argonautica 0.2.0

Idiomatic Argon2 password hashing for Rust
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

use std::str::FromStr;

use config::defaults::DEFAULT_VERSION;
use {Error, ErrorKind};

impl Default for Version {
    /// Returns [`Version::_0x13`](enum.Version.html#variant._0x13)
    fn default() -> Version {
        DEFAULT_VERSION
    }
}

impl FromStr for Version {
    ///
    type Err = Error;

    /// Performs the following mapping:
    /// * `"16"` => `Ok(Version::_0x10)`<br/>
    /// * `"19"` => `Ok(Version::_0x13)`<br/>
    /// * anything else => an error
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "16" => Ok(Version::_0x10),
            "19" => Ok(Version::_0x13),
            _ => {
                Err(Error::new(ErrorKind::VersionEncodeError).add_context(format!("String: {}", s)))
            }
        }
    }
}

/// Enum representing the various versions of the Argon2 algorithm (
/// [`0x10`](enum.Version.html#variant._0x10) and
/// [`0x13`](enum.Version.html#variant._0x13))
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
pub enum Version {
    /// An outdated version of the Argon2 algorithm. Do <b><u>not</b></u> use this unless you have a specific reason to.
    _0x10 = 0x10,
    /// The default and latest version of the Argon2 algorithm (as of 5/18). Use this unless you have a specific reason not to.
    _0x13 = 0x13,
}

impl Version {
    /// Performs the following mapping:
    /// * `Version::_0x10` => `"16"`<br/>
    /// * `Version::_0x13` => `"19"`
    pub fn as_str(&self) -> &'static str {
        match *self {
            Version::_0x10 => "16",
            Version::_0x13 => "19",
        }
    }

    /// Performs the following mapping:
    /// * `16_u32` => `Ok(Version::_0x10)`<br/>
    /// * `19_u32` => `Ok(Version::_0x13)`<br/>
    /// * anything else => an error
    pub fn from_u32(x: u32) -> Result<Version, Error> {
        match x {
            16 => Ok(Version::_0x10),
            19 => Ok(Version::_0x13),
            _ => Err(Error::new(ErrorKind::VersionEncodeError).add_context(format!("Int: {}", x))),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_send() {
        fn assert_send<T: Send>() {}
        assert_send::<Version>();
    }

    #[test]
    fn test_sync() {
        fn assert_sync<T: Sync>() {}
        assert_sync::<Version>();
    }

    #[cfg(feature = "serde")]
    #[test]
    fn test_serialize() {
        use serde;
        fn assert_serialize<T: serde::Serialize>() {}
        assert_serialize::<Version>();
    }

    #[cfg(feature = "serde")]
    #[test]
    fn test_deserialize() {
        use serde;
        fn assert_deserialize<'de, T: serde::Deserialize<'de>>() {}
        assert_deserialize::<Version>();
    }
}