Files
ersatztv/docs/decisions/records/security/iptv-browser-token.md
T
timothy fba5233caf
PR Gates / CI image pin matches docker/ci (pull_request) Successful in 11s
PR Gates / Docs update reminder (pull_request) Successful in 16s
PR Gates / decisions lifecycle (pull_request) Failing after 23s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 1m17s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 1m29s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 8m5s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 16m5s
Build ErsatzTV Image / Functional E2E (curl + UI contracts) (pull_request) Successful in 17m6s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
feat(610): split the decision corpus into one YAML-frontmatter file per record
168 records -> docs/decisions/records/<area>/<topic>.md (163 active, 23 dirs) and
docs/decisions/archive/<area>/<topic>.md (5 archived). The filename IS the key,
so one-active-record-per-key becomes a filesystem property rather than a
validator check, and supersession becomes a `git mv`.

WHY: the monolith was a concurrency problem before an aesthetic one. A
3,900-line append target made parallel sessions collide -- PR #605 and PR #614
both hit append-vs-append conflicts during routine rebases, and hand-resolving
those inside the corpus is exactly the operation the rationale-rewrite guard
exists to police.

HOW IT IS VERIFIED: a ~170-file diff cannot be meaningfully read, so correctness
does not rest on reading it. The parser was taught BOTH formats first, so the
body-diff guard parses the old form at the merge-base and the new form at head --
the migration validates itself, no bypass. The proof is a field-level equivalence
harness: 168 records before and after, zero lost, zero gained, zero field
mismatches, zero rationale bodies differing. Reviewers should scrutinise the
harness; it is the actual evidence.

What measuring caught that reading would not have:

- ~500 lines sit OUTSIDE any record -- decisions.md's lifecycle schema and each
  topic file's preamble, mostly the only copy. Source files are kept and
  stripped, never deleted. They also cannot be filed per-area: topic files hold
  several areas and 4 of 23 areas span several files.
- Archive discovery was a non-recursive glob; after the split it found ZERO
  archived records, surfacing as four bogus "supersedes points to unknown key"
  errors rather than an obvious failure.
- ~32 live docs point into the corpus BY DATE, which the split dangles. Each
  stripped file now ends with a generated "Records formerly in this file" index,
  which also rescues the identical breadcrumbs in old issue comments.
- decisions.md's "In this file:" list was 97 same-file anchor bullets that the
  split makes WRONG, not merely stale. Dropped; the generated index replaces
  them with links that resolve.

The equivalence harness now runs against a checked-in FIXTURE, not the live
corpus. The earlier version migrated the real tree, which made it a one-shot:
the moment the migration landed there was nothing left to move and the tests
failed for reasons unrelated to the code. A fixture keeps them testing the
SCRIPT rather than the repo's current state.

Keys preserved verbatim, warts included: `sched` (12) and `scheduling` (1) remain
two directories for one concept. Renaming a key is not a move -- it changes
identity, breaks the equivalence proof, and invalidates MemPalace's per-key
drawers. Taxonomy normalisation is separate work.

refs #610
2026-07-25 19:45:09 +02:00

5.1 KiB

