adminx-core 0.3.0

Framework-neutral core for the adminx admin-panel framework: the Resource trait, storage abstraction, registry, and neutral request/response types shared by every web-framework and database adapter.
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

// adminx-core/src/request.rs
//
// A neutral request context. Adapters build this from their framework's request
// (extracting the query string, path params, authenticated claims, and the CSRF
// cookie) and hand it to Resource methods.

use std::collections::HashMap;

/// Authenticated principal, decoded from the auth cookie by `auth::build_ctx`.
#[derive(Debug, Clone, Default)]
pub struct Claims {
    pub sub: String,
    pub email: String,
    pub role: String,
    pub roles: Vec<String>,
    /// MFA step for this session: `"ok"` (fully authenticated) or `"pending"`
    /// (password verified, awaiting a second factor). Empty on anonymous ctx.
    pub mfa: String,
}

#[derive(Debug, Clone, Default)]
pub struct ReqCtx {
    /// Raw query string (without leading `?`).
    pub query: String,
    /// Prefix the adminx app is mounted at (e.g. `/adminx`), used to build links.
    pub mount: String,
    pub path_params: HashMap<String, String>,
    pub headers: HashMap<String, String>,
    pub claims: Option<Claims>,
    /// Raw CSRF cookie value, if the request carried one. Compared against the
    /// hidden form field on POST; see `crate::csrf`.
    pub csrf: Option<String>,
}

impl ReqCtx {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn with_query(mut self, query: impl Into<String>) -> Self {
        self.query = query.into();
        self
    }

    pub fn with_mount(mut self, mount: impl Into<String>) -> Self {
        self.mount = mount.into();
        self
    }

    pub fn with_claims(mut self, claims: Claims) -> Self {
        self.claims = Some(claims);
        self
    }

    pub fn with_csrf(mut self, csrf: impl Into<String>) -> Self {
        self.csrf = Some(csrf.into());
        self
    }

    /// All roles for the current principal (`role` plus `roles`), empty if anon.
    pub fn roles(&self) -> Vec<String> {
        match &self.claims {
            Some(c) => {
                let mut r = c.roles.clone();
                if !c.role.is_empty() && !r.contains(&c.role) {
                    r.push(c.role.clone());
                }
                r
            }
            None => Vec::new(),
        }
    }
}