Struct Kdf 

pub struct Kdf<Key: ByteArray<CRYPTO_KDF_KEYBYTES> + Zeroize + ZeroizeOnDrop, Context: ByteArray<CRYPTO_KDF_CONTEXTBYTES> + Zeroize> { /* private fields */ }

Key derivation implementation based on Blake2b, compatible with libsodium’s crypto_kdf_* functions.

The main-key type must implement ZeroizeOnDrop so keys remain self-wiping after Kdf::into_parts transfers ownership to the caller.

Implementations

impl<Key: NewByteArray<CRYPTO_KDF_KEYBYTES> + Zeroize + ZeroizeOnDrop, Context: NewByteArray<CRYPTO_KDF_CONTEXTBYTES> + Zeroize> Kdf<Key, Context>

pub fn generate() -> Self

Randomly generates a new pair of main key and context.

pub fn gen() -> Self

👎Deprecated:

use generate() instead

Randomly generates a new pair of main key and context.

Prefer generate. gen is retained for compatibility with older Rust editions.

impl<Key: ByteArray<CRYPTO_KDF_KEYBYTES> + Zeroize + ZeroizeOnDrop, Context: ByteArray<CRYPTO_KDF_CONTEXTBYTES> + Zeroize> Kdf<Key, Context>

pub fn derive_subkey<const LENGTH: usize, Subkey: NewByteArray<LENGTH>>( &self, subkey_id: u64, ) -> Result<Subkey, Error>

Derives a subkey for subkey_id, returning it.

Errors

Returns an error unless LENGTH is between CRYPTO_KDF_BLAKE2B_BYTES_MIN and CRYPTO_KDF_BLAKE2B_BYTES_MAX, inclusive.

pub fn derive_subkey_to_vec( &self, subkey_id: u64, length: usize, ) -> Result<Vec<u8>, Error>

Derives a subkey for subkey_id, returning it as a Vec. Provided for convenience.

Errors

Returns an error unless length is between CRYPTO_KDF_BLAKE2B_BYTES_MIN and CRYPTO_KDF_BLAKE2B_BYTES_MAX, inclusive.

pub fn from_parts(main_key: Key, context: Context) -> Self

Constructs a new instance from key and context, consuming them both.

pub fn into_parts(self) -> (Key, Context)

Moves the key and context out of this instance, returning them as a tuple.

impl Kdf<Key, Context>

pub fn generate_with_defaults() -> Self

Randomly generates a new pair of main key and context.

pub fn gen_with_defaults() -> Self

👎Deprecated:

use generate_with_defaults() instead

Randomly generates a new pair of main key and context.

Prefer generate_with_defaults. This method is retained for compatibility.

Trait Implementations

impl<Key: Clone + ByteArray<CRYPTO_KDF_KEYBYTES> + Zeroize + ZeroizeOnDrop, Context: Clone + ByteArray<CRYPTO_KDF_CONTEXTBYTES> + Zeroize> Clone for Kdf<Key, Context>

fn clone(&self) -> Kdf<Key, Context>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Key: ByteArray<CRYPTO_KDF_KEYBYTES> + Zeroize + ZeroizeOnDrop, Context: ByteArray<CRYPTO_KDF_CONTEXTBYTES> + Zeroize> Debug for Kdf<Key, Context>

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

Formats the value using the given formatter.

impl<'de, Key, Context> Deserialize<'de> for Kdf<Key, Context>

where Key: Deserialize<'de> + ByteArray<CRYPTO_KDF_KEYBYTES> + Zeroize + ZeroizeOnDrop, Context: Deserialize<'de> + ByteArray<CRYPTO_KDF_CONTEXTBYTES> + Zeroize,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Key, Context> Serialize for Kdf<Key, Context>

where Key: Serialize + ByteArray<CRYPTO_KDF_KEYBYTES> + Zeroize + ZeroizeOnDrop, Context: Serialize + ByteArray<CRYPTO_KDF_CONTEXTBYTES> + Zeroize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Key, Context> Zeroize for Kdf<Key, Context>

where Key: Zeroize + ByteArray<CRYPTO_KDF_KEYBYTES> + ZeroizeOnDrop, Context: Zeroize + ByteArray<CRYPTO_KDF_CONTEXTBYTES>,

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.