[][src]Struct sequoia_openpgp::cert::CertRevocationBuilder

pub struct CertRevocationBuilder { /* fields omitted */ }

A Cert revocation builder.

Note: a Cert revocation has two degrees of freedom: the Cert, and the key used to generate the revocation.

Normally, the key used to generate the revocation is the Cert's primary key. However, this is not required.

If Alice has marked Robert's key (R) as a designated revoker for her key (A), then R can revoke A or parts of A. In this case, the Cert is A, and the key used to generate the revocation comes from R.

Example

use openpgp::types::{ReasonForRevocation, RevocationStatus, SignatureType};
use openpgp::cert::prelude::*;
use openpgp::crypto::KeyPair;
use openpgp::parse::Parse;
use sequoia_openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

let (cert, _) = CertBuilder::new()
    .set_cipher_suite(CipherSuite::Cv25519)
    .generate()?;
assert_eq!(RevocationStatus::NotAsFarAsWeKnow,
           cert.revoked(p, None));

let mut signer = cert.primary_key().key().clone()
    .mark_parts_secret()?.into_keypair()?;
let sig = CertRevocationBuilder::new()
    .set_reason_for_revocation(ReasonForRevocation::KeyCompromised,
                               b"It was the maid :/")?
    .build(&mut signer, &cert, None)?;
assert_eq!(sig.typ(), SignatureType::KeyRevocation);

let cert = cert.merge_packets(vec![sig.clone().into()])?;
assert_eq!(RevocationStatus::Revoked(vec![&sig]),
           cert.revoked(p, None));

Implementations

impl CertRevocationBuilder[src]

pub fn new() -> Self[src]

Returns a new CertRevocationBuilder.

pub fn set_reason_for_revocation(
    self,
    code: ReasonForRevocation,
    reason: &[u8]
) -> Result<Self>
[src]

Sets the reason for revocation.

pub fn set_signature_creation_time(
    self,
    creation_time: SystemTime
) -> Result<Self>
[src]

Sets the revocation signature's creation time.

pub fn build<H>(
    self,
    signer: &mut dyn Signer,
    cert: &Cert,
    hash_algo: H
) -> Result<Signature> where
    H: Into<Option<HashAlgorithm>>, 
[src]

Returns a revocation certificate for the cert Cert signed by signer.

Methods from Deref<Target = Builder>

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

Gets the version.

pub fn typ(&self) -> SignatureType[src]

Gets the signature type.

pub fn pk_algo(&self) -> PublicKeyAlgorithm[src]

Gets the public key algorithm.

pub fn hash_algo(&self) -> HashAlgorithm[src]

Gets the hash algorithm.

Trait Implementations

impl Deref for CertRevocationBuilder[src]

type Target = Builder

The resulting type after dereferencing.

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> From<T> for T[src]

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

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.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,