Struct HOTP

pub struct HOTP { /* private fields */ }

This is the secret that will be used to generate HMAC based one-time-passwords.

References

• This object implements utilities for RFC4226.

Implementations

impl HOTP

pub fn new(algorithm: HOTPAlgorithm) -> Result<HOTP, Unspecified>

Creates a new HOTPSecret from OS generated random number.

Arguments

• algorithm - Algorithm to use for OTP generation.

pub fn from_base32(data: &str) -> Result<HOTP, ()>

Loads a base32 encoded secret.

Arguments

• data - base32 encoded secret to load.

pub fn from_bin(data: &[u8]) -> Result<HOTP, ()>

Loads the HOTP secret from a given [u8].

Arguments

• data - The shared secret.
• algorithm - Algorithm used for OTP generation.

pub fn get_secret_base32(&self) -> String

Exports the HOTP Secret as base32 encoded string.

pub fn get_otp(&self, counter: &[u8], digits: u32) -> u32

Generates a One Time Password from the provided parameters.

Arguments

• counter - Password’s counter. This counter value should never be reused for security reasons.
• digits - Desired OTP length, this value should be at least 6.

pub fn validate(&self, counter: &[u8], digits: u32, guess: u32) -> bool

Validates the given OTP

Arguments

• counter - The counter to test against.
• digits - The OTPs length.
• guess - A user provided guess to validate.

Note

It is recommended to check the following counters in case the user skipped an OTP. You should verify that an OTP with the same counter was not already used.