Merge branch '1538-create-handshake-key-pair' into 'master'

Generate and store handshake key pair at startup if necessary

Closes #1538

See merge request briar/briar!1082

bramble-api/src/main/java/org/briarproject/bramble/api/client/BdfIncomingMessageHook.java

@@ -33,7 +33,8 @@ public abstract class BdfIncomingMessageHook implements IncomingMessageHook {
 	/**
 	 * Called once for each incoming message that passes validation.
 	 *
-	 * @return whether or not this message should be shared
+	 * @param txn A read-write transaction
+	 * @return Whether or not this message should be shared
 	 * @throws DbException Should only be used for real database errors.
 	 * If this is thrown, delivery will be attempted again at next startup,
 	 * whereas if a FormatException is thrown, the message will be permanently

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

@@ -159,8 +159,20 @@ public interface ContactManager {
 
 	interface ContactHook {
 
+		/**
+		 * Called when a contact is being added.
+		 *
+		 * @param txn A read-write transaction
+		 * @param c The contact that is being added
+		 */
 		void addingContact(Transaction txn, Contact c) throws DbException;
 
+		/**
+		 * Called when a contact is being removed
+		 *
+		 * @param txn A read-write transaction
+		 * @param c The contact that is being removed
+		 */
 		void removingContact(Transaction txn, Contact c) throws DbException;
 	}
 }

bramble-api/src/main/java/org/briarproject/bramble/api/db/DatabaseComponent.java

@@ -7,7 +7,7 @@ import org.briarproject.bramble.api.contact.PendingContactId;
 import org.briarproject.bramble.api.crypto.SecretKey;
 import org.briarproject.bramble.api.identity.Author;
 import org.briarproject.bramble.api.identity.AuthorId;
-import org.briarproject.bramble.api.identity.LocalAuthor;
+import org.briarproject.bramble.api.identity.Identity;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 import org.briarproject.bramble.api.plugin.TransportId;
 import org.briarproject.bramble.api.settings.Settings;
@@ -128,9 +128,9 @@ public interface DatabaseComponent {
 			HandshakeKeys k) throws DbException;
 
 	/**
-	 * Stores a local pseudonym.
+	 * Stores an identity.
 	 */
-	void addLocalAuthor(Transaction txn, LocalAuthor a) throws DbException;
+	void addIdentity(Transaction txn, Identity i) throws DbException;
 
 	/**
 	 * Stores a local message.
@@ -174,12 +174,12 @@ public interface DatabaseComponent {
 	boolean containsGroup(Transaction txn, GroupId g) throws DbException;
 
 	/**
-	 * Returns true if the database contains the given local author.
+	 * Returns true if the database contains an identity for the given
+	 * pseudonym.
 	 * <p/>
 	 * Read-only.
 	 */
-	boolean containsLocalAuthor(Transaction txn, AuthorId local)
-			throws DbException;
+	boolean containsIdentity(Transaction txn, AuthorId a) throws DbException;
 
 	/**
 	 * Returns true if the database contains the given pending contact.
@@ -317,18 +317,18 @@ public interface DatabaseComponent {
 			throws DbException;
 
 	/**
-	 * Returns the local pseudonym with the given ID.
+	 * Returns the identity for the local pseudonym with the given ID.
 	 * <p/>
 	 * Read-only.
 	 */
-	LocalAuthor getLocalAuthor(Transaction txn, AuthorId a) throws DbException;
+	Identity getIdentity(Transaction txn, AuthorId a) throws DbException;
 
 	/**
-	 * Returns all local pseudonyms.
+	 * Returns the identities for all local pseudonyms.
 	 * <p/>
 	 * Read-only.
 	 */
-	Collection<LocalAuthor> getLocalAuthors(Transaction txn) throws DbException;
+	Collection<Identity> getIdentities(Transaction txn) throws DbException;
 
 	/**
 	 * Returns the message with the given ID.
@@ -559,9 +559,9 @@ public interface DatabaseComponent {
 			HandshakeKeySetId k) throws DbException;
 
 	/**
-	 * Removes a local pseudonym (and all associated state) from the database.
+	 * Removes an identity (and all associated state) from the database.
 	 */
