stateset-authz 0.8.0

IO-free, framework-agnostic authorization engine for StateSet iCommerce — roles, permissions, rate limiting, audit logging, and field redaction
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
//! The authorization engine — combines roles, rate limiting, audit, and redaction.
//!
//! [`AuthzEngine`] is the main entry point for authorization checks. It is IO-free
//! and framework-agnostic, designed to be embedded in any runtime.

use std::collections::HashMap;

use crate::{
    AccessDecision, Action, AuditFilter, AuditLog, AuditRecord, AuthzError, AuthzResult,
    RateLimitDecision, RateLimitRule, RateLimiter, RedactionConfig, Resource, Role,
};

/// Default audit log capacity.
const DEFAULT_AUDIT_MAX_SIZE: usize = 1000;

/// The central authorization engine.
///
/// Combines role-based access control, rate limiting, audit logging, and
/// field redaction into a single, coherent API.
///
/// ```rust
/// use stateset_authz::{AuthzEngineBuilder, Role, Action, Resource};
///
/// let mut engine = AuthzEngineBuilder::new()
///     .add_role(Role::admin())
///     .add_role(Role::viewer())
///     .assign_role("alice", "admin")
///     .assign_role("bob", "viewer")
///     .build();
///
/// let decision = engine.authorize("alice", &Resource::new("orders"), &Action::Delete);
/// assert!(decision.is_allowed());
///
/// let decision = engine.authorize("bob", &Resource::new("orders"), &Action::Delete);
/// assert!(decision.is_denied());
/// ```
#[derive(Debug)]
pub struct AuthzEngine {
    roles: HashMap<String, Role>,
    actor_roles: HashMap<String, String>,
    rate_limiter: RateLimiter,
    audit_log: AuditLog,
    redaction_config: RedactionConfig,
    approval_required: Vec<ApprovalRule>,
}

/// A rule that requires explicit approval for specific operations.
#[derive(Debug, Clone)]
struct ApprovalRule {
    resource_type: Option<String>,
    action: Option<Action>,
}

impl AuthzEngine {
    /// Checks whether `actor_id` is allowed to perform `action` on `resource`.
    ///
    /// This method:
    /// 1. Looks up the actor's role
    /// 2. Checks the role's permission for the resource type
    /// 3. Checks rate limits
    /// 4. Checks approval-required rules
    /// 5. Records an audit entry
    ///
    /// ```rust
    /// use stateset_authz::{AuthzEngineBuilder, Role, Action, Resource};
    ///
    /// let mut engine = AuthzEngineBuilder::new()
    ///     .add_role(Role::viewer())
    ///     .assign_role("bob", "viewer")
    ///     .build();
    ///
    /// let d = engine.authorize("bob", &Resource::new("orders"), &Action::Read);
    /// assert!(d.is_allowed());
    /// ```
    pub fn authorize(
        &mut self,
        actor_id: &str,
        resource: &Resource,
        action: &Action,
    ) -> AccessDecision {
        // 1. Look up role
        let role = match self.resolve_role(actor_id) {
            Some(r) => r,
            None => {
                let decision =
                    AccessDecision::denied(format!("actor '{actor_id}' has no assigned role"));
                self.record_audit(actor_id, action, resource, &decision);
                return decision;
            }
        };

        // 2. Check permission level
        let decision = role.check(resource.resource_type(), action);
        if decision.is_denied() {
            self.record_audit(actor_id, action, resource, &decision);
            return decision;
        }

        // 3. Check rate limits
        let rate_decision = self.rate_limiter.check_and_record(actor_id, resource.resource_type());
        if let RateLimitDecision::Exceeded { retry_after } = rate_decision {
            let decision = AccessDecision::denied(format!(
                "rate limit exceeded for '{}' on '{}' (retry after {}ms)",
                actor_id,
                resource.resource_type(),
                retry_after.as_millis(),
            ));
            self.record_audit(actor_id, action, resource, &decision);
            return decision;
        }

        // 4. Check approval-required rules
        for rule in &self.approval_required {
            let resource_match =
                rule.resource_type.as_ref().is_none_or(|rt| rt == resource.resource_type());
            let action_match = rule.action.as_ref().is_none_or(|a| a == action);

            if resource_match && action_match {
                let decision = AccessDecision::requires_approval(format!(
                    "action '{action}' on '{}' requires explicit approval",
                    resource.resource_type(),
                ));
                self.record_audit(actor_id, action, resource, &decision);
                return decision;
            }
        }

        // 5. All checks passed
        let decision = AccessDecision::Allowed;
        self.record_audit(actor_id, action, resource, &decision);
        decision
    }

