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

Fix PortsForwarder.Expose() proxy check #441

Merged
merged 3 commits into from
Jan 14, 2025

Conversation

cpick
Copy link

@cpick cpick commented Dec 21, 2024

The check for existing proxies entries used local as a key, but they're actually inserted using keys of: key(protocol, local).

This meant that, previously, the check was ineffective and wouldn't reject duplicate forwards.

Copy link
Collaborator

@cfergeau cfergeau left a comment

Choose a reason for hiding this comment

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

Ouch, good catch.
I'd add this on top of this commit to let the compiler catch such bugs in the future:

diff --git a/pkg/services/forwarder/ports.go b/pkg/services/forwarder/ports.go
index 6b92a005..a1de5401 100644
--- a/pkg/services/forwarder/ports.go
+++ b/pkg/services/forwarder/ports.go
@@ -25,11 +25,13 @@ import (
 	"gvisor.dev/gvisor/pkg/tcpip/stack"
 )
 
+type ProxyKey string
+
 type PortsForwarder struct {
 	stack *stack.Stack
 
 	proxiesLock sync.Mutex
-	proxies     map[string]proxy
+	proxies     map[ProxyKey]proxy
 }
 
 type proxy struct {
@@ -61,7 +63,7 @@ func (w CloseWrapper) Close() error {
 func NewPortsForwarder(s *stack.Stack) *PortsForwarder {
 	return &PortsForwarder{
 		stack:   s,
-		proxies: make(map[string]proxy),
+		proxies: make(map[ProxyKey]proxy),
 	}
 }
 
@@ -256,8 +258,8 @@ func (f *PortsForwarder) Expose(protocol types.TransportProtocol, local, remote
 	return nil
 }
 
-func key(protocol types.TransportProtocol, local string) string {
-	return fmt.Sprintf("%s/%s", protocol, local)
+func key(protocol types.TransportProtocol, local string) ProxyKey {
+	return ProxyKey(fmt.Sprintf("%s/%s", protocol, local))
 }
 
 func (f *PortsForwarder) Unexpose(protocol types.TransportProtocol, local string) error {

@cfergeau
Copy link
Collaborator

cfergeau commented Jan 8, 2025

I've added the suggested change as a new commit, rebased to get a fix for CI failures, and force-pushed this to your branch.

@cfergeau
Copy link
Collaborator

cfergeau commented Jan 8, 2025

This break the port forwarding test:

port forwarding
/home/runner/work/gvisor-tap-vsock/gvisor-tap-vsock/test/port_forwarding_test.go:23
  should expose and reach rootless podman API using unix to unix forwarding over ssh [It]
  /home/runner/work/gvisor-tap-vsock/gvisor-tap-vsock/test/port_forwarding_test.go:231

it's reproducible locally with only your commit on top of git main, so this is not related to the github environment. The main branch is green: https://github.com/containers/gvisor-tap-vsock/actions/runs/12671768387/job/35314238072

@vyasgun
Copy link
Member

vyasgun commented Jan 9, 2025

The test is failing because unix/local is being exposed in an earlier test and not being unexposed. This should fix it:

diff --git a/test/port_forwarding_test.go b/test/port_forwarding_test.go
index 2e32e8f1..8e031934 100644
--- a/test/port_forwarding_test.go
+++ b/test/port_forwarding_test.go
@@ -226,6 +226,9 @@ var _ = ginkgo.Describe("port forwarding", func() {
                        g.Expect(err).ShouldNot(gomega.HaveOccurred())
                        g.Expect(resp.StatusCode).To(gomega.Equal(http.StatusOK))
                }).Should(gomega.Succeed())
+
+               out, err = sshExec(`curl http://gateway.containers.internal/services/forwarder/unexpose -X POST -d'{"protocol":"unix","local":"` + unix2tcpfwdsock + `","remote":"tcp://192.168.127.2:8080"}'`)
+               gomega.Expect(err).ShouldNot(gomega.HaveOccurred())
        })
 
        ginkgo.It("should expose and reach rootless podman API using unix to unix forwarding over ssh", func() {

@cfergeau
Copy link
Collaborator

cfergeau commented Jan 9, 2025

The test is failing because unix/local is being exposed in an earlier test and not being unexposed. This should fix it:

diff --git a/test/port_forwarding_test.go b/test/port_forwarding_test.go
index 2e32e8f1..8e031934 100644
--- a/test/port_forwarding_test.go
+++ b/test/port_forwarding_test.go
@@ -226,6 +226,9 @@ var _ = ginkgo.Describe("port forwarding", func() {
                        g.Expect(err).ShouldNot(gomega.HaveOccurred())
                        g.Expect(resp.StatusCode).To(gomega.Equal(http.StatusOK))
                }).Should(gomega.Succeed())
+
+               out, err = sshExec(`curl http://gateway.containers.internal/services/forwarder/unexpose -X POST -d'{"protocol":"unix","local":"` + unix2tcpfwdsock + `","remote":"tcp://192.168.127.2:8080"}'`)
+               gomega.Expect(err).ShouldNot(gomega.HaveOccurred())
        })
 
        ginkgo.It("should expose and reach rootless podman API using unix to unix forwarding over ssh", func() {

Ah tests are not independent from each other :-/
Can you add a commit fixing this to this fix-proxy-check branch?

@vyasgun
Copy link
Member

vyasgun commented Jan 10, 2025

@cfergeau I don't have the permission to do so :/

Chris Pick and others added 3 commits January 10, 2025 15:13
The check for existing `proxies` entries used `local` as a key, but
they're actually inserted using keys of: `key(protocol, local)`.

This meant that, previously, the check was ineffective and wouldn't
reject duplicate forwards.

Signed-off-by: Chris Pick <[email protected]>
This allows the go compiler to catch the bug fixed in the previous
commit:
```
GOARCH=amd64 GOOS=freebsd  go build -ldflags "-s -w -X github.com/containers/gvisor-tap-vsock/pkg/types.gitVersion=v0.8.1-5-g9df1d587" -o bin/gvproxy-freebsd-amd64 ./cmd/gvproxy
 # github.com/containers/gvisor-tap-vsock/pkg/services/forwarder
pkg/services/forwarder/ports.go:73:24: cannot use local (variable of type string) as ProxyKey value in map index
make: *** [Makefile:57: cross] Error 1
```

Signed-off-by: Christophe Fergeau <[email protected]>
…gain

This also fixes a pre-existing issue with this test file, an exposed
port was not unexposed before attempting to expose it again, which
caused a test failure after the PortsForwarder.Expose() fix.

Signed-off-by: Gunjan Vyas <[email protected]>
@cfergeau
Copy link
Collaborator

CI is green now. I'll merge this next week if you don't have objections to these follow-ups commits @cpick

@cfergeau
Copy link
Collaborator

/lgtm
/approve

Copy link
Contributor

openshift-ci bot commented Jan 14, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cfergeau, cpick

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

The pull request process is described 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

@openshift-merge-bot openshift-merge-bot bot merged commit 5086dbc into containers:main Jan 14, 2025
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants