Add support and docs for Windows

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.github/workflows/release.yml

@@ -18,13 +18,13 @@ jobs:
         name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: 1.19
+          go-version: "1.22"
       -
         name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v6
         with:
-          version: latest
-          args: release --rm-dist
+          version: '~> v2'
+          args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
           CGO_ENABLED: 0

.goreleaser.yaml

@@ -1,36 +1,39 @@
+# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+# vim: set ts=2 sw=2 tw=0 fo=jcroql
+version: 2
+
 before:
   hooks:
     - go mod tidy
     - go get -v
     - rm -rf dist
 builds:
--
-  env:
+  - env:
       - CGO_ENABLED=0
-  ldflags:
-    - -s -w
     goos:
-    - darwin
       - linux
+      - darwin
+      - windows
     goarch:
       - amd64
       - arm
       - arm64
-archives:
-- replacements:
-    darwin: Darwin
-    linux: Linux
-    amd64: x86_64
+    goarm:
+      - "7"
+    ldflags:
+      - -s -w
+    mod_timestamp: "{{ .CommitTimestamp }}"
 checksum:
-  name_template: 'checksums.txt'
+  name_template: "checksums.txt"
 snapshot:
   name_template: "{{ .Tag }}"
 changelog:
   sort: asc
+  use: github
   filters:
     exclude:
-    - '^docs:'
-    - '^test:'
+      - "^docs:"
+      - "^test:"
 release:
   github:
     owner: davegallant
@@ -38,12 +41,12 @@ release:
 
 # Check https://goreleaser.com/customization/homebrew/
 brews:
-  - homepage: 'https://github.com/davegallant/homebrew-public'
-    description: 'a client for vpngate.net'
-    folder: Formula
+  - homepage: "https://github.com/davegallant/homebrew-public"
+    description: "a client for vpngate.net"
+    directory: Formula
     commit_author:
       name: davegallant
       email: davegallant@gmail.com
-    tap:
+    repository:
       owner: davegallant
       name: homebrew-public

README.md

