API

• SignalProtocolAddress
• SessionBuilder
• SessionCipher

SignalProtocolAddress

new SignalProtocolAddress(number, deviceId)

Constructs a new SignalProtocolAddress.

Parameter	Type	Description
number	String	The storage interface.
deviceId	Number	Remote address

SignalProtocolAddress.fromString(str)

Constructs a new SignalProtocolAddress from a string.

Parameter	Type	Description
str	String

SignalProtocolAddress.getName()

Parameter	Type	Description
returns	String

SignalProtocolAddress.getDeviceId()

Parameter	Type	Description
returns	Number

SignalProtocolAddress.toString()

Convert the address into it's string form.

Parameter	Type	Description
returns	String

SignalProtocolAddress.equals(signalProtocolAddress)

Compares one address to another.

Parameter	Type	Description
returns	Boolean

---

SessionBuilder

new SessionBuilder(store, address)

Constructs a new SessionBuilder.

Parameter	Type	Description
store	SignalProtocolStore	A storage interface
address	SignalProtocolAddress	A remote address

SessionBuilder.processPreKey(preKeyBundle)

Create a new session from a PreKey bundle returned by the server.

Parameter	Type	Description
preKeyBundle	Object	{ registrationId: <Number>, identityKey: <ArrayBuffer>, signedPreKey: { keyId: <Number>, publicKey: <ArrayBuffer>, signature: <ArrayBuffer> }, preKey: { keyId: <Number>, publicKey : <ArrayBuffer> } }
returns	Promise

SessionBuilder.processV3(record, preKeyWhisperMessage)

Construct a new session from a preKeyWhisperMessage. Modifies the given record object but does not save the change to the store. This method is not used in practice, as it is automatically called internally by decryptPreKeyWhisperMessage.

Parameter	Type	Description
record	SessionRecord
preKeyWhisperMessage	PreKeyWhisperMessage
returns	Promise

SessionCipher

new SessionCipher(store, address)

Constructs a new SessionCipher.

Parameter	Type	Description
store	SignalProtocolStore	A storage interface
address	SignalProtocolAddress	A remote address

SessionCipher.encrypt(message, encoding=)

Encrypt a message to the cipher's address.

Parameter	Type	Description
message	ByteBuffer | ArrayBuffer | Uint8Array | String	Anything that can be wrapped by a ByteBuffer
encoding	String	String encoding if message is a string ("base64", "hex", "binary", defaults to "utf8")
returns	Promise	resolves to object: {type: <Number>, body: <String>}

SessionCipher.decryptWhisperMessage(message, encoding=)

Decrypt a normal message.

Parameter	Type	Description
message	ByteBuffer | ArrayBuffer | Uint8Array | String	Anything that can be wrapped by a ByteBuffer
encoding	String	String encoding if message is a string ("base64", "hex", "binary", defaults to "utf8")
returns	Promise	resolves to ArrayBuffer

SessionCipher.decryptPreKeyWhisperMessage(message, encoding=)

Decrypt a PreKey message.

Parameter	Type	Description
message	ByteBuffer | ArrayBuffer | Uint8Array | String	Anything that can be wrapped by a ByteBuffer
encoding	String	String encoding if message is a string ("base64", "hex", "binary", defaults to "utf8")
returns	Promise	resolves to ArrayBuffer

---