admin/gluetun
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Quentin McGaw
2023-09-23 11:46:14 +00:00
parent 71201411f4
commit 0406de399d
14 changed files with 135 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
internal/portforward/interfaces.go
View File

@@ -1,6 +1,9 @@
package portforward
import "context"
import (
"context"
"net/netip"
)
type Service interface {
Start(ctx context.Context) (runError <-chan error, err error)
@@ -8,6 +11,10 @@ type Service interface {
GetPortForwarded() (port uint16)
}
type Routing interface {
VPNLocalGatewayIP(vpnInterface string) (gateway netip.Addr, err error)
}
type PortAllower interface {
SetAllowedPort(ctx context.Context, port uint16, intf string) (err error)
RemoveAllowedPort(ctx context.Context, port uint16) (err error)

6
internal/portforward/loop.go
View File

@@ -16,6 +16,7 @@ type Loop struct {
settingsMutex sync.RWMutex
service Service
// Fixed injected objets
routing Routing
client *http.Client
portAllower PortAllower
logger Logger
@@ -30,13 +31,14 @@ type Loop struct {
runDone <-chan struct{}
}
func NewLoop(settings settings.PortForwarding,
func NewLoop(settings settings.PortForwarding, routing Routing,
client *http.Client, portAllower PortAllower,
logger Logger, uid, gid int) *Loop {
return &Loop{
settings: service.Settings{
UserSettings: settings,
},
routing: routing,
client: client,
portAllower: portAllower,
logger: logger,
@@ -85,7 +87,7 @@ func (l *Loop) run(runCtx context.Context, runDone chan<- struct{},
}
l.settingsMutex.RLock()
l.service = service.New(l.settings, l.client,
l.service = service.New(l.settings, l.routing, l.client,
l.portAllower, l.logger, l.uid, l.gid)
l.settingsMutex.RUnlock()

14
internal/portforward/service/interfaces.go
View File

@@ -2,6 +2,9 @@ package service
import (
"context"
"net/netip"
"github.com/qdm12/gluetun/internal/provider/utils"
)
type PortAllower interface {
@@ -9,8 +12,19 @@ type PortAllower interface {
RemoveAllowedPort(ctx context.Context, port uint16) (err error)
}
type Routing interface {
VPNLocalGatewayIP(vpnInterface string) (gateway netip.Addr, err error)
}
type Logger interface {
Info(s string)
Warn(s string)
Error(s string)
}
type PortForwarder interface {
Name() string
PortForward(ctx context.Context, objects utils.PortForwardObjects) (
port uint16, err error)
KeepPortForward(ctx context.Context, objects utils.PortForwardObjects) (err error)
}

4
internal/portforward/service/service.go
View File

@@ -15,6 +15,7 @@ type Service struct {
puid int
pgid int
// Fixed injected objets
routing Routing
client *http.Client
portAllower PortAllower
logger Logger
@@ -24,7 +25,7 @@ type Service struct {
keepPortDoneCh <-chan struct{}
}
func New(settings Settings, client *http.Client,
func New(settings Settings, routing Routing, client *http.Client,
portAllower PortAllower, logger Logger, puid, pgid int) *Service {
return &Service{
// Fixed parameters
@@ -32,6 +33,7 @@ func New(settings Settings, client *http.Client,
puid: puid,
pgid: pgid,
// Fixed injected objets
routing: routing,
client: client,
portAllower: portAllower,
logger: logger,

19
internal/portforward/service/settings.go
View File

@@ -3,21 +3,18 @@ package service
import (
"errors"
"fmt"
"net/netip"
"github.com/qdm12/gluetun/internal/configuration/settings"
"github.com/qdm12/gluetun/internal/constants/providers"
"github.com/qdm12/gluetun/internal/provider"
"github.com/qdm12/gosettings"
)
type Settings struct {
UserSettings settings.PortForwarding
PortForwarder provider.PortForwarder
Gateway netip.Addr // needed for PIA and ProtonVPN
ServerName string // needed for PIA
Interface string // needed for PIA and ProtonVPN, tun0 for example
VPNProvider string // used to validate new settings
PortForwarder PortForwarder
Interface string // needed for PIA and ProtonVPN, tun0 for example
ServerName string // needed for PIA
VPNProvider string // used to validate new settings
}
// UpdateWith deep copies the receiving settings, overrides the copy with
@@ -37,9 +34,8 @@ func (s Settings) UpdateWith(partialUpdate Settings) (updatedSettings Settings,
func (s Settings) copy() (copied Settings) {
copied.UserSettings = s.UserSettings.Copy()
copied.PortForwarder = s.PortForwarder
copied.Gateway = s.Gateway
copied.ServerName = s.ServerName
copied.Interface = s.Interface
copied.ServerName = s.ServerName
copied.VPNProvider = s.VPNProvider
return copied
}
@@ -47,9 +43,8 @@ func (s Settings) copy() (copied Settings) {
func (s *Settings) overrideWith(update Settings) {
s.UserSettings.OverrideWith(update.UserSettings)
s.PortForwarder = gosettings.OverrideWithInterface(s.PortForwarder, update.PortForwarder)
s.Gateway = gosettings.OverrideWithValidator(s.Gateway, update.Gateway)
s.ServerName = gosettings.OverrideWithString(s.ServerName, update.ServerName)
s.Interface = gosettings.OverrideWithString(s.Interface, update.Interface)
s.ServerName = gosettings.OverrideWithString(s.ServerName, update.ServerName)
s.VPNProvider = gosettings.OverrideWithString(s.VPNProvider, update.VPNProvider)
}
@@ -69,8 +64,6 @@ func (s *Settings) validate() (err error) {
return fmt.Errorf("%w", ErrServerNameNotSet)
case s.PortForwarder == nil:
return fmt.Errorf("%w", ErrPortForwarderNotSet)
case !s.Gateway.IsValid():
return fmt.Errorf("%w", ErrGatewayNotSet)
case s.Interface == "":
return fmt.Errorf("%w", ErrInterfaceNotSet)
}

26
internal/portforward/service/start.go
View File

@@ -3,6 +3,8 @@ package service
import (
"context"
"fmt"
"github.com/qdm12/gluetun/internal/provider/utils"
)
func (s *Service) Start(ctx context.Context) (runError <-chan error, err error) {
@@ -14,8 +16,19 @@ func (s *Service) Start(ctx context.Context) (runError <-chan error, err error)
}
s.logger.Info("starting")
port, err := s.settings.PortForwarder.PortForward(ctx, s.client, s.logger,
s.settings.Gateway, s.settings.ServerName)
gateway, err := s.routing.VPNLocalGatewayIP(s.settings.Interface)
if err != nil {
return nil, fmt.Errorf("getting VPN local gateway IP: %w", err)
}
obj := utils.PortForwardObjects{
Logger: s.logger,
Gateway: gateway,
Client: s.client,
ServerName: s.settings.ServerName,
}
port, err := s.settings.PortForwarder.PortForward(ctx, obj)
if err != nil {
return nil, fmt.Errorf("port forwarding for the first time: %w", err)
}
@@ -43,18 +56,17 @@ func (s *Service) Start(ctx context.Context) (runError <-chan error, err error)
keepPortDoneCh := make(chan struct{})
s.keepPortDoneCh = keepPortDoneCh
go func(ctx context.Context, settings Settings, port uint16,
runError chan<- error, doneCh chan<- struct{}) {
go func(ctx context.Context, portForwarder PortForwarder,
obj utils.PortForwardObjects, runError chan<- error, doneCh chan<- struct{}) {
defer close(doneCh)
err = settings.PortForwarder.KeepPortForward(ctx, port,
settings.Gateway, settings.ServerName, s.logger)
err = portForwarder.KeepPortForward(ctx, obj)
crashed := ctx.Err() == nil
if !crashed { // stopped by Stop call
return
}
_ = s.cleanup()
runError <- err
}(keepPortCtx, s.settings, port, runErrorCh, keepPortDoneCh)
}(keepPortCtx, s.settings.PortForwarder, obj, runErrorCh, keepPortDoneCh)
return runErrorCh, nil
}