Struct sequoia_openpgp::cert::CertBuilder

pub struct CertBuilder { /* fields omitted */ }

Simplifies generation of Keys.

Builder to generate complex Cert hierarchies with multiple user IDs.

Methods

impl CertBuilder

pub fn new() -> Self

Returns a new CertBuilder.

The returned CertBuilder is setup to only create a certification-capable primary key using the default cipher suite. You'll almost certainly want to add subkeys (using CertBuilder::add_signing_subkey, or CertBuilder::add_transport_encryption_subkey, for instance), and user ids (using CertBuilder::add_userid).

pub fn general_purpose<C, U>(ciphersuite: C, userids: Option<U>) -> Self where
    C: Into<Option<CipherSuite>>,
    U: Into<UserID>, 

Generates a general-purpose key.

The key's primary key is certification- and signature-capable. The key has one subkey, an encryption-capable subkey.

pub fn autocrypt<'a, V, U>(version: V, userid: Option<U>) -> Self where
    V: Into<Option<Autocrypt>>,
    U: Into<UserID>, 

Generates a key compliant to Autocrypt.

If no version is given the latest one is used.

The autocrypt specification requires a UserID. However, because it can be useful to add the UserID later, it is permitted to be none.

pub fn set_cipher_suite(self, cs: CipherSuite) -> Self

Sets the encryption and signature algorithms for primary and all subkeys.

pub fn add_userid<'a, U>(self, uid: U) -> Self where
    U: Into<UserID>, 

Adds a new user ID. The first user ID added will be the primary user ID.

pub fn add_user_attribute<'a, U>(self, ua: U) -> Self where
    U: Into<UserAttribute>, 

Adds a new user attribute.

pub fn add_signing_subkey(self) -> Self

Adds a signing capable subkey.

pub fn add_transport_encryption_subkey(self) -> Self

Adds a subkey suitable for transport encryption.

pub fn add_storage_encryption_subkey(self) -> Self

Adds a subkey suitable for storage encryption.

pub fn add_certification_subkey(self) -> Self

Adds an certification capable subkey.

pub fn add_authentication_subkey(self) -> Self

Adds an authentication capable subkey.

pub fn add_subkey<T>(self, flags: KeyFlags, expiration: T) -> Self where
    T: Into<Option<Duration>>, 

Adds a custom subkey.

If expiration is None, the subkey uses the same expiration time as the primary key.

pub fn primary_keyflags(self, flags: KeyFlags) -> Self

Sets the capabilities of the primary key. The function automatically makes the primary key certification capable if subkeys are added.

pub fn set_password(self, password: Option<Password>) -> Self

Sets a password to encrypt the secret keys with.

pub fn set_expiration<T>(self, expiration: T) -> Self where
    T: Into<Option<Duration>>, 

Sets the expiration time.

A value of None means never.

pub fn generate(self) -> Result<(Cert, Signature)>

Generates the actual Cert.

Trait Implementations

impl Clone for CertBuilder

fn clone(&self) -> CertBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CertBuilder

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

Formats the value using the given formatter.