feat(dns): replace unbound with qdm12/dns@v2.0.0-beta-rc6 (#1742)

- Faster start up
- Clearer error messages
- Allow for more Gluetun-specific customization
- DNSSEC validation is dropped for now (it's sort of unneeded)
- Fix #137

internal/cli/openvpnconfig.go

@@ -49,7 +49,7 @@ func (c *CLI) OpenvpnConfig(logger OpenvpnConfigLogger, reader *reader.Reader,
 	}
 
 	var allSettings settings.Settings
-	err = allSettings.Read(reader)
+	err = allSettings.Read(reader, logger)
 	if err != nil {
 		return err
 	}

internal/configuration/settings/deprecated.go

@@ -0,0 +1,25 @@
+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.",
+	}
+	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/dnsblacklist.go

@@ -3,10 +3,11 @@ package settings
 import (
 	"errors"
 	"fmt"
+	"net/http"
 	"net/netip"
 	"regexp"
 
-	"github.com/qdm12/dns/pkg/blacklist"
+	"github.com/qdm12/dns/v2/pkg/blockbuilder"
 	"github.com/qdm12/gosettings"
 	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
@@ -74,16 +75,18 @@ func (b *DNSBlacklist) overrideWith(other DNSBlacklist) {
 	b.AddBlockedIPPrefixes = gosettings.OverrideWithSlice(b.AddBlockedIPPrefixes, other.AddBlockedIPPrefixes)
 }
 
-func (b DNSBlacklist) ToBlacklistFormat() (settings blacklist.BuilderSettings, err error) {
-	return blacklist.BuilderSettings{
-		BlockMalicious:       *b.BlockMalicious,
-		BlockAds:             *b.BlockAds,
-		BlockSurveillance:    *b.BlockSurveillance,
+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:        netipAddressesToNetaddrIPs(b.AddBlockedIPs),
-		AddBlockedIPPrefixes: netipPrefixesToNetaddrIPPrefixes(b.AddBlockedIPPrefixes),
-	}, nil
+		AddBlockedIPs:        b.AddBlockedIPs,
+		AddBlockedIPPrefixes: b.AddBlockedIPPrefixes,
+	}
 }
 
 func (b DNSBlacklist) String() string {

internal/configuration/settings/dot.go

@@ -3,8 +3,10 @@ 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"
@@ -16,14 +18,18 @@ type DoT struct {
 	// and used. It defaults to true, and cannot be nil
 	// in the internal state.
 	Enabled *bool
-	// UpdatePeriod is the period to update DNS block
-	// lists and cryptographic files for DNSSEC validation.
+	// 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
-	// Unbound contains settings to configure Unbound.
-	Unbound Unbound
+	// 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
@@ -40,9 +46,12 @@ func (d DoT) validate() (err error) {
 			ErrDoTUpdatePeriodTooShort, *d.UpdatePeriod, minUpdatePeriod)
 	}
 
-	err = d.Unbound.validate()
-	if err != nil {
-		return err
+	providers := provider.NewProviders()
+	for _, providerName := range d.Providers {
+		_, err := providers.Get(providerName)
+		if err != nil {
+			return err
+		}
 	}
 
 	err = d.Blacklist.validate()
@@ -57,7 +66,9 @@ func (d *DoT) copy() (copied DoT) {
 	return DoT{
 		Enabled:      gosettings.CopyPointer(d.Enabled),
 		UpdatePeriod: gosettings.CopyPointer(d.UpdatePeriod),
-		Unbound:      d.Unbound.copy(),
+		Providers:    gosettings.CopySlice(d.Providers),
+		Caching:      gosettings.CopyPointer(d.Caching),
+		IPv6:         gosettings.CopyPointer(d.IPv6),
 		Blacklist:    d.Blacklist.copy(),
 	}
 }
@@ -68,7 +79,9 @@ func (d *DoT) copy() (copied DoT) {
 func (d *DoT) overrideWith(other DoT) {
 	d.Enabled = gosettings.OverrideWithPointer(d.Enabled, other.Enabled)
 	d.UpdatePeriod = gosettings.OverrideWithPointer(d.UpdatePeriod, other.UpdatePeriod)
-	d.Unbound.overrideWith(other.Unbound)
+	d.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)
 }
 
@@ -76,10 +89,26 @@ func (d *DoT) setDefaults() {
 	d.Enabled = gosettings.DefaultPointer(d.Enabled, true)
 	const defaultUpdatePeriod = 24 * time.Hour
 	d.UpdatePeriod = gosettings.DefaultPointer(d.UpdatePeriod, defaultUpdatePeriod)
-	d.Unbound.setDefaults()
+	d.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()
 }
@@ -98,7 +127,14 @@ func (d DoT) toLinesNode() (node *gotree.Node) {
 	}
 	node.Appendf("Update period: %s", update)
 
-	node.AppendNode(d.Unbound.toLinesNode())
+	upstreamResolvers := node.Appendf("Upstream resolvers:")
+	for _, provider := range d.Providers {
+		upstreamResolvers.Appendf(provider)
+	}
+
+	node.Appendf("Caching: %s", gosettings.BoolToYesNo(d.Caching))
+	node.Appendf("IPv6: %s", gosettings.BoolToYesNo(d.IPv6))
+
 	node.AppendNode(d.Blacklist.toLinesNode())
 
 	return node
@@ -115,7 +151,14 @@ func (d *DoT) read(reader *reader.Reader) (err error) {
 		return err
 	}
 
-	err = d.Unbound.read(reader)
+	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
 	}

internal/configuration/settings/helpers_test.go

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

internal/configuration/settings/netaddr.go

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

internal/configuration/settings/settings.go

@@ -184,7 +184,12 @@ func (s Settings) Warnings() (warnings []string) {
 	return warnings
 }
 
-func (s *Settings) Read(r *reader.Reader) (err error) {
+func (s *Settings) Read(r *reader.Reader, warner Warner) (err error) {
+	warnings := readObsolete(r)
+	for _, warning := range warnings {
+		warner.Warn(warning)
+	}
+
 	readFunctions := map[string]func(r *reader.Reader) error{
 		"control server": s.ControlServer.read,
 		"DNS":            s.DNS.read,

internal/configuration/settings/settings_test.go

@@ -43,18 +43,10 @@ func Test_Settings_String(t *testing.T) {
 |   └── DNS over TLS settings:
 |       ├── Enabled: yes
 |       ├── Update period: every 24h0m0s
-|       ├── Unbound settings:
-|       |   ├── Authoritative servers:
-|       |   |   └── Cloudflare
-|       |   ├── Caching: yes
-|       |   ├── IPv6: no
-|       |   ├── Verbosity level: 1
-|       |   ├── Verbosity details level: 0
-|       |   ├── Validation log level: 0
-|       |   ├── System user: root
-|       |   └── Allowed networks:
-|       |       ├── 0.0.0.0/0
-|       |       └── ::/0
+|       ├── Upstream resolvers:
+|       |   └── Cloudflare
+|       ├── Caching: yes
+|       ├── IPv6: no
 |       └── DNS filtering settings:
 |           ├── Block malicious: yes
 |           ├── Block ads: no

internal/configuration/settings/unbound.go

@@ -1,223 +0,0 @@
-package settings
-
-import (
-	"errors"
-	"fmt"
-	"net/netip"
-
-	"github.com/qdm12/dns/pkg/provider"
-	"github.com/qdm12/dns/pkg/unbound"
-	"github.com/qdm12/gosettings"
-	"github.com/qdm12/gosettings/reader"
-	"github.com/qdm12/gotree"
-)
-
-// Unbound is settings for the Unbound program.
-type Unbound struct {
-	Providers             []string       `json:"providers"`
-	Caching               *bool          `json:"caching"`
-	IPv6                  *bool          `json:"ipv6"`
-	VerbosityLevel        *uint8         `json:"verbosity_level"`
-	VerbosityDetailsLevel *uint8         `json:"verbosity_details_level"`
-	ValidationLogLevel    *uint8         `json:"validation_log_level"`
-	Username              string         `json:"username"`
-	Allowed               []netip.Prefix `json:"allowed"`
-}
-
-func (u *Unbound) setDefaults() {
-	if len(u.Providers) == 0 {
-		u.Providers = []string{
-			provider.Cloudflare().String(),
-		}
-	}
-
-	u.Caching = gosettings.DefaultPointer(u.Caching, true)
-	u.IPv6 = gosettings.DefaultPointer(u.IPv6, false)
-
-	const defaultVerbosityLevel = 1
-	u.VerbosityLevel = gosettings.DefaultPointer(u.VerbosityLevel, defaultVerbosityLevel)
-
-	const defaultVerbosityDetailsLevel = 0
-	u.VerbosityDetailsLevel = gosettings.DefaultPointer(u.VerbosityDetailsLevel, defaultVerbosityDetailsLevel)
-
-	const defaultValidationLogLevel = 0
-	u.ValidationLogLevel = gosettings.DefaultPointer(u.ValidationLogLevel, defaultValidationLogLevel)
-
-	if u.Allowed == nil {
-		u.Allowed = []netip.Prefix{
-			netip.PrefixFrom(netip.AddrFrom4([4]byte{}), 0),
-			netip.PrefixFrom(netip.AddrFrom16([16]byte{}), 0),
-		}
-	}
-
-	u.Username = gosettings.DefaultComparable(u.Username, "root")
-}
-
-var (
-	ErrUnboundVerbosityLevelNotValid        = errors.New("Unbound verbosity level is not valid")
-	ErrUnboundVerbosityDetailsLevelNotValid = errors.New("Unbound verbosity details level is not valid")
-	ErrUnboundValidationLogLevelNotValid    = errors.New("Unbound validation log level is not valid")
-)
-
-func (u Unbound) validate() (err error) {
-	for _, s := range u.Providers {
-		_, err := provider.Parse(s)
-		if err != nil {
-			return err
-		}
-	}
-
-	const maxVerbosityLevel = 5
-	if *u.VerbosityLevel > maxVerbosityLevel {
-		return fmt.Errorf("%w: %d must be between 0 and %d",
-			ErrUnboundVerbosityLevelNotValid,
-			*u.VerbosityLevel,
-			maxVerbosityLevel)
-	}
-
-	const maxVerbosityDetailsLevel = 4
-	if *u.VerbosityDetailsLevel > maxVerbosityDetailsLevel {
-		return fmt.Errorf("%w: %d must be between 0 and %d",
-			ErrUnboundVerbosityDetailsLevelNotValid,
-			*u.VerbosityDetailsLevel,
-			maxVerbosityDetailsLevel)
-	}
-
-	const maxValidationLogLevel = 2
-	if *u.ValidationLogLevel > maxValidationLogLevel {
-		return fmt.Errorf("%w: %d must be between 0 and %d",
-			ErrUnboundValidationLogLevelNotValid,
-			*u.ValidationLogLevel, maxValidationLogLevel)
-	}
-
-	return nil
-}
-
-func (u Unbound) copy() (copied Unbound) {
-	return Unbound{
-		Providers:             gosettings.CopySlice(u.Providers),
-		Caching:               gosettings.CopyPointer(u.Caching),
-		IPv6:                  gosettings.CopyPointer(u.IPv6),
-		VerbosityLevel:        gosettings.CopyPointer(u.VerbosityLevel),
-		VerbosityDetailsLevel: gosettings.CopyPointer(u.VerbosityDetailsLevel),
-		ValidationLogLevel:    gosettings.CopyPointer(u.ValidationLogLevel),
-		Username:              u.Username,
-		Allowed:               gosettings.CopySlice(u.Allowed),
-	}
-}
-
-func (u *Unbound) overrideWith(other Unbound) {
-	u.Providers = gosettings.OverrideWithSlice(u.Providers, other.Providers)
-	u.Caching = gosettings.OverrideWithPointer(u.Caching, other.Caching)
-	u.IPv6 = gosettings.OverrideWithPointer(u.IPv6, other.IPv6)
-	u.VerbosityLevel = gosettings.OverrideWithPointer(u.VerbosityLevel, other.VerbosityLevel)
-	u.VerbosityDetailsLevel = gosettings.OverrideWithPointer(u.VerbosityDetailsLevel, other.VerbosityDetailsLevel)
-	u.ValidationLogLevel = gosettings.OverrideWithPointer(u.ValidationLogLevel, other.ValidationLogLevel)
-	u.Username = gosettings.OverrideWithComparable(u.Username, other.Username)
-	u.Allowed = gosettings.OverrideWithSlice(u.Allowed, other.Allowed)
-}
-
-func (u Unbound) ToUnboundFormat() (settings unbound.Settings, err error) {
-	providers := make([]provider.Provider, len(u.Providers))
-	for i := range providers {
-		providers[i], err = provider.Parse(u.Providers[i])
-		if err != nil {
-			return settings, err
-		}
-	}
-
-	const port = 53
-
-	return unbound.Settings{
-		ListeningPort:         port,
-		IPv4:                  true,
-		Providers:             providers,
-		Caching:               *u.Caching,
-		IPv6:                  *u.IPv6,
-		VerbosityLevel:        *u.VerbosityLevel,
-		VerbosityDetailsLevel: *u.VerbosityDetailsLevel,
-		ValidationLogLevel:    *u.ValidationLogLevel,
-		AccessControl: unbound.AccessControlSettings{
-			Allowed: netipPrefixesToNetaddrIPPrefixes(u.Allowed),
-		},
-		Username: u.Username,
-	}, nil
-}
-
-var (
-	ErrConvertingNetip = errors.New("converting net.IP to netip.Addr failed")
-)
-
-func (u Unbound) GetFirstPlaintextIPv4() (ipv4 netip.Addr, err error) {
-	s := u.Providers[0]
-	provider, err := provider.Parse(s)
-	if err != nil {
-		return ipv4, err
-	}
-
-	ip := provider.DNS().IPv4[0]
-	ipv4, ok := netip.AddrFromSlice(ip)
-	if !ok {
-		return ipv4, fmt.Errorf("%w: for ip %s (%#v)",
-			ErrConvertingNetip, ip, ip)
-	}
-	return ipv4.Unmap(), nil
-}
-
-func (u Unbound) String() string {
-	return u.toLinesNode().String()
-}
-
-func (u Unbound) toLinesNode() (node *gotree.Node) {
-	node = gotree.New("Unbound settings:")
-
-	authServers := node.Appendf("Authoritative servers:")
-	for _, provider := range u.Providers {
-		authServers.Appendf(provider)
-	}
-
-	node.Appendf("Caching: %s", gosettings.BoolToYesNo(u.Caching))
-	node.Appendf("IPv6: %s", gosettings.BoolToYesNo(u.IPv6))
-	node.Appendf("Verbosity level: %d", *u.VerbosityLevel)
-	node.Appendf("Verbosity details level: %d", *u.VerbosityDetailsLevel)
-	node.Appendf("Validation log level: %d", *u.ValidationLogLevel)
-	node.Appendf("System user: %s", u.Username)
-
-	allowedNetworks := node.Appendf("Allowed networks:")
-	for _, network := range u.Allowed {
-		allowedNetworks.Appendf(network.String())
-	}
-
-	return node
-}
-
-func (u *Unbound) read(reader *reader.Reader) (err error) {
-	u.Providers = reader.CSV("DOT_PROVIDERS")
-
-	u.Caching, err = reader.BoolPtr("DOT_CACHING")
-	if err != nil {
-		return err
-	}
-
-	u.IPv6, err = reader.BoolPtr("DOT_IPV6")
-	if err != nil {
-		return err
-	}
-
-	u.VerbosityLevel, err = reader.Uint8Ptr("DOT_VERBOSITY")
-	if err != nil {
-		return err
-	}
-
-	u.VerbosityDetailsLevel, err = reader.Uint8Ptr("DOT_VERBOSITY_DETAILS")
-	if err != nil {
-		return err
-	}
-
-	u.ValidationLogLevel, err = reader.Uint8Ptr("DOT_VALIDATION_LOGLEVEL")
-	if err != nil {
-		return err
-	}
-
-	return nil
-}

internal/configuration/settings/unbound_test.go

@@ -1,43 +0,0 @@
-package settings
-
-import (
-	"encoding/json"
-	"net/netip"
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-)
-
-func Test_Unbound_JSON(t *testing.T) {
-	t.Parallel()
-
-	settings := Unbound{
-		Providers:             []string{"cloudflare"},
-		Caching:               boolPtr(true),
-		IPv6:                  boolPtr(false),
-		VerbosityLevel:        uint8Ptr(1),
-		VerbosityDetailsLevel: nil,
-		ValidationLogLevel:    uint8Ptr(0),
-		Username:              "user",
-		Allowed: []netip.Prefix{
-			netip.PrefixFrom(netip.AddrFrom4([4]byte{}), 0),
-			netip.PrefixFrom(netip.AddrFrom16([16]byte{}), 0),
-		},
-	}
-
-	b, err := json.Marshal(settings)
-	require.NoError(t, err)
-
-	const expected = `{"providers":["cloudflare"],"caching":true,"ipv6":false,` +
-		`"verbosity_level":1,"verbosity_details_level":null,"validation_log_level":0,` +
-		`"username":"user","allowed":["0.0.0.0/0","::/0"]}`
-
-	assert.Equal(t, expected, string(b))
-
-	var resultSettings Unbound
-	err = json.Unmarshal(b, &resultSettings)
-	require.NoError(t, err)
-
-	assert.Equal(t, settings, resultSettings)
-}

internal/constants/colors.go

@@ -2,10 +2,6 @@ package constants
 
 import "github.com/fatih/color"
 
-func ColorUnbound() *color.Color {
-	return color.New(color.FgCyan)
-}
-
 func ColorOpenvpn() *color.Color {
 	return color.New(color.FgHiMagenta)
 }

internal/dns/interfaces.go

@@ -1,15 +0,0 @@
-package dns
-
-import (
-	"context"
-
-	"github.com/qdm12/dns/pkg/unbound"
-)
-
-type Configurator interface {
-	SetupFiles(ctx context.Context) error
-	MakeUnboundConf(settings unbound.Settings) (err error)
-	Start(ctx context.Context, verbosityDetailsLevel uint8) (
-		stdoutLines, stderrLines chan string, waitError chan error, err error)
-	Version(ctx context.Context) (version string, err error)
-}

internal/dns/logs.go

@@ -1,75 +0,0 @@
-package dns
-
-import (
-	"context"
-	"regexp"
-	"strings"
-
-	"github.com/qdm12/gluetun/internal/constants"
-)
-
-type logLevel uint8
-
-const (
-	levelDebug logLevel = iota
-	levelInfo
-	levelWarn
-	levelError
-)
-
-func (l *Loop) collectLines(ctx context.Context, done chan<- struct{},
-	stdout, stderr chan string) {
-	defer close(done)
-
-	var line string
-
-	for {
-		select {
-		case <-ctx.Done():
-			// Context should only be canceled after stdout and stderr are done
-			// being written to.
-			close(stdout)
-			close(stderr)
-			return
-		case line = <-stderr:
-		case line = <-stdout:
-		}
-
-		line, level := processLogLine(line)
-		switch level {
-		case levelDebug:
-			l.logger.Debug(line)
-		case levelInfo:
-			l.logger.Info(line)
-		case levelWarn:
-			l.logger.Warn(line)
-		case levelError:
-			l.logger.Error(line)
-		}
-	}
-}
-
-var unboundPrefix = regexp.MustCompile(`\[[0-9]{10}\] unbound\[[0-9]+:[0|1]\] `)
-
-func processLogLine(s string) (filtered string, level logLevel) {
-	prefix := unboundPrefix.FindString(s)
-	filtered = s[len(prefix):]
-	switch {
-	case strings.HasPrefix(filtered, "notice: "):
-		filtered = strings.TrimPrefix(filtered, "notice: ")
-		level = levelInfo
-	case strings.HasPrefix(filtered, "info: "):
-		filtered = strings.TrimPrefix(filtered, "info: ")
-		level = levelInfo
-	case strings.HasPrefix(filtered, "warn: "):
-		filtered = strings.TrimPrefix(filtered, "warn: ")
-		level = levelWarn
-	case strings.HasPrefix(filtered, "error: "):
-		filtered = strings.TrimPrefix(filtered, "error: ")
-		level = levelError
-	default:
-		level = levelInfo
-	}
-	filtered = constants.ColorUnbound().Sprintf(filtered)
-	return filtered, level
-}

internal/dns/logs_test.go

@@ -1,48 +0,0 @@
-package dns
-
-import (
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-)
-
-func Test_processLogLine(t *testing.T) {
-	t.Parallel()
-	tests := map[string]struct {
-		s        string
-		filtered string
-		level    logLevel
-	}{
-		"empty string":  {"", "", levelInfo},
-		"random string": {"asdasqdb", "asdasqdb", levelInfo},
-		"unbound notice": {
-			"[1594595249] unbound[75:0] notice: init module 0: validator",
-			"init module 0: validator",
-			levelInfo},
-		"unbound info": {
-			"[1594595249] unbound[75:0] info: init module 0: validator",
-			"init module 0: validator",
-			levelInfo},
-		"unbound warn": {
-			"[1594595249] unbound[75:0] warn: init module 0: validator",
-			"init module 0: validator",
-			levelWarn},
-		"unbound error": {
-			"[1594595249] unbound[75:0] error: init module 0: validator",
-			"init module 0: validator",
-			levelError},
-		"unbound unknown": {
-			"[1594595249] unbound[75:0] BLA: init module 0: validator",
-			"BLA: init module 0: validator",
-			levelInfo},
-	}
-	for name, tc := range tests {
-		tc := tc
-		t.Run(name, func(t *testing.T) {
-			t.Parallel()
-			filtered, level := processLogLine(tc.s)
-			assert.Equal(t, tc.filtered, filtered)
-			assert.Equal(t, tc.level, level)
-		})
-	}
-}

internal/dns/loop.go

@@ -2,10 +2,12 @@ package dns
 
 import (
 	"context"
+	"fmt"
 	"net/http"
 	"time"
 
-	"github.com/qdm12/dns/pkg/blacklist"
+	"github.com/qdm12/dns/v2/pkg/dot"
+	"github.com/qdm12/dns/v2/pkg/middlewares/filter/mapfilter"
 	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/constants"
 	"github.com/qdm12/gluetun/internal/dns/state"
@@ -16,9 +18,9 @@ import (
 type Loop struct {
 	statusManager *loopstate.State
 	state         *state.State
-	conf          Configurator
+	server        *dot.Server
+	filter        *mapfilter.Filter
 	resolvConf    string
-	blockBuilder  blacklist.Builder
 	client        *http.Client
 	logger        Logger
 	userTrigger   bool
@@ -34,8 +36,8 @@ type Loop struct {
 
 const defaultBackoffTime = 10 * time.Second
 
-func NewLoop(conf Configurator, settings settings.DNS,
-	client *http.Client, logger Logger) *Loop {
+func NewLoop(settings settings.DNS,
+	client *http.Client, logger Logger) (loop *Loop, err error) {
 	start := make(chan struct{})
 	running := make(chan models.LoopStatus)
 	stop := make(chan struct{})
@@ -45,12 +47,17 @@ func NewLoop(conf Configurator, settings settings.DNS,
 	statusManager := loopstate.New(constants.Stopped, start, running, stop, stopped)
 	state := state.New(statusManager, settings, updateTicker)
 
+	filter, err := mapfilter.New(mapfilter.Settings{})
+	if err != nil {
+		return nil, fmt.Errorf("creating map filter: %w", err)
+	}
+
 	return &Loop{
 		statusManager: statusManager,
 		state:         state,
-		conf:          conf,
+		server:        nil,
+		filter:        filter,
 		resolvConf:    "/etc/resolv.conf",
-		blockBuilder:  blacklist.NewBuilder(client),
 		client:        client,
 		logger:        logger,
 		userTrigger:   true,
@@ -62,7 +69,7 @@ func NewLoop(conf Configurator, settings settings.DNS,
 		backoffTime:   defaultBackoffTime,
 		timeNow:       time.Now,
 		timeSince:     time.Since,
-	}
+	}, nil
 }
 
 func (l *Loop) logAndWait(ctx context.Context, err error) {

internal/dns/plaintext.go

@@ -2,36 +2,22 @@ package dns
 
 import (
 	"net/netip"
+	"time"
 
-	"github.com/qdm12/dns/pkg/nameserver"
+	"github.com/qdm12/dns/v2/pkg/nameserver"
 )
 
 func (l *Loop) useUnencryptedDNS(fallback bool) {
 	settings := l.GetSettings()
 
 	// Try with user provided plaintext ip address
-	// if it's not 127.0.0.1 (default for DoT)
-	targetIP := settings.ServerAddress
-	if targetIP.Compare(netip.AddrFrom4([4]byte{127, 0, 0, 1})) != 0 {
-		if fallback {
-			l.logger.Info("falling back on plaintext DNS at address " + targetIP.String())
-		} else {
-			l.logger.Info("using plaintext DNS at address " + targetIP.String())
-		}
-		nameserver.UseDNSInternally(targetIP.AsSlice())
-		const keepNameserver = false
-		err := nameserver.UseDNSSystemWide(l.resolvConf, targetIP.AsSlice(), keepNameserver)
-		if err != nil {
-			l.logger.Error(err.Error())
-		}
-		return
-	}
-
-	// Use first plaintext DNS IPv4 address
-	targetIP, err := settings.DoT.Unbound.GetFirstPlaintextIPv4()
-	if err != nil {
-		// Unbound should always have a default provider
-		panic(err)
+	// if it's not 127.0.0.1 (default for DoT), otherwise
+	// use the first DoT provider ipv4 address found.
+	var targetIP netip.Addr
+	if settings.ServerAddress.Compare(netip.AddrFrom4([4]byte{127, 0, 0, 1})) != 0 {
+		targetIP = settings.ServerAddress
+	} else {
+		targetIP = settings.DoT.GetFirstPlaintextIPv4()
 	}
 
 	if fallback {
@@ -39,9 +25,19 @@ func (l *Loop) useUnencryptedDNS(fallback bool) {
 	} else {
 		l.logger.Info("using plaintext DNS at address " + targetIP.String())
 	}
-	nameserver.UseDNSInternally(targetIP.AsSlice())
-	const keepNameserver = false
-	err = nameserver.UseDNSSystemWide(l.resolvConf, targetIP.AsSlice(), keepNameserver)
+
+	const dialTimeout = 3 * time.Second
+	settingsInternalDNS := nameserver.SettingsInternalDNS{
+		IP:      targetIP,
+		Timeout: dialTimeout,
+	}
+	nameserver.UseDNSInternally(settingsInternalDNS)
+
+	settingsSystemWide := nameserver.SettingsSystemDNS{
+		IP:         targetIP,
+		ResolvPath: l.resolvConf,
+	}
+	err := nameserver.UseDNSSystemWide(settingsSystemWide)
 	if err != nil {
 		l.logger.Error(err.Error())
 	}

internal/dns/run.go

@@ -26,16 +26,14 @@ func (l *Loop) Run(ctx context.Context, done chan<- struct{}) {
 	}
 
 	for ctx.Err() == nil {
-		// Upper scope variables for Unbound only
+		// Upper scope variables for the DNS over TLS server only
 		// Their values are to be used if DOT=off
-		waitError := make(chan error)
-		unboundCancel := func() { waitError <- nil }
-		closeStreams := func() {}
+		var runError <-chan error
 
 		settings := l.GetSettings()
 		for !*settings.KeepNameserver && *settings.DoT.Enabled {
 			var err error
-			unboundCancel, waitError, closeStreams, err = l.setupUnbound(ctx)
+			runError, err = l.setupServer(ctx)
 			if err == nil {
 				l.backoffTime = defaultBackoffTime
 				l.logger.Info("ready")
@@ -49,11 +47,12 @@ func (l *Loop) Run(ctx context.Context, done chan<- struct{}) {
 				return
 			}
 
-			if !errors.Is(err, errUpdateFiles) {
+			if !errors.Is(err, errUpdateBlockLists) {
 				const fallback = true
 				l.useUnencryptedDNS(fallback)
 			}
 			l.logAndWait(ctx, err)
+			settings = l.GetSettings()
 		}
 
 		settings = l.GetSettings()
@@ -64,40 +63,44 @@ func (l *Loop) Run(ctx context.Context, done chan<- struct{}) {
 
 		l.userTrigger = false
 
-		stayHere := true
-		for stayHere {
-			select {
-			case <-ctx.Done():
-				unboundCancel()
-				<-waitError
-				close(waitError)
-				closeStreams()
-				return
-			case <-l.stop:
-				l.userTrigger = true
-				l.logger.Info("stopping")
-				const fallback = false
-				l.useUnencryptedDNS(fallback)
-				unboundCancel()
-				<-waitError
-				// do not close waitError or the waitError
-				// select case will trigger
-				closeStreams()
-				l.stopped <- struct{}{}
-			case <-l.start:
-				l.userTrigger = true
-				l.logger.Info("starting")
-				stayHere = false
-			case err := <-waitError: // unexpected error
-				closeStreams()
-
-				unboundCancel()
-				l.statusManager.SetStatus(constants.Crashed)
-				const fallback = true
-				l.useUnencryptedDNS(fallback)
-				l.logAndWait(ctx, err)
-				stayHere = false
-			}
+		exitLoop := l.runWait(ctx, runError)
+		if exitLoop {
+			return
 		}
 	}
 }
+
+func (l *Loop) runWait(ctx context.Context, runError <-chan error) (exitLoop bool) {
+	for {
+		select {
+		case <-ctx.Done():
+			l.stopServer()
+			// TODO revert OS and Go nameserver when exiting
+			return true
+		case <-l.stop:
+			l.userTrigger = true
+			l.logger.Info("stopping")
+			const fallback = false
+			l.useUnencryptedDNS(fallback)
+			l.stopServer()
+			l.stopped <- struct{}{}
+		case <-l.start:
+			l.userTrigger = true
+			l.logger.Info("starting")
+			return false
+		case err := <-runError: // unexpected error
+			l.statusManager.SetStatus(constants.Crashed)
+			const fallback = true
+			l.useUnencryptedDNS(fallback)
+			l.logAndWait(ctx, err)
+			return false
+		}
+	}
+}
+
+func (l *Loop) stopServer() {
+	stopErr := l.server.Stop()
+	if stopErr != nil {
+		l.logger.Error("stopping DoT server: " + stopErr.Error())
+	}
+}

internal/dns/settings.go

@@ -2,7 +2,14 @@ package dns
 
 import (
 	"context"
+	"fmt"
 
+	"github.com/qdm12/dns/v2/pkg/dot"
+	cachemiddleware "github.com/qdm12/dns/v2/pkg/middlewares/cache"
+	"github.com/qdm12/dns/v2/pkg/middlewares/cache/lru"
+	filtermiddleware "github.com/qdm12/dns/v2/pkg/middlewares/filter"
+	"github.com/qdm12/dns/v2/pkg/middlewares/filter/mapfilter"
+	"github.com/qdm12/dns/v2/pkg/provider"
 	"github.com/qdm12/gluetun/internal/configuration/settings"
 )
 
@@ -12,3 +19,55 @@ func (l *Loop) SetSettings(ctx context.Context, settings settings.DNS) (
 	outcome string) {
 	return l.state.SetSettings(ctx, settings)
 }
+
+func buildDoTSettings(settings settings.DNS,
+	filter *mapfilter.Filter, logger Logger) (
+	dotSettings dot.ServerSettings, err error) {
+	var middlewares []dot.Middleware
+
+	if *settings.DoT.Caching {
+		lruCache, err := lru.New(lru.Settings{})
+		if err != nil {
+			return dot.ServerSettings{}, fmt.Errorf("creating LRU cache: %w", err)
+		}
+		cacheMiddleware, err := cachemiddleware.New(cachemiddleware.Settings{
+			Cache: lruCache,
+		})
+		if err != nil {
+			return dot.ServerSettings{}, fmt.Errorf("creating cache middleware: %w", err)
+		}
+		middlewares = append(middlewares, cacheMiddleware)
+	}
+
+	filterMiddleware, err := filtermiddleware.New(filtermiddleware.Settings{
+		Filter: filter,
+	})
+	if err != nil {
+		return dot.ServerSettings{}, fmt.Errorf("creating filter middleware: %w", err)
+	}
+	middlewares = append(middlewares, filterMiddleware)
+
+	providersData := provider.NewProviders()
+	providers := make([]provider.Provider, len(settings.DoT.Providers))
+	for i := range settings.DoT.Providers {
+		var err error
+		providers[i], err = providersData.Get(settings.DoT.Providers[i])
+		if err != nil {
+			panic(err) // this should already had been checked
+		}
+	}
+
+	ipVersion := "ipv4"
+	if *settings.DoT.IPv6 {
+		ipVersion = "ipv6"
+	}
+	return dot.ServerSettings{
+		Resolver: dot.ResolverSettings{
+			UpstreamResolvers: providers,
+			IPVersion:         ipVersion,
+			Warner:            logger,
+		},
+		Middlewares: middlewares,
+		Logger:      logger,
+	}, nil
+}

internal/dns/setup.go

@@ -4,59 +4,55 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"net"
 
-	"github.com/qdm12/dns/pkg/check"
-	"github.com/qdm12/dns/pkg/nameserver"
+	"github.com/qdm12/dns/v2/pkg/check"
+	"github.com/qdm12/dns/v2/pkg/dot"
+	"github.com/qdm12/dns/v2/pkg/nameserver"
 )
 
-var errUpdateFiles = errors.New("cannot update files")
+var errUpdateBlockLists = errors.New("cannot update filter block lists")
 
-// Returning cancel == nil signals we want to re-run setupUnbound
-// Returning err == errUpdateFiles signals we should not fall back
-// on the plaintext DNS as DOT is still up and running.
-func (l *Loop) setupUnbound(ctx context.Context) (
-	cancel context.CancelFunc, waitError chan error, closeStreams func(), err error) {
+func (l *Loop) setupServer(ctx context.Context) (runError <-chan error, err error) {
 	err = l.updateFiles(ctx)
 	if err != nil {
-		return nil, nil, nil,
-			fmt.Errorf("%w: %s", errUpdateFiles, err)
+		return nil, fmt.Errorf("%w: %w", errUpdateBlockLists, err)
 	}
 
 	settings := l.GetSettings()
 
-	unboundCtx, cancel := context.WithCancel(context.Background())
-	stdoutLines, stderrLines, waitError, err := l.conf.Start(unboundCtx,
-		*settings.DoT.Unbound.VerbosityDetailsLevel)
+	dotSettings, err := buildDoTSettings(settings, l.filter, l.logger)
 	if err != nil {
-		cancel()
-		return nil, nil, nil, err
+		return nil, fmt.Errorf("building DoT settings: %w", err)
 	}
 
-	linesCollectionCtx, linesCollectionCancel := context.WithCancel(context.Background())
-	lineCollectionDone := make(chan struct{})
-	go l.collectLines(linesCollectionCtx, lineCollectionDone,
-		stdoutLines, stderrLines)
-	closeStreams = func() {
-		linesCollectionCancel()
-		<-lineCollectionDone
+	server, err := dot.NewServer(dotSettings)
+	if err != nil {
+		return nil, fmt.Errorf("creating DoT server: %w", err)
 	}
 
-	// use Unbound
-	nameserver.UseDNSInternally(settings.ServerAddress.AsSlice())
-	err = nameserver.UseDNSSystemWide(l.resolvConf, settings.ServerAddress.AsSlice(),
-		*settings.KeepNameserver)
+	runError, err = server.Start()
+	if err != nil {
+		return nil, fmt.Errorf("starting server: %w", err)
+	}
+	l.server = server
+
+	// use internal DNS server
+	nameserver.UseDNSInternally(nameserver.SettingsInternalDNS{
+		IP: settings.ServerAddress,
+	})
+	err = nameserver.UseDNSSystemWide(nameserver.SettingsSystemDNS{
+		IP:         settings.ServerAddress,
+		ResolvPath: l.resolvConf,
+	})
 	if err != nil {
 		l.logger.Error(err.Error())
 	}
 
-	if err := check.WaitForDNS(ctx, net.DefaultResolver); err != nil {
-		cancel()
-		<-waitError
-		close(waitError)
-		closeStreams()
-		return nil, nil, nil, err
+	err = check.WaitForDNS(ctx, check.Settings{})
+	if err != nil {
+		l.stopServer()
+		return nil, err
 	}
 
-	return cancel, waitError, closeStreams, nil
+	return runError, nil
 }

internal/dns/ticker.go

@@ -34,7 +34,7 @@ func (l *Loop) RunRestartTicker(ctx context.Context, done chan<- struct{}) {
 				if err := l.updateFiles(ctx); err != nil {
 					l.statusManager.SetStatus(constants.Crashed)
 					l.logger.Error(err.Error())
-					l.logger.Warn("skipping Unbound restart due to failed files update")
+					l.logger.Warn("skipping DNS server restart due to failed files update")
 					continue
 				}
 			}

internal/dns/update.go

@@ -1,35 +1,46 @@
 package dns
 
-import "context"
+import (
+	"context"
+	"fmt"
+
+	"github.com/qdm12/dns/v2/pkg/blockbuilder"
+	"github.com/qdm12/dns/v2/pkg/middlewares/filter/update"
+)
 
 func (l *Loop) updateFiles(ctx context.Context) (err error) {
-	l.logger.Info("downloading DNS over TLS cryptographic files")
-	if err := l.conf.SetupFiles(ctx); err != nil {
-		return err
-	}
 	settings := l.GetSettings()
 
-	unboundSettings, err := settings.DoT.Unbound.ToUnboundFormat()
-	if err != nil {
-		return err
-	}
-
 	l.logger.Info("downloading hostnames and IP block lists")
-	blacklistSettings, err := settings.DoT.Blacklist.ToBlacklistFormat()
+	blacklistSettings := settings.DoT.Blacklist.ToBlockBuilderSettings(l.client)
+
+	blockBuilder, err := blockbuilder.New(blacklistSettings)
+	if err != nil {
+		return fmt.Errorf("creating block builder: %w", err)
+	}
+
+	result := blockBuilder.BuildAll(ctx)
+	for _, resultErr := range result.Errors {
+		if err != nil {
+			err = fmt.Errorf("%w, %w", err, resultErr)
+			continue
+		}
+		err = resultErr
+	}
+
 	if err != nil {
 		return err
 	}
 
-	blockedHostnames, blockedIPs, blockedIPPrefixes, errs :=
-		l.blockBuilder.All(ctx, blacklistSettings)
-	for _, err := range errs {
-		l.logger.Warn(err.Error())
+	updateSettings := update.Settings{
+		IPs:        result.BlockedIPs,
+		IPPrefixes: result.BlockedIPPrefixes,
+	}
+	updateSettings.BlockHostnames(result.BlockedHostnames)
+	err = l.filter.Update(updateSettings)
+	if err != nil {
+		return fmt.Errorf("updating filter: %w", err)
 	}
 
-	// TODO change to BlockHostnames() when migrating to qdm12/dns v2
-	unboundSettings.Blacklist.FqdnHostnames = blockedHostnames
-	unboundSettings.Blacklist.IPs = blockedIPs
-	unboundSettings.Blacklist.IPPrefixes = blockedIPPrefixes
-
-	return l.conf.MakeUnboundConf(unboundSettings)
+	return nil
 }

internal/server/handler.go

@@ -12,7 +12,7 @@ func newHandler(ctx context.Context, logger infoWarner, logging bool,
 	buildInfo models.BuildInformation,
 	vpnLooper VPNLooper,
 	pfGetter PortForwardedGetter,
-	unboundLooper DNSLoop,
+	dnsLooper DNSLoop,
 	updaterLooper UpdaterLooper,
 	publicIPLooper PublicIPLoop,
 	storage Storage,
@@ -22,11 +22,11 @@ func newHandler(ctx context.Context, logger infoWarner, logging bool,
 
 	vpn := newVPNHandler(ctx, vpnLooper, storage, ipv6Supported, logger)
 	openvpn := newOpenvpnHandler(ctx, vpnLooper, pfGetter, logger)
-	dns := newDNSHandler(ctx, unboundLooper, logger)
+	dns := newDNSHandler(ctx, dnsLooper, logger)
 	updater := newUpdaterHandler(ctx, updaterLooper, logger)
 	publicip := newPublicIPHandler(publicIPLooper, logger)
 
-	handler.v0 = newHandlerV0(ctx, logger, vpnLooper, unboundLooper, updaterLooper)
+	handler.v0 = newHandlerV0(ctx, logger, vpnLooper, dnsLooper, updaterLooper)
 	handler.v1 = newHandlerV1(logger, buildInfo, vpn, openvpn, dns, updater, publicip)
 
 	handlerWithLog := withLogMiddleware(handler, logger, logging)

internal/server/handlerv0.go

@@ -42,7 +42,7 @@ func (h *handlerV0) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 		if _, err := w.Write([]byte("openvpn restarted, please consider using the /v1/ API in the future.")); err != nil {
 			h.logger.Warn(err.Error())
 		}
-	case "/unbound/actions/restart":
+	case "/unbound/actions/restart": // TODO v4 change to /dns/
 		outcome, _ := h.dns.ApplyStatus(h.ctx, constants.Stopped)
 		h.logger.Info("dns: " + outcome)
 		outcome, _ = h.dns.ApplyStatus(h.ctx, constants.Running)

internal/server/server.go

@@ -10,12 +10,12 @@ import (
 
 func New(ctx context.Context, address string, logEnabled bool, logger Logger,
 	buildInfo models.BuildInformation, openvpnLooper VPNLooper,
-	pfGetter PortForwardedGetter, unboundLooper DNSLoop,
+	pfGetter PortForwardedGetter, dnsLooper DNSLoop,
 	updaterLooper UpdaterLooper, publicIPLooper PublicIPLoop, storage Storage,
 	ipv6Supported bool) (
 	server *httpserver.Server, err error) {
 	handler := newHandler(ctx, logger, logEnabled, buildInfo,
-		openvpnLooper, pfGetter, unboundLooper, updaterLooper, publicIPLooper,
+		openvpnLooper, pfGetter, dnsLooper, updaterLooper, publicIPLooper,
 		storage, ipv6Supported)
 
 	httpServerSettings := httpserver.Settings{