thodg/totp-rs/README.md
-
Show log
Commit
-
Hash : ff6f562a
Author :
Date : 2022-05-20T15:00:12
The return of otpauth Signed-off-by: constantoine <cleo.rebert@gmail.com>
totp-rs
This library permits the creation of 2FA authentification tokens per TOTP, the verification of said tokens, with configurable time skew, validity time of each token, algorithm and number of digits! Default features are kept as lightweight as possible to ensure small binaries and short compilation time.
It now supports parsing otpauth URLs into a totp object, with sane default values.
Be aware that some authenticator apps will accept the SHA256 and SHA512 algorithms but silently fallback to SHA1 which will make the check() function fail due to mismatched algorithms.
Features
qr
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
serde_support
With optional feature “serde_support”, library-defined types TOTP and Algorithm and will be Deserialize-able and Serialize-able
How to use
Add it to your Cargo.toml:
[dependencies]
totp-rs = "^2.0"You can then do something like:
use std::time::SystemTime;
use totp_rs::{Algorithm, TOTP};
fn main() {
let totp = TOTP::new(
Algorithm::SHA1,
6,
1,
30,
"supersecret",
Some("Github".to_string()),
"constantoine@github.com".to_string(),
).unwrap();
let token = totp.generate_current().unwrap();
println!("{}", token);
}With qrcode generation
Add it to your Cargo.toml:
[dependencies.totp-rs]
version = "^2.0"
features = ["qr"]You can then do something like:
use totp_rs::{Algorithm, TOTP};
fn main() {
let totp = TOTP::new(
Algorithm::SHA1,
6,
1,
30,
"supersecret",
Some("Github".to_string()),
"constantoine@github.com".to_string(),
).unwrap();
let code = totp.get_qr("user@example.com", "my-org.com")?;
println!("{}", code);
}With serde support
Add it to your Cargo.toml:
[dependencies.totp-rs]
version = "^2.0"
features = ["serde_support"]With otpauth url support
Add it to your Cargo.toml:
[dependencies.totp-rs]
version = "^2.0"
features = ["otpauth"]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 totp = TOTP::from_url(otpauth).unwrap();
println!("{}", totp.generate_current().unwrap());
}Source
-
README.md
-
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
# totp-rs  [](https://docs.rs/totp-rs) [](https://crates.io/crates/totp-rs) [](https://codecov.io/gh/constantoine/totp-rs) [](https://github.com/constantoine/totp-rs/actions/workflows/security.yml) This library permits the creation of 2FA authentification tokens per TOTP, the verification of said tokens, with configurable time skew, validity time of each token, algorithm and number of digits! Default features are kept as lightweight as possible to ensure small binaries and short compilation time. It now supports parsing [otpauth URLs](https://github.com/google/google-authenticator/wiki/Key-Uri-Format) into a totp object, with sane default values. Be aware that some authenticator apps will accept the `SHA256` and `SHA512` algorithms but silently fallback to `SHA1` which will make the `check()` function fail due to mismatched algorithms. ## Features --- ### qr 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 ### serde_support With optional feature "serde_support", library-defined types `TOTP` and `Algorithm` and will be Deserialize-able and Serialize-able ## How to use --- Add it to your `Cargo.toml`: ```toml [dependencies] totp-rs = "^2.0" ``` You can then do something like: ```Rust use std::time::SystemTime; use totp_rs::{Algorithm, TOTP}; fn main() { let totp = TOTP::new( Algorithm::SHA1, 6, 1, 30, "supersecret", Some("Github".to_string()), "constantoine@github.com".to_string(), ).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" features = ["qr"] ``` You can then do something like: ```Rust use totp_rs::{Algorithm, TOTP}; fn main() { let totp = TOTP::new( Algorithm::SHA1, 6, 1, 30, "supersecret", Some("Github".to_string()), "constantoine@github.com".to_string(), ).unwrap(); let code = totp.get_qr("user@example.com", "my-org.com")?; println!("{}", code); } ``` ### With serde support Add it to your `Cargo.toml`: ```toml [dependencies.totp-rs] version = "^2.0" features = ["serde_support"] ``` ### With otpauth url support Add it to your `Cargo.toml`: ```toml [dependencies.totp-rs] version = "^2.0" features = ["otpauth"] ``` You can then do something like: ```Rust use totp_rs::TOTP; fn main() { let otpauth = "otpauth://totp/GitHub:constantoine@github.com?secret=ABC&issuer=GitHub"; let totp = TOTP::from_url(otpauth).unwrap(); println!("{}", totp.generate_current().unwrap()); } ```