Struct Base

pub struct Base<'b> {
    pub secret: Secret<'b>,
    pub algorithm: Algorithm,
    pub digits: Digits,
}

Represents OTP base configuration.

Fields

secret: Secret<'b>

The secret to use as the key.

algorithm: Algorithm

The algorithm to use.

digits: Digits

The number of digits to return.

Implementations

impl<'b> Base<'b>

pub fn builder() -> BaseBuilder<'b>

Create an instance of Base using the builder syntax

impl Base<'_>

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

Generates codes based on the given input.

Panics

Even though unwrap and indexing are used, the code will never panic, provided the HMAC implementation is correct.

pub fn generate_string(&self, input: u64) -> String

Calls generate and returns the string representation of the resulting code.

The resulting string is padded with zeros if needed (see string).

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

Verifies that the given code matches the given input.

pub fn verify_string<S: AsRef<str>>(&self, input: u64, code: S) -> bool

Verifies that the given string code matches the given input in constant time.

This method exists to simplify verification.

impl Base<'_>

pub fn query_for(&self, url: &mut Url)

Available on crate feature auth only.

Applies the base configuration to the given URL.

pub fn extract_from(query: &mut Query<'_>) -> Result<Self, Error>

Available on crate feature auth only.

Extracts the base configuration from the given query.

Errors

Returns Error if the base configuration can not be extracted.

impl Base<'_>

pub fn into_owned(self) -> Owned

Converts Self into Owned.

Trait Implementations

impl<'b> Clone for Base<'b>

fn clone(&self) -> Base<'b>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'b> Debug for Base<'b>

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

Formats the value using the given formatter.

impl<'de, 'b> Deserialize<'de> for Base<'b>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'b> Hash for Base<'b>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'b> PartialEq for Base<'b>

fn eq(&self, other: &Base<'b>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'b> Serialize for Base<'b>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'b> Eq for Base<'b>

impl<'b> StructuralPartialEq for Base<'b>