Struct matrix_sdk_crypto::UserIdentity

pub struct UserIdentity { /* fields omitted */ }

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 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 async 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 async 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.

Methods from Deref<Target = ReadOnlyUserIdentity>

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.

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 = ReadOnlyUserIdentity

The resulting type after dereferencing.

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

Dereferences the value.

impl From<UserIdentity> for UserIdentities

fn from(i: UserIdentity) -> Self

Performs the conversion.