pegase 0.2.0

Cli to generate secret config files from yaml recipe
Documentation
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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
use std::collections::BTreeMap;

use garde::{Report, Validate};
use serde::{Deserialize, Serialize};
use thiserror::Error;

use crate::{
    generators::{
        GenerateSecret, GenerationError, Secret,
        pass::{PassCharset, PassSecretGenerator, PassSecretGeneratorConfig, PassSize},
    },
    internal::secrets::{
        argon2::{
            DEFAULT_M_COST, DEFAULT_P_COST, DEFAULT_T_COST, MAX_M_COST, MAX_P_COST, MAX_T_COST,
            MIN_P_COST, MIN_T_COST, generate_argon2,
        },
        pbkdf2::{DEFAULT_ROUNDS, MAX_ROUNDS, MIN_ROUNDS, generate_pbkdf2},
        yescrypt::{
            DEFAULT_N, DEFAULT_P, DEFAULT_R, MAX_N, MAX_P, MAX_R, MIN_N, MIN_P, MIN_R,
            generate_yescrypt,
        },
    },
};

#[derive(Debug, Serialize, Deserialize, Clone, Validate, PartialEq)]
pub struct Argon2Params {
    #[garde(range(min = self.p_cost * 8, max = MAX_M_COST))]
    pub m_cost: u32,
    #[garde(range(min = MIN_T_COST, max = MAX_T_COST))]
    pub t_cost: u32,
    #[garde(range(min = MIN_P_COST, max = MAX_P_COST))]
    pub p_cost: u32,
}

impl Default for Argon2Params {
    fn default() -> Self {
        Self {
            m_cost: DEFAULT_M_COST,
            t_cost: DEFAULT_T_COST,
            p_cost: DEFAULT_P_COST,
        }
    }
}

#[derive(Debug, Serialize, Deserialize, Clone, Validate, PartialEq)]
pub struct Pbkdf2Params {
    #[garde(range(min = MIN_ROUNDS, max = MAX_ROUNDS))]
    pub rounds: u32,
}

impl Default for Pbkdf2Params {
    fn default() -> Self {
        Self {
            rounds: DEFAULT_ROUNDS,
        }
    }
}

#[derive(Debug, Serialize, Deserialize, Clone, Validate, PartialEq)]
pub struct YescryptParams {
    #[garde(range(min = MIN_N, max = MAX_N))]
    pub n_cost: u64,
    #[garde(range(min = MIN_R, max = MAX_R))]
    pub r_cost: u32,
    #[garde(range(min = MIN_P, max = MAX_P))]
    pub p_cost: u32,
}

impl Default for YescryptParams {
    fn default() -> Self {
        Self {
            n_cost: DEFAULT_N,
            r_cost: DEFAULT_R,
            p_cost: DEFAULT_P,
        }
    }
}

#[derive(Debug, Serialize, Deserialize, Clone, Validate, PartialEq)]
#[serde(rename_all = "snake_case")]
#[serde(tag = "kind")]
pub enum HashKind {
    Argon2 {
        #[garde(dive)]
        params: Option<Argon2Params>,
    },
    Pbkdf2 {
        #[garde(dive)]
        params: Option<Pbkdf2Params>,
    },
    #[serde(alias = "linux_passwd")]
    Yescrypt {
        #[garde(dive)]
        params: Option<YescryptParams>,
    },
}

impl Default for HashKind {
    fn default() -> Self {
        HashKind::Argon2 {
            params: Default::default(),
        }
    }
}

#[derive(Debug, Serialize, Deserialize, Default, Clone, Validate, PartialEq)]
#[serde(try_from = "HashSecretGeneratorConfigDeserializeWith")]
pub struct HashSecretGeneratorConfig {
    #[garde(dive)]
    pub kind: Option<HashKind>,
    #[garde(dive)]
    pub pass_config: Option<PassSecretGeneratorConfig>,
}

/* #region absolute horror */
/*
   `#[serde(deny_unknown_fields)]` does not support `#[serde(flatten)]` so a way to achieve a
   similar result is to add an `other` field that contains all remaining fields and check if this
   field is empty
*/

#[derive(Deserialize, Default, Clone, Debug, Validate)]
struct HashSecretGeneratorConfigDeserializeWith {
    #[serde(flatten)]
    #[garde(dive)]
    pub kind: Option<HashKind>,
    #[serde(flatten)]
    #[garde(dive)]
    pub size: Option<PassSize>,
    #[garde(dive)]
    pub charset: Option<PassCharset>,
    #[serde(flatten)]
    #[garde(skip)]
    other: BTreeMap<String, serde_value::Value>,
}

