Skip to content
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.

Sign up for GitHub

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

Jump to bottom

apiutil, middleware: strengthen the robustness of GetIPPortFromHTTPRequest function #6958

Merged
merged 4 commits into from
Aug 15, 2023
Merged

apiutil, middleware: strengthen the robustness of GetIPPortFromHTTPRequest function #6958

merged 4 commits into from
Aug 15, 2023

Conversation

JmPotato
Copy link
Member

@JmPotato JmPotato commented Aug 15, 2023 •
edited
Loading

What problem does this PR solve?

Issue Number: Close #6957.

What is changed and how does it work?

- Improve `GetIPPortFromHTTPRequest` to ensure it could handle different host addresses.
- Make middleware set the forwarded header correctly.

Check List

Tests

  • Unit test
  • Integration test

Release note

Ensure the HTTP middleware set the forwarded header correctly.

@JmPotato JmPotato added the component/api HTTP API. label Aug 15, 2023
@ti-chi-bot
Copy link
Contributor

ti-chi-bot bot commented Aug 15, 2023 •
edited
Loading

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • CabinfeverB
  • rleungx

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot bot added needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. release-note-none Denotes a PR that doesn't merit a release note. needs-cherry-pick-release-7.1 Should cherry pick this PR to release-7.1 branch. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Aug 15, 2023
@JmPotato JmPotato removed needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. needs-cherry-pick-release-7.1 Should cherry pick this PR to release-7.1 branch. labels Aug 15, 2023
@JmPotato
Strengthen the robustness of GetIPPortFromHTTPRequest function
67a2eca 
Signed-off-by: JmPotato <ghzpotato@gmail.com>
@codecov
Copy link

codecov bot commented Aug 15, 2023 •
edited
Loading

Codecov Report

Merging #6958 (58da06a) into master (602c10d) will increase coverage by 0.04%.
The diff coverage is 88.23%.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #6958      +/-   ##
==========================================
+ Coverage   74.35%   74.40%   +0.04%     
==========================================
  Files         427      427              
  Lines       45315    45327      +12     
==========================================
+ Hits        33695    33725      +30     
+ Misses       8654     8639      -15     
+ Partials     2966     2963       -3
Flag Coverage Δ
unittests 74.40% <88.23%> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

rleungx
rleungx reviewed Aug 15, 2023
View reviewed changes
pkg/utils/apiutil/serverapi/middleware.go
r.Header.Add(apiutil.XForwardedForHeader, forwardedIP)
r.Header.Add(apiutil.XForwardedPortHeader, forwardedPort)
} else {
r.Header.Add(apiutil.XForwardedForHeader, r.RemoteAddr)
Copy link
Member

Choose a reason for hiding this comment

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

Do we need else here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Just in case if the remote address is illegal, we can still get it passed down through the middleware.

@ti-chi-bot ti-chi-bot bot added the status/LGT1 Indicates that a PR has LGTM 1. label Aug 15, 2023
@JmPotato
Address the comment
e786dcb 
Signed-off-by: JmPotato <ghzpotato@gmail.com>
@ti-chi-bot ti-chi-bot bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Aug 15, 2023
@JmPotato
Copy link
Member Author

/merge

@ti-chi-bot
Copy link
Contributor

ti-chi-bot bot commented Aug 15, 2023

@JmPotato: It seems you want to merge this PR, I will help you trigger all the tests:

/run-all-tests

You only need to trigger /merge once, and if the CI test fails, you just re-trigger the test that failed and the bot will merge the PR for you after the CI passes.

If you have any questions about the PR merge process, please refer to pr process.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Contributor

ti-chi-bot bot commented Aug 15, 2023

This pull request has been accepted and is ready to merge.

Commit hash: e786dcb

@ti-chi-bot ti-chi-bot bot added status/can-merge Indicates a PR has been approved by a committer. and removed status/can-merge Indicates a PR has been approved by a committer. labels Aug 15, 2023
@JmPotato
Rename the XRealIPHeader
adbc759 
Signed-off-by: JmPotato <ghzpotato@gmail.com>
@JmPotato
Replace more headers with the consts
58da06a 
Signed-off-by: JmPotato <ghzpotato@gmail.com>
@JmPotato
Copy link
Member Author

/merge

@ti-chi-bot
Copy link
Contributor

ti-chi-bot bot commented Aug 15, 2023

@JmPotato: It seems you want to merge this PR, I will help you trigger all the tests:

/run-all-tests

You only need to trigger /merge once, and if the CI test fails, you just re-trigger the test that failed and the bot will merge the PR for you after the CI passes.

If you have any questions about the PR merge process, please refer to pr process.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Contributor

ti-chi-bot bot commented Aug 15, 2023

This pull request has been accepted and is ready to merge.

Commit hash: 58da06a

@ti-chi-bot ti-chi-bot bot added the status/can-merge Indicates a PR has been approved by a committer. label Aug 15, 2023
@ti-chi-bot ti-chi-bot bot merged commit 70e9ffc into tikv:master Aug 15, 2023
23 checks passed
@JmPotato JmPotato deleted the fix_forward_ip branch August 15, 2023 06:31
mittalrishabh pushed a commit to mittalrishabh/pd that referenced this pull request Aug 18, 2023
@JmPotato @mittalrishabh
apiutil, middleware: strengthen the robustness of GetIPPortFromHTTPRe…
c9cc1dc 
…quest function (tikv#6958)

close tikv#6957

- Improve `GetIPPortFromHTTPRequest` to ensure it could handle different host addresses.
- Make middleware set the forwarded header correctly.

Signed-off-by: JmPotato <ghzpotato@gmail.com>
Signed-off-by: rishabh_mittal <mittalrishabh@gmail.com>
@rleungx rleungx mentioned this pull request Aug 21, 2023
Merged
rleungx pushed a commit to rleungx/pd that referenced this pull request Dec 1, 2023
@JmPotato @rleungx
apiutil, middleware: strengthen the robustness of GetIPPortFromHTTPRe…
f7d858e 
…quest function (tikv#6958)

close tikv#6957

- Improve `GetIPPortFromHTTPRequest` to ensure it could handle different host addresses.
- Make middleware set the forwarded header correctly.

Signed-off-by: JmPotato <ghzpotato@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CabinfeverB CabinfeverB CabinfeverB approved these changes

@rleungx rleungx rleungx approved these changes

Assignees
No one assigned
Labels
component/api HTTP API. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Port is not truncated correctly when getting IP from HTTP request
3 participants
@JmPotato @CabinfeverB @rleungx