otp-std 0.2.3

Generating and verifying One-Time Passwords.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! Authentication scheme.

use const_macros::const_early;

use miette::Diagnostic;
use thiserror::Error;

use crate::{auth::url::Url, macros::errors};

/// The scheme used in OTP URLs.
pub const SCHEME: &str = "otpauth";

/// Represents errors that occur when unexpected schemes are encountered.
///
/// The only scheme valid for OTP URLs is [`SCHEME`].
#[derive(Debug, Error, Diagnostic)]
#[error("unexpected scheme `{scheme}`; expected `{SCHEME}`")]
#[diagnostic(code(otp_std::auth::scheme), help("make sure the scheme is correct"))]
pub struct Error {
    /// The unexpected scheme.
    pub scheme: String,
}

impl Error {
    /// Constructs [`Self`].
    pub const fn new(scheme: String) -> Self {
        Self { scheme }
    }
}

errors! {
    Type = Error,
    Hack = $,
    error => new(scheme => to_owned),
}

/// Checks whether the given scheme matches [`SCHEME`].
///
/// # Errors
///
/// Returns [`struct@Error`] when the scheme does not match [`SCHEME`].
pub fn check<S: AsRef<str>>(scheme: S) -> Result<(), Error> {
    fn check_inner(scheme: &str) -> Result<(), Error> {
        const_early!(scheme != SCHEME => error!(scheme));

        Ok(())
    }

    check_inner(scheme.as_ref())
}

/// Checks whether the given URL has the scheme matching [`SCHEME`].
///
/// # Errors
///
/// Returns [`struct@Error`] when the URL scheme does not match [`SCHEME`].
pub fn check_url(url: &Url) -> Result<(), Error> {
    check(url.scheme())
}