Enum matrix_sdk_crypto::UserIdentity

pub enum UserIdentity {
    Own(OwnUserIdentity),
    Other(OtherUserIdentity),
}

Enum over the different user identity types we can have.

Variants

Own(OwnUserIdentity)

Our own user identity.

Other(OtherUserIdentity)

An identity belonging to another user.

Implementations

impl UserIdentity

pub fn own(self) -> Option<OwnUserIdentity>

Destructure the enum into an OwnUserIdentity if it’s of the correct type.

pub fn other(self) -> Option<OtherUserIdentity>

Destructure the enum into an OtherUserIdentity if it’s of the correct type.

pub fn user_id(&self) -> &UserId

Get the ID of the user this identity belongs to.

pub fn is_verified(&self) -> bool

Check if this user identity is verified.

For our own identity, this means either that we have checked the public keys in the identity against the private keys; or that the identity has been manually marked as verified via OwnUserIdentity::verify.

For another user’s identity, it means that we have verified our own identity as above, and that the other user’s identity has been signed by our own user-signing key.

pub fn was_previously_verified(&self) -> bool

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

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

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

Reset the flag that records that the identity has been verified, thus clearing UserIdentity::was_previously_verified and UserIdentity::has_verification_violation.

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

Remember this identity, ensuring it does not result in a pin violation.

When we first see a user, we assume their cryptographic identity has not been tampered with by the homeserver or another entity with man-in-the-middle capabilities. We remember this identity and call this action “pinning”.

If the identity presented for the user changes later on, the newly presented identity is considered to be in “pin violation”. This method explicitly accepts the new identity, allowing it to replace the previously pinned one and bringing it out of pin violation.

UIs should display a warning to the user when encountering an identity which is not verified and is in pin violation. See OtherUserIdentity::identity_needs_user_approval.

pub fn has_verification_violation(&self) -> bool

Was this identity previously verified, and is no longer?

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 From<OtherUserIdentity> for UserIdentity

fn from(i: OtherUserIdentity) -> Self

Converts to this type from the input type.

impl From<OwnUserIdentity> for UserIdentity

fn from(i: OwnUserIdentity) -> Self

Converts to this type from the input type.