Enum matrix_sdk_crypto::olm::SenderData

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

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

impl SenderData

pub fn unknown() -> Self

Create a SenderData which contains no device info.

pub fn device_info(device_keys: DeviceKeys) -> Self

Create a SenderData which contains device info.

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.

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

Create a SenderData with a known but unverified sender.

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

Create a SenderData with a verified sender.

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.

pub fn to_type(&self) -> SenderDataType

Return our type as a SenderDataType.

Trait Implementations

impl Clone for SenderData

fn clone(&self) -> SenderData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SenderData

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

Formats the value using the given formatter.

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.

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SenderData

fn eq(&self, other: &SenderData) -> 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 Serialize for SenderData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SenderData