Trait sequoia_openpgp::crypto::Signer

pub trait Signer {
    // Required methods
    fn public(&self) -> &Key<PublicParts, UnspecifiedRole>;
    fn sign(
        &mut self,
        hash_algo: HashAlgorithm,
        digest: &[u8],
    ) -> Result<Signature>;

    // Provided method
    fn acceptable_hashes(&self) -> &[HashAlgorithm] { ... }
}

Creates a signature.

Used in the streaming Signer, the methods binding components to certificates (e.g. UserID::bind), SignatureBuilder’s signing functions (e.g. SignatureBuilder::sign_standalone), and likely many more places.

This is a low-level mechanism to produce an arbitrary OpenPGP signature. Using this trait allows Sequoia to perform all operations involving signing to use a variety of secret key storage mechanisms (e.g. smart cards).

A signer consists of the public key and a way of creating a signature. This crate implements Signer for KeyPair, which is a tuple containing the public and unencrypted secret key in memory. Other crates may provide their own implementations of Signer to utilize keys stored in various places. Currently, the following implementations exist:

• KeyPair: In-memory keys.
• sequoia_rpc::gnupg::KeyPair: Connects to the gpg-agent.

Required Methods

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.

Provided Methods

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

Returns a list of hashes that this signer accepts.

Some cryptographic libraries or hardware modules support signing digests produced with only a limited set of hashing algorithms. This function indicates to callers which algorithm digests are supported by this signer.

The default implementation of this function allows all hash algorithms to be used. Provide an explicit implementation only when a smaller subset of hashing algorithms is valid for this Signer implementation.

Trait Implementations

impl Signer for Box<dyn Signer>

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

Returns a reference to the public key.

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

Returns a list of hashes that this signer accepts.

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

Creates a signature over the digest produced by hash_algo.

impl Signer for Box<dyn Signer + Send + Sync>

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

Returns a reference to the public key.

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

Returns a list of hashes that this signer accepts.

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

Creates a signature over the digest produced by hash_algo.

Implementations on Foreign Types

impl Signer for Box<dyn Signer + Send + Sync>

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

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

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

impl Signer for Box<dyn Signer>

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

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

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

Implementors

impl Signer for KeyPair