org.whispersystems.libsignal.state.impl

Class InMemorySignalProtocolStore

java.lang.Object

org.whispersystems.libsignal.state.impl.InMemorySignalProtocolStore

All Implemented Interfaces:

IdentityKeyStore, PreKeyStore, SessionStore, SignalProtocolStore, SignedPreKeyStore

public class InMemorySignalProtocolStore
extends java.lang.Object
implements SignalProtocolStore

Nested Class Summary

Nested classes/interfaces inherited from interface org.whispersystems.libsignal.state.IdentityKeyStore

IdentityKeyStore.Direction

Constructor Summary

Constructors

Constructor and Description
InMemorySignalProtocolStore(IdentityKeyPair identityKeyPair, int registrationId)

Method Summary

Modifier and Type	Method and Description
boolean	containsPreKey(int preKeyId)
boolean	containsSession(SignalProtocolAddress address) Determine whether there is a committed SessionRecord for a recipientId + deviceId tuple.
boolean	containsSignedPreKey(int signedPreKeyId)
void	deleteAllSessions(java.lang.String name) Remove the SessionRecords corresponding to all devices of a recipientId.
void	deleteSession(SignalProtocolAddress address) Remove a SessionRecord for a recipientId + deviceId tuple.
IdentityKey	getIdentity(SignalProtocolAddress address) Return the saved public identity key for a remote client
IdentityKeyPair	getIdentityKeyPair() Get the local client's identity key pair.
int	getLocalRegistrationId() Return the local client's registration ID.
java.util.List<java.lang.Integer>	getSubDeviceSessions(java.lang.String name) Returns all known devices with active sessions for a recipient
boolean	isTrustedIdentity(SignalProtocolAddress address, IdentityKey identityKey, IdentityKeyStore.Direction direction) Verify a remote client's identity key.
PreKeyRecord	loadPreKey(int preKeyId) Load a local PreKeyRecord.
SessionRecord	loadSession(SignalProtocolAddress address) Returns a copy of the SessionRecord corresponding to the recipientId + deviceId tuple, or a new SessionRecord if one does not currently exist.
SignedPreKeyRecord	loadSignedPreKey(int signedPreKeyId) Load a local SignedPreKeyRecord.
java.util.List<SignedPreKeyRecord>	loadSignedPreKeys() Load all local SignedPreKeyRecords.
void	removePreKey(int preKeyId) Delete a PreKeyRecord from local storage.
void	removeSignedPreKey(int signedPreKeyId) Delete a SignedPreKeyRecord from local storage.
boolean	saveIdentity(SignalProtocolAddress address, IdentityKey identityKey) Save a remote client's identity key
void	storePreKey(int preKeyId, PreKeyRecord record) Store a local PreKeyRecord.
void	storeSession(SignalProtocolAddress address, SessionRecord record) Commit to storage the SessionRecord for a given recipientId + deviceId tuple.
void	storeSignedPreKey(int signedPreKeyId, SignedPreKeyRecord record) Store a local SignedPreKeyRecord.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InMemorySignalProtocolStore

public InMemorySignalProtocolStore(IdentityKeyPair identityKeyPair,
                                   int registrationId)

Method Detail

getIdentityKeyPair

public IdentityKeyPair getIdentityKeyPair()

Description copied from interface: IdentityKeyStore

Get the local client's identity key pair.

Specified by:

getIdentityKeyPair in interface IdentityKeyStore

Returns:

The local client's persistent identity key pair.

getLocalRegistrationId

public int getLocalRegistrationId()

Description copied from interface: IdentityKeyStore

Return the local client's registration ID.

Clients should maintain a registration ID, a random number between 1 and 16380 that's generated once at install time.

Specified by:

getLocalRegistrationId in interface IdentityKeyStore

Returns:

the local client's registration ID.

saveIdentity

public boolean saveIdentity(SignalProtocolAddress address,
                            IdentityKey identityKey)

Description copied from interface: IdentityKeyStore

Save a remote client's identity key

Store a remote client's identity key as trusted.

Specified by:

saveIdentity in interface IdentityKeyStore

Parameters:

address - The address of the remote client.

identityKey - The remote client's identity key.

Returns:

True if the identity key replaces a previous identity, false if not

isTrustedIdentity

public boolean isTrustedIdentity(SignalProtocolAddress address,
                                 IdentityKey identityKey,
                                 IdentityKeyStore.Direction direction)

Description copied from interface: IdentityKeyStore

Verify a remote client's identity key.

Determine whether a remote client's identity is trusted. Convention is that the Signal 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.' Clients may wish to make a distinction as to how keys are trusted based on the direction of travel. For instance, clients may wish to accept all 'incoming' identity key changes, while only blocking identity key changes when sending a message.

Specified by:

isTrustedIdentity in interface IdentityKeyStore

Parameters:

address - The address of the remote client.

identityKey - The identity key to verify.

direction - The direction (sending or receiving) this identity is being used for.

Returns:

true if trusted, false if untrusted.

getIdentity

public IdentityKey getIdentity(SignalProtocolAddress address)

Description copied from interface: IdentityKeyStore

Return the saved public identity key for a remote client

Specified by:

getIdentity in interface IdentityKeyStore

Parameters:

address - The address of the remote client

Returns:

The public identity key, or null if absent

loadPreKey

public PreKeyRecord loadPreKey(int preKeyId)
                        throws InvalidKeyIdException

