uxum 0.9.5

Opinionated backend service framework based on axum
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

//! AAA - errors.

use thiserror::Error;

use crate::errors::IoError;

/// Error type used in authentication and authorization layer.
#[derive(Clone, Debug, Error)]
#[non_exhaustive]
pub enum AuthError {
    /// No authentication data provided.
    #[error("No authentication data provided")]
    NoAuthProvided,
    /// Invalid format for Authorization header.
    #[error("Invalid format for Authorization header")]
    InvalidAuthHeader,
    /// Unknown authentication scheme.
    #[error("Unknown authentication scheme: {0}")]
    UnknownAuthScheme(String),
    /// Authentication payload decoding error.
    #[error("Authentication payload decoding error: {0}")]
    PayloadDecode(#[from] base64::DecodeError),
    /// Authentication payload is not printable.
    #[error("Authentication payload is not printable: {0}")]
    NonPrintablePayload(#[from] std::string::FromUtf8Error),
    /// Invalid authentication payload.
    #[error("Invalid authentication payload")]
    InvalidAuthPayload,
    /// User not recognized.
    ///
    /// [`AuthError::UserNotFound`] and [`AuthError::AuthFailed`] must produce exactly the same
    /// response to not divulge sensitive information.
    #[error("Authentication failed")]
    UserNotFound,
    /// Authentication failed.
    ///
    /// [`AuthError::UserNotFound`] and [`AuthError::AuthFailed`] must produce exactly the same
    /// response to not divulge sensitive information.
    #[error("Authentication failed")]
    AuthFailed,
    /// User does not have permission.
    #[error("User does not have permission: {0}")]
    NoPermission(&'static str),
}

/// Error on setting up authentication framework.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum AuthSetupError {
    /// Key loading error.
    #[error("Key loading error (file {0}): {1}")]
    KeyIo(String, IoError),
    #[cfg(feature = "jwt")]
    /// Key decoding error.
    #[error("Key decoding error: {0}")]
    KeyDecode(#[from] jsonwebtoken::errors::Error),
}