Merge branch '1556-key-manager-methods-for-pending-contacts' into 'master'

Add key manager methods for pending contacts

Closes #1556

See merge request briar/briar!1089

bramble-api/src/main/java/org/briarproject/bramble/api/Bytes.java

@@ -6,6 +6,7 @@ import org.briarproject.bramble.util.StringUtils;
 import java.util.Arrays;
 import java.util.Comparator;
 
+import javax.annotation.Nullable;
 import javax.annotation.concurrent.ThreadSafe;
 
 /**
@@ -38,7 +39,7 @@ public class Bytes implements Comparable<Bytes> {
 	}
 
 	@Override
-	public boolean equals(Object o) {
+	public boolean equals(@Nullable Object o) {
 		return o instanceof Bytes && Arrays.equals(bytes, ((Bytes) o).bytes);
 	}
 

bramble-api/src/main/java/org/briarproject/bramble/api/contact/ContactId.java

@@ -2,6 +2,7 @@ package org.briarproject.bramble.api.contact;
 
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 
+import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 
 /**
@@ -28,7 +29,7 @@ public class ContactId {
 	}
 
 	@Override
-	public boolean equals(Object o) {
+	public boolean equals(@Nullable Object o) {
 		return o instanceof ContactId && id == ((ContactId) o).id;
 	}
 }

bramble-api/src/main/java/org/briarproject/bramble/api/contact/PendingContactId.java

@@ -3,6 +3,7 @@ package org.briarproject.bramble.api.contact;
 import org.briarproject.bramble.api.UniqueId;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 
+import javax.annotation.Nullable;
 import javax.annotation.concurrent.ThreadSafe;
 
 /**
@@ -17,9 +18,8 @@ public class PendingContactId extends UniqueId {
 		super(id);
 	}
 
-
 	@Override
-	public boolean equals(Object o) {
+	public boolean equals(@Nullable Object o) {
 		return o instanceof PendingContactId && super.equals(o);
 	}
 }

bramble-api/src/main/java/org/briarproject/bramble/api/nullsafety/NullSafety.java

@@ -6,10 +6,20 @@ import javax.annotation.Nullable;
 public class NullSafety {
 
 	/**
-	 * Stand-in for `Objects.requireNonNull()`.
+	 * Stand-in for {@code Objects.requireNonNull()}.
 	 */
 	public static <T> T requireNonNull(@Nullable T t) {
 		if (t == null) throw new NullPointerException();
 		return t;
 	}
+
+	/**
+	 * Checks that exactly one of the arguments is null.
+	 *
+	 * @throws AssertionError If both or neither of the arguments are null
+	 */
+	public static void requireExactlyOneNull(@Nullable Object a,
+			@Nullable Object b) {
+		if ((a == null) == (b == null)) throw new AssertionError();
+	}
 }

bramble-api/src/main/java/org/briarproject/bramble/api/transport/KeyManager.java

@@ -1,6 +1,7 @@
 package org.briarproject.bramble.api.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.db.DbException;
 import org.briarproject.bramble.api.db.Transaction;
