Skip to content

Conversation

miagilepner
Copy link
Collaborator

Description

This PR validates that the client address extracted from the X-Forwarded-For header is a valid IP address

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Feb 28, 2025
@miagilepner miagilepner added this to the 1.20.0-rc milestone Feb 28, 2025
Copy link

github-actions bot commented Feb 28, 2025

CI Results:
All Go tests succeeded! ✅

Copy link
Contributor

@bosouza bosouza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

validation seems in line with other checks in the file

@miagilepner miagilepner marked this pull request as ready for review March 3, 2025 09:40
@miagilepner miagilepner requested a review from a team as a code owner March 3, 2025 09:40
Copy link

github-actions bot commented Mar 3, 2025

Build Results:
All builds succeeded! ✅

Copy link
Contributor

@mcollao-hc mcollao-hc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@miagilepner miagilepner merged commit 49eda90 into main Mar 4, 2025
134 of 135 checks passed
@miagilepner miagilepner deleted the miagilepner/x-forwarded-for-validate branch March 4, 2025 09:40
req := client.NewRequest("GET", "/")
req.Headers = make(http.Header)
req.Headers.Set("x-forwarded-for", "5.6.7.8, 4.5.6.7, 8.8.8.8")
req.Headers.Set("x-forwarded-for", "10.9.8.7, 1.2.3.4, 256.1.1.1")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@miagilepner calling .Set() will replace the contents.
https://pkg.go.dev/net/http#Header.Set

You'd want to use https://pkg.go.dev/net/http#Header.Add if the intention was to test two chains of x-fowarded-for.
The same issue exists in the second testcase you added below.

https://go.dev/play/p/IBGXWmu6S0I

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants