axess-core 0.11.0

Core implementation for the axess library. Session state machine, multi-factor authentication engine, Cedar Policy evaluation, and pluggable storage backends. Use the `axess` facade crate unless you need direct access to internals.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
//! Authentication service: orchestrates identity lookup, factor verification,
//! and session management.
//!
//! Hold an `Arc<AuthnService<…>>` in Axum state. The login flow is:
//!
//! 1. [`RequestAuthnService::begin_login`]: identifies the user, starts the MFA chain.
//! 2. [`RequestAuthnService::prepare_factor`]: for challenge-based factors (EmailOtp),
//!    generates and stores the challenge, returns data for the app to deliver.
//!    For simple factors (Password, TOTP, HOTP), returns `Ready` immediately.
//! 3. [`RequestAuthnService::verify_factor`]: verifies the credential the user submits.
//!
//! # Enforcing session validity on protected routes
//!
//! The `login_required!` macro checks `is_authenticated()` on the session
//! state, but does **not** consult the session registry. If you use
//! [`AuthnServiceBuilder::with_registry`] for forced-logout support, use
//! [`require_valid_session`] middleware instead:
//!
//! ```rust,ignore
//! use axess::require_valid_session;
//!
//! let authn = AuthnService::builder(identity, factors)
//!     .with_registry(registry)
//!     .build();
//!
//! let validator = authn.session_validator();
//!
//! let app = Router::new()
//!     .route("/api/protected", get(my_handler))
//!     .layer(require_valid_session(validator));
//! ```
//!
//! [`SessionValidator`] is a lightweight, `Clone` handle that avoids threading
//! the full `AuthnService` generic type through your middleware stack.

// ── Sub-modules ──────────────────────────────────────────────────────────────

mod account;
mod builder;
mod factor_pipeline;
mod login;
pub mod outcomes;
#[cfg(feature = "device")]
pub mod step_up;
mod verification;

#[cfg(feature = "fido2")]
pub(crate) mod fido2_service;

#[cfg(feature = "ldap")]
mod ldap_service;

#[cfg(feature = "oauth")]
pub(crate) mod oauth_service;

pub mod session_validator;

pub use builder::AuthnServiceBuilder;
#[cfg(feature = "oauth")]
pub use builder::{DEFAULT_JWKS_REFRESH_INTERVAL, DEFAULT_SID_MAP_CAPACITY};
pub use outcomes::{FactorOutcome, LoginOutcome, PrepareOutcome, SignupOutcome};
pub use session_validator::{NoSessionRegistryError, SessionValidator, require_valid_session};
#[cfg(feature = "device")]
pub use step_up::{StepUpPolicy, StepUpPolicyBuilder, decide_step_up_for_user};

// ── Imports ──────────────────────────────────────────────────────────────────

use crate::authn::store::{FactorStore, IdentityStore};
use axess_clock::Clock;
use std::sync::Arc;

// ── AuthnService ──────────────────────────────────────────────────────────────

/// Authentication service: orchestrates identity lookup, factor verification,
/// and session management.
///
/// Generic over:
/// - `I`: [`IdentityStore`]
/// - `F`: [`FactorStore`] (same error type as `I`)
///
/// RNG and Clock are held as `Arc<dyn SecureRng>` / `Arc<dyn Clock>` so
/// the service shape is `AuthnService<I, F>` regardless of which
/// concrete RNG / clock the adopter wires in. Swap clocks for DST via
/// [`AuthnServiceBuilder::with_clock`] without changing the type; adopters
/// can store the service in `Arc<AppState>` and inject a `MockClock`
/// for tests against the same `<I, F>` shape.
/// A cheap handle over one `Arc` of shared collaborators.
///
/// This is the application-lifetime half: keep one in application state.
/// It cannot write an audit event, because it does not know who the client
/// is. The methods that can are on [`RequestAuthnService`], which
/// [`with_audit_context`](Self::with_audit_context) derives per request.
///
/// Cloning is a refcount bump. Construction goes through
/// [`AuthnService::builder`], because the collaborators must be settled
/// before they are shared.
pub struct AuthnService<I, F>
where
    I: IdentityStore,
    F: FactorStore,
{
    pub(crate) inner: Arc<AuthnServiceBuilder<I, F>>,
}

