Enum aptos_secure_storage::Storage

pub enum Storage {
    GitHubStorage(GitHubStorage),
    VaultStorage(VaultStorage),
    InMemoryStorage(InMemoryStorage),
    NamespacedStorage(Namespaced<Box<Storage>>),
    OnDiskStorage(OnDiskStorage),
}

This is the interface into secure storage. Any storage engine implementing this trait should support both key/value operations (e.g., get, set and create) and cryptographic key operations (e.g., generate_key, sign and rotate_key). This is a hack that allows us to convert from SecureBackend into a useable T: Storage. This boilerplate can be 100% generated by a proc macro.

Variants

GitHubStorage(GitHubStorage)

VaultStorage(VaultStorage)

InMemoryStorage(InMemoryStorage)

NamespacedStorage(Namespaced<Box<Storage>>)

OnDiskStorage(OnDiskStorage)

Trait Implementations

impl CryptoStorage for Storage

fn create_key(
    &mut self,
    __enum_dispatch_arg_0: &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.

fn export_private_key(
    &self,
    __enum_dispatch_arg_0: &str
) -> Result<Ed25519PrivateKey, Error>

Returns the Ed25519 private key stored at ‘name’.

fn import_private_key(
    &mut self,
    __enum_dispatch_arg_0: &str,
    __enum_dispatch_arg_1: 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 running in test environments where a set of deterministic keys must be generated.

fn export_private_key_for_version(
    &self,
    __enum_dispatch_arg_0: &str,
    __enum_dispatch_arg_1: 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.

fn get_public_key(
    &self,
    __enum_dispatch_arg_0: &str
) -> Result<PublicKeyResponse, Error>

Returns the Ed25519 public key stored at ‘name’.

fn get_public_key_previous_version(
    &self,
    __enum_dispatch_arg_0: &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.

fn rotate_key(
    &mut self,
    __enum_dispatch_arg_0: &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.

fn sign<T: CryptoHash + Serialize>(
    &self,
    __enum_dispatch_arg_0: &str,
    __enum_dispatch_arg_1: &T
) -> Result<Ed25519Signature, Error>

Signs the provided securely-hashable struct, using the ‘named’ private key.

fn sign_using_version<T: CryptoHash + Serialize>(
    &self,
    __enum_dispatch_arg_0: &str,
    __enum_dispatch_arg_1: Ed25519PublicKey,
    __enum_dispatch_arg_2: &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.

impl CryptoStorage for Box<Storage>

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.

fn export_private_key(&self, name: &str) -> Result<Ed25519PrivateKey, Error>

Returns the Ed25519 private key stored at ‘name’.

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 running in test environments where a set of deterministic keys must be generated.

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.

fn get_public_key(&self, name: &str) -> Result<PublicKeyResponse, Error>

Returns the Ed25519 public key stored at ‘name’.

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.

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.

fn sign<T: CryptoHash + Serialize>(
    &self,
    name: &str,
    message: &T
) -> Result<Ed25519Signature, Error>

Signs the provided securely-hashable struct, using the ‘named’ private key.

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.

impl From<GitHubStorage> for Storage

fn from(v: GitHubStorage) -> Storage

Converts to this type from the input type.

impl From<InMemoryStorage> for Storage

fn from(v: InMemoryStorage) -> Storage

Converts to this type from the input type.

impl From<Namespaced<Box<Storage, Global>>> for Storage

fn from(v: Namespaced<Box<Storage>>) -> Storage

Converts to this type from the input type.

impl From<OnDiskStorage> for Storage

fn from(v: OnDiskStorage) -> Storage

Converts to this type from the input type.

impl From<VaultStorage> for Storage

fn from(v: VaultStorage) -> Storage

Converts to this type from the input type.

impl KVStorage for Storage

fn available(&self) -> Result<(), Error>

Returns an error if the backend service is not online and available.

fn get<T: DeserializeOwned>(
    &self,
    __enum_dispatch_arg_0: &str
) -> Result<GetResponse<T>, Error>

Retrieves a value from storage and fails if the backend is unavailable or the process has invalid permissions.

fn set<T: Serialize>(
    &mut self,
    __enum_dispatch_arg_0: &str,
    __enum_dispatch_arg_1: T
) -> Result<(), Error>

Sets a value in storage and fails if the backend is unavailable or the process has invalid permissions.

impl KVStorage for Box<Storage>

fn available(&self) -> Result<(), Error>

Returns an error if the backend service is not online and available.

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.

fn set<T: Serialize>(&mut self, key: &str, value: T) -> Result<(), Error>

Sets a value in storage and fails if the backend is unavailable or the process has invalid permissions.

impl TryInto<GitHubStorage> for Storage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<GitHubStorage, <Self as TryInto<GitHubStorage>>::Error>

Performs the conversion.

impl TryInto<InMemoryStorage> for Storage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<InMemoryStorage, <Self as TryInto<InMemoryStorage>>::Error>

Performs the conversion.

impl TryInto<Namespaced<Box<Storage, Global>>> for Storage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<Namespaced<Box<Storage>>, <Self as TryInto<Namespaced<Box<Storage>>>>::Error>

Performs the conversion.

impl TryInto<OnDiskStorage> for Storage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<OnDiskStorage, <Self as TryInto<OnDiskStorage>>::Error>

Performs the conversion.

impl TryInto<VaultStorage> for Storage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<VaultStorage, <Self as TryInto<VaultStorage>>::Error>

Performs the conversion.