Struct orion::pwhash::PasswordHash

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

A type to represent the PasswordHash that PBKDF2 returns when used for password hashing.

A PasswordHash's first 64 bytes are the salt used to hash the password, and the last 64 bytes are the actual password hash.

Errors:

An error will be returned if:

• slice is not 128 bytes.

Security:

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

• The trait PartialEq<&'_ [u8]> is implemented for this type so that users are not tempted to call unprotected_as_bytes to compare this sensitive value to a byte slice. The trait is implemented in such a way that the comparison happens in constant time. Thus, users should prefer SecretType == &[u8] over SecretType.unprotected_as_bytes() == &[u8]. Examples are shown below. The examples apply to any type that implements PartialEq<&'_ [u8]>.

use orion::hazardous::mac::hmac::Tag;

// Initialize an arbitrary, 64-byte tag.
let tag = Tag::from_slice(&[1; 64])?;

// Secure, constant-time comparison with a byte slice
assert!(tag == &[1; 64][..]);

// Secure, constant-time comparison with another Tag
assert!(tag == Tag::from_slice(&[1; 64])?);

Methods

impl PasswordHash

#[must_use] pub fn from_slice(slice: &[u8]) -> Result<PasswordHash, 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.

Trait Implementations

impl Clone for PasswordHash

fn clone(&self) -> PasswordHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PasswordHash

impl Debug for PasswordHash

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

Formats the value using the given formatter.

impl From<[u8; 128]> for PasswordHash

fn from(bytes: [u8; 128]) -> PasswordHash

Make an object from a byte array.

impl<'_> PartialEq<&'_ [u8]> for PasswordHash

fn eq(&self, other: &&[u8]) -> 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 PartialEq<PasswordHash> for PasswordHash

fn eq(&self, other: &PasswordHash) -> 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 !=.