matrix_sdk_crypto::olm

Enum SenderData

Source
pub enum SenderData {
    UnknownDevice {
        legacy_session: bool,
        owner_check_failed: bool,
    },
    DeviceInfo {
        device_keys: DeviceKeys,
        legacy_session: bool,
    },
    VerificationViolation(KnownSenderData),
    SenderUnverified(KnownSenderData),
    SenderVerified(KnownSenderData),
}
Expand description

Information on the device and user that sent the megolm session data to us

Sessions start off in UnknownDevice state, and progress into DeviceInfo state when we get the device info. Finally, if we can look up the sender using the device info, the session can be moved into VerificationViolation, SenderUnverified, or SenderVerified state, depending on the verification status of the user. If the user’s verification state changes, the state may change accordingly.

Variants§

§

UnknownDevice

We have not yet found the (signed) device info for the sending device, or we did find a device but it does not own the session.

Fields

§legacy_session: bool

Was this session created before we started collecting trust information about sessions? If so, we may choose to display its messages even though trust info is missing.

§owner_check_failed: bool

If true, we found the device but it was not the owner of the session. If false, we could not find the device.

§

DeviceInfo

We have the signed device info for the sending device, but not yet the cross-signing key that it was signed with.

Fields

§device_keys: DeviceKeys

Information about the device that sent the to-device message creating this session.

§legacy_session: bool

Was this session created before we started collecting trust information about sessions? If so, we may choose to display its messages even though trust info is missing.

§

VerificationViolation(KnownSenderData)

We have found proof that this user, with this cross-signing key, sent the to-device message that established this session, but we have not yet verified the cross-signing key, and we had verified a previous cross-signing key for this user.

§

SenderUnverified(KnownSenderData)

We have found proof that this user, with this cross-signing key, sent the to-device message that established this session, but we have not yet verified the cross-signing key.

§

SenderVerified(KnownSenderData)

We have found proof that this user, with this cross-signing key, sent the to-device message that established this session, and we have verified the cross-signing key.

Implementations§

Source§

impl SenderData

Source

pub fn unknown() -> Self

Create a SenderData which contains no device info.

Source

pub fn device_info(device_keys: DeviceKeys) -> Self

Create a SenderData which contains device info.

Source

pub fn sender_verification_violation( user_id: &UserId, device_id: &DeviceId, master_key: Ed25519PublicKey, ) -> Self

Create a SenderData with a known but unverified sender, where the sender was previously verified.

Source

pub fn sender_unverified( user_id: &UserId, device_id: &DeviceId, master_key: Ed25519PublicKey, ) -> Self

Create a SenderData with a known but unverified sender.

Source

pub fn sender_verified( user_id: &UserId, device_id: &DeviceId, master_key: Ed25519PublicKey, ) -> Self

Create a SenderData with a verified sender.

Source

pub fn legacy() -> Self

Create a SenderData which has the legacy flag set. Caution: messages within sessions with this flag will be displayed in some contexts, even when we are unable to verify the sender.

The returned struct contains no device info.

Source

pub fn to_type(&self) -> SenderDataType

Return our type as a SenderDataType.

Trait Implementations§

Source§

impl Clone for SenderData

Source§

fn clone(&self) -> SenderData

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 SenderData

Source§

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

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

impl Default for SenderData

Used when deserialising and the sender_data property is missing. If we are deserialising an InboundGroupSession session with missing sender_data, this must be a legacy session (i.e. it was created before we started tracking sender data). We set its legacy flag to true, so we can populate it with trust information if it is available later.

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SenderData

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SenderData

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for SenderData

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SenderData

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

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

Source§

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

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

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§

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§

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

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

Source§

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

Source§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T

Source§

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

Source§

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