Merge pull request #48 from timvisee/feature-unchecked Add unchecked TOTP constructor and URL parsing methods
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
diff --git a/src/lib.rs b/src/lib.rs
index cc71cc1..55ba5d5 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -247,7 +247,7 @@ impl TOTP {
///
/// # Errors
///
- /// Will return an error in case issuer or label contain the character ':'
+ /// Will return an error if the `digit` or `secret` size is invalid or if `issuer` or `label` contain the character ':'
pub fn new(
algorithm: Algorithm,
digits: usize,
@@ -265,7 +265,7 @@ impl TOTP {
if account_name.contains(':') {
return Err(TotpUrlError::AccountName(account_name));
}
- Ok(TOTP {
+ Ok(Self::new_unchecked(
algorithm,
digits,
skew,
@@ -273,7 +273,38 @@ impl TOTP {
secret,
issuer,
account_name,
- })
+ ))
+ }
+
+ #[cfg(feature = "otpauth")]
+ /// Will create a new instance of TOTP with given parameters. See [the doc](struct.TOTP.html#fields) for reference as to how to choose those values. This is unchecked and does not check the `digits` and `secret` size
+ ///
+ /// # Description
+ /// * `secret`: expect a non-encoded value, to pass in base32 string use `Secret::Encoded(String)`
+ ///
+ /// ```rust
+ /// use totp_rs::{Secret, TOTP, Algorithm};
+ /// let secret = Secret::Encoded("OBWGC2LOFVZXI4TJNZTS243FMNZGK5BNGEZDG".to_string());
+ /// let totp = TOTP::new_unchecked(Algorithm::SHA1, 6, 1, 30, secret.to_bytes().unwrap(), None, "".to_string());
+ /// ```
+ pub fn new_unchecked(
+ algorithm: Algorithm,
+ digits: usize,
+ skew: u8,
+ step: u64,
+ secret: Vec<u8>,
+ issuer: Option<String>,
+ account_name: String,
+ ) -> TOTP {
+ TOTP {
+ algorithm,
+ digits,
+ skew,
+ step,
+ secret,
+ issuer,
+ account_name,
+ }
}
#[cfg(not(feature = "otpauth"))]
@@ -292,7 +323,7 @@ impl TOTP {
///
/// # Errors
///
- /// Will return an error in case issuer or label contain the character ':'
+ /// Will return an error if the `digit` or `secret` size is invalid
pub fn new(
algorithm: Algorithm,
digits: usize,
@@ -302,13 +333,34 @@ impl TOTP {
) -> Result<TOTP, TotpUrlError> {
crate::rfc::assert_digits(&digits)?;
crate::rfc::assert_secret_length(secret.as_ref())?;
- Ok(TOTP {
+ Ok(Self::new_unchecked(algorithm, digits, skew, step, secret))
+ }
+
+ #[cfg(not(feature = "otpauth"))]
+ /// Will create a new instance of TOTP with given parameters. See [the doc](struct.TOTP.html#fields) for reference as to how to choose those values. This is unchecked and does not check the `digits` and `secret` size
+ ///
+ /// # Description
+ /// * `secret`: expect a non-encoded value, to pass in base32 string use `Secret::Encoded(String)`
+ ///
+ /// ```rust
+ /// use totp_rs::{Secret, TOTP, Algorithm};
+ /// let secret = Secret::Encoded("OBWGC2LOFVZXI4TJNZTS243FMNZGK5BNGEZDG".to_string());
+ /// let totp = TOTP::new_unchecked(Algorithm::SHA1, 6, 1, 30, secret.to_bytes().unwrap());
+ /// ```
+ pub fn new_unchecked(
+ algorithm: Algorithm,
+ digits: usize,
+ skew: u8,
+ step: u64,
+ secret: Vec<u8>,
+ ) -> TOTP {
+ TOTP {
algorithm,
digits,
skew,
step,
secret,
- })
+ }
}
/// Will create a new instance of TOTP from the given [Rfc6238](struct.Rfc6238.html) struct
@@ -398,6 +450,32 @@ impl TOTP {
/// Generate a TOTP from the standard otpauth URL
#[cfg(feature = "otpauth")]
pub fn from_url<S: AsRef<str>>(url: S) -> Result<TOTP, TotpUrlError> {
+ let (algorithm, digits, skew, step, secret, issuer, account_name) =
+ Self::parts_from_url(url)?;
+ TOTP::new(algorithm, digits, skew, step, secret, issuer, account_name)
+ }
+
+ /// Generate a TOTP from the standard otpauth URL, using `TOTP::new_unchecked` internally
+ #[cfg(feature = "otpauth")]
+ pub fn from_url_unchecked<S: AsRef<str>>(url: S) -> Result<TOTP, TotpUrlError> {
+ let (algorithm, digits, skew, step, secret, issuer, account_name) =
+ Self::parts_from_url(url)?;
+ Ok(TOTP::new_unchecked(
+ algorithm,
+ digits,
+ skew,
+ step,
+ secret,
+ issuer,
+ account_name,
+ ))
+ }
+
+ /// Parse the TOTP parts from the standard otpauth URL
+ #[cfg(feature = "otpauth")]
+ fn parts_from_url<S: AsRef<str>>(
+ url: S,
+ ) -> Result<(Algorithm, usize, u8, u64, Vec<u8>, Option<String>, String), TotpUrlError> {
let url = Url::parse(url.as_ref()).map_err(TotpUrlError::Url)?;
if url.scheme() != "otpauth" {
return Err(TotpUrlError::Scheme(url.scheme().to_string()));
@@ -477,7 +555,7 @@ impl TOTP {
return Err(TotpUrlError::Secret("".to_string()));
}
- TOTP::new(algorithm, digits, 1, step, secret, issuer, account_name)
+ Ok((algorithm, digits, 1, step, secret, issuer, account_name))
}
/// Will generate a standard URL used to automatically add TOTP auths. Usually used with qr codes