-	void removeLocalAuthor(Transaction txn, AuthorId a) throws DbException;
+	void removeIdentity(Transaction txn, AuthorId a) throws DbException;
 
 	/**
 	 * Removes a message (and all associated state) from the database.
@@ -619,6 +619,12 @@ public interface DatabaseComponent {
 	void addMessageDependencies(Transaction txn, Message dependent,
 			Collection<MessageId> dependencies) throws DbException;
 
+	/**
+	 * Sets the handshake key pair for the identity with the given ID.
+	 */
+	void setHandshakeKeyPair(Transaction txn, AuthorId local, byte[] publicKey,
+			byte[] privateKey) throws DbException;
+
 	/**
 	 * Sets the reordering window for the given transport key set in the given
 	 * time period.

bramble-api/src/main/java/org/briarproject/bramble/api/db/NoSuchIdentityException.java

@@ -1,9 +1,9 @@
 package org.briarproject.bramble.api.db;
 
 /**
- * Thrown when a database operation is attempted for a pseudonym that is not in
+ * Thrown when a database operation is attempted for an identity that is not in
  * the database. This exception may occur due to concurrent updates and does
  * not indicate a database error.
  */
-public class NoSuchLocalAuthorException extends DbException {
+public class NoSuchIdentityException extends DbException {
 }

bramble-api/src/main/java/org/briarproject/bramble/api/identity/AuthorFactory.java

@@ -18,14 +18,7 @@ public interface AuthorFactory {
 
 	/**
 	 * Creates a local author with the current format version and the given
-	 * name and keys.
+	 * name.
 	 */
-	LocalAuthor createLocalAuthor(String name, byte[] publicKey,
-			byte[] privateKey);
-
-	/**
-	 * Creates a local author with the given format version, name and keys.
-	 */
-	LocalAuthor createLocalAuthor(int formatVersion, String name,
-			byte[] publicKey, byte[] privateKey);
+	LocalAuthor createLocalAuthor(String name);
 }

bramble-api/src/main/java/org/briarproject/bramble/api/identity/Identity.java

@@ -0,0 +1,96 @@
+package org.briarproject.bramble.api.identity;
+
+import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+
+import java.util.Arrays;
+
+import javax.annotation.Nullable;
+import javax.annotation.concurrent.Immutable;
+
+import static org.briarproject.bramble.api.crypto.CryptoConstants.MAX_AGREEMENT_PUBLIC_KEY_BYTES;
+
+@Immutable
+@NotNullByDefault
+public class Identity {
+
+	private final LocalAuthor localAuthor;
+	@Nullable
+	private final byte[] handshakePublicKey, handshakePrivateKey;
+	private final long created;
+
+	public Identity(LocalAuthor localAuthor,
+			@Nullable byte[] handshakePublicKey,
+			@Nullable byte[] handshakePrivateKey, long created) {
+		if (handshakePublicKey != null) {
+			int keyLength = handshakePublicKey.length;
+			if (keyLength == 0 || keyLength > MAX_AGREEMENT_PUBLIC_KEY_BYTES)
+				throw new IllegalArgumentException();
+		}
+		this.localAuthor = localAuthor;
+		this.handshakePublicKey = handshakePublicKey;
+		this.handshakePrivateKey = handshakePrivateKey;
+		this.created = created;
+	}
+
+	/**
+	 * Returns the ID of the user's pseudonym.
+	 */
+	public AuthorId getId() {
+		return localAuthor.getId();
+	}
+
+	/**
+	 * Returns the user's pseudonym.
+	 */
+	public LocalAuthor getLocalAuthor() {
+		return localAuthor;
+	}
+
+	/**
+	 * Returns true if the identity has a handshake key pair.
+	 */
+	public boolean hasHandshakeKeyPair() {
+		return handshakePublicKey != null && handshakePrivateKey != null;
+	}
+
+	/**
+	 * Returns the public key used for handshaking, or null if no key exists.
+	 */
+	@Nullable
+	public byte[] getHandshakePublicKey() {
+		return handshakePublicKey;
+	}
+
+	/**
+	 * Returns the private key used for handshaking, or null if no key exists.
+	 */
+	@Nullable
+	public byte[] getHandshakePrivateKey() {
+		return handshakePrivateKey;
+	}
+
+	/**
+	 * Returns the time the identity was created, in milliseconds since the
+	 * Unix epoch.
+	 */
+	public long getTimeCreated() {
+		return created;
+	}
+
+	@Override
+	public int hashCode() {
+		return localAuthor.getId().hashCode();
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (o instanceof Identity) {
+			Identity i = (Identity) o;
+			return created == i.created &&
+					localAuthor.equals(i.localAuthor) &&
+					Arrays.equals(handshakePublicKey, i.handshakePublicKey) &&
+					Arrays.equals(handshakePrivateKey, i.handshakePrivateKey);
+		}
+		return false;
+	}
+}

bramble-api/src/main/java/org/briarproject/bramble/api/identity/IdentityManager.java

@@ -1,30 +1,29 @@
 package org.briarproject.bramble.api.identity;
 
 import org.briarproject.bramble.api.crypto.CryptoExecutor;
+import org.briarproject.bramble.api.crypto.SecretKey;
 import org.briarproject.bramble.api.db.DbException;
 import org.briarproject.bramble.api.db.Transaction;
+import org.briarproject.bramble.api.lifecycle.LifecycleManager;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 
 @NotNullByDefault
 public interface IdentityManager {
 
 	/**
-	 * Creates a local identity with the given name.
+	 * Creates an identity with the given name. The identity includes a
+	 * handshake key pair.
 	 */
 	@CryptoExecutor
-	LocalAuthor createLocalAuthor(String name);
+	Identity createIdentity(String name);
 
 	/**
-	 * Registers the given local identity with the manager. The identity is
-	 * not stored until {@link #storeLocalAuthor()} is called.
+	 * Registers the given identity with the manager. This method should be
+	 * called before {@link LifecycleManager#startServices(SecretKey)}. The
+	 * identity is stored when {@link LifecycleManager#startServices(SecretKey)}
+	 * is called. The identity must include a handshake key pair.
 	 */
-	void registerLocalAuthor(LocalAuthor a);
-
-	/**
-	 * Stores the local identity registered with
-	 * {@link #registerLocalAuthor(LocalAuthor)}, if any.
-	 */
-	void storeLocalAuthor() throws DbException;
+	void registerIdentity(Identity i);
 
 	/**
 	 * Returns the cached local identity or loads it from the database.
@@ -33,7 +32,18 @@ public interface IdentityManager {
 
 	/**
 	 * Returns the cached local identity or loads it from the database.
+	 * <p/>
+	 * Read-only.
 	 */
 	LocalAuthor getLocalAuthor(Transaction txn) throws DbException;
 
+	/**
+	 * Returns the cached handshake keys or loads them from the database.
+	 * <p/>
+	 * Read-only.
+	 *
+	 * @return A two-element array containing the public key in the first
+	 * element and the private key in the second
+	 */
+	byte[][] getHandshakeKeys(Transaction txn) throws DbException;
 }

bramble-api/src/main/java/org/briarproject/bramble/api/identity/LocalAuthor.java

@@ -2,11 +2,8 @@ package org.briarproject.bramble.api.identity;
 
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 
-import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 
-import static org.briarproject.bramble.api.identity.AuthorConstants.MAX_PUBLIC_KEY_LENGTH;
-
 /**
  * A pseudonym for the local user.
  */
@@ -15,31 +12,11 @@ import static org.briarproject.bramble.api.identity.AuthorConstants.MAX_PUBLIC_K
 public class LocalAuthor extends Author {
 
 	private final byte[] privateKey;
-	@Nullable
-	private final byte[] handshakePublicKey, handshakePrivateKey;
-	private final long created;
 
 	public LocalAuthor(AuthorId id, int formatVersion, String name,
-			byte[] publicKey, byte[] privateKey, long created) {
+			byte[] publicKey, byte[] privateKey) {
 		super(id, formatVersion, name, publicKey);
 		this.privateKey = privateKey;
-		this.created = created;
-		handshakePublicKey = null;
-		handshakePrivateKey = null;
-	}
-
-	public LocalAuthor(AuthorId id, int formatVersion, String name,
-			byte[] publicKey, byte[] privateKey, byte[] handshakePublicKey,
-			byte[] handshakePrivateKey, long created) {
-		super(id, formatVersion, name, publicKey);
-		if (handshakePublicKey.length == 0 ||
-				handshakePublicKey.length > MAX_PUBLIC_KEY_LENGTH) {
-			throw new IllegalArgumentException();
-		}
-		this.privateKey = privateKey;
-		this.handshakePublicKey = handshakePublicKey;
-		this.handshakePrivateKey = handshakePrivateKey;
-		this.created = created;
 	}
 
 	/**
@@ -48,28 +25,4 @@ public class LocalAuthor extends Author {
 	public byte[] getPrivateKey() {
 		return privateKey;
 	}
-
-	/**
-	 * Returns the public key used for handshaking, or null if no key exists.
-	 */
-	@Nullable
-	public byte[] getHandshakePublicKey() {
-		return handshakePublicKey;
-	}
-
-	/**
-	 * Returns the private key used for handshaking, or null if no key exists.
-	 */
-	@Nullable
-	public byte[] getHandshakePrivateKey() {
-		return handshakePrivateKey;
-	}
-
-	/**
-	 * Returns the time the pseudonym was created, in milliseconds since the
-	 * Unix epoch.
-	 */
-	public long getTimeCreated() {
-		return created;
-	}
 }

bramble-api/src/main/java/org/briarproject/bramble/api/identity/event/IdentityAddedEvent.java

@@ -7,15 +7,15 @@ import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 import javax.annotation.concurrent.Immutable;
 
 /**
- * An event that is broadcast when a local pseudonym is added.
+ * An event that is broadcast when an identity is added.
  */
 @Immutable
 @NotNullByDefault
-public class LocalAuthorAddedEvent extends Event {
+public class IdentityAddedEvent extends Event {
 
 	private final AuthorId authorId;
 
-	public LocalAuthorAddedEvent(AuthorId authorId) {
+	public IdentityAddedEvent(AuthorId authorId) {
 		this.authorId = authorId;
 	}
 

bramble-api/src/main/java/org/briarproject/bramble/api/identity/event/IdentityRemovedEvent.java

@@ -7,15 +7,15 @@ import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 import javax.annotation.concurrent.Immutable;
 
 /**
- * An event that is broadcast when a local pseudonym is removed.
+ * An event that is broadcast when an identity is removed.
  */
 @Immutable
 @NotNullByDefault
-public class LocalAuthorRemovedEvent extends Event {
+public class IdentityRemovedEvent extends Event {
 
 	private final AuthorId authorId;
 
-	public LocalAuthorRemovedEvent(AuthorId authorId) {
+	public IdentityRemovedEvent(AuthorId authorId) {
 		this.authorId = authorId;
 	}
 

bramble-api/src/main/java/org/briarproject/bramble/api/lifecycle/LifecycleManager.java

@@ -2,16 +2,16 @@ package org.briarproject.bramble.api.lifecycle;
 
 import org.briarproject.bramble.api.crypto.SecretKey;
 import org.briarproject.bramble.api.db.DatabaseComponent;
+import org.briarproject.bramble.api.db.DbException;
+import org.briarproject.bramble.api.db.Transaction;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
-import org.briarproject.bramble.api.sync.Client;
 
 import java.util.concurrent.ExecutorService;
 
 /**
- * Manages the lifecycle of the app, starting {@link Client Clients}, starting
- * and stopping {@link Service Services}, shutting down
- * {@link ExecutorService ExecutorServices}, and opening and closing the
- * {@link DatabaseComponent}.
+ * Manages the lifecycle of the app: opening and closing the
+ * {@link DatabaseComponent} starting and stopping {@link Service Services},
+ * and shutting down {@link ExecutorService ExecutorServices}.
  */
 @NotNullByDefault
 public interface LifecycleManager {
@@ -42,18 +42,19 @@ public interface LifecycleManager {
 		}
 	}
 
+	/**
+	 * Registers a hook to be called after the database is opened and before
+	 * {@link Service services} are started. This method should be called
+	 * before {@link #startServices(SecretKey)}.
+	 */
+	void registerOpenDatabaseHook(OpenDatabaseHook hook);
+
 	/**
 	 * Registers a {@link Service} to be started and stopped. This method
 	 * should be called before {@link #startServices(SecretKey)}.
 	 */
 	void registerService(Service s);
 
-	/**
-	 * Registers a {@link Client} to be started. This method should be called
-	 * before {@link #startServices(SecretKey)}.
-	 */
-	void registerClient(Client c);
-
 	/**
 	 * Registers an {@link ExecutorService} to be shut down. This method
 	 * should be called before {@link #startServices(SecretKey)}.
@@ -62,7 +63,7 @@ public interface LifecycleManager {
 
 	/**
 	 * Opens the {@link DatabaseComponent} using the given key and starts any
-	 * registered {@link Client Clients} and {@link Service Services}.
+	 * registered {@link Service Services}.
 	 */
 	StartResult startServices(SecretKey dbKey);
 
@@ -80,8 +81,7 @@ public interface LifecycleManager {
 
 	/**
 	 * Waits for the {@link DatabaseComponent} to be opened and all registered
-	 * {@link Client Clients} and {@link Service Services} to start before
-	 * returning.
+	 * {@link Service Services} to start before returning.
 	 */
 	void waitForStartup() throws InterruptedException;
 
@@ -97,4 +97,13 @@ public interface LifecycleManager {
 	 */
 	LifecycleState getLifecycleState();
 
+	interface OpenDatabaseHook {
+		/**
+		 * Called when the database is being opened, before
+		 * {@link #waitForDatabase()} returns.
+		 *
+		 * @param txn A read-write transaction
+		 */
+		void onDatabaseOpened(Transaction txn) throws DbException;
+	}
 }

bramble-api/src/main/java/org/briarproject/bramble/api/sync/Client.java

@@ -1,14 +0,0 @@
-package org.briarproject.bramble.api.sync;
-
-import org.briarproject.bramble.api.db.DbException;
-import org.briarproject.bramble.api.db.Transaction;
-import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
-
-@NotNullByDefault
-public interface Client {
-
-	/**
-	 * Called at startup to create any local state needed by the client.
-	 */
-	void createLocalState(Transaction txn) throws DbException;
-}

bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/IncomingMessageHook.java

@@ -11,7 +11,8 @@ public interface IncomingMessageHook {
 	/**
 	 * Called once for each incoming message that passes validation.
 	 *
-	 * @return whether or not this message should be shared
+	 * @param txn A read-write transaction
+	 * @return Whether or not this message should be shared
 	 * @throws DbException Should only be used for real database errors.
 	 * If this is thrown, delivery will be attempted again at next startup,
 	 * whereas if an InvalidMessageException is thrown,

bramble-api/src/main/java/org/briarproject/bramble/api/versioning/ClientVersioningManager.java

@@ -46,7 +46,14 @@ public interface ClientVersioningManager {
 			ClientId clientId, int majorVersion) throws DbException;
 
 	interface ClientVersioningHook {
-
+		/**
+		 * Called when the visibility of a client with respect to a contact is
+		 * changing.
+		 *
+		 * @param txn A read-write transaction
+		 * @param c The contact affected by the visibility change
+		 * @param v The new visibility of the client
+		 */
 		void onClientVisibilityChanging(Transaction txn, Contact c,
 				Visibility v) throws DbException;
 	}