Struct matrix_sdk_crypto::UserIdentity

pub struct UserIdentity { /* private fields */ }

Struct representing a cross signing identity of a user.

This is the user identity of a user that isn’t 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 a read-only version of the struct and allows verifications to be requested to verify our own device with the user identity.

Implementations

impl UserIdentity

pub fn is_verified(&self) -> bool

Is this user identity verified.

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

Manually verify this user.

This method will attempt to sign the user identity using our private cross signing key.

This method fails if we don’t have the private part of our user-signing key.

Returns a request that needs to be sent out for the user to be marked as verified.

pub fn request_verification( &self, room_id: &RoomId, request_event_id: &EventId, methods: Option<Vec<VerificationMethod>>, ) -> VerificationRequest

Create a VerificationRequest object after the verification request content has been sent out.

pub fn verification_request_content( &self, methods: Option<Vec<VerificationMethod>>, ) -> KeyVerificationRequestEventContent

Send a verification request to the given user.

The returned content needs to be sent out into a DM room with the given user.

After the content has been sent out a VerificationRequest can be started with the request_verification() method.

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

Pin the current identity (public part of the master signing key).

pub fn identity_needs_user_approval(&self) -> bool

Did the identity change after an initial observation in a way that requires approval from the user?

A user identity needs approval if it changed after the crypto machine has already observed (“pinned”) a different identity for that user and it is not an explicitly verified identity (using for example interactive verification).

Such a change is to be considered a pinning violation which the application should report to the local user, and can be resolved by:

• Verifying the new identity with UserIdentity::request_verification
• Or by updating the pin to the new identity with UserIdentity::pin_current_master_key.

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

Remove the requirement for this identity to be verified.

pub fn has_verification_violation(&self) -> bool

Was this identity verified since initial observation and is not anymore?

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

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

Methods from Deref<Target = OtherUserIdentityData>

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 was_previously_verified(&self) -> bool

True if we verified this identity (with any own identity, at any point).

To pass this latch back to false, one must call OtherUserIdentityData::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 anymore it will be reported to the user. In order to remove this notice users have to verify again or to withdraw the verification requirement.

Trait Implementations

impl Clone for UserIdentity

fn clone(&self) -> UserIdentity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserIdentity

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

Formats the value using the given formatter.

impl Deref for UserIdentity

type Target = OtherUserIdentityData

The resulting type after dereferencing.

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

Dereferences the value.

impl From<UserIdentity> for UserIdentities

fn from(i: UserIdentity) -> Self

Converts to this type from the input type.