Struct Rfc6238

pub struct Rfc6238 { /* private fields */ }

rfc-6238 compliant set of options to create a TOTP

Example

use totp_rs::{Rfc6238, TOTP};

let mut rfc = Rfc6238::with_defaults(
    "totp-sercret-123".as_bytes().to_vec()
).unwrap();

// optional, set digits, issuer, account_name
rfc.digits(8).unwrap();

let totp = TOTP::from_rfc6238(rfc).unwrap();

Implementations

impl Rfc6238

pub fn new( digits: usize, secret: Vec<u8>, issuer: Option<String>, account_name: String, ) -> Result<Rfc6238, Rfc6238Error>

Create an rfc-6238 compliant set of options that can be turned into a TOTP.

Errors

will return a Rfc6238Error when

• digits is lower than 6 or higher than 8.
• secret is smaller than 128 bits (16 characters).

pub fn with_defaults(secret: Vec<u8>) -> Result<Rfc6238, Rfc6238Error>

Create an rfc-6238 compliant set of options that can be turned into a TOTP, with a default value of 6 for digits, None issuer and an empty account.

Errors

will return a Rfc6238Error when

• digits is lower than 6 or higher than 8.
• secret is smaller than 128 bits (16 characters).

pub fn digits(&mut self, value: usize) -> Result<(), Rfc6238Error>

Set the digits.

pub fn issuer(&mut self, value: String)

Set the issuer.

pub fn account_name(&mut self, value: String)

Set the account_name.

Trait Implementations

impl Clone for Rfc6238

fn clone(&self) -> Rfc6238

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rfc6238

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

Formats the value using the given formatter.

impl TryFrom<Rfc6238> for TOTP

fn try_from(rfc: Rfc6238) -> Result<Self, Self::Error>

Try to create a TOTP from a Rfc6238 config.

type Error = TotpUrlError

The type returned in the event of a conversion error.