org.jivesoftware.smackx.omemo.util

Class OmemoMessageBuilder<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.util.OmemoMessageBuilder<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

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

Class used to build OMEMO messages.

Constructor Summary

Constructors

Constructor and Description
OmemoMessageBuilder(OmemoManager omemoManager, OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph> omemoStore, byte[] aesKey, byte[] iv) Create a OmemoMessageBuilder.
OmemoMessageBuilder(OmemoManager omemoManager, OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph> omemoStore, String message) Create a new OmemoMessageBuilder with random IV and AES key.

Method Summary

Modifier and Type	Method and Description
void	addRecipient(OmemoDevice device) Add a new recipient device to the message.
void	addRecipient(OmemoDevice device, boolean ignoreTrust) Add a new recipient device to the message.
OmemoVAxolotlElement	finish() Assemble an OmemoMessageElement from the current state of the builder.
static byte[]	generateIv() Generate a 16 byte initialization vector for AES encryption.
static byte[]	generateKey() Generate a new AES key used to encrypt the message.
byte[]	getCiphertextMessage()
byte[]	getMessageKey()
void	setMessage(String message) Create an AES messageKey and use it to encrypt the message.

Methods inherited from class java.lang.Object

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

Constructor Detail

OmemoMessageBuilder

public OmemoMessageBuilder(OmemoManager omemoManager,
                           OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph> omemoStore,
                           byte[] aesKey,
                           byte[] iv)
                    throws NoSuchPaddingException,
                           BadPaddingException,
                           InvalidKeyException,
                           NoSuchAlgorithmException,
                           IllegalBlockSizeException,
                           UnsupportedEncodingException,
                           NoSuchProviderException,
                           InvalidAlgorithmParameterException

Create a OmemoMessageBuilder.

Parameters:

omemoManager - OmemoManager of our device.

omemoStore - OmemoStore.

aesKey - AES key that will be transported to the recipient. This is used eg. to encrypt the body.

iv - IV

Throws:

NoSuchPaddingException

BadPaddingException

InvalidKeyException

NoSuchAlgorithmException

IllegalBlockSizeException

UnsupportedEncodingException

NoSuchProviderException

InvalidAlgorithmParameterException

OmemoMessageBuilder

public OmemoMessageBuilder(OmemoManager omemoManager,
                           OmemoStore<T_IdKeyPair,T_IdKey,T_PreKey,T_SigPreKey,T_Sess,T_Addr,T_ECPub,T_Bundle,T_Ciph> omemoStore,
                           String message)
                    throws NoSuchPaddingException,
                           BadPaddingException,
                           InvalidKeyException,
                           NoSuchAlgorithmException,
                           IllegalBlockSizeException,
                           UnsupportedEncodingException,
                           NoSuchProviderException,
                           InvalidAlgorithmParameterException

Create a new OmemoMessageBuilder with random IV and AES key.

Parameters:

omemoManager - omemoManager of our device.

omemoStore - omemoStore.

message - Messages body.

Throws:

NoSuchPaddingException

BadPaddingException

InvalidKeyException

NoSuchAlgorithmException

IllegalBlockSizeException

UnsupportedEncodingException

NoSuchProviderException

InvalidAlgorithmParameterException

Method Detail

setMessage

public void setMessage(String message)
                throws NoSuchPaddingException,
                       NoSuchAlgorithmException,
                       NoSuchProviderException,
                       InvalidAlgorithmParameterException,
                       InvalidKeyException,
                       UnsupportedEncodingException,
                       BadPaddingException,
                       IllegalBlockSizeException

Create an AES messageKey and use it to encrypt the message. Optionally append the Auth Tag of the encrypted message to the messageKey afterwards.

Parameters:

message - content of the message

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.

addRecipient

public void addRecipient(OmemoDevice device)
                  throws CryptoFailedException,
                         UndecidedOmemoIdentityException,
                         CorruptedOmemoKeyException

Add a new recipient device to the message.

Parameters:

device - recipient device

Throws:

CryptoFailedException - when encrypting the messageKey fails

UndecidedOmemoIdentityException

CorruptedOmemoKeyException

addRecipient

public void addRecipient(OmemoDevice device,
                         boolean ignoreTrust)
                  throws CryptoFailedException,
                         UndecidedOmemoIdentityException,
                         CorruptedOmemoKeyException

Add a new recipient device to the message.

Parameters:

device - recipient device

ignoreTrust - ignore current trust state? Useful for keyTransportMessages that are sent to repair a session

Throws:

CryptoFailedException

UndecidedOmemoIdentityException

CorruptedOmemoKeyException

finish

public OmemoVAxolotlElement finish()

Assemble an OmemoMessageElement from the current state of the builder.

Returns:

OmemoMessageElement

generateKey

public static byte[] generateKey()
                          throws NoSuchAlgorithmException

Generate a new AES key used to encrypt the message.

Returns:

new AES key

Throws:

NoSuchAlgorithmException

generateIv

public static byte[] generateIv()

Generate a 16 byte initialization vector for AES encryption.

Returns:

iv

getCiphertextMessage

public byte[] getCiphertextMessage()

getMessageKey

public byte[] getMessageKey()