Skip to main content

Hotp

Struct Hotp 

Source
pub struct Hotp<'a> { /* private fields */ }
Expand description

Configuration for HMAC-based One-Time Password (HOTP).

Implementations§

Source§

impl<'a> Hotp<'a>

Source

pub fn new<'s: 'a>( secret: &'s impl AsRef<[u8]>, algorithm: Algorithm, digits: u8, ) -> Result<Self, Error>

Creates a new HOTP configuration.

§Arguments
  • secret - The raw byte array of the shared secret.
  • algorithm - The HMAC hashing algorithm.
  • digits - Length of the output token (typically 6 or 8).
§Errors

Returns Error::InvalidDigits if digits is 0 or greater than 10.

Source

pub fn secret(&self) -> &'a [u8]

Returns the shared secret.

Source

pub fn algorithm(&self) -> Algorithm

Returns the hashing algorithm.

Source

pub fn digits(&self) -> u8

Returns the number of digits in the output token.

Source

pub fn generate(&self, counter: u64) -> Result<String, Error>

Implements the core HOTP generation algorithm (RFC 4226).

§Errors

Returns Error::InvalidSecret if the internal HMAC implementation rejects the secret length.

Source

pub fn verify(&self, code: &str, counter: u64) -> Result<bool, Error>

Verifies a user-provided token against a specific counter.

§Errors

Returns Error::InvalidSecret if the internal HMAC implementation rejects the secret length.

Trait Implementations§

Source§

impl<'a> Clone for Hotp<'a>

Source§

fn clone(&self) -> Hotp<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Hotp<'a>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Hotp<'a>

§

impl<'a> RefUnwindSafe for Hotp<'a>

§

impl<'a> Send for Hotp<'a>

§

impl<'a> Sync for Hotp<'a>

§

impl<'a> Unpin for Hotp<'a>

§

impl<'a> UnsafeUnpin for Hotp<'a>

§

impl<'a> UnwindSafe for Hotp<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.