Chore(deps): Bump peter-evans/dockerhub-description from 4 to 5

Bumps [peter-evans/dockerhub-description](https://github.com/peter-evans/dockerhub-description) from 4 to 5.
- [Release notes](https://github.com/peter-evans/dockerhub-description/releases)
- [Commits](https://github.com/peter-evans/dockerhub-description/compare/v4...v5)

---
updated-dependencies:
- dependency-name: peter-evans/dockerhub-description
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

.devcontainer/.dockerignore

@@ -1,5 +1,4 @@
 .dockerignore
 devcontainer.json
-docker-compose.yml
 Dockerfile
 README.md

.devcontainer/Dockerfile

@@ -1 +1,2 @@
-FROM qmcgaw/godevcontainer
+FROM ghcr.io/qdm12/godevcontainer:v0.21-alpine
+RUN apk add wireguard-tools htop openssl

.devcontainer/README.md

@@ -2,67 +2,47 @@
 
 Development container that can be used with VSCode.
 
-It works on Linux, Windows and OSX.
+It works on Linux, Windows (WSL2) and OSX.
 
 ## Requirements
 
 - [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
+- [VS code dev 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 and directory on your host if you don't have them:
+
+    ```sh
+    touch ~/.gitconfig ~/.zsh_history
+    mkdir -p ~/.ssh
+    ```
+
+1. **For OSX hosts**: ensure the project directory and your home directory `~` are 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. Select `Dev-Containers: Open Folder in Container...` and choose the project directory.
 
 ## Customization
 
-### Customize the image
+For any customization to take effect, you should "rebuild and reopen":
 
-You can make changes to the [Dockerfile](Dockerfile) and then rebuild the image. For example, your Dockerfile could be:
+1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P)
+2. Select `Dev-Containers: Rebuild Container`
 
-```Dockerfile
+Changes you can make are notably:
-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`.
+- Changes to the Docker image in [Dockerfile](Dockerfile)
+- Changes to VSCode **settings** and **extensions** in [devcontainer.json](devcontainer.json).
+- Change the entrypoint script by adding a bind mount in [devcontainer.json](devcontainer.json) of a shell script to `/root/.welcome.sh` to replace the [current welcome script](https://github.com/qdm12/godevcontainer/blob/master/shell/.welcome.sh). For example:
 
-To rebuild the image, either:
+    ```json
-
+    // Welcome script
-- With VSCode through the command palette, select `Remote-Containers: Rebuild and reopen in container`
+    {
-- With a terminal, go to this directory and `docker-compose build`
+        "source": "/yourpath/.welcome.sh",
-
+        "target": "/root/.welcome.sh",
-### Customize VS code settings
+        "type": "bind"
-
+    },
-You can customize **settings** and **extensions** in the [devcontainer.json](devcontainer.json) definition file.
-
-### Entrypoint script
-
-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).
-
-### Run other services
-
-1. Modify [docker-compose.yml](docker-compose.yml) to launch other services at the same time as this development container, such as a test database:
-
-    ```yml
-      database:
-        image: postgres
-        restart: always
-        environment:
-          POSTGRES_PASSWORD: password
     ```
 
-1. In [devcontainer.json](devcontainer.json), change the line `"runServices": ["vscode"],` to `"runServices": ["vscode", "database"],`.
+- More options are documented in the [devcontainer.json reference](https://containers.dev/implementors/json_reference/).
-1. In the VS code command palette, rebuild the container.

.devcontainer/devcontainer.json

@@ -1,70 +1,111 @@
-{
+{
-    "name": "gluetun-dev",
+    "name": "gluetun-dev",
-    "dockerComposeFile": [
+    // User defined settings
-        "docker-compose.yml"
+    "containerEnv": {
-    ],
+        "TZ": ""
-    "service": "vscode",
+    },
-    "runServices": [
+    // Fixed settings
-        "vscode"
+    "build": {
-    ],
+        "dockerfile": "./Dockerfile"
-    "shutdownAction": "stopCompose",
+    },
-    "postCreateCommand": "go mod download",
+    "postCreateCommand": "~/.windows.sh && go mod download",
-    "workspaceFolder": "/workspace",
+    "capAdd": [
-    "extensions": [
+        "NET_ADMIN", // Gluetun specific
-        "golang.go",
+        "SYS_PTRACE" // for dlv Go debugging
-        "eamodio.gitlens", // IDE Git information
+    ],
-        "davidanson.vscode-markdownlint",
+    "securityOpt": [
-        "ms-azuretools.vscode-docker", // Docker integration and linting
+        "seccomp=unconfined" // for dlv Go debugging
-        "shardulm94.trailing-spaces", // Show trailing spaces
+    ],
-        "Gruntfuggly.todo-tree", // Highlights TODO comments
+    "mounts": [
-        "bierner.emojisense", // Emoji sense for markdown
+        // Zsh commands history persistence
-        "stkb.rewrap", // rewrap comments after n characters on one line
+        {
-        "vscode-icons-team.vscode-icons", // Better file extension icons
+            "source": "${localEnv:HOME}/.zsh_history",
-        "github.vscode-pull-request-github", // Github interaction
+            "target": "/root/.zsh_history",
-        "redhat.vscode-yaml", // Kubernetes, Drone syntax highlighting
+            "type": "bind"
-        "bajdzis.vscode-database", // Supports connections to mysql or postgres, over SSL, socked
+        },
-        "IBM.output-colorizer", // Colorize your output/test logs
+        // Git configuration file
-        "mohsen1.prettify-json", // Prettify JSON data
+        {
-    ],
+            "source": "${localEnv:HOME}/.gitconfig",
-    "settings": {
+            "target": "/root/.gitconfig",
-        "files.eol": "\n",
+            "type": "bind"
-        "remote.extensionKind": {
+        },
-            "ms-azuretools.vscode-docker": "workspace"
+        // SSH directory for Linux, OSX and WSL
-        },
+        // On Linux and OSX, a symlink /mnt/ssh <-> ~/.ssh is
-        "go.useLanguageServer": true,
+        // created in the container. On Windows, files are copied
-        "go.autocompleteUnimportedPackages": true,
+        // from /mnt/ssh to ~/.ssh to fix permissions.
-        "go.gotoSymbol.includeImports": true,
+        {
-        "go.gotoSymbol.includeGoroot": true,
+            "source": "${localEnv:HOME}/.ssh",
-        "gopls": {
+            "target": "/mnt/ssh",
-            "completeUnimported": true,
+            "type": "bind"
-            "deepCompletion": true,
+        },
-            "usePlaceholders": false
+        // Docker socket to access the host Docker server
-        },
+        {
-        "go.lintTool": "golangci-lint",
+            "source": "/var/run/docker.sock",
-        "go.buildOnSave": "workspace",
+            "target": "/var/run/docker.sock",
-        "go.lintOnSave": "workspace",
+            "type": "bind"
-        "go.vetOnSave": "workspace",
+        }
-        "editor.formatOnSave": true,
+    ],
-        "[go]": {
+    "customizations": {
-            "editor.codeActionsOnSave": {
+        "vscode": {
-                "source.organizeImports": true
+            "extensions": [
-            }
+                "golang.go",
-        },
+                "eamodio.gitlens", // IDE Git information
-        "go.toolsEnvVars": {
+                "davidanson.vscode-markdownlint",
-            "GOFLAGS": "-tags=",
+                "ms-azuretools.vscode-docker", // Docker integration and linting
-            // "CGO_ENABLED": 1 // for the race detector
+                "shardulm94.trailing-spaces", // Show trailing spaces
-        },
+                "Gruntfuggly.todo-tree", // Highlights TODO comments
-        "gopls.env": {
+                "bierner.emojisense", // Emoji sense for markdown
-            "GOFLAGS": "-tags="
+                "stkb.rewrap", // rewrap comments after n characters on one line
-        },
+                "vscode-icons-team.vscode-icons", // Better file extension icons
-        "go.testEnvVars": {},
+                "github.vscode-pull-request-github", // Github interaction
-        "go.testFlags": [
+                "redhat.vscode-yaml", // Kubernetes, Drone syntax highlighting
-            "-v",
+                "bajdzis.vscode-database", // Supports connections to mysql or postgres, over SSL, socked
-            // "-race"
+                "IBM.output-colorizer", // Colorize your output/test logs
-        ],
+                "github.copilot" // AI code completion
-        "go.testTimeout": "10s",
+            ],
-        "go.coverOnSingleTest": true,
+            "settings": {
-        "go.coverOnSingleTestFile": true,
+                "files.eol": "\n",
-        "go.coverOnTestPackage": true
+                "remote.extensionKind": {
-    }
+                    "ms-azuretools.vscode-docker": "workspace"
+                },
+                "go.useLanguageServer": true,
+                "[go]": {
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": "explicit"
+                    }
+                },
+                "[go.mod]": {
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": "explicit"
+                    }
+                },
+                "gopls": {
+                    "usePlaceholders": false,
+                    "staticcheck": true,
+                    "ui.diagnostic.analyses": {
+                        "ST1000": false
+                    },
+                    "formatting.gofumpt": true,
+                },
+                "go.lintTool": "golangci-lint",
+                "go.lintOnSave": "package",
+                "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
+            }
+        }
+    }
 }

.devcontainer/docker-compose.yml

@@ -1,25 +0,0 @@
-version: "3.7"
-
-services:
-  vscode:
-    build: .
-    image: godevcontainer
-    volumes:
-      - ../:/workspace
-      # Docker socket to access Docker server
-      - /var/run/docker.sock:/var/run/docker.sock
-      # SSH directory
-      - ~/.ssh:/home/vscode/.ssh
-      - ~/.ssh:/root/.ssh
-      # Git config
-      - ~/.gitconfig:/home/districter/.gitconfig
-      - ~/.gitconfig:/root/.gitconfig
-    environment:
-      - TZ=
-    cap_add:
-      # For debugging with dlv
-      - SYS_PTRACE
-    security_opt:
-      # For debugging with dlv
-      - seccomp:unconfined
-    entrypoint: zsh -c "while sleep 1000; do :; done"

.dockerignore

@@ -1,10 +1,9 @@
 .devcontainer
 .git
 .github
-cmd
-!cmd/gluetun
 doc
 docker-compose.yml
+Dockerfile
 LICENSE
 README.md
 title.svg

.github/CONTRIBUTING.md

@@ -13,17 +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)
 - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
-
-## Contributors
-
-Thanks for all the contributions, whether small or not so small!
-
-- [@JeordyR](https://github.com/JeordyR) for testing the Mullvad version and opening a [PR with a few fixes](https://github.com/qdm12/gluetun/pull/84/files) 👍
-- [@rorph](https://github.com/rorph) for a [PR to pick a random region for PIA](https://github.com/qdm12/gluetun/pull/70) and a [PR to make the container work with kubernetes](https://github.com/qdm12/gluetun/pull/69)
-- [@JesterEE](https://github.com/JesterEE) for a [PR to fix silly line endings in block lists back then](https://github.com/qdm12/gluetun/pull/55) 📎
-- [@elmerfdz](https://github.com/elmerfdz) for a [PR to add timezone information to have correct log timestampts](https://github.com/qdm12/gluetun/pull/51) 🕙
-- [@Juggels](https://github.com/Juggels) for a [PR to write the PIA forwarded port to a file](https://github.com/qdm12/gluetun/pull/43)
-- [@gdlx](https://github.com/gdlx) for a [PR to fix and improve PIA port forwarding script](https://github.com/qdm12/gluetun/pull/32)
-- [@janaz](https://github.com/janaz) for keeping an eye on [updating things in the Dockerfile](https://github.com/qdm12/gluetun/pull/8)

.github/ISSUE_TEMPLATE/bug.md

@@ -1,37 +0,0 @@
----
-name: Bug
-about: Report a bug
-title: 'Bug: FILL THIS TEXT!'
-labels: ":bug: bug"
-assignees: qdm12
-
----
-
-**Host OS** (approximate answer is fine too): Ubuntu 18
-
-**Is this urgent?**: No
-
-**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 i.e. token information with PIA port forwarding*
-
-```log
-
-PASTE YOUR LOGS
-IN THERE
-
-```

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,117 @@
+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
+        - Giganews
+        - 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

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Report a Wiki issue
+    url: https://github.com/qdm12/gluetun-wiki/issues/new/choose
+    about: Please create an issue on the gluetun-wiki repository.
+  - name: Configuration help?
+    url: https://github.com/qdm12/gluetun/discussions/new/choose
+    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

@@ -1,17 +0,0 @@
----
-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

@@ -0,0 +1,19 @@
+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

@@ -1,53 +0,0 @@
----
-name: Help
-about: Ask for help
-title: 'Help: FILL THIS TEXT!'
-labels: ":pray: help wanted"
-assignees:
-
----
-
-**Host OS** (approximate answer is fine too): Ubuntu 18
-
-**Is this urgent?**: No
-
-**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 i.e. token information with PIA port forwarding*
-
-```log
-
-PASTE YOUR LOGS
-IN THERE
-
-```
-
-**What are you using to run your container?**: Docker Compose
-
-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

@@ -0,0 +1,17 @@
+---
+name: Support a VPN provider
+about: Suggest a VPN provider to be supported
+title: 'VPN provider support: NAME OF THE PROVIDER'
+labels: ":bulb: New provider"
+
+---
+
+One of the following is required:
+
+- Publicly accessible URL to a zip file containing the Openvpn configuration files
+- Publicly accessible URL to a structured (JSON etc.) list of servers **and attach** an example Openvpn configuration file for both TCP and UDP
+- Publicly accessible URL to the list of servers **and attach** an example Openvpn configuration file for both TCP and UDP
+
+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.

.github/dependabot.yml

@@ -5,3 +5,11 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+  - package-ecosystem: docker
+    directory: /
+    schedule:
+      interval: "daily"
+  - package-ecosystem: gomod
+    directory: /
+    schedule:
+      interval: "daily"

.github/labels.yml

@@ -1,67 +1,152 @@
-- name: "Bug :bug:"
+- name: "Status: 🗯️ Waiting for feedback"
-  color: "b60205"
+  color: "f7d692"
-  description: ""
+- name: "Status: 🔴 Blocked"
-- name: "Feature request :bulb:"
+  color: "f7d692"
-  color: "0e8a16"
+  description: "Blocked by another issue or pull request"
-  description: ""
+- name: "Status: 📌 Before next release"
-- name: "Help wanted :pray:"
+  color: "f7d692"
-  color: "4caf50"
+  description: "Has to be done before the next release"
-  description: ""
+- name: "Status: 🔒 After next release"
-- name: "Documentation :memo:"
+  color: "f7d692"
-  color: "c5def5"
+  description: "Will be done after the next release"
-  description: ""
+- name: "Status: 🟡 Nearly resolved"
-- name: "Needs more info :thinking:"
+  color: "f7d692"
-  color: "795548"
+  description: "This might be resolved or is about to be resolved"
-  description: ""
+
+- name: "Closed: ⚰️ Inactive"
+  color: "959a9c"
+  description: "No answer was received for weeks"
+- name: "Closed: 👥 Duplicate"
+  color: "959a9c"
+  description: "Issue duplicates an existing issue"
+- name: "Closed: 🗑️ Bad issue"
+  color: "959a9c"
+- name: "Closed: ☠️ cannot be done"
+  color: "959a9c"
+
+- name: "Priority: 🚨 Urgent"
+  color: "03adfc"
+- name: "Priority: 💤 Low priority"
+  color: "03adfc"
+
+- name: "Complexity: ☣️ Hard to do"
+  color: "ff9efc"
+- name: "Complexity: 🟩 Easy to do"
+  color: "ff9efc"
+
+- name: "Popularity: ❤️‍🔥 extreme"
+  color: "ffc7ea"
+- name: "Popularity: ❤️ high"
+  color: "ffc7ea"
 
 # VPN providers
-- name: ":cloud: Cyberghost"
+- name: "☁️ AirVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Custom"
-- name: ":cloud: Mullvad"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Cyberghost"
-- name: ":cloud: NordVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Giganews"
-- name: ":cloud: PIA"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ HideMyAss"
-- name: ":cloud: Privado"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ IPVanish"
-- name: ":cloud: PureVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ IVPN"
-- name: ":cloud: Surfshark"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ ExpressVPN"
-- name: ":cloud: Vyprvpn"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ FastestVPN"
-- name: ":cloud: Windscribe"
+  color: "cfe8d4"
+- name: "☁️ Mullvad"
+  color: "cfe8d4"
+- name: "☁️ NordVPN"
+  color: "cfe8d4"
+- name: "☁️ Perfect Privacy"
+  color: "cfe8d4"
+- name: "☁️ PIA"
+  color: "cfe8d4"
+- name: "☁️ Privado"
+  color: "cfe8d4"
+- name: "☁️ PrivateVPN"
+  color: "cfe8d4"
+- name: "☁️ ProtonVPN"
+  color: "cfe8d4"
+- name: "☁️ PureVPN"
+  color: "cfe8d4"
+- name: "☁️ SlickVPN"
+  color: "cfe8d4"
+- name: "☁️ Surfshark"
+  color: "cfe8d4"
+- name: "☁️ Torguard"
+  color: "cfe8d4"
+- name: "☁️ VPNSecure.me"
+  color: "cfe8d4"
+- name: "☁️ VPNUnlimited"
+  color: "cfe8d4"
+- name: "☁️ Vyprvpn"
+  color: "cfe8d4"
+- name: "☁️ WeVPN"
+  color: "cfe8d4"
+- name: "☁️ Windscribe"
   color: "cfe8d4"
-  description: ""
 
-# Problem category
+- name: "Category: User error 🤦"
-- name: "Openvpn"
+  from_name: "Category: Config problem 📝"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Healthcheck 🩺"
-- name: "Unbound (DNS over TLS)"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Documentation ✒️"
-- name: "Firewall"
+  description: "A problem with the readme or a code comment."
   color: "ffc7ea"
-  description: ""
+- name: "Category: Maintenance ⛓️"
-- name: "HTTP proxy"
+  description: "Anything related to code or other maintenance"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Logs 📚"
-- name: "Shadowsocks"
+  description: "Something to change in logs"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Good idea 🎯"
-- name: "Healthcheck server"
+  description: "This is a good idea, judged by the maintainers"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Motivated! 🙌"
-- name: "Control server"
+  description: "Your pumpness makes me pumped! The issue or PR shows great motivation!"
+  color: "ffc7ea"
+- name: "Category: Foolproof settings 👼"
+  color: "ffc7ea"
+- name: "Category: Label missing ❗"
+  color: "ffc7ea"
+- name: "Category: updater ♻️"
+  color: "ffc7ea"
+  description: "Concerns the code to update servers data"
+- name: "Category: New provider 🆕"
+  color: "ffc7ea"
+- name: "Category: OpenVPN 🔐"
+  color: "ffc7ea"
+- name: "Category: Wireguard 🔐"
+  color: "ffc7ea"
+- name: "Category: DNS 📠"
+  color: "ffc7ea"
+- name: "Category: Firewall ⛓️"
+  color: "ffc7ea"
+- name: "Category: Routing 🛤️"
+  color: "ffc7ea"
+- name: "Category: IPv6 🛰️"
+  color: "ffc7ea"
+- name: "Category: VPN port forwarding 📥"
+  color: "ffc7ea"
+- name: "Category: HTTP proxy 🔁"
+  color: "ffc7ea"
+- name: "Category: Shadowsocks 🔁"
+  color: "ffc7ea"
+- name: "Category: control server ⚙️"
+  color: "ffc7ea"
+- name: "Category: kernel 🧠"
+  color: "ffc7ea"
+- name: "Category: public IP service 💬"
+  color: "ffc7ea"
+- name: "Category: servers storage 📦"
+  color: "ffc7ea"
+- name: "Category: Performance 🚀"
+  color: "ffc7ea"
+- name: "Category: Investigation 🔍"
   color: "ffc7ea"
-  description: ""

.github/pull_request_template.md

@@ -0,0 +1,12 @@
+# Description
+
+<!-- Please describe the reason for the changes being proposed. -->
+
+# Issue
+
+<!-- Please link to the issue(s) this change relates to. -->
+
+# Assertions
+
+* [ ] I am aware that we do not accept manual changes to the servers.json file <!-- If this is your goal, please consult https://github.com/qdm12/gluetun-wiki/blob/main/setup/servers.md#update-using-the-command-line -->
+* [ ] I am aware that any changes to settings should be reflected in the [wiki](https://github.com/qdm12/gluetun-wiki/)

.github/workflows/branch.yml

@@ -1,52 +0,0 @@
-name: branch
-on:
-  push:
-    branches:
-      - "*"
-      - "!master"
-    paths:
-      - .github/workflows/branch.yml
-      - cmd/**
-      - internal/**
-      - .dockerignore
-      - .golangci.yml
-      - Dockerfile
-      - go.mod
-      - go.sum
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - env:
-          DOCKER_BUILDKIT: "1"
-        run: docker build --target test .
-
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - env:
-          DOCKER_BUILDKIT: "1"
-        run: docker build --target lint .
-
-  docker:
-    runs-on: ubuntu-latest
-    needs: [test, lint]
-    steps:
-      - uses: actions/checkout@v2
-      - uses: docker/setup-qemu-action@v1
-      - uses: docker/setup-buildx-action@v1
-      - name: Dockerhub login
-        run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u qmcgaw --password-stdin 2>&1
-      - name: Docker build
-        run: |
-          docker buildx build \
-            --platform=linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/s390x,linux/ppc64le \
-            --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \
-            --build-arg COMMIT=`git rev-parse --short HEAD` \
-            --build-arg VERSION="branch-${GITHUB_REF##*/}" \
-            -t qmcgaw/gluetun:branch-${GITHUB_REF##*/} \
-            --push \
-            .

.github/workflows/ci-skip.yml

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,177 @@
+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/**
+      - internal/**
+      - pkg/**
+      - .dockerignore
+      - .golangci.yml
+      - Dockerfile
+      - go.mod
+      - go.sum
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+    env:
+      DOCKER_BUILDKIT: "1"
+    steps:
+      - uses: actions/checkout@v5
+
+      - 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
+        run: docker build --target mocks .
+
+      - name: Build test image
+        run: docker build --target test -t test-container .
+
+      - name: Run tests in test container
+        run: |
+          touch coverage.txt
+          docker run --rm --device /dev/net/tun \
+          -v "$(pwd)/coverage.txt:/tmp/gobuild/coverage.txt" \
+          test-container
+
+      - name: Build final image
+        run: docker build -t final-image .
+
+  verify-private:
+    if: |
+      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]
+    runs-on: ubuntu-latest
+    environment: secrets
+    steps:
+      - uses: actions/checkout@v5
+
+      - run: docker build -t qmcgaw/gluetun .
+
+      - name: Setup Go for CI utility
+        uses: actions/setup-go@v6
+        with:
+          go-version-file: ci/go.mod
+
+      - name: Build utility
+        run: go build -C ./ci -o runner ./cmd/main.go
+
+      - name: Run Gluetun container with Mullvad configuration
+        run: echo -e "${{ secrets.MULLVAD_WIREGUARD_PRIVATE_KEY }}\n${{ secrets.MULLVAD_WIREGUARD_ADDRESS }}" | ./ci/runner mullvad
+
+  codeql:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-go@v6
+        with:
+          go-version-file: go.mod
+      - uses: github/codeql-action/init@v4
+        with:
+          languages: go
+      - uses: github/codeql-action/autobuild@v4
+      - uses: github/codeql-action/analyze@v4
+
+  publish:
+    if: |
+      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@v5
+
+      # extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - 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/setup-buildx-action@v3
+
+      - uses: docker/login-action@v3
+        with:
+          username: qmcgaw
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: qdm12
+          password: ${{ github.token }}
+
+      - name: Short commit
+        id: shortcommit
+        run: echo "::set-output name=value::$(git rev-parse --short HEAD)"
+
+      - name: Build and push final image
+        uses: docker/build-push-action@v6
+        with:
+          platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/ppc64le
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            CREATED=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
+            COMMIT=${{ steps.shortcommit.outputs.value }}
+            VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }}
+          tags: ${{ steps.meta.outputs.tags }}
+          push: true

.github/workflows/closed-issue.yml

@@ -0,0 +1,21 @@
+name: Closed issue
+on:
+  issues:
+    types: [closed]
+
+jobs:
+  comment:
+    permissions:
+      issues: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/create-or-update-comment@v5
+        with:
+          token: ${{ github.token }}
+          issue-number: ${{ github.event.issue.number }}
+          body: |
+            Closed issues are **NOT** monitored, so commenting here is likely to be not seen.
+            If you think this is *still unresolved* and have **more information** to bring, please create another issue.
+
+            This is an automated comment setup because @qdm12 is the sole maintainer of this project
+            which became too popular to monitor issues closed.

.github/workflows/configs/mlc-config.json

@@ -0,0 +1,13 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^https://console.substack.com/p/console-72$"
+    }
+  ],
+  "timeout": "20s",
+  "retryOn429": false,
+  "fallbackRetryDelay": "30s",
+  "aliveStatusCodes": [
+    200
+  ]
+}

.github/workflows/dockerhub-description.yml

@@ -1,21 +0,0 @@
-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
-      - name: Docker Hub Description
-        uses: peter-evans/dockerhub-description@v2.4.1
-        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,12 +7,11 @@ on:
       - .github/workflows/labels.yml
 jobs:
   labeler:
+    permissions:
+      issues: write
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
+      - uses: actions/checkout@v5
-        uses: actions/checkout@v2
+      - uses: crazy-max/ghaction-github-labeler@v5
-      - name: Labeler
+        with:
-        if: success()
+          yaml-file: .github/labels.yml
-        uses: crazy-max/ghaction-github-labeler@v3.1.1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/latest.yml

@@ -1,53 +0,0 @@
-name: latest
-on:
-  push:
-    branches: [master]
-    paths:
-      - .github/workflows/latest.yml
-      - cmd/**
-      - internal/**
-      - .dockerignore
-      - .golangci.yml
-      - Dockerfile
-      - go.mod
-      - go.sum
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - env:
-          DOCKER_BUILDKIT: "1"
-        run: docker build --target test .
-
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - env:
-          DOCKER_BUILDKIT: "1"
-        run: docker build --target lint .
-
-  docker:
-    runs-on: ubuntu-latest
-    needs: [test, lint]
-    steps:
-      - uses: actions/checkout@v2
-      - uses: docker/setup-qemu-action@v1
-      - uses: docker/setup-buildx-action@v1
-      - name: Dockerhub login
-        run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u qmcgaw --password-stdin 2>&1
-      - name: Docker buildx
-        run: |
-          docker buildx build \
-            --platform=linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/s390x,linux/ppc64le \
-            --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \
-            --build-arg COMMIT=`git rev-parse --short HEAD` \
-            --build-arg VERSION=latest \
-            -t qmcgaw/private-internet-access:latest \
-            -t qmcgaw/gluetun:latest \
-            --push \
-            .
-      - run: curl -X POST https://hooks.microbadger.com/images/qmcgaw/private-internet-access/tQFy7AxtSUNANPe6aoVChYdsI_I=
-        continue-on-error: true

.github/workflows/markdown-skip.yml

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,47 @@
+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@v5
+
+      - uses: DavidAnson/markdownlint-cli2-action@v20
+        with:
+          globs: "**.md"
+          config: .markdownlint-cli2.jsonc
+
+      - 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
+          config-file: .github/workflows/configs/mlc-config.json
+
+      - uses: peter-evans/dockerhub-description@v5
+        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

@@ -1,16 +0,0 @@
-name: Misspells
-on:
-  pull_request:
-    branches: [master]
-  push:
-    branches: [master]
-jobs:
-  misspell:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: reviewdog/action-misspell@master
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          locale: "US"
-          level: error

.github/workflows/opened-issue.yml

@@ -0,0 +1,22 @@
+name: Opened issue
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  comment:
+    permissions:
+      issues: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/create-or-update-comment@v5
+        with:
+          token: ${{ github.token }}
+          issue-number: ${{ github.event.issue.number }}
+          body: |
+            @qdm12 is more or less the only maintainer of this project and works on it in his free time.
+            Please:
+            - **do not** ask for updates, be patient
+            - :+1: the issue to show your support instead of commenting
+            @qdm12 usually checks issues at least once a week, if this is a new urgent bug,
+            [revert to an older tagged container image](https://github.com/qdm12/gluetun-wiki/blob/main/setup/docker-image-tags.md)

.github/workflows/pr.yml

@@ -1,40 +0,0 @@
-name: pull request
-on:
-  pull_request:
-    branches: [master]
-    paths:
-      - .github/workflows/pr.yml
-      - cmd/**
-      - internal/**
-      - .dockerignore
-      - .golangci.yml
-      - Dockerfile
-      - go.mod
-      - go.sum
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - env:
-          DOCKER_BUILDKIT: "1"
-        run: docker build --target test .
-
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - env:
-          DOCKER_BUILDKIT: "1"
-        run: docker build --target lint .
-
-  docker:
-    runs-on: ubuntu-latest
-    needs: [test, lint]
-    steps:
-      - uses: actions/checkout@v2
-      - name: Docker build
-        env:
-          DOCKER_BUILDKIT: "1"
-        run: docker build .

.github/workflows/release.yml

@@ -1,51 +0,0 @@
-name: release
-on:
-  release:
-    types: [published]
-    paths:
-      - .github/workflows/release.yml
-      - cmd/**
-      - internal/**
-      - .dockerignore
-      - .golangci.yml
-      - Dockerfile
-      - go.mod
-      - go.sum
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - env:
-          DOCKER_BUILDKIT: "1"
-        run: docker build --target test .
-
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - env:
-          DOCKER_BUILDKIT: "1"
-        run: docker build --target lint .
-
-  docker:
-    runs-on: ubuntu-latest
-    needs: [test, lint]
-    steps:
-      - uses: actions/checkout@v2
-      - uses: docker/setup-qemu-action@v1
-      - uses: docker/setup-buildx-action@v1
-      - name: Dockerhub login
-        run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u qmcgaw --password-stdin 2>&1
-      - name: Docker buildx
-        run: |
-          docker buildx build \
-            --platform=linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/s390x,linux/ppc64le \
-            --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \
-            --build-arg COMMIT=`git rev-parse --short HEAD` \
-            --build-arg VERSION=${GITHUB_REF##*/} \
-            -t qmcgaw/private-internet-access:${GITHUB_REF##*/} \
-            -t qmcgaw/gluetun:${GITHUB_REF##*/} \
-            --push \
-            .

.gitignore

@@ -0,0 +1 @@
+scratch.txt

.golangci.yml

@@ -1,31 +1,91 @@
-linters-settings:
+version: "2"
-  maligned:
-    suggest-new: true
-  misspell:
-    locale: US
 
-issues:
+formatters:
-  exclude-rules:
-    - path: _test\.go
-      linters:
-        - dupl
-        - maligned
-    - path: internal/unix/constants\.go
-      linters:
-        - golint
-      text: don't use ALL_CAPS in Go names; use CamelCase
-linters:
-  disable-all: true
   enable:
+    - gci
+    - gofumpt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+
+linters:
+  settings:
+    misspell:
+      locale: US
+    goconst:
+      ignore-string-values:
+        # commonly used settings strings
+        - "^disabled$"
+        # Firewall and routing strings
+        - "^(ACCEPT|DROP)$"
+        - "^--delete$"
+        - "^all$"
+        - "^(tcp|udp)$"
+        # Server route strings
+        - "^/status$"
+
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      - linters:
+          - containedctx
+          - dupl
+          - err113
+          - maintidx
+        path: _test\.go
+      - linters:
+          - dupl
+        path: internal\/server\/.+\.go
+      - linters:
+          - ireturn
+        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:
+          - revive
+        path: internal\/provider\/(common|utils)\/.+\.go
+        text: "var-naming: avoid (bad|meaningless) package names"
+      - linters:
+          - err113
+          - mnd
+        path: ci\/.+\.go
+
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+  enable:
+    # - cyclop
+    # - errorlint
+    - asasalint
     - asciicheck
+    - bidichk
     - bodyclose
-    - deadcode
+    - containedctx
+    - copyloopvar
+    - decorder
     - dogsled
     - dupl
-    - errcheck
+    - dupword
+    - durationcheck
+    - err113
+    - errchkjson
+    - errname
     - exhaustive
-    - exportloopref
+    - fatcontext
-    - gci
+    - forcetypeassert
+    - gocheckcompilerdirectives
     - gochecknoglobals
     - gochecknoinits
     - gocognit
@@ -34,37 +94,43 @@ linters:
     - gocyclo
     - godot
     - goheader
-    - goimports
+    - gomoddirectives
-    - golint
-    - gomnd
     - goprintffuncname
     - gosec
-    - gosimple
+    - gosmopolitan
-    - govet
+    - grouper
-    - ineffassign
+    - importas
-    - interfacer
+    - interfacebloat
+    - intrange
+    - ireturn
     - lll
-    - maligned
+    - maintidx
+    - makezero
+    - mirror
     - misspell
+    - mnd
+    - musttag
     - nakedret
     - nestif
+    - nilerr
+    - nilnil
     - noctx
     - nolintlint
+    - nosprintfhostport
+    - paralleltest
     - prealloc
+    - predeclared
+    - promlinter
+    - reassign
+    - revive
     - rowserrcheck
-    - scopelint
     - sqlclosecheck
-    - staticcheck
+    - tagalign
-    - structcheck
+    - thelper
-    - typecheck
+    - tparallel
     - unconvert
     - unparam
-    - unused
+    - usestdlibvars
-    - varcheck
+    - wastedassign
     - whitespace
-
+    - zerologlint
-run:
-  skip-dirs:
-    - .devcontainer
-    - .github
-    - doc

.markdownlint-cli2.jsonc

@@ -0,0 +1,9 @@
+{
+  "config": {
+    "default": true,
+    "MD013": false,
+  },
+  "ignores": [
+    ".github/pull_request_template.md"
+  ]
+}

.vscode/extensions.json

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

.vscode/settings.json

@@ -0,0 +1,29 @@
+{
+  // 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": "explicit"
+    }
+  },
+  "go.lintTool": "golangci-lint",
+  "go.lintOnSave": "package"
+}

.vscode/tasks.json

@@ -0,0 +1,51 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Update a VPN provider servers data",
+            "type": "shell",
+            "command": "go",
+            "args": [
+                "run",
+                "./cmd/gluetun/main.go",
+                "update",
+                "${input:updateMode}",
+                "-providers",
+                "${input:provider}"
+            ],
+        },
+        {
+            "label": "Add a Gluetun Github Git remote",
+            "type": "shell",
+            "command": "git",
+            "args": [
+                "remote",
+                "add",
+                "${input:githubRemoteUsername}",
+                "git@github.com:${input:githubRemoteUsername}/gluetun.git"
+            ],
+        }
+    ],
+    "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"
+        },
+        {
+            "id": "githubRemoteUsername",
+            "type": "promptString",
+            "description": "Please enter a Github username",
+        },
+    ]
+}

Dockerfile

@@ -1,50 +1,71 @@
-ARG ALPINE_VERSION=3.12
+ARG ALPINE_VERSION=3.22
-ARG GO_VERSION=1.15
+ARG GO_ALPINE_VERSION=3.22
+ARG GO_VERSION=1.25
+ARG XCPUTRANSLATE_VERSION=v0.9.0
+ARG GOLANGCI_LINT_VERSION=v2.4.0
+ARG MOCKGEN_VERSION=v1.6.0
+ARG BUILDPLATFORM=linux/amd64
 
-FROM --platform=$BUILDPLATFORM golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS base
+FROM --platform=${BUILDPLATFORM} ghcr.io/qdm12/xcputranslate:${XCPUTRANSLATE_VERSION} AS xcputranslate
-RUN apk --update add git
+FROM --platform=${BUILDPLATFORM} ghcr.io/qdm12/binpot:golangci-lint-${GOLANGCI_LINT_VERSION} AS golangci-lint
+FROM --platform=${BUILDPLATFORM} ghcr.io/qdm12/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++ 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
 COPY cmd/ ./cmd/
 COPY internal/ ./internal/
 
-FROM --platform=$BUILDPLATFORM base AS test
+FROM --platform=${BUILDPLATFORM} base AS test
+# Note on the go race detector:
+# - we set CGO_ENABLED=1 to have it enabled
+# - we installed g++ to support the race detector
 ENV CGO_ENABLED=1
-RUN apk --update add g++
+ENTRYPOINT go test -race -coverpkg=./... -coverprofile=coverage.txt -covermode=atomic ./...
-RUN go test -race ./...
 
-FROM --platform=$BUILDPLATFORM base AS lint
+FROM --platform=${BUILDPLATFORM} base AS lint
-ARG GOLANGCI_LINT_VERSION=v1.34.1
-RUN wget -O- -nv https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | \
-    sh -s -- -b /usr/local/bin ${GOLANGCI_LINT_VERSION}
 COPY .golangci.yml ./
-RUN golangci-lint run --timeout=10m
+RUN golangci-lint run
 
-FROM --platform=$BUILDPLATFORM base AS build
+FROM --platform=${BUILDPLATFORM} base AS mocks
-COPY --from=qmcgaw/xcputranslate:v0.4.0 /xcputranslate /usr/local/bin/xcputranslate
+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 "snapshot" && \
+    grep -lr -E '^// Code generated by MockGen\. DO NOT EDIT\.$' . | xargs -r -d '\n' rm && \
+    go generate -run "mockgen" ./... && \
+    git diff --exit-code && \
+    rm -rf .git/
+
+FROM --platform=${BUILDPLATFORM} base AS build
 ARG TARGETPLATFORM
 ARG VERSION=unknown
-ARG BUILD_DATE="an unknown date"
+ARG CREATED="an unknown date"
 ARG COMMIT=unknown
-COPY cmd/ ./cmd/
+RUN GOARCH="$(xcputranslate translate -field arch -targetplatform ${TARGETPLATFORM})" \
-COPY internal/ ./internal/
+    GOARM="$(xcputranslate translate -field arm -targetplatform ${TARGETPLATFORM})" \
-RUN GOARCH="$(xcputranslate -field arch -targetplatform ${TARGETPLATFORM})" \
-    GOARM="$(xcputranslate -field arm -targetplatform ${TARGETPLATFORM})" \
     go build -trimpath -ldflags="-s -w \
     -X 'main.version=$VERSION' \
-    -X 'main.buildDate=$BUILD_DATE' \
+    -X 'main.created=$CREATED' \
     -X 'main.commit=$COMMIT' \
     " -o entrypoint cmd/gluetun/main.go
 
 FROM alpine:${ALPINE_VERSION}
 ARG VERSION=unknown
-ARG BUILD_DATE="an unknown date"
+ARG CREATED="an unknown date"
 ARG COMMIT=unknown
 LABEL \
     org.opencontainers.image.authors="quentin.mcgaw@gmail.com" \
-    org.opencontainers.image.created=$BUILD_DATE \
+    org.opencontainers.image.created=$CREATED \
     org.opencontainers.image.version=$VERSION \
     org.opencontainers.image.revision=$COMMIT \
     org.opencontainers.image.url="https://github.com/qdm12/gluetun" \
@@ -52,54 +73,103 @@ 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 VPNSP=pia \
+ENV VPN_SERVICE_PROVIDER=pia \
-    VERSION_INFORMATION=on \
+    VPN_TYPE=openvpn \
-    PROTOCOL=udp \
+    # Common VPN options
-    OPENVPN_VERBOSITY=1 \
+    VPN_INTERFACE=tun0 \
-    OPENVPN_ROOT=no \
+    # OpenVPN
-    OPENVPN_TARGET_IP= \
+    OPENVPN_ENDPOINT_IP= \
-    OPENVPN_IPV6=off \
+    OPENVPN_ENDPOINT_PORT= \
-    TZ= \
+    OPENVPN_PROTOCOL=udp \
-    PUID= \
-    PGID= \
-    PUBLICIP_FILE="/tmp/gluetun/ip" \
-    # PIA, Windscribe, Surfshark, Cyberghost, Vyprvpn, NordVPN, PureVPN only
     OPENVPN_USER= \
     OPENVPN_PASSWORD= \
-    USER_SECRETFILE=/run/secrets/openvpn_user \
+    OPENVPN_USER_SECRETFILE=/run/secrets/openvpn_user \
-    PASSWORD_SECRETFILE=/run/secrets/openvpn_password \
+    OPENVPN_PASSWORD_SECRETFILE=/run/secrets/openvpn_password \
-    REGION= \
+    OPENVPN_VERSION=2.6 \
-    # PIA only
+    OPENVPN_VERBOSITY=1 \
-    PIA_ENCRYPTION=strong \
+    OPENVPN_FLAGS= \
-    PORT_FORWARDING=off \
+    OPENVPN_CIPHERS= \
-    PORT_FORWARDING_STATUS_FILE="/tmp/gluetun/forwarded_port" \
+    OPENVPN_AUTH= \
-    # Mullvad and PureVPN only
+    OPENVPN_PROCESS_USER=root \
-    COUNTRY= \
+    OPENVPN_MSSFIX= \
-    # Mullvad, PureVPN, Windscribe only
+    OPENVPN_CUSTOM_CONFIG= \
-    CITY= \
+    # Wireguard
-    # Windscribe only
+    WIREGUARD_ENDPOINT_IP= \
-    SERVER_HOSTNAME= \
+    WIREGUARD_ENDPOINT_PORT= \
-    # Mullvad only
+    WIREGUARD_CONF_SECRETFILE=/run/secrets/wg0.conf \
+    WIREGUARD_PRIVATE_KEY= \
+    WIREGUARD_PRIVATE_KEY_SECRETFILE=/run/secrets/wireguard_private_key \
+    WIREGUARD_PRESHARED_KEY= \
+    WIREGUARD_PRESHARED_KEY_SECRETFILE=/run/secrets/wireguard_preshared_key \
+    WIREGUARD_PUBLIC_KEY= \
+    WIREGUARD_ALLOWED_IPS= \
+    WIREGUARD_PERSISTENT_KEEPALIVE_INTERVAL=0 \
+    WIREGUARD_ADDRESSES= \
+    WIREGUARD_ADDRESSES_SECRETFILE=/run/secrets/wireguard_addresses \
+    WIREGUARD_MTU=1320 \
+    WIREGUARD_IMPLEMENTATION=auto \
+    # VPN server filtering
+    SERVER_REGIONS= \
+    SERVER_COUNTRIES= \
+    SERVER_CITIES= \
+    SERVER_HOSTNAMES= \
+    SERVER_CATEGORIES= \
+    # # Mullvad only:
     ISP= \
-    OWNED=no \
+    OWNED_ONLY=no \
-    # Mullvad and Windscribe only
+    # # Private Internet Access only:
-    PORT= \
+    PRIVATE_INTERNET_ACCESS_OPENVPN_ENCRYPTION_PRESET= \
-    # Cyberghost only
+    VPN_PORT_FORWARDING=off \
-    CYBERGHOST_GROUP="Premium UDP Europe" \
+    VPN_PORT_FORWARDING_LISTENING_PORT=0 \
+    VPN_PORT_FORWARDING_PROVIDER= \
+    VPN_PORT_FORWARDING_STATUS_FILE="/tmp/gluetun/forwarded_port" \
+    VPN_PORT_FORWARDING_USERNAME= \
+    VPN_PORT_FORWARDING_PASSWORD= \
+    VPN_PORT_FORWARDING_UP_COMMAND= \
+    VPN_PORT_FORWARDING_DOWN_COMMAND= \
+    # # Cyberghost only:
+    OPENVPN_CERT= \
+    OPENVPN_KEY= \
     OPENVPN_CLIENTCRT_SECRETFILE=/run/secrets/openvpn_clientcrt \
     OPENVPN_CLIENTKEY_SECRETFILE=/run/secrets/openvpn_clientkey \
-    # NordVPN only
+    # # VPNSecure 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= \
-    # Openvpn
+    # # PIA only:
-    OPENVPN_CIPHER= \
+    SERVER_NAMES= \
-    OPENVPN_AUTH= \
+    # # VPNUnlimited and ProtonVPN only:
+    STREAM_ONLY= \
+    FREE_ONLY= \
+    # # ProtonVPN only:
+    SECURE_CORE_ONLY= \
+    TOR_ONLY= \
+    # # Surfshark only:
+    MULTIHOP_ONLY= \
+    # # VPN Secure only:
+    PREMIUM_ONLY= \
+    # # PIA and ProtonVPN only:
+    PORT_FORWARD_ONLY= \
+    # Firewall
+    FIREWALL_ENABLED_DISABLING_IT_SHOOTS_YOU_IN_YOUR_FOOT=on \
+    FIREWALL_VPN_INPUT_PORTS= \
+    FIREWALL_INPUT_PORTS= \
+    FIREWALL_OUTBOUND_SUBNETS= \
+    FIREWALL_DEBUG=off \
+    # Logging
+    LOG_LEVEL=info \
+    # Health
+    HEALTH_SERVER_ADDRESS=127.0.0.1:9999 \
+    HEALTH_TARGET_ADDRESS=cloudflare.com:443 \
+    HEALTH_ICMP_TARGET_IP=0.0.0.0 \
+    HEALTH_RESTART_VPN=on \
     # DNS over TLS
     DOT=on \
     DOT_PROVIDERS=cloudflare \
-    DOT_PRIVATE_ADDRESS=127.0.0.1/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,169.254.0.0/16,::1/128,fc00::/7,fe80::/10,::ffff:0:0/96 \
+    DOT_PRIVATE_ADDRESS=127.0.0.1/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,169.254.0.0/16,::1/128,fc00::/7,fe80::/10,::ffff:7f00:1/104,::ffff:a00:0/104,::ffff:a9fe:0/112,::ffff:ac10:0/108,::ffff:c0a8:0/112 \
-    DOT_VERBOSITY=1 \
-    DOT_VERBOSITY_DETAILS=0 \
-    DOT_VALIDATION_LOGLEVEL=0 \
     DOT_CACHING=on \
     DOT_IPV6=off \
     BLOCK_MALICIOUS=on \
@@ -107,18 +177,13 @@ ENV VPNSP=pia \
     BLOCK_ADS=off \
     UNBLOCK= \
     DNS_UPDATE_PERIOD=24h \
-    DNS_PLAINTEXT_ADDRESS=1.1.1.1 \
+    DNS_ADDRESS=127.0.0.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_PORT=8888 \
+    HTTPPROXY_LISTENING_ADDRESS=":8888" \
+    HTTPPROXY_STEALTH=off \
     HTTPPROXY_USER= \
     HTTPPROXY_PASSWORD= \
     HTTPPROXY_USER_SECRETFILE=/run/secrets/httpproxy_user \
@@ -126,19 +191,46 @@ ENV VPNSP=pia \
     # Shadowsocks
     SHADOWSOCKS=off \
     SHADOWSOCKS_LOG=off \
-    SHADOWSOCKS_PORT=8388 \
+    SHADOWSOCKS_LISTENING_ADDRESS=":8388" \
     SHADOWSOCKS_PASSWORD= \
     SHADOWSOCKS_PASSWORD_SECRETFILE=/run/secrets/shadowsocks_password \
-    SHADOWSOCKS_METHOD=chacha20-ietf-poly1305 \
+    SHADOWSOCKS_CIPHER=chacha20-ietf-poly1305 \
-    UPDATER_PERIOD=0
+    # Control server
-ENTRYPOINT ["/entrypoint"]
+    HTTP_CONTROL_SERVER_LOG=on \
+    HTTP_CONTROL_SERVER_ADDRESS=":8000" \
+    HTTP_CONTROL_SERVER_AUTH_CONFIG_FILEPATH=/gluetun/auth/config.toml \
+    # Server data updater
+    UPDATER_PERIOD=0 \
+    UPDATER_MIN_RATIO=0.8 \
+    UPDATER_VPN_SERVICE_PROVIDERS= \
+    # Public IP
+    PUBLICIP_FILE="/tmp/gluetun/ip" \
+    PUBLICIP_ENABLED=on \
+    PUBLICIP_API=ipinfo,ifconfigco,ip2location,cloudflare \
+    PUBLICIP_API_TOKEN= \
+    # Storage
+    STORAGE_FILEPATH=/gluetun/servers.json \
+    # 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 /entrypoint healthcheck
+HEALTHCHECK --interval=5s --timeout=5s --start-period=10s --retries=3 CMD /gluetun-entrypoint healthcheck
-RUN apk add -q --progress --no-cache --update openvpn ca-certificates iptables ip6tables unbound tzdata && \
+ARG TARGETPLATFORM
-    rm -rf /var/cache/apk/* /etc/unbound/* /usr/sbin/unbound-* && \
+RUN apk add --no-cache --update -l wget && \
+    apk add --no-cache --update -X "https://dl-cdn.alpinelinux.org/alpine/v3.17/main" openvpn\~2.5 && \
+    mv /usr/sbin/openvpn /usr/sbin/openvpn2.5 && \
+    apk del openvpn && \
+    apk add --no-cache --update openvpn ca-certificates iptables iptables-legacy tzdata && \
+    mv /usr/sbin/openvpn /usr/sbin/openvpn2.6 && \
+    rm -rf /var/cache/apk/* /etc/openvpn/*.sh /usr/lib/openvpn/plugins/openvpn-plugin-down-root.so && \
     deluser openvpn && \
-    deluser unbound && \
     mkdir /gluetun
-# TODO remove once SAN is added to PIA servers certificates, see https://github.com/pia-foss/manual-connections/issues/10
+COPY --from=build /tmp/gobuild/entrypoint /gluetun-entrypoint
-ENV GODEBUG=x509ignoreCN=0
-COPY --from=build /tmp/gobuild/entrypoint /entrypoint

README.md

@@ -1,132 +1,128 @@
-# Gluetun VPN client
+# Gluetun VPN client
-
+
-*Lightweight swiss-knife-like VPN client to tunnel to Private Internet Access,
+Lightweight swiss-army-knife-like VPN client to multiple VPN service providers
-Mullvad, Windscribe, Surfshark Cyberghost, VyprVPN, NordVPN, PureVPN and Privado VPN servers, using Go, OpenVPN, iptables, DNS over TLS, ShadowSocks and an HTTP proxy*
+
-
+![Title image](https://raw.githubusercontent.com/qdm12/gluetun/master/title.svg)
-**ANNOUNCEMENT**: *New Docker image name `qmcgaw/gluetun`*
+
-
+[![Build status](https://github.com/qdm12/gluetun/actions/workflows/ci.yml/badge.svg)](https://github.com/qdm12/gluetun/actions/workflows/ci.yml)
-<img height="250" src="https://raw.githubusercontent.com/qdm12/gluetun/master/title.svg?sanitize=true">
+
-
+[![Docker pulls qmcgaw/gluetun](https://img.shields.io/docker/pulls/qmcgaw/gluetun.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
-[![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 pulls qmcgaw/private-internet-access](https://img.shields.io/docker/pulls/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
-[![Size](https://img.shields.io/docker/image-size/qmcgaw/gluetun/latest?label=Latest%20image)](https://hub.docker.com/r/qmcgaw/gluetun/tags)
+
-
+[![Docker stars qmcgaw/gluetun](https://img.shields.io/docker/stars/qmcgaw/gluetun.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
-[![Docker Pulls](https://img.shields.io/docker/pulls/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/private-internet-access)
+[![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](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)
-![Last release](https://img.shields.io/github/release/qdm12/gluetun?label=Last%20release)
+![Last Docker tag](https://img.shields.io/docker/v/qmcgaw/gluetun?sort=semver&label=Last%20Docker%20tag)
-![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 Release Date](https://img.shields.io/github/release-date/qdm12/gluetun?label=Last%20release%20date)
+![GitHub last release date](https://img.shields.io/github/release-date/qdm12/gluetun?label=Last%20release%20date)
-
+![Commits since release](https://img.shields.io/github/commits-since/qdm12/gluetun/latest?sort=semver)
-![Commits since release](https://img.shields.io/github/commits-since/qdm12/gluetun/latest?sort=semver)
+
-[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/commits)
+[![Latest size](https://img.shields.io/docker/image-size/qmcgaw/gluetun/latest?label=Latest%20image)](https://hub.docker.com/r/qmcgaw/gluetun/tags)
-
+
-[![Lines of code](https://img.shields.io/tokei/lines/github/qdm12/gluetun)](https://github.com/qdm12/gluetun)
+[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/commits/master)
-
+[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/graphs/contributors)
-## Quick links
+[![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)
-- Problem or suggestion?
+[![GitHub closed issues](https://img.shields.io/github/issues-closed/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues?q=is%3Aissue+is%3Aclosed)
-  - [Start a discussion](https://github.com/qdm12/gluetun/discussions)
+
-  - [Create an issue](https://github.com/qdm12/gluetun/issues)
+![Code size](https://img.shields.io/github/languages/code-size/qdm12/gluetun)
-  - [Check the Wiki](https://github.com/qdm12/gluetun/wiki)
+![GitHub repo size](https://img.shields.io/github/repo-size/qdm12/gluetun)
-  - [Join the Slack channel](https://join.slack.com/t/qdm12/shared_invite/enQtOTE0NjcxNTM1ODc5LTYyZmVlOTM3MGI4ZWU0YmJkMjUxNmQ4ODQ2OTAwYzMxMTlhY2Q1MWQyOWUyNjc2ODliNjFjMDUxNWNmNzk5MDk)
+![Go version](https://img.shields.io/github/go-mod/go-version/qdm12/gluetun)
-- Happy?
+
-  - Sponsor me on [github.com/sponsors/qdm12](https://github.com/sponsors/qdm12)
+![Visitors count](https://visitor-badge.laobi.icu/badge?page_id=gluetun.readme)
-  - Donate to [paypal.me/qmcgaw](https://www.paypal.me/qmcgaw)
+
-  - Drop me [an email](mailto:quentin.mcgaw@gmail.com)
+## Quick links
-
+
-## Features
+- [Setup](#setup)
-
+- [Features](#features)
-- Based on Alpine 3.12 for a small Docker image of 52MB
+- Problem?
-- Supports **Private Internet Access**, **Mullvad**, **Windscribe**, **Surfshark**, **Cyberghost**, **Vyprvpn**, **NordVPN**, **PureVPN** and **Privado** servers
+  - 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)
-- Supports Openvpn only for now
+  - [Start a discussion](https://github.com/qdm12/gluetun/discussions)
-- DNS over TLS baked in with service provider(s) of your choice
+  - [Fix the Unraid template](https://github.com/qdm12/gluetun/discussions/550)
-- DNS fine blocking of malicious/ads/surveillance hostnames and IP addresses, with live update every 24 hours
+- Suggestion?
-- Choose the vpn network protocol, `udp` or `tcp`
+  - [Create an issue](https://github.com/qdm12/gluetun/issues)
-- Built in firewall kill switch to allow traffic only with needed the VPN servers and LAN devices
+- Happy?
-- Built in Shadowsocks proxy (protocol based on SOCKS5 with an encryption layer, tunnels TCP+UDP)
+  - Sponsor me on [github.com/sponsors/qdm12](https://github.com/sponsors/qdm12)
-- Built in HTTP proxy (tunnels HTTP and HTTPS through TCP)
+  - Donate to [paypal.me/qmcgaw](https://www.paypal.me/qmcgaw)
-- [Connect other containers to it](https://github.com/qdm12/gluetun/wiki/Connect-to-gluetun)
+  - Drop me [an email](mailto:quentin.mcgaw@gmail.com)
-- [Connect LAN devices to it](https://github.com/qdm12/gluetun/wiki/Connect-to-gluetun)
+- **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)
-- Compatible with amd64, i686 (32 bit), **ARM** 64 bit, ARM 32 bit v6 and v7, and even s390x as well as ppc64le 🎆
+- Video:
-- VPN server side port forwarding for Private Internet Access and Vyprvpn
+
-- Possibility of split horizon DNS by selecting multiple DNS over TLS providers
+  [![Video Gif](https://i.imgur.com/CetWunc.gif)](https://youtu.be/0F6I03LQcI4)
-- Subprograms all drop root privileges once launched
+
-- Subprograms output streams are all merged together
+- [Substack Console interview](https://console.substack.com/p/console-72)
-- Can work as a Kubernetes sidecar container, thanks @rorph
+
-
+## Features
-## Setup
+
-
+- Based on Alpine 3.22 for a small Docker image of 41.1MB
-1. On some devices you may need to setup your tunnel kernel module on your host with `insmod /lib/modules/tun.ko` or `modprobe tun`
+- Supports: **AirVPN**, **Cyberghost**, **ExpressVPN**, **FastestVPN**, **Giganews**, **HideMyAss**, **IPVanish**, **IVPN**, **Mullvad**, **NordVPN**, **Perfect Privacy**, **Privado**, **Private Internet Access**, **PrivateVPN**, **ProtonVPN**, **PureVPN**,  **SlickVPN**, **Surfshark**, **TorGuard**, **VPNSecure.me**, **VPNUnlimited**, **Vyprvpn**, **WeVPN**, **Windscribe** servers
-    - [Synology users Wiki page](https://github.com/qdm12/gluetun/wiki/Synology-setup)
+- Supports OpenVPN for all providers listed
-1. Launch the container with:
+- Supports Wireguard both kernelspace and userspace
-
+  - For **AirVPN**, **FastestVPN**, **Ivpn**, **Mullvad**, **NordVPN**, **Perfect privacy**, **ProtonVPN**, **Surfshark** and **Windscribe**
-    ```bash
+  - For **Cyberghost**, **Private Internet Access**, **PrivateVPN**, **PureVPN**, **Torguard**, **VPN Unlimited**, **VyprVPN** and **WeVPN** using [the custom provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md)
-    docker run -d --name gluetun --cap-add=NET_ADMIN \
+  - For custom Wireguard configurations using [the custom provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md)
-    -e VPNSP="private internet access" -e REGION="CA Montreal" \
+  - More in progress, see [#134](https://github.com/qdm12/gluetun/issues/134)
-    -e OPENVPN_USER=js89ds7 -e OPENVPN_PASSWORD=8fd9s239G \
+- DNS over TLS baked in with service provider(s) of your choice
-    -v /yourpath:/gluetun \
+- DNS fine blocking of malicious/ads/surveillance hostnames and IP addresses, with live update every 24 hours
-    qmcgaw/gluetun
+- Choose the vpn network protocol, `udp` or `tcp`
-    ```
+- Built in firewall kill switch to allow traffic only with needed the VPN servers and LAN devices
-
+- Built in Shadowsocks proxy server (protocol based on SOCKS5 with an encryption layer, tunnels TCP+UDP)
-    or use [docker-compose.yml](https://github.com/qdm12/gluetun/blob/master/docker-compose.yml) with:
+- Built in HTTP proxy (tunnels HTTP and HTTPS through TCP)
-
+- [Connect other containers to it](https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-container-to-gluetun.md)
-    ```bash
+- [Connect LAN devices to it](https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-lan-device-to-gluetun.md)
-    echo "your openvpn username" > openvpn_user
+- Compatible with amd64, i686 (32 bit), **ARM** 64 bit, ARM 32 bit v6 and v7, and even ppc64le 🎆
-    echo "your openvpn password" > openvpn_password
+- Custom VPN server side port forwarding for [Perfect Privacy](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/perfect-privacy.md#vpn-server-port-forwarding), [Private Internet Access](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/private-internet-access.md#vpn-server-port-forwarding), [PrivateVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/privatevpn.md#vpn-server-port-forwarding) and [ProtonVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/protonvpn.md#vpn-server-port-forwarding)
-    docker-compose up -d
+- Possibility of split horizon DNS by selecting multiple DNS over TLS providers
-    ```
+- Can work as a Kubernetes sidecar container, thanks @rorph
-
+
-    You should probably check the many [environment variables](https://github.com/qdm12/gluetun/wiki/Environment-variables) available to adapt the container to your needs.
+## Setup
-
+
-## Further setup
+🎉 There are now instructions specific to each VPN provider with examples to help you get started as quickly as possible!
-
+
-The following points are all optional but should give you insights on all the possibilities with this container.
+Go to the [Wiki](https://github.com/qdm12/gluetun-wiki)!
-
+
-- Use [Docker secrets](https://github.com/qdm12/gluetun/wiki/Docker-secrets) to read your credentials instead of environment variables
+[🐛 Found a bug in the Wiki?!](https://github.com/qdm12/gluetun-wiki/issues/new/choose)
-- [Test your setup](https://github.com/qdm12/gluetun/wiki/Test-your-setup)
+
-- [How to connect other containers and devices to Gluetun](https://github.com/qdm12/gluetun/wiki/Connect-to-gluetun)
+Here's a docker-compose.yml for the laziest:
-- [VPN server side port forwarding](https://github.com/qdm12/gluetun/wiki/Port-forwarding)
+
-- [HTTP control server](https://github.com/qdm12/gluetun/wiki/HTTP-Control-server) to automate things, restart Openvpn etc.
+```yml
-- 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.
+---
-
+services:
-## Development
+  gluetun:
-
+    image: qmcgaw/gluetun
-- 💻 [Contribute with code](https://github.com/qdm12/gluetun/wiki/Development) ([existing contributors 👍](https://github.com/qdm12/gluetun/blob/master/.github/CONTRIBUTING.md#Contributors))
+    # container_name: gluetun
-- [List of issues and feature requests](https://github.com/qdm12/gluetun/issues)
+    # line above must be uncommented to allow external containers to connect.
-- [Kanban board](https://github.com/qdm12/gluetun/projects/1)
+    # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-container-to-gluetun.md#external-container-to-gluetun
-
+    cap_add:
-## License
+      - NET_ADMIN
-
+    devices:
-[![MIT](https://img.shields.io/github/license/qdm12/gluetun)](https://github.com/qdm12/gluetun/master/LICENSE)
+      - /dev/net/tun:/dev/net/tun
-
+    ports:
-## Support
+      - 8888:8888/tcp # HTTP proxy
-
+      - 8388:8388/tcp # Shadowsocks
-- Sponsor me on [Github](https://github.com/sponsors/qdm12) or donate to [paypal.me/qmcgaw](https://www.paypal.me/qmcgaw)
+      - 8388:8388/udp # Shadowsocks
-
+    volumes:
-  [![https://github.com/sponsors/qdm12](https://raw.githubusercontent.com/qdm12/gluetun/master/doc/sponsors.jpg)](https://github.com/sponsors/qdm12)
+      - /yourpath:/gluetun
-  [![https://www.paypal.me/qmcgaw](https://raw.githubusercontent.com/qdm12/gluetun/master/doc/paypal.jpg)](https://www.paypal.me/qmcgaw)
+    environment:
-
+      # See https://github.com/qdm12/gluetun-wiki/tree/main/setup#setup
-- Contribute to the issues and discussions on Github
+      - VPN_SERVICE_PROVIDER=ivpn
-- Many thanks to @Frepke, @Ralph521, G. Mendez, M. Otmar Weber, J. Perez, A. Cooper and **others** for supporting me financially 🥇👍
+      - VPN_TYPE=openvpn
-
+      # OpenVPN:
-## Metadata
+      - OPENVPN_USER=
-
+      - OPENVPN_PASSWORD=
-[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/commits)
+      # Wireguard:
-[![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)
+      # - WIREGUARD_PRIVATE_KEY=wOEI9rqqbDwnN8/Bpp22sVz48T71vJ4fYmFWujulwUU=
-
+      # - WIREGUARD_ADDRESSES=10.64.222.21/32
-[![GitHub issues](https://img.shields.io/github/issues/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues)
+      # Timezone for accurate log times
-[![GitHub closed issues](https://img.shields.io/github/issues-closed/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues?q=is%3Aissue+is%3Aclosed)
+      - TZ=
-
+      # Server list updater
-![Visitors count](https://visitor-badge.laobi.icu/badge?page_id=gluetun.readme)
+      # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/servers.md#update-the-vpn-servers-list
-![GitHub stars](https://img.shields.io/github/stars/qdm12/gluetun?style=social)
+      - UPDATER_PERIOD=
-![GitHub watchers](https://img.shields.io/github/watchers/qdm12/gluetun?style=social)
+```
-![Contributors](https://img.shields.io/github/contributors/qdm12/gluetun)
+
-![GitHub forks](https://img.shields.io/github/forks/qdm12/gluetun?style=social)
+🆕 Image also available as `ghcr.io/qdm12/gluetun`
-
+
-![Code size](https://img.shields.io/github/languages/code-size/qdm12/gluetun)
+## License
-![GitHub repo size](https://img.shields.io/github/repo-size/qdm12/gluetun)
+
-
+[![MIT](https://img.shields.io/github/license/qdm12/gluetun)](https://github.com/qdm12/gluetun/blob/master/LICENSE)
-[![dockeri.co](https://dockeri.co/image/qmcgaw/gluetun)](https://hub.docker.com/r/qmcgaw/gluetun)
-
-![Docker Layers for latest](https://img.shields.io/microbadger/layers/qmcgaw/gluetun/latest?label=Docker%20image%20layers)
-![Go version](https://img.shields.io/github/go-mod/go-version/qdm12/gluetun)

ci/cmd/main.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"os/signal"
+
+	"github.com/qdm12/gluetun/ci/internal"
+)
+
+func main() {
+	if len(os.Args) < 2 {
+		fmt.Println("Usage: " + os.Args[0] + " <command>")
+		os.Exit(1)
+	}
+
+	ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt)
+
+	var err error
+	switch os.Args[1] {
+	case "mullvad":
+		err = internal.MullvadTest(ctx)
+	default:
+		err = fmt.Errorf("unknown command: %s", os.Args[1])
+	}
+	stop()
+	if err != nil {
+		fmt.Println("❌", err)
+		os.Exit(1)
+	}
+	fmt.Println("✅ Test completed successfully.")
+}

ci/go.mod

@@ -0,0 +1,36 @@
+module github.com/qdm12/gluetun/ci
+
+go 1.25.0
+
+require (
+	github.com/docker/docker v28.5.1+incompatible
+	github.com/opencontainers/image-spec v1.1.1
+)
+
+require (
+	github.com/Microsoft/go-winio v0.6.2 // indirect
+	github.com/containerd/errdefs v1.0.0 // indirect
+	github.com/containerd/errdefs/pkg v0.3.0 // indirect
+	github.com/containerd/log v0.1.0 // indirect
+	github.com/distribution/reference v0.6.0 // indirect
+	github.com/docker/go-connections v0.6.0 // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/felixge/httpsnoop v1.0.4 // indirect
+	github.com/go-logr/logr v1.4.3 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/moby/docker-image-spec v1.3.1 // indirect
+	github.com/moby/sys/atomicwriter v0.1.0 // indirect
+	github.com/moby/term v0.5.2 // indirect
+	github.com/morikuni/aec v1.0.0 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.63.0 // indirect
+	go.opentelemetry.io/otel v1.38.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.38.0 // indirect
+	go.opentelemetry.io/otel/metric v1.38.0 // indirect
+	go.opentelemetry.io/otel/trace v1.38.0 // indirect
+	golang.org/x/sys v0.35.0 // indirect
+	golang.org/x/time v0.14.0 // indirect
+	gotest.tools/v3 v3.5.2 // indirect
+)

ci/go.sum

@@ -0,0 +1,97 @@
+github.com/Azure/go-ansiterm v0.0.0-20250102033503-faa5f7b0171c h1:udKWzYgxTojEKWjV8V+WSxDXJ4NFATAsZjh8iIbsQIg=
+github.com/Azure/go-ansiterm v0.0.0-20250102033503-faa5f7b0171c/go.mod h1:xomTg63KZ2rFqZQzSB4Vz2SUXa1BpHTVz9L5PTmPC4E=
+github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY=
+github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU=
+github.com/cenkalti/backoff/v5 v5.0.3 h1:ZN+IMa753KfX5hd8vVaMixjnqRZ3y8CuJKRKj1xcsSM=
+github.com/cenkalti/backoff/v5 v5.0.3/go.mod h1:rkhZdG3JZukswDf7f0cwqPNk4K0sa+F97BxZthm/crw=
+github.com/containerd/errdefs v1.0.0 h1:tg5yIfIlQIrxYtu9ajqY42W3lpS19XqdxRQeEwYG8PI=
+github.com/containerd/errdefs v1.0.0/go.mod h1:+YBYIdtsnF4Iw6nWZhJcqGSg/dwvV7tyJ/kCkyJ2k+M=
+github.com/containerd/errdefs/pkg v0.3.0 h1:9IKJ06FvyNlexW690DXuQNx2KA2cUJXx151Xdx3ZPPE=
+github.com/containerd/errdefs/pkg v0.3.0/go.mod h1:NJw6s9HwNuRhnjJhM7pylWwMyAkmCQvQ4GpJHEqRLVk=
+github.com/containerd/log v0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I=
+github.com/containerd/log v0.1.0/go.mod h1:VRRf09a7mHDIRezVKTRCrOq78v577GXq3bSa3EhrzVo=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/distribution/reference v0.6.0 h1:0IXCQ5g4/QMHHkarYzh5l+u8T3t73zM5QvfrDyIgxBk=
+github.com/distribution/reference v0.6.0/go.mod h1:BbU0aIcezP1/5jX/8MP0YiH4SdvB5Y4f/wlDRiLyi3E=
+github.com/docker/docker v28.5.1+incompatible h1:Bm8DchhSD2J6PsFzxC35TZo4TLGR2PdW/E69rU45NhM=
+github.com/docker/docker v28.5.1+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
+github.com/docker/go-connections v0.6.0 h1:LlMG9azAe1TqfR7sO+NJttz1gy6KO7VJBh+pMmjSD94=
+github.com/docker/go-connections v0.6.0/go.mod h1:AahvXYshr6JgfUJGdDCs2b5EZG/vmaMAntpSFH5BFKE=
+github.com/docker/go-units v0.5.0 h1:69rxXcBk27SvSaaxTtLh/8llcHD8vYHT7WSdRZ/jvr4=
+github.com/docker/go-units v0.5.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk=
+github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg=
+github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
+github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
+github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
+github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
+github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
+github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
+github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
+github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.2 h1:8Tjv8EJ+pM1xP8mK6egEbD1OgnVTyacbefKhmbLhIhU=
+github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.2/go.mod h1:pkJQ2tZHJ0aFOVEEot6oZmaVEZcRme73eIFmhiVuRWs=
+github.com/moby/docker-image-spec v1.3.1 h1:jMKff3w6PgbfSa69GfNg+zN/XLhfXJGnEx3Nl2EsFP0=
+github.com/moby/docker-image-spec v1.3.1/go.mod h1:eKmb5VW8vQEh/BAr2yvVNvuiJuY6UIocYsFu/DxxRpo=
+github.com/moby/sys/atomicwriter v0.1.0 h1:kw5D/EqkBwsBFi0ss9v1VG3wIkVhzGvLklJ+w3A14Sw=
+github.com/moby/sys/atomicwriter v0.1.0/go.mod h1:Ul8oqv2ZMNHOceF643P6FKPXeCmYtlQMvpizfsSoaWs=
+github.com/moby/sys/sequential v0.6.0 h1:qrx7XFUd/5DxtqcoH1h438hF5TmOvzC/lspjy7zgvCU=
+github.com/moby/sys/sequential v0.6.0/go.mod h1:uyv8EUTrca5PnDsdMGXhZe6CCe8U/UiTWd+lL+7b/Ko=
+github.com/moby/term v0.5.2 h1:6qk3FJAFDs6i/q3W/pQ97SX192qKfZgGjCQqfCJkgzQ=
+github.com/moby/term v0.5.2/go.mod h1:d3djjFCrjnB+fl8NJux+EJzu0msscUP+f8it8hPkFLc=
+github.com/morikuni/aec v1.0.0 h1:nP9CBfwrvYnBRgY6qfDQkygYDmYwOilePFkwzv4dU8A=
+github.com/morikuni/aec v1.0.0/go.mod h1:BbKIizmSmc5MMPqRYbxO4ZU0S0+P200+tUnFx7PXmsc=
+github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U=
+github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM=
+github.com/opencontainers/image-spec v1.1.1 h1:y0fUlFfIZhPF1W537XOLg0/fcx6zcHCJwooC2xJA040=
+github.com/opencontainers/image-spec v1.1.1/go.mod h1:qpqAh3Dmcf36wStyyWU+kCeDgrGnAve2nCC8+7h8Q0M=
+github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
+github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
+github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
+github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
+go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=
+go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=
+go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.63.0 h1:RbKq8BG0FI8OiXhBfcRtqqHcZcka+gU3cskNuf05R18=
+go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.63.0/go.mod h1:h06DGIukJOevXaj/xrNjhi/2098RZzcLTbc0jDAUbsg=
+go.opentelemetry.io/otel v1.38.0 h1:RkfdswUDRimDg0m2Az18RKOsnI8UDzppJAtj01/Ymk8=
+go.opentelemetry.io/otel v1.38.0/go.mod h1:zcmtmQ1+YmQM9wrNsTGV/q/uyusom3P8RxwExxkZhjM=
+go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.38.0 h1:GqRJVj7UmLjCVyVJ3ZFLdPRmhDUp2zFmQe3RHIOsw24=
+go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.38.0/go.mod h1:ri3aaHSmCTVYu2AWv44YMauwAQc0aqI9gHKIcSbI1pU=
+go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.38.0 h1:aTL7F04bJHUlztTsNGJ2l+6he8c+y/b//eR0jjjemT4=
+go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.38.0/go.mod h1:kldtb7jDTeol0l3ewcmd8SDvx3EmIE7lyvqbasU3QC4=
+go.opentelemetry.io/otel/metric v1.38.0 h1:Kl6lzIYGAh5M159u9NgiRkmoMKjvbsKtYRwgfrA6WpA=
+go.opentelemetry.io/otel/metric v1.38.0/go.mod h1:kB5n/QoRM8YwmUahxvI3bO34eVtQf2i4utNVLr9gEmI=
+go.opentelemetry.io/otel/sdk v1.38.0 h1:l48sr5YbNf2hpCUj/FoGhW9yDkl+Ma+LrVl8qaM5b+E=
+go.opentelemetry.io/otel/sdk v1.38.0/go.mod h1:ghmNdGlVemJI3+ZB5iDEuk4bWA3GkTpW+DOoZMYBVVg=
+go.opentelemetry.io/otel/sdk/metric v1.38.0 h1:aSH66iL0aZqo//xXzQLYozmWrXxyFkBJ6qT5wthqPoM=
+go.opentelemetry.io/otel/sdk/metric v1.38.0/go.mod h1:dg9PBnW9XdQ1Hd6ZnRz689CbtrUp0wMMs9iPcgT9EZA=
+go.opentelemetry.io/otel/trace v1.38.0 h1:Fxk5bKrDZJUH+AMyyIXGcFAPah0oRcT+LuNtJrmcNLE=
+go.opentelemetry.io/otel/trace v1.38.0/go.mod h1:j1P9ivuFsTceSWe1oY+EeW3sc+Pp42sO++GHkg4wwhs=
+go.opentelemetry.io/proto/otlp v1.7.1 h1:gTOMpGDb0WTBOP8JaO72iL3auEZhVmAQg4ipjOVAtj4=
+go.opentelemetry.io/proto/otlp v1.7.1/go.mod h1:b2rVh6rfI/s2pHWNlB7ILJcRALpcNDzKhACevjI+ZnE=
+golang.org/x/net v0.43.0 h1:lat02VYK2j4aLzMzecihNvTlJNQUq316m2Mr9rnM6YE=
+golang.org/x/net v0.43.0/go.mod h1:vhO1fvI4dGsIjh73sWfUVjj3N7CA9WkKJNQm2svM6Jg=
+golang.org/x/sys v0.35.0 h1:vz1N37gP5bs89s7He8XuIYXpyY0+QlsKmzipCbUtyxI=
+golang.org/x/sys v0.35.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng=
+golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU=
+golang.org/x/time v0.14.0 h1:MRx4UaLrDotUKUdCIqzPC48t1Y9hANFKIRpNx+Te8PI=
+golang.org/x/time v0.14.0/go.mod h1:eL/Oa2bBBK0TkX57Fyni+NgnyQQN4LitPmob2Hjnqw4=
+google.golang.org/genproto/googleapis/api v0.0.0-20250825161204-c5933d9347a5 h1:BIRfGDEjiHRrk0QKZe3Xv2ieMhtgRGeLcZQ0mIVn4EY=
+google.golang.org/genproto/googleapis/api v0.0.0-20250825161204-c5933d9347a5/go.mod h1:j3QtIyytwqGr1JUDtYXwtMXWPKsEa5LtzIFN1Wn5WvE=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20250825161204-c5933d9347a5 h1:eaY8u2EuxbRv7c3NiGK0/NedzVsCcV6hDuU5qPX5EGE=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20250825161204-c5933d9347a5/go.mod h1:M4/wBTSeyLxupu3W3tJtOgB14jILAS/XWPSSa3TAlJc=
+google.golang.org/grpc v1.75.0 h1:+TW+dqTd2Biwe6KKfhE5JpiYIBWq865PhKGSXiivqt4=
+google.golang.org/grpc v1.75.0/go.mod h1:JtPAzKiq4v1xcAB2hydNlWI2RnF85XXcV0mhKXr2ecQ=
+google.golang.org/protobuf v1.36.8 h1:xHScyCOEuuwZEc6UtSOvPbAT4zRh0xcNRYekJwfqyMc=
+google.golang.org/protobuf v1.36.8/go.mod h1:fuxRtAxBytpl4zzqUh6/eyUujkJdNiuEkXntxiD/uRU=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gotest.tools/v3 v3.5.2 h1:7koQfIKdy+I8UTetycgUqXWSDwpgv193Ka+qRsmBY8Q=
+gotest.tools/v3 v3.5.2/go.mod h1:LtdLGcnqToBH83WByAAi/wiwSFCArdFIUV/xxN4pcjA=

ci/internal/mullvad.go

@@ -0,0 +1,193 @@
+package internal
+
+import (
+	"bufio"
+	"context"
+	"fmt"
+	"io"
+	"os"
+	"regexp"
+	"strings"
+	"time"
+
+	"github.com/docker/docker/api/types/container"
+	"github.com/docker/docker/api/types/network"
+	"github.com/docker/docker/client"
+	v1 "github.com/opencontainers/image-spec/specs-go/v1"
+)
+
+func MullvadTest(ctx context.Context) error {
+	secrets, err := readSecrets(ctx)
+	if err != nil {
+		return fmt.Errorf("reading secrets: %w", err)
+	}
+
+	const timeout = 15 * time.Second
+	ctx, cancel := context.WithTimeout(ctx, timeout)
+	defer cancel()
+
+	client, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())
+	if err != nil {
+		return fmt.Errorf("creating Docker client: %w", err)
+	}
+	defer client.Close()
+
+	config := &container.Config{
+		Image:       "qmcgaw/gluetun",
+		StopTimeout: ptrTo(3),
+		Env: []string{
+			"VPN_SERVICE_PROVIDER=mullvad",
+			"VPN_TYPE=wireguard",
+			"LOG_LEVEL=debug",
+			"SERVER_COUNTRIES=USA",
+			"WIREGUARD_PRIVATE_KEY=" + secrets.mullvadWireguardPrivateKey,
+			"WIREGUARD_ADDRESSES=" + secrets.mullvadWireguardAddress,
+		},
+	}
+	hostConfig := &container.HostConfig{
+		AutoRemove: true,
+		CapAdd:     []string{"NET_ADMIN", "NET_RAW"},
+	}
+	networkConfig := (*network.NetworkingConfig)(nil)
+	platform := (*v1.Platform)(nil)
+	const containerName = "" // auto-generated name
+
+	response, err := client.ContainerCreate(ctx, config, hostConfig, networkConfig, platform, containerName)
+	if err != nil {
+		return fmt.Errorf("creating container: %w", err)
+	}
+	for _, warning := range response.Warnings {
+		fmt.Println("Warning during container creation:", warning)
+	}
+	containerID := response.ID
+	defer stopContainer(client, containerID)
+
+	beforeStartTime := time.Now()
+
+	err = client.ContainerStart(ctx, containerID, container.StartOptions{})
+	if err != nil {
+		return fmt.Errorf("starting container: %w", err)
+	}
+
+	return waitForLogLine(ctx, client, containerID, beforeStartTime)
+}
+
+func ptrTo[T any](v T) *T { return &v }
+
+type secrets struct {
+	mullvadWireguardPrivateKey string
+	mullvadWireguardAddress    string
+}
+
+func readSecrets(ctx context.Context) (secrets, error) {
+	expectedSecrets := [...]string{
+		"Mullvad Wireguard private key",
+		"Mullvad Wireguard address",
+	}
+
+	scanner := bufio.NewScanner(os.Stdin)
+	lines := make([]string, 0, len(expectedSecrets))
+
+	for i := range expectedSecrets {
+		fmt.Println("🤫 reading", expectedSecrets[i], "from Stdin...")
+		if !scanner.Scan() {
+			break
+		}
+		lines = append(lines, strings.TrimSpace(scanner.Text()))
+		if ctx.Err() != nil {
+			return secrets{}, ctx.Err()
+		}
+	}
+
+	if err := scanner.Err(); err != nil {
+		return secrets{}, fmt.Errorf("reading secrets from stdin: %w", err)
+	}
+
+	if len(lines) < len(expectedSecrets) {
+		return secrets{}, fmt.Errorf("expected %d secrets via Stdin, but only received %d",
+			len(expectedSecrets), len(lines))
+	}
+	for i, line := range lines {
+		if line == "" {
+			return secrets{}, fmt.Errorf("secret on line %d/%d was empty", i+1, len(lines))
+		}
+	}
+
+	return secrets{
+		mullvadWireguardPrivateKey: lines[0],
+		mullvadWireguardAddress:    lines[1],
+	}, nil
+}
+
+func stopContainer(client *client.Client, containerID string) {
+	const stopTimeout = 5 * time.Second // must be higher than 3s, see above [container.Config]'s StopTimeout field
+	stopCtx, stopCancel := context.WithTimeout(context.Background(), stopTimeout)
+	defer stopCancel()
+
+	err := client.ContainerStop(stopCtx, containerID, container.StopOptions{})
+	if err != nil {
+		fmt.Println("failed to stop container:", err)
+	}
+}
+
+var successRegexp = regexp.MustCompile(`^.+Public IP address is .+$`)
+
+func waitForLogLine(ctx context.Context, client *client.Client, containerID string,
+	beforeStartTime time.Time,
+) error {
+	logOptions := container.LogsOptions{
+		ShowStdout: true,
+		Follow:     true,
+		Since:      beforeStartTime.Format(time.RFC3339Nano),
+	}
+
+	reader, err := client.ContainerLogs(ctx, containerID, logOptions)
+	if err != nil {
+		return fmt.Errorf("error getting container logs: %w", err)
+	}
+	defer reader.Close()
+
+	var linesSeen []string
+	scanner := bufio.NewScanner(reader)
+	for ctx.Err() == nil {
+		if scanner.Scan() {
+			line := scanner.Text()
+			if len(line) > 8 { // remove Docker log prefix
+				line = line[8:]
+			}
+			linesSeen = append(linesSeen, line)
+			if successRegexp.MatchString(line) {
+				fmt.Println("✅ Success line logged")
+				return nil
+			}
+			continue
+		}
+		err := scanner.Err()
+		if err != nil && err != io.EOF {
+			logSeenLines(linesSeen)
+			return fmt.Errorf("reading log stream: %w", err)
+		}
+
+		// The scanner is either done or cannot read because of EOF
+		fmt.Println("The log scanner stopped")
+		logSeenLines(linesSeen)
+
+		// Check if the container is still running
+		inspect, err := client.ContainerInspect(ctx, containerID)
+		if err != nil {
+			return fmt.Errorf("inspecting container: %w", err)
+		}
+		if !inspect.State.Running {
+			return fmt.Errorf("container stopped unexpectedly while waiting for log line. Exit code: %d", inspect.State.ExitCode)
+		}
+	}
+
+	return ctx.Err()
+}
+
+func logSeenLines(lines []string) {
+	fmt.Println("Logs seen so far:")
+	for _, line := range lines {
+		fmt.Println("  " + line)
+	}
+}

cmd/gluetun/main.go

@@ -2,221 +2,318 @@ package main
 
 import (
 	"context"
+	"errors"
 	"fmt"
-	"net"
+	"io/fs"
 	"net/http"
-	nativeos "os"
+	"os"
+	"os/exec"
 	"os/signal"
 	"strings"
-	"sync"
 	"syscall"
 	"time"
+	_ "time/tzdata"
 
-	"github.com/qdm12/dns/pkg/unbound"
+	_ "github.com/breml/rootcerts"
 	"github.com/qdm12/gluetun/internal/alpine"
 	"github.com/qdm12/gluetun/internal/cli"
+	"github.com/qdm12/gluetun/internal/command"
+	"github.com/qdm12/gluetun/internal/configuration/settings"
+	"github.com/qdm12/gluetun/internal/configuration/sources/files"
+	"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"
-	gluetunLogging "github.com/qdm12/gluetun/internal/logging"
 	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/gluetun/internal/netlink"
 	"github.com/qdm12/gluetun/internal/openvpn"
-	"github.com/qdm12/gluetun/internal/params"
+	"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/routing"
 	"github.com/qdm12/gluetun/internal/server"
-	"github.com/qdm12/gluetun/internal/settings"
 	"github.com/qdm12/gluetun/internal/shadowsocks"
 	"github.com/qdm12/gluetun/internal/storage"
-	"github.com/qdm12/gluetun/internal/unix"
+	"github.com/qdm12/gluetun/internal/tun"
-	"github.com/qdm12/gluetun/internal/updater"
+	updater "github.com/qdm12/gluetun/internal/updater/loop"
-	versionpkg "github.com/qdm12/gluetun/internal/version"
+	"github.com/qdm12/gluetun/internal/updater/resolver"
-	"github.com/qdm12/golibs/command"
+	"github.com/qdm12/gluetun/internal/updater/unzip"
-	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/gluetun/internal/vpn"
-	"github.com/qdm12/golibs/os"
+	"github.com/qdm12/gosettings/reader"
-	"github.com/qdm12/golibs/os/user"
+	"github.com/qdm12/gosettings/reader/sources/env"
-	"github.com/qdm12/updated/pkg/dnscrypto"
+	"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"
 )
 
 //nolint:gochecknoglobals
 var (
-	version   = "unknown"
+	version = "unknown"
-	commit    = "unknown"
+	commit  = "unknown"
-	buildDate = "an unknown date"
+	created = "an unknown date"
 )
 
 func main() {
 	buildInfo := models.BuildInformation{
-		Version:   version,
+		Version: version,
-		Commit:    commit,
+		Commit:  commit,
-		BuildDate: buildDate,
+		Created: created,
 	}
 
-	ctx := context.Background()
+	background := context.Background()
-	ctx, cancel := context.WithCancel(ctx)
+	signalCh := make(chan os.Signal, 1)
+	signal.Notify(signalCh, os.Interrupt, syscall.SIGTERM)
+	ctx, cancel := context.WithCancel(background)
 
-	logger, err := logging.NewLogger(logging.ConsoleEncoding, logging.InfoLevel)
+	logger := log.New(log.SetLevel(log.LevelInfo))
-	if err != nil {
-		fmt.Println(err)
-		nativeos.Exit(1)
-	}
 
-	args := nativeos.Args
+	args := os.Args
-	os := os.New()
+	tun := tun.New()
-	osUser := user.New()
+	netLinkDebugLogger := logger.New(log.SetComponent("netlink"))
-	unix := unix.New()
+	netLinker := netlink.New(netLinkDebugLogger)
 	cli := cli.New()
+	cmder := command.New()
+
+	reader := reader.New(reader.Settings{
+		Sources: []reader.Source{
+			secrets.New(logger),
+			files.New(logger),
+			env.New(env.Settings{}),
+		},
+		HandleDeprecatedKey: func(source, deprecatedKey, currentKey string) {
+			logger.Warn("You are using the old " + source + " " + deprecatedKey +
+				", please consider changing it to " + currentKey)
+		},
+	})
 
 	errorCh := make(chan error)
 	go func() {
-		errorCh <- _main(ctx, buildInfo, args, logger, os, osUser, unix, cli)
+		errorCh <- _main(ctx, buildInfo, args, logger, reader, tun, netLinker, cmder, cli)
 	}()
 
-	signalsCh := make(chan nativeos.Signal, 1)
+	// Wait for OS signal or run error
-	signal.Notify(signalsCh,
+	var err error
-		syscall.SIGINT,
-		syscall.SIGTERM,
-		nativeos.Interrupt,
-	)
-
 	select {
-	case signal := <-signalsCh:
+	case receivedSignal := <-signalCh:
-		logger.Warn("Caught OS signal %s, shutting down", signal)
+		signal.Stop(signalCh)
-	case err := <-errorCh:
+		fmt.Println("")
+		logger.Warn("Caught OS signal " + receivedSignal.String() + ", shutting down")
+		cancel()
+	case err = <-errorCh:
 		close(errorCh)
 		if err == nil { // expected exit such as healthcheck
-			nativeos.Exit(0)
+			os.Exit(0)
 		}
-		logger.Error(err)
+		logger.Error(err.Error())
+		cancel()
 	}
 
-	cancel()
+	// Shutdown timed sequence, and force exit on second OS signal
-
 	const shutdownGracePeriod = 5 * time.Second
 	timer := time.NewTimer(shutdownGracePeriod)
 	select {
-	case <-errorCh:
+	case shutdownErr := <-errorCh:
-		if !timer.Stop() {
+		timer.Stop()
-			<-timer.C
+		if shutdownErr != nil {
+			logger.Warnf("Shutdown failed: %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)
 	}
-
-	nativeos.Exit(1)
 }
 
-//nolint:gocognit,gocyclo
+var errCommandUnknown = errors.New("command is unknown")
-func _main(background context.Context, buildInfo models.BuildInformation,
+
-	args []string, logger logging.Logger, os os.OS, osUser user.OSUser, unix unix.Unix,
+//nolint:gocognit,gocyclo,maintidx
-	cli cli.CLI) error {
+func _main(ctx context.Context, buildInfo models.BuildInformation,
+	args []string, logger log.LoggerInterface, reader *reader.Reader,
+	tun Tun, netLinker netLinker, cmder RunStarter,
+	cli clier,
+) error {
 	if len(args) > 1 { // cli operation
 		switch args[1] {
 		case "healthcheck":
-			return cli.HealthCheck(background)
+			return cli.HealthCheck(ctx, reader, logger)
 		case "clientkey":
-			return cli.ClientKey(args[2:], os.OpenFile)
+			return cli.ClientKey(args[2:])
 		case "openvpnconfig":
-			return cli.OpenvpnConfig(os)
+			return cli.OpenvpnConfig(logger, reader, netLinker)
 		case "update":
-			return cli.Update(args[2:], os)
+			return cli.Update(ctx, args[2:], logger)
+		case "format-servers":
+			return cli.FormatServers(args[2:])
+		case "genkey":
+			return cli.GenKey(args[2:])
 		default:
-			return fmt.Errorf("command %q is unknown", args[1])
+			return fmt.Errorf("%w: %s", errCommandUnknown, args[1])
 		}
 	}
-	ctx, cancel := context.WithCancel(background)
+
-	defer cancel()
+	announcementExp, err := time.Parse(time.RFC3339, "2024-12-01T00:00:00Z")
+	if err != nil {
+		return err
+	}
+	splashSettings := gosplash.Settings{
+		User:         "qdm12",
+		Repository:   "gluetun",
+		Emails:       []string{"quentin.mcgaw@gmail.com"},
+		Version:      buildInfo.Version,
+		Commit:       buildInfo.Commit,
+		Created:      buildInfo.Created,
+		Announcement: "All control server routes will become private by default after the v3.41.0 release",
+		AnnounceExp:  announcementExp,
+		// Sponsor information
+		PaypalUser:    "qmcgaw",
+		GithubSponsor: "qdm12",
+	}
+	for _, line := range gosplash.MakeLines(splashSettings) {
+		fmt.Println(line)
+	}
+
+	var allSettings settings.Settings
+	err = allSettings.Read(reader, logger)
+	if err != nil {
+		return err
+	}
+	allSettings.SetDefaults()
+
+	// Note: no need to validate minimal settings for the firewall:
+	// - global log level is parsed below
+	// - firewall Debug and Enabled are booleans parsed from source
+	logLevel, err := log.ParseLevel(allSettings.Log.Level)
+	if err != nil {
+		return fmt.Errorf("log level: %w", err)
+	}
+	logger.Patch(log.SetLevel(logLevel))
+	netLinker.PatchLoggerLevel(logLevel)
+
+	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, *allSettings.Storage.Filepath)
+	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, logger)
+	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.NewConfigurator(os.OpenFile, osUser)
+	alpineConf := alpine.New()
-	ovpnConf := openvpn.NewConfigurator(logger, os, unix)
+	ovpnConf := openvpn.New(
-	dnsCrypto := dnscrypto.New(httpClient, "", "")
+		logger.New(log.SetComponent("openvpn configurator")),
-	const cacertsPath = "/etc/ssl/certs/ca-certificates.crt"
+		cmder, puid, pgid)
-	dnsConf := unbound.NewConfigurator(logger, os.OpenFile, dnsCrypto,
-		"/etc/unbound", "/usr/sbin/unbound", cacertsPath)
-	routingConf := routing.NewRouting(logger)
-	firewallConf := firewall.NewConfigurator(logger, routingConf, os.OpenFile)
-	streamMerger := command.NewStreamMerger()
 
-	paramsReader := params.NewReader(logger, os)
+	err = printVersions(ctx, logger, []printVersionElement{
-	fmt.Println(gluetunLogging.Splash(buildInfo))
+		{name: "Alpine", getVersion: alpineConf.Version},
-
+		{name: "OpenVPN 2.5", getVersion: ovpnConf.Version25},
-	printVersions(ctx, logger, map[string]func(ctx context.Context) (string, error){
+		{name: "OpenVPN 2.6", getVersion: ovpnConf.Version26},
-		"OpenVPN":  ovpnConf.Version,
+		{name: "IPtables", getVersion: firewallConf.Version},
-		"Unbound":  dnsConf.Version,
-		"IPtables": firewallConf.Version,
 	})
-
-	allSettings, err := settings.GetAllSettings(paramsReader)
 	if err != nil {
 		return err
 	}
+
 	logger.Info(allSettings.String())
 
-	if err := os.MkdirAll("/tmp/gluetun", 0644); err != nil {
+	for _, warning := range allSettings.Warnings() {
-		return err
+		logger.Warn(warning)
-	}
-	if err := os.MkdirAll("/gluetun", 0644); err != nil {
-		return err
 	}
 
-	// TODO run this in a loop or in openvpn to reload from file without restarting
+	const permission = fs.FileMode(0o644)
-	storage := storage.New(logger, os, constants.ServersData)
+	err = os.MkdirAll("/tmp/gluetun", permission)
-	allServers, err := storage.SyncServers(constants.GetAllServers())
+	if err != nil {
+		return err
+	}
+	err = os.MkdirAll("/gluetun", permission)
 	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 err
+		return fmt.Errorf("creating user: %w", err)
 	}
 	if nonRootUsername != defaultUsername {
-		logger.Info("using existing username %s corresponding to user id %d", nonRootUsername, puid)
+		logger.Info("using existing username " + nonRootUsername + " corresponding to user id " + fmt.Sprint(puid))
 	}
-
+	allSettings.VPN.OpenVPN.ProcessUser = nonRootUsername
-	if err := os.Chown("/etc/unbound", puid, pgid); err != nil {
-		return err
-	}
-
-	if allSettings.Firewall.Debug {
-		firewallConf.SetDebug()
-		routingConf.SetDebug()
-	}
-
-	defaultInterface, defaultGateway, err := routingConf.DefaultRoute()
-	if err != nil {
-		return err
-	}
-
-	localSubnet, err := routingConf.LocalSubnet()
-	if err != nil {
-		return err
-	}
-
-	defaultIP, err := routingConf.DefaultIP()
-	if err != nil {
-		return err
-	}
-
-	firewallConf.SetNetworkInformation(defaultInterface, defaultGateway, localSubnet, defaultIP)
 
 	if err := routingConf.Setup(); err != nil {
-		return err
+		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)
 	}
 	defer func() {
-		routingConf.SetVerbose(false)
+		routingLogger.Info("routing cleanup...")
 		if err := routingConf.TearDown(); err != nil {
-			logger.Error(err)
+			routingLogger.Error("cannot teardown routing: " + err.Error())
 		}
 	}()
 
@@ -227,217 +324,281 @@ func _main(background context.Context, buildInfo models.BuildInformation,
 		return err
 	}
 
-	if err := ovpnConf.CheckTUN(); err != nil {
+	err = routingConf.AddLocalRules(localNetworks)
-		logger.Warn(err)
+	if err != nil {
-		err = ovpnConf.CreateTUN()
+		return fmt.Errorf("adding local rules: %w", err)
-		if err != nil {
-			return err
-		}
 	}
 
-	tunnelReadyCh := make(chan struct{})
+	const tunDevice = "/dev/net/tun"
-	dnsReadyCh := make(chan struct{})
+	err = tun.Check(tunDevice)
-	defer close(tunnelReadyCh)
+	if err != nil {
-	defer close(dnsReadyCh)
+		if !errors.Is(err, os.ErrNotExist) {
-
+			return fmt.Errorf("checking TUN device: %w (see the Wiki errors/tun page)", err)
-	if allSettings.Firewall.Enabled {
-		err := firewallConf.SetEnabled(ctx, true) // disabled by default
-		if err != nil {
-			return err
 		}
-	}
+		logger.Info(err.Error() + "; creating it...")
-
+		err = tun.Create(tunDevice)
-	for _, vpnPort := range allSettings.Firewall.VPNInputPorts {
-		err = firewallConf.SetAllowedPort(ctx, vpnPort, string(constants.TUN))
 		if err != nil {
-			return err
+			return fmt.Errorf("creating tun device: %w", err)
 		}
 	}
 
 	for _, port := range allSettings.Firewall.InputPorts {
-		err = firewallConf.SetAllowedPort(ctx, port, defaultInterface)
+		for _, defaultRoute := range defaultRoutes {
-		if err != nil {
+			err = firewallConf.SetAllowedPort(ctx, port, defaultRoute.NetInterface)
-			return err
+			if err != nil {
+				return err
+			}
 		}
 	} // TODO move inside firewall?
 
-	wg := &sync.WaitGroup{}
+	// Shutdown settings
-
+	const totalShutdownTimeout = 3 * time.Second
-	wg.Add(1)
+	const defaultShutdownTimeout = 400 * time.Millisecond
-	go collectStreamLines(ctx, wg, streamMerger, logger, tunnelReadyCh)
+	defaultShutdownOnSuccess := func(goRoutineName string) {
-
+		logger.Info(goRoutineName + ": terminated ✔️")
-	openvpnLooper := openvpn.NewLooper(allSettings.OpenVPN, nonRootUsername, puid, pgid, allServers,
+	}
-		ovpnConf, firewallConf, routingConf, logger, httpClient, os.OpenFile, streamMerger, cancel)
+	defaultShutdownOnFailure := func(goRoutineName string, err error) {
-	wg.Add(1)
+		logger.Warn(goRoutineName + ": " + err.Error() + " ⚠️")
-	// wait for restartOpenvpn
+	}
-	go openvpnLooper.Run(ctx, wg)
+	defaultGroupOptions := []group.Option{
-
+		group.OptionTimeout(defaultShutdownTimeout),
-	updaterLooper := updater.NewLooper(allSettings.Updater,
+		group.OptionOnSuccess(defaultShutdownOnSuccess),
-		allServers, storage, openvpnLooper.SetServers, httpClient, logger)
-	wg.Add(1)
-	// wait for updaterLooper.Restart() or its ticket launched with RunRestartTicker
-	go updaterLooper.Run(ctx, wg)
-
-	unboundLooper := dns.NewLooper(dnsConf, allSettings.DNS, httpClient,
-		logger, streamMerger, nonRootUsername, puid, pgid)
-	wg.Add(1)
-	// wait for unboundLooper.Restart or its ticker launched with RunRestartTicker
-	go unboundLooper.Run(ctx, wg, dnsReadyCh)
-
-	publicIPLooper := publicip.NewLooper(
-		httpClient, logger, allSettings.PublicIP, puid, pgid, os)
-	wg.Add(1)
-	go publicIPLooper.Run(ctx, wg)
-	wg.Add(1)
-	go publicIPLooper.RunRestartTicker(ctx, wg)
-
-	httpProxyLooper := httpproxy.NewLooper(logger, allSettings.HTTPProxy)
-	wg.Add(1)
-	go httpProxyLooper.Run(ctx, wg)
-
-	shadowsocksLooper := shadowsocks.NewLooper(allSettings.ShadowSocks, logger)
-	wg.Add(1)
-	go shadowsocksLooper.Run(ctx, wg)
-
-	wg.Add(1)
-	go routeReadyEvents(ctx, wg, buildInfo, tunnelReadyCh, dnsReadyCh,
-		unboundLooper, updaterLooper, publicIPLooper, routingConf, logger, httpClient,
-		allSettings.VersionInformation, allSettings.OpenVPN.Provider.PortForwarding.Enabled, openvpnLooper.PortForward,
-	)
-	controlServerAddress := fmt.Sprintf("0.0.0.0:%d", allSettings.ControlServer.Port)
-	controlServerLogging := allSettings.ControlServer.Log
-	httpServer := server.New(controlServerAddress, controlServerLogging,
-		logger, buildInfo, openvpnLooper, unboundLooper, updaterLooper, publicIPLooper)
-	wg.Add(1)
-	go httpServer.Run(ctx, wg)
-
-	healthcheckServer := healthcheck.NewServer(
-		constants.HealthcheckAddress, logger)
-	wg.Add(1)
-	go healthcheckServer.Run(ctx, wg)
-
-	// Start openvpn for the first time in a blocking call
-	// until openvpn is launched
-	_, _ = openvpnLooper.SetStatus(constants.Running) // TODO option to disable with variable
-
-	<-ctx.Done()
-
-	if allSettings.OpenVPN.Provider.PortForwarding.Enabled {
-		logger.Info("Clearing forwarded port status file %s", allSettings.OpenVPN.Provider.PortForwarding.Filepath)
-		if err := os.Remove(string(allSettings.OpenVPN.Provider.PortForwarding.Filepath)); err != nil {
-			logger.Error(err)
-		}
 	}
 
-	wg.Wait()
+	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"))
+	portForwardLooper := portforward.NewLoop(allSettings.VPN.Provider.PortForwarding,
+		routingConf, httpClient, firewallConf, portForwardLogger, cmder, puid, pgid)
+	portForwardRunError, err := portForwardLooper.Start(ctx)
+	if err != nil {
+		return fmt.Errorf("starting port forwarding loop: %w", err)
+	}
+
+	dnsLogger := logger.New(log.SetComponent("dns"))
+	dnsLooper, err := dns.NewLoop(allSettings.DNS, httpClient,
+		dnsLogger)
+	if err != nil {
+		return fmt.Errorf("creating DNS loop: %w", err)
+	}
+
+	dnsHandler, dnsCtx, dnsDone := goshutdown.NewGoRoutineHandler(
+		"dns", goroutine.OptionTimeout(defaultShutdownTimeout))
+	// wait for dnsLooper.Restart or its ticker launched with RunRestartTicker
+	go dnsLooper.Run(dnsCtx, dnsDone)
+	otherGroupHandler.Add(dnsHandler)
+
+	dnsTickerHandler, dnsTickerCtx, dnsTickerDone := goshutdown.NewGoRoutineHandler(
+		"dns ticker", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go dnsLooper.RunRestartTicker(dnsTickerCtx, dnsTickerDone)
+	controlGroupHandler.Add(dnsTickerHandler)
+
+	publicIPLooper, err := publicip.NewLoop(allSettings.PublicIP, puid, pgid, httpClient,
+		logger.New(log.SetComponent("ip getter")))
+	if err != nil {
+		return fmt.Errorf("creating public ip loop: %w", err)
+	}
+	publicIPRunError, err := publicIPLooper.Start(ctx)
+	if err != nil {
+		return fmt.Errorf("starting public ip loop: %w", err)
+	}
+
+	healthLogger := logger.New(log.SetComponent("healthcheck"))
+	healthcheckServer := healthcheck.NewServer(allSettings.Health, healthLogger)
+	healthServerHandler, healthServerCtx, healthServerDone := goshutdown.NewGoRoutineHandler(
+		"HTTP health server", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go healthcheckServer.Run(healthServerCtx, healthServerDone)
+	healthChecker := healthcheck.NewChecker(healthLogger)
+
+	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, publicIPLooper.Fetcher(), openvpnFileExtractor)
+
+	vpnLogger := logger.New(log.SetComponent("vpn"))
+	vpnLooper := vpn.NewLoop(allSettings.VPN, ipv6Supported, allSettings.Firewall.VPNInputPorts,
+		providers, storage, allSettings.Health, healthChecker, healthcheckServer, ovpnConf, netLinker, firewallConf,
+		routingConf, portForwardLooper, cmder, publicIPLooper, dnsLooper, 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))
+	// wait for updaterLooper.Restart() or its ticket launched with RunRestartTicker
+	go updaterLooper.Run(updaterCtx, updaterDone)
+	tickersGroupHandler.Add(updaterHandler)
+
+	updaterTickerHandler, updaterTickerCtx, updaterTickerDone := goshutdown.NewGoRoutineHandler(
+		"updater ticker", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go updaterLooper.RunRestartTicker(updaterTickerCtx, updaterTickerDone)
+	controlGroupHandler.Add(updaterTickerHandler)
+
+	httpProxyLooper := httpproxy.NewLoop(
+		logger.New(log.SetComponent("http proxy")),
+		allSettings.HTTPProxy)
+	httpProxyHandler, httpProxyCtx, httpProxyDone := goshutdown.NewGoRoutineHandler(
+		"http proxy", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go httpProxyLooper.Run(httpProxyCtx, httpProxyDone)
+	otherGroupHandler.Add(httpProxyHandler)
+
+	shadowsocksLooper := shadowsocks.NewLoop(allSettings.Shadowsocks,
+		logger.New(log.SetComponent("shadowsocks")))
+	shadowsocksHandler, shadowsocksCtx, shadowsocksDone := goshutdown.NewGoRoutineHandler(
+		"shadowsocks proxy", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go shadowsocksLooper.Run(shadowsocksCtx, shadowsocksDone)
+	otherGroupHandler.Add(shadowsocksHandler)
+
+	controlServerAddress := *allSettings.ControlServer.Address
+	controlServerLogging := *allSettings.ControlServer.Log
+	httpServerHandler, httpServerCtx, httpServerDone := goshutdown.NewGoRoutineHandler(
+		"http server", goroutine.OptionTimeout(defaultShutdownTimeout))
+	httpServer, err := server.New(httpServerCtx, controlServerAddress, controlServerLogging,
+		logger.New(log.SetComponent("http server")),
+		allSettings.ControlServer.AuthFilePath,
+		buildInfo, vpnLooper, portForwardLooper, dnsLooper, updaterLooper, publicIPLooper,
+		storage, ipv6Supported)
+	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)
+
+	orderHandler := goshutdown.NewOrderHandler("gluetun",
+		order.OptionTimeout(totalShutdownTimeout),
+		order.OptionOnSuccess(defaultShutdownOnSuccess),
+		order.OptionOnFailure(defaultShutdownOnFailure))
+	orderHandler.Append(controlGroupHandler, tickersGroupHandler, healthServerHandler,
+		vpnHandler, otherGroupHandler)
+
+	// Start VPN for the first time in a blocking call
+	// until the VPN is launched
+	_, _ = vpnLooper.ApplyStatus(ctx, constants.Running) // TODO option to disable with variable
+
+	select {
+	case <-ctx.Done():
+		stoppers := []interface {
+			String() string
+			Stop() 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())
+}
+
+type printVersionElement struct {
+	name       string
+	getVersion func(ctx context.Context) (version string, err error)
+}
+
+type infoer interface {
+	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)
+	defer cancel()
+
+	for _, element := range elements {
+		version, err := element.getVersion(ctx)
+		if err != nil {
+			return fmt.Errorf("getting %s version: %w", element.name, err)
+		}
+		logger.Info(element.name + " version: " + version)
+	}
 
 	return nil
 }
 
-func printVersions(ctx context.Context, logger logging.Logger,
+type netLinker interface {
-	versionFunctions map[string]func(ctx context.Context) (string, error)) {
+	Addresser
-	const timeout = 5 * time.Second
+	Router
-	ctx, cancel := context.WithTimeout(ctx, timeout)
+	Ruler
-	defer cancel()
+	Linker
-	for name, f := range versionFunctions {
+	IsWireguardSupported() (ok bool, err error)
-		version, err := f(ctx)
+	IsIPv6Supported() (ok bool, err error)
-		if err != nil {
+	PatchLoggerLevel(level log.Level)
-			logger.Error(err)
-		} else {
-			logger.Info("%s version: %s", name, version)
-		}
-	}
 }
 
-func collectStreamLines(ctx context.Context, wg *sync.WaitGroup,
+type Addresser interface {
-	streamMerger command.StreamMerger,
+	AddrList(link netlink.Link, family int) (
-	logger logging.Logger, tunnelReadyCh chan<- struct{}) {
+		addresses []netlink.Addr, err error)
-	defer wg.Done()
+	AddrReplace(link netlink.Link, addr netlink.Addr) error
-	// Blocking line merging paramsReader for openvpn and unbound
-	logger.Info("Launching standard output merger")
-	streamMerger.CollectLines(ctx, func(line string) {
-		line, level := gluetunLogging.PostProcessLine(line)
-		if line == "" {
-			return
-		}
-		switch level {
-		case logging.DebugLevel:
-			logger.Debug(line)
-		case logging.InfoLevel:
-			logger.Info(line)
-		case logging.WarnLevel:
-			logger.Warn(line)
-		case logging.ErrorLevel:
-			logger.Error(line)
-		}
-		switch {
-		case strings.Contains(line, "Initialization Sequence Completed"):
-			tunnelReadyCh <- struct{}{}
-		case strings.Contains(line, "TLS Error: TLS key negotiation failed to occur within 60 seconds (check your network connectivity)"): //nolint:lll
-			logger.Warn("This means that either...")
-			logger.Warn("1. The VPN server IP address you are trying to connect to is no longer valid, see https://github.com/qdm12/gluetun/wiki/Update-servers-information") //nolint:lll
-			logger.Warn("2. The VPN server crashed, try changing region")
-			logger.Warn("3. Your Internet connection is not working, ensure it works")
-			logger.Warn("Feel free to create an issue at https://github.com/qdm12/gluetun/issues/new/choose")
-		}
-	}, func(err error) {
-		logger.Warn(err)
-	})
 }
 
-func routeReadyEvents(ctx context.Context, wg *sync.WaitGroup, buildInfo models.BuildInformation,
+type Router interface {
-	tunnelReadyCh, dnsReadyCh <-chan struct{},
+	RouteList(family int) (routes []netlink.Route, err error)
-	unboundLooper dns.Looper, updaterLooper updater.Looper, publicIPLooper publicip.Looper,
+	RouteAdd(route netlink.Route) error
-	routing routing.Routing, logger logging.Logger, httpClient *http.Client,
+	RouteDel(route netlink.Route) error
-	versionInformation, portForwardingEnabled bool, startPortForward func(vpnGateway net.IP)) {
+	RouteReplace(route netlink.Route) error
-	defer wg.Done()
+}
-	tickerWg := &sync.WaitGroup{}
+
-	// for linters only
+type Ruler interface {
-	var restartTickerContext context.Context
+	RuleList(family int) (rules []netlink.Rule, err error)
-	var restartTickerCancel context.CancelFunc = func() {}
+	RuleAdd(rule netlink.Rule) error
-	for {
+	RuleDel(rule netlink.Rule) error
-		select {
+}
-		case <-ctx.Done():
+
-			restartTickerCancel() // for linters only
+type Linker interface {
-			tickerWg.Wait()
+	LinkList() (links []netlink.Link, err error)
-			return
+	LinkByName(name string) (link netlink.Link, err error)
-		case <-tunnelReadyCh: // blocks until openvpn is connected
+	LinkByIndex(index int) (link netlink.Link, err error)
-			if unboundLooper.GetSettings().Enabled {
+	LinkAdd(link netlink.Link) (linkIndex int, err error)
-				_, _ = unboundLooper.SetStatus(constants.Running)
+	LinkDel(link netlink.Link) (err error)
-			}
+	LinkSetUp(link netlink.Link) (linkIndex int, err error)
-			restartTickerCancel() // stop previous restart tickers
+	LinkSetDown(link netlink.Link) (err error)
-			tickerWg.Wait()
+}
-			restartTickerContext, restartTickerCancel = context.WithCancel(ctx)
+
-			tickerWg.Add(2) //nolint:gomnd
+type clier interface {
-			go unboundLooper.RunRestartTicker(restartTickerContext, tickerWg)
+	ClientKey(args []string) error
-			go updaterLooper.RunRestartTicker(restartTickerContext, tickerWg)
+	FormatServers(args []string) error
-			vpnDestination, err := routing.VPNDestinationIP()
+	OpenvpnConfig(logger cli.OpenvpnConfigLogger, reader *reader.Reader, ipv6Checker cli.IPv6Checker) error
-			if err != nil {
+	HealthCheck(ctx context.Context, reader *reader.Reader, warner cli.Warner) error
-				logger.Warn(err)
+	Update(ctx context.Context, args []string, logger cli.UpdaterLogger) error
-			} else {
+	GenKey(args []string) error
-				logger.Info("VPN routing IP address: %s", vpnDestination)
+}
-			}
+
-			if portForwardingEnabled {
+type Tun interface {
-				// vpnGateway required only for PIA
+	Check(tunDevice string) error
-				vpnGateway, err := routing.VPNLocalGatewayIP()
+	Create(tunDevice string) error
-				if err != nil {
+}
-					logger.Error(err)
+
-				}
+type RunStarter interface {
-				logger.Info("VPN gateway IP address: %s", vpnGateway)
+	Run(cmd *exec.Cmd) (output string, err error)
-				startPortForward(vpnGateway)
+	Start(cmd *exec.Cmd) (stdoutLines, stderrLines <-chan string,
-			}
+		waitError <-chan error, err error)
-		case <-dnsReadyCh:
-			// Runs the Public IP getter job once
-			_, _ = publicIPLooper.SetStatus(constants.Running)
-			if !versionInformation {
-				break
-			}
-			message, err := versionpkg.GetMessage(ctx, buildInfo, httpClient)
-			if err != nil {
-				logger.Error(err)
-				break
-			}
-			logger.Info(message)
-		}
-	}
 }

docker-compose.yml

@@ -1,31 +0,0 @@
-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
-    secrets:
-      - openvpn_user
-      - openvpn_password
-    environment:
-      # More variables are available, see the readme table
-      - VPNSP=private internet access
-      # Timezone for accurate logs times
-      - TZ=
-    restart: always
-
-secrets:
-  openvpn_user:
-    file: ./openvpn_user
-  openvpn_password:
-    file: ./openvpn_password

go.mod

@@ -1,16 +1,62 @@
 module github.com/qdm12/gluetun
 
-go 1.15
+go 1.25.0
 
 require (
-	github.com/fatih/color v1.10.0
+	github.com/breml/rootcerts v0.3.2
-	github.com/golang/mock v1.4.4
+	github.com/fatih/color v1.18.0
-	github.com/kyokomi/emoji v2.2.4+incompatible
+	github.com/golang/mock v1.6.0
-	github.com/qdm12/dns v1.4.0-rc4
+	github.com/klauspost/compress v1.17.11
-	github.com/qdm12/golibs v0.0.0-20210102020307-17bc97def973
+	github.com/klauspost/pgzip v1.2.6
-	github.com/qdm12/ss-server v0.1.0
+	github.com/pelletier/go-toml/v2 v2.2.3
-	github.com/qdm12/updated v0.0.0-20210102005021-dd457d77f94a
+	github.com/qdm12/dns/v2 v2.0.0-rc8
-	github.com/stretchr/testify v1.6.1
+	github.com/qdm12/gosettings v0.4.4
-	github.com/vishvananda/netlink v1.1.0
+	github.com/qdm12/goshutdown v0.3.0
-	golang.org/x/sys v0.0.0-20201223074533-0d417f636930
+	github.com/qdm12/gosplash v0.2.0
+	github.com/qdm12/gotree v0.3.0
+	github.com/qdm12/log v0.1.0
+	github.com/qdm12/ss-server v0.6.0
+	github.com/stretchr/testify v1.10.0
+	github.com/ulikunitz/xz v0.5.15
+	github.com/vishvananda/netlink v1.3.1
+	github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a
+	golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c
+	golang.org/x/net v0.46.0
+	golang.org/x/sys v0.37.0
+	golang.org/x/text v0.30.0
+	golang.zx2c4.com/wireguard v0.0.0-20231211153847-12269c276173
+	golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230429144221-925a1e7659e6
+	gopkg.in/ini.v1 v1.67.0
+)
+
+require (
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/josharian/native v1.1.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.3.2 // indirect
+	github.com/mdlayher/netlink v1.7.2 // indirect
+	github.com/mdlayher/socket v0.4.1 // indirect
+	github.com/miekg/dns v1.1.62 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/prometheus/client_golang v1.20.5 // indirect
+	github.com/prometheus/client_model v0.6.1 // indirect
+	github.com/prometheus/common v0.60.1 // indirect
+	github.com/prometheus/procfs v0.15.1 // indirect
+	github.com/qdm12/goservices v0.1.0 // indirect
+	github.com/riobard/go-bloom v0.0.0-20200614022211-cdc8013cb5b3 // indirect
+	github.com/vishvananda/netns v0.0.5 // indirect
+	golang.org/x/crypto v0.43.0 // indirect
+	golang.org/x/mod v0.28.0 // indirect
+	golang.org/x/sync v0.17.0 // indirect
+	golang.org/x/tools v0.37.0 // indirect
+	golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2 // indirect
+	google.golang.org/protobuf v1.35.1 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	kernel.org/pub/linux/libs/security/libcap/cap v1.2.70 // indirect
+	kernel.org/pub/linux/libs/security/libcap/psx v1.2.70 // indirect
 )

go.sum

@@ -1,188 +1,152 @@
-github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
+github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
-github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
-github.com/PuerkitoBio/purell v1.1.0 h1:rmGxhojJlM0tuKtfdvliR84CFHljx9ag64t2xmVkjK4=
+github.com/breml/rootcerts v0.3.2 h1:gm11iClhK8wFn/GDdINoDaqPkiaGXyVvSwoXINZN+z4=
-github.com/PuerkitoBio/purell v1.1.0/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0=
+github.com/breml/rootcerts v0.3.2/go.mod h1:S/PKh+4d1HUn4HQovEB8hPJZO6pUZYrIhmXBhsegfXw=
-github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 h1:d+Bc7a5rLufV/sSk/8dngufqelfh6jnri85riMAaF/M=
+github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
-github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE=
+github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
-github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs=
-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 h1:eg0MeVzsP1G42dRafH3vf+al2vQIJU0YHX+1Tw87oco=
-github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY=
-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=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/docker/go-units v0.3.3/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk=
+github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM=
-github.com/emirpasic/gods v1.12.0/go.mod h1:YfzfFFoVP/catgzJb4IKIqXjX78Ha8FMSDh3ymbK86o=
+github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU=
-github.com/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s=
+github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc=
-github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU=
+github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs=
-github.com/fatih/color v1.10.0 h1:s36xzo75JdqLaaWoiEHk767eHiwo0598uUxyfiPkDsg=
+github.com/google/btree v1.0.1 h1:gK4Kx5IaGY9CD5sPJ36FHiBJ6ZXl0kilRiiCj+jdYp4=
-github.com/fatih/color v1.10.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM=
+github.com/google/btree v1.0.1/go.mod h1:xXMiIv4Fb/0kKde4SpL7qlzvu5cMJDRkFDxJfI9uaxA=
-github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
-github.com/gliderlabs/ssh v0.2.2/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aevW3Awn0=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
-github.com/globalsign/mgo v0.0.0-20180905125535-1ca0a4f7cbcb h1:D4uzjWwKYQ5XnAvUbuvHW93esHg7F8N/OYeBBcJoTr0=
+github.com/josharian/native v1.1.0 h1:uuaP0hAbW7Y4l0ZRQ6C9zfb7Mg1mbFKry/xzDAfmtLA=
-github.com/globalsign/mgo v0.0.0-20180905125535-1ca0a4f7cbcb/go.mod h1:xkRDCp4j0OGD1HRkm4kmhM+pmpv3AKq5SU7GMg4oO/Q=
+github.com/josharian/native v1.1.0/go.mod h1:7X/raswPFr05uY3HiLlYeyQntB6OO7E/d2Cu7qoaN2w=
-github.com/go-openapi/analysis v0.0.0-20180825180245-b006789cd277/go.mod h1:k70tL6pCuVxPJOHXQ+wIac1FUrvNkHolPie/cLEU6hI=
+github.com/klauspost/compress v1.17.11 h1:In6xLpyWOi1+C7tXUUWv2ot1QvBjxevKAaI6IXrJmUc=
-github.com/go-openapi/analysis v0.17.0 h1:8JV+dzJJiK46XqGLqqLav8ZfEiJECp8jlOFhpiCdZ+0=
+github.com/klauspost/compress v1.17.11/go.mod h1:pMDklpSncoRMuLFrf1W9Ss9KT+0rH90U12bZKk7uwG0=
-github.com/go-openapi/analysis v0.17.0/go.mod h1:IowGgpVeD0vNm45So8nr+IcQ3pxVtpRoBWb8PVZO0ik=
+github.com/klauspost/pgzip v1.2.6 h1:8RXeL5crjEUFnR2/Sn6GJNWtSQ3Dk8pq4CL3jvdDyjU=
-github.com/go-openapi/errors v0.17.0/go.mod h1:LcZQpmvG4wyF5j4IhA73wkLFQg+QJXOQHVjmcZxhka0=
+github.com/klauspost/pgzip v1.2.6/go.mod h1:Ch1tH69qFZu15pkjo5kYi6mth2Zzwzt50oCQKQE9RUs=
-github.com/go-openapi/errors v0.17.2 h1:azEQ8Fnx0jmtFF2fxsnmd6I0x6rsweUF63qqSO1NmKk=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
-github.com/go-openapi/errors v0.17.2/go.mod h1:LcZQpmvG4wyF5j4IhA73wkLFQg+QJXOQHVjmcZxhka0=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
-github.com/go-openapi/jsonpointer v0.17.0 h1:nH6xp8XdXHx8dqveo0ZuJBluCO2qGrPbDNZ0dwoRHP0=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
-github.com/go-openapi/jsonpointer v0.17.0/go.mod h1:cOnomiV+CVVwFLk0A/MExoFMjwdsUdVpsRhURCKh+3M=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
-github.com/go-openapi/jsonreference v0.17.0 h1:yJW3HCkTHg7NOA+gZ83IPHzUSnUzGXhGmsdiCcMexbA=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
-github.com/go-openapi/jsonreference v0.17.0/go.mod h1:g4xxGn04lDIRh0GJb5QlpE3HfopLOL6uZrK/VgnsK9I=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
-github.com/go-openapi/loads v0.17.0 h1:H22nMs3GDQk4SwAaFQ+jLNw+0xoFeCueawhZlv8MBYs=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
-github.com/go-openapi/loads v0.17.0/go.mod h1:72tmFy5wsWx89uEVddd0RjRWPZm92WRLhf7AC+0+OOU=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
-github.com/go-openapi/runtime v0.0.0-20180920151709-4f900dc2ade9/go.mod h1:6v9a6LTXWQCdL8k1AO3cvqx5OtZY/Y9wKTgaoP6YRfA=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
-github.com/go-openapi/runtime v0.17.2 h1:/ZK67ikFhQAMFFH/aPu2MaGH7QjP4wHBvHYOVIzDAw0=
+github.com/mdlayher/genetlink v1.3.2 h1:KdrNKe+CTu+IbZnm/GVUMXSqBBLqcGpRDa0xkQy56gw=
-github.com/go-openapi/runtime v0.17.2/go.mod h1:QO936ZXeisByFmZEO1IS1Dqhtf4QV1sYYFtIq6Ld86Q=
+github.com/mdlayher/genetlink v1.3.2/go.mod h1:tcC3pkCrPUGIKKsCsp0B3AdaaKuHtaxoJRz3cc+528o=
-github.com/go-openapi/spec v0.17.0 h1:XNvrt8FlSVP8T1WuhbAFF6QDhJc0zsoWzX4wXARhhpE=
+github.com/mdlayher/netlink v1.7.2 h1:/UtM3ofJap7Vl4QWCPDGXY8d3GIY2UGSDbK+QWmY8/g=
-github.com/go-openapi/spec v0.17.0/go.mod h1:XkF/MOi14NmjsfZ8VtAKf8pIlbZzyoTvZsdfssdxcBI=
+github.com/mdlayher/netlink v1.7.2/go.mod h1:xraEF7uJbxLhc5fpHL4cPe221LI2bdttWlU+ZGLfQSw=
-github.com/go-openapi/strfmt v0.17.0 h1:1isAxYf//QDTnVzbLAMrUK++0k1EjeLJU/gTOR0o3Mc=
+github.com/mdlayher/socket v0.4.1 h1:eM9y2/jlbs1M615oshPQOHZzj6R6wMT7bX5NPiQvn2U=
-github.com/go-openapi/strfmt v0.17.0/go.mod h1:P82hnJI0CXkErkXi8IKjPbNBM6lV6+5pLP5l494TcyU=
+github.com/mdlayher/socket v0.4.1/go.mod h1:cAqeGjoufqdxWkD7DkpyS+wcefOtmu5OQ8KuoJGIReA=
-github.com/go-openapi/swag v0.17.0 h1:iqrgMg7Q7SvtbWLlltPrkMs0UBJI6oTSs79JFRUi880=
+github.com/miekg/dns v1.1.62 h1:cN8OuEF1/x5Rq6Np+h1epln8OiyPWV+lROx9LxcGgIQ=
-github.com/go-openapi/swag v0.17.0/go.mod h1:AByQ+nYG6gQg71GINrmuDXCPWdL640yX49/kXLo40Tg=
+github.com/miekg/dns v1.1.62/go.mod h1:mvDlcItzm+br7MToIKqkglaGhlFMHJ9DTNNWONWXbNQ=
-github.com/go-openapi/validate v0.17.0 h1:pqoViQz3YLOGIhAmD0N4Lt6pa/3Gnj3ymKqQwq8iS6U=
+github.com/mikioh/ipaddr v0.0.0-20190404000644-d465c8ab6721 h1:RlZweED6sbSArvlE924+mUcZuXKLBHA35U7LN621Bws=
-github.com/go-openapi/validate v0.17.0/go.mod h1:Uh4HdOzKt19xGIGm1qHf/ofbX1YQ4Y+MYsct2VUrAJ4=
+github.com/mikioh/ipaddr v0.0.0-20190404000644-d465c8ab6721/go.mod h1:Ickgr2WtCLZ2MDGd4Gr0geeCH5HybhRJbonOgQpvSxc=
-github.com/golang/mock v1.4.3 h1:GV+pQPG/EUUbkh47niozDcADz6go/dUwhVzdUQHIVRw=
+github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
-github.com/golang/mock v1.4.3/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
+github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
-github.com/golang/mock v1.4.4 h1:l75CXGRSwbaYNpl/Z2X1XIIAMSCquvXgpVZDhwEIJsc=
+github.com/pelletier/go-toml/v2 v2.2.3 h1:YmeHyLY8mFWbdkNWwpr+qIL2bEqT0o95WSdkNHvL12M=
-github.com/golang/mock v1.4.4/go.mod h1:l3mdAwkq5BuhzHwde/uurv3sEJeZMXNpwsxVWU71h+4=
+github.com/pelletier/go-toml/v2 v2.2.3/go.mod h1:MfCQTFTvCcUyyvvwm1+G6H/jORL20Xlb6rzQu9GuUkc=
-github.com/gomodule/redigo v2.0.0+incompatible/go.mod h1:B4C85qUVwatsJoIUNIfCRsp7qO0iAmpGFZ4EELWSbC4=
-github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
-github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
-github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/gotify/go-api-client/v2 v2.0.4 h1:0w8skCr8aLBDKaQDg31LKKHUGF7rt7zdRpR+6cqIAlE=
-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/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
-github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
-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=
-github.com/kr/pty v1.1.8/go.mod h1:O1sed60cT9XZ5uDucP5qwvh+TE3NnUj51EiZO/lmSfw=
-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 h1:np0woGKwx9LiHAQmwZx79Oc0rHpNw3o+3evou4BEPv4=
-github.com/kyokomi/emoji v2.2.4+incompatible/go.mod h1:mZ6aGCD7yk8j6QY6KICwnZ2pxoszVseX1DNoGtU2tBA=
-github.com/mailru/easyjson v0.0.0-20180823135443-60711f1a8329 h1:2gxZ0XQIU/5z3Z3bUBu+FXuk2pFbkN6tcwi/pjyaDic=
-github.com/mailru/easyjson v0.0.0-20180823135443-60711f1a8329/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
-github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=
-github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
-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-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
-github.com/mattn/go-isatty v0.0.11 h1:FxPOTFNqGkuDUGi3H/qkUbQO4ZiBa2brKq5r0l8TGeM=
-github.com/mattn/go-isatty v0.0.11/go.mod h1:PhnuNfih5lzO57/f3n+odYbM4JtupLOxQOAqxQCu2WE=
-github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
-github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
-github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
-github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=
-github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
-github.com/mr-tron/base58 v1.1.3 h1:v+sk57XuaCKGXpWtVBX8YJzO7hMGx4Aajh4TQbdEFdc=
-github.com/mr-tron/base58 v1.1.3/go.mod h1:BinMc/sQntlIE1frQmRFPUoPA1Zkr8VRgBdjWI2mNwc=
-github.com/pborman/uuid v1.2.0/go.mod h1:X/NO0urCmaxf9VXbdlT7C2Yzkj2IKimNn4k+gtPdI/k=
-github.com/pelletier/go-buffruneio v0.2.0/go.mod h1:JkE26KsDizTr40EUHkXVtNPvgGtbSNq5BcowyYOWdKo=
-github.com/phayes/permbits v0.0.0-20190612203442-39d7c581d2ee h1:P6U24L02WMfj9ymZTxl7CxS73JC99x3ukk+DBkgQGQs=
-github.com/phayes/permbits v0.0.0-20190612203442-39d7c581d2ee/go.mod h1:3uODdxMgOaPYeWU7RzZLxVtJHZ/x1f/iHkBZuKJDzuY=
-github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
-github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/qdm12/dns v1.4.0-rc4 h1:pCcFMqismbktPQX7yrtdmJZq30Y05JBfWRTXY1ZLVFw=
+github.com/prometheus/client_golang v1.20.5 h1:cxppBPuYhUnsO6yo/aoRol4L7q7UFfdm+bR9r+8l63Y=
-github.com/qdm12/dns v1.4.0-rc4/go.mod h1:JhUKBhuDRYBUQ2XwW/jbeWx/qS0sSJjIFjGTCFGP5I8=
+github.com/prometheus/client_golang v1.20.5/go.mod h1:PIEt8X02hGcP8JWbeHyeZ53Y/jReSnHgO035n//V5WE=
-github.com/qdm12/golibs v0.0.0-20201227203847-2fd99ffdfdba/go.mod h1:pikkTN7g7zRuuAnERwqW1yAFq6pYmxrxpjiwGvb0Ysc=
+github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E=
-github.com/qdm12/golibs v0.0.0-20210102020307-17bc97def973 h1:5YeJALmDjvg2wSi6XB8MpQQekbT/eBnwGahJrh01HHQ=
+github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY=
-github.com/qdm12/golibs v0.0.0-20210102020307-17bc97def973/go.mod h1:pikkTN7g7zRuuAnERwqW1yAFq6pYmxrxpjiwGvb0Ysc=
+github.com/prometheus/common v0.60.1 h1:FUas6GcOw66yB/73KC+BOZoFJmbo/1pojoILArPAaSc=
-github.com/qdm12/ss-server v0.1.0 h1:WV9MkHCDEWRwe4WpnYFeR/zcZAxYoTbfntLDnw9AQ50=
+github.com/prometheus/common v0.60.1/go.mod h1:h0LYf1R1deLSKtD4Vdg8gy4RuOvENW2J/h19V5NADQw=
-github.com/qdm12/ss-server v0.1.0/go.mod h1:ABVUkxubboL3vqBkOwDV9glX1/x7SnYrckBe5d+M/zw=
+github.com/prometheus/procfs v0.15.1 h1:YagwOFzUgYfKKHX6Dr+sHT7km/hxC76UB0learggepc=
-github.com/qdm12/updated v0.0.0-20210102005021-dd457d77f94a h1:gkyP+gMEeBgMgyRYGrVNcoy6cL1065IvXsyfB6xboIc=
+github.com/prometheus/procfs v0.15.1/go.mod h1:fB45yRUv8NstnjriLhBQLuOUt+WW4BsoGhij/e3PBqk=
-github.com/qdm12/updated v0.0.0-20210102005021-dd457d77f94a/go.mod h1:bbJGxEYCnsA8WU4vBcXYU6mOoHyzdP458FIKP4mfLJM=
+github.com/qdm12/dns/v2 v2.0.0-rc8 h1:kbgKPkbT+79nScfuZ0ZcVhksTGo8IUqQ8TTQGnQlZ18=
+github.com/qdm12/dns/v2 v2.0.0-rc8/go.mod h1:VaF02KWEL7xNV4oKfG4N9nEv/kR6bqyIcBReCV5NJhw=
+github.com/qdm12/goservices v0.1.0 h1:9sODefm/yuIGS7ynCkEnNlMTAYn9GzPhtcK4F69JWvc=
+github.com/qdm12/goservices v0.1.0/go.mod h1:/JOFsAnHFiSjyoXxa5FlfX903h20K5u/3rLzCjYVMck=
+github.com/qdm12/gosettings v0.4.4 h1:SM6tOZDf6k8qbjWU8KWyBF4mWIixfsKCfh9DGRLHlj4=
+github.com/qdm12/gosettings v0.4.4/go.mod h1:CPrt2YC4UsURTrslmhxocVhMCW03lIrqdH2hzIf5prg=
+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.2.0 h1:DOxCEizbW6ZG+FgpH2oK1atT6bM8MHL9GZ2ywSS4zZY=
+github.com/qdm12/gosplash v0.2.0/go.mod h1:k+1PzhO0th9cpX4q2Nneu4xTsndXqrM/x7NTIYmJ4jo=
+github.com/qdm12/gotree v0.3.0 h1:Q9f4C571EFK7ZEsPkEL2oGZX7I+ZhVxhh1ZSydW+5yI=
+github.com/qdm12/gotree v0.3.0/go.mod h1:iz06uXmRR4Aq9v6tX7mosXStO/yGHxRA1hbyD0UVeYw=
+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.6.0 h1:OaOdCIBXx0z3DGHPT6Th0v88vGa3MtAS4oRgUsDHGZE=
+github.com/qdm12/ss-server v0.6.0/go.mod h1:0BO/zEmtTiLDlmQEcjtoHTC+w+cWxwItjBuGP6TWM78=
 github.com/riobard/go-bloom v0.0.0-20200614022211-cdc8013cb5b3 h1:f/FNXud6gA3MNr8meMVVGxhp+QBTqY91tM8HjEuMjGg=
 github.com/riobard/go-bloom v0.0.0-20200614022211-cdc8013cb5b3/go.mod h1:HgjTstvQsPGkxUsCd2KWxErBblirPizecHcpD3ffK+s=
-github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
+github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII=
-github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
+github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o=
-github.com/src-d/gcfg v1.4.0/go.mod h1:p/UMsR43ujA89BJY9duynAwIpvqEujIH/jFlfL7jWoI=
+github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
-github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/ulikunitz/xz v0.5.15 h1:9DNdB5s+SgV3bQ2ApL10xRc35ck0DuIX/isZvIk+ubY=
-github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
+github.com/ulikunitz/xz v0.5.15/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
-github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/vishvananda/netlink v1.3.1 h1:3AEMt62VKqz90r0tmNhog0r/PpWKmrEShJU0wJW6bV0=
-github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/vishvananda/netlink v1.3.1/go.mod h1:ARtKouGSTGchR8aMwmkzC0qiNPrrWO5JS/XMVl45+b4=
-github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/vishvananda/netns v0.0.5 h1:DfiHV+j8bA32MFM7bfEunvT8IAqQ/NzSJHtcmW5zdEY=
-github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
+github.com/vishvananda/netns v0.0.5/go.mod h1:SpkAiCQRtJ6TvvxPnOSyH3BMl6unz3xZlaprSwhNNJM=
-github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a h1:fZHgsYlfvtyqToslyjUt3VOPF4J7aK/3MPcK7xp3PDk=
-github.com/vishvananda/netlink v1.1.0 h1:1iyaYNBLmP6L0220aDnYQpo1QEV4t4hJ+xEEhhJH8j0=
+github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a/go.mod h1:ul22v+Nro/R083muKhosV54bj5niojjWZvU8xrevuH4=
-github.com/vishvananda/netlink v1.1.0/go.mod h1:cTgwzPIzzgDAYoQrMm0EdrjRUBkTqKYppBueQtXaqoE=
+github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
-github.com/vishvananda/netns v0.0.0-20191106174202-0a2b9b5464df h1:OviZH7qLw/7ZovXvuNyL3XQl8UFofeikI1NW1Gypu7k=
-github.com/vishvananda/netns v0.0.0-20191106174202-0a2b9b5464df/go.mod h1:JP3t17pCcGlemwknint6hfoeCVQrEMVwxRLRjXpq+BU=
-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=
-go.uber.org/atomic v1.5.0 h1:OI5t8sDa1Or+q8AeE+yKeB/SDYioSHAgcVljj9JIETY=
-go.uber.org/atomic v1.5.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ=
-go.uber.org/multierr v1.3.0 h1:sFPn2GLc3poCkfrpIXGhBD2X0CMIo4Q/zSULXrj/+uc=
-go.uber.org/multierr v1.3.0/go.mod h1:VgVr7evmIr6uPjLBxg28wmKNXyqE9akIJ5XnfpiKl+4=
-go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee h1:0mgffUl7nfd+FpvXMVz4IDEaUSmT1ysygQC7qYo7sG4=
-go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA=
-go.uber.org/zap v1.13.0 h1:nR6NoDBgAf67s68NhaXbsojM+2gxp3S1hWkHDl27pVU=
-go.uber.org/zap v1.13.0/go.mod h1:zwrFLgMcdUuIBviXEYEH1YKNaOBnKXsx2IPda5bBwHM=
-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-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
-golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
-golang.org/x/crypto v0.0.0-20200117160349-530e935923ad/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/crypto v0.43.0 h1:dduJYIi3A3KOfdGOHX8AVZ/jGiyPa3IbBozJ5kNuE04=
-golang.org/x/crypto v0.0.0-20200728195943-123391ffb6de h1:ikNHVSjEfnvz6sxdSPCaPt572qowuyMDMJLLm3Db3ig=
+golang.org/x/crypto v0.43.0/go.mod h1:BFbav4mRNlXJL4wNeejLpWxB7wMbc79PdRGhWKncxR0=
-golang.org/x/crypto v0.0.0-20200728195943-123391ffb6de/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c h1:7dEasQXItcW1xKJ2+gg5VOiBnqWrJc+rq0DPKyvvdbY=
-golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad h1:DN0cp81fZ3njFcrLCytUHRSUkqBjfTo4Tx9RJTWs0EY=
+golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c/go.mod h1:NQtJDoLvd6faHhE7m4T/1IY708gDefGGjR/iUW8yQQ8=
-golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
+golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
-golang.org/x/lint v0.0.0-20190930215403-16217165b5de h1:5hukYrvBGR8/eNkX5mdUezrA6JiaEZDtJb9Ei+1LlBs=
+golang.org/x/mod v0.28.0 h1:gQBtGhjxykdjY9YhZpSlZIsbnaE2+PgjfLWUQTnoZ1U=
-golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
+golang.org/x/mod v0.28.0/go.mod h1:yfB/L0NOf/kmEbXjzCPOx1iK1fRutOydrCMsqRhEBxI=
-golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc=
-golang.org/x/net v0.0.0-20181005035420-146acd28ed58/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
-golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/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-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
+golang.org/x/net v0.46.0 h1:giFlY12I07fugqwPuWJi68oOnpfqFnJIJzaIIm2JVV4=
+golang.org/x/net v0.46.0/go.mod h1:Q9BGdFy1y4nkUwiLvT5qtyhAnEHgnQ/zd8PfU6nc210=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.17.0 h1:l60nONMj9l5drqw6jlhIELNv9I0A4OFgRsG9k2oT9Ug=
+golang.org/x/sync v0.17.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
 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-20190222072716-a9d3bda3a223/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-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/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-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20201223074533-0d417f636930 h1:vRgIt+nup/B/BwIS0g2oC0haq0iqbV3ZA+u6+0TlNCo=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20201223074533-0d417f636930/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
+golang.org/x/sys v0.37.0 h1:fdNQudmxPjkdUTPnLn5mdQv7Zwvbvpaxqs831goi9kQ=
-golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/sys v0.37.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 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.30.0 h1:yznKA/E9zq54KzlzBEAWn1NXSQ8DIp/NYMy88xJjl4k=
+golang.org/x/text v0.30.0/go.mod h1:yDdHFIX9t+tORqspjENWgzaCVXgk0yYnYuSZ8UzzBVM=
+golang.org/x/time v0.0.0-20220210224613-90d013bbcef8 h1:vVKdlvoWBphwdxWKrFZEuM0kGgGLxUOYcY4U/2Vjg44=
+golang.org/x/time v0.0.0-20220210224613-90d013bbcef8/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-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
-golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
+golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
-golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
+golang.org/x/tools v0.37.0 h1:DVSRzp7FwePZW356yEAChSdNcQo6Nsp+fex1SUW09lE=
-golang.org/x/tools v0.0.0-20190729092621-ff9f1409240a/go.mod h1:jcCCGcm9btYwXyDqrUWc6MKQKKGJCWEQ3AfLSRIbEuI=
+golang.org/x/tools v0.37.0/go.mod h1:MBN5QPQtLMHVdvsbtarmTNukZDdgwdwlO5qGacAzF0w=
-golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
-golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5 h1:hKsoRgsbwY1NafxrwTs+k64bikrLBkAgPir1TNCj3Zs=
-golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 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-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-20231211153847-12269c276173 h1:/jFs0duh4rdb8uIfPMv78iAJGcPKDeqAFnaLBropIC4=
+golang.zx2c4.com/wireguard v0.0.0-20231211153847-12269c276173/go.mod h1:tkCQ4FQXmpAgYVh++1cq16/dH4QJtmvpRv19DWGAHSA=
+golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230429144221-925a1e7659e6 h1:CawjfCvYQH2OU3/TnxLx97WDSUDRABfT18pCOYwc2GE=
+golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230429144221-925a1e7659e6/go.mod h1:3rxYc4HtVcSG9gVaTs2GEBdehh+sYPOwKtyUWEOTb80=
+google.golang.org/protobuf v1.35.1 h1:m3LfL6/Ca+fqnjnlqQXNpFPABW1UD7mjh8KO2mKFytA=
+google.golang.org/protobuf v1.35.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
 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-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
-gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
-gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
+gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA=
-gopkg.in/src-d/go-billy.v4 v4.3.2/go.mod h1:nDjArDMp+XMs1aFAESLRjfGSgfvoYN0hDfzEk0GjC98=
+gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
-gopkg.in/src-d/go-git-fixtures.v3 v3.5.0/go.mod h1:dLBcvytrw/TYZsNTWCnkNF2DSIlzWYqTe3rJR56Ac7g=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
-gopkg.in/src-d/go-git.v4 v4.13.1/go.mod h1:nx5NYcxdKxq5fpltdHnPa2Exj4Sx0EclMWZQbYDu2z8=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
+gvisor.dev/gvisor v0.0.0-20230927004350-cbd86285d259 h1:TbRPT0HtzFP3Cno1zZo7yPzEEnfu8EjLfl6IU9VfqkQ=
-gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gvisor.dev/gvisor v0.0.0-20230927004350-cbd86285d259/go.mod h1:AVgIgHMwK63XvmAzWG9vLQ41YnVHN0du0tEC46fI7yY=
-gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+kernel.org/pub/linux/libs/security/libcap/cap v1.2.70 h1:QnLPkuDWWbD5C+3DUA2IUXai5TK6w2zff+MAGccqdsw=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+kernel.org/pub/linux/libs/security/libcap/cap v1.2.70/go.mod h1:/iBwcj9nbLejQitYvUm9caurITQ6WyNHibJk6Q9fiS4=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+kernel.org/pub/linux/libs/security/libcap/psx v1.2.70 h1:HsB2G/rEQiYyo1bGoQqHZ/Bvd6x1rERQTNdPr1FyWjI=
-honnef.co/go/tools v0.0.1-2019.2.3 h1:3JgtbtFHMiCmsznwGVTUWbgGov+pVqnlf1dEJTNAXeM=
+kernel.org/pub/linux/libs/security/libcap/psx v1.2.70/go.mod h1:+l6Ee2F59XiJ2I6WR5ObpC1utCQJZ/VLsEbQCD8RG24=
-honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=
-rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
-rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=

internal/alpine/alpine.go

@@ -1,22 +1,21 @@
 package alpine
 
 import (
-	"github.com/qdm12/golibs/os"
+	"os/user"
-	"github.com/qdm12/golibs/os/user"
 )
 
-type Configurator interface {
+type Alpine struct {
-	CreateUser(username string, uid int) (createdUsername string, err error)
+	alpineReleasePath string
+	passwdPath        string
+	lookupID          func(uid string) (*user.User, error)
+	lookup            func(username string) (*user.User, error)
 }
 
-type configurator struct {
+func New() *Alpine {
-	openFile os.OpenFileFunc
+	return &Alpine{
-	osUser   user.OSUser
+		alpineReleasePath: "/etc/alpine-release",
-}
+		passwdPath:        "/etc/passwd",
-
+		lookupID:          user.LookupId,
-func NewConfigurator(openFile os.OpenFileFunc, osUser user.OSUser) Configurator {
+		lookup:            user.Lookup,
-	return &configurator{
-		openFile: openFile,
-		osUser:   osUser,
 	}
 }

internal/alpine/users.go

@@ -1,35 +1,47 @@
 package alpine
 
 import (
+	"errors"
 	"fmt"
+	"io/fs"
 	"os"
 	"os/user"
+	"strconv"
 )
 
+var ErrUserAlreadyExists = errors.New("user already exists")
+
 // CreateUser creates a user in Alpine with the given UID.
-func (c *configurator) CreateUser(username string, uid int) (createdUsername string, err error) {
+func (a *Alpine) CreateUser(username string, uid int) (createdUsername string, err error) {
-	UIDStr := fmt.Sprintf("%d", uid)
+	UIDStr := strconv.Itoa(uid)
-	u, err := c.osUser.LookupID(UIDStr)
+	u, err := a.lookupID(UIDStr)
 	_, unknownUID := err.(user.UnknownUserIdError)
 	if err != nil && !unknownUID {
-		return "", fmt.Errorf("cannot create user: %w", err)
+		return "", err
-	} else if u != nil {
+	}
+
+	if u != nil {
 		if u.Username == username {
 			return "", nil
 		}
 		return u.Username, nil
 	}
-	u, err = c.osUser.Lookup(username)
+
+	u, err = a.lookup(username)
 	_, unknownUsername := err.(user.UnknownUserError)
 	if err != nil && !unknownUsername {
-		return "", fmt.Errorf("cannot create user: %w", err)
+		return "", err
-	} else if u != nil {
-		return "", fmt.Errorf("cannot create user: user with name %s already exists for ID %s instead of %d",
-			username, u.Uid, uid)
 	}
-	file, err := c.openFile("/etc/passwd", os.O_APPEND|os.O_WRONLY, 0644)
+
+	if u != nil {
+		return "", fmt.Errorf("%w: with name %s for ID %s instead of %d",
+			ErrUserAlreadyExists, username, u.Uid, uid)
+	}
+
+	const permission = fs.FileMode(0o644)
+	file, err := os.OpenFile(a.passwdPath, os.O_APPEND|os.O_WRONLY, permission)
 	if err != nil {
-		return "", fmt.Errorf("cannot create user: %w", err)
+		return "", err
 	}
 	s := fmt.Sprintf("%s:x:%d:::/dev/null:/sbin/nologin\n", username, uid)
 	_, err = file.WriteString(s)
@@ -37,5 +49,6 @@ func (c *configurator) CreateUser(username string, uid int) (createdUsername str
 		_ = file.Close()
 		return "", err
 	}
+
 	return username, file.Close()
 }

internal/alpine/version.go

@@ -0,0 +1,27 @@
+package alpine
+
+import (
+	"context"
+	"io"
+	"os"
+	"strings"
+)
+
+func (a *Alpine) Version(context.Context) (version string, err error) {
+	file, err := os.OpenFile(a.alpineReleasePath, os.O_RDONLY, 0)
+	if err != nil {
+		return "", err
+	}
+
+	b, err := io.ReadAll(file)
+	if err != nil {
+		return "", err
+	}
+
+	if err := file.Close(); err != nil {
+		return "", err
+	}
+
+	version = strings.ReplaceAll(string(b), "\n", "")
+	return version, nil
+}

internal/cli/ci.go

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

internal/cli/cli.go

@@ -1,20 +1,11 @@
 package cli
 
-import (
+type CLI struct {
-	"context"
+	repoServersPath string
-
-	"github.com/qdm12/golibs/os"
-)
-
-type CLI interface {
-	ClientKey(args []string, openFile os.OpenFileFunc) error
-	HealthCheck(ctx context.Context) error
-	OpenvpnConfig(os os.OS) error
-	Update(args []string, os os.OS) error
 }
 
-type cli struct{}
+func New() *CLI {
-
+	return &CLI{
-func New() CLI {
+		repoServersPath: "./internal/storage/servers.json",
-	return &cli{}
+	}
 }

internal/cli/clientkey.go

@@ -3,24 +3,23 @@ package cli
 import (
 	"flag"
 	"fmt"
-	"io/ioutil"
+	"io"
+	"os"
 	"strings"
-
-	"github.com/qdm12/gluetun/internal/constants"
-	"github.com/qdm12/golibs/os"
 )
 
-func (c *cli) ClientKey(args []string, openFile os.OpenFileFunc) error {
+func (c *CLI) ClientKey(args []string) error {
 	flagSet := flag.NewFlagSet("clientkey", flag.ExitOnError)
-	filepath := flagSet.String("path", string(constants.ClientKey), "file path to the client.key file")
+	const openVPNClientKeyPath = "/gluetun/client.key" // TODO deduplicate?
+	filepath := flagSet.String("path", openVPNClientKeyPath, "file path to the client.key file")
 	if err := flagSet.Parse(args); err != nil {
 		return err
 	}
-	file, err := openFile(*filepath, os.O_RDONLY, 0)
+	file, err := os.OpenFile(*filepath, os.O_RDONLY, 0)
 	if err != nil {
 		return err
 	}
-	data, err := ioutil.ReadAll(file)
+	data, err := io.ReadAll(file)
 	if err != nil {
 		_ = file.Close()
 		return err
@@ -28,9 +27,6 @@ func (c *cli) ClientKey(args []string, openFile os.OpenFileFunc) error {
 	if err := file.Close(); err != nil {
 		return err
 	}
-	if err != nil {
-		return err
-	}
 	s := string(data)
 	s = strings.ReplaceAll(s, "\n", "")
 	s = strings.ReplaceAll(s, "\r", "")

internal/cli/formatservers.go

@@ -0,0 +1,113 @@
+package cli
+
+import (
+	"errors"
+	"flag"
+	"fmt"
+	"io/fs"
+	"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 (
+	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' or 'json'")
+	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
+	}
+
+	// Note the format is validated by storage.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, err := storage.Format(providerToFormat, format)
+	if err != nil {
+		return fmt.Errorf("formatting servers: %w", err)
+	}
+
+	output = filepath.Clean(output)
+	const permission = fs.FileMode(0o644)
+	file, err := os.OpenFile(output, os.O_TRUNC|os.O_WRONLY|os.O_CREATE, permission)
+	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/genkey.go

@@ -0,0 +1,66 @@
+package cli
+
+import (
+	"crypto/rand"
+	"flag"
+	"fmt"
+)
+
+func (c *CLI) GenKey(args []string) (err error) {
+	flagSet := flag.NewFlagSet("genkey", flag.ExitOnError)
+	err = flagSet.Parse(args)
+	if err != nil {
+		return fmt.Errorf("parsing flags: %w", err)
+	}
+
+	const keyLength = 128 / 8
+	keyBytes := make([]byte, keyLength)
+
+	_, _ = rand.Read(keyBytes)
+
+	key := base58Encode(keyBytes)
+	fmt.Println(key)
+
+	return nil
+}
+
+func base58Encode(data []byte) string {
+	const alphabet = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"
+	const radix = 58
+
+	zcount := 0
+	for zcount < len(data) && data[zcount] == 0 {
+		zcount++
+	}
+
+	// integer simplification of ceil(log(256)/log(58))
+	ceilLog256Div58 := (len(data)-zcount)*555/406 + 1 //nolint:mnd
+	size := zcount + ceilLog256Div58
+
+	output := make([]byte, size)
+
+	high := size - 1
+	for _, b := range data {
+		i := size - 1
+		for carry := uint32(b); i > high || carry != 0; i-- {
+			carry += 256 * uint32(output[i]) //nolint:mnd
+			output[i] = byte(carry % radix)
+			carry /= radix
+		}
+		high = i
+	}
+
+	// Determine the additional "zero-gap" in the output buffer
+	additionalZeroGapEnd := zcount
+	for additionalZeroGapEnd < size && output[additionalZeroGapEnd] == 0 {
+		additionalZeroGapEnd++
+	}
+
+	val := output[additionalZeroGapEnd-zcount:]
+	size = len(val)
+	for i := range val {
+		output[i] = alphabet[val[i]]
+	}
+
+	return string(output[:size])
+}

internal/cli/healthcheck.go

@@ -2,19 +2,41 @@ package cli
 
 import (
 	"context"
+	"net"
 	"net/http"
 	"time"
 
-	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/healthcheck"
+	"github.com/qdm12/gosettings/reader"
 )
 
-func (c *cli) HealthCheck(ctx context.Context) error {
+func (c *CLI) HealthCheck(ctx context.Context, reader *reader.Reader, _ Warner) (err error) {
+	// Extract the health server port from the configuration.
+	var config settings.Health
+	err = config.Read(reader)
+	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
+	}
+
 	const timeout = 10 * time.Second
 	httpClient := &http.Client{Timeout: timeout}
-	healthchecker := healthcheck.NewChecker(httpClient)
+	client := healthcheck.NewClient(httpClient)
 	ctx, cancel := context.WithTimeout(ctx, timeout)
 	defer cancel()
-	const url = "http://" + constants.HealthcheckAddress
+
-	return healthchecker.Check(ctx, url)
+	url := "http://127.0.0.1:" + port
+	return client.Check(ctx, url)
 }

internal/cli/interfaces.go

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,9 @@
+package cli
+
+type noopLogger struct{}
+
+func newNoopLogger() *noopLogger {
+	return new(noopLogger)
+}
+
+func (l *noopLogger) Info(string) {}

internal/cli/openvpnconfig.go

@@ -1,48 +1,92 @@
 package cli
 
 import (
+	"context"
 	"fmt"
+	"net/http"
+	"net/netip"
 	"strings"
 	"time"
 
+	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/constants"
-	"github.com/qdm12/gluetun/internal/params"
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/gluetun/internal/openvpn/extract"
 	"github.com/qdm12/gluetun/internal/provider"
-	"github.com/qdm12/gluetun/internal/settings"
 	"github.com/qdm12/gluetun/internal/storage"
-	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/gluetun/internal/updater/resolver"
-	"github.com/qdm12/golibs/os"
+	"github.com/qdm12/gosettings/reader"
 )
 
-func (c *cli) OpenvpnConfig(os os.OS) error {
+type OpenvpnConfigLogger interface {
-	logger, err := logging.NewLogger(logging.ConsoleEncoding, logging.InfoLevel)
+	Info(s string)
+	Warn(s string)
+}
+
+type Unzipper interface {
+	FetchAndExtract(ctx context.Context, url string) (
+		contents map[string][]byte, err error)
+}
+
+type ParallelResolver interface {
+	Resolve(ctx context.Context, settings resolver.ParallelSettings) (
+		hostToIPs map[string][]netip.Addr, warnings []string, err error)
+}
+
+type IPFetcher interface {
+	String() string
+	CanFetchAnyIP() bool
+	FetchInfo(ctx context.Context, ip netip.Addr) (data models.PublicIP, err error)
+}
+
+type IPv6Checker interface {
+	IsIPv6Supported() (supported bool, err error)
+}
+
+func (c *CLI) OpenvpnConfig(logger OpenvpnConfigLogger, reader *reader.Reader,
+	ipv6Checker IPv6Checker,
+) error {
+	storage, err := storage.New(logger, constants.ServersData)
 	if err != nil {
 		return err
 	}
-	paramsReader := params.NewReader(logger, os)
+
-	allSettings, err := settings.GetAllSettings(paramsReader)
+	var allSettings settings.Settings
+	err = allSettings.Read(reader, logger)
 	if err != nil {
 		return err
 	}
-	allServers, err := storage.New(logger, os, constants.ServersData).
+	allSettings.SetDefaults()
-		SyncServers(constants.GetAllServers())
+
+	ipv6Supported, err := ipv6Checker.IsIPv6Supported()
+	if err != nil {
+		return fmt.Errorf("checking for IPv6 support: %w", err)
+	}
+
+	if err = allSettings.Validate(storage, ipv6Supported, logger); 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
 	}
-	providerConf := provider.New(allSettings.OpenVPN.Provider.Name, allServers, time.Now)
+
-	connection, err := providerConf.GetOpenVPNConnection(allSettings.OpenVPN.Provider.ServerSelection)
+	lines := providerConf.OpenVPNConfig(connection,
-	if err != nil {
+		allSettings.VPN.OpenVPN, ipv6Supported)
-		return err
+
-	}
-	lines := providerConf.BuildConf(
-		connection,
-		allSettings.OpenVPN.Verbosity,
-		"nonroortuser",
-		allSettings.OpenVPN.Root,
-		allSettings.OpenVPN.Cipher,
-		allSettings.OpenVPN.Auth,
-		allSettings.OpenVPN.Provider.ExtraConfigOptions,
-	)
 	fmt.Println(strings.Join(lines, "\n"))
 	return nil
 }

internal/cli/update.go

@@ -2,61 +2,110 @@ package cli
 
 import (
 	"context"
+	"errors"
 	"flag"
 	"fmt"
 	"net/http"
+	"strings"
 	"time"
 
+	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/constants"
-	"github.com/qdm12/gluetun/internal/settings"
+	"github.com/qdm12/gluetun/internal/constants/providers"
+	"github.com/qdm12/gluetun/internal/openvpn/extract"
+	"github.com/qdm12/gluetun/internal/provider"
+	"github.com/qdm12/gluetun/internal/publicip/api"
 	"github.com/qdm12/gluetun/internal/storage"
 	"github.com/qdm12/gluetun/internal/updater"
-	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/gluetun/internal/updater/resolver"
-	"github.com/qdm12/golibs/os"
+	"github.com/qdm12/gluetun/internal/updater/unzip"
 )
 
-func (c *cli) Update(args []string, os os.OS) error {
+var (
-	options := settings.Updater{CLI: true}
+	ErrModeUnspecified     = errors.New("at least one of -enduser or -maintainer must be specified")
-	var flushToFile bool
+	ErrNoProviderSpecified = errors.New("no provider was specified")
+)
+
+type UpdaterLogger interface {
+	Info(s string)
+	Warn(s string)
+	Error(s string)
+}
+
+func (c *CLI) Update(ctx context.Context, args []string, logger UpdaterLogger) error {
+	options := settings.Updater{}
+	var endUserMode, maintainerMode, updateAll bool
+	var csvProviders, ipToken string
 	flagSet := flag.NewFlagSet("update", flag.ExitOnError)
-	flagSet.BoolVar(&flushToFile, "file", false, "Write results to /gluetun/servers.json (for end users)")
+	flagSet.BoolVar(&endUserMode, "enduser", false, "Write results to /gluetun/servers.json (for end users)")
-	flagSet.BoolVar(&options.Stdout, "stdout", false, "Write results to console to modify the program (for maintainers)")
+	flagSet.BoolVar(&maintainerMode, "maintainer", false,
-	flagSet.StringVar(&options.DNSAddress, "dns", "1.1.1.1", "DNS resolver address to use")
+		"Write results to ./internal/storage/servers.json to modify the program (for maintainers)")
-	flagSet.BoolVar(&options.Cyberghost, "cyberghost", false, "Update Cyberghost servers")
+	flagSet.StringVar(&options.DNSAddress, "dns", "8.8.8.8", "DNS resolver address to use")
-	flagSet.BoolVar(&options.Mullvad, "mullvad", false, "Update Mullvad servers")
+	const defaultMinRatio = 0.8
-	flagSet.BoolVar(&options.Nordvpn, "nordvpn", false, "Update Nordvpn servers")
+	flagSet.Float64Var(&options.MinRatio, "minratio", defaultMinRatio,
-	flagSet.BoolVar(&options.PIA, "pia", false, "Update Private Internet Access post-summer 2020 servers")
+		"Minimum ratio of servers to find for the update to succeed")
-	flagSet.BoolVar(&options.Privado, "privado", false, "Update Privado servers")
+	flagSet.BoolVar(&updateAll, "all", false, "Update servers for all VPN providers")
-	flagSet.BoolVar(&options.Purevpn, "purevpn", false, "Update Purevpn servers")
+	flagSet.StringVar(&csvProviders, "providers", "", "CSV string of VPN providers to update server data for")
-	flagSet.BoolVar(&options.Surfshark, "surfshark", false, "Update Surfshark servers")
+	flagSet.StringVar(&ipToken, "ip-token", "", "IP data service token (e.g. ipinfo.io) to use")
-	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
 	}
-	logger, err := logging.NewLogger(logging.ConsoleEncoding, logging.InfoLevel)
+
+	if !endUserMode && !maintainerMode {
+		return fmt.Errorf("%w", ErrModeUnspecified)
+	}
+
+	if updateAll {
+		options.Providers = providers.All()
+	} 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 err
+		return fmt.Errorf("options validation failed: %w", err)
 	}
-	if !flushToFile && !options.Stdout {
+
-		return fmt.Errorf("at least one of -file or -stdout must be specified")
+	storage, err := storage.New(logger, constants.ServersData)
+	if err != nil {
+		return fmt.Errorf("creating servers storage: %w", err)
 	}
-	ctx := context.Background()
+
 	const clientTimeout = 10 * time.Second
 	httpClient := &http.Client{Timeout: clientTimeout}
-	storage := storage.New(logger, os, constants.ServersData)
+	unzipper := unzip.New(httpClient)
-	currentServers, err := storage.SyncServers(constants.GetAllServers())
+	parallelResolver := resolver.NewParallelResolver(options.DNSAddress)
-	if err != nil {
+	nameTokenPairs := []api.NameToken{
-		return fmt.Errorf("cannot update servers: %w", err)
+		{Name: string(api.IPInfo), Token: ipToken},
+		{Name: string(api.IP2Location)},
+		{Name: string(api.IfConfigCo)},
 	}
-	updater := updater.New(options, httpClient, currentServers, logger)
+	fetchers, err := api.New(nameTokenPairs, httpClient)
-	allServers, err := updater.UpdateServers(ctx)
 	if err != nil {
-		return err
+		return fmt.Errorf("creating public IP fetchers: %w", err)
 	}
-	if flushToFile {
+	ipFetcher := api.NewResilient(fetchers, logger)
-		if err := storage.FlushToFile(allServers); err != nil {
+
-			return fmt.Errorf("cannot update servers: %w", err)
+	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)
+	}
+
+	if maintainerMode {
+		err := storage.FlushToFile(c.repoServersPath)
+		if err != nil {
+			return fmt.Errorf("writing servers data to embedded JSON file: %w", err)
 		}
 	}
 

internal/cli/warner.go

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

internal/command/cmder.go

@@ -0,0 +1,8 @@
+package command
+
+// Cmder handles running subprograms synchronously and asynchronously.
+type Cmder struct{}
+
+func New() *Cmder {
+	return &Cmder{}
+}

internal/command/interfaces_local.go

@@ -0,0 +1,11 @@
+package command
+
+import "io"
+
+type execCmd interface {
+	CombinedOutput() ([]byte, error)
+	StdoutPipe() (io.ReadCloser, error)
+	StderrPipe() (io.ReadCloser, error)
+	Start() error
+	Wait() error
+}

internal/command/mocks_generate_test.go

@@ -0,0 +1,3 @@
+package command
+
+//go:generate mockgen -destination=mocks_local_test.go -package=$GOPACKAGE -source=interfaces_local.go

internal/command/mocks_local_test.go

@@ -0,0 +1,108 @@
+// Code generated by MockGen. DO NOT EDIT.
+// Source: interfaces_local.go
+
+// Package command is a generated GoMock package.
+package command
+
+import (
+	io "io"
+	reflect "reflect"
+
+	gomock "github.com/golang/mock/gomock"
+)
+
+// MockexecCmd is a mock of execCmd interface.
+type MockexecCmd struct {
+	ctrl     *gomock.Controller
+	recorder *MockexecCmdMockRecorder
+}
+
+// MockexecCmdMockRecorder is the mock recorder for MockexecCmd.
+type MockexecCmdMockRecorder struct {
+	mock *MockexecCmd
+}
+
+// NewMockexecCmd creates a new mock instance.
+func NewMockexecCmd(ctrl *gomock.Controller) *MockexecCmd {
+	mock := &MockexecCmd{ctrl: ctrl}
+	mock.recorder = &MockexecCmdMockRecorder{mock}
+	return mock
+}
+
+// EXPECT returns an object that allows the caller to indicate expected use.
+func (m *MockexecCmd) EXPECT() *MockexecCmdMockRecorder {
+	return m.recorder
+}
+
+// CombinedOutput mocks base method.
+func (m *MockexecCmd) CombinedOutput() ([]byte, error) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "CombinedOutput")
+	ret0, _ := ret[0].([]byte)
+	ret1, _ := ret[1].(error)
+	return ret0, ret1
+}
+
+// CombinedOutput indicates an expected call of CombinedOutput.
+func (mr *MockexecCmdMockRecorder) CombinedOutput() *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CombinedOutput", reflect.TypeOf((*MockexecCmd)(nil).CombinedOutput))
+}
+
+// Start mocks base method.
+func (m *MockexecCmd) Start() error {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "Start")
+	ret0, _ := ret[0].(error)
+	return ret0
+}
+
+// Start indicates an expected call of Start.
+func (mr *MockexecCmdMockRecorder) Start() *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Start", reflect.TypeOf((*MockexecCmd)(nil).Start))
+}
+
+// StderrPipe mocks base method.
+func (m *MockexecCmd) StderrPipe() (io.ReadCloser, error) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "StderrPipe")
+	ret0, _ := ret[0].(io.ReadCloser)
+	ret1, _ := ret[1].(error)
+	return ret0, ret1
+}
+
+// StderrPipe indicates an expected call of StderrPipe.
+func (mr *MockexecCmdMockRecorder) StderrPipe() *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "StderrPipe", reflect.TypeOf((*MockexecCmd)(nil).StderrPipe))
+}
+
+// StdoutPipe mocks base method.
+func (m *MockexecCmd) StdoutPipe() (io.ReadCloser, error) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "StdoutPipe")
+	ret0, _ := ret[0].(io.ReadCloser)
+	ret1, _ := ret[1].(error)
+	return ret0, ret1
+}
+
+// StdoutPipe indicates an expected call of StdoutPipe.
+func (mr *MockexecCmdMockRecorder) StdoutPipe() *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "StdoutPipe", reflect.TypeOf((*MockexecCmd)(nil).StdoutPipe))
+}
+
+// Wait mocks base method.
+func (m *MockexecCmd) Wait() error {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "Wait")
+	ret0, _ := ret[0].(error)
+	return ret0
+}
+
+// Wait indicates an expected call of Wait.
+func (mr *MockexecCmdMockRecorder) Wait() *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Wait", reflect.TypeOf((*MockexecCmd)(nil).Wait))
+}

internal/command/run.go

@@ -0,0 +1,30 @@
+package command
+
+import (
+	"os/exec"
+	"strings"
+)
+
+// Run runs a command in a blocking manner, returning its output and
+// an error if it failed.
+func (c *Cmder) Run(cmd *exec.Cmd) (output string, err error) {
+	return run(cmd)
+}
+
+func run(cmd execCmd) (output string, err error) {
+	stdout, err := cmd.CombinedOutput()
+	output = string(stdout)
+	output = strings.TrimSuffix(output, "\n")
+	lines := stringToLines(output)
+	for i := range lines {
+		lines[i] = strings.TrimPrefix(lines[i], "'")
+		lines[i] = strings.TrimSuffix(lines[i], "'")
+	}
+	output = strings.Join(lines, "\n")
+	return output, err
+}
+
+func stringToLines(s string) (lines []string) {
+	s = strings.TrimSuffix(s, "\n")
+	return strings.Split(s, "\n")
+}

internal/command/run_test.go

@@ -0,0 +1,54 @@
+package command
+
+import (
+	"errors"
+	"testing"
+
+	gomock "github.com/golang/mock/gomock"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_run(t *testing.T) {
+	t.Parallel()
+
+	errDummy := errors.New("dummy")
+
+	testCases := map[string]struct {
+		stdout []byte
+		cmdErr error
+		output string
+		err    error
+	}{
+		"no output": {},
+		"cmd error": {
+			stdout: []byte("'hello \nworld'\n"),
+			cmdErr: errDummy,
+			output: "hello \nworld",
+			err:    errDummy,
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			ctrl := gomock.NewController(t)
+
+			mockCmd := NewMockexecCmd(ctrl)
+
+			mockCmd.EXPECT().CombinedOutput().Return(testCase.stdout, testCase.cmdErr)
+
+			output, err := run(mockCmd)
+
+			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.output, output)
+		})
+	}
+}

internal/command/split.go

@@ -0,0 +1,150 @@
+package command
+
+import (
+	"bytes"
+	"errors"
+	"fmt"
+	"strings"
+	"unicode/utf8"
+)
+
+var (
+	ErrCommandEmpty            = errors.New("command is empty")
+	ErrSingleQuoteUnterminated = errors.New("unterminated single-quoted string")
+	ErrDoubleQuoteUnterminated = errors.New("unterminated double-quoted string")
+	ErrEscapeUnterminated      = errors.New("unterminated backslash-escape")
+)
+
+// Split splits a command string into a slice of arguments.
+// This is especially important for commands such as:
+// /bin/sh -c "echo hello"
+// which should be split into: ["/bin/sh", "-c", "echo hello"]
+// It supports backslash-escapes, single-quotes and double-quotes.
+// It does not support:
+// - the $" quoting style.
+// - expansion (brace, shell or pathname).
+func Split(command string) (words []string, err error) {
+	if command == "" {
+		return nil, fmt.Errorf("%w", ErrCommandEmpty)
+	}
+
+	const bufferSize = 1024
+	buffer := bytes.NewBuffer(make([]byte, bufferSize))
+
+	startIndex := 0
+
+	for startIndex < len(command) {
+		// skip any split characters at the start
+		character, runeSize := utf8.DecodeRuneInString(command[startIndex:])
+		switch {
+		case strings.ContainsRune(" \n\t", character):
+			startIndex += runeSize
+		case character == '\\':
+			// Look ahead to eventually skip an escaped newline
+			if command[startIndex+runeSize:] == "" {
+				return nil, fmt.Errorf("%w: %q", ErrEscapeUnterminated, command)
+			}
+			character, runeSize := utf8.DecodeRuneInString(command[startIndex+runeSize:])
+			if character == '\n' {
+				startIndex += runeSize + runeSize // backslash and newline
+			}
+		default:
+			var word string
+			buffer.Reset()
+			word, startIndex, err = splitWord(command, startIndex, buffer)
+			if err != nil {
+				return nil, fmt.Errorf("splitting word in %q: %w", command, err)
+			}
+			words = append(words, word)
+		}
+	}
+	return words, nil
+}
+
+// WARNING: buffer must be cleared before calling this function.
+func splitWord(input string, startIndex int, buffer *bytes.Buffer) (
+	word string, newStartIndex int, err error,
+) {
+	cursor := startIndex
+	for cursor < len(input) {
+		character, runeLength := utf8.DecodeRuneInString(input[cursor:])
+		cursor += runeLength
+		if character == '"' ||
+			character == '\'' ||
+			character == '\\' ||
+			character == ' ' ||
+			character == '\n' ||
+			character == '\t' {
+			buffer.WriteString(input[startIndex : cursor-runeLength])
+		}
+
+		switch {
+		case strings.ContainsRune(" \n\t", character): // spacing character
+			return buffer.String(), cursor, nil
+		case character == '"':
+			return handleDoubleQuoted(input, cursor, buffer)
+		case character == '\'':
+			return handleSingleQuoted(input, cursor, buffer)
+		case character == '\\':
+			return handleEscaped(input, cursor, buffer)
+		}
+	}
+
+	buffer.WriteString(input[startIndex:])
+	return buffer.String(), len(input), nil
+}
+
+func handleDoubleQuoted(input string, startIndex int, buffer *bytes.Buffer) (
+	word string, newStartIndex int, err error,
+) {
+	cursor := startIndex
+	for cursor < len(input) {
+		nextCharacter, nextRuneLength := utf8.DecodeRuneInString(input[cursor:])
+		cursor += nextRuneLength
+		switch nextCharacter {
+		case '"': // end of the double quoted string
+			buffer.WriteString(input[startIndex : cursor-nextRuneLength])
+			return splitWord(input, cursor, buffer)
+		case '\\': // escaped character
+			escapedCharacter, escapedRuneLength := utf8.DecodeRuneInString(input[cursor:])
+			cursor += escapedRuneLength
+			if !strings.ContainsRune("$`\"\n\\", escapedCharacter) {
+				break
+			}
+			buffer.WriteString(input[startIndex : cursor-nextRuneLength-escapedRuneLength])
+			if escapedCharacter != '\n' {
+				// skip backslash entirely for the newline character
+				buffer.WriteRune(escapedCharacter)
+			}
+			startIndex = cursor
+		}
+	}
+	return "", 0, fmt.Errorf("%w", ErrDoubleQuoteUnterminated)
+}
+
+func handleSingleQuoted(input string, startIndex int, buffer *bytes.Buffer) (
+	word string, newStartIndex int, err error,
+) {
+	closingQuoteIndex := strings.IndexRune(input[startIndex:], '\'')
+	if closingQuoteIndex == -1 {
+		return "", 0, fmt.Errorf("%w", ErrSingleQuoteUnterminated)
+	}
+	buffer.WriteString(input[startIndex : startIndex+closingQuoteIndex])
+	const singleQuoteRuneLength = 1
+	startIndex += closingQuoteIndex + singleQuoteRuneLength
+	return splitWord(input, startIndex, buffer)
+}
+
+func handleEscaped(input string, startIndex int, buffer *bytes.Buffer) (
+	word string, newStartIndex int, err error,
+) {
+	if input[startIndex:] == "" {
+		return "", 0, fmt.Errorf("%w", ErrEscapeUnterminated)
+	}
+	character, runeLength := utf8.DecodeRuneInString(input[startIndex:])
+	if character != '\n' { // backslash-escaped newline is ignored
+		buffer.WriteString(input[startIndex : startIndex+runeLength])
+	}
+	startIndex += runeLength
+	return splitWord(input, startIndex, buffer)
+}

internal/command/split_test.go

@@ -0,0 +1,110 @@
+package command
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_Split(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		command    string
+		words      []string
+		errWrapped error
+		errMessage string
+	}{
+		"empty": {
+			command:    "",
+			errWrapped: ErrCommandEmpty,
+			errMessage: "command is empty",
+		},
+		"concrete_sh_command": {
+			command: `/bin/sh -c "echo 123"`,
+			words:   []string{"/bin/sh", "-c", "echo 123"},
+		},
+		"single_word": {
+			command: "word1",
+			words:   []string{"word1"},
+		},
+		"two_words_single_space": {
+			command: "word1 word2",
+			words:   []string{"word1", "word2"},
+		},
+		"two_words_multiple_space": {
+			command: "word1    word2",
+			words:   []string{"word1", "word2"},
+		},
+		"two_words_no_expansion": {
+			command: "word1*    word2?",
+			words:   []string{"word1*", "word2?"},
+		},
+		"escaped_single quote": {
+			command: "ain\\'t good",
+			words:   []string{"ain't", "good"},
+		},
+		"escaped_single_quote_all_single_quoted": {
+			command: "'ain'\\''t good'",
+			words:   []string{"ain't good"},
+		},
+		"empty_single_quoted": {
+			command: "word1 ''  word2",
+			words:   []string{"word1", "", "word2"},
+		},
+		"escaped_newline": {
+			command: "word1\\\nword2",
+			words:   []string{"word1word2"},
+		},
+		"quoted_newline": {
+			command: "text \"with\na\" quoted newline",
+			words:   []string{"text", "with\na", "quoted", "newline"},
+		},
+		"quoted_escaped_newline": {
+			command: "\"word1\\d\\\\\\\" word2\\\nword3 word4\"",
+			words:   []string{"word1\\d\\\" word2word3 word4"},
+		},
+		"escaped_separated_newline": {
+			command: "word1 \\\n word2",
+			words:   []string{"word1", "word2"},
+		},
+		"double_quotes_no_spacing": {
+			command: "word1\"word2\"word3",
+			words:   []string{"word1word2word3"},
+		},
+		"unterminated_single_quote": {
+			command:    "'abc'\\''def",
+			errWrapped: ErrSingleQuoteUnterminated,
+			errMessage: `splitting word in "'abc'\\''def": unterminated single-quoted string`,
+		},
+		"unterminated_double_quote": {
+			command:    "\"abc'def",
+			errWrapped: ErrDoubleQuoteUnterminated,
+			errMessage: `splitting word in "\"abc'def": unterminated double-quoted string`,
+		},
+		"unterminated_escape": {
+			command:    "abc\\",
+			errWrapped: ErrEscapeUnterminated,
+			errMessage: `splitting word in "abc\\": unterminated backslash-escape`,
+		},
+		"unterminated_escape_only": {
+			command:    "   \\",
+			errWrapped: ErrEscapeUnterminated,
+			errMessage: `unterminated backslash-escape: "   \\"`,
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			words, err := Split(testCase.command)
+
+			assert.Equal(t, testCase.words, words)
+			assert.ErrorIs(t, err, testCase.errWrapped)
+			if testCase.errWrapped != nil {
+				assert.EqualError(t, err, testCase.errMessage)
+			}
+		})
+	}
+}

internal/command/start.go

@@ -0,0 +1,100 @@
+package command
+
+import (
+	"bufio"
+	"errors"
+	"io"
+	"os"
+	"os/exec"
+)
+
+// Start launches a command and streams stdout and stderr to channels.
+// All the channels returned are ready only and won't be closed
+// if the command fails later.
+func (c *Cmder) Start(cmd *exec.Cmd) (
+	stdoutLines, stderrLines <-chan string,
+	waitError <-chan error, startErr error,
+) {
+	return start(cmd)
+}
+
+func start(cmd execCmd) (stdoutLines, stderrLines <-chan string,
+	waitError <-chan error, startErr error,
+) {
+	stop := make(chan struct{})
+	stdoutReady := make(chan struct{})
+	stdoutLinesCh := make(chan string)
+	stdoutDone := make(chan struct{})
+	stderrReady := make(chan struct{})
+	stderrLinesCh := make(chan string)
+	stderrDone := make(chan struct{})
+
+	stdout, err := cmd.StdoutPipe()
+	if err != nil {
+		return nil, nil, nil, err
+	}
+	go streamToChannel(stdoutReady, stop, stdoutDone, stdout, stdoutLinesCh)
+
+	stderr, err := cmd.StderrPipe()
+	if err != nil {
+		_ = stdout.Close()
+		close(stop)
+		<-stdoutDone
+		return nil, nil, nil, err
+	}
+	go streamToChannel(stderrReady, stop, stderrDone, stderr, stderrLinesCh)
+
+	err = cmd.Start()
+	if err != nil {
+		_ = stdout.Close()
+		_ = stderr.Close()
+		close(stop)
+		<-stdoutDone
+		<-stderrDone
+		return nil, nil, nil, err
+	}
+
+	waitErrorCh := make(chan error)
+	go func() {
+		err := cmd.Wait()
+		_ = stdout.Close()
+		_ = stderr.Close()
+		close(stop)
+		<-stdoutDone
+		<-stderrDone
+		waitErrorCh <- err
+	}()
+
+	return stdoutLinesCh, stderrLinesCh, waitErrorCh, nil
+}
+
+func streamToChannel(ready chan<- struct{},
+	stop <-chan struct{}, done chan<- struct{},
+	stream io.Reader, lines chan<- string,
+) {
+	defer close(done)
+	close(ready)
+	scanner := bufio.NewScanner(stream)
+	lineBuffer := make([]byte, bufio.MaxScanTokenSize) // 64KB
+	const maxCapacity = 20 * 1024 * 1024               // 20MB
+	scanner.Buffer(lineBuffer, maxCapacity)
+
+	for scanner.Scan() {
+		// scanner is closed if the context is canceled
+		// or if the command failed starting because the
+		// stream is closed (io.EOF error).
+		lines <- scanner.Text()
+	}
+	err := scanner.Err()
+	if err == nil || errors.Is(err, os.ErrClosed) {
+		return
+	}
+
+	// ignore the error if it is stopped.
+	select {
+	case <-stop:
+		return
+	default:
+		lines <- "stream error: " + err.Error()
+	}
+}

internal/command/start_test.go

@@ -0,0 +1,118 @@
+package command
+
+import (
+	"bytes"
+	"errors"
+	"io"
+	"strings"
+	"testing"
+
+	gomock "github.com/golang/mock/gomock"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func linesToReadCloser(lines []string) io.ReadCloser {
+	s := strings.Join(lines, "\n")
+	return io.NopCloser(bytes.NewBufferString(s))
+}
+
+func Test_start(t *testing.T) {
+	t.Parallel()
+
+	errDummy := errors.New("dummy")
+
+	testCases := map[string]struct {
+		stdout        []string
+		stdoutPipeErr error
+		stderr        []string
+		stderrPipeErr error
+		startErr      error
+		waitErr       error
+		err           error
+	}{
+		"no output": {},
+		"success": {
+			stdout: []string{"hello", "world"},
+			stderr: []string{"some", "error"},
+		},
+		"stdout pipe error": {
+			stdoutPipeErr: errDummy,
+			err:           errDummy,
+		},
+		"stderr pipe error": {
+			stderrPipeErr: errDummy,
+			err:           errDummy,
+		},
+		"start error": {
+			startErr: errDummy,
+			err:      errDummy,
+		},
+		"wait error": {
+			waitErr: errDummy,
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			ctrl := gomock.NewController(t)
+
+			stdout := linesToReadCloser(testCase.stdout)
+			stderr := linesToReadCloser(testCase.stderr)
+
+			mockCmd := NewMockexecCmd(ctrl)
+
+			mockCmd.EXPECT().StdoutPipe().
+				Return(stdout, testCase.stdoutPipeErr)
+			if testCase.stdoutPipeErr == nil {
+				mockCmd.EXPECT().StderrPipe().Return(stderr, testCase.stderrPipeErr)
+				if testCase.stderrPipeErr == nil {
+					mockCmd.EXPECT().Start().Return(testCase.startErr)
+					if testCase.startErr == nil {
+						mockCmd.EXPECT().Wait().Return(testCase.waitErr)
+					}
+				}
+			}
+
+			stdoutLines, stderrLines, waitError, err := start(mockCmd)
+
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+				assert.Nil(t, stdoutLines)
+				assert.Nil(t, stderrLines)
+				assert.Nil(t, waitError)
+				return
+			}
+
+			require.NoError(t, err)
+
+			var stdoutIndex, stderrIndex int
+
+			done := false
+			for !done {
+				select {
+				case line := <-stdoutLines:
+					assert.Equal(t, testCase.stdout[stdoutIndex], line)
+					stdoutIndex++
+				case line := <-stderrLines:
+					assert.Equal(t, testCase.stderr[stderrIndex], line)
+					stderrIndex++
+				case err := <-waitError:
+					if testCase.waitErr != nil {
+						require.Error(t, err)
+						assert.Equal(t, testCase.waitErr.Error(), err.Error())
+					} else {
+						assert.NoError(t, err)
+					}
+					done = true
+				}
+			}
+
+			assert.Equal(t, len(testCase.stdout), stdoutIndex)
+			assert.Equal(t, len(testCase.stderr), stderrIndex)
+		})
+	}
+}

internal/configuration/settings/deprecated.go

@@ -0,0 +1,27 @@
+package settings
+
+import (
+	"slices"
+
+	"github.com/qdm12/gosettings/reader"
+	"golang.org/x/exp/maps"
+)
+
+func readObsolete(r *reader.Reader) (warnings []string) {
+	keyToMessage := map[string]string{
+		"DOT_VERBOSITY":                "DOT_VERBOSITY is obsolete, use LOG_LEVEL instead.",
+		"DOT_VERBOSITY_DETAILS":        "DOT_VERBOSITY_DETAILS is obsolete because it was specific to Unbound.",
+		"DOT_VALIDATION_LOGLEVEL":      "DOT_VALIDATION_LOGLEVEL is obsolete because DNSSEC validation is not implemented.",
+		"HEALTH_VPN_DURATION_INITIAL":  "HEALTH_VPN_DURATION_INITIAL is obsolete",
+		"HEALTH_VPN_DURATION_ADDITION": "HEALTH_VPN_DURATION_ADDITION is obsolete",
+	}
+	sortedKeys := maps.Keys(keyToMessage)
+	slices.Sort(sortedKeys)
+	warnings = make([]string, 0, len(keyToMessage))
+	for _, key := range sortedKeys {
+		if r.Get(key) != nil {
+			warnings = append(warnings, keyToMessage[key])
+		}
+	}
+	return warnings
+}

internal/configuration/settings/dns.go

@@ -0,0 +1,101 @@
+package settings
+
+import (
+	"fmt"
+	"net/netip"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"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(),
+	}
+}
+
+// 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
+}
+
+func (d *DNS) read(r *reader.Reader) (err error) {
+	d.ServerAddress, err = r.NetipAddr("DNS_ADDRESS", reader.RetroKeys("DNS_PLAINTEXT_ADDRESS"))
+	if err != nil {
+		return err
+	}
+
+	d.KeepNameserver, err = r.BoolPtr("DNS_KEEP_NAMESERVER")
+	if err != nil {
+		return err
+	}
+
+	err = d.DoT.read(r)
+	if err != nil {
+		return fmt.Errorf("DNS over TLS settings: %w", err)
+	}
+
+	return nil
+}

internal/configuration/settings/dnsblacklist.go

@@ -0,0 +1,195 @@
+package settings
+
+import (
+	"errors"
+	"fmt"
+	"net/http"
+	"net/netip"
+	"regexp"
+
+	"github.com/qdm12/dns/v2/pkg/blockbuilder"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"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) 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) ToBlockBuilderSettings(client *http.Client) (
+	settings blockbuilder.Settings,
+) {
+	return blockbuilder.Settings{
+		Client:               client,
+		BlockMalicious:       b.BlockMalicious,
+		BlockAds:             b.BlockAds,
+		BlockSurveillance:    b.BlockSurveillance,
+		AllowedHosts:         b.AllowedHosts,
+		AddBlockedHosts:      b.AddBlockedHosts,
+		AddBlockedIPs:        b.AddBlockedIPs,
+		AddBlockedIPPrefixes: b.AddBlockedIPPrefixes,
+	}
+}
+
+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.Append("Allowed hosts:")
+		for _, host := range b.AllowedHosts {
+			allowedHostsNode.Append(host)
+		}
+	}
+
+	if len(b.AddBlockedHosts) > 0 {
+		blockedHostsNode := node.Append("Blocked hosts:")
+		for _, host := range b.AddBlockedHosts {
+			blockedHostsNode.Append(host)
+		}
+	}
+
+	if len(b.AddBlockedIPs) > 0 {
+		blockedIPsNode := node.Append("Blocked IP addresses:")
+		for _, ip := range b.AddBlockedIPs {
+			blockedIPsNode.Append(ip.String())
+		}
+	}
+
+	if len(b.AddBlockedIPPrefixes) > 0 {
+		blockedIPPrefixesNode := node.Append("Blocked IP networks:")
+		for _, ipNetwork := range b.AddBlockedIPPrefixes {
+			blockedIPPrefixesNode.Append(ipNetwork.String())
+		}
+	}
+
+	return node
+}
+
+func (b *DNSBlacklist) read(r *reader.Reader) (err error) {
+	b.BlockMalicious, err = r.BoolPtr("BLOCK_MALICIOUS")
+	if err != nil {
+		return err
+	}
+
+	b.BlockSurveillance, err = r.BoolPtr("BLOCK_SURVEILLANCE",
+		reader.RetroKeys("BLOCK_NSA"))
+	if err != nil {
+		return err
+	}
+
+	b.BlockAds, err = r.BoolPtr("BLOCK_ADS")
+	if err != nil {
+		return err
+	}
+
+	b.AddBlockedIPs, b.AddBlockedIPPrefixes,
+		err = readDoTPrivateAddresses(r) // TODO v4 split in 2
+	if err != nil {
+		return err
+	}
+
+	b.AllowedHosts = r.CSV("UNBLOCK") // TODO v4 change name
+
+	return nil
+}
+
+var ErrPrivateAddressNotValid = errors.New("private address is not a valid IP or CIDR range")
+
+func readDoTPrivateAddresses(reader *reader.Reader) (ips []netip.Addr,
+	ipPrefixes []netip.Prefix, err error,
+) {
+	privateAddresses := reader.CSV("DOT_PRIVATE_ADDRESS")
+	if len(privateAddresses) == 0 {
+		return nil, nil, nil
+	}
+
+	ips = make([]netip.Addr, 0, len(privateAddresses))
+	ipPrefixes = make([]netip.Prefix, 0, len(privateAddresses))
+
+	for _, privateAddress := range privateAddresses {
+		ip, err := netip.ParseAddr(privateAddress)
+		if err == nil {
+			ips = append(ips, ip)
+			continue
+		}
+
+		ipPrefix, err := netip.ParsePrefix(privateAddress)
+		if err == nil {
+			ipPrefixes = append(ipPrefixes, ipPrefix)
+			continue
+		}
+
+		return nil, nil, fmt.Errorf(
+			"environment variable DOT_PRIVATE_ADDRESS: %w: %s",
+			ErrPrivateAddressNotValid, privateAddress)
+	}
+
+	return ips, ipPrefixes, nil
+}

internal/configuration/settings/dot.go

@@ -0,0 +1,170 @@
+package settings
+
+import (
+	"errors"
+	"fmt"
+	"net/netip"
+	"time"
+
+	"github.com/qdm12/dns/v2/pkg/provider"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"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.
+	// 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
+	// Providers is a list of DNS over TLS providers
+	Providers []string `json:"providers"`
+	// Caching is true if the DoT server should cache
+	// DNS responses.
+	Caching *bool `json:"caching"`
+	// IPv6 is true if the DoT server should connect over IPv6.
+	IPv6 *bool `json:"ipv6"`
+	// 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)
+	}
+
+	providers := provider.NewProviders()
+	for _, providerName := range d.Providers {
+		_, err := providers.Get(providerName)
+		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),
+		Providers:    gosettings.CopySlice(d.Providers),
+		Caching:      gosettings.CopyPointer(d.Caching),
+		IPv6:         gosettings.CopyPointer(d.IPv6),
+		Blacklist:    d.Blacklist.copy(),
+	}
+}
+
+// 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.Providers = gosettings.OverrideWithSlice(d.Providers, other.Providers)
+	d.Caching = gosettings.OverrideWithPointer(d.Caching, other.Caching)
+	d.IPv6 = gosettings.OverrideWithPointer(d.IPv6, other.IPv6)
+	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.Providers = gosettings.DefaultSlice(d.Providers, []string{
+		provider.Cloudflare().Name,
+	})
+	d.Caching = gosettings.DefaultPointer(d.Caching, true)
+	d.IPv6 = gosettings.DefaultPointer(d.IPv6, false)
+	d.Blacklist.setDefaults()
+}
+
+func (d DoT) GetFirstPlaintextIPv4() (ipv4 netip.Addr) {
+	providers := provider.NewProviders()
+	provider, err := providers.Get(d.Providers[0])
+	if err != nil {
+		// Settings should be validated before calling this function,
+		// so an error happening here is a programming error.
+		panic(err)
+	}
+
+	return provider.DoT.IPv4[0].Addr()
+}
+
+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"
+	if *d.UpdatePeriod > 0 {
+		update = "every " + d.UpdatePeriod.String()
+	}
+	node.Appendf("Update period: %s", update)
+
+	upstreamResolvers := node.Append("Upstream resolvers:")
+	for _, provider := range d.Providers {
+		upstreamResolvers.Append(provider)
+	}
+
+	node.Appendf("Caching: %s", gosettings.BoolToYesNo(d.Caching))
+	node.Appendf("IPv6: %s", gosettings.BoolToYesNo(d.IPv6))
+
+	node.AppendNode(d.Blacklist.toLinesNode())
+
+	return node
+}
+
+func (d *DoT) read(reader *reader.Reader) (err error) {
+	d.Enabled, err = reader.BoolPtr("DOT")
+	if err != nil {
+		return err
+	}
+
+	d.UpdatePeriod, err = reader.DurationPtr("DNS_UPDATE_PERIOD")
+	if err != nil {
+		return err
+	}
+
+	d.Providers = reader.CSV("DOT_PROVIDERS")
+
+	d.Caching, err = reader.BoolPtr("DOT_CACHING")
+	if err != nil {
+		return err
+	}
+
+	d.IPv6, err = reader.BoolPtr("DOT_IPV6")
+	if err != nil {
+		return err
+	}
+
+	err = d.Blacklist.read(reader)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/settings/errors.go

@@ -0,0 +1,56 @@
+package settings
+
+import "errors"
+
+var (
+	ErrValueUnknown                    = errors.New("value is unknown")
+	ErrCityNotValid                    = errors.New("the city specified is not valid")
+	ErrControlServerPrivilegedPort     = errors.New("cannot use privileged port without running as root")
+	ErrCategoryNotValid                = errors.New("the category specified is not valid")
+	ErrCountryNotValid                 = errors.New("the country specified is not valid")
+	ErrFilepathMissing                 = errors.New("filepath is missing")
+	ErrFirewallZeroPort                = errors.New("cannot have a zero port")
+	ErrFirewallPublicOutboundSubnet    = errors.New("outbound subnet has an unspecified address")
+	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")
+	ErrPortForwardingUserEmpty         = errors.New("port forwarding username is empty")
+	ErrPortForwardingPasswordEmpty     = errors.New("port forwarding password is empty")
+	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")
+	ErrWireguardKeepAliveNegative      = errors.New("persistent keep alive interval is negative")
+	ErrWireguardImplementationNotValid = errors.New("implementation is not valid")
+)

internal/configuration/settings/firewall.go

@@ -0,0 +1,142 @@
+package settings
+
+import (
+	"fmt"
+	"net/netip"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"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)
+	}
+
+	for _, subnet := range f.OutboundSubnets {
+		if subnet.Addr().IsUnspecified() {
+			return fmt.Errorf("%w: %s", ErrFirewallPublicOutboundSubnet, subnet)
+		}
+	}
+
+	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),
+	}
+}
+
+// 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 {
+			outboundSubnets.Appendf("%s", &subnet)
+		}
+	}
+
+	return node
+}
+
+func (f *Firewall) read(r *reader.Reader) (err error) {
+	f.VPNInputPorts, err = r.CSVUint16("FIREWALL_VPN_INPUT_PORTS")
+	if err != nil {
+		return err
+	}
+
+	f.InputPorts, err = r.CSVUint16("FIREWALL_INPUT_PORTS")
+	if err != nil {
+		return err
+	}
+
+	f.OutboundSubnets, err = r.CSVNetipPrefixes(
+		"FIREWALL_OUTBOUND_SUBNETS", reader.RetroKeys("EXTRA_SUBNETS"))
+	if err != nil {
+		return err
+	}
+
+	f.Enabled, err = r.BoolPtr("FIREWALL_ENABLED_DISABLING_IT_SHOOTS_YOU_IN_YOUR_FOOT")
+	if err != nil {
+		return err
+	}
+
+	f.Debug, err = r.BoolPtr("FIREWALL_DEBUG")
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/settings/firewall_test.go

@@ -0,0 +1,73 @@
+package settings
+
+import (
+	"net/netip"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_Firewall_validate(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		firewall   Firewall
+		errWrapped error
+		errMessage string
+	}{
+		"empty": {},
+		"zero_vpn_input_port": {
+			firewall: Firewall{
+				VPNInputPorts: []uint16{0},
+			},
+			errWrapped: ErrFirewallZeroPort,
+			errMessage: "VPN input ports: cannot have a zero port",
+		},
+		"zero_input_port": {
+			firewall: Firewall{
+				InputPorts: []uint16{0},
+			},
+			errWrapped: ErrFirewallZeroPort,
+			errMessage: "input ports: cannot have a zero port",
+		},
+		"unspecified_outbound_subnet": {
+			firewall: Firewall{
+				OutboundSubnets: []netip.Prefix{
+					netip.MustParsePrefix("0.0.0.0/0"),
+				},
+			},
+			errWrapped: ErrFirewallPublicOutboundSubnet,
+			errMessage: "outbound subnet has an unspecified address: 0.0.0.0/0",
+		},
+		"public_outbound_subnet": {
+			firewall: Firewall{
+				OutboundSubnets: []netip.Prefix{
+					netip.MustParsePrefix("1.2.3.4/32"),
+				},
+			},
+		},
+		"valid_settings": {
+			firewall: Firewall{
+				VPNInputPorts: []uint16{100, 101},
+				InputPorts:    []uint16{200, 201},
+				OutboundSubnets: []netip.Prefix{
+					netip.MustParsePrefix("192.168.1.0/24"),
+					netip.MustParsePrefix("10.10.1.1/32"),
+				},
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			err := testCase.firewall.validate()
+
+			assert.ErrorIs(t, err, testCase.errWrapped)
+			if testCase.errWrapped != nil {
+				assert.EqualError(t, err, testCase.errMessage)
+			}
+		})
+	}
+}

internal/configuration/settings/health.go

@@ -0,0 +1,113 @@
+package settings
+
+import (
+	"fmt"
+	"net/netip"
+	"os"
+	"time"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
+	"github.com/qdm12/gotree"
+)
+
+// 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 TLS dial to periodically for the health check.
+	// It cannot be the empty string in the internal state.
+	TargetAddress string
+	// ICMPTargetIP is the IP address to use for ICMP echo requests
+	// in the health checker. It can be set to an unspecified address
+	// such that the VPN server IP is used, which is also the default behavior.
+	ICMPTargetIP netip.Addr
+	// RestartVPN indicates whether to restart the VPN connection
+	// when the healthcheck fails.
+	RestartVPN *bool
+}
+
+func (h Health) Validate() (err error) {
+	err = validate.ListeningAddress(h.ServerAddress, os.Getuid())
+	if err != nil {
+		return fmt.Errorf("server listening address is not valid: %w", err)
+	}
+
+	return nil
+}
+
+func (h *Health) copy() (copied Health) {
+	return Health{
+		ServerAddress:     h.ServerAddress,
+		ReadHeaderTimeout: h.ReadHeaderTimeout,
+		ReadTimeout:       h.ReadTimeout,
+		TargetAddress:     h.TargetAddress,
+		ICMPTargetIP:      h.ICMPTargetIP,
+		RestartVPN:        gosettings.CopyPointer(h.RestartVPN),
+	}
+}
+
+// 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.OverrideWithComparable(h.ServerAddress, other.ServerAddress)
+	h.ReadHeaderTimeout = gosettings.OverrideWithComparable(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
+	h.ReadTimeout = gosettings.OverrideWithComparable(h.ReadTimeout, other.ReadTimeout)
+	h.TargetAddress = gosettings.OverrideWithComparable(h.TargetAddress, other.TargetAddress)
+	h.ICMPTargetIP = gosettings.OverrideWithComparable(h.ICMPTargetIP, other.ICMPTargetIP)
+	h.RestartVPN = gosettings.OverrideWithPointer(h.RestartVPN, other.RestartVPN)
+}
+
+func (h *Health) SetDefaults() {
+	h.ServerAddress = gosettings.DefaultComparable(h.ServerAddress, "127.0.0.1:9999")
+	const defaultReadHeaderTimeout = 100 * time.Millisecond
+	h.ReadHeaderTimeout = gosettings.DefaultComparable(h.ReadHeaderTimeout, defaultReadHeaderTimeout)
+	const defaultReadTimeout = 500 * time.Millisecond
+	h.ReadTimeout = gosettings.DefaultComparable(h.ReadTimeout, defaultReadTimeout)
+	h.TargetAddress = gosettings.DefaultComparable(h.TargetAddress, "cloudflare.com:443")
+	h.ICMPTargetIP = gosettings.DefaultComparable(h.ICMPTargetIP, netip.IPv4Unspecified()) // use the VPN server IP
+	h.RestartVPN = gosettings.DefaultPointer(h.RestartVPN, true)
+}
+
+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)
+	icmpTarget := "VPN server IP"
+	if !h.ICMPTargetIP.IsUnspecified() {
+		icmpTarget = h.ICMPTargetIP.String()
+	}
+	node.Appendf("ICMP target IP: %s", icmpTarget)
+	node.Appendf("Restart VPN on healthcheck failure: %s", gosettings.BoolToYesNo(h.RestartVPN))
+	return node
+}
+
+func (h *Health) Read(r *reader.Reader) (err error) {
+	h.ServerAddress = r.String("HEALTH_SERVER_ADDRESS")
+	h.TargetAddress = r.String("HEALTH_TARGET_ADDRESS",
+		reader.RetroKeys("HEALTH_ADDRESS_TO_PING"))
+	h.ICMPTargetIP, err = r.NetipAddr("HEALTH_ICMP_TARGET_IP")
+	if err != nil {
+		return err
+	}
+	h.RestartVPN, err = r.BoolPtr("HEALTH_RESTART_VPN")
+	if err != nil {
+		return err
+	}
+	return nil
+}

internal/configuration/settings/helpers.go

@@ -0,0 +1,5 @@
+package settings
+
+func ptrTo[T any](value T) *T {
+	return &value
+}

internal/configuration/settings/helpers/belong.go

@@ -0,0 +1,10 @@
+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_test.go

@@ -0,0 +1,30 @@
+package settings
+
+import gomock "github.com/golang/mock/gomock"
+
+type sourceKeyValue struct {
+	key   string
+	value string
+}
+
+func newMockSource(ctrl *gomock.Controller, keyValues []sourceKeyValue) *MockSource {
+	source := NewMockSource(ctrl)
+	var previousCall *gomock.Call
+	for _, keyValue := range keyValues {
+		transformedKey := keyValue.key
+		keyTransformCall := source.EXPECT().KeyTransform(keyValue.key).Return(transformedKey)
+		if previousCall != nil {
+			keyTransformCall.After(previousCall)
+		}
+		isSet := keyValue.value != ""
+		previousCall = source.EXPECT().Get(transformedKey).
+			Return(keyValue.value, isSet).After(keyTransformCall)
+		if isSet {
+			previousCall = source.EXPECT().KeyTransform(keyValue.key).
+				Return(transformedKey).After(previousCall)
+			previousCall = source.EXPECT().String().
+				Return("mock source").After(previousCall)
+		}
+	}
+	return source
+}

internal/configuration/settings/httpproxy.go

@@ -0,0 +1,182 @@
+package settings
+
+import (
+	"fmt"
+	"os"
+	"strings"
+	"time"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
+	"github.com/qdm12/gotree"
+)
+
+// 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
+	err = validate.ListeningAddress(h.ListeningAddress, os.Getuid())
+	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,
+	}
+}
+
+// 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.OverrideWithComparable(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.OverrideWithComparable(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
+	h.ReadTimeout = gosettings.OverrideWithComparable(h.ReadTimeout, other.ReadTimeout)
+}
+
+func (h *HTTPProxy) setDefaults() {
+	h.User = gosettings.DefaultPointer(h.User, "")
+	h.Password = gosettings.DefaultPointer(h.Password, "")
+	h.ListeningAddress = gosettings.DefaultComparable(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.DefaultComparable(h.ReadHeaderTimeout, defaultReadHeaderTimeout)
+	const defaultReadTimeout = 3 * time.Second
+	h.ReadTimeout = gosettings.DefaultComparable(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
+}
+
+func (h *HTTPProxy) read(r *reader.Reader) (err error) {
+	h.User = r.Get("HTTPPROXY_USER",
+		reader.RetroKeys("PROXY_USER", "TINYPROXY_USER"),
+		reader.ForceLowercase(false))
+
+	h.Password = r.Get("HTTPPROXY_PASSWORD",
+		reader.RetroKeys("PROXY_PASSWORD", "TINYPROXY_PASSWORD"),
+		reader.ForceLowercase(false))
+
+	h.ListeningAddress, err = readHTTProxyListeningAddress(r)
+	if err != nil {
+		return err
+	}
+
+	h.Enabled, err = r.BoolPtr("HTTPPROXY", reader.RetroKeys("PROXY", "TINYPROXY"))
+	if err != nil {
+		return err
+	}
+
+	h.Stealth, err = r.BoolPtr("HTTPPROXY_STEALTH")
+	if err != nil {
+		return err
+	}
+
+	h.Log, err = readHTTProxyLog(r)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func readHTTProxyListeningAddress(r *reader.Reader) (listeningAddress string, err error) {
+	// Retro-compatible keys using a port only
+	port, err := r.Uint16Ptr("",
+		reader.RetroKeys("HTTPPROXY_PORT", "TINYPROXY_PORT", "PROXY_PORT"),
+		reader.IsRetro("HTTPPROXY_LISTENING_ADDRESS"))
+	if err != nil {
+		return "", err
+	} else if port != nil {
+		return fmt.Sprintf(":%d", *port), nil
+	}
+	const currentKey = "HTTPPROXY_LISTENING_ADDRESS"
+	return r.String(currentKey), nil
+}
+
+func readHTTProxyLog(r *reader.Reader) (enabled *bool, err error) {
+	const currentKey = "HTTPPROXY_LOG"
+	// Retro-compatible keys using different boolean verbs
+	value := r.String("",
+		reader.RetroKeys("PROXY_LOG", "TINYPROXY_LOG"),
+		reader.IsRetro(currentKey))
+	switch strings.ToLower(value) {
+	case "":
+		return r.BoolPtr(currentKey)
+	case "on", "info", "connect", "notice":
+		return ptrTo(true), nil
+	case "disabled", "no", "off":
+		return ptrTo(false), nil
+	default:
+		return nil, fmt.Errorf("HTTP retro-compatible proxy log setting: %w: %s",
+			ErrValueUnknown, value)
+	}
+}

internal/configuration/settings/interfaces.go

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

internal/configuration/settings/log.go

@@ -0,0 +1,57 @@
+package settings
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"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 empty in the internal state.
+	Level string
+}
+
+func (l Log) validate() (err error) {
+	_, err = log.ParseLevel(l.Level)
+	if err != nil {
+		return fmt.Errorf("level: %w", err)
+	}
+	return nil
+}
+
+func (l *Log) copy() (copied Log) {
+	return Log{
+		Level: l.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.OverrideWithComparable(l.Level, other.Level)
+}
+
+func (l *Log) setDefaults() {
+	l.Level = gosettings.DefaultComparable(l.Level, log.LevelInfo.String())
+}
+
+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)
+	return node
+}
+
+func (l *Log) read(r *reader.Reader) (err error) {
+	l.Level = r.String("LOG_LEVEL")
+	return nil
+}

internal/configuration/settings/mocks_generate_test.go

@@ -0,0 +1,4 @@
+package settings
+
+//go:generate mockgen -destination=mocks_test.go -package=$GOPACKAGE . Warner
+//go:generate mockgen -destination=mocks_reader_test.go -package=$GOPACKAGE github.com/qdm12/gosettings/reader Source

internal/configuration/settings/mocks_reader_test.go

@@ -0,0 +1,77 @@
+// Code generated by MockGen. DO NOT EDIT.
+// Source: github.com/qdm12/gosettings/reader (interfaces: Source)
+
+// Package settings is a generated GoMock package.
+package settings
+
+import (
+	reflect "reflect"
+
+	gomock "github.com/golang/mock/gomock"
+)
+
+// MockSource is a mock of Source interface.
+type MockSource struct {
+	ctrl     *gomock.Controller
+	recorder *MockSourceMockRecorder
+}
+
+// MockSourceMockRecorder is the mock recorder for MockSource.
+type MockSourceMockRecorder struct {
+	mock *MockSource
+}
+
+// NewMockSource creates a new mock instance.
+func NewMockSource(ctrl *gomock.Controller) *MockSource {
+	mock := &MockSource{ctrl: ctrl}
+	mock.recorder = &MockSourceMockRecorder{mock}
+	return mock
+}
+
+// EXPECT returns an object that allows the caller to indicate expected use.
+func (m *MockSource) EXPECT() *MockSourceMockRecorder {
+	return m.recorder
+}
+
+// Get mocks base method.
+func (m *MockSource) Get(arg0 string) (string, bool) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "Get", arg0)
+	ret0, _ := ret[0].(string)
+	ret1, _ := ret[1].(bool)
+	return ret0, ret1
+}
+
+// Get indicates an expected call of Get.
+func (mr *MockSourceMockRecorder) Get(arg0 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Get", reflect.TypeOf((*MockSource)(nil).Get), arg0)
+}
+
+// KeyTransform mocks base method.
+func (m *MockSource) KeyTransform(arg0 string) string {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "KeyTransform", arg0)
+	ret0, _ := ret[0].(string)
+	return ret0
+}
+
+// KeyTransform indicates an expected call of KeyTransform.
+func (mr *MockSourceMockRecorder) KeyTransform(arg0 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "KeyTransform", reflect.TypeOf((*MockSource)(nil).KeyTransform), arg0)
+}
+
+// String mocks base method.
+func (m *MockSource) String() string {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "String")
+	ret0, _ := ret[0].(string)
+	return ret0
+}
+
+// String indicates an expected call of String.
+func (mr *MockSourceMockRecorder) String() *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "String", reflect.TypeOf((*MockSource)(nil).String))
+}

