otp_offline 0.2.0

Library for offline verification of YubiKey OTPs.
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

//! `YubiKey` OTP Verification Library
//!
//! This crate provides functionality for handling `YubiKey` One-Time Passwords,
//! including parsing, decryption, validation, and simple storage offline without contacting the YubiCloud service.
//!
//! # Features
//!
//! This crate provides optional features that can be individually enabled or disabled:
//!
//! - `decryption` (default): Enables OTP decryption and core validation functionality, including the [`otp`] and [`store`] modules
//! - `modhex` (default): Enables modhex encoding/decoding support for `YubiKey` OTP format via the [`modhex`] module
//! - `simple_store`: Enables a simple example key-value store implementation for persisting OTP data and preventing replay attacks (requires `decryption` and `modhex`)
//!
//! Both `decryption` and `modhex` are enabled by default. You can disable all defaults and opt-in to specific features as needed.
//!
//! # Core Modules
//!
//! - [`otp`]: Contains the main OTP decryption and validation logic
//! - [`modhex`]: Handles modhex encoding and decoding for `YubiKey` OTP format
//! - [`simple_store`]: Provides a simple (example) key-value store for persisting OTP data and preventing replay attacks
//!
//! For more information about the `YubiKey` OTP protocol, see: <https://developers.yubico.com/OTP/OTPs_Explained.html>

#[cfg(feature = "modhex")]
pub mod modhex;

#[cfg(feature = "decryption")]
pub mod otp;

#[cfg(feature = "decryption")]
pub mod store;

#[cfg(feature = "simple_store")]
pub mod simple_store;