Skip to content

docs: add a compliance / integration-layer responsibilities guide#450

Open
dhensby wants to merge 1 commit into
node-oauth:masterfrom
dhensby:docs/compliance-guide
Open

docs: add a compliance / integration-layer responsibilities guide#450
dhensby wants to merge 1 commit into
node-oauth:masterfrom
dhensby:docs/compliance-guide

Conversation

@dhensby

@dhensby dhensby commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

What

Adds a Compliance & your responsibilities guide (docs/guide/compliance.md), linked from the Guide sidebar.

Closes #79.

Why

#79 asked us to document the RFC MUSTs that can only be satisfied by the HTTP integration layer / deployment, not by this framework-agnostic core (jankapunkt: "We should create a documentation like COMPLIANCE.md for that"). This gives implementers a single conformance checklist instead of having to re-read RFC 6749 §10.

Contents

  • What the library already handles (so the boundary is clear): grant flows, code/token validation + single-use codes, scope + PKCE verification, reading params from query and body, POST + application/x-www-form-urlencoded token endpoint, and RFC-compliant responses (error/error_description, Cache-Control: no-store, WWW-Authenticate).
  • What you must handle, each with the RFC citation: TLS (§1.6/§2.3.1), supporting GET on the authorization endpoint (§3.1), sending the response/redirect, brute-force/rate limiting (§2.3.1), CSRF + state (§10.12), resource-owner authentication, and secure model storage (§3.1.2/§10).
  • A conformance checklist and links to RFC 6749 §10 and RFC 9700.

Docs only — no code change. npm run docs:build passes (no dead links).

Document the RFC 6749/6750 requirements that fall on the integration
(Express/Koa/...) and deployment layers rather than this framework-agnostic
core: TLS, supporting GET on the authorization endpoint, sending the
response/redirect, brute-force/rate limiting, CSRF/state, resource-owner
authentication and secure model storage. Includes a conformance checklist and
a summary of what the library already handles, linked from the guide sidebar.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

RFC-Conformity depends on Implementation

1 participant