#hotp #totp #otp

rust-otp

A Rust library for performing the HMAC-based One-Time Password (HOTP) and Time-based One-Time Password (TOTP) algorithms

2 stable releases

2.0.0 Dec 26, 2023
1.0.0 Dec 17, 2023

#508 in Authentication

Download history 24/week @ 2024-03-12 8/week @ 2024-03-19 22/week @ 2024-03-26 26/week @ 2024-04-02 27/week @ 2024-04-09 33/week @ 2024-04-16 45/week @ 2024-04-23 62/week @ 2024-04-30 29/week @ 2024-05-07 16/week @ 2024-05-14 27/week @ 2024-05-21 24/week @ 2024-05-28 24/week @ 2024-06-04 24/week @ 2024-06-11 20/week @ 2024-06-18 76/week @ 2024-06-25

156 downloads per month
Used in 2 crates (via deepwell)

MIT license

8KB
80 lines

rust-otp

Build Status

rust-otp is a Rust library for performing the HMAC-based One-time Passsword Algorithm as per RFC 4226 and the Time-based One-time Password Algorithm as per RFC 6238. These are also the algorithms many mobile-based 2FA apps, such as Google Authenticator and Authy, use to generate 2FA codes.

Installation

Just add the library as a dependency by adding the following section to your Cargo.toml file.

[dependencies.otp]

git = "https://github.com/WesleyBatista/rust-otp"

Usage

   // first argument is the secret, second argument is the counter
    println!("HOTP: {:?}", otp::make_hotp("base32secret3232".to_ascii_uppercase().as_str(), 0).unwrap());
    assert_eq!(otp::make_hotp(&"base32secret3232".to_ascii_uppercase(), 0).unwrap(), 260182);

    // first argument is the secret, followed by the time step in seconds (Google
    // Authenticator uses a time step of 30), and then the skew in seconds
    // (often used when calculating HOTPs for a sequence of consecutive
    // time intervals, to deal with potential latency and desynchronization).

    println!("TOTP: {:?}", otp::make_totp(&("base32secret3232".to_ascii_uppercase()), 30, 0).unwrap());
    // there is a non-zero possibility of this assertion failing
    assert_ne!(otp::make_totp(&"base32secret3232".to_ascii_uppercase(), 30, 0).unwrap(), 260182_u32);

License

rust-otp is licensed under the MIT license. The full license is included in this repository in LICENSE.md.

Dependencies

~7–15MB
~278K SLoC