totp-rs/README.md

25 lines
769 B
Markdown
Raw Normal View History

2020-04-11 15:24:50 -04:00
# totp-rs
2020-04-13 10:59:30 -04:00
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!
2020-04-11 15:24:50 -04:00
## How to use
2020-04-11 19:08:38 -04:00
Add it to your `Cargo.toml`:
2020-04-11 15:24:50 -04:00
```toml
2020-04-13 10:59:30 -04:00
[dependencies]
totp-rs = "~0.2"
2020-04-11 15:24:50 -04:00
```
2020-04-13 16:57:06 -04:00
You can then do something like:
```Rust
use totp_rs::{TOTP, Algorithm};
use std::time::SystemTime;
let username = "example".to_string();
let totp = TOTP::new(Algorithm::SHA1, 6, 1, 30, "supersecret".to_string().into_bytes());
let time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)?.as_secs();
let url = totp.get_url(format!("account:{}", username), "my-org.com".to_string());
println!("{}", url);
let token = totp.generate(time);
println!("{}", token);
```