Struct matrix_sdk_crypto::types::CrossSigningKey

source · [−]

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

Expand description

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: BTreeMap<OwnedDeviceKeyId, SigningKey>

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: BTreeMap<OwnedDeviceKeyId, SigningKey>,
    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 AsRef<CrossSigningKey> for MasterPubkey

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for CrossSigningKey

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

Formats the value using the given formatter. Read more

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. Read more

impl From<CrossSigningKey> for MasterPubkey

fn from(key: CrossSigningKey) -> Self

Converts to this type from the input type.

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. Read more

Auto Trait Implementations

impl RefUnwindSafe for CrossSigningKey

impl Send for CrossSigningKey

impl Sync for CrossSigningKey

impl Unpin for CrossSigningKey

impl UnwindSafe for CrossSigningKey

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,