Struct Hash

pub struct Hash {
    pub alg: Algorithm,
    pub mem_cost_kib: u32,
    pub iterations: u32,
    pub threads: u32,
    pub salt: Vec<u8>,
    pub hash: Vec<u8>,
}

A container for an Argon2 hash, the corresponding salt, and the parameters used for hashing

Fields

alg: Algorithm

The algorithm used for hashing (Argon2d, Argon2i, or Argon2id)

mem_cost_kib: u32

The memory cost in kibibytes

iterations: u32

The number of iterations used for hashing

threads: u32

The number of threads used for hashing

salt: Vec<u8>

The salt used to generate the hash

hash: Vec<u8>

The hash in bytes

Implementations

impl Hash

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

Returns a reference to a byte slice of the computed hash/key.

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

Returns a reference to a byte slice of the salt used to generate the hash.

pub fn algorithm(&self) -> Algorithm

Returns the algorithm used to generate the hash.

pub fn memory_cost_kib(&self) -> u32

Returns the memory cost used to generate the hash.

pub fn iterations(&self) -> u32

Returns the number of iterations used to generate the hash.

pub fn threads(&self) -> u32

Returns the number of threads used to generate the hash.

pub fn verify(&self, password: &[u8]) -> bool

Checks if the hash matches the provided password.

Because verification requires re-hashing the password, this is an expensive operation. For some appliations, it might make sense to move this operation to a separate thread using std::thread or something like the Rayon crate to avoid blocking main threads.

pub fn verify_with_secret(&self, password: &[u8], secret: Secret<'_>) -> bool

Checks if the hash matches the provided password using the provided secret.

Because verification requires re-hashing the password, this is an expensive operation. For some appliations, it might make sense to move this operation to a separate thread using std::thread or something like the Rayon crate to avoid blocking main threads.

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

Formats the value using the given formatter.

impl FromStr for Hash

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

Deserializes a hash string into parts (e.g. the hash, the salt, parameters) that can be used for purposes such as verification or encryption.

A hash string looks something like this:

$argon2id$v=19$m=62500,t=18,p=2$AQIDBAUGBwg$ypJ3pKxN4aWGkwMv0TOb08OIzwrfK1SZWy64vyTLKo8

type Err = Argon2Error

The associated error which can be returned from parsing.

impl ToString for Hash

fn to_string(&self) -> String

Generates a hash string. Aside from the hash, the hash string also includes the salt and paramters used to generate the hash, making it easy to store in a database or a cache. This string is formatted to a standard shared by most implementations of argon2, so other argon2 libraries should be able to use this hash string.

A hash string looks something like this:

$argon2id$v=19$m=62500,t=18,p=2$AQIDBAUGBwg$ypJ3pKxN4aWGkwMv0TOb08OIzwrfK1SZWy64vyTLKo8