Struct PasswordHash

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

A hashed password.

This is used to store a hashed user password in the database. The password hash is created using the password_auth crate internally, so by default, it generates the hash using the latest recommended algorithm.

Security

The implementation of the Debug trait for this type hides the password hash value to prevent it from being leaked in logs or other debug output.

There is no PartialEq implementation for this type, as it should never be needed to compare password hashes directly. Instead, use the verify method to verify a password against the hash.

Implementations

impl PasswordHash

pub fn new<T: Into<String>>(hash: T) -> Result<Self>

Creates a new password hash object from a string.

Note that this method takes the hash directly. If you need to hash a password, use PasswordHash::from_password instead.

Examples

use cot::auth::{Password, PasswordHash};

let hash = PasswordHash::from_password(&Password::new("password"));
let stored_hash = hash.into_string();
let hash = PasswordHash::new(stored_hash).unwrap();

Errors

Returns an error if the password hash is invalid.

pub fn from_password(password: &Password) -> Self

Creates a new password hash from a password.

The password is hashed using the latest recommended algorithm.

Examples

use cot::auth::{Password, PasswordHash};

let hash = PasswordHash::from_password(&Password::new("password"));

pub fn verify(&self, password: &Password) -> PasswordVerificationResult

Verifies a password against the hash.

• If the password is valid, returns PasswordVerificationResult::Ok.
• If the password is valid but the hash is obsolete, returns PasswordVerificationResult::OkObsolete with the new hash calculated with the currently preferred algorithm. The new hash should be saved to the database.
• If the password is invalid, returns PasswordVerificationResult::Invalid.

Examples

use cot::auth::{Password, PasswordHash, PasswordVerificationResult};

let password = Password::new("password");
let hash = PasswordHash::from_password(&password);

match hash.verify(&password) {
    PasswordVerificationResult::Ok => println!("Password is valid"),
    PasswordVerificationResult::OkObsolete(new_hash) => println!(
        "Password is valid, but the hash is obsolete. Save the new hash: {}",
        new_hash.as_str()
    ),
    PasswordVerificationResult::Invalid => println!("Password is invalid"),
}

pub fn as_str(&self) -> &str

Returns the password hash as a string.

For security reasons, you should avoid using this method as much as possible. Typically, you should use the PasswordHash::verify() method to verify a password against the hash. This method is mostly useful for persisting the password hash externally.

Examples

use cot::auth::{Password, PasswordHash};

let hash = PasswordHash::from_password(&Password::new("password"));
assert!(!hash.as_str().is_empty());

pub fn into_string(self) -> String

Consumes the object and returns the password hash as a string.

For security reasons, you should avoid using this method as much as possible. Typically, you should use the PasswordHash::verify() method to verify a password against the hash. This method is mostly useful for persisting the password hash externally.

Examples

use cot::auth::{Password, PasswordHash};

let hash = PasswordHash::from_password(&Password::new("password"));
assert!(!hash.into_string().is_empty());

Trait Implementations

impl AsFormField for PasswordHash

type Type = PasswordField

The form field type associated with the field.

fn clean_value(field: &Self::Type) -> Result<Self, FormFieldValidationError>

Validates the value of the field and converts it to the final type. This method should return an error if the value is invalid.

fn to_field_value(&self) -> String

Returns self as a value that can be set with FormField::set_value.

fn new_field( options: FormFieldOptions, custom_options: <Self::Type as FormField>::CustomOptions, ) -> Self::Type

Creates a new form field with the given options and custom options.

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

Available on crate feature db only.

const TYPE: ColumnType

The type of the column in the database as one of the variants of the ColumnType enum.

const NULLABLE: bool = false

Whether the field can be NULL in the database.

impl Debug for PasswordHash

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

Formats the value using the given formatter.

impl FromDbValue for PasswordHash

Available on crate feature db only.

fn from_sqlite(value: SqliteValueRef<'_>) -> Result<Self>

Available on crate feature sqlite only.

Converts the given SQLite database value to a Rust value.

fn from_postgres(value: PostgresValueRef<'_>) -> Result<Self>

Available on crate feature postgres only.

Converts the given PostgreSQL database value to a Rust value.

fn from_mysql(value: MySqlValueRef<'_>) -> Result<Self>

where Self: Sized,

Available on crate feature mysql only.

Converts the given MySQL database value to a Rust value.

impl ToDbValue for PasswordHash

Available on crate feature db only.

fn to_db_value(&self) -> DbValue

Converts the Rust value to a sea_query value.

impl TryFrom<String> for PasswordHash

type Error = AuthError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.