matrix_sdk::authentication::qrcode

Enum QrAuthMessage

Source 
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.
Expand description

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§

Source§

impl QrAuthMessage

Source

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§

Source§

impl Debug for QrAuthMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for QrAuthMessage

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>
Source§

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> Any for T
where T: Any,

Source§

impl<T> AsyncTraitDeps for T
where T: Debug + SendOutsideWasm + SyncOutsideWasm,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T

Source§

impl<T> SendOutsideWasm for T
where T: Send,

Source§

impl<T> SyncOutsideWasm for T
where T: Sync,