// Cloneable whatever `I` and `F` are, because both sit behind the `Arc`.
// `#[derive(Clone)]` would emit `I: Clone, F: Clone` bounds and so refuse
// the stores adopters actually have.
impl<I, F> Clone for AuthnService<I, F>
where
    I: IdentityStore,
    F: FactorStore,
{
    fn clone(&self) -> Self {
        Self {
            inner: Arc::clone(&self.inner),
        }
    }
}

/// An [`AuthnService`] bound to one request's client metadata.
///
/// Every method that can write an audit event lives here and nowhere else,
/// so a row with no client address is not a thing a caller can produce by
/// forgetting a step: there is no `begin_login` to forget it on. Derive one
/// per request with
/// [`AuthnService::with_audit_context`](AuthnService::with_audit_context)
/// and let it die with the request.
///
/// It derefs to the service, so the application-scoped methods
/// ([`check_session`](AuthnService::check_session), the capability
/// predicates, the revocation calls) are reachable through it and a handler
/// needs only the one handle.
///
/// **Do not store one.** It pins that client's address for as long as it
/// lives, so a copy kept in application state would stamp a stale address
/// onto every later event: a quieter kind of wrong than a missing one,
/// because the rows look complete.
pub struct RequestAuthnService<I, F>
where
    I: IdentityStore,
    F: FactorStore,
{
    service: AuthnService<I, F>,
    /// Client metadata stamped onto every event this handle emits. Not
    /// optional: holding one is what the type means.
    pub(crate) audit: Arc<crate::authn::event::AuditContext>,
}

// Same reason as `AuthnService`'s hand-written impl: a derive would demand
// `I: Clone, F: Clone` and so refuse the stores adopters actually have.
impl<I, F> Clone for RequestAuthnService<I, F>
where
    I: IdentityStore,
    F: FactorStore,
{
    fn clone(&self) -> Self {
        Self {
            service: self.service.clone(),
            audit: Arc::clone(&self.audit),
        }
    }
}

impl<I, F> std::ops::Deref for RequestAuthnService<I, F>
where
    I: IdentityStore,
    F: FactorStore,
{
    type Target = AuthnService<I, F>;

    fn deref(&self) -> &Self::Target {
        &self.service
    }
}

impl<B> AuthnService<B, B>
where
    B: crate::authn::store::AuthnBackend + Clone,
{
    /// Create a new service from a backend that implements both
    /// [`IdentityStore`] and [`FactorStore`] (typical SQL pattern).
    /// Equivalent to `AuthnService::new(backend.clone(), backend)`:
    /// removes the universal `(b.clone(), b)` ceremony at every example.
    pub fn from_backend(backend: B) -> Self {
        Self::new(backend.clone(), backend)
    }

    /// Start configuring a service from a dual-role backend.
    pub fn builder_from_backend(backend: B) -> AuthnServiceBuilder<B, B> {
        AuthnService::builder(backend.clone(), backend)
    }
}

