Add key manager methods for pending contacts.

2026-02-14 11:49:04 +01:00 · 2019-05-09 13:07:15 +01:00
parent f42fc5213e
commit dd50f4bcd4
9 changed files with 294 additions and 33 deletions
--- a/bramble-core/src/test/java/org/briarproject/bramble/transport/KeyManagerImplTest.java
+++ b/bramble-core/src/test/java/org/briarproject/bramble/transport/KeyManagerImplTest.java
@@ -1,6 +1,7 @@
 package org.briarproject.bramble.transport;

 import org.briarproject.bramble.api.contact.ContactId;
+import org.briarproject.bramble.api.contact.PendingContactId;
 import org.briarproject.bramble.api.contact.event.ContactRemovedEvent;
 import org.briarproject.bramble.api.crypto.SecretKey;
 import org.briarproject.bramble.api.db.DatabaseComponent;
@@ -26,6 +27,7 @@ import static java.util.Collections.singletonMap;
 import static org.briarproject.bramble.api.transport.TransportConstants.TAG_LENGTH;
 import static org.briarproject.bramble.test.TestUtils.getContactId;
 import static org.briarproject.bramble.test.TestUtils.getRandomBytes;
+import static org.briarproject.bramble.test.TestUtils.getRandomId;
 import static org.briarproject.bramble.test.TestUtils.getSecretKey;
 import static org.briarproject.bramble.test.TestUtils.getTransportId;
 import static org.junit.Assert.assertEquals;
