Struct sequoia_gpg_agent::KeyPair

pub struct KeyPair { /* private fields */ }

A cryptographic key pair.

A KeyPair is a combination of public and secret key. This particular implementation does not have the secret key, but diverges the cryptographic operations to gpg-agent.

This provides a convenient, synchronous interface for use with the low-level Sequoia crate.

Implementations

impl KeyPair

pub fn new_for_gnupg_context<R>( ctx: &Context, key: &Key<PublicParts, R> ) -> Result<KeyPair>

where R: KeyRole,

Returns a KeyPair for key with the secret bits managed by the agent.

This provides a convenient, synchronous interface for use with the low-level Sequoia crate.

pub fn new_for_socket<P, R>( agent_socket: P, key: &Key<PublicParts, R> ) -> Result<KeyPair>

where P: AsRef<Path>, R: KeyRole,

Returns a KeyPair for key with the secret bits managed by the agent.

If you have a Agent, then you should create a KeyPair using Agent::keypair.

pub fn with_cert(self, cert: &ValidCert<'_>) -> Self

Changes the password prompt to include information about the cert.

Use this function to give more context to the user when she is prompted for a password. This function will generate a prompt that is very similar to the prompts that GnuPG generates.

To set an arbitrary password prompt, use KeyPair::with_password_prompt.

pub fn with_password(self, password: Password) -> Self

Supplies a password to unlock the secret key.

This will be used when the secret key operation is performed, e.g. when signing or decrypting a message.

Note: This is the equivalent of GnuPG’s --pinentry-mode=loopback and requires explicit opt-in in the gpg-agent configuration using the allow-loopback-pinentry option. If this is not enabled in the agent, the secret key operation will fail. It is likely only useful during testing.

pub fn set_pinentry_mode(self, mode: PinentryMode) -> Self

Overrides the pinentry mode.

pub fn suppress_pinentry(self) -> Self

Disables gpg’s pinentry.

Changes the pinentry mode to PinEntryMode::Error, which configures the agent to not ask for a password.

pub fn with_password_prompt(self, prompt: String) -> Self

Changes the password prompt.

Use this function to give more context to the user when she is prompted for a password.

To set an password prompt that uses information from the OpenPGP certificate, use KeyPair::with_cert.

impl KeyPair

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

Signs a message.

An async implementation of sequoia_openpgp::crypto::Signer::sign.

impl KeyPair

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

Decrypts a message.

An async implementation of sequoia_openpgp::crypto::Decryptor::decrypt.

Trait Implementations

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