Struct BackupDecryptor

pub struct BackupDecryptor<'a> {
    pub(crate) backup: &'a Backup,
    pub(crate) cipher: Aes256Gcm,
}

Backup decryptor which decrypts backup items on the fly.

Fields

backup: &'a Backup

cipher: Aes256Gcm

Implementations

impl<'a> BackupDecryptor<'a>

pub(crate) fn new(backup: &'a Backup, passphrase: &[u8]) -> Result<Self>

Create a new BackupDecryptor using a Backup and a passphrase.

Errors

Even though this function returns a Result it is unlikely to fail since all parameters are static.

pub(crate) fn decrypt(&self, ciphertext: &[u8], aad: &[u8]) -> Result<Vec<u8>>

Decrypts ciphertext while verifying additional data (aad).

Errors

Returns:

• Error::Decryption if a decryption error is encountered, for example the ciphertext is of incorrect length, has been tampered with, the decryption passphrase is wrong or the additional authenticated data is incorrect.

pub fn version(&self) -> Result<Vec<u8>>

Decrypted backup version.

Errors

Returns:

• Error::Decryption if a decryption error is encountered, for example the encrypted version is of incorrect length, has been tampered with, the decryption passphrase is wrong or the additional authenticated data is incorrect (e.g. a different encrypted piece of data is impersonating the backup version).

pub fn domain_key(&self) -> Result<Vec<u8>>

Decrypted domain key.

Errors

Returns:

• Error::Decryption if a decryption error is encountered, for example the encrypted domain key is of incorrect length, has been tampered with, the decryption passphrase is wrong or the additional authenticated data is incorrect (e.g. a different encrypted piece of data is impersonating the domain key).

pub fn items_iter( &'a self, ) -> impl Iterator<Item = Result<(String, Vec<u8>)>> + 'a

Returns an iterator over backup entries.

The entries are pairs of keys (which are strings) and values (byte vectors). Since the entries are decrypted as they are being read the pairs are wrapped in Results.

Errors

This function does not fail but reading the inner iterator may return errors:

• Error::Decryption if a decryption error is encountered, for example the encrypted entry is of incorrect length, has been tampered with, the decryption passphrase is wrong or the additional authenticated data is incorrect (e.g. a different encrypted piece of data is impersonating the backup entry).
• Error::Utf8 if the entry’s key is not a well-formed UTF-8 string.