yubihsm 0.20.0

//! `YubiHSM2` authentication keys (2 * AES-128 symmetric PSK) from which session keys are derived

use crate::error::Error;
#[cfg(feature = "hmac")]
use hmac::Hmac;
#[cfg(feature = "pbkdf2")]
use pbkdf2::pbkdf2;
use rand_os::{rand_core::RngCore, OsRng};
#[cfg(feature = "sha2")]
use sha2::Sha256;
use std::fmt::{self, Debug};
use zeroize::Zeroize;

/// Auth keys are 2 * AES-128 keys
pub const AUTHENTICATION_KEY_SIZE: usize = 32;

/// Password from which the default auth key is derived
pub const DEFAULT_PASSWORD: &[u8] = b"password";

/// Salt value to use with PBKDF2 when deriving auth keys from a password.
/// This salt is designed to be compatible with the password functionality in
/// yubihsm-shell (otherwise using a static salt is not best practice).
pub const DEFAULT_PBKDF2_SALT: &[u8] = b"Yubico";

/// Number of PBKDF2 iterations to perform when deriving auth keys.
/// This number of iterations matches what is performed by yubihsm-shell.
pub const DEFAULT_PBKDF2_ITERATIONS: usize = 10_000;

/// `YubiHSM2` authentication keys (2 * AES-128 symmetric PSK) from which
/// session keys are derived.c
#[derive(Clone)]
pub struct AuthenticationKey(pub(crate) [u8; AUTHENTICATION_KEY_SIZE]);

impl AuthenticationKey {
    /// Generate a random `AuthenticationKey` using `OsRng`.
    pub fn random() -> Self {
        let mut rng = OsRng::new().expect("RNG failure!");
        let mut challenge = [0u8; AUTHENTICATION_KEY_SIZE];
        rng.fill_bytes(&mut challenge);
        AuthenticationKey(challenge)
    }

    /// Derive an auth key from a password (using PBKDF2 + static salt).
    /// This method is designed to be compatible with yubihsm-shell. Ensure
    /// you use a long, random password when using this method as the key
    /// derivation algorithm used does little to prevent brute force attacks.
    #[cfg(feature = "passwords")]
    pub fn derive_from_password(password: &[u8]) -> Self {
        let mut kdf_output = [0u8; AUTHENTICATION_KEY_SIZE];
        pbkdf2::<Hmac<Sha256>>(
            password,
            DEFAULT_PBKDF2_SALT,
            DEFAULT_PBKDF2_ITERATIONS,
            &mut kdf_output,
        );
        Self::new(kdf_output)
    }

    /// Create an AuthenticationKey from a 32-byte slice, returning an error if the key
    /// is the wrong length
    pub fn from_slice(key_slice: &[u8]) -> Result<Self, AuthenticationKeyError> {
        ensure!(
            key_slice.len() == AUTHENTICATION_KEY_SIZE,
            AuthenticationKeyErrorKind::SizeInvalid,
            "expected {}-byte key, got {}",
            AUTHENTICATION_KEY_SIZE,
            key_slice.len()
        );

        let mut key_bytes = [0u8; AUTHENTICATION_KEY_SIZE];
        key_bytes.copy_from_slice(key_slice);

        Ok(AuthenticationKey(key_bytes))
    }

    /// Create a new AuthenticationKey from the given byte array
    pub fn new(key_bytes: [u8; AUTHENTICATION_KEY_SIZE]) -> Self {
        AuthenticationKey(key_bytes)
    }

    /// Borrow the secret authentication keys
    pub fn as_secret_slice(&self) -> &[u8] {
        &self.0
    }

    /// Obtain the encryption key portion of this auth key
    pub(crate) fn enc_key(&self) -> &[u8] {
        &self.0[..16]
    }

    /// Obtain the MAC key portion of this auth key
    pub(crate) fn mac_key(&self) -> &[u8] {
        &self.0[16..]
    }
}

impl Debug for AuthenticationKey {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        // Avoid leaking secrets in debug messages
        write!(f, "yubihsm::AuthenticationKey(...)")
    }
}

/// Derive the default authentication key for all YubiHSM2s
#[cfg(feature = "passwords")]
impl Default for AuthenticationKey {
    fn default() -> Self {
        AuthenticationKey::derive_from_password(DEFAULT_PASSWORD)
    }
}

impl Drop for AuthenticationKey {
    fn drop(&mut self) {
        self.0.zeroize();
    }
}

impl From<[u8; AUTHENTICATION_KEY_SIZE]> for AuthenticationKey {
    fn from(key_bytes: [u8; AUTHENTICATION_KEY_SIZE]) -> AuthenticationKey {
        AuthenticationKey::new(key_bytes)
    }
}

impl_array_serializers!(AuthenticationKey, AUTHENTICATION_KEY_SIZE);

/// `AuthenticationKey`-related errors
pub type AuthenticationKeyError = Error<AuthenticationKeyErrorKind>;

/// Kinds of `AuthenticationKey`-related errors
#[derive(Copy, Clone, Eq, PartialEq, Debug, Fail)]
pub enum AuthenticationKeyErrorKind {
    /// Size is invalid
    #[fail(display = "invalid size")]
    SizeInvalid,
}