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.

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

TCP Proxy: Fix TLS passthrough for fragmented ClientHello. #11843

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

maxl99
Copy link

@maxl99 maxl99 commented Aug 21, 2024

What this PR does / why we need it:

We need to read the entire length of the ClientHello packet in order to get the SNI field for proper tls passthrough.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • CVE Report (Scanner found CVE and adding report)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation only

Which issue/s this PR fixes

fixes #11491
fixes #11424

How Has This Been Tested?

Tested with tldr_fail_test.py (modified to use tls1.2)
Without the patch:
image
With the patch, passthrough also works for a fragmented ClientHello.

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added unit and/or e2e tests to cover my changes.
  • All new and existing tests passed.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 21, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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 kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Aug 21, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @maxl99!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority labels Aug 21, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @maxl99. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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 kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 21, 2024
Copy link

netlify bot commented Aug 21, 2024

Deploy Preview for kubernetes-ingress-nginx canceled.

Name Link
🔨 Latest commit b7ed9ba
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/6710e774134d5c0008b729f7

@maxl99 maxl99 force-pushed the fix/tls-passthrough branch 2 times, most recently from a989d48 to 9a0ea21 Compare August 25, 2024 18:24
Copy link
Member

@kvaps kvaps left a comment

Choose a reason for hiding this comment

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

LGTM, tested this, works perfectly

kvaps added a commit to aenix-io/cozystack that referenced this pull request Sep 27, 2024
Fixed nginx-ingress image to include this patch:
- kubernetes/ingress-nginx#11843

Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
@tao12345666333
Copy link
Member

/ok-to-test

I will run the test suite first.

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 12, 2024
@tao12345666333 tao12345666333 self-assigned this Oct 12, 2024
@Gacko
Copy link
Member

Gacko commented Oct 12, 2024

/kind bug
/priority backlog
/hold

If this is a bug, could you please also add some tests to prevent future regression?

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/bug Categorizes issue or PR as related to a bug. priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority labels Oct 12, 2024
pkg/tcpproxy/tcp.go Outdated Show resolved Hide resolved
pkg/tcpproxy/tcp.go Outdated Show resolved Hide resolved
@Gacko Gacko changed the title fix: tls-passthrough if ClientHello is fragmented TCP Proxy: Fix TLS passthrough for fragmented ClientHello. Oct 12, 2024
We need to read the entire length of the ClientHello packet in order
to get the SNI field for proper tls passthrough.
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: kvaps, maxl99
Once this PR has been reviewed and has the lgtm label, please ask for approval from tao12345666333. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@maxl99
Copy link
Author

maxl99 commented Oct 17, 2024

/kind bug /priority backlog /hold

If this is a bug, could you please also add some tests to prevent future regression?

I tried to implement an e2e test that sends a ClientHello with 2 packets (similar to the behaviour we see in the packet capture).
Sadly it seems to be a bit tricky because the test is also successful without the patch :(
I'm using net.Dial and Write. I also tried casting it to an net.TCPConn and setting things like SetWriteBuffer(0) and SetNoDelay(true).

@longwuyuan
Copy link
Contributor

ssl-passthrough is targeted for deprecation.

I understand this is disruptive. But there is demand for real-client-ip and now this fragmented client-helo. Its also very clear that 2 PRs are in queue for addressing this.

But please consider that the requirement now is 2 folds. On one hand a developer of the project needs to evaluate not just the PRs here but also the impact of those changes on the design, security & stability of the controller.. Secondly the continued support/maintenance to sustain the TLS-Passthrough feature in its current go-proxy avatar, requires resources.

The project hit CVEs and and other sustaining related problems and faced acute shortage of resources for a extended length of time. So to avoid future impact to the security/stability of the controller, a decision was made to focus on the core functionality of the project. We are even deprecating several functioning useful popular features. Implementing the Gateway-API is the other focus besides shipping a secure-by-default controller.

Hence wait for other comments, but I would say not to expect much traction on this as the TLS-Passthrough feature itself may be deprecated sooner than later. I understand its the least desired scene but its the reality of changing times.

Users do obviously have the option to fork the project and implement desired changes there. regards.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/bug Categorizes issue or PR as related to a bug. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/backlog Higher priority than priority/awaiting-more-evidence. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
6 participants