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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

/// Enum representing the various kinds of errors
#[derive(Fail, 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 ErrorKind {
    /// Additional data too long. Length in bytes must be less than 2^32
    #[fail(display = "Additional data too long. Length in bytes must be less than 2^32")]
    AdditionalDataTooLongError,

    /// Backend encode error. u32 provided could not be encoded into a Backend
    #[fail(display = "Backend encode error. u32 provided could not be encoded into a Backend")]
    BackendEncodeError,

    /// Rust backend not yet supported. Please use the C backend
    #[fail(display = "Rust backend not yet supported. Please use the C backend")]
    BackendUnsupportedError,

    /// Base64 decode error. Bytes provided were invalid base64
    #[fail(display = "Base64 decode error. Bytes provided were invalid base64")]
    Base64DecodeError,

    /// This is a bug in the argonautica crate and should be unreachable. Please file an issue
    #[fail(
        display = "This is a bug in the argonautica crate and should be unreachable. Please file an issue"
    )]
    Bug,

    /// Hash decode error. Hash provided was invalid
    #[fail(display = "Hash decode error. Hash provided was invalid")]
    HashDecodeError,

    #[cfg(test)]
    /// Hash encode error. HashRaw provided could not be encoded into a hash
    #[fail(display = "Hash encode error. HashRaw provided could not be encoded into a hash")]
    HashEncodeError,

    /// Hash length too short. Hash length must be at least 4
    #[fail(display = "Hash length too short. Hash length must be at least 4")]
    HashLenTooShortError,

    /// Hash missing. Attempted to verify without first having provided a hash
    #[fail(display = "Hash missing. Attempted to verify without first having provided a hash")]
    HashMissingError,

    /// Iterations too few. Iterations must be greater than 0
    #[fail(display = "Iterations must be greater than 0")]
    IterationsTooFewError,

    /// Lanes too few. Lanes must be greater than 0
    #[fail(display = "Lanes must be greater than 0")]
    LanesTooFewError,

    /// Lanes too many. Lanes must be less than 2^24
    #[fail(display = "Lanes must be less than 2^24")]
    LanesTooManyError,

    /// C code attempted to allocate memory (using malloc) and failed
    #[fail(display = "C code attempted to allocate memory (using malloc) and failed")]
    MemoryAllocationError,

    /// Memory size invalid. Memory size must be a power of two
    #[fail(display = "Memory size invalid. Memory size must be a power of two")]
    MemorySizeInvalidError,

    /// Memory size too small. Memory size must be at least 8 times the number of lanes
    #[fail(
        display = "Memory size too small. Memory size must be at least 8 times the number of lanes"
    )]
    MemorySizeTooSmallError,

    /// Failed to access OS random number generator
    #[fail(display = "Failed to access OS random number generator")]
    OsRngError,

    /// Password immutable error. You attempted to hash or verify with an immutable password and password_clearing set to true, which is not possible because with an immutable password argonautica cannot zero out the password bytes. To prevent this error, either pass Hasher or Verifier a mutable password or set password_clearing to false
    #[fail(
        display = "Password immutable error. You attempted to hash or verify with an immutable password and password_clearing set to true, which is not possible because with an immutable password argonautica cannot zero out the password bytes. To prevent this error, either pass Hasher or Verifier a mutable password or set password_clearing to false"
    )]
    PasswordImmutableError,

    /// Password missing. Attempted to verify without first having provided a password
    #[fail(
        display = "Password missing. Attempted to verify without first having provided a password"
    )]
    PasswordMissingError,

    /// Password too long. Length in bytes must be less than 2^32
    #[fail(display = "Password too long. Length in bytes must be less than 2^32")]
    PasswordTooLongError,

    /// Password too short. Length in bytes must be greater than 0
    #[fail(display = "Password too short. Length in bytes must be greater than 0")]
    PasswordTooShortError,

    /// Salt too long. Length in bytes must be less than 2^32
    #[fail(display = "Salt too long. Length in bytes must be less than 2^32")]
    SaltTooLongError,

    /// Salt too short. Length in bytes must be at least 8
    #[fail(display = "Salt too short. Length in bytes must be at least 8")]
    SaltTooShortError,

    /// Secret key immutable error. You attempted to hash or verify with an immutable secret key and secret_key_clearing set to true, which is not possible because with an immutable secret key argonautica cannot zero out the secret key bytes. To prevent this error, either pass Hasher or Verifier a mutable secret key or set secret_key_clearing to false
    #[fail(
        display = "Secret key immutable error. You attempted to hash or verify with an immutable secret key and secret_key_clearing set to true, which is not possible because with an immutable secret key argonautica cannot zero out the secret key bytes. To prevent this error, either pass Hasher or Verifier a mutable secret key or set secret_key_clearing to false"
    )]
    SecretKeyImmutableError,

    /// Secret key missing. Attempted to hash without a secret key without having first opted out of using a secret key
    #[fail(
        display = "Secret key missing. Attempted to hash without a secret key without having first opted out of using a secret key"
    )]
    SecretKeyMissingError,

    /// Secret key too long. Length in bytes must be less than 2^32
    #[fail(display = "Secret key too long. Length in bytes must be less than 2^32")]
    SecretKeyTooLongError,

    /// C code reported a "Threading failure" error
    #[fail(display = "C code reported a \"Threading failure\" error")]
    ThreadError,

    /// Threads too few. Threads must be greater than 0
    #[fail(display = "Threads too few. Threads must be greater than 0")]
    ThreadsTooFewError,

    /// Threads too many. Threads must be less than 2^24
    #[fail(display = "Threads too many. Threads must be less than 2^24")]
    ThreadsTooManyError,

    /// Utf-8 encode error. Bytes provided could not be encoded into utf-8
    #[fail(display = "Utf-8 encode error. Bytes provided could not be encoded into utf-8")]
    Utf8EncodeError,

    /// Variant encode error. &str provided could not be encoded into a Variant
    #[fail(display = "Variant encode error. &str provided could not be encoded into a Variant")]
    VariantEncodeError,

    /// Version encode error. &str or u32 provided could not be encoded into a Version
    #[fail(
        display = "Version encode error. &str or u32 provided could not be encoded into a Version"
    )]
    VersionEncodeError,

    #[doc(hidden)]
    #[fail(display = "__Nonexaustive variant")]
    __Nonexhaustive,
}

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

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

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

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

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