diff --git a/bin/check/named-checkconf.html b/bin/check/named-checkconf.html index a43900ce0c..2e31adbcef 100644 --- a/bin/check/named-checkconf.html +++ b/bin/check/named-checkconf.html @@ -23,26 +23,45 @@
-
+ + + + + + + +

Name

-

named-checkconf — named configuration file syntax checking tool

+

+ named-checkconf + — named configuration file syntax checking tool +

-
+ +

Synopsis

-

named-checkconf [-hjvz] [-p +

+ named-checkconf + [-hjvz] + [-p [-x - ]] [-t directory] {filename}

-
-
+ ]] + [-t directory] + {filename} +

+
+ +

DESCRIPTION

-

named-checkconf + +

named-checkconf checks the syntax, but not the semantics, of a named configuration file. The file is parsed and checked for syntax errors, along with all files included by it. If no file is specified, /etc/named.conf is read by default.

-

+

Note: files that named reads in separate parser contexts, such as rndc.key and bind.keys, are not automatically read @@ -52,37 +71,50 @@ successful. named-checkconf can be run on these files explicitly, however.

-
-
+
+ +

OPTIONS

-
+ +
-h
-

+

+

Print the usage summary and exit. -

+

+
-j
-

+

+

When loading a zonefile read the journal if it exists. -

+

+
-p
-

+

+

Print out the named.conf and included files in canonical form if no errors were detected. See also the -x option. -

+

+
-t directory
-

+

+

Chroot to directory so that include directives in the configuration file are processed as if run by a similarly chrooted named. -

+

+
-v
-

+

+

Print the version of the named-checkconf program and exit. -

+

+
-x
-

+

+

When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks ('?'). This allows the @@ -90,32 +122,46 @@ files to be shared — for example, when submitting bug reports — without compromising private data. This option cannot be used without -p. -

+

+
-z
-

+

+

Perform a test load of all master zones found in named.conf. -

+

+
filename
-

+

+

The name of the configuration file to be checked. If not specified, it defaults to /etc/named.conf. -

+

+
-
-
+ +
+ +

RETURN VALUES

-

named-checkconf + +

named-checkconf returns an exit status of 1 if errors were detected and 0 otherwise.

-
-
+
+ +

SEE ALSO

-

named(8), - named-checkzone(8), + +

+ named(8) + , + + named-checkzone(8) + , BIND 9 Administrator Reference Manual.

-
+
diff --git a/bin/check/named-checkzone.html b/bin/check/named-checkzone.html index a568a8e233..286c4fabdd 100644 --- a/bin/check/named-checkzone.html +++ b/bin/check/named-checkzone.html @@ -23,24 +23,94 @@
-
+ + + + + + + +

Name

-

named-checkzone, named-compilezone — zone file validity checking or converting tool

+

+ named-checkzone, + named-compilezone + — zone file validity checking or converting tool +

-
+ +

Synopsis

-

named-checkzone [-d] [-h] [-j] [-q] [-v] [-c class] [-f format] [-F format] [-J filename] [-i mode] [-k mode] [-m mode] [-M mode] [-n mode] [-l ttl] [-L serial] [-o filename] [-r mode] [-s style] [-S mode] [-t directory] [-T mode] [-w directory] [-D] [-W mode] {zonename} {filename}

-

named-compilezone [-d] [-j] [-q] [-v] [-c class] [-C mode] [-f format] [-F format] [-J filename] [-i mode] [-k mode] [-m mode] [-n mode] [-l ttl] [-L serial] [-r mode] [-s style] [-t directory] [-T mode] [-w directory] [-D] [-W mode] {-o filename} {zonename} {filename}

-
-
+

+ named-checkzone + [-d] + [-h] + [-j] + [-q] + [-v] + [-c class] + [-f format] + [-F format] + [-J filename] + [-i mode] + [-k mode] + [-m mode] + [-M mode] + [-n mode] + [-l ttl] + [-L serial] + [-o filename] + [-r mode] + [-s style] + [-S mode] + [-t directory] + [-T mode] + [-w directory] + [-D] + [-W mode] + {zonename} + {filename} +

+

+ named-compilezone + [-d] + [-j] + [-q] + [-v] + [-c class] + [-C mode] + [-f format] + [-F format] + [-J filename] + [-i mode] + [-k mode] + [-m mode] + [-n mode] + [-l ttl] + [-L serial] + [-r mode] + [-s style] + [-t directory] + [-T mode] + [-w directory] + [-D] + [-W mode] + {-o filename} + {zonename} + {filename} +

+
+ +

DESCRIPTION

-

named-checkzone + +

named-checkzone checks the syntax and integrity of a zone file. It performs the same checks as named does when loading a zone. This makes named-checkzone useful for checking zone files before configuring them into a name server.

-

+

named-compilezone is similar to named-checkzone, but it always dumps the zone contents to a specified file in a specified format. @@ -51,45 +121,62 @@ least be as strict as those specified in the named configuration file.

-
-
+
+ +

OPTIONS

-
+ + +
-d
-

+

+

Enable debugging. -

+

+
-h
-

+

+

Print the usage summary and exit. -

+

+
-q
-

+

+

Quiet mode - exit code only. -

+

+
-v
-

+

+

Print the version of the named-checkzone program and exit. -

+

+
-j
-

+

+

When loading a zone file, read the journal if it exists. The journal file name is assumed to be the zone file name appended with the string .jnl. -

+

+
-J filename
-

+

+

When loading the zone file read the journal from the given file, if it exists. (Implies -j.) -

+

+
-c class
-

+

+

Specify the class of the zone. If not specified, "IN" is assumed. -

+

+
-i mode
-

+

Perform post-load zone integrity checks. Possible modes are "full" (default), "full-sibling", @@ -97,19 +184,19 @@ "local-sibling" and "none".

-

+

Mode "full" checks that MX records refer to A or AAAA record (both in-zone and out-of-zone hostnames). Mode "local" only checks MX records which refer to in-zone hostnames.

-

+

Mode "full" checks that SRV records refer to A or AAAA record (both in-zone and out-of-zone hostnames). Mode "local" only checks SRV records which refer to in-zone hostnames.

-

+

Mode "full" checks that delegation NS records refer to A or AAAA record (both in-zone and out-of-zone hostnames). It also checks that glue address records @@ -118,31 +205,33 @@ refer to in-zone hostnames or that some required glue exists, that is when the nameserver is in a child zone.

-

+

Mode "full-sibling" and "local-sibling" disable sibling glue checks but are otherwise the same as "full" and "local" respectively.

-

+

Mode "none" disables the checks.

-
+
-f format
-

+

+

Specify the format of the zone file. Possible formats are "text" (default), "raw", and "map". -

+

+
-F format
-

+

Specify the format of the output file specified. For named-checkzone, this does not cause any effects unless it dumps the zone contents.

-

+

Possible formats are "text" (default), which is the standard textual representation of the zone, and "map", "raw", @@ -153,9 +242,10 @@ any version of named; if N is 1, the file can be read by release 9.9.0 or higher; the default is 1.

-
+
-k mode
-

+

+

Perform "check-names" checks with the specified failure mode. Possible modes are "fail" @@ -163,38 +253,48 @@ "warn" (default for named-checkzone) and "ignore". -

+

+
-l ttl
-

+

+

Sets a maximum permissible TTL for the input file. Any record with a TTL higher than this value will cause the zone to be rejected. This is similar to using the max-zone-ttl option in named.conf. -

+

+
-L serial
-

+

+

When compiling a zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) -

+

+
-m mode
-

+

+

Specify whether MX records should be checked to see if they are addresses. Possible modes are "fail", "warn" (default) and "ignore". -

+

+
-M mode
-

+

+

Check if a MX record refers to a CNAME. Possible modes are "fail", "warn" (default) and "ignore". -

+

+
-n mode
-

+

+

Specify whether NS records should be checked to see if they are addresses. Possible modes are "fail" @@ -202,24 +302,30 @@ "warn" (default for named-checkzone) and "ignore". -

+

+
-o filename
-

+

+

Write zone output to filename. If filename is - then write to standard out. This is mandatory for named-compilezone. -

+

+
-r mode
-

+

+

Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS. Possible modes are "fail", "warn" (default) and "ignore". -

+

+
-s style
-

+

+

Specify the style of the dumped zone file. Possible styles are "full" (default) and "relative". @@ -232,74 +338,101 @@ contents. It also does not have any meaning if the output format is not text. -

+

+
-S mode
-

+

+

Check if a SRV record refers to a CNAME. Possible modes are "fail", "warn" (default) and "ignore". -

+

+
-t directory
-

+

+

Chroot to directory so that include directives in the configuration file are processed as if run by a similarly chrooted named. -

+

+
-T mode
-

+

+

Check if Sender Policy Framework (SPF) records exist and issues a warning if an SPF-formatted TXT record is not also present. Possible modes are "warn" (default), "ignore". -

+

+
-w directory
-

+

+

chdir to directory so that relative filenames in master file $INCLUDE directives work. This is similar to the directory clause in named.conf. -

+

+
-D
-

+

+

Dump zone file in canonical format. This is always enabled for named-compilezone. -

+

+
-W mode
-

+

+

Specify whether to check for non-terminal wildcards. Non-terminal wildcards are almost always the result of a failure to understand the wildcard matching algorithm (RFC 1034). Possible modes are "warn" (default) and "ignore". -

+

+
zonename
-

+

+

The domain name of the zone being checked. -

+

+
filename
-

+

+

The name of the zone file. -

+

+
-
-
+ +
+ +

RETURN VALUES

-

named-checkzone + +

named-checkzone returns an exit status of 1 if errors were detected and 0 otherwise.

-
-
+
+ +

SEE ALSO

-

named(8), - named-checkconf(8), + +

+ named(8) + , + + named-checkconf(8) + , RFC 1035, BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/bin/confgen/ddns-confgen.html b/bin/confgen/ddns-confgen.html index 0f5906726e..c4f44de89d 100644 --- a/bin/confgen/ddns-confgen.html +++ b/bin/confgen/ddns-confgen.html @@ -22,31 +22,63 @@
-
+ + + + + +

Name

-

ddns-confgen — ddns key generation tool

-
-
-

Synopsis

-

tsig-keygen [-a algorithm] [-h] [-r randomfile] [name]

-

ddns-confgen [-a algorithm] [-h] [-k keyname] [-q] [-r randomfile] [ -s name | -z zone ]

-
-
-

DESCRIPTION

+ ddns-confgen + — ddns key generation tool +

+
+ + + +
+

Synopsis

+

+ tsig-keygen + [-a algorithm] + [-h] + [-r randomfile] + [name] +

+

+ ddns-confgen + [-a algorithm] + [-h] + [-k keyname] + [-q] + [-r randomfile] + [ + -s name + | -z zone + ] +

+
+ +
+

DESCRIPTION

+ +

tsig-keygen and ddns-confgen are invocation methods for a utility that generates keys for use in TSIG signing. The resulting keys can be used, for example, to secure dynamic DNS updates to a zone or for the rndc command channel.

-

+ +

When run as tsig-keygen, a domain name can be specified on the command line which will be used as the name of the generated key. If no name is specified, the default is tsig-key.

-

+ +

When run as ddns-confgen, the generated key is accompanied by configuration text and instructions that can be used with nsupdate and @@ -56,7 +88,8 @@ rndc-confgen command for setting up command channel security.)

-

+ +

Note that named itself can configure a local DDNS key for use with nsupdate -l: it does this when a zone is configured with @@ -66,24 +99,32 @@ if nsupdate is to be used from a remote system.

-
-
+
+ +

OPTIONS

-
+ + +
-a algorithm
-

+

+

Specifies the algorithm to use for the TSIG key. Available choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384 and hmac-sha512. The default is hmac-sha256. Options are case-insensitive, and the "hmac-" prefix may be omitted. -

+

+
-h
-

+

+

Prints a short summary of options and arguments. -

+

+
-k keyname
-

+

+

Specifies the key name of the DDNS authentication key. The default is ddns-key when neither the -s nor -z option is @@ -93,15 +134,19 @@ ddns-key.example.com. The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods. -

+

+
-q
-

+

+

(ddns-confgen only.) Quiet mode: Print only the key, with no explanatory text or usage examples; This is essentially identical to tsig-keygen. -

+

+
-r randomfile
-

+

+

Specifies a source of random data for generating the authorization. If the operating system does not provide a /dev/random or equivalent device, the @@ -111,9 +156,11 @@ instead of the default. The special value keyboard indicates that keyboard input should be used. -

+

+
-s name
-

+

+

(ddns-confgen only.) Generate configuration example to allow dynamic updates of a single hostname. The example named.conf @@ -124,9 +171,11 @@ Note that the "self" nametype cannot be used, since the name to be updated may differ from the key name. This option cannot be used with the -z option. -

+

+
-z zone
-

+

+

(ddns-confgen only.) Generate configuration example to allow dynamic updates of a zone: The example named.conf text @@ -136,16 +185,26 @@ all subdomain names within that zone. This option cannot be used with the -s option. -

+

+
-
-
+
+ +

SEE ALSO

-

nsupdate(1), - named.conf(5), - named(8), + +

+ nsupdate(1) + , + + named.conf(5) + , + + named(8) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/bin/confgen/rndc-confgen.html b/bin/confgen/rndc-confgen.html index d712860ea4..1f403fc4c8 100644 --- a/bin/confgen/rndc-confgen.html +++ b/bin/confgen/rndc-confgen.html @@ -23,17 +23,43 @@
-
+ + + + + +

Name

-

rndc-confgen — rndc key generation tool

+

+ rndc-confgen + — rndc key generation tool +

-
+ + + +

Synopsis

-

rndc-confgen [-a] [-A algorithm] [-b keysize] [-c keyfile] [-h] [-k keyname] [-p port] [-r randomfile] [-s address] [-t chrootdir] [-u user]

-
-
+

+ rndc-confgen + [-a] + [-A algorithm] + [-b keysize] + [-c keyfile] + [-h] + [-k keyname] + [-p port] + [-r randomfile] + [-s address] + [-t chrootdir] + [-u user] +

+
+ +

DESCRIPTION

-

rndc-confgen + +

rndc-confgen generates configuration files for rndc. It can be used as a convenient alternative to writing the @@ -46,13 +72,17 @@ avoid the need for a rndc.conf file and a controls statement altogether.

-
-
+ +
+ +

OPTIONS

-
+ + +
-a
-

+

Do automatic rndc configuration. This creates a file rndc.key in /etc (or whatever @@ -67,7 +97,7 @@ named on the local host with no further configuration.

-

+

Running rndc-confgen -a allows BIND 9 and rndc to be used as drop-in @@ -75,7 +105,7 @@ with no changes to the existing BIND 8 named.conf file.

-

+

If a more elaborate configuration than that generated by rndc-confgen -a is required, for example if rndc is to be used remotely, @@ -86,44 +116,57 @@ named.conf as directed.

-
+
-A algorithm
-

+

+

Specifies the algorithm to use for the TSIG key. Available choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384 and hmac-sha512. The default is hmac-md5 or if MD5 was disabled hmac-sha256. -

+

+
-b keysize
-

+

+

Specifies the size of the authentication key in bits. Must be between 1 and 512 bits; the default is the hash size. -

+

+
-c keyfile
-

+

+

Used with the -a option to specify an alternate location for rndc.key. -

+

+
-h
-

+

+

Prints a short summary of the options and arguments to rndc-confgen. -

+

+
-k keyname
-

+

+

Specifies the key name of the rndc authentication key. This must be a valid domain name. The default is rndc-key. -

+

+
-p port
-

+

+

Specifies the command channel port where named listens for connections from rndc. The default is 953. -

+

+
-r randomfile
-

+

+

Specifies a source of random data for generating the authorization. If the operating system does not provide a /dev/random @@ -134,24 +177,30 @@ data to be used instead of the default. The special value keyboard indicates that keyboard input should be used. -

+

+
-s address
-

+

+

Specifies the IP address where named listens for command channel connections from rndc. The default is the loopback address 127.0.0.1. -

+

+
-t chrootdir
-

+

+

Used with the -a option to specify a directory where named will run chrooted. An additional copy of the rndc.key will be written relative to this directory so that it will be found by the chrooted named. -

+

+
-u user
-

+

+

Used with the -a option to set the owner of the rndc.key file generated. @@ -159,33 +208,45 @@ -t is also specified only the file in the chroot area has its owner changed. -

+

+
-
-
+
+ +

EXAMPLES

-

+ +

To allow rndc to be used with no manual configuration, run

-

rndc-confgen -a +

rndc-confgen -a

-

+

To print a sample rndc.conf file and corresponding controls and key statements to be manually inserted into named.conf, run

-

rndc-confgen +

rndc-confgen

-
-
+
+ +

SEE ALSO

-

rndc(8), - rndc.conf(5), - named(8), + +

+ rndc(8) + , + + rndc.conf(5) + , + + named(8) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/bin/delv/delv.html b/bin/delv/delv.html index 311ae243b7..7ba4995150 100644 --- a/bin/delv/delv.html +++ b/bin/delv/delv.html @@ -22,25 +22,70 @@
-
+ + + + + +

Name

-

delv — DNS lookup and validation utility

+

+ delv + — DNS lookup and validation utility +

-
+ + + +

Synopsis

-

delv [@server] [-4] [-6] [-a anchor-file] [-b address] [-c class] [-d level] [-i] [-m] [-p port#] [-q name] [-t type] [-x addr] [name] [type] [class] [queryopt...]

-

delv [-h]

-

delv [-v]

-

delv [queryopt...] [query...]

-
-
+

+ delv + [@server] + [-4] + [-6] + [-a anchor-file] + [-b address] + [-c class] + [-d level] + [-i] + [-m] + [-p port#] + [-q name] + [-t type] + [-x addr] + [name] + [type] + [class] + [queryopt...] +

+ +

+ delv + [-h] +

+ +

+ delv + [-v] +

+ +

+ delv + [queryopt...] + [query...] +

+
+ +

DESCRIPTION

-

delv + +

delv (Domain Entity Lookup & Validation) is a tool for sending DNS queries and validating the results, using the the same internal resolver and validator logic as named.

-

+

delv will send to a specified name server all queries needed to fetch and validate the requested data; this includes the original requested query, subsequent queries to follow @@ -50,7 +95,7 @@ behavior of a name server configured for DNSSEC validating and forwarding.

-

+

By default, responses are validated using built-in DNSSEC trust anchors for the root zone (".") and for the ISC DNSSEC lookaside validation zone ("dlv.isc.org"). Records returned by @@ -62,7 +107,7 @@ be used to check the validity of DNS responses in environments where local name servers may not be trustworthy.

-

+

Unless it is told to query a specific name server, delv will try each of the servers listed in /etc/resolv.conf. If no usable server @@ -70,15 +115,18 @@ queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6).

-

+

When no command line arguments or options are given, delv will perform an NS query for "." (the root zone).

-
-
+
+ +

SIMPLE USAGE

-

+ + +

A typical invocation of delv looks like: 

 delv @server name type
@@ -89,7 +137,7 @@
server
-

+

is the name or IP address of the name server to query. This can be an IPv4 address in dotted-decimal notation or an IPv6 address in colon-delimited notation. When the supplied @@ -99,7 +147,7 @@ initial lookup is not validated by DNSSEC).

-

+

If no server argument is provided, delv consults /etc/resolv.conf; if an @@ -112,13 +160,16 @@ the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6).

-
+
name
-

+

+

is the domain name to be looked up. -

+

+
type
-

+

+

indicates what type of query is required — ANY, A, MX, etc. type can be any valid query @@ -126,30 +177,34 @@ type argument is supplied, delv will perform a lookup for an A record. -

+

+

-
-
+ +
+ +

OPTIONS

-
+ +
-a anchor-file
-

+

Specifies a file from which to read DNSSEC trust anchors. The default is /etc/bind.keys, which is included with BIND 9 and contains trust anchors for the root zone (".") and for the ISC DNSSEC lookaside validation zone ("dlv.isc.org").

-

+

Keys that do not match the root or DLV trust-anchor names are ignored; these key names can be overridden using the +dlv=NAME or +root=NAME options.

-

+

Note: When reading the trust anchor file, delv treats managed-keys statements and trusted-keys statements @@ -163,23 +218,28 @@ /etc/bind.keys to use DNSSEC validation in delv.

-
+
-b address
-

+

+

Sets the source IP address of the query to address. This must be a valid address on one of the host's network interfaces or "0.0.0.0" or "::". An optional source port may be specified by appending "#<port>" -

+

+
-c class
-

+

+

Sets the query class for the requested data. Currently, only class "IN" is supported in delv and any other value is ignored. -

+

+
-d level
-

+

+

Set the systemwide debug level to level. The allowed range is from 0 to 99. The default is 0 (no debugging). @@ -188,13 +248,17 @@ See the +mtrace, +rtrace, and +vtrace options below for additional debugging details. -

+

+
-h
-

+

+

Display the delv help usage output and exit. -

+

+
-i
-

+

+

Insecure mode. This disables internal DNSSEC validation. (Note, however, this does not set the CD bit on upstream queries. If the server being queried is performing DNSSEC @@ -202,30 +266,37 @@ can cause delv to time out. When it is necessary to examine invalid data to debug a DNSSEC problem, use dig +cd.) -

+

+
-m
-

+

+

Enables memory usage debugging. -

+

+
-p port#
-

+

+

Specifies a destination port to use for queries instead of the standard DNS port number 53. This option would be used with a name server that has been configured to listen for queries on a non-standard port number. -

+

+
-q name
-

+

+

Sets the query name to name. While the query name can be specified without using the -q, it is sometimes necessary to disambiguate names from types or classes (for example, when looking up the name "ns", which could be misinterpreted as the type NS, or "ch", which could be misinterpreted as class CH). -

+

+
-t type
-

+

Sets the query type to type, which can be any valid query type supported in BIND 9 except for zone transfer types AXFR and IXFR. As with @@ -233,18 +304,21 @@ query name type or class when they are ambiguous. it is sometimes necessary to disambiguate names from types.

-

+

The default query type is "A", unless the -x option is supplied to indicate a reverse lookup, in which case it is "PTR".

-
+
-v
-

+

+

Print the delv version and exit. -

+

+
-x addr
-

+

+

Performs a reverse lookup, mapping an addresses to a name. addr is an IPv4 address in dotted-decimal notation, or a colon-delimited IPv6 address. @@ -254,24 +328,33 @@ lookup for a name like 11.12.13.10.in-addr.arpa and sets the query type to PTR. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. -

+

+
-4
-

+

+

Forces delv to only use IPv4. -

+

+
-6
-

+

+

Forces delv to only use IPv6. -

+

+
-
-
+
+ +

QUERY OPTIONS

-

delv + + +

delv provides a number of query options which affect the way results are displayed, and in some cases the way lookups are performed.

-

+ +

Each query option is identified by a keyword preceded by a plus sign (+). Some keywords set or reset an option. These may be preceded by the string @@ -283,7 +366,8 @@

+[no]cdflag
-

+

+

Controls whether to set the CD (checking disabled) bit in queries sent by delv. This may be useful when troubleshooting DNSSEC problems from behind a validating @@ -292,20 +376,25 @@ the CD flag on queries will cause the resolver to return invalid responses, which delv can then validate internally and report the errors in detail. -

+

+
+[no]class
-

+

+

Controls whether to display the CLASS when printing a record. The default is to display the CLASS. -

+

+
+[no]ttl
-

+

+

Controls whether to display the TTL when printing a record. The default is to display the TTL. -

+

+
+[no]rtrace
-

+

Toggle resolver fetch logging. This reports the name and type of each query sent by delv in the process of carrying out the resolution and validation @@ -313,62 +402,69 @@ all subsequent queries to follow CNAMEs and to establish a chain of trust for DNSSEC validation.

-

+

This is equivalent to setting the debug level to 1 in the "resolver" logging category. Setting the systemwide debug level to 1 using the -d option will product the same output (but will affect other logging categories as well).

-
+
+[no]mtrace
-

+

Toggle message logging. This produces a detailed dump of the responses received by delv in the process of carrying out the resolution and validation process.

-

+

This is equivalent to setting the debug level to 10 for the the "packets" module of the "resolver" logging category. Setting the systemwide debug level to 10 using the -d option will produce the same output (but will affect other logging categories as well).

-
+
+[no]vtrace
-

+

Toggle validation logging. This shows the internal process of the validator as it determines whether an answer is validly signed, unsigned, or invalid.

-

+

This is equivalent to setting the debug level to 3 for the the "validator" module of the "dnssec" logging category. Setting the systemwide debug level to 3 using the -d option will produce the same output (but will affect other logging categories as well).

-
+
+[no]short
-

+

+

Provide a terse answer. The default is to print the answer in a verbose form. -

+

+
+[no]comments
-

+

+

Toggle the display of comment lines in the output. The default is to print comments. -

+

+
+[no]rrcomments
-

+

+

Toggle the display of per-record comments in the output (for example, human-readable key information about DNSKEY records). The default is to print per-record comments. -

+

+
+[no]crypto
-

+

+

Toggle the display of cryptographic fields in DNSSEC records. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see @@ -376,14 +472,18 @@ When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]". -

+

+
+[no]trust
-

+

+

Controls whether to display the trust level when printing a record. The default is to display the trust level. -

+

+
+[no]split[=W]
-

+

+

Split long hex- or base64-formatted fields in resource records into chunks of W characters (where W is rounded up to the nearest @@ -392,24 +492,30 @@ +split=0 causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active. -

+

+
+[no]all
-

+

+

Set or clear the display options +[no]comments, +[no]rrcomments, and +[no]trust as a group. -

+

+
+[no]multiline
-

+

+

Print long records (such as RRSIG, DNSKEY, and SOA records) in a verbose multi-line format with human-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the delv output. -

+

+
+[no]dnssec
-

+

+

Indicates whether to display RRSIG records in the delv output. The default is to do so. Note that (unlike in dig) @@ -419,9 +525,11 @@ will always occur unless suppressed by the use of -i or +noroot and +nodlv. -

+

+
+[no]root[=ROOT]
-

+

+

Indicates whether to perform conventional (non-lookaside) DNSSEC validation, and if so, specifies the name of a trust anchor. The default is to validate using @@ -429,9 +537,11 @@ a built-in key. If specifying a different trust anchor, then -a must be used to specify a file containing the key. -

+

+
+[no]dlv[=DLV]
-

+

+

Indicates whether to perform DNSSEC lookaside validation, and if so, specifies the name of the DLV trust anchor. The default is to perform lookaside validation using @@ -439,27 +549,37 @@ built-in key. If specifying a different name, then -a must be used to specify a file containing the DLV key. -

+

+

-
-
+
+ +

FILES

-

/etc/bind.keys

-

/etc/resolv.conf

-
-
+ +

/etc/bind.keys

+

/etc/resolv.conf

+
+ +

SEE ALSO

-

dig(1), - named(8), + +

+ dig(1) + , + + named(8) + , RFC4034, RFC4035, RFC4431, RFC5074, RFC5155.

-
+
+
diff --git a/bin/dig/dig.html b/bin/dig/dig.html index 1b6c2e6cf4..d89a595826 100644 --- a/bin/dig/dig.html +++ b/bin/dig/dig.html @@ -23,19 +23,61 @@
-
+ + + + + +

Name

-

dig — DNS lookup utility

+

+ dig + — DNS lookup utility +

-
+ + + +

Synopsis

-

dig [@server] [-b address] [-c class] [-f filename] [-k filename] [-m] [-p port#] [-q name] [-t type] [-v] [-x addr] [-y [hmac:]name:key] [-4] [-6] [name] [type] [class] [queryopt...]

-

dig [-h]

-

dig [global-queryopt...] [query...]

-
-
+

+ dig + [@server] + [-b address] + [-c class] + [-f filename] + [-k filename] + [-m] + [-p port#] + [-q name] + [-t type] + [-v] + [-x addr] + [-y [hmac:]name:key] + [-4] + [-6] + [name] + [type] + [class] + [queryopt...] +

+ +

+ dig + [-h] +

+ +

+ dig + [global-queryopt...] + [query...] +

+
+ +

DESCRIPTION

-

dig + +

dig (domain information groper) is a flexible tool for interrogating DNS name servers. It performs DNS lookups and displays the answers that are returned from the name server(s) that @@ -44,7 +86,8 @@ clarity of output. Other lookup tools tend to have less functionality than dig.

-

+ +

Although dig is normally used with command-line arguments, it also has a batch mode of operation for reading lookup @@ -55,34 +98,42 @@ from the command line.

-

+ +

Unless it is told to query a specific name server, dig will try each of the servers listed in /etc/resolv.conf. If no usable server addresses are found, dig will send the query to the local host.

-

+ +

When no command line arguments or options are given, dig will perform an NS query for "." (the root).

-

+ +

It is possible to set per-user defaults for dig via ${HOME}/.digrc. This file is read and any options in it are applied before the command line arguments.

-

+ +

The IN and CH class names overlap with the IN and CH top level domain names. Either use the -t and -c options to specify the type and class, use the -q the specify the domain name, or use "IN." and "CH." when looking up these top level domains.

-
-
+ +
+ +

SIMPLE USAGE

-

+ + +

A typical invocation of dig looks like: 

 dig @server name type
@@ -93,7 +144,7 @@
server
-

+

is the name or IP address of the name server to query. This can be an IPv4 address in dotted-decimal notation or an IPv6 address in colon-delimited notation. When the supplied @@ -101,7 +152,7 @@ dig resolves that name before querying that name server.

-

+

If no server argument is provided, dig consults /etc/resolv.conf; if an @@ -114,13 +165,16 @@ local host. The reply from the name server that responds is displayed.

-
+
name
-

+

+

is the name of the resource record that is to be looked up. -

+

+
type
-

+

+

indicates what type of query is required — ANY, A, MX, SIG, etc. type can be any valid query @@ -128,81 +182,109 @@ type argument is supplied, dig will perform a lookup for an A record. -

+

+

-
-
+ +
+ +

OPTIONS

-
+ + +
-4
-

+

+

Use IPv4 only. -

+

+
-6
-

+

+

Use IPv6 only. -

+

+
-b address[#port]
-

+

+

Set the source IP address of the query. The address must be a valid address on one of the host's network interfaces, or "0.0.0.0" or "::". An optional port may be specified by appending "#<port>" -

+

+
-c class
-

+

+

Set the query class. The default class is IN; other classes are HS for Hesiod records or CH for Chaosnet records. -

+

+
-f file
-

+

+

Batch mode: dig reads a list of lookup requests to process from the given file. Each line in the file should be organized in the same way they would be presented as queries to dig using the command-line interface. -

+

+
-i
-

+

+

Do reverse IPv6 lookups using the obsolete RFC1886 IP6.INT domain, which is no longer in use. Obsolete bit string label queries (RFC2874) are not attempted. -

+

+
-k keyfile
-

+

+

Sign queries using TSIG using a key read from the given file. Key files can be generated using - tsig-keygen(8). + + tsig-keygen(8) + . When using TSIG authentication with dig, the name server that is queried needs to know the key and algorithm that is being used. In BIND, this is done by providing appropriate key and server statements in named.conf. -

+

+
-m
-

+

+

Enable memory usage debugging. -

+

+
-p port
-

+

+

Send the query to a non-standard port on the server, instead of the defaut port 53. This option would be used to test a name server that has been configured to listen for queries on a non-standard port number. -

+

+
-q name
-

+

+

The domain name to query. This is useful to distinguish the name from other arguments. -

+

+
-t type
-

+

+

The resource record type to query. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the @@ -214,13 +296,17 @@ made to the zone since the serial number in the zone's SOA record was N. -

+

+
-v
-

+

+

Print the version number and exit. -

+

+
-x addr
-

+

+

Simplified reverse lookups, for mapping addresses to names. The addr is an IPv4 address in dotted-decimal notation, or a colon-delimited IPv6 @@ -235,10 +321,11 @@ addresses are looked up using nibble format under the IP6.ARPA domain (but see also the -i option). -

+

+
-y [hmac:]keyname:secret
-

+

Sign queries using TSIG with the given authentication key. keyname is the name of the key, and secret is the base64 encoded shared secret. @@ -250,28 +337,34 @@ is not specified, the default is hmac-md5 or if MD5 was disabled hmac-sha256.

-

+

NOTE: You should use the -k option and avoid the -y option, because with -y the shared secret is supplied as a command line argument in clear text. This may be visible in the output from - ps(1) + + ps(1) + or in a history file maintained by the user's shell.

-
+
-
-
+
+ +

QUERY OPTIONS

-

dig + + +

dig provides a number of query options which affect the way in which lookups are made and the results displayed. Some of these set or reset flag bits in the query header, some determine which sections of the answer get printed, and others determine the timeout and retry strategies.

-

+ +

Each query option is identified by a keyword preceded by a plus sign (+). Some keywords set or reset an option. These may be preceded @@ -287,20 +380,27 @@

+[no]aaflag
-

+

+

A synonym for +[no]aaonly. -

+

+
+[no]aaonly
-

+

+

Sets the "aa" flag in the query. -

+

+
+[no]additional
-

+

+

Display [do not display] the additional section of a reply. The default is to display it. -

+

+
+[no]adflag
-

+

+

Set [do not set] the AD (authentic data) bit in the query. This requests the server to return whether all of the answer and authority sections have all @@ -310,61 +410,81 @@ from a OPT-OUT range. AD=0 indicate that some part of the answer was insecure or not validated. This bit is set by default. -

+

+
+[no]all
-

+

+

Set or clear all display flags. -

+

+
+[no]answer
-

+

+

Display [do not display] the answer section of a reply. The default is to display it. -

+

+
+[no]authority
-

+

+

Display [do not display] the authority section of a reply. The default is to display it. -

+

+
+[no]besteffort
-

+

+

Attempt to display the contents of messages which are malformed. The default is to not display malformed answers. -

+

+
+bufsize=B
-

+

+

Set the UDP message buffer size advertised using EDNS0 to B bytes. The maximum and minimum sizes of this buffer are 65535 and 0 respectively. Values outside this range are rounded up or down appropriately. Values other than zero will cause a EDNS query to be sent. -

+

+
+[no]cdflag
-

+

+

Set [do not set] the CD (checking disabled) bit in the query. This requests the server to not perform DNSSEC validation of responses. -

+

+
+[no]class
-

+

+

Display [do not display] the CLASS when printing the record. -

+

+
+[no]cmd
-

+

+

Toggles the printing of the initial comment in the output identifying the version of dig and the query options that have been applied. This comment is printed by default. -

+

+
+[no]comments
-

+

+

Toggle the display of comment lines in the output. The default is to print comments. -

+

+
+[no]crypto
-

+

+

Toggle the display of cryptographic fields in DNSSEC records. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing @@ -373,100 +493,130 @@ are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]". -

+

+
+[no]defname
-

+

+

Deprecated, treated as a synonym for +[no]search -

+

+
+[no]dnssec
-

+

+

Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query. -

+

+
+domain=somename
-

+

+

Set the search list to contain the single domain somename, as if specified in a domain directive in /etc/resolv.conf, and enable search list processing as if the +search option were given. -

+

+
+[no]edns[=#]
-

+

+

Specify the EDNS version to query with. Valid values are 0 to 255. Setting the EDNS version will cause a EDNS query to be sent. +noedns clears the remembered EDNS version. EDNS is set to 0 by default. -

+

+
+[no]ednsflags[=#]
-

+

+

Set the must-be-zero EDNS flags bits (Z bits) to the specified value. Decimal, hex and octal encodings are accepted. Setting a named flag (e.g. DO) will silently be ignored. By default, no Z bits are set. -

+

+
+[no]ednsnegotiation
-

+

+

Enable / disable EDNS version negotiation. By default EDNS version negotiation is enabled. -

+

+
+[no]ednsopt[=code[:value]]
-

+

+

Specify EDNS option with code point code and optionally payload of value as a hexadecimal string. +noednsopt clears the EDNS options to to be sent. -

+

+
+[no]expire
-

+

+

Send an EDNS Expire option. -

+

+
+[no]fail
-

+

+

Do not try the next server if you receive a SERVFAIL. The default is to not try the next server which is the reverse of normal stub resolver behavior. -

+

+
+[no]identify
-

+

+

Show [or do not show] the IP address and port number that supplied the answer when the +short option is enabled. If short form answers are requested, the default is not to show the source address and port number of the server that provided the answer. -

+

+
+[no]idnout
-

+

+

Convert [do not convert] puny code on output. This requires IDN SUPPORT to have been enabled at compile time. The default is to convert output. -

+

+
+[no]ignore
-

+

+

Ignore truncation in UDP responses instead of retrying with TCP. By default, TCP retries are performed. -

+

+
+[no]keepopen
-

+

+

Keep the TCP socket open between queries and reuse it rather than creating a new TCP socket for each lookup. The default is +nokeepopen. -

+

+
+[no]multiline
-

+

+

Print records like the SOA records in a verbose multi-line format with human-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the dig output. -

+

+
+ndots=D
-

+

+

Set the number of dots that have to appear in name to D for it to be considered absolute. The default value @@ -478,110 +628,140 @@ or domain directive in /etc/resolv.conf if +search is set. -

+

+
+[no]nsid
-

+

+

Include an EDNS name server ID request when sending a query. -

+

+
+[no]nssearch
-

+

+

When this option is set, dig attempts to find the authoritative name servers for the zone containing the name being looked up and display the SOA record that each name server has for the zone. -

+

+
+[no]onesoa
-

+

+

Print only one (starting) SOA record when performing an AXFR. The default is to print both the starting and ending SOA records. -

+

+
+[no]opcode=value
-

+

+

Set [restore] the DNS message opcode to the specified value. The default value is QUERY (0). -

+

+
+[no]qr
-

+

+

Print [do not print] the query as it is sent. By default, the query is not printed. -

+

+
+[no]question
-

+

+

Print [do not print] the question section of a query when an answer is returned. The default is to print the question section as a comment. -

+

+
+[no]rdflag
-

+

+

A synonym for +[no]recurse. -

+

+
+[no]recurse
-

+

+

Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means dig normally sends recursive queries. Recursion is automatically disabled when the +nssearch or +trace query options are used. -

+

+
+retry=T
-

+

+

Sets the number of times to retry UDP queries to server to T instead of the default, 2. Unlike +tries, this does not include the initial query. -

+

+
+[no]rrcomments
-

+

+

Toggle the display of per-record comments in the output (for example, human-readable key information about DNSKEY records). The default is not to print record comments unless multiline mode is active. -

+

+
+[no]search
-

+

Use [do not use] the search list defined by the searchlist or domain directive in resolv.conf (if any). The search list is not used by default.

-

+

'ndots' from resolv.conf (default 1) which may be overridden by +ndots determines if the name will be treated as relative or not and hence whether a search is eventually performed or not.

-
+
+[no]short
-

+

+

Provide a terse answer. The default is to print the answer in a verbose form. -

+

+
+[no]showsearch
-

+

+

Perform [do not perform] a search showing intermediate results. -

+

+
+[no]sigchase
-

+

+

Chase DNSSEC signature chains. Requires dig be compiled with -DDIG_SIGCHASE. -

+

+
+[no]sit[=####]
-

+

+

Send a Source Identity Token EDNS option, with optional value. Replaying a SIT from a previous response will allow the server to identify a previous client. The default is +nosit. Currently using experimental value 65001 for the option code. -

+

+
+split=W
-

+

+

Split long hex- or base64-formatted fields in resource records into chunks of W characters (where W is rounded @@ -590,21 +770,24 @@ +split=0 causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active. -

+

+
+[no]stats
-

+

+

This query option toggles the printing of statistics: when the query was made, the size of the reply and so on. The default behavior is to print the query statistics. -

+

+
+[no]subnet=addr[/prefix-length]
-

+

Send (don't send) an EDNS Client Subnet option with the specified IP address or network prefix.

-

+

dig +subnet=0.0.0.0/0, or simply dig +subnet=0 for short, sends an EDNS CLIENT-SUBNET option with an empty address and a source @@ -613,17 +796,20 @@ not be used when resolving this query.

-
+
+[no]tcp
-

+

+

Use [do not use] TCP when querying name servers. The default behavior is to use UDP unless an ixfr=N query is requested, in which case the default is TCP. AXFR queries always use TCP. -

+

+
+time=T
-

+

+

Sets the timeout for a query to T seconds. The default @@ -631,15 +817,18 @@ An attempt to set T to less than 1 will result in a query timeout of 1 second being applied. -

+

+
+[no]topdown
-

+

+

When chasing DNSSEC signature chains perform a top-down validation. Requires dig be compiled with -DDIG_SIGCHASE. -

+

+
+[no]trace
-

+

Toggle tracing of the delegation path from the root name servers for the name being looked up. Tracing is disabled by default. When tracing is enabled, @@ -647,62 +836,67 @@ resolve the name being looked up. It will follow referrals from the root servers, showing the answer from each server that was used to resolve the lookup. -

-

+

If @server is also specified, it affects only the initial query for the root zone name servers. -

-

+

+dnssec is also set when +trace is set to better emulate the default queries from a nameserver.

-
+
+tries=T
-

+

+

Sets the number of times to try UDP queries to server to T instead of the default, 3. If T is less than or equal to zero, the number of tries is silently rounded up to 1. -

+

+
+trusted-key=####
-

+

Specifies a file containing trusted keys to be used with +sigchase. Each DNSKEY record must be on its own line. -

-

+

If not specified, dig will look for /etc/trusted-key.key then trusted-key.key in the current directory. -

-

+

Requires dig be compiled with -DDIG_SIGCHASE.

-
+
+[no]ttlid
-

+

+

Display [do not display] the TTL when printing the record. -

+

+
+[no]vc
-

+

+

Use [do not use] TCP when querying name servers. This alternate syntax to +[no]tcp is provided for backwards compatibility. The "vc" stands for "virtual circuit". -

+

+

-
-
+
+ +

MULTIPLE QUERIES

-

+ + +

The BIND 9 implementation of dig supports specifying multiple queries on the command line (in addition to @@ -710,7 +904,8 @@ queries can be supplied with its own set of flags, options and query options.

-

+ +

In this case, each query argument represent an individual query in the command-line syntax described above. Each @@ -718,7 +913,8 @@ looked up, an optional query type and class and any query options that should be applied to that query.

-

+ +

A global set of query options, which should be applied to all queries, can also be supplied. These global query options must precede the first tuple of name, class, type, options, flags, and query options @@ -745,10 +941,13 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr will not print the initial query when it looks up the NS records for isc.org.

-
-
+ +
+ +

IDN SUPPORT

-

+ +

If dig has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. dig appropriately converts character encoding of @@ -759,27 +958,40 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr The IDN support is disabled if the variable is set when dig runs.

-
-
+
+ +

FILES

-

/etc/resolv.conf + +

/etc/resolv.conf

-

${HOME}/.digrc +

${HOME}/.digrc

-
-
+
+ +

SEE ALSO

-

host(1), - named(8), - dnssec-keygen(8), + +

+ host(1) + , + + named(8) + , + + dnssec-keygen(8) + , RFC1035.

-
-
+
+ +

BUGS

-

+ +

There are probably too many query options.

-
+
+
diff --git a/bin/dig/host.html b/bin/dig/host.html index b5ac949863..acb1d31d1e 100644 --- a/bin/dig/host.html +++ b/bin/dig/host.html @@ -23,24 +23,54 @@
-
+ + + + + +

Name

-

host — DNS lookup utility

+

+ host + — DNS lookup utility +

-
+ + + +

Synopsis

-

host [-aCdlnrsTwv] [-c class] [-N ndots] [-R number] [-t type] [-W wait] [-m flag] [-4] [-6] [-v] [-V] {name} [server]

-
-
+

+ host + [-aCdlnrsTwv] + [-c class] + [-N ndots] + [-R number] + [-t type] + [-W wait] + [-m flag] + [-4] + [-6] + [-v] + [-V] + {name} + [server] +

+
+ +

DESCRIPTION

-

host + + +

host is a simple utility for performing DNS lookups. It is normally used to convert names to IP addresses and vice versa. When no arguments or options are given, host prints a short summary of its command line arguments and options.

-

name is the domain name that is to be + +

name is the domain name that is to be looked up. It can also be a dotted-decimal IPv4 address or a colon-delimited IPv6 address, in which case host will by @@ -52,68 +82,86 @@ should query instead of the server or servers listed in /etc/resolv.conf.

-
-
+ +
+ +

OPTIONS

-
+ +
-4
-

+

+

Use IPv4 only for query transport. See also the -6 option. -

+

+
-6
-

+

+

Use IPv6 only for query transport. See also the -4 option. -

+

+
-a
-

+

+

"All". The -a option is normally equivalent to -v -t ANY. It also affects the behaviour of the -l list zone option. -

+

+
-c class
-

+

+

Query class: This can be used to lookup HS (Hesiod) or CH (Chaosnet) class resource records. The default class is IN (Internet). -

+

+
-C
-

+

+

Check consistency: host will query the SOA records for zone name from all the listed authoritative name servers for that zone. The list of name servers is defined by the NS records that are found for the zone. -

+

+
-d
-

+

+

Print debugging traces. Equivalent to the -v verbose option. -

+

+
-i
-

+

+

Obsolete. Use the IP6.INT domain for reverse lookups of IPv6 addresses as defined in RFC1886 and deprecated in RFC4159. The default is to use IP6.ARPA as specified in RFC3596. -

+

+
-l
-

+

List zone: The host command performs a zone transfer of zone name and prints out the NS, PTR and address records (A/AAAA).

-

+

Together, the -l -a options print all records in the zone.

-
+
-N ndots
-

+

+

The number of dots that have to be in name for it to be considered absolute. The default value is that defined using the @@ -123,9 +171,11 @@ searched for in the domains listed in the search or domain directive in /etc/resolv.conf. -

+

+
-r
-

+

+

Non-recursive query: Setting this option clears the RD (recursion desired) bit in the query. This should mean that the name server @@ -136,28 +186,33 @@ name server by making non-recursive queries and expecting to receive answers to those queries that can be referrals to other name servers. -

+

+
-R number
-

+

+

Number of retries for UDP queries: If number is negative or zero, the number of retries will default to 1. The default value is 1. -

+

+
-s
-

+

+

Do not send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior. -

+

+
-t type
-

+

Query type: The type argument can be any recognized query type: CNAME, NS, SOA, TXT, DNSKEY, AXFR, etc.

-

+

When no query type is specified, host automatically selects an appropriate query type. By default, it looks for A, AAAA, and MX records. @@ -168,65 +223,78 @@ address, host will query for PTR records.

-

+

If a query type of IXFR is chosen the starting serial number can be specified by appending an equal followed by the starting serial number (like -t IXFR=12345678).

-
+
-T
-

+

+

TCP: By default, host uses UDP when making queries. The -T option makes it use a TCP connection when querying the name server. TCP will be automatically selected for queries that require it, such as zone transfer (AXFR) requests. -

+

+
-m flag
-

+

+

Memory usage debugging: the flag can be record, usage, or trace. You can specify the -m option more than once to set multiple flags. -

+

+
-v
-

+

+

Verbose output. Equivalent to the -d debug option. -

+

+
-V
-

+

+

Print the version number and exit. -

+

+
-w
-

+

+

Wait forever: The query timeout is set to the maximum possible. See also the -W option. -

+

+
-W wait
-

+

Timeout: Wait for up to wait seconds for a reply. If wait is less than one, the wait interval is set to one second.

-

+

By default, host will wait for 5 seconds for UDP responses and 10 seconds for TCP connections.

-

+

See also the -w option.

-
+
-
-
+ +
+ +

IDN SUPPORT

-

+ +

If host has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. host appropriately converts character encoding of @@ -237,17 +305,26 @@ The IDN support is disabled if the variable is set when host runs.

-
-
+
+ +

FILES

-

/etc/resolv.conf + +

/etc/resolv.conf

-
-
+
+ +

SEE ALSO

-

dig(1), - named(8). + +

+ dig(1) + , + + named(8) + .

-
+
+
diff --git a/bin/dig/nslookup.html b/bin/dig/nslookup.html index f521fa97dc..3ab2b98112 100644 --- a/bin/dig/nslookup.html +++ b/bin/dig/nslookup.html @@ -21,18 +21,36 @@
-
-
+
+ + + + + +

Name

-

nslookup — query Internet name servers interactively

+

+ nslookup + — query Internet name servers interactively +

-
+ + + +

Synopsis

-

nslookup [-option] [name | -] [server]

-
-
+

+ nslookup + [-option] + [name | -] + [server] +

+
+ +

DESCRIPTION

-

Nslookup + +

Nslookup is a program to query Internet domain name servers. Nslookup has two modes: interactive and non-interactive. Interactive mode allows the user to query name servers for information about various hosts and @@ -41,29 +59,37 @@ used to print just the name and requested information for a host or domain.

-
-
+
+ +

ARGUMENTS

-

+ +

Interactive mode is entered in the following cases:

    -

  1. +

  2. +

    when no arguments are given (the default name server will be used) -

    3. -

  3. +

    +
    4. +
  4. +

    when the first argument is a hyphen (-) and the second argument is the host name or Internet address of a name server. -

    5. +

    +

-

+ +

Non-interactive mode is used when the name or Internet address of the host to be looked up is given as the first argument. The optional second argument specifies the host name or address of a name server.

-

+ +

Options can also be specified on the command line if they precede the arguments and are prefixed with a hyphen. For example, to change the default query type to host information, and the initial @@ -76,246 +102,299 @@ nslookup -query=hinfo -timeout=10

-

+

The -version option causes nslookup to print the version number and immediately exits.

-
-
+ +
+ +

INTERACTIVE COMMANDS

-
+ +
host [server]
-

+

Look up information for host using the current default server or using server, if specified. If host is an Internet address and the query type is A or PTR, the name of the host is returned. If host is a name and does not have a trailing period, the search list is used to qualify the name.

-

+ +

To look up a host not in the current domain, append a period to the name.

-
+
server domain
-

+
+

+
lserver domain
-

+

+

Change the default server to domain; lserver uses the initial server to look up information about domain, while server uses the current default server. If an authoritative answer can't be found, the names of servers that might have the answer are returned. -

+

+
root
-

+

+

not implemented -

+

+
finger
-

+

+

not implemented -

+

+
ls
-

+

+

not implemented -

+

+
view
-

+

+

not implemented -

+

+
help
-

+

+

not implemented -

+

+
?
-

+

+

not implemented -

+

+
exit
-

+

+

Exits the program. -

+

+
set keyword[=value]
-

+

This command is used to change state information that affects the lookups. Valid keywords are:

all
-

+

+

Prints the current values of the frequently used options to set. Information about the current default server and host is also printed. -

+

+
class=value
-

+

Change the query class to one of:

IN
-

+

+

the Internet class -

+

+
CH
-

+

+

the Chaos class -

+

+
HS
-

+

+

the Hesiod class -

+

+
ANY
-

+

+

wildcard -

+

+

The class specifies the protocol group of the information.

-

+

(Default = IN; abbreviation = cl)

- +
[no]debug
-

+

Turn on or off the display of the full response packet and any intermediate response packets when searching.

-

+

(Default = nodebug; abbreviation = [no]deb)

-
+
[no]d2
-

+

Turn debugging mode on or off. This displays more about what nslookup is doing.

-

+

(Default = nod2)

-
+
domain=name
-

+

+

Sets the search list to name. -

+

+
[no]search
-

+

If the lookup request contains at least one period but doesn't end with a trailing period, append the domain names in the domain search list to the request until an answer is received.

-

+

(Default = search)

-
+
port=value
-

+

Change the default TCP/UDP name server port to value.

-

+

(Default = 53; abbreviation = po)

-
+
querytype=value
-

+
+

+
type=value
-

+

Change the type of the information query.

-

+

(Default = A; abbreviations = q, ty)

-
+
[no]recurse
-

+

Tell the name server to query other servers if it does not have the information.

-

+

(Default = recurse; abbreviation = [no]rec)

-
+
ndots=number
-

+

+

Set the number of dots (label separators) in a domain that will disable searching. Absolute names always stop searching. -

+

+
retry=number
-

+

+

Set the number of retries to number. -

+

+
timeout=number
-

+

+

Change the initial timeout interval for waiting for a reply to number seconds. -

+

+
[no]vc
-

+

Always use a virtual circuit when sending requests to the server.

-

+

(Default = novc)

-
+
[no]fail
-

+

Try the next nameserver if a nameserver responds with SERVFAIL or a referral (nofail) or terminate query (fail) on such a response.

-

+

(Default = nofail)

-
+

- +
-
-
+
+ +

RETURN VALUES

-

+

nslookup returns with an exit status of 1 if any query failed, and 0 otherwise.

-
-
+
+ +

FILES

-

/etc/resolv.conf + +

/etc/resolv.conf

-
-
+
+ +

SEE ALSO

-

dig(1), - host(1), - named(8). + +

+ dig(1) + , + + host(1) + , + + named(8) + .

-
+
diff --git a/bin/dnssec/dnssec-dsfromkey.html b/bin/dnssec/dnssec-dsfromkey.html index 5a3071c270..6cbf339e78 100644 --- a/bin/dnssec/dnssec-dsfromkey.html +++ b/bin/dnssec/dnssec-dsfromkey.html @@ -22,158 +22,242 @@
-
+ + + + + +

Name

-

dnssec-dsfromkey — DNSSEC DS RR generation tool

+

+ dnssec-dsfromkey + — DNSSEC DS RR generation tool +

-
+ + + +

Synopsis

-

dnssec-dsfromkey [-v level] [-1] [-2] [-a alg] [-C] [-l domain] [-T TTL] {keyfile}

-

dnssec-dsfromkey {-s} [-1] [-2] [-a alg] [-K directory] [-l domain] [-s] [-c class] [-T TTL] [-f file] [-A] [-v level] {dnsname}

-

dnssec-dsfromkey [-h] [-V]

-
-
+

+ dnssec-dsfromkey + [-v level] + [-1] + [-2] + [-a alg] + [-C] + [-l domain] + [-T TTL] + {keyfile} +

+

+ dnssec-dsfromkey + {-s} + [-1] + [-2] + [-a alg] + [-K directory] + [-l domain] + [-s] + [-c class] + [-T TTL] + [-f file] + [-A] + [-v level] + {dnsname} +

+

+ dnssec-dsfromkey + [-h] + [-V] +

+
+ +

DESCRIPTION

-

dnssec-dsfromkey + +

dnssec-dsfromkey outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s).

-
-
+
+ +

OPTIONS

-
+ + +
-1
-

+

+

Use SHA-1 as the digest algorithm (the default is to use both SHA-1 and SHA-256). -

+

+
-2
-

+

+

Use SHA-256 as the digest algorithm. -

+

+
-a algorithm
-

+

+

Select the digest algorithm. The value of algorithm must be one of SHA-1 (SHA1), SHA-256 (SHA256), GOST or SHA-384 (SHA384). These values are case insensitive. -

+

+
-C
-

+

+

Generate CDS records rather than DS records. This is mutually exclusive with generating lookaside records. -

+

+
-T TTL
-

+

+

Specifies the TTL of the DS records. -

+

+
-K directory
-

+

+

Look for key files (or, in keyset mode, keyset- files) in directory. -

+

+
-f file
-

+

Zone file mode: in place of the keyfile name, the argument is the DNS domain name of a zone master file, which can be read from file. If the zone name is the same as file, then it may be omitted.

-

+

If file is set to "-", then the zone data is read from the standard input. This makes it possible to use the output of the dig command as input, as in:

-

+

dig dnskey example.com | dnssec-dsfromkey -f - example.com

-
+
-A
-

+

+

Include ZSK's when generating DS records. Without this option, only keys which have the KSK flag set will be converted to DS records and printed. Useful only in zone file mode. -

+

+
-l domain
-

+

+

Generate a DLV set instead of a DS set. The specified domain is appended to the name for each record in the set. The DNSSEC Lookaside Validation (DLV) RR is described in RFC 4431. This is mutually exclusive with generating CDS records. -

+

+
-s
-

+

+

Keyset mode: in place of the keyfile name, the argument is the DNS domain name of a keyset file. -

+

+
-c class
-

+

+

Specifies the DNS class (default is IN). Useful only in keyset or zone file mode. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-h
-

+

+

Prints usage information. -

+

+
-V
-

+

+

Prints version information. -

+

+
-
-
+
+ +

EXAMPLE

-

+ +

To build the SHA-256 DS RR from the Kexample.com.+003+26160 keyfile name, the following command would be issued:

-

dnssec-dsfromkey -2 Kexample.com.+003+26160 +

dnssec-dsfromkey -2 Kexample.com.+003+26160

-

+

The command would print something like:

-

example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94 +

example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94

-
-
+
+ +

FILES

-

+ +

The keyfile can be designed by the key identification Knnnn.+aaa+iiiii or the full file name Knnnn.+aaa+iiiii.key as generated by dnssec-keygen(8).

-

+

The keyset file name is built from the directory, the string keyset- and the dnsname.

-
-
+
+ +

CAVEAT

-

+ +

A keyfile error can give a "file not found" even if the file exists.

-
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), - dnssec-signzone(8), + +

+ dnssec-keygen(8) + , + + dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 3658, RFC 4431. RFC 4509.

-
+
+
diff --git a/bin/dnssec/dnssec-importkey.html b/bin/dnssec/dnssec-importkey.html index 37a90ebd81..2485f39d62 100644 --- a/bin/dnssec/dnssec-importkey.html +++ b/bin/dnssec/dnssec-importkey.html @@ -22,18 +22,52 @@
-
+ + + + + +

Name

-

dnssec-importkey — import DNSKEY records from external systems so they can be managed

+

+ dnssec-importkey + — import DNSKEY records from external systems so they can be managed +

-
+ + + +

Synopsis

-

dnssec-importkey [-K directory] [-L ttl] [-P date/offset] [-D date/offset] [-h] [-v level] [-V] {keyfile}

-

dnssec-importkey {-f filename} [-K directory] [-L ttl] [-P date/offset] [-D date/offset] [-h] [-v level] [-V] [dnsname]

-
-
+

+ dnssec-importkey + [-K directory] + [-L ttl] + [-P date/offset] + [-D date/offset] + [-h] + [-v level] + [-V] + {keyfile} +

+

+ dnssec-importkey + {-f filename} + [-K directory] + [-L ttl] + [-P date/offset] + [-D date/offset] + [-h] + [-v level] + [-V] + [dnsname] +

+
+ +

DESCRIPTION

-

dnssec-importkey + +

dnssec-importkey reads a public DNSKEY record and generates a pair of .key/.private files. The DNSKEY record may be read from an existing .key file, in which case a corresponding .private file @@ -41,7 +75,7 @@ from the standard input, in which case both .key and .private files will be generated.

-

+

The newly-created .private file does not contain private key data, and cannot be used for signing. However, having a .private file makes it possible to set @@ -50,53 +84,68 @@ public key can be added to and removed from the DNSKEY RRset on schedule even if the true private key is stored offline.

-
-
+
+ +

OPTIONS

-
+ + +
-f filename
-

+

Zone file mode: instead of a public keyfile name, the argument is the DNS domain name of a zone master file, which can be read from file. If the domain name is the same as file, then it may be omitted.

-

+

If file is set to "-", then the zone data is read from the standard input.

-
+
-K directory
-

+

+

Sets the directory in which the key files are to reside. -

+

+
-L ttl
-

+

+

Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. Setting the default TTL to 0 or none removes it. -

+

+
-h
-

+

+

Emit usage message and exit. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-
-
+
+ +

TIMING OPTIONS

-

+ +

Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as an offset from the present time. For convenience, if such an offset @@ -107,37 +156,51 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. -

+

+
-D date/offset
-

+

+

Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) -

+

+
-
-
+
+ +

FILES

-

+ +

A keyfile can be designed by the key identification Knnnn.+aaa+iiiii or the full file name Knnnn.+aaa+iiiii.key as generated by dnssec-keygen(8).

-
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), - dnssec-signzone(8), + +

+ dnssec-keygen(8) + , + + dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 5011.

-
+
+
diff --git a/bin/dnssec/dnssec-keyfromlabel.html b/bin/dnssec/dnssec-keyfromlabel.html index eb752d94f2..f238bc4e80 100644 --- a/bin/dnssec/dnssec-keyfromlabel.html +++ b/bin/dnssec/dnssec-keyfromlabel.html @@ -22,17 +22,56 @@
-
+ + + + + +

Name

-

dnssec-keyfromlabel — DNSSEC key generation tool

+

+ dnssec-keyfromlabel + — DNSSEC key generation tool +

-
+ + + +

Synopsis

-

dnssec-keyfromlabel {-l label} [-3] [-a algorithm] [-A date/offset] [-c class] [-D date/offset] [-E engine] [-f flag] [-G] [-I date/offset] [-i interval] [-k] [-K directory] [-L ttl] [-n nametype] [-P date/offset] [-p protocol] [-R date/offset] [-S key] [-t type] [-v level] [-V] [-y] {name}

-
-
+

+ dnssec-keyfromlabel + {-l label} + [-3] + [-a algorithm] + [-A date/offset] + [-c class] + [-D date/offset] + [-E engine] + [-f flag] + [-G] + [-I date/offset] + [-i interval] + [-k] + [-K directory] + [-L ttl] + [-n nametype] + [-P date/offset] + [-p protocol] + [-R date/offset] + [-S key] + [-t type] + [-v level] + [-V] + [-y] + {name} +

+
+ +

DESCRIPTION

-

dnssec-keyfromlabel + +

dnssec-keyfromlabel generates a key pair of files that referencing a key object stored in a cryptographic hardware service module (HSM). The private key file can be used for DNSSEC signing of zone data as if it were a @@ -40,52 +79,57 @@ but the key material is stored within the HSM, and the actual signing takes place there.

-

+

The name of the key is specified on the command line. This must match the name of the zone for which the key is being generated.

-
-
+
+ +

OPTIONS

-
+ + +
-a algorithm
-

+

Selects the cryptographic algorithm. The value of algorithm must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384. These values are case insensitive.

-

+

If no algorithm is specified, then RSASHA1 will be used by default, unless the -3 option is specified, in which case NSEC3RSASHA1 will be used instead. (If -3 is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.)

-

+

Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended.

-

+

Note 2: DH automatically sets the -k flag.

-
+
-3
-

+

+

Use an NSEC3-capable algorithm to generate a DNSSEC key. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -93,20 +137,20 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-l label
-

+

Specifies the label for a key pair in the crypto hardware.

-

+

When BIND 9 is built with OpenSSL-based PKCS#11 support, the label is an arbitrary string that identifies a particular key. It may be preceded by an optional OpenSSL engine name, followed by a colon, as in "pkcs11:keylabel".

-

+

When BIND 9 is built with native PKCS#11 support, the label is a PKCS#11 URI string in the format "pkcs11:keyword=value[;keyword=value;...]" @@ -115,7 +159,7 @@ which the HSM's PIN code can be obtained. The label will be stored in the on-disk "private" file.

-

+

If the label contains a pin-source field, tools using the generated key files will be able to use the HSM for signing and other @@ -124,18 +168,21 @@ may reduce the security advantage of using an HSM; be sure this is what you want to do before making use of this feature.

-
+
-n nametype
-

+

+

Specifies the owner type of the key. The value of nametype must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). These values are case insensitive. -

+

+
-C
-

+

+

Compatibility mode: generates an old-style key, without any metadata. By default, dnssec-keyfromlabel will include the key's creation date in the metadata stored @@ -143,53 +190,71 @@ (publication date, activation date, etc). Keys that include this data may be incompatible with older versions of BIND; the -C option suppresses them. -

+

+
-c class
-

+

+

Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. -

+

+
-f flag
-

+

+

Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE. -

+

+
-G
-

+

+

Generate a key, but do not publish it or sign with it. This option is incompatible with -P and -A. -

+

+
-h
-

+

+

Prints a short summary of the options and arguments to dnssec-keyfromlabel. -

+

+
-K directory
-

+

+

Sets the directory in which the key files are to be written. -

+

+
-k
-

+

+

Generate KEY records rather than DNSKEY records. -

+

+
-L ttl
-

+

+

Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. Setting the default TTL to 0 or none removes it. -

+

+
-p protocol
-

+

+

Sets the protocol value for the key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in RFC 2535 and its successors. -

+

+
-S key
-

+

+

Generate a key as an explicit successor to an existing key. The name, algorithm, size, and type of the key will be set to match the predecessor. The activation date of the new @@ -197,35 +262,47 @@ one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. -

+

+
-t type
-

+

+

Indicates the use of the key. type must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-y
-

+

+

Allows DNSSEC key files to be generated even if the key ID would collide with that of an existing key, in the event of either key being revoked. (This is only safe to use if you are sure you won't be using RFC 5011 trust anchor maintenance with either of the keys involved.) -

+

+
-
-
+
+ +

TIMING OPTIONS

-

+ + +

Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as an offset from the present time. For convenience, if such an offset @@ -236,42 +313,53 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. If not set, and if the -G option has not been used, the default is "now". -

+

+
-A date/offset
-

+

+

Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. If not set, and if the -G option has not been used, the default is "now". -

+

+
-R date/offset
-

+

+

Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it. -

+

+
-I date/offset
-

+

+

Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it. -

+

+
-D date/offset
-

+

+

Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) -

+

+
-i interval
-

+

Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the @@ -280,68 +368,83 @@ the publication date is specified but activation date isn't, then activation will be set to this much time after publication.

-

+

If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero.

-

+

As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.

-
+
-
-
+
+ +

GENERATED KEY FILES

-

+ +

When dnssec-keyfromlabel completes successfully, it prints a string of the form Knnnn.+aaa+iiiii to the standard output. This is an identification string for the key files it has generated.

-
    -

  • nnnn is the key name. -

    • -

  • aaa is the numeric representation +

      +
    • +

      nnnn is the key name. +

      +
      • +
    • +

      aaa is the numeric representation of the algorithm. -

      • -

    • iiiii is the key identifier (or +

      +
      • +
    • +

      iiiii is the key identifier (or footprint). -

      • +

      +
    -

    dnssec-keyfromlabel +

    dnssec-keyfromlabel creates two files, with names based on the printed string. Knnnn.+aaa+iiiii.key contains the public key, and Knnnn.+aaa+iiiii.private contains the private key.

    -

    +

    The .key file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement).

    -

    +

    The .private file contains algorithm-specific fields. For obvious security reasons, this file does not have general read permission.

    -
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), - dnssec-signzone(8), + +

+ dnssec-keygen(8) + , + + dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 4034, The PKCS#11 URI Scheme (draft-pechanec-pkcs11uri-13).

-
+
+
diff --git a/bin/dnssec/dnssec-keygen.html b/bin/dnssec/dnssec-keygen.html index 99d1cc326b..7129b92d6c 100644 --- a/bin/dnssec/dnssec-keygen.html +++ b/bin/dnssec/dnssec-keygen.html @@ -23,34 +23,82 @@
-
+ + + + + +

Name

-

dnssec-keygen — DNSSEC key generation tool

+

+ dnssec-keygen + — DNSSEC key generation tool +

-
+ + + +

Synopsis

-

dnssec-keygen [-a algorithm] [-b keysize] [-n nametype] [-3] [-A date/offset] [-C] [-c class] [-D date/offset] [-E engine] [-f flag] [-G] [-g generator] [-h] [-I date/offset] [-i interval] [-K directory] [-L ttl] [-k] [-P date/offset] [-p protocol] [-q] [-R date/offset] [-r randomdev] [-S key] [-s strength] [-t type] [-v level] [-V] [-z] {name}

-
-
+

+ dnssec-keygen + [-a algorithm] + [-b keysize] + [-n nametype] + [-3] + [-A date/offset] + [-C] + [-c class] + [-D date/offset] + [-E engine] + [-f flag] + [-G] + [-g generator] + [-h] + [-I date/offset] + [-i interval] + [-K directory] + [-L ttl] + [-k] + [-P date/offset] + [-p protocol] + [-q] + [-R date/offset] + [-r randomdev] + [-S key] + [-s strength] + [-t type] + [-v level] + [-V] + [-z] + {name} +

+
+ +

DESCRIPTION

-

dnssec-keygen + +

dnssec-keygen generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034. It can also generate keys for use with TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY (Transaction Key) as defined in RFC 2930.

-

+

The name of the key is specified on the command line. For DNSSEC keys, this must match the name of the zone for which the key is being generated.

-
-
+
+ +

OPTIONS

-
+ + +
-a algorithm
-

+

Selects the cryptographic algorithm. For DNSSEC keys, the value of algorithm must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, @@ -60,26 +108,26 @@ HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are case insensitive.

-

+

If no algorithm is specified, then RSASHA1 will be used by default, unless the -3 option is specified, in which case NSEC3RSASHA1 will be used instead. (If -3 is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.)

-

+

Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is mandatory.

-

+

Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512 automatically set the -T KEY option.

-
+
-b keysize
-

+

Specifies the number of bits in the key. The choice of key size depends on the algorithm used. RSA keys must be between 512 and 2048 bits. Diffie Hellman keys must be between @@ -88,7 +136,7 @@ between 1 and 512 bits. Elliptic curve algorithms don't need this parameter.

-

+

The key size does not need to be specified if using a default algorithm. The default key size is 1024 bits for zone signing keys (ZSK's) and 2048 bits for key signing keys (KSK's, @@ -97,9 +145,10 @@ then there is no default key size, and the -b must be used.

-
+
-n nametype
-

+

+

Specifies the owner type of the key. The value of nametype must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with @@ -107,18 +156,22 @@ USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). These values are case insensitive. Defaults to ZONE for DNSKEY generation. -

+

+
-3
-

+

+

Use an NSEC3-capable algorithm to generate a DNSSEC key. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default. Note that RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 and ECDSAP384SHA384 algorithms are NSEC3-capable. -

+

+
-C
-

+

+

Compatibility mode: generates an old-style key, without any metadata. By default, dnssec-keygen will include the key's creation date in the metadata stored @@ -126,18 +179,21 @@ (publication date, activation date, etc). Keys that include this data may be incompatible with older versions of BIND; the -C option suppresses them. -

+

+
-c class
-

+

+

Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -145,39 +201,52 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-f flag
-

+

+

Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE. -

+

+
-G
-

+

+

Generate a key, but do not publish it or sign with it. This option is incompatible with -P and -A. -

+

+
-g generator
-

+

+

If generating a Diffie Hellman key, use this generator. Allowed values are 2 and 5. If no generator is specified, a known prime from RFC 2539 will be used if possible; otherwise the default is 2. -

+

+
-h
-

+

+

Prints a short summary of the options and arguments to dnssec-keygen. -

+

+
-K directory
-

+

+

Sets the directory in which the key files are to be written. -

+

+
-k
-

+

+

Deprecated in favor of -T KEY. -

+

+
-L ttl
-

+

+

Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was @@ -186,16 +255,20 @@ is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to 0 or none is the same as leaving it unset. -

+

+
-p protocol
-

+

+

Sets the protocol value for the generated key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in RFC 2535 and its successors. -

+

+
-q
-

+

+

Quiet mode: Suppresses unnecessary output, including progress indication. Without this option, when dnssec-keygen is run interactively @@ -207,9 +280,11 @@ round of the Miller-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key. -

+

+
-r randomdev
-

+

+

Specifies the source of randomness. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness @@ -219,9 +294,11 @@ data to be used instead of the default. The special value keyboard indicates that keyboard input should be used. -

+

+
-S key
-

+

+

Create a new key which is an explicit successor to an existing key. The name, algorithm, size, and type of the key will be set to match the existing key. The activation @@ -229,16 +306,19 @@ the existing one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. -

+

+
-s strength
-

+

+

Specifies the strength value of the key. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC. -

+

+
-T rrtype
-

+

Specifies the resource record type to use for the key. rrtype must be either DNSKEY or KEY. The default is DNSKEY when using a DNSSEC algorithm, but it can be @@ -250,27 +330,36 @@ Using any TSIG algorithm (HMAC-* or DH) forces this option to KEY.

-
+
-t type
-

+

+

Indicates the use of the key. type must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-
-
+
+ +

TIMING OPTIONS

-

+ + +

Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as an offset from the present time. For convenience, if such an offset @@ -281,44 +370,55 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. If not set, and if the -G option has not been used, the default is "now". -

+

+
-A date/offset
-

+

+

Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. If not set, and if the -G option has not been used, the default is "now". If set, if and -P is not set, then the publication date will be set to the activation date minus the prepublication interval. -

+

+
-R date/offset
-

+

+

Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it. -

+

+
-I date/offset
-

+

+

Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it. -

+

+
-D date/offset
-

+

+

Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) -

+

+
-i interval
-

+

Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the @@ -327,42 +427,51 @@ the publication date is specified but activation date isn't, then activation will be set to this much time after publication.

-

+

If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero.

-

+

As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.

-
+
-
-
+
+ + +

GENERATED KEYS

-

+ +

When dnssec-keygen completes successfully, it prints a string of the form Knnnn.+aaa+iiiii to the standard output. This is an identification string for the key it has generated.

-
    -

  • nnnn is the key name. -

    • -

  • aaa is the numeric representation +

      +
    • +

      nnnn is the key name. +

      +
      • +
    • +

      aaa is the numeric representation of the algorithm. -

      • -

    • iiiii is the key identifier (or +

      +
      • +
    • +

      iiiii is the key identifier (or footprint). -

      • +

      +
    -

    dnssec-keygen +

    dnssec-keygen creates two files, with names based on the printed string. Knnnn.+aaa+iiiii.key contains the public key, and @@ -370,53 +479,60 @@ private key.

    -

    +

    The .key file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement).

    -

    +

    The .private file contains algorithm-specific fields. For obvious security reasons, this file does not have general read permission.

    -

    +

    Both .key and .private files are generated for symmetric cryptography algorithms such as HMAC-MD5, even though the public and private key are equivalent.

    -
-
+
+ +

EXAMPLE

-

+ +

To generate a 768-bit DSA key for the domain example.com, the following command would be issued:

-

dnssec-keygen -a DSA -b 768 -n ZONE example.com +

dnssec-keygen -a DSA -b 768 -n ZONE example.com

-

+

The command would print a string of the form:

-

Kexample.com.+003+26160 +

Kexample.com.+003+26160

-

+

In this example, dnssec-keygen creates the files Kexample.com.+003+26160.key and Kexample.com.+003+26160.private.

-
-
+
+ +

SEE ALSO

-

dnssec-signzone(8), + +

+ dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 2539, RFC 2845, RFC 4034.

-
+
+
diff --git a/bin/dnssec/dnssec-revoke.html b/bin/dnssec/dnssec-revoke.html index 78fe31b7c0..6498c67e09 100644 --- a/bin/dnssec/dnssec-revoke.html +++ b/bin/dnssec/dnssec-revoke.html @@ -22,52 +22,88 @@
-
+ + + + + +

Name

-

dnssec-revoke — set the REVOKED bit on a DNSSEC key

+

+ dnssec-revoke + — set the REVOKED bit on a DNSSEC key +

-
+ + + +

Synopsis

-

dnssec-revoke [-hr] [-v level] [-V] [-K directory] [-E engine] [-f] [-R] {keyfile}

-
-
+

+ dnssec-revoke + [-hr] + [-v level] + [-V] + [-K directory] + [-E engine] + [-f] + [-R] + {keyfile} +

+
+ +

DESCRIPTION

-

dnssec-revoke + +

dnssec-revoke reads a DNSSEC key file, sets the REVOKED bit on the key as defined in RFC 5011, and creates a new pair of key files containing the now-revoked key.

-
-
+
+ +

OPTIONS

-
+ + +
-h
-

+

+

Emit usage message and exit. -

+

+
-K directory
-

+

+

Sets the directory in which the key files are to reside. -

+

+
-r
-

+

+

After writing the new keyset files remove the original keyset files. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -75,26 +111,35 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-f
-

+

+

Force overwrite: Causes dnssec-revoke to write the new key pair even if a file already exists matching the algorithm and key ID of the revoked key. -

+

+
-R
-

+

+

Print the key tag of the key with the REVOKE bit set but do not revoke the key. -

+

+
-
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), + +

+ dnssec-keygen(8) + , BIND 9 Administrator Reference Manual, RFC 5011.

-
+
+
diff --git a/bin/dnssec/dnssec-settime.html b/bin/dnssec/dnssec-settime.html index c5c8339ecb..c4ae653dfd 100644 --- a/bin/dnssec/dnssec-settime.html +++ b/bin/dnssec/dnssec-settime.html @@ -22,17 +22,45 @@
-
+ + + + + +

Name

-

dnssec-settime — set the key timing metadata for a DNSSEC key

+

+ dnssec-settime + — set the key timing metadata for a DNSSEC key +

-
+ + + +

Synopsis

-

dnssec-settime [-f] [-K directory] [-L ttl] [-P date/offset] [-A date/offset] [-R date/offset] [-I date/offset] [-D date/offset] [-h] [-V] [-v level] [-E engine] {keyfile}

-
-
+

+ dnssec-settime + [-f] + [-K directory] + [-L ttl] + [-P date/offset] + [-A date/offset] + [-R date/offset] + [-I date/offset] + [-D date/offset] + [-h] + [-V] + [-v level] + [-E engine] + {keyfile} +

+
+ +

DESCRIPTION

-

dnssec-settime + +

dnssec-settime reads a DNSSEC private key file and sets the key timing metadata as specified by the -P, -A, -R, -I, and -D @@ -41,12 +69,12 @@ determine when a key is to be published, whether it should be used for signing a zone, etc.

-

+

If none of these options is set on the command line, then dnssec-settime simply prints the key timing metadata already stored in the key.

-

+

When key metadata fields are changed, both files of a key pair (Knnnn.+aaa+iiiii.key and Knnnn.+aaa+iiiii.private) are regenerated. @@ -55,12 +83,16 @@ file. The private file's permissions are always set to be inaccessible to anyone other than the owner (mode 0600).

-
-
+
+ +

OPTIONS

-
+ + +
-f
-

+

+

Force an update of an old-format key with no metadata fields. Without this option, dnssec-settime will fail when attempting to update a legacy key. With this option, @@ -69,13 +101,17 @@ set to the present time. If no other values are specified, then the key's publication and activation dates will also be set to the present time. -

+

+
-K directory
-

+

+

Sets the directory in which the key files are to reside. -

+

+
-L ttl
-

+

+

Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was @@ -84,25 +120,32 @@ is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to 0 or none removes it from the key. -

+

+
-h
-

+

+

Emit usage message and exit. -

+

+
-V
-

+

+

Prints version information. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -110,12 +153,14 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-
-
+
+ +

TIMING OPTIONS

-

+ +

Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as an offset from the present time. For convenience, if such an offset @@ -125,39 +170,51 @@ days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To unset a date, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. -

+

+
-A date/offset
-

+

+

Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. -

+

+
-R date/offset
-

+

+

Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it. -

+

+
-I date/offset
-

+

+

Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it. -

+

+
-D date/offset
-

+

+

Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) -

+

+
-S predecessor key
-

+

+

Select a key for which the key being modified will be an explicit successor. The name, algorithm, size, and type of the predecessor key must exactly match those of the key being @@ -165,10 +222,11 @@ to the inactivation date of the predecessor. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. -

+

+
-i interval
-

+

Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the @@ -177,34 +235,40 @@ the publication date is specified but activation date isn't, then activation will be set to this much time after publication.

-

+

If the key is being set to be an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero.

-

+

As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.

-
+
-
-
+
+ +

PRINTING OPTIONS

-

+ +

dnssec-settime can also be used to print the timing metadata associated with a key.

-
+ +
-u
-

+

+

Print times in UNIX epoch format. -

+

+
-p C/P/A/R/I/D/all
-

+

+

Print a specific metadata value or set of metadata values. The -p option may be followed by one or more of the following letters to indicate which value or values to print: @@ -215,16 +279,24 @@ I for the inactivation date, or D for the deletion date. To print all of the metadata, use -p all. -

+

+
-
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), - dnssec-signzone(8), + +

+ dnssec-keygen(8) + , + + dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 5011.

-
+
+
diff --git a/bin/dnssec/dnssec-signzone.html b/bin/dnssec/dnssec-signzone.html index b1ff979b28..bdb9c25326 100644 --- a/bin/dnssec/dnssec-signzone.html +++ b/bin/dnssec/dnssec-signzone.html @@ -23,17 +23,71 @@
-
+ + + + + +

Name

-

dnssec-signzone — DNSSEC zone signing tool

+

+ dnssec-signzone + — DNSSEC zone signing tool +

-
+ + + +

Synopsis

-

dnssec-signzone [-a] [-c class] [-d directory] [-D] [-E engine] [-e end-time] [-f output-file] [-g] [-h] [-K directory] [-k key] [-L serial] [-l domain] [-M domain] [-i interval] [-I input-format] [-j jitter] [-N soa-serial-format] [-o origin] [-O output-format] [-P] [-p] [-R] [-r randomdev] [-S] [-s start-time] [-T ttl] [-t] [-u] [-v level] [-V] [-X extended end-time] [-x] [-z] [-3 salt] [-H iterations] [-A] {zonefile} [key...]

-
-
+

+ dnssec-signzone + [-a] + [-c class] + [-d directory] + [-D] + [-E engine] + [-e end-time] + [-f output-file] + [-g] + [-h] + [-K directory] + [-k key] + [-L serial] + [-l domain] + [-M domain] + [-i interval] + [-I input-format] + [-j jitter] + [-N soa-serial-format] + [-o origin] + [-O output-format] + [-P] + [-p] + [-R] + [-r randomdev] + [-S] + [-s start-time] + [-T ttl] + [-t] + [-u] + [-v level] + [-V] + [-X extended end-time] + [-x] + [-z] + [-3 salt] + [-H iterations] + [-A] + {zonefile} + [key...] +

+
+ +

DESCRIPTION

-

dnssec-signzone + +

dnssec-signzone signs a zone. It generates NSEC and RRSIG records and produces a signed version of the zone. The security status of delegations from the signed zone @@ -41,34 +95,46 @@ determined by the presence or absence of a keyset file for each child zone.

-
-
+
+ +

OPTIONS

-
+ + +
-a
-

+

+

Verify all generated signatures. -

+

+
-c class
-

+

+

Specifies the DNS class of the zone. -

+

+
-C
-

+

+

Compatibility mode: Generate a keyset-zonename file in addition to dsset-zonename when signing a zone, for use by older versions of dnssec-signzone. -

+

+
-d directory
-

+

+

Look for dsset- or keyset- files in directory. -

+

+
-D
-

+

+

Output only those record types automatically managed by dnssec-signzone, i.e. RRSIG, NSEC, NSEC3 and NSEC3PARAM records. If smart signing @@ -77,15 +143,16 @@ zone file with $INCLUDE. This option cannot be combined with -O raw, -O map, or serial number updating. -

+

+
-E engine
-

+

When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -93,30 +160,39 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-g
-

+

+

Generate DS records for child zones from dsset- or keyset- file. Existing DS records will be removed. -

+

+
-K directory
-

+

+

Key repository: Specify a directory to search for DNSSEC keys. If not specified, defaults to the current directory. -

+

+
-k key
-

+

+

Treat specified key as a key signing key ignoring any key flags. This option may be specified multiple times. -

+

+
-l domain
-

+

+

Generate a DLV set in addition to the key (DNSKEY) and DS sets. The domain is appended to the name of the records. -

+

+
-M maxttl
-

+

+

Sets the maximum TTL for the signed zone. Any TTL higher than maxttl in the input zone will be reduced to maxttl @@ -129,9 +205,11 @@ max-zone-ttl in named.conf. (Note: This option is incompatible with -D, because it modifies non-DNSSEC data in the output zone.) -

+

+
-s start-time
-

+

+

Specify the date and time when the generated RRSIG records become valid. This can be either an absolute or relative time. An absolute start time is indicated by a number @@ -140,9 +218,11 @@ indicated by +N, which is N seconds from the current time. If no start-time is specified, the current time minus 1 hour (to allow for clock skew) is used. -

+

+
-e end-time
-

+

+

Specify the date and time when the generated RRSIG records expire. As with start-time, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative @@ -152,10 +232,11 @@ specified, 30 days from the start time is used as a default. end-time must be later than start-time. -

+

+
-X extended end-time
-

+

Specify the date and time when the generated RRSIG records for the DNSKEY RRset will expire. This is to be used in cases when the DNSKEY signatures need to persist longer than @@ -163,7 +244,7 @@ of the KSK is kept offline and the KSK signature is to be refreshed manually.

-

+

As with start-time, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative to the start time is indicated with +N, which is N seconds from @@ -174,28 +255,34 @@ 30 days from the start time.) extended end-time must be later than start-time.

-
+
-f output-file
-

+

+

The name of the output file containing the signed zone. The default is to append .signed to the input filename. If output-file is set to "-", then the signed zone is written to the standard output, with a default output format of "full". -

+

+
-h
-

+

+

Prints a short summary of the options and arguments to dnssec-signzone. -

+

+
-V
-

+

+

Prints version information. -

+

+
-i interval
-

+

When a previously-signed zone is passed as input, records may be resigned. The interval option specifies the cycle interval as an offset from the current @@ -203,7 +290,7 @@ cycle interval, it is retained. Otherwise, it is considered to be expiring soon, and it will be replaced.

-

+

The default cycle interval is one quarter of the difference between the signature end and start times. So if neither end-time or start-time @@ -214,9 +301,10 @@ are due to expire in less than 7.5 days, they would be replaced.

-
+
-I input-format
-

+

+

The format of the input zone file. Possible formats are "text" (default), "raw", and "map". @@ -225,10 +313,11 @@ format containing updates can be signed directly. The use of this option does not make much sense for non-dynamic zones. -

+

+
-j jitter
-

+

When signing a zone with a fixed signature lifetime, all RRSIG records issued at the time of signing expires simultaneously. If the zone is incrementally signed, i.e. @@ -239,52 +328,67 @@ expire time, thus spreading incremental signature regeneration over time.

-

+

Signature lifetime jitter also to some extent benefits validators and servers by spreading out cache expiration, i.e. if large numbers of RRSIGs don't expire at the same time from all caches there will be less congestion than if all validators need to refetch at mostly the same time.

-
+
-L serial
-

+

+

When writing a signed zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) -

+

+
-n ncpus
-

+

+

Specifies the number of threads to use. By default, one thread is started for each detected CPU. -

+

+
-N soa-serial-format
-

+

The SOA serial number format of the signed zone. Possible formats are "keep" (default), "increment" and "unixtime".

-
+ +
"keep"
-

Do not modify the SOA serial number.

+
+

Do not modify the SOA serial number.

+
"increment"
-

Increment the SOA serial number using RFC 1982 - arithmetics.

+
+

Increment the SOA serial number using RFC 1982 + arithmetics.

+
"unixtime"
-

Set the SOA serial number to the number of seconds - since epoch.

+
+

Set the SOA serial number to the number of seconds + since epoch.

+
-
+ +
-o origin
-

+

+

The zone origin. If not specified, the name of the zone file is assumed to be the origin. -

+

+
-O output-format
-

+

+

The format of the output file containing the signed zone. Possible formats are "text" (default), which is the standard textual representation of the zone; @@ -297,33 +401,36 @@ the raw zone file: if N is 0, the raw file can be read by any version of named; if N is 1, the file can be read by release 9.9.0 or higher; the default is 1. -

+

+
-p
-

+

+

Use pseudo-random data when signing the zone. This is faster, but less secure, than using real random data. This option may be useful when signing large zones or when the entropy source is limited. -

+

+
-P
-

+

Disable post sign verification tests.

-

+

The post sign verification test ensures that for each algorithm in use there is at least one non revoked self signed KSK key, that all revoked KSK keys are self signed, and that all records in the zone are signed by the algorithm. This option skips these tests.

-
+
-Q
-

+

Remove signatures from keys that are no longer active.

-

+

Normally, when a previously-signed zone is passed as input to the signer, and a DNSKEY record has been removed and replaced with a new one, signatures from the old key @@ -335,22 +442,23 @@ enables ZSK rollover using the procedure described in RFC 4641, section 4.2.1.1 ("Pre-Publish Key Rollover").

-
+
-R
-

+

Remove signatures from keys that are no longer published.

-

+

This option is similar to -Q, except it forces dnssec-signzone to signatures from keys that are no longer published. This enables ZSK rollover using the procedure described in RFC 4641, section 4.2.1.2 ("Double Signature Zone Signing Key Rollover").

-
+
-r randomdev
-

+

+

Specifies the source of randomness. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness @@ -360,53 +468,65 @@ data to be used instead of the default. The special value keyboard indicates that keyboard input should be used. -

+

+
-S
-

+

Smart signing: Instructs dnssec-signzone to search the key repository for keys that match the zone being signed, and to include them in the zone if appropriate.

-

+

When a key is found, its timing metadata is examined to determine how it should be used, according to the following rules. Each successive rule takes priority over the prior ones:

-
+
-

+

+

If no timing metadata has been set for the key, the key is published in the zone and used to sign the zone. -

+

+
-

+

+

If the key's publication date is set and is in the past, the key is published in the zone. -

+

+
-

+

+

If the key's activation date is set and in the past, the key is published (regardless of publication date) and used to sign the zone. -

+

+
-

+

+

If the key's revocation date is set and in the past, and the key is published, then the key is revoked, and the revoked key is used to sign the zone. -

+

+
-

+

+

If either of the key's unpublication or deletion dates are set and in the past, the key is NOT published or used to sign the zone, regardless of any other metadata. -

+

+
- +
-T ttl
-

+

+

Specifies a TTL to be used for new DNSKEY records imported into the zone from the key repository. If not specified, the default is the TTL value from the zone's SOA @@ -418,81 +538,102 @@ them, or if any of the imported DNSKEY records had a default TTL value. In the event of a a conflict between TTL values in imported keys, the shortest one is used. -

+

+
-t
-

+

+

Print statistics at completion. -

+

+
-u
-

+

+

Update NSEC/NSEC3 chain when re-signing a previously signed zone. With this option, a zone signed with NSEC can be switched to NSEC3, or a zone signed with NSEC3 can be switch to NSEC or to NSEC3 with different parameters. Without this option, dnssec-signzone will retain the existing chain when re-signing. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-x
-

+

+

Only sign the DNSKEY RRset with key-signing keys, and omit signatures from zone-signing keys. (This is similar to the dnssec-dnskey-kskonly yes; zone option in named.) -

+

+
-z
-

+

+

Ignore KSK flag on key when determining what to sign. This causes KSK-flagged keys to sign all records, not just the DNSKEY RRset. (This is similar to the update-check-ksk no; zone option in named.) -

+

+
-3 salt
-

+

+

Generate an NSEC3 chain with the given hex encoded salt. A dash (salt) can be used to indicate that no salt is to be used when generating the NSEC3 chain. -

+

+
-H iterations
-

+

+

When generating an NSEC3 chain, use this many iterations. The default is 10. -

+

+
-A
-

+

When generating an NSEC3 chain set the OPTOUT flag on all NSEC3 records and do not generate NSEC3 records for insecure delegations.

-

+

Using this option twice (i.e., -AA) turns the OPTOUT flag off for all records. This is useful when using the -u option to modify an NSEC3 chain which previously had OPTOUT set.

-
+
zonefile
-

+

+

The file containing the zone to be signed. -

+

+
key
-

+

+

Specify which keys should be used to sign the zone. If no keys are specified, then the zone will be examined for DNSKEY records at the zone apex. If these are found and there are matching private keys, in the current directory, then these will be used for signing. -

+

+
-
-
+
+ +

EXAMPLE

-

+ +

The following command signs the example.com zone with the DSA key generated by dnssec-keygen (Kexample.com.+003+17247). Because the -S option @@ -505,13 +646,13 @@ Kexample.com.+003+17247 db.example.com.signed % -

+

In the above example, dnssec-signzone creates the file db.example.com.signed. This file should be referenced in a zone statement in a named.conf file.

-

+

This example re-signs a previously signed zone with default parameters. The private keys are assumed to be in the current directory.

@@ -519,13 +660,18 @@ db.example.com.signed % dnssec-signzone -o example.com db.example.com db.example.com.signed % -
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), + +

+ dnssec-keygen(8) + , BIND 9 Administrator Reference Manual, RFC 4033, RFC 4641.

-
+
+
diff --git a/bin/dnssec/dnssec-verify.html b/bin/dnssec/dnssec-verify.html index a2687577fd..4bd154139d 100644 --- a/bin/dnssec/dnssec-verify.html +++ b/bin/dnssec/dnssec-verify.html @@ -22,35 +22,64 @@
-
+ + + + + +

Name

-

dnssec-verify — DNSSEC zone verification tool

+

+ dnssec-verify + — DNSSEC zone verification tool +

-
+ + + +

Synopsis

-

dnssec-verify [-c class] [-E engine] [-I input-format] [-o origin] [-v level] [-V] [-x] [-z] {zonefile}

-
-
+

+ dnssec-verify + [-c class] + [-E engine] + [-I input-format] + [-o origin] + [-v level] + [-V] + [-x] + [-z] + {zonefile} +

+
+ +

DESCRIPTION

-

dnssec-verify + +

dnssec-verify verifies that a zone is fully signed for each algorithm found in the DNSKEY RRset for the zone, and that the NSEC / NSEC3 chains are complete.

-
-
+
+ +

OPTIONS

-
+ + +
-c class
-

+

+

Specifies the DNS class of the zone. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -58,9 +87,10 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-I input-format
-

+

+

The format of the input zone file. Possible formats are "text" (default) and "raw". @@ -69,32 +99,41 @@ format containing updates can be verified independently. The use of this option does not make much sense for non-dynamic zones. -

+

+
-o origin
-

+

+

The zone origin. If not specified, the name of the zone file is assumed to be the origin. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-x
-

+

+

Only verify that the DNSKEY RRset is signed with key-signing keys. Without this flag, it is assumed that the DNSKEY RRset will be signed by all active keys. When this flag is set, it will not be an error if the DNSKEY RRset is not signed by zone-signing keys. This corresponds to the -x option in dnssec-signzone. -

+

+
-z
-

+

Ignore the KSK flag on the keys when determining whether the zone if correctly signed. Without this flag it is assumed that there will be a non-revoked, self-signed @@ -102,7 +141,7 @@ that RRsets other than DNSKEY RRset will be signed with a different DNSKEY without the KSK flag set.

-

+

With this flag set, we only require that for each algorithm, there will be at least one non-revoked, self-signed DNSKEY, regardless of the KSK flag state, and that other RRsets @@ -111,20 +150,27 @@ for both purposes. This corresponds to the -z option in dnssec-signzone.

-
+
zonefile
-

+

+

The file containing the zone to be signed. -

+

+
-
-
+
+ +

SEE ALSO

-

- dnssec-signzone(8), + +

+ + dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 4033.

-
+
+
diff --git a/bin/named/lwresd.html b/bin/named/lwresd.html index f394ceecc7..8b42339836 100644 --- a/bin/named/lwresd.html +++ b/bin/named/lwresd.html @@ -23,24 +23,57 @@
-
+ + + + + +

Name

-

lwresd — lightweight resolver daemon

+

+ lwresd + — lightweight resolver daemon +

-
+ + + +

Synopsis

-

lwresd [-c config-file] [-C config-file] [-d debug-level] [-f] [-g] [-i pid-file] [-m flag] [-n #cpus] [-P port] [-p port] [-s] [-t directory] [-u user] [-v] [-4] [-6]

-
-
+

+ lwresd + [-c config-file] + [-C config-file] + [-d debug-level] + [-f] + [-g] + [-i pid-file] + [-m flag] + [-n #cpus] + [-P port] + [-p port] + [-s] + [-t directory] + [-u user] + [-v] + [-4] + [-6] +

+
+ +

DESCRIPTION

-

lwresd + + +

lwresd is the daemon providing name lookup services to clients that use the BIND 9 lightweight resolver library. It is essentially a stripped-down, caching-only name server that answers queries using the BIND 9 lightweight resolver protocol rather than the DNS protocol.

-

lwresd + +

lwresd listens for resolver queries on a UDP port on the IPv4 loopback interface, 127.0.0.1. This means that lwresd can only be used by @@ -48,14 +81,14 @@ number 921 is used for lightweight resolver requests and responses.

-

+

Incoming lightweight resolver requests are decoded by the server which then resolves them using the DNS protocol. When the DNS lookup completes, lwresd encodes the answers in the lightweight resolver format and returns them to the client that made the request.

-

+

If /etc/resolv.conf contains any nameserver entries, lwresd sends recursive DNS queries to those servers. This is similar @@ -65,60 +98,80 @@ queries autonomously starting at the root name servers, using a built-in list of root server hints.

-
-
+
+ +

OPTIONS

-
+ + +
-4
-

+

+

Use IPv4 only even if the host machine is capable of IPv6. -4 and -6 are mutually exclusive. -

+

+
-6
-

+

+

Use IPv6 only even if the host machine is capable of IPv4. -4 and -6 are mutually exclusive. -

+

+
-c config-file
-

+

+

Use config-file as the configuration file instead of the default, /etc/lwresd.conf. -c can not be used with -C. -

+

+
-C config-file
-

+

+

Use config-file as the configuration file instead of the default, /etc/resolv.conf. -C can not be used with -c. -

+

+
-d debug-level
-

+

+

Set the daemon's debug level to debug-level. Debugging traces from lwresd become more verbose as the debug level increases. -

+

+
-f
-

+

+

Run the server in the foreground (i.e. do not daemonize). -

+

+
-g
-

+

+

Run the server in the foreground and force all logging to stderr. -

+

+
-i pid-file
-

+

+

Use pid-file as the PID file instead of the default, /var/run/lwresd/lwresd.pid. -

+

+
-m flag
-

+

+

Turn on memory usage debugging flags. Possible flags are usage, trace, @@ -127,54 +180,61 @@ mctx. These correspond to the ISC_MEM_DEBUGXXXX flags described in <isc/mem.h>. -

+

+
-n #cpus
-

+

+

Create #cpus worker threads to take advantage of multiple CPUs. If not specified, lwresd will try to determine the number of CPUs present and create one thread per CPU. If it is unable to determine the number of CPUs, a single worker thread will be created. -

+

+
-P port
-

+

+

Listen for lightweight resolver queries on port port. If not specified, the default is port 921. -

+

+
-p port
-

+

+

Send DNS lookups to port port. If not specified, the default is port 53. This provides a way of testing the lightweight resolver daemon with a name server that listens for queries on a non-standard port number. -

+

+
-s
-

+

Write memory usage statistics to stdout on exit.

-
+

Note

-

+

This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.

-
-
+
+
-t directory
-

Chroot +

Chroot to directory after processing the command line arguments, but before reading the configuration file.

-
+

Warning

-

+

This option should be used in conjunction with the -u option, as chrooting a process running as root doesn't enhance security on most @@ -182,39 +242,61 @@ defined allows a process with root privileges to escape a chroot jail.

-
-
+
+
-u user
-

Setuid +

+

Setuid to user after completing privileged operations, such as creating sockets that listen on privileged ports. -

+

+
-v
-

+

+

Report the version number and exit. -

+

+
-
-
+ +
+ +

FILES

-
+ + +
/etc/resolv.conf
-

+

+

The default configuration file. -

+

+
/var/run/lwresd.pid
-

+

+

The default process-id file. -

+

+
-
-
+ +
+ +

SEE ALSO

-

named(8), - lwres(3), - resolver(5). + +

+ named(8) + , + + lwres(3) + , + + resolver(5) + .

-
+
+
diff --git a/bin/named/named.conf.html b/bin/named/named.conf.html index fc0dbf7dcc..e01a9b11bc 100644 --- a/bin/named/named.conf.html +++ b/bin/named/named.conf.html @@ -22,61 +22,84 @@
-
+ + + + + +

Name

-

named.conf — configuration file for named

+

+ named.conf + — configuration file for named +

-
+ + + +

Synopsis

-

named.conf

-
-
+

+ named.conf +

+
+ +

DESCRIPTION

-

named.conf is the configuration file + +

named.conf is the configuration file for named. Statements are enclosed in braces and terminated with a semi-colon. Clauses in the statements are also semi-colon terminated. The usual comment styles are supported:

-

+

C style: /* */

-

+

C++ style: // to end of line

-

+

Unix style: # to end of line

-
-
+
+ +

ACL

-


+ +


acl string { address_match_element; ... };

-
-
+
+ +

KEY

-


+ +


key domain_name {
algorithm string;
secret string;
};

-
-
+
+ +

MASTERS

-


+ +


masters string [ port integer ] {
( masters | ipv4_address [port integer] |
ipv6_address [port integer] ) [ key string ]; ...
};

-
-
+
+ +

SERVER

-


+ +


server ( ipv4_address[/prefixlen] | ipv6_address[/prefixlen] ) {
bogus boolean;
edns boolean;
@@ -96,26 +119,32 @@ server support-ixfr boolean; // obsolete
};

-
-
+
+ +

TRUSTED-KEYS

-


+ +


trusted-keys {
domain_name flags protocol algorithm key; ...
};

-
-
+
+ +

MANAGED-KEYS

-


+ +


managed-keys {
domain_name initial-key flags protocol algorithm key; ...
};

-
-
+
+ +

CONTROLS

-


+ +


controls {
inet ( ipv4_address | ipv6_address | * )
[ port ( integer | * ) ]
@@ -124,10 +153,12 @@ controls unix unsupported; // not implemented
};

-
-
+
+ +

LOGGING

-


+ +


logging {
channel string {
file log_file;
@@ -142,10 +173,12 @@ logging category string { string; ... };
};

-
-
+
+ +

LWRES

-


+ +


lwres {
listen-on [ port integer ] {
( ipv4_address | ipv6_address ) [ port integer ]; ...
@@ -155,10 +188,12 @@ lwres ndots integer;
};

-
-
+
+ +

OPTIONS

-


+ +


options {
avoid-v4-udp-ports { port; ... };
avoid-v6-udp-ports { port; ... };
@@ -364,10 +399,12 @@ options use-ixfr boolean; // obsolete
};

-
-
+
+ +

VIEW

-


+ +


view string optional_class {
match-clients { address_match_element; ... };
match-destinations { address_match_element; ... };
@@ -535,10 +572,12 @@ view max-ixfr-log-size size; // obsolete
};

-
-
+
+ +

ZONE

-


+ +


zone string optional_class {
type ( master | slave | stub | hint | redirect |
forward | delegation-only );
@@ -633,19 +672,30 @@ zone pubkey integer integer integer quoted_string; // obsolete
};

-
-
+
+ +

FILES

-

/etc/named.conf + +

/etc/named.conf

-
-
+
+ +

SEE ALSO

-

named(8), - named-checkconf(8), - rndc(8), + +

+ named(8) + , + + named-checkconf(8) + , + + rndc(8) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/bin/named/named.html b/bin/named/named.html index 3071548b2f..4dbbe95bca 100644 --- a/bin/named/named.html +++ b/bin/named/named.html @@ -23,46 +23,89 @@
-
+ + + + + +

Name

-

named — Internet domain name server

+

+ named + — Internet domain name server +

-
+ + + +

Synopsis

-

named [-4] [-6] [-c config-file] [-d debug-level] [-D string] [-E engine-name] [-f] [-g] [-M option] [-m flag] [-n #cpus] [-p port] [-s] [-S #max-socks] [-t directory] [-U #listeners] [-u user] [-v] [-V] [-x cache-file]

-
-
+

+ named + [-4] + [-6] + [-c config-file] + [-d debug-level] + [-D string] + [-E engine-name] + [-f] + [-g] + [-M option] + [-m flag] + [-n #cpus] + [-p port] + [-s] + [-S #max-socks] + [-t directory] + [-U #listeners] + [-u user] + [-v] + [-V] + [-x cache-file] +

+
+ +

DESCRIPTION

-

named + +

named is a Domain Name System (DNS) server, part of the BIND 9 distribution from ISC. For more information on the DNS, see RFCs 1033, 1034, and 1035.

-

+

When invoked without arguments, named will read the default configuration file /etc/named.conf, read any initial data, and listen for queries.

-
-
+
+ +

OPTIONS

-
+ + +
-4
-

+

+

Use IPv4 only even if the host machine is capable of IPv6. -4 and -6 are mutually exclusive. -

+

+
-6
-

+

+

Use IPv6 only even if the host machine is capable of IPv4. -4 and -6 are mutually exclusive. -

+

+
-c config-file
-

+

+

Use config-file as the configuration file instead of the default, /etc/named.conf. To @@ -72,28 +115,33 @@ directory option in the configuration file, config-file should be an absolute pathname. -

+

+
-d debug-level
-

+

+

Set the daemon's debug level to debug-level. Debugging traces from named become more verbose as the debug level increases. -

+

+
-D string
-

+

+

Specifies a string that is used to identify a instance of named in a process listing. The contents of string are not examined. -

+

+
-E engine-name
-

+

When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -101,26 +149,33 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-f
-

+

+

Run the server in the foreground (i.e. do not daemonize). -

+

+
-g
-

+

+

Run the server in the foreground and force all logging to stderr. -

+

+
-M option
-

+

+

Sets the default memory context options. Currently the only supported option is external, which causes the internal memory manager to be bypassed in favor of system-provided memory allocation functions. -

+

+
-m flag
-

+

+

Turn on memory usage debugging flags. Possible flags are usage, trace, @@ -129,46 +184,51 @@ mctx. These correspond to the ISC_MEM_DEBUGXXXX flags described in <isc/mem.h>. -

+

+
-n #cpus
-

+

+

Create #cpus worker threads to take advantage of multiple CPUs. If not specified, named will try to determine the number of CPUs present and create one thread per CPU. If it is unable to determine the number of CPUs, a single worker thread will be created. -

+

+
-p port
-

+

+

Listen for queries on port port. If not specified, the default is port 53. -

+

+
-s
-

+

Write memory usage statistics to stdout on exit.

-
+

Note

-

+

This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.

-
-
+
+
-S #max-socks
-

+

Allow named to use up to #max-socks sockets. The default value is 4096 on systems built with default configuration options, and 21000 on systems built with "configure --with-tuning=large".

-
+

Warning

-

+

This option should be unnecessary for the vast majority of users. The use of this option could even be harmful because the @@ -183,18 +243,18 @@ named reserves some file descriptors for its internal use.

-
-
+
+
-t directory
-

Chroot +

Chroot to directory after processing the command line arguments, but before reading the configuration file.

-
+

Warning

-

+

This option should be used in conjunction with the -u option, as chrooting a process running as root doesn't enhance security on most @@ -202,10 +262,11 @@ defined allows a process with root privileges to escape a chroot jail.

-
-
+
+
-U #listeners
-

+

+

Use #listeners worker threads to listen for incoming UDP packets on each address. If not specified, named will @@ -218,17 +279,18 @@ be increased as high as that value, but no higher. On Windows, the number of UDP listeners is hardwired to 1 and this option has no effect. -

+

+
-u user
-

Setuid +

Setuid to user after completing privileged operations, such as creating sockets that listen on privileged ports.

-
+

Note

-

+

On Linux, named uses the kernel's capability mechanism to drop all root privileges except the ability to bind(2) to @@ -241,63 +303,80 @@ later, since previous kernels did not allow privileges to be retained after setuid(2).

-
-
+
+
-v
-

+

+

Report the version number and exit. -

+

+
-V
-

+

+

Report the version number and build options, and exit. -

+

+
-x cache-file
-

+

Load data from cache-file into the cache of the default view.

-
+

Warning

-

+

This option must not be used. It is only of interest to BIND 9 developers and may be removed or changed in a future release.

-
-
+
+
-
-
+ +
+ +

SIGNALS

-

+ +

In routine operation, signals should not be used to control the nameserver; rndc should be used instead.

-
+ +
SIGHUP
-

+

+

Force a reload of the server. -

+

+
SIGINT, SIGTERM
-

+

+

Shut down the server. -

+

+
-

+ +

The result of sending any other signals to the server is undefined.

-
-
+ +
+ +

CONFIGURATION

-

+ +

The named configuration file is too complex to describe in detail here. A complete description is provided in the BIND 9 Administrator Reference Manual.

-

+ +

named inherits the umask (file creation mode mask) from the parent process. If files created by named, such as journal files, @@ -305,32 +384,59 @@ should be set explicitly in the script used to start the named process.

-
-
+ +
+ +

FILES

-
+ + +
/etc/named.conf
-

+

+

The default configuration file. -

+

+
/var/run/named/named.pid
-

+

+

The default process-id file. -

+

+
-
-
+ +
+ +

SEE ALSO

-

RFC 1033, + +

RFC 1033, RFC 1034, RFC 1035, - named-checkconf(8), - named-checkzone(8), - rndc(8), - lwresd(8), - named.conf(5), + + named-checkconf + (8) + , + + named-checkzone + (8) + , + + rndc + (8) + , + + lwresd + (8) + , + + named.conf + (5) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/bin/nsupdate/nsupdate.html b/bin/nsupdate/nsupdate.html index ef9dd6103f..f13b2e91be 100644 --- a/bin/nsupdate/nsupdate.html +++ b/bin/nsupdate/nsupdate.html @@ -23,17 +23,49 @@
-
+ + + +

Name

-

nsupdate — Dynamic DNS update utility

+

+ nsupdate + — Dynamic DNS update utility +

-
+ + + +

Synopsis

-

nsupdate [-d] [-D] [-L level] [[-g] | [-o] | [-l] | [-y [hmac:]keyname:secret] | [-k keyfile]] [-t timeout] [-u udptimeout] [-r udpretries] [-R randomdev] [-v] [-T] [-P] [-V] [filename]

-
-
+

+ nsupdate + [-d] + [-D] + [-L level] + [ + [-g] + | [-o] + | [-l] + | [-y [hmac:]keyname:secret] + | [-k keyfile] + ] + [-t timeout] + [-u udptimeout] + [-r udpretries] + [-R randomdev] + [-v] + [-T] + [-P] + [-V] + [filename] +

+
+ +

DESCRIPTION

-

nsupdate + +

nsupdate is used to submit Dynamic DNS Update requests as defined in RFC 2136 to a name server. This allows resource records to be added or removed from a zone @@ -42,27 +74,27 @@ one resource record.

-

+

Zones that are under dynamic control via nsupdate or a DHCP server should not be edited by hand. Manual edits could conflict with dynamic updates and cause data to be lost.

-

+

The resource records that are dynamically added or removed with nsupdate have to be in the same zone. Requests are sent to the zone's master server. This is identified by the MNAME field of the zone's SOA record.

-

+

Transaction signatures can be used to authenticate the Dynamic DNS updates. These use the TSIG resource record type described in RFC 2845 or the SIG(0) record described in RFC 2535 and RFC 2931 or GSS-TSIG as described in RFC 3645.

-

+

TSIG relies on a shared secret that should only be known to nsupdate and the name server. @@ -77,33 +109,41 @@ uses the -y or -k options to provide the TSIG shared secret. These options are mutually exclusive.

-

+

SIG(0) uses public key cryptography. To use a SIG(0) key, the public key must be stored in a KEY record in a zone served by the name server.

-

+

GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode is switched on with the -g flag. A non-standards-compliant variant of GSS-TSIG used by Windows 2000 can be switched on with the -o flag.

-
-
+
+ +

OPTIONS

-
+ + +
-d
-

+

+

Debug mode. This provides tracing information about the update requests that are made and the replies received from the name server. -

+

+
-D
-

+

+

Extra debug mode. -

+

+
-k keyfile
-

+

+

The file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing a named.conf-format key @@ -115,9 +155,11 @@ The -k may also be used to specify a SIG(0) key used to authenticate Dynamic DNS update requests. In this case, the key specified is not an HMAC-MD5 key. -

+

+
-l
-

+

+

Local-host only mode. This sets the server address to localhost (disabling the server so that the server address cannot be overridden). Connections to the local server will @@ -126,30 +168,40 @@ local master zone has set update-policy to local. The location of this key file can be overridden with the -k option. -

+

+
-L level
-

+

+

Set the logging debug level. If zero, logging is disabled. -

+

+
-p port
-

+

+

Set the port to use for connections to a name server. The default is 53. -

+

+
-P
-

+

+

Print the list of private BIND-specific resource record types whose format is understood by nsupdate. See also the -T option. -

+

+
-r udpretries
-

+

+

The number of UDP retries. The default is 3. If zero, only one update request will be made. -

+

+
-R randomdev
-

+

+

Where to obtain randomness. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness is keyboard @@ -158,51 +210,60 @@ instead of the default. The special value keyboard indicates that keyboard input should be used. This option may be specified multiple times. -

+

+
-t timeout
-

+

+

The maximum time an update request can take before it is aborted. The default is 300 seconds. Zero can be used to disable the timeout. -

+

+
-T
-

+

Print the list of IANA standard resource record types whose format is understood by nsupdate. nsupdate will exit after the lists are printed. The -T option can be combined with the -P option.

-

+

Other types can be entered using "TYPEXXXXX" where "XXXXX" is the decimal value of the type with no leading zeros. The rdata, if present, will be parsed using the UNKNOWN rdata format, (<backslash> <hash> <space> <length> <space> <hexstring>).

-
+
-u udptimeout
-

+

+

The UDP retry interval. The default is 3 seconds. If zero, the interval will be computed from the timeout interval and number of UDP retries. -

+

+
-v
-

+

+

Use TCP even for small update requests. By default, nsupdate uses UDP to send update requests to the name server unless they are too large to fit in a UDP request in which case TCP will be used. TCP may be preferable when a batch of update requests is made. -

+

+
-V
-

+

+

Print the version number and exit. -

+

+
-y [hmac:]keyname:secret
-

+

Literal TSIG authentication key. keyname is the name of the key, and secret is the base64 encoded shared secret. @@ -214,19 +275,23 @@ is not specified, the default is hmac-md5 or if MD5 was disabled hmac-sha256.

-

+

NOTE: Use of the -y option is discouraged because the shared secret is supplied as a command line argument in clear text. This may be visible in the output from - ps(1) + + ps(1) + or in a history file maintained by the user's shell.

-
+
-
-
+
+ +

INPUT FORMAT

-

nsupdate + +

nsupdate reads input from filename or standard input. @@ -240,7 +305,7 @@ Updates will be rejected if the tests for the prerequisite conditions fail.

-

+

Every update request consists of zero or more prerequisites and zero or more updates. This allows a suitably authenticated update request to proceed if some @@ -250,7 +315,7 @@ accumulated commands to be sent as one Dynamic DNS update request to the name server.

-

+

The command formats and their meaning are as follows:

@@ -259,7 +324,8 @@ {servername} [port] -

+

+

Sends all dynamic update requests to the name server servername. When no server statement is provided, @@ -275,13 +341,15 @@ If no port number is specified, the default DNS port number of 53 is used. -

+

+
local {address} [port]
-

+

+

Sends all dynamic update requests using the local address. @@ -293,12 +361,14 @@ can additionally be used to make requests come from a specific port. If no port number is specified, the system will assign one. -

+

+
zone {zonename}
-

+

+

Specifies that all updates are to be made to the zone zonename. If no @@ -307,32 +377,38 @@ nsupdate will attempt determine the correct zone to update based on the rest of the input. -

+

+
class {classname}
-

+

+

Specify the default class. If no class is specified, the default class is IN. -

+

+
ttl {seconds}
-

+

+

Specify the default time to live for records to be added. The value none will clear the default ttl. -

+

+
key [hmac:] {keyname} {secret}
-

+

+

Specifies that all updates are to be TSIG-signed using the keyname secret pair. If hmac is specified, then it sets the @@ -341,55 +417,67 @@ hmac-sha256. The key command overrides any key specified on the command line via -y or -k. -

+

+
gsstsig
-

+

+

Use GSS-TSIG to sign the updated. This is equivalent to specifying -g on the commandline. -

+

+
oldgsstsig
-

+

+

Use the Windows 2000 version of GSS-TSIG to sign the updated. This is equivalent to specifying -o on the commandline. -

+

+
realm {[realm_name]}
-

+

+

When using GSS-TSIG use realm_name rather than the default realm in krb5.conf. If no realm is specified the saved realm is cleared. -

+

+
[prereq] nxdomain {domain-name}
-

+

+

Requires that no resource record of any type exists with name domain-name. -

+

+
[prereq] yxdomain {domain-name}
-

+

+

Requires that domain-name exists (has as at least one resource record, of any type). -

+

+
[prereq] nxrrset {domain-name} [class] {type}
-

+

+

Requires that no resource record exists of the specified type, class @@ -398,14 +486,16 @@ If class is omitted, IN (internet) is assumed. -

+

+
[prereq] yxrrset {domain-name} [class] {type}
-

+

+

This requires that a resource record of the specified type, class @@ -415,7 +505,8 @@ If class is omitted, IN (internet) is assumed. -

+

+
[prereq] yxrrset {domain-name} @@ -423,7 +514,8 @@ {type} {data...}
-

+

+

The data from each set of prerequisites of this form @@ -444,7 +536,8 @@ are written in the standard text representation of the resource record's RDATA. -

+

+
[update] del[ete] {domain-name} @@ -452,7 +545,8 @@ [class] [type [data...]]
-

+

+

Deletes any resource records named domain-name. If @@ -465,7 +559,8 @@ is not supplied. The ttl is ignored, and is only allowed for compatibility. -

+

+
[update] add {domain-name} @@ -474,62 +569,80 @@ {type} {data...}
-

+

+

Adds a new resource record with the specified ttl, class and data. -

+

+
show
-

+

+

Displays the current message, containing all of the prerequisites and updates specified since the last send. -

+

+
send
-

+

+

Sends the current message. This is equivalent to entering a blank line. -

+

+
answer
-

+

+

Displays the answer. -

+

+
debug
-

+

+

Turn on debugging. -

+

+
version
-

+

+

Print version number. -

+

+
help
-

+

+

Print a list of commands. -

+

+

-

+ +

Lines beginning with a semicolon are comments and are ignored.

-
-
+ +
+ +

EXAMPLES

-

+ +

The examples below show how nsupdate could be used to insert and delete resource records from the @@ -550,7 +663,7 @@

-

+

Any A records for oldhost.example.com are deleted. @@ -567,7 +680,7 @@

-

+

The prerequisite condition gets the name server to check that there are no resource records of any type for nickname.example.com. @@ -580,33 +693,50 @@ (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have RRSIG, DNSKEY and NSEC records.)

-
-
+
+ +

FILES

-
+ + +
/etc/resolv.conf
-

+

+

used to identify default name server -

+

+
/var/run/named/session.key
-

+

+

sets the default TSIG key for use in local-only mode -

+

+
K{name}.+157.+{random}.key
-

+

+

base-64 encoding of HMAC-MD5 key created by - dnssec-keygen(8). -

+ + dnssec-keygen(8) + . +

+
K{name}.+157.+{random}.private
-

+

+

base-64 encoding of HMAC-MD5 key created by - dnssec-keygen(8). -

+ + dnssec-keygen(8) + . +

+
-
-
+
+ +

SEE ALSO

-

+ +

RFC 2136, RFC 3007, RFC 2104, @@ -614,19 +744,27 @@ RFC 1034, RFC 2535, RFC 2931, - named(8), - ddns-confgen(8), - dnssec-keygen(8). + + named(8) + , + + ddns-confgen(8) + , + + dnssec-keygen(8) + .

-
-
+
+ +

BUGS

-

+ +

The TSIG key is redundantly stored in two separate files. This is a consequence of nsupdate using the DST library for its cryptographic operations, and may change in future releases.

-
+
diff --git a/bin/pkcs11/pkcs11-destroy.html b/bin/pkcs11/pkcs11-destroy.html index 332803fc92..65346d9bec 100644 --- a/bin/pkcs11/pkcs11-destroy.html +++ b/bin/pkcs11/pkcs11-destroy.html @@ -22,69 +22,115 @@
-
+ + + + + +

Name

-

pkcs11-destroy — destroy PKCS#11 objects

-
-
-

Synopsis

-

pkcs11-destroy [-m module] [-s slot] { -i ID | -l label } [-p PIN] [-w seconds]

-
-
-

DESCRIPTION

+ pkcs11-destroy + — destroy PKCS#11 objects +

+
+ + + +
+

Synopsis

+

+ pkcs11-destroy + [-m module] + [-s slot] + { + -i ID + | -l label + } + [-p PIN] + [-w seconds] +

+
+ +
+

DESCRIPTION

+ +

pkcs11-destroy destroys keys stored in a PKCS#11 device, identified by their ID or label.

-

+

Matching keys are displayed before being destroyed. By default, there is a five second delay to allow the user to interrupt the process before the destruction takes place.

-
-
+
+ +

ARGUMENTS

-
+ +
-m module
-

+

+

Specify the PKCS#11 provider module. This must be the full path to a shared library object implementing the PKCS#11 API for the device. -

+

+
-s slot
-

+

+

Open the session with the given PKCS#11 slot. The default is slot 0. -

+

+
-i ID
-

+

+

Destroy keys with the given object ID. -

+

+
-l label
-

+

+

Destroy keys with the given label. -

+

+
-p PIN
-

+

+

Specify the PIN for the device. If no PIN is provided on the command line, pkcs11-destroy will prompt for it. -

+

+
-w seconds
-

+

+

Specify how long to pause before carrying out key destruction. The default is five seconds. If set to 0, destruction will be immediate. -

+

+
-
-
+
+ +

SEE ALSO

-

- pkcs11-keygen(8), - pkcs11-list(8), - pkcs11-tokens(8) + +

+ + pkcs11-keygen(8) + , + + pkcs11-list(8) + , + + pkcs11-tokens(8) +

-
+
+
diff --git a/bin/pkcs11/pkcs11-keygen.html b/bin/pkcs11/pkcs11-keygen.html index cc6c239067..eaaa421905 100644 --- a/bin/pkcs11/pkcs11-keygen.html +++ b/bin/pkcs11/pkcs11-keygen.html @@ -22,93 +22,152 @@
-
+ + + + + +

Name

-

pkcs11-keygen — generate keys on a PKCS#11 device

-
-
-

Synopsis

-

pkcs11-keygen {-a algorithm} [-b keysize] [-e] [-i id] [-m module] [-P] [-p PIN] [-q] [-S] [-s slot] {label}

-
-
-

DESCRIPTION

+ pkcs11-keygen + — generate keys on a PKCS#11 device +

+
+ + + +
+

Synopsis

+

+ pkcs11-keygen + {-a algorithm} + [-b keysize] + [-e] + [-i id] + [-m module] + [-P] + [-p PIN] + [-q] + [-S] + [-s slot] + {label} +

+
+ +
+

DESCRIPTION

+ +

pkcs11-keygen causes a PKCS#11 device to generate a new key pair with the given label (which must be unique) and with keysize bits of prime.

-
-
+
+ +

ARGUMENTS

-
+ +
-a algorithm
-

+

+

Specify the key algorithm class: Supported classes are RSA, DSA, DH, and ECC. In addition to these strings, the algorithm can be specified as a DNSSEC signing algorithm that will be used with this key; for example, NSEC3RSASHA1 maps to RSA, and ECDSAP256SHA256 maps to ECC. The default class is "RSA". -

+

+
-b keysize
-

+

+

Create the key pair with keysize bits of prime. For ECC keys, the only valid values are 256 and 384, and the default is 256. -

+

+
-e
-

+

+

For RSA keys only, use a large exponent. -

+

+
-i id
-

+

+

Create key objects with id. The id is either an unsigned short 2 byte or an unsigned long 4 byte number. -

+

+
-m module
-

+

+

Specify the PKCS#11 provider module. This must be the full path to a shared library object implementing the PKCS#11 API for the device. -

+

+
-P
-

+

+

Set the new private key to be non-sensitive and extractable. The allows the private key data to be read from the PKCS#11 device. The default is for private keys to be sensitive and non-extractable. -

+

+
-p PIN
-

+

+

Specify the PIN for the device. If no PIN is provided on the command line, pkcs11-keygen will prompt for it. -

+

+
-q
-

+

+

Quiet mode: suppress unnecessary output. -

+

+
-S
-

+

+

For Diffie-Hellman (DH) keys only, use a special prime of 768, 1024 or 1536 bit size and base (aka generator) 2. If not specified, bit size will default to 1024. -

+

+
-s slot
-

+

+

Open the session with the given PKCS#11 slot. The default is slot 0. -

+

+
-
-
+
+ +

SEE ALSO

-

- pkcs11-destroy(8), - pkcs11-list(8), - pkcs11-tokens(8), - dnssec-keyfromlabel(8) + +

+ + pkcs11-destroy(8) + , + + pkcs11-list(8) + , + + pkcs11-tokens(8) + , + + dnssec-keyfromlabel(8) +

-
+
+
diff --git a/bin/pkcs11/pkcs11-list.html b/bin/pkcs11/pkcs11-list.html index 8d5dd0d740..85fb5ba0ce 100644 --- a/bin/pkcs11/pkcs11-list.html +++ b/bin/pkcs11/pkcs11-list.html @@ -22,63 +22,107 @@
-
+ + + + + +

Name

-

pkcs11-list — list PKCS#11 objects

-
-
-

Synopsis

-

pkcs11-list [-P] [-m module] [-s slot] [-i ID] [-l label] [-p PIN]

-
-
-

DESCRIPTION

+ pkcs11-list + — list PKCS#11 objects +

+
+ + + +
+

Synopsis

+

+ pkcs11-list + [-P] + [-m module] + [-s slot] + [-i ID] + [-l label] + [-p PIN] +

+
+ +
+

DESCRIPTION

+ +

pkcs11-list lists the PKCS#11 objects with ID or label or by default all objects.

-
-
+
+ +

ARGUMENTS

-
+ +
-P
-

+

+

List only the public objects. (Note that on some PKCS#11 devices, all objects are private.) -

+

+
-m module
-

+

+

Specify the PKCS#11 provider module. This must be the full path to a shared library object implementing the PKCS#11 API for the device. -

+

+
-s slot
-

+

+

Open the session with the given PKCS#11 slot. The default is slot 0. -

+

+
-i ID
-

+

+

List only key objects with the given object ID. -

+

+
-l label
-

+

+

List only key objects with the given label. -

+

+
-p PIN
-

+

+

Specify the PIN for the device. If no PIN is provided on the command line, pkcs11-list will prompt for it. -

+

+
-
-
+
+ +

SEE ALSO

-

- pkcs11-destroy(8), - pkcs11-keygen(8), - pkcs11-tokens(8) + +

+ + pkcs11-destroy(8) + , + + pkcs11-keygen(8) + , + + pkcs11-tokens(8) +

-
+
+
diff --git a/bin/pkcs11/pkcs11-tokens.html b/bin/pkcs11/pkcs11-tokens.html index 59e3d4711f..15a96fbbc6 100644 --- a/bin/pkcs11/pkcs11-tokens.html +++ b/bin/pkcs11/pkcs11-tokens.html @@ -22,44 +22,76 @@
-
+ + + + + +

Name

-

pkcs11-tokens — list PKCS#11 available tokens

-
-
-

Synopsis

-

pkcs11-tokens [-m module] [-v]

-
-
-

DESCRIPTION

+ pkcs11-tokens + — list PKCS#11 available tokens +

+
+ + + +
+

Synopsis

+

+ pkcs11-tokens + [-m module] + [-v] +

+
+ +
+

DESCRIPTION

+ +

pkcs11-tokens lists the PKCS#11 available tokens with defaults from the slot/token scan performed at application initialization.

-
-
+
+ +

ARGUMENTS

-
+ +
-m module
-

+

+

Specify the PKCS#11 provider module. This must be the full path to a shared library object implementing the PKCS#11 API for the device. -

+

+
-v
-

+

+

Make the PKCS#11 libisc initialization verbose. -

+

+
-
-
+
+ +

SEE ALSO

-

- pkcs11-destroy(8), - pkcs11-keygen(8), - pkcs11-list(8) + +

+ + pkcs11-destroy(8) + , + + pkcs11-keygen(8) + , + + pkcs11-list(8) +

-
+
+
diff --git a/bin/python/dnssec-checkds.html b/bin/python/dnssec-checkds.html index acc8cf6543..15a9099dcc 100644 --- a/bin/python/dnssec-checkds.html +++ b/bin/python/dnssec-checkds.html @@ -22,58 +22,105 @@
-
+ + + + + +

Name

-

dnssec-checkds — DNSSEC delegation consistency checking tool

+

+ dnssec-checkds + — DNSSEC delegation consistency checking tool +

-
+ + + +

Synopsis

-

dnssec-checkds [-l domain] [-f file] [-d dig path] [-D dsfromkey path] {zone}

-

dnssec-dsfromkey [-l domain] [-f file] [-d dig path] [-D dsfromkey path] {zone}

-
-
+

+ dnssec-checkds + [-l domain] + [-f file] + [-d dig path] + [-D dsfromkey path] + {zone} +

+

+ dnssec-dsfromkey + [-l domain] + [-f file] + [-d dig path] + [-D dsfromkey path] + {zone} +

+
+ +

DESCRIPTION

-

dnssec-checkds + +

dnssec-checkds verifies the correctness of Delegation Signer (DS) or DNSSEC Lookaside Validation (DLV) resource records for keys in a specified zone.

-
-
+
+ +

OPTIONS

-
+ + +
-f file
-

+

+

If a file is specified, then the zone is read from that file to find the DNSKEY records. If not, then the DNSKEY records for the zone are looked up in the DNS. -

+

+
-l domain
-

+

+

Check for a DLV record in the specified lookaside domain, instead of checking for a DS record in the zone's parent. For example, to check for DLV records for "example.com" in ISC's DLV zone, use: dnssec-checkds -l dlv.isc.org example.com -

+

+
-d dig path
-

+

+

Specifies a path to a dig binary. Used for testing. -

+

+
-D dsfromkey path
-

+

+

Specifies a path to a dnssec-dsfromkey binary. Used for testing. -

+

+
-
-
+
+ +

SEE ALSO

-

dnssec-dsfromkey(8), - dnssec-keygen(8), - dnssec-signzone(8), + +

+ dnssec-dsfromkey(8) + , + + dnssec-keygen(8) + , + + dnssec-signzone(8) + ,

-
+
+
diff --git a/bin/python/dnssec-coverage.html b/bin/python/dnssec-coverage.html index 1f64693c37..6116d1951c 100644 --- a/bin/python/dnssec-coverage.html +++ b/bin/python/dnssec-coverage.html @@ -22,22 +22,47 @@
-
+ + + + + +

Name

-

dnssec-coverage — checks future DNSKEY coverage for a zone

+

+ dnssec-coverage + — checks future DNSKEY coverage for a zone +

-
+ + + +

Synopsis

-

dnssec-coverage [-K directory] [-l length] [-f file] [-d DNSKEY TTL] [-m max TTL] [-r interval] [-c compilezone path] [-k] [-z] [zone...]

-
-
+

+ dnssec-coverage + [-K directory] + [-l length] + [-f file] + [-d DNSKEY TTL] + [-m max TTL] + [-r interval] + [-c compilezone path] + [-k] + [-z] + [zone...] +

+
+ +

DESCRIPTION

-

dnssec-coverage + +

dnssec-coverage verifies that the DNSSEC keys for a given zone or a set of zones have timing metadata set properly to ensure no future lapses in DNSSEC coverage.

-

+

If zone is specified, then keys found in the key repository matching that zone are scanned, and an ordered list is generated of the events scheduled for that key (i.e., @@ -50,47 +75,54 @@ key is rolled, and cached data signed by the prior key has not had time to expire from resolver caches.

-

+

If zone is not specified, then all keys in the key repository will be scanned, and all zones for which there are keys will be analyzed. (Note: This method of reporting is only accurate if all the zones that have keys in a given repository share the same TTL parameters.)

-
-
+
+ +

OPTIONS

-
+ + +
-K directory
-

+

+

Sets the directory in which keys can be found. Defaults to the current working directory. -

+

+
-f file
-

+

+

If a file is specified, then the zone is read from that file; the largest TTL and the DNSKEY TTL are determined directly from the zone data, and the -m and -d options do not need to be specified on the command line. -

+

+
-l duration
-

+

The length of time to check for DNSSEC coverage. Key events scheduled further into the future than duration will be ignored, and assumed to be correct.

-

+

The value of duration can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.

-
+
-m maximum TTL
-

+

Sets the value to be used as the maximum TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure. When a zone-signing key is @@ -99,26 +131,26 @@ before that key can be purged from the DNSKEY RRset. If that condition does not apply, a warning will be generated.

-

+

The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.

-

+

This option is not necessary if the -f has been used to specify a zone file. If -f has been specified, this option may still be used; it will override the value found in the file.

-

+

If this option is not used and the maximum TTL cannot be retrieved from a zone file, a warning is generated and a default value of 1 week is used.

-
+
-d DNSKEY TTL
-

+

Sets the value to be used as the DNSKEY TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure. When a key is rolled (that @@ -127,12 +159,12 @@ the new key is activated and begins generating signatures. If that condition does not apply, a warning will be generated.

-

+

The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.

-

+

This option is not necessary if -f has been used to specify a zone file from which the TTL of the DNSKEY RRset can be read, or if a default key TTL was @@ -141,15 +173,15 @@ this option may still be used; it will override the values found in the zone file or the key file.

-

+

If this option is not used and the key TTL cannot be retrieved from the zone file or the key file, then a warning is generated and a default value of 1 day is used.

-
+
-r resign interval
-

+

Sets the value to be used as the resign interval for the zone or zones being analyzed when determining whether there is a possibility of validation failure. This value defaults to @@ -159,37 +191,54 @@ named.conf, then it should also be changed here.

-

+

The length of the interval can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.

-
+
-k
-

+

+

Only check KSK coverage; ignore ZSK events. Cannot be used with -z. -

+

+
-z
-

+

+

Only check ZSK coverage; ignore KSK events. Cannot be used with -k. -

+

+
-c compilezone path
-

+

+

Specifies a path to a named-compilezone binary. Used for testing. -

+

+
-
-
+
+ +

SEE ALSO

-

- dnssec-checkds(8), - dnssec-dsfromkey(8), - dnssec-keygen(8), - dnssec-signzone(8) + +

+ + dnssec-checkds(8) + , + + dnssec-dsfromkey(8) + , + + dnssec-keygen(8) + , + + dnssec-signzone(8) +

-
+
+
diff --git a/bin/rndc/rndc.conf.html b/bin/rndc/rndc.conf.html index 05776af9c3..9b28822217 100644 --- a/bin/rndc/rndc.conf.html +++ b/bin/rndc/rndc.conf.html @@ -23,17 +23,32 @@
-
+ + + + + +

Name

-

rndc.conf — rndc configuration file

+

+ rndc.conf + — rndc configuration file +

-
+ + + +

Synopsis

-

rndc.conf

-
-
+

+ rndc.conf +

+
+ +

DESCRIPTION

-

rndc.conf is the configuration file + +

rndc.conf is the configuration file for rndc, the BIND 9 name server control utility. This file has a similar structure and syntax to named.conf. Statements are enclosed @@ -41,21 +56,21 @@ the statements are also semi-colon terminated. The usual comment styles are supported:

-

+

C style: /* */

-

+

C++ style: // to end of line

-

+

Unix style: # to end of line

-

rndc.conf is much simpler than +

rndc.conf is much simpler than named.conf. The file uses three statements: an options statement, a server statement and a key statement.

-

+

The options statement contains five clauses. The default-server clause is followed by the name or address of a name server. This host will be used when @@ -78,7 +93,7 @@ can be used to set the IPv4 and IPv6 source addresses respectively.

-

+

After the server keyword, the server statement includes a string which is the hostname or address for a name server. The statement has three possible clauses: @@ -92,7 +107,7 @@ of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively.

-

+

The key statement begins with an identifying string, the name of the key. The statement has two clauses. algorithm identifies the authentication algorithm @@ -103,7 +118,7 @@ the base-64 encoding of the algorithm's authentication key. The base-64 string is enclosed in double quotes.

-

+

There are two common ways to generate the base-64 string for the secret. The BIND 9 program rndc-confgen can @@ -116,10 +131,13 @@ ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each.

-
-
+
+ +

EXAMPLE

-
+
+
+    
       options {
         default-server  localhost;
         default-key     samplekey;
@@ -127,14 +145,14 @@
 

 

     

-
+    
       server localhost {
         key             samplekey;
       };
 

 

     

-
+    
       server testserver {
         key		testkey;
         addresses	{ localhost port 5353; };
@@ -142,7 +160,7 @@
 

 

     

-
+    
       key samplekey {
         algorithm       hmac-sha256;
         secret          "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
@@ -150,7 +168,7 @@
 

 

     

-
+    
       key testkey {
         algorithm	hmac-sha256;
         secret		"R3HI8P6BKw9ZwXwN3VZKuQ==";
@@ -158,7 +176,8 @@
     

 

     

-

+
+    

       In the above example, rndc will by
       default use
       the server at localhost (127.0.0.1) and the key called samplekey.
@@ -168,16 +187,16 @@
       uses the HMAC-SHA256 algorithm and its secret clause contains the
       base-64 encoding of the HMAC-SHA256 secret enclosed in double quotes.
     

-

+    

       If rndc -s testserver is used then rndc will
       connect to server on localhost port 5353 using the key testkey.
     

-

+    

       To generate a random secret with rndc-confgen:
     

-
rndc-confgen
+    
rndc-confgen
     

-

+    

       A complete rndc.conf file, including
       the
       randomly generated key, will be written to the standard
@@ -185,29 +204,40 @@
       controls statements for
       named.conf are also printed.
     

-

+    

       To generate a base-64 secret with mmencode:
     

-
echo "known plaintext for a secret" | mmencode
+    
echo "known plaintext for a secret" | mmencode
     

-
-
+
+ +

NAME SERVER CONFIGURATION

-

+ +

The name server must be configured to accept rndc connections and to recognize the key specified in the rndc.conf file, using the controls statement in named.conf. See the sections on the controls statement in the BIND 9 Administrator Reference Manual for details.

-
-
+
+ +

SEE ALSO

-

rndc(8), - rndc-confgen(8), - mmencode(1), + +

+ rndc(8) + , + + rndc-confgen(8) + , + + mmencode(1) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/bin/rndc/rndc.html b/bin/rndc/rndc.html index 0f799d32f8..582cc5fd5e 100644 --- a/bin/rndc/rndc.html +++ b/bin/rndc/rndc.html @@ -23,17 +23,41 @@
-
+ + + + + +

Name

-

rndc — name server control utility

+

+ rndc + — name server control utility +

-
+ + + +

Synopsis

-

rndc [-b source-address] [-c config-file] [-k key-file] [-s server] [-p port] [-q] [-V] [-y key_id] {command}

-
-
+

+ rndc + [-b source-address] + [-c config-file] + [-k key-file] + [-s server] + [-p port] + [-q] + [-V] + [-y key_id] + {command} +

+
+ +

DESCRIPTION

-

rndc + +

rndc controls the operation of a name server. It supersedes the ndc utility that was provided in old BIND releases. If @@ -42,7 +66,7 @@ supported commands and the available options and their arguments.

-

rndc +

rndc communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of @@ -56,30 +80,38 @@ over the channel must be signed by a key_id known to the server.

-

rndc +

rndc reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use.

-
-
+
+ +

OPTIONS

-
+ + +
-b source-address
-

+

+

Use source-address as the source address for the connection to the server. Multiple instances are permitted to allow setting of both the IPv4 and IPv6 source addresses. -

+

+
-c config-file
-

+

+

Use config-file as the configuration file instead of the default, /etc/rndc.conf. -

+

+
-k key-file
-

+

+

Use key-file as the key file instead of the default, /etc/rndc.key. The key in @@ -87,34 +119,44 @@ authenticate commands sent to the server if the config-file does not exist. -

+

+
-s server
-

server is +

+

server is the name or address of the server which matches a server statement in the configuration file for rndc. If no server is supplied on the command line, the host named by the default-server clause in the options statement of the rndc configuration file will be used. -

+

+
-p port
-

+

+

Send commands to TCP port port instead of BIND 9's default control channel port, 953. -

+

+
-q
-

+

+

Quiet mode: Message text returned by the server will not be printed except when there is an error. -

+

+
-V
-

+

+

Enable verbose logging. -

+

+
-y key_id
-

+

+

Use the key key_id from the configuration file. key_id @@ -130,22 +172,26 @@ which are used to send authenticated control commands to name servers. It should therefore not have general read or write access. -

+

+
-
-
+
+ +

COMMANDS

-

+ +

A list of commands supported by rndc can be seen by running rndc without arguments.

-

+

Currently supported commands are:

-
+ +
addzone zone [class [view]] configuration
-

+

Add a zone while the server is running. This command requires the allow-new-zones option to be set @@ -155,7 +201,7 @@ configuration text that would ordinarily be placed in named.conf.

-

+

The configuration is saved in a file called hash.nzf, where hash is a @@ -165,31 +211,31 @@ configuration, so that zones that were added can persist after a restart.

-

+

This sample addzone command would add the zone example.com to the default view:

-

+

$ rndc addzone example.com '{ type master; file "example.com.db"; };'

-

+

(Note the brackets and semi-colon around the zone configuration text.)

-

+

See also rndc delzone.

-
+
delzone [-clean] zone [class [view]]
-

+

Delete a zone while the server is running. Only zones that were originally added via rndc addzone can be deleted in this manner.

-

+

If the -clean is specified, the zone's master file (and journal file, if any) will be deleted along with the zone. Without the @@ -199,12 +245,13 @@ be cleaned up will be reported in the output of the rndc delzone command.)

-

+

See also rndc addzone.

-
+
dumpdb [-all|-cache|-zone|-adb|-bad] [view ...]
-

+

+

Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is @@ -212,26 +259,33 @@ views are dumped. (See the dump-file option in the BIND 9 Administrator Reference Manual.) -

+

+
flush
-

+

+

Flushes the server's cache. -

+

+
flushname name [view]
-

+

+

Flushes the given name from the server's DNS cache and, if applicable, from the server's nameserver address database or bad-server cache. -

+

+
flushtree name [view]
-

+

+

Flushes the given name, and all of its subdomains, from the server's DNS cache, the address database, and the bad server cache. -

+

+
freeze [zone [class [view]]]
-

+

Suspend updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by @@ -240,13 +294,13 @@ All dynamic update attempts will be refused while the zone is frozen.

-

+

See also rndc thaw.

-
+
halt [-p]
-

+

Stop the server immediately. Recent changes made through dynamic update or IXFR are not saved to the master files, but will be rolled forward from the @@ -255,13 +309,13 @@ This allows an external process to determine when named had completed halting.

-

+

See also rndc stop.

-
+
loadkeys zone [class [view]]
-

+

Fetch all DNSSEC keys for the given zone from the key directory. If they are within their publication period, merge them into the @@ -270,7 +324,7 @@ immediately re-signed by the new keys, but is allowed to incrementally re-sign over time.

-

+

This command requires that the auto-dnssec zone option be set to maintain, @@ -279,31 +333,33 @@ (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)

-

+

See also rndc loadkeys.

-
+
notify zone [class [view]]
-

+

+

Resend NOTIFY messages for the zone. -

+

+
notrace
-

+

Sets the server's debugging level to 0.

-

+

See also rndc trace.

-
+
querylog [on|off]
-

+

Enable or disable query logging. (For backward compatibility, this command can also be used without an argument to toggle query logging on and off.)

-

+

Query logging can also be enabled by explicitly directing the queries category to a @@ -314,9 +370,10 @@ options section of named.conf.

-
+
reconfig
-

+

+

Reload the configuration file and load new zones, but do not reload existing zone files even if they have changed. @@ -324,34 +381,43 @@ is a large number of zones because it avoids the need to examine the modification times of the zones files. -

+

+
recursing
-

+

+

Dump the list of queries named is currently recursing on, and the list of domains to which iterative queries are currently being sent. (The second list includes the number of fetches currently active for the given domain, and how many have been passed or dropped because of the fetches-per-zone option.) -

+

+
refresh zone [class [view]]
-

+

+

Schedule zone maintenance for the given zone. -

+

+
reload
-

+

+

Reload configuration file and zones. -

+

+
reload zone [class [view]]
-

+

+

Reload the given zone. -

+

+
retransfer zone [class [view]]
-

+

Retransfer the given slave zone from the master server.

-

+

If the zone is configured to use inline-signing, the signed version of the zone is discarded; after the @@ -359,24 +425,28 @@ signed version will be regenerated with all new signatures.

-
+
scan
-

+

+

Scan the list of available network interfaces for changes, without performing a full reconfig or waiting for the interface-interval timer. -

+

+
secroots [view ...]
-

+

+

Dump the server's security roots to the secroots file for the specified views. If no view is specified, security roots for all views are dumped. -

+

+
sign zone [class [view]]
-

+

Fetch all DNSSEC keys for the given zone from the key directory (see the key-directory option in @@ -386,7 +456,7 @@ is changed, then the zone is automatically re-signed with the new key set.

-

+

This command requires that the auto-dnssec zone option be set to allow or @@ -396,13 +466,13 @@ (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)

-

+

See also rndc loadkeys.

-
+
signing [( -list | -clear keyid/algorithm | -clear all | -nsec3param ( parameters | none ) ) ] zone [class [view]]
-

+

List, edit, or remove the DNSSEC signing state records for the specified zone. The status of ongoing DNSSEC operations (such as signing or generating @@ -415,7 +485,7 @@ or have finished signing the zone, and which NSEC3 chains are being created or removed.

-

+

rndc signing -clear can remove a single key (specified in the same format that rndc signing -list uses to @@ -424,7 +494,7 @@ that a key has not yet finished signing the zone will be retained.

-

+

rndc signing -nsec3param sets the NSEC3 parameters for a zone. This is the only supported mechanism for using NSEC3 with @@ -433,7 +503,7 @@ an NSEC3PARAM resource record: hash algorithm, flags, iterations, and salt, in that order.

-

+

Currently, the only defined value for hash algorithm is 1, representing SHA-1. The flags may be set to @@ -448,7 +518,7 @@ which causes named to generate a random 64-bit salt.

-

+

So, for example, to create an NSEC3 chain using the SHA-1 hash algorithm, no opt-out flag, 10 iterations, and a salt value of "FFFF", use: @@ -457,29 +527,33 @@ salt, use: rndc signing -nsec3param 1 1 15 - zone.

-

+

rndc signing -nsec3param none removes an existing NSEC3 chain and replaces it with NSEC.

-
+
stats
-

+

+

Write server statistics to the statistics file. (See the statistics-file option in the BIND 9 Administrator Reference Manual.) -

+

+
status
-

+

+

Display status of the server. Note that the number of zones includes the internal bind/CH zone and the default ./IN hint zone if there is not an explicit root zone configured. -

+

+
stop [-p]
-

+

Stop the server, making sure any recent changes made through dynamic update or IXFR are first saved to the master files of the updated zones. @@ -487,18 +561,20 @@ This allows an external process to determine when named had completed stopping.

-

See also rndc halt.

-
+

See also rndc halt.

+
sync [-clean] [zone [class [view]]]
-

+

+

Sync changes in the journal file for a dynamic zone to the master file. If the "-clean" option is specified, the journal file is also removed. If no zone is specified, then all zones are synced. -

+

+
thaw [zone [class [view]]]
-

+

Enable updates to a frozen dynamic zone. If no zone is specified, then all frozen zones are enabled. This causes the server to reload the zone @@ -512,46 +588,55 @@ zone has changed, any existing journal file will be removed.

-

See also rndc freeze.

-
+

See also rndc freeze.

+
trace
-

+

+

Increment the servers debugging level by one. -

+

+
trace level
-

+

Sets the server's debugging level to an explicit value.

-

+

See also rndc notrace.

-
+
tsig-delete keyname [view]
-

+

+

Delete a given TKEY-negotiated key from the server. (This does not apply to statically configured TSIG keys.) -

+

+
tsig-list
-

+

+

List the names of all TSIG keys currently configured for use by named in each view. The list both statically configured keys and dynamic TKEY-negotiated keys. -

+

+
validation ( on | off | check ) [view ...]
-

+

+

Enable, disable, or check the current status of DNSSEC validation. Note dnssec-enable also needs to be set to yes or auto to be effective. It defaults to enabled. -

+

+
zonestatus zone [class [view]]
-

+

+

Displays the current status of the given zone, including the master file name and any include files from which it was loaded, when it was most @@ -561,28 +646,44 @@ signed, whether it uses automatic DNSSEC key management or inline signing, and the scheduled refresh or expiry times for the zone. -

+

+
-
-
+
+ +

LIMITATIONS

-

+ +

There is currently no way to provide the shared secret for a key_id without using the configuration file.

-

+

Several error messages could be clearer.

-
-
+
+ +

SEE ALSO

-

rndc.conf(5), - rndc-confgen(8), - named(8), - named.conf(5), - ndc(8), + +

+ rndc.conf(5) + , + + rndc-confgen(8) + , + + named(8) + , + + named.conf(5) + , + + ndc(8) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/bin/tools/arpaname.html b/bin/tools/arpaname.html index a37c269a1c..1fd6e1f09a 100644 --- a/bin/tools/arpaname.html +++ b/bin/tools/arpaname.html @@ -22,26 +22,44 @@
-
+ + + + +

Name

-

arpaname — translate IP addresses to the corresponding ARPA names

-
-
-

Synopsis

-

arpaname {ipaddress ...}

-
-
-

DESCRIPTION

+ arpaname + — translate IP addresses to the corresponding ARPA names +

+
+ + + +
+

Synopsis

+

+ arpaname + {ipaddress ...} +

+
+ +
+

DESCRIPTION

+ +

arpaname translates IP addresses (IPv4 and IPv6) to the corresponding IN-ADDR.ARPA or IP6.ARPA names.

-
-
+
+ +

SEE ALSO

-

+ +

BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/bin/tools/genrandom.html b/bin/tools/genrandom.html index f0e8571fc3..a3a014bb16 100644 --- a/bin/tools/genrandom.html +++ b/bin/tools/genrandom.html @@ -22,47 +22,80 @@
-
+ + + + + +

Name

-

genrandom — generate a file containing random data

-
-
-

Synopsis

-

genrandom [-n number] {size} {filename}

-
-
-

DESCRIPTION

+ genrandom + — generate a file containing random data +

+
+ + + +
+

Synopsis

+

+ genrandom + [-n number] + {size} + {filename} +

+
+ +
+

DESCRIPTION

+ +

genrandom generates a file or a set of files containing a specified quantity of pseudo-random data, which can be used as a source of entropy for other commands on systems with no random device.

-
-
+
+ +

ARGUMENTS

-
+ +
-n number
-

+

+

In place of generating one file, generates number (from 2 to 9) files, appending number to the name. -

+

+
size
-

+

+

The size of the file, in kilobytes, to generate. -

+

+
filename
-

+

+

The file name into which random data should be written. -

+

+
-
-
+
+ +

SEE ALSO

-

- rand(3), - arc4random(3) + +

+ + rand(3) + , + + arc4random(3) +

-
+
+
diff --git a/bin/tools/isc-hmac-fixup.html b/bin/tools/isc-hmac-fixup.html index 4ae77087ea..26b80ab7b8 100644 --- a/bin/tools/isc-hmac-fixup.html +++ b/bin/tools/isc-hmac-fixup.html @@ -22,17 +22,34 @@
-
+ + + + + +

Name

-

isc-hmac-fixup — fixes HMAC keys generated by older versions of BIND

-
-
-

Synopsis

-

isc-hmac-fixup {algorithm} {secret}

-
-
-

DESCRIPTION

+ isc-hmac-fixup + — fixes HMAC keys generated by older versions of BIND +

+
+ + + +
+

Synopsis

+

+ isc-hmac-fixup + {algorithm} + {secret} +

+
+ +
+

DESCRIPTION

+ +

Versions of BIND 9 up to and including BIND 9.6 had a bug causing HMAC-SHA* TSIG keys which were longer than the digest length of the hash algorithm (i.e., SHA1 keys longer than 160 bits, SHA256 keys @@ -40,13 +57,13 @@ message authentication code that was incompatible with other DNS implementations.

-

+

This bug has been fixed in BIND 9.7. However, the fix may cause incompatibility between older and newer versions of BIND, when using long keys. isc-hmac-fixup modifies those keys to restore compatibility.

-

+

To modify a key, run isc-hmac-fixup and specify the key's algorithm and secret on the command line. If the secret is longer than the digest length of the algorithm (64 bytes @@ -55,10 +72,12 @@ secret. (If the secret did not require conversion, then it will be printed without modification.)

-
-
+
+ +

SECURITY CONSIDERATIONS

-

+ +

Secrets that have been converted by isc-hmac-fixup are shortened, but as this is how the HMAC protocol works in operation anyway, it does not affect security. RFC 2104 notes, @@ -66,13 +85,16 @@ extra length would not significantly increase the function strength."

-
-
+
+ +

SEE ALSO

-

+ +

BIND 9 Administrator Reference Manual, RFC 2104.

-
+
+
diff --git a/bin/tools/named-journalprint.html b/bin/tools/named-journalprint.html index 62d7a94ca2..65a995b349 100644 --- a/bin/tools/named-journalprint.html +++ b/bin/tools/named-journalprint.html @@ -22,22 +22,38 @@
-
+ + + + + +

Name

-

named-journalprint — print zone journal in human-readable form

-
-
-

Synopsis

-

named-journalprint {journal}

-
-
-

DESCRIPTION

+ named-journalprint + — print zone journal in human-readable form +

+
+ + + +
+

Synopsis

+

+ named-journalprint + {journal} +

+
+ +
+

DESCRIPTION

+ +

named-journalprint prints the contents of a zone journal file in a human-readable form.

-

+

Journal files are automatically created by named when changes are made to dynamic zones (e.g., by nsupdate). They record each addition @@ -48,21 +64,28 @@ .jnl to the name of the corresponding zone file.

-

+

named-journalprint converts the contents of a given journal file into a human-readable text format. Each line begins with "add" or "del", to indicate whether the record was added or deleted, and continues with the resource record in master-file format.

-
-
+
+ +

SEE ALSO

-

- named(8), - nsupdate(8), + +

+ + named(8) + , + + nsupdate(8) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/bin/tools/named-rrchecker.html b/bin/tools/named-rrchecker.html index d1bfd0fa77..0e72b9d15c 100644 --- a/bin/tools/named-rrchecker.html +++ b/bin/tools/named-rrchecker.html @@ -22,49 +22,74 @@
-
+ + + +

Name

-

named-rrchecker — syntax checker for individual DNS resource records

+

+ named-rrchecker + — syntax checker for individual DNS resource records +

-
+ + + +

Synopsis

-

named-rrchecker [-h] [-o origin] [-p] [-u] [-C] [-T] [-P]

-
-
+

+ named-rrchecker + [-h] + [-o origin] + [-p] + [-u] + [-C] + [-T] + [-P] +

+
+ +

DESCRIPTION

-

named-rrchecker + +

named-rrchecker read a individual DNS resource record from standard input and checks if it is syntactically correct.

-

+

The -h prints out the help menu.

-

+

The -o origin option specifies a origin to be used when interpreting the record.

-

+

The -p prints out the resulting record in canonical form. If there is no canonical form defined then the record will be printed in unknown record format.

-

+

The -u prints out the resulting record in unknown record form.

-

+

The -C, -T and -P print out the known class, standard type and private type mnemonics respectively.

-
-
+
+ +

SEE ALSO

-

+ +

RFC 1034, RFC 1035, - named(8) + + named(8) +

-
+
+
diff --git a/bin/tools/nsec3hash.html b/bin/tools/nsec3hash.html index 21d703db2a..fe53ad66a9 100644 --- a/bin/tools/nsec3hash.html +++ b/bin/tools/nsec3hash.html @@ -22,52 +22,84 @@
-
+ + + + + +

Name

-

nsec3hash — generate NSEC3 hash

-
-
-

Synopsis

-

nsec3hash {salt} {algorithm} {iterations} {domain}

-
-
-

DESCRIPTION

+ nsec3hash + — generate NSEC3 hash +

+
+ + + +
+

Synopsis

+

+ nsec3hash + {salt} + {algorithm} + {iterations} + {domain} +

+
+ +
+

DESCRIPTION

+ +

nsec3hash generates an NSEC3 hash based on a set of NSEC3 parameters. This can be used to check the validity of NSEC3 records in a signed zone.

-
-
+
+ +

ARGUMENTS

-
+ +
salt
-

+

+

The salt provided to the hash algorithm. -

+

+
algorithm
-

+

+

A number indicating the hash algorithm. Currently the only supported hash algorithm for NSEC3 is SHA-1, which is indicated by the number 1; consequently "1" is the only useful value for this argument. -

+

+
iterations
-

+

+

The number of additional times the hash should be performed. -

+

+
domain
-

+

+

The domain name to be hashed. -

+

+
-
-
+
+ +

SEE ALSO

-

+ +

BIND 9 Administrator Reference Manual, RFC 5155.

-
+
+
diff --git a/doc/arm/Bv9ARM.ch01.html b/doc/arm/Bv9ARM.ch01.html index 84dcca8ab5..56a42b5f5d 100644 --- a/doc/arm/Bv9ARM.ch01.html +++ b/doc/arm/Bv9ARM.ch01.html @@ -59,7 +59,8 @@
-

+ +

The Internet Domain Name System (DNS) consists of the syntax to specify the names of entities in the Internet in a hierarchical @@ -69,10 +70,12 @@ group of distributed hierarchical databases.

-
+ +

Scope of Document

-

+ +

The Berkeley Internet Name Domain (BIND) implements a domain name server for a number of operating systems. This @@ -81,12 +84,14 @@ BIND version 9 software package for system administrators.

-

This version of the manual corresponds to BIND version 9.10.

-
-
+

This version of the manual corresponds to BIND version 9.10.

+
+ +

Organization of This Document

-

+ +

In this document, Chapter 1 introduces the basic DNS and BIND concepts. Chapter 2 describes resource requirements for running BIND in various @@ -111,15 +116,18 @@ and the Domain Name System.

-
-
+
+

Conventions Used in This Document

-

+ +

In this document, we use the following general typographic conventions:

-
+ +
+
@@ -176,11 +184,14 @@ -
-

+ +

+ +

The following conventions are used in descriptions of the BIND configuration file:

-
+
+
@@ -235,31 +246,36 @@ -
+ +

-
-
+
+

The Domain Name System (DNS)

-

+ +

The purpose of this document is to explain the installation and upkeep of the BIND (Berkeley Internet Name Domain) software package, and we begin by reviewing the fundamentals of the Domain Name System (DNS) as they relate to BIND.

-
+ +

DNS Fundamentals

-

+ +

The Domain Name System (DNS) is a hierarchical, distributed database. It stores information for mapping Internet host names to IP addresses and vice versa, mail routing information, and other data used by Internet applications.

-

+ +

Clients look up information in the DNS by calling a resolver library, which sends queries to one or more name servers and interprets the responses. @@ -270,11 +286,13 @@ libbind resolver library is also available from ISC as a separate download.

-
-
+ +
+

Domains and Domain Names

-

+ +

The data stored in the DNS is identified by domain names that are organized as a tree according to organizational or administrative boundaries. Each node of the tree, called a domain, is given a label. The domain @@ -285,7 +303,8 @@ separated by dots. A label need only be unique within its parent domain.

-

+ +

For example, a domain name for a host at the company Example, Inc. could be ourhost.example.com, @@ -297,7 +316,8 @@ ourhost is the name of the host.

-

+ +

For administrative purposes, the name space is partitioned into areas called zones, each starting at a node and extending down to the leaf nodes or to nodes where other zones @@ -305,27 +325,32 @@ The data for each zone is stored in a name server, which answers queries about the zone using the DNS protocol.

-

+ +

The data associated with each domain name is stored in the form of resource records (RRs). Some of the supported resource record types are described in the section called “Types of Resource Records and When to Use Them”.

-

+ +

For more detailed information about the design of the DNS and the DNS protocol, please refer to the standards documents listed in the section called “Request for Comments (RFCs)”.

-
-
+
+ +

Zones

-

+ +

To properly operate a name server, it is important to understand the difference between a zone and a domain.

-

+ +

As stated previously, a zone is a point of delegation in the DNS tree. A zone consists of those contiguous parts of the domain @@ -337,7 +362,8 @@ parent zone, which should be matched by equivalent NS records at the root of the delegated zone.

-

+ +

For instance, consider the example.com domain which includes names such as host.aaa.example.com and @@ -359,7 +385,8 @@ gain a complete understanding of this difficult and subtle topic.

-

+ +

Though BIND is called a "domain name server", it deals primarily in terms of zones. The master and slave @@ -369,11 +396,13 @@ be a slave server for your domain, you are actually asking for slave service for some collection of zones.

-
-
+
+ +

Authoritative Name Servers

-

+ +

Each zone is served by at least one authoritative name server, which contains the complete data for the zone. @@ -381,16 +410,19 @@ most zones have two or more authoritative servers, on different networks.

-

+ +

Responses from authoritative servers have the "authoritative answer" (AA) bit set in the response packets. This makes them easy to identify when debugging DNS configurations using tools like dig (the section called “Diagnostic Tools”).

-
+ +

The Primary Master

-

+ +

The authoritative server where the master copy of the zone data is maintained is called the primary master server, or simply the @@ -401,16 +433,19 @@ zone file or master file.

-

+ +

In some cases, however, the master file may not be edited by humans at all, but may instead be the result of dynamic update operations.

-
-
+
+ +

Slave Servers

-

+ +

The other authoritative servers, the slave servers (also known as secondary servers) load @@ -422,11 +457,13 @@ to transfer it from another slave. In other words, a slave server may itself act as a master to a subordinate slave server.

-
-
+
+ +

Stealth Servers

-

+ +

Usually all of the zone's authoritative servers are listed in NS records in the parent zone. These NS records constitute a delegation of the zone from the parent. @@ -437,7 +474,8 @@ list servers in the parent's delegation that are not present at the zone's top level.

-

+ +

A stealth server is a server that is authoritative for a zone but is not listed in that zone's NS records. Stealth servers can be used for keeping a local copy of @@ -448,7 +486,8 @@ are inaccessible.

-

+ +

A configuration where the primary master server itself is a stealth server is often referred to as a "hidden primary" configuration. One use for this configuration is when the primary @@ -456,12 +495,17 @@ is behind a firewall and therefore unable to communicate directly with the outside world.

-
-
-
+ +
+ +
+

Caching Name Servers

-

+ + + +

The resolver libraries provided by most operating systems are stub resolvers, meaning that they are not capable of @@ -473,22 +517,26 @@ is called a recursive name server; it performs recursive lookups for local clients.

-

+ +

To improve performance, recursive servers cache the results of the lookups they perform. Since the processes of recursion and caching are intimately connected, the terms recursive server and caching server are often used synonymously.

-

+ +

The length of time for which a record may be retained in the cache of a caching name server is controlled by the Time To Live (TTL) field associated with each resource record.

-
+ +

Forwarding

-

+ +

Even a caching name server does not necessarily perform the complete recursive lookup itself. Instead, it can forward some or all of the queries @@ -496,7 +544,8 @@ server, commonly referred to as a forwarder.

-

+ +

There may be one or more forwarders, and they are queried in turn until the list is exhausted or an answer @@ -510,18 +559,22 @@ that can do it, and that server would query the Internet DNS servers on the internal server's behalf.

-
-
-
+
+ +
+ +

Name Servers in Multiple Roles

-

+ +

The BIND name server can simultaneously act as a master for some zones, a slave for other zones, and as a caching (recursive) server for a set of local clients.

-

+ +

However, since the functions of authoritative name service and caching/recursive name service are logically separate, it is often advantageous to run them on separate server machines. @@ -536,9 +589,11 @@ does not need to be reachable from the Internet at large and can be placed inside a firewall.

-
-
-
+ +
+
+ +
diff --git a/doc/arm/Bv9ARM.ch02.html b/doc/arm/Bv9ARM.ch02.html index b0236260d8..63206bbb6b 100644 --- a/doc/arm/Bv9ARM.ch02.html +++ b/doc/arm/Bv9ARM.ch02.html @@ -52,16 +52,17 @@
Supported Operating Systems
-
+ +

Hardware requirements

-

+

DNS hardware requirements have traditionally been quite modest. For many installations, servers that have been pensioned off from active duty have performed admirably as DNS servers.

-

+

The DNSSEC features of BIND 9 may prove to be quite CPU intensive however, so organizations that make heavy use of these @@ -70,22 +71,22 @@ full utilization of multiprocessor systems for installations that need it.

-
-
+
+

CPU Requirements

-

+

CPU requirements for BIND 9 range from i486-class machines for serving of static zones without caching, to enterprise-class machines if you intend to process many dynamic updates and DNSSEC signed zones, serving many thousands of queries per second.

-
-
+
+

Memory Requirements

-

+

The memory of the server has to be large enough to fit the cache and zones loaded off disk. The max-cache-size option can be used to limit the amount of memory used by the cache, @@ -104,11 +105,14 @@ a relatively stable size where entries are expiring from the cache as fast as they are being inserted.

-
-
+ +
+ +

Name Server Intensive Environment Issues

-

+ +

For name server intensive environments, there are two alternative configurations that may be used. The first is where clients and any second-level internal name servers query a main name server, which @@ -121,11 +125,13 @@ this has the disadvantage of making many more external queries, as none of the name servers share their cached data.

-
-
+
+ +

Supported Operating Systems

-

+ +

ISC BIND 9 compiles and runs on a large number of Unix-like operating systems and on @@ -135,8 +141,8 @@ directory of the BIND 9 source distribution.

-
-
+ +
diff --git a/doc/arm/Bv9ARM.ch03.html b/doc/arm/Bv9ARM.ch03.html index f896bc6d3f..6fe9592e6d 100644 --- a/doc/arm/Bv9ARM.ch03.html +++ b/doc/arm/Bv9ARM.ch03.html @@ -58,18 +58,22 @@ -

+ +

In this chapter we provide some suggested configurations along with guidelines for their use. We suggest reasonable values for certain option settings.

-
+ +

Sample Configurations

-
+ +

A Caching-only Name Server

-

+ +

The following sample configuration is appropriate for a caching-only name server for use by clients internal to a corporation. All queries @@ -78,6 +82,7 @@ suitable firewall rules.

+ 
 // Two corporate subnets we wish to allow queries from.
 acl corpnets { 192.168.4.0/24; 192.168.7.0/24; };
@@ -95,15 +100,19 @@ zone "0.0.127.in-addr.arpa" {
      notify no;
 };
-
-
+ +
+ +

An Authoritative-only Name Server

-

+ +

This sample configuration is for an authoritative-only server that is the master server for "example.com" and a slave for the subdomain "eng.example.com".

+ 
 options {
      // Working directory
@@ -142,23 +151,31 @@ zone "eng.example.com" {
      masters { 192.168.4.12; };
 };
-
-
-
+ +
+
+ +

Load Balancing

-

+ + + +

A primitive form of load balancing can be achieved in the DNS by using multiple records (such as multiple A records) for one name.

-

+ +

For example, if you have three WWW servers with network addresses of 10.0.0.1, 10.0.0.2 and 10.0.0.3, a set of records such as the following means that clients will connect to each machine one third of the time:

-
+ +
+
@@ -272,47 +289,52 @@ zone "eng.example.com" { -
-

+ +

+

When a resolver queries for these records, BIND will rotate them and respond to the query with the records in a different order. In the example above, clients will randomly receive records in the order 1, 2, 3; 2, 3, 1; and 3, 1, 2. Most clients will use the first record returned and discard the rest.

-

+

For more detail on ordering responses, check the rrset-order sub-statement in the options statement, see RRset Ordering.

-
-
+ +
+ +

Name Server Operations

-
+ +

Tools for Use With the Name Server Daemon

-

+

This section describes several indispensable diagnostic, administrative and monitoring tools available to the system administrator for controlling and debugging the name server daemon.

-
+

Diagnostic Tools

-

+

The dig, host, and nslookup programs are all command line tools for manually querying name servers. They differ in style and output format.

-
+ +
dig
-

+

The domain information groper (dig) is the most versatile and complete of these lookup tools. It has two modes: simple interactive @@ -322,22 +344,31 @@ zone "eng.example.com" { accessible from the command line.

-

dig [@server] domain [query-type] [query-class] [+query-option] [-dig-option] [%comment]

-

+

+ dig + [@server] + domain + [query-type] + [query-class] + [+query-option] + [-dig-option] + [%comment] +

+

The usual simple use of dig will take the form

-

+

dig @server domain query-type query-class

-

+

For more information and a list of available commands and options, see the dig man page.

-
+
host
-

+

The host utility emphasizes simplicity and ease of use. By default, it converts @@ -345,16 +376,29 @@ zone "eng.example.com" { functionality can be extended with the use of options.

-

host [-aCdlnrsTwv] [-c class] [-N ndots] [-t type] [-W timeout] [-R retries] [-m flag] [-4] [-6] hostname [server]

-

+

+ host + [-aCdlnrsTwv] + [-c class] + [-N ndots] + [-t type] + [-W timeout] + [-R retries] + [-m flag] + [-4] + [-6] + hostname + [server] +

+

For more information and a list of available commands and options, see the host man page.

-
+
nslookup
-

nslookup +

nslookup has two modes: interactive and non-interactive. Interactive mode allows the user to query name servers for information about various @@ -363,8 +407,15 @@ zone "eng.example.com" { the name and requested information for a host or domain.

-

nslookup [-option...] [[host-to-find] | [- [server]]]

-

+

+ nslookup + [-option...] + [ + [host-to-find] + | [- [server]] + ] +

+

Interactive mode is entered when no arguments are given (the default name server will be used) or when the first argument is a @@ -372,7 +423,7 @@ zone "eng.example.com" { Internet address of a name server.

-

+

Non-interactive mode is used when the name or Internet address of the host to be looked up is given as the first argument. @@ -380,56 +431,76 @@ zone "eng.example.com" { optional second argument specifies the host name or address of a name server.

-

+

Due to its arcane user interface and frequently inconsistent behavior, we do not recommend the use of nslookup. Use dig instead.

-
+
-
-
+
+ +

Administrative Tools

-

+

Administrative tools play an integral part in the management of a server.

-
+
named-checkconf
-

+

The named-checkconf program checks the syntax of a named.conf file.

-

named-checkconf [-jvz] [-t directory] [filename]

-
+

+ named-checkconf + [-jvz] + [-t directory] + [filename] +

+
named-checkzone
-

+

The named-checkzone program checks a master file for syntax and consistency.

-

named-checkzone [-djqvD] [-c class] [-o output] [-t directory] [-w directory] [-k (ignore|warn|fail)] [-n (ignore|warn|fail)] [-W (ignore|warn)] zone [filename]

-
+

+ named-checkzone + [-djqvD] + [-c class] + [-o output] + [-t directory] + [-w directory] + [-k (ignore|warn|fail)] + [-n (ignore|warn|fail)] + [-W (ignore|warn)] + zone + [filename] +

+
named-compilezone
-

+

+

Similar to named-checkzone, but it always dumps the zone content to a specified file (typically in a different format). -

+

+
rndc
-

+

The remote name daemon control (rndc) program allows the system @@ -444,11 +515,21 @@ zone "eng.example.com" { options it will display a usage message as follows:

-

rndc [-c config] [-s server] [-p port] [-y key] command [command...]

-

See rndc(8) for details of +

+ rndc + [-c config] + [-s server] + [-p port] + [-y key] + command + [command...] +

+ +

See rndc(8) for details of the available rndc commands.

-

+ +

rndc requires a configuration file, since all communication with the server is authenticated with @@ -472,7 +553,8 @@ zone "eng.example.com" { the section called “controls Statement Definition and Usage”.

-

+ +

The format of the configuration file is similar to that of named.conf, but limited to @@ -484,7 +566,8 @@ zone "eng.example.com" { be shared. The order of statements is not significant.

-

+ +

The options statement has three clauses: default-server, default-key, @@ -502,7 +585,8 @@ zone "eng.example.com" { port is given on the command line or in a server statement.

-

+ +

The key statement defines a key to be used by rndc when authenticating @@ -531,7 +615,8 @@ zone "eng.example.com" { have any meaning. The secret is a base-64 encoded string as specified in RFC 3548.

-

+ +

The server statement associates a key defined using the key @@ -547,9 +632,11 @@ zone "eng.example.com" { connect to on the server.

-

+ +

A sample minimal configuration file is as follows:

+ 
 key rndc_key {
      algorithm "hmac-sha256";
@@ -561,30 +648,36 @@ options {
      default-key    rndc_key;
 };
-

+ +

This file, if installed as /etc/rndc.conf, would allow the command:

-

+ +

$ rndc reload

-

+ +

to connect to 127.0.0.1 port 953 and cause the name server to reload, if a name server on the local machine were running with following controls statements:

+ 
 controls {
         inet 127.0.0.1
             allow { localhost; } keys { rndc_key; };
 };
-

+ +

and it had an identical key statement for rndc_key.

-

+ +

Running the rndc-confgen program will conveniently create a rndc.conf @@ -599,19 +692,23 @@ controls { modify named.conf at all.

-
+ +
-
-
-
+ +
+
+ +

Signals

-

+

Certain UNIX signals cause the name server to take specific actions, as described in the following table. These signals can be sent using the kill command.

-
+
+
@@ -649,10 +746,11 @@ controls { -
-
-
-
+ +
+
+
+
diff --git a/doc/arm/Bv9ARM.ch04.html b/doc/arm/Bv9ARM.ch04.html index df8c6a0f43..39d36fdcae 100644 --- a/doc/arm/Bv9ARM.ch04.html +++ b/doc/arm/Bv9ARM.ch04.html @@ -110,17 +110,19 @@ -
+ +

Notify

-

+

DNS NOTIFY is a mechanism that allows master servers to notify their slave servers of changes to a zone's data. In response to a NOTIFY from a master server, the slave will check to see that its version of the zone is the current version and, if not, initiate a zone transfer.

-

+ +

For more information about DNS NOTIFY, see the description of the notify option in the section called “Boolean Options” and @@ -128,7 +130,8 @@ the section called “Zone Transfers”. The NOTIFY protocol is specified in RFC 1996.

-
+ +

Note

As a slave zone can also be a master to other slaves, named, @@ -138,29 +141,35 @@ zones that it loads.

-
-
+ +
+ +

Dynamic Update

-

+ +

Dynamic Update is a method for adding, replacing or deleting records in a master server by sending it a special form of DNS messages. The format and meaning of these messages is specified in RFC 2136.

-

+ +

Dynamic update is enabled by including an allow-update or an update-policy clause in the zone statement.

-

+ +

If the zone's update-policy is set to local, updates to the zone will be permitted for the key local-ddns, which will be generated by named at startup. See the section called “Dynamic Update Policies” for more details.

-

+ +

Dynamic updates using Kerberos signed requests can be made using the TKEY/GSS protocol by setting either the tkey-gssapi-keytab option, or alternatively @@ -170,17 +179,20 @@ policies for the zone, using the Kerberos principal as the signer for the request.

-

+ +

Updating of secure zones (zones using DNSSEC) follows RFC 3007: RRSIG, NSEC and NSEC3 records affected by updates are automatically regenerated by the server using an online zone key. Update authorization is based on transaction signatures and an explicit server policy.

-
+ +

The journal file

-

+ +

All changes made to a zone using dynamic update are stored in the zone's journal file. This file is automatically created by the server when the first dynamic update takes place. @@ -190,7 +202,8 @@ file unless specifically overridden. The journal file is in a binary format and should not be edited manually.

-

+ +

The server will also occasionally write ("dump") the complete contents of the updated zone to its zone file. This is not done immediately after @@ -203,25 +216,29 @@ will be removed when the dump is complete, and can be safely ignored.

-

+ +

When a server is restarted after a shutdown or crash, it will replay the journal file to incorporate into the zone any updates that took place after the last zone dump.

-

+ +

Changes that result from incoming incremental zone transfers are also journalled in a similar way.

-

+ +

The zone files of dynamic zones cannot normally be edited by hand because they are not guaranteed to contain the most recent dynamic changes — those are only in the journal file. The only way to ensure that the zone file of a dynamic zone is up to date is to run rndc stop.

-

+ +

If you have to make changes to a dynamic zone manually, the following procedure will work: Disable dynamic updates to the zone using @@ -232,7 +249,8 @@ rndc thaw zone to reload the changed zone and re-enable dynamic updates.

-

+ +

rndc sync zone will update the zone file with changes from the journal file without stopping dynamic updates; this may be useful for viewing @@ -240,18 +258,23 @@ file after updating the zone file, use rndc sync -clean.

-
-
-
+ +
+ +
+ +

Incremental Zone Transfers (IXFR)

-

+ +

The incremental zone transfer (IXFR) protocol is a way for slave servers to transfer only changed data, instead of having to transfer the entire zone. The IXFR protocol is specified in RFC 1995. See Proposed Standards.

-

+ +

When acting as a master, BIND 9 supports IXFR for those zones where the necessary change history information is available. These @@ -262,24 +285,27 @@ ixfr-from-differences is set to yes.

-

+ +

When acting as a slave, BIND 9 will attempt to use IXFR unless it is explicitly disabled. For more information about disabling IXFR, see the description of the request-ixfr clause of the server statement.

-
-
+
+ +

Split DNS

-

+ +

Setting up different views, or visibility, of the DNS space to internal and external resolvers is usually referred to as a Split DNS setup. There are several reasons an organization would want to set up its DNS this way.

-

+

One common reason for setting up a DNS system this way is to hide "internal" DNS information from "external" clients on the Internet. There is some debate as to whether or not this is actually @@ -293,17 +319,17 @@ choose to use a Split DNS to present a consistent view of itself to the outside world.

-

+

Another common reason for setting up a Split DNS system is to allow internal networks that are behind filters or in RFC 1918 space (reserved IP space, as documented in RFC 1918) to resolve DNS on the Internet. Split DNS can also be used to allow mail from outside back in to the internal network.

-
+

Example split DNS setup

-

+

Let's say a company named Example, Inc. (example.com) has several corporate sites that have an internal network with @@ -311,14 +337,14 @@ Internet Protocol (IP) space and an external demilitarized zone (DMZ), or "outside" section of a network, that is available to the public.

-

+

Example, Inc. wants its internal clients to be able to resolve external hostnames and to exchange mail with people on the outside. The company also wants its internal resolvers to have access to certain internal-only zones that are not available at all outside of the internal network.

-

+

In order to accomplish this, the company will set up two sets of name servers. One set will be on the inside network (in the reserved @@ -326,7 +352,7 @@ "proxy" hosts that can talk to both sides of its network, in the DMZ.

-

+

The internal servers will be configured to forward all queries, except queries for site1.internal, site2.internal, site1.example.com, and site2.example.com, to the servers @@ -335,20 +361,20 @@ for site1.example.com, site2.example.com, site1.internal, and site2.internal.

-

+

To protect the site1.internal and site2.internal domains, the internal name servers must be configured to disallow all queries to these domains from any external hosts, including the bastion hosts.

-

+

The external servers, which are on the bastion hosts, will be configured to serve the "public" version of the site1 and site2.example.com zones. This could include things such as the host records for public servers (www.example.com and ftp.example.com), and mail exchange (MX) records (a.mx.example.com and b.mx.example.com).

-

+

In addition, the public site1 and site2.example.com zones should have special MX records that contain wildcard (`*') records pointing to the bastion hosts. This is needed because external mail @@ -357,11 +383,11 @@ be delivered to the bastion host, which can then forward it on to internal hosts.

-

+

Here's an example of a wildcard MX record:

-
*   IN MX 10 external1.example.com.
-

+ 

*   IN MX 10 external1.example.com.
+

Now that they accept mail on behalf of anything in the internal network, the bastion hosts will need to know how to deliver mail to internal hosts. In order for this to work properly, the resolvers @@ -369,57 +395,72 @@ the bastion hosts will need to be configured to point to the internal name servers for DNS resolution.

-

+

Queries for internal hostnames will be answered by the internal servers, and queries for external hostnames will be forwarded back out to the DNS servers on the bastion hosts.

-

+

In order for all this to work properly, internal clients will need to be configured to query only the internal name servers for DNS queries. This could also be enforced via selective filtering on the network.

-

+

If everything has been set properly, Example, Inc.'s internal clients will now be able to:

-
    +
    • + Look up any hostnames in the site1 and site2.example.com zones. -
      • + +
    • + Look up any hostnames in the site1.internal and site2.internal domains. -
      • -
    • Look up any hostnames on the Internet.
      • -
    • Exchange mail with both internal and external people.
      • + + +
    • + Look up any hostnames on the Internet. +
      • +
    • + Exchange mail with both internal and external people. +
    -

    +

    Hosts on the Internet will be able to:

    -
      +
      • + Look up any hostnames in the site1 and site2.example.com zones. -
        • + +
      • + Exchange mail with anyone in the site1 and site2.example.com zones. -
        • + +
      -

      + +

      Here is an example configuration for the setup we just described above. Note that this is only configuration information; for information on how to configure your zone files, see the section called “Sample Configurations”.

      -

      + +

      Internal DNS server config:

      + 
       
 acl internals { 172.16.72.0/24; 192.168.1.0/24; };
@@ -481,9 +522,11 @@ zone "site2.internal" {
   allow-transfer { internals; }
 };
      -

      + +

      External (bastion host) DNS server config:

      + 
       acl internals { 172.16.72.0/24; 192.168.1.0/24; };
 
@@ -518,22 +561,26 @@ zone "site2.example.com" {
   allow-transfer { internals; externals; }
 };
      -

      + +

      In the resolv.conf (or equivalent) on the bastion host(s):

      + 
       search ...
 nameserver 172.16.72.2
 nameserver 172.16.72.3
 nameserver 172.16.72.4
      -
    -
-
+ +
+
+

TSIG

-

+ +

TSIG (Transaction SIGnatures) is a mechanism for authenticating DNS messages, originally specified in RFC 2845. It allows DNS messages to be cryptographically signed using a shared secret. TSIG can @@ -544,12 +591,12 @@ nameserver 172.16.72.4 is critical to the integrity of the server, such as with dynamic UPDATE messages or zone transfers from a master to a slave server.

-

+

This is a guide to setting up TSIG in BIND. It describes the configuration syntax and the process of creating TSIG keys.

-

+

named supports TSIG for server-to-server communication, and some of the tools included with BIND support it for sending messages to @@ -557,31 +604,32 @@ nameserver 172.16.72.4

  • -nsupdate(1) supports TSIG via the + nsupdate(1) supports TSIG via the -k, -l and -y command line options, or via the key command when running interactively.
  • -dig(1) supports TSIG via the + dig(1) supports TSIG via the -k and -y command line options.

-
+ +

Generating a Shared Key

-

+

TSIG keys can be generated using the tsig-keygen command; the output of the command is a key directive suitable for inclusion in named.conf. The key name, algorithm and size can be specified by command line parameters; the defaults are "tsig-key", HMAC-SHA256, and 256 bits, respectively.

-

+

Any string which is a valid DNS name can be used as a key name. For example, a key to be shared between servers called host1 and host2 could @@ -590,25 +638,26 @@ nameserver 172.16.72.4 

   $ tsig-keygen host1-host2. > host1-host2.key
-

+

This key may then be copied to both hosts. The key name and secret must be identical on both hosts. (Note: copying a shared secret from one server to another is beyond the scope of the DNS. A secure transport mechanism should be used: secure FTP, SSL, ssh, telephone, encrypted email, etc.)

-

+

tsig-keygen can also be run as ddns-confgen, in which case its output includes additional configuration text for setting up dynamic DNS in named. See ddns-confgen(8) for details.

-
-
+
+ +

Loading A New Key

-

+

For a key shared between servers called host1 and host2, the following could be added to each server's @@ -620,11 +669,11 @@ key "host1-host2." { secret "DAopyf1mhCbFVZw7pgmNPBoLUq8wEUT7UuPoLENP2HY="; }; -

+

(This is the same key generated above using tsig-keygen.)

-

+

Since this text contains a secret, it is recommended that either named.conf not be world-readable, or that the key directive @@ -632,26 +681,27 @@ key "host1-host2." { included in named.conf via the include directive.

-

+

Once a key has been added to named.conf and the server has been restarted or reconfigured, the server can recognize the key. If the server receives a message signed by the key, it will be able to verify the signature. If the signature is valid, the response will be signed using the same key.

-

+

TSIG keys that are known to a server can be listed using the command rndc tsig-list.

-
-
+
+ +

Instructing the Server to Use a Key

-

+

A server sending a request to another server must be told whether to use a key, and if so, which key to use.

-

+

For example, a key may be specified for each server in the masters statement in the definition of a slave zone; in this case, all SOA QUERY messages, NOTIFY @@ -661,7 +711,7 @@ key "host1-host2." { or slave zone, causing NOTIFY messages to be signed using the specified key.

-

+

Keys can also be specified in a server directive. Adding the following on host1, if the IP address of host2 is 10.1.2.3, would @@ -674,56 +724,58 @@ server 10.1.2.3 { keys { host1-host2. ;}; }; -

+

Multiple keys may be present in the keys statement, but only the first one is used. As this directive does not contain secrets, it can be used in a world-readable file.

-

+

Requests sent by host2 to host1 would not be signed, unless a similar server directive were in host2's configuration file.

-

+

Whenever any server sends a TSIG-signed DNS request, it will expect the response to be signed with the same key. If a response is not signed, or if the signature is not valid, the response will be rejected.

-
-
+
+ +

TSIG-Based Access Control

-

+

TSIG keys may be specified in ACL definitions and ACL directives such as allow-query, allow-transfer and allow-update. The above key would be denoted in an ACL element as key host1-host2.

-

+

An example of an allow-update directive using a TSIG key: 

 allow-update { !{ !localnets; any; }; key host1-host2. ;};
-

+

This allows dynamic updates to succeed only if the UPDATE request comes from an address in localnets, and if it is signed using the host1-host2. key.

-

+

See the section called “Dynamic Update Policies” for a discussion of the more flexible update-policy statement.

-
-
+
+ +

Errors

-

+

Processing of TSIG-signed messages can result in several errors:

    @@ -749,23 +801,25 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; In all of the above cases, the server will return a response code of NOTAUTH (not authenticated).

    -
-
-
+
+
+ +

TKEY

-

+ +

TKEY (Transaction KEY) is a mechanism for automatically negotiating a shared secret between two hosts, originally specified in RFC 2930.

-

+

There are several TKEY "modes" that specify how a key is to be generated or assigned. BIND 9 implements only one of these modes: Diffie-Hellman key exchange. Both hosts are required to have a KEY record with algorithm DH (though this record is not required to be present in a zone).

-

+

The TKEY process is initiated by a client or server by sending a query of type TKEY to a TKEY-aware server. The query must include an appropriate KEY record in the additional section, and @@ -777,51 +831,55 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; can then be used by to sign subsequent transactions between the two servers.

-

+

TSIG keys known by the server, including TKEY-negotiated keys, can be listed using rndc tsig-list.

-

+

TKEY-negotiated keys can be deleted from a server using rndc tsig-delete. This can also be done via the TKEY protocol itself, by sending an authenticated TKEY query specifying the "key deletion" mode.

-
-
+ +
+

SIG(0)

-

+ +

BIND partially supports DNSSEC SIG(0) transaction signatures as specified in RFC 2535 and RFC 2931. SIG(0) uses public/private keys to authenticate messages. Access control is performed in the same manner as TSIG keys; privileges can be granted or denied in ACL directives based on the key name.

-

+

When a SIG(0) signed message is received, it will only be verified if the key is known and trusted by the server. The server will not attempt to recursively fetch or validate the key.

-

+

SIG(0) signing of multiple-message TCP streams is not supported.

-

+

The only tool shipped with BIND 9 that generates SIG(0) signed messages is nsupdate.

-
-
+
+ +

DNSSEC

-

+

Cryptographic authentication of DNS information is possible through the DNS Security (DNSSEC-bis) extensions, defined in RFC 4033, RFC 4034, and RFC 4035. This section describes the creation and use of DNSSEC signed zones.

-

+ +

In order to set up a DNSSEC secure zone, there are a series of steps which must be followed. BIND 9 ships @@ -834,7 +892,8 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; that the tools shipped with BIND 9.2.x and earlier are not compatible with the current ones.

-

+ +

There must also be communication with the administrators of the parent and/or child zone to transmit keys. A zone's security status must be indicated by the parent zone for a DNSSEC capable @@ -843,19 +902,23 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; delegation point.

-

+ +

For other servers to trust data in this zone, they must either be statically configured with this zone's zone key or the zone key of another zone above this one in the DNS tree.

-
+ +

Generating Keys

-

+ +

The dnssec-keygen program is used to generate keys.

-

+ +

A secure zone must contain one or more zone keys. The zone keys will sign all other records in the zone, as well as the zone keys of any secure delegated zones. Zone keys must @@ -866,14 +929,17 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; designated as "mandatory to implement" by the IETF; currently the only one is RSASHA1.

-

+ +

The following command will generate a 768-bit RSASHA1 key for the child.example zone:

-

+ +

dnssec-keygen -a RSASHA1 -b 768 -n ZONE child.example.

-

+ +

Two output files will be produced: Kchild.example.+005+12345.key and Kchild.example.+005+12345.private @@ -889,29 +955,35 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; .key file) is used for signature verification.

-

+ +

To generate another key with the same properties (but with a different key tag), repeat the above command.

-

+ +

The dnssec-keyfromlabel program is used to get a key pair from a crypto hardware and build the key files. Its usage is similar to dnssec-keygen.

-

+ +

The public keys should be inserted into the zone file by including the .key files using $INCLUDE statements.

-
-
+ +
+

Signing the Zone

-

+ +

The dnssec-signzone program is used to sign a zone.

-

+ +

Any keyset files corresponding to secure subzones should be present. The zone signer will generate NSEC, NSEC3 @@ -921,16 +993,19 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; is not specified, then DS RRsets for the secure child zones need to be added manually.

-

+ +

The following command signs the zone, assuming it is in a file called zone.child.example. By default, all zone keys which have an available private key are used to generate signatures.

-

+ +

dnssec-signzone -o child.example zone.child.example

-

+ +

One output file is produced: zone.child.example.signed. This file @@ -938,31 +1013,37 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; as the input file for the zone.

-

dnssec-signzone + +

dnssec-signzone will also produce a keyset and dsset files and optionally a dlvset file. These are used to provide the parent zone administrators with the DNSKEYs (or their corresponding DS records) that are the secure entry point to the zone.

-
-
+ +
+ +

Configuring Servers

-

+ +

To enable named to respond appropriately to DNS requests from DNSSEC aware clients, dnssec-enable must be set to yes. (This is the default setting.)

-

+ +

To enable named to validate answers from other servers, the dnssec-enable option must be set to yes, and the dnssec-validation options must be set to yes or auto.

-

+ +

If dnssec-validation is set to auto, then a default trust anchor for the DNS root zone will be used. @@ -974,7 +1055,8 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; will not occur. The default setting is yes.

-

+ +

trusted-keys are copies of DNSKEY RRs for zones that are used to form the first link in the cryptographic chain of trust. All keys listed in @@ -982,23 +1064,27 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; are deemed to exist and only the listed keys will be used to validated the DNSKEY RRset that they are from.

-

+ +

managed-keys are trusted keys which are automatically kept up to date via RFC 5011 trust anchor maintenance.

-

+ +

trusted-keys and managed-keys are described in more detail later in this document.

-

+ +

Unlike BIND 8, BIND 9 does not verify signatures on load, so zone keys for authoritative zones do not need to be specified in the configuration file.

-

+ +

After DNSSEC gets established, a typical DNSSEC configuration will look something like the following. It has one or more public keys for the root. This allows answers from @@ -1008,6 +1094,7 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; is immune to compromises in the DNSSEC components of the security of parent zones.

+ 
 managed-keys {
         /* Root Key */
@@ -1060,61 +1147,71 @@ options {
         dnssec-validation yes;
 };
-
+ +

Note

None of the keys listed in this example are valid. In particular, the root key is not valid.

-

+ +

When DNSSEC validation is enabled and properly configured, the resolver will reject any answers from signed, secure zones which fail to validate, and will return SERVFAIL to the client.

-

+ +

Responses may fail to validate for any of several reasons, including missing, expired, or invalid signatures, a key which does not match the DS RRset in the parent zone, or an insecure response from a zone which, according to its parent, should have been secure.

-
+ +

Note

-

+

When the validator receives a response from an unsigned zone that has a signed parent, it must confirm with the parent that the zone was intentionally left unsigned. It does this by verifying, via signed and validated NSEC/NSEC3 records, that the parent zone contains no DS records for the child.

-

+

If the validator can prove that the zone is insecure, then the response is accepted. However, if it cannot, then it must assume an insecure response to be a forgery; it rejects the response and logs an error.

-

+

The logged error reads "insecurity proof failed" and "got insecure response; parent indicates it should be secure". (Prior to BIND 9.7, the logged error was "not insecure". This referred to the zone, not the response.)

-
-
-
-
+
+
+ +
+ +

DNSSEC, Dynamic Zones, and Automatic Signing

-

As of BIND 9.7.0 it is possible to change a dynamic zone + +

As of BIND 9.7.0 it is possible to change a dynamic zone from insecure to signed and back again. A secure zone can use either NSEC or NSEC3 chains.

-

-Converting from insecure to secure

-

Changing a zone from insecure to secure can be done in two +

+

+Converting from insecure to secure

+ +
+

Changing a zone from insecure to secure can be done in two ways: using a dynamic DNS update, or the auto-dnssec zone option.

-

For either method, you need to configure +

For either method, you need to configure named so that it can see the K* files which contain the public and private parts of the keys that will be used to sign the zone. These files @@ -1122,7 +1219,7 @@ options { dnssec-keygen. You can do this by placing them in the key-directory, as specified in named.conf:

-
+  
         zone example.net {
                 type master;
                 update-policy local;
@@ -1130,32 +1227,35 @@ options {
                 key-directory "dynamic/example.net";
         };
 

-
If one KSK and one ZSK DNSKEY key have been generated, this
+  
If one KSK and one ZSK DNSKEY key have been generated, this
   configuration will cause all records in the zone to be signed
   with the ZSK, and the DNSKEY RRset to be signed with the KSK as
   well. An NSEC chain will be generated as part of the initial
   signing process.

-

-Dynamic DNS update method

-
To insert the keys via dynamic update:

-
+  

+

+Dynamic DNS update method

+
+  

+  
To insert the keys via dynamic update:

+  
         % nsupdate
         > ttl 3600
         > update add example.net DNSKEY 256 3 7 AwEAAZn17pUF0KpbPA2c7Gz76Vb18v0teKT3EyAGfBfL8eQ8al35zz3Y I1m/SAQBxIqMfLtIwqWPdgthsu36azGQAX8=
         > update add example.net DNSKEY 257 3 7 AwEAAd/7odU/64o2LGsifbLtQmtO8dFDtTAZXSX2+X3e/UNlq9IHq3Y0 XtC0Iuawl/qkaKVxXe2lo8Ct+dM6UehyCqk=
         > send
 

-
While the update request will complete almost immediately,
+  
While the update request will complete almost immediately,
   the zone will not be completely signed until
   named has had time to walk the zone and
   generate the NSEC and RRSIG records. The NSEC record at the apex
   will be added last, to signal that there is a complete NSEC
   chain.

-
If you wish to sign using NSEC3 instead of NSEC, you should
+  
If you wish to sign using NSEC3 instead of NSEC, you should
   add an NSEC3PARAM record to the initial update request. If you
   wish the NSEC3 chain to have the OPTOUT bit set, set it in the
   flags field of the NSEC3PARAM record.

-
+  
         % nsupdate
         > ttl 3600
         > update add example.net DNSKEY 256 3 7 AwEAAZn17pUF0KpbPA2c7Gz76Vb18v0teKT3EyAGfBfL8eQ8al35zz3Y I1m/SAQBxIqMfLtIwqWPdgthsu36azGQAX8=
@@ -1163,29 +1263,32 @@ options {
         > update add example.net NSEC3PARAM 1 1 100 1234567890
         > send
 

-
Again, this update request will complete almost
+  
Again, this update request will complete almost
   immediately; however, the record won't show up until
   named has had a chance to build/remove the
   relevant chain. A private type record will be created to record
   the state of the operation (see below for more details), and will
   be removed once the operation completes.

-
While the initial signing and NSEC/NSEC3 chain generation
+  
While the initial signing and NSEC/NSEC3 chain generation
   is happening, other updates are possible as well.

-

-Fully automatic zone signing

-
To enable automatic signing, add the
+  

+

+Fully automatic zone signing

+
+  

+  
To enable automatic signing, add the
   auto-dnssec option to the zone statement in
   named.conf.
   auto-dnssec has two possible arguments:
   allow or
   maintain.

-
With
+  
With
   auto-dnssec allow,
   named can search the key directory for keys
   matching the zone, insert them into the zone, and use them to
   sign the zone. It will do so only when it receives an
   rndc sign <zonename>.

-

+  

   
   auto-dnssec maintain includes the above
   functionality, but will also automatically adjust the zone's
@@ -1193,7 +1296,7 @@ options {
   (See dnssec-keygen(8) and
   dnssec-settime(8) for more information.)
   

-

+  

   named will periodically search the key directory
   for keys matching the zone, and if the keys' metadata indicates
   that any change should be made the zone, such as adding, removing,
@@ -1203,21 +1306,21 @@ options {
   to a maximum of 24 hours.  The rndc loadkeys forces
   named to check for key updates immediately.
   

-

+  

   If keys are present in the key directory the first time the zone
   is loaded, the zone will be signed immediately, without waiting for an
   rndc sign or rndc loadkeys
   command. (Those commands can still be used when there are unscheduled
   key changes, however.)
   

-

+  

   When new keys are added to a zone, the TTL is set to match that
   of any existing DNSKEY RRset. If there is no existing DNSKEY RRset,
   then the TTL will be set to the TTL specified when the key was
   created (using the dnssec-keygen -L option), if
   any, or to the SOA TTL.
   

-

+  

   If you wish the zone to be signed using NSEC3 instead of NSEC,
   submit an NSEC3PARAM record via dynamic update prior to the
   scheduled publication and activation of the keys.  If you wish the
@@ -1227,25 +1330,28 @@ options {
   the zone is signed and the NSEC3 chain is completed, the NSEC3PARAM
   record will appear in the zone.
   

-
Using the
+  
Using the
   auto-dnssec option requires the zone to be
   configured to allow dynamic updates, by adding an
   allow-update or
   update-policy statement to the zone
   configuration. If this has not been done, the configuration will
   fail.

-

-Private-type records

-
The state of the signing process is signaled by
+  

+

+Private-type records

+
+  

+  
The state of the signing process is signaled by
   private-type records (with a default type value of 65534). When
   signing is complete, these records will have a nonzero value for
   the final octet (for those records which have a nonzero initial
   octet).

-
The private type record format: If the first octet is
+  
The private type record format: If the first octet is
   non-zero then the record indicates that the zone needs to be
   signed with the key matching the record, or that all signatures
   that match the record should be removed.

-

+  

     

 


 

@@ -1256,15 +1362,15 @@ options {
 

 

   

-
Only records flagged as "complete" can be removed via
+  
Only records flagged as "complete" can be removed via
   dynamic update. Attempts to remove other private type records
   will be silently ignored.

-
If the first octet is zero (this is a reserved algorithm
+  
If the first octet is zero (this is a reserved algorithm
   number that should never appear in a DNSKEY record) then the
   record indicates changes to the NSEC3 chains are in progress. The
   rest of the record contains an NSEC3PARAM record. The flag field
   tells what operation to perform based on the flag bits.

-

+  

     

 


 

@@ -1275,14 +1381,20 @@ options {
 

 

   

-

-DNSKEY rollovers

-
As with insecure-to-secure conversions, rolling DNSSEC
+  

+

+DNSKEY rollovers

+
+  

+  
As with insecure-to-secure conversions, rolling DNSSEC
   keys can be done in two ways: using a dynamic DNS update, or the
   auto-dnssec zone option.

-

-Dynamic DNS update method

-
 To perform key rollovers via dynamic update, you need to add
+  

+

+Dynamic DNS update method

+
+  

+  
 To perform key rollovers via dynamic update, you need to add
   the K* files for the new keys so that
   named can find them. You can then add the new
   DNSKEY RRs via dynamic update.
@@ -1290,21 +1402,24 @@ options {
   with the new keys. When the signing is complete the private type
   records will be updated so that the last octet is non
   zero.

-
If this is for a KSK you need to inform the parent and any
+  
If this is for a KSK you need to inform the parent and any
   trust anchor repositories of the new KSK.

-
You should then wait for the maximum TTL in the zone before
+  
You should then wait for the maximum TTL in the zone before
   removing the old DNSKEY. If it is a KSK that is being updated,
   you also need to wait for the DS RRset in the parent to be
   updated and its TTL to expire. This ensures that all clients will
   be able to verify at least one signature when you remove the old
   DNSKEY.

-
The old DNSKEY can be removed via UPDATE. Take care to
+  
The old DNSKEY can be removed via UPDATE. Take care to
   specify the correct key.
   named will clean out any signatures generated
   by the old key after the update completes.

-

-Automatic key rollovers

-
When a new key reaches its activation date (as set by
+  

+

+Automatic key rollovers

+
+  

+  
When a new key reaches its activation date (as set by
   dnssec-keygen or dnssec-settime),
   if the auto-dnssec zone option is set to
   maintain, named will
@@ -1317,51 +1432,69 @@ options {
   signature validity periods expire.  By default, this rollover
   completes in 30 days, after which it will be safe to remove the
   old key from the DNSKEY RRset.

-

-NSEC3PARAM rollovers via UPDATE

-
Add the new NSEC3PARAM record via dynamic update. When the
+  

+

+NSEC3PARAM rollovers via UPDATE

+
+  

+  
Add the new NSEC3PARAM record via dynamic update. When the
   new NSEC3 chain has been generated, the NSEC3PARAM flag field
   will be zero. At this point you can remove the old NSEC3PARAM
   record. The old chain will be removed after the update request
   completes.

-

-Converting from NSEC to NSEC3

-
To do this, you just need to add an NSEC3PARAM record. When
+  

+

+Converting from NSEC to NSEC3

+
+  

+  
To do this, you just need to add an NSEC3PARAM record. When
   the conversion is complete, the NSEC chain will have been removed
   and the NSEC3PARAM record will have a zero flag field. The NSEC3
   chain will be generated before the NSEC chain is
   destroyed.

-

-Converting from NSEC3 to NSEC

-
To do this, use nsupdate to
+  

+

+Converting from NSEC3 to NSEC

+
+  

+  
To do this, use nsupdate to
   remove all NSEC3PARAM records with a zero flag
   field. The NSEC chain will be generated before the NSEC3 chain is
   removed.

-

-Converting from secure to insecure

-
To convert a signed zone to unsigned using dynamic DNS,
+  

+

+Converting from secure to insecure

+
+  

+  
To convert a signed zone to unsigned using dynamic DNS,
   delete all the DNSKEY records from the zone apex using
   nsupdate. All signatures, NSEC or NSEC3 chains,
   and associated NSEC3PARAM records will be removed automatically.
   This will take place after the update request completes.

-
 This requires the
+  
 This requires the
   dnssec-secure-to-insecure option to be set to
   yes in
   named.conf.

-
In addition, if the auto-dnssec maintain
+  
In addition, if the auto-dnssec maintain
   zone statement is used, it should be removed or changed to
   allow instead (or it will re-sign).
   

-

-Periodic re-signing

-
In any secure zone which supports dynamic updates, named
+  

+

+Periodic re-signing

+
+  

+  
In any secure zone which supports dynamic updates, named
   will periodically re-sign RRsets which have not been re-signed as
   a result of some update action. The signature lifetimes will be
   adjusted so as to spread the re-sign load over time rather than
   all at once.

-

-NSEC3 and OPTOUT

-

+  

+

+NSEC3 and OPTOUT

+
+  

+  

   named only supports creating new NSEC3 chains
   where all the NSEC3 records in the zone have the same OPTOUT
   state.
@@ -1372,33 +1505,39 @@ options {
   changed if the OPTOUT state of an individual NSEC3 needs to be
   changed.
-
+ +

Dynamic Trust Anchor Management

-

BIND 9.7.0 introduces support for RFC 5011, dynamic trust + +

BIND 9.7.0 introduces support for RFC 5011, dynamic trust anchor management. Using this feature allows named to keep track of changes to critical DNSSEC keys without any need for the operator to make changes to configuration files.

-
+

Validating Resolver

-

To configure a validating resolver to use RFC 5011 to + + +

To configure a validating resolver to use RFC 5011 to maintain a trust anchor, configure the trust anchor using a managed-keys statement. Information about this can be found in the section called “managed-keys Statement Definition and Usage”.

-
-
+ +
+

Authoritative Server

-

To set up an authoritative zone for RFC 5011 trust anchor + +

To set up an authoritative zone for RFC 5011 trust anchor maintenance, generate two (or more) key signing keys (KSKs) for the zone. Sign the zone with one of them; this is the "active" KSK. All KSK's which do not sign the zone are "stand-by" keys.

-

Any validating resolver which is configured to use the +

Any validating resolver which is configured to use the active KSK as an RFC 5011-managed trust anchor will take note of the stand-by KSKs in the zone's DNSKEY RRset, and store them for future reference. The resolver will recheck the zone @@ -1407,7 +1546,7 @@ options { anchor for the zone. Any time after this 30-day acceptance timer has completed, the active KSK can be revoked, and the zone can be "rolled over" to the newly accepted key.

-

The easiest way to place a stand-by key in a zone is to +

The easiest way to place a stand-by key in a zone is to use the "smart signing" features of dnssec-keygen and dnssec-signzone. If a key with a publication @@ -1415,54 +1554,56 @@ options { the future, " dnssec-signzone -S" will include the DNSKEY record in the zone, but will not sign with it:

-
+    
 $ dnssec-keygen -K keys -f KSK -P now -A now+2y example.net
 $ dnssec-signzone -S -K keys example.net
 

-
To revoke a key, the new command
+    
To revoke a key, the new command
     dnssec-revoke has been added. This adds the
     REVOKED bit to the key flags and re-generates the
     K*.key and
     K*.private files.

-
After revoking the active key, the zone must be signed
+    
After revoking the active key, the zone must be signed
     with both the revoked KSK and the new active KSK. (Smart
     signing takes care of this automatically.)

-
Once a key has been revoked and used to sign the DNSKEY
+    
Once a key has been revoked and used to sign the DNSKEY
     RRset in which it appears, that key will never again be
     accepted as a valid trust anchor by the resolver. However,
     validation can proceed using the new active key (which had been
     accepted by the resolver when it was a stand-by key).

-
See RFC 5011 for more details on key rollover
+    
See RFC 5011 for more details on key rollover
     scenarios.

-
When a key has been revoked, its key ID changes,
+    
When a key has been revoked, its key ID changes,
     increasing by 128, and wrapping around at 65535. So, for
     example, the key "Kexample.com.+005+10000" becomes
     "Kexample.com.+005+10128".

-
If two keys have ID's exactly 128 apart, and one is
+    
If two keys have ID's exactly 128 apart, and one is
     revoked, then the two key ID's will collide, causing several
     problems. To prevent this,
     dnssec-keygen will not generate a new key if
     another key is present which may collide. This checking will
     only occur if the new keys are written to the same directory
     which holds all other keys in use for that zone.

-
Older versions of BIND 9 did not have this precaution.
+    
Older versions of BIND 9 did not have this precaution.
     Exercise caution if using key revocation on keys that were
     generated by previous releases, or if using keys stored in
     multiple directories or on multiple machines.

-
It is expected that a future release of BIND 9 will
+    
It is expected that a future release of BIND 9 will
     address this problem in a different way, by storing revoked
     keys with their original unrevoked key ID's.

+
-
-
+ +

PKCS#11 (Cryptoki) support

-

+ +

PKCS#11 (Public Key Cryptography Standard #11) defines a platform-independent API for the control of hardware security modules (HSMs) and other cryptographic support devices.

-

+

BIND 9 is known to work with three HSMs: The AEP Keyper, which has been tested with Debian Linux, Solaris x86 and Windows Server 2003; the Thales nShield, tested with Debian Linux; and the Sun SCA 6000 @@ -1471,13 +1612,13 @@ $ dnssec-signzone -S -K keys example.net< a software-based HSM simulator library produced by the OpenDNSSEC project.

-

+

PKCS#11 makes use of a "provider library": a dynamically loadable library which provides a low-level PKCS#11 interface to drive the HSM hardware. The PKCS#11 provider library comes from the HSM vendor, and it is specific to the HSM to be controlled.

-

+

There are two available mechanisms for PKCS#11 support in BIND 9: OpenSSL-based PKCS#11 and native PKCS#11. When using the first mechanism, BIND uses a modified version of OpenSSL, which loads @@ -1487,19 +1628,21 @@ $ dnssec-signzone -S -K keys example.net< OpenSSL completely; BIND loads the provider library itself, and uses the PKCS#11 API to drive the HSM directly.

-
+

Prerequisites

-

+ +

See the documentation provided by your HSM vendor for information about installing, initializing, testing and troubleshooting the HSM.

-
-
+
+

Native PKCS#11

-

+ +

Native PKCS#11 mode will only work with an HSM capable of carrying out every cryptographic operation BIND 9 may need. The HSM's provider library must have a complete implementation @@ -1511,15 +1654,15 @@ $ dnssec-signzone -S -K keys example.net< native PKCS#11, it is expected that OpenSSL-based PKCS#11 will be deprecated.)

-

+

To build BIND with native PKCS#11, configure as follows:

-
+    
 $ cd bind9
 $ ./configure --enable-native-pkcs11 \
     --with-pkcs11=provider-library-path
     

-

+    

       This will cause all BIND tools, including named
       and the dnssec-* and pkcs11-*
       tools, to use the PKCS#11 provider library specified in
@@ -1529,10 +1672,11 @@ $ ./configure --enable-native-pkcs11 \
       dnssec-* tools, or the -m in
       the pkcs11-* tools.)
     

-

+    

 

 Building SoftHSMv2

-

+
+      

 	SoftHSMv2, the latest development version of SoftHSM, is available
 	from
 	
@@ -1550,7 +1694,7 @@ $ ./configure --enable-native-pkcs11 \
 	cryptographic functions, but when using it for native PKCS#11 in
 	BIND, OpenSSL is required.
       

-

+      

 	By default, the SoftHSMv2 configuration file is
 	prefix/etc/softhsm2.conf (where
 	prefix is configured at compile time).
@@ -1558,19 +1702,20 @@ $ ./configure --enable-native-pkcs11 \
 	variable.  The SoftHSMv2 cryptographic store must be installed and
 	initialized before using it with BIND.
       

-
+      
 $  cd SoftHSMv2 
 $  configure --with-crypto-backend=openssl --prefix=/opt/pkcs11/usr --enable-gost 
 $  make 
 $  make install 
 $  /opt/pkcs11/usr/bin/softhsm-util --init-token 0 --slot 0 --label softhsmv2 
       

-

-

-

+    

+
+

OpenSSL-based PKCS#11

-

+ +

OpenSSL-based PKCS#11 mode uses a modified version of the OpenSSL library; stock OpenSSL does not fully support PKCS#11. ISC provides a patch to OpenSSL to correct this. This patch is @@ -1578,20 +1723,23 @@ $ /opt/pkcs11/usr/bin/softhsm-util --init-token modified by ISC to provide new features such as PIN management and key-by-reference.

-

+

There are two "flavors" of PKCS#11 support provided by the patched OpenSSL, one of which must be chosen at configuration time. The correct choice depends on the HSM hardware:

-
    -

  • +

      +
    • +

      Use 'crypto-accelerator' with HSMs that have hardware cryptographic acceleration features, such as the SCA 6000 board. This causes OpenSSL to run all supported cryptographic operations in the HSM. -

      • -

    • +

      +
      • +
    • +

      Use 'sign-only' with HSMs that are designed to function primarily as secure key storage devices, but lack hardware acceleration. These devices are highly secure, but @@ -1602,9 +1750,10 @@ $ /opt/pkcs11/usr/bin/softhsm-util --init-token such as zone signing, and to use the system CPU for all other computationally-intensive operations. The AEP Keyper is an example of such a device. -

      • +

      +
    -

    +

    The modified OpenSSL code is included in the BIND 9 release, in the form of a context diff against the latest versions of OpenSSL. OpenSSL 0.9.8, 1.0.0, 1.0.1 and 1.0.2 are supported; @@ -1612,7 +1761,7 @@ $ /opt/pkcs11/usr/bin/softhsm-util --init-token follow, we use OpenSSL 0.9.8, but the same methods work with OpenSSL 1.0.0 through 1.0.2.

    -
    +

    Note

    The OpenSSL patches as of this writing (January 2016) @@ -1622,27 +1771,28 @@ $ /opt/pkcs11/usr/bin/softhsm-util --init-token is expected to change.

    -

    +

    Before building BIND 9 with PKCS#11 support, it will be necessary to build OpenSSL with the patch in place, and configure it with the path to your HSM's PKCS#11 provider library.

    -
    +

    Patching OpenSSL

    -
    +
+      
     $ wget http://www.openssl.org/source/openssl-0.9.8zc.tar.gz
   
    
-
    Extract the tarball:
    
-
    +      
    Extract the tarball:
    
+      
     $ tar zxf openssl-0.9.8zc.tar.gz
 
    
-
    Apply the patch from the BIND 9 release:
    
-
    +      
    Apply the patch from the BIND 9 release:
    
+      
     $ patch -p1 -d openssl-0.9.8zc \
 	      < bind9/bin/pkcs11/openssl-0.9.8zc-patch
 
    
-
    
+      
    
 
    Note
    
 
    
 	The patch file may not be compatible with the
@@ -1650,87 +1800,93 @@ $ patch -p1 -d openssl-0.9.8zc \
 	install GNU patch.
       
    
 
    
-
    
+      
    
 	When building OpenSSL, place it in a non-standard
 	location so that it does not interfere with OpenSSL libraries
 	elsewhere on the system. In the following examples, we choose
 	to install into "/opt/pkcs11/usr". We will use this location
 	when we configure BIND 9.
       
    
-
    
+      
    
 	Later, when building BIND 9, the location of the custom-built
 	OpenSSL library will need to be specified via configure.
       
    
-
    
-
    
+    
    
+    
    
 
    
 Building OpenSSL for the AEP Keyper on Linux
    
-
    
+      
+
+      
    
 	The AEP Keyper is a highly secure key storage device,
 	but does not provide hardware cryptographic acceleration. It
 	can carry out cryptographic operations, but it is probably
 	slower than your system's CPU. Therefore, we choose the
 	'sign-only' flavor when building OpenSSL.
       
    
-
    
+      
    
 	The Keyper-specific PKCS#11 provider library is
 	delivered with the Keyper software. In this example, we place
 	it /opt/pkcs11/usr/lib:
       
    
-
    +      
     $ cp pkcs11.GCC4.0.2.so.4.05 /opt/pkcs11/usr/lib/libpkcs11.so
 
    
-
    
+      
    
 	The Keyper library requires threads, so we
 	must specify -pthread.
       
    
-
    +      
     $ cd openssl-0.9.8zc
 $ ./Configure linux-x86_64 -pthread \
 	    --pk11-libname=/opt/pkcs11/usr/lib/libpkcs11.so \
 	    --pk11-flavor=sign-only \
 	    --prefix=/opt/pkcs11/usr
 
    
-
    
+      
    
 	After configuring, run "make"
 	and "make test". If "make
 	test" fails with "pthread_atfork() not found", you forgot to
 	add the -pthread above.
       
    
-
    
-
    
+    
    
+    
    
 
    
 Building OpenSSL for the SCA 6000 on Solaris
    
-
    
+      
+
+      
    
 	The SCA-6000 PKCS#11 provider is installed as a system
 	library, libpkcs11. It is a true crypto accelerator, up to 4
 	times faster than any CPU, so the flavor shall be
 	'crypto-accelerator'.
       
    
-
    
+      
    
 	In this example, we are building on Solaris x86 on an
 	AMD64 system.
       
    
-
    +      
     $ cd openssl-0.9.8zc
 $ ./Configure solaris64-x86_64-cc \
 	    --pk11-libname=/usr/lib/64/libpkcs11.so \
 	    --pk11-flavor=crypto-accelerator \
 	    --prefix=/opt/pkcs11/usr
 
    
-
    
+      
    
 	(For a 32-bit build, use "solaris-x86-cc" and /usr/lib/libpkcs11.so.)
       
    
-
    
+      
    
 	After configuring, run
 	make and
 	make test.
       
    
-
    
-
    
+    
    
+    
    
 
    
 Building OpenSSL for SoftHSM
    
-
    
+      
+
+      
    
 	SoftHSM (version 1) is a software library developed by the
 	OpenDNSSEC project
 	(
@@ -1743,13 +1899,13 @@ $ ./Configure solaris64-x86_64-cc \
 	less secure than a true HSM, it can allow you to experiment
 	with PKCS#11 when an HSM is not available.
       
    
-
    
+      
    
 	The SoftHSM cryptographic store must be installed and
 	initialized before using it with OpenSSL, and the SOFTHSM_CONF
 	environment variable must always point to the SoftHSM configuration
 	file:
       
    
-
    +      
     $  cd softhsm-1.3.7 
 $  configure --prefix=/opt/pkcs11/usr 
 $  make 
@@ -1758,111 +1914,118 @@ $  export SOFTHSM_CONF=/opt/pkcs11/softhsm.conf
 $  echo "0:/opt/pkcs11/softhsm.db" > $SOFTHSM_CONF 
 $  /opt/pkcs11/usr/bin/softhsm --init-token 0 --slot 0 --label softhsm 
 
    
-
    
+      
    
 	SoftHSM can perform all cryptographic operations, but
 	since it only uses your system CPU, there is no advantage to using
 	it for anything but signing.  Therefore, we choose the 'sign-only'
 	flavor when building OpenSSL.
       
    
-
    +      
     $ cd openssl-0.9.8zc
 $ ./Configure linux-x86_64 -pthread \
 	    --pk11-libname=/opt/pkcs11/usr/lib/libsofthsm.so \
 	    --pk11-flavor=sign-only \
 	    --prefix=/opt/pkcs11/usr
 
    
-
    
+      
    
 	After configuring, run "make"
 	and "make test".
       
    
-
    
-
    
+
    +

    Once you have built OpenSSL, run "apps/openssl engine pkcs11" to confirm that PKCS#11 support was compiled in correctly. The output should be one of the following lines, depending on the flavor selected:

    -
    +    
     	(pkcs11) PKCS #11 engine support (sign only)
 
    
-
    Or:
    
-
    +    
    Or:
    
+    
     	(pkcs11) PKCS #11 engine support (crypto accelerator)
 
    
-
    
+    
    
       Next, run
       "apps/openssl engine pkcs11 -t". This will
       attempt to initialize the PKCS#11 engine. If it is able to
       do so successfully, it will report
       “[ available ]”.
     
    
-
    
+    
    
       If the output is correct, run
       "make install" which will install the
       modified OpenSSL suite to /opt/pkcs11/usr.
     
    
-
    
+    
    
 
    
-
    
+      
+
+      
    
 	To link with the PKCS#11 provider, threads must be
 	enabled in the BIND 9 build.
       
    
-
    +      
     $ cd ../bind9
 $ ./configure --enable-threads \
 	   --with-openssl=/opt/pkcs11/usr \
 	   --with-pkcs11=/opt/pkcs11/usr/lib/libpkcs11.so
 
    
-
    
-
    
+    
    
+    
    
 
    
 Configuring BIND 9 for Solaris with the SCA 6000
    
-
    
+      
+
+      
    
 	To link with the PKCS#11 provider, threads must be
 	enabled in the BIND 9 build.
       
    
-
    +      
     $ cd ../bind9
 $ ./configure CC="cc -xarch=amd64" --enable-threads \
 	    --with-openssl=/opt/pkcs11/usr \
 	    --with-pkcs11=/usr/lib/64/libpkcs11.so
 
    
-
    (For a 32-bit build, omit CC="cc -xarch=amd64".)
    
-
    
+      
    (For a 32-bit build, omit CC="cc -xarch=amd64".)
    
+      
    
 	If configure complains about OpenSSL not working, you
 	may have a 32/64-bit architecture mismatch. Or, you may have
 	incorrectly specified the path to OpenSSL (it should be the
 	same as the --prefix argument to the OpenSSL
 	Configure).
       
    
-
    
-
    
+    
    
+    
    
 
    
 Configuring BIND 9 for SoftHSM
    
-
    +      
+
+      
     $ cd ../bind9
 $ ./configure --enable-threads \
 	   --with-openssl=/opt/pkcs11/usr \
 	   --with-pkcs11=/opt/pkcs11/usr/lib/libsofthsm.so
 
    
-
    
-
    
+    
    
+    
    
       After configuring, run
       "make",
       "make test" and
       "make install".
     
    
-
    
+    
    
       (Note: If "make test" fails in the "pkcs11" system test, you may
       have forgotten to set the SOFTHSM_CONF environment variable.)
     
    
-
    -
    +
    +

    PKCS#11 Tools

    -

    + +

    BIND 9 includes a minimal set of tools to operate the HSM, including pkcs11-keygen to generate a new key pair @@ -1872,7 +2035,7 @@ $ ./configure --enable-threads \ pkcs11-destroy to remove objects, and pkcs11-tokens to list available tokens.

    -

    +

    In UNIX/Linux builds, these tools are built only if BIND 9 is configured with the --with-pkcs11 option. (Note: If --with-pkcs11 is set to "yes", rather than to the path of the @@ -1881,24 +2044,25 @@ $ ./configure --enable-threads \ PKCS11_PROVIDER environment variable to specify the path to the provider.)

    -
    -
    +
    +

    Using the HSM

    -

    + +

    For OpenSSL-based PKCS#11, we must first set up the runtime environment so the OpenSSL and PKCS#11 libraries can be loaded:

    -
    +    
     $ export LD_LIBRARY_PATH=/opt/pkcs11/usr/lib:${LD_LIBRARY_PATH}
 
    
-
    
+    
    
       This causes named and other binaries to load
       the OpenSSL library from /opt/pkcs11/usr/lib
       rather than from the default location.  This step is not necessary
       when using native PKCS#11.
     
    
-
    
+    
    
       Some HSMs require other environment variables to be set.
       For example, when operating an AEP Keyper, it is necessary to
       specify the location of the "machine" file, which stores
@@ -1907,10 +2071,10 @@ $ export LD_LIBRARY_PATH=/opt/pkcs11/usr/lib:${L
       /opt/Keyper/PKCS11Provider/machine,
       use:
     
    
-
    +    
     $ export KEYPER_LIBRARY_PATH=/opt/Keyper/PKCS11Provider
 
    
-
    
+    
    
       Such environment variables must be set whenever running
       any tool that uses the HSM, including
       pkcs11-keygen,
@@ -1921,31 +2085,31 @@ $ export KEYPER_LIBRARY_PATH=/opt/Keyper/PKCS11P
       dnssec-keygen, and
       named.
     
    
-
    
+    
    
       We can now create and use keys in the HSM. In this case,
       we will create a 2048 bit key and give it the label
       "sample-ksk":
     
    
-
    +    
     $ pkcs11-keygen -b 2048 -l sample-ksk
 
    
-
    To confirm that the key exists:
    
-
    +    
    To confirm that the key exists:
    
+    
     $ pkcs11-list
 Enter PIN:
 object[0]: handle 2147483658 class 3 label[8] 'sample-ksk' id[0]
 object[1]: handle 2147483657 class 2 label[8] 'sample-ksk' id[0]
 
    
-
    
+    
    
       Before using this key to sign a zone, we must create a
       pair of BIND 9 key files. The "dnssec-keyfromlabel" utility
       does this. In this case, we will be using the HSM key
       "sample-ksk" as the key-signing key for "example.net":
     
    
-
    +    
     $ dnssec-keyfromlabel -l sample-ksk -f KSK example.net
 
    
-
    
+    
    
       The resulting K*.key and K*.private files can now be used
       to sign the zone. Unlike normal K* files, which contain both
       public and private key data, these files will contain only the
@@ -1953,31 +2117,31 @@ $ dnssec-keyfromlabel -l sample-ksk -f KSK examp
       remains stored within the HSM. Signing with the private key takes
       place inside the HSM.
     
    
-
    
+    
    
       If you wish to generate a second key in the HSM for use
       as a zone-signing key, follow the same procedure above, using a
       different keylabel, a smaller key size, and omitting "-f KSK"
       from the dnssec-keyfromlabel arguments:
     
    
-
    
+    
    
       (Note: When using OpenSSL-based PKCS#11 the label is an arbitrary
       string which identifies the key.  With native PKCS#11, the label is
       a PKCS#11 URI string which may include other details about the key
       and the HSM, including its PIN. See
       dnssec-keyfromlabel(8) for details.)
     
    
-
    +    
     $ pkcs11-keygen -b 1024 -l sample-zsk
 $ dnssec-keyfromlabel -l sample-zsk example.net
 
    
-
    
+    
    
       Alternatively, you may prefer to generate a conventional
       on-disk key, using dnssec-keygen:
     
    
-
    +    
     $ dnssec-keygen example.net
 
    
-
    
+    
    
       This provides less security than an HSM key, but since
       HSMs can be slow or cumbersome to use for security reasons, it
       may be more efficient to reserve HSM keys for use in the less
@@ -1987,13 +2151,13 @@ $ dnssec-keygen example.net
       there is no speed advantage to using on-disk keys, as cryptographic
       operations will be done by the HSM regardless.)
     
    
-
    
+    
    
       Now you can sign the zone. (Note: If not using the -S
       option to dnssec-signzone, it will be
       necessary to add the contents of both K*.key
       files to the zone master file before signing it.)
     
    
-
    +    
     $ dnssec-signzone -S example.net
 Enter PIN:
 Verifying the zone using the following algorithms:
@@ -2002,11 +2166,12 @@ Zone signing complete:
 Algorithm: NSEC3RSASHA1: ZSKs: 1, KSKs: 1 active, 0 revoked, 0 stand-by
 example.net.signed
 
    
-
    -
    +
    +

    Specifying the engine on the command line

    -

    + +

    When using OpenSSL-based PKCS#11, the "engine" to be used by OpenSSL can be specified in named and all of the BIND dnssec-* tools by using the "-E @@ -2016,29 +2181,30 @@ example.net.signed for some reason you wish to use a different OpenSSL engine.

    -

    +

    If you wish to disable use of the "pkcs11" engine — for troubleshooting purposes, or because the HSM is unavailable — set the engine to the empty string. For example:

    -
    +    
     $ dnssec-signzone -E '' -S example.net
 
    
-
    
+    
    
       This causes
       dnssec-signzone to run as if it were compiled
       without the --with-pkcs11 option.
     
    
-
    
+    
    
       When built with native PKCS#11 mode, the "engine" option has a
       different meaning: it specifies the path to the PKCS#11 provider
       library.  This may be useful when testing a new provider library.
     
    
-
    -
    +
    +

    Running named with automatic zone re-signing

    -

    + +

    If you want named to dynamically re-sign zones using HSM keys, and/or to to sign new records inserted via nsupdate, then named must have access to the HSM PIN. In OpenSSL-based PKCS#11, @@ -2046,13 +2212,13 @@ $ dnssec-signzone -E '' -S example.net/opt/pkcs11/usr/ssl/openssl.cnf).

    -

    +

    The location of the openssl.cnf file can be overridden by setting the OPENSSL_CONF environment variable before running named.

    -

    Sample openssl.cnf:

    -
    +    
    Sample openssl.cnf:
    
+    
     	openssl_conf = openssl_def
 	[ openssl_def ]
 	engines = engine_section
@@ -2061,40 +2227,42 @@ $ dnssec-signzone -E '' -S example.net<PLACE PIN HERE>
 
    
-
    
+    
    
       This will also allow the dnssec-* tools to access the HSM
       without PIN entry. (The pkcs11-* tools access the HSM directly,
       not via OpenSSL, so a PIN will still be required to use
       them.)
     
    
-
    
+    
    
       In native PKCS#11 mode, the PIN can be provided in a file specified
       as an attribute of the key's label.  For example, if a key had the label
       pkcs11:object=local-zsk;pin-source=/etc/hsmpin,
       then the PIN would be read from the file
       /etc/hsmpin.
     
    
-
    
+    
    
 
    Warning
    
-
    
+      
    
 	Placing the HSM's PIN in a text file in this manner may reduce the
 	security advantage of using an HSM. Be sure this is what you want to
 	do before configuring the system in this way.
       
    
+    
    
+
    -
    -
-
+ +

DLZ (Dynamically Loadable Zones)

-

+ +

DLZ (Dynamically Loadable Zones) is an extension to BIND 9 that allows zone data to be retrieved directly from an external database. There is no required format or schema. DLZ drivers exist for several different database backends including PostgreSQL, MySQL, and LDAP and can be written for any other.

-

+

Historically, DLZ drivers had to be statically linked with the named binary and were turned on via a configure option at compile time (for example, "configure --with-dlz-ldap"). @@ -2102,7 +2270,7 @@ $ dnssec-signzone -E '' -S example.netcontrib/dlz/drivers are still linked this way.

-

+

In BIND 9.8 and higher, it is possible to link some DLZ modules dynamically at runtime, via the DLZ "dlopen" driver, which acts as a generic wrapper around a shared object implementing the DLZ API. The @@ -2111,7 +2279,8 @@ $ dnssec-signzone -E '' -S example.netcontrib/dlz/drivers.

-

+ +

When the DLZ module provides data to named, it does so in text format. The response is converted to DNS wire format by named. This conversion, and the lack of any internal caching, places significant @@ -2122,20 +2291,22 @@ $ dnssec-signzone -E '' -S example.net -

+ +

Configuring DLZ

-

+ +

A DLZ database is configured with a dlz statement in named.conf:

-
+    
     dlz example {
 	database "dlopen driver.so args";
 	search yes;
     };
     

-

+    

       This specifies a DLZ module to search when answering queries; the
       module is implemented in driver.so and is
       loaded at runtime by the dlopen DLZ driver.  Multiple
@@ -2145,11 +2316,11 @@ $ dnssec-signzone -E '' -S example.net
-

+    

       The search option in the above example can be
       omitted, because yes is the default value.
     

-

+    

       If search is set to no, then
       this DLZ module is not searched for the best
       match when a query is received.  Instead, zones in this DLZ must be
@@ -2159,7 +2330,7 @@ $ dnssec-signzone -E '' -S example.net
-
+    
     dlz other {
 	database "dlopen driver.so args";
 	search no;
@@ -2170,11 +2341,12 @@ $ dnssec-signzone -E '' -S example.net
-
-
+
+

Sample DLZ Driver

-

+ +

For guidance in implementation of DLZ modules, the directory contrib/dlz/example contains a basic dynamically-linkable DLZ module--i.e., one which can be @@ -2183,25 +2355,25 @@ $ dnssec-signzone -E '' -S example.netdlz statement:

-
+    
     dlz other {
 	database "dlopen driver.so example.nil";
     };
     

-

+    

       In the above example, the module is configured to create a zone
       "example.nil", which can answer queries and AXFR requests, and
       accept DDNS updates.  At runtime, prior to any updates, the zone
       contains an SOA, NS, and a single A record at the apex:
     

-
+    
  example.nil.  3600    IN      SOA     example.nil. hostmaster.example.nil. (
 					       123 900 600 86400 3600
 				       )
  example.nil.  3600    IN      NS      example.nil.
  example.nil.  1800    IN      A       10.53.0.1
     

-

+    

       The sample driver is capable of retrieving information about the
       querying client, and altering its response on the basis of this
       information.  To demonstrate this feature, the example driver
@@ -2212,25 +2384,27 @@ $ dnssec-signzone -E '' -S example.net
-

+    

       Documentation of the DLZ module API can be found in
       contrib/dlz/example/README.  This directory also
       contains the header file dlz_minimal.h, which
       defines the API and should be included by any dynamically-linkable
       DLZ module.
     

+
-
-
+ +

IPv6 Support in BIND 9

-

+

BIND 9 fully supports all currently defined forms of IPv6 name to address and address to name lookups. It will also use IPv6 addresses to make queries when running on an IPv6 capable system.

-

+ +

For forward lookups, BIND 9 supports only AAAA records. RFC 3363 deprecated the use of A6 records, and client-side support for A6 records was accordingly removed @@ -2240,7 +2414,8 @@ $ dnssec-signzone -E '' -S example.net -

+ +

For IPv6 reverse lookups, BIND 9 supports the traditional "nibble" format used in the ip6.arpa domain, as well as the older, deprecated @@ -2255,33 +2430,39 @@ $ dnssec-signzone -E '' -S example.netBIND 9 name server will not load a zone file containing binary labels.

-

+ +

For an overview of the format and structure of IPv6 addresses, see the section called “IPv6 addresses (AAAA)”.

-
+ +

Address Lookups Using AAAA Records

-

+ +

The IPv6 AAAA record is a parallel to the IPv4 A record, and, unlike the deprecated A6 record, specifies the entire IPv6 address in a single record. For example,

+ 
 $ORIGIN example.com.
 host            3600    IN      AAAA    2001:db8::1
-

+ +

Use of IPv4-in-IPv6 mapped addresses is not recommended. If a host has an IPv4 address, use an A record, not a AAAA, with ::ffff:192.168.42.1 as the address.

-
-
+
+

Address to Name Lookups Using Nibble Format

-

+ +

When looking up an address in nibble format, the address components are simply reversed, just as in IPv4, and ip6.arpa. is appended to the @@ -2290,14 +2471,16 @@ host 3600 IN AAAA 2001:db8::1 a host with address 2001:db8::1.

+ 
 $ORIGIN 0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa.
 1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0  14400   IN    PTR    (
                                     host.example.com. )
-
-
-
+ +
+
+
diff --git a/doc/arm/Bv9ARM.ch05.html b/doc/arm/Bv9ARM.ch05.html index b955de7ba7..0b2168902a 100644 --- a/doc/arm/Bv9ARM.ch05.html +++ b/doc/arm/Bv9ARM.ch05.html @@ -49,22 +49,24 @@
Running a Resolver Daemon
-
+ +

The Lightweight Resolver Library

-

+ +

Traditionally applications have been linked with a stub resolver library that sends recursive DNS queries to a local caching name server.

-

+

IPv6 once introduced new complexity into the resolution process, such as following A6 chains and DNAME records, and simultaneous lookup of IPv4 and IPv6 addresses. Though most of the complexity was then removed, these are hard or impossible to implement in a traditional stub resolver.

-

+

BIND 9 therefore can also provide resolution services to local clients using a combination of a lightweight resolver library and a resolver @@ -72,18 +74,20 @@ a simple UDP-based protocol, the "lightweight resolver protocol" that is distinct from and simpler than the full DNS protocol.

-
-
+
+

Running a Resolver Daemon

-

+ +

To use the lightweight resolver interface, the system must run the resolver daemon lwresd or a local name server configured with a lwres statement.

-

+ +

By default, applications using the lightweight resolver library will make UDP requests to the IPv4 loopback address (127.0.0.1) on port 921. @@ -92,12 +96,14 @@ lines in /etc/resolv.conf.

-

+ +

The daemon currently only looks in the DNS, but in the future it may use other sources such as /etc/hosts, NIS, etc.

-

+ +

The lwresd daemon is essentially a caching-only name server that responds to requests using the lightweight @@ -110,7 +116,7 @@ autonomously if none are specified.

-

+

The lwresd daemon may also be configured with a named.conf style configuration file, @@ -120,8 +126,8 @@ be configured to act as a lightweight resolver daemon using the lwres statement in named.conf.

-
-
+ +
diff --git a/doc/arm/Bv9ARM.ch06.html b/doc/arm/Bv9ARM.ch06.html index b2747ce8ca..e573a15038 100644 --- a/doc/arm/Bv9ARM.ch06.html +++ b/doc/arm/Bv9ARM.ch06.html @@ -107,7 +107,8 @@ -

+ +

BIND 9 configuration is broadly similar to BIND 8; however, there are a few new areas @@ -117,20 +118,23 @@ if they can be more efficiently implemented using the new features found in BIND 9.

-

+ +

BIND 4 configuration files can be converted to the new format using the shell script contrib/named-bootconf/named-bootconf.sh.

-
+

Configuration File Elements

-

+ +

Following is a list of elements used throughout the BIND configuration file documentation:

-
+
+
@@ -498,67 +502,87 @@ -
-
+ +
+

Address Match Lists

-
+ +

Syntax

+ 
address_match_list = address_match_list_element ; ...
 
 address_match_list_element = [ ! ] ( ip_address | ip_prefix |
      key key_id | acl_name | { address_match_list } )
-
-
+ +
+

Definition and Usage

-

+ +

Address match lists are primarily used to determine access control for various server operations. They are also used in the listen-on and sortlist statements. The elements which constitute an address match list can be any of the following:

-
    -
  • an IP address (IPv4 or IPv6)
    • -
  • an IP prefix (in `/' notation)
    • +
    • + an IP address (IPv4 or IPv6) +
      • +
    • + an IP prefix (in `/' notation) +
      • +
    • + a key ID, as defined by the key statement -
      • -
    • the name of an address match list defined with + +
      • +
    • + the name of an address match list defined with the acl statement -
      • -
    • a nested address match list enclosed in braces
      • + + +
    • + a nested address match list enclosed in braces +
    -

    + +

    Elements can be negated with a leading exclamation mark (`!'), and the match list names "any", "none", "localhost", and "localnets" are predefined. More information on those names can be found in the description of the acl statement.

    -

    + +

    The addition of the key clause made the name of this syntactic element something of a misnomer, since security keys can be used to validate access without regard to a host or network address. Nonetheless, the term "address match list" is still used throughout the documentation.

    -

    + +

    When a given IP address or prefix is compared to an address match list, the comparison takes place in approximately O(1) time. However, key comparisons require that the list of keys be traversed until a matching key is found, and therefore may be somewhat slower.

    -

    + +

    The interpretation of a match depends on whether the list is being used for access control, defining listen-on ports, or in a sortlist, and whether the element was negated.

    -

    + +

    When used as an access control list, a non-negated match allows access and a negated match denies access. If there is no match, access is denied. The clauses @@ -577,7 +601,8 @@ server to refuse queries on any of the machine's addresses which do not match the list.

    -

    + +

    Order of insertion is significant. If more than one element in an ACL is found to match a given IP address or prefix, preference will be given to the one that came @@ -593,22 +618,26 @@ that problem by having 1.2.3.13 blocked by the negation, but all other 1.2.3.* hosts fall through.

    -
-
-
+
+
+ +

Comment Syntax

-

+ +

The BIND 9 comment syntax allows for comments to appear anywhere that whitespace may appear in a BIND configuration file. To appeal to programmers of all kinds, they can be written in the C, C++, or shell/perl style.

-
+ +

Syntax

-

+ + 

/* This is a BIND comment as in C */

@@ -620,25 +649,26 @@ # and perl

-
-
+
+

Definition and Usage

-

+ +

Comments may appear anywhere that whitespace may appear in a BIND configuration file.

-

+

C-style comments start with the two characters /* (slash, star) and end with */ (star, slash). Because they are completely delimited with these characters, they can be used to comment only a portion of a line or to span multiple lines.

-

+

C-style comments cannot be nested. For example, the following is not valid because the entire comment ends with the first */:

-

+ 

/* This is the start of a comment.
@@ -649,14 +679,15 @@
 

 
           

-

+
+          

             C++-style comments start with the two characters // (slash,
             slash) and continue to the end of the physical line. They cannot
             be continued across multiple physical lines; to have one logical
             comment span multiple lines, each line must use the // pair.
             For example:
           

-

+          

 
 

 
// This is the start of a comment.  The next line
@@ -666,14 +697,15 @@
 

 
           

-

+          

             Shell-style (or perl-style, if you prefer) comments start
             with the character # (number sign)
             and continue to the end of the
             physical line, as in C++ comments.
             For example:
           

-

+
+          

 
 

 
# This is the start of a comment.  The next line
@@ -683,22 +715,25 @@
 

 
           

-

+
+          

 
Warning

-

+            

               You cannot use the semicolon (`;') character
               to start a comment such as you would in a zone file. The
               semicolon indicates the end of a configuration
               statement.
             

-

-

-
-
-
+
+
+
+
+ +

Configuration File Grammar

-

+ +

A BIND 9 configuration consists of statements and comments. Statements end with a semicolon. Statements and comments are the @@ -706,10 +741,13 @@ statements contain a block of sub-statements, which are also terminated with a semicolon.

-

+ +

The following statements are supported:

-
+ +
+
@@ -868,34 +906,43 @@ -
-

+ +

+ +

The logging and options statements may only occur once per configuration.

-
+ +

acl Statement Grammar

+ 
acl acl-name {
     address_match_list
 };
-
-
+ +
+

acl Statement Definition and Usage

-

+ +

The acl statement assigns a symbolic name to an address match list. It gets its name from a primary use of address match lists: Access Control Lists (ACLs).

-

+ +

The following ACLs are built-in:

-
+ +
+
@@ -955,21 +1002,23 @@ -
-

+ +

+ +

When BIND 9 is built with GeoIP support, ACLs can also be used for geographic access restrictions. This is done by specifying an ACL element of the form: geoip [db database] field value

-

+

The field indicates which field to search for a match. Available fields are "country", "region", "city", "continent", "postal" (postal code), "metro" (metro code), "area" (area code), "tz" (timezone), "isp", "org", "asnum", "domain" and "netspeed".

-

+

value is the value to search for within the database. A string may be quoted if it contains spaces or other special characters. If this is @@ -985,7 +1034,7 @@ standard two-letter state or province abbreviation; otherwise it is the full name of the state or province.

-

+

The database field indicates which GeoIP database to search for a match. In most cases this is unnecessary, because most search fields can only be found in @@ -1000,10 +1049,10 @@ database if it is installed, or the "region" database if it is installed, or the "country" database, in that order.

-

+

Some example GeoIP ACLs:

-
geoip country US;
+        
geoip country US;
 geoip country JAP;
 geoip db country country Canada;
 geoip db region region WA;
@@ -1013,10 +1062,13 @@ geoip postal 95062;
 geoip tz "America/Los_Angeles";
 geoip org "Internet Systems Consortium";
 

-
-
+ + +
+

controls Statement Grammar

+ 
controls {
   [ inet ( ip_addr | * ) [ port ip_port ] allow { address_match_list }
       [ keys { key_list } ]
@@ -1026,19 +1078,23 @@ geoip org "Internet Systems Consortium";
    [ ...; ]
 };
-
-
+ +
+ +

controls Statement Definition and Usage

-

+ +

The controls statement declares control channels to be used by system administrators to control the operation of the name server. These control channels are used by the rndc utility to send commands to and retrieve non-DNS results from a name server.

-

+ +

An inet control channel is a TCP socket listening at the specified ip_port on the specified ip_addr, which can be an IPv4 or IPv6 @@ -1051,11 +1107,13 @@ geoip org "Internet Systems Consortium"; using the loopback address (127.0.0.1 or ::1) is recommended for maximum security.

-

+ +

If no port is specified, port 953 is used. The asterisk "*" cannot be used for ip_port.

-

+ +

The ability to issue commands over the control channel is restricted by the allow and keys clauses. @@ -1065,7 +1123,8 @@ geoip org "Internet Systems Consortium"; elements of the address_match_list are ignored.

-

+ +

A unix control channel is a UNIX domain socket listening at the specified path in the file system. Access to the socket is specified by the perm, @@ -1074,7 +1133,8 @@ geoip org "Internet Systems Consortium"; (perm) are applied to the parent directory as the permissions on the socket itself are ignored.

-

+ +

The primary authorization mechanism of the command channel is the key_list, which contains a list of key_ids. @@ -1083,7 +1143,8 @@ geoip org "Internet Systems Consortium"; See Remote Name Daemon Control application in the section called “Administrative Tools”) for information about configuring keys in rndc.

-

+ +

If no controls statement is present, named will set up a default control channel listening on the loopback address 127.0.0.1 @@ -1097,7 +1158,8 @@ geoip org "Internet Systems Consortium"; To create a rndc.key file, run rndc-confgen -a.

-

+ +

The rndc.key feature was created to ease the transition of systems from BIND 8, which did not have digital signatures on its command channel @@ -1110,7 +1172,8 @@ geoip org "Internet Systems Consortium"; command rndc-confgen -a after BIND 9 is installed.

-

+ +

Since the rndc.key feature is only intended to allow the backward-compatible usage of BIND 8 configuration files, this @@ -1131,21 +1194,25 @@ geoip org "Internet Systems Consortium"; readable by a group that contains the users who should have access.

-

+ +

To disable the command channel, use an empty controls statement: controls { };.

-
-
+ +
+

include Statement Grammar

-
include filename;
-
-
+ + 
include filename;
+
+

include Statement Definition and Usage

-

+ +

The include statement inserts the specified file at the point where the include statement is encountered. The include @@ -1155,27 +1222,33 @@ geoip org "Internet Systems Consortium"; others. For example, the statement could include private keys that are readable only by the name server.

-
-
+ +
+

key Statement Grammar

+ 
key key_id {
     algorithm algorithm_id;
     secret secret_string;
 };
-
-
+ +
+ +

key Statement Definition and Usage

-

+ +

The key statement defines a shared secret key for use with TSIG (see the section called “TSIG”) or the command channel (see the section called “controls Statement Definition and Usage”).

-

+ +

The key statement can occur at the top level of the configuration file or inside a view @@ -1186,7 +1259,8 @@ geoip org "Internet Systems Consortium"; Usage”) must be defined at the top level.

-

+ +

The key_id, also known as the key name, is a domain name uniquely identifying the key. It can be used in a server @@ -1195,7 +1269,8 @@ geoip org "Internet Systems Consortium"; verify that incoming requests have been signed with a key matching this name, algorithm, and secret.

-

+ +

The algorithm_id is a string that specifies a security/authentication algorithm. Named supports hmac-md5, @@ -1209,10 +1284,12 @@ geoip org "Internet Systems Consortium"; to be used by the algorithm, and is treated as a base-64 encoded string.

-
-
+ +
+

logging Statement Grammar

+ 
logging {
   [ channel channel_name {
     ( ( file path_name
@@ -1233,11 +1310,14 @@ geoip org "Internet Systems Consortium";
     ...
 };
-
-
+ +
+ +

logging Statement Definition and Usage

-

+ +

The logging statement configures a wide variety of logging options for the name server. Its channel phrase @@ -1245,18 +1325,20 @@ geoip org "Internet Systems Consortium"; a name that can then be used with the category phrase to select how various classes of messages are logged.

-

+

Only one logging statement is used to define as many channels and categories as are wanted. If there is no logging statement, the logging configuration will be:

+ 
logging {
      category default { default_syslog; default_debug; };
      category unmatched { null; };
 };
-

+ +

In BIND 9, the logging configuration is only established when the entire configuration file has been parsed. In BIND 8, it was @@ -1267,14 +1349,17 @@ geoip org "Internet Systems Consortium"; channels, or to standard error if the "-g" option was specified.

-
+ +

The channel Phrase

-

+ +

All log output goes to one or more channels; you can make as many of them as you want.

-

+ +

Every channel definition must include a destination clause that says whether messages selected for the channel go to a file, to a particular syslog facility, to the standard error stream, or are @@ -1285,12 +1370,14 @@ geoip org "Internet Systems Consortium"; category name and/or severity level (the default is not to include any).

-

+ +

The null destination clause causes all messages sent to the channel to be discarded; in that case, other options for the channel are meaningless.

-

+ +

The file destination clause directs the channel to a disk file. It can include limitations @@ -1298,7 +1385,8 @@ geoip org "Internet Systems Consortium"; versions of the file will be saved each time the file is opened.

-

+ +

If you use the versions log file option, then named will retain that many backup @@ -1321,7 +1409,8 @@ geoip org "Internet Systems Consortium"; existing log file is simply appended.

-

+ +

The size option for files is used to limit log growth. If the file ever exceeds the size, then named will @@ -1337,17 +1426,20 @@ geoip org "Internet Systems Consortium"; the file.

-

+ +

Example usage of the size and versions options:

+ 
channel an_example_channel {
     file "example.log" versions 3 size 20m;
     print-time yes;
     print-category yes;
 };
-

+ +

The syslog destination clause directs the channel to the system log. Its argument is a @@ -1369,10 +1461,10 @@ geoip org "Internet Systems Consortium"; only uses two arguments to the openlog() function, then this clause is silently ignored.

-

+

On Windows machines syslog messages are directed to the EventViewer.

-

+

The severity clause works like syslog's "priorities", except that they can also be used if you are writing straight to a file rather than using syslog. @@ -1381,7 +1473,7 @@ geoip org "Internet Systems Consortium"; levels will be accepted.

-

+

If you are using syslog, then the syslog.conf priorities will also determine what eventually passes through. For example, defining a channel facility and severity as daemon and debug but @@ -1393,7 +1485,8 @@ geoip org "Internet Systems Consortium"; then syslogd would print all messages it received from the channel.

-

+ +

The stderr destination clause directs the channel to the server's standard error stream. This is intended @@ -1402,7 +1495,8 @@ geoip org "Internet Systems Consortium"; example when debugging a configuration.

-

+ +

The server can supply extensive debugging information when it is in debugging mode. If the server's global debug level is greater @@ -1416,19 +1510,21 @@ notrace. All debugging messages in the server have a debug level, and higher debug levels give more detailed output. Channels that specify a specific debug severity, for example:

+ 
channel specific_debug_level {
     file "foo";
     severity debug 3;
 };
-

+ +

will get debugging output of level 3 or less any time the server is in debugging mode, regardless of the global debugging level. Channels with dynamic severity use the server's global debug level to determine what messages to print.

-

+

If print-time has been turned on, then the date and time will be logged. print-time may @@ -1446,15 +1542,18 @@ notrace. All debugging messages in the server have a debug three print- options are on:

-

+ +

28-Feb-2000 15:05:32.863 general: notice: running

-

+ +

There are four predefined channels that are used for named's default logging as follows. How they are used is described in the section called “The category Phrase”.

+ 
channel default_syslog {
     // send to syslog's daemon facility
     syslog daemon;
@@ -1482,7 +1581,8 @@ channel null {
    null;
 };
-

+ +

The default_debug channel has the special property that it only produces output when the server's debug @@ -1490,7 +1590,8 @@ channel null { nonzero. It normally writes to a file called named.run in the server's working directory.

-

+ +

For security reasons, when the "-u" command line option is used, the named.run file is created only after named has @@ -1500,17 +1601,20 @@ channel null { to capture this output, you must run the server with the "-g" option and redirect standard error to a file.

-

+ +

Once a channel is defined, it cannot be redefined. Thus you cannot alter the built-in channels directly, but you can modify the default logging by pointing categories at channels you have defined.

-
-
+
+ +

The category Phrase

-

+ +

There are many categories, so you can send the logs you want to see wherever you want, without seeing logs you don't want. If you don't specify a list of channels for a category, then log @@ -1519,13 +1623,16 @@ channel null { instead. If you don't specify a default category, the following "default default" is used:

+ 
category default { default_syslog; default_debug; };
-

+ +

As an example, let's say you want to log security events to a file, but you also want keep the default logging behavior. You'd specify the following:

+ 
channel my_security_channel {
     file "my_security_file";
     severity info;
@@ -1535,18 +1642,22 @@ category security {
     default_syslog;
     default_debug;
 };
-

+ +

To discard all messages in a category, specify the null channel:

+ 
category xfer-out { null; };
 category notify { null; };
-

+ +

Following are the available categories and brief descriptions of the types of log information they contain. More categories may be added in future BIND releases.

-
+
+
@@ -1901,12 +2012,14 @@ category notify { null; }; -
+
-
+
+

The query-errors Category

-

+ +

The query-errors category is specifically intended for debugging purposes: To identify why and how specific queries result in responses which @@ -1914,14 +2027,15 @@ category notify { null; }; Messages of this category are therefore only logged with debug levels.

-

+ +

At the debug levels of 1 or higher, each response with the rcode of SERVFAIL is logged as follows:

-

+

client 127.0.0.1#61502: query failed (SERVFAIL) for www.example.com/IN/AAAA at query.c:3880

-

+

This means an error resulting in SERVFAIL was detected at line 3880 of source file query.c. @@ -1929,13 +2043,13 @@ category notify { null; }; help identify the cause of SERVFAIL for an authoritative server.

-

+

At the debug levels of 2 or higher, detailed context information of recursive resolutions that resulted in SERVFAIL is logged. The log message will look like as follows:

-

+ 

@@ -1946,14 +2060,14 @@ badresp:1,adberr:0,findfail:0,valfail:0]

-

+

The first part before the colon shows that a recursive resolution for AAAA records of www.example.com completed in 30.000183 seconds and the final result that led to the SERVFAIL was determined at line 2970 of source file resolver.c.

-

+

The following part shows the detected final result and the latest result of DNSSEC validation. The latter is always success when no validation attempt @@ -1963,7 +2077,7 @@ badresp:1,adberr:0,findfail:0,valfail:0] to a timeout in 30 seconds. DNSSEC validation was probably not attempted.

-

+

The last part enclosed in square brackets shows statistics information collected for this particular resolution attempt. @@ -1973,7 +2087,9 @@ badresp:1,adberr:0,findfail:0,valfail:0] The meaning of the other fields is summarized in the following table.

-
+ +
+
@@ -2112,15 +2228,16 @@ badresp:1,adberr:0,findfail:0,valfail:0] -
-

+ +

+

At the debug levels of 3 or higher, the same messages as those at the debug 1 level are logged for other errors than SERVFAIL. Note that negative responses such as NXDOMAIN are not regarded as errors here.

-

+

At the debug levels of 4 or higher, the same messages as those at the debug 2 level are logged for other errors than SERVFAIL. @@ -2129,15 +2246,18 @@ badresp:1,adberr:0,findfail:0,valfail:0] This is because any unexpected results can be difficult to debug in the recursion case.

-
-
-
+
+
+ +

lwres Statement Grammar

-

+ +

This is the grammar of the lwres statement in the named.conf file:

+ 
lwres {
   [ listen-on {
     ( ip_addr [ port ip_port ] [ dscp ip_dscp ] ; )
@@ -2148,11 +2268,13 @@ badresp:1,adberr:0,findfail:0,valfail:0]
   [ ndots number; ]
 };
-
-
+ +
+

lwres Statement Definition and Usage

-

+ +

The lwres statement configures the name server to also act as a lightweight resolver server. (See @@ -2160,7 +2282,8 @@ badresp:1,adberr:0,findfail:0,valfail:0] lwres statements configuring lightweight resolver servers with different properties.

-

+ +

The listen-on statement specifies a list of IPv4 addresses (and ports) that this instance of a lightweight @@ -2171,7 +2294,8 @@ badresp:1,adberr:0,findfail:0,valfail:0] 127.0.0.1, port 921.

-

+ +

The view statement binds this instance of a lightweight resolver daemon to a view in the DNS namespace, so that @@ -2182,7 +2306,8 @@ badresp:1,adberr:0,findfail:0,valfail:0] is used, and if there is no default view, an error is triggered.

-

+ +

The search statement is equivalent to the search statement in @@ -2190,7 +2315,8 @@ badresp:1,adberr:0,findfail:0,valfail:0] list of domains which are appended to relative names in queries.

-

+ +

The ndots statement is equivalent to the ndots statement in @@ -2199,10 +2325,11 @@ badresp:1,adberr:0,findfail:0,valfail:0] number of dots in a relative domain name that should result in an exact match lookup before search path elements are appended.

-
-
+
+

masters Statement Grammar

+ 
 masters name [ port ip_port ] [ dscp ip_dscp ] {
   ( masters_list ; ) |
@@ -2210,24 +2337,30 @@ badresp:1,adberr:0,findfail:0,valfail:0]
     ...
 };
-
-
+ +
+ +

masters Statement Definition and Usage

-

masters + +

masters lists allow for a common set of masters to be easily used by multiple stub and slave zones in their masters or also-notify lists.

-
-
+
+ +

options Statement Grammar

-

+ +

This is the grammar of the options statement in the named.conf file:

+ 
options {
   [ attach-cache cache_name ; ]
   [ version version_string ; ]
@@ -2483,12 +2616,15 @@ badresp:1,adberr:0,findfail:0,valfail:0]
       [ qname-wait-recurse yes_or_no ] ; ]
 } ; ]
-
-
+ +
+ +

options Statement Definition and Usage

-

+ +

The options statement sets up global options to be used by BIND. This statement @@ -2497,10 +2633,11 @@ badresp:1,adberr:0,findfail:0,valfail:0] statement, an options block with each option set to its default will be used.

-
+ +
attach-cache
-

+

Allows multiple views to share a single cache database. Each view has its own cache database by default, but @@ -2509,13 +2646,15 @@ badresp:1,adberr:0,findfail:0,valfail:0] share a single cache to save memory and possibly improve resolution efficiency by using this option.

-

+ +

The attach-cache option may also be specified in view statements, in which case it overrides the global attach-cache option.

-

+ +

The cache_name specifies the cache to be shared. When the named server configures @@ -2525,14 +2664,16 @@ badresp:1,adberr:0,findfail:0,valfail:0] The rest of the views will simply refer to the already created cache.

-

+ +

One common configuration to share a cache would be to allow all views to share a single cache. This can be done by specifying the attach-cache as a global option with an arbitrary name.

-

+ +

Another possible operation is to allow a subset of all views to share a cache while the others to retain their own caches. @@ -2541,6 +2682,7 @@ badresp:1,adberr:0,findfail:0,valfail:0] attach-cache option as a view A (or B)'s option, referring to the other view name:

+ 
   view "A" {
     // this view has its own cache
@@ -2555,7 +2697,8 @@ badresp:1,adberr:0,findfail:0,valfail:0]
     ...
   };
-

+ +

Views that share a cache must have the same policy on configurable parameters that may affect caching. The current implementation requires the following @@ -2570,7 +2713,8 @@ badresp:1,adberr:0,findfail:0,valfail:0] max-cache-size, and zero-no-soa-ttl.

-

+ +

Note that there may be other parameters that may cause confusion if they are inconsistent for different views that share a single cache. @@ -2582,9 +2726,10 @@ badresp:1,adberr:0,findfail:0,valfail:0] configuration differences in different views do not cause disruption with a shared cache.

-
+
directory
-

+

+

The working directory of the server. Any non-absolute pathnames in the configuration file will be taken @@ -2597,9 +2742,11 @@ badresp:1,adberr:0,findfail:0,valfail:0] which the server was started. The directory specified should be an absolute path. -

+

+
geoip-directory
-

+

+

Specifies the directory containing GeoIP .dat database files for GeoIP initialization. By default, this option is unset @@ -2608,9 +2755,11 @@ badresp:1,adberr:0,findfail:0,valfail:0] (For details, see the section called “acl Statement Definition and Usage” about the geoip ACL.) -

+

+
key-directory
-

+

+

When performing dynamic update of secure zones, the directory where the public and private DNSSEC key files should be found, if different than the current working @@ -2619,15 +2768,16 @@ badresp:1,adberr:0,findfail:0,valfail:0] bind.keys, rndc.key or session.key.) -

+

+
managed-keys-directory
-

+

Specifies the directory in which to store the files that track managed DNSSEC keys. By default, this is the working directory.

-

+

If named is not configured to use views, then managed keys for the server will be tracked in a single file called managed-keys.bind. @@ -2636,25 +2786,30 @@ badresp:1,adberr:0,findfail:0,valfail:0] of the view name, followed by the extension .mkeys.

-
+
named-xfer
-

+

+

This option is obsolete. It was used in BIND 8 to specify the pathname to the named-xfer program. In BIND 9, no separate named-xfer program is needed; its functionality is built into the name server. -

+

+
tkey-gssapi-keytab
-

+

+

The KRB5 keytab file to use for GSS-TSIG updates. If this option is set and tkey-gssapi-credential is not set, then updates will be allowed with any key matching a principal in the specified keytab. -

+

+
tkey-gssapi-credential
-

+

+

The security credential with which the server should authenticate keys requested by the GSS-TSIG protocol. Currently only Kerberos 5 authentication is available @@ -2667,9 +2822,11 @@ badresp:1,adberr:0,findfail:0,valfail:0] To use GSS-TSIG, tkey-domain must also be set if a specific keytab is not set with tkey-gssapi-keytab. -

+

+
tkey-domain
-

+

+

The domain appended to the names of all shared keys generated with TKEY. When a client requests a TKEY exchange, @@ -2685,9 +2842,11 @@ badresp:1,adberr:0,findfail:0,valfail:0] "_tkey.domainname". If you are using GSS-TSIG, this variable must be defined, unless you specify a specific keytab using tkey-gssapi-keytab. -

+

+
tkey-dhkey
-

+

+

The Diffie-Hellman key used by the server to generate shared keys with clients using the Diffie-Hellman mode @@ -2696,26 +2855,34 @@ badresp:1,adberr:0,findfail:0,valfail:0] public and private keys from files in the working directory. In most cases, the key_name should be the server's host name. -

+

+
cache-file
-

+

+

This is for testing only. Do not use. -

+

+
dump-file
-

+

+

The pathname of the file the server dumps the database to when instructed to do so with rndc dumpdb. If not specified, the default is named_dump.db. -

+

+
memstatistics-file
-

+

+

The pathname of the file the server writes memory usage statistics to on exit. If not specified, the default is named.memstats. -

+

+
pid-file
-

+

+

The pathname of the file the server writes its process ID in. If not specified, the default is /var/run/named/named.pid. @@ -2727,42 +2894,52 @@ badresp:1,adberr:0,findfail:0,valfail:0] is a keyword, not a filename, and therefore is not enclosed in double quotes. -

+

+
recursing-file
-

+

+

The pathname of the file the server dumps the queries that are currently recursing when instructed to do so with rndc recursing. If not specified, the default is named.recursing. -

+

+
statistics-file
-

+

+

The pathname of the file the server appends statistics to when instructed to do so using rndc stats. If not specified, the default is named.stats in the server's current directory. The format of the file is described in the section called “The Statistics File”. -

+

+
bindkeys-file
-

+

+

The pathname of a file to override the built-in trusted keys provided by named. See the discussion of dnssec-lookaside and dnssec-validation for details. If not specified, the default is /etc/bind.keys. -

+

+
secroots-file
-

+

+

The pathname of the file the server dumps security roots to when instructed to do so with rndc secroots. If not specified, the default is named.secroots. -

+

+
session-keyfile
-

+

+

The pathname of the file into which to write a TSIG session key generated by named for use by nsupdate -l. If not specified, the @@ -2772,21 +2949,27 @@ badresp:1,adberr:0,findfail:0,valfail:0] update-policy statement's local option for more information about this feature.) -

+

+
session-keyname
-

+

+

The key name to use for the TSIG session key. If not specified, the default is "local-ddns". -

+

+
session-keyalg
-

+

+

The algorithm to use for the TSIG session key. Valid values are hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, hmac-sha512 and hmac-md5. If not specified, the default is hmac-sha256. -

+

+
port
-

+

+

The UDP/TCP port number the server uses for receiving and sending DNS protocol traffic. The default is 53. This option is mainly intended for server @@ -2794,16 +2977,20 @@ badresp:1,adberr:0,findfail:0,valfail:0] a server using a port other than 53 will not be able to communicate with the global DNS. -

+

+
dscp
-

+

+

The global Differentiated Services Code Point (DSCP) value to classify outgoing DNS traffic on operating systems that support DSCP. Valid values are 0 through 63. It is not configured by default. -

+

+
random-device
-

+

+

The source of entropy to be used by the server. Entropy is primarily needed for DNSSEC operations, such as TKEY transactions and dynamic @@ -2820,33 +3007,36 @@ badresp:1,adberr:0,findfail:0,valfail:0] effect during the initial configuration load at server startup time and is ignored on subsequent reloads. -

+

+
preferred-glue
-

+

+

If specified, the listed type (A or AAAA) will be emitted before other glue in the additional section of a query response. The default is to prefer A records when responding to queries that arrived via IPv4 and AAAA when responding to queries that arrived via IPv6. -

+

+
root-delegation-only
-

+

Turn on enforcement of delegation-only in TLDs (top level domains) and root zones with an optional exclude list.

-

+

DS queries are expected to be made to and be answered by delegation only zones. Such queries and responses are treated as an exception to delegation-only processing and are not converted to NXDOMAIN responses provided a CNAME is not discovered at the query name.

-

+

If a delegation only zone server also serves a child zone it is not always possible to determine whether an answer comes from the delegation only zone or the @@ -2862,24 +3052,26 @@ badresp:1,adberr:0,findfail:0,valfail:0] all these checks there is still a possibility of false negatives when a child zone is being served.

-

+

Similarly false positives can arise from empty nodes (no records at the name) in the delegation only zone when the query type is not ANY.

-

+

Note some TLDs are not delegation only (e.g. "DE", "LV", "US" and "MUSEUM"). This list is not exhaustive.

+ 
 options {
         root-delegation-only exclude { "de"; "lv"; "us"; "museum"; };
 };
-
+ +
disable-algorithms
-

+

Disable the specified DNSSEC algorithms at and below the specified name. Multiple disable-algorithms @@ -2887,15 +3079,15 @@ options { Only the best match disable-algorithms clause will be used to determine which algorithms are used.

-

+

If all supported algorithms are disabled, the zones covered by the disable-algorithms will be treated as insecure.

-
+
disable-ds-digests
-

+

Disable the specified DS/DLV digest types at and below the specified name. Multiple disable-ds-digests @@ -2903,15 +3095,15 @@ options { Only the best match disable-ds-digests clause will be used to determine which digest types are used.

-

+

If all supported digest types are disabled, the zones covered by the disable-ds-digests will be treated as insecure.

-
+
dnssec-lookaside
-

+

When set, dnssec-lookaside provides the validator with an alternate method to validate DNSKEY records at the top of a zone. When a DNSKEY is at or @@ -2923,18 +3115,18 @@ options { record validates a DNSKEY (similarly to the way a DS record does) the DNSKEY RRset is deemed to be trusted.

-

+

If dnssec-lookaside is set to auto, then built-in default values for the DLV domain and trust anchor will be used, along with a built-in key for validation.

-

+

If dnssec-lookaside is set to no, then dnssec-lookaside is not used.

-

+

The default DLV key is stored in the file bind.keys; named will load that key at @@ -2945,22 +3137,23 @@ options { new copy of bind.keys can be downloaded from https://www.isc.org/solutions/dlv/.

-

+

(To prevent problems if bind.keys is not found, the current key is also compiled in to named. Relying on this is not recommended, however, as it requires named to be recompiled with a new key when the DLV key expires.)

-

+

NOTE: named only loads certain specific keys from bind.keys: those for the DLV zone and for the DNS root zone. The file cannot be used to store keys for other zones.

-
+
dnssec-must-be-secure
-

+

+

Specify hierarchies which must be or may not be secure (signed and validated). If yes, then named will only accept answers if @@ -2970,10 +3163,11 @@ options { trusted-keys or managed-keys statement, or dnssec-lookaside must be active. -

+

+
dns64
-

+

This directive instructs named to return mapped IPv4 addresses to AAAA queries when there are no AAAA records. It is intended to be @@ -2981,11 +3175,11 @@ options { dns64 defines one DNS64 prefix. Multiple DNS64 prefixes can be defined.

-

+

Compatible IPv6 prefixes have lengths of 32, 40, 48, 56, 64 and 96 as per RFC 6052.

-

+

Additionally a reverse IP6.ARPA zone will be created for the prefix to provide a mapping from the IP6.ARPA names to the corresponding IN-ADDR.ARPA names using synthesized @@ -2995,20 +3189,20 @@ options { are settable at the view / options level. These are not settable on a per-prefix basis.

-

+

Each dns64 supports an optional clients ACL that determines which clients are affected by this directive. If not defined, it defaults to any;.

-

+

Each dns64 supports an optional mapped ACL that selects which IPv4 addresses are to be mapped in the corresponding A RRset. If not defined it defaults to any;.

-

+

Normally, DNS64 won't apply to a domain name that owns one or more AAAA records; these records will simply be returned. The optional @@ -3019,7 +3213,7 @@ options { name owns. If not defined, exclude defaults to ::ffff:0.0.0.0/96.

-

+

A optional suffix can also be defined to set the bits trailing the mapped IPv4 address bits. By default these bits are @@ -3027,13 +3221,13 @@ options { matching the prefix and mapped IPv4 address must be zero.

-

+

If recursive-only is set to yes the DNS64 synthesis will only happen for recursive queries. The default is no.

-

+

If break-dnssec is set to yes the DNS64 synthesis will happen even if the result, if validated, would @@ -3052,9 +3246,10 @@ options { suffix ::; }; -

+
dnssec-loadkeys-interval
-

+

+

When a zone is configured with auto-dnssec maintain; its key repository must be checked periodically to see if any new keys have been added @@ -3067,10 +3262,11 @@ options { the minimum is 1 (1 minute), and the maximum is 1440 (24 hours); any higher value is silently reduced. -

+

+
dnssec-update-mode
-

+

If this option is set to its default value of maintain in a zone of type master which is DNSSEC-signed @@ -3083,13 +3279,13 @@ options { by regenerating RRSIG records whenever they approach their expiration date.

-

+

If the option is changed to no-resign, then named will sign all new or changed records, but scheduled maintenance of signatures is disabled.

-

+

With either of these settings, named will reject updates to a DNSSEC-signed zone when the signing keys are inactive or unavailable to @@ -3098,10 +3294,10 @@ options { signing and allow DNSSEC data to be submitted into a zone via dynamic update; this is not yet implemented.)

-
+
max-zone-ttl
-

+

Specifies a maximum permissible TTL value. When loading a zone file using a masterfile-format of @@ -3110,7 +3306,7 @@ options { max-zone-ttl will cause the zone to be rejected.

-

+

This is useful in DNSSEC-signed zones because when rolling to a new DNSKEY, the old key needs to remain available until RRSIG records have expired from @@ -3118,31 +3314,31 @@ options { that the largest TTL in the zone will be no higher the set value.

-

+

(NOTE: Because map-format files load directly into memory, this option cannot be used with them.)

-

+

The default value is unlimited. A max-zone-ttl of zero is treated as unlimited.

-
+
serial-update-method
-

+

Zones configured for dynamic DNS may use this option to set the update method that will be used for the zone serial number in the SOA record.

-

+

With the default setting of serial-update-method increment;, the SOA serial number will be incremented by one each time the zone is updated.

-

+

When set to serial-update-method unixtime;, the SOA serial number will be set to the number of seconds @@ -3150,10 +3346,10 @@ options { already greater than or equal to that value, in which case it is simply incremented by one.

-
+
zone-statistics
-

+

If full, the server will collect statistical data on all zones (unless specifically turned off on a per-zone basis by specifying @@ -3165,7 +3361,7 @@ options { current serial number, but not query type counters).

-

+

These statistics may be accessed via the statistics-channel or using rndc stats, which @@ -3173,7 +3369,7 @@ options { in the statistics-file. See also the section called “The Statistics File”.

-

+

For backward compatibility with earlier versions of BIND 9, the zone-statistics option can also accept yes @@ -3184,35 +3380,40 @@ options { as none; previously, it was the same as terse.

-
+
-
+ +

Boolean Options

-
+ +
automatic-interface-scan
-

+

If yes and supported by the OS, automatically rescan network interfaces when the interface addresses are added or removed. The default is yes.

-

+

Currently the OS needs to support routing sockets for automatic-interface-scan to be supported.

-
+
allow-new-zones
-

+

+

If yes, then zones can be added at runtime via rndc addzone or deleted via rndc delzone. The default is no. -

+

+
auth-nxdomain
-

+

+

If yes, then the AA bit is always set on NXDOMAIN responses, even if the server is not actually @@ -3221,25 +3422,30 @@ options { a change from BIND 8. If you are using very old DNS software, you may need to set it to yes. -

+

+
deallocate-on-exit
-

+

+

This option was used in BIND 8 to enable checking for memory leaks on exit. BIND 9 ignores the option and always performs the checks. -

+

+
memstatistics
-

+

+

Write memory statistics to the file specified by memstatistics-file at exit. The default is no unless '-m record' is specified on the command line in which case it is yes. -

+

+
dialup
-

+

If yes, then the server treats all zones as if they are doing zone transfers across @@ -3254,14 +3460,14 @@ options { the normal zone maintenance traffic. The default is no.

-

+

The dialup option may also be specified in the view and zone statements, in which case it overrides the global dialup option.

-

+

If the zone is a master zone, then the server will send out a NOTIFY request to all the slaves (default). This should trigger the @@ -3273,7 +3479,7 @@ options { by notify and also-notify.

-

+

If the zone is a slave or stub zone, then the server will suppress the regular @@ -3283,7 +3489,7 @@ options { addition to sending NOTIFY requests.

-

+

Finer control can be achieved by using notify which only sends NOTIFY messages, @@ -3298,7 +3504,9 @@ options { refresh processing.

-
+ +
+
@@ -3449,21 +3657,27 @@ options { -
-

+ +

+ +

Note that normal NOTIFY processing is not affected by dialup.

- + +
fake-iquery
-

+

+

In BIND 8, this option enabled simulating the obsolete DNS query type IQUERY. BIND 9 never does IQUERY simulation. -

+

+
fetch-glue
-

+

+

This option is obsolete. In BIND 8, fetch-glue yes caused the server to attempt to fetch glue resource records @@ -3472,16 +3686,20 @@ options { data section of a response. This is now considered a bad idea and BIND 9 never does it. -

+

+
flush-zones-on-shutdown
-

+

+

When the nameserver exits due receiving SIGTERM, flush or do not flush any pending zone writes. The default is flush-zones-on-shutdown no. -

+

+
has-old-clients
-

+

+

This option was incorrectly implemented in BIND 8, and is ignored by BIND 9. To achieve the intended effect @@ -3489,16 +3707,20 @@ options { has-old-clients yes, specify the two separate options auth-nxdomain yes and rfc2308-type1 no instead. -

+

+
host-statistics
-

+

+

In BIND 8, this enables keeping of statistics for every host that the name server interacts with. Not implemented in BIND 9. -

+

+
maintain-ixfr-base
-

+

+

This option is obsolete. It was used in BIND 8 to determine whether a transaction log was @@ -3506,27 +3728,32 @@ options { log whenever possible. If you need to disable outgoing incremental zone transfers, use provide-ixfr no. -

+

+
minimal-responses
-

+

+

If yes, then when generating responses the server will only add records to the authority and additional data sections when they are required (e.g. delegations, negative responses). This may improve the performance of the server. The default is no. -

+

+
multiple-cnames
-

+

+

This option was used in BIND 8 to allow a domain name to have multiple CNAME records in violation of the DNS standards. BIND 9.2 onwards always strictly enforces the CNAME rules both in master files and dynamic updates. -

+

+
notify
-

+

If yes (the default), DNS NOTIFY messages are sent when a zone the server is authoritative for @@ -3537,7 +3764,7 @@ options { in the SOA MNAME field), and to any servers listed in the also-notify option.

-

+

If master-only, notifies are only sent for master zones. @@ -3546,7 +3773,7 @@ options { servers explicitly listed using also-notify. If no, no notifies are sent.

-

+

The notify option may also be specified in the zone statement, @@ -3555,9 +3782,10 @@ options { caused slaves to crash.

-
+
notify-to-soa
-

+

+

If yes do not check the nameservers in the NS RRset against the SOA MNAME. Normally a NOTIFY message is not sent to the SOA MNAME (SOA ORIGIN) as it is @@ -3566,9 +3794,11 @@ options { hidden master configurations and in that case you would want the ultimate master to still send NOTIFY messages to all the nameservers listed in the NS RRset. -

+

+
recursion
-

+

+

If yes, and a DNS query requests recursion, then the server will attempt to do @@ -3584,9 +3814,11 @@ options { queries. Caching may still occur as an effect the server's internal operation, such as NOTIFY address lookups. -

+

+
request-nsid
-

+

+

If yes, then an empty EDNS(0) NSID (Name Server Identifier) option is sent with all queries to authoritative name servers during iterative @@ -3595,9 +3827,11 @@ options { the resolver category at level info. The default is no. -

+

+
request-sit
-

+

+

If yes, then a SIT (Source Identity Token) EDNS option is sent along with the query. If the resolver has previously talked @@ -3613,18 +3847,22 @@ options { Resolvers which do not send a correct SIT option may be limited to receiving smaller responses via the nosit-udp-size option. -

+

+
nosit-udp-size
-

+

+

Sets the maximum size of UDP responses that will be sent to queries without a valid source identity token. A value below 128 will be silently raised to 128. The default value is 4096, but the max-udp-size option may further limit the response size. -

+

+
sit-secret
-

+

+

If set, this is a shared secret used for generating and verifying Source Identity Token EDNS options within a anycast cluster. If not set the system @@ -3632,26 +3870,27 @@ options { shared secret is encoded as a hex string and needs to be 128 bits for AES128, 160 bits for SHA1 and 256 bits for SHA256. -

+

+
rfc2308-type1
-

+

Setting this to yes will cause the server to send NS records along with the SOA record for negative answers. The default is no.

-
+

Note

-

+

Not yet implemented in BIND 9.

-
-
+
+
trust-anchor-telemetry
-

+

Causes named to send specially-formed queries once per day to domains for which trust anchors have been configured via trusted-keys, @@ -3659,7 +3898,7 @@ options { dnssec-validation auto, or dnssec-lookaside auto.

-

+

The query name used for these queries has the form "_ta-xxxx(-xxxx)(...)".<domain>, where each "xxxx" is a group of four hexadecimal digits @@ -3667,24 +3906,27 @@ options { The key IDs for each domain are sorted smallest to largest prior to encoding. The query type is NULL.

-

+

By monitoring these queries, zone operators will be able to see which resolvers have been updated to trust a new key; this may help them decide when it is safe to remove an old one.

-

+

The default is yes.

-
+
use-id-pool
-

+

+

This option is obsolete. BIND 9 always allocates query IDs from a pool. -

+

+
use-ixfr
-

+

+

This option is obsolete. If you need to disable IXFR to a particular server or servers, see @@ -3693,23 +3935,29 @@ options { Usage”. See also the section called “Incremental Zone Transfers (IXFR)”. -

+

+
provide-ixfr
-

+

+

See the description of provide-ixfr in the section called “server Statement Definition and Usage”. -

+

+
request-ixfr
-

+

+

See the description of request-ixfr in the section called “server Statement Definition and Usage”. -

+

+
treat-cr-as-space
-

+

+

This option was used in BIND 8 to make the server treat carriage return ("\r") characters the same way @@ -3720,19 +3968,22 @@ options { and NT/DOS "\r\n" newlines are always accepted, and the option is ignored. -

+

+
additional-from-auth, additional-from-cache
-

+ +

These options control the behavior of an authoritative server when answering queries which have additional data, or when following CNAME and DNAME chains.

-

+ +

When both of these options are set to yes (the default) and a query is being answered from authoritative data (a zone @@ -3752,7 +4003,8 @@ options { what would otherwise be provided in the additional section.

-

+ +

For example, if a query asks for an MX record for host foo.example.com, and the record found is "MX 10 mail.example.net", normally the address records (A and AAAA) for mail.example.net will be provided as well, @@ -3762,7 +4014,8 @@ options { the server only search for additional data in the zone it answers from.

-

+ +

These options are intended for use in authoritative-only servers, or in authoritative-only views. Attempts to set them to no without also @@ -3771,7 +4024,8 @@ options { server to ignore the options and log a warning message.

-

+ +

Specifying additional-from-cache no actually disables the use of the cache not only for additional data lookups @@ -3781,7 +4035,8 @@ options { correctness of the cached data is an issue.

-

+ +

When a name server is non-recursively queried for a name that is not below the apex of any served zone, it normally answers with @@ -3799,15 +4054,16 @@ options { upwards referrals are not required for the resolution process.

-
+ +
match-mapped-addresses
-

+

If yes, then an IPv4-mapped IPv6 address will match any address match list entries that match the corresponding IPv4 address.

-

+

This option was introduced to work around a kernel quirk in some operating systems that causes IPv4 TCP connections, such as zone transfers, to be accepted on an @@ -3816,10 +4072,10 @@ options { named now solves this problem internally. The use of this option is discouraged.

-
+
filter-aaaa-on-v4
-

+

This option is only available when BIND 9 is compiled with the --enable-filter-aaaa option on the @@ -3833,7 +4089,7 @@ options { to override the global filter-aaaa-on-v4 option.

-

+

If yes, the DNS client is at an IPv4 address, in filter-aaaa, and if the response does not include DNSSEC signatures, @@ -3841,13 +4097,13 @@ options { This filtering applies to all responses and not only authoritative responses.

-

+

If break-dnssec, then AAAA records are deleted even when DNSSEC is enabled. As suggested by the name, this makes the response not verify, because the DNSSEC protocol is designed detect deletions.

-

+

This mechanism can erroneously cause other servers to not give AAAA records to their clients. A recursing server with both IPv6 and IPv4 network connections @@ -3855,29 +4111,31 @@ options { via IPv4 will be denied AAAA records even if its client is using IPv6.

-

+

This mechanism is applied to authoritative as well as non-authoritative records. A client using IPv4 that is not allowed recursion can erroneously be given AAAA records because the server is not allowed to check for A records.

-

+

Some AAAA records are given to IPv4 clients in glue records. IPv4 clients that are servers can then erroneously answer requests for AAAA records received via IPv4.

-
+
filter-aaaa-on-v6
-

+

+

Identical to filter-aaaa-on-v4, except it filters AAAA responses to queries from IPv6 clients instead of IPv4 clients. To filter all responses, set both options to yes. -

+

+
ixfr-from-differences
-

+

When yes and the server loads a new version of a master zone from its zone file or receives a new version of a slave file via zone transfer, it will @@ -3887,7 +4145,7 @@ options { transmitted to downstream slaves as an incremental zone transfer.

-

+

By allowing incremental zone transfers to be used for non-dynamic zones, this option saves bandwidth at the expense of increased CPU and memory consumption at the @@ -3899,7 +4157,7 @@ options { temporarily allocate memory to hold this complete difference set.

-

ixfr-from-differences +

ixfr-from-differences also accepts master and slave at the view and options levels which causes @@ -3908,9 +4166,10 @@ options { slave zones respectively. It is off by default.

-
+
multi-master
-

+

+

This should be set when you have multiple masters for a zone and the addresses refer to different machines. If yes, named will @@ -3918,21 +4177,22 @@ options { when the serial number on the master is less than what named currently has. The default is no. -

+

+
auto-dnssec
-

+

Zones configured for dynamic DNS may use this option to allow varying levels of automatic DNSSEC key management. There are three possible settings:

-

+

auto-dnssec allow; permits keys to be updated and the zone fully re-signed whenever the user issues the command rndc sign zonename.

-

+

auto-dnssec maintain; includes the above, but also automatically adjusts the zone's DNSSEC keys on schedule, according to the keys' timing metadata @@ -3955,22 +4215,24 @@ options { interval is defined by dnssec-loadkeys-interval.)

-

+

The default setting is auto-dnssec off.

-
+
dnssec-enable
-

+

+

This indicates whether DNSSEC-related resource records are to be returned by named. If set to no, named will not return DNSSEC-related resource records unless specifically queried for. The default is yes. -

+

+
dnssec-validation
-

+

Enable DNSSEC validation in named. Note dnssec-enable also needs to be set to yes to be effective. @@ -3984,35 +4246,39 @@ options { managed-keys statement. The default is yes.

-
+

Note

-

+

Whenever the resolver sends out queries to an EDNS-compliant server, it always sets the DO bit indicating it can support DNSSEC responses even if dnssec-validation is off.

-
-
+
+
dnssec-accept-expired
-

+

+

Accept expired signatures when verifying DNSSEC signatures. The default is no. Setting this option to yes leaves named vulnerable to replay attacks. -

+

+
querylog
-

+

+

Specify whether query logging should be started when named starts. If querylog is not specified, then the query logging is determined by the presence of the logging category queries. -

+

+
check-names
-

+

This option is used to restrict the character set and syntax of certain domain names in master files and/or DNS responses @@ -4025,11 +4291,11 @@ options { For answers received from the network (response) the default is ignore.

-

+

The rules for legal hostnames and mail domains are derived from RFC 952 and RFC 821 as modified by RFC 1123.

-

check-names +

check-names applies to the owner names of A, AAAA and MX records. It also applies to the domain names in the RDATA of NS, SOA, MX, and SRV records. @@ -4037,24 +4303,29 @@ options { name indicated that it is a reverse lookup of a hostname (the owner name ends in IN-ADDR.ARPA, IP6.ARPA, or IP6.INT).

-
+
check-dup-records
-

+

+

Check master zones for records that are treated as different by DNSSEC but are semantically equal in plain DNS. The default is to warn. Other possible values are fail and ignore. -

+

+
check-mx
-

+

+

Check whether the MX record appears to refer to a IP address. The default is to warn. Other possible values are fail and ignore. -

+

+
check-wildcard
-

+

+

This option is used to check for non-terminal wildcards. The use of non-terminal wildcards is almost always as a result of a failure @@ -4062,10 +4333,11 @@ options { This option affects master zones. The default (yes) is to check for non-terminal wildcards and issue a warning. -

+

+
check-integrity
-

+

Perform post load zone integrity checks on master zones. This checks that MX and SRV records refer to address (A or AAAA) records and that glue @@ -4078,7 +4350,7 @@ options { checks use named-checkzone). The default is yes.

-

+

The use of the SPF record for publishing Sender Policy Framework is deprecated as the migration from using TXT records to SPF records was abandoned. @@ -4088,53 +4360,65 @@ options { TXT record does not exist and can be suppressed with check-spf.

-
+
check-mx-cname
-

+

+

If check-integrity is set then fail, warn or ignore MX records that refer to CNAMES. The default is to warn. -

+

+
check-srv-cname
-

+

+

If check-integrity is set then fail, warn or ignore SRV records that refer to CNAMES. The default is to warn. -

+

+
check-sibling
-

+

+

When performing integrity checks, also check that sibling glue exists. The default is yes. -

+

+
check-spf
-

+

+

If check-integrity is set then check that there is a TXT Sender Policy Framework record present (starts with "v=spf1") if there is an SPF record present. The default is warn. -

+

+
zero-no-soa-ttl
-

+

+

When returning authoritative negative responses to SOA queries set the TTL of the SOA record returned in the authority section to zero. The default is yes. -

+

+
zero-no-soa-ttl-cache
-

+

+

When caching a negative response to a SOA query set the TTL to zero. The default is no. -

+

+
update-check-ksk
-

+

When set to the default value of yes, check the KSK bit in each key to determine how the key should be used when generating RRSIGs for a secure zone.

-

+

Ordinarily, zone-signing keys (that is, keys without the KSK bit set) are used to sign the entire zone, while key-signing keys (keys with the KSK bit set) are only @@ -4145,7 +4429,7 @@ options { similar to the dnssec-signzone -z command line option.

-

+

When this option is set to yes, there must be at least two active keys for every algorithm represented in the DNSKEY RRset: at least one KSK and one @@ -4153,10 +4437,10 @@ options { this requirement is not met, this option will be ignored for that algorithm.

-
+
dnssec-dnskey-kskonly
-

+

When this option and update-check-ksk are both set to yes, only key-signing keys (that is, keys with the KSK bit set) will be used @@ -4166,21 +4450,23 @@ options { This is similar to the dnssec-signzone -x command line option.

-

+

The default is no. If update-check-ksk is set to no, this option is ignored.

-
+
try-tcp-refresh
-

+

+

Try to refresh the zone using TCP if UDP queries fail. For BIND 8 compatibility, the default is yes. -

+

+
dnssec-secure-to-insecure
-

+

Allow a dynamic zone to transition from secure to insecure (i.e., signed to unsigned) by deleting all of the DNSKEY records. The default is no. @@ -4188,27 +4474,30 @@ options { at the zone apex is deleted, all RRSIG and NSEC records will be removed from the zone as well.

-

+

If the zone uses NSEC3, then it is also necessary to delete the NSEC3PARAM RRset from the zone apex; this will cause the removal of all corresponding NSEC3 records. (It is expected that this requirement will be eliminated in a future release.)

-

+

Note that if a zone has been configured with auto-dnssec maintain and the private keys remain accessible in the key repository, then the zone will be automatically signed again the next time named is started.

-
+
-
-
+ +
+ +

Forwarding

-

+ +

The forwarding facility can be used to create a large site-wide cache on a few servers, reducing traffic over links to external name servers. It can also be used to allow queries by servers that @@ -4218,9 +4507,11 @@ options { the server is not authoritative and does not have the answer in its cache.

-
+ +
forward
-

+

+

This option is only meaningful if the forwarders list is not empty. A value of first, the default, causes the server to query the forwarders @@ -4230,15 +4521,19 @@ options { the answer itself. If only is specified, the server will only query the forwarders. -

+

+
forwarders
-

+

+

Specifies the IP addresses to be used for forwarding. The default is the empty list (no forwarding). -

+

+
-

+ +

Forwarding can also be configured on a per-domain basis, allowing for the global forwarding options to be overridden in a variety of ways. You can set particular domains to use different @@ -4247,20 +4542,24 @@ options { or not forward at all, see the section called “zone Statement Grammar”.

-
-
+
+ +

Dual-stack Servers

-

+ +

Dual-stack servers are used as servers of last resort to work around problems in reachability due the lack of support for either IPv4 or IPv6 on the host machine.

-
+ +
dual-stack-servers
-

+

+

Specifies host names or addresses of machines with access to both IPv4 and IPv6 transports. If a hostname is used, the server must be able @@ -4269,20 +4568,26 @@ options { stacked, then the dual-stack-servers have no effect unless access to a transport has been disabled on the command line (e.g. named -4). -

+

+
-
-
+
+ +

Access Control

-

+ + +

Access to the server can be restricted based on the IP address of the requesting system. See the section called “Address Match Lists” for details on how to specify IP address lists.

-
+ +
allow-notify
-

+

+

Specifies which hosts are allowed to notify this server, a slave, of zone changes in addition to the zone masters. @@ -4295,10 +4600,11 @@ options { for a slave zone. If not specified, the default is to process notify messages only from a zone's master. -

+

+
allow-query
-

+

Specifies which hosts are allowed to ask ordinary DNS questions. allow-query may also be specified in the zone @@ -4307,49 +4613,50 @@ options { If not specified, the default is to allow queries from all hosts.

-
+

Note

-

+

allow-query-cache is now used to specify access to the cache.

-
-
+
+
allow-query-on
-

+

Specifies which local addresses can accept ordinary DNS questions. This makes it possible, for instance, to allow queries on internal-facing interfaces but disallow them on external-facing ones, without necessarily knowing the internal network's addresses.

-

+

Note that allow-query-on is only checked for queries that are permitted by allow-query. A query must be allowed by both ACLs, or it will be refused.

-

+

allow-query-on may also be specified in the zone statement, in which case it overrides the options allow-query-on statement.

-

+

If not specified, the default is to allow queries on all addresses.

-
+

Note

-

+

allow-query-cache is used to specify access to the cache.

-
-
+
+
allow-query-cache
-

+

+

Specifies which hosts are allowed to get answers from the cache. If allow-query-cache is not set then allow-recursion @@ -4358,17 +4665,21 @@ options { set in which case none; is used, otherwise the default (localnets; localhost;) is used. -

+

+
allow-query-cache-on
-

+

+

Specifies which local addresses can give answers from the cache. If not specified, the default is to allow cache queries on any address, localnets and localhost. -

+

+
allow-recursion
-

+

+

Specifies which hosts are allowed to make recursive queries through this server. If allow-recursion is not set @@ -4377,25 +4688,30 @@ options { is used if set, otherwise the default (localnets; localhost;) is used. -

+

+
allow-recursion-on
-

+

+

Specifies which local addresses can accept recursive queries. If not specified, the default is to allow recursive queries on all addresses. -

+

+
allow-update
-

+

+

Specifies which hosts are allowed to submit Dynamic DNS updates for master zones. The default is to deny updates from all hosts. Note that allowing updates based on the requestor's IP address is insecure; see the section called “Dynamic Update Security” for details. -

+

+
allow-update-forwarding
-

+

Specifies which hosts are allowed to submit Dynamic DNS updates to slave zones to be forwarded to the @@ -4412,7 +4728,7 @@ options { with the master server, not the slaves.

-

+

Note that enabling the update forwarding feature on a slave server may expose master servers relying on insecure IP address @@ -4420,9 +4736,10 @@ options { access control to attacks; see the section called “Dynamic Update Security” for more details.

-
+
allow-v6-synthesis
-

+

+

This option was introduced for the smooth transition from AAAA to A6 and from "nibble labels" to binary labels. @@ -4430,9 +4747,11 @@ options { deprecated, this option was also deprecated. It is now ignored with some warning messages. -

+

+
allow-transfer
-

+

+

Specifies which hosts are allowed to receive zone transfers from the server. allow-transfer may also be specified in the zone @@ -4440,24 +4759,29 @@ options { case it overrides the options allow-transfer statement. If not specified, the default is to allow transfers to all hosts. -

+

+
blackhole
-

+

+

Specifies a list of addresses that the server will not accept queries from or use to resolve a query. Queries from these addresses will not be responded to. The default is none. -

+

+
filter-aaaa
-

+

+

Specifies a list of addresses to which filter-aaaa-on-v4 is applies. The default is any. -

+

+
no-case-compress
-

+

Specifies a list of addresses which require responses to use case-insensitive compression. This ACL can be used when named needs to work with @@ -4465,7 +4789,7 @@ options { 1034 to use case-insensitive name comparisons when checking for matching domain names.

-

+

If left undefined, the ACL defaults to none: case-insensitive compression will be used for all clients. If the ACL is defined and @@ -4473,7 +4797,7 @@ options { compressing domain names in DNS responses sent to that client.

-

+

This can result in slightly smaller responses: if a response contains the names "example.com" and "example.COM", case-insensitive compression would treat @@ -4485,12 +4809,12 @@ options { match the query, which is required by some clients due to incorrect use of case-sensitive comparisons.

-

+

Case-insensitive compression is always used in AXFR and IXFR responses, regardless of whether the client matches this ACL.

-

+

There are circumstances in which named will not preserve the case of owner names of records: if a zone file defines records of different types with @@ -4505,21 +4829,26 @@ options { have their case preserved unless the client matches this ACL.

-
+
resolver-query-timeout
-

+

+

The amount of time the resolver will spend attempting to resolve a recursive query before failing. The default and minimum is 10 and the maximum is 30. Setting it to 0 will result in the default being used. -

+

+
-
-
+ +
+ +

Interfaces

-

+ +

The interfaces and ports that the server will answer queries from may be specified using the listen-on option. listen-on takes an optional port and an address_match_list @@ -4528,30 +4857,35 @@ options { The server will listen on all interfaces allowed by the address match list. If a port is not specified, port 53 will be used.

-

+

Multiple listen-on statements are allowed. For example,

+ 
listen-on { 5.6.7.8; };
 listen-on port 1234 { !1.2.3.4; 1.2/16; };
-

+ +

will enable the name server on port 53 for the IP address 5.6.7.8, and on port 1234 of an address on the machine in net 1.2 that is not 1.2.3.4.

-

+ +

If no listen-on is specified, the server will listen on port 53 on all IPv4 interfaces.

-

+ +

The listen-on-v6 option is used to specify the interfaces and the ports on which the server will listen for incoming queries sent using IPv6. If not specified, the server will listen on port 53 on all IPv6 interfaces.

-

+ +

When 

{ any; }

is @@ -4566,7 +4900,8 @@ listen-on port 1234 { !1.2.3.4; 1.2/16; }; If the system only has incomplete API support for IPv6, however, the behavior is the same as that for IPv4.

-

+ +

A list of particular IPv6 addresses can also be specified, in which case the server listens on a separate socket for each specified @@ -4575,30 +4910,38 @@ listen-on port 1234 { !1.2.3.4; 1.2/16; }; IPv4 addresses specified in listen-on-v6 will be ignored, with a logged warning.

-

+ +

Multiple listen-on-v6 options can be used. For example,

+ 
listen-on-v6 { any; };
 listen-on-v6 port 1234 { !2001:db8::/32; any; };
-

+ +

will enable the name server on port 53 for any IPv6 addresses (with a single wildcard socket), and on port 1234 of IPv6 addresses that is not in the prefix 2001:db8::/32 (with separate sockets for each matched address.)

-

+ +

To make the server not listen on any IPv6 address, use

+ 
listen-on-v6 { none; };
-
-
+ +
+ +

Query Address

-

+ +

If the server doesn't know the answer to a question, it will query other name servers. query-source specifies the address and port used for such queries. For queries sent over @@ -4607,7 +4950,8 @@ listen-on-v6 port 1234 { !2001:db8::/32; any; }; a wildcard IP address (INADDR_ANY) will be used.

-

+ +

If port is * or is omitted, a random port number from a pre-configured range is picked up and will be used for each query. @@ -4618,15 +4962,18 @@ listen-on-v6 port 1234 { !2001:db8::/32; any; }; the avoid-v4-udp-ports and avoid-v6-udp-ports options, respectively.

-

+ +

The defaults of the query-source and query-source-v6 options are:

+ 
query-source address * port *;
 query-source-v6 address * port *;
-

+ +

If use-v4-udp-ports or use-v6-udp-ports is unspecified, named will check if the operating @@ -4636,10 +4983,12 @@ query-source-v6 address * port *; named will use the corresponding system default range; otherwise, it will use its own defaults:

+ 
use-v4-udp-ports { range 1024 65535; };
 use-v6-udp-ports { range 1024 65535; };
-

+ +

Note: make sure the ranges be sufficiently large for security. A desirable size depends on various parameters, but we generally recommend it contain at least 16384 ports @@ -4655,7 +5004,8 @@ use-v6-udp-ports { range 1024 65535; }; ranges are sufficiently large and are reasonably independent from the ranges used by other applications.

-

+ +

Note: the operational configuration where named runs may prohibit the use of some ports. For example, UNIX systems will not allow @@ -4667,15 +5017,18 @@ use-v6-udp-ports { range 1024 65535; }; It is therefore important to configure the set of ports that can be safely used in the expected operational environment.

-

+ +

The defaults of the avoid-v4-udp-ports and avoid-v6-udp-ports options are:

+ 
avoid-v4-udp-ports {};
 avoid-v6-udp-ports {};
-

+ +

Note: BIND 9.5.0 introduced the use-queryport-pool option to support a pool of such random ports, but this @@ -4687,57 +5040,67 @@ avoid-v6-udp-ports {}; query-source-v6 options; it implicitly disables the use of randomized port numbers.

-
+ +
use-queryport-pool
-

+

+

This option is obsolete. -

+

+
queryport-pool-ports
-

+

+

This option is obsolete. -

+

+
queryport-pool-updateinterval
-

+

+

This option is obsolete. -

+

+
-
+

Note

-

+

The address specified in the query-source option is used for both UDP and TCP queries, but the port applies only to UDP queries. TCP queries always use a random unprivileged port.

-
-
+
+

Note

-

+

Solaris 2.5.1 and earlier does not support setting the source address for TCP sockets.

-
-
+
+

Note

-

+

See also transfer-source and notify-source.

-
-
-
+
+
+ +

Zone Transfers

-

+ +

BIND has mechanisms in place to facilitate zone transfers and set limits on the amount of load that transfers place on the system. The following options apply to zone transfers.

-
+ +
also-notify
-

+

Defines a global list of IP addresses of name servers that are also sent NOTIFY messages whenever a fresh copy of the @@ -4755,7 +5118,7 @@ avoid-v6-udp-ports {}; In place of explicit addresses, one or more named masters lists can be used.

-

+

If an also-notify list is given in a zone statement, it will override @@ -4768,38 +5131,46 @@ avoid-v6-udp-ports {}; the empty list (no global notification list).

-
+
max-transfer-time-in
-

+

+

Inbound zone transfers running longer than this many minutes will be terminated. The default is 120 minutes (2 hours). The maximum value is 28 days (40320 minutes). -

+

+
max-transfer-idle-in
-

+

+

Inbound zone transfers making no progress in this many minutes will be terminated. The default is 60 minutes (1 hour). The maximum value is 28 days (40320 minutes). -

+

+
max-transfer-time-out
-

+

+

Outbound zone transfers running longer than this many minutes will be terminated. The default is 120 minutes (2 hours). The maximum value is 28 days (40320 minutes). -

+

+
max-transfer-idle-out
-

+

+

Outbound zone transfers making no progress in this many minutes will be terminated. The default is 60 minutes (1 hour). The maximum value is 28 days (40320 minutes). -

+

+
serial-query-rate
-

+

Slave servers will periodically query master servers to find out if zone serial numbers have changed. Each such query uses a minute amount of @@ -4812,16 +5183,17 @@ avoid-v6-udp-ports {}; The lowest possible rate is one per second; when set to zero, it will be silently raised to one.

-

+

In addition to controlling the rate SOA refresh queries are issued at, serial-query-rate also controls the rate at which NOTIFY messages are sent from both master and slave zones.

-
+
serial-queries
-

+

+

In BIND 8, the serial-queries option set the maximum number of concurrent serial number queries @@ -4830,9 +5202,12 @@ avoid-v6-udp-ports {}; serial queries and ignores the serial-queries option. Instead, it limits the rate at which the queries are sent as defined using the serial-query-rate option. -

+

+
transfer-format
-

+

+ +

Zone transfers can be sent using two different formats, one-answer and many-answers. @@ -4852,25 +5227,32 @@ avoid-v6-udp-ports {}; transfer-format may be overridden on a per-server basis by using the server statement. -

+

+ +
transfers-in
-

+

+

The maximum number of inbound zone transfers that can be running concurrently. The default value is 10. Increasing transfers-in may speed up the convergence of slave zones, but it also may increase the load on the local system. -

+

+
transfers-out
-

+

+

The maximum number of outbound zone transfers that can be running concurrently. Zone transfer requests in excess of the limit will be refused. The default value is 10. -

+

+
transfers-per-ns
-

+

+

The maximum number of inbound zone transfers that can be concurrently transferring from a given remote name server. @@ -4882,10 +5264,11 @@ avoid-v6-udp-ports {}; the load on the remote name server. transfers-per-ns may be overridden on a per-server basis by using the transfers phrase of the server statement. -

+

+
transfer-source
-

transfer-source +

transfer-source determines which local address will be bound to IPv4 TCP connections used to fetch zones transferred inbound by the server. It also determines the @@ -4906,28 +5289,30 @@ avoid-v6-udp-ports {}; zone block in the configuration file.

-
+

Note

-

+

Solaris 2.5.1 and earlier does not support setting the source address for TCP sockets.

-
-
+
+
transfer-source-v6
-

+

+

The same as transfer-source, except zone transfers are performed using IPv6. -

+

+
alt-transfer-source
-

+

An alternate transfer source if the one listed in transfer-source fails and use-alt-transfer-source is set.

-
+

Note

If you do not wish the alternate transfer source @@ -4938,25 +5323,29 @@ avoid-v6-udp-ports {}; query.

-
+
alt-transfer-source-v6
-

+

+

An alternate transfer source if the one listed in transfer-source-v6 fails and use-alt-transfer-source is set. -

+

+
use-alt-transfer-source
-

+

+

Use the alternate transfer sources or not. If views are specified this defaults to no otherwise it defaults to yes (for BIND 8 compatibility). -

+

+
notify-source
-

notify-source +

notify-source determines which local source address, and optionally UDP port, will be used to send NOTIFY messages. This address must appear in the slave @@ -4970,25 +5359,30 @@ avoid-v6-udp-ports {}; view block in the configuration file.

-
+

Note

-

+

Solaris 2.5.1 and earlier does not support setting the source address for TCP sockets.

-
-
+
+
notify-source-v6
-

+

+

Like notify-source, but applies to notify messages sent to IPv6 addresses. -

+

+
-
-
+ +
+ +

UDP Port Lists

-

+ +

use-v4-udp-ports, avoid-v4-udp-ports, use-v6-udp-ports, and @@ -4999,17 +5393,20 @@ avoid-v6-udp-ports {}; available ports are determined. For example, with the following configuration

+ 
 use-v6-udp-ports { range 32768 65535; };
 avoid-v6-udp-ports { 40000; range 50000 60000; };
-

+ +

UDP ports of IPv6 messages sent from named will be in one of the following ranges: 32768 to 39999, 40001 to 49999, and 60001 to 65535.

-

+ +

avoid-v4-udp-ports and avoid-v6-udp-ports can be used to prevent named from choosing as its random source port a @@ -5026,11 +5423,13 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; sense; they are provided for backward compatibility and to possibly simplify the port specification.

-
-
+
+ +

Operating System Resource Limits

-

+ +

The server's usage of many system resources can be limited. Scaled values are allowed when specifying resource limits. For example, 1G can be used instead of @@ -5043,7 +5442,8 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; that was in force when the server was started. See the description of size_spec in the section called “Configuration File Elements”.

-

+ +

The following options set operating system resource limits for the name server process. Some operating systems don't support some or @@ -5051,14 +5451,18 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; the unsupported limit is used.

-
+ +
coresize
-

+

+

The maximum size of a core dump. The default is default. -

+

+
datasize
-

+

+

The maximum amount of data memory the server may use. The default is default. This is a hard limit on server memory usage. @@ -5073,37 +5477,49 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; max-cache-size and recursive-clients options instead. -

+

+
files
-

+

+

The maximum number of files the server may have open concurrently. The default is unlimited. -

+

+
stacksize
-

+

+

The maximum amount of stack memory the server may use. The default is default. -

+

+
-
-
+ +
+ +

Server Resource Limits

-

+ +

The following options set limits on the server's resource consumption that are enforced internally by the server rather than the operating system.

-
+ +
max-ixfr-log-size
-

+

+

This option is obsolete; it is accepted and ignored for BIND 8 compatibility. The option max-journal-size performs a similar function in BIND 9. -

+

+
max-journal-size
-

+

+

Sets a maximum size for each journal file (see the section called “The journal file”). When the journal file approaches @@ -5114,21 +5530,26 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; unlimited, which also means 2 gigabytes. This may also be set on a per-zone basis. -

+

+
max-records
-

+

+

The maximum number of records permitted in a zone. The default is zero which means unlimited. -

+

+
host-statistics-max
-

+

+

In BIND 8, specifies the maximum number of host statistics entries to be kept. Not implemented in BIND 9. -

+

+
recursive-clients
-

+

The maximum number ("hard quota") of simultaneous recursive lookups the server will perform on behalf of clients. The default is @@ -5139,14 +5560,14 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; recursive-clients option may have to be decreased on hosts with limited memory.

-

+

recursive-clients defines a "hard quota" limit for pending recursive clients: when more clients than this are pending, new incoming requests will not be accepted, and for each incoming request a previous pending request will also be dropped.

-

+

A "soft quota" is also set. When this lower quota is exceeded, incoming requests are accepted, but for each one, a pending request will be dropped. @@ -5156,18 +5577,20 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; otherwise it is set to 90% of recursive-clients.

-
+
tcp-clients
-

+

+

The maximum number of simultaneous client TCP connections that the server will accept. The default is 100. -

+

+
clients-per-query, max-clients-per-query
-

These set the +

These set the initial value (minimum) and maximum number of recursive simultaneous clients for any given query (<qname,qtype,qclass>) that the server will accept @@ -5175,7 +5598,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; self tune this value and changes will be logged. The default values are 10 and 100.

-

+

This value should reflect how many queries come in for a given name in the time it takes to resolve that name. If the number of queries exceed this value, named will @@ -5185,22 +5608,22 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; estimate will then be lowered in 20 minutes if it has remained unchanged.

-

+

If clients-per-query is set to zero, then there is no limit on the number of clients per query and no queries will be dropped.

-

+

If max-clients-per-query is set to zero, then there is no upper bound other than imposed by recursive-clients.

-
+
fetches-per-zone
-

+

The maximum number of simultaneous iterative queries to any one domain that the server will permit before blocking new queries for data @@ -5210,7 +5633,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; would take to resolve them. It should be smaller than recursive-clients.

-

+

When many clients simultaneously query for the same name and type, the clients will all be attached to the same fetch, up to the @@ -5222,7 +5645,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; max-clients-per-query is not effective as a limit.

-

+

Optionally, this value may be followed by the keyword drop or fail, indicating whether queries which exceed the fetch @@ -5230,12 +5653,12 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; or answered with SERVFAIL. The default is drop.

-

+

If fetches-per-zone is set to zero, then there is no limit on the number of fetches per query and no queries will be dropped. The default is zero.

-

+

The current list of active fetches can be dumped by running rndc recursing. The list includes the number of active fetches for each @@ -5248,16 +5671,16 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; next time a fetch is sent to that domain, it is recreated with the counters set to zero.)

-

+

(Note: This option is only available when BIND is built with configure --enable-fetchlimit.)

-
+
fetches-per-server
-

+

The maximum number of simultaneous iterative queries that the server will allow to be sent to a single upstream name server before blocking @@ -5267,7 +5690,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; would take to resolve them. It should be smaller than recursive-clients.

-

+

Optionally, this value may be followed by the keyword drop or fail, indicating whether queries will be dropped with no @@ -5276,12 +5699,12 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; exceeded the per-server quota. The default is fail.

-

+

If fetches-per-server is set to zero, then there is no limit on the number of fetches per query and no queries will be dropped. The default is zero.

-

+

The fetches-per-server quota is dynamically adjusted in response to detected congestion. As queries are sent to a server @@ -5297,19 +5720,19 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; can be used to adjust the parameters for this calculation.

-

+

(Note: This option is only available when BIND is built with configure --enable-fetchlimit.)

-
+
fetch-quota-params
-

+

Sets the parameters to use for dynamic resizing of the fetches-per-server quota in response to detected congestion.

-

+

The first argument is an integer value indicating how frequently to recalculate the moving average of the ratio of timeouts to responses for each @@ -5317,7 +5740,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; the average ratio after every 100 queries have either been answered or timed out.

-

+

The remaining three arguments represent the "low" threshold (defaulting to a timeout ratio of 0.1), the "high" threshold (defaulting to a timeout @@ -5332,14 +5755,14 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; precision of 1/100: at most two places after the decimal point are significant.

-

+

(Note: This option is only available when BIND is built with configure --enable-fetchlimit.)

-
+
reserved-sockets
-

+

The number of file descriptors reserved for TCP, stdio, etc. This needs to be big enough to cover the number of interfaces named listens on, tcp-clients as well as @@ -5349,12 +5772,13 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; maximum value is 128 less than maxsockets (-S). This option may be removed in the future.

-

+

This option has little effect on Windows.

-
+
max-cache-size
-

+

+

The maximum amount of memory to use for the server's cache, in bytes. When the amount of data in the cache @@ -5370,9 +5794,11 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; In a server with multiple views, the limit applies separately to the cache of each view. The default is unlimited. -

+

+
tcp-listen-queue
-

+

+

The listen queue depth. The default and minimum is 10. If the kernel supports the accept filter "dataready" this also controls how @@ -5382,15 +5808,20 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; less than 10 will be silently raised. A value of 0 may also be used; on most platforms this sets the listen queue length to a system-defined default value. -

+

+
-
-
+ +
+ +

Periodic Task Intervals

-
+ +
cleaning-interval
-

+

+

This interval is effectively obsolete. Previously, the server would remove expired resource records from the cache every cleaning-interval minutes. @@ -5399,9 +5830,11 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; rely on the periodic cleaning any more. Specifying this option therefore has no effect on the server's behavior. -

+

+
heartbeat-interval
-

+

+

The server will perform zone maintenance tasks for all zones marked as dialup whenever this interval expires. The default is 60 minutes. Reasonable @@ -5409,9 +5842,11 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; to 1 day (1440 minutes). The maximum value is 28 days (40320 minutes). If set to 0, no zone maintenance for these zones will occur. -

+

+
interface-interval
-

+

+

The server will scan the network interface list every interface-interval minutes. The default @@ -5424,10 +5859,11 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; listen-on configuration), and will stop listening on interfaces that have gone away. -

+

+
statistics-interval
-

+

Name server statistics will be logged every statistics-interval minutes. The default is @@ -5436,18 +5872,21 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

Note

-

+

Not yet implemented in BIND 9.

-
-
+
+
-
-
+ +
+ +

Topology

-

+ +

All other things being equal, when the server chooses a name server to query from a list of name servers, it prefers the one that is @@ -5464,34 +5903,40 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; any non-negated list element, and closer than any negated element. For example,

+ 
topology {
     10/8;
     !1.2.3/24;
     { 1.2/16; 3/8; };
 };
-

+ +

will prefer servers on network 10 the most, followed by hosts on network 1.2.0.0 (netmask 255.255.0.0) and network 3, with the exception of hosts on network 1.2.3 (netmask 255.255.255.0), which is preferred least of all.

-

+

The default topology is

+ 
    topology { localhost; localnets; };
-
+ +

Note

-

+

The topology option is not implemented in BIND 9.

-
-
-
+
+
+ +

The sortlist Statement

-

+ +

The response to a DNS query may consist of multiple resource records (RRs) forming a resource records set (RRset). The name server will normally return the @@ -5507,7 +5952,8 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; in the server, based on the client's address. This only requires configuring the name servers, not all the clients.

-

+ +

The sortlist statement (see below) takes an address_match_list and @@ -5523,7 +5969,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; of each top level list is checked against the source address of the query until a match is found.

-

+

Once the source address of the query has been matched, if the top level statement contains only one element, the actual primitive @@ -5538,7 +5984,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; minimum distance is moved to the beginning of the response.

-

+

In the following example, any queries received from any of the addresses of the host itself will get responses preferring addresses @@ -5556,6 +6002,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; or the 192.168.5/24 network will only prefer other addresses on their directly connected networks.

+ 
sortlist {
     // IF the local host
     // THEN first fit on the following nets
@@ -5579,7 +6026,8 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
     { { 192.168.4/24; 192.168.5/24; };
     };
 };
-

+ +

The following example will give reasonable behavior for the local host and hosts on directly connected networks. It is similar to the behavior of the address sort in BIND 4.9.x. Responses sent @@ -5591,16 +6039,19 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; Responses to other queries will not be sorted.

+ 
sortlist {
            { localhost; localnets; };
            { localnets; };
 };
-
-
+ +
+

RRset Ordering

-

+ +

When multiple records are returned in an answer it may be useful to configure the order of the records placed into the response. @@ -5610,25 +6061,27 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; See also the sortlist statement, the section called “The sortlist Statement”.

-

+ +

An order_spec is defined as follows:

-

+

[class class_name] [type type_name] [name "domain_name"] order ordering

-

+

If no class is specified, the default is ANY. If no type is specified, the default is ANY. If no name is specified, the default is "*" (asterisk).

-

+

The legal values for ordering are:

-
+
+
@@ -5672,46 +6125,52 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; -
-

+ +

+

For example:

+ 
rrset-order {
    class IN type A name "host.example.com" order random;
    order cyclic;
 };
-

+ +

will cause any responses for type A records in class IN that have "host.example.com" as a suffix, to always be returned in random order. All other records are returned in cyclic order.

-

+

If multiple rrset-order statements appear, they are not combined — the last one applies.

-

+

By default, all records are returned in random order.

-
+ +

Note

-

+

In this release of BIND 9, the rrset-order statement does not support "fixed" ordering by default. Fixed ordering can be enabled at compile time by specifying "--enable-fixed-rrset" on the "configure" command line.

-
-
-
+
+
+ +

Tuning

-
+ +
lame-ttl
-

+

Sets the number of seconds to cache a lame server indication. 0 disables caching. (This is NOT recommended.) @@ -5719,15 +6178,18 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; maximum value is 1800 (30 minutes).

-

+ +

Lame-ttl also controls the amount of time DNSSEC validation failures are cached. There is a minimum of 30 seconds applied to bad cache entries if the lame-ttl is set to less than 30 seconds.

-
+ +
max-ncache-ttl
-

+

+

To reduce network traffic and increase performance, the server stores negative answers. max-ncache-ttl is used to set a maximum retention time for these answers in @@ -5737,9 +6199,11 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; max-ncache-ttl cannot exceed 7 days and will be silently truncated to 7 days if set to a greater value. -

+

+
max-cache-ttl
-

+

+

Sets the maximum time for which the server will cache ordinary (positive) answers. The default is one week (7 days). @@ -5747,25 +6211,26 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; SERVFAIL, because of lost caches of intermediate RRsets (such as NS and glue AAAA/A records) in the resolution process. -

+

+
min-roots
-

+

The minimum number of root servers that is required for a request for the root servers to be accepted. The default is 2.

-
+

Note

-

+

Not implemented in BIND 9.

-
-
+
+
sig-validity-interval
-

+

Specifies the number of days into the future when DNSSEC signatures automatically generated as a result of dynamic updates (the section called “Dynamic Update”) will expire. There @@ -5779,44 +6244,48 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; giving a re-signing interval of 7 1/2 days. The maximum values are 10 years (3660 days).

-

+

The signature inception time is unconditionally set to one hour before the current time to allow for a limited amount of clock skew.

-

+

The sig-validity-interval should be, at least, several multiples of the SOA expire interval to allow for reasonable interaction between the various timer and expiry dates.

-
+
sig-signing-nodes
-

+

+

Specify the maximum number of nodes to be examined in each quantum when signing a zone with a new DNSKEY. The default is 100. -

+

+
sig-signing-signatures
-

+

+

Specify a threshold number of signatures that will terminate processing a quantum when signing a zone with a new DNSKEY. The default is 10. -

+

+
sig-signing-type
-

+

Specify a private RDATA type to be used when generating signing state records. The default is 65534.

-

+

It is expected that this parameter may be removed in a future version once there is a standard type.

-

+

Signing state records are used to internally by named to track the current state of a zone-signing process, i.e., whether it is still active @@ -5832,12 +6301,12 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; records for a zone, use rndc signing -clear all zone.

-
+
min-refresh-time, max-refresh-time, min-retry-time, max-retry-time
-

+

These options control the server's behavior on refreshing a zone (querying for SOA changes) or retrying failed transfers. @@ -5847,7 +6316,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; little control over their contents.

-

+

These options allow the administrator to set a minimum and maximum refresh and retry time either per-zone, per-view, or @@ -5856,7 +6325,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; and clamp the SOA refresh and retry times to the specified values.

-

+

The following defaults apply. min-refresh-time 300 seconds, max-refresh-time 2419200 seconds @@ -5864,10 +6333,10 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; and max-retry-time 1209600 seconds (2 weeks).

-
+
edns-udp-size
-

+

Sets the maximum advertised EDNS UDP buffer size in bytes, to control the size of packets received from authoritative servers in response to recursive queries. @@ -5875,19 +6344,19 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; will be silently adjusted to the nearest value within it). The default value is 4096.

-

+

The usual reason for setting edns-udp-size to a non-default value is to get UDP answers to pass through broken firewalls that block fragmented packets and/or block UDP DNS packets that are greater than 512 bytes.

-

+

When named first queries a remote server, it will advertise a UDP buffer size of 512, as this has the greatest chance of success on the first try.

-

+

If the initial response times out, named will try again with plain DNS, and if that is successful, it will be taken as evidence that the server does not @@ -5898,7 +6367,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; will send an EDNS query to see if the situation has improved.)

-

+

However, if the initial query is successful with EDNS advertising a buffer size of 512, then named will advertise progressively @@ -5906,7 +6375,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; responses begin timing out or edns-udp-size is reached.

-

+

The default buffer sizes used by named are 512, 1232, 1432, and 4096, but never exceeding edns-udp-size. (The values 1232 and @@ -5914,22 +6383,22 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; UDP message to be sent without fragmentation at the minimum MTU sizes for Ethernet and IPv6 networks.)

-
+
max-udp-size
-

+

Sets the maximum EDNS UDP message size named will send in bytes. Valid values are 512 to 4096 (values outside this range will be silently adjusted to the nearest value within it). The default value is 4096.

-

+

This value applies to responses sent by a server; to set the advertised buffer size in queries, see edns-udp-size.

-

+

The usual reason for setting max-udp-size to a non-default value is to get UDP answers to pass through broken @@ -5938,14 +6407,14 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; This is independent of the advertised receive buffer (edns-udp-size).

-

+

Setting this to a low value will encourage additional TCP traffic to the nameserver.

-
+
masterfile-format
-

Specifies +

Specifies the file format of zone files (see the section called “Additional File Formats”). The default value is text, which is the @@ -5956,7 +6425,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; named-compilezone tool, or dumped by named.

-

+

Note that when a zone file in a different format than text is loaded, named may omit some of the checks which would be performed for a @@ -5970,7 +6439,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; loaded directly into memory via memory mapping, with only minimal checking.

-

+

This statement sets the masterfile-format for all zones, but can be overridden on a per-zone or per-view basis @@ -5979,11 +6448,12 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; view block in the configuration file.

-
+
max-recursion-depth
-

+

+

Sets the maximum number of levels of recursion that are permitted at any one time while servicing a recursive query. Resolving a name may require @@ -5992,11 +6462,13 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; of indirections exceeds this value, the recursive query is terminated and returns SERVFAIL. The default is 7. -

+

+
max-recursion-queries
-

+

+

Sets the maximum number of iterative queries that may be sent while servicing a recursive query. If more queries are sent, the recursive query @@ -6004,35 +6476,38 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; look up top level comains such as "com" and "net" and the DNS root zone are exempt from this limitation. The default is 75. -

+

+
notify-delay
-

+

The delay, in seconds, between sending sets of notify messages for a zone. The default is five (5) seconds.

-

+

The overall rate that NOTIFY messages are sent for all zones is controlled by serial-query-rate.

-
+
max-rsa-exponent-size
-

+

+

The maximum RSA exponent size, in bits, that will be accepted when validating. Valid values are 35 to 4096 bits. The default zero (0) is also accepted and is equivalent to 4096. -

+

+
prefetch
-

+

When a query is received for cached data which is to expire shortly, named can refresh the data from the authoritative server immediately, ensuring that the cache always has an answer available.

-

+

The prefetch specifies the "trigger" TTL value at which prefetch of the current query will take place: when a cache record with a @@ -6044,7 +6519,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; prefetch to be disabled. The default trigger TTL is 2.

-

+

An optional second argument specifies the "eligibility" TTL: the smallest original TTL value that will be accepted for a record to be @@ -6054,13 +6529,16 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; adjust it upward. The default eligibility TTL is 9.

-
+
-
-
+ +
+ +

Built-in server information zones

-

+ +

The server provides some helpful diagnostic information through a number of built-in zones under the pseudo-top-level-domain bind in the @@ -6079,25 +6557,29 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; rate-limit is set to allow three responses per second.

-

+

If you need to disable these zones, use the options below, or hide the built-in CHAOS view by defining an explicit view of class CHAOS that matches all clients.

-
+ +
version
-

+

+

The version the server should report via a query of the name version.bind with type TXT, class CHAOS. The default is the real version number of this server. Specifying version none disables processing of the queries. -

+

+
hostname
-

+

+

The hostname the server should report via a query of the name hostname.bind with type TXT, class CHAOS. @@ -6108,9 +6590,11 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; identify which of a group of anycast servers is actually answering your queries. Specifying hostname none; disables processing of the queries. -

+

+
server-id
-

+

+

The ID the server should report when receiving a Name Server Identifier (NSID) query, or a query of the name ID.SERVER with type @@ -6122,13 +6606,17 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; Specifying server-id hostname; will cause named to use the hostname as found by the gethostname() function. The default server-id is none. -

+

+
-
-
+ +
+ +

Built-in Empty Zones

-

+ +

Named has some built-in empty zones (SOA and NS records only). These are for zones that should normally be answered locally and which queries should not be sent to the Internet's root @@ -6140,12 +6628,12 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; IPv6 link local addresses, the IPv6 loopback address and the IPv6 unknown address.

-

+

Named will attempt to determine if a built-in zone already exists or is active (covered by a forward-only forwarding declaration) and will not create an empty zone in that case.

-

+

The current list of empty zones is:

    @@ -6249,7 +6737,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

-

+

Empty zones are settable at the view level and only apply to views of class IN. Disabled empty zones are only inherited from options if there are no disabled empty zones specified @@ -6261,7 +6749,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

-

+

If you are using the address ranges covered here, you should already have reverse zones covering the addresses you use. In practice this appears to not be the case with many queries @@ -6270,7 +6758,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; to be deployed to channel the query load away from the infrastructure servers.

-
+

Note

The real parent servers for these zones should disable all @@ -6279,35 +6767,46 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; enable them to return referrals to deeper in the tree.

-
+
empty-server
-

+

+

Specify what server name will appear in the returned SOA record for empty zones. If none is specified, then the zone's name will be used. -

+

+
empty-contact
-

+

+

Specify what contact name will appear in the returned SOA record for empty zones. If none is specified, then "." will be used. -

+

+
empty-zones-enable
-

+

+

Enable or disable all empty zones. By default, they are enabled. -

+

+
disable-empty-zone
-

+

+

Disable individual empty zones. By default, none are disabled. This option can be specified multiple times. -

+

+
-
-
+
+ +

Additional Section Caching

-

+ + +

The additional section cache, also called acache, is an internal cache to improve the response performance of BIND 9. When additional section caching is enabled, BIND 9 will @@ -6317,7 +6816,8 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; mechanism of BIND 9, and is not related to the DNS caching server function.

-

+ +

Additional section caching does not change the response content (except the RRsets ordering of the additional section, see below), but can improve the response performance @@ -6325,7 +6825,8 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; It is particularly effective when BIND 9 acts as an authoritative server for a zone that has many delegations with many glue RRs.

-

+ +

In order to obtain the maximum performance improvement from additional section caching, setting additional-from-cache @@ -6334,7 +6835,8 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; does not short-cut of additional section information from the DNS cache data.

-

+ +

One obvious disadvantage of acache is that it requires much more memory for the internal cached data. @@ -6347,7 +6849,8 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; consumption for acache by using max-acache-size.

-

+ +

Additional section caching also has a minor effect on the RRset ordering in the additional section. Without acache, @@ -6363,26 +6866,33 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; it only contains a single RR), in which case the ordering does not matter much.

-

+ +

The following is a summary of options related to acache.

-
+ +
acache-enable
-

+

+

If yes, additional section caching is enabled. The default value is no. -

+

+
acache-cleaning-interval
-

+

+

The server will remove stale cache entries, based on an LRU based algorithm, every acache-cleaning-interval minutes. The default is 60 minutes. If set to 0, no periodic cleaning will occur. -

+

+
max-acache-size
-

+

+

The maximum amount of memory in bytes to use for the server's acache. When the amount of data in the acache reaches this limit, the server @@ -6392,13 +6902,17 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; separately to the acache of each view. The default is 16M. -

+

+
-
-
+ +
+ +

Content Filtering

-

+ +

BIND 9 provides the ability to filter out DNS responses from external DNS servers containing certain types of data in the answer section. @@ -6424,10 +6938,12 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; deny-answer-aliases, 

www.example.com. CNAME xxx.example.com.
-

+ +

returned by an "example.com" server will be accepted.

-

+ +

In the address_match_list of the deny-answer-addresses option, only ip_addr @@ -6435,12 +6951,14 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; are meaningful; any key_id will be silently ignored.

-

+ +

If a response message is rejected due to the filtering, the entire message is discarded without being cached, and a SERVFAIL error will be returned to the client.

-

+ +

This filtering is intended to prevent "DNS rebinding attacks," in which an attacker, in response to a query for a domain name the attacker controls, returns an IP address within your own network or @@ -6455,39 +6973,48 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; for more details about the attacks.

-

+ +

For example, if you own a domain named "example.net" and your internal network uses an IPv4 prefix 192.0.2.0/24, you might specify the following rules:

+ 
deny-answer-addresses { 192.0.2.0/24; } except-from { "example.net"; };
 deny-answer-aliases { "example.net"; };
-

+ +

If an external attacker lets a web browser in your local network look up an IPv4 address of "attacker.example.com", the attacker's DNS server would return a response like this:

+ 
attacker.example.com. A 192.0.2.1
-

+ +

in the answer section. Since the rdata of this record (the IPv4 address) matches the specified prefix 192.0.2.0/24, this response will be ignored.

-

+ +

On the other hand, if the browser looks up a legitimate internal web server "www.example.net" and the following response is returned to the BIND 9 server

+ 
www.example.net. A 192.0.2.2
-

+ +

it will be accepted since the owner name "www.example.net" matches the except-from element, "example.net".

-

+ +

Note that this is not really an attack on the DNS per se. In fact, there is nothing wrong for an "external" name to be mapped to your "internal" IP address or domain name @@ -6508,7 +7035,8 @@ deny-answer-aliases { "example.net"; }; very sure you have no other choice and the attack is a real threat for your applications.

-

+ +

Care should be particularly taken if you want to use this option for addresses within 127.0.0.0/8. These addresses are obviously "internal", but many @@ -6517,11 +7045,13 @@ deny-answer-aliases { "example.net"; }; Filtering out DNS records containing this address spuriously can break such applications.

-
-
+
+ +

Response Policy Zone (RPZ) Rewriting

-

+ +

BIND 9 includes a limited mechanism to modify DNS responses for requests analogous to email anti-spam DNS blacklists. @@ -6529,7 +7059,8 @@ deny-answer-aliases { "example.net"; }; deny the existence of IP addresses for domains (NODATA), or contain other IP addresses or data.

-

+ +

Response policy zones are named in the response-policy option for the view or among the global options if there is no response-policy option for the view. @@ -6540,7 +7071,8 @@ deny-answer-aliases { "example.net"; }; Note that zones using masterfile-format map cannot be used as policy zones.

-

+ +

A response-policy option can support multiple policy zones. To maximize performance, a radix tree is used to quickly identify response policy zones @@ -6549,13 +7081,14 @@ deny-answer-aliases { "example.net"; }; in a single response-policy option; more than that is a configuration error.

-

+ +

Five policy triggers can be encoded in RPZ records.

RPZ-CLIENT-IP
-

+

IP records are triggered by the IP address of the DNS client. Client IP address triggers are encoded in records that have @@ -6570,7 +7103,8 @@ deny-answer-aliases { "example.net"; }; B4 is the decimal value of the least significant byte of the IPv4 address as in IN-ADDR.ARPA.

-

+ +

IPv6 addresses are encoded in a format similar to the standard IPv6 text representation, prefixlength.W8.W7.W6.W5.W4.W3.W2.W1.rpz-client-ip. @@ -6586,24 +7120,29 @@ deny-answer-aliases { "example.net"; }; encodings. The IPv6 prefix length must be between 1 and 128.

-
+
QNAME
-

+

+

QNAME policy records are triggered by query names of requests and targets of CNAME records resolved to generate the response. The owner name of a QNAME policy record is the query name relativized to the policy zone. -

+

+
RPZ-IP
-

+

+

IP triggers are IP addresses in an A or AAAA record in the ANSWER section of a response. They are encoded like client-IP triggers except as subdomains of rpz-ip. -

+

+
RPZ-NSDNAME
-

+

+

NSDNAME triggers match names of authoritative servers for the query name, a parent of the query name, a CNAME for query name, or a parent of a CNAME. @@ -6613,20 +7152,24 @@ deny-answer-aliases { "example.net"; }; NSIP triggers match IP addresses in A and AAAA RRsets for domains that can be checked against NSDNAME policy records. -

+

+
RPZ-NSIP
-

+

+

NSIP triggers are encoded like IP triggers except as subdomains of rpz-nsip. NSDNAME and NSIP triggers are checked only for names with at least min-ns-dots dots. The default value of min-ns-dots is 1 to exclude top level domains. -

+

+

-

+ +

The query response is checked against all response policy zones, so two or more policy records can be triggered by a response. Because DNS responses are rewritten according to at most one @@ -6655,14 +7198,16 @@ deny-answer-aliases { "example.net"; };

-

+ +

When the processing of a response is restarted to resolve DNAME or CNAME records and a policy record set has not been triggered, all response policy zones are again consulted for the DNAME or CNAME names and addresses.

-

+ +

RPZ record sets are any types of DNS record except DNAME or DNSSEC that encode actions or responses to individual queries. @@ -6674,48 +7219,59 @@ deny-answer-aliases { "example.net"; };

PASSTHRU
-

+

+

The whitelist policy is specified by a CNAME whose target is rpz-passthru. It causes the response to not be rewritten and is most often used to "poke holes" in policies for CIDR blocks. -

+

+
DROP
-

+

+

The blacklist policy is specified by a CNAME whose target is rpz-drop. It causes the response to be discarded. Nothing is sent to the DNS client. -

+

+
TCP-Only
-

+

+

The "slip" policy is specified by a CNAME whose target is rpz-tcp-only. It changes UDP responses to short, truncated DNS responses that require the DNS client to try again with TCP. It is used to mitigate distributed DNS reflection attacks. -

+

+
NXDOMAIN
-

+

+

The domain undefined response is encoded by a CNAME whose target is the root domain (.) -

+

+
NODATA
-

+

+

The empty set of resource records is specified by CNAME whose target is the wildcard top-level domain (*.). It rewrites the response to NODATA or ANCOUNT=1. -

+

+
Local Data
-

+

A set of ordinary DNS records can be used to answer queries. Queries for record types not the set are answered with NODATA.

-

+ +

A special form of local data is a CNAME whose target is a wildcard such as *.example.com. It is used as if were an ordinary CNAME after the astrisk (*) @@ -6723,11 +7279,12 @@ deny-answer-aliases { "example.net"; }; The purpose for this special form is query logging in the walled garden's authority DNS server.

-
+

-

+ +

All of the actions specified in all of the individual records in a policy zone can be overridden with a policy clause in the @@ -6738,11 +7295,14 @@ deny-answer-aliases { "example.net"; };

GIVEN
-

The placeholder policy says "do not override but +

+

The placeholder policy says "do not override but perform the action specified in the zone." -

+

+
DISABLED
-

+

+

The testing override policy causes policy zone records to do nothing but log what they would have done if the policy zone were not disabled. @@ -6752,22 +7312,28 @@ deny-answer-aliases { "example.net"; }; Disabled policy zones should appear first, because they will often not be logged if a higher precedence trigger is found first. -

+

+
PASSTHRU, DROP, TCP-Only, NXDOMAIN, NODATA
-

+

+

override with the corresponding per-record policy. -

+

+
CNAME domain
-

+

+

causes all RPZ policy records to act as if they were "cname domain" records. -

+

+

-

+ +

By default, the actions encoded in a response policy zone are applied only to queries that ask for recursion (RD=1). That default can be changed for a single policy zone or @@ -6778,7 +7344,8 @@ deny-answer-aliases { "example.net"; }; delete answers that would otherwise contain RFC 1918 values on the externally visible name server or view.

-

+ +

Also by default, RPZ actions are applied only to DNS requests that either do not request DNSSEC metadata (DO=0) or when no DNSSEC records are available for request name in the original @@ -6789,7 +7356,8 @@ deny-answer-aliases { "example.net"; }; clause option reflects the fact that results rewritten by RPZ actions cannot verify.

-

+ +

No DNS records are needed for a QNAME or Client-IP trigger. The name or IP address itself is sufficient, so in principle the query name need not be recursively resolved. @@ -6816,22 +7384,24 @@ deny-answer-aliases { "example.net"; }; appear to be rewritten, since no recursion is being done to discover problems at the authoritative server.

-

+ +

The TTL of a record modified by RPZ policies is set from the TTL of the relevant record in policy zone. It is then limited to a maximum value. The max-policy-ttl clause changes that maximum from its default of 5.

-

+ +

For example, you might use this option statement 

    response-policy { zone "badlist"; };
-

+

and this zone statement 

    zone "badlist" {type master; file "master/badlist"; allow-query {none;}; };
-

+

with this zone file 

$TTL 1H
@@ -6873,7 +7443,7 @@ example.com                 CNAME   rpz-tcp-only.
 *.example.com               CNAME   rpz-tcp-only.
-

+

RPZ can affect server performance. Each configured response policy zone requires the server to perform one to four additional database lookups before a @@ -6888,15 +7458,18 @@ example.com CNAME rpz-tcp-only. A server with four response policy zones with QNAME and IP triggers might have a maximum QPS rate about 50% lower.

-

+ +

Responses rewritten by RPZ are counted in the RPZRewrites statistics.

-
-
+
+ +

Response Rate Limiting

-

+ +

Excessive almost identical UDP responses can be controlled by configuring a rate-limit clause in an @@ -6909,7 +7482,8 @@ example.com CNAME rpz-tcp-only. Legitimate clients react to dropped or truncated response by retrying with UDP or with TCP respectively.

-

+ +

This mechanism is intended for authoritative DNS servers. It can be used on recursive servers but can slow applications such as SMTP servers (mail receivers) and @@ -6917,7 +7491,8 @@ example.com CNAME rpz-tcp-only. same domains. When possible, closing "open" recursive servers is better.

-

+ +

Response rate limiting uses a "credit" or "token bucket" scheme. Each combination of identical response and client has a conceptual account that earns a specified number @@ -6936,7 +7511,8 @@ example.com CNAME rpz-tcp-only. When the specified number of credits for a class of responses is set to 0, those responses are not rate limited.

-

+ +

The notions of "identical response" and "DNS client" for rate limiting are not simplistic. All responses to an address block are counted as if to a @@ -6945,7 +7521,8 @@ example.com CNAME rpz-tcp-only. specified with ipv4-prefix-length (default 24) and ipv6-prefix-length (default 56).

-

+ +

All non-empty responses for a valid domain name (qname) and record type (qtype) are identical and have a limit specified with responses-per-second @@ -6969,12 +7546,14 @@ example.com CNAME rpz-tcp-only. referrals-per-second (default responses-per-second).

-

+ +

Responses generated from local wildcards are counted and limited as if they were for the parent domain name. This controls flooding using random.wild.example.com.

-

+ +

All requests that result in DNS errors other than NXDOMAIN, such as SERVFAIL and FORMERR, are identical regardless of requested name (qname) or record type (qtype). @@ -6985,7 +7564,8 @@ example.com CNAME rpz-tcp-only. but it can be set separately with errors-per-second.

-

+ +

Many attacks using DNS involve UDP requests with forged source addresses. Rate limiting prevents the use of BIND 9 to flood a network @@ -7009,7 +7589,8 @@ example.com CNAME rpz-tcp-only. cannot be replaced with truncated responses and are instead leaked at the slip rate.

-

+ +

(NOTE: Dropped responses from an authoritative server may reduce the difficulty of a third party successfully forging a response to a recursive resolver. The best security @@ -7022,7 +7603,8 @@ example.com CNAME rpz-tcp-only. responses to be truncated rather than dropped. This reduces the effectiveness of rate-limiting against reflection attacks.)

-

+ +

When the approximate query per second rate exceeds the qps-scale value, then the responses-per-second, @@ -7040,7 +7622,8 @@ example.com CNAME rpz-tcp-only. Responses sent via TCP are not limited but are counted to compute the query per second rate.

-

+ +

Communities of DNS clients can be given their own parameters or no rate limiting by putting rate-limit statements in view @@ -7052,7 +7635,8 @@ example.com CNAME rpz-tcp-only. DNS clients within a view can be exempted from rate limits with the exempt-clients clause.

-

+ +

UDP responses of all kinds can be limited with the all-per-second phrase. This rate limiting is unlike the rate limiting provided by @@ -7088,7 +7672,8 @@ example.com CNAME rpz-tcp-only. but that rate limiting must be done before the DNS server sees the requests.

-

+ +

The maximum size of the table used to track requests and rate limit responses is set with max-table-size. Each entry in the table is between 40 and 80 bytes. @@ -7102,22 +7687,26 @@ example.com CNAME rpz-tcp-only. expansions of the table and inform choices for the initial and maximum table size.

-

+ +

Use log-only yes to test rate limiting parameters without actually dropping any requests.

-

+ +

Responses dropped by rate limits are included in the RateDropped and QryDropped statistics. Responses that truncated by rate limits are included in RateSlipped and RespTruncated.

-
-
-
+
+
+ +

server Statement Grammar

+ 
server ( ip_addr | ip_prefix ) {
   [ bogus yes_or_no ; ]
   [ provide-ixfr yes_or_no ; ]
@@ -7148,12 +7737,15 @@ example.com                 CNAME   rpz-tcp-only.
   [ queryport-pool-updateinterval number ; ]
 } ;
-
-
+ +
+ +

server Statement Definition and Usage

-

+ +

The server statement defines characteristics to be associated with a remote name server. If a prefix length is @@ -7162,7 +7754,8 @@ example.com CNAME rpz-tcp-only. server clause applies regardless of the order in named.conf.

-

+ +

The server statement can occur at the top level of the configuration file or inside a view @@ -7177,13 +7770,14 @@ example.com CNAME rpz-tcp-only. used as defaults.

-

+ +

If you discover that a remote server is giving out bad data, marking it as bogus will prevent further queries to it. The default value of bogus is no.

-

+

The provide-ixfr clause determines whether the local server, acting as master, will respond with an @@ -7199,7 +7793,8 @@ example.com CNAME rpz-tcp-only. view or global options block is used as a default.

-

+ +

The request-ixfr clause determines whether the local server, acting as a slave, will request incremental zone @@ -7209,7 +7804,8 @@ example.com CNAME rpz-tcp-only. also be set in the zone block and, if set there, it will override the global or view setting for that zone.

-

+ +

IXFR requests to servers that do not support IXFR will automatically fall back to AXFR. Therefore, there is no need to manually list @@ -7223,12 +7819,14 @@ example.com CNAME rpz-tcp-only. and slave claim to support it, for example if one of the servers is buggy and crashes or corrupts data when IXFR is used.

-

+ +

The edns clause determines whether the local server will attempt to use EDNS when communicating with the remote server. The default is yes.

-

+ +

The edns-udp-size option sets the EDNS UDP size that is advertised by named when querying the remote server. Valid values are 512 @@ -7247,7 +7845,8 @@ example.com CNAME rpz-tcp-only. behavior may be brought into conformance with the options/view behavior in future releases.)

-

+ +

The max-udp-size option sets the maximum EDNS UDP message size named will send. Valid values are 512 to 4096 bytes (values outside this range will @@ -7255,13 +7854,15 @@ example.com CNAME rpz-tcp-only. know that there is a firewall that is blocking large replies from named.

-

+ +

The tcp-only option sets the transport protocol to TCP. The default is to use the UDP transport and to fallback on TCP only when a truncated response is received.

-

+ +

The server supports two zone transfer methods. The first, one-answer, uses one DNS message per resource record transferred. many-answers packs as many resource records as possible into a message. many-answers is @@ -7275,14 +7876,16 @@ example.com CNAME rpz-tcp-only. by the options statement will be used.

-

transfers + +

transfers is used to limit the number of concurrent inbound zone transfers from the specified server. If no transfers clause is specified, the limit is set according to the transfers-per-ns option.

-

+ +

The keys clause identifies a key_id defined by the key statement, to be used for transaction security (TSIG, the section called “TSIG”) @@ -7293,10 +7896,12 @@ example.com CNAME rpz-tcp-only. required to be signed by this key.

-

+ +

Only a single key per server is currently supported.

-

+ +

The transfer-source and transfer-source-v6 clauses specify the IPv4 and IPv6 source @@ -7312,7 +7917,8 @@ example.com CNAME rpz-tcp-only. transfer-source-v6 in the section called “Zone Transfers”.

-

+ +

The notify-source and notify-source-v6 clauses specify the IPv4 and IPv6 source address to be used for notify @@ -7321,7 +7927,8 @@ example.com CNAME rpz-tcp-only. can be specified. Similarly, for an IPv6 remote server, only notify-source-v6 can be specified.

-

+ +

The query-source and query-source-v6 clauses specify the IPv4 and IPv6 source address to be used for queries @@ -7330,14 +7937,16 @@ example.com CNAME rpz-tcp-only. be specified. Similarly, for an IPv6 remote server, only query-source-v6 can be specified.

-

+ +

The request-nsid clause determines whether the local server will add a NSID EDNS option to requests sent to the server. This overrides request-nsid set at the view or option level.

-

+ +

The request-sit clause determines whether the local server will add a SIT EDNS option to requests sent to the server. This overrides @@ -7346,28 +7955,33 @@ example.com CNAME rpz-tcp-only. supported by the remote server and not add a SIT EDNS option to requests.

-
-
+
+ +

statistics-channels Statement Grammar

+ 
statistics-channels {
   [ inet ( ip_addr | * ) [ port ip_port ]
       [ allow {  address_match_list  } ] ; ]
     ...
 };
-
-
+
+ +

statistics-channels Statement Definition and Usage

-

+ +

The statistics-channels statement declares communication channels to be used by system administrators to get access to statistics information of the name server.

-

+ +

This statement intends to be flexible to support multiple communication protocols in the future, but currently only HTTP access is supported. @@ -7377,7 +7991,8 @@ example.com CNAME rpz-tcp-only. still accepted even if it is built without the library, but any HTTP access will fail with an error.

-

+ +

An inet control channel is a TCP socket listening at the specified ip_port on the specified ip_addr, which can be an IPv4 or IPv6 @@ -7388,12 +8003,14 @@ example.com CNAME rpz-tcp-only. To listen on the IPv6 wildcard address, use an ip_addr of ::.

-

+ +

If no port is specified, port 80 is used for HTTP channels. The asterisk "*" cannot be used for ip_port.

-

+ +

The attempt of opening a statistics channel is restricted by the optional allow clause. Connections to the statistics channel are permitted based on the @@ -7405,11 +8022,13 @@ example.com CNAME rpz-tcp-only. recommended to restrict the source of connection requests appropriately.

-

+ +

If no statistics-channels statement is present, named will not open any communication channels.

-

+ +

The statistics are available in various formats and views depending on the URI used to access them. For example, if the statistics channel is configured to listen on 127.0.0.1 @@ -7421,7 +8040,8 @@ example.com CNAME rpz-tcp-only. charts and graphs using the Google Charts API when using a javascript-capable browser.

-

+ +

Applications that depend on a particular XML schema can request http://127.0.0.1:8888/xml/v2 for version 2 @@ -7431,7 +8051,8 @@ example.com CNAME rpz-tcp-only. it will respond; if not, it will return a "page not found" error.

-

+ +

Broken-out subsets of the statistics can be viewed at http://127.0.0.1:8888/xml/v3/status (server uptime and last reconfiguration time), @@ -7446,7 +8067,8 @@ example.com CNAME rpz-tcp-only. http://127.0.0.1:8888/xml/v3/tasks (task manager statistics).

-

+ +

The full set of statistics can also be read in JSON format at http://127.0.0.1:8888/json, with the broken-out subsets at @@ -7463,21 +8085,25 @@ example.com CNAME rpz-tcp-only. http://127.0.0.1:8888/json/v1/tasks (task manager statistics).

-
-
+
+ +

trusted-keys Statement Grammar

+ 
trusted-keys {
   ( domain_name flags protocol algorithm key_data ; )
     ...
 } ;
-
-
+ +
+

trusted-keys Statement Definition and Usage

-

+ +

The trusted-keys statement defines DNSSEC security roots. DNSSEC is described in the section called “DNSSEC”. A security root is defined when the public key for a non-authoritative zone is known, but @@ -7488,7 +8114,7 @@ example.com CNAME rpz-tcp-only. proven secure. The resolver attempts DNSSEC validation on all DNS data in subdomains of a security root.

-

+

All keys (and corresponding zones) listed in trusted-keys are deemed to exist regardless of what parent zones say. Similarly for all keys listed in @@ -7496,7 +8122,7 @@ example.com CNAME rpz-tcp-only. used to validate the DNSKEY RRset. The parent's DS RRset will not be used.

-

+

The trusted-keys statement can contain multiple key entries, each consisting of the key's domain name, flags, protocol, algorithm, and the Base-64 @@ -7505,28 +8131,32 @@ example.com CNAME rpz-tcp-only. in the key data, so the configuration may be split up into multiple lines.

-

+

trusted-keys may be set at the top level of named.conf or within a view. If it is set in both places, they are additive: keys defined at the top level are inherited by all views, but keys defined in a view are only used within that view.

-
-
+
+ +

managed-keys Statement Grammar

+ 
managed-keys {
   ( domain_name initial_key flags protocol algorithm key_data ; )
     ...
 } ;
-
-
+ +
+

managed-keys Statement Definition and Usage

-

+ +

The managed-keys statement, like trusted-keys, defines DNSSEC security roots. The difference is that @@ -7534,7 +8164,7 @@ example.com CNAME rpz-tcp-only. automatically, without intervention from the resolver operator.

-

+

Suppose, for example, that a zone's key-signing key was compromised, and the zone owner had to revoke and replace the key. A resolver which had the old key in a @@ -7544,7 +8174,7 @@ example.com CNAME rpz-tcp-only. continue until the resolver operator had updated the trusted-keys statement with the new key.

-

+

If, however, the zone were listed in a managed-keys statement instead, then the zone owner could add a "stand-by" key to the zone in advance. @@ -7555,7 +8185,7 @@ example.com CNAME rpz-tcp-only. using that key to validate answers, minimizing the damage that the compromised key could do.

-

+

A managed-keys statement contains a list of the keys to be managed, along with information about how the keys are to be initialized for the first time. The only @@ -7566,7 +8196,7 @@ example.com CNAME rpz-tcp-only. allow keys to be initialized by other methods, eliminating this requirement.)

-

+

Consequently, a managed-keys statement appears similar to a trusted-keys, differing in the presence of the second field, containing the keyword @@ -7579,7 +8209,7 @@ example.com CNAME rpz-tcp-only. managed key database and start the RFC 5011 key maintenance process.

-

+

The first time named runs with a managed key configured in named.conf, it fetches the DNSKEY RRset directly from the zone apex, and validates it @@ -7587,7 +8217,7 @@ example.com CNAME rpz-tcp-only. statement. If the DNSKEY RRset is validly signed, then it is used as the basis for a new managed keys database.

-

+

From that point on, whenever named runs, it sees the managed-keys statement, checks to make sure RFC 5011 key maintenance has already been initialized @@ -7596,7 +8226,7 @@ example.com CNAME rpz-tcp-only. statement is not used to validate answers; it has been superseded by the key or keys stored in the managed keys database.

-

+

The next time named runs after a name has been removed from the managed-keys statement, the corresponding @@ -7604,18 +8234,18 @@ example.com CNAME rpz-tcp-only. and RFC 5011 key maintenance will no longer be used for that domain.

-

+

In the current implementation, the managed keys database is stored as a master-format zone file.

-

+

On servers which do not use views, this file is named managed-keys.bind. When views are in use, there will be a separate managed keys database for each view; the filename will be a hash of the view name followed by the suffix .mkeys.

-

+

When the key database is changed, the zone is updated. As with any other dynamic zone, changes will be written into a journal file, e.g., @@ -7628,7 +8258,7 @@ example.com CNAME rpz-tcp-only. (For this reason among others, the working directory should be always be writable by named.)

-

+

If the dnssec-validation option is set to auto, named will automatically initialize a managed key for the @@ -7642,10 +8272,12 @@ example.com CNAME rpz-tcp-only. named, and can be overridden from bindkeys-file.

-
-
+
+ +

view Statement Grammar

+ 
view view_name [ class ] {
     match-clients { address_match_list } ;
     match-destinations { address_match_list } ;
@@ -7654,11 +8286,13 @@ example.com                 CNAME   rpz-tcp-only.
   [ zone_statement ; ... ]
 } ;
-
-
+ +
+

view Statement Definition and Usage

-

+ +

The view statement is a powerful feature of BIND 9 that lets a name server @@ -7667,7 +8301,8 @@ example.com CNAME rpz-tcp-only. implementing split DNS setups without having to run multiple servers.

-

+ +

Each view statement defines a view of the DNS namespace that will be seen by a subset of clients. A client @@ -7695,7 +8330,8 @@ example.com CNAME rpz-tcp-only. a client request will be resolved in the context of the first view that it matches.

-

+ +

Zones defined within a view statement will only be accessible to clients that match the view. @@ -7704,7 +8340,8 @@ example.com CNAME rpz-tcp-only. "internal" and "external" clients in a split DNS setup.

-

+ +

Many of the options given in the options statement can also be used within a view statement, and then @@ -7717,12 +8354,14 @@ example.com CNAME rpz-tcp-only. view-specific defaults take precedence over those in the options statement.

-

+ +

Views are class specific. If no class is given, class IN is assumed. Note that all non-IN views must contain a hint zone, since only the IN class has compiled-in default hints.

-

+ +

If there are no view statements in the config file, a default view that matches any client is automatically @@ -7738,10 +8377,12 @@ example.com CNAME rpz-tcp-only. statements must occur inside view statements.

-

+ +

Here is an example of a typical split DNS setup implemented using view statements:

+ 
view "internal" {
       // This should match our internal networks.
       match-clients { 10.0.0.0/8; };
@@ -7774,11 +8415,13 @@ view "external" {
       };
 };
-
-
+ +
+

zone Statement Grammar

+ 
zone zone_name [ class ] {
     type master ;
   [ allow-query { address_match_list } ; ]
@@ -7986,14 +8629,17 @@ view "external" {
 } ;
-
-
+ +
+

zone Statement Definition and Usage

-
+ +

Zone Types

-

+ +

The type keyword is required for the zone configuration unless it is an in-view configuration. Its @@ -8003,7 +8649,9 @@ view "external" { slave, static-stub, and stub.

-
+ +
+
@@ -8316,17 +8964,20 @@ view "external" { -
-
-
+ +
+
+ +

Class

-

+ +

The zone's name may optionally be followed by a class. If a class is not specified, class IN (for Internet), is assumed. This is correct for the vast majority of cases.

-

+

The hesiod class is named for an information service from MIT's Project Athena. It is @@ -8335,52 +8986,69 @@ view "external" { HS is a synonym for hesiod.

-

+

Another MIT development is Chaosnet, a LAN protocol created in the mid-1970s. Zone data for it can be specified with the CHAOS class.

-
-
+
+ +

Zone Options

-
+ +
allow-notify
-

+

+

See the description of allow-notify in the section called “Access Control”. -

+

+
allow-query
-

+

+

See the description of allow-query in the section called “Access Control”. -

+

+
allow-query-on
-

+

+

See the description of allow-query-on in the section called “Access Control”. -

+

+
allow-transfer
-

+

+

See the description of allow-transfer in the section called “Access Control”. -

+

+
allow-update
-

+

+

See the description of allow-update in the section called “Access Control”. -

+

+
update-policy
-

+

+

Specifies a "Simple Secure Update" policy. See the section called “Dynamic Update Policies”. -

+

+
allow-update-forwarding
-

+

+

See the description of allow-update-forwarding in the section called “Access Control”. -

+

+
also-notify
-

+

+

Only meaningful if notify is active for this zone. The set of machines that will @@ -8401,9 +9069,11 @@ view "external" { also-notify is not meaningful for stub zones. The default is the empty list. -

+

+
check-names
-

+

+

This option is used to restrict the character set and syntax of certain domain names in master files and/or DNS responses @@ -8411,67 +9081,90 @@ view "external" { network. The default varies according to zone type. For master zones the default is fail. For slave zones the default is warn. It is not implemented for hint zones. -

+

+
check-mx
-

+

+

See the description of check-mx in the section called “Boolean Options”. -

+

+
check-spf
-

+

+

See the description of check-spf in the section called “Boolean Options”. -

+

+
check-wildcard
-

+

+

See the description of check-wildcard in the section called “Boolean Options”. -

+

+
check-integrity
-

+

+

See the description of check-integrity in the section called “Boolean Options”. -

+

+
check-sibling
-

+

+

See the description of check-sibling in the section called “Boolean Options”. -

+

+
zero-no-soa-ttl
-

+

+

See the description of zero-no-soa-ttl in the section called “Boolean Options”. -

+

+
update-check-ksk
-

+

+

See the description of update-check-ksk in the section called “Boolean Options”. -

+

+
dnssec-loadkeys-interval
-

+

+

See the description of dnssec-loadkeys-interval in the section called “options Statement Definition and Usage”. -

+

+
dnssec-update-mode
-

+

+

See the description of dnssec-update-mode in the section called “options Statement Definition and Usage”. -

+

+
dnssec-dnskey-kskonly
-

+

+

See the description of dnssec-dnskey-kskonly in the section called “Boolean Options”. -

+

+
try-tcp-refresh
-

+

+

See the description of try-tcp-refresh in the section called “Boolean Options”. -

+

+
database
-

+

Specify the type of database to be used for storing the zone data. The string following the database keyword is interpreted as a list of whitespace-delimited words. @@ -8482,53 +9175,60 @@ view "external" { specific to the database type.

-

+

The default is "rbt", BIND 9's native in-memory red-black-tree database. This database does not take arguments.

-

+

Other values are possible if additional database drivers have been linked into the server. Some sample drivers are included with the distribution but none are linked in by default.

-
+
dialup
-

+

+

See the description of dialup in the section called “Boolean Options”. -

+

+
delegation-only
-

+

The flag only applies to forward, hint and stub zones. If set to yes, then the zone will also be treated as if it is also a delegation-only type zone.

-

+

See caveats in root-delegation-only.

-
+
forward
-

+

+

Only meaningful if the zone has a forwarders list. The only value causes the lookup to fail after trying the forwarders and getting no answer, while first would allow a normal lookup to be tried. -

+

+
forwarders
-

+

+

Used to override the list of global forwarders. If it is not specified in a zone of type forward, no forwarding is done for the zone and the global options are not used. -

+

+
ixfr-base
-

+

+

Was used in BIND 8 to specify the name of the transaction log (journal) file for dynamic update @@ -8538,83 +9238,110 @@ view "external" { file by appending ".jnl" to the name of the zone file. -

+

+
ixfr-tmp-file
-

+

+

Was an undocumented option in BIND 8. Ignored in BIND 9. -

+

+
journal
-

+

+

Allow the default journal's filename to be overridden. The default is the zone's filename with ".jnl" appended. This is applicable to master and slave zones. -

+

+
max-journal-size
-

+

+

See the description of max-journal-size in the section called “Server Resource Limits”. -

+

+
max-records
-

+

+

See the description of max-records in the section called “Server Resource Limits”. -

+

+
max-transfer-time-in
-

+

+

See the description of max-transfer-time-in in the section called “Zone Transfers”. -

+

+
max-transfer-idle-in
-

+

+

See the description of max-transfer-idle-in in the section called “Zone Transfers”. -

+

+
max-transfer-time-out
-

+

+

See the description of max-transfer-time-out in the section called “Zone Transfers”. -

+

+
max-transfer-idle-out
-

+

+

See the description of max-transfer-idle-out in the section called “Zone Transfers”. -

+

+
notify
-

+

+

See the description of notify in the section called “Boolean Options”. -

+

+
notify-delay
-

+

+

See the description of notify-delay in the section called “Tuning”. -

+

+
notify-to-soa
-

+

+

See the description of notify-to-soa in the section called “Boolean Options”. -

+

+
pubkey
-

+

+

In BIND 8, this option was intended for specifying a public zone key for verification of signatures in DNSSEC signed zones when they are loaded from disk. BIND 9 does not verify signatures on load and ignores the option. -

+

+
zone-statistics
-

+

+

See the description of zone-statistics in the section called “options Statement Definition and Usage”. -

+

+
server-addresses
-

+

Only meaningful for static-stub zones. This is a list of IP addresses to which queries should be sent in recursive resolution for the @@ -8623,7 +9350,7 @@ view "external" { configure the apex NS RR with associated glue A or AAAA RRs.

-

+

For example, if "example.com" is configured as a static-stub zone with 192.0.2.1 and 2001:db8::1234 in a server-addresses option, @@ -8632,7 +9359,7 @@ view "external" { 

example.com. NS example.com.
 example.com. A 192.0.2.1
 example.com. AAAA 2001:db8::1234
-

+

These records are internally used to resolve names under the static-stub zone. For instance, if the server receives a query for @@ -8640,10 +9367,10 @@ example.com. AAAA 2001:db8::1234 will initiate recursive resolution and send queries to 192.0.2.1 and/or 2001:db8::1234.

-
+
server-names
-

+

Only meaningful for static-stub zones. This is a list of domain names of nameservers that act as authoritative servers of the static-stub @@ -8661,7 +9388,7 @@ example.com. AAAA 2001:db8::1234 "ns.example.net" cannot, and will be rejected by the configuration parser.

-

+

A non empty list for this option will internally configure the apex NS RR with the specified names. For example, if "example.com" is configured as a @@ -8673,7 +9400,7 @@ example.com. AAAA 2001:db8::1234 

example.com. NS ns1.example.net.
 example.com. NS ns2.example.net.
-

+

These records are internally used to resolve names under the static-stub zone. For instance, if the server receives a query for @@ -8683,145 +9410,189 @@ example.com. NS ns2.example.net. "ns2.example.net" to IP addresses, and then send queries to (one or more of) these addresses.

-
+
sig-validity-interval
-

+

+

See the description of sig-validity-interval in the section called “Tuning”. -

+

+
sig-signing-nodes
-

+

+

See the description of sig-signing-nodes in the section called “Tuning”. -

+

+
sig-signing-signatures
-

+

+

See the description of sig-signing-signatures in the section called “Tuning”. -

+

+
sig-signing-type
-

+

+

See the description of sig-signing-type in the section called “Tuning”. -

+

+
transfer-source
-

+

+

See the description of transfer-source in the section called “Zone Transfers”. -

+

+
transfer-source-v6
-

+

+

See the description of transfer-source-v6 in the section called “Zone Transfers”. -

+

+
alt-transfer-source
-

+

+

See the description of alt-transfer-source in the section called “Zone Transfers”. -

+

+
alt-transfer-source-v6
-

+

+

See the description of alt-transfer-source-v6 in the section called “Zone Transfers”. -

+

+
use-alt-transfer-source
-

+

+

See the description of use-alt-transfer-source in the section called “Zone Transfers”. -

+

+
notify-source
-

+

+

See the description of notify-source in the section called “Zone Transfers”. -

+

+
notify-source-v6
-

+

+

See the description of notify-source-v6 in the section called “Zone Transfers”. -

+

+
min-refresh-time, max-refresh-time, min-retry-time, max-retry-time
-

+

+

See the description in the section called “Tuning”. -

+

+
ixfr-from-differences
-

+

+

See the description of ixfr-from-differences in the section called “Boolean Options”. (Note that the ixfr-from-differences master and slave choices are not available at the zone level.) -

+

+
key-directory
-

+

+

See the description of key-directory in the section called “options Statement Definition and Usage”. -

+

+
auto-dnssec
-

+

+

See the description of auto-dnssec in the section called “options Statement Definition and Usage”. -

+

+
serial-update-method
-

+

+

See the description of serial-update-method in the section called “options Statement Definition and Usage”. -

+

+
inline-signing
-

+

+

If yes, this enables "bump in the wire" signing of a zone, where a unsigned zone is transferred in or loaded from disk and a signed version of the zone is served, with possibly, a different serial number. This behaviour is disabled by default. -

+

+
multi-master
-

+

+

See the description of multi-master in the section called “Boolean Options”. -

+

+
masterfile-format
-

+

+

See the description of masterfile-format in the section called “Tuning”. -

+

+
max-zone-ttl
-

+

+

See the description of max-zone-ttl in the section called “options Statement Definition and Usage”. -

+

+
dnssec-secure-to-insecure
-

+

+

See the description of dnssec-secure-to-insecure in the section called “Boolean Options”. -

+

+
-
-
+ +
+

Dynamic Update Policies

-

BIND 9 supports two alternative + +

BIND 9 supports two alternative methods of granting clients the right to perform dynamic updates to a zone, configured by the allow-update and update-policy option, respectively.

-

+

The allow-update clause works the same way as in previous versions of BIND. It grants given clients the permission to update any record of any name in the zone.

-

+

The update-policy clause allows more fine-grained control over what updates are allowed. A set of rules is specified, where each rule @@ -8831,7 +9602,7 @@ example.com. NS ns2.example.net. it includes either a TSIG or SIG(0) record), the identity of the signer can be determined.

-

+

Rules are specified in the update-policy zone option, and are only meaningful for master zones. When the update-policy statement @@ -8841,7 +9612,7 @@ example.com. NS ns2.example.net. only examines the signer of a message; the source address is not relevant.

-

+

There is a pre-defined update-policy rule which can be switched on with the command update-policy local;. @@ -8856,26 +9627,31 @@ example.com. NS ns2.example.net. session-keyname and session-keyalg options, respectively).

-

+

A client running on the local system, and with appropriate permissions, may read that file and use the key to sign update requests. The zone's update policy will be set to allow that key to change any record within the zone. Assuming the key name is "local-ddns", this policy is equivalent to:

-
update-policy { grant local-ddns zonesub any; };
+
+            
update-policy { grant local-ddns zonesub any; };
             

-

+
+            

               The command nsupdate -l sends update
               requests to localhost, and signs them using the session key.
             

-

+
+            

               Other rule definitions look like this:
             

+
 
 ( grant | deny ) identity nametype [ name ] [ types ]
 

-

+
+            

               Each rule grants or denies privileges.  Once a message has
               successfully matched a rule, the operation is immediately
               granted or denied and no further rules are examined.  A rule
@@ -8884,13 +9660,13 @@ example.com. NS ns2.example.net.
               field, and the type matches the types specified in the type
               field.
             

-

+            

               No signer is required for tcp-self
               or 6to4-self however the standard
               reverse mapping / prefix conversion must match the identity
               field.
             

-

+            

               The identity field specifies a name or a wildcard
               name.  Normally, this is the name of the TSIG or
               SIG(0) key used to sign the update request.  When a
@@ -8907,14 +9683,14 @@ example.com. NS ns2.example.net.
               The identity field must
               contain a fully-qualified domain name.
             

-

+            

               For nametypes krb5-self,
               ms-self, krb5-subdomain,
               and ms-subdomain the
               identity field specifies
               the Windows or Kerberos realm of the machine belongs to.
             

-

+            

               The nametype field has 13
               values:
               name, subdomain,
@@ -8926,7 +9702,8 @@ example.com. NS ns2.example.net.
               tcp-self, 6to4-self,
               zonesub, and external.
             

-

+            

+              
@@ -9206,12 +9983,15 @@ example.com. NS ns2.example.net.
                     
-

 
 
 

 
 

-

+
+
+ +

In all cases, the name field must specify a fully-qualified domain name.

-

+ +

If no types are explicitly specified, this rule matches all types except RRSIG, NS, SOA, NSEC and NSEC3. Types may be specified by name, including "ANY" (ANY matches @@ -9220,11 +10000,13 @@ example.com. NS ns2.example.net. all records associated with a name, the rules are checked for each existing record type.

-
-
+
+ +

Multiple views

-

+ +

When multiple views are in use, a zone may be referenced by more than one of them. Often, the views will contain different zones with the same name, allowing @@ -9235,7 +10017,7 @@ example.com. NS ns2.example.net. way to do this: it allows a view to reference a zone that was defined in a previously configured view. Example:

-
+            
 view internal {
     match-clients { 10/8; };
 
@@ -9253,11 +10035,11 @@ view external {
     };
 };
             

-

+            

               An in-view option cannot refer to a view
               that is configured later in the configuration file.
             

-

+            

               A zone statement which uses the
               in-view option may not use any other
               options with the exception of forward
@@ -9265,41 +10047,45 @@ view external {
               the behavior of the containing view, rather than changing
               the zone object itself.)
             

-

+            

               Zone level acls (e.g. allow-query, allow-transfer) and
               other configuration details of the zone are all set
               in the view the referenced zone is defined in.  Care
               need to be taken to ensure that acls are wide enough
               for all views referencing the zone.
             

-

+            

               An in-view zone cannot be used as a
               response policy zone.
             

-

+            

               An in-view zone is not intended to reference
               a forward zone.
             

-
-
-
-
+
+ +
+
+

Zone File

-
+ +

Types of Resource Records and When to Use Them

-

+ +

This section, largely borrowed from RFC 1034, describes the concept of a Resource Record (RR) and explains when each is used. Since the publication of RFC 1034, several new RRs have been identified and implemented in the DNS. These are also included.

-
+

Resource Records

-

+ +

A domain name identifies a node. Each node has a set of resource information, which may be empty. The set of resource information associated with a particular name is composed of @@ -9309,10 +10095,12 @@ view external { permitted for optimization purposes, for example, to specify that a particular nearby server be tried first. See the section called “The sortlist Statement” and the section called “RRset Ordering”.

-

+ +

The components of a Resource Record are:

-
+
+
@@ -9387,11 +10175,13 @@ view external { -
-

+ +

+

The following are types of valid RRs:

-
+
+
@@ -10396,12 +11186,14 @@ view external { -
-

+ +

+

The following classes of resource records are currently valid in the DNS:

-
+
+
@@ -10454,8 +11246,10 @@ view external { -
-

+ +

+ +

The owner name is often implicit, rather than forming an integral part of the RR. For example, many name servers internally form @@ -10466,7 +11260,7 @@ view external { that fits the needs of the resource being described.

-

+

The meaning of the TTL field is a time limit on how long an RR can be kept in a cache. This limit does not apply to authoritative @@ -10486,17 +11280,18 @@ view external { following the change.

-

+

The data in the RDATA section of RRs is carried as a combination of binary strings and domain names. The domain names are frequently used as "pointers" to other data in the DNS.

-
-
+
+

Textual expression of RRs

-

+ +

RRs are represented in binary form in the packets of the DNS protocol, and are usually represented in highly encoded form when @@ -10509,13 +11304,13 @@ view external { possible using parentheses.

-

+

The start of the line gives the owner of the RR. If a line begins with a blank, then the owner is assumed to be the same as that of the previous RR. Blank lines are often included for readability.

-

+

Following the owner, we list the TTL, type, and class of the RR. Class and type use the mnemonics defined above, and TTL is an integer before the type field. In order to avoid ambiguity @@ -10526,14 +11321,15 @@ view external { values are often omitted from examples in the interests of clarity.

-

+

The resource data or RDATA section of the RR are given using knowledge of the typical representation for the data.

-

+

For example, we might show the RRs carried in a message as:

-
+
+
@@ -10637,21 +11433,23 @@ view external { -
-

+ +

+

The MX RRs have an RDATA section which consists of a 16-bit number followed by a domain name. The address RRs use a standard IP address format to contain a 32-bit internet address.

-

+

The above example shows six RRs, with two RRs at each of three domain names.

-

+

Similarly we might see:

-
+
+
@@ -10689,17 +11487,20 @@ view external { -
-

+ +

+

This example shows two addresses for XX.LCS.MIT.EDU, each of a different class.

-
-
-
+
+
+ +

Discussion of MX Records

-

+ +

As described above, domain servers store information as a series of resource records, each of which contains a particular piece of information about a given domain name (which is usually, @@ -10708,7 +11509,8 @@ view external { and stored with some additional type information to help systems determine when the RR is relevant.

-

+ +

MX records are used to control delivery of email. The data specified in the record is a priority and a domain name. The priority @@ -10725,7 +11527,7 @@ view external { It must have an associated address record (A or AAAA) — CNAME is not sufficient.

-

+

For a given domain, if there is both a CNAME record and an MX record, the MX record is in error, and will be ignored. Instead, @@ -10734,7 +11536,8 @@ view external { pointed to by the CNAME. For example:

-
+
+
@@ -10871,18 +11674,20 @@ view external { -
+ +

Mail delivery will be attempted to mail.example.com and mail2.example.com (in any order), and if neither of those succeed, delivery to mail.backup.org will be attempted.

-
-
+
+

Setting TTLs

-

+ +

The time-to-live of the RR field is a 32-bit integer represented in units of seconds, and is primarily used by resolvers when they cache RRs. The TTL describes how long a RR can be cached before it @@ -10890,7 +11695,8 @@ view external { currently used in a zone file.

-
+
+
@@ -10945,16 +11751,18 @@ view external { -
-

+ +

+

All of these TTLs default to units of seconds, though units can be explicitly specified, for example, 1h30m.

-
-
+
+

Inverse Mapping in IPv4

-

+ +

Reverse name resolution (that is, translation from IP address to name) is achieved by means of the in-addr.arpa domain and PTR records. Entries in the in-addr.arpa domain are made in @@ -10969,7 +11777,8 @@ view external { PTR records if the machine has more than one name. For example, in the [example.com] domain:

-
+
+
@@ -11000,22 +11809,24 @@ view external { -
-
+ +
+

Note

-

+

The $ORIGIN lines in the examples are for providing context to the examples only — they do not necessarily appear in the actual usage. They are only used here to indicate that the example is relative to the listed origin.

-
-
-
+
+
+

Other Zone File Directives

-

+ +

The Master File Format was initially defined in RFC 1035 and has subsequently been extended. While the Master File Format itself @@ -11023,30 +11834,32 @@ view external { same class.

-

+

Master File Directives include $ORIGIN, $INCLUDE, and $TTL.

-
+

The @ (at-sign)

-

+ +

When used in the label (or name) field, the asperand or at-sign (@) symbol represents the current origin. At the start of the zone file, it is the <zone_name> (followed by trailing dot).

-
-
+
+

The $ORIGIN Directive

-

+ +

Syntax: $ORIGIN domain-name [comment]

-

$ORIGIN +

$ORIGIN sets the domain name that will be appended to any unqualified records. When a zone is first read in there is an implicit $ORIGIN @@ -11056,42 +11869,47 @@ view external { the domain specified in the $ORIGIN argument if it is not absolute.

+ 
 $ORIGIN example.com.
 WWW     CNAME   MAIN-SERVER
-

+ +

is equivalent to

+ 
 WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM.
-
-
+ +
+

The $INCLUDE Directive

-

+ +

Syntax: $INCLUDE filename [ origin ] [ comment ]

-

+

Read and process the file filename as if it were included into the file at this point. If origin is specified the file is processed with $ORIGIN set to that value, otherwise the current $ORIGIN is used.

-

+

The origin and the current domain name revert to the values they had prior to the $INCLUDE once the file has been read.

-
+

Note

-

+

RFC 1035 specifies that the current origin should be restored after an $INCLUDE, but it is silent @@ -11101,31 +11919,33 @@ WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM. This could be construed as a deviation from RFC 1035, a feature, or both.

-
-
-
+
+
+

The $TTL Directive

-

+ +

Syntax: $TTL default-ttl [ comment ]

-

+

Set the default Time To Live (TTL) for subsequent records with undefined TTLs. Valid TTLs are of the range 0-2147483647 seconds.

-

$TTL +

$TTL is defined in RFC 2308.

-
-
-
+
+
+

BIND Master File Extension: the $GENERATE Directive

-

+ +

Syntax: $GENERATE range lhs @@ -11135,7 +11955,7 @@ WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM. rhs [comment]

-

$GENERATE +

$GENERATE is used to create a series of resource records that only differ from each other by an iterator. $GENERATE can be used to @@ -11143,12 +11963,15 @@ WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM. sub /24 reverse delegations described in RFC 2317: Classless IN-ADDR.ARPA delegation.

+ 
$ORIGIN 0.0.192.IN-ADDR.ARPA.
 $GENERATE 1-2 @ NS SERVER$.EXAMPLE.
 $GENERATE 1-127 $ CNAME $.0
-

+ +

is equivalent to

+ 
0.0.0.192.IN-ADDR.ARPA. NS SERVER1.EXAMPLE.
 0.0.0.192.IN-ADDR.ARPA. NS SERVER2.EXAMPLE.
 1.0.0.192.IN-ADDR.ARPA. CNAME 1.0.0.0.192.IN-ADDR.ARPA.
@@ -11156,18 +11979,22 @@ $GENERATE 1-127 $ CNAME $.0
... 127.0.0.192.IN-ADDR.ARPA. CNAME 127.0.0.0.192.IN-ADDR.ARPA. -

+ +

Generate a set of A and MX records. Note the MX's right hand side is a quoted string. The quotes will be stripped when the right hand side is processed.

+ 
 $ORIGIN EXAMPLE.
 $GENERATE 1-127 HOST-$ A 1.2.3.$
 $GENERATE 1-127 HOST-$ MX "0 ."
-

+ +

is equivalent to

+ 
HOST-1.EXAMPLE.   A  1.2.3.1
 HOST-1.EXAMPLE.   MX 0 .
 HOST-2.EXAMPLE.   A  1.2.3.2
@@ -11178,7 +12005,9 @@ HOST-3.EXAMPLE.   MX 0 .
 HOST-127.EXAMPLE. A  1.2.3.127
 HOST-127.EXAMPLE. MX 0 .
-
+ +
+
@@ -11306,30 +12135,33 @@ HOST-127.EXAMPLE. MX 0 . -
-

+ +

+

The $GENERATE directive is a BIND extension and not part of the standard zone file format.

-

+

BIND 8 does not support the optional TTL and CLASS fields.

-
-
+
+ +

Additional File Formats

-

+ +

In addition to the standard textual format, BIND 9 supports the ability to read or dump to zone files in other formats.

-

+

The raw format is a binary representation of zone data in a manner similar to that used in zone transfers. Since it does not require parsing text, load time is significantly reduced.

-

+

An even faster alternative is the map format, which is an image of a BIND 9 in-memory zone database; it is capable of being loaded @@ -11337,7 +12169,7 @@ HOST-127.EXAMPLE. MX 0 . function; the zone can begin serving queries almost immediately.

-

+

For a primary server, a zone file in raw or map format is expected to be generated from a textual zone @@ -11348,7 +12180,7 @@ HOST-127.EXAMPLE. MX 0 . named dumps the zone contents after zone transfer or when applying prior updates.

-

+

If a zone file in a binary format needs manual modification, it first must be converted to a textual form by the named-compilezone command. All @@ -11356,7 +12188,7 @@ HOST-127.EXAMPLE. MX 0 . should then be converted to the binary form by the named-compilezone command again.

-

+

Note that map format is extremely architecture-specific. A map file cannot be used on a system @@ -11373,12 +12205,14 @@ HOST-127.EXAMPLE. MX 0 . portable backup of such a file, conversion to text format is recommended.

-
-
-
+
+
+ +

BIND9 Statistics

-

+ +

BIND 9 maintains lots of statistics information and provides several interfaces for users to get access to the statistics. @@ -11387,11 +12221,14 @@ HOST-127.EXAMPLE. MX 0 . are meaningful in BIND 9, and other information that is considered useful.

-

+ +

The statistics information is categorized into the following sections.

-
+ +
+
@@ -11490,8 +12327,10 @@ HOST-127.EXAMPLE. MX 0 . -
-

+ +

+ +

A subset of Name Server Statistics is collected and shown per zone for which the server has the authority when zone-statistics is set to @@ -11501,11 +12340,13 @@ HOST-127.EXAMPLE. MX 0 . Usage” for further details.

-

+ +

These statistics counters are shown with their zone and view names. The view name is omitted when the server is not configured with explicit views.

-

+ +

There are currently two user interfaces to get access to the statistics. One is in the plain text format dumped to the file specified @@ -11515,16 +12356,18 @@ HOST-127.EXAMPLE. MX 0 . is specified in the configuration file (see the section called “statistics-channels Statement Grammar”.)

-
+ +

The Statistics File

-

+ +

The text format statistics dump begins with a line, like:

-

+

+++ Statistics Dump +++ (973798949)

-

+

The number in parentheses is a standard Unix-style timestamp, measured as seconds since January 1, 1970. @@ -11533,28 +12376,33 @@ HOST-127.EXAMPLE. MX 0 . as described above. Each section begins with a line, like:

-

+ +

++ Name Server Statistics ++

-

+ +

Each section consists of lines, each containing the statistics counter value followed by its textual description. See below for available counters. For brevity, counters that have a value of 0 are not shown in the statistics file.

-

+ +

The statistics dump ends with the line where the number is identical to the number in the beginning line; for example:

-

+

--- Statistics Dump --- (973798949)

-
-
+
+ +

Statistics Counters

-

+ +

The following tables summarize statistics counters that BIND 9 provides. For each row of the tables, the leftmost column is the @@ -11570,10 +12418,13 @@ HOST-127.EXAMPLE. MX 0 . it gives the corresponding counter name of the BIND 8 statistics, if applicable.

-
+ +

Name Server Statistics Counters

-
+ +
+
@@ -12164,12 +13015,16 @@ HOST-127.EXAMPLE. MX 0 . -
-
-
+ +
+
+ +

Zone Maintenance Statistics Counters

-
+ +
+
@@ -12318,12 +13173,16 @@ HOST-127.EXAMPLE. MX 0 . -
-
-
+ +
+
+ +

Resolver Statistics Counters

-
+ +
+
@@ -12701,12 +13560,16 @@ HOST-127.EXAMPLE. MX 0 . -
-
-
+ +
+ +
+ +

Socket I/O Statistics Counters

-

+ +

Socket I/O statistics counters are defined per socket types, which are UDP4 (UDP/IPv4), @@ -12721,7 +13584,9 @@ HOST-127.EXAMPLE. MX 0 . Not all counters are available for all socket types; exceptions are noted in the description field.

-
+ +
+
@@ -12856,45 +13721,58 @@ HOST-127.EXAMPLE. MX 0 . -
-
-
+ +
+
+ +

Compatibility with BIND 8 Counters

-

+ +

Most statistics counters that were available in BIND 8 are also supported in BIND 9 as shown in the above tables. Here are notes about other counters that do not appear in these tables.

-
+ +
RFwdR,SFwdR
-

+

+

These counters are not supported because BIND 9 does not adopt the notion of forwarding as BIND 8 did. -

+

+
RAXFR
-

+

+

This counter is accessible in the Incoming Queries section. -

+

+
RIQ
-

+

+

This counter is accessible in the Incoming Requests section. -

+

+
ROpts
-

+

+

This counter is not supported because BIND 9 does not care about IP options in the first place. -

+

+
-
-
-
-
+
+
+
+ +
diff --git a/doc/arm/Bv9ARM.ch07.html b/doc/arm/Bv9ARM.ch07.html index f0daa93c3a..a91c83c44b 100644 --- a/doc/arm/Bv9ARM.ch07.html +++ b/doc/arm/Bv9ARM.ch07.html @@ -54,10 +54,12 @@
Dynamic Update Security
-
+ +

Access Control Lists

-

+ +

Access Control Lists (ACLs) are address match lists that you can set up and nickname for future use in allow-notify, allow-query, allow-query-on, @@ -65,20 +67,21 @@ blackhole, allow-transfer, etc.

-

+

Using ACLs allows you to have finer control over who can access your name server, without cluttering up your config files with huge lists of IP addresses.

-

+

It is a good idea to use ACLs, and to control access to your server. Limiting access to your server by outside parties can help prevent spoofing and denial of service (DoS) attacks against your server.

-

+

Here is an example of how to properly apply ACLs:

+ 
 // Set up an ACL named "bogusnets" that will block
 // RFC1918 space and some reserved space, which is
@@ -107,16 +110,18 @@ zone "example.com" {
   allow-query { any; };
 };
-

+ +

This allows recursive queries of the server from the outside unless recursion has been previously disabled.

-
-
+
+

Chroot and Setuid

-

+ +

On UNIX servers, it is possible to run BIND in a chrooted environment (using the chroot() function) by specifying @@ -125,23 +130,25 @@ zone "example.com" { BIND in a "sandbox", which will limit the damage done if a server is compromised.

-

+

Another useful feature in the UNIX version of BIND is the ability to run the daemon as an unprivileged user ( -u user ). We suggest running as an unprivileged user when using the chroot feature.

-

+

Here is an example command line to load BIND in a chroot sandbox, /var/named, and to run named setuid to user 202:

-

+

/usr/local/sbin/named -u 202 -t /var/named

-
+ +

The chroot Environment

-

+ +

In order for a chroot environment to work properly in a particular directory (for example, /var/named), you will need to set @@ -153,7 +160,7 @@ zone "example.com" { options like directory and pid-file to account for this.

-

+

Unlike with earlier versions of BIND, you typically will not need to compile named statically nor install shared libraries under the new root. @@ -164,11 +171,13 @@ zone "example.com" { /dev/log, and /etc/localtime.

-
-
+
+ +

Using the setuid Function

-

+ +

Prior to running the named daemon, use the touch utility (to change file @@ -179,7 +188,7 @@ zone "example.com" { to which you want BIND to write.

-
+

Note

If the named daemon is running as an @@ -187,12 +196,14 @@ zone "example.com" { ports if the server is reloaded.

-
-
-
+
+
+ +

Dynamic Update Security

-

+ +

Access to the dynamic update facility should be strictly limited. In earlier versions of BIND, the only way to do this was @@ -212,7 +223,8 @@ zone "example.com" { forward it to the master with its own source IP address causing the master to approve it without question.

-

+ +

For these reasons, we strongly recommend that updates be cryptographically authenticated by means of transaction signatures (TSIG). That is, the allow-update @@ -221,7 +233,8 @@ zone "example.com" { prefixes. Alternatively, the new update-policy option can be used.

-

+ +

Some sites choose to keep all dynamically-updated DNS data in a subdomain and delegate that subdomain to a separate zone. This way, the top-level zone containing critical data such as the IP @@ -229,8 +242,9 @@ zone "example.com" { of public web and mail servers need not allow dynamic update at all.

-
-
+ +
+
diff --git a/doc/arm/Bv9ARM.ch08.html b/doc/arm/Bv9ARM.ch08.html index 771e41b974..912820e177 100644 --- a/doc/arm/Bv9ARM.ch08.html +++ b/doc/arm/Bv9ARM.ch08.html @@ -51,25 +51,30 @@
Where Can I Get Help?
-
+ +

Common Problems

-
+ +

It's not working; how can I figure out what's wrong?

-

+ +

The best solution to solving installation and configuration issues is to take preventative measures by setting up logging files beforehand. The log files provide a source of hints and information that can be used to figure out what went wrong and how to fix the problem.

-
-
-
+ +
+
+

Incrementing and Changing the Serial Number

-

+ +

Zone serial numbers are just numbers — they aren't date related. A lot of people set them to a number that represents a date, usually of the form YYYYMMDDRR. @@ -81,22 +86,26 @@ lower than the serial number on the master, the slave server will attempt to update its copy of the zone.

-

+ +

Setting the serial number to a lower number on the master server than the slave server means that the slave will not perform updates to its copy of the zone.

-

+ +

The solution to this is to add 2147483647 (2^31-1) to the number, reload the zone and make sure all slaves have updated to the new zone serial number, then reset the number to what you want it to be, and reload the zone again.

-
-
+ +
+

Where Can I Get Help?

-

+ +

The Internet Systems Consortium (ISC) offers a wide range of support and service agreements for BIND and DHCP servers. Four @@ -109,15 +118,16 @@ fix announcements to remote support. It also includes training in BIND and DHCP.

-

+ +

To discuss arrangements for support, contact info@isc.org or visit the ISC web page at http://www.isc.org/services/support/ to read more.

-
-
+ +
diff --git a/doc/arm/Bv9ARM.ch09.html b/doc/arm/Bv9ARM.ch09.html index 73071d2e72..0cedf08cf5 100644 --- a/doc/arm/Bv9ARM.ch09.html +++ b/doc/arm/Bv9ARM.ch09.html @@ -59,106 +59,136 @@ -
+

Release Notes for BIND Version 9.10.4

-
+ +

Introduction

-

+

This document summarizes significant changes since the last production release of BIND on the corresponding major release branch. Please see the CHANGES file for a further list of bug fixes and other changes.

-
-
+
+ +

Download

-

+

The latest versions of BIND 9 software can always be found at http://www.isc.org/downloads/. There you will find additional information about each release, source code, and pre-compiled versions for Microsoft Windows operating systems.

-
-
+
+ +

Security Fixes

-
    -

  • +

      +
    • +

      Added the ability to specify the maximum number of records permitted in a zone (max-records #;). This provides a mechanism to block overly large zone transfers, which is a potential risk with slave zones from other parties, as described in CVE-2016-6170. [RT #42143] -

      • -

    • +

      +
      • +
    • +

      It was possible to trigger a assertion when rendering a message using a specially crafted request. This flaw is disclosed in CVE-2016-2776. [RT #43139] -

      • -

    • +

      +
      • +
    • +

      getrrsetbyname with a non absolute name could trigger an infinite recursion bug in lwresd and named with lwres configured if when combined with a search list entry the resulting name is too long. This flaw is disclosed in CVE-2016-2775. [RT #42694] -

      • -

    • +

      +
      • +
    • +

      Duplicate EDNS COOKIE options in a response could trigger an assertion failure. This flaw is disclosed in CVE-2016-2088. [RT #41809] -

      • -

    • +

      +
      • +
    • +

      The resolver could abort with an assertion failure due to improper DNAME handling when parsing fetch reply messages. This flaw is disclosed in CVE-2016-1286. [RT #41753] -

      • -

    • +

      +
      • +
    • +

      Malformed control messages can trigger assertions in named and rndc. This flaw is disclosed in CVE-2016-1285. [RT #41666] -

      • -

    • +

      +
      • +
    • +

      Certain errors that could be encountered when printing out or logging an OPT record containing a CLIENT-SUBNET option could be mishandled, resulting in an assertion failure. This flaw is disclosed in CVE-2015-8705. [RT #41397] -

      • -

    • +

      +
      • +
    • +

      Specific APL data could trigger an INSIST. This flaw is disclosed in CVE-2015-8704. [RT #41396] -

      • -

    • +

      +
      • +
    • +

      Incorrect reference counting could result in an INSIST failure if a socket error occurred while performing a lookup. This flaw is disclosed in CVE-2015-8461. [RT#40945] -

      • -

    • +

      +
      • +
    • +

      Insufficient testing when parsing a message allowed records with an incorrect class to be be accepted, triggering a REQUIRE failure when those records were subsequently cached. This flaw is disclosed in CVE-2015-8000. [RT #40987] -

      • +

      +
    -
-
+ +
+ +

New Features

-
    -

  • +

      +
    • +

      The following resource record types have been implemented: AVC, CSYNC, NINFO, RKEY, SINK, SMIMEA, TA, TALINK. -

      • -

    • +

      +
      • +
    • +

      Added a warning for a common misconfiguration involving forwarded RFC 1918 and IPv6 ULA (Universal Local Address) zones. -

      • -

    • +

      +
      • +
    • +

      Contributed software from Nominum is included in the source at contrib/dnsperf-2.1.0.0-1/. It includes dnsperf for measuring the performance of authoritative DNS servers, resperf for @@ -167,14 +197,18 @@ gnuplot graphs, and queryparse to extract DNS queries from pcap capture files. This software is not installed by default with BIND. -

      • -

    • +

      +
      • +
    • +

      When loading a signed zone, named will now check whether an RRSIG's inception time is in the future, and if so, it will regenerate the RRSIG immediately. This helps when a system's clock needs to be reset backwards. -

      • -

    • +

      +
      • +
    • +

      named now provides feedback to the owners of zones which have trust anchors configured (trusted-keys, @@ -184,46 +218,62 @@ configured trust anchors for the zone. This is controlled by trust-anchor-telemetry and defaults to yes. -

      • +

      +
    -
-
+
+ +

Feature Changes

-
    -

  • +

      +
    • +

      The ISC DNSSEC Lookaside Validation (DLV) service is scheduled to be disabled in 2017. A warning is now logged when named is configured to use this service, either explicitly or via dnssec-lookaside auto;. [RT #42207] -

      • -

    • +

      +
      • +
    • +

      Updated the compiled-in addresses for H.ROOT-SERVERS.NET and L.ROOT-SERVERS.NET. -

      • -

    • +

      +
      • +
    • +

      The default preferred glue is now the address type of the transport the query was received over. -

      • -

    • +

      +
      • +
    • +

      On machines with 2 or more processors (CPU), the default value for the number of UDP listeners has been changed to the number of detected processors minus one. -

      • -

    • +

      +
      • +
    • +

      Zone transfers now use smaller message sizes to improve message compression. This results in reduced network usage. -

      • -

    • +

      +
      • +
    • +

      named -V output now also includes operating system details. -

      • +

      +
    -
-
+
+ +

Porting Changes

-

  • +

    • +

      The Microsoft Windows install tool BINDInstall.exe which requires a non-free version of Visual Studio to be built, now uses two @@ -232,63 +282,86 @@ previously compiled in the binary. Read win32utils/build.txt for more details. [RT #38915] -

    -
-
+

+
+
+ +

Bug Fixes

-
    -

  • +

      +
    • +

      Fixed a crash when calling rndc stats on some Windows builds: some Visual Studio compilers generate code that crashes when the "%z" printf() format specifier is used. [RT #42380] -

      • -

    • +

      +
      • +
    • +

      Windows installs were failing due to triggering UAC without the installation binary being signed. -

      • -

    • +

      +
      • +
    • +

      A change in the internal binary representation of the RBT database node structure enabled a race condition to occur (especially when BIND was built with certain compilers or optimizer settings), leading to inconsistent database state which caused random assertion failures. [RT #42380] -

      • -

    • +

      +
      • +
    • +

      rndc flushtree now works even if there wasn't a cached node at the specified name. [RT #41846] -

      • -

    • +

      +
      • +
    • +

      Don't emit records with zero TTL unless the records were received with a zero TTL. After being returned to waiting clients, the answer will be discarded from the cache. [RT #41687] -

      • -

    • +

      +
      • +
    • +

      For Windows platforms, the SIT (Source Identity Token) support was restored. (It was mistakenly partially replaced in a previous beta with new 9.11 COOKIE support.) [RT #41905] -

      • -

    • +

      +
      • +
    • +

      When deleting records from a zone database, interior nodes could be left empty but not deleted, damaging search performance afterward. [RT #40997] [RT #41941] -

      • -

    • +

      +
      • +
    • +

      The server could crash due to a use-after-free if a zone transfer timed out. [RT #41297] -

      • -

    • +

      +
      • +
    • +

      Authoritative servers that were marked as bogus (e.g. blackholed in configuration or with invalid addresses) were being queried anyway. [RT #41321] -

      • -

    • +

      +
      • +
    • +

      Some of the options for GeoIP ACLs, including "areacode", "metrocode", and "timezone", were incorrectly documented as "area", "metro" and "tz". Both the long and abbreviated versions are now accepted. -

      • -

    • +

      +
      • +
    • +

      Zones configured to use map format master files can't be used as policy zones because RPZ summary data isn't compiled when such zones are mapped into @@ -296,30 +369,33 @@ but in the meantime it has been documented, and attempting to use such zones in response-policy statements is now a configuration error. [RT #38321] -

      • +

      +
    -
-
+
+ +

End of Life

-

+

The end of life for BIND 9.10 is yet to be determined but will not be before BIND 9.12.0 has been released for 6 months. https://www.isc.org/downloads/software-support-policy/

-
-
+
+ +

Thank You

-

+

Thank you to everyone who assisted us in making this release possible. If you would like to contribute to ISC to assist us in continuing to make quality open source software, please visit our donations page at http://www.isc.org/donate/.

+
-
-
+
diff --git a/doc/arm/Bv9ARM.ch10.html b/doc/arm/Bv9ARM.ch10.html index 648619ad34..9f60cf798e 100644 --- a/doc/arm/Bv9ARM.ch10.html +++ b/doc/arm/Bv9ARM.ch10.html @@ -44,7 +44,7 @@

A Brief History of the DNS and BIND

-

+

Although the "official" beginning of the Domain Name System occurred in 1984 with the publication of RFC 920, the core of the new system was described in 1983 in RFCs 882 and @@ -59,7 +59,8 @@ became the standards upon which all DNS implementations are built.

-

+ +

The first working domain name server, called "Jeeves", was written in 1983-84 by Paul Mockapetris for operation on DEC Tops-20 @@ -77,7 +78,7 @@ Administration (DARPA).

-

+

Versions of BIND through 4.8.3 were maintained by the Computer Systems Research Group (CSRG) at UC Berkeley. Douglas Terry, Mark @@ -92,7 +93,7 @@ Mike Muuss, Jim Bloom and Mike Schwartz. BIND maintenance was subsequently handled by Mike Karels and Øivind Kure.

-

+

BIND versions 4.9 and 4.9.1 were released by Digital Equipment Corporation (now Compaq Computer Corporation). Paul Vixie, then @@ -104,41 +105,41 @@ Baran, Anant Kumar, Art Harkin, Win Treese, Don Lewis, Christophe Wolfhugel, and others.

-

+

In 1994, BIND version 4.9.2 was sponsored by Vixie Enterprises. Paul Vixie became BIND's principal architect/programmer.

-

+

BIND versions from 4.9.3 onward have been developed and maintained by the Internet Systems Consortium and its predecessor, the Internet Software Consortium, with support being provided by ISC's sponsors.

-

+

As co-architects/programmers, Bob Halley and Paul Vixie released the first production-ready version of BIND version 8 in May 1997.

-

+

BIND version 9 was released in September 2000 and is a major rewrite of nearly all aspects of the underlying BIND architecture.

-

+

BIND versions 4 and 8 are officially deprecated. No additional development is done on BIND version 4 or BIND version 8.

-

+

BIND development work is made possible today by the sponsorship of several corporations, and by the tireless work efforts of numerous individuals.

- +
diff --git a/doc/arm/Bv9ARM.ch11.html b/doc/arm/Bv9ARM.ch11.html index 0c6bd0c3be..64f5455cee 100644 --- a/doc/arm/Bv9ARM.ch11.html +++ b/doc/arm/Bv9ARM.ch11.html @@ -54,10 +54,12 @@ -
+ +

IPv6 addresses (AAAA)

-

+ +

IPv6 addresses are 128-bit identifiers for interfaces and sets of interfaces which were introduced in the DNS to facilitate scalable Internet routing. There are three types of addresses: Unicast, @@ -68,13 +70,13 @@ Unicast address scheme. For more information, see RFC 3587, "Global Unicast Address Format."

-

+

IPv6 unicast addresses consist of a global routing prefix, a subnet identifier, and an interface identifier.

-

+

The global routing prefix is provided by the upstream provider or ISP, and (roughly) corresponds to the IPv4 network section @@ -88,14 +90,14 @@ interface on a given network; in IPv6, addresses belong to interfaces rather than to machines.

-

+

The subnetting capability of IPv6 is much more flexible than that of IPv4: subnetting can be carried out on bit boundaries, in much the same way as Classless InterDomain Routing (CIDR), and the DNS PTR representation ("nibble" format) makes setting up reverse zones easier.

-

+

The Interface Identifier must be unique on the local link, and is usually generated automatically by the IPv6 implementation, although it is usually possible to @@ -103,7 +105,7 @@ address might look like: 2001:db8:201:9:a00:20ff:fe81:2b32

-

+

IPv6 address specifications often contain long strings of zeros, so the architects have included a shorthand for specifying @@ -111,14 +113,16 @@ string of zeros that can fit, and can be used only once in an address.

-
-
+
+

Bibliography (and Suggested Reading)

-
+ +

Request for Comments (RFCs)

-

+ +

Specification documents for the Internet protocol suite, including the DNS, are published as part of the Request for Comments (RFCs) @@ -126,336 +130,752 @@ by the Internet Engineering Task Force (IETF) and the Internet Engineering Steering Group (IESG). RFCs can be obtained online via FTP at:

-

+

ftp://www.isi.edu/in-notes/RFCxxxx.txt

-

+

(where xxxx is the number of the RFC). RFCs are also available via the Web at:

-

+

http://www.ietf.org/rfc/.

-
+

Bibliography

-
-
-

[RFC974] C. Partridge. Mail Routing and the Domain System. January 1986.

+
+ + +
+

[RFC974] + + C. Partridge. + Mail Routing and the Domain System. + January 1986. +

-
-

[RFC1034] P.V. Mockapetris. Domain Names — Concepts and Facilities. November 1987.

+
+

[RFC1034] + + P.V. Mockapetris. + Domain Names — Concepts and Facilities. + November 1987. +

-
-

[RFC1035] P. V. Mockapetris. Domain Names — Implementation and - Specification. November 1987.

+
+

[RFC1035] + + P. V. Mockapetris. Domain Names — Implementation and + Specification. + November 1987. +

+
+
+ + +
+

[RFC2181] + + R., R. Bush Elz. + Clarifications to the DNS + Specification. + July 1997. +

-
-
-

[RFC2181] R., R. Bush Elz. Clarifications to the DNS - Specification. July 1997.

+
+

[RFC2308] + + M. Andrews. + Negative Caching of DNS + Queries. + March 1998. +

-
-

[RFC2308] M. Andrews. Negative Caching of DNS - Queries. March 1998.

+
+

[RFC1995] + + M. Ohta. + Incremental Zone Transfer in DNS. + August 1996. +

-
-

[RFC1995] M. Ohta. Incremental Zone Transfer in DNS. August 1996.

+
+

[RFC1996] + + P. Vixie. + A Mechanism for Prompt Notification of Zone Changes. + August 1996. +

-
-

[RFC1996] P. Vixie. A Mechanism for Prompt Notification of Zone Changes. August 1996.

+
+

[RFC2136] + + P. Vixie, S. Thomson, Y. Rekhter, and J. Bound. + Dynamic Updates in the Domain Name System. + April 1997. +

-
-

[RFC2136] P. Vixie, S. Thomson, Y. Rekhter, and J. Bound. Dynamic Updates in the Domain Name System. April 1997.

+
+

[RFC2671] + + P. Vixie. + Extension Mechanisms for DNS (EDNS0). + August 1997. +

-
-

[RFC2671] P. Vixie. Extension Mechanisms for DNS (EDNS0). August 1997.

+
+

[RFC2672] + + M. Crawford. + Non-Terminal DNS Name Redirection. + August 1999. +

-
-

[RFC2672] M. Crawford. Non-Terminal DNS Name Redirection. August 1999.

+
+

[RFC2845] + + P. Vixie, O. Gudmundsson, D. Eastlake, 3rd, and B. Wellington. + Secret Key Transaction Authentication for DNS (TSIG). + May 2000. +

-
-

[RFC2845] P. Vixie, O. Gudmundsson, D. Eastlake, 3rd, and B. Wellington. Secret Key Transaction Authentication for DNS (TSIG). May 2000.

+
+

[RFC2930] + + D. Eastlake, 3rd. + Secret Key Establishment for DNS (TKEY RR). + September 2000. +

-
-

[RFC2930] D. Eastlake, 3rd. Secret Key Establishment for DNS (TKEY RR). September 2000.

+
+

[RFC2931] + + D. Eastlake, 3rd. + DNS Request and Transaction Signatures (SIG(0)s). + September 2000. +

-
-

[RFC2931] D. Eastlake, 3rd. DNS Request and Transaction Signatures (SIG(0)s). September 2000.

+
+

[RFC3007] + + B. Wellington. + Secure Domain Name System (DNS) Dynamic Update. + November 2000. +

-
-

[RFC3007] B. Wellington. Secure Domain Name System (DNS) Dynamic Update. November 2000.

-
-
-

[RFC3645] S. Kwan, P. Garg, J. Gilroy, L. Esibov, J. Westhead, and R. Hall. Generic Security Service Algorithm for Secret +

+

[RFC3645] + + S. Kwan, P. Garg, J. Gilroy, L. Esibov, J. Westhead, and R. Hall. + Generic Security Service Algorithm for Secret Key Transaction Authentication for DNS - (GSS-TSIG). October 2003.

+ (GSS-TSIG). + October 2003. +

+
+
+ +
+

[RFC3225] + + D. Conrad. + Indicating Resolver Support of DNSSEC. + December 2001. +

-
-
-

[RFC3225] D. Conrad. Indicating Resolver Support of DNSSEC. December 2001.

+
+

[RFC3833] + + D. Atkins and R. Austein. + Threat Analysis of the Domain Name System (DNS). + August 2004. +

-
-

[RFC3833] D. Atkins and R. Austein. Threat Analysis of the Domain Name System (DNS). August 2004.

+
+

[RFC4033] + + R. Arends, R. Austein, M. Larson, D. Massey, and S. Rose. + DNS Security Introduction and Requirements. + March 2005. +

-
-

[RFC4033] R. Arends, R. Austein, M. Larson, D. Massey, and S. Rose. DNS Security Introduction and Requirements. March 2005.

+
+

[RFC4034] + + R. Arends, R. Austein, M. Larson, D. Massey, and S. Rose. + Resource Records for the DNS Security Extensions. + March 2005. +

-
-

[RFC4034] R. Arends, R. Austein, M. Larson, D. Massey, and S. Rose. Resource Records for the DNS Security Extensions. March 2005.

+
+

[RFC4035] + + R. Arends, R. Austein, M. Larson, D. Massey, and S. Rose. + Protocol Modifications for the DNS + Security Extensions. + March 2005. +

-
-

[RFC4035] R. Arends, R. Austein, M. Larson, D. Massey, and S. Rose. Protocol Modifications for the DNS - Security Extensions. March 2005.

+
+
+ +
+

[RFC1535] + + E. Gavron. + A Security Problem and Proposed Correction With Widely + Deployed DNS Software.. + October 1993. +

+
+

[RFC1536] + + A. Kumar, J. Postel, C. Neuman, P. Danzig, and S. Miller. + Common DNS Implementation + Errors and Suggested Fixes. + October 1993. +

-
-
-

[RFC1535] E. Gavron. A Security Problem and Proposed Correction With Widely - Deployed DNS Software.. October 1993.

+
+

[RFC1982] + + R. Elz and R. Bush. + Serial Number Arithmetic. + August 1996. +

-
-

[RFC1536] A. Kumar, J. Postel, C. Neuman, P. Danzig, and S. Miller. Common DNS Implementation - Errors and Suggested Fixes. October 1993.

+
+

[RFC4074] + + Y. Morishita and T. Jinmei. + Common Misbehaviour Against DNS + Queries for IPv6 Addresses. + May 2005. +

-
-

[RFC1982] R. Elz and R. Bush. Serial Number Arithmetic. August 1996.

+
+
+ +
+

[RFC1183] + + C.F. Everhart, L. A. Mamakos, R. Ullmann, and P. Mockapetris. + New DNS RR Definitions. + October 1990. +

-
-

[RFC4074] Y. Morishita and T. Jinmei. Common Misbehaviour Against DNS - Queries for IPv6 Addresses. May 2005.

+
+

[RFC1706] + + B. Manning and R. Colella. + DNS NSAP Resource Records. + October 1994. +

+
+

[RFC2168] + + R. Daniel and M. Mealling. + Resolution of Uniform Resource Identifiers using + the Domain Name System. + June 1997. +

-
-
-

[RFC1183] C.F. Everhart, L. A. Mamakos, R. Ullmann, and P. Mockapetris. New DNS RR Definitions. October 1990.

-
-
-

[RFC1706] B. Manning and R. Colella. DNS NSAP Resource Records. October 1994.

-
-
-

[RFC2168] R. Daniel and M. Mealling. Resolution of Uniform Resource Identifiers using - the Domain Name System. June 1997.

-
-
-

[RFC1876] C. Davis, P. Vixie, T., and I. Dickinson. A Means for Expressing Location Information in the +

+

[RFC1876] + + C. Davis, P. Vixie, T., and I. Dickinson. + A Means for Expressing Location Information in the Domain - Name System. January 1996.

+ Name System. + January 1996. +

-
-

[RFC2052] A. Gulbrandsen and P. Vixie. A DNS RR for Specifying the +

+

[RFC2052] + + A. Gulbrandsen and P. Vixie. + A DNS RR for Specifying the Location of - Services.. October 1996.

+ Services.. + October 1996. +

-
-

[RFC2163] A. Allocchio. Using the Internet DNS to +

+

[RFC2163] + + A. Allocchio. + Using the Internet DNS to Distribute MIXER - Conformant Global Address Mapping. January 1998.

+ Conformant Global Address Mapping. + January 1998. +

-
-

[RFC2230] R. Atkinson. Key Exchange Delegation Record for the DNS. October 1997.

+
+

[RFC2230] + + R. Atkinson. + Key Exchange Delegation Record for the DNS. + October 1997. +

-
-

[RFC2536] D. Eastlake, 3rd. DSA KEYs and SIGs in the Domain Name System (DNS). March 1999.

+
+

[RFC2536] + + D. Eastlake, 3rd. + DSA KEYs and SIGs in the Domain Name System (DNS). + March 1999. +

-
-

[RFC2537] D. Eastlake, 3rd. RSA/MD5 KEYs and SIGs in the Domain Name System (DNS). March 1999.

+
+

[RFC2537] + + D. Eastlake, 3rd. + RSA/MD5 KEYs and SIGs in the Domain Name System (DNS). + March 1999. +

-
-

[RFC2538] D. Eastlake, 3rd and O. Gudmundsson. Storing Certificates in the Domain Name System (DNS). March 1999.

+
+

[RFC2538] + + D. Eastlake, 3rd and O. Gudmundsson. + Storing Certificates in the Domain Name System (DNS). + March 1999. +

-
-

[RFC2539] D. Eastlake, 3rd. Storage of Diffie-Hellman Keys in the Domain Name System (DNS). March 1999.

+
+

[RFC2539] + + D. Eastlake, 3rd. + Storage of Diffie-Hellman Keys in the Domain Name System (DNS). + March 1999. +

-
-

[RFC2540] D. Eastlake, 3rd. Detached Domain Name System (DNS) Information. March 1999.

+
+

[RFC2540] + + D. Eastlake, 3rd. + Detached Domain Name System (DNS) Information. + March 1999. +

-
-

[RFC2782] A. Gulbrandsen. P. Vixie. L. Esibov. A DNS RR for specifying the location of services (DNS SRV). February 2000.

+
+

[RFC2782] + + A. Gulbrandsen. + P. Vixie. + L. Esibov. + A DNS RR for specifying the location of services (DNS SRV). + February 2000. +

-
-

[RFC2915] M. Mealling. R. Daniel. The Naming Authority Pointer (NAPTR) DNS Resource Record. September 2000.

+
+

[RFC2915] + + M. Mealling. + R. Daniel. + The Naming Authority Pointer (NAPTR) DNS Resource Record. + September 2000. +

-
-

[RFC3110] D. Eastlake, 3rd. RSA/SHA-1 SIGs and RSA KEYs in the Domain Name System (DNS). May 2001.

+
+

[RFC3110] + + D. Eastlake, 3rd. + RSA/SHA-1 SIGs and RSA KEYs in the Domain Name System (DNS). + May 2001. +

-
-

[RFC3123] P. Koch. A DNS RR Type for Lists of Address Prefixes (APL RR). June 2001.

+
+

[RFC3123] + + P. Koch. + A DNS RR Type for Lists of Address Prefixes (APL RR). + June 2001. +

-
-

[RFC3596] S. Thomson, C. Huitema, V. Ksinant, and M. Souissi. DNS Extensions to support IP - version 6. October 2003.

+
+

[RFC3596] + + S. Thomson, C. Huitema, V. Ksinant, and M. Souissi. + DNS Extensions to support IP + version 6. + October 2003. +

-
-

[RFC3597] A. Gustafsson. Handling of Unknown DNS Resource Record (RR) Types. September 2003.

+
+

[RFC3597] + + A. Gustafsson. + Handling of Unknown DNS Resource Record (RR) Types. + September 2003. +

+
+
+ +
+

[RFC1101] + + P. V. Mockapetris. + DNS Encoding of Network Names + and Other Types. + April 1989. +

-
-
-

[RFC1101] P. V. Mockapetris. DNS Encoding of Network Names - and Other Types. April 1989.

+
+

[RFC1123] + + Braden. + Requirements for Internet Hosts - Application and + Support. + October 1989. +

-
-

[RFC1123] Braden. Requirements for Internet Hosts - Application and - Support. October 1989.

+
+

[RFC1591] + + J. Postel. + Domain Name System Structure and Delegation. + March 1994. +

-
-

[RFC1591] J. Postel. Domain Name System Structure and Delegation. March 1994.

+
+

[RFC2317] + + H. Eidnes, G. de Groot, and P. Vixie. + Classless IN-ADDR.ARPA Delegation. + March 1998. +

-
-

[RFC2317] H. Eidnes, G. de Groot, and P. Vixie. Classless IN-ADDR.ARPA Delegation. March 1998.

+
+

[RFC2826] + + Internet Architecture Board. + IAB Technical Comment on the Unique DNS Root. + May 2000. +

-
-

[RFC2826] Internet Architecture Board. IAB Technical Comment on the Unique DNS Root. May 2000.

+
+

[RFC2929] + + D. Eastlake, 3rd, E. Brunner-Williams, and B. Manning. + Domain Name System (DNS) IANA Considerations. + September 2000. +

-
-

[RFC2929] D. Eastlake, 3rd, E. Brunner-Williams, and B. Manning. Domain Name System (DNS) IANA Considerations. September 2000.

+
+
+ +
+

[RFC1033] + + M. Lottor. + Domain administrators operations guide.. + November 1987. +

+
+

[RFC1537] + + P. Beertema. + Common DNS Data File + Configuration Errors. + October 1993. +

-
-
-

[RFC1033] M. Lottor. Domain administrators operations guide.. November 1987.

+
+

[RFC1912] + + D. Barr. + Common DNS Operational and + Configuration Errors. + February 1996. +

-
-

[RFC1537] P. Beertema. Common DNS Data File - Configuration Errors. October 1993.

+
+

[RFC2010] + + B. Manning and P. Vixie. + Operational Criteria for Root Name Servers.. + October 1996. +

-
-

[RFC1912] D. Barr. Common DNS Operational and - Configuration Errors. February 1996.

+
+

[RFC2219] + + M. Hamilton and R. Wright. + Use of DNS Aliases for + Network Services.. + October 1997. +

-
-

[RFC2010] B. Manning and P. Vixie. Operational Criteria for Root Name Servers.. October 1996.

+
+
+ +
+

[RFC2825] + + IAB and R. Daigle. + A Tangled Web: Issues of I18N, Domain Names, + and the Other Internet protocols. + May 2000. +

-
-

[RFC2219] M. Hamilton and R. Wright. Use of DNS Aliases for - Network Services.. October 1997.

+
+

[RFC3490] + + P. Faltstrom, P. Hoffman, and A. Costello. + Internationalizing Domain Names in Applications (IDNA). + March 2003. +

+
+

[RFC3491] + + P. Hoffman and M. Blanchet. + Nameprep: A Stringprep Profile for Internationalized Domain Names. + March 2003. +

-
-
-

[RFC2825] IAB and R. Daigle. A Tangled Web: Issues of I18N, Domain Names, - and the Other Internet protocols. May 2000.

-
-
-

[RFC3490] P. Faltstrom, P. Hoffman, and A. Costello. Internationalizing Domain Names in Applications (IDNA). March 2003.

-
-
-

[RFC3491] P. Hoffman and M. Blanchet. Nameprep: A Stringprep Profile for Internationalized Domain Names. March 2003.

-
-
-

[RFC3492] A. Costello. Punycode: A Bootstring encoding of Unicode +

+

[RFC3492] + + A. Costello. + Punycode: A Bootstring encoding of Unicode for Internationalized Domain Names in - Applications (IDNA). March 2003.

+ Applications (IDNA). + March 2003. +

-
-
-
+
+
+ +

Note

-

+

Note: the following list of RFCs, although DNS-related, are not concerned with implementing software.

+
+
+

[RFC1464] + + R. Rosenbaum. + Using the Domain Name System To Store Arbitrary String + Attributes. + May 1993. +

-
-

[RFC1464] R. Rosenbaum. Using the Domain Name System To Store Arbitrary String - Attributes. May 1993.

+
+

[RFC1713] + + A. Romao. + Tools for DNS Debugging. + November 1994. +

-
-

[RFC1713] A. Romao. Tools for DNS Debugging. November 1994.

+
+

[RFC1794] + + T. Brisco. + DNS Support for Load + Balancing. + April 1995. +

-
-

[RFC1794] T. Brisco. DNS Support for Load - Balancing. April 1995.

+
+

[RFC2240] + + O. Vaughan. + A Legal Basis for Domain Name Allocation. + November 1997. +

-
-

[RFC2240] O. Vaughan. A Legal Basis for Domain Name Allocation. November 1997.

+
+

[RFC2345] + + J. Klensin, T. Wolf, and G. Oglesby. + Domain Names and Company Name Retrieval. + May 1998. +

-
-

[RFC2345] J. Klensin, T. Wolf, and G. Oglesby. Domain Names and Company Name Retrieval. May 1998.

+
+

[RFC2352] + + O. Vaughan. + A Convention For Using Legal Names as Domain Names. + May 1998. +

-
-

[RFC2352] O. Vaughan. A Convention For Using Legal Names as Domain Names. May 1998.

+
+

[RFC3071] + + J. Klensin. + Reflections on the DNS, RFC 1591, and Categories of Domains. + February 2001. +

-
-

[RFC3071] J. Klensin. Reflections on the DNS, RFC 1591, and Categories of Domains. February 2001.

+
+

[RFC3258] + + T. Hardie. + Distributing Authoritative Name Servers via + Shared Unicast Addresses. + April 2002. +

-
-

[RFC3258] T. Hardie. Distributing Authoritative Name Servers via - Shared Unicast Addresses. April 2002.

+
+

[RFC3901] + + A. Durand and J. Ihren. + DNS IPv6 Transport Operational Guidelines. + September 2004. +

-
-

[RFC3901] A. Durand and J. Ihren. DNS IPv6 Transport Operational Guidelines. September 2004.

+
+
+ +
+

[RFC1712] + + C. Farrell, M. Schulze, S. Pleitner, and D. Baldoni. + DNS Encoding of Geographical + Location. + November 1994. +

+
+

[RFC2673] + + M. Crawford. + Binary Labels in the Domain Name System. + August 1999. +

-
-
-

[RFC1712] C. Farrell, M. Schulze, S. Pleitner, and D. Baldoni. DNS Encoding of Geographical - Location. November 1994.

+
+

[RFC2874] + + M. Crawford and C. Huitema. + DNS Extensions to Support IPv6 Address Aggregation + and Renumbering. + July 2000. +

-
-

[RFC2673] M. Crawford. Binary Labels in the Domain Name System. August 1999.

-
-
-

[RFC2874] M. Crawford and C. Huitema. DNS Extensions to Support IPv6 Address Aggregation - and Renumbering. July 2000.

-
-
-
-
+
+
+ +

Note

-

+

Most of these have been consolidated into RFC4033, RFC4034 and RFC4035 which collectively describe DNSSECbis.

+
+
+

[RFC2065] + + D. Eastlake, 3rd and C. Kaufman. + Domain Name System Security Extensions. + January 1997. +

-
-

[RFC2065] D. Eastlake, 3rd and C. Kaufman. Domain Name System Security Extensions. January 1997.

+
+

[RFC2137] + + D. Eastlake, 3rd. + Secure Domain Name System Dynamic Update. + April 1997. +

-
-

[RFC2137] D. Eastlake, 3rd. Secure Domain Name System Dynamic Update. April 1997.

+
+

[RFC2535] + + D. Eastlake, 3rd. + Domain Name System Security Extensions. + March 1999. +

-
-

[RFC2535] D. Eastlake, 3rd. Domain Name System Security Extensions. March 1999.

+
+

[RFC3008] + + B. Wellington. + Domain Name System Security (DNSSEC) + Signing Authority. + November 2000. +

-
-

[RFC3008] B. Wellington. Domain Name System Security (DNSSEC) - Signing Authority. November 2000.

+
+

[RFC3090] + + E. Lewis. + DNS Security Extension Clarification on Zone Status. + March 2001. +

-
-

[RFC3090] E. Lewis. DNS Security Extension Clarification on Zone Status. March 2001.

+
+

[RFC3445] + + D. Massey and S. Rose. + Limiting the Scope of the KEY Resource Record (RR). + December 2002. +

-
-

[RFC3445] D. Massey and S. Rose. Limiting the Scope of the KEY Resource Record (RR). December 2002.

+
+

[RFC3655] + + B. Wellington and O. Gudmundsson. + Redefinition of DNS Authenticated Data (AD) bit. + November 2003. +

-
-

[RFC3655] B. Wellington and O. Gudmundsson. Redefinition of DNS Authenticated Data (AD) bit. November 2003.

+
+

[RFC3658] + + O. Gudmundsson. + Delegation Signer (DS) Resource Record (RR). + December 2003. +

-
-

[RFC3658] O. Gudmundsson. Delegation Signer (DS) Resource Record (RR). December 2003.

+
+

[RFC3755] + + S. Weiler. + Legacy Resolver Compatibility for Delegation Signer (DS). + May 2004. +

-
-

[RFC3755] S. Weiler. Legacy Resolver Compatibility for Delegation Signer (DS). May 2004.

+
+

[RFC3757] + + O. Kolkman, J. Schlyter, and E. Lewis. + Domain Name System KEY (DNSKEY) Resource Record + (RR) Secure Entry Point (SEP) Flag. + April 2004. +

-
-

[RFC3757] O. Kolkman, J. Schlyter, and E. Lewis. Domain Name System KEY (DNSKEY) Resource Record - (RR) Secure Entry Point (SEP) Flag. April 2004.

+
+

[RFC3845] + + J. Schlyter. + DNS Security (DNSSEC) NextSECure (NSEC) RDATA Format. + August 2004. +

-
-

[RFC3845] J. Schlyter. DNS Security (DNSSEC) NextSECure (NSEC) RDATA Format. August 2004.

-
-
-
-
-
+
+
+
+

Internet Drafts

-

+ +

Internet Drafts (IDs) are rough-draft working documents of the Internet Engineering Task Force. They are, in essence, RFCs in the preliminary stages of development. Implementors are @@ -465,22 +885,27 @@ they are "works in progress." IDs have a lifespan of six months after which they are deleted unless updated by their authors.

-
-
+
+

Other Documents About BIND

-

-
+ +

+

Bibliography

-
-

Paul Albitz and Cricket Liu. DNS and BIND. Copyright © 1998 Sebastopol, CA: O'Reilly and Associates.

-
-
-
-
+
+

+ Paul Albitz and Cricket Liu. + DNS and BIND. + Copyright © 1998 Sebastopol, CA: O'Reilly and Associates. +

+
+
+
+
diff --git a/doc/arm/Bv9ARM.ch12.html b/doc/arm/Bv9ARM.ch12.html index 063f199fc3..a30bde3d63 100644 --- a/doc/arm/Bv9ARM.ch12.html +++ b/doc/arm/Bv9ARM.ch12.html @@ -57,68 +57,80 @@ -
+

BIND 9 DNS Library Support

-

This version of BIND 9 "exports" its internal libraries so + +

This version of BIND 9 "exports" its internal libraries so that they can be used by third-party applications more easily (we call them "export" libraries in this document). In addition to all major DNS-related APIs BIND 9 is currently using, the export libraries provide the following features:

-
    -

  • The newly created "DNS client" module. This is a higher +

      +
    • +

      The newly created "DNS client" module. This is a higher level API that provides an interface to name resolution, single DNS transaction with a particular server, and dynamic update. Regarding name resolution, it supports advanced features such as DNSSEC validation and caching. This module - supports both synchronous and asynchronous mode.

      • -

    • The new "IRS" (Information Retrieval System) library. + supports both synchronous and asynchronous mode.

      +
      • +
    • +

      The new "IRS" (Information Retrieval System) library. It provides an interface to parse the traditional resolv.conf file and more advanced, DNS-specific configuration file for the rest of this package (see the description for the - dns.conf file below).

      • -

    • As part of the IRS library, newly implemented standard + dns.conf file below).

      +
      • +
    • +

      As part of the IRS library, newly implemented standard address-name mapping functions, getaddrinfo() and getnameinfo(), are provided. They use the DNSSEC-aware validating resolver backend, and could use other advanced features of the BIND 9 libraries such as caching. The getaddrinfo() function resolves both A and AAAA RRs - concurrently (when the address family is unspecified).

      • -

    • An experimental framework to support other event - libraries than BIND 9's internal event task system.

      • + concurrently (when the address family is unspecified).

      + +
    • +

      An experimental framework to support other event + libraries than BIND 9's internal event task system.

      +
    -
    +

    Prerequisite

    -

    GNU make is required to build the export libraries (other + +

    GNU make is required to build the export libraries (other part of BIND 9 can still be built with other types of make). In the reminder of this document, "make" means GNU make. Note that in some platforms you may need to invoke a different command name than "make" (e.g. "gmake") to indicate it's GNU make.

    -
    -
    +
    +

    Compilation

    -
    +
+  
     $ ./configure --enable-exportlib [other flags]
 $ make
 
    
-
    
+  
    
   This will create (in addition to usual BIND 9 programs) and a
   separate set of libraries under the lib/export directory. For
   example, lib/export/dns/libdns.a is the archive file of the
   export version of the BIND 9 DNS library. Sample application
   programs using the libraries will also be built under the
   lib/export/samples directory (see below).
    
-
    -
    +
    +

    Installation

    -
    +
+  
     $ cd lib/export
 $ make install
 
    
-
    
+  
    
   This will install library object files under the directory
   specified by the --with-export-libdir configure option (default:
   EPREFIX/lib/bind9), and header files under the directory
@@ -128,20 +140,24 @@ $ make install
   "make install" at the top directory will do the
   same.
   
    
-
    
+  
    
   To see how to build your own
   application after the installation, see
   lib/export/samples/Makefile-postinstall.in.
    
-
    -
    +
    +

    Known Defects/Restrictions

    -
      -

    • Currently, win32 is not supported for the export - library. (Normal BIND 9 application can be built as - before).

      • + +
      • -

        The "fixed" RRset order is not (currently) supported in + +

        Currently, win32 is not supported for the export + library. (Normal BIND 9 application can be built as + before).

        +
        • +
      • +

        The "fixed" RRset order is not (currently) supported in the export library. If you want to use "fixed" RRset order for, e.g. named while still building the export library even without the fixed order support, build @@ -156,27 +172,34 @@ $ make

        -
        • -

      • The client module and the IRS library currently do not +

        • +
      • +

        The client module and the IRS library currently do not support DNSSEC validation using DLV (the underlying modules can handle it, but there is no tunable interface to enable - the feature).

        • -

      • RFC 5011 is not supported in the validating stub + the feature).

        +
        • +
      • +

        RFC 5011 is not supported in the validating stub resolver of the export library. In fact, it is not clear whether it should: trust anchors would be a system-wide configuration which would be managed by an administrator, while the stub resolver will be used by ordinary applications - run by a normal user.

        • -

      • Not all common /etc/resolv.conf + run by a normal user.

        +
        • +
      • +

        Not all common /etc/resolv.conf options are supported in the IRS library. The only available options in this - version are "debug" and "ndots".

        • + version are "debug" and "ndots".

        +
      -
    -
    +
    +

    The dns.conf File

    -

    The IRS library supports an "advanced" configuration file + +

    The IRS library supports an "advanced" configuration file related to the DNS library for configuration parameters that would be beyond the capability of the resolv.conf file. @@ -190,29 +213,31 @@ $ make statement is supported, whose syntax is the same as the same name of statement for named.conf. (See the section called “trusted-keys Statement Grammar” for details.)

    -
    -
    +
    +

    Sample Applications

    -

    Some sample application programs using this API are + +

    Some sample application programs using this API are provided for reference. The following is a brief description of these applications.

    -
    +

    sample: a simple stub resolver utility

    -

    + +

    It sends a query of a given name (of a given optional RR type) to a specified recursive server, and prints the result as a list of RRs. It can also act as a validating stub resolver if a trust anchor is given via a set of command line options.

    -

    +

    Usage: sample [options] server_address hostname

    -

    +

    Options and Arguments:

    -
    +
    -t RRtype
    @@ -261,20 +286,21 @@ $ make the domain name for the query

    -
    -
    +
    +

    sample-async: a simple stub resolver, working asynchronously

    -

    + +

    Similar to "sample", but accepts a list of (query) domain names as a separate file and resolves the names asynchronously.

    -

    +

    Usage: sample-async [-s server_address] [-t RR_type] input_file

    -

    +

    Options and Arguments:

    -
    +
    -s server_address
    @@ -300,13 +326,14 @@ $ make   mx.example.net
      ns.xxx.example

    - +
    -
    -
    +
    +

    sample-request: a simple DNS transaction client

    -

    + +

    It sends a query to a specified server, and prints the response with minimal processing. It doesn't act as a "stub resolver": it stops the processing once it gets any @@ -315,39 +342,46 @@ $ make ultimate answer. In other words, this utility acts as a very simplified dig.

    -

    +

    Usage: sample-request [-t RRtype] server_address hostname

    -

    +

    Options and Arguments:

    -
    +
    -t RRtype
    -

    +

    +

    specify the RR type of the queries. The default is the A RR. -

    +

    +
    server_address
    -

    +

    +

    an IP(v4/v6) address of the recursive server to which the query is sent. -

    +

    +
    hostname
    -

    +

    +

    the domain name for the query -

    +

    +
    -
    -
    +
    +

    sample-gai: getaddrinfo() and getnameinfo() test code

    -

    + +

    This is a test program to check getaddrinfo() and getnameinfo() behavior. It takes a host name as an argument, calls getaddrinfo() with the given host @@ -357,26 +391,27 @@ $ make validating resolver, and getaddrinfo()/getnameinfo() will fail with an EAI_INSECUREDATA error when DNSSEC validation fails.

    -

    +

    Usage: sample-gai hostname

    -
    -
    +
    +

    sample-update: a simple dynamic update client program

    -

    + +

    It accepts a single update command as a command-line argument, sends an update request message to the authoritative server, and shows the response from the server. In other words, this is a simplified nsupdate.

    -

    +

    Usage: sample-update [options] (add|delete) "update data"

    -

    +

    Options and Arguments:

    -
    +
    -a auth_server
    @@ -432,7 +467,8 @@ $ make would look like "name TTL RRtype RDATA".

    -
    + +

    Note

    In practice, either -a or -r must be specified. Others can @@ -440,43 +476,46 @@ $ make appropriate server and the zone name for the update.

    -

    + +

    Examples: assuming the primary authoritative server of the dynamic.example.com zone has an IPv6 address 2001:db8::1234,

    -
    +   
     $ sample-update -a sample-update -k Kxxx.+nnn+mmmm.key add "foo.dynamic.example.com 30 IN A 192.168.2.1"
    
-
    
+   
    
      adds an A RR for foo.dynamic.example.com using the given key.
    
    
-
    +   
     $ sample-update -a sample-update -k Kxxx.+nnn+mmmm.key delete "foo.dynamic.example.com 30 IN A"
    
-
    
+   
    
      removes all A RRs for foo.dynamic.example.com using the given key.
    
    
-
    +   
     $ sample-update -a sample-update -k Kxxx.+nnn+mmmm.key delete "foo.dynamic.example.com"
    
-
    
+   
    
      removes all RRs for foo.dynamic.example.com using the given key.
    
    
-
    -
    +
    +

    nsprobe: domain/name server checker in terms of RFC 4074

    -

    + +

    It checks a set of domains to see the name servers of the domains behave correctly in terms of RFC 4074. This is included in the set of sample programs to show how the export library can be used in a DNS-related application.

    -

    +

    Usage: nsprobe [-d] [-v [-v...]] [-c cache_address] [input_file]

    -

    +

    Options

    -
    + +
    -d
    @@ -515,18 +554,19 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mm specifically, adding "www" and "ftp" to the zone name.

    -
    -
    -
    +
    +
    +

    Library References

    -

    As of this writing, there is no formal "manual" of the + +

    As of this writing, there is no formal "manual" of the libraries, except this document, header files (some of them provide pretty detailed explanations), and sample application programs.

    +
    -
    -
    +
diff --git a/doc/arm/Bv9ARM.ch13.html b/doc/arm/Bv9ARM.ch13.html index 38fe20f465..e8d9c8f270 100644 --- a/doc/arm/Bv9ARM.ch13.html +++ b/doc/arm/Bv9ARM.ch13.html @@ -137,7 +137,36 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
diff --git a/doc/arm/Bv9ARM.html b/doc/arm/Bv9ARM.html index 350806368f..17cbb3a98a 100644 --- a/doc/arm/Bv9ARM.html +++ b/doc/arm/Bv9ARM.html @@ -369,7 +369,34 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
diff --git a/doc/arm/man.arpaname.html b/doc/arm/man.arpaname.html index 35b87f2492..0f9fb9e85e 100644 --- a/doc/arm/man.arpaname.html +++ b/doc/arm/man.arpaname.html @@ -41,27 +41,45 @@
-
+ + + + +

Name

-

arpaname — translate IP addresses to the corresponding ARPA names

-
-
-

Synopsis

-

arpaname {ipaddress ...}

-
-
-

DESCRIPTION

+ arpaname + — translate IP addresses to the corresponding ARPA names +

+
+ + + +
+

Synopsis

+

+ arpaname + {ipaddress ...} +

+
+ +
+

DESCRIPTION

+ +

arpaname translates IP addresses (IPv4 and IPv6) to the corresponding IN-ADDR.ARPA or IP6.ARPA names.

-
-
+
+ +

SEE ALSO

-

+ +

BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/doc/arm/man.ddns-confgen.html b/doc/arm/man.ddns-confgen.html index 89c30e604c..ae05faf293 100644 --- a/doc/arm/man.ddns-confgen.html +++ b/doc/arm/man.ddns-confgen.html @@ -41,31 +41,63 @@
-
+ + + + + +

Name

-

ddns-confgen — ddns key generation tool

-
-
-

Synopsis

-

tsig-keygen [-a algorithm] [-h] [-r randomfile] [name]

-

ddns-confgen [-a algorithm] [-h] [-k keyname] [-q] [-r randomfile] [ -s name | -z zone ]

-
-
-

DESCRIPTION

+ ddns-confgen + — ddns key generation tool +

+
+ + + +
+

Synopsis

+

+ tsig-keygen + [-a algorithm] + [-h] + [-r randomfile] + [name] +

+

+ ddns-confgen + [-a algorithm] + [-h] + [-k keyname] + [-q] + [-r randomfile] + [ + -s name + | -z zone + ] +

+
+ +
+

DESCRIPTION

+ +

tsig-keygen and ddns-confgen are invocation methods for a utility that generates keys for use in TSIG signing. The resulting keys can be used, for example, to secure dynamic DNS updates to a zone or for the rndc command channel.

-

+ +

When run as tsig-keygen, a domain name can be specified on the command line which will be used as the name of the generated key. If no name is specified, the default is tsig-key.

-

+ +

When run as ddns-confgen, the generated key is accompanied by configuration text and instructions that can be used with nsupdate and @@ -75,7 +107,8 @@ rndc-confgen command for setting up command channel security.)

-

+ +

Note that named itself can configure a local DDNS key for use with nsupdate -l: it does this when a zone is configured with @@ -85,24 +118,32 @@ if nsupdate is to be used from a remote system.

-
-
+
+ +

OPTIONS

-
+ + +
-a algorithm
-

+

+

Specifies the algorithm to use for the TSIG key. Available choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384 and hmac-sha512. The default is hmac-sha256. Options are case-insensitive, and the "hmac-" prefix may be omitted. -

+

+
-h
-

+

+

Prints a short summary of options and arguments. -

+

+
-k keyname
-

+

+

Specifies the key name of the DDNS authentication key. The default is ddns-key when neither the -s nor -z option is @@ -112,15 +153,19 @@ ddns-key.example.com. The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods. -

+

+
-q
-

+

+

(ddns-confgen only.) Quiet mode: Print only the key, with no explanatory text or usage examples; This is essentially identical to tsig-keygen. -

+

+
-r randomfile
-

+

+

Specifies a source of random data for generating the authorization. If the operating system does not provide a /dev/random or equivalent device, the @@ -130,9 +175,11 @@ instead of the default. The special value keyboard indicates that keyboard input should be used. -

+

+
-s name
-

+

+

(ddns-confgen only.) Generate configuration example to allow dynamic updates of a single hostname. The example named.conf @@ -143,9 +190,11 @@ Note that the "self" nametype cannot be used, since the name to be updated may differ from the key name. This option cannot be used with the -z option. -

+

+
-z zone
-

+

+

(ddns-confgen only.) Generate configuration example to allow dynamic updates of a zone: The example named.conf text @@ -155,17 +204,27 @@ all subdomain names within that zone. This option cannot be used with the -s option. -

+

+
-
-
+
+ +

SEE ALSO

-

nsupdate(1), - named.conf(5), - named(8), + +

+ nsupdate(1) + , + + named.conf(5) + , + + named(8) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/doc/arm/man.delv.html b/doc/arm/man.delv.html index f7628940b3..3e8373ef4b 100644 --- a/doc/arm/man.delv.html +++ b/doc/arm/man.delv.html @@ -41,25 +41,70 @@
-
+ + + + + +

Name

-

delv — DNS lookup and validation utility

+

+ delv + — DNS lookup and validation utility +

-
+ + + +

Synopsis

-

delv [@server] [-4] [-6] [-a anchor-file] [-b address] [-c class] [-d level] [-i] [-m] [-p port#] [-q name] [-t type] [-x addr] [name] [type] [class] [queryopt...]

-

delv [-h]

-

delv [-v]

-

delv [queryopt...] [query...]

-
-
+

+ delv + [@server] + [-4] + [-6] + [-a anchor-file] + [-b address] + [-c class] + [-d level] + [-i] + [-m] + [-p port#] + [-q name] + [-t type] + [-x addr] + [name] + [type] + [class] + [queryopt...] +

+ +

+ delv + [-h] +

+ +

+ delv + [-v] +

+ +

+ delv + [queryopt...] + [query...] +

+
+ +

DESCRIPTION

-

delv + +

delv (Domain Entity Lookup & Validation) is a tool for sending DNS queries and validating the results, using the the same internal resolver and validator logic as named.

-

+

delv will send to a specified name server all queries needed to fetch and validate the requested data; this includes the original requested query, subsequent queries to follow @@ -69,7 +114,7 @@ behavior of a name server configured for DNSSEC validating and forwarding.

-

+

By default, responses are validated using built-in DNSSEC trust anchors for the root zone (".") and for the ISC DNSSEC lookaside validation zone ("dlv.isc.org"). Records returned by @@ -81,7 +126,7 @@ be used to check the validity of DNS responses in environments where local name servers may not be trustworthy.

-

+

Unless it is told to query a specific name server, delv will try each of the servers listed in /etc/resolv.conf. If no usable server @@ -89,15 +134,18 @@ queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6).

-

+

When no command line arguments or options are given, delv will perform an NS query for "." (the root zone).

-
-
+
+ +

SIMPLE USAGE

-

+ + +

A typical invocation of delv looks like: 

 delv @server name type
@@ -108,7 +156,7 @@
server
-

+

is the name or IP address of the name server to query. This can be an IPv4 address in dotted-decimal notation or an IPv6 address in colon-delimited notation. When the supplied @@ -118,7 +166,7 @@ initial lookup is not validated by DNSSEC).

-

+

If no server argument is provided, delv consults /etc/resolv.conf; if an @@ -131,13 +179,16 @@ the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6).

-
+
name
-

+

+

is the domain name to be looked up. -

+

+
type
-

+

+

indicates what type of query is required — ANY, A, MX, etc. type can be any valid query @@ -145,30 +196,34 @@ type argument is supplied, delv will perform a lookup for an A record. -

+

+

-
-
+ +
+ +

OPTIONS

-
+ +
-a anchor-file
-

+

Specifies a file from which to read DNSSEC trust anchors. The default is /etc/bind.keys, which is included with BIND 9 and contains trust anchors for the root zone (".") and for the ISC DNSSEC lookaside validation zone ("dlv.isc.org").

-

+

Keys that do not match the root or DLV trust-anchor names are ignored; these key names can be overridden using the +dlv=NAME or +root=NAME options.

-

+

Note: When reading the trust anchor file, delv treats managed-keys statements and trusted-keys statements @@ -182,23 +237,28 @@ /etc/bind.keys to use DNSSEC validation in delv.

-
+
-b address
-

+

+

Sets the source IP address of the query to address. This must be a valid address on one of the host's network interfaces or "0.0.0.0" or "::". An optional source port may be specified by appending "#<port>" -

+

+
-c class
-

+

+

Sets the query class for the requested data. Currently, only class "IN" is supported in delv and any other value is ignored. -

+

+
-d level
-

+

+

Set the systemwide debug level to level. The allowed range is from 0 to 99. The default is 0 (no debugging). @@ -207,13 +267,17 @@ See the +mtrace, +rtrace, and +vtrace options below for additional debugging details. -

+

+
-h
-

+

+

Display the delv help usage output and exit. -

+

+
-i
-

+

+

Insecure mode. This disables internal DNSSEC validation. (Note, however, this does not set the CD bit on upstream queries. If the server being queried is performing DNSSEC @@ -221,30 +285,37 @@ can cause delv to time out. When it is necessary to examine invalid data to debug a DNSSEC problem, use dig +cd.) -

+

+
-m
-

+

+

Enables memory usage debugging. -

+

+
-p port#
-

+

+

Specifies a destination port to use for queries instead of the standard DNS port number 53. This option would be used with a name server that has been configured to listen for queries on a non-standard port number. -

+

+
-q name
-

+

+

Sets the query name to name. While the query name can be specified without using the -q, it is sometimes necessary to disambiguate names from types or classes (for example, when looking up the name "ns", which could be misinterpreted as the type NS, or "ch", which could be misinterpreted as class CH). -

+

+
-t type
-

+

Sets the query type to type, which can be any valid query type supported in BIND 9 except for zone transfer types AXFR and IXFR. As with @@ -252,18 +323,21 @@ query name type or class when they are ambiguous. it is sometimes necessary to disambiguate names from types.

-

+

The default query type is "A", unless the -x option is supplied to indicate a reverse lookup, in which case it is "PTR".

-
+
-v
-

+

+

Print the delv version and exit. -

+

+
-x addr
-

+

+

Performs a reverse lookup, mapping an addresses to a name. addr is an IPv4 address in dotted-decimal notation, or a colon-delimited IPv6 address. @@ -273,24 +347,33 @@ lookup for a name like 11.12.13.10.in-addr.arpa and sets the query type to PTR. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. -

+

+
-4
-

+

+

Forces delv to only use IPv4. -

+

+
-6
-

+

+

Forces delv to only use IPv6. -

+

+
-
-
+
+ +

QUERY OPTIONS

-

delv + + +

delv provides a number of query options which affect the way results are displayed, and in some cases the way lookups are performed.

-

+ +

Each query option is identified by a keyword preceded by a plus sign (+). Some keywords set or reset an option. These may be preceded by the string @@ -302,7 +385,8 @@

+[no]cdflag
-

+

+

Controls whether to set the CD (checking disabled) bit in queries sent by delv. This may be useful when troubleshooting DNSSEC problems from behind a validating @@ -311,20 +395,25 @@ the CD flag on queries will cause the resolver to return invalid responses, which delv can then validate internally and report the errors in detail. -

+

+
+[no]class
-

+

+

Controls whether to display the CLASS when printing a record. The default is to display the CLASS. -

+

+
+[no]ttl
-

+

+

Controls whether to display the TTL when printing a record. The default is to display the TTL. -

+

+
+[no]rtrace
-

+

Toggle resolver fetch logging. This reports the name and type of each query sent by delv in the process of carrying out the resolution and validation @@ -332,62 +421,69 @@ all subsequent queries to follow CNAMEs and to establish a chain of trust for DNSSEC validation.

-

+

This is equivalent to setting the debug level to 1 in the "resolver" logging category. Setting the systemwide debug level to 1 using the -d option will product the same output (but will affect other logging categories as well).

-
+
+[no]mtrace
-

+

Toggle message logging. This produces a detailed dump of the responses received by delv in the process of carrying out the resolution and validation process.

-

+

This is equivalent to setting the debug level to 10 for the the "packets" module of the "resolver" logging category. Setting the systemwide debug level to 10 using the -d option will produce the same output (but will affect other logging categories as well).

-
+
+[no]vtrace
-

+

Toggle validation logging. This shows the internal process of the validator as it determines whether an answer is validly signed, unsigned, or invalid.

-

+

This is equivalent to setting the debug level to 3 for the the "validator" module of the "dnssec" logging category. Setting the systemwide debug level to 3 using the -d option will produce the same output (but will affect other logging categories as well).

-
+
+[no]short
-

+

+

Provide a terse answer. The default is to print the answer in a verbose form. -

+

+
+[no]comments
-

+

+

Toggle the display of comment lines in the output. The default is to print comments. -

+

+
+[no]rrcomments
-

+

+

Toggle the display of per-record comments in the output (for example, human-readable key information about DNSKEY records). The default is to print per-record comments. -

+

+
+[no]crypto
-

+

+

Toggle the display of cryptographic fields in DNSSEC records. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see @@ -395,14 +491,18 @@ When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]". -

+

+
+[no]trust
-

+

+

Controls whether to display the trust level when printing a record. The default is to display the trust level. -

+

+
+[no]split[=W]
-

+

+

Split long hex- or base64-formatted fields in resource records into chunks of W characters (where W is rounded up to the nearest @@ -411,24 +511,30 @@ +split=0 causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active. -

+

+
+[no]all
-

+

+

Set or clear the display options +[no]comments, +[no]rrcomments, and +[no]trust as a group. -

+

+
+[no]multiline
-

+

+

Print long records (such as RRSIG, DNSKEY, and SOA records) in a verbose multi-line format with human-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the delv output. -

+

+
+[no]dnssec
-

+

+

Indicates whether to display RRSIG records in the delv output. The default is to do so. Note that (unlike in dig) @@ -438,9 +544,11 @@ will always occur unless suppressed by the use of -i or +noroot and +nodlv. -

+

+
+[no]root[=ROOT]
-

+

+

Indicates whether to perform conventional (non-lookaside) DNSSEC validation, and if so, specifies the name of a trust anchor. The default is to validate using @@ -448,9 +556,11 @@ a built-in key. If specifying a different trust anchor, then -a must be used to specify a file containing the key. -

+

+
+[no]dlv[=DLV]
-

+

+

Indicates whether to perform DNSSEC lookaside validation, and if so, specifies the name of the DLV trust anchor. The default is to perform lookaside validation using @@ -458,28 +568,38 @@ built-in key. If specifying a different name, then -a must be used to specify a file containing the DLV key. -

+

+

-
-
+
+ +

FILES

-

/etc/bind.keys

-

/etc/resolv.conf

-
-
+ +

/etc/bind.keys

+

/etc/resolv.conf

+
+ +

SEE ALSO

-

dig(1), - named(8), + +

+ dig(1) + , + + named(8) + , RFC4034, RFC4035, RFC4431, RFC5074, RFC5155.

-
+
+
diff --git a/doc/arm/man.dig.html b/doc/arm/man.dig.html index 7aa2fb9c05..4e00189b9d 100644 --- a/doc/arm/man.dig.html +++ b/doc/arm/man.dig.html @@ -41,19 +41,61 @@
-
+ + + + + +

Name

-

dig — DNS lookup utility

+

+ dig + — DNS lookup utility +

-
+ + + +

Synopsis

-

dig [@server] [-b address] [-c class] [-f filename] [-k filename] [-m] [-p port#] [-q name] [-t type] [-v] [-x addr] [-y [hmac:]name:key] [-4] [-6] [name] [type] [class] [queryopt...]

-

dig [-h]

-

dig [global-queryopt...] [query...]

-
-
+

+ dig + [@server] + [-b address] + [-c class] + [-f filename] + [-k filename] + [-m] + [-p port#] + [-q name] + [-t type] + [-v] + [-x addr] + [-y [hmac:]name:key] + [-4] + [-6] + [name] + [type] + [class] + [queryopt...] +

+ +

+ dig + [-h] +

+ +

+ dig + [global-queryopt...] + [query...] +

+
+ +

DESCRIPTION

-

dig + +

dig (domain information groper) is a flexible tool for interrogating DNS name servers. It performs DNS lookups and displays the answers that are returned from the name server(s) that @@ -62,7 +104,8 @@ clarity of output. Other lookup tools tend to have less functionality than dig.

-

+ +

Although dig is normally used with command-line arguments, it also has a batch mode of operation for reading lookup @@ -73,34 +116,42 @@ from the command line.

-

+ +

Unless it is told to query a specific name server, dig will try each of the servers listed in /etc/resolv.conf. If no usable server addresses are found, dig will send the query to the local host.

-

+ +

When no command line arguments or options are given, dig will perform an NS query for "." (the root).

-

+ +

It is possible to set per-user defaults for dig via ${HOME}/.digrc. This file is read and any options in it are applied before the command line arguments.

-

+ +

The IN and CH class names overlap with the IN and CH top level domain names. Either use the -t and -c options to specify the type and class, use the -q the specify the domain name, or use "IN." and "CH." when looking up these top level domains.

-
-
+ +
+ +

SIMPLE USAGE

-

+ + +

A typical invocation of dig looks like: 

 dig @server name type
@@ -111,7 +162,7 @@
server
-

+

is the name or IP address of the name server to query. This can be an IPv4 address in dotted-decimal notation or an IPv6 address in colon-delimited notation. When the supplied @@ -119,7 +170,7 @@ dig resolves that name before querying that name server.

-

+

If no server argument is provided, dig consults /etc/resolv.conf; if an @@ -132,13 +183,16 @@ local host. The reply from the name server that responds is displayed.

-
+
name
-

+

+

is the name of the resource record that is to be looked up. -

+

+
type
-

+

+

indicates what type of query is required — ANY, A, MX, SIG, etc. type can be any valid query @@ -146,81 +200,109 @@ type argument is supplied, dig will perform a lookup for an A record. -

+

+

-
-
+ +
+ +

OPTIONS

-
+ + +
-4
-

+

+

Use IPv4 only. -

+

+
-6
-

+

+

Use IPv6 only. -

+

+
-b address[#port]
-

+

+

Set the source IP address of the query. The address must be a valid address on one of the host's network interfaces, or "0.0.0.0" or "::". An optional port may be specified by appending "#<port>" -

+

+
-c class
-

+

+

Set the query class. The default class is IN; other classes are HS for Hesiod records or CH for Chaosnet records. -

+

+
-f file
-

+

+

Batch mode: dig reads a list of lookup requests to process from the given file. Each line in the file should be organized in the same way they would be presented as queries to dig using the command-line interface. -

+

+
-i
-

+

+

Do reverse IPv6 lookups using the obsolete RFC1886 IP6.INT domain, which is no longer in use. Obsolete bit string label queries (RFC2874) are not attempted. -

+

+
-k keyfile
-

+

+

Sign queries using TSIG using a key read from the given file. Key files can be generated using - tsig-keygen(8). + + tsig-keygen(8) + . When using TSIG authentication with dig, the name server that is queried needs to know the key and algorithm that is being used. In BIND, this is done by providing appropriate key and server statements in named.conf. -

+

+
-m
-

+

+

Enable memory usage debugging. -

+

+
-p port
-

+

+

Send the query to a non-standard port on the server, instead of the defaut port 53. This option would be used to test a name server that has been configured to listen for queries on a non-standard port number. -

+

+
-q name
-

+

+

The domain name to query. This is useful to distinguish the name from other arguments. -

+

+
-t type
-

+

+

The resource record type to query. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the @@ -232,13 +314,17 @@ made to the zone since the serial number in the zone's SOA record was N. -

+

+
-v
-

+

+

Print the version number and exit. -

+

+
-x addr
-

+

+

Simplified reverse lookups, for mapping addresses to names. The addr is an IPv4 address in dotted-decimal notation, or a colon-delimited IPv6 @@ -253,10 +339,11 @@ addresses are looked up using nibble format under the IP6.ARPA domain (but see also the -i option). -

+

+
-y [hmac:]keyname:secret
-

+

Sign queries using TSIG with the given authentication key. keyname is the name of the key, and secret is the base64 encoded shared secret. @@ -268,28 +355,34 @@ is not specified, the default is hmac-md5 or if MD5 was disabled hmac-sha256.

-

+

NOTE: You should use the -k option and avoid the -y option, because with -y the shared secret is supplied as a command line argument in clear text. This may be visible in the output from - ps(1) + + ps(1) + or in a history file maintained by the user's shell.

-
+
-
-
+
+ +

QUERY OPTIONS

-

dig + + +

dig provides a number of query options which affect the way in which lookups are made and the results displayed. Some of these set or reset flag bits in the query header, some determine which sections of the answer get printed, and others determine the timeout and retry strategies.

-

+ +

Each query option is identified by a keyword preceded by a plus sign (+). Some keywords set or reset an option. These may be preceded @@ -305,20 +398,27 @@

+[no]aaflag
-

+

+

A synonym for +[no]aaonly. -

+

+
+[no]aaonly
-

+

+

Sets the "aa" flag in the query. -

+

+
+[no]additional
-

+

+

Display [do not display] the additional section of a reply. The default is to display it. -

+

+
+[no]adflag
-

+

+

Set [do not set] the AD (authentic data) bit in the query. This requests the server to return whether all of the answer and authority sections have all @@ -328,61 +428,81 @@ from a OPT-OUT range. AD=0 indicate that some part of the answer was insecure or not validated. This bit is set by default. -

+

+
+[no]all
-

+

+

Set or clear all display flags. -

+

+
+[no]answer
-

+

+

Display [do not display] the answer section of a reply. The default is to display it. -

+

+
+[no]authority
-

+

+

Display [do not display] the authority section of a reply. The default is to display it. -

+

+
+[no]besteffort
-

+

+

Attempt to display the contents of messages which are malformed. The default is to not display malformed answers. -

+

+
+bufsize=B
-

+

+

Set the UDP message buffer size advertised using EDNS0 to B bytes. The maximum and minimum sizes of this buffer are 65535 and 0 respectively. Values outside this range are rounded up or down appropriately. Values other than zero will cause a EDNS query to be sent. -

+

+
+[no]cdflag
-

+

+

Set [do not set] the CD (checking disabled) bit in the query. This requests the server to not perform DNSSEC validation of responses. -

+

+
+[no]class
-

+

+

Display [do not display] the CLASS when printing the record. -

+

+
+[no]cmd
-

+

+

Toggles the printing of the initial comment in the output identifying the version of dig and the query options that have been applied. This comment is printed by default. -

+

+
+[no]comments
-

+

+

Toggle the display of comment lines in the output. The default is to print comments. -

+

+
+[no]crypto
-

+

+

Toggle the display of cryptographic fields in DNSSEC records. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing @@ -391,100 +511,130 @@ are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]". -

+

+
+[no]defname
-

+

+

Deprecated, treated as a synonym for +[no]search -

+

+
+[no]dnssec
-

+

+

Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query. -

+

+
+domain=somename
-

+

+

Set the search list to contain the single domain somename, as if specified in a domain directive in /etc/resolv.conf, and enable search list processing as if the +search option were given. -

+

+
+[no]edns[=#]
-

+

+

Specify the EDNS version to query with. Valid values are 0 to 255. Setting the EDNS version will cause a EDNS query to be sent. +noedns clears the remembered EDNS version. EDNS is set to 0 by default. -

+

+
+[no]ednsflags[=#]
-

+

+

Set the must-be-zero EDNS flags bits (Z bits) to the specified value. Decimal, hex and octal encodings are accepted. Setting a named flag (e.g. DO) will silently be ignored. By default, no Z bits are set. -

+

+
+[no]ednsnegotiation
-

+

+

Enable / disable EDNS version negotiation. By default EDNS version negotiation is enabled. -

+

+
+[no]ednsopt[=code[:value]]
-

+

+

Specify EDNS option with code point code and optionally payload of value as a hexadecimal string. +noednsopt clears the EDNS options to to be sent. -

+

+
+[no]expire
-

+

+

Send an EDNS Expire option. -

+

+
+[no]fail
-

+

+

Do not try the next server if you receive a SERVFAIL. The default is to not try the next server which is the reverse of normal stub resolver behavior. -

+

+
+[no]identify
-

+

+

Show [or do not show] the IP address and port number that supplied the answer when the +short option is enabled. If short form answers are requested, the default is not to show the source address and port number of the server that provided the answer. -

+

+
+[no]idnout
-

+

+

Convert [do not convert] puny code on output. This requires IDN SUPPORT to have been enabled at compile time. The default is to convert output. -

+

+
+[no]ignore
-

+

+

Ignore truncation in UDP responses instead of retrying with TCP. By default, TCP retries are performed. -

+

+
+[no]keepopen
-

+

+

Keep the TCP socket open between queries and reuse it rather than creating a new TCP socket for each lookup. The default is +nokeepopen. -

+

+
+[no]multiline
-

+

+

Print records like the SOA records in a verbose multi-line format with human-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the dig output. -

+

+
+ndots=D
-

+

+

Set the number of dots that have to appear in name to D for it to be considered absolute. The default value @@ -496,110 +646,140 @@ or domain directive in /etc/resolv.conf if +search is set. -

+

+
+[no]nsid
-

+

+

Include an EDNS name server ID request when sending a query. -

+

+
+[no]nssearch
-

+

+

When this option is set, dig attempts to find the authoritative name servers for the zone containing the name being looked up and display the SOA record that each name server has for the zone. -

+

+
+[no]onesoa
-

+

+

Print only one (starting) SOA record when performing an AXFR. The default is to print both the starting and ending SOA records. -

+

+
+[no]opcode=value
-

+

+

Set [restore] the DNS message opcode to the specified value. The default value is QUERY (0). -

+

+
+[no]qr
-

+

+

Print [do not print] the query as it is sent. By default, the query is not printed. -

+

+
+[no]question
-

+

+

Print [do not print] the question section of a query when an answer is returned. The default is to print the question section as a comment. -

+

+
+[no]rdflag
-

+

+

A synonym for +[no]recurse. -

+

+
+[no]recurse
-

+

+

Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means dig normally sends recursive queries. Recursion is automatically disabled when the +nssearch or +trace query options are used. -

+

+
+retry=T
-

+

+

Sets the number of times to retry UDP queries to server to T instead of the default, 2. Unlike +tries, this does not include the initial query. -

+

+
+[no]rrcomments
-

+

+

Toggle the display of per-record comments in the output (for example, human-readable key information about DNSKEY records). The default is not to print record comments unless multiline mode is active. -

+

+
+[no]search
-

+

Use [do not use] the search list defined by the searchlist or domain directive in resolv.conf (if any). The search list is not used by default.

-

+

'ndots' from resolv.conf (default 1) which may be overridden by +ndots determines if the name will be treated as relative or not and hence whether a search is eventually performed or not.

-
+
+[no]short
-

+

+

Provide a terse answer. The default is to print the answer in a verbose form. -

+

+
+[no]showsearch
-

+

+

Perform [do not perform] a search showing intermediate results. -

+

+
+[no]sigchase
-

+

+

Chase DNSSEC signature chains. Requires dig be compiled with -DDIG_SIGCHASE. -

+

+
+[no]sit[=####]
-

+

+

Send a Source Identity Token EDNS option, with optional value. Replaying a SIT from a previous response will allow the server to identify a previous client. The default is +nosit. Currently using experimental value 65001 for the option code. -

+

+
+split=W
-

+

+

Split long hex- or base64-formatted fields in resource records into chunks of W characters (where W is rounded @@ -608,21 +788,24 @@ +split=0 causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active. -

+

+
+[no]stats
-

+

+

This query option toggles the printing of statistics: when the query was made, the size of the reply and so on. The default behavior is to print the query statistics. -

+

+
+[no]subnet=addr[/prefix-length]
-

+

Send (don't send) an EDNS Client Subnet option with the specified IP address or network prefix.

-

+

dig +subnet=0.0.0.0/0, or simply dig +subnet=0 for short, sends an EDNS CLIENT-SUBNET option with an empty address and a source @@ -631,17 +814,20 @@ not be used when resolving this query.

-
+
+[no]tcp
-

+

+

Use [do not use] TCP when querying name servers. The default behavior is to use UDP unless an ixfr=N query is requested, in which case the default is TCP. AXFR queries always use TCP. -

+

+
+time=T
-

+

+

Sets the timeout for a query to T seconds. The default @@ -649,15 +835,18 @@ An attempt to set T to less than 1 will result in a query timeout of 1 second being applied. -

+

+
+[no]topdown
-

+

+

When chasing DNSSEC signature chains perform a top-down validation. Requires dig be compiled with -DDIG_SIGCHASE. -

+

+
+[no]trace
-

+

Toggle tracing of the delegation path from the root name servers for the name being looked up. Tracing is disabled by default. When tracing is enabled, @@ -665,62 +854,67 @@ resolve the name being looked up. It will follow referrals from the root servers, showing the answer from each server that was used to resolve the lookup. -

-

+

If @server is also specified, it affects only the initial query for the root zone name servers. -

-

+

+dnssec is also set when +trace is set to better emulate the default queries from a nameserver.

-
+
+tries=T
-

+

+

Sets the number of times to try UDP queries to server to T instead of the default, 3. If T is less than or equal to zero, the number of tries is silently rounded up to 1. -

+

+
+trusted-key=####
-

+

Specifies a file containing trusted keys to be used with +sigchase. Each DNSKEY record must be on its own line. -

-

+

If not specified, dig will look for /etc/trusted-key.key then trusted-key.key in the current directory. -

-

+

Requires dig be compiled with -DDIG_SIGCHASE.

-
+
+[no]ttlid
-

+

+

Display [do not display] the TTL when printing the record. -

+

+
+[no]vc
-

+

+

Use [do not use] TCP when querying name servers. This alternate syntax to +[no]tcp is provided for backwards compatibility. The "vc" stands for "virtual circuit". -

+

+

-
-
+
+ +

MULTIPLE QUERIES

-

+ + +

The BIND 9 implementation of dig supports specifying multiple queries on the command line (in addition to @@ -728,7 +922,8 @@ queries can be supplied with its own set of flags, options and query options.

-

+ +

In this case, each query argument represent an individual query in the command-line syntax described above. Each @@ -736,7 +931,8 @@ looked up, an optional query type and class and any query options that should be applied to that query.

-

+ +

A global set of query options, which should be applied to all queries, can also be supplied. These global query options must precede the first tuple of name, class, type, options, flags, and query options @@ -763,10 +959,13 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr will not print the initial query when it looks up the NS records for isc.org.

-
-
+ +
+ +

IDN SUPPORT

-

+ +

If dig has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. dig appropriately converts character encoding of @@ -777,28 +976,41 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr The IDN support is disabled if the variable is set when dig runs.

-
-
+
+ +

FILES

-

/etc/resolv.conf + +

/etc/resolv.conf

-

${HOME}/.digrc +

${HOME}/.digrc

-
-
+
+ +

SEE ALSO

-

host(1), - named(8), - dnssec-keygen(8), + +

+ host(1) + , + + named(8) + , + + dnssec-keygen(8) + , RFC1035.

-
-
+
+ +

BUGS

-

+ +

There are probably too many query options.

-
+
+
diff --git a/doc/arm/man.dnssec-checkds.html b/doc/arm/man.dnssec-checkds.html index d2b5809934..1ae925acc7 100644 --- a/doc/arm/man.dnssec-checkds.html +++ b/doc/arm/man.dnssec-checkds.html @@ -41,59 +41,106 @@
-
+ + + + + +

Name

-

dnssec-checkds — DNSSEC delegation consistency checking tool

+

+ dnssec-checkds + — DNSSEC delegation consistency checking tool +

-
+ + + +

Synopsis

-

dnssec-checkds [-l domain] [-f file] [-d dig path] [-D dsfromkey path] {zone}

-

dnssec-dsfromkey [-l domain] [-f file] [-d dig path] [-D dsfromkey path] {zone}

-
-
+

+ dnssec-checkds + [-l domain] + [-f file] + [-d dig path] + [-D dsfromkey path] + {zone} +

+

+ dnssec-dsfromkey + [-l domain] + [-f file] + [-d dig path] + [-D dsfromkey path] + {zone} +

+
+ +

DESCRIPTION

-

dnssec-checkds + +

dnssec-checkds verifies the correctness of Delegation Signer (DS) or DNSSEC Lookaside Validation (DLV) resource records for keys in a specified zone.

-
-
+
+ +

OPTIONS

-
+ + +
-f file
-

+

+

If a file is specified, then the zone is read from that file to find the DNSKEY records. If not, then the DNSKEY records for the zone are looked up in the DNS. -

+

+
-l domain
-

+

+

Check for a DLV record in the specified lookaside domain, instead of checking for a DS record in the zone's parent. For example, to check for DLV records for "example.com" in ISC's DLV zone, use: dnssec-checkds -l dlv.isc.org example.com -

+

+
-d dig path
-

+

+

Specifies a path to a dig binary. Used for testing. -

+

+
-D dsfromkey path
-

+

+

Specifies a path to a dnssec-dsfromkey binary. Used for testing. -

+

+
-
-
+
+ +

SEE ALSO

-

dnssec-dsfromkey(8), - dnssec-keygen(8), - dnssec-signzone(8), + +

+ dnssec-dsfromkey(8) + , + + dnssec-keygen(8) + , + + dnssec-signzone(8) + ,

-
+
+
diff --git a/doc/arm/man.dnssec-coverage.html b/doc/arm/man.dnssec-coverage.html index bcea296a8a..d0356be7c0 100644 --- a/doc/arm/man.dnssec-coverage.html +++ b/doc/arm/man.dnssec-coverage.html @@ -41,22 +41,47 @@
-
+ + + + + +

Name

-

dnssec-coverage — checks future DNSKEY coverage for a zone

+

+ dnssec-coverage + — checks future DNSKEY coverage for a zone +

-
+ + + +

Synopsis

-

dnssec-coverage [-K directory] [-l length] [-f file] [-d DNSKEY TTL] [-m max TTL] [-r interval] [-c compilezone path] [-k] [-z] [zone...]

-
-
+

+ dnssec-coverage + [-K directory] + [-l length] + [-f file] + [-d DNSKEY TTL] + [-m max TTL] + [-r interval] + [-c compilezone path] + [-k] + [-z] + [zone...] +

+
+ +

DESCRIPTION

-

dnssec-coverage + +

dnssec-coverage verifies that the DNSSEC keys for a given zone or a set of zones have timing metadata set properly to ensure no future lapses in DNSSEC coverage.

-

+

If zone is specified, then keys found in the key repository matching that zone are scanned, and an ordered list is generated of the events scheduled for that key (i.e., @@ -69,47 +94,54 @@ key is rolled, and cached data signed by the prior key has not had time to expire from resolver caches.

-

+

If zone is not specified, then all keys in the key repository will be scanned, and all zones for which there are keys will be analyzed. (Note: This method of reporting is only accurate if all the zones that have keys in a given repository share the same TTL parameters.)

-
-
+
+ +

OPTIONS

-
+ + +
-K directory
-

+

+

Sets the directory in which keys can be found. Defaults to the current working directory. -

+

+
-f file
-

+

+

If a file is specified, then the zone is read from that file; the largest TTL and the DNSKEY TTL are determined directly from the zone data, and the -m and -d options do not need to be specified on the command line. -

+

+
-l duration
-

+

The length of time to check for DNSSEC coverage. Key events scheduled further into the future than duration will be ignored, and assumed to be correct.

-

+

The value of duration can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.

-
+
-m maximum TTL
-

+

Sets the value to be used as the maximum TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure. When a zone-signing key is @@ -118,26 +150,26 @@ before that key can be purged from the DNSKEY RRset. If that condition does not apply, a warning will be generated.

-

+

The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.

-

+

This option is not necessary if the -f has been used to specify a zone file. If -f has been specified, this option may still be used; it will override the value found in the file.

-

+

If this option is not used and the maximum TTL cannot be retrieved from a zone file, a warning is generated and a default value of 1 week is used.

-
+
-d DNSKEY TTL
-

+

Sets the value to be used as the DNSKEY TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure. When a key is rolled (that @@ -146,12 +178,12 @@ the new key is activated and begins generating signatures. If that condition does not apply, a warning will be generated.

-

+

The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.

-

+

This option is not necessary if -f has been used to specify a zone file from which the TTL of the DNSKEY RRset can be read, or if a default key TTL was @@ -160,15 +192,15 @@ this option may still be used; it will override the values found in the zone file or the key file.

-

+

If this option is not used and the key TTL cannot be retrieved from the zone file or the key file, then a warning is generated and a default value of 1 day is used.

-
+
-r resign interval
-

+

Sets the value to be used as the resign interval for the zone or zones being analyzed when determining whether there is a possibility of validation failure. This value defaults to @@ -178,38 +210,55 @@ named.conf, then it should also be changed here.

-

+

The length of the interval can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.

-
+
-k
-

+

+

Only check KSK coverage; ignore ZSK events. Cannot be used with -z. -

+

+
-z
-

+

+

Only check ZSK coverage; ignore KSK events. Cannot be used with -k. -

+

+
-c compilezone path
-

+

+

Specifies a path to a named-compilezone binary. Used for testing. -

+

+
-
-
+
+ +

SEE ALSO

-

- dnssec-checkds(8), - dnssec-dsfromkey(8), - dnssec-keygen(8), - dnssec-signzone(8) + +

+ + dnssec-checkds(8) + , + + dnssec-dsfromkey(8) + , + + dnssec-keygen(8) + , + + dnssec-signzone(8) +

-
+
+
diff --git a/doc/arm/man.dnssec-dsfromkey.html b/doc/arm/man.dnssec-dsfromkey.html index 687d591bca..52a75fd4fe 100644 --- a/doc/arm/man.dnssec-dsfromkey.html +++ b/doc/arm/man.dnssec-dsfromkey.html @@ -41,159 +41,243 @@
-
+ + + + + +

Name

-

dnssec-dsfromkey — DNSSEC DS RR generation tool

+

+ dnssec-dsfromkey + — DNSSEC DS RR generation tool +

-
+ + + +

Synopsis

-

dnssec-dsfromkey [-v level] [-1] [-2] [-a alg] [-C] [-l domain] [-T TTL] {keyfile}

-

dnssec-dsfromkey {-s} [-1] [-2] [-a alg] [-K directory] [-l domain] [-s] [-c class] [-T TTL] [-f file] [-A] [-v level] {dnsname}

-

dnssec-dsfromkey [-h] [-V]

-
-
+

+ dnssec-dsfromkey + [-v level] + [-1] + [-2] + [-a alg] + [-C] + [-l domain] + [-T TTL] + {keyfile} +

+

+ dnssec-dsfromkey + {-s} + [-1] + [-2] + [-a alg] + [-K directory] + [-l domain] + [-s] + [-c class] + [-T TTL] + [-f file] + [-A] + [-v level] + {dnsname} +

+

+ dnssec-dsfromkey + [-h] + [-V] +

+
+ +

DESCRIPTION

-

dnssec-dsfromkey + +

dnssec-dsfromkey outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s).

-
-
+
+ +

OPTIONS

-
+ + +
-1
-

+

+

Use SHA-1 as the digest algorithm (the default is to use both SHA-1 and SHA-256). -

+

+
-2
-

+

+

Use SHA-256 as the digest algorithm. -

+

+
-a algorithm
-

+

+

Select the digest algorithm. The value of algorithm must be one of SHA-1 (SHA1), SHA-256 (SHA256), GOST or SHA-384 (SHA384). These values are case insensitive. -

+

+
-C
-

+

+

Generate CDS records rather than DS records. This is mutually exclusive with generating lookaside records. -

+

+
-T TTL
-

+

+

Specifies the TTL of the DS records. -

+

+
-K directory
-

+

+

Look for key files (or, in keyset mode, keyset- files) in directory. -

+

+
-f file
-

+

Zone file mode: in place of the keyfile name, the argument is the DNS domain name of a zone master file, which can be read from file. If the zone name is the same as file, then it may be omitted.

-

+

If file is set to "-", then the zone data is read from the standard input. This makes it possible to use the output of the dig command as input, as in:

-

+

dig dnskey example.com | dnssec-dsfromkey -f - example.com

-
+
-A
-

+

+

Include ZSK's when generating DS records. Without this option, only keys which have the KSK flag set will be converted to DS records and printed. Useful only in zone file mode. -

+

+
-l domain
-

+

+

Generate a DLV set instead of a DS set. The specified domain is appended to the name for each record in the set. The DNSSEC Lookaside Validation (DLV) RR is described in RFC 4431. This is mutually exclusive with generating CDS records. -

+

+
-s
-

+

+

Keyset mode: in place of the keyfile name, the argument is the DNS domain name of a keyset file. -

+

+
-c class
-

+

+

Specifies the DNS class (default is IN). Useful only in keyset or zone file mode. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-h
-

+

+

Prints usage information. -

+

+
-V
-

+

+

Prints version information. -

+

+
-
-
+
+ +

EXAMPLE

-

+ +

To build the SHA-256 DS RR from the Kexample.com.+003+26160 keyfile name, the following command would be issued:

-

dnssec-dsfromkey -2 Kexample.com.+003+26160 +

dnssec-dsfromkey -2 Kexample.com.+003+26160

-

+

The command would print something like:

-

example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94 +

example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94

-
-
+
+ +

FILES

-

+ +

The keyfile can be designed by the key identification Knnnn.+aaa+iiiii or the full file name Knnnn.+aaa+iiiii.key as generated by dnssec-keygen(8).

-

+

The keyset file name is built from the directory, the string keyset- and the dnsname.

-
-
+
+ +

CAVEAT

-

+ +

A keyfile error can give a "file not found" even if the file exists.

-
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), - dnssec-signzone(8), + +

+ dnssec-keygen(8) + , + + dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 3658, RFC 4431. RFC 4509.

-
+
+
diff --git a/doc/arm/man.dnssec-importkey.html b/doc/arm/man.dnssec-importkey.html index 5d3ef715fe..1ccebdd479 100644 --- a/doc/arm/man.dnssec-importkey.html +++ b/doc/arm/man.dnssec-importkey.html @@ -41,18 +41,52 @@
-
+ + + + + +

Name

-

dnssec-importkey — import DNSKEY records from external systems so they can be managed

+

+ dnssec-importkey + — import DNSKEY records from external systems so they can be managed +

-
+ + + +

Synopsis

-

dnssec-importkey [-K directory] [-L ttl] [-P date/offset] [-D date/offset] [-h] [-v level] [-V] {keyfile}

-

dnssec-importkey {-f filename} [-K directory] [-L ttl] [-P date/offset] [-D date/offset] [-h] [-v level] [-V] [dnsname]

-
-
+

+ dnssec-importkey + [-K directory] + [-L ttl] + [-P date/offset] + [-D date/offset] + [-h] + [-v level] + [-V] + {keyfile} +

+

+ dnssec-importkey + {-f filename} + [-K directory] + [-L ttl] + [-P date/offset] + [-D date/offset] + [-h] + [-v level] + [-V] + [dnsname] +

+
+ +

DESCRIPTION

-

dnssec-importkey + +

dnssec-importkey reads a public DNSKEY record and generates a pair of .key/.private files. The DNSKEY record may be read from an existing .key file, in which case a corresponding .private file @@ -60,7 +94,7 @@ from the standard input, in which case both .key and .private files will be generated.

-

+

The newly-created .private file does not contain private key data, and cannot be used for signing. However, having a .private file makes it possible to set @@ -69,53 +103,68 @@ public key can be added to and removed from the DNSKEY RRset on schedule even if the true private key is stored offline.

-
-
+
+ +

OPTIONS

-
+ + +
-f filename
-

+

Zone file mode: instead of a public keyfile name, the argument is the DNS domain name of a zone master file, which can be read from file. If the domain name is the same as file, then it may be omitted.

-

+

If file is set to "-", then the zone data is read from the standard input.

-
+
-K directory
-

+

+

Sets the directory in which the key files are to reside. -

+

+
-L ttl
-

+

+

Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. Setting the default TTL to 0 or none removes it. -

+

+
-h
-

+

+

Emit usage message and exit. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-
-
+
+ +

TIMING OPTIONS

-

+ +

Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as an offset from the present time. For convenience, if such an offset @@ -126,38 +175,52 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. -

+

+
-D date/offset
-

+

+

Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) -

+

+
-
-
+
+ +

FILES

-

+ +

A keyfile can be designed by the key identification Knnnn.+aaa+iiiii or the full file name Knnnn.+aaa+iiiii.key as generated by dnssec-keygen(8).

-
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), - dnssec-signzone(8), + +

+ dnssec-keygen(8) + , + + dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 5011.

-
+
+
diff --git a/doc/arm/man.dnssec-keyfromlabel.html b/doc/arm/man.dnssec-keyfromlabel.html index 150dc08653..c4bec39748 100644 --- a/doc/arm/man.dnssec-keyfromlabel.html +++ b/doc/arm/man.dnssec-keyfromlabel.html @@ -41,17 +41,56 @@
-
+ + + + + +

Name

-

dnssec-keyfromlabel — DNSSEC key generation tool

+

+ dnssec-keyfromlabel + — DNSSEC key generation tool +

-
+ + + +

Synopsis

-

dnssec-keyfromlabel {-l label} [-3] [-a algorithm] [-A date/offset] [-c class] [-D date/offset] [-E engine] [-f flag] [-G] [-I date/offset] [-i interval] [-k] [-K directory] [-L ttl] [-n nametype] [-P date/offset] [-p protocol] [-R date/offset] [-S key] [-t type] [-v level] [-V] [-y] {name}

-
-
+

+ dnssec-keyfromlabel + {-l label} + [-3] + [-a algorithm] + [-A date/offset] + [-c class] + [-D date/offset] + [-E engine] + [-f flag] + [-G] + [-I date/offset] + [-i interval] + [-k] + [-K directory] + [-L ttl] + [-n nametype] + [-P date/offset] + [-p protocol] + [-R date/offset] + [-S key] + [-t type] + [-v level] + [-V] + [-y] + {name} +

+
+ +

DESCRIPTION

-

dnssec-keyfromlabel + +

dnssec-keyfromlabel generates a key pair of files that referencing a key object stored in a cryptographic hardware service module (HSM). The private key file can be used for DNSSEC signing of zone data as if it were a @@ -59,52 +98,57 @@ but the key material is stored within the HSM, and the actual signing takes place there.

-

+

The name of the key is specified on the command line. This must match the name of the zone for which the key is being generated.

-
-
+
+ +

OPTIONS

-
+ + +
-a algorithm
-

+

Selects the cryptographic algorithm. The value of algorithm must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384. These values are case insensitive.

-

+

If no algorithm is specified, then RSASHA1 will be used by default, unless the -3 option is specified, in which case NSEC3RSASHA1 will be used instead. (If -3 is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.)

-

+

Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended.

-

+

Note 2: DH automatically sets the -k flag.

-
+
-3
-

+

+

Use an NSEC3-capable algorithm to generate a DNSSEC key. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -112,20 +156,20 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-l label
-

+

Specifies the label for a key pair in the crypto hardware.

-

+

When BIND 9 is built with OpenSSL-based PKCS#11 support, the label is an arbitrary string that identifies a particular key. It may be preceded by an optional OpenSSL engine name, followed by a colon, as in "pkcs11:keylabel".

-

+

When BIND 9 is built with native PKCS#11 support, the label is a PKCS#11 URI string in the format "pkcs11:keyword=value[;keyword=value;...]" @@ -134,7 +178,7 @@ which the HSM's PIN code can be obtained. The label will be stored in the on-disk "private" file.

-

+

If the label contains a pin-source field, tools using the generated key files will be able to use the HSM for signing and other @@ -143,18 +187,21 @@ may reduce the security advantage of using an HSM; be sure this is what you want to do before making use of this feature.

-
+
-n nametype
-

+

+

Specifies the owner type of the key. The value of nametype must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). These values are case insensitive. -

+

+
-C
-

+

+

Compatibility mode: generates an old-style key, without any metadata. By default, dnssec-keyfromlabel will include the key's creation date in the metadata stored @@ -162,53 +209,71 @@ (publication date, activation date, etc). Keys that include this data may be incompatible with older versions of BIND; the -C option suppresses them. -

+

+
-c class
-

+

+

Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. -

+

+
-f flag
-

+

+

Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE. -

+

+
-G
-

+

+

Generate a key, but do not publish it or sign with it. This option is incompatible with -P and -A. -

+

+
-h
-

+

+

Prints a short summary of the options and arguments to dnssec-keyfromlabel. -

+

+
-K directory
-

+

+

Sets the directory in which the key files are to be written. -

+

+
-k
-

+

+

Generate KEY records rather than DNSKEY records. -

+

+
-L ttl
-

+

+

Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. Setting the default TTL to 0 or none removes it. -

+

+
-p protocol
-

+

+

Sets the protocol value for the key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in RFC 2535 and its successors. -

+

+
-S key
-

+

+

Generate a key as an explicit successor to an existing key. The name, algorithm, size, and type of the key will be set to match the predecessor. The activation date of the new @@ -216,35 +281,47 @@ one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. -

+

+
-t type
-

+

+

Indicates the use of the key. type must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-y
-

+

+

Allows DNSSEC key files to be generated even if the key ID would collide with that of an existing key, in the event of either key being revoked. (This is only safe to use if you are sure you won't be using RFC 5011 trust anchor maintenance with either of the keys involved.) -

+

+
-
-
+
+ +

TIMING OPTIONS

-

+ + +

Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as an offset from the present time. For convenience, if such an offset @@ -255,42 +332,53 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. If not set, and if the -G option has not been used, the default is "now". -

+

+
-A date/offset
-

+

+

Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. If not set, and if the -G option has not been used, the default is "now". -

+

+
-R date/offset
-

+

+

Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it. -

+

+
-I date/offset
-

+

+

Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it. -

+

+
-D date/offset
-

+

+

Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) -

+

+
-i interval
-

+

Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the @@ -299,69 +387,84 @@ the publication date is specified but activation date isn't, then activation will be set to this much time after publication.

-

+

If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero.

-

+

As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.

-
+
-
-
+
+ +

GENERATED KEY FILES

-

+ +

When dnssec-keyfromlabel completes successfully, it prints a string of the form Knnnn.+aaa+iiiii to the standard output. This is an identification string for the key files it has generated.

-
    -

  • nnnn is the key name. -

    • -

  • aaa is the numeric representation +

      +
    • +

      nnnn is the key name. +

      +
      • +
    • +

      aaa is the numeric representation of the algorithm. -

      • -

    • iiiii is the key identifier (or +

      +
      • +
    • +

      iiiii is the key identifier (or footprint). -

      • +

      +
    -

    dnssec-keyfromlabel +

    dnssec-keyfromlabel creates two files, with names based on the printed string. Knnnn.+aaa+iiiii.key contains the public key, and Knnnn.+aaa+iiiii.private contains the private key.

    -

    +

    The .key file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement).

    -

    +

    The .private file contains algorithm-specific fields. For obvious security reasons, this file does not have general read permission.

    -
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), - dnssec-signzone(8), + +

+ dnssec-keygen(8) + , + + dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 4034, The PKCS#11 URI Scheme (draft-pechanec-pkcs11uri-13).

-
+
+
diff --git a/doc/arm/man.dnssec-keygen.html b/doc/arm/man.dnssec-keygen.html index 5a801d62e1..162ac4d284 100644 --- a/doc/arm/man.dnssec-keygen.html +++ b/doc/arm/man.dnssec-keygen.html @@ -41,34 +41,82 @@
-
+ + + + + +

Name

-

dnssec-keygen — DNSSEC key generation tool

+

+ dnssec-keygen + — DNSSEC key generation tool +

-
+ + + +

Synopsis

-

dnssec-keygen [-a algorithm] [-b keysize] [-n nametype] [-3] [-A date/offset] [-C] [-c class] [-D date/offset] [-E engine] [-f flag] [-G] [-g generator] [-h] [-I date/offset] [-i interval] [-K directory] [-L ttl] [-k] [-P date/offset] [-p protocol] [-q] [-R date/offset] [-r randomdev] [-S key] [-s strength] [-t type] [-v level] [-V] [-z] {name}

-
-
+

+ dnssec-keygen + [-a algorithm] + [-b keysize] + [-n nametype] + [-3] + [-A date/offset] + [-C] + [-c class] + [-D date/offset] + [-E engine] + [-f flag] + [-G] + [-g generator] + [-h] + [-I date/offset] + [-i interval] + [-K directory] + [-L ttl] + [-k] + [-P date/offset] + [-p protocol] + [-q] + [-R date/offset] + [-r randomdev] + [-S key] + [-s strength] + [-t type] + [-v level] + [-V] + [-z] + {name} +

+
+ +

DESCRIPTION

-

dnssec-keygen + +

dnssec-keygen generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034. It can also generate keys for use with TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY (Transaction Key) as defined in RFC 2930.

-

+

The name of the key is specified on the command line. For DNSSEC keys, this must match the name of the zone for which the key is being generated.

-
-
+
+ +

OPTIONS

-
+ + +
-a algorithm
-

+

Selects the cryptographic algorithm. For DNSSEC keys, the value of algorithm must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, @@ -78,26 +126,26 @@ HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are case insensitive.

-

+

If no algorithm is specified, then RSASHA1 will be used by default, unless the -3 option is specified, in which case NSEC3RSASHA1 will be used instead. (If -3 is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.)

-

+

Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is mandatory.

-

+

Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512 automatically set the -T KEY option.

-
+
-b keysize
-

+

Specifies the number of bits in the key. The choice of key size depends on the algorithm used. RSA keys must be between 512 and 2048 bits. Diffie Hellman keys must be between @@ -106,7 +154,7 @@ between 1 and 512 bits. Elliptic curve algorithms don't need this parameter.

-

+

The key size does not need to be specified if using a default algorithm. The default key size is 1024 bits for zone signing keys (ZSK's) and 2048 bits for key signing keys (KSK's, @@ -115,9 +163,10 @@ then there is no default key size, and the -b must be used.

-
+
-n nametype
-

+

+

Specifies the owner type of the key. The value of nametype must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with @@ -125,18 +174,22 @@ USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). These values are case insensitive. Defaults to ZONE for DNSKEY generation. -

+

+
-3
-

+

+

Use an NSEC3-capable algorithm to generate a DNSSEC key. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default. Note that RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 and ECDSAP384SHA384 algorithms are NSEC3-capable. -

+

+
-C
-

+

+

Compatibility mode: generates an old-style key, without any metadata. By default, dnssec-keygen will include the key's creation date in the metadata stored @@ -144,18 +197,21 @@ (publication date, activation date, etc). Keys that include this data may be incompatible with older versions of BIND; the -C option suppresses them. -

+

+
-c class
-

+

+

Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -163,39 +219,52 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-f flag
-

+

+

Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE. -

+

+
-G
-

+

+

Generate a key, but do not publish it or sign with it. This option is incompatible with -P and -A. -

+

+
-g generator
-

+

+

If generating a Diffie Hellman key, use this generator. Allowed values are 2 and 5. If no generator is specified, a known prime from RFC 2539 will be used if possible; otherwise the default is 2. -

+

+
-h
-

+

+

Prints a short summary of the options and arguments to dnssec-keygen. -

+

+
-K directory
-

+

+

Sets the directory in which the key files are to be written. -

+

+
-k
-

+

+

Deprecated in favor of -T KEY. -

+

+
-L ttl
-

+

+

Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was @@ -204,16 +273,20 @@ is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to 0 or none is the same as leaving it unset. -

+

+
-p protocol
-

+

+

Sets the protocol value for the generated key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in RFC 2535 and its successors. -

+

+
-q
-

+

+

Quiet mode: Suppresses unnecessary output, including progress indication. Without this option, when dnssec-keygen is run interactively @@ -225,9 +298,11 @@ round of the Miller-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key. -

+

+
-r randomdev
-

+

+

Specifies the source of randomness. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness @@ -237,9 +312,11 @@ data to be used instead of the default. The special value keyboard indicates that keyboard input should be used. -

+

+
-S key
-

+

+

Create a new key which is an explicit successor to an existing key. The name, algorithm, size, and type of the key will be set to match the existing key. The activation @@ -247,16 +324,19 @@ the existing one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. -

+

+
-s strength
-

+

+

Specifies the strength value of the key. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC. -

+

+
-T rrtype
-

+

Specifies the resource record type to use for the key. rrtype must be either DNSKEY or KEY. The default is DNSKEY when using a DNSSEC algorithm, but it can be @@ -268,27 +348,36 @@ Using any TSIG algorithm (HMAC-* or DH) forces this option to KEY.

-
+
-t type
-

+

+

Indicates the use of the key. type must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-
-
+
+ +

TIMING OPTIONS

-

+ + +

Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as an offset from the present time. For convenience, if such an offset @@ -299,44 +388,55 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. If not set, and if the -G option has not been used, the default is "now". -

+

+
-A date/offset
-

+

+

Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. If not set, and if the -G option has not been used, the default is "now". If set, if and -P is not set, then the publication date will be set to the activation date minus the prepublication interval. -

+

+
-R date/offset
-

+

+

Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it. -

+

+
-I date/offset
-

+

+

Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it. -

+

+
-D date/offset
-

+

+

Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) -

+

+
-i interval
-

+

Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the @@ -345,42 +445,51 @@ the publication date is specified but activation date isn't, then activation will be set to this much time after publication.

-

+

If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero.

-

+

As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.

-
+
-
-
+
+ + +

GENERATED KEYS

-

+ +

When dnssec-keygen completes successfully, it prints a string of the form Knnnn.+aaa+iiiii to the standard output. This is an identification string for the key it has generated.

-
    -

  • nnnn is the key name. -

    • -

  • aaa is the numeric representation +

      +
    • +

      nnnn is the key name. +

      +
      • +
    • +

      aaa is the numeric representation of the algorithm. -

      • -

    • iiiii is the key identifier (or +

      +
      • +
    • +

      iiiii is the key identifier (or footprint). -

      • +

      +
    -

    dnssec-keygen +

    dnssec-keygen creates two files, with names based on the printed string. Knnnn.+aaa+iiiii.key contains the public key, and @@ -388,54 +497,61 @@ private key.

    -

    +

    The .key file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement).

    -

    +

    The .private file contains algorithm-specific fields. For obvious security reasons, this file does not have general read permission.

    -

    +

    Both .key and .private files are generated for symmetric cryptography algorithms such as HMAC-MD5, even though the public and private key are equivalent.

    -
-
+
+ +

EXAMPLE

-

+ +

To generate a 768-bit DSA key for the domain example.com, the following command would be issued:

-

dnssec-keygen -a DSA -b 768 -n ZONE example.com +

dnssec-keygen -a DSA -b 768 -n ZONE example.com

-

+

The command would print a string of the form:

-

Kexample.com.+003+26160 +

Kexample.com.+003+26160

-

+

In this example, dnssec-keygen creates the files Kexample.com.+003+26160.key and Kexample.com.+003+26160.private.

-
-
+
+ +

SEE ALSO

-

dnssec-signzone(8), + +

+ dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 2539, RFC 2845, RFC 4034.

-
+
+
diff --git a/doc/arm/man.dnssec-revoke.html b/doc/arm/man.dnssec-revoke.html index 26410f5be2..4d8edd8291 100644 --- a/doc/arm/man.dnssec-revoke.html +++ b/doc/arm/man.dnssec-revoke.html @@ -41,52 +41,88 @@
-
+ + + + + +

Name

-

dnssec-revoke — set the REVOKED bit on a DNSSEC key

+

+ dnssec-revoke + — set the REVOKED bit on a DNSSEC key +

-
+ + + +

Synopsis

-

dnssec-revoke [-hr] [-v level] [-V] [-K directory] [-E engine] [-f] [-R] {keyfile}

-
-
+

+ dnssec-revoke + [-hr] + [-v level] + [-V] + [-K directory] + [-E engine] + [-f] + [-R] + {keyfile} +

+
+ +

DESCRIPTION

-

dnssec-revoke + +

dnssec-revoke reads a DNSSEC key file, sets the REVOKED bit on the key as defined in RFC 5011, and creates a new pair of key files containing the now-revoked key.

-
-
+
+ +

OPTIONS

-
+ + +
-h
-

+

+

Emit usage message and exit. -

+

+
-K directory
-

+

+

Sets the directory in which the key files are to reside. -

+

+
-r
-

+

+

After writing the new keyset files remove the original keyset files. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -94,27 +130,36 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-f
-

+

+

Force overwrite: Causes dnssec-revoke to write the new key pair even if a file already exists matching the algorithm and key ID of the revoked key. -

+

+
-R
-

+

+

Print the key tag of the key with the REVOKE bit set but do not revoke the key. -

+

+
-
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), + +

+ dnssec-keygen(8) + , BIND 9 Administrator Reference Manual, RFC 5011.

-
+
+
diff --git a/doc/arm/man.dnssec-settime.html b/doc/arm/man.dnssec-settime.html index 139186067a..650a089736 100644 --- a/doc/arm/man.dnssec-settime.html +++ b/doc/arm/man.dnssec-settime.html @@ -41,17 +41,45 @@
-
+ + + + + +

Name

-

dnssec-settime — set the key timing metadata for a DNSSEC key

+

+ dnssec-settime + — set the key timing metadata for a DNSSEC key +

-
+ + + +

Synopsis

-

dnssec-settime [-f] [-K directory] [-L ttl] [-P date/offset] [-A date/offset] [-R date/offset] [-I date/offset] [-D date/offset] [-h] [-V] [-v level] [-E engine] {keyfile}

-
-
+

+ dnssec-settime + [-f] + [-K directory] + [-L ttl] + [-P date/offset] + [-A date/offset] + [-R date/offset] + [-I date/offset] + [-D date/offset] + [-h] + [-V] + [-v level] + [-E engine] + {keyfile} +

+
+ +

DESCRIPTION

-

dnssec-settime + +

dnssec-settime reads a DNSSEC private key file and sets the key timing metadata as specified by the -P, -A, -R, -I, and -D @@ -60,12 +88,12 @@ determine when a key is to be published, whether it should be used for signing a zone, etc.

-

+

If none of these options is set on the command line, then dnssec-settime simply prints the key timing metadata already stored in the key.

-

+

When key metadata fields are changed, both files of a key pair (Knnnn.+aaa+iiiii.key and Knnnn.+aaa+iiiii.private) are regenerated. @@ -74,12 +102,16 @@ file. The private file's permissions are always set to be inaccessible to anyone other than the owner (mode 0600).

-
-
+
+ +

OPTIONS

-
+ + +
-f
-

+

+

Force an update of an old-format key with no metadata fields. Without this option, dnssec-settime will fail when attempting to update a legacy key. With this option, @@ -88,13 +120,17 @@ set to the present time. If no other values are specified, then the key's publication and activation dates will also be set to the present time. -

+

+
-K directory
-

+

+

Sets the directory in which the key files are to reside. -

+

+
-L ttl
-

+

+

Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was @@ -103,25 +139,32 @@ is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to 0 or none removes it from the key. -

+

+
-h
-

+

+

Emit usage message and exit. -

+

+
-V
-

+

+

Prints version information. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -129,12 +172,14 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-
-
+
+ +

TIMING OPTIONS

-

+ +

Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as an offset from the present time. For convenience, if such an offset @@ -144,39 +189,51 @@ days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To unset a date, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. -

+

+
-A date/offset
-

+

+

Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. -

+

+
-R date/offset
-

+

+

Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it. -

+

+
-I date/offset
-

+

+

Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it. -

+

+
-D date/offset
-

+

+

Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) -

+

+
-S predecessor key
-

+

+

Select a key for which the key being modified will be an explicit successor. The name, algorithm, size, and type of the predecessor key must exactly match those of the key being @@ -184,10 +241,11 @@ to the inactivation date of the predecessor. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. -

+

+
-i interval
-

+

Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the @@ -196,34 +254,40 @@ the publication date is specified but activation date isn't, then activation will be set to this much time after publication.

-

+

If the key is being set to be an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero.

-

+

As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.

-
+
-
-
+
+ +

PRINTING OPTIONS

-

+ +

dnssec-settime can also be used to print the timing metadata associated with a key.

-
+ +
-u
-

+

+

Print times in UNIX epoch format. -

+

+
-p C/P/A/R/I/D/all
-

+

+

Print a specific metadata value or set of metadata values. The -p option may be followed by one or more of the following letters to indicate which value or values to print: @@ -234,17 +298,25 @@ I for the inactivation date, or D for the deletion date. To print all of the metadata, use -p all. -

+

+
-
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), - dnssec-signzone(8), + +

+ dnssec-keygen(8) + , + + dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 5011.

-
+
+
diff --git a/doc/arm/man.dnssec-signzone.html b/doc/arm/man.dnssec-signzone.html index e9b366e2a4..cd7f1dfa17 100644 --- a/doc/arm/man.dnssec-signzone.html +++ b/doc/arm/man.dnssec-signzone.html @@ -41,17 +41,71 @@
-
+ + + + + +

Name

-

dnssec-signzone — DNSSEC zone signing tool

+

+ dnssec-signzone + — DNSSEC zone signing tool +

-
+ + + +

Synopsis

-

dnssec-signzone [-a] [-c class] [-d directory] [-D] [-E engine] [-e end-time] [-f output-file] [-g] [-h] [-K directory] [-k key] [-L serial] [-l domain] [-M domain] [-i interval] [-I input-format] [-j jitter] [-N soa-serial-format] [-o origin] [-O output-format] [-P] [-p] [-R] [-r randomdev] [-S] [-s start-time] [-T ttl] [-t] [-u] [-v level] [-V] [-X extended end-time] [-x] [-z] [-3 salt] [-H iterations] [-A] {zonefile} [key...]

-
-
+

+ dnssec-signzone + [-a] + [-c class] + [-d directory] + [-D] + [-E engine] + [-e end-time] + [-f output-file] + [-g] + [-h] + [-K directory] + [-k key] + [-L serial] + [-l domain] + [-M domain] + [-i interval] + [-I input-format] + [-j jitter] + [-N soa-serial-format] + [-o origin] + [-O output-format] + [-P] + [-p] + [-R] + [-r randomdev] + [-S] + [-s start-time] + [-T ttl] + [-t] + [-u] + [-v level] + [-V] + [-X extended end-time] + [-x] + [-z] + [-3 salt] + [-H iterations] + [-A] + {zonefile} + [key...] +

+
+ +

DESCRIPTION

-

dnssec-signzone + +

dnssec-signzone signs a zone. It generates NSEC and RRSIG records and produces a signed version of the zone. The security status of delegations from the signed zone @@ -59,34 +113,46 @@ determined by the presence or absence of a keyset file for each child zone.

-
-
+
+ +

OPTIONS

-
+ + +
-a
-

+

+

Verify all generated signatures. -

+

+
-c class
-

+

+

Specifies the DNS class of the zone. -

+

+
-C
-

+

+

Compatibility mode: Generate a keyset-zonename file in addition to dsset-zonename when signing a zone, for use by older versions of dnssec-signzone. -

+

+
-d directory
-

+

+

Look for dsset- or keyset- files in directory. -

+

+
-D
-

+

+

Output only those record types automatically managed by dnssec-signzone, i.e. RRSIG, NSEC, NSEC3 and NSEC3PARAM records. If smart signing @@ -95,15 +161,16 @@ zone file with $INCLUDE. This option cannot be combined with -O raw, -O map, or serial number updating. -

+

+
-E engine
-

+

When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -111,30 +178,39 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-g
-

+

+

Generate DS records for child zones from dsset- or keyset- file. Existing DS records will be removed. -

+

+
-K directory
-

+

+

Key repository: Specify a directory to search for DNSSEC keys. If not specified, defaults to the current directory. -

+

+
-k key
-

+

+

Treat specified key as a key signing key ignoring any key flags. This option may be specified multiple times. -

+

+
-l domain
-

+

+

Generate a DLV set in addition to the key (DNSKEY) and DS sets. The domain is appended to the name of the records. -

+

+
-M maxttl
-

+

+

Sets the maximum TTL for the signed zone. Any TTL higher than maxttl in the input zone will be reduced to maxttl @@ -147,9 +223,11 @@ max-zone-ttl in named.conf. (Note: This option is incompatible with -D, because it modifies non-DNSSEC data in the output zone.) -

+

+
-s start-time
-

+

+

Specify the date and time when the generated RRSIG records become valid. This can be either an absolute or relative time. An absolute start time is indicated by a number @@ -158,9 +236,11 @@ indicated by +N, which is N seconds from the current time. If no start-time is specified, the current time minus 1 hour (to allow for clock skew) is used. -

+

+
-e end-time
-

+

+

Specify the date and time when the generated RRSIG records expire. As with start-time, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative @@ -170,10 +250,11 @@ specified, 30 days from the start time is used as a default. end-time must be later than start-time. -

+

+
-X extended end-time
-

+

Specify the date and time when the generated RRSIG records for the DNSKEY RRset will expire. This is to be used in cases when the DNSKEY signatures need to persist longer than @@ -181,7 +262,7 @@ of the KSK is kept offline and the KSK signature is to be refreshed manually.

-

+

As with start-time, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative to the start time is indicated with +N, which is N seconds from @@ -192,28 +273,34 @@ 30 days from the start time.) extended end-time must be later than start-time.

-
+
-f output-file
-

+

+

The name of the output file containing the signed zone. The default is to append .signed to the input filename. If output-file is set to "-", then the signed zone is written to the standard output, with a default output format of "full". -

+

+
-h
-

+

+

Prints a short summary of the options and arguments to dnssec-signzone. -

+

+
-V
-

+

+

Prints version information. -

+

+
-i interval
-

+

When a previously-signed zone is passed as input, records may be resigned. The interval option specifies the cycle interval as an offset from the current @@ -221,7 +308,7 @@ cycle interval, it is retained. Otherwise, it is considered to be expiring soon, and it will be replaced.

-

+

The default cycle interval is one quarter of the difference between the signature end and start times. So if neither end-time or start-time @@ -232,9 +319,10 @@ are due to expire in less than 7.5 days, they would be replaced.

-
+
-I input-format
-

+

+

The format of the input zone file. Possible formats are "text" (default), "raw", and "map". @@ -243,10 +331,11 @@ format containing updates can be signed directly. The use of this option does not make much sense for non-dynamic zones. -

+

+
-j jitter
-

+

When signing a zone with a fixed signature lifetime, all RRSIG records issued at the time of signing expires simultaneously. If the zone is incrementally signed, i.e. @@ -257,52 +346,67 @@ expire time, thus spreading incremental signature regeneration over time.

-

+

Signature lifetime jitter also to some extent benefits validators and servers by spreading out cache expiration, i.e. if large numbers of RRSIGs don't expire at the same time from all caches there will be less congestion than if all validators need to refetch at mostly the same time.

-
+
-L serial
-

+

+

When writing a signed zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) -

+

+
-n ncpus
-

+

+

Specifies the number of threads to use. By default, one thread is started for each detected CPU. -

+

+
-N soa-serial-format
-

+

The SOA serial number format of the signed zone. Possible formats are "keep" (default), "increment" and "unixtime".

-
+ +
"keep"
-

Do not modify the SOA serial number.

+
+

Do not modify the SOA serial number.

+
"increment"
-

Increment the SOA serial number using RFC 1982 - arithmetics.

+
+

Increment the SOA serial number using RFC 1982 + arithmetics.

+
"unixtime"
-

Set the SOA serial number to the number of seconds - since epoch.

+
+

Set the SOA serial number to the number of seconds + since epoch.

+
-
+ +
-o origin
-

+

+

The zone origin. If not specified, the name of the zone file is assumed to be the origin. -

+

+
-O output-format
-

+

+

The format of the output file containing the signed zone. Possible formats are "text" (default), which is the standard textual representation of the zone; @@ -315,33 +419,36 @@ the raw zone file: if N is 0, the raw file can be read by any version of named; if N is 1, the file can be read by release 9.9.0 or higher; the default is 1. -

+

+
-p
-

+

+

Use pseudo-random data when signing the zone. This is faster, but less secure, than using real random data. This option may be useful when signing large zones or when the entropy source is limited. -

+

+
-P
-

+

Disable post sign verification tests.

-

+

The post sign verification test ensures that for each algorithm in use there is at least one non revoked self signed KSK key, that all revoked KSK keys are self signed, and that all records in the zone are signed by the algorithm. This option skips these tests.

-
+
-Q
-

+

Remove signatures from keys that are no longer active.

-

+

Normally, when a previously-signed zone is passed as input to the signer, and a DNSKEY record has been removed and replaced with a new one, signatures from the old key @@ -353,22 +460,23 @@ enables ZSK rollover using the procedure described in RFC 4641, section 4.2.1.1 ("Pre-Publish Key Rollover").

-
+
-R
-

+

Remove signatures from keys that are no longer published.

-

+

This option is similar to -Q, except it forces dnssec-signzone to signatures from keys that are no longer published. This enables ZSK rollover using the procedure described in RFC 4641, section 4.2.1.2 ("Double Signature Zone Signing Key Rollover").

-
+
-r randomdev
-

+

+

Specifies the source of randomness. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness @@ -378,53 +486,65 @@ data to be used instead of the default. The special value keyboard indicates that keyboard input should be used. -

+

+
-S
-

+

Smart signing: Instructs dnssec-signzone to search the key repository for keys that match the zone being signed, and to include them in the zone if appropriate.

-

+

When a key is found, its timing metadata is examined to determine how it should be used, according to the following rules. Each successive rule takes priority over the prior ones:

-
+
-

+

+

If no timing metadata has been set for the key, the key is published in the zone and used to sign the zone. -

+

+
-

+

+

If the key's publication date is set and is in the past, the key is published in the zone. -

+

+
-

+

+

If the key's activation date is set and in the past, the key is published (regardless of publication date) and used to sign the zone. -

+

+
-

+

+

If the key's revocation date is set and in the past, and the key is published, then the key is revoked, and the revoked key is used to sign the zone. -

+

+
-

+

+

If either of the key's unpublication or deletion dates are set and in the past, the key is NOT published or used to sign the zone, regardless of any other metadata. -

+

+
- +
-T ttl
-

+

+

Specifies a TTL to be used for new DNSKEY records imported into the zone from the key repository. If not specified, the default is the TTL value from the zone's SOA @@ -436,81 +556,102 @@ them, or if any of the imported DNSKEY records had a default TTL value. In the event of a a conflict between TTL values in imported keys, the shortest one is used. -

+

+
-t
-

+

+

Print statistics at completion. -

+

+
-u
-

+

+

Update NSEC/NSEC3 chain when re-signing a previously signed zone. With this option, a zone signed with NSEC can be switched to NSEC3, or a zone signed with NSEC3 can be switch to NSEC or to NSEC3 with different parameters. Without this option, dnssec-signzone will retain the existing chain when re-signing. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-x
-

+

+

Only sign the DNSKEY RRset with key-signing keys, and omit signatures from zone-signing keys. (This is similar to the dnssec-dnskey-kskonly yes; zone option in named.) -

+

+
-z
-

+

+

Ignore KSK flag on key when determining what to sign. This causes KSK-flagged keys to sign all records, not just the DNSKEY RRset. (This is similar to the update-check-ksk no; zone option in named.) -

+

+
-3 salt
-

+

+

Generate an NSEC3 chain with the given hex encoded salt. A dash (salt) can be used to indicate that no salt is to be used when generating the NSEC3 chain. -

+

+
-H iterations
-

+

+

When generating an NSEC3 chain, use this many iterations. The default is 10. -

+

+
-A
-

+

When generating an NSEC3 chain set the OPTOUT flag on all NSEC3 records and do not generate NSEC3 records for insecure delegations.

-

+

Using this option twice (i.e., -AA) turns the OPTOUT flag off for all records. This is useful when using the -u option to modify an NSEC3 chain which previously had OPTOUT set.

-
+
zonefile
-

+

+

The file containing the zone to be signed. -

+

+
key
-

+

+

Specify which keys should be used to sign the zone. If no keys are specified, then the zone will be examined for DNSKEY records at the zone apex. If these are found and there are matching private keys, in the current directory, then these will be used for signing. -

+

+
-
-
+
+ +

EXAMPLE

-

+ +

The following command signs the example.com zone with the DSA key generated by dnssec-keygen (Kexample.com.+003+17247). Because the -S option @@ -523,13 +664,13 @@ Kexample.com.+003+17247 db.example.com.signed % -

+

In the above example, dnssec-signzone creates the file db.example.com.signed. This file should be referenced in a zone statement in a named.conf file.

-

+

This example re-signs a previously signed zone with default parameters. The private keys are assumed to be in the current directory.

@@ -537,14 +678,19 @@ db.example.com.signed % dnssec-signzone -o example.com db.example.com db.example.com.signed % -
-
+
+ +

SEE ALSO

-

dnssec-keygen(8), + +

+ dnssec-keygen(8) + , BIND 9 Administrator Reference Manual, RFC 4033, RFC 4641.

-
+
+
diff --git a/doc/arm/man.dnssec-verify.html b/doc/arm/man.dnssec-verify.html index 1d5de38f52..28c684e79f 100644 --- a/doc/arm/man.dnssec-verify.html +++ b/doc/arm/man.dnssec-verify.html @@ -41,35 +41,64 @@
-
+ + + + + +

Name

-

dnssec-verify — DNSSEC zone verification tool

+

+ dnssec-verify + — DNSSEC zone verification tool +

-
+ + + +

Synopsis

-

dnssec-verify [-c class] [-E engine] [-I input-format] [-o origin] [-v level] [-V] [-x] [-z] {zonefile}

-
-
+

+ dnssec-verify + [-c class] + [-E engine] + [-I input-format] + [-o origin] + [-v level] + [-V] + [-x] + [-z] + {zonefile} +

+
+ +

DESCRIPTION

-

dnssec-verify + +

dnssec-verify verifies that a zone is fully signed for each algorithm found in the DNSKEY RRset for the zone, and that the NSEC / NSEC3 chains are complete.

-
-
+
+ +

OPTIONS

-
+ + +
-c class
-

+

+

Specifies the DNS class of the zone. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -77,9 +106,10 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-I input-format
-

+

+

The format of the input zone file. Possible formats are "text" (default) and "raw". @@ -88,32 +118,41 @@ format containing updates can be verified independently. The use of this option does not make much sense for non-dynamic zones. -

+

+
-o origin
-

+

+

The zone origin. If not specified, the name of the zone file is assumed to be the origin. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-x
-

+

+

Only verify that the DNSKEY RRset is signed with key-signing keys. Without this flag, it is assumed that the DNSKEY RRset will be signed by all active keys. When this flag is set, it will not be an error if the DNSKEY RRset is not signed by zone-signing keys. This corresponds to the -x option in dnssec-signzone. -

+

+
-z
-

+

Ignore the KSK flag on the keys when determining whether the zone if correctly signed. Without this flag it is assumed that there will be a non-revoked, self-signed @@ -121,7 +160,7 @@ that RRsets other than DNSKEY RRset will be signed with a different DNSKEY without the KSK flag set.

-

+

With this flag set, we only require that for each algorithm, there will be at least one non-revoked, self-signed DNSKEY, regardless of the KSK flag state, and that other RRsets @@ -130,21 +169,28 @@ for both purposes. This corresponds to the -z option in dnssec-signzone.

-
+
zonefile
-

+

+

The file containing the zone to be signed. -

+

+
-
-
+
+ +

SEE ALSO

-

- dnssec-signzone(8), + +

+ + dnssec-signzone(8) + , BIND 9 Administrator Reference Manual, RFC 4033.

-
+
+
diff --git a/doc/arm/man.genrandom.html b/doc/arm/man.genrandom.html index 113de6fc4f..e38be520f5 100644 --- a/doc/arm/man.genrandom.html +++ b/doc/arm/man.genrandom.html @@ -41,48 +41,81 @@
-
+ + + + + +

Name

-

genrandom — generate a file containing random data

-
-
-

Synopsis

-

genrandom [-n number] {size} {filename}

-
-
-

DESCRIPTION

+ genrandom + — generate a file containing random data +

+
+ + + +
+

Synopsis

+

+ genrandom + [-n number] + {size} + {filename} +

+
+ +
+

DESCRIPTION

+ +

genrandom generates a file or a set of files containing a specified quantity of pseudo-random data, which can be used as a source of entropy for other commands on systems with no random device.

-
-
+
+ +

ARGUMENTS

-
+ +
-n number
-

+

+

In place of generating one file, generates number (from 2 to 9) files, appending number to the name. -

+

+
size
-

+

+

The size of the file, in kilobytes, to generate. -

+

+
filename
-

+

+

The file name into which random data should be written. -

+

+
-
-
+
+ +

SEE ALSO

-

- rand(3), - arc4random(3) + +

+ + rand(3) + , + + arc4random(3) +

-
+
+
diff --git a/doc/arm/man.host.html b/doc/arm/man.host.html index 979dc8a401..547f77739e 100644 --- a/doc/arm/man.host.html +++ b/doc/arm/man.host.html @@ -41,24 +41,54 @@
-
+ + + + + +

Name

-

host — DNS lookup utility

+

+ host + — DNS lookup utility +

-
+ + + +

Synopsis

-

host [-aCdlnrsTwv] [-c class] [-N ndots] [-R number] [-t type] [-W wait] [-m flag] [-4] [-6] [-v] [-V] {name} [server]

-
-
+

+ host + [-aCdlnrsTwv] + [-c class] + [-N ndots] + [-R number] + [-t type] + [-W wait] + [-m flag] + [-4] + [-6] + [-v] + [-V] + {name} + [server] +

+
+ +

DESCRIPTION

-

host + + +

host is a simple utility for performing DNS lookups. It is normally used to convert names to IP addresses and vice versa. When no arguments or options are given, host prints a short summary of its command line arguments and options.

-

name is the domain name that is to be + +

name is the domain name that is to be looked up. It can also be a dotted-decimal IPv4 address or a colon-delimited IPv6 address, in which case host will by @@ -70,68 +100,86 @@ should query instead of the server or servers listed in /etc/resolv.conf.

-
-
+ +
+ +

OPTIONS

-
+ +
-4
-

+

+

Use IPv4 only for query transport. See also the -6 option. -

+

+
-6
-

+

+

Use IPv6 only for query transport. See also the -4 option. -

+

+
-a
-

+

+

"All". The -a option is normally equivalent to -v -t ANY. It also affects the behaviour of the -l list zone option. -

+

+
-c class
-

+

+

Query class: This can be used to lookup HS (Hesiod) or CH (Chaosnet) class resource records. The default class is IN (Internet). -

+

+
-C
-

+

+

Check consistency: host will query the SOA records for zone name from all the listed authoritative name servers for that zone. The list of name servers is defined by the NS records that are found for the zone. -

+

+
-d
-

+

+

Print debugging traces. Equivalent to the -v verbose option. -

+

+
-i
-

+

+

Obsolete. Use the IP6.INT domain for reverse lookups of IPv6 addresses as defined in RFC1886 and deprecated in RFC4159. The default is to use IP6.ARPA as specified in RFC3596. -

+

+
-l
-

+

List zone: The host command performs a zone transfer of zone name and prints out the NS, PTR and address records (A/AAAA).

-

+

Together, the -l -a options print all records in the zone.

-
+
-N ndots
-

+

+

The number of dots that have to be in name for it to be considered absolute. The default value is that defined using the @@ -141,9 +189,11 @@ searched for in the domains listed in the search or domain directive in /etc/resolv.conf. -

+

+
-r
-

+

+

Non-recursive query: Setting this option clears the RD (recursion desired) bit in the query. This should mean that the name server @@ -154,28 +204,33 @@ name server by making non-recursive queries and expecting to receive answers to those queries that can be referrals to other name servers. -

+

+
-R number
-

+

+

Number of retries for UDP queries: If number is negative or zero, the number of retries will default to 1. The default value is 1. -

+

+
-s
-

+

+

Do not send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior. -

+

+
-t type
-

+

Query type: The type argument can be any recognized query type: CNAME, NS, SOA, TXT, DNSKEY, AXFR, etc.

-

+

When no query type is specified, host automatically selects an appropriate query type. By default, it looks for A, AAAA, and MX records. @@ -186,65 +241,78 @@ address, host will query for PTR records.

-

+

If a query type of IXFR is chosen the starting serial number can be specified by appending an equal followed by the starting serial number (like -t IXFR=12345678).

-
+
-T
-

+

+

TCP: By default, host uses UDP when making queries. The -T option makes it use a TCP connection when querying the name server. TCP will be automatically selected for queries that require it, such as zone transfer (AXFR) requests. -

+

+
-m flag
-

+

+

Memory usage debugging: the flag can be record, usage, or trace. You can specify the -m option more than once to set multiple flags. -

+

+
-v
-

+

+

Verbose output. Equivalent to the -d debug option. -

+

+
-V
-

+

+

Print the version number and exit. -

+

+
-w
-

+

+

Wait forever: The query timeout is set to the maximum possible. See also the -W option. -

+

+
-W wait
-

+

Timeout: Wait for up to wait seconds for a reply. If wait is less than one, the wait interval is set to one second.

-

+

By default, host will wait for 5 seconds for UDP responses and 10 seconds for TCP connections.

-

+

See also the -w option.

-
+
-
-
+ +
+ +

IDN SUPPORT

-

+ +

If host has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. host appropriately converts character encoding of @@ -255,18 +323,27 @@ The IDN support is disabled if the variable is set when host runs.

-
-
+
+ +

FILES

-

/etc/resolv.conf + +

/etc/resolv.conf

-
-
+
+ +

SEE ALSO

-

dig(1), - named(8). + +

+ dig(1) + , + + named(8) + .

-
+
+
diff --git a/doc/arm/man.isc-hmac-fixup.html b/doc/arm/man.isc-hmac-fixup.html index 3ca7b4ed79..52389d2d2b 100644 --- a/doc/arm/man.isc-hmac-fixup.html +++ b/doc/arm/man.isc-hmac-fixup.html @@ -41,17 +41,34 @@
-
+ + + + + +

Name

-

isc-hmac-fixup — fixes HMAC keys generated by older versions of BIND

-
-
-

Synopsis

-

isc-hmac-fixup {algorithm} {secret}

-
-
-

DESCRIPTION

+ isc-hmac-fixup + — fixes HMAC keys generated by older versions of BIND +

+
+ + + +
+

Synopsis

+

+ isc-hmac-fixup + {algorithm} + {secret} +

+
+ +
+

DESCRIPTION

+ +

Versions of BIND 9 up to and including BIND 9.6 had a bug causing HMAC-SHA* TSIG keys which were longer than the digest length of the hash algorithm (i.e., SHA1 keys longer than 160 bits, SHA256 keys @@ -59,13 +76,13 @@ message authentication code that was incompatible with other DNS implementations.

-

+

This bug has been fixed in BIND 9.7. However, the fix may cause incompatibility between older and newer versions of BIND, when using long keys. isc-hmac-fixup modifies those keys to restore compatibility.

-

+

To modify a key, run isc-hmac-fixup and specify the key's algorithm and secret on the command line. If the secret is longer than the digest length of the algorithm (64 bytes @@ -74,10 +91,12 @@ secret. (If the secret did not require conversion, then it will be printed without modification.)

-
-
+
+ +

SECURITY CONSIDERATIONS

-

+ +

Secrets that have been converted by isc-hmac-fixup are shortened, but as this is how the HMAC protocol works in operation anyway, it does not affect security. RFC 2104 notes, @@ -85,14 +104,17 @@ extra length would not significantly increase the function strength."

-
-
+
+ +

SEE ALSO

-

+ +

BIND 9 Administrator Reference Manual, RFC 2104.

-
+
+
diff --git a/doc/arm/man.lwresd.html b/doc/arm/man.lwresd.html index baebdb1016..83a06b6e20 100644 --- a/doc/arm/man.lwresd.html +++ b/doc/arm/man.lwresd.html @@ -41,24 +41,57 @@
-
+ + + + + +

Name

-

lwresd — lightweight resolver daemon

+

+ lwresd + — lightweight resolver daemon +

-
+ + + +

Synopsis

-

lwresd [-c config-file] [-C config-file] [-d debug-level] [-f] [-g] [-i pid-file] [-m flag] [-n #cpus] [-P port] [-p port] [-s] [-t directory] [-u user] [-v] [-4] [-6]

-
-
+

+ lwresd + [-c config-file] + [-C config-file] + [-d debug-level] + [-f] + [-g] + [-i pid-file] + [-m flag] + [-n #cpus] + [-P port] + [-p port] + [-s] + [-t directory] + [-u user] + [-v] + [-4] + [-6] +

+
+ +

DESCRIPTION

-

lwresd + + +

lwresd is the daemon providing name lookup services to clients that use the BIND 9 lightweight resolver library. It is essentially a stripped-down, caching-only name server that answers queries using the BIND 9 lightweight resolver protocol rather than the DNS protocol.

-

lwresd + +

lwresd listens for resolver queries on a UDP port on the IPv4 loopback interface, 127.0.0.1. This means that lwresd can only be used by @@ -66,14 +99,14 @@ number 921 is used for lightweight resolver requests and responses.

-

+

Incoming lightweight resolver requests are decoded by the server which then resolves them using the DNS protocol. When the DNS lookup completes, lwresd encodes the answers in the lightweight resolver format and returns them to the client that made the request.

-

+

If /etc/resolv.conf contains any nameserver entries, lwresd sends recursive DNS queries to those servers. This is similar @@ -83,60 +116,80 @@ queries autonomously starting at the root name servers, using a built-in list of root server hints.

-
-
+
+ +

OPTIONS

-
+ + +
-4
-

+

+

Use IPv4 only even if the host machine is capable of IPv6. -4 and -6 are mutually exclusive. -

+

+
-6
-

+

+

Use IPv6 only even if the host machine is capable of IPv4. -4 and -6 are mutually exclusive. -

+

+
-c config-file
-

+

+

Use config-file as the configuration file instead of the default, /etc/lwresd.conf. -c can not be used with -C. -

+

+
-C config-file
-

+

+

Use config-file as the configuration file instead of the default, /etc/resolv.conf. -C can not be used with -c. -

+

+
-d debug-level
-

+

+

Set the daemon's debug level to debug-level. Debugging traces from lwresd become more verbose as the debug level increases. -

+

+
-f
-

+

+

Run the server in the foreground (i.e. do not daemonize). -

+

+
-g
-

+

+

Run the server in the foreground and force all logging to stderr. -

+

+
-i pid-file
-

+

+

Use pid-file as the PID file instead of the default, /var/run/lwresd/lwresd.pid. -

+

+
-m flag
-

+

+

Turn on memory usage debugging flags. Possible flags are usage, trace, @@ -145,54 +198,61 @@ mctx. These correspond to the ISC_MEM_DEBUGXXXX flags described in <isc/mem.h>. -

+

+
-n #cpus
-

+

+

Create #cpus worker threads to take advantage of multiple CPUs. If not specified, lwresd will try to determine the number of CPUs present and create one thread per CPU. If it is unable to determine the number of CPUs, a single worker thread will be created. -

+

+
-P port
-

+

+

Listen for lightweight resolver queries on port port. If not specified, the default is port 921. -

+

+
-p port
-

+

+

Send DNS lookups to port port. If not specified, the default is port 53. This provides a way of testing the lightweight resolver daemon with a name server that listens for queries on a non-standard port number. -

+

+
-s
-

+

Write memory usage statistics to stdout on exit.

-
+

Note

-

+

This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.

-
-
+
+
-t directory
-

Chroot +

Chroot to directory after processing the command line arguments, but before reading the configuration file.

-
+

Warning

-

+

This option should be used in conjunction with the -u option, as chrooting a process running as root doesn't enhance security on most @@ -200,40 +260,62 @@ defined allows a process with root privileges to escape a chroot jail.

-
-
+
+
-u user
-

Setuid +

+

Setuid to user after completing privileged operations, such as creating sockets that listen on privileged ports. -

+

+
-v
-

+

+

Report the version number and exit. -

+

+
-
-
+ +
+ +

FILES

-
+ + +
/etc/resolv.conf
-

+

+

The default configuration file. -

+

+
/var/run/lwresd.pid
-

+

+

The default process-id file. -

+

+
-
-
+ +
+ +

SEE ALSO

-

named(8), - lwres(3), - resolver(5). + +

+ named(8) + , + + lwres(3) + , + + resolver(5) + .

-
+
+
diff --git a/doc/arm/man.named-checkconf.html b/doc/arm/man.named-checkconf.html index ec581fe03a..862d87e6fd 100644 --- a/doc/arm/man.named-checkconf.html +++ b/doc/arm/man.named-checkconf.html @@ -41,26 +41,45 @@
-
+ + + + + + + +

Name

-

named-checkconf — named configuration file syntax checking tool

+

+ named-checkconf + — named configuration file syntax checking tool +

-
+ +

Synopsis

-

named-checkconf [-hjvz] [-p +

+ named-checkconf + [-hjvz] + [-p [-x - ]] [-t directory] {filename}

-
-
+ ]] + [-t directory] + {filename} +

+
+ +

DESCRIPTION

-

named-checkconf + +

named-checkconf checks the syntax, but not the semantics, of a named configuration file. The file is parsed and checked for syntax errors, along with all files included by it. If no file is specified, /etc/named.conf is read by default.

-

+

Note: files that named reads in separate parser contexts, such as rndc.key and bind.keys, are not automatically read @@ -70,37 +89,50 @@ successful. named-checkconf can be run on these files explicitly, however.

-
-
+
+ +

OPTIONS

-
+ +
-h
-

+

+

Print the usage summary and exit. -

+

+
-j
-

+

+

When loading a zonefile read the journal if it exists. -

+

+
-p
-

+

+

Print out the named.conf and included files in canonical form if no errors were detected. See also the -x option. -

+

+
-t directory
-

+

+

Chroot to directory so that include directives in the configuration file are processed as if run by a similarly chrooted named. -

+

+
-v
-

+

+

Print the version of the named-checkconf program and exit. -

+

+
-x
-

+

+

When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks ('?'). This allows the @@ -108,33 +140,47 @@ files to be shared — for example, when submitting bug reports — without compromising private data. This option cannot be used without -p. -

+

+
-z
-

+

+

Perform a test load of all master zones found in named.conf. -

+

+
filename
-

+

+

The name of the configuration file to be checked. If not specified, it defaults to /etc/named.conf. -

+

+
-
-
+ +
+ +

RETURN VALUES

-

named-checkconf + +

named-checkconf returns an exit status of 1 if errors were detected and 0 otherwise.

-
-
+
+ +

SEE ALSO

-

named(8), - named-checkzone(8), + +

+ named(8) + , + + named-checkzone(8) + , BIND 9 Administrator Reference Manual.

-
+
diff --git a/doc/arm/man.named-checkzone.html b/doc/arm/man.named-checkzone.html index c103cb1a7a..69f3641d1e 100644 --- a/doc/arm/man.named-checkzone.html +++ b/doc/arm/man.named-checkzone.html @@ -41,24 +41,94 @@
-
+ + + + + + + +

Name

-

named-checkzone, named-compilezone — zone file validity checking or converting tool

+

+ named-checkzone, + named-compilezone + — zone file validity checking or converting tool +

-
+ +

Synopsis

-

named-checkzone [-d] [-h] [-j] [-q] [-v] [-c class] [-f format] [-F format] [-J filename] [-i mode] [-k mode] [-m mode] [-M mode] [-n mode] [-l ttl] [-L serial] [-o filename] [-r mode] [-s style] [-S mode] [-t directory] [-T mode] [-w directory] [-D] [-W mode] {zonename} {filename}

-

named-compilezone [-d] [-j] [-q] [-v] [-c class] [-C mode] [-f format] [-F format] [-J filename] [-i mode] [-k mode] [-m mode] [-n mode] [-l ttl] [-L serial] [-r mode] [-s style] [-t directory] [-T mode] [-w directory] [-D] [-W mode] {-o filename} {zonename} {filename}

-
-
+

+ named-checkzone + [-d] + [-h] + [-j] + [-q] + [-v] + [-c class] + [-f format] + [-F format] + [-J filename] + [-i mode] + [-k mode] + [-m mode] + [-M mode] + [-n mode] + [-l ttl] + [-L serial] + [-o filename] + [-r mode] + [-s style] + [-S mode] + [-t directory] + [-T mode] + [-w directory] + [-D] + [-W mode] + {zonename} + {filename} +

+

+ named-compilezone + [-d] + [-j] + [-q] + [-v] + [-c class] + [-C mode] + [-f format] + [-F format] + [-J filename] + [-i mode] + [-k mode] + [-m mode] + [-n mode] + [-l ttl] + [-L serial] + [-r mode] + [-s style] + [-t directory] + [-T mode] + [-w directory] + [-D] + [-W mode] + {-o filename} + {zonename} + {filename} +

+
+ +

DESCRIPTION

-

named-checkzone + +

named-checkzone checks the syntax and integrity of a zone file. It performs the same checks as named does when loading a zone. This makes named-checkzone useful for checking zone files before configuring them into a name server.

-

+

named-compilezone is similar to named-checkzone, but it always dumps the zone contents to a specified file in a specified format. @@ -69,45 +139,62 @@ least be as strict as those specified in the named configuration file.

-
-
+
+ +

OPTIONS

-
+ + +
-d
-

+

+

Enable debugging. -

+

+
-h
-

+

+

Print the usage summary and exit. -

+

+
-q
-

+

+

Quiet mode - exit code only. -

+

+
-v
-

+

+

Print the version of the named-checkzone program and exit. -

+

+
-j
-

+

+

When loading a zone file, read the journal if it exists. The journal file name is assumed to be the zone file name appended with the string .jnl. -

+

+
-J filename
-

+

+

When loading the zone file read the journal from the given file, if it exists. (Implies -j.) -

+

+
-c class
-

+

+

Specify the class of the zone. If not specified, "IN" is assumed. -

+

+
-i mode
-

+

Perform post-load zone integrity checks. Possible modes are "full" (default), "full-sibling", @@ -115,19 +202,19 @@ "local-sibling" and "none".

-

+

Mode "full" checks that MX records refer to A or AAAA record (both in-zone and out-of-zone hostnames). Mode "local" only checks MX records which refer to in-zone hostnames.

-

+

Mode "full" checks that SRV records refer to A or AAAA record (both in-zone and out-of-zone hostnames). Mode "local" only checks SRV records which refer to in-zone hostnames.

-

+

Mode "full" checks that delegation NS records refer to A or AAAA record (both in-zone and out-of-zone hostnames). It also checks that glue address records @@ -136,31 +223,33 @@ refer to in-zone hostnames or that some required glue exists, that is when the nameserver is in a child zone.

-

+

Mode "full-sibling" and "local-sibling" disable sibling glue checks but are otherwise the same as "full" and "local" respectively.

-

+

Mode "none" disables the checks.

-
+
-f format
-

+

+

Specify the format of the zone file. Possible formats are "text" (default), "raw", and "map". -

+

+
-F format
-

+

Specify the format of the output file specified. For named-checkzone, this does not cause any effects unless it dumps the zone contents.

-

+

Possible formats are "text" (default), which is the standard textual representation of the zone, and "map", "raw", @@ -171,9 +260,10 @@ any version of named; if N is 1, the file can be read by release 9.9.0 or higher; the default is 1.

-
+
-k mode
-

+

+

Perform "check-names" checks with the specified failure mode. Possible modes are "fail" @@ -181,38 +271,48 @@ "warn" (default for named-checkzone) and "ignore". -

+

+
-l ttl
-

+

+

Sets a maximum permissible TTL for the input file. Any record with a TTL higher than this value will cause the zone to be rejected. This is similar to using the max-zone-ttl option in named.conf. -

+

+
-L serial
-

+

+

When compiling a zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) -

+

+
-m mode
-

+

+

Specify whether MX records should be checked to see if they are addresses. Possible modes are "fail", "warn" (default) and "ignore". -

+

+
-M mode
-

+

+

Check if a MX record refers to a CNAME. Possible modes are "fail", "warn" (default) and "ignore". -

+

+
-n mode
-

+

+

Specify whether NS records should be checked to see if they are addresses. Possible modes are "fail" @@ -220,24 +320,30 @@ "warn" (default for named-checkzone) and "ignore". -

+

+
-o filename
-

+

+

Write zone output to filename. If filename is - then write to standard out. This is mandatory for named-compilezone. -

+

+
-r mode
-

+

+

Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS. Possible modes are "fail", "warn" (default) and "ignore". -

+

+
-s style
-

+

+

Specify the style of the dumped zone file. Possible styles are "full" (default) and "relative". @@ -250,75 +356,102 @@ contents. It also does not have any meaning if the output format is not text. -

+

+
-S mode
-

+

+

Check if a SRV record refers to a CNAME. Possible modes are "fail", "warn" (default) and "ignore". -

+

+
-t directory
-

+

+

Chroot to directory so that include directives in the configuration file are processed as if run by a similarly chrooted named. -

+

+
-T mode
-

+

+

Check if Sender Policy Framework (SPF) records exist and issues a warning if an SPF-formatted TXT record is not also present. Possible modes are "warn" (default), "ignore". -

+

+
-w directory
-

+

+

chdir to directory so that relative filenames in master file $INCLUDE directives work. This is similar to the directory clause in named.conf. -

+

+
-D
-

+

+

Dump zone file in canonical format. This is always enabled for named-compilezone. -

+

+
-W mode
-

+

+

Specify whether to check for non-terminal wildcards. Non-terminal wildcards are almost always the result of a failure to understand the wildcard matching algorithm (RFC 1034). Possible modes are "warn" (default) and "ignore". -

+

+
zonename
-

+

+

The domain name of the zone being checked. -

+

+
filename
-

+

+

The name of the zone file. -

+

+
-
-
+ +
+ +

RETURN VALUES

-

named-checkzone + +

named-checkzone returns an exit status of 1 if errors were detected and 0 otherwise.

-
-
+
+ +

SEE ALSO

-

named(8), - named-checkconf(8), + +

+ named(8) + , + + named-checkconf(8) + , RFC 1035, BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/doc/arm/man.named-journalprint.html b/doc/arm/man.named-journalprint.html index 97a75e4641..df9e6f8945 100644 --- a/doc/arm/man.named-journalprint.html +++ b/doc/arm/man.named-journalprint.html @@ -41,22 +41,38 @@
-
+ + + + + +

Name

-

named-journalprint — print zone journal in human-readable form

-
-
-

Synopsis

-

named-journalprint {journal}

-
-
-

DESCRIPTION

+ named-journalprint + — print zone journal in human-readable form +

+
+ + + +
+

Synopsis

+

+ named-journalprint + {journal} +

+
+ +
+

DESCRIPTION

+ +

named-journalprint prints the contents of a zone journal file in a human-readable form.

-

+

Journal files are automatically created by named when changes are made to dynamic zones (e.g., by nsupdate). They record each addition @@ -67,22 +83,29 @@ .jnl to the name of the corresponding zone file.

-

+

named-journalprint converts the contents of a given journal file into a human-readable text format. Each line begins with "add" or "del", to indicate whether the record was added or deleted, and continues with the resource record in master-file format.

-
-
+
+ +

SEE ALSO

-

- named(8), - nsupdate(8), + +

+ + named(8) + , + + nsupdate(8) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/doc/arm/man.named-rrchecker.html b/doc/arm/man.named-rrchecker.html index 616fa6b606..79fb3ebcea 100644 --- a/doc/arm/man.named-rrchecker.html +++ b/doc/arm/man.named-rrchecker.html @@ -41,50 +41,75 @@
-
+ + + +

Name

-

named-rrchecker — syntax checker for individual DNS resource records

+

+ named-rrchecker + — syntax checker for individual DNS resource records +

-
+ + + +

Synopsis

-

named-rrchecker [-h] [-o origin] [-p] [-u] [-C] [-T] [-P]

-
-
+

+ named-rrchecker + [-h] + [-o origin] + [-p] + [-u] + [-C] + [-T] + [-P] +

+
+ +

DESCRIPTION

-

named-rrchecker + +

named-rrchecker read a individual DNS resource record from standard input and checks if it is syntactically correct.

-

+

The -h prints out the help menu.

-

+

The -o origin option specifies a origin to be used when interpreting the record.

-

+

The -p prints out the resulting record in canonical form. If there is no canonical form defined then the record will be printed in unknown record format.

-

+

The -u prints out the resulting record in unknown record form.

-

+

The -C, -T and -P print out the known class, standard type and private type mnemonics respectively.

-
-
+
+ +

SEE ALSO

-

+ +

RFC 1034, RFC 1035, - named(8) + + named(8) +

-
+
+
diff --git a/doc/arm/man.named.conf.html b/doc/arm/man.named.conf.html index 0c7718ab61..548f71f10b 100644 --- a/doc/arm/man.named.conf.html +++ b/doc/arm/man.named.conf.html @@ -41,61 +41,84 @@
-
+ + + + + +

Name

-

named.conf — configuration file for named

+

+ named.conf + — configuration file for named +

-
+ + + +

Synopsis

-

named.conf

-
-
+

+ named.conf +

+
+ +

DESCRIPTION

-

named.conf is the configuration file + +

named.conf is the configuration file for named. Statements are enclosed in braces and terminated with a semi-colon. Clauses in the statements are also semi-colon terminated. The usual comment styles are supported:

-

+

C style: /* */

-

+

C++ style: // to end of line

-

+

Unix style: # to end of line

-
-
+
+ +

ACL

-


+ +


acl string { address_match_element; ... };

-
-
+
+ +

KEY

-


+ +


key domain_name {
algorithm string;
secret string;
};

-
-
+
+ +

MASTERS

-


+ +


masters string [ port integer ] {
( masters | ipv4_address [port integer] |
ipv6_address [port integer] ) [ key string ]; ...
};

-
-
+
+ +

SERVER

-


+ +


server ( ipv4_address[/prefixlen] | ipv6_address[/prefixlen] ) {
bogus boolean;
edns boolean;
@@ -115,26 +138,32 @@ server support-ixfr boolean; // obsolete
};

-
-
+
+ +

TRUSTED-KEYS

-


+ +


trusted-keys {
domain_name flags protocol algorithm key; ...
};

-
-
+
+ +

MANAGED-KEYS

-


+ +


managed-keys {
domain_name initial-key flags protocol algorithm key; ...
};

-
-
+
+ +

CONTROLS

-


+ +


controls {
inet ( ipv4_address | ipv6_address | * )
[ port ( integer | * ) ]
@@ -143,10 +172,12 @@ controls unix unsupported; // not implemented
};

-
-
+
+ +

LOGGING

-


+ +


logging {
channel string {
file log_file;
@@ -161,10 +192,12 @@ logging category string { string; ... };
};

-
-
+
+ +

LWRES

-


+ +


lwres {
listen-on [ port integer ] {
( ipv4_address | ipv6_address ) [ port integer ]; ...
@@ -174,10 +207,12 @@ lwres ndots integer;
};

-
-
+
+ +

OPTIONS

-


+ +


options {
avoid-v4-udp-ports { port; ... };
avoid-v6-udp-ports { port; ... };
@@ -383,10 +418,12 @@ options use-ixfr boolean; // obsolete
};

-
-
+
+ +

VIEW

-


+ +


view string optional_class {
match-clients { address_match_element; ... };
match-destinations { address_match_element; ... };
@@ -554,10 +591,12 @@ view max-ixfr-log-size size; // obsolete
};

-
-
+
+ +

ZONE

-


+ +


zone string optional_class {
type ( master | slave | stub | hint | redirect |
forward | delegation-only );
@@ -652,20 +691,31 @@ zone pubkey integer integer integer quoted_string; // obsolete
};

-
-
+
+ +

FILES

-

/etc/named.conf + +

/etc/named.conf

-
-
+
+ +

SEE ALSO

-

named(8), - named-checkconf(8), - rndc(8), + +

+ named(8) + , + + named-checkconf(8) + , + + rndc(8) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/doc/arm/man.named.html b/doc/arm/man.named.html index f7004c51c1..bf16016852 100644 --- a/doc/arm/man.named.html +++ b/doc/arm/man.named.html @@ -41,46 +41,89 @@
-
+ + + + + +

Name

-

named — Internet domain name server

+

+ named + — Internet domain name server +

-
+ + + +

Synopsis

-

named [-4] [-6] [-c config-file] [-d debug-level] [-D string] [-E engine-name] [-f] [-g] [-M option] [-m flag] [-n #cpus] [-p port] [-s] [-S #max-socks] [-t directory] [-U #listeners] [-u user] [-v] [-V] [-x cache-file]

-
-
+

+ named + [-4] + [-6] + [-c config-file] + [-d debug-level] + [-D string] + [-E engine-name] + [-f] + [-g] + [-M option] + [-m flag] + [-n #cpus] + [-p port] + [-s] + [-S #max-socks] + [-t directory] + [-U #listeners] + [-u user] + [-v] + [-V] + [-x cache-file] +

+
+ +

DESCRIPTION

-

named + +

named is a Domain Name System (DNS) server, part of the BIND 9 distribution from ISC. For more information on the DNS, see RFCs 1033, 1034, and 1035.

-

+

When invoked without arguments, named will read the default configuration file /etc/named.conf, read any initial data, and listen for queries.

-
-
+
+ +

OPTIONS

-
+ + +
-4
-

+

+

Use IPv4 only even if the host machine is capable of IPv6. -4 and -6 are mutually exclusive. -

+

+
-6
-

+

+

Use IPv6 only even if the host machine is capable of IPv4. -4 and -6 are mutually exclusive. -

+

+
-c config-file
-

+

+

Use config-file as the configuration file instead of the default, /etc/named.conf. To @@ -90,28 +133,33 @@ directory option in the configuration file, config-file should be an absolute pathname. -

+

+
-d debug-level
-

+

+

Set the daemon's debug level to debug-level. Debugging traces from named become more verbose as the debug level increases. -

+

+
-D string
-

+

+

Specifies a string that is used to identify a instance of named in a process listing. The contents of string are not examined. -

+

+
-E engine-name
-

+

When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing.

-

+

When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service @@ -119,26 +167,33 @@ (--enable-native-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "--with-pkcs11".

-
+
-f
-

+

+

Run the server in the foreground (i.e. do not daemonize). -

+

+
-g
-

+

+

Run the server in the foreground and force all logging to stderr. -

+

+
-M option
-

+

+

Sets the default memory context options. Currently the only supported option is external, which causes the internal memory manager to be bypassed in favor of system-provided memory allocation functions. -

+

+
-m flag
-

+

+

Turn on memory usage debugging flags. Possible flags are usage, trace, @@ -147,46 +202,51 @@ mctx. These correspond to the ISC_MEM_DEBUGXXXX flags described in <isc/mem.h>. -

+

+
-n #cpus
-

+

+

Create #cpus worker threads to take advantage of multiple CPUs. If not specified, named will try to determine the number of CPUs present and create one thread per CPU. If it is unable to determine the number of CPUs, a single worker thread will be created. -

+

+
-p port
-

+

+

Listen for queries on port port. If not specified, the default is port 53. -

+

+
-s
-

+

Write memory usage statistics to stdout on exit.

-
+

Note

-

+

This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.

-
-
+
+
-S #max-socks
-

+

Allow named to use up to #max-socks sockets. The default value is 4096 on systems built with default configuration options, and 21000 on systems built with "configure --with-tuning=large".

-
+

Warning

-

+

This option should be unnecessary for the vast majority of users. The use of this option could even be harmful because the @@ -201,18 +261,18 @@ named reserves some file descriptors for its internal use.

-
-
+
+
-t directory
-

Chroot +

Chroot to directory after processing the command line arguments, but before reading the configuration file.

-
+

Warning

-

+

This option should be used in conjunction with the -u option, as chrooting a process running as root doesn't enhance security on most @@ -220,10 +280,11 @@ defined allows a process with root privileges to escape a chroot jail.

-
-
+
+
-U #listeners
-

+

+

Use #listeners worker threads to listen for incoming UDP packets on each address. If not specified, named will @@ -236,17 +297,18 @@ be increased as high as that value, but no higher. On Windows, the number of UDP listeners is hardwired to 1 and this option has no effect. -

+

+
-u user
-

Setuid +

Setuid to user after completing privileged operations, such as creating sockets that listen on privileged ports.

-
+

Note

-

+

On Linux, named uses the kernel's capability mechanism to drop all root privileges except the ability to bind(2) to @@ -259,63 +321,80 @@ later, since previous kernels did not allow privileges to be retained after setuid(2).

-
-
+
+
-v
-

+

+

Report the version number and exit. -

+

+
-V
-

+

+

Report the version number and build options, and exit. -

+

+
-x cache-file
-

+

Load data from cache-file into the cache of the default view.

-
+

Warning

-

+

This option must not be used. It is only of interest to BIND 9 developers and may be removed or changed in a future release.

-
-
+
+
-
-
+ +
+ +

SIGNALS

-

+ +

In routine operation, signals should not be used to control the nameserver; rndc should be used instead.

-
+ +
SIGHUP
-

+

+

Force a reload of the server. -

+

+
SIGINT, SIGTERM
-

+

+

Shut down the server. -

+

+
-

+ +

The result of sending any other signals to the server is undefined.

-
-
+ +
+ +

CONFIGURATION

-

+ +

The named configuration file is too complex to describe in detail here. A complete description is provided in the BIND 9 Administrator Reference Manual.

-

+ +

named inherits the umask (file creation mode mask) from the parent process. If files created by named, such as journal files, @@ -323,33 +402,60 @@ should be set explicitly in the script used to start the named process.

-
-
+ +
+ +

FILES

-
+ + +
/etc/named.conf
-

+

+

The default configuration file. -

+

+
/var/run/named/named.pid
-

+

+

The default process-id file. -

+

+
-
-
+ +
+ +

SEE ALSO

-

RFC 1033, + +

RFC 1033, RFC 1034, RFC 1035, - named-checkconf(8), - named-checkzone(8), - rndc(8), - lwresd(8), - named.conf(5), + + named-checkconf + (8) + , + + named-checkzone + (8) + , + + rndc + (8) + , + + lwresd + (8) + , + + named.conf + (5) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/doc/arm/man.nsec3hash.html b/doc/arm/man.nsec3hash.html index ce3af71f8f..dad3d8d220 100644 --- a/doc/arm/man.nsec3hash.html +++ b/doc/arm/man.nsec3hash.html @@ -39,53 +39,85 @@
-
+ + + + + +

Name

-

nsec3hash — generate NSEC3 hash

-
-
-

Synopsis

-

nsec3hash {salt} {algorithm} {iterations} {domain}

-
-
-

DESCRIPTION

+ nsec3hash + — generate NSEC3 hash +

+
+ + + +
+

Synopsis

+

+ nsec3hash + {salt} + {algorithm} + {iterations} + {domain} +

+
+ +
+

DESCRIPTION

+ +

nsec3hash generates an NSEC3 hash based on a set of NSEC3 parameters. This can be used to check the validity of NSEC3 records in a signed zone.

-
-
+
+ +

ARGUMENTS

-
+ +
salt
-

+

+

The salt provided to the hash algorithm. -

+

+
algorithm
-

+

+

A number indicating the hash algorithm. Currently the only supported hash algorithm for NSEC3 is SHA-1, which is indicated by the number 1; consequently "1" is the only useful value for this argument. -

+

+
iterations
-

+

+

The number of additional times the hash should be performed. -

+

+
domain
-

+

+

The domain name to be hashed. -

+

+
-
-
+
+ +

SEE ALSO

-

+ +

BIND 9 Administrator Reference Manual, RFC 5155.

-
+
+
diff --git a/doc/arm/man.nsupdate.html b/doc/arm/man.nsupdate.html index 52c31279d1..d97396e727 100644 --- a/doc/arm/man.nsupdate.html +++ b/doc/arm/man.nsupdate.html @@ -41,17 +41,49 @@
-
+ + + +

Name

-

nsupdate — Dynamic DNS update utility

+

+ nsupdate + — Dynamic DNS update utility +

-
+ + + +

Synopsis

-

nsupdate [-d] [-D] [-L level] [[-g] | [-o] | [-l] | [-y [hmac:]keyname:secret] | [-k keyfile]] [-t timeout] [-u udptimeout] [-r udpretries] [-R randomdev] [-v] [-T] [-P] [-V] [filename]

-
-
+

+ nsupdate + [-d] + [-D] + [-L level] + [ + [-g] + | [-o] + | [-l] + | [-y [hmac:]keyname:secret] + | [-k keyfile] + ] + [-t timeout] + [-u udptimeout] + [-r udpretries] + [-R randomdev] + [-v] + [-T] + [-P] + [-V] + [filename] +

+
+ +

DESCRIPTION

-

nsupdate + +

nsupdate is used to submit Dynamic DNS Update requests as defined in RFC 2136 to a name server. This allows resource records to be added or removed from a zone @@ -60,27 +92,27 @@ one resource record.

-

+

Zones that are under dynamic control via nsupdate or a DHCP server should not be edited by hand. Manual edits could conflict with dynamic updates and cause data to be lost.

-

+

The resource records that are dynamically added or removed with nsupdate have to be in the same zone. Requests are sent to the zone's master server. This is identified by the MNAME field of the zone's SOA record.

-

+

Transaction signatures can be used to authenticate the Dynamic DNS updates. These use the TSIG resource record type described in RFC 2845 or the SIG(0) record described in RFC 2535 and RFC 2931 or GSS-TSIG as described in RFC 3645.

-

+

TSIG relies on a shared secret that should only be known to nsupdate and the name server. @@ -95,33 +127,41 @@ uses the -y or -k options to provide the TSIG shared secret. These options are mutually exclusive.

-

+

SIG(0) uses public key cryptography. To use a SIG(0) key, the public key must be stored in a KEY record in a zone served by the name server.

-

+

GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode is switched on with the -g flag. A non-standards-compliant variant of GSS-TSIG used by Windows 2000 can be switched on with the -o flag.

-
-
+
+ +

OPTIONS

-
+ + +
-d
-

+

+

Debug mode. This provides tracing information about the update requests that are made and the replies received from the name server. -

+

+
-D
-

+

+

Extra debug mode. -

+

+
-k keyfile
-

+

+

The file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing a named.conf-format key @@ -133,9 +173,11 @@ The -k may also be used to specify a SIG(0) key used to authenticate Dynamic DNS update requests. In this case, the key specified is not an HMAC-MD5 key. -

+

+
-l
-

+

+

Local-host only mode. This sets the server address to localhost (disabling the server so that the server address cannot be overridden). Connections to the local server will @@ -144,30 +186,40 @@ local master zone has set update-policy to local. The location of this key file can be overridden with the -k option. -

+

+
-L level
-

+

+

Set the logging debug level. If zero, logging is disabled. -

+

+
-p port
-

+

+

Set the port to use for connections to a name server. The default is 53. -

+

+
-P
-

+

+

Print the list of private BIND-specific resource record types whose format is understood by nsupdate. See also the -T option. -

+

+
-r udpretries
-

+

+

The number of UDP retries. The default is 3. If zero, only one update request will be made. -

+

+
-R randomdev
-

+

+

Where to obtain randomness. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness is keyboard @@ -176,51 +228,60 @@ instead of the default. The special value keyboard indicates that keyboard input should be used. This option may be specified multiple times. -

+

+
-t timeout
-

+

+

The maximum time an update request can take before it is aborted. The default is 300 seconds. Zero can be used to disable the timeout. -

+

+
-T
-

+

Print the list of IANA standard resource record types whose format is understood by nsupdate. nsupdate will exit after the lists are printed. The -T option can be combined with the -P option.

-

+

Other types can be entered using "TYPEXXXXX" where "XXXXX" is the decimal value of the type with no leading zeros. The rdata, if present, will be parsed using the UNKNOWN rdata format, (<backslash> <hash> <space> <length> <space> <hexstring>).

-
+
-u udptimeout
-

+

+

The UDP retry interval. The default is 3 seconds. If zero, the interval will be computed from the timeout interval and number of UDP retries. -

+

+
-v
-

+

+

Use TCP even for small update requests. By default, nsupdate uses UDP to send update requests to the name server unless they are too large to fit in a UDP request in which case TCP will be used. TCP may be preferable when a batch of update requests is made. -

+

+
-V
-

+

+

Print the version number and exit. -

+

+
-y [hmac:]keyname:secret
-

+

Literal TSIG authentication key. keyname is the name of the key, and secret is the base64 encoded shared secret. @@ -232,19 +293,23 @@ is not specified, the default is hmac-md5 or if MD5 was disabled hmac-sha256.

-

+

NOTE: Use of the -y option is discouraged because the shared secret is supplied as a command line argument in clear text. This may be visible in the output from - ps(1) + + ps(1) + or in a history file maintained by the user's shell.

-
+
-
-
+
+ +

INPUT FORMAT

-

nsupdate + +

nsupdate reads input from filename or standard input. @@ -258,7 +323,7 @@ Updates will be rejected if the tests for the prerequisite conditions fail.

-

+

Every update request consists of zero or more prerequisites and zero or more updates. This allows a suitably authenticated update request to proceed if some @@ -268,7 +333,7 @@ accumulated commands to be sent as one Dynamic DNS update request to the name server.

-

+

The command formats and their meaning are as follows:

@@ -277,7 +342,8 @@ {servername} [port] -

+

+

Sends all dynamic update requests to the name server servername. When no server statement is provided, @@ -293,13 +359,15 @@ If no port number is specified, the default DNS port number of 53 is used. -

+

+
local {address} [port]
-

+

+

Sends all dynamic update requests using the local address. @@ -311,12 +379,14 @@ can additionally be used to make requests come from a specific port. If no port number is specified, the system will assign one. -

+

+
zone {zonename}
-

+

+

Specifies that all updates are to be made to the zone zonename. If no @@ -325,32 +395,38 @@ nsupdate will attempt determine the correct zone to update based on the rest of the input. -

+

+
class {classname}
-

+

+

Specify the default class. If no class is specified, the default class is IN. -

+

+
ttl {seconds}
-

+

+

Specify the default time to live for records to be added. The value none will clear the default ttl. -

+

+
key [hmac:] {keyname} {secret}
-

+

+

Specifies that all updates are to be TSIG-signed using the keyname secret pair. If hmac is specified, then it sets the @@ -359,55 +435,67 @@ hmac-sha256. The key command overrides any key specified on the command line via -y or -k. -

+

+
gsstsig
-

+

+

Use GSS-TSIG to sign the updated. This is equivalent to specifying -g on the commandline. -

+

+
oldgsstsig
-

+

+

Use the Windows 2000 version of GSS-TSIG to sign the updated. This is equivalent to specifying -o on the commandline. -

+

+
realm {[realm_name]}
-

+

+

When using GSS-TSIG use realm_name rather than the default realm in krb5.conf. If no realm is specified the saved realm is cleared. -

+

+
[prereq] nxdomain {domain-name}
-

+

+

Requires that no resource record of any type exists with name domain-name. -

+

+
[prereq] yxdomain {domain-name}
-

+

+

Requires that domain-name exists (has as at least one resource record, of any type). -

+

+
[prereq] nxrrset {domain-name} [class] {type}
-

+

+

Requires that no resource record exists of the specified type, class @@ -416,14 +504,16 @@ If class is omitted, IN (internet) is assumed. -

+

+
[prereq] yxrrset {domain-name} [class] {type}
-

+

+

This requires that a resource record of the specified type, class @@ -433,7 +523,8 @@ If class is omitted, IN (internet) is assumed. -

+

+
[prereq] yxrrset {domain-name} @@ -441,7 +532,8 @@ {type} {data...}
-

+

+

The data from each set of prerequisites of this form @@ -462,7 +554,8 @@ are written in the standard text representation of the resource record's RDATA. -

+

+
[update] del[ete] {domain-name} @@ -470,7 +563,8 @@ [class] [type [data...]]
-

+

+

Deletes any resource records named domain-name. If @@ -483,7 +577,8 @@ is not supplied. The ttl is ignored, and is only allowed for compatibility. -

+

+
[update] add {domain-name} @@ -492,62 +587,80 @@ {type} {data...}
-

+

+

Adds a new resource record with the specified ttl, class and data. -

+

+
show
-

+

+

Displays the current message, containing all of the prerequisites and updates specified since the last send. -

+

+
send
-

+

+

Sends the current message. This is equivalent to entering a blank line. -

+

+
answer
-

+

+

Displays the answer. -

+

+
debug
-

+

+

Turn on debugging. -

+

+
version
-

+

+

Print version number. -

+

+
help
-

+

+

Print a list of commands. -

+

+

-

+ +

Lines beginning with a semicolon are comments and are ignored.

-
-
+ +
+ +

EXAMPLES

-

+ +

The examples below show how nsupdate could be used to insert and delete resource records from the @@ -568,7 +681,7 @@

-

+

Any A records for oldhost.example.com are deleted. @@ -585,7 +698,7 @@

-

+

The prerequisite condition gets the name server to check that there are no resource records of any type for nickname.example.com. @@ -598,33 +711,50 @@ (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have RRSIG, DNSKEY and NSEC records.)

-
-
+
+ +

FILES

-
+ + +
/etc/resolv.conf
-

+

+

used to identify default name server -

+

+
/var/run/named/session.key
-

+

+

sets the default TSIG key for use in local-only mode -

+

+
K{name}.+157.+{random}.key
-

+

+

base-64 encoding of HMAC-MD5 key created by - dnssec-keygen(8). -

+ + dnssec-keygen(8) + . +

+
K{name}.+157.+{random}.private
-

+

+

base-64 encoding of HMAC-MD5 key created by - dnssec-keygen(8). -

+ + dnssec-keygen(8) + . +

+
-
-
+
+ +

SEE ALSO

-

+ +

RFC 2136, RFC 3007, RFC 2104, @@ -632,20 +762,28 @@ RFC 1034, RFC 2535, RFC 2931, - named(8), - ddns-confgen(8), - dnssec-keygen(8). + + named(8) + , + + ddns-confgen(8) + , + + dnssec-keygen(8) + .

-
-
+
+ +

BUGS

-

+ +

The TSIG key is redundantly stored in two separate files. This is a consequence of nsupdate using the DST library for its cryptographic operations, and may change in future releases.

-
+
diff --git a/doc/arm/man.rndc-confgen.html b/doc/arm/man.rndc-confgen.html index b372053251..0426cf0349 100644 --- a/doc/arm/man.rndc-confgen.html +++ b/doc/arm/man.rndc-confgen.html @@ -41,17 +41,43 @@
-
+ + + + + +

Name

-

rndc-confgen — rndc key generation tool

+

+ rndc-confgen + — rndc key generation tool +

-
+ + + +

Synopsis

-

rndc-confgen [-a] [-A algorithm] [-b keysize] [-c keyfile] [-h] [-k keyname] [-p port] [-r randomfile] [-s address] [-t chrootdir] [-u user]

-
-
+

+ rndc-confgen + [-a] + [-A algorithm] + [-b keysize] + [-c keyfile] + [-h] + [-k keyname] + [-p port] + [-r randomfile] + [-s address] + [-t chrootdir] + [-u user] +

+
+ +

DESCRIPTION

-

rndc-confgen + +

rndc-confgen generates configuration files for rndc. It can be used as a convenient alternative to writing the @@ -64,13 +90,17 @@ avoid the need for a rndc.conf file and a controls statement altogether.

-
-
+ +
+ +

OPTIONS

-
+ + +
-a
-

+

Do automatic rndc configuration. This creates a file rndc.key in /etc (or whatever @@ -85,7 +115,7 @@ named on the local host with no further configuration.

-

+

Running rndc-confgen -a allows BIND 9 and rndc to be used as drop-in @@ -93,7 +123,7 @@ with no changes to the existing BIND 8 named.conf file.

-

+

If a more elaborate configuration than that generated by rndc-confgen -a is required, for example if rndc is to be used remotely, @@ -104,44 +134,57 @@ named.conf as directed.

-
+
-A algorithm
-

+

+

Specifies the algorithm to use for the TSIG key. Available choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384 and hmac-sha512. The default is hmac-md5 or if MD5 was disabled hmac-sha256. -

+

+
-b keysize
-

+

+

Specifies the size of the authentication key in bits. Must be between 1 and 512 bits; the default is the hash size. -

+

+
-c keyfile
-

+

+

Used with the -a option to specify an alternate location for rndc.key. -

+

+
-h
-

+

+

Prints a short summary of the options and arguments to rndc-confgen. -

+

+
-k keyname
-

+

+

Specifies the key name of the rndc authentication key. This must be a valid domain name. The default is rndc-key. -

+

+
-p port
-

+

+

Specifies the command channel port where named listens for connections from rndc. The default is 953. -

+

+
-r randomfile
-

+

+

Specifies a source of random data for generating the authorization. If the operating system does not provide a /dev/random @@ -152,24 +195,30 @@ data to be used instead of the default. The special value keyboard indicates that keyboard input should be used. -

+

+
-s address
-

+

+

Specifies the IP address where named listens for command channel connections from rndc. The default is the loopback address 127.0.0.1. -

+

+
-t chrootdir
-

+

+

Used with the -a option to specify a directory where named will run chrooted. An additional copy of the rndc.key will be written relative to this directory so that it will be found by the chrooted named. -

+

+
-u user
-

+

+

Used with the -a option to set the owner of the rndc.key file generated. @@ -177,34 +226,46 @@ -t is also specified only the file in the chroot area has its owner changed. -

+

+
-
-
+
+ +

EXAMPLES

-

+ +

To allow rndc to be used with no manual configuration, run

-

rndc-confgen -a +

rndc-confgen -a

-

+

To print a sample rndc.conf file and corresponding controls and key statements to be manually inserted into named.conf, run

-

rndc-confgen +

rndc-confgen

-
-
+
+ +

SEE ALSO

-

rndc(8), - rndc.conf(5), - named(8), + +

+ rndc(8) + , + + rndc.conf(5) + , + + named(8) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/doc/arm/man.rndc.conf.html b/doc/arm/man.rndc.conf.html index 99e7e06acb..6bfdc87c57 100644 --- a/doc/arm/man.rndc.conf.html +++ b/doc/arm/man.rndc.conf.html @@ -41,17 +41,32 @@
-
+ + + + + +

Name

-

rndc.conf — rndc configuration file

+

+ rndc.conf + — rndc configuration file +

-
+ + + +

Synopsis

-

rndc.conf

-
-
+

+ rndc.conf +

+
+ +

DESCRIPTION

-

rndc.conf is the configuration file + +

rndc.conf is the configuration file for rndc, the BIND 9 name server control utility. This file has a similar structure and syntax to named.conf. Statements are enclosed @@ -59,21 +74,21 @@ the statements are also semi-colon terminated. The usual comment styles are supported:

-

+

C style: /* */

-

+

C++ style: // to end of line

-

+

Unix style: # to end of line

-

rndc.conf is much simpler than +

rndc.conf is much simpler than named.conf. The file uses three statements: an options statement, a server statement and a key statement.

-

+

The options statement contains five clauses. The default-server clause is followed by the name or address of a name server. This host will be used when @@ -96,7 +111,7 @@ can be used to set the IPv4 and IPv6 source addresses respectively.

-

+

After the server keyword, the server statement includes a string which is the hostname or address for a name server. The statement has three possible clauses: @@ -110,7 +125,7 @@ of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively.

-

+

The key statement begins with an identifying string, the name of the key. The statement has two clauses. algorithm identifies the authentication algorithm @@ -121,7 +136,7 @@ the base-64 encoding of the algorithm's authentication key. The base-64 string is enclosed in double quotes.

-

+

There are two common ways to generate the base-64 string for the secret. The BIND 9 program rndc-confgen can @@ -134,10 +149,13 @@ ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each.

-
-
+
+ +

EXAMPLE

-
+
+
+    
       options {
         default-server  localhost;
         default-key     samplekey;
@@ -145,14 +163,14 @@
 

 

     

-
+    
       server localhost {
         key             samplekey;
       };
 

 

     

-
+    
       server testserver {
         key		testkey;
         addresses	{ localhost port 5353; };
@@ -160,7 +178,7 @@
 

 

     

-
+    
       key samplekey {
         algorithm       hmac-sha256;
         secret          "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
@@ -168,7 +186,7 @@
 

 

     

-
+    
       key testkey {
         algorithm	hmac-sha256;
         secret		"R3HI8P6BKw9ZwXwN3VZKuQ==";
@@ -176,7 +194,8 @@
     

 

     

-

+
+    

       In the above example, rndc will by
       default use
       the server at localhost (127.0.0.1) and the key called samplekey.
@@ -186,16 +205,16 @@
       uses the HMAC-SHA256 algorithm and its secret clause contains the
       base-64 encoding of the HMAC-SHA256 secret enclosed in double quotes.
     

-

+    

       If rndc -s testserver is used then rndc will
       connect to server on localhost port 5353 using the key testkey.
     

-

+    

       To generate a random secret with rndc-confgen:
     

-
rndc-confgen
+    
rndc-confgen
     

-

+    

       A complete rndc.conf file, including
       the
       randomly generated key, will be written to the standard
@@ -203,30 +222,41 @@
       controls statements for
       named.conf are also printed.
     

-

+    

       To generate a base-64 secret with mmencode:
     

-
echo "known plaintext for a secret" | mmencode
+    
echo "known plaintext for a secret" | mmencode
     

-
-
+
+ +

NAME SERVER CONFIGURATION

-

+ +

The name server must be configured to accept rndc connections and to recognize the key specified in the rndc.conf file, using the controls statement in named.conf. See the sections on the controls statement in the BIND 9 Administrator Reference Manual for details.

-
-
+
+ +

SEE ALSO

-

rndc(8), - rndc-confgen(8), - mmencode(1), + +

+ rndc(8) + , + + rndc-confgen(8) + , + + mmencode(1) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/doc/arm/man.rndc.html b/doc/arm/man.rndc.html index 5f0c26d0cc..5b748942fd 100644 --- a/doc/arm/man.rndc.html +++ b/doc/arm/man.rndc.html @@ -41,17 +41,41 @@
-
+ + + + + +

Name

-

rndc — name server control utility

+

+ rndc + — name server control utility +

-
+ + + +

Synopsis

-

rndc [-b source-address] [-c config-file] [-k key-file] [-s server] [-p port] [-q] [-V] [-y key_id] {command}

-
-
+

+ rndc + [-b source-address] + [-c config-file] + [-k key-file] + [-s server] + [-p port] + [-q] + [-V] + [-y key_id] + {command} +

+
+ +

DESCRIPTION

-

rndc + +

rndc controls the operation of a name server. It supersedes the ndc utility that was provided in old BIND releases. If @@ -60,7 +84,7 @@ supported commands and the available options and their arguments.

-

rndc +

rndc communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of @@ -74,30 +98,38 @@ over the channel must be signed by a key_id known to the server.

-

rndc +

rndc reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use.

-
-
+
+ +

OPTIONS

-
+ + +
-b source-address
-

+

+

Use source-address as the source address for the connection to the server. Multiple instances are permitted to allow setting of both the IPv4 and IPv6 source addresses. -

+

+
-c config-file
-

+

+

Use config-file as the configuration file instead of the default, /etc/rndc.conf. -

+

+
-k key-file
-

+

+

Use key-file as the key file instead of the default, /etc/rndc.key. The key in @@ -105,34 +137,44 @@ authenticate commands sent to the server if the config-file does not exist. -

+

+
-s server
-

server is +

+

server is the name or address of the server which matches a server statement in the configuration file for rndc. If no server is supplied on the command line, the host named by the default-server clause in the options statement of the rndc configuration file will be used. -

+

+
-p port
-

+

+

Send commands to TCP port port instead of BIND 9's default control channel port, 953. -

+

+
-q
-

+

+

Quiet mode: Message text returned by the server will not be printed except when there is an error. -

+

+
-V
-

+

+

Enable verbose logging. -

+

+
-y key_id
-

+

+

Use the key key_id from the configuration file. key_id @@ -148,22 +190,26 @@ which are used to send authenticated control commands to name servers. It should therefore not have general read or write access. -

+

+
-
-
+
+ +

COMMANDS

-

+ +

A list of commands supported by rndc can be seen by running rndc without arguments.

-

+

Currently supported commands are:

-
+ +
addzone zone [class [view]] configuration
-

+

Add a zone while the server is running. This command requires the allow-new-zones option to be set @@ -173,7 +219,7 @@ configuration text that would ordinarily be placed in named.conf.

-

+

The configuration is saved in a file called hash.nzf, where hash is a @@ -183,31 +229,31 @@ configuration, so that zones that were added can persist after a restart.

-

+

This sample addzone command would add the zone example.com to the default view:

-

+

$ rndc addzone example.com '{ type master; file "example.com.db"; };'

-

+

(Note the brackets and semi-colon around the zone configuration text.)

-

+

See also rndc delzone.

-
+
delzone [-clean] zone [class [view]]
-

+

Delete a zone while the server is running. Only zones that were originally added via rndc addzone can be deleted in this manner.

-

+

If the -clean is specified, the zone's master file (and journal file, if any) will be deleted along with the zone. Without the @@ -217,12 +263,13 @@ be cleaned up will be reported in the output of the rndc delzone command.)

-

+

See also rndc addzone.

-
+
dumpdb [-all|-cache|-zone|-adb|-bad] [view ...]
-

+

+

Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is @@ -230,26 +277,33 @@ views are dumped. (See the dump-file option in the BIND 9 Administrator Reference Manual.) -

+

+
flush
-

+

+

Flushes the server's cache. -

+

+
flushname name [view]
-

+

+

Flushes the given name from the server's DNS cache and, if applicable, from the server's nameserver address database or bad-server cache. -

+

+
flushtree name [view]
-

+

+

Flushes the given name, and all of its subdomains, from the server's DNS cache, the address database, and the bad server cache. -

+

+
freeze [zone [class [view]]]
-

+

Suspend updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by @@ -258,13 +312,13 @@ All dynamic update attempts will be refused while the zone is frozen.

-

+

See also rndc thaw.

-
+
halt [-p]
-

+

Stop the server immediately. Recent changes made through dynamic update or IXFR are not saved to the master files, but will be rolled forward from the @@ -273,13 +327,13 @@ This allows an external process to determine when named had completed halting.

-

+

See also rndc stop.

-
+
loadkeys zone [class [view]]
-

+

Fetch all DNSSEC keys for the given zone from the key directory. If they are within their publication period, merge them into the @@ -288,7 +342,7 @@ immediately re-signed by the new keys, but is allowed to incrementally re-sign over time.

-

+

This command requires that the auto-dnssec zone option be set to maintain, @@ -297,31 +351,33 @@ (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)

-

+

See also rndc loadkeys.

-
+
notify zone [class [view]]
-

+

+

Resend NOTIFY messages for the zone. -

+

+
notrace
-

+

Sets the server's debugging level to 0.

-

+

See also rndc trace.

-
+
querylog [on|off]
-

+

Enable or disable query logging. (For backward compatibility, this command can also be used without an argument to toggle query logging on and off.)

-

+

Query logging can also be enabled by explicitly directing the queries category to a @@ -332,9 +388,10 @@ options section of named.conf.

-
+
reconfig
-

+

+

Reload the configuration file and load new zones, but do not reload existing zone files even if they have changed. @@ -342,34 +399,43 @@ is a large number of zones because it avoids the need to examine the modification times of the zones files. -

+

+
recursing
-

+

+

Dump the list of queries named is currently recursing on, and the list of domains to which iterative queries are currently being sent. (The second list includes the number of fetches currently active for the given domain, and how many have been passed or dropped because of the fetches-per-zone option.) -

+

+
refresh zone [class [view]]
-

+

+

Schedule zone maintenance for the given zone. -

+

+
reload
-

+

+

Reload configuration file and zones. -

+

+
reload zone [class [view]]
-

+

+

Reload the given zone. -

+

+
retransfer zone [class [view]]
-

+

Retransfer the given slave zone from the master server.

-

+

If the zone is configured to use inline-signing, the signed version of the zone is discarded; after the @@ -377,24 +443,28 @@ signed version will be regenerated with all new signatures.

-
+
scan
-

+

+

Scan the list of available network interfaces for changes, without performing a full reconfig or waiting for the interface-interval timer. -

+

+
secroots [view ...]
-

+

+

Dump the server's security roots to the secroots file for the specified views. If no view is specified, security roots for all views are dumped. -

+

+
sign zone [class [view]]
-

+

Fetch all DNSSEC keys for the given zone from the key directory (see the key-directory option in @@ -404,7 +474,7 @@ is changed, then the zone is automatically re-signed with the new key set.

-

+

This command requires that the auto-dnssec zone option be set to allow or @@ -414,13 +484,13 @@ (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)

-

+

See also rndc loadkeys.

-
+
signing [( -list | -clear keyid/algorithm | -clear all | -nsec3param ( parameters | none ) ) ] zone [class [view]]
-

+

List, edit, or remove the DNSSEC signing state records for the specified zone. The status of ongoing DNSSEC operations (such as signing or generating @@ -433,7 +503,7 @@ or have finished signing the zone, and which NSEC3 chains are being created or removed.

-

+

rndc signing -clear can remove a single key (specified in the same format that rndc signing -list uses to @@ -442,7 +512,7 @@ that a key has not yet finished signing the zone will be retained.

-

+

rndc signing -nsec3param sets the NSEC3 parameters for a zone. This is the only supported mechanism for using NSEC3 with @@ -451,7 +521,7 @@ an NSEC3PARAM resource record: hash algorithm, flags, iterations, and salt, in that order.

-

+

Currently, the only defined value for hash algorithm is 1, representing SHA-1. The flags may be set to @@ -466,7 +536,7 @@ which causes named to generate a random 64-bit salt.

-

+

So, for example, to create an NSEC3 chain using the SHA-1 hash algorithm, no opt-out flag, 10 iterations, and a salt value of "FFFF", use: @@ -475,29 +545,33 @@ salt, use: rndc signing -nsec3param 1 1 15 - zone.

-

+

rndc signing -nsec3param none removes an existing NSEC3 chain and replaces it with NSEC.

-
+
stats
-

+

+

Write server statistics to the statistics file. (See the statistics-file option in the BIND 9 Administrator Reference Manual.) -

+

+
status
-

+

+

Display status of the server. Note that the number of zones includes the internal bind/CH zone and the default ./IN hint zone if there is not an explicit root zone configured. -

+

+
stop [-p]
-

+

Stop the server, making sure any recent changes made through dynamic update or IXFR are first saved to the master files of the updated zones. @@ -505,18 +579,20 @@ This allows an external process to determine when named had completed stopping.

-

See also rndc halt.

-
+

See also rndc halt.

+
sync [-clean] [zone [class [view]]]
-

+

+

Sync changes in the journal file for a dynamic zone to the master file. If the "-clean" option is specified, the journal file is also removed. If no zone is specified, then all zones are synced. -

+

+
thaw [zone [class [view]]]
-

+

Enable updates to a frozen dynamic zone. If no zone is specified, then all frozen zones are enabled. This causes the server to reload the zone @@ -530,46 +606,55 @@ zone has changed, any existing journal file will be removed.

-

See also rndc freeze.

-
+

See also rndc freeze.

+
trace
-

+

+

Increment the servers debugging level by one. -

+

+
trace level
-

+

Sets the server's debugging level to an explicit value.

-

+

See also rndc notrace.

-
+
tsig-delete keyname [view]
-

+

+

Delete a given TKEY-negotiated key from the server. (This does not apply to statically configured TSIG keys.) -

+

+
tsig-list
-

+

+

List the names of all TSIG keys currently configured for use by named in each view. The list both statically configured keys and dynamic TKEY-negotiated keys. -

+

+
validation ( on | off | check ) [view ...]
-

+

+

Enable, disable, or check the current status of DNSSEC validation. Note dnssec-enable also needs to be set to yes or auto to be effective. It defaults to enabled. -

+

+
zonestatus zone [class [view]]
-

+

+

Displays the current status of the given zone, including the master file name and any include files from which it was loaded, when it was most @@ -579,29 +664,45 @@ signed, whether it uses automatic DNSSEC key management or inline signing, and the scheduled refresh or expiry times for the zone. -

+

+
-
-
+
+ +

LIMITATIONS

-

+ +

There is currently no way to provide the shared secret for a key_id without using the configuration file.

-

+

Several error messages could be clearer.

-
-
+
+ +

SEE ALSO

-

rndc.conf(5), - rndc-confgen(8), - named(8), - named.conf(5), - ndc(8), + +

+ rndc.conf(5) + , + + rndc-confgen(8) + , + + named(8) + , + + named.conf(5) + , + + ndc(8) + , BIND 9 Administrator Reference Manual.

-
+
+
diff --git a/doc/arm/notes.html b/doc/arm/notes.html index cdac8bc46d..c781b9ac40 100644 --- a/doc/arm/notes.html +++ b/doc/arm/notes.html @@ -19,106 +19,138 @@ -
+
+ +

Release Notes for BIND Version 9.10.4

-
+ +

Introduction

-

+

This document summarizes significant changes since the last production release of BIND on the corresponding major release branch. Please see the CHANGES file for a further list of bug fixes and other changes.

-
-
+
+ +

Download

-

+

The latest versions of BIND 9 software can always be found at http://www.isc.org/downloads/. There you will find additional information about each release, source code, and pre-compiled versions for Microsoft Windows operating systems.

-
-
+
+ +

Security Fixes

-
    -

  • +

      +
    • +

      Added the ability to specify the maximum number of records permitted in a zone (max-records #;). This provides a mechanism to block overly large zone transfers, which is a potential risk with slave zones from other parties, as described in CVE-2016-6170. [RT #42143] -

      • -

    • +

      +
      • +
    • +

      It was possible to trigger a assertion when rendering a message using a specially crafted request. This flaw is disclosed in CVE-2016-2776. [RT #43139] -

      • -

    • +

      +
      • +
    • +

      getrrsetbyname with a non absolute name could trigger an infinite recursion bug in lwresd and named with lwres configured if when combined with a search list entry the resulting name is too long. This flaw is disclosed in CVE-2016-2775. [RT #42694] -

      • -

    • +

      +
      • +
    • +

      Duplicate EDNS COOKIE options in a response could trigger an assertion failure. This flaw is disclosed in CVE-2016-2088. [RT #41809] -

      • -

    • +

      +
      • +
    • +

      The resolver could abort with an assertion failure due to improper DNAME handling when parsing fetch reply messages. This flaw is disclosed in CVE-2016-1286. [RT #41753] -

      • -

    • +

      +
      • +
    • +

      Malformed control messages can trigger assertions in named and rndc. This flaw is disclosed in CVE-2016-1285. [RT #41666] -

      • -

    • +

      +
      • +
    • +

      Certain errors that could be encountered when printing out or logging an OPT record containing a CLIENT-SUBNET option could be mishandled, resulting in an assertion failure. This flaw is disclosed in CVE-2015-8705. [RT #41397] -

      • -

    • +

      +
      • +
    • +

      Specific APL data could trigger an INSIST. This flaw is disclosed in CVE-2015-8704. [RT #41396] -

      • -

    • +

      +
      • +
    • +

      Incorrect reference counting could result in an INSIST failure if a socket error occurred while performing a lookup. This flaw is disclosed in CVE-2015-8461. [RT#40945] -

      • -

    • +

      +
      • +
    • +

      Insufficient testing when parsing a message allowed records with an incorrect class to be be accepted, triggering a REQUIRE failure when those records were subsequently cached. This flaw is disclosed in CVE-2015-8000. [RT #40987] -

      • +

      +
    -
-
+ +
+ +

New Features

-
    -

  • +

      +
    • +

      The following resource record types have been implemented: AVC, CSYNC, NINFO, RKEY, SINK, SMIMEA, TA, TALINK. -

      • -

    • +

      +
      • +
    • +

      Added a warning for a common misconfiguration involving forwarded RFC 1918 and IPv6 ULA (Universal Local Address) zones. -

      • -

    • +

      +
      • +
    • +

      Contributed software from Nominum is included in the source at contrib/dnsperf-2.1.0.0-1/. It includes dnsperf for measuring the performance of authoritative DNS servers, resperf for @@ -127,14 +159,18 @@ gnuplot graphs, and queryparse to extract DNS queries from pcap capture files. This software is not installed by default with BIND. -

      • -

    • +

      +
      • +
    • +

      When loading a signed zone, named will now check whether an RRSIG's inception time is in the future, and if so, it will regenerate the RRSIG immediately. This helps when a system's clock needs to be reset backwards. -

      • -

    • +

      +
      • +
    • +

      named now provides feedback to the owners of zones which have trust anchors configured (trusted-keys, @@ -144,46 +180,62 @@ configured trust anchors for the zone. This is controlled by trust-anchor-telemetry and defaults to yes. -

      • +

      +
    -
-
+
+ +

Feature Changes

-
    -

  • +

      +
    • +

      The ISC DNSSEC Lookaside Validation (DLV) service is scheduled to be disabled in 2017. A warning is now logged when named is configured to use this service, either explicitly or via dnssec-lookaside auto;. [RT #42207] -

      • -

    • +

      +
      • +
    • +

      Updated the compiled-in addresses for H.ROOT-SERVERS.NET and L.ROOT-SERVERS.NET. -

      • -

    • +

      +
      • +
    • +

      The default preferred glue is now the address type of the transport the query was received over. -

      • -

    • +

      +
      • +
    • +

      On machines with 2 or more processors (CPU), the default value for the number of UDP listeners has been changed to the number of detected processors minus one. -

      • -

    • +

      +
      • +
    • +

      Zone transfers now use smaller message sizes to improve message compression. This results in reduced network usage. -

      • -

    • +

      +
      • +
    • +

      named -V output now also includes operating system details. -

      • +

      +
    -
-
+
+ +

Porting Changes

-

  • +

    • +

      The Microsoft Windows install tool BINDInstall.exe which requires a non-free version of Visual Studio to be built, now uses two @@ -192,63 +244,86 @@ previously compiled in the binary. Read win32utils/build.txt for more details. [RT #38915] -

    -
-
+

+
+
+ +

Bug Fixes

-
    -

  • +

      +
    • +

      Fixed a crash when calling rndc stats on some Windows builds: some Visual Studio compilers generate code that crashes when the "%z" printf() format specifier is used. [RT #42380] -

      • -

    • +

      +
      • +
    • +

      Windows installs were failing due to triggering UAC without the installation binary being signed. -

      • -

    • +

      +
      • +
    • +

      A change in the internal binary representation of the RBT database node structure enabled a race condition to occur (especially when BIND was built with certain compilers or optimizer settings), leading to inconsistent database state which caused random assertion failures. [RT #42380] -

      • -

    • +

      +
      • +
    • +

      rndc flushtree now works even if there wasn't a cached node at the specified name. [RT #41846] -

      • -

    • +

      +
      • +
    • +

      Don't emit records with zero TTL unless the records were received with a zero TTL. After being returned to waiting clients, the answer will be discarded from the cache. [RT #41687] -

      • -

    • +

      +
      • +
    • +

      For Windows platforms, the SIT (Source Identity Token) support was restored. (It was mistakenly partially replaced in a previous beta with new 9.11 COOKIE support.) [RT #41905] -

      • -

    • +

      +
      • +
    • +

      When deleting records from a zone database, interior nodes could be left empty but not deleted, damaging search performance afterward. [RT #40997] [RT #41941] -

      • -

    • +

      +
      • +
    • +

      The server could crash due to a use-after-free if a zone transfer timed out. [RT #41297] -

      • -

    • +

      +
      • +
    • +

      Authoritative servers that were marked as bogus (e.g. blackholed in configuration or with invalid addresses) were being queried anyway. [RT #41321] -

      • -

    • +

      +
      • +
    • +

      Some of the options for GeoIP ACLs, including "areacode", "metrocode", and "timezone", were incorrectly documented as "area", "metro" and "tz". Both the long and abbreviated versions are now accepted. -

      • -

    • +

      +
      • +
    • +

      Zones configured to use map format master files can't be used as policy zones because RPZ summary data isn't compiled when such zones are mapped into @@ -256,27 +331,31 @@ but in the meantime it has been documented, and attempting to use such zones in response-policy statements is now a configuration error. [RT #38321] -

      • +

      +
    -
-
+
+ +

End of Life

-

+

The end of life for BIND 9.10 is yet to be determined but will not be before BIND 9.12.0 has been released for 6 months. https://www.isc.org/downloads/software-support-policy/

-
-
+
+ +

Thank You

-

+

Thank you to everyone who assisted us in making this release possible. If you would like to contribute to ISC to assist us in continuing to make quality open source software, please visit our donations page at http://www.isc.org/donate/.

+
-
+
diff --git a/isc-config.sh.html b/isc-config.sh.html index 664cee3f90..a69262157c 100644 --- a/isc-config.sh.html +++ b/isc-config.sh.html @@ -22,22 +22,43 @@
-
+ + + + + + + +

Name

-

isc-config.sh — Get information about the installed version of ISC BIND

+

+ isc-config.sh + — Get information about the installed version of ISC BIND +

-
+ +

Synopsis

-

isc-config.sh [--cflags] [--exec-prefix] [--libs] [--prefix] [--version] [libraries...]

-
-
+

+ isc-config.sh + [--cflags] + [--exec-prefix] + [--libs] + [--prefix] + [--version] + [libraries...] +

+
+ +

DESCRIPTION

-

isc-config.sh + +

isc-config.sh prints information related to the installed version of ISC BIND, such as the compiler and linker flags required to compile and link programs that use ISC BIND libraries.

-

+

The optional libraries are used to report specific details for compiling and linking for the listed libraries. The allowed choices are: @@ -50,47 +71,65 @@ Multiple libraries may be listed on the command line. (Some libraries require other libraries, so are implied.)

-
-
+ +
+ +

OPTIONS

-
+ + +
--cflags
-

+

+

Prints the compiler command line options required to compile files that use ISC BIND. Use the libraries command line argument(s) to print additional specific flags to pass to the C compiler. -

+

+
--exec-prefix
-

+

+

Prints the directory prefix used in the ISC BIND installation for architecture dependent files to standard output. -

+

+
--libs
-

+

+

Prints the linker command line options used to link with the ISC BIND libraries. Use the libraries command line argument(s) to print additional specific flags. -

+

+
--prefix
-

+

+

Prints the directory prefix used in the ISC BIND installation for architecture independent files to standard output. -

+

+
--version
-

+

+

Prints the version of the installed ISC BIND suite. -

+

+
-
-
+ +
+ +

RETURN VALUES

-

isc-config.sh + +

isc-config.sh returns an exit status of 1 if invoked with invalid arguments or no arguments at all. It returns 0 if information was successfully printed.

-
+
+
diff --git a/lib/lwres/man/lwres.html b/lib/lwres/man/lwres.html index 901e6540f5..b62564e3e4 100644 --- a/lib/lwres/man/lwres.html +++ b/lib/lwres/man/lwres.html @@ -23,17 +23,31 @@
-
+ + + + +

Name

-

lwres — introduction to the lightweight resolver library

-
-
-

Synopsis

-
#include <lwres/lwres.h>
-
-
-

DESCRIPTION

+ lwres + — introduction to the lightweight resolver library +

+
+ + + +
+

Synopsis

+
+
#include <lwres/lwres.h>
+
+
+ +
+

DESCRIPTION

+ +

The BIND 9 lightweight resolver library is a simple, name service independent stub resolver library. It provides hostname-to-address and address-to-hostname lookup services to applications by @@ -45,10 +59,12 @@ The library and resolver daemon communicate using a simple UDP-based protocol.

-
-
+
+ +

OVERVIEW

-

+ +

The lwresd library implements multiple name service APIs. The standard gethostbyname(), @@ -73,7 +89,7 @@ library into their base distributions should rename the functions in the library proper so that the renaming macros are not needed.

-

+

The library also provides a native API consisting of the functions lwres_getaddrsbyname() and @@ -82,14 +98,14 @@ control over the lookup process than the standard functions provide.

-

+

In addition to these name service independent address lookup functions, the library implements a new, experimental API for looking up arbitrary DNS resource records, using the lwres_getaddrsbyname() function.

-

+

Finally, there is a low-level API for converting lookup requests and responses to and from raw lwres protocol packets. This API can be used by clients requiring nonblocking operation, @@ -99,63 +115,65 @@ resolver daemon. The use of this low-level API in clients and servers is outlined in the following sections.

-
-
+
+

CLIENT-SIDE LOW-LEVEL API CALL FLOW

-

+ +

When a client program wishes to make an lwres request using the native low-level API, it typically performs the following sequence of actions.

-

+

(1) Allocate or use an existing lwres_packet_t, called pkt below.

-

+

(2) Set pkt.recvlength to the maximum length we will accept. This is done so the receiver of our packets knows how large our receive buffer is. The "default" is a constant in lwres.h: LWRES_RECVLENGTH = 4096.

-

+

(3) Set pkt.serial to a unique serial number. This value is echoed back to the application by the remote server.

-

+

(4) Set pkt.pktflags. Usually this is set to 0.

-

+

(5) Set pkt.result to 0.

-

+

(6) Call lwres_*request_render(), or marshall in the data using the primitives such as lwres_packet_render() and storing the packet data.

-

+

(7) Transmit the resulting buffer.

-

+

(8) Call lwres_*response_parse() to parse any packets received.

-

+

(9) Verify that the opcode and serial match a request, and process the packet specific information contained in the body.

-
-
+
+

SERVER-SIDE LOW-LEVEL API CALL FLOW

-

+ +

When implementing the server side of the lightweight resolver protocol using the lwres library, a sequence of actions like the following is typically involved in processing each request packet.

-

+

Note that the same lwres_packet_t is used in both the _parse() and _render() calls, with only a few modifications made @@ -163,15 +181,15 @@ recommended as it keeps the serial, opcode, and other fields correct.

-

+

(1) When a packet is received, call lwres_*request_parse() to unmarshall it. This returns a lwres_packet_t (also called pkt, below) as well as a data specific type, such as lwres_gabnrequest_t.

-

+

(2) Process the request in the data specific type.

-

+

(3) Set the pkt.result, pkt.recvlength as above. All other fields can @@ -181,38 +199,59 @@ properly. Otherwise, the LWRES_LWPACKETFLAG_RESPONSE bit should be set.

-

+

(4) Call the data specific rendering function, such as lwres_gabnresponse_render().

-

+

(5) Send the resulting packet to the client.

-

-
-
+

+
+

SEE ALSO

-

lwres_gethostent(3), - lwres_getipnode(3), +

+ lwres_gethostent(3) + , - lwres_getnameinfo(3), + + lwres_getipnode(3) + , - lwres_noop(3), + + lwres_getnameinfo(3) + , - lwres_gabn(3), + + lwres_noop(3) + , - lwres_gnba(3), + + lwres_gabn(3) + , - lwres_context(3), + + lwres_gnba(3) + , - lwres_config(3), + + lwres_context(3) + , - resolver(5), + + lwres_config(3) + , - lwresd(8). + + resolver(5) + , + + + lwresd(8) + .

-
+
diff --git a/lib/lwres/man/lwres_buffer.html b/lib/lwres/man/lwres_buffer.html index e17f0770b8..740aa0b7fa 100644 --- a/lib/lwres/man/lwres_buffer.html +++ b/lib/lwres/man/lwres_buffer.html @@ -23,16 +23,44 @@
-
+ + + + + + + +

Name

-

lwres_buffer_init, lwres_buffer_invalidate, lwres_buffer_add, lwres_buffer_subtract, lwres_buffer_clear, lwres_buffer_first, lwres_buffer_forward, lwres_buffer_back, lwres_buffer_getuint8, lwres_buffer_putuint8, lwres_buffer_getuint16, lwres_buffer_putuint16, lwres_buffer_getuint32, lwres_buffer_putuint32, lwres_buffer_putmem, lwres_buffer_getmem — lightweight resolver buffer management

+

+ lwres_buffer_init, + lwres_buffer_invalidate, + lwres_buffer_add, + lwres_buffer_subtract, + lwres_buffer_clear, + lwres_buffer_first, + lwres_buffer_forward, + lwres_buffer_back, + lwres_buffer_getuint8, + lwres_buffer_putuint8, + lwres_buffer_getuint16, + lwres_buffer_putuint16, + lwres_buffer_getuint32, + lwres_buffer_putuint32, + lwres_buffer_putmem, + lwres_buffer_getmem + — lightweight resolver buffer management +

-
+ +

Synopsis

-
+ + 
 #include <lwres/lwbuffer.h>
+
@@ -50,6 +78,7 @@ void
 
+
void @@ -70,6 +99,7 @@ void
 
+
@@ -83,6 +113,7 @@ void
 
+
void @@ -90,6 +121,7 @@ void lwres_buffer_t *b);
 
+
void @@ -97,6 +129,7 @@ void lwres_buffer_t *b);
 
+
@@ -123,6 +156,7 @@ void
 
+
lwres_uint8_t @@ -130,6 +164,7 @@ lwres_uint8_t lwres_buffer_t *b);
 
+
@@ -143,6 +178,7 @@ void
 
+
lwres_uint16_t @@ -150,6 +186,7 @@ lwres_uint16_t lwres_buffer_t *b);
 
+
@@ -163,6 +200,7 @@ void
 
+
lwres_uint32_t @@ -170,6 +208,7 @@ lwres_uint32_t lwres_buffer_t *b);
 
+
@@ -183,6 +222,7 @@ void
 
+
@@ -200,6 +240,7 @@ void
 
+
@@ -217,18 +258,22 @@ void
 
+
-
-
+
+ +

DESCRIPTION

-

+ + +

These functions provide bounds checked access to a region of memory where data is being read or written. They are based on, and similar to, the isc_buffer_ functions in the ISC library.

-

+

A buffer is a region of memory, together with a set of related subregions. The used region and the @@ -242,7 +287,7 @@ void buffer commands. Initially, the used region is empty.

-

+

The used region is further subdivided into two disjoint regions: the consumed region and the remaining region. The union of these two regions is the used region. @@ -255,7 +300,7 @@ void buffer commands. Initially, the consumed region is empty.

-

+

The active region is an (optional) subregion of the remaining region. @@ -265,7 +310,7 @@ void If the current offset advances beyond the chosen offset, the active region will also be empty.

-
+    
    /------------entire length---------------\\
    /----- used region -----\\/-- available --\\
    +----------------------------------------+
@@ -275,7 +320,7 @@ void
       

 

     

-
+    
   a == base of buffer.
   b == current pointer.  Can be anywhere between a and d.
   c == active pointer.  Meaningful between b and d.
@@ -284,7 +329,7 @@ void
       

 

     

-
+    
   a-e == entire length of buffer.
   a-d == used region.
   a-b == consumed region.
@@ -293,7 +338,7 @@ void
 

 

     

-
lwres_buffer_init()
+    
lwres_buffer_init()
       initializes the
       lwres_buffer_t
       *b
@@ -302,12 +347,12 @@ void
       bytes starting at location
       base.
     

-
lwres_buffer_invalidate()
+    
lwres_buffer_invalidate()
       marks the buffer *b
       as invalid.  Invalidating a buffer after use is not required,
       but makes it possible to catch its possible accidental use.
     

-

+    

       The functions
       lwres_buffer_add()
       and
@@ -326,7 +371,7 @@ void
       They just change the value of
       used.
     

-

+    

       A buffer is re-initialised by
       lwres_buffer_clear().
       The function sets
@@ -336,14 +381,14 @@ void
       active
       to zero.
     

-
lwres_buffer_first
+    
lwres_buffer_first
       makes the consumed region of buffer
       *p
       empty by setting
       current
       to zero (the start of the buffer).
     

-
lwres_buffer_forward()
+    
lwres_buffer_forward()
       increases the consumed region of buffer
       *b
       by
@@ -357,7 +402,7 @@ void
       n
       bytes and checks for underflow.
     

-
lwres_buffer_getuint8()
+    
lwres_buffer_getuint8()
       reads an unsigned 8-bit integer from
       *b
       and returns it.
@@ -367,7 +412,7 @@ void
       to buffer
       *b.
     

-
lwres_buffer_getuint16()
+    
lwres_buffer_getuint16()
       and
       lwres_buffer_getuint32()
       are identical to
@@ -385,7 +430,7 @@ void
       b,
       in network byte order.
     

-

+    

       Arbitrary amounts of data are read or written from a lightweight
       resolver buffer with
       lwres_buffer_getmem()
@@ -408,6 +453,6 @@ void
       to
       base.
     

-
+
diff --git a/lib/lwres/man/lwres_config.html b/lib/lwres/man/lwres_config.html index 54b8397a07..2e30638f4d 100644 --- a/lib/lwres/man/lwres_config.html +++ b/lib/lwres/man/lwres_config.html @@ -23,13 +23,28 @@
-
+ + + + + + + +

Name

-

lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get — lightweight resolver configuration

+

+ lwres_conf_init, + lwres_conf_clear, + lwres_conf_parse, + lwres_conf_print, + lwres_conf_get + — lightweight resolver configuration +

-
+ +

Synopsis

-
+ 
#include <lwres/lwres.h>
@@ -79,23 +94,28 @@ lwres_conf_t *
 
-
-
+
+ +

DESCRIPTION

-

lwres_conf_init() + + +

lwres_conf_init() creates an empty lwres_conf_t structure for lightweight resolver context ctx.

-

lwres_conf_clear() + +

lwres_conf_clear() frees up all the internal memory used by that lwres_conf_t structure in resolver context ctx.

-

lwres_conf_parse() + +

lwres_conf_parse() opens the file filename and parses it to initialise the resolver context @@ -103,7 +123,8 @@ lwres_conf_t * lwres_conf_t structure.

-

lwres_conf_print() + +

lwres_conf_print() prints the lwres_conf_t structure for resolver context @@ -112,10 +133,13 @@ lwres_conf_t * FILE fp.

-
-
+
+

RETURN VALUES

-

lwres_conf_parse() + + + +

lwres_conf_parse() returns LWRES_R_SUCCESS if it successfully read and parsed filename. @@ -124,24 +148,31 @@ lwres_conf_t * could not be opened or contained incorrect resolver statements.

-

lwres_conf_print() + +

lwres_conf_print() returns LWRES_R_SUCCESS unless an error occurred when converting the network addresses to a numeric host address string. If this happens, the function returns LWRES_R_FAILURE.

-
-
+
+

SEE ALSO

-

stdio(3), - resolver(5). + +

+ stdio(3) + , + + resolver(5) + .

-
-
+
+

FILES

-

/etc/resolv.conf + +

/etc/resolv.conf

-
+
diff --git a/lib/lwres/man/lwres_context.html b/lib/lwres/man/lwres_context.html index bf76fe2a3a..0e7854bf56 100644 --- a/lib/lwres/man/lwres_context.html +++ b/lib/lwres/man/lwres_context.html @@ -23,13 +23,29 @@
-
+ + + + + + + +

Name

-

lwres_context_create, lwres_context_destroy, lwres_context_nextserial, lwres_context_initserial, lwres_context_freemem, lwres_context_allocmem, lwres_context_sendrecv — lightweight resolver context management

+

+ lwres_context_create, + lwres_context_destroy, + lwres_context_nextserial, + lwres_context_initserial, + lwres_context_freemem, + lwres_context_allocmem, + lwres_context_sendrecv + — lightweight resolver context management +

-
+

Synopsis

-
+ 
#include <lwres/lwres.h>
@@ -139,10 +155,12 @@ void *
 
-
-
+
+

DESCRIPTION

-

lwres_context_create() + + +

lwres_context_create() creates a lwres_context_t structure for use in lightweight resolver operations. It holds a socket and other data needed for communicating with a resolver daemon. The new @@ -153,7 +171,7 @@ void * is modified to point to the newly created lwres_context_t.

-

+

When the lightweight resolver needs to perform dynamic memory allocation, it will call malloc_function @@ -164,9 +182,13 @@ void * and free_function are NULL, memory is allocated using - malloc(3). + + malloc(3) + . and - free(3). + + free(3) + . It is not permitted to have a NULL malloc_function and a non-NULL @@ -178,19 +200,24 @@ void * arg is unused and should be passed as NULL.

-

+ +

Once memory for the structure has been allocated, it is initialized using - lwres_conf_init(3) + + lwres_conf_init(3) + and returned via *contextp.

-

lwres_context_destroy() + +

lwres_context_destroy() destroys a lwres_context_t, closing its socket. contextp is a pointer to a pointer to the context that is to be destroyed. The pointer will be set to NULL when the context has been destroyed.

-

+ +

The context holds a serial number that is used to identify resolver request packets and associate responses with the corresponding requests. This serial number is controlled using @@ -202,7 +229,8 @@ void * lwres_context_nextserial() increments the serial number and returns the previous value.

-

+ +

Memory for a lightweight resolver context is allocated and freed using lwres_context_allocmem() and lwres_context_freemem(). These use @@ -215,7 +243,8 @@ void * len bytes of space starting at location mem.

-

lwres_context_sendrecv() + +

lwres_context_sendrecv() performs I/O for the context ctx. Data are read and written from the context's socket. It writes data from sendbase — typically a @@ -225,21 +254,24 @@ void * written to this receive buffer is returned in *recvd_len.

-
-
+
+ +

RETURN VALUES

-

lwres_context_create() + + +

lwres_context_create() returns LWRES_R_NOMEMORY if memory for the struct lwres_context could not be allocated, LWRES_R_SUCCESS otherwise.

-

+

Successful calls to the memory allocator lwres_context_allocmem() return a pointer to the start of the allocated space. It returns NULL if memory could not be allocated.

-

LWRES_R_SUCCESS +

LWRES_R_SUCCESS is returned when lwres_context_sendrecv() completes successfully. @@ -250,15 +282,22 @@ void * lwres_context_sendrecv() times out waiting for a response.

-
-
+
+

SEE ALSO

-

lwres_conf_init(3), - malloc(3), +

+ lwres_conf_init(3) + , - free(3). + + malloc(3) + , + + + free(3) + .

-
+
diff --git a/lib/lwres/man/lwres_gabn.html b/lib/lwres/man/lwres_gabn.html index 22735e337f..5b7a9f5006 100644 --- a/lib/lwres/man/lwres_gabn.html +++ b/lib/lwres/man/lwres_gabn.html @@ -23,13 +23,28 @@
-
+ + + + + + + +

Name

-

lwres_gabnrequest_render, lwres_gabnresponse_render, lwres_gabnrequest_parse, lwres_gabnresponse_parse, lwres_gabnresponse_free, lwres_gabnrequest_free — lightweight resolver getaddrbyname message handling

+

+ lwres_gabnrequest_render, + lwres_gabnresponse_render, + lwres_gabnrequest_parse, + lwres_gabnresponse_parse, + lwres_gabnresponse_free, + lwres_gabnrequest_free + — lightweight resolver getaddrbyname message handling +

-
+

Synopsis

-
+ 
#include <lwres/lwres.h>
@@ -142,15 +157,16 @@ void
 
-
-
+
+

DESCRIPTION

-

+ +

These are low-level routines for creating and parsing lightweight resolver name-to-address lookup request and response messages.

-

+

There are four main functions for the getaddrbyname opcode. One render function converts a getaddrbyname request structure — lwres_gabnrequest_t — @@ -163,23 +179,23 @@ void This is complemented by a parse function which converts a packet in canonical format to a getaddrbyname response structure.

-

+

These structures are defined in <lwres/lwres.h>. They are shown below.

-
+    
 #define LWRES_OPCODE_GETADDRSBYNAME     0x00010001U
 

 

     

-
+    
 typedef struct lwres_addr lwres_addr_t;
 typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t;
 

 

     

-
+    
 typedef struct {
         lwres_uint32_t  flags;
         lwres_uint32_t  addrtypes;
@@ -189,7 +205,7 @@ typedef struct {
 

 

     

-
+    
 typedef struct {
         lwres_uint32_t          flags;
         lwres_uint16_t          naliases;
@@ -205,7 +221,8 @@ typedef struct {
 

 

     

-
lwres_gabnrequest_render()
+
+    
lwres_gabnrequest_render()
       uses resolver context ctx to convert
       getaddrbyname request structure req to
       canonical format.  The packet header structure
@@ -219,7 +236,8 @@ typedef struct {
       lwres_gabnresponse_t to the lightweight resolver's
       canonical format.
     

-
lwres_gabnrequest_parse()
+
+    
lwres_gabnrequest_parse()
       uses context ctx to convert the contents
       of packet pkt to a
       lwres_gabnrequest_t structure.  Buffer
@@ -232,7 +250,8 @@ typedef struct {
       semantics as lwres_gabnrequest_parse()
       except it yields a lwres_gabnresponse_t structure.
     

-
lwres_gabnresponse_free()
+
+    
lwres_gabnresponse_free()
       and lwres_gabnrequest_free() release the
       memory in resolver context ctx that was
       allocated to the lwres_gabnresponse_t or
@@ -242,10 +261,11 @@ typedef struct {
       Any memory associated with ancillary buffers and strings for
       those structures is also discarded.
     

-
-
+
+

RETURN VALUES

-

+ +

The getaddrbyname opcode functions lwres_gabnrequest_render(), lwres_gabnresponse_render() @@ -280,11 +300,14 @@ typedef struct { lwres_lwpacket_t indicate that the packet is not a response to an earlier query.

-
-
+
+

SEE ALSO

-

lwres_packet(3) + +

+ lwres_packet(3) +

-
+
diff --git a/lib/lwres/man/lwres_gai_strerror.html b/lib/lwres/man/lwres_gai_strerror.html index 52dc6c49ee..dbed607520 100644 --- a/lib/lwres/man/lwres_gai_strerror.html +++ b/lib/lwres/man/lwres_gai_strerror.html @@ -23,13 +23,24 @@
-
+ + + + + + + +

Name

-

lwres_gai_strerror — print suitable error string

+

+ lwres_gai_strerror + — print suitable error string +

-
+ +

Synopsis

-
+ 
#include <lwres/netdb.h>
@@ -39,10 +50,13 @@ char *
 
-
-
+
+ +

DESCRIPTION

-

lwres_gai_strerror() + + +

lwres_gai_strerror() returns an error message corresponding to an error code returned by getaddrinfo(). The following error codes and their meaning are defined in @@ -50,55 +64,77 @@ char *

EAI_ADDRFAMILY
-

+

+

address family for hostname not supported -

+

+
EAI_AGAIN
-

+

+

temporary failure in name resolution -

+

+
EAI_BADFLAGS
-

+

+

invalid value for ai_flags -

+

+
EAI_FAIL
-

+

+

non-recoverable failure in name resolution -

+

+
EAI_FAMILY
-

ai_family not supported -

+
+

ai_family not supported +

+
EAI_MEMORY
-

+

+

memory allocation failure -

+

+
EAI_NODATA
-

+

+

no address associated with hostname -

+

+
EAI_NONAME
-

+

+

hostname or servname not provided, or not known -

+

+
EAI_SERVICE
-

+

+

servname not supported for ai_socktype -

+

+
EAI_SOCKTYPE
-

ai_socktype not supported -

+
+

ai_socktype not supported +

+
EAI_SYSTEM
-

+

+

system error returned in errno -

+

+

The message invalid error code is returned if ecode is out of range.

-

ai_flags, +

ai_flags, ai_family and ai_socktype @@ -107,17 +143,27 @@ char * used by lwres_getaddrinfo().

-
-
+
+ +

SEE ALSO

-

strerror(3), - lwres_getaddrinfo(3), +

+ strerror(3) + , - getaddrinfo(3), + + lwres_getaddrinfo(3) + , - RFC2133. + + getaddrinfo(3) + , + + + RFC2133 + .

-
+
diff --git a/lib/lwres/man/lwres_getaddrinfo.html b/lib/lwres/man/lwres_getaddrinfo.html index c39bdd378e..5144fab206 100644 --- a/lib/lwres/man/lwres_getaddrinfo.html +++ b/lib/lwres/man/lwres_getaddrinfo.html @@ -23,13 +23,24 @@
-
+ + + + + + + +

Name

-

lwres_getaddrinfo, lwres_freeaddrinfo — socket address structure to host and service name

+

+ lwres_getaddrinfo, + lwres_freeaddrinfo + — socket address structure to host and service name +

-
+

Synopsis

-
+ 
#include <lwres/netdb.h>
@@ -60,12 +71,13 @@ void
 
-

+ +

If the operating system does not provide a struct addrinfo, the following structure is used:

-
+    
 struct  addrinfo {
         int             ai_flags;       /* AI_PASSIVE, AI_CANONNAME */
         int             ai_family;      /* PF_xxx */
@@ -79,10 +91,14 @@ struct  addrinfo {
 

 

     

-
-
+ +
+ +

DESCRIPTION

-

lwres_getaddrinfo() + + +

lwres_getaddrinfo() is used to get a list of IP addresses and port numbers for host hostname and service servname. @@ -99,7 +115,8 @@ struct addrinfo { decimal port number or a service name as listed in /etc/services.

-

hints + +

hints is an optional pointer to a struct addrinfo. This structure can be used to provide hints concerning the type of @@ -111,7 +128,8 @@ struct addrinfo {

ai_family
-

+

+

The protocol family that should be used. When ai_family @@ -120,9 +138,11 @@ struct addrinfo { it means the caller will accept any protocol family supported by the operating system. -

+

+
ai_socktype
-

+

+

denotes the type of socket — SOCK_STREAM, SOCK_DGRAM @@ -132,18 +152,21 @@ struct addrinfo { When ai_socktype is zero the caller will accept any socket type. -

+

+
ai_protocol
-

+

+

indicates which transport protocol is wanted: IPPROTO_UDP or IPPROTO_TCP. If ai_protocol is zero the caller will accept any protocol. -

+

+
ai_flags
-

+

Flag bits. If the AI_CANONNAME @@ -161,7 +184,9 @@ struct addrinfo { bit indicates that the returned socket address structure is intended for used in a call to - bind(2). + + bind(2) + . In this case, if the hostname argument is a NULL @@ -172,21 +197,29 @@ struct addrinfo { IN6ADDR_ANY_INIT for an IPv6 address.

-

+

When ai_flags does not set the AI_PASSIVE bit, the returned socket address structure will be ready for use in a call to - connect(2) + + connect(2) + for a connection-oriented protocol or - connect(2), + + connect(2) + , - sendto(2), + + sendto(2) + , or - sendmsg(2) + + sendmsg(2) + if a connectionless protocol was chosen. The IP address portion of the socket address structure will be set to the loopback address if @@ -198,7 +231,7 @@ struct addrinfo { is not set in ai_flags.

-

+

If ai_flags is set to @@ -209,22 +242,25 @@ struct addrinfo { address and no name resolution should be attempted.

-
+

-

+ +

All other elements of the struct addrinfo passed via hints must be zero.

-

+ +

A hints of NULL is treated as if the caller provided a struct addrinfo initialized to zero with ai_familyset to PF_UNSPEC.

-

+ +

After a successful call to lwres_getaddrinfo(), *res @@ -248,7 +284,9 @@ struct addrinfo { returned addrinfo structure contain the corresponding arguments for a call to - socket(2). + + socket(2) + . For each addrinfo structure in the list, the @@ -256,7 +294,8 @@ struct addrinfo { member points to a filled-in socket address structure of length ai_addrlen.

-

+ +

All of the information returned by lwres_getaddrinfo() is dynamically allocated: the addrinfo structures, and the socket @@ -273,42 +312,72 @@ struct addrinfo { created by a call to lwres_getaddrinfo().

-
-
+ +
+ +

RETURN VALUES

-

lwres_getaddrinfo() + + +

lwres_getaddrinfo() returns zero on success or one of the error codes listed in - gai_strerror(3) + + gai_strerror(3) + if an error occurs. If both hostname and servname are NULL lwres_getaddrinfo() returns EAI_NONAME.

-
-
+
+

SEE ALSO

-

lwres(3), - lwres_getaddrinfo(3), +

+ lwres(3) + , - lwres_freeaddrinfo(3), + + lwres_getaddrinfo(3) + , - lwres_gai_strerror(3), + + lwres_freeaddrinfo(3) + , - RFC2133, + + lwres_gai_strerror(3) + , - getservbyname(3), + + RFC2133 + , - bind(2), + + getservbyname(3) + , - connect(2), + + bind(2) + , - sendto(2), + + connect(2) + , - sendmsg(2), + + sendto(2) + , - socket(2). + + sendmsg(2) + , + + + socket(2) + .

-
+ +
diff --git a/lib/lwres/man/lwres_gethostent.html b/lib/lwres/man/lwres_gethostent.html index 59c8aef8f5..098d196eb5 100644 --- a/lib/lwres/man/lwres_gethostent.html +++ b/lib/lwres/man/lwres_gethostent.html @@ -23,13 +23,33 @@
-
+ + + + + + + +

Name

-

lwres_gethostbyname, lwres_gethostbyname2, lwres_gethostbyaddr, lwres_gethostent, lwres_sethostent, lwres_endhostent, lwres_gethostbyname_r, lwres_gethostbyaddr_r, lwres_gethostent_r, lwres_sethostent_r, lwres_endhostent_r — lightweight resolver get network host entry

+

+ lwres_gethostbyname, + lwres_gethostbyname2, + lwres_gethostbyaddr, + lwres_gethostent, + lwres_sethostent, + lwres_endhostent, + lwres_gethostbyname_r, + lwres_gethostbyaddr_r, + lwres_gethostent_r, + lwres_sethostent_r, + lwres_endhostent_r + — lightweight resolver get network host entry +

-
+

Synopsis

-
+ 
#include <lwres/netdb.h>
@@ -183,21 +203,25 @@ void
 
-
-
+
+ +

DESCRIPTION

-

+ +

These functions provide hostname-to-address and address-to-hostname lookups by means of the lightweight resolver. They are similar to the standard - gethostent(3) + + gethostent(3) + functions provided by most operating systems. They use a struct hostent which is usually defined in <namedb.h>.

-
+    
 struct  hostent {
         char    *h_name;        /* official name of host */
         char    **h_aliases;    /* alias list */
@@ -209,46 +233,56 @@ struct  hostent {
 

 

     

-

+    

       The members of this structure are:
       

 

 
h_name

-

+

+            

               The official (canonical) name of the host.
-            

+            

+          
 
h_aliases

-

+

+            

               A NULL-terminated array of alternate names (nicknames) for the
               host.
-            

+            

+          
 
h_addrtype

-

+

+            

               The type of address being returned —
               PF_INET
               or
               PF_INET6.
-            

+            

+          
 
h_length

-

+

+            

               The length of the address in bytes.
-            

+            

+          
 
h_addr_list

-

+

+            

               A NULL
               terminated array of network addresses for the host.
               Host addresses are returned in network byte order.
-            

+            

+          
 

 

     

-

+    

       For backward compatibility with very old software,
       h_addr
       is the first address in
       h_addr_list.
     

-
lwres_gethostent(),
+    
lwres_gethostent(),
       lwres_sethostent(),
       lwres_endhostent(),
       lwres_gethostent_r(),
@@ -262,7 +296,8 @@ struct  hostent {
       these functions; it only provides them as stub functions that always
       return failure.
     

-
lwres_gethostbyname()
+
+    
lwres_gethostbyname()
       and lwres_gethostbyname2() look up the
       hostname name.
       lwres_gethostbyname() always looks for an
@@ -276,7 +311,8 @@ struct  hostent {
       lwres_gethostbyname() or
       lwres_gethostbyname2() fail.
     

-

+
+    

       Reverse lookups of addresses are performed by
       lwres_gethostbyaddr().
       addr is an address of length
@@ -299,7 +335,8 @@ struct  hostent {
       return resbuf,
       which is a pointer to the struct hostent it created.
     

-
lwres_gethostbyaddr_r()
+
+    
lwres_gethostbyaddr_r()
       is a thread-safe function
       that performs a reverse lookup of address addr
       which is len bytes long and is of
@@ -321,10 +358,13 @@ struct  hostent {
       resbuf, which is a pointer to the
       struct hostent() it created.
     

-
-
+ +
+ +

RETURN VALUES

-

+ +

The functions lwres_gethostbyname(), lwres_gethostbyname2(), @@ -339,37 +379,50 @@ struct hostent {

HOST_NOT_FOUND
-

+

+

The host or address was not found. -

+

+
TRY_AGAIN
-

+

+

A recoverable error occurred, e.g., a timeout. Retrying the lookup may succeed. -

+

+
NO_RECOVERY
-

+

+

A non-recoverable error occurred. -

+

+
NO_DATA
-

+

+

The name exists, but has no address information associated with it (or vice versa in the case of a reverse lookup). The code NO_ADDRESS is accepted as a synonym for NO_DATA for backwards compatibility. -

+

+

-

lwres_hstrerror(3) + +

+ lwres_hstrerror(3) + translates these error codes to suitable error messages.

-

lwres_gethostent() + +

lwres_gethostent() and lwres_gethostent_r() always return NULL.

-

+ +

Successful calls to lwres_gethostbyname_r() and lwres_gethostbyaddr_r() return resbuf, a pointer to the @@ -385,19 +438,29 @@ struct hostent { variable errno to ERANGE.

-
-
+ +
+

SEE ALSO

-

gethostent(3), - lwres_getipnode(3), +

+ gethostent(3) + , - lwres_hstrerror(3) + + lwres_getipnode(3) + , + + + lwres_hstrerror(3) +

-
-
+
+ +

BUGS

-

lwres_gethostbyname(), + +

lwres_gethostbyname(), lwres_gethostbyname2(), lwres_gethostbyaddr() and @@ -410,7 +473,7 @@ struct hostent { lwres_gethostbyaddr_r() respectively.

-

+

The resolver daemon does not currently support any non-DNS name services such as /etc/hosts @@ -418,6 +481,6 @@ struct hostent { NIS, consequently the above functions don't, either.

-
+
diff --git a/lib/lwres/man/lwres_getipnode.html b/lib/lwres/man/lwres_getipnode.html index 62d7f944d6..ba1c07d6b6 100644 --- a/lib/lwres/man/lwres_getipnode.html +++ b/lib/lwres/man/lwres_getipnode.html @@ -23,13 +23,25 @@
-
+ + + + + + + +

Name

-

lwres_getipnodebyname, lwres_getipnodebyaddr, lwres_freehostent — lightweight resolver nodename / address translation API

+

+ lwres_getipnodebyname, + lwres_getipnodebyaddr, + lwres_freehostent + — lightweight resolver nodename / address translation API +

-
+

Synopsis

-
+ 
#include <lwres/netdb.h>
@@ -81,21 +93,25 @@ void
 
-
-
+
+ +

DESCRIPTION

-

+ + +

These functions perform thread safe, protocol independent nodename-to-address and address-to-nodename translation as defined in RFC2553.

-

+ +

They use a struct hostent which is defined in namedb.h:

-
+    
 struct  hostent {
         char    *h_name;        /* official name of host */
         char    **h_aliases;    /* alias list */
@@ -107,42 +123,54 @@ struct  hostent {
 

 

     

-

+
+    

       The members of this structure are:
       

 

 
h_name

-

+

+            

               The official (canonical) name of the host.
-            

+            

+          
 
h_aliases

-

+

+            

               A NULL-terminated array of alternate names (nicknames) for the
               host.
-            

+            

+          
 
h_addrtype

-

+

+            

               The type of address being returned - usually
               PF_INET
               or
               PF_INET6.
 
-            

+            

+          
 
h_length

-

+

+            

               The length of the address in bytes.
-            

+            

+          
 
h_addr_list

-

+

+            

               A
               NULL
               terminated array of network addresses for the host.
               Host addresses are returned in network byte order.
-            

+            

+          
 

 

     

-
lwres_getipnodebyname()
+
+    
lwres_getipnodebyname()
       looks up addresses of protocol family af
       for the hostname name.  The
       flags parameter contains ORed flag bits
@@ -152,15 +180,18 @@ struct  hostent {
       

 

 
AI_V4MAPPED

-

+

+            

               This is used with an
               af
               of AF_INET6, and causes IPv4 addresses to be returned as
               IPv4-mapped
               IPv6 addresses.
-            

+            

+          
 
AI_ALL

-

+

+            

               This is used with an
               af
               of AF_INET6, and causes all known addresses (IPv6 and IPv4) to
@@ -168,31 +199,37 @@ struct  hostent {
               If AI_V4MAPPED is also set, the IPv4 addresses are return as
               mapped
               IPv6 addresses.
-            

+            

+          
 
AI_ADDRCONFIG

-

+

+            

               Only return an IPv6 or IPv4 address if here is an active network
               interface of that type.  This is not currently implemented
               in the BIND 9 lightweight resolver, and the flag is ignored.
-            

+            

+          
 
AI_DEFAULT

-

+

+            

               This default sets the
               AI_V4MAPPED
               and
               AI_ADDRCONFIG
               flag bits.
-            

+            

+          
 

 

     

-
lwres_getipnodebyaddr()
+
+    
lwres_getipnodebyaddr()
       performs a reverse lookup of address src
       which is len bytes long.
       af denotes the protocol family, typically
       PF_INET or PF_INET6.
     

-
lwres_freehostent()
+    
lwres_freehostent()
       releases all the memory associated with the struct
       hostent pointer he.  Any memory
       allocated for the h_name,
@@ -200,10 +237,11 @@ struct  hostent {
       h_aliases is freed, as is the memory for
       the hostent structure itself.
     

-
-
+
+

RETURN VALUES

-

+ +

If an error occurs, lwres_getipnodebyname() and @@ -218,47 +256,70 @@ struct hostent {

HOST_NOT_FOUND
-

+

+

No such host is known. -

+

+
NO_ADDRESS
-

+

+

The server recognised the request and the name but no address is available. Another type of request to the name server for the domain might return an answer. -

+

+
TRY_AGAIN
-

+

+

A temporary and possibly transient error occurred, such as a failure of a server to respond. The request may succeed if retried. -

+

+
NO_RECOVERY
-

+

+

An unexpected failure occurred, and retrying the request is pointless. -

+

+

-

lwres_hstrerror(3) +

+ lwres_hstrerror(3) + translates these error codes to suitable error messages.

-
-
+
+

SEE ALSO

-

RFC2553, - lwres(3), +

+ RFC2553 + , - lwres_gethostent(3), + + lwres(3) + , - lwres_getaddrinfo(3), + + lwres_gethostent(3) + , - lwres_getnameinfo(3), + + lwres_getaddrinfo(3) + , - lwres_hstrerror(3). + + lwres_getnameinfo(3) + , + + + lwres_hstrerror(3) + .

-
+
diff --git a/lib/lwres/man/lwres_getnameinfo.html b/lib/lwres/man/lwres_getnameinfo.html index ffcd0a034c..df4523cea6 100644 --- a/lib/lwres/man/lwres_getnameinfo.html +++ b/lib/lwres/man/lwres_getnameinfo.html @@ -23,15 +23,25 @@
-
+ + + + + + + +

Name

-

lwres_getnameinfo — lightweight resolver socket address structure to hostname and +

+ lwres_getnameinfo + — lightweight resolver socket address structure to hostname and service name -

+ +

-
+

Synopsis

-
+ 
#include <lwres/netdb.h>
@@ -67,12 +77,17 @@ int
 
-
-
+
+ +

DESCRIPTION

-

+ + +

This function is equivalent to the - getnameinfo(3) function defined in RFC2133. + + getnameinfo(3) + function defined in RFC2133. lwres_getnameinfo() returns the hostname for the struct sockaddr sa which @@ -84,45 +99,56 @@ int hostname is 1025 bytes: NI_MAXHOST.

-

The name of the service associated with the port number in + +

The name of the service associated with the port number in sa is returned in *serv. It is servlen bytes long. The maximum length of the service name is NI_MAXSERV - 32 bytes.

-

+ +

The flags argument sets the following bits:

NI_NOFQDN
-

+

+

A fully qualified domain name is not required for local hosts. The local part of the fully qualified domain name is returned instead. -

+

+
NI_NUMERICHOST
-

+

+

Return the address in numeric form, as if calling inet_ntop(), instead of a host name. -

+

+
NI_NAMEREQD
-

+

+

A name is required. If the hostname cannot be found in the DNS and this flag is set, a non-zero error code is returned. If the hostname is not found and the flag is not set, the address is returned in numeric form. -

+

+
NI_NUMERICSERV
-

+

+

The service name is returned as a digit string representing the port number. -

+

+
NI_DGRAM
-

+

+

Specifies that the service being looked up is a datagram service, and causes getservbyport() to be called with a second argument of "udp" instead of its default of "tcp". This is @@ -130,34 +156,53 @@ int for the few ports (512-514) that have different services for UDP and TCP. -

+

+

-
-
+
+ +

RETURN VALUES

-

lwres_getnameinfo() + +

lwres_getnameinfo() returns 0 on success or a non-zero error code if an error occurs.

-
-
+
+

SEE ALSO

-

RFC2133, - getservbyport(3), - lwres(3), - lwres_getnameinfo(3), - lwres_getnamebyaddr(3). - lwres_net_ntop(3). + +

+ RFC2133 + , + + getservbyport(3) + , + + lwres(3) + , + + lwres_getnameinfo(3) + , + + lwres_getnamebyaddr(3) + . + + lwres_net_ntop(3) + .

-
-
+
+

BUGS

-

+ +

RFC2133 fails to define what the nonzero return values of - getnameinfo(3) + + getnameinfo(3) + are.

-
+
diff --git a/lib/lwres/man/lwres_getrrsetbyname.html b/lib/lwres/man/lwres_getrrsetbyname.html index e7eac54c3a..169ddc1d33 100644 --- a/lib/lwres/man/lwres_getrrsetbyname.html +++ b/lib/lwres/man/lwres_getrrsetbyname.html @@ -23,13 +23,24 @@
-
+ + + + + + + +

Name

-

lwres_getrrsetbyname, lwres_freerrset — retrieve DNS records

+

+ lwres_getrrsetbyname, + lwres_freerrset + — retrieve DNS records +

-
+

Synopsis

-
+ 
#include <lwres/netdb.h>
@@ -64,10 +75,11 @@ void
 
-

+ +

The following structures are used:

-
+    
 struct  rdatainfo {
         unsigned int            rdi_length;     /* length of data */
         unsigned char           *rdi_data;      /* record data */
@@ -75,7 +87,7 @@ struct  rdatainfo {
 

 

     

-
+    
 struct  rrsetinfo {
         unsigned int            rri_flags;      /* RRSET_VALIDATED... */
         unsigned int            rri_rdclass;    /* class number */
@@ -90,10 +102,12 @@ struct  rrsetinfo {
 

 

     

-
-
+
+ +

DESCRIPTION

-

lwres_getrrsetbyname() + +

lwres_getrrsetbyname() gets a set of resource records associated with a hostname, class, and type. @@ -101,7 +115,7 @@ struct rrsetinfo { null-terminated string. The flags field is currently unused and must be zero.

-

+

After a successful call to lwres_getrrsetbyname(), *res is a pointer to an @@ -120,7 +134,7 @@ struct rrsetinfo { bit is set, the data has been DNSSEC validated and the signatures verified.

-

+

All of the information returned by lwres_getrrsetbyname() is dynamically allocated: the rrsetinfo and @@ -137,46 +151,63 @@ struct rrsetinfo { rrset created by a call to lwres_getrrsetbyname().

-

-
-
+

+
+

RETURN VALUES

-

lwres_getrrsetbyname() + +

lwres_getrrsetbyname() returns zero on success, and one of the following error codes if an error occurred:

ERRSET_NONAME
-

+

+

the name does not exist -

+

+
ERRSET_NODATA
-

+

+

the name exists, but does not have data of the desired type -

+

+
ERRSET_NOMEMORY
-

+

+

memory could not be allocated -

+

+
ERRSET_INVAL
-

+

+

a parameter is invalid -

+

+
ERRSET_FAIL
-

+

+

other failure -

+

+
-

+
+

+

-
-
+
+

SEE ALSO

-

lwres(3). + +

+ lwres(3) + .

-
+ +
diff --git a/lib/lwres/man/lwres_gnba.html b/lib/lwres/man/lwres_gnba.html index b0b6bc8b4f..024785ad7c 100644 --- a/lib/lwres/man/lwres_gnba.html +++ b/lib/lwres/man/lwres_gnba.html @@ -23,16 +23,34 @@
-
+ + + + + + + +

Name

-

lwres_gnbarequest_render, lwres_gnbaresponse_render, lwres_gnbarequest_parse, lwres_gnbaresponse_parse, lwres_gnbaresponse_free, lwres_gnbarequest_free — lightweight resolver getnamebyaddress message handling

+

+ lwres_gnbarequest_render, + lwres_gnbaresponse_render, + lwres_gnbarequest_parse, + lwres_gnbaresponse_parse, + lwres_gnbaresponse_free, + lwres_gnbarequest_free + — lightweight resolver getnamebyaddress message handling +

-
+ +

Synopsis

-
+ + 
 #include <lwres/lwres.h>
+
@@ -55,6 +73,7 @@ lwres_result_t
 
+
@@ -119,6 +138,7 @@ lwres_result_t
 
+
@@ -147,15 +167,18 @@ void
 
-
-
+ +
+ +

DESCRIPTION

-

+ +

These are low-level routines for creating and parsing lightweight resolver address-to-name lookup request and response messages.

-

+

There are four main functions for the getnamebyaddr opcode. One render function converts a getnamebyaddr request structure — lwres_gnbarequest_t — @@ -169,17 +192,17 @@ void This is complemented by a parse function which converts a packet in canonical format to a getnamebyaddr response structure.

-

+

These structures are defined in lwres/lwres.h. They are shown below.

-
+    
 #define LWRES_OPCODE_GETNAMEBYADDR      0x00010002U
 

 

     

-
+    
 typedef struct {
         lwres_uint32_t  flags;
         lwres_addr_t    addr;
@@ -187,7 +210,7 @@ typedef struct {
 

 

     

-
+    
 typedef struct {
         lwres_uint32_t  flags;
         lwres_uint16_t  naliases;
@@ -201,7 +224,8 @@ typedef struct {
 

 

     

-
lwres_gnbarequest_render()
+
+    
lwres_gnbarequest_render()
       uses resolver context ctx to convert
       getnamebyaddr request structure req to
       canonical format.  The packet header structure
@@ -213,7 +237,8 @@ typedef struct {
       lwres_gnbaresponse_t to the lightweight resolver's
       canonical format.
     

-
lwres_gnbarequest_parse()
+
+    
lwres_gnbarequest_parse()
       uses context ctx to convert the contents of
       packet pkt to a
       lwres_gnbarequest_t structure.  Buffer
@@ -225,7 +250,8 @@ typedef struct {
       semantics as lwres_gnbarequest_parse()
       except it yields a lwres_gnbaresponse_t structure.
     

-
lwres_gnbaresponse_free()
+
+    
lwres_gnbaresponse_free()
       and lwres_gnbarequest_free() release the
       memory in resolver context ctx that was
       allocated to the lwres_gnbaresponse_t or
@@ -234,10 +260,12 @@ typedef struct {
       ancillary buffers and strings for those structures is also
       discarded.
     

-
-
+
+ +

RETURN VALUES

-

+ +

The getnamebyaddr opcode functions lwres_gnbarequest_render(), lwres_gnbaresponse_render() @@ -272,11 +300,14 @@ typedef struct { lwres_lwpacket_t indicate that the packet is not a response to an earlier query.

-
-
+
+

SEE ALSO

-

lwres_packet(3). + +

+ lwres_packet(3) + .

-
+
diff --git a/lib/lwres/man/lwres_hstrerror.html b/lib/lwres/man/lwres_hstrerror.html index d0c8213961..449fd50e85 100644 --- a/lib/lwres/man/lwres_hstrerror.html +++ b/lib/lwres/man/lwres_hstrerror.html @@ -23,13 +23,24 @@
-
+ + + + + + + +

Name

-

lwres_herror, lwres_hstrerror — lightweight resolver error message generation

+

+ lwres_herror, + lwres_hstrerror + — lightweight resolver error message generation +

-
+

Synopsis

-
+ 
#include <lwres/netdb.h>
@@ -46,16 +57,20 @@ const char *
 
-
-
+
+ +

DESCRIPTION

-

lwres_herror() + + +

lwres_herror() prints the string s on stderr followed by the string generated by lwres_hstrerror() for the error code stored in the global variable lwres_h_errno.

-

lwres_hstrerror() + +

lwres_hstrerror() returns an appropriate string for the error code gievn by err. The values of the error codes and messages are as follows: @@ -63,40 +78,58 @@ const char *

NETDB_SUCCESS
-

Resolver Error 0 (no error) -

+
+

Resolver Error 0 (no error) +

+
HOST_NOT_FOUND
-

Unknown host -

+
+

Unknown host +

+
TRY_AGAIN
-

Host name lookup failure -

+
+

Host name lookup failure +

+
NO_RECOVERY
-

Unknown server error -

+
+

Unknown server error +

+
NO_DATA
-

No address associated with name -

+
+

No address associated with name +

+

-
-
+
+ +

RETURN VALUES

-

+ +

The string Unknown resolver error is returned by lwres_hstrerror() when the value of lwres_h_errno is not a valid error code.

-
-
+
+

SEE ALSO

-

herror(3), - lwres_hstrerror(3). +

+ herror(3) + , + + + lwres_hstrerror(3) + .

-
+ +
diff --git a/lib/lwres/man/lwres_inetntop.html b/lib/lwres/man/lwres_inetntop.html index e9f609e5e1..22ab1619ee 100644 --- a/lib/lwres/man/lwres_inetntop.html +++ b/lib/lwres/man/lwres_inetntop.html @@ -23,13 +23,23 @@
-
+ + + + + + + +

Name

-

lwres_net_ntop — lightweight resolver IP address presentation

+

+ lwres_net_ntop + — lightweight resolver IP address presentation +

-
+

Synopsis

-
+ 
#include <lwres/net.h>
@@ -53,10 +63,13 @@ const char *
 
-
-
+
+ +

DESCRIPTION

-

lwres_net_ntop() + + +

lwres_net_ntop() converts an IP address of protocol family af — IPv4 or IPv6 — at location src from network format to its @@ -64,17 +77,21 @@ const char * that string would be a dotted-decimal. An IPv6 address would be represented in colon notation as described in RFC1884.

-

+ +

The generated string is copied to dst provided size indicates it is long enough to store the ASCII representation of the address.

-
-
+ +
+

RETURN VALUES

-

+ + +

If successful, the function returns dst: a pointer to a string containing the presentation format of the address. lwres_net_ntop() returns @@ -84,13 +101,21 @@ const char * not supported.

-
-
+ +
+

SEE ALSO

-

RFC1884, - inet_ntop(3), - errno(3). + +

+ RFC1884 + , + + inet_ntop(3) + , + + errno(3) + .

-
+
diff --git a/lib/lwres/man/lwres_noop.html b/lib/lwres/man/lwres_noop.html index e7e3c7b6f6..3f59cee56d 100644 --- a/lib/lwres/man/lwres_noop.html +++ b/lib/lwres/man/lwres_noop.html @@ -23,13 +23,28 @@
-
+ + + + + + + +

Name

-

lwres_nooprequest_render, lwres_noopresponse_render, lwres_nooprequest_parse, lwres_noopresponse_parse, lwres_noopresponse_free, lwres_nooprequest_free — lightweight resolver no-op message handling

+

+ lwres_nooprequest_render, + lwres_noopresponse_render, + lwres_nooprequest_parse, + lwres_noopresponse_parse, + lwres_noopresponse_free, + lwres_nooprequest_free + — lightweight resolver no-op message handling +

-
+

Synopsis

-
+ 
 #include <lwres/lwres.h>
@@ -143,21 +158,22 @@ void
 
-
-
+
+

DESCRIPTION

-

+ +

These are low-level routines for creating and parsing lightweight resolver no-op request and response messages.

-

+

The no-op message is analogous to a ping packet: a packet is sent to the resolver daemon and is simply echoed back. The opcode is intended to allow a client to determine if the server is operational or not.

-

+

There are four main functions for the no-op opcode. One render function converts a no-op request structure — lwres_nooprequest_t — @@ -170,18 +186,18 @@ void This is complemented by a parse function which converts a packet in canonical format to a no-op response structure.

-

+

These structures are defined in lwres/lwres.h. They are shown below.

-
+    
 #define LWRES_OPCODE_NOOP       0x00000000U
 

 

     

-
+    
 typedef struct {
         lwres_uint16_t  datalength;
         unsigned char   *data;
@@ -189,7 +205,7 @@ typedef struct {
 

 

     

-
+    
 typedef struct {
         lwres_uint16_t  datalength;
         unsigned char   *data;
@@ -197,12 +213,13 @@ typedef struct {
 

 

     

-

+    

       Although the structures have different types, they are identical.
       This is because the no-op opcode simply echos whatever data was sent:
       the response is therefore identical to the request.
     

-
lwres_nooprequest_render()
+
+    
lwres_nooprequest_render()
       uses resolver context ctx to convert
       no-op request structure req to canonical
       format.  The packet header structure pkt
@@ -215,7 +232,8 @@ typedef struct {
       lwres_noopresponse_t to the lightweight resolver's
       canonical format.
     

-
lwres_nooprequest_parse()
+
+    
lwres_nooprequest_parse()
       uses context ctx to convert the contents
       of packet pkt to a
       lwres_nooprequest_t structure.  Buffer
@@ -227,17 +245,20 @@ typedef struct {
       semantics as lwres_nooprequest_parse()
       except it yields a lwres_noopresponse_t structure.
     

-
lwres_noopresponse_free()
+
+    
lwres_noopresponse_free()
       and lwres_nooprequest_free() release the
       memory in resolver context ctx that was
       allocated to the lwres_noopresponse_t or
       lwres_nooprequest_t structures referenced via
       structp.
     

-
-
+ +
+

RETURN VALUES

-

+ +

The no-op opcode functions lwres_nooprequest_render(), @@ -273,11 +294,14 @@ typedef struct { lwres_lwpacket_t indicate that the packet is not a response to an earlier query.

-
-
+
+

SEE ALSO

-

lwres_packet(3) + +

+ lwres_packet(3) +

-
+
diff --git a/lib/lwres/man/lwres_packet.html b/lib/lwres/man/lwres_packet.html index e3a0594d99..0cd0446a82 100644 --- a/lib/lwres/man/lwres_packet.html +++ b/lib/lwres/man/lwres_packet.html @@ -23,13 +23,24 @@
-
+ + + + + + + +

Name

-

lwres_lwpacket_renderheader, lwres_lwpacket_parseheader — lightweight resolver packet handling functions

+

+ lwres_lwpacket_renderheader, + lwres_lwpacket_parseheader + — lightweight resolver packet handling functions +

-
+

Synopsis

-
+ 
#include <lwres/lwpacket.h>
@@ -58,21 +69,23 @@ lwres_result_t
 
-
-
+
+

DESCRIPTION

-

+ +

These functions rely on a struct lwres_lwpacket which is defined in lwres/lwpacket.h.

-
+
+    
 typedef struct lwres_lwpacket lwres_lwpacket_t;
       

 

     

-
+    
 struct lwres_lwpacket {
         lwres_uint32_t          length;
         lwres_uint16_t          version;
@@ -87,26 +100,32 @@ struct lwres_lwpacket {
 

 

     

-

+
+    

       The elements of this structure are:
       

 

 
length

-

+

+            

               the overall packet length, including the entire packet header.
               This field is filled in by the lwres_gabn_*() and lwres_gnba_*()
               calls.
-            

+            

+          
 
version

-

+

+            

               the header format. There is currently only one format,
               LWRES_LWPACKETVERSION_0.
 
               This field is filled in by the lwres_gabn_*() and lwres_gnba_*()
               calls.
-            

+            

+          
 
pktflags

-

+

+            

               library-defined flags for this packet: for instance whether the
               packet
               is a request or a reply. Flag values can be set, but not defined
@@ -117,9 +136,11 @@ struct lwres_lwpacket {
               LWRES_LWPACKETFLAG_RESPONSE bit, which is set by the library in
               the
               lwres_gabn_*() and lwres_gnba_*() calls.
-            

+            

+          
 
serial

-

+

+            

               is set by the requestor and is returned in all replies. If two
               or more
               packets from the same source have the same serial number and are
@@ -128,9 +149,11 @@ struct lwres_lwpacket {
               latter ones
               may be dropped.
               This field must be set by the application.
-            

+            

+          
 
opcode

-

+

+            

               indicates the operation.
               Opcodes between 0x00000000 and 0x03ffffff are
               reserved for use by the lightweight resolver library. Opcodes
@@ -138,9 +161,11 @@ struct lwres_lwpacket {
               0x04000000 and 0xffffffff are application defined.
               This field is filled in by the lwres_gabn_*() and lwres_gnba_*()
               calls.
-            

+            

+          
 
result

-

+

+            

               is only valid for replies.
               Results between 0x04000000 and 0xffffffff are application
               defined.
@@ -148,73 +173,91 @@ struct lwres_lwpacket {
               library use.
               This field is filled in by the lwres_gabn_*() and lwres_gnba_*()
               calls.
-            

+            

+          
 
recvlength

-

+

+            

               is the maximum buffer size that the receiver can handle on
               requests
               and the size of the buffer needed to satisfy a request when the
               buffer
               is too large for replies.
               This field is supplied by the application.
-            

+            

+          
 
authtype

-

+

+            

               defines the packet level authentication that is used.
               Authorisation types between 0x1000 and 0xffff are application
               defined
               and types between 0x0000 and 0x0fff are reserved for library
               use.
               Currently these are not used and must be zero.
-            

+            

+          
 
authlen

-

+

+            

               gives the length of the authentication data.
               Since packet authentication is currently not used, this must be
               zero.
-            

+            

+          
 

 

     

-

+    

       The following opcodes are currently defined:
       

 

 
NOOP

-

+

+            

               Success is always returned and the packet contents are echoed.
               The lwres_noop_*() functions should be used for this type.
-            

+            

+          
 
GETADDRSBYNAME

-

+

+            

               returns all known addresses for a given name.
               The lwres_gabn_*() functions should be used for this type.
-            

+            

+          
 
GETNAMEBYADDR

-

+

+            

               return the hostname for the given address.
               The lwres_gnba_*() functions should be used for this type.
-            

+            

+          
 

 

     

-
lwres_lwpacket_renderheader()
+
+    
lwres_lwpacket_renderheader()
       transfers the contents of lightweight resolver packet structure
       lwres_lwpacket_t *pkt in
       network byte order to the lightweight resolver buffer,
       *b.
     

-
lwres_lwpacket_parseheader()
+
+    
lwres_lwpacket_parseheader()
       performs the converse operation.  It transfers data in network
       byte order from buffer *b to resolver
       packet *pkt.  The contents of the buffer
       b should correspond to a
       lwres_lwpacket_t.
     

-
-
+ +
+ +

RETURN VALUES

-

+ +

Successful calls to lwres_lwpacket_renderheader() and lwres_lwpacket_parseheader() return @@ -224,6 +267,7 @@ struct lwres_lwpacket { functions return LWRES_R_UNEXPECTEDEND.

-
+ +
diff --git a/lib/lwres/man/lwres_resutil.html b/lib/lwres/man/lwres_resutil.html index aa175fb9fa..0ae3bc3752 100644 --- a/lib/lwres/man/lwres_resutil.html +++ b/lib/lwres/man/lwres_resutil.html @@ -23,13 +23,26 @@
-
+ + + + + + + +

Name

-

lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr — lightweight resolver utility functions

+

+ lwres_string_parse, + lwres_addr_parse, + lwres_getaddrsbyname, + lwres_getnamebyaddr + — lightweight resolver utility functions +

-
+

Synopsis

-
+ 
#include <lwres/lwres.h>
@@ -108,10 +121,13 @@ lwres_result_t
 
-
-
+
+ +

DESCRIPTION

-

lwres_string_parse() + + +

lwres_string_parse() retrieves a DNS-encoded string starting the current pointer of lightweight resolver buffer b: i.e. b->current. When the function returns, @@ -122,7 +138,8 @@ lwres_result_t string length, the encoded string, and the trailing NULL character.

-

lwres_addr_parse() + +

lwres_addr_parse() extracts an address from the buffer b. The buffer's current pointer b->current is presumed to point at an encoded address: the address preceded @@ -135,10 +152,12 @@ lwres_result_t next byte of available data in the buffer following the encoded address.

-

lwres_getaddrsbyname() + +

lwres_getaddrsbyname() and lwres_getnamebyaddr() use the lwres_gnbaresponse_t structure defined below:

+ 
 typedef struct {
         lwres_uint32_t          flags;
@@ -153,13 +172,17 @@ typedef struct {
         size_t                  baselen;
 } lwres_gabnresponse_t;
-

+ +

The contents of this structure are not manipulated directly but they are controlled through the - lwres_gabn(3) + + lwres_gabn(3) + functions.

-

+ +

The lightweight resolver uses lwres_getaddrsbyname() to perform forward lookups. @@ -173,7 +196,8 @@ typedef struct { LWRES_ADDRTYPE_V6 for IPv6 addresses. Results of the lookup are returned in *structp.

-

lwres_getnamebyaddr() + +

lwres_getnamebyaddr() performs reverse lookups. Resolver context ctx is used for memory allocation. The address type is indicated by addrtype: @@ -184,10 +208,12 @@ typedef struct { function call is made available through *structp.

-
-
+
+ +

RETURN VALUES

-

+ +

Successful calls to lwres_string_parse() and @@ -201,16 +227,18 @@ typedef struct { if the buffer has less space than expected for the components of the encoded string or address.

-

lwres_getaddrsbyname() + +

lwres_getaddrsbyname() returns LWRES_R_SUCCESS on success and it returns LWRES_R_NOTFOUND if the hostname name could not be found.

-

LWRES_R_SUCCESS +

LWRES_R_SUCCESS is returned by a successful call to lwres_getnamebyaddr().

-

+ +

Both lwres_getaddrsbyname() and @@ -222,13 +250,20 @@ typedef struct { if the buffers used for sending queries and receiving replies are too small.

-
-
-

SEE ALSO

-

lwres_buffer(3), - lwres_gabn(3). +

+
+

SEE ALSO

+ +

+ lwres_buffer(3) + , + + + lwres_gabn(3) + .

-
+ +