authfix 0.1.1

A simple and extensible authentication layer for Actix Web, designed for fast integration and easy configuration.
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

//! General configuration for session auth
use std::sync::Arc;

use crate::middleware::PathMatcher;

/// Configuration for the auth related API endpoints: login, logout, verify MFA
///
/// The default routes are: "/login", "/login/mfa" and "/logout"
/// ```ignore
/// let routes = Routes::default();
/// ```
///
/// Routes implements [From] for [PathMatcher], the resulting PathMatcher is then configured for securing all routes by default.
/// ```no_run
/// use authfix::middleware::PathMatcher;
/// use authfix::session::config::Routes;
///
/// let path_matcher: PathMatcher = Routes::new("/auth", "/login", "/mfa", "/logout").into();
/// ```

#[derive(Clone)]
pub struct Routes {
    inner: Arc<RoutesInner>,
}

struct RoutesInner {
    login: String,
    logout: String,
    mfa: String,
    default_redirect: String,
}

impl Routes {
    pub fn new(prefix: &str, login: &str, mfa: &str, logout: &str) -> Self {
        Self {
            inner: Arc::new(RoutesInner {
                login: create_uri(prefix, login),
                logout: create_uri(prefix, logout),
                mfa: create_uri(prefix, mfa),
                default_redirect: normalize_uri_part("/"),
            }),
        }
    }

    /// Sets the default redirect URI, where the user is redirected after a successful login.
    pub fn set_default_redirect(self, redirect: &str) -> Self {
        Self {
            inner: Arc::new(RoutesInner {
                login: self.inner.login.clone(),
                logout: self.inner.logout.clone(),
                mfa: self.inner.mfa.clone(),
                default_redirect: normalize_uri_part(redirect),
            }),
        }
    }

    pub fn default_redirect(&self) -> &str {
        &self.inner.default_redirect
    }

    pub fn login(&self) -> &str {
        &self.inner.login
    }
    pub fn logout(&self) -> &str {
        &self.inner.logout
    }
    pub fn mfa(&self) -> &str {
        &self.inner.mfa
    }
}

impl From<Routes> for PathMatcher {
    fn from(value: Routes) -> Self {
        PathMatcher::new(vec![value.login()], true)
    }
}

impl Default for Routes {
    fn default() -> Self {
        Self {
            inner: Arc::new(RoutesInner {
                login: "/login".to_owned(),
                logout: "/logout".to_owned(),
                mfa: "/login/mfa".to_owned(),
                default_redirect: normalize_uri_part("/"),
            }),
        }
    }
}

fn create_uri(prefix: &str, endpoint: &str) -> String {
    if prefix.trim() == "" || prefix.trim() == "/" {
        normalize_uri_part(endpoint)
    } else {
        format!(
            "{}{}",
            normalize_uri_part(prefix),
            normalize_uri_part(endpoint)
        )
    }
}

fn normalize_uri_part(part: &str) -> String {
    let mut normalized = part.to_owned().to_lowercase();

    if normalized.ends_with("/") && normalized.len() > 1 {
        normalized = normalized[0..(part.len() - 1)].to_owned();
    }

    if !normalized.starts_with("/") {
        normalized = format!("/{normalized}");
    }

    normalized
}

#[cfg(test)]
mod test {
    use super::Routes;
    use crate::{middleware::PathMatcher, session::config::normalize_uri_part};

    #[test]
    fn should_be_able_to_add_routes_to_path_matcher() {
        let routes = Routes::new("", "/custom-login", "/custom-mfa", "/logout");

        let mut path_matcher: PathMatcher = routes.into();
        path_matcher.add(vec!["/public"]);

        assert!(!path_matcher.matches("/custom-login"));
        assert!(!path_matcher.matches("/public"));
    }

    #[test]
    fn path_matcher_can_be_created_from_routes() {
        let routes = Routes::new("", "/custom-login", "/custom-mfa", "/logout");
        let path_matcher: PathMatcher = routes.into();

        assert!(!path_matcher.matches("/custom-login"));
        assert!(path_matcher.matches("/custom-mfa"));
        assert!(path_matcher.matches("/logout"));
    }

    #[test]
    fn should_ignore_empty_prefix() {
        let routes = Routes::new("", "/login", "/mfa", "/logout");

        assert_eq!(routes.login(), "/login");
    }

    #[test]
    fn normalize_uri_part_test() {
        assert_eq!("/login/mfa", normalize_uri_part("/login/mfa/"));
        assert_eq!("/login/mfa", normalize_uri_part("login/mfa/"));
        assert_eq!("/login/mfa", normalize_uri_part("login/mfa"));
        assert_eq!("/", normalize_uri_part("/"));
        assert_eq!("/", normalize_uri_part(""));
    }
}