    /// Adds a new role to the engine.
    ///
    /// If a role with the same name already exists, it is replaced.
    pub fn add_role(&mut self, role: Role) {
        self.roles.insert(role.name().to_owned(), role);
    }

    /// Assigns a role to an actor.
    ///
    /// Returns an error if the role does not exist.
    pub fn assign_role(&mut self, actor_id: &str, role_name: &str) -> AuthzResult<()> {
        if !self.roles.contains_key(role_name) {
            return Err(AuthzError::invalid_role(role_name));
        }
        self.actor_roles.insert(actor_id.to_owned(), role_name.to_owned());
        Ok(())
    }

    /// Removes a role assignment for an actor.
    pub fn remove_role(&mut self, actor_id: &str) {
        self.actor_roles.remove(actor_id);
    }

    /// Returns the role assigned to an actor, if any.
    #[must_use]
    pub fn actor_role(&self, actor_id: &str) -> Option<&str> {
        self.actor_roles.get(actor_id).map(String::as_str)
    }

    /// Returns a reference to the rate limiter.
    #[must_use]
    pub const fn rate_limiter(&self) -> &RateLimiter {
        &self.rate_limiter
    }

    /// Returns a mutable reference to the rate limiter.
    pub const fn rate_limiter_mut(&mut self) -> &mut RateLimiter {
        &mut self.rate_limiter
    }

    /// Returns a reference to the audit log.
    #[must_use]
    pub const fn audit_log(&self) -> &AuditLog {
        &self.audit_log
    }

    /// Queries the audit log with the given filter.
    #[must_use]
    pub fn query_audit(&self, filter: &AuditFilter) -> Vec<&AuditRecord> {
        self.audit_log.query(filter)
    }

    /// Returns a reference to the redaction config.
    #[must_use]
    pub const fn redaction_config(&self) -> &RedactionConfig {
        &self.redaction_config
    }

    /// Redacts sensitive fields in a JSON value using the engine's redaction config.
    pub fn redact(&self, value: &mut serde_json::Value) {
        crate::redact_value(value, &self.redaction_config);
    }

    /// Adds a rate limit rule.
    pub fn add_rate_limit_rule(&mut self, rule: RateLimitRule) {
        self.rate_limiter.add_rule(rule);
    }

    /// Requires explicit approval for operations matching the criteria.
    pub fn require_approval(&mut self, resource_type: Option<String>, action: Option<Action>) {
        self.approval_required.push(ApprovalRule { resource_type, action });
    }

    // -- Private helpers --

    fn resolve_role(&self, actor_id: &str) -> Option<Role> {
        let role_name = self.actor_roles.get(actor_id)?;
        self.roles.get(role_name).cloned()
    }

    fn record_audit(
        &mut self,
        actor_id: &str,
        action: &Action,
        resource: &Resource,
        decision: &AccessDecision,
    ) {
        let record = AuditRecord::new(actor_id, *action, resource.clone(), decision.clone());
        self.audit_log.record(record);
    }
}

/// Builder for constructing an [`AuthzEngine`].
///
/// ```rust
/// use stateset_authz::{AuthzEngineBuilder, Role, RateLimitRule, RedactionConfig};
/// use std::time::Duration;
///
/// let engine = AuthzEngineBuilder::new()
///     .add_role(Role::admin())
///     .add_role(Role::viewer())
///     .assign_role("alice", "admin")
///     .assign_role("bob", "viewer")
///     .rate_limit_rule(RateLimitRule::new("orders", 100, Duration::from_secs(60)))
///     .redaction_config(RedactionConfig::default())
///     .audit_max_size(5000)
///     .build();
/// ```
#[derive(Debug)]
pub struct AuthzEngineBuilder {
    roles: HashMap<String, Role>,
    actor_roles: HashMap<String, String>,
    rate_limit_rules: Vec<RateLimitRule>,
    redaction_config: RedactionConfig,
    audit_max_size: usize,
    approval_rules: Vec<ApprovalRule>,
}

