Enum QrVerificationData

pub enum QrVerificationData {
    Verification(VerificationData),
    SelfVerification(SelfVerificationData),
    SelfVerificationNoMasterKey(SelfVerificationNoMasterKey),
}

Available on crate features e2e-encryption and qrcode only.

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

impl QrVerificationData

pub fn from_bytes( bytes: impl AsRef<[u8]>, ) -> Result<QrVerificationData, 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)?;

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();

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());

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.

pub fn first_key(&self) -> Ed25519PublicKey

Get the first key of this QrVerificationData.

pub fn second_key(&self) -> Ed25519PublicKey

Get the second key of this QrVerificationData.

pub fn secret(&self) -> &Base64

Get the secret of this QrVerificationData.

Trait Implementations

impl Clone for QrVerificationData

fn clone(&self) -> QrVerificationData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QrVerificationData

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

Formats the value using the given formatter.

impl From<SelfVerificationData> for QrVerificationData

fn from(data: SelfVerificationData) -> QrVerificationData

Converts to this type from the input type.

impl From<SelfVerificationNoMasterKey> for QrVerificationData

fn from(data: SelfVerificationNoMasterKey) -> QrVerificationData

Converts to this type from the input type.

impl From<VerificationData> for QrVerificationData

fn from(data: VerificationData) -> QrVerificationData

Converts to this type from the input type.

impl PartialEq for QrVerificationData

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for QrVerificationData

type Error = DecodingError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8>> for QrVerificationData

type Error = DecodingError

The type returned in the event of a conversion error.

fn try_from( value: Vec<u8>, ) -> Result<QrVerificationData, <QrVerificationData as TryFrom<Vec<u8>>>::Error>

Performs the conversion.

impl Eq for QrVerificationData

impl StructuralPartialEq for QrVerificationData