Struct CTorServiceKeystore 

pub struct CTorServiceKeystore {
    keystore: CTorKeystore,
    nickname: HsNickname,
}

Available on crate features keymgr and ctor-keystore only.

A read-only C Tor service keystore.

This keystore provides read-only access to the hidden service keys rooted at a given HiddenServiceDirectory directory (see HiddenServiceDirectory in tor(1)).

This keystore can be used to read the HiddenServiceDirectory/private_key and HiddenServiceDirectory/public_key C Tor keys, specified by CTorServicePath::PrivateKey (with KeyType::Ed25519ExpandedKeypair) and CTorServicePath::PublicKey (with KeyType::Ed25519PublicKey), respectively. Any other files stored in HiddenServiceDirectory 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 key. If the requested CTorPath is not Service, or if the [HsNickname] specified in the CTorPath does not match the nickname of this store, the key will be declared not found. If the requested CTorPath is Service, but the ItemType and CTorServicePath are mismatched, an error is returned.

Fields

keystore: CTorKeystore

The underlying keystore

nickname: HsNickname

The nickname of the service this keystore is meant for

Implementations

impl CTorServiceKeystore

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

Create a new CTorServiceKeystore 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.

Trait Implementations

impl Keystore for CTorServiceKeystore

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 raw_entry_id(&self, raw_id: &str) -> Result<RawEntryId>

Available on crate feature onion-service-cli-extra only.

Convert the specified string to a RawEntryId that represents the raw unique identifier of an entry in this keystore.

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 remove_unchecked(&self, _entry_id: &RawEntryId) -> Result<()>

Available on crate feature onion-service-cli-extra only.

Remove the specified keystore entry.

fn list(&self) -> Result<Vec<KeystoreEntryResult<KeystoreEntry<'_>>>>

List all the entries in this keystore.