Enum matrix_sdk_qrcode::QrVerificationData

source ·
pub enum QrVerificationData {
    Verification(VerificationData),
    SelfVerification(SelfVerificationData),
    SelfVerificationNoMasterKey(SelfVerificationNoMasterKey),
}
Expand description

An enum representing the different modes for a QR verification code.

Variants§

§

Verification(VerificationData)

The QR verification is verifying another user.

It relies on both devices already trusting or owning the master cross-signing key for the corresponding user.

In this case, the QR code data includes:

  • The master cross-signing key of the displaying device’s user.
  • What the displaying device believes is the master cross-signing key of the scanning device’s user.

After a successful verification, each device will trust the cross-signing key of the other user, and will upload a cross-signature of that key.

§

SelfVerification(SelfVerificationData)

The QR verification is self-verifying and the device displaying the QR code trusts or owns the master cross-signing key.

This normally happens when the displaying device is an existing device, and the scanning device is new.

In this case, the QR code data includes:

  • The master cross-signing key (which is trusted by the displaying device).
  • What the displaying device believes is the device key of the scanning device.

After a successful verification, the scanning device will be able to trust the master key, and the displaying device will be able to trust the scanning device’s device key.

Since the displaying device should be cross-signed already, this means that the scanning device will now trust the displaying device.

The displaying device will then upload a cross-signature of the scanning device (assuming it has the private key), and will send the secret keys to the scanning device.

§

SelfVerificationNoMasterKey(SelfVerificationNoMasterKey)

The QR verification is self-verifying in which the current device does not yet trust the master key.

This normally happens when the displaying device is new, and the scanning device is an existing device.

In this case, the QR code data includes:

  • The displaying device’s device key.
  • What the displaying device believes is the master cross-signing key.

If the verification is successful, the scanning device will be able to trust the displaying device’s device key, and the displaying device will be able to trust the master key.

Since the scanning device should be cross-signed already, this means that the displaying device will now trust the scanning device.

The scanning device will then upload a cross-signature of the displaying device (assuming it has the private key), and will send the secret keys to the displaying device.

Implementations§

source§

impl QrVerificationData

source

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<Self, DecodingError>

Parse the decoded payload of a QR code in byte slice form as a QrVerificationData

This method is useful if you would like to do your own custom QR code decoding.

§Arguments
  • bytes - The raw bytes of a decoded QR code.
§Examples
let data = b"MATRIX\
             \x02\x02\x00\x07\
             FLOW_ID\
             kS /\x92i\x1e6\xcd'g\xf9#\x11\xd8\x8a\xa2\xf61\x05\x1b6\xef\xfc\xa4%\x80\x1a\x0c\xd2\xe8\x04\
             \xbdR|\xf8n\x07\xa4\x1f\xb4\xcc3\x0eBT\xe7[~\xfd\x87\xd06B\xdfoVv%\x9b\x86\xae\xbcM\
             SHARED_SECRET";

let result = QrVerificationData::from_bytes(data)?;
source

pub fn to_qr_code(&self) -> Result<QrCode, EncodingError>

Encode the QrVerificationData into a QrCode.

This method turns the QrVerificationData into a QR code that can be rendered and presented to be scanned.

The encoding can fail if the data doesn’t fit into a QR code or if the identity keys that should be encoded into the QR code are not valid base64.

§Examples
let data = b"MATRIX\
             \x02\x02\x00\x07\
             FLOW_ID\
             kS /\x92i\x1e6\xcd'g\xf9#\x11\xd8\x8a\xa2\xf61\x05\x1b6\xef\xfc\xa4%\x80\x1a\x0c\xd2\xe8\x04\
             \xbdR|\xf8n\x07\xa4\x1f\xb4\xcc3\x0eBT\xe7[~\xfd\x87\xd06B\xdfoVv%\x9b\x86\xae\xbcM\
             SHARED_SECRET";

let result = QrVerificationData::from_bytes(data)?;
let encoded = result.to_qr_code().unwrap();
source

pub fn to_bytes(&self) -> Result<Vec<u8>, EncodingError>

Encode the QrVerificationData into a vector of bytes that can be encoded as a QR code.

The encoding can fail if the identity keys that should be encoded are not valid base64.

§Examples
let data = b"MATRIX\
             \x02\x02\x00\x07\
             FLOW_ID\
             kS /\x92i\x1e6\xcd'g\xf9#\x11\xd8\x8a\xa2\xf61\x05\x1b6\xef\xfc\xa4%\x80\x1a\x0c\xd2\xe8\x04\
             \xbdR|\xf8n\x07\xa4\x1f\xb4\xcc3\x0eBT\xe7[~\xfd\x87\xd06B\xdfoVv%\x9b\x86\xae\xbcM\
             SHARED_SECRET";

let result = QrVerificationData::from_bytes(data)?;
let encoded = result.to_bytes().unwrap();

assert_eq!(data.as_ref(), encoded.as_slice());
source

pub fn flow_id(&self) -> &str

Get the flow id for this QrVerificationData.

This represents the ID as a string even if it is a EventId.

source

pub fn first_key(&self) -> Ed25519PublicKey

Get the first key of this QrVerificationData.

source

pub fn second_key(&self) -> Ed25519PublicKey

Get the second key of this QrVerificationData.

source

pub fn secret(&self) -> &Base64

Get the secret of this QrVerificationData.

Trait Implementations§

source§

impl Clone for QrVerificationData

source§

fn clone(&self) -> QrVerificationData

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for QrVerificationData

source§

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

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

impl From<SelfVerificationData> for QrVerificationData

source§

fn from(data: SelfVerificationData) -> Self

Converts to this type from the input type.
source§

impl From<SelfVerificationNoMasterKey> for QrVerificationData

source§

fn from(data: SelfVerificationNoMasterKey) -> Self

Converts to this type from the input type.
source§

impl From<VerificationData> for QrVerificationData

source§

fn from(data: VerificationData) -> Self

Converts to this type from the input type.
source§

impl PartialEq for QrVerificationData

source§

fn eq(&self, other: &QrVerificationData) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl TryFrom<&[u8]> for QrVerificationData

§

type Error = DecodingError

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

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<Vec<u8>> for QrVerificationData

§

type Error = DecodingError

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

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl Eq for QrVerificationData

source§

impl StructuralPartialEq for QrVerificationData

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

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

§

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>).
§

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.
§

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
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

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>,

§

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.
§

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

§

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