pub struct ScopeRegistry { /* private fields */ }Expand description
Hub-level roles→scopes source of truth. Built once at hub construction
via ScopeRegistry::builder, immutable thereafter.
Holds the role table, the set of public methods, and a per-method
explicit-scope overlay (used when the macro emits explicit scope = ...
literals; otherwise ScopeRegistry::required_scopes_for resolves the
implicit <activation>.<method> requirement at lookup time).
The lookups dispatch (AUTHZ-CORE-1/5, R-5) and schema projection (AUTHZ-PRIVACY-3) consume:
- “what scopes are required for this method?” —
ScopeRegistry::required_scopes_for - “is this method public?” —
ScopeRegistry::is_public - “expand this role to its transitive scope set” —
ScopeRegistry::expand_role/ScopeRegistry::effective_scopes
Default is the empty registry: no roles, no public methods, no
overlays. A hub without a registry is treated as this empty registry —
with default-deny OFF that is the harmless no-op; with default-deny ON
every gated method denies.
Implementations§
Source§impl ScopeRegistry
impl ScopeRegistry
Sourcepub fn builder() -> ScopeRegistryBuilder
pub fn builder() -> ScopeRegistryBuilder
Start declaring a deployment’s role taxonomy.
Sourcepub fn is_public(&self, method: &MethodPath) -> bool
pub fn is_public(&self, method: &MethodPath) -> bool
True iff the method was declared public via
ScopeRegistryBuilder::public_method.
Sourcepub fn required_scopes_for(&self, method: &MethodPath) -> Vec<Scope>
pub fn required_scopes_for(&self, method: &MethodPath) -> Vec<Scope>
The scopes required to invoke method.
Returns the explicit overlay if ScopeRegistryBuilder::method_scopes
declared one; otherwise the implicit requirement derived from the
method path itself.
Implicit-scope note: AUTHZ-CORE-4 phrases the implicit rule as
<activation>.<method>; for the canonical two-segment paths the full
dotted path IS <activation>.<method>. For deeper paths
(e.g. solar.earth.luna.info) this implementation uses the full
dotted path as the implicit scope rather than
first-segment + last-segment, because collapsing the middle segments
would alias distinct methods (solar.earth.luna.info and
solar.mars.info would both require solar.info — granting one
would grant the other, an authorization hazard). Wildcard role grants
(solar.*) still cover the whole subtree.
Sourcepub fn expand_role(&self, role: &RoleName) -> BTreeSet<Scope>
pub fn expand_role(&self, role: &RoleName) -> BTreeSet<Scope>
The transitive union of scopes granted by role: its own scopes,
plus its inherits roles’ scopes, plus theirs, deduplicated.
A role unknown to this registry expands to the empty set — token claims are external input, and a role the deployment never declared grants nothing (default-deny posture).
Defense in depth: the walk carries a visited set, so it terminates
even on a cyclic role graph. Cycles cannot arise through
ScopeRegistryBuilder::build (which rejects them); the visited set
is the layered second defense AUTHZ-CORE-6 risk 3 calls for.
Sourcepub fn effective_scopes(&self, roles: &[RoleName]) -> BTreeSet<Scope>
pub fn effective_scopes(&self, roles: &[RoleName]) -> BTreeSet<Scope>
The union of ScopeRegistry::expand_role over each held role —
the holder’s full effective scope set.
Wildcard scopes (*, <prefix>.*) are preserved as held scopes in
the result; the wildcard math happens at the use-site via
Scope::matches.