Struct SigningKey 

struct SigningKey<'a> {
    public_key: PublicKey,
    raw_signer: &'a dyn RawSigningKey,
}

PGP-adapter for a raw HSM key.

All PGP-related operations executed on objects of this type will be forwarded to the HSM instance.

Fields

public_key: PublicKey

raw_signer: &'a dyn RawSigningKey

Implementations

impl<'a> SigningKey<'a>

fn new(raw_signer: &'a dyn RawSigningKey, public_key: PublicKey) -> Self

Creates a new SigningKey from a RawSigningKey implementation and a [PublicKey].

fn new_provisioned(raw_signer: &'a dyn RawSigningKey) -> Result<Self, Error>

Creates a new SigningKey from a RawSigningKey implementation.

The RawSigningKey implementation is expected to already have a certificate setup for itself.

Errors

Returns an error if

• retrieval of the certificate from raw_signer fails
• parsing of the certificate retrieved fails
• the certificate is missing (Error::OpenPpgCertificateMissing)

Trait Implementations

impl Debug for SigningKey<'_>

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

Formats the value using the given formatter.

impl KeyDetails for SigningKey<'_>

fn version(&self) -> KeyVersion

fn fingerprint(&self) -> Fingerprint

fn key_id(&self) -> KeyId

fn algorithm(&self) -> PublicKeyAlgorithm

impl SecretKeyTrait for SigningKey<'_>

fn create_signature( &self, _key_pw: &Password, hash: HashAlgorithm, data: &[u8], ) -> Result<SignatureBytes>

Creates a data signature.

Note

If self targets an HSM, it is expected to be unlocked and configured with access to the signing key.

Using a [Password] is not necessary as the operation deals with unencrypted cryptographic key material.

Errors

Returns an error if

• the key uses unsupported parameters (e.g. brainpool curves),
• digest serialization fails (e.g. ASN1 encoding of digest for RSA signatures),
• RawSigningKey::sign call fails,
• parsing of signature returned from the HSM fails.

fn hash_alg(&self) -> HashAlgorithm

Returns the preferred hash algorithm for data digests.

Note

We always return SHA-512 as it is faster than SHA-256 on modern hardware and of sufficient size to accommodate all elliptic-curve algorithms.