Struct Vault 

pub struct Vault { /* private fields */ }

Vault file storage.

Implementations

impl Vault

pub fn new( id: VaultId, name: String, cipher: Cipher, kdf: KeyDerivation, flags: VaultFlags, ) -> Self

Create a new vault.

pub fn shared_access(&self) -> &SharedAccess

Shared access.

pub fn vault_urn(id: &VaultId) -> Result<Urn, Error>

Get the URN for a vault identifier.

pub fn deriver(&self) -> Box<dyn Deriver<Sha256> + Send + 'static>

Key derivation function deriver.

pub fn set_default_flag(&mut self, value: bool)

Set whether this vault is a default vault.

pub fn set_archive_flag(&mut self, value: bool)

Set whether this vault is an archive vault.

pub fn set_authenticator_flag(&mut self, value: bool)

Set whether this vault is an authenticator vault.

pub fn set_contact_flag(&mut self, value: bool)

Set whether this vault is for contacts.

pub fn set_system_flag(&mut self, value: bool)

Set whether this vault is for system specific information.

pub fn set_device_flag(&mut self, value: bool)

Set whether this vault is for device specific information.

pub fn set_no_sync_flag(&mut self, value: bool)

Set whether this vault should not sync with own devices.

pub fn insert_entry(&mut self, id: SecretId, entry: VaultCommit)

Insert a secret into this vault.

pub fn get(&self, id: &SecretId) -> Option<&VaultCommit>

Get a secret in this vault.

pub async fn encrypt( &self, key: &PrivateKey, plaintext: &[u8], ) -> Result<AeadPack, Error>

Encrypt plaintext using the cipher assigned to this vault.

pub async fn decrypt( &self, key: &PrivateKey, aead: &AeadPack, ) -> Result<Vec<u8>, Error>

Decrypt ciphertext using the cipher assigned to this vault.

pub fn rotate_identifier(&mut self)

Choose a new identifier for this vault.

This is useful when importing a vault and the identifier collides with an existing vault; rather than overwriting the existing vault we can import it alongside by choosing a new identifier.

pub async fn verify(&self, key: &AccessKey) -> Result<(), Error>

Verify an access key.

pub fn iter(&self) -> impl Iterator<Item = (&Uuid, &VaultCommit)>

Iterator for the secret keys and values.

pub fn keys(&self) -> impl Iterator<Item = &Uuid>

Iterator for the secret keys.

pub fn values(&self) -> impl Iterator<Item = &VaultCommit>

Iterator for the secret values.

pub fn len(&self) -> usize

Number of secrets in this vault.

pub fn is_empty(&self) -> bool

Determine if this vault is empty.

pub async fn into_event(&self) -> Result<WriteEvent, Error>

Convert this vault into a create vault event.

Ensures the vault is head-only before encoding into the event.

pub fn commits(&self) -> impl Iterator<Item = (&Uuid, &CommitHash)>

Iterator for the secret keys and commit hashes.

pub fn salt(&self) -> Option<&String>

Get the salt used for passphrase authentication.

pub fn seed(&self) -> Option<&Seed>

Get the seed used for passphrase authentication.

pub fn summary(&self) -> &Summary

Get the summary for this vault.

pub fn flags(&self) -> &VaultFlags

Reference to the vault flags.

pub fn flags_mut(&mut self) -> &mut VaultFlags

Mutable reference to the vault flags.

pub fn id(&self) -> &VaultId

Unique identifier for this vault.

pub fn name(&self) -> &str

Public name for this vault.

pub fn set_name(&mut self, name: String)

Set the public name of this vault.

pub fn cipher(&self) -> &Cipher

Encryption cipher for this vault.

pub fn kdf(&self) -> &KeyDerivation

Key derivation function.

pub fn header(&self) -> &Header

Vault header.

pub fn header_mut(&mut self) -> &mut Header

Mutable vault header.

pub fn data(&self) -> &IndexMap<SecretId, VaultCommit>

Vault data.

pub fn data_mut(&mut self) -> &mut IndexMap<SecretId, VaultCommit>

Mutable vault data.

pub fn meta_data(&self) -> HashMap<&Uuid, &AeadPack>

Get the meta data for all the secrets.

Trait Implementations

impl Clone for Vault

fn clone(&self) -> Vault

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vault

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

Formats the value using the given formatter.

impl Decodable for Vault

fn decode<'life0, 'life1, 'async_trait, R>( &'life0 mut self, reader: &'life1 mut BinaryReader<R>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where R: 'async_trait + AsyncRead + AsyncSeek + Unpin + Send, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Decode from the binary reader into self.

impl Default for Vault

fn default() -> Vault

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Vault

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for Vault

fn encode<'life0, 'life1, 'async_trait, W>( &'life0 self, writer: &'life1 mut BinaryWriter<W>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where W: 'async_trait + AsyncWrite + AsyncSeek + Unpin + Send, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Encode self into the binary writer.

impl EncryptedEntry for Vault

type Error = Error

Error type for vault access.

fn summary<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Summary, Error>> + Send + 'async_trait>>

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

Get the vault summary.

fn vault_name<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Cow<'_, str>, Error>> + Send + 'async_trait>>

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

Get the name of a vault.

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

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

Set the name of a vault.

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

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

Set the flags for a vault.

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

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

Set the vault meta data.

fn create_secret<'life0, 'async_trait>( &'life0 mut self, commit: CommitHash, secret: VaultEntry, ) -> Pin<Box<dyn Future<Output = Result<WriteEvent, Error>> + Send + 'async_trait>>

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

Add an encrypted secret to the vault.

fn read_secret<'a, 'life0, 'async_trait>( &'a self, id: &'life0 SecretId, ) -> Pin<Box<dyn Future<Output = Result<Option<(Cow<'a, VaultCommit>, ReadEvent)>, Error>> + Send + 'async_trait>>

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

Get an encrypted secret from the vault.

fn update_secret<'life0, 'life1, 'async_trait>( &'life0 mut self, id: &'life1 SecretId, commit: CommitHash, secret: VaultEntry, ) -> Pin<Box<dyn Future<Output = Result<Option<WriteEvent>, Error>> + Send + 'async_trait>>

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

Update an encrypted secret in the vault.

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

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

Remove an encrypted secret from the vault.

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

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

Replace the vault with new vault content.

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 From<Header> for Vault

fn from(header: Header) -> Self

Converts to this type from the input type.

impl From<Summary> for Vault

fn from(value: Summary) -> 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 From<Vault> for Header

fn from(value: Vault) -> Self

Converts to this type from the input type.

impl IntoIterator for Vault

type Item = (Uuid, VaultCommit)

The type of the elements being iterated over.

type IntoIter = IntoIter<Uuid, VaultCommit>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Vault

fn eq(&self, other: &Vault) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Vault

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Vault

impl StructuralPartialEq for Vault