Module libreauth::oath

Implementation of standards which are part of the OATH Reference Architecture.

Examples

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

let code = hotp.generate();
assert_eq!(code, "755224");
assert!(hotp.is_valid(&"755224".to_owned()));

let code = hotp.increment_counter().generate();
assert_eq!(code, "287082");
assert!(hotp.is_valid(&"287082".to_owned()));

let key_base32 = "GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ".to_owned();
let mut totp = libreauth::oath::TOTPBuilder::new()
    .base32_key(&key_base32)
    .finalize()
    .unwrap();

let code = totp.generate();
println!("TOTP code: {}", code);

assert!(totp.is_valid(&code));

Structs

• HOTP
  Generates, manipulates and checks HOTP codes.
• HOTPBuilder
  Builds an HOTP object.
• HOTPcfg
  [C binding] HOTP configuration storage
• KeyUriBuilder
  Creates the Key Uri Format according to the Google authenticator specification by calling key_uri_format() on HOTP or TOTP. This value can be used to generete QR codes which allow easy scanning by the end user.
• TOTP
  Generates and checks TOTP codes.
• TOTPBuilder
  Builds a TOTP object.
• TOTPcfg
  [C binding] TOTP configuration storage

Enums

• Error
  Errors used for the Rust interface.
• ErrorCode
  Error codes used in the C interface.
• ParametersVisibility
  Defines the base policy for showing or hiding parameters in a Key URI.

Functions

• libreauth_hotp_generate
  [C binding] Generate an HOTP code according to the given configuration and stores it in the supplied buffer.
• libreauth_hotp_get_uri^⚠
  [C binding] Generate the key URI.
• libreauth_hotp_init^⚠
  [C binding] Initialize a struct libreauth_hotp_cfg with the default values.
• libreauth_hotp_is_valid
  [C binding] Check whether or not the supplied HOTP code is valid.
• libreauth_totp_generate
  [C binding] Generate a TOTP code according to the given configuration and stores it in the supplied buffer.
• libreauth_totp_get_uri^⚠
  [C binding] Generate the key URI.
• libreauth_totp_init^⚠
  [C binding] Initialize a struct libreauth_totp_cfg with the default values.
• libreauth_totp_is_valid
  [C binding] Initialize a struct libreauth_totp_cfg with the default values.