Struct matrix_sdk_qrcode::VerificationData

pub struct VerificationData { /* private fields */ }

The non-encoded data for the first mode of QR code verification.

This mode is used for verification between two users using their master cross signing keys.

Implementations

impl VerificationData

pub fn new( flow_id: String, first_master_key: Ed25519PublicKey, second_master_key: Ed25519PublicKey, shared_secret: Base64, ) -> Self

Create a new VerificationData struct that can be encoded as a QR code.

Arguments

• flow_id - The event ID or transaction ID of the m.key.verification.request event that initiated the verification flow this QR code should be part of.

• first_master_key - Our own cross signing master key.

• second_master_key - The cross signing master key of the other user.

• shared_secret - A random bytestring encoded as unpadded base64, needs to be at least 8 bytes long.

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

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

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

Examples

let data = b"MATRIX\
             \x02\x00\x00\x0f\
             $test:localhost\
             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)?;
if let QrVerificationData::Verification(decoded) = result {
    let encoded = decoded.to_bytes().unwrap();
    assert_eq!(data.as_ref(), encoded.as_slice());
} else {
    panic!("Data was encoded as an incorrect mode");
}

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

Encode the VerificationData into a QrCode.

This method turns the VerificationData 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 keys that should be encoded into the QR code are not valid base64.

Trait Implementations

impl Clone for VerificationData

fn clone(&self) -> VerificationData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VerificationData

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

Formats the value using the given formatter.

impl From<VerificationData> for QrVerificationData

fn from(data: VerificationData) -> Self

Converts to this type from the input type.

impl PartialEq for VerificationData

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

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

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.

impl Eq for VerificationData

impl StructuralPartialEq for VerificationData