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.
- Backed
UpRoom Key - A backed up version of an
InboundGroupSession. - Cross
Signing Status - Struct representing the state of our private cross signing keys, it shows which private cross signing keys we have locally stored.
- Curve25519
Public Key - Struct representing a Curve25519 public key.
- Encryption
Settings - Settings for an encrypted room.
- Exported
Room Key - An exported version of an
InboundGroupSession. - Identity
Keys - Struct holding the two public identity keys of an
Account. - Inbound
Group Session - A structure representing an inbound group session.
- Known
Sender Data - Information about the sender of a megolm session where we know the cross-signing identity of the sender.
- OlmMessage
Hash - A hash of a successfully decrypted Olm message.
- Outbound
Group Session - Outbound group session.
- Outbound
Group Session Encryption Result - The result of encrypting a message with an outbound group session.
- Pickled
Account - A pickled version of an
Account. - Pickled
Cross Signing Identity - The pickled version of a
PrivateCrossSigningIdentity. - Pickled
Inbound Group Session - A pickled version of an
InboundGroupSession. - Pickled
Outbound Group Session - A pickled version of an
InboundGroupSession. - Pickled
Session - A pickled version of a
Session. - Private
Cross Signing Identity - Private cross signing identity.
- Session
- Cryptographic session that enables secure communication between two
Accounts - Session
Key - The session key, can be used to create a
InboundGroupSession. - Static
Account Data - Account data that’s static for the lifetime of a Client.
Enums§
- Forwarder
Data - Represents information about the user who forwarded a megolm session under
MSC4268. This is similar to
SenderData, but it is limited to variants where a cross-signing key has been received from the forwarder, as specified in the MSC. - Sender
Data - Information on the device and user that sent the megolm session data to us
- Sender
Data Type - Used when serializing
crate::olm::group_sessions::InboundGroupSessions. We want just the type of the session’sSenderDatato be queryable, so we store the type as a separate column/property in the database. - Session
Creation Error - An error type for the creation of group sessions.
- Session
Export Error - An error type for the export of inbound group sessions.
- Share
Info - Struct holding info about the share state of a outbound group session.