org.jivesoftware.smackx.omemo.signal

Class SignalOmemoKeyUtil

java.lang.Object

org.jivesoftware.smackx.omemo.util.OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

org.jivesoftware.smackx.omemo.signal.SignalOmemoKeyUtil

public class SignalOmemoKeyUtil
extends OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Concrete implementation of the KeyUtil for an implementation using the Signal library.

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smackx.omemo.util.OmemoKeyUtil

OmemoKeyUtil.Bundle

Field Summary

Fields inherited from class org.jivesoftware.smackx.omemo.util.OmemoKeyUtil

BUNDLE

Constructor Summary

Constructors

Constructor and Description
SignalOmemoKeyUtil()

Method Summary

Modifier and Type	Method and Description
OmemoDevice	addressAsOmemoDevice(org.whispersystems.libsignal.SignalProtocolAddress address) Convert a crypto-lib specific contact object into an OmemoDevice.
org.whispersystems.libsignal.state.PreKeyBundle	bundleFromOmemoBundle(OmemoBundleVAxolotlElement bundle, OmemoDevice contact, int preKeyId) Build a crypto-lib specific PreKeyBundle (T_Bundle) using a PreKey from the OmemoBundleElement 'bundle'.
OmemoSession<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>	createOmemoSession(OmemoManager omemoManager, OmemoStore<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher> omemoStore, OmemoDevice from) Create a new crypto-specific Session object.
OmemoSession<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>	createOmemoSession(OmemoManager omemoManager, OmemoStore<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher> omemoStore, OmemoDevice contact, org.whispersystems.libsignal.IdentityKey identityKey) Create a new concrete OmemoSession with a contact.
org.whispersystems.libsignal.ecc.ECPublicKey	ellipticCurvePublicKeyFromBytes(byte[] data) Deserialize an elliptic curve public key from bytes.
org.whispersystems.libsignal.IdentityKeyPair	generateOmemoIdentityKeyPair() Generate a new IdentityKeyPair.
HashMap<Integer,org.whispersystems.libsignal.state.PreKeyRecord>	generateOmemoPreKeys(int currentPreKeyId, int count) Generate 'count' new PreKeys beginning with id 'startId'.
org.whispersystems.libsignal.state.SignedPreKeyRecord	generateOmemoSignedPreKey(org.whispersystems.libsignal.IdentityKeyPair identityKeyPair, int currentPreKeyId) Generate a new signed preKey.
OmemoFingerprint	getFingerprint(org.whispersystems.libsignal.IdentityKey identityKey) Return the fingerprint of an identityKey.
byte[]	identityKeyForBundle(org.whispersystems.libsignal.IdentityKey identityKey) Prepare an identityKey for transport in an OmemoBundleElement (serialize it).
org.whispersystems.libsignal.IdentityKey	identityKeyFromBytes(byte[] data) Deserialize an identityKey from a byte array.
org.whispersystems.libsignal.IdentityKey	identityKeyFromPair(org.whispersystems.libsignal.IdentityKeyPair identityKeyPair) Extract the public identityKey from an identityKeyPair.
org.whispersystems.libsignal.IdentityKeyPair	identityKeyPairFromBytes(byte[] data) Deserialize an identityKeyPair from a byte array.
byte[]	identityKeyPairToBytes(org.whispersystems.libsignal.IdentityKeyPair identityKeyPair) serialize an identityKeyPair into bytes.
byte[]	identityKeyToBytes(org.whispersystems.libsignal.IdentityKey identityKey) Serialize an identityKey into bytes.
org.whispersystems.libsignal.SignalProtocolAddress	omemoDeviceAsAddress(OmemoDevice contact) Convert an OmemoDevice to a crypto-lib specific contact format.
byte[]	preKeyForBundle(org.whispersystems.libsignal.state.PreKeyRecord preKeyRecord) Prepare a preKey for transport in an OmemoBundleElement.
org.whispersystems.libsignal.state.PreKeyRecord	preKeyFromBytes(byte[] bytes) Deserialize a preKey from a byte array.
byte[]	preKeyPublicKeyForBundle(org.whispersystems.libsignal.ecc.ECPublicKey preKey) Prepare an elliptic curve preKey for transport in an OmemoBundleElement.
byte[]	preKeyToBytes(org.whispersystems.libsignal.state.PreKeyRecord preKeyRecord) Serialize a preKey into a byte array.
org.whispersystems.libsignal.state.SessionRecord	rawSessionFromBytes(byte[] data) Deserialize a raw OMEMO Session from bytes.
byte[]	rawSessionToBytes(org.whispersystems.libsignal.state.SessionRecord session) Serialize a raw OMEMO session into a byte array.
org.whispersystems.libsignal.state.SignedPreKeyRecord	signedPreKeyFromBytes(byte[] data) Deserialize a signedPreKey from a byte array.
int	signedPreKeyIdFromKey(org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKey) return the id of the given signedPreKey.
byte[]	signedPreKeyPublicForBundle(org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKey) Prepare a public signedPreKey for transport in a bundle.
byte[]	signedPreKeySignatureFromKey(org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKey) Extract the signature from a signedPreKey.
byte[]	signedPreKeyToBytes(org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKeyRecord) Serialize a signedPreKey into a byte array.

