Struct diem_secure_storage::Namespaced
source · pub struct Namespaced<S> { /* private fields */ }Expand description
This provides a light wrapper around KV storages to support a namespace. That namespace is effectively prefixing all keys with then namespace value and “/” so a namespace of foo and a key of bar becomes “foo/bar”. Without a namespace, the key would just be “bar”.
Implementations§
source§impl<S> Namespaced<S>
impl<S> Namespaced<S>
source§impl<'a, S> Namespaced<&'a S>where
S: KVStorage,
impl<'a, S> Namespaced<&'a S>where S: KVStorage,
sourcepub fn get<T: DeserializeOwned>(
&self,
key: &str
) -> Result<GetResponse<T>, Error>
pub fn get<T: DeserializeOwned>( &self, key: &str ) -> Result<GetResponse<T>, Error>
This is a small hack in order to allow for calling KVStorage::get from a Namespaced created
from an &S and not an S
Trait Implementations§
source§impl<S: CryptoStorage> CryptoStorage for Namespaced<S>
impl<S: CryptoStorage> CryptoStorage for Namespaced<S>
source§fn create_key(&mut self, name: &str) -> Result<Ed25519PublicKey, Error>
fn create_key(&mut self, name: &str) -> Result<Ed25519PublicKey, Error>
Securely generates a new named Ed25519 private key. The behavior for calling this interface
multiple times with the same name is implementation specific.
source§fn export_private_key(&self, name: &str) -> Result<Ed25519PrivateKey, Error>
fn export_private_key(&self, name: &str) -> Result<Ed25519PrivateKey, Error>
Returns the Ed25519 private key stored at ‘name’.
source§fn import_private_key(
&mut self,
name: &str,
key: Ed25519PrivateKey
) -> Result<(), Error>
fn import_private_key( &mut self, name: &str, key: Ed25519PrivateKey ) -> Result<(), Error>
An optional API that allows importing private keys and storing them at the provided name.
This is not intended to be used in production and the API may throw unimplemented if
not used correctly. As this is purely a testing API, there is no defined behavior for
importing a key for a given name if that name already exists. It only exists to allow
Diem to be run in test environments where a set of deterministic keys must be generated.
source§fn export_private_key_for_version(
&self,
name: &str,
version: Ed25519PublicKey
) -> Result<Ed25519PrivateKey, Error>
fn export_private_key_for_version( &self, name: &str, version: Ed25519PublicKey ) -> Result<Ed25519PrivateKey, Error>
Returns the Ed25519 private key stored at ‘name’ and identified by ‘version’, which is the
corresponding public key. This may fail even if the ‘named’ key exists but the version is
not present.
source§fn get_public_key(&self, name: &str) -> Result<PublicKeyResponse, Error>
fn get_public_key(&self, name: &str) -> Result<PublicKeyResponse, Error>
Returns the Ed25519 public key stored at ‘name’.
source§fn get_public_key_previous_version(
&self,
name: &str
) -> Result<Ed25519PublicKey, Error>
fn get_public_key_previous_version( &self, name: &str ) -> Result<Ed25519PublicKey, Error>
Returns the previous version of the Ed25519 public key stored at ‘name’. For the most recent
version, see ‘get_public_key(..)’ above.
source§fn rotate_key(&mut self, name: &str) -> Result<Ed25519PublicKey, Error>
fn rotate_key(&mut self, name: &str) -> Result<Ed25519PublicKey, Error>
Rotates an Ed25519 private key. Future calls without version to this ‘named’ key will
return the rotated key instance. The previous key is retained and can be accessed via
the version. At most two versions are expected to be retained.
source§fn sign<T: CryptoHash + Serialize>(
&self,
name: &str,
message: &T
) -> Result<Ed25519Signature, Error>
fn sign<T: CryptoHash + Serialize>( &self, name: &str, message: &T ) -> Result<Ed25519Signature, Error>
Signs the provided securely-hashable struct, using the ‘named’ private
key.
source§fn sign_using_version<T: CryptoHash + Serialize>(
&self,
name: &str,
version: Ed25519PublicKey,
message: &T
) -> Result<Ed25519Signature, Error>
fn sign_using_version<T: CryptoHash + Serialize>( &self, name: &str, version: Ed25519PublicKey, message: &T ) -> Result<Ed25519Signature, Error>
Signs the provided securely-hashable struct, using the ‘named’ and ‘versioned’ private key. This may fail
even if the ‘named’ key exists but the version is not present.
source§impl<S: KVStorage> KVStorage for Namespaced<S>
impl<S: KVStorage> KVStorage for Namespaced<S>
source§fn available(&self) -> Result<(), Error>
fn available(&self) -> Result<(), Error>
Returns an error if the backend service is not online and available.
source§fn get<T: DeserializeOwned>(&self, key: &str) -> Result<GetResponse<T>, Error>
fn get<T: DeserializeOwned>(&self, key: &str) -> Result<GetResponse<T>, Error>
Retrieves a value from storage and fails if the backend is unavailable or the process has
invalid permissions.