1c8094600SDag-Erling Smørgrav# 2c8094600SDag-Erling Smørgrav# Example configuration file. 3c8094600SDag-Erling Smørgrav# 4*9cf5bc93SCy Schubert# See unbound.conf(5) man page, version 1.15.0. 5c8094600SDag-Erling Smørgrav# 6c8094600SDag-Erling Smørgrav# this is a comment. 7c8094600SDag-Erling Smørgrav 80640e0c1SCy Schubert# Use this anywhere in the file to include other text into this file. 9c8094600SDag-Erling Smørgrav#include: "otherfile.conf" 10c8094600SDag-Erling Smørgrav 110640e0c1SCy Schubert# Use this anywhere in the file to include other text, that explicitly starts a 120640e0c1SCy Schubert# clause, into this file. Text after this directive needs to start a clause. 130640e0c1SCy Schubert#include-toplevel: "otherfile.conf" 140640e0c1SCy Schubert 15c8094600SDag-Erling Smørgrav# The server clause sets the main parameters. 16c8094600SDag-Erling Smørgravserver: 17c8094600SDag-Erling Smørgrav # whitespace is not necessary, but looks cleaner. 18c8094600SDag-Erling Smørgrav 19c8094600SDag-Erling Smørgrav # verbosity number, 0 is least verbose. 1 is default. 20c8094600SDag-Erling Smørgrav verbosity: 1 21c8094600SDag-Erling Smørgrav 22c8094600SDag-Erling Smørgrav # print statistics to the log (for every thread) every N seconds. 23c8094600SDag-Erling Smørgrav # Set to "" or 0 to disable. Default is disabled. 24c8094600SDag-Erling Smørgrav # statistics-interval: 0 25c8094600SDag-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 34c8094600SDag-Erling Smørgrav # enable cumulative statistics, without clearing them after printing. 35c8094600SDag-Erling Smørgrav # statistics-cumulative: no 36c8094600SDag-Erling Smørgrav 37c8094600SDag-Erling Smørgrav # enable extended statistics (query types, answer codes, status) 38c8094600SDag-Erling Smørgrav # printed from unbound-control. default off, because of speed. 39c8094600SDag-Erling Smørgrav # extended-statistics: no 40c8094600SDag-Erling Smørgrav 41c8094600SDag-Erling Smørgrav # number of threads to create. 1 disables threading. 42c8094600SDag-Erling Smørgrav # num-threads: 1 43c8094600SDag-Erling Smørgrav 44c8094600SDag-Erling Smørgrav # specify the interfaces to answer queries from by ip-address. 45c8094600SDag-Erling Smørgrav # The default is to listen to localhost (127.0.0.1 and ::1). 46c8094600SDag-Erling Smørgrav # specify 0.0.0.0 and ::0 to bind to all available interfaces. 47c8094600SDag-Erling Smørgrav # specify every interface[@port] on a new 'interface:' labelled line. 48c8094600SDag-Erling Smørgrav # The listen interfaces are not changed on reload, only on restart. 49c8094600SDag-Erling Smørgrav # interface: 192.0.2.153 50c8094600SDag-Erling Smørgrav # interface: 192.0.2.154 51c8094600SDag-Erling Smørgrav # interface: 192.0.2.154@5003 52c8094600SDag-Erling Smørgrav # interface: 2001:DB8::5 53c8094600SDag-Erling Smørgrav 54c8094600SDag-Erling Smørgrav # enable this feature to copy the source address of queries to reply. 55c8094600SDag-Erling Smørgrav # Socket options are not supported on all platforms. experimental. 56c8094600SDag-Erling Smørgrav # interface-automatic: no 57c8094600SDag-Erling Smørgrav 58c8094600SDag-Erling Smørgrav # port to answer queries from 59c8094600SDag-Erling Smørgrav # port: 53 60c8094600SDag-Erling Smørgrav 61c8094600SDag-Erling Smørgrav # specify the interfaces to send outgoing queries to authoritative 62c8094600SDag-Erling Smørgrav # server from by ip-address. If none, the default (all) interface 63c8094600SDag-Erling Smørgrav # is used. Specify every interface on a 'outgoing-interface:' line. 64c8094600SDag-Erling Smørgrav # outgoing-interface: 192.0.2.153 65c8094600SDag-Erling Smørgrav # outgoing-interface: 2001:DB8::5 66c8094600SDag-Erling Smørgrav # outgoing-interface: 2001:DB8::6 67c8094600SDag-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 770640e0c1SCy Schubert # Prefer ipv4 upstream servers, even if ipv6 is available. 780640e0c1SCy Schubert # prefer-ip4: no 790640e0c1SCy Schubert 80c8094600SDag-Erling Smørgrav # number of ports to allocate per thread, determines the size of the 81c8094600SDag-Erling Smørgrav # port range that can be open simultaneously. About double the 82c8094600SDag-Erling Smørgrav # num-queries-per-thread, or, use as many as the OS will allow you. 83c8094600SDag-Erling Smørgrav # outgoing-range: 4096 84c8094600SDag-Erling Smørgrav 85*9cf5bc93SCy Schubert # permit Unbound to use this port number or port range for 86c8094600SDag-Erling Smørgrav # making outgoing queries, using an outgoing interface. 87c8094600SDag-Erling Smørgrav # outgoing-port-permit: 32768 88c8094600SDag-Erling Smørgrav 89*9cf5bc93SCy Schubert # deny Unbound the use this of port number or port range for 90c8094600SDag-Erling Smørgrav # making outgoing queries, using an outgoing interface. 91*9cf5bc93SCy Schubert # Use this to make sure Unbound does not grab a UDP port that some 92c8094600SDag-Erling Smørgrav # other server on this computer needs. The default is to avoid 93c8094600SDag-Erling Smørgrav # IANA-assigned port numbers. 94c8094600SDag-Erling Smørgrav # If multiple outgoing-port-permit and outgoing-port-avoid options 95c8094600SDag-Erling Smørgrav # are present, they are processed in order. 96c8094600SDag-Erling Smørgrav # outgoing-port-avoid: "3200-3208" 97c8094600SDag-Erling Smørgrav 98c8094600SDag-Erling Smørgrav # number of outgoing simultaneous tcp buffers to hold per thread. 99c8094600SDag-Erling Smørgrav # outgoing-num-tcp: 10 100c8094600SDag-Erling Smørgrav 101c8094600SDag-Erling Smørgrav # number of incoming simultaneous tcp buffers to hold per thread. 102c8094600SDag-Erling Smørgrav # incoming-num-tcp: 10 103c8094600SDag-Erling Smørgrav 104c8094600SDag-Erling Smørgrav # buffer size for UDP port 53 incoming (SO_RCVBUF socket option). 105c8094600SDag-Erling Smørgrav # 0 is system default. Use 4m to catch query spikes for busy servers. 106c8094600SDag-Erling Smørgrav # so-rcvbuf: 0 107c8094600SDag-Erling Smørgrav 108c8094600SDag-Erling Smørgrav # buffer size for UDP port 53 outgoing (SO_SNDBUF socket option). 109c8094600SDag-Erling Smørgrav # 0 is system default. Use 4m to handle spikes on very busy servers. 110c8094600SDag-Erling Smørgrav # so-sndbuf: 0 111c8094600SDag-Erling Smørgrav 112c8094600SDag-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 115c8094600SDag-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 1260640e0c1SCy Schubert # the value of the Differentiated Services Codepoint (DSCP) 1270640e0c1SCy Schubert # in the differentiated services field (DS) of the outgoing 1280640e0c1SCy Schubert # IP packets 1290640e0c1SCy Schubert # ip-dscp: 0 1300640e0c1SCy Schubert 131c8094600SDag-Erling Smørgrav # EDNS reassembly buffer to advertise to UDP peers (the actual buffer 1320640e0c1SCy Schubert # is set with msg-buffer-size). 1330640e0c1SCy Schubert # edns-buffer-size: 1232 134c8094600SDag-Erling Smørgrav 135c8094600SDag-Erling Smørgrav # Maximum UDP response size (not applied to TCP response). 136c8094600SDag-Erling Smørgrav # Suggested values are 512 to 4096. Default is 4096. 65536 disables it. 137c8094600SDag-Erling Smørgrav # max-udp-size: 4096 138c8094600SDag-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 142c8094600SDag-Erling Smørgrav # buffer size for handling DNS data. No messages larger than this 143c8094600SDag-Erling Smørgrav # size can be sent or received, by UDP or TCP. In bytes. 144c8094600SDag-Erling Smørgrav # msg-buffer-size: 65552 145c8094600SDag-Erling Smørgrav 146c8094600SDag-Erling Smørgrav # the amount of memory to use for the message cache. 147c8094600SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "4Mb". 148c8094600SDag-Erling Smørgrav # msg-cache-size: 4m 149c8094600SDag-Erling Smørgrav 150c8094600SDag-Erling Smørgrav # the number of slabs to use for the message cache. 151c8094600SDag-Erling Smørgrav # the number of slabs must be a power of 2. 152c8094600SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 153c8094600SDag-Erling Smørgrav # msg-cache-slabs: 4 154c8094600SDag-Erling Smørgrav 155c8094600SDag-Erling Smørgrav # the number of queries that a thread gets to service. 156c8094600SDag-Erling Smørgrav # num-queries-per-thread: 1024 157c8094600SDag-Erling Smørgrav 158c8094600SDag-Erling Smørgrav # if very busy, 50% queries run to completion, 50% get timeout in msec 159c8094600SDag-Erling Smørgrav # jostle-timeout: 200 160c8094600SDag-Erling Smørgrav 161c8094600SDag-Erling Smørgrav # msec to wait before close of port on timeout UDP. 0 disables. 162c8094600SDag-Erling Smørgrav # delay-close: 0 163c8094600SDag-Erling Smørgrav 1640640e0c1SCy Schubert # perform connect for UDP sockets to mitigate ICMP side channel. 1650640e0c1SCy Schubert # udp-connect: yes 1660640e0c1SCy Schubert 1670640e0c1SCy Schubert # The number of retries when a non-positive response is received. 1680640e0c1SCy Schubert # outbound-msg-retry: 5 1690640e0c1SCy Schubert 170e86b9096SDag-Erling Smørgrav # msec for waiting for an unknown server to reply. Increase if you 171e86b9096SDag-Erling Smørgrav # are behind a slow satellite link, to eg. 1128. 172e86b9096SDag-Erling Smørgrav # unknown-server-time-limit: 376 173e86b9096SDag-Erling Smørgrav 174c8094600SDag-Erling Smørgrav # the amount of memory to use for the RRset cache. 175c8094600SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "4Mb". 176c8094600SDag-Erling Smørgrav # rrset-cache-size: 4m 177c8094600SDag-Erling Smørgrav 178c8094600SDag-Erling Smørgrav # the number of slabs to use for the RRset cache. 179c8094600SDag-Erling Smørgrav # the number of slabs must be a power of 2. 180c8094600SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 181c8094600SDag-Erling Smørgrav # rrset-cache-slabs: 4 182c8094600SDag-Erling Smørgrav 183c8094600SDag-Erling Smørgrav # the time to live (TTL) value lower bound, in seconds. Default 0. 184c8094600SDag-Erling Smørgrav # If more than an hour could easily give trouble due to stale data. 185c8094600SDag-Erling Smørgrav # cache-min-ttl: 0 186c8094600SDag-Erling Smørgrav 187c8094600SDag-Erling Smørgrav # the time to live (TTL) value cap for RRsets and messages in the 188c8094600SDag-Erling Smørgrav # cache. Items are not cached for longer. In seconds. 189c8094600SDag-Erling Smørgrav # cache-max-ttl: 86400 190c8094600SDag-Erling Smørgrav 19109a3aaf3SDag-Erling Smørgrav # the time to live (TTL) value cap for negative responses in the cache 19209a3aaf3SDag-Erling Smørgrav # cache-max-negative-ttl: 3600 19309a3aaf3SDag-Erling Smørgrav 194c8094600SDag-Erling Smørgrav # the time to live (TTL) value for cached roundtrip times, lameness and 195c8094600SDag-Erling Smørgrav # EDNS version information for hosts. In seconds. 196c8094600SDag-Erling Smørgrav # infra-host-ttl: 900 197c8094600SDag-Erling Smørgrav 1986480faa8SDag-Erling Smørgrav # minimum wait time for responses, increase if uplink is long. In msec. 1996480faa8SDag-Erling Smørgrav # infra-cache-min-rtt: 50 2006480faa8SDag-Erling Smørgrav 2010640e0c1SCy Schubert # enable to make server probe down hosts more frequently. 2020640e0c1SCy Schubert # infra-keep-probing: no 2030640e0c1SCy Schubert 204c8094600SDag-Erling Smørgrav # the number of slabs to use for the Infrastructure cache. 205c8094600SDag-Erling Smørgrav # the number of slabs must be a power of 2. 206c8094600SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 207c8094600SDag-Erling Smørgrav # infra-cache-slabs: 4 208c8094600SDag-Erling Smørgrav 209c8094600SDag-Erling Smørgrav # the maximum number of hosts that are cached (roundtrip, EDNS, lame). 210c8094600SDag-Erling Smørgrav # infra-cache-numhosts: 10000 211c8094600SDag-Erling Smørgrav 212b5663de9SDag-Erling Smørgrav # define a number of tags here, use with local-zone, access-control. 213b5663de9SDag-Erling Smørgrav # repeat the define-tag statement to add additional tags. 214b5663de9SDag-Erling Smørgrav # define-tag: "tag1 tag2 tag3" 215b5663de9SDag-Erling Smørgrav 216c8094600SDag-Erling Smørgrav # Enable IPv4, "yes" or "no". 217c8094600SDag-Erling Smørgrav # do-ip4: yes 218c8094600SDag-Erling Smørgrav 219c8094600SDag-Erling Smørgrav # Enable IPv6, "yes" or "no". 220c8094600SDag-Erling Smørgrav # do-ip6: yes 221c8094600SDag-Erling Smørgrav 222c8094600SDag-Erling Smørgrav # Enable UDP, "yes" or "no". 223c8094600SDag-Erling Smørgrav # do-udp: yes 224c8094600SDag-Erling Smørgrav 225c8094600SDag-Erling Smørgrav # Enable TCP, "yes" or "no". 226c8094600SDag-Erling Smørgrav # do-tcp: yes 227c8094600SDag-Erling Smørgrav 228c8094600SDag-Erling Smørgrav # upstream connections use TCP only (and no UDP), "yes" or "no" 229c8094600SDag-Erling Smørgrav # useful for tunneling scenarios, default no. 230c8094600SDag-Erling Smørgrav # tcp-upstream: no 231c8094600SDag-Erling Smørgrav 2328a384985SDag-Erling Smørgrav # upstream connections also use UDP (even if do-udp is no). 2338a384985SDag-Erling Smørgrav # useful if if you want UDP upstream, but don't provide UDP downstream. 2348a384985SDag-Erling Smørgrav # udp-upstream-without-downstream: no 2358a384985SDag-Erling Smørgrav 236f61ef7f6SDag-Erling Smørgrav # Maximum segment size (MSS) of TCP socket on which the server 237f61ef7f6SDag-Erling Smørgrav # responds to queries. Default is 0, system default MSS. 238f61ef7f6SDag-Erling Smørgrav # tcp-mss: 0 239f61ef7f6SDag-Erling Smørgrav 240f61ef7f6SDag-Erling Smørgrav # Maximum segment size (MSS) of TCP socket for outgoing queries. 241f61ef7f6SDag-Erling Smørgrav # Default is 0, system default MSS. 242f61ef7f6SDag-Erling Smørgrav # outgoing-tcp-mss: 0 243f61ef7f6SDag-Erling Smørgrav 2444c75e3aaSDag-Erling Smørgrav # Idle TCP timeout, connection closed in milliseconds 2454c75e3aaSDag-Erling Smørgrav # tcp-idle-timeout: 30000 2464c75e3aaSDag-Erling Smørgrav 2474c75e3aaSDag-Erling Smørgrav # Enable EDNS TCP keepalive option. 2484c75e3aaSDag-Erling Smørgrav # edns-tcp-keepalive: no 2494c75e3aaSDag-Erling Smørgrav 2504c75e3aaSDag-Erling Smørgrav # Timeout for EDNS TCP keepalive, in msec. 2514c75e3aaSDag-Erling Smørgrav # edns-tcp-keepalive-timeout: 120000 2524c75e3aaSDag-Erling Smørgrav 2533005e0a3SDag-Erling Smørgrav # Use systemd socket activation for UDP, TCP, and control sockets. 2543005e0a3SDag-Erling Smørgrav # use-systemd: no 2553005e0a3SDag-Erling Smørgrav 256c8094600SDag-Erling Smørgrav # Detach from the terminal, run in background, "yes" or "no". 257*9cf5bc93SCy Schubert # Set the value to "no" when Unbound runs as systemd service. 258c8094600SDag-Erling Smørgrav # do-daemonize: yes 259c8094600SDag-Erling Smørgrav 260c8094600SDag-Erling Smørgrav # control which clients are allowed to make (recursive) queries 261c8094600SDag-Erling Smørgrav # to this server. Specify classless netblocks with /size and action. 262c8094600SDag-Erling Smørgrav # By default everything is refused, except for localhost. 263c8094600SDag-Erling Smørgrav # Choose deny (drop message), refuse (polite error reply), 2643bd4df0aSDag-Erling Smørgrav # allow (recursive ok), allow_setrd (recursive ok, rd bit is forced on), 2653bd4df0aSDag-Erling Smørgrav # allow_snoop (recursive and nonrecursive ok) 266c8094600SDag-Erling Smørgrav # deny_non_local (drop queries unless can be answered from local-data) 267c8094600SDag-Erling Smørgrav # refuse_non_local (like deny_non_local but polite error reply). 268c8094600SDag-Erling Smørgrav # access-control: 0.0.0.0/0 refuse 269c8094600SDag-Erling Smørgrav # access-control: 127.0.0.0/8 allow 270c8094600SDag-Erling Smørgrav # access-control: ::0/0 refuse 271c8094600SDag-Erling Smørgrav # access-control: ::1 allow 272c8094600SDag-Erling Smørgrav # access-control: ::ffff:127.0.0.1 allow 273c8094600SDag-Erling Smørgrav 274b5663de9SDag-Erling Smørgrav # tag access-control with list of tags (in "" with spaces between) 275b5663de9SDag-Erling Smørgrav # Clients using this access control element use localzones that 276b5663de9SDag-Erling Smørgrav # are tagged with one of these tags. 277b5663de9SDag-Erling Smørgrav # access-control-tag: 192.0.2.0/24 "tag2 tag3" 278b5663de9SDag-Erling Smørgrav 279b5663de9SDag-Erling Smørgrav # set action for particular tag for given access control element 280b5663de9SDag-Erling Smørgrav # if you have multiple tag values, the tag used to lookup the action 281b5663de9SDag-Erling Smørgrav # is the first tag match between access-control-tag and local-zone-tag 282b5663de9SDag-Erling Smørgrav # where "first" comes from the order of the define-tag values. 283b5663de9SDag-Erling Smørgrav # access-control-tag-action: 192.0.2.0/24 tag3 refuse 284b5663de9SDag-Erling Smørgrav 285b5663de9SDag-Erling Smørgrav # set redirect data for particular tag for access control element 286b5663de9SDag-Erling Smørgrav # access-control-tag-data: 192.0.2.0/24 tag2 "A 127.0.0.1" 287b5663de9SDag-Erling Smørgrav 2883005e0a3SDag-Erling Smørgrav # Set view for access control element 2893005e0a3SDag-Erling Smørgrav # access-control-view: 192.0.2.0/24 viewname 2903005e0a3SDag-Erling Smørgrav 291c8094600SDag-Erling Smørgrav # if given, a chroot(2) is done to the given directory. 292c8094600SDag-Erling Smørgrav # i.e. you can chroot to the working directory, for example, 293c8094600SDag-Erling Smørgrav # for extra security, but make sure all files are in that directory. 294c8094600SDag-Erling Smørgrav # 295c8094600SDag-Erling Smørgrav # If chroot is enabled, you should pass the configfile (from the 296c8094600SDag-Erling Smørgrav # commandline) as a full path from the original root. After the 297c8094600SDag-Erling Smørgrav # chroot has been performed the now defunct portion of the config 298c8094600SDag-Erling Smørgrav # file path is removed to be able to reread the config after a reload. 299c8094600SDag-Erling Smørgrav # 300c8094600SDag-Erling Smørgrav # All other file paths (working dir, logfile, roothints, and 301c8094600SDag-Erling Smørgrav # key files) can be specified in several ways: 302c8094600SDag-Erling Smørgrav # o as an absolute path relative to the new root. 303c8094600SDag-Erling Smørgrav # o as a relative path to the working directory. 304c8094600SDag-Erling Smørgrav # o as an absolute path relative to the original root. 305c8094600SDag-Erling Smørgrav # In the last case the path is adjusted to remove the unused portion. 306c8094600SDag-Erling Smørgrav # 307c8094600SDag-Erling Smørgrav # The pid file can be absolute and outside of the chroot, it is 308c8094600SDag-Erling Smørgrav # written just prior to performing the chroot and dropping permissions. 309c8094600SDag-Erling Smørgrav # 310*9cf5bc93SCy Schubert # Additionally, Unbound may need to access /dev/urandom (for entropy). 311c8094600SDag-Erling Smørgrav # How to do this is specific to your OS. 312c8094600SDag-Erling Smørgrav # 313c8094600SDag-Erling Smørgrav # If you give "" no chroot is performed. The path must not end in a /. 3140640e0c1SCy Schubert # chroot: "@UNBOUND_CHROOT_DIR@" 315c8094600SDag-Erling Smørgrav 316c8094600SDag-Erling Smørgrav # if given, user privileges are dropped (after binding port), 317c8094600SDag-Erling Smørgrav # and the given username is assumed. Default is user "unbound". 318c8094600SDag-Erling Smørgrav # If you give "" no privileges are dropped. 3190640e0c1SCy Schubert # username: "@UNBOUND_USERNAME@" 320c8094600SDag-Erling Smørgrav 321c8094600SDag-Erling Smørgrav # the working directory. The relative files in this config are 322c8094600SDag-Erling Smørgrav # relative to this directory. If you give "" the working directory 323c8094600SDag-Erling Smørgrav # is not changed. 324b5663de9SDag-Erling Smørgrav # If you give a server: directory: dir before include: file statements 325b5663de9SDag-Erling Smørgrav # then those includes can be relative to the working directory. 3260640e0c1SCy Schubert # directory: "@UNBOUND_RUN_DIR@" 327c8094600SDag-Erling Smørgrav 328c8094600SDag-Erling Smørgrav # the log file, "" means log to stderr. 329c8094600SDag-Erling Smørgrav # Use of this option sets use-syslog to "no". 330c8094600SDag-Erling Smørgrav # logfile: "" 331c8094600SDag-Erling Smørgrav 332c8094600SDag-Erling Smørgrav # Log to syslog(3) if yes. The log facility LOG_DAEMON is used to 3333005e0a3SDag-Erling Smørgrav # log to. If yes, it overrides the logfile. 334c8094600SDag-Erling Smørgrav # use-syslog: yes 335c8094600SDag-Erling Smørgrav 3363005e0a3SDag-Erling Smørgrav # Log identity to report. if empty, defaults to the name of argv[0] 3373005e0a3SDag-Erling Smørgrav # (usually "unbound"). 3383005e0a3SDag-Erling Smørgrav # log-identity: "" 3393005e0a3SDag-Erling Smørgrav 340c8094600SDag-Erling Smørgrav # print UTC timestamp in ascii to logfile, default is epoch in seconds. 341c8094600SDag-Erling Smørgrav # log-time-ascii: no 342c8094600SDag-Erling Smørgrav 343c8094600SDag-Erling Smørgrav # print one line with time, IP, name, type, class for every query. 344c8094600SDag-Erling Smørgrav # log-queries: no 345c8094600SDag-Erling Smørgrav 3463005e0a3SDag-Erling Smørgrav # print one line per reply, with time, IP, name, type, class, rcode, 3473005e0a3SDag-Erling Smørgrav # timetoresolve, fromcache and responsesize. 3483005e0a3SDag-Erling Smørgrav # log-replies: no 3493005e0a3SDag-Erling Smørgrav 350e86b9096SDag-Erling Smørgrav # log with tag 'query' and 'reply' instead of 'info' for 351e86b9096SDag-Erling Smørgrav # filtering log-queries and log-replies from the log. 352e86b9096SDag-Erling Smørgrav # log-tag-queryreply: no 353e86b9096SDag-Erling Smørgrav 3544c75e3aaSDag-Erling Smørgrav # log the local-zone actions, like local-zone type inform is enabled 3554c75e3aaSDag-Erling Smørgrav # also for the other local zone types. 3564c75e3aaSDag-Erling Smørgrav # log-local-actions: no 3574c75e3aaSDag-Erling Smørgrav 3584c75e3aaSDag-Erling Smørgrav # print log lines that say why queries return SERVFAIL to clients. 3594c75e3aaSDag-Erling Smørgrav # log-servfail: no 3604c75e3aaSDag-Erling Smørgrav 361c8094600SDag-Erling Smørgrav # the pid file. Can be an absolute path outside of chroot/work dir. 3620640e0c1SCy Schubert # pidfile: "@UNBOUND_PIDFILE@" 363c8094600SDag-Erling Smørgrav 364c8094600SDag-Erling Smørgrav # file to read root hints from. 36505ab2901SDag-Erling Smørgrav # get one from https://www.internic.net/domain/named.cache 366c8094600SDag-Erling Smørgrav # root-hints: "" 367c8094600SDag-Erling Smørgrav 368c8094600SDag-Erling Smørgrav # enable to not answer id.server and hostname.bind queries. 369c8094600SDag-Erling Smørgrav # hide-identity: no 370c8094600SDag-Erling Smørgrav 371c8094600SDag-Erling Smørgrav # enable to not answer version.server and version.bind queries. 372c8094600SDag-Erling Smørgrav # hide-version: no 373c8094600SDag-Erling Smørgrav 37465b390aaSDag-Erling Smørgrav # enable to not answer trustanchor.unbound queries. 37565b390aaSDag-Erling Smørgrav # hide-trustanchor: no 37665b390aaSDag-Erling Smørgrav 3770640e0c1SCy Schubert # enable to not set the User-Agent HTTP header. 3780640e0c1SCy Schubert # hide-http-user-agent: no 3790640e0c1SCy Schubert 380c8094600SDag-Erling Smørgrav # the identity to report. Leave "" or default to return hostname. 381c8094600SDag-Erling Smørgrav # identity: "" 382c8094600SDag-Erling Smørgrav 383c8094600SDag-Erling Smørgrav # the version to report. Leave "" or default to return package version. 384c8094600SDag-Erling Smørgrav # version: "" 385c8094600SDag-Erling Smørgrav 3860640e0c1SCy Schubert # NSID identity (hex string, or "ascii_somestring"). default disabled. 3870640e0c1SCy Schubert # nsid: "aabbccdd" 3880640e0c1SCy Schubert 3890640e0c1SCy Schubert # User-Agent HTTP header to use. Leave "" or default to use package name 3900640e0c1SCy Schubert # and version. 3910640e0c1SCy Schubert # http-user-agent: "" 3920640e0c1SCy Schubert 393c8094600SDag-Erling Smørgrav # the target fetch policy. 394c8094600SDag-Erling Smørgrav # series of integers describing the policy per dependency depth. 395c8094600SDag-Erling Smørgrav # The number of values in the list determines the maximum dependency 396c8094600SDag-Erling Smørgrav # depth the recursor will pursue before giving up. Each integer means: 397c8094600SDag-Erling Smørgrav # -1 : fetch all targets opportunistically, 398c8094600SDag-Erling Smørgrav # 0: fetch on demand, 399c8094600SDag-Erling Smørgrav # positive value: fetch that many targets opportunistically. 400c8094600SDag-Erling Smørgrav # Enclose the list of numbers between quotes (""). 401c8094600SDag-Erling Smørgrav # target-fetch-policy: "3 2 1 0 0" 402c8094600SDag-Erling Smørgrav 403c8094600SDag-Erling Smørgrav # Harden against very small EDNS buffer sizes. 4040640e0c1SCy Schubert # harden-short-bufsize: yes 405c8094600SDag-Erling Smørgrav 406c8094600SDag-Erling Smørgrav # Harden against unseemly large queries. 407c8094600SDag-Erling Smørgrav # harden-large-queries: no 408c8094600SDag-Erling Smørgrav 409c8094600SDag-Erling Smørgrav # Harden against out of zone rrsets, to avoid spoofing attempts. 410c8094600SDag-Erling Smørgrav # harden-glue: yes 411c8094600SDag-Erling Smørgrav 412c8094600SDag-Erling Smørgrav # Harden against receiving dnssec-stripped data. If you turn it 413c8094600SDag-Erling Smørgrav # off, failing to validate dnskey data for a trustanchor will 414c8094600SDag-Erling Smørgrav # trigger insecure mode for that zone (like without a trustanchor). 415c8094600SDag-Erling Smørgrav # Default on, which insists on dnssec data for trust-anchored zones. 416c8094600SDag-Erling Smørgrav # harden-dnssec-stripped: yes 417c8094600SDag-Erling Smørgrav 418c8094600SDag-Erling Smørgrav # Harden against queries that fall under dnssec-signed nxdomain names. 4194c75e3aaSDag-Erling Smørgrav # harden-below-nxdomain: yes 420c8094600SDag-Erling Smørgrav 421c8094600SDag-Erling Smørgrav # Harden the referral path by performing additional queries for 422c8094600SDag-Erling Smørgrav # infrastructure data. Validates the replies (if possible). 423c8094600SDag-Erling Smørgrav # Default off, because the lookups burden the server. Experimental 424c8094600SDag-Erling Smørgrav # implementation of draft-wijngaards-dnsext-resolver-side-mitigation. 425c8094600SDag-Erling Smørgrav # harden-referral-path: no 426c8094600SDag-Erling Smørgrav 42709a3aaf3SDag-Erling Smørgrav # Harden against algorithm downgrade when multiple algorithms are 42809a3aaf3SDag-Erling Smørgrav # advertised in the DS record. If no, allows the weakest algorithm 42909a3aaf3SDag-Erling Smørgrav # to validate the zone. 430b75612f8SDag-Erling Smørgrav # harden-algo-downgrade: no 43109a3aaf3SDag-Erling Smørgrav 43205ab2901SDag-Erling Smørgrav # Sent minimum amount of information to upstream servers to enhance 43305ab2901SDag-Erling Smørgrav # privacy. Only sent minimum required labels of the QNAME and set QTYPE 43457bddd21SDag-Erling Smørgrav # to A when possible. 4353bd4df0aSDag-Erling Smørgrav # qname-minimisation: yes 43605ab2901SDag-Erling Smørgrav 4373005e0a3SDag-Erling Smørgrav # QNAME minimisation in strict mode. Do not fall-back to sending full 4383005e0a3SDag-Erling Smørgrav # QNAME to potentially broken nameservers. A lot of domains will not be 4393005e0a3SDag-Erling Smørgrav # resolvable when this option in enabled. 4403005e0a3SDag-Erling Smørgrav # This option only has effect when qname-minimisation is enabled. 4413005e0a3SDag-Erling Smørgrav # qname-minimisation-strict: no 4423005e0a3SDag-Erling Smørgrav 44357bddd21SDag-Erling Smørgrav # Aggressive NSEC uses the DNSSEC NSEC chain to synthesize NXDOMAIN 44457bddd21SDag-Erling Smørgrav # and other denials, using information from previous NXDOMAINs answers. 445*9cf5bc93SCy Schubert # aggressive-nsec: yes 44657bddd21SDag-Erling Smørgrav 447c8094600SDag-Erling Smørgrav # Use 0x20-encoded random bits in the query to foil spoof attempts. 448c8094600SDag-Erling Smørgrav # This feature is an experimental implementation of draft dns-0x20. 449c8094600SDag-Erling Smørgrav # use-caps-for-id: no 450c8094600SDag-Erling Smørgrav 45109a3aaf3SDag-Erling Smørgrav # Domains (and domains in them) without support for dns-0x20 and 45209a3aaf3SDag-Erling Smørgrav # the fallback fails because they keep sending different answers. 4530640e0c1SCy Schubert # caps-exempt: "licdn.com" 4540640e0c1SCy Schubert # caps-exempt: "senderbase.org" 45509a3aaf3SDag-Erling Smørgrav 456c8094600SDag-Erling Smørgrav # Enforce privacy of these addresses. Strips them away from answers. 457c8094600SDag-Erling Smørgrav # It may cause DNSSEC validation to additionally mark it as bogus. 458c8094600SDag-Erling Smørgrav # Protects against 'DNS Rebinding' (uses browser as network proxy). 459c8094600SDag-Erling Smørgrav # Only 'private-domain' and 'local-data' names are allowed to have 460c8094600SDag-Erling Smørgrav # these private addresses. No default. 461c8094600SDag-Erling Smørgrav # private-address: 10.0.0.0/8 462c8094600SDag-Erling Smørgrav # private-address: 172.16.0.0/12 463c8094600SDag-Erling Smørgrav # private-address: 192.168.0.0/16 464c8094600SDag-Erling Smørgrav # private-address: 169.254.0.0/16 465c8094600SDag-Erling Smørgrav # private-address: fd00::/8 466c8094600SDag-Erling Smørgrav # private-address: fe80::/10 46705ab2901SDag-Erling Smørgrav # private-address: ::ffff:0:0/96 468c8094600SDag-Erling Smørgrav 469c8094600SDag-Erling Smørgrav # Allow the domain (and its subdomains) to contain private addresses. 470c8094600SDag-Erling Smørgrav # local-data statements are allowed to contain private addresses too. 471c8094600SDag-Erling Smørgrav # private-domain: "example.com" 472c8094600SDag-Erling Smørgrav 473c8094600SDag-Erling Smørgrav # If nonzero, unwanted replies are not only reported in statistics, 474c8094600SDag-Erling Smørgrav # but also a running total is kept per thread. If it reaches the 475c8094600SDag-Erling Smørgrav # threshold, a warning is printed and a defensive action is taken, 476c8094600SDag-Erling Smørgrav # the cache is cleared to flush potential poison out of it. 477c8094600SDag-Erling Smørgrav # A suggested value is 10000000, the default is 0 (turned off). 478c8094600SDag-Erling Smørgrav # unwanted-reply-threshold: 0 479c8094600SDag-Erling Smørgrav 480c8094600SDag-Erling Smørgrav # Do not query the following addresses. No DNS queries are sent there. 481c8094600SDag-Erling Smørgrav # List one address per entry. List classless netblocks with /size, 482c8094600SDag-Erling Smørgrav # do-not-query-address: 127.0.0.1/8 483c8094600SDag-Erling Smørgrav # do-not-query-address: ::1 484c8094600SDag-Erling Smørgrav 485c8094600SDag-Erling Smørgrav # if yes, the above default do-not-query-address entries are present. 486c8094600SDag-Erling Smørgrav # if no, localhost can be queried (for testing and debugging). 487c8094600SDag-Erling Smørgrav # do-not-query-localhost: yes 488c8094600SDag-Erling Smørgrav 489c8094600SDag-Erling Smørgrav # if yes, perform prefetching of almost expired message cache entries. 490c8094600SDag-Erling Smørgrav # prefetch: no 491c8094600SDag-Erling Smørgrav 492c8094600SDag-Erling Smørgrav # if yes, perform key lookups adjacent to normal lookups. 493c8094600SDag-Erling Smørgrav # prefetch-key: no 494c8094600SDag-Erling Smørgrav 495e86b9096SDag-Erling Smørgrav # deny queries of type ANY with an empty response. 496e86b9096SDag-Erling Smørgrav # deny-any: no 497e86b9096SDag-Erling Smørgrav 498c8094600SDag-Erling Smørgrav # if yes, Unbound rotates RRSet order in response. 4990640e0c1SCy Schubert # rrset-roundrobin: yes 500c8094600SDag-Erling Smørgrav 501c8094600SDag-Erling Smørgrav # if yes, Unbound doesn't insert authority/additional sections 502c8094600SDag-Erling Smørgrav # into response messages when those sections are not required. 5034c75e3aaSDag-Erling Smørgrav # minimal-responses: yes 504c8094600SDag-Erling Smørgrav 505e2d15004SDag-Erling Smørgrav # true to disable DNSSEC lameness check in iterator. 506e2d15004SDag-Erling Smørgrav # disable-dnssec-lame-check: no 507e2d15004SDag-Erling Smørgrav 508c8094600SDag-Erling Smørgrav # module configuration of the server. A string with identifiers 509c8094600SDag-Erling Smørgrav # separated by spaces. Syntax: "[dns64] [validator] iterator" 510e86b9096SDag-Erling Smørgrav # most modules have to be listed at the beginning of the line, 511e86b9096SDag-Erling Smørgrav # except cachedb(just before iterator), and python (at the beginning, 512e86b9096SDag-Erling Smørgrav # or, just before the iterator). 513c8094600SDag-Erling Smørgrav # module-config: "validator iterator" 514c8094600SDag-Erling Smørgrav 515c8094600SDag-Erling Smørgrav # File with trusted keys, kept uptodate using RFC5011 probes, 516c8094600SDag-Erling Smørgrav # initial file like trust-anchor-file, then it stores metadata. 517c8094600SDag-Erling Smørgrav # Use several entries, one per domain name, to track multiple zones. 518c8094600SDag-Erling Smørgrav # 519c8094600SDag-Erling Smørgrav # If you want to perform DNSSEC validation, run unbound-anchor before 520*9cf5bc93SCy Schubert # you start Unbound (i.e. in the system boot scripts). 5210640e0c1SCy Schubert # And then enable the auto-trust-anchor-file config item. 522c8094600SDag-Erling Smørgrav # Please note usage of unbound-anchor root anchor is at your own risk 523c8094600SDag-Erling Smørgrav # and under the terms of our LICENSE (see that file in the source). 5240640e0c1SCy Schubert # auto-trust-anchor-file: "@UNBOUND_ROOTKEY_FILE@" 525c8094600SDag-Erling Smørgrav 526c7f4d7adSDag-Erling Smørgrav # trust anchor signaling sends a RFC8145 key tag query after priming. 5278a384985SDag-Erling Smørgrav # trust-anchor-signaling: yes 528c7f4d7adSDag-Erling Smørgrav 5290fb34990SDag-Erling Smørgrav # Root key trust anchor sentinel (draft-ietf-dnsop-kskroll-sentinel) 5300fb34990SDag-Erling Smørgrav # root-key-sentinel: yes 5310fb34990SDag-Erling Smørgrav 532c8094600SDag-Erling Smørgrav # File with trusted keys for validation. Specify more than one file 533c8094600SDag-Erling Smørgrav # with several entries, one file per entry. 534c8094600SDag-Erling Smørgrav # Zone file format, with DS and DNSKEY entries. 535c8094600SDag-Erling Smørgrav # Note this gets out of date, use auto-trust-anchor-file please. 536c8094600SDag-Erling Smørgrav # trust-anchor-file: "" 537c8094600SDag-Erling Smørgrav 538c8094600SDag-Erling Smørgrav # Trusted key for validation. DS or DNSKEY. specify the RR on a 539c8094600SDag-Erling Smørgrav # single line, surrounded by "". TTL is ignored. class is IN default. 540c8094600SDag-Erling Smørgrav # Note this gets out of date, use auto-trust-anchor-file please. 541c8094600SDag-Erling Smørgrav # (These examples are from August 2007 and may not be valid anymore). 542c8094600SDag-Erling Smørgrav # trust-anchor: "nlnetlabs.nl. DNSKEY 257 3 5 AQPzzTWMz8qSWIQlfRnPckx2BiVmkVN6LPupO3mbz7FhLSnm26n6iG9N Lby97Ji453aWZY3M5/xJBSOS2vWtco2t8C0+xeO1bc/d6ZTy32DHchpW 6rDH1vp86Ll+ha0tmwyy9QP7y2bVw5zSbFCrefk8qCUBgfHm9bHzMG1U BYtEIQ==" 543c8094600SDag-Erling Smørgrav # trust-anchor: "jelte.nlnetlabs.nl. DS 42860 5 1 14D739EB566D2B1A5E216A0BA4D17FA9B038BE4A" 544c8094600SDag-Erling Smørgrav 545c8094600SDag-Erling Smørgrav # File with trusted keys for validation. Specify more than one file 546c8094600SDag-Erling Smørgrav # with several entries, one file per entry. Like trust-anchor-file 547c8094600SDag-Erling Smørgrav # but has a different file format. Format is BIND-9 style format, 548c8094600SDag-Erling Smørgrav # the trusted-keys { name flag proto algo "key"; }; clauses are read. 549c8094600SDag-Erling Smørgrav # you need external update procedures to track changes in keys. 550c8094600SDag-Erling Smørgrav # trusted-keys-file: "" 551c8094600SDag-Erling Smørgrav 552c8094600SDag-Erling Smørgrav # Ignore chain of trust. Domain is treated as insecure. 553c8094600SDag-Erling Smørgrav # domain-insecure: "example.com" 554c8094600SDag-Erling Smørgrav 555c8094600SDag-Erling Smørgrav # Override the date for validation with a specific fixed date. 556c8094600SDag-Erling Smørgrav # Do not set this unless you are debugging signature inception 557c8094600SDag-Erling Smørgrav # and expiration. "" or "0" turns the feature off. -1 ignores date. 558c8094600SDag-Erling Smørgrav # val-override-date: "" 559c8094600SDag-Erling Smørgrav 560c8094600SDag-Erling Smørgrav # The time to live for bogus data, rrsets and messages. This avoids 561c8094600SDag-Erling Smørgrav # some of the revalidation, until the time interval expires. in secs. 562c8094600SDag-Erling Smørgrav # val-bogus-ttl: 60 563c8094600SDag-Erling Smørgrav 564c8094600SDag-Erling Smørgrav # The signature inception and expiration dates are allowed to be off 565c8094600SDag-Erling Smørgrav # by 10% of the signature lifetime (expir-incep) from our local clock. 566c8094600SDag-Erling Smørgrav # This leeway is capped with a minimum and a maximum. In seconds. 567c8094600SDag-Erling Smørgrav # val-sig-skew-min: 3600 568c8094600SDag-Erling Smørgrav # val-sig-skew-max: 86400 569c8094600SDag-Erling Smørgrav 5700640e0c1SCy Schubert # The maximum number the validator should restart validation with 5710640e0c1SCy Schubert # another authority in case of failed validation. 5720640e0c1SCy Schubert # val-max-restart: 5 5730640e0c1SCy Schubert 574c8094600SDag-Erling Smørgrav # Should additional section of secure message also be kept clean of 575c8094600SDag-Erling Smørgrav # unsecure data. Useful to shield the users of this validator from 576c8094600SDag-Erling Smørgrav # potential bogus data in the additional section. All unsigned data 577c8094600SDag-Erling Smørgrav # in the additional section is removed from secure messages. 578c8094600SDag-Erling Smørgrav # val-clean-additional: yes 579c8094600SDag-Erling Smørgrav 580c8094600SDag-Erling Smørgrav # Turn permissive mode on to permit bogus messages. Thus, messages 581c8094600SDag-Erling Smørgrav # for which security checks failed will be returned to clients, 582c8094600SDag-Erling Smørgrav # instead of SERVFAIL. It still performs the security checks, which 583c8094600SDag-Erling Smørgrav # result in interesting log files and possibly the AD bit in 584c8094600SDag-Erling Smørgrav # replies if the message is found secure. The default is off. 585c8094600SDag-Erling Smørgrav # val-permissive-mode: no 586c8094600SDag-Erling Smørgrav 587c8094600SDag-Erling Smørgrav # Ignore the CD flag in incoming queries and refuse them bogus data. 588*9cf5bc93SCy Schubert # Enable it if the only clients of Unbound are legacy servers (w2008) 589c8094600SDag-Erling Smørgrav # that set CD but cannot validate themselves. 590c8094600SDag-Erling Smørgrav # ignore-cd-flag: no 591c8094600SDag-Erling Smørgrav 5920640e0c1SCy Schubert # Serve expired responses from cache, with serve-expired-reply-ttl in 5930640e0c1SCy Schubert # the response, and then attempt to fetch the data afresh. 5943005e0a3SDag-Erling Smørgrav # serve-expired: no 5954c75e3aaSDag-Erling Smørgrav # 5964c75e3aaSDag-Erling Smørgrav # Limit serving of expired responses to configured seconds after 5974c75e3aaSDag-Erling Smørgrav # expiration. 0 disables the limit. 5984c75e3aaSDag-Erling Smørgrav # serve-expired-ttl: 0 5994c75e3aaSDag-Erling Smørgrav # 6004c75e3aaSDag-Erling Smørgrav # Set the TTL of expired records to the serve-expired-ttl value after a 6014c75e3aaSDag-Erling Smørgrav # failed attempt to retrieve the record from upstream. This makes sure 6024c75e3aaSDag-Erling Smørgrav # that the expired records will be served as long as there are queries 6034c75e3aaSDag-Erling Smørgrav # for it. 6044c75e3aaSDag-Erling Smørgrav # serve-expired-ttl-reset: no 6050640e0c1SCy Schubert # 6060640e0c1SCy Schubert # TTL value to use when replying with expired data. 6070640e0c1SCy Schubert # serve-expired-reply-ttl: 30 6080640e0c1SCy Schubert # 6090640e0c1SCy Schubert # Time in milliseconds before replying to the client with expired data. 6100640e0c1SCy Schubert # This essentially enables the serve-stale behavior as specified in 6110640e0c1SCy Schubert # RFC 8767 that first tries to resolve before 6120640e0c1SCy Schubert # immediately responding with expired data. 0 disables this behavior. 6130640e0c1SCy Schubert # A recommended value is 1800. 6140640e0c1SCy Schubert # serve-expired-client-timeout: 0 6150640e0c1SCy Schubert 6160640e0c1SCy Schubert # Return the original TTL as received from the upstream name server rather 6170640e0c1SCy Schubert # than the decrementing TTL as stored in the cache. Enabling this feature 618*9cf5bc93SCy Schubert # does not impact cache expiry, it only changes the TTL Unbound embeds in 6190640e0c1SCy Schubert # responses to queries. Note that enabling this feature implicitly disables 6200640e0c1SCy Schubert # enforcement of the configured minimum and maximum TTL. 6210640e0c1SCy Schubert # serve-original-ttl: no 6223005e0a3SDag-Erling Smørgrav 623c8094600SDag-Erling Smørgrav # Have the validator log failed validations for your diagnosis. 624c8094600SDag-Erling Smørgrav # 0: off. 1: A line per failed user query. 2: With reason and bad IP. 625c8094600SDag-Erling Smørgrav # val-log-level: 0 626c8094600SDag-Erling Smørgrav 627c8094600SDag-Erling Smørgrav # It is possible to configure NSEC3 maximum iteration counts per 628c8094600SDag-Erling Smørgrav # keysize. Keep this table very short, as linear search is done. 629c8094600SDag-Erling Smørgrav # A message with an NSEC3 with larger count is marked insecure. 630c8094600SDag-Erling Smørgrav # List in ascending order the keysize and count values. 6310640e0c1SCy Schubert # val-nsec3-keysize-iterations: "1024 150 2048 150 4096 150" 6320640e0c1SCy Schubert 6330640e0c1SCy Schubert # if enabled, ZONEMD verification failures do not block the zone. 6340640e0c1SCy Schubert # zonemd-permissive-mode: no 635c8094600SDag-Erling Smørgrav 636c8094600SDag-Erling Smørgrav # instruct the auto-trust-anchor-file probing to add anchors after ttl. 637c8094600SDag-Erling Smørgrav # add-holddown: 2592000 # 30 days 638c8094600SDag-Erling Smørgrav 639c8094600SDag-Erling Smørgrav # instruct the auto-trust-anchor-file probing to del anchors after ttl. 640c8094600SDag-Erling Smørgrav # del-holddown: 2592000 # 30 days 641c8094600SDag-Erling Smørgrav 642c8094600SDag-Erling Smørgrav # auto-trust-anchor-file probing removes missing anchors after ttl. 643c8094600SDag-Erling Smørgrav # If the value 0 is given, missing anchors are not removed. 644c8094600SDag-Erling Smørgrav # keep-missing: 31622400 # 366 days 645c8094600SDag-Erling Smørgrav 646e2d15004SDag-Erling Smørgrav # debug option that allows very small holddown times for key rollover, 647e2d15004SDag-Erling Smørgrav # otherwise the RFC mandates probe intervals must be at least 1 hour. 648b75612f8SDag-Erling Smørgrav # permit-small-holddown: no 649b75612f8SDag-Erling Smørgrav 650c8094600SDag-Erling Smørgrav # the amount of memory to use for the key cache. 651c8094600SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "4Mb". 652c8094600SDag-Erling Smørgrav # key-cache-size: 4m 653c8094600SDag-Erling Smørgrav 654c8094600SDag-Erling Smørgrav # the number of slabs to use for the key cache. 655c8094600SDag-Erling Smørgrav # the number of slabs must be a power of 2. 656c8094600SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 657c8094600SDag-Erling Smørgrav # key-cache-slabs: 4 658c8094600SDag-Erling Smørgrav 6590640e0c1SCy Schubert # the amount of memory to use for the negative cache. 660c8094600SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "1Mb". 661c8094600SDag-Erling Smørgrav # neg-cache-size: 1m 662c8094600SDag-Erling Smørgrav 663c8094600SDag-Erling Smørgrav # By default, for a number of zones a small default 'nothing here' 664c8094600SDag-Erling Smørgrav # reply is built-in. Query traffic is thus blocked. If you 665c8094600SDag-Erling Smørgrav # wish to serve such zone you can unblock them by uncommenting one 666c8094600SDag-Erling Smørgrav # of the nodefault statements below. 667c8094600SDag-Erling Smørgrav # You may also have to use domain-insecure: zone to make DNSSEC work, 668c8094600SDag-Erling Smørgrav # unless you have your own trust anchors for this zone. 669c8094600SDag-Erling Smørgrav # local-zone: "localhost." nodefault 670c8094600SDag-Erling Smørgrav # local-zone: "127.in-addr.arpa." nodefault 671c8094600SDag-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 6720640e0c1SCy Schubert # local-zone: "home.arpa." nodefault 673f61ef7f6SDag-Erling Smørgrav # local-zone: "onion." nodefault 674971980c3SDag-Erling Smørgrav # local-zone: "test." nodefault 675971980c3SDag-Erling Smørgrav # local-zone: "invalid." nodefault 676c8094600SDag-Erling Smørgrav # local-zone: "10.in-addr.arpa." nodefault 677c8094600SDag-Erling Smørgrav # local-zone: "16.172.in-addr.arpa." nodefault 678c8094600SDag-Erling Smørgrav # local-zone: "17.172.in-addr.arpa." nodefault 679c8094600SDag-Erling Smørgrav # local-zone: "18.172.in-addr.arpa." nodefault 680c8094600SDag-Erling Smørgrav # local-zone: "19.172.in-addr.arpa." nodefault 681c8094600SDag-Erling Smørgrav # local-zone: "20.172.in-addr.arpa." nodefault 682c8094600SDag-Erling Smørgrav # local-zone: "21.172.in-addr.arpa." nodefault 683c8094600SDag-Erling Smørgrav # local-zone: "22.172.in-addr.arpa." nodefault 684c8094600SDag-Erling Smørgrav # local-zone: "23.172.in-addr.arpa." nodefault 685c8094600SDag-Erling Smørgrav # local-zone: "24.172.in-addr.arpa." nodefault 686c8094600SDag-Erling Smørgrav # local-zone: "25.172.in-addr.arpa." nodefault 687c8094600SDag-Erling Smørgrav # local-zone: "26.172.in-addr.arpa." nodefault 688c8094600SDag-Erling Smørgrav # local-zone: "27.172.in-addr.arpa." nodefault 689c8094600SDag-Erling Smørgrav # local-zone: "28.172.in-addr.arpa." nodefault 690c8094600SDag-Erling Smørgrav # local-zone: "29.172.in-addr.arpa." nodefault 691c8094600SDag-Erling Smørgrav # local-zone: "30.172.in-addr.arpa." nodefault 692c8094600SDag-Erling Smørgrav # local-zone: "31.172.in-addr.arpa." nodefault 693c8094600SDag-Erling Smørgrav # local-zone: "168.192.in-addr.arpa." nodefault 694c8094600SDag-Erling Smørgrav # local-zone: "0.in-addr.arpa." nodefault 695c8094600SDag-Erling Smørgrav # local-zone: "254.169.in-addr.arpa." nodefault 696c8094600SDag-Erling Smørgrav # local-zone: "2.0.192.in-addr.arpa." nodefault 697c8094600SDag-Erling Smørgrav # local-zone: "100.51.198.in-addr.arpa." nodefault 698c8094600SDag-Erling Smørgrav # local-zone: "113.0.203.in-addr.arpa." nodefault 699c8094600SDag-Erling Smørgrav # local-zone: "255.255.255.255.in-addr.arpa." nodefault 700c8094600SDag-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 701c8094600SDag-Erling Smørgrav # local-zone: "d.f.ip6.arpa." nodefault 702c8094600SDag-Erling Smørgrav # local-zone: "8.e.f.ip6.arpa." nodefault 703c8094600SDag-Erling Smørgrav # local-zone: "9.e.f.ip6.arpa." nodefault 704c8094600SDag-Erling Smørgrav # local-zone: "a.e.f.ip6.arpa." nodefault 705c8094600SDag-Erling Smørgrav # local-zone: "b.e.f.ip6.arpa." nodefault 706c8094600SDag-Erling Smørgrav # local-zone: "8.b.d.0.1.0.0.2.ip6.arpa." nodefault 707c8094600SDag-Erling Smørgrav # And for 64.100.in-addr.arpa. to 127.100.in-addr.arpa. 708c8094600SDag-Erling Smørgrav 7090640e0c1SCy Schubert # Add example.com into ipset 7100640e0c1SCy Schubert # local-zone: "example.com" ipset 7110640e0c1SCy Schubert 712*9cf5bc93SCy Schubert # If Unbound is running service for the local host then it is useful 713c8094600SDag-Erling Smørgrav # to perform lan-wide lookups to the upstream, and unblock the 714*9cf5bc93SCy Schubert # long list of local-zones above. If this Unbound is a dns server 715c8094600SDag-Erling Smørgrav # for a network of computers, disabled is better and stops information 716c8094600SDag-Erling Smørgrav # leakage of local lan information. 717c8094600SDag-Erling Smørgrav # unblock-lan-zones: no 718c8094600SDag-Erling Smørgrav 7190de4f1bfSDag-Erling Smørgrav # The insecure-lan-zones option disables validation for 7200de4f1bfSDag-Erling Smørgrav # these zones, as if they were all listed as domain-insecure. 7210de4f1bfSDag-Erling Smørgrav # insecure-lan-zones: no 7220de4f1bfSDag-Erling Smørgrav 723c8094600SDag-Erling Smørgrav # a number of locally served zones can be configured. 724c8094600SDag-Erling Smørgrav # local-zone: <zone> <type> 725c8094600SDag-Erling Smørgrav # local-data: "<resource record string>" 726c8094600SDag-Erling Smørgrav # o deny serves local data (if any), else, drops queries. 727c8094600SDag-Erling Smørgrav # o refuse serves local data (if any), else, replies with error. 728c8094600SDag-Erling Smørgrav # o static serves local data, else, nxdomain or nodata answer. 729c8094600SDag-Erling Smørgrav # o transparent gives local data, but resolves normally for other names 730c8094600SDag-Erling Smørgrav # o redirect serves the zone data for any subdomain in the zone. 731c8094600SDag-Erling Smørgrav # o nodefault can be used to normally resolve AS112 zones. 732c8094600SDag-Erling Smørgrav # o typetransparent resolves normally for other types and other names 7333005e0a3SDag-Erling Smørgrav # o inform acts like transparent, but logs client IP address 73409a3aaf3SDag-Erling Smørgrav # o inform_deny drops queries and logs client IP address 735e86b9096SDag-Erling Smørgrav # o inform_redirect redirects queries and logs client IP address 7360640e0c1SCy Schubert # o always_transparent, always_refuse, always_nxdomain, always_nodata, 7370640e0c1SCy Schubert # always_deny resolve in that way but ignore local data for 7380640e0c1SCy Schubert # that name 7390640e0c1SCy Schubert # o always_null returns 0.0.0.0 or ::0 for any name in the zone. 74057bddd21SDag-Erling Smørgrav # o noview breaks out of that view towards global local-zones. 741c8094600SDag-Erling Smørgrav # 742c8094600SDag-Erling Smørgrav # defaults are localhost address, reverse for 127.0.0.1 and ::1 743c8094600SDag-Erling Smørgrav # and nxdomain for AS112 zones. If you configure one of these zones 744c8094600SDag-Erling Smørgrav # the default content is omitted, or you can omit it with 'nodefault'. 745c8094600SDag-Erling Smørgrav # 746c8094600SDag-Erling Smørgrav # If you configure local-data without specifying local-zone, by 747c8094600SDag-Erling Smørgrav # default a transparent local-zone is created for the data. 748c8094600SDag-Erling Smørgrav # 749c8094600SDag-Erling Smørgrav # You can add locally served data with 750c8094600SDag-Erling Smørgrav # local-zone: "local." static 751c8094600SDag-Erling Smørgrav # local-data: "mycomputer.local. IN A 192.0.2.51" 752c8094600SDag-Erling Smørgrav # local-data: 'mytext.local TXT "content of text record"' 753c8094600SDag-Erling Smørgrav # 754c8094600SDag-Erling Smørgrav # You can override certain queries with 755c8094600SDag-Erling Smørgrav # local-data: "adserver.example.com A 127.0.0.1" 756c8094600SDag-Erling Smørgrav # 757c8094600SDag-Erling Smørgrav # You can redirect a domain to a fixed address with 758c8094600SDag-Erling Smørgrav # (this makes example.com, www.example.com, etc, all go to 192.0.2.3) 759c8094600SDag-Erling Smørgrav # local-zone: "example.com" redirect 760c8094600SDag-Erling Smørgrav # local-data: "example.com A 192.0.2.3" 761c8094600SDag-Erling Smørgrav # 762c8094600SDag-Erling Smørgrav # Shorthand to make PTR records, "IPv4 name" or "IPv6 name". 763c8094600SDag-Erling Smørgrav # You can also add PTR records using local-data directly, but then 764c8094600SDag-Erling Smørgrav # you need to do the reverse notation yourself. 765c8094600SDag-Erling Smørgrav # local-data-ptr: "192.0.2.3 www.example.com" 766c8094600SDag-Erling Smørgrav 767b5663de9SDag-Erling Smørgrav # tag a localzone with a list of tag names (in "" with spaces between) 768b5663de9SDag-Erling Smørgrav # local-zone-tag: "example.com" "tag2 tag3" 769b5663de9SDag-Erling Smørgrav 770b5663de9SDag-Erling Smørgrav # add a netblock specific override to a localzone, with zone type 771b5663de9SDag-Erling Smørgrav # local-zone-override: "example.com" 192.0.2.0/24 refuse 772b5663de9SDag-Erling Smørgrav 7730640e0c1SCy Schubert # service clients over TLS (on the TCP sockets) with plain DNS inside 7740640e0c1SCy Schubert # the TLS stream, and over HTTPS using HTTP/2 as specified in RFC8484. 7750640e0c1SCy Schubert # Give the certificate to use and private key. 776c8094600SDag-Erling Smørgrav # default is "" (disabled). requires restart to take effect. 77757bddd21SDag-Erling Smørgrav # tls-service-key: "path/to/privatekeyfile.key" 77857bddd21SDag-Erling Smørgrav # tls-service-pem: "path/to/publiccertfile.pem" 77957bddd21SDag-Erling Smørgrav # tls-port: 853 7800640e0c1SCy Schubert # https-port: 443 781c8094600SDag-Erling Smørgrav 782e86b9096SDag-Erling Smørgrav # cipher setting for TLSv1.2 783e86b9096SDag-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" 784e86b9096SDag-Erling Smørgrav # cipher setting for TLSv1.3 785e86b9096SDag-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" 786e86b9096SDag-Erling Smørgrav 7870640e0c1SCy Schubert # Pad responses to padded queries received over TLS 7880640e0c1SCy Schubert # pad-responses: yes 7890640e0c1SCy Schubert 7900640e0c1SCy Schubert # Padded responses will be padded to the closest multiple of this size. 7910640e0c1SCy Schubert # pad-responses-block-size: 468 7920640e0c1SCy Schubert 7930640e0c1SCy Schubert # Use the SNI extension for TLS connections. Default is yes. 7940640e0c1SCy Schubert # Changing the value requires a reload. 7950640e0c1SCy Schubert # tls-use-sni: yes 7960640e0c1SCy Schubert 797e86b9096SDag-Erling Smørgrav # Add the secret file for TLS Session Ticket. 798e86b9096SDag-Erling Smørgrav # Secret file must be 80 bytes of random data. 799e86b9096SDag-Erling Smørgrav # First key use to encrypt and decrypt TLS session tickets. 800e86b9096SDag-Erling Smørgrav # Other keys use to decrypt only. 801e86b9096SDag-Erling Smørgrav # requires restart to take effect. 802e86b9096SDag-Erling Smørgrav # tls-session-ticket-keys: "path/to/secret_file1" 803e86b9096SDag-Erling Smørgrav # tls-session-ticket-keys: "path/to/secret_file2" 804e86b9096SDag-Erling Smørgrav 8050fb34990SDag-Erling Smørgrav # request upstream over TLS (with plain DNS inside the TLS stream). 806c8094600SDag-Erling Smørgrav # Default is no. Can be turned on and off with unbound-control. 80757bddd21SDag-Erling Smørgrav # tls-upstream: no 80857bddd21SDag-Erling Smørgrav 80957bddd21SDag-Erling Smørgrav # Certificates used to authenticate connections made upstream. 81057bddd21SDag-Erling Smørgrav # tls-cert-bundle: "" 811c8094600SDag-Erling Smørgrav 8123bd4df0aSDag-Erling Smørgrav # Add system certs to the cert bundle, from the Windows Cert Store 8133bd4df0aSDag-Erling Smørgrav # tls-win-cert: no 8143bd4df0aSDag-Erling Smørgrav 8150640e0c1SCy Schubert # Pad queries over TLS upstreams 8160640e0c1SCy Schubert # pad-queries: yes 8170640e0c1SCy Schubert 8180640e0c1SCy Schubert # Padded queries will be padded to the closest multiple of this size. 8190640e0c1SCy Schubert # pad-queries-block-size: 128 8200640e0c1SCy Schubert 8210fb34990SDag-Erling Smørgrav # Also serve tls on these port numbers (eg. 443, ...), by listing 8227da0adf7SDag-Erling Smørgrav # tls-additional-port: portno for each of the port numbers. 8230fb34990SDag-Erling Smørgrav 8240640e0c1SCy Schubert # HTTP endpoint to provide DNS-over-HTTPS service on. 8250640e0c1SCy Schubert # http-endpoint: "/dns-query" 8260640e0c1SCy Schubert 8270640e0c1SCy Schubert # HTTP/2 SETTINGS_MAX_CONCURRENT_STREAMS value to use. 8280640e0c1SCy Schubert # http-max-streams: 100 8290640e0c1SCy Schubert 8300640e0c1SCy Schubert # Maximum number of bytes used for all HTTP/2 query buffers. 8310640e0c1SCy Schubert # http-query-buffer-size: 4m 8320640e0c1SCy Schubert 8330640e0c1SCy Schubert # Maximum number of bytes used for all HTTP/2 response buffers. 8340640e0c1SCy Schubert # http-response-buffer-size: 4m 8350640e0c1SCy Schubert 8360640e0c1SCy Schubert # Set TCP_NODELAY socket option on sockets used for DNS-over-HTTPS 8370640e0c1SCy Schubert # service. 8380640e0c1SCy Schubert # http-nodelay: yes 8390640e0c1SCy Schubert 8400640e0c1SCy Schubert # Disable TLS for DNS-over-HTTP downstream service. 8410640e0c1SCy Schubert # http-notls-downstream: no 8420640e0c1SCy Schubert 843c8094600SDag-Erling Smørgrav # DNS64 prefix. Must be specified when DNS64 is use. 844c8094600SDag-Erling Smørgrav # Enable dns64 in module-config. Used to synthesize IPv6 from IPv4. 845c8094600SDag-Erling Smørgrav # dns64-prefix: 64:ff9b::0/96 846c8094600SDag-Erling Smørgrav 8474c75e3aaSDag-Erling Smørgrav # DNS64 ignore AAAA records for these domains and use A instead. 8484c75e3aaSDag-Erling Smørgrav # dns64-ignore-aaaa: "example.com" 8494c75e3aaSDag-Erling Smørgrav 85009a3aaf3SDag-Erling Smørgrav # ratelimit for uncached, new queries, this limits recursion effort. 85109a3aaf3SDag-Erling Smørgrav # ratelimiting is experimental, and may help against randomqueryflood. 85209a3aaf3SDag-Erling Smørgrav # if 0(default) it is disabled, otherwise state qps allowed per zone. 85309a3aaf3SDag-Erling Smørgrav # ratelimit: 0 85409a3aaf3SDag-Erling Smørgrav 85509a3aaf3SDag-Erling Smørgrav # ratelimits are tracked in a cache, size in bytes of cache (or k,m). 85609a3aaf3SDag-Erling Smørgrav # ratelimit-size: 4m 85709a3aaf3SDag-Erling Smørgrav # ratelimit cache slabs, reduces lock contention if equal to cpucount. 85809a3aaf3SDag-Erling Smørgrav # ratelimit-slabs: 4 85909a3aaf3SDag-Erling Smørgrav 86009a3aaf3SDag-Erling Smørgrav # 0 blocks when ratelimited, otherwise let 1/xth traffic through 86109a3aaf3SDag-Erling Smørgrav # ratelimit-factor: 10 86209a3aaf3SDag-Erling Smørgrav 863*9cf5bc93SCy Schubert # Aggressive rate limit when the limit is reached and until demand has 864*9cf5bc93SCy Schubert # decreased in a 2 second rate window. 865*9cf5bc93SCy Schubert # ratelimit-backoff: no 866*9cf5bc93SCy Schubert 86709a3aaf3SDag-Erling Smørgrav # override the ratelimit for a specific domain name. 86809a3aaf3SDag-Erling Smørgrav # give this setting multiple times to have multiple overrides. 86909a3aaf3SDag-Erling Smørgrav # ratelimit-for-domain: example.com 1000 87009a3aaf3SDag-Erling Smørgrav # override the ratelimits for all domains below a domain name 87109a3aaf3SDag-Erling Smørgrav # can give this multiple times, the name closest to the zone is used. 872b5663de9SDag-Erling Smørgrav # ratelimit-below-domain: com 1000 87309a3aaf3SDag-Erling Smørgrav 8743005e0a3SDag-Erling Smørgrav # global query ratelimit for all ip addresses. 8753005e0a3SDag-Erling Smørgrav # feature is experimental. 8763005e0a3SDag-Erling Smørgrav # if 0(default) it is disabled, otherwise states qps allowed per ip address 8773005e0a3SDag-Erling Smørgrav # ip-ratelimit: 0 8783005e0a3SDag-Erling Smørgrav 8793005e0a3SDag-Erling Smørgrav # ip ratelimits are tracked in a cache, size in bytes of cache (or k,m). 8803005e0a3SDag-Erling Smørgrav # ip-ratelimit-size: 4m 8813005e0a3SDag-Erling Smørgrav # ip ratelimit cache slabs, reduces lock contention if equal to cpucount. 8823005e0a3SDag-Erling Smørgrav # ip-ratelimit-slabs: 4 8833005e0a3SDag-Erling Smørgrav 8843005e0a3SDag-Erling Smørgrav # 0 blocks when ip is ratelimited, otherwise let 1/xth traffic through 8853005e0a3SDag-Erling Smørgrav # ip-ratelimit-factor: 10 8863005e0a3SDag-Erling Smørgrav 887*9cf5bc93SCy Schubert # Aggressive rate limit when the limit is reached and until demand has 888*9cf5bc93SCy Schubert # decreased in a 2 second rate window. 889*9cf5bc93SCy Schubert # ip-ratelimit-backoff: no 890*9cf5bc93SCy Schubert 8914c75e3aaSDag-Erling Smørgrav # Limit the number of connections simultaneous from a netblock 8924c75e3aaSDag-Erling Smørgrav # tcp-connection-limit: 192.0.2.0/24 12 8934c75e3aaSDag-Erling Smørgrav 894e86b9096SDag-Erling Smørgrav # select from the fastest servers this many times out of 1000. 0 means 895e86b9096SDag-Erling Smørgrav # the fast server select is disabled. prefetches are not sped up. 896e86b9096SDag-Erling Smørgrav # fast-server-permil: 0 897e86b9096SDag-Erling Smørgrav # the number of servers that will be used in the fast server selection. 898e86b9096SDag-Erling Smørgrav # fast-server-num: 3 8990fb34990SDag-Erling Smørgrav 900*9cf5bc93SCy Schubert # Specific options for ipsecmod. Unbound needs to be configured with 901c7f4d7adSDag-Erling Smørgrav # --enable-ipsecmod for these to take effect. 902c7f4d7adSDag-Erling Smørgrav # 903c7f4d7adSDag-Erling Smørgrav # Enable or disable ipsecmod (it still needs to be defined in 904c7f4d7adSDag-Erling Smørgrav # module-config above). Can be used when ipsecmod needs to be 905c7f4d7adSDag-Erling Smørgrav # enabled/disabled via remote-control(below). 906c7f4d7adSDag-Erling Smørgrav # ipsecmod-enabled: yes 907c7f4d7adSDag-Erling Smørgrav # 908c7f4d7adSDag-Erling Smørgrav # Path to executable external hook. It must be defined when ipsecmod is 909c7f4d7adSDag-Erling Smørgrav # listed in module-config (above). 910c7f4d7adSDag-Erling Smørgrav # ipsecmod-hook: "./my_executable" 911c7f4d7adSDag-Erling Smørgrav # 912*9cf5bc93SCy Schubert # When enabled Unbound will reply with SERVFAIL if the return value of 913c7f4d7adSDag-Erling Smørgrav # the ipsecmod-hook is not 0. 914c7f4d7adSDag-Erling Smørgrav # ipsecmod-strict: no 915c7f4d7adSDag-Erling Smørgrav # 916c7f4d7adSDag-Erling Smørgrav # Maximum time to live (TTL) for cached A/AAAA records with IPSECKEY. 917c7f4d7adSDag-Erling Smørgrav # ipsecmod-max-ttl: 3600 918c7f4d7adSDag-Erling Smørgrav # 919c7f4d7adSDag-Erling Smørgrav # Reply with A/AAAA even if the relevant IPSECKEY is bogus. Mainly used for 920c7f4d7adSDag-Erling Smørgrav # testing. 921c7f4d7adSDag-Erling Smørgrav # ipsecmod-ignore-bogus: no 922c7f4d7adSDag-Erling Smørgrav # 923c7f4d7adSDag-Erling Smørgrav # Domains for which ipsecmod will be triggered. If not defined (default) 9240640e0c1SCy Schubert # all domains are treated as being allowed. 9250640e0c1SCy Schubert # ipsecmod-allow: "example.com" 9260640e0c1SCy Schubert # ipsecmod-allow: "nlnetlabs.nl" 9270640e0c1SCy Schubert 9280640e0c1SCy Schubert # Timeout for REUSE entries in milliseconds. 9290640e0c1SCy Schubert # tcp-reuse-timeout: 60000 9300640e0c1SCy Schubert # Max number of queries on a reuse connection. 9310640e0c1SCy Schubert # max-reuse-tcp-queries: 200 9320640e0c1SCy Schubert # Timeout in milliseconds for TCP queries to auth servers. 9330640e0c1SCy Schubert # tcp-auth-query-timeout: 3000 934c7f4d7adSDag-Erling Smørgrav 9353005e0a3SDag-Erling Smørgrav 936c8094600SDag-Erling Smørgrav# Python config section. To enable: 937c8094600SDag-Erling Smørgrav# o use --with-pythonmodule to configure before compiling. 938c8094600SDag-Erling Smørgrav# o list python in the module-config string (above) to enable. 939e86b9096SDag-Erling Smørgrav# It can be at the start, it gets validated results, or just before 940e86b9096SDag-Erling Smørgrav# the iterator and process before DNSSEC validation. 941c8094600SDag-Erling Smørgrav# o and give a python-script to run. 942c8094600SDag-Erling Smørgravpython: 943c8094600SDag-Erling Smørgrav # Script file to load 9440640e0c1SCy Schubert # python-script: "@UNBOUND_SHARE_DIR@/ubmodule-tst.py" 9450640e0c1SCy Schubert 9460640e0c1SCy Schubert# Dynamic library config section. To enable: 9470640e0c1SCy Schubert# o use --with-dynlibmodule to configure before compiling. 9480640e0c1SCy Schubert# o list dynlib in the module-config string (above) to enable. 9490640e0c1SCy Schubert# It can be placed anywhere, the dynlib module is only a very thin wrapper 9500640e0c1SCy Schubert# to load modules dynamically. 9510640e0c1SCy Schubert# o and give a dynlib-file to run. If more than one dynlib entry is listed in 9520640e0c1SCy Schubert# the module-config then you need one dynlib-file per instance. 9530640e0c1SCy Schubertdynlib: 9540640e0c1SCy Schubert # Script file to load 9550640e0c1SCy Schubert # dynlib-file: "@UNBOUND_SHARE_DIR@/dynlib.so" 956c8094600SDag-Erling Smørgrav 957c8094600SDag-Erling Smørgrav# Remote control config section. 958c8094600SDag-Erling Smørgravremote-control: 959c8094600SDag-Erling Smørgrav # Enable remote control with unbound-control(8) here. 960c8094600SDag-Erling Smørgrav # set up the keys and certificates with unbound-control-setup. 961c8094600SDag-Erling Smørgrav # control-enable: no 962c8094600SDag-Erling Smørgrav 963c8094600SDag-Erling Smørgrav # what interfaces are listened to for remote control. 964c8094600SDag-Erling Smørgrav # give 0.0.0.0 and ::0 to listen to all interfaces. 9657da0adf7SDag-Erling Smørgrav # set to an absolute path to use a unix local name pipe, certificates 9667da0adf7SDag-Erling Smørgrav # are not used for that, so key and cert files need not be present. 967c8094600SDag-Erling Smørgrav # control-interface: 127.0.0.1 968c8094600SDag-Erling Smørgrav # control-interface: ::1 969c8094600SDag-Erling Smørgrav 970c8094600SDag-Erling Smørgrav # port number for remote control operations. 971c8094600SDag-Erling Smørgrav # control-port: 8953 972c8094600SDag-Erling Smørgrav 9737da0adf7SDag-Erling Smørgrav # for localhost, you can disable use of TLS by setting this to "no" 9747da0adf7SDag-Erling Smørgrav # For local sockets this option is ignored, and TLS is not used. 9757da0adf7SDag-Erling Smørgrav # control-use-cert: "yes" 9767da0adf7SDag-Erling Smørgrav 977*9cf5bc93SCy Schubert # Unbound server key file. 9780640e0c1SCy Schubert # server-key-file: "@UNBOUND_RUN_DIR@/unbound_server.key" 979c8094600SDag-Erling Smørgrav 980*9cf5bc93SCy Schubert # Unbound server certificate file. 9810640e0c1SCy Schubert # server-cert-file: "@UNBOUND_RUN_DIR@/unbound_server.pem" 982c8094600SDag-Erling Smørgrav 983c8094600SDag-Erling Smørgrav # unbound-control key file. 9840640e0c1SCy Schubert # control-key-file: "@UNBOUND_RUN_DIR@/unbound_control.key" 985c8094600SDag-Erling Smørgrav 986c8094600SDag-Erling Smørgrav # unbound-control certificate file. 9870640e0c1SCy Schubert # control-cert-file: "@UNBOUND_RUN_DIR@/unbound_control.pem" 988c8094600SDag-Erling Smørgrav 989c8094600SDag-Erling Smørgrav# Stub zones. 990c8094600SDag-Erling Smørgrav# Create entries like below, to make all queries for 'example.com' and 991c8094600SDag-Erling Smørgrav# 'example.org' go to the given list of nameservers. list zero or more 992c8094600SDag-Erling Smørgrav# nameservers by hostname or by ipaddress. If you set stub-prime to yes, 993c8094600SDag-Erling Smørgrav# the list is treated as priming hints (default is no). 994c8094600SDag-Erling Smørgrav# With stub-first yes, it attempts without the stub if it fails. 995b75612f8SDag-Erling Smørgrav# Consider adding domain-insecure: name and local-zone: name nodefault 996b75612f8SDag-Erling Smørgrav# to the server: section if the stub is a locally served zone. 997c8094600SDag-Erling Smørgrav# stub-zone: 998c8094600SDag-Erling Smørgrav# name: "example.com" 999c8094600SDag-Erling Smørgrav# stub-addr: 192.0.2.68 1000c8094600SDag-Erling Smørgrav# stub-prime: no 1001c8094600SDag-Erling Smørgrav# stub-first: no 10020640e0c1SCy Schubert# stub-tcp-upstream: no 100357bddd21SDag-Erling Smørgrav# stub-tls-upstream: no 10044c75e3aaSDag-Erling Smørgrav# stub-no-cache: no 1005c8094600SDag-Erling Smørgrav# stub-zone: 1006c8094600SDag-Erling Smørgrav# name: "example.org" 1007c8094600SDag-Erling Smørgrav# stub-host: ns.example.com. 1008c8094600SDag-Erling Smørgrav 1009c8094600SDag-Erling Smørgrav# Forward zones 1010c8094600SDag-Erling Smørgrav# Create entries like below, to make all queries for 'example.com' and 1011c8094600SDag-Erling Smørgrav# 'example.org' go to the given list of servers. These servers have to handle 1012c8094600SDag-Erling Smørgrav# recursion to other nameservers. List zero or more nameservers by hostname 1013c8094600SDag-Erling Smørgrav# or by ipaddress. Use an entry with name "." to forward all queries. 1014c8094600SDag-Erling Smørgrav# If you enable forward-first, it attempts without the forward if it fails. 1015c8094600SDag-Erling Smørgrav# forward-zone: 1016c8094600SDag-Erling Smørgrav# name: "example.com" 1017c8094600SDag-Erling Smørgrav# forward-addr: 192.0.2.68 1018c8094600SDag-Erling Smørgrav# forward-addr: 192.0.2.73@5355 # forward to port 5355. 1019c8094600SDag-Erling Smørgrav# forward-first: no 10200640e0c1SCy Schubert# forward-tcp-upstream: no 102157bddd21SDag-Erling Smørgrav# forward-tls-upstream: no 10224c75e3aaSDag-Erling Smørgrav# forward-no-cache: no 1023c8094600SDag-Erling Smørgrav# forward-zone: 1024c8094600SDag-Erling Smørgrav# name: "example.org" 1025c8094600SDag-Erling Smørgrav# forward-host: fwd.example.com 10263005e0a3SDag-Erling Smørgrav 102757bddd21SDag-Erling Smørgrav# Authority zones 102857bddd21SDag-Erling Smørgrav# The data for these zones is kept locally, from a file or downloaded. 102957bddd21SDag-Erling Smørgrav# The data can be served to downstream clients, or used instead of the 103057bddd21SDag-Erling Smørgrav# upstream (which saves a lookup to the upstream). The first example 103157bddd21SDag-Erling Smørgrav# has a copy of the root for local usage. The second serves example.org 103257bddd21SDag-Erling Smørgrav# authoritatively. zonefile: reads from file (and writes to it if you also 10330640e0c1SCy Schubert# download it), primary: fetches with AXFR and IXFR, or url to zonefile. 10340640e0c1SCy Schubert# With allow-notify: you can give additional (apart from primaries) sources of 10350fb34990SDag-Erling Smørgrav# notifies. 103657bddd21SDag-Erling Smørgrav# auth-zone: 103757bddd21SDag-Erling Smørgrav# name: "." 10380640e0c1SCy Schubert# primary: 199.9.14.201 # b.root-servers.net 10390640e0c1SCy Schubert# primary: 192.33.4.12 # c.root-servers.net 10400640e0c1SCy Schubert# primary: 199.7.91.13 # d.root-servers.net 10410640e0c1SCy Schubert# primary: 192.5.5.241 # f.root-servers.net 10420640e0c1SCy Schubert# primary: 192.112.36.4 # g.root-servers.net 10430640e0c1SCy Schubert# primary: 193.0.14.129 # k.root-servers.net 10440640e0c1SCy Schubert# primary: 192.0.47.132 # xfr.cjr.dns.icann.org 10450640e0c1SCy Schubert# primary: 192.0.32.132 # xfr.lax.dns.icann.org 10460640e0c1SCy Schubert# primary: 2001:500:200::b # b.root-servers.net 10470640e0c1SCy Schubert# primary: 2001:500:2::c # c.root-servers.net 10480640e0c1SCy Schubert# primary: 2001:500:2d::d # d.root-servers.net 10490640e0c1SCy Schubert# primary: 2001:500:2f::f # f.root-servers.net 10500640e0c1SCy Schubert# primary: 2001:500:12::d0d # g.root-servers.net 10510640e0c1SCy Schubert# primary: 2001:7fd::1 # k.root-servers.net 10520640e0c1SCy Schubert# primary: 2620:0:2830:202::132 # xfr.cjr.dns.icann.org 10530640e0c1SCy Schubert# primary: 2620:0:2d0:202::132 # xfr.lax.dns.icann.org 1054e86b9096SDag-Erling Smørgrav# fallback-enabled: yes 105557bddd21SDag-Erling Smørgrav# for-downstream: no 105657bddd21SDag-Erling Smørgrav# for-upstream: yes 105757bddd21SDag-Erling Smørgrav# auth-zone: 105857bddd21SDag-Erling Smørgrav# name: "example.org" 105957bddd21SDag-Erling Smørgrav# for-downstream: yes 106057bddd21SDag-Erling Smørgrav# for-upstream: yes 10610640e0c1SCy Schubert# zonemd-check: no 10620640e0c1SCy Schubert# zonemd-reject-absence: no 106357bddd21SDag-Erling Smørgrav# zonefile: "example.org.zone" 106457bddd21SDag-Erling Smørgrav 10653005e0a3SDag-Erling Smørgrav# Views 10663005e0a3SDag-Erling Smørgrav# Create named views. Name must be unique. Map views to requests using 10673005e0a3SDag-Erling Smørgrav# the access-control-view option. Views can contain zero or more local-zone 10683005e0a3SDag-Erling Smørgrav# and local-data options. Options from matching views will override global 10693005e0a3SDag-Erling Smørgrav# options. Global options will be used if no matching view is found. 10703005e0a3SDag-Erling Smørgrav# With view-first yes, it will try to answer using the global local-zone and 10713005e0a3SDag-Erling Smørgrav# local-data elements if there is no view specific match. 10723005e0a3SDag-Erling Smørgrav# view: 10733005e0a3SDag-Erling Smørgrav# name: "viewname" 10743005e0a3SDag-Erling Smørgrav# local-zone: "example.com" redirect 10753005e0a3SDag-Erling Smørgrav# local-data: "example.com A 192.0.2.3" 107665b390aaSDag-Erling Smørgrav# local-data-ptr: "192.0.2.3 www.example.com" 10773005e0a3SDag-Erling Smørgrav# view-first: no 10783005e0a3SDag-Erling Smørgrav# view: 10793005e0a3SDag-Erling Smørgrav# name: "anotherview" 10803005e0a3SDag-Erling Smørgrav# local-zone: "example.com" refuse 108165b390aaSDag-Erling Smørgrav 108265b390aaSDag-Erling Smørgrav# DNSCrypt 1083*9cf5bc93SCy Schubert# To enable, use --enable-dnscrypt to configure before compiling. 108465b390aaSDag-Erling Smørgrav# Caveats: 1085*9cf5bc93SCy Schubert# 1. the keys/certs cannot be produced by Unbound. You can use dnscrypt-wrapper 108665b390aaSDag-Erling Smørgrav# for this: https://github.com/cofyc/dnscrypt-wrapper/blob/master/README.md#usage 108765b390aaSDag-Erling Smørgrav# 2. dnscrypt channel attaches to an interface. you MUST set interfaces to 108865b390aaSDag-Erling Smørgrav# listen on `dnscrypt-port` with the follo0wing snippet: 108965b390aaSDag-Erling Smørgrav# server: 109065b390aaSDag-Erling Smørgrav# interface: 0.0.0.0@443 109165b390aaSDag-Erling Smørgrav# interface: ::0@443 109265b390aaSDag-Erling Smørgrav# 109365b390aaSDag-Erling Smørgrav# Finally, `dnscrypt` config has its own section. 109465b390aaSDag-Erling Smørgrav# dnscrypt: 109565b390aaSDag-Erling Smørgrav# dnscrypt-enable: yes 109665b390aaSDag-Erling Smørgrav# dnscrypt-port: 443 109765b390aaSDag-Erling Smørgrav# dnscrypt-provider: 2.dnscrypt-cert.example.com. 109865b390aaSDag-Erling Smørgrav# dnscrypt-secret-key: /path/unbound-conf/keys1/1.key 109965b390aaSDag-Erling Smørgrav# dnscrypt-secret-key: /path/unbound-conf/keys2/1.key 110065b390aaSDag-Erling Smørgrav# dnscrypt-provider-cert: /path/unbound-conf/keys1/1.cert 110165b390aaSDag-Erling Smørgrav# dnscrypt-provider-cert: /path/unbound-conf/keys2/1.cert 1102971980c3SDag-Erling Smørgrav 1103971980c3SDag-Erling Smørgrav# CacheDB 1104*9cf5bc93SCy Schubert# External backend DB as auxiliary cache. 1105*9cf5bc93SCy Schubert# To enable, use --enable-cachedb to configure before compiling. 1106*9cf5bc93SCy Schubert# Specify the backend name 1107971980c3SDag-Erling Smørgrav# (default is "testframe", which has no use other than for debugging and 1108971980c3SDag-Erling Smørgrav# testing) and backend-specific options. The 'cachedb' module must be 1109e86b9096SDag-Erling Smørgrav# included in module-config, just before the iterator module. 1110971980c3SDag-Erling Smørgrav# cachedb: 1111971980c3SDag-Erling Smørgrav# backend: "testframe" 1112971980c3SDag-Erling Smørgrav# # secret seed string to calculate hashed keys 1113971980c3SDag-Erling Smørgrav# secret-seed: "default" 11140fb34990SDag-Erling Smørgrav# 11150fb34990SDag-Erling Smørgrav# # For "redis" backend: 1116*9cf5bc93SCy Schubert# # (to enable, use --with-libhiredis to configure before compiling) 11170fb34990SDag-Erling Smørgrav# # redis server's IP address or host name 11180fb34990SDag-Erling Smørgrav# redis-server-host: 127.0.0.1 11190fb34990SDag-Erling Smørgrav# # redis server's TCP port 11200fb34990SDag-Erling Smørgrav# redis-server-port: 6379 11210fb34990SDag-Erling Smørgrav# # timeout (in ms) for communication with the redis server 11220fb34990SDag-Erling Smørgrav# redis-timeout: 100 11230640e0c1SCy Schubert# # set timeout on redis records based on DNS response TTL 11240640e0c1SCy Schubert# redis-expire-records: no 11250640e0c1SCy Schubert 11260640e0c1SCy Schubert# IPSet 11270640e0c1SCy Schubert# Add specify domain into set via ipset. 1128*9cf5bc93SCy Schubert# To enable: 1129*9cf5bc93SCy Schubert# o use --enable-ipset to configure before compiling; 1130*9cf5bc93SCy Schubert# o Unbound then needs to run as root user. 11310640e0c1SCy Schubert# ipset: 11320640e0c1SCy Schubert# # set name for ip v4 addresses 11330640e0c1SCy Schubert# name-v4: "list-v4" 11340640e0c1SCy Schubert# # set name for ip v6 addresses 11350640e0c1SCy Schubert# name-v6: "list-v6" 11360640e0c1SCy Schubert# 11370640e0c1SCy Schubert 1138*9cf5bc93SCy Schubert# Dnstap logging support, if compiled in by using --enable-dnstap to configure. 1139*9cf5bc93SCy Schubert# To enable, set the dnstap-enable to yes and also some of 1140*9cf5bc93SCy Schubert# dnstap-log-..-messages to yes. And select an upstream log destination, by 1141*9cf5bc93SCy Schubert# socket path, TCP or TLS destination. 11420640e0c1SCy Schubert# dnstap: 11430640e0c1SCy Schubert# dnstap-enable: no 11440640e0c1SCy Schubert# # if set to yes frame streams will be used in bidirectional mode 11450640e0c1SCy Schubert# dnstap-bidirectional: yes 11460640e0c1SCy Schubert# dnstap-socket-path: "@DNSTAP_SOCKET_PATH@" 11470640e0c1SCy Schubert# # if "" use the unix socket in dnstap-socket-path, otherwise, 11480640e0c1SCy Schubert# # set it to "IPaddress[@port]" of the destination. 11490640e0c1SCy Schubert# dnstap-ip: "" 11500640e0c1SCy Schubert# # if set to yes if you want to use TLS to dnstap-ip, no for TCP. 11510640e0c1SCy Schubert# dnstap-tls: yes 11520640e0c1SCy Schubert# # name for authenticating the upstream server. or "" disabled. 11530640e0c1SCy Schubert# dnstap-tls-server-name: "" 1154*9cf5bc93SCy Schubert# # if "", it uses the cert bundle from the main Unbound config. 11550640e0c1SCy Schubert# dnstap-tls-cert-bundle: "" 11560640e0c1SCy Schubert# # key file for client authentication, or "" disabled. 11570640e0c1SCy Schubert# dnstap-tls-client-key-file: "" 11580640e0c1SCy Schubert# # cert file for client authentication, or "" disabled. 11590640e0c1SCy Schubert# dnstap-tls-client-cert-file: "" 11600640e0c1SCy Schubert# dnstap-send-identity: no 11610640e0c1SCy Schubert# dnstap-send-version: no 11620640e0c1SCy Schubert# # if "" it uses the hostname. 11630640e0c1SCy Schubert# dnstap-identity: "" 11640640e0c1SCy Schubert# # if "" it uses the package version. 11650640e0c1SCy Schubert# dnstap-version: "" 11660640e0c1SCy Schubert# dnstap-log-resolver-query-messages: no 11670640e0c1SCy Schubert# dnstap-log-resolver-response-messages: no 11680640e0c1SCy Schubert# dnstap-log-client-query-messages: no 11690640e0c1SCy Schubert# dnstap-log-client-response-messages: no 11700640e0c1SCy Schubert# dnstap-log-forwarder-query-messages: no 11710640e0c1SCy Schubert# dnstap-log-forwarder-response-messages: no 11720640e0c1SCy Schubert 11730640e0c1SCy Schubert# Response Policy Zones 11740640e0c1SCy Schubert# RPZ policies. Applied in order of configuration. QNAME, Response IP 11750640e0c1SCy Schubert# Address, nsdname, nsip and clientip triggers are supported. Supported 11760640e0c1SCy Schubert# actions are: NXDOMAIN, NODATA, PASSTHRU, DROP, Local Data, tcp-only 11770640e0c1SCy Schubert# and drop. Policies can be loaded from a file, or using zone 11780640e0c1SCy Schubert# transfer, or using HTTP. The respip module needs to be added 11790640e0c1SCy Schubert# to the module-config, e.g.: module-config: "respip validator iterator". 11800640e0c1SCy Schubert# rpz: 11810640e0c1SCy Schubert# name: "rpz.example.com" 11820640e0c1SCy Schubert# zonefile: "rpz.example.com" 11830640e0c1SCy Schubert# primary: 192.0.2.0 11840640e0c1SCy Schubert# allow-notify: 192.0.2.0/32 11850640e0c1SCy Schubert# url: http://www.example.com/rpz.example.org.zone 11860640e0c1SCy Schubert# rpz-action-override: cname 11870640e0c1SCy Schubert# rpz-cname-override: www.example.org 11880640e0c1SCy Schubert# rpz-log: yes 11890640e0c1SCy Schubert# rpz-log-name: "example policy" 1190*9cf5bc93SCy Schubert# rpz-signal-nxdomain-ra: no 1191*9cf5bc93SCy Schubert# for-downstream: no 11920640e0c1SCy Schubert# tags: "example" 1193