Description copied from interface: PreKeyStore

Load a local PreKeyRecord.

Specified by:

loadPreKey in interface PreKeyStore

Parameters:

preKeyId - the ID of the local PreKeyRecord.

Returns:

the corresponding PreKeyRecord.

Throws:

InvalidKeyIdException - when there is no corresponding PreKeyRecord.

storePreKey

public void storePreKey(int preKeyId,
                        PreKeyRecord record)

Description copied from interface: PreKeyStore

Store a local PreKeyRecord.

Specified by:

storePreKey in interface PreKeyStore

Parameters:

preKeyId - the ID of the PreKeyRecord to store.

record - the PreKeyRecord.

containsPreKey

public boolean containsPreKey(int preKeyId)

Specified by:

containsPreKey in interface PreKeyStore

Parameters:

preKeyId - A PreKeyRecord ID.

Returns:

true if the store has a record for the preKeyId, otherwise false.

removePreKey

public void removePreKey(int preKeyId)

Description copied from interface: PreKeyStore

Delete a PreKeyRecord from local storage.

Specified by:

removePreKey in interface PreKeyStore

Parameters:

preKeyId - The ID of the PreKeyRecord to remove.

loadSession

public SessionRecord loadSession(SignalProtocolAddress address)

Description copied from interface: SessionStore

Returns a copy of the SessionRecord corresponding to the recipientId + deviceId tuple, or a new SessionRecord if one does not currently exist.

It is important that implementations return a copy of the current durable information. The returned SessionRecord may be modified, but those changes should not have an effect on the durable session state (what is returned by subsequent calls to this method) without the store method being called here first.

Specified by:

loadSession in interface SessionStore

Parameters:

address - The name and device ID of the remote client.

Returns:

a copy of the SessionRecord corresponding to the recipientId + deviceId tuple, or a new SessionRecord if one does not currently exist.

getSubDeviceSessions

public java.util.List<java.lang.Integer> getSubDeviceSessions(java.lang.String name)

Description copied from interface: SessionStore

Returns all known devices with active sessions for a recipient

Specified by:

getSubDeviceSessions in interface SessionStore

Parameters:

name - the name of the client.

Returns:

all known sub-devices with active sessions.

storeSession

public void storeSession(SignalProtocolAddress address,
                         SessionRecord record)

Description copied from interface: SessionStore

Commit to storage the SessionRecord for a given recipientId + deviceId tuple.

Specified by:

storeSession in interface SessionStore

Parameters:

address - the address of the remote client.

record - the current SessionRecord for the remote client.

containsSession

public boolean containsSession(SignalProtocolAddress address)

Description copied from interface: SessionStore

Determine whether there is a committed SessionRecord for a recipientId + deviceId tuple.

Specified by:

containsSession in interface SessionStore

Parameters:

address - the address of the remote client.

Returns:

true if a SessionRecord exists, false otherwise.

deleteSession

public void deleteSession(SignalProtocolAddress address)

Description copied from interface: SessionStore

Remove a SessionRecord for a recipientId + deviceId tuple.

Specified by:

deleteSession in interface SessionStore

Parameters:

address - the address of the remote client.

deleteAllSessions

public void deleteAllSessions(java.lang.String name)

Description copied from interface: SessionStore

Remove the SessionRecords corresponding to all devices of a recipientId.

Specified by:

deleteAllSessions in interface SessionStore

Parameters:

name - the name of the remote client.

loadSignedPreKey

public SignedPreKeyRecord loadSignedPreKey(int signedPreKeyId)
                                    throws InvalidKeyIdException

Description copied from interface: SignedPreKeyStore

Load a local SignedPreKeyRecord.

Specified by:

loadSignedPreKey in interface SignedPreKeyStore

Parameters:

signedPreKeyId - the ID of the local SignedPreKeyRecord.

Returns:

the corresponding SignedPreKeyRecord.

Throws:

InvalidKeyIdException - when there is no corresponding SignedPreKeyRecord.

loadSignedPreKeys

public java.util.List<SignedPreKeyRecord> loadSignedPreKeys()

Description copied from interface: SignedPreKeyStore

Load all local SignedPreKeyRecords.

Specified by:

loadSignedPreKeys in interface SignedPreKeyStore

Returns:

All stored SignedPreKeyRecords.

storeSignedPreKey

public void storeSignedPreKey(int signedPreKeyId,
                              SignedPreKeyRecord record)

Description copied from interface: SignedPreKeyStore

Store a local SignedPreKeyRecord.

Specified by:

storeSignedPreKey in interface SignedPreKeyStore

Parameters:

signedPreKeyId - the ID of the SignedPreKeyRecord to store.

record - the SignedPreKeyRecord.

containsSignedPreKey

public boolean containsSignedPreKey(int signedPreKeyId)

Specified by:

containsSignedPreKey in interface SignedPreKeyStore

Parameters:

signedPreKeyId - A SignedPreKeyRecord ID.

Returns:

true if the store has a record for the signedPreKeyId, otherwise false.

removeSignedPreKey

public void removeSignedPreKey(int signedPreKeyId)

Description copied from interface: SignedPreKeyStore

Delete a SignedPreKeyRecord from local storage.

Specified by:

removeSignedPreKey in interface SignedPreKeyStore

Parameters:

signedPreKeyId - The ID of the SignedPreKeyRecord to remove.