Skip to main content

TOTP

Struct TOTP 

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

TOTP generator and validator.

Secret is securely zeroized from memory when dropped.

Implementations§

Source§

impl TOTP

Source

pub fn new(secret: Vec<u8>, digits: usize, interval: u64) -> Self

Create new TOTP with secret.

Source

pub fn with_secret(secret: Vec<u8>) -> Self

Create with default settings (6 digits, 30 second interval).

Source

pub fn generate_secret() -> Result<Vec<u8>>

Generate a random secret.

Source

pub fn generate(&self, timestamp: Option<u64>) -> String

Generate TOTP code for given time.

Source

pub fn verify(&self, code: &str, timestamp: Option<u64>, window: u32) -> bool

Verify TOTP code with time window.

Source

pub fn secret_to_base32(secret: &[u8]) -> String

Convert secret to Base32.

Source

pub fn secret_from_base32(encoded: &str) -> Result<Vec<u8>>

Decode Base32 secret.

Source

pub fn provisioning_uri(&self, account: &str, issuer: &str) -> String

Generate provisioning URI for QR codes.

Source

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

Get the secret.

Trait Implementations§

Source§

impl Drop for TOTP

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Zeroize for TOTP

Source§

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

Auto Trait Implementations§

§

impl Freeze 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> 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, 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.