feat: enforce hashed api key auth#234
Open
pq198363-ops wants to merge 1 commit into
Open
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.
Closes #33.
Summary
REQUIRE_API_KEY=trueenforcement for state-changing routes while leaving GET/HEAD/OPTIONS openADMIN_API_KEYfor privileged writes, includingPOST /api/v1/admin/*and API-key creation/revocationThreat model note
Tenant API keys are returned once at creation and are no longer stored as live secrets in
apiKeyStore.GET /api/v1/api-keysreturns only prefix/label/createdAt. WithREQUIRE_API_KEY=true, normal writes need a tenant key, while admin writes and credential management need the separateADMIN_API_KEYso a tenant key cannot pause/unpause the backend or mint new tenant keys.RED evidence
Before implementation, the focused auth test failed because:
X-API-Keystill allowedPOST /api/v1/usagewith 201 instead of 401apiKeyStorecontained the raw generated keyPOST /api/v1/admin/pauseaccepted unauthenticated requests with 200 instead of 401Verification
npx prettier --check README.md src/auth/apiKeys.ts src/auth/apiKeys.test.ts src/middleware/index.ts src/routes/apiKeys.ts src/store/state.ts src/types.ts src/apikey-recognition.test.ts src/routes/operational.test.tsnpm run lintdist/, thennpm run build$env:NODE_ENV='test'; node --test dist/*.test.js dist/**/*.test.jsgit diff --checkFull clean test result: 94 tests, 11 suites, all passed.