Struct CTorClientKeystore

pub struct CTorClientKeystore(CTorKeystore);

Available on crate features keymgr and ctor-keystore only.

A read-only C Tor client keystore.

This keystore provides read-only access to the client restricted discovery keys rooted at a given ClientOnionAuthDir directory (see ClientOnionAuthDir in tor(1)).

The key files must be in the <hsid>:descriptor:x25519:<base32-encoded-x25519-public-key> format and have the .auth_private extension. Invalid keys, and keys that don’t have the expected extension, will be ignored.

The only supported Keystore operations are contains, get, and list. All other keystore operations will return an error.

This keystore implementation uses the CTorPath of the requested KeySpecifier and the [KeystoreItemType] to identify the appropriate restricted discovery keypair. If the requested CTorPath is not ClientHsDescEncKey, the keystore will declare the key not found. If the requested CTorPath is ClientHsDescEncKey, but the KeystoreItemType is not X25519StaticKeypair, an error is returned.

Tuple Fields

0: CTorKeystore

Implementations

impl CTorClientKeystore

pub fn from_path_and_mistrust( keystore_dir: impl AsRef<Path>, mistrust: &Mistrust, id: KeystoreId, ) -> Result<Self>

Create a new CTorKeystore rooted at the specified keystore_dir directory.

This function returns an error if keystore_dir is not a directory, or if it does not conform to the requirements of the specified Mistrust.

impl CTorClientKeystore

fn list_entries(&self, dir: &RelKeyPath<'_>) -> Result<ReadDir>

List all the key entries in the keystore_dir.

impl CTorClientKeystore

fn read_key( &self, key_path: &Path, ) -> StdResult<Option<String>, CTorKeystoreError>

Read the contents of the specified key.

Returns Ok(None) if the file doesn’t exist.

fn list_keys( &self, ) -> Result<impl Iterator<Item = StdResult<(HsId, HsClientDescEncKeypair), CTorKeystoreError>> + '_>

List all entries in this store

Returns a list of results, where Ok signifies a recognized entry, and Err(CTorKeystoreError) an unrecognized one. A key is said to be recognized if its file name ends with .auth_private, and it presents this format: <hsid>:descriptor:x25519:<base32-encoded-x25519-public-key>

Trait Implementations

impl Keystore for CTorClientKeystore

fn id(&self) -> &KeystoreId

An identifier for this key store instance.

fn contains( &self, key_spec: &dyn KeySpecifier, item_type: &KeystoreItemType, ) -> Result<bool>

Check if the key identified by key_spec exists in this key store.

fn get( &self, key_spec: &dyn KeySpecifier, item_type: &KeystoreItemType, ) -> Result<Option<ErasedKey>>

Retrieve the key identified by key_spec.

fn insert( &self, _key: &dyn EncodableItem, _key_spec: &dyn KeySpecifier, ) -> Result<()>

Write key to the key store.

fn remove( &self, _key_spec: &dyn KeySpecifier, _item_type: &KeystoreItemType, ) -> Result<Option<()>>

Remove the specified key.

fn list(&self) -> Result<Vec<KeystoreEntryResult<(KeyPath, KeystoreItemType)>>>

List all the entries in this keystore.