Struct sequoia_openpgp::cert::components::ValidPrimaryKeyAmalgamation

pub struct ValidPrimaryKeyAmalgamation<'a, P: KeyParts> { /* fields omitted */ }

A Key and its associated data.

This is just a wrapper around ValidKeyAmalgamation that preserves the ValidKeyAmalgamation's role.

Methods

impl<'a, P: KeyParts> ValidPrimaryKeyAmalgamation<'a, P>

pub fn key(&self) -> &'a Key<P, PrimaryRole> where
    &'a Key<P, UnspecifiedRole>: From<&'a Key<PublicParts, PrimaryRole>>, 

Returns the key.

pub fn with_policy<T>(self, policy: &'a dyn Policy, time: T) -> Result<Self> where
    T: Into<Option<SystemTime>>, 

Changes the amalgamation's policy.

If time is None, the current time is used.

Methods from Deref<Target = ValidKeyAmalgamation<'a, P>>

pub fn bundle(&self) -> &'a KeyBundle<P, UnspecifiedRole> where
    &'a KeyBundle<P, UnspecifiedRole>: From<&'a KeyBundle<PublicParts, PrimaryRole>>, 

Returns this key's bundle.

pub fn alive(&self) -> Result<()>

Returns whether the key is alive as of the amalgamtion's reference time.

Note: this does not return whether the certificate is valid.

Considers both the binding signature and the direct key signature. Information in the binding signature takes precedence over the direct key signature. See also Section 5.2.3.3 of RFC 4880.

pub fn has_secret(&self) -> bool

Returns whether the key contains secret key material.

pub fn has_unencrypted_secret(&self) -> bool

Returns whether the key contains unencrypted secret key material.

Trait Implementations

impl<'a, P: 'a + KeyParts> Amalgamation<'a> for ValidPrimaryKeyAmalgamation<'a, P>

fn cert(&self) -> &'a Cert

Returns the certificate that the component came from.

fn time(&self) -> SystemTime

Returns the amalgamation's reference time.

For queries that are with respect to a point in time, this determines that point in time. For instance, if a key is created at t_c and expires at t_e, then ValidKeyAmalgamation::alive will return true if the reference time is greater than or equal to t_c and less than t_e.

fn policy(&self) -> &'a dyn Policy

Returns the amalgamation's policy.

fn with_policy<T>(self, policy: &'a dyn Policy, time: T) -> Result<Self> where
    T: Into<Option<SystemTime>>, 

Changes the amalgamation's policy.

If time is None, the current time is used.

fn binding_signature(&self) -> &'a Signature

Returns the key's binding signature as of the reference time, if any.

fn direct_key_signature(&self) -> Option<&'a Signature>

Returns the Certificate's direct key signature as of the reference time, if any.

Subpackets on direct key signatures apply to all components of the certificate.

fn revoked(&self) -> RevocationStatus<'a>

Returns the key's revocation status as of the amalgamation's reference time.

Note: this function only returns whether the key has been revoked, it does not return whether the certificate has been revoked.

fn cert_revoked(&self) -> RevocationStatus<'a>

Returns the certificate's revocation status as of the amalgamtion's reference time.

fn cert_alive(&self) -> Result<()>

Returns whether the certificateis alive as of the amalgamtion's reference time.

fn map<F: Fn(&'a Signature) -> Option<T>, T>(&self, f: F) -> Option<T>

Maps the given function over binding and direct key signature.

fn key_flags(&self) -> Option<KeyFlags>

Returns the key's key flags as of the amalgamtion's reference time.

fn has_any_key_flag<F>(&self, flags: F) -> bool where
    F: Borrow<KeyFlags>, 

Returns whether the key has at least one of the specified key flags as of the amalgamtion's reference time.

fn for_certification(&self) -> bool

Returns whether key is certification capable as of the amalgamtion's reference time.

fn for_signing(&self) -> bool

Returns whether key is signing capable as of the amalgamtion's reference time.

fn for_authentication(&self) -> bool

Returns whether key is authentication capable as of the amalgamtion's reference time.

fn for_storage_encryption(&self) -> bool

Returns whether key is intended for storage encryption as of the amalgamtion's reference time.

fn for_transport_encryption(&self) -> bool

Returns whether key is intended for transport encryption as of the amalgamtion's reference time.

fn key_expiration_time(&self) -> Option<Duration>

Returns the key's expiration time as of the amalgamtion's reference time.

fn revocation_key(&self) -> Option<(u8, PublicKeyAlgorithm, Fingerprint)>

Returns the value of the Revocation Key subpacket, which contains a designated revoker.

impl<'a, P: Clone + KeyParts> Clone for ValidPrimaryKeyAmalgamation<'a, P>

fn clone(&self) -> ValidPrimaryKeyAmalgamation<'a, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, P: Debug + KeyParts> Debug for ValidPrimaryKeyAmalgamation<'a, P>

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

Formats the value using the given formatter.

impl<'a, P: KeyParts> Deref for ValidPrimaryKeyAmalgamation<'a, P> where
    &'a Key<P, PrimaryRole>: From<&'a Key<PublicParts, PrimaryRole>>, 

type Target = ValidKeyAmalgamation<'a, P>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, P> From<ValidPrimaryKeyAmalgamation<'a, P>> for ValidKeyAmalgamation<'a, P> where
    P: KeyParts, 

fn from(a: ValidPrimaryKeyAmalgamation<'a, P>) -> Self

Performs the conversion.

impl<'a, P: KeyParts> Preferences<'a> for ValidPrimaryKeyAmalgamation<'a, P>

fn preferred_symmetric_algorithms(&self) -> Option<&'a [SymmetricAlgorithm]>

Returns symmetric algorithms that the key holder prefers.

fn preferred_hash_algorithms(&self) -> Option<&'a [HashAlgorithm]>

Returns hash algorithms that the key holder prefers.

fn preferred_compression_algorithms(&self) -> Option<&'a [CompressionAlgorithm]>

Returns compression algorithms that the key holder prefers.

fn preferred_aead_algorithms(&self) -> Option<&'a [AEADAlgorithm]>

Returns AEAD algorithms that the key holder prefers.

fn key_server_preferences(&self) -> Option<KeyServerPreferences>

Returns the key holder's keyserver preferences.

fn preferred_key_server(&self) -> Option<&'a [u8]>

Returns the key holder's preferred keyserver for updates.

fn features(&self) -> Option<Features>

Returns the key holder's feature set.