doh-client
is a DNS over HTTPS client, which opens a local UDP (DNS) port and forwards all DNS
queries to a remote HTTP/2.0 server. By default, the client will connect to the Cloudflare DNS
service. It uses Tokio for all asynchronous IO operations and
Rustls to connect to the HTTPS server. The client uses a private
HTTP cache (see RFC 7234) to increase the
performance if the --cache-size
is not zero.
doh-client
is written in Rust. To build it you need the
Rust compiler and build system cargo
.
$ cargo build
Or to build it as a release build:
$ cargo build --release
On default, the feature socks5 proxy(RFC 1928) is enabled. To build the client without the feature use the following command:
$ cargo build --no-default-features
To run the binary, you need one positional argument, if native-certs
feature is not active (see
Usage).
$ ./doh-client /path/to/the/ca/file.pem
For example, if you use Arch Linux then the following command uses the system cert store:
# ./doh-client /etc/ca-certificates/extracted/tls-ca-bundle.pem
To run the doh-client
as a daemon and without root
under Linux with systemd
as init system
follow the instructions. This example will connect to the Cloudflare DNS service.
- Build the binary (see Build).
- Copy the binary to
/usr/bin
asroot
:# cp target/release/doh-client /usr/bin/
- Copy the config files to
/etc/systemd/system/
asroot
:If the location of the binary is different from above then change the path in# cp doh-client.service doh-client.socket /etc/systemd/system
doh-client.service
underExecStart
. In the config filedoh-client.service
the path of the CA file is set to/etc/ca-certificates/extracted/tls-ca-bundle.pem
, adjust the path before going further (The path should be correct if you use Arch Linux). - Reload
systemd
manager configuration:# systemctl daemon-reload
- Enable the
doh-client
as a daemon:# systemctl enable doh-client
- Reboot the system or start the daemon manually:
# systemctl start doh-client
- Adjust the
/etc/resolv.conf
by adding the following line:nameserver 127.0.0.1
If AppArmor is used then the doh-client
profile from the repository can be applied to
AppArmor.
- Copy the profile file
usr.bin.doh-client
to/etc/apparmor.d/
asroot
:If the location of the CA file is different from# cp usr.bin.doh-client /etc/apparmor.d/
/etc/ca-certificates/extracted/tls-ca-bundle.pem
then change the path inusr.bin.doh-client
. - Reboot the system or reload all profiles:
# systemctl restart apparmor.service
There is an AUR package available.
To run the doh-client
as a daemon and without root
under Mac OS with launchd
as init system.
This example will connect to the Cloudflare DNS service.
- Build the binary (see Build).
- Copy the binary to
/usr/local/bin
asroot
:# cp target/release/doh-client /usr/local/bin/
- Copy the
launchd
config files to/Library/LaunchDaemons/
asroot
:If the location of the binary is different from above then change the path in# cp com.doh-client.daemon.plist /Library/LaunchDaemons
com.doh-client.daemon.plist
underProgramArguments
. In the config filecom.doh-client.daemon.plist
the path of the CA file is set to/usr/local/share/doh-client/DigiCert_Global_Root_CA.pem
, download the pem file under the following link. Before copy the pem file to/usr/local/share/doh-client/
, make the directorydoh-client
withmkdir
. - Load and start the config file as follow:
# launchctl load -w /Library/LaunchDaemons/com.doh-client.daemon.plist
- Adjust the
/etc/resolv.conf
by adding the following line:nameserver 127.0.0.1
doh-client
has one required positional argument, CAFILE
which sets the path to a pem file, which
contains the trusted CA certificates.
$ ./doh-client --help
DNS over HTTPS client 3.1.2
LinkTed <[email protected]>
Open a local UDP (DNS) port and forward DNS queries to a remote HTTP/2.0 server.
By default, the client will connect to the Cloudflare DNS service.
This binary uses the env_logger as logger implementations.
See https://github.com/sebasmagri/env_logger/
USAGE:
doh-client [OPTIONS] [CAFILE]
ARGS:
<CAFILE> The path to the pem file, which contains the trusted CA certificates
If no path is given then the platform's native certificate store will be used
OPTIONS:
-c, --cache-size <UNSIGNED LONG>
The size of the private HTTP cache
If the size is 0 then the private HTTP cache is not used (ignores cache-control)
[default: 1024]
--cache-fallback
Use expired cache entries if no response is received from the server
--client-auth-certs <CERTSFILE>
The path to the pem file, which contains the certificates for the client authentication
--client-auth-key <KEYFILE>
The path to the pem file, which contains the key for the client authentication
-d, --domain <Domain>
The domain name of the remote server [default: cloudflare-dns.com]
-g, --get
Use the GET method for the HTTP/2.0 request
-h, --help
Print help information
-l, --listen-addr <Addr:Port>
Listen address [default: 127.0.0.1:53]
--listen-activation
Use file descriptor 3 under Unix as UDP socket or launch_activate_socket() under Mac OS
-p, --path <STRING>
The path of the URI [default: dns-query]
--proxy-credentials <Username:Password>
The credentials for the proxy
--proxy-host <Addr/Domain:Port>
Socks5 or HTTP CONNECT proxy host (see below)
--proxy-https-cafile <CAFILE>
The path to the pem file, which contains the trusted CA certificates for the https proxy
If no path is given then the platform's native certificate store will be used
--proxy-https-domain <Domain>
The domain name of the https proxy
--proxy-scheme <proxy-scheme>
The protocol of the proxy [possible values: socks5, socks5h, http, https]
-r, --remote-host <Addr/Domain:Port>
Remote address/domain to the DOH server (see below) [default: 1.1.1.1:443]
--retries <UNSIGNED INT>
The number of retries to connect to the remote server [default: 3]
-t, --timeout <UNSIGNED LONG>
The time in seconds after that the connection would be closed if no response is received
from the server [default: 2]
-V, --version
Print version information
CAUTION: If a domain name is used for a <Addr/Domain:Port> value instead of an IP address the system
resolver will be used to resolve the IP address of the domain name. If the `doh-client` is
configured as system resolver, then it will NOT WORK. It is recommended to always use an IP address
for <Addr/Domain:Port> values.
To demonstrate that the private HTTP cache (see
RFC 7234) increases the performance of the
client, make a request to github.com
:
$ dig github.com +nocookie
; <<>> DiG 9.13.5 <<>> github.com +nocookie
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 19752
;; flags: qr rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 0, ADDITIONAL: 1
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 1452
;; QUESTION SECTION:
;github.com. IN A
;; ANSWER SECTION:
github.com. 8 IN A 192.30.253.112
github.com. 8 IN A 192.30.253.113
;; Query time: 35 msec
;; SERVER: 127.0.0.1#53(127.0.0.1)
;; WHEN: Sa Jan 05 20:00:20 CET 2019
;; MSG SIZE rcvd: 71
The query took 35 milliseconds. If the request is made again (quick, before the response is removed from the cache):
$ dig github.com +nocookie
; <<>> DiG 9.13.5 <<>> github.com +nocookie
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 52653
;; flags: qr rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 0, ADDITIONAL: 1
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 1452
;; QUESTION SECTION:
;github.com. IN A
;; ANSWER SECTION:
github.com. 8 IN A 192.30.253.112
github.com. 8 IN A 192.30.253.113
;; Query time: 0 msec
;; SERVER: 127.0.0.1#53(127.0.0.1)
;; WHEN: Sa Jan 05 20:00:21 CET 2019
;; MSG SIZE rcvd: 71
Now, the query took 0 milliseconds, because it was cached.
How long is a DNS request and response in the cache?
- If
control-cache: max-age=XXX
is present in the HTTP header then this value is used. For example, if the server responds with acontrol-cache: max-age=100
then the DNS request and response is in the cache for 100 seconds. After 100 seconds, the client will forward the request to the server again. - If
control-cache: max-age=XXX
is not present then the smallest TTL in the answer, authority and additional section of the DNS response is used.
This project is licensed under the BSD-3-Clause license.
Any contribution intentionally submitted for inclusion in doh-client
by you, shall be licensed as
BSD-3-Clause, without any additional terms or
conditions.