Struct matrix_sdk_crypto::OtherUserIdentity

source ·
pub struct OtherUserIdentity { /* private fields */ }
Expand description

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§

source§

impl OtherUserIdentity

source

pub fn is_verified(&self) -> bool

Is this user identity verified.

source

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.

source

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.

source

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 OtherUserIdentity::request_verification() method.

source

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

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

source

pub fn identity_needs_user_approval(&self) -> bool

Has the identity changed 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, unless it is an explicitly verified identity (using for example interactive verification).

This situation can be resolved by:

source

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

Remove the requirement for this identity to be verified.

source

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

Methods from Deref<Target = OtherUserIdentityData>§

source

pub fn user_id(&self) -> &UserId

Get the user id of this identity.

source

pub fn master_key(&self) -> &MasterPubkey

Get the public master key of the identity.

source

pub fn self_signing_key(&self) -> &SelfSigningPubkey

Get the public self-signing key of the identity.

source

pub fn was_previously_verified(&self) -> bool

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

To set this latch back to false, call OtherUserIdentityData::withdraw_verification().

source

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§

source§

impl Clone for OtherUserIdentity

source§

fn clone(&self) -> OtherUserIdentity

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for OtherUserIdentity

source§

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

Formats the value using the given formatter. Read more
source§

impl Deref for OtherUserIdentity

§

type Target = OtherUserIdentityData

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl DerefMut for OtherUserIdentity

source§

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

Mutably dereferences the value.
source§

impl From<OtherUserIdentity> for UserIdentity

source§

fn from(i: OtherUserIdentity) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
source§

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
source§

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>
source§

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> AsyncTraitDeps for T

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,