impl AuthzEngineBuilder {
    /// Creates a new builder with default settings.
    #[must_use]
    pub fn new() -> Self {
        Self {
            roles: HashMap::new(),
            actor_roles: HashMap::new(),
            rate_limit_rules: Vec::new(),
            redaction_config: RedactionConfig::default(),
            audit_max_size: DEFAULT_AUDIT_MAX_SIZE,
            approval_rules: Vec::new(),
        }
    }

    /// Adds a role to the engine.
    #[must_use]
    pub fn add_role(mut self, role: Role) -> Self {
        self.roles.insert(role.name().to_owned(), role);
        self
    }

    /// Assigns a role to an actor.
    ///
    /// [`build`](Self::build) and [`build_checked`](Self::build_checked) validate
    /// that every assigned role exists before constructing the engine.
    #[must_use]
    pub fn assign_role(
        mut self,
        actor_id: impl Into<String>,
        role_name: impl Into<String>,
    ) -> Self {
        self.actor_roles.insert(actor_id.into(), role_name.into());
        self
    }

    /// Adds a rate limit rule.
    #[must_use]
    pub fn rate_limit_rule(mut self, rule: RateLimitRule) -> Self {
        self.rate_limit_rules.push(rule);
        self
    }

    /// Sets the redaction configuration.
    #[must_use]
    pub fn redaction_config(mut self, config: RedactionConfig) -> Self {
        self.redaction_config = config;
        self
    }

    /// Sets the maximum number of audit records to retain.
    #[must_use]
    pub const fn audit_max_size(mut self, max_size: usize) -> Self {
        self.audit_max_size = max_size;
        self
    }

    /// Adds an approval requirement.
    #[must_use]
    pub fn require_approval(
        mut self,
        resource_type: Option<String>,
        action: Option<Action>,
    ) -> Self {
        self.approval_rules.push(ApprovalRule { resource_type, action });
        self
    }

    /// Builds the [`AuthzEngine`], returning an error when any assignment
    /// references a role that has not been added to the builder.
    pub fn build_checked(self) -> AuthzResult<AuthzEngine> {
        self.validate_assignments()?;
        Ok(self.build_unchecked())
    }

    /// Builds the [`AuthzEngine`].
    ///
    /// Panics when any assignment references a role that has not been added.
    /// Use [`build_checked`](Self::build_checked) to surface configuration
    /// errors without panicking.
    #[must_use]
    pub fn build(self) -> AuthzEngine {
        match self.build_checked() {
            Ok(engine) => engine,
            Err(err) => panic!("invalid AuthzEngineBuilder configuration: {err}"),
        }
    }

    fn validate_assignments(&self) -> AuthzResult<()> {
        if let Some(role_name) =
            self.actor_roles.values().find(|role_name| !self.roles.contains_key(role_name.as_str()))
        {
            return Err(AuthzError::invalid_role(role_name.clone()));
        }
        Ok(())
    }

    fn build_unchecked(self) -> AuthzEngine {
        let mut rate_limiter = RateLimiter::new();
        for rule in self.rate_limit_rules {
            rate_limiter.add_rule(rule);
        }

        AuthzEngine {
            roles: self.roles,
            actor_roles: self.actor_roles,
            rate_limiter,
            audit_log: AuditLog::new(self.audit_max_size),
            redaction_config: self.redaction_config,
            approval_required: self.approval_rules,
        }
    }
}

impl Default for AuthzEngineBuilder {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use crate::{PermissionLevel, RoleBuilder};
    use std::time::Duration;

    use super::*;

    fn basic_engine() -> AuthzEngine {
        AuthzEngineBuilder::new()
            .add_role(Role::admin())
            .add_role(Role::viewer())
            .add_role(Role::none())
            .assign_role("alice", "admin")
            .assign_role("bob", "viewer")
            .assign_role("nobody", "none")
            .build()
    }

    // -- authorize --

    #[test]
    fn admin_can_do_everything() {
        let mut engine = basic_engine();
        for &action in Action::all() {
            let d = engine.authorize("alice", &Resource::new("orders"), &action);
            assert!(d.is_allowed(), "admin should allow {action}");
        }
    }

    #[test]
    fn viewer_can_only_read() {
        let mut engine = basic_engine();
        assert!(engine.authorize("bob", &Resource::new("orders"), &Action::Read).is_allowed());
        assert!(engine.authorize("bob", &Resource::new("orders"), &Action::Create).is_denied());
    }

