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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
use lazy_static;
use ring::rand::SecureRandom;
use ring::{hkdf, rand};
use serde_mcf;
use serde_yaml;
use super::HashUpdate;
use errors::{ExpectReport, Result};
use hashing::{Algorithm, Output};
use key;
use primitives::{self, Primitive};
use std::default::Default;
use std::fmt;
use std::fs::File;
use std::io::BufReader;
use std::path::Path;
use std::sync::{Arc, Mutex};
lazy_static! {
pub static ref RANDOMNESS_SOURCE: rand::SystemRandom = {
lazy_static::initialize(&RAND_BACKUP);
rand::SystemRandom::new()
};
static ref RAND_BACKUP: Arc<Mutex<BackupPrng>> = {
let rng = rand::SystemRandom::new();
let mut seed = [0_u8; 32];
let mut salt_key_value = [0_u8; 32];
rng.fill(&mut seed).expect("could not generate any randomness");
rng.fill(&mut salt_key_value).expect("could not generate any randomness");
Arc::new(Mutex::new(BackupPrng {
salt: hkdf::Salt::new(hkdf::HKDF_SHA256, &salt_key_value[..]),
seed,
}))
};
pub static ref DEFAULT_PRIM: Primitive = {
primitives::Scrypt::default()
};
pub static ref DEFAULT_ALG: Algorithm = {
Algorithm::Single(DEFAULT_PRIM.clone())
};
pub static ref DEFAULT_CONFIG: Config = {
Config::default()
};
}
#[derive(Debug, Deserialize, Serialize)]
pub struct Config {
#[serde(skip)]
algorithm: Algorithm,
#[serde(default = "primitives::Scrypt::default")]
primitive: Primitive,
keyed: Option<Primitive>,
#[serde(skip, default = "key::get_global")]
keys: &'static dyn key::Store,
}
impl Default for Config {
fn default() -> Self {
Self {
algorithm: DEFAULT_ALG.clone(),
primitive: DEFAULT_PRIM.clone(),
keyed: None,
keys: key::get_global(),
}
}
}
impl fmt::Display for Config {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str(&serde_yaml::to_string(&self).map_err(|_| fmt::Error)?)
}
}
impl Config {
#[must_use]
pub fn with_primitive(primitive: Primitive) -> Self {
Self {
algorithm: Algorithm::Single(primitive.clone()),
primitive,
keyed: None,
keys: key::get_global(),
}
}
pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self> {
let file = File::open(path.as_ref());
if let Ok(file) = file {
let reader = BufReader::new(file);
let mut config: Self = serde_yaml::from_reader(reader).expect("invalid config file");
config.algorithm = Algorithm::Single(config.primitive.clone());
if let Some(kh) = config.keyed.clone() {
config.algorithm = config.algorithm.into_wrapped(kh);
}
trace!("imported config as: {:?}", config);
Ok(config)
} else {
info!("could not open config file {:?}: {:?}", path.as_ref(), file);
Err("could not open config file".into())
}
}
#[must_use]
pub fn hash_password(&self, password: &str) -> String {
self.hash_password_safe(password)
.expect_report("failed to hash password")
}
#[doc(hidden)]
pub fn hash_password_safe(&self, password: &str) -> Result<String> {
let pwd_hash = self.algorithm.hash(password);
Ok(serde_mcf::to_string(&pwd_hash)?)
}
#[must_use]
pub fn verify_password(&self, hash: &str, password: &str) -> bool {
self.verify_password_safe(hash, password).unwrap_or(false)
}
#[doc(hidden)]
pub fn verify_password_safe(&self, hash: &str, password: &str) -> Result<bool> {
let mut pwd_hash: Output = serde_mcf::from_str(hash)?;
pwd_hash.check_keys(self);
Ok(pwd_hash.verify(password))
}
pub fn verify_password_update_hash(&self, hash: &str, password: &str) -> HashUpdate {
self.verify_password_update_hash_safe(hash, password)
.unwrap_or(HashUpdate::Failed)
}
#[doc(hidden)]
pub fn verify_password_update_hash_safe(
&self,
hash: &str,
password: &str,
) -> Result<HashUpdate> {
let pwd_hash: Output = serde_mcf::from_str(hash)?;
if pwd_hash.verify(password) {
if pwd_hash.alg == self.algorithm {
Ok(HashUpdate::Verified(None))
} else {
let new_hash = serde_mcf::to_string(&self.algorithm.hash(password))?;
Ok(HashUpdate::Verified(Some(new_hash)))
}
} else {
Ok(HashUpdate::Failed)
}
}
#[must_use]
pub fn migrate_hash(&self, hash: &str) -> Option<String> {
self.migrate_hash_safe(hash)
.expect("failed to migrate password")
}
#[doc(hidden)]
pub fn migrate_hash_safe(&self, hash: &str) -> Result<Option<String>> {
let pwd_hash: Output = serde_mcf::from_str(hash)?;
if !pwd_hash.alg.needs_migrating(&self.primitive) {
return Ok(None);
}
let new_params = pwd_hash.alg.to_wrapped(self.primitive.clone());
let new_salt = pwd_hash.salt;
let new_hash = self.primitive.compute(&pwd_hash.hash, &new_salt);
let new_hash = Output {
alg: new_params,
hash: new_hash,
salt: new_salt,
};
Ok(Some(serde_mcf::to_string(&new_hash)?))
}
#[must_use]
pub fn add_key(&self, key: &[u8]) -> String {
self.keys.insert(key)
}
pub(crate) fn get_key(&self, key_id: &str) -> Option<Vec<u8>> {
self.keys.get_key(key_id)
}
pub fn set_primitive(&mut self, primitive: Primitive) {
self.primitive = primitive.clone();
self.algorithm = match self.algorithm {
Algorithm::Single(_) => Algorithm::Single(primitive),
Algorithm::Nested { ref outer, .. } => {
Algorithm::Single(primitive).into_wrapped(outer.clone())
}
};
}
pub fn set_keyed_hash(&mut self, keyed: Primitive) {
self.keyed = Some(keyed.clone());
let mut newalg = match self.algorithm {
Algorithm::Single(_) => self.algorithm.to_wrapped(keyed),
Algorithm::Nested {
outer: ref _outer,
ref inner,
} => inner.to_wrapped(keyed),
};
newalg.update_key(self);
self.algorithm = newalg;
}
pub fn set_key_source(&mut self, store: &'static dyn key::Store) {
self.keys = store;
}
}
struct BackupPrng {
salt: hkdf::Salt,
seed: [u8; 32],
}
impl BackupPrng {
fn gen_salt(&mut self) -> Vec<u8> {
let mut buf = [0_u8; 48];
let alg = self.salt.algorithm();
self.salt
.extract(&self.seed)
.expand(&[b"libpasta backup PRNG"], alg)
.expect("expand failure")
.fill(&mut buf[..])
.expect("fill failure");
self.seed.copy_from_slice(&buf[16..]);
let mut output = Vec::with_capacity(16);
output.extend_from_slice(&buf[0..16]);
output
}
}
pub(crate) fn backup_gen_salt() -> Vec<u8> {
RAND_BACKUP
.lock()
.expect("could not acquire lock on RAND_BACKUP")
.gen_salt()
}
#[cfg(test)]
mod test {
#![allow(clippy::wildcard_imports)]
use super::*;
use crate::*;
use ring;
#[test]
fn use_config() {
let config = Config::with_primitive(primitives::Argon2::default());
let hash = config.hash_password("hunter2");
assert!(config.verify_password(&hash, "hunter2"));
let mut config = Config::default();
config.set_primitive(primitives::Bcrypt::default());
let hash = config.hash_password("hunter2");
assert!(verify_password(&hash, "hunter2"));
}
#[derive(Debug)]
struct StaticSource(&'static [u8; 16]);
impl key::Store for StaticSource {
fn insert(&self, _key: &[u8]) -> String {
"StaticKey".to_string()
}
fn get_key(&self, _id: &str) -> Option<Vec<u8>> {
Some(self.0.to_vec())
}
}
static STATIC_SOURCE: StaticSource = StaticSource(b"ThisIsAStaticKey");
#[test]
fn alternate_key_source() {
let mut config = Config::default();
config.set_key_source(&STATIC_SOURCE);
let id = config.add_key(&[]);
assert_eq!(config.get_key(&id), Some(b"ThisIsAStaticKey".to_vec()));
let hmac = primitives::Hmac::with_key_id(ring::hkdf::HKDF_SHA256, "dummy");
config.set_keyed_hash(hmac);
let hash = config.hash_password("hunter2");
assert!(config.verify_password_safe(&hash, "hunter2").unwrap())
}
}