1b7579f77SDag-Erling Smørgrav# 2b7579f77SDag-Erling Smørgrav# Example configuration file. 3b7579f77SDag-Erling Smørgrav# 4*c0caa2e2SCy Schubert# See unbound.conf(5) man page, version 1.12.0. 5b7579f77SDag-Erling Smørgrav# 6b7579f77SDag-Erling Smørgrav# this is a comment. 7b7579f77SDag-Erling Smørgrav 825039b37SCy Schubert# Use this anywhere in the file to include other text into this file. 9b7579f77SDag-Erling Smørgrav#include: "otherfile.conf" 10b7579f77SDag-Erling Smørgrav 1125039b37SCy Schubert# Use this anywhere in the file to include other text, that explicitly starts a 1225039b37SCy Schubert# clause, into this file. Text after this directive needs to start a clause. 1325039b37SCy Schubert#include-toplevel: "otherfile.conf" 1425039b37SCy Schubert 15b7579f77SDag-Erling Smørgrav# The server clause sets the main parameters. 16b7579f77SDag-Erling Smørgravserver: 17b7579f77SDag-Erling Smørgrav # whitespace is not necessary, but looks cleaner. 18b7579f77SDag-Erling Smørgrav 19b7579f77SDag-Erling Smørgrav # verbosity number, 0 is least verbose. 1 is default. 20b7579f77SDag-Erling Smørgrav verbosity: 1 21b7579f77SDag-Erling Smørgrav 22b7579f77SDag-Erling Smørgrav # print statistics to the log (for every thread) every N seconds. 23b7579f77SDag-Erling Smørgrav # Set to "" or 0 to disable. Default is disabled. 24b7579f77SDag-Erling Smørgrav # statistics-interval: 0 25b7579f77SDag-Erling Smørgrav 2665b390aaSDag-Erling Smørgrav # enable shm for stats, default no. if you enable also enable 2765b390aaSDag-Erling Smørgrav # statistics-interval, every time it also writes stats to the 2865b390aaSDag-Erling Smørgrav # shared memory segment keyed with shm-key. 2965b390aaSDag-Erling Smørgrav # shm-enable: no 3065b390aaSDag-Erling Smørgrav 3165b390aaSDag-Erling Smørgrav # shm for stats uses this key, and key+1 for the shared mem segment. 3265b390aaSDag-Erling Smørgrav # shm-key: 11777 3365b390aaSDag-Erling Smørgrav 34b7579f77SDag-Erling Smørgrav # enable cumulative statistics, without clearing them after printing. 35b7579f77SDag-Erling Smørgrav # statistics-cumulative: no 36b7579f77SDag-Erling Smørgrav 37b7579f77SDag-Erling Smørgrav # enable extended statistics (query types, answer codes, status) 38b7579f77SDag-Erling Smørgrav # printed from unbound-control. default off, because of speed. 39b7579f77SDag-Erling Smørgrav # extended-statistics: no 40b7579f77SDag-Erling Smørgrav 41b7579f77SDag-Erling Smørgrav # number of threads to create. 1 disables threading. 42b7579f77SDag-Erling Smørgrav # num-threads: 1 43b7579f77SDag-Erling Smørgrav 44b7579f77SDag-Erling Smørgrav # specify the interfaces to answer queries from by ip-address. 45b7579f77SDag-Erling Smørgrav # The default is to listen to localhost (127.0.0.1 and ::1). 46b7579f77SDag-Erling Smørgrav # specify 0.0.0.0 and ::0 to bind to all available interfaces. 47b7579f77SDag-Erling Smørgrav # specify every interface[@port] on a new 'interface:' labelled line. 48b7579f77SDag-Erling Smørgrav # The listen interfaces are not changed on reload, only on restart. 49b7579f77SDag-Erling Smørgrav # interface: 192.0.2.153 50b7579f77SDag-Erling Smørgrav # interface: 192.0.2.154 51b7579f77SDag-Erling Smørgrav # interface: 192.0.2.154@5003 52b7579f77SDag-Erling Smørgrav # interface: 2001:DB8::5 53b7579f77SDag-Erling Smørgrav 54b7579f77SDag-Erling Smørgrav # enable this feature to copy the source address of queries to reply. 55b7579f77SDag-Erling Smørgrav # Socket options are not supported on all platforms. experimental. 56b7579f77SDag-Erling Smørgrav # interface-automatic: no 57b7579f77SDag-Erling Smørgrav 58b7579f77SDag-Erling Smørgrav # port to answer queries from 59b7579f77SDag-Erling Smørgrav # port: 53 60b7579f77SDag-Erling Smørgrav 61b7579f77SDag-Erling Smørgrav # specify the interfaces to send outgoing queries to authoritative 62b7579f77SDag-Erling Smørgrav # server from by ip-address. If none, the default (all) interface 63b7579f77SDag-Erling Smørgrav # is used. Specify every interface on a 'outgoing-interface:' line. 64b7579f77SDag-Erling Smørgrav # outgoing-interface: 192.0.2.153 65b7579f77SDag-Erling Smørgrav # outgoing-interface: 2001:DB8::5 66b7579f77SDag-Erling Smørgrav # outgoing-interface: 2001:DB8::6 67b7579f77SDag-Erling Smørgrav 68b5663de9SDag-Erling Smørgrav # Specify a netblock to use remainder 64 bits as random bits for 69b5663de9SDag-Erling Smørgrav # upstream queries. Uses freebind option (Linux). 70b5663de9SDag-Erling Smørgrav # outgoing-interface: 2001:DB8::/64 71b5663de9SDag-Erling Smørgrav # Also (Linux:) ip -6 addr add 2001:db8::/64 dev lo 72b5663de9SDag-Erling Smørgrav # And: ip -6 route add local 2001:db8::/64 dev lo 73b5663de9SDag-Erling Smørgrav # And set prefer-ip6: yes to use the ip6 randomness from a netblock. 74b5663de9SDag-Erling Smørgrav # Set this to yes to prefer ipv6 upstream servers over ipv4. 75b5663de9SDag-Erling Smørgrav # prefer-ip6: no 76b5663de9SDag-Erling Smørgrav 7725039b37SCy Schubert # Prefer ipv4 upstream servers, even if ipv6 is available. 7825039b37SCy Schubert # prefer-ip4: no 7925039b37SCy Schubert 80b7579f77SDag-Erling Smørgrav # number of ports to allocate per thread, determines the size of the 81b7579f77SDag-Erling Smørgrav # port range that can be open simultaneously. About double the 82b7579f77SDag-Erling Smørgrav # num-queries-per-thread, or, use as many as the OS will allow you. 83b7579f77SDag-Erling Smørgrav # outgoing-range: 4096 84b7579f77SDag-Erling Smørgrav 85b7579f77SDag-Erling Smørgrav # permit unbound to use this port number or port range for 86b7579f77SDag-Erling Smørgrav # making outgoing queries, using an outgoing interface. 87b7579f77SDag-Erling Smørgrav # outgoing-port-permit: 32768 88b7579f77SDag-Erling Smørgrav 89b7579f77SDag-Erling Smørgrav # deny unbound the use this of port number or port range for 90b7579f77SDag-Erling Smørgrav # making outgoing queries, using an outgoing interface. 91b7579f77SDag-Erling Smørgrav # Use this to make sure unbound does not grab a UDP port that some 92b7579f77SDag-Erling Smørgrav # other server on this computer needs. The default is to avoid 93b7579f77SDag-Erling Smørgrav # IANA-assigned port numbers. 948ed2b524SDag-Erling Smørgrav # If multiple outgoing-port-permit and outgoing-port-avoid options 958ed2b524SDag-Erling Smørgrav # are present, they are processed in order. 96b7579f77SDag-Erling Smørgrav # outgoing-port-avoid: "3200-3208" 97b7579f77SDag-Erling Smørgrav 98b7579f77SDag-Erling Smørgrav # number of outgoing simultaneous tcp buffers to hold per thread. 99b7579f77SDag-Erling Smørgrav # outgoing-num-tcp: 10 100b7579f77SDag-Erling Smørgrav 101b7579f77SDag-Erling Smørgrav # number of incoming simultaneous tcp buffers to hold per thread. 102b7579f77SDag-Erling Smørgrav # incoming-num-tcp: 10 103b7579f77SDag-Erling Smørgrav 104b7579f77SDag-Erling Smørgrav # buffer size for UDP port 53 incoming (SO_RCVBUF socket option). 105b7579f77SDag-Erling Smørgrav # 0 is system default. Use 4m to catch query spikes for busy servers. 106b7579f77SDag-Erling Smørgrav # so-rcvbuf: 0 107b7579f77SDag-Erling Smørgrav 108b7579f77SDag-Erling Smørgrav # buffer size for UDP port 53 outgoing (SO_SNDBUF socket option). 109b7579f77SDag-Erling Smørgrav # 0 is system default. Use 4m to handle spikes on very busy servers. 110b7579f77SDag-Erling Smørgrav # so-sndbuf: 0 111b7579f77SDag-Erling Smørgrav 112ff825849SDag-Erling Smørgrav # use SO_REUSEPORT to distribute queries over threads. 113e86b9096SDag-Erling Smørgrav # at extreme load it could be better to turn it off to distribute even. 1144c75e3aaSDag-Erling Smørgrav # so-reuseport: yes 11517d15b25SDag-Erling Smørgrav 11609a3aaf3SDag-Erling Smørgrav # use IP_TRANSPARENT so the interface: addresses can be non-local 11709a3aaf3SDag-Erling Smørgrav # and you can config non-existing IPs that are going to work later on 118f61ef7f6SDag-Erling Smørgrav # (uses IP_BINDANY on FreeBSD). 11909a3aaf3SDag-Erling Smørgrav # ip-transparent: no 12009a3aaf3SDag-Erling Smørgrav 121e2d15004SDag-Erling Smørgrav # use IP_FREEBIND so the interface: addresses can be non-local 122e2d15004SDag-Erling Smørgrav # and you can bind to nonexisting IPs and interfaces that are down. 123e2d15004SDag-Erling Smørgrav # Linux only. On Linux you also have ip-transparent that is similar. 124e2d15004SDag-Erling Smørgrav # ip-freebind: no 125e2d15004SDag-Erling Smørgrav 12625039b37SCy Schubert # the value of the Differentiated Services Codepoint (DSCP) 12725039b37SCy Schubert # in the differentiated services field (DS) of the outgoing 12825039b37SCy Schubert # IP packets 12925039b37SCy Schubert # ip-dscp: 0 13025039b37SCy Schubert 131b7579f77SDag-Erling Smørgrav # EDNS reassembly buffer to advertise to UDP peers (the actual buffer 132*c0caa2e2SCy Schubert # is set with msg-buffer-size). 133*c0caa2e2SCy Schubert # edns-buffer-size: 1232 134b7579f77SDag-Erling Smørgrav 13517d15b25SDag-Erling Smørgrav # Maximum UDP response size (not applied to TCP response). 13617d15b25SDag-Erling Smørgrav # Suggested values are 512 to 4096. Default is 4096. 65536 disables it. 13717d15b25SDag-Erling Smørgrav # max-udp-size: 4096 13817d15b25SDag-Erling Smørgrav 139e86b9096SDag-Erling Smørgrav # max memory to use for stream(tcp and tls) waiting result buffers. 140e86b9096SDag-Erling Smørgrav # stream-wait-size: 4m 141e86b9096SDag-Erling Smørgrav 142b7579f77SDag-Erling Smørgrav # buffer size for handling DNS data. No messages larger than this 143b7579f77SDag-Erling Smørgrav # size can be sent or received, by UDP or TCP. In bytes. 144b7579f77SDag-Erling Smørgrav # msg-buffer-size: 65552 145b7579f77SDag-Erling Smørgrav 146b7579f77SDag-Erling Smørgrav # the amount of memory to use for the message cache. 147b7579f77SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "4Mb". 148b7579f77SDag-Erling Smørgrav # msg-cache-size: 4m 149b7579f77SDag-Erling Smørgrav 150b7579f77SDag-Erling Smørgrav # the number of slabs to use for the message cache. 151b7579f77SDag-Erling Smørgrav # the number of slabs must be a power of 2. 152b7579f77SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 153b7579f77SDag-Erling Smørgrav # msg-cache-slabs: 4 154b7579f77SDag-Erling Smørgrav 155b7579f77SDag-Erling Smørgrav # the number of queries that a thread gets to service. 156b7579f77SDag-Erling Smørgrav # num-queries-per-thread: 1024 157b7579f77SDag-Erling Smørgrav 158b7579f77SDag-Erling Smørgrav # if very busy, 50% queries run to completion, 50% get timeout in msec 159b7579f77SDag-Erling Smørgrav # jostle-timeout: 200 160b7579f77SDag-Erling Smørgrav 16117d15b25SDag-Erling Smørgrav # msec to wait before close of port on timeout UDP. 0 disables. 16217d15b25SDag-Erling Smørgrav # delay-close: 0 16317d15b25SDag-Erling Smørgrav 164e86b9096SDag-Erling Smørgrav # msec for waiting for an unknown server to reply. Increase if you 165e86b9096SDag-Erling Smørgrav # are behind a slow satellite link, to eg. 1128. 166e86b9096SDag-Erling Smørgrav # unknown-server-time-limit: 376 167e86b9096SDag-Erling Smørgrav 168b7579f77SDag-Erling Smørgrav # the amount of memory to use for the RRset cache. 169b7579f77SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "4Mb". 170b7579f77SDag-Erling Smørgrav # rrset-cache-size: 4m 171b7579f77SDag-Erling Smørgrav 172b7579f77SDag-Erling Smørgrav # the number of slabs to use for the RRset cache. 173b7579f77SDag-Erling Smørgrav # the number of slabs must be a power of 2. 174b7579f77SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 175b7579f77SDag-Erling Smørgrav # rrset-cache-slabs: 4 176b7579f77SDag-Erling Smørgrav 177b7579f77SDag-Erling Smørgrav # the time to live (TTL) value lower bound, in seconds. Default 0. 178b7579f77SDag-Erling Smørgrav # If more than an hour could easily give trouble due to stale data. 179b7579f77SDag-Erling Smørgrav # cache-min-ttl: 0 180b7579f77SDag-Erling Smørgrav 181b7579f77SDag-Erling Smørgrav # the time to live (TTL) value cap for RRsets and messages in the 182b7579f77SDag-Erling Smørgrav # cache. Items are not cached for longer. In seconds. 183b7579f77SDag-Erling Smørgrav # cache-max-ttl: 86400 184b7579f77SDag-Erling Smørgrav 18509a3aaf3SDag-Erling Smørgrav # the time to live (TTL) value cap for negative responses in the cache 18609a3aaf3SDag-Erling Smørgrav # cache-max-negative-ttl: 3600 18709a3aaf3SDag-Erling Smørgrav 188b7579f77SDag-Erling Smørgrav # the time to live (TTL) value for cached roundtrip times, lameness and 189b7579f77SDag-Erling Smørgrav # EDNS version information for hosts. In seconds. 190b7579f77SDag-Erling Smørgrav # infra-host-ttl: 900 191b7579f77SDag-Erling Smørgrav 1926480faa8SDag-Erling Smørgrav # minimum wait time for responses, increase if uplink is long. In msec. 1936480faa8SDag-Erling Smørgrav # infra-cache-min-rtt: 50 1946480faa8SDag-Erling Smørgrav 195b7579f77SDag-Erling Smørgrav # the number of slabs to use for the Infrastructure cache. 196b7579f77SDag-Erling Smørgrav # the number of slabs must be a power of 2. 197b7579f77SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 198b7579f77SDag-Erling Smørgrav # infra-cache-slabs: 4 199b7579f77SDag-Erling Smørgrav 200b7579f77SDag-Erling Smørgrav # the maximum number of hosts that are cached (roundtrip, EDNS, lame). 201b7579f77SDag-Erling Smørgrav # infra-cache-numhosts: 10000 202b7579f77SDag-Erling Smørgrav 203b5663de9SDag-Erling Smørgrav # define a number of tags here, use with local-zone, access-control. 204b5663de9SDag-Erling Smørgrav # repeat the define-tag statement to add additional tags. 205b5663de9SDag-Erling Smørgrav # define-tag: "tag1 tag2 tag3" 206b5663de9SDag-Erling Smørgrav 207b7579f77SDag-Erling Smørgrav # Enable IPv4, "yes" or "no". 208b7579f77SDag-Erling Smørgrav # do-ip4: yes 209b7579f77SDag-Erling Smørgrav 210b7579f77SDag-Erling Smørgrav # Enable IPv6, "yes" or "no". 211b7579f77SDag-Erling Smørgrav # do-ip6: yes 212b7579f77SDag-Erling Smørgrav 213b7579f77SDag-Erling Smørgrav # Enable UDP, "yes" or "no". 214b7579f77SDag-Erling Smørgrav # do-udp: yes 215b7579f77SDag-Erling Smørgrav 216b7579f77SDag-Erling Smørgrav # Enable TCP, "yes" or "no". 217b7579f77SDag-Erling Smørgrav # do-tcp: yes 218b7579f77SDag-Erling Smørgrav 219b7579f77SDag-Erling Smørgrav # upstream connections use TCP only (and no UDP), "yes" or "no" 220b7579f77SDag-Erling Smørgrav # useful for tunneling scenarios, default no. 221b7579f77SDag-Erling Smørgrav # tcp-upstream: no 222b7579f77SDag-Erling Smørgrav 2238a384985SDag-Erling Smørgrav # upstream connections also use UDP (even if do-udp is no). 2248a384985SDag-Erling Smørgrav # useful if if you want UDP upstream, but don't provide UDP downstream. 2258a384985SDag-Erling Smørgrav # udp-upstream-without-downstream: no 2268a384985SDag-Erling Smørgrav 227f61ef7f6SDag-Erling Smørgrav # Maximum segment size (MSS) of TCP socket on which the server 228f61ef7f6SDag-Erling Smørgrav # responds to queries. Default is 0, system default MSS. 229f61ef7f6SDag-Erling Smørgrav # tcp-mss: 0 230f61ef7f6SDag-Erling Smørgrav 231f61ef7f6SDag-Erling Smørgrav # Maximum segment size (MSS) of TCP socket for outgoing queries. 232f61ef7f6SDag-Erling Smørgrav # Default is 0, system default MSS. 233f61ef7f6SDag-Erling Smørgrav # outgoing-tcp-mss: 0 234f61ef7f6SDag-Erling Smørgrav 2354c75e3aaSDag-Erling Smørgrav # Idle TCP timeout, connection closed in milliseconds 2364c75e3aaSDag-Erling Smørgrav # tcp-idle-timeout: 30000 2374c75e3aaSDag-Erling Smørgrav 2384c75e3aaSDag-Erling Smørgrav # Enable EDNS TCP keepalive option. 2394c75e3aaSDag-Erling Smørgrav # edns-tcp-keepalive: no 2404c75e3aaSDag-Erling Smørgrav 2414c75e3aaSDag-Erling Smørgrav # Timeout for EDNS TCP keepalive, in msec. 2424c75e3aaSDag-Erling Smørgrav # edns-tcp-keepalive-timeout: 120000 2434c75e3aaSDag-Erling Smørgrav 2443005e0a3SDag-Erling Smørgrav # Use systemd socket activation for UDP, TCP, and control sockets. 2453005e0a3SDag-Erling Smørgrav # use-systemd: no 2463005e0a3SDag-Erling Smørgrav 247b7579f77SDag-Erling Smørgrav # Detach from the terminal, run in background, "yes" or "no". 2483005e0a3SDag-Erling Smørgrav # Set the value to "no" when unbound runs as systemd service. 249b7579f77SDag-Erling Smørgrav # do-daemonize: yes 250b7579f77SDag-Erling Smørgrav 251b7579f77SDag-Erling Smørgrav # control which clients are allowed to make (recursive) queries 252b7579f77SDag-Erling Smørgrav # to this server. Specify classless netblocks with /size and action. 253b7579f77SDag-Erling Smørgrav # By default everything is refused, except for localhost. 254b7579f77SDag-Erling Smørgrav # Choose deny (drop message), refuse (polite error reply), 2553bd4df0aSDag-Erling Smørgrav # allow (recursive ok), allow_setrd (recursive ok, rd bit is forced on), 2563bd4df0aSDag-Erling Smørgrav # allow_snoop (recursive and nonrecursive ok) 25717d15b25SDag-Erling Smørgrav # deny_non_local (drop queries unless can be answered from local-data) 25817d15b25SDag-Erling Smørgrav # refuse_non_local (like deny_non_local but polite error reply). 259b7579f77SDag-Erling Smørgrav # access-control: 0.0.0.0/0 refuse 260b7579f77SDag-Erling Smørgrav # access-control: 127.0.0.0/8 allow 261b7579f77SDag-Erling Smørgrav # access-control: ::0/0 refuse 262b7579f77SDag-Erling Smørgrav # access-control: ::1 allow 263b7579f77SDag-Erling Smørgrav # access-control: ::ffff:127.0.0.1 allow 264b7579f77SDag-Erling Smørgrav 265b5663de9SDag-Erling Smørgrav # tag access-control with list of tags (in "" with spaces between) 266b5663de9SDag-Erling Smørgrav # Clients using this access control element use localzones that 267b5663de9SDag-Erling Smørgrav # are tagged with one of these tags. 268b5663de9SDag-Erling Smørgrav # access-control-tag: 192.0.2.0/24 "tag2 tag3" 269b5663de9SDag-Erling Smørgrav 270b5663de9SDag-Erling Smørgrav # set action for particular tag for given access control element 271b5663de9SDag-Erling Smørgrav # if you have multiple tag values, the tag used to lookup the action 272b5663de9SDag-Erling Smørgrav # is the first tag match between access-control-tag and local-zone-tag 273b5663de9SDag-Erling Smørgrav # where "first" comes from the order of the define-tag values. 274b5663de9SDag-Erling Smørgrav # access-control-tag-action: 192.0.2.0/24 tag3 refuse 275b5663de9SDag-Erling Smørgrav 276b5663de9SDag-Erling Smørgrav # set redirect data for particular tag for access control element 277b5663de9SDag-Erling Smørgrav # access-control-tag-data: 192.0.2.0/24 tag2 "A 127.0.0.1" 278b5663de9SDag-Erling Smørgrav 279bc892140SDag-Erling Smørgrav # Set view for access control element 280bc892140SDag-Erling Smørgrav # access-control-view: 192.0.2.0/24 viewname 281bc892140SDag-Erling Smørgrav 282b7579f77SDag-Erling Smørgrav # if given, a chroot(2) is done to the given directory. 283b7579f77SDag-Erling Smørgrav # i.e. you can chroot to the working directory, for example, 284b7579f77SDag-Erling Smørgrav # for extra security, but make sure all files are in that directory. 285b7579f77SDag-Erling Smørgrav # 286b7579f77SDag-Erling Smørgrav # If chroot is enabled, you should pass the configfile (from the 287b7579f77SDag-Erling Smørgrav # commandline) as a full path from the original root. After the 288b7579f77SDag-Erling Smørgrav # chroot has been performed the now defunct portion of the config 289b7579f77SDag-Erling Smørgrav # file path is removed to be able to reread the config after a reload. 290b7579f77SDag-Erling Smørgrav # 291b7579f77SDag-Erling Smørgrav # All other file paths (working dir, logfile, roothints, and 292b7579f77SDag-Erling Smørgrav # key files) can be specified in several ways: 293b7579f77SDag-Erling Smørgrav # o as an absolute path relative to the new root. 294b7579f77SDag-Erling Smørgrav # o as a relative path to the working directory. 295b7579f77SDag-Erling Smørgrav # o as an absolute path relative to the original root. 296b7579f77SDag-Erling Smørgrav # In the last case the path is adjusted to remove the unused portion. 297b7579f77SDag-Erling Smørgrav # 298b7579f77SDag-Erling Smørgrav # The pid file can be absolute and outside of the chroot, it is 299b7579f77SDag-Erling Smørgrav # written just prior to performing the chroot and dropping permissions. 300b7579f77SDag-Erling Smørgrav # 3010eefd307SCy Schubert # Additionally, unbound may need to access /dev/urandom (for entropy). 302b7579f77SDag-Erling Smørgrav # How to do this is specific to your OS. 303b7579f77SDag-Erling Smørgrav # 304b7579f77SDag-Erling Smørgrav # If you give "" no chroot is performed. The path must not end in a /. 305b7579f77SDag-Erling Smørgrav # chroot: "@UNBOUND_CHROOT_DIR@" 306b7579f77SDag-Erling Smørgrav 307b7579f77SDag-Erling Smørgrav # if given, user privileges are dropped (after binding port), 308b7579f77SDag-Erling Smørgrav # and the given username is assumed. Default is user "unbound". 309b7579f77SDag-Erling Smørgrav # If you give "" no privileges are dropped. 310b7579f77SDag-Erling Smørgrav # username: "@UNBOUND_USERNAME@" 311b7579f77SDag-Erling Smørgrav 312b7579f77SDag-Erling Smørgrav # the working directory. The relative files in this config are 313b7579f77SDag-Erling Smørgrav # relative to this directory. If you give "" the working directory 314b7579f77SDag-Erling Smørgrav # is not changed. 315b5663de9SDag-Erling Smørgrav # If you give a server: directory: dir before include: file statements 316b5663de9SDag-Erling Smørgrav # then those includes can be relative to the working directory. 317b7579f77SDag-Erling Smørgrav # directory: "@UNBOUND_RUN_DIR@" 318b7579f77SDag-Erling Smørgrav 319b7579f77SDag-Erling Smørgrav # the log file, "" means log to stderr. 320b7579f77SDag-Erling Smørgrav # Use of this option sets use-syslog to "no". 321b7579f77SDag-Erling Smørgrav # logfile: "" 322b7579f77SDag-Erling Smørgrav 323b7579f77SDag-Erling Smørgrav # Log to syslog(3) if yes. The log facility LOG_DAEMON is used to 324bc892140SDag-Erling Smørgrav # log to. If yes, it overrides the logfile. 325b7579f77SDag-Erling Smørgrav # use-syslog: yes 326b7579f77SDag-Erling Smørgrav 327bc892140SDag-Erling Smørgrav # Log identity to report. if empty, defaults to the name of argv[0] 328bc892140SDag-Erling Smørgrav # (usually "unbound"). 329bc892140SDag-Erling Smørgrav # log-identity: "" 330bc892140SDag-Erling Smørgrav 331b7579f77SDag-Erling Smørgrav # print UTC timestamp in ascii to logfile, default is epoch in seconds. 332b7579f77SDag-Erling Smørgrav # log-time-ascii: no 333b7579f77SDag-Erling Smørgrav 334b7579f77SDag-Erling Smørgrav # print one line with time, IP, name, type, class for every query. 335b7579f77SDag-Erling Smørgrav # log-queries: no 336b7579f77SDag-Erling Smørgrav 3373005e0a3SDag-Erling Smørgrav # print one line per reply, with time, IP, name, type, class, rcode, 3383005e0a3SDag-Erling Smørgrav # timetoresolve, fromcache and responsesize. 3393005e0a3SDag-Erling Smørgrav # log-replies: no 3403005e0a3SDag-Erling Smørgrav 341e86b9096SDag-Erling Smørgrav # log with tag 'query' and 'reply' instead of 'info' for 342e86b9096SDag-Erling Smørgrav # filtering log-queries and log-replies from the log. 343e86b9096SDag-Erling Smørgrav # log-tag-queryreply: no 344e86b9096SDag-Erling Smørgrav 3454c75e3aaSDag-Erling Smørgrav # log the local-zone actions, like local-zone type inform is enabled 3464c75e3aaSDag-Erling Smørgrav # also for the other local zone types. 3474c75e3aaSDag-Erling Smørgrav # log-local-actions: no 3484c75e3aaSDag-Erling Smørgrav 3494c75e3aaSDag-Erling Smørgrav # print log lines that say why queries return SERVFAIL to clients. 3504c75e3aaSDag-Erling Smørgrav # log-servfail: no 3514c75e3aaSDag-Erling Smørgrav 352b7579f77SDag-Erling Smørgrav # the pid file. Can be an absolute path outside of chroot/work dir. 353b7579f77SDag-Erling Smørgrav # pidfile: "@UNBOUND_PIDFILE@" 354b7579f77SDag-Erling Smørgrav 355b7579f77SDag-Erling Smørgrav # file to read root hints from. 35605ab2901SDag-Erling Smørgrav # get one from https://www.internic.net/domain/named.cache 357b7579f77SDag-Erling Smørgrav # root-hints: "" 358b7579f77SDag-Erling Smørgrav 359b7579f77SDag-Erling Smørgrav # enable to not answer id.server and hostname.bind queries. 360b7579f77SDag-Erling Smørgrav # hide-identity: no 361b7579f77SDag-Erling Smørgrav 362b7579f77SDag-Erling Smørgrav # enable to not answer version.server and version.bind queries. 363b7579f77SDag-Erling Smørgrav # hide-version: no 364b7579f77SDag-Erling Smørgrav 36565b390aaSDag-Erling Smørgrav # enable to not answer trustanchor.unbound queries. 36665b390aaSDag-Erling Smørgrav # hide-trustanchor: no 36765b390aaSDag-Erling Smørgrav 368b7579f77SDag-Erling Smørgrav # the identity to report. Leave "" or default to return hostname. 369b7579f77SDag-Erling Smørgrav # identity: "" 370b7579f77SDag-Erling Smørgrav 371b7579f77SDag-Erling Smørgrav # the version to report. Leave "" or default to return package version. 372b7579f77SDag-Erling Smørgrav # version: "" 373b7579f77SDag-Erling Smørgrav 374b7579f77SDag-Erling Smørgrav # the target fetch policy. 375b7579f77SDag-Erling Smørgrav # series of integers describing the policy per dependency depth. 376b7579f77SDag-Erling Smørgrav # The number of values in the list determines the maximum dependency 377b7579f77SDag-Erling Smørgrav # depth the recursor will pursue before giving up. Each integer means: 378b7579f77SDag-Erling Smørgrav # -1 : fetch all targets opportunistically, 379b7579f77SDag-Erling Smørgrav # 0: fetch on demand, 380b7579f77SDag-Erling Smørgrav # positive value: fetch that many targets opportunistically. 381b7579f77SDag-Erling Smørgrav # Enclose the list of numbers between quotes (""). 382b7579f77SDag-Erling Smørgrav # target-fetch-policy: "3 2 1 0 0" 383b7579f77SDag-Erling Smørgrav 384b7579f77SDag-Erling Smørgrav # Harden against very small EDNS buffer sizes. 385b7579f77SDag-Erling Smørgrav # harden-short-bufsize: no 386b7579f77SDag-Erling Smørgrav 387b7579f77SDag-Erling Smørgrav # Harden against unseemly large queries. 388b7579f77SDag-Erling Smørgrav # harden-large-queries: no 389b7579f77SDag-Erling Smørgrav 390b7579f77SDag-Erling Smørgrav # Harden against out of zone rrsets, to avoid spoofing attempts. 391b7579f77SDag-Erling Smørgrav # harden-glue: yes 392b7579f77SDag-Erling Smørgrav 393b7579f77SDag-Erling Smørgrav # Harden against receiving dnssec-stripped data. If you turn it 394b7579f77SDag-Erling Smørgrav # off, failing to validate dnskey data for a trustanchor will 395b7579f77SDag-Erling Smørgrav # trigger insecure mode for that zone (like without a trustanchor). 396b7579f77SDag-Erling Smørgrav # Default on, which insists on dnssec data for trust-anchored zones. 397b7579f77SDag-Erling Smørgrav # harden-dnssec-stripped: yes 398b7579f77SDag-Erling Smørgrav 399b7579f77SDag-Erling Smørgrav # Harden against queries that fall under dnssec-signed nxdomain names. 4004c75e3aaSDag-Erling Smørgrav # harden-below-nxdomain: yes 401b7579f77SDag-Erling Smørgrav 402b7579f77SDag-Erling Smørgrav # Harden the referral path by performing additional queries for 403b7579f77SDag-Erling Smørgrav # infrastructure data. Validates the replies (if possible). 404b7579f77SDag-Erling Smørgrav # Default off, because the lookups burden the server. Experimental 405b7579f77SDag-Erling Smørgrav # implementation of draft-wijngaards-dnsext-resolver-side-mitigation. 406b7579f77SDag-Erling Smørgrav # harden-referral-path: no 407b7579f77SDag-Erling Smørgrav 40809a3aaf3SDag-Erling Smørgrav # Harden against algorithm downgrade when multiple algorithms are 40909a3aaf3SDag-Erling Smørgrav # advertised in the DS record. If no, allows the weakest algorithm 41009a3aaf3SDag-Erling Smørgrav # to validate the zone. 411b75612f8SDag-Erling Smørgrav # harden-algo-downgrade: no 41209a3aaf3SDag-Erling Smørgrav 41305ab2901SDag-Erling Smørgrav # Sent minimum amount of information to upstream servers to enhance 41405ab2901SDag-Erling Smørgrav # privacy. Only sent minimum required labels of the QNAME and set QTYPE 41557bddd21SDag-Erling Smørgrav # to A when possible. 4163bd4df0aSDag-Erling Smørgrav # qname-minimisation: yes 41705ab2901SDag-Erling Smørgrav 418bc892140SDag-Erling Smørgrav # QNAME minimisation in strict mode. Do not fall-back to sending full 419bc892140SDag-Erling Smørgrav # QNAME to potentially broken nameservers. A lot of domains will not be 420bc892140SDag-Erling Smørgrav # resolvable when this option in enabled. 421bc892140SDag-Erling Smørgrav # This option only has effect when qname-minimisation is enabled. 422bc892140SDag-Erling Smørgrav # qname-minimisation-strict: no 423bc892140SDag-Erling Smørgrav 42457bddd21SDag-Erling Smørgrav # Aggressive NSEC uses the DNSSEC NSEC chain to synthesize NXDOMAIN 42557bddd21SDag-Erling Smørgrav # and other denials, using information from previous NXDOMAINs answers. 42657bddd21SDag-Erling Smørgrav # aggressive-nsec: no 42757bddd21SDag-Erling Smørgrav 428b7579f77SDag-Erling Smørgrav # Use 0x20-encoded random bits in the query to foil spoof attempts. 429b7579f77SDag-Erling Smørgrav # This feature is an experimental implementation of draft dns-0x20. 430b7579f77SDag-Erling Smørgrav # use-caps-for-id: no 431b7579f77SDag-Erling Smørgrav 43209a3aaf3SDag-Erling Smørgrav # Domains (and domains in them) without support for dns-0x20 and 43309a3aaf3SDag-Erling Smørgrav # the fallback fails because they keep sending different answers. 434*c0caa2e2SCy Schubert # caps-exempt: "licdn.com" 435*c0caa2e2SCy Schubert # caps-exempt: "senderbase.org" 43609a3aaf3SDag-Erling Smørgrav 437b7579f77SDag-Erling Smørgrav # Enforce privacy of these addresses. Strips them away from answers. 438b7579f77SDag-Erling Smørgrav # It may cause DNSSEC validation to additionally mark it as bogus. 439b7579f77SDag-Erling Smørgrav # Protects against 'DNS Rebinding' (uses browser as network proxy). 440b7579f77SDag-Erling Smørgrav # Only 'private-domain' and 'local-data' names are allowed to have 441b7579f77SDag-Erling Smørgrav # these private addresses. No default. 442b7579f77SDag-Erling Smørgrav # private-address: 10.0.0.0/8 443b7579f77SDag-Erling Smørgrav # private-address: 172.16.0.0/12 444b7579f77SDag-Erling Smørgrav # private-address: 192.168.0.0/16 445b7579f77SDag-Erling Smørgrav # private-address: 169.254.0.0/16 446b7579f77SDag-Erling Smørgrav # private-address: fd00::/8 447b7579f77SDag-Erling Smørgrav # private-address: fe80::/10 44805ab2901SDag-Erling Smørgrav # private-address: ::ffff:0:0/96 449b7579f77SDag-Erling Smørgrav 450b7579f77SDag-Erling Smørgrav # Allow the domain (and its subdomains) to contain private addresses. 451b7579f77SDag-Erling Smørgrav # local-data statements are allowed to contain private addresses too. 452b7579f77SDag-Erling Smørgrav # private-domain: "example.com" 453b7579f77SDag-Erling Smørgrav 454b7579f77SDag-Erling Smørgrav # If nonzero, unwanted replies are not only reported in statistics, 455b7579f77SDag-Erling Smørgrav # but also a running total is kept per thread. If it reaches the 456b7579f77SDag-Erling Smørgrav # threshold, a warning is printed and a defensive action is taken, 457b7579f77SDag-Erling Smørgrav # the cache is cleared to flush potential poison out of it. 458b7579f77SDag-Erling Smørgrav # A suggested value is 10000000, the default is 0 (turned off). 459b7579f77SDag-Erling Smørgrav # unwanted-reply-threshold: 0 460b7579f77SDag-Erling Smørgrav 461b7579f77SDag-Erling Smørgrav # Do not query the following addresses. No DNS queries are sent there. 462b7579f77SDag-Erling Smørgrav # List one address per entry. List classless netblocks with /size, 463b7579f77SDag-Erling Smørgrav # do-not-query-address: 127.0.0.1/8 464b7579f77SDag-Erling Smørgrav # do-not-query-address: ::1 465b7579f77SDag-Erling Smørgrav 466b7579f77SDag-Erling Smørgrav # if yes, the above default do-not-query-address entries are present. 467b7579f77SDag-Erling Smørgrav # if no, localhost can be queried (for testing and debugging). 468b7579f77SDag-Erling Smørgrav # do-not-query-localhost: yes 469b7579f77SDag-Erling Smørgrav 470b7579f77SDag-Erling Smørgrav # if yes, perform prefetching of almost expired message cache entries. 471b7579f77SDag-Erling Smørgrav # prefetch: no 472b7579f77SDag-Erling Smørgrav 473b7579f77SDag-Erling Smørgrav # if yes, perform key lookups adjacent to normal lookups. 474b7579f77SDag-Erling Smørgrav # prefetch-key: no 475b7579f77SDag-Erling Smørgrav 476e86b9096SDag-Erling Smørgrav # deny queries of type ANY with an empty response. 477e86b9096SDag-Erling Smørgrav # deny-any: no 478e86b9096SDag-Erling Smørgrav 479b7579f77SDag-Erling Smørgrav # if yes, Unbound rotates RRSet order in response. 48025039b37SCy Schubert # rrset-roundrobin: yes 481b7579f77SDag-Erling Smørgrav 482b7579f77SDag-Erling Smørgrav # if yes, Unbound doesn't insert authority/additional sections 483b7579f77SDag-Erling Smørgrav # into response messages when those sections are not required. 4844c75e3aaSDag-Erling Smørgrav # minimal-responses: yes 485b7579f77SDag-Erling Smørgrav 486e2d15004SDag-Erling Smørgrav # true to disable DNSSEC lameness check in iterator. 487e2d15004SDag-Erling Smørgrav # disable-dnssec-lame-check: no 488e2d15004SDag-Erling Smørgrav 489b7579f77SDag-Erling Smørgrav # module configuration of the server. A string with identifiers 490ff825849SDag-Erling Smørgrav # separated by spaces. Syntax: "[dns64] [validator] iterator" 491e86b9096SDag-Erling Smørgrav # most modules have to be listed at the beginning of the line, 492e86b9096SDag-Erling Smørgrav # except cachedb(just before iterator), and python (at the beginning, 493e86b9096SDag-Erling Smørgrav # or, just before the iterator). 494b7579f77SDag-Erling Smørgrav # module-config: "validator iterator" 495b7579f77SDag-Erling Smørgrav 496b7579f77SDag-Erling Smørgrav # File with trusted keys, kept uptodate using RFC5011 probes, 497b7579f77SDag-Erling Smørgrav # initial file like trust-anchor-file, then it stores metadata. 498b7579f77SDag-Erling Smørgrav # Use several entries, one per domain name, to track multiple zones. 499b7579f77SDag-Erling Smørgrav # 500b7579f77SDag-Erling Smørgrav # If you want to perform DNSSEC validation, run unbound-anchor before 501b7579f77SDag-Erling Smørgrav # you start unbound (i.e. in the system boot scripts). And enable: 502b7579f77SDag-Erling Smørgrav # Please note usage of unbound-anchor root anchor is at your own risk 503b7579f77SDag-Erling Smørgrav # and under the terms of our LICENSE (see that file in the source). 504b7579f77SDag-Erling Smørgrav # auto-trust-anchor-file: "@UNBOUND_ROOTKEY_FILE@" 505b7579f77SDag-Erling Smørgrav 506c7f4d7adSDag-Erling Smørgrav # trust anchor signaling sends a RFC8145 key tag query after priming. 5078a384985SDag-Erling Smørgrav # trust-anchor-signaling: yes 508c7f4d7adSDag-Erling Smørgrav 5090fb34990SDag-Erling Smørgrav # Root key trust anchor sentinel (draft-ietf-dnsop-kskroll-sentinel) 5100fb34990SDag-Erling Smørgrav # root-key-sentinel: yes 5110fb34990SDag-Erling Smørgrav 512b7579f77SDag-Erling Smørgrav # File with trusted keys for validation. Specify more than one file 513b7579f77SDag-Erling Smørgrav # with several entries, one file per entry. 514b7579f77SDag-Erling Smørgrav # Zone file format, with DS and DNSKEY entries. 515b7579f77SDag-Erling Smørgrav # Note this gets out of date, use auto-trust-anchor-file please. 516b7579f77SDag-Erling Smørgrav # trust-anchor-file: "" 517b7579f77SDag-Erling Smørgrav 518b7579f77SDag-Erling Smørgrav # Trusted key for validation. DS or DNSKEY. specify the RR on a 519b7579f77SDag-Erling Smørgrav # single line, surrounded by "". TTL is ignored. class is IN default. 520b7579f77SDag-Erling Smørgrav # Note this gets out of date, use auto-trust-anchor-file please. 521b7579f77SDag-Erling Smørgrav # (These examples are from August 2007 and may not be valid anymore). 522b7579f77SDag-Erling Smørgrav # trust-anchor: "nlnetlabs.nl. DNSKEY 257 3 5 AQPzzTWMz8qSWIQlfRnPckx2BiVmkVN6LPupO3mbz7FhLSnm26n6iG9N Lby97Ji453aWZY3M5/xJBSOS2vWtco2t8C0+xeO1bc/d6ZTy32DHchpW 6rDH1vp86Ll+ha0tmwyy9QP7y2bVw5zSbFCrefk8qCUBgfHm9bHzMG1U BYtEIQ==" 523b7579f77SDag-Erling Smørgrav # trust-anchor: "jelte.nlnetlabs.nl. DS 42860 5 1 14D739EB566D2B1A5E216A0BA4D17FA9B038BE4A" 524b7579f77SDag-Erling Smørgrav 525b7579f77SDag-Erling Smørgrav # File with trusted keys for validation. Specify more than one file 526b7579f77SDag-Erling Smørgrav # with several entries, one file per entry. Like trust-anchor-file 527b7579f77SDag-Erling Smørgrav # but has a different file format. Format is BIND-9 style format, 528b7579f77SDag-Erling Smørgrav # the trusted-keys { name flag proto algo "key"; }; clauses are read. 529b7579f77SDag-Erling Smørgrav # you need external update procedures to track changes in keys. 530b7579f77SDag-Erling Smørgrav # trusted-keys-file: "" 531b7579f77SDag-Erling Smørgrav 532b7579f77SDag-Erling Smørgrav # Ignore chain of trust. Domain is treated as insecure. 533b7579f77SDag-Erling Smørgrav # domain-insecure: "example.com" 534b7579f77SDag-Erling Smørgrav 535b7579f77SDag-Erling Smørgrav # Override the date for validation with a specific fixed date. 536b7579f77SDag-Erling Smørgrav # Do not set this unless you are debugging signature inception 537b7579f77SDag-Erling Smørgrav # and expiration. "" or "0" turns the feature off. -1 ignores date. 538b7579f77SDag-Erling Smørgrav # val-override-date: "" 539b7579f77SDag-Erling Smørgrav 540b7579f77SDag-Erling Smørgrav # The time to live for bogus data, rrsets and messages. This avoids 541b7579f77SDag-Erling Smørgrav # some of the revalidation, until the time interval expires. in secs. 542b7579f77SDag-Erling Smørgrav # val-bogus-ttl: 60 543b7579f77SDag-Erling Smørgrav 544b7579f77SDag-Erling Smørgrav # The signature inception and expiration dates are allowed to be off 545b7579f77SDag-Erling Smørgrav # by 10% of the signature lifetime (expir-incep) from our local clock. 546b7579f77SDag-Erling Smørgrav # This leeway is capped with a minimum and a maximum. In seconds. 547b7579f77SDag-Erling Smørgrav # val-sig-skew-min: 3600 548b7579f77SDag-Erling Smørgrav # val-sig-skew-max: 86400 549b7579f77SDag-Erling Smørgrav 550b7579f77SDag-Erling Smørgrav # Should additional section of secure message also be kept clean of 551b7579f77SDag-Erling Smørgrav # unsecure data. Useful to shield the users of this validator from 552b7579f77SDag-Erling Smørgrav # potential bogus data in the additional section. All unsigned data 553b7579f77SDag-Erling Smørgrav # in the additional section is removed from secure messages. 554b7579f77SDag-Erling Smørgrav # val-clean-additional: yes 555b7579f77SDag-Erling Smørgrav 556b7579f77SDag-Erling Smørgrav # Turn permissive mode on to permit bogus messages. Thus, messages 557b7579f77SDag-Erling Smørgrav # for which security checks failed will be returned to clients, 558b7579f77SDag-Erling Smørgrav # instead of SERVFAIL. It still performs the security checks, which 559b7579f77SDag-Erling Smørgrav # result in interesting log files and possibly the AD bit in 560b7579f77SDag-Erling Smørgrav # replies if the message is found secure. The default is off. 561b7579f77SDag-Erling Smørgrav # val-permissive-mode: no 562b7579f77SDag-Erling Smørgrav 563b7579f77SDag-Erling Smørgrav # Ignore the CD flag in incoming queries and refuse them bogus data. 564b7579f77SDag-Erling Smørgrav # Enable it if the only clients of unbound are legacy servers (w2008) 565b7579f77SDag-Erling Smørgrav # that set CD but cannot validate themselves. 566b7579f77SDag-Erling Smørgrav # ignore-cd-flag: no 567b7579f77SDag-Erling Smørgrav 568091e9e46SCy Schubert # Serve expired responses from cache, with serve-expired-reply-ttl in 569091e9e46SCy Schubert # the response, and then attempt to fetch the data afresh. 570bc892140SDag-Erling Smørgrav # serve-expired: no 5714c75e3aaSDag-Erling Smørgrav # 5724c75e3aaSDag-Erling Smørgrav # Limit serving of expired responses to configured seconds after 5734c75e3aaSDag-Erling Smørgrav # expiration. 0 disables the limit. 5744c75e3aaSDag-Erling Smørgrav # serve-expired-ttl: 0 5754c75e3aaSDag-Erling Smørgrav # 5764c75e3aaSDag-Erling Smørgrav # Set the TTL of expired records to the serve-expired-ttl value after a 5774c75e3aaSDag-Erling Smørgrav # failed attempt to retrieve the record from upstream. This makes sure 5784c75e3aaSDag-Erling Smørgrav # that the expired records will be served as long as there are queries 5794c75e3aaSDag-Erling Smørgrav # for it. 5804c75e3aaSDag-Erling Smørgrav # serve-expired-ttl-reset: no 581091e9e46SCy Schubert # 582091e9e46SCy Schubert # TTL value to use when replying with expired data. 583091e9e46SCy Schubert # serve-expired-reply-ttl: 30 584091e9e46SCy Schubert # 585091e9e46SCy Schubert # Time in milliseconds before replying to the client with expired data. 586091e9e46SCy Schubert # This essentially enables the serve-stale behavior as specified in 587*c0caa2e2SCy Schubert # RFC 8767 that first tries to resolve before 588091e9e46SCy Schubert # immediately responding with expired data. 0 disables this behavior. 589091e9e46SCy Schubert # A recommended value is 1800. 590091e9e46SCy Schubert # serve-expired-client-timeout: 0 591bc892140SDag-Erling Smørgrav 592b7579f77SDag-Erling Smørgrav # Have the validator log failed validations for your diagnosis. 593b7579f77SDag-Erling Smørgrav # 0: off. 1: A line per failed user query. 2: With reason and bad IP. 594b7579f77SDag-Erling Smørgrav # val-log-level: 0 595b7579f77SDag-Erling Smørgrav 596b7579f77SDag-Erling Smørgrav # It is possible to configure NSEC3 maximum iteration counts per 597b7579f77SDag-Erling Smørgrav # keysize. Keep this table very short, as linear search is done. 598b7579f77SDag-Erling Smørgrav # A message with an NSEC3 with larger count is marked insecure. 599b7579f77SDag-Erling Smørgrav # List in ascending order the keysize and count values. 600b7579f77SDag-Erling Smørgrav # val-nsec3-keysize-iterations: "1024 150 2048 500 4096 2500" 601b7579f77SDag-Erling Smørgrav 602b7579f77SDag-Erling Smørgrav # instruct the auto-trust-anchor-file probing to add anchors after ttl. 603b7579f77SDag-Erling Smørgrav # add-holddown: 2592000 # 30 days 604b7579f77SDag-Erling Smørgrav 605b7579f77SDag-Erling Smørgrav # instruct the auto-trust-anchor-file probing to del anchors after ttl. 606b7579f77SDag-Erling Smørgrav # del-holddown: 2592000 # 30 days 607b7579f77SDag-Erling Smørgrav 608b7579f77SDag-Erling Smørgrav # auto-trust-anchor-file probing removes missing anchors after ttl. 609b7579f77SDag-Erling Smørgrav # If the value 0 is given, missing anchors are not removed. 610b7579f77SDag-Erling Smørgrav # keep-missing: 31622400 # 366 days 611b7579f77SDag-Erling Smørgrav 612e2d15004SDag-Erling Smørgrav # debug option that allows very small holddown times for key rollover, 613e2d15004SDag-Erling Smørgrav # otherwise the RFC mandates probe intervals must be at least 1 hour. 614b75612f8SDag-Erling Smørgrav # permit-small-holddown: no 615b75612f8SDag-Erling Smørgrav 616b7579f77SDag-Erling Smørgrav # the amount of memory to use for the key cache. 617b7579f77SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "4Mb". 618b7579f77SDag-Erling Smørgrav # key-cache-size: 4m 619b7579f77SDag-Erling Smørgrav 620b7579f77SDag-Erling Smørgrav # the number of slabs to use for the key cache. 621b7579f77SDag-Erling Smørgrav # the number of slabs must be a power of 2. 622b7579f77SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 623b7579f77SDag-Erling Smørgrav # key-cache-slabs: 4 624b7579f77SDag-Erling Smørgrav 625*c0caa2e2SCy Schubert # the amount of memory to use for the negative cache. 626b7579f77SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "1Mb". 627b7579f77SDag-Erling Smørgrav # neg-cache-size: 1m 628b7579f77SDag-Erling Smørgrav 62917d15b25SDag-Erling Smørgrav # By default, for a number of zones a small default 'nothing here' 63017d15b25SDag-Erling Smørgrav # reply is built-in. Query traffic is thus blocked. If you 63117d15b25SDag-Erling Smørgrav # wish to serve such zone you can unblock them by uncommenting one 63217d15b25SDag-Erling Smørgrav # of the nodefault statements below. 63317d15b25SDag-Erling Smørgrav # You may also have to use domain-insecure: zone to make DNSSEC work, 63417d15b25SDag-Erling Smørgrav # unless you have your own trust anchors for this zone. 63517d15b25SDag-Erling Smørgrav # local-zone: "localhost." nodefault 63617d15b25SDag-Erling Smørgrav # local-zone: "127.in-addr.arpa." nodefault 63717d15b25SDag-Erling Smørgrav # local-zone: "1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa." nodefault 638f61ef7f6SDag-Erling Smørgrav # local-zone: "onion." nodefault 639971980c3SDag-Erling Smørgrav # local-zone: "test." nodefault 640971980c3SDag-Erling Smørgrav # local-zone: "invalid." nodefault 64117d15b25SDag-Erling Smørgrav # local-zone: "10.in-addr.arpa." nodefault 64217d15b25SDag-Erling Smørgrav # local-zone: "16.172.in-addr.arpa." nodefault 64317d15b25SDag-Erling Smørgrav # local-zone: "17.172.in-addr.arpa." nodefault 64417d15b25SDag-Erling Smørgrav # local-zone: "18.172.in-addr.arpa." nodefault 64517d15b25SDag-Erling Smørgrav # local-zone: "19.172.in-addr.arpa." nodefault 64617d15b25SDag-Erling Smørgrav # local-zone: "20.172.in-addr.arpa." nodefault 64717d15b25SDag-Erling Smørgrav # local-zone: "21.172.in-addr.arpa." nodefault 64817d15b25SDag-Erling Smørgrav # local-zone: "22.172.in-addr.arpa." nodefault 64917d15b25SDag-Erling Smørgrav # local-zone: "23.172.in-addr.arpa." nodefault 65017d15b25SDag-Erling Smørgrav # local-zone: "24.172.in-addr.arpa." nodefault 65117d15b25SDag-Erling Smørgrav # local-zone: "25.172.in-addr.arpa." nodefault 65217d15b25SDag-Erling Smørgrav # local-zone: "26.172.in-addr.arpa." nodefault 65317d15b25SDag-Erling Smørgrav # local-zone: "27.172.in-addr.arpa." nodefault 65417d15b25SDag-Erling Smørgrav # local-zone: "28.172.in-addr.arpa." nodefault 65517d15b25SDag-Erling Smørgrav # local-zone: "29.172.in-addr.arpa." nodefault 65617d15b25SDag-Erling Smørgrav # local-zone: "30.172.in-addr.arpa." nodefault 65717d15b25SDag-Erling Smørgrav # local-zone: "31.172.in-addr.arpa." nodefault 65817d15b25SDag-Erling Smørgrav # local-zone: "168.192.in-addr.arpa." nodefault 65917d15b25SDag-Erling Smørgrav # local-zone: "0.in-addr.arpa." nodefault 66017d15b25SDag-Erling Smørgrav # local-zone: "254.169.in-addr.arpa." nodefault 66117d15b25SDag-Erling Smørgrav # local-zone: "2.0.192.in-addr.arpa." nodefault 66217d15b25SDag-Erling Smørgrav # local-zone: "100.51.198.in-addr.arpa." nodefault 66317d15b25SDag-Erling Smørgrav # local-zone: "113.0.203.in-addr.arpa." nodefault 66417d15b25SDag-Erling Smørgrav # local-zone: "255.255.255.255.in-addr.arpa." nodefault 66517d15b25SDag-Erling Smørgrav # local-zone: "0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa." nodefault 66617d15b25SDag-Erling Smørgrav # local-zone: "d.f.ip6.arpa." nodefault 66717d15b25SDag-Erling Smørgrav # local-zone: "8.e.f.ip6.arpa." nodefault 66817d15b25SDag-Erling Smørgrav # local-zone: "9.e.f.ip6.arpa." nodefault 66917d15b25SDag-Erling Smørgrav # local-zone: "a.e.f.ip6.arpa." nodefault 67017d15b25SDag-Erling Smørgrav # local-zone: "b.e.f.ip6.arpa." nodefault 67117d15b25SDag-Erling Smørgrav # local-zone: "8.b.d.0.1.0.0.2.ip6.arpa." nodefault 672ff825849SDag-Erling Smørgrav # And for 64.100.in-addr.arpa. to 127.100.in-addr.arpa. 673ff825849SDag-Erling Smørgrav 6740eefd307SCy Schubert # Add example.com into ipset 6750eefd307SCy Schubert # local-zone: "example.com" ipset 6760eefd307SCy Schubert 6770de4f1bfSDag-Erling Smørgrav # If unbound is running service for the local host then it is useful 678ff825849SDag-Erling Smørgrav # to perform lan-wide lookups to the upstream, and unblock the 679ff825849SDag-Erling Smørgrav # long list of local-zones above. If this unbound is a dns server 680ff825849SDag-Erling Smørgrav # for a network of computers, disabled is better and stops information 681ff825849SDag-Erling Smørgrav # leakage of local lan information. 682ff825849SDag-Erling Smørgrav # unblock-lan-zones: no 68317d15b25SDag-Erling Smørgrav 6840de4f1bfSDag-Erling Smørgrav # The insecure-lan-zones option disables validation for 6850de4f1bfSDag-Erling Smørgrav # these zones, as if they were all listed as domain-insecure. 6860de4f1bfSDag-Erling Smørgrav # insecure-lan-zones: no 6870de4f1bfSDag-Erling Smørgrav 688b7579f77SDag-Erling Smørgrav # a number of locally served zones can be configured. 689b7579f77SDag-Erling Smørgrav # local-zone: <zone> <type> 690b7579f77SDag-Erling Smørgrav # local-data: "<resource record string>" 691b7579f77SDag-Erling Smørgrav # o deny serves local data (if any), else, drops queries. 692b7579f77SDag-Erling Smørgrav # o refuse serves local data (if any), else, replies with error. 693b7579f77SDag-Erling Smørgrav # o static serves local data, else, nxdomain or nodata answer. 694b7579f77SDag-Erling Smørgrav # o transparent gives local data, but resolves normally for other names 695b7579f77SDag-Erling Smørgrav # o redirect serves the zone data for any subdomain in the zone. 696b7579f77SDag-Erling Smørgrav # o nodefault can be used to normally resolve AS112 zones. 697b7579f77SDag-Erling Smørgrav # o typetransparent resolves normally for other types and other names 698bc892140SDag-Erling Smørgrav # o inform acts like transparent, but logs client IP address 69909a3aaf3SDag-Erling Smørgrav # o inform_deny drops queries and logs client IP address 700e86b9096SDag-Erling Smørgrav # o inform_redirect redirects queries and logs client IP address 701b5663de9SDag-Erling Smørgrav # o always_transparent, always_refuse, always_nxdomain, resolve in 7020fb34990SDag-Erling Smørgrav # that way but ignore local data for that name 70357bddd21SDag-Erling Smørgrav # o noview breaks out of that view towards global local-zones. 704b7579f77SDag-Erling Smørgrav # 705b7579f77SDag-Erling Smørgrav # defaults are localhost address, reverse for 127.0.0.1 and ::1 706b7579f77SDag-Erling Smørgrav # and nxdomain for AS112 zones. If you configure one of these zones 707b7579f77SDag-Erling Smørgrav # the default content is omitted, or you can omit it with 'nodefault'. 708b7579f77SDag-Erling Smørgrav # 709b7579f77SDag-Erling Smørgrav # If you configure local-data without specifying local-zone, by 710b7579f77SDag-Erling Smørgrav # default a transparent local-zone is created for the data. 711b7579f77SDag-Erling Smørgrav # 712b7579f77SDag-Erling Smørgrav # You can add locally served data with 713b7579f77SDag-Erling Smørgrav # local-zone: "local." static 714b7579f77SDag-Erling Smørgrav # local-data: "mycomputer.local. IN A 192.0.2.51" 715b7579f77SDag-Erling Smørgrav # local-data: 'mytext.local TXT "content of text record"' 716b7579f77SDag-Erling Smørgrav # 717b7579f77SDag-Erling Smørgrav # You can override certain queries with 718b7579f77SDag-Erling Smørgrav # local-data: "adserver.example.com A 127.0.0.1" 719b7579f77SDag-Erling Smørgrav # 720b7579f77SDag-Erling Smørgrav # You can redirect a domain to a fixed address with 721b7579f77SDag-Erling Smørgrav # (this makes example.com, www.example.com, etc, all go to 192.0.2.3) 722b7579f77SDag-Erling Smørgrav # local-zone: "example.com" redirect 723b7579f77SDag-Erling Smørgrav # local-data: "example.com A 192.0.2.3" 724b7579f77SDag-Erling Smørgrav # 725b7579f77SDag-Erling Smørgrav # Shorthand to make PTR records, "IPv4 name" or "IPv6 name". 726b7579f77SDag-Erling Smørgrav # You can also add PTR records using local-data directly, but then 727b7579f77SDag-Erling Smørgrav # you need to do the reverse notation yourself. 728b7579f77SDag-Erling Smørgrav # local-data-ptr: "192.0.2.3 www.example.com" 729b7579f77SDag-Erling Smørgrav 730b5663de9SDag-Erling Smørgrav # tag a localzone with a list of tag names (in "" with spaces between) 731b5663de9SDag-Erling Smørgrav # local-zone-tag: "example.com" "tag2 tag3" 732b5663de9SDag-Erling Smørgrav 733b5663de9SDag-Erling Smørgrav # add a netblock specific override to a localzone, with zone type 734b5663de9SDag-Erling Smørgrav # local-zone-override: "example.com" 192.0.2.0/24 refuse 735b5663de9SDag-Erling Smørgrav 736*c0caa2e2SCy Schubert # service clients over TLS (on the TCP sockets) with plain DNS inside 737*c0caa2e2SCy Schubert # the TLS stream, and over HTTPS using HTTP/2 as specified in RFC8484. 738*c0caa2e2SCy Schubert # Give the certificate to use and private key. 739b7579f77SDag-Erling Smørgrav # default is "" (disabled). requires restart to take effect. 74057bddd21SDag-Erling Smørgrav # tls-service-key: "path/to/privatekeyfile.key" 74157bddd21SDag-Erling Smørgrav # tls-service-pem: "path/to/publiccertfile.pem" 74257bddd21SDag-Erling Smørgrav # tls-port: 853 743*c0caa2e2SCy Schubert # https-port: 443 744b7579f77SDag-Erling Smørgrav 745e86b9096SDag-Erling Smørgrav # cipher setting for TLSv1.2 746e86b9096SDag-Erling Smørgrav # tls-ciphers: "DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256" 747e86b9096SDag-Erling Smørgrav # cipher setting for TLSv1.3 748e86b9096SDag-Erling Smørgrav # tls-ciphersuites: "TLS_AES_128_GCM_SHA256:TLS_AES_128_CCM_8_SHA256:TLS_AES_128_CCM_SHA256:TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256" 749e86b9096SDag-Erling Smørgrav 75025039b37SCy Schubert # Use the SNI extension for TLS connections. Default is yes. 75125039b37SCy Schubert # Changing the value requires a reload. 75225039b37SCy Schubert # tls-use-sni: yes 75325039b37SCy Schubert 754e86b9096SDag-Erling Smørgrav # Add the secret file for TLS Session Ticket. 755e86b9096SDag-Erling Smørgrav # Secret file must be 80 bytes of random data. 756e86b9096SDag-Erling Smørgrav # First key use to encrypt and decrypt TLS session tickets. 757e86b9096SDag-Erling Smørgrav # Other keys use to decrypt only. 758e86b9096SDag-Erling Smørgrav # requires restart to take effect. 759e86b9096SDag-Erling Smørgrav # tls-session-ticket-keys: "path/to/secret_file1" 760e86b9096SDag-Erling Smørgrav # tls-session-ticket-keys: "path/to/secret_file2" 761e86b9096SDag-Erling Smørgrav 7620fb34990SDag-Erling Smørgrav # request upstream over TLS (with plain DNS inside the TLS stream). 763b7579f77SDag-Erling Smørgrav # Default is no. Can be turned on and off with unbound-control. 76457bddd21SDag-Erling Smørgrav # tls-upstream: no 76557bddd21SDag-Erling Smørgrav 76657bddd21SDag-Erling Smørgrav # Certificates used to authenticate connections made upstream. 76757bddd21SDag-Erling Smørgrav # tls-cert-bundle: "" 768b7579f77SDag-Erling Smørgrav 7693bd4df0aSDag-Erling Smørgrav # Add system certs to the cert bundle, from the Windows Cert Store 7703bd4df0aSDag-Erling Smørgrav # tls-win-cert: no 7713bd4df0aSDag-Erling Smørgrav 7720fb34990SDag-Erling Smørgrav # Also serve tls on these port numbers (eg. 443, ...), by listing 7737da0adf7SDag-Erling Smørgrav # tls-additional-port: portno for each of the port numbers. 7740fb34990SDag-Erling Smørgrav 775*c0caa2e2SCy Schubert # HTTP endpoint to provide DNS-over-HTTPS service on. 776*c0caa2e2SCy Schubert # http-endpoint: "/dns-query" 777*c0caa2e2SCy Schubert 778*c0caa2e2SCy Schubert # HTTP/2 SETTINGS_MAX_CONCURRENT_STREAMS value to use. 779*c0caa2e2SCy Schubert # http-max-streams: 100 780*c0caa2e2SCy Schubert 781*c0caa2e2SCy Schubert # Maximum number of bytes used for all HTTP/2 query buffers. 782*c0caa2e2SCy Schubert # http-query-buffer-size: 4m 783*c0caa2e2SCy Schubert 784*c0caa2e2SCy Schubert # Maximum number of bytes used for all HTTP/2 response buffers. 785*c0caa2e2SCy Schubert # http-response-buffer-size: 4m 786*c0caa2e2SCy Schubert 787*c0caa2e2SCy Schubert # Set TCP_NODELAY socket option on sockets used for DNS-over-HTTPS 788*c0caa2e2SCy Schubert # service. 789*c0caa2e2SCy Schubert # http-nodelay: yes 790*c0caa2e2SCy Schubert 791ff825849SDag-Erling Smørgrav # DNS64 prefix. Must be specified when DNS64 is use. 792ff825849SDag-Erling Smørgrav # Enable dns64 in module-config. Used to synthesize IPv6 from IPv4. 793ff825849SDag-Erling Smørgrav # dns64-prefix: 64:ff9b::0/96 794ff825849SDag-Erling Smørgrav 7954c75e3aaSDag-Erling Smørgrav # DNS64 ignore AAAA records for these domains and use A instead. 7964c75e3aaSDag-Erling Smørgrav # dns64-ignore-aaaa: "example.com" 7974c75e3aaSDag-Erling Smørgrav 79809a3aaf3SDag-Erling Smørgrav # ratelimit for uncached, new queries, this limits recursion effort. 79909a3aaf3SDag-Erling Smørgrav # ratelimiting is experimental, and may help against randomqueryflood. 80009a3aaf3SDag-Erling Smørgrav # if 0(default) it is disabled, otherwise state qps allowed per zone. 80109a3aaf3SDag-Erling Smørgrav # ratelimit: 0 80209a3aaf3SDag-Erling Smørgrav 80309a3aaf3SDag-Erling Smørgrav # ratelimits are tracked in a cache, size in bytes of cache (or k,m). 80409a3aaf3SDag-Erling Smørgrav # ratelimit-size: 4m 80509a3aaf3SDag-Erling Smørgrav # ratelimit cache slabs, reduces lock contention if equal to cpucount. 80609a3aaf3SDag-Erling Smørgrav # ratelimit-slabs: 4 80709a3aaf3SDag-Erling Smørgrav 80809a3aaf3SDag-Erling Smørgrav # 0 blocks when ratelimited, otherwise let 1/xth traffic through 80909a3aaf3SDag-Erling Smørgrav # ratelimit-factor: 10 81009a3aaf3SDag-Erling Smørgrav 81109a3aaf3SDag-Erling Smørgrav # override the ratelimit for a specific domain name. 81209a3aaf3SDag-Erling Smørgrav # give this setting multiple times to have multiple overrides. 81309a3aaf3SDag-Erling Smørgrav # ratelimit-for-domain: example.com 1000 81409a3aaf3SDag-Erling Smørgrav # override the ratelimits for all domains below a domain name 81509a3aaf3SDag-Erling Smørgrav # can give this multiple times, the name closest to the zone is used. 816b5663de9SDag-Erling Smørgrav # ratelimit-below-domain: com 1000 81709a3aaf3SDag-Erling Smørgrav 8183005e0a3SDag-Erling Smørgrav # global query ratelimit for all ip addresses. 8193005e0a3SDag-Erling Smørgrav # feature is experimental. 8203005e0a3SDag-Erling Smørgrav # if 0(default) it is disabled, otherwise states qps allowed per ip address 8213005e0a3SDag-Erling Smørgrav # ip-ratelimit: 0 8223005e0a3SDag-Erling Smørgrav 8233005e0a3SDag-Erling Smørgrav # ip ratelimits are tracked in a cache, size in bytes of cache (or k,m). 8243005e0a3SDag-Erling Smørgrav # ip-ratelimit-size: 4m 8253005e0a3SDag-Erling Smørgrav # ip ratelimit cache slabs, reduces lock contention if equal to cpucount. 8263005e0a3SDag-Erling Smørgrav # ip-ratelimit-slabs: 4 8273005e0a3SDag-Erling Smørgrav 8283005e0a3SDag-Erling Smørgrav # 0 blocks when ip is ratelimited, otherwise let 1/xth traffic through 8293005e0a3SDag-Erling Smørgrav # ip-ratelimit-factor: 10 8303005e0a3SDag-Erling Smørgrav 8314c75e3aaSDag-Erling Smørgrav # Limit the number of connections simultaneous from a netblock 8324c75e3aaSDag-Erling Smørgrav # tcp-connection-limit: 192.0.2.0/24 12 8334c75e3aaSDag-Erling Smørgrav 834e86b9096SDag-Erling Smørgrav # select from the fastest servers this many times out of 1000. 0 means 835e86b9096SDag-Erling Smørgrav # the fast server select is disabled. prefetches are not sped up. 836e86b9096SDag-Erling Smørgrav # fast-server-permil: 0 837e86b9096SDag-Erling Smørgrav # the number of servers that will be used in the fast server selection. 838e86b9096SDag-Erling Smørgrav # fast-server-num: 3 8390fb34990SDag-Erling Smørgrav 840c7f4d7adSDag-Erling Smørgrav # Specific options for ipsecmod. unbound needs to be configured with 841c7f4d7adSDag-Erling Smørgrav # --enable-ipsecmod for these to take effect. 842c7f4d7adSDag-Erling Smørgrav # 843c7f4d7adSDag-Erling Smørgrav # Enable or disable ipsecmod (it still needs to be defined in 844c7f4d7adSDag-Erling Smørgrav # module-config above). Can be used when ipsecmod needs to be 845c7f4d7adSDag-Erling Smørgrav # enabled/disabled via remote-control(below). 846c7f4d7adSDag-Erling Smørgrav # ipsecmod-enabled: yes 847c7f4d7adSDag-Erling Smørgrav # 848c7f4d7adSDag-Erling Smørgrav # Path to executable external hook. It must be defined when ipsecmod is 849c7f4d7adSDag-Erling Smørgrav # listed in module-config (above). 850c7f4d7adSDag-Erling Smørgrav # ipsecmod-hook: "./my_executable" 851c7f4d7adSDag-Erling Smørgrav # 852c7f4d7adSDag-Erling Smørgrav # When enabled unbound will reply with SERVFAIL if the return value of 853c7f4d7adSDag-Erling Smørgrav # the ipsecmod-hook is not 0. 854c7f4d7adSDag-Erling Smørgrav # ipsecmod-strict: no 855c7f4d7adSDag-Erling Smørgrav # 856c7f4d7adSDag-Erling Smørgrav # Maximum time to live (TTL) for cached A/AAAA records with IPSECKEY. 857c7f4d7adSDag-Erling Smørgrav # ipsecmod-max-ttl: 3600 858c7f4d7adSDag-Erling Smørgrav # 859c7f4d7adSDag-Erling Smørgrav # Reply with A/AAAA even if the relevant IPSECKEY is bogus. Mainly used for 860c7f4d7adSDag-Erling Smørgrav # testing. 861c7f4d7adSDag-Erling Smørgrav # ipsecmod-ignore-bogus: no 862c7f4d7adSDag-Erling Smørgrav # 863c7f4d7adSDag-Erling Smørgrav # Domains for which ipsecmod will be triggered. If not defined (default) 864*c0caa2e2SCy Schubert # all domains are treated as being allowed. 865*c0caa2e2SCy Schubert # ipsecmod-allow: "example.com" 866*c0caa2e2SCy Schubert # ipsecmod-allow: "nlnetlabs.nl" 867c7f4d7adSDag-Erling Smørgrav 8683005e0a3SDag-Erling Smørgrav 869b7579f77SDag-Erling Smørgrav# Python config section. To enable: 870b7579f77SDag-Erling Smørgrav# o use --with-pythonmodule to configure before compiling. 871b7579f77SDag-Erling Smørgrav# o list python in the module-config string (above) to enable. 872e86b9096SDag-Erling Smørgrav# It can be at the start, it gets validated results, or just before 873e86b9096SDag-Erling Smørgrav# the iterator and process before DNSSEC validation. 874b7579f77SDag-Erling Smørgrav# o and give a python-script to run. 875b7579f77SDag-Erling Smørgravpython: 876b7579f77SDag-Erling Smørgrav # Script file to load 877b7579f77SDag-Erling Smørgrav # python-script: "@UNBOUND_SHARE_DIR@/ubmodule-tst.py" 878b7579f77SDag-Erling Smørgrav 87925039b37SCy Schubert# Dynamic library config section. To enable: 88025039b37SCy Schubert# o use --with-dynlibmodule to configure before compiling. 88125039b37SCy Schubert# o list dynlib in the module-config string (above) to enable. 88225039b37SCy Schubert# It can be placed anywhere, the dynlib module is only a very thin wrapper 88325039b37SCy Schubert# to load modules dynamically. 88425039b37SCy Schubert# o and give a dynlib-file to run. If more than one dynlib entry is listed in 88525039b37SCy Schubert# the module-config then you need one dynlib-file per instance. 88625039b37SCy Schubertdynlib: 88725039b37SCy Schubert # Script file to load 88825039b37SCy Schubert # dynlib-file: "@UNBOUND_SHARE_DIR@/dynlib.so" 88925039b37SCy Schubert 890b7579f77SDag-Erling Smørgrav# Remote control config section. 891b7579f77SDag-Erling Smørgravremote-control: 892b7579f77SDag-Erling Smørgrav # Enable remote control with unbound-control(8) here. 893b7579f77SDag-Erling Smørgrav # set up the keys and certificates with unbound-control-setup. 894b7579f77SDag-Erling Smørgrav # control-enable: no 895b7579f77SDag-Erling Smørgrav 896b7579f77SDag-Erling Smørgrav # what interfaces are listened to for remote control. 897b7579f77SDag-Erling Smørgrav # give 0.0.0.0 and ::0 to listen to all interfaces. 8987da0adf7SDag-Erling Smørgrav # set to an absolute path to use a unix local name pipe, certificates 8997da0adf7SDag-Erling Smørgrav # are not used for that, so key and cert files need not be present. 900b7579f77SDag-Erling Smørgrav # control-interface: 127.0.0.1 901b7579f77SDag-Erling Smørgrav # control-interface: ::1 902b7579f77SDag-Erling Smørgrav 903b7579f77SDag-Erling Smørgrav # port number for remote control operations. 904b7579f77SDag-Erling Smørgrav # control-port: 8953 905b7579f77SDag-Erling Smørgrav 9067da0adf7SDag-Erling Smørgrav # for localhost, you can disable use of TLS by setting this to "no" 9077da0adf7SDag-Erling Smørgrav # For local sockets this option is ignored, and TLS is not used. 9087da0adf7SDag-Erling Smørgrav # control-use-cert: "yes" 9097da0adf7SDag-Erling Smørgrav 910b7579f77SDag-Erling Smørgrav # unbound server key file. 911b7579f77SDag-Erling Smørgrav # server-key-file: "@UNBOUND_RUN_DIR@/unbound_server.key" 912b7579f77SDag-Erling Smørgrav 913b7579f77SDag-Erling Smørgrav # unbound server certificate file. 914b7579f77SDag-Erling Smørgrav # server-cert-file: "@UNBOUND_RUN_DIR@/unbound_server.pem" 915b7579f77SDag-Erling Smørgrav 916b7579f77SDag-Erling Smørgrav # unbound-control key file. 917b7579f77SDag-Erling Smørgrav # control-key-file: "@UNBOUND_RUN_DIR@/unbound_control.key" 918b7579f77SDag-Erling Smørgrav 919b7579f77SDag-Erling Smørgrav # unbound-control certificate file. 920b7579f77SDag-Erling Smørgrav # control-cert-file: "@UNBOUND_RUN_DIR@/unbound_control.pem" 921b7579f77SDag-Erling Smørgrav 922b7579f77SDag-Erling Smørgrav# Stub zones. 923b7579f77SDag-Erling Smørgrav# Create entries like below, to make all queries for 'example.com' and 924b7579f77SDag-Erling Smørgrav# 'example.org' go to the given list of nameservers. list zero or more 925b7579f77SDag-Erling Smørgrav# nameservers by hostname or by ipaddress. If you set stub-prime to yes, 926b7579f77SDag-Erling Smørgrav# the list is treated as priming hints (default is no). 927b7579f77SDag-Erling Smørgrav# With stub-first yes, it attempts without the stub if it fails. 928b75612f8SDag-Erling Smørgrav# Consider adding domain-insecure: name and local-zone: name nodefault 929b75612f8SDag-Erling Smørgrav# to the server: section if the stub is a locally served zone. 930b7579f77SDag-Erling Smørgrav# stub-zone: 931b7579f77SDag-Erling Smørgrav# name: "example.com" 932b7579f77SDag-Erling Smørgrav# stub-addr: 192.0.2.68 933b7579f77SDag-Erling Smørgrav# stub-prime: no 934b7579f77SDag-Erling Smørgrav# stub-first: no 93557bddd21SDag-Erling Smørgrav# stub-tls-upstream: no 9364c75e3aaSDag-Erling Smørgrav# stub-no-cache: no 937b7579f77SDag-Erling Smørgrav# stub-zone: 938b7579f77SDag-Erling Smørgrav# name: "example.org" 939b7579f77SDag-Erling Smørgrav# stub-host: ns.example.com. 940b7579f77SDag-Erling Smørgrav 941b7579f77SDag-Erling Smørgrav# Forward zones 942b7579f77SDag-Erling Smørgrav# Create entries like below, to make all queries for 'example.com' and 943b7579f77SDag-Erling Smørgrav# 'example.org' go to the given list of servers. These servers have to handle 944b7579f77SDag-Erling Smørgrav# recursion to other nameservers. List zero or more nameservers by hostname 945b7579f77SDag-Erling Smørgrav# or by ipaddress. Use an entry with name "." to forward all queries. 946b7579f77SDag-Erling Smørgrav# If you enable forward-first, it attempts without the forward if it fails. 947b7579f77SDag-Erling Smørgrav# forward-zone: 948b7579f77SDag-Erling Smørgrav# name: "example.com" 949b7579f77SDag-Erling Smørgrav# forward-addr: 192.0.2.68 950b7579f77SDag-Erling Smørgrav# forward-addr: 192.0.2.73@5355 # forward to port 5355. 951b7579f77SDag-Erling Smørgrav# forward-first: no 95257bddd21SDag-Erling Smørgrav# forward-tls-upstream: no 9534c75e3aaSDag-Erling Smørgrav# forward-no-cache: no 954b7579f77SDag-Erling Smørgrav# forward-zone: 955b7579f77SDag-Erling Smørgrav# name: "example.org" 956b7579f77SDag-Erling Smørgrav# forward-host: fwd.example.com 957bc892140SDag-Erling Smørgrav 95857bddd21SDag-Erling Smørgrav# Authority zones 95957bddd21SDag-Erling Smørgrav# The data for these zones is kept locally, from a file or downloaded. 96057bddd21SDag-Erling Smørgrav# The data can be served to downstream clients, or used instead of the 96157bddd21SDag-Erling Smørgrav# upstream (which saves a lookup to the upstream). The first example 96257bddd21SDag-Erling Smørgrav# has a copy of the root for local usage. The second serves example.org 96357bddd21SDag-Erling Smørgrav# authoritatively. zonefile: reads from file (and writes to it if you also 964*c0caa2e2SCy Schubert# download it), primary: fetches with AXFR and IXFR, or url to zonefile. 965*c0caa2e2SCy Schubert# With allow-notify: you can give additional (apart from primaries) sources of 9660fb34990SDag-Erling Smørgrav# notifies. 96757bddd21SDag-Erling Smørgrav# auth-zone: 96857bddd21SDag-Erling Smørgrav# name: "." 969*c0caa2e2SCy Schubert# primary: 199.9.14.201 # b.root-servers.net 970*c0caa2e2SCy Schubert# primary: 192.33.4.12 # c.root-servers.net 971*c0caa2e2SCy Schubert# primary: 199.7.91.13 # d.root-servers.net 972*c0caa2e2SCy Schubert# primary: 192.5.5.241 # f.root-servers.net 973*c0caa2e2SCy Schubert# primary: 192.112.36.4 # g.root-servers.net 974*c0caa2e2SCy Schubert# primary: 193.0.14.129 # k.root-servers.net 975*c0caa2e2SCy Schubert# primary: 192.0.47.132 # xfr.cjr.dns.icann.org 976*c0caa2e2SCy Schubert# primary: 192.0.32.132 # xfr.lax.dns.icann.org 977*c0caa2e2SCy Schubert# primary: 2001:500:200::b # b.root-servers.net 978*c0caa2e2SCy Schubert# primary: 2001:500:2::c # c.root-servers.net 979*c0caa2e2SCy Schubert# primary: 2001:500:2d::d # d.root-servers.net 980*c0caa2e2SCy Schubert# primary: 2001:500:2f::f # f.root-servers.net 981*c0caa2e2SCy Schubert# primary: 2001:500:12::d0d # g.root-servers.net 982*c0caa2e2SCy Schubert# primary: 2001:7fd::1 # k.root-servers.net 983*c0caa2e2SCy Schubert# primary: 2620:0:2830:202::132 # xfr.cjr.dns.icann.org 984*c0caa2e2SCy Schubert# primary: 2620:0:2d0:202::132 # xfr.lax.dns.icann.org 985e86b9096SDag-Erling Smørgrav# fallback-enabled: yes 98657bddd21SDag-Erling Smørgrav# for-downstream: no 98757bddd21SDag-Erling Smørgrav# for-upstream: yes 98857bddd21SDag-Erling Smørgrav# auth-zone: 98957bddd21SDag-Erling Smørgrav# name: "example.org" 99057bddd21SDag-Erling Smørgrav# for-downstream: yes 99157bddd21SDag-Erling Smørgrav# for-upstream: yes 99257bddd21SDag-Erling Smørgrav# zonefile: "example.org.zone" 99357bddd21SDag-Erling Smørgrav 994bc892140SDag-Erling Smørgrav# Views 995bc892140SDag-Erling Smørgrav# Create named views. Name must be unique. Map views to requests using 996bc892140SDag-Erling Smørgrav# the access-control-view option. Views can contain zero or more local-zone 997bc892140SDag-Erling Smørgrav# and local-data options. Options from matching views will override global 998bc892140SDag-Erling Smørgrav# options. Global options will be used if no matching view is found. 999bc892140SDag-Erling Smørgrav# With view-first yes, it will try to answer using the global local-zone and 1000bc892140SDag-Erling Smørgrav# local-data elements if there is no view specific match. 1001bc892140SDag-Erling Smørgrav# view: 1002bc892140SDag-Erling Smørgrav# name: "viewname" 1003bc892140SDag-Erling Smørgrav# local-zone: "example.com" redirect 1004bc892140SDag-Erling Smørgrav# local-data: "example.com A 192.0.2.3" 100565b390aaSDag-Erling Smørgrav# local-data-ptr: "192.0.2.3 www.example.com" 1006bc892140SDag-Erling Smørgrav# view-first: no 1007bc892140SDag-Erling Smørgrav# view: 1008bc892140SDag-Erling Smørgrav# name: "anotherview" 1009bc892140SDag-Erling Smørgrav# local-zone: "example.com" refuse 101065b390aaSDag-Erling Smørgrav 101165b390aaSDag-Erling Smørgrav# DNSCrypt 101265b390aaSDag-Erling Smørgrav# Caveats: 101365b390aaSDag-Erling Smørgrav# 1. the keys/certs cannot be produced by unbound. You can use dnscrypt-wrapper 101465b390aaSDag-Erling Smørgrav# for this: https://github.com/cofyc/dnscrypt-wrapper/blob/master/README.md#usage 101565b390aaSDag-Erling Smørgrav# 2. dnscrypt channel attaches to an interface. you MUST set interfaces to 101665b390aaSDag-Erling Smørgrav# listen on `dnscrypt-port` with the follo0wing snippet: 101765b390aaSDag-Erling Smørgrav# server: 101865b390aaSDag-Erling Smørgrav# interface: 0.0.0.0@443 101965b390aaSDag-Erling Smørgrav# interface: ::0@443 102065b390aaSDag-Erling Smørgrav# 102165b390aaSDag-Erling Smørgrav# Finally, `dnscrypt` config has its own section. 102265b390aaSDag-Erling Smørgrav# dnscrypt: 102365b390aaSDag-Erling Smørgrav# dnscrypt-enable: yes 102465b390aaSDag-Erling Smørgrav# dnscrypt-port: 443 102565b390aaSDag-Erling Smørgrav# dnscrypt-provider: 2.dnscrypt-cert.example.com. 102665b390aaSDag-Erling Smørgrav# dnscrypt-secret-key: /path/unbound-conf/keys1/1.key 102765b390aaSDag-Erling Smørgrav# dnscrypt-secret-key: /path/unbound-conf/keys2/1.key 102865b390aaSDag-Erling Smørgrav# dnscrypt-provider-cert: /path/unbound-conf/keys1/1.cert 102965b390aaSDag-Erling Smørgrav# dnscrypt-provider-cert: /path/unbound-conf/keys2/1.cert 1030971980c3SDag-Erling Smørgrav 1031971980c3SDag-Erling Smørgrav# CacheDB 1032971980c3SDag-Erling Smørgrav# Enable external backend DB as auxiliary cache. Specify the backend name 1033971980c3SDag-Erling Smørgrav# (default is "testframe", which has no use other than for debugging and 1034971980c3SDag-Erling Smørgrav# testing) and backend-specific options. The 'cachedb' module must be 1035e86b9096SDag-Erling Smørgrav# included in module-config, just before the iterator module. 1036971980c3SDag-Erling Smørgrav# cachedb: 1037971980c3SDag-Erling Smørgrav# backend: "testframe" 1038971980c3SDag-Erling Smørgrav# # secret seed string to calculate hashed keys 1039971980c3SDag-Erling Smørgrav# secret-seed: "default" 10400fb34990SDag-Erling Smørgrav# 10410fb34990SDag-Erling Smørgrav# # For "redis" backend: 10420fb34990SDag-Erling Smørgrav# # redis server's IP address or host name 10430fb34990SDag-Erling Smørgrav# redis-server-host: 127.0.0.1 10440fb34990SDag-Erling Smørgrav# # redis server's TCP port 10450fb34990SDag-Erling Smørgrav# redis-server-port: 6379 10460fb34990SDag-Erling Smørgrav# # timeout (in ms) for communication with the redis server 10470fb34990SDag-Erling Smørgrav# redis-timeout: 100 104825039b37SCy Schubert# # set timeout on redis records based on DNS response TTL 104925039b37SCy Schubert# redis-expire-records: no 10500eefd307SCy Schubert 10510eefd307SCy Schubert# IPSet 10520eefd307SCy Schubert# Add specify domain into set via ipset. 105325039b37SCy Schubert# Note: To enable ipset unbound needs to run as root user. 10540eefd307SCy Schubert# ipset: 10550eefd307SCy Schubert# # set name for ip v4 addresses 10560eefd307SCy Schubert# name-v4: "list-v4" 10570eefd307SCy Schubert# # set name for ip v6 addresses 10580eefd307SCy Schubert# name-v6: "list-v6" 10590eefd307SCy Schubert# 10600eefd307SCy Schubert 106125039b37SCy Schubert# Dnstap logging support, if compiled in. To enable, set the dnstap-enable 106225039b37SCy Schubert# to yes and also some of dnstap-log-..-messages to yes. And select an 106325039b37SCy Schubert# upstream log destination, by socket path, TCP or TLS destination. 106425039b37SCy Schubert# dnstap: 106525039b37SCy Schubert# dnstap-enable: no 106625039b37SCy Schubert# # if set to yes frame streams will be used in bidirectional mode 106725039b37SCy Schubert# dnstap-bidirectional: yes 106825039b37SCy Schubert# dnstap-socket-path: "@DNSTAP_SOCKET_PATH@" 106925039b37SCy Schubert# # if "" use the unix socket in dnstap-socket-path, otherwise, 107025039b37SCy Schubert# # set it to "IPaddress[@port]" of the destination. 107125039b37SCy Schubert# dnstap-ip: "" 107225039b37SCy Schubert# # if set to yes if you want to use TLS to dnstap-ip, no for TCP. 107325039b37SCy Schubert# dnstap-tls: yes 107425039b37SCy Schubert# # name for authenticating the upstream server. or "" disabled. 107525039b37SCy Schubert# dnstap-tls-server-name: "" 107625039b37SCy Schubert# # if "", it uses the cert bundle from the main unbound config. 107725039b37SCy Schubert# dnstap-tls-cert-bundle: "" 107825039b37SCy Schubert# # key file for client authentication, or "" disabled. 107925039b37SCy Schubert# dnstap-tls-client-key-file: "" 108025039b37SCy Schubert# # cert file for client authentication, or "" disabled. 108125039b37SCy Schubert# dnstap-tls-client-cert-file: "" 108225039b37SCy Schubert# dnstap-send-identity: no 108325039b37SCy Schubert# dnstap-send-version: no 108425039b37SCy Schubert# # if "" it uses the hostname. 108525039b37SCy Schubert# dnstap-identity: "" 108625039b37SCy Schubert# # if "" it uses the package version. 108725039b37SCy Schubert# dnstap-version: "" 108825039b37SCy Schubert# dnstap-log-resolver-query-messages: no 108925039b37SCy Schubert# dnstap-log-resolver-response-messages: no 109025039b37SCy Schubert# dnstap-log-client-query-messages: no 109125039b37SCy Schubert# dnstap-log-client-response-messages: no 109225039b37SCy Schubert# dnstap-log-forwarder-query-messages: no 109325039b37SCy Schubert# dnstap-log-forwarder-response-messages: no 109425039b37SCy Schubert 1095091e9e46SCy Schubert# Response Policy Zones 1096091e9e46SCy Schubert# RPZ policies. Applied in order of configuration. QNAME and Response IP 1097091e9e46SCy Schubert# Address trigger are the only supported triggers. Supported actions are: 1098091e9e46SCy Schubert# NXDOMAIN, NODATA, PASSTHRU, DROP and Local Data. Policies can be loaded from 1099091e9e46SCy Schubert# file, using zone transfer, or using HTTP. The respip module needs to be added 1100091e9e46SCy Schubert# to the module-config, e.g.: module-config: "respip validator iterator". 1101091e9e46SCy Schubert# rpz: 1102091e9e46SCy Schubert# name: "rpz.example.com" 1103091e9e46SCy Schubert# zonefile: "rpz.example.com" 1104*c0caa2e2SCy Schubert# primary: 192.0.2.0 1105091e9e46SCy Schubert# allow-notify: 192.0.2.0/32 1106091e9e46SCy Schubert# url: http://www.example.com/rpz.example.org.zone 1107091e9e46SCy Schubert# rpz-action-override: cname 1108091e9e46SCy Schubert# rpz-cname-override: www.example.org 1109091e9e46SCy Schubert# rpz-log: yes 1110091e9e46SCy Schubert# rpz-log-name: "example policy" 1111091e9e46SCy Schubert# tags: "example" 1112