libreauth 0.18.1

Collection of user authentication tools.
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

/// Error codes used in the C interface.
///
/// ## C interface
/// The C interface uses an enum of type `libreauth_pass_errno` and the members has been renamed
/// as follows:
/// <table>
///     <thead>
///         <tr>
///             <th>Rust</th>
///             <th>C</th>
///         </tr>
///     </thead>
///     <tbody>
///         <tr>
///             <td>Success</td>
///             <td>LIBREAUTH_PASS_SUCCESS</td>
///         </tr>
///         <tr>
///             <td>PasswordTooShort</td>
///             <td>LIBREAUTH_PASS_PASSWORD_TOO_SHORT</td>
///         </tr>
///         <tr>
///             <td>PasswordTooLong</td>
///             <td>LIBREAUTH_PASS_PASSWORD_TOO_LONG</td>
///         </tr>
///         <tr>
///             <td>InvalidPasswordFormat</td>
///             <td>LIBREAUTH_PASS_INVALID_PASSWORD_FORMAT</td>
///         </tr>
///         <tr>
///             <td>IncompatibleOption</td>
///             <td>LIBREAUTH_PASS_INCOMPATIBLE_OPTION</td>
///         </tr>
///         <tr>
///             <td>NotEnoughSpace</td>
///             <td>LIBREAUTH_PASS_NOT_ENOUGH_SPACE</td>
///         </tr>
///         <tr>
///             <td>NullPtr</td>
///             <td>LIBREAUTH_PASS_NULL_PTR</td>
///         </tr>
///         <tr>
///             <td>InvalidKeyLen</td>
///             <td>LIBREAUTH_PASS_INVALID_KEY_LEN</td>
///         </tr>
///     </tbody>
/// </table>
#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub enum ErrorCode {
	/// Used in C-bindings to indicate the absence of errors.
	Success = 0,
	/// The password is shorter than the minimal length.
	PasswordTooShort = 1,
	/// The password is longer than the maximal length.
	PasswordTooLong = 2,
	/// The input does not respect the [storage format](crate::pass).
	InvalidPasswordFormat = 10,
	/// Some options you specified are incompatible.
	IncompatibleOption = 11,
	/// Used in C-bindings to indicate the storage does not have enough space to store the data.
	NotEnoughSpace = 20,
	/// Used in C-bindings to indicate a NULL pointer.
	NullPtr = 21,
	/// Used in C-bindings to indicate an invalid key length.
	InvalidKeyLen = 22,
}

/// Errors for the Rust interface.
///
/// *To implement `std::error::Error`, the `stderror` feature must be activated*
#[derive(Clone, Copy, Debug)]
#[cfg_attr(feature = "thiserror", derive(thiserror::Error))]
pub enum Error {
	#[cfg_attr(
		feature = "thiserror",
		error("Password was shorter than the minimal length (actual {actual}, min {min})")
	)]
	PasswordTooShort { min: usize, actual: usize },
	#[cfg_attr(
		feature = "thiserror",
		error("Password was longer than the maximal length (actual {actual}, max {max})")
	)]
	PasswordTooLong { max: usize, actual: usize },
	#[cfg_attr(
		feature = "thiserror",
		error("Input does not respect the storage format")
	)]
	InvalidPasswordFormat,
}

impl From<Error> for ErrorCode {
	fn from(error: Error) -> Self {
		match error {
			Error::PasswordTooShort { min: _, actual: _ } => ErrorCode::PasswordTooShort,
			Error::PasswordTooLong { max: _, actual: _ } => ErrorCode::PasswordTooLong,
			Error::InvalidPasswordFormat => ErrorCode::InvalidPasswordFormat,
		}
	}
}

impl From<digest::InvalidLength> for ErrorCode {
	fn from(_error: digest::InvalidLength) -> Self {
		ErrorCode::InvalidPasswordFormat
	}
}

impl From<hmac::digest::InvalidLength> for Error {
	fn from(_error: hmac::digest::InvalidLength) -> Self {
		Error::InvalidPasswordFormat
	}
}