Module matrix_sdk::authentication::qrcode

Available on crate feature experimental-oidc and crate feature e2e-encryption and non-WebAssembly only.

Types for the QR code login support defined in MSC4108.

Please note, QR code logins are only supported when using OIDC as the auththentication 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

• LoginWithQrCode
  Named future for the Oidc::login_with_qr_code() method.
• QrCodeData
  Data for the QR code login mechanism.
• StandardErrorResponse
  Error response returned by server after requesting an access token.

Enums

• ConfigurationError
  There was a problem configuring the request.
• CoreErrorResponseType
  Basic access token error types.
• DeviceAuhorizationOidcError
  Error type describing failures in the interaction between the device attempting to log in and the OIDC provider.
• DeviceCodeErrorResponseType
  Basic access token error types.
• DiscoveryError
  Error retrieving provider metadata.
• EciesError
  The Error type for the ECIES submodule.
• HttpClientError
  Error type returned by built-in HTTP clients when requests fail.
• LoginFailureReason
  Reasons why the login might have failed.
• LoginProgress
  Type telling us about the progress of the QR code login.
• LoginProtocolType
  Enum containing known login protocol types.
• LoginQrCodeDecodeError
  Error type for the decoding of the QrCodeData.
• MessageDecodeError
  The error type for the ECIES message decoding failures.
• QRCodeLoginError
  The error type for failures while trying to log in a new device using a QR code.
• QrAuthMessage
  Messages that will be exchanged over the SecureChannel to log in a new device using a QR code.
• QrCodeMode
  The mode of the QR code login.
• QrCodeModeData
  The mode-specific data for the QR code.
• RequestTokenError
  Error encountered while requesting access token.
• SecureChannelError
  Error type for failures in when receiving or sending messages over the secure channel.