@@ -6,7 +6,7 @@ This is a client for [vpngate.net](https://www.vpngate.net/).
 
 This client fetches the list of available relay servers provided by vpngate.net, and allows you to filter and connect to a server of your liking.
 
-You can check out your current IP address and region at https://ipinfo.io, or run the following:
+You can check out your current IP address and region at <https://ipinfo.io>, or run the following:
 
 ```shell
 curl ipinfo.io
@@ -14,22 +14,27 @@ curl ipinfo.io
 
 ## Requirements
 
-- [openvpn](https://github.com/OpenVPN/openvpn)
-- macOS or Linux
+- OpenVPN <= 2.5 (configurations on vpngate.net do not seem work on OpenVPN 2.6+)
+- macOS, Linux, or Windows
 
 ## Install
 
-The simplest method of installation is using homebrew. You can also build from source.
+You can install vpngate in a few different ways, and differs slightly depending on your OS.
 
-### from homebrew
+### Homebrew
 
 vpngate can be installed with [homebrew](https://brew.sh/) (ensure that xcode is installed before installing homebrew by running `xcode-select --install`).
 
 ```shell
-
 brew install openvpn davegallant/public/vpngate
 ```
 
+## Windows
+
+On Windows, install OpenVPN 2.5.x from the [official website](https://openvpn.net/community-downloads/).
+
+You must run in the terminal (command prompt) as Administrator in order to be able to run the relevant OpenVPN commands.
+
 ### from source
 
 Ensure that [go](https://golang.org/doc/install) is installed.
@@ -79,6 +84,28 @@ If the country doesn't matter, a random server can be selected:
 sudo vpngate connect --random
 ```
 
+#### Proxy
+
+In some cases, anonymity is necessary to populate the list of available VPN servers.
+
+A proxy is a way to bypass restrictions and in some cases, internet censorship.
+
+##### HTTP/HTTPS
+
+Use the specified HTTP/HTTPS proxy to fetch the server list.
+
+```shell
+sudo vpngate connect --proxy "http://localhost:8080"
+```
+
+##### SOCKS5
+
+Use the specified SOCKS5 proxy to fetch the server list.
+
+```shell
+sudo vpngate connect --socks5 "127.0.0.1:1080"
+```
+
 ## Notes
 
 - I do not maintain any of the servers on vpngate.net (connect to these servers at your own discretion)

cmd/connect.go

@@ -18,13 +18,15 @@ import (
 var (
 	flagRandom      bool
 	flagReconnect   bool
+	flagProxy       string
 	flagSocks5Proxy string
 )
 
 func init() {
 	connectCmd.Flags().BoolVarP(&flagRandom, "random", "r", false, "connect to a random server")
 	connectCmd.Flags().BoolVarP(&flagReconnect, "reconnect", "t", false, "continually attempt to connect to the server")
-	connectCmd.Flags().StringVarP(&flagSocks5Proxy, "socks5", "s", "", "provide a socks5 proxy server to connect through (i.e. 127.0.0.1:1080")
+	connectCmd.Flags().StringVarP(&flagProxy, "proxy", "p", "", "provide a http/https proxy server to make requests through (i.e. http://127.0.0.1:8080)")
+	connectCmd.Flags().StringVarP(&flagSocks5Proxy, "socks5", "s", "", "provide a socks5 proxy server to make requests through (i.e. 127.0.0.1:1080)")
 	rootCmd.AddCommand(connectCmd)
 }
 
@@ -35,7 +37,7 @@ var connectCmd = &cobra.Command{
 	Long:  `Connect to a vpn from a list of relay servers`,
 	Args:  cobra.RangeArgs(0, 1),
 	Run: func(cmd *cobra.Command, args []string) {
-		vpnServers, err := vpn.GetList(flagSocks5Proxy)
+		vpnServers, err := vpn.GetList(flagProxy, flagSocks5Proxy)
 		if err != nil {
 			log.Fatal().Msgf(err.Error())
 			os.Exit(1)

cmd/list.go

@@ -14,6 +14,8 @@ import (
 
 func init() {
 	rootCmd.AddCommand(listCmd)
+	listCmd.Flags().StringVarP(&flagProxy, "proxy", "p", "", "provide a http/https proxy server to make requests through (i.e. http://127.0.0.1:8080)")
+	listCmd.Flags().StringVarP(&flagSocks5Proxy, "socks5", "s", "", "provide a socks5 proxy server to make requests through (i.e. 127.0.0.1:1080)")
 }
 
 var listCmd = &cobra.Command{
@@ -22,7 +24,7 @@ var listCmd = &cobra.Command{
 	Args:  cobra.NoArgs,
 	Run: func(cmd *cobra.Command, args []string) {
 		
-		vpnServers, err := vpn.GetList(flagSocks5Proxy)
+		vpnServers, err := vpn.GetList(flagProxy, flagSocks5Proxy)
 		if err != nil {
 			log.Fatal().Msgf(err.Error())
 			os.Exit(1)

go.mod

@@ -12,7 +12,7 @@ require (
 	github.com/spf13/afero v1.11.0
 	github.com/spf13/cobra v1.8.1
 	github.com/stretchr/testify v1.9.0
-	golang.org/x/net v0.19.0
+	golang.org/x/net v0.27.0
 )
 
 require (
@@ -29,9 +29,9 @@ require (
 	github.com/rivo/uniseg v0.4.4 // indirect
 	github.com/rogpeppe/go-internal v1.9.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	golang.org/x/sys v0.15.0 // indirect
-	golang.org/x/term v0.15.0 // indirect
-	golang.org/x/text v0.14.0 // indirect
+	golang.org/x/sys v0.22.0 // indirect
+	golang.org/x/term v0.22.0 // indirect
+	golang.org/x/text v0.16.0 // indirect
 	gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -82,6 +82,10 @@ golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v
 golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
 golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c=
 golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U=
+golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs=
+golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
+golang.org/x/net v0.27.0 h1:5K3Njcw06/l2y9vpGCSdcxWOYHOUk3dVNGDXN+FvAys=
+golang.org/x/net v0.27.0/go.mod h1:dDi0PyhWNoiUOrAS8uXv/vnScO4wnHQO4mj9fn/RytE=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
@@ -96,16 +100,26 @@ golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc=
 golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
+golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI=
+golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.15.0 h1:y/Oo/a/q3IXu26lQgl04j/gjuBDOBlx7X6Om1j2CPW4=
 golang.org/x/term v0.15.0/go.mod h1:BDl952bC7+uMoWR75FIrCDx79TPU9oHkTZ9yRbYOrX0=
+golang.org/x/term v0.18.0 h1:FcHjZXDMxI8mM3nwhX9HlKop4C0YQvCVCdwYl2wOtE8=
+golang.org/x/term v0.18.0/go.mod h1:ILwASektA3OnRv7amZ1xhE/KTR+u50pbXfZ03+6Nx58=
+golang.org/x/term v0.22.0 h1:BbsgPEJULsl2fV/AT3v15Mjva5yXKQDyKf+TbDz7QJk=
+golang.org/x/term v0.22.0/go.mod h1:F3qCibpT5AMpCRfhfT53vVJwhLtIVHhB9XDjfFvnMI4=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
+golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4=
+golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=

pkg/vpn/client.go

@@ -2,6 +2,7 @@ package vpn
 
 import (
 	"os"
+	"runtime"
 
 	"github.com/davegallant/vpngate/pkg/exec"
 	"github.com/juju/errors"
@@ -28,6 +29,10 @@ func Connect(configPath string) error {
 		}
 	}()
 
-	_, err = exec.Run("openvpn", ".", "--verb", "4", "--log", tmpLogFile.Name(), "--config", configPath)
+	executable := "openvpn"
+	if runtime.GOOS == "windows" {
+		executable = "C:\\Program Files\\OpenVPN\\bin\\openvpn.exe"
+	}
+	_, err = exec.Run(executable, ".", "--verb", "4", "--log", tmpLogFile.Name(), "--config", configPath)
 	return err
 }

pkg/vpn/list.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"io"
 	"net/http"
+	"net/url"
 	"os"
 
 	"github.com/jszwec/csvutil"
@@ -57,7 +58,7 @@ func parseVpnList(r io.Reader) (*[]Server, error) {
 }
 
 // GetList returns a list of vpn servers
-func GetList(socks5Proxy string) (*[]Server, error) {
+func GetList(httpProxy string, socks5Proxy string) (*[]Server, error) {
 	cacheExpired := vpnListCacheIsExpired()
 
 	var servers *[]Server
@@ -78,7 +79,21 @@ func GetList(socks5Proxy string) (*[]Server, error) {
 
 	log.Info().Msg("Fetching the latest server list")
 
-	if socks5Proxy != "" {
+	if httpProxy != "" {
+		proxyURL, err := url.Parse(httpProxy)
+		if err != nil {
+			log.Error().Msgf("Error parsing proxy: %s", err)
+			os.Exit(1)
+		}
+		transport := &http.Transport{
+			Proxy: http.ProxyURL(proxyURL),
+		}
+
+		client = &http.Client{
+			Transport: transport,
+		}
+
+	} else if socks5Proxy != "" {
 		dialer, err := proxy.SOCKS5("tcp", socks5Proxy, nil, proxy.Direct)
 		if err != nil {
 			log.Error().Msgf("Error creating SOCKS5 dialer: %v", err)

pkg/vpn/list_test.go

@@ -9,7 +9,7 @@ import (
 
 // TestGetListReal tests getting the real list of vpn servers
 func TestGetListReal(t *testing.T) {
-	_, err := GetList("")
+	_, err := GetList("", "")
 
 	assert.NoError(t, err)
 }