]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/unbound/doc/unbound.conf.5
Upgrade Unbound to 1.6.4. More to follow.
[FreeBSD/FreeBSD.git] / contrib / unbound / doc / unbound.conf.5
1 .TH "unbound.conf" "5" "Jun 27, 2017" "NLnet Labs" "unbound 1.6.4"
2 .\"
3 .\" unbound.conf.5 -- unbound.conf manual
4 .\"
5 .\" Copyright (c) 2007, NLnet Labs. All rights reserved.
6 .\"
7 .\" See LICENSE for the license.
8 .\"
9 .\"
10 .SH "NAME"
11 .B unbound.conf
12 \- Unbound configuration file.
13 .SH "SYNOPSIS"
14 .B unbound.conf
15 .SH "DESCRIPTION"
16 .B unbound.conf
17 is used to configure
18 \fIunbound\fR(8).
19 The file format has attributes and values. Some attributes have attributes
20 inside them.
21 The notation is: attribute: value.
22 .P
23 Comments start with # and last to the end of line. Empty lines are
24 ignored as is whitespace at the beginning of a line.
25 .P
26 The utility
27 \fIunbound\-checkconf\fR(8)
28 can be used to check unbound.conf prior to usage.
29 .SH "EXAMPLE"
30 An example config file is shown below. Copy this to /etc/unbound/unbound.conf
31 and start the server with:
32 .P
33 .nf
34         $ unbound \-c /etc/unbound/unbound.conf
35 .fi
36 .P
37 Most settings are the defaults. Stop the server with:
38 .P
39 .nf
40         $ kill `cat /etc/unbound/unbound.pid`
41 .fi
42 .P
43 Below is a minimal config file. The source distribution contains an extensive
44 example.conf file with all the options.
45 .P
46 .nf
47 # unbound.conf(5) config file for unbound(8).
48 server:
49         directory: "/etc/unbound"
50         username: unbound
51         # make sure unbound can access entropy from inside the chroot.
52         # e.g. on linux the use these commands (on BSD, devfs(8) is used):
53         #      mount \-\-bind \-n /dev/random /etc/unbound/dev/random
54         # and  mount \-\-bind \-n /dev/log /etc/unbound/dev/log
55         chroot: "/etc/unbound"
56         # logfile: "/etc/unbound/unbound.log"  #uncomment to use logfile.
57         pidfile: "/etc/unbound/unbound.pid"
58         # verbosity: 1          # uncomment and increase to get more logging.
59         # listen on all interfaces, answer queries from the local subnet.
60         interface: 0.0.0.0
61         interface: ::0
62         access\-control: 10.0.0.0/8 allow
63         access\-control: 2001:DB8::/64 allow
64 .fi
65 .SH "FILE FORMAT"
66 There must be whitespace between keywords. Attribute keywords end with a colon ':'.
67 An attribute is followed by its containing attributes, or a value.
68 .P
69 Files can be included using the
70 .B include:
71 directive. It can appear anywhere, it accepts a single file name as argument.
72 Processing continues as if the text from the included file was copied into
73 the config file at that point.  If also using chroot, using full path names
74 for the included files works, relative pathnames for the included names work
75 if the directory where the daemon is started equals its chroot/working
76 directory or is specified before the include statement with directory: dir.
77 Wildcards can be used to include multiple files, see \fIglob\fR(7).
78 .SS "Server Options"
79 These options are part of the
80 .B server:
81 clause.
82 .TP
83 .B verbosity: \fI<number>
84 The verbosity number, level 0 means no verbosity, only errors. Level 1
85 gives operational information. Level 2 gives detailed operational
86 information. Level 3 gives query level information, output per query.
87 Level 4 gives algorithm level information.  Level 5 logs client
88 identification for cache misses.  Default is level 1.
89 The verbosity can also be increased from the commandline, see \fIunbound\fR(8).
90 .TP
91 .B statistics\-interval: \fI<seconds>
92 The number of seconds between printing statistics to the log for every thread.
93 Disable with value 0 or "". Default is disabled.  The histogram statistics
94 are only printed if replies were sent during the statistics interval,
95 requestlist statistics are printed for every interval (but can be 0).
96 This is because the median calculation requires data to be present.
97 .TP
98 .B statistics\-cumulative: \fI<yes or no>
99 If enabled, statistics are cumulative since starting unbound, without clearing
100 the statistics counters after logging the statistics. Default is no.
101 .TP
102 .B extended\-statistics: \fI<yes or no>
103 If enabled, extended statistics are printed from \fIunbound\-control\fR(8).
104 Default is off, because keeping track of more statistics takes time.  The
105 counters are listed in \fIunbound\-control\fR(8).
106 .TP
107 .B num\-threads: \fI<number>
108 The number of threads to create to serve clients. Use 1 for no threading.
109 .TP
110 .B port: \fI<port number>
111 The port number, default 53, on which the server responds to queries.
112 .TP
113 .B interface: \fI<ip address[@port]>
114 Interface to use to connect to the network. This interface is listened to
115 for queries from clients, and answers to clients are given from it.
116 Can be given multiple times to work on several interfaces. If none are
117 given the default is to listen to localhost.
118 The interfaces are not changed on a reload (kill \-HUP) but only on restart.
119 A port number can be specified with @port (without spaces between
120 interface and port number), if not specified the default port (from
121 \fBport\fR) is used.
122 .TP
123 .B ip\-address: \fI<ip address[@port]>
124 Same as interface: (for easy of compatibility with nsd.conf).
125 .TP
126 .B interface\-automatic: \fI<yes or no>
127 Detect source interface on UDP queries and copy them to replies.  This
128 feature is experimental, and needs support in your OS for particular socket
129 options.  Default value is no.
130 .TP
131 .B outgoing\-interface: \fI<ip address or ip6 netblock>
132 Interface to use to connect to the network. This interface is used to send
133 queries to authoritative servers and receive their replies. Can be given
134 multiple times to work on several interfaces. If none are given the
135 default (all) is used. You can specify the same interfaces in
136 .B interface:
137 and
138 .B outgoing\-interface:
139 lines, the interfaces are then used for both purposes. Outgoing queries are
140 sent via a random outgoing interface to counter spoofing.
141 .IP
142 If an IPv6 netblock is specified instead of an individual IPv6 address,
143 outgoing UDP queries will use a randomised source address taken from the
144 netblock to counter spoofing. Requires the IPv6 netblock to be routed to the
145 host running unbound, and requires OS support for unprivileged non-local binds
146 (currently only supported on Linux). Several netblocks may be specified with
147 multiple
148 .B outgoing\-interface:
149 options, but do not specify both an individual IPv6 address and an IPv6
150 netblock, or the randomisation will be compromised.  Consider combining with
151 .B prefer\-ip6: yes
152 to increase the likelihood of IPv6 nameservers being selected for queries.
153 On Linux you need these two commands to be able to use the freebind socket
154 option to receive traffic for the ip6 netblock:
155 ip \-6 addr add mynetblock/64 dev lo &&
156 ip \-6 route add local mynetblock/64 dev lo
157 .TP
158 .B outgoing\-range: \fI<number>
159 Number of ports to open. This number of file descriptors can be opened per
160 thread. Must be at least 1. Default depends on compile options. Larger
161 numbers need extra resources from the operating system.  For performance a
162 very large value is best, use libevent to make this possible.
163 .TP
164 .B outgoing\-port\-permit: \fI<port number or range>
165 Permit unbound to open this port or range of ports for use to send queries.
166 A larger number of permitted outgoing ports increases resilience against
167 spoofing attempts. Make sure these ports are not needed by other daemons.
168 By default only ports above 1024 that have not been assigned by IANA are used.
169 Give a port number or a range of the form "low\-high", without spaces.
170 .IP
171 The \fBoutgoing\-port\-permit\fR and \fBoutgoing\-port\-avoid\fR statements
172 are processed in the line order of the config file, adding the permitted ports
173 and subtracting the avoided ports from the set of allowed ports.  The
174 processing starts with the non IANA allocated ports above 1024 in the set
175 of allowed ports.
176 .TP
177 .B outgoing\-port\-avoid: \fI<port number or range>
178 Do not permit unbound to open this port or range of ports for use to send
179 queries. Use this to make sure unbound does not grab a port that another
180 daemon needs. The port is avoided on all outgoing interfaces, both IP4 and IP6.
181 By default only ports above 1024 that have not been assigned by IANA are used.
182 Give a port number or a range of the form "low\-high", without spaces.
183 .TP
184 .B outgoing\-num\-tcp: \fI<number>
185 Number of outgoing TCP buffers to allocate per thread. Default is 10. If
186 set to 0, or if do\-tcp is "no", no TCP queries to authoritative servers
187 are done.  For larger installations increasing this value is a good idea.
188 .TP
189 .B incoming\-num\-tcp: \fI<number>
190 Number of incoming TCP buffers to allocate per thread. Default is
191 10. If set to 0, or if do\-tcp is "no", no TCP queries from clients are
192 accepted. For larger installations increasing this value is a good idea.
193 .TP
194 .B edns\-buffer\-size: \fI<number>
195 Number of bytes size to advertise as the EDNS reassembly buffer size.
196 This is the value put into datagrams over UDP towards peers.  The actual
197 buffer size is determined by msg\-buffer\-size (both for TCP and UDP).  Do
198 not set higher than that value.  Default is 4096 which is RFC recommended.
199 If you have fragmentation reassembly problems, usually seen as timeouts,
200 then a value of 1480 can fix it.  Setting to 512 bypasses even the most
201 stringent path MTU problems, but is seen as extreme, since the amount
202 of TCP fallback generated is excessive (probably also for this resolver,
203 consider tuning the outgoing tcp number).
204 .TP
205 .B max\-udp\-size: \fI<number>
206 Maximum UDP response size (not applied to TCP response).  65536 disables the
207 udp response size maximum, and uses the choice from the client, always.
208 Suggested values are 512 to 4096. Default is 4096.
209 .TP
210 .B msg\-buffer\-size: \fI<number>
211 Number of bytes size of the message buffers. Default is 65552 bytes, enough
212 for 64 Kb packets, the maximum DNS message size. No message larger than this
213 can be sent or received. Can be reduced to use less memory, but some requests
214 for DNS data, such as for huge resource records, will result in a SERVFAIL
215 reply to the client.
216 .TP
217 .B msg\-cache\-size: \fI<number>
218 Number of bytes size of the message cache. Default is 4 megabytes.
219 A plain number is in bytes, append 'k', 'm' or 'g' for kilobytes, megabytes
220 or gigabytes (1024*1024 bytes in a megabyte).
221 .TP
222 .B msg\-cache\-slabs: \fI<number>
223 Number of slabs in the message cache. Slabs reduce lock contention by threads.
224 Must be set to a power of 2. Setting (close) to the number of cpus is a
225 reasonable guess.
226 .TP
227 .B num\-queries\-per\-thread: \fI<number>
228 The number of queries that every thread will service simultaneously.
229 If more queries arrive that need servicing, and no queries can be jostled out
230 (see \fIjostle\-timeout\fR), then the queries are dropped. This forces
231 the client to resend after a timeout; allowing the server time to work on
232 the existing queries. Default depends on compile options, 512 or 1024.
233 .TP
234 .B jostle\-timeout: \fI<msec>
235 Timeout used when the server is very busy.  Set to a value that usually
236 results in one roundtrip to the authority servers.  If too many queries
237 arrive, then 50% of the queries are allowed to run to completion, and
238 the other 50% are replaced with the new incoming query if they have already
239 spent more than their allowed time.  This protects against denial of
240 service by slow queries or high query rates.  Default 200 milliseconds.
241 The effect is that the qps for long-lasting queries is about
242 (numqueriesperthread / 2) / (average time for such long queries) qps.
243 The qps for short queries can be about (numqueriesperthread / 2)
244 / (jostletimeout in whole seconds) qps per thread, about (1024/2)*5 = 2560
245 qps by default.
246 .TP
247 .B delay\-close: \fI<msec>
248 Extra delay for timeouted UDP ports before they are closed, in msec.
249 Default is 0, and that disables it.  This prevents very delayed answer
250 packets from the upstream (recursive) servers from bouncing against
251 closed ports and setting off all sort of close-port counters, with
252 eg. 1500 msec.  When timeouts happen you need extra sockets, it checks
253 the ID and remote IP of packets, and unwanted packets are added to the
254 unwanted packet counter.
255 .TP
256 .B so\-rcvbuf: \fI<number>
257 If not 0, then set the SO_RCVBUF socket option to get more buffer
258 space on UDP port 53 incoming queries.  So that short spikes on busy
259 servers do not drop packets (see counter in netstat \-su).  Default is
260 0 (use system value).  Otherwise, the number of bytes to ask for, try
261 "4m" on a busy server.  The OS caps it at a maximum, on linux unbound
262 needs root permission to bypass the limit, or the admin can use sysctl
263 net.core.rmem_max.  On BSD change kern.ipc.maxsockbuf in /etc/sysctl.conf.
264 On OpenBSD change header and recompile kernel. On Solaris ndd \-set
265 /dev/udp udp_max_buf 8388608.
266 .TP
267 .B so\-sndbuf: \fI<number>
268 If not 0, then set the SO_SNDBUF socket option to get more buffer space on
269 UDP port 53 outgoing queries.  This for very busy servers handles spikes
270 in answer traffic, otherwise 'send: resource temporarily unavailable'
271 can get logged, the buffer overrun is also visible by netstat \-su.
272 Default is 0 (use system value).  Specify the number of bytes to ask
273 for, try "4m" on a very busy server.  The OS caps it at a maximum, on
274 linux unbound needs root permission to bypass the limit, or the admin
275 can use sysctl net.core.wmem_max.  On BSD, Solaris changes are similar
276 to so\-rcvbuf.
277 .TP
278 .B so\-reuseport: \fI<yes or no>
279 If yes, then open dedicated listening sockets for incoming queries for each
280 thread and try to set the SO_REUSEPORT socket option on each socket.  May
281 distribute incoming queries to threads more evenly.  Default is no.  On Linux
282 it is supported in kernels >= 3.9.  On other systems, FreeBSD, OSX it may
283 also work.  You can enable it (on any platform and kernel),
284 it then attempts to open the port and passes the option if it was available
285 at compile time, if that works it is used, if it fails, it continues
286 silently (unless verbosity 3) without the option.
287 .TP
288 .B ip\-transparent: \fI<yes or no>
289 If yes, then use IP_TRANSPARENT socket option on sockets where unbound
290 is listening for incoming traffic.  Default no.  Allows you to bind to
291 non\-local interfaces.  For example for non\-existant IP addresses that
292 are going to exist later on, with host failover configuration.  This is
293 a lot like interface\-automatic, but that one services all interfaces
294 and with this option you can select which (future) interfaces unbound
295 provides service on.  This option needs unbound to be started with root
296 permissions on some systems.  The option uses IP_BINDANY on FreeBSD systems.
297 .TP
298 .B ip\-freebind: \fI<yes or no>
299 If yes, then use IP_FREEBIND socket option on sockets where unbound
300 is listening to incoming traffic.  Default no.  Allows you to bind to
301 IP addresses that are nonlocal or do not exist, like when the network
302 interface or IP address is down.  Exists only on Linux, where the similar
303 ip\-transparent option is also available.
304 .TP
305 .B rrset\-cache\-size: \fI<number>
306 Number of bytes size of the RRset cache. Default is 4 megabytes.
307 A plain number is in bytes, append 'k', 'm' or 'g' for kilobytes, megabytes
308 or gigabytes (1024*1024 bytes in a megabyte).
309 .TP
310 .B rrset\-cache\-slabs: \fI<number>
311 Number of slabs in the RRset cache. Slabs reduce lock contention by threads.
312 Must be set to a power of 2.
313 .TP
314 .B cache\-max\-ttl: \fI<seconds>
315 Time to live maximum for RRsets and messages in the cache. Default is
316 86400 seconds (1 day). If the maximum kicks in, responses to clients
317 still get decrementing TTLs based on the original (larger) values.
318 When the internal TTL expires, the cache item has expired.
319 Can be set lower to force the resolver to query for data often, and not
320 trust (very large) TTL values.
321 .TP
322 .B cache\-min\-ttl: \fI<seconds>
323 Time to live minimum for RRsets and messages in the cache. Default is 0.
324 If the minimum kicks in, the data is cached for longer than the domain
325 owner intended, and thus less queries are made to look up the data.
326 Zero makes sure the data in the cache is as the domain owner intended,
327 higher values, especially more than an hour or so, can lead to trouble as
328 the data in the cache does not match up with the actual data any more.
329 .TP
330 .B cache\-max\-negative\-ttl: \fI<seconds>
331 Time to live maximum for negative responses, these have a SOA in the
332 authority section that is limited in time.  Default is 3600.
333 .TP
334 .B infra\-host\-ttl: \fI<seconds>
335 Time to live for entries in the host cache. The host cache contains
336 roundtrip timing, lameness and EDNS support information. Default is 900.
337 .TP
338 .B infra\-cache\-slabs: \fI<number>
339 Number of slabs in the infrastructure cache. Slabs reduce lock contention
340 by threads. Must be set to a power of 2.
341 .TP
342 .B infra\-cache\-numhosts: \fI<number>
343 Number of hosts for which information is cached. Default is 10000.
344 .TP
345 .B infra\-cache\-min\-rtt: \fI<msec>
346 Lower limit for dynamic retransmit timeout calculation in infrastructure
347 cache. Default is 50 milliseconds. Increase this value if using forwarders
348 needing more time to do recursive name resolution.
349 .TP
350 .B define\-tag: \fI<"list of tags">
351 Define the tags that can be used with local\-zone and access\-control.
352 Enclose the list between quotes ("") and put spaces between tags.
353 .TP
354 .B do\-ip4: \fI<yes or no>
355 Enable or disable whether ip4 queries are answered or issued. Default is yes.
356 .TP
357 .B do\-ip6: \fI<yes or no>
358 Enable or disable whether ip6 queries are answered or issued. Default is yes.
359 If disabled, queries are not answered on IPv6, and queries are not sent on
360 IPv6 to the internet nameservers.  With this option you can disable the
361 ipv6 transport for sending DNS traffic, it does not impact the contents of
362 the DNS traffic, which may have ip4 and ip6 addresses in it.
363 .TP
364 .B prefer\-ip6: \fI<yes or no>
365 If enabled, prefer IPv6 transport for sending DNS queries to internet
366 nameservers. Default is no.
367 .TP
368 .B do\-udp: \fI<yes or no>
369 Enable or disable whether UDP queries are answered or issued. Default is yes.
370 .TP
371 .B do\-tcp: \fI<yes or no>
372 Enable or disable whether TCP queries are answered or issued. Default is yes.
373 .TP
374 .B tcp\-mss: \fI<number>
375 Maximum segment size (MSS) of TCP socket on which the server responds
376 to queries. Value lower than common MSS on Ethernet
377 (1220 for example) will address path MTU problem.
378 Note that not all platform supports socket option to set MSS (TCP_MAXSEG).
379 Default is system default MSS determined by interface MTU and
380 negotiation between server and client.
381 .TP
382 .B outgoing\-tcp\-mss: \fI<number>
383 Maximum segment size (MSS) of TCP socket for outgoing queries
384 (from Unbound to other servers). Value lower than
385 common MSS on Ethernet (1220 for example) will address path MTU problem.
386 Note that not all platform supports socket option to set MSS (TCP_MAXSEG).
387 Default is system default MSS determined by interface MTU and
388 negotiation between Unbound and other servers.
389 .TP
390 .B tcp\-upstream: \fI<yes or no>
391 Enable or disable whether the upstream queries use TCP only for transport.
392 Default is no.  Useful in tunneling scenarios.
393 .TP
394 .B ssl\-upstream: \fI<yes or no>
395 Enabled or disable whether the upstream queries use SSL only for transport.
396 Default is no.  Useful in tunneling scenarios.  The SSL contains plain DNS in
397 TCP wireformat.  The other server must support this (see
398 \fBssl\-service\-key\fR).
399 .TP
400 .B ssl\-service-key: \fI<file>
401 If enabled, the server provider SSL service on its TCP sockets.  The clients
402 have to use ssl\-upstream: yes.  The file is the private key for the TLS
403 session.  The public certificate is in the ssl\-service\-pem file.  Default
404 is "", turned off.  Requires a restart (a reload is not enough) if changed,
405 because the private key is read while root permissions are held and before
406 chroot (if any).  Normal DNS TCP service is not provided and gives errors,
407 this service is best run with a different \fBport:\fR config or \fI@port\fR
408 suffixes in the \fBinterface\fR config.
409 .TP
410 .B ssl\-service\-pem: \fI<file>
411 The public key certificate pem file for the ssl service.  Default is "",
412 turned off.
413 .TP
414 .B ssl\-port: \fI<number>
415 The port number on which to provide TCP SSL service, default 853, only
416 interfaces configured with that port number as @number get the SSL service.
417 .TP
418 .B use\-systemd: \fI<yes or no>
419 Enable or disable systemd socket activation.
420 Default is no.
421 .TP
422 .B do\-daemonize: \fI<yes or no>
423 Enable or disable whether the unbound server forks into the background as
424 a daemon.  Set the value to \fIno\fR when unbound runs as systemd service.
425 Default is yes.
426 .TP
427 .B access\-control: \fI<IP netblock> <action>
428 The netblock is given as an IP4 or IP6 address with /size appended for a
429 classless network block. The action can be \fIdeny\fR, \fIrefuse\fR,
430 \fIallow\fR, \fIallow_snoop\fR, \fIdeny_non_local\fR or \fIrefuse_non_local\fR.
431 The most specific netblock match is used, if none match \fIdeny\fR is used.
432 .IP
433 The action \fIdeny\fR stops queries from hosts from that netblock.
434 .IP
435 The action \fIrefuse\fR stops queries too, but sends a DNS rcode REFUSED
436 error message back.
437 .IP
438 The action \fIallow\fR gives access to clients from that netblock.
439 It gives only access for recursion clients (which is
440 what almost all clients need).  Nonrecursive queries are refused.
441 .IP
442 The \fIallow\fR action does allow nonrecursive queries to access the
443 local\-data that is configured.  The reason is that this does not involve
444 the unbound server recursive lookup algorithm, and static data is served
445 in the reply.  This supports normal operations where nonrecursive queries
446 are made for the authoritative data.  For nonrecursive queries any replies
447 from the dynamic cache are refused.
448 .IP
449 The action \fIallow_snoop\fR gives nonrecursive access too.  This give
450 both recursive and non recursive access.  The name \fIallow_snoop\fR refers
451 to cache snooping, a technique to use nonrecursive queries to examine
452 the cache contents (for malicious acts).  However, nonrecursive queries can
453 also be a valuable debugging tool (when you want to examine the cache
454 contents). In that case use \fIallow_snoop\fR for your administration host.
455 .IP
456 By default only localhost is \fIallow\fRed, the rest is \fIrefuse\fRd.
457 The default is \fIrefuse\fRd, because that is protocol\-friendly. The DNS
458 protocol is not designed to handle dropped packets due to policy, and
459 dropping may result in (possibly excessive) retried queries.
460 .IP
461 The deny_non_local and refuse_non_local settings are for hosts that are
462 only allowed to query for the authoritative local\-data, they are not
463 allowed full recursion but only the static data.  With deny_non_local,
464 messages that are disallowed are dropped, with refuse_non_local they
465 receive error code REFUSED.
466 .TP
467 .B access\-control\-tag: \fI<IP netblock> <"list of tags">
468 Assign tags to access-control elements. Clients using this access control
469 element use localzones that are tagged with one of these tags. Tags must be
470 defined in \fIdefine\-tags\fR.  Enclose list of tags in quotes ("") and put
471 spaces between tags. If access\-control\-tag is configured for a netblock that
472 does not have an access\-control, an access\-control element with action
473 \fIallow\fR is configured for this netblock.
474 .TP
475 .B access\-control\-tag\-action: \fI<IP netblock> <tag> <action>
476 Set action for particular tag for given access control element. If you have
477 multiple tag values, the tag used to lookup the action is the first tag match
478 between access\-control\-tag and local\-zone\-tag where "first" comes from the
479 order of the define-tag values.
480 .TP
481 .B access\-control\-tag\-data: \fI<IP netblock> <tag> <"resource record string">
482 Set redirect data for particular tag for given access control element.
483 .TP
484 .B access\-control\-view: \fI<IP netblock> <view name>
485 Set view for given access control element.
486 .TP
487 .B chroot: \fI<directory>
488 If chroot is enabled, you should pass the configfile (from the
489 commandline) as a full path from the original root. After the
490 chroot has been performed the now defunct portion of the config
491 file path is removed to be able to reread the config after a reload.
492 .IP
493 All other file paths (working dir, logfile, roothints, and
494 key files) can be specified in several ways:
495 as an absolute path relative to the new root,
496 as a relative path to the working directory, or
497 as an absolute path relative to the original root.
498 In the last case the path is adjusted to remove the unused portion.
499 .IP
500 The pidfile can be either a relative path to the working directory, or
501 an absolute path relative to the original root. It is written just prior
502 to chroot and dropping permissions. This allows the pidfile to be
503 /var/run/unbound.pid and the chroot to be /var/unbound, for example.
504 .IP
505 Additionally, unbound may need to access /dev/random (for entropy)
506 from inside the chroot.
507 .IP
508 If given a chroot is done to the given directory. The default is
509 "/var/unbound". If you give "" no chroot is performed.
510 .TP
511 .B username: \fI<name>
512 If given, after binding the port the user privileges are dropped. Default is
513 "unbound". If you give username: "" no user change is performed.
514 .IP
515 If this user is not capable of binding the
516 port, reloads (by signal HUP) will still retain the opened ports.
517 If you change the port number in the config file, and that new port number
518 requires privileges, then a reload will fail; a restart is needed.
519 .TP
520 .B directory: \fI<directory>
521 Sets the working directory for the program. Default is "/var/unbound".
522 On Windows the string "%EXECUTABLE%" tries to change to the directory
523 that unbound.exe resides in.
524 If you give a server: directory: dir before include: file statements
525 then those includes can be relative to the working directory.
526 .TP
527 .B logfile: \fI<filename>
528 If "" is given, logging goes to stderr, or nowhere once daemonized.
529 The logfile is appended to, in the following format:
530 .nf
531 [seconds since 1970] unbound[pid:tid]: type: message.
532 .fi
533 If this option is given, the use\-syslog is option is set to "no".
534 The logfile is reopened (for append) when the config file is reread, on
535 SIGHUP.
536 .TP
537 .B use\-syslog: \fI<yes or no>
538 Sets unbound to send log messages to the syslogd, using
539 \fIsyslog\fR(3).
540 The log facility LOG_DAEMON is used, with identity "unbound".
541 The logfile setting is overridden when use\-syslog is turned on.
542 The default is to log to syslog.
543 .TP
544 .B log\-identity: \fI<string>
545 If "" is given (default), then the name of the executable, usually "unbound"
546 is used to report to the log.  Enter a string to override it
547 with that, which is useful on systems that run more than one instance of
548 unbound, with different configurations, so that the logs can be easily
549 distinguished against.
550 .TP
551 .B log\-time\-ascii: \fI<yes or no>
552 Sets logfile lines to use a timestamp in UTC ascii. Default is no, which
553 prints the seconds since 1970 in brackets. No effect if using syslog, in
554 that case syslog formats the timestamp printed into the log files.
555 .TP
556 .B log\-queries: \fI<yes or no>
557 Prints one line per query to the log, with the log timestamp and IP address,
558 name, type and class.  Default is no.  Note that it takes time to print these
559 lines which makes the server (significantly) slower.  Odd (nonprintable)
560 characters in names are printed as '?'.
561 .TP
562 .B log\-replies: \fI<yes or no>
563 Prints one line per reply to the log, with the log timestamp and IP address,
564 name, type, class, return code, time to resolve, from cache and response size.
565 Default is no.  Note that it takes time to print these
566 lines which makes the server (significantly) slower.  Odd (nonprintable)
567 characters in names are printed as '?'.
568 .TP
569 .B pidfile: \fI<filename>
570 The process id is written to the file. Default is "/var/unbound/unbound.pid".
571 So,
572 .nf
573 kill \-HUP `cat /var/unbound/unbound.pid`
574 .fi
575 triggers a reload,
576 .nf
577 kill \-TERM `cat /var/unbound/unbound.pid`
578 .fi
579 gracefully terminates.
580 .TP
581 .B root\-hints: \fI<filename>
582 Read the root hints from this file. Default is nothing, using builtin hints
583 for the IN class. The file has the format of zone files, with root
584 nameserver names and addresses only. The default may become outdated,
585 when servers change, therefore it is good practice to use a root\-hints file.
586 .TP
587 .B hide\-identity: \fI<yes or no>
588 If enabled id.server and hostname.bind queries are refused.
589 .TP
590 .B identity: \fI<string>
591 Set the identity to report. If set to "", the default, then the hostname
592 of the server is returned.
593 .TP
594 .B hide\-version: \fI<yes or no>
595 If enabled version.server and version.bind queries are refused.
596 .TP
597 .B version: \fI<string>
598 Set the version to report. If set to "", the default, then the package
599 version is returned.
600 .TP
601 .B hide\-trustanchor: \fI<yes or no>
602 If enabled trustanchor.unbound queries are refused.
603 .TP
604 .B target\-fetch\-policy: \fI<"list of numbers">
605 Set the target fetch policy used by unbound to determine if it should fetch
606 nameserver target addresses opportunistically. The policy is described per
607 dependency depth.
608 .IP
609 The number of values determines the maximum dependency depth
610 that unbound will pursue in answering a query.
611 A value of \-1 means to fetch all targets opportunistically for that dependency
612 depth. A value of 0 means to fetch on demand only. A positive value fetches
613 that many targets opportunistically.
614 .IP
615 Enclose the list between quotes ("") and put spaces between numbers.
616 The default is "3 2 1 0 0". Setting all zeroes, "0 0 0 0 0" gives behaviour
617 closer to that of BIND 9, while setting "\-1 \-1 \-1 \-1 \-1" gives behaviour
618 rumoured to be closer to that of BIND 8.
619 .TP
620 .B harden\-short\-bufsize: \fI<yes or no>
621 Very small EDNS buffer sizes from queries are ignored. Default is off, since
622 it is legal protocol wise to send these, and unbound tries to give very
623 small answers to these queries, where possible.
624 .TP
625 .B harden\-large\-queries: \fI<yes or no>
626 Very large queries are ignored. Default is off, since it is legal protocol
627 wise to send these, and could be necessary for operation if TSIG or EDNS
628 payload is very large.
629 .TP
630 .B harden\-glue: \fI<yes or no>
631 Will trust glue only if it is within the servers authority. Default is on.
632 .TP
633 .B harden\-dnssec\-stripped: \fI<yes or no>
634 Require DNSSEC data for trust\-anchored zones, if such data is absent,
635 the zone becomes bogus. If turned off, and no DNSSEC data is received
636 (or the DNSKEY data fails to validate), then the zone is made insecure,
637 this behaves like there is no trust anchor. You could turn this off if
638 you are sometimes behind an intrusive firewall (of some sort) that
639 removes DNSSEC data from packets, or a zone changes from signed to
640 unsigned to badly signed often. If turned off you run the risk of a
641 downgrade attack that disables security for a zone. Default is on.
642 .TP
643 .B harden\-below\-nxdomain: \fI<yes or no>
644 From RFC 8020 (with title "NXDOMAIN: There Really Is Nothing Underneath"),
645 returns nxdomain to queries for a name
646 below another name that is already known to be nxdomain.  DNSSEC mandates
647 noerror for empty nonterminals, hence this is possible.  Very old software
648 might return nxdomain for empty nonterminals (that usually happen for reverse
649 IP address lookups), and thus may be incompatible with this.  To try to avoid
650 this only DNSSEC-secure nxdomains are used, because the old software does not
651 have DNSSEC.  Default is off.
652 The nxdomain must be secure, this means nsec3 with optout is insufficient.
653 .TP
654 .B harden\-referral\-path: \fI<yes or no>
655 Harden the referral path by performing additional queries for
656 infrastructure data.  Validates the replies if trust anchors are configured
657 and the zones are signed.  This enforces DNSSEC validation on nameserver
658 NS sets and the nameserver addresses that are encountered on the referral
659 path to the answer.
660 Default off, because it burdens the authority servers, and it is
661 not RFC standard, and could lead to performance problems because of the
662 extra query load that is generated.  Experimental option.
663 If you enable it consider adding more numbers after the target\-fetch\-policy
664 to increase the max depth that is checked to.
665 .TP
666 .B harden\-algo\-downgrade: \fI<yes or no>
667 Harden against algorithm downgrade when multiple algorithms are
668 advertised in the DS record.  If no, allows the weakest algorithm to
669 validate the zone.  Default is no.  Zone signers must produce zones
670 that allow this feature to work, but sometimes they do not, and turning
671 this option off avoids that validation failure.
672 .TP
673 .B use\-caps\-for\-id: \fI<yes or no>
674 Use 0x20\-encoded random bits in the query to foil spoof attempts.
675 This perturbs the lowercase and uppercase of query names sent to
676 authority servers and checks if the reply still has the correct casing.
677 Disabled by default.
678 This feature is an experimental implementation of draft dns\-0x20.
679 .TP
680 .B caps\-whitelist: \fI<domain>
681 Whitelist the domain so that it does not receive caps\-for\-id perturbed
682 queries.  For domains that do not support 0x20 and also fail with fallback
683 because they keep sending different answers, like some load balancers.
684 Can be given multiple times, for different domains.
685 .TP
686 .B qname\-minimisation: \fI<yes or no>
687 Send minimum amount of information to upstream servers to enhance privacy.
688 Only sent minimum required labels of the QNAME and set QTYPE to NS when
689 possible. Best effort approach; full QNAME and original QTYPE will be sent when
690 upstream replies with a RCODE other than NOERROR, except when receiving
691 NXDOMAIN from a DNSSEC signed zone. Default is off.
692 .TP
693 .B qname\-minimisation\-strict: \fI<yes or no>
694 QNAME minimisation in strict mode. Do not fall-back to sending full QNAME to
695 potentially broken nameservers. A lot of domains will not be resolvable when
696 this option in enabled. Only use if you know what you are doing.
697 This option only has effect when qname-minimisation is enabled. Default is off.
698 .TP
699 .B private\-address: \fI<IP address or subnet>
700 Give IPv4 of IPv6 addresses or classless subnets. These are addresses
701 on your private network, and are not allowed to be returned for
702 public internet names.  Any occurrence of such addresses are removed
703 from DNS answers. Additionally, the DNSSEC validator may mark the
704 answers bogus. This protects against so\-called DNS Rebinding, where
705 a user browser is turned into a network proxy, allowing remote access
706 through the browser to other parts of your private network.  Some names
707 can be allowed to contain your private addresses, by default all the
708 \fBlocal\-data\fR that you configured is allowed to, and you can specify
709 additional names using \fBprivate\-domain\fR.  No private addresses are
710 enabled by default.  We consider to enable this for the RFC1918 private
711 IP address space by default in later releases. That would enable private
712 addresses for 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 169.254.0.0/16
713 fd00::/8 and fe80::/10, since the RFC standards say these addresses
714 should not be visible on the public internet.  Turning on 127.0.0.0/8
715 would hinder many spamblocklists as they use that.  Adding ::ffff:0:0/96
716 stops IPv4-mapped IPv6 addresses from bypassing the filter.
717 .TP
718 .B private\-domain: \fI<domain name>
719 Allow this domain, and all its subdomains to contain private addresses.
720 Give multiple times to allow multiple domain names to contain private
721 addresses. Default is none.
722 .TP
723 .B unwanted\-reply\-threshold: \fI<number>
724 If set, a total number of unwanted replies is kept track of in every thread.
725 When it reaches the threshold, a defensive action is taken and a warning
726 is printed to the log.  The defensive action is to clear the rrset and
727 message caches, hopefully flushing away any poison.  A value of 10 million
728 is suggested.  Default is 0 (turned off).
729 .TP
730 .B do\-not\-query\-address: \fI<IP address>
731 Do not query the given IP address. Can be IP4 or IP6. Append /num to
732 indicate a classless delegation netblock, for example like
733 10.2.3.4/24 or 2001::11/64.
734 .TP
735 .B do\-not\-query\-localhost: \fI<yes or no>
736 If yes, localhost is added to the do\-not\-query\-address entries, both
737 IP6 ::1 and IP4 127.0.0.1/8. If no, then localhost can be used to send
738 queries to. Default is yes.
739 .TP
740 .B prefetch: \fI<yes or no>
741 If yes, message cache elements are prefetched before they expire to
742 keep the cache up to date.  Default is no.  Turning it on gives about
743 10 percent more traffic and load on the machine, but popular items do
744 not expire from the cache.
745 .TP
746 .B prefetch-key: \fI<yes or no>
747 If yes, fetch the DNSKEYs earlier in the validation process, when a DS
748 record is encountered.  This lowers the latency of requests.  It does use
749 a little more CPU.  Also if the cache is set to 0, it is no use. Default is no.
750 .TP
751 .B rrset-roundrobin: \fI<yes or no>
752 If yes, Unbound rotates RRSet order in response (the random number is taken
753 from the query ID, for speed and thread safety).  Default is no.
754 .TP
755 .B minimal-responses: \fI<yes or no>
756 If yes, Unbound doesn't insert authority/additional sections into response
757 messages when those sections are not required.  This reduces response
758 size significantly, and may avoid TCP fallback for some responses.
759 This may cause a slight speedup.  The default is no, because the DNS
760 protocol RFCs mandate these sections, and the additional content could
761 be of use and save roundtrips for clients.
762 .TP
763 .B disable-dnssec-lame-check: \fI<yes or no>
764 If true, disables the DNSSEC lameness check in the iterator.  This check
765 sees if RRSIGs are present in the answer, when dnssec is expected,
766 and retries another authority if RRSIGs are unexpectedly missing.
767 The validator will insist in RRSIGs for DNSSEC signed domains regardless
768 of this setting, if a trust anchor is loaded.
769 .TP
770 .B module\-config: \fI<"module names">
771 Module configuration, a list of module names separated by spaces, surround
772 the string with quotes (""). The modules can be validator, iterator.
773 Setting this to "iterator" will result in a non\-validating server.
774 Setting this to "validator iterator" will turn on DNSSEC validation.
775 The ordering of the modules is important.
776 You must also set trust\-anchors for validation to be useful.
777 .TP
778 .B trust\-anchor\-file: \fI<filename>
779 File with trusted keys for validation. Both DS and DNSKEY entries can appear
780 in the file. The format of the file is the standard DNS Zone file format.
781 Default is "", or no trust anchor file.
782 .TP
783 .B auto\-trust\-anchor\-file: \fI<filename>
784 File with trust anchor for one zone, which is tracked with RFC5011 probes.
785 The probes are several times per month, thus the machine must be online
786 frequently.  The initial file can be one with contents as described in
787 \fBtrust\-anchor\-file\fR.  The file is written to when the anchor is updated,
788 so the unbound user must have write permission.  Write permission to the file,
789 but also to the directory it is in (to create a temporary file, which is
790 necessary to deal with filesystem full events), it must also be inside the
791 chroot (if that is used).
792 .TP
793 .B trust\-anchor: \fI<"Resource Record">
794 A DS or DNSKEY RR for a key to use for validation. Multiple entries can be
795 given to specify multiple trusted keys, in addition to the trust\-anchor\-files.
796 The resource record is entered in the same format as 'dig' or 'drill' prints
797 them, the same format as in the zone file. Has to be on a single line, with
798 "" around it. A TTL can be specified for ease of cut and paste, but is ignored.
799 A class can be specified, but class IN is default.
800 .TP
801 .B trusted\-keys\-file: \fI<filename>
802 File with trusted keys for validation. Specify more than one file
803 with several entries, one file per entry. Like \fBtrust\-anchor\-file\fR
804 but has a different file format. Format is BIND\-9 style format,
805 the trusted\-keys { name flag proto algo "key"; }; clauses are read.
806 It is possible to use wildcards with this statement, the wildcard is
807 expanded on start and on reload.
808 .TP
809 .B trust\-anchor\-signaling: \fI<yes or no>
810 Send RFC8145 key tag query after trust anchor priming. Default is off.
811 .TP
812 .B dlv\-anchor\-file: \fI<filename>
813 This option was used during early days DNSSEC deployment when no parent-side
814 DS record registrations were easily available.  Nowadays, it is best to have
815 DS records registered with the parent zone (many top level zones are signed).
816 File with trusted keys for DLV (DNSSEC Lookaside Validation). Both DS and
817 DNSKEY entries can be used in the file, in the same format as for
818 \fItrust\-anchor\-file:\fR statements. Only one DLV can be configured, more
819 would be slow. The DLV configured is used as a root trusted DLV, this
820 means that it is a lookaside for the root. Default is "", or no dlv anchor
821 file. DLV is going to be decommissioned.  Please do not use it any more.
822 .TP
823 .B dlv\-anchor: \fI<"Resource Record">
824 Much like trust\-anchor, this is a DLV anchor with the DS or DNSKEY inline.
825 DLV is going to be decommissioned.  Please do not use it any more.
826 .TP
827 .B domain\-insecure: \fI<domain name>
828 Sets domain name to be insecure, DNSSEC chain of trust is ignored towards
829 the domain name.  So a trust anchor above the domain name can not make the
830 domain secure with a DS record, such a DS record is then ignored.
831 Also keys from DLV are ignored for the domain.  Can be given multiple times
832 to specify multiple domains that are treated as if unsigned.  If you set
833 trust anchors for the domain they override this setting (and the domain
834 is secured).
835 .IP
836 This can be useful if you want to make sure a trust anchor for external
837 lookups does not affect an (unsigned) internal domain.  A DS record
838 externally can create validation failures for that internal domain.
839 .TP
840 .B val\-override\-date: \fI<rrsig\-style date spec>
841 Default is "" or "0", which disables this debugging feature. If enabled by
842 giving a RRSIG style date, that date is used for verifying RRSIG inception
843 and expiration dates, instead of the current date. Do not set this unless
844 you are debugging signature inception and expiration. The value \-1 ignores
845 the date altogether, useful for some special applications.
846 .TP
847 .B val\-sig\-skew\-min: \fI<seconds>
848 Minimum number of seconds of clock skew to apply to validated signatures.
849 A value of 10% of the signature lifetime (expiration \- inception) is
850 used, capped by this setting.  Default is 3600 (1 hour) which allows for
851 daylight savings differences.  Lower this value for more strict checking
852 of short lived signatures.
853 .TP
854 .B val\-sig\-skew\-max: \fI<seconds>
855 Maximum number of seconds of clock skew to apply to validated signatures.
856 A value of 10% of the signature lifetime (expiration \- inception)
857 is used, capped by this setting.  Default is 86400 (24 hours) which
858 allows for timezone setting problems in stable domains.  Setting both
859 min and max very low disables the clock skew allowances.  Setting both
860 min and max very high makes the validator check the signature timestamps
861 less strictly.
862 .TP
863 .B val\-bogus\-ttl: \fI<number>
864 The time to live for bogus data. This is data that has failed validation;
865 due to invalid signatures or other checks. The TTL from that data cannot be
866 trusted, and this value is used instead. The value is in seconds, default 60.
867 The time interval prevents repeated revalidation of bogus data.
868 .TP
869 .B val\-clean\-additional: \fI<yes or no>
870 Instruct the validator to remove data from the additional section of secure
871 messages that are not signed properly. Messages that are insecure, bogus,
872 indeterminate or unchecked are not affected. Default is yes. Use this setting
873 to protect the users that rely on this validator for authentication from
874 potentially bad data in the additional section.
875 .TP
876 .B val\-log\-level: \fI<number>
877 Have the validator print validation failures to the log.  Regardless of
878 the verbosity setting.  Default is 0, off.  At 1, for every user query
879 that fails a line is printed to the logs.  This way you can monitor what
880 happens with validation.  Use a diagnosis tool, such as dig or drill,
881 to find out why validation is failing for these queries.  At 2, not only
882 the query that failed is printed but also the reason why unbound thought
883 it was wrong and which server sent the faulty data.
884 .TP
885 .B val\-permissive\-mode: \fI<yes or no>
886 Instruct the validator to mark bogus messages as indeterminate. The security
887 checks are performed, but if the result is bogus (failed security), the
888 reply is not withheld from the client with SERVFAIL as usual. The client
889 receives the bogus data. For messages that are found to be secure the AD bit
890 is set in replies. Also logging is performed as for full validation.
891 The default value is "no".
892 .TP
893 .B ignore\-cd\-flag: \fI<yes or no>
894 Instruct unbound to ignore the CD flag from clients and refuse to
895 return bogus answers to them.  Thus, the CD (Checking Disabled) flag
896 does not disable checking any more.  This is useful if legacy (w2008)
897 servers that set the CD flag but cannot validate DNSSEC themselves are
898 the clients, and then unbound provides them with DNSSEC protection.
899 The default value is "no".
900 .TP
901 .B serve\-expired: \fI<yes or no>
902 If enabled, unbound attempts to serve old responses from cache with a
903 TTL of 0 in the response without waiting for the actual resolution to finish.
904 The actual resolution answer ends up in the cache later on.  Default is "no".
905 .TP
906 .B val\-nsec3\-keysize\-iterations: \fI<"list of values">
907 List of keysize and iteration count values, separated by spaces, surrounded
908 by quotes. Default is "1024 150 2048 500 4096 2500". This determines the
909 maximum allowed NSEC3 iteration count before a message is simply marked
910 insecure instead of performing the many hashing iterations. The list must
911 be in ascending order and have at least one entry. If you set it to
912 "1024 65535" there is no restriction to NSEC3 iteration values.
913 This table must be kept short; a very long list could cause slower operation.
914 .TP
915 .B add\-holddown: \fI<seconds>
916 Instruct the \fBauto\-trust\-anchor\-file\fR probe mechanism for RFC5011
917 autotrust updates to add new trust anchors only after they have been
918 visible for this time.  Default is 30 days as per the RFC.
919 .TP
920 .B del\-holddown: \fI<seconds>
921 Instruct the \fBauto\-trust\-anchor\-file\fR probe mechanism for RFC5011
922 autotrust updates to remove revoked trust anchors after they have been
923 kept in the revoked list for this long.  Default is 30 days as per
924 the RFC.
925 .TP
926 .B keep\-missing: \fI<seconds>
927 Instruct the \fBauto\-trust\-anchor\-file\fR probe mechanism for RFC5011
928 autotrust updates to remove missing trust anchors after they have been
929 unseen for this long.  This cleans up the state file if the target zone
930 does not perform trust anchor revocation, so this makes the auto probe
931 mechanism work with zones that perform regular (non\-5011) rollovers.
932 The default is 366 days.  The value 0 does not remove missing anchors,
933 as per the RFC.
934 .TP
935 .B permit\-small\-holddown: \fI<yes or no>
936 Debug option that allows the autotrust 5011 rollover timers to assume
937 very small values.  Default is no.
938 .TP
939 .B key\-cache\-size: \fI<number>
940 Number of bytes size of the key cache. Default is 4 megabytes.
941 A plain number is in bytes, append 'k', 'm' or 'g' for kilobytes, megabytes
942 or gigabytes (1024*1024 bytes in a megabyte).
943 .TP
944 .B key\-cache\-slabs: \fI<number>
945 Number of slabs in the key cache. Slabs reduce lock contention by threads.
946 Must be set to a power of 2. Setting (close) to the number of cpus is a
947 reasonable guess.
948 .TP
949 .B neg\-cache\-size: \fI<number>
950 Number of bytes size of the aggressive negative cache. Default is 1 megabyte.
951 A plain number is in bytes, append 'k', 'm' or 'g' for kilobytes, megabytes
952 or gigabytes (1024*1024 bytes in a megabyte).
953 .TP
954 .B unblock\-lan\-zones: \fI<yesno>
955 Default is disabled.  If enabled, then for private address space,
956 the reverse lookups are no longer filtered.  This allows unbound when
957 running as dns service on a host where it provides service for that host,
958 to put out all of the queries for the 'lan' upstream.  When enabled,
959 only localhost, 127.0.0.1 reverse and ::1 reverse zones are configured
960 with default local zones.  Disable the option when unbound is running
961 as a (DHCP-) DNS network resolver for a group of machines, where such
962 lookups should be filtered (RFC compliance), this also stops potential
963 data leakage about the local network to the upstream DNS servers.
964 .TP
965 .B insecure\-lan\-zones: \fI<yesno>
966 Default is disabled.  If enabled, then reverse lookups in private
967 address space are not validated.  This is usually required whenever
968 \fIunblock\-lan\-zones\fR is used.
969 .TP
970 .B local\-zone: \fI<zone> <type>
971 Configure a local zone. The type determines the answer to give if
972 there is no match from local\-data. The types are deny, refuse, static,
973 transparent, redirect, nodefault, typetransparent, inform, inform_deny,
974 always_transparent, always_refuse, always_nxdomain,
975 and are explained below. After that the default settings are listed. Use
976 local\-data: to enter data into the local zone. Answers for local zones
977 are authoritative DNS answers. By default the zones are class IN.
978 .IP
979 If you need more complicated authoritative data, with referrals, wildcards,
980 CNAME/DNAME support, or DNSSEC authoritative service, setup a stub\-zone for
981 it as detailed in the stub zone section below.
982 .TP 10
983 \h'5'\fIdeny\fR
984 Do not send an answer, drop the query.
985 If there is a match from local data, the query is answered.
986 .TP 10
987 \h'5'\fIrefuse\fR
988 Send an error message reply, with rcode REFUSED.
989 If there is a match from local data, the query is answered.
990 .TP 10
991 \h'5'\fIstatic\fR
992 If there is a match from local data, the query is answered.
993 Otherwise, the query is answered with nodata or nxdomain.
994 For a negative answer a SOA is included in the answer if present
995 as local\-data for the zone apex domain.
996 .TP 10
997 \h'5'\fItransparent\fR
998 If there is a match from local data, the query is answered.
999 Otherwise if the query has a different name, the query is resolved normally.
1000 If the query is for a name given in localdata but no such type of data is
1001 given in localdata, then a noerror nodata answer is returned.
1002 If no local\-zone is given local\-data causes a transparent zone
1003 to be created by default.
1004 .TP 10
1005 \h'5'\fItypetransparent\fR
1006 If there is a match from local data, the query is answered.  If the query
1007 is for a different name, or for the same name but for a different type,
1008 the query is resolved normally.  So, similar to transparent but types
1009 that are not listed in local data are resolved normally, so if an A record
1010 is in the local data that does not cause a nodata reply for AAAA queries.
1011 .TP 10
1012 \h'5'\fIredirect\fR
1013 The query is answered from the local data for the zone name.
1014 There may be no local data beneath the zone name.
1015 This answers queries for the zone, and all subdomains of the zone
1016 with the local data for the zone.
1017 It can be used to redirect a domain to return a different address record
1018 to the end user, with
1019 local\-zone: "example.com." redirect and
1020 local\-data: "example.com. A 127.0.0.1"
1021 queries for www.example.com and www.foo.example.com are redirected, so
1022 that users with web browsers cannot access sites with suffix example.com.
1023 .TP 10
1024 \h'5'\fIinform\fR
1025 The query is answered normally, same as transparent.  The client IP
1026 address (@portnumber) is printed to the logfile.  The log message is:
1027 timestamp, unbound-pid, info: zonename inform IP@port queryname type
1028 class.  This option can be used for normal resolution, but machines
1029 looking up infected names are logged, eg. to run antivirus on them.
1030 .TP 10
1031 \h'5'\fIinform_deny\fR
1032 The query is dropped, like 'deny', and logged, like 'inform'.  Ie. find
1033 infected machines without answering the queries.
1034 .TP 10
1035 \h'5'\fIalways_transparent\fR
1036 Like transparent, but ignores local data and resolves normally.
1037 .TP 10
1038 \h'5'\fIalways_refuse\fR
1039 Like refuse, but ignores local data and refuses the query.
1040 .TP 10
1041 \h'5'\fIalways_nxdomain\fR
1042 Like static, but ignores local data and returns nxdomain for the query.
1043 .TP 10
1044 \h'5'\fInodefault\fR
1045 Used to turn off default contents for AS112 zones. The other types
1046 also turn off default contents for the zone. The 'nodefault' option
1047 has no other effect than turning off default contents for the
1048 given zone.  Use \fInodefault\fR if you use exactly that zone, if you want to
1049 use a subzone, use \fItransparent\fR.
1050 .P
1051 The default zones are localhost, reverse 127.0.0.1 and ::1, the onion and
1052 the AS112 zones. The AS112 zones are reverse DNS zones for private use and
1053 reserved IP addresses for which the servers on the internet cannot provide
1054 correct answers. They are configured by default to give nxdomain (no reverse
1055 information) answers. The defaults can be turned off by specifying your
1056 own local\-zone of that name, or using the 'nodefault' type. Below is a
1057 list of the default zone contents.
1058 .TP 10
1059 \h'5'\fIlocalhost\fR
1060 The IP4 and IP6 localhost information is given. NS and SOA records are provided
1061 for completeness and to satisfy some DNS update tools. Default content:
1062 .nf
1063 local\-zone: "localhost." static
1064 local\-data: "localhost. 10800 IN NS localhost."
1065 local\-data: "localhost. 10800 IN
1066     SOA localhost. nobody.invalid. 1 3600 1200 604800 10800"
1067 local\-data: "localhost. 10800 IN A 127.0.0.1"
1068 local\-data: "localhost. 10800 IN AAAA ::1"
1069 .fi
1070 .TP 10
1071 \h'5'\fIreverse IPv4 loopback\fR
1072 Default content:
1073 .nf
1074 local\-zone: "127.in\-addr.arpa." static
1075 local\-data: "127.in\-addr.arpa. 10800 IN NS localhost."
1076 local\-data: "127.in\-addr.arpa. 10800 IN
1077     SOA localhost. nobody.invalid. 1 3600 1200 604800 10800"
1078 local\-data: "1.0.0.127.in\-addr.arpa. 10800 IN
1079     PTR localhost."
1080 .fi
1081 .TP 10
1082 \h'5'\fIreverse IPv6 loopback\fR
1083 Default content:
1084 .nf
1085 local\-zone: "1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.
1086     0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa." static
1087 local\-data: "1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.
1088     0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa. 10800 IN
1089     NS localhost."
1090 local\-data: "1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.
1091     0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa. 10800 IN
1092     SOA localhost. nobody.invalid. 1 3600 1200 604800 10800"
1093 local\-data: "1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.
1094     0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa. 10800 IN
1095     PTR localhost."
1096 .fi
1097 .TP 10
1098 \h'5'\fIonion (RFC 7686)\fR
1099 Default content:
1100 .nf
1101 local\-zone: "onion." static
1102 local\-data: "onion. 10800 IN NS localhost."
1103 local\-data: "onion. 10800 IN
1104     SOA localhost. nobody.invalid. 1 3600 1200 604800 10800"
1105 .fi
1106 .TP 10
1107 \h'5'\fIreverse RFC1918 local use zones\fR
1108 Reverse data for zones 10.in\-addr.arpa, 16.172.in\-addr.arpa to
1109 31.172.in\-addr.arpa, 168.192.in\-addr.arpa.
1110 The \fBlocal\-zone:\fR is set static and as \fBlocal\-data:\fR SOA and NS
1111 records are provided.
1112 .TP 10
1113 \h'5'\fIreverse RFC3330 IP4 this, link\-local, testnet and broadcast\fR
1114 Reverse data for zones 0.in\-addr.arpa, 254.169.in\-addr.arpa,
1115 2.0.192.in\-addr.arpa (TEST NET 1), 100.51.198.in\-addr.arpa (TEST NET 2),
1116 113.0.203.in\-addr.arpa (TEST NET 3), 255.255.255.255.in\-addr.arpa.
1117 And from 64.100.in\-addr.arpa to 127.100.in\-addr.arpa (Shared Address Space).
1118 .TP 10
1119 \h'5'\fIreverse RFC4291 IP6 unspecified\fR
1120 Reverse data for zone
1121 .nf
1122 0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.
1123 0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa.
1124 .fi
1125 .TP 10
1126 \h'5'\fIreverse RFC4193 IPv6 Locally Assigned Local Addresses\fR
1127 Reverse data for zone D.F.ip6.arpa.
1128 .TP 10
1129 \h'5'\fIreverse RFC4291 IPv6 Link Local Addresses\fR
1130 Reverse data for zones 8.E.F.ip6.arpa to B.E.F.ip6.arpa.
1131 .TP 10
1132 \h'5'\fIreverse IPv6 Example Prefix\fR
1133 Reverse data for zone 8.B.D.0.1.0.0.2.ip6.arpa. This zone is used for
1134 tutorials and examples. You can remove the block on this zone with:
1135 .nf
1136   local\-zone: 8.B.D.0.1.0.0.2.ip6.arpa. nodefault
1137 .fi
1138 You can also selectively unblock a part of the zone by making that part
1139 transparent with a local\-zone statement.
1140 This also works with the other default zones.
1141 .\" End of local-zone listing.
1142 .TP 5
1143 .B local\-data: \fI"<resource record string>"
1144 Configure local data, which is served in reply to queries for it.
1145 The query has to match exactly unless you configure the local\-zone as
1146 redirect. If not matched exactly, the local\-zone type determines
1147 further processing. If local\-data is configured that is not a subdomain of
1148 a local\-zone, a transparent local\-zone is configured.
1149 For record types such as TXT, use single quotes, as in
1150 local\-data: 'example. TXT "text"'.
1151 .IP
1152 If you need more complicated authoritative data, with referrals, wildcards,
1153 CNAME/DNAME support, or DNSSEC authoritative service, setup a stub\-zone for
1154 it as detailed in the stub zone section below.
1155 .TP 5
1156 .B local\-data\-ptr: \fI"IPaddr name"
1157 Configure local data shorthand for a PTR record with the reversed IPv4 or
1158 IPv6 address and the host name.  For example "192.0.2.4 www.example.com".
1159 TTL can be inserted like this: "2001:DB8::4 7200 www.example.com"
1160 .TP 5
1161 .B local\-zone\-tag: \fI<zone> <"list of tags">
1162 Assign tags to localzones. Tagged localzones will only be applied when the
1163 used access-control element has a matching tag. Tags must be defined in
1164 \fIdefine\-tags\fR.  Enclose list of tags in quotes ("") and put spaces between
1165 tags.
1166 .TP 5
1167 .B local\-zone\-override: \fI<zone> <IP netblock> <type>
1168 Override the localzone type for queries from addresses matching netblock.
1169 Use this localzone type, regardless the type configured for the local-zone
1170 (both tagged and untagged) and regardless the type configured using
1171 access\-control\-tag\-action.
1172 .TP 5
1173 .B ratelimit: \fI<number or 0>
1174 Enable ratelimiting of queries sent to nameserver for performing recursion.
1175 If 0, the default, it is disabled.  This option is experimental at this time.
1176 The ratelimit is in queries per second that are allowed.  More queries are
1177 turned away with an error (servfail).  This stops recursive floods, eg. random
1178 query names, but not spoofed reflection floods.  Cached responses are not
1179 ratelimited by this setting.  The zone of the query is determined by examining
1180 the nameservers for it, the zone name is used to keep track of the rate.
1181 For example, 1000 may be a suitable value to stop the server from being
1182 overloaded with random names, and keeps unbound from sending traffic to the
1183 nameservers for those zones.
1184 .TP 5
1185 .B ratelimit\-size: \fI<memory size>
1186 Give the size of the data structure in which the current ongoing rates are
1187 kept track in.  Default 4m.  In bytes or use m(mega), k(kilo), g(giga).
1188 The ratelimit structure is small, so this data structure likely does
1189 not need to be large.
1190 .TP 5
1191 .B ratelimit\-slabs: \fI<number>
1192 Give power of 2 number of slabs, this is used to reduce lock contention
1193 in the ratelimit tracking data structure.  Close to the number of cpus is
1194 a fairly good setting.
1195 .TP 5
1196 .B ratelimit\-factor: \fI<number>
1197 Set the amount of queries to rate limit when the limit is exceeded.
1198 If set to 0, all queries are dropped for domains where the limit is
1199 exceeded.  If set to another value, 1 in that number is allowed through
1200 to complete.  Default is 10, allowing 1/10 traffic to flow normally.
1201 This can make ordinary queries complete (if repeatedly queried for),
1202 and enter the cache, whilst also mitigating the traffic flow by the
1203 factor given.
1204 .TP 5
1205 .B ratelimit\-for\-domain: \fI<domain> <number qps or 0>
1206 Override the global ratelimit for an exact match domain name with the listed
1207 number.  You can give this for any number of names.  For example, for
1208 a top\-level\-domain you may want to have a higher limit than other names.
1209 A value of 0 will disable ratelimiting for that domain.
1210 .TP 5
1211 .B ratelimit\-below\-domain: \fI<domain> <number qps or 0>
1212 Override the global ratelimit for a domain name that ends in this name.
1213 You can give this multiple times, it then describes different settings
1214 in different parts of the namespace.  The closest matching suffix is used
1215 to determine the qps limit.  The rate for the exact matching domain name
1216 is not changed, use ratelimit\-for\-domain to set that, you might want
1217 to use different settings for a top\-level\-domain and subdomains.
1218 A value of 0 will disable ratelimiting for domain names that end in this name.
1219 .TP 5
1220 .B ip\-ratelimit: \fI<number or 0>
1221 Enable global ratelimiting of queries accepted per ip address.
1222 If 0, the default, it is disabled.  This option is experimental at this time.
1223 The ratelimit is in queries per second that are allowed.  More queries are
1224 completely dropped and will not receive a reply, SERVFAIL or otherwise.
1225 IP ratelimiting happens before looking in the cache. This may be useful for
1226 mitigating amplification attacks.
1227 .TP 5
1228 .B ip\-ratelimit\-size: \fI<memory size>
1229 Give the size of the data structure in which the current ongoing rates are
1230 kept track in.  Default 4m.  In bytes or use m(mega), k(kilo), g(giga).
1231 The ip ratelimit structure is small, so this data structure likely does
1232 not need to be large.
1233 .TP 5
1234 .B ip\-ratelimit\-slabs: \fI<number>
1235 Give power of 2 number of slabs, this is used to reduce lock contention
1236 in the ip ratelimit tracking data structure.  Close to the number of cpus is
1237 a fairly good setting.
1238 .TP 5
1239 .B ip\-ratelimit\-factor: \fI<number>
1240 Set the amount of queries to rate limit when the limit is exceeded.
1241 If set to 0, all queries are dropped for addresses where the limit is
1242 exceeded.  If set to another value, 1 in that number is allowed through
1243 to complete.  Default is 10, allowing 1/10 traffic to flow normally.
1244 This can make ordinary queries complete (if repeatedly queried for),
1245 and enter the cache, whilst also mitigating the traffic flow by the
1246 factor given.
1247 .SS "Remote Control Options"
1248 In the
1249 .B remote\-control:
1250 clause are the declarations for the remote control facility.  If this is
1251 enabled, the \fIunbound\-control\fR(8) utility can be used to send
1252 commands to the running unbound server.  The server uses these clauses
1253 to setup SSLv3 / TLSv1 security for the connection.  The
1254 \fIunbound\-control\fR(8) utility also reads the \fBremote\-control\fR
1255 section for options.  To setup the correct self\-signed certificates use the
1256 \fIunbound\-control\-setup\fR(8) utility.
1257 .TP 5
1258 .B control\-enable: \fI<yes or no>
1259 The option is used to enable remote control, default is "no".
1260 If turned off, the server does not listen for control commands.
1261 .TP 5
1262 .B control\-interface: \fI<ip address or path>
1263 Give IPv4 or IPv6 addresses or local socket path to listen on for
1264 control commands.
1265 By default localhost (127.0.0.1 and ::1) is listened to.
1266 Use 0.0.0.0 and ::0 to listen to all interfaces.
1267 If you change this and permissions have been dropped, you must restart
1268 the server for the change to take effect.
1269 .TP 5
1270 .B control\-port: \fI<port number>
1271 The port number to listen on for IPv4 or IPv6 control interfaces,
1272 default is 8953.
1273 If you change this and permissions have been dropped, you must restart
1274 the server for the change to take effect.
1275 .TP 5
1276 .B control\-use\-cert: \fI<yes or no>
1277 Whether to require certificate authentication of control connections.
1278 The default is "yes".
1279 This should not be changed unless there are other mechanisms in place
1280 to prevent untrusted users from accessing the remote control
1281 interface.
1282 .TP 5
1283 .B server\-key\-file: \fI<private key file>
1284 Path to the server private key, by default unbound_server.key.
1285 This file is generated by the \fIunbound\-control\-setup\fR utility.
1286 This file is used by the unbound server, but not by \fIunbound\-control\fR.
1287 .TP 5
1288 .B server\-cert\-file: \fI<certificate file.pem>
1289 Path to the server self signed certificate, by default unbound_server.pem.
1290 This file is generated by the \fIunbound\-control\-setup\fR utility.
1291 This file is used by the unbound server, and also by \fIunbound\-control\fR.
1292 .TP 5
1293 .B control\-key\-file: \fI<private key file>
1294 Path to the control client private key, by default unbound_control.key.
1295 This file is generated by the \fIunbound\-control\-setup\fR utility.
1296 This file is used by \fIunbound\-control\fR.
1297 .TP 5
1298 .B control\-cert\-file: \fI<certificate file.pem>
1299 Path to the control client certificate, by default unbound_control.pem.
1300 This certificate has to be signed with the server certificate.
1301 This file is generated by the \fIunbound\-control\-setup\fR utility.
1302 This file is used by \fIunbound\-control\fR.
1303 .SS "Stub Zone Options"
1304 .LP
1305 There may be multiple
1306 .B stub\-zone:
1307 clauses. Each with a name: and zero or more hostnames or IP addresses.
1308 For the stub zone this list of nameservers is used. Class IN is assumed.
1309 The servers should be authority servers, not recursors; unbound performs
1310 the recursive processing itself for stub zones.
1311 .P
1312 The stub zone can be used to configure authoritative data to be used
1313 by the resolver that cannot be accessed using the public internet servers.
1314 This is useful for company\-local data or private zones. Setup an
1315 authoritative server on a different host (or different port). Enter a config
1316 entry for unbound with
1317 .B stub\-addr:
1318 <ip address of host[@port]>.
1319 The unbound resolver can then access the data, without referring to the
1320 public internet for it.
1321 .P
1322 This setup allows DNSSEC signed zones to be served by that
1323 authoritative server, in which case a trusted key entry with the public key
1324 can be put in config, so that unbound can validate the data and set the AD
1325 bit on replies for the private zone (authoritative servers do not set the
1326 AD bit).  This setup makes unbound capable of answering queries for the
1327 private zone, and can even set the AD bit ('authentic'), but the AA
1328 ('authoritative') bit is not set on these replies.
1329 .P
1330 Consider adding \fBserver:\fR statements for \fBdomain\-insecure:\fR and
1331 for \fBlocal\-zone:\fI name nodefault\fR for the zone if it is a locally
1332 served zone.  The insecure clause stops DNSSEC from invalidating the
1333 zone.  The local zone nodefault (or \fItransparent\fR) clause makes the
1334 (reverse\-) zone bypass unbound's filtering of RFC1918 zones.
1335 .TP
1336 .B name: \fI<domain name>
1337 Name of the stub zone.
1338 .TP
1339 .B stub\-host: \fI<domain name>
1340 Name of stub zone nameserver. Is itself resolved before it is used.
1341 .TP
1342 .B stub\-addr: \fI<IP address>
1343 IP address of stub zone nameserver. Can be IP 4 or IP 6.
1344 To use a nondefault port for DNS communication append '@' with the port number.
1345 .TP
1346 .B stub\-prime: \fI<yes or no>
1347 This option is by default off.  If enabled it performs NS set priming,
1348 which is similar to root hints, where it starts using the list of nameservers
1349 currently published by the zone.  Thus, if the hint list is slightly outdated,
1350 the resolver picks up a correct list online.
1351 .TP
1352 .B stub\-first: \fI<yes or no>
1353 If enabled, a query is attempted without the stub clause if it fails.
1354 The data could not be retrieved and would have caused SERVFAIL because
1355 the servers are unreachable, instead it is tried without this clause.
1356 The default is no.
1357 .TP
1358 .B stub\-ssl\-upstream: \fI<yes or no>
1359 Enabled or disable whether the queries to this stub use SSL for transport.
1360 Default is no.
1361 .SS "Forward Zone Options"
1362 .LP
1363 There may be multiple
1364 .B forward\-zone:
1365 clauses. Each with a \fBname:\fR and zero or more hostnames or IP
1366 addresses.  For the forward zone this list of nameservers is used to
1367 forward the queries to. The servers listed as \fBforward\-host:\fR and
1368 \fBforward\-addr:\fR have to handle further recursion for the query.  Thus,
1369 those servers are not authority servers, but are (just like unbound is)
1370 recursive servers too; unbound does not perform recursion itself for the
1371 forward zone, it lets the remote server do it.  Class IN is assumed.
1372 A forward\-zone entry with name "." and a forward\-addr target will
1373 forward all queries to that other server (unless it can answer from
1374 the cache).
1375 .TP
1376 .B name: \fI<domain name>
1377 Name of the forward zone.
1378 .TP
1379 .B forward\-host: \fI<domain name>
1380 Name of server to forward to. Is itself resolved before it is used.
1381 .TP
1382 .B forward\-addr: \fI<IP address>
1383 IP address of server to forward to. Can be IP 4 or IP 6.
1384 To use a nondefault port for DNS communication append '@' with the port number.
1385 .TP
1386 .B forward\-first: \fI<yes or no>
1387 If enabled, a query is attempted without the forward clause if it fails.
1388 The data could not be retrieved and would have caused SERVFAIL because
1389 the servers are unreachable, instead it is tried without this clause.
1390 The default is no.
1391 .TP
1392 .B forward\-ssl\-upstream: \fI<yes or no>
1393 Enabled or disable whether the queries to this forwarder use SSL for transport.
1394 Default is no.
1395 .SS "View Options"
1396 .LP
1397 There may be multiple
1398 .B view:
1399 clauses. Each with a \fBname:\fR and zero or more \fBlocal\-zone\fR and
1400 \fBlocal\-data\fR elements. View can be mapped to requests by specifying the
1401 view name in an \fBaccess\-control\-view\fR element. Options from matching
1402 views will override global options. Global options will be used if no matching
1403 view is found, or when the matching view does not have the option specified.
1404 .TP
1405 .B name: \fI<view name>
1406 Name of the view. Must be unique. This name is used in access\-control\-view
1407 elements.
1408 .TP
1409 .B local\-zone: \fI<zone> <type>
1410 View specific local\-zone elements. Has the same types and behaviour as the
1411 global local\-zone elements. When there is at least one local\-zone specified
1412 and view\-first is no, the default local-zones will be added to this view.
1413 Defaults can be disabled using the nodefault type. When view\-first is yes or
1414 when a view does not have a local\-zone, the global local\-zone will be used
1415 including it's default zones.
1416 .TP
1417 .B local\-data: \fI"<resource record string>"
1418 View specific local\-data elements. Has the same behaviour as the global
1419 local\-data elements.
1420 .TP
1421 .B local\-data\-ptr: \fI"IPaddr name"
1422 View specific local\-data\-ptr elements. Has the same behaviour as the global
1423 local\-data\-ptr elements.
1424 .TP
1425 .B view\-first: \fI<yes or no>
1426 If enabled, it attempts to use the global local\-zone and local\-data if there
1427 is no match in the view specific options.
1428 The default is no.
1429 .SS "Python Module Options"
1430 .LP
1431 The
1432 .B python:
1433 clause gives the settings for the \fIpython\fR(1) script module.  This module
1434 acts like the iterator and validator modules do, on queries and answers.
1435 To enable the script module it has to be compiled into the daemon,
1436 and the word "python" has to be put in the \fBmodule\-config:\fR option
1437 (usually first, or between the validator and iterator).
1438 .LP
1439 If the \fBchroot:\fR option is enabled, you should make sure Python's
1440 library directory structure is bind mounted in the new root environment, see
1441 \fImount\fR(8).  Also the \fBpython\-script:\fR path should be specified as an
1442 absolute path relative to the new root, or as a relative path to the working
1443 directory.
1444 .TP
1445 .B python\-script: \fI<python file>\fR
1446 The script file to load.
1447 .SS "DNS64 Module Options"
1448 .LP
1449 The dns64 module must be configured in the \fBmodule\-config:\fR "dns64
1450 validator iterator" directive and be compiled into the daemon to be
1451 enabled.  These settings go in the \fBserver:\fR section.
1452 .TP
1453 .B dns64\-prefix: \fI<IPv6 prefix>\fR
1454 This sets the DNS64 prefix to use to synthesize AAAA records with.
1455 It must be /96 or shorter.  The default prefix is 64:ff9b::/96.
1456 .TP
1457 .B dns64\-synthall: \fI<yes or no>\fR
1458 Debug option, default no.  If enabled, synthesize all AAAA records
1459 despite the presence of actual AAAA records.
1460 .SS "DNSCrypt Options"
1461 .LP
1462 The
1463 .B dnscrypt:
1464 clause give the settings of the dnscrypt channel. While those options are
1465 available, they are only meaningful if unbound was compiled with
1466 \fB\-\-enable\-dnscrypt\fR.
1467 Currently certificate and secret/public keys cannot be generated by unbound.
1468 You can use dnscrypt-wrapper to generate those: https://github.com/cofyc/\
1469 dnscrypt-wrapper/blob/master/README.md#usage
1470 .TP
1471 .B dnscrypt\-enable: \fI<yes or no>\fR
1472 Whether or not the \fBdnscrypt\fR config should be enabled. You may define
1473 configuration but not activate it.
1474 The default is no.
1475 .TP
1476 .B dnscrypt\-port: \fI<port number>
1477 On which port should \fBdnscrypt\fR should be activated. Note that you should
1478 have a matching \fBinterface\fR option defined in the \fBserver\fR section for
1479 this port.
1480 .TP
1481 .B dnscrypt\-provider: \fI<provider name>\fR
1482 The provider name to use to distribute certificates. This is of the form:
1483 \fB2.dnscrypt-cert.example.com.\fR. The name \fIMUST\fR end with a dot.
1484 .TP
1485 .B dnscrypt\-secret\-key: \fI<path to secret key file>\fR
1486 Path to the time limited secret key file. This option may be specified multiple
1487 times.
1488 .TP
1489 .B dnscrypt\-provider\-cert: \fI<path to cert file>\fR
1490 Path to the certificate related to the \fBdnscrypt\-secret\-key\fRs.
1491 This option may be specified multiple times.
1492 .SS "EDNS Client Subnet Module Options"
1493 .LP
1494 The ECS module must be configured in the \fBmodule\-config:\fR "subnetcache
1495 validator iterator" directive and be compiled into the daemon to be
1496 enabled.  These settings go in the \fBserver:\fR section.
1497 .LP
1498 If the destination address is whitelisted with Unbound will add the EDNS0
1499 option to the query containing the relevant part of the client's address. When
1500 an answer contains the ECS option the response and the option are placed in a
1501 specialized cache. If the authority indicated no support, the response is
1502 stored in the regular cache.
1503 .LP
1504 Additionally, when a client includes the option in its queries, Unbound will
1505 forward the option to the authority if prensent in the whitelist, or
1506 \fBclient\-subnet\-always\-forward\fR is set to yes. In this case the lookup in
1507 the regular cache is skipped.
1508 .LP
1509 The maximum size of the ECS cache is controlled by 'msg-cache-size' in the
1510 configuration file. On top of that, for each query only 100 different subnets
1511 are allowed to be stored for each address family. Exceeding that number, older
1512 entries will be purged from cache.
1513 .TP
1514 .B send\-client\-subnet: \fI<IP address>\fR
1515 Send client source address to this authority. Append /num to indicate a
1516 classless delegation netblock, for example like 10.2.3.4/24 or 2001::11/64. Can
1517 be given multiple times. Authorities not listed will not receive edns-subnet
1518 information, unless domain in query is specified in \fBclient\-subnet\-zone\fR.
1519 .TP
1520 .B client\-subnet\-zone: \fI<domain>\fR
1521 Send client source address in queries for this domain and its subdomains. Can be
1522 given multiple times. Zones not listed will not receive edns-subnet information,
1523 unless hosted by authority specified in \fBsend\-client\-subnet\fR.
1524 .TP
1525 .B client\-subnet\-always\-forward: \fI<yes or no>\fR
1526 Specify whether the ECS whitelist check (configured using
1527 \fBsend\-client\-subnet\fR) is applied for all queries, even if the triggering
1528 query contains an ECS record, or only for queries for which the ECS record is
1529 generated using the querier address (and therefore did not contain ECS data in
1530 the client query). If enabled, the whitelist check is skipped when the client
1531 query contains an ECS record. Default is no.
1532 .TP
1533 .B max\-client\-subnet\-ipv6: \fI<number>\fR
1534 Specifies the maximum prefix length of the client source address we are willing
1535 to expose to third parties for IPv6.  Defaults to 56.
1536 .TP
1537 .B max\-client\-subnet\-ipv4: \fI<number>\fR
1538 Specifies the maximum prefix length of the client source address we are willing
1539 to expose to third parties for IPv4. Defaults to 24.
1540 .SS "Opportunistic IPsec Support Module Options"
1541 .LP
1542 The IPsec module must be configured in the \fBmodule\-config:\fR "ipsecmod
1543 validator iterator" directive and be compiled into the daemon to be
1544 enabled.  These settings go in the \fBserver:\fR section.
1545 .LP
1546 When unbound receives an A/AAAA query that is not in the cache and finds a
1547 valid answer, it will withhold returning the answer and instead will generate
1548 an IPSECKEY subquery for the same domain name.  If an answer was found, unbound
1549 will call an external hook passing the following arguments:
1550 .TP 10
1551 \h'5'\fIQNAME\fR
1552 Domain name of the A/AAAA and IPSECKEY query.  In string format.
1553 .TP 10
1554 \h'5'\fIIPSECKEY TTL\fR
1555 TTL of the IPSECKEY RRset.
1556 .TP 10
1557 \h'5'\fIA/AAAA\fR
1558 String of space separated IP addresses present in the A/AAAA RRset.  The IP
1559 addresses are in string format.
1560 .TP 10
1561 \h'5'\fIIPSECKEY\fR
1562 String of space separated IPSECKEY RDATA present in the IPSECKEY RRset.  The
1563 IPSECKEY RDATA are in DNS presentation format.
1564 .LP
1565 The A/AAAA answer is then cached and returned to the client.  If the external
1566 hook was called the TTL changes to ensure it doesn't surpass
1567 \fBipsecmod-max-ttl\fR.
1568 .LP
1569 The same procedure is also followed when \fBprefetch:\fR is used, but the
1570 A/AAAA answer is given to the client before the hook is called.
1571 \fBipsecmod-max-ttl\fR ensures that the A/AAAA answer given from cache is still
1572 relevant for opportunistic IPsec.
1573 .TP
1574 .B ipsecmod-enabled: \fI<yes or no>\fR
1575 Specifies whether the IPsec module is enabled or not.  The IPsec module still
1576 needs to be defined in the \fBmodule\-config:\fR directive.  This option
1577 facilitates turning on/off the module without restarting/reloading unbound.
1578 Defaults to yes.
1579 .TP
1580 .B ipsecmod\-hook: \fI<filename>\fR
1581 Specifies the external hook that unbound will call with \fIsystem\fR(3).  The
1582 file can be specified as an absolute/relative path.  The file needs the proper
1583 permissions to be able to be executed by the same user that runs unbound.  It
1584 must be present when the IPsec module is defined in the \fBmodule\-config:\fR
1585 directive.
1586 .TP
1587 .B ipsecmod-strict: \fI<yes or no>\fR
1588 If enabled unbound requires the external hook to return a success value of 0.
1589 Failing to do so unbound will reply with SERVFAIL.  The A/AAAA answer will also
1590 not be cached.  Defaults to no.
1591 .TP
1592 .B ipsecmod\-max-ttl: \fI<seconds>\fR
1593 Time to live maximum for A/AAAA cached records after calling the external hook.
1594 Defaults to 3600.
1595 .TP
1596 .B ipsecmod-ignore-bogus: \fI<yes or no>\fR
1597 Specifies the behaviour of unbound when the IPSECKEY answer is bogus.  If set
1598 to yes, the hook will be called and the A/AAAA answer will be returned to the
1599 client.  If set to no, the hook will not be called and the answer to the
1600 A/AAAA query will be SERVFAIL.  Mainly used for testing.  Defaults to no.
1601 .TP
1602 .B ipsecmod\-whitelist: \fI<domain>\fR
1603 Whitelist the domain so that the module logic will be executed.  Can
1604 be given multiple times, for different domains.  If the option is not
1605 specified, all domains are treated as being whitelisted (default).
1606 .SH "MEMORY CONTROL EXAMPLE"
1607 In the example config settings below memory usage is reduced. Some service
1608 levels are lower, notable very large data and a high TCP load are no longer
1609 supported. Very large data and high TCP loads are exceptional for the DNS.
1610 DNSSEC validation is enabled, just add trust anchors.
1611 If you do not have to worry about programs using more than 3 Mb of memory,
1612 the below example is not for you. Use the defaults to receive full service,
1613 which on BSD\-32bit tops out at 30\-40 Mb after heavy usage.
1614 .P
1615 .nf
1616 # example settings that reduce memory usage
1617 server:
1618         num\-threads: 1
1619         outgoing\-num\-tcp: 1   # this limits TCP service, uses less buffers.
1620         incoming\-num\-tcp: 1
1621         outgoing\-range: 60     # uses less memory, but less performance.
1622         msg\-buffer\-size: 8192   # note this limits service, 'no huge stuff'.
1623         msg\-cache\-size: 100k
1624         msg\-cache\-slabs: 1
1625         rrset\-cache\-size: 100k
1626         rrset\-cache\-slabs: 1
1627         infra\-cache\-numhosts: 200
1628         infra\-cache\-slabs: 1
1629         key\-cache\-size: 100k
1630         key\-cache\-slabs: 1
1631         neg\-cache\-size: 10k
1632         num\-queries\-per\-thread: 30
1633         target\-fetch\-policy: "2 1 0 0 0 0"
1634         harden\-large\-queries: "yes"
1635         harden\-short\-bufsize: "yes"
1636 .fi
1637 .SH "FILES"
1638 .TP
1639 .I /var/unbound
1640 default unbound working directory.
1641 .TP
1642 .I /var/unbound
1643 default
1644 \fIchroot\fR(2)
1645 location.
1646 .TP
1647 .I /var/unbound/unbound.conf
1648 unbound configuration file.
1649 .TP
1650 .I /var/unbound/unbound.pid
1651 default unbound pidfile with process ID of the running daemon.
1652 .TP
1653 .I unbound.log
1654 unbound log file. default is to log to
1655 \fIsyslog\fR(3).
1656 .SH "SEE ALSO"
1657 \fIunbound\fR(8),
1658 \fIunbound\-checkconf\fR(8).
1659 .SH "AUTHORS"
1660 .B Unbound
1661 was written by NLnet Labs. Please see CREDITS file
1662 in the distribution for further details.