email_pass 0.5.0

Email and Password Type in Rust
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

use crate::errors::Error;

/// Abstraction to [`zxcvbn::Entropy::score`].
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
pub enum PasswordStrong {
    /// Equals to [`zxcvbn::Entropy::score`] = 2
    Low,
    /// Equals to [`zxcvbn::Entropy::score`] = 3
    Default,
    /// Equals to [`zxcvbn::Entropy::score`] = 4
    Hard,
}

impl PasswordStrong {
    pub fn as_u8(&self) -> u8 {
        match self {
            PasswordStrong::Low => 2,
            PasswordStrong::Default => 3,
            PasswordStrong::Hard => 4,
        }
    }
}

/// Simplify the raw passwords checking, based in minimum length and explicit strong.
/// Use the crate [`zxcvbn`] to estimate the strong based in entropy.
#[derive(Copy, Clone)]
pub struct PasswordStrongChecker {
    min_len: usize,
    /// Corresponds to [`zxcvbn::Entropy::score`]
    strong: PasswordStrong,
}

impl PasswordStrongChecker {
    pub fn new() -> Self {
        Self {
            min_len: 8,
            strong: PasswordStrong::Default,
        }
    }

    pub fn min_len(mut self, min_len: usize) -> Self {
        self.min_len = min_len;
        self
    }

    pub fn strong(mut self, strong: PasswordStrong) -> Self {
        self.strong = strong;
        self
    }

    /// check the password's strong.
    pub fn check(&self, raw_password: &str) -> Result<(), Error> {
        if raw_password.len() < self.min_len {
            return Err(Error::PasswordLength);
        }

        let estimate = zxcvbn::zxcvbn(raw_password, &[])?;
        if estimate.score() < self.strong.as_u8() {
            return Err(Error::UnsafePassword);
        }

        Ok(())
    }
}

impl Default for PasswordStrongChecker {
    fn default() -> Self {
        Self::new()
    }
}