Methods inherited from class org.jivesoftware.smackx.omemo.util.OmemoKeyUtil

addInBounds, preKeyPublicFromBytes, preKeyPublisKeysForBundle, prettyFingerprint, prettyFingerprint, signedPreKeyPublicFromBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

SignalOmemoKeyUtil

public SignalOmemoKeyUtil()

Method Detail

generateOmemoIdentityKeyPair

public org.whispersystems.libsignal.IdentityKeyPair generateOmemoIdentityKeyPair()

Description copied from class: OmemoKeyUtil

Generate a new IdentityKeyPair. We should always have only one pair and usually keep this for a long time.

Specified by:

generateOmemoIdentityKeyPair in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Returns:

identityKeyPair

generateOmemoPreKeys

public HashMap<Integer,org.whispersystems.libsignal.state.PreKeyRecord> generateOmemoPreKeys(int currentPreKeyId,
                                                                                             int count)

Description copied from class: OmemoKeyUtil

Generate 'count' new PreKeys beginning with id 'startId'. These preKeys are published and can be used by contacts to establish sessions with us.

Specified by:

generateOmemoPreKeys in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

currentPreKeyId - start id

count - how many keys do we want to generate

Returns:

Map of new preKeys

generateOmemoSignedPreKey

public org.whispersystems.libsignal.state.SignedPreKeyRecord generateOmemoSignedPreKey(org.whispersystems.libsignal.IdentityKeyPair identityKeyPair,
                                                                                       int currentPreKeyId)
                                                                                throws CorruptedOmemoKeyException

Description copied from class: OmemoKeyUtil

Generate a new signed preKey.

Specified by:

generateOmemoSignedPreKey in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

identityKeyPair - identityKeyPair used to sign the preKey

currentPreKeyId - id that the preKey will have

Returns:

signedPreKey

Throws:

CorruptedOmemoKeyException - when the identityKeyPair is invalid

signedPreKeyFromBytes

public org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKeyFromBytes(byte[] data)
                                                                            throws IOException

Description copied from class: OmemoKeyUtil

Deserialize a signedPreKey from a byte array.

Specified by:

signedPreKeyFromBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

data - byte array

Returns:

deserialized signed preKey

Throws:

IOException - when something goes wrong

signedPreKeyToBytes

public byte[] signedPreKeyToBytes(org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKeyRecord)

Description copied from class: OmemoKeyUtil

Serialize a signedPreKey into a byte array.

Specified by:

signedPreKeyToBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

signedPreKeyRecord - signedPreKey

Returns:

byte array

createOmemoSession

public OmemoSession<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher> createOmemoSession(OmemoManager omemoManager,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OmemoStore<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher> omemoStore,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OmemoDevice contact,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                org.whispersystems.libsignal.IdentityKey identityKey)

Description copied from class: OmemoKeyUtil

Create a new concrete OmemoSession with a contact.

Specified by:

createOmemoSession in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

omemoManager - omemoManager of our device.

omemoStore - omemoStore

contact - device to establish the session with

identityKey - identityKey of the device

Returns:

concrete OmemoSession

createOmemoSession

public OmemoSession<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher> createOmemoSession(OmemoManager omemoManager,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OmemoStore<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher> omemoStore,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OmemoDevice from)

Description copied from class: OmemoKeyUtil

Create a new crypto-specific Session object.

Specified by:

createOmemoSession in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

omemoManager - omemoManager of our device.