impl<I, F> AuthnService<I, F>
where
    I: IdentityStore,
    F: FactorStore<Error = I::Error>,
{
    /// Create a service with OS RNG, system clock and no customisation.
    ///
    /// Shorthand for `AuthnService::builder(identity, factors).build()`.
    /// Reach for [`builder`](Self::builder) to set a clock, registry,
    /// metrics, providers, or the audit-context policy.
    pub fn new(identity: I, factors: F) -> Self {
        Self::builder(identity, factors).build()
    }

    /// Start configuring a service.
    pub fn builder(identity: I, factors: F) -> AuthnServiceBuilder<I, F> {
        AuthnServiceBuilder::new(identity, factors)
    }

    /// Derive the request-scoped handle that can authenticate, stamping
    /// every event it emits with `ctx`.
    ///
    /// Call it once per request, and let the result die with the request:
    ///
    /// ```ignore
    /// async fn post_login(
    ///     State(state): State<AppState>,
    ///     audit: AuditContext,          // the extractor; reads what the layer resolved
    ///     Form(form): Form<LoginForm>,
    /// ) -> Response {
    ///     let svc = state.authn.with_audit_context(audit);
    ///     svc.begin_login(&form.identifier, &tenant, &session).await?;
    ///     svc.verify_factor(&credential, &session).await?;
    /// }
    /// ```
    ///
    /// Both calls go through `svc` because there is no other way to make
    /// them: `begin_login` and `verify_factor` are on
    /// [`RequestAuthnService`], not on this type. Before 0.7.0 they were on both
    /// and reaching back to `state.authn` for the second call wrote that
    /// row with no address, which in a login handler is the failed-password
    /// row: the one a brute-force query counts.
    ///
    /// The collaborators are shared, so this costs a refcount bump and one
    /// small allocation; only the context differs between handles.
    pub fn with_audit_context(
        &self,
        ctx: crate::authn::event::AuditContext,
    ) -> RequestAuthnService<I, F> {
        RequestAuthnService {
            service: self.clone(),
            audit: Arc::new(ctx),
        }
    }

    /// Return a reference to the OAuth provider registry for introspection.
    ///
    /// Use `oauth_providers().provider_names()` or `oauth_providers().provider_count()`
    /// to list or count the configured providers.
    #[cfg(feature = "oauth")]
    pub fn oauth_providers(&self) -> &crate::federation::oauth::OAuthProviderRegistry {
        &self.inner.oauth_providers
    }

    /// The OIDC `sid` map this service fills on every OAuth login that
    /// carries a `sid`. Hand it to
    /// [`BackChannelLogoutHandler::new`](crate::federation::backchannel_logout::BackChannelLogoutHandler::new)
    /// and the front-channel handler so an IdP-initiated logout finds the
    /// sessions this service created. Clones share one map.
    #[cfg(feature = "oauth")]
    pub fn sid_map(&self) -> crate::federation::sid_map::SidMap {
        self.inner.sid_map.clone()
    }

    /// `true` when at least one OAuth/OIDC provider has been registered
    /// via [`with_oauth_provider`](AuthnServiceBuilder::with_oauth_provider). Sugar over
    /// [`oauth_providers`](AuthnService::oauth_providers)`.provider_count() > 0`
    /// for the common yes/no check.
    #[cfg(feature = "oauth")]
    pub fn has_oauth_providers(&self) -> bool {
        self.inner.oauth_providers.provider_count() > 0
    }

    /// `true` when a FIDO2/WebAuthn provider has been attached via
    /// [`with_fido2`](AuthnServiceBuilder::with_fido2). Adopters typically already hold
    /// a handle to the provider they wired in; this predicate exists so
    /// adopters that only need "is it configured?" don't have to keep
    /// their own bookkeeping in sync with the service.
    #[cfg(feature = "fido2")]
    pub fn has_fido2(&self) -> bool {
        self.inner.fido2.is_some()
    }

    /// `true` when an LDAP provider has been attached via
    /// [`with_ldap`](AuthnServiceBuilder::with_ldap). See [`has_fido2`](Self::has_fido2)
    /// for rationale.
    #[cfg(feature = "ldap")]
    pub fn has_ldap(&self) -> bool {
        self.inner.ldap.is_some()
    }

    /// Whether a session registry is wired on this service. Adopters checking
    /// before calling the revocation methods can use this to short-circuit and
    /// return a clearer error than [`NoSessionRegistryError`] from deep
    /// inside a handler.
    pub fn has_session_registry(&self) -> bool {
        self.inner.registry.is_some()
    }

    /// Invalidate every active session for a user. Used by admin "kick" and
    /// by credential-rotation paths that need to force a re-authentication.
    ///
    /// Returns `Err(NoSessionRegistryError)` when no registry is wired on
    /// the service: the caller cannot enforce revocation without one and
    /// should surface that as a 500 / configuration error rather than
    /// reporting a misleading 200 OK.
    ///
    /// Registry-backend errors (Valkey outage, replication lag) are logged
    /// at `warn` inside the wrapper and *swallowed*; the method returns
    /// `Ok(())` so the caller's flow continues. Backends that need
    /// fail-closed semantics should arrange them at the deployment layer
    /// (e.g. liveness probe gating on registry health).
    pub async fn invalidate_user_sessions(
        &self,
        user_id: &crate::authn::ids::UserId,
    ) -> Result<(), NoSessionRegistryError> {
        match &self.inner.registry {
            Some(reg) => {
                reg.invalidate_user(user_id).await;
                Ok(())
            }
            None => Err(NoSessionRegistryError),
        }
    }

    /// Invalidate a single session for a user. Used by per-session "end"
    /// admin actions and by sibling-session-revocation paths (e.g. after
    /// disabling MFA, kill every other session except the current one).
    ///
    /// Same error contract as [`invalidate_user_sessions`](Self::invalidate_user_sessions).
    pub async fn invalidate_session(
        &self,
        user_id: &crate::authn::ids::UserId,
        session_id: &crate::session::id::SessionId,
    ) -> Result<(), NoSessionRegistryError> {
        match &self.inner.registry {
            Some(reg) => {
                reg.invalidate_session(user_id, session_id).await;
                Ok(())
            }
            None => Err(NoSessionRegistryError),
        }
    }

    /// Enumerate active sessions for a user. Used by admin session lists,
    /// concurrent-session-limit enforcement, and by "kill every other
    /// session" flows that need to read the active set before filtering
    /// out the current session.
    ///
    /// Returns an empty vec when the registry's backend doesn't support
    /// enumeration. Returns `Err(NoSessionRegistryError)` when no
    /// registry is wired.
    pub async fn active_sessions(
        &self,
        user_id: &crate::authn::ids::UserId,
    ) -> Result<Vec<crate::session::id::SessionId>, NoSessionRegistryError> {
        match &self.inner.registry {
            Some(reg) => Ok(reg.active_sessions(user_id).await),
            None => Err(NoSessionRegistryError),
        }
    }

    /// Create a [`SessionValidator`] that checks registry validity.
    ///
    /// Use this with [`require_valid_session`] middleware to enforce
    /// registry-based session checks on protected routes without threading
    /// the full `AuthnService` type through your middleware:
    pub fn session_validator(&self) -> SessionValidator {
        SessionValidator {
            registry: self.inner.registry.clone(),
            identity: None,
        }
    }

    /// Create a [`SessionValidator`] that **also** cross-checks the session's
    /// stated `tenant_id` against the user's actual tenant on every call.
    ///
    /// Adds one `IdentityLookup::get_user_tenant` lookup per `is_valid` call: wire
    /// this when your threat model includes session-store tampering or
    /// cross-environment session bleed (shared keys across dev/prod, backup
    /// restored after compromise, etc.). For deployments where the session
    /// store sits inside the same trust boundary as the identity store,
    /// the lookup overhead is wasted; use [`session_validator`](Self::session_validator)
    /// in that case.
    pub fn session_validator_with_identity_check(&self) -> SessionValidator {
        SessionValidator {
            registry: self.inner.registry.clone(),
            identity: Some(Arc::new(session_validator::IdentityWrapper(
                self.inner.identity.clone(),
            ))),
        }
    }
}

