[codex] Derive trusted rate limit keys#230
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 #48
Summary
TRUST_PROXYparsing and wired Expresstrust proxybefore request middleware runs.true,yes,on, and1map to one trusted proxy hop, while positive integers configure explicit hop counts.X-API-Keyfirst, using a SHA-256 digest so bucket keys do not store the raw secret.429 rate_limitedresponse andRetry-Afterheader.Threat model
Spoofed
X-Forwarded-Forvalues must not bypass rate limiting whenTRUST_PROXYis unset. Operators should only enableTRUST_PROXYbehind a load balancer or reverse proxy they control, where inbound forwarding headers are stripped or overwritten. Authenticated tenants behind the same NAT should not throttle each other once their API keys are recognized.RED / GREEN evidence
RED before implementation:
npm run build; $env:NODE_ENV='test'; node --test dist/ratelimit-key.test.jsfailed becauseTRUST_PROXY=1still produced429after 60 distinct forwarded IPs.429after the first key filled the IP bucket.GREEN after implementation:
npm run build; $env:NODE_ENV='test'; node --test dist/ratelimit-key.test.jspassed 3 focused tests.Validation
npx prettier --check README.md src/index.ts src/middleware/index.ts src/store/state.ts src/ratelimit-key.test.tsnpm run lintgit diff --checkdist/, thennpm run build$env:NODE_ENV='test'; node --test dist/*.test.js dist/**/*.test.jsResult: full clean test run passed, 92 tests across 11 suites.
Notes
npm testuses POSIX inlineNODE_ENV=test, so on Windows PowerShell I used the equivalent$env:NODE_ENV='test'; node --test ...command after building.