Class MegolmOutboundSession

Outbound Megolm session: encrypts room messages for everyone who has its session key.

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

Ported from vodozemac 0.11.1 (megolm/group_session), session config version 1. Pickles use vodozemac's format.

Properties

| Edit this page View Source

MessageIndex

Index of the next message.

Declaration
public uint MessageIndex { get; }
Property Value
Type Description
uint
| Edit this page View Source

SessionId

Session ID: the public signing key, unpadded base64.

Declaration
public string SessionId { get; }
Property Value
Type Description
string
| Edit this page View Source

SessionKey

The session key at the current index, signed, to share in m.room_key.

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

Methods

| Edit this page View Source

Create()

Create a session with a random ratchet and signing key.

Declaration
public static MegolmOutboundSession Create()
Returns
Type Description
MegolmOutboundSession
| Edit this page View Source

Dispose()

Wipe secrets.

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

Encrypt(byte[])

Encrypt plaintext at the current index, then advance the ratchet.

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

Encrypt(string)

Encrypt UTF-8 plaintext.

Declaration
public string Encrypt(string plaintext)
Parameters
Type Name Description
string plaintext
Returns
Type Description
string
| 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 MegolmOutboundSession FromPickle(string pickle, ReadOnlySpan<byte> key)
Parameters
Type Name Description
string pickle
ReadOnlySpan<byte> key
Returns
Type Description
MegolmOutboundSession
| 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

Implements