[][src]Struct sequoia_openpgp::types::RevocationKey

pub struct RevocationKey { /* fields omitted */ }

Designates a key as a valid third-party revoker.

This is described in Section 5.2.3.15 of RFC 4880.

Revocation keys can be retrieved using ComponentAmalgamation::revocation_keys and set using CertBuilder::set_revocation_keys.

Examples

use sequoia_openpgp as openpgp;
use openpgp::cert::prelude::*;
use openpgp::policy::StandardPolicy;
use openpgp::types::RevocationKey;

let p = &StandardPolicy::new();

let (alice, _) =
    CertBuilder::general_purpose(None, Some("alice@example.org"))
    .generate()?;

// Make Alice a designated revoker for Bob.
let (bob, _) =
    CertBuilder::general_purpose(None, Some("bob@example.org"))
    .set_revocation_keys(vec![(&alice).into()])
    .generate()?;

// Make sure Alice is listed as a designated revoker for Bob
// on a component.
assert_eq!(bob.with_policy(p, None)?.primary_userid()?.revocation_keys(p)
               .collect::<Vec<&RevocationKey>>(),
           vec![&(&alice).into()]);

Implementations

impl RevocationKey[src]

pub fn new(
    pk_algo: PublicKeyAlgorithm,
    fp: Fingerprint,
    sensitive: bool
) -> Self
[src]

Creates a new instance.

pub fn from_bits(
    pk_algo: PublicKeyAlgorithm,
    fp: Fingerprint,
    class: u8
) -> Result<Self>
[src]

Creates a new instance from the raw class parameter.

pub fn class(&self) -> u8[src]

Returns the class octet, the sum of all flags.

pub fn revoker(&self) -> (PublicKeyAlgorithm, &Fingerprint)[src]

Returns the revoker's identity.

pub fn set_revoker(
    &mut self,
    pk_algo: PublicKeyAlgorithm,
    fp: Fingerprint
) -> (PublicKeyAlgorithm, Fingerprint)
[src]

Sets the revoker's identity.

pub fn sensitive(&self) -> bool[src]

Returns whether or not the relation between revoker and revokee is of a sensitive nature.

pub fn set_sensitive(self, v: bool) -> Self[src]

Sets whether or not the relation between revoker and revokee is of a sensitive nature.

Trait Implementations

impl Clone for RevocationKey[src]

impl Debug for RevocationKey[src]

impl Eq for RevocationKey[src]

impl<'_> From<&'_ Cert> for RevocationKey[src]

impl Hash for RevocationKey[src]

impl Marshal for RevocationKey[src]

impl MarshalInto for RevocationKey[src]

impl Ord for RevocationKey[src]

impl PartialEq<RevocationKey> for RevocationKey[src]

impl PartialOrd<RevocationKey> for RevocationKey[src]

impl StructuralEq for RevocationKey[src]

impl StructuralPartialEq for RevocationKey[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DynClone for T where
    T: Clone
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.