Struct radicle_keystore::file::FileStorage

pub struct FileStorage<C, PK, SK, M> { /* private fields */ }

Keystore implementation which stores the encrypted key in a file on the local filesystem.

Implementations

impl<C, PK, SK, M> FileStorage<C, PK, SK, M>

pub fn new(key_file_path: &Path, crypto: C) -> Self

Construct a new FileStorage with the given Crypto implementation.

The Path given by key_file_path must be an actual file path, not a directory.

pub fn key_file_path(&self) -> &Path

Path to the file where the encrypted key is stored.

Trait Implementations

impl<C: Clone, PK: Clone, SK: Clone, M: Clone> Clone for FileStorage<C, PK, SK, M>

fn clone(&self) -> FileStorage<C, PK, SK, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C, PK, SK, M> Keystore for FileStorage<C, PK, SK, M> where
    C: Crypto,
    C::Error: Display + Debug,
    C::SecretBox: Serialize + DeserializeOwned,
    SK: AsRef<[u8]> + SecretKeyExt<Metadata = M>,
    <SK as SecretKeyExt>::Error: Display + Debug,
    PK: Clone + From<SK> + Serialize + DeserializeOwned,
    M: Clone + Serialize + DeserializeOwned, 

type PublicKey = PK

type SecretKey = SK

type Metadata = M

type Error = Error<C::Error, <SK as SecretKeyExt>::Error>

fn put_key(&mut self, key: Self::SecretKey) -> Result<(), Self::Error>

Securely store secret key key in the keystore.

fn get_key(
    &self
) -> Result<Keypair<Self::PublicKey, Self::SecretKey>, Self::Error>

Retrieve both the secret and public parts of the stored key material.

fn show_key(&self) -> Result<(Self::PublicKey, Self::Metadata), Self::Error>

Retrieve only the public part of the key material, along with any metadata.