Module olm

Source
Expand description

The crypto specific Olm objects.

Note: You’ll only be interested in these if you are implementing a custom CryptoStore.

Structs§

Account
Account holding identity keys for which sessions can be created.
BackedUpRoomKey
A backed up version of an InboundGroupSession
CrossSigningStatus
Struct representing the state of our private cross signing keys, it shows which private cross signing keys we have locally stored.
Curve25519PublicKey
Struct representing a Curve25519 public key.
EncryptionSettings
Settings for an encrypted room.
ExportedRoomKey
An exported version of an InboundGroupSession
IdentityKeys
Struct holding the two public identity keys of an Account.
InboundGroupSession
A structure representing an inbound group session.
KnownSenderData
Information about the sender of a megolm session where we know the cross-signing identity of the sender.
OlmMessageHash
A hash of a successfully decrypted Olm message.
OutboundGroupSession
Outbound group session.
PickledAccount
A pickled version of an Account.
PickledCrossSigningIdentity
The pickled version of a PrivateCrossSigningIdentity.
PickledInboundGroupSession
A pickled version of an InboundGroupSession.
PickledOutboundGroupSession
A pickled version of an InboundGroupSession.
PickledSession
A pickled version of a Session.
PrivateCrossSigningIdentity
Private cross signing identity.
Session
Cryptographic session that enables secure communication between two Accounts
SessionKey
The session key, can be used to create a InboundGroupSession.
StaticAccountData
Account data that’s static for the lifetime of a Client.

Enums§

SenderData
Information on the device and user that sent the megolm session data to us
SenderDataType
Used when serializing crate::olm::group_sessions::InboundGroupSessions. We want just the type of the session’s SenderData to be queryable, so we store the type as a separate column/property in the database.
SessionCreationError
An error type for the creation of group sessions.
SessionExportError
An error type for the export of inbound group sessions.
ShareInfo
Struct holding info about the share state of a outbound group session.