wasefire-board-api 0.10.0

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Cryptography interface.

#[cfg(feature = "internal-crypto-rng")]
use core::marker::PhantomData;

#[cfg(feature = "internal-api-crypto-hash")]
use crypto_common::BlockSizeUser;
#[cfg(any(feature = "internal-api-crypto-hash", feature = "internal-api-crypto-hmac"))]
use crypto_common::Output;
#[cfg(feature = "internal-api-crypto-hmac")]
use crypto_common::{InvalidLength, KeyInit};
#[cfg(feature = "internal-api-crypto-hash")]
use digest::HashMarker;
#[cfg(feature = "internal-api-crypto-hmac")]
use digest::MacMarker;
#[cfg(any(feature = "internal-api-crypto-hash", feature = "internal-api-crypto-hmac"))]
use digest::{FixedOutput, Update};
#[cfg(feature = "internal-crypto-rng")]
use signature::rand_core;
#[cfg(feature = "internal-api-crypto-hmac")]
use wasefire_error::Code;
#[cfg(feature = "internal-with-error")]
use wasefire_sync::TakeCell;

#[cfg(feature = "internal-with-error")]
use crate::Error;
#[cfg(any(feature = "internal-api-crypto-hash", feature = "internal-api-crypto-hmac"))]
use crate::Support;

#[cfg(feature = "internal-api-crypto-aead")]
pub mod aead;
#[cfg(feature = "internal-api-crypto-cbc")]
pub mod cbc;
#[cfg(feature = "internal-api-crypto-ecc")]
pub mod ecc;
#[cfg(feature = "internal-api-crypto-ecdh")]
pub mod ecdh;
#[cfg(feature = "internal-api-crypto-ecdsa")]
pub mod ecdsa;
#[cfg(feature = "api-crypto-ed25519")]
pub mod ed25519;

/// Cryptography interface.
pub trait Api: Send {
    /// AES-128-CCM interface.
    #[cfg(feature = "api-crypto-aes128-ccm")]
    type Aes128Ccm: aead::Api<typenum::U16, typenum::U13, Tag = typenum::U4>;

    /// AES-256-CBC interface.
    #[cfg(feature = "api-crypto-aes256-cbc")]
    type Aes256Cbc: cbc::Api<typenum::U32, typenum::U16>;

    /// AES-256-GCM interface.
    #[cfg(feature = "api-crypto-aes256-gcm")]
    type Aes256Gcm: aead::Api<typenum::U32, typenum::U12>;

    /// Ed25519 interface.
    #[cfg(feature = "api-crypto-ed25519")]
    type Ed25519: ed25519::Api;

    /// HMAC-SHA-256 interface.
    #[cfg(feature = "api-crypto-hmac-sha256")]
    type HmacSha256: Hmac<KeySize = typenum::U64, OutputSize = typenum::U32>;

    /// HMAC-SHA-384 interface.
    #[cfg(feature = "api-crypto-hmac-sha384")]
    type HmacSha384: Hmac<KeySize = typenum::U128, OutputSize = typenum::U48>;

    /// P-256 interface.
    #[cfg(feature = "api-crypto-p256")]
    type P256: ecc::Api<typenum::U32>;

    /// P-256 ECDH interface.
    #[cfg(feature = "api-crypto-p256-ecdh")]
    type P256Ecdh: ecdh::Api<32>;

    /// P-256 ECDSA interface.
    #[cfg(feature = "api-crypto-p256-ecdsa")]
    type P256Ecdsa: ecdsa::Api<32>;

    /// P-384 interface.
    #[cfg(feature = "api-crypto-p384")]
    type P384: ecc::Api<typenum::U48>;

    /// P-384 ECDH interface.
    #[cfg(feature = "api-crypto-p384-ecdh")]
    type P384Ecdh: ecdh::Api<48>;

    /// P-384 ECDSA interface.
    #[cfg(feature = "api-crypto-p384-ecdsa")]
    type P384Ecdsa: ecdsa::Api<48>;

