Struct snapper_box::crypto::key::DerivedKey

pub struct DerivedKey { /* fields omitted */ }

A key that has been derived from a RootKey

This will have an encryption key and an hmac key derived from the RootKey’s entropy pool, using Blake3 in key-derivation mode, keyed with the RootKey’s hmac key.

This struct also contains the context string that was used to derive it, as a way to validate key provenance, or possibly reconstruct a key after a corruption occurs.

Implementations

impl DerivedKey

pub fn encrypt(
    &self,
    root_key: &RootKey
) -> Result<EncryptedDerivedKey<'static>, Error>

Encrypts the given DerivedKey into an EncryptedDerivedKey using the given RootKey.

This method packs the derived key into a ClearText box, and then encrypts it to a CipherText box, without enabling compression.

See the documentation for CipherText for a description of the encryption method.

Errors

Will error if the encryption or serialization fail

Trait Implementations

impl Clone for DerivedKey

fn clone(&self) -> DerivedKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for DerivedKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Drop for DerivedKey

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for DerivedKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Key for DerivedKey

fn encryption_key(&self) -> &Key

Provides the encryption key as a chacha Key

fn hmac_key(&self) -> &[u8; 32]

Provides the hmac key

impl Serialize for DerivedKey

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

Serialize this value into the given Serde serializer.

impl Zeroize for DerivedKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.