securitydept-utils 0.2.0-beta.2

Utils of SecurityDept, a layered authentication and authorization toolkit built as reusable Rust crates.
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

use std::borrow::Cow;

use serde::Serialize;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum UserRecovery {
    None,
    Retry,
    RestartFlow,
    Reauthenticate,
    ContactSupport,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct ErrorPresentation {
    pub code: &'static str,
    pub message: Cow<'static, str>,
    pub recovery: UserRecovery,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ServerErrorKind {
    InvalidRequest,
    Unauthenticated,
    Unauthorized,
    Conflict,
    Unavailable,
    Internal,
}

impl ServerErrorKind {
    pub const fn from_http_status(status: u16) -> Self {
        match status {
            400 | 404 | 422 => Self::InvalidRequest,
            401 => Self::Unauthenticated,
            403 => Self::Unauthorized,
            409 => Self::Conflict,
            503 => Self::Unavailable,
            _ if status >= 500 => Self::Internal,
            _ => Self::InvalidRequest,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct ServerErrorDescriptor {
    pub kind: ServerErrorKind,
    pub code: &'static str,
    pub message: Cow<'static, str>,
    pub recovery: UserRecovery,
    pub retryable: bool,
    pub presentation: ErrorPresentation,
}

impl ServerErrorDescriptor {
    pub fn new(kind: ServerErrorKind, presentation: ErrorPresentation) -> Self {
        let retryable = presentation.recovery == UserRecovery::Retry;
        Self {
            kind,
            code: presentation.code,
            message: presentation.message.clone(),
            recovery: presentation.recovery,
            retryable,
            presentation,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct ServerErrorEnvelope {
    pub success: bool,
    pub status: u16,
    pub error: ServerErrorDescriptor,
}

impl ServerErrorEnvelope {
    pub fn new(status: u16, error: ServerErrorDescriptor) -> Self {
        Self {
            success: false,
            status,
            error,
        }
    }
}

impl ErrorPresentation {
    pub fn new(
        code: &'static str,
        message: impl Into<Cow<'static, str>>,
        recovery: UserRecovery,
    ) -> Self {
        Self {
            code,
            message: message.into(),
            recovery,
        }
    }
}

pub trait ToErrorPresentation {
    fn to_error_presentation(&self) -> ErrorPresentation;
}

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

    #[test]
    fn server_error_kind_derives_from_status() {
        assert_eq!(
            ServerErrorKind::from_http_status(401),
            ServerErrorKind::Unauthenticated
        );
        assert_eq!(
            ServerErrorKind::from_http_status(409),
            ServerErrorKind::Conflict
        );
        assert_eq!(
            ServerErrorKind::from_http_status(503),
            ServerErrorKind::Unavailable
        );
    }

    #[test]
    fn server_error_descriptor_preserves_dual_layer_fields() {
        let descriptor = ServerErrorDescriptor::new(
            ServerErrorKind::InvalidRequest,
            ErrorPresentation::new(
                "token_set_frontend.redirect_uri_invalid",
                "The redirect URL is invalid.",
                UserRecovery::RestartFlow,
            ),
        );

        assert_eq!(descriptor.kind, ServerErrorKind::InvalidRequest);
        assert_eq!(descriptor.code, "token_set_frontend.redirect_uri_invalid");
        assert_eq!(descriptor.recovery, UserRecovery::RestartFlow);
        assert_eq!(descriptor.presentation.code, descriptor.code);
        assert!(!descriptor.retryable);
    }
}