#[derive(Debug, Error)]
pub enum ParsingError {
    #[error("Unknown field: {0}")]
    UnknownField(String),
    #[error("Missing field: {0}")]
    MissingField(String),
    #[error("Value error: {0}")]
    ValueError(#[from] Report),
}

impl TryFrom<HashSecretGeneratorConfigDeserializeWith> for HashSecretGeneratorConfig {
    type Error = ParsingError;

    fn try_from(
        value: HashSecretGeneratorConfigDeserializeWith,
    ) -> Result<HashSecretGeneratorConfig, ParsingError> {
        let mut other_keys = value.other.clone();

        /* #region absolute horror - the return */
        /*
           There is an issue with `#[serde(tag)]` and `#[serde(flatten)]`, the fields of the tagged
           enums are duplicated inside the `other` map so they need to be removed to check if there
           are unknown fields
        */

        // println!("{value:?}\n\n");

        // println!("{other_keys:?}\n\n");

        match &value.kind {
            // Some(Rsa({bits: Some(bits)})) => todo!(),
            Some(HashKind::Argon2 { params: Some(_) }) => {
                other_keys.remove("params");
                other_keys.remove("kind");
            }
            // Some(Rsa({bits: Some(bits)})) => todo!(),
            Some(HashKind::Pbkdf2 { params: Some(_) }) => {
                other_keys.remove("params");
                other_keys.remove("kind");
            }
            // Some(Rsa({bits: Some(bits)})) => todo!(),
            Some(HashKind::Yescrypt { params: Some(_) }) => {
                other_keys.remove("params");
                other_keys.remove("kind");
            }
            Some(_) => {
                other_keys.remove("kind");
            }
            None => (),
        }

        match value.size {
            Some(PassSize::Length(_)) => {
                other_keys.remove("length");
            }
            Some(PassSize::AtLeastBits(_)) => {
                other_keys.remove("at_least_bits");
            }
            None => (),
        }

        if value.charset.is_some() {
            other_keys.remove("charset");
        }

        /* #endregion */

        // https://github.com/serde-rs/serde/issues/1880
        if other_keys.contains_key("kind") {
            return Err(ParsingError::MissingField(
                "missing field inside param".to_string(),
            ));
        }

        if let Some((key, _)) = other_keys.first_key_value() {
            return Err(ParsingError::UnknownField(format!("{:?}", key)));
        }

        value.validate()?;

        Ok(HashSecretGeneratorConfig {
            kind: value.kind,
            pass_config: Some(PassSecretGeneratorConfig {
                charset: value.charset,
                size: value.size,
            }),
        })
    }
}

/* #endregion */

#[derive(Debug, Serialize, Deserialize, Clone, Default, Validate, PartialEq)]
#[serde(transparent)]
pub struct HashSecretGenerator {
    #[garde(dive)]
    pub config: HashSecretGeneratorConfig,
}

impl GenerateSecret for HashSecretGenerator {
    fn generate(&self) -> Result<Secret, GenerationError> {
        let config = self.config.clone();

        config.validate()?;

        let Secret::String(plain) = PassSecretGenerator {
            config: config.pass_config.unwrap_or_default(),
        }
        .generate()?
        else {
            unreachable!()
        };

        let hash = match config.kind.unwrap_or_default() {
            HashKind::Argon2 { params } => {
                let params = params.unwrap_or_default();
                generate_argon2(
                    plain.as_bytes(),
                    params.m_cost,
                    params.t_cost,
                    params.p_cost,
                )?
            }
            HashKind::Pbkdf2 { params } => {
                let params = params.unwrap_or_default();
                generate_pbkdf2(plain.as_bytes(), params.rounds)?
            }
            HashKind::Yescrypt { params } => {
                let params = params.unwrap_or_default();
                generate_yescrypt(
                    plain.as_bytes(),
                    params.n_cost,
                    params.r_cost,
                    params.p_cost,
                )?
            }
        };

        Ok(Secret::Hash { plain, hash })
    }
}

#[cfg(test)]
mod test {
    use std::collections::HashSet;

    use argon2::Argon2;
    use password_hash::PasswordVerifier;
    use pbkdf2::Pbkdf2;
    use yescrypt::Yescrypt;

    use crate::generators::{
        GenerateSecret, Secret,
        pass::{PassCharset, PassSecretGeneratorConfig, PassSize},
    };

    use super::{
        Argon2Params, HashKind, HashSecretGenerator, HashSecretGeneratorConfig, Pbkdf2Params,
        YescryptParams,
    };

