Enum sequoia_openpgp::types::ReasonForRevocation

#[non_exhaustive]
pub enum ReasonForRevocation {
    Unspecified,
    KeySuperseded,
    KeyCompromised,
    KeyRetired,
    UIDRetired,
    Private(u8),
    Unknown(u8),
}

Describes the reason for a revocation.

See the description of revocation subpackets Section 5.2.3.23 of RFC 4880.

Note: This enum cannot be exhaustively matched to allow future extensions.

Examples

use sequoia_openpgp as openpgp;
use openpgp::cert::prelude::*;
use openpgp::policy::StandardPolicy;
use openpgp::types::{RevocationStatus, ReasonForRevocation, SignatureType};

let p = &StandardPolicy::new();

// A certificate with a User ID.
let (cert, _) = CertBuilder::new()
    .add_userid("Alice <alice@example.org>")
    .generate()?;

let mut keypair = cert.primary_key().key().clone()
    .parts_into_secret()?.into_keypair()?;
let ca = cert.userids().nth(0).unwrap();

// Generate the revocation for the first and only UserID.
let revocation =
    UserIDRevocationBuilder::new()
    .set_reason_for_revocation(
        ReasonForRevocation::UIDRetired,
        b"Left example.org.")?
    .build(&mut keypair, &cert, ca.userid(), None)?;
assert_eq!(revocation.typ(), SignatureType::CertificationRevocation);

// Now merge the revocation signature into the Cert.
let cert = cert.insert_packets(revocation.clone())?;

// Check that it is revoked.
let ca = cert.userids().nth(0).unwrap();
let status = ca.with_policy(p, None)?.revocation_status();
if let RevocationStatus::Revoked(revs) = status {
    assert_eq!(revs.len(), 1);
    let rev = revs[0];

    assert_eq!(rev.typ(), SignatureType::CertificationRevocation);
    assert_eq!(rev.reason_for_revocation(),
               Some((ReasonForRevocation::UIDRetired,
                     "Left example.org.".as_bytes())));
   // User ID has been revoked.
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

No reason specified (key revocations or cert revocations)

KeySuperseded

Key is superseded (key revocations)

KeyCompromised

Key material has been compromised (key revocations)

KeyRetired

Key is retired and no longer used (key revocations)

UIDRetired

User ID information is no longer valid (cert revocations)

Private(u8)

Private reason identifier.

Unknown(u8)

Unknown reason identifier.

Implementations

impl ReasonForRevocation

pub fn revocation_type(&self) -> RevocationType

Returns the revocation’s RevocationType.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::{ReasonForRevocation, RevocationType};

assert_eq!(ReasonForRevocation::KeyCompromised.revocation_type(), RevocationType::Hard);
assert_eq!(ReasonForRevocation::Private(101).revocation_type(), RevocationType::Hard);

assert_eq!(ReasonForRevocation::KeyRetired.revocation_type(), RevocationType::Soft);

pub fn variants() -> impl Iterator<Item = Self>

Returns an iterator over all valid variants.

Returns an iterator over all known variants. This does not include the ReasonForRevocation::Private or ReasonForRevocation::Unknown variants.

Trait Implementations

impl Clone for ReasonForRevocation

fn clone(&self) -> ReasonForRevocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReasonForRevocation

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

Formats the value using the given formatter.

impl Display for ReasonForRevocation

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

Formats the value using the given formatter.

impl From<ReasonForRevocation> for u8

fn from(r: ReasonForRevocation) -> u8

Converts to this type from the input type.

impl From<u8> for ReasonForRevocation

fn from(u: u8) -> Self

Converts to this type from the input type.

impl Hash for ReasonForRevocation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ReasonForRevocation

fn cmp(&self, other: &ReasonForRevocation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ReasonForRevocation

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ReasonForRevocation

fn partial_cmp(&self, other: &ReasonForRevocation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ReasonForRevocation

impl Eq for ReasonForRevocation

impl StructuralPartialEq for ReasonForRevocation