    #[test]
    fn none_role_denied() {
        let mut engine = basic_engine();
        assert!(engine.authorize("nobody", &Resource::new("orders"), &Action::Read).is_denied());
    }

    #[test]
    fn unknown_actor_denied() {
        let mut engine = basic_engine();
        let d = engine.authorize("ghost", &Resource::new("orders"), &Action::Read);
        assert!(d.is_denied());
        assert!(d.reason().unwrap().contains("no assigned role"));
    }

    // -- Rate limiting --

    #[test]
    fn rate_limit_blocks_after_max() {
        let mut engine = AuthzEngineBuilder::new()
            .add_role(Role::admin())
            .assign_role("alice", "admin")
            .rate_limit_rule(RateLimitRule::new("orders", 2, Duration::from_secs(60)))
            .build();

        assert!(engine.authorize("alice", &Resource::new("orders"), &Action::Read).is_allowed());
        assert!(engine.authorize("alice", &Resource::new("orders"), &Action::Read).is_allowed());
        let d = engine.authorize("alice", &Resource::new("orders"), &Action::Read);
        assert!(d.is_denied());
        assert!(d.reason().unwrap().contains("rate limit"));
    }

    // -- Approval required --

    #[test]
    fn approval_required_triggers() {
        let mut engine = AuthzEngineBuilder::new()
            .add_role(Role::admin())
            .assign_role("alice", "admin")
            .require_approval(Some("orders".to_owned()), Some(Action::Delete))
            .build();

        // Delete requires approval even for admin
        let d = engine.authorize("alice", &Resource::new("orders"), &Action::Delete);
        assert!(d.requires_approval_check());
        assert!(d.reason().unwrap().contains("requires explicit approval"));

        // But read is fine
        assert!(engine.authorize("alice", &Resource::new("orders"), &Action::Read).is_allowed());
    }

    #[test]
    fn approval_required_wildcard_action() {
        let mut engine = AuthzEngineBuilder::new()
            .add_role(Role::admin())
            .assign_role("alice", "admin")
            .require_approval(Some("payments".to_owned()), None)
            .build();

        // Any action on payments requires approval
        let d = engine.authorize("alice", &Resource::new("payments"), &Action::Read);
        assert!(d.requires_approval_check());
    }

    // -- Audit logging --

    #[test]
    fn authorize_records_audit() {
        let mut engine = basic_engine();
        engine.authorize("alice", &Resource::new("orders"), &Action::Read);

        assert_eq!(engine.audit_log().len(), 1);
        let records = engine.query_audit(&AuditFilter::new().actor("alice"));
        assert_eq!(records.len(), 1);
        assert!(records[0].decision().is_allowed());
    }

    #[test]
    fn denied_operations_also_audited() {
        let mut engine = basic_engine();
        engine.authorize("bob", &Resource::new("orders"), &Action::Delete);

        let records = engine.query_audit(&AuditFilter::new().actor("bob"));
        assert_eq!(records.len(), 1);
        assert!(records[0].decision().is_denied());
    }

    // -- Role management --

    #[test]
    fn add_role_at_runtime() {
        let mut engine = basic_engine();
        let custom = RoleBuilder::new("custom").default_level(PermissionLevel::Write).build();

        engine.add_role(custom);
        engine.assign_role("charlie", "custom").unwrap();

        assert!(
            engine.authorize("charlie", &Resource::new("orders"), &Action::Create).is_allowed()
        );
    }

    #[test]
    fn assign_invalid_role_returns_error() {
        let mut engine = basic_engine();
        let err = engine.assign_role("charlie", "nonexistent").unwrap_err();
        assert!(err.to_string().contains("nonexistent"));
    }

    #[test]
    fn remove_role_denies_access() {
        let mut engine = basic_engine();
        assert!(engine.authorize("alice", &Resource::new("orders"), &Action::Read).is_allowed());

        engine.remove_role("alice");

        assert!(engine.authorize("alice", &Resource::new("orders"), &Action::Read).is_denied());
    }

    #[test]
    fn actor_role_accessor() {
        let engine = basic_engine();
        assert_eq!(engine.actor_role("alice"), Some("admin"));
        assert_eq!(engine.actor_role("ghost"), None);
    }

    // -- Redaction --

