Improves handling size_t FFI values.

- The size_t type that is used in all the MU APIs will be dependent on the compiler that ```bindgen``` uses to generate the bindings for the library. This attempts to make the crate less dependant on that value in the public APIs. - Changes the Marshall and Unmarshall traits to use usize as input. - Removed the ```private_in_public``` it is 'warn by default' and because documentation ci is run with ```-Dwarnings``` it will cause the lint to be enforced. Signed-off-by: Jesper Brynolf <[email protected]>
Superhepper · Nov 17, 2023 · 50f24ac · 50f24ac
1 parent 29b7278
commit 50f24ac
Show file tree

Hide file tree

Showing 16 changed files with 250 additions and 706 deletions.
diff --git a/tss-esapi/Cargo.toml b/tss-esapi/Cargo.toml
@@ -32,6 +32,7 @@ picky-asn1-x509 = { version = "0.12.0", optional = true }
 cfg-if = "1.0.0"
 strum = { version = "0.25.0", optional = true }
 strum_macros = { version = "0.25.0", optional = true }
+paste = "1.0.14"
 
 [dev-dependencies]
 env_logger = "0.9.0"

diff --git a/tss-esapi/src/constants/command_code.rs b/tss-esapi/src/constants/command_code.rs
@@ -2,15 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 mod structure;
 
-use crate::{
-    traits::{Marshall, UnMarshall},
-    tss2_esys::TPM2_CC,
-    Error, Result, ReturnCode, WrapperErrorKind,
-};
+use crate::{traits::impl_mu_simple, tss2_esys::TPM2_CC, Error, Result, WrapperErrorKind};
 use log::error;
 use num_derive::{FromPrimitive, ToPrimitive};
 use num_traits::{FromPrimitive, ToPrimitive};
-use std::convert::{TryFrom, TryInto};
+use std::convert::TryFrom;
 use structure::CommandCodeStructure;
 
 /// Enum representing the command code constants.
@@ -155,56 +151,4 @@ impl From<CommandCode> for TPM2_CC {
     }
 }
 
-impl Marshall for CommandCode {
-    const BUFFER_SIZE: usize = std::mem::size_of::<TPM2_CC>();
-
-    fn marshall_offset(
-        &self,
-        marshalled_data: &mut [u8],
-        offset: &mut std::os::raw::c_ulong,
-    ) -> Result<()> {
-        ReturnCode::ensure_success(
-            unsafe {
-                crate::tss2_esys::Tss2_MU_TPM2_CC_Marshal(
-                    (*self).into(),
-                    marshalled_data.as_mut_ptr(),
-                    marshalled_data.len().try_into().map_err(|e| {
-                        error!("Failed to convert size of buffer to TSS size_t type: {}", e);
-                        Error::local_error(WrapperErrorKind::InvalidParam)
-                    })?,
-                    offset,
-                )
-            },
-            |ret| {
-                error!("Failed to marshal CommandCode: {}", ret);
-            },
-        )?;
-        Ok(())
-    }
-}
-
-impl UnMarshall for CommandCode {
-    fn unmarshall_offset(
-        marshalled_data: &[u8],
-        offset: &mut std::os::raw::c_ulong,
-    ) -> Result<Self> {
-        let mut dest = TPM2_CC::default();
-
-        ReturnCode::ensure_success(
-            unsafe {
-                crate::tss2_esys::Tss2_MU_TPM2_CC_Unmarshal(
-                    marshalled_data.as_ptr(),
-                    marshalled_data.len().try_into().map_err(|e| {
-                        error!("Failed to convert length of marshalled data: {}", e);
-                        Error::local_error(WrapperErrorKind::InvalidParam)
-                    })?,
-                    offset,
-                    &mut dest,
-                )
-            },
-            |ret| error!("Failed to unmarshal SensitiveCreate: {}", ret),
-        )?;
-
-        CommandCode::try_from(dest)
-    }
-}
+impl_mu_simple!(CommandCode, TPM2_CC);
diff --git a/tss-esapi/src/ffi.rs b/tss-esapi/src/ffi.rs
@@ -1,11 +1,12 @@
 // Copyright 2022 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
 
-pub(crate) mod data_zeroize;
+pub mod data_zeroize;
 
-use crate::ffi::data_zeroize::FfiDataZeroize;
+use crate::{ffi::data_zeroize::FfiDataZeroize, Error, Result, WrapperErrorKind};
+use log::error;
 use mbox::MBox;
