Struct TotpCredential 

pub struct TotpCredential {
    pub secret: B32,
    pub period: u8,
    pub digits: u8,
    pub username: Option<String>,
    pub algorithm: OTPHashAlgorithm,
    pub issuer: Option<String>,
}

Note: Enrollment in TOTP credentials historically has been quite non-standardized but typically authenticator and RP implementations have more or less aligned with the early Google Authenticator implementation spelled out at https://github.com/google/google-authenticator/wiki/Key-Uri-Format. This specification was designed with that in mind.

Fields

secret: B32

The shared secret used to generate the OTPs. This MUST be a Base32 string

period: u8

The time step used to refresh the OTP in seconds. The default SHOULD be 30 seconds, although the relying party MAY customize this to a different value.

digits: u8

The number of digits to generate and display to the user each period. The default SHOULD be 6, although the relying party MAY customize this to a different value.

username: Option<String>

This member contains the username of the account this TotpCredential is used for.

Note: While this member is optional, it is strongly recommended to be included if available.

algorithm: OTPHashAlgorithm

The algorithm used to generate the OTP hashes. This value SHOULD be a member of OTPHashAlgorithm but importers MUST ignore TotpCredential entries with unknown algorithm values.

issuer: Option<String>

This member contains the relying party that issued the credential and should be user consumable.

Note: While this member is optional, it is strongly recommended to be included if available.

Trait Implementations

impl Clone for TotpCredential

fn clone(&self) -> TotpCredential

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TotpCredential

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TotpCredential

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TotpCredential

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.