@@ -18,17 +19,45 @@ public interface KeyManager {
 
 	/**
 	 * Informs the key manager that a new contact has been added. Derives and
-	 * stores a set of transport keys for communicating with the contact over
-	 * each transport and returns the key set IDs.
+	 * stores a set of rotation mode transport keys for communicating with the
+	 * contact over each transport and returns the key set IDs.
 	 * <p/>
 	 * {@link StreamContext StreamContexts} for the contact can be created
 	 * after this method has returned.
 	 *
-	 * @param alice true if the local party is Alice
-	 * @param active whether the derived keys can be used for outgoing streams
+	 * @param alice True if the local party is Alice
+	 * @param active Whether the derived keys can be used for outgoing streams
 	 */
-	Map<TransportId, KeySetId> addContact(Transaction txn, ContactId c,
-			SecretKey rootKey, long timestamp, boolean alice, boolean active)
+	Map<TransportId, KeySetId> addContactWithRotationKeys(Transaction txn,
+			ContactId c, SecretKey rootKey, long timestamp, boolean alice,
+			boolean active) throws DbException;
+
+	/**
+	 * Informs the key manager that a new contact has been added. Derives and
+	 * stores a set of handshake mode transport keys for communicating with the
+	 * contact over each transport and returns the key set IDs.
+	 * <p/>
+	 * {@link StreamContext StreamContexts} for the contact can be created
+	 * after this method has returned.
+	 *
+	 * @param alice True if the local party is Alice
+	 */
+	Map<TransportId, KeySetId> addContactWithHandshakeKeys(Transaction txn,
+			ContactId c, SecretKey rootKey, boolean alice) throws DbException;
+
+	/**
+	 * Informs the key manager that a new pending contact has been added.
+	 * Derives and stores a set of handshake mode transport keys for
+	 * communicating with the pending contact over each transport and returns
+	 * the key set IDs.
+	 * <p/>
+	 * {@link StreamContext StreamContexts} for the pending contact can be
+	 * created after this method has returned.
+	 *
+	 * @param alice True if the local party is Alice
+	 */
+	Map<TransportId, KeySetId> addPendingContact(Transaction txn,
+			PendingContactId p, SecretKey rootKey, boolean alice)
 			throws DbException;
 
 	/**
@@ -43,15 +72,28 @@ public interface KeyManager {
 	 */
 	boolean canSendOutgoingStreams(ContactId c, TransportId t);
 
+	/**
+	 * Returns true if we have keys that can be used for outgoing streams to
+	 * the given pending contact over the given transport.
+	 */
+	boolean canSendOutgoingStreams(PendingContactId p, TransportId t);
+
 	/**
 	 * Returns a {@link StreamContext} for sending a stream to the given
-	 * contact over the given transport, or null if an error occurs or the
-	 * contact does not support the transport.
+	 * contact over the given transport, or null if an error occurs.
 	 */
 	@Nullable
 	StreamContext getStreamContext(ContactId c, TransportId t)
 			throws DbException;
 
+	/**
+	 * Returns a {@link StreamContext} for sending a stream to the given
+	 * pending contact over the given transport, or null if an error occurs.
+	 */
+	@Nullable
+	StreamContext getStreamContext(PendingContactId p, TransportId t)
+			throws DbException;
+
 	/**
 	 * Looks up the given tag and returns a {@link StreamContext} for reading
 	 * from the corresponding stream, or null if an error occurs or the tag was

bramble-api/src/main/java/org/briarproject/bramble/api/transport/StreamContext.java

@@ -9,6 +9,8 @@ import org.briarproject.bramble.api.plugin.TransportId;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 
+import static org.briarproject.bramble.api.nullsafety.NullSafety.requireExactlyOneNull;
+
 @Immutable
 @NotNullByDefault
 public class StreamContext {
@@ -26,8 +28,7 @@ public class StreamContext {
 			@Nullable PendingContactId pendingContactId,
 			TransportId transportId, SecretKey tagKey, SecretKey headerKey,
 			long streamNumber, boolean handshakeMode) {
-		if ((contactId == null) == (pendingContactId == null))
-			throw new IllegalArgumentException();
+		requireExactlyOneNull(contactId, pendingContactId);
 		this.contactId = contactId;
 		this.pendingContactId = pendingContactId;
 		this.transportId = transportId;

bramble-api/src/main/java/org/briarproject/bramble/api/transport/TransportKeySet.java

@@ -7,6 +7,8 @@ import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 
+import static org.briarproject.bramble.api.nullsafety.NullSafety.requireExactlyOneNull;
+
 /**
  * A set of keys for communicating with a given contact or pending contact
  * over a given transport.
@@ -24,8 +26,7 @@ public class TransportKeySet {
 
 	public TransportKeySet(KeySetId keySetId, @Nullable ContactId contactId,
 			@Nullable PendingContactId pendingContactId, TransportKeys keys) {
-		if ((contactId == null) == (pendingContactId == null))
-			throw new IllegalArgumentException();
+		requireExactlyOneNull(contactId, pendingContactId);
 		this.keySetId = keySetId;
 		this.contactId = contactId;
 		this.pendingContactId = pendingContactId;