Struct argon2::Config

pub struct Config<'a> {
    pub ad: &'a [u8],
    pub hash_length: u32,
    pub lanes: u32,
    pub mem_cost: u32,
    pub secret: &'a [u8],
    pub time_cost: u32,
    pub variant: Variant,
    pub version: Version,
}

Structure containing configuration settings.

Examples

use argon2::{Config, Variant, Version};

let config = Config::default();
assert_eq!(config.ad, &[]);
assert_eq!(config.hash_length, 32);
assert_eq!(config.lanes, 1);
assert_eq!(config.mem_cost, 19 * 1024);
assert_eq!(config.secret, &[]);
assert_eq!(config.time_cost, 2);
assert_eq!(config.variant, Variant::Argon2id);
assert_eq!(config.version, Version::Version13);

Fields

ad: &'a [u8]

The associated data.

hash_length: u32

The length of the resulting hash.

lanes: u32

The number of lanes.

mem_cost: u32

The amount of memory requested (KB).

secret: &'a [u8]

The key.

time_cost: u32

The number of passes.

variant: Variant

The variant.

version: Version

The version number.

Implementations

impl<'a> Config<'a>

pub fn original() -> Config<'a>

Default configuration used by the original C implementation.

pub fn owasp1() -> Config<'a>

OWASP recommended configuration with t=1 and 46 MiB memory.

pub fn owasp2() -> Config<'a>

OWASP recommended configuration with t=2 and 19 MiB memory.

pub fn owasp3() -> Config<'a>

OWASP recommended configuration with t=3 and 12 MiB memory.

pub fn owasp4() -> Config<'a>

OWASP recommended configuration with t=4 and 9 MiB memory.

pub fn owasp5() -> Config<'a>

OWASP recommended configuration with t=5 and 7 MiB memory.

pub fn rfc9106() -> Config<'a>

RFC9106 recommended configuration with t=1 and 2 GiB memory.

pub fn rfc9106_low_mem() -> Config<'a>

RFC9106 recommended configuration for memory-constrained environments.

Trait Implementations

impl<'a> Clone for Config<'a>

fn clone(&self) -> Config<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Config<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Config<'a>

fn default() -> Config<'a>

OWASP recommended configuration with t=2 and 19 MiB memory.

impl<'a> PartialEq for Config<'a>

fn eq(&self, other: &Config<'a>) -> 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<'a> StructuralPartialEq for Config<'a>