authen 0.1.0

A robust, modular, high-level, and secure authentication crate 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

use thiserror::Error;

/// All possible errors that can occur within the authentication crate.
///
/// This enum is used throughout the crate to represent error conditions that may arise
/// during authentication, user management, password handling, token operations, and more.
/// Each variant is documented to clarify the context in which it is used.

#[derive(Debug, Error)]
pub enum AuthError {
    /// Returned when the provided credentials are invalid (e.g., wrong password or username).
    #[error("Invalid credentials provided.")]
    InvalidCredentials,

    /// Returned when a user cannot be found in the data store.
    #[error("User not found.")]
    UserNotFound,

    /// Returned when attempting to create a user that already exists.
    #[error("User already exists.")]
    UserAlreadyExists,

    /// Returned when password hashing fails.
    /// Contains the underlying error message.
    #[error("Password hashing failed: {0}")]
    HashingError(String),

    /// Returned when password verification fails.
    /// Contains the underlying error message.
    #[error("Password verification failed: {0}")]
    PasswordVerificationError(String),

    /// Returned when there is a configuration error in the authentication system.
    /// Contains a description of the configuration issue.
    #[error("Configuration error: {0}")]
    ConfigError(String),

    /// Returned when a service required for authentication is unavailable.
    /// Contains a description of the service issue.
    #[error("Service unavailable: {0}")]
    ServiceUnavailable(String),

    /// Returned when a feature is not yet implemented.
    /// Contains a description of the missing feature.
    #[error("Feature not implemented yet: {0}")]
    NotImplemented(String),

    /// Returned when input data is invalid or malformed.
    /// Contains a description of the invalid input.
    #[error("Invalid input data: {0}")]
    InvalidInput(String),

    /// Returned when a password does not meet policy requirements or is otherwise invalid.
    /// Contains a description of the password issue.
    #[error("Invalid password: {0}")]
    InvalidPassword(String),

    /// Returned when a verification process fails (e.g., email or token verification).
    /// Contains a description of the verification error.
    #[error("Verification error: {0}")]
    VerificationError(String),

    /// Returned when a token (such as a JWT) has expired and is no longer valid.
    #[error("Token expired")]
    TokenExpired,

    /// Returned when token generation fails.
    /// Contains a description of the generation error.
    #[error("Token generation failed: {0}")]
    TokenGeneration(String),

    /// Returned when token validation fails.
    /// Contains a description of the validation error.
    #[error("Token validation failed: {0}")]
    TokenValidation(String),

    /// Returned when a token is invalid (malformed, tampered, or otherwise unusable).
    /// Contains a description of the invalid token.
    #[error("InvalidToken: {0}")]
    InvalidToken(String),

    /// Returned when the password manager component is missing or unavailable.
    #[error("Missing password manager")]
    MissingPasswordManager,

    /// Returned when the persistent user manager component is missing or unavailable.
    #[error("Missing persistent user manager")]
    MissingPersistentUserManager,

    /// Returned when the token manager component is missing or unavailable.
    #[error("Missing token manager")]
    MissingTokenManager,
    /// Returned when a network error occurs during OAuth operations.
    #[error("OAuth network error: {0}")]
    OAuthNetwork(String),

    /// Returned when an invalid response is received from the OAuth provider.
    #[error("OAuth invalid response: {0}")]
    OAuthInvalidResponse(String),

    /// Returned when the OAuth provider returns an error.
    #[error("OAuth provider error: {0}")]
    OAuthProvider(String),

    /// Returned when the token exchange process fails during OAuth.
    #[error("OAuth token exchange failed: {0}")]
    OAuthTokenExchange(String),

    /// Returned when fetching user info from the OAuth provider fails.
    #[error("OAuth user info fetch failed: {0}")]
    OAuthUserInfo(String),

    /// Returned for other errors related to OAuth operations.
    #[error("OAuth other error: {0}")]
    OAuthOther(String),

    /// Returned when a user signup operation fails.
    /// Contains a description of the signup error.
    #[error("User signup error: {0}")]
    SignupError(String),

    /// Returned when a user login operation fails.
    /// Contains a description of the login error.
    #[error("User login error: {0}")]
    LoginError(String),

    /// Returned when a database error occurs (only available with the `postgres` feature).
    /// Contains a description of the database error.
    #[cfg(feature = "postgres")]
    #[error("Database error: {0}")]
    DatabaseError(String),
}