Struct ContextCache 

pub struct ContextCache<'a> {
    pub handles: HashMap<u32, TpmHandle>,
    pub writer: &'a mut dyn Write,
    pub contexts: HashMap<String, Vec<u8>>,
    pub session_map: SessionCache,
    /* private fields */
}

Fields

handles: HashMap<u32, TpmHandle>

writer: &'a mut dyn Write

contexts: HashMap<String, Vec<u8>>

session_map: SessionCache

Implementations

impl<'a> ContextCache<'a>

pub fn teardown(&mut self, device: Option<Rc<RefCell<Device>>>)

Flushes transient handles and saves dirty contexts, printing errors to stderr.

pub fn execute<C: TpmCommandObject>( &mut self, device: &mut Device, command: &C, handles: &[u32], auths: &[Auth], ) -> Result<(TpmResponseBody, TpmAuthResponses), ContextError>

Executes a TPM command with full authorization session handling.

This function encapsulates the prepare, build, execute, and teardown sequence for authorized commands.

Errors

Returns a ContextError if any stage of the session management or command execution fails.

pub fn new( device: Option<&mut Device>, cache_dir: &Path, writer: &'a mut dyn Write, session_map: SessionCache, ) -> Result<ContextCache<'a>, ContextError>

Creates a new Context, loads and refreshes saved contexts from disk.

Errors

Returns a ContextError if loading or refreshing contexts fails.

pub fn loaded_contexts( &self, device: Rc<RefCell<Device>>, ) -> ContextIterator<'_>

Creates an iterator that loads each saved context and yields a Context guard.

pub fn remove_context(&mut self, grip: &str) -> Result<(), ContextError>

Removes a context from the cache.

Errors

Returns an I/O error if the context file cannot be removed from disk.

pub fn reset(&mut self) -> Result<(), ContextError>

Deletes all cached contexts from disk and memory.

Errors

Returns an I/O error if any context file cannot be removed.

pub fn new_context( &mut self, device: &mut Device, handle: TpmHandle, name: &Tpm2bName, ) -> Result<(), ContextError>

Creates and saves a new managed transient context.

Errors

Returns an error if the TPM context cannot be saved or if the new context cannot be written to the writer.

pub fn mark_dirty(&mut self, grip: String)

Marks a saved context as needing to be written to disk.

pub fn cache_dir(&self) -> &Path

pub fn import_key( &mut self, device: &mut Device, parent_handle: TpmHandle, input_bytes: &[u8], auths: &[Auth], ) -> Result<TpmKey, ContextError>

Imports an external key under a TPM parent, creating a new TpmKey.

Errors

Returns an error if the TPM import operation fails.

pub fn load_context_from_bytes( &mut self, device: &mut Device, blob: &[u8], ) -> Result<(TpmHandle, Tpm2bName), ContextError>

Loads a TPM context from a byte slice.

Errors

Returns a ContextError on parsing or TPM command failure.

pub fn load_parent( &mut self, device: &mut Device, uri: &Uri, ) -> Result<TpmHandle, ContextError>

Validates a URI for a parent object and loads its context.

Errors

Returns an error if the URI is not a valid parent type (tpm:// or key://) or if context loading fails.

pub fn load_context( &mut self, device: &mut Device, uri: &Uri, ) -> Result<TpmHandle, ContextError>

Loads a TPM context from a URI.

If the URI points to a transient context, the context is loaded into the TPM and its handle is tracked for automatic cleanup. Persistent handles from tpm:// URIs are returned directly and are not tracked.

Errors

Returns a ContextError on parsing or TPM command failure.

pub fn delete( &mut self, device: &mut Device, uri: &Uri, auths: &[Auth], ) -> Result<u32, ContextError>

Deletes a persistent or transient object by URI.

Errors

Returns a ContextError if the handle is invalid or the delete operation fails.

pub fn track(&mut self, handle: TpmHandle) -> Result<(), ContextError>

Tracks a transient handle for automatic cleanup at the end of execution.

Errors

Returns a ContextError if the handle is invalid or does not exist.

pub fn untrack(&mut self, handle: u32)

Removes a handle from the automatic cleanup list.

pub fn flush(&mut self, device: &mut Device) -> Result<(), ContextError>

Flushes all tracked transient handles out of the TPM device.

Errors

Returns ContextError if the device mutex is poisoned or if flushing a handle fails. It returns the first error encountered.

pub fn write_key_data( &mut self, output_uri: Option<&Uri>, key: &TpmKey, ) -> Result<(), ContextError>

Handles the output of a TpmKey, choosing PEM or DER format based on the URI.

Errors

Returns a ContextError on failure.

pub fn write_data( &mut self, output_uri: Option<&Uri>, data: &[u8], ) -> Result<(), ContextError>

Writes data to a file path or stdout.

Errors

This function will return an error if writing to a file fails.

pub fn read_certificate( &mut self, device: &mut Device, auths: &[Auth], handle: u32, max_read_size: usize, ) -> Result<Option<Vec<u8>>, ContextError>

Reads a certificate from a given NV index.

Errors

Returns a ContextError if the TPM commands fail or if the response is invalid.

pub fn evict_key( &mut self, device: &mut Device, transient_handle: TpmHandle, persistent_handle: TpmHandle, auths: &[Auth], ) -> Result<(), ContextError>

Makes a transient key persistent.

Errors

Returns a ContextError if the transient handle is not being tracked by the context, or if the underlying TPM2_EvictControl command fails.

Trait Implementations

impl Debug for ContextCache<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.