Skip to main content

ScopeRegistry

Struct ScopeRegistry 

Source
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:

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

Source

pub fn builder() -> ScopeRegistryBuilder

Start declaring a deployment’s role taxonomy.

Source

pub fn role(&self, name: &RoleName) -> Option<&Role>

Look up a declared role by name.

Source

pub fn is_public(&self, method: &MethodPath) -> bool

True iff the method was declared public via ScopeRegistryBuilder::public_method.

Source

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.

Source

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.

Source

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.

Trait Implementations§

Source§

impl Clone for ScopeRegistry

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ScopeRegistry

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ScopeRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for ScopeRegistry

Source§

impl PartialEq for ScopeRegistry

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ScopeRegistry

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more