Struct matrix_sdk_crypto::Device

source · [−]

pub struct Device { /* private fields */ }

Expand description

A device represents a E2EE capable client of an user.

Implementations

source

impl Device

source

pub async fn start_verification(&self) -> StoreResult<(Sas, ToDeviceRequest)>

Start a interactive verification with this Device

Returns a Sas object and a to-device request that needs to be sent out.

This method has been deprecated in the spec and the request_verification() method should be used instead.

source

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

Request an interacitve verification with this Device

Returns a VerificationRequest object and a to-device request that needs to be sent out.

source

pub async fn request_verification_with_methods(
&self,
methods: Vec<VerificationMethod>
) -> (VerificationRequest, OutgoingVerificationRequest)

Request an interacitve verification with this Device

Returns a VerificationRequest object and a to-device request that needs to be sent out.

Arguments

methods - The verification methods that we want to support.

source

pub fn verified(&self) -> bool

Is this device considered to be verified.

This method returns true if either is_locally_trusted() returns true or if is_cross_signing_trusted() returns true.

source

pub fn is_cross_signing_trusted(&self) -> bool

Is this device considered to be verified using cross signing.

source

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

Manually verify this device.

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

This method will always fail if the device belongs to someone else, we can only sign our own devices.

It can also fail if we don’t have the private part of our self-signing key.

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

source

pub async fn set_local_trust(&self, trust_state: LocalTrust) -> StoreResult<()>

Set the local trust state of the device to the given state.

This won’t affect any cross signing trust state, this only sets a flag marking to have the given trust state.

Arguments

trust_state - The new trust state that should be set for the device.

source

pub async fn encrypt_session(
 &self,
 session: InboundGroupSession,
 message_index: Option<u32>
) -> Result<(Session, ToDeviceRoomEncryptedEventContent), OlmError>

Encrypt the given inbound group session as a forwarded room key for this device.

Methods from Deref<Target = ReadOnlyDevice>

source

pub fn user_id(&self) -> &UserId

The user id of the device owner.

source

pub fn device_id(&self) -> &DeviceId

The unique ID of the device.

source

pub fn display_name(&self) -> Option<&str>

Get the human readable name of the device.

source

pub fn get_key(&self, algorithm: DeviceKeyAlgorithm) -> Option<&DeviceKey>

Get the key of the given key algorithm belonging to this device.

source

pub fn curve25519_key(&self) -> Option<Curve25519PublicKey>

Get the Curve25519 key of the given device.

source

pub fn ed25519_key(&self) -> Option<Ed25519PublicKey>

Get the Ed25519 key of the given device.

source

pub fn keys(&self) -> &BTreeMap<OwnedDeviceKeyId, DeviceKey>

Get a map containing all the device keys.

source

pub fn signatures(&self) -> &Signatures

Get a map containing all the device signatures.

source

pub fn local_trust_state(&self) -> LocalTrust

Get the trust state of the device.

source

pub fn is_locally_trusted(&self) -> bool

Is the device locally marked as trusted.

source

pub fn is_blacklisted(&self) -> bool

Is the device locally marked as blacklisted.

Blacklisted devices won’t receive any group sessions.

source

pub fn algorithms(&self) -> &[EventEncryptionAlgorithm]

Get the list of algorithms this device supports.

source

pub fn deleted(&self) -> bool

Is the device deleted.

Trait Implementations

source

impl Clone for Device

source

fn clone(&self) -> Device

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 Device

source

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

Formats the value using the given formatter. Read more

source

impl Deref for Device

type Target = ReadOnlyDevice

The resulting type after dereferencing.

source

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

Dereferences the value.

Auto Trait Implementations

impl !RefUnwindSafe for Device

impl Send for Device

impl Sync for Device

impl Unpin for Device

impl !UnwindSafe for Device

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

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

const: unstable · 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> Same<T> 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

source

Struct matrix_sdk_crypto::Device

Implementations

impl Device

pub async fn start_verification(&self) -> StoreResult<(Sas, ToDeviceRequest)>

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

pub async fn request_verification_with_methods( &self, methods: Vec<VerificationMethod>) -> (VerificationRequest, OutgoingVerificationRequest)

pub fn verified(&self) -> bool

pub fn is_cross_signing_trusted(&self) -> bool

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

pub async fn set_local_trust(&self, trust_state: LocalTrust) -> StoreResult<()>

pub async fn encrypt_session( &self, session: InboundGroupSession, message_index: Option<u32>) -> Result<(Session, ToDeviceRoomEncryptedEventContent), OlmError>

Methods from Deref<Target = ReadOnlyDevice>

pub fn user_id(&self) -> &UserId

pub fn device_id(&self) -> &DeviceId

pub fn display_name(&self) -> Option<&str>

pub fn get_key(&self, algorithm: DeviceKeyAlgorithm) -> Option<&DeviceKey>

pub fn curve25519_key(&self) -> Option<Curve25519PublicKey>

pub fn ed25519_key(&self) -> Option<Ed25519PublicKey>

pub fn keys(&self) -> &BTreeMap<OwnedDeviceKeyId, DeviceKey>

pub fn signatures(&self) -> &Signatures

pub fn local_trust_state(&self) -> LocalTrust

pub fn is_locally_trusted(&self) -> bool

pub fn is_blacklisted(&self) -> bool

pub fn algorithms(&self) -> &[EventEncryptionAlgorithm]

pub fn deleted(&self) -> bool

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

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

impl Debug for Device

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

impl Deref for Device

type Target = ReadOnlyDevice

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

Auto Trait Implementations

impl !RefUnwindSafe for Device

impl Send for Device

impl Sync for Device

impl Unpin for Device

impl !UnwindSafe for Device

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> AsyncTraitDeps for T where T: Debug + Send + Sync,

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

pub async fn request_verification_with_methods(
&self,
methods: Vec<VerificationMethod>
) -> (VerificationRequest, OutgoingVerificationRequest)

pub async fn encrypt_session(
&self,
session: InboundGroupSession,
message_index: Option<u32>
) -> Result<(Session, ToDeviceRoomEncryptedEventContent), OlmError>

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

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

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

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

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

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

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

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

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

impl<T> AsyncTraitDeps for T where
T: Debug + Send + Sync,