Skip to content

Feature/0.10#5

Merged
KrisSimon merged 5 commits intomainfrom
feature/0.10
Nov 8, 2025
Merged

Feature/0.10#5
KrisSimon merged 5 commits intomainfrom
feature/0.10

Conversation

@KrisSimon
Copy link
Copy Markdown
Contributor

No description provided.

KrisSimon and others added 5 commits October 25, 2025 22:19
Add comprehensive documentation for the /.well-known/openid-configuration
endpoint including:
- Overview of OpenID Connect Discovery
- Benefits (automatic configuration, multi-tenant support, version compatibility)
- Example requests and responses
- Multi-tenant usage patterns
- Integration with OAuth clients like oidc-client-ts

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit adds extensive documentation for the JWKS endpoint and JWT
signing algorithm configuration:

**Updates to oauth/endpoints.md:**
- Added complete `/.well-known/jwks.json` endpoint documentation
- Explained JWKS purpose, use cases, and benefits
- Documented JWKS response structure and field meanings
- Added caching behavior and recommendations
- Provided JWT verification example with jwks-rsa library
- Explained key rotation process and zero-downtime updates
- Documented algorithm selection (HS256 vs RS256)
- Added security recommendations for RS256 adoption

**New file: configuration/jwt_algorithms.md:**
- Comprehensive guide to JWT signing algorithms
- Detailed comparison table: HS256 vs RS256
- When to use each algorithm (use cases and recommendations)
- Zero-downtime migration strategy from HS256 to RS256
  - 8-step migration process with code examples
  - Rollback strategy
  - Monitoring and verification steps
- Key rotation best practices (RS256 only)
- Troubleshooting guide for common migration issues
- Environment variable reference (JWT_ALGORITHM, JWT_SECRET, etc.)
- Links to RFCs and related documentation

The documentation provides clear guidance for:
- Production deployments using RS256
- Migrating existing HS256 deployments
- Understanding JWKS and public key distribution
- Implementing resource server JWT verification

All documentation follows the existing style and includes practical
examples for developers.
@KrisSimon KrisSimon merged commit 1d6a63d into main Nov 8, 2025
@KrisSimon KrisSimon deleted the feature/0.10 branch November 8, 2025 12:50
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