impl<I, F> RequestAuthnService<I, F>
where
    I: IdentityStore,
    F: FactorStore<Error = I::Error>,
{
    /// Stamp the builder with `self.inner.clock.now()` and dispatch the
    /// resulting [`AuthEvent`](crate::authn::event::AuthEvent) to the
    /// identity store, logging at `tracing::error!` if the store
    /// rejects the write.
    ///
    /// This is the canonical audit-emit entry point for the crate.
    /// The vast majority of audit emits share the shape
    /// `builder.build_at(self.inner.clock.now())` followed by an identity
    /// `record_event` that must not block the request flow on store
    /// failure. Threading the clock through the builder finisher at
    /// every call site obscures intent (the timestamp is always *now*)
    /// and risks drift if the clock dependency ever changes shape
    /// (matching how the RNG threading was retrofitted). `emit_audit`
    /// centralises the `clock + record + log` pattern so call sites
    /// read as `self.emit_audit(builder.with_factor(kind)).await`:
    /// the audit content is what the reader cares about.
    ///
    /// Audit-store outages surface as `tracing::error!` (with
    /// `event_type` and `event_status` context) **and** as
    /// [`AuthnError::Store`](crate::authn::error::AuthnError::Store): the
    /// flow stops. An authentication that is not recorded has not, for
    /// evidence purposes, happened, and a deployment that offers this
    /// catalogue as SOC 2 or PCI-DSS evidence cannot have it silently
    /// develop holes. The trade is availability: logins fail while the
    /// audit store does, so the sink belongs behind something durable
    /// (a local write shipped asynchronously) rather than a remote
    /// service on the request path.
    ///
    /// Every path that can reject a login emits before it returns, which
    /// is what keeps this from becoming a user-enumeration oracle: an
    /// unknown identifier and a wrong password both attempt an audit
    /// write, so an outage fails both identically.
    ///
    /// The underlying `record_event_or_log` is private;
    /// callers go through [`emit_audit`](Self::emit_audit) for the
    /// "now" case and [`emit_audit_at`](Self::emit_audit_at) for the
    /// captured-timestamp case. The single intentional bypass is the
    /// audit-failure-with-context emit in `factor_pipeline.rs`,
    /// which calls `self.inner.identity.record_event(...)` directly so its
    /// `tracing::error!` can include `user_id = %user_id`: context
    /// `record_event_or_log` doesn't have. That bypass is documented
    /// at the call site.
    pub(crate) async fn emit_audit(
        &self,
        builder: crate::authn::event::AuthEventBuilder,
    ) -> Result<(), crate::authn::error::AuthnError<I::Error>> {
        self.emit_audit_at(builder, self.inner.clock.now()).await
    }

    /// Stamp the builder with the given `event_time` and dispatch
    /// to the identity store, failing the flow on a store error exactly
    /// as [`emit_audit`](Self::emit_audit) does.
    ///
    /// Use this when several events in the same flow must share a
    /// single timestamp (e.g. a successful signup and the resulting
    /// `Authenticated` row should be the same instant): capture the
    /// time once upstream and pass it to each emit. Calls that just
    /// want "now" should use [`emit_audit`](Self::emit_audit).
    pub(crate) async fn emit_audit_at(
        &self,
        builder: crate::authn::event::AuthEventBuilder,
        event_time: chrono::DateTime<chrono::Utc>,
    ) -> Result<(), crate::authn::error::AuthnError<I::Error>> {
        // The single point every emit site funnels through, and so the one
        // place the per-request context is applied. It is not optional
        // here: reaching this method at all means a caller held a
        // `RequestAuthnService`, and the only way to hold one is to have supplied
        // a context. Before 0.6.0 nothing applied it anywhere and every row
        // carried a null client IP; 0.6.0 applied it when present and
        // offered a runtime policy for when it was not; 0.7.0 removed the
        // state the policy was checking for.
        let event = builder.with_audit_context(&self.audit).build_at(event_time);

        // Kept for the failure log only; formatting them is deferred to
        // that branch so a recorded event pays for no strings.
        let (event_type, event_status) = (event.event_type.clone(), event.event_status.clone());
        match self.inner.identity.record_event(event).await {
            Ok(crate::authn::store::AuditOutcome::Recorded) => Ok(()),
            Ok(crate::authn::store::AuditOutcome::Shed) => {
                // A deliberate drop, not a failure: the sink is protecting
                // its storage. Proceed, and let the metric carry it.
                self.inner.metrics.audit_event_shed();
                Ok(())
            }
            Err(e) => {
                tracing::error!(
                    error = %e,
                    event_type = ?event_type,
                    event_status = ?event_status,
                    "identity store rejected audit event; failing the flow rather \
                     than proceeding unrecorded"
                );
                self.inner.metrics.audit_store_outage();
                Err(crate::authn::error::AuthnError::Store(e))
            }
        }
    }
}

