Struct MasterPubkey

pub struct MasterPubkey(/* private fields */);

Wrapper for a cross signing key marking it as the master key.

Master keys are used to sign other cross signing keys, the self signing and user signing keys of an user will be signed by their master key.

Implementations

impl MasterPubkey

pub fn user_id(&self) -> &UserId

Get the user id of the master key’s owner.

pub fn keys(&self) -> &SigningKeys<OwnedDeviceKeyId>

Get the keys map of containing the master keys.

pub fn usage(&self) -> &[KeyUsage]

Get the list of KeyUsage that is set for this key.

pub fn signatures(&self) -> &Signatures

Get the signatures map of this cross signing key.

pub fn get_key(&self, key_id: &DeviceKeyId) -> Option<&SigningKey>

Get the master key with the given key id.

Arguments

• key_id - The id of the key that should be fetched.

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

Get the first available master key.

There’s usually only a single master key so this will usually fetch the only key.

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

fn clone(&self) -> MasterPubkey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MasterPubkey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MasterPubkey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> IntoIterator for &'a MasterPubkey

type Item = (&'a OwnedKeyId<DeviceKeyAlgorithm, DeviceId>, &'a SigningKey)

The type of the elements being iterated over.

type IntoIter = Iter<'a, OwnedKeyId<DeviceKeyAlgorithm, DeviceId>, SigningKey>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for MasterPubkey

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

The PartialEq implementation compares the user ID, the usage and the key material, ignoring signatures.

The usage could be safely ignored since the type guarantees it has the correct usage by construction – it is impossible to construct a value of a particular key type with an incorrect usage. However, we check it anyway, to codify the notion that the same key material with a different usage results in a logically different key.

The signatures are provided by other devices and don’t alter the identity of the key itself.

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 MasterPubkey

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 Eq for MasterPubkey