    /// SHA-256 interface.
    #[cfg(feature = "api-crypto-sha256")]
    type Sha256: Hash<BlockSize = typenum::U64, OutputSize = typenum::U32>;

    /// SHA-384 interface.
    #[cfg(feature = "api-crypto-sha384")]
    type Sha384: Hash<BlockSize = typenum::U128, OutputSize = typenum::U48>;
}

/// Hash interface.
#[cfg(feature = "internal-api-crypto-hash")]
pub trait Hash:
    Support<bool> + Send + Default + BlockSizeUser + Update + FixedOutput + HashMarker + WithError
{
}
/// HMAC interface.
#[cfg(feature = "internal-api-crypto-hmac")]
pub trait Hmac:
    Support<bool> + Send + KeyInit + Update + FixedOutput + MacMarker + WithError
{
}

#[cfg(feature = "internal-api-crypto-hash")]
impl<T> Hash for T where T: Support<bool>
        + Send
        + Default
        + BlockSizeUser
        + Update
        + FixedOutput
        + HashMarker
        + WithError
{
}
#[cfg(feature = "internal-api-crypto-hmac")]
impl<T> Hmac for T where T: Support<bool> + Send + KeyInit + Update + FixedOutput + MacMarker + WithError
{}

/// Adds error support to operations with an infallible signature.
#[cfg(feature = "internal-with-error")]
pub trait WithError {
    /// Executes a seemingly infallible operation with error support.
    ///
    /// The closure may actually call multiple seemingly infaillible operations. Each such call
    /// should support running after a previous one failed. This funtion returns an error if any
    /// such call failed.
    fn with_error<T>(operation: impl FnOnce() -> T) -> Result<T, Error>;
}

/// Helper trait for infaillible operations.
#[cfg(feature = "internal-with-error")]
pub trait NoError {}

#[cfg(feature = "internal-with-error")]
impl<T: NoError> WithError for T {
    fn with_error<R>(operation: impl FnOnce() -> R) -> Result<R, Error> {
        Ok(operation())
    }
}

/// Helper struct to implement `WithError`.
#[cfg(feature = "internal-with-error")]
pub struct GlobalError(TakeCell<Result<(), Error>>);

#[cfg(feature = "internal-with-error")]
impl GlobalError {
    /// Creates an empty global error.
    #[allow(clippy::new_without_default)]
    pub const fn new() -> Self {
        GlobalError(TakeCell::new(None))
    }

    /// Helper to implement `with_error`.
    ///
    /// This will consume the global error if not empty.
    pub fn with<T>(&self, operation: impl FnOnce() -> T) -> Result<T, Error> {
        self.0.put(Ok(()));
        let result = operation();
        self.0.take().map(|()| result)
    }

    /// Records an error.
    ///
    /// This will overwrite any previous error that was not consumed yet.
    pub fn record<T>(&self, x: Result<T, Error>) -> Option<T> {
        x.inspect_err(|e| self.0.with(|x| *x = Err(*e))).ok()
    }
}

/// Helper to use the board RNG as a cryptography-secure one.
#[cfg(feature = "internal-crypto-rng")]
pub struct CryptoRng<T: crate::Api> {
    rng: PhantomData<crate::Rng<T>>,
}

#[cfg(feature = "internal-crypto-rng")]
impl<T: crate::Api> Default for CryptoRng<T> {
    fn default() -> Self {
        CryptoRng { rng: PhantomData }
    }
}

#[cfg(feature = "internal-crypto-rng")]
impl<T: crate::Api> rand_core::RngCore for CryptoRng<T> {
    fn next_u32(&mut self) -> u32 {
        rand_core::impls::next_u32_via_fill(self)
    }

    fn next_u64(&mut self) -> u64 {
        rand_core::impls::next_u64_via_fill(self)
    }

    fn fill_bytes(&mut self, dest: &mut [u8]) {
        self.try_fill_bytes(dest).unwrap()
    }

    fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), rand_core::Error> {
        ERROR
            .record(<crate::Rng<T> as crate::rng::Api>::fill_bytes(dest))
            .ok_or_else(|| core::num::NonZeroU32::new(1).unwrap().into())
    }
}

