Struct matrix_sdk_crypto::OwnUserIdentity

pub struct OwnUserIdentity { /* private fields */ }

Struct representing a cross signing identity of a user.

This is the user identity of a user that is our own. Other users will only contain a master key and a self signing key, meaning that only device signatures can be checked with this identity.

This struct wraps the OwnUserIdentityData type and allows a verification to be requested to verify our own device with the user identity.

Implementations

impl OwnUserIdentity

pub async fn verify(&self) -> Result<SignatureUploadRequest, SignatureError>

Mark our user identity as verified.

This will mark the identity locally as verified and sign it with our own device.

Returns a signature upload request that needs to be sent out.

pub async fn request_verification( &self, ) -> Result<(VerificationRequest, OutgoingVerificationRequest), CryptoStoreError>

Send a verification request to our other devices.

pub async fn request_verification_with_methods( &self, methods: Vec<VerificationMethod>, ) -> Result<(VerificationRequest, OutgoingVerificationRequest), CryptoStoreError>

Send a verification request to our other devices while specifying our supported methods.

Arguments

• methods - The verification methods that we’re supporting.

pub async fn trusts_our_own_device(&self) -> Result<bool, CryptoStoreError>

Does our user identity trust our own device, i.e. have we signed our own device keys with our self-signing key.

pub async fn withdraw_verification(&self) -> Result<(), CryptoStoreError>

Remove the requirement for this identity to be verified.

Methods from Deref<Target = 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 OwnUserIdentity

fn clone(&self) -> OwnUserIdentity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OwnUserIdentity

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

Formats the value using the given formatter.

impl Deref for OwnUserIdentity

type Target = OwnUserIdentityData

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for OwnUserIdentity

fn deref_mut(&mut self) -> &mut <Self as Deref>::Target

Mutably dereferences the value.

impl From<OwnUserIdentity> for UserIdentity

fn from(i: OwnUserIdentity) -> Self

Converts to this type from the input type.