feat(protonvpn): support up to 5 forwarded ports (#3208)

This commit is contained in:
Quentin McGaw
2026-04-18 02:36:06 +02:00
committed by GitHub
parent 7e7e8182ef
commit d5eeec6fb3
17 changed files with 254 additions and 109 deletions
+2 -1
View File
@@ -164,7 +164,8 @@ ENV VPN_SERVICE_PROVIDER=pia \
VPN_PORT_FORWARDING_PROVIDER= \ VPN_PORT_FORWARDING_PROVIDER= \
VPN_PORT_FORWARDING_UP_COMMAND= \ VPN_PORT_FORWARDING_UP_COMMAND= \
VPN_PORT_FORWARDING_DOWN_COMMAND= \ VPN_PORT_FORWARDING_DOWN_COMMAND= \
VPN_PORT_FORWARDING_LISTENING_PORT=0 \ VPN_PORT_FORWARDING_LISTENING_PORTS=0 \
VPN_PORT_FORWARDING_PORTS_COUNT=1 \
VPN_PORT_FORWARDING_STATUS_FILE="/tmp/gluetun/forwarded_port" \ VPN_PORT_FORWARDING_STATUS_FILE="/tmp/gluetun/forwarded_port" \
# PMTUD # PMTUD
PMTUD_ICMP_ADDRESSES=1.1.1.1,8.8.8.8 \ PMTUD_ICMP_ADDRESSES=1.1.1.1,8.8.8.8 \
+67 -20
View File
@@ -1,8 +1,10 @@
package settings package settings
import ( import (
"errors"
"fmt" "fmt"
"path/filepath" "path/filepath"
"slices"
"github.com/qdm12/gluetun/internal/constants/providers" "github.com/qdm12/gluetun/internal/constants/providers"
"github.com/qdm12/gosettings" "github.com/qdm12/gosettings"
@@ -37,16 +39,28 @@ type PortForwarding struct {
// It can be the empty string to indicate to NOT run a command. // It can be the empty string to indicate to NOT run a command.
// It cannot be nil in the internal state. // It cannot be nil in the internal state.
DownCommand *string `json:"down_command"` DownCommand *string `json:"down_command"`
// ListeningPort is the port traffic would be redirected to from the // ListeningPorts are the ports traffic would be redirected to from the
// forwarded port. The redirection is disabled if it is set to 0, which // forwarded ports. The redirection is disabled if it is the slice [0],
// is its default as well. // which is its default as well. If set and not [0], its length must match
ListeningPort *uint16 `json:"listening_port"` // the PortsCount value, such that each forwarded port is redirected to
// the corresponding listening port.
ListeningPorts []uint16 `json:"listening_port"`
// PortsCount is the number of ports to forward. It is optional for ProtonVPN
// and be between 1 and 5. For other providers, it must be set to 1 if port
// forwarding is enabled.
PortsCount uint16 `json:"ports_count"`
// Username is only used for Private Internet Access port forwarding. // Username is only used for Private Internet Access port forwarding.
Username string `json:"username"` Username string `json:"username"`
// Password is only used for Private Internet Access port forwarding. // Password is only used for Private Internet Access port forwarding.
Password string `json:"password"` Password string `json:"password"`
} }
var (
ErrPortsCountTooHigh = errors.New("ports count too high")
ErrListeningPortsLen = errors.New("listening ports length must be equal to ports count")
ErrListeningPortZero = errors.New("listening port cannot be 0")
)
func (p PortForwarding) Validate(vpnProvider string) (err error) { func (p PortForwarding) Validate(vpnProvider string) (err error) {
if !*p.Enabled { if !*p.Enabled {
return nil return nil
@@ -75,13 +89,36 @@ func (p PortForwarding) Validate(vpnProvider string) (err error) {
} }
} }
if providerSelected == providers.PrivateInternetAccess { switch providerSelected {
case providers.PrivateInternetAccess:
const maxPortsCount = 1
switch { switch {
case p.PortsCount > maxPortsCount:
return fmt.Errorf("%w: %d > %d", ErrPortsCountTooHigh, p.PortsCount, maxPortsCount)
case p.Username == "": case p.Username == "":
return fmt.Errorf("%w", ErrPortForwardingUserEmpty) return fmt.Errorf("%w", ErrPortForwardingUserEmpty)
case p.Password == "": case p.Password == "":
return fmt.Errorf("%w", ErrPortForwardingPasswordEmpty) return fmt.Errorf("%w", ErrPortForwardingPasswordEmpty)
} }
case providers.Protonvpn:
const maxPortsCount = 4
if p.PortsCount > maxPortsCount {
return fmt.Errorf("%w: %d > %d", ErrPortsCountTooHigh, p.PortsCount, maxPortsCount)
}
default:
const maxPortsCount = 1
if p.PortsCount > maxPortsCount {
return fmt.Errorf("%w: %d > %d", ErrPortsCountTooHigh, p.PortsCount, maxPortsCount)
}
}
if !slices.Equal(p.ListeningPorts, []uint16{0}) {
switch {
case len(p.ListeningPorts) != int(p.PortsCount):
return fmt.Errorf("%w: %d != %d", ErrListeningPortsLen, len(p.ListeningPorts), p.PortsCount)
case slices.Contains(p.ListeningPorts, 0):
return fmt.Errorf("%w: in %v", ErrListeningPortZero, p.ListeningPorts)
}
} }
return nil return nil
@@ -89,14 +126,14 @@ func (p PortForwarding) Validate(vpnProvider string) (err error) {
func (p *PortForwarding) Copy() (copied PortForwarding) { func (p *PortForwarding) Copy() (copied PortForwarding) {
return PortForwarding{ return PortForwarding{
Enabled: gosettings.CopyPointer(p.Enabled), Enabled: gosettings.CopyPointer(p.Enabled),
Provider: gosettings.CopyPointer(p.Provider), Provider: gosettings.CopyPointer(p.Provider),
Filepath: gosettings.CopyPointer(p.Filepath), Filepath: gosettings.CopyPointer(p.Filepath),
UpCommand: gosettings.CopyPointer(p.UpCommand), UpCommand: gosettings.CopyPointer(p.UpCommand),
DownCommand: gosettings.CopyPointer(p.DownCommand), DownCommand: gosettings.CopyPointer(p.DownCommand),
ListeningPort: gosettings.CopyPointer(p.ListeningPort), ListeningPorts: gosettings.CopySlice(p.ListeningPorts),
Username: p.Username, Username: p.Username,
Password: p.Password, Password: p.Password,
} }
} }
@@ -106,7 +143,7 @@ func (p *PortForwarding) OverrideWith(other PortForwarding) {
p.Filepath = gosettings.OverrideWithPointer(p.Filepath, other.Filepath) p.Filepath = gosettings.OverrideWithPointer(p.Filepath, other.Filepath)
p.UpCommand = gosettings.OverrideWithPointer(p.UpCommand, other.UpCommand) p.UpCommand = gosettings.OverrideWithPointer(p.UpCommand, other.UpCommand)
p.DownCommand = gosettings.OverrideWithPointer(p.DownCommand, other.DownCommand) p.DownCommand = gosettings.OverrideWithPointer(p.DownCommand, other.DownCommand)
p.ListeningPort = gosettings.OverrideWithPointer(p.ListeningPort, other.ListeningPort) p.ListeningPorts = gosettings.OverrideWithSlice(p.ListeningPorts, other.ListeningPorts)
p.Username = gosettings.OverrideWithComparable(p.Username, other.Username) p.Username = gosettings.OverrideWithComparable(p.Username, other.Username)
p.Password = gosettings.OverrideWithComparable(p.Password, other.Password) p.Password = gosettings.OverrideWithComparable(p.Password, other.Password)
} }
@@ -117,7 +154,8 @@ func (p *PortForwarding) setDefaults() {
p.Filepath = gosettings.DefaultPointer(p.Filepath, "/tmp/gluetun/forwarded_port") p.Filepath = gosettings.DefaultPointer(p.Filepath, "/tmp/gluetun/forwarded_port")
p.UpCommand = gosettings.DefaultPointer(p.UpCommand, "") p.UpCommand = gosettings.DefaultPointer(p.UpCommand, "")
p.DownCommand = gosettings.DefaultPointer(p.DownCommand, "") p.DownCommand = gosettings.DefaultPointer(p.DownCommand, "")
p.ListeningPort = gosettings.DefaultPointer(p.ListeningPort, 0) p.ListeningPorts = gosettings.DefaultSlice(p.ListeningPorts, []uint16{0}) // disabled
p.PortsCount = gosettings.DefaultComparable(p.PortsCount, 1)
} }
func (p PortForwarding) String() string { func (p PortForwarding) String() string {
@@ -131,11 +169,14 @@ func (p PortForwarding) toLinesNode() (node *gotree.Node) {
node = gotree.New("Automatic port forwarding settings:") node = gotree.New("Automatic port forwarding settings:")
listeningPort := "disabled" node.Appendf("Number of ports to be forwarded: %d", p.PortsCount)
if *p.ListeningPort != 0 {
listeningPort = fmt.Sprintf("%d", *p.ListeningPort) if !slices.Equal(p.ListeningPorts, []uint16{0}) {
redirNode := node.Appendf("Redirection for listening ports:")
for i, port := range p.ListeningPorts {
redirNode.Appendf("Port #%d -> %d", i+1, port)
}
} }
node.Appendf("Redirection listening port: %s", listeningPort)
if *p.Provider == "" { if *p.Provider == "" {
node.Appendf("Use port forwarding code for current provider") node.Appendf("Use port forwarding code for current provider")
@@ -190,7 +231,13 @@ func (p *PortForwarding) read(r *reader.Reader) (err error) {
p.DownCommand = r.Get("VPN_PORT_FORWARDING_DOWN_COMMAND", p.DownCommand = r.Get("VPN_PORT_FORWARDING_DOWN_COMMAND",
reader.ForceLowercase(false)) reader.ForceLowercase(false))
p.ListeningPort, err = r.Uint16Ptr("VPN_PORT_FORWARDING_LISTENING_PORT") p.ListeningPorts, err = r.CSVUint16("VPN_PORT_FORWARDING_LISTENING_PORTS",
reader.RetroKeys("VPN_PORT_FORWARDING_LISTENING_PORT"))
if err != nil {
return err
}
p.PortsCount, err = r.Uint16("VPN_PORT_FORWARDING_PORTS_COUNT")
if err != nil { if err != nil {
return err return err
} }
+6 -5
View File
@@ -42,11 +42,12 @@ func NewLoop(settings settings.PortForwarding, routing Routing,
settings: Settings{ settings: Settings{
VPNIsUp: ptrTo(false), VPNIsUp: ptrTo(false),
Service: service.Settings{ Service: service.Settings{
Enabled: settings.Enabled, Enabled: settings.Enabled,
Filepath: *settings.Filepath, Filepath: *settings.Filepath,
UpCommand: *settings.UpCommand, UpCommand: *settings.UpCommand,
DownCommand: *settings.DownCommand, DownCommand: *settings.DownCommand,
ListeningPort: *settings.ListeningPort, ListeningPorts: settings.ListeningPorts,
PortsCount: settings.PortsCount,
}, },
}, },
routing: routing, routing: routing,
+1 -1
View File
@@ -30,7 +30,7 @@ type Logger interface {
type PortForwarder interface { type PortForwarder interface {
Name() string Name() string
PortForward(ctx context.Context, objects utils.PortForwardObjects) ( PortForward(ctx context.Context, objects utils.PortForwardObjects) (
ports []uint16, err error) internalToExternalPorts map[uint16]uint16, err error)
KeepPortForward(ctx context.Context, objects utils.PortForwardObjects) (err error) KeepPortForward(ctx context.Context, objects utils.PortForwardObjects) (err error)
} }
+5 -1
View File
@@ -69,7 +69,11 @@ func (s *Service) SetPortsForwarded(ctx context.Context, ports []uint16) (err er
return fmt.Errorf("cleaning up: %w", err) return fmt.Errorf("cleaning up: %w", err)
} }
err = s.onNewPorts(ctx, ports) internalToExternalPorts := make(map[uint16]uint16, len(ports))
for _, port := range ports {
internalToExternalPorts[port] = port
}
err = s.onNewPorts(ctx, internalToExternalPorts)
if err != nil { if err != nil {
return fmt.Errorf("handling new ports: %w", err) return fmt.Errorf("handling new ports: %w", err)
} }
+37 -4
View File
@@ -3,6 +3,7 @@ package service
import ( import (
"errors" "errors"
"fmt" "fmt"
"slices"
"github.com/qdm12/gluetun/internal/constants/providers" "github.com/qdm12/gluetun/internal/constants/providers"
"github.com/qdm12/gosettings" "github.com/qdm12/gosettings"
@@ -17,7 +18,8 @@ type Settings struct {
Interface string // needed for PIA, PrivateVPN and ProtonVPN, tun0 for example Interface string // needed for PIA, PrivateVPN and ProtonVPN, tun0 for example
ServerName string // needed for PIA ServerName string // needed for PIA
CanPortForward bool // needed for PIA CanPortForward bool // needed for PIA
ListeningPort uint16 ListeningPorts []uint16
PortsCount uint16
Username string // needed for PIA Username string // needed for PIA
Password string // needed for PIA Password string // needed for PIA
} }
@@ -31,7 +33,8 @@ func (s Settings) Copy() (copied Settings) {
copied.Interface = s.Interface copied.Interface = s.Interface
copied.ServerName = s.ServerName copied.ServerName = s.ServerName
copied.CanPortForward = s.CanPortForward copied.CanPortForward = s.CanPortForward
copied.ListeningPort = s.ListeningPort copied.ListeningPorts = gosettings.CopySlice(s.ListeningPorts)
copied.PortsCount = s.PortsCount
copied.Username = s.Username copied.Username = s.Username
copied.Password = s.Password copied.Password = s.Password
return copied return copied
@@ -46,7 +49,8 @@ func (s *Settings) OverrideWith(update Settings) {
s.Interface = gosettings.OverrideWithComparable(s.Interface, update.Interface) s.Interface = gosettings.OverrideWithComparable(s.Interface, update.Interface)
s.ServerName = gosettings.OverrideWithComparable(s.ServerName, update.ServerName) s.ServerName = gosettings.OverrideWithComparable(s.ServerName, update.ServerName)
s.CanPortForward = gosettings.OverrideWithComparable(s.CanPortForward, update.CanPortForward) s.CanPortForward = gosettings.OverrideWithComparable(s.CanPortForward, update.CanPortForward)
s.ListeningPort = gosettings.OverrideWithComparable(s.ListeningPort, update.ListeningPort) s.ListeningPorts = gosettings.OverrideWithSlice(s.ListeningPorts, update.ListeningPorts)
s.PortsCount = gosettings.OverrideWithComparable(s.PortsCount, update.PortsCount)
s.Username = gosettings.OverrideWithComparable(s.Username, update.Username) s.Username = gosettings.OverrideWithComparable(s.Username, update.Username)
s.Password = gosettings.OverrideWithComparable(s.Password, update.Password) s.Password = gosettings.OverrideWithComparable(s.Password, update.Password)
} }
@@ -58,6 +62,10 @@ var (
ErrPasswordNotSet = errors.New("password not set") ErrPasswordNotSet = errors.New("password not set")
ErrFilepathNotSet = errors.New("file path not set") ErrFilepathNotSet = errors.New("file path not set")
ErrInterfaceNotSet = errors.New("interface not set") ErrInterfaceNotSet = errors.New("interface not set")
ErrPortsCountZero = errors.New("ports count cannot be zero")
ErrPortsCountTooHigh = errors.New("ports count too high")
ErrListeningPortsLen = errors.New("listening ports length must be equal to ports count")
ErrListeningPortZero = errors.New("listening port cannot be 0")
) )
func (s *Settings) Validate(forStartup bool) (err error) { func (s *Settings) Validate(forStartup bool) (err error) {
@@ -78,7 +86,12 @@ func (s *Settings) Validate(forStartup bool) (err error) {
return fmt.Errorf("%w", ErrPortForwarderNotSet) return fmt.Errorf("%w", ErrPortForwarderNotSet)
case s.Interface == "": case s.Interface == "":
return fmt.Errorf("%w", ErrInterfaceNotSet) return fmt.Errorf("%w", ErrInterfaceNotSet)
case s.PortForwarder.Name() == providers.PrivateInternetAccess: case s.PortsCount == 0:
return fmt.Errorf("%w", ErrPortsCountZero)
}
switch s.PortForwarder.Name() {
case providers.PrivateInternetAccess:
switch { switch {
case s.ServerName == "": case s.ServerName == "":
return fmt.Errorf("%w", ErrServerNameNotSet) return fmt.Errorf("%w", ErrServerNameNotSet)
@@ -87,6 +100,26 @@ func (s *Settings) Validate(forStartup bool) (err error) {
case s.Password == "": case s.Password == "":
return fmt.Errorf("%w", ErrPasswordNotSet) return fmt.Errorf("%w", ErrPasswordNotSet)
} }
case providers.Protonvpn:
const maxPortsCount = 4
if s.PortsCount > maxPortsCount {
return fmt.Errorf("%w: %d > %d", ErrPortsCountTooHigh, s.PortsCount, maxPortsCount)
}
default:
const maxPortsCount = 1
if s.PortsCount > maxPortsCount {
return fmt.Errorf("%w: %d > %d", ErrPortsCountTooHigh, s.PortsCount, maxPortsCount)
}
} }
if !slices.Equal(s.ListeningPorts, []uint16{0}) {
switch {
case len(s.ListeningPorts) != int(s.PortsCount):
return fmt.Errorf("%w: %d != %d", ErrListeningPortsLen, len(s.ListeningPorts), s.PortsCount)
case slices.Contains(s.ListeningPorts, 0):
return fmt.Errorf("%w: in %v", ErrListeningPortZero, s.ListeningPorts)
}
}
return nil return nil
} }
+42 -16
View File
@@ -3,6 +3,7 @@ package service
import ( import (
"context" "context"
"fmt" "fmt"
"maps"
"slices" "slices"
"github.com/qdm12/gluetun/internal/netlink" "github.com/qdm12/gluetun/internal/netlink"
@@ -42,8 +43,9 @@ func (s *Service) Start(ctx context.Context) (runError <-chan error, err error)
CanPortForward: s.settings.CanPortForward, CanPortForward: s.settings.CanPortForward,
Username: s.settings.Username, Username: s.settings.Username,
Password: s.settings.Password, Password: s.settings.Password,
PortsCount: s.settings.PortsCount,
} }
ports, err := s.settings.PortForwarder.PortForward(ctx, obj) internalToExternalPorts, err := s.settings.PortForwarder.PortForward(ctx, obj)
if err != nil { if err != nil {
return nil, fmt.Errorf("port forwarding for the first time: %w", err) return nil, fmt.Errorf("port forwarding for the first time: %w", err)
} }
@@ -51,7 +53,7 @@ func (s *Service) Start(ctx context.Context) (runError <-chan error, err error)
s.portMutex.Lock() s.portMutex.Lock()
defer s.portMutex.Unlock() defer s.portMutex.Unlock()
err = s.onNewPorts(ctx, ports) err = s.onNewPorts(ctx, internalToExternalPorts)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -86,36 +88,60 @@ func (s *Service) Start(ctx context.Context) (runError <-chan error, err error)
return runErrorCh, nil return runErrorCh, nil
} }
func (s *Service) onNewPorts(ctx context.Context, ports []uint16) (err error) { func (s *Service) onNewPorts(ctx context.Context, internalToExternalPorts map[uint16]uint16) (err error) {
slices.Sort(ports) autoRedirectionNeeded := false
externalToInternalPorts := make(map[uint16]uint16, len(internalToExternalPorts))
for internal, external := range internalToExternalPorts {
externalToInternalPorts[external] = internal
if internal != external {
autoRedirectionNeeded = true
}
}
s.logger.Info(portsToString(ports)) externalPorts := slices.Collect(maps.Keys(externalToInternalPorts))
slices.Sort(externalPorts)
for _, port := range ports { s.logger.Info(portsToString(externalPorts))
err = s.portAllower.SetAllowedPort(ctx, port, s.settings.Interface)
userRedirectionEnabled := !slices.Equal(s.settings.ListeningPorts, []uint16{0})
for i, port := range externalPorts {
internalPort := externalToInternalPorts[port]
err = s.portAllower.SetAllowedPort(ctx, internalPort, s.settings.Interface)
if err != nil { if err != nil {
return fmt.Errorf("allowing port in firewall: %w", err) return fmt.Errorf("allowing port in firewall: %w", err)
} }
if s.settings.ListeningPort != 0 { var sourcePort, destinationPort uint16
err = s.portAllower.RedirectPort(ctx, s.settings.Interface, port, s.settings.ListeningPort) switch {
if err != nil { case userRedirectionEnabled: // precedence over auto redirection
return fmt.Errorf("redirecting port in firewall: %w", err) sourcePort = externalToInternalPorts[port]
} destinationPort = s.settings.ListeningPorts[i]
case autoRedirectionNeeded:
sourcePort = externalToInternalPorts[port]
destinationPort = port
default:
// No redirection needed, source and destination ports are the same.
continue
}
err = s.portAllower.RedirectPort(ctx, s.settings.Interface, sourcePort, destinationPort)
if err != nil {
return fmt.Errorf("redirecting port %d to %d in firewall: %w",
sourcePort, destinationPort, err)
} }
} }
err = s.writePortForwardedFile(ports) err = s.writePortForwardedFile(externalPorts)
if err != nil { if err != nil {
_ = s.cleanup() _ = s.cleanup()
return fmt.Errorf("writing port file: %w", err) return fmt.Errorf("writing port file: %w", err)
} }
s.ports = make([]uint16, len(ports)) s.ports = make([]uint16, len(internalToExternalPorts))
copy(s.ports, ports) copy(s.ports, externalPorts)
if s.settings.UpCommand != "" { if s.settings.UpCommand != "" {
err = runCommand(ctx, s.cmder, s.logger, s.settings.UpCommand, ports, s.settings.Interface) err = runCommand(ctx, s.cmder, s.logger, s.settings.UpCommand, externalPorts, s.settings.Interface)
if err != nil { if err != nil {
err = fmt.Errorf("running up command: %w", err) err = fmt.Errorf("running up command: %w", err)
s.logger.Error(err.Error()) s.logger.Error(err.Error())
+3 -1
View File
@@ -3,6 +3,7 @@ package service
import ( import (
"context" "context"
"fmt" "fmt"
"slices"
"time" "time"
) )
@@ -38,13 +39,14 @@ func (s *Service) cleanup() (err error) {
} }
} }
redirectionWasEnabled := !slices.Equal(s.settings.ListeningPorts, []uint16{0})
for _, port := range s.ports { for _, port := range s.ports {
err = s.portAllower.RemoveAllowedPort(context.Background(), port) err = s.portAllower.RemoveAllowedPort(context.Background(), port)
if err != nil { if err != nil {
return fmt.Errorf("blocking previous port in firewall: %w", err) return fmt.Errorf("blocking previous port in firewall: %w", err)
} }
if s.settings.ListeningPort != 0 { if redirectionWasEnabled {
ctx := context.Background() ctx := context.Background()
const listeningPort = 0 // 0 to clear the redirection const listeningPort = 0 // 0 to clear the redirection
err = s.portAllower.RedirectPort(ctx, s.settings.Interface, port, listeningPort) err = s.portAllower.RedirectPort(ctx, s.settings.Interface, port, listeningPort)
@@ -10,12 +10,17 @@ import (
// PortForward calculates and returns the VPN server side ports forwarded. // PortForward calculates and returns the VPN server side ports forwarded.
func (p *Provider) PortForward(_ context.Context, func (p *Provider) PortForward(_ context.Context,
objects utils.PortForwardObjects, objects utils.PortForwardObjects,
) (ports []uint16, err error) { ) (internalToExternalPorts map[uint16]uint16, err error) {
if !objects.InternalIP.IsValid() { if !objects.InternalIP.IsValid() {
panic("internal ip is not set") panic("internal ip is not set")
} }
return internalIPToPorts(objects.InternalIP), nil ports := internalIPToPorts(objects.InternalIP)
internalToExternalPorts = make(map[uint16]uint16, len(ports))
for _, port := range ports {
internalToExternalPorts[port] = port
}
return internalToExternalPorts, nil
} }
func (p *Provider) KeepPortForward(ctx context.Context, func (p *Provider) KeepPortForward(ctx context.Context,
@@ -26,7 +26,7 @@ var ErrServerNameNotFound = errors.New("server name not found in servers")
// PortForward obtains a VPN server side port forwarded from PIA. // PortForward obtains a VPN server side port forwarded from PIA.
func (p *Provider) PortForward(ctx context.Context, func (p *Provider) PortForward(ctx context.Context,
objects utils.PortForwardObjects, objects utils.PortForwardObjects,
) (ports []uint16, err error) { ) (internalToExternalPorts map[uint16]uint16, err error) {
switch { switch {
case objects.ServerName == "": case objects.ServerName == "":
panic("server name cannot be empty") panic("server name cannot be empty")
@@ -84,7 +84,7 @@ func (p *Provider) PortForward(ctx context.Context,
return nil, fmt.Errorf("binding port: %w", err) return nil, fmt.Errorf("binding port: %w", err)
} }
return []uint16{data.Port}, nil return map[uint16]uint16{data.Port: data.Port}, nil
} }
var ErrPortForwardedExpired = errors.New("port forwarded data expired") var ErrPortForwardedExpired = errors.New("port forwarded data expired")
+3 -2
View File
@@ -22,7 +22,7 @@ var ErrPortForwardedNotFound = errors.New("port forwarded not found")
// PortForward obtains a VPN server side port forwarded from the PrivateVPN API. // PortForward obtains a VPN server side port forwarded from the PrivateVPN API.
// It returns 0 if all ports are to forwarded on a dedicated server IP. // It returns 0 if all ports are to forwarded on a dedicated server IP.
func (p *Provider) PortForward(ctx context.Context, objects utils.PortForwardObjects) ( func (p *Provider) PortForward(ctx context.Context, objects utils.PortForwardObjects) (
ports []uint16, err error, internalToExternalPorts map[uint16]uint16, err error,
) { ) {
// Define a timeout since the default client has a large timeout and we don't // Define a timeout since the default client has a large timeout and we don't
// want to wait too long. // want to wait too long.
@@ -75,7 +75,8 @@ func (p *Provider) PortForward(ctx context.Context, objects utils.PortForwardObj
if err != nil { if err != nil {
return nil, fmt.Errorf("parsing port: %w", err) return nil, fmt.Errorf("parsing port: %w", err)
} }
return []uint16{uint16(portUint64)}, nil port := uint16(portUint64)
return map[uint16]uint16{port: port}, nil
} }
func (p *Provider) KeepPortForward(ctx context.Context, func (p *Provider) KeepPortForward(ctx context.Context,
@@ -28,10 +28,10 @@ func Test_Provider_PortForward(t *testing.T) {
cancel() cancel()
testCases := map[string]struct { testCases := map[string]struct {
ctx context.Context ctx context.Context
objects utils.PortForwardObjects objects utils.PortForwardObjects
ports []uint16 internalToExternalPorts map[uint16]uint16
errMessage string errMessage string
}{ }{
"canceled context": { "canceled context": {
ctx: canceledCtx, ctx: canceledCtx,
@@ -192,7 +192,7 @@ func Test_Provider_PortForward(t *testing.T) {
}), }),
}, },
}, },
ports: []uint16{61527}, internalToExternalPorts: map[uint16]uint16{61527: 61527},
}, },
} }
for name, testCase := range testCases { for name, testCase := range testCases {
@@ -203,7 +203,7 @@ func Test_Provider_PortForward(t *testing.T) {
ports, err := provider.PortForward(testCase.ctx, ports, err := provider.PortForward(testCase.ctx,
testCase.objects) testCase.objects)
assert.Equal(t, testCase.ports, ports) assert.Equal(t, testCase.internalToExternalPorts, ports)
if testCase.errMessage != "" { if testCase.errMessage != "" {
assert.EqualError(t, err, testCase.errMessage) assert.EqualError(t, err, testCase.errMessage)
} else { } else {
+68 -45
View File
@@ -4,6 +4,7 @@ import (
"context" "context"
"errors" "errors"
"fmt" "fmt"
"maps"
"strings" "strings"
"time" "time"
@@ -13,17 +14,18 @@ import (
var ErrServerPortForwardNotSupported = errors.New("server does not support port forwarding") var ErrServerPortForwardNotSupported = errors.New("server does not support port forwarding")
const nonSymmetricPortStart uint16 = 56789
// PortForward obtains a VPN server side port forwarded from ProtonVPN gateway. // PortForward obtains a VPN server side port forwarded from ProtonVPN gateway.
func (p *Provider) PortForward(ctx context.Context, objects utils.PortForwardObjects) ( func (p *Provider) PortForward(ctx context.Context, objects utils.PortForwardObjects) (
ports []uint16, err error, internalToExternalPorts map[uint16]uint16, err error,
) { ) {
if !objects.CanPortForward { if !objects.CanPortForward {
return nil, fmt.Errorf("%w", ErrServerPortForwardNotSupported) return nil, fmt.Errorf("%w", ErrServerPortForwardNotSupported)
} }
client := natpmp.New() client := natpmp.New()
_, externalIPv4Address, err := client.ExternalAddress(ctx, _, externalIPv4Address, err := client.ExternalAddress(ctx, objects.Gateway)
objects.Gateway)
if err != nil { if err != nil {
switch { switch {
case strings.HasSuffix(err.Error(), "connection refused"): case strings.HasSuffix(err.Error(), "connection refused"):
@@ -38,29 +40,37 @@ func (p *Provider) PortForward(ctx context.Context, objects utils.PortForwardObj
logger := objects.Logger logger := objects.Logger
logger.Info("gateway external IPv4 address is " + externalIPv4Address.String()) logger.Debug("gateway external IPv4 address is " + externalIPv4Address.String())
const internalPort, externalPort = 0, 1 const externalPort = 0
const lifetime = 60 * time.Second const lifetime = 60 * time.Second
_, _, assignedUDPExternalPort, assignedLifetime, err := client.AddPortMapping(ctx, objects.Gateway, "udp", p.internalToExternalPorts = make(map[uint16]uint16, objects.PortsCount)
internalPort, externalPort, lifetime) for i := range objects.PortsCount {
if err != nil { internalPort := nonSymmetricPortStart + i
return nil, fmt.Errorf("adding UDP port mapping: %w", err) protoToInternalPort := map[string]uint16{
"udp": 0,
"tcp": 0,
}
protoToExternalPort := maps.Clone(protoToInternalPort)
for protocol := range protoToExternalPort {
_, assignedInternalPort, assignedExternalPort, assignedLifetime, err := client.AddPortMapping(
ctx, objects.Gateway, protocol, internalPort, externalPort, lifetime)
if err != nil {
return nil, fmt.Errorf("adding %d/%d %s port mapping: %w",
i+1, objects.PortsCount, strings.ToUpper(protocol), err)
}
checkLifetime(logger, strings.ToUpper(protocol), lifetime, assignedLifetime)
checkInternalPort(logger, internalPort, assignedInternalPort)
protoToInternalPort[protocol] = assignedInternalPort
protoToExternalPort[protocol] = assignedExternalPort
}
checkInternalPorts(logger, protoToInternalPort["udp"], protoToInternalPort["tcp"])
checkExternalPorts(logger, protoToExternalPort["udp"], protoToExternalPort["tcp"])
p.internalToExternalPorts[protoToInternalPort["tcp"]] = protoToExternalPort["tcp"]
} }
checkLifetime(logger, "UDP", lifetime, assignedLifetime)
_, _, assignedTCPExternalPort, assignedLifetime, err := client.AddPortMapping(ctx, objects.Gateway, "tcp", return maps.Clone(p.internalToExternalPorts), nil
internalPort, externalPort, lifetime)
if err != nil {
return nil, fmt.Errorf("adding TCP port mapping: %w", err)
}
checkLifetime(logger, "TCP", lifetime, assignedLifetime)
checkExternalPorts(logger, assignedUDPExternalPort, assignedTCPExternalPort)
p.portForwarded = assignedTCPExternalPort
return []uint16{assignedTCPExternalPort}, nil
} }
func checkLifetime(logger utils.Logger, protocol string, func checkLifetime(logger utils.Logger, protocol string,
@@ -73,6 +83,20 @@ func checkLifetime(logger utils.Logger, protocol string,
} }
} }
func checkInternalPort(logger utils.Logger, sent, received uint16) {
if sent != received {
logger.Warn(fmt.Sprintf("internal port assigned %d differs from requested internal port %d",
sent, received))
}
}
func checkInternalPorts(logger utils.Logger, udpPort, tcpPort uint16) {
if udpPort != tcpPort {
logger.Warn(fmt.Sprintf("UDP internal port %d differs from TCP internal port %d",
udpPort, tcpPort))
}
}
func checkExternalPorts(logger utils.Logger, udpPort, tcpPort uint16) { func checkExternalPorts(logger utils.Logger, udpPort, tcpPort uint16) {
if udpPort != tcpPort { if udpPort != tcpPort {
logger.Warn(fmt.Sprintf("UDP external port %d differs from TCP external port %d", logger.Warn(fmt.Sprintf("UDP external port %d differs from TCP external port %d",
@@ -80,7 +104,10 @@ func checkExternalPorts(logger utils.Logger, udpPort, tcpPort uint16) {
} }
} }
var ErrExternalPortChanged = errors.New("external port changed") var (
ErrInternalPortChanged = errors.New("internal port changed")
ErrExternalPortChanged = errors.New("external port changed")
)
func (p *Provider) KeepPortForward(ctx context.Context, func (p *Provider) KeepPortForward(ctx context.Context,
objects utils.PortForwardObjects, objects utils.PortForwardObjects,
@@ -96,32 +123,28 @@ func (p *Provider) KeepPortForward(ctx context.Context,
case <-timer.C: case <-timer.C:
} }
objects.Logger.Debug("refreshing port forward since 45 seconds have elapsed") objects.Logger.Debug("refreshing forwarded ports since 45 seconds have elapsed")
networkProtocols := []string{"udp", "tcp"} networkProtocols := [...]string{"udp", "tcp"}
const internalPort = 0
const lifetime = 60 * time.Second const lifetime = 60 * time.Second
for internalPort, externalPort := range p.internalToExternalPorts {
for _, networkProtocol := range networkProtocols { for _, networkProtocol := range networkProtocols {
_, _, assignedExternalPort, assignedLiftetime, err := client.AddPortMapping(ctx, objects.Gateway, networkProtocol, _, assignedInternalPort, assignedExternalPort, assignedLiftetime, err := client.AddPortMapping(
internalPort, p.portForwarded, lifetime) ctx, objects.Gateway, networkProtocol, internalPort, externalPort, lifetime)
if err != nil { if err != nil {
return fmt.Errorf("adding port mapping: %w", err) return fmt.Errorf("adding port mapping: %w", err)
} }
checkLifetime(logger, networkProtocol, lifetime, assignedLiftetime)
if assignedLiftetime != lifetime { if externalPort != assignedExternalPort {
logger.Warn(fmt.Sprintf("assigned lifetime %s differs"+ return fmt.Errorf("%w: %d changed to %d",
" from requested lifetime %s", ErrExternalPortChanged, externalPort, assignedExternalPort)
assignedLiftetime, lifetime)) } else if internalPort != assignedInternalPort {
} return fmt.Errorf("%w: %d (for external port %d) changed to %d",
ErrInternalPortChanged, internalPort, externalPort, assignedInternalPort)
if p.portForwarded != assignedExternalPort { }
return fmt.Errorf("%w: %d changed to %d",
ErrExternalPortChanged, p.portForwarded, assignedExternalPort)
} }
objects.Logger.Debug(fmt.Sprintf("port forwarded %d maintained", externalPort))
} }
objects.Logger.Debug(fmt.Sprintf("port forwarded %d maintained", p.portForwarded))
timer.Reset(refreshTimeout) timer.Reset(refreshTimeout)
} }
} }
+1 -1
View File
@@ -13,7 +13,7 @@ type Provider struct {
storage common.Storage storage common.Storage
randSource rand.Source randSource rand.Source
common.Fetcher common.Fetcher
portForwarded uint16 internalToExternalPorts map[uint16]uint16
} }
func New(storage common.Storage, randSource rand.Source, func New(storage common.Storage, randSource rand.Source,
+2
View File
@@ -25,6 +25,8 @@ type PortForwardObjects struct {
Username string Username string
// Password is used by Private Internet Access for port forwarding. // Password is used by Private Internet Access for port forwarding.
Password string Password string
// PortsCount is used by ProtonVPN for port forwarding.
PortsCount uint16
} }
type Routing interface { type Routing interface {
+1 -1
View File
@@ -52,7 +52,7 @@ type Provider interface {
type PortForwarder interface { type PortForwarder interface {
Name() string Name() string
PortForward(ctx context.Context, objects utils.PortForwardObjects) ( PortForward(ctx context.Context, objects utils.PortForwardObjects) (
ports []uint16, err error) internalToExternalPorts map[uint16]uint16, err error)
KeepPortForward(ctx context.Context, objects utils.PortForwardObjects) (err error) KeepPortForward(ctx context.Context, objects utils.PortForwardObjects) (err error)
} }
+1 -1
View File
@@ -62,7 +62,7 @@ func (n *noPortForwarder) Name() string {
} }
func (n *noPortForwarder) PortForward(context.Context, pfutils.PortForwardObjects) ( func (n *noPortForwarder) PortForward(context.Context, pfutils.PortForwardObjects) (
ports []uint16, err error, internalToExternalPorts map[uint16]uint16, err error,
) { ) {
return nil, fmt.Errorf("%w: for %s", ErrPortForwardingNotSupported, n.providerName) return nil, fmt.Errorf("%w: for %s", ErrPortForwardingNotSupported, n.providerName)
} }