#[cfg(feature = "internal-crypto-rng")]
static ERROR: GlobalError = GlobalError::new();

#[cfg(feature = "internal-crypto-rng")]
impl<T: crate::Api> rand_core::CryptoRng for CryptoRng<T> {}

#[cfg(feature = "internal-crypto-rng")]
impl<T: crate::Api> WithError for CryptoRng<T> {
    fn with_error<R>(operation: impl FnOnce() -> R) -> Result<R, Error> {
        ERROR.with(operation)
    }
}

/// AES-128-CCM interface.
#[cfg(feature = "api-crypto-aes128-ccm")]
pub type Aes128Ccm<B> = <super::Crypto<B> as Api>::Aes128Ccm;

/// AES-256-CBC interface.
#[cfg(feature = "api-crypto-aes256-cbc")]
pub type Aes256Cbc<B> = <super::Crypto<B> as Api>::Aes256Cbc;

/// AES-256-GCM interface.
#[cfg(feature = "api-crypto-aes256-gcm")]
pub type Aes256Gcm<B> = <super::Crypto<B> as Api>::Aes256Gcm;

/// Ed25519 interface.
#[cfg(feature = "api-crypto-ed25519")]
pub type Ed25519<B> = <super::Crypto<B> as Api>::Ed25519;

/// HMAC-SHA-256 interface.
#[cfg(feature = "api-crypto-hmac-sha256")]
pub type HmacSha256<B> = <super::Crypto<B> as Api>::HmacSha256;

/// HMAC-SHA-384 interface.
#[cfg(feature = "api-crypto-hmac-sha384")]
pub type HmacSha384<B> = <super::Crypto<B> as Api>::HmacSha384;

/// P-256 interface.
#[cfg(feature = "api-crypto-p256")]
pub type P256<B> = <super::Crypto<B> as Api>::P256;

/// P-256 ECDH interface.
#[cfg(feature = "api-crypto-p256-ecdh")]
pub type P256Ecdh<B> = <super::Crypto<B> as Api>::P256Ecdh;

/// P-256 ECDSA interface.
#[cfg(feature = "api-crypto-p256-ecdsa")]
pub type P256Ecdsa<B> = <super::Crypto<B> as Api>::P256Ecdsa;

/// P-384 interface.
#[cfg(feature = "api-crypto-p384")]
pub type P384<B> = <super::Crypto<B> as Api>::P384;

/// P-384 ECDH interface.
#[cfg(feature = "api-crypto-p384-ecdh")]
pub type P384Ecdh<B> = <super::Crypto<B> as Api>::P384Ecdh;

/// P-384 ECDSA interface.
#[cfg(feature = "api-crypto-p384-ecdsa")]
pub type P384Ecdsa<B> = <super::Crypto<B> as Api>::P384Ecdsa;

/// SHA-256 interface.
#[cfg(feature = "api-crypto-sha256")]
pub type Sha256<B> = <super::Crypto<B> as Api>::Sha256;

/// SHA-384 interface.
#[cfg(feature = "api-crypto-sha384")]
pub type Sha384<B> = <super::Crypto<B> as Api>::Sha384;

/// AES-128-CCM interface.
#[cfg(feature = "software-crypto-aes128-ccm")]
pub type SoftwareAes128Ccm = ccm::Ccm<aes::Aes128, typenum::U4, typenum::U13>;

/// AES-256-CBC interface.
#[cfg(feature = "software-crypto-aes256-cbc")]
pub type SoftwareAes256Cbc = cbc::Software<aes::Aes256>;

/// AES-256-GCM interface.
#[cfg(feature = "software-crypto-aes256-gcm")]
pub type SoftwareAes256Gcm = aes_gcm::Aes256Gcm;

/// Ed25519 interface.
#[cfg(feature = "software-crypto-ed25519")]
pub type SoftwareEd25519<R> = ed25519::Software<R>;

/// HMAC-SHA-256 interface.
#[cfg(feature = "software-crypto-hmac-sha256")]
pub type SoftwareHmacSha256<T> = hmac::SimpleHmac<<T as Api>::Sha256>;

