Struct Device

pub struct Device { /* private fields */ }

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 fn is_our_own_device(&self) -> bool

Is this our own device?

pub fn is_owner_of_session( &self, session: &InboundGroupSession, ) -> Result<bool, MismatchedIdentityKeysError>

Does the given InboundGroupSession belong to this device?

An InboundGroupSession is exchanged between devices as an Olm encrypted m.room_key event. This method determines if this Device can be confirmed as the creator and owner of the m.room_key.

pub fn is_cross_signed_by_owner(&self) -> bool

Is this device cross signed by its owner?

pub fn is_device_owner_verified(&self) -> bool

Is the device owner verified by us?

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

Request an interactive verification with this Device.

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

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

Request an interactive 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 is_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_room_key_for_forwarding( &self, session: InboundGroupSession, message_index: Option<u32>, ) -> Result<(Session, Raw<ToDeviceEncryptedEventContent>), OlmError>

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

pub async fn encrypt_event_raw( &self, event_type: &str, content: &Value, ) -> Result<Raw<ToDeviceEncryptedEventContent>, OlmError>

Encrypt an event for this device.

Beware that the 1-to-1 session must be established prior to this call by using the OlmMachine::get_missing_sessions method.

Notable limitation: The caller is responsible for sending the encrypted event to the target device, this encryption method supports out-of-order messages to a certain extent (2000 messages), if multiple messages are encrypted using this method they should be sent in the same order as they are encrypted.

Note: To instead encrypt an event meant for a room use the OlmMachine::encrypt_room_event() method instead.

Arguments

• event_type - The type of the event to be sent.
• content - The content of the event to be sent. This should be a type that implements the Serialize trait.

Returns

The encrypted raw content to be shared with your preferred transport layer (usually to-device), OlmError::MissingSession if there is no established session with the device.

pub fn is_dehydrated(&self) -> bool

Whether or not the device is a dehydrated device.

Methods from Deref<Target = DeviceData>

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<&str>

Get the human readable name of the device.

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

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

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

Get the Curve25519 key of the given device.

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

Get the Ed25519 key of the given device.

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

Get a map containing all the device keys.

pub fn signatures(&self) -> &Signatures

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 was_withheld_code_sent(&self) -> bool

Returns true if the m.no_olm withheld code was already sent to this device.

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

Get the list of algorithms this device supports.

pub fn supports_olm(&self) -> bool

Does this device support any of our known Olm encryption algorithms.

pub fn olm_session_config(&self) -> SessionConfig

Get the optimal SessionConfig for this device.

pub fn is_deleted(&self) -> bool

Is the device deleted.

pub fn as_device_keys(&self) -> &DeviceKeys

Return the device keys

pub fn first_time_seen_ts(&self) -> MilliSecondsSinceUnixEpoch

Get the local timestamp of when this device was first persisted, in milliseconds since epoch (client local time).

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

The resulting type after dereferencing.

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

Dereferences the value.