standard_id 0.36.0 → 0.36.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dd8850abb672f638f6db5cf4d60ae8ec64b26bdb8d5835405c72e7bebc4d800
-  data.tar.gz: 69575f6669362c905ed16059f35f15044f1ee2bbade449b6dc5c62bfd93caeb5
+  metadata.gz: 5519e19cd0f121d012683a24a10d0052ce4bf33e508ede831712db3851abace9
+  data.tar.gz: 9786b159f6ad07238cb7e636f3cfd5e028ec31cb6014f38e0349de3760f0deaf
 SHA512:
-  metadata.gz: 87ed7e67e16666c2c576a2e7bb55e43ff2a861ecf93c824d5995da4d8f383d09f4bb60e8b389e9821e2d85acfb849690548cc0e6fbfabaa3e73d0f02dd44015c
-  data.tar.gz: 9036f22d16ee08ac97a4e5d6ae46d8c6fc7c63130da4ed66a815dfef2b21ecce787f576cc2127dbd6040405e6a6dbd2f4f71c5303d1c6e803770347af6d85b9f
+  metadata.gz: b18d51d0fc882c6aaf4c9a6482e58600bf82594860715c1b6f5850dd0175834f72dc5735dbb23b2e1f45fbc4ceb8f975dffdc2484a3ee1871b882e89d76c4df6
+  data.tar.gz: 7039cfdf1894c351a3802b893e31a2ff23754acd0a861116b190ca5875540a7ba45d35589cefef79ad1a65444feca3eb999740285bc5af0bd073139d41fdedbc

data/CHANGELOG.md

@@ -7,6 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.36.1] - 2026-08-04
+
+**A follow-up to 0.36.0's own regression, released the same day.** 0.36.0 is correct and stays — read its entry first for why `SESSION_VALIDATING` had to start carrying `account:`. This release repairs the fallout of that fix on the gem's own API routes. Two releases land together because the second is only reachable *because* of the first.
+
+### Fixed
+
+- **`StandardId::Api::BaseController` now answers `401` — not `500` — when the authenticated account is deactivated or locked.** 0.36.0 made `AccountStatus` / `AccountLocking` fire on a live authenticated request for the first time, which is the intended behaviour. But `AccountDeactivatedError` and `AccountLockedError` are bare `StandardError` subclasses, under neither `InvalidSessionError` nor `OAuthError`, and the API base controller rescued only those three families. So the very change that started refusing a disabled account's bearer token turned every route under `ApiEngine` — `/api/v1/sessions`, `/api/v1/userinfo`, all of it — into an unhandled exception for that account. Every consumer mounting `ApiEngine` inherited it. Before 0.36.0 the guard was inert on that path, so the hole existed but was unreachable; the release is what exposed it.
+
+  Observed independently in two consumers during the 0.36.0 rollout: `luminality-web`, which has an app-side handler on `Api::ErrorHandling` and so saw only the *gem-owned* routes fail, and `sidekick-web`, which has none and saw its whole API tree fail.
+
+  A 500 is not a refusal. It carries no `WWW-Authenticate`, tells the client nothing about discarding a token that will never work again, and pages the on-call for a routine account state. Both errors now render the established bearer shape — `401`, `{ "error": "invalid_token", "error_description": … }`, plus the matching `WWW-Authenticate` challenge — via the same `render_bearer_unauthorized!` the other credential failures use. No new response shape was invented.
+
+  **Why `invalid_token`.** RFC 6750 §3.1 defines exactly three codes. `invalid_token` covers a token "expired, revoked, malformed, or **invalid for other reasons**", and a token whose subject account has been disabled is invalid for one of those other reasons; it also carries the right client instruction — discard the token and re-authenticate — which is precisely correct here, since no retry with this token can ever succeed. `insufficient_scope` (403) would be wrong twice over: nothing about this is a scope failure, and 403 invites a client to keep the token and retry. `invalid_request` (400) would be wrong because the request is perfectly well-formed.
+
+  `AccountLockedError#lock_reason` is **not** surfaced. It is operator-authored text meant for logs and admin screens, and `WWW-Authenticate` is a quoted string that arbitrary text would break as well as leak. A spec pins that the reason appears in neither the body nor the header.
+
+### Unchanged, deliberately — two decisions worth knowing about
+
+- **The `WebEngine`'s own routes (`/sessions`, `/account`, `/logout`) get no gem-side handler, and this is not an oversight.** `StandardId::Web::BaseController` descends from the **host's** `ApplicationController`, so the `rescue_from StandardId::AccountDeactivatedError` the README has always told hosts to write already covers those routes. A gem handler there would not add safety, it would remove it: Rails scans `rescue_handlers` most-recently-registered-first, and a subclass registers after its parent, so anything the gem registered on `Web::BaseController` would outrank and silently override the host's — replacing a host's "your account has been deactivated" page with whatever the gem chose. `Api::BaseController` has no such escape hatch; descending from `ActionController::API`, there is nowhere in its ancestry for a host to put a handler, which is exactly why only that side is rescued in the gem.
+
+  **Hosts must therefore still carry their own `ApplicationController` handler for these two errors.** If you do not have one, a deactivated or locked account hitting a web route — yours or the engine's — is an unhandled exception. That was true before 0.36.0 for the sign-in path and remains true; 0.36.0 simply widened the set of requests that can reach it from "sign-in and token mint" to "any authenticated request". The README's account sections now spell out which routes the engine answers for and which it does not.
+
+- **`AccountDeactivatedError` / `AccountLockedError` still descend from `StandardError`, not from `InvalidSessionError`.** Reparenting them was considered as the broader fix — it would make every consumer's existing `rescue_from StandardId::InvalidSessionError` catch them automatically, with no consumer change at all — and rejected on two grounds. First, they mean something genuinely different: an `InvalidSessionError` says the credential is no good and the remedy is to sign in again, while these say the credential is fine and the account is disabled, where signing in again will not help and the user needs to be told so. Consumers who deliberately distinguish the two would lose that distinction silently. Second, and decisively, it would hijack handlers hosts have already written: `Web::BaseController` registers `rescue_from NotAuthenticatedError, InvalidSessionError, with: :redirect_unauthenticated_to_login`, so under the reparented hierarchy a host's `rescue_from AccountDeactivatedError` — registered *earlier*, on the parent — would lose to the gem's subclass registration, and every consumer following the README would start bouncing disabled users to `/login` instead of to their account-disabled page. A patch release that quietly re-routes a documented UX is not a patch. The narrow fix leaves both hierarchies and both sets of host handlers exactly as they were.
+
+### Testing
+
+`spec/requests/standard_id/live_session_account_guard_spec.rb` gains three API examples (401 shape for deactivated, 401 shape for locked, and `lock_reason` non-disclosure) and two web examples pinning the delegate-to-host design above. Proven by negative control: with the two `rescue_from` lines deleted from `Api::BaseController`, the three API examples fail with the raw error escaping the request; restored, the file is 14/14 and the suite 2097/2097.
+
+Relates to rarebit-one/rarebit-ops#306.
+
 ## [0.36.0] - 2026-08-04
 
 ### Security

