Struct sequoia_openpgp::crypto::KeyPair

pub struct KeyPair { /* private fields */ }

A cryptographic key pair.

A KeyPair is a combination of public and secret key. If both are available in memory, a KeyPair is a convenient implementation of Signer and Decryptor.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Curve;
use openpgp::cert::prelude::*;
use openpgp::packet::prelude::*;

// Conveniently create a KeyPair from a bare key:
let keypair =
    Key4::<_, key::UnspecifiedRole>::generate_ecc(false, Curve::Cv25519)?
        .into_keypair()?;

// Or from a query over a certificate:
let (cert, _) =
    CertBuilder::general_purpose(None, Some("alice@example.org"))
        .generate()?;
let keypair =
    cert.keys().unencrypted_secret().nth(0).unwrap().key().clone()
        .into_keypair()?;

Implementations

impl KeyPair

pub fn new(
    public: Key<PublicParts, UnspecifiedRole>,
    secret: Unencrypted
) -> Result<Self>

Creates a new key pair.

pub fn public(&self) -> &Key<PublicParts, UnspecifiedRole>

Returns a reference to the public key.

pub fn secret(&self) -> &Unencrypted

Returns a reference to the secret key.

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 Decryptor for KeyPair

fn public(&self) -> &Key<PublicParts, UnspecifiedRole>

Returns a reference to the public key.

fn decrypt(
    &mut self,
    ciphertext: &Ciphertext,
    plaintext_len: Option<usize>
) -> Result<SessionKey>

Decrypts ciphertext, returning the plain session key.

impl From<KeyPair> for Key<SecretParts, UnspecifiedRole>

fn from(p: KeyPair) -> Self

Converts to this type from the input type.

impl Signer for KeyPair

fn public(&self) -> &Key<PublicParts, UnspecifiedRole>

Returns a reference to the public key.

fn sign(&mut self, hash_algo: HashAlgorithm, digest: &[u8]) -> Result<Signature>

Creates a signature over the digest produced by hash_algo.

fn acceptable_hashes(&self) -> &[HashAlgorithm]

Returns a list of hashes that this signer accepts.