https://github.com/eendroroy/rusotp
https://github.com/eendroroy/rusotp
hotp otp totp
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/eendroroy/rusotp
- Owner: eendroroy
- License: agpl-3.0
- Created: 2025-01-12T09:41:16.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-04-09T05:42:28.000Z (9 months ago)
- Last Synced: 2025-04-09T06:30:42.705Z (9 months ago)
- Topics: hotp, otp, totp
- Language: Rust
- Homepage:
- Size: 177 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rusotp
OTP generation and validation library.
* Implements [RFC4226](https://datatracker.ietf.org/doc/html/rfc4226)
and [RFC6238](https://datatracker.ietf.org/doc/html/rfc6238)
* Supports alphanumeric OTP generation
* Supports `HmacSha1`, `HmacSha256`, and `HmacSha512` digests
**Note:** `HmacSha1` support is provided for RFC compliance.
It is recommended to use `HmacSha256` or `HmacSha512` for better security.
## Usage HOTP
To use the `rusotp` library for HOTP, follow these steps:
1. Add `rusotp` to your `Cargo.toml`:
```toml
[dependencies]
rusotp = "0.3.2"
```
2. Import the necessary components in your Rust code:
```rust
use rusotp::{Algorithm, HOTP};
```
3. Create a new HOTP instance and generate an OTP:
```rust
const ALGORITHM: Algorithm = Algorithm::SHA256;
const SECRET: &str = "12345678901234567890";
const LENGTH: u8 = 6;
const COUNTER: u64 = 1;
let hotp = HOTP::new(ALGORITHM, SECRET, LENGTH, 10).unwrap();
let otp = hotp.generate(COUNTER).unwrap();
println!("Generated OTP: {}", otp);
```
4. Verify an OTP:
```rust
let is_valid = hotp.verify("287082", COUNTER, 0).unwrap();
println!("Is OTP valid? {}", is_valid);
```
5. Generate a provisioning URI for use with OTP apps like Google Authenticator:
```rust
const ISSUER: &str = "MyService";
const NAME: &str = "user@example.com";
let uri = hotp.provisioning_uri(ISSUER, NAME, COUNTER).unwrap();
println!("Provisioning URI: {}", uri);
```
For more examples and detailed usage, refer to the [documentation](https://docs.rs/rusotp).
## Usage TOTP
To use the `rusotp` library, follow these steps:
1. Add `rusotp` to your `Cargo.toml`:
```toml
[dependencies]
rusotp = "0.3.2"
```
2. Import the necessary components in your Rust code:
```rust
use rusotp::{Algorithm, TOTP};
```
3. Create a new TOTP instance and generate an OTP:
```rust
const ALGORITHM: Algorithm = Algorithm::SHA256;
const SECRET: &str = "12345678901234567890";
const LENGTH: u8 = 6;
const RADIX: u8 = 10;
const INTERVAL: u8 = 30;
let totp = TOTP::new(ALGORITHM, SECRET, LENGTH, RADIX, INTERVAL).unwrap();
let otp = totp.generate().unwrap();
println!("Generated OTP: {}", otp);
```
4. Verify an OTP:
```rust
let is_valid = totp.verify(&otp);
println!("Is OTP valid? {}", is_valid);
```
5. Generate a provisioning URI for use with OTP apps like Google Authenticator:
```rust
const ISSUER: &str = "MyService";
const NAME: &str = "user@example.com";
let uri = totp.provisioning_uri(ISSUER, NAME).unwrap();
println!("Provisioning URI: {}", uri);
```
For more examples and detailed usage, refer to the [documentation](https://docs.rs/rusotp).
## Contributing
We welcome contributions to the [rusotp](https://github.com/eendroroy/rusotp) project! Here are some ways you can help:
1. **Report Bugs**: If you find a bug, please report it by opening an issue on GitHub.
2. **Suggest Features**: If you have an idea for a new feature, please open an issue to discuss it.
3. **Submit Pull Requests**: If you want to contribute code, follow these steps:
1. Fork the repository (https://github.com/eendroroy/rusotp/fork)
2. Create a new branch (`git checkout -b my-new-feature`)
3. Make your changes and commit them (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Open a Pull Request
Please make sure your contributions adhere to our [Code of Conduct](http://contributor-covenant.org).