Struct matrix_sdk_crypto::types::CrossSigningKey

pub struct CrossSigningKey {
    pub user_id: OwnedUserId,
    pub usage: Vec<KeyUsage>,
    pub keys: SigningKeys<OwnedDeviceKeyId>,
    pub signatures: Signatures,
    /* private fields */
}

A cross signing key.

Fields

user_id: OwnedUserId

The ID of the user the key belongs to.

usage: Vec<KeyUsage>

What the key is used for.

keys: SigningKeys<OwnedDeviceKeyId>

The public key.

The object must have exactly one property.

signatures: Signatures

Signatures of the key.

Only optional for master key.

Implementations

impl CrossSigningKey

pub fn new( user_id: OwnedUserId, usage: Vec<KeyUsage>, keys: SigningKeys<OwnedDeviceKeyId>, signatures: Signatures, ) -> Self

Creates a new CrossSigningKey with the given user ID, usage, keys and signatures.

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

Serialize the cross signing key into a Raw version.

pub fn get_first_key_and_id(&self) -> Option<(&DeviceKeyId, Ed25519PublicKey)>

Get the Ed25519 cross-signing key (and its ID).

Structurally, a cross-signing key could contain more than one actual key. However, the spec forbids this (see the keys field description), so we just get the first one.

Trait Implementations

impl AsMut<CrossSigningKey> for MasterPubkey

fn as_mut(&mut self) -> &mut CrossSigningKey

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<CrossSigningKey> for SelfSigningPubkey

fn as_mut(&mut self) -> &mut CrossSigningKey

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<CrossSigningKey> for UserSigningPubkey

fn as_mut(&mut self) -> &mut CrossSigningKey

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<CrossSigningKey> for MasterPubkey

fn as_ref(&self) -> &CrossSigningKey

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CrossSigningKey> for SelfSigningPubkey

fn as_ref(&self) -> &CrossSigningKey

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CrossSigningKey> for UserSigningPubkey

fn as_ref(&self) -> &CrossSigningKey

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CrossSigningKey

fn clone(&self) -> CrossSigningKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CrossSigningKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CrossSigningKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CrossSigningKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CrossSigningKey> for MasterPubkey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(key: CrossSigningKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CrossSigningKey> for SelfSigningPubkey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(key: CrossSigningKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CrossSigningKey> for UserSigningPubkey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(key: CrossSigningKey) -> Result<Self, Self::Error>

Performs the conversion.