Struct yubirs::piv::key::Key

pub struct Key<T: PcscHal> { /* fields omitted */ }

Key is an AbstractKey structure using a public/private key pair stored on a PC/SC hardware device. The idea is that we can use a hardware key for encryption / decryption, and thus can use it as a wrapping key in a KeyStore.

Methods

impl<T: PcscHal> Key<T>

pub fn new<P: AsRef<Path>>(
    reader: Option<&str>,
    pin: Option<&str>,
    slot: Key,
    public_key: P
) -> Result<Self>

Construct a new Key instance.

This requires instantiating a new PIV handle, with the given reader (if any), and using the given pin (if not specified, it will be prompted for instead) for authentication.

Encryption is done using the given public key file (in PEM format), and decryption is done using the private key stored in the given slot on the hardware device.

Trait Implementations

impl<T: PcscHal> AbstractKey for Key<T>

fn get_digest(&self) -> Digest

Return a digest/signature computed from this key.

fn encrypt(
    &self,
    plaintext: &[u8],
    nonce: Option<Nonce>
) -> Result<(Option<Nonce>, Vec<u8>), Error>

Encrypt the given plaintext with this key. This function optionally takes a nonce as an argument. If this key's encryption algorithm utilizes a nonce, the provided one will be used.

fn decrypt(
    &self,
    nonce: Option<&Nonce>,
    ciphertext: &[u8]
) -> Result<Vec<u8>, Error>

Decrypt the given ciphertext using this key and the nonce which was generated at encryption time (if any), returning the plaintext.