Struct secret_keeper::keepers::env::EnvKeeper

pub struct EnvKeeper {}

EnvKeeper generates encryption key from a passphrase in environment variable.

The passphrase from the environment is combined wih a nonce plus salt through PBKDF2+HMAC+SHA256 to generate the key. (Implementation by RustCrypto)

Uri formats:

• env: uses the default environment variable VAULT_PASSWORD
• env:VARNAME - variable VARNAME contains the passphrase
• env://VARNAME - alternate syntax

Implementations

impl EnvKeeper

pub fn new() -> Self

Trait Implementations

impl Debug for EnvKeeper

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

Formats the value using the given formatter.

impl SecretKeeper for EnvKeeper

fn get_scheme(&self) -> &str

returns the uri scheme

fn wrap<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    uri: &'life1 str,
    nonce: &'life2 [u8],
    key: &'life3 [u8]
) -> Pin<Box<dyn Future<Output = Result<WrappedKey, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, 

Encrypts key with a passphrase-generated key Passphrase is retrieved from enviornment variable (default VAULT_PASSWORD, or the name in the key uri "env:<VAR_NAME>"). Returned encrypted key is stringified with bech32. Applications using envelope encryption don't call this function directly, but instead use Cipher.export. Cipher.export invokes SecretKeeper.wrap to encrypt the key and generate the WrappedKey.

fn unwrap<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    nonce: &'life1 [u8],
    wk: &'life2 WrappedKey
) -> Pin<Box<dyn Future<Output = Result<Bytes, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Unwraps and decrypts key with a passphrase-generated key Passphrase is retrieved from enviornment variable (default VAULT_PASSWORD, or the name in the key uri "env:<VAR_NAME>").

#[must_use]fn init_cipher<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    ckind: CipherKind,
    nonce: &'life1 [u8],
    wrapped: Option<&'life2 WrappedKey>
) -> Pin<Box<dyn Future<Output = Result<Box<dyn Cipher>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Initialize a new encryption cipher.

fn as_create(&self) -> Result<&dyn Create, Error>

attempts to cast keeper to Create. Returns Error if create() is not implemented.