Skip to main content

GenericHkdf

Struct GenericHkdf 

Source
pub struct GenericHkdf<H: HmacImpl> {
    pub(crate) hmac: H,
}
Expand description

Structure representing the HKDF, capable of HKDF-Expand and HKDF-Extract operations. Recommendations for the correct usage of the parameters can be found in the crate root.

This type is generic over HMAC implementation. Most users should use Hkdf or SimpleHkdf type aliases.

Fields§

§hmac: H

Implementations§

Source§

impl<H: HmacImpl> GenericHkdf<H>

Source

pub fn new(salt: Option<&[u8]>, ikm: &[u8]) -> Self

Convenience method for extract when the generated pseudorandom key can be ignored and only HKDF-Expand operation is needed. This is the most common constructor.

Source

pub fn from_prk(prk: &[u8]) -> Result<Self, InvalidPrkLength>

Create Hkdf from an already cryptographically strong pseudorandom key as per section 3.3 from RFC5869.

§Errors

Returns InvalidPrkLength if prk is shorter than the output size of H.

Source

pub fn extract(salt: Option<&[u8]>, ikm: &[u8]) -> (Output<H>, Self)

The RFC5869 HKDF-Extract operation returning both the generated pseudorandom key and Hkdf struct for expanding.

Source

pub fn expand_multi_info( &self, info_components: &[&[u8]], okm: &mut [u8], ) -> Result<(), InvalidLength>

The RFC5869 HKDF-Expand operation. This is equivalent to calling expand with the info argument set equal to the concatenation of all the elements of info_components.

§Errors

Returns InvalidLength in the event okm is too large.

Source

pub fn expand(&self, info: &[u8], okm: &mut [u8]) -> Result<(), InvalidLength>

The RFC5869 HKDF-Expand operation

If you don’t have any info to pass, use an empty slice.

§Errors

Returns InvalidLength in the event okm is too large.

Trait Implementations§

Source§

impl<H: Clone + HmacImpl> Clone for GenericHkdf<H>

Source§

fn clone(&self) -> GenericHkdf<H>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<H: Debug + HmacImpl> Debug for GenericHkdf<H>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<H> Freeze for GenericHkdf<H>
where H: Freeze,

§

impl<H> RefUnwindSafe for GenericHkdf<H>
where H: RefUnwindSafe,

§

impl<H> Send for GenericHkdf<H>
where H: Send,

§

impl<H> Sync for GenericHkdf<H>
where H: Sync,

§

impl<H> Unpin for GenericHkdf<H>
where H: Unpin,

§

impl<H> UnsafeUnpin for GenericHkdf<H>
where H: UnsafeUnpin,

§

impl<H> UnwindSafe for GenericHkdf<H>
where H: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.