Expand description
Uniffi based bindings for the matrix-sdk-crypto crate.
This crate can be used to introduce E2EE support into an existing Matrix client or client library in any of the language targets Uniffi supports.
Structs§
- Backup
Keys - Backup keys and information we load from the store.
- Backup
Recovery Key - The private part of the backup key, the one used for recovery.
- Bootstrap
Cross Signing Result - Cancel
Info - Information on why a verification flow has been cancelled and by whom.
- Confirm
Verification Result - A result type for confirming verifications.
- Cross
Signing KeyExport - A struct containing private cross signing keys that can be backed up or uploaded to the secret store.
- Cross
Signing Status - Struct representing the state of our private cross signing keys, it shows which private cross signing keys we have locally stored.
- Decrypted
Event - An event that was successfully decrypted.
- Dehydrated
Device Key - Dehydrated device key
- Device
- An E2EE capable Matrix device.
- Device
Lists - Encryption
Settings - Settings that should be used when a room key is shared.
- KeyRequest
Pair - A pair of outgoing room key requests, both of those are sendToDevice requests.
- Keys
Import Result - Megolm
V1Backup Key - The public part of the backup key.
- Migration
Data - Struct collecting data that is important to migrate to the rust-sdk
- OlmMachine
- A high level state machine that handles E2EE for Matrix.
- Passphrase
Info - Struct containing info about the way the backup key got derived from a passphrase.
- Pickled
Account - A pickled version of an
Account. - Pickled
Inbound Group Session - A pickled version of an
InboundGroupSession. - Pickled
Session - A pickled version of a
Session. - PkEncryption
- The encryption component of PkEncryption support.
- PkMessage
- A message that was encrypted using a
PkEncryptionobject. - QrCode
- The
m.qr_code.scan.v1,m.qr_code.show.v1, andm.reciprocate.v1verification flow. - Request
Verification Result - A result type for requesting verifications.
- Room
KeyCounts - Struct holding the number of room keys we have.
- Room
Settings - Room encryption settings which are modified by state events or user options
- Sas
- The
m.sas.v1verification flow. - Scan
Result - A result type for scanning QR codes.
- Session
Migration Data - Struct collecting data that is important to migrate sessions to the rust-sdk
- Shield
State - Take a look at
matrix_sdk_common::deserialized_responses::ShieldStatefor more info. - Signature
Upload Request - Signature
Verification - The result of a signature verification of a signed JSON object.
- Start
SasResult - A result type for starting SAS verifications.
- Upload
Signing Keys Request - Verification
- Enum representing the different verification flows we support.
- Verification
Request - The verificatoin request object which then can transition into some concrete verification method
- Version
Info - Build-time information about important crates that are used.
Enums§
- Crypto
Store Error - Decode
Error - Error type for the decoding and storing of the backup key.
- Decryption
Error - Event
Encryption Algorithm - An encryption algorithm to be used to encrypt messages sent to a room.
- History
Visibility - Who can see a room’s history.
- KeyImport
Error - Migration
Error - Error type for the migration process.
- Outgoing
Verification Request - PkDecryption
Error - Error type for the decryption of backed up room keys.
- QrCode
State - An Enum describing the state the QrCode verification is in.
- Request
- Request
Type - SasState
- An Enum describing the state the SAS verification is in.
- Secret
Import Error - Shield
Color - Take a look at
matrix_sdk_common::deserialized_responses::ShieldStatefor more info. - Signature
Error - User
Identity - Enum representing cross signing identity of our own user or some other user.
- Verification
Request State - An Enum describing the state the QrCode verification is in.
Traits§
- Logger
- Trait that can be used to forward Rust logs over FFI to a language specific logger.
- Progress
Listener - Callback that will be passed over the FFI to report progress
- QrCode
Listener - Listener that will be passed over the FFI to report changes to a QrCode verification.
- SasListener
- Listener that will be passed over the FFI to report changes to a SAS verification.
- Verification
Request Listener - Listener that will be passed over the FFI to report changes to a verification request.
Functions§
- migrate
- Migrate a libolm based setup to a vodozemac based setup stored in a SQLite store.
- migrate_
room_ settings - Migrate room settings, including room algorithm and whether to block untrusted devices from legacy store to Sqlite store.
- migrate_
sessions - Migrate sessions and group sessions of a libolm based setup to a vodozemac based setup stored in a SQLite store.
- set_
logger - Set the logger that should be used to forward Rust logs over FFI.