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::RevocationStatus;
use openpgp::types::{ReasonForRevocation, SignatureType};
use openpgp::cert::{CipherSuite, CertBuilder, CertRevocationBuilder};
use openpgp::crypto::KeyPair;
use openpgp::parse::Parse;

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

let mut signer = cert.primary().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(None));

Methods

impl CertRevocationBuilder

pub fn new() -> Self

Returns a new CertRevocationBuilder.

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

Sets the reason for revocation.

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

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>>, 

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

Methods from Deref<Target = Builder>

pub fn version(&self) -> u8

Gets the version.

pub fn typ(&self) -> SignatureType

Gets the signature type.

pub fn pk_algo(&self) -> PublicKeyAlgorithm

Gets the public key algorithm.

pub fn hash_algo(&self) -> HashAlgorithm

Gets the hash algorithm.

Trait Implementations

impl Deref for CertRevocationBuilder

type Target = Builder

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.