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
|
// Copyright (c) 2017 Martijn Rijkeboer <mrr@sru-systems.com>
//
// 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 super::common;
use super::thread_mode::ThreadMode;
use super::variant::Variant;
use super::version::Version;
/// Structure containing configuration settings.
///
/// # Examples
///
/// ```
/// use argon2::{Config, ThreadMode, 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, 4096);
/// assert_eq!(config.secret, &[]);
/// assert_eq!(config.thread_mode, ThreadMode::Sequential);
/// assert_eq!(config.time_cost, 3);
/// assert_eq!(config.variant, Variant::Argon2i);
/// 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 thread mode.
pub thread_mode: ThreadMode,
/// The number of passes.
pub time_cost: u32,
/// The variant.
pub variant: Variant,
/// The version number.
pub version: Version,
}
impl<'a> Config<'a> {
pub fn uses_sequential(&self) -> bool {
self.thread_mode == ThreadMode::Sequential || self.lanes == 1
}
}
impl<'a> Default for Config<'a> {
fn default() -> Config<'a> {
Config {
ad: &[],
hash_length: common::DEF_HASH_LENGTH,
lanes: common::DEF_LANES,
mem_cost: common::DEF_MEMORY,
secret: &[],
thread_mode: ThreadMode::default(),
time_cost: common::DEF_TIME,
variant: Variant::default(),
version: Version::default(),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use variant::Variant;
use 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, 4096);
assert_eq!(config.secret, &[]);
assert_eq!(config.thread_mode, ThreadMode::Sequential);
assert_eq!(config.time_cost, 3);
assert_eq!(config.variant, Variant::Argon2i);
assert_eq!(config.version, Version::Version13);
}
}
|