-use std::ops::Deref;
+use std::{convert::TryFrom, ops::Deref};
 
 /// Function that takes ownership of data that has been
 /// allocated with C memory allocation functions in TSS while also
@@ -26,7 +27,61 @@ where
     owned_ffi_data
 }
 
-pub(crate) fn to_owned_bytes(ffi_bytes_ptr: *mut u8, size: usize) -> Vec<u8> {
+/// Function that takes ownership of bytes that are stored in a
+/// buffer that has been allocated with C memory allocation functions in TSS.
+///
+/// # Arguments
+/// * `ffi_bytes_ptr` - A pointer to the FFI buffer.
+/// * `size`          - The number of bytes to read from the buffer.
+///
+/// # Returns
+/// The owned bytes in the form of a `Vec<u8>` object.
+pub fn to_owned_bytes(ffi_bytes_ptr: *mut u8, size: usize) -> Vec<u8> {
     let ffi_bytes = unsafe { MBox::<[u8]>::from_raw_parts(ffi_bytes_ptr, size) };
     return Vec::<u8>::from(ffi_bytes.as_ref());
 }
+
+/// Type used for handling `size_t` variables
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+pub struct FfiSizeType(crate::tss2_esys::size_t);
+
+impl FfiSizeType {
+    /// Returns an unsafe mutable pointer to the `size_t` value.
+    pub(crate) fn as_mut_ptr(&mut self) -> *mut crate::tss2_esys::size_t {
+        &mut self.0
+    }
+}
+
+impl From<crate::tss2_esys::size_t> for FfiSizeType {
+    fn from(value: crate::tss2_esys::size_t) -> Self {
+        Self(value)
+    }
+}
+
+impl From<FfiSizeType> for crate::tss2_esys::size_t {
+    fn from(ffi: FfiSizeType) -> crate::tss2_esys::size_t {
+        ffi.0
+    }
+}
+
+impl TryFrom<usize> for FfiSizeType {
+    type Error = Error;
+    fn try_from(native: usize) -> Result<Self> {
+        crate::tss2_esys::size_t::try_from(native)
+            .map(FfiSizeType)
+            .map_err(|err| {
+                error!("Failed to convert `usize` to `size_t`: {}", err);
+                Error::local_error(WrapperErrorKind::UnsupportedParam)
+            })
+    }
+}
+
+impl TryFrom<FfiSizeType> for usize {
+    type Error = Error;
+    fn try_from(ffi: FfiSizeType) -> Result<usize> {
+        usize::try_from(ffi.0).map_err(|err| {
+            error!("Failed to convert `size_t` to `usize`: {}", err);
+            Error::local_error(WrapperErrorKind::UnsupportedParam)
+        })
+    }
+}
diff --git a/tss-esapi/src/interface_types/structure_tags.rs b/tss-esapi/src/interface_types/structure_tags.rs
@@ -1,16 +1,13 @@
 // Copyright 2021 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
 
-use log::error;
 use tss_esapi_sys::TPMI_ST_COMMAND_TAG;
 
 use crate::{
-    constants::StructureTag,
-    traits::{Marshall, UnMarshall},
-    tss2_esys::TPMI_ST_ATTEST,
-    Error, Result, ReturnCode, WrapperErrorKind,
+    constants::StructureTag, traits::impl_mu_simple, tss2_esys::TPMI_ST_ATTEST, Error, Result,
+    WrapperErrorKind,
 };
-use std::convert::{TryFrom, TryInto};
+use std::convert::TryFrom;
 
 /// Type of attestation.
 ///
@@ -75,60 +72,7 @@ impl TryFrom<TPMI_ST_ATTEST> for AttestationType {
     }
 }
 
