[][src]Struct minisign::KeyPair

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

A key pair (PublicKey and SecretKey).

Fields

pk: PublicKeysk: SecretKey

Methods

impl KeyPair[src]

pub fn generate_unencrypted_keypair() -> Result<Self>[src]

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>[src]

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
[src]

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
[src]

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[src]

impl Debug for KeyPair[src]

Auto Trait Implementations

impl RefUnwindSafe for KeyPair

impl Send for KeyPair

impl Sync for KeyPair

impl Unpin for KeyPair

impl UnwindSafe for KeyPair

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> Same<T> for T

type Output = T

Should always be Self

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.