Struct FilesystemKeyStore 

pub struct FilesystemKeyStore {
    pub keys_directory: PathBuf,
}

Available on crate feature std only.

A filesystem-based keystore that stores keys in separate files and provides transaction authentication functionality. The public key is hashed and the result is used as the filename and the contents of the file are the serialized public and secret key.

Fields

keys_directory: PathBuf

The directory where the keys are stored and read from.

Implementations

impl FilesystemKeyStore

pub fn new(keys_directory: PathBuf) -> Result<Self, KeyStoreError>

Creates a FilesystemKeyStore on a specific directory.

pub fn add_key(&self, key: &AuthSecretKey) -> Result<(), KeyStoreError>

Adds a secret key to the keystore.

pub fn remove_key( &self, pub_key: PublicKeyCommitment, ) -> Result<(), KeyStoreError>

Removes a secret key from the keystore, given the commitment of a public key.

pub fn get_key( &self, pub_key: PublicKeyCommitment, ) -> Result<Option<AuthSecretKey>, KeyStoreError>

Retrieves a secret key from the keystore given the commitment of a public key.

Trait Implementations

impl Clone for FilesystemKeyStore

fn clone(&self) -> FilesystemKeyStore

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FilesystemKeyStore

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

Formats the value using the given formatter.

impl TransactionAuthenticator for FilesystemKeyStore

async fn get_signature( &self, pub_key: PublicKeyCommitment, signing_info: &SigningInputs, ) -> Result<Signature, AuthenticationError>

Gets a signature over a message, given a public key.

The public key should correspond to one of the keys tracked by the keystore.

Errors

If the public key isn’t found in the store, AuthenticationError::UnknownPublicKey is returned.

async fn get_public_key( &self, _pub_key_commitment: PublicKeyCommitment, ) -> Option<&PublicKey>

Retrieves a public key for a specific public key commitment.