Available on crate feature
e2e-encryption only.Expand description
Interactive verification for E2EE capable users and devices in Matrix.
The SDK supports interactive verification of devices and users, this module contains types that model and support different verification flows.
A verification flow usually starts its life as a VerificationRequest, the request can then be accepted, or it needs to be accepted by the other side of the verification flow.
Once both sides have agreed to perform the verification, and the VerificationRequest::is_ready() method returns true, the verification can transition into one of the supported verification flows:
SasVerification- Interactive verification using a short authentication string.QrVerification- Interactive verification using QR codes.
Structs§
- Accept
Settings - Customize the accept-reply for a verification process
- Accepted
Protocols - Struct containing the protocols that were agreed to be used for the SAS flow.
- Cancel
Info - Information about the cancellation of a verification request or verification flow.
- Emoji
- An emoji that is used for interactive verification using a short auth string.
- Emoji
Short Auth String - The short auth string for the emoji method of SAS verification.
- QrVerification
qrcode - An object controlling QR code style key verification flows.
- SasVerification
- An object controlling the short auth string verification flow.
- Verification
Request - An object controlling the interactive verification flow.
Enums§
- Decoding
Error qrcode - Error type describing errors that happen while QR data is being decoded.
- Encoding
Error qrcode - Error type describing errors that happen while QR data is being encoded.
- QrVerification
Data qrcode - An enum representing the different modes for a QR verification code.
- QrVerification
State qrcode - An Enum describing the state the QrCode verification is in.
- SasState
- An Enum describing the state the SAS verification is in.
- Scan
Error qrcode - An error for the different failure modes that can happen during the validation of a scanned QR code.
- Verification
- An enum over the different verification types the SDK supports.
- Verification
Request State - An Enum describing the state the verification request is in.
Functions§
- format_
emojis - Format the list of emojis as a two line string.