org.jivesoftware.smackx.omemo

Class OmemoService<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph>

java.lang.Object

org.jivesoftware.smackx.omemo.OmemoService<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph>

Type Parameters:

T_IdKeyPair - IdentityKeyPair class

T_IdKey - IdentityKey class

T_PreKey - PreKey class

T_SigPreKey - SignedPreKey class

T_Sess - Session class

T_Addr - Address class

T_ECPub - Elliptic Curve PublicKey class

T_Bundle - Bundle class

T_Ciph - Cipher class

Direct Known Subclasses:

SignalOmemoService

public abstract class OmemoService<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph>
extends Object

This class contains OMEMO related logic and registers listeners etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOGGER
protected OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph>	omemoStore

Constructor Summary

Constructors

Constructor and Description
OmemoService() Create a new OmemoService object.

Method Summary

Modifier and Type	Method and Description
void	buildSessionFromOmemoBundle(OmemoManager omemoManager, OmemoDevice device, boolean fresh) Build an OmemoSession for the given OmemoDevice.
protected static void	checkAvailableAlgorithms() Test availability of required algorithms.
abstract OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph>	createDefaultOmemoStoreBackend() Create a default OmemoStore object.
static OmemoService<?,?,?,?,?,?,?,?,?>	getInstance()
protected Message	getOmemoRatchetUpdateMessage(OmemoManager omemoManager, OmemoDevice recipient, boolean preKeyMessage) Return a new RatchetUpdateMessage.
OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph>	getOmemoStoreBackend() Return the used omemoStore backend.
static boolean	isServiceRegistered()
protected abstract void	processBundle(OmemoManager omemoManager, T_Bundle bundle, OmemoDevice device) Process a received bundle.
protected void	sendOmemoRatchetUpdateMessage(OmemoManager omemoManager, OmemoDevice recipient, boolean preKeyMessage) Send an OmemoRatchetUpdateMessage to recipient.
protected static void	setInstance(OmemoService<?,?,?,?,?,?,?,?,?> omemoService) Set singleton instance.
void	setOmemoStoreBackend(OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph> omemoStore) Set an omemoStore as backend.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final Logger LOGGER

omemoStore

protected OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph> omemoStore

Constructor Detail

OmemoService

public OmemoService()
             throws NoSuchPaddingException,
                    InvalidKeyException,
                    UnsupportedEncodingException,
                    IllegalBlockSizeException,
                    BadPaddingException,
                    NoSuchAlgorithmException,
                    NoSuchProviderException,
                    InvalidAlgorithmParameterException

Create a new OmemoService object. This should only happen once. When the service gets created, it tries a placeholder crypto function in order to test, if all necessary algorithms are available on the system.

Throws:

NoSuchPaddingException - When no Cipher could be instantiated.

NoSuchAlgorithmException - when no Cipher could be instantiated.

NoSuchProviderException - when BouncyCastle could not be found.

InvalidAlgorithmParameterException - when the Cipher could not be initialized

InvalidKeyException - when the generated key is invalid

UnsupportedEncodingException - when UTF8 is unavailable

BadPaddingException - when cipher.doFinal gets wrong padding

IllegalBlockSizeException - when cipher.doFinal gets wrong Block size.

Method Detail

getInstance

public static OmemoService<?,?,?,?,?,?,?,?,?> getInstance()

setInstance

protected static void setInstance(OmemoService<?,?,?,?,?,?,?,?,?> omemoService)

Set singleton instance. Throws an IllegalStateException, if there is already a service set as instance.

Parameters:

omemoService - instance

isServiceRegistered

public static boolean isServiceRegistered()

getOmemoStoreBackend

public OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph> getOmemoStoreBackend()

Return the used omemoStore backend. If there is no store backend set yet, set the default one (typically a file-based one).

Returns:

omemoStore backend

setOmemoStoreBackend

public void setOmemoStoreBackend(OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph> omemoStore)

Set an omemoStore as backend. Throws an IllegalStateException, if there is already a backend set.

Parameters:

omemoStore - store.

createDefaultOmemoStoreBackend

public abstract OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph> createDefaultOmemoStoreBackend()

Create a default OmemoStore object.

Returns:

default omemoStore.

checkAvailableAlgorithms

protected static void checkAvailableAlgorithms()
                                        throws NoSuchPaddingException,
                                               UnsupportedEncodingException,
                                               InvalidAlgorithmParameterException,
                                               NoSuchAlgorithmException,
                                               IllegalBlockSizeException,
                                               BadPaddingException,
                                               NoSuchProviderException,
                                               InvalidKeyException

Test availability of required algorithms. We do this in advance, so we can simplify exception handling later.

Throws:

NoSuchPaddingException

UnsupportedEncodingException

InvalidAlgorithmParameterException

NoSuchAlgorithmException

IllegalBlockSizeException

BadPaddingException

NoSuchProviderException

InvalidKeyException

buildSessionFromOmemoBundle

public void buildSessionFromOmemoBundle(OmemoManager omemoManager,
                                        OmemoDevice device,
                                        boolean fresh)
                                 throws CannotEstablishOmemoSessionException,
                                        CorruptedOmemoKeyException

Build an OmemoSession for the given OmemoDevice.

Parameters:

omemoManager - omemoManager

device - OmemoDevice

fresh - Do we want to build a session even if we already have one?

Throws:

CannotEstablishOmemoSessionException - when no session could be established

CorruptedOmemoKeyException - when the bundle contained an invalid OMEMO identityKey

processBundle

protected abstract void processBundle(OmemoManager omemoManager,
                                      T_Bundle bundle,
                                      OmemoDevice device)
                               throws CorruptedOmemoKeyException

Process a received bundle. Typically that includes saving keys and building a session.

Parameters:

omemoManager - omemoManager that will process the bundle

bundle - T_Bundle (depends on used Signal/Olm library)

device - OmemoDevice

Throws:

CorruptedOmemoKeyException

getOmemoRatchetUpdateMessage

protected Message getOmemoRatchetUpdateMessage(OmemoManager omemoManager,
                                               OmemoDevice recipient,
                                               boolean preKeyMessage)
                                        throws CannotEstablishOmemoSessionException,
                                               CorruptedOmemoKeyException,
                                               CryptoFailedException,
                                               UndecidedOmemoIdentityException

Return a new RatchetUpdateMessage.

Parameters:

omemoManager - omemoManager of the sending device.

recipient - recipient

preKeyMessage - if true, a new session will be built for this message (useful to repair broken sessions) otherwise the message will be encrypted using the existing session.

Returns:

OmemoRatchetUpdateMessage

Throws:

CannotEstablishOmemoSessionException

CorruptedOmemoKeyException

CryptoFailedException

UndecidedOmemoIdentityException

sendOmemoRatchetUpdateMessage

protected void sendOmemoRatchetUpdateMessage(OmemoManager omemoManager,
                                             OmemoDevice recipient,
                                             boolean preKeyMessage)
                                      throws UndecidedOmemoIdentityException,
                                             CorruptedOmemoKeyException,
                                             CryptoFailedException,
                                             CannotEstablishOmemoSessionException

Send an OmemoRatchetUpdateMessage to recipient. If preKeyMessage is true, the message will be encrypted using a freshly built session. This can be used to repair broken sessions.

Parameters:

omemoManager - omemoManager of the sending device.

recipient - recipient

preKeyMessage - shall this be a preKeyMessage?

Throws:

UndecidedOmemoIdentityException

CorruptedOmemoKeyException

CryptoFailedException

CannotEstablishOmemoSessionException