Skip to main content

plexus_auth_core/
grants.rs

1//! AUTH-2: **grants, roles, memberships, ceilings — and the gate** that asks
2//! them on every call.
3//!
4//! The model (AUTH-1, owner 2026-10-10: "every method should be its own grant
5//! inherently and require a role to have it explicitly listed if not admin
6//! role"):
7//!
8//! - A [`Grant`] is the right to call one method: `<activation>.<method>`
9//!   (`tickets.set_status`). Inherent — every method has exactly one and
10//!   nothing declares it.
11//! - A role is a named, explicit list of grants ([`GrantSet::Listed`]); the
12//!   built-in [`ADMIN`] role alone holds every grant ([`GrantSet::All`]).
13//!   [`RoleTable`] is an in-memory [`Roles`] in which a role may list
14//!   another role (inclusion), flattened as it is defined.
15//! - A [`Membership`] says a principal holds a role on a scope
16//!   ([`ScopeRef::Named`]) or everywhere ([`ScopeRef::Everywhere`], `*`).
17//! - A *target* is the param that locates the resource a call acts on; the
18//!   service's [`Resolve`] maps its value to the scopes it lives in,
19//!   innermost first (`MENGER-12` → `[MENGER, *]`).
20//! - A [`Ceiling`] is a session's upper bound (IDENTITY-40): `role@SCOPE` or
21//!   `grant@SCOPE` entries. A session may carry several layers; every layer
22//!   must allow a check, as the memberships must.
23//!
24//! [`Gate::check`] answers one call: allowed — with the [`Reach`] the method
25//! answers from — or a [`Refusal`] that names what was needed. Everything is
26//! answered from memory: the three service traits are synchronous and must
27//! not do I/O.
28//!
29//! # Relation to R-5's [`ScopeRegistry`](crate::ScopeRegistry)
30//!
31//! R-5's registry maps *token-claimed roles* to dotted capability scopes and
32//! knows nothing of where a role is held. The grant model keeps its words —
33//! a grant is exactly R-5's implicit `<activation>.<method>` scope, and
34//! [`RoleName`] is the same type — and adds the *where*: memberships on
35//! scopes, targets resolved through a chain, ceilings. Both gates can be
36//! configured on one hub; a hub with neither dispatches as before.
37
38use std::collections::{BTreeMap, BTreeSet};
39use std::fmt;
40use std::sync::Arc;
41
42use serde::{Deserialize, Deserializer, Serialize, Serializer};
43
44use crate::audit::RoleName;
45use crate::auth::AuthContext;
46use crate::identity::Principal;
47
48/// The built-in role that holds every grant. No other role holds anything it
49/// does not list.
50pub const ADMIN: &str = "admin";
51
52/// The metadata key a session's ceiling rides under (IDENTITY-42's
53/// `menger_session` sessions write it): either a list of `role@SCOPE` /
54/// `grant@SCOPE` strings (one layer) or a list of such lists (layers, every
55/// one of which must allow a check).
56pub const CEILING_KEY: &str = "ceiling";
57
58// ---------------------------------------------------------------------------
59// Grant
60// ---------------------------------------------------------------------------
61
62/// The right to call one method: `<activation>.<method>`, e.g.
63/// `tickets.set_status`. Every method has exactly one; nothing declares it.
64#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
65#[serde(transparent)]
66pub struct Grant(String);
67
68impl Grant {
69    /// Wrap a dotted method path as a grant. Unvalidated, as wire-decoded
70    /// values are.
71    pub fn new(path: impl Into<String>) -> Self {
72        Self(path.into())
73    }
74
75    /// The grant of `method` on `activation`: `<activation>.<method>`.
76    pub fn of(activation: &str, method: &str) -> Self {
77        Self(format!("{activation}.{method}"))
78    }
79
80    /// The dotted path.
81    pub fn as_str(&self) -> &str {
82        &self.0
83    }
84}
85
86impl fmt::Display for Grant {
87    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
88        f.write_str(&self.0)
89    }
90}
91
92// ---------------------------------------------------------------------------
93// ScopeRef
94// ---------------------------------------------------------------------------
95
96/// Where a role is held: everywhere (`*`) or one named scope (`MENGER`).
97/// What a name means — a shortcode, a tenant, a project — is the service's;
98/// the gate only compares names and asks [`Resolve::chain`] how they nest.
99///
100/// On the wire, a plain string: `"*"` or the name.
101#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
102pub enum ScopeRef {
103    /// `*`: every scope.
104    Everywhere,
105    /// One named scope, and whatever the service nests under it.
106    Named(String),
107}
108
109impl ScopeRef {
110    /// `"*"` → [`ScopeRef::Everywhere`]; anything else (trimmed) → named.
111    pub fn parse(text: &str) -> Self {
112        match text.trim() {
113            "*" => Self::Everywhere,
114            other => Self::Named(other.to_string()),
115        }
116    }
117
118    /// A named scope.
119    pub fn named(name: impl Into<String>) -> Self {
120        Self::Named(name.into())
121    }
122
123    /// `"*"` or the name.
124    pub fn as_str(&self) -> &str {
125        match self {
126            Self::Everywhere => "*",
127            Self::Named(n) => n,
128        }
129    }
130
131    /// Whether this is `*`.
132    pub fn is_everywhere(&self) -> bool {
133        matches!(self, Self::Everywhere)
134    }
135}
136
137impl fmt::Display for ScopeRef {
138    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
139        f.write_str(self.as_str())
140    }
141}
142
143impl Serialize for ScopeRef {
144    fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
145        s.serialize_str(self.as_str())
146    }
147}
148
149impl<'de> Deserialize<'de> for ScopeRef {
150    fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
151        let s = String::deserialize(d)?;
152        Ok(Self::parse(&s))
153    }
154}
155
156// ---------------------------------------------------------------------------
157// GrantSet, RoleOrGrant, Membership, Ceiling
158// ---------------------------------------------------------------------------
159
160/// What a role holds: every grant ([`ADMIN`]) or exactly those it lists.
161#[derive(Debug, Clone, PartialEq, Eq)]
162pub enum GrantSet {
163    /// Every grant — the admin role, and only it by default.
164    All,
165    /// Exactly these grants.
166    Listed(BTreeSet<Grant>),
167}
168
169impl GrantSet {
170    /// Whether the set holds `grant`.
171    pub fn contains(&self, grant: &Grant) -> bool {
172        match self {
173            Self::All => true,
174            Self::Listed(set) => set.contains(grant),
175        }
176    }
177
178    /// A listed set from anything that names grants.
179    pub fn listed<I, G>(grants: I) -> Self
180    where
181        I: IntoIterator<Item = G>,
182        G: Into<String>,
183    {
184        Self::Listed(grants.into_iter().map(|g| Grant::new(g)).collect())
185    }
186}
187
188/// One ceiling entry's left side: a role (`editor`) or a single grant
189/// (`tickets.get`). A dotted name is a grant; a bare one is a role.
190#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
191pub enum RoleOrGrant {
192    Role(RoleName),
193    Grant(Grant),
194}
195
196impl RoleOrGrant {
197    /// A dotted name is a grant, a bare one a role.
198    pub fn parse(text: &str) -> Self {
199        let t = text.trim();
200        if t.contains('.') {
201            Self::Grant(Grant::new(t))
202        } else {
203            Self::Role(RoleName::new(t))
204        }
205    }
206}
207
208impl fmt::Display for RoleOrGrant {
209    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
210        match self {
211            Self::Role(r) => write!(f, "{r}"),
212            Self::Grant(g) => write!(f, "{g}"),
213        }
214    }
215}
216
217/// A principal holds a role on a scope: `key:ac79… is editor on MENGER`.
218#[derive(Debug, Clone, PartialEq, Eq)]
219pub struct Membership {
220    pub principal: Principal,
221    pub role: RoleName,
222    pub scope: ScopeRef,
223}
224
225/// A session's upper bound (IDENTITY-40): `(role or grant, scope)` entries,
226/// spelled `editor@MENGER-12`, `tickets.get@*`. A check passes a ceiling
227/// when some entry's scope is in the target's chain and the entry allows the
228/// grant (the grant itself, or a role listing it).
229#[derive(Debug, Clone, PartialEq, Eq, Hash, Default)]
230pub struct Ceiling(pub Vec<(RoleOrGrant, ScopeRef)>);
231
232/// Why a ceiling could not be read.
233#[derive(Debug, Clone, PartialEq, Eq)]
234pub struct CeilingError(pub String);
235
236impl fmt::Display for CeilingError {
237    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
238        f.write_str(&self.0)
239    }
240}
241
242impl std::error::Error for CeilingError {}
243
244impl Ceiling {
245    /// One `role@SCOPE` or `grant@SCOPE` entry.
246    pub fn entry(text: &str) -> Result<(RoleOrGrant, ScopeRef), CeilingError> {
247        let (left, scope) = text
248            .trim()
249            .split_once('@')
250            .ok_or_else(|| CeilingError(format!("`{}` is not role@SCOPE or grant@SCOPE", text.trim())))?;
251        if left.trim().is_empty() || scope.trim().is_empty() {
252            return Err(CeilingError(format!("`{}` is not role@SCOPE or grant@SCOPE", text.trim())));
253        }
254        Ok((RoleOrGrant::parse(left), ScopeRef::parse(scope)))
255    }
256
257    /// A ceiling from its entries' text.
258    pub fn parse<I, S>(entries: I) -> Result<Self, CeilingError>
259    where
260        I: IntoIterator<Item = S>,
261        S: AsRef<str>,
262    {
263        entries
264            .into_iter()
265            .map(|e| Self::entry(e.as_ref()))
266            .collect::<Result<Vec<_>, _>>()
267            .map(Ceiling)
268    }
269
270    /// The entries as the wire says them: `role@SCOPE` each.
271    pub fn text(&self) -> Vec<String> {
272        self.0.iter().map(|(rg, s)| format!("{rg}@{s}")).collect()
273    }
274
275    /// The ceilings an identity's metadata carries under [`CEILING_KEY`]:
276    /// none → `[]`; a list of strings → one layer; a list of lists → one
277    /// layer each. Anything else is an error, and a caller whose ceiling
278    /// cannot be read must be refused, never widened.
279    pub fn layers_of(ctx: &AuthContext) -> Result<Vec<Ceiling>, CeilingError> {
280        let Some(v) = ctx.metadata.get(CEILING_KEY) else {
281            return Ok(Vec::new());
282        };
283        let unreadable = || CeilingError("this session's ceiling cannot be read: sign in again".into());
284        let items = v.as_array().ok_or_else(unreadable)?;
285        if items.iter().all(|i| i.is_string()) {
286            let texts: Vec<&str> = items.iter().filter_map(|i| i.as_str()).collect();
287            return Ok(vec![Self::parse(texts).map_err(|_| unreadable())?]);
288        }
289        items
290            .iter()
291            .map(|layer| {
292                let entries = layer.as_array().ok_or_else(unreadable)?;
293                let texts = entries
294                    .iter()
295                    .map(|e| e.as_str().ok_or_else(unreadable))
296                    .collect::<Result<Vec<_>, _>>()?;
297                Self::parse(texts).map_err(|_| unreadable())
298            })
299            .collect()
300    }
301}
302
303/// PERF-15: everything [`Gate::held_on`] reads of one signed-in caller,
304/// besides the grants generation — what its principal holds (each
305/// membership's role and scope, as a set) and its session's ceiling layers.
306/// Two callers with equal fingerprints hold the same grants on the same
307/// scopes, whoever they are: at one generation the gate answers them alike.
308/// So a service keeps what a caller may see (its view, AUTH-4) by it —
309/// one entry shared by every caller holding the same, dropped when the
310/// generation moves. Compared whole, never by a digest: two fingerprints are
311/// one key only when they are equal. [`Gate::fingerprint`] takes one,
312/// [`Gate::held_on_by`] answers from it.
313#[derive(Debug, Clone, PartialEq, Eq, Hash)]
314pub struct Fingerprint {
315    /// (role, scope) of each membership, sorted, each once.
316    held: Vec<(RoleName, ScopeRef)>,
317    /// The session's ceiling, as [`Ceiling::layers_of`] reads it (an
318    /// unreadable one is one empty layer, as the gate reads it).
319    layers: Vec<Ceiling>,
320}
321
322// ---------------------------------------------------------------------------
323// What a service supplies
324// ---------------------------------------------------------------------------
325
326/// Who holds which role where (menger: its members table, cached). Answered
327/// from memory: no I/O on a call.
328pub trait Memberships: Send + Sync {
329    fn held(&self, who: &Principal) -> Vec<Membership>;
330
331    /// What `who` holds of its own — without a membership the service
332    /// gives every signed-in principal (menger's `everyone` grant). It
333    /// decides whether `who` is still waiting for an admin (`auth.waiting`,
334    /// `auth.signup`); the gate reads [`Memberships::held`]. The default is
335    /// `held`: a service with no such grant has nothing to leave out.
336    fn own_held(&self, who: &Principal) -> Vec<Membership> {
337        self.held(who)
338    }
339}
340
341/// Role → grants (defaults declared in code, edits as data). Answered from
342/// memory. [`ADMIN`] holds every grant whatever this answers.
343pub trait Roles: Send + Sync {
344    /// What `role` holds; `None` for a role this service does not know
345    /// (it holds nothing).
346    fn grants(&self, role: &RoleName) -> Option<GrantSet>;
347
348    /// Every role this service knows, so a refusal can name the roles that
349    /// list a grant. The default knows none (a refusal then names only
350    /// [`ADMIN`]).
351    fn names(&self) -> Vec<RoleName> {
352        Vec::new()
353    }
354}
355
356/// Where a target lives. Answered from memory.
357pub trait Resolve: Send + Sync {
358    /// The scopes a target lives in, innermost first, ending in
359    /// [`ScopeRef::Everywhere`]: `"MENGER-12"` → `[MENGER-12, MENGER, *]`
360    /// (or, for a service whose memberships are per shortcode,
361    /// `[MENGER, *]`). `None`: the value locates nothing — the call is
362    /// refused.
363    ///
364    /// The gate also asks it about **scope names** (a membership's or a
365    /// ceiling's): `chain("MENGER")` → `[MENGER, PLEXUS, *]`, to tell which
366    /// of two scopes lies within the other when it narrows a reach by a
367    /// ceiling. A service that cannot answer for a name returns `None`, and
368    /// two different names are then taken as disjoint.
369    fn chain(&self, target: &str) -> Option<Vec<ScopeRef>>;
370}
371
372// ---------------------------------------------------------------------------
373// RoleTable — an in-memory Roles with inclusion
374// ---------------------------------------------------------------------------
375
376/// Why [`RoleTable::define`] refused a role.
377#[derive(Debug, Clone, PartialEq, Eq)]
378pub enum RoleTableError {
379    /// An entry named a role that is not (yet) defined. A role may only
380    /// include roles defined before it, which is what keeps inclusion
381    /// acyclic.
382    UnknownRole { role: String, includes: String },
383}
384
385impl fmt::Display for RoleTableError {
386    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
387        match self {
388            Self::UnknownRole { role, includes } => write!(
389                f,
390                "role {role} includes {includes}, which is not defined before it"
391            ),
392        }
393    }
394}
395
396impl std::error::Error for RoleTableError {}
397
398/// An in-memory [`Roles`]: each role an explicit list of grants, where an
399/// entry may also name an earlier role (inclusion, flattened when defined).
400/// [`ADMIN`] is built in.
401///
402/// ```
403/// use plexus_auth_core::grants::{Grant, RoleTable, Roles};
404/// use plexus_auth_core::RoleName;
405///
406/// let roles = RoleTable::new()
407///     .define("viewer", ["tickets.get", "tickets.list"]).unwrap()
408///     .define("editor", ["viewer", "tickets.set_status"]).unwrap();
409/// let editor = roles.grants(&RoleName::new("editor")).unwrap();
410/// assert!(editor.contains(&Grant::new("tickets.get")));
411/// ```
412#[derive(Debug, Clone, Default)]
413pub struct RoleTable {
414    roles: BTreeMap<RoleName, GrantSet>,
415}
416
417impl RoleTable {
418    /// The table with only the built-in [`ADMIN`].
419    pub fn new() -> Self {
420        Self::default()
421    }
422
423    /// Define (or extend) `role`: each entry a grant (dotted) or an earlier
424    /// role (bare), whose grants are included. Defining a role again adds to
425    /// it, which is how several activations' defaults for one role name
426    /// merge.
427    pub fn define<I, S>(mut self, role: &str, entries: I) -> Result<Self, RoleTableError>
428    where
429        I: IntoIterator<Item = S>,
430        S: AsRef<str>,
431    {
432        let name = RoleName::new(role);
433        let mut set = match self.roles.remove(&name) {
434            Some(GrantSet::Listed(s)) => s,
435            Some(GrantSet::All) => {
436                self.roles.insert(name, GrantSet::All);
437                return Ok(self);
438            }
439            None => BTreeSet::new(),
440        };
441        let mut all = name.as_str() == ADMIN;
442        for entry in entries {
443            let e = entry.as_ref().trim();
444            if e.contains('.') {
445                set.insert(Grant::new(e));
446                continue;
447            }
448            if e == ADMIN {
449                all = true;
450                continue;
451            }
452            match self.roles.get(&RoleName::new(e)) {
453                Some(GrantSet::All) => all = true,
454                Some(GrantSet::Listed(inc)) => set.extend(inc.iter().cloned()),
455                None => {
456                    return Err(RoleTableError::UnknownRole { role: role.to_string(), includes: e.to_string() })
457                }
458            }
459        }
460        self.roles.insert(name, if all { GrantSet::All } else { GrantSet::Listed(set) });
461        Ok(self)
462    }
463
464    /// Replace `role`'s grants outright (an admin's edit: the store wins).
465    pub fn set(&mut self, role: &str, grants: GrantSet) {
466        self.roles.insert(RoleName::new(role), grants);
467    }
468
469    /// A table from already-flat lists (`role → [grant, …]`), as a schema's
470    /// `roles` carries them; lists for one role name merge.
471    pub fn from_lists<'a, I, G>(lists: I) -> Self
472    where
473        I: IntoIterator<Item = (&'a str, G)>,
474        G: IntoIterator,
475        G::Item: AsRef<str>,
476    {
477        let mut table = Self::new();
478        for (role, grants) in lists {
479            let name = RoleName::new(role);
480            let grants: Vec<Grant> = grants.into_iter().map(|g| Grant::new(g.as_ref().trim())).collect();
481            match table.roles.entry(name) {
482                std::collections::btree_map::Entry::Occupied(mut o) => {
483                    if let GrantSet::Listed(s) = o.get_mut() {
484                        s.extend(grants);
485                    }
486                }
487                std::collections::btree_map::Entry::Vacant(v) => {
488                    v.insert(if role == ADMIN { GrantSet::All } else { GrantSet::Listed(grants.into_iter().collect()) });
489                }
490            }
491        }
492        table
493    }
494}
495
496impl Roles for RoleTable {
497    fn grants(&self, role: &RoleName) -> Option<GrantSet> {
498        if role.as_str() == ADMIN {
499            return Some(GrantSet::All);
500        }
501        self.roles.get(role).cloned()
502    }
503
504    fn names(&self) -> Vec<RoleName> {
505        self.roles.keys().cloned().collect()
506    }
507}
508
509// ---------------------------------------------------------------------------
510// Refusal
511// ---------------------------------------------------------------------------
512
513/// Why the gate refused a call.
514#[derive(Debug, Clone, PartialEq, Eq)]
515pub enum Refusal {
516    /// No principal: only `public` methods are reachable anonymously.
517    Unauthenticated,
518    /// The caller does not hold `grant` on `scope` (within its ceiling).
519    MissingGrant {
520        /// The grant the call needed.
521        grant: Grant,
522        /// Where it was needed: the target's innermost scope, or `*` for a
523        /// method without a target (held anywhere would have done).
524        scope: ScopeRef,
525        /// The roles that list the grant ([`ADMIN`] last).
526        roles: Vec<RoleName>,
527        /// Where the caller does hold it (within its ceiling).
528        held_on: Vec<ScopeRef>,
529    },
530    /// AUTH-11: the caller signed in, but that sign-in no longer stands
531    /// (signed out, expired, revoked) — it proves no one.
532    Ended {
533        /// Why, in words for the caller ("you have signed out: sign in
534        /// again").
535        reason: String,
536    },
537}
538
539impl fmt::Display for Refusal {
540    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
541        match self {
542            Self::Unauthenticated => f.write_str("sign in first"),
543            Self::Ended { reason } => f.write_str(reason),
544            Self::MissingGrant { grant, scope, .. } => write!(f, "needs {grant} on {scope}"),
545        }
546    }
547}
548
549impl std::error::Error for Refusal {}
550
551// ---------------------------------------------------------------------------
552// Reach
553// ---------------------------------------------------------------------------
554
555/// Where a call may act: the scopes the caller holds the method's grant on
556/// (within its ceiling), handed to the method beside `auth`. A read without a
557/// target (`list`, `watch`) answers only from these.
558///
559/// A reach is **live** when it came from a gate: [`Reach::allows`] and
560/// [`Reach::current`] ask the gate again, as memberships, roles and the
561/// ceiling stand *now* — so a stream checks each event (IDENTITY-37: a role
562/// revoked reaches an open stream at its next event). A hub without a gate
563/// hands every method [`Reach::everywhere`], which allows everything.
564#[derive(Clone)]
565pub struct Reach {
566    held_on: Vec<ScopeRef>,
567    live: Option<Live>,
568}
569
570#[derive(Clone)]
571struct Live {
572    gate: Gate,
573    caller: Option<AuthContext>,
574    grant: Grant,
575}
576
577impl fmt::Debug for Reach {
578    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
579        f.debug_struct("Reach")
580            .field("held_on", &self.held_on)
581            .field("grant", &self.live.as_ref().map(|l| l.grant.as_str()))
582            .finish()
583    }
584}
585
586impl PartialEq for Reach {
587    /// Two reaches are equal when they hold the same scopes for the same
588    /// grant (the gate behind them is not compared).
589    fn eq(&self, other: &Self) -> bool {
590        self.held_on == other.held_on && self.grant() == other.grant()
591    }
592}
593
594impl Reach {
595    /// Everything — what a method receives on a hub without a gate (login
596    /// off), as today.
597    pub fn everywhere() -> Self {
598        Self { held_on: vec![ScopeRef::Everywhere], live: None }
599    }
600
601    /// Whether the grant is held on `*`.
602    pub fn is_everywhere(&self) -> bool {
603        self.held_on.iter().any(ScopeRef::is_everywhere)
604    }
605
606    /// Whether the grant is held nowhere (a `public` method called by a
607    /// caller who holds no role listing it).
608    pub fn is_empty(&self) -> bool {
609        self.held_on.is_empty()
610    }
611
612    /// The scopes the grant is held on; `[*]` when everywhere.
613    pub fn held_on(&self) -> &[ScopeRef] {
614        &self.held_on
615    }
616
617    /// The grant this reach is for; `None` on a hub without a gate.
618    pub fn grant(&self) -> Option<&Grant> {
619        self.live.as_ref().map(|l| &l.grant)
620    }
621
622    /// POLYGLOT-5: the grants generation of the gate this reach came from
623    /// (BIDIR-8) — a call held open elsewhere (a child service's stream)
624    /// asks [`Reach::current`] again only when it moved. `None` without a
625    /// gate.
626    pub fn generation(&self) -> Option<&GrantsGeneration> {
627        self.live.as_ref().map(|l| l.gate.generation())
628    }
629
630    /// Whether the call may act on `target` — asked of the gate as it
631    /// stands now. Without a gate: always.
632    pub fn allows(&self, target: &str) -> bool {
633        match &self.live {
634            None => self.is_everywhere(),
635            Some(l) => l.gate.check(l.caller.as_ref(), &l.grant, Some(target)).is_ok(),
636        }
637    }
638
639    /// The reach as it stands now: `None` once the grant is held nowhere (a
640    /// stream should end). Without a gate: unchanged.
641    pub fn current(&self) -> Option<Reach> {
642        match &self.live {
643            None => Some(self.clone()),
644            Some(l) => l.gate.check(l.caller.as_ref(), &l.grant, None).ok(),
645        }
646    }
647
648    /// FRAME-5: [`Reach::current`] with the gate's refusal kept — `Err`
649    /// says why the grant is held nowhere now: [`Refusal::Ended`] when the
650    /// sign-in no longer stands (signed out, expired, revoked session),
651    /// [`Refusal::MissingGrant`] when the grants moved away,
652    /// [`Refusal::Unauthenticated`] when the caller proves no one. A held
653    /// open call that must say *why* it ends (a watch's typed reason) asks
654    /// this; one that only needs to know whether asks `current`. Without a
655    /// gate: unchanged.
656    pub fn recheck(&self) -> Result<Reach, Refusal> {
657        match &self.live {
658            None => Ok(self.clone()),
659            Some(l) => l.gate.check(l.caller.as_ref(), &l.grant, None),
660        }
661    }
662
663    /// Whether the reach covers a target whose chain is `chain` (as
664    /// [`Resolve::chain`] gives it), by this snapshot — no new question to
665    /// the gate. Prefer [`Reach::allows`] where the answer must be current.
666    pub fn covers(&self, chain: &[ScopeRef]) -> bool {
667        self.is_everywhere() || self.held_on.iter().any(|s| chain.contains(s))
668    }
669}
670
671// ---------------------------------------------------------------------------
672// Gate
673// ---------------------------------------------------------------------------
674
675/// AUTH-11: whether a signed-in caller's sign-in still stands — the
676/// service's session table, asked by [`Gate::check`] on every call (and so
677/// on every [`Reach::allows`] / [`Reach::current`] a stream makes). A
678/// signed-out or revoked session proves no one, whatever its principal
679/// holds. Memory only, like the other service traits.
680pub trait Liveness: Send + Sync {
681    /// `Err`: why the sign-in no longer stands, in words for the caller.
682    fn alive(&self, caller: &AuthContext) -> Result<(), String>;
683}
684
685struct GateInner {
686    memberships: Arc<dyn Memberships>,
687    roles: Arc<dyn Roles>,
688    resolve: Arc<dyn Resolve>,
689    liveness: Option<Arc<dyn Liveness>>,
690    generation: GrantsGeneration,
691}
692
693/// BIDIR-8: what moved the grants generation ([`Gate::moved`]) — every
694/// write that could change an answer the gate gave.
695#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
696pub enum GrantsMove {
697    /// A membership added.
698    Grant,
699    /// A membership removed.
700    Revoke,
701    /// A role's grants edited.
702    RoleEdit,
703    /// A principal added to a team (it holds the team's grants).
704    TeamAdd,
705    /// A principal removed from a team.
706    TeamRemove,
707    /// A sign-in ended: signed out, or its session revoked.
708    SignOut,
709}
710
711/// BIDIR-8 (BIDIR-5's finding): the **grants generation** — a count every
712/// write that could change one of the gate's answers moves
713/// ([`GrantsMove`]). It is the gate's: whoever holds an answer across time
714/// (a duplex call's caller, a watch) records the generation it was decided
715/// at and asks the gate again only when it has moved — once per move, never
716/// per item. Cheap to clone (two `Arc`s, one count); a read is one atomic
717/// load; a move wakes every [`subscribe`](GrantsGeneration::subscribe)r.
718///
719/// A service shares one across its gates with [`Gate::with_generation`]
720/// (menger: the gate in front of its calls, the access layer's and the store's count are
721/// one).
722#[derive(Clone)]
723pub struct GrantsGeneration {
724    now: Arc<std::sync::atomic::AtomicU64>,
725    tx: Arc<tokio::sync::watch::Sender<u64>>,
726}
727
728impl fmt::Debug for GrantsGeneration {
729    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
730        f.debug_tuple("GrantsGeneration").field(&self.current()).finish()
731    }
732}
733
734impl Default for GrantsGeneration {
735    fn default() -> Self {
736        Self::new()
737    }
738}
739
740impl GrantsGeneration {
741    /// A count at 0.
742    pub fn new() -> Self {
743        Self { now: Arc::new(std::sync::atomic::AtomicU64::new(0)), tx: Arc::new(tokio::sync::watch::channel(0).0) }
744    }
745
746    /// Something that could change an answer moved: +1, and every
747    /// subscriber woken. Answers the generation now.
748    pub fn bump(&self) -> u64 {
749        let n = self.now.fetch_add(1, std::sync::atomic::Ordering::AcqRel) + 1;
750        self.tx.send_replace(n);
751        n
752    }
753
754    /// [`bump`](Self::bump), naming what moved (for the reader; the count
755    /// is one either way).
756    pub fn moved(&self, why: GrantsMove) -> u64 {
757        let _ = why;
758        self.bump()
759    }
760
761    /// The generation now (one atomic load).
762    pub fn current(&self) -> u64 {
763        self.now.load(std::sync::atomic::Ordering::Acquire)
764    }
765
766    /// At least `n` — a service that counted before it shared this handle
767    /// carries its count over. Never back: a smaller `n` changes nothing.
768    pub fn raise_to(&self, n: u64) {
769        let was = self.now.fetch_max(n, std::sync::atomic::Ordering::AcqRel);
770        if n > was {
771            self.tx.send_replace(self.current());
772        }
773    }
774
775    /// What wakes a holder when the generation moves.
776    pub fn subscribe(&self) -> tokio::sync::watch::Receiver<u64> {
777        self.tx.subscribe()
778    }
779}
780
781/// The one rule in front of every call: the method's grant, held through a
782/// role on the target's scope, within the session's ceiling. Default deny.
783/// Cheap to clone (one `Arc`); cheap to ask (memory only), so a stream may
784/// ask per event.
785#[derive(Clone)]
786pub struct Gate {
787    inner: Arc<GateInner>,
788}
789
790impl fmt::Debug for Gate {
791    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
792        f.write_str("Gate")
793    }
794}
795
796impl Gate {
797    /// A gate over a service's memberships, roles and resolver.
798    pub fn new(memberships: Arc<dyn Memberships>, roles: Arc<dyn Roles>, resolve: Arc<dyn Resolve>) -> Self {
799        Self { inner: Arc::new(GateInner { memberships, roles, resolve, liveness: None, generation: GrantsGeneration::new() }) }
800    }
801
802    /// BIDIR-8: this gate, counting its moves in `generation` — the
803    /// service's one ([`GrantsGeneration`]), shared by every gate it builds.
804    /// Without it a gate counts alone, from 0.
805    pub fn with_generation(self, generation: GrantsGeneration) -> Self {
806        let i = &self.inner;
807        Self {
808            inner: Arc::new(GateInner {
809                memberships: i.memberships.clone(),
810                roles: i.roles.clone(),
811                resolve: i.resolve.clone(),
812                liveness: i.liveness.clone(),
813                generation,
814            }),
815        }
816    }
817
818    /// BIDIR-8: the grants generation this gate's answers are decided at.
819    pub fn generation(&self) -> &GrantsGeneration {
820        &self.inner.generation
821    }
822
823    /// BIDIR-8: a write that could change this gate's answers happened
824    /// (the service wrote it — the gate keeps no memberships of its own):
825    /// the generation moves once. Answers the generation now.
826    pub fn moved(&self, why: GrantsMove) -> u64 {
827        self.inner.generation.moved(why)
828    }
829
830    /// AUTH-11: this gate, asking `liveness` whether a caller's sign-in
831    /// still stands before every check. Without it the gate still refuses
832    /// a caller past its `expires_at` stamp ([`AuthContext::expired`]).
833    pub fn with_liveness(self, liveness: Arc<dyn Liveness>) -> Self {
834        let i = &self.inner;
835        Self {
836            inner: Arc::new(GateInner {
837                memberships: i.memberships.clone(),
838                roles: i.roles.clone(),
839                resolve: i.resolve.clone(),
840                liveness: Some(liveness),
841                generation: i.generation.clone(),
842            }),
843        }
844    }
845
846    /// AUTH-11: whether `caller`'s sign-in still stands: not past its
847    /// `expires_at`, and live by the service's [`Liveness`]. An anonymous
848    /// context has no sign-in to end: `Ok`.
849    pub fn alive(&self, caller: &AuthContext) -> Result<(), String> {
850        if caller.principal().is_none() {
851            return Ok(());
852        }
853        if caller.expired() {
854            return Err("your sign-in has expired: sign in again".into());
855        }
856        match &self.inner.liveness {
857            Some(l) => l.alive(caller),
858            None => Ok(()),
859        }
860    }
861
862    /// Whether `role` lists `grant` ([`ADMIN`] lists every grant).
863    pub fn lists(&self, role: &RoleName, grant: &Grant) -> bool {
864        role.as_str() == ADMIN || self.inner.roles.grants(role).is_some_and(|g| g.contains(grant))
865    }
866
867    /// The roles that list `grant`, [`ADMIN`] last.
868    pub fn roles_listing(&self, grant: &Grant) -> Vec<RoleName> {
869        let mut out: Vec<RoleName> = self
870            .inner
871            .roles
872            .names()
873            .into_iter()
874            .filter(|r| r.as_str() != ADMIN && self.lists(r, grant))
875            .collect();
876        out.push(RoleName::new(ADMIN));
877        out
878    }
879
880    /// Whether a ceiling entry allows `grant`.
881    fn entry_allows(&self, entry: &RoleOrGrant, grant: &Grant) -> bool {
882        match entry {
883            RoleOrGrant::Grant(g) => g == grant,
884            RoleOrGrant::Role(r) => self.lists(r, grant),
885        }
886    }
887
888    /// The caller's principal and ceiling layers; `None` when anonymous. An
889    /// unreadable ceiling becomes one empty layer — it allows nothing.
890    fn caller_of(caller: Option<&AuthContext>) -> Option<(Principal, Vec<Ceiling>)> {
891        let ctx = caller?;
892        let principal = ctx.principal()?;
893        let layers = Ceiling::layers_of(ctx).unwrap_or_else(|_| vec![Ceiling::default()]);
894        Some((principal, layers))
895    }
896
897    /// Whether `inner` lies within `outer` (or is it).
898    fn within(&self, inner: &ScopeRef, outer: &ScopeRef) -> bool {
899        if outer.is_everywhere() || inner == outer {
900            return true;
901        }
902        match inner {
903            ScopeRef::Everywhere => false,
904            ScopeRef::Named(name) => self.inner.resolve.chain(name).is_some_and(|c| c.contains(outer)),
905        }
906    }
907
908    /// The scopes both `a` and `b` reach: where one lies within the other,
909    /// the inner one.
910    fn meet(&self, a: Vec<ScopeRef>, b: Vec<ScopeRef>) -> Vec<ScopeRef> {
911        if a.iter().any(ScopeRef::is_everywhere) {
912            return b;
913        }
914        if b.iter().any(ScopeRef::is_everywhere) {
915            return a;
916        }
917        let mut out = BTreeSet::new();
918        for x in &a {
919            for y in &b {
920                if self.within(x, y) {
921                    out.insert(x.clone());
922                } else if self.within(y, x) {
923                    out.insert(y.clone());
924                }
925            }
926        }
927        out.into_iter().collect()
928    }
929
930    /// Collapse to `[*]` when `*` is among them; dedupe, ordered.
931    fn normal(scopes: impl IntoIterator<Item = ScopeRef>) -> Vec<ScopeRef> {
932        let set: BTreeSet<ScopeRef> = scopes.into_iter().collect();
933        if set.contains(&ScopeRef::Everywhere) {
934            vec![ScopeRef::Everywhere]
935        } else {
936            set.into_iter().collect()
937        }
938    }
939
940    fn held_on_for(&self, principal: &Principal, layers: &[Ceiling], grant: &Grant) -> Vec<ScopeRef> {
941        let held = self.inner.memberships.held(principal);
942        self.held_on_in(held.iter().map(|m| (&m.role, &m.scope)), layers, grant)
943    }
944
945    /// Where `held` (role, scope pairs) holds `grant` within `layers`: what
946    /// [`Gate::held_on`] answers from the memberships and
947    /// [`Gate::held_on_by`] from a [`Fingerprint`] — one rule.
948    fn held_on_in<'a>(
949        &self,
950        held: impl Iterator<Item = (&'a RoleName, &'a ScopeRef)>,
951        layers: &[Ceiling],
952        grant: &Grant,
953    ) -> Vec<ScopeRef> {
954        let mut acc = Self::normal(held.filter(|(role, _)| self.lists(role, grant)).map(|(_, scope)| scope.clone()));
955        for layer in layers {
956            if acc.is_empty() {
957                break;
958            }
959            let allowed = Self::normal(
960                layer.0.iter().filter(|(rg, _)| self.entry_allows(rg, grant)).map(|(_, s)| s.clone()),
961            );
962            acc = self.meet(acc, allowed);
963        }
964        acc
965    }
966
967    /// Where the caller holds `grant`, within its ceiling: `[*]` when
968    /// everywhere, `[]` when nowhere (and for an anonymous caller). What a
969    /// method without a target answers from.
970    pub fn held_on(&self, caller: &AuthContext, grant: &Grant) -> Vec<ScopeRef> {
971        match Self::caller_of(Some(caller)) {
972            Some((p, layers)) => self.held_on_for(&p, &layers, grant),
973            None => Vec::new(),
974        }
975    }
976
977    /// PERF-15: what this gate's answers about `caller` read, besides the
978    /// grants generation — its principal's memberships and its session's
979    /// ceiling ([`Fingerprint`]); `None` when it is anonymous. The
980    /// memberships are read now, from memory.
981    pub fn fingerprint(&self, caller: &AuthContext) -> Option<Fingerprint> {
982        let (principal, layers) = Self::caller_of(Some(caller))?;
983        let mut held: Vec<(RoleName, ScopeRef)> =
984            self.inner.memberships.held(&principal).into_iter().map(|m| (m.role, m.scope)).collect();
985        held.sort();
986        held.dedup();
987        Some(Fingerprint { held, layers })
988    }
989
990    /// PERF-15: [`Gate::held_on`] for whoever has `who` — read from the
991    /// fingerprint instead of the memberships, by the same rule, so a view
992    /// built from it is exactly the one built from any caller it was taken
993    /// of.
994    pub fn held_on_by(&self, who: &Fingerprint, grant: &Grant) -> Vec<ScopeRef> {
995        self.held_on_in(who.held.iter().map(|(r, s)| (r, s)), &who.layers, grant)
996    }
997
998    /// Allowed when the grant is listed by a role held on a scope in the
999    /// target's chain — or anywhere, for a call with no target — and every
1000    /// ceiling layer allows it the same way. The [`Reach`] is live (it asks
1001    /// this gate again on [`Reach::allows`] / [`Reach::current`]).
1002    ///
1003    /// AUTH-11: first, the caller's sign-in must still stand
1004    /// ([`Gate::alive`]) — a signed-out session holds nothing, so a socket
1005    /// that signed out cannot go on to call `auth.grant`.
1006    pub fn check(&self, caller: Option<&AuthContext>, grant: &Grant, target: Option<&str>) -> Result<Reach, Refusal> {
1007        let Some((principal, layers)) = Self::caller_of(caller) else {
1008            return Err(Refusal::Unauthenticated);
1009        };
1010        if let Some(ctx) = caller {
1011            self.alive(ctx).map_err(|reason| Refusal::Ended { reason })?;
1012        }
1013        let held_on = self.held_on_for(&principal, &layers, grant);
1014        let (allowed, scope) = match target {
1015            None => (!held_on.is_empty(), ScopeRef::Everywhere),
1016            Some(t) => match self.inner.resolve.chain(t) {
1017                None => (false, ScopeRef::named(t)),
1018                Some(chain) => {
1019                    let in_chain = |s: &ScopeRef| s.is_everywhere() || chain.contains(s);
1020                    let by_membership = self
1021                        .inner
1022                        .memberships
1023                        .held(&principal)
1024                        .iter()
1025                        .any(|m| in_chain(&m.scope) && self.lists(&m.role, grant));
1026                    let by_ceiling = layers
1027                        .iter()
1028                        .all(|layer| layer.0.iter().any(|(rg, s)| in_chain(s) && self.entry_allows(rg, grant)));
1029                    let scope = chain.first().cloned().unwrap_or_else(|| ScopeRef::named(t));
1030                    (by_membership && by_ceiling, scope)
1031                }
1032            },
1033        };
1034        if allowed {
1035            Ok(Reach {
1036                held_on,
1037                live: Some(Live { gate: self.clone(), caller: caller.cloned(), grant: grant.clone() }),
1038            })
1039        } else {
1040            Err(Refusal::MissingGrant { grant: grant.clone(), scope, roles: self.roles_listing(grant), held_on })
1041        }
1042    }
1043
1044    /// The reach of a `public` method: what [`Gate::check`] would allow
1045    /// without a target, or an empty (still live) reach when the caller holds
1046    /// the grant nowhere or is anonymous. A public method is never refused.
1047    pub fn reach_of_public(&self, caller: Option<&AuthContext>, grant: &Grant) -> Reach {
1048        self.check(caller, grant, None).unwrap_or_else(|_| Reach {
1049            held_on: Vec::new(),
1050            live: Some(Live { gate: self.clone(), caller: caller.cloned(), grant: grant.clone() }),
1051        })
1052    }
1053}
1054
1055// ---------------------------------------------------------------------------
1056// Tests — the gate's decision table
1057// ---------------------------------------------------------------------------
1058
1059#[cfg(test)]
1060mod tests {
1061    use super::*;
1062    use std::sync::Mutex;
1063
1064    const ADA: &str = "key:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
1065    const BOB: &str = "key:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb";
1066
1067    /// Memberships as a mutable table, so a test can revoke one.
1068    #[derive(Default)]
1069    struct Members(Mutex<Vec<Membership>>);
1070    impl Members {
1071        fn grant(&self, who: &str, role: &str, scope: &str) {
1072            self.0.lock().unwrap().push(Membership {
1073                principal: who.parse().unwrap(),
1074                role: RoleName::new(role),
1075                scope: ScopeRef::parse(scope),
1076            });
1077        }
1078        fn revoke_all(&self) {
1079            self.0.lock().unwrap().clear();
1080        }
1081    }
1082    impl Memberships for Members {
1083        fn held(&self, who: &Principal) -> Vec<Membership> {
1084            self.0.lock().unwrap().iter().filter(|m| &m.principal == who).cloned().collect()
1085        }
1086    }
1087
1088    /// menger-shaped: a ticket `CODE-n` lives in itself, then `CODE`;
1089    /// MENGER and IDENTITY are disjoint, both hosted under PLEXUS.
1090    struct Shortcodes;
1091    impl Resolve for Shortcodes {
1092        fn chain(&self, target: &str) -> Option<Vec<ScopeRef>> {
1093            let code = target.split_once('-').map(|(c, _)| c).unwrap_or(target);
1094            let mut chain = Vec::new();
1095            if target.contains('-') {
1096                chain.push(ScopeRef::named(target));
1097            }
1098            match code {
1099                "MENGER" | "IDENTITY" => {
1100                    chain.push(ScopeRef::named(code));
1101                    chain.push(ScopeRef::named("PLEXUS"));
1102                }
1103                "PLEXUS" => chain.push(ScopeRef::named("PLEXUS")),
1104                _ => return None,
1105            }
1106            chain.push(ScopeRef::Everywhere);
1107            Some(chain)
1108        }
1109    }
1110
1111    fn roles() -> RoleTable {
1112        RoleTable::new()
1113            .define("viewer", ["tickets.get", "tickets.list"])
1114            .unwrap()
1115            .define("editor", ["viewer", "tickets.set_status"])
1116            .unwrap()
1117    }
1118
1119    fn gate(members: &Arc<Members>) -> Gate {
1120        Gate::new(members.clone(), Arc::new(roles()), Arc::new(Shortcodes))
1121    }
1122
1123    fn who(p: &str) -> AuthContext {
1124        AuthContext::for_principal(&p.parse().unwrap(), "s1", vec![], serde_json::Value::Null)
1125    }
1126
1127    fn with_ceiling(p: &str, ceiling: serde_json::Value) -> AuthContext {
1128        AuthContext::for_principal(&p.parse().unwrap(), "s1", vec![], serde_json::json!({ CEILING_KEY: ceiling }))
1129    }
1130
1131    fn g(s: &str) -> Grant {
1132        Grant::new(s)
1133    }
1134
1135    #[test]
1136    fn a_grant_no_role_lists_is_refused_to_all_but_admin() {
1137        let m = Arc::new(Members::default());
1138        m.grant(ADA, "editor", "*");
1139        m.grant(BOB, "admin", "MENGER");
1140        let gate = gate(&m);
1141        let err = gate.check(Some(&who(ADA)), &g("members.grant"), Some("MENGER-1")).unwrap_err();
1142        assert_eq!(
1143            err,
1144            Refusal::MissingGrant {
1145                grant: g("members.grant"),
1146                scope: ScopeRef::named("MENGER-1"),
1147                roles: vec![RoleName::new("admin")],
1148                held_on: vec![],
1149            }
1150        );
1151        assert!(gate.check(Some(&who(BOB)), &g("members.grant"), Some("MENGER-1")).is_ok());
1152        // admin on MENGER is not admin on IDENTITY.
1153        assert!(gate.check(Some(&who(BOB)), &g("members.grant"), Some("IDENTITY-1")).is_err());
1154    }
1155
1156    #[test]
1157    fn held_on_a_scope_allows_targets_in_its_chain_only() {
1158        let m = Arc::new(Members::default());
1159        m.grant(ADA, "editor", "MENGER");
1160        let gate = gate(&m);
1161        let reach = gate.check(Some(&who(ADA)), &g("tickets.set_status"), Some("MENGER-12")).unwrap();
1162        assert_eq!(reach.held_on(), &[ScopeRef::named("MENGER")]);
1163        let err = gate.check(Some(&who(ADA)), &g("tickets.set_status"), Some("IDENTITY-1")).unwrap_err();
1164        assert_eq!(
1165            err,
1166            Refusal::MissingGrant {
1167                grant: g("tickets.set_status"),
1168                scope: ScopeRef::named("IDENTITY-1"),
1169                roles: vec![RoleName::new("editor"), RoleName::new("admin")],
1170                held_on: vec![ScopeRef::named("MENGER")],
1171            }
1172        );
1173        assert_eq!(err.to_string(), "needs tickets.set_status on IDENTITY-1");
1174        // A target nothing resolves is refused.
1175        assert!(gate.check(Some(&who(ADA)), &g("tickets.get"), Some("NOPE-1")).is_err());
1176    }
1177
1178    #[test]
1179    fn held_on_everywhere_allows_any_target_and_reach_is_everywhere() {
1180        let m = Arc::new(Members::default());
1181        m.grant(ADA, "viewer", "*");
1182        m.grant(ADA, "viewer", "MENGER");
1183        let gate = gate(&m);
1184        let reach = gate.check(Some(&who(ADA)), &g("tickets.get"), Some("IDENTITY-3")).unwrap();
1185        assert!(reach.is_everywhere());
1186        assert_eq!(reach.held_on(), &[ScopeRef::Everywhere]);
1187        assert!(gate.check(Some(&who(ADA)), &g("tickets.list"), None).unwrap().is_everywhere());
1188        // viewer does not list set_status, wherever it is held.
1189        assert!(gate.check(Some(&who(ADA)), &g("tickets.set_status"), Some("IDENTITY-3")).is_err());
1190    }
1191
1192    #[test]
1193    fn without_a_target_held_anywhere_suffices_and_reach_says_where() {
1194        let m = Arc::new(Members::default());
1195        m.grant(ADA, "viewer", "MENGER");
1196        m.grant(ADA, "viewer", "IDENTITY");
1197        let gate = gate(&m);
1198        let reach = gate.check(Some(&who(ADA)), &g("tickets.list"), None).unwrap();
1199        assert_eq!(reach.held_on(), &[ScopeRef::named("IDENTITY"), ScopeRef::named("MENGER")]);
1200        assert!(reach.allows("MENGER-4"));
1201        assert!(!reach.allows("PLEXUS-1"));
1202        let err = gate.check(Some(&who(BOB)), &g("tickets.list"), None).unwrap_err();
1203        assert!(matches!(err, Refusal::MissingGrant { ref scope, .. } if scope.is_everywhere()));
1204    }
1205
1206    #[test]
1207    fn a_ceiling_narrows_the_membership() {
1208        let m = Arc::new(Members::default());
1209        m.grant(ADA, "editor", "MENGER");
1210        let gate = gate(&m);
1211        let narrowed = with_ceiling(ADA, serde_json::json!(["editor@MENGER-12"]));
1212        assert!(gate.check(Some(&narrowed), &g("tickets.set_status"), Some("MENGER-12")).is_ok());
1213        assert!(gate.check(Some(&narrowed), &g("tickets.set_status"), Some("MENGER-13")).is_err());
1214        // The reach of a target-less read is the meet: MENGER-12, inside MENGER.
1215        let reach = gate.check(Some(&narrowed), &g("tickets.list"), None).unwrap();
1216        assert_eq!(reach.held_on(), &[ScopeRef::named("MENGER-12")]);
1217        // A grant-entry ceiling: only tickets.get, anywhere the membership allows.
1218        let only_get = with_ceiling(ADA, serde_json::json!([["tickets.get@*"]]));
1219        assert!(gate.check(Some(&only_get), &g("tickets.get"), Some("MENGER-1")).is_ok());
1220        let err = gate.check(Some(&only_get), &g("tickets.set_status"), Some("MENGER-1")).unwrap_err();
1221        assert!(matches!(err, Refusal::MissingGrant { ref held_on, .. } if held_on.is_empty()));
1222        // Two layers: both must allow.
1223        let layered = with_ceiling(ADA, serde_json::json!([["editor@*"], ["viewer@MENGER"]]));
1224        assert!(gate.check(Some(&layered), &g("tickets.get"), Some("MENGER-1")).is_ok());
1225        assert!(gate.check(Some(&layered), &g("tickets.set_status"), Some("MENGER-1")).is_err());
1226        // A ceiling never widens: editor@IDENTITY grants nothing there.
1227        let wider = with_ceiling(ADA, serde_json::json!(["editor@IDENTITY"]));
1228        assert!(gate.check(Some(&wider), &g("tickets.get"), Some("IDENTITY-1")).is_err());
1229        // An unreadable ceiling allows nothing.
1230        let bad = with_ceiling(ADA, serde_json::json!("editor@*"));
1231        assert!(gate.check(Some(&bad), &g("tickets.get"), Some("MENGER-1")).is_err());
1232    }
1233
1234    #[test]
1235    fn role_inclusion_flattens_and_must_name_an_earlier_role() {
1236        let r = roles();
1237        let editor = r.grants(&RoleName::new("editor")).unwrap();
1238        assert!(editor.contains(&g("tickets.get")) && editor.contains(&g("tickets.set_status")));
1239        let viewer = r.grants(&RoleName::new("viewer")).unwrap();
1240        assert!(!viewer.contains(&g("tickets.set_status")));
1241        assert_eq!(
1242            RoleTable::new().define("editor", ["viewer"]).unwrap_err(),
1243            RoleTableError::UnknownRole { role: "editor".into(), includes: "viewer".into() }
1244        );
1245        // admin is built in: holds every grant, whatever the table says.
1246        assert_eq!(r.grants(&RoleName::new("admin")), Some(GrantSet::All));
1247        // from_lists merges one role's lists from several activations.
1248        let merged = RoleTable::from_lists([("editor", vec!["tickets.get"]), ("editor", vec!["comments.add"])]);
1249        let e = merged.grants(&RoleName::new("editor")).unwrap();
1250        assert!(e.contains(&g("tickets.get")) && e.contains(&g("comments.add")));
1251    }
1252
1253    #[test]
1254    fn anonymous_is_unauthenticated() {
1255        let m = Arc::new(Members::default());
1256        let gate = gate(&m);
1257        assert_eq!(gate.check(None, &g("tickets.get"), Some("MENGER-1")).unwrap_err(), Refusal::Unauthenticated);
1258        assert_eq!(
1259            gate.check(Some(&AuthContext::anonymous()), &g("tickets.list"), None).unwrap_err(),
1260            Refusal::Unauthenticated
1261        );
1262        // A public method's reach for an anonymous caller: empty, never refused.
1263        assert!(gate.reach_of_public(None, &g("auth.login")).is_empty());
1264    }
1265
1266    #[test]
1267    fn a_live_reach_follows_grants_as_they_stand() {
1268        let m = Arc::new(Members::default());
1269        m.grant(ADA, "viewer", "MENGER");
1270        let gate = gate(&m);
1271        let reach = gate.check(Some(&who(ADA)), &g("tickets.list"), None).unwrap();
1272        assert!(reach.allows("MENGER-1"));
1273        assert!(reach.current().is_some());
1274        m.revoke_all();
1275        assert!(!reach.allows("MENGER-1"));
1276        assert!(reach.current().is_none());
1277        // Without a gate, everything.
1278        assert!(Reach::everywhere().allows("ANY-1") && Reach::everywhere().current().is_some());
1279    }
1280
1281    #[test]
1282    fn scope_refs_and_ceilings_round_trip() {
1283        assert_eq!(serde_json::to_string(&ScopeRef::Everywhere).unwrap(), "\"*\"");
1284        assert_eq!(serde_json::from_str::<ScopeRef>("\"MENGER\"").unwrap(), ScopeRef::named("MENGER"));
1285        let c = Ceiling::parse(["editor@MENGER-12", "tickets.get@*"]).unwrap();
1286        assert_eq!(c.0[0], (RoleOrGrant::Role(RoleName::new("editor")), ScopeRef::named("MENGER-12")));
1287        assert_eq!(c.0[1], (RoleOrGrant::Grant(g("tickets.get")), ScopeRef::Everywhere));
1288        assert_eq!(c.text(), vec!["editor@MENGER-12", "tickets.get@*"]);
1289        assert!(Ceiling::parse(["editor"]).is_err());
1290    }
1291
1292    /// A session table with one switch: signed out or not.
1293    #[derive(Default)]
1294    struct Switch(std::sync::atomic::AtomicBool);
1295    impl Liveness for Switch {
1296        fn alive(&self, _: &AuthContext) -> Result<(), String> {
1297            if self.0.load(std::sync::atomic::Ordering::SeqCst) {
1298                Err("you have signed out: sign in again".into())
1299            } else {
1300                Ok(())
1301            }
1302        }
1303    }
1304
1305    /// AUTH-11: a signed-out session holds nothing — not even admin on `*`
1306    /// — and a live reach taken before the sign-out ends with it.
1307    #[test]
1308    fn a_session_that_ended_holds_nothing() {
1309        let m = Arc::new(Members::default());
1310        m.grant(ADA, "admin", "*");
1311        let out = Arc::new(Switch::default());
1312        let gate = gate(&m).with_liveness(out.clone());
1313        let reach = gate.check(Some(&who(ADA)), &g("auth.grant"), None).expect("admin before sign-out");
1314        assert!(reach.allows("MENGER-1"));
1315        out.0.store(true, std::sync::atomic::Ordering::SeqCst);
1316        let ended = Refusal::Ended { reason: "you have signed out: sign in again".into() };
1317        assert_eq!(gate.check(Some(&who(ADA)), &g("auth.grant"), None).unwrap_err(), ended);
1318        assert_eq!(gate.check(Some(&who(ADA)), &g("tickets.get"), Some("MENGER-1")).unwrap_err(), ended);
1319        assert!(!reach.allows("MENGER-1"), "a stream's next event sees it");
1320        assert!(reach.current().is_none());
1321        assert!(gate.reach_of_public(Some(&who(ADA)), &g("auth.grant")).is_empty());
1322        // Anonymous is not "ended": still plain Unauthenticated.
1323        assert_eq!(gate.check(None, &g("auth.grant"), None).unwrap_err(), Refusal::Unauthenticated);
1324    }
1325
1326    /// AUTH-11: past its `expires_at` stamp, a sign-in is over even with
1327    /// no liveness hook.
1328    #[test]
1329    fn an_expired_sign_in_holds_nothing() {
1330        let m = Arc::new(Members::default());
1331        m.grant(ADA, "admin", "*");
1332        let gate = gate(&m);
1333        let past = AuthContext::for_principal(&ADA.parse().unwrap(), "s1", vec![], serde_json::json!({ "expires_at": 1 }));
1334        assert!(matches!(gate.check(Some(&past), &g("auth.grant"), None), Err(Refusal::Ended { .. })));
1335        let future = AuthContext::for_principal(&ADA.parse().unwrap(), "s1", vec![], serde_json::json!({ "expires_at": i64::MAX }));
1336        assert!(gate.check(Some(&future), &g("auth.grant"), None).is_ok());
1337    }
1338
1339    /// PERF-15: a fingerprint is what the gate's answers read of a caller —
1340    /// equal for two principals holding the same, different when a
1341    /// membership or the ceiling differs, `None` when anonymous — and
1342    /// `held_on_by` answers from it exactly what `held_on` answers.
1343    #[test]
1344    fn a_fingerprint_is_what_the_answers_read() {
1345        let m = Arc::new(Members::default());
1346        m.grant(ADA, "viewer", "IDENTITY");
1347        m.grant(ADA, "editor", "MENGER");
1348        m.grant(BOB, "editor", "MENGER");
1349        m.grant(BOB, "viewer", "IDENTITY");
1350        m.grant(BOB, "editor", "MENGER");
1351        let gate = gate(&m);
1352        let (ada, bob) = (gate.fingerprint(&who(ADA)).unwrap(), gate.fingerprint(&who(BOB)).unwrap());
1353        assert_eq!(ada, bob, "the same holdings, in another order and once more: one fingerprint");
1354        assert_eq!(gate.fingerprint(&AuthContext::anonymous()), None);
1355        let narrow = with_ceiling(ADA, serde_json::json!(["editor@MENGER-12"]));
1356        let narrowed = gate.fingerprint(&narrow).unwrap();
1357        assert_ne!(narrowed, ada, "a ceiling: another fingerprint");
1358        let unreadable = gate.fingerprint(&with_ceiling(ADA, serde_json::json!("editor@*"))).unwrap();
1359        assert_ne!(unreadable, ada, "an unreadable ceiling allows nothing: not the unbounded caller's");
1360        for (ctx, fp) in [(&who(ADA), &ada), (&narrow, &narrowed), (&with_ceiling(ADA, serde_json::json!("editor@*")), &unreadable)] {
1361            for grant in ["tickets.get", "tickets.set_status", "tickets.delete", "members.grant"] {
1362                assert_eq!(gate.held_on_by(fp, &g(grant)), gate.held_on(ctx, &g(grant)), "{grant}");
1363            }
1364        }
1365        assert_eq!(gate.held_on_by(&narrowed, &g("tickets.get")), vec![ScopeRef::named("MENGER-12")]);
1366        m.revoke_all();
1367        assert_ne!(gate.fingerprint(&who(ADA)).unwrap(), ada, "a revoke: another fingerprint");
1368    }
1369}