libr2fa 0.1.3

rust implementation for HTOP, TOTP and steam guard tow-factor-authentication
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

use std::rc::Rc;

use serde::{Deserialize, Serialize};

use crate::{error, HMACType, Key, OtpAuthKey};

/// HOTPKey is the key for the HOTP,
/// HOTP is the counter based key,
/// each time you get a code, the counter will increase by 1,
/// the counter is stored in the key
///
/// usage:
/// ```rust
/// use libr2fa::HOTPKey;
/// use libr2fa::HMACType;
/// use libr2fa::Key;
///
/// let mut hotp_key = HOTPKey {
///     key: "MFSWS5LGNBUXKZLBO5TGQ33JO5SWC2DGNF2WCZLIMZUXKZLXMFUGM2LVNFQWK53IMZUXK2A=".to_string(),
///     hmac_type: HMACType::SHA1,
///     ..Default::default()
/// };
///
/// let code = hotp_key.get_code().unwrap();
/// ```
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct HOTPKey {
    /// name
    pub name: String,
    /// key from the user
    pub key: String,
    /// digits
    /// 6, 7, 8
    pub digits: u8,
    /// counter
    pub counter: u64,
    /// recovery codes
    pub recovery_codes: Vec<String>,
    /// hmac type
    pub hmac_type: HMACType,
    /// issuer
    pub issuer: Option<String>,
}

impl Default for HOTPKey {
    fn default() -> Self {
        Self {
            name: Default::default(),
            key: Default::default(),
            digits: 6,
            counter: Default::default(),
            recovery_codes: Default::default(),
            hmac_type: Default::default(),
            issuer: Default::default(),
        }
    }
}

impl HOTPKey {
    fn decode_key(&self) -> Result<Rc<[u8]>, error::Error> {
        let key = data_encoding::BASE32.decode(self.get_key().as_bytes());
        if key.is_err() {
            return Err(error::Error::InvalidKey);
        }

        Ok(Rc::from(key.unwrap().as_slice()))
    }

    fn get_key(&self) -> &str {
        &self.key
    }
}

impl OtpAuthKey for HOTPKey {
    fn to_uri_struct(&self) -> crate::URI {
        crate::URI {
            name: self.name.clone(),
            secret: self.key.clone(),
            issuer: self.issuer.clone(),
            algorithm: Some(self.hmac_type),
            digits: Some(self.digits),
            period: None,
            counter: Some(self.counter),
            key_type: crate::KeyType::TOTP,
        }
    }

    fn from_uri_struct(uri: &crate::URI) -> Result<Box<dyn Key>, crate::Error> {
        let counter = if let Some(counter) = uri.counter {
            counter
        } else {
            30
        };
        let digits = if let Some(digits) = uri.digits {
            digits
        } else {
            6
        };
        let algorithm = if let Some(algorithm) = uri.algorithm {
            algorithm
        } else {
            HMACType::SHA1
        };

        Ok(Box::from(HOTPKey {
            name: uri.name.clone(),
            key: uri.secret.clone(),
            digits,
            counter,
            recovery_codes: Vec::default(),
            hmac_type: algorithm,
            issuer: uri.issuer.clone(),
        }))
    }

    fn get_issuer(&self) -> Option<&str> {
        self.issuer.as_deref()
    }
}

impl Key for HOTPKey {
    fn get_type(&self) -> crate::KeyType {
        crate::KeyType::HOTP
    }

    fn get_name(&self) -> &str {
        &self.name
    }

    fn get_recovery_codes(&self) -> Vec<String> {
        self.recovery_codes.clone()
    }

    fn get_code(&mut self) -> Result<String, error::Error> {
        let raw = self.decode_key()?;
        self.counter += 1;

        let res = self
            .hmac_type
            .get_hash(raw.as_ref(), &self.counter.to_be_bytes())?;
        let offset: usize = (res[res.len() - 1] & 0x0f) as usize;

        let code: u32 = (((res[offset] & 0x7f) as u32) << 24)
            | ((res[offset + 1] as u32) << 16)
            | ((res[offset + 2] as u32) << 8)
            | (res[offset + 3] as u32);

        // trim to the number of digits
        let code = code % 10u32.pow(self.digits as u32);

        let mut code = code.to_string();
        // padding 0
        while code.len() < self.digits as usize {
            code.insert(0, '0');
        }

        Ok(code)
    }

    fn set_name(&mut self, name: &str) {
        self.name = name.to_string();
    }

    fn set_recovery_codes(&mut self, recovery_codes: Vec<String>) {
        self.recovery_codes = recovery_codes;
    }

    fn as_any(&self) -> &dyn std::any::Any {
        self
    }
}