internal/configuration/settings/mocks_test.go

@@ -0,0 +1,46 @@
+// Code generated by MockGen. DO NOT EDIT.
+// Source: github.com/qdm12/gluetun/internal/configuration/settings (interfaces: Warner)
+
+// Package settings is a generated GoMock package.
+package settings
+
+import (
+	reflect "reflect"
+
+	gomock "github.com/golang/mock/gomock"
+)
+
+// MockWarner is a mock of Warner interface.
+type MockWarner struct {
+	ctrl     *gomock.Controller
+	recorder *MockWarnerMockRecorder
+}
+
+// MockWarnerMockRecorder is the mock recorder for MockWarner.
+type MockWarnerMockRecorder struct {
+	mock *MockWarner
+}
+
+// NewMockWarner creates a new mock instance.
+func NewMockWarner(ctrl *gomock.Controller) *MockWarner {
+	mock := &MockWarner{ctrl: ctrl}
+	mock.recorder = &MockWarnerMockRecorder{mock}
+	return mock
+}
+
+// EXPECT returns an object that allows the caller to indicate expected use.
+func (m *MockWarner) EXPECT() *MockWarnerMockRecorder {
+	return m.recorder
+}
+
+// Warn mocks base method.
+func (m *MockWarner) Warn(arg0 string) {
+	m.ctrl.T.Helper()
+	m.ctrl.Call(m, "Warn", arg0)
+}
+
+// Warn indicates an expected call of Warn.
+func (mr *MockWarnerMockRecorder) Warn(arg0 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Warn", reflect.TypeOf((*MockWarner)(nil).Warn), arg0)
+}

