Struct matrix_qrcode::SelfVerificationData

pub struct SelfVerificationData { /* private fields */ }

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

This mode is used for verification between two devices of the same user where this device, that is creating this QR code, is trusting or owning the cross signing master key.

Implementations

impl SelfVerificationData

pub fn new(
    transaction_id: String,
    master_key: Ed25519PublicKey,
    device_key: Ed25519PublicKey,
    shared_secret: Base64<Standard, Vec<u8, Global>>
) -> SelfVerificationData

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

Arguments

• transaction_id - The transaction id of this verification flow, the transaction id was sent by the m.key.verification.request event that initiated the verification flow this QR code should be part of.

• master_key - Our own cross signing master key. Needs to be encoded as unpadded base64

• device_key - The ed25519 key of the other device, encoded as unpadded base64.

• 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, Global>, EncodingError>

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

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

Example

let data = b"MATRIX\
             \x02\x01\x00\x06\
             FLOWID\
             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::SelfVerification(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 SelfVerificationData into a QrCode.

This method turns the SelfVerificationData 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 SelfVerificationData

fn clone(&self) -> SelfVerificationData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SelfVerificationData

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 PartialEq<SelfVerificationData> for SelfVerificationData

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

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

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

This method tests for !=.

impl StructuralPartialEq for SelfVerificationData