Struct Hkdf 

pub struct Hkdf<Variant, Prk, const PRK_LENGTH: usize>
where
    Variant: HkdfVariant<PRK_LENGTH>,
    Prk: ByteArray<PRK_LENGTH> + Zeroize + ZeroizeOnDrop,
{ /* private fields */ }

HKDF expander for a specific HkdfVariant.

Implementations

impl<Variant, Prk, const PRK_LENGTH: usize> Hkdf<Variant, Prk, PRK_LENGTH>

where Variant: HkdfVariant<PRK_LENGTH>, Prk: NewByteArray<PRK_LENGTH> + Zeroize + ZeroizeOnDrop,

pub fn generate() -> Self

Randomly generates a new PRK for HKDF expand.

pub fn gen() -> Self

👎Deprecated:

use generate() instead

Randomly generates a new PRK for HKDF expand.

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

pub fn extract<Salt: Bytes + ?Sized, Ikm: Bytes + ?Sized>( salt: Option<&Salt>, ikm: &Ikm, ) -> Self

Extracts a PRK from input keying material and optional salt.

pub fn extract_and_expand<const OUTPUT_LENGTH: usize, Salt: Bytes + ?Sized, Ikm: Bytes + ?Sized, Context: Bytes + ?Sized, Output: NewByteArray<OUTPUT_LENGTH>>( salt: Option<&Salt>, ikm: &Ikm, context: &Context, ) -> Result<Output, Error>

One-shot HKDF extract-and-expand into a fixed-size output type.

Errors

Returns an error if OUTPUT_LENGTH is outside the range supported by the selected HKDF variant.

pub fn extract_and_expand_to_vec<Salt: Bytes + ?Sized, Ikm: Bytes + ?Sized, Context: Bytes + ?Sized>( output_len: usize, salt: Option<&Salt>, ikm: &Ikm, context: &Context, ) -> Result<Vec<u8>, Error>

One-shot HKDF extract-and-expand into a Vec.

Errors

Returns an error if output_len is outside the range supported by the selected HKDF variant.

pub fn extract_and_expand_to_bytes<Salt: Bytes + ?Sized, Ikm: Bytes + ?Sized, Context: Bytes + ?Sized, Output: NewBytes + ResizableBytes>( output_len: usize, salt: Option<&Salt>, ikm: &Ikm, context: &Context, ) -> Result<Output, Error>

One-shot HKDF extract-and-expand into a runtime-sized byte container.

Errors

Returns an error if output_len is outside the range supported by the selected HKDF variant.

impl<Variant, Prk, const PRK_LENGTH: usize> Hkdf<Variant, Prk, PRK_LENGTH>

where Variant: HkdfVariant<PRK_LENGTH>, Prk: ByteArray<PRK_LENGTH> + Zeroize + ZeroizeOnDrop,

pub fn from_prk(prk: Prk) -> Self

Constructs an HKDF expander from a PRK, consuming it.

pub fn into_prk(self) -> Prk

Moves the PRK out of this expander.

pub fn expand<const OUTPUT_LENGTH: usize, Context: Bytes + ?Sized, Output>( &self, context: &Context, ) -> Result<Output, Error>

where Output: NewByteArray<OUTPUT_LENGTH>,

Expands this PRK into a fixed-size output type.

Errors

Returns an error if OUTPUT_LENGTH is outside the range supported by the selected HKDF variant.

pub fn expand_to_vec<Context: Bytes + ?Sized>( &self, output_len: usize, context: &Context, ) -> Result<Vec<u8>, Error>

Expands this PRK into a Vec of output_len bytes.

Errors

Returns an error if output_len is outside the range supported by the selected HKDF variant.

pub fn expand_to_bytes<Context: Bytes + ?Sized, Output: NewBytes + ResizableBytes>( &self, output_len: usize, context: &Context, ) -> Result<Output, Error>

Expands this PRK into a runtime-sized byte container.

Errors

Returns an error if output_len is outside the range supported by the selected HKDF variant.

impl<Variant, const PRK_LENGTH: usize> Hkdf<Variant, Variant::Prk, PRK_LENGTH>

where Variant: HkdfVariant<PRK_LENGTH>,

pub fn generate_with_defaults() -> Self

Randomly generates a new PRK using the default stack-allocated type.

pub fn gen_with_defaults() -> Self

👎Deprecated:

use generate_with_defaults() instead

Randomly generates a new PRK using the default stack-allocated type.

Prefer generate_with_defaults. This method is retained for compatibility.

Trait Implementations

impl<Variant, Prk, const PRK_LENGTH: usize> Clone for Hkdf<Variant, Prk, PRK_LENGTH>

where Variant: HkdfVariant<PRK_LENGTH> + Clone, Prk: ByteArray<PRK_LENGTH> + Zeroize + ZeroizeOnDrop + Clone,

fn clone(&self) -> Hkdf<Variant, Prk, PRK_LENGTH>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Variant, Prk, const PRK_LENGTH: usize> Debug for Hkdf<Variant, Prk, PRK_LENGTH>

where Variant: HkdfVariant<PRK_LENGTH> + Debug, Prk: ByteArray<PRK_LENGTH> + Zeroize + ZeroizeOnDrop + Debug,

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

Formats the value using the given formatter.

impl<'de, Variant, Prk, const PRK_LENGTH: usize> Deserialize<'de> for Hkdf<Variant, Prk, PRK_LENGTH>

where Variant: HkdfVariant<PRK_LENGTH>, Prk: ByteArray<PRK_LENGTH> + Zeroize + ZeroizeOnDrop + Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Variant, Prk, const PRK_LENGTH: usize> Serialize for Hkdf<Variant, Prk, PRK_LENGTH>

where Variant: HkdfVariant<PRK_LENGTH>, Prk: ByteArray<PRK_LENGTH> + Zeroize + ZeroizeOnDrop + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Variant, Prk, const PRK_LENGTH: usize> Zeroize for Hkdf<Variant, Prk, PRK_LENGTH>

where Variant: HkdfVariant<PRK_LENGTH>, Prk: ByteArray<PRK_LENGTH> + Zeroize + ZeroizeOnDrop,

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.