Struct Password 

pub struct Password {
    pub phc: String,
    /* private fields */
}

A safely constructed Password

Fields

phc: String

Implementations

impl Password

pub fn new(phc: &str) -> ResultPwd<Self>

Load a password from a PCH formatted string. (Use this for load from a Storage)

pub fn hash(raw: &str, check: impl PasswordIsSafe) -> ResultPwd<Self>

Hash a raw string into a PCH salted string using recommended algorithm (argon2::Argon2 as 2021) and verify is safe using a checker

pub unsafe fn hash_unsafe(raw: &str) -> ResultPwd<Self>

Hash a raw string into a PCH salted string using recommended algorithm (argon2::Argon2 as 2021)

Safety

This is marked unsafe because allow to use empty string, short password, leaked passwords, etc use Self::hash and prove the password is safe instead

Available because is useful for testing or for provide a way to upgrade later to a strong password.

pub fn hash_argon(raw: &str, check: impl PasswordIsSafe) -> ResultPwd<Self>

Hash a raw string into a PCH salted string using argon2::Argon2 and verify is safe using a checker

pub unsafe fn hash_argon_unsafe(raw: &str) -> ResultPwd<Self>

Hash a raw string into a PCH salted string using argon2::Argon2

Safety

Check comment on Self::hash_unsafe

pub fn get_hash(&self) -> PasswordHash<'_>

Return the constructed hash_unsafe from the internal String

Safety

At this point the internal string is always a correct PHC in the defined PasswordAlgo

pub fn validate_password(&self, against: &str) -> Result<(), PasswordError>

Check if this password match a raw &str

Examples

use forbidden::prelude::*;

let p = unsafe{ Password::hash_unsafe("hi").unwrap() };
// Verify if the password match...
assert!(p.validate_password("hi").is_ok());

//Also can be used with equality in case you don't care for the error causes of not matching:
assert_eq!(p, "hi");

pub fn salt() -> SaltString

A salted string that can be used for hashing passwords

Trait Implementations

impl Clone for Password

fn clone(&self) -> Password

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Password

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

Formats the value using the given formatter.

impl Display for Password

When using Display trait, not allow to leak the details of the Password

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

Formats the value using the given formatter.

impl FromStr for Password

type Err = PasswordError

The associated error which can be returned from parsing.

fn from_str(phc: &str) -> Result<Self, Self::Err>

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

impl Hash for Password

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Password

fn cmp(&self, other: &Password) -> 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<&str> for Password

fn eq(&self, other: &&str) -> 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 PartialEq for Password

fn eq(&self, other: &Password) -> 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 Password

fn partial_cmp(&self, other: &Password) -> 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 Eq for Password

impl StructuralPartialEq for Password