Struct orion::kdf::Password

#[must_use]
pub struct Password { /* fields omitted */ }

A type to represent the Password that PBKDF2 hashes and uses for key derivation.

As default it will randomly generate a Password of 32 bytes.

Errors:

An error will be returned if:

• slice is empty.
• length is 0.
• length is not less than u32::max_value().

Panics:

A panic will occur if:

• The OsRng fails to initialize or read from its source.

Security:

• Avoid using unprotected_as_bytes() whenever possible, as it breaks all protections that the type implements.

Methods

impl Password

#[must_use]

pub fn from_slice(slice: &[u8]) -> Result<Password, UnknownCryptoError>

Make an object from a given byte slice.

#[must_use]

pub fn unprotected_as_bytes(&self) -> &[u8]

Return the object as byte slice. Warning: Should not be used unless strictly needed. This breaks protections that the type implements.

pub fn get_length(&self) -> usize

Return the length of the object.

#[must_use]

pub fn generate(length: usize) -> Result<Password, UnknownCryptoError>

Randomly generate using a CSPRNG. Not available in no_std context.

Trait Implementations

impl Drop for Password

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Password> for Password

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Default for Password

#[must_use]

fn default() -> Password

Randomly generate using a CSPRNG with recommended size. Not available in no_std context.

impl Debug for Password

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

Formats the value using the given formatter.