Add option for the logging middleware to log real IP #2002
Merged
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
github-actions
bot
added
the
needs triage
azazeal
approved these changes
Sep 18, 2024
This commit adds the option (enabled via environment variable) to the logging middleware to log real/originating IP address of a client based on specific headers. Three headers are supported: True-Client-IP, X-Real-IP, X-Forwarded-For. This is particularly useful when there is proxy server(s) sitting between step-ca and client. Implements smallstep#1995
azazeal
force-pushed
the
leonweecs/log-real-ip
branch
from
6845daa
to
0329aa3
Compare
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.
Implements #1995
Name of feature:
Pain or issue this feature alleviates:
Please refer to #1995.
Why is this important to the project (if not answered above):
N/A
Is there documentation on how to use this feature? If so, where?
N/A
In what environments or workflows is this feature supported?
When step-ca is sitting behind a reverse proxy, e.g. AWS ALB, Cloudflare and so on.
In what environments or workflows is this feature explicitly NOT supported (if any)?
N/A
It is worth noting that this feature is best not to be turned on when you can't trust the headers used, see here for more info,
Supporting links/other PRs/issues:
realIPfunction is mostly borrowed from chi's realip middleware.💔Thank you!