Struct password_hash::PasswordHash

pub struct PasswordHash<'a> {
    pub algorithm: Ident<'a>,
    pub version: Option<Decimal>,
    pub params: ParamsString,
    pub salt: Option<Salt<'a>>,
    pub hash: Option<Output>,
}

Password hash.

This type corresponds to the parsed representation of a PHC string as described in the PHC string format specification.

PHC strings have the following format:

$<id>[$v=<version>][$<param>=<value>(,<param>=<value>)*][$<salt>[$<hash>]]

where:

• <id> is the symbolic name for the function
• <version> is the algorithm version
• <param> is a parameter name
• <value> is a parameter value
• <salt> is an encoding of the salt
• <hash> is an encoding of the hash output

The string is then the concatenation, in that order, of:

• a $ sign;
• the function symbolic name;
• optionally, a $ sign followed by the algorithm version with a v=version format;
• optionally, a $ sign followed by one or several parameters, each with a name=value format; the parameters are separated by commas;
• optionally, a $ sign followed by the (encoded) salt value;
• optionally, a $ sign followed by the (encoded) hash output (the hash output may be present only if the salt is present).

Fields

algorithm: Ident<'a>

Password hashing algorithm identifier.

This corresponds to the <id> field in a PHC string, a.k.a. the symbolic name for the function.

version: Option<Decimal>

Optional version field.

This corresponds to the <version> field in a PHC string.

params: ParamsString

Algorithm-specific parameters.

This corresponds to the set of $<param>=<value>(,<param>=<value>)* name/value pairs in a PHC string.

salt: Option<Salt<'a>>

Salt string for personalizing a password hash output.

This corresponds to the <salt> value in a PHC string.

hash: Option<Output>

Password hashing function Output, a.k.a. hash/digest.

This corresponds to the <hash> output in a PHC string.

Implementations

impl<'a> PasswordHash<'a>

pub fn new(s: &'a str) -> Result<Self>

Parse a password hash from a string in the PHC string format.

pub fn parse(s: &'a str, encoding: Encoding) -> Result<Self>

Parse a password hash from the given Encoding.

pub fn generate( phf: impl PasswordHasher, password: impl AsRef<[u8]>, salt: impl Into<Salt<'a>>, ) -> Result<Self>

Generate a password hash using the supplied algorithm.

pub fn verify_password( &self, phfs: &[&dyn PasswordVerifier], password: impl AsRef<[u8]>, ) -> Result<()>

Verify this password hash using the specified set of supported PasswordHasher trait objects.

pub fn encoding(&self) -> Encoding

Get the Encoding that this PasswordHash is serialized with.

pub fn serialize(&self) -> PasswordHashString

Available on crate feature alloc only.

Serialize this PasswordHash as a PasswordHashString.

Trait Implementations

impl<'a> Clone for PasswordHash<'a>

fn clone(&self) -> PasswordHash<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PasswordHash<'a>

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

Formats the value using the given formatter.

impl<'a> Display for PasswordHash<'a>

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

Formats the value using the given formatter.

impl From<&PasswordHash<'_>> for PasswordHashString

Available on crate feature alloc only.

fn from(hash: &PasswordHash<'_>) -> PasswordHashString

Converts to this type from the input type.

impl From<PasswordHash<'_>> for PasswordHashString

Available on crate feature alloc only.

fn from(hash: PasswordHash<'_>) -> PasswordHashString

Converts to this type from the input type.

impl<'a> PartialEq for PasswordHash<'a>

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

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

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

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

impl<'a> TryFrom<&'a str> for PasswordHash<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self>

Performs the conversion.

impl<'a> Eq for PasswordHash<'a>

impl<'a> StructuralPartialEq for PasswordHash<'a>

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 240 bytes