internal/configuration/settings/nordvpn_retro.go

@@ -0,0 +1,43 @@
+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

@@ -0,0 +1,436 @@
+package settings
+
+import (
+	"encoding/base64"
+	"fmt"
+	"regexp"
+	"strings"
+
+	"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/reader"
+	"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),
+	}
+}
+
+// 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.OverrideWithComparable(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.OverrideWithComparable(o.Interface, other.Interface)
+	o.ProcessUser = gosettings.OverrideWithComparable(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.DefaultComparable(o.Version, openvpn.Openvpn26)
+	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.DefaultComparable(o.Interface, "tun0")
+	o.ProcessUser = gosettings.DefaultComparable(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
+}
+
+func (o *OpenVPN) read(r *reader.Reader) (err error) {
+	o.Version = r.String("OPENVPN_VERSION")
+	o.User = r.Get("OPENVPN_USER", reader.RetroKeys("USER"), reader.ForceLowercase(false))
+	o.Password = r.Get("OPENVPN_PASSWORD", reader.RetroKeys("PASSWORD"), reader.ForceLowercase(false))
+	o.ConfFile = r.Get("OPENVPN_CUSTOM_CONFIG", reader.ForceLowercase(false))
+	o.Ciphers = r.CSV("OPENVPN_CIPHERS", reader.RetroKeys("OPENVPN_CIPHER"))
+	o.Auth = r.Get("OPENVPN_AUTH")
+	o.Cert = r.Get("OPENVPN_CERT", reader.ForceLowercase(false))
+	o.Key = r.Get("OPENVPN_KEY", reader.ForceLowercase(false))
+	o.EncryptedKey = r.Get("OPENVPN_ENCRYPTED_KEY", reader.ForceLowercase(false))
+	o.KeyPassphrase = r.Get("OPENVPN_KEY_PASSPHRASE", reader.ForceLowercase(false))
+	o.PIAEncPreset = r.Get("PRIVATE_INTERNET_ACCESS_OPENVPN_ENCRYPTION_PRESET",
+		reader.RetroKeys("ENCRYPTION", "PIA_ENCRYPTION"))
+
+	o.MSSFix, err = r.Uint16Ptr("OPENVPN_MSSFIX")
+	if err != nil {
+		return err
+	}
+
+	o.Interface = r.String("VPN_INTERFACE",
+		reader.RetroKeys("OPENVPN_INTERFACE"), reader.ForceLowercase(false))
+
+	o.ProcessUser, err = readOpenVPNProcessUser(r)
+	if err != nil {
+		return err
+	}
+
+	o.Verbosity, err = r.IntPtr("OPENVPN_VERBOSITY")
+	if err != nil {
+		return err
+	}
+
+	flagsPtr := r.Get("OPENVPN_FLAGS", reader.ForceLowercase(false))
+	if flagsPtr != nil {
+		o.Flags = strings.Fields(*flagsPtr)
+	}
+
+	return nil
+}
+
+func readOpenVPNProcessUser(r *reader.Reader) (processUser string, err error) {
+	value, err := r.BoolPtr("OPENVPN_ROOT") // Retro-compatibility
+	if err != nil {
+		return "", err
+	} else if value != nil {
+		if *value {
+			return "root", nil
+		}
+		const defaultNonRootUser = "nonrootuser"
+		return defaultNonRootUser, nil
+	}
+
+	return r.String("OPENVPN_PROCESS_USER"), nil
+}

internal/configuration/settings/openvpn_test.go

@@ -0,0 +1,43 @@
+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 {
+		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

@@ -0,0 +1,207 @@
+package settings
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/constants/providers"
+	"github.com/qdm12/gluetun/internal/provider/privateinternetaccess/presets"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"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"`
+	// Protocol is the OpenVPN network protocol to use,
+	// and can be udp or tcp. It cannot be the empty string
+	// in the internal state.
+	Protocol string `json:"protocol"`
+	// 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)
+		}
+	}
+
+	err = validate.IsOneOf(o.Protocol, constants.UDP, constants.TCP)
+	if err != nil {
+		return fmt.Errorf("network protocol: %w", err)
+	}
+
+	// Validate TCP
+	if o.Protocol == constants.TCP && helpers.IsOneOf(vpnProvider,
+		providers.Giganews,
+		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.Giganews, 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.Protocol == constants.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),
+		Protocol:     o.Protocol,
+		CustomPort:   gosettings.CopyPointer(o.CustomPort),
+		PIAEncPreset: gosettings.CopyPointer(o.PIAEncPreset),
+	}
+}
+
+func (o *OpenVPNSelection) overrideWith(other OpenVPNSelection) {
+	o.ConfFile = gosettings.OverrideWithPointer(o.ConfFile, other.ConfFile)
+	o.Protocol = gosettings.OverrideWithComparable(o.Protocol, other.Protocol)
+	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.Protocol = gosettings.DefaultComparable(o.Protocol, constants.UDP)
+	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", strings.ToUpper(o.Protocol))
+
+	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
+}
+
+func (o *OpenVPNSelection) read(r *reader.Reader) (err error) {
+	o.ConfFile = r.Get("OPENVPN_CUSTOM_CONFIG", reader.ForceLowercase(false))
+
+	o.Protocol = r.String("OPENVPN_PROTOCOL", reader.RetroKeys("PROTOCOL"))
+
+	o.CustomPort, err = r.Uint16Ptr("OPENVPN_ENDPOINT_PORT",
+		reader.RetroKeys("PORT", "OPENVPN_PORT", "VPN_ENDPOINT_PORT"))
+	if err != nil {
+		return err
+	}
+
+	o.PIAEncPreset = r.Get("PRIVATE_INTERNET_ACCESS_OPENVPN_ENCRYPTION_PRESET",
+		reader.RetroKeys("ENCRYPTION", "PIA_ENCRYPTION"))
+
+	return nil
+}

internal/configuration/settings/portforward.go

@@ -0,0 +1,215 @@
+package settings
+
+import (
+	"fmt"
+	"path/filepath"
+
+	"github.com/qdm12/gluetun/internal/constants/providers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"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 forwarding 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"`
+	// UpCommand is the command to use when the port forwarding is up.
+	// It can be the empty string to indicate not to run a command.
+	// It cannot be nil in the internal state.
+	UpCommand *string `json:"up_command"`
+	// DownCommand is the command to use after the port forwarding goes down.
+	// It can be the empty string to indicate to NOT run a command.
+	// It cannot be nil in the internal state.
+	DownCommand *string `json:"down_command"`
+	// 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"`
+	// Username is only used for Private Internet Access port forwarding.
+	Username string `json:"username"`
+	// Password is only used for Private Internet Access port forwarding.
+	Password string `json:"password"`
+}
+
+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.Perfectprivacy,
+		providers.PrivateInternetAccess,
+		providers.Privatevpn,
+		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)
+		}
+	}
+
+	if providerSelected == providers.PrivateInternetAccess {
+		switch {
+		case p.Username == "":
+			return fmt.Errorf("%w", ErrPortForwardingUserEmpty)
+		case p.Password == "":
+			return fmt.Errorf("%w", ErrPortForwardingPasswordEmpty)
+		}
+	}
+
+	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),
+		UpCommand:     gosettings.CopyPointer(p.UpCommand),
+		DownCommand:   gosettings.CopyPointer(p.DownCommand),
+		ListeningPort: gosettings.CopyPointer(p.ListeningPort),
+		Username:      p.Username,
+		Password:      p.Password,
+	}
+}
+
+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.UpCommand = gosettings.OverrideWithPointer(p.UpCommand, other.UpCommand)
+	p.DownCommand = gosettings.OverrideWithPointer(p.DownCommand, other.DownCommand)
+	p.ListeningPort = gosettings.OverrideWithPointer(p.ListeningPort, other.ListeningPort)
+	p.Username = gosettings.OverrideWithComparable(p.Username, other.Username)
+	p.Password = gosettings.OverrideWithComparable(p.Password, other.Password)
+}
+
+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.UpCommand = gosettings.DefaultPointer(p.UpCommand, "")
+	p.DownCommand = gosettings.DefaultPointer(p.DownCommand, "")
+	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)
+
+	if *p.UpCommand != "" {
+		node.Appendf("Forwarded port up command: %s", *p.UpCommand)
+	}
+	if *p.DownCommand != "" {
+		node.Appendf("Forwarded port down command: %s", *p.DownCommand)
+	}
+
+	if p.Username != "" {
+		credentialsNode := node.Appendf("Credentials:")
+		credentialsNode.Appendf("Username: %s", p.Username)
+		credentialsNode.Appendf("Password: %s", gosettings.ObfuscateKey(p.Password))
+	}
+
+	return node
+}
+
+func (p *PortForwarding) read(r *reader.Reader) (err error) {
+	p.Enabled, err = r.BoolPtr("VPN_PORT_FORWARDING",
+		reader.RetroKeys(
+			"PORT_FORWARDING",
+			"PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING",
+		))
+	if err != nil {
+		return err
+	}
+
+	p.Provider = r.Get("VPN_PORT_FORWARDING_PROVIDER")
+
+	p.Filepath = r.Get("VPN_PORT_FORWARDING_STATUS_FILE",
+		reader.ForceLowercase(false),
+		reader.RetroKeys(
+			"PORT_FORWARDING_STATUS_FILE",
+			"PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING_STATUS_FILE",
+		))
+
+	p.UpCommand = r.Get("VPN_PORT_FORWARDING_UP_COMMAND",
+		reader.ForceLowercase(false))
+
+	p.DownCommand = r.Get("VPN_PORT_FORWARDING_DOWN_COMMAND",
+		reader.ForceLowercase(false))
+
+	p.ListeningPort, err = r.Uint16Ptr("VPN_PORT_FORWARDING_LISTENING_PORT")
+	if err != nil {
+		return err
+	}
+
+	usernameKeys := []string{"VPN_PORT_FORWARDING_USERNAME", "OPENVPN_USER", "USER"}
+	for _, key := range usernameKeys {
+		p.Username = r.String(key, reader.ForceLowercase(false))
+		if p.Username != "" {
+			break
+		}
+	}
+
+	passwordKeys := []string{"VPN_PORT_FORWARDING_PASSWORD", "OPENVPN_PASSWORD", "PASSWORD"}
+	for _, key := range passwordKeys {
+		p.Password = r.String(key, reader.ForceLowercase(false))
+		if p.Password != "" {
+			break
+		}
+	}
+
+	return nil
+}

