Go to file
Cléo Rebert 733c27970e
Merge pull request #18 from constantoine/add_tests
Add tests for generate_current and check_current
2022-05-06 12:46:00 +02:00
.github/workflows Update security.yml 2022-01-13 18:33:33 +01:00
src Add tests for generate_current and check_current 2022-05-06 12:41:30 +02:00
.gitignore Add tests for generate_current and check_current 2022-05-06 12:41:30 +02:00
Cargo.toml Add tests for generate_current and check_current 2022-05-06 12:41:30 +02:00
LICENSE Changed to 7.0 for 2021 edition 2022-01-13 16:23:07 +01:00
README.md Add tests for generate_current and check_current 2022-05-06 12:41:30 +02:00

README.md

totp-rs

Build Status docs codecov cargo-audit

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

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

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 = "~1.3"

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 url = totp.get_url("user@example.com", "my-org.com");
println!("{}", url);
let token = totp.generate_current().unwrap();
println!("{}", token);

With qrcode generation

Add it to your Cargo.toml:

[dependencies.totp-rs]
version = "~1.3"
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 = "~1.3"
features = ["serde_support"]