Struct otpauth::TOTP

pub struct TOTP { /* fields omitted */ }

Two-step verification of TOTP algorithm

Methods

impl TOTP

pub fn new<S: Into<String>>(secret: S) -> TOTP

Constructs a new TOTP

pub fn from_base32<S: Into<String>>(secret: S) -> Option<TOTP>

Constructs a new TOTP with base-32 encoded secret bytes

pub fn from_bytes(bytes: &[u8]) -> TOTP

Constructs a new TOTP with secret bytes

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

Generate a TOTP code.

A TOTP code is an extension of HOTP algorithm.

period: A period that a TOTP code is valid in seconds

timestamp: Create TOTP at this given timestamp

pub fn verify(&self, code: u32, period: u64, timestamp: u64) -> bool

Valid a TOTP code.

code: A number that is less than 6 characters.

period: A period that a TOTP code is valid in seconds

timestamp: Validate TOTP at this given timestamp

pub fn base32_secret(&self) -> String

Return the secret bytes in base32 encoding.

pub fn to_uri<S: AsRef<str>>(&self, label: S, issuer: S) -> String

Generate the otpauth protocal string.

label: Label of the identifier.

issuer: The company, the organization or something else.

Trait Implementations

impl Eq for TOTP

impl Clone for TOTP

fn clone(&self) -> TOTP

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<TOTP> for TOTP

fn eq(&self, other: &TOTP) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TOTP) -> bool

This method tests for !=.

impl Debug for TOTP

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

Formats the value using the given formatter.