Test cases for functions 'write_authorize_nv' and 'get_poll_handles()' have been added.

Author: danieltrick

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [0.13.0] - 2026-03-19
+
+### Added
+
+- Test cases for functions `write_authorize_nv` and `get_poll_handles()` have been added.
+- New error code `InternalError::NotImplemented` has been added.
+
+### Changed
+
+- Docker images used for testing/building have been updated to the latest version.
+
 ## [0.12.2] - 2026-03-03
 
 ### Changed

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "tss2-fapi-rs"
-version = "0.12.2"
+version = "0.13.0"
 edition = "2024"
 rust-version = "1.85"
 description = "Provides a Rust interface to the TSS2.0 Feature API (FAPI)"

Cargo.toml

@@ -24,8 +24,14 @@ const ERR_INVALID_ARGUMENTS: ErrorCode = ErrorCode::InternalError(InternalError:
 
 /* Opaque ContextBlob type  */
 #[derive(Debug)]
+#[non_exhaustive]
 pub struct TctiOpaqueContextBlob(pub *mut c_void);
 
+/* Opaque ContextBlob type  */
+#[derive(Debug)]
+#[non_exhaustive]
+pub struct FapiPollHandle(pub *mut c_void);
+
 /// Wraps the native `FAPI_CONTEXT` and exposes the related FAPI functions.
 ///
 /// Each FAPI context represents a logically independent connection to the TPM. It stores meta data information about object in order to calculate session auths and similar things.
@@ -928,8 +934,8 @@ impl FapiContext {
     /// This functions is a stub. Currently, `Fapi_GetPollHandles()` is **not** implemented in the Rust wrapper library!
     ///
     /// </div>
-    pub fn get_poll_handles(&mut self) -> Result<Vec<()>, ErrorCode> {
-        todo!("Not implemented yet.");
+    pub fn get_poll_handles(&mut self) -> Result<Vec<FapiPollHandle>, ErrorCode> {
+        Err(ErrorCode::InternalError(InternalError::NotImplemented))
     }
 
     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

src/context.rs

@@ -217,6 +217,7 @@ pub enum Tpm2Warning {
 pub enum InternalError {
     NoResultData,
     InvalidArguments,
+    NotImplemented,
 }
 
 impl ErrorCode {

src/error.rs

@@ -88,7 +88,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! tss2-fapi-rs = "0.12.2"
+//! tss2-fapi-rs = "0.13.0"
 //! ```
 //!
 //! **Note:** Please also consider the [prerequisites](#prerequisites) that are required to use the `tss2-fapi-rs` library!

src/lib.rs

@@ -24,6 +24,7 @@ use std::{fs, path::Path};
 use tss2_fapi_rs::{FapiCallbacks, FapiContext, ImportData, KeyFlags, json::JsonValue};
 
 const KEY_FLAGS_SIGN: &[KeyFlags] = &[KeyFlags::NoDA, KeyFlags::Sign];
+const POLICY_NV_AUTH_SIZE: usize = 34usize;
 
 // ==========================================================================
 // Test cases
@@ -44,7 +45,6 @@ fn test_policy_signed_rsa() {
         let mut rng = ChaChaRng::from_seed(create_seed(i));
 
         // Create FAPI context
-
         let mut context = match FapiContext::new() {
             Ok(fpai_ctx) => fpai_ctx,
             Err(error) => panic!("Failed to create context: {:?}", error),
@@ -255,6 +255,49 @@ fn test_policy_action() {
     });
 }
 
+/// Test the `write_authorize_nv()` function to write a policy digest to an NV index.
+#[test]
+#[serial]
+#[named]
+fn test_write_authorize_nv() {
+    let configuration = TestConfiguration::with_finalizer(|| my_tpm_finalizer(PASSWORD));
+
+    repeat_test!(|i| {
+        let nv_path = &format!("nv/Owner/pol_digest{}", i);
+        let pol_name = &format!("/policy/pol_signed_rsa{}", i);
+
+        // Create FAPI context
+        let mut context = match FapiContext::new() {
+            Ok(fpai_ctx) => fpai_ctx,
+            Err(error) => panic!("Failed to create context: {:?}", error),
+        };
+
+        // Read policy from file
+        let policy_json = read_policy(configuration.data_path(), "pol_signed_rsa").expect("Failed to read policy!");
+
+        // Initialize TPM, if not already initialized
+        tpm_initialize!(context, PASSWORD, MyCallbacks::new(PASSWORD, None));
+
+        // Import policy
+        match context.import(pol_name, ImportData::from_json(&policy_json).unwrap()) {
+            Ok(_) => debug!("Policy imported."),
+            Err(error) => panic!("Failed to import policy: {:?}", error),
+        };
+
+        // Create NV index, if not already created
+        match context.create_nv(nv_path, Some(&[tss2_fapi_rs::NvFlags::NoDA]), POLICY_NV_AUTH_SIZE, None, None) {
+            Ok(_) => debug!("NV index created."),
+            Err(error) => panic!("NV index creation has failed: {:?}", error),
+        }
+
+        // Write the policy digest to NV index
+        match context.write_authorize_nv(nv_path, pol_name) {
+            Ok(_) => debug!("Policy digest has been written to NV index."),
+            Err(error) => panic!("Writing the policy digest failed: {:?}", error),
+        }
+    });
+}
+
 // ==========================================================================
 // Helper functions
 // ==========================================================================

tests/09_policy_test.rs

@@ -0,0 +1,39 @@
+/* SPDX-License-Identifier: BSD-3-Clause */
+/***********************************************************************************************
+ * Copyright 2024-2026 Fraunhofer SIT, sponsored by the ELISA and ProSeCA research projects.
+ * All rights reserved.
+ **********************************************************************************************/
+
+pub mod common;
+
+use common::{callback::MyCallbacks, param::PASSWORD, setup::TestConfiguration, utils::my_tpm_finalizer};
+use function_name::named;
+use serial_test::serial;
+use tss2_fapi_rs::{ErrorCode, FapiContext, InternalError};
+
+// ==========================================================================
+// Test cases
+// ==========================================================================
+
+/// Test the `get_poll_handles()` function (which is **not** currently implemented)
+#[test]
+#[serial]
+#[named]
+fn test_get_poll_handles() {
+    let _configuration = TestConfiguration::with_finalizer(|| my_tpm_finalizer(PASSWORD));
+
+    repeat_test!(|_i| {
+        // Create FAPI context
+        let mut context = match FapiContext::new() {
+            Ok(fpai_ctx) => fpai_ctx,
+            Err(error) => panic!("Failed to create context: {:?}", error),
+        };
+
+        // Initialize TPM, if not already initialized
+        tpm_initialize!(context, PASSWORD, MyCallbacks::new(PASSWORD, None));
+
+        // Try to acquire the poll handles (this is expected to fail!)
+        let result = context.get_poll_handles();
+        assert!(matches!(result, Err(ErrorCode::InternalError(InternalError::NotImplemented))));
+    });
+}