1c8094600SDag-Erling Smørgrav# 2c8094600SDag-Erling Smørgrav# Example configuration file. 3c8094600SDag-Erling Smørgrav# 4*65b390aaSDag-Erling Smørgrav# See unbound.conf(5) man page, version 1.6.2. 5c8094600SDag-Erling Smørgrav# 6c8094600SDag-Erling Smørgrav# this is a comment. 7c8094600SDag-Erling Smørgrav 8c8094600SDag-Erling Smørgrav#Use this to include other text into the file. 9c8094600SDag-Erling Smørgrav#include: "otherfile.conf" 10c8094600SDag-Erling Smørgrav 11c8094600SDag-Erling Smørgrav# The server clause sets the main parameters. 12c8094600SDag-Erling Smørgravserver: 13c8094600SDag-Erling Smørgrav # whitespace is not necessary, but looks cleaner. 14c8094600SDag-Erling Smørgrav 15c8094600SDag-Erling Smørgrav # verbosity number, 0 is least verbose. 1 is default. 16c8094600SDag-Erling Smørgrav verbosity: 1 17c8094600SDag-Erling Smørgrav 18c8094600SDag-Erling Smørgrav # print statistics to the log (for every thread) every N seconds. 19c8094600SDag-Erling Smørgrav # Set to "" or 0 to disable. Default is disabled. 20c8094600SDag-Erling Smørgrav # statistics-interval: 0 21c8094600SDag-Erling Smørgrav 22*65b390aaSDag-Erling Smørgrav # enable shm for stats, default no. if you enable also enable 23*65b390aaSDag-Erling Smørgrav # statistics-interval, every time it also writes stats to the 24*65b390aaSDag-Erling Smørgrav # shared memory segment keyed with shm-key. 25*65b390aaSDag-Erling Smørgrav # shm-enable: no 26*65b390aaSDag-Erling Smørgrav 27*65b390aaSDag-Erling Smørgrav # shm for stats uses this key, and key+1 for the shared mem segment. 28*65b390aaSDag-Erling Smørgrav # shm-key: 11777 29*65b390aaSDag-Erling Smørgrav 30c8094600SDag-Erling Smørgrav # enable cumulative statistics, without clearing them after printing. 31c8094600SDag-Erling Smørgrav # statistics-cumulative: no 32c8094600SDag-Erling Smørgrav 33c8094600SDag-Erling Smørgrav # enable extended statistics (query types, answer codes, status) 34c8094600SDag-Erling Smørgrav # printed from unbound-control. default off, because of speed. 35c8094600SDag-Erling Smørgrav # extended-statistics: no 36c8094600SDag-Erling Smørgrav 37c8094600SDag-Erling Smørgrav # number of threads to create. 1 disables threading. 38c8094600SDag-Erling Smørgrav # num-threads: 1 39c8094600SDag-Erling Smørgrav 40c8094600SDag-Erling Smørgrav # specify the interfaces to answer queries from by ip-address. 41c8094600SDag-Erling Smørgrav # The default is to listen to localhost (127.0.0.1 and ::1). 42c8094600SDag-Erling Smørgrav # specify 0.0.0.0 and ::0 to bind to all available interfaces. 43c8094600SDag-Erling Smørgrav # specify every interface[@port] on a new 'interface:' labelled line. 44c8094600SDag-Erling Smørgrav # The listen interfaces are not changed on reload, only on restart. 45c8094600SDag-Erling Smørgrav # interface: 192.0.2.153 46c8094600SDag-Erling Smørgrav # interface: 192.0.2.154 47c8094600SDag-Erling Smørgrav # interface: 192.0.2.154@5003 48c8094600SDag-Erling Smørgrav # interface: 2001:DB8::5 49c8094600SDag-Erling Smørgrav 50c8094600SDag-Erling Smørgrav # enable this feature to copy the source address of queries to reply. 51c8094600SDag-Erling Smørgrav # Socket options are not supported on all platforms. experimental. 52c8094600SDag-Erling Smørgrav # interface-automatic: no 53c8094600SDag-Erling Smørgrav 54c8094600SDag-Erling Smørgrav # port to answer queries from 55c8094600SDag-Erling Smørgrav # port: 53 56c8094600SDag-Erling Smørgrav 57c8094600SDag-Erling Smørgrav # specify the interfaces to send outgoing queries to authoritative 58c8094600SDag-Erling Smørgrav # server from by ip-address. If none, the default (all) interface 59c8094600SDag-Erling Smørgrav # is used. Specify every interface on a 'outgoing-interface:' line. 60c8094600SDag-Erling Smørgrav # outgoing-interface: 192.0.2.153 61c8094600SDag-Erling Smørgrav # outgoing-interface: 2001:DB8::5 62c8094600SDag-Erling Smørgrav # outgoing-interface: 2001:DB8::6 63c8094600SDag-Erling Smørgrav 64b5663de9SDag-Erling Smørgrav # Specify a netblock to use remainder 64 bits as random bits for 65b5663de9SDag-Erling Smørgrav # upstream queries. Uses freebind option (Linux). 66b5663de9SDag-Erling Smørgrav # outgoing-interface: 2001:DB8::/64 67b5663de9SDag-Erling Smørgrav # Also (Linux:) ip -6 addr add 2001:db8::/64 dev lo 68b5663de9SDag-Erling Smørgrav # And: ip -6 route add local 2001:db8::/64 dev lo 69b5663de9SDag-Erling Smørgrav # And set prefer-ip6: yes to use the ip6 randomness from a netblock. 70b5663de9SDag-Erling Smørgrav # Set this to yes to prefer ipv6 upstream servers over ipv4. 71b5663de9SDag-Erling Smørgrav # prefer-ip6: no 72b5663de9SDag-Erling Smørgrav 73c8094600SDag-Erling Smørgrav # number of ports to allocate per thread, determines the size of the 74c8094600SDag-Erling Smørgrav # port range that can be open simultaneously. About double the 75c8094600SDag-Erling Smørgrav # num-queries-per-thread, or, use as many as the OS will allow you. 76c8094600SDag-Erling Smørgrav # outgoing-range: 4096 77c8094600SDag-Erling Smørgrav 78c8094600SDag-Erling Smørgrav # permit unbound to use this port number or port range for 79c8094600SDag-Erling Smørgrav # making outgoing queries, using an outgoing interface. 80c8094600SDag-Erling Smørgrav # outgoing-port-permit: 32768 81c8094600SDag-Erling Smørgrav 82c8094600SDag-Erling Smørgrav # deny unbound the use this of port number or port range for 83c8094600SDag-Erling Smørgrav # making outgoing queries, using an outgoing interface. 84c8094600SDag-Erling Smørgrav # Use this to make sure unbound does not grab a UDP port that some 85c8094600SDag-Erling Smørgrav # other server on this computer needs. The default is to avoid 86c8094600SDag-Erling Smørgrav # IANA-assigned port numbers. 87c8094600SDag-Erling Smørgrav # If multiple outgoing-port-permit and outgoing-port-avoid options 88c8094600SDag-Erling Smørgrav # are present, they are processed in order. 89c8094600SDag-Erling Smørgrav # outgoing-port-avoid: "3200-3208" 90c8094600SDag-Erling Smørgrav 91c8094600SDag-Erling Smørgrav # number of outgoing simultaneous tcp buffers to hold per thread. 92c8094600SDag-Erling Smørgrav # outgoing-num-tcp: 10 93c8094600SDag-Erling Smørgrav 94c8094600SDag-Erling Smørgrav # number of incoming simultaneous tcp buffers to hold per thread. 95c8094600SDag-Erling Smørgrav # incoming-num-tcp: 10 96c8094600SDag-Erling Smørgrav 97c8094600SDag-Erling Smørgrav # buffer size for UDP port 53 incoming (SO_RCVBUF socket option). 98c8094600SDag-Erling Smørgrav # 0 is system default. Use 4m to catch query spikes for busy servers. 99c8094600SDag-Erling Smørgrav # so-rcvbuf: 0 100c8094600SDag-Erling Smørgrav 101c8094600SDag-Erling Smørgrav # buffer size for UDP port 53 outgoing (SO_SNDBUF socket option). 102c8094600SDag-Erling Smørgrav # 0 is system default. Use 4m to handle spikes on very busy servers. 103c8094600SDag-Erling Smørgrav # so-sndbuf: 0 104c8094600SDag-Erling Smørgrav 105c8094600SDag-Erling Smørgrav # use SO_REUSEPORT to distribute queries over threads. 106c8094600SDag-Erling Smørgrav # so-reuseport: no 107c8094600SDag-Erling Smørgrav 10809a3aaf3SDag-Erling Smørgrav # use IP_TRANSPARENT so the interface: addresses can be non-local 10909a3aaf3SDag-Erling Smørgrav # and you can config non-existing IPs that are going to work later on 110f61ef7f6SDag-Erling Smørgrav # (uses IP_BINDANY on FreeBSD). 11109a3aaf3SDag-Erling Smørgrav # ip-transparent: no 11209a3aaf3SDag-Erling Smørgrav 113e2d15004SDag-Erling Smørgrav # use IP_FREEBIND so the interface: addresses can be non-local 114e2d15004SDag-Erling Smørgrav # and you can bind to nonexisting IPs and interfaces that are down. 115e2d15004SDag-Erling Smørgrav # Linux only. On Linux you also have ip-transparent that is similar. 116e2d15004SDag-Erling Smørgrav # ip-freebind: no 117e2d15004SDag-Erling Smørgrav 118c8094600SDag-Erling Smørgrav # EDNS reassembly buffer to advertise to UDP peers (the actual buffer 119c8094600SDag-Erling Smørgrav # is set with msg-buffer-size). 1480 can solve fragmentation (timeouts). 120c8094600SDag-Erling Smørgrav # edns-buffer-size: 4096 121c8094600SDag-Erling Smørgrav 122c8094600SDag-Erling Smørgrav # Maximum UDP response size (not applied to TCP response). 123c8094600SDag-Erling Smørgrav # Suggested values are 512 to 4096. Default is 4096. 65536 disables it. 124c8094600SDag-Erling Smørgrav # max-udp-size: 4096 125c8094600SDag-Erling Smørgrav 126c8094600SDag-Erling Smørgrav # buffer size for handling DNS data. No messages larger than this 127c8094600SDag-Erling Smørgrav # size can be sent or received, by UDP or TCP. In bytes. 128c8094600SDag-Erling Smørgrav # msg-buffer-size: 65552 129c8094600SDag-Erling Smørgrav 130c8094600SDag-Erling Smørgrav # the amount of memory to use for the message cache. 131c8094600SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "4Mb". 132c8094600SDag-Erling Smørgrav # msg-cache-size: 4m 133c8094600SDag-Erling Smørgrav 134c8094600SDag-Erling Smørgrav # the number of slabs to use for the message cache. 135c8094600SDag-Erling Smørgrav # the number of slabs must be a power of 2. 136c8094600SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 137c8094600SDag-Erling Smørgrav # msg-cache-slabs: 4 138c8094600SDag-Erling Smørgrav 139c8094600SDag-Erling Smørgrav # the number of queries that a thread gets to service. 140c8094600SDag-Erling Smørgrav # num-queries-per-thread: 1024 141c8094600SDag-Erling Smørgrav 142c8094600SDag-Erling Smørgrav # if very busy, 50% queries run to completion, 50% get timeout in msec 143c8094600SDag-Erling Smørgrav # jostle-timeout: 200 144c8094600SDag-Erling Smørgrav 145c8094600SDag-Erling Smørgrav # msec to wait before close of port on timeout UDP. 0 disables. 146c8094600SDag-Erling Smørgrav # delay-close: 0 147c8094600SDag-Erling Smørgrav 148c8094600SDag-Erling Smørgrav # the amount of memory to use for the RRset cache. 149c8094600SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "4Mb". 150c8094600SDag-Erling Smørgrav # rrset-cache-size: 4m 151c8094600SDag-Erling Smørgrav 152c8094600SDag-Erling Smørgrav # the number of slabs to use for the RRset cache. 153c8094600SDag-Erling Smørgrav # the number of slabs must be a power of 2. 154c8094600SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 155c8094600SDag-Erling Smørgrav # rrset-cache-slabs: 4 156c8094600SDag-Erling Smørgrav 157c8094600SDag-Erling Smørgrav # the time to live (TTL) value lower bound, in seconds. Default 0. 158c8094600SDag-Erling Smørgrav # If more than an hour could easily give trouble due to stale data. 159c8094600SDag-Erling Smørgrav # cache-min-ttl: 0 160c8094600SDag-Erling Smørgrav 161c8094600SDag-Erling Smørgrav # the time to live (TTL) value cap for RRsets and messages in the 162c8094600SDag-Erling Smørgrav # cache. Items are not cached for longer. In seconds. 163c8094600SDag-Erling Smørgrav # cache-max-ttl: 86400 164c8094600SDag-Erling Smørgrav 16509a3aaf3SDag-Erling Smørgrav # the time to live (TTL) value cap for negative responses in the cache 16609a3aaf3SDag-Erling Smørgrav # cache-max-negative-ttl: 3600 16709a3aaf3SDag-Erling Smørgrav 168c8094600SDag-Erling Smørgrav # the time to live (TTL) value for cached roundtrip times, lameness and 169c8094600SDag-Erling Smørgrav # EDNS version information for hosts. In seconds. 170c8094600SDag-Erling Smørgrav # infra-host-ttl: 900 171c8094600SDag-Erling Smørgrav 1726480faa8SDag-Erling Smørgrav # minimum wait time for responses, increase if uplink is long. In msec. 1736480faa8SDag-Erling Smørgrav # infra-cache-min-rtt: 50 1746480faa8SDag-Erling Smørgrav 175c8094600SDag-Erling Smørgrav # the number of slabs to use for the Infrastructure cache. 176c8094600SDag-Erling Smørgrav # the number of slabs must be a power of 2. 177c8094600SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 178c8094600SDag-Erling Smørgrav # infra-cache-slabs: 4 179c8094600SDag-Erling Smørgrav 180c8094600SDag-Erling Smørgrav # the maximum number of hosts that are cached (roundtrip, EDNS, lame). 181c8094600SDag-Erling Smørgrav # infra-cache-numhosts: 10000 182c8094600SDag-Erling Smørgrav 183b5663de9SDag-Erling Smørgrav # define a number of tags here, use with local-zone, access-control. 184b5663de9SDag-Erling Smørgrav # repeat the define-tag statement to add additional tags. 185b5663de9SDag-Erling Smørgrav # define-tag: "tag1 tag2 tag3" 186b5663de9SDag-Erling Smørgrav 187c8094600SDag-Erling Smørgrav # Enable IPv4, "yes" or "no". 188c8094600SDag-Erling Smørgrav # do-ip4: yes 189c8094600SDag-Erling Smørgrav 190c8094600SDag-Erling Smørgrav # Enable IPv6, "yes" or "no". 191c8094600SDag-Erling Smørgrav # do-ip6: yes 192c8094600SDag-Erling Smørgrav 193c8094600SDag-Erling Smørgrav # Enable UDP, "yes" or "no". 194c8094600SDag-Erling Smørgrav # do-udp: yes 195c8094600SDag-Erling Smørgrav 196c8094600SDag-Erling Smørgrav # Enable TCP, "yes" or "no". 197c8094600SDag-Erling Smørgrav # do-tcp: yes 198c8094600SDag-Erling Smørgrav 199c8094600SDag-Erling Smørgrav # upstream connections use TCP only (and no UDP), "yes" or "no" 200c8094600SDag-Erling Smørgrav # useful for tunneling scenarios, default no. 201c8094600SDag-Erling Smørgrav # tcp-upstream: no 202c8094600SDag-Erling Smørgrav 203f61ef7f6SDag-Erling Smørgrav # Maximum segment size (MSS) of TCP socket on which the server 204f61ef7f6SDag-Erling Smørgrav # responds to queries. Default is 0, system default MSS. 205f61ef7f6SDag-Erling Smørgrav # tcp-mss: 0 206f61ef7f6SDag-Erling Smørgrav 207f61ef7f6SDag-Erling Smørgrav # Maximum segment size (MSS) of TCP socket for outgoing queries. 208f61ef7f6SDag-Erling Smørgrav # Default is 0, system default MSS. 209f61ef7f6SDag-Erling Smørgrav # outgoing-tcp-mss: 0 210f61ef7f6SDag-Erling Smørgrav 2113005e0a3SDag-Erling Smørgrav # Use systemd socket activation for UDP, TCP, and control sockets. 2123005e0a3SDag-Erling Smørgrav # use-systemd: no 2133005e0a3SDag-Erling Smørgrav 214c8094600SDag-Erling Smørgrav # Detach from the terminal, run in background, "yes" or "no". 2153005e0a3SDag-Erling Smørgrav # Set the value to "no" when unbound runs as systemd service. 216c8094600SDag-Erling Smørgrav # do-daemonize: yes 217c8094600SDag-Erling Smørgrav 218c8094600SDag-Erling Smørgrav # control which clients are allowed to make (recursive) queries 219c8094600SDag-Erling Smørgrav # to this server. Specify classless netblocks with /size and action. 220c8094600SDag-Erling Smørgrav # By default everything is refused, except for localhost. 221c8094600SDag-Erling Smørgrav # Choose deny (drop message), refuse (polite error reply), 222c8094600SDag-Erling Smørgrav # allow (recursive ok), allow_snoop (recursive and nonrecursive ok) 223c8094600SDag-Erling Smørgrav # deny_non_local (drop queries unless can be answered from local-data) 224c8094600SDag-Erling Smørgrav # refuse_non_local (like deny_non_local but polite error reply). 225c8094600SDag-Erling Smørgrav # access-control: 0.0.0.0/0 refuse 226c8094600SDag-Erling Smørgrav # access-control: 127.0.0.0/8 allow 227c8094600SDag-Erling Smørgrav # access-control: ::0/0 refuse 228c8094600SDag-Erling Smørgrav # access-control: ::1 allow 229c8094600SDag-Erling Smørgrav # access-control: ::ffff:127.0.0.1 allow 230c8094600SDag-Erling Smørgrav 231b5663de9SDag-Erling Smørgrav # tag access-control with list of tags (in "" with spaces between) 232b5663de9SDag-Erling Smørgrav # Clients using this access control element use localzones that 233b5663de9SDag-Erling Smørgrav # are tagged with one of these tags. 234b5663de9SDag-Erling Smørgrav # access-control-tag: 192.0.2.0/24 "tag2 tag3" 235b5663de9SDag-Erling Smørgrav 236b5663de9SDag-Erling Smørgrav # set action for particular tag for given access control element 237b5663de9SDag-Erling Smørgrav # if you have multiple tag values, the tag used to lookup the action 238b5663de9SDag-Erling Smørgrav # is the first tag match between access-control-tag and local-zone-tag 239b5663de9SDag-Erling Smørgrav # where "first" comes from the order of the define-tag values. 240b5663de9SDag-Erling Smørgrav # access-control-tag-action: 192.0.2.0/24 tag3 refuse 241b5663de9SDag-Erling Smørgrav 242b5663de9SDag-Erling Smørgrav # set redirect data for particular tag for access control element 243b5663de9SDag-Erling Smørgrav # access-control-tag-data: 192.0.2.0/24 tag2 "A 127.0.0.1" 244b5663de9SDag-Erling Smørgrav 2453005e0a3SDag-Erling Smørgrav # Set view for access control element 2463005e0a3SDag-Erling Smørgrav # access-control-view: 192.0.2.0/24 viewname 2473005e0a3SDag-Erling Smørgrav 248c8094600SDag-Erling Smørgrav # if given, a chroot(2) is done to the given directory. 249c8094600SDag-Erling Smørgrav # i.e. you can chroot to the working directory, for example, 250c8094600SDag-Erling Smørgrav # for extra security, but make sure all files are in that directory. 251c8094600SDag-Erling Smørgrav # 252c8094600SDag-Erling Smørgrav # If chroot is enabled, you should pass the configfile (from the 253c8094600SDag-Erling Smørgrav # commandline) as a full path from the original root. After the 254c8094600SDag-Erling Smørgrav # chroot has been performed the now defunct portion of the config 255c8094600SDag-Erling Smørgrav # file path is removed to be able to reread the config after a reload. 256c8094600SDag-Erling Smørgrav # 257c8094600SDag-Erling Smørgrav # All other file paths (working dir, logfile, roothints, and 258c8094600SDag-Erling Smørgrav # key files) can be specified in several ways: 259c8094600SDag-Erling Smørgrav # o as an absolute path relative to the new root. 260c8094600SDag-Erling Smørgrav # o as a relative path to the working directory. 261c8094600SDag-Erling Smørgrav # o as an absolute path relative to the original root. 262c8094600SDag-Erling Smørgrav # In the last case the path is adjusted to remove the unused portion. 263c8094600SDag-Erling Smørgrav # 264c8094600SDag-Erling Smørgrav # The pid file can be absolute and outside of the chroot, it is 265c8094600SDag-Erling Smørgrav # written just prior to performing the chroot and dropping permissions. 266c8094600SDag-Erling Smørgrav # 267c8094600SDag-Erling Smørgrav # Additionally, unbound may need to access /dev/random (for entropy). 268c8094600SDag-Erling Smørgrav # How to do this is specific to your OS. 269c8094600SDag-Erling Smørgrav # 270c8094600SDag-Erling Smørgrav # If you give "" no chroot is performed. The path must not end in a /. 271c8094600SDag-Erling Smørgrav # chroot: "/var/unbound" 272c8094600SDag-Erling Smørgrav 273c8094600SDag-Erling Smørgrav # if given, user privileges are dropped (after binding port), 274c8094600SDag-Erling Smørgrav # and the given username is assumed. Default is user "unbound". 275c8094600SDag-Erling Smørgrav # If you give "" no privileges are dropped. 276c8094600SDag-Erling Smørgrav # username: "unbound" 277c8094600SDag-Erling Smørgrav 278c8094600SDag-Erling Smørgrav # the working directory. The relative files in this config are 279c8094600SDag-Erling Smørgrav # relative to this directory. If you give "" the working directory 280c8094600SDag-Erling Smørgrav # is not changed. 281b5663de9SDag-Erling Smørgrav # If you give a server: directory: dir before include: file statements 282b5663de9SDag-Erling Smørgrav # then those includes can be relative to the working directory. 283c8094600SDag-Erling Smørgrav # directory: "/var/unbound" 284c8094600SDag-Erling Smørgrav 285c8094600SDag-Erling Smørgrav # the log file, "" means log to stderr. 286c8094600SDag-Erling Smørgrav # Use of this option sets use-syslog to "no". 287c8094600SDag-Erling Smørgrav # logfile: "" 288c8094600SDag-Erling Smørgrav 289c8094600SDag-Erling Smørgrav # Log to syslog(3) if yes. The log facility LOG_DAEMON is used to 2903005e0a3SDag-Erling Smørgrav # log to. If yes, it overrides the logfile. 291c8094600SDag-Erling Smørgrav # use-syslog: yes 292c8094600SDag-Erling Smørgrav 2933005e0a3SDag-Erling Smørgrav # Log identity to report. if empty, defaults to the name of argv[0] 2943005e0a3SDag-Erling Smørgrav # (usually "unbound"). 2953005e0a3SDag-Erling Smørgrav # log-identity: "" 2963005e0a3SDag-Erling Smørgrav 297c8094600SDag-Erling Smørgrav # print UTC timestamp in ascii to logfile, default is epoch in seconds. 298c8094600SDag-Erling Smørgrav # log-time-ascii: no 299c8094600SDag-Erling Smørgrav 300c8094600SDag-Erling Smørgrav # print one line with time, IP, name, type, class for every query. 301c8094600SDag-Erling Smørgrav # log-queries: no 302c8094600SDag-Erling Smørgrav 3033005e0a3SDag-Erling Smørgrav # print one line per reply, with time, IP, name, type, class, rcode, 3043005e0a3SDag-Erling Smørgrav # timetoresolve, fromcache and responsesize. 3053005e0a3SDag-Erling Smørgrav # log-replies: no 3063005e0a3SDag-Erling Smørgrav 307c8094600SDag-Erling Smørgrav # the pid file. Can be an absolute path outside of chroot/work dir. 308c8094600SDag-Erling Smørgrav # pidfile: "/var/unbound/unbound.pid" 309c8094600SDag-Erling Smørgrav 310c8094600SDag-Erling Smørgrav # file to read root hints from. 31105ab2901SDag-Erling Smørgrav # get one from https://www.internic.net/domain/named.cache 312c8094600SDag-Erling Smørgrav # root-hints: "" 313c8094600SDag-Erling Smørgrav 314c8094600SDag-Erling Smørgrav # enable to not answer id.server and hostname.bind queries. 315c8094600SDag-Erling Smørgrav # hide-identity: no 316c8094600SDag-Erling Smørgrav 317c8094600SDag-Erling Smørgrav # enable to not answer version.server and version.bind queries. 318c8094600SDag-Erling Smørgrav # hide-version: no 319c8094600SDag-Erling Smørgrav 320*65b390aaSDag-Erling Smørgrav # enable to not answer trustanchor.unbound queries. 321*65b390aaSDag-Erling Smørgrav # hide-trustanchor: no 322*65b390aaSDag-Erling Smørgrav 323c8094600SDag-Erling Smørgrav # the identity to report. Leave "" or default to return hostname. 324c8094600SDag-Erling Smørgrav # identity: "" 325c8094600SDag-Erling Smørgrav 326c8094600SDag-Erling Smørgrav # the version to report. Leave "" or default to return package version. 327c8094600SDag-Erling Smørgrav # version: "" 328c8094600SDag-Erling Smørgrav 329c8094600SDag-Erling Smørgrav # the target fetch policy. 330c8094600SDag-Erling Smørgrav # series of integers describing the policy per dependency depth. 331c8094600SDag-Erling Smørgrav # The number of values in the list determines the maximum dependency 332c8094600SDag-Erling Smørgrav # depth the recursor will pursue before giving up. Each integer means: 333c8094600SDag-Erling Smørgrav # -1 : fetch all targets opportunistically, 334c8094600SDag-Erling Smørgrav # 0: fetch on demand, 335c8094600SDag-Erling Smørgrav # positive value: fetch that many targets opportunistically. 336c8094600SDag-Erling Smørgrav # Enclose the list of numbers between quotes (""). 337c8094600SDag-Erling Smørgrav # target-fetch-policy: "3 2 1 0 0" 338c8094600SDag-Erling Smørgrav 339c8094600SDag-Erling Smørgrav # Harden against very small EDNS buffer sizes. 340c8094600SDag-Erling Smørgrav # harden-short-bufsize: no 341c8094600SDag-Erling Smørgrav 342c8094600SDag-Erling Smørgrav # Harden against unseemly large queries. 343c8094600SDag-Erling Smørgrav # harden-large-queries: no 344c8094600SDag-Erling Smørgrav 345c8094600SDag-Erling Smørgrav # Harden against out of zone rrsets, to avoid spoofing attempts. 346c8094600SDag-Erling Smørgrav # harden-glue: yes 347c8094600SDag-Erling Smørgrav 348c8094600SDag-Erling Smørgrav # Harden against receiving dnssec-stripped data. If you turn it 349c8094600SDag-Erling Smørgrav # off, failing to validate dnskey data for a trustanchor will 350c8094600SDag-Erling Smørgrav # trigger insecure mode for that zone (like without a trustanchor). 351c8094600SDag-Erling Smørgrav # Default on, which insists on dnssec data for trust-anchored zones. 352c8094600SDag-Erling Smørgrav # harden-dnssec-stripped: yes 353c8094600SDag-Erling Smørgrav 354c8094600SDag-Erling Smørgrav # Harden against queries that fall under dnssec-signed nxdomain names. 355c8094600SDag-Erling Smørgrav # harden-below-nxdomain: no 356c8094600SDag-Erling Smørgrav 357c8094600SDag-Erling Smørgrav # Harden the referral path by performing additional queries for 358c8094600SDag-Erling Smørgrav # infrastructure data. Validates the replies (if possible). 359c8094600SDag-Erling Smørgrav # Default off, because the lookups burden the server. Experimental 360c8094600SDag-Erling Smørgrav # implementation of draft-wijngaards-dnsext-resolver-side-mitigation. 361c8094600SDag-Erling Smørgrav # harden-referral-path: no 362c8094600SDag-Erling Smørgrav 36309a3aaf3SDag-Erling Smørgrav # Harden against algorithm downgrade when multiple algorithms are 36409a3aaf3SDag-Erling Smørgrav # advertised in the DS record. If no, allows the weakest algorithm 36509a3aaf3SDag-Erling Smørgrav # to validate the zone. 366b75612f8SDag-Erling Smørgrav # harden-algo-downgrade: no 36709a3aaf3SDag-Erling Smørgrav 36805ab2901SDag-Erling Smørgrav # Sent minimum amount of information to upstream servers to enhance 36905ab2901SDag-Erling Smørgrav # privacy. Only sent minimum required labels of the QNAME and set QTYPE 37005ab2901SDag-Erling Smørgrav # to NS when possible. 37105ab2901SDag-Erling Smørgrav # qname-minimisation: no 37205ab2901SDag-Erling Smørgrav 3733005e0a3SDag-Erling Smørgrav # QNAME minimisation in strict mode. Do not fall-back to sending full 3743005e0a3SDag-Erling Smørgrav # QNAME to potentially broken nameservers. A lot of domains will not be 3753005e0a3SDag-Erling Smørgrav # resolvable when this option in enabled. 3763005e0a3SDag-Erling Smørgrav # This option only has effect when qname-minimisation is enabled. 3773005e0a3SDag-Erling Smørgrav # qname-minimisation-strict: no 3783005e0a3SDag-Erling Smørgrav 379c8094600SDag-Erling Smørgrav # Use 0x20-encoded random bits in the query to foil spoof attempts. 380c8094600SDag-Erling Smørgrav # This feature is an experimental implementation of draft dns-0x20. 381c8094600SDag-Erling Smørgrav # use-caps-for-id: no 382c8094600SDag-Erling Smørgrav 38309a3aaf3SDag-Erling Smørgrav # Domains (and domains in them) without support for dns-0x20 and 38409a3aaf3SDag-Erling Smørgrav # the fallback fails because they keep sending different answers. 38509a3aaf3SDag-Erling Smørgrav # caps-whitelist: "licdn.com" 386b5663de9SDag-Erling Smørgrav # caps-whitelist: "senderbase.org" 38709a3aaf3SDag-Erling Smørgrav 388c8094600SDag-Erling Smørgrav # Enforce privacy of these addresses. Strips them away from answers. 389c8094600SDag-Erling Smørgrav # It may cause DNSSEC validation to additionally mark it as bogus. 390c8094600SDag-Erling Smørgrav # Protects against 'DNS Rebinding' (uses browser as network proxy). 391c8094600SDag-Erling Smørgrav # Only 'private-domain' and 'local-data' names are allowed to have 392c8094600SDag-Erling Smørgrav # these private addresses. No default. 393c8094600SDag-Erling Smørgrav # private-address: 10.0.0.0/8 394c8094600SDag-Erling Smørgrav # private-address: 172.16.0.0/12 395c8094600SDag-Erling Smørgrav # private-address: 192.168.0.0/16 396c8094600SDag-Erling Smørgrav # private-address: 169.254.0.0/16 397c8094600SDag-Erling Smørgrav # private-address: fd00::/8 398c8094600SDag-Erling Smørgrav # private-address: fe80::/10 39905ab2901SDag-Erling Smørgrav # private-address: ::ffff:0:0/96 400c8094600SDag-Erling Smørgrav 401c8094600SDag-Erling Smørgrav # Allow the domain (and its subdomains) to contain private addresses. 402c8094600SDag-Erling Smørgrav # local-data statements are allowed to contain private addresses too. 403c8094600SDag-Erling Smørgrav # private-domain: "example.com" 404c8094600SDag-Erling Smørgrav 405c8094600SDag-Erling Smørgrav # If nonzero, unwanted replies are not only reported in statistics, 406c8094600SDag-Erling Smørgrav # but also a running total is kept per thread. If it reaches the 407c8094600SDag-Erling Smørgrav # threshold, a warning is printed and a defensive action is taken, 408c8094600SDag-Erling Smørgrav # the cache is cleared to flush potential poison out of it. 409c8094600SDag-Erling Smørgrav # A suggested value is 10000000, the default is 0 (turned off). 410c8094600SDag-Erling Smørgrav # unwanted-reply-threshold: 0 411c8094600SDag-Erling Smørgrav 412c8094600SDag-Erling Smørgrav # Do not query the following addresses. No DNS queries are sent there. 413c8094600SDag-Erling Smørgrav # List one address per entry. List classless netblocks with /size, 414c8094600SDag-Erling Smørgrav # do-not-query-address: 127.0.0.1/8 415c8094600SDag-Erling Smørgrav # do-not-query-address: ::1 416c8094600SDag-Erling Smørgrav 417c8094600SDag-Erling Smørgrav # if yes, the above default do-not-query-address entries are present. 418c8094600SDag-Erling Smørgrav # if no, localhost can be queried (for testing and debugging). 419c8094600SDag-Erling Smørgrav # do-not-query-localhost: yes 420c8094600SDag-Erling Smørgrav 421c8094600SDag-Erling Smørgrav # if yes, perform prefetching of almost expired message cache entries. 422c8094600SDag-Erling Smørgrav # prefetch: no 423c8094600SDag-Erling Smørgrav 424c8094600SDag-Erling Smørgrav # if yes, perform key lookups adjacent to normal lookups. 425c8094600SDag-Erling Smørgrav # prefetch-key: no 426c8094600SDag-Erling Smørgrav 427c8094600SDag-Erling Smørgrav # if yes, Unbound rotates RRSet order in response. 428c8094600SDag-Erling Smørgrav # rrset-roundrobin: no 429c8094600SDag-Erling Smørgrav 430c8094600SDag-Erling Smørgrav # if yes, Unbound doesn't insert authority/additional sections 431c8094600SDag-Erling Smørgrav # into response messages when those sections are not required. 432c8094600SDag-Erling Smørgrav # minimal-responses: no 433c8094600SDag-Erling Smørgrav 434e2d15004SDag-Erling Smørgrav # true to disable DNSSEC lameness check in iterator. 435e2d15004SDag-Erling Smørgrav # disable-dnssec-lame-check: no 436e2d15004SDag-Erling Smørgrav 437c8094600SDag-Erling Smørgrav # module configuration of the server. A string with identifiers 438c8094600SDag-Erling Smørgrav # separated by spaces. Syntax: "[dns64] [validator] iterator" 439c8094600SDag-Erling Smørgrav # module-config: "validator iterator" 440c8094600SDag-Erling Smørgrav 441c8094600SDag-Erling Smørgrav # File with trusted keys, kept uptodate using RFC5011 probes, 442c8094600SDag-Erling Smørgrav # initial file like trust-anchor-file, then it stores metadata. 443c8094600SDag-Erling Smørgrav # Use several entries, one per domain name, to track multiple zones. 444c8094600SDag-Erling Smørgrav # 445c8094600SDag-Erling Smørgrav # If you want to perform DNSSEC validation, run unbound-anchor before 446c8094600SDag-Erling Smørgrav # you start unbound (i.e. in the system boot scripts). And enable: 447c8094600SDag-Erling Smørgrav # Please note usage of unbound-anchor root anchor is at your own risk 448c8094600SDag-Erling Smørgrav # and under the terms of our LICENSE (see that file in the source). 449c8094600SDag-Erling Smørgrav # auto-trust-anchor-file: "/var/unbound/root.key" 450c8094600SDag-Erling Smørgrav 451c8094600SDag-Erling Smørgrav # File with DLV trusted keys. Same format as trust-anchor-file. 452c8094600SDag-Erling Smørgrav # There can be only one DLV configured, it is trusted from root down. 45309a3aaf3SDag-Erling Smørgrav # DLV is going to be decommissioned. Please do not use it any more. 454c8094600SDag-Erling Smørgrav # dlv-anchor-file: "dlv.isc.org.key" 455c8094600SDag-Erling Smørgrav 456c8094600SDag-Erling Smørgrav # File with trusted keys for validation. Specify more than one file 457c8094600SDag-Erling Smørgrav # with several entries, one file per entry. 458c8094600SDag-Erling Smørgrav # Zone file format, with DS and DNSKEY entries. 459c8094600SDag-Erling Smørgrav # Note this gets out of date, use auto-trust-anchor-file please. 460c8094600SDag-Erling Smørgrav # trust-anchor-file: "" 461c8094600SDag-Erling Smørgrav 462c8094600SDag-Erling Smørgrav # Trusted key for validation. DS or DNSKEY. specify the RR on a 463c8094600SDag-Erling Smørgrav # single line, surrounded by "". TTL is ignored. class is IN default. 464c8094600SDag-Erling Smørgrav # Note this gets out of date, use auto-trust-anchor-file please. 465c8094600SDag-Erling Smørgrav # (These examples are from August 2007 and may not be valid anymore). 466c8094600SDag-Erling Smørgrav # trust-anchor: "nlnetlabs.nl. DNSKEY 257 3 5 AQPzzTWMz8qSWIQlfRnPckx2BiVmkVN6LPupO3mbz7FhLSnm26n6iG9N Lby97Ji453aWZY3M5/xJBSOS2vWtco2t8C0+xeO1bc/d6ZTy32DHchpW 6rDH1vp86Ll+ha0tmwyy9QP7y2bVw5zSbFCrefk8qCUBgfHm9bHzMG1U BYtEIQ==" 467c8094600SDag-Erling Smørgrav # trust-anchor: "jelte.nlnetlabs.nl. DS 42860 5 1 14D739EB566D2B1A5E216A0BA4D17FA9B038BE4A" 468c8094600SDag-Erling Smørgrav 469c8094600SDag-Erling Smørgrav # File with trusted keys for validation. Specify more than one file 470c8094600SDag-Erling Smørgrav # with several entries, one file per entry. Like trust-anchor-file 471c8094600SDag-Erling Smørgrav # but has a different file format. Format is BIND-9 style format, 472c8094600SDag-Erling Smørgrav # the trusted-keys { name flag proto algo "key"; }; clauses are read. 473c8094600SDag-Erling Smørgrav # you need external update procedures to track changes in keys. 474c8094600SDag-Erling Smørgrav # trusted-keys-file: "" 475c8094600SDag-Erling Smørgrav 476c8094600SDag-Erling Smørgrav # Ignore chain of trust. Domain is treated as insecure. 477c8094600SDag-Erling Smørgrav # domain-insecure: "example.com" 478c8094600SDag-Erling Smørgrav 479c8094600SDag-Erling Smørgrav # Override the date for validation with a specific fixed date. 480c8094600SDag-Erling Smørgrav # Do not set this unless you are debugging signature inception 481c8094600SDag-Erling Smørgrav # and expiration. "" or "0" turns the feature off. -1 ignores date. 482c8094600SDag-Erling Smørgrav # val-override-date: "" 483c8094600SDag-Erling Smørgrav 484c8094600SDag-Erling Smørgrav # The time to live for bogus data, rrsets and messages. This avoids 485c8094600SDag-Erling Smørgrav # some of the revalidation, until the time interval expires. in secs. 486c8094600SDag-Erling Smørgrav # val-bogus-ttl: 60 487c8094600SDag-Erling Smørgrav 488c8094600SDag-Erling Smørgrav # The signature inception and expiration dates are allowed to be off 489c8094600SDag-Erling Smørgrav # by 10% of the signature lifetime (expir-incep) from our local clock. 490c8094600SDag-Erling Smørgrav # This leeway is capped with a minimum and a maximum. In seconds. 491c8094600SDag-Erling Smørgrav # val-sig-skew-min: 3600 492c8094600SDag-Erling Smørgrav # val-sig-skew-max: 86400 493c8094600SDag-Erling Smørgrav 494c8094600SDag-Erling Smørgrav # Should additional section of secure message also be kept clean of 495c8094600SDag-Erling Smørgrav # unsecure data. Useful to shield the users of this validator from 496c8094600SDag-Erling Smørgrav # potential bogus data in the additional section. All unsigned data 497c8094600SDag-Erling Smørgrav # in the additional section is removed from secure messages. 498c8094600SDag-Erling Smørgrav # val-clean-additional: yes 499c8094600SDag-Erling Smørgrav 500c8094600SDag-Erling Smørgrav # Turn permissive mode on to permit bogus messages. Thus, messages 501c8094600SDag-Erling Smørgrav # for which security checks failed will be returned to clients, 502c8094600SDag-Erling Smørgrav # instead of SERVFAIL. It still performs the security checks, which 503c8094600SDag-Erling Smørgrav # result in interesting log files and possibly the AD bit in 504c8094600SDag-Erling Smørgrav # replies if the message is found secure. The default is off. 505c8094600SDag-Erling Smørgrav # val-permissive-mode: no 506c8094600SDag-Erling Smørgrav 507c8094600SDag-Erling Smørgrav # Ignore the CD flag in incoming queries and refuse them bogus data. 508c8094600SDag-Erling Smørgrav # Enable it if the only clients of unbound are legacy servers (w2008) 509c8094600SDag-Erling Smørgrav # that set CD but cannot validate themselves. 510c8094600SDag-Erling Smørgrav # ignore-cd-flag: no 511c8094600SDag-Erling Smørgrav 5123005e0a3SDag-Erling Smørgrav # Serve expired reponses from cache, with TTL 0 in the response, 5133005e0a3SDag-Erling Smørgrav # and then attempt to fetch the data afresh. 5143005e0a3SDag-Erling Smørgrav # serve-expired: no 5153005e0a3SDag-Erling Smørgrav 516c8094600SDag-Erling Smørgrav # Have the validator log failed validations for your diagnosis. 517c8094600SDag-Erling Smørgrav # 0: off. 1: A line per failed user query. 2: With reason and bad IP. 518c8094600SDag-Erling Smørgrav # val-log-level: 0 519c8094600SDag-Erling Smørgrav 520c8094600SDag-Erling Smørgrav # It is possible to configure NSEC3 maximum iteration counts per 521c8094600SDag-Erling Smørgrav # keysize. Keep this table very short, as linear search is done. 522c8094600SDag-Erling Smørgrav # A message with an NSEC3 with larger count is marked insecure. 523c8094600SDag-Erling Smørgrav # List in ascending order the keysize and count values. 524c8094600SDag-Erling Smørgrav # val-nsec3-keysize-iterations: "1024 150 2048 500 4096 2500" 525c8094600SDag-Erling Smørgrav 526c8094600SDag-Erling Smørgrav # instruct the auto-trust-anchor-file probing to add anchors after ttl. 527c8094600SDag-Erling Smørgrav # add-holddown: 2592000 # 30 days 528c8094600SDag-Erling Smørgrav 529c8094600SDag-Erling Smørgrav # instruct the auto-trust-anchor-file probing to del anchors after ttl. 530c8094600SDag-Erling Smørgrav # del-holddown: 2592000 # 30 days 531c8094600SDag-Erling Smørgrav 532c8094600SDag-Erling Smørgrav # auto-trust-anchor-file probing removes missing anchors after ttl. 533c8094600SDag-Erling Smørgrav # If the value 0 is given, missing anchors are not removed. 534c8094600SDag-Erling Smørgrav # keep-missing: 31622400 # 366 days 535c8094600SDag-Erling Smørgrav 536e2d15004SDag-Erling Smørgrav # debug option that allows very small holddown times for key rollover, 537e2d15004SDag-Erling Smørgrav # otherwise the RFC mandates probe intervals must be at least 1 hour. 538b75612f8SDag-Erling Smørgrav # permit-small-holddown: no 539b75612f8SDag-Erling Smørgrav 540c8094600SDag-Erling Smørgrav # the amount of memory to use for the key cache. 541c8094600SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "4Mb". 542c8094600SDag-Erling Smørgrav # key-cache-size: 4m 543c8094600SDag-Erling Smørgrav 544c8094600SDag-Erling Smørgrav # the number of slabs to use for the key cache. 545c8094600SDag-Erling Smørgrav # the number of slabs must be a power of 2. 546c8094600SDag-Erling Smørgrav # more slabs reduce lock contention, but fragment memory usage. 547c8094600SDag-Erling Smørgrav # key-cache-slabs: 4 548c8094600SDag-Erling Smørgrav 549c8094600SDag-Erling Smørgrav # the amount of memory to use for the negative cache (used for DLV). 550c8094600SDag-Erling Smørgrav # plain value in bytes or you can append k, m or G. default is "1Mb". 551c8094600SDag-Erling Smørgrav # neg-cache-size: 1m 552c8094600SDag-Erling Smørgrav 553c8094600SDag-Erling Smørgrav # By default, for a number of zones a small default 'nothing here' 554c8094600SDag-Erling Smørgrav # reply is built-in. Query traffic is thus blocked. If you 555c8094600SDag-Erling Smørgrav # wish to serve such zone you can unblock them by uncommenting one 556c8094600SDag-Erling Smørgrav # of the nodefault statements below. 557c8094600SDag-Erling Smørgrav # You may also have to use domain-insecure: zone to make DNSSEC work, 558c8094600SDag-Erling Smørgrav # unless you have your own trust anchors for this zone. 559c8094600SDag-Erling Smørgrav # local-zone: "localhost." nodefault 560c8094600SDag-Erling Smørgrav # local-zone: "127.in-addr.arpa." nodefault 561c8094600SDag-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 562f61ef7f6SDag-Erling Smørgrav # local-zone: "onion." nodefault 563c8094600SDag-Erling Smørgrav # local-zone: "10.in-addr.arpa." nodefault 564c8094600SDag-Erling Smørgrav # local-zone: "16.172.in-addr.arpa." nodefault 565c8094600SDag-Erling Smørgrav # local-zone: "17.172.in-addr.arpa." nodefault 566c8094600SDag-Erling Smørgrav # local-zone: "18.172.in-addr.arpa." nodefault 567c8094600SDag-Erling Smørgrav # local-zone: "19.172.in-addr.arpa." nodefault 568c8094600SDag-Erling Smørgrav # local-zone: "20.172.in-addr.arpa." nodefault 569c8094600SDag-Erling Smørgrav # local-zone: "21.172.in-addr.arpa." nodefault 570c8094600SDag-Erling Smørgrav # local-zone: "22.172.in-addr.arpa." nodefault 571c8094600SDag-Erling Smørgrav # local-zone: "23.172.in-addr.arpa." nodefault 572c8094600SDag-Erling Smørgrav # local-zone: "24.172.in-addr.arpa." nodefault 573c8094600SDag-Erling Smørgrav # local-zone: "25.172.in-addr.arpa." nodefault 574c8094600SDag-Erling Smørgrav # local-zone: "26.172.in-addr.arpa." nodefault 575c8094600SDag-Erling Smørgrav # local-zone: "27.172.in-addr.arpa." nodefault 576c8094600SDag-Erling Smørgrav # local-zone: "28.172.in-addr.arpa." nodefault 577c8094600SDag-Erling Smørgrav # local-zone: "29.172.in-addr.arpa." nodefault 578c8094600SDag-Erling Smørgrav # local-zone: "30.172.in-addr.arpa." nodefault 579c8094600SDag-Erling Smørgrav # local-zone: "31.172.in-addr.arpa." nodefault 580c8094600SDag-Erling Smørgrav # local-zone: "168.192.in-addr.arpa." nodefault 581c8094600SDag-Erling Smørgrav # local-zone: "0.in-addr.arpa." nodefault 582c8094600SDag-Erling Smørgrav # local-zone: "254.169.in-addr.arpa." nodefault 583c8094600SDag-Erling Smørgrav # local-zone: "2.0.192.in-addr.arpa." nodefault 584c8094600SDag-Erling Smørgrav # local-zone: "100.51.198.in-addr.arpa." nodefault 585c8094600SDag-Erling Smørgrav # local-zone: "113.0.203.in-addr.arpa." nodefault 586c8094600SDag-Erling Smørgrav # local-zone: "255.255.255.255.in-addr.arpa." nodefault 587c8094600SDag-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 588c8094600SDag-Erling Smørgrav # local-zone: "d.f.ip6.arpa." nodefault 589c8094600SDag-Erling Smørgrav # local-zone: "8.e.f.ip6.arpa." nodefault 590c8094600SDag-Erling Smørgrav # local-zone: "9.e.f.ip6.arpa." nodefault 591c8094600SDag-Erling Smørgrav # local-zone: "a.e.f.ip6.arpa." nodefault 592c8094600SDag-Erling Smørgrav # local-zone: "b.e.f.ip6.arpa." nodefault 593c8094600SDag-Erling Smørgrav # local-zone: "8.b.d.0.1.0.0.2.ip6.arpa." nodefault 594c8094600SDag-Erling Smørgrav # And for 64.100.in-addr.arpa. to 127.100.in-addr.arpa. 595c8094600SDag-Erling Smørgrav 5960de4f1bfSDag-Erling Smørgrav # If unbound is running service for the local host then it is useful 597c8094600SDag-Erling Smørgrav # to perform lan-wide lookups to the upstream, and unblock the 598c8094600SDag-Erling Smørgrav # long list of local-zones above. If this unbound is a dns server 599c8094600SDag-Erling Smørgrav # for a network of computers, disabled is better and stops information 600c8094600SDag-Erling Smørgrav # leakage of local lan information. 601c8094600SDag-Erling Smørgrav # unblock-lan-zones: no 602c8094600SDag-Erling Smørgrav 6030de4f1bfSDag-Erling Smørgrav # The insecure-lan-zones option disables validation for 6040de4f1bfSDag-Erling Smørgrav # these zones, as if they were all listed as domain-insecure. 6050de4f1bfSDag-Erling Smørgrav # insecure-lan-zones: no 6060de4f1bfSDag-Erling Smørgrav 607c8094600SDag-Erling Smørgrav # a number of locally served zones can be configured. 608c8094600SDag-Erling Smørgrav # local-zone: <zone> <type> 609c8094600SDag-Erling Smørgrav # local-data: "<resource record string>" 610c8094600SDag-Erling Smørgrav # o deny serves local data (if any), else, drops queries. 611c8094600SDag-Erling Smørgrav # o refuse serves local data (if any), else, replies with error. 612c8094600SDag-Erling Smørgrav # o static serves local data, else, nxdomain or nodata answer. 613c8094600SDag-Erling Smørgrav # o transparent gives local data, but resolves normally for other names 614c8094600SDag-Erling Smørgrav # o redirect serves the zone data for any subdomain in the zone. 615c8094600SDag-Erling Smørgrav # o nodefault can be used to normally resolve AS112 zones. 616c8094600SDag-Erling Smørgrav # o typetransparent resolves normally for other types and other names 6173005e0a3SDag-Erling Smørgrav # o inform acts like transparent, but logs client IP address 61809a3aaf3SDag-Erling Smørgrav # o inform_deny drops queries and logs client IP address 619b5663de9SDag-Erling Smørgrav # o always_transparent, always_refuse, always_nxdomain, resolve in 620b5663de9SDag-Erling Smørgrav # that way but ignore local data for that name. 621c8094600SDag-Erling Smørgrav # 622c8094600SDag-Erling Smørgrav # defaults are localhost address, reverse for 127.0.0.1 and ::1 623c8094600SDag-Erling Smørgrav # and nxdomain for AS112 zones. If you configure one of these zones 624c8094600SDag-Erling Smørgrav # the default content is omitted, or you can omit it with 'nodefault'. 625c8094600SDag-Erling Smørgrav # 626c8094600SDag-Erling Smørgrav # If you configure local-data without specifying local-zone, by 627c8094600SDag-Erling Smørgrav # default a transparent local-zone is created for the data. 628c8094600SDag-Erling Smørgrav # 629c8094600SDag-Erling Smørgrav # You can add locally served data with 630c8094600SDag-Erling Smørgrav # local-zone: "local." static 631c8094600SDag-Erling Smørgrav # local-data: "mycomputer.local. IN A 192.0.2.51" 632c8094600SDag-Erling Smørgrav # local-data: 'mytext.local TXT "content of text record"' 633c8094600SDag-Erling Smørgrav # 634c8094600SDag-Erling Smørgrav # You can override certain queries with 635c8094600SDag-Erling Smørgrav # local-data: "adserver.example.com A 127.0.0.1" 636c8094600SDag-Erling Smørgrav # 637c8094600SDag-Erling Smørgrav # You can redirect a domain to a fixed address with 638c8094600SDag-Erling Smørgrav # (this makes example.com, www.example.com, etc, all go to 192.0.2.3) 639c8094600SDag-Erling Smørgrav # local-zone: "example.com" redirect 640c8094600SDag-Erling Smørgrav # local-data: "example.com A 192.0.2.3" 641c8094600SDag-Erling Smørgrav # 642c8094600SDag-Erling Smørgrav # Shorthand to make PTR records, "IPv4 name" or "IPv6 name". 643c8094600SDag-Erling Smørgrav # You can also add PTR records using local-data directly, but then 644c8094600SDag-Erling Smørgrav # you need to do the reverse notation yourself. 645c8094600SDag-Erling Smørgrav # local-data-ptr: "192.0.2.3 www.example.com" 646c8094600SDag-Erling Smørgrav 647b5663de9SDag-Erling Smørgrav # tag a localzone with a list of tag names (in "" with spaces between) 648b5663de9SDag-Erling Smørgrav # local-zone-tag: "example.com" "tag2 tag3" 649b5663de9SDag-Erling Smørgrav 650b5663de9SDag-Erling Smørgrav # add a netblock specific override to a localzone, with zone type 651b5663de9SDag-Erling Smørgrav # local-zone-override: "example.com" 192.0.2.0/24 refuse 652b5663de9SDag-Erling Smørgrav 653c8094600SDag-Erling Smørgrav # service clients over SSL (on the TCP sockets), with plain DNS inside 654c8094600SDag-Erling Smørgrav # the SSL stream. Give the certificate to use and private key. 655c8094600SDag-Erling Smørgrav # default is "" (disabled). requires restart to take effect. 656c8094600SDag-Erling Smørgrav # ssl-service-key: "path/to/privatekeyfile.key" 657c8094600SDag-Erling Smørgrav # ssl-service-pem: "path/to/publiccertfile.pem" 65805ab2901SDag-Erling Smørgrav # ssl-port: 853 659c8094600SDag-Erling Smørgrav 660c8094600SDag-Erling Smørgrav # request upstream over SSL (with plain DNS inside the SSL stream). 661c8094600SDag-Erling Smørgrav # Default is no. Can be turned on and off with unbound-control. 662c8094600SDag-Erling Smørgrav # ssl-upstream: no 663c8094600SDag-Erling Smørgrav 664c8094600SDag-Erling Smørgrav # DNS64 prefix. Must be specified when DNS64 is use. 665c8094600SDag-Erling Smørgrav # Enable dns64 in module-config. Used to synthesize IPv6 from IPv4. 666c8094600SDag-Erling Smørgrav # dns64-prefix: 64:ff9b::0/96 667c8094600SDag-Erling Smørgrav 66809a3aaf3SDag-Erling Smørgrav # ratelimit for uncached, new queries, this limits recursion effort. 66909a3aaf3SDag-Erling Smørgrav # ratelimiting is experimental, and may help against randomqueryflood. 67009a3aaf3SDag-Erling Smørgrav # if 0(default) it is disabled, otherwise state qps allowed per zone. 67109a3aaf3SDag-Erling Smørgrav # ratelimit: 0 67209a3aaf3SDag-Erling Smørgrav 67309a3aaf3SDag-Erling Smørgrav # ratelimits are tracked in a cache, size in bytes of cache (or k,m). 67409a3aaf3SDag-Erling Smørgrav # ratelimit-size: 4m 67509a3aaf3SDag-Erling Smørgrav # ratelimit cache slabs, reduces lock contention if equal to cpucount. 67609a3aaf3SDag-Erling Smørgrav # ratelimit-slabs: 4 67709a3aaf3SDag-Erling Smørgrav 67809a3aaf3SDag-Erling Smørgrav # 0 blocks when ratelimited, otherwise let 1/xth traffic through 67909a3aaf3SDag-Erling Smørgrav # ratelimit-factor: 10 68009a3aaf3SDag-Erling Smørgrav 68109a3aaf3SDag-Erling Smørgrav # override the ratelimit for a specific domain name. 68209a3aaf3SDag-Erling Smørgrav # give this setting multiple times to have multiple overrides. 68309a3aaf3SDag-Erling Smørgrav # ratelimit-for-domain: example.com 1000 68409a3aaf3SDag-Erling Smørgrav # override the ratelimits for all domains below a domain name 68509a3aaf3SDag-Erling Smørgrav # can give this multiple times, the name closest to the zone is used. 686b5663de9SDag-Erling Smørgrav # ratelimit-below-domain: com 1000 68709a3aaf3SDag-Erling Smørgrav 6883005e0a3SDag-Erling Smørgrav # global query ratelimit for all ip addresses. 6893005e0a3SDag-Erling Smørgrav # feature is experimental. 6903005e0a3SDag-Erling Smørgrav # if 0(default) it is disabled, otherwise states qps allowed per ip address 6913005e0a3SDag-Erling Smørgrav # ip-ratelimit: 0 6923005e0a3SDag-Erling Smørgrav 6933005e0a3SDag-Erling Smørgrav # ip ratelimits are tracked in a cache, size in bytes of cache (or k,m). 6943005e0a3SDag-Erling Smørgrav # ip-ratelimit-size: 4m 6953005e0a3SDag-Erling Smørgrav # ip ratelimit cache slabs, reduces lock contention if equal to cpucount. 6963005e0a3SDag-Erling Smørgrav # ip-ratelimit-slabs: 4 6973005e0a3SDag-Erling Smørgrav 6983005e0a3SDag-Erling Smørgrav # 0 blocks when ip is ratelimited, otherwise let 1/xth traffic through 6993005e0a3SDag-Erling Smørgrav # ip-ratelimit-factor: 10 7003005e0a3SDag-Erling Smørgrav 7013005e0a3SDag-Erling Smørgrav 702c8094600SDag-Erling Smørgrav# Python config section. To enable: 703c8094600SDag-Erling Smørgrav# o use --with-pythonmodule to configure before compiling. 704c8094600SDag-Erling Smørgrav# o list python in the module-config string (above) to enable. 705c8094600SDag-Erling Smørgrav# o and give a python-script to run. 706c8094600SDag-Erling Smørgravpython: 707c8094600SDag-Erling Smørgrav # Script file to load 708c8094600SDag-Erling Smørgrav # python-script: "/var/unbound/ubmodule-tst.py" 709c8094600SDag-Erling Smørgrav 710c8094600SDag-Erling Smørgrav# Remote control config section. 711c8094600SDag-Erling Smørgravremote-control: 712c8094600SDag-Erling Smørgrav # Enable remote control with unbound-control(8) here. 713c8094600SDag-Erling Smørgrav # set up the keys and certificates with unbound-control-setup. 714c8094600SDag-Erling Smørgrav # control-enable: no 715c8094600SDag-Erling Smørgrav 7166480faa8SDag-Erling Smørgrav # Set to no and use an absolute path as control-interface to use 7176480faa8SDag-Erling Smørgrav # a unix local named pipe for unbound-control. 7186480faa8SDag-Erling Smørgrav # control-use-cert: yes 7196480faa8SDag-Erling Smørgrav 720c8094600SDag-Erling Smørgrav # what interfaces are listened to for remote control. 721c8094600SDag-Erling Smørgrav # give 0.0.0.0 and ::0 to listen to all interfaces. 722c8094600SDag-Erling Smørgrav # control-interface: 127.0.0.1 723c8094600SDag-Erling Smørgrav # control-interface: ::1 724c8094600SDag-Erling Smørgrav 725c8094600SDag-Erling Smørgrav # port number for remote control operations. 726c8094600SDag-Erling Smørgrav # control-port: 8953 727c8094600SDag-Erling Smørgrav 728c8094600SDag-Erling Smørgrav # unbound server key file. 729c8094600SDag-Erling Smørgrav # server-key-file: "/var/unbound/unbound_server.key" 730c8094600SDag-Erling Smørgrav 731c8094600SDag-Erling Smørgrav # unbound server certificate file. 732c8094600SDag-Erling Smørgrav # server-cert-file: "/var/unbound/unbound_server.pem" 733c8094600SDag-Erling Smørgrav 734c8094600SDag-Erling Smørgrav # unbound-control key file. 735c8094600SDag-Erling Smørgrav # control-key-file: "/var/unbound/unbound_control.key" 736c8094600SDag-Erling Smørgrav 737c8094600SDag-Erling Smørgrav # unbound-control certificate file. 738c8094600SDag-Erling Smørgrav # control-cert-file: "/var/unbound/unbound_control.pem" 739c8094600SDag-Erling Smørgrav 740c8094600SDag-Erling Smørgrav# Stub zones. 741c8094600SDag-Erling Smørgrav# Create entries like below, to make all queries for 'example.com' and 742c8094600SDag-Erling Smørgrav# 'example.org' go to the given list of nameservers. list zero or more 743c8094600SDag-Erling Smørgrav# nameservers by hostname or by ipaddress. If you set stub-prime to yes, 744c8094600SDag-Erling Smørgrav# the list is treated as priming hints (default is no). 745c8094600SDag-Erling Smørgrav# With stub-first yes, it attempts without the stub if it fails. 746b75612f8SDag-Erling Smørgrav# Consider adding domain-insecure: name and local-zone: name nodefault 747b75612f8SDag-Erling Smørgrav# to the server: section if the stub is a locally served zone. 748c8094600SDag-Erling Smørgrav# stub-zone: 749c8094600SDag-Erling Smørgrav# name: "example.com" 750c8094600SDag-Erling Smørgrav# stub-addr: 192.0.2.68 751c8094600SDag-Erling Smørgrav# stub-prime: no 752c8094600SDag-Erling Smørgrav# stub-first: no 7533005e0a3SDag-Erling Smørgrav# stub-ssl-upstream: no 754c8094600SDag-Erling Smørgrav# stub-zone: 755c8094600SDag-Erling Smørgrav# name: "example.org" 756c8094600SDag-Erling Smørgrav# stub-host: ns.example.com. 757c8094600SDag-Erling Smørgrav 758c8094600SDag-Erling Smørgrav# Forward zones 759c8094600SDag-Erling Smørgrav# Create entries like below, to make all queries for 'example.com' and 760c8094600SDag-Erling Smørgrav# 'example.org' go to the given list of servers. These servers have to handle 761c8094600SDag-Erling Smørgrav# recursion to other nameservers. List zero or more nameservers by hostname 762c8094600SDag-Erling Smørgrav# or by ipaddress. Use an entry with name "." to forward all queries. 763c8094600SDag-Erling Smørgrav# If you enable forward-first, it attempts without the forward if it fails. 764c8094600SDag-Erling Smørgrav# forward-zone: 765c8094600SDag-Erling Smørgrav# name: "example.com" 766c8094600SDag-Erling Smørgrav# forward-addr: 192.0.2.68 767c8094600SDag-Erling Smørgrav# forward-addr: 192.0.2.73@5355 # forward to port 5355. 768c8094600SDag-Erling Smørgrav# forward-first: no 7693005e0a3SDag-Erling Smørgrav# forward-ssl-upstream: no 770c8094600SDag-Erling Smørgrav# forward-zone: 771c8094600SDag-Erling Smørgrav# name: "example.org" 772c8094600SDag-Erling Smørgrav# forward-host: fwd.example.com 7733005e0a3SDag-Erling Smørgrav 7743005e0a3SDag-Erling Smørgrav# Views 7753005e0a3SDag-Erling Smørgrav# Create named views. Name must be unique. Map views to requests using 7763005e0a3SDag-Erling Smørgrav# the access-control-view option. Views can contain zero or more local-zone 7773005e0a3SDag-Erling Smørgrav# and local-data options. Options from matching views will override global 7783005e0a3SDag-Erling Smørgrav# options. Global options will be used if no matching view is found. 7793005e0a3SDag-Erling Smørgrav# With view-first yes, it will try to answer using the global local-zone and 7803005e0a3SDag-Erling Smørgrav# local-data elements if there is no view specific match. 7813005e0a3SDag-Erling Smørgrav# view: 7823005e0a3SDag-Erling Smørgrav# name: "viewname" 7833005e0a3SDag-Erling Smørgrav# local-zone: "example.com" redirect 7843005e0a3SDag-Erling Smørgrav# local-data: "example.com A 192.0.2.3" 785*65b390aaSDag-Erling Smørgrav# local-data-ptr: "192.0.2.3 www.example.com" 7863005e0a3SDag-Erling Smørgrav# view-first: no 7873005e0a3SDag-Erling Smørgrav# view: 7883005e0a3SDag-Erling Smørgrav# name: "anotherview" 7893005e0a3SDag-Erling Smørgrav# local-zone: "example.com" refuse 790*65b390aaSDag-Erling Smørgrav 791*65b390aaSDag-Erling Smørgrav# DNSCrypt 792*65b390aaSDag-Erling Smørgrav# Caveats: 793*65b390aaSDag-Erling Smørgrav# 1. the keys/certs cannot be produced by unbound. You can use dnscrypt-wrapper 794*65b390aaSDag-Erling Smørgrav# for this: https://github.com/cofyc/dnscrypt-wrapper/blob/master/README.md#usage 795*65b390aaSDag-Erling Smørgrav# 2. dnscrypt channel attaches to an interface. you MUST set interfaces to 796*65b390aaSDag-Erling Smørgrav# listen on `dnscrypt-port` with the follo0wing snippet: 797*65b390aaSDag-Erling Smørgrav# server: 798*65b390aaSDag-Erling Smørgrav# interface: 0.0.0.0@443 799*65b390aaSDag-Erling Smørgrav# interface: ::0@443 800*65b390aaSDag-Erling Smørgrav# 801*65b390aaSDag-Erling Smørgrav# Finally, `dnscrypt` config has its own section. 802*65b390aaSDag-Erling Smørgrav# dnscrypt: 803*65b390aaSDag-Erling Smørgrav# dnscrypt-enable: yes 804*65b390aaSDag-Erling Smørgrav# dnscrypt-port: 443 805*65b390aaSDag-Erling Smørgrav# dnscrypt-provider: 2.dnscrypt-cert.example.com. 806*65b390aaSDag-Erling Smørgrav# dnscrypt-secret-key: /path/unbound-conf/keys1/1.key 807*65b390aaSDag-Erling Smørgrav# dnscrypt-secret-key: /path/unbound-conf/keys2/1.key 808*65b390aaSDag-Erling Smørgrav# dnscrypt-provider-cert: /path/unbound-conf/keys1/1.cert 809*65b390aaSDag-Erling Smørgrav# dnscrypt-provider-cert: /path/unbound-conf/keys2/1.cert 810