/// HMAC-SHA-384 interface.
#[cfg(feature = "software-crypto-hmac-sha384")]
pub type SoftwareHmacSha384<T> = hmac::SimpleHmac<<T as Api>::Sha384>;

/// P-256 interface.
#[cfg(feature = "software-crypto-p256")]
pub type SoftwareP256<T> = ecc::Software<p256::NistP256, <T as Api>::Sha256>;

/// P-256 ECDH interface.
#[cfg(feature = "software-crypto-p256-ecdh")]
pub type SoftwareP256Ecdh<R> = ecdh::Software<p256::NistP256, R, 32>;

/// P-256 ECDSA interface.
#[cfg(feature = "software-crypto-p256-ecdsa")]
pub type SoftwareP256Ecdsa<T, R> = ecdsa::Software<p256::NistP256, <T as Api>::Sha256, R, 32>;

/// P-384 interface.
#[cfg(feature = "software-crypto-p384")]
pub type SoftwareP384<T> = ecc::Software<p384::NistP384, <T as Api>::Sha384>;

/// P-384 ECDH interface.
#[cfg(feature = "software-crypto-p384-ecdh")]
pub type SoftwareP384Ecdh<R> = ecdh::Software<p384::NistP384, R, 48>;

/// P-384 ECDSA interface.
#[cfg(feature = "software-crypto-p384-ecdsa")]
pub type SoftwareP384Ecdsa<T, R> = ecdsa::Software<p384::NistP384, <T as Api>::Sha384, R, 48>;

/// SHA-256 interface.
#[cfg(feature = "software-crypto-sha256")]
pub type SoftwareSha256 = sha2::Sha256;

/// SHA-384 interface.
#[cfg(feature = "software-crypto-sha384")]
pub type SoftwareSha384 = sha2::Sha384;

#[cfg(feature = "internal-test-software-crypto")]
mod _test_software_crypto {
    use super::*;

    macro_rules! test {
        ($Type:ident $($Param:ident)* $([$($where:tt)*])?; $Final:path) => {
            #[allow(dead_code, non_snake_case)]
            fn $Type<$($Param),*>() $(where $($where)*)? {
                fn assert<T: $Final>() {}
                assert::<$Type<$($Param),*>>();
            }
        };
    }

    #[cfg(feature = "software-crypto-aes128-ccm")]
    test!(SoftwareAes128Ccm; aead::Api<typenum::U16, typenum::U13, Tag = typenum::U4>);
    #[cfg(feature = "software-crypto-aes256-cbc")]
    test!(SoftwareAes256Cbc; cbc::Api<typenum::U32, typenum::U16>);
    #[cfg(feature = "software-crypto-aes256-gcm")]
    test!(SoftwareAes256Gcm; aead::Api<typenum::U32, typenum::U12>);
    #[cfg(feature = "software-crypto-ed25519")]
    test!(SoftwareEd25519 R [R: Default + rand_core::CryptoRngCore + WithError + Send];
          ed25519::Api);
    #[cfg(feature = "software-crypto-hmac-sha256")]
    test!(SoftwareHmacSha256 T [T: Api]; Hmac<KeySize = typenum::U64, OutputSize = typenum::U32>);
    #[cfg(feature = "software-crypto-hmac-sha384")]
    test!(SoftwareHmacSha384 T [T: Api]; Hmac<KeySize = typenum::U128, OutputSize = typenum::U48>);
    #[cfg(feature = "software-crypto-p256")]
    test!(SoftwareP256 T [T: Api, T::Sha256: digest::FixedOutputReset]; ecc::Api<typenum::U32>);
    #[cfg(feature = "software-crypto-p256-ecdh")]
    test!(SoftwareP256Ecdh R [R: Default + rand_core::CryptoRngCore + WithError + Send];
          ecdh::Api<32>);
    #[cfg(feature = "software-crypto-p256-ecdsa")]
    test!(SoftwareP256Ecdsa T R [T: Api, T::Sha256: digest::FixedOutputReset,
                                 R: Default + rand_core::CryptoRngCore + WithError + Send];
          ecdsa::Api<32>);
    #[cfg(feature = "software-crypto-p384")]
    test!(SoftwareP384 T [T: Api, T::Sha384: digest::FixedOutputReset]; ecc::Api<typenum::U48>);
    #[cfg(feature = "software-crypto-p384-ecdh")]
    test!(SoftwareP384Ecdh R [R: Default + rand_core::CryptoRngCore + WithError + Send];
          ecdh::Api<48>);
    #[cfg(feature = "software-crypto-p384-ecdsa")]
    test!(SoftwareP384Ecdsa T R [T: Api, T::Sha384: digest::FixedOutputReset,
                                 R: Default + rand_core::CryptoRngCore + WithError + Send];
          ecdsa::Api<48>);
    #[cfg(feature = "software-crypto-sha256")]
    test!(SoftwareSha256[]; Hash<BlockSize = typenum::U64, OutputSize = typenum::U32>);
    #[cfg(feature = "software-crypto-sha384")]
    test!(SoftwareSha384[]; Hash<BlockSize = typenum::U128, OutputSize = typenum::U48>);
}

