Enum sequoia_openpgp::types::ReasonForRevocation

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

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)§

This enum is marked as 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§

source§

impl ReasonForRevocation

source

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);
source

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§

source§

impl Clone for ReasonForRevocation

source§

fn clone(&self) -> ReasonForRevocation

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 Debug for ReasonForRevocation

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for ReasonForRevocation

source§

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

Formats the value using the given formatter. Read more
source§

impl From<ReasonForRevocation> for u8

source§

fn from(r: ReasonForRevocation) -> u8

Converts to this type from the input type.
source§

impl From<u8> for ReasonForRevocation

source§

fn from(u: u8) -> Self

Converts to this type from the input type.
source§

impl Hash for ReasonForRevocation

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for ReasonForRevocation

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for ReasonForRevocation

source§

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

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

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.
source§

impl PartialOrd for ReasonForRevocation

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Copy for ReasonForRevocation

source§

impl Eq for ReasonForRevocation

source§

impl StructuralPartialEq for ReasonForRevocation

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.