Skip to main content

plexus_core/plexus/
auth_activation.rs

1//! AUTH-5 — **the `auth` activation**: one auth surface in every gated
2//! Plexus hub. Sign in, sign up, who am I, what does this need, and the
3//! admin's roles and memberships.
4//!
5//! A service turns login on with [`DynamicHub::with_auth`], handing it an
6//! [`AuthSetup`]: what only the service knows —
7//!
8//! - an [`AuthBackend`]: its providers, its login flows (the browser start
9//!   and finish, a password, a session minted on a key-proved or signed-in
10//!   connection), signup and the waiting list, logout;
11//! - an editable [`RoleStore`] (role → grants: defaults from the
12//!   activations' `roles(...)`, an admin's edits win) and
13//!   [`MembershipStore`] (who holds which role where);
14//! - its scope [`Resolve`]r.
15//!
16//! The hub builds the [`Gate`] from those same stores (so an edit reaches
17//! the next call and the next view), mounts this activation, and the rest
18//! the activation answers itself from the gate and the stores:
19//!
20//! | method | who | answers |
21//! |---|---|---|
22//! | `providers`, `login`, `signup` | anyone (`public`) | the door |
23//! | `whoami`, `logout`, `requires` | any signed-in caller (whatever its roles or ceiling) | `whoami`, `logged_out`, `requires` |
24//! | `roles` | whoever holds `auth.roles` (admin) | one `role` per role |
25//! | `role_set` | admin on `*` | the role as it now stands |
26//! | `grant`, `revoke` | whoever holds them on the scope (`target = "scope"`) | `granted` / `revoked` |
27//! | `waiting` | admin on `*` | one `waiting` per principal asking |
28//!
29//! A refusal the gate makes is AUTH-2's typed error item; one this
30//! activation makes (`role_set`, `waiting` short of `*`) is an in-band
31//! `{type: "error", error_kind: "forbidden", grant, scope, roles,
32//! held_on, message}` event — the same fields.
33//!
34//! [`super::auth_memory`] has a reference in-memory implementation of every
35//! trait here, for tests and as a starting point.
36//!
37//! [`DynamicHub::with_auth`]: super::DynamicHub::with_auth
38
39use std::collections::{BTreeMap, BTreeSet};
40use std::fmt;
41use std::sync::{Arc, RwLock};
42
43use async_stream::stream;
44use async_trait::async_trait;
45use futures::Stream;
46use schemars::JsonSchema;
47use serde::{Deserialize, Serialize};
48
49use plexus_auth_core::grants::{
50    Ceiling, Gate, Grant, GrantSet, GrantsGeneration, GrantsMove, Liveness, Membership, Memberships, Reach, Resolve, Roles, ScopeRef, ADMIN,
51};
52use plexus_auth_core::identity::Principal;
53use plexus_auth_core::RoleName;
54
55use super::auth::AuthContext;
56use super::auth_params as param;
57use super::schema::{MethodRole, PluginSchema};
58
59/// The grants every signed-in caller reaches, whatever its roles or its
60/// session's ceiling: asking who it is, signing out, and asking what a
61/// method needs. Never anonymously.
62pub const SIGNED_IN_GRANTS: [&str; 3] = ["auth.whoami", "auth.logout", "auth.requires"];
63
64// ===========================================================================
65// Wire types
66// ===========================================================================
67
68/// How a provider signs someone in.
69#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
70#[serde(rename_all = "snake_case")]
71pub enum ProviderKind {
72    /// A person, through the browser (OIDC, WorkOS, …): `login {flow:
73    /// {browser}}` then `{code}`.
74    Browser,
75    /// A username and password (`login {flow: {password}}`).
76    Password,
77    /// An agent's key: a proof at the upgrade, then `login {flow: {session}}`.
78    Key,
79}
80
81/// One way in this server offers.
82#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
83pub struct Provider {
84    /// Its name (`workos`, `plexus-idp`, `key`).
85    pub name: String,
86    pub kind: ProviderKind,
87    /// A human label, when it has one.
88    #[serde(default, skip_serializing_if = "Option::is_none")]
89    pub label: Option<String>,
90}
91
92/// How a caller signs in (`auth.login {flow: …}`). On the wire, externally
93/// tagged: `{"browser": {"redirect": …}}`, `{"code": {"code", "state"}}`,
94/// `{"password": {"username", "password"}}`, `{"session": {"ttl_secs",
95/// "ceiling"}}`.
96#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
97#[serde(rename_all = "snake_case")]
98pub enum LoginFlow {
99    /// A person, from a client with a browser: answered with the URL to
100    /// open (`login_url {url, state}`); the browser comes back to
101    /// `redirect` (a loopback address the client listens on) with a
102    /// one-time code.
103    Browser { redirect: String },
104    /// The browser came back: trade the code for a session. Single-use,
105    /// bound to the state.
106    Code { code: String, state: String },
107    /// Where a provider takes a password.
108    Password { username: String, password: String },
109    /// A session on a connection that is already someone — a key proof at
110    /// the upgrade (IDENTITY-40), or a session — bounded by `ceiling`
111    /// (`role@SCOPE` / `grant@SCOPE` entries) and lasting `ttl_secs`.
112    Session {
113        #[serde(default)]
114        ttl_secs: Option<u64>,
115        #[serde(default)]
116        ceiling: Option<Vec<String>>,
117    },
118}
119
120/// A session a backend minted.
121#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
122pub struct Session {
123    /// The bearer token (`Authorization: Bearer …`, or the service's cookie).
124    pub token: String,
125    /// Who it is: `key:…`, `oidc:workos/user_…`, `idp:…`.
126    pub principal: String,
127    /// The agent id, for an agent's session.
128    #[serde(default, skip_serializing_if = "Option::is_none")]
129    pub agent: Option<String>,
130    /// A display name, when the provider gives one.
131    #[serde(default, skip_serializing_if = "Option::is_none")]
132    pub name: Option<String>,
133    /// Unix seconds.
134    pub expires_at: i64,
135    /// The session's ceiling, `role@SCOPE` / `grant@SCOPE`; empty: none.
136    #[serde(default)]
137    pub ceiling: Vec<String>,
138}
139
140/// Someone asking for access.
141#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
142pub struct Waiting {
143    pub principal: String,
144    #[serde(default, skip_serializing_if = "Option::is_none")]
145    pub name: Option<String>,
146    /// The way they came in (`key`, `workos`, …).
147    #[serde(default, skip_serializing_if = "Option::is_none")]
148    pub provider: Option<String>,
149    /// Unix seconds: when they first asked.
150    pub since: i64,
151}
152
153/// What `login` answers.
154#[derive(Debug, Clone, PartialEq, Eq)]
155pub enum LoginAnswer {
156    /// Open this URL; the browser comes back with a code for this state.
157    LoginUrl { url: String, state: String },
158    Session(Session),
159}
160
161/// What `signup` answers when the backend decides it.
162#[derive(Debug, Clone, PartialEq, Eq)]
163pub enum SignupAnswer {
164    Waiting(Waiting),
165    LoginUrl { url: String, state: String },
166    Session(Session),
167}
168
169/// Why a backend would not: said to the caller as an in-band error.
170#[derive(Debug, Clone, PartialEq, Eq)]
171pub struct AuthFailure(pub String);
172
173impl AuthFailure {
174    pub fn new(message: impl Into<String>) -> Self {
175        Self(message.into())
176    }
177}
178
179impl fmt::Display for AuthFailure {
180    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
181        f.write_str(&self.0)
182    }
183}
184
185impl std::error::Error for AuthFailure {}
186
187/// Why a store would not write.
188#[derive(Debug, Clone, PartialEq, Eq)]
189pub struct StoreError(pub String);
190
191impl StoreError {
192    pub fn new(message: impl Into<String>) -> Self {
193        Self(message.into())
194    }
195}
196
197impl fmt::Display for StoreError {
198    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
199        f.write_str(&self.0)
200    }
201}
202
203impl std::error::Error for StoreError {}
204
205/// A membership as `whoami` says it.
206#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
207pub struct MembershipEntry {
208    pub role: String,
209    pub scope: String,
210}
211
212/// Every event the `auth` activation sends (`{"type": …}`).
213#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
214#[serde(tag = "type", rename_all = "snake_case")]
215pub enum AuthEvent {
216    /// `providers`: one way in.
217    Provider {
218        name: String,
219        kind: ProviderKind,
220        #[serde(default, skip_serializing_if = "Option::is_none")]
221        label: Option<String>,
222    },
223    /// `login {browser}` / `signup`: open this URL.
224    LoginUrl { url: String, state: String },
225    /// `login`: signed in.
226    Session {
227        token: String,
228        principal: String,
229        #[serde(default, skip_serializing_if = "Option::is_none")]
230        agent: Option<String>,
231        #[serde(default, skip_serializing_if = "Option::is_none")]
232        name: Option<String>,
233        expires_at: i64,
234        #[serde(default)]
235        ceiling: Vec<String>,
236    },
237    /// `signup` (asking for access) / `waiting` (an admin's list).
238    Waiting {
239        principal: String,
240        #[serde(default, skip_serializing_if = "Option::is_none")]
241        name: Option<String>,
242        #[serde(default, skip_serializing_if = "Option::is_none")]
243        provider: Option<String>,
244        since: i64,
245    },
246    /// `whoami`.
247    Whoami {
248        principal: String,
249        #[serde(default, skip_serializing_if = "Option::is_none")]
250        name: Option<String>,
251        #[serde(default, skip_serializing_if = "Option::is_none")]
252        agent: Option<String>,
253        memberships: Vec<MembershipEntry>,
254        ceiling: Vec<String>,
255    },
256    /// `logout`.
257    LoggedOut { principal: String },
258    /// `requires {method}`: its grant, its target, the roles that list it.
259    Requires {
260        method: String,
261        grant: String,
262        #[serde(default, skip_serializing_if = "Option::is_none")]
263        target: Option<String>,
264        roles: Vec<String>,
265        #[serde(default, skip_serializing_if = "std::ops::Not::not")]
266        public: bool,
267    },
268    /// `roles` / `role_set`: a role and its grants (`all`: every grant —
269    /// admin).
270    Role {
271        role: String,
272        grants: Vec<String>,
273        #[serde(default, skip_serializing_if = "std::ops::Not::not")]
274        all: bool,
275    },
276    /// `grant`.
277    Granted { principal: String, role: String, scope: String },
278    /// `revoke`: the roles it removed there.
279    Revoked { principal: String, scope: String, roles: Vec<String> },
280    /// Anything refused or failed. A refusal (`error_kind: "forbidden"`)
281    /// carries AUTH-2's fields.
282    Error {
283        message: String,
284        #[serde(default, skip_serializing_if = "Option::is_none")]
285        error_kind: Option<String>,
286        #[serde(default, skip_serializing_if = "Option::is_none")]
287        grant: Option<String>,
288        #[serde(default, skip_serializing_if = "Option::is_none")]
289        scope: Option<String>,
290        #[serde(default, skip_serializing_if = "Option::is_none")]
291        roles: Option<Vec<String>>,
292        #[serde(default, skip_serializing_if = "Option::is_none")]
293        held_on: Option<Vec<String>>,
294    },
295}
296
297impl AuthEvent {
298    fn error(message: impl Into<String>) -> Self {
299        Self::Error { message: message.into(), error_kind: None, grant: None, scope: None, roles: None, held_on: None }
300    }
301}
302
303impl From<Session> for AuthEvent {
304    fn from(s: Session) -> Self {
305        Self::Session {
306            token: s.token,
307            principal: s.principal,
308            agent: s.agent,
309            name: s.name,
310            expires_at: s.expires_at,
311            ceiling: s.ceiling,
312        }
313    }
314}
315
316impl From<Waiting> for AuthEvent {
317    fn from(w: Waiting) -> Self {
318        Self::Waiting { principal: w.principal, name: w.name, provider: w.provider, since: w.since }
319    }
320}
321
322// ===========================================================================
323// What a service supplies
324// ===========================================================================
325
326/// What only the service knows about signing in. Async: a backend may talk
327/// to its identity provider. (The gate's own questions — [`Memberships`],
328/// [`Roles`], [`Resolve`] — stay synchronous and from memory.)
329#[async_trait]
330pub trait AuthBackend: Send + Sync + 'static {
331    /// The ways in this server offers (`auth.providers`).
332    fn providers(&self) -> Vec<Provider>;
333
334    /// Sign in by `flow` (`auth.login`). `caller` is the connection's
335    /// identity, if any: a [`LoginFlow::Session`] needs one (a key proof at
336    /// the upgrade, or a session) and must not widen it — the new
337    /// session's ceiling lies within the caller's (layer it). The browser
338    /// flow's start and finish, the code's single use and expiry, and the
339    /// session's minting are the backend's.
340    async fn login(&self, caller: Option<&AuthContext>, flow: LoginFlow) -> Result<LoginAnswer, AuthFailure>;
341
342    /// `auth.signup` where the activation's own rule does not decide it:
343    /// an anonymous caller (create an account — or refuse: sign in first),
344    /// or one who already holds a membership. (A signed-in caller holding
345    /// none is put on the waiting list by [`AuthBackend::ask_access`].)
346    async fn signup(&self, caller: Option<&AuthContext>, via: Option<String>) -> Result<SignupAnswer, AuthFailure>;
347
348    /// Put a signed-in caller who holds no membership on the waiting list
349    /// (asking again keeps the first `since`).
350    async fn ask_access(&self, caller: &AuthContext, via: Option<String>) -> Result<Waiting, AuthFailure>;
351
352    /// Everyone who has asked for access. The activation shows an admin
353    /// only those still holding no membership.
354    fn waiting(&self) -> Vec<Waiting>;
355
356    /// End the caller's session (`auth.logout`). A connection with no
357    /// session to end (a bare key proof) is not an error.
358    async fn logout(&self, caller: &AuthContext) -> Result<(), AuthFailure>;
359
360    /// AUTH-11: whether a signed-in caller's sign-in still stands — its
361    /// session not signed out, revoked or expired. The gate asks it before
362    /// every call it decides (`auth.*` included), so a sign-in that ended
363    /// holds nothing from its next call on. `Err`: why not, in words for
364    /// the caller. Memory only: it is asked on every call. (The gate
365    /// refuses a caller past its `expires_at` stamp before asking.)
366    fn alive(&self, caller: &AuthContext) -> Result<(), String>;
367}
368
369/// AUTH-11: the backend as the gate's [`Liveness`].
370struct BackendLiveness(Arc<dyn AuthBackend>);
371
372impl Liveness for BackendLiveness {
373    fn alive(&self, caller: &AuthContext) -> Result<(), String> {
374        self.0.alive(caller)
375    }
376}
377
378/// [`Roles`] an admin can edit (`auth.role_set`). The gate reads the same
379/// store, so an edit reaches the next call and the next view.
380#[async_trait]
381pub trait RoleStore: Roles + 'static {
382    /// Replace `role`'s grants. Never called for [`ADMIN`].
383    async fn set(&self, role: &RoleName, grants: GrantSet) -> Result<(), StoreError>;
384}
385
386/// [`Memberships`] an admin can edit (`auth.grant`, `auth.revoke`).
387#[async_trait]
388pub trait MembershipStore: Memberships + 'static {
389    /// Add a membership (holding it already is not an error).
390    async fn grant(&self, membership: Membership) -> Result<(), StoreError>;
391
392    /// Remove `principal`'s memberships on `scope` — the one role named, or
393    /// every role there. Answers the roles removed.
394    async fn revoke(
395        &self,
396        principal: &Principal,
397        role: Option<&RoleName>,
398        scope: &ScopeRef,
399    ) -> Result<Vec<RoleName>, StoreError>;
400}
401
402/// What [`DynamicHub::with_auth`](super::DynamicHub::with_auth) takes.
403#[derive(Clone)]
404pub struct AuthSetup {
405    pub backend: Arc<dyn AuthBackend>,
406    pub roles: Arc<dyn RoleStore>,
407    pub memberships: Arc<dyn MembershipStore>,
408    pub resolve: Arc<dyn Resolve>,
409    /// BIDIR-8: the service's grants generation, when it shares one between
410    /// this service's call gate and gates of its own (menger's access
411    /// layer); else the call gate counts alone. `auth.grant`, `auth.revoke`,
412    /// `auth.role_set` and `auth.logout` move it.
413    pub generation: Option<GrantsGeneration>,
414}
415
416impl AuthSetup {
417    pub fn new(
418        backend: Arc<dyn AuthBackend>,
419        roles: Arc<dyn RoleStore>,
420        memberships: Arc<dyn MembershipStore>,
421        resolve: Arc<dyn Resolve>,
422    ) -> Self {
423        Self { backend, roles, memberships, resolve, generation: None }
424    }
425
426    /// BIDIR-8: the service's call gate counts its moves in `generation`, shared with
427    /// whatever else the service decides by it.
428    pub fn with_generation(mut self, generation: GrantsGeneration) -> Self {
429        self.generation = Some(generation);
430        self
431    }
432}
433
434// ===========================================================================
435// The catalog: what each method requires
436// ===========================================================================
437
438/// What one method requires, as `auth.requires` says it.
439#[derive(Debug, Clone, PartialEq, Eq)]
440pub struct Requirement {
441    pub grant: String,
442    pub target: Option<String>,
443    pub public: bool,
444}
445
446/// Every method of the hub by grant — fed as activations register — and
447/// (NEST-5) the hub's slots, through which a literal path finds its slot's
448/// requirement.
449#[derive(Clone, Default)]
450pub struct Catalog(Arc<RwLock<BTreeMap<String, Requirement>>>, Arc<RwLock<super::slots::Slots>>);
451
452impl Catalog {
453    /// Add an activation's methods (not its auto-generated `schema`, which
454    /// is introspection, nor its child routes).
455    pub(crate) fn add(&self, schema: &PluginSchema) {
456        self.1.write().unwrap_or_else(|p| p.into_inner()).add(schema);
457        let mut map = self.0.write().unwrap_or_else(|p| p.into_inner());
458        for m in &schema.methods {
459            if m.is_auto_schema() || !matches!(m.role, MethodRole::Rpc) {
460                continue;
461            }
462            let grant = m.grant_or(&schema.namespace);
463            map.insert(grant.clone(), Requirement { grant, target: m.target.clone(), public: m.public });
464        }
465    }
466
467    /// NEST-15: forget every method under the top-level name `ns` (a peer the
468    /// service no longer serves).
469    pub(crate) fn remove_under(&self, ns: &str) {
470        let prefix = format!("{ns}.");
471        self.0.write().unwrap_or_else(|p| p.into_inner()).retain(|k, _| !k.starts_with(&prefix));
472    }
473
474    /// NEST-5: an untyped slot (`solar.{planet}`), granted whole.
475    pub(crate) fn add_slots(&self, untyped: &[String]) {
476        let mut slots = self.1.write().unwrap_or_else(|p| p.into_inner());
477        let mut map = self.0.write().unwrap_or_else(|p| p.into_inner());
478        for path in untyped {
479            slots.add_untyped(path);
480            map.insert(path.clone(), Requirement { grant: path.clone(), target: None, public: false });
481        }
482    }
483
484    /// The requirement of `method` (`tickets.set_status`); NEST-5: through
485    /// a slot, the slot's (`solar.earth.info` → `solar.{planet}.info`).
486    pub fn get(&self, method: &str) -> Option<Requirement> {
487        let map = self.0.read().unwrap_or_else(|p| p.into_inner());
488        if let Some(r) = map.get(method) {
489            return Some(r.clone());
490        }
491        let key = self.1.read().unwrap_or_else(|p| p.into_inner()).resolve(method)?;
492        map.get(&key).cloned()
493    }
494
495    /// Whether `grant` names a method of this hub.
496    pub fn knows(&self, grant: &str) -> bool {
497        self.0.read().unwrap_or_else(|p| p.into_inner()).contains_key(grant)
498    }
499}
500
501// ===========================================================================
502// The activation
503// ===========================================================================
504
505/// The `auth` activation. Mounted by
506/// [`DynamicHub::with_auth`](super::DynamicHub::with_auth); see the module
507/// docs.
508#[derive(Clone)]
509pub struct AuthActivation {
510    inner: Arc<AuthInner>,
511}
512
513struct AuthInner {
514    backend: Arc<dyn AuthBackend>,
515    roles: Arc<dyn RoleStore>,
516    memberships: Arc<dyn MembershipStore>,
517    gate: Gate,
518    catalog: Catalog,
519}
520
521/// The service's resolver, and `*` → `[*]` (a membership on everywhere is
522/// granted and revoked like any other scope).
523struct WithEverywhere(Arc<dyn Resolve>);
524
525impl Resolve for WithEverywhere {
526    fn chain(&self, target: &str) -> Option<Vec<ScopeRef>> {
527        if target.trim() == "*" {
528            return Some(vec![ScopeRef::Everywhere]);
529        }
530        self.0.chain(target)
531    }
532}
533
534impl AuthActivation {
535    /// The activation and the gate over the same stores.
536    pub(crate) fn mount(setup: AuthSetup, catalog: Catalog) -> (Self, Gate) {
537        let memberships: Arc<dyn Memberships> = setup.memberships.clone();
538        let roles: Arc<dyn Roles> = setup.roles.clone();
539        let mut gate = Gate::new(memberships, roles, Arc::new(WithEverywhere(setup.resolve)))
540            .with_liveness(Arc::new(BackendLiveness(setup.backend.clone())));
541        if let Some(generation) = setup.generation {
542            gate = gate.with_generation(generation);
543        }
544        let auth = Self {
545            inner: Arc::new(AuthInner {
546                backend: setup.backend,
547                roles: setup.roles,
548                memberships: setup.memberships,
549                gate: gate.clone(),
550                catalog,
551            }),
552        };
553        (auth, gate)
554    }
555}
556
557fn principal_of(ctx: &AuthContext) -> Option<Principal> {
558    ctx.principal()
559}
560
561fn meta(ctx: &AuthContext, key: &str) -> Option<String> {
562    ctx.get_metadata_string(key).filter(|s| !s.is_empty())
563}
564
565/// An in-band refusal: `grant` is needed on `*`.
566fn needs_everywhere(gate: &Gate, grant: &str, reach: &Reach) -> AuthEvent {
567    let g = Grant::new(grant);
568    AuthEvent::Error {
569        message: format!("needs {grant} on *"),
570        error_kind: Some("forbidden".into()),
571        grant: Some(grant.into()),
572        scope: Some("*".into()),
573        roles: Some(gate.roles_listing(&g).iter().map(|r| r.as_str().to_string()).collect()),
574        held_on: Some(reach.held_on().iter().map(|s| s.as_str().to_string()).collect()),
575    }
576}
577
578fn role_event(role: &RoleName, grants: Option<GrantSet>) -> AuthEvent {
579    match grants {
580        Some(GrantSet::All) => AuthEvent::Role { role: role.as_str().into(), grants: Vec::new(), all: true },
581        Some(GrantSet::Listed(set)) => AuthEvent::Role {
582            role: role.as_str().into(),
583            grants: set.iter().map(|g| g.as_str().to_string()).collect(),
584            all: false,
585        },
586        None => AuthEvent::Role { role: role.as_str().into(), grants: Vec::new(), all: false },
587    }
588}
589
590#[plexus_macros::activation(
591    version = "1.0.0",
592    description = "Sign in, who am I, what does this need",
593    roles(member = ["whoami", "logout", "requires"]),
594    // MACRO-12: every parameter is a type (`super::auth_params`); a bare
595    // string parameter does not compile here.
596    typed_params,
597)]
598impl AuthActivation {
599    /// The ways in this server offers.
600    #[plexus_macros::method(public, group = "sign in", description = "The ways in this server offers")]
601    async fn providers(&self) -> impl Stream<Item = AuthEvent> + Send + 'static {
602        let providers = self.inner.backend.providers();
603        stream! {
604            for p in providers {
605                yield AuthEvent::Provider { name: p.name, kind: p.kind, label: p.label };
606            }
607        }
608    }
609
610    /// Sign in — a person through the browser (`{browser: {redirect}}`,
611    /// then `{code: {code, state}}`), a password, or an agent's session on
612    /// a key-proved connection (`{session: {ttl_secs, ceiling}}`).
613    #[plexus_macros::method(
614        public,
615        group = "sign in",
616        description = "Sign in — a person through the browser, an agent with its key",
617        params(flow = "browser {redirect} | code {code, state} | password {username, password} | session {ttl_secs?, ceiling?}")
618    )]
619    async fn login(&self, auth: Option<&AuthContext>, flow: LoginFlow) -> impl Stream<Item = AuthEvent> + Send + 'static {
620        let inner = self.inner.clone();
621        let caller = auth.cloned();
622        stream! {
623            if let LoginFlow::Session { ceiling: Some(entries), .. } = &flow {
624                if let Err(e) = Ceiling::parse(entries) {
625                    yield AuthEvent::error(format!("ceiling: {e}"));
626                    return;
627                }
628            }
629            if matches!(flow, LoginFlow::Session { .. }) && caller.as_ref().and_then(principal_of).is_none() {
630                yield AuthEvent::error("a session needs a connection that is someone: a key proof at the upgrade, or a session");
631                return;
632            }
633            match inner.backend.login(caller.as_ref(), flow).await {
634                Ok(LoginAnswer::LoginUrl { url, state }) => yield AuthEvent::LoginUrl { url, state },
635                Ok(LoginAnswer::Session(s)) => yield s.into(),
636                Err(e) => yield AuthEvent::error(e.0),
637            }
638        }
639    }
640
641    /// Create an account, or ask for access: a signed-in caller holding no
642    /// membership of its own ([`Memberships::own_held`]) joins the waiting
643    /// list for an admin.
644    #[plexus_macros::method(
645        public,
646        group = "sign in",
647        description = "Create an account, or ask for access",
648        params(via = "The provider to sign up through, where the server offers several")
649    )]
650    async fn signup(&self, auth: Option<&AuthContext>, via: Option<param::ProviderName>) -> impl Stream<Item = AuthEvent> + Send + 'static {
651        let inner = self.inner.clone();
652        let caller = auth.cloned();
653        let via = via.map(param::ProviderName::into_string);
654        stream! {
655            let holds_none = caller
656                .as_ref()
657                .and_then(principal_of)
658                .map(|p| inner.memberships.own_held(&p).is_empty());
659            let answer = match (holds_none, caller.as_ref()) {
660                (Some(true), Some(ctx)) => inner.backend.ask_access(ctx, via).await.map(SignupAnswer::Waiting),
661                _ => inner.backend.signup(caller.as_ref(), via).await,
662            };
663            match answer {
664                Ok(SignupAnswer::Waiting(w)) => yield w.into(),
665                Ok(SignupAnswer::LoginUrl { url, state }) => yield AuthEvent::LoginUrl { url, state },
666                Ok(SignupAnswer::Session(s)) => yield s.into(),
667                Err(e) => yield AuthEvent::error(e.0),
668            }
669        }
670    }
671
672    /// Who this connection is: principal, name, the roles it holds where,
673    /// and its session's ceiling.
674    #[plexus_macros::method(group = "you", description = "Who you are: principal, roles held where, ceiling")]
675    async fn whoami(&self, auth: &AuthContext) -> impl Stream<Item = AuthEvent> + Send + 'static {
676        let inner = self.inner.clone();
677        let ctx = auth.clone();
678        stream! {
679            let Some(p) = principal_of(&ctx) else {
680                yield AuthEvent::error("sign in first");
681                return;
682            };
683            let memberships = inner
684                .memberships
685                .held(&p)
686                .into_iter()
687                .map(|m| MembershipEntry { role: m.role.as_str().into(), scope: m.scope.as_str().into() })
688                .collect();
689            let ceiling = Ceiling::layers_of(&ctx)
690                .map(|layers| layers.iter().flat_map(|l| l.text()).collect())
691                .unwrap_or_default();
692            yield AuthEvent::Whoami {
693                principal: p.to_string(),
694                name: meta(&ctx, "name"),
695                agent: meta(&ctx, "agent"),
696                memberships,
697                ceiling,
698            };
699        }
700    }
701
702    /// End this session.
703    #[plexus_macros::method(group = "you", description = "Sign out: end this session")]
704    async fn logout(&self, auth: &AuthContext) -> impl Stream<Item = AuthEvent> + Send + 'static {
705        let inner = self.inner.clone();
706        let ctx = auth.clone();
707        stream! {
708            let principal = principal_of(&ctx).map(|p| p.to_string()).unwrap_or_default();
709            match inner.backend.logout(&ctx).await {
710                Ok(()) => {
711                    // BIDIR-8: a sign-in ended; whatever holds it verifies again.
712                    inner.gate.moved(GrantsMove::SignOut);
713                    yield AuthEvent::LoggedOut { principal }
714                }
715                Err(e) => yield AuthEvent::error(e.0),
716            }
717        }
718    }
719
720    /// What a method needs: its grant, its target and the roles that list
721    /// it.
722    #[plexus_macros::method(
723        group = "you",
724        description = "What a method needs: its grant, target, and the roles that list it",
725        params(method = "The method, as <activation>.<method>: tickets.set_status"),
726        example(note = "what changing a ticket's status needs", params = r#"{"method": "tickets.set_status"}"#)
727    )]
728    async fn requires(&self, auth: &AuthContext, method: param::MethodPath) -> impl Stream<Item = AuthEvent> + Send + 'static {
729        let _ = auth;
730        let inner = self.inner.clone();
731        stream! {
732            match inner.catalog.get(method.as_str()) {
733                None => yield AuthEvent::error(format!("no method {method} here")),
734                Some(req) => {
735                    let roles = inner.gate.roles_listing(&Grant::new(req.grant.clone()));
736                    yield AuthEvent::Requires {
737                        method: method.into_string(),
738                        grant: req.grant,
739                        target: req.target,
740                        roles: roles.iter().map(|r| r.as_str().to_string()).collect(),
741                        public: req.public,
742                    };
743                }
744            }
745        }
746    }
747
748    /// Every role and the grants it lists (admin: every grant).
749    #[plexus_macros::method(group = "admin", description = "Every role and the grants it lists")]
750    async fn roles(&self, auth: &AuthContext) -> impl Stream<Item = AuthEvent> + Send + 'static {
751        let _ = auth;
752        let inner = self.inner.clone();
753        stream! {
754            let admin = RoleName::new(ADMIN);
755            yield role_event(&admin, Some(GrantSet::All));
756            let names: BTreeSet<RoleName> = inner.roles.names().into_iter().filter(|r| r.as_str() != ADMIN).collect();
757            for r in names {
758                let grants = inner.roles.grants(&r);
759                yield role_event(&r, grants);
760            }
761        }
762    }
763
764    /// Set a role's grants (admin on `*`). Each entry a grant
765    /// (`tickets.get`) or an existing role whose grants it includes.
766    #[plexus_macros::method(
767        group = "admin",
768        description = "Set a role's grants (admin on *)",
769        params(role = "The role (not admin)", grants = "Grants (tickets.get) or roles to include")
770    )]
771    async fn role_set(&self, auth: &AuthContext, reach: Reach, role: param::RoleName, grants: Vec<param::GrantName>) -> impl Stream<Item = AuthEvent> + Send + 'static {
772        let _ = auth;
773        let inner = self.inner.clone();
774        stream! {
775            if !reach.is_everywhere() {
776                yield needs_everywhere(&inner.gate, "auth.role_set", &reach);
777                return;
778            }
779            // The name's shape (one word, no `.` or `@`) is `param::RoleName`'s,
780            // refused as InvalidParams before this runs.
781            if role.as_str() == ADMIN {
782                yield AuthEvent::error("admin holds every grant; it is not edited");
783                return;
784            }
785            let mut set: BTreeSet<Grant> = BTreeSet::new();
786            for entry in grants.iter() {
787                let entry = entry.as_str();
788                if entry.contains('.') {
789                    if !inner.catalog.knows(entry) {
790                        yield AuthEvent::error(format!("no method {entry} here"));
791                        return;
792                    }
793                    set.insert(Grant::new(entry));
794                } else {
795                    match inner.roles.grants(&RoleName::new(entry)) {
796                        Some(GrantSet::Listed(included)) => set.extend(included),
797                        Some(GrantSet::All) => {
798                            yield AuthEvent::error(format!("{entry} holds every grant; a role cannot include it"));
799                            return;
800                        }
801                        None => {
802                            yield AuthEvent::error(format!("no role {entry} to include"));
803                            return;
804                        }
805                    }
806                }
807            }
808            let name = role.role();
809            if let Err(e) = inner.roles.set(&name, GrantSet::Listed(set)).await {
810                yield AuthEvent::error(e.0);
811                return;
812            }
813            inner.gate.moved(GrantsMove::RoleEdit);
814            let now = inner.roles.grants(&name);
815            yield role_event(&name, now);
816        }
817    }
818
819    /// Give `principal` `role` on `scope` (whoever holds `auth.grant` on
820    /// the scope: admin there).
821    #[plexus_macros::method(
822        target = "scope",
823        group = "admin",
824        description = "Give a principal a role on a scope",
825        params(principal = "key:…, oidc:…/…, idp:…", role = "The role", scope = "Where: a scope name, or *"),
826        example(note = "make a person an editor on MENGER", params = r#"{"principal": "oidc:workos/user_01M4", "role": "editor", "scope": "MENGER"}"#),
827        example(note = "make an agent's key an admin everywhere", params = r#"{"principal": "key:ac79e0d1f2a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d", "role": "admin", "scope": "*"}"#)
828    )]
829    async fn grant(&self, auth: &AuthContext, principal: param::Principal, role: param::RoleName, scope: param::ScopeName) -> impl Stream<Item = AuthEvent> + Send + 'static {
830        let _ = auth;
831        let inner = self.inner.clone();
832        stream! {
833            let who: Principal = principal.principal();
834            let role_name = role.role();
835            if role_name.as_str() != ADMIN && inner.roles.grants(&role_name).is_none() {
836                yield AuthEvent::error(format!("no role {role} here"));
837                return;
838            }
839            let scope_ref = scope.scope();
840            let m = Membership { principal: who.clone(), role: role_name.clone(), scope: scope_ref.clone() };
841            match inner.memberships.grant(m).await {
842                Ok(()) => {
843                    inner.gate.moved(GrantsMove::Grant);
844                    yield AuthEvent::Granted {
845                        principal: who.to_string(),
846                        role: role_name.as_str().into(),
847                        scope: scope_ref.as_str().into(),
848                    }
849                }
850                Err(e) => yield AuthEvent::error(e.0),
851            }
852        }
853    }
854
855    /// Take `principal`'s role (or every role) on `scope` away.
856    #[plexus_macros::method(
857        target = "scope",
858        group = "admin",
859        description = "Take a principal's role on a scope away",
860        params(principal = "key:…, oidc:…/…, idp:…", role = "The role; absent: every role there", scope = "Where: a scope name, or *")
861    )]
862    async fn revoke(&self, auth: &AuthContext, principal: param::Principal, role: Option<param::RoleName>, scope: param::ScopeName) -> impl Stream<Item = AuthEvent> + Send + 'static {
863        let _ = auth;
864        let inner = self.inner.clone();
865        stream! {
866            let who: Principal = principal.principal();
867            let scope_ref = scope.scope();
868            let role_name = role.as_ref().map(param::RoleName::role);
869            match inner.memberships.revoke(&who, role_name.as_ref(), &scope_ref).await {
870                Ok(removed) => {
871                    if !removed.is_empty() {
872                        inner.gate.moved(GrantsMove::Revoke);
873                    }
874                    yield AuthEvent::Revoked {
875                        principal: who.to_string(),
876                        scope: scope_ref.as_str().into(),
877                        roles: removed.iter().map(|r| r.as_str().to_string()).collect(),
878                    }
879                }
880                Err(e) => yield AuthEvent::error(e.0),
881            }
882        }
883    }
884
885    /// Who signed up or asked for access and holds nothing of its own yet
886    /// ([`Memberships::own_held`]; admin on `*`).
887    #[plexus_macros::method(group = "admin", description = "Who asked for access and holds nothing yet (admin on *)")]
888    async fn waiting(&self, auth: &AuthContext, reach: Reach) -> impl Stream<Item = AuthEvent> + Send + 'static {
889        let _ = auth;
890        let inner = self.inner.clone();
891        stream! {
892            if !reach.is_everywhere() {
893                yield needs_everywhere(&inner.gate, "auth.waiting", &reach);
894                return;
895            }
896            for w in inner.backend.waiting() {
897                let still = w
898                    .principal
899                    .parse::<Principal>()
900                    .map(|p| inner.memberships.own_held(&p).is_empty())
901                    .unwrap_or(true);
902                if still {
903                    yield w.into();
904                }
905            }
906        }
907    }
908}