feat(rate-limiting,response-ratelimiting) config option: hide/omit rate headers sent to client #2087
Conversation
This file contains 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
|
For the new config item, omit_client_headers or another name would be fine too: I'm open to suggestions. |
jdmonin
changed the title
|
lgtm let's wait for 0.10 release first before merging |
Tieske
added
pr/ready (but hold merge)
|
Great, thank you for taking a look! |
|
@jdmonin can you rebase this PR against |
p0pr0ck5
added
pr/changes requested
jdmonin
force-pushed
the
feature/rate-limiting-hide-headers
branch
from
ac66f4b to
7ea8229
Compare
|
@p0pr0ck5 Thanks for your patience! Rebased and tested. |
p0pr0ck5
reviewed
Apr 12, 2017
| if not conf.hide_client_headers then | ||
| ngx.header[RATELIMIT_LIMIT.."-"..limit_name.."-"..period_name] = lv.limit | ||
| ngx.header[RATELIMIT_REMAINING.."-"..limit_name.."-"..period_name] = math_max(0, lv.remaining - (increments[limit_name] and increments[limit_name] or 0)) -- increment_value for this current request | ||
| end | ||
|
|
||
| if increments[limit_name] and increments[limit_name] > 0 and lv.remaining <= 0 then | ||
| stop = true -- No more |
There was a problem hiding this comment.
One thought here: should exit early out of this loop (via break) if we are omitting headers, and we've reached this condition? Once we've assigned stop = true, we're not doing any other work aside from assigning headers, so breakingnoit early would save some work. Don't know if this is worth it though, so this isn't a blocker to me, just a thought.
p0pr0ck5
added
pr/status/please review
and removed
pr/changes requested
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.
Summary
Add a config option to the rate-limiting and response-ratelimiting plugins to not send the rate-related headers (limit and remaining) normally sent to the client. For publicly exposed APIs, this can be useful for security.
Full changelog