omemoStore - omemoStore where we can save the session, get keys from etc.

from - the device we want to create the session with.

Returns:

a new session

rawSessionFromBytes

public org.whispersystems.libsignal.state.SessionRecord rawSessionFromBytes(byte[] data)
                                                                     throws IOException

Description copied from class: OmemoKeyUtil

Deserialize a raw OMEMO Session from bytes.

Specified by:

rawSessionFromBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

data - bytes

Returns:

raw OMEMO Session

Throws:

IOException - when something goes wrong

rawSessionToBytes

public byte[] rawSessionToBytes(org.whispersystems.libsignal.state.SessionRecord session)

Description copied from class: OmemoKeyUtil

Serialize a raw OMEMO session into a byte array.

Specified by:

rawSessionToBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

session - raw session

Returns:

byte array

identityKeyPairFromBytes

public org.whispersystems.libsignal.IdentityKeyPair identityKeyPairFromBytes(byte[] data)
                                                                      throws CorruptedOmemoKeyException

Description copied from class: OmemoKeyUtil

Deserialize an identityKeyPair from a byte array.

Specified by:

identityKeyPairFromBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

data - byte array

Returns:

IdentityKeyPair (T_IdKeyPair)

Throws:

CorruptedOmemoKeyException - if the key is damaged of malformed

identityKeyFromBytes

public org.whispersystems.libsignal.IdentityKey identityKeyFromBytes(byte[] data)
                                                              throws CorruptedOmemoKeyException

Description copied from class: OmemoKeyUtil

Deserialize an identityKey from a byte array.

Specified by:

identityKeyFromBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

data - byte array

Returns:

identityKey (T_IdKey)

Throws:

CorruptedOmemoKeyException - if the key is damaged or malformed

ellipticCurvePublicKeyFromBytes

public org.whispersystems.libsignal.ecc.ECPublicKey ellipticCurvePublicKeyFromBytes(byte[] data)
                                                                             throws CorruptedOmemoKeyException

Description copied from class: OmemoKeyUtil

Deserialize an elliptic curve public key from bytes.

Specified by:

ellipticCurvePublicKeyFromBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

data - bytes

Returns:

elliptic curve public key (T_ECPub)

Throws:

CorruptedOmemoKeyException - if the key is damaged or malformed

preKeyToBytes

public byte[] preKeyToBytes(org.whispersystems.libsignal.state.PreKeyRecord preKeyRecord)

Description copied from class: OmemoKeyUtil

Serialize a preKey into a byte array.

Specified by:

preKeyToBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

preKeyRecord - preKey

Returns:

byte[]

preKeyFromBytes

public org.whispersystems.libsignal.state.PreKeyRecord preKeyFromBytes(byte[] bytes)
                                                                throws IOException

Description copied from class: OmemoKeyUtil

Deserialize a preKey from a byte array.

Specified by:

preKeyFromBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

bytes - byte array

Returns:

deserialized preKey

Throws:

IOException - when something goes wrong

bundleFromOmemoBundle

public org.whispersystems.libsignal.state.PreKeyBundle bundleFromOmemoBundle(OmemoBundleVAxolotlElement bundle,
                                                                             OmemoDevice contact,
                                                                             int preKeyId)
                                                                      throws CorruptedOmemoKeyException

Description copied from class: OmemoKeyUtil

Build a crypto-lib specific PreKeyBundle (T_Bundle) using a PreKey from the OmemoBundleElement 'bundle'. The PreKeyBundle will contain the identityKey, signedPreKey and signature, as well as a preKey from the OmemoBundleElement.

Specified by:

bundleFromOmemoBundle in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

bundle - OmemoBundleElement

contact - Contact that the bundle belongs to

preKeyId - id of the preKey that will be selected from the OmemoBundleElement and that the PreKeyBundle will contain

Returns:

PreKeyBundle (T_PreKey)

Throws:

CorruptedOmemoKeyException - if some key is damaged or malformed

signedPreKeySignatureFromKey

public byte[] signedPreKeySignatureFromKey(org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKey)

Description copied from class: OmemoKeyUtil

Extract the signature from a signedPreKey.

Specified by:

signedPreKeySignatureFromKey in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

signedPreKey - signedPreKey

Returns:

signature as byte array

signedPreKeyIdFromKey

public int signedPreKeyIdFromKey(org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKey)

