Fix: install latest apk-tools before using apk

.devcontainer/Dockerfile

@@ -1,2 +1 @@
 FROM qmcgaw/godevcontainer
-RUN apk add wireguard-tools htop openssl

.devcontainer/README.md

@@ -9,21 +9,17 @@ It works on Linux, Windows and OSX.
 - [VS code](https://code.visualstudio.com/download) installed
 - [VS code remote containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed
 - [Docker](https://www.docker.com/products/docker-desktop) installed and running
+    - If you don't use Linux or WSL 2, share your home directory `~/` and the directory of your project with Docker Desktop
 - [Docker Compose](https://docs.docker.com/compose/install/) installed
+- Ensure your host has the following and that they are accessible by Docker:
+    - `~/.ssh` directory
+    - `~/.gitconfig` file (can be empty)
 
 ## Setup
 
-1. Create the following files on your host if you don't have them:
-
-    ```sh
-    touch ~/.gitconfig ~/.zsh_history
-    ```
-
-    Note that the development container will create the empty directories `~/.docker`, `~/.ssh` and `~/.kube` if you don't have them.
-
-1. **For Docker on OSX or Windows without WSL**: ensure your home directory `~` is accessible by Docker.
 1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P).
 1. Select `Remote-Containers: Open Folder in Container...` and choose the project directory.
+1. For Docker running on Windows HyperV, if you want to use SSH keys, bind mount them at `/tmp/.ssh` by changing the `volumes` section in the [docker-compose.yml](docker-compose.yml).
 
 ## Customization
 
@@ -33,9 +29,13 @@ You can make changes to the [Dockerfile](Dockerfile) and then rebuild the image.
 
 ```Dockerfile
 FROM qmcgaw/godevcontainer
+USER root
 RUN apk add curl
+USER vscode
 ```
 
+Note that you may need to use `USER root` to build as root, and then change back to `USER vscode`.
+
 To rebuild the image, either:
 
 - With VSCode through the command palette, select `Remote-Containers: Rebuild and reopen in container`
@@ -47,11 +47,11 @@ You can customize **settings** and **extensions** in the [devcontainer.json](dev
 
 ### Entrypoint script
 
-You can bind mount a shell script to `/root/.welcome.sh` to replace the [current welcome script](https://github.com/qdm12/godevcontainer/blob/master/shell/.welcome.sh).
+You can bind mount a shell script to `/home/vscode/.welcome.sh` to replace the [current welcome script](shell/.welcome.sh).
 
 ### Publish a port
 
-To access a port from your host to your development container, publish a port in [docker-compose.yml](docker-compose.yml). You can also now do it directly with VSCode without restarting the container.
+To access a port from your host to your development container, publish a port in [docker-compose.yml](docker-compose.yml).
 
 ### Run other services
 

.devcontainer/devcontainer.json

@@ -1,73 +1,81 @@
-{
+{
-    "name": "gluetun-dev",
+    "name": "gluetun-dev",
-    "dockerComposeFile": [
+    "dockerComposeFile": [
-        "docker-compose.yml"
+        "docker-compose.yml"
-    ],
+    ],
-    "service": "vscode",
+    "service": "vscode",
-    "runServices": [
+    "runServices": [
-        "vscode"
+        "vscode"
-    ],
+    ],
-    "shutdownAction": "stopCompose",
+    "shutdownAction": "stopCompose",
-    "postCreateCommand": "~/.windows.sh && go mod download && go mod tidy",
+    "postCreateCommand": "source ~/.windows.sh && go mod download && go mod tidy",
-    "workspaceFolder": "/workspace",
+    "workspaceFolder": "/workspace",
-    // "overrideCommand": "",
+    "extensions": [
-    "customizations": {
+        "golang.go",
-        "vscode": {
+        "eamodio.gitlens", // IDE Git information
-            "extensions": [
+        "davidanson.vscode-markdownlint",
-                "golang.go",
+        "ms-azuretools.vscode-docker", // Docker integration and linting
-                "eamodio.gitlens", // IDE Git information
+        "shardulm94.trailing-spaces", // Show trailing spaces
-                "davidanson.vscode-markdownlint",
+        "Gruntfuggly.todo-tree", // Highlights TODO comments
-                "ms-azuretools.vscode-docker", // Docker integration and linting
+        "bierner.emojisense", // Emoji sense for markdown
-                "shardulm94.trailing-spaces", // Show trailing spaces
+        "stkb.rewrap", // rewrap comments after n characters on one line
-                "Gruntfuggly.todo-tree", // Highlights TODO comments
+        "vscode-icons-team.vscode-icons", // Better file extension icons
-                "bierner.emojisense", // Emoji sense for markdown
+        "github.vscode-pull-request-github", // Github interaction
-                "stkb.rewrap", // rewrap comments after n characters on one line
+        "redhat.vscode-yaml", // Kubernetes, Drone syntax highlighting
-                "vscode-icons-team.vscode-icons", // Better file extension icons
+        "bajdzis.vscode-database", // Supports connections to mysql or postgres, over SSL, socked
-                "github.vscode-pull-request-github", // Github interaction
+        "IBM.output-colorizer", // Colorize your output/test logs
-                "redhat.vscode-yaml", // Kubernetes, Drone syntax highlighting
+        "mohsen1.prettify-json", // Prettify JSON data
-                "bajdzis.vscode-database", // Supports connections to mysql or postgres, over SSL, socked
+    ],
-                "IBM.output-colorizer", // Colorize your output/test logs
+    "settings": {
-                "github.copilot" // AI code completion
+        "files.eol": "\n",
-            ],
+        "remote.extensionKind": {
-            "settings": {
+            "ms-azuretools.vscode-docker": "workspace"
-                "files.eol": "\n",
+        },
-                "remote.extensionKind": {
+        "editor.codeActionsOnSaveTimeout": 3000,
-                    "ms-azuretools.vscode-docker": "workspace"
+        "go.useLanguageServer": true,
-                },
+        "[go]": {
-                "go.useLanguageServer": true,
+            "editor.formatOnSave": true,
-                "[go]": {
+            "editor.codeActionsOnSave": {
-                    "editor.codeActionsOnSave": {
+                "source.organizeImports": true,
-                        "source.organizeImports": true
+            },
-                    }
+            // Optional: Disable snippets, as they conflict with completion ranking.
-                },
+            "editor.snippetSuggestions": "none"
-                "[go.mod]": {
+        },
-                    "editor.codeActionsOnSave": {
+        "[go.mod]": {
-                        "source.organizeImports": true
+            "editor.formatOnSave": true,
-                    }
+            "editor.codeActionsOnSave": {
-                },
+                "source.organizeImports": true,
-                "gopls": {
+            },
-                    "usePlaceholders": false,
+        },
-                    "staticcheck": true
+        "gopls": {
-                },
+            "usePlaceholders": false,
-                "go.lintTool": "golangci-lint",
+            "staticcheck": true
-                "go.lintOnSave": "package",
+        },
-                "editor.formatOnSave": true,
+        "go.autocompleteUnimportedPackages": true,
-                "go.buildTags": "linux",
+        "go.gotoSymbol.includeImports": true,
-                "go.toolsEnvVars": {
+        "go.gotoSymbol.includeGoroot": true,
-                    "CGO_ENABLED": "0"
+        "go.lintTool": "golangci-lint",
-                },
+        "go.buildOnSave": "workspace",
-                "go.testEnvVars": {
+        "go.lintOnSave": "workspace",
-                    "CGO_ENABLED": "1"
+        "go.vetOnSave": "workspace",
-                },
+        "editor.formatOnSave": true,
-                "go.testFlags": [
+        "go.toolsEnvVars": {
-                    "-v",
+            "GOFLAGS": "-tags=",
-                    "-race"
+            // "CGO_ENABLED": 1 // for the race detector
-                ],
+        },
-                "go.testTimeout": "10s",
+        "gopls.env": {
-                "go.coverOnSingleTest": true,
+            "GOFLAGS": "-tags="
-                "go.coverOnSingleTestFile": true,
+        },
-                "go.coverOnTestPackage": true
+        "go.testEnvVars": {
-            }
+            "": ""
-        }
+        },
-    }
+        "go.testFlags": [
+            "-v",
+            // "-race"
+        ],
+        "go.testTimeout": "10s",
+        "go.coverOnSingleTest": true,
+        "go.coverOnSingleTestFile": true,
+        "go.coverOnTestPackage": true
+    }
 }

.devcontainer/docker-compose.yml

@@ -1,28 +1,30 @@
-version: "3.7"
+version: "3.7"
-
+
-services:
+services:
-  vscode:
+  vscode:
-    build: .
+    build: .
-    volumes:
+    image: godevcontainer
-      - ../:/workspace
+    volumes:
-      # Docker socket to access Docker server
+      - ../:/workspace
-      - /var/run/docker.sock:/var/run/docker.sock
+      # Docker socket to access Docker server
-      # SSH directory for Linux, OSX and WSL
+      - /var/run/docker.sock:/var/run/docker.sock
-      # On Linux and OSX, a symlink /mnt/ssh <-> ~/.ssh is
+      # Docker configuration
-      # created in the container. On Windows, files are copied
+      - ~/.docker:/root/.docker:z
-      # from /mnt/ssh to ~/.ssh to fix permissions.
+      # SSH directory for Linux, OSX and WSL
-      - ~/.ssh:/mnt/ssh
+      - ~/.ssh:/root/.ssh:z
-      # Shell history persistence
+      # For Windows without WSL, a copy will be made
-      - ~/.zsh_history:/root/.zsh_history
+      # from /tmp/.ssh to ~/.ssh to fix permissions
-      # Git config
+      #- ~/.ssh:/tmp/.ssh:ro
-      - ~/.gitconfig:/root/.gitconfig
+      # Shell history persistence
-    environment:
+      - ~/.zsh_history:/root/.zsh_history:z
-      - TZ=
+      # Git config
-    cap_add:
+      - ~/.gitconfig:/root/.gitconfig:z
-      # For debugging with dlv
+    environment:
-      - SYS_PTRACE
+      - TZ=
-      - NET_ADMIN
+    cap_add:
-    security_opt:
+      # For debugging with dlv
-      # For debugging with dlv
+      - SYS_PTRACE
-      - seccomp:unconfined
+    security_opt:
-    entrypoint: [ "zsh", "-c", "while sleep 1000; do :; done" ]
+      # For debugging with dlv
+      - seccomp:unconfined
+    entrypoint: zsh -c "while sleep 1000; do :; done"

.github/CONTRIBUTING.md

@@ -13,6 +13,6 @@ Contributions are [released](https://help.github.com/articles/github-terms-of-se
 
 ## Resources
 
-- [Gluetun guide on development](https://github.com/qdm12/gluetun-wiki/blob/main/contributing/development.md)
+- [Gluetun guide on development](https://github.com/qdm12/gluetun/wiki/Development)
 - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,45 @@
+---
+name: Bug
+about: Report a bug
+title: 'Bug: FILL THIS TEXT!'
+labels: ":bug: bug"
+assignees: qdm12
+
+---
+
+<!---
+⚠️ Answer the following or I'll insta-close your issue
+-->
+
+**Is this urgent?**: No
+
+**Host OS** (approximate answer is fine too): Ubuntu 18
+
+**CPU arch** or **device name**: amd64
+
+**What VPN provider are you using**:
+
+**What are you using to run your container?**: Docker Compose
+
+**What is the version of the program** (See the line at the top of your logs)
+
+```
+Running version latest built on 2020-03-13T01:30:06Z (commit d0f678c)
+```
+
+**What's the problem** 🤔
+
+That feature doesn't work
+
+**Share your logs... (careful to remove in example tokens)**
+
+```log
+
+PASTE YOUR LOGS
+IN THERE
+
+```
+
+<!---
+💡 You can highlight your code with https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlight
+-->

.github/ISSUE_TEMPLATE/bug.yml

@@ -1,116 +0,0 @@
-name: Bug
-description: Report a bug
-title: "Bug: "
-labels: [":bug: bug"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to fill out this bug report!
-
-        ⚠️ Your issue will be instantly closed as not planned WITHOUT explanation if:
-        - you do not fill out **the title of the issue** ☝️
-        - you do not provide the **Gluetun version** as requested below
-        - you provide **less than 10 lines of logs** as requested below
-  - type: dropdown
-    id: urgent
-    attributes:
-      label: Is this urgent?
-      description: |
-        Is this a critical bug, or do you need this fixed urgently?
-        If this is urgent, note you can use one of the [image tags available](https://github.com/qdm12/gluetun-wiki/blob/main/setup/docker-image-tags.md) if that can help.
-      options:
-        - "No"
-        - "Yes"
-  - type: input
-    id: host-os
-    attributes:
-      label: Host OS
-      description: What is your host OS?
-      placeholder: "Debian Buster"
-  - type: dropdown
-    id: cpu-arch
-    attributes:
-      label: CPU arch
-      description: You can find it on Linux with `uname -m`.
-      options:
-        - x86_64
-        - aarch64
-        - armv7l
-        - "386"
-        - s390x
-        - ppc64le
-  - type: dropdown
-    id: vpn-service-provider
-    attributes:
-      label: VPN service provider
-      options:
-        - AirVPN
-        - Custom
-        - Cyberghost
-        - ExpressVPN
-        - FastestVPN
-        - HideMyAss
-        - IPVanish
-        - IVPN
-        - Mullvad
-        - NordVPN
-        - Privado
-        - Private Internet Access
-        - PrivateVPN
-        - ProtonVPN
-        - PureVPN
-        - SlickVPN
-        - Surfshark
-        - TorGuard
-        - VPNSecure.me
-        - VPNUnlimited
-        - VyprVPN
-        - WeVPN
-        - Windscribe
-    validations:
-      required: true
-  - type: dropdown
-    id: docker
-    attributes:
-      label: What are you using to run the container
-      options:
-        - docker run
-        - docker-compose
-        - Portainer
-        - Kubernetes
-        - Podman
-        - Unraid
-        - Other
-    validations:
-      required: true
-  - type: input
-    id: version
-    attributes:
-      label: What is the version of Gluetun
-      description: |
-        Copy paste the version line at the top of your logs.
-        It MUST be in the form `Running version latest built on 2020-03-13T01:30:06Z (commit d0f678c)`.
-    validations:
-      required: true
-  - type: textarea
-    id: problem
-    attributes:
-      label: "What's the problem 🤔"
-      placeholder: "That feature does not work..."
-    validations:
-      required: true
-  - type: textarea
-    id: logs
-    attributes:
-      label: Share your logs (at least 10 lines)
-      description: No sensitive information is logged out except when running with `LOG_LEVEL=debug`.
-      render: plain text
-    validations:
-      required: true
-  - type: textarea
-    id: config
-    attributes:
-      label: Share your configuration
-      description: Share your configuration such as `docker-compose.yml`. Ensure to remove credentials.
-      render: yml

.github/ISSUE_TEMPLATE/config.yml

@@ -1,10 +0,0 @@
-contact_links:
-  - name: Report a Wiki issue
-    url: https://github.com/qdm12/gluetun-wiki/issues/new
-    about: Please create an issue on the gluetun-wiki repository.
-  - name: Configuration help?
-    url: https://github.com/qdm12/gluetun/discussions/new
-    about: Please create a Github discussion.
-  - name: Unraid template issue
-    url: https://github.com/qdm12/gluetun/discussions/550
-    about: Please read the relevant Github discussion.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest a feature to add to this project
+title: 'Feature request: FILL THIS TEXT!'
+labels: ":bulb: feature request"
+assignees: qdm12
+
+---
+
+**What's the feature?** 🧐
+
+- Support this new feature because that and that
+
+**Optional extra information** 🚀
+
+- I tried `docker run something` and it doesn't work
+- That [url](https://github.com/qdm12/gluetun) is interesting

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,19 +0,0 @@
-name: Feature request
-description: Suggest a feature to add to Gluetun
-title: "Feature request: "
-labels: [":bulb: feature request"]
-body:
-  - type: textarea
-    id: description
-    attributes:
-      label: "What's the feature 🧐"
-      placeholder: "Make the tunnel resistant to earth quakes"
-    validations:
-      required: true
-  - type: textarea
-    id: extra
-    attributes:
-      label: "Extra information and references"
-      placeholder: |
-        - I tried `docker run something` and it doesn't work
-        - That [url](https://github.com/qdm12/gluetun) is interesting

.github/ISSUE_TEMPLATE/help.md

@@ -0,0 +1,67 @@
+---
+name: Help
+about: Ask for help
+title: 'Help: FILL THIS TEXT!'
+labels: ":pray: help wanted"
+assignees:
+
+---
+
+<!---
+⚠️ If this about a Docker configuration problem or another service:
+Start a discussion at https://github.com/qdm12/gluetun/discussions/new
+OR I WILL INSTA-CLOSE YOUR ISSUE.
+-->
+
+<!---
+⚠️ Answer the following or I'll insta-close your issue
+-->
+
+**Is this urgent?**: No
+
+**Host OS** (approximate answer is fine too): Ubuntu 18
+
+**CPU arch** or **device name**: amd64
+
+**What VPN provider are you using**:
+
+**What is the version of the program** (See the line at the top of your logs)
+
+```
+Running version latest built on 2020-03-13T01:30:06Z (commit d0f678c)
+```
+
+**What's the problem** 🤔
+
+That feature doesn't work
+
+**Share your logs... (careful to remove in example tokens)**
+
+```log
+
+PASTE YOUR LOGS
+IN THERE
+
+```
+
+**What are you using to run your container?**: Docker Compose
+
+<!---
+💡 You can highlight your code with https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlight
+-->
+
+Please also share your configuration file:
+
+```yml
+your .yml
+content
+in here
+```
+
+or
+
+```sh
+# your docker
+# run command
+# in here
+```

.github/ISSUE_TEMPLATE/provider.md

@@ -14,4 +14,4 @@ One of the following is required:
 
 If the list of servers requires to login **or** is hidden behind an interactive configurator,
 you can only use a custom Openvpn configuration file.
-[The Wiki's OpenVPN configuration file page](https://github.com/qdm12/gluetun-wiki/blob/main/setup/openvpn-configuration-file.md) describes how to do so.
+[The Wiki](https://github.com/qdm12/gluetun/wiki/Openvpn-file) describes how to do so.

.github/labels.yml

@@ -1,34 +1,20 @@
-# Temporary status
+- name: "Bug :bug:"
-- name: "🗯️ Waiting for feedback"
+  color: "b60205"
-  color: "aadefa"
   description: ""
-- name: "🔴 Blocked"
+- name: "Feature request :bulb:"
-  color: "ff3f14"
+  color: "0e8a16"
-  description: "Blocked by another issue or pull request"
-- name: "🔒 After next release"
-  color: "e8f274"
-  description: "Will be done after the next release"
-
-# Priority
-- name: "🚨 Urgent"
-  color: "d5232f"
   description: ""
-- name: "💤 Low priority"
+- name: "Help wanted :pray:"
-  color: "4285f4"
+  color: "4caf50"
   description: ""
-
+- name: "Documentation :memo:"
-# Complexity
+  color: "c5def5"
-- name: "☣️ Hard to do"
-  color: "7d0008"
   description: ""
-- name: "🟩 Easy to do"
+- name: "Needs more info :thinking:"
-  color: "34cf43"
+  color: "795548"
   description: ""
 
 # VPN providers
-- name: ":cloud: AirVPN"
-  color: "cfe8d4"
-  description: ""
 - name: ":cloud: Cyberghost"
   color: "cfe8d4"
   description: ""
@@ -41,9 +27,6 @@
 - name: ":cloud: IVPN"
   color: "cfe8d4"
   description: ""
-- name: ":cloud: ExpressVPN"
-  color: "cfe8d4"
-  description: ""
 - name: ":cloud: FastestVPN"
   color: "cfe8d4"
   description: ""
@@ -53,9 +36,6 @@
 - name: ":cloud: NordVPN"
   color: "cfe8d4"
   description: ""
-- name: ":cloud: Perfect Privacy"
-  color: "cfe8d4"
-  description: ""
 - name: ":cloud: PIA"
   color: "cfe8d4"
   description: ""
@@ -70,55 +50,32 @@
 - name: ":cloud: PureVPN"
   color: "cfe8d4"
   description: ""
-- name: ":cloud: SlickVPN"
-  color: "cfe8d4"
-  description: ""
 - name: ":cloud: Surfshark"
   color: "cfe8d4"
   description: ""
 - name: ":cloud: Torguard"
   color: "cfe8d4"
   description: ""
-- name: ":cloud: VPNSecure.me"
-  color: "cfe8d4"
 - name: ":cloud: VPNUnlimited"
   color: "cfe8d4"
   description: ""
 - name: ":cloud: Vyprvpn"
   color: "cfe8d4"
   description: ""
-- name: ":cloud: WeVPN"
-  color: "cfe8d4"
-  description: ""
 - name: ":cloud: Windscribe"
   color: "cfe8d4"
   description: ""
 
 # Problem category
-- name: "Config problem"
-  color: "ffc7ea"
-  description: ""
 - name: "Openvpn"
   color: "ffc7ea"
   description: ""
-- name: "Wireguard"
-  color: "ffc7ea"
-  description: ""
 - name: "Unbound (DNS over TLS)"
   color: "ffc7ea"
   description: ""
 - name: "Firewall"
   color: "ffc7ea"
   description: ""
-- name: "Routing"
-  color: "ffc7ea"
-  description: ""
-- name: "IPv6"
-  color: "ffc7ea"
-  description: ""
-- name: "Port forwarding"
-  color: "ffc7ea"
-  description: ""
 - name: "HTTP proxy"
   color: "ffc7ea"
   description: ""

.github/workflows/ci-skip.yml

@@ -1,35 +0,0 @@
-name: No trigger file paths
-on:
-  push:
-    branches:
-      - master
-    paths-ignore:
-      - .github/workflows/ci.yml
-      - cmd/**
-      - internal/**
-      - pkg/**
-      - .dockerignore
-      - .golangci.yml
-      - Dockerfile
-      - go.mod
-      - go.sum
-  pull_request:
-    paths-ignore:
-      - .github/workflows/ci.yml
-      - cmd/**
-      - internal/**
-      - pkg/**
-      - .dockerignore
-      - .golangci.yml
-      - Dockerfile
-      - go.mod
-      - go.sum
-
-jobs:
-  verify:
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-    steps:
-      - name: No trigger path triggered for required verify workflow.
-        run: exit 0

.github/workflows/ci.yml

@@ -1,22 +1,6 @@
 name: CI
 on:
-  release:
-    types:
-      - published
   push:
-    branches:
-      - master
-    paths:
-      - .github/workflows/ci.yml
-      - cmd/**
-      - internal/**
-      - pkg/**
-      - .dockerignore
-      - .golangci.yml
-      - Dockerfile
-      - go.mod
-      - go.sum
-  pull_request:
     paths:
       - .github/workflows/ci.yml
       - cmd/**
@@ -31,27 +15,16 @@ on:
 jobs:
   verify:
     runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
     env:
       DOCKER_BUILDKIT: "1"
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v2.3.4
-
-      - uses: reviewdog/action-misspell@v1
-        with:
-          locale: "US"
-          level: error
-          exclude: |
-            ./internal/storage/servers.json
-            *.md
 
       - name: Linting
         run: docker build --target lint .
 
-      - name: Mocks check
+      - name: Go mod tidy check
-        run: docker build --target mocks .
+        run: docker build --target tidy .
 
       - name: Build test image
         run: docker build --target test -t test-container .
@@ -63,85 +36,64 @@ jobs:
           -v "$(pwd)/coverage.txt:/tmp/gobuild/coverage.txt" \
           test-container
 
+      - name: Code security analysis
+        uses: snyk/actions/golang@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+
       - name: Build final image
         run: docker build -t final-image .
 
-  codeql:
+      - name: Image security analysis
-    runs-on: ubuntu-latest
+        uses: snyk/actions/docker@master
-    permissions:
+        env:
-      actions: read
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
-      contents: read
-      security-events: write
-    steps:
-      - uses: actions/checkout@v4
-      - uses: github/codeql-action/init@v3
         with:
-          languages: go
+          image: final-image
-      - uses: github/codeql-action/autobuild@v3
-      - uses: github/codeql-action/analyze@v3
 
   publish:
-    if: |
+    needs: [verify]
-      github.repository == 'qdm12/gluetun' &&
-      (
-        github.event_name == 'push' ||
-        github.event_name == 'release' ||
-        (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && github.actor != 'dependabot[bot]')
-      )
-    needs: [verify, codeql]
-    permissions:
-      actions: read
-      contents: read
-      packages: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v2.3.4
 
-      # extract metadata (tags, labels) for Docker
+      - uses: docker/setup-qemu-action@v1
-      # https://github.com/docker/metadata-action
+      - uses: docker/setup-buildx-action@v1
-      - name: Extract Docker metadata
-        id: meta
-        uses: docker/metadata-action@v5
-        with:
-          flavor: |
-            latest=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
-          images: |
-            ghcr.io/qdm12/gluetun
-            qmcgaw/gluetun
-            qmcgaw/private-internet-access
-          tags: |
-            type=ref,event=pr
-            type=semver,pattern=v{{major}}.{{minor}}.{{patch}}
-            type=semver,pattern=v{{major}}.{{minor}}
-            type=semver,pattern=v{{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }}
-            type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
 
-      - uses: docker/setup-qemu-action@v3
+      - uses: docker/login-action@v1
-      - uses: docker/setup-buildx-action@v3
-
-      - uses: docker/login-action@v3
         with:
           username: qmcgaw
           password: ${{ secrets.DOCKERHUB_PASSWORD }}
 
-      - uses: docker/login-action@v3
+      - name: Set variables
-        with:
+        id: vars
-          registry: ghcr.io
+        env:
-          username: qdm12
+          EVENT_NAME: ${{ github.event_name }}
-          password: ${{ github.token }}
+        run: |
-
+          BRANCH=${GITHUB_REF#refs/heads/}
-      - name: Short commit
+          TAG=${GITHUB_REF#refs/tags/}
-        id: shortcommit
+          echo ::set-output name=commit::$(git rev-parse --short HEAD)
-        run: echo "::set-output name=value::$(git rev-parse --short HEAD)"
+          echo ::set-output name=created::$(date -u +%Y-%m-%dT%H:%M:%SZ)
+          if [ "$TAG" != "$GITHUB_REF" ]; then
+            echo ::set-output name=version::$TAG
+            echo ::set-output name=platforms::linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/ppc64le
+          elif [ "$BRANCH" = "master" ]; then
+            echo ::set-output name=version::latest
+            echo ::set-output name=platforms::linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/ppc64le
+          else
+            echo ::set-output name=version::$BRANCH
+            echo ::set-output name=platforms::linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/ppc64le
+          fi
 
       - name: Build and push final image
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v2.6.1
         with:
-          platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/ppc64le
+          platforms: ${{ steps.vars.outputs.platforms }}
-          labels: ${{ steps.meta.outputs.labels }}
           build-args: |
-            CREATED=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
+            CREATED=${{ steps.vars.outputs.created }}
-            COMMIT=${{ steps.shortcommit.outputs.value }}
+            COMMIT=${{ steps.vars.outputs.commit }}
-            VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }}
+            VERSION=${{ steps.vars.outputs.version }}
-          tags: ${{ steps.meta.outputs.tags }}
+          tags: |
+            qmcgaw/gluetun:${{ steps.vars.outputs.version }}
+            qmcgaw/private-internet-access:${{ steps.vars.outputs.version }}
           push: true

.github/workflows/dockerhub-description.yml

@@ -0,0 +1,21 @@
+name: Docker Hub description
+on:
+  push:
+    branches: [master]
+    paths:
+      - README.md
+      - .github/workflows/dockerhub-description.yml
+jobs:
+  dockerHubDescription:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.4
+      - name: Docker Hub Description
+        uses: peter-evans/dockerhub-description@v2
+        with:
+          username: qmcgaw
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: qmcgaw/gluetun
+          short-description: Lightweight Swiss-knife VPN client to connect to several VPN providers
+          readme-filepath: README.md

.github/workflows/labels.yml

@@ -7,11 +7,9 @@ on:
       - .github/workflows/labels.yml
 jobs:
   labeler:
-    permissions:
-      issues: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v2.3.4
-      - uses: crazy-max/ghaction-github-labeler@v5
+      - uses: crazy-max/ghaction-github-labeler@v3
         with:
           yaml-file: .github/labels.yml

.github/workflows/markdown-skip.yml

@@ -1,21 +0,0 @@
-name: Markdown
-on:
-  push:
-    branches:
-      - master
-    paths-ignore:
-      - "**.md"
-      - .github/workflows/markdown.yml
-  pull_request:
-    paths-ignore:
-      - "**.md"
-      - .github/workflows/markdown.yml
-
-jobs:
-  markdown:
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-    steps:
-      - name: No trigger path triggered for required markdown workflow.
-        run: exit 0

.github/workflows/markdown.yml

@@ -1,46 +0,0 @@
-name: Markdown
-on:
-  push:
-    branches:
-      - master
-    paths:
-      - "**.md"
-      - .github/workflows/markdown.yml
-  pull_request:
-    paths:
-      - "**.md"
-      - .github/workflows/markdown.yml
-
-jobs:
-  markdown:
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: DavidAnson/markdownlint-cli2-action@v14
-        with:
-          globs: "**.md"
-          config: .markdownlint.json
-
-      - uses: reviewdog/action-misspell@v1
-        with:
-          locale: "US"
-          level: error
-          pattern: |
-            *.md
-
-      - uses: gaurav-nelson/github-action-markdown-link-check@v1
-        with:
-          use-quiet-mode: yes
-
-      - uses: peter-evans/dockerhub-description@v3
-        if: github.repository == 'qdm12/gluetun' && github.event_name == 'push'
-        with:
-          username: qmcgaw
-          password: ${{ secrets.DOCKERHUB_PASSWORD }}
-          repository: qmcgaw/gluetun
-          short-description: Lightweight Swiss-knife VPN client to connect to several VPN providers
-          readme-filepath: README.md

.github/workflows/misspell.yml

@@ -0,0 +1,15 @@
+name: Misspells
+on:
+  pull_request:
+    branches: [master]
+  push:
+    branches: [master]
+jobs:
+  misspell:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.4
+      - uses: reviewdog/action-misspell@v1
+        with:
+          locale: "US"
+          level: error

.golangci.yml

@@ -1,4 +1,6 @@
 linters-settings:
+  maligned:
+    suggest-new: true
   misspell:
     locale: US
 
@@ -7,55 +9,38 @@ issues:
     - path: _test\.go
       linters:
         - dupl
+        - maligned
         - goerr113
-        - containedctx
+    - path: internal/server/
-    - path: "internal\\/server\\/.+\\.go"
       linters:
         - dupl
-    - path: "internal\\/configuration\\/settings\\/.+\\.go"
+    - path: internal/configuration/
       linters:
         - dupl
-    - text: "^mnd: Magic number: 0[0-9]{3}, in <argument> detected$"
+    - path: internal/constants/
-      source: "^.+= os\\.OpenFile\\(.+, .+, 0[0-9]{3}\\)"
+      linters:
+        - dupl
+    - text: "exported: exported var Err*"
+      linters:
+        - revive
+    - text: "mnd: Magic number: 0644*"
       linters:
         - gomnd
-    - text: "^mnd: Magic number: 0[0-9]{3}, in <argument> detected$"
+    - text: "mnd: Magic number: 0400*"
-      source: "^.+= os\\.MkdirAll\\(.+, 0[0-9]{3}\\)"
       linters:
         - gomnd
-    - linters:
-        - lll
-      source: "^//go:generate .+$"
-    - text: "returns interface \\(github\\.com\\/vishvananda\\/netlink\\.Link\\)"
-      linters:
-        - ireturn
-    - path: "internal\\/openvpn\\/pkcs8\\/descbc\\.go"
-      text: "newCipherDESCBCBlock returns interface \\(github\\.com\\/youmark\\/pkcs8\\.Cipher\\)"
-      linters:
-        - ireturn
-
 linters:
+  disable-all: true
   enable:
-    # - cyclop
-    # - errorlint
-    - asasalint
     - asciicheck
-    - bidichk
     - bodyclose
-    - containedctx
+    - deadcode
-    - decorder
     - dogsled
     - dupl
-    - dupword
+    - errcheck
-    - durationcheck
-    - errchkjson
-    - errname
-    - execinquery
     - exhaustive
     - exportloopref
-    - forcetypeassert
     - gci
-    - gocheckcompilerdirectives
     - gochecknoglobals
     - gochecknoinits
     - gocognit
@@ -67,45 +52,34 @@ linters:
     - goheader
     - goimports
     - gomnd
-    - gomoddirectives
     - goprintffuncname
     - gosec
-    - gosmopolitan
+    - gosimple
-    - grouper
+    - govet
     - importas
-    - interfacebloat
+    - ineffassign
-    - ireturn
     - lll
-    - maintidx
-    - makezero
-    - mirror
     - misspell
-    - musttag
     - nakedret
     - nestif
     - nilerr
-    - nilnil
     - noctx
     - nolintlint
-    - nosprintfhostport
-    - paralleltest
     - prealloc
     - predeclared
-    - promlinter
-    - reassign
     - revive
     - rowserrcheck
     - sqlclosecheck
-    - tagalign
+    - staticcheck
-    - tenv
+    - structcheck
     - thelper
     - tparallel
+    - typecheck
     - unconvert
     - unparam
-    - usestdlibvars
+    - unused
-    - wastedassign
+    - varcheck
     - whitespace
-    - zerologlint
 
 run:
   skip-dirs:

.markdownlint.json

@@ -1,3 +0,0 @@
-{
-  "MD013": false
-}

.vscode/extensions.json

@@ -1,8 +0,0 @@
-{
-  // This list should be kept to the strict minimum
-  // to develop this project.
-  "recommendations": [
-    "golang.go",
-    "davidanson.vscode-markdownlint",
-  ],
-}

.vscode/launch.json

@@ -1,35 +0,0 @@
-{
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Update a VPN provider servers data",
-            "type": "go",
-            "request": "launch",
-            "cwd": "${workspaceFolder}",
-            "program": "cmd/gluetun/main.go",
-            "args": [
-                "update",
-                "${input:updateMode}",
-                "-providers",
-                "${input:provider}"
-            ],
-        }
-    ],
-    "inputs": [
-        {
-            "id": "provider",
-            "type": "promptString",
-            "description": "Please enter a provider (or comma separated list of providers)",
-        },
-        {
-            "id": "updateMode",
-            "type": "pickString",
-            "description": "Update mode to use",
-            "options": [
-                "-maintainer",
-                "-enduser"
-            ],
-            "default": "-maintainer"
-        },
-    ]
-}

.vscode/settings.json

@@ -1,29 +0,0 @@
-{
-  // The settings should be kept to the strict minimum
-  // to develop this project.
-  "files.eol": "\n",
-  "editor.formatOnSave": true,
-  "go.buildTags": "linux",
-  "go.toolsEnvVars": {
-    "CGO_ENABLED": "0"
-  },
-  "go.testEnvVars": {
-    "CGO_ENABLED": "1"
-  },
-  "go.testFlags": [
-    "-v",
-    "-race"
-  ],
-  "go.testTimeout": "10s",
-  "go.coverOnSingleTest": true,
-  "go.coverOnSingleTestFile": true,
-  "go.coverOnTestPackage": true,
-  "go.useLanguageServer": true,
-  "[go]": {
-    "editor.codeActionsOnSave": {
-      "source.organizeImports": true
-    }
-  },
-  "go.lintTool": "golangci-lint",
-  "go.lintOnSave": "package"
-}

Dockerfile

@@ -1,22 +1,18 @@
-ARG ALPINE_VERSION=3.18
+ARG ALPINE_VERSION=3.14
-ARG GO_ALPINE_VERSION=3.18
+ARG GO_ALPINE_VERSION=3.13
-ARG GO_VERSION=1.21
+ARG GO_VERSION=1.16
 ARG XCPUTRANSLATE_VERSION=v0.6.0
-ARG GOLANGCI_LINT_VERSION=v1.54.1
+ARG GOLANGCI_LINT_VERSION=v1.41.1
-ARG MOCKGEN_VERSION=v1.6.0
 ARG BUILDPLATFORM=linux/amd64
 
 FROM --platform=${BUILDPLATFORM} qmcgaw/xcputranslate:${XCPUTRANSLATE_VERSION} AS xcputranslate
 FROM --platform=${BUILDPLATFORM} qmcgaw/binpot:golangci-lint-${GOLANGCI_LINT_VERSION} AS golangci-lint
-FROM --platform=${BUILDPLATFORM} qmcgaw/binpot:mockgen-${MOCKGEN_VERSION} AS mockgen
 
 FROM --platform=${BUILDPLATFORM} golang:${GO_VERSION}-alpine${GO_ALPINE_VERSION} AS base
 COPY --from=xcputranslate /xcputranslate /usr/local/bin/xcputranslate
-# Note: findutils needed to have xargs support `-d` flag for mocks stage.
+RUN apk --update add git g++
-RUN apk --update add git g++ findutils
 ENV CGO_ENABLED=0
 COPY --from=golangci-lint /bin /go/bin/golangci-lint
-COPY --from=mockgen /bin /go/bin/mockgen
 WORKDIR /tmp/gobuild
 COPY go.mod go.sum ./
 RUN go mod download
@@ -34,17 +30,14 @@ FROM --platform=${BUILDPLATFORM} base AS lint
 COPY .golangci.yml ./
 RUN golangci-lint run --timeout=10m
 
-FROM --platform=${BUILDPLATFORM} base AS mocks
+FROM --platform=${BUILDPLATFORM} base AS tidy
 RUN git init && \
     git config user.email ci@localhost && \
     git config user.name ci && \
-    git config core.fileMode false && \
+    git add -A && git commit -m ci && \
-    git add -A && \
+    sed -i '/\/\/ indirect/d' go.mod && \
-    git commit -m "snapshot" && \
+    go mod tidy && \
-    grep -lr -E '^// Code generated by MockGen\. DO NOT EDIT\.$' . | xargs -r -d '\n' rm && \
+    git diff --exit-code -- go.mod
-    go generate -run "mockgen" ./... && \
-    git diff --exit-code && \
-    rm -rf .git/
 
 FROM --platform=${BUILDPLATFORM} base AS build
 ARG TARGETPLATFORM
@@ -73,81 +66,54 @@ LABEL \
     org.opencontainers.image.source="https://github.com/qdm12/gluetun" \
     org.opencontainers.image.title="VPN swiss-knife like client for multiple VPN providers" \
     org.opencontainers.image.description="VPN swiss-knife like client to tunnel to multiple VPN servers using OpenVPN, IPtables, DNS over TLS, Shadowsocks, an HTTP proxy and Alpine Linux"
-ENV VPN_SERVICE_PROVIDER=pia \
+ENV VPNSP=pia \
-    VPN_TYPE=openvpn \
+    VERSION_INFORMATION=on \
-    # Common VPN options
+    PROTOCOL=udp \
-    VPN_ENDPOINT_IP= \
-    VPN_ENDPOINT_PORT= \
-    VPN_INTERFACE=tun0 \
-    # OpenVPN
-    OPENVPN_PROTOCOL=udp \
-    OPENVPN_USER= \
-    OPENVPN_PASSWORD= \
-    OPENVPN_USER_SECRETFILE=/run/secrets/openvpn_user \
-    OPENVPN_PASSWORD_SECRETFILE=/run/secrets/openvpn_password \
     OPENVPN_VERSION=2.5 \
     OPENVPN_VERBOSITY=1 \
     OPENVPN_FLAGS= \
-    OPENVPN_CIPHERS= \
+    OPENVPN_ROOT=yes \
-    OPENVPN_AUTH= \
+    OPENVPN_TARGET_IP= \
-    OPENVPN_PROCESS_USER=root \
+    OPENVPN_IPV6=off \
     OPENVPN_CUSTOM_CONFIG= \
-    # Wireguard
+    TZ= \
-    WIREGUARD_PRIVATE_KEY= \
+    PUID= \
-    WIREGUARD_PRESHARED_KEY= \
+    PGID= \
-    WIREGUARD_PUBLIC_KEY= \
+    PUBLICIP_FILE="/tmp/gluetun/ip" \
-    WIREGUARD_ALLOWED_IPS= \
+    # VPN provider settings
-    WIREGUARD_ADDRESSES= \
+    OPENVPN_USER= \
-    WIREGUARD_MTU=1400 \
+    OPENVPN_PASSWORD= \
-    WIREGUARD_IMPLEMENTATION=auto \
+    USER_SECRETFILE=/run/secrets/openvpn_user \
-    # VPN server filtering
+    PASSWORD_SECRETFILE=/run/secrets/openvpn_password \
-    SERVER_REGIONS= \
+    REGION= \
-    SERVER_COUNTRIES= \
+    COUNTRY= \
-    SERVER_CITIES= \
+    CITY= \
-    SERVER_HOSTNAMES= \
+    PORT= \
-    # # Mullvad only:
+    SERVER_HOSTNAME= \
+    # Mullvad only:
     ISP= \
-    OWNED_ONLY=no \
+    OWNED=no \
-    # # Private Internet Access only:
+    # Private Internet Access only:
-    PRIVATE_INTERNET_ACCESS_OPENVPN_ENCRYPTION_PRESET= \
+    PIA_ENCRYPTION=strong \
-    VPN_PORT_FORWARDING=off \
+    PORT_FORWARDING=off \
-    VPN_PORT_FORWARDING_LISTENING_PORT=0 \
+    PORT_FORWARDING_STATUS_FILE="/tmp/gluetun/forwarded_port" \
-    VPN_PORT_FORWARDING_PROVIDER= \
+    # Cyberghost only:
-    VPN_PORT_FORWARDING_STATUS_FILE="/tmp/gluetun/forwarded_port" \
+    CYBERGHOST_GROUP="Premium UDP Europe" \
-    # # Cyberghost only:
-    OPENVPN_CERT= \
-    OPENVPN_KEY= \
     OPENVPN_CLIENTCRT_SECRETFILE=/run/secrets/openvpn_clientcrt \
     OPENVPN_CLIENTKEY_SECRETFILE=/run/secrets/openvpn_clientkey \
-    # # VPNSecure only:
+    # Nordvpn only:
-    OPENVPN_ENCRYPTED_KEY= \
-    OPENVPN_ENCRYPTED_KEY_SECRETFILE=/run/secrets/openvpn_encrypted_key \
-    OPENVPN_KEY_PASSPHRASE= \
-    OPENVPN_KEY_PASSPHRASE_SECRETFILE=/run/secrets/openvpn_key_passphrase \
-    # # Nordvpn only:
     SERVER_NUMBER= \
-    # # PIA only:
+    # NordVPN and ProtonVPN only:
-    SERVER_NAMES= \
+    SERVER_NAME= \
-    # # ProtonVPN only:
+    # ProtonVPN only:
     FREE_ONLY= \
-    # # Surfshark only:
+    # Openvpn
-    MULTIHOP_ONLY= \
+    OPENVPN_CIPHER= \
-    # # VPN Secure only:
+    OPENVPN_AUTH= \
-    PREMIUM_ONLY= \
-    # Firewall
-    FIREWALL=on \
-    FIREWALL_VPN_INPUT_PORTS= \
-    FIREWALL_INPUT_PORTS= \
-    FIREWALL_OUTBOUND_SUBNETS= \
-    FIREWALL_DEBUG=off \
-    # Logging
-    LOG_LEVEL=info \
     # Health
+    HEALTH_OPENVPN_DURATION_INITIAL=6s \
+    HEALTH_OPENVPN_DURATION_ADDITION=5s \
     HEALTH_SERVER_ADDRESS=127.0.0.1:9999 \
-    HEALTH_TARGET_ADDRESS=cloudflare.com:443 \
-    HEALTH_SUCCESS_WAIT_DURATION=5s \
-    HEALTH_VPN_DURATION_INITIAL=6s \
-    HEALTH_VPN_DURATION_ADDITION=5s \
     # DNS over TLS
     DOT=on \
     DOT_PROVIDERS=cloudflare \
@@ -162,13 +128,18 @@ ENV VPN_SERVICE_PROVIDER=pia \
     BLOCK_ADS=off \
     UNBLOCK= \
     DNS_UPDATE_PERIOD=24h \
-    DNS_ADDRESS=127.0.0.1 \
+    DNS_PLAINTEXT_ADDRESS=1.1.1.1 \
     DNS_KEEP_NAMESERVER=off \
+    # Firewall
+    FIREWALL=on \
+    FIREWALL_VPN_INPUT_PORTS= \
+    FIREWALL_INPUT_PORTS= \
+    FIREWALL_OUTBOUND_SUBNETS= \
+    FIREWALL_DEBUG=off \
     # HTTP proxy
     HTTPPROXY= \
     HTTPPROXY_LOG=off \
-    HTTPPROXY_LISTENING_ADDRESS=":8888" \
+    HTTPPROXY_PORT=8888 \
-    HTTPPROXY_STEALTH=off \
     HTTPPROXY_USER= \
     HTTPPROXY_PASSWORD= \
     HTTPPROXY_USER_SECRETFILE=/run/secrets/httpproxy_user \
@@ -176,44 +147,22 @@ ENV VPN_SERVICE_PROVIDER=pia \
     # Shadowsocks
     SHADOWSOCKS=off \
     SHADOWSOCKS_LOG=off \
-    SHADOWSOCKS_LISTENING_ADDRESS=":8388" \
+    SHADOWSOCKS_PORT=8388 \
     SHADOWSOCKS_PASSWORD= \
     SHADOWSOCKS_PASSWORD_SECRETFILE=/run/secrets/shadowsocks_password \
-    SHADOWSOCKS_CIPHER=chacha20-ietf-poly1305 \
+    SHADOWSOCKS_METHOD=chacha20-ietf-poly1305 \
-    # Control server
+    UPDATER_PERIOD=0
-    HTTP_CONTROL_SERVER_LOG=on \
+ENTRYPOINT ["/entrypoint"]
-    HTTP_CONTROL_SERVER_ADDRESS=":8000" \
-    # Server data updater
-    UPDATER_PERIOD=0 \
-    UPDATER_MIN_RATIO=0.8 \
-    UPDATER_VPN_SERVICE_PROVIDERS= \
-    # Public IP
-    PUBLICIP_FILE="/tmp/gluetun/ip" \
-    PUBLICIP_PERIOD=12h \
-    # Pprof
-    PPROF_ENABLED=no \
-    PPROF_BLOCK_PROFILE_RATE=0 \
-    PPROF_MUTEX_PROFILE_RATE=0 \
-    PPROF_HTTP_SERVER_ADDRESS=":6060" \
-    # Extras
-    VERSION_INFORMATION=on \
-    TZ= \
-    PUID= \
-    PGID=
-ENTRYPOINT ["/gluetun-entrypoint"]
 EXPOSE 8000/tcp 8888/tcp 8388/tcp 8388/udp
-HEALTHCHECK --interval=5s --timeout=5s --start-period=10s --retries=1 CMD /gluetun-entrypoint healthcheck
+HEALTHCHECK --interval=5s --timeout=5s --start-period=10s --retries=1 CMD /entrypoint healthcheck
 ARG TARGETPLATFORM
-RUN apk add --no-cache --update -l wget && \
+RUN apk add --no-cache --update -l apk-tools && \
-    apk add --no-cache --update -X "https://dl-cdn.alpinelinux.org/alpine/v3.17/main" openvpn\~2.5 && \
+    apk add --no-cache --update -X "https://dl-cdn.alpinelinux.org/alpine/v3.12/main" openvpn==2.4.11-r0 && \
-    mv /usr/sbin/openvpn /usr/sbin/openvpn2.5 && \
+    mv /usr/sbin/openvpn /usr/sbin/openvpn2.4 && \
     apk del openvpn && \
     apk add --no-cache --update openvpn ca-certificates iptables ip6tables unbound tzdata && \
-    mv /usr/sbin/openvpn /usr/sbin/openvpn2.6 && \
-    # Fix vulnerability issue
-    apk add --no-cache --update busybox && \
     rm -rf /var/cache/apk/* /etc/unbound/* /usr/sbin/unbound-* /etc/openvpn/*.sh /usr/lib/openvpn/plugins/openvpn-plugin-down-root.so && \
     deluser openvpn && \
     deluser unbound && \
     mkdir /gluetun
-COPY --from=build /tmp/gobuild/entrypoint /gluetun-entrypoint
+COPY --from=build /tmp/gobuild/entrypoint /entrypoint

README.md

@@ -1,130 +1,120 @@
-# Gluetun VPN client
+# Gluetun VPN client
-
+
-Lightweight swiss-knife-like VPN client to multiple VPN service providers
+*Lightweight swiss-knife-like VPN client to tunnel to Cyberghost, FastestVPN,
-
+HideMyAss, IPVanish, IVPN, Mullvad, NordVPN, Privado, Private Internet Access, PrivateVPN,
-![Title image](https://raw.githubusercontent.com/qdm12/gluetun/master/title.svg)
+ProtonVPN, PureVPN, Surfshark, TorGuard, VPNUnlimited, VyprVPN and Windscribe VPN servers
-
+using Go, OpenVPN, iptables, DNS over TLS, ShadowSocks and an HTTP proxy*
-[![Build status](https://github.com/qdm12/gluetun/actions/workflows/ci.yml/badge.svg)](https://github.com/qdm12/gluetun/actions/workflows/ci.yml)
+
-
+**ANNOUNCEMENT**:
-[![Docker pulls qmcgaw/gluetun](https://img.shields.io/docker/pulls/qmcgaw/gluetun.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
+
-[![Docker pulls qmcgaw/private-internet-access](https://img.shields.io/docker/pulls/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
+![Title image](https://raw.githubusercontent.com/qdm12/gluetun/master/title.svg)
-
+
-[![Docker stars qmcgaw/gluetun](https://img.shields.io/docker/stars/qmcgaw/gluetun.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
+[![Build status](https://github.com/qdm12/gluetun/actions/workflows/ci.yml/badge.svg)](https://github.com/qdm12/gluetun/actions/workflows/ci.yml)
-[![Docker stars qmcgaw/private-internet-access](https://img.shields.io/docker/stars/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
+
-
+[![Docker pulls qmcgaw/gluetun](https://img.shields.io/docker/pulls/qmcgaw/gluetun.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
-![Last release](https://img.shields.io/github/release/qdm12/gluetun?label=Last%20release)
+[![Docker pulls qmcgaw/private-internet-access](https://img.shields.io/docker/pulls/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
-![Last Docker tag](https://img.shields.io/docker/v/qmcgaw/gluetun?sort=semver&label=Last%20Docker%20tag)
+
-[![Last release size](https://img.shields.io/docker/image-size/qmcgaw/gluetun?sort=semver&label=Last%20released%20image)](https://hub.docker.com/r/qmcgaw/gluetun/tags?page=1&ordering=last_updated)
+[![Docker stars qmcgaw/gluetun](https://img.shields.io/docker/stars/qmcgaw/gluetun.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
-![GitHub last release date](https://img.shields.io/github/release-date/qdm12/gluetun?label=Last%20release%20date)
+[![Docker stars qmcgaw/private-internet-access](https://img.shields.io/docker/stars/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
-![Commits since release](https://img.shields.io/github/commits-since/qdm12/gluetun/latest?sort=semver)
+
-
+![Last release](https://img.shields.io/github/release/qdm12/gluetun?label=Last%20release)
-[![Latest size](https://img.shields.io/docker/image-size/qmcgaw/gluetun/latest?label=Latest%20image)](https://hub.docker.com/r/qmcgaw/gluetun/tags)
+![Last Docker tag](https://img.shields.io/docker/v/qmcgaw/gluetun?sort=semver&label=Last%20Docker%20tag)
-
+[![Last release size](https://img.shields.io/docker/image-size/qmcgaw/gluetun?sort=semver&label=Last%20released%20image)](https://hub.docker.com/r/qmcgaw/gluetun/tags?page=1&ordering=last_updated)
-[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/commits/master)
+![GitHub last release date](https://img.shields.io/github/release-date/qdm12/gluetun?label=Last%20release%20date)
-[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/graphs/contributors)
+![Commits since release](https://img.shields.io/github/commits-since/qdm12/gluetun/latest?sort=semver)
-[![GitHub closed PRs](https://img.shields.io/github/issues-pr-closed/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/pulls?q=is%3Apr+is%3Aclosed)
+
-[![GitHub issues](https://img.shields.io/github/issues/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues)
+[![Latest size](https://img.shields.io/docker/image-size/qmcgaw/gluetun/latest?label=Latest%20image)](https://hub.docker.com/r/qmcgaw/gluetun/tags)
-[![GitHub closed issues](https://img.shields.io/github/issues-closed/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues?q=is%3Aissue+is%3Aclosed)
+
-
+[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/commits/master)
-[![Lines of code](https://img.shields.io/tokei/lines/github/qdm12/gluetun)](https://github.com/qdm12/gluetun)
+[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/graphs/contributors)
-![Code size](https://img.shields.io/github/languages/code-size/qdm12/gluetun)
+[![GitHub closed PRs](https://img.shields.io/github/issues-pr-closed/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/pulls?q=is%3Apr+is%3Aclosed)
-![GitHub repo size](https://img.shields.io/github/repo-size/qdm12/gluetun)
+[![GitHub issues](https://img.shields.io/github/issues/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues)
-![Go version](https://img.shields.io/github/go-mod/go-version/qdm12/gluetun)
+[![GitHub closed issues](https://img.shields.io/github/issues-closed/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues?q=is%3Aissue+is%3Aclosed)
-
+
-![Visitors count](https://visitor-badge.laobi.icu/badge?page_id=gluetun.readme)
+[![Lines of code](https://img.shields.io/tokei/lines/github/qdm12/gluetun)](https://github.com/qdm12/gluetun)
-
+![Code size](https://img.shields.io/github/languages/code-size/qdm12/gluetun)
-## Quick links
+![GitHub repo size](https://img.shields.io/github/repo-size/qdm12/gluetun)
-
+![Go version](https://img.shields.io/github/go-mod/go-version/qdm12/gluetun)
-- [Setup](#setup)
+
-- [Features](#features)
+![Visitors count](https://visitor-badge.laobi.icu/badge?page_id=gluetun.readme)
-- Problem?
+
-  - Check the Wiki [common errors](https://github.com/qdm12/gluetun-wiki/tree/main/errors) and [faq](https://github.com/qdm12/gluetun-wiki/tree/main/faq)
+## Quick links
-  - [Start a discussion](https://github.com/qdm12/gluetun/discussions)
+
-  - [Fix the Unraid template](https://github.com/qdm12/gluetun/discussions/550)
+- Problem or suggestion?
-- Suggestion?
+  - [Start a discussion](https://github.com/qdm12/gluetun/discussions)
-  - [Create an issue](https://github.com/qdm12/gluetun/issues)
+  - [Create an issue](https://github.com/qdm12/gluetun/issues)
-- Happy?
+  - [Check the Wiki](https://github.com/qdm12/gluetun/wiki)
-  - Sponsor me on [github.com/sponsors/qdm12](https://github.com/sponsors/qdm12)
+  - [Join the Slack channel](https://join.slack.com/t/qdm12/shared_invite/enQtOTE0NjcxNTM1ODc5LTYyZmVlOTM3MGI4ZWU0YmJkMjUxNmQ4ODQ2OTAwYzMxMTlhY2Q1MWQyOWUyNjc2ODliNjFjMDUxNWNmNzk5MDk)
-  - Donate to [paypal.me/qmcgaw](https://www.paypal.me/qmcgaw)
+- Happy?
-  - Drop me [an email](mailto:quentin.mcgaw@gmail.com)
+  - Sponsor me on [github.com/sponsors/qdm12](https://github.com/sponsors/qdm12)
-- **Want to add a VPN provider?** check [the development page](https://github.com/qdm12/gluetun-wiki/blob/main/contributing/development.md) and [add a provider page](https://github.com/qdm12/gluetun-wiki/blob/main/contributing/add-a-provider.md)
+  - Donate to [paypal.me/qmcgaw](https://www.paypal.me/qmcgaw)
-- Video:
+  - Drop me [an email](mailto:quentin.mcgaw@gmail.com)
-
+- Video:
-  [![Video Gif](https://i.imgur.com/CetWunc.gif)](https://youtu.be/0F6I03LQcI4)
+
-
+  [![Video Gif](https://i.imgur.com/CetWunc.gif)](https://youtu.be/0F6I03LQcI4)
-- [Substack Console interview](https://console.substack.com/p/console-72)
+
-
+## Features
-## Features
+
-
+- Based on Alpine 3.13 for a small Docker image of 54MB
-- Based on Alpine 3.18 for a small Docker image of 35.6MB
+- Supports: **Cyberghost**, **FastestVPN**, **HideMyAss**, **IPVanish**, **IVPN**, **Mullvad**, **NordVPN**, **Privado**, **Private Internet Access**, **PrivateVPN**, **ProtonVPN**, **PureVPN**,  **Surfshark**, **TorGuard**, **VPNUnlimited**, **Vyprvpn**, **Windscribe** servers
-- Supports: **AirVPN**, **Cyberghost**, **ExpressVPN**, **FastestVPN**, **HideMyAss**, **IPVanish**, **IVPN**, **Mullvad**, **NordVPN**, **Perfect Privacy**, **Privado**, **Private Internet Access**, **PrivateVPN**, **ProtonVPN**, **PureVPN**,  **SlickVPN**, **Surfshark**, **TorGuard**, **VPNSecure.me**, **VPNUnlimited**, **Vyprvpn**, **WeVPN**, **Windscribe** servers
+- Supports Openvpn only for now
-- Supports OpenVPN for all providers listed
+- DNS over TLS baked in with service provider(s) of your choice
-- Supports Wireguard both kernelspace and userspace
+- DNS fine blocking of malicious/ads/surveillance hostnames and IP addresses, with live update every 24 hours
-  - For **AirVPN**, **Ivpn**, **Mullvad**, **NordVPN**, **Surfshark** and **Windscribe**
+- Choose the vpn network protocol, `udp` or `tcp`
-  - For **ProtonVPN**, **PureVPN**, **Torguard**, **VPN Unlimited** and **WeVPN** using [the custom provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md)
+- Built in firewall kill switch to allow traffic only with needed the VPN servers and LAN devices
-  - For custom Wireguard configurations using [the custom provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md)
+- Built in Shadowsocks proxy (protocol based on SOCKS5 with an encryption layer, tunnels TCP+UDP)
-  - More in progress, see [#134](https://github.com/qdm12/gluetun/issues/134)
+- Built in HTTP proxy (tunnels HTTP and HTTPS through TCP)
-- DNS over TLS baked in with service provider(s) of your choice
+- [Connect other containers to it](https://github.com/qdm12/gluetun/wiki/Connect-to-gluetun)
-- DNS fine blocking of malicious/ads/surveillance hostnames and IP addresses, with live update every 24 hours
+- [Connect LAN devices to it](https://github.com/qdm12/gluetun/wiki/Connect-to-gluetun)
-- Choose the vpn network protocol, `udp` or `tcp`
+- Compatible with amd64, i686 (32 bit), **ARM** 64 bit, ARM 32 bit v6 and v7, and even ppc64le 🎆
-- Built in firewall kill switch to allow traffic only with needed the VPN servers and LAN devices
+- VPN server side port forwarding for Private Internet Access and Vyprvpn
-- Built in Shadowsocks proxy (protocol based on SOCKS5 with an encryption layer, tunnels TCP+UDP)
+- Possibility of split horizon DNS by selecting multiple DNS over TLS providers
-- Built in HTTP proxy (tunnels HTTP and HTTPS through TCP)
+- Subprograms all drop root privileges once launched
-- [Connect other containers to it](https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-container-to-gluetun.md)
+- Subprograms output streams are all merged together
-- [Connect LAN devices to it](https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-lan-device-to-gluetun.md)
+- Can work as a Kubernetes sidecar container, thanks @rorph
-- Compatible with amd64, i686 (32 bit), **ARM** 64 bit, ARM 32 bit v6 and v7, and even ppc64le 🎆
+
-- [Custom VPN server side port forwarding for Private Internet Access](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/private-internet-access.md#vpn-server-port-forwarding)
+## Setup
-- Possibility of split horizon DNS by selecting multiple DNS over TLS providers
+
-- Unbound subprogram drops root privileges once launched
+1. Ensure your `tun` kernel module is setup:
-- Can work as a Kubernetes sidecar container, thanks @rorph
+
-
+    ```sh
-## Setup
+    sudo modprobe tun
-
+    # or, if you don't have modprobe, with
-🎉 There are now instructions specific to each VPN provider with examples to help you get started as quickly as possible!
+    sudo insmod /lib/modules/tun.ko
-
+    ```
-Go to the [Wiki](https://github.com/qdm12/gluetun-wiki)!
+
-
+1. Extra steps:
-[🐛 Found a bug in the Wiki?!](https://github.com/qdm12/gluetun-wiki/issues/new)
+    - [For Synology users](https://github.com/qdm12/gluetun/wiki/Synology-setup)
-
+    - [For 32 bit Operating systems (**Rasberry Pis**)](https://github.com/qdm12/gluetun/wiki/32-bit-setup)
-Here's a docker-compose.yml for the laziest:
+1. Launch the container with:
-
+
-```yml
+    ```bash
-version: "3"
+    docker run -d --name gluetun --cap-add=NET_ADMIN \
-services:
+    -e VPNSP="private internet access" -e REGION="CA Montreal" \
-  gluetun:
+    -e OPENVPN_USER=js89ds7 -e OPENVPN_PASSWORD=8fd9s239G \
-    image: qmcgaw/gluetun
+    -v /yourpath:/gluetun \
-    # container_name: gluetun
+    qmcgaw/gluetun
-    # line above must be uncommented to allow external containers to connect.
+    ```
-    # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-container-to-gluetun.md#external-container-to-gluetun
+
-    cap_add:
+    or use [docker-compose.yml](https://github.com/qdm12/gluetun/blob/master/docker-compose.yml) with:
-      - NET_ADMIN
+
-    devices:
+    ```bash
-      - /dev/net/tun:/dev/net/tun
+    docker-compose up -d
-    ports:
+    ```
-      - 8888:8888/tcp # HTTP proxy
+
-      - 8388:8388/tcp # Shadowsocks
+    You should probably check the many [environment variables](https://github.com/qdm12/gluetun/wiki/Environment-variables) available to adapt the container to your needs.
-      - 8388:8388/udp # Shadowsocks
+
-    volumes:
+## Further setup
-      - /yourpath:/gluetun
+
-    environment:
+The following points are all optional but should give you insights on all the possibilities with this container.
-      # See https://github.com/qdm12/gluetun-wiki/tree/main/setup#setup
+
-      - VPN_SERVICE_PROVIDER=ivpn
+- [Test your setup](https://github.com/qdm12/gluetun/wiki/Test-your-setup)
-      - VPN_TYPE=openvpn
+- [How to connect other containers and devices to Gluetun](https://github.com/qdm12/gluetun/wiki/Connect-to-gluetun)
-      # OpenVPN:
+- [VPN server side port forwarding](https://github.com/qdm12/gluetun/wiki/Port-forwarding)
-      - OPENVPN_USER=
+- [HTTP control server](https://github.com/qdm12/gluetun/wiki/HTTP-Control-server) to automate things, restart Openvpn etc.
-      - OPENVPN_PASSWORD=
+- Update the image with `docker pull qmcgaw/gluetun:latest`. See this [Wiki document](https://github.com/qdm12/gluetun/wiki/Docker-image-tags) for Docker tags available.
-      # Wireguard:
+- Use [Docker secrets](https://github.com/qdm12/gluetun/wiki/Docker-secrets) to read your credentials instead of environment variables
-      # - WIREGUARD_PRIVATE_KEY=wOEI9rqqbDwnN8/Bpp22sVz48T71vJ4fYmFWujulwUU=
+
-      # - WIREGUARD_ADDRESSES=10.64.222.21/32
+## License
-      # Timezone for accurate log times
+
-      - TZ=
+[![MIT](https://img.shields.io/github/license/qdm12/gluetun)](https://github.com/qdm12/gluetun/master/LICENSE)
-      # Server list updater
-      # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/servers.md#update-the-vpn-servers-list
-      - UPDATER_PERIOD=
-```
-
-🆕 Image also available as `ghcr.io/qdm12/gluetun`
-
-## License
-
-[![MIT](https://img.shields.io/github/license/qdm12/gluetun)](https://github.com/qdm12/gluetun/blob/master/LICENSE)

cmd/gluetun/main.go

@@ -4,53 +4,39 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"net"
 	"net/http"
 	"os"
 	"os/signal"
+	"strconv"
 	"strings"
 	"syscall"
 	"time"
-	_ "time/tzdata"
 
-	_ "github.com/breml/rootcerts"
 	"github.com/qdm12/dns/pkg/unbound"
 	"github.com/qdm12/gluetun/internal/alpine"
 	"github.com/qdm12/gluetun/internal/cli"
-	"github.com/qdm12/gluetun/internal/configuration/settings"
+	"github.com/qdm12/gluetun/internal/configuration"
-	"github.com/qdm12/gluetun/internal/configuration/sources/env"
-	"github.com/qdm12/gluetun/internal/configuration/sources/files"
-	mux "github.com/qdm12/gluetun/internal/configuration/sources/merge"
-	"github.com/qdm12/gluetun/internal/configuration/sources/secrets"
 	"github.com/qdm12/gluetun/internal/constants"
 	"github.com/qdm12/gluetun/internal/dns"
 	"github.com/qdm12/gluetun/internal/firewall"
 	"github.com/qdm12/gluetun/internal/healthcheck"
 	"github.com/qdm12/gluetun/internal/httpproxy"
 	"github.com/qdm12/gluetun/internal/models"
-	"github.com/qdm12/gluetun/internal/netlink"
 	"github.com/qdm12/gluetun/internal/openvpn"
-	"github.com/qdm12/gluetun/internal/openvpn/extract"
-	"github.com/qdm12/gluetun/internal/portforward"
-	"github.com/qdm12/gluetun/internal/pprof"
-	"github.com/qdm12/gluetun/internal/provider"
 	"github.com/qdm12/gluetun/internal/publicip"
-	"github.com/qdm12/gluetun/internal/publicip/ipinfo"
 	"github.com/qdm12/gluetun/internal/routing"
 	"github.com/qdm12/gluetun/internal/server"
 	"github.com/qdm12/gluetun/internal/shadowsocks"
 	"github.com/qdm12/gluetun/internal/storage"
-	"github.com/qdm12/gluetun/internal/tun"
+	"github.com/qdm12/gluetun/internal/unix"
-	updater "github.com/qdm12/gluetun/internal/updater/loop"
+	"github.com/qdm12/gluetun/internal/updater"
-	"github.com/qdm12/gluetun/internal/updater/resolver"
+	versionpkg "github.com/qdm12/gluetun/internal/version"
-	"github.com/qdm12/gluetun/internal/updater/unzip"
-	"github.com/qdm12/gluetun/internal/vpn"
 	"github.com/qdm12/golibs/command"
+	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/golibs/params"
 	"github.com/qdm12/goshutdown"
-	"github.com/qdm12/goshutdown/goroutine"
-	"github.com/qdm12/goshutdown/group"
-	"github.com/qdm12/goshutdown/order"
 	"github.com/qdm12/gosplash"
-	"github.com/qdm12/log"
 	"github.com/qdm12/updated/pkg/dnscrypto"
 )
 
@@ -61,6 +47,11 @@ var (
 	created = "an unknown date"
 )
 
+var (
+	errSetupRouting = errors.New("cannot setup routing")
+	errCreateUser   = errors.New("cannot create user")
+)
+
 func main() {
 	buildInfo := models.BuildInformation{
 		Version: version,
@@ -68,37 +59,31 @@ func main() {
 		Created: created,
 	}
 
-	background := context.Background()
+	ctx := context.Background()
-	signalCh := make(chan os.Signal, 1)
+	ctx, stop := signal.NotifyContext(ctx, syscall.SIGINT, syscall.SIGTERM, os.Interrupt)
-	signal.Notify(signalCh, os.Interrupt, syscall.SIGTERM)
+	ctx, cancel := context.WithCancel(ctx)
-	ctx, cancel := context.WithCancel(background)
 
-	logger := log.New(log.SetLevel(log.LevelInfo))
+	logger := logging.NewParent(logging.Settings{
+		Level: logging.LevelInfo,
+	})
 
 	args := os.Args
-	tun := tun.New()
+	unix := unix.New()
-	netLinkDebugLogger := logger.New(log.SetComponent("netlink"))
-	netLinker := netlink.New(netLinkDebugLogger)
 	cli := cli.New()
+	env := params.NewEnv()
 	cmder := command.NewCmder()
 
-	secretsReader := secrets.New()
-	filesReader := files.New()
-	envReader := env.New(logger)
-	muxReader := mux.New(secretsReader, filesReader, envReader)
-
 	errorCh := make(chan error)
 	go func() {
-		errorCh <- _main(ctx, buildInfo, args, logger, muxReader, tun, netLinker, cmder, cli)
+		errorCh <- _main(ctx, buildInfo, args, logger, env, unix, cmder, cli)
 	}()
 
-	var err error
 	select {
-	case signal := <-signalCh:
+	case <-ctx.Done():
-		fmt.Println("")
+		stop()
-		logger.Warn("Caught OS signal " + signal.String() + ", shutting down")
+		logger.Warn("Caught OS signal, shutting down")
-		cancel()
+	case err := <-errorCh:
-	case err = <-errorCh:
+		stop()
 		close(errorCh)
 		if err == nil { // expected exit such as healthcheck
 			os.Exit(0)
@@ -110,56 +95,54 @@ func main() {
 	const shutdownGracePeriod = 5 * time.Second
 	timer := time.NewTimer(shutdownGracePeriod)
 	select {
-	case shutdownErr := <-errorCh:
+	case <-errorCh:
 		if !timer.Stop() {
 			<-timer.C
 		}
-		if shutdownErr != nil {
-			logger.Warnf("Shutdown not completed gracefully: %s", shutdownErr)
-			os.Exit(1)
-		}
-
 		logger.Info("Shutdown successful")
-		if err != nil {
-			os.Exit(1)
-		}
-		os.Exit(0)
 	case <-timer.C:
 		logger.Warn("Shutdown timed out")
-		os.Exit(1)
-	case signal := <-signalCh:
-		logger.Warn("Caught OS signal " + signal.String() + ", forcing shut down")
-		os.Exit(1)
 	}
+
+	os.Exit(1)
 }
 
 var (
 	errCommandUnknown = errors.New("command is unknown")
 )
 
-//nolint:gocognit,gocyclo,maintidx
+//nolint:gocognit,gocyclo
 func _main(ctx context.Context, buildInfo models.BuildInformation,
-	args []string, logger log.LoggerInterface, source Source,
+	args []string, logger logging.ParentLogger, env params.Env,
-	tun Tun, netLinker netLinker, cmder command.RunStarter,
+	unix unix.Unix, cmder command.RunStarter, cli cli.CLIer) error {
-	cli clier) error {
 	if len(args) > 1 { // cli operation
 		switch args[1] {
 		case "healthcheck":
-			return cli.HealthCheck(ctx, source, logger)
+			return cli.HealthCheck(ctx, env, logger)
 		case "clientkey":
 			return cli.ClientKey(args[2:])
 		case "openvpnconfig":
-			return cli.OpenvpnConfig(logger, source, netLinker)
+			return cli.OpenvpnConfig(logger)
 		case "update":
 			return cli.Update(ctx, args[2:], logger)
-		case "format-servers":
-			return cli.FormatServers(args[2:])
 		default:
 			return fmt.Errorf("%w: %s", errCommandUnknown, args[1])
 		}
 	}
 
-	announcementExp, err := time.Parse(time.RFC3339, "2023-07-01T00:00:00Z")
+	const clientTimeout = 15 * time.Second
+	httpClient := &http.Client{Timeout: clientTimeout}
+	// Create configurators
+	alpineConf := alpine.New()
+	ovpnConf := openvpn.NewConfigurator(
+		logger.NewChild(logging.Settings{Prefix: "openvpn configurator: "}),
+		unix, cmder)
+	dnsCrypto := dnscrypto.New(httpClient, "", "")
+	const cacertsPath = "/etc/ssl/certs/ca-certificates.crt"
+	dnsConf := unbound.NewConfigurator(nil, cmder, dnsCrypto,
+		"/etc/unbound", "/usr/sbin/unbound", cacertsPath)
+
+	announcementExp, err := time.Parse(time.RFC3339, "2021-07-22T00:00:00Z")
 	if err != nil {
 		return err
 	}
@@ -170,7 +153,7 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 		Version:      buildInfo.Version,
 		Commit:       buildInfo.Commit,
 		BuildDate:    buildInfo.Created,
-		Announcement: "Wiki moved to https://github.com/qdm12/gluetun-wiki",
+		Announcement: "",
 		AnnounceExp:  announcementExp,
 		// Sponsor information
 		PaypalUser:    "qmcgaw",
@@ -180,92 +163,10 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 		fmt.Println(line)
 	}
 
-	allSettings, err := source.Read()
-	if err != nil {
-		return err
-	}
-
-	// Note: no need to validate minimal settings for the firewall:
-	// - global log level is parsed from source
-	// - firewall Debug and Enabled are booleans parsed from source
-
-	logger.Patch(log.SetLevel(*allSettings.Log.Level))
-	netLinker.PatchLoggerLevel(*allSettings.Log.Level)
-
-	routingLogger := logger.New(log.SetComponent("routing"))
-	if *allSettings.Firewall.Debug { // To remove in v4
-		routingLogger.Patch(log.SetLevel(log.LevelDebug))
-	}
-	routingConf := routing.New(netLinker, routingLogger)
-
-	defaultRoutes, err := routingConf.DefaultRoutes()
-	if err != nil {
-		return err
-	}
-
-	localNetworks, err := routingConf.LocalNetworks()
-	if err != nil {
-		return err
-	}
-
-	firewallLogger := logger.New(log.SetComponent("firewall"))
-	if *allSettings.Firewall.Debug { // To remove in v4
-		firewallLogger.Patch(log.SetLevel(log.LevelDebug))
-	}
-	firewallConf, err := firewall.NewConfig(ctx, firewallLogger, cmder,
-		defaultRoutes, localNetworks)
-	if err != nil {
-		return err
-	}
-
-	if *allSettings.Firewall.Enabled {
-		err = firewallConf.SetEnabled(ctx, true)
-		if err != nil {
-			return err
-		}
-	}
-
-	// TODO run this in a loop or in openvpn to reload from file without restarting
-	storageLogger := logger.New(log.SetComponent("storage"))
-	storage, err := storage.New(storageLogger, constants.ServersData)
-	if err != nil {
-		return err
-	}
-
-	ipv6Supported, err := netLinker.IsIPv6Supported()
-	if err != nil {
-		return fmt.Errorf("checking for IPv6 support: %w", err)
-	}
-
-	err = allSettings.Validate(storage, ipv6Supported)
-	if err != nil {
-		return err
-	}
-
-	allSettings.Pprof.HTTPServer.Logger = logger.New(log.SetComponent("pprof"))
-	pprofServer, err := pprof.New(allSettings.Pprof)
-	if err != nil {
-		return fmt.Errorf("creating Pprof server: %w", err)
-	}
-
-	puid, pgid := int(*allSettings.System.PUID), int(*allSettings.System.PGID)
-
-	const clientTimeout = 15 * time.Second
-	httpClient := &http.Client{Timeout: clientTimeout}
-	// Create configurators
-	alpineConf := alpine.New()
-	ovpnConf := openvpn.New(
-		logger.New(log.SetComponent("openvpn configurator")),
-		cmder, puid, pgid)
-	dnsCrypto := dnscrypto.New(httpClient, "", "")
-	const cacertsPath = "/etc/ssl/certs/ca-certificates.crt"
-	dnsConf := unbound.NewConfigurator(nil, cmder, dnsCrypto,
-		"/etc/unbound", "/usr/sbin/unbound", cacertsPath)
-
 	err = printVersions(ctx, logger, []printVersionElement{
 		{name: "Alpine", getVersion: alpineConf.Version},
+		{name: "OpenVPN 2.4", getVersion: ovpnConf.Version24},
 		{name: "OpenVPN 2.5", getVersion: ovpnConf.Version25},
-		{name: "OpenVPN 2.6", getVersion: ovpnConf.Version26},
 		{name: "Unbound", getVersion: dnsConf.Version},
 		{name: "IPtables", getVersion: func(ctx context.Context) (version string, err error) {
 			return firewall.Version(ctx, cmder)
@@ -275,11 +176,13 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 		return err
 	}
 
-	logger.Info(allSettings.String())
+	var allSettings configuration.Settings
-
+	err = allSettings.Read(env,
-	for _, warning := range allSettings.Warnings() {
+		logger.NewChild(logging.Settings{Prefix: "configuration: "}))
-		logger.Warn(warning)
+	if err != nil {
+		return err
 	}
+	logger.Info(allSettings.String())
 
 	if err := os.MkdirAll("/tmp/gluetun", 0644); err != nil {
 		return err
@@ -288,33 +191,76 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 		return err
 	}
 
+	// TODO run this in a loop or in openvpn to reload from file without restarting
+	storage := storage.New(
+		logger.NewChild(logging.Settings{Prefix: "storage: "}),
+		constants.ServersData)
+	allServers, err := storage.SyncServers(constants.GetAllServers())
+	if err != nil {
+		return err
+	}
+
+	// Should never change
+	puid, pgid := allSettings.System.PUID, allSettings.System.PGID
+
 	const defaultUsername = "nonrootuser"
 	nonRootUsername, err := alpineConf.CreateUser(defaultUsername, puid)
 	if err != nil {
-		return fmt.Errorf("creating user: %w", err)
+		return fmt.Errorf("%w: %s", errCreateUser, err)
 	}
 	if nonRootUsername != defaultUsername {
 		logger.Info("using existing username " + nonRootUsername + " corresponding to user id " + fmt.Sprint(puid))
 	}
 	// set it for Unbound
 	// TODO remove this when migrating to qdm12/dns v2
-	allSettings.DNS.DoT.Unbound.Username = nonRootUsername
+	allSettings.DNS.Unbound.Username = nonRootUsername
-	allSettings.VPN.OpenVPN.ProcessUser = nonRootUsername
 
 	if err := os.Chown("/etc/unbound", puid, pgid); err != nil {
 		return err
 	}
 
+	firewallLogLevel := logging.LevelInfo
+	if allSettings.Firewall.Debug {
+		firewallLogLevel = logging.LevelDebug
+	}
+	routingLogger := logger.NewChild(logging.Settings{
+		Prefix: "routing: ",
+		Level:  firewallLogLevel,
+	})
+	routingConf := routing.NewRouting(routingLogger)
+
+	defaultInterface, defaultGateway, err := routingConf.DefaultRoute()
+	if err != nil {
+		return err
+	}
+
+	localNetworks, err := routingConf.LocalNetworks()
+	if err != nil {
+		return err
+	}
+
+	defaultIP, err := routingConf.DefaultIP()
+	if err != nil {
+		return err
+	}
+
+	firewallLogger := logger.NewChild(logging.Settings{
+		Prefix: "firewall: ",
+		Level:  firewallLogLevel,
+	})
+	firewallConf := firewall.NewConfig(firewallLogger, cmder,
+		defaultInterface, defaultGateway, localNetworks, defaultIP)
+
 	if err := routingConf.Setup(); err != nil {
 		if strings.Contains(err.Error(), "operation not permitted") {
 			logger.Warn("💡 Tip: Are you passing NET_ADMIN capability to gluetun?")
 		}
-		return fmt.Errorf("setting up routing: %w", err)
+		return fmt.Errorf("%w: %s", errSetupRouting, err)
 	}
 	defer func() {
-		routingLogger.Info("routing cleanup...")
+		logger.Info("routing cleanup...")
 		if err := routingConf.TearDown(); err != nil {
-			routingLogger.Error("cannot teardown routing: " + err.Error())
+			logger.Error("cannot teardown routing: " + err.Error())
 		}
 	}()
 
@@ -325,35 +271,39 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 		return err
 	}
 
-	err = routingConf.AddLocalRules(localNetworks)
+	if err := ovpnConf.CheckTUN(); err != nil {
-	if err != nil {
+		logger.Warn(err.Error())
-		return fmt.Errorf("adding local rules: %w", err)
+		err = ovpnConf.CreateTUN()
+		if err != nil {
+			return err
+		}
 	}
 
-	const tunDevice = "/dev/net/tun"
+	tunnelReadyCh := make(chan struct{})
-	err = tun.Check(tunDevice)
+	defer close(tunnelReadyCh)
-	if err != nil {
+
-		if !errors.Is(err, os.ErrNotExist) {
+	if allSettings.Firewall.Enabled {
-			return fmt.Errorf("checking TUN device: %w (see the Wiki errors/tun page)", err)
+		err := firewallConf.SetEnabled(ctx, true) // disabled by default
-		}
-		logger.Info(err.Error() + "; creating it...")
-		err = tun.Create(tunDevice)
 		if err != nil {
-			return fmt.Errorf("creating tun device: %w", err)
+			return err
+		}
+	}
+
+	for _, vpnPort := range allSettings.Firewall.VPNInputPorts {
+		err = firewallConf.SetAllowedPort(ctx, vpnPort, string(constants.TUN))
+		if err != nil {
+			return err
 		}
 	}
 
 	for _, port := range allSettings.Firewall.InputPorts {
-		for _, defaultRoute := range defaultRoutes {
+		err = firewallConf.SetAllowedPort(ctx, port, defaultInterface)
-			err = firewallConf.SetAllowedPort(ctx, port, defaultRoute.NetInterface)
+		if err != nil {
-			if err != nil {
+			return err
-				return err
-			}
 		}
 	} // TODO move inside firewall?
 
 	// Shutdown settings
-	const totalShutdownTimeout = 3 * time.Second
 	const defaultShutdownTimeout = 400 * time.Millisecond
 	defaultShutdownOnSuccess := func(goRoutineName string) {
 		logger.Info(goRoutineName + ": terminated ✔️")
@@ -361,150 +311,114 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 	defaultShutdownOnFailure := func(goRoutineName string, err error) {
 		logger.Warn(goRoutineName + ": " + err.Error() + " ⚠️")
 	}
-	defaultGroupOptions := []group.Option{
+	defaultGoRoutineSettings := goshutdown.GoRoutineSettings{Timeout: defaultShutdownTimeout}
-		group.OptionTimeout(defaultShutdownTimeout),
+	defaultGroupSettings := goshutdown.GroupSettings{
-		group.OptionOnSuccess(defaultShutdownOnSuccess)}
+		Timeout:   defaultShutdownTimeout,
-
+		OnSuccess: defaultShutdownOnSuccess,
-	controlGroupHandler := goshutdown.NewGroupHandler("control", defaultGroupOptions...)
-	tickersGroupHandler := goshutdown.NewGroupHandler("tickers", defaultGroupOptions...)
-	otherGroupHandler := goshutdown.NewGroupHandler("other", defaultGroupOptions...)
-
-	if *allSettings.Pprof.Enabled {
-		// TODO run in run loop so this can be patched at runtime
-		pprofReady := make(chan struct{})
-		pprofHandler, pprofCtx, pprofDone := goshutdown.NewGoRoutineHandler("pprof server")
-		go pprofServer.Run(pprofCtx, pprofReady, pprofDone)
-		otherGroupHandler.Add(pprofHandler)
-		<-pprofReady
 	}
 
-	portForwardLogger := logger.New(log.SetComponent("port forwarding"))
+	controlGroupHandler := goshutdown.NewGroupHandler("control", defaultGroupSettings)
-	portForwardLooper := portforward.NewLoop(allSettings.VPN.Provider.PortForwarding,
+	tickersGroupHandler := goshutdown.NewGroupHandler("tickers", defaultGroupSettings)
-		routingConf, httpClient, firewallConf, portForwardLogger, puid, pgid)
+	otherGroupHandler := goshutdown.NewGroupHandler("other", defaultGroupSettings)
-	portForwardRunError, err := portForwardLooper.Start(ctx)
-	if err != nil {
-		return fmt.Errorf("starting port forwarding loop: %w", err)
-	}
 
-	unboundLogger := logger.New(log.SetComponent("dns"))
+	openvpnLooper := openvpn.NewLoop(allSettings.OpenVPN, nonRootUsername, puid, pgid, allServers,
-	unboundLooper := dns.NewLoop(dnsConf, allSettings.DNS, httpClient,
+		ovpnConf, firewallConf, logger, httpClient, tunnelReadyCh)
-		unboundLogger)
+	openvpnHandler, openvpnCtx, openvpnDone := goshutdown.NewGoRoutineHandler(
-	dnsHandler, dnsCtx, dnsDone := goshutdown.NewGoRoutineHandler(
+		"openvpn", goshutdown.GoRoutineSettings{Timeout: time.Second})
-		"unbound", goroutine.OptionTimeout(defaultShutdownTimeout))
+	// wait for restartOpenvpn
-	// wait for unboundLooper.Restart or its ticker launched with RunRestartTicker
+	go openvpnLooper.Run(openvpnCtx, openvpnDone)
-	go unboundLooper.Run(dnsCtx, dnsDone)
-	otherGroupHandler.Add(dnsHandler)
 
-	dnsTickerHandler, dnsTickerCtx, dnsTickerDone := goshutdown.NewGoRoutineHandler(
+	updaterLooper := updater.NewLooper(allSettings.Updater,
-		"dns ticker", goroutine.OptionTimeout(defaultShutdownTimeout))
+		allServers, storage, openvpnLooper.SetServers, httpClient,
-	go unboundLooper.RunRestartTicker(dnsTickerCtx, dnsTickerDone)
+		logger.NewChild(logging.Settings{Prefix: "updater: "}))
-	controlGroupHandler.Add(dnsTickerHandler)
-
-	ipFetcher := ipinfo.New(httpClient)
-	publicIPLooper := publicip.NewLoop(ipFetcher,
-		logger.New(log.SetComponent("ip getter")),
-		allSettings.PublicIP, puid, pgid)
-	publicIPRunError, err := publicIPLooper.Start(ctx)
-	if err != nil {
-		return fmt.Errorf("starting public ip loop: %w", err)
-	}
-
-	updaterLogger := logger.New(log.SetComponent("updater"))
-
-	unzipper := unzip.New(httpClient)
-	parallelResolver := resolver.NewParallelResolver(allSettings.Updater.DNSAddress)
-	openvpnFileExtractor := extract.New()
-	providers := provider.NewProviders(storage, time.Now, updaterLogger,
-		httpClient, unzipper, parallelResolver, ipFetcher, openvpnFileExtractor)
-
-	vpnLogger := logger.New(log.SetComponent("vpn"))
-	vpnLooper := vpn.NewLoop(allSettings.VPN, ipv6Supported, allSettings.Firewall.VPNInputPorts,
-		providers, storage, ovpnConf, netLinker, firewallConf, routingConf, portForwardLooper,
-		cmder, publicIPLooper, unboundLooper, vpnLogger, httpClient,
-		buildInfo, *allSettings.Version.Enabled)
-	vpnHandler, vpnCtx, vpnDone := goshutdown.NewGoRoutineHandler(
-		"vpn", goroutine.OptionTimeout(time.Second))
-	go vpnLooper.Run(vpnCtx, vpnDone)
-
-	updaterLooper := updater.NewLoop(allSettings.Updater,
-		providers, storage, httpClient, updaterLogger)
 	updaterHandler, updaterCtx, updaterDone := goshutdown.NewGoRoutineHandler(
-		"updater", goroutine.OptionTimeout(defaultShutdownTimeout))
+		"updater", defaultGoRoutineSettings)
 	// wait for updaterLooper.Restart() or its ticket launched with RunRestartTicker
 	go updaterLooper.Run(updaterCtx, updaterDone)
 	tickersGroupHandler.Add(updaterHandler)
 
-	updaterTickerHandler, updaterTickerCtx, updaterTickerDone := goshutdown.NewGoRoutineHandler(
+	unboundLogger := logger.NewChild(logging.Settings{Prefix: "dns over tls: "})
-		"updater ticker", goroutine.OptionTimeout(defaultShutdownTimeout))
+	unboundLooper := dns.NewLoop(dnsConf, allSettings.DNS, httpClient,
-	go updaterLooper.RunRestartTicker(updaterTickerCtx, updaterTickerDone)
+		unboundLogger)
-	controlGroupHandler.Add(updaterTickerHandler)
+	dnsHandler, dnsCtx, dnsDone := goshutdown.NewGoRoutineHandler(
+		"unbound", defaultGoRoutineSettings)
+	// wait for unboundLooper.Restart or its ticker launched with RunRestartTicker
+	go unboundLooper.Run(dnsCtx, dnsDone)
+	otherGroupHandler.Add(dnsHandler)
+
+	publicIPLooper := publicip.NewLoop(httpClient,
+		logger.NewChild(logging.Settings{Prefix: "ip getter: "}),
+		allSettings.PublicIP, puid, pgid)
+	pubIPHandler, pubIPCtx, pubIPDone := goshutdown.NewGoRoutineHandler(
+		"public IP", defaultGoRoutineSettings)
+	go publicIPLooper.Run(pubIPCtx, pubIPDone)
+	otherGroupHandler.Add(pubIPHandler)
+
+	pubIPTickerHandler, pubIPTickerCtx, pubIPTickerDone := goshutdown.NewGoRoutineHandler(
+		"public IP", defaultGoRoutineSettings)
+	go publicIPLooper.RunRestartTicker(pubIPTickerCtx, pubIPTickerDone)
+	tickersGroupHandler.Add(pubIPTickerHandler)
 
 	httpProxyLooper := httpproxy.NewLoop(
-		logger.New(log.SetComponent("http proxy")),
+		logger.NewChild(logging.Settings{Prefix: "http proxy: "}),
 		allSettings.HTTPProxy)
 	httpProxyHandler, httpProxyCtx, httpProxyDone := goshutdown.NewGoRoutineHandler(
-		"http proxy", goroutine.OptionTimeout(defaultShutdownTimeout))
+		"http proxy", defaultGoRoutineSettings)
 	go httpProxyLooper.Run(httpProxyCtx, httpProxyDone)
 	otherGroupHandler.Add(httpProxyHandler)
 
-	shadowsocksLooper := shadowsocks.NewLoop(allSettings.Shadowsocks,
+	shadowsocksLooper := shadowsocks.NewLooper(allSettings.ShadowSocks,
-		logger.New(log.SetComponent("shadowsocks")))
+		logger.NewChild(logging.Settings{Prefix: "shadowsocks: "}))
 	shadowsocksHandler, shadowsocksCtx, shadowsocksDone := goshutdown.NewGoRoutineHandler(
-		"shadowsocks proxy", goroutine.OptionTimeout(defaultShutdownTimeout))
+		"shadowsocks proxy", defaultGoRoutineSettings)
 	go shadowsocksLooper.Run(shadowsocksCtx, shadowsocksDone)
 	otherGroupHandler.Add(shadowsocksHandler)
 
-	controlServerAddress := *allSettings.ControlServer.Address
+	eventsRoutingHandler, eventsRoutingCtx, eventsRoutingDone := goshutdown.NewGoRoutineHandler(
-	controlServerLogging := *allSettings.ControlServer.Log
+		"events routing", defaultGoRoutineSettings)
+	go routeReadyEvents(eventsRoutingCtx, eventsRoutingDone, buildInfo, tunnelReadyCh,
+		unboundLooper, updaterLooper, publicIPLooper, routingConf, logger, httpClient,
+		allSettings.VersionInformation, allSettings.OpenVPN.Provider.PortForwarding.Enabled, openvpnLooper.PortForward,
+	)
+	controlGroupHandler.Add(eventsRoutingHandler)
+
+	controlServerAddress := ":" + strconv.Itoa(int(allSettings.ControlServer.Port))
+	controlServerLogging := allSettings.ControlServer.Log
 	httpServerHandler, httpServerCtx, httpServerDone := goshutdown.NewGoRoutineHandler(
-		"http server", goroutine.OptionTimeout(defaultShutdownTimeout))
+		"http server", defaultGoRoutineSettings)
-	httpServer, err := server.New(httpServerCtx, controlServerAddress, controlServerLogging,
+	httpServer := server.New(httpServerCtx, controlServerAddress, controlServerLogging,
-		logger.New(log.SetComponent("http server")),
+		logger.NewChild(logging.Settings{Prefix: "http server: "}),
-		buildInfo, vpnLooper, portForwardLooper, unboundLooper, updaterLooper, publicIPLooper,
+		buildInfo, openvpnLooper, unboundLooper, updaterLooper, publicIPLooper)
-		storage, ipv6Supported)
+	go httpServer.Run(httpServerCtx, httpServerDone)
-	if err != nil {
-		return fmt.Errorf("setting up control server: %w", err)
-	}
-	httpServerReady := make(chan struct{})
-	go httpServer.Run(httpServerCtx, httpServerReady, httpServerDone)
-	<-httpServerReady
 	controlGroupHandler.Add(httpServerHandler)
 
-	healthLogger := logger.New(log.SetComponent("healthcheck"))
+	healthLogger := logger.NewChild(logging.Settings{Prefix: "healthcheck: "})
-	healthcheckServer := healthcheck.NewServer(allSettings.Health, healthLogger, vpnLooper)
+	healthcheckServer := healthcheck.NewServer(allSettings.Health, healthLogger, openvpnLooper)
 	healthServerHandler, healthServerCtx, healthServerDone := goshutdown.NewGoRoutineHandler(
-		"HTTP health server", goroutine.OptionTimeout(defaultShutdownTimeout))
+		"HTTP health server", defaultGoRoutineSettings)
 	go healthcheckServer.Run(healthServerCtx, healthServerDone)
 
-	orderHandler := goshutdown.NewOrderHandler("gluetun",
+	const orderShutdownTimeout = 3 * time.Second
-		order.OptionTimeout(totalShutdownTimeout),
+	orderSettings := goshutdown.OrderSettings{
-		order.OptionOnSuccess(defaultShutdownOnSuccess),
+		Timeout:   orderShutdownTimeout,
-		order.OptionOnFailure(defaultShutdownOnFailure))
+		OnFailure: defaultShutdownOnFailure,
+		OnSuccess: defaultShutdownOnSuccess,
+	}
+	orderHandler := goshutdown.NewOrder("gluetun", orderSettings)
 	orderHandler.Append(controlGroupHandler, tickersGroupHandler, healthServerHandler,
-		vpnHandler, otherGroupHandler)
+		openvpnHandler, otherGroupHandler)
 
-	// Start VPN for the first time in a blocking call
+	// Start openvpn for the first time in a blocking call
-	// until the VPN is launched
+	// until openvpn is launched
-	_, _ = vpnLooper.ApplyStatus(ctx, constants.Running) // TODO option to disable with variable
+	_, _ = openvpnLooper.ApplyStatus(ctx, constants.Running) // TODO option to disable with variable
 
-	select {
+	<-ctx.Done()
-	case <-ctx.Done():
+
-		stoppers := []interface {
+	if allSettings.OpenVPN.Provider.PortForwarding.Enabled {
-			String() string
+		logger.Info("Clearing forwarded port status file " + allSettings.OpenVPN.Provider.PortForwarding.Filepath)
-			Stop() error
+		if err := os.Remove(allSettings.OpenVPN.Provider.PortForwarding.Filepath); err != nil {
-		}{
+			logger.Error(err.Error())
-			portForwardLooper, publicIPLooper,
 		}
-		for _, stopper := range stoppers {
-			err := stopper.Stop()
-			if err != nil {
-				logger.Error(fmt.Sprintf("stopping %s: %s", stopper, err))
-			}
-		}
-	case err := <-portForwardRunError:
-		logger.Errorf("port forwarding loop crashed: %s", err)
-	case err := <-publicIPRunError:
-		logger.Errorf("public IP loop crashed: %s", err)
 	}
 
 	return orderHandler.Shutdown(context.Background())
@@ -515,11 +429,7 @@ type printVersionElement struct {
 	getVersion func(ctx context.Context) (version string, err error)
 }
 
-type infoer interface {
+func printVersions(ctx context.Context, logger logging.Logger,
-	Info(s string)
-}
-
-func printVersions(ctx context.Context, logger infoer,
 	elements []printVersionElement) (err error) {
 	const timeout = 5 * time.Second
 	ctx, cancel := context.WithTimeout(ctx, timeout)
@@ -528,7 +438,7 @@ func printVersions(ctx context.Context, logger infoer,
 	for _, element := range elements {
 		version, err := element.getVersion(ctx)
 		if err != nil {
-			return fmt.Errorf("getting %s version: %w", element.name, err)
+			return err
 		}
 		logger.Info(element.name + " version: " + version)
 	}
@@ -536,60 +446,72 @@ func printVersions(ctx context.Context, logger infoer,
 	return nil
 }
 
-type netLinker interface {
+func routeReadyEvents(ctx context.Context, done chan<- struct{}, buildInfo models.BuildInformation,
-	Addresser
+	tunnelReadyCh <-chan struct{},
-	Router
+	unboundLooper dns.Looper, updaterLooper updater.Looper, publicIPLooper publicip.Looper,
-	Ruler
+	routing routing.VPNGetter, logger logging.Logger, httpClient *http.Client,
-	Linker
+	versionInformation, portForwardingEnabled bool, startPortForward func(vpnGateway net.IP)) {
-	IsWireguardSupported() (ok bool, err error)
+	defer close(done)
-	IsIPv6Supported() (ok bool, err error)
-	PatchLoggerLevel(level log.Level)
-}
 
-type Addresser interface {
+	// for linters only
-	AddrList(link netlink.Link, family int) (
+	var restartTickerContext context.Context
-		addresses []netlink.Addr, err error)
+	var restartTickerCancel context.CancelFunc = func() {}
-	AddrReplace(link netlink.Link, addr netlink.Addr) error
-}
 
-type Router interface {
+	unboundTickerDone := make(chan struct{})
-	RouteList(family int) (routes []netlink.Route, err error)
+	close(unboundTickerDone)
-	RouteAdd(route netlink.Route) error
+	updaterTickerDone := make(chan struct{})
-	RouteDel(route netlink.Route) error
+	close(updaterTickerDone)
-	RouteReplace(route netlink.Route) error
-}
 
-type Ruler interface {
+	first := true
-	RuleList(family int) (rules []netlink.Rule, err error)
+	for {
-	RuleAdd(rule netlink.Rule) error
+		select {
-	RuleDel(rule netlink.Rule) error
+		case <-ctx.Done():
-}
+			restartTickerCancel() // for linters only
+			<-unboundTickerDone
+			<-updaterTickerDone
+			return
+		case <-tunnelReadyCh: // blocks until openvpn is connected
+			vpnDestination, err := routing.VPNDestinationIP()
+			if err != nil {
+				logger.Warn(err.Error())
+			} else {
+				logger.Info("VPN routing IP address: " + vpnDestination.String())
+			}
 
-type Linker interface {
+			if unboundLooper.GetSettings().Enabled {
-	LinkList() (links []netlink.Link, err error)
+				_, _ = unboundLooper.ApplyStatus(ctx, constants.Running)
-	LinkByName(name string) (link netlink.Link, err error)
+			}
-	LinkByIndex(index int) (link netlink.Link, err error)
-	LinkAdd(link netlink.Link) (linkIndex int, err error)
-	LinkDel(link netlink.Link) (err error)
-	LinkSetUp(link netlink.Link) (linkIndex int, err error)
-	LinkSetDown(link netlink.Link) (err error)
-}
 
-type clier interface {
+			restartTickerCancel() // stop previous restart tickers
-	ClientKey(args []string) error
+			<-unboundTickerDone
-	FormatServers(args []string) error
+			<-updaterTickerDone
-	OpenvpnConfig(logger cli.OpenvpnConfigLogger, source cli.Source, ipv6Checker cli.IPv6Checker) error
+			restartTickerContext, restartTickerCancel = context.WithCancel(ctx)
-	HealthCheck(ctx context.Context, source cli.Source, warner cli.Warner) error
-	Update(ctx context.Context, args []string, logger cli.UpdaterLogger) error
-}
 
-type Tun interface {
+			// Runs the Public IP getter job once
-	Check(tunDevice string) error
+			_, _ = publicIPLooper.ApplyStatus(ctx, constants.Running)
-	Create(tunDevice string) error
+			if versionInformation && first {
-}
+				first = false
+				message, err := versionpkg.GetMessage(ctx, buildInfo, httpClient)
+				if err != nil {
+					logger.Error("cannot get version information: " + err.Error())
+				} else {
+					logger.Info(message)
+				}
+			}
 
-type Source interface {
+			unboundTickerDone = make(chan struct{})
-	Read() (settings settings.Settings, err error)
+			updaterTickerDone = make(chan struct{})
-	ReadHealth() (health settings.Health, err error)
+			go unboundLooper.RunRestartTicker(restartTickerContext, unboundTickerDone)
-	String() string
+			go updaterLooper.RunRestartTicker(restartTickerContext, updaterTickerDone)
+			if portForwardingEnabled {
+				// vpnGateway required only for PIA
+				vpnGateway, err := routing.VPNLocalGatewayIP()
+				if err != nil {
+					logger.Error("cannot get VPN local gateway IP: " + err.Error())
+				}
+				logger.Info("VPN gateway IP address: " + vpnGateway.String())
+				startPortForward(vpnGateway)
+			}
+		}
+	}
 }

docker-compose.yml

@@ -0,0 +1,24 @@
+version: "3.7"
+services:
+  gluetun:
+    image: qmcgaw/gluetun
+    container_name: gluetun
+    cap_add:
+      - NET_ADMIN
+    network_mode: bridge
+    ports:
+      - 8888:8888/tcp # HTTP proxy
+      - 8388:8388/tcp # Shadowsocks
+      - 8388:8388/udp # Shadowsocks
+      - 8000:8000/tcp # Built-in HTTP control server
+    # command:
+    volumes:
+      - /yourpath:/gluetun
+    environment:
+      # More variables are available, see the readme table
+      - OPENVPN_USER=
+      - OPENVPN_PASSWORD=
+      - VPNSP=private internet access
+      # Timezone for accurate logs times
+      - TZ=
+    restart: always

go.mod

@@ -1,55 +1,18 @@
 module github.com/qdm12/gluetun
 
-go 1.21
+go 1.16
 
 require (
-	github.com/breml/rootcerts v0.2.17
+	github.com/fatih/color v1.12.0
-	github.com/fatih/color v1.16.0
 	github.com/golang/mock v1.6.0
-	github.com/klauspost/compress v1.17.4
-	github.com/klauspost/pgzip v1.2.6
 	github.com/qdm12/dns v1.11.0
-	github.com/qdm12/golibs v0.0.0-20210822203818-5c568b0777b6
+	github.com/qdm12/golibs v0.0.0-20210723175634-a75ca7fd74c2
-	github.com/qdm12/gosettings v0.4.0-rc1
+	github.com/qdm12/goshutdown v0.1.0
-	github.com/qdm12/goshutdown v0.3.0
 	github.com/qdm12/gosplash v0.1.0
-	github.com/qdm12/gotree v0.2.0
+	github.com/qdm12/ss-server v0.2.0
-	github.com/qdm12/govalid v0.2.0-rc1
-	github.com/qdm12/log v0.1.0
-	github.com/qdm12/ss-server v0.5.0
 	github.com/qdm12/updated v0.0.0-20210603204757-205acfe6937e
-	github.com/stretchr/testify v1.8.4
+	github.com/stretchr/testify v1.7.0
-	github.com/ulikunitz/xz v0.5.11
+	github.com/vishvananda/netlink v1.1.0
-	github.com/vishvananda/netlink v1.2.1-beta.2
+	golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c
-	github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a
+	inet.af/netaddr v0.0.0-20210718074554-06ca8145d722
-	golang.org/x/net v0.19.0
-	golang.org/x/sys v0.15.0
-	golang.org/x/text v0.14.0
-	golang.zx2c4.com/wireguard v0.0.0-20230325221338-052af4a8072b
-	golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230215201556-9c5414ab4bde
-	gopkg.in/ini.v1 v1.67.0
-	inet.af/netaddr v0.0.0-20220811202034-502d2d690317
-)
-
-require (
-	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/google/go-cmp v0.5.9 // indirect
-	github.com/josharian/native v1.0.0 // indirect
-	github.com/mattn/go-colorable v0.1.13 // indirect
-	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/mdlayher/genetlink v1.2.0 // indirect
-	github.com/mdlayher/netlink v1.6.2 // indirect
-	github.com/mdlayher/socket v0.2.3 // indirect
-	github.com/miekg/dns v1.1.40 // indirect
-	github.com/mr-tron/base58 v1.2.0 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/riobard/go-bloom v0.0.0-20200614022211-cdc8013cb5b3 // indirect
-	github.com/vishvananda/netns v0.0.0-20200728191858-db3c7e526aae // indirect
-	go4.org/intern v0.0.0-20211027215823-ae77deb06f29 // indirect
-	go4.org/unsafe/assume-no-moving-gc v0.0.0-20230525183740-e7c30c78aeb2 // indirect
-	golang.org/x/crypto v0.17.0 // indirect
-	golang.org/x/exp v0.0.0-20230522175609-2e198f4a06a1 // indirect
-	golang.org/x/sync v0.1.0 // indirect
-	golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -4,8 +4,6 @@ github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/g
 github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
 github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY=
-github.com/breml/rootcerts v0.2.17 h1:0/M2BE2Apw0qEJCXDOkaiu7d5Sx5ObNfe1BkImJ4u1I=
-github.com/breml/rootcerts v0.2.17/go.mod h1:S/PKh+4d1HUn4HQovEB8hPJZO6pUZYrIhmXBhsegfXw=
 github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
@@ -13,9 +11,8 @@ github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
 github.com/docker/go-units v0.3.3/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk=
 github.com/dvyukov/go-fuzz v0.0.0-20210103155950-6a8e9d1f2415/go.mod h1:11Gm+ccJnvAhCNLlf5+cS9KjtbaD5I5zaZpFMsTHWTw=
 github.com/emirpasic/gods v1.12.0/go.mod h1:YfzfFFoVP/catgzJb4IKIqXjX78Ha8FMSDh3ymbK86o=
+github.com/fatih/color v1.12.0 h1:mRhaKNwANqRgUBGKmnI5ZxEk7QXmjQeCcuYFMX2bfcc=
 github.com/fatih/color v1.12.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM=
-github.com/fatih/color v1.16.0 h1:zmkK9Ngbjj+K0yRhTVONQh1p/HknKYSlNT+vZCzyokM=
-github.com/fatih/color v1.16.0/go.mod h1:fL2Sau1YI5c0pdGEVCbKQbLXB6edEj1ZgiY4NijnWvE=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
 github.com/gliderlabs/ssh v0.2.2/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aevW3Awn0=
 github.com/globalsign/mgo v0.0.0-20180905125535-1ca0a4f7cbcb/go.mod h1:xkRDCp4j0OGD1HRkm4kmhM+pmpv3AKq5SU7GMg4oO/Q=
@@ -36,24 +33,12 @@ github.com/golang/mock v1.5.0/go.mod h1:CWnOUgYIOo4TcNZ0wHX3YZCqsaM1I1Jvs6v3mP3K
 github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc=
 github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs=
 github.com/gomodule/redigo v2.0.0+incompatible/go.mod h1:B4C85qUVwatsJoIUNIfCRsp7qO0iAmpGFZ4EELWSbC4=
-github.com/google/btree v1.0.1 h1:gK4Kx5IaGY9CD5sPJ36FHiBJ6ZXl0kilRiiCj+jdYp4=
-github.com/google/btree v1.0.1/go.mod h1:xXMiIv4Fb/0kKde4SpL7qlzvu5cMJDRkFDxJfI9uaxA=
 github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
-github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8/DtOE=
-github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
-github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/gotify/go-api-client/v2 v2.0.4/go.mod h1:VKiah/UK20bXsr0JObE1eBVLW44zbBouzjuri9iwjFU=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
-github.com/josharian/native v1.0.0 h1:Ts/E8zCSEsG17dUqv7joXJFybuMLjQfWE04tsBODTxk=
-github.com/josharian/native v1.0.0/go.mod h1:7X/raswPFr05uY3HiLlYeyQntB6OO7E/d2Cu7qoaN2w=
 github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
-github.com/klauspost/compress v1.17.4 h1:Ej5ixsIri7BrIjBkRZLTo6ghwrEtHFk7ijlczPW4fZ4=
-github.com/klauspost/compress v1.17.4/go.mod h1:/dCuZOvVtNoHsyb+cuJD3itjs3NbnF6KH9zAO4BDxPM=
-github.com/klauspost/pgzip v1.2.6 h1:8RXeL5crjEUFnR2/Sn6GJNWtSQ3Dk8pq4CL3jvdDyjU=
-github.com/klauspost/pgzip v1.2.6/go.mod h1:Ch1tH69qFZu15pkjo5kYi6mth2Zzwzt50oCQKQE9RUs=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
@@ -62,25 +47,12 @@ github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kyokomi/emoji v2.2.4+incompatible/go.mod h1:mZ6aGCD7yk8j6QY6KICwnZ2pxoszVseX1DNoGtU2tBA=
 github.com/mailru/easyjson v0.0.0-20180823135443-60711f1a8329/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
+github.com/mattn/go-colorable v0.1.8 h1:c1ghPdyEDarC70ftn0y+A/Ee++9zz8ljHG1b13eJ0s8=
 github.com/mattn/go-colorable v0.1.8/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
-github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
-github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
 github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
-github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
-github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
-github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
-github.com/mdlayher/genetlink v1.2.0 h1:4yrIkRV5Wfk1WfpWTcoOlGmsWgQj3OtQN9ZsbrE+XtU=
-github.com/mdlayher/genetlink v1.2.0/go.mod h1:ra5LDov2KrUCZJiAtEvXXZBxGMInICMXIwshlJ+qRxQ=
-github.com/mdlayher/netlink v1.6.0/go.mod h1:0o3PlBmGst1xve7wQ7j/hwpNaFaH4qCRyWCdcZk8/vA=
-github.com/mdlayher/netlink v1.6.2 h1:D2zGSkvYsJ6NreeED3JiVTu1lj2sIYATqSaZlhPzUgQ=
-github.com/mdlayher/netlink v1.6.2/go.mod h1:O1HXX2sIWSMJ3Qn1BYZk1yZM+7iMki/uYGGiwGyq/iU=
-github.com/mdlayher/socket v0.1.1/go.mod h1:mYV5YIZAfHh4dzDVzI8x8tWLWCliuX8Mon5Awbj+qDs=
-github.com/mdlayher/socket v0.2.3 h1:XZA2X2TjdOwNoNPVPclRCURoX/hokBY8nkTmRZFEheM=
-github.com/mdlayher/socket v0.2.3/go.mod h1:bz12/FozYNH/VbvC3q7TRIK/Y6dH1kCKsXaUeXi/FmY=
 github.com/miekg/dns v1.1.40 h1:pyyPFfGMnciYUk/mXpKkVmeMQjfXqt3FAJ2hy7tPiLA=
 github.com/miekg/dns v1.1.40/go.mod h1:KNUDUusw/aVsxyTYZM1oqvCicbwhgbNgztCETuNZ7xM=
-github.com/mikioh/ipaddr v0.0.0-20190404000644-d465c8ab6721 h1:RlZweED6sbSArvlE924+mUcZuXKLBHA35U7LN621Bws=
-github.com/mikioh/ipaddr v0.0.0-20190404000644-d465c8ab6721/go.mod h1:Ickgr2WtCLZ2MDGd4Gr0geeCH5HybhRJbonOgQpvSxc=
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
 github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/mr-tron/base58 v1.2.0 h1:T/HDJBh4ZCPbU39/+c3rRvE0uKBQlU27+QI8LJ4t64o=
@@ -94,23 +66,14 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/qdm12/dns v1.11.0 h1:jpcD5DZXXQSQe5a263PL09ghukiIdptvXFOZvyKEm6Q=
 github.com/qdm12/dns v1.11.0/go.mod h1:FmQsNOUcrrZ4UFzWAiED56AKXeNgaX3ySbmPwEfNjjE=
 github.com/qdm12/golibs v0.0.0-20210603202746-e5494e9c2ebb/go.mod h1:15RBzkun0i8XB7ADIoLJWp9ITRgsz3LroEI2FiOXLRg=
+github.com/qdm12/golibs v0.0.0-20210723175634-a75ca7fd74c2 h1:FMeOhe/bGloI0T5Wb6QB7/rfOqgFeI//UF/N/f7PUCI=
 github.com/qdm12/golibs v0.0.0-20210723175634-a75ca7fd74c2/go.mod h1:6aRbg4Z/bTbm9JfxsGXfWKHi7zsOvPfUTK1S5HuAFKg=
-github.com/qdm12/golibs v0.0.0-20210822203818-5c568b0777b6 h1:bge5AL7cjHJMPz+5IOz5yF01q/l8No6+lIEBieA8gMg=
+github.com/qdm12/goshutdown v0.1.0 h1:lmwnygdXtnr2pa6VqfR/bm8077/BnBef1+7CP96B7Sw=
-github.com/qdm12/golibs v0.0.0-20210822203818-5c568b0777b6/go.mod h1:6aRbg4Z/bTbm9JfxsGXfWKHi7zsOvPfUTK1S5HuAFKg=
+github.com/qdm12/goshutdown v0.1.0/go.mod h1:/LP3MWLqI+wGH/ijfaUG+RHzBbKXIiVKnrg5vXOCf6Q=
-github.com/qdm12/gosettings v0.4.0-rc1 h1:UYA92yyeDPbmZysIuG65yrpZVPtdIoRmtEHft/AyI38=
-github.com/qdm12/gosettings v0.4.0-rc1/go.mod h1:JRV3opOpHvnKlIA29lKQMdYw1WSMVMfHYLLHPHol5ME=
-github.com/qdm12/goshutdown v0.3.0 h1:pqBpJkdwlZlfTEx4QHtS8u8CXx6pG0fVo6S1N0MpSEM=
-github.com/qdm12/goshutdown v0.3.0/go.mod h1:EqZ46No00kCTZ5qzdd3qIzY6ayhMt24QI8Mh8LVQYmM=
 github.com/qdm12/gosplash v0.1.0 h1:Sfl+zIjFZFP7b0iqf2l5UkmEY97XBnaKkH3FNY6Gf7g=
 github.com/qdm12/gosplash v0.1.0/go.mod h1:+A3fWW4/rUeDXhY3ieBzwghKdnIPFJgD8K3qQkenJlw=
-github.com/qdm12/gotree v0.2.0 h1:+58ltxkNLUyHtATFereAcOjBVfY6ETqRex8XK90Fb/c=
+github.com/qdm12/ss-server v0.2.0 h1:+togLzeeLAJ68MD1JqOWvYi9rl9t/fx1Qh7wKzZhY1g=
-github.com/qdm12/gotree v0.2.0/go.mod h1:1SdFaqKZuI46U1apbXIf25pDMNnrPuYLEqMF/qL4lY4=
+github.com/qdm12/ss-server v0.2.0/go.mod h1:+1bWO1EfWNvsGM5Cuep6vneChK2OHniqtAsED9Fh1y0=
-github.com/qdm12/govalid v0.2.0-rc1 h1:4iYQvU4ibrASgzelsEgZX4JyKX3UTB/DcHObzQ7BXtw=
-github.com/qdm12/govalid v0.2.0-rc1/go.mod h1:/uWzVWMuS71wmbsVnlUxpQiy6EAXqm8eQ2RbyA72roQ=
-github.com/qdm12/log v0.1.0 h1:jYBd/xscHYpblzZAd2kjZp2YmuYHjAAfbTViJWxoPTw=
-github.com/qdm12/log v0.1.0/go.mod h1:Vchi5M8uBvHfPNIblN4mjXn/oSbiWguQIbsgF1zdQPI=
-github.com/qdm12/ss-server v0.5.0 h1:ARAqJayohDM51BmJ/R5Yplkpo+Qxgp7xizBF1HWd7uQ=
-github.com/qdm12/ss-server v0.5.0/go.mod h1:eFd8PL/uy0ZvJ4KeSUzToruJctVQoYqXk+LRy9vcOiI=
 github.com/qdm12/updated v0.0.0-20210603204757-205acfe6937e h1:4q+uFLawkaQRq3yARYLsjJPZd2wYwxn4g6G/5v0xW1g=
 github.com/qdm12/updated v0.0.0-20210603204757-205acfe6937e/go.mod h1:UvJRGkZ9XL3/D7e7JiTTVLm1F3Cymd3/gFpD6frEpBo=
 github.com/riobard/go-bloom v0.0.0-20200614022211-cdc8013cb5b3 h1:f/FNXud6gA3MNr8meMVVGxhp+QBTqY91tM8HjEuMjGg=
@@ -122,101 +85,65 @@ github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoH
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
+github.com/vishvananda/netlink v1.1.0 h1:1iyaYNBLmP6L0220aDnYQpo1QEV4t4hJ+xEEhhJH8j0=
-github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/vishvananda/netlink v1.1.0/go.mod h1:cTgwzPIzzgDAYoQrMm0EdrjRUBkTqKYppBueQtXaqoE=
-github.com/ulikunitz/xz v0.5.11 h1:kpFauv27b6ynzBNT/Xy+1k+fK4WswhN/6PN5WhFAGw8=
+github.com/vishvananda/netns v0.0.0-20191106174202-0a2b9b5464df h1:OviZH7qLw/7ZovXvuNyL3XQl8UFofeikI1NW1Gypu7k=
-github.com/ulikunitz/xz v0.5.11/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
+github.com/vishvananda/netns v0.0.0-20191106174202-0a2b9b5464df/go.mod h1:JP3t17pCcGlemwknint6hfoeCVQrEMVwxRLRjXpq+BU=
-github.com/vishvananda/netlink v1.2.1-beta.2 h1:Llsql0lnQEbHj0I1OuKyp8otXp0r3q0mPkuhwHfStVs=
-github.com/vishvananda/netlink v1.2.1-beta.2/go.mod h1:twkDnbuQxJYemMlGd4JFIcuhgX83tXhKS2B/PRMpOho=
-github.com/vishvananda/netns v0.0.0-20200728191858-db3c7e526aae h1:4hwBBUfQCFe3Cym0ZtKyq7L16eZUtYKs+BaHDN6mAns=
-github.com/vishvananda/netns v0.0.0-20200728191858-db3c7e526aae/go.mod h1:DD4vA1DwXk04H54A1oHXtwZmA0grkVMdPxx/VGLCah0=
 github.com/xanzy/ssh-agent v0.2.1/go.mod h1:mLlQY/MoOhWBj+gOGMQkOeiEvkx+8pJSI+0Bx9h2kr4=
 github.com/yl2chen/cidranger v1.0.2/go.mod h1:9U1yz7WPYDwf0vpNWFaeRh0bjwz5RVgRy/9UEQfHl0g=
-github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a h1:fZHgsYlfvtyqToslyjUt3VOPF4J7aK/3MPcK7xp3PDk=
-github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a/go.mod h1:ul22v+Nro/R083muKhosV54bj5niojjWZvU8xrevuH4=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
+go4.org/intern v0.0.0-20210108033219-3eb7198706b2 h1:VFTf+jjIgsldaz/Mr00VaCSswHJrI2hIjQygE/W4IMg=
 go4.org/intern v0.0.0-20210108033219-3eb7198706b2/go.mod h1:vLqJ+12kCw61iCWsPto0EOHhBS+o4rO5VIucbc9g2Cc=
-go4.org/intern v0.0.0-20211027215823-ae77deb06f29 h1:UXLjNohABv4S58tHmeuIZDO6e3mHpW2Dx33gaNt03LE=
-go4.org/intern v0.0.0-20211027215823-ae77deb06f29/go.mod h1:cS2ma+47FKrLPdXFpr7CuxiTW3eyJbWew4qx0qtQWDA=
 go4.org/unsafe/assume-no-moving-gc v0.0.0-20201222175341-b30ae309168e/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
+go4.org/unsafe/assume-no-moving-gc v0.0.0-20201222180813-1025295fd063 h1:1tk03FUNpulq2cuWpXZWj649rwJpk0d20rxWiopKRmc=
 go4.org/unsafe/assume-no-moving-gc v0.0.0-20201222180813-1025295fd063/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
-go4.org/unsafe/assume-no-moving-gc v0.0.0-20211027215541-db492cf91b37/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
-go4.org/unsafe/assume-no-moving-gc v0.0.0-20220617031537-928513b29760/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
-go4.org/unsafe/assume-no-moving-gc v0.0.0-20230525183740-e7c30c78aeb2 h1:WJhcL4p+YeDxmZWg141nRm7XC8IDmhz7lk5GpadO1Sg=
-go4.org/unsafe/assume-no-moving-gc v0.0.0-20230525183740-e7c30c78aeb2/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
 golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
-golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
+golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 h1:/UOmuWzQfxxo9UtlXMwuQU8CMgg1eZXqTRwkSQJWKOI=
 golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
-golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
-golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
-golang.org/x/exp v0.0.0-20230522175609-2e198f4a06a1 h1:k/i9J1pBpvlfR+9QsetwPyERsqu1GIbi967PQMq3Ivc=
-golang.org/x/exp v0.0.0-20230522175609-2e198f4a06a1/go.mod h1:V1LtkGg67GoY2N1AnLN78QLrzxkLyJw7RJb1gzOOz9w=
 golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
 golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/net v0.0.0-20181005035420-146acd28ed58/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
-golang.org/x/net v0.0.0-20190503192946-f4e77d36d62c/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20190923162816-aa69164e4478/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
 golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 h1:4nGaVu0QrbjT/AK2PRLuQfQuh6DJve+pELhqTdAj3x0=
 golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
-golang.org/x/net v0.0.0-20210928044308-7d9f5e0b762b/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
-golang.org/x/net v0.0.0-20220923203811-8be639271d50/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk=
-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/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20210220032951-036812b2e83c h1:5KslGYwFpkhGh+Q16bwMP3cOontH8FOep7tGV86Y7SQ=
 golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.0.0-20220923202941-7f9b1623fab7/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
-golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190221075227-b4e8571b14e0/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20190606203320-7fc4e5ec1444/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190924154521-2837fb4f24fe/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20200217220822-9197077df867/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20200728102440-3e129f6d46b1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I=
-golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220128215802-99c3d69c2c27/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220319134239-a9b59b0215f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.6.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/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/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
-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/time v0.0.0-20191024005414-555d28b269f0 h1:/5xXl8Y5W96D+TtHSlonuFqGHIWVuyCkGJLwGh9JJFs=
-golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190729092621-ff9f1409240a/go.mod h1:jcCCGcm9btYwXyDqrUWc6MKQKKGJCWEQ3AfLSRIbEuI=
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
@@ -225,30 +152,18 @@ golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
 golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2 h1:B82qJJgjvYKsXS9jeunTOisW56dUokqW/FOteYJJ/yg=
-golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2/go.mod h1:deeaetjYA+DHMHg+sMSMI58GrEteJUUzzw7en6TJQcI=
-golang.zx2c4.com/wireguard v0.0.0-20230325221338-052af4a8072b h1:J1CaxgLerRR5lgx3wnr6L04cJFbWoceSK9JWBdglINo=
-golang.zx2c4.com/wireguard v0.0.0-20230325221338-052af4a8072b/go.mod h1:tqur9LnfstdR9ep2LaJT4lFUl0EjlHtge+gAjmsHUG4=
-golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230215201556-9c5414ab4bde h1:ybF7AMzIUikL9x4LgwEmzhXtzRpKNqngme1VGDWz+Nk=
-golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230215201556-9c5414ab4bde/go.mod h1:mQqgjkW8GQQcJQsbBvK890TKqUK1DfKWkuBGbOkuMHQ=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA=
-gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/src-d/go-billy.v4 v4.3.2/go.mod h1:nDjArDMp+XMs1aFAESLRjfGSgfvoYN0hDfzEk0GjC98=
 gopkg.in/src-d/go-git-fixtures.v3 v3.5.0/go.mod h1:dLBcvytrw/TYZsNTWCnkNF2DSIlzWYqTe3rJR56Ac7g=
 gopkg.in/src-d/go-git.v4 v4.13.1/go.mod h1:nx5NYcxdKxq5fpltdHnPa2Exj4Sx0EclMWZQbYDu2z8=
 gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
 gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
-gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gvisor.dev/gvisor v0.0.0-20221203005347-703fd9b7fbc0 h1:Wobr37noukisGxpKo5jAsLREcpj61RxrWYzD8uwveOY=
-gvisor.dev/gvisor v0.0.0-20221203005347-703fd9b7fbc0/go.mod h1:Dn5idtptoW1dIos9U6A2rpebLs/MtTwFacjKb8jLdQA=
 inet.af/netaddr v0.0.0-20210511181906-37180328850c/go.mod h1:z0nx+Dh+7N7CC8V5ayHtHGpZpxLQZZxkIaaz6HN65Ls=
-inet.af/netaddr v0.0.0-20220811202034-502d2d690317 h1:U2fwK6P2EqmopP/hFLTOAjWTki0qgd4GMJn5X8wOleU=
+inet.af/netaddr v0.0.0-20210718074554-06ca8145d722 h1:Qws2rZnQudC58cIagVucPQDLmMi3kAXgxscsgD0v6DU=
-inet.af/netaddr v0.0.0-20220811202034-502d2d690317/go.mod h1:OIezDfdzOgFhuw4HuWapWq2e9l0H9tK4F1j+ETRtF3k=
+inet.af/netaddr v0.0.0-20210718074554-06ca8145d722/go.mod h1:z0nx+Dh+7N7CC8V5ayHtHGpZpxLQZZxkIaaz6HN65Ls=

internal/alpine/alpine.go

@@ -1,9 +1,17 @@
+// Package alpine defines a configurator to interact with the Alpine operating system.
 package alpine
 
 import (
 	"os/user"
 )
 
+var _ Alpiner = (*Alpine)(nil)
+
+type Alpiner interface {
+	UserCreater
+	VersionGetter
+}
+
 type Alpine struct {
 	alpineReleasePath string
 	passwdPath        string

internal/alpine/users.go

@@ -12,6 +12,10 @@ var (
 	ErrUserAlreadyExists = errors.New("user already exists")
 )
 
+type UserCreater interface {
+	CreateUser(username string, uid int) (createdUsername string, err error)
+}
+
 // CreateUser creates a user in Alpine with the given UID.
 func (a *Alpine) CreateUser(username string, uid int) (createdUsername string, err error) {
 	UIDStr := strconv.Itoa(uid)

internal/alpine/version.go

@@ -7,7 +7,11 @@ import (
 	"strings"
 )
 
-func (a *Alpine) Version(context.Context) (version string, err error) {
+type VersionGetter interface {
+	Version(ctx context.Context) (version string, err error)
+}
+
+func (a *Alpine) Version(ctx context.Context) (version string, err error) {
 	file, err := os.OpenFile(a.alpineReleasePath, os.O_RDONLY, 0)
 	if err != nil {
 		return "", err

internal/cli/ci.go

@@ -2,6 +2,6 @@ package cli
 
 import "context"
 
-func (c *CLI) CI(context.Context) error {
+func (c *CLI) CI(context context.Context) error {
 	return nil
 }

internal/cli/cli.go

@@ -1,11 +1,21 @@
+// Package cli defines an interface CLI to run command line operations.
 package cli
 
+var _ CLIer = (*CLI)(nil)
+
+type CLIer interface {
+	ClientKeyFormatter
+	HealthChecker
+	OpenvpnConfigMaker
+	Updater
+}
+
 type CLI struct {
 	repoServersPath string
 }
 
 func New() *CLI {
 	return &CLI{
-		repoServersPath: "./internal/storage/servers.json",
+		repoServersPath: "./internal/constants/servers.json",
 	}
 }

internal/cli/clientkey.go

@@ -7,12 +7,16 @@ import (
 	"os"
 	"strings"
 
-	"github.com/qdm12/gluetun/internal/configuration/sources/files"
+	"github.com/qdm12/gluetun/internal/constants"
 )
 
+type ClientKeyFormatter interface {
+	ClientKey(args []string) error
+}
+
 func (c *CLI) ClientKey(args []string) error {
 	flagSet := flag.NewFlagSet("clientkey", flag.ExitOnError)
-	filepath := flagSet.String("path", files.OpenVPNClientKeyPath, "file path to the client.key file")
+	filepath := flagSet.String("path", constants.ClientKey, "file path to the client.key file")
 	if err := flagSet.Parse(args); err != nil {
 		return err
 	}

internal/cli/formatservers.go

@@ -1,110 +0,0 @@
-package cli
-
-import (
-	"errors"
-	"flag"
-	"fmt"
-	"os"
-	"path/filepath"
-	"strings"
-
-	"github.com/qdm12/gluetun/internal/constants"
-	"github.com/qdm12/gluetun/internal/constants/providers"
-	"github.com/qdm12/gluetun/internal/storage"
-	"golang.org/x/text/cases"
-	"golang.org/x/text/language"
-)
-
-var (
-	ErrFormatNotRecognized       = errors.New("format is not recognized")
-	ErrProviderUnspecified       = errors.New("VPN provider to format was not specified")
-	ErrMultipleProvidersToFormat = errors.New("more than one VPN provider to format were specified")
-)
-
-func addProviderFlag(flagSet *flag.FlagSet, providerToFormat map[string]*bool,
-	provider string, titleCaser cases.Caser) {
-	boolPtr, ok := providerToFormat[provider]
-	if !ok {
-		panic(fmt.Sprintf("unknown provider in format map: %s", provider))
-	}
-	flagSet.BoolVar(boolPtr, provider, false, "Format "+titleCaser.String(provider)+" servers")
-}
-
-func (c *CLI) FormatServers(args []string) error {
-	var format, output string
-	allProviders := providers.All()
-	allProviderFlags := make([]string, len(allProviders))
-	for i, provider := range allProviders {
-		allProviderFlags[i] = strings.ReplaceAll(provider, " ", "-")
-	}
-
-	providersToFormat := make(map[string]*bool, len(allProviders))
-	for _, provider := range allProviderFlags {
-		providersToFormat[provider] = new(bool)
-	}
-	flagSet := flag.NewFlagSet("format-servers", flag.ExitOnError)
-	flagSet.StringVar(&format, "format", "markdown", "Format to use which can be: 'markdown'")
-	flagSet.StringVar(&output, "output", "/dev/stdout", "Output file to write the formatted data to")
-	titleCaser := cases.Title(language.English)
-	for _, provider := range allProviderFlags {
-		addProviderFlag(flagSet, providersToFormat, provider, titleCaser)
-	}
-	if err := flagSet.Parse(args); err != nil {
-		return err
-	}
-
-	if format != "markdown" {
-		return fmt.Errorf("%w: %s", ErrFormatNotRecognized, format)
-	}
-
-	// Verify only one provider is set to be formatted.
-	var providers []string
-	for provider, formatPtr := range providersToFormat {
-		if *formatPtr {
-			providers = append(providers, provider)
-		}
-	}
-	switch len(providers) {
-	case 0:
-		return fmt.Errorf("%w", ErrProviderUnspecified)
-	case 1:
-	default:
-		return fmt.Errorf("%w: %d specified: %s",
-			ErrMultipleProvidersToFormat, len(providers),
-			strings.Join(providers, ", "))
-	}
-
-	var providerToFormat string
-	for _, providerToFormat = range allProviders {
-		if strings.ReplaceAll(providerToFormat, " ", "-") == providers[0] {
-			break
-		}
-	}
-
-	logger := newNoopLogger()
-	storage, err := storage.New(logger, constants.ServersData)
-	if err != nil {
-		return fmt.Errorf("creating servers storage: %w", err)
-	}
-
-	formatted := storage.FormatToMarkdown(providerToFormat)
-
-	output = filepath.Clean(output)
-	file, err := os.OpenFile(output, os.O_TRUNC|os.O_WRONLY|os.O_CREATE, 0644)
-	if err != nil {
-		return fmt.Errorf("opening output file: %w", err)
-	}
-
-	_, err = fmt.Fprint(file, formatted)
-	if err != nil {
-		_ = file.Close()
-		return fmt.Errorf("writing to output file: %w", err)
-	}
-
-	err = file.Close()
-	if err != nil {
-		return fmt.Errorf("closing output file: %w", err)
-	}
-
-	return nil
-}

internal/cli/healthcheck.go

@@ -6,23 +6,24 @@ import (
 	"net/http"
 	"time"
 
+	"github.com/qdm12/gluetun/internal/configuration"
 	"github.com/qdm12/gluetun/internal/healthcheck"
+	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/golibs/params"
 )
 
-func (c *CLI) HealthCheck(ctx context.Context, source Source, _ Warner) error {
+type HealthChecker interface {
+	HealthCheck(ctx context.Context, env params.Env, logger logging.Logger) error
+}
+
+func (c *CLI) HealthCheck(ctx context.Context, env params.Env,
+	logger logging.Logger) error {
 	// Extract the health server port from the configuration.
-	config, err := source.ReadHealth()
+	config := configuration.Health{}
+	err := config.Read(env, logger)
 	if err != nil {
 		return err
 	}
-
-	config.SetDefaults()
-
-	err = config.Validate()
-	if err != nil {
-		return err
-	}
-
 	_, port, err := net.SplitHostPort(config.ServerAddress)
 	if err != nil {
 		return err

internal/cli/interfaces.go

@@ -1,9 +0,0 @@
-package cli
-
-import "github.com/qdm12/gluetun/internal/configuration/settings"
-
-type Source interface {
-	Read() (settings settings.Settings, err error)
-	ReadHealth() (health settings.Health, err error)
-	String() string
-}

internal/cli/nooplogger.go

@@ -1,16 +0,0 @@
-package cli
-
-import "github.com/qdm12/golibs/logging"
-
-type noopLogger struct{}
-
-func newNoopLogger() *noopLogger {
-	return new(noopLogger)
-}
-
-func (l *noopLogger) Debug(string)             {}
-func (l *noopLogger) Info(string)              {}
-func (l *noopLogger) Warn(string)              {}
-func (l *noopLogger) Error(string)             {}
-func (l *noopLogger) PatchLevel(logging.Level) {}
-func (l *noopLogger) PatchPrefix(string)       {}

internal/cli/openvpnconfig.go

@@ -1,85 +1,39 @@
 package cli
 
 import (
-	"context"
 	"fmt"
-	"net/http"
-	"net/netip"
 	"strings"
 	"time"
 
+	"github.com/qdm12/gluetun/internal/configuration"
 	"github.com/qdm12/gluetun/internal/constants"
-	"github.com/qdm12/gluetun/internal/openvpn/extract"
 	"github.com/qdm12/gluetun/internal/provider"
-	"github.com/qdm12/gluetun/internal/publicip/ipinfo"
 	"github.com/qdm12/gluetun/internal/storage"
-	"github.com/qdm12/gluetun/internal/updater/resolver"
+	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/golibs/params"
 )
 
-type OpenvpnConfigLogger interface {
+type OpenvpnConfigMaker interface {
-	Info(s string)
+	OpenvpnConfig(logger logging.Logger) error
-	Warn(s string)
 }
 
-type Unzipper interface {
+func (c *CLI) OpenvpnConfig(logger logging.Logger) error {
-	FetchAndExtract(ctx context.Context, url string) (
+	var allSettings configuration.Settings
-		contents map[string][]byte, err error)
+	err := allSettings.Read(params.NewEnv(), logger)
-}
-
-type ParallelResolver interface {
-	Resolve(ctx context.Context, settings resolver.ParallelSettings) (
-		hostToIPs map[string][]netip.Addr, warnings []string, err error)
-}
-
-type IPFetcher interface {
-	FetchMultiInfo(ctx context.Context, ips []netip.Addr) (data []ipinfo.Response, err error)
-}
-
-type IPv6Checker interface {
-	IsIPv6Supported() (supported bool, err error)
-}
-
-func (c *CLI) OpenvpnConfig(logger OpenvpnConfigLogger, source Source,
-	ipv6Checker IPv6Checker) error {
-	storage, err := storage.New(logger, constants.ServersData)
 	if err != nil {
 		return err
 	}
-
+	allServers, err := storage.New(logger, constants.ServersData).
-	allSettings, err := source.Read()
+		SyncServers(constants.GetAllServers())
 	if err != nil {
 		return err
 	}
-
+	providerConf := provider.New(allSettings.OpenVPN.Provider.Name, allServers, time.Now)
-	ipv6Supported, err := ipv6Checker.IsIPv6Supported()
+	connection, err := providerConf.GetOpenVPNConnection(allSettings.OpenVPN.Provider.ServerSelection)
-	if err != nil {
-		return fmt.Errorf("checking for IPv6 support: %w", err)
-	}
-
-	if err = allSettings.Validate(storage, ipv6Supported); err != nil {
-		return fmt.Errorf("validating settings: %w", err)
-	}
-
-	// Unused by this CLI command
-	unzipper := (Unzipper)(nil)
-	client := (*http.Client)(nil)
-	warner := (Warner)(nil)
-	parallelResolver := (ParallelResolver)(nil)
-	ipFetcher := (IPFetcher)(nil)
-	openvpnFileExtractor := extract.New()
-
-	providers := provider.NewProviders(storage, time.Now, warner, client,
-		unzipper, parallelResolver, ipFetcher, openvpnFileExtractor)
-	providerConf := providers.Get(*allSettings.VPN.Provider.Name)
-	connection, err := providerConf.GetConnection(
-		allSettings.VPN.Provider.ServerSelection, ipv6Supported)
 	if err != nil {
 		return err
 	}
-
+	lines := providerConf.BuildConf(connection, "nonroortuser", allSettings.OpenVPN)
-	lines := providerConf.OpenVPNConfig(connection,
-		allSettings.VPN.OpenVPN, ipv6Supported)
-
 	fmt.Println(strings.Join(lines, "\n"))
 	return nil
 }

internal/cli/update.go

@@ -2,101 +2,110 @@ package cli
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"flag"
 	"fmt"
 	"net/http"
-	"strings"
+	"os"
 	"time"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings"
+	"github.com/qdm12/gluetun/internal/configuration"
 	"github.com/qdm12/gluetun/internal/constants"
-	"github.com/qdm12/gluetun/internal/constants/providers"
+	"github.com/qdm12/gluetun/internal/models"
-	"github.com/qdm12/gluetun/internal/openvpn/extract"
-	"github.com/qdm12/gluetun/internal/provider"
-	"github.com/qdm12/gluetun/internal/publicip/ipinfo"
 	"github.com/qdm12/gluetun/internal/storage"
 	"github.com/qdm12/gluetun/internal/updater"
-	"github.com/qdm12/gluetun/internal/updater/resolver"
+	"github.com/qdm12/golibs/logging"
-	"github.com/qdm12/gluetun/internal/updater/unzip"
 )
 
 var (
-	ErrModeUnspecified     = errors.New("at least one of -enduser or -maintainer must be specified")
+	ErrModeUnspecified         = errors.New("at least one of -enduser or -maintainers must be specified")
-	ErrNoProviderSpecified = errors.New("no provider was specified")
+	ErrSyncServers             = errors.New("cannot sync hardcoded and persisted servers")
+	ErrUpdateServerInformation = errors.New("cannot update server information")
+	ErrWriteToFile             = errors.New("cannot write updated information to file")
 )
 
-type UpdaterLogger interface {
+type Updater interface {
-	Info(s string)
+	Update(ctx context.Context, args []string, logger logging.Logger) error
-	Warn(s string)
-	Error(s string)
 }
 
-func (c *CLI) Update(ctx context.Context, args []string, logger UpdaterLogger) error {
+func (c *CLI) Update(ctx context.Context, args []string, logger logging.Logger) error {
-	options := settings.Updater{}
+	options := configuration.Updater{CLI: true}
 	var endUserMode, maintainerMode, updateAll bool
-	var csvProviders string
 	flagSet := flag.NewFlagSet("update", flag.ExitOnError)
 	flagSet.BoolVar(&endUserMode, "enduser", false, "Write results to /gluetun/servers.json (for end users)")
 	flagSet.BoolVar(&maintainerMode, "maintainer", false,
-		"Write results to ./internal/storage/servers.json to modify the program (for maintainers)")
+		"Write results to ./internal/constants/servers.json to modify the program (for maintainers)")
 	flagSet.StringVar(&options.DNSAddress, "dns", "8.8.8.8", "DNS resolver address to use")
-	const defaultMinRatio = 0.8
-	flagSet.Float64Var(&options.MinRatio, "minratio", defaultMinRatio,
-		"Minimum ratio of servers to find for the update to succeed")
 	flagSet.BoolVar(&updateAll, "all", false, "Update servers for all VPN providers")
-	flagSet.StringVar(&csvProviders, "providers", "", "CSV string of VPN providers to update server data for")
+	flagSet.BoolVar(&options.Cyberghost, "cyberghost", false, "Update Cyberghost servers")
+	flagSet.BoolVar(&options.Fastestvpn, "fastestvpn", false, "Update FastestVPN servers")
+	flagSet.BoolVar(&options.HideMyAss, "hidemyass", false, "Update HideMyAss servers")
+	flagSet.BoolVar(&options.Ipvanish, "ipvanish", false, "Update IpVanish servers")
+	flagSet.BoolVar(&options.Ivpn, "ivpn", false, "Update IVPN servers")
+	flagSet.BoolVar(&options.Mullvad, "mullvad", false, "Update Mullvad servers")
+	flagSet.BoolVar(&options.Nordvpn, "nordvpn", false, "Update Nordvpn servers")
+	flagSet.BoolVar(&options.PIA, "pia", false, "Update Private Internet Access post-summer 2020 servers")
+	flagSet.BoolVar(&options.Privado, "privado", false, "Update Privado servers")
+	flagSet.BoolVar(&options.Privatevpn, "privatevpn", false, "Update Private VPN servers")
+	flagSet.BoolVar(&options.Protonvpn, "protonvpn", false, "Update Protonvpn servers")
+	flagSet.BoolVar(&options.Purevpn, "purevpn", false, "Update Purevpn servers")
+	flagSet.BoolVar(&options.Surfshark, "surfshark", false, "Update Surfshark servers")
+	flagSet.BoolVar(&options.Torguard, "torguard", false, "Update Torguard servers")
+	flagSet.BoolVar(&options.VPNUnlimited, "vpnunlimited", false, "Update VPN Unlimited servers")
+	flagSet.BoolVar(&options.Vyprvpn, "vyprvpn", false, "Update Vyprvpn servers")
+	flagSet.BoolVar(&options.Windscribe, "windscribe", false, "Update Windscribe servers")
 	if err := flagSet.Parse(args); err != nil {
 		return err
 	}
-
 	if !endUserMode && !maintainerMode {
-		return fmt.Errorf("%w", ErrModeUnspecified)
+		return ErrModeUnspecified
 	}
 
 	if updateAll {
-		options.Providers = providers.All()
+		options.EnableAll()
-	} else {
-		if csvProviders == "" {
-			return fmt.Errorf("%w", ErrNoProviderSpecified)
-		}
-		options.Providers = strings.Split(csvProviders, ",")
-	}
-
-	options.SetDefaults(options.Providers[0])
-
-	err := options.Validate()
-	if err != nil {
-		return fmt.Errorf("options validation failed: %w", err)
-	}
-
-	storage, err := storage.New(logger, constants.ServersData)
-	if err != nil {
-		return fmt.Errorf("creating servers storage: %w", err)
 	}
 
 	const clientTimeout = 10 * time.Second
 	httpClient := &http.Client{Timeout: clientTimeout}
-	unzipper := unzip.New(httpClient)
+	storage := storage.New(logger, constants.ServersData)
-	parallelResolver := resolver.NewParallelResolver(options.DNSAddress)
+	currentServers, err := storage.SyncServers(constants.GetAllServers())
-	ipFetcher := ipinfo.New(httpClient)
-	openvpnFileExtractor := extract.New()
-
-	providers := provider.NewProviders(storage, time.Now, logger, httpClient,
-		unzipper, parallelResolver, ipFetcher, openvpnFileExtractor)
-
-	updater := updater.New(httpClient, storage, providers, logger)
-	err = updater.UpdateServers(ctx, options.Providers, options.MinRatio)
 	if err != nil {
-		return fmt.Errorf("updating server information: %w", err)
+		return fmt.Errorf("%w: %s", ErrSyncServers, err)
+	}
+	updater := updater.New(options, httpClient, currentServers, logger)
+	allServers, err := updater.UpdateServers(ctx)
+	if err != nil {
+		return fmt.Errorf("%w: %s", ErrUpdateServerInformation, err)
+	}
+
+	if endUserMode {
+		if err := storage.FlushToFile(allServers); err != nil {
+			return fmt.Errorf("%w: %s", ErrWriteToFile, err)
+		}
 	}
 
 	if maintainerMode {
-		err := storage.FlushToFile(c.repoServersPath)
+		if err := writeToEmbeddedJSON(c.repoServersPath, allServers); err != nil {
-		if err != nil {
+			return fmt.Errorf("%w: %s", ErrWriteToFile, err)
-			return fmt.Errorf("writing servers data to embedded JSON file: %w", err)
 		}
 	}
 
 	return nil
 }
+
+func writeToEmbeddedJSON(repoServersPath string,
+	allServers models.AllServers) error {
+	const perms = 0600
+	f, err := os.OpenFile(repoServersPath,
+		os.O_TRUNC|os.O_WRONLY|os.O_CREATE, perms)
+	if err != nil {
+		return err
+	}
+
+	defer f.Close()
+
+	encoder := json.NewEncoder(f)
+	encoder.SetIndent("", "  ")
+	return encoder.Encode(allServers)
+}

internal/cli/warner.go

@@ -1,5 +0,0 @@
-package cli
-
-type Warner interface {
-	Warn(s string)
-}

internal/configuration/configuration.go

@@ -0,0 +1,3 @@
+// Package configuration reads initial settings from environment variables
+// and secret files.
+package configuration

internal/configuration/constants.go

@@ -0,0 +1,6 @@
+package configuration
+
+const (
+	lastIndent = "|--"
+	indent     = "   "
+)

internal/configuration/cyberghost.go

@@ -0,0 +1,72 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) cyberghostLines() (lines []string) {
+	lines = append(lines, lastIndent+"Server group: "+settings.ServerSelection.Group)
+
+	if len(settings.ServerSelection.Regions) > 0 {
+		lines = append(lines, lastIndent+"Regions: "+commaJoin(settings.ServerSelection.Regions))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	if settings.ExtraConfigOptions.ClientKey != "" {
+		lines = append(lines, lastIndent+"Client key is set")
+	}
+
+	if settings.ExtraConfigOptions.ClientCertificate != "" {
+		lines = append(lines, lastIndent+"Client certificate is set")
+	}
+
+	return lines
+}
+
+func (settings *Provider) readCyberghost(r reader) (err error) {
+	settings.Name = constants.Cyberghost
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ExtraConfigOptions.ClientKey, err = readClientKey(r)
+	if err != nil {
+		return err
+	}
+
+	settings.ExtraConfigOptions.ClientCertificate, err = readClientCertificate(r)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Group, err = r.env.Inside("CYBERGHOST_GROUP",
+		constants.CyberghostGroupChoices(), params.Default("Premium UDP Europe"))
+	if err != nil {
+		return fmt.Errorf("environment variable CYBERGHOST_GROUP: %w", err)
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.CyberghostRegionChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.CyberghostHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return nil
+}

internal/configuration/dns.go

@@ -0,0 +1,117 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"net"
+	"strings"
+	"time"
+
+	"github.com/qdm12/dns/pkg/blacklist"
+	"github.com/qdm12/dns/pkg/unbound"
+	"github.com/qdm12/golibs/params"
+)
+
+// DNS contains settings to configure Unbound for DNS over TLS operation.
+type DNS struct { //nolint:maligned
+	Enabled          bool
+	PlaintextAddress net.IP
+	KeepNameserver   bool
+	UpdatePeriod     time.Duration
+	Unbound          unbound.Settings
+	BlacklistBuild   blacklist.BuilderSettings
+}
+
+func (settings *DNS) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *DNS) lines() (lines []string) {
+	lines = append(lines, lastIndent+"DNS:")
+
+	if settings.PlaintextAddress != nil {
+		lines = append(lines, indent+lastIndent+"Plaintext address: "+settings.PlaintextAddress.String())
+	}
+
+	if settings.KeepNameserver {
+		lines = append(lines, indent+lastIndent+"Keep nameserver (disabled blocking): yes")
+	}
+
+	if !settings.Enabled {
+		return lines
+	}
+
+	lines = append(lines, indent+lastIndent+"DNS over TLS:")
+
+	lines = append(lines, indent+indent+lastIndent+"Unbound:")
+	for _, line := range settings.Unbound.Lines() {
+		lines = append(lines, indent+indent+indent+line)
+	}
+
+	lines = append(lines, indent+indent+lastIndent+"Blacklist:")
+	for _, line := range settings.BlacklistBuild.Lines(indent, lastIndent) {
+		lines = append(lines, indent+indent+indent+line)
+	}
+
+	if settings.UpdatePeriod > 0 {
+		lines = append(lines, indent+indent+lastIndent+"Update: every "+settings.UpdatePeriod.String())
+	}
+
+	return lines
+}
+
+var (
+	ErrUnboundSettings   = errors.New("failed getting Unbound settings")
+	ErrBlacklistSettings = errors.New("failed getting DNS blacklist settings")
+)
+
+func (settings *DNS) read(r reader) (err error) {
+	settings.Enabled, err = r.env.OnOff("DOT", params.Default("on"))
+	if err != nil {
+		return fmt.Errorf("environment variable DOT: %w", err)
+	}
+
+	// Plain DNS settings
+	if err := settings.readDNSPlaintext(r.env); err != nil {
+		return err
+	}
+	settings.KeepNameserver, err = r.env.OnOff("DNS_KEEP_NAMESERVER", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable DNS_KEEP_NAMESERVER: %w", err)
+	}
+
+	// DNS over TLS external settings
+	if err := settings.readBlacklistBuilding(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrBlacklistSettings, err)
+	}
+
+	settings.UpdatePeriod, err = r.env.Duration("DNS_UPDATE_PERIOD", params.Default("24h"))
+	if err != nil {
+		return fmt.Errorf("environment variable DNS_UPDATE_PERIOD: %w", err)
+	}
+
+	// Unbound settings
+	if err := settings.readUnbound(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrUnboundSettings, err)
+	}
+
+	return nil
+}
+
+var (
+	ErrDNSAddressNotAnIP = errors.New("DNS plaintext address is not an IP address")
+)
+
+func (settings *DNS) readDNSPlaintext(env params.Env) error {
+	s, err := env.Get("DNS_PLAINTEXT_ADDRESS", params.Default("1.1.1.1"))
+	if err != nil {
+		return fmt.Errorf("environment variable DNS_PLAINTEXT_ADDRESS: %w", err)
+	}
+
+	settings.PlaintextAddress = net.ParseIP(s)
+	if settings.PlaintextAddress == nil {
+		return fmt.Errorf("%w: %s", ErrDNSAddressNotAnIP, s)
+	}
+
+	return nil
+}

internal/configuration/dns_test.go

@@ -0,0 +1,76 @@
+package configuration
+
+import (
+	"net"
+	"testing"
+	"time"
+
+	"github.com/qdm12/dns/pkg/blacklist"
+	"github.com/qdm12/dns/pkg/provider"
+	"github.com/qdm12/dns/pkg/unbound"
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_DNS_Lines(t *testing.T) {
+	t.Parallel()
+	testCases := map[string]struct {
+		settings DNS
+		lines    []string
+	}{
+		"disabled DOT": {
+			settings: DNS{
+				PlaintextAddress: net.IP{1, 1, 1, 1},
+			},
+			lines: []string{
+				"|--DNS:",
+				"   |--Plaintext address: 1.1.1.1",
+			},
+		},
+		"enabled DOT": {
+			settings: DNS{
+				Enabled:        true,
+				KeepNameserver: true,
+				Unbound: unbound.Settings{
+					Providers: []provider.Provider{
+						provider.Cloudflare(),
+					},
+				},
+				BlacklistBuild: blacklist.BuilderSettings{
+					BlockMalicious:    true,
+					BlockAds:          true,
+					BlockSurveillance: true,
+				},
+				UpdatePeriod: time.Hour,
+			},
+			lines: []string{
+				"|--DNS:",
+				"   |--Keep nameserver (disabled blocking): yes",
+				"   |--DNS over TLS:",
+				"      |--Unbound:",
+				"          |--DNS over TLS providers:",
+				"              |--Cloudflare",
+				"          |--Listening port: 0",
+				"          |--Access control:",
+				"              |--Allowed:",
+				"          |--Caching: disabled",
+				"          |--IPv4 resolution: disabled",
+				"          |--IPv6 resolution: disabled",
+				"          |--Verbosity level: 0/5",
+				"          |--Verbosity details level: 0/4",
+				"          |--Validation log level: 0/2",
+				"          |--Username: ",
+				"      |--Blacklist:",
+				"         |--Blocked categories: malicious, surveillance, ads",
+				"      |--Update: every 1h0m0s",
+			},
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			lines := testCase.settings.lines()
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}

internal/configuration/dnsblacklist.go

@@ -0,0 +1,87 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/qdm12/golibs/params"
+	"inet.af/netaddr"
+)
+
+func (settings *DNS) readBlacklistBuilding(r reader) (err error) {
+	settings.BlacklistBuild.BlockMalicious, err = r.env.OnOff("BLOCK_MALICIOUS", params.Default("on"))
+	if err != nil {
+		return fmt.Errorf("environment variable BLOCK_MALICIOUS: %w", err)
+	}
+
+	settings.BlacklistBuild.BlockSurveillance, err = r.env.OnOff("BLOCK_SURVEILLANCE", params.Default("on"),
+		params.RetroKeys([]string{"BLOCK_NSA"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable BLOCK_SURVEILLANCE (or BLOCK_NSA): %w", err)
+	}
+
+	settings.BlacklistBuild.BlockAds, err = r.env.OnOff("BLOCK_ADS", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable BLOCK_ADS: %w", err)
+	}
+
+	if err := settings.readPrivateAddresses(r.env); err != nil {
+		return err
+	}
+
+	return settings.readBlacklistUnblockedHostnames(r)
+}
+
+var (
+	ErrInvalidPrivateAddress = errors.New("private address is not a valid IP or CIDR range")
+)
+
+func (settings *DNS) readPrivateAddresses(env params.Env) (err error) {
+	privateAddresses, err := env.CSV("DOT_PRIVATE_ADDRESS")
+	if err != nil {
+		return fmt.Errorf("environment variable DOT_PRIVATE_ADDRESS: %w", err)
+	} else if len(privateAddresses) == 0 {
+		return nil
+	}
+
+	ips := make([]netaddr.IP, 0, len(privateAddresses))
+	ipPrefixes := make([]netaddr.IPPrefix, 0, len(privateAddresses))
+
+	for _, address := range privateAddresses {
+		ip, err := netaddr.ParseIP(address)
+		if err == nil {
+			ips = append(ips, ip)
+			continue
+		}
+
+		ipPrefix, err := netaddr.ParseIPPrefix(address)
+		if err == nil {
+			ipPrefixes = append(ipPrefixes, ipPrefix)
+			continue
+		}
+
+		return fmt.Errorf("%w: %s", ErrInvalidPrivateAddress, address)
+	}
+
+	settings.BlacklistBuild.AddBlockedIPs = append(settings.BlacklistBuild.AddBlockedIPs, ips...)
+	settings.BlacklistBuild.AddBlockedIPPrefixes = append(settings.BlacklistBuild.AddBlockedIPPrefixes, ipPrefixes...)
+
+	return nil
+}
+
+func (settings *DNS) readBlacklistUnblockedHostnames(r reader) (err error) {
+	hostnames, err := r.env.CSV("UNBLOCK")
+	if err != nil {
+		return fmt.Errorf("environment variable UNBLOCK: %w", err)
+	} else if len(hostnames) == 0 {
+		return nil
+	}
+	for _, hostname := range hostnames {
+		if !r.regex.MatchHostname(hostname) {
+			return fmt.Errorf("%w: %s", ErrInvalidHostname, hostname)
+		}
+	}
+
+	settings.BlacklistBuild.AllowedHosts = append(settings.BlacklistBuild.AllowedHosts, hostnames...)
+	return nil
+}

internal/configuration/fastestvpn.go

@@ -0,0 +1,45 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) fastestvpnLines() (lines []string) {
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	if len(settings.ServerSelection.Countries) > 0 {
+		lines = append(lines, lastIndent+"Countries: "+commaJoin(settings.ServerSelection.Countries))
+	}
+
+	return lines
+}
+
+func (settings *Provider) readFastestvpn(r reader) (err error) {
+	settings.Name = constants.Fastestvpn
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.FastestvpnHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.FastestvpnCountriesChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	return nil
+}

internal/configuration/firewall.go

@@ -0,0 +1,99 @@
+package configuration
+
+import (
+	"fmt"
+	"net"
+	"strings"
+
+	"github.com/qdm12/golibs/params"
+)
+
+// Firewall contains settings to customize the firewall operation.
+type Firewall struct {
+	VPNInputPorts   []uint16
+	InputPorts      []uint16
+	OutboundSubnets []net.IPNet
+	Enabled         bool
+	Debug           bool
+}
+
+func (settings *Firewall) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *Firewall) lines() (lines []string) {
+	if !settings.Enabled {
+		lines = append(lines, lastIndent+"Firewall: disabled ⚠️")
+		return lines
+	}
+
+	lines = append(lines, lastIndent+"Firewall:")
+
+	if settings.Debug {
+		lines = append(lines, indent+lastIndent+"Debug: on")
+	}
+
+	if len(settings.VPNInputPorts) > 0 {
+		lines = append(lines, indent+lastIndent+"VPN input ports: "+
+			strings.Join(uint16sToStrings(settings.VPNInputPorts), ", "))
+	}
+
+	if len(settings.InputPorts) > 0 {
+		lines = append(lines, indent+lastIndent+"Input ports: "+
+			strings.Join(uint16sToStrings(settings.InputPorts), ", "))
+	}
+
+	if len(settings.OutboundSubnets) > 0 {
+		lines = append(lines, indent+lastIndent+"Outbound subnets: "+
+			strings.Join(ipNetsToStrings(settings.OutboundSubnets), ", "))
+	}
+
+	return lines
+}
+
+func (settings *Firewall) read(r reader) (err error) {
+	settings.Enabled, err = r.env.OnOff("FIREWALL", params.Default("on"))
+	if err != nil {
+		return fmt.Errorf("environment variable FIREWALL: %w", err)
+	}
+
+	settings.Debug, err = r.env.OnOff("FIREWALL_DEBUG", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable FIREWALL_DEBUG: %w", err)
+	}
+
+	if err := settings.readVPNInputPorts(r.env); err != nil {
+		return err
+	}
+
+	if err := settings.readInputPorts(r.env); err != nil {
+		return err
+	}
+
+	return settings.readOutboundSubnets(r)
+}
+
+func (settings *Firewall) readVPNInputPorts(env params.Env) (err error) {
+	settings.VPNInputPorts, err = readCSVPorts(env, "FIREWALL_VPN_INPUT_PORTS")
+	if err != nil {
+		return fmt.Errorf("environment variable FIREWALL_VPN_INPUT_PORTS: %w", err)
+	}
+	return nil
+}
+
+func (settings *Firewall) readInputPorts(env params.Env) (err error) {
+	settings.InputPorts, err = readCSVPorts(env, "FIREWALL_INPUT_PORTS")
+	if err != nil {
+		return fmt.Errorf("environment variable FIREWALL_INPUT_PORTS: %w", err)
+	}
+	return nil
+}
+
+func (settings *Firewall) readOutboundSubnets(r reader) (err error) {
+	retroOption := params.RetroKeys([]string{"EXTRA_SUBNETS"}, r.onRetroActive)
+	settings.OutboundSubnets, err = readCSVIPNets(r.env, "FIREWALL_OUTBOUND_SUBNETS", retroOption)
+	if err != nil {
+		return fmt.Errorf("environment variable FIREWALL_OUTBOUND_SUBNETS: %w", err)
+	}
+	return nil
+}

internal/configuration/health.go

@@ -0,0 +1,62 @@
+package configuration
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/golibs/params"
+)
+
+// Health contains settings for the healthcheck and health server.
+type Health struct {
+	ServerAddress string
+	OpenVPN       HealthyWait
+}
+
+func (settings *Health) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *Health) lines() (lines []string) {
+	lines = append(lines, lastIndent+"Health:")
+
+	lines = append(lines, indent+lastIndent+"Server address: "+settings.ServerAddress)
+
+	lines = append(lines, indent+lastIndent+"OpenVPN:")
+	for _, line := range settings.OpenVPN.lines() {
+		lines = append(lines, indent+indent+line)
+	}
+
+	return lines
+}
+
+// Read is to be used for the healthcheck query mode.
+func (settings *Health) Read(env params.Env, logger logging.Logger) (err error) {
+	reader := newReader(env, logger)
+	return settings.read(reader)
+}
+
+func (settings *Health) read(r reader) (err error) {
+	var warning string
+	settings.ServerAddress, warning, err = r.env.ListeningAddress(
+		"HEALTH_SERVER_ADDRESS", params.Default("127.0.0.1:9999"))
+	if warning != "" {
+		r.logger.Warn("environment variable HEALTH_SERVER_ADDRESS: " + warning)
+	}
+	if err != nil {
+		return fmt.Errorf("environment variable HEALTH_SERVER_ADDRESS: %w", err)
+	}
+
+	settings.OpenVPN.Initial, err = r.env.Duration("HEALTH_OPENVPN_DURATION_INITIAL", params.Default("6s"))
+	if err != nil {
+		return fmt.Errorf("environment variable HEALTH_OPENVPN_DURATION_INITIAL: %w", err)
+	}
+
+	settings.OpenVPN.Addition, err = r.env.Duration("HEALTH_OPENVPN_DURATION_ADDITION", params.Default("5s"))
+	if err != nil {
+		return fmt.Errorf("environment variable HEALTH_OPENVPN_DURATION_ADDITION: %w", err)
+	}
+
+	return nil
+}

internal/configuration/health_test.go

@@ -0,0 +1,182 @@
+package configuration
+
+import (
+	"errors"
+	"testing"
+	"time"
+
+	"github.com/golang/mock/gomock"
+	"github.com/qdm12/golibs/logging/mock_logging"
+	"github.com/qdm12/golibs/params/mock_params"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_Health_String(t *testing.T) {
+	t.Parallel()
+
+	var health Health
+	const expected = "|--Health:\n   |--Server address: \n   |--OpenVPN:\n      |--Initial duration: 0s"
+
+	s := health.String()
+
+	assert.Equal(t, expected, s)
+}
+
+func Test_Health_lines(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		settings Health
+		lines    []string
+	}{
+		"empty": {
+			lines: []string{
+				"|--Health:",
+				"   |--Server address: ",
+				"   |--OpenVPN:",
+				"      |--Initial duration: 0s",
+			},
+		},
+		"filled settings": {
+			settings: Health{
+				ServerAddress: "address:9999",
+				OpenVPN: HealthyWait{
+					Initial:  time.Second,
+					Addition: time.Minute,
+				},
+			},
+			lines: []string{
+				"|--Health:",
+				"   |--Server address: address:9999",
+				"   |--OpenVPN:",
+				"      |--Initial duration: 1s",
+				"      |--Addition duration: 1m0s",
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			lines := testCase.settings.lines()
+
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}
+
+func Test_Health_read(t *testing.T) {
+	t.Parallel()
+
+	errDummy := errors.New("dummy")
+
+	testCases := map[string]struct {
+		openvpnInitialDuration  time.Duration
+		openvpnInitialErr       error
+		openvpnAdditionDuration time.Duration
+		openvpnAdditionErr      error
+		serverAddress           string
+		serverAddressWarning    string
+		serverAddressErr        error
+		expected                Health
+		err                     error
+	}{
+		"success": {
+			openvpnInitialDuration:  time.Second,
+			openvpnAdditionDuration: time.Minute,
+			serverAddress:           "127.0.0.1:9999",
+			expected: Health{
+				ServerAddress: "127.0.0.1:9999",
+				OpenVPN: HealthyWait{
+					Initial:  time.Second,
+					Addition: time.Minute,
+				},
+			},
+		},
+		"listening address error": {
+			openvpnInitialDuration:  time.Second,
+			openvpnAdditionDuration: time.Minute,
+			serverAddress:           "127.0.0.1:9999",
+			serverAddressWarning:    "warning",
+			serverAddressErr:        errDummy,
+			expected: Health{
+				ServerAddress: "127.0.0.1:9999",
+			},
+			err: errors.New("environment variable HEALTH_SERVER_ADDRESS: dummy"),
+		},
+		"initial error": {
+			openvpnInitialDuration:  time.Second,
+			openvpnInitialErr:       errDummy,
+			openvpnAdditionDuration: time.Minute,
+			expected: Health{
+				OpenVPN: HealthyWait{
+					Initial: time.Second,
+				},
+			},
+			err: errors.New("environment variable HEALTH_OPENVPN_DURATION_INITIAL: dummy"),
+		},
+		"addition error": {
+			openvpnInitialDuration:  time.Second,
+			openvpnAdditionDuration: time.Minute,
+			openvpnAdditionErr:      errDummy,
+			expected: Health{
+				OpenVPN: HealthyWait{
+					Initial:  time.Second,
+					Addition: time.Minute,
+				},
+			},
+			err: errors.New("environment variable HEALTH_OPENVPN_DURATION_ADDITION: dummy"),
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			ctrl := gomock.NewController(t)
+
+			env := mock_params.NewMockEnv(ctrl)
+			logger := mock_logging.NewMockLogger(ctrl)
+
+			env.EXPECT().ListeningAddress("HEALTH_SERVER_ADDRESS", gomock.Any()).
+				Return(testCase.serverAddress, testCase.serverAddressWarning,
+					testCase.serverAddressErr)
+			if testCase.serverAddressWarning != "" {
+				logger.EXPECT().Warn("environment variable HEALTH_SERVER_ADDRESS: " + testCase.serverAddressWarning)
+			}
+
+			if testCase.serverAddressErr == nil {
+				env.EXPECT().
+					Duration("HEALTH_OPENVPN_DURATION_INITIAL", gomock.Any()).
+					Return(testCase.openvpnInitialDuration, testCase.openvpnInitialErr)
+				if testCase.openvpnInitialErr == nil {
+					env.EXPECT().
+						Duration("HEALTH_OPENVPN_DURATION_ADDITION", gomock.Any()).
+						Return(testCase.openvpnAdditionDuration, testCase.openvpnAdditionErr)
+				}
+			}
+
+			r := reader{
+				env:    env,
+				logger: logger,
+			}
+
+			var health Health
+
+			err := health.read(r)
+
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+
+			assert.Equal(t, testCase.expected, health)
+		})
+	}
+}

internal/configuration/healthwait_test.go

@@ -0,0 +1,55 @@
+package configuration
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_HealthyWait_String(t *testing.T) {
+	t.Parallel()
+
+	var healthyWait HealthyWait
+	const expected = "|--Initial duration: 0s"
+
+	s := healthyWait.String()
+
+	assert.Equal(t, expected, s)
+}
+
+func Test_HealthyWait_lines(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		settings HealthyWait
+		lines    []string
+	}{
+		"empty": {
+			lines: []string{
+				"|--Initial duration: 0s",
+			},
+		},
+		"filled settings": {
+			settings: HealthyWait{
+				Initial:  time.Second,
+				Addition: time.Minute,
+			},
+			lines: []string{
+				"|--Initial duration: 1s",
+				"|--Addition duration: 1m0s",
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			lines := testCase.settings.lines()
+
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}

internal/configuration/healthywait.go

@@ -0,0 +1,30 @@
+package configuration
+
+import (
+	"strings"
+	"time"
+)
+
+type HealthyWait struct {
+	// Initial is the initial duration to wait for the program
+	// to be healthy before taking action.
+	Initial time.Duration
+	// Addition is the duration to add to the Initial duration
+	// after Initial has expired to wait longer for the program
+	// to be healthy.
+	Addition time.Duration
+}
+
+func (settings *HealthyWait) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *HealthyWait) lines() (lines []string) {
+	lines = append(lines, lastIndent+"Initial duration: "+settings.Initial.String())
+
+	if settings.Addition > 0 {
+		lines = append(lines, lastIndent+"Addition duration: "+settings.Addition.String())
+	}
+
+	return lines
+}

internal/configuration/hidemyass.go

@@ -0,0 +1,63 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) hideMyAssLines() (lines []string) {
+	if len(settings.ServerSelection.Countries) > 0 {
+		lines = append(lines, lastIndent+"Countries: "+commaJoin(settings.ServerSelection.Countries))
+	}
+
+	if len(settings.ServerSelection.Regions) > 0 {
+		lines = append(lines, lastIndent+"Regions: "+commaJoin(settings.ServerSelection.Regions))
+	}
+
+	if len(settings.ServerSelection.Cities) > 0 {
+		lines = append(lines, lastIndent+"Cities: "+commaJoin(settings.ServerSelection.Cities))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	return lines
+}
+
+func (settings *Provider) readHideMyAss(r reader) (err error) {
+	settings.Name = constants.HideMyAss
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.HideMyAssCountryChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.HideMyAssCountryChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.HideMyAssCityChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.HideMyAssHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return nil
+}

internal/configuration/httpproxy.go

@@ -0,0 +1,106 @@
+package configuration
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/qdm12/golibs/params"
+)
+
+// HTTPProxy contains settings to configure the HTTP proxy.
+type HTTPProxy struct {
+	User     string
+	Password string
+	Port     uint16
+	Enabled  bool
+	Stealth  bool
+	Log      bool
+}
+
+func (settings *HTTPProxy) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *HTTPProxy) lines() (lines []string) {
+	if !settings.Enabled {
+		return nil
+	}
+
+	lines = append(lines, lastIndent+"HTTP proxy:")
+
+	lines = append(lines, indent+lastIndent+"Port: "+strconv.Itoa(int(settings.Port)))
+
+	if settings.User != "" {
+		lines = append(lines, indent+lastIndent+"Authentication: enabled")
+	}
+
+	if settings.Log {
+		lines = append(lines, indent+lastIndent+"Log: enabled")
+	}
+
+	if settings.Stealth {
+		lines = append(lines, indent+lastIndent+"Stealth: enabled")
+	}
+
+	return lines
+}
+
+func (settings *HTTPProxy) read(r reader) (err error) {
+	settings.Enabled, err = r.env.OnOff("HTTPPROXY", params.Default("off"),
+		params.RetroKeys([]string{"TINYPROXY", "PROXY"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY (or TINYPROXY, PROXY): %w", err)
+	}
+
+	settings.User, err = r.getFromEnvOrSecretFile("HTTPPROXY_USER", false, // compulsory
+		[]string{"TINYPROXY_USER", "PROXY_USER"})
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY_USER (or TINYPROXY_USER, PROXY_USER): %w", err)
+	}
+
+	settings.Password, err = r.getFromEnvOrSecretFile("HTTPPROXY_PASSWORD", false,
+		[]string{"TINYPROXY_PASSWORD", "PROXY_PASSWORD"})
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY_PASSWORD (or TINYPROXY_PASSWORD, PROXY_PASSWORD): %w", err)
+	}
+
+	settings.Stealth, err = r.env.OnOff("HTTPPROXY_STEALTH", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY_STEALTH: %w", err)
+	}
+
+	if err := settings.readLog(r); err != nil {
+		return err
+	}
+
+	var warning string
+	settings.Port, warning, err = r.env.ListeningPort("HTTPPROXY_PORT", params.Default("8888"),
+		params.RetroKeys([]string{"TINYPROXY_PORT", "PROXY_PORT"}, r.onRetroActive))
+	if len(warning) > 0 {
+		r.logger.Warn(warning)
+	}
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY_PORT (or TINYPROXY_PORT, PROXY_PORT): %w", err)
+	}
+
+	return nil
+}
+
+func (settings *HTTPProxy) readLog(r reader) error {
+	s, err := r.env.Get("HTTPPROXY_LOG",
+		params.RetroKeys([]string{"PROXY_LOG_LEVEL", "TINYPROXY_LOG"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY_LOG (or TINYPROXY_LOG, PROXY_LOG_LEVEL): %w", err)
+	}
+
+	switch strings.ToLower(s) {
+	case "on":
+		settings.Log = true
+	// Retro compatibility
+	case "info", "connect", "notice":
+		settings.Log = true
+	}
+
+	return nil
+}

internal/configuration/ipvanish.go

@@ -0,0 +1,54 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) ipvanishLines() (lines []string) {
+	if len(settings.ServerSelection.Countries) > 0 {
+		lines = append(lines, lastIndent+"Countries: "+commaJoin(settings.ServerSelection.Countries))
+	}
+
+	if len(settings.ServerSelection.Cities) > 0 {
+		lines = append(lines, lastIndent+"Cities: "+commaJoin(settings.ServerSelection.Cities))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	return lines
+}
+
+func (settings *Provider) readIpvanish(r reader) (err error) {
+	settings.Name = constants.Ipvanish
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.IpvanishCountryChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.IpvanishCityChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.IpvanishHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return nil
+}

internal/configuration/ipvanish_test.go

@@ -0,0 +1,192 @@
+package configuration
+
+import (
+	"errors"
+	"net"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params/mock_params"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_Provider_ipvanishLines(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		settings Provider
+		lines    []string
+	}{
+		"empty settings": {},
+		"full settings": {
+			settings: Provider{
+				ServerSelection: ServerSelection{
+					Countries: []string{"A", "B"},
+					Cities:    []string{"C", "D"},
+					Hostnames: []string{"E", "F"},
+				},
+			},
+			lines: []string{
+				"|--Countries: A, B",
+				"|--Cities: C, D",
+				"|--Hostnames: E, F",
+			},
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			lines := testCase.settings.ipvanishLines()
+
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}
+
+func Test_Provider_readIpvanish(t *testing.T) {
+	t.Parallel()
+
+	var errDummy = errors.New("dummy test error")
+
+	type singleStringCall struct {
+		call  bool
+		value string
+		err   error
+	}
+
+	type sliceStringCall struct {
+		call   bool
+		values []string
+		err    error
+	}
+
+	testCases := map[string]struct {
+		protocol  singleStringCall
+		targetIP  singleStringCall
+		countries sliceStringCall
+		cities    sliceStringCall
+		hostnames sliceStringCall
+		settings  Provider
+		err       error
+	}{
+		"protocol error": {
+			protocol: singleStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+			err: errors.New("environment variable PROTOCOL: dummy test error"),
+		},
+		"target IP error": {
+			protocol: singleStringCall{call: true},
+			targetIP: singleStringCall{call: true, value: "something", err: errDummy},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+			err: errors.New("environment variable OPENVPN_TARGET_IP: dummy test error"),
+		},
+		"countries error": {
+			protocol:  singleStringCall{call: true},
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+			err: errors.New("environment variable COUNTRY: dummy test error"),
+		},
+		"cities error": {
+			protocol:  singleStringCall{call: true},
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+			err: errors.New("environment variable CITY: dummy test error"),
+		},
+		"hostnames error": {
+			protocol:  singleStringCall{call: true},
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+			err: errors.New("environment variable SERVER_HOSTNAME: dummy test error"),
+		},
+		"default settings": {
+			protocol:  singleStringCall{call: true},
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+		},
+		"set settings": {
+			protocol:  singleStringCall{call: true, value: constants.TCP},
+			targetIP:  singleStringCall{call: true, value: "1.2.3.4"},
+			countries: sliceStringCall{call: true, values: []string{"A", "B"}},
+			cities:    sliceStringCall{call: true, values: []string{"C", "D"}},
+			hostnames: sliceStringCall{call: true, values: []string{"E", "F"}},
+			settings: Provider{
+				Name: constants.Ipvanish,
+				ServerSelection: ServerSelection{
+					TCP:       true,
+					TargetIP:  net.IPv4(1, 2, 3, 4),
+					Countries: []string{"A", "B"},
+					Cities:    []string{"C", "D"},
+					Hostnames: []string{"E", "F"},
+				},
+			},
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			ctrl := gomock.NewController(t)
+
+			env := mock_params.NewMockEnv(ctrl)
+			if testCase.protocol.call {
+				env.EXPECT().Inside("PROTOCOL", []string{constants.TCP, constants.UDP}, gomock.Any()).
+					Return(testCase.protocol.value, testCase.protocol.err)
+			}
+			if testCase.targetIP.call {
+				env.EXPECT().Get("OPENVPN_TARGET_IP").
+					Return(testCase.targetIP.value, testCase.targetIP.err)
+			}
+			if testCase.countries.call {
+				env.EXPECT().CSVInside("COUNTRY", constants.IpvanishCountryChoices()).
+					Return(testCase.countries.values, testCase.countries.err)
+			}
+			if testCase.cities.call {
+				env.EXPECT().CSVInside("CITY", constants.IpvanishCityChoices()).
+					Return(testCase.cities.values, testCase.cities.err)
+			}
+			if testCase.hostnames.call {
+				env.EXPECT().CSVInside("SERVER_HOSTNAME", constants.IpvanishHostnameChoices()).
+					Return(testCase.hostnames.values, testCase.hostnames.err)
+			}
+
+			r := reader{env: env}
+
+			var settings Provider
+			err := settings.readIpvanish(r)
+
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+
+			assert.Equal(t, testCase.settings, settings)
+		})
+	}
+}

internal/configuration/ivpn.go

@@ -0,0 +1,54 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) ivpnLines() (lines []string) {
+	if len(settings.ServerSelection.Countries) > 0 {
+		lines = append(lines, lastIndent+"Countries: "+commaJoin(settings.ServerSelection.Countries))
+	}
+
+	if len(settings.ServerSelection.Cities) > 0 {
+		lines = append(lines, lastIndent+"Cities: "+commaJoin(settings.ServerSelection.Cities))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	return lines
+}
+
+func (settings *Provider) readIvpn(r reader) (err error) {
+	settings.Name = constants.Ivpn
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.IvpnCountryChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.IvpnCityChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.IvpnHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return nil
+}

internal/configuration/ivpn_test.go

@@ -0,0 +1,192 @@
+package configuration
+
+import (
+	"errors"
+	"net"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params/mock_params"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_Provider_ivpnLines(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		settings Provider
+		lines    []string
+	}{
+		"empty settings": {},
+		"full settings": {
+			settings: Provider{
+				ServerSelection: ServerSelection{
+					Countries: []string{"A", "B"},
+					Cities:    []string{"C", "D"},
+					Hostnames: []string{"E", "F"},
+				},
+			},
+			lines: []string{
+				"|--Countries: A, B",
+				"|--Cities: C, D",
+				"|--Hostnames: E, F",
+			},
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			lines := testCase.settings.ivpnLines()
+
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}
+
+func Test_Provider_readIvpn(t *testing.T) {
+	t.Parallel()
+
+	var errDummy = errors.New("dummy test error")
+
+	type singleStringCall struct {
+		call  bool
+		value string
+		err   error
+	}
+
+	type sliceStringCall struct {
+		call   bool
+		values []string
+		err    error
+	}
+
+	testCases := map[string]struct {
+		protocol  singleStringCall
+		targetIP  singleStringCall
+		countries sliceStringCall
+		cities    sliceStringCall
+		hostnames sliceStringCall
+		settings  Provider
+		err       error
+	}{
+		"protocol error": {
+			protocol: singleStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable PROTOCOL: dummy test error"),
+		},
+		"target IP error": {
+			protocol: singleStringCall{call: true},
+			targetIP: singleStringCall{call: true, value: "something", err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable OPENVPN_TARGET_IP: dummy test error"),
+		},
+		"countries error": {
+			protocol:  singleStringCall{call: true},
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable COUNTRY: dummy test error"),
+		},
+		"cities error": {
+			protocol:  singleStringCall{call: true},
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable CITY: dummy test error"),
+		},
+		"hostnames error": {
+			protocol:  singleStringCall{call: true},
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable SERVER_HOSTNAME: dummy test error"),
+		},
+		"default settings": {
+			protocol:  singleStringCall{call: true},
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+		},
+		"set settings": {
+			protocol:  singleStringCall{call: true, value: constants.TCP},
+			targetIP:  singleStringCall{call: true, value: "1.2.3.4"},
+			countries: sliceStringCall{call: true, values: []string{"A", "B"}},
+			cities:    sliceStringCall{call: true, values: []string{"C", "D"}},
+			hostnames: sliceStringCall{call: true, values: []string{"E", "F"}},
+			settings: Provider{
+				Name: constants.Ivpn,
+				ServerSelection: ServerSelection{
+					TCP:       true,
+					TargetIP:  net.IPv4(1, 2, 3, 4),
+					Countries: []string{"A", "B"},
+					Cities:    []string{"C", "D"},
+					Hostnames: []string{"E", "F"},
+				},
+			},
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			ctrl := gomock.NewController(t)
+
+			env := mock_params.NewMockEnv(ctrl)
+			if testCase.protocol.call {
+				env.EXPECT().Inside("PROTOCOL", []string{constants.TCP, constants.UDP}, gomock.Any()).
+					Return(testCase.protocol.value, testCase.protocol.err)
+			}
+			if testCase.targetIP.call {
+				env.EXPECT().Get("OPENVPN_TARGET_IP").
+					Return(testCase.targetIP.value, testCase.targetIP.err)
+			}
+			if testCase.countries.call {
+				env.EXPECT().CSVInside("COUNTRY", constants.IvpnCountryChoices()).
+					Return(testCase.countries.values, testCase.countries.err)
+			}
+			if testCase.cities.call {
+				env.EXPECT().CSVInside("CITY", constants.IvpnCityChoices()).
+					Return(testCase.cities.values, testCase.cities.err)
+			}
+			if testCase.hostnames.call {
+				env.EXPECT().CSVInside("SERVER_HOSTNAME", constants.IvpnHostnameChoices()).
+					Return(testCase.hostnames.values, testCase.hostnames.err)
+			}
+
+			r := reader{env: env}
+
+			var settings Provider
+			err := settings.readIvpn(r)
+
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+
+			assert.Equal(t, testCase.settings, settings)
+		})
+	}
+}

internal/configuration/keys.go

@@ -0,0 +1,55 @@
+package configuration
+
+import (
+	"encoding/pem"
+	"errors"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func readClientKey(r reader) (clientKey string, err error) {
+	b, err := r.getFromFileOrSecretFile("OPENVPN_CLIENTKEY", constants.ClientKey)
+	if err != nil {
+		return "", err
+	}
+	return extractClientKey(b)
+}
+
+var errDecodePEMBlockClientKey = errors.New("cannot decode PEM block from client key")
+
+func extractClientKey(b []byte) (key string, err error) {
+	pemBlock, _ := pem.Decode(b)
+	if pemBlock == nil {
+		return "", errDecodePEMBlockClientKey
+	}
+	parsedBytes := pem.EncodeToMemory(pemBlock)
+	s := string(parsedBytes)
+	s = strings.ReplaceAll(s, "\n", "")
+	s = strings.TrimPrefix(s, "-----BEGIN PRIVATE KEY-----")
+	s = strings.TrimSuffix(s, "-----END PRIVATE KEY-----")
+	return s, nil
+}
+
+func readClientCertificate(r reader) (clientCertificate string, err error) {
+	b, err := r.getFromFileOrSecretFile("OPENVPN_CLIENTCRT", constants.ClientCertificate)
+	if err != nil {
+		return "", err
+	}
+	return extractClientCertificate(b)
+}
+
+var errDecodePEMBlockClientCert = errors.New("cannot decode PEM block from client certificate")
+
+func extractClientCertificate(b []byte) (certificate string, err error) {
+	pemBlock, _ := pem.Decode(b)
+	if pemBlock == nil {
+		return "", errDecodePEMBlockClientCert
+	}
+	parsedBytes := pem.EncodeToMemory(pemBlock)
+	s := string(parsedBytes)
+	s = strings.ReplaceAll(s, "\n", "")
+	s = strings.TrimPrefix(s, "-----BEGIN CERTIFICATE-----")
+	s = strings.TrimSuffix(s, "-----END CERTIFICATE-----")
+	return s, nil
+}

internal/configuration/keys_test.go

@@ -0,0 +1,174 @@
+package configuration
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_extractClientKey(t *testing.T) {
+	t.Parallel()
+	const validPEM = `
+-----BEGIN PRIVATE KEY-----
+MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQCrQDrezCptkWxX
+ywm3KdXtvti+rPF3vfzOmXRKiKXDMpMxzoiaD5Wspirxxjr4C+B14xTwZjJZfxJL
+2HpPdOeBmA5tmAoGUESspnzxR/N1T4Uggx0vlAzFo0UZ0sutV6CJK19Kk38REwlG
+AB8gl6JYeSUuu6qREjrLVwFRH72acvC/p4jBki/MjAfEaeHc0yDJT9jpjpchw+Hx
+Ymy+1BnfNTAfGDdTVx9qWb+ByQ7xfvzuD9AOeqiWApDzZIuDDsaWn2orv+syoJVo
+rV52/F+75zks6+fzQ+0sotBlRyvsZKGi80F89RIHwG+5LNSuRDWnVvrwv1oc6V2/
+lMidwT7yb0kXt0IRW6JzbaHyB2LkPazBlr6IPNupk83x9t2Buw0HI2SQKHMKOChU
+i2/906yLUOo3QpAi3Wk1c/Xu9DvGR/pOA15WCakiAfG3Fq6hUxNncmpOMeOLF/ez
+L19jZ3KA4E2Te4+GA0NYlXgkDbsIILWapHwqHXcDukynHisr7RawjrvXoLyasm4L
+O66aNXK9wtipSMDA7tdlQP6Xe9bHflDHxwreiuEGxnrsvLU7LHBWdD7UT2/u8zdr
+pimqi4L7W5p5aOBMn8jSVCO9+4CAxiLlc2qx5vb4/EPMsdQfacYP7vY9iVh/qPi3
+bcUVGUlg8wAJDrTksxU1K3FVR7BEPwIDAQABAoICAAhyrbTJ+5nWH7MhCASqIqyM
+yqJ1Y6AVlkAW397BaPP9Lbe6SZDYDfkrZVjx/3y3EUafgivtzrQNibiGIFqFGNqS
+xrtvUadIFGsz91vrwb3aw2V8MldjhVHGoSUJ+hQ+C2RY6GWEazNLbhyu6tovwMl+
+iHAKv/pSHOZlD2KSH0dcPjYmLJ/n90Wu7r8ovgSnwalMsBWtfBUlVaMTyOuNCQ2y
+0QHnrusElD8p2EGtynftXMrdqtTcBi8IR2BKaHt5oiBSEum/mPmxZE16p/tUreBW
+IsLtjE663htimMc2QJtzx2mDeIqSiGYrfxdyd7d1E/SCXPS9a9ObS42k6FSn8NPu
+K5kN6fPV5EDM2CqKEt9QZPlyrjZIuffOZtJj0xPuTwhRle4SOtyjn2c/vsv9Fkrp
+B6B1v7T4+SSOIedOYkL+FP/IexMNG/ZTB5Y2hrZ03JW9RGpFAa4//qGG2qUCR3hE
+rVS6v58qO/3+TCFSn/TI8AfcTcJbes3yTbVyLH6NAjATfYqJDJJFf+PG0qKc8q1N
+KvXmT+x4JiBBM32cOg11GPflxIZSKi9He50hnPGnC042N06ba/pkUPG49XwE37hn
+kIGmcFGcDIMDTEZnPBogPFqGpepYdwGWxbadRiUoX2wgurHRRmA0YM32MjVky9C1
+12Q/Jy9PIk/qdjYdWfAhAoIBAQDcvxfUx7MKMFgYYm4E51X+7B9QoxdhVaxcoVgK
+VwfvedsLi0Bk1B1JVSXqnNfyDZbpxFz2v5Xd/dSit2rjnfBm+DoJYN9ZNnrbIH+s
+qsO1DuHZvMZlRDJbpt7PpVH/pcf7rEWRY+avkMMsiGwI/ruDs17eu7jULeG7N4jb
+kh1mdvF7K56O6Xe8jGJu5qaOPRWOkABK1cEOjQ5hB1iAwO/ua5hehP87SvbYzIhz
+nQTE3AqTWgWbIyC4R85U7tS9hsXnSQ/ICM9pWcyN0Y667LwR2tX0QKl5M/YoM0sG
+mw+VQED8O2R45jTzSAcox77dRg55Pp3Xexsp2iVvaTIeAaevAoIBAQDGmZS1gFO4
+TEgQXHdmibLizDUHLuw662GC+3Hilx+nZBZtWOc6t8yquUyggSKQmBDiKAf0ipMe
+xFao+5I3StJJ2P4Vel95Vcu8KgqCF736Q1iNgDHuW8ho8e0y+YE371x5co3POGC0
+SfbcnRTXQx2+wWXzZDh+KtnaDUyDN12/qCIUyAuSVLwEM28ZFM3qadG1aUdCB5oe
+o8jfgsg6YSukm4uE/tuI3/wAI7FkaCqvt/zkLauRff5FcNa7os4EKtNnGfebxscP
+yFYpMsW9VI0rfmYz02gho33lnofs4o8x/gxh6t5zfVbsZ7vUiSDJBahWboG9aE99
+OY2TKb6ibsBxAoIBAQChDBVR2oPnqg+Lcrw7fZ8Cxbeu992F2KBQUDHQEWCruSYy
+zNwk84+OQb3Q5a6yXHG+iNEd//ZRp+8q60/jUgXiybRlxTQNfS6ykYo0Kb1wabQi
+S5Qeq1tl/F9P9JfXQFafaTaz9MOHUMDjy3+uLFIXqpRLQX995R9rm/+P2ZDzgVF5
+///E2dXOTElACax3117TzIE6F6qqeASGi3ppLNmfAwZ95t/inTVsRARE/MhO6w4Y
+JLQ0U7N6XoDM/BVfVGUr8OS/lpXjkW0oBjvwaehnylUPxuEdmOg8ufdBkX0T8XW3
+z4jkn2cAGouGl/vKqWLD2AgF/j16Ejn/hyrWM3TnAoIBAA6lSssrwIDJ11KljwSX
+yQJirtJtymv56cIACwD7xhDRF7pOoRa6cTRx383CWCszm6Mh8pw9D+Zn8kAZ9Ulw
+khtyDiLFWH8ZLaIds5Kub4siJkihGI2MZTYgCS8GKVpXo4ktQnnynWcOQU85okzR
+nULw/jS5wlTDkjc7XdYbYiV9H65KplfPOeJRbLL7zsensBhhwCiFaP8zct/QxDVR
+7yb/dYWESepJIktcVnuiFuvIdLTbDVj4YqT6UkuaEPlLszVaO+FYAlwOmRQGs4Bn
+2NVJR/4wa/B3HxSs4Tc96fN02bLq4CbCKoPajoZ46lsIuMZO9fBi3eHNObyNiopu
+AnECggEBAJiJ0tK/PGh+Q9uv57Z4QcmbawoxMQW1qK/rLYwacYsSpzo8VhbZf+Jh
+8biMg9AIQsLWnqmB3gmndePArGXkSxnilRozNLaeclTZy7rh00BctTEfgee4Kxdi
+JKkJlVK0CE8I6txVRqkoOMyxsk1kRZ4l2yW2nxzyWlJKwvD75x2PQ6xWvpLAggyn
+q00I3MzNIgR123jytN1NyC7l+mnGoC23ToXM7B3/PQjGYTq3jawKomrX1cmwzKBT
++pzjtJSWvMeUEZQS1PpOhxpPBRHagdKXt+ug2DqDtU6rfpDGtTBh5QNkg5SA7lxZ
+zZjrL52saevO25cigVl+hxcnY8DTpbk=
+-----END PRIVATE KEY-----
+`
+	const validKeyString = "MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQCrQDrezCptkWxXywm3KdXtvti+rPF3vfzOmXRKiKXDMpMxzoiaD5Wspirxxjr4C+B14xTwZjJZfxJL2HpPdOeBmA5tmAoGUESspnzxR/N1T4Uggx0vlAzFo0UZ0sutV6CJK19Kk38REwlGAB8gl6JYeSUuu6qREjrLVwFRH72acvC/p4jBki/MjAfEaeHc0yDJT9jpjpchw+HxYmy+1BnfNTAfGDdTVx9qWb+ByQ7xfvzuD9AOeqiWApDzZIuDDsaWn2orv+syoJVorV52/F+75zks6+fzQ+0sotBlRyvsZKGi80F89RIHwG+5LNSuRDWnVvrwv1oc6V2/lMidwT7yb0kXt0IRW6JzbaHyB2LkPazBlr6IPNupk83x9t2Buw0HI2SQKHMKOChUi2/906yLUOo3QpAi3Wk1c/Xu9DvGR/pOA15WCakiAfG3Fq6hUxNncmpOMeOLF/ezL19jZ3KA4E2Te4+GA0NYlXgkDbsIILWapHwqHXcDukynHisr7RawjrvXoLyasm4LO66aNXK9wtipSMDA7tdlQP6Xe9bHflDHxwreiuEGxnrsvLU7LHBWdD7UT2/u8zdrpimqi4L7W5p5aOBMn8jSVCO9+4CAxiLlc2qx5vb4/EPMsdQfacYP7vY9iVh/qPi3bcUVGUlg8wAJDrTksxU1K3FVR7BEPwIDAQABAoICAAhyrbTJ+5nWH7MhCASqIqyMyqJ1Y6AVlkAW397BaPP9Lbe6SZDYDfkrZVjx/3y3EUafgivtzrQNibiGIFqFGNqSxrtvUadIFGsz91vrwb3aw2V8MldjhVHGoSUJ+hQ+C2RY6GWEazNLbhyu6tovwMl+iHAKv/pSHOZlD2KSH0dcPjYmLJ/n90Wu7r8ovgSnwalMsBWtfBUlVaMTyOuNCQ2y0QHnrusElD8p2EGtynftXMrdqtTcBi8IR2BKaHt5oiBSEum/mPmxZE16p/tUreBWIsLtjE663htimMc2QJtzx2mDeIqSiGYrfxdyd7d1E/SCXPS9a9ObS42k6FSn8NPuK5kN6fPV5EDM2CqKEt9QZPlyrjZIuffOZtJj0xPuTwhRle4SOtyjn2c/vsv9FkrpB6B1v7T4+SSOIedOYkL+FP/IexMNG/ZTB5Y2hrZ03JW9RGpFAa4//qGG2qUCR3hErVS6v58qO/3+TCFSn/TI8AfcTcJbes3yTbVyLH6NAjATfYqJDJJFf+PG0qKc8q1NKvXmT+x4JiBBM32cOg11GPflxIZSKi9He50hnPGnC042N06ba/pkUPG49XwE37hnkIGmcFGcDIMDTEZnPBogPFqGpepYdwGWxbadRiUoX2wgurHRRmA0YM32MjVky9C112Q/Jy9PIk/qdjYdWfAhAoIBAQDcvxfUx7MKMFgYYm4E51X+7B9QoxdhVaxcoVgKVwfvedsLi0Bk1B1JVSXqnNfyDZbpxFz2v5Xd/dSit2rjnfBm+DoJYN9ZNnrbIH+sqsO1DuHZvMZlRDJbpt7PpVH/pcf7rEWRY+avkMMsiGwI/ruDs17eu7jULeG7N4jbkh1mdvF7K56O6Xe8jGJu5qaOPRWOkABK1cEOjQ5hB1iAwO/ua5hehP87SvbYzIhznQTE3AqTWgWbIyC4R85U7tS9hsXnSQ/ICM9pWcyN0Y667LwR2tX0QKl5M/YoM0sGmw+VQED8O2R45jTzSAcox77dRg55Pp3Xexsp2iVvaTIeAaevAoIBAQDGmZS1gFO4TEgQXHdmibLizDUHLuw662GC+3Hilx+nZBZtWOc6t8yquUyggSKQmBDiKAf0ipMexFao+5I3StJJ2P4Vel95Vcu8KgqCF736Q1iNgDHuW8ho8e0y+YE371x5co3POGC0SfbcnRTXQx2+wWXzZDh+KtnaDUyDN12/qCIUyAuSVLwEM28ZFM3qadG1aUdCB5oeo8jfgsg6YSukm4uE/tuI3/wAI7FkaCqvt/zkLauRff5FcNa7os4EKtNnGfebxscPyFYpMsW9VI0rfmYz02gho33lnofs4o8x/gxh6t5zfVbsZ7vUiSDJBahWboG9aE99OY2TKb6ibsBxAoIBAQChDBVR2oPnqg+Lcrw7fZ8Cxbeu992F2KBQUDHQEWCruSYyzNwk84+OQb3Q5a6yXHG+iNEd//ZRp+8q60/jUgXiybRlxTQNfS6ykYo0Kb1wabQiS5Qeq1tl/F9P9JfXQFafaTaz9MOHUMDjy3+uLFIXqpRLQX995R9rm/+P2ZDzgVF5///E2dXOTElACax3117TzIE6F6qqeASGi3ppLNmfAwZ95t/inTVsRARE/MhO6w4YJLQ0U7N6XoDM/BVfVGUr8OS/lpXjkW0oBjvwaehnylUPxuEdmOg8ufdBkX0T8XW3z4jkn2cAGouGl/vKqWLD2AgF/j16Ejn/hyrWM3TnAoIBAA6lSssrwIDJ11KljwSXyQJirtJtymv56cIACwD7xhDRF7pOoRa6cTRx383CWCszm6Mh8pw9D+Zn8kAZ9UlwkhtyDiLFWH8ZLaIds5Kub4siJkihGI2MZTYgCS8GKVpXo4ktQnnynWcOQU85okzRnULw/jS5wlTDkjc7XdYbYiV9H65KplfPOeJRbLL7zsensBhhwCiFaP8zct/QxDVR7yb/dYWESepJIktcVnuiFuvIdLTbDVj4YqT6UkuaEPlLszVaO+FYAlwOmRQGs4Bn2NVJR/4wa/B3HxSs4Tc96fN02bLq4CbCKoPajoZ46lsIuMZO9fBi3eHNObyNiopuAnECggEBAJiJ0tK/PGh+Q9uv57Z4QcmbawoxMQW1qK/rLYwacYsSpzo8VhbZf+Jh8biMg9AIQsLWnqmB3gmndePArGXkSxnilRozNLaeclTZy7rh00BctTEfgee4KxdiJKkJlVK0CE8I6txVRqkoOMyxsk1kRZ4l2yW2nxzyWlJKwvD75x2PQ6xWvpLAggynq00I3MzNIgR123jytN1NyC7l+mnGoC23ToXM7B3/PQjGYTq3jawKomrX1cmwzKBT+pzjtJSWvMeUEZQS1PpOhxpPBRHagdKXt+ug2DqDtU6rfpDGtTBh5QNkg5SA7lxZzZjrL52saevO25cigVl+hxcnY8DTpbk=" //nolint:lll
+	testCases := map[string]struct {
+		b   []byte
+		key string
+		err error
+	}{
+		"no input": {
+			err: errDecodePEMBlockClientKey,
+		},
+		"bad input": {
+			b:   []byte{1, 2, 3},
+			err: errDecodePEMBlockClientKey,
+		},
+		"valid key": {
+			b:   []byte(validPEM),
+			key: validKeyString,
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			key, err := extractClientKey(testCase.b)
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+			assert.Equal(t, testCase.key, key)
+		})
+	}
+}
+
+func Test_extractClientCertificate(t *testing.T) {
+	t.Parallel()
+	const validPEM = `
+-----BEGIN CERTIFICATE-----
+MIIGrDCCBJSgAwIBAgIEAdTnfTANBgkqhkiG9w0BAQsFADB7MQswCQYDVQQGEwJS
+TzESMBAGA1UEBxMJQnVjaGFyZXN0MRgwFgYDVQQKEw9DeWJlckdob3N0IFMuQS4x
+GzAZBgNVBAMTEkN5YmVyR2hvc3QgUm9vdCBDQTEhMB8GCSqGSIb3DQEJARYSaW5m
+b0BjeWJlcmdob3N0LnJvMB4XDTIwMDcwNDE1MjkzNloXDTMwMDcwMjE1MjkzNlow
+fTELMAkGA1UEBhMCUk8xEjAQBgNVBAcMCUJ1Y2hhcmVzdDEYMBYGA1UECgwPQ3li
+ZXJHaG9zdCBTLkEuMR0wGwYDVQQDDBRjLmoua2xhdmVyQGdtYWlsLmNvbTEhMB8G
+CSqGSIb3DQEJARYSaW5mb0BjeWJlcmdob3N0LnJvMIICIjANBgkqhkiG9w0BAQEF
+AAOCAg8AMIICCgKCAgEAobp2NlGUHMNBe08YEOnVG3QJjF3ZaXbRhE/II9rmtgJT
+NZtDohGChvFlNRsExKzVrKxHCeuJkVffwzQ6fYk4/M1RdYLJUh0UVw3e4WdApw8E
+7TJZxDYm4SHQNXUvt1Rt5TjslcXxIpDZgrMSc/kHROYEL9tdgdzPZErUJehXyJPh
+EzIrzmAJh501x7WwKPz9ctSVlItyavqEWFF2vyUa6X9DYmD9mQTz5c+VXNO5DkXm
+PFBIaEVDnvFtcjGJ56yEvFnWVukL+OUX7ezowrIOFOcp9udjgpeiHq+XvsQ6ER0D
+Jt25MiEId3NjkxtZ8BitDftTcLN/kt81hWKT7adMVc3kpIZ80cxrwRCttMd7sHAz
+KI9u7pMxv10eUOsIEY87ewBe3l6KvEnjA+9uIjim6gLLebDIaEH50Ee9PzNJ8fqQ
+2u54Ab4bt00/H1sUnJ6Ss/+WsQDOK1BsPRKKcnHZntOlHrs2Tu5+txKNU2cOapI8
+SjVULUNKrRXASbpfWnLUfri/HO742bJb/TjkOJcOxta3hTPFAhaRWBusVlB41XVH
+euH5DAhugYXeSNK6/6Ul8YvKUNH/7QbxuGIGXfth19Xl4QLI1umyEjZopSlt3tOi
+O2V1soVNSQCCfxXVoCTMESMLjhkjWdmBDhdy2GTW7S4YoJfqVKiS18rYkN7I4ZMC
+AwEAAaOCATQwggEwMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgWgMDQGCWCGSAGG+EIB
+DQQnFiVDeWJlckdob3N0IEdlbmVyYXRlZCBVc2VyIENlcnRpZmljYXRlMBEGCWCG
+SAGG+EIBAQQEAwIHgDAdBgNVHQ4EFgQULwUtU5s6pL2NN9gPeEnKX0dhwiswga0G
+A1UdIwSBpTCBooAU6tdK1g/He5qzjeAoM5eHt4in9iWhf6R9MHsxCzAJBgNVBAYT
+AlJPMRIwEAYDVQQHEwlCdWNoYXJlc3QxGDAWBgNVBAoTD0N5YmVyR2hvc3QgUy5B
+LjEbMBkGA1UEAxMSQ3liZXJHaG9zdCBSb290IENBMSEwHwYJKoZIhvcNAQkBFhJp
+bmZvQGN5YmVyZ2hvc3Qucm+CCQCcVButZsQ0uzANBgkqhkiG9w0BAQsFAAOCAgEA
+ystGIMYhQWaEdTqlnLCytrr8657t+PuidZMNNIaPB3wN2Fi2xKf14DTg03mqxjmP
+Pb+f+PVNIOV5PdWD4jcQwOP1GEboGV0DFzlRGeAtDcvKwdee4oASJbZq1CETqDao
+hQTxKEWC+UBk2F36nOaEI6Sab+Mb4cR9//PAwvzOqrXuGF5NuIOX7eFtCMQSgQq6
+lRRqTQjekm0Dxigx4JA92Jo2qZRwCJ0T3IXBJGL831HCFJbDWv8PV3lsfFb/i2+v
+r54uywFQVWWp18dYi97gipfuQ4zRg2Ldx5aXSmnhhKpg5ioZvtk043QofF12YORh
+obElqavRbvvhZvlCouvcuoq9QKi7IPe5SJZkZ1X7ezMesCwBzwFpt6vRUAcslsNF
+bcYS1iSENlY/PTcDqBhbKuc9yAhq+/aUgaY/8VF5RWVzSRZufbf3BPwOkE4K0Uyb
+aobO/YX0JOkCacAD+4tdR6YSXNIMMRAOCBQvxbxFXaHzhwhzBAjdsC56FrJKwXvQ
+rRLU3tF4P0zFMeNTay8uTtUXugDK7EnklLESuYdpUJ8bUMlAUhJBi6UFI9/icMud
+xXvLRvhnBW9EtKib5JnVFUovcEUt+3EJbyst05nkL4YPjQS4TC9DHdo5SyRAy1Tp
+iOCYTbretAFZRhh6ycUN5hBeN8GMQxiMreMtDV4PEIQ=
+-----END CERTIFICATE-----
+`
+	const validCertificateString = "MIIGrDCCBJSgAwIBAgIEAdTnfTANBgkqhkiG9w0BAQsFADB7MQswCQYDVQQGEwJSTzESMBAGA1UEBxMJQnVjaGFyZXN0MRgwFgYDVQQKEw9DeWJlckdob3N0IFMuQS4xGzAZBgNVBAMTEkN5YmVyR2hvc3QgUm9vdCBDQTEhMB8GCSqGSIb3DQEJARYSaW5mb0BjeWJlcmdob3N0LnJvMB4XDTIwMDcwNDE1MjkzNloXDTMwMDcwMjE1MjkzNlowfTELMAkGA1UEBhMCUk8xEjAQBgNVBAcMCUJ1Y2hhcmVzdDEYMBYGA1UECgwPQ3liZXJHaG9zdCBTLkEuMR0wGwYDVQQDDBRjLmoua2xhdmVyQGdtYWlsLmNvbTEhMB8GCSqGSIb3DQEJARYSaW5mb0BjeWJlcmdob3N0LnJvMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAobp2NlGUHMNBe08YEOnVG3QJjF3ZaXbRhE/II9rmtgJTNZtDohGChvFlNRsExKzVrKxHCeuJkVffwzQ6fYk4/M1RdYLJUh0UVw3e4WdApw8E7TJZxDYm4SHQNXUvt1Rt5TjslcXxIpDZgrMSc/kHROYEL9tdgdzPZErUJehXyJPhEzIrzmAJh501x7WwKPz9ctSVlItyavqEWFF2vyUa6X9DYmD9mQTz5c+VXNO5DkXmPFBIaEVDnvFtcjGJ56yEvFnWVukL+OUX7ezowrIOFOcp9udjgpeiHq+XvsQ6ER0DJt25MiEId3NjkxtZ8BitDftTcLN/kt81hWKT7adMVc3kpIZ80cxrwRCttMd7sHAzKI9u7pMxv10eUOsIEY87ewBe3l6KvEnjA+9uIjim6gLLebDIaEH50Ee9PzNJ8fqQ2u54Ab4bt00/H1sUnJ6Ss/+WsQDOK1BsPRKKcnHZntOlHrs2Tu5+txKNU2cOapI8SjVULUNKrRXASbpfWnLUfri/HO742bJb/TjkOJcOxta3hTPFAhaRWBusVlB41XVHeuH5DAhugYXeSNK6/6Ul8YvKUNH/7QbxuGIGXfth19Xl4QLI1umyEjZopSlt3tOiO2V1soVNSQCCfxXVoCTMESMLjhkjWdmBDhdy2GTW7S4YoJfqVKiS18rYkN7I4ZMCAwEAAaOCATQwggEwMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgWgMDQGCWCGSAGG+EIBDQQnFiVDeWJlckdob3N0IEdlbmVyYXRlZCBVc2VyIENlcnRpZmljYXRlMBEGCWCGSAGG+EIBAQQEAwIHgDAdBgNVHQ4EFgQULwUtU5s6pL2NN9gPeEnKX0dhwiswga0GA1UdIwSBpTCBooAU6tdK1g/He5qzjeAoM5eHt4in9iWhf6R9MHsxCzAJBgNVBAYTAlJPMRIwEAYDVQQHEwlCdWNoYXJlc3QxGDAWBgNVBAoTD0N5YmVyR2hvc3QgUy5BLjEbMBkGA1UEAxMSQ3liZXJHaG9zdCBSb290IENBMSEwHwYJKoZIhvcNAQkBFhJpbmZvQGN5YmVyZ2hvc3Qucm+CCQCcVButZsQ0uzANBgkqhkiG9w0BAQsFAAOCAgEAystGIMYhQWaEdTqlnLCytrr8657t+PuidZMNNIaPB3wN2Fi2xKf14DTg03mqxjmPPb+f+PVNIOV5PdWD4jcQwOP1GEboGV0DFzlRGeAtDcvKwdee4oASJbZq1CETqDaohQTxKEWC+UBk2F36nOaEI6Sab+Mb4cR9//PAwvzOqrXuGF5NuIOX7eFtCMQSgQq6lRRqTQjekm0Dxigx4JA92Jo2qZRwCJ0T3IXBJGL831HCFJbDWv8PV3lsfFb/i2+vr54uywFQVWWp18dYi97gipfuQ4zRg2Ldx5aXSmnhhKpg5ioZvtk043QofF12YORhobElqavRbvvhZvlCouvcuoq9QKi7IPe5SJZkZ1X7ezMesCwBzwFpt6vRUAcslsNFbcYS1iSENlY/PTcDqBhbKuc9yAhq+/aUgaY/8VF5RWVzSRZufbf3BPwOkE4K0UybaobO/YX0JOkCacAD+4tdR6YSXNIMMRAOCBQvxbxFXaHzhwhzBAjdsC56FrJKwXvQrRLU3tF4P0zFMeNTay8uTtUXugDK7EnklLESuYdpUJ8bUMlAUhJBi6UFI9/icMudxXvLRvhnBW9EtKib5JnVFUovcEUt+3EJbyst05nkL4YPjQS4TC9DHdo5SyRAy1TpiOCYTbretAFZRhh6ycUN5hBeN8GMQxiMreMtDV4PEIQ=" //nolint:lll
+	testCases := map[string]struct {
+		b           []byte
+		certificate string
+		err         error
+	}{
+		"no input": {
+			err: errDecodePEMBlockClientCert,
+		},
+		"bad input": {
+			b:   []byte{1, 2, 3},
+			err: errDecodePEMBlockClientCert,
+		},
+		"valid key": {
+			b:           []byte(validPEM),
+			certificate: validCertificateString,
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			certificate, err := extractClientCertificate(testCase.b)
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+			assert.Equal(t, testCase.certificate, certificate)
+		})
+	}
+}

internal/configuration/lines.go

@@ -0,0 +1,22 @@
+package configuration
+
+import (
+	"net"
+	"strconv"
+)
+
+func uint16sToStrings(uint16s []uint16) (strings []string) {
+	strings = make([]string, len(uint16s))
+	for i := range uint16s {
+		strings[i] = strconv.Itoa(int(uint16s[i]))
+	}
+	return strings
+}
+
+func ipNetsToStrings(ipNets []net.IPNet) (strings []string) {
+	strings = make([]string, len(ipNets))
+	for i := range ipNets {
+		strings[i] = ipNets[i].String()
+	}
+	return strings
+}

internal/configuration/mullvad.go

@@ -0,0 +1,89 @@
+package configuration
+
+import (
+	"fmt"
+	"strconv"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) mullvadLines() (lines []string) {
+	if len(settings.ServerSelection.Countries) > 0 {
+		lines = append(lines, lastIndent+"Countries: "+commaJoin(settings.ServerSelection.Countries))
+	}
+
+	if len(settings.ServerSelection.Cities) > 0 {
+		lines = append(lines, lastIndent+"Cities: "+commaJoin(settings.ServerSelection.Cities))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	if len(settings.ServerSelection.ISPs) > 0 {
+		lines = append(lines, lastIndent+"ISPs: "+commaJoin(settings.ServerSelection.ISPs))
+	}
+
+	if settings.ServerSelection.CustomPort > 0 {
+		lines = append(lines, lastIndent+"Custom port: "+strconv.Itoa(int(settings.ServerSelection.CustomPort)))
+	}
+
+	if settings.ExtraConfigOptions.OpenVPNIPv6 {
+		lines = append(lines, lastIndent+"IPv6: enabled")
+	}
+
+	return lines
+}
+
+func (settings *Provider) readMullvad(r reader) (err error) {
+	settings.Name = constants.Mullvad
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.MullvadCountryChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.MullvadCityChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.MullvadHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.ISPs, err = r.env.CSVInside("ISP", constants.MullvadISPChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable ISP: %w", err)
+	}
+
+	settings.ServerSelection.CustomPort, err = readCustomPort(r.env, settings.ServerSelection.TCP,
+		[]uint16{80, 443, 1401}, []uint16{53, 1194, 1195, 1196, 1197, 1300, 1301, 1302, 1303, 1400})
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Owned, err = r.env.YesNo("OWNED", params.Default("no"))
+	if err != nil {
+		return fmt.Errorf("environment variable OWNED: %w", err)
+	}
+
+	settings.ExtraConfigOptions.OpenVPNIPv6, err = r.env.OnOff("OPENVPN_IPV6", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_IPV6: %w", err)
+	}
+
+	return nil
+}

internal/configuration/nordvpn.go

@@ -0,0 +1,91 @@
+package configuration
+
+import (
+	"fmt"
+	"strconv"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) nordvpnLines() (lines []string) {
+	if len(settings.ServerSelection.Regions) > 0 {
+		lines = append(lines, lastIndent+"Regions: "+commaJoin(settings.ServerSelection.Regions))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	if len(settings.ServerSelection.Names) > 0 {
+		lines = append(lines, lastIndent+"Names: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	if numbersUint16 := settings.ServerSelection.Numbers; len(numbersUint16) > 0 {
+		numbersString := make([]string, len(numbersUint16))
+		for i, numberUint16 := range numbersUint16 {
+			numbersString[i] = strconv.Itoa(int(numberUint16))
+		}
+		lines = append(lines, lastIndent+"Numbers: "+commaJoin(numbersString))
+	}
+
+	return lines
+}
+
+func (settings *Provider) readNordvpn(r reader) (err error) {
+	settings.Name = constants.Nordvpn
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.NordvpnRegionChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.NordvpnHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.Names, err = r.env.CSVInside("SERVER_NAME", constants.NordvpnHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_NAME: %w", err)
+	}
+
+	settings.ServerSelection.Numbers, err = readNordVPNServerNumbers(r.env)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func readNordVPNServerNumbers(env params.Env) (numbers []uint16, err error) {
+	const possiblePortsCount = 65537
+	possibilities := make([]string, possiblePortsCount)
+	for i := range possibilities {
+		possibilities[i] = fmt.Sprintf("%d", i)
+	}
+	possibilities[65536] = ""
+	values, err := env.CSVInside("SERVER_NUMBER", possibilities)
+	if err != nil {
+		return nil, err
+	}
+	numbers = make([]uint16, len(values))
+	for i := range values {
+		n, err := strconv.Atoi(values[i])
+		if err != nil {
+			return nil, err
+		}
+		numbers[i] = uint16(n)
+	}
+	return numbers, nil
+}

internal/configuration/openvpn.go

@@ -0,0 +1,204 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+// OpenVPN contains settings to configure the OpenVPN client.
+type OpenVPN struct {
+	User      string   `json:"user"`
+	Password  string   `json:"password"`
+	Verbosity int      `json:"verbosity"`
+	Flags     []string `json:"flags"`
+	MSSFix    uint16   `json:"mssfix"`
+	Root      bool     `json:"run_as_root"`
+	Cipher    string   `json:"cipher"`
+	Auth      string   `json:"auth"`
+	Provider  Provider `json:"provider"`
+	Config    string   `json:"custom_config"`
+	Version   string   `json:"version"`
+}
+
+func (settings *OpenVPN) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *OpenVPN) lines() (lines []string) {
+	lines = append(lines, lastIndent+"OpenVPN:")
+
+	lines = append(lines, indent+lastIndent+"Version: "+settings.Version)
+
+	lines = append(lines, indent+lastIndent+"Verbosity level: "+strconv.Itoa(settings.Verbosity))
+
+	if len(settings.Flags) > 0 {
+		lines = append(lines, indent+lastIndent+"Flags: "+strings.Join(settings.Flags, " "))
+	}
+
+	if settings.Root {
+		lines = append(lines, indent+lastIndent+"Run as root: enabled")
+	}
+
+	if len(settings.Cipher) > 0 {
+		lines = append(lines, indent+lastIndent+"Custom cipher: "+settings.Cipher)
+	}
+	if len(settings.Auth) > 0 {
+		lines = append(lines, indent+lastIndent+"Custom auth algorithm: "+settings.Auth)
+	}
+
+	if len(settings.Config) > 0 {
+		lines = append(lines, indent+lastIndent+"Custom configuration: "+settings.Config)
+	}
+
+	if settings.Provider.Name == "" {
+		lines = append(lines, indent+lastIndent+"Provider: custom configuration")
+	} else {
+		lines = append(lines, indent+lastIndent+"Provider:")
+		for _, line := range settings.Provider.lines() {
+			lines = append(lines, indent+indent+line)
+		}
+	}
+
+	return lines
+}
+
+var (
+	ErrInvalidVPNProvider = errors.New("invalid VPN provider")
+)
+
+func (settings *OpenVPN) read(r reader) (err error) {
+	vpnsp, err := r.env.Inside("VPNSP", []string{
+		"cyberghost", "fastestvpn", "hidemyass", "ipvanish", "ivpn", "mullvad", "nordvpn",
+		"privado", "pia", "private internet access", "privatevpn", "protonvpn",
+		"purevpn", "surfshark", "torguard", constants.VPNUnlimited, "vyprvpn", "windscribe"},
+		params.Default("private internet access"))
+	if err != nil {
+		return fmt.Errorf("environment variable VPNSP: %w", err)
+	}
+	if vpnsp == "pia" { // retro compatibility
+		vpnsp = "private internet access"
+	}
+
+	settings.Provider.Name = vpnsp
+
+	settings.Config, err = r.env.Get("OPENVPN_CUSTOM_CONFIG", params.CaseSensitiveValue())
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_CUSTOM_CONFIG: %w", err)
+	}
+	customConfig := settings.Config != ""
+
+	if customConfig {
+		settings.Provider.Name = ""
+	}
+
+	credentialsRequired := !customConfig && settings.Provider.Name != constants.VPNUnlimited
+
+	settings.User, err = r.getFromEnvOrSecretFile("OPENVPN_USER", credentialsRequired, []string{"USER"})
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_USER: %w", err)
+	}
+	// Remove spaces in user ID to simplify user's life, thanks @JeordyR
+	settings.User = strings.ReplaceAll(settings.User, " ", "")
+
+	if settings.Provider.Name == constants.Mullvad {
+		settings.Password = "m"
+	} else {
+		settings.Password, err = r.getFromEnvOrSecretFile("OPENVPN_PASSWORD", credentialsRequired, []string{"PASSWORD"})
+		if err != nil {
+			return err
+		}
+	}
+
+	settings.Version, err = r.env.Inside("OPENVPN_VERSION",
+		[]string{constants.Openvpn24, constants.Openvpn25}, params.Default(constants.Openvpn25))
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_VERSION: %w", err)
+	}
+
+	settings.Verbosity, err = r.env.IntRange("OPENVPN_VERBOSITY", 0, 6, params.Default("1")) //nolint:gomnd
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_VERBOSITY: %w", err)
+	}
+
+	settings.Flags = []string{}
+	flagsStr, err := r.env.Get("OPENVPN_FLAGS")
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_FLAGS: %w", err)
+	}
+	if flagsStr != "" {
+		settings.Flags = strings.Fields(flagsStr)
+	}
+
+	settings.Root, err = r.env.YesNo("OPENVPN_ROOT", params.Default("yes"))
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_ROOT: %w", err)
+	}
+
+	settings.Cipher, err = r.env.Get("OPENVPN_CIPHER")
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_CIPHER: %w", err)
+	}
+
+	settings.Auth, err = r.env.Get("OPENVPN_AUTH")
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_AUTH: %w", err)
+	}
+
+	const maxMSSFix = 10000
+	mssFix, err := r.env.IntRange("OPENVPN_MSSFIX", 0, maxMSSFix, params.Default("0"))
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_MSSFIX: %w", err)
+	}
+	settings.MSSFix = uint16(mssFix)
+	return settings.readProvider(r)
+}
+
+func (settings *OpenVPN) readProvider(r reader) error {
+	var readProvider func(r reader) error
+	switch settings.Provider.Name {
+	case "": // custom config
+		readProvider = func(r reader) error { return nil }
+	case constants.Cyberghost:
+		readProvider = settings.Provider.readCyberghost
+	case constants.Fastestvpn:
+		readProvider = settings.Provider.readFastestvpn
+	case constants.HideMyAss:
+		readProvider = settings.Provider.readHideMyAss
+	case constants.Ipvanish:
+		readProvider = settings.Provider.readIpvanish
+	case constants.Ivpn:
+		readProvider = settings.Provider.readIvpn
+	case constants.Mullvad:
+		readProvider = settings.Provider.readMullvad
+	case constants.Nordvpn:
+		readProvider = settings.Provider.readNordvpn
+	case constants.Privado:
+		readProvider = settings.Provider.readPrivado
+	case constants.PrivateInternetAccess:
+		readProvider = settings.Provider.readPrivateInternetAccess
+	case constants.Privatevpn:
+		readProvider = settings.Provider.readPrivatevpn
+	case constants.Protonvpn:
+		readProvider = settings.Provider.readProtonvpn
+	case constants.Purevpn:
+		readProvider = settings.Provider.readPurevpn
+	case constants.Surfshark:
+		readProvider = settings.Provider.readSurfshark
+	case constants.Torguard:
+		readProvider = settings.Provider.readTorguard
+	case constants.VPNUnlimited:
+		readProvider = settings.Provider.readVPNUnlimited
+	case constants.Vyprvpn:
+		readProvider = settings.Provider.readVyprvpn
+	case constants.Windscribe:
+		readProvider = settings.Provider.readWindscribe
+	default:
+		return fmt.Errorf("%w: %s", ErrInvalidVPNProvider, settings.Provider.Name)
+	}
+	return readProvider(r)
+}

internal/configuration/openvpn_test.go

@@ -0,0 +1,65 @@
+package configuration
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_OpenVPN_JSON(t *testing.T) {
+	t.Parallel()
+	in := OpenVPN{
+		Root:  true,
+		Flags: []string{},
+		Provider: Provider{
+			Name: "name",
+		},
+	}
+	data, err := json.MarshalIndent(in, "", "  ")
+	require.NoError(t, err)
+	assert.Equal(t, `{
+  "user": "",
+  "password": "",
+  "verbosity": 0,
+  "flags": [],
+  "mssfix": 0,
+  "run_as_root": true,
+  "cipher": "",
+  "auth": "",
+  "provider": {
+    "name": "name",
+    "server_selection": {
+      "tcp": false,
+      "regions": null,
+      "group": "",
+      "countries": null,
+      "cities": null,
+      "hostnames": null,
+      "names": null,
+      "isps": null,
+      "owned": false,
+      "custom_port": 0,
+      "numbers": null,
+      "encryption_preset": "",
+      "free_only": false,
+      "stream_only": false
+    },
+    "extra_config": {
+      "encryption_preset": "",
+      "openvpn_ipv6": false
+    },
+    "port_forwarding": {
+      "enabled": false,
+      "filepath": ""
+    }
+  },
+  "custom_config": "",
+  "version": ""
+}`, string(data))
+	var out OpenVPN
+	err = json.Unmarshal(data, &out)
+	require.NoError(t, err)
+	assert.Equal(t, in, out)
+}

internal/configuration/privado.go

@@ -0,0 +1,63 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) privadoLines() (lines []string) {
+	if len(settings.ServerSelection.Countries) > 0 {
+		lines = append(lines, lastIndent+"Countries: "+commaJoin(settings.ServerSelection.Countries))
+	}
+
+	if len(settings.ServerSelection.Regions) > 0 {
+		lines = append(lines, lastIndent+"Regions: "+commaJoin(settings.ServerSelection.Regions))
+	}
+
+	if len(settings.ServerSelection.Cities) > 0 {
+		lines = append(lines, lastIndent+"Cities: "+commaJoin(settings.ServerSelection.Cities))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	return lines
+}
+
+func (settings *Provider) readPrivado(r reader) (err error) {
+	settings.Name = constants.Privado
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.PrivadoCountryChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.PrivadoRegionChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.PrivadoCityChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.PrivadoHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return nil
+}

internal/configuration/privateinternetaccess.go

@@ -0,0 +1,98 @@
+package configuration
+
+import (
+	"fmt"
+	"strconv"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) privateinternetaccessLines() (lines []string) {
+	if len(settings.ServerSelection.Regions) > 0 {
+		lines = append(lines, lastIndent+"Regions: "+commaJoin(settings.ServerSelection.Regions))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	if len(settings.ServerSelection.Names) > 0 {
+		lines = append(lines, lastIndent+"Names: "+commaJoin(settings.ServerSelection.Names))
+	}
+
+	lines = append(lines, lastIndent+"Encryption preset: "+settings.ServerSelection.EncryptionPreset)
+
+	if settings.ServerSelection.CustomPort > 0 {
+		lines = append(lines, lastIndent+"Custom port: "+strconv.Itoa(int(settings.ServerSelection.CustomPort)))
+	}
+
+	if settings.PortForwarding.Enabled {
+		lines = append(lines, lastIndent+"Port forwarding:")
+		for _, line := range settings.PortForwarding.lines() {
+			lines = append(lines, indent+line)
+		}
+	}
+
+	return lines
+}
+
+func (settings *Provider) readPrivateInternetAccess(r reader) (err error) {
+	settings.Name = constants.PrivateInternetAccess
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	encryptionPreset, err := r.env.Inside("PIA_ENCRYPTION",
+		[]string{constants.PIAEncryptionPresetNone, constants.PIAEncryptionPresetNormal, constants.PIAEncryptionPresetStrong},
+		params.RetroKeys([]string{"ENCRYPTION"}, r.onRetroActive),
+		params.Default(constants.PIACertificateStrong),
+	)
+	if err != nil {
+		return fmt.Errorf("environment variable PIA_ENCRYPTION: %w", err)
+	}
+	settings.ServerSelection.EncryptionPreset = encryptionPreset
+	settings.ExtraConfigOptions.EncryptionPreset = encryptionPreset
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.PIAGeoChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.PIAHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_NAME", constants.PIANameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_NAME: %w", err)
+	}
+
+	settings.ServerSelection.CustomPort, err = readPortOrZero(r.env, "PORT")
+	if err != nil {
+		return fmt.Errorf("environment variable PORT: %w", err)
+	}
+
+	settings.PortForwarding.Enabled, err = r.env.OnOff("PORT_FORWARDING", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable PORT_FORWARDING: %w", err)
+	}
+
+	if settings.PortForwarding.Enabled {
+		settings.PortForwarding.Filepath, err = r.env.Path("PORT_FORWARDING_STATUS_FILE",
+			params.Default("/tmp/gluetun/forwarded_port"), params.CaseSensitiveValue())
+		if err != nil {
+			return fmt.Errorf("environment variable PORT_FORWARDING_STATUS_FILE: %w", err)
+		}
+	}
+
+	return nil
+}

internal/configuration/privatevpn.go

@@ -0,0 +1,54 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) privatevpnLines() (lines []string) {
+	if len(settings.ServerSelection.Countries) > 0 {
+		lines = append(lines, lastIndent+"Countries: "+commaJoin(settings.ServerSelection.Countries))
+	}
+
+	if len(settings.ServerSelection.Cities) > 0 {
+		lines = append(lines, lastIndent+"Cities: "+commaJoin(settings.ServerSelection.Cities))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	return lines
+}
+
+func (settings *Provider) readPrivatevpn(r reader) (err error) {
+	settings.Name = constants.Privatevpn
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.PrivatevpnCountryChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.PrivatevpnCityChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.PrivatevpnHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return nil
+}

internal/configuration/protonvpn.go

@@ -0,0 +1,87 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) protonvpnLines() (lines []string) {
+	if len(settings.ServerSelection.Countries) > 0 {
+		lines = append(lines, lastIndent+"Countries: "+commaJoin(settings.ServerSelection.Countries))
+	}
+
+	if len(settings.ServerSelection.Regions) > 0 {
+		lines = append(lines, lastIndent+"Regions: "+commaJoin(settings.ServerSelection.Regions))
+	}
+
+	if len(settings.ServerSelection.Cities) > 0 {
+		lines = append(lines, lastIndent+"Cities: "+commaJoin(settings.ServerSelection.Cities))
+	}
+
+	if len(settings.ServerSelection.Names) > 0 {
+		lines = append(lines, lastIndent+"Names: "+commaJoin(settings.ServerSelection.Names))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	if settings.ServerSelection.FreeOnly {
+		lines = append(lines, lastIndent+"Free only: yes")
+	}
+
+	return lines
+}
+
+func (settings *Provider) readProtonvpn(r reader) (err error) {
+	settings.Name = constants.Protonvpn
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.CustomPort, err = readPortOrZero(r.env, "PORT")
+	if err != nil {
+		return fmt.Errorf("environment variable PORT: %w", err)
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.ProtonvpnCountryChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.ProtonvpnRegionChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.ProtonvpnCityChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Names, err = r.env.CSVInside("SERVER_NAME", constants.ProtonvpnNameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_NAME: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.ProtonvpnHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.FreeOnly, err = r.env.YesNo("FREE_ONLY", params.Default("no"))
+	if err != nil {
+		return fmt.Errorf("environment variable FREE_ONLY: %w", err)
+	}
+
+	return nil
+}

internal/configuration/provider.go

@@ -0,0 +1,129 @@
+package configuration
+
+import (
+	"fmt"
+	"net"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+// Provider contains settings specific to a VPN provider.
+type Provider struct {
+	Name               string             `json:"name"`
+	ServerSelection    ServerSelection    `json:"server_selection"`
+	ExtraConfigOptions ExtraConfigOptions `json:"extra_config"`
+	PortForwarding     PortForwarding     `json:"port_forwarding"`
+}
+
+func (settings *Provider) lines() (lines []string) {
+	lines = append(lines, lastIndent+strings.Title(settings.Name)+" settings:")
+
+	selection := settings.ServerSelection
+
+	lines = append(lines, indent+lastIndent+"Network protocol: "+protoToString(selection.TCP))
+
+	if selection.TargetIP != nil {
+		lines = append(lines, indent+lastIndent+"Target IP address: "+selection.TargetIP.String())
+	}
+
+	var providerLines []string
+	switch strings.ToLower(settings.Name) {
+	case "cyberghost":
+		providerLines = settings.cyberghostLines()
+	case "fastestvpn":
+		providerLines = settings.fastestvpnLines()
+	case "hidemyass":
+		providerLines = settings.hideMyAssLines()
+	case "ipvanish":
+		providerLines = settings.ipvanishLines()
+	case "ivpn":
+		providerLines = settings.ivpnLines()
+	case "mullvad":
+		providerLines = settings.mullvadLines()
+	case "nordvpn":
+		providerLines = settings.nordvpnLines()
+	case "privado":
+		providerLines = settings.privadoLines()
+	case "privatevpn":
+		providerLines = settings.privatevpnLines()
+	case "private internet access":
+		providerLines = settings.privateinternetaccessLines()
+	case "protonvpn":
+		providerLines = settings.protonvpnLines()
+	case "purevpn":
+		providerLines = settings.purevpnLines()
+	case "surfshark":
+		providerLines = settings.surfsharkLines()
+	case "torguard":
+		providerLines = settings.torguardLines()
+	case strings.ToLower(constants.VPNUnlimited):
+		providerLines = settings.vpnUnlimitedLines()
+	case "vyprvpn":
+		providerLines = settings.vyprvpnLines()
+	case "windscribe":
+		providerLines = settings.windscribeLines()
+	default:
+		panic(`Missing lines method for provider "` +
+			settings.Name + `"! Please create a Github issue.`)
+	}
+
+	for _, line := range providerLines {
+		lines = append(lines, indent+line)
+	}
+
+	return lines
+}
+
+func commaJoin(slice []string) string {
+	return strings.Join(slice, ", ")
+}
+
+func readProtocol(env params.Env) (tcp bool, err error) {
+	protocol, err := env.Inside("PROTOCOL", []string{constants.TCP, constants.UDP}, params.Default(constants.UDP))
+	if err != nil {
+		return false, fmt.Errorf("environment variable PROTOCOL: %w", err)
+	}
+	return protocol == constants.TCP, nil
+}
+
+func protoToString(tcp bool) string {
+	if tcp {
+		return constants.TCP
+	}
+	return constants.UDP
+}
+
+func readTargetIP(env params.Env) (targetIP net.IP, err error) {
+	targetIP, err = readIP(env, "OPENVPN_TARGET_IP")
+	if err != nil {
+		return nil, fmt.Errorf("environment variable OPENVPN_TARGET_IP: %w", err)
+	}
+	return targetIP, nil
+}
+
+func readCustomPort(env params.Env, tcp bool,
+	allowedTCP, allowedUDP []uint16) (port uint16, err error) {
+	port, err = readPortOrZero(env, "PORT")
+	if err != nil {
+		return 0, fmt.Errorf("environment variable PORT: %w", err)
+	} else if port == 0 {
+		return 0, nil
+	}
+
+	if tcp {
+		for i := range allowedTCP {
+			if allowedTCP[i] == port {
+				return port, nil
+			}
+		}
+		return 0, fmt.Errorf("environment variable PORT: %w: port %d for TCP protocol", ErrInvalidPort, port)
+	}
+	for i := range allowedUDP {
+		if allowedUDP[i] == port {
+			return port, nil
+		}
+	}
+	return 0, fmt.Errorf("environment variable PORT: %w: port %d for UDP protocol", ErrInvalidPort, port)
+}

internal/configuration/provider_test.go

@@ -0,0 +1,382 @@
+package configuration
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params/mock_params"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+var errDummy = errors.New("dummy")
+
+func Test_Provider_lines(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		settings Provider
+		lines    []string
+	}{
+		"cyberghost": {
+			settings: Provider{
+				Name: constants.Cyberghost,
+				ServerSelection: ServerSelection{
+					Group:   "group",
+					Regions: []string{"a", "El country"},
+				},
+				ExtraConfigOptions: ExtraConfigOptions{
+					ClientKey:         "a",
+					ClientCertificate: "a",
+				},
+			},
+			lines: []string{
+				"|--Cyberghost settings:",
+				"   |--Network protocol: udp",
+				"   |--Server group: group",
+				"   |--Regions: a, El country",
+				"   |--Client key is set",
+				"   |--Client certificate is set",
+			},
+		},
+		"fastestvpn": {
+			settings: Provider{
+				Name: constants.Fastestvpn,
+				ServerSelection: ServerSelection{
+					Hostnames: []string{"a", "b"},
+					Countries: []string{"c", "d"},
+				},
+			},
+			lines: []string{
+				"|--Fastestvpn settings:",
+				"   |--Network protocol: udp",
+				"   |--Hostnames: a, b",
+				"   |--Countries: c, d",
+			},
+		},
+		"hidemyass": {
+			settings: Provider{
+				Name: constants.HideMyAss,
+				ServerSelection: ServerSelection{
+					Countries: []string{"a", "b"},
+					Cities:    []string{"c", "d"},
+					Hostnames: []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Hidemyass settings:",
+				"   |--Network protocol: udp",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e, f",
+			},
+		},
+		"ipvanish": {
+			settings: Provider{
+				Name: constants.Ipvanish,
+				ServerSelection: ServerSelection{
+					Countries: []string{"a", "b"},
+					Cities:    []string{"c", "d"},
+					Hostnames: []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Ipvanish settings:",
+				"   |--Network protocol: udp",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e, f",
+			},
+		},
+		"ivpn": {
+			settings: Provider{
+				Name: constants.Ivpn,
+				ServerSelection: ServerSelection{
+					Countries: []string{"a", "b"},
+					Cities:    []string{"c", "d"},
+					Hostnames: []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Ivpn settings:",
+				"   |--Network protocol: udp",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e, f",
+			},
+		},
+		"mullvad": {
+			settings: Provider{
+				Name: constants.Mullvad,
+				ServerSelection: ServerSelection{
+					Countries:  []string{"a", "b"},
+					Cities:     []string{"c", "d"},
+					ISPs:       []string{"e", "f"},
+					CustomPort: 1,
+				},
+				ExtraConfigOptions: ExtraConfigOptions{
+					OpenVPNIPv6: true,
+				},
+			},
+			lines: []string{
+				"|--Mullvad settings:",
+				"   |--Network protocol: udp",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--ISPs: e, f",
+				"   |--Custom port: 1",
+				"   |--IPv6: enabled",
+			},
+		},
+		"nordvpn": {
+			settings: Provider{
+				Name: constants.Nordvpn,
+				ServerSelection: ServerSelection{
+					Regions: []string{"a", "b"},
+					Numbers: []uint16{1, 2},
+				},
+			},
+			lines: []string{
+				"|--Nordvpn settings:",
+				"   |--Network protocol: udp",
+				"   |--Regions: a, b",
+				"   |--Numbers: 1, 2",
+			},
+		},
+		"privado": {
+			settings: Provider{
+				Name: constants.Privado,
+				ServerSelection: ServerSelection{
+					Hostnames: []string{"a", "b"},
+				},
+			},
+			lines: []string{
+				"|--Privado settings:",
+				"   |--Network protocol: udp",
+				"   |--Hostnames: a, b",
+			},
+		},
+		"privatevpn": {
+			settings: Provider{
+				Name: constants.Privatevpn,
+				ServerSelection: ServerSelection{
+					Hostnames: []string{"a", "b"},
+					Countries: []string{"c", "d"},
+					Cities:    []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Privatevpn settings:",
+				"   |--Network protocol: udp",
+				"   |--Countries: c, d",
+				"   |--Cities: e, f",
+				"   |--Hostnames: a, b",
+			},
+		},
+		"protonvpn": {
+			settings: Provider{
+				Name: constants.Protonvpn,
+				ServerSelection: ServerSelection{
+					Countries: []string{"a", "b"},
+					Regions:   []string{"c", "d"},
+					Cities:    []string{"e", "f"},
+					Names:     []string{"g", "h"},
+					Hostnames: []string{"i", "j"},
+				},
+			},
+			lines: []string{
+				"|--Protonvpn settings:",
+				"   |--Network protocol: udp",
+				"   |--Countries: a, b",
+				"   |--Regions: c, d",
+				"   |--Cities: e, f",
+				"   |--Names: g, h",
+				"   |--Hostnames: i, j",
+			},
+		},
+		"private internet access": {
+			settings: Provider{
+				Name: constants.PrivateInternetAccess,
+				ServerSelection: ServerSelection{
+					Regions:          []string{"a", "b"},
+					EncryptionPreset: constants.PIAEncryptionPresetStrong,
+					CustomPort:       1,
+				},
+				PortForwarding: PortForwarding{
+					Enabled:  true,
+					Filepath: string("/here"),
+				},
+			},
+			lines: []string{
+				"|--Private Internet Access settings:",
+				"   |--Network protocol: udp",
+				"   |--Regions: a, b",
+				"   |--Encryption preset: strong",
+				"   |--Custom port: 1",
+				"   |--Port forwarding:",
+				"      |--File path: /here",
+			},
+		},
+		"purevpn": {
+			settings: Provider{
+				Name: constants.Purevpn,
+				ServerSelection: ServerSelection{
+					Regions:   []string{"a", "b"},
+					Countries: []string{"c", "d"},
+					Cities:    []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Purevpn settings:",
+				"   |--Network protocol: udp",
+				"   |--Regions: a, b",
+				"   |--Countries: c, d",
+				"   |--Cities: e, f",
+			},
+		},
+		"surfshark": {
+			settings: Provider{
+				Name: constants.Surfshark,
+				ServerSelection: ServerSelection{
+					Regions: []string{"a", "b"},
+				},
+			},
+			lines: []string{
+				"|--Surfshark settings:",
+				"   |--Network protocol: udp",
+				"   |--Regions: a, b",
+			},
+		},
+		"torguard": {
+			settings: Provider{
+				Name: constants.Torguard,
+				ServerSelection: ServerSelection{
+					Countries: []string{"a", "b"},
+					Cities:    []string{"c", "d"},
+					Hostnames: []string{"e"},
+				},
+			},
+			lines: []string{
+				"|--Torguard settings:",
+				"   |--Network protocol: udp",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e",
+			},
+		},
+		constants.VPNUnlimited: {
+			settings: Provider{
+				Name: constants.VPNUnlimited,
+				ServerSelection: ServerSelection{
+					Countries:  []string{"a", "b"},
+					Cities:     []string{"c", "d"},
+					Hostnames:  []string{"e", "f"},
+					FreeOnly:   true,
+					StreamOnly: true,
+				},
+				ExtraConfigOptions: ExtraConfigOptions{
+					ClientKey: "a",
+				},
+			},
+			lines: []string{
+				"|--Vpn Unlimited settings:",
+				"   |--Network protocol: udp",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e, f",
+				"   |--Free servers only",
+				"   |--Stream servers only",
+				"   |--Client key is set",
+			},
+		},
+		"vyprvpn": {
+			settings: Provider{
+				Name: constants.Vyprvpn,
+				ServerSelection: ServerSelection{
+					Regions: []string{"a", "b"},
+				},
+			},
+			lines: []string{
+				"|--Vyprvpn settings:",
+				"   |--Network protocol: udp",
+				"   |--Regions: a, b",
+			},
+		},
+		"windscribe": {
+			settings: Provider{
+				Name: constants.Windscribe,
+				ServerSelection: ServerSelection{
+					Regions:    []string{"a", "b"},
+					Cities:     []string{"c", "d"},
+					Hostnames:  []string{"e", "f"},
+					CustomPort: 1,
+				},
+			},
+			lines: []string{
+				"|--Windscribe settings:",
+				"   |--Network protocol: udp",
+				"   |--Regions: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e, f",
+				"   |--Custom port: 1",
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			lines := testCase.settings.lines()
+
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}
+
+func Test_readProtocol(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		mockStr string
+		mockErr error
+		tcp     bool
+		err     error
+	}{
+		"error": {
+			mockErr: errDummy,
+			err:     errors.New("environment variable PROTOCOL: dummy"),
+		},
+		"success": {
+			mockStr: "tcp",
+			tcp:     true,
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			ctrl := gomock.NewController(t)
+
+			env := mock_params.NewMockEnv(ctrl)
+			env.EXPECT().
+				Inside("PROTOCOL", []string{"tcp", "udp"}, gomock.Any()).
+				Return(testCase.mockStr, testCase.mockErr)
+
+			tcp, err := readProtocol(env)
+
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+
+			assert.Equal(t, testCase.tcp, tcp)
+		})
+	}
+}

internal/configuration/publicip.go

@@ -0,0 +1,47 @@
+package configuration
+
+import (
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/qdm12/golibs/params"
+)
+
+type PublicIP struct {
+	Period     time.Duration `json:"period"`
+	IPFilepath string        `json:"ip_filepath"`
+}
+
+func (settings *PublicIP) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *PublicIP) lines() (lines []string) {
+	if settings.Period == 0 {
+		lines = append(lines, lastIndent+"Public IP getter: disabled")
+		return lines
+	}
+
+	lines = append(lines, lastIndent+"Public IP getter:")
+	lines = append(lines, indent+lastIndent+"Fetch period: "+settings.Period.String())
+	lines = append(lines, indent+lastIndent+"IP file: "+settings.IPFilepath)
+
+	return lines
+}
+
+func (settings *PublicIP) read(r reader) (err error) {
+	settings.Period, err = r.env.Duration("PUBLICIP_PERIOD", params.Default("12h"))
+	if err != nil {
+		return fmt.Errorf("environment variable PUBLICIP_PERIOD: %w", err)
+	}
+
+	settings.IPFilepath, err = r.env.Path("PUBLICIP_FILE", params.CaseSensitiveValue(),
+		params.Default("/tmp/gluetun/ip"),
+		params.RetroKeys([]string{"IP_STATUS_FILE"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable PUBLICIP_FILE (or IP_STATUS_FILE): %w", err)
+	}
+
+	return nil
+}

internal/configuration/purevpn.go

@@ -0,0 +1,63 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) purevpnLines() (lines []string) {
+	if len(settings.ServerSelection.Regions) > 0 {
+		lines = append(lines, lastIndent+"Regions: "+commaJoin(settings.ServerSelection.Regions))
+	}
+
+	if len(settings.ServerSelection.Countries) > 0 {
+		lines = append(lines, lastIndent+"Countries: "+commaJoin(settings.ServerSelection.Countries))
+	}
+
+	if len(settings.ServerSelection.Cities) > 0 {
+		lines = append(lines, lastIndent+"Cities: "+commaJoin(settings.ServerSelection.Cities))
+	}
+
+	if len(settings.ServerSelection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(settings.ServerSelection.Hostnames))
+	}
+
+	return lines
+}
+
+func (settings *Provider) readPurevpn(r reader) (err error) {
+	settings.Name = constants.Purevpn
+
+	settings.ServerSelection.TCP, err = readProtocol(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.PurevpnRegionChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.PurevpnCountryChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.PurevpnCityChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.PurevpnHostnameChoices())
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return nil
+}

internal/configuration/reader.go

@@ -0,0 +1,122 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"net"
+	"strconv"
+	"strings"
+
+	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/golibs/params"
+	"github.com/qdm12/golibs/verification"
+)
+
+type reader struct {
+	env    params.Env
+	logger logging.Logger
+	regex  verification.Regex
+}
+
+func newReader(env params.Env, logger logging.Logger) reader {
+	return reader{
+		env:    env,
+		logger: logger,
+		regex:  verification.NewRegex(),
+	}
+}
+
+func (r *reader) onRetroActive(oldKey, newKey string) {
+	r.logger.Warn(
+		"You are using the old environment variable " + oldKey +
+			", please consider changing it to " + newKey)
+}
+
+var (
+	ErrInvalidPort = errors.New("invalid port")
+)
+
+func readCSVPorts(env params.Env, key string) (ports []uint16, err error) {
+	s, err := env.Get(key)
+	if err != nil {
+		return nil, err
+	} else if s == "" {
+		return nil, nil
+	}
+
+	portsStr := strings.Split(s, ",")
+	ports = make([]uint16, len(portsStr))
+	for i, portStr := range portsStr {
+		portInt, err := strconv.Atoi(portStr)
+		if err != nil {
+			return nil, fmt.Errorf("%w: %s: %s", ErrInvalidPort, portStr, err)
+		} else if portInt <= 0 || portInt > 65535 {
+			return nil, fmt.Errorf("%w: %d: must be between 1 and 65535", ErrInvalidPort, portInt)
+		}
+		ports[i] = uint16(portInt)
+	}
+
+	return ports, nil
+}
+
+var (
+	ErrInvalidIPNet = errors.New("invalid IP network")
+)
+
+func readCSVIPNets(env params.Env, key string, options ...params.OptionSetter) (
+	ipNets []net.IPNet, err error) {
+	s, err := env.Get(key, options...)
+	if err != nil {
+		return nil, err
+	} else if s == "" {
+		return nil, nil
+	}
+
+	ipNetsStr := strings.Split(s, ",")
+	ipNets = make([]net.IPNet, len(ipNetsStr))
+	for i, ipNetStr := range ipNetsStr {
+		_, ipNet, err := net.ParseCIDR(ipNetStr)
+		if err != nil {
+			return nil, fmt.Errorf("%w: %s: %s",
+				ErrInvalidIPNet, ipNetStr, err)
+		} else if ipNet == nil {
+			return nil, fmt.Errorf("%w: %s: subnet is nil", ErrInvalidIPNet, ipNetStr)
+		}
+		ipNets[i] = *ipNet
+	}
+
+	return ipNets, nil
+}
+
+var (
+	ErrInvalidIP = errors.New("invalid IP address")
+)
+
+func readIP(env params.Env, key string) (ip net.IP, err error) {
+	s, err := env.Get(key)
+	if s == "" {
+		return nil, nil
+	} else if err != nil {
+		return nil, err
+	}
+
+	ip = net.ParseIP(s)
+	if ip == nil {
+		return nil, fmt.Errorf("%w: %s", ErrInvalidIP, s)
+	}
+
+	return ip, nil
+}
+
+func readPortOrZero(env params.Env, key string) (port uint16, err error) {
+	s, err := env.Get(key)
+	if err != nil {
+		return 0, err
+	}
+
+	if s == "" || s == "0" {
+		return 0, nil
+	}
+
+	return env.Port(key)
+}

internal/configuration/secrets.go

@@ -0,0 +1,119 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"io"
+	"os"
+	"strings"
+
+	"github.com/qdm12/golibs/params"
+)
+
+var (
+	ErrGetSecretFilepath = errors.New("cannot get secret file path from env")
+	ErrReadSecretFile    = errors.New("cannot read secret file")
+	ErrSecretFileIsEmpty = errors.New("secret file is empty")
+	ErrReadNonSecretFile = errors.New("cannot read non secret file")
+	ErrFilesDoNotExist   = errors.New("files do not exist")
+)
+
+func cleanSuffix(value string) string {
+	value = strings.TrimSuffix(value, "\n")
+	value = strings.TrimSuffix(value, "\r")
+	return value
+}
+
+func (r *reader) getFromEnvOrSecretFile(envKey string, compulsory bool, retroKeys []string) (value string, err error) {
+	envOptions := []params.OptionSetter{
+		params.Compulsory(), // to fallback on file reading
+		params.CaseSensitiveValue(),
+		params.Unset(),
+		params.RetroKeys(retroKeys, r.onRetroActive),
+	}
+	value, envErr := r.env.Get(envKey, envOptions...)
+	if envErr == nil {
+		value = cleanSuffix(value)
+		return value, nil
+	}
+
+	secretFilepathEnvKey := envKey + "_SECRETFILE"
+	defaultSecretFile := "/run/secrets/" + strings.ToLower(envKey)
+	filepath, err := r.env.Get(secretFilepathEnvKey,
+		params.CaseSensitiveValue(),
+		params.Default(defaultSecretFile),
+	)
+	if err != nil {
+		return "", fmt.Errorf("%w: environment variable %s: %s",
+			ErrGetSecretFilepath, secretFilepathEnvKey, err)
+	}
+
+	file, fileErr := os.OpenFile(filepath, os.O_RDONLY, 0)
+	if os.IsNotExist(fileErr) {
+		if compulsory {
+			return "", envErr
+		}
+		return "", nil
+	} else if fileErr != nil {
+		return "", fmt.Errorf("%w: %s", ErrReadSecretFile, fileErr)
+	}
+
+	b, err := io.ReadAll(file)
+	if err != nil {
+		return "", fmt.Errorf("%w: %s", ErrReadSecretFile, err)
+	}
+
+	value = string(b)
+	value = cleanSuffix(value)
+	if compulsory && value == "" {
+		return "", ErrSecretFileIsEmpty
+	}
+
+	return value, nil
+}
+
+// Tries to read from the secret file then the non secret file.
+func (r *reader) getFromFileOrSecretFile(secretName, filepath string) (
+	b []byte, err error) {
+	defaultSecretFile := "/run/secrets/" + strings.ToLower(secretName)
+	key := strings.ToUpper(secretName) + "_SECRETFILE"
+	secretFilepath, err := r.env.Get(key,
+		params.CaseSensitiveValue(),
+		params.Default(defaultSecretFile),
+	)
+	if err != nil {
+		return b, fmt.Errorf("environment variable %s: %w: %s", key, ErrGetSecretFilepath, err)
+	}
+
+	b, err = readFromFile(secretFilepath)
+	if err != nil && !os.IsNotExist(err) {
+		return b, fmt.Errorf("%w: %s", ErrReadSecretFile, err)
+	} else if err == nil {
+		return b, nil
+	}
+
+	// Secret file does not exist, try the non secret file
+	b, err = readFromFile(filepath)
+	if err != nil && !os.IsNotExist(err) {
+		return nil, fmt.Errorf("%w: %s", ErrReadSecretFile, err)
+	} else if err == nil {
+		return b, nil
+	}
+	return nil, fmt.Errorf("%w: %s and %s", ErrFilesDoNotExist, secretFilepath, filepath)
+}
+
+func readFromFile(filepath string) (b []byte, err error) {
+	file, err := os.Open(filepath)
+	if err != nil {
+		return nil, err
+	}
+	b, err = io.ReadAll(file)
+	if err != nil {
+		_ = file.Close()
+		return nil, err
+	}
+	if err := file.Close(); err != nil {
+		return nil, err
+	}
+	return b, nil
+}

internal/configuration/selection.go

@@ -0,0 +1,63 @@
+package configuration
+
+import (
+	"net"
+)
+
+type ServerSelection struct { //nolint:maligned
+	// Common
+	TCP      bool   `json:"tcp"` // UDP if TCP is false
+	TargetIP net.IP `json:"target_ip,omitempty"`
+	// TODO comments
+	// Cyberghost, PIA, Protonvpn, Surfshark, Windscribe, Vyprvpn, NordVPN
+	Regions []string `json:"regions"`
+
+	// Cyberghost
+	Group string `json:"group"`
+
+	// Fastestvpn, HideMyAss, IPVanish, IVPN, Mullvad, PrivateVPN, Protonvpn, PureVPN, VPNUnlimited
+	Countries []string `json:"countries"`
+	// HideMyAss, IPVanish, IVPN, Mullvad, PrivateVPN, Protonvpn, PureVPN, VPNUnlimited, Windscribe
+	Cities []string `json:"cities"`
+	// Fastestvpn, HideMyAss, IPVanish, IVPN, PrivateVPN, Windscribe, Privado, Protonvpn, VPNUnlimited
+	Hostnames []string `json:"hostnames"`
+	Names     []string `json:"names"` // Protonvpn
+
+	// Mullvad
+	ISPs  []string `json:"isps"`
+	Owned bool     `json:"owned"`
+
+	// Mullvad, Windscribe, PIA
+	CustomPort uint16 `json:"custom_port"`
+
+	// NordVPN
+	Numbers []uint16 `json:"numbers"`
+
+	// PIA
+	EncryptionPreset string `json:"encryption_preset"`
+
+	// ProtonVPN
+	FreeOnly bool `json:"free_only"`
+
+	// VPNUnlimited
+	StreamOnly bool `json:"stream_only"`
+}
+
+type ExtraConfigOptions struct {
+	ClientCertificate string `json:"-"`                 // Cyberghost
+	ClientKey         string `json:"-"`                 // Cyberghost, VPNUnlimited
+	EncryptionPreset  string `json:"encryption_preset"` // PIA
+	OpenVPNIPv6       bool   `json:"openvpn_ipv6"`      // Mullvad
+}
+
+// PortForwarding contains settings for port forwarding.
+type PortForwarding struct {
+	Enabled  bool   `json:"enabled"`
+	Filepath string `json:"filepath"`
+}
+
+func (p *PortForwarding) lines() (lines []string) {
+	return []string{
+		lastIndent + "File path: " + p.Filepath,
+	}
+}

internal/configuration/server.go

@@ -0,0 +1,50 @@
+package configuration
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/qdm12/golibs/params"
+)
+
+// ControlServer contains settings to customize the control server operation.
+type ControlServer struct {
+	Port uint16
+	Log  bool
+}
+
+func (settings *ControlServer) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *ControlServer) lines() (lines []string) {
+	lines = append(lines, lastIndent+"HTTP control server:")
+
+	lines = append(lines, indent+lastIndent+"Listening port: "+strconv.Itoa(int(settings.Port)))
+
+	if settings.Log {
+		lines = append(lines, indent+lastIndent+"Logging: enabled")
+	}
+
+	return lines
+}
+
+func (settings *ControlServer) read(r reader) (err error) {
+	settings.Log, err = r.env.OnOff("HTTP_CONTROL_SERVER_LOG", params.Default("on"))
+	if err != nil {
+		return fmt.Errorf("environment variable HTTP_CONTROL_SERVER_LOG: %w", err)
+	}
+
+	var warning string
+	settings.Port, warning, err = r.env.ListeningPort(
+		"HTTP_CONTROL_SERVER_PORT", params.Default("8000"))
+	if len(warning) > 0 {
+		r.logger.Warn(warning)
+	}
+	if err != nil {
+		return fmt.Errorf("environment variable HTTP_CONTROL_SERVER_PORT: %w", err)
+	}
+
+	return nil
+}

internal/configuration/settings.go

@@ -0,0 +1,117 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"strings"
+
+	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/golibs/params"
+)
+
+// Settings contains all settings for the program to run.
+type Settings struct {
+	OpenVPN            OpenVPN
+	System             System
+	DNS                DNS
+	Firewall           Firewall
+	HTTPProxy          HTTPProxy
+	ShadowSocks        ShadowSocks
+	Updater            Updater
+	PublicIP           PublicIP
+	VersionInformation bool
+	ControlServer      ControlServer
+	Health             Health
+}
+
+func (settings *Settings) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *Settings) lines() (lines []string) {
+	lines = append(lines, "Settings summary below:")
+	lines = append(lines, settings.OpenVPN.lines()...)
+	lines = append(lines, settings.DNS.lines()...)
+	lines = append(lines, settings.Firewall.lines()...)
+	lines = append(lines, settings.System.lines()...)
+	lines = append(lines, settings.HTTPProxy.lines()...)
+	lines = append(lines, settings.ShadowSocks.lines()...)
+	lines = append(lines, settings.Health.lines()...)
+	lines = append(lines, settings.ControlServer.lines()...)
+	lines = append(lines, settings.Updater.lines()...)
+	lines = append(lines, settings.PublicIP.lines()...)
+	if settings.VersionInformation {
+		lines = append(lines, lastIndent+"Github version information: enabled")
+	}
+	return lines
+}
+
+var (
+	ErrOpenvpn       = errors.New("cannot read Openvpn settings")
+	ErrSystem        = errors.New("cannot read System settings")
+	ErrDNS           = errors.New("cannot read DNS settings")
+	ErrFirewall      = errors.New("cannot read firewall settings")
+	ErrHTTPProxy     = errors.New("cannot read HTTP proxy settings")
+	ErrShadowsocks   = errors.New("cannot read Shadowsocks settings")
+	ErrControlServer = errors.New("cannot read control server settings")
+	ErrUpdater       = errors.New("cannot read Updater settings")
+	ErrPublicIP      = errors.New("cannot read Public IP getter settings")
+	ErrHealth        = errors.New("cannot read health settings")
+)
+
+// Read obtains all configuration options for the program and returns an error as soon
+// as an error is encountered reading them.
+func (settings *Settings) Read(env params.Env, logger logging.Logger) (err error) {
+	r := newReader(env, logger)
+
+	settings.VersionInformation, err = r.env.OnOff("VERSION_INFORMATION", params.Default("on"))
+	if err != nil {
+		return fmt.Errorf("environment variable VERSION_INFORMATION: %w", err)
+	}
+
+	if err := settings.OpenVPN.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrOpenvpn, err)
+	}
+
+	if err := settings.System.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrSystem, err)
+	}
+
+	if err := settings.DNS.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrDNS, err)
+	}
+
+	if err := settings.Firewall.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrFirewall, err)
+	}
+
+	if err := settings.HTTPProxy.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrHTTPProxy, err)
+	}
+
+	if err := settings.ShadowSocks.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrShadowsocks, err)
+	}
+
+	if err := settings.ControlServer.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrControlServer, err)
+	}
+
+	if err := settings.Updater.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrUpdater, err)
+	}
+
+	if ip := settings.DNS.PlaintextAddress; ip != nil {
+		settings.Updater.DNSAddress = ip.String()
+	}
+
+	if err := settings.PublicIP.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrPublicIP, err)
+	}
+
+	if err := settings.Health.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrHealth, err)
+	}
+
+	return nil
+}

internal/configuration/settings/dns.go

@@ -1,89 +0,0 @@
-package settings
-
-import (
-	"fmt"
-	"net/netip"
-
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gotree"
-)
-
-// DNS contains settings to configure DNS.
-type DNS struct {
-	// ServerAddress is the DNS server to use inside
-	// the Go program and for the system.
-	// It defaults to '127.0.0.1' to be used with the
-	// DoT server. It cannot be the zero value in the internal
-	// state.
-	ServerAddress netip.Addr
-	// KeepNameserver is true if the existing DNS server
-	// found in /etc/resolv.conf should be used
-	// Note setting this to true will likely DNS traffic
-	// outside the VPN tunnel since it would go through
-	// the local DNS server of your Docker/Kubernetes
-	// configuration, which is likely not going through the tunnel.
-	// This will also disable the DNS over TLS server and the
-	// `ServerAddress` field will be ignored.
-	// It defaults to false and cannot be nil in the
-	// internal state.
-	KeepNameserver *bool
-	// DOT contains settings to configure the DoT
-	// server.
-	DoT DoT
-}
-
-func (d DNS) validate() (err error) {
-	err = d.DoT.validate()
-	if err != nil {
-		return fmt.Errorf("validating DoT settings: %w", err)
-	}
-
-	return nil
-}
-
-func (d *DNS) Copy() (copied DNS) {
-	return DNS{
-		ServerAddress:  d.ServerAddress,
-		KeepNameserver: gosettings.CopyPointer(d.KeepNameserver),
-		DoT:            d.DoT.copy(),
-	}
-}
-
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (d *DNS) mergeWith(other DNS) {
-	d.ServerAddress = gosettings.MergeWithValidator(d.ServerAddress, other.ServerAddress)
-	d.KeepNameserver = gosettings.MergeWithPointer(d.KeepNameserver, other.KeepNameserver)
-	d.DoT.mergeWith(other.DoT)
-}
-
-// overrideWith overrides fields of the receiver
-// settings object with any field set in the other
-// settings.
-func (d *DNS) overrideWith(other DNS) {
-	d.ServerAddress = gosettings.OverrideWithValidator(d.ServerAddress, other.ServerAddress)
-	d.KeepNameserver = gosettings.OverrideWithPointer(d.KeepNameserver, other.KeepNameserver)
-	d.DoT.overrideWith(other.DoT)
-}
-
-func (d *DNS) setDefaults() {
-	localhost := netip.AddrFrom4([4]byte{127, 0, 0, 1})
-	d.ServerAddress = gosettings.DefaultValidator(d.ServerAddress, localhost)
-	d.KeepNameserver = gosettings.DefaultPointer(d.KeepNameserver, false)
-	d.DoT.setDefaults()
-}
-
-func (d DNS) String() string {
-	return d.toLinesNode().String()
-}
-
-func (d DNS) toLinesNode() (node *gotree.Node) {
-	node = gotree.New("DNS settings:")
-	node.Appendf("Keep existing nameserver(s): %s", gosettings.BoolToYesNo(d.KeepNameserver))
-	if *d.KeepNameserver {
-		return node
-	}
-	node.Appendf("DNS server address to use: %s", d.ServerAddress)
-	node.AppendNode(d.DoT.toLinesNode())
-	return node
-}

internal/configuration/settings/dnsblacklist.go

@@ -1,138 +0,0 @@
-package settings
-
-import (
-	"errors"
-	"fmt"
-	"net/netip"
-	"regexp"
-
-	"github.com/qdm12/dns/pkg/blacklist"
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gotree"
-)
-
-// DNSBlacklist is settings for the DNS blacklist building.
-type DNSBlacklist struct {
-	BlockMalicious       *bool
-	BlockAds             *bool
-	BlockSurveillance    *bool
-	AllowedHosts         []string
-	AddBlockedHosts      []string
-	AddBlockedIPs        []netip.Addr
-	AddBlockedIPPrefixes []netip.Prefix
-}
-
-func (b *DNSBlacklist) setDefaults() {
-	b.BlockMalicious = gosettings.DefaultPointer(b.BlockMalicious, true)
-	b.BlockAds = gosettings.DefaultPointer(b.BlockAds, false)
-	b.BlockSurveillance = gosettings.DefaultPointer(b.BlockSurveillance, true)
-}
-
-var hostRegex = regexp.MustCompile(`^([a-zA-Z0-9]|[a-zA-Z0-9_][a-zA-Z0-9\-_]{0,61}[a-zA-Z0-9_])(\.([a-zA-Z0-9]|[a-zA-Z0-9_][a-zA-Z0-9\-_]{0,61}[a-zA-Z0-9]))*$`) //nolint:lll
-
-var (
-	ErrAllowedHostNotValid = errors.New("allowed host is not valid")
-	ErrBlockedHostNotValid = errors.New("blocked host is not valid")
-)
-
-func (b DNSBlacklist) validate() (err error) {
-	for _, host := range b.AllowedHosts {
-		if !hostRegex.MatchString(host) {
-			return fmt.Errorf("%w: %s", ErrAllowedHostNotValid, host)
-		}
-	}
-
-	for _, host := range b.AddBlockedHosts {
-		if !hostRegex.MatchString(host) {
-			return fmt.Errorf("%w: %s", ErrBlockedHostNotValid, host)
-		}
-	}
-
-	return nil
-}
-
-func (b DNSBlacklist) copy() (copied DNSBlacklist) {
-	return DNSBlacklist{
-		BlockMalicious:       gosettings.CopyPointer(b.BlockMalicious),
-		BlockAds:             gosettings.CopyPointer(b.BlockAds),
-		BlockSurveillance:    gosettings.CopyPointer(b.BlockSurveillance),
-		AllowedHosts:         gosettings.CopySlice(b.AllowedHosts),
-		AddBlockedHosts:      gosettings.CopySlice(b.AddBlockedHosts),
-		AddBlockedIPs:        gosettings.CopySlice(b.AddBlockedIPs),
-		AddBlockedIPPrefixes: gosettings.CopySlice(b.AddBlockedIPPrefixes),
-	}
-}
-
-func (b *DNSBlacklist) mergeWith(other DNSBlacklist) {
-	b.BlockMalicious = gosettings.MergeWithPointer(b.BlockMalicious, other.BlockMalicious)
-	b.BlockAds = gosettings.MergeWithPointer(b.BlockAds, other.BlockAds)
-	b.BlockSurveillance = gosettings.MergeWithPointer(b.BlockSurveillance, other.BlockSurveillance)
-	b.AllowedHosts = gosettings.MergeWithSlice(b.AllowedHosts, other.AllowedHosts)
-	b.AddBlockedHosts = gosettings.MergeWithSlice(b.AddBlockedHosts, other.AddBlockedHosts)
-	b.AddBlockedIPs = gosettings.MergeWithSlice(b.AddBlockedIPs, other.AddBlockedIPs)
-	b.AddBlockedIPPrefixes = gosettings.MergeWithSlice(b.AddBlockedIPPrefixes, other.AddBlockedIPPrefixes)
-}
-
-func (b *DNSBlacklist) overrideWith(other DNSBlacklist) {
-	b.BlockMalicious = gosettings.OverrideWithPointer(b.BlockMalicious, other.BlockMalicious)
-	b.BlockAds = gosettings.OverrideWithPointer(b.BlockAds, other.BlockAds)
-	b.BlockSurveillance = gosettings.OverrideWithPointer(b.BlockSurveillance, other.BlockSurveillance)
-	b.AllowedHosts = gosettings.OverrideWithSlice(b.AllowedHosts, other.AllowedHosts)
-	b.AddBlockedHosts = gosettings.OverrideWithSlice(b.AddBlockedHosts, other.AddBlockedHosts)
-	b.AddBlockedIPs = gosettings.OverrideWithSlice(b.AddBlockedIPs, other.AddBlockedIPs)
-	b.AddBlockedIPPrefixes = gosettings.OverrideWithSlice(b.AddBlockedIPPrefixes, other.AddBlockedIPPrefixes)
-}
-
-func (b DNSBlacklist) ToBlacklistFormat() (settings blacklist.BuilderSettings, err error) {
-	return blacklist.BuilderSettings{
-		BlockMalicious:       *b.BlockMalicious,
-		BlockAds:             *b.BlockAds,
-		BlockSurveillance:    *b.BlockSurveillance,
-		AllowedHosts:         b.AllowedHosts,
-		AddBlockedHosts:      b.AddBlockedHosts,
-		AddBlockedIPs:        netipAddressesToNetaddrIPs(b.AddBlockedIPs),
-		AddBlockedIPPrefixes: netipPrefixesToNetaddrIPPrefixes(b.AddBlockedIPPrefixes),
-	}, nil
-}
-
-func (b DNSBlacklist) String() string {
-	return b.toLinesNode().String()
-}
-
-func (b DNSBlacklist) toLinesNode() (node *gotree.Node) {
-	node = gotree.New("DNS filtering settings:")
-
-	node.Appendf("Block malicious: %s", gosettings.BoolToYesNo(b.BlockMalicious))
-	node.Appendf("Block ads: %s", gosettings.BoolToYesNo(b.BlockAds))
-	node.Appendf("Block surveillance: %s", gosettings.BoolToYesNo(b.BlockSurveillance))
-
-	if len(b.AllowedHosts) > 0 {
-		allowedHostsNode := node.Appendf("Allowed hosts:")
-		for _, host := range b.AllowedHosts {
-			allowedHostsNode.Appendf(host)
-		}
-	}
-
-	if len(b.AddBlockedHosts) > 0 {
-		blockedHostsNode := node.Appendf("Blocked hosts:")
-		for _, host := range b.AddBlockedHosts {
-			blockedHostsNode.Appendf(host)
-		}
-	}
-
-	if len(b.AddBlockedIPs) > 0 {
-		blockedIPsNode := node.Appendf("Blocked IP addresses:")
-		for _, ip := range b.AddBlockedIPs {
-			blockedIPsNode.Appendf(ip.String())
-		}
-	}
-
-	if len(b.AddBlockedIPPrefixes) > 0 {
-		blockedIPPrefixesNode := node.Appendf("Blocked IP networks:")
-		for _, ipNetwork := range b.AddBlockedIPPrefixes {
-			blockedIPPrefixesNode.Appendf(ipNetwork.String())
-		}
-	}
-
-	return node
-}

internal/configuration/settings/dot.go

@@ -1,113 +0,0 @@
-package settings
-
-import (
-	"errors"
-	"fmt"
-	"time"
-
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gotree"
-)
-
-// DoT contains settings to configure the DoT server.
-type DoT struct {
-	// Enabled is true if the DoT server should be running
-	// and used. It defaults to true, and cannot be nil
-	// in the internal state.
-	Enabled *bool
-	// UpdatePeriod is the period to update DNS block
-	// lists and cryptographic files for DNSSEC validation.
-	// It can be set to 0 to disable the update.
-	// It defaults to 24h and cannot be nil in
-	// the internal state.
-	UpdatePeriod *time.Duration
-	// Unbound contains settings to configure Unbound.
-	Unbound Unbound
-	// Blacklist contains settings to configure the filter
-	// block lists.
-	Blacklist DNSBlacklist
-}
-
-var (
-	ErrDoTUpdatePeriodTooShort = errors.New("update period is too short")
-)
-
-func (d DoT) validate() (err error) {
-	const minUpdatePeriod = 30 * time.Second
-	if *d.UpdatePeriod != 0 && *d.UpdatePeriod < minUpdatePeriod {
-		return fmt.Errorf("%w: %s must be bigger than %s",
-			ErrDoTUpdatePeriodTooShort, *d.UpdatePeriod, minUpdatePeriod)
-	}
-
-	err = d.Unbound.validate()
-	if err != nil {
-		return err
-	}
-
-	err = d.Blacklist.validate()
-	if err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func (d *DoT) copy() (copied DoT) {
-	return DoT{
-		Enabled:      gosettings.CopyPointer(d.Enabled),
-		UpdatePeriod: gosettings.CopyPointer(d.UpdatePeriod),
-		Unbound:      d.Unbound.copy(),
-		Blacklist:    d.Blacklist.copy(),
-	}
-}
-
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (d *DoT) mergeWith(other DoT) {
-	d.Enabled = gosettings.MergeWithPointer(d.Enabled, other.Enabled)
-	d.UpdatePeriod = gosettings.MergeWithPointer(d.UpdatePeriod, other.UpdatePeriod)
-	d.Unbound.mergeWith(other.Unbound)
-	d.Blacklist.mergeWith(other.Blacklist)
-}
-
-// overrideWith overrides fields of the receiver
-// settings object with any field set in the other
-// settings.
-func (d *DoT) overrideWith(other DoT) {
-	d.Enabled = gosettings.OverrideWithPointer(d.Enabled, other.Enabled)
-	d.UpdatePeriod = gosettings.OverrideWithPointer(d.UpdatePeriod, other.UpdatePeriod)
-	d.Unbound.overrideWith(other.Unbound)
-	d.Blacklist.overrideWith(other.Blacklist)
-}
-
-func (d *DoT) setDefaults() {
-	d.Enabled = gosettings.DefaultPointer(d.Enabled, true)
-	const defaultUpdatePeriod = 24 * time.Hour
-	d.UpdatePeriod = gosettings.DefaultPointer(d.UpdatePeriod, defaultUpdatePeriod)
-	d.Unbound.setDefaults()
-	d.Blacklist.setDefaults()
-}
-
-func (d DoT) String() string {
-	return d.toLinesNode().String()
-}
-
-func (d DoT) toLinesNode() (node *gotree.Node) {
-	node = gotree.New("DNS over TLS settings:")
-
-	node.Appendf("Enabled: %s", gosettings.BoolToYesNo(d.Enabled))
-	if !*d.Enabled {
-		return node
-	}
-
-	update := "disabled" //nolint:goconst
-	if *d.UpdatePeriod > 0 {
-		update = "every " + d.UpdatePeriod.String()
-	}
-	node.Appendf("Update period: %s", update)
-
-	node.AppendNode(d.Unbound.toLinesNode())
-	node.AppendNode(d.Blacklist.toLinesNode())
-
-	return node
-}

internal/configuration/settings/errors.go

@@ -1,51 +0,0 @@
-package settings
-
-import "errors"
-
-var (
-	ErrCityNotValid                    = errors.New("the city specified is not valid")
-	ErrControlServerPrivilegedPort     = errors.New("cannot use privileged port without running as root")
-	ErrCountryNotValid                 = errors.New("the country specified is not valid")
-	ErrFilepathMissing                 = errors.New("filepath is missing")
-	ErrFirewallZeroPort                = errors.New("cannot have a zero port to block")
-	ErrHostnameNotValid                = errors.New("the hostname specified is not valid")
-	ErrISPNotValid                     = errors.New("the ISP specified is not valid")
-	ErrMinRatioNotValid                = errors.New("minimum ratio is not valid")
-	ErrMissingValue                    = errors.New("missing value")
-	ErrNameNotValid                    = errors.New("the server name specified is not valid")
-	ErrOpenVPNClientKeyMissing         = errors.New("client key is missing")
-	ErrOpenVPNCustomPortNotAllowed     = errors.New("custom endpoint port is not allowed")
-	ErrOpenVPNEncryptionPresetNotValid = errors.New("PIA encryption preset is not valid")
-	ErrOpenVPNInterfaceNotValid        = errors.New("interface name is not valid")
-	ErrOpenVPNKeyPassphraseIsEmpty     = errors.New("key passphrase is empty")
-	ErrOpenVPNMSSFixIsTooHigh          = errors.New("mssfix option value is too high")
-	ErrOpenVPNPasswordIsEmpty          = errors.New("password is empty")
-	ErrOpenVPNTCPNotSupported          = errors.New("TCP protocol is not supported")
-	ErrOpenVPNUserIsEmpty              = errors.New("user is empty")
-	ErrOpenVPNVerbosityIsOutOfBounds   = errors.New("verbosity value is out of bounds")
-	ErrOpenVPNVersionIsNotValid        = errors.New("version is not valid")
-	ErrPortForwardingEnabled           = errors.New("port forwarding cannot be enabled")
-	ErrPublicIPPeriodTooShort          = errors.New("public IP address check period is too short")
-	ErrRegionNotValid                  = errors.New("the region specified is not valid")
-	ErrServerAddressNotValid           = errors.New("server listening address is not valid")
-	ErrSystemPGIDNotValid              = errors.New("process group id is not valid")
-	ErrSystemPUIDNotValid              = errors.New("process user id is not valid")
-	ErrSystemTimezoneNotValid          = errors.New("timezone is not valid")
-	ErrUpdaterPeriodTooSmall           = errors.New("VPN server data updater period is too small")
-	ErrVPNProviderNameNotValid         = errors.New("VPN provider name is not valid")
-	ErrVPNTypeNotValid                 = errors.New("VPN type is not valid")
-	ErrWireguardAllowedIPNotSet        = errors.New("allowed IP is not set")
-	ErrWireguardAllowedIPsNotSet       = errors.New("allowed IPs is not set")
-	ErrWireguardEndpointIPNotSet       = errors.New("endpoint IP is not set")
-	ErrWireguardEndpointPortNotAllowed = errors.New("endpoint port is not allowed")
-	ErrWireguardEndpointPortNotSet     = errors.New("endpoint port is not set")
-	ErrWireguardEndpointPortSet        = errors.New("endpoint port is set")
-	ErrWireguardInterfaceAddressNotSet = errors.New("interface address is not set")
-	ErrWireguardInterfaceAddressIPv6   = errors.New("interface address is IPv6 but IPv6 is not supported")
-	ErrWireguardInterfaceNotValid      = errors.New("interface name is not valid")
-	ErrWireguardPreSharedKeyNotSet     = errors.New("pre-shared key is not set")
-	ErrWireguardPrivateKeyNotSet       = errors.New("private key is not set")
-	ErrWireguardPublicKeyNotSet        = errors.New("public key is not set")
-	ErrWireguardPublicKeyNotValid      = errors.New("public key is not valid")
-	ErrWireguardImplementationNotValid = errors.New("implementation is not valid")
-)

internal/configuration/settings/firewall.go

@@ -1,118 +0,0 @@
-package settings
-
-import (
-	"fmt"
-	"net/netip"
-
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gotree"
-)
-
-// Firewall contains settings to customize the firewall operation.
-type Firewall struct {
-	VPNInputPorts   []uint16
-	InputPorts      []uint16
-	OutboundSubnets []netip.Prefix
-	Enabled         *bool
-	Debug           *bool
-}
-
-func (f Firewall) validate() (err error) {
-	if hasZeroPort(f.VPNInputPorts) {
-		return fmt.Errorf("VPN input ports: %w", ErrFirewallZeroPort)
-	}
-
-	if hasZeroPort(f.InputPorts) {
-		return fmt.Errorf("input ports: %w", ErrFirewallZeroPort)
-	}
-
-	return nil
-}
-
-func hasZeroPort(ports []uint16) (has bool) {
-	for _, port := range ports {
-		if port == 0 {
-			return true
-		}
-	}
-	return false
-}
-
-func (f *Firewall) copy() (copied Firewall) {
-	return Firewall{
-		VPNInputPorts:   gosettings.CopySlice(f.VPNInputPorts),
-		InputPorts:      gosettings.CopySlice(f.InputPorts),
-		OutboundSubnets: gosettings.CopySlice(f.OutboundSubnets),
-		Enabled:         gosettings.CopyPointer(f.Enabled),
-		Debug:           gosettings.CopyPointer(f.Debug),
-	}
-}
-
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-// It merges values of slices together, even if they
-// are set in the receiver settings.
-func (f *Firewall) mergeWith(other Firewall) {
-	f.VPNInputPorts = gosettings.MergeWithSlice(f.VPNInputPorts, other.VPNInputPorts)
-	f.InputPorts = gosettings.MergeWithSlice(f.InputPorts, other.InputPorts)
-	f.OutboundSubnets = gosettings.MergeWithSlice(f.OutboundSubnets, other.OutboundSubnets)
-	f.Enabled = gosettings.MergeWithPointer(f.Enabled, other.Enabled)
-	f.Debug = gosettings.MergeWithPointer(f.Debug, other.Debug)
-}
-
-// overrideWith overrides fields of the receiver
-// settings object with any field set in the other
-// settings.
-func (f *Firewall) overrideWith(other Firewall) {
-	f.VPNInputPorts = gosettings.OverrideWithSlice(f.VPNInputPorts, other.VPNInputPorts)
-	f.InputPorts = gosettings.OverrideWithSlice(f.InputPorts, other.InputPorts)
-	f.OutboundSubnets = gosettings.OverrideWithSlice(f.OutboundSubnets, other.OutboundSubnets)
-	f.Enabled = gosettings.OverrideWithPointer(f.Enabled, other.Enabled)
-	f.Debug = gosettings.OverrideWithPointer(f.Debug, other.Debug)
-}
-
-func (f *Firewall) setDefaults() {
-	f.Enabled = gosettings.DefaultPointer(f.Enabled, true)
-	f.Debug = gosettings.DefaultPointer(f.Debug, false)
-}
-
-func (f Firewall) String() string {
-	return f.toLinesNode().String()
-}
-
-func (f Firewall) toLinesNode() (node *gotree.Node) {
-	node = gotree.New("Firewall settings:")
-
-	node.Appendf("Enabled: %s", gosettings.BoolToYesNo(f.Enabled))
-	if !*f.Enabled {
-		return node
-	}
-
-	if *f.Debug {
-		node.Appendf("Debug mode: on")
-	}
-
-	if len(f.VPNInputPorts) > 0 {
-		vpnInputPortsNode := node.Appendf("VPN input ports:")
-		for _, port := range f.VPNInputPorts {
-			vpnInputPortsNode.Appendf("%d", port)
-		}
-	}
-
-	if len(f.InputPorts) > 0 {
-		inputPortsNode := node.Appendf("Input ports:")
-		for _, port := range f.InputPorts {
-			inputPortsNode.Appendf("%d", port)
-		}
-	}
-
-	if len(f.OutboundSubnets) > 0 {
-		outboundSubnets := node.Appendf("Outbound subnets:")
-		for _, subnet := range f.OutboundSubnets {
-			subnet := subnet
-			outboundSubnets.Appendf("%s", &subnet)
-		}
-	}
-
-	return node
-}

internal/configuration/settings/health.go

@@ -1,113 +0,0 @@
-package settings
-
-import (
-	"fmt"
-	"os"
-	"time"
-
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gotree"
-	"github.com/qdm12/govalid/address"
-)
-
-// Health contains settings for the healthcheck and health server.
-type Health struct {
-	// ServerAddress is the listening address
-	// for the health check server.
-	// It cannot be the empty string in the internal state.
-	ServerAddress string
-	// ReadHeaderTimeout is the HTTP server header read timeout
-	// duration of the HTTP server. It defaults to 100 milliseconds.
-	ReadHeaderTimeout time.Duration
-	// ReadTimeout is the HTTP read timeout duration of the
-	// HTTP server. It defaults to 500 milliseconds.
-	ReadTimeout time.Duration
-	// TargetAddress is the address (host or host:port)
-	// to TCP dial to periodically for the health check.
-	// It cannot be the empty string in the internal state.
-	TargetAddress string
-	// SuccessWait is the duration to wait to re-run the
-	// healthcheck after a successful healthcheck.
-	// It defaults to 5 seconds and cannot be zero in
-	// the internal state.
-	SuccessWait time.Duration
-	// VPN has health settings specific to the VPN loop.
-	VPN HealthyWait
-}
-
-func (h Health) Validate() (err error) {
-	uid := os.Getuid()
-	err = address.Validate(h.ServerAddress,
-		address.OptionListening(uid))
-	if err != nil {
-		return fmt.Errorf("server listening address is not valid: %w", err)
-	}
-
-	err = h.VPN.validate()
-	if err != nil {
-		return fmt.Errorf("health VPN settings: %w", err)
-	}
-
-	return nil
-}
-
-func (h *Health) copy() (copied Health) {
-	return Health{
-		ServerAddress:     h.ServerAddress,
-		ReadHeaderTimeout: h.ReadHeaderTimeout,
-		ReadTimeout:       h.ReadTimeout,
-		TargetAddress:     h.TargetAddress,
-		SuccessWait:       h.SuccessWait,
-		VPN:               h.VPN.copy(),
-	}
-}
-
-// MergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (h *Health) MergeWith(other Health) {
-	h.ServerAddress = gosettings.MergeWithString(h.ServerAddress, other.ServerAddress)
-	h.ReadHeaderTimeout = gosettings.MergeWithNumber(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
-	h.ReadTimeout = gosettings.MergeWithNumber(h.ReadTimeout, other.ReadTimeout)
-	h.TargetAddress = gosettings.MergeWithString(h.TargetAddress, other.TargetAddress)
-	h.SuccessWait = gosettings.MergeWithNumber(h.SuccessWait, other.SuccessWait)
-	h.VPN.mergeWith(other.VPN)
-}
-
-// OverrideWith overrides fields of the receiver
-// settings object with any field set in the other
-// settings.
-func (h *Health) OverrideWith(other Health) {
-	h.ServerAddress = gosettings.OverrideWithString(h.ServerAddress, other.ServerAddress)
-	h.ReadHeaderTimeout = gosettings.OverrideWithNumber(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
-	h.ReadTimeout = gosettings.OverrideWithNumber(h.ReadTimeout, other.ReadTimeout)
-	h.TargetAddress = gosettings.OverrideWithString(h.TargetAddress, other.TargetAddress)
-	h.SuccessWait = gosettings.OverrideWithNumber(h.SuccessWait, other.SuccessWait)
-	h.VPN.overrideWith(other.VPN)
-}
-
-func (h *Health) SetDefaults() {
-	h.ServerAddress = gosettings.DefaultString(h.ServerAddress, "127.0.0.1:9999")
-	const defaultReadHeaderTimeout = 100 * time.Millisecond
-	h.ReadHeaderTimeout = gosettings.DefaultNumber(h.ReadHeaderTimeout, defaultReadHeaderTimeout)
-	const defaultReadTimeout = 500 * time.Millisecond
-	h.ReadTimeout = gosettings.DefaultNumber(h.ReadTimeout, defaultReadTimeout)
-	h.TargetAddress = gosettings.DefaultString(h.TargetAddress, "cloudflare.com:443")
-	const defaultSuccessWait = 5 * time.Second
-	h.SuccessWait = gosettings.DefaultNumber(h.SuccessWait, defaultSuccessWait)
-	h.VPN.setDefaults()
-}
-
-func (h Health) String() string {
-	return h.toLinesNode().String()
-}
-
-func (h Health) toLinesNode() (node *gotree.Node) {
-	node = gotree.New("Health settings:")
-	node.Appendf("Server listening address: %s", h.ServerAddress)
-	node.Appendf("Target address: %s", h.TargetAddress)
-	node.Appendf("Duration to wait after success: %s", h.SuccessWait)
-	node.Appendf("Read header timeout: %s", h.ReadHeaderTimeout)
-	node.Appendf("Read timeout: %s", h.ReadTimeout)
-	node.AppendNode(h.VPN.toLinesNode("VPN"))
-	return node
-}

internal/configuration/settings/healthywait.go

@@ -1,66 +0,0 @@
-package settings
-
-import (
-	"time"
-
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gotree"
-)
-
-type HealthyWait struct {
-	// Initial is the initial duration to wait for the program
-	// to be healthy before taking action.
-	// It cannot be nil in the internal state.
-	Initial *time.Duration
-	// Addition is the duration to add to the Initial duration
-	// after Initial has expired to wait longer for the program
-	// to be healthy.
-	// It cannot be nil in the internal state.
-	Addition *time.Duration
-}
-
-func (h HealthyWait) validate() (err error) {
-	return nil
-}
-
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (h *HealthyWait) copy() (copied HealthyWait) {
-	return HealthyWait{
-		Initial:  gosettings.CopyPointer(h.Initial),
-		Addition: gosettings.CopyPointer(h.Addition),
-	}
-}
-
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (h *HealthyWait) mergeWith(other HealthyWait) {
-	h.Initial = gosettings.MergeWithPointer(h.Initial, other.Initial)
-	h.Addition = gosettings.MergeWithPointer(h.Addition, other.Addition)
-}
-
-// overrideWith overrides fields of the receiver
-// settings object with any field set in the other
-// settings.
-func (h *HealthyWait) overrideWith(other HealthyWait) {
-	h.Initial = gosettings.OverrideWithPointer(h.Initial, other.Initial)
-	h.Addition = gosettings.OverrideWithPointer(h.Addition, other.Addition)
-}
-
-func (h *HealthyWait) setDefaults() {
-	const initialDurationDefault = 6 * time.Second
-	const additionDurationDefault = 5 * time.Second
-	h.Initial = gosettings.DefaultPointer(h.Initial, initialDurationDefault)
-	h.Addition = gosettings.DefaultPointer(h.Addition, additionDurationDefault)
-}
-
-func (h HealthyWait) String() string {
-	return h.toLinesNode("Health").String()
-}
-
-func (h HealthyWait) toLinesNode(kind string) (node *gotree.Node) {
-	node = gotree.New(kind + " wait durations:")
-	node.Appendf("Initial duration: %s", *h.Initial)
-	node.Appendf("Additional duration: %s", *h.Addition)
-	return node
-}

internal/configuration/settings/helpers/belong.go

@@ -1,10 +0,0 @@
-package helpers
-
-func IsOneOf[T comparable](value T, choices ...T) (ok bool) {
-	for _, choice := range choices {
-		if value == choice {
-			return true
-		}
-	}
-	return false
-}

internal/configuration/settings/helpers/string.go

@@ -1,8 +0,0 @@
-package helpers
-
-func TCPPtrToString(tcp *bool) string {
-	if *tcp {
-		return "TCP"
-	}
-	return "UDP"
-}

internal/configuration/settings/helpers_test.go

@@ -1,4 +0,0 @@
-package settings
-
-func boolPtr(b bool) *bool    { return &b }
-func uint8Ptr(n uint8) *uint8 { return &n }

internal/configuration/settings/httpproxy.go

@@ -1,130 +0,0 @@
-package settings
-
-import (
-	"fmt"
-	"os"
-	"time"
-
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gotree"
-	"github.com/qdm12/govalid/address"
-)
-
-// HTTPProxy contains settings to configure the HTTP proxy.
-type HTTPProxy struct {
-	// User is the username to use for the HTTP proxy.
-	// It cannot be nil in the internal state.
-	User *string
-	// Password is the password to use for the HTTP proxy.
-	// It cannot be nil in the internal state.
-	Password *string
-	// ListeningAddress is the listening address
-	// of the HTTP proxy server.
-	// It cannot be the empty string in the internal state.
-	ListeningAddress string
-	// Enabled is true if the HTTP proxy server should run,
-	// and false otherwise. It cannot be nil in the
-	// internal state.
-	Enabled *bool
-	// Stealth is true if the HTTP proxy server should hide
-	// each request has been proxied to the destination.
-	// It cannot be nil in the internal state.
-	Stealth *bool
-	// Log is true if the HTTP proxy server should log
-	// each request/response. It cannot be nil in the
-	// internal state.
-	Log *bool
-	// ReadHeaderTimeout is the HTTP header read timeout duration
-	// of the HTTP server. It defaults to 1 second if left unset.
-	ReadHeaderTimeout time.Duration
-	// ReadTimeout is the HTTP read timeout duration
-	// of the HTTP server. It defaults to 3 seconds if left unset.
-	ReadTimeout time.Duration
-}
-
-func (h HTTPProxy) validate() (err error) {
-	// Do not validate user and password
-
-	uid := os.Getuid()
-	err = address.Validate(h.ListeningAddress, address.OptionListening(uid))
-	if err != nil {
-		return fmt.Errorf("%w: %s", ErrServerAddressNotValid, h.ListeningAddress)
-	}
-
-	return nil
-}
-
-func (h *HTTPProxy) copy() (copied HTTPProxy) {
-	return HTTPProxy{
-		User:              gosettings.CopyPointer(h.User),
-		Password:          gosettings.CopyPointer(h.Password),
-		ListeningAddress:  h.ListeningAddress,
-		Enabled:           gosettings.CopyPointer(h.Enabled),
-		Stealth:           gosettings.CopyPointer(h.Stealth),
-		Log:               gosettings.CopyPointer(h.Log),
-		ReadHeaderTimeout: h.ReadHeaderTimeout,
-		ReadTimeout:       h.ReadTimeout,
-	}
-}
-
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (h *HTTPProxy) mergeWith(other HTTPProxy) {
-	h.User = gosettings.MergeWithPointer(h.User, other.User)
-	h.Password = gosettings.MergeWithPointer(h.Password, other.Password)
-	h.ListeningAddress = gosettings.MergeWithString(h.ListeningAddress, other.ListeningAddress)
-	h.Enabled = gosettings.MergeWithPointer(h.Enabled, other.Enabled)
-	h.Stealth = gosettings.MergeWithPointer(h.Stealth, other.Stealth)
-	h.Log = gosettings.MergeWithPointer(h.Log, other.Log)
-	h.ReadHeaderTimeout = gosettings.MergeWithNumber(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
-	h.ReadTimeout = gosettings.MergeWithNumber(h.ReadTimeout, other.ReadTimeout)
-}
-
-// overrideWith overrides fields of the receiver
-// settings object with any field set in the other
-// settings.
-func (h *HTTPProxy) overrideWith(other HTTPProxy) {
-	h.User = gosettings.OverrideWithPointer(h.User, other.User)
-	h.Password = gosettings.OverrideWithPointer(h.Password, other.Password)
-	h.ListeningAddress = gosettings.OverrideWithString(h.ListeningAddress, other.ListeningAddress)
-	h.Enabled = gosettings.OverrideWithPointer(h.Enabled, other.Enabled)
-	h.Stealth = gosettings.OverrideWithPointer(h.Stealth, other.Stealth)
-	h.Log = gosettings.OverrideWithPointer(h.Log, other.Log)
-	h.ReadHeaderTimeout = gosettings.OverrideWithNumber(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
-	h.ReadTimeout = gosettings.OverrideWithNumber(h.ReadTimeout, other.ReadTimeout)
-}
-
-func (h *HTTPProxy) setDefaults() {
-	h.User = gosettings.DefaultPointer(h.User, "")
-	h.Password = gosettings.DefaultPointer(h.Password, "")
-	h.ListeningAddress = gosettings.DefaultString(h.ListeningAddress, ":8888")
-	h.Enabled = gosettings.DefaultPointer(h.Enabled, false)
-	h.Stealth = gosettings.DefaultPointer(h.Stealth, false)
-	h.Log = gosettings.DefaultPointer(h.Log, false)
-	const defaultReadHeaderTimeout = time.Second
-	h.ReadHeaderTimeout = gosettings.DefaultNumber(h.ReadHeaderTimeout, defaultReadHeaderTimeout)
-	const defaultReadTimeout = 3 * time.Second
-	h.ReadTimeout = gosettings.DefaultNumber(h.ReadTimeout, defaultReadTimeout)
-}
-
-func (h HTTPProxy) String() string {
-	return h.toLinesNode().String()
-}
-
-func (h HTTPProxy) toLinesNode() (node *gotree.Node) {
-	node = gotree.New("HTTP proxy settings:")
-	node.Appendf("Enabled: %s", gosettings.BoolToYesNo(h.Enabled))
-	if !*h.Enabled {
-		return node
-	}
-
-	node.Appendf("Listening address: %s", h.ListeningAddress)
-	node.Appendf("User: %s", *h.User)
-	node.Appendf("Password: %s", gosettings.ObfuscateKey(*h.Password))
-	node.Appendf("Stealth mode: %s", gosettings.BoolToYesNo(h.Stealth))
-	node.Appendf("Log: %s", gosettings.BoolToYesNo(h.Log))
-	node.Appendf("Read header timeout: %s", h.ReadHeaderTimeout)
-	node.Appendf("Read timeout: %s", h.ReadTimeout)
-
-	return node
-}

internal/configuration/settings/log.go

@@ -1,51 +0,0 @@
-package settings
-
-import (
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gotree"
-	"github.com/qdm12/log"
-)
-
-// Log contains settings to configure the logger.
-type Log struct {
-	// Level is the log level of the logger.
-	// It cannot be nil in the internal state.
-	Level *log.Level
-}
-
-func (l Log) validate() (err error) {
-	return nil
-}
-
-func (l *Log) copy() (copied Log) {
-	return Log{
-		Level: gosettings.CopyPointer(l.Level),
-	}
-}
-
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (l *Log) mergeWith(other Log) {
-	l.Level = gosettings.MergeWithPointer(l.Level, other.Level)
-}
-
-// overrideWith overrides fields of the receiver
-// settings object with any field set in the other
-// settings.
-func (l *Log) overrideWith(other Log) {
-	l.Level = gosettings.OverrideWithPointer(l.Level, other.Level)
-}
-
-func (l *Log) setDefaults() {
-	l.Level = gosettings.DefaultPointer(l.Level, log.LevelInfo)
-}
-
-func (l Log) String() string {
-	return l.toLinesNode().String()
-}
-
-func (l Log) toLinesNode() (node *gotree.Node) {
-	node = gotree.New("Log settings:")
-	node.Appendf("Log level: %s", l.Level.String())
-	return node
-}

internal/configuration/settings/netaddr.go

@@ -1,36 +0,0 @@
-package settings
-
-import (
-	"net/netip"
-
-	"inet.af/netaddr"
-)
-
-func netipAddressToNetaddrIP(address netip.Addr) (ip netaddr.IP) {
-	if address.Is4() {
-		return netaddr.IPFrom4(address.As4())
-	}
-	return netaddr.IPFrom16(address.As16())
-}
-
-func netipAddressesToNetaddrIPs(addresses []netip.Addr) (ips []netaddr.IP) {
-	ips = make([]netaddr.IP, len(addresses))
-	for i := range addresses {
-		ips[i] = netipAddressToNetaddrIP(addresses[i])
-	}
-	return ips
-}
-
-func netipPrefixToNetaddrIPPrefix(prefix netip.Prefix) (ipPrefix netaddr.IPPrefix) {
-	netaddrIP := netipAddressToNetaddrIP(prefix.Addr())
-	bits := prefix.Bits()
-	return netaddr.IPPrefixFrom(netaddrIP, uint8(bits))
-}
-
-func netipPrefixesToNetaddrIPPrefixes(prefixes []netip.Prefix) (ipPrefixes []netaddr.IPPrefix) {
-	ipPrefixes = make([]netaddr.IPPrefix, len(prefixes))
-	for i := range ipPrefixes {
-		ipPrefixes[i] = netipPrefixToNetaddrIPPrefix(prefixes[i])
-	}
-	return ipPrefixes
-}

internal/configuration/settings/nordvpn_retro.go

@@ -1,42 +0,0 @@
-package settings
-
-// Retro-compatibility because SERVER_REGIONS changed to SERVER_COUNTRIES
-// and SERVER_REGIONS is now the continent field for servers.
-// TODO v4 remove.
-func nordvpnRetroRegion(selection ServerSelection, validRegions, validCountries []string) (
-	updatedSelection ServerSelection) {
-	validRegionsMap := stringSliceToMap(validRegions)
-	validCountriesMap := stringSliceToMap(validCountries)
-
-	updatedSelection = selection.copy()
-	updatedSelection.Regions = make([]string, 0, len(selection.Regions))
-	for _, region := range selection.Regions {
-		_, isValid := validRegionsMap[region]
-		if isValid {
-			updatedSelection.Regions = append(updatedSelection.Regions, region)
-			continue
-		}
-
-		_, isValid = validCountriesMap[region]
-		if !isValid {
-			// Region is not valid for the country or region
-			// just leave it to the validation to fail it later
-			continue
-		}
-
-		// Region is not valid for a region, but is a valid country
-		// Handle retro-compatibility and transfer the value to the
-		// country field.
-		updatedSelection.Countries = append(updatedSelection.Countries, region)
-	}
-
-	return updatedSelection
-}
-
-func stringSliceToMap(slice []string) (m map[string]struct{}) {
-	m = make(map[string]struct{}, len(slice))
-	for _, s := range slice {
-		m[s] = struct{}{}
-	}
-	return m
-}

internal/configuration/settings/openvpn.go

@@ -1,397 +0,0 @@
-package settings
-
-import (
-	"encoding/base64"
-	"fmt"
-	"regexp"
-
-	"github.com/qdm12/gluetun/internal/constants/openvpn"
-	"github.com/qdm12/gluetun/internal/constants/providers"
-	"github.com/qdm12/gluetun/internal/openvpn/extract"
-	"github.com/qdm12/gluetun/internal/provider/privateinternetaccess/presets"
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gosettings/validate"
-	"github.com/qdm12/gotree"
-)
-
-// OpenVPN contains settings to configure the OpenVPN client.
-type OpenVPN struct {
-	// Version is the OpenVPN version to run.
-	// It can only be "2.5" or "2.6".
-	Version string `json:"version"`
-	// User is the OpenVPN authentication username.
-	// It cannot be nil in the internal state if OpenVPN is used.
-	// It is usually required but in some cases can be the empty string
-	// to indicate no user+password authentication is needed.
-	User *string `json:"user"`
-	// Password is the OpenVPN authentication password.
-	// It cannot be nil in the internal state if OpenVPN is used.
-	// It is usually required but in some cases can be the empty string
-	// to indicate no user+password authentication is needed.
-	Password *string `json:"password"`
-	// ConfFile is a custom OpenVPN configuration file path.
-	// It can be set to the empty string for it to be ignored.
-	// It cannot be nil in the internal state.
-	ConfFile *string `json:"config_file_path"`
-	// Ciphers is a list of ciphers to use for OpenVPN,
-	// different from the ones specified by the VPN
-	// service provider configuration files.
-	Ciphers []string `json:"ciphers"`
-	// Auth is an auth algorithm to use in OpenVPN instead
-	// of the one specified by the VPN service provider.
-	// It cannot be nil in the internal state.
-	// It is ignored if it is set to the empty string.
-	Auth *string `json:"auth"`
-	// Cert is the base64 encoded DER of an OpenVPN certificate for the <cert> block.
-	// This is notably used by Cyberghost and VPN secure.
-	// It can be set to the empty string to be ignored.
-	// It cannot be nil in the internal state.
-	Cert *string `json:"cert"`
-	// Key is the base64 encoded DER of an OpenVPN key.
-	// This is used by Cyberghost and VPN Unlimited.
-	// It can be set to the empty string to be ignored.
-	// It cannot be nil in the internal state.
-	Key *string `json:"key"`
-	// EncryptedKey is the base64 encoded DER of an encrypted key for OpenVPN.
-	// It is used by VPN secure.
-	// It defaults to the empty string meaning it is not
-	// to be used. KeyPassphrase must be set if this one is set.
-	EncryptedKey *string `json:"encrypted_key"`
-	// KeyPassphrase is the key passphrase to be used by OpenVPN
-	// to decrypt the EncryptedPrivateKey. It defaults to the
-	// empty string and must be set if EncryptedPrivateKey is set.
-	KeyPassphrase *string `json:"key_passphrase"`
-	// PIAEncPreset is the encryption preset for
-	// Private Internet Access. It can be set to an
-	// empty string for other providers.
-	PIAEncPreset *string `json:"pia_encryption_preset"`
-	// MSSFix is the value (1 to 10000) to set for the
-	// mssfix option for OpenVPN. It is ignored if set to 0.
-	// It cannot be nil in the internal state.
-	MSSFix *uint16 `json:"mssfix"`
-	// Interface is the OpenVPN device interface name.
-	// It cannot be an empty string in the internal state.
-	Interface string `json:"interface"`
-	// ProcessUser is the OpenVPN process OS username
-	// to use. It cannot be empty in the internal state.
-	// It defaults to 'root'.
-	ProcessUser string `json:"process_user"`
-	// Verbosity is the OpenVPN verbosity level from 0 to 6.
-	// It cannot be nil in the internal state.
-	Verbosity *int `json:"verbosity"`
-	// Flags is a slice of additional flags to be passed
-	// to the OpenVPN program.
-	Flags []string `json:"flags"`
-}
-
-var ivpnAccountID = regexp.MustCompile(`^(i|ivpn)\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}$`)
-
-func (o OpenVPN) validate(vpnProvider string) (err error) {
-	// Validate version
-	validVersions := []string{openvpn.Openvpn25, openvpn.Openvpn26}
-	if err = validate.IsOneOf(o.Version, validVersions...); err != nil {
-		return fmt.Errorf("%w: %w", ErrOpenVPNVersionIsNotValid, err)
-	}
-
-	isCustom := vpnProvider == providers.Custom
-	isUserRequired := !isCustom &&
-		vpnProvider != providers.Airvpn &&
-		vpnProvider != providers.VPNSecure
-
-	if isUserRequired && *o.User == "" {
-		return fmt.Errorf("%w", ErrOpenVPNUserIsEmpty)
-	}
-
-	passwordRequired := isUserRequired &&
-		(vpnProvider != providers.Ivpn || !ivpnAccountID.MatchString(*o.User))
-
-	if passwordRequired && *o.Password == "" {
-		return fmt.Errorf("%w", ErrOpenVPNPasswordIsEmpty)
-	}
-
-	err = validateOpenVPNConfigFilepath(isCustom, *o.ConfFile)
-	if err != nil {
-		return fmt.Errorf("custom configuration file: %w", err)
-	}
-
-	err = validateOpenVPNClientCertificate(vpnProvider, *o.Cert)
-	if err != nil {
-		return fmt.Errorf("client certificate: %w", err)
-	}
-
-	err = validateOpenVPNClientKey(vpnProvider, *o.Key)
-	if err != nil {
-		return fmt.Errorf("client key: %w", err)
-	}
-
-	err = validateOpenVPNEncryptedKey(vpnProvider, *o.EncryptedKey)
-	if err != nil {
-		return fmt.Errorf("encrypted key: %w", err)
-	}
-
-	if *o.EncryptedKey != "" && *o.KeyPassphrase == "" {
-		return fmt.Errorf("%w", ErrOpenVPNKeyPassphraseIsEmpty)
-	}
-
-	const maxMSSFix = 10000
-	if *o.MSSFix > maxMSSFix {
-		return fmt.Errorf("%w: %d is over the maximum value of %d",
-			ErrOpenVPNMSSFixIsTooHigh, *o.MSSFix, maxMSSFix)
-	}
-
-	if !regexpInterfaceName.MatchString(o.Interface) {
-		return fmt.Errorf("%w: '%s' does not match regex '%s'",
-			ErrOpenVPNInterfaceNotValid, o.Interface, regexpInterfaceName)
-	}
-
-	if *o.Verbosity < 0 || *o.Verbosity > 6 {
-		return fmt.Errorf("%w: %d can only be between 0 and 5",
-			ErrOpenVPNVerbosityIsOutOfBounds, o.Verbosity)
-	}
-
-	return nil
-}
-
-func validateOpenVPNConfigFilepath(isCustom bool,
-	confFile string) (err error) {
-	if !isCustom {
-		return nil
-	}
-
-	if confFile == "" {
-		return fmt.Errorf("%w", ErrFilepathMissing)
-	}
-
-	err = validate.FileExists(confFile)
-	if err != nil {
-		return err
-	}
-
-	extractor := extract.New()
-	_, _, err = extractor.Data(confFile)
-	if err != nil {
-		return fmt.Errorf("extracting information from custom configuration file: %w", err)
-	}
-
-	return nil
-}
-
-func validateOpenVPNClientCertificate(vpnProvider,
-	clientCert string) (err error) {
-	switch vpnProvider {
-	case
-		providers.Airvpn,
-		providers.Cyberghost,
-		providers.VPNSecure,
-		providers.VPNUnlimited:
-		if clientCert == "" {
-			return fmt.Errorf("%w", ErrMissingValue)
-		}
-	}
-
-	if clientCert == "" {
-		return nil
-	}
-
-	_, err = base64.StdEncoding.DecodeString(clientCert)
-	if err != nil {
-		return err
-	}
-	return nil
-}
-
-func validateOpenVPNClientKey(vpnProvider, clientKey string) (err error) {
-	switch vpnProvider {
-	case
-		providers.Airvpn,
-		providers.Cyberghost,
-		providers.VPNUnlimited,
-		providers.Wevpn:
-		if clientKey == "" {
-			return fmt.Errorf("%w", ErrMissingValue)
-		}
-	}
-
-	if clientKey == "" {
-		return nil
-	}
-
-	_, err = base64.StdEncoding.DecodeString(clientKey)
-	if err != nil {
-		return err
-	}
-	return nil
-}
-
-func validateOpenVPNEncryptedKey(vpnProvider,
-	encryptedPrivateKey string) (err error) {
-	if vpnProvider == providers.VPNSecure && encryptedPrivateKey == "" {
-		return fmt.Errorf("%w", ErrMissingValue)
-	}
-
-	if encryptedPrivateKey == "" {
-		return nil
-	}
-
-	_, err = base64.StdEncoding.DecodeString(encryptedPrivateKey)
-	if err != nil {
-		return err
-	}
-	return nil
-}
-
-func (o *OpenVPN) copy() (copied OpenVPN) {
-	return OpenVPN{
-		Version:       o.Version,
-		User:          gosettings.CopyPointer(o.User),
-		Password:      gosettings.CopyPointer(o.Password),
-		ConfFile:      gosettings.CopyPointer(o.ConfFile),
-		Ciphers:       gosettings.CopySlice(o.Ciphers),
-		Auth:          gosettings.CopyPointer(o.Auth),
-		Cert:          gosettings.CopyPointer(o.Cert),
-		Key:           gosettings.CopyPointer(o.Key),
-		EncryptedKey:  gosettings.CopyPointer(o.EncryptedKey),
-		KeyPassphrase: gosettings.CopyPointer(o.KeyPassphrase),
-		PIAEncPreset:  gosettings.CopyPointer(o.PIAEncPreset),
-		MSSFix:        gosettings.CopyPointer(o.MSSFix),
-		Interface:     o.Interface,
-		ProcessUser:   o.ProcessUser,
-		Verbosity:     gosettings.CopyPointer(o.Verbosity),
-		Flags:         gosettings.CopySlice(o.Flags),
-	}
-}
-
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (o *OpenVPN) mergeWith(other OpenVPN) {
-	o.Version = gosettings.MergeWithString(o.Version, other.Version)
-	o.User = gosettings.MergeWithPointer(o.User, other.User)
-	o.Password = gosettings.MergeWithPointer(o.Password, other.Password)
-	o.ConfFile = gosettings.MergeWithPointer(o.ConfFile, other.ConfFile)
-	o.Ciphers = gosettings.MergeWithSlice(o.Ciphers, other.Ciphers)
-	o.Auth = gosettings.MergeWithPointer(o.Auth, other.Auth)
-	o.Cert = gosettings.MergeWithPointer(o.Cert, other.Cert)
-	o.Key = gosettings.MergeWithPointer(o.Key, other.Key)
-	o.EncryptedKey = gosettings.MergeWithPointer(o.EncryptedKey, other.EncryptedKey)
-	o.KeyPassphrase = gosettings.MergeWithPointer(o.KeyPassphrase, other.KeyPassphrase)
-	o.PIAEncPreset = gosettings.MergeWithPointer(o.PIAEncPreset, other.PIAEncPreset)
-	o.MSSFix = gosettings.MergeWithPointer(o.MSSFix, other.MSSFix)
-	o.Interface = gosettings.MergeWithString(o.Interface, other.Interface)
-	o.ProcessUser = gosettings.MergeWithString(o.ProcessUser, other.ProcessUser)
-	o.Verbosity = gosettings.MergeWithPointer(o.Verbosity, other.Verbosity)
-	o.Flags = gosettings.MergeWithSlice(o.Flags, other.Flags)
-}
-
-// overrideWith overrides fields of the receiver
-// settings object with any field set in the other
-// settings.
-func (o *OpenVPN) overrideWith(other OpenVPN) {
-	o.Version = gosettings.OverrideWithString(o.Version, other.Version)
-	o.User = gosettings.OverrideWithPointer(o.User, other.User)
-	o.Password = gosettings.OverrideWithPointer(o.Password, other.Password)
-	o.ConfFile = gosettings.OverrideWithPointer(o.ConfFile, other.ConfFile)
-	o.Ciphers = gosettings.OverrideWithSlice(o.Ciphers, other.Ciphers)
-	o.Auth = gosettings.OverrideWithPointer(o.Auth, other.Auth)
-	o.Cert = gosettings.OverrideWithPointer(o.Cert, other.Cert)
-	o.Key = gosettings.OverrideWithPointer(o.Key, other.Key)
-	o.EncryptedKey = gosettings.OverrideWithPointer(o.EncryptedKey, other.EncryptedKey)
-	o.KeyPassphrase = gosettings.OverrideWithPointer(o.KeyPassphrase, other.KeyPassphrase)
-	o.PIAEncPreset = gosettings.OverrideWithPointer(o.PIAEncPreset, other.PIAEncPreset)
-	o.MSSFix = gosettings.OverrideWithPointer(o.MSSFix, other.MSSFix)
-	o.Interface = gosettings.OverrideWithString(o.Interface, other.Interface)
-	o.ProcessUser = gosettings.OverrideWithString(o.ProcessUser, other.ProcessUser)
-	o.Verbosity = gosettings.OverrideWithPointer(o.Verbosity, other.Verbosity)
-	o.Flags = gosettings.OverrideWithSlice(o.Flags, other.Flags)
-}
-
-func (o *OpenVPN) setDefaults(vpnProvider string) {
-	o.Version = gosettings.DefaultString(o.Version, openvpn.Openvpn25)
-	o.User = gosettings.DefaultPointer(o.User, "")
-	if vpnProvider == providers.Mullvad {
-		o.Password = gosettings.DefaultPointer(o.Password, "m")
-	} else {
-		o.Password = gosettings.DefaultPointer(o.Password, "")
-	}
-
-	o.ConfFile = gosettings.DefaultPointer(o.ConfFile, "")
-	o.Auth = gosettings.DefaultPointer(o.Auth, "")
-	o.Cert = gosettings.DefaultPointer(o.Cert, "")
-	o.Key = gosettings.DefaultPointer(o.Key, "")
-	o.EncryptedKey = gosettings.DefaultPointer(o.EncryptedKey, "")
-	o.KeyPassphrase = gosettings.DefaultPointer(o.KeyPassphrase, "")
-
-	var defaultEncPreset string
-	if vpnProvider == providers.PrivateInternetAccess {
-		defaultEncPreset = presets.Strong
-	}
-	o.PIAEncPreset = gosettings.DefaultPointer(o.PIAEncPreset, defaultEncPreset)
-	o.MSSFix = gosettings.DefaultPointer(o.MSSFix, 0)
-	o.Interface = gosettings.DefaultString(o.Interface, "tun0")
-	o.ProcessUser = gosettings.DefaultString(o.ProcessUser, "root")
-	o.Verbosity = gosettings.DefaultPointer(o.Verbosity, 1)
-}
-
-func (o OpenVPN) String() string {
-	return o.toLinesNode().String()
-}
-
-func (o OpenVPN) toLinesNode() (node *gotree.Node) {
-	node = gotree.New("OpenVPN settings:")
-	node.Appendf("OpenVPN version: %s", o.Version)
-	node.Appendf("User: %s", gosettings.ObfuscateKey(*o.User))
-	node.Appendf("Password: %s", gosettings.ObfuscateKey(*o.Password))
-
-	if *o.ConfFile != "" {
-		node.Appendf("Custom configuration file: %s", *o.ConfFile)
-	}
-
-	if len(o.Ciphers) > 0 {
-		node.Appendf("Ciphers: %s", o.Ciphers)
-	}
-
-	if *o.Auth != "" {
-		node.Appendf("Auth: %s", *o.Auth)
-	}
-
-	if *o.Cert != "" {
-		node.Appendf("Client crt: %s", gosettings.ObfuscateKey(*o.Cert))
-	}
-
-	if *o.Key != "" {
-		node.Appendf("Client key: %s", gosettings.ObfuscateKey(*o.Key))
-	}
-
-	if *o.EncryptedKey != "" {
-		node.Appendf("Encrypted key: %s (key passhrapse %s)",
-			gosettings.ObfuscateKey(*o.EncryptedKey), gosettings.ObfuscateKey(*o.KeyPassphrase))
-	}
-
-	if *o.PIAEncPreset != "" {
-		node.Appendf("Private Internet Access encryption preset: %s", *o.PIAEncPreset)
-	}
-
-	if *o.MSSFix > 0 {
-		node.Appendf("MSS Fix: %d", *o.MSSFix)
-	}
-
-	if o.Interface != "" {
-		node.Appendf("Network interface: %s", o.Interface)
-	}
-
-	node.Appendf("Run OpenVPN as: %s", o.ProcessUser)
-
-	node.Appendf("Verbosity level: %d", *o.Verbosity)
-
-	if len(o.Flags) > 0 {
-		node.Appendf("Flags: %s", o.Flags)
-	}
-
-	return node
-}
-
-// WithDefaults is a shorthand using setDefaults.
-// It's used in unit tests in other packages.
-func (o OpenVPN) WithDefaults(provider string) OpenVPN {
-	o.setDefaults(provider)
-	return o
-}

internal/configuration/settings/openvpn_test.go

@@ -1,44 +0,0 @@
-package settings
-
-import (
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-)
-
-func Test_ivpnAccountID(t *testing.T) {
-	t.Parallel()
-
-	testCases := []struct {
-		s     string
-		match bool
-	}{
-		{},
-		{s: "abc"},
-		{s: "i"},
-		{s: "ivpn"},
-		{s: "ivpn-aaaa"},
-		{s: "ivpn-aaaa-aaaa"},
-		{s: "ivpn-aaaa-aaaa-aaa"},
-		{s: "ivpn-aaaa-aaaa-aaaa", match: true},
-		{s: "ivpn-aaaa-aaaa-aaaaa"},
-		{s: "ivpn-a6B7-fP91-Zh6Y", match: true},
-		{s: "i-aaaa"},
-		{s: "i-aaaa-aaaa"},
-		{s: "i-aaaa-aaaa-aaa"},
-		{s: "i-aaaa-aaaa-aaaa", match: true},
-		{s: "i-aaaa-aaaa-aaaaa"},
-		{s: "i-a6B7-fP91-Zh6Y", match: true},
-	}
-
-	for _, testCase := range testCases {
-		testCase := testCase
-		t.Run(testCase.s, func(t *testing.T) {
-			t.Parallel()
-
-			match := ivpnAccountID.MatchString(testCase.s)
-
-			assert.Equal(t, testCase.match, match)
-		})
-	}
-}

internal/configuration/settings/openvpnselection.go

@@ -1,188 +0,0 @@
-package settings
-
-import (
-	"fmt"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
-	"github.com/qdm12/gluetun/internal/constants/providers"
-	"github.com/qdm12/gluetun/internal/provider/privateinternetaccess/presets"
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gosettings/validate"
-	"github.com/qdm12/gotree"
-)
-
-type OpenVPNSelection struct {
-	// ConfFile is the custom configuration file path.
-	// It can be set to an empty string to indicate to
-	// NOT use a custom configuration file.
-	// It cannot be nil in the internal state.
-	ConfFile *string `json:"config_file_path"`
-	// TCP is true if the OpenVPN protocol is TCP,
-	// and false for UDP.
-	// It cannot be nil in the internal state.
-	TCP *bool `json:"tcp"`
-	// CustomPort is the OpenVPN server endpoint port.
-	// It can be set to 0 to indicate no custom port should
-	// be used. It cannot be nil in the internal state.
-	CustomPort *uint16 `json:"custom_port"`
-	// PIAEncPreset is the encryption preset for
-	// Private Internet Access. It can be set to an
-	// empty string for other providers.
-	PIAEncPreset *string `json:"pia_encryption_preset"`
-}
-
-func (o OpenVPNSelection) validate(vpnProvider string) (err error) {
-	// Validate ConfFile
-	if confFile := *o.ConfFile; confFile != "" {
-		err := validate.FileExists(confFile)
-		if err != nil {
-			return fmt.Errorf("configuration file: %w", err)
-		}
-	}
-
-	// Validate TCP
-	if *o.TCP && helpers.IsOneOf(vpnProvider,
-		providers.Ipvanish,
-		providers.Perfectprivacy,
-		providers.Privado,
-		providers.Vyprvpn,
-	) {
-		return fmt.Errorf("%w: for VPN service provider %s",
-			ErrOpenVPNTCPNotSupported, vpnProvider)
-	}
-
-	// Validate CustomPort
-	if *o.CustomPort != 0 {
-		switch vpnProvider {
-		// no restriction on port
-		case providers.Custom, providers.Cyberghost, providers.HideMyAss,
-			providers.Privatevpn, providers.Torguard:
-		// no custom port allowed
-		case providers.Expressvpn, providers.Fastestvpn,
-			providers.Ipvanish, providers.Nordvpn,
-			providers.Privado, providers.Purevpn,
-			providers.Surfshark, providers.VPNSecure,
-			providers.VPNUnlimited, providers.Vyprvpn:
-			return fmt.Errorf("%w: for VPN service provider %s",
-				ErrOpenVPNCustomPortNotAllowed, vpnProvider)
-		default:
-			var allowedTCP, allowedUDP []uint16
-			switch vpnProvider {
-			case providers.Airvpn:
-				allowedTCP = []uint16{
-					53, 80, 443, // IP in 1, 3
-					1194, 2018, 41185, // IP in 1, 2, 3, 4
-				}
-				allowedUDP = []uint16{53, 80, 443, 1194, 2018, 41185}
-			case providers.Ivpn:
-				allowedTCP = []uint16{80, 443, 1143}
-				allowedUDP = []uint16{53, 1194, 2049, 2050}
-			case providers.Mullvad:
-				allowedTCP = []uint16{80, 443, 1401}
-				allowedUDP = []uint16{53, 1194, 1195, 1196, 1197, 1300, 1301, 1302, 1303, 1400}
-			case providers.Perfectprivacy:
-				allowedTCP = []uint16{44, 443, 4433}
-				allowedUDP = []uint16{44, 443, 4433}
-			case providers.PrivateInternetAccess:
-				allowedTCP = []uint16{80, 110, 443}
-				allowedUDP = []uint16{53, 1194, 1197, 1198, 8080, 9201}
-			case providers.Protonvpn:
-				allowedTCP = []uint16{443, 5995, 8443}
-				allowedUDP = []uint16{80, 443, 1194, 4569, 5060}
-			case providers.SlickVPN:
-				allowedTCP = []uint16{443, 8080, 8888}
-				allowedUDP = []uint16{443, 8080, 8888}
-			case providers.Wevpn:
-				allowedTCP = []uint16{53, 1195, 1199, 2018}
-				allowedUDP = []uint16{80, 1194, 1198}
-			case providers.Windscribe:
-				allowedTCP = []uint16{21, 22, 80, 123, 143, 443, 587, 1194, 3306, 8080, 54783}
-				allowedUDP = []uint16{53, 80, 123, 443, 1194, 54783}
-			default:
-				panic(fmt.Sprintf("VPN provider %s has no registered allowed ports", vpnProvider))
-			}
-
-			allowedPorts := allowedUDP
-			if *o.TCP {
-				allowedPorts = allowedTCP
-			}
-			err = validate.IsOneOf(*o.CustomPort, allowedPorts...)
-			if err != nil {
-				return fmt.Errorf("%w: for VPN service provider %s: %w",
-					ErrOpenVPNCustomPortNotAllowed, vpnProvider, err)
-			}
-		}
-	}
-
-	// Validate EncPreset
-	if vpnProvider == providers.PrivateInternetAccess {
-		validEncryptionPresets := []string{
-			presets.None,
-			presets.Normal,
-			presets.Strong,
-		}
-		if err = validate.IsOneOf(*o.PIAEncPreset, validEncryptionPresets...); err != nil {
-			return fmt.Errorf("%w: %w", ErrOpenVPNEncryptionPresetNotValid, err)
-		}
-	}
-
-	return nil
-}
-
-func (o *OpenVPNSelection) copy() (copied OpenVPNSelection) {
-	return OpenVPNSelection{
-		ConfFile:     gosettings.CopyPointer(o.ConfFile),
-		TCP:          gosettings.CopyPointer(o.TCP),
-		CustomPort:   gosettings.CopyPointer(o.CustomPort),
-		PIAEncPreset: gosettings.CopyPointer(o.PIAEncPreset),
-	}
-}
-
-func (o *OpenVPNSelection) mergeWith(other OpenVPNSelection) {
-	o.ConfFile = gosettings.MergeWithPointer(o.ConfFile, other.ConfFile)
-	o.TCP = gosettings.MergeWithPointer(o.TCP, other.TCP)
-	o.CustomPort = gosettings.MergeWithPointer(o.CustomPort, other.CustomPort)
-	o.PIAEncPreset = gosettings.MergeWithPointer(o.PIAEncPreset, other.PIAEncPreset)
-}
-
-func (o *OpenVPNSelection) overrideWith(other OpenVPNSelection) {
-	o.ConfFile = gosettings.OverrideWithPointer(o.ConfFile, other.ConfFile)
-	o.TCP = gosettings.OverrideWithPointer(o.TCP, other.TCP)
-	o.CustomPort = gosettings.OverrideWithPointer(o.CustomPort, other.CustomPort)
-	o.PIAEncPreset = gosettings.OverrideWithPointer(o.PIAEncPreset, other.PIAEncPreset)
-}
-
-func (o *OpenVPNSelection) setDefaults(vpnProvider string) {
-	o.ConfFile = gosettings.DefaultPointer(o.ConfFile, "")
-	o.TCP = gosettings.DefaultPointer(o.TCP, false)
-	o.CustomPort = gosettings.DefaultPointer(o.CustomPort, 0)
-
-	var defaultEncPreset string
-	if vpnProvider == providers.PrivateInternetAccess {
-		defaultEncPreset = presets.Strong
-	}
-	o.PIAEncPreset = gosettings.DefaultPointer(o.PIAEncPreset, defaultEncPreset)
-}
-
-func (o OpenVPNSelection) String() string {
-	return o.toLinesNode().String()
-}
-
-func (o OpenVPNSelection) toLinesNode() (node *gotree.Node) {
-	node = gotree.New("OpenVPN server selection settings:")
-	node.Appendf("Protocol: %s", helpers.TCPPtrToString(o.TCP))
-
-	if *o.CustomPort != 0 {
-		node.Appendf("Custom port: %d", *o.CustomPort)
-	}
-
-	if *o.PIAEncPreset != "" {
-		node.Appendf("Private Internet Access encryption preset: %s", *o.PIAEncPreset)
-	}
-
-	if *o.ConfFile != "" {
-		node.Appendf("Custom configuration file: %s", *o.ConfFile)
-	}
-
-	return node
-}

internal/configuration/settings/portforward.go

@@ -1,126 +0,0 @@
-package settings
-
-import (
-	"fmt"
-	"path/filepath"
-
-	"github.com/qdm12/gluetun/internal/constants/providers"
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gosettings/validate"
-	"github.com/qdm12/gotree"
-)
-
-// PortForwarding contains settings for port forwarding.
-type PortForwarding struct {
-	// Enabled is true if port forwarding should be activated.
-	// It cannot be nil for the internal state.
-	Enabled *bool `json:"enabled"`
-	// Provider is set to specify which custom port forwarding code
-	// should be used. This is especially necessary for the custom
-	// provider using Wireguard for a provider where Wireguard is not
-	// natively supported but custom port forwading code is available.
-	// It defaults to the empty string, meaning the current provider
-	// should be the one used for port forwarding.
-	// It cannot be nil for the internal state.
-	Provider *string `json:"provider"`
-	// Filepath is the port forwarding status file path
-	// to use. It can be the empty string to indicate not
-	// to write to a file. It cannot be nil for the
-	// internal state
-	Filepath *string `json:"status_file_path"`
-	// ListeningPort is the port traffic would be redirected to from the
-	// forwarded port. The redirection is disabled if it is set to 0, which
-	// is its default as well.
-	ListeningPort *uint16 `json:"listening_port"`
-}
-
-func (p PortForwarding) Validate(vpnProvider string) (err error) {
-	if !*p.Enabled {
-		return nil
-	}
-
-	// Validate current provider or custom provider specified
-	providerSelected := vpnProvider
-	if *p.Provider != "" {
-		providerSelected = *p.Provider
-	}
-	validProviders := []string{
-		providers.PrivateInternetAccess,
-		providers.Protonvpn,
-	}
-	if err = validate.IsOneOf(providerSelected, validProviders...); err != nil {
-		return fmt.Errorf("%w: %w", ErrPortForwardingEnabled, err)
-	}
-
-	// Validate Filepath
-	if *p.Filepath != "" { // optional
-		_, err := filepath.Abs(*p.Filepath)
-		if err != nil {
-			return fmt.Errorf("filepath is not valid: %w", err)
-		}
-	}
-
-	return nil
-}
-
-func (p *PortForwarding) Copy() (copied PortForwarding) {
-	return PortForwarding{
-		Enabled:       gosettings.CopyPointer(p.Enabled),
-		Provider:      gosettings.CopyPointer(p.Provider),
-		Filepath:      gosettings.CopyPointer(p.Filepath),
-		ListeningPort: gosettings.CopyPointer(p.ListeningPort),
-	}
-}
-
-func (p *PortForwarding) mergeWith(other PortForwarding) {
-	p.Enabled = gosettings.MergeWithPointer(p.Enabled, other.Enabled)
-	p.Provider = gosettings.MergeWithPointer(p.Provider, other.Provider)
-	p.Filepath = gosettings.MergeWithPointer(p.Filepath, other.Filepath)
-	p.ListeningPort = gosettings.MergeWithPointer(p.ListeningPort, other.ListeningPort)
-}
-
-func (p *PortForwarding) OverrideWith(other PortForwarding) {
-	p.Enabled = gosettings.OverrideWithPointer(p.Enabled, other.Enabled)
-	p.Provider = gosettings.OverrideWithPointer(p.Provider, other.Provider)
-	p.Filepath = gosettings.OverrideWithPointer(p.Filepath, other.Filepath)
-	p.ListeningPort = gosettings.OverrideWithPointer(p.ListeningPort, other.ListeningPort)
-}
-
-func (p *PortForwarding) setDefaults() {
-	p.Enabled = gosettings.DefaultPointer(p.Enabled, false)
-	p.Provider = gosettings.DefaultPointer(p.Provider, "")
-	p.Filepath = gosettings.DefaultPointer(p.Filepath, "/tmp/gluetun/forwarded_port")
-	p.ListeningPort = gosettings.DefaultPointer(p.ListeningPort, 0)
-}
-
-func (p PortForwarding) String() string {
-	return p.toLinesNode().String()
-}
-
-func (p PortForwarding) toLinesNode() (node *gotree.Node) {
-	if !*p.Enabled {
-		return nil
-	}
-
-	node = gotree.New("Automatic port forwarding settings:")
-
-	listeningPort := "disabled"
-	if *p.ListeningPort != 0 {
-		listeningPort = fmt.Sprintf("%d", *p.ListeningPort)
-	}
-	node.Appendf("Redirection listening port: %s", listeningPort)
-
-	if *p.Provider == "" {
-		node.Appendf("Use port forwarding code for current provider")
-	} else {
-		node.Appendf("Use code for provider: %s", *p.Provider)
-	}
-
-	filepath := *p.Filepath
-	if filepath == "" {
-		filepath = "[not set]"
-	}
-	node.Appendf("Forwarded port file path: %s", filepath)
-
-	return node
-}