Struct argon2::Argon2

pub struct Argon2<'key> { /* fields omitted */ }

Argon2 context.

Holds the following Argon2 inputs:

• output array and its length,
• password and its length,
• salt and its length,
• secret and its length,
• associated data and its length,
• number of passes, amount of used memory (in KBytes, can be rounded up a bit)
• number of parallel threads that will be run.

All the parameters above affect the output hash value. Additionally, two function pointers can be provided to allocate and deallocate the memory (if NULL, memory will be allocated internally). Also, three flags indicate whether to erase password, secret as soon as they are pre-hashed (and thus not needed anymore), and the entire memory

Simplest situation: you have output array out[8], password is stored in pwd[32], salt is stored in salt[16], you do not have keys nor associated data.

You need to spend 1 GB of RAM and you run 5 passes of Argon2d with 4 parallel lanes.

You want to erase the password, but you’re OK with last pass not being erased.

Implementations

impl<'key> Argon2<'key>

pub fn new(
    secret: Option<&'key [u8]>,
    t_cost: u32,
    m_cost: u32,
    parallelism: u32,
    version: Version
) -> Result<Self, Error>

Create a new Argon2 context.

pub fn hash_password_into(
    &self,
    alg: Algorithm,
    pwd: &[u8],
    salt: &[u8],
    ad: &[u8],
    out: &mut [u8]
) -> Result<(), Error>

Hash a password and associated parameters into the provided output buffer.

pub fn params(&self) -> Params

Get default configured Params.

Trait Implementations

impl<'key> Clone for Argon2<'key>

fn clone(&self) -> Argon2<'key>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Argon2<'_>

fn default() -> Self

Returns the “default value” for a type.

impl PasswordHasher for Argon2<'_>

This is supported on crate feature password-hash only.

type Params = Params

Algorithm-specific parameters.

fn hash_password_simple<'a, S: ?Sized>(
    &self,
    password: &[u8],
    salt: &'a S
) -> Result<PasswordHash<'a>> where
    S: AsRef<str> + ?Sized, 

Simple API for computing a PasswordHash from a password and Salt value.

fn hash_password<'a>(
    &self,
    password: &[u8],
    alg_id: Option<Ident<'a>>,
    params: Params,
    salt: impl Into<Salt<'a>>
) -> Result<PasswordHash<'a>>

Compute a PasswordHash with the given algorithm Ident (or None for the recommended default), password, salt, and parameters.