Struct Totp

pub struct Totp<D>
where
    D: CoreProxy,
    D::Core: HashMarker + UpdateCore + FixedOutputCore + BufferKindUser<BufferKind = Eager> + Default + Clone,
    <D::Core as BlockSizeUser>::BlockSize: IsLess<U256>,
    Le<<D::Core as BlockSizeUser>::BlockSize, U256>: NonZero,
{ /* private fields */ }

TOTP

Implementation of TOTP in RFC 6238.

Examples

Common Usage

use minotp::*;
use sha1::Sha1;

let secret = b"test";

let totp = Totp::<Sha1>::from_bytes(secret, COMMON_INTERVAL).unwrap();

// Get remaining seconds
let _remaining_seconds = totp.remaining_sec();

// Get token
let _token = totp.gen_6_str();

// -- snip -- //

Base32 secret

Use a third-party crate (e.g., data_encoding) to decode your secret if your secret is Base32 encoded.

use data_encoding::BASE32;
use minotp::*;
use sha1::Sha1;

let secret_base32_str = "ORSXG5A=";

let secret = BASE32.decode(secret_base32_str.as_bytes()).unwrap();

let totp = Totp::<Sha1>::from_bytes(&secret, COMMON_INTERVAL).unwrap();

let _token = totp.gen_6_str();

// -- snip -- //

Implementations

impl<D> Totp<D>

where D: CoreProxy, D::Core: HashMarker + UpdateCore + FixedOutputCore + BufferKindUser<BufferKind = Eager> + Default + Clone, <D::Core as BlockSizeUser>::BlockSize: IsLess<U256>, Le<<D::Core as BlockSizeUser>::BlockSize, U256>: NonZero,

pub fn from_bytes(secret: &[u8], interval: u32) -> Result<Self, InvalidLength>

where Self: Sized,

Instantiate a TOTP instance

pub fn new( secret: &[u8], interval: u32, timestamp: u64, ) -> Result<Self, InvalidLength>

Instantiate a TOTP instance with custom timestamp

Examples

use minotp::*;
use sha1::Sha1;

let secret = b"test";
let interval = 75;
let unix_timestamp = 112345u64;

let totp = Totp::<Sha1>::new(secret, interval, unix_timestamp).unwrap();

assert_eq!(totp.gen_6_str(), "677062");

pub fn interval(&self) -> u32

Interval of current TOTP instance in seconds

pub fn remaining_sec(&self) -> u32

Remaining seconds of current token since instantiated

Trait Implementations

impl<D> GenerateOtp for Totp<D>

where D: CoreProxy, D::Core: HashMarker + UpdateCore + FixedOutputCore + BufferKindUser<BufferKind = Eager> + Default + Clone, <D::Core as BlockSizeUser>::BlockSize: IsLess<U256>, Le<<D::Core as BlockSizeUser>::BlockSize, U256>: NonZero,

fn gen(self, digits: u8) -> u32

Generate an OTP token as an unsigned number

fn gen_str(self, digits: u8) -> String

where Self: Sized,

Generate an OTP token as a string