From 22b8057cca4b7faa29878fa2c7b0ab8bfcd26df5 Mon Sep 17 00:00:00 2001 From: Wouter Wijngaards Date: Thu, 10 Jan 2008 15:46:55 +0000 Subject: [PATCH] man page fixes for Solaris. git-svn-id: file:///svn/unbound/trunk@838 be551aaa-1e26-0410-a405-d3ace91eadb9 --- doc/Changelog | 1 + doc/unbound-checkconf.8 | 52 ++--- doc/unbound-host.1 | 110 +++++---- doc/unbound.8 | 60 ++--- doc/unbound.conf.5 | 488 +++++++++++++++++++++++----------------- 5 files changed, 404 insertions(+), 307 deletions(-) diff --git a/doc/Changelog b/doc/Changelog index 2a5b0c231..20ec8b28c 100644 --- a/doc/Changelog +++ b/doc/Changelog @@ -4,6 +4,7 @@ by linking with .lo instead of .o files in the ldns package. - nicer do-ip6: yes/no documentation. - nicer linking of libevent .o files. + - man pages render correctly on solaris. 9 January 2008: Wouter - fixup openssl RAND problem, when the system is not configured to diff --git a/doc/unbound-checkconf.8 b/doc/unbound-checkconf.8 index 2f936346f..ac4c8889a 100644 --- a/doc/unbound-checkconf.8 +++ b/doc/unbound-checkconf.8 @@ -1,3 +1,4 @@ +.TH "unbound-checkconf" "8" "@date@" "NLnet Labs" "unbound @version@" .\" .\" unbound-checkconf.8 -- unbound configuration checker manual .\" @@ -6,40 +7,37 @@ .\" See LICENSE for the license. .\" .\" -.Dd @date@ -.Dt unbound-checkconf 8 -.Sh NAME +.SH "NAME" +.LP unbound-checkconf -.Nd Check unbound configuration file for errors. -.Sh SYNOPSIS -.Nm unbound-checkconf -.Op Fl h -.Op cfgfile -.Sh DESCRIPTION -.Ic Unbound-checkconf +\- Check unbound configuration file for errors. +.SH "SYNOPSIS" +.B unbound-checkconf +.RB [ \-h ] +.IR cfgfile +.SH "DESCRIPTION" +.B Unbound-checkconf checks the configuration file for the -.Xr unbound 8 +\fIunbound\fR(8) DNS resolver for syntax and other errors. -The config file syntax is -described in -.Xr unbound.conf 5 . -.Pp +The config file syntax is described in +\fIunbound.conf\fR(5). +.P The available options are: -.Bl -tag -width indent -.It Fl h +.TP +.B \-h Show the version and commandline option help. -.It cfgfile +.TP +.I cfgfile The config file to read with settings for unbound. It is checked. If omitted, the config file at the default location is checked. -.El -.Sh EXIT CODE +.SH "EXIT CODE" The unbound-checkconf program exits with status code 1 on error, 0 for a correct config file. -.Sh FILES -.Bl -tag -width indent -.It Pa /etc/unbound/unbound.conf +.SH "FILES" +.TP +.I /etc/unbound/unbound.conf unbound configuration file. -.El -.Sh SEE ALSO -.Xr unbound.conf 5 , -.Xr unbound 8 . +.SH "SEE ALSO" +\fIunbound.conf\fR(5), +\fIunbound\fR(8). diff --git a/doc/unbound-host.1 b/doc/unbound-host.1 index ce4de940c..699e743c3 100644 --- a/doc/unbound-host.1 +++ b/doc/unbound-host.1 @@ -1,3 +1,4 @@ +.TH "unbound\-host" "1" "@date@" "NLnet Labs" "unbound @version@" .\" .\" unbound-host.1 -- unbound DNS lookup utility .\" @@ -6,74 +7,87 @@ .\" See LICENSE for the license. .\" .\" -.Dd @date@ -.Dt unbound-host 1 -.Sh NAME -unbound-host -.Nd unbound DNS lookup utility -.Sh SYNOPSIS -.Nm unbound-host -.Op Fl vdh -.Op Fl c Ar class -.Op Fl t Ar type -hostname -.Op Fl y Ar key -.Op Fl f Ar keyfile -.Op Fl F Ar namedkeyfile -.Sh DESCRIPTION -.Ic Unbound-host -Uses the unbound validating resolver to query for the hostname and display -results. With the \fB-v\fR option it displays validation +.SH "NAME" +.LP +.B unbound\-host +\- unbound DNS lookup utility +.SH "SYNOPSIS" +.LP +.B unbound\-host +.RB [ \-vdh ] +.RB [ \-c +.IR class ] +.RB [ \-t +.IR type ] +.I hostname +.RB [ \-y +.IR key ] +.RB [ \-f +.IR keyfile ] +.RB [ \-F +.IR namedkeyfile ] +.SH "DESCRIPTION" +.LP +.B Unbound\-host +uses the unbound validating resolver to query for the hostname and display +results. With the \fB\-v\fR option it displays validation status: secure, insecure, bogus (security failure). - -.Pp +.P The available options are: -.Bl -tag -width indent -.It hostname +.TP +.I hostname This name is resolved (looked up in the DNS). If a IPv4 or IPv6 address is given, a reverse lookup is performed. -.It Fl h +.TP +.B \-h Show the version and commandline option help. -.It Fl v +.TP +.B \-v Enable verbose output and it shows validation results, on every line. Secure means that the NXDOMAIN (no such domain name), nodata (no such data) or positive data response validated correctly with one of the keys. Insecure means that that domain name has no security set up for it. Bogus (security failure) means that the response failed one or more checks, it is likely wrong, outdated, tampered with, or broken. -.It Fl d -Enable debug output to stderr. One -d shows what the resolver and validator -are doing and may tell you what is going on. More times, -d -d, gives a +.TP +.B \-d +Enable debug output to stderr. One \-d shows what the resolver and validator +are doing and may tell you what is going on. More times, \-d \-d, gives a lot of output, with every packet sent and received. -.It Fl c Ar class +.TP +.B \-c \fIclass Specify the class to lookup for, the default is IN the internet class. -.It Fl t Ar type +.TP +.B \-t \fItype Specify the type of data to lookup. The default looks for IPv4, IPv6 and mail handler data, or domain name pointers for reverse queries. -.It Fl y Ar key +.TP +.B \-y \fIkey Specify a public key to use as trust anchor. This is the base for a chain of trust that is built up from the trust anchor to the response, in order to validate the response message. Can be given as a DS or DNSKEY record. -For example -y "example.com DS 31560 5 1 1CFED84787E6E19CCF9372C1187325972FE546CD". -.It Fl f Ar keyfile +For example \-y "example.com DS 31560 5 1 1CFED84787E6E19CCF9372C1187325972FE546CD". +.TP +.B \-f \fIkeyfile Reads keys from a file. Every line has a DS or DNSKEY record, in the format -as for -y. The zone file format, the same as dig and drill produce. -.It Fl F Ar namedkeyfile -Reads keys from a BIND-style named.conf file. Only the trusted-key {}; entries +as for \-y. The zone file format, the same as dig and drill produce. +.TP +.B \-F \fInamedkeyfile +Reads keys from a BIND\-style named.conf file. Only the trusted\-key {}; entries are read. -.El -.Sh EXAMPLES +.SH "EXAMPLES" +.LP Some examples of use. -.Pp -$ unbound-host www.example.com -.Pp -$ unbound-host -v -y "example.com DS 31560 5 1 1CFED84787E6E19CCF9372C1187325972FE546CD" www.example.com -.Pp -$ unbound-host -v -y "example.com DS 31560 5 1 1CFED84787E6E19CCF9372C1187325972FE546CD" 192.0.2.153 -.Sh EXIT CODE -The unbound-host program exits with status code 1 on error, +.P +$ unbound\-host www.example.com +.P +$ unbound\-host \-v \-y "example.com DS 31560 5 1 1CFED84787E6E19CCF9372C1187325972FE546CD" www.example.com +.P +$ unbound\-host \-v \-y "example.com DS 31560 5 1 1CFED84787E6E19CCF9372C1187325972FE546CD" 192.0.2.153 +.SH "EXIT CODE" +The unbound\-host program exits with status code 1 on error, 0 on no error. The data may not be available on exit code 0, exit code 1 means the lookup encountered a fatal error. -.Sh SEE ALSO -.Xr unbound.conf 5 , -.Xr unbound 8 . +.SH "SEE ALSO" +\fIunbound.conf\fR(5), +\fIunbound\fR(8). diff --git a/doc/unbound.8 b/doc/unbound.8 index 48e90454c..403a7ec49 100644 --- a/doc/unbound.8 +++ b/doc/unbound.8 @@ -1,3 +1,4 @@ +.TH "unbound" "8" "@date@" "NLnet Labs" "unbound @version@" .\" .\" unbound.8 -- unbound manual .\" @@ -6,42 +7,45 @@ .\" See LICENSE for the license. .\" .\" -.Dd @date@ -.Dt unbound 8 -.Sh NAME -unbound -.Nd Unbound DNS validating resolver @version@. -.Sh SYNOPSIS -.Nm unbound -.Op Fl h -.Op Fl d -.Op Fl v -.Op Fl c Ar cfgfile -.Sh DESCRIPTION -.Ic Unbound +.SH "NAME" +.LP +.B unbound +\- Unbound DNS validating resolver @version@. +.SH "SYNOPSIS" +.LP +.B unbound +.RB [ \-h ] +.RB [ \-d ] +.RB [ \-v ] +.RB [ \-c +.IR cfgfile ] +.SH "DESCRIPTION" +.LP +.B Unbound is an implementation of a DNS resolver, that does caching and DNSSEC validation. -.Pp +.P The available options are: -.Bl -tag -width indent -.It Fl h +.TP +.B \-h Show the version and commandline option help. -.It Fl c Ar cfgfile +.TP +.B \-c\fI cfgfile Set the config file with settings for unbound to read instead of the file at default location /etc/unbound/unbound.conf. The syntax is -described in -.Xr unbound.conf 5 . -.It Fl d +described in \fIunbound.conf\fR(5). +.TP +.B \-d Debug flag, do not fork into the background, but stay attached to the console. This flag will also delay writing to the logfile until the -thread-spawn time. So that most config and setup errors appear on stderr. -.It Fl v +thread\-spawn time. So that most config and setup errors appear on stderr. +.TP +.B \-v Increase verbosity. If given multiple times, more information is logged. This is in addition to the verbosity (if any) from the config file. -.El -.Sh SEE ALSO -.Xr unbound.conf 5 , -.Xr unbound-checkconf 8 . -.Sh AUTHORS -.Ic Unbound +.SH "SEE ALSO" +\fIunbound.conf\fR(5), +\fIunbound\-checkconf\fR(8). +.SH "AUTHORS" +.B Unbound developers are mentioned in the CREDITS file in the distribution. diff --git a/doc/unbound.conf.5 b/doc/unbound.conf.5 index 037a18924..a10ba6c85 100644 --- a/doc/unbound.conf.5 +++ b/doc/unbound.conf.5 @@ -1,3 +1,4 @@ +.TH "unbound.conf" "5" "@date@" "NLnet Labs" "unbound @version@" .\" .\" unbound.conf.5 -- unbound.conf manual .\" @@ -6,39 +7,44 @@ .\" See LICENSE for the license. .\" .\" -.Dd @date@ -.Os FreeBSD -.Dt unbound.conf 5 -.Sh NAME -.Nm unbound.conf -.Nd Unbound configuration file. -.Sh SYNOPSIS -.Nm unbound.conf -.Sh DESCRIPTION -.Ic unbound.conf +.SH "NAME" +.LP +.B unbound.conf +\- Unbound configuration file. +.SH "SYNOPSIS" +.LP +.B unbound.conf +.SH "DESCRIPTION" +.LP +.B unbound.conf is used to configure -.Xr unbound 8 . +\fIunbound\fR(8). The file format has attributes and values. Some attributes have attributes inside them. The notation is: attribute: value. -.Pp +.P Comments start with # and last to the end of line. Empty lines are ignored as is whitespace at the beginning of a line. -.Pp +.P The utility -.Xr unbound-checkconf 8 +\fIunbound\-checkconf\fR(8) can be used to check unbound.conf prior to usage. -.Sh EXAMPLE +.SH "EXAMPLE" 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: +.P .nf $ kill `cat /etc/unbound/unbound.pid` .fi +.P Below is a minimal config file. The source distribution contains an extensive example.conf file with all the options. +.P .nf # unbound.conf(5) config file for unbound(8). server: @@ -48,210 +54,253 @@ server: # logfile: "/etc/unbound/unbound.log" #uncomment to use logfile. pidfile: "/etc/unbound/unbound.pid" # verbosity: 1 # uncomment and increase to get more logging. - # listen on all interfaces, answer queries from the local subnet. interface: 0.0.0.0 interface: ::0 - access-control: 10.0.0.0/8 allow - access-control: 2001:DB8::/64 allow + access\-control: 10.0.0.0/8 allow + access\-control: 2001:DB8::/64 allow .fi -.Sh FILE FORMAT +.SH "FILE FORMAT" +.LP There must be whitespace between keywords. Attribute keywords end with a colon ':'. An attribute is followed by its containing attributes, or a value. -.Pp +.P Files can be included using the -.Ic include: +.B include: directive. It can appear anywhere, and takes a single filename as an argument. Processing continues as if the text from the included file was copied into the config file at that point. -.Ss Server Options +.SS "Server Options" These options are part of the -.Ic server: +.B server: clause. -.Bl -tag -width indent -.It \fBverbosity:\fR +.TP +.B verbosity: \fI The verbosity number, level 0 means no verbosity, only errors. Level 1 gives operational information. Level 2 gives query level information, output per query. Level 3 gives algorithm level information. Default is level 1. The verbosity can also be increased from the commandline, see -.Xr unbound 8 . -.It \fBnum-threads:\fR +\fIunbound\fR(8). +.TP +.B num\-threads: \fI The number of threads to create to serve clients. Use 1 for no threading. -.It \fBport:\fR +.TP +.B port: \fI The port number, default 53, on which the server responds to queries. -.It \fBinterface:\fR +.TP +.B interface: \fI 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 given the default is to listen to localhost. -The interfaces are not changed on a reload (kill -HUP) but only on restart. -.It \fBoutgoing-interface:\fR +The interfaces are not changed on a reload (kill \-HUP) but only on restart. +.TP +.B outgoing\-interface: \fI 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 -.Ic interface: +.B interface: and -.Ic outgoing-interface: +.B outgoing\-interface: lines, the interfaces are then used for both purposes. Outgoing queries are sent via a random outgoing interface to counter spoofing. -.It \fBoutgoing-port:\fR +.TP +.B outgoing\-port: \fI The starting port number where the outgoing query port range is allocated. Default is 1053. -.It \fBoutgoing-range:\fR +.TP +.B outgoing\-range: \fI Number of ports to open. This number is opened per thread for every outgoing query interface. Must be at least 1. Default is 16. Larger numbers give more protection against spoofing attempts, but need extra resources from the operating system. -.It \fBoutgoing-num-tcp:\fR +.TP +.B outgoing\-num\-tcp: \fI Number of outgoing TCP buffers to allocate per thread. Default is 10. If set to 0, or if do_tcp is "no", no TCP queries to authoritative servers are done. -.It \fBincoming-num-tcp:\fR +.TP +.B incoming\-num\-tcp: \fI Number of incoming TCP buffers to allocate per thread. Default is 10. If set to 0, or if do_tcp is "no", no TCP queries from clients are accepted. -.It \fBmsg-buffer-size:\fR +.TP +.B msg\-buffer\-size: \fI 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 reply to the client. -.It \fBmsg-cache-size:\fR +.TP +.B msg\-cache\-size: \fI Number of bytes size of the message cache. Default is 4 megabytes. -.It \fBmsg-cache-slabs:\fR +.TP +.B msg\-cache\-slabs: \fI 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 reasonable guess. -.It \fBnum-queries-per-thread:\fR +.TP +.B num\-queries\-per\-thread: \fI The number of queries that every thread will service simultaneously. If more queries arrive that need servicing, they are dropped. This forces the client to resend after a timeout; allowing the server time to work on the existing queries. Default 1024. -.It \fBrrset-cache-size:\fR +.TP +.B rrset\-cache\-size: \fI Number of bytes size of the RRset cache. Default is 4 megabytes. -.It \fBrrset-cache-slabs:\fR +.TP +.B rrset\-cache\-slabs: \fI Number of slabs in the RRset cache. Slabs reduce lock contention by threads. Must be set to a power of 2. -.It \fBcache-max-ttl:\fR +.TP +.B cache\-max\-ttl: \fI 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. -.It \fBinfra-host-ttl:\fR +.TP +.B infra\-host\-ttl: \fI Time to live for entries in the host cache. The host cache contains roundtrip timing and EDNS support information. Default is 900. -.It \fBinfra-lame-ttl:\fR +.TP +.B infra\-lame\-ttl: \fI The time to live when a delegation is discovered to be lame. Default is 900. -.It \fBinfra-cache-slabs:\fR +.TP +.B infra\-cache\-slabs: \fI Number of slabs in the infrastructure cache. Slabs reduce lock contention by threads. Must be set to a power of 2. -.It \fBinfra-cache-numhosts:\fR +.TP +.B infra\-cache\-numhosts: \fI Number of hosts for which information is cached. Default is 10000. -.It \fBinfra-cache-lame-size:\fR +.TP +.B infra\-cache\-lame\-size: \fI Number of bytes that the lameness cache per host is allowed to use. Default is 10 kb, which gives maximum storage for a couple score zones, depending on the lame zone name lengths. -.It \fBdo-ip4:\fR +.TP +.B do\-ip4: \fI Enable or disable whether ip4 queries are answered or issued. Default is yes. -.It \fBdo-ip6:\fR +.TP +.B do\-ip6: \fI Enable or disable whether ip6 queries are answered or issued. Default is yes. If disabled, queries are not answered on IPv6, and queries are not sent on IPv6 to the internet nameservers. -.It \fBdo-udp:\fR +.TP +.B do\-udp: \fI Enable or disable whether UDP queries are answered or issued. Default is yes. -.It \fBdo-tcp:\fR +.TP +.B do\-tcp: \fI Enable or disable whether TCP queries are answered or issued. Default is yes. -.It \fBaccess-control:\fR +.TP +.B access\-control: \fI The netblock is given as an IP4 or IP6 address with /size appended for a classless network block. The action can be deny, refuse or allow. Deny stops queries from hosts from that netblock. Refuse stops queries too, but sends a DNS rcode REFUSED error message back. Allow gives access to clients from that netblock. By default only localhost is allowed, the rest is refused. -The default is refused, because that is protocol-friendly. The DNS protocol +The default is refused, 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. -.It \fBchroot:\fR +.TP +.B chroot: \fI If given a chroot is done to the given directory. The default is "/etc/unbound". If you give "" no chroot is performed. -.It \fBusername:\fR +.TP +.B username: \fI If given, after binding the port the user privileges are dropped. Default is "unbound". If you give username: "" no user change is performed. -.Pp +.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 requires privileges, then a reload will fail; a restart is needed. -.It \fBdirectory:\fR +.TP +.B directory: \fI Sets the working directory for the program. -.It \fBlogfile:\fR +.TP +.B logfile: \fI If "" is given, logging goes to stderr, or nowhere once daemonized. The logfile is appended to, in the following format: +.nf [seconds since 1970] unbound[pid:tid]: type: message. -If this option is given, the use-syslog is option is set to "no". +.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 SIGHUP. -.It \fBuse-syslog:\fR +.TP +.B use\-syslog: \fI Sets unbound to send log messages to the syslogd, using -.Xr syslog 3 . +\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 logfile setting is overridden when use\-syslog is turned on. The default is to log to syslog. -.It \fBpidfile:\fR +.TP +.B pidfile: \fI The process id is written to the file. Default is "/etc/unbound/unbound.pid". So, .nf -kill -HUP `cat /etc/unbound/unbound.pid` +kill \-HUP `cat /etc/unbound/unbound.pid` .fi triggers a reload, .nf -kill -QUIT `cat /etc/unbound/unbound.pid` +kill \-QUIT `cat /etc/unbound/unbound.pid` .fi gracefully terminates. -.It \fBroot-hints:\fR +.TP +.B root\-hints: \fI 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 nameserver names and addresses only. The default may become outdated, -when servers change, therefore it is good practice to use a root-hints file. -.It \fBhide-identity:\fR +when servers change, therefore it is good practice to use a root\-hints file. +.TP +.B hide\-identity: \fI If enabled id.server and hostname.bind queries are refused. -.It \fBidentity:\fR +.TP +.B identity: \fI Set the identity to report. If set to "", the default, then the hostname of the server is returned. -.It \fBhide-version:\fR +.TP +.B hide\-version: \fI If enabled version.server and version.bind queries are refused. -.It \fBversion:\fR +.TP +.B version: \fI Set the version to report. If set to "", the default, then the package version is returned. -.It \fBtarget-fetch-policy:\fR <"list of numbers"> +.TP +.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. -.Pp +.IP The number of values determines the maximum dependency depth that unbound will pursue in answering a query. -A value of -1 means to fetch all targets opportunistically for that dependency +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. -.Pp +.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. -.It \fBharden-short-bufsize:\fR +.TP +.B harden\-short\-bufsize: \fI 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 small answers to these queries, where possible. -.It \fBharden-large-queries:\fR +.TP +.B harden\-large\-queries: \fI Very large queries are ignored. Default is off, since it is legal protocol wise to send these, and could be necessary for operation if TSIG or EDNS payload is very large. -.It \fBharden-glue:\fR +.TP +.B harden\-glue: \fI Will trust glue only if it is within the servers authority. Default is on. -.It \fBharden-dnssec-stripped:\fR -Require DNSSEC data for trust-anchored zones, if such data is absent, +.TP +.B harden\-dnssec\-stripped: \fI +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 @@ -259,60 +308,71 @@ 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. -.It \fBdo-not-query-address:\fR +.TP +.B do\-not\-query\-address: \fI 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. -.It \fBdo-not-query-localhost:\fR -If yes, localhost is added to the do-not-query-address entries, both +.TP +.B do\-not\-query\-localhost: \fI +If yes, localhost is added to the do\-not\-query\-address entries, both IP6 ::1 and IP4 127.0.0.1/8. If no, then localhost can be used to send queries to. Default is yes. -.It \fBmodule-config:\fR <"module names"> +.TP +.B module\-config: \fI<"module names"> Module configuration, a list of module names separated by spaces, surround the string with quotes (""). The modules can be validator, iterator. -Setting this to "iterator" will result in a non-validating server. +Setting this to "iterator" will result in a non\-validating server. Setting this to "validator iterator" will turn on DNSSEC validation. -You must also set trust-anchors for validation to be useful. -.It \fBtrust-anchor-file:\fR +You must also set trust\-anchors for validation to be useful. +.TP +.B trust\-anchor\-file: \fI File with trusted keys for validation. Both DS and DNSKEY entries can appear in the file. The format of the file is the standard DNS Zone file format. Default is "", or no trust anchor file. -.It \fBtrust-anchor:\fR <"Resource Record"> +.TP +.B trust\-anchor: \fI<"Resource Record"> 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. +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. A class can be specified, but class IN is default. -.It \fBtrusted-keys-file:\fR +.TP +.B trusted\-keys\-file: \fI 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, -the trusted-keys { name flag proto algo "key"; }; clauses are read. -.It \fBval-override-date:\fR +with several entries, one file per entry. Like \fBtrust\-anchor\-file\fR +but has a different file format. Format is BIND\-9 style format, +the trusted\-keys { name flag proto algo "key"; }; clauses are read. +.TP +.B val\-override\-date: \fI 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 you are debugging signature inception and expiration. -.It \fBval-bogus-ttl:\fR +.TP +.B val\-bogus\-ttl: \fI The time to live for bogus data. This is data that has failed validation; due to invalid signatures or other checks. The TTL from that data cannot be trusted, and this value is used instead. The value is in seconds, default 900. The time interval prevents repeated revalidation of bogus data. -.It \fBval-clean-additional:\fR +.TP +.B val\-clean\-additional: \fI 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 protentially bad data in the additional section. -.It \fBval-permissive-mode:\fR +.TP +.B val\-permissive\-mode: \fI 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 is set in replies. Also logging is performed as for full validation. The default value is "no". -.It \fBval-nsec3-keysize-iterations:\fR <"list of values"> +.TP +.B val\-nsec3\-keysize\-iterations: \fI<"list of values"> 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 @@ -320,188 +380,208 @@ 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 "1024 65535" there is no restriction to NSEC3 iteration values. This table must be kept short; a very long list could cause slower operation. -.It \fBkey-cache-size:\fR +.TP +.B key\-cache\-size: \fI Number of bytes size of the key cache. Default is 4 megabytes. -.It \fBkey-cache-slabs:\fR +.TP +.B key\-cache\-slabs: \fI 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 reasonable guess. -.It \fBlocal-zone:\fR +.TP +.B local\-zone: \fI Configure a local zone. The type determines the answer to give if there is -no match from local-data. The types are deny, refuse, static, transparent, +no match from local\-data. The types are deny, refuse, static, transparent, redirect, nodefault, and are explained below. After that the default settings -are listed. Use local-data: to enter data into the local zone. Answers for +are listed. Use local\-data: to enter data into the local zone. Answers for local zones are authoritative DNS answers. By default the zones are class IN. -.Bl -tag -width indent -.It \fIdeny\fR +.TP 10 +\h'5'\fIdeny\fR Do not send an answer, drop the query. If there is a match from local data, the query is answered. -.It \fIrefuse\fR +.TP 10 +\h'5'\fIrefuse\fR Send an error message reply, with rcode REFUSED. If there is a match from local data, the query is answered. -.It \fIstatic\fR +.TP 10 +\h'5'\fIstatic\fR If there is a match from local data, the query is answered. 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. -.It \fItransparent\fR +as local\-data for the zone apex domain. +.TP 10 +\h'5'\fItransparent\fR If there is a match from local data, the query is answered. Otherwise, the query is resolved normally. -If no local-zone is given local-data causes a transparent zone +If no local\-zone is given local\-data causes a transparent zone to be created by default. -.It \fIredirect\fR +.TP 10 +\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 a different address, with -local-zone: "example.com." redirect and -local-data: "example.com. A 127.0.0.1" +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. -.It \fInodefault\fR +.TP 10 +\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 given zone. -.El +.P The default zones are localhost, reverse 127.0.0.1 and ::1, and 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. -.Bl -tag -width indent -.It \fIlocalhost\fR +.TP 10 +\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 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" +local\-zone: "localhost." static +local\-data: "localhost. 10800 IN NS localhost." +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 -.It \fIreverse IPv4 loopback\fR +.TP 10 +\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 SOA localhost. nobody.invalid. 1 3600 1200 604800 10800" -local-data: "1.0.0.127.in-addr.arpa. 10800 IN PTR localhost." +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 SOA localhost. nobody.invalid. 1 3600 1200 604800 10800" +local\-data: "1.0.0.127.in\-addr.arpa. 10800 IN PTR localhost." .fi -.It \fIreverse IPv6 loopback\fR +.TP 10 +\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 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 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 PTR localhost." +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 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 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 PTR localhost." .fi -.It \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 +.TP 10 +\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 records are provided. -.It \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, 255.255.255.255.in-addr.arpa. -.It \fIreverse RFC4291 IP6 unspecified\fR +.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, +2.0.192.in\-addr.arpa, 255.255.255.255.in\-addr.arpa. +.TP 10 +\h'5'\fIreverse RFC4291 IP6 unspecified\fR Reverse data for zone 0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa. -.It \fIreverse RFC4193 IPv6 Locally Assigned Local Addresses\fR +.TP 10 +\h'5'\fIreverse RFC4193 IPv6 Locally Assigned Local Addresses\fR Reverse data for zone D.F.ip6.arpa. -.It \fIreverse RFC4291 IPv6 Link Local Addresses\fR +.TP 10 +\h'5'\fIreverse RFC4291 IPv6 Link Local Addresses\fR Reverse data for zones 8.E.F.ip6.arpa to B.E.F.ip6.arpa. -.El .\" End of local-zone listing. -.It \fBlocal-data:\fR "" +.TP 5 +.B local\-data: \fI"" 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 -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. +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 -local-data: 'example. TXT "text"'. -.El -.Ss Stub Zone Options +local\-data: 'example. TXT "text"'. +.SS "Stub Zone Options" +.LP There may be multiple -.Ic stub-zone: +.B stub\-zone: clauses. Each with a name: and zero or more hostnames or IP addresses. For the stub zone this list of nameservers is used. Class IN is assumed. -.Bl -tag -width indent -.It \fBname:\fR +.TP +.B name: \fI Name of the stub zone. -.It \fBstub-host:\fR +.TP +.B stub\-host: \fI Name of stub zone nameserver. Is itself resolved before it is used. -.It \fBstub-addr:\fR +.TP +.B stub\-addr: \fI 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. -.El -.Ss Forward Zone Options +.SS "Forward Zone Options" +.LP There may be multiple -.Ic forward-zone: +.B forward\-zone: clauses. Each with a name: and zero or more hostnames or IP addresses. For the forward zone this list of nameservers is used to forward the queries to. The servers have to handle further recursion for the query. Class IN is -assumed. A forward-zone entry with name "." and a forward-addr target will +assumed. A forward\-zone entry with name "." and a forward\-addr target will forward all queries to that other server (unless it can answer from the cache). -.Bl -tag -width indent -.It \fBname:\fR +.TP +.B name: \fI Name of the forward zone. -.It \fBforward-host:\fR +.TP +.B forward\-host: \fI Name of server to forward to. Is itself resolved before it is used. -.It \fBforward-addr:\fR +.TP +.B forward\-addr: \fI IP address of server to forward to. Can be IP 4 or IP 6. To use a nondefault port for DNS communication append '@' with the port number. -.El -.Sh MEMORY CONTROL EXAMPLE +.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 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 1 meg of memory, the below example is not for you. Use the defaults to receive full service. -.Pp +.P .nf # example settings that reduce memory usage server: - num-threads: 1 - outgoing-num-tcp: 1 # this limits TCP service, uses less buffers. - incoming-num-tcp: 1 - outgoing-range: 1 # uses less memory, but less port randomness. - msg-buffer-size: 8192 # note this limits service, 'no huge stuff'. - msg-cache-size: 102400 # 100 Kb. - msg-cache-slabs: 1 - rrset-cache-size: 102400 # 100 Kb. - rrset-cache-slabs: 1 - infra-cache-numhosts: 200 - infra-cache-numlame: 10 - key-cache-size: 102400 # 100 Kb. - key-cache-slabs: 1 - num-queries-per-thread: 30 - target-fetch-policy: "2 1 0 0 0 0" - harden-large-queries: "yes" - harden-short-bufsize: "yes" - do-ip6: no # save a bit of memory if not used. + num\-threads: 1 + outgoing\-num\-tcp: 1 # this limits TCP service, uses less buffers. + incoming\-num\-tcp: 1 + outgoing\-range: 1 # uses less memory, but less port randomness. + msg\-buffer\-size: 8192 # note this limits service, 'no huge stuff'. + msg\-cache\-size: 102400 # 100 Kb. + msg\-cache\-slabs: 1 + rrset\-cache\-size: 102400 # 100 Kb. + rrset\-cache\-slabs: 1 + infra\-cache\-numhosts: 200 + infra\-cache\-numlame: 10 + key\-cache\-size: 102400 # 100 Kb. + key\-cache\-slabs: 1 + num\-queries\-per\-thread: 30 + target\-fetch\-policy: "2 1 0 0 0 0" + harden\-large\-queries: "yes" + harden\-short\-bufsize: "yes" + do\-ip6: no # save a bit of memory if not used. .fi -.Sh FILES -.Bl -tag -width indent -.It Pa /etc/unbound +.SH "FILES" +.TP +.I /etc/unbound default unbound working directory and default -.Xr chroot 2 +\fIchroot\fR(2) location. -.It Pa unbound.conf +.TP +.I unbound.conf unbound configuration file. -.It Pa unbound.pid +.TP +.I unbound.pid default unbound pidfile with process ID of the running daemon. -.It Pa unbound.log +.TP +.I unbound.log unbound log file. default is to log to -.Xr syslog 3 . -.El -.Sh SEE ALSO -.Xr unbound 8 , -.Xr unbound-checkconf 8 . -.Sh AUTHORS -.Ic Unbound +\fIsyslog\fR(3). +.SH "SEE ALSO" +\fIunbound\fR(8), +\fIunbound\-checkconf\fR(8). +.SH "AUTHORS" +.B Unbound was written by NLnet Labs. Please see CREDITS file in the distribution for further details. -- 2.47.2