Go to file
Cléo Rebert 43107283ac
Update README.md
2021-08-20 18:59:09 +02:00
.github/workflows Create rust.yml 2020-06-22 17:10:33 +02:00
src Fixed warning about deprecated type alias 2020-11-02 23:21:19 +01:00
.gitignore First commit 2020-04-11 21:24:50 +02:00
Cargo.toml New version 2021-08-20 18:50:56 +02:00
LICENSE Create license 2020-04-13 16:54:21 +02:00
README.md Update README.md 2021-08-20 18:59:09 +02:00

README.md

totp-rs

Build Status docs

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

Features


qr

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

How to use


Add it to your Cargo.toml:

[dependencies]
totp-rs = "~0.6"

You can then do something like:

use std::time::SystemTime;
use totp_rs::{Algorithm, TOTP};

let totp = TOTP::new(
    Algorithm::SHA1,
    6,
    1,
    30,
    "supersecret",
);
let time = SystemTime::now()
    .duration_since(SystemTime::UNIX_EPOCH).unwrap()
    .as_secs();
let url = totp.get_url("user@example.com", "my-org.com");
println!("{}", url);
let token = totp.generate(time);
println!("{}", token);

With qrcode generation

Add it to your Cargo.toml:

[dependencies.totp-rs]
version = "~0.6"
features = ["qr"]

You can then do something like:

use totp_rs::{Algorithm, TOTP};

let totp = TOTP::new(
    Algorithm::SHA1,
    6,
    1,
    30,
    "supersecret",
);
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 = "~0.6"
features = ["serde_support"]