#[cfg(test)]
mod audit_context_wiring_tests {
    //! The seam these cover was unwired for an entire release: the context
    //! type, the extractor and the builder method all existed, and nothing
    //! joined them, so every audit row carried a null client IP while the
    //! documentation offered the catalogue as compliance evidence. Nothing
    //! failed, which is why nothing caught it.
    //!
    //! The case that needed a test most is the one that no longer compiles.
    //! `AuthnService` has no `emit_audit`, so "a route that forgot to wire a
    //! context" is not a state a test can construct, and the policy that
    //! used to catch it at runtime is gone with it.

    use super::AuthnService;
    use crate::authn::event::{AuditContext, AuthEventBuilder, AuthEventType};
    use crate::testing::{MockFactorStore, MockIdentityStore};

    fn ctx_with_ip(ip: &str) -> AuditContext {
        AuditContext {
            ip_address: Some(ip.parse().expect("test literal is a valid address")),
            user_agent: Some("probe/1.0".to_owned()),
            ..Default::default()
        }
    }

    /// The property the wiring exists for: a handle carrying a context
    /// stamps it onto the event that reaches the sink.
    #[tokio::test]
    async fn context_reaches_the_stored_event() {
        let identity = MockIdentityStore::new();
        let service = AuthnService::new(identity.clone(), MockFactorStore::new());

        service
            .with_audit_context(ctx_with_ip("203.0.113.7"))
            .emit_audit(AuthEventBuilder::success(AuthEventType::Authenticated))
            .await
            .expect("emit must succeed");

        let events = identity.events();
        let event = events.last().expect("one event recorded");
        assert_eq!(
            event.ip_address,
            Some("203.0.113.7".parse().unwrap()),
            "the context's address must reach the stored event"
        );
        assert_eq!(event.user_agent.as_deref(), Some("probe/1.0"));
    }

