yescrypt 0.1.0

Pure Rust implementation of the yescrypt password-based key derivation function
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

//! Error type.

use core::{fmt, num::TryFromIntError};

/// Result type for the `yescrypt` crate with its [`Error`] type.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
    /// Encoding error (i.e. Base64)
    Encoding,

    /// Internal error (bug in library)
    Internal,

    /// Invalid params
    Params,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::Encoding => write!(f, "yescrypt encoding invalid"),
            Error::Internal => write!(f, "internal error"),
            Error::Params => write!(f, "yescrypt params invalid"),
        }
    }
}

impl core::error::Error for Error {}

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

#[cfg(feature = "kdf")]
impl From<Error> for kdf::Error {
    fn from(_: Error) -> Self {
        kdf::Error
    }
}

#[cfg(feature = "password-hash")]
impl From<Error> for password_hash::Error {
    fn from(err: Error) -> Self {
        match err {
            Error::Encoding => password_hash::Error::EncodingInvalid,
            Error::Internal => password_hash::Error::Internal,
            Error::Params => password_hash::Error::ParamsInvalid,
        }
    }
}