Skip to main content

This is unreleased documentation for the main (development) branch of crypto-glue.

Pbkdf2Params

Struct Pbkdf2Params

pub struct Pbkdf2Params {
    pub salt: Salt,
    pub iteration_count: u32,
    pub key_length: Option<u16>,
    pub prf: Pbkdf2Prf,
}

Expand description

Password-Based Key Derivation Scheme 2 parameters as defined in RFC 8018 Appendix A.2.

PBKDF2-params ::= SEQUENCE {
    salt CHOICE {
        specified OCTET STRING,
        otherSource AlgorithmIdentifier {{PBKDF2-SaltSources}}
    },
    iterationCount INTEGER (1..MAX),
    keyLength INTEGER (1..MAX) OPTIONAL,
    prf AlgorithmIdentifier {{PBKDF2-PRFs}} DEFAULT
    algid-hmacWithSHA1 }

Fields§

§salt: Salt

PBKDF2 salt

§iteration_count: u32

PBKDF2 iteration count

§key_length: Option<u16>

PBKDF2 output length

§prf: Pbkdf2Prf

Pseudo-random function to use with PBKDF2

Implementations§

impl Pbkdf2Params

pub const MAX_ITERATION_COUNT: u32 = 100_000_000

Implementation defined maximum iteration count of 100,000,000.

For especially critical keys, or for very powerful systems or systems where user-perceived performance is not critical, an iteration count of 10,000,000 may be appropriate.

See RFC 8018, §4.2 and RFC 8018, §A.2

pub fn hmac_sha256(iteration_count: u32, salt: &[u8]) -> Result<Self>

Initialize PBKDF2-HMAC-SHA256 with the given iteration count and salt.

§Errors

Returns Error::AlgorithmParametersInvalid if iteration_count exceeds Pbkdf2Params::MAX_ITERATION_COUNT or salt exceeds Salt::MAX_LEN.

Trait Implementations§

impl Clone for Pbkdf2Params

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for Pbkdf2Params

impl Debug for Pbkdf2Params

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

Formats the value using the given formatter. Read more

impl<'a> DecodeValue<'a> for Pbkdf2Params

type Error = Error

Type returned in the event of a decoding error.

fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self>

Attempt to decode this value using the provided Reader. Read more

impl EncodeValue for Pbkdf2Params

fn value_len(&self) -> Result<Length>

Compute the length of this value (sans [Tag]+Length header) when encoded as ASN.1 DER. Read more

fn encode_value(&self, writer: &mut impl Writer) -> Result<()>

Encode value (sans [Tag]+Length header) as ASN.1 DER using the provided Writer. Read more

Get the Header used to encode this value. Read more

impl Eq for Pbkdf2Params

impl From<Pbkdf2Params> for Kdf

fn from(params: Pbkdf2Params) -> Self

Converts to this type from the input type.

impl PartialEq for Pbkdf2Params

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl Sequence<'_> for Pbkdf2Params

impl StructuralPartialEq for Pbkdf2Params

impl TryFrom<AnyRef<'_>> for Pbkdf2Params

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: AnyRef<'_>) -> Result<Self>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for Pbkdf2Params

impl RefUnwindSafe for Pbkdf2Params

impl Send for Pbkdf2Params

impl Sync for Pbkdf2Params

impl Unpin for Pbkdf2Params

impl UnsafeUnpin for Pbkdf2Params

impl UnwindSafe for Pbkdf2Params

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<'a, T> Choice<'a> for T
where T: Decode<'a> + FixedTag,

fn can_decode(tag: Tag) -> bool

Is the provided Tag decodable as a variant of this CHOICE?

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

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

impl<'a, T> Decode<'a> for T
where T: DecodeValue<'a> + FixedTag + 'a,

type Error = <T as DecodeValue<'a>>::Error

Type returned in the event of a decoding error.

fn decode<R>(reader: &mut R) -> Result<T, <T as DecodeValue<'a>>::Error>
where R: Reader<'a>,

Attempt to decode this TLV message using the provided decoder. Read more

fn from_der(bytes: &'a [u8]) -> Result<Self, Self::Error>

Parse Self from the provided DER-encoded byte slice. Read more

fn from_der_partial(bytes: &'a [u8]) -> Result<(Self, &'a [u8]), Self::Error>

Parse Self from the provided DER-encoded byte slice. Read more

impl<T> DecodeOwned for T
where T: for<'a> Decode<'a>,

impl<T> Encode for T
where T: EncodeValue + Tagged + ?Sized,

fn encoded_len(&self) -> Result<Length, Error>

Compute the length of this TLV object in bytes when encoded as ASN.1 DER. Read more

fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>

Encode this TLV object as ASN.1 DER using the provided Writer. Read more

fn encode_to_slice<'a>(&self, buf: &'a mut [u8]) -> Result<&'a [u8], Error>

Encode this TLV object to the provided byte slice, returning a sub-slice containing the encoded message. Read more

fn encode_to_vec(&self, buf: &mut Vec<u8>) -> Result<Length, Error>

Encode this TLV object as ASN.1 DER, appending it to the provided byte vector. Read more

fn to_der(&self) -> Result<Vec<u8>, Error>

Encode this TLV object as ASN.1 DER, returning a byte vector. Read more

impl<'a, S> FixedTag for S
where S: Sequence<'a>,

const TAG: Tag = Tag::Sequence

ASN.1 tag

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IsConstructed for T
where T: FixedTag + ?Sized,

const CONSTRUCTED: bool

ASN.1 constructed bit

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tagged for T
where T: FixedTag + ?Sized,

fn tag(&self) -> Tag

Get the ASN.1 tag that this type is encoded with.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.