minotp 1.2.1

Simple OTP library for Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# minotp

![GitHub Release](https://img.shields.io/github/v/release/chardon55/minotp)

Simple OTP library for Rust.

## Usage

### Installation

Add `minotp` into your project.

```bash
cargo add minotp@1
```

Also all hash libraries you want (e.g., SHA1 of [Rust Crypto](https://github.com/RustCrypto)).

```bash
cargo add sha1
```

### TOTP (commonly used)

```rust
use minotp::*;
use sha1::Sha1;

let secret = b"test";

let totp = Totp::<Sha1>::from_bytes(secret, 30).unwrap();

// Get remaining seconds
let _remaining_seconds = totp.remaining_sec();

// Get token as a 6-digit owned string
let _token = totp.gen_6_str();

// -- snip -- //
```

Use an encoding crate to decode a Base32 encoded secret
if you have to deal with one.

For example, using [`data_encoding`](https://crates.io/crates/data-encoding).

```rust
use data_encoding::BASE32;
use minotp::*;
use sha1::Sha1;

let secret_base32_str = "ORSXG5A=";

let secret = BASE32.decode(secret_base32_str.as_bytes()).unwrap();

let totp = Totp::<Sha1>::from_bytes(&secret, 30).unwrap();

let _token = totp.gen_6_str();

// -- snip -- //
```

## Found any bug?

~~You must be kidding.~~ Fire an issue right now if you found one!