-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(remix): Correctly parse X-Forwarded-For
Http header
#7329
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
import { getClientIPAddress } from '../../src/utils/getIpAddress'; | ||
|
||
class Headers { | ||
private headers: Record<string, string> = {}; | ||
|
||
get(key: string): string | null { | ||
return this.headers[key] ?? null; | ||
} | ||
|
||
set(key: string, value: string): void { | ||
this.headers[key] = value; | ||
} | ||
} | ||
|
||
describe('getClientIPAddress', () => { | ||
it.each([ | ||
[ | ||
'2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5,2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5, 141.101.69.35', | ||
'2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5', | ||
Comment on lines
+17
to
+19
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This test failed before the fix, returning |
||
], | ||
[ | ||
'2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5, 2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5, 141.101.69.35', | ||
'2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5', | ||
], | ||
[ | ||
'2a01:cb19:8350:ed00:d0dd:INVALID_IP_ADDR:8be5,141.101.69.35,2a01:cb19:8350:ed00:d0dd:fa5b:de31:8be5', | ||
'141.101.69.35', | ||
], | ||
])('should parse the IP from the X-Forwarded-For header %s', (headerValue, expectedIP) => { | ||
const headers = new Headers(); | ||
headers.set('X-Forwarded-For', headerValue); | ||
|
||
const ip = getClientIPAddress(headers as any); | ||
|
||
expect(ip).toEqual(expectedIP); | ||
}); | ||
}); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super-l: This may be slightly more efficient as:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally good idea (and I definitely didn't think of this initially) but my only concern here is that we're potentially rewriting individual IP addresses in the header value, very potentially making an invalid IP address appear valid:
'2b01:cb19:8350:ed00:d0 dd:fa5b:de31:8be5, 141.101.69.35'
would first be rewritten to'2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5,141.101.69.35'
before it's split, resulting in the function returning2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5
when it would otherwise have returned141.101.69.35
.Of course, that's a super unlikely edge case but I'd rather avoid it. Wdyt?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't both code snippets (so the regex and the trim variants) return the same thing in this scenario? 😅 But maybe I am missing something here :) really it probably doesn't matter at all, so let's just go with what you wrote 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since
trim
only looks at trailing/leading white spaces it'd not touch the whitespace in the middle of the originally invalid IP address. (I double checked this with a test, just to be sure because I was also confused 😅 ).But yeah, I'll go with the original version.