Struct PasswordHash 

pub struct PasswordHash(/* private fields */);

Available on crate feature password-hash only.

Password hash encoded in the Modular Crypt Format (MCF). Owned form with builder functionality.

Password hashes in this format take the form ${id}$..., where {id} is a short numeric or alphanumeric algorithm identifier optionally containing a -, followed by $ as a delimiter, further followed by an algorithm-specific serialization of a password hash, typically using a variant (often an algorithm-specific variant) of Base64. This algorithm-specific serialization contains one or more fields ${first}[${second}]..., where each field only uses characters in the regexp range [A-Za-z0-9./+=,\-].

Example (SHA-crypt w\ SHA-512):

$6$rounds=100000$exn6tVc2j/MZD8uG$BI1Xh8qQSK9J4m14uwy7abn.ctj/TIAzlaVCto0MQrOFIeTXsc1iwzH16XEWo/a7c7Y9eVJvufVzYAs4EsPOy0

Implementations

impl PasswordHash

pub fn new(s: impl Into<String>) -> Result<PasswordHash, Error>

Parse the given input string, returning an PasswordHash if valid.

pub fn as_password_hash_ref(&self) -> &PasswordHashRef

Borrow the contents of this password hash as a PasswordHashRef.

Similar conversions can be performed using AsRef, Borrow, and Deref, however this one is useful when the return type may be ambiguous and avoiding potential inference bugs is preferable.

pub fn from_id(id: &str) -> Result<PasswordHash, Error>

Create an PasswordHash from an identifier.

Returns

Error if the identifier is invalid.

Allowed characters match the regex: [a-z0-9\-], where the first and last characters do NOT contain a -.

pub fn push_base64(&mut self, field: &[u8], base64_encoding: Base64)

Available on crate feature base64 only.

Encode the given data as the specified variant of Base64 and push it onto the password hash string, first adding a $ delimiter.

pub fn push_displayable<D>(&mut self, displayable: D) -> Result<(), Error>

where D: Display,

Push a type which impls fmt::Display, first adding a $ delimiter and ensuring the added characters comprise a valid field.

pub fn push_field(&mut self, field: Field<'_>)

Push an additional field onto the password hash string, first adding a $ delimiter.

pub fn push_str(&mut self, s: &str) -> Result<(), Error>

Push a raw string onto the MCF hash, first adding a $ delimiter and also ensuring it validates as a Field.

Errors

• If the provided str fails to validate as a Field (i.e. contains characters outside the allowed set)

Methods from Deref<Target = PasswordHashRef>

pub fn as_str(&self) -> &str

Get the contained string as a str.

pub fn id(&self) -> &str

Get the algorithm identifier for this MCF hash.

pub fn fields(&self) -> Fields<'_>

Get an iterator over the parts of the password hash as delimited by $, excluding the initial identifier.

Trait Implementations

impl AsRef<PasswordHashRef> for PasswordHash

fn as_ref(&self) -> &PasswordHashRef

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for PasswordHash

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<PasswordHashRef> for PasswordHash

fn borrow(&self) -> &PasswordHashRef

Immutably borrows from an owned value.

impl Clone for PasswordHash

fn clone(&self) -> PasswordHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CustomizedPasswordHasher<PasswordHash> for Yescrypt

type Params = Params

Algorithm-specific parameters.

fn hash_password_customized( &self, password: &[u8], salt: &[u8], alg_id: Option<&str>, version: Option<Version>, params: Params, ) -> Result<PasswordHash>

Compute a [PasswordHash] from the provided password using an explicit set of customized algorithm parameters as opposed to the defaults.

fn hash_password_with_params( &self, password: &[u8], salt: &[u8], params: Self::Params, ) -> Result<H, Error>

Compute a [PasswordHash] using customized parameters only, using the default algorithm and version.

impl Debug for PasswordHash

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

Formats the value using the given formatter.

impl Deref for PasswordHash

type Target = PasswordHashRef

The resulting type after dereferencing.

fn deref(&self) -> &PasswordHashRef

Dereferences the value.

impl Display for PasswordHash

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

Formats the value using the given formatter.

impl<'a> From<&'a PasswordHash> for &'a PasswordHashRef

fn from(hash: &'a PasswordHash) -> &'a PasswordHashRef

Converts to this type from the input type.

impl From<&PasswordHashRef> for PasswordHash

fn from(hash: &PasswordHashRef) -> PasswordHash

Converts to this type from the input type.

impl FromStr for PasswordHash

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PasswordHash, Error>

Parses a string s to return a value of this type.

impl Ord for PasswordHash

fn cmp(&self, other: &PasswordHash) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PasswordHash

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PasswordHash

fn partial_cmp(&self, other: &PasswordHash) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PasswordHasher<PasswordHash> for Yescrypt

fn hash_password_with_salt( &self, password: &[u8], salt: &[u8], ) -> Result<PasswordHash>

Compute the hash H from the given password and salt, potentially using configuration stored in &self for the parameters, or otherwise the recommended defaults.

fn hash_password(&self, password: &[u8]) -> Result<H, Error>

Available on crate feature getrandom only.

Compute the hash H from the given password, potentially using configuration stored in &self for the parameters, or otherwise the recommended defaults.

fn hash_password_with_rng<R>( &self, rng: &mut R, password: &[u8], ) -> Result<H, Error>

where R: TryCryptoRng + ?Sized,

Available on crate feature rand_core only.

Compute the hash H from the given password, potentially using configuration stored in &self for the parameters, or otherwise the recommended defaults.

impl PasswordVerifier<PasswordHash> for Yescrypt

fn verify_password(&self, password: &[u8], hash: &PasswordHash) -> Result<()>

Compute this password hashing function against the provided password using the parameters from the provided password hash and see if the computed output matches.

impl TryFrom<&str> for PasswordHash

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<PasswordHash, Error>

Performs the conversion.

impl TryFrom<String> for PasswordHash

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<PasswordHash, Error>

Performs the conversion.

impl Eq for PasswordHash

impl StructuralPartialEq for PasswordHash