internal/configuration/settings/portforward_test.go

@@ -0,0 +1,19 @@
+package settings
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_PortForwarding_String(t *testing.T) {
+	t.Parallel()
+
+	settings := PortForwarding{
+		Enabled: ptrTo(false),
+	}
+
+	s := settings.String()
+
+	assert.Empty(t, s)
+}

internal/configuration/settings/provider.go

@@ -0,0 +1,128 @@
+package settings
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/constants/providers"
+	"github.com/qdm12/gluetun/internal/constants/vpn"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
+	"github.com/qdm12/gotree"
+)
+
+// Provider contains settings specific to a VPN provider.
+type Provider struct {
+	// Name is the VPN service provider name.
+	// It cannot be the empty string in the internal state.
+	Name string `json:"name"`
+	// ServerSelection is the settings to
+	// select the VPN server.
+	ServerSelection ServerSelection `json:"server_selection"`
+	// PortForwarding is the settings about port forwarding.
+	PortForwarding PortForwarding `json:"port_forwarding"`
+}
+
+// TODO v4 remove pointer for receiver (because of Surfshark).
+func (p *Provider) validate(vpnType string, filterChoicesGetter FilterChoicesGetter, warner Warner) (err error) {
+	// Validate Name
+	var validNames []string
+	if vpnType == vpn.OpenVPN {
+		validNames = providers.AllWithCustom()
+		validNames = append(validNames, "pia") // Retro-compatibility
+	} else { // Wireguard
+		validNames = []string{
+			providers.Airvpn,
+			providers.Custom,
+			providers.Fastestvpn,
+			providers.Ivpn,
+			providers.Mullvad,
+			providers.Nordvpn,
+			providers.Protonvpn,
+			providers.Surfshark,
+			providers.Windscribe,
+		}
+	}
+	if err = validate.IsOneOf(p.Name, validNames...); err != nil {
+		return fmt.Errorf("%w for Wireguard: %w", ErrVPNProviderNameNotValid, err)
+	}
+
+	err = p.ServerSelection.validate(p.Name, filterChoicesGetter, warner)
+	if err != nil {
+		return fmt.Errorf("server selection: %w", err)
+	}
+
+	err = p.PortForwarding.Validate(p.Name)
+	if err != nil {
+		return fmt.Errorf("port forwarding: %w", err)
+	}
+
+	return nil
+}
+
+func (p *Provider) copy() (copied Provider) {
+	return Provider{
+		Name:            p.Name,
+		ServerSelection: p.ServerSelection.copy(),
+		PortForwarding:  p.PortForwarding.Copy(),
+	}
+}
+
+func (p *Provider) overrideWith(other Provider) {
+	p.Name = gosettings.OverrideWithComparable(p.Name, other.Name)
+	p.ServerSelection.overrideWith(other.ServerSelection)
+	p.PortForwarding.OverrideWith(other.PortForwarding)
+}
+
+func (p *Provider) setDefaults() {
+	p.Name = gosettings.DefaultComparable(p.Name, providers.PrivateInternetAccess)
+	p.PortForwarding.setDefaults()
+	p.ServerSelection.setDefaults(p.Name, *p.PortForwarding.Enabled)
+}
+
+func (p Provider) String() string {
+	return p.toLinesNode().String()
+}
+
+func (p Provider) toLinesNode() (node *gotree.Node) {
+	node = gotree.New("VPN provider settings:")
+	node.Appendf("Name: %s", p.Name)
+	node.AppendNode(p.ServerSelection.toLinesNode())
+	node.AppendNode(p.PortForwarding.toLinesNode())
+	return node
+}
+
+func (p *Provider) read(r *reader.Reader, vpnType string) (err error) {
+	p.Name = readVPNServiceProvider(r, vpnType)
+
+	err = p.ServerSelection.read(r, p.Name, vpnType)
+	if err != nil {
+		return fmt.Errorf("server selection: %w", err)
+	}
+
+	err = p.PortForwarding.read(r)
+	if err != nil {
+		return fmt.Errorf("port forwarding: %w", err)
+	}
+
+	return nil
+}
+
+func readVPNServiceProvider(r *reader.Reader, vpnType string) (vpnProvider string) {
+	vpnProvider = r.String("VPN_SERVICE_PROVIDER", reader.RetroKeys("VPNSP"))
+	if vpnProvider == "" {
+		if vpnType != vpn.Wireguard && r.Get("OPENVPN_CUSTOM_CONFIG") != nil {
+			// retro compatibility
+			return providers.Custom
+		}
+		return ""
+	}
+
+	vpnProvider = strings.ToLower(vpnProvider)
+	if vpnProvider == "pia" { // retro compatibility
+		return providers.PrivateInternetAccess
+	}
+
+	return vpnProvider
+}

