sos-password 0.17.0

Password generation and helpers for the Save Our Secrets SDK.
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

//! Helper functions for generating diceware passwords.
use crate::{Error, Result};
use chbs::{
    config::{BasicConfig, BasicConfigBuilder},
    prelude::*,
    probability::Probability,
    word::{WordList, WordSampler},
};
use secrecy::SecretString;

use once_cell::sync::Lazy;

static WORD_LIST: Lazy<WordList> = Lazy::new(WordList::builtin_eff_large);

/// Generate a passphrase using the given config.
pub fn generate_passphrase_config(
    config: &BasicConfig<WordSampler>,
) -> Result<(SecretString, f64)> {
    if config.words < 6 {
        return Err(Error::DicewareWordsTooFew(config.words, 6));
    }

    let scheme = config.to_scheme();
    Ok((scheme.generate().into(), scheme.entropy().bits()))
}

/// Generate a diceware passphrase with the given number of words.
///
/// The number of words must be at least six.
pub fn generate_passphrase_words(
    words: usize,
) -> Result<(SecretString, f64)> {
    let config = default_config(words);
    generate_passphrase_config(&config)
}

/// Generate a diceware passphrase with six words which is ~171 bits of entropy.
pub fn generate_passphrase() -> Result<(SecretString, f64)> {
    generate_passphrase_words(6)
}

/// Get the default config for diceware passphrase generation.
pub fn default_config(words: usize) -> BasicConfig<WordSampler> {
    let config = BasicConfigBuilder::default()
        .word_provider(WORD_LIST.sampler())
        .words(words)
        .separator(' ')
        .capitalize_first(Probability::Never)
        .capitalize_words(Probability::Never)
        .build()
        .unwrap();
    config
}