1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
// Copyright (c) 2017 Martijn Rijkeboer <[email protected]>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use crate::variant::Variant;
use crate::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, 2 * 1024 * 1024);
/// assert_eq!(config.secret, &[]);
/// assert_eq!(config.time_cost, 1);
/// assert_eq!(config.variant, Variant::Argon2id);
/// assert_eq!(config.version, Version::Version13);
/// ```
#[derive(Clone, Debug, PartialEq)]
pub struct Config<'a> {
/// The associated data.
pub ad: &'a [u8],
/// The length of the resulting hash.
pub hash_length: u32,
/// The number of lanes.
pub lanes: u32,
/// The amount of memory requested (KB).
pub mem_cost: u32,
/// The key.
pub secret: &'a [u8],
/// The number of passes.
pub time_cost: u32,
/// The variant.
pub variant: Variant,
/// The version number.
pub version: Version,
}
impl<'a> Config<'a> {
/// Default configuration used by the original C implementation.
pub fn original() -> Config<'a> {
Config {
ad: &[],
hash_length: 32,
lanes: 1,
mem_cost: 4096,
secret: &[],
time_cost: 3,
variant: Variant::Argon2i,
version: Version::Version13,
}
}
/// RFC9106 recommended configuration with t=1 and 2 GiB memory.
pub fn rfc9106() -> Config<'a> {
Config {
ad: &[],
hash_length: 32,
lanes: 1,
mem_cost: 2097152,
secret: &[],
time_cost: 1,
variant: Variant::Argon2id,
version: Version::Version13,
}
}
/// RFC9106 recommended configuration for memory-constrained environments.
pub fn rfc9106_low_mem() -> Config<'a> {
Config {
ad: &[],
hash_length: 32,
lanes: 1,
mem_cost: 65536,
secret: &[],
time_cost: 3,
variant: Variant::Argon2id,
version: Version::Version13,
}
}
}
impl<'a> Default for Config<'a> {
/// RFC9106 recommended configuration with t=1 and 2 GiB memory.
fn default() -> Config<'a> {
Config::rfc9106()
}
}
#[cfg(test)]
mod tests {
use crate::config::Config;
use crate::variant::Variant;
use crate::version::Version;
#[test]
fn default_returns_correct_instance() {
let config = Config::default();
assert_eq!(config.ad, &[]);
assert_eq!(config.hash_length, 32);
assert_eq!(config.lanes, 1);
assert_eq!(config.mem_cost, 2 * 1024 * 1024);
assert_eq!(config.secret, &[]);
assert_eq!(config.time_cost, 1);
assert_eq!(config.variant, Variant::Argon2id);
assert_eq!(config.version, Version::Version13);
}
#[test]
fn original_returns_correct_instance() {
let config = Config::original();
assert_eq!(config.ad, &[]);
assert_eq!(config.hash_length, 32);
assert_eq!(config.lanes, 1);
assert_eq!(config.mem_cost, 4096);
assert_eq!(config.secret, &[]);
assert_eq!(config.time_cost, 3);
assert_eq!(config.variant, Variant::Argon2i);
assert_eq!(config.version, Version::Version13);
}
#[test]
fn rfc9106_returns_correct_instance() {
let config = Config::rfc9106();
assert_eq!(config.ad, &[]);
assert_eq!(config.hash_length, 32);
assert_eq!(config.lanes, 1);
assert_eq!(config.mem_cost, 2 * 1024 * 1024);
assert_eq!(config.secret, &[]);
assert_eq!(config.time_cost, 1);
assert_eq!(config.variant, Variant::Argon2id);
assert_eq!(config.version, Version::Version13);
}
#[test]
fn rfc9106_low_mem_returns_correct_instance() {
let config = Config::rfc9106_low_mem();
assert_eq!(config.ad, &[]);
assert_eq!(config.hash_length, 32);
assert_eq!(config.lanes, 1);
assert_eq!(config.mem_cost, 64 * 1024);
assert_eq!(config.secret, &[]);
assert_eq!(config.time_cost, 3);
assert_eq!(config.variant, Variant::Argon2id);
assert_eq!(config.version, Version::Version13);
}
}