internal/configuration/settings/publicip.go

@@ -0,0 +1,175 @@
+package settings
+
+import (
+	"fmt"
+	"path/filepath"
+
+	"github.com/qdm12/gluetun/internal/publicip/api"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gotree"
+)
+
+// PublicIP contains settings for port forwarding.
+type PublicIP struct {
+	// Enabled is set to true to fetch the public ip address
+	// information on VPN connection. It defaults to true.
+	Enabled *bool
+	// IPFilepath is the public IP address 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
+	IPFilepath *string
+	// APIs is the list of public ip APIs to use to fetch public IP information.
+	// If there is more than one API, the first one is used
+	// by default and the others are used as fallbacks in case of
+	// the service rate limiting us. It defaults to use all services,
+	// with the first one being ipinfo.io for historical reasons.
+	APIs []PublicIPAPI
+}
+
+type PublicIPAPI struct {
+	// Name is the name of the public ip API service.
+	// It can be "cloudflare", "ifconfigco", "ip2location" or "ipinfo".
+	Name string
+	// Token is the token to use for the public ip API service.
+	Token string
+}
+
+// UpdateWith deep copies the receiving settings, overrides the copy with
+// fields set in the partialUpdate argument, validates the new settings
+// and returns them if they are valid, or returns an error otherwise.
+// In all cases, the receiving settings are unmodified.
+func (p PublicIP) UpdateWith(partialUpdate PublicIP) (updatedSettings PublicIP, err error) {
+	updatedSettings = p.copy()
+	updatedSettings.overrideWith(partialUpdate)
+	err = updatedSettings.validate()
+	if err != nil {
+		return updatedSettings, fmt.Errorf("validating updated settings: %w", err)
+	}
+	return updatedSettings, nil
+}
+
+func (p PublicIP) validate() (err error) {
+	if *p.IPFilepath != "" { // optional
+		_, err := filepath.Abs(*p.IPFilepath)
+		if err != nil {
+			return fmt.Errorf("filepath is not valid: %w", err)
+		}
+	}
+
+	for _, publicIPAPI := range p.APIs {
+		_, err = api.ParseProvider(publicIPAPI.Name)
+		if err != nil {
+			return fmt.Errorf("API name: %w", err)
+		}
+	}
+
+	return nil
+}
+
+func (p *PublicIP) copy() (copied PublicIP) {
+	return PublicIP{
+		Enabled:    gosettings.CopyPointer(p.Enabled),
+		IPFilepath: gosettings.CopyPointer(p.IPFilepath),
+		APIs:       gosettings.CopySlice(p.APIs),
+	}
+}
+
+func (p *PublicIP) overrideWith(other PublicIP) {
+	p.Enabled = gosettings.OverrideWithPointer(p.Enabled, other.Enabled)
+	p.IPFilepath = gosettings.OverrideWithPointer(p.IPFilepath, other.IPFilepath)
+	p.APIs = gosettings.OverrideWithSlice(p.APIs, other.APIs)
+}
+
+func (p *PublicIP) setDefaults() {
+	p.Enabled = gosettings.DefaultPointer(p.Enabled, true)
+	p.IPFilepath = gosettings.DefaultPointer(p.IPFilepath, "/tmp/gluetun/ip")
+	p.APIs = gosettings.DefaultSlice(p.APIs, []PublicIPAPI{
+		{Name: string(api.IPInfo)},
+		{Name: string(api.Cloudflare)},
+		{Name: string(api.IfConfigCo)},
+		{Name: string(api.IP2Location)},
+	})
+}
+
+func (p PublicIP) String() string {
+	return p.toLinesNode().String()
+}
+
+func (p PublicIP) toLinesNode() (node *gotree.Node) {
+	if !*p.Enabled {
+		return gotree.New("Public IP settings: disabled")
+	}
+
+	node = gotree.New("Public IP settings:")
+
+	if *p.IPFilepath != "" {
+		node.Appendf("IP file path: %s", *p.IPFilepath)
+	}
+
+	baseAPIString := "Public IP data base API: " + p.APIs[0].Name
+	if p.APIs[0].Token != "" {
+		baseAPIString += " (token " + gosettings.ObfuscateKey(p.APIs[0].Token) + ")"
+	}
+	node.Append(baseAPIString)
+	if len(p.APIs) > 1 {
+		backupAPIsNode := node.Append("Public IP data backup APIs:")
+		for i := 1; i < len(p.APIs); i++ {
+			message := p.APIs[i].Name
+			if p.APIs[i].Token != "" {
+				message += " (token " + gosettings.ObfuscateKey(p.APIs[i].Token) + ")"
+			}
+			backupAPIsNode.Append(message)
+		}
+	}
+
+	return node
+}
+
+func (p *PublicIP) read(r *reader.Reader, warner Warner) (err error) {
+	p.Enabled, err = readPublicIPEnabled(r, warner)
+	if err != nil {
+		return err
+	}
+
+	p.IPFilepath = r.Get("PUBLICIP_FILE",
+		reader.ForceLowercase(false), reader.RetroKeys("IP_STATUS_FILE"))
+
+	apiNames := r.CSV("PUBLICIP_API")
+	if len(apiNames) > 0 {
+		apiTokens := r.CSV("PUBLICIP_API_TOKEN")
+		p.APIs = make([]PublicIPAPI, len(apiNames))
+		for i := range apiNames {
+			p.APIs[i].Name = apiNames[i]
+			var token string
+			if i < len(apiTokens) { // only set token if it exists
+				token = apiTokens[i]
+			}
+			p.APIs[i].Token = token
+		}
+	}
+
+	return nil
+}
+
+func readPublicIPEnabled(r *reader.Reader, warner Warner) (
+	enabled *bool, err error,
+) {
+	periodPtr, err := r.DurationPtr("PUBLICIP_PERIOD") // Retro-compatibility
+	if err != nil {
+		return nil, err
+	} else if periodPtr == nil {
+		return r.BoolPtr("PUBLICIP_ENABLED")
+	}
+
+	if *periodPtr == 0 {
+		warner.Warn("please replace PUBLICIP_PERIOD=0 with PUBLICIP_ENABLED=no")
+		return ptrTo(false), nil
+	}
+
+	warner.Warn("PUBLICIP_PERIOD is no longer used. " +
+		"It is assumed from its non-zero value you want PUBLICIP_ENABLED=yes. " +
+		"Please migrate to use PUBLICIP_ENABLED only in the future.")
+	return ptrTo(true), nil
+}

