feat: support API key signing-secret rotation with grace window #1184#1386
Open
OluwapelumiElisha wants to merge 2 commits into
Open
feat: support API key signing-secret rotation with grace window #1184#1386OluwapelumiElisha wants to merge 2 commits into
OluwapelumiElisha wants to merge 2 commits into
Conversation
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.
📝 Description #1184
Adds support for rotating API key signing secrets through a new admin-only endpoint without requiring API key reissuance. The implementation introduces a configurable grace window that allows both the previous and newly generated signing secrets to remain valid during transition, preventing integrator downtime. All rotations are recorded in the audit trail for security and compliance purposes.
🎯 Type of Change
🔧 Changes Made
Files Modified
backend/src/models/api-key.tsbackend/src/services/api-key-service.tsbackend/src/controllers/v1/api-keys.tsbackend/src/routes/v1/api-keys.tsbackend/docs/auth.mdbackend/openapi.yamlNew Files Added
backend/src/tests/api-key-rotation.test.tsKey Changes
prev_signing_secret_hashandprev_secret_expires_atfields to API key model.POST /api/v1/admin/api-keys/:id/rotate-signing-secret.🧪 Testing
Test Coverage
🔒 Security Notes
Merge #1184