feat(providers): add AirVPN support (#1145)

internal/provider/airvpn/updater/api.go

@@ -0,0 +1,65 @@
+package updater
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"net"
+	"net/http"
+
+	"github.com/qdm12/gluetun/internal/provider/common"
+)
+
+type apiData struct {
+	Servers []apiServer `json:"servers"`
+}
+
+type apiServer struct {
+	PublicName  string `json:"public_name"`
+	CountryName string `json:"country_name"`
+	CountryCode string `json:"country_code"`
+	Location    string `json:"location"`
+	Continent   string `json:"continent"`
+	IPv4In1     net.IP `json:"ip_v4_in1"`
+	IPv4In2     net.IP `json:"ip_v4_in2"`
+	IPv4In3     net.IP `json:"ip_v4_in3"`
+	IPv4In4     net.IP `json:"ip_v4_in4"`
+	IPv6In1     net.IP `json:"ip_v6_in1"`
+	IPv6In2     net.IP `json:"ip_v6_in2"`
+	IPv6In3     net.IP `json:"ip_v6_in3"`
+	IPv6In4     net.IP `json:"ip_v6_in4"`
+	Health      string `json:"health"`
+}
+
+func fetchAPI(ctx context.Context, client *http.Client) (
+	data apiData, err error) {
+	const url = "https://airvpn.org/api/status/"
+
+	request, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
+	if err != nil {
+		return data, fmt.Errorf("creating HTTP request: %w", err)
+	}
+
+	response, err := client.Do(request)
+	if err != nil {
+		return data, fmt.Errorf("doing HTTP request: %w", err)
+	}
+
+	if response.StatusCode != http.StatusOK {
+		_ = response.Body.Close()
+		return data, fmt.Errorf("%w: %d %s",
+			common.ErrHTTPStatusCodeNotOK, response.StatusCode, response.Status)
+	}
+
+	decoder := json.NewDecoder(response.Body)
+	if err := decoder.Decode(&data); err != nil {
+		_ = response.Body.Close()
+		return data, fmt.Errorf("unmarshaling response body: %w", err)
+	}
+
+	if err := response.Body.Close(); err != nil {
+		return data, fmt.Errorf("closing response body: %w", err)
+	}
+
+	return data, nil
+}

internal/provider/airvpn/updater/servers.go

@@ -0,0 +1,97 @@
+package updater
+
+import (
+	"context"
+	"fmt"
+	"net"
+	"sort"
+
+	"github.com/qdm12/gluetun/internal/constants/vpn"
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/gluetun/internal/provider/common"
+)
+
+func (u *Updater) FetchServers(ctx context.Context, minServers int) (
+	servers []models.Server, err error) {
+	data, err := fetchAPI(ctx, u.client)
+	if err != nil {
+		return nil, fmt.Errorf("fetching API: %w", err)
+	}
+
+	// every API server model has:
+	// - Wireguard server using IPv4In1
+	// - Wiregard server using IPv6In1
+	// - OpenVPN TCP+UDP+SSH+SSL server with tls-auth using IPv4In1 and IPv6In1
+	// - OpenVPN TCP+UDP+SSH+SSL server with tls-auth using IPv4In2 and IPv6In2
+	// - OpenVPN TCP+UDP+SSH+SSL server with tls-crypt using IPv4In3 and IPv6In3
+	// - OpenVPN TCP+UDP+SSH+SSL server with tls-crypt using IPv6In4 and IPv6In4
+	const numberOfServersPerAPIServer = 1 + // Wireguard server using IPv4In1
+		1 + // Wiregard server using IPv6In1
+		4 + // OpenVPN TCP server with tls-auth using IPv4In3, IPv6In3, IPv4In4, IPv6In4
+		4 // OpenVPN UDP server with tls-auth using IPv4In3, IPv6In3, IPv4In4, IPv6In4
+	projectedNumberOfServers := numberOfServersPerAPIServer * len(data.Servers)
+
+	if projectedNumberOfServers < minServers {
+		return nil, fmt.Errorf("%w: %d and expected at least %d",
+			common.ErrNotEnoughServers, projectedNumberOfServers, minServers)
+	}
+
+	servers = make([]models.Server, 0, projectedNumberOfServers)
+	for _, apiServer := range data.Servers {
+		if apiServer.Health != "ok" {
+			continue
+		}
+
+		baseServer := models.Server{
+			ServerName: apiServer.PublicName,
+			Country:    apiServer.CountryName,
+			City:       apiServer.Location,
+			Region:     apiServer.Continent,
+		}
+
+		baseWireguardServer := baseServer
+		baseWireguardServer.VPN = vpn.Wireguard
+		baseWireguardServer.WgPubKey = "PyLCXAQT8KkM4T+dUsOQfn+Ub3pGxfGlxkIApuig+hk="
+
+		ipv4WireguadServer := baseWireguardServer
+		ipv4WireguadServer.IPs = []net.IP{apiServer.IPv4In1}
+		ipv4WireguadServer.Hostname = apiServer.CountryCode + ".vpn.airdns.org"
+		servers = append(servers, ipv4WireguadServer)
+
+		ipv6WireguadServer := baseWireguardServer
+		ipv6WireguadServer.IPs = []net.IP{apiServer.IPv6In1}
+		ipv6WireguadServer.Hostname = apiServer.CountryCode + ".ipv6.vpn.airdns.org"
+		servers = append(servers, ipv6WireguadServer)
+
+		baseOpenVPNServer := baseServer
+		baseOpenVPNServer.VPN = vpn.OpenVPN
+		baseOpenVPNServer.UDP = true
+		baseOpenVPNServer.TCP = true
+
+		// Ignore IPs 1 and 2 since tls-crypt is superior to tls-auth really.
+
+		ipv4In3OpenVPNServer := baseOpenVPNServer
+		ipv4In3OpenVPNServer.IPs = []net.IP{apiServer.IPv4In3}
+		ipv4In3OpenVPNServer.Hostname = apiServer.CountryCode + "3.vpn.airdns.org"
+		servers = append(servers, ipv4In3OpenVPNServer)
+
+		ipv6In3OpenVPNServer := baseOpenVPNServer
+		ipv6In3OpenVPNServer.IPs = []net.IP{apiServer.IPv6In3}
+		ipv6In3OpenVPNServer.Hostname = apiServer.CountryCode + "3.ipv6.vpn.airdns.org"
+		servers = append(servers, ipv6In3OpenVPNServer)
+
+		ipv4In4OpenVPNServer := baseOpenVPNServer
+		ipv4In4OpenVPNServer.IPs = []net.IP{apiServer.IPv4In4}
+		ipv4In4OpenVPNServer.Hostname = apiServer.CountryCode + "4.vpn.airdns.org"
+		servers = append(servers, ipv4In4OpenVPNServer)
+
+		ipv6In4OpenVPNServer := baseOpenVPNServer
+		ipv6In4OpenVPNServer.IPs = []net.IP{apiServer.IPv6In4}
+		ipv6In4OpenVPNServer.Hostname = apiServer.CountryCode + "4.ipv6.vpn.airdns.org"
+		servers = append(servers, ipv6In4OpenVPNServer)
+	}
+
+	sort.Sort(models.SortableServers(servers))
+
+	return servers, nil
+}

internal/provider/airvpn/updater/updater.go

@@ -0,0 +1,15 @@
+package updater
+
+import (
+	"net/http"
+)
+
+type Updater struct {
+	client *http.Client
+}
+
+func New(client *http.Client) *Updater {
+	return &Updater{
+		client: client,
+	}
+}