internal/configuration/settings/publicip_test.go

@@ -0,0 +1,161 @@
+package settings
+
+import (
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_PublicIP_read(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		makeReader func(ctrl *gomock.Controller) *reader.Reader
+		makeWarner func(ctrl *gomock.Controller) Warner
+		settings   PublicIP
+		errWrapped error
+		errMessage string
+	}{
+		"nothing_read": {
+			makeReader: func(ctrl *gomock.Controller) *reader.Reader {
+				source := newMockSource(ctrl, []sourceKeyValue{
+					{key: "PUBLICIP_PERIOD"},
+					{key: "PUBLICIP_ENABLED"},
+					{key: "IP_STATUS_FILE"},
+					{key: "PUBLICIP_FILE"},
+					{key: "PUBLICIP_API"},
+				})
+				return reader.New(reader.Settings{
+					Sources: []reader.Source{source},
+				})
+			},
+		},
+		"single_api_no_token": {
+			makeReader: func(ctrl *gomock.Controller) *reader.Reader {
+				source := newMockSource(ctrl, []sourceKeyValue{
+					{key: "PUBLICIP_PERIOD"},
+					{key: "PUBLICIP_ENABLED"},
+					{key: "IP_STATUS_FILE"},
+					{key: "PUBLICIP_FILE"},
+					{key: "PUBLICIP_API", value: "ipinfo"},
+					{key: "PUBLICIP_API_TOKEN"},
+				})
+				return reader.New(reader.Settings{
+					Sources: []reader.Source{source},
+				})
+			},
+			settings: PublicIP{
+				APIs: []PublicIPAPI{
+					{Name: "ipinfo"},
+				},
+			},
+		},
+		"single_api_with_token": {
+			makeReader: func(ctrl *gomock.Controller) *reader.Reader {
+				source := newMockSource(ctrl, []sourceKeyValue{
+					{key: "PUBLICIP_PERIOD"},
+					{key: "PUBLICIP_ENABLED"},
+					{key: "IP_STATUS_FILE"},
+					{key: "PUBLICIP_FILE"},
+					{key: "PUBLICIP_API", value: "ipinfo"},
+					{key: "PUBLICIP_API_TOKEN", value: "xyz"},
+				})
+				return reader.New(reader.Settings{
+					Sources: []reader.Source{source},
+				})
+			},
+			settings: PublicIP{
+				APIs: []PublicIPAPI{
+					{Name: "ipinfo", Token: "xyz"},
+				},
+			},
+		},
+		"multiple_apis_no_token": {
+			makeReader: func(ctrl *gomock.Controller) *reader.Reader {
+				source := newMockSource(ctrl, []sourceKeyValue{
+					{key: "PUBLICIP_PERIOD"},
+					{key: "PUBLICIP_ENABLED"},
+					{key: "IP_STATUS_FILE"},
+					{key: "PUBLICIP_FILE"},
+					{key: "PUBLICIP_API", value: "ipinfo,ip2location"},
+					{key: "PUBLICIP_API_TOKEN"},
+				})
+				return reader.New(reader.Settings{
+					Sources: []reader.Source{source},
+				})
+			},
+			settings: PublicIP{
+				APIs: []PublicIPAPI{
+					{Name: "ipinfo"},
+					{Name: "ip2location"},
+				},
+			},
+		},
+		"multiple_apis_with_token": {
+			makeReader: func(ctrl *gomock.Controller) *reader.Reader {
+				source := newMockSource(ctrl, []sourceKeyValue{
+					{key: "PUBLICIP_PERIOD"},
+					{key: "PUBLICIP_ENABLED"},
+					{key: "IP_STATUS_FILE"},
+					{key: "PUBLICIP_FILE"},
+					{key: "PUBLICIP_API", value: "ipinfo,ip2location"},
+					{key: "PUBLICIP_API_TOKEN", value: "xyz,abc"},
+				})
+				return reader.New(reader.Settings{
+					Sources: []reader.Source{source},
+				})
+			},
+			settings: PublicIP{
+				APIs: []PublicIPAPI{
+					{Name: "ipinfo", Token: "xyz"},
+					{Name: "ip2location", Token: "abc"},
+				},
+			},
+		},
+		"multiple_apis_with_and_without_token": {
+			makeReader: func(ctrl *gomock.Controller) *reader.Reader {
+				source := newMockSource(ctrl, []sourceKeyValue{
+					{key: "PUBLICIP_PERIOD"},
+					{key: "PUBLICIP_ENABLED"},
+					{key: "IP_STATUS_FILE"},
+					{key: "PUBLICIP_FILE"},
+					{key: "PUBLICIP_API", value: "ipinfo,ip2location"},
+					{key: "PUBLICIP_API_TOKEN", value: "xyz"},
+				})
+				return reader.New(reader.Settings{
+					Sources: []reader.Source{source},
+				})
+			},
+			settings: PublicIP{
+				APIs: []PublicIPAPI{
+					{Name: "ipinfo", Token: "xyz"},
+					{Name: "ip2location"},
+				},
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			ctrl := gomock.NewController(t)
+
+			reader := testCase.makeReader(ctrl)
+			var warner Warner
+			if testCase.makeWarner != nil {
+				warner = testCase.makeWarner(ctrl)
+			}
+
+			var settings PublicIP
+			err := settings.read(reader, warner)
+
+			assert.Equal(t, testCase.settings, settings)
+			assert.ErrorIs(t, err, testCase.errWrapped)
+			if testCase.errWrapped != nil {
+				assert.EqualError(t, err, testCase.errMessage)
+			}
+		})
+	}
+}