dipper 0.5.3

An out-of-the-box modular dependency injection web application framework.
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

pub use humantime::FormattedDuration;
use sha1::{Digest, Sha1};
use totp_rs::{Algorithm, Secret, TOTP as TotpStd};

#[derive(Debug, Clone)]
pub struct TOTP {
    algorithm: Algorithm,
    digits: usize,
    skew: u8,
    step: u64,
}

impl Default for TOTP {
    fn default() -> Self {
        Self {
            algorithm: Algorithm::SHA1,
            digits: 6,
            skew: 1,
            step: Self::OTP_DEFAULT_STEP,
        }
    }
}

impl TOTP {
    const OTP_DEFAULT_STEP: u64 = 30;
    pub fn default_otp() -> Self {
        Self::default()
    }
    const EMAIL_DEFAULT_STEP: u64 = 10 * 60;
    pub fn default_email() -> Self {
        Self::default().with_step(Self::EMAIL_DEFAULT_STEP)
    }
    const SMS_DEFAULT_STEP: u64 = 5 * 60;
    pub fn default_sms() -> Self {
        Self::default().with_step(Self::SMS_DEFAULT_STEP)
    }
    /// Set duration in seconds of a step.
    /// The recommended value per [rfc-6238](https://tools.ietf.org/html/rfc6238#section-5.2) is 30 seconds
    pub const fn with_step(mut self, step: u64) -> Self {
        self.step = step;
        self
    }
    /// The number of digits composing the auth code.
    /// Per [rfc-4226](https://tools.ietf.org/html/rfc4226#section-5.3), this can oscilate between 6 and 8 digits
    pub const fn with_digits(mut self, digits: usize) -> Self {
        self.digits = digits;
        self
    }
    pub fn secret_from_root(root: impl AsRef<[u8]>) -> String {
        let mut hasher = Sha1::new();
        hasher.update(root);
        let result = hasher.finalize();
        let Secret::Encoded(secret_base32) = Secret::Raw(result.to_vec()).to_encoded() else {
            unreachable!()
        };
        secret_base32
    }
    pub fn gen_secret_base32() -> String {
        let Secret::Encoded(secret_base32) = Secret::generate_secret().to_encoded() else {
            unreachable!()
        };
        secret_base32
    }
    pub fn qr_base64(&self, secret_base32: String, app_name: String, username: String) -> anyhow::Result<String> {
        let secret = Secret::Encoded(secret_base32);
        let totp = TotpStd::new(
            self.algorithm,
            self.digits,
            self.skew,
            self.step,
            secret.to_bytes()?,
            Some(app_name),
            username,
        )?;
        let qr_base64 = totp.get_qr_base64().map_err(|err| anyhow::anyhow!(err))?;
        Ok(format!("data:image/png;base64,{qr_base64}"))
    }
    pub fn qr_png(&self, secret_base32: String, app_name: String, username: String) -> anyhow::Result<Vec<u8>> {
        let secret = Secret::Encoded(secret_base32);
        let totp = TotpStd::new(
            self.algorithm,
            self.digits,
            self.skew,
            self.step,
            secret.to_bytes()?,
            Some(app_name),
            username,
        )?;
        let qr_png = totp.get_qr_png().map_err(|err| anyhow::anyhow!(err))?;
        Ok(qr_png)
    }
    pub fn check_current(&self, secret_base32: String, totp_token: &str) -> anyhow::Result<bool> {
        let totp = TotpStd::new(
            self.algorithm,
            self.digits,
            self.skew,
            self.step,
            Secret::Encoded(secret_base32).to_bytes()?,
            None,
            "".to_owned(),
        )?;
        Ok(totp.check_current(totp_token)?)
    }
    pub fn gen_current(&self, secret_base32: String) -> anyhow::Result<String> {
        let totp = TotpStd::new(
            self.algorithm,
            self.digits,
            self.skew,
            self.step,
            Secret::Encoded(secret_base32).to_bytes()?,
            None,
            "".to_owned(),
        )?;
        Ok(totp.generate_current()?)
    }
    pub fn gen_current2(&self, secret_base32: String) -> anyhow::Result<(String, FormattedDuration)> {
        let code = self.gen_current(secret_base32)?;
        let duration = humantime::format_duration(core::time::Duration::from_secs(self.step));
        Ok((code, duration))
    }
}

#[cfg(test)]
mod tests {
    use super::TOTP;

    const SECRET_BASE32: &'static str = "BQ3OBNNHYUZJZFTF6R2XBTKY2OJLISPW";

    #[test]
    fn gen_secret_base32() {
        let secret_base32 = TOTP::gen_secret_base32();
        println!("secret_base32={secret_base32}");
    }

    #[test]
    fn qr_base64() {
        let totp = TOTP::default();
        let qr_base64 = totp
            .qr_base64(
                SECRET_BASE32.to_owned(),
                env!("CARGO_PKG_NAME").to_owned(),
                "andeya".to_owned(),
            )
            .unwrap();
        println!("{qr_base64}");
    }

    #[test]
    fn check_current() {
        let totp_token = "379244";
        let totp = TOTP::default();
        let r = totp.check_current(SECRET_BASE32.to_owned(), totp_token);
        println!("{r:?}");
    }

    #[test]
    fn gen_current() {
        let totp = TOTP::default();
        let totp_token = totp.gen_current(SECRET_BASE32.to_owned());
        println!("{totp_token:?}");
    }

    #[test]
    fn gen_current2() {
        let totp = TOTP::default();
        let (token, fmt_duration) = totp.gen_current2(SECRET_BASE32.to_owned()).unwrap();
        println!("The TOTP code {token} is valid within {fmt_duration}.");
    }
}