Struct boringauth::oath::HOTP

pub struct HOTP { /* fields omitted */ }

Methods

impl HOTP

pub fn generate(&self) -> String

Generate the HOTP value.

Examples

let key_ascii = "12345678901234567890".to_owned();
let mut hotp = boringauth::oath::HOTPBuilder::new()
    .ascii_key(&key_ascii)
    .finalize()
    .unwrap();

let code = hotp.generate();
assert_eq!(code, "755224");
let code = hotp.increment_counter().generate();
assert_eq!(code, "287082");

pub fn increment_counter(&mut self) -> &mut HOTP

Increments the internal counter.

pub fn is_valid(&self, code: &String) -> bool

Checks if the given code is valid. This implementation uses the double HMAC verification in order to prevent a timing side channel attack.

Examples

let key_ascii = "12345678901234567890".to_owned();
let user_code = "755224".to_owned();
let valid = boringauth::oath::HOTPBuilder::new()
    .ascii_key(&key_ascii)
    .finalize()
    .unwrap()
    .is_valid(&user_code);
assert_eq!(valid, true);