1 files changed, 57 insertions, 0 deletions
diff --git a/src/main/java/org/whispersystems/libaxolotl/state/IdentityKeyStore.java b/src/main/java/org/whispersystems/libaxolotl/state/IdentityKeyStore.java
new file mode 100644
index 00000000..d2024f78
--- /dev/null
+++ b/src/main/java/org/whispersystems/libaxolotl/state/IdentityKeyStore.java
@@ -0,0 +1,57 @@
+package org.whispersystems.libaxolotl.state;
+
+import org.whispersystems.libaxolotl.IdentityKey;
+import org.whispersystems.libaxolotl.IdentityKeyPair;
+
+/**
+ * Provides an interface to identity information.
+ *
+ * @author Moxie Marlinspike
+ */
+public interface IdentityKeyStore {
+
+  /**
+   * Get the local client's identity key pair.
+   *
+   * @return The local client's persistent identity key pair.
+   */
+  public IdentityKeyPair getIdentityKeyPair();
+
+  /**
+   * Return the local client's registration ID.
+   * <p>
+   * Clients should maintain a registration ID, a random number
+   * between 1 and 16380 that's generated once at install time.
+   *
+   * @return the local client's registration ID.
+   */
+  public int             getLocalRegistrationId();
+
+  /**
+   * Save a remote client's identity key
+   * <p>
+   * Store a remote client's identity key as trusted.
+   *
+   * @param recipientId The recipient ID of the remote client.
+   * @param identityKey The remote client's identity key.
+   */
+  public void            saveIdentity(long recipientId, IdentityKey identityKey);
+
+
+  /**
+   * Verify a remote client's identity key.
+   * <p>
+   * Determine whether a remote client's identity is trusted.  Convention is
+   * that the TextSecure protocol is 'trust on first use.'  This means that
+   * an identity key is considered 'trusted' if there is no entry for the recipient
+   * in the local store, or if it matches the saved key for a recipient in the local
+   * store.  Only if it mismatches an entry in the local store is it considered
+   * 'untrusted.'
+   *
+   * @param recipientId The recipient ID of the remote client.
+   * @param identityKey The identity key to verify.
+   * @return true if trusted, false if untrusted.
+   */
+  public boolean         isTrustedIdentity(long recipientId, IdentityKey identityKey);
+
+}