Struct matrix_sdk_crypto::Device

pub struct Device { /* fields omitted */ }

A device represents a E2EE capable client of an user.

Implementations

impl Device

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.

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.

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.

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.

pub fn is_cross_signing_trusted(&self) -> bool

Is this device considered to be verified using cross signing.

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.

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.

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

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

Methods from Deref<Target = ReadOnlyDevice>

pub fn user_id(&self) -> &UserId

The user id of the device owner.

pub fn device_id(&self) -> &DeviceId

The unique ID of the device.

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

Get the human readable name of the device.

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

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

pub fn keys(&self) -> &BTreeMap<DeviceKeyId, String>

Get a map containing all the device keys.

pub fn signatures(&self) -> &BTreeMap<UserId, BTreeMap<DeviceKeyId, String>>

Get a map containing all the device signatures.

pub fn local_trust_state(&self) -> LocalTrust

Get the trust state of the device.

pub fn is_locally_trusted(&self) -> bool

Is the device locally marked as trusted.

pub fn is_blacklisted(&self) -> bool

Is the device locally marked as blacklisted.

Blacklisted devices won’t receive any group sessions.

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

Get the list of algorithms this device supports.

pub fn deleted(&self) -> bool

Is the device deleted.

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Device

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

Formats the value using the given formatter.

impl Deref for Device

type Target = ReadOnlyDevice

The resulting type after dereferencing.

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

Dereferences the value.