Struct matrix_sdk_crypto::Sas

source ·
pub struct Sas { /* private fields */ }
Expand description

Short authentication string object.

Implementations§

source§

impl Sas

source

pub fn user_id(&self) -> &UserId

Get our own user id.

source

pub fn device_id(&self) -> &DeviceId

Get our own device ID.

source

pub fn other_user_id(&self) -> &UserId

Get the user id of the other side.

source

pub fn other_device_id(&self) -> &DeviceId

Get the device ID of the other side.

source

pub fn other_device(&self) -> &DeviceData

Get the device of the other user.

source

pub fn flow_id(&self) -> &FlowId

Get the unique ID that identifies this SAS verification flow.

source

pub fn room_id(&self) -> Option<&RoomId>

Get the room id if the verification is happening inside a room.

source

pub fn supports_emoji(&self) -> bool

Does this verification flow support displaying emoji for the short authentication string.

source

pub fn started_from_request(&self) -> bool

Did this verification flow start from a verification request.

source

pub fn is_self_verification(&self) -> bool

Is this a verification that is verifying one of our own devices.

source

pub fn have_we_confirmed(&self) -> bool

Have we confirmed that the short auth string matches.

source

pub fn has_been_accepted(&self) -> bool

Has the verification been accepted by both parties.

source

pub fn cancel_info(&self) -> Option<CancelInfo>

Get info about the cancellation if the verification flow has been cancelled.

source

pub fn we_started(&self) -> bool

Did we initiate the verification flow.

source

pub fn accept(&self) -> Option<OutgoingVerificationRequest>

Accept the SAS verification.

This does nothing if the verification was already accepted, otherwise it returns an AcceptEventContent that needs to be sent out.

source

pub fn accept_with_settings( &self, settings: AcceptSettings, ) -> Option<OutgoingVerificationRequest>

Accept the SAS verification customizing the accept method.

This does nothing if the verification was already accepted, otherwise it returns an AcceptEventContent that needs to be sent out.

Specify a function modifying the attributes of the accept request.

source

pub async fn confirm( &self, ) -> Result<(Vec<OutgoingVerificationRequest>, Option<SignatureUploadRequest>), CryptoStoreError>

Confirm the Sas verification.

This confirms that the short auth strings match on both sides.

Does nothing if we’re not in a state where we can confirm the short auth string, otherwise returns a MacEventContent that needs to be sent to the server.

source

pub fn cancel(&self) -> Option<OutgoingVerificationRequest>

Cancel the verification.

This cancels the verification with the CancelCode::User.

Returns None if the Sas object is already in a canceled state, otherwise it returns a request that needs to be sent out.

source

pub fn cancel_with_code( &self, code: CancelCode, ) -> Option<OutgoingVerificationRequest>

Cancel the verification.

This cancels the verification with given CancelCode.

Note: This method should generally not be used, the cancel() method should be preferred. The SDK will automatically cancel with the appropriate cancel code, user initiated cancellations should only cancel with the CancelCode::User

Returns None if the Sas object is already in a canceled state, otherwise it returns a request that needs to be sent out.

source

pub fn timed_out(&self) -> bool

Has the SAS verification flow timed out.

source

pub fn can_be_presented(&self) -> bool

Are we in a state where we can show the short auth string.

source

pub fn is_done(&self) -> bool

Is the SAS flow done.

source

pub fn is_cancelled(&self) -> bool

Is the SAS flow canceled.

source

pub fn emoji(&self) -> Option<[Emoji; 7]>

Get the emoji version of the short auth string.

Returns None if we can’t yet present the short auth string, otherwise seven tuples containing the emoji and description.

source

pub fn emoji_index(&self) -> Option<[u8; 7]>

Get the index of the emoji representing the short auth string

Returns None if we can’t yet present the short auth string, otherwise seven u8 numbers in the range from 0 to 63 inclusive which can be converted to an emoji using the relevant spec entry.

source

pub fn decimals(&self) -> Option<(u16, u16, u16)>

Get the decimal version of the short auth string.

Returns None if we can’t yet present the short auth string, otherwise a tuple containing three 4-digit integers that represent the short auth string.

source

pub fn changes(&self) -> impl Stream<Item = SasState>

Listen for changes in the SAS verification process.

The changes are presented as a stream of SasState values.

This method can be used to react to changes in the state of the verification process, or rather the method can be used to handle each step of the verification process.

§Flowchart

The flow of the verification process is pictured bellow. Please note that the process can be cancelled at each step of the process. Either side can cancel the process.

               ┌───────┐
               │Created│
               └───┬───┘
                   │
               ┌───⌄───┐
               │Started│
               └───┬───┘
                   │
              ┌────⌄───┐
              │Accepted│
              └────┬───┘
                   │
           ┌───────⌄──────┐
           │Keys Exchanged│
           └───────┬──────┘
                   │
           ________⌄________
          ╱                 ╲       ┌─────────┐
         ╱   Does the short  ╲______│Cancelled│
         ╲ auth string match ╱ no   └─────────┘
          ╲_________________╱
                   │yes
                   │
              ┌────⌄────┐
              │Confirmed│
              └────┬────┘
                   │
               ┌───⌄───┐
               │  Done │
               └───────┘
§Examples
use futures_util::{Stream, StreamExt};
use matrix_sdk_crypto::{Sas, SasState};

let mut stream = sas.changes();

while let Some(state) = stream.next().await {
    match state {
        SasState::KeysExchanged { emojis, decimals: _ } => {
            let emojis =
                emojis.expect("We only support emoji verification");
            println!("Do these emojis match {emojis:#?}");

            // Ask the user to confirm or cancel here.
        }
        SasState::Done { .. } => {
            let device = sas.other_device();

            println!(
                "Successfully verified device {} {} {:?}",
                device.user_id(),
                device.device_id(),
                device.local_trust_state()
            );

            break;
        }
        SasState::Cancelled(cancel_info) => {
            println!(
                "The verification has been cancelled, reason: {}",
                cancel_info.reason()
            );
            break;
        }
        SasState::Created { .. }
        | SasState::Started { .. }
        | SasState::Accepted { .. }
        | SasState::Confirmed => (),
    }
}
source

pub fn state(&self) -> SasState

Get the current state of the verification process.

Trait Implementations§

source§

impl Clone for Sas

source§

fn clone(&self) -> Sas

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 Sas

source§

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

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

impl From<Sas> for Verification

source§

fn from(sas: Sas) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Sas

§

impl !RefUnwindSafe for Sas

§

impl Send for Sas

§

impl Sync for Sas

§

impl Unpin for Sas

§

impl !UnwindSafe for Sas

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

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

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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,

§

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

impl<T> Instrument for T

source§

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

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

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

§

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

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

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> AsyncTraitDeps for T

source§

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

source§

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