michael/totp-rs
michael
/
totp-rs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add test to secret.rs 

Signed-off-by: constantoine <cleo.rebert-ext@treezor.com>
This commit is contained in:
constantoine 2022-08-09 11:04:11 +02:00
parent 6b9f13f6a2
commit 0103e7a6e5
No known key found for this signature in database
GPG Key ID: 0FA097951CF65367
1 changed files with 98 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

145
src/secret.rs
View File

@ -1,3 +1,82 @@
//! Representation of a secret either a "raw" \[u8\] or "base 32" encoded String
//!
//! # Examples
//!
//! - Create a TOTP from a "raw" secret
//! ```
//! # #[cfg(not(feature = "otpauth"))] {
//! use totp_rs::{Secret, TOTP, Algorithm};
//!
//! let secret = [
//! 0x70, 0x6c, 0x61, 0x69, 0x6e, 0x2d, 0x73, 0x74, 0x72, 0x69, 0x6e, 0x67, 0x2d, 0x73, 0x65,
//! 0x63, 0x72, 0x65, 0x74, 0x2d, 0x31, 0x32, 0x33,
//! ];
//! let secret_raw = Secret::Raw(secret.to_vec());
//! let totp_raw = TOTP::new(
//! Algorithm::SHA1,
//! 6,
//! 1,
//! 30,
//! secret_raw.to_bytes().unwrap(),
//! ).unwrap();
//!
//! println!("code from raw secret:\t{}", totp_raw.generate_current().unwrap());
//! # }
//! ```
//!
//! - Create a TOTP from a base32 encoded secret
//! ```
//! # #[cfg(not(feature = "otpauth"))] {
//! use totp_rs::{Secret, TOTP, Algorithm};
//!
//! let secret_b32 = Secret::Encoded(String::from("OBWGC2LOFVZXI4TJNZTS243FMNZGK5BNGEZDG"));
//! let totp_b32 = TOTP::new(
//! Algorithm::SHA1,
//! 6,
//! 1,
//! 30,
//! secret_b32.to_bytes().unwrap(),
//! ).unwrap();
//!
//! println!("code from base32:\t{}", totp_b32.generate_current().unwrap());
//! # }
//!
//! ```
//! - Create a TOTP from a Generated Secret
//! ```
//! # #[cfg(feature = "gen_secret")] {
//! use totp_rs::{Secret, TOTP, Algorithm};
//!
//! let secret_b32 = Secret::default();
//! let totp_b32 = TOTP::new(
//! Algorithm::SHA1,
//! 6,
//! 1,
//! 30,
//! secret_b32.to_bytes().unwrap(),
//! ).unwrap();
//!
//! println!("code from base32:\t{}", totp_b32.generate_current().unwrap());
//! # }
//! ```
//! - Create a TOTP from a Generated Secret 2
//! ```
//! # #[cfg(feature = "gen_secret")] {
//! use totp_rs::{Secret, TOTP, Algorithm};
//!
//! let secret_b32 = Secret::generate_secret();
//! let totp_b32 = TOTP::new(
//! Algorithm::SHA1,
//! 6,
//! 1,
//! 30,
//! secret_b32.to_bytes().unwrap(),
//! ).unwrap();
//!
//! println!("code from base32:\t{}", totp_b32.generate_current().unwrap());
//! # }
//! ```
use std::string::FromUtf8Error;
use base32::{self, Alphabet};
@ -7,49 +86,6 @@ pub enum SecretParseError {
Utf8Error(FromUtf8Error),
}
/// Representation of a secret either a "raw" \[u8\] or "base 32" encoded String
///
/// # Examples
///
/// - Create a TOTP from a "raw" secret
/// ```
/// use totp_rs::{Secret, TOTP, Algorithm};
///
/// let secret = [
/// 0x70, 0x6c, 0x61, 0x69, 0x6e, 0x2d, 0x73, 0x74, 0x72, 0x69, 0x6e, 0x67, 0x2d, 0x73, 0x65,
/// 0x63, 0x72, 0x65, 0x74, 0x2d, 0x31, 0x32, 0x33,
/// ];
/// let secret_raw = Secret::Raw(secret.to_vec());
/// let totp_raw = TOTP::new(
/// Algorithm::SHA1,
/// 6,
/// 1,
/// 30,
/// secret_raw.to_bytes().unwrap(),
/// None,
/// "account".to_string(),
/// ).unwrap();
///
/// println!("code from raw secret:\t{}", totp_raw.generate_current().unwrap());
/// ```
///
/// - Create a TOTP from a base32 encoded secret
/// ```
/// use totp_rs::{Secret, TOTP, Algorithm};
///
/// let secret_b32 = Secret::Encoded(String::from("OBWGC2LOFVZXI4TJNZTS243FMNZGK5BNGEZDG"));
/// let totp_b32 = TOTP::new(
/// Algorithm::SHA1,
/// 6,
/// 1,
/// 30,
/// secret_b32.to_bytes().unwrap(),
/// None,
/// "account".to_string(),
/// ).unwrap();
///
/// println!("code from base32:\t{}", totp_b32.generate_current().unwrap());
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Secret {
/// represent a non-encoded "raw" secret
@ -58,6 +94,13 @@ pub enum Secret {
Encoded(String),
}
#[cfg(feature = "gen_secret")]
impl Default for Secret {
fn default() -> Self {
return Secret::generate_secret()
}
}
impl Secret {
/// Get the inner String value as a Vec of bytes
@ -87,7 +130,7 @@ impl Secret {
match self {
Secret::Raw(s) => Secret::Encoded(base32::encode(
Alphabet::RFC4648 { padding: false },
&s,
s,
)),
Secret::Encoded(_) => self.clone(),
}
@ -108,7 +151,7 @@ impl Secret {
let mut rng = rand::thread_rng();
let mut secret: [u8; 20] = Default::default();
rng.fill(&mut secret);
rng.fill(&mut secret[..]);
Secret::Raw(secret.to_vec())
}
}
@ -143,7 +186,7 @@ mod tests {
fn secret_display() {
let base32_str = String::from(BASE32);
let secret_raw = Secret::Raw(BYTES.to_vec());
let secret_base32 = Secret::Encoded(base32_str.clone());
let secret_base32 = Secret::Encoded(base32_str);
println!("{}", secret_raw);
assert_eq!(secret_raw.to_string(), BYTES_DISPLAY.to_string());
assert_eq!(secret_base32.to_string(), BASE32.to_string());
@ -153,7 +196,7 @@ mod tests {
fn secret_convert_base32_raw() {
let base32_str = String::from(BASE32);
let secret_raw = Secret::Raw(BYTES.to_vec());
let secret_base32 = Secret::Encoded(base32_str.clone());
let secret_base32 = Secret::Encoded(base32_str);
assert_eq!(&secret_raw.to_encoded(), &secret_base32);
assert_eq!(&secret_raw.to_raw().unwrap(), &secret_raw);
@ -169,6 +212,14 @@ mod tests {
assert_eq!(Secret::Encoded(base32_str).to_bytes().unwrap(), BYTES.to_vec());
}
#[test]
fn secret_from_string() {
let raw: Secret = Secret::Raw("TestSecretSuperSecret".as_bytes().to_vec());
let encoded: Secret = Secret::Encoded("KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ".to_string());
assert_eq!(raw.to_encoded(), encoded);
assert_eq!(raw, encoded.to_raw().unwrap());
}
#[test]
#[cfg(feature = "gen_secret")]
fn secret_gen_secret() {