thodg/totp-rs

Diff

  • Show log

    Commit

  • Hash : 1010772c
    Author : constantoine
    Date : 2022-05-06T15:41:47

    Update license Signed-off-by: constantoine <cleo.rebert@gmail.com>

  • 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

    otpauth

    With optional feature “otpauth”, Support to parse the TOTP parameter from otpauth URL

    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"]

    With otpauth url support

    Add it to your Cargo.toml:

    [dependencies.totp-rs]
version = "~1.3"
features = ["otpauth"]
    use totp_rs::TOTP;

let otpauth = "otpauth://totp/GitHub:test?secret=ABC&issuer=GitHub";
let totp = TOTP::from_url(otpauth).unwrap();
println!("{}", totp.generate_current().unwrap());

kmx.io     mail     discord kmxgit v0.4.0