Struct libreauth::oath::KeyUriBuilder

pub struct KeyUriBuilder<'a> { /* fields omitted */ }

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.

WARNING: The finalized value contains the secret key of the authentication process and should only be displayed to the corresponding user!

Example

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

let uri = totp
    .key_uri_format("Provider1", "alice@example.com")
    .finalize();

assert_eq!(
    uri,
    "otpauth://totp/Provider1:alice@example.com?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=Provider1"
);

Methods

impl<'a> KeyUriBuilder<'a>

pub fn parameters_visibility_policy(self, policy: ParametersVisibility) -> Self

Set the visibility policy for parameters.

Example

use libreauth::oath::{ParametersVisibility, TOTPBuilder };

let key_ascii = "12345678901234567890".to_owned();
let mut totp = TOTPBuilder::new()
    .ascii_key(&key_ascii)
    .finalize()
    .unwrap();

let uri = totp
    .key_uri_format("Provider1", "alice@example.com")
    .parameters_visibility_policy(ParametersVisibility::HideAll)
    .finalize();

assert_eq!(
    uri,
    "otpauth://totp/Provider1:alice@example.com?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ"
);

pub fn overwrite_label(self, label: &'a str) -> Self

Completely overwrite the default {issuer}:{account_name} label with a custom one.

Example

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

let uri = totp
    .key_uri_format("Provider1", "alice@example.com")
    .overwrite_label("Provider1Label")
    .finalize();

assert_eq!(
    uri,
    "otpauth://totp/Provider1Label?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=Provider1"
);

pub fn add_parameter(self, key: &'a str, value: &'a str) -> Self

Add a custom key/value parameter.

Example

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

let uri = totp
    .key_uri_format("Provider1", "alice@example.com")
    .add_parameter("foo", "bar")
    .finalize();

assert_eq!(
    uri,
    "otpauth://totp/Provider1:alice@example.com?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=Provider1&foo=bar"
);

pub fn finalize(&self) -> String

Generate the final format.