#[cfg(feature = "software-crypto-sha256")]
impl crate::Supported for sha2::Sha256 {}

#[cfg(feature = "software-crypto-sha384")]
impl crate::Supported for sha2::Sha384 {}

#[cfg(feature = "internal-software-crypto-hmac")]
impl<D> Support<bool> for hmac::SimpleHmac<D>
where D: Support<bool> + Default + BlockSizeUser + Update + FixedOutput + HashMarker + WithError
{
    const SUPPORT: bool = D::SUPPORT;
}

#[cfg(feature = "software-crypto-sha256")]
impl NoError for sha2::Sha256 {}

#[cfg(feature = "software-crypto-sha384")]
impl NoError for sha2::Sha384 {}

#[cfg(feature = "internal-software-crypto-hmac")]
impl<D> WithError for hmac::SimpleHmac<D>
where D: Support<bool> + Default + BlockSizeUser + Update + FixedOutput + HashMarker + WithError
{
    fn with_error<T>(operation: impl FnOnce() -> T) -> Result<T, Error> {
        D::with_error(operation)
    }
}

/// Hash wrapper with error support.
#[cfg(feature = "internal-api-crypto-hash")]
pub struct HashApi<T: Hash>(T);

/// HMAC wrapper with error support.
#[cfg(feature = "internal-api-crypto-hmac")]
pub struct HmacApi<T: Hmac>(T);

#[cfg(feature = "internal-api-crypto-hash")]
impl<T: Hash> HashApi<T> {
    /// Creates a hash wrapper.
    pub fn new() -> Result<Self, Error> {
        T::with_error(|| T::default()).map(HashApi)
    }

    /// Updates the hash with the provided data.
    pub fn update(&mut self, data: &[u8]) -> Result<(), Error> {
        T::with_error(|| self.0.update(data))
    }

    /// Finalizes the hash to the provided output.
    pub fn finalize_into(self, out: &mut Output<T>) -> Result<(), Error> {
        T::with_error(|| self.0.finalize_into(out))
    }
}

#[cfg(feature = "internal-api-crypto-hmac")]
impl<T: Hmac> HmacApi<T> {
    /// Creates an HMAC wrapper.
    pub fn new(key: &[u8]) -> Result<Self, Error> {
        match T::with_error(|| T::new_from_slice(key)) {
            Ok(Ok(x)) => Ok(HmacApi(x)),
            Ok(Err(InvalidLength)) => Err(Error::user(Code::InvalidLength)),
            Err(e) => Err(e),
        }
    }

    /// Updates the HMAC with the provided data.
    pub fn update(&mut self, data: &[u8]) -> Result<(), Error> {
        T::with_error(|| self.0.update(data))
    }

    /// Finalizes the HMAC to the provided output.
    pub fn finalize_into(self, out: &mut Output<T>) -> Result<(), Error> {
        T::with_error(|| self.0.finalize_into(out))
    }
}