Struct DataKey 

pub struct DataKey { /* private fields */ }

The key that seals stored secrets. Keep it apart from every other key, outside the database and its backups. Zeroed on drop.

Implementations

impl DataKey

pub fn new(key: &[u8; 32]) -> Self

A key from 32 bytes.

pub fn seal_bytes<R: CryptoRng + ?Sized>( &self, rng: &mut R, aad: &Aad, plaintext: &[u8], ) -> Result<Vec<u8>, Error>

Seals bytes for a binary column.

Errors

Error::Crypto when encryption fails.

pub fn open_bytes(&self, aad: &Aad, stored: &[u8]) -> Option<Vec<u8>>

Opens sealed bytes; None when they are plaintext, sealed under another key, bound to another Aad or tampered with.

pub fn seal_text<R: CryptoRng + ?Sized>( &self, rng: &mut R, aad: &Aad, plaintext: &str, ) -> Result<String, Error>

Seals text for a text column.

Errors

Error::Crypto when encryption fails.

pub fn open_text(&self, aad: &Aad, stored: &str) -> Option<String>

Opens sealed text; None as for open_bytes.

pub fn seal_totp<R: CryptoRng + ?Sized>( &self, rng: &mut R, user: UserId, secret: &TotpSecret, ) -> Result<Vec<u8>, Error>

Seals a TOTP secret of user.

Errors

Error::Crypto when encryption fails.

pub fn open_totp( &self, user: UserId, stored: &[u8], ) -> Result<TotpSecret, Error>

Opens a TOTP secret of user.

Errors

Error::Crypto when it does not open: a wrong key, another account’s value or a plaintext leftover from latchkey 0.1.

pub fn seal_passkey<R: CryptoRng + ?Sized>( &self, rng: &mut R, user: UserId, id: PasskeyId, passkey: &Passkey, ) -> Result<String, Error>

Available on crate feature passkeys only.

Seals a passkey as JSON text.

Errors

Error::Crypto when serialising or encryption fails.

pub fn open_passkey( &self, user: UserId, id: PasskeyId, stored: &str, ) -> Result<Passkey, Error>

Available on crate feature passkeys only.

Opens a passkey sealed with seal_passkey.

Errors

Error::Crypto when it does not open or parse.

Trait Implementations

impl Clone for DataKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataKey

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

Formats the value using the given formatter.