chore(portforward): move vpn gateway obtention within port forwarding service

internal/provider/privateinternetaccess/portforward.go

@@ -22,30 +22,33 @@ import (
 )
 
 var (
-	ErrServerNameNotFound  = errors.New("server name not found in servers")
-	ErrGatewayIPIsNotValid = errors.New("gateway IP address is not valid")
-	ErrServerNameEmpty     = errors.New("server name is empty")
+	ErrServerNameNotFound = errors.New("server name not found in servers")
 )
 
 // PortForward obtains a VPN server side port forwarded from PIA.
-func (p *Provider) PortForward(ctx context.Context, client *http.Client,
-	logger utils.Logger, gateway netip.Addr, serverName string) (
-	port uint16, err error) {
+func (p *Provider) PortForward(ctx context.Context,
+	objects utils.PortForwardObjects) (port uint16, err error) {
+	switch {
+	case objects.ServerName == "":
+		panic("server name cannot be empty")
+	case !objects.Gateway.IsValid():
+		panic("gateway is not set")
+	}
+
+	serverName := objects.ServerName
+
 	server, ok := p.storage.GetServerByName(providers.PrivateInternetAccess, serverName)
 	if !ok {
 		return 0, fmt.Errorf("%w: %s", ErrServerNameNotFound, serverName)
 	}
 
+	logger := objects.Logger
+
 	if !server.PortForward {
 		logger.Error("The server " + serverName +
 			" (region " + server.Region + ") does not support port forwarding")
 		return 0, nil
 	}
-	if !gateway.IsValid() {
-		return 0, fmt.Errorf("%w: %s", ErrGatewayIPIsNotValid, gateway)
-	} else if serverName == "" {
-		return 0, ErrServerNameEmpty
-	}
 
 	privateIPClient, err := newHTTPClient(serverName)
 	if err != nil {
@@ -70,7 +73,8 @@ func (p *Provider) PortForward(ctx context.Context, client *http.Client,
 	}
 
 	if !dataFound || expired {
-		data, err = refreshPIAPortForwardData(ctx, client, privateIPClient, gateway,
+		client := objects.Client
+		data, err = refreshPIAPortForwardData(ctx, client, privateIPClient, objects.Gateway,
 			p.portForwardPath, p.authFilePath)
 		if err != nil {
 			return 0, fmt.Errorf("refreshing port forward data: %w", err)
@@ -80,7 +84,7 @@ func (p *Provider) PortForward(ctx context.Context, client *http.Client,
 	logger.Info("Port forwarded data expires in " + format.FriendlyDuration(durationToExpiration))
 
 	// First time binding
-	if err := bindPort(ctx, privateIPClient, gateway, data); err != nil {
+	if err := bindPort(ctx, privateIPClient, objects.Gateway, data); err != nil {
 		return 0, fmt.Errorf("binding port: %w", err)
 	}
 
@@ -91,9 +95,16 @@ var (
 	ErrPortForwardedExpired = errors.New("port forwarded data expired")
 )
 
-func (p *Provider) KeepPortForward(ctx context.Context, _ uint16,
-	gateway netip.Addr, serverName string, _ utils.Logger) (err error) {
-	privateIPClient, err := newHTTPClient(serverName)
+func (p *Provider) KeepPortForward(ctx context.Context,
+	objects utils.PortForwardObjects) (err error) {
+	switch {
+	case objects.ServerName == "":
+		panic("server name cannot be empty")
+	case !objects.Gateway.IsValid():
+		panic("gateway is not set")
+	}
+
+	privateIPClient, err := newHTTPClient(objects.ServerName)
 	if err != nil {
 		return fmt.Errorf("creating custom HTTP client: %w", err)
 	}
@@ -120,7 +131,7 @@ func (p *Provider) KeepPortForward(ctx context.Context, _ uint16,
 			}
 			return ctx.Err()
 		case <-keepAliveTimer.C:
-			err := bindPort(ctx, privateIPClient, gateway, data)
+			err = bindPort(ctx, privateIPClient, objects.Gateway, data)
 			if err != nil {
 				return fmt.Errorf("binding port: %w", err)
 			}

internal/provider/protonvpn/portforward.go

@@ -2,10 +2,7 @@ package protonvpn
 
 import (
 	"context"
-	"errors"
 	"fmt"
-	"net/http"
-	"net/netip"
 	"strings"
 	"time"
 
@@ -13,31 +10,24 @@ import (
 	"github.com/qdm12/gluetun/internal/provider/utils"
 )
 
-var (
-	ErrGatewayIPNotValid = errors.New("gateway IP address is not valid")
-)
-
 // PortForward obtains a VPN server side port forwarded from ProtonVPN gateway.
-func (p *Provider) PortForward(ctx context.Context, _ *http.Client,
-	logger utils.Logger, gateway netip.Addr, _ string) (
+func (p *Provider) PortForward(ctx context.Context, objects utils.PortForwardObjects) (
 	port uint16, err error) {
-	if !gateway.IsValid() {
-		return 0, fmt.Errorf("%w", ErrGatewayIPNotValid)
-	}
-
 	client := natpmp.New()
 	_, externalIPv4Address, err := client.ExternalAddress(ctx,
-		gateway)
+		objects.Gateway)
 	if err != nil {
 		return 0, fmt.Errorf("getting external IPv4 address: %w", err)
 	}
 
+	logger := objects.Logger
+
 	logger.Info("gateway external IPv4 address is " + externalIPv4Address.String())
 	const internalPort, externalPort = 0, 0
 	const lifetime = 60 * time.Second
 
 	_, _, assignedUDPExternalPort, assignedLifetime, err :=
-		client.AddPortMapping(ctx, gateway, "udp",
+		client.AddPortMapping(ctx, objects.Gateway, "udp",
 			internalPort, externalPort, lifetime)
 	if err != nil {
 		return 0, fmt.Errorf("adding UDP port mapping: %w", err)
@@ -45,7 +35,7 @@ func (p *Provider) PortForward(ctx context.Context, _ *http.Client,
 	checkLifetime(logger, "UDP", lifetime, assignedLifetime)
 
 	_, _, assignedTCPExternalPort, assignedLifetime, err :=
-		client.AddPortMapping(ctx, gateway, "tcp",
+		client.AddPortMapping(ctx, objects.Gateway, "tcp",
 			internalPort, externalPort, lifetime)
 	if err != nil {
 		return 0, fmt.Errorf("adding TCP port mapping: %w", err)
@@ -55,6 +45,8 @@ func (p *Provider) PortForward(ctx context.Context, _ *http.Client,
 	checkExternalPorts(logger, assignedUDPExternalPort, assignedTCPExternalPort)
 	port = assignedTCPExternalPort
 
+	p.portForwarded = port
+
 	return port, nil
 }
 
@@ -74,11 +66,12 @@ func checkExternalPorts(logger utils.Logger, udpPort, tcpPort uint16) {
 	}
 }
 
-func (p *Provider) KeepPortForward(ctx context.Context, port uint16,
-	gateway netip.Addr, _ string, logger utils.Logger) (err error) {
+func (p *Provider) KeepPortForward(ctx context.Context,
+	objects utils.PortForwardObjects) (err error) {
 	client := natpmp.New()
 	const refreshTimeout = 45 * time.Second
 	timer := time.NewTimer(refreshTimeout)
+	logger := objects.Logger
 	for {
 		select {
 		case <-ctx.Done():
@@ -92,8 +85,8 @@ func (p *Provider) KeepPortForward(ctx context.Context, port uint16,
 
 		for _, networkProtocol := range networkProtocols {
 			_, _, assignedExternalPort, assignedLiftetime, err :=
-				client.AddPortMapping(ctx, gateway, networkProtocol,
-					internalPort, port, lifetime)
+				client.AddPortMapping(ctx, objects.Gateway, networkProtocol,
+					internalPort, p.portForwarded, lifetime)
 			if err != nil {
 				return fmt.Errorf("adding port mapping: %w", err)
 			}
@@ -104,10 +97,10 @@ func (p *Provider) KeepPortForward(ctx context.Context, port uint16,
 					assignedLiftetime, lifetime))
 			}
 
-			if port != assignedExternalPort {
-				logger.Warn(fmt.Sprintf("external port assigned %d changed to %d",
-					port, assignedExternalPort))
-				port = assignedExternalPort
+			if p.portForwarded != assignedExternalPort {
+				objects.Logger.Warn(fmt.Sprintf("external port assigned %d changed to %d",
+					p.portForwarded, assignedExternalPort))
+				p.portForwarded = assignedExternalPort
 			}
 		}
 

internal/provider/protonvpn/provider.go

@@ -13,6 +13,7 @@ type Provider struct {
 	storage    common.Storage
 	randSource rand.Source
 	common.Fetcher
+	portForwarded uint16
 }
 
 func New(storage common.Storage, randSource rand.Source,

internal/provider/provider.go

@@ -2,8 +2,6 @@ package provider
 
 import (
 	"context"
-	"net/http"
-	"net/netip"
 
 	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/models"
@@ -22,9 +20,7 @@ type Provider interface {
 
 type PortForwarder interface {
 	Name() string
-	PortForward(ctx context.Context, client *http.Client,
-		logger utils.Logger, gateway netip.Addr, serverName string) (
+	PortForward(ctx context.Context, objects utils.PortForwardObjects) (
 		port uint16, err error)
-	KeepPortForward(ctx context.Context, port uint16, gateway netip.Addr,
-		serverName string, _ utils.Logger) (err error)
+	KeepPortForward(ctx context.Context, objects utils.PortForwardObjects) (err error)
 }

internal/provider/utils/noportforward.go

@@ -4,16 +4,11 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"net/http"
-	"net/netip"
 )
 
 type NoPortForwarder interface {
-	PortForward(ctx context.Context, client *http.Client,
-		logger Logger, gateway netip.Addr, serverName string) (
-		port uint16, err error)
-	KeepPortForward(ctx context.Context, port uint16, gateway netip.Addr,
-		serverName string, logger Logger) (err error)
+	PortForward(ctx context.Context, objects PortForwardObjects) (port uint16, err error)
+	KeepPortForward(ctx context.Context, objects PortForwardObjects) (err error)
 }
 
 type NoPortForwarding struct {
@@ -28,12 +23,11 @@ func NewNoPortForwarding(providerName string) *NoPortForwarding {
 
 var ErrPortForwardingNotSupported = errors.New("custom port forwarding obtention is not supported")
 
-func (n *NoPortForwarding) PortForward(context.Context, *http.Client,
-	Logger, netip.Addr, string) (port uint16, err error) {
+func (n *NoPortForwarding) PortForward(context.Context, PortForwardObjects) (
+	port uint16, err error) {
 	return 0, fmt.Errorf("%w: for %s", ErrPortForwardingNotSupported, n.providerName)
 }
 
-func (n *NoPortForwarding) KeepPortForward(context.Context, uint16, netip.Addr,
-	string, Logger) (err error) {
+func (n *NoPortForwarding) KeepPortForward(context.Context, PortForwardObjects) (err error) {
 	return fmt.Errorf("%w: for %s", ErrPortForwardingNotSupported, n.providerName)
 }

internal/provider/utils/portforward.go

@@ -0,0 +1,27 @@
+package utils
+
+import (
+	"net/http"
+	"net/netip"
+)
+
+// PortForwardObjects contains fields that may or may not need to be set
+// depending on the port forwarding provider code.
+type PortForwardObjects struct {
+	// Logger is a logger, used by both Private Internet Access and ProtonVPN.
+	Logger Logger
+	// Gateway is the VPN gateway IP address, used by Private Internet Access
+	// and ProtonVPN.
+	Gateway netip.Addr
+	// Client is used to query the VPN gateway for Private Internet Access.
+	Client *http.Client
+	// ServerName is used by Private Internet Access for port forwarding,
+	// and to look up the server data from storage.
+	// TODO use server data directly to remove storage dependency for port
+	// forwarding implementation.
+	ServerName string
+}
+
+type Routing interface {
+	VPNLocalGatewayIP(vpnInterface string) (gateway netip.Addr, err error)
+}