Struct FieldCipher 

pub struct FieldCipher { /* private fields */ }

Encrypts and decrypts the fields a schema marks cypher, so their values never reach the disk in the clear.

The additional authenticated data binds each value to its table, its record and its field name, which is what stops a stored value from being moved somewhere it did not belong. Nothing that compaction rewrites takes part in it, so compacting a log needs no key at all.

Implementations

impl FieldCipher

pub fn new(options: CipherOptions) -> Result<Self, HaysonCipherError>

pub fn write_key_id(&self) -> &str

pub fn on_missing_key(&self) -> MissingKeyPolicy

What a read of a value sealed under a key this cipher does not hold does — the policy a maintenance pass has to honour as well, so that it never turns a missing key into lost data.

pub fn knows(&self, key_id: &str) -> bool

pub fn encrypt( &self, table: &str, key: &str, field: &str, value: &Value, ) -> String

pub fn decrypt( &self, table: &str, key: &str, field: &str, envelope: &str, ) -> Result<Option<Value>, HaysonCipherError>

Ok(None) only when the key is missing and the policy is omit.

Trait Implementations

impl Clone for FieldCipher

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 FieldCipher

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

Formats the value using the given formatter.