OTP generation and validation library.
- Implements RFC4226 and RFC6238
- Supports alphanumeric OTP generation
- Supports
HmacSha1,HmacSha256, andHmacSha512digests
Note: HmacSha1 support is provided for RFC compliance.
It is recommended to use HmacSha256 or HmacSha512 for better security.
Add rusotp to your Cargo.toml:
[dependencies]
rusotp = "0.4.0"use rusotp::{Algorithm, Radix, Secret, HOTP};
use std::num::NonZeroU8;
const ALGORITHM: Algorithm = Algorithm::SHA1;
const COUNTER: u64 = 1;
fn main() {
let secret = Secret::new("12345678901234567890").unwrap();
let radix = Radix::new(10).unwrap();
// Generate an OTP
let hotp = HOTP::new(ALGORITHM, secret, NonZeroU8::new(6).unwrap(), radix);
let otp = hotp.generate(COUNTER).unwrap();
println!("Generated OTP: {}", otp);
// Verify an OTP
let is_valid = hotp.verify("287082", COUNTER, 0).unwrap();
println!("Is OTP valid? {}", is_valid.is_some());
// Generate provisioning URI
const ISSUER: &str = "MyService";
let uri = hotp.provisioning_uri(ISSUER, COUNTER).unwrap();
println!("Provisioning URI: {}", uri);
}use rusotp::{Algorithm, Radix, Secret, TOTP};
use std::num::NonZero;
const ALGORITHM: Algorithm = Algorithm::SHA1;
const LENGTH: u8 = 6;
const INTERVAL: u64 = 30;
fn main() {
let radix = Radix::new(10).unwrap();
let secret = Secret::new("12345678901234567890").unwrap();
// Generate an OTP
let totp = TOTP::new(ALGORITHM, secret, NonZero::new(LENGTH).unwrap(), radix, NonZero::new(INTERVAL).unwrap());
let otp = totp.generate().unwrap();
println!("Generated OTP: {}", otp);
// Verify an OTP
let is_valid = totp.verify(&otp, None, 0, 0).unwrap();
println!("Is OTP valid? {}", is_valid.is_some());
// Generate provisioning URI
const ISSUER: &str = "MyService";
const NAME: &str = "user@example.com";
let uri = totp.provisioning_uri(ISSUER, NAME).unwrap();
println!("Provisioning URI: {}", uri);
}#include <stdio.h>
#include "rusotp.hpp"
int main() {
HotpConfig config = {"SHA1", "12345678901234567890", 6, 10};
unsigned long counter = 2;
// Generate an OTP
StringResult otp = hotp_generate(config, counter);
printf("HOTP : %s\n", otp.data);
// Verify an OTP
const char *verified = hotp_verify(config, otp.data, counter, 0).data ? "true" : "false";
printf("VERIFIED : %s\n", verified);
// Generate provisioning URI
StringResult uri = hotp_provisioning_uri(config, "rusotp", counter);
printf("URI : %s\n", uri.data);
return 0;
}#include <stdio.h>
#include "rusotp.hpp"
int main() {
TotpConfig config = {"SHA1", "12345678901234567890", 6, 10, 30};
unsigned long timestamp = 10000;
// Generate an OTP
StringResult otp_now = totp_generate(config);
printf("NOW: %s\n", otp_now.data);
// Verify an OTP
const char *verified = totp_verify(config, otp_now.data, 0, 0, 0).data ? "true" : "false";
printf("VERIFIED : %s\n", verified);
// Generate an OTP at given timestamp
StringResult otp_at = totp_generate_at(config, timestamp);
printf("AT: %s\n", otp_at.data);
// Verify an OTP generated at given timestamp
const char *verified_at = totp_verify_at(config, otp_at.data, timestamp, 0, 0, 0).data ? "true" : "false";
printf("VERIFIED : %s\n", verified_at);
// Generate provisioning URI
StringResult provisioning_uri = totp_provisioning_uri(config, "rusotp", "user@email.mail");
printf("URI : %s\n", provisioning_uri.data);
return 0;
}See the docs.rs/rusotp for more examples and API details.
We welcome contributions to the rusotp project! Here are some ways you can help:
- Report Bugs: If you find a bug, please report it by opening an issue on GitHub.
- Suggest Features: If you have an idea for a new feature, please open an issue to discuss it.
- Submit Pull Requests: If you want to contribute code, follow these steps:
- Fork the repository (https://github.com/eendroroy/rusotp/fork)
- Create a new branch (
git checkout -b my-new-feature) - Make your changes and commit them (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Open a Pull Request
Please make sure your contributions adhere to our Code of Conduct.
This project is licensed under the GNU AGPL-3.0 License. See the LICENSE file for more details.