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 extract<Ikm: Bytes + ?Sized>(salt: Option<&[u8]>, ikm: &Ikm) -> Self

Extracts a PRK from input keying material and optional salt.

pub fn extract_and_expand<const OUTPUT_LENGTH: usize, Output: NewByteArray<OUTPUT_LENGTH>, Ikm: Bytes + ?Sized, Context: Bytes + ?Sized>( salt: Option<&[u8]>, 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<Ikm: Bytes + ?Sized, Context: Bytes + ?Sized>( salt: Option<&[u8]>, ikm: &Ikm, context: &Context, output_len: usize, ) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

One-shot HKDF extract-and-expand 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 extract_and_expand_to_bytes<Output: NewBytes + ResizableBytes, Ikm: Bytes + ?Sized, Context: Bytes + ?Sized>( salt: Option<&[u8]>, ikm: &Ikm, context: &Context, output_len: usize, ) -> Result<Output, Error>

One-shot HKDF extract-and-expand into a runtime-sized byte container of output_len bytes, such as protected memory.

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, Output, Context: Bytes + ?Sized>( &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, context: &Context, output_len: usize, ) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

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<Output: NewBytes + ResizableBytes, Context: Bytes + ?Sized>( &self, context: &Context, output_len: usize, ) -> Result<Output, Error>

Expands this PRK into a runtime-sized byte container of output_len bytes, such as protected memory.

Errors

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

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) -> Self

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>,

Available on crate feature serde only.

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,

Available on crate feature serde only.

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.