Class OlmSession

An Olm session with one other device: a double ratchet for encrypting to-device messages.

Inheritance
object
OlmSession
Implements
Inherited Members
Namespace: Uniform.Matrix.Protocol.Crypto
Assembly: Uniform.Matrix.Protocol.Crypto.dll
Syntax
public sealed class OlmSession : IDisposable
Remarks

Ported from vodozemac 0.11.1 (olm/session), session config version 1: truncated MACs. Pickles use vodozemac's format.

Properties

| Edit this page View Source

SessionId

Session ID: SHA-256 of the identity, base and one-time keys.

Declaration
public string SessionId { get; }
Property Value
Type Description
string

Methods

| Edit this page View Source

Decrypt(OlmMessage)

Decrypt a message of this session; throw OlmException when it does not decrypt.

Declaration
public byte[] Decrypt(OlmMessage message)
Parameters
Type Name Description
OlmMessage message
Returns
Type Description
byte[]
| Edit this page View Source

Dispose()

Wipe secrets.

Declaration
public void Dispose()
| Edit this page View Source

Encrypt(byte[])

Encrypt plaintext: a pre-key message until the other side has answered.

Declaration
public OlmMessage Encrypt(byte[] plaintext)
Parameters
Type Name Description
byte[] plaintext
Returns
Type Description
OlmMessage
| Edit this page View Source

Encrypt(string)

Encrypt UTF-8 plaintext.

Declaration
public OlmMessage Encrypt(string plaintext)
Parameters
Type Name Description
string plaintext
Returns
Type Description
OlmMessage
| Edit this page View Source

FromPickle(string, ReadOnlySpan<byte>)

Restore a session from Pickle(ReadOnlySpan<byte>); throw OlmException for a wrong key.

Declaration
public static OlmSession FromPickle(string pickle, ReadOnlySpan<byte> key)
Parameters
Type Name Description
string pickle
ReadOnlySpan<byte> key
Returns
Type Description
OlmSession
| Edit this page View Source

Pickle(ReadOnlySpan<byte>)

Pickle the session in vodozemac's format, encrypted with 32-byte key.

Declaration
public string Pickle(ReadOnlySpan<byte> key)
Parameters
Type Name Description
ReadOnlySpan<byte> key
Returns
Type Description
string
| Edit this page View Source

PreKeySessionId(string)

Return the ID of the session a pre-key message would create or continue.

Declaration
public static string PreKeySessionId(string preKeyCiphertext)
Parameters
Type Name Description
string preKeyCiphertext
Returns
Type Description
string

Implements