Class MegolmInboundSession

Inbound Megolm session: decrypts one sender's room messages from the index its key was shared at.

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

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

Properties

| Edit this page View Source

FirstKnownIndex

First message index this session can decrypt.

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

SessionId

Session ID: the sender's public signing key, unpadded base64.

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

Methods

| Edit this page View Source

Decrypt(string)

Decrypt a Megolm message; throw OlmException for bad signatures, MACs or an index before FirstKnownIndex.

Declaration
public MegolmPlaintext Decrypt(string ciphertext)
Parameters
Type Name Description
string ciphertext
Returns
Type Description
MegolmPlaintext
| Edit this page View Source

Dispose()

Wipe secrets.

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

ExportAt(uint)

Export the session from index on, to share with another device or a backup; throw OlmException before FirstKnownIndex.

Declaration
public string ExportAt(uint index)
Parameters
Type Name Description
uint index
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 MegolmInboundSession FromPickle(string pickle, ReadOnlySpan<byte> key)
Parameters
Type Name Description
string pickle
ReadOnlySpan<byte> key
Returns
Type Description
MegolmInboundSession
| Edit this page View Source

FromSessionKey(string)

Create a session from a signed session key of m.room_key; throw OlmException when the signature is invalid.

Declaration
public static MegolmInboundSession FromSessionKey(string sessionKey)
Parameters
Type Name Description
string sessionKey
Returns
Type Description
MegolmInboundSession
| Edit this page View Source

Import(string)

Create a session from an exported key, e.g. from a key backup or another device; not signed, so the sender is not proven.

Declaration
public static MegolmInboundSession Import(string exportedKey)
Parameters
Type Name Description
string exportedKey
Returns
Type Description
MegolmInboundSession
| 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