DNS over HTTPS with AdGuard Home running in Kubernetes, behind Traefik
Since several years now, my network setup at home includes an instance of AdGuard Home running on a Raspberry Pi, and acting as both a DHCP and DNS server for all the family devices. AdGuard Home provides a network-wide ads and tracking blocker, while also allowing to save some bandwidth usage (and indirectly CPU / memory consumption) while browsing.
As a reminder, the Dynamic Host and Configuration Protocol (DHCP) allows to automatically assign IP addresses (from a range of addresses) and other configuration (like DNS servers) to devices joining a network. The Domain Name System (DNS) is a protocol allowing to translate human-readable domain names into IP addresses.
After experimenting with Adguard Home and other alternatives like Pi-Hole, I sticked to the former for its simplicity of use and overall resource usage.
This has been running successfully for years now in my private home network setup. So I wanted to benefit from this even on the go, regardless of the network I or any other family member is connected to.
Last year, folks at AdGuard published a blog post on how to run and operate Adguard Home on a public server. I therefore set out to migrate AdGuard Home to a public server, ideally running in my existing Kubernetes cluster because I did not want to rent an additional server dedicated to this. Instead, running it in the existing Kubernetes cluster would allow to benefit from automated TLS certificate management already in place and leverage existing nodes.
Sure, another option could have been to set up a publicly-reachable VPN Server in the private network and instruct it to configure devices such that they use the internal AdGuard Home as DNS Server. But for learning purposes, I wanted to get my hands dirty running this in Kubernetes. And if you follow this blog, you might have noticed that I tend to like migrating things to Kubernetes.
Below is an overview of the network setup (10.10.10.0/24) before the migration. The Raspberry Pi running AdGuard Home is assigned a static private IP address (10.10.10.10) and is connected to a router running OpenWRT (10.10.10.254) and performing Network Address Translation (NAT).
And this is what I wanted to achieve.
In a nutshell:
- there is no longer an AdGuard Home instance running in the private network. In fact, it would be migrated outside of the home network, in the Kubernetes cluster, but publicly reachable.
- the OpenWRT router would behave as the DHCP and DNS server for the home network, just like it used to be by default.
- the OpenWRT router would forward all DNS requests to the new AdGuard Home server.
- when outside of the home network, devices would just need to set the new AdGuard Home server as their DNS server, for name resolution. DNS Traffic should ideally be secured, via protocols like DNS over HTTPS (DoH) / over TLS (DoT) / over QUIC (DoQ), which are natively supported by AdGuard Home.
- my Kubernetes Cluster (powered by k3s under the hood) already includes a Traefik Ingress Controller, which acts as a reverse proxy for underlying services, providing SSL/TLS Termination as well. Adguard Home is no exception here, and would need to live behind Traefik, just like my other services exposed.
Deployment in Kubernetes
At the time of writing, I found few Helm Charts for Adguard Home out there, but most of them appeared to be either unmaintained or too tedious to configure properly or missing some configuration.
So I set out to create yet another Chart for Adguard Home, hopefully simpler.
A key non-functional point for me is to backup files to external service like S3, just in the event my future-self needs to restore something back. So based on the same logic used to backup this Ghost blog, I implemented the ability to backup the AdGuard Home configuration file to AWS S3.
This Chart is now listed on ArtifactHub, and can be used like so:
❯ helm repo add rm3l https://helm-charts.rm3l.org ❯ helm install my-adguard-home rm3l/adguard-home \ --version <version> \ --set backup.enabled="true" \ --set backup.schedule="@daily" \ --set backup.aws.enabled="true" \ --set backup.aws.accessKeyId="my-aws-access-key-id" \ --set backup.aws.secretKey="my-aws-secret-key" \ --set backup.aws.s3.destination="s3://path/to/my/adguard-home-s3-export.yaml"
Note that there are still few options to pass at the Chart installation time, like the domain name under which you want to expose AdGuard Home. Head over to https://github.com/rm3l/helm-charts/blob/main/charts/adguard-home/README.md for further details about the Chart configuration.
Once the Chart is deployed in the Kubernetes cluster, and provided you enabled the HTTP Ingress along with a domain name for routing, a new public endpoint should expose your AdGuard Home services over HTTPS: https://<my_dns_domain_name>/dns-query, for secure DNS-over-HTTPS (DoH) name resolution.
Testing the DoH resolver
Our newly deployed DoH resolver can be tested with familiar tools like curl, which supports DoH since its 7.62.0 release:
❯ curl --doh-url https://<my_dns_domain_name>/dns-query \ https://facebook.com/ \ -X OPTIONS -i HTTP/2 301 location: https://www.facebook.com/ access-control-expose-headers: X-FB-Debug, X-Loader-Length access-control-allow-methods: OPTIONS access-control-allow-credentials: true access-control-allow-origin: https://facebook.com vary: Origin strict-transport-security: max-age=15552000; preload content-type: text/html; charset="utf-8" x-fb-debug: lM2W9yXZ0CopX4MP0MskmZTHduIvh9Tzb/wwJF58p+3bNBfPbrJUDsuTaH3TIdCBzZiaRy9K11tZ2N6iMYvGCQ== content-length: 0 date: Mon, 10 Jan 2022 22:51:56 GMT priority: u=3,i alt-svc: h3=":443"; ma=3600, h3-29=":443"; ma=3600
Unencrypted in-cluster DNS over HTTPS
As depicted earlier, there is already an Traefik Ingress Controller running in the Kubernetes Cluster, and acting as a reverse proxy for all the services deployed there.
At the moment, such services are externally reachable via HTTPS (via Kubernetes Ingresses and automated Let's Encrypt certificate management via cert-manager). And as far as I can tell, Kubernetes Ingress Resource handles HTTP(S) traffic only, but other protocols are expected to be supported with the newer Gateway API.
As a consequence, DNS protocols other than HTTP(S) will need to be exposed differently. At this stage, this is configurable, but done by default via Kubernetes Services of type NodePort, allowing to allocate a port on every node in the cluster.
For DNS over HTTPS name resolution, it is however possible to access the Service via a Kubernetes Ingress, handled by the Traefik Ingress Controller. Since Traefik terminates TLS connections, it expects services behind it to be reachable via an unencrypted Service.
By default, AdGuard Home does not expose DNS over HTTPS traffic via an unencrypted connection once encryption is enabled in its web interface. Fortunately, this behavior can be changed manually in the Configuration file, by setting the allow_unencrypted_doh configuration property to true, as done in the Helm Chart default values. More info in the official FAQ.
Preventing potential attacks
Exposing a public DNS server might be dangerous from the security standpoint, especially when this DNS server is also a critical service in the private network at home.
To alleviate a potential misuse of this resolver, Adguard Home ships anti-DNS amplication features via rate limiting options and options to restrict incoming traffic to trusted networks. These can be configured under AdGuard Home > Settings > DNS Settings.
What I did besides this is disable the plain DNS protocol (on port 53) and other protocols I do not need, and use only DNS over HTTPS, since this is the only way I want Adguard Home to be reachable from the outside. This should hopefully mitigate potential DNS spoofing and amplification attacks.
This behavior is configurable by disabling the unused services in the Helm Chart values.yaml file.
At home, the DNS resolver is configured in my router (running OpenWRT), to avoid having to configure each device individually. You may also be able to do so if you are using a different router.
I make use at home of a Linksys WRT1900ACS wireless router, on which I installed OpenWRT. I like the idea of open-source operating systems like DD-WRT or OpenWRT for embedded devices. This is the reason why I even publish and maintain a popular Android application for managing and monitoring routers running DD-WRT (and OpenWRT to some extent): DD-WRT Companion.
To make an OpenWRT router forward all incoming (plain) DNS requests to a DNS-over-HTTPS (DoH) resolver, we can SSH into the router, install the https-dns-proxy package and configure the DoH resolver accordingly:
# Install packages opkg update opkg install https-dns-proxy # This adds a menu in the web interface opkg install luci-app-https-dns-proxy # Clean-up all existing entries and recreate a single entry with # the right DoH resolver while uci -q delete [email protected]; do :; done uci set https-dns-proxy.dns="https-dns-proxy" # A bootstrap DNS allows to resolve the DoH resolver name uci set https-dns-proxy.dns.bootstrap_dns="126.96.36.199,188.8.131.52" uci set https-dns-proxy.dns.resolver_url="https://<my_dns_domain_name>/dns-query" uci set https-dns-proxy.dns.listen_addr="127.0.0.1" uci set https-dns-proxy.dns.listen_port="5053" # Commit the changes uci commit https-dns-proxy # Restart the DNS Proxy /etc/init.d/https-dns-proxy restart
Once restarted, we can see in the OpenWRT web interface (Services > HTTPS DNS Proxy). Unfortunately, the custom values set manually in the command line will not be displayed. This is perhaps a bug in the interface package, which I will try to investigate later on when I get a chance.
The process for configuring devices is documented here: https://github.com/AdguardTeam/AdGuardHome/wiki/Encryption#configure-devices
Personally, I'm making use of the Open-Source Intra application on Android devices (until they natively support DNS over HTTPS, which is reportedly expected in Android 13). It is also possible to directly configure browsers like Chromium and Firefox since they both support secure DNS over HTTPS.
It's been a few weeks now since Adguard Home has been migrated to Kubernetes and running, and I am quite happy with the result.
However, as we can see from the screen capture above, there is one caveat worth mentioning: the client IP and hostname seen by Adguard Home is the one of Traefik, the reverse proxy. This should ideally represent the ones of each client connecting to the DNS resolver, so as to make the most of Adguard Home (like advanced query logs or the ability to block clients on an individual basis).
This is what I plan to investigate in a near future: source IP preservation.
Thanks for reading thus far, and stay tuned for other posts.
As usual, feel free to share your thoughts in the comments below.