Struct SessionCache 

pub struct SessionCache {
    pub sessions: HashMap<String, Session>,
    pub dirty: HashSet<String>,
    pub sessions_dir: PathBuf,
}

Fields

sessions: HashMap<String, Session>

dirty: HashSet<String>

sessions_dir: PathBuf

Implementations

impl SessionCache

pub fn new(cache_dir: &Path) -> Self

Creates a new, empty SessionMap.

pub fn load_sessions(&mut self) -> Result<(), SessionError>

Populates the session map by reading all available session files from the cache directory.

Errors

Returns SessionError on I/O failure.

pub fn refresh_sessions( &mut self, device: &mut Device, ) -> Result<(), SessionError>

Validates all sessions at startup, and removes expired sessions from the previous power cycle.

Errors

Returns an aggregate DeviceError if any non-recoverable errors occur. Individual session failures are logged as warnings.

pub fn save(&mut self) -> Result<(), SessionError>

Saves all sessions marked as dirty to their respective files.

Errors

Returns an error on serialization or I/O failure.

pub fn add(&mut self, session: Session) -> String

Adds a new session and returns its URI.

pub fn remove(&mut self, uri: &str) -> Result<Option<Session>, SessionError>

Removes a session from the map and deletes its file from disk. This operation is idempotent.

Errors

Returns SessionError on I/O failure (e.g. permissions).

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

Removes all sessions from the map and deletes their files from disk.

Errors

Returns SessionError::Io on I/O failure.

pub fn get(&self, uri: &str) -> Result<&Session, SessionError>

Gets an immutable reference to a session.

Errors

Returns SessionError::NotFound if no session is found.

pub fn get_mut(&mut self, uri: &str) -> Result<&mut Session, SessionError>

Gets a mutable reference to a session, marks it as dirty.

Errors

Returns SessionError::NotFound if no session is found.

pub fn iter(&self) -> Iter<'_, String, Session>

Returns an iterator over the sessions.

pub fn prepare_sessions( &mut self, device: &mut Device, auth_list: &[Auth], ) -> Result<Vec<u32>, SessionError>

Loads session contexts if they are not already active.

Errors

Returns a SessionError if a session URI is invalid or if loading a TPM context fails.

pub fn build_auth_area<C: TpmCommandObject>( &self, device: &mut Device, command: &C, handles: &[u32], auth_list: &[Auth], ) -> Result<(Vec<TpmsAuthCommand>, Vec<u32>), SessionError>

Builds the authorization area for a command.

Errors

Returns a SessionError if a session URI is not found, or if building any part of the authorization command fails.

pub fn teardown_sessions( &mut self, device: &mut Device, session_handles: &[u32], auth_responses: &TpmAuthResponses, ) -> Result<(), SessionError>

Finalizes sessions after a command executes.

Errors

Returns a SessionError if a session URI is not found, or if saving/flushing the updated TPM context fails.

Trait Implementations

impl Debug for SessionCache

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a SessionCache

type Item = (&'a String, &'a Session)

The type of the elements being iterated over.

type IntoIter = Iter<'a, String, Session>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.