balloon-hash 0.4.0

Pure Rust implementation of the Balloon password hashing 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
57
58
59
60
61
62
63
64
65
66
67
68

//! Error type

use core::fmt;

#[cfg(feature = "password-hash")]
use password_hash::errors::InvalidValue;

/// Result with balloon's [`Error`] type.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
    /// Algorithm identifier invalid.
    AlgorithmInvalid,
    /// Memory cost is too small.
    MemoryTooLittle,
    /// Not enough threads.
    ThreadsTooFew,
    /// Too many threads.
    ThreadsTooMany,
    /// Time cost is too small.
    TimeTooSmall,
    /// Output size not correct.
    OutputSize {
        /// Output size provided.
        actual: usize,
        /// Output size expected.
        expected: usize,
    },
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::AlgorithmInvalid => f.write_str("algorithm identifier invalid"),
            Error::MemoryTooLittle => f.write_str("memory cost is too small"),
            Error::ThreadsTooFew => f.write_str("not enough threads"),
            Error::ThreadsTooMany => f.write_str("too many threads"),
            Error::TimeTooSmall => f.write_str("time cost is too small"),
            Error::OutputSize { expected, .. } => {
                write!(f, "unexpected output size, expected {expected} bytes")
            }
        }
    }
}

#[cfg(feature = "password-hash")]
#[cfg_attr(docsrs, doc(cfg(feature = "password-hash")))]
impl From<Error> for password_hash::Error {
    fn from(err: Error) -> password_hash::Error {
        match err {
            Error::AlgorithmInvalid => password_hash::Error::Algorithm,
            Error::MemoryTooLittle => InvalidValue::TooShort.param_error(),
            Error::ThreadsTooFew => InvalidValue::TooShort.param_error(),
            Error::ThreadsTooMany => InvalidValue::TooLong.param_error(),
            Error::TimeTooSmall => InvalidValue::TooShort.param_error(),
            Error::OutputSize { actual, expected } => password_hash::Error::OutputSize {
                provided: actual.cmp(&expected),
                expected,
            },
        }
    }
}

#[cfg(feature = "std")]
impl std::error::Error for Error {}