Struct PasswordHash 

pub struct PasswordHash {
    pub algorithm: Ident,
    pub version: Option<u32>,
    pub params: ParamsString,
    pub salt: Option<Salt>,
    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

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<u32>

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>

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 PasswordHash

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

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

pub fn serialize(&self) -> PasswordHashString

👎Deprecated since 0.3.0:

Use PasswordHash or String instead

DEPRECATED: serialize this PasswordHash as a PasswordHashString.

Trait Implementations

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 Argon2<'_>

Available on crate features alloc and password-hash only.

type Params = Params

Algorithm-specific parameters.

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

Compute a password hash 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 password hash 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 Display for PasswordHash

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

Formats the value using the given formatter.

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 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 PasswordHasher<PasswordHash> for Argon2<'_>

Available on crate features alloc and password-hash only.

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>

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

impl<T> PasswordVerifier<PasswordHash> for T

where T: CustomizedPasswordHasher<PasswordHash>, <T as CustomizedPasswordHasher<PasswordHash>>::Params: for<'a> TryFrom<&'a PasswordHash, Error = Error>,

Available on crate feature phc only.

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

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<&PasswordHash> for Params

Available on crate feature password-hash only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(hash: &PasswordHash) -> Result<Self>

Performs the conversion.

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 Eq for PasswordHash

impl StructuralPartialEq for PasswordHash