Merge pull request #19 from wyhaya/master Add TOTP::from_url
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 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
diff --git a/Cargo.toml b/Cargo.toml
index 9696ff3..d4a6387 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -12,12 +12,13 @@ keywords = ["authentication", "2fa", "totp", "hmac", "otp"]
categories = ["authentication", "web-programming"]
[package.metadata.docs.rs]
-features = [ "qr", "serde_support" ]
+features = [ "qr", "serde_support", "otpauth" ]
[features]
default = []
qr = ["qrcodegen", "image", "base64"]
serde_support = ["serde"]
+otpauth = ["url"]
[dependencies]
serde = { version = "1.0", features = ["derive"], optional = true }
@@ -29,3 +30,4 @@ constant_time_eq = "~0.2.1"
qrcodegen = { version = "~1.8", optional = true }
image = { version = "~0.24.2", features = ["png"], optional = true, default-features = false}
base64 = { version = "~0.13", optional = true }
+url = { version = "2.2.2", optional = true }
\ No newline at end of file
diff --git a/README.md b/README.md
index fe0630c..ea56fd7 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,10 @@ With optional feature "qr", you can use it to generate a base64 png qrcode
### serde_support
With optional feature "serde_support", library-defined types will be Deserialize-able and Serialize-able
+### otpauth
+
+With optional feature "otpauth", Support to parse the TOTP parameter from `otpauth` URL
+
## How to use
---
Add it to your `Cargo.toml`:
@@ -67,3 +71,20 @@ Add it to your `Cargo.toml`:
version = "~1.3"
features = ["serde_support"]
```
+
+### With otpauth url support
+
+Add it to your `Cargo.toml`:
+```toml
+[dependencies.totp-rs]
+version = "~1.3"
+features = ["otpauth"]
+```
+
+```Rust
+use totp_rs::TOTP;
+
+let otpauth = "otpauth://totp/GitHub:test?secret=ABC&issuer=GitHub";
+let totp = TOTP::from_url(otpauth).unwrap();
+println!("{}", totp.generate_current().unwrap());
+```
\ No newline at end of file
diff --git a/src/lib.rs b/src/lib.rs
index 64ecda5..ff14699 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -51,6 +51,9 @@ use core::fmt;
#[cfg(feature = "qr")]
use {base64, image::Luma, qrcodegen};
+#[cfg(feature = "otpauth")]
+use url::{Host, ParseError, Url};
+
use hmac::Mac;
use std::time::{SystemTime, SystemTimeError, UNIX_EPOCH};
@@ -108,6 +111,18 @@ fn system_time() -> Result<u64, SystemTimeError> {
Ok(t)
}
+#[cfg(feature = "otpauth")]
+#[derive(Debug)]
+pub enum TotpUrlError {
+ Url(ParseError),
+ Scheme,
+ Host,
+ Secret,
+ Algorithm,
+ Digits,
+ Step,
+}
+
/// TOTP holds informations as to how to generate an auth code and validate it. Its [secret](struct.TOTP.html#structfield.secret) field is sensitive data, treat it accordingly
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde_support", derive(Serialize, Deserialize))]
@@ -206,6 +221,54 @@ impl<T: AsRef<[u8]>> TOTP<T> {
self.secret.as_ref(),
)
}
+
+ /// Generate a TOTP from the standard otpauth URL
+ #[cfg(feature = "otpauth")]
+ pub fn from_url<S: AsRef<str>>(url: S) -> Result<TOTP<Vec<u8>>, TotpUrlError> {
+ let url = Url::parse(url.as_ref()).map_err(|err| TotpUrlError::Url(err))?;
+ if url.scheme() != "otpauth" {
+ return Err(TotpUrlError::Scheme);
+ }
+ if url.host() != Some(Host::Domain("totp")) {
+ return Err(TotpUrlError::Host);
+ }
+
+ let mut algorithm = Algorithm::SHA1;
+ let mut digits = 6;
+ let mut step = 30;
+ let mut secret = Vec::new();
+
+ for (key, value) in url.query_pairs() {
+ match key.as_ref() {
+ "algorithm" => {
+ algorithm = match value.as_ref() {
+ "SHA1" => Algorithm::SHA1,
+ "SHA256" => Algorithm::SHA256,
+ "SHA512" => Algorithm::SHA512,
+ _ => return Err(TotpUrlError::Algorithm),
+ }
+ }
+ "digits" => {
+ digits = value.parse::<usize>().map_err(|_| TotpUrlError::Digits)?;
+ }
+ "period" => {
+ step = value.parse::<u64>().map_err(|_| TotpUrlError::Step)?;
+ }
+ "secret" => {
+ secret =
+ base32::decode(base32::Alphabet::RFC4648 { padding: false }, value.as_ref())
+ .ok_or(TotpUrlError::Secret)?;
+ }
+ _ => {}
+ }
+ }
+
+ if secret.is_empty() {
+ return Err(TotpUrlError::Secret);
+ }
+
+ Ok(TOTP::new(algorithm, digits, 1, step, secret))
+ }
/// Will generate a standard URL used to automatically add TOTP auths. Usually used with qr codes
pub fn get_url(&self, label: &str, issuer: &str) -> String {
@@ -416,6 +479,35 @@ mod tests {
}
#[test]
+ #[cfg(feature = "otpauth")]
+ fn from_url_err() {
+ assert!(TOTP::<Vec<u8>>::from_url("otpauth://hotp/123").is_err());
+ assert!(TOTP::<Vec<u8>>::from_url("otpauth://totp/GitHub:test").is_err());
+ }
+
+ #[test]
+ #[cfg(feature = "otpauth")]
+ fn from_url_default() {
+ let totp = TOTP::<Vec<u8>>::from_url("otpauth://totp/GitHub:test?secret=ABC").unwrap();
+ assert_eq!(totp.secret, base32::decode(base32::Alphabet::RFC4648 { padding: false }, "ABC").unwrap());
+ assert_eq!(totp.algorithm, Algorithm::SHA1);
+ assert_eq!(totp.digits, 6);
+ assert_eq!(totp.skew, 1);
+ assert_eq!(totp.step, 30);
+ }
+
+ #[test]
+ #[cfg(feature = "otpauth")]
+ fn from_url_query() {
+ let totp = TOTP::<Vec<u8>>::from_url("otpauth://totp/GitHub:test?secret=ABC&digits=8&period=60&algorithm=SHA256").unwrap();
+ assert_eq!(totp.secret, base32::decode(base32::Alphabet::RFC4648 { padding: false }, "ABC").unwrap());
+ assert_eq!(totp.algorithm, Algorithm::SHA256);
+ assert_eq!(totp.digits, 8);
+ assert_eq!(totp.skew, 1);
+ assert_eq!(totp.step, 60);
+ }
+
+ #[test]
#[cfg(feature = "qr")]
fn generates_qr() {
use sha1::{Digest, Sha1};