-impl Marshall for AttestationType {
-    const BUFFER_SIZE: usize = std::mem::size_of::<TPMI_ST_ATTEST>();
-
-    fn marshall_offset(
-        &self,
-        marshalled_data: &mut [u8],
-        offset: &mut std::os::raw::c_ulong,
-    ) -> Result<()> {
-        ReturnCode::ensure_success(
-            unsafe {
-                crate::tss2_esys::Tss2_MU_TPM2_ST_Marshal(
-                    (*self).into(),
-                    marshalled_data.as_mut_ptr(),
-                    marshalled_data.len().try_into().map_err(|e| {
-                        error!("Failed to convert size of buffer to TSS size_t type: {}", e);
-                        Error::local_error(WrapperErrorKind::InvalidParam)
-                    })?,
-                    offset,
-                )
-            },
-            |ret| {
-                error!("Failed to marshal AttestationType: {}", ret);
-            },
-        )?;
-
-        Ok(())
-    }
-}
-
-impl UnMarshall for AttestationType {
-    fn unmarshall_offset(
-        marshalled_data: &[u8],
-        offset: &mut std::os::raw::c_ulong,
-    ) -> Result<Self> {
-        let mut dest = TPMI_ST_ATTEST::default();
-
-        ReturnCode::ensure_success(
-            unsafe {
-                crate::tss2_esys::Tss2_MU_TPM2_ST_Unmarshal(
-                    marshalled_data.as_ptr(),
-                    marshalled_data.len().try_into().map_err(|e| {
-                        error!("Failed to convert length of marshalled data: {}", e);
-                        Error::local_error(WrapperErrorKind::InvalidParam)
-                    })?,
-                    offset,
-                    &mut dest,
-                )
-            },
-            |ret| error!("Failed to unmarshal AttestationType: {}", ret),
-        )?;
-
-        AttestationType::try_from(dest)
-    }
-}
+impl_mu_simple!(AttestationType, TPMI_ST_ATTEST, TPM2_ST);
 
 /// Type of command tag.
 ///
@@ -175,57 +119,4 @@ impl TryFrom<TPMI_ST_COMMAND_TAG> for CommandTag {
     }
 }
 
-impl Marshall for CommandTag {
-    const BUFFER_SIZE: usize = std::mem::size_of::<TPMI_ST_COMMAND_TAG>();
-
-    fn marshall_offset(
-        &self,
-        marshalled_data: &mut [u8],
-        offset: &mut std::os::raw::c_ulong,
-    ) -> Result<()> {
-        ReturnCode::ensure_success(
-            unsafe {
-                crate::tss2_esys::Tss2_MU_TPM2_ST_Marshal(
-                    (*self).into(),
-                    marshalled_data.as_mut_ptr(),
-                    marshalled_data.len().try_into().map_err(|e| {
-                        error!("Failed to convert size of buffer to TSS size_t type: {}", e);
-                        Error::local_error(WrapperErrorKind::InvalidParam)
-                    })?,
-                    offset,
-                )
-            },
-            |ret| {
-                error!("Failed to marshal CommandTag: {}", ret);
-            },
-        )?;
-
-        Ok(())
-    }
-}
-
-impl UnMarshall for CommandTag {
-    fn unmarshall_offset(
-        marshalled_data: &[u8],
-        offset: &mut std::os::raw::c_ulong,
-    ) -> Result<Self> {
-        let mut dest = TPMI_ST_COMMAND_TAG::default();
-
-        ReturnCode::ensure_success(
-            unsafe {
-                crate::tss2_esys::Tss2_MU_TPM2_ST_Unmarshal(
-                    marshalled_data.as_ptr(),
-                    marshalled_data.len().try_into().map_err(|e| {
-                        error!("Failed to convert length of marshalled data: {}", e);
-                        Error::local_error(WrapperErrorKind::InvalidParam)
-                    })?,
-                    offset,
-                    &mut dest,
-                )
-            },
-            |ret| error!("Failed to unmarshal CommandTag: {}", ret),
-        )?;
-
-        CommandTag::try_from(dest)
-    }
-}
+impl_mu_simple!(CommandTag, TPMI_ST_COMMAND_TAG, TPM2_ST);
diff --git a/tss-esapi/src/lib.rs b/tss-esapi/src/lib.rs
@@ -9,7 +9,8 @@
     overflowing_literals,
     path_statements,
     patterns_in_fns_without_body,
-    private_in_public,
+    private_bounds,
+    private_interfaces,
     unconditional_recursion,
     unused,
     unused_allocation,
@@ -28,6 +29,7 @@
     missing_copy_implementations,
     rustdoc::broken_intra_doc_links,
 )]
+
 //! # TSS 2.0 Rust Wrapper over Enhanced System API
 //! This crate exposes the functionality of the TCG Software Stack Enhanced System API to
 //! Rust developers, both directly through FFI bindings and through more Rust-tailored interfaces

diff --git a/tss-esapi/src/macros/mod.rs b/tss-esapi/src/macros/mod.rs