Struct KeyPair

pub struct KeyPair {
    pub pk: PublicKey,
    pub sk: SecretKey,
}

A key pair (PublicKey and SecretKey).

Fields

pk: PublicKey

sk: SecretKey

Implementations

impl KeyPair

pub fn generate_unencrypted_keypair() -> Result<Self>

Create an unencrypted key pair.

The secret key will not be protected by a password.

This is not recommended and incompatible with other implementations, but can be necessary if using a password is really not an option for your application.

You generally want to use generated_encrypted_keypair() instead.

pub fn generate_encrypted_keypair(password: Option<String>) -> Result<Self>

Create and encrypt a new key pair.

If password is None, a password will be interactively asked for.

A key can be converted to a box in order to be serialized and saved. Ex: pk.to_box()?.to_bytes()

pub fn generate_and_write_encrypted_keypair<W, X>( pk_writer: W, sk_writer: X, comment: Option<&str>, password: Option<String>, ) -> Result<Self>

where W: Write, X: Write,

Create, encrypt and save a new key pair.

Arguments

• pk_writer - Where to store the public key box.
• sk_writer - Where to store the secret key box.
• comment - An optional untrusted comment to replace the default one.
• password - If None, a password will be interactively asked for.

pub fn generate_and_write_unencrypted_keypair<W, X>( pk_writer: W, sk_writer: X, ) -> Result<Self>

where W: Write, X: Write,

Create and save an unencrypted key pair.

The secret key will not be protected by a password, and keys will be stored as raw bytes, not as a box.

This is not recommended and incompatible with other implementations, but can be necessary if using a password is not an option for your application.

You generally want to use generated_encrypted_keypair() instead.

Arguments

• pk_writer - Where to store the public key box.
• sk_writer - Where to store the secret key box.

Trait Implementations

impl Clone for KeyPair

fn clone(&self) -> KeyPair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPair

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

Formats the value using the given formatter.