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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

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
Contributor

openshift-ci bot commented Dec 21, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: cpick
Once this PR has been reviewed and has the lgtm label, please assign baude for approval. For more information see the 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

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 {

Chris Pick and others added 2 commits January 8, 2025 12:24
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]>
@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants