Add a new get_ip_address_from_request method
#19006
Draft
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
This method raises a `SynapseException` if Synapse is unable to extract the IP address of a client from an incoming request. This typically indicates that there is an invalid configuration in one's reverse proxy. Raise an exception rather than returning a dummy IP address, as it's typically better to fail loudly in this case.
anoadragon453
force-pushed
the
anoa/raise_exception_on_ip_address_failure
branch
from
7c36a84 to
50b74ba
Compare
anoadragon453
commented
Oct 1, 2025
Comment on lines
+317
to
+318
| "Unable to view IP address of the requester. " \ | ||
| "Check that you are setting the X-Forwarded-For header correctly in your reverse proxy." |
There was a problem hiding this comment.
This was the fix in #18940, though I don't know whether there are any other potential causes that a Twisted wouldn't be able to get an IP address for the client?
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.
This method raises a
SynapseExceptionif Synapse is unable to extract the IP address of a client from an incoming request. This typically indicates that there is an invalid configuration in one's reverse proxy.I chose to raise an exception, rather than returning a dummy IP address, as it's typically better to fail loudly.
Closes #18940, which noted that Synapse doesn't return a particularly useful error in one of the cases.