Struct sequoia_openpgp::cert::bundle::ComponentBundle

source ·

pub struct ComponentBundle<C> { /* private fields */ }

Expand description

A certificate component and its associated signatures.

See the module level documentation for a detailed description.

Implementations§

source §

impl<P, R> ComponentBundle<Key<P, R>>
where P: KeyParts, R: KeyRole,

source

pub fn parts_into_public(self) -> KeyBundle<PublicParts, R>

Changes the key’s parts tag to PublicParts.

source

pub fn parts_as_public(&self) -> &KeyBundle<PublicParts, R>

Changes the key’s parts tag to PublicParts.

source

pub fn parts_as_public_mut(&mut self) -> &mut KeyBundle<PublicParts, R>

Changes the key’s parts tag to PublicParts.

source

pub fn parts_into_secret(self) -> Result<KeyBundle<SecretParts, R>>

Changes the key’s parts tag to SecretParts.

source

pub fn parts_as_secret(&self) -> Result<&KeyBundle<SecretParts, R>>

Changes the key’s parts tag to SecretParts.

source

pub fn parts_as_secret_mut(&mut self) -> Result<&mut KeyBundle<SecretParts, R>>

Changes the key’s parts tag to SecretParts.

source

pub fn parts_into_unspecified(self) -> KeyBundle<UnspecifiedParts, R>

Changes the key’s parts tag to UnspecifiedParts.

source

pub fn parts_as_unspecified(&self) -> &KeyBundle<UnspecifiedParts, R>

Changes the key’s parts tag to UnspecifiedParts.

source

pub fn parts_as_unspecified_mut( &mut self, ) -> &mut KeyBundle<UnspecifiedParts, R>

Changes the key’s parts tag to UnspecifiedParts.

source §

impl<P, R> ComponentBundle<Key<P, R>>
where P: KeyParts, R: KeyRole,

source

pub fn role_into_primary(self) -> KeyBundle<P, PrimaryRole>

Changes the key’s role tag to PrimaryRole.

source

pub fn role_as_primary(&self) -> &KeyBundle<P, PrimaryRole>

Changes the key’s role tag to PrimaryRole.

source

pub fn role_as_primary_mut(&mut self) -> &mut KeyBundle<P, PrimaryRole>

Changes the key’s role tag to PrimaryRole.

source

pub fn role_into_subordinate(self) -> KeyBundle<P, SubordinateRole>

Changes the key’s role tag to SubordinateRole.

source

pub fn role_as_subordinate(&self) -> &KeyBundle<P, SubordinateRole>

Changes the key’s role tag to SubordinateRole.

source

pub fn role_as_subordinate_mut(&mut self) -> &mut KeyBundle<P, SubordinateRole>

Changes the key’s role tag to SubordinateRole.

source

pub fn role_into_unspecified(self) -> KeyBundle<P, UnspecifiedRole>

Changes the key’s role tag to UnspecifiedRole.

source

pub fn role_as_unspecified(&self) -> &KeyBundle<P, UnspecifiedRole>

Changes the key’s role tag to UnspecifiedRole.

source

pub fn role_as_unspecified_mut(&mut self) -> &mut KeyBundle<P, UnspecifiedRole>

Changes the key’s role tag to UnspecifiedRole.

source §

impl<C> ComponentBundle<C>

source

pub fn component(&self) -> &C

Returns a reference to the bundle’s component.

§Examples

// Display some information about any unknown components.
for u in cert.unknowns() {
    eprintln!(" - {:?}", u.component());
}

source

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

Returns the active binding signature at time t.

The active binding signature is the most recent, non-revoked self-signature that is valid according to the policy and alive at time t (creation time <= t, t < expiry). If there are multiple such signatures then the signatures are ordered by their MPIs interpreted as byte strings.

§Examples

use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

// Display information about each User ID's current active
// binding signature (the `time` parameter is `None`), if any.
for ua in cert.userids() {
    eprintln!("{:?}", ua.binding_signature(p, None));
}

source

pub fn self_signatures2(&self) -> impl Iterator<Item = &Signature> + Send + Sync

Returns the component’s self-signatures.

The signatures are validated, and they are sorted by their creation time, most recent first.

§Examples

use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

for (i, ka) in cert.keys().enumerate() {
    eprintln!("Key #{} ({}) has {:?} self signatures",
              i, ka.fingerprint(),
              ka.bundle().self_signatures2().count());
}

source

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

👎Deprecated: Use self_signatures2 instead.

Returns the component’s self-signatures.

source

pub fn certifications2(&self) -> impl Iterator<Item = &Signature> + Send + Sync

Returns the component’s third-party certifications.

The signatures are not validated. They are sorted by their creation time, most recent first.

§Examples

use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

for ua in cert.userids() {
    eprintln!("User ID {} has {:?} unverified, third-party certifications",
              String::from_utf8_lossy(ua.userid().value()),
              ua.bundle().certifications2().count());
}

source

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

👎Deprecated: Use certifications2 instead.

Returns the component’s third-party certifications.

source

