Argon2

Struct Argon2 

Source
pub struct Argon2 {
    pub m_cost: u32,
    pub t_cost: u32,
    pub p_cost: u32,
    pub hash_length: u64,
    pub algorithm: Algorithm,
    pub version: Version,
}
Expand description

Argon2 instance

§Parameters

  • m_cost - The memory cost in kibibytes
  • t_cost - Iteration cost
  • p_cost - Parallelization
  • hash_length - The length of the hash in bytes
  • algorithm - The algorithm to use
  • version - The version of the algorithm to use

By default it will use the Argon2id with a 64 byte hash length (maximum).

It is not recomended to change them, the default values are fine for most use cases.

Generally speaking you don’t want to mess with the t_cost and p_cost parameters a lot. For max security the p_cost should be set to 1 and the t_cost could be anything between 8 and 30. That also depends on the m_cost which is the most important parameter. The higher the m_cost the more secure the hash is but the time it takes to compute it increases linearly.

§Presets

There are some presets for the Argon2 struct that you can use.

  • Argon2::very_fast()
  • Argon2::fast()
  • Argon2::balanced()
  • Argon2::slow()
  • Argon2::very_slow()

Fields§

§m_cost: u32§t_cost: u32§p_cost: u32§hash_length: u64§algorithm: Algorithm

By default we use the Argon2id

§version: Version

By default we use the version 0x13

Implementations§

Source§

impl Argon2

Source

pub fn new(m_cost: u32, t_cost: u32, p_cost: u32) -> Self

Create a new Argon2 instance with the given parameters.

By default it will use the Argon2id with a 64 byte hash length.

§Arguments
  • m_cost - The memory cost in kibibytes
  • t_cost - Iteration cost
  • p_cost - Parallelization
Source

pub fn with_algorithm(self, algorithm: Algorithm) -> Self

Source

pub fn with_version(self, version: Version) -> Self

Source

pub fn with_hash_length(self, hash_length: u64) -> Self

Source

pub fn hash_password( &self, password: &str, salt: Vec<u8>, ) -> Result<Vec<u8>, Error>

Hashes the given password

§Arguments
  • password - The password to hash
  • salt - The salt to use for hashing
§Returns

The hash of the password in its raw byte form

Source§

impl Argon2

Source

pub fn very_fast() -> Self

Source

pub fn fast() -> Self

Source

pub fn balanced() -> Self

Source

pub fn slow() -> Self

Source

pub fn very_slow() -> Self

Trait Implementations§

Source§

impl Clone for Argon2

Source§

fn clone(&self) -> Argon2

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Argon2

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Argon2

Source§

fn default() -> Argon2

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Argon2

§

impl RefUnwindSafe for Argon2

§

impl Send for Argon2

§

impl Sync for Argon2

§

impl Unpin for Argon2

§

impl UnwindSafe for Argon2

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.