@@ -43,11 +45,17 @@ public class KeyManagerImplTest extends BrambleMockTestCase {
 	private final DeterministicExecutor executor = new DeterministicExecutor();
 	private final Transaction txn = new Transaction(null, false);
 	private final ContactId contactId = getContactId();
+	private final PendingContactId pendingContactId =
+			new PendingContactId(getRandomId());
 	private final KeySetId keySetId = new KeySetId(345);
 	private final TransportId transportId = getTransportId();
 	private final TransportId unknownTransportId = getTransportId();
-	private final StreamContext streamContext = new StreamContext(contactId,
-			null, transportId, getSecretKey(), getSecretKey(), 1, false);
+	private final StreamContext contactStreamContext =
+			new StreamContext(contactId, null, transportId, getSecretKey(),
+					getSecretKey(), 1, false);
+	private final StreamContext pendingContactStreamContext =
+			new StreamContext(null, pendingContactId, transportId,
+					getSecretKey(), getSecretKey(), 1, true);
 	private final byte[] tag = getRandomBytes(TAG_LENGTH);
 	private final Random random = new Random();

@@ -117,23 +125,60 @@ public class KeyManagerImplTest extends BrambleMockTestCase {
 	}

 	@Test
-	public void testGetStreamContextForUnknownTransport() throws Exception {
+	public void testAddPendingContact() throws Exception {
+		SecretKey secretKey = getSecretKey();
+		boolean alice = random.nextBoolean();
+
+		context.checking(new Expectations() {{
+			oneOf(transportKeyManager).addPendingContact(txn, pendingContactId,
+					secretKey, alice);
+			will(returnValue(keySetId));
+		}});
+
+		Map<TransportId, KeySetId> ids = keyManager.addPendingContact(txn,
+				pendingContactId, secretKey, alice);
+		assertEquals(singletonMap(transportId, keySetId), ids);
+	}
+
+	@Test
+	public void testGetStreamContextForContactWithUnknownTransport()
+			throws Exception {
 		assertNull(keyManager.getStreamContext(contactId, unknownTransportId));
 	}

+	@Test
+	public void testGetStreamContextForPendingContactWithUnknownTransport()
+			throws Exception {
+		assertNull(keyManager.getStreamContext(pendingContactId,
+				unknownTransportId));
+	}
+
 	@Test
 	public void testGetStreamContextForContact() throws Exception {
 		context.checking(new DbExpectations() {{
 			oneOf(db).transactionWithNullableResult(with(false),
 					withNullableDbCallable(txn));
 			oneOf(transportKeyManager).getStreamContext(txn, contactId);
-			will(returnValue(streamContext));
+			will(returnValue(contactStreamContext));
 		}});

-		assertEquals(streamContext,
+		assertEquals(contactStreamContext,
 				keyManager.getStreamContext(contactId, transportId));
 	}

+	@Test
+	public void testGetStreamContextForPendingContact() throws Exception {
+		context.checking(new DbExpectations() {{
+			oneOf(db).transactionWithNullableResult(with(false),
+					withNullableDbCallable(txn));
+			oneOf(transportKeyManager).getStreamContext(txn, pendingContactId);
+			will(returnValue(pendingContactStreamContext));
+		}});
+
+		assertEquals(pendingContactStreamContext,
+				keyManager.getStreamContext(pendingContactId, transportId));
+	}
+
 	@Test
 	public void testGetStreamContextForTagAndUnknownTransport()
 			throws Exception {
@@ -146,10 +191,10 @@ public class KeyManagerImplTest extends BrambleMockTestCase {
 			oneOf(db).transactionWithNullableResult(with(false),
 					withNullableDbCallable(txn));
 			oneOf(transportKeyManager).getStreamContext(txn, tag);
-			will(returnValue(streamContext));
+			will(returnValue(contactStreamContext));
 		}});

-		assertEquals(streamContext,
+		assertEquals(contactStreamContext,
 				keyManager.getStreamContext(transportId, tag));
 	}

--- a/bramble-core/src/test/java/org/briarproject/bramble/transport/TransportKeyManagerImplTest.java
+++ b/bramble-core/src/test/java/org/briarproject/bramble/transport/TransportKeyManagerImplTest.java
@@ -1,6 +1,7 @@
 package org.briarproject.bramble.transport;

 import org.briarproject.bramble.api.contact.ContactId;
+import org.briarproject.bramble.api.contact.PendingContactId;
 import org.briarproject.bramble.api.crypto.SecretKey;
 import org.briarproject.bramble.api.crypto.TransportCrypto;
 import org.briarproject.bramble.api.db.DatabaseComponent;
@@ -37,6 +38,7 @@ import static org.briarproject.bramble.api.transport.TransportConstants.PROTOCOL
 import static org.briarproject.bramble.api.transport.TransportConstants.REORDERING_WINDOW_SIZE;
 import static org.briarproject.bramble.api.transport.TransportConstants.TAG_LENGTH;
 import static org.briarproject.bramble.test.TestUtils.getContactId;
+import static org.briarproject.bramble.test.TestUtils.getRandomId;
 import static org.briarproject.bramble.test.TestUtils.getSecretKey;
 import static org.briarproject.bramble.test.TestUtils.getTransportId;
 import static org.briarproject.bramble.util.ByteUtils.MAX_32_BIT_UNSIGNED;
@@ -61,6 +63,8 @@ public class TransportKeyManagerImplTest extends BrambleMockTestCase {
 	private final long timePeriodLength = maxLatency + MAX_CLOCK_DIFFERENCE;
 	private final ContactId contactId = getContactId();
 	private final ContactId contactId1 = getContactId();
+	private final PendingContactId pendingContactId =
+			new PendingContactId(getRandomId());
 	private final KeySetId keySetId = new KeySetId(345);
 	private final KeySetId keySetId1 = new KeySetId(456);
 	private final SecretKey tagKey = getSecretKey();
@@ -162,7 +166,7 @@ public class TransportKeyManagerImplTest extends BrambleMockTestCase {
 	public void testHandshakeKeysAreDerivedWhenAddingContact()
 			throws Exception {
 		boolean alice = random.nextBoolean();
-		TransportKeys transportKeys = createTransportKeys(1000, 0, true);
+		TransportKeys transportKeys = createHandshakeKeys(1000, 0, alice);
 		Transaction txn = new Transaction(null, false);

 		context.checking(new Expectations() {{
@@ -193,6 +197,42 @@ public class TransportKeyManagerImplTest extends BrambleMockTestCase {
 		assertTrue(transportKeyManager.canSendOutgoingStreams(contactId));
 	}

+	@Test
+	public void testHandshakeKeysAreDerivedWhenAddingPendingContact()
+			throws Exception {
+		boolean alice = random.nextBoolean();
+		TransportKeys transportKeys = createHandshakeKeys(1000, 0, alice);
+		Transaction txn = new Transaction(null, false);
+
+		context.checking(new Expectations() {{
+			// Get the current time (1 ms after start of time period 1000)
+			oneOf(clock).currentTimeMillis();
+			will(returnValue(timePeriodLength * 1000 + 1));
+			// Derive the transport keys
+			oneOf(transportCrypto).deriveHandshakeKeys(transportId, rootKey,
+					1000, alice);
+			will(returnValue(transportKeys));
+			// Encode the tags (3 sets)
+			for (long i = 0; i < REORDERING_WINDOW_SIZE; i++) {
+				exactly(3).of(transportCrypto).encodeTag(
+						with(any(byte[].class)), with(tagKey),
+						with(PROTOCOL_VERSION), with(i));
+				will(new EncodeTagAction());
+			}
+			// Save the keys
+			oneOf(db).addTransportKeys(txn, pendingContactId, transportKeys);
+			will(returnValue(keySetId));
+		}});
+
+		TransportKeyManager transportKeyManager = new TransportKeyManagerImpl(
+				db, transportCrypto, dbExecutor, scheduler, clock, transportId,
+				maxLatency);
+		assertEquals(keySetId, transportKeyManager.addPendingContact(txn,
+				pendingContactId, rootKey, alice));
+		assertTrue(transportKeyManager.canSendOutgoingStreams(
+				pendingContactId));
+	}
+
 	@Test
 	public void testOutgoingStreamContextIsNullIfContactIsNotFound()
 			throws Exception {
@@ -205,6 +245,19 @@ public class TransportKeyManagerImplTest extends BrambleMockTestCase {
 		assertFalse(transportKeyManager.canSendOutgoingStreams(contactId));
 	}

+	@Test
+	public void testOutgoingStreamContextIsNullIfPendingContactIsNotFound()
+			throws Exception {
+		Transaction txn = new Transaction(null, false);
+
+		TransportKeyManager transportKeyManager = new TransportKeyManagerImpl(
+				db, transportCrypto, dbExecutor, scheduler, clock, transportId,
+				maxLatency);
+		assertNull(transportKeyManager.getStreamContext(txn, pendingContactId));
+		assertFalse(transportKeyManager.canSendOutgoingStreams(
+				pendingContactId));
+	}
+
 	@Test
 	public void testOutgoingStreamContextIsNullIfStreamCounterIsExhausted()
 			throws Exception {
@@ -565,6 +618,21 @@ public class TransportKeyManagerImplTest extends BrambleMockTestCase {
 		return new TransportKeys(transportId, inPrev, inCurr, inNext, outCurr);
 	}

+	@SuppressWarnings("SameParameterValue")
+	private TransportKeys createHandshakeKeys(long timePeriod,
+			long streamCounter, boolean alice) {
+		IncomingKeys inPrev = new IncomingKeys(tagKey, headerKey,
+				timePeriod - 1);
+		IncomingKeys inCurr = new IncomingKeys(tagKey, headerKey,
+				timePeriod);
+		IncomingKeys inNext = new IncomingKeys(tagKey, headerKey,
+				timePeriod + 1);
+		OutgoingKeys outCurr = new OutgoingKeys(tagKey, headerKey,
+				timePeriod, streamCounter, true);
+		return new TransportKeys(transportId, inPrev, inCurr, inNext, outCurr,
+				rootKey, alice);
+	}
+
 	private class EncodeTagAction implements Action {

 		private final Collection<byte[]> tags;