Struct matrix_sdk_crypto::OwnUserIdentityData

pub struct OwnUserIdentityData { /* private fields */ }

Struct representing a cross signing identity of our own user.

This is the user identity of our own user. This user identity will contain a master key, self signing key as well as a user signing key.

This identity can verify other identities as well as devices belonging to the identity.

Implementations

impl OwnUserIdentityData

pub fn user_id(&self) -> &UserId

Get the user id of this identity.

pub fn master_key(&self) -> &MasterPubkey

Get the public master key of the identity.

pub fn self_signing_key(&self) -> &SelfSigningPubkey

Get the public self-signing key of the identity.

pub fn user_signing_key(&self) -> &UserSigningPubkey

Get the public user-signing key of the identity.

pub fn is_identity_verified(&self, identity: &OtherUserIdentityData) -> bool

Check if the given user identity has been verified.

The identity of another user is verified iff our own identity is verified and if our own identity has signed the other user’s identity.

Arguments

• identity - The identity of another user which we want to check has been verified.

pub fn mark_as_verified(&self)

Mark our identity as verified.

pub fn is_verified(&self) -> bool

Check if our identity is verified.

pub fn was_previously_verified(&self) -> bool

True if we verified our own identity at some point in the past.

To reset this latch back to false, one must call OwnUserIdentityData::withdraw_verification().

pub fn withdraw_verification(&self)

Remove the requirement for this identity to be verified.

If an identity was previously verified and is not any more it will be reported to the user. In order to remove this notice users have to verify again or to withdraw the verification requirement.

pub fn has_verification_violation(&self) -> bool

Was this identity previously verified, and is no longer?

Such a violation should be reported to the local user by the application, and resolved by

• Verifying the new identity with OwnUserIdentity::request_verification
• Or by withdrawing the verification requirement OwnUserIdentity::withdraw_verification.

Trait Implementations

impl Clone for OwnUserIdentityData

fn clone(&self) -> OwnUserIdentityData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OwnUserIdentityData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OwnUserIdentityData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<OwnUserIdentityData> for UserIdentityData

fn from(identity: OwnUserIdentityData) -> Self

Converts to this type from the input type.

impl PartialEq for OwnUserIdentityData

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

The PartialEq implementation compares several attributes, including the user ID, key material, usage, and, notably, the signatures of the master key.

This approach contrasts with the PartialEq implementation of the MasterPubkey, SelfSigningPubkey and UserSigningPubkey types, where the signatures are disregarded. This distinction arises from our treatment of identity as the combined representation of cross-signing keys and the associated verification state.

The verification state of an identity depends on the signatures of the master key, requiring their inclusion in our PartialEq implementation.

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 OwnUserIdentityData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.