Struct DeviceKeys

pub struct DeviceKeys {
    pub user_id: OwnedUserId,
    pub device_id: OwnedDeviceId,
    pub algorithms: Vec<EventEncryptionAlgorithm>,
    pub keys: BTreeMap<OwnedDeviceKeyId, DeviceKey>,
    pub signatures: Signatures,
    pub dehydrated: JsOption<bool>,
    pub unsigned: UnsignedDeviceInfo,
    /* private fields */
}

Represents a Matrix cryptographic device

This struct models a Matrix cryptographic device involved in end-to-end encrypted messaging, specifically for to-device communication. It aligns with the DeviceKeys struct in the Matrix Specification, encapsulating essential elements such as the public device identity keys.

See also ruma::encryption::DeviceKeys which is similar, but slightly less comprehensive (it lacks some fields, and the keys are represented as base64 strings rather than type-safe DeviceKeys). We always use this struct to build /keys/upload requests and to deserialize /keys/query responses.

Fields

user_id: OwnedUserId

The ID of the user the device belongs to.

Must match the user ID used when logging in.

device_id: OwnedDeviceId

The ID of the device these keys belong to.

Must match the device ID used when logging in.

algorithms: Vec<EventEncryptionAlgorithm>

The encryption algorithms supported by this device.

keys: BTreeMap<OwnedDeviceKeyId, DeviceKey>

Public identity keys.

signatures: Signatures

Signatures for the device key object.

dehydrated: JsOption<bool>

Whether the device is a dehydrated device or not

unsigned: UnsignedDeviceInfo

Additional data added to the device key information by intermediate servers, and not covered by the signatures.

Implementations

impl DeviceKeys

pub fn new( user_id: OwnedUserId, device_id: OwnedDeviceId, algorithms: Vec<EventEncryptionAlgorithm>, keys: BTreeMap<OwnedDeviceKeyId, DeviceKey>, signatures: Signatures, ) -> Self

Creates a new DeviceKeys from the given user id, device ID, algorithms, keys and signatures.

pub fn to_raw<T>(&self) -> Raw<T>

Serialize the device keys key into a Raw version.

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.

Trait Implementations

impl Clone for DeviceKeys

fn clone(&self) -> DeviceKeys

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceKeys

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeviceKeys

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeviceKeys

fn eq(&self, other: &DeviceKeys) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DeviceKeys

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&DeviceKeys> for DeviceData

type Error = SignatureError

The type returned in the event of a conversion error.

fn try_from(device_keys: &DeviceKeys) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for DeviceKeys