Struct mini_functions::hash::models::hash::Hash

#[non_exhaustive]
pub struct Hash {
    pub hash: Vec<u8>,
    pub salt: Vec<u8>,
    pub algorithm: HashAlgorithm,
}

A struct for storing and verifying hashed passwords. It uses #[non_exhaustive] and derive macros for common functionalities.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hash: Vec<u8>

The password hash.

salt: Vec<u8>

The salt used for hashing.

algorithm: HashAlgorithm

The hash algorithm used.

Implementations

impl Hash

pub fn new_argon2i(password: &str, salt: Vec<u8>) -> Result<Hash, String>

Creates a new Hash instance using Argon2i algorithm for password hashing.

Example

use hsh::models::hash::{Hash, Salt};

let password = "my_password";
let salt: Salt = vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9];

let result = Hash::new_argon2i(password, salt);
match result {
    Ok(hash) => println!("Successfully created Argon2i hash"),
    Err(e) => println!("An error occurred: {}", e),
}

pub fn new_bcrypt(password: &str, cost: u32) -> Result<Hash, String>

Creates a new Hash instance using Bcrypt algorithm for password hashing.

Example

use hsh::models::hash::Hash;

let password = "my_password";
let cost: u32 = 16;

let result = Hash::new_bcrypt(password, cost);
match result {
    Ok(hash) => println!("Successfully created Bcrypt hash"),
    Err(e) => println!("An error occurred: {}", e),
}

pub fn new_scrypt(password: &str, salt: Vec<u8>) -> Result<Hash, String>

Creates a new Hash instance using Scrypt algorithm for password hashing.

Example

use hsh::models::hash::{Hash, Salt};

let password = "my_password";
let salt: Salt = vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9];

let result = Hash::new_scrypt(password, salt);
match result {
    Ok(hash) => println!("Successfully created Scrypt hash"),
    Err(e) => println!("An error occurred: {}", e),
}

pub fn algorithm(&self) -> HashAlgorithm

A function that returns the hash algorithm used by the hash map.

pub fn from_hash(hash: &[u8], algo: &str) -> Result<Hash, String>

A function that creates a new hash object from a hash value and a hash algorithm.

pub fn from_string(hash_str: &str) -> Result<Hash, String>

A function that creates a new hash object from a hash string in the format algorithm$salt$hash.

pub fn generate_hash( password: &str, salt: &str, algo: &str ) -> Result<Vec<u8>, String>

A function that generates a hash value for a password using the specified hash algorithm. The function takes three arguments:

• password: The password to be hashed.
• salt: A random string used to make the hash value unique.
• algo: The name of the hash algorithm to use.

The function returns a Result object containing the hash value if successful, or an error message if unsuccessful.

pub fn generate_random_string(len: usize) -> String

A function that generates a random string of the specified length.

pub fn generate_salt(algo: &str) -> Result<String, String>

A function that generates a random salt for a password using the specified hash algorithm.

pub fn hash(&self) -> &[u8]

A function that returns the hash value of a hash object.

pub fn hash_length(&self) -> usize

A function that returns the length of the hash value of a hash object.

pub fn new(password: &str, salt: &str, algo: &str) -> Result<Hash, String>

A function that creates a new hash object from a password, salt, and hash algorithm.

pub fn parse(input: &str) -> Result<Hash, Box<dyn Error>>

A function that parses a JSON string into a hash object.

pub fn parse_algorithm(hash_str: &str) -> Result<HashAlgorithm, String>

A function that parses a hash string into a hash algorithm.

pub fn salt(&self) -> &[u8]

A function that returns the salt used to hash a password.

pub fn set_hash(&mut self, hash: &[u8])

A function that sets the hash value of a hash object.

pub fn set_password( &mut self, password: &str, salt: &str, algo: &str ) -> Result<(), String>

A function that sets the password of a hash object.

pub fn set_salt(&mut self, salt: &[u8])

A function that sets the salt of a hash object.

pub fn to_string_representation(&self) -> String

A function that converts a hash object to a string representation.

pub fn verify(&self, password: &str) -> Result<bool, &'static str>

A function that verifies a password against a hash object.

Trait Implementations

impl Clone for Hash

fn clone(&self) -> Hash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hash

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Hash

fn deserialize<__D>( __deserializer: __D ) -> Result<Hash, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Hash

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

Formats the value using the given formatter.

impl Hash for Hash

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

where __H: Hasher,

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 Hash

fn cmp(&self, other: &Hash) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Hash

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Hash

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Hash

impl StructuralEq for Hash

impl StructuralPartialEq for Hash