    #[test]
    fn engine_redact_uses_config() {
        let engine = AuthzEngineBuilder::new().build();
        let mut value = serde_json::json!({
            "name": "Test",
            "password": "secret"
        });

        engine.redact(&mut value);
        assert_eq!(value["password"], "[REDACTED]");
        assert_eq!(value["name"], "Test");
    }

    // -- Builder --

    #[test]
    fn builder_default() {
        let builder = AuthzEngineBuilder::default();
        let engine = builder.build();
        assert_eq!(engine.audit_log().max_size(), DEFAULT_AUDIT_MAX_SIZE);
    }

    #[test]
    fn builder_custom_audit_size() {
        let engine = AuthzEngineBuilder::new().audit_max_size(50).build();
        assert_eq!(engine.audit_log().max_size(), 50);
    }

    #[test]
    fn builder_custom_redaction() {
        let config = RedactionConfig::with_fields(["custom_field"]);
        let engine = AuthzEngineBuilder::new().redaction_config(config).build();

        assert!(engine.redaction_config().should_redact("custom_field"));
        assert!(!engine.redaction_config().should_redact("password"));
    }

    #[test]
    fn builder_build_checked_rejects_unknown_role_assignment() {
        let err = AuthzEngineBuilder::new()
            .add_role(Role::admin())
            .assign_role("alice", "missing")
            .build_checked()
            .unwrap_err();

        assert_eq!(err, AuthzError::invalid_role("missing"));
    }

    // -- Full flow integration --

    #[test]
    fn full_flow_assign_authorize_audit() {
        let mut engine = AuthzEngineBuilder::new()
            .add_role(Role::admin())
            .add_role(Role::viewer())
            .assign_role("alice", "admin")
            .assign_role("bob", "viewer")
            .rate_limit_rule(RateLimitRule::new("orders", 10, Duration::from_secs(60)))
            .build();

        // Alice can create orders
        let d = engine.authorize("alice", &Resource::new("orders"), &Action::Create);
        assert!(d.is_allowed());

        // Bob cannot create orders
        let d = engine.authorize("bob", &Resource::new("orders"), &Action::Create);
        assert!(d.is_denied());

        // Both operations were audited
        assert_eq!(engine.audit_log().len(), 2);

        let alice_records = engine.query_audit(&AuditFilter::new().actor("alice"));
        assert_eq!(alice_records.len(), 1);
        assert!(alice_records[0].decision().is_allowed());

        let bob_records = engine.query_audit(&AuditFilter::new().actor("bob"));
        assert_eq!(bob_records.len(), 1);
        assert!(bob_records[0].decision().is_denied());
    }

    #[test]
    fn rate_limiting_integration() {
        let mut engine = AuthzEngineBuilder::new()
            .add_role(Role::admin())
            .assign_role("alice", "admin")
            .rate_limit_rule(RateLimitRule::new("orders", 3, Duration::from_secs(60)))
            .build();

        for _ in 0..3 {
            assert!(
                engine.authorize("alice", &Resource::new("orders"), &Action::Read).is_allowed()
            );
        }

        let d = engine.authorize("alice", &Resource::new("orders"), &Action::Read);
        assert!(d.is_denied());

        // All 4 operations (3 allowed + 1 denied) are audited
        assert_eq!(engine.audit_log().len(), 4);
    }

    #[test]
    fn rate_limiter_accessors() {
        let mut engine = AuthzEngineBuilder::new()
            .rate_limit_rule(RateLimitRule::new("orders", 5, Duration::from_secs(60)))
            .build();

        assert_eq!(engine.rate_limiter().rule_count(), 1);

        // Add another via mutable accessor
        engine.rate_limiter_mut().add_rule(RateLimitRule::new(
            "customers",
            10,
            Duration::from_secs(60),
        ));
        assert_eq!(engine.rate_limiter().rule_count(), 2);
    }

    #[test]
    fn require_approval_at_runtime() {
        let mut engine =
            AuthzEngineBuilder::new().add_role(Role::admin()).assign_role("alice", "admin").build();

        // Initially allowed
        assert!(engine.authorize("alice", &Resource::new("orders"), &Action::Delete).is_allowed());

        // Add approval requirement
        engine.require_approval(Some("orders".to_owned()), Some(Action::Delete));

        // Now requires approval
        let d = engine.authorize("alice", &Resource::new("orders"), &Action::Delete);
        assert!(d.requires_approval_check());
    }
}