#totp #hmac #otp #2fa

totp-rs

RFC-compliant TOTP implementation with ease of use as a goal and additionnal QoL features

22 stable releases (4 major)

5.5.1 Jan 19, 2024
5.4.0 Oct 4, 2023
5.3.0 Sep 10, 2023
5.1.0 Jul 15, 2023
0.5.0 Jul 3, 2020

#22 in Authentication

Download history 2580/week @ 2023-12-21 2983/week @ 2023-12-28 3570/week @ 2024-01-04 3987/week @ 2024-01-11 6325/week @ 2024-01-18 6929/week @ 2024-01-25 9222/week @ 2024-02-01 10872/week @ 2024-02-08 8189/week @ 2024-02-15 9675/week @ 2024-02-22 11165/week @ 2024-02-29 11745/week @ 2024-03-07 14481/week @ 2024-03-14 16297/week @ 2024-03-21 15807/week @ 2024-03-28 13981/week @ 2024-04-04

62,572 downloads per month
Used in 32 crates (24 directly)

MIT license

88KB
1.5K SLoC

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.

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. It adds 2 fields to TOTP.

serde_support

With optional feature "serde_support", library-defined types TOTP and Algorithm and will be Deserialize-able and Serialize-able.

gen_secret

With optional feature "gen_secret", a secret will be generated for you to store in database.

zeroize

Securely zero secret information when the TOTP struct is dropped.

steam

Add support for Steam TOTP tokens.

Examples

Summary

  1. Understanding Secret
  2. Generate a token
  3. Enable qrcode generation
  4. Enable serde support
  5. Enable otpauth url support
  6. Enable gen_secret support
  7. With RFC-6238 compliant default
  8. New TOTP from steam secret

Understanding Secret


This new type was added as a disambiguation between Raw and already base32 encoded secrets.

Secret::Raw("TestSecretSuperSecret".as_bytes().to_vec())

Is equivalent to

Secret::Encoded("KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ".to_string())

Generate a token


Add it to your Cargo.toml:

[dependencies]
totp-rs = "^5.0"

You can then do something like:

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

fn main() {
    let totp = TOTP::new(
        Algorithm::SHA1,
        6,
        1,
        30,
        Secret::Raw("TestSecretSuperSecret".as_bytes().to_vec()).to_bytes().unwrap(),
    ).unwrap();
    let token = totp.generate_current().unwrap();
    println!("{}", token);   
}

Which is equivalent to:

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

fn main() {
    let totp = TOTP::new(
        Algorithm::SHA1,
        6,
        1,
        30,
        Secret::Encoded("KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ".to_string()).to_bytes().unwrap(),
    ).unwrap();
    let token = totp.generate_current().unwrap();
    println!("{}", token);   
}

With qrcode generation


Add it to your Cargo.toml:

[dependencies.totp-rs]
version = "^5.3"
features = ["qr"]

You can then do something like:

use totp_rs::{Algorithm, TOTP, Secret};

fn main() {
    let totp = TOTP::new(
        Algorithm::SHA1,
        6,
        1,
        30,
        Secret::Encoded("KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ".to_string()).to_bytes().unwrap(),
        Some("Github".to_string()),
        "constantoine@github.com".to_string(),
    ).unwrap();
    let qr_code = totp.get_qr_base64()?;
    println!("{}", qr_code);   
}

With serde support


Add it to your Cargo.toml:

[dependencies.totp-rs]
version = "^5.0"
features = ["serde_support"]

With otpauth url support


Add it to your Cargo.toml:

[dependencies.totp-rs]
version = "^5.0"
features = ["otpauth"]

You can then do something like:

use totp_rs::TOTP;

fn main() {
    let otpauth = "otpauth://totp/GitHub:constantoine@github.com?secret=KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ&issuer=GitHub";
    let totp = TOTP::from_url(otpauth).unwrap();
    println!("{}", totp.generate_current().unwrap());
}

With gen_secret


Add it to your Cargo.toml:

[dependencies.totp-rs]
version = "^5.3"
features = ["gen_secret"]

You can then do something like:

use totp_rs::{Algorithm, TOTP, Secret};

fn main() {
    let totp = TOTP::new(
        Algorithm::SHA1,
        6,
        1,
        30,
        Secret::default().to_bytes().unwrap(),
        Some("Github".to_string()),
        "constantoine@github.com".to_string(),
    ).unwrap();
    let qr_code = totp.get_qr_base64()?;
    println!("{}", qr_code);   
}

Which is equivalent to

use totp_rs::{Algorithm, TOTP, Secret};

fn main() {
    let totp = TOTP::new(
        Algorithm::SHA1,
        6,
        1,
        30,
        Secret::generate_secret().to_bytes().unwrap(),
        Some("Github".to_string()),
        "constantoine@github.com".to_string(),
    ).unwrap();
    let qr_code = totp.get_qr_base64()?;
    println!("{}", qr_code);   
}

With RFC-6238 compliant default


You can do something like this

use totp_rs::{Algorithm, TOTP, Secret, Rfc6238};

fn main () {
    let mut rfc = Rfc6238::with_defaults(
            Secret::Encoded("KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ".to_string()).to_bytes().unwrap(),
        )
        .unwrap();

    // optional, set digits
    rfc.digits(8).unwrap();

    // create a TOTP from rfc
    let totp = TOTP::from_rfc6238(rfc).unwrap();
    let code = totp.generate_current().unwrap();
    println!("code: {}", code);
}

With gen_secret feature, you can go even further and have all values by default and a secure secret.

Note: With otpauth feature, TOTP.issuer will be None, and TOTP.account_name will be "". Be sure to set those fields before generating an URL/QRCode

fn main() {
    let totp = TOTP::default();
    let code = totp.generate_current().unwrap();
    println!("code: {}", code);
}

New TOTP from steam secret


Add it to your Cargo.toml:

[dependencies.totp-rs]
version = "^5.3"
features = ["steam"]

You can then do something like:

use totp_rs::{TOTP, Secret};

fn main() {
    let totp = TOTP::new_steam(
        Secret::Encoded("KRSXG5CTMVRXEZLUKN2XAZLSKNSWG4TFOQ".to_string()).to_bytes().unwrap(),
    ).unwrap();
    let code = totp.generate_current().unwrap();
    println!("code: {}", code);   
}

Dependencies

~0.5–2.8MB
~36K SLoC