Struct sequoia_openpgp::cert::ValidCert

pub struct ValidCert<'a> { /* fields omitted */ }

A certificate under a given policy at a given time.

Implementations

impl<'a> ValidCert<'a>

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

Returns the certificate.

pub 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.

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

Returns the amalgamation's policy.

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

Changes the amalgamation's policy.

If time is None, the current time is used.

Returns an error if the certificate is not valid for the given policy at the given time.

pub fn direct_key_signature(&self) -> Result<&'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.

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

Returns the Cert's revocation status.

A Cert is revoked if:

• There is a live revocation that is newer than all live self signatures, or

• There is a hard revocation (even if it is not live at time t, and even if there is a newer self-signature).

Note: Certs and subkeys have different criteria from User IDs and User Attributes.

Note: this only returns whether this Cert is revoked; it does not imply anything about the Cert or other components.

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

Returns whether or not the Cert is alive.

pub fn primary_key(&self) -> ValidPrimaryKeyAmalgamation<'a, PublicParts>

Returns the amalgamated primary key.

pub fn keys(&self) -> ValidKeyAmalgamationIter<PublicParts, UnspecifiedRole>

Returns an iterator over the certificate's keys.

That is, this returns an iterator over the primary key and any subkeys.

pub fn primary_userid(&self) -> Result<ValidComponentAmalgamation<'a, UserID>>

Returns the amalgamated primary userid, if any.

pub fn userids(&self) -> ValidComponentBundleIter<UserID>

Returns an iterator over the Cert's userids.

pub fn primary_user_attribute(
    &self
) -> Result<ValidComponentAmalgamation<'a, UserAttribute>>

Returns the amalgamated primary user attribute, if any.

pub fn user_attributes(&self) -> ValidComponentBundleIter<UserAttribute>

Returns an iterator over the Cert's UserAttributeBundles.

Methods from Deref<Target = Cert>

pub fn primary_key(&self) -> PrimaryKeyAmalgamation<PublicParts>

Returns the amalgamated primary key.

pub fn direct_key_signature<T>(
    &self,
    policy: &dyn Policy,
    t: T
) -> Result<&Signature> where
    T: Into<Option<SystemTime>>, 

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.

pub fn revoked<T>(&self, policy: &dyn Policy, t: T) -> RevocationStatus where
    T: Into<Option<SystemTime>>, 

Returns the Cert's revocation status at time t.

A Cert is revoked at time t if:

• There is a live revocation at time t that is newer than all live self signatures at time t, or

• There is a hard revocation (even if it is not live at time t, and even if there is a newer self-signature).

Note: Certs and subkeys have different criteria from User IDs and User Attributes.

Note: this only returns whether this Cert is revoked; it does not imply anything about the Cert or other components.

pub fn alive<T>(&self, policy: &dyn Policy, t: T) -> Result<()> where
    T: Into<Option<SystemTime>>, 

Returns whether or not the Cert is alive at t.

pub fn primary_userid<'a, T>(
    &'a self,
    policy: &'a dyn Policy,
    t: T
) -> Result<ValidComponentAmalgamation<'a, UserID>> where
    T: Into<Option<SystemTime>>, 

Returns the amalgamated primary userid at t, if any.

pub fn userids(&self) -> ComponentBundleIter<UserID>

Returns an iterator over the Cert's userids.

pub fn primary_user_attribute<'a, T>(
    &'a self,
    policy: &'a dyn Policy,
    t: T
) -> Result<ValidComponentAmalgamation<'a, UserAttribute>> where
    T: Into<Option<SystemTime>>, 

Returns the amalgamated primary user attribute at t, if any.

pub fn user_attributes(&self) -> ComponentBundleIter<UserAttribute>

Returns an iterator over the Cert's UserAttributeBundles.

pub fn unknowns(&self) -> ComponentBundleIter<Unknown>

Returns an iterator over the Cert's unknown components.

pub fn bad_signatures(&self) -> &[Signature]

Returns a slice containing all bad signatures.

Bad signatures are signatures that we could not associate with one of the components.

pub fn keys(&self) -> KeyAmalgamationIter<PublicParts, UnspecifiedRole>

Returns an iterator over the certificate's keys.

That is, this returns an iterator over the primary key and any subkeys.

pub fn key_handle(&self) -> KeyHandle

Returns the Cert's fingerprint.

pub fn fingerprint(&self) -> Fingerprint

Returns the Cert's fingerprint.

pub fn keyid(&self) -> KeyID

Returns the Cert's keyid.

pub fn is_tsk(&self) -> bool

Returns whether at least one of the keys includes a secret part.

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

Fixes a time and policy for use with this certificate.

If time is None, the current time is used.

Returns an error if the certificate is not valid for the given policy at the given time.

pub fn as_tsk<'a>(&'a self) -> TSK<'a>

Derive a TSK object from this key.

This object writes out secret keys during serialization.

pub fn armor_headers(&self) -> Vec<String>

Creates descriptive armor headers.

Returns armor headers that describe this Cert. The Cert's primary fingerprint and valid userids (according to the default policy) are included as comments, so that it is easier to identify the Cert when looking at the armored data.

pub fn armored<'a>(&'a self) -> impl Serialize + SerializeInto + 'a

Wraps this Cert in an armor structure when serialized.

Derives an object from this Cert that adds an armor structure to the serialized Cert when it is serialized. Additionally, the Cert's userids are added as comments, so that it is easier to identify the Cert when looking at the armored data.

Example

use sequoia_openpgp as openpgp;
use openpgp::cert::prelude::*;
use openpgp::serialize::SerializeInto;

let (cert, _) =
    CertBuilder::general_purpose(None, Some("Mr. Pink ☮☮☮"))
    .generate()?;
let armored = String::from_utf8(cert.armored().to_vec()?)?;

assert!(armored.starts_with("-----BEGIN PGP PUBLIC KEY BLOCK-----"));
assert!(armored.contains("Mr. Pink ☮☮☮"));

Trait Implementations

impl<'a> Clone for ValidCert<'a>

fn clone(&self) -> ValidCert<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ValidCert<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for ValidCert<'a>

type Target = Cert

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> Display for ValidCert<'a>

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

Formats the value using the given formatter.

impl<'a> Preferences<'a> for ValidCert<'a>

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.