    /// A context with no address is a context, and must write its row.
    ///
    /// Requiring the type is not requiring an address. Where nothing is
    /// trustworthy the extractor honestly yields `None`, and a first cut of
    /// the policy this replaced tested whether the *event* carried client
    /// metadata, which would have failed every login on exactly the
    /// deployments that got this right.
    #[tokio::test]
    async fn an_honestly_empty_context_still_records() {
        let identity = MockIdentityStore::new();
        let service = AuthnService::new(identity.clone(), MockFactorStore::new());

        let empty = AuditContext::default();
        assert!(empty.ip_address.is_none());

        service
            .with_audit_context(empty)
            .emit_audit(AuthEventBuilder::success(AuthEventType::Authenticated))
            .await
            .expect("an empty context is still a context");

        let events = identity.events();
        assert_eq!(events.len(), 1);
        assert!(events[0].ip_address.is_none());
        assert_eq!(
            events[0].ip_source,
            crate::client_ip::Source::Unknown,
            "the row says it does not know, rather than claiming a source"
        );
    }

    /// The handle is a view over shared collaborators, not a second
    /// service: two request handles write to the same store, each with its
    /// own client.
    #[tokio::test]
    async fn request_handles_share_the_same_collaborators() {
        let identity = MockIdentityStore::new();
        let service = AuthnService::new(identity.clone(), MockFactorStore::new());

        service
            .with_audit_context(ctx_with_ip("203.0.113.7"))
            .emit_audit(AuthEventBuilder::success(AuthEventType::Authenticated))
            .await
            .expect("emit");
        service
            .with_audit_context(ctx_with_ip("198.51.100.4"))
            .emit_audit(AuthEventBuilder::success(AuthEventType::Authenticated))
            .await
            .expect("emit");

        let events = identity.events();
        assert_eq!(events.len(), 2, "both handles wrote to the one store");
        assert_ne!(
            events[0].ip_address, events[1].ip_address,
            "each handle carried its own context"
        );
    }

