webgates 1.0.0

Application-facing composition crate for webgates authentication and authorization.
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
159
160
161

use std::fmt::Display;
use std::sync::Arc;

use crate::accounts::Account;
use crate::authz::access_hierarchy::AccessHierarchy;
use crate::authz::access_policy::AccessPolicy;
use crate::authz::authorization_service::AuthorizationService;
use crate::codecs::jwt::RegisteredClaims;
use crate::codecs::jwt::validation_service::JwtClaimsVerifier;
use crate::codecs::jwt::{JwtClaims, validation_result::JwtValidationResult};
use uuid::Uuid;

/// Outcome of evaluating a cookie token against a remote-JWKS verifier.
#[derive(Debug, Clone)]
pub enum RemoteCookieEvaluation<R, G>
where
    R: AccessHierarchy + Eq + Display + Clone,
    G: Eq + Clone,
{
    OptionalAnonymous,
    OptionalAuthorized {
        account: Account<R, G>,
        registered_claims: RegisteredClaims,
    },
    MissingToken,
    InvalidToken,
    InvalidIssuer {
        expected: String,
        actual: String,
    },
    DenyAllPolicy,
    PolicyDenied {
        account_id: Uuid,
    },
    Authorized {
        account: Account<R, G>,
        registered_claims: RegisteredClaims,
    },
}

/// Framework-agnostic runtime for cookie verification via a remote-JWKS verifier.
#[derive(Clone)]
pub struct RemoteJwksCookieGateRuntime<V, R, G>
where
    V: JwtClaimsVerifier<JwtClaims<Account<R, G>>>,
    R: AccessHierarchy + Eq + Display + Clone,
    G: Eq + Clone,
{
    authorization_service: AuthorizationService<R, G>,
    verifier: Arc<V>,
    expected_issuer: String,
    install_optional_extensions: bool,
}

impl<V, R, G> RemoteJwksCookieGateRuntime<V, R, G>
where
    V: JwtClaimsVerifier<JwtClaims<Account<R, G>>>,
    R: AccessHierarchy + Eq + Display + Clone,
    G: Eq + Clone,
{
    pub fn new(
        verifier: Arc<V>,
        expected_issuer: impl Into<String>,
        policy: AccessPolicy<R, G>,
        install_optional_extensions: bool,
    ) -> Self {
        Self {
            authorization_service: AuthorizationService::new(policy),
            verifier,
            expected_issuer: expected_issuer.into(),
            install_optional_extensions,
        }
    }

    pub fn evaluate(&self, token: Option<&str>) -> RemoteCookieEvaluation<R, G> {
        if self.install_optional_extensions {
            if let Some(token) = token {
                match self.verifier.verify_token(token) {
                    Ok(jwt) if jwt.registered_claims.issuer == self.expected_issuer => {
                        return RemoteCookieEvaluation::OptionalAuthorized {
                            account: jwt.custom_claims,
                            registered_claims: jwt.registered_claims,
                        };
                    }
                    _ => {}
                }
            }
            return RemoteCookieEvaluation::OptionalAnonymous;
        }

        if self.authorization_service.policy_denies_all_access() {
            return RemoteCookieEvaluation::DenyAllPolicy;
        }

        let Some(token) = token else {
            return RemoteCookieEvaluation::MissingToken;
        };

        match self.verifier.verify_token(token) {
            Ok(jwt) => {
                let account = jwt.custom_claims;
                let registered_claims = jwt.registered_claims;

                if registered_claims.issuer != self.expected_issuer {
                    return RemoteCookieEvaluation::InvalidIssuer {
                        expected: self.expected_issuer.clone(),
                        actual: registered_claims.issuer,
                    };
                }

                let account_id = account.account_id;
                if self.authorization_service.is_authorized(&account) {
                    RemoteCookieEvaluation::Authorized {
                        account,
                        registered_claims,
                    }
                } else {
                    RemoteCookieEvaluation::PolicyDenied { account_id }
                }
            }
            Err(_) => RemoteCookieEvaluation::InvalidToken,
        }
    }

    pub fn verifier(&self) -> Arc<V> {
        Arc::clone(&self.verifier)
    }

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

    pub fn policy(&self) -> AccessPolicy<R, G> {
        self.authorization_service.clone_policy()
    }

    pub fn with_optional_extensions(mut self, optional: bool) -> Self {
        self.install_optional_extensions = optional;
        self
    }
}

/// Map existing local validation results into remote-cookie evaluations.
pub fn map_validation_result_to_remote_evaluation<R, G>(
    result: JwtValidationResult<Account<R, G>>,
) -> RemoteCookieEvaluation<R, G>
where
    R: AccessHierarchy + Eq + Display + Clone,
    G: Eq + Clone,
{
    match result {
        JwtValidationResult::Valid(jwt) => RemoteCookieEvaluation::Authorized {
            account: jwt.custom_claims,
            registered_claims: jwt.registered_claims,
        },
        JwtValidationResult::InvalidToken => RemoteCookieEvaluation::InvalidToken,
        JwtValidationResult::InvalidIssuer { expected, actual } => {
            RemoteCookieEvaluation::InvalidIssuer { expected, actual }
        }
    }
}