Description copied from class: OmemoKeyUtil

return the id of the given signedPreKey.

Specified by:

signedPreKeyIdFromKey in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

signedPreKey - key

Returns:

id of the key

identityKeyPairToBytes

public byte[] identityKeyPairToBytes(org.whispersystems.libsignal.IdentityKeyPair identityKeyPair)

Description copied from class: OmemoKeyUtil

serialize an identityKeyPair into bytes.

Specified by:

identityKeyPairToBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

identityKeyPair - identityKeyPair

Returns:

byte array

identityKeyFromPair

public org.whispersystems.libsignal.IdentityKey identityKeyFromPair(org.whispersystems.libsignal.IdentityKeyPair identityKeyPair)

Description copied from class: OmemoKeyUtil

Extract the public identityKey from an identityKeyPair.

Specified by:

identityKeyFromPair in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

identityKeyPair - keyPair

Returns:

public key of the pair

identityKeyForBundle

public byte[] identityKeyForBundle(org.whispersystems.libsignal.IdentityKey identityKey)

Description copied from class: OmemoKeyUtil

Prepare an identityKey for transport in an OmemoBundleElement (serialize it).

Specified by:

identityKeyForBundle in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

identityKey - identityKey that will be transported

Returns:

key as byte array

identityKeyToBytes

public byte[] identityKeyToBytes(org.whispersystems.libsignal.IdentityKey identityKey)

Description copied from class: OmemoKeyUtil

Serialize an identityKey into bytes.

Specified by:

identityKeyToBytes in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

identityKey - idKey

Returns:

bytes

preKeyPublicKeyForBundle

public byte[] preKeyPublicKeyForBundle(org.whispersystems.libsignal.ecc.ECPublicKey preKey)

Description copied from class: OmemoKeyUtil

Prepare an elliptic curve preKey for transport in an OmemoBundleElement.

Specified by:

preKeyPublicKeyForBundle in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

preKey - key

Returns:

key as byte array

preKeyForBundle

public byte[] preKeyForBundle(org.whispersystems.libsignal.state.PreKeyRecord preKeyRecord)

Description copied from class: OmemoKeyUtil

Prepare a preKey for transport in an OmemoBundleElement.

Specified by:

preKeyForBundle in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

preKeyRecord - preKey

Returns:

key as byte array

signedPreKeyPublicForBundle

public byte[] signedPreKeyPublicForBundle(org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKey)

Description copied from class: OmemoKeyUtil

Prepare a public signedPreKey for transport in a bundle.

Specified by:

signedPreKeyPublicForBundle in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

signedPreKey - signedPrekey

Returns:

signedPreKey as byte array

getFingerprint

public OmemoFingerprint getFingerprint(org.whispersystems.libsignal.IdentityKey identityKey)

Description copied from class: OmemoKeyUtil

Return the fingerprint of an identityKey.

Specified by:

getFingerprint in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

identityKey - identityKey

Returns:

fingerprint of the key

omemoDeviceAsAddress

public org.whispersystems.libsignal.SignalProtocolAddress omemoDeviceAsAddress(OmemoDevice contact)

Description copied from class: OmemoKeyUtil

Convert an OmemoDevice to a crypto-lib specific contact format.

Specified by:

omemoDeviceAsAddress in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

contact - omemoContact

Returns:

crypto-lib specific contact object

addressAsOmemoDevice

public OmemoDevice addressAsOmemoDevice(org.whispersystems.libsignal.SignalProtocolAddress address)
                                 throws XmppStringprepException

Description copied from class: OmemoKeyUtil

Convert a crypto-lib specific contact object into an OmemoDevice.

Specified by:

addressAsOmemoDevice in class OmemoKeyUtil<org.whispersystems.libsignal.IdentityKeyPair,org.whispersystems.libsignal.IdentityKey,org.whispersystems.libsignal.state.PreKeyRecord,org.whispersystems.libsignal.state.SignedPreKeyRecord,org.whispersystems.libsignal.state.SessionRecord,org.whispersystems.libsignal.SignalProtocolAddress,org.whispersystems.libsignal.ecc.ECPublicKey,org.whispersystems.libsignal.state.PreKeyBundle,org.whispersystems.libsignal.SessionCipher>

Parameters:

address - contact

Returns:

as OmemoDevice

Throws:

XmppStringprepException - if the address is not a valid BareJid