key, title, status, since, supersedes, superseded-by, rule, signals, mechanics
key title status since supersedes superseded-by rule signals mechanics
security.iptv-browser-token 2026-07-22 — Short-lived browser IPTV token so the SPA reaches `/iptv/*` under JWT auth (#552) active 2026-07-22 none none Under a JWT-enabled deployment (`JWT:IssuerSigningKey` set), the browser SPA obtains a short-lived, globally-scoped `/iptv/*` access token from an authenticated `GET /api/v1/auth/iptv-token` and appends it as `?access_token=`; the endpoint answers 204 when JWT is disabled (nothing to mint). Lifetime defaults to 60 min, configurable via `JWT:BrowserTokenLifetimeMinutes`. channel preview / playback-troubleshooting 401ing under JWT; `/iptv/*` not accepting `ctv-session`; minting a JWT for the browser · paths: `ErsatzTV/JwtHelper.cs`, `ErsatzTV/Controllers/Api/AuthController.cs`, `web/src/media/iptvToken.ts` · issues: #552, #60 `JwtHelper.GenerateBrowserToken()`; `AuthController.IptvToken`; `withIptvToken(url)` (SPA)

/iptv/* is gated by ConditionalIptvAuthorizeFilter only when JWT:IssuerSigningKey is configured, and the "jwt" scheme accepts only a bearer token or ?access_token=not the SPA's ctv-session cookie (a distinct scheme). Nothing minted a JWT for the browser, so under JWT the #60 channel preview was declared Unavailable and the pre-existing playback-troubleshooting screen was latently broken. This closes both with one seam.

  • Endpoint. GET /api/v1/auth/iptv-token on AuthController (already [SkipApiAuthorization] + self-checks the principal, like machine-key). Requires any authenticated session (401 otherwise); returns { token, expiresAt } when JwtHelper.IsEnabled, else 204 No Content/iptv/* is open then, so there is nothing to append and the SPA plays the plain URL. Cache-Control: no-store. Excluded from the OpenAPI document (AuthController is [IgnoreApi], per the #295 F4 ruling — a browser-interactive credential is not something a generated client drives).
  • A GET is correct here despite the "no side-effecting GET under /api" rule (api-conventions.md §9): minting a JWT writes no server state (stateless token, no DB row, no revocation list), so it is not a CSRF-relevant side effect, and same-origin policy already blocks a cross-site page from reading the credentialed response body — identical reasoning to the machine-key GET.
  • Scope: global. The "jwt" scheme validates only signature + lifetime (no audience/channel claims), and the token is minted only to the already-authenticated admin who can reach every channel. Channel-scoping would mean adding claim-based auth to ConditionalIptvAuthorizeFilter and the streaming path — deferred until a non-admin preview audience exists.
  • Lifetime: 60 min default, JWT:BrowserTokenLifetimeMinutes override, clamped to 24h. The token re-validates on every /iptv/* request, so lifetime is the max continuous watch before playback stalls; 60 min comfortably covers an operator verification session, an expired idle session just needs Retry (mints fresh), and a security-conscious operator can tighten it. A non-positive/unparseable value falls back to the default rather than minting an already-expired token; a value above 24h (a seconds-vs-minutes typo would otherwise mint a multi-year bearer token) is clamped down. Revocation is by short lifetime only — a stateless JWT has no per-token revocation; rotating JWT:IssuerSigningKey invalidates all tokens (the existing lever). The SPA's resetIptvTokenCache() (called on the preview panel's Retry and on each troubleshooting Play) makes a user-initiated retry re-mint, so a stale token or a stale "JWT disabled" latch from a since-reconfigured backend can't wedge a recovery attempt.
  • Deferred hardening (broader than #552) — RESOLVED by security.iptv-access-token-transport (#421, #559). The ?access_token= transport itself had pre-existing weaknesses this feature inherited, then bounded by the short lifetime: Serilog's request log included the full query (so a token could reach logs on an /iptv 5xx), and the token-bearing dynamic manifests carried no Cache-Control: no-store. Both predate this feature (Jellyfin and the M3U playlist already pass access_token in /iptv URLs); their fixes were cross-cutting changes to shared request-logging / manifest behavior, tracked as a follow-up and now landed in the record below (which also adds the #421 M3U quote-safety encoding).
  • Only the top-level manifest needs the token. The multi-variant playlist embeds access_token into its variant URL (IptvController.GetMultiVariantPlaylist), and HLS segments are served by UseStaticFiles at RequestPath=/iptv/sessionoutside ConditionalIptvAuthorizeFilter (which is a [ServiceFilter] on IptvController only) — so segment GETs are ungated regardless. The SPA's withIptvToken(url) appends the token to the one manifest URL (a no-op when JWT is off; caches the token in memory until shortly before expiry) and is used by both the channel-preview panel and the playback-troubleshooting screen.