Struct OwnUserIdentity

Source

pub struct OwnUserIdentity { /* private fields */ }

Expand description

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§

Source §

impl OwnUserIdentity

Source

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.

Source

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

Send a verification request to our other devices.

Source

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.

Source

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.

Source

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

Remove the requirement for this identity to be verified.

Methods from Deref<Target = OwnUserIdentityData>§

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 user_signing_key(&self) -> &UserSigningPubkey

Get the public user-signing key of the identity.

Source

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.

Source

pub fn mark_as_verified(&self)

Mark our identity as verified.

Source

pub fn is_verified(&self) -> bool

Check if our identity is verified.

Source

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().

Source

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.

Source

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§

Source §

impl Clone for OwnUserIdentity

Source §

fn clone(&self) -> OwnUserIdentity

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 OwnUserIdentity

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Deref for OwnUserIdentity

Source §

type Target = OwnUserIdentityData

The resulting type after dereferencing.

Source §

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

Dereferences the value.

Source §

impl DerefMut for OwnUserIdentity

Source §

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

Mutably dereferences the value.

Source §

impl From<OwnUserIdentity> for UserIdentity

Source §

fn from(i: OwnUserIdentity) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !UnwindSafe for OwnUserIdentity

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 §

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

🔬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,

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.

Source §

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

§

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 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 §