Struct YubiHsm2SigningKey 

pub struct YubiHsm2SigningKey {
    yubihsm: Client,
    key_id: Id,
}

A signing key stored in the YubiHSM.

Fields

yubihsm: Client

key_id: Id

Implementations

impl YubiHsm2SigningKey

pub fn mock(key_id: u16, credentials: &Credentials) -> Result<Self, Error>

Returns a signing key emulated in software.

Warning

The signing key created by this function should be used only for tests as the signing material is exposed in memory!

Errors

When automatic provisioning of the emulator fails this function can return Error.

Panics

This function panics if certificate generation fails.

pub fn new_with_serial_number( serial_number: &str, key_id: u16, credentials: &Credentials, ) -> Result<Self, Error>

Returns a new YubiHsm2SigningKey backed by specific YubiHSM2 hardware.

The hardware is identified using its serial_number and the key is addressed by its key_id.

Errors

If the communication with the device fails or the authentication data is incorrect this function will return an Error.

Trait Implementations

impl Debug for YubiHsm2SigningKey

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

Formats the value using the given formatter.

impl RawSigningKey for YubiHsm2SigningKey

fn key_id(&self) -> String

Returns the internal key identifier formatted as a String.

fn sign(&self, digest: &[u8]) -> Result<Vec<Vec<u8>>, SignerError>

Signs a raw digest.

The digest is without any framing and the result will be a vector of raw signature parts.

Errors

If the operation fails the implementation returns a signstar_crypto::signer::error::Error::Hsm, which wraps the client-specific HSM error in its source field.

fn certificate(&self) -> Result<Option<Vec<u8>>, SignerError>

Returns certificate bytes associated with this signing key, if any.

This interface does not interpret the certificate in any way but has a notion of certificate being set or unset.

Errors

If the operation fails the implementation returns a SignerError::Hsm, which wraps the client-specific HSM error in its source field.

fn public(&self) -> Result<RawPublicKey, SignerError>

Returns raw public parts of this signing key.

Implementation of this trait implies that the signing key exists and as such always has public parts. The public key is used for generating application-specific certificates.

Errors

If the operation fails the implementation returns a SignerError::Hsm, which wraps the client-specific HSM error in its source field.