Available on crate feature
experimental-oidc and crate feature e2e-encryption and non-WebAssembly only.Expand description
Types for the QR code login support defined in MSC4108.
Please note, QR code logins are only supported when using OAuth 2.0 as the authentication mechanism, native Matrix authentication does not support it.
This currently only implements the case where the new device is scanning the
QR code. To log in using a QR code, please take a look at the
Oidc::login_with_qr_code() method.
Structs§
- Login
With QrCode - Named future for the
Oidc::login_with_qr_code()method. - QrCode
Data - Data for the QR code login mechanism.
- Standard
Error Response - Error response returned by server after requesting an access token.
Enums§
- Configuration
Error - There was a problem configuring the request.
- Device
Authorization Oauth Error - Error type describing failures in the interaction between the device attempting to log in and the OAuth 2.0 authorization server.
- Device
Code Error Response Type - Basic access token error types.
- Ecies
Error - The Error type for the ECIES submodule.
- Http
Client Error - Error type returned by built-in HTTP clients when requests fail.
- Login
Failure Reason - Reasons why the login might have failed.
- Login
Progress - Type telling us about the progress of the QR code login.
- Login
Protocol Type - Enum containing known login protocol types.
- Login
QrCode Decode Error - Error type for the decoding of the
QrCodeData. - Message
Decode Error - The error type for the ECIES message decoding failures.
- QRCode
Login Error - The error type for failures while trying to log in a new device using a QR code.
- QrAuth
Message - Messages that will be exchanged over the
SecureChannelto log in a new device using a QR code. - QrCode
Mode - The mode of the QR code login.
- QrCode
Mode Data - The mode-specific data for the QR code.
- Request
Token Error - Error encountered while requesting access token.
- Secure
Channel Error - Error type for failures in when receiving or sending messages over the secure channel.
Type Aliases§
- Basic
Error Response - Error response specialization for basic OAuth2 implementation.
- Basic
Request Token Error - Token error specialization for basic OAuth2 implementation.
- Device
Code Error Response - Error response specialization for device code OAuth2 implementation.