Struct AccessPoint 

pub struct AccessPoint<E>
where
    E: Error + Debug + From<Error> + From<Error> + From<Error> + Send + Sync + 'static,
{ /* private fields */ }

Access to an in-memory vault optionally mirroring changes to storage.

It stores the derived private key in memory so should only be used on client implementations.

Calling lock() will zeroize the private key in memory and prevent any access to the vault until unlock() is called successfully.

To allow for meta data to be displayed before secret decryption certain parts of a vault are encrypted separately which means that technically it would be possible to use different private keys for different secrets and for the meta data however this would be a very poor user experience and would lead to confusion so the access point is also responsible for ensuring the same private key is used to encrypt the different chunks.

Implementations

impl<E> AccessPoint<E>

where E: Error + Debug + From<Error> + From<Error> + From<Error> + Send + Sync + 'static,

pub fn new(vault: Vault) -> Self

Create a new access point.

pub fn new_mirror( vault: Vault, mirror: Box<dyn EncryptedEntry<Error = E> + Send + Sync + 'static>, ) -> Self

Create a new access point that writes in-memory changes to a mirror.

Trait Implementations

impl<E> From<AccessPoint<E>> for Vault

where E: Error + Debug + From<Error> + From<Error> + From<Error> + Send + Sync + 'static,

fn from(value: AccessPoint<E>) -> Self

Converts to this type from the input type.

impl<E> From<Vault> for AccessPoint<E>

where E: Error + Debug + From<Error> + From<Error> + From<Error> + Send + Sync + 'static,

fn from(value: Vault) -> Self

Converts to this type from the input type.

impl<E> SecretAccess for AccessPoint<E>

where E: Error + Debug + From<Error> + From<Error> + From<Error> + Send + Sync + 'static,

type Error = E

Error type.

fn is_mirror(&self) -> bool

Indicates whether the access point is mirroring changes to storage.

fn vault(&self) -> &Vault

In-memory vault.

fn replace_vault<'life0, 'async_trait>( &'life0 mut self, vault: Vault, mirror_changes: bool, ) -> Pin<Box<dyn Future<Output = Result<(), E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Replace this vault with a new updated vault.

fn reload_vault<'life0, 'async_trait, P>( &'life0 mut self, path: P, ) -> Pin<Box<dyn Future<Output = Result<(), E>> + Send + 'async_trait>>

where P: 'async_trait + AsRef<Path> + Send, Self: 'async_trait, 'life0: 'async_trait,

Reload the vault from disc.

fn summary(&self) -> &Summary

Vault summary information.

fn id(&self) -> &VaultId

Vault identifier.

fn name(&self) -> &str

Public name for the vault.

fn set_vault_name<'life0, 'async_trait>( &'life0 mut self, name: String, ) -> Pin<Box<dyn Future<Output = Result<WriteEvent, E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set the public name for the vault.

fn set_vault_flags<'life0, 'async_trait>( &'life0 mut self, flags: VaultFlags, ) -> Pin<Box<dyn Future<Output = Result<WriteEvent, E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set the vault flags.

fn vault_meta<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<VaultMeta, E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Attempt to decrypt the meta data for the vault using the key assigned to this access point.

fn set_vault_meta<'life0, 'life1, 'async_trait>( &'life0 mut self, meta_data: &'life1 VaultMeta, ) -> Pin<Box<dyn Future<Output = Result<WriteEvent, E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Set the meta data for the vault.

fn create_secret<'life0, 'life1, 'async_trait>( &'life0 mut self, secret_data: &'life1 SecretRow, ) -> Pin<Box<dyn Future<Output = Result<WriteEvent, E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Add a secret to the vault.

fn raw_secret<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 SecretId, ) -> Pin<Box<dyn Future<Output = Result<Option<(VaultCommit, ReadEvent)>, E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read the encrypted contents of a secret.

fn read_secret<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 SecretId, ) -> Pin<Box<dyn Future<Output = Result<Option<(SecretMeta, Secret, ReadEvent)>, E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a secret and it’s meta data.

fn update_secret<'life0, 'life1, 'async_trait>( &'life0 mut self, id: &'life1 SecretId, secret_meta: SecretMeta, secret: Secret, ) -> Pin<Box<dyn Future<Output = Result<Option<WriteEvent>, E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Update a secret.

fn delete_secret<'life0, 'life1, 'async_trait>( &'life0 mut self, id: &'life1 SecretId, ) -> Pin<Box<dyn Future<Output = Result<Option<WriteEvent>, E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a secret and it’s meta data.

fn verify<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 AccessKey, ) -> Pin<Box<dyn Future<Output = Result<(), E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Verify an encryption password.

fn unlock<'life0, 'life1, 'async_trait>( &'life0 mut self, key: &'life1 AccessKey, ) -> Pin<Box<dyn Future<Output = Result<VaultMeta, E>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Unlock the vault using the access key.

fn lock(&mut self)

Lock the vault by deleting the stored private key associated with the vault and securely zeroing the underlying memory.