Skip to main content

TOTP

Struct TOTP 

Source
pub struct TOTP { /* private fields */ }
Expand description

Time-based One-Time Password (TOTP) generator.

Implements RFC 6238.

Implementations§

Source§

impl TOTP

Source

pub fn builder() -> TOTPBuilder

Returns a new TOTP builder

Source

pub fn new( secret: Vec<u8>, algorithm: Algorithm, digits: u32, time_step: u64, ) -> Self

Creates a new TOTP instance with the given parameters

Source

pub fn generate_at(&self, timestamp: u64) -> u32

Generates the TOTP value for a specific timestamp

Source

pub fn generate_current(&self) -> Result<u32, Error>

Generates the TOTP value for the current system time

§Errors

Returns error if system time is before Unix epoch.

Source

pub fn generate_formatted_at(&self, timestamp: u64) -> String

Generates the TOTP value as a formatted string with leading zeros for a specific timestamp

Source

pub fn generate_current_formatted(&self) -> Result<String, Error>

Generates the formatted TOTP value (with leading zeros) for the current system time

§Errors

Returns error if system time is before Unix epoch.

Source

pub fn verify_at(&self, code: u32, timestamp: u64, window: u32) -> bool

Verifies a TOTP code at a specific timestamp with a given look-back/forward window.

The window is the number of steps to check before and after the current step. For example, a window of 1 means it will check the current, previous, and next step.

Source

pub fn verify_current(&self, code: u32, window: u32) -> Result<bool, Error>

Verifies a TOTP code for the current time with default window of 0.

§Errors

Returns error if system time is before Unix epoch.

Source

pub fn verify_current_formatted( &self, code: &str, window: u32, ) -> Result<bool, Error>

Verifies a formatted TOTP string for the current time.

§Errors

Returns error if system time is before Unix epoch or if code is not a valid number.

Trait Implementations§

Source§

impl Clone for TOTP

Source§

fn clone(&self) -> Self

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 Debug for TOTP

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Forget for TOTP

§

impl Freeze for TOTP

§

impl Move for TOTP

§

impl RefUnwindSafe for TOTP

§

impl Send for TOTP

§

impl Sync for TOTP

§

impl Unpin for TOTP

§

impl UnsafeUnpin for TOTP

§

impl UnwindSafe for TOTP

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.