Add JWT RS256 key rotation support#1834
Open
Killerjunior wants to merge 1 commit into
Open
Conversation
|
@Killerjunior Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Linked Issue
Closes #1704
Description
Implemented JWT RS256 key loading from environment variables and added support for key rotation without downtime by allowing verification against multiple public keys.
What changed?
BackEnd/src/common/utils/jwt-keys.tsBackEnd/src/modules/auth/strategies/jwt.strategy.tsBackEnd/src/common/guards/ws-auth.guard.tsBackEnd/src/modules/auth/auth.module.tsBackEnd/src/modules/websocket/websocket.module.tsBackEnd/.env.exampledocs/backend/jwt-key-rotation.mddocs/backend/README.mdWhy was it changed?
How was it implemented?
JWT_PRIVATE_KEY,JWT_PUBLIC_KEY, andJWT_PUBLIC_KEYS.Type of Change
Contract Changelog Discipline
contracts/earn-quest/CHANGELOG.mdunder## [Unreleased]### Breaking Changesentry with impact, affected files, and migration stepstype(scope)!:) in the PR title or commit historyBREAKING CHANGE:explanation belowBREAKING CHANGE details (required for breaking contract changes):
Test Evidence
Unit Tests
npm run test)npm run test:cov)Test output / screenshot:
E2E / Integration Tests
npm run test:e2e)Swagger / API Documentation
@ApiOperation,@ApiResponse, and@ApiBearerAuthdecorators@ApiProperty/@ApiPropertyOptional/api/docsand responses are accurateError Handling Checklist
HTTP Exceptions
NotFoundException,BadRequestException,ForbiddenException,UnauthorizedException,ConflictException, etc.)Errorthrown where an HTTP exception is expectedInput Validation (DTOs)
class-validatordecorators (@IsString,@IsUUID,@IsNotEmpty,@IsOptional, etc.)class-transformerdecorators applied where necessary (@Transform,@Type,@Expose)ValidationPipeis applied globally or at the controller level - raw unvalidated input is never usedGuards & Authorization
@UseGuards(JwtAuthGuard)or equivalent@Public()decorator where applicableLogging
LoggerService)errorlevel with stack tracesLoggerMiddleware- no duplicate logs addedStellar / Soroban Contract Interactions
Database / Migration
npm run typeorm:generate-migration)seed.ts)Breaking Type / Model Changes (Frontend — FE-068)
breaking-types☐breaking-runtime☐added☐changed☐deprecated☐removed☐fixed☐security## [Unreleased]inFrontEnd/my-app/CHANGELOG.mdOR a new file inFrontEnd/my-app/.changeset/.Migration:code block.cd FrontEnd/my-app && npm run changelog:checkpasses locally.changelog-skiplabel or[changelog-skip]to the PR title.Final Pre-Merge Checklist
main/masternpm run lint)npm run format)console.log/ debug statements left in production code.env.exampleupdated if new environment variables were introducedReadMe Backend.mdorReadMe Frontend.mdupdated if setup steps changedAdditional Notes for Reviewer
JWT_PUBLIC_KEYS(comma-separated list).JWT_PUBLIC_KEYSis absent, verification falls back toJWT_PUBLIC_KEY.JWT_PRIVATE_KEY(active key).docs/backend/jwt-key-rotation.md.