gluetun/internal/params/params.go

package params

import (
	"net"
	"os"
	"time"

	"github.com/qdm12/gluetun/internal/models"
	"github.com/qdm12/golibs/files"
	"github.com/qdm12/golibs/logging"
	libparams "github.com/qdm12/golibs/params"
	"github.com/qdm12/golibs/verification"
)

// Reader contains methods to obtain parameters
type Reader interface {
	GetVPNSP() (vpnServiceProvider models.VPNProvider, err error)

	// DNS over TLS getters
	GetDNSOverTLS() (DNSOverTLS bool, err error)
	GetDNSOverTLSProviders() (providers []models.DNSProvider, err error)
	GetDNSOverTLSCaching() (caching bool, err error)
	GetDNSOverTLSVerbosity() (verbosityLevel uint8, err error)
	GetDNSOverTLSVerbosityDetails() (verbosityDetailsLevel uint8, err error)
	GetDNSOverTLSValidationLogLevel() (validationLogLevel uint8, err error)
	GetDNSMaliciousBlocking() (blocking bool, err error)
	GetDNSSurveillanceBlocking() (blocking bool, err error)
	GetDNSAdsBlocking() (blocking bool, err error)
	GetDNSUnblockedHostnames() (hostnames []string, err error)
	GetDNSOverTLSPrivateAddresses() (privateAddresses []string, err error)
	GetDNSOverTLSIPv6() (ipv6 bool, err error)
	GetDNSUpdatePeriod() (period time.Duration, err error)
	GetDNSPlaintext() (ip net.IP, err error)
	GetDNSKeepNameserver() (on bool, err error)

	// System
	GetUID() (uid int, err error)
	GetGID() (gid int, err error)
	GetTimezone() (timezone string, err error)
	GetIPStatusFilepath() (filepath models.Filepath, err error)

	// Firewall getters
	GetFirewall() (enabled bool, err error)
	GetExtraSubnets() (extraSubnets []net.IPNet, err error)
	GetVPNInputPorts() (ports []uint16, err error)
	GetFirewallDebug() (debug bool, err error)

	// VPN getters
	GetUser() (s string, err error)
	GetPassword(required bool) (s string, err error)
	GetNetworkProtocol() (protocol models.NetworkProtocol, err error)
	GetOpenVPNVerbosity() (verbosity int, err error)
	GetOpenVPNRoot() (root bool, err error)
	GetTargetIP() (ip net.IP, err error)
	GetOpenVPNCipher() (cipher string, err error)
	GetOpenVPNAuth() (auth string, err error)

	// PIA getters
	GetPortForwarding() (activated bool, err error)
	GetPortForwardingStatusFilepath() (filepath models.Filepath, err error)
	GetPIAEncryptionPreset() (preset string, err error)
	GetPIARegion() (region string, err error)
	GetPIAOldRegion() (region string, err error)

	// Mullvad getters
	GetMullvadCountry() (country string, err error)
	GetMullvadCity() (country string, err error)
	GetMullvadISP() (country string, err error)
	GetMullvadPort() (port uint16, err error)

	// Windscribe getters
	GetWindscribeRegion() (country string, err error)
	GetWindscribePort(protocol models.NetworkProtocol) (port uint16, err error)

	// Surfshark getters
	GetSurfsharkRegion() (country string, err error)

	// Cyberghost getters
	GetCyberghostGroup() (group string, err error)
	GetCyberghostRegion() (region string, err error)
	GetCyberghostClientKey() (clientKey string, err error)

	// Vyprvpn getters
	GetVyprvpnRegion() (region string, err error)

	// NordVPN getters
	GetNordvpnRegion() (region string, err error)
	GetNordvpnNumber() (number uint16, err error)

	// PureVPN getters
	GetPurevpnRegion() (region string, err error)
	GetPurevpnCountry() (country string, err error)
	GetPurevpnCity() (city string, err error)

	// Shadowsocks getters
	GetShadowSocks() (activated bool, err error)
	GetShadowSocksLog() (activated bool, err error)
	GetShadowSocksPort() (port uint16, err error)
	GetShadowSocksPassword() (password string, err error)
	GetShadowSocksMethod() (method string, err error)

	// Tinyproxy getters
	GetTinyProxy() (activated bool, err error)
	GetTinyProxyLog() (models.TinyProxyLogLevel, error)
	GetTinyProxyPort() (port uint16, err error)
	GetTinyProxyUser() (user string, err error)
	GetTinyProxyPassword() (password string, err error)

	// Public IP getters
	GetPublicIPPeriod() (period time.Duration, err error)

	GetVersionInformation() (enabled bool, err error)

	GetUpdaterPeriod() (period time.Duration, err error)
}

type reader struct {
	envParams   libparams.EnvParams
	logger      logging.Logger
	verifier    verification.Verifier
	unsetEnv    func(key string) error
	fileManager files.FileManager
}

// Newreader returns a paramsReadeer object to read parameters from
// environment variables
func NewReader(logger logging.Logger, fileManager files.FileManager) Reader {
	return &reader{
		envParams:   libparams.NewEnvParams(),
		logger:      logger,
		verifier:    verification.NewVerifier(),
		unsetEnv:    os.Unsetenv,
		fileManager: fileManager,
	}
}

// GetVPNSP obtains the VPN service provider to use from the environment variable VPNSP
func (r *reader) GetVPNSP() (vpnServiceProvider models.VPNProvider, err error) {
	s, err := r.envParams.GetValueIfInside("VPNSP", []string{"pia", "private internet access", "private internet access old", "mullvad", "windscribe", "surfshark", "cyberghost", "vyprvpn", "nordvpn", "purevpn"})
	if s == "pia" {
		s = "private internet access"
	}
	return models.VPNProvider(s), err
}

func (r *reader) GetVersionInformation() (enabled bool, err error) {
	return r.envParams.GetOnOff("VERSION_INFORMATION", libparams.Default("on"))
}