    /// The request handle reaches the service's own methods, so a handler
    /// needs one handle and not two. Losing this would push handlers back
    /// to holding `state.authn` alongside the derived handle, which is the
    /// shape that wrote the address onto one call and not the other.
    #[tokio::test]
    async fn the_request_handle_derefs_to_the_service() {
        let service = AuthnService::new(MockIdentityStore::new(), MockFactorStore::new());
        let request = service.with_audit_context(AuditContext::default());

        assert!(!request.has_session_registry());
    }
}

#[cfg(test)]
mod audit_shed_tests {
    //! `Shed` exists so a sink can protect its storage without the flow
    //! treating that as a failure. The hazard it answers: every failed
    //! login writes a row, including for identifiers that do not exist,
    //! so an unauthenticated caller can drive writes at the store, and
    //! with no way to shed, exhausting it fails every login for everyone.

    use super::AuthnService;
    use crate::authn::event::{AuditContext, AuthEventBuilder, AuthEventType};
    use crate::authn::store::AuditOutcome;
    use crate::testing::{MockFactorStore, MockIdentityStore};

    /// A shed event does not fail the flow. An outage does. This is the
    /// whole distinction, and the reason `Result<(), E>` was not enough.
    #[tokio::test]
    async fn shedding_continues_the_flow_where_an_outage_fails_it() {
        let identity = MockIdentityStore::new();
        let service = AuthnService::new(identity.clone(), MockFactorStore::new())
            .with_audit_context(AuditContext::default());

        identity.arm_record_event_shedding();
        service
            .emit_audit(AuthEventBuilder::success(AuthEventType::Authenticated))
            .await
            .expect("a deliberate drop must not fail the flow");
        assert!(
            identity.events().is_empty(),
            "shed means nothing was stored"
        );

        identity.disarm_record_event_shedding();
        identity.arm_record_event_failure();
        service
            .emit_audit(AuthEventBuilder::success(AuthEventType::Authenticated))
            .await
            .expect_err("an outage must still fail the flow");
    }

    /// The distinction the type exists for: a sink that discards events
    /// must not claim to have recorded them.
    #[tokio::test]
    async fn a_discarding_sink_reports_shed_not_recorded() {
        use crate::authn::store::IdentityAuthnLog;

        let backend = crate::authn::store::NoopAuthnLog(MockIdentityStore::new());
        let outcome = backend
            .record_event(AuthEventBuilder::success(AuthEventType::Authenticated).build())
            .await
            .expect("noop sink never errors");

        assert_eq!(
            outcome,
            AuditOutcome::Shed,
            "a sink that discards must not report Recorded: that claims a \
             write which never happened, which is what made the audit gap \
             invisible in the first place"
        );
    }

    /// A real sink records, and says so.
    #[tokio::test]
    async fn a_writing_sink_reports_recorded() {
        use crate::authn::store::IdentityAuthnLog;

        let identity = MockIdentityStore::new();
        let outcome = identity
            .record_event(AuthEventBuilder::success(AuthEventType::Authenticated).build())
            .await
            .expect("mock sink never errors");

        assert_eq!(outcome, AuditOutcome::Recorded);
        assert_eq!(identity.events().len(), 1, "and actually wrote it");
    }
}