Skip to content

docs: April 2026 security hardening — flags, metrics, migration notes#61

Open
lakhansamani wants to merge 1 commit intomainfrom
docs/security-hardening-2026-04
Open

docs: April 2026 security hardening — flags, metrics, migration notes#61
lakhansamani wants to merge 1 commit intomainfrom
docs/security-hardening-2026-04

Conversation

@lakhansamani
Copy link
Copy Markdown
Contributor

Summary

Documents every operator-visible change introduced by the April 2026 security batch in the main authorizer repo (PRs #582–#590).

What's added

  • New page `docs/core/security.md` — single dedicated reference covering all the hardening: admin auth, refresh-token lifetime, trusted proxies, CORS/CSRF, HTTP timeouts, security response headers (HSTS/CSP/Permissions-Policy), OAuth flow hardening, webhook SSRF protection, OTP and TOTP at-rest, GraphQL query limits, rate-limiter behaviour changes, login error normalization. Includes a TL;DR with the breaking changes at the top and a rolling-deploy note for multi-replica TOTP migration.
  • Updates to `docs/core/server-config.md` to mark `--admin-secret` as required, add `--trusted-proxies`, `--refresh-token-expires-in`, the four `--graphql-max-*` limits, `--enable-hsts`, and `--disable-csp` to their respective sections, plus a new "Security headers" section and a pointer to the security reference page.
  • Updates to `docs/core/metrics-monitoring.md` to register the new `authorizer_graphql_limit_rejections_total` counter with its label values and tuning guidance.
  • Updates to `docs/migration/v1-to-v2.md` with a "Breaking changes — April 2026 security batch" subsection covering `--admin-secret` and `--trusted-proxies` with concrete reverse-proxy topology examples.
  • Sidebar update: `core/security` slotted between `server-config` and `databases`.

Test plan

  • Local docusaurus build (`npm start`) renders the new page without broken links
  • Sidebar shows "Security Hardening" under Core in the right position
  • Cross-links from `server-config.md` and `metrics-monitoring.md` resolve
  • Migration breaking-changes subsection is reachable from the existing v1→v2 ToC

Adds a dedicated docs/core/security.md page covering every CLI flag
and behavioural change introduced by the April 2026 security batch
across the authorizer repo, plus targeted updates to the surrounding
docs so the new flags appear in the right reference sections.

New page (docs/core/security.md):
  - TL;DR with the two breaking changes (--admin-secret required,
    --trusted-proxies default empty)
  - Admin authentication
  - Refresh tokens (new --refresh-token-expires-in flag)
  - Trusted proxies (with topology table covering single host, nginx,
    Cloudflare, AWS ALB, Kubernetes)
  - CORS, CSRF, and origin enforcement
  - HTTP server timeouts and graceful shutdown
  - Security response headers (HSTS, CSP, Permissions-Policy)
  - OAuth flow hardening (response_mode=query rejection, GET /logout
    confirmation page, OIDC RP-initiated logout note)
  - Webhook SSRF protection (DNS rebinding TOCTOU defence)
  - OTP and TOTP at rest, including the rolling-deploy note for
    multi-replica clusters and the JWT key-rotation warning
  - GraphQL hardening (depth/complexity/alias/body-size limits, GET
    transport disabled)
  - Rate limiter behaviour changes (Redis error propagation, window
    math fix)
  - Login error normalization and user-enumeration defences

server-config.md:
  - Mark --admin-secret as required and explain the breaking change
  - Document --trusted-proxies as a top-level core flag
  - Add --refresh-token-expires-in to the JWT section
  - Add the new --graphql-max-* limits to the GraphQL security section
  - Add a new "Security headers" section covering --enable-hsts and
    --disable-csp
  - Add a "Full security reference" pointer to the new security page
  - Renumber the trailing sections accordingly
  - Add a JWT key-rotation warning that ties into TOTP at-rest

metrics-monitoring.md:
  - Register the new authorizer_graphql_limit_rejections_total counter
    with its limit-kind label values and tuning guidance

migration/v1-to-v2.md:
  - New "Breaking changes — April 2026 security batch" subsection at
    the end of section 3, covering --admin-secret and --trusted-proxies
    with concrete examples for the most common reverse-proxy topologies

sidebars.ts:
  - Add core/security to the Core sidebar between server-config and
    databases so it surfaces in the natural reading order
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 7, 2026

Deploy Preview for authorizerdev-docs ready!

Name Link
🔨 Latest commit 52f818c
🔍 Latest deploy log https://app.netlify.com/projects/authorizerdev-docs/deploys/69d49fe4bd216c0008c17ff8
😎 Deploy Preview https://deploy-preview-61--authorizerdev-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant