tss-esapi 8.0.0-alpha

Rust-native wrapper around TSS 2.0 Enhanced System API
// Copyright 2022 Contributors to the Parsec project.
// SPDX-License-Identifier: Apache-2.0
use crate::{
    structures::SensitiveCreate,
    traits::{impl_mu_complex, Marshall, UnMarshall},
    tss2_esys::{TPM2B_SENSITIVE_CREATE, TPMS_SENSITIVE_CREATE},
    Error, Result, WrapperErrorKind,
};
use log::error;
use std::{
    convert::{TryFrom, TryInto},
    ops::Deref,
};
use zeroize::{Zeroize, ZeroizeOnDrop};

/// The [SensitiveCreate] buffer type.
///
/// # Details
/// The SensitiveCreateBuffer contains [SensitiveCreate] in marshalled
/// form. It can be unmarshalled into [SensitiveCreate] or [TPM2B_SENSITIVE_CREATE].
/// structure.
#[derive(Debug, Clone, PartialEq, Eq, Zeroize, ZeroizeOnDrop)]
pub struct SensitiveCreateBuffer(Vec<u8>);

impl SensitiveCreateBuffer {
    pub const MAX_SIZE: usize = std::mem::size_of::<TPMS_SENSITIVE_CREATE>();
    pub const MIN_SIZE: usize = 4;

    /// Returns the content of the buffer.
    pub fn value(&self) -> &[u8] {
        &self.0
    }

    /// Private function for ensuring that a buffer size is valid.
    fn ensure_valid_buffer_size(buffer_size: usize, container_name: &str) -> Result<()> {
        if (Self::MIN_SIZE..=Self::MAX_SIZE).contains(&buffer_size) {
            Ok(())
        } else {
            error!(
                "Error: Invalid {} size ({} >= {} >= {})",
                container_name,
                Self::MAX_SIZE,
                buffer_size,
                Self::MIN_SIZE,
            );
            Err(Error::local_error(WrapperErrorKind::WrongParamSize))
        }
    }
}

impl Deref for SensitiveCreateBuffer {
    type Target = Vec<u8>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl TryFrom<Vec<u8>> for SensitiveCreateBuffer {
    type Error = Error;

    fn try_from(bytes: Vec<u8>) -> Result<Self> {
        Self::ensure_valid_buffer_size(bytes.len(), "Vec<u8>")?;
        Ok(SensitiveCreateBuffer(bytes))
    }
}

impl TryFrom<&[u8]> for SensitiveCreateBuffer {
    type Error = Error;

    fn try_from(bytes: &[u8]) -> Result<Self> {
        Self::ensure_valid_buffer_size(bytes.len(), "&[u8]")?;
        Ok(SensitiveCreateBuffer(bytes.to_vec()))
    }
}

impl TryFrom<TPM2B_SENSITIVE_CREATE> for SensitiveCreateBuffer {
    type Error = Error;

    fn try_from(tss: TPM2B_SENSITIVE_CREATE) -> Result<Self> {
        Self::ensure_valid_buffer_size(tss.size as usize, "buffer")?;
        SensitiveCreate::try_from(tss.sensitive)
            .and_then(|sensitive_create| sensitive_create.marshall())
            .map(SensitiveCreateBuffer)
    }
}

impl TryFrom<SensitiveCreateBuffer> for TPM2B_SENSITIVE_CREATE {
    type Error = Error;

    fn try_from(native: SensitiveCreateBuffer) -> Result<Self> {
        SensitiveCreate::unmarshall(&native.0).map(|sensitive_create| TPM2B_SENSITIVE_CREATE {
            size: native.0.len() as u16,
            sensitive: sensitive_create.into(),
        })
    }
}

impl TryFrom<SensitiveCreateBuffer> for SensitiveCreate {
    type Error = Error;

    fn try_from(buf: SensitiveCreateBuffer) -> Result<Self> {
        SensitiveCreate::unmarshall(&buf.0)
    }
}

impl TryFrom<SensitiveCreate> for SensitiveCreateBuffer {
    type Error = Error;

    fn try_from(sensitve_create: SensitiveCreate) -> Result<SensitiveCreateBuffer> {
        Ok(SensitiveCreateBuffer(sensitve_create.marshall()?))
    }
}

impl_mu_complex!(SensitiveCreateBuffer, TPM2B_SENSITIVE_CREATE);