data/README.md

@@ -784,7 +784,14 @@ User.inactive   # => Users with status 'inactive'
 
 ### Handling AccountDeactivatedError
 
-When an inactive account attempts to authenticate, `StandardId::AccountDeactivatedError` is raised. You need to handle this error in your application controller:
+When an inactive account attempts to authenticate — at sign-in, at token mint, and (since 0.36.0) on every request made with an already-issued credential — `StandardId::AccountDeactivatedError` is raised. You need to handle this error in your application controller:
+
+> **What the engine's own routes do.** You are responsible for **your** controllers only. The engine handles its own:
+>
+> - **`ApiEngine` routes** (`/api/v1/sessions`, `/api/v1/userinfo`, …) answer **`401` with `error: "invalid_token"`** per RFC 6750 — `StandardId::Api::BaseController` descends from `ActionController::API`, so your `rescue_from` is not in its ancestry and could never have covered it.
+> - **`WebEngine` routes** (`/sessions`, `/account`, `/logout`) are covered by the `rescue_from` you write on `ApplicationController` below, because `StandardId::Web::BaseController` descends from it. The engine deliberately registers no handler of its own there — one would take precedence over yours and override your UX.
+>
+> So: write the `ApplicationController` handler (it covers your pages *and* the web engine's), and write the `Api::BaseController` handler only for **your own** API controllers.
 
 ```ruby
 # app/controllers/application_controller.rb
@@ -900,7 +907,7 @@ User.unlocked.active  # => Users who can log in
 
 ### Handling AccountLockedError
 
-When a locked account attempts to authenticate, `StandardId::AccountLockedError` is raised. The error includes metadata about the lock:
+When a locked account attempts to authenticate, `StandardId::AccountLockedError` is raised. The error includes metadata about the lock. The same engine-owned-route rules described under [Handling AccountDeactivatedError](#handling-accountdeactivatederror) apply: `ApiEngine` routes answer `401 invalid_token` themselves (never echoing `lock_reason`), `WebEngine` routes defer to your `ApplicationController` handler.
 
 ```ruby
 # app/controllers/application_controller.rb

data/app/controllers/standard_id/api/base_controller.rb

@@ -16,6 +16,16 @@ module StandardId
       rescue_from StandardId::InvalidSessionError, with: :handle_invalid_session
       rescue_from StandardId::OAuthError, with: :handle_oauth_error
 
+      # AccountStatus / AccountLocking raise these from the SESSION_VALIDATING
+      # subscriber, i.e. mid-request on an ALREADY authenticated call, not just
+      # at sign-in or token mint. Unrescued they are a 500 on every gem-owned
+      # API route. Unlike Web::BaseController — which descends from the host's
+      # ApplicationController, so a host `rescue_from` covers it — this class
+      # descends from ActionController::API, so the host has nowhere to put a
+      # handler in the ancestry and the gem must answer for itself.
+      rescue_from StandardId::AccountDeactivatedError, with: :handle_account_deactivated
+      rescue_from StandardId::AccountLockedError, with: :handle_account_locked
+
       protected
 
       def validate_content_type!
@@ -43,6 +53,27 @@ module StandardId
         render_bearer_unauthorized!(error_description: default_invalid_token_message)
       end
 
+      # RFC 6750 §3.1 offers exactly three error codes, and `invalid_token` is
+      # the right one: it covers a token "expired, revoked, malformed, or
+      # invalid for other reasons", and a bearer token whose subject account has
+      # been disabled is invalid for one of those other reasons. It also carries
+      # the correct client instruction — discard the token and re-authenticate —
+      # which is what we want, since no retry with this token will ever succeed.
+      # `insufficient_scope` (403) would be wrong: nothing here is about scope,
+      # and a 403 invites the client to keep the token and retry. `invalid_request`
+      # (400) would be wrong: the request is well-formed.
+      def handle_account_deactivated(_error)
+        render_bearer_unauthorized!(error_description: "The account is deactivated")
+      end
+
+      # Deliberately does NOT surface `error.lock_reason`. It is operator-authored
+      # text intended for logs and admin screens (see StandardId::AccountLockedError),
+      # and the WWW-Authenticate header this renders into is a quoted string that
+      # arbitrary text would break as well as leak.
+      def handle_account_locked(_error)
+        render_bearer_unauthorized!(error_description: "The account is locked")
+      end
+
       def handle_oauth_error(error)
         render json: {
           error: error.oauth_error_code,

data/lib/standard_id/errors.rb

@@ -7,6 +7,31 @@ module StandardId
   class RevokedSessionError < InvalidSessionError; end
 
   # Account errors
+  #
+  # These deliberately do NOT descend from InvalidSessionError, even though
+  # doing so would make every host's existing `rescue_from InvalidSessionError`
+  # catch them for free. Two reasons:
+  #
+  #   1. They mean something different. An InvalidSessionError says the
+  #      credential is no good — expired, revoked — and the remedy is to sign in
+  #      again. These say the credential is fine and the ACCOUNT is disabled;
+  #      signing in again will not help, and the user needs to be told so.
+  #      Hosts document that distinction in their UX (see the README's
+  #      "Handling AccountDeactivatedError" / "Handling AccountLockedError").
+  #   2. Reparenting them would silently HIJACK the handlers hosts already
+  #      wrote. Web::BaseController registers
+  #      `rescue_from NotAuthenticatedError, InvalidSessionError, with:
+  #      :redirect_unauthenticated_to_login`, and Rails resolves rescue_from
+  #      handlers most-recently-registered-first — a subclass's registration
+  #      wins over its parent's. A host's `rescue_from AccountDeactivatedError`
+  #      on ApplicationController is registered EARLIER than the gem's
+  #      subclass registration, so as a subclass of InvalidSessionError these
+  #      would start bouncing to /login instead of reaching the host's
+  #      account-deactivated page. That is a behaviour regression for every
+  #      consumer who followed the README.
+  #
+  # Consequently every entry point that must not raise has to rescue these
+  # explicitly; StandardId::Api::BaseController does.
   class AccountDeactivatedError < StandardError; end
 
   class AccountLockedError < StandardError

data/lib/standard_id/version.rb

@@ -1,3 +1,3 @@
 module StandardId
-  VERSION = "0.36.0"
+  VERSION = "0.36.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standard_id
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.36.1
 platform: ruby
 authors:
 - Jaryl Sim