    #[test]
    fn check_argon2() {
        let m_cost = 10 * 1024;
        let t_cost = 3;
        let p_cost = 2;
        let size = 10_000;
        let charset = PassCharset::Hex;

        let generator = HashSecretGenerator {
            config: HashSecretGeneratorConfig {
                kind: Some(HashKind::Argon2 {
                    params: Some(Argon2Params {
                        m_cost,
                        t_cost,
                        p_cost,
                    }),
                }),
                pass_config: Some(PassSecretGeneratorConfig {
                    size: Some(PassSize::Length(10_000)),
                    charset: Some(charset.clone()),
                }),
            },
        };

        let secret = generator.generate().unwrap();

        if let Secret::Hash { plain, hash } = secret {
            let allowed_chars = charset.charset();
            let unique_chars: HashSet<_> = HashSet::from_iter(plain.as_bytes());
            assert!(plain.as_bytes().iter().all(|c| allowed_chars.contains(c)));
            assert_eq!(unique_chars.len(), allowed_chars.len());

            assert_eq!(plain.len(), size);

            let parsed_hash = argon2::PasswordHash::new(&hash).unwrap();

            assert_eq!(parsed_hash.algorithm.as_str(), "argon2id");
            assert_eq!(parsed_hash.params.get_decimal("m").unwrap(), m_cost);
            assert_eq!(parsed_hash.params.get_decimal("t").unwrap(), t_cost);
            assert_eq!(parsed_hash.params.get_decimal("p").unwrap(), p_cost);

            assert!(
                Argon2::default()
                    .verify_password(plain.as_bytes(), &parsed_hash)
                    .is_ok()
            );
        } else {
            panic!("expected hash, got {secret:?}")
        }
    }

    #[test]
    fn check_pbkdf2() {
        let rounds = 100_000;
        let size = 10_000;
        let charset = PassCharset::Hex;

        let generator = HashSecretGenerator {
            config: HashSecretGeneratorConfig {
                kind: Some(HashKind::Pbkdf2 {
                    params: Some(Pbkdf2Params { rounds }),
                }),
                pass_config: Some(PassSecretGeneratorConfig {
                    size: Some(PassSize::Length(10_000)),
                    charset: Some(charset.clone()),
                }),
            },
        };

        let secret = generator.generate().unwrap();

        if let Secret::Hash { plain, hash } = secret {
            let allowed_chars = charset.charset();
            let unique_chars: HashSet<_> = HashSet::from_iter(plain.as_bytes());
            assert!(plain.as_bytes().iter().all(|c| allowed_chars.contains(c)));
            assert_eq!(unique_chars.len(), allowed_chars.len());

            assert_eq!(plain.len(), size);

            let parsed_hash = pbkdf2::mcf::PasswordHash::new(&hash).unwrap();

            assert!(hash.starts_with(&format!("$pbkdf2-sha256${rounds}$")));

            assert!(
                Pbkdf2::default()
                    .verify_password(plain.as_bytes(), &parsed_hash)
                    .is_ok()
            );
        } else {
            panic!("expected hash, got {secret:?}")
        }
    }

    #[test]
    fn check_yescrypt() {
        let n = 2048;
        let r = 16;
        let p = 2;
        let size = 10_000;
        let charset = PassCharset::Hex;

        let generator = HashSecretGenerator {
            config: HashSecretGeneratorConfig {
                kind: Some(HashKind::Yescrypt {
                    params: Some(YescryptParams {
                        n_cost: n,
                        r_cost: r,
                        p_cost: p,
                    }),
                }),
                pass_config: Some(PassSecretGeneratorConfig {
                    size: Some(PassSize::Length(10_000)),
                    charset: Some(charset.clone()),
                }),
            },
        };

        let secret = generator.generate().unwrap();

        if let Secret::Hash { plain, hash } = secret {
            let allowed_chars = charset.charset();
            let unique_chars: HashSet<_> = HashSet::from_iter(plain.as_bytes());
            assert!(plain.as_bytes().iter().all(|c| allowed_chars.contains(c)));
            assert_eq!(unique_chars.len(), allowed_chars.len());

            assert_eq!(plain.len(), size);

            let parsed_hash = yescrypt::PasswordHash::new(&hash).unwrap();

            assert!(hash.starts_with("$y$j8D..$"));

            assert!(
                Yescrypt::default()
                    .verify_password(plain.as_bytes(), &parsed_hash)
                    .is_ok()
            );
        } else {
            panic!("expected hash, got {secret:?}")
        }
    }
}