Enum matrix_sdk::authentication::qrcode::QrAuthMessage

pub enum QrAuthMessage {
    LoginProtocols {
        protocols: Vec<LoginProtocolType>,
        homeserver: Url,
    },
    LoginProtocol {
        device_authorization_grant: AuthorizationGrant,
        protocol: LoginProtocolType,
        device_id: Curve25519PublicKey,
    },
    LoginProtocolAccepted,
    LoginSuccess,
    LoginDeclined,
    LoginFailure {
        reason: LoginFailureReason,
        homeserver: Option<Url>,
    },
    LoginSecrets(SecretsBundle),
}

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

Messages that will be exchanged over the SecureChannel to log in a new device using a QR code.

Variants

LoginProtocols

Message declaring the available protocols for sign in. Sent by the existing device.

Fields

protocols: Vec<LoginProtocolType>

The login protocols the existing device supports.

homeserver: Url

The homeserver we’re going to log in to.

LoginProtocol

Message declaring which protocols from the previous m.login.protocols message the new device has picked. Sent by the new device.

Fields

device_authorization_grant: AuthorizationGrant

The device authorization grant the OIDC provider has given to the new device, contains the URL the existing device should use to confirm the log in.

protocol: LoginProtocolType

The protocol the new device has picked.

device_id: Curve25519PublicKey

The device ID the new device will be using.

LoginProtocolAccepted

Message declaring that the protocol in the previous m.login.protocol message was accepted. Sent by the existing device.

LoginSuccess

Message that informs the existing device that it successfully obtained an access token from the OIDC provider. Sent by the new device.

LoginDeclined

Message that informs the existing device that the OIDC provider has declined to give us an access token, i.e. because the user declined the log in. Sent by the new device.

LoginFailure

Message signaling that a failure happened during the login. Can be sent by either device.

Fields

reason: LoginFailureReason

The claimed reason for the login failure.

homeserver: Option<Url>

The homeserver that we attempted to log in to.

LoginSecrets(SecretsBundle)

Message containing end-to-end encryption related secrets, the new device can use these secrets to mark itself as verified, connect to a room key backup, and login other devices via a QR login. Sent by the existing device.

Implementations

impl QrAuthMessage

pub fn authorization_grant_login_protocol( device_authorization_grant: AuthorizationGrant, device_id: Curve25519PublicKey, ) -> QrAuthMessage

Create a new QrAuthMessage::LoginProtocol message with the LoginProtocolType::DeviceAuthorizationGrant protocol type.

Trait Implementations

impl Debug for QrAuthMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QrAuthMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for QrAuthMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.