Struct tor_keymgr::KeyMgr

pub struct KeyMgr { /* private fields */ }

Available on crate feature keymgr only.

A key manager with several Keystores.

Note: KeyMgr is a low-level utility and does not implement caching (the key stores are accessed for every read/write).

Implementations

impl KeyMgr

pub fn new( default_store: impl Keystore, key_stores: Vec<Box<dyn Keystore>> ) -> Self

Create a new KeyMgr with a default Keystore and zero or more secondary Keystores.

pub fn get<K: ToEncodableKey>( &self, key_spec: &dyn KeySpecifier ) -> Result<Option<K>>

Read a key from one of the key stores, and try to deserialize it as K::Key.

The key returned is retrieved from the first key store that contains an entry for the given specifier.

Returns Ok(None) if none of the key stores have the requested key.

pub fn generate<K: ToEncodableKey>( &self, key_spec: &dyn KeySpecifier, selector: KeystoreSelector<'_>, rng: &mut dyn KeygenRng, overwrite: bool ) -> Result<Option<()>>

Generate a new key of type K, and insert it into the key store specified by selector.

If the key already exists in the specified key store, the overwrite flag is used to decide whether to overwrite it with a newly generated key.

Returns Ok(Some(()) if a new key was created, and Ok(None) otherwise.

IMPORTANT: using this function concurrently with any other KeyMgr operation that mutates the key store state is not recommended, as it can yield surprising results! The outcome of KeyMgr::generate depends on whether the selected key store contains the specified key, and thus suffers from a a TOCTOU race.

pub fn insert<K: ToEncodableKey>( &self, key: K, key_spec: &dyn KeySpecifier, selector: KeystoreSelector<'_> ) -> Result<()>

Insert key into the Keystore specified by selector.

If the key already exists, it is overwritten.

pub fn remove<K: ToEncodableKey>( &self, key_spec: &dyn KeySpecifier, selector: KeystoreSelector<'_> ) -> Result<Option<()>>

Remove the key identified by key_spec from the Keystore specified by selector.

Returns Ok(None) if the key does not exist in the requested keystore. Returns Ok(Some(()) if the key was successfully removed.

Returns Err if an error occurred while trying to remove the key.