Updated README and added a summary with updated examples Signed-off-by: constantoine <cleo.rebert-ext@treezor.com>
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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
diff --git a/README.md b/README.md
index 8ef67f5..39a170c 100644
--- a/README.md
+++ b/README.md
@@ -10,23 +10,48 @@ Be aware that some authenticator apps will accept the `SHA256` and `SHA512` algo
## Features
---
### qr
-With optional feature "qr", you can use it to generate a base64 png qrcode. This will enable feature `otpauth`
+With optional feature "qr", you can use it to generate a base64 png qrcode. This will enable feature `otpauth`.
### otpauth
-With optional feature "otpauth", support parsing the TOTP parameters from an `otpauth` URL, and generating an `otpauth` URL
+With optional feature "otpauth", support parsing the TOTP parameters from an `otpauth` URL, and generating an `otpauth` URL. It adds 2 fields to `TOTP`.
### serde_support
-With optional feature "serde_support", library-defined types `TOTP` and `Algorithm` and will be Deserialize-able and Serialize-able
+With optional feature "serde_support", library-defined types `TOTP` and `Algorithm` and will be Deserialize-able and Serialize-able.
+### gen_secret
+With optional feature "gen_secret", a secret will be generated for you to store in database.
-## How to use
+
+# Examples
+
+## Summarry
+
+0. [Understanding Secret](#understanding-secret)
+1. [Generate a token](#generate-a-token)
+2. [Enable qrcode generation](#with-qrcode-generation)
+3. [Enable serde support](#with-serde-support)
+4. [Enable otpauth url support](#with-otpauth-url-support)
+5. [Enable gen_secret support](#with-gensecret)
+6. [With RFC-6238 compliant default](#with-rfc-6238-compliant-default)
+
+### Understanding Secret
+---
+This new type was added as a disambiguation between Raw and already base32 encoded secrets.
+```Rust
+ Secret::Raw("TestSecretSuperSecret".as_bytes().to_vec())
+```
+Is equivalent to
+```Rust
+ Secret::Encoded("KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ".to_string())
+```
+### Generate a token
---
Add it to your `Cargo.toml`:
```toml
[dependencies]
-totp-rs = "^2.0"
+totp-rs = "^3.0"
```
You can then do something like:
```Rust
use std::time::SystemTime;
-use totp_rs::{Algorithm, TOTP};
+use totp_rs::{Algorithm, TOTP, Secret};
fn main() {
let totp = TOTP::new(
@@ -34,26 +59,40 @@ fn main() {
6,
1,
30,
- "supersecret",
- Some("Github".to_string()),
- "constantoine@github.com".to_string(),
+ Secret::Raw("TestSecretSuperSecret".as_bytes().to_vec()).to_bytes().unwrap(),
).unwrap();
let token = totp.generate_current().unwrap();
println!("{}", token);
}
```
+Which is equivalent to:
+```Rust
+use std::time::SystemTime;
+use totp_rs::{Algorithm, TOTP, Secret};
+fn main() {
+ let totp = TOTP::new(
+ Algorithm::SHA1,
+ 6,
+ 1,
+ 30,
+ Secret::Encoded("KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ".to_string()).to_bytes().unwrap(),
+ ).unwrap();
+ let token = totp.generate_current().unwrap();
+ println!("{}", token);
+}
+```
### With qrcode generation
-
+---
Add it to your `Cargo.toml`:
```toml
[dependencies.totp-rs]
-version = "^2.0"
+version = "^3.0"
features = ["qr"]
```
You can then do something like:
```Rust
-use totp_rs::{Algorithm, TOTP};
+use totp_rs::{Algorithm, TOTP, Secret};
fn main() {
let totp = TOTP::new(
@@ -61,29 +100,30 @@ fn main() {
6,
1,
30,
- "supersecret",
+ Secret::Encoded("KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ".to_string()).to_bytes().unwrap(),
Some("Github".to_string()),
"constantoine@github.com".to_string(),
).unwrap();
- let code = totp.get_qr("user@example.com", "my-org.com")?;
+ let code = totp.get_qr()?;
println!("{}", code);
}
```
### With serde support
+---
Add it to your `Cargo.toml`:
```toml
[dependencies.totp-rs]
-version = "^2.0"
+version = "^3.0"
features = ["serde_support"]
```
### With otpauth url support
-
+---
Add it to your `Cargo.toml`:
```toml
[dependencies.totp-rs]
-version = "^2.0"
+version = "^3.0"
features = ["otpauth"]
```
You can then do something like:
@@ -91,8 +131,84 @@ You can then do something like:
use totp_rs::TOTP;
fn main() {
- let otpauth = "otpauth://totp/GitHub:constantoine@github.com?secret=ABC&issuer=GitHub";
+ let otpauth = "otpauth://totp/GitHub:constantoine@github.com?secret=KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ&issuer=GitHub";
let totp = TOTP::from_url(otpauth).unwrap();
println!("{}", totp.generate_current().unwrap());
}
+```
+
+### With gen_secret
+---
+Add it to your `Cargo.toml`:
+```toml
+[dependencies.totp-rs]
+version = "^3.0"
+features = ["gen_secret"]
+```
+You can then do something like:
+```Rust
+use totp_rs::{Algorithm, TOTP, Secret};
+
+fn main() {
+ let totp = TOTP::new(
+ Algorithm::SHA1,
+ 6,
+ 1,
+ 30,
+ Secret::default().to_bytes().unwrap(),
+ Some("Github".to_string()),
+ "constantoine@github.com".to_string(),
+ ).unwrap();
+ let code = totp.get_qr()?;
+ println!("{}", code);
+}
+```
+Which is equivalent to
+```Rust
+use totp_rs::{Algorithm, TOTP, Secret};
+
+fn main() {
+ let totp = TOTP::new(
+ Algorithm::SHA1,
+ 6,
+ 1,
+ 30,
+ Secret::generate_secret().to_bytes().unwrap(),
+ Some("Github".to_string()),
+ "constantoine@github.com".to_string(),
+ ).unwrap();
+ let code = totp.get_qr()?;
+ println!("{}", code);
+}
+```
+
+### With RFC-6238 compliant default
+---
+You can do something like this
+```Rust
+use totp_rs::{Algorithm, TOTP, Secret, Rfc6238};
+
+fn main () {
+ let mut rfc = Rfc6238::with_defaults(
+ Secret::Encoded("KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ".to_string()).to_bytes().unwrap(),
+ )
+ .unwrap();
+
+ // optional, set digits
+ rfc.digits(8).unwrap();
+
+ // create a TOTP from rfc
+ let totp = TOTP::from_rfc6238(rfc).unwrap();
+ let code = totp.generate_current().unwrap();
+ println!("code: {}", code);
+}
+```
+With `gen_secret` feature, you can go even further and have all values by default and a secure secret.
+
+Note: With `otpauth` feature, `TOTP.issuer` will be `None`, and `TOTP.account_name` will be `""`. Be sure to set those fields before generating an URL/QRCode
+```Rust
+fn main() {
+ let totp = TOTP::default();
+ println!("code: {}", code);
+}
```
\ No newline at end of file