thotp 0.1.11

An RFC based implementation of TOTPs and HOTPs
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

//! A simple module containing 2 functions to encode and decode the secrets generated by this crate's
//! `generate_secret` function to and from the given encoding available in the
//! [data_encoding](https://docs.rs/data-encoding/latest/data_encoding/index.html) crate.
//!
//!
//! ## Example
//! ```
//! use thotp::encoding::{encode, decode};
//! use thotp::generate_secret;
//!
//! let buffer = generate_secret(160);
//!
//! let encoded = encode(&buffer, data_encoding::BASE32);
//!
//! let decoded: [u8; 160] =
//!   decode(&encoded, data_encoding::BASE32)
//!   .unwrap()
//!   .try_into()
//!   .unwrap();
//!
//! assert_eq!(buffer, decoded)
//! ```

use super::ThotpError;
pub use data_encoding;
use data_encoding::Encoding;

/// Encodes the provided buffer to the encoding of choice. Useful for encoding secret
/// buffers generated by this crate's `generate_secret` function.
pub fn encode(buffer: &[u8], encoding: Encoding) -> String {
    encoding.encode(buffer)
}

/// Decodes the provided string from the encoding of choice. Useful for decoding
/// encoded secrets generated with this crate's `generate_secret` and `encode` functions.
pub fn decode(key: &str, encoding: Encoding) -> Result<Vec<u8>, ThotpError> {
    let decoded = encoding.decode(key.as_bytes())?;
    Ok(decoded)
}

#[cfg(test)]
mod tests {
    use super::super::{generate_secret, ThotpError};
    use super::{decode, encode};

    #[test]
    fn encode_decode() -> Result<(), ThotpError> {
        let buffer = generate_secret(160);
        let encoded = encode(&buffer, data_encoding::BASE32);
        let decoded: [u8; 160] = decode(&encoded, data_encoding::BASE32)?.try_into().unwrap();
        assert_eq!(buffer, decoded);
        Ok(())
    }
}