diff options
author | Dag-Erling Smørgrav <des@FreeBSD.org> | 2018-05-12 11:54:35 +0000 |
---|---|---|
committer | Dag-Erling Smørgrav <des@FreeBSD.org> | 2018-05-12 11:54:35 +0000 |
commit | 15de2de8449b4f5063f93578ae68aa0bc79a205c (patch) | |
tree | f0a7e3230212205e7ff88a2900de97026940f63c /doc | |
parent | 689b65913bba5320ef50befddf4743c6dafde873 (diff) | |
download | src-test2-15de2de8449b4f5063f93578ae68aa0bc79a205c.tar.gz src-test2-15de2de8449b4f5063f93578ae68aa0bc79a205c.zip |
Notes
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Changelog | 190 | ||||
-rw-r--r-- | doc/README | 2 | ||||
-rw-r--r-- | doc/example.conf.in | 33 | ||||
-rw-r--r-- | doc/libunbound.3.in | 4 | ||||
-rw-r--r-- | doc/unbound-anchor.8.in | 2 | ||||
-rw-r--r-- | doc/unbound-checkconf.8.in | 2 | ||||
-rw-r--r-- | doc/unbound-control.8.in | 2 | ||||
-rw-r--r-- | doc/unbound-host.1.in | 2 | ||||
-rw-r--r-- | doc/unbound.8.in | 4 | ||||
-rw-r--r-- | doc/unbound.conf.5.in | 438 |
10 files changed, 490 insertions, 189 deletions
diff --git a/doc/Changelog b/doc/Changelog index 8f8d6daeacea..24a4f97e9a94 100644 --- a/doc/Changelog +++ b/doc/Changelog @@ -1,12 +1,198 @@ +22 June 2017: Wouter + - Tag 1.6.4rc2 + +22 June 2017: Ralph + - Added fastrpz patch to contrib + +21 June 2017: Wouter + - Fix #1316: heap read buffer overflow in parse_edns_options. + +20 June 2017: Wouter + - Fix warning in pythonmod under clang compiler. + - Tag 1.6.4rc1 + - Fix lintian typo. + +16 June 2017: Ralph + - Fix #1277: disable domain ratelimit by setting value to 0. + +16 June 2017: Wouter + - Fix #1301: memory leak in respip and tests. + - Free callback in edns-subnetmod on exit and restart. + - Fix memory leak in sldns_buffer_new_frm_data. + - Fix memory leak in dnscrypt config read. + - Fix dnscrypt chacha cert support ifdefs. + - Fix dnscrypt chacha cert unit test escapes in grep. + - Remove asynclook tests that cause test and purifier problems. + - Fix to unlock view in view test. + +15 June 2017: Wouter + - Fix stub zone queries leaking to the internet for + harden-referral-path ns checks. + - Fix query for refetch_glue of stub leaking to internet. + 13 June 2017: Wouter + - Fix #1279: Memory leak on reload when python module is enabled. - Fix #1280: Unbound fails assert when response from authoritative contains malformed qname. When 0x20 caps-for-id is enabled, when assertions are not enabled the malformed qname is handled correctly. - - tag for 1.6.3 + - 1.6.3 tag created, with only #1280 fix, trunk is 1.6.4 development. + - More fixes in depth for buffer checks in 0x20 qname checks. + +12 June 2017: Wouter + - Fix #1278: Incomplete wildcard proof. + +8 June 2017: Ralph + - Added domain name based ECS whitelist. + +8 June 2017: Wouter + - Detect chacha for dnscrypt at configure time. + - dnscrypt unit tests with chacha. + +7 June 2017: Wouter + - Fix that unbound-control can set val_clean_additional and val_permissive_mode. + - Add dnscrypt XChaCha20 tests. + +6 June 2017: Wouter + - Add an explicit type cast for TCP FASTOPEN fix. + - renumbering B-Root's IPv6 address to 2001:500:200::b. + - Fix #1275: cached data in cachedb is never used. + - Fix #1276: [dnscrypt] add XChaCha20-Poly1305 cipher. + +1 June 2017: Ralph + - Fix #1274: automatically trim chroot path from dnscrypt key/cert paths + (from Manu Bretelle). + +1 June 2017: Wouter + - Fix fastopen EPIPE fallthrough to perform connect. + +31 May 2017: Ralph + - Also use global local-zones when there is a matching view that does + not have any local-zone specified. + +31 May 2017: Wouter + - Fix #1273: cachedb.c doesn't compile with -Wextra. + - If MSG_FASTOPEN gives EPIPE fallthrough to try normal tcp write. + +30 May 2017: Ralph + - Fix #1269: inconsistent use of built-in local zones with views. + - Add defaults for new local-zone trees added to views using + unbound-control. + +30 May 2017: Wouter + - Support for openssl EVP_DigestVerify. + - Support for the ED25519 algorithm with openssl (from openssl 1.1.1). + +29 May 2017: Wouter + - Fix assertion for low buffer size and big edns payload when worker + overrides udpsize. + +26 May 2017: Ralph + - Added redirect-bogus.patch to contrib directory. + +26 May 2017: Wouter + - Fix #1270: unitauth.c doesn't compile with higher warning level + and optimization + - exec_prefix is by default equal to prefix. + - printout localzone for duplicate local-zone warnings. + +24 May 2017: Wouter + - authzone cname chain, no rrset duplicates, wildcard doesn't change + rrsets added for cname chain. + +23 May 2017: Wouter + - first services/authzone check in, it compiles and reads and writes + zonefiles. + - iana portlist update + +22 May 2017: Wouter + - Fix #1268: SIGSEGV after log_reopen. + +18 May 2017: Wouter + - Fix #1265 to use /bin/kill. + - Fix #1267: Libunbound validator/val_secalgo.c uses obsolete APIs, + and compatibility with BoringSSL. + +17 May 2017: Wouter + - Fix #1265: contrib/unbound.service contains hardcoded path. + +17 May 2017: George + - Use qstate's region for IPSECKEY rrset (ipsecmod). + +16 May 2017: George + - Implemented opportunistic IPsec support module (ipsecmod). + - Some whitespace fixup. + +16 May 2017: Wouter + - updated dependencies in the makefile. + - document trust-anchor-signaling in example config file. + - updated configure, dependencies and flex output. + - better module memory lookup, fix of unbound-control shm names for + module memory printout of statistics. + - Fix type AVC sldns rrdef. + +12 May 2017: Wouter + - Adjust servfail by iterator to not store in cache when serve-expired + is enabled, to avoid overwriting useful information there. + - Fix queries for nameservers under a stub leaking to the internet. + +9 May 2017: Ralph + - Add 'c' to getopt() in testbound. + - iana portlist update + +8 May 2017: Wouter + - Fix tcp-mss failure printout text. + - Set SO_REUSEADDR on outgoing tcp connections to fix the bind before + connect limited tcp connections. With the option tcp connections + can share the same source port (for different destinations). + +2 May 2017: Ralph + - Added mesh_add_sub to add detached mesh entries. + - Use mesh_add_sub for key tag signaling query. + +2 May 2017: Wouter + - Added test for leak of stub information. + - Fix sldns wire2str printout of RR type CAA tags. + - Fix sldns int16_data parse. + - Fix sldns parse and printout of TSIG RRs. + - sldns SMIMEA and AVC definitions, same as getdns definitions. + +1 May 2017: Wouter + - Fix #1259: "--disable-ecdsa" argument overwritten + by "#ifdef SHA256_DIGEST_LENGTH@daemon/remote.c". + - iana portlist update + - Fix #1258: Windows 10 X64 unbound 1.6.2 service will not start. + and fix that 64bit getting installed in C:\Program Files (x86). + +26 April 2017: Ralph + - Implemented trust anchor signaling using key tag query. + +26 April 2017: Wouter + - Based on #1257: check parse limit before t increment in sldns RR + string parse routine. + +24 April 2017: Wouter + - unbound-checkconf -o allows query of dnstap config variables. + Also unbound-control get_option. Also for dnscrypt. + - trunk contains 1.6.3 version number (changes from 1.6.2 back from + when the 1.6.2rc1 tag has been created). + +21 April 2017: Ralph + - Fix #1254: clarify ratelimit-{for,below}-domain (from Manu Bretelle). + - iana portlist update + +18 April 2017: Ralph + - Fix #1252: more indentation inconsistencies. + - Fix #1253: unused variable in edns-subnet/addrtree.c:getbit(). + +13 April 2017: Ralph + - Added ECS unit test (from Manu Bretelle). + - ECS documentation fix (from Manu Bretelle). 13 April 2017: Wouter - Fix #1250: inconsistent indentation in services/listen_dnsport.c. - tag for 1.6.2rc1 + - (for 1.6.3:) unbound.h exports the shm stats structures. They use + type long long and no ifdefs, and ub_ before the typenames. 12 April 2017: Wouter - subnet mem value is available in shm, also when not enabled, @@ -243,7 +429,7 @@ - Fix #1184: Log DNS replies. This includes the same logging information that DNS queries and response code and response size, patch from Larissa Feng. - - Fix #1185: Source IP rate limiting, patch from Larissa Feng. + - Fix #1187: Source IP rate limiting, patch from Larissa Feng. 3 January 2017: Wouter - configure --enable-systemd and lets unbound use systemd sockets if diff --git a/doc/README b/doc/README index 558a48071e2a..0e4a1535ed14 100644 --- a/doc/README +++ b/doc/README @@ -1,4 +1,4 @@ -README for Unbound 1.6.3 +README for Unbound 1.6.4 Copyright 2007 NLnet Labs http://unbound.net diff --git a/doc/example.conf.in b/doc/example.conf.in index 3411d7edbdd6..539602953beb 100644 --- a/doc/example.conf.in +++ b/doc/example.conf.in @@ -1,7 +1,7 @@ # # Example configuration file. # -# See unbound.conf(5) man page, version 1.6.3. +# See unbound.conf(5) man page, version 1.6.4. # # this is a comment. @@ -448,6 +448,9 @@ server: # and under the terms of our LICENSE (see that file in the source). # auto-trust-anchor-file: "@UNBOUND_ROOTKEY_FILE@" + # trust anchor signaling sends a RFC8145 key tag query after priming. + # trust-anchor-signaling: no + # File with DLV trusted keys. Same format as trust-anchor-file. # There can be only one DLV configured, it is trusted from root down. # DLV is going to be decommissioned. Please do not use it any more. @@ -698,6 +701,34 @@ server: # 0 blocks when ip is ratelimited, otherwise let 1/xth traffic through # ip-ratelimit-factor: 10 + # Specific options for ipsecmod. unbound needs to be configured with + # --enable-ipsecmod for these to take effect. + # + # Enable or disable ipsecmod (it still needs to be defined in + # module-config above). Can be used when ipsecmod needs to be + # enabled/disabled via remote-control(below). + # ipsecmod-enabled: yes + # + # Path to executable external hook. It must be defined when ipsecmod is + # listed in module-config (above). + # ipsecmod-hook: "./my_executable" + # + # When enabled unbound will reply with SERVFAIL if the return value of + # the ipsecmod-hook is not 0. + # ipsecmod-strict: no + # + # Maximum time to live (TTL) for cached A/AAAA records with IPSECKEY. + # ipsecmod-max-ttl: 3600 + # + # Reply with A/AAAA even if the relevant IPSECKEY is bogus. Mainly used for + # testing. + # ipsecmod-ignore-bogus: no + # + # Domains for which ipsecmod will be triggered. If not defined (default) + # all domains are treated as being whitelisted. + # ipsecmod-whitelist: "example.com" + # ipsecmod-whitelist: "nlnetlabs.nl" + # Python config section. To enable: # o use --with-pythonmodule to configure before compiling. diff --git a/doc/libunbound.3.in b/doc/libunbound.3.in index 70ed5c2d4e74..bcd79ffcaff4 100644 --- a/doc/libunbound.3.in +++ b/doc/libunbound.3.in @@ -1,4 +1,4 @@ -.TH "libunbound" "3" "Jun 13, 2017" "NLnet Labs" "unbound 1.6.3" +.TH "libunbound" "3" "Jun 27, 2017" "NLnet Labs" "unbound 1.6.4" .\" .\" libunbound.3 -- unbound library functions manual .\" @@ -43,7 +43,7 @@ .B ub_ctx_zone_remove, .B ub_ctx_data_add, .B ub_ctx_data_remove -\- Unbound DNS validating resolver 1.6.3 functions. +\- Unbound DNS validating resolver 1.6.4 functions. .SH "SYNOPSIS" .B #include <unbound.h> .LP diff --git a/doc/unbound-anchor.8.in b/doc/unbound-anchor.8.in index f96a9e6c291d..8d041c01d19f 100644 --- a/doc/unbound-anchor.8.in +++ b/doc/unbound-anchor.8.in @@ -1,4 +1,4 @@ -.TH "unbound-anchor" "8" "Jun 13, 2017" "NLnet Labs" "unbound 1.6.3" +.TH "unbound-anchor" "8" "Jun 27, 2017" "NLnet Labs" "unbound 1.6.4" .\" .\" unbound-anchor.8 -- unbound anchor maintenance utility manual .\" diff --git a/doc/unbound-checkconf.8.in b/doc/unbound-checkconf.8.in index 523784b5c4b8..c9f4502cf6ed 100644 --- a/doc/unbound-checkconf.8.in +++ b/doc/unbound-checkconf.8.in @@ -1,4 +1,4 @@ -.TH "unbound-checkconf" "8" "Jun 13, 2017" "NLnet Labs" "unbound 1.6.3" +.TH "unbound-checkconf" "8" "Jun 27, 2017" "NLnet Labs" "unbound 1.6.4" .\" .\" unbound-checkconf.8 -- unbound configuration checker manual .\" diff --git a/doc/unbound-control.8.in b/doc/unbound-control.8.in index 47d2a4861a23..98be38c44137 100644 --- a/doc/unbound-control.8.in +++ b/doc/unbound-control.8.in @@ -1,4 +1,4 @@ -.TH "unbound-control" "8" "Jun 13, 2017" "NLnet Labs" "unbound 1.6.3" +.TH "unbound-control" "8" "Jun 27, 2017" "NLnet Labs" "unbound 1.6.4" .\" .\" unbound-control.8 -- unbound remote control manual .\" diff --git a/doc/unbound-host.1.in b/doc/unbound-host.1.in index 1d698e16d93e..db51410c428f 100644 --- a/doc/unbound-host.1.in +++ b/doc/unbound-host.1.in @@ -1,4 +1,4 @@ -.TH "unbound\-host" "1" "Jun 13, 2017" "NLnet Labs" "unbound 1.6.3" +.TH "unbound\-host" "1" "Jun 27, 2017" "NLnet Labs" "unbound 1.6.4" .\" .\" unbound-host.1 -- unbound DNS lookup utility .\" diff --git a/doc/unbound.8.in b/doc/unbound.8.in index cca759b622b5..8555937c1be9 100644 --- a/doc/unbound.8.in +++ b/doc/unbound.8.in @@ -1,4 +1,4 @@ -.TH "unbound" "8" "Jun 13, 2017" "NLnet Labs" "unbound 1.6.3" +.TH "unbound" "8" "Jun 27, 2017" "NLnet Labs" "unbound 1.6.4" .\" .\" unbound.8 -- unbound manual .\" @@ -9,7 +9,7 @@ .\" .SH "NAME" .B unbound -\- Unbound DNS validating resolver 1.6.3. +\- Unbound DNS validating resolver 1.6.4. .SH "SYNOPSIS" .B unbound .RB [ \-h ] diff --git a/doc/unbound.conf.5.in b/doc/unbound.conf.5.in index b2c76ac9575c..6b6e6d974bc8 100644 --- a/doc/unbound.conf.5.in +++ b/doc/unbound.conf.5.in @@ -1,4 +1,4 @@ -.TH "unbound.conf" "5" "Jun 13, 2017" "NLnet Labs" "unbound 1.6.3" +.TH "unbound.conf" "5" "Jun 27, 2017" "NLnet Labs" "unbound 1.6.4" .\" .\" unbound.conf.5 -- unbound.conf manual .\" @@ -16,13 +16,14 @@ .B unbound.conf is used to configure \fIunbound\fR(8). -The file format has attributes and values. Some attributes have attributes inside them. +The file format has attributes and values. Some attributes have attributes +inside them. The notation is: attribute: value. .P Comments start with # and last to the end of line. Empty lines are ignored as is whitespace at the beginning of a line. .P -The utility +The utility \fIunbound\-checkconf\fR(8) can be used to check unbound.conf prior to usage. .SH "EXAMPLE" @@ -30,7 +31,7 @@ An example config file is shown below. Copy this to /etc/unbound/unbound.conf and start the server with: .P .nf - $ unbound \-c /etc/unbound/unbound.conf + $ unbound \-c /etc/unbound/unbound.conf .fi .P Most settings are the defaults. Stop the server with: @@ -62,8 +63,8 @@ server: access\-control: 2001:DB8::/64 allow .fi .SH "FILE FORMAT" -There must be whitespace between keywords. Attribute keywords end with a colon ':'. An attribute -is followed by its containing attributes, or a value. +There must be whitespace between keywords. Attribute keywords end with a colon ':'. +An attribute is followed by its containing attributes, or a value. .P Files can be included using the .B include: @@ -71,7 +72,7 @@ directive. It can appear anywhere, it accepts a single file name as argument. Processing continues as if the text from the included file was copied into the config file at that point. If also using chroot, using full path names for the included files works, relative pathnames for the included names work -if the directory where the daemon is started equals its chroot/working +if the directory where the daemon is started equals its chroot/working directory or is specified before the include statement with directory: dir. Wildcards can be used to include multiple files, see \fIglob\fR(7). .SS "Server Options" @@ -80,17 +81,17 @@ These options are part of the clause. .TP .B verbosity: \fI<number> -The verbosity number, level 0 means no verbosity, only errors. Level 1 +The verbosity number, level 0 means no verbosity, only errors. Level 1 gives operational information. Level 2 gives detailed operational -information. Level 3 gives query level information, output per query. -Level 4 gives algorithm level information. Level 5 logs client -identification for cache misses. Default is level 1. +information. Level 3 gives query level information, output per query. +Level 4 gives algorithm level information. Level 5 logs client +identification for cache misses. Default is level 1. The verbosity can also be increased from the commandline, see \fIunbound\fR(8). .TP .B statistics\-interval: \fI<seconds> The number of seconds between printing statistics to the log for every thread. Disable with value 0 or "". Default is disabled. The histogram statistics -are only printed if replies were sent during the statistics interval, +are only printed if replies were sent during the statistics interval, requestlist statistics are printed for every interval (but can be 0). This is because the median calculation requires data to be present. .TP @@ -99,7 +100,7 @@ If enabled, statistics are cumulative since starting unbound, without clearing the statistics counters after logging the statistics. Default is no. .TP .B extended\-statistics: \fI<yes or no> -If enabled, extended statistics are printed from \fIunbound\-control\fR(8). +If enabled, extended statistics are printed from \fIunbound\-control\fR(8). Default is off, because keeping track of more statistics takes time. The counters are listed in \fIunbound\-control\fR(8). .TP @@ -112,7 +113,7 @@ The port number, default 53, on which the server responds to queries. .B interface: \fI<ip address[@port]> Interface to use to connect to the network. This interface is listened to for queries from clients, and answers to clients are given from it. -Can be given multiple times to work on several interfaces. If none are +Can be given multiple times to work on several interfaces. If none are given the default is to listen to localhost. The interfaces are not changed on a reload (kill \-HUP) but only on restart. A port number can be specified with @port (without spaces between @@ -123,19 +124,19 @@ interface and port number), if not specified the default port (from Same as interface: (for easy of compatibility with nsd.conf). .TP .B interface\-automatic: \fI<yes or no> -Detect source interface on UDP queries and copy them to replies. This +Detect source interface on UDP queries and copy them to replies. This feature is experimental, and needs support in your OS for particular socket options. Default value is no. .TP .B outgoing\-interface: \fI<ip address or ip6 netblock> Interface to use to connect to the network. This interface is used to send -queries to authoritative servers and receive their replies. Can be given -multiple times to work on several interfaces. If none are given the -default (all) is used. You can specify the same interfaces in +queries to authoritative servers and receive their replies. Can be given +multiple times to work on several interfaces. If none are given the +default (all) is used. You can specify the same interfaces in .B interface: and .B outgoing\-interface: -lines, the interfaces are then used for both purposes. Outgoing queries are +lines, the interfaces are then used for both purposes. Outgoing queries are sent via a random outgoing interface to counter spoofing. .IP If an IPv6 netblock is specified instead of an individual IPv6 address, @@ -155,26 +156,26 @@ ip \-6 addr add mynetblock/64 dev lo && ip \-6 route add local mynetblock/64 dev lo .TP .B outgoing\-range: \fI<number> -Number of ports to open. This number of file descriptors can be opened per -thread. Must be at least 1. Default depends on compile options. Larger +Number of ports to open. This number of file descriptors can be opened per +thread. Must be at least 1. Default depends on compile options. Larger numbers need extra resources from the operating system. For performance a very large value is best, use libevent to make this possible. .TP .B outgoing\-port\-permit: \fI<port number or range> Permit unbound to open this port or range of ports for use to send queries. A larger number of permitted outgoing ports increases resilience against -spoofing attempts. Make sure these ports are not needed by other daemons. +spoofing attempts. Make sure these ports are not needed by other daemons. By default only ports above 1024 that have not been assigned by IANA are used. Give a port number or a range of the form "low\-high", without spaces. .IP -The \fBoutgoing\-port\-permit\fR and \fBoutgoing\-port\-avoid\fR statements -are processed in the line order of the config file, adding the permitted ports -and subtracting the avoided ports from the set of allowed ports. The -processing starts with the non IANA allocated ports above 1024 in the set +The \fBoutgoing\-port\-permit\fR and \fBoutgoing\-port\-avoid\fR statements +are processed in the line order of the config file, adding the permitted ports +and subtracting the avoided ports from the set of allowed ports. The +processing starts with the non IANA allocated ports above 1024 in the set of allowed ports. .TP .B outgoing\-port\-avoid: \fI<port number or range> -Do not permit unbound to open this port or range of ports for use to send +Do not permit unbound to open this port or range of ports for use to send queries. Use this to make sure unbound does not grab a port that another daemon needs. The port is avoided on all outgoing interfaces, both IP4 and IP6. By default only ports above 1024 that have not been assigned by IANA are used. @@ -204,13 +205,13 @@ consider tuning the outgoing tcp number). .B max\-udp\-size: \fI<number> Maximum UDP response size (not applied to TCP response). 65536 disables the udp response size maximum, and uses the choice from the client, always. -Suggested values are 512 to 4096. Default is 4096. +Suggested values are 512 to 4096. Default is 4096. .TP .B msg\-buffer\-size: \fI<number> Number of bytes size of the message buffers. Default is 65552 bytes, enough for 64 Kb packets, the maximum DNS message size. No message larger than this can be sent or received. Can be reduced to use less memory, but some requests -for DNS data, such as for huge resource records, will result in a SERVFAIL +for DNS data, such as for huge resource records, will result in a SERVFAIL reply to the client. .TP .B msg\-cache\-size: \fI<number> @@ -220,7 +221,7 @@ or gigabytes (1024*1024 bytes in a megabyte). .TP .B msg\-cache\-slabs: \fI<number> Number of slabs in the message cache. Slabs reduce lock contention by threads. -Must be set to a power of 2. Setting (close) to the number of cpus is a +Must be set to a power of 2. Setting (close) to the number of cpus is a reasonable guess. .TP .B num\-queries\-per\-thread: \fI<number> @@ -232,12 +233,12 @@ the existing queries. Default depends on compile options, 512 or 1024. .TP .B jostle\-timeout: \fI<msec> Timeout used when the server is very busy. Set to a value that usually -results in one roundtrip to the authority servers. If too many queries +results in one roundtrip to the authority servers. If too many queries arrive, then 50% of the queries are allowed to run to completion, and -the other 50% are replaced with the new incoming query if they have already -spent more than their allowed time. This protects against denial of +the other 50% are replaced with the new incoming query if they have already +spent more than their allowed time. This protects against denial of service by slow queries or high query rates. Default 200 milliseconds. -The effect is that the qps for long-lasting queries is about +The effect is that the qps for long-lasting queries is about (numqueriesperthread / 2) / (average time for such long queries) qps. The qps for short queries can be about (numqueriesperthread / 2) / (jostletimeout in whole seconds) qps per thread, about (1024/2)*5 = 2560 @@ -308,12 +309,12 @@ or gigabytes (1024*1024 bytes in a megabyte). .TP .B rrset\-cache\-slabs: \fI<number> Number of slabs in the RRset cache. Slabs reduce lock contention by threads. -Must be set to a power of 2. +Must be set to a power of 2. .TP .B cache\-max\-ttl: \fI<seconds> -Time to live maximum for RRsets and messages in the cache. Default is -86400 seconds (1 day). If the maximum kicks in, responses to clients -still get decrementing TTLs based on the original (larger) values. +Time to live maximum for RRsets and messages in the cache. Default is +86400 seconds (1 day). If the maximum kicks in, responses to clients +still get decrementing TTLs based on the original (larger) values. When the internal TTL expires, the cache item has expired. Can be set lower to force the resolver to query for data often, and not trust (very large) TTL values. @@ -323,7 +324,7 @@ Time to live minimum for RRsets and messages in the cache. Default is 0. If the minimum kicks in, the data is cached for longer than the domain owner intended, and thus less queries are made to look up the data. Zero makes sure the data in the cache is as the domain owner intended, -higher values, especially more than an hour or so, can lead to trouble as +higher values, especially more than an hour or so, can lead to trouble as the data in the cache does not match up with the actual data any more. .TP .B cache\-max\-negative\-ttl: \fI<seconds> @@ -331,12 +332,12 @@ Time to live maximum for negative responses, these have a SOA in the authority section that is limited in time. Default is 3600. .TP .B infra\-host\-ttl: \fI<seconds> -Time to live for entries in the host cache. The host cache contains +Time to live for entries in the host cache. The host cache contains roundtrip timing, lameness and EDNS support information. Default is 900. .TP .B infra\-cache\-slabs: \fI<number> -Number of slabs in the infrastructure cache. Slabs reduce lock contention -by threads. Must be set to a power of 2. +Number of slabs in the infrastructure cache. Slabs reduce lock contention +by threads. Must be set to a power of 2. .TP .B infra\-cache\-numhosts: \fI<number> Number of hosts for which information is cached. Default is 10000. @@ -372,7 +373,7 @@ Enable or disable whether TCP queries are answered or issued. Default is yes. .TP .B tcp\-mss: \fI<number> Maximum segment size (MSS) of TCP socket on which the server responds -to queries. Value lower than common MSS on Ethernet +to queries. Value lower than common MSS on Ethernet (1220 for example) will address path MTU problem. Note that not all platform supports socket option to set MSS (TCP_MAXSEG). Default is system default MSS determined by interface MTU and @@ -393,7 +394,8 @@ Default is no. Useful in tunneling scenarios. .B ssl\-upstream: \fI<yes or no> Enabled or disable whether the upstream queries use SSL only for transport. Default is no. Useful in tunneling scenarios. The SSL contains plain DNS in -TCP wireformat. The other server must support this (see \fBssl\-service\-key\fR). +TCP wireformat. The other server must support this (see +\fBssl\-service\-key\fR). .TP .B ssl\-service-key: \fI<file> If enabled, the server provider SSL service on its TCP sockets. The clients @@ -423,37 +425,37 @@ a daemon. Set the value to \fIno\fR when unbound runs as systemd service. Default is yes. .TP .B access\-control: \fI<IP netblock> <action> -The netblock is given as an IP4 or IP6 address with /size appended for a -classless network block. The action can be \fIdeny\fR, \fIrefuse\fR, +The netblock is given as an IP4 or IP6 address with /size appended for a +classless network block. The action can be \fIdeny\fR, \fIrefuse\fR, \fIallow\fR, \fIallow_snoop\fR, \fIdeny_non_local\fR or \fIrefuse_non_local\fR. The most specific netblock match is used, if none match \fIdeny\fR is used. .IP The action \fIdeny\fR stops queries from hosts from that netblock. .IP -The action \fIrefuse\fR stops queries too, but sends a DNS rcode REFUSED +The action \fIrefuse\fR stops queries too, but sends a DNS rcode REFUSED error message back. .IP -The action \fIallow\fR gives access to clients from that netblock. -It gives only access for recursion clients (which is +The action \fIallow\fR gives access to clients from that netblock. +It gives only access for recursion clients (which is what almost all clients need). Nonrecursive queries are refused. .IP -The \fIallow\fR action does allow nonrecursive queries to access the +The \fIallow\fR action does allow nonrecursive queries to access the local\-data that is configured. The reason is that this does not involve -the unbound server recursive lookup algorithm, and static data is served -in the reply. This supports normal operations where nonrecursive queries -are made for the authoritative data. For nonrecursive queries any replies +the unbound server recursive lookup algorithm, and static data is served +in the reply. This supports normal operations where nonrecursive queries +are made for the authoritative data. For nonrecursive queries any replies from the dynamic cache are refused. .IP -The action \fIallow_snoop\fR gives nonrecursive access too. This give -both recursive and non recursive access. The name \fIallow_snoop\fR refers +The action \fIallow_snoop\fR gives nonrecursive access too. This give +both recursive and non recursive access. The name \fIallow_snoop\fR refers to cache snooping, a technique to use nonrecursive queries to examine -the cache contents (for malicious acts). However, nonrecursive queries can -also be a valuable debugging tool (when you want to examine the cache +the cache contents (for malicious acts). However, nonrecursive queries can +also be a valuable debugging tool (when you want to examine the cache contents). In that case use \fIallow_snoop\fR for your administration host. .IP By default only localhost is \fIallow\fRed, the rest is \fIrefuse\fRd. -The default is \fIrefuse\fRd, because that is protocol\-friendly. The DNS -protocol is not designed to handle dropped packets due to policy, and +The default is \fIrefuse\fRd, because that is protocol\-friendly. The DNS +protocol is not designed to handle dropped packets due to policy, and dropping may result in (possibly excessive) retried queries. .IP The deny_non_local and refuse_non_local settings are for hosts that are @@ -485,8 +487,8 @@ Set view for given access control element. .B chroot: \fI<directory> If chroot is enabled, you should pass the configfile (from the commandline) as a full path from the original root. After the -chroot has been performed the now defunct portion of the config -file path is removed to be able to reread the config after a reload. +chroot has been performed the now defunct portion of the config +file path is removed to be able to reread the config after a reload. .IP All other file paths (working dir, logfile, roothints, and key files) can be specified in several ways: @@ -497,22 +499,22 @@ In the last case the path is adjusted to remove the unused portion. .IP The pidfile can be either a relative path to the working directory, or an absolute path relative to the original root. It is written just prior -to chroot and dropping permissions. This allows the pidfile to be +to chroot and dropping permissions. This allows the pidfile to be /var/run/unbound.pid and the chroot to be /var/unbound, for example. .IP Additionally, unbound may need to access /dev/random (for entropy) from inside the chroot. .IP -If given a chroot is done to the given directory. The default is +If given a chroot is done to the given directory. The default is "@UNBOUND_CHROOT_DIR@". If you give "" no chroot is performed. .TP .B username: \fI<name> If given, after binding the port the user privileges are dropped. Default is -"@UNBOUND_USERNAME@". If you give username: "" no user change is performed. +"@UNBOUND_USERNAME@". If you give username: "" no user change is performed. .IP If this user is not capable of binding the port, reloads (by signal HUP) will still retain the opened ports. -If you change the port number in the config file, and that new port number +If you change the port number in the config file, and that new port number requires privileges, then a reload will fail; a restart is needed. .TP .B directory: \fI<directory> @@ -524,17 +526,17 @@ then those includes can be relative to the working directory. .TP .B logfile: \fI<filename> If "" is given, logging goes to stderr, or nowhere once daemonized. -The logfile is appended to, in the following format: +The logfile is appended to, in the following format: .nf -[seconds since 1970] unbound[pid:tid]: type: message. +[seconds since 1970] unbound[pid:tid]: type: message. .fi If this option is given, the use\-syslog is option is set to "no". -The logfile is reopened (for append) when the config file is reread, on +The logfile is reopened (for append) when the config file is reread, on SIGHUP. .TP .B use\-syslog: \fI<yes or no> -Sets unbound to send log messages to the syslogd, using -\fIsyslog\fR(3). +Sets unbound to send log messages to the syslogd, using +\fIsyslog\fR(3). The log facility LOG_DAEMON is used, with identity "unbound". The logfile setting is overridden when use\-syslog is turned on. The default is to log to syslog. @@ -565,20 +567,20 @@ lines which makes the server (significantly) slower. Odd (nonprintable) characters in names are printed as '?'. .TP .B pidfile: \fI<filename> -The process id is written to the file. Default is "@UNBOUND_PIDFILE@". +The process id is written to the file. Default is "@UNBOUND_PIDFILE@". So, .nf -kill \-HUP `cat @UNBOUND_PIDFILE@` +kill \-HUP `cat @UNBOUND_PIDFILE@` .fi triggers a reload, .nf -kill \-TERM `cat @UNBOUND_PIDFILE@` +kill \-TERM `cat @UNBOUND_PIDFILE@` .fi gracefully terminates. .TP .B root\-hints: \fI<filename> Read the root hints from this file. Default is nothing, using builtin hints -for the IN class. The file has the format of zone files, with root +for the IN class. The file has the format of zone files, with root nameserver names and addresses only. The default may become outdated, when servers change, therefore it is good practice to use a root\-hints file. .TP @@ -602,22 +604,22 @@ If enabled trustanchor.unbound queries are refused. .B target\-fetch\-policy: \fI<"list of numbers"> Set the target fetch policy used by unbound to determine if it should fetch nameserver target addresses opportunistically. The policy is described per -dependency depth. +dependency depth. .IP The number of values determines the maximum dependency depth -that unbound will pursue in answering a query. +that unbound will pursue in answering a query. A value of \-1 means to fetch all targets opportunistically for that dependency depth. A value of 0 means to fetch on demand only. A positive value fetches -that many targets opportunistically. +that many targets opportunistically. .IP Enclose the list between quotes ("") and put spaces between numbers. The default is "3 2 1 0 0". Setting all zeroes, "0 0 0 0 0" gives behaviour -closer to that of BIND 9, while setting "\-1 \-1 \-1 \-1 \-1" gives behaviour +closer to that of BIND 9, while setting "\-1 \-1 \-1 \-1 \-1" gives behaviour rumoured to be closer to that of BIND 8. .TP .B harden\-short\-bufsize: \fI<yes or no> Very small EDNS buffer sizes from queries are ignored. Default is off, since -it is legal protocol wise to send these, and unbound tries to give very +it is legal protocol wise to send these, and unbound tries to give very small answers to these queries, where possible. .TP .B harden\-large\-queries: \fI<yes or no> @@ -631,11 +633,11 @@ Will trust glue only if it is within the servers authority. Default is on. .B harden\-dnssec\-stripped: \fI<yes or no> Require DNSSEC data for trust\-anchored zones, if such data is absent, the zone becomes bogus. If turned off, and no DNSSEC data is received -(or the DNSKEY data fails to validate), then the zone is made insecure, -this behaves like there is no trust anchor. You could turn this off if -you are sometimes behind an intrusive firewall (of some sort) that -removes DNSSEC data from packets, or a zone changes from signed to -unsigned to badly signed often. If turned off you run the risk of a +(or the DNSKEY data fails to validate), then the zone is made insecure, +this behaves like there is no trust anchor. You could turn this off if +you are sometimes behind an intrusive firewall (of some sort) that +removes DNSSEC data from packets, or a zone changes from signed to +unsigned to badly signed often. If turned off you run the risk of a downgrade attack that disables security for a zone. Default is on. .TP .B harden\-below\-nxdomain: \fI<yes or no> @@ -653,7 +655,7 @@ The nxdomain must be secure, this means nsec3 with optout is insufficient. Harden the referral path by performing additional queries for infrastructure data. Validates the replies if trust anchors are configured and the zones are signed. This enforces DNSSEC validation on nameserver -NS sets and the nameserver addresses that are encountered on the referral +NS sets and the nameserver addresses that are encountered on the referral path to the answer. Default off, because it burdens the authority servers, and it is not RFC standard, and could lead to performance problems because of the @@ -670,9 +672,9 @@ this option off avoids that validation failure. .TP .B use\-caps\-for\-id: \fI<yes or no> Use 0x20\-encoded random bits in the query to foil spoof attempts. -This perturbs the lowercase and uppercase of query names sent to -authority servers and checks if the reply still has the correct casing. -Disabled by default. +This perturbs the lowercase and uppercase of query names sent to +authority servers and checks if the reply still has the correct casing. +Disabled by default. This feature is an experimental implementation of draft dns\-0x20. .TP .B caps\-whitelist: \fI<domain> @@ -683,7 +685,7 @@ Can be given multiple times, for different domains. .TP .B qname\-minimisation: \fI<yes or no> Send minimum amount of information to upstream servers to enhance privacy. -Only sent minimum required labels of the QNAME and set QTYPE to NS when +Only sent minimum required labels of the QNAME and set QTYPE to NS when possible. Best effort approach; full QNAME and original QTYPE will be sent when upstream replies with a RCODE other than NOERROR, except when receiving NXDOMAIN from a DNSSEC signed zone. Default is off. @@ -715,7 +717,7 @@ stops IPv4-mapped IPv6 addresses from bypassing the filter. .TP .B private\-domain: \fI<domain name> Allow this domain, and all its subdomains to contain private addresses. -Give multiple times to allow multiple domain names to contain private +Give multiple times to allow multiple domain names to contain private addresses. Default is none. .TP .B unwanted\-reply\-threshold: \fI<number> @@ -726,7 +728,7 @@ message caches, hopefully flushing away any poison. A value of 10 million is suggested. Default is 0 (turned off). .TP .B do\-not\-query\-address: \fI<IP address> -Do not query the given IP address. Can be IP4 or IP6. Append /num to +Do not query the given IP address. Can be IP4 or IP6. Append /num to indicate a classless delegation netblock, for example like 10.2.3.4/24 or 2001::11/64. .TP @@ -793,17 +795,20 @@ A DS or DNSKEY RR for a key to use for validation. Multiple entries can be given to specify multiple trusted keys, in addition to the trust\-anchor\-files. The resource record is entered in the same format as 'dig' or 'drill' prints them, the same format as in the zone file. Has to be on a single line, with -"" around it. A TTL can be specified for ease of cut and paste, but is ignored. +"" around it. A TTL can be specified for ease of cut and paste, but is ignored. A class can be specified, but class IN is default. .TP .B trusted\-keys\-file: \fI<filename> File with trusted keys for validation. Specify more than one file with several entries, one file per entry. Like \fBtrust\-anchor\-file\fR -but has a different file format. Format is BIND\-9 style format, +but has a different file format. Format is BIND\-9 style format, the trusted\-keys { name flag proto algo "key"; }; clauses are read. It is possible to use wildcards with this statement, the wildcard is expanded on start and on reload. .TP +.B trust\-anchor\-signaling: \fI<yes or no> +Send RFC8145 key tag query after trust anchor priming. Default is off. +.TP .B dlv\-anchor\-file: \fI<filename> This option was used during early days DNSSEC deployment when no parent-side DS record registrations were easily available. Nowadays, it is best to have @@ -811,9 +816,9 @@ DS records registered with the parent zone (many top level zones are signed). File with trusted keys for DLV (DNSSEC Lookaside Validation). Both DS and DNSKEY entries can be used in the file, in the same format as for \fItrust\-anchor\-file:\fR statements. Only one DLV can be configured, more -would be slow. The DLV configured is used as a root trusted DLV, this -means that it is a lookaside for the root. Default is "", or no dlv anchor file. -DLV is going to be decommissioned. Please do not use it any more. +would be slow. The DLV configured is used as a root trusted DLV, this +means that it is a lookaside for the root. Default is "", or no dlv anchor +file. DLV is going to be decommissioned. Please do not use it any more. .TP .B dlv\-anchor: \fI<"Resource Record"> Much like trust\-anchor, this is a DLV anchor with the DS or DNSKEY inline. @@ -825,17 +830,17 @@ the domain name. So a trust anchor above the domain name can not make the domain secure with a DS record, such a DS record is then ignored. Also keys from DLV are ignored for the domain. Can be given multiple times to specify multiple domains that are treated as if unsigned. If you set -trust anchors for the domain they override this setting (and the domain +trust anchors for the domain they override this setting (and the domain is secured). .IP This can be useful if you want to make sure a trust anchor for external -lookups does not affect an (unsigned) internal domain. A DS record +lookups does not affect an (unsigned) internal domain. A DS record externally can create validation failures for that internal domain. .TP .B val\-override\-date: \fI<rrsig\-style date spec> Default is "" or "0", which disables this debugging feature. If enabled by giving a RRSIG style date, that date is used for verifying RRSIG inception -and expiration dates, instead of the current date. Do not set this unless +and expiration dates, instead of the current date. Do not set this unless you are debugging signature inception and expiration. The value \-1 ignores the date altogether, useful for some special applications. .TP @@ -865,7 +870,7 @@ The time interval prevents repeated revalidation of bogus data. Instruct the validator to remove data from the additional section of secure messages that are not signed properly. Messages that are insecure, bogus, indeterminate or unchecked are not affected. Default is yes. Use this setting -to protect the users that rely on this validator for authentication from +to protect the users that rely on this validator for authentication from potentially bad data in the additional section. .TP .B val\-log\-level: \fI<number> @@ -880,10 +885,10 @@ it was wrong and which server sent the faulty data. .B val\-permissive\-mode: \fI<yes or no> Instruct the validator to mark bogus messages as indeterminate. The security checks are performed, but if the result is bogus (failed security), the -reply is not withheld from the client with SERVFAIL as usual. The client -receives the bogus data. For messages that are found to be secure the AD bit +reply is not withheld from the client with SERVFAIL as usual. The client +receives the bogus data. For messages that are found to be secure the AD bit is set in replies. Also logging is performed as for full validation. -The default value is "no". +The default value is "no". .TP .B ignore\-cd\-flag: \fI<yes or no> Instruct unbound to ignore the CD flag from clients and refuse to @@ -903,7 +908,7 @@ List of keysize and iteration count values, separated by spaces, surrounded by quotes. Default is "1024 150 2048 500 4096 2500". This determines the maximum allowed NSEC3 iteration count before a message is simply marked insecure instead of performing the many hashing iterations. The list must -be in ascending order and have at least one entry. If you set it to +be in ascending order and have at least one entry. If you set it to "1024 65535" there is no restriction to NSEC3 iteration values. This table must be kept short; a very long list could cause slower operation. .TP @@ -938,7 +943,7 @@ or gigabytes (1024*1024 bytes in a megabyte). .TP .B key\-cache\-slabs: \fI<number> Number of slabs in the key cache. Slabs reduce lock contention by threads. -Must be set to a power of 2. Setting (close) to the number of cpus is a +Must be set to a power of 2. Setting (close) to the number of cpus is a reasonable guess. .TP .B neg\-cache\-size: \fI<number> @@ -989,7 +994,7 @@ Otherwise, the query is answered with nodata or nxdomain. For a negative answer a SOA is included in the answer if present as local\-data for the zone apex domain. .TP 10 -\h'5'\fItransparent\fR +\h'5'\fItransparent\fR If there is a match from local data, the query is answered. Otherwise if the query has a different name, the query is resolved normally. If the query is for a name given in localdata but no such type of data is @@ -997,49 +1002,49 @@ given in localdata, then a noerror nodata answer is returned. If no local\-zone is given local\-data causes a transparent zone to be created by default. .TP 10 -\h'5'\fItypetransparent\fR +\h'5'\fItypetransparent\fR If there is a match from local data, the query is answered. If the query is for a different name, or for the same name but for a different type, the query is resolved normally. So, similar to transparent but types that are not listed in local data are resolved normally, so if an A record is in the local data that does not cause a nodata reply for AAAA queries. .TP 10 -\h'5'\fIredirect\fR +\h'5'\fIredirect\fR The query is answered from the local data for the zone name. There may be no local data beneath the zone name. This answers queries for the zone, and all subdomains of the zone with the local data for the zone. It can be used to redirect a domain to return a different address record -to the end user, with -local\-zone: "example.com." redirect and +to the end user, with +local\-zone: "example.com." redirect and local\-data: "example.com. A 127.0.0.1" queries for www.example.com and www.foo.example.com are redirected, so that users with web browsers cannot access sites with suffix example.com. .TP 10 -\h'5'\fIinform\fR +\h'5'\fIinform\fR The query is answered normally, same as transparent. The client IP address (@portnumber) is printed to the logfile. The log message is: timestamp, unbound-pid, info: zonename inform IP@port queryname type class. This option can be used for normal resolution, but machines looking up infected names are logged, eg. to run antivirus on them. .TP 10 -\h'5'\fIinform_deny\fR +\h'5'\fIinform_deny\fR The query is dropped, like 'deny', and logged, like 'inform'. Ie. find infected machines without answering the queries. .TP 10 -\h'5'\fIalways_transparent\fR +\h'5'\fIalways_transparent\fR Like transparent, but ignores local data and resolves normally. .TP 10 -\h'5'\fIalways_refuse\fR +\h'5'\fIalways_refuse\fR Like refuse, but ignores local data and refuses the query. .TP 10 -\h'5'\fIalways_nxdomain\fR +\h'5'\fIalways_nxdomain\fR Like static, but ignores local data and returns nxdomain for the query. .TP 10 -\h'5'\fInodefault\fR +\h'5'\fInodefault\fR Used to turn off default contents for AS112 zones. The other types -also turn off default contents for the zone. The 'nodefault' option -has no other effect than turning off default contents for the +also turn off default contents for the zone. The 'nodefault' option +has no other effect than turning off default contents for the given zone. Use \fInodefault\fR if you use exactly that zone, if you want to use a subzone, use \fItransparent\fR. .P @@ -1048,71 +1053,71 @@ the AS112 zones. The AS112 zones are reverse DNS zones for private use and reserved IP addresses for which the servers on the internet cannot provide correct answers. They are configured by default to give nxdomain (no reverse information) answers. The defaults can be turned off by specifying your -own local\-zone of that name, or using the 'nodefault' type. Below is a +own local\-zone of that name, or using the 'nodefault' type. Below is a list of the default zone contents. .TP 10 -\h'5'\fIlocalhost\fR +\h'5'\fIlocalhost\fR The IP4 and IP6 localhost information is given. NS and SOA records are provided for completeness and to satisfy some DNS update tools. Default content: .nf local\-zone: "localhost." static local\-data: "localhost. 10800 IN NS localhost." -local\-data: "localhost. 10800 IN +local\-data: "localhost. 10800 IN SOA localhost. nobody.invalid. 1 3600 1200 604800 10800" local\-data: "localhost. 10800 IN A 127.0.0.1" local\-data: "localhost. 10800 IN AAAA ::1" .fi .TP 10 -\h'5'\fIreverse IPv4 loopback\fR +\h'5'\fIreverse IPv4 loopback\fR Default content: .nf local\-zone: "127.in\-addr.arpa." static local\-data: "127.in\-addr.arpa. 10800 IN NS localhost." -local\-data: "127.in\-addr.arpa. 10800 IN +local\-data: "127.in\-addr.arpa. 10800 IN SOA localhost. nobody.invalid. 1 3600 1200 604800 10800" -local\-data: "1.0.0.127.in\-addr.arpa. 10800 IN +local\-data: "1.0.0.127.in\-addr.arpa. 10800 IN PTR localhost." .fi .TP 10 -\h'5'\fIreverse IPv6 loopback\fR +\h'5'\fIreverse IPv6 loopback\fR Default content: .nf 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." static local\-data: "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. 10800 IN + 0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa. 10800 IN NS localhost." local\-data: "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. 10800 IN + 0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa. 10800 IN SOA localhost. nobody.invalid. 1 3600 1200 604800 10800" local\-data: "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. 10800 IN + 0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa. 10800 IN PTR localhost." .fi .TP 10 -\h'5'\fIonion (RFC 7686)\fR +\h'5'\fIonion (RFC 7686)\fR Default content: .nf local\-zone: "onion." static local\-data: "onion. 10800 IN NS localhost." -local\-data: "onion. 10800 IN +local\-data: "onion. 10800 IN SOA localhost. nobody.invalid. 1 3600 1200 604800 10800" .fi .TP 10 -\h'5'\fIreverse RFC1918 local use zones\fR -Reverse data for zones 10.in\-addr.arpa, 16.172.in\-addr.arpa to +\h'5'\fIreverse RFC1918 local use zones\fR +Reverse data for zones 10.in\-addr.arpa, 16.172.in\-addr.arpa to 31.172.in\-addr.arpa, 168.192.in\-addr.arpa. -The \fBlocal\-zone:\fR is set static and as \fBlocal\-data:\fR SOA and NS +The \fBlocal\-zone:\fR is set static and as \fBlocal\-data:\fR SOA and NS records are provided. .TP 10 -\h'5'\fIreverse RFC3330 IP4 this, link\-local, testnet and broadcast\fR -Reverse data for zones 0.in\-addr.arpa, 254.169.in\-addr.arpa, +\h'5'\fIreverse RFC3330 IP4 this, link\-local, testnet and broadcast\fR +Reverse data for zones 0.in\-addr.arpa, 254.169.in\-addr.arpa, 2.0.192.in\-addr.arpa (TEST NET 1), 100.51.198.in\-addr.arpa (TEST NET 2), 113.0.203.in\-addr.arpa (TEST NET 3), 255.255.255.255.in\-addr.arpa. And from 64.100.in\-addr.arpa to 127.100.in\-addr.arpa (Shared Address Space). .TP 10 \h'5'\fIreverse RFC4291 IP6 unspecified\fR -Reverse data for zone +Reverse data for zone .nf 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. @@ -1137,11 +1142,11 @@ This also works with the other default zones. .TP 5 .B local\-data: \fI"<resource record string>" Configure local data, which is served in reply to queries for it. -The query has to match exactly unless you configure the local\-zone as +The query has to match exactly unless you configure the local\-zone as redirect. If not matched exactly, the local\-zone type determines further processing. If local\-data is configured that is not a subdomain of -a local\-zone, a transparent local\-zone is configured. -For record types such as TXT, use single quotes, as in +a local\-zone, a transparent local\-zone is configured. +For record types such as TXT, use single quotes, as in local\-data: 'example. TXT "text"'. .IP If you need more complicated authoritative data, with referrals, wildcards, @@ -1160,7 +1165,7 @@ used access-control element has a matching tag. Tags must be defined in tags. .TP 5 .B local\-zone\-override: \fI<zone> <IP netblock> <type> -Override the localzone type for queries from addresses matching netblock. +Override the localzone type for queries from addresses matching netblock. Use this localzone type, regardless the type configured for the local-zone (both tagged and untagged) and regardless the type configured using access\-control\-tag\-action. @@ -1197,18 +1202,20 @@ This can make ordinary queries complete (if repeatedly queried for), and enter the cache, whilst also mitigating the traffic flow by the factor given. .TP 5 -.B ratelimit\-for\-domain: \fI<domain> <number qps> +.B ratelimit\-for\-domain: \fI<domain> <number qps or 0> Override the global ratelimit for an exact match domain name with the listed number. You can give this for any number of names. For example, for a top\-level\-domain you may want to have a higher limit than other names. +A value of 0 will disable ratelimiting for that domain. .TP 5 -.B ratelimit\-below\-domain: \fI<domain> <number qps> +.B ratelimit\-below\-domain: \fI<domain> <number qps or 0> Override the global ratelimit for a domain name that ends in this name. You can give this multiple times, it then describes different settings in different parts of the namespace. The closest matching suffix is used to determine the qps limit. The rate for the exact matching domain name is not changed, use ratelimit\-for\-domain to set that, you might want to use different settings for a top\-level\-domain and subdomains. +A value of 0 will disable ratelimiting for domain names that end in this name. .TP 5 .B ip\-ratelimit: \fI<number or 0> Enable global ratelimiting of queries accepted per ip address. @@ -1304,21 +1311,21 @@ the recursive processing itself for stub zones. .P The stub zone can be used to configure authoritative data to be used by the resolver that cannot be accessed using the public internet servers. -This is useful for company\-local data or private zones. Setup an -authoritative server on a different host (or different port). Enter a config -entry for unbound with +This is useful for company\-local data or private zones. Setup an +authoritative server on a different host (or different port). Enter a config +entry for unbound with .B stub\-addr: -<ip address of host[@port]>. -The unbound resolver can then access the data, without referring to the -public internet for it. +<ip address of host[@port]>. +The unbound resolver can then access the data, without referring to the +public internet for it. .P -This setup allows DNSSEC signed zones to be served by that +This setup allows DNSSEC signed zones to be served by that authoritative server, in which case a trusted key entry with the public key -can be put in config, so that unbound can validate the data and set the AD -bit on replies for the private zone (authoritative servers do not set the -AD bit). This setup makes unbound capable of answering queries for the -private zone, and can even set the AD bit ('authentic'), but the AA -('authoritative') bit is not set on these replies. +can be put in config, so that unbound can validate the data and set the AD +bit on replies for the private zone (authoritative servers do not set the +AD bit). This setup makes unbound capable of answering queries for the +private zone, and can even set the AD bit ('authentic'), but the AA +('authoritative') bit is not set on these replies. .P Consider adding \fBserver:\fR statements for \fBdomain\-insecure:\fR and for \fBlocal\-zone:\fI name nodefault\fR for the zone if it is a locally @@ -1337,8 +1344,8 @@ IP address of stub zone nameserver. Can be IP 4 or IP 6. To use a nondefault port for DNS communication append '@' with the port number. .TP .B stub\-prime: \fI<yes or no> -This option is by default off. If enabled it performs NS set priming, -which is similar to root hints, where it starts using the list of nameservers +This option is by default off. If enabled it performs NS set priming, +which is similar to root hints, where it starts using the list of nameservers currently published by the zone. Thus, if the hint list is slightly outdated, the resolver picks up a correct list online. .TP @@ -1390,10 +1397,10 @@ Default is no. There may be multiple .B view: clauses. Each with a \fBname:\fR and zero or more \fBlocal\-zone\fR and -\fBlocal\-data\fR elements. View can be mapped to requests by specifying the view -name in an \fBaccess\-control\-view\fR element. Options from matching views will -override global options. Global options will be used if no matching view -is found. +\fBlocal\-data\fR elements. View can be mapped to requests by specifying the +view name in an \fBaccess\-control\-view\fR element. Options from matching +views will override global options. Global options will be used if no matching +view is found, or when the matching view does not have the option specified. .TP .B name: \fI<view name> Name of the view. Must be unique. This name is used in access\-control\-view @@ -1401,7 +1408,11 @@ elements. .TP .B local\-zone: \fI<zone> <type> View specific local\-zone elements. Has the same types and behaviour as the -global local\-zone elements. +global local\-zone elements. When there is at least one local\-zone specified +and view\-first is no, the default local-zones will be added to this view. +Defaults can be disabled using the nodefault type. When view\-first is yes or +when a view does not have a local\-zone, the global local\-zone will be used +including it's default zones. .TP .B local\-data: \fI"<resource record string>" View specific local\-data elements. Has the same behaviour as the global @@ -1454,7 +1465,8 @@ clause give the settings of the dnscrypt channel. While those options are available, they are only meaningful if unbound was compiled with \fB\-\-enable\-dnscrypt\fR. Currently certificate and secret/public keys cannot be generated by unbound. -You can use dnscrypt-wrapper to generate those: https://github.com/cofyc/dnscrypt-wrapper/blob/master/README.md#usage +You can use dnscrypt-wrapper to generate those: https://github.com/cofyc/\ +dnscrypt-wrapper/blob/master/README.md#usage .TP .B dnscrypt\-enable: \fI<yes or no>\fR Whether or not the \fBdnscrypt\fR config should be enabled. You may define @@ -1475,23 +1487,24 @@ Path to the time limited secret key file. This option may be specified multiple times. .TP .B dnscrypt\-provider\-cert: \fI<path to cert file>\fR -Path to the certificate related to the \fBdnscrypt\-secret\-key\fRs. This option -may be specified multiple times. +Path to the certificate related to the \fBdnscrypt\-secret\-key\fRs. +This option may be specified multiple times. .SS "EDNS Client Subnet Module Options" .LP The ECS module must be configured in the \fBmodule\-config:\fR "subnetcache validator iterator" directive and be compiled into the daemon to be enabled. These settings go in the \fBserver:\fR section. .LP -If the destination address is whitelisted with Unbound will add the EDNS0 option -to the query containing the relevant part of the client's address. When an -answer contains the ECS option the response and the option are placed in a -specialized cache. If the authority indicated no support, the response is stored -in the regular cache. +If the destination address is whitelisted with Unbound will add the EDNS0 +option to the query containing the relevant part of the client's address. When +an answer contains the ECS option the response and the option are placed in a +specialized cache. If the authority indicated no support, the response is +stored in the regular cache. .LP Additionally, when a client includes the option in its queries, Unbound will -forward the option to the authority regardless of the authorities presence in -the whitelist. In this case the lookup in the regular cache is skipped. +forward the option to the authority if prensent in the whitelist, or +\fBclient\-subnet\-always\-forward\fR is set to yes. In this case the lookup in +the regular cache is skipped. .LP The maximum size of the ECS cache is controlled by 'msg-cache-size' in the configuration file. On top of that, for each query only 100 different subnets @@ -1502,7 +1515,12 @@ entries will be purged from cache. Send client source address to this authority. Append /num to indicate a classless delegation netblock, for example like 10.2.3.4/24 or 2001::11/64. Can be given multiple times. Authorities not listed will not receive edns-subnet -information. +information, unless domain in query is specified in \fBclient\-subnet\-zone\fR. +.TP +.B client\-subnet\-zone: \fI<domain>\fR +Send client source address in queries for this domain and its subdomains. Can be +given multiple times. Zones not listed will not receive edns-subnet information, +unless hosted by authority specified in \fBsend\-client\-subnet\fR. .TP .B client\-subnet\-always\-forward: \fI<yes or no>\fR Specify whether the ECS whitelist check (configured using @@ -1519,6 +1537,72 @@ to expose to third parties for IPv6. Defaults to 56. .B max\-client\-subnet\-ipv4: \fI<number>\fR Specifies the maximum prefix length of the client source address we are willing to expose to third parties for IPv4. Defaults to 24. +.SS "Opportunistic IPsec Support Module Options" +.LP +The IPsec module must be configured in the \fBmodule\-config:\fR "ipsecmod +validator iterator" directive and be compiled into the daemon to be +enabled. These settings go in the \fBserver:\fR section. +.LP +When unbound receives an A/AAAA query that is not in the cache and finds a +valid answer, it will withhold returning the answer and instead will generate +an IPSECKEY subquery for the same domain name. If an answer was found, unbound +will call an external hook passing the following arguments: +.TP 10 +\h'5'\fIQNAME\fR +Domain name of the A/AAAA and IPSECKEY query. In string format. +.TP 10 +\h'5'\fIIPSECKEY TTL\fR +TTL of the IPSECKEY RRset. +.TP 10 +\h'5'\fIA/AAAA\fR +String of space separated IP addresses present in the A/AAAA RRset. The IP +addresses are in string format. +.TP 10 +\h'5'\fIIPSECKEY\fR +String of space separated IPSECKEY RDATA present in the IPSECKEY RRset. The +IPSECKEY RDATA are in DNS presentation format. +.LP +The A/AAAA answer is then cached and returned to the client. If the external +hook was called the TTL changes to ensure it doesn't surpass +\fBipsecmod-max-ttl\fR. +.LP +The same procedure is also followed when \fBprefetch:\fR is used, but the +A/AAAA answer is given to the client before the hook is called. +\fBipsecmod-max-ttl\fR ensures that the A/AAAA answer given from cache is still +relevant for opportunistic IPsec. +.TP +.B ipsecmod-enabled: \fI<yes or no>\fR +Specifies whether the IPsec module is enabled or not. The IPsec module still +needs to be defined in the \fBmodule\-config:\fR directive. This option +facilitates turning on/off the module without restarting/reloading unbound. +Defaults to yes. +.TP +.B ipsecmod\-hook: \fI<filename>\fR +Specifies the external hook that unbound will call with \fIsystem\fR(3). The +file can be specified as an absolute/relative path. The file needs the proper +permissions to be able to be executed by the same user that runs unbound. It +must be present when the IPsec module is defined in the \fBmodule\-config:\fR +directive. +.TP +.B ipsecmod-strict: \fI<yes or no>\fR +If enabled unbound requires the external hook to return a success value of 0. +Failing to do so unbound will reply with SERVFAIL. The A/AAAA answer will also +not be cached. Defaults to no. +.TP +.B ipsecmod\-max-ttl: \fI<seconds>\fR +Time to live maximum for A/AAAA cached records after calling the external hook. +Defaults to 3600. +.TP +.B ipsecmod-ignore-bogus: \fI<yes or no>\fR +Specifies the behaviour of unbound when the IPSECKEY answer is bogus. If set +to yes, the hook will be called and the A/AAAA answer will be returned to the +client. If set to no, the hook will not be called and the answer to the +A/AAAA query will be SERVFAIL. Mainly used for testing. Defaults to no. +.TP +.B ipsecmod\-whitelist: \fI<domain>\fR +Whitelist the domain so that the module logic will be executed. Can +be given multiple times, for different domains. If the option is not +specified, all domains are treated as being whitelisted (default). .SH "MEMORY CONTROL EXAMPLE" In the example config settings below memory usage is reduced. Some service levels are lower, notable very large data and a high TCP load are no longer @@ -1526,7 +1610,7 @@ supported. Very large data and high TCP loads are exceptional for the DNS. DNSSEC validation is enabled, just add trust anchors. If you do not have to worry about programs using more than 3 Mb of memory, the below example is not for you. Use the defaults to receive full service, -which on BSD\-32bit tops out at 30\-40 Mb after heavy usage. +which on BSD\-32bit tops out at 30\-40 Mb after heavy usage. .P .nf # example settings that reduce memory usage @@ -1567,12 +1651,12 @@ unbound configuration file. default unbound pidfile with process ID of the running daemon. .TP .I unbound.log -unbound log file. default is to log to -\fIsyslog\fR(3). +unbound log file. default is to log to +\fIsyslog\fR(3). .SH "SEE ALSO" -\fIunbound\fR(8), +\fIunbound\fR(8), \fIunbound\-checkconf\fR(8). .SH "AUTHORS" -.B Unbound +.B Unbound was written by NLnet Labs. Please see CREDITS file in the distribution for further details. |