Repository navigation
feat(auth): enforce capability scopes per route and key minting (#504) - #572
Open
sparkysolutions10-pixel wants to merge 1 commit into
Open
sparkysolutions10-pixel wants to merge 1 commit into
sparkysolutions10-pixel wants to merge 1 commit 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
Fixes #504.
Summary of Changes
ApiKeyContextpreviously granted unrestricted access to every non-public route for every authenticated key, preventing least-privilege scoping for partners or specialized integrations.This PR implements coarse capability scopes in accordance with all acceptance criteria:
scopes String[] @default([])toApiKeymodel inprisma/schema.prisma.POST /admin/keysaccepts and validatesscopes?: string[].scopesin the key issuance response.{ config: { scope: 'read:prices' } }).apiKeyAuthPluginverifies the caller's key against the required scope.*), requests are rejected with HTTP 403code: 'insufficient_scope'explicitly naming the required scope.scopes: []) continue to have unrestricted access to all endpoints, ensuring existing integrations never break on deploy.src/__tests__/keyScopes.test.tstesting scoped key issuance, successful scoped route access, 403 insufficient scope rejection naming the missing capability, and full backward compatibility for legacy unscoped keys.Testing
npx vitest run src/__tests__/keyScopes.test.ts(4/4 passed)npx vitest run src/__tests__/auth.test.ts(22/22 passed)npx vitest run tests/openapi.test.ts(8/8 passed)