mcf 0.6.0

Pure Rust implementation of the Modular Crypt Format (MCF) which is used to store password hashes in the form `${id}$...`
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
60
61
62
63
64
65
66
67
68
69
70

//! Error types.

use core::fmt;

#[cfg(feature = "base64")]
use base64ct::Error as B64Error;

/// Result type for `mcf`.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
    /// Base64 encoding errors.
    #[cfg(feature = "base64")]
    Base64(B64Error),

    /// `$` delimiter either missing or in an unexpected place
    DelimiterInvalid,

    /// Encoding validation failure or error during encode time
    EncodingInvalid,

    /// MCF field (between `$` characters) is not well-formed
    FieldInvalid,

    /// MCF identifier missing
    IdentifierMissing,

    /// MCF identifier invalid (must be `a-z`, `0-9`, or `-`)
    IdentifierInvalid,
}

impl core::error::Error for Error {
    fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
        match self {
            #[cfg(feature = "base64")]
            Error::Base64(e) => Some(e),
            _ => None,
        }
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            #[cfg(feature = "base64")]
            Error::Base64(base64_err) => write!(f, "{base64_err}"),
            Error::DelimiterInvalid => write!(f, "invalid use of `$` delimiter"),
            Error::EncodingInvalid => write!(f, "invalid MCF encoding"),
            Error::FieldInvalid => write!(f, "invalid MCF field (between `$` characters)"),
            Error::IdentifierMissing => write!(f, "MCF identifier missing"),
            Error::IdentifierInvalid => write!(f, "MCF identifier invalid"),
        }
    }
}

#[cfg(feature = "base64")]
impl From<B64Error> for Error {
    fn from(base64_err: B64Error) -> Self {
        Error::Base64(base64_err)
    }
}

impl From<fmt::Error> for Error {
    fn from(_: fmt::Error) -> Self {
        Error::EncodingInvalid
    }
}