pub fn self_revocations2( &self, ) -> impl Iterator<Item = &Signature> + Send + Sync

Returns the component’s revocations that were issued by the certificate holder.

The revocations are validated, and they are sorted by their creation time, most recent first.

§Examples

use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

for u in cert.userids() {
    eprintln!("User ID {} has {:?} revocation certificates.",
              String::from_utf8_lossy(u.userid().value()),
              u.bundle().self_revocations2().count());
}

source

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

👎Deprecated: Use self_revocations2 instead.

Returns the component’s revocations that were issued by the certificate holder.

source

pub fn other_revocations2( &self, ) -> impl Iterator<Item = &Signature> + Send + Sync

Returns the component’s revocations that were issued by other certificates.

The revocations are not validated. They are sorted by their creation time, most recent first.

§Examples

use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

for u in cert.userids() {
    eprintln!("User ID {} has {:?} unverified, third-party revocation certificates.",
              String::from_utf8_lossy(u.userid().value()),
              u.bundle().other_revocations2().count());
}

source

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

👎Deprecated: Use other_revocations2 instead.

Returns the component’s revocations that were issued by other certificates.

source

pub fn attestations(&self) -> impl Iterator<Item = &Signature> + Send + Sync

Returns all of the component’s Attestation Key Signatures.

This feature is experimental.

The signatures are validated, and they are sorted by their creation time, most recent first.

A certificate owner can use Attestation Key Signatures to attest to third party certifications. Currently, only userid and user attribute certifications can be attested. See Section 5.2.3.30 of RFC 4880bis for details.

§Examples

use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

for (i, uid) in cert.userids().enumerate() {
    eprintln!("UserID #{} ({:?}) has {:?} attestation key signatures",
              i, uid.email(),
              uid.attestations().count());
}

source

pub fn signatures(&self) -> impl Iterator<Item = &Signature> + Send + Sync

Returns all of the component’s signatures.

Only the self-signatures are validated. The signatures are sorted first by type, then by creation time. The self revocations come first, then the self signatures, then any key attestation signatures, certifications, and third-party revocations coming last. This function may return additional types of signatures that could be associated to this component.

§Examples

use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

for (i, ka) in cert.keys().enumerate() {
    eprintln!("Key #{} ({}) has {:?} signatures",
              i, ka.fingerprint(),
              ka.signatures().count());
}

source §

impl<P: KeyParts, R: KeyRole> ComponentBundle<Key<P, R>>

source

pub fn key(&self) -> &Key<P, R>

Returns a reference to the key.

This is just a type-specific alias for ComponentBundle::component.

§Examples

// Display some information about the keys.
for ka in cert.keys() {
    eprintln!(" - {:?}", ka.key());
}

source §

impl<P: KeyParts> ComponentBundle<Key<P, SubordinateRole>>

source

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

Returns the subkey’s revocation status at time t.

A subkey 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 subkey is revoked; it does not imply anything about the Cert or other components.

§Examples

use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

// Display the subkeys' revocation status.
for ka in cert.keys().subkeys() {
    eprintln!(" Revocation status of {}: {:?}",
              ka.fingerprint(), ka.revocation_status(p, None));
}

source §

impl ComponentBundle<UserID>

source

pub fn userid(&self) -> &UserID

Returns a reference to the User ID.

This is just a type-specific alias for ComponentBundle::component.

§Examples

// Display some information about the User IDs.
for ua in cert.userids() {
    eprintln!(" - {:?}", ua.userid());
}

source

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

Returns the User ID’s revocation status at time t.

A User ID 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.

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

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

§Examples

use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

// Display the User IDs' revocation status.
for ua in cert.userids() {
    eprintln!(" Revocation status of {}: {:?}",
              String::from_utf8_lossy(ua.userid().value()),
              ua.revocation_status(p, None));
}

source §

impl ComponentBundle<UserAttribute>

source

pub fn user_attribute(&self) -> &UserAttribute

Returns a reference to the User Attribute.

This is just a type-specific alias for ComponentBundle::component.

§Examples

// Display some information about the User Attributes
for ua in cert.user_attributes() {
    eprintln!(" - {:?}", ua.user_attribute());
}

source

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

Returns the User Attribute’s revocation status at time t.

A User Attribute 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.

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

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

§Examples

use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

// Display the User Attributes' revocation status.
for (i, ua) in cert.user_attributes().enumerate() {
    eprintln!(" Revocation status of User Attribute #{}: {:?}",
              i, ua.revocation_status(p, None));
}

source §

impl ComponentBundle<Unknown>

source

pub fn unknown(&self) -> &Unknown

Returns a reference to the unknown component.

This is just a type-specific alias for ComponentBundle::component.

§Examples

// Display some information about the User Attributes
for u in cert.unknowns() {
    eprintln!(" - {:?}", u.unknown());
}

Trait Implementations§

source §

impl<C: Clone> Clone for ComponentBundle<C>

source §

fn clone(&self) -> ComponentBundle<C>

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

source §

impl<C: Debug> Debug for ComponentBundle<C>

source §

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

Formats the value using the given formatter. Read more

source §