diff --git a/CHANGES b/CHANGES index 51375aa569..0d9bc08132 100644 --- a/CHANGES +++ b/CHANGES @@ -5,6 +5,8 @@ 5547. [bug] BIND 9 failed to build with --disable-threads and --with-geoip2. [GL #2324] + --- 9.11.26 released --- + 5544. [func] Restore the default value of "nocookie-udp-size" to 4096 bytes. [GL #2250] diff --git a/README b/README index bb86502f4a..75616b3dfe 100644 --- a/README +++ b/README @@ -360,6 +360,10 @@ BIND 9.11.25 BIND 9.11.25 is a maintenance release. +BIND 9.11.26 + +BIND 9.11.26 is a maintenance release. + Building BIND Minimally, BIND requires a UNIX or Linux system with an ANSI C compiler, diff --git a/README.md b/README.md index 6f16887b6e..560c99358d 100644 --- a/README.md +++ b/README.md @@ -377,6 +377,10 @@ BIND 9.11.24 is a maintenance release. BIND 9.11.25 is a maintenance release. +#### BIND 9.11.26 + +BIND 9.11.26 is a maintenance release. + ### Building BIND Minimally, BIND requires a UNIX or Linux system with an ANSI C compiler, diff --git a/bin/check/named-checkconf.8 b/bin/check/named-checkconf.8 index 2eeddeddef..10979e7046 100644 --- a/bin/check/named-checkconf.8 +++ b/bin/check/named-checkconf.8 @@ -35,24 +35,20 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" named-checkconf \- named configuration file syntax checking tool - .SH "SYNOPSIS" - .HP \w'\fBnamed\-checkconf\fR\ 'u - \fBnamed\-checkconf\fR - [\fB\-hjvz\fR] - [\fB\-p\fR\ [\fB\-x\fR\ ]] - [\fB\-t\ \fR\fB\fIdirectory\fR\fR] - {filename} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBnamed\-checkconf\fR\ 'u +\fBnamed\-checkconf\fR [\fB\-hjvz\fR] [\fB\-p\fR\ [\fB\-x\fR\ ]] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] {filename} +.SH "DESCRIPTION" +.PP \fBnamed\-checkconf\fR checks the syntax, but not the semantics, of a \fBnamed\fR 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\&. - .PP +.PP Note: files that \fBnamed\fR reads in separate parser contexts, such as @@ -66,67 +62,67 @@ to fail to run, even if was successful\&. \fBnamed\-checkconf\fR can be run on these files explicitly, however\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-h .RS 4 - Print the usage summary and exit\&. - .RE - .PP +Print the usage summary and exit\&. +.RE +.PP \-j .RS 4 - When loading a zonefile read the journal if it exists\&. - .RE - .PP +When loading a zonefile read the journal if it exists\&. +.RE +.PP \-p .RS 4 - Print out the +Print out the named\&.conf and included files in canonical form if no errors were detected\&. See also the \fB\-x\fR option\&. - .RE - .PP +.RE +.PP \-t \fIdirectory\fR .RS 4 - Chroot to +Chroot to directory so that include directives in the configuration file are processed as if run by a similarly chrooted \fBnamed\fR\&. - .RE - .PP +.RE +.PP \-v .RS 4 - Print the version of the +Print the version of the \fBnamed\-checkconf\fR program and exit\&. - .RE - .PP +.RE +.PP \-x .RS 4 - When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks (\*(Aq?\*(Aq)\&. This allows the contents of +When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks (\*(Aq?\*(Aq)\&. This allows the contents of named\&.conf and related files to be shared \(em for example, when submitting bug reports \(em without compromising private data\&. This option cannot be used without \fB\-p\fR\&. - .RE - .PP +.RE +.PP \-z .RS 4 - Perform a test load of all master zones found in +Perform a test load of all master zones found in named\&.conf\&. - .RE - .PP +.RE +.PP filename .RS 4 - The name of the configuration file to be checked\&. If not specified, it defaults to +The name of the configuration file to be checked\&. If not specified, it defaults to /etc/named\&.conf\&. - .RE - .SH "RETURN VALUES" - .PP +.RE +.SH "RETURN VALUES" +.PP \fBnamed\-checkconf\fR returns an exit status of 1 if errors were detected and 0 otherwise\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBnamed\fR(8), \fBnamed-checkzone\fR(8), BIND 9 Administrator Reference Manual\&. diff --git a/bin/check/named-checkconf.html b/bin/check/named-checkconf.html index b0f8107573..091c9ee879 100644 --- a/bin/check/named-checkconf.html +++ b/bin/check/named-checkconf.html @@ -14,45 +14,26 @@
- - - - - - - -
+

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 @@ -62,50 +43,37 @@ 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 @@ -113,46 +81,32 @@ 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.8 b/bin/check/named-checkzone.8 index e2206b0efc..99948c1981 100644 --- a/bin/check/named-checkzone.8 +++ b/bin/check/named-checkzone.8 @@ -35,123 +35,71 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" named-checkzone, named-compilezone \- zone file validity checking or converting tool - .SH "SYNOPSIS" - .HP \w'\fBnamed\-checkzone\fR\ 'u - \fBnamed\-checkzone\fR - [\fB\-d\fR] - [\fB\-h\fR] - [\fB\-j\fR] - [\fB\-q\fR] - [\fB\-v\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-f\ \fR\fB\fIformat\fR\fR] - [\fB\-F\ \fR\fB\fIformat\fR\fR] - [\fB\-J\ \fR\fB\fIfilename\fR\fR] - [\fB\-i\ \fR\fB\fImode\fR\fR] - [\fB\-k\ \fR\fB\fImode\fR\fR] - [\fB\-m\ \fR\fB\fImode\fR\fR] - [\fB\-M\ \fR\fB\fImode\fR\fR] - [\fB\-n\ \fR\fB\fImode\fR\fR] - [\fB\-l\ \fR\fB\fIttl\fR\fR] - [\fB\-L\ \fR\fB\fIserial\fR\fR] - [\fB\-o\ \fR\fB\fIfilename\fR\fR] - [\fB\-r\ \fR\fB\fImode\fR\fR] - [\fB\-s\ \fR\fB\fIstyle\fR\fR] - [\fB\-S\ \fR\fB\fImode\fR\fR] - [\fB\-t\ \fR\fB\fIdirectory\fR\fR] - [\fB\-T\ \fR\fB\fImode\fR\fR] - [\fB\-w\ \fR\fB\fIdirectory\fR\fR] - [\fB\-D\fR] - [\fB\-W\ \fR\fB\fImode\fR\fR] - {zonename} - {filename} - .HP \w'\fBnamed\-compilezone\fR\ 'u - \fBnamed\-compilezone\fR - [\fB\-d\fR] - [\fB\-j\fR] - [\fB\-q\fR] - [\fB\-v\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-C\ \fR\fB\fImode\fR\fR] - [\fB\-f\ \fR\fB\fIformat\fR\fR] - [\fB\-F\ \fR\fB\fIformat\fR\fR] - [\fB\-J\ \fR\fB\fIfilename\fR\fR] - [\fB\-i\ \fR\fB\fImode\fR\fR] - [\fB\-k\ \fR\fB\fImode\fR\fR] - [\fB\-m\ \fR\fB\fImode\fR\fR] - [\fB\-n\ \fR\fB\fImode\fR\fR] - [\fB\-l\ \fR\fB\fIttl\fR\fR] - [\fB\-L\ \fR\fB\fIserial\fR\fR] - [\fB\-r\ \fR\fB\fImode\fR\fR] - [\fB\-s\ \fR\fB\fIstyle\fR\fR] - [\fB\-t\ \fR\fB\fIdirectory\fR\fR] - [\fB\-T\ \fR\fB\fImode\fR\fR] - [\fB\-w\ \fR\fB\fIdirectory\fR\fR] - [\fB\-D\fR] - [\fB\-W\ \fR\fB\fImode\fR\fR] - {\fB\-o\ \fR\fB\fIfilename\fR\fR} - {zonename} - {filename} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBnamed\-checkzone\fR\ 'u +\fBnamed\-checkzone\fR [\fB\-d\fR] [\fB\-h\fR] [\fB\-j\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-f\ \fR\fB\fIformat\fR\fR] [\fB\-F\ \fR\fB\fIformat\fR\fR] [\fB\-J\ \fR\fB\fIfilename\fR\fR] [\fB\-i\ \fR\fB\fImode\fR\fR] [\fB\-k\ \fR\fB\fImode\fR\fR] [\fB\-m\ \fR\fB\fImode\fR\fR] [\fB\-M\ \fR\fB\fImode\fR\fR] [\fB\-n\ \fR\fB\fImode\fR\fR] [\fB\-l\ \fR\fB\fIttl\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-o\ \fR\fB\fIfilename\fR\fR] [\fB\-r\ \fR\fB\fImode\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-S\ \fR\fB\fImode\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-T\ \fR\fB\fImode\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {zonename} {filename} +.HP \w'\fBnamed\-compilezone\fR\ 'u +\fBnamed\-compilezone\fR [\fB\-d\fR] [\fB\-j\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-C\ \fR\fB\fImode\fR\fR] [\fB\-f\ \fR\fB\fIformat\fR\fR] [\fB\-F\ \fR\fB\fIformat\fR\fR] [\fB\-J\ \fR\fB\fIfilename\fR\fR] [\fB\-i\ \fR\fB\fImode\fR\fR] [\fB\-k\ \fR\fB\fImode\fR\fR] [\fB\-m\ \fR\fB\fImode\fR\fR] [\fB\-n\ \fR\fB\fImode\fR\fR] [\fB\-l\ \fR\fB\fIttl\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-r\ \fR\fB\fImode\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-T\ \fR\fB\fImode\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {\fB\-o\ \fR\fB\fIfilename\fR\fR} {zonename} {filename} +.SH "DESCRIPTION" +.PP \fBnamed\-checkzone\fR checks the syntax and integrity of a zone file\&. It performs the same checks as \fBnamed\fR does when loading a zone\&. This makes \fBnamed\-checkzone\fR useful for checking zone files before configuring them into a name server\&. - .PP +.PP \fBnamed\-compilezone\fR is similar to \fBnamed\-checkzone\fR, but it always dumps the zone contents to a specified file in a specified format\&. Additionally, it applies stricter check levels by default, since the dump output will be used as an actual zone file loaded by \fBnamed\fR\&. When manually specified otherwise, the check levels must at least be as strict as those specified in the \fBnamed\fR configuration file\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-d .RS 4 - Enable debugging\&. - .RE - .PP +Enable debugging\&. +.RE +.PP \-h .RS 4 - Print the usage summary and exit\&. - .RE - .PP +Print the usage summary and exit\&. +.RE +.PP \-q .RS 4 - Quiet mode \- exit code only\&. - .RE - .PP +Quiet mode \- exit code only\&. +.RE +.PP \-v .RS 4 - Print the version of the +Print the version of the \fBnamed\-checkzone\fR program and exit\&. - .RE - .PP +.RE +.PP \-j .RS 4 - 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 +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\&. - .RE - .PP +.RE +.PP \-J \fIfilename\fR .RS 4 - When loading the zone file read the journal from the given file, if it exists\&. (Implies \-j\&.) - .RE - .PP +When loading the zone file read the journal from the given file, if it exists\&. (Implies \-j\&.) +.RE +.PP \-c \fIclass\fR .RS 4 - Specify the class of the zone\&. If not specified, "IN" is assumed\&. - .RE - .PP +Specify the class of the zone\&. If not specified, "IN" is assumed\&. +.RE +.PP \-i \fImode\fR .RS 4 - Perform post\-load zone integrity checks\&. Possible modes are +Perform post\-load zone integrity checks\&. Possible modes are \fB"full"\fR (default), \fB"full\-sibling"\fR, @@ -160,25 +108,25 @@ program and exit\&. and \fB"none"\fR\&. .sp - Mode +Mode \fB"full"\fR checks that MX records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames)\&. Mode \fB"local"\fR only checks MX records which refer to in\-zone hostnames\&. .sp - Mode +Mode \fB"full"\fR checks that SRV records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames)\&. Mode \fB"local"\fR only checks SRV records which refer to in\-zone hostnames\&. .sp - Mode +Mode \fB"full"\fR 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 in the zone match those advertised by the child\&. Mode \fB"local"\fR only checks NS records which refer to in\-zone hostnames or that some required glue exists, that is when the nameserver is in a child zone\&. .sp - Mode +Mode \fB"full\-sibling"\fR and \fB"local\-sibling"\fR @@ -188,26 +136,26 @@ and \fB"local"\fR respectively\&. .sp - Mode +Mode \fB"none"\fR disables the checks\&. - .RE - .PP +.RE +.PP \-f \fIformat\fR .RS 4 - Specify the format of the zone file\&. Possible formats are +Specify the format of the zone file\&. Possible formats are \fB"text"\fR (default), \fB"raw"\fR, and \fB"map"\fR\&. - .RE - .PP +.RE +.PP \-F \fIformat\fR .RS 4 - Specify the format of the output file specified\&. For +Specify the format of the output file specified\&. For \fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents\&. .sp - Possible formats are +Possible formats are \fB"text"\fR (default), which is the standard textual representation of the zone, and \fB"map"\fR, @@ -217,11 +165,11 @@ disables the checks\&. \fB"raw=N"\fR specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of \fBnamed\fR; if N is 1, the file can be read by release 9\&.9\&.0 or higher; the default is 1\&. - .RE - .PP +.RE +.PP \-k \fImode\fR .RS 4 - Perform +Perform \fB"check\-names"\fR checks with the specified failure mode\&. Possible modes are \fB"fail"\fR @@ -231,42 +179,42 @@ checks with the specified failure mode\&. Possible modes are (default for \fBnamed\-checkzone\fR) and \fB"ignore"\fR\&. - .RE - .PP +.RE +.PP \-l \fIttl\fR .RS 4 - 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 +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 \fBmax\-zone\-ttl\fR option in named\&.conf\&. - .RE - .PP +.RE +.PP \-L \fIserial\fR .RS 4 - 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\&.) - .RE - .PP +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\&.) +.RE +.PP \-m \fImode\fR .RS 4 - Specify whether MX records should be checked to see if they are addresses\&. Possible modes are +Specify whether MX records should be checked to see if they are addresses\&. Possible modes are \fB"fail"\fR, \fB"warn"\fR (default) and \fB"ignore"\fR\&. - .RE - .PP +.RE +.PP \-M \fImode\fR .RS 4 - Check if a MX record refers to a CNAME\&. Possible modes are +Check if a MX record refers to a CNAME\&. Possible modes are \fB"fail"\fR, \fB"warn"\fR (default) and \fB"ignore"\fR\&. - .RE - .PP +.RE +.PP \-n \fImode\fR .RS 4 - Specify whether NS records should be checked to see if they are addresses\&. Possible modes are +Specify whether NS records should be checked to see if they are addresses\&. Possible modes are \fB"fail"\fR (default for \fBnamed\-compilezone\fR), @@ -274,100 +222,100 @@ named\&.conf\&. (default for \fBnamed\-checkzone\fR) and \fB"ignore"\fR\&. - .RE - .PP +.RE +.PP \-o \fIfilename\fR .RS 4 - Write zone output to +Write zone output to filename\&. If filename is \- then write to standard out\&. This is mandatory for \fBnamed\-compilezone\fR\&. - .RE - .PP +.RE +.PP \-r \fImode\fR .RS 4 - Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS\&. Possible modes are +Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS\&. Possible modes are \fB"fail"\fR, \fB"warn"\fR (default) and \fB"ignore"\fR\&. - .RE - .PP +.RE +.PP \-s \fIstyle\fR .RS 4 - Specify the style of the dumped zone file\&. Possible styles are +Specify the style of the dumped zone file\&. Possible styles are \fB"full"\fR (default) and \fB"relative"\fR\&. The full format is most suitable for processing automatically by a separate script\&. On the other hand, the relative format is more human\-readable and is thus suitable for editing by hand\&. For \fBnamed\-checkzone\fR this does not cause any effects unless it dumps the zone contents\&. It also does not have any meaning if the output format is not text\&. - .RE - .PP +.RE +.PP \-S \fImode\fR .RS 4 - Check if a SRV record refers to a CNAME\&. Possible modes are +Check if a SRV record refers to a CNAME\&. Possible modes are \fB"fail"\fR, \fB"warn"\fR (default) and \fB"ignore"\fR\&. - .RE - .PP +.RE +.PP \-t \fIdirectory\fR .RS 4 - Chroot to +Chroot to directory so that include directives in the configuration file are processed as if run by a similarly chrooted \fBnamed\fR\&. - .RE - .PP +.RE +.PP \-T \fImode\fR .RS 4 - 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 +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 \fB"warn"\fR (default), \fB"ignore"\fR\&. - .RE - .PP +.RE +.PP \-w \fIdirectory\fR .RS 4 - chdir to +chdir to directory so that relative filenames in master file $INCLUDE directives work\&. This is similar to the directory clause in named\&.conf\&. - .RE - .PP +.RE +.PP \-D .RS 4 - Dump zone file in canonical format\&. This is always enabled for +Dump zone file in canonical format\&. This is always enabled for \fBnamed\-compilezone\fR\&. - .RE - .PP +.RE +.PP \-W \fImode\fR .RS 4 - 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 +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 \fB"warn"\fR (default) and \fB"ignore"\fR\&. - .RE - .PP +.RE +.PP zonename .RS 4 - The domain name of the zone being checked\&. - .RE - .PP +The domain name of the zone being checked\&. +.RE +.PP filename .RS 4 - The name of the zone file\&. - .RE - .SH "RETURN VALUES" - .PP +The name of the zone file\&. +.RE +.SH "RETURN VALUES" +.PP \fBnamed\-checkzone\fR returns an exit status of 1 if errors were detected and 0 otherwise\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBnamed\fR(8), \fBnamed-checkconf\fR(8), RFC 1035, diff --git a/bin/check/named-checkzone.html b/bin/check/named-checkzone.html index 43b35e2cd6..0ca0ff345b 100644 --- a/bin/check/named-checkzone.html +++ b/bin/check/named-checkzone.html @@ -14,94 +14,24 @@
- - - - - - - -
+

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. @@ -112,62 +42,45 @@ 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", @@ -175,19 +88,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 @@ -196,33 +109,31 @@ 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", @@ -233,10 +144,9 @@ 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" @@ -244,48 +154,38 @@ "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" @@ -293,30 +193,24 @@ "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". @@ -329,101 +223,74 @@ 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.8 b/bin/confgen/ddns-confgen.8 index d2a17e29eb..ba9b307c7d 100644 --- a/bin/confgen/ddns-confgen.8 +++ b/bin/confgen/ddns-confgen.8 @@ -35,39 +35,26 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" ddns-confgen \- ddns key generation tool - .SH "SYNOPSIS" - .HP \w'\fBtsig\-keygen\fR\ 'u - \fBtsig\-keygen\fR - [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] - [\fB\-h\fR] - [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] - [name] - .HP \w'\fBddns\-confgen\fR\ 'u - \fBddns\-confgen\fR - [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] - [\fB\-h\fR] - [\fB\-k\ \fR\fB\fIkeyname\fR\fR] - [\fB\-q\fR] - [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] - [ - | \-s\ \fIname\fR - | \-z\ \fIzone\fR - ] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBtsig\-keygen\fR\ 'u +\fBtsig\-keygen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [name] +.HP \w'\fBddns\-confgen\fR\ 'u +\fBddns\-confgen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-q\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\-s\ \fIname\fR | \-z\ \fIzone\fR] +.SH "DESCRIPTION" +.PP \fBtsig\-keygen\fR and \fBddns\-confgen\fR 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 \fBrndc\fR command channel\&. - .PP +.PP When run as \fBtsig\-keygen\fR, 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 \fBtsig\-key\fR\&. - .PP +.PP When run as \fBddns\-confgen\fR, the generated key is accompanied by configuration text and instructions that can be used with \fBnsupdate\fR @@ -78,7 +65,7 @@ when setting up dynamic DNS, including an example statement\&. (This usage similar to the \fBrndc\-confgen\fR command for setting up command channel security\&.) - .PP +.PP Note that \fBnamed\fR itself can configure a local DDNS key for use with @@ -88,21 +75,21 @@ itself can configure a local DDNS key for use with is only needed when a more elaborate configuration is required: for instance, if \fBnsupdate\fR is to be used from a remote system\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-a \fIalgorithm\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-h .RS 4 - Prints a short summary of options and arguments\&. - .RE - .PP +Prints a short summary of options and arguments\&. +.RE +.PP \-k \fIkeyname\fR .RS 4 - Specifies the key name of the DDNS authentication key\&. The default is +Specifies the key name of the DDNS authentication key\&. The default is \fBddns\-key\fR when neither the \fB\-s\fR @@ -113,29 +100,29 @@ option is specified; otherwise, the default is as a separate label followed by the argument of the option, e\&.g\&., \fBddns\-key\&.example\&.com\&.\fR The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods\&. - .RE - .PP +.RE +.PP \-q .RS 4 - (\fBddns\-confgen\fR +(\fBddns\-confgen\fR only\&.) Quiet mode: Print only the key, with no explanatory text or usage examples; This is essentially identical to \fBtsig\-keygen\fR\&. - .RE - .PP +.RE +.PP \-r \fIrandomfile\fR .RS 4 - Specifies a source of random data for generating the authorization\&. If the operating system does not provide a +Specifies a source of random data for generating the authorization\&. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness is keyboard input\&. randomdev specifies the name of a character device or file containing random data to be used instead of the default\&. The special value keyboard indicates that keyboard input should be used\&. - .RE - .PP +.RE +.PP \-s \fIname\fR .RS 4 - (\fBddns\-confgen\fR +(\fBddns\-confgen\fR only\&.) Generate configuration example to allow dynamic updates of a single hostname\&. The example \fBnamed\&.conf\fR text shows how to set an update policy for the specified @@ -143,11 +130,11 @@ text shows how to set an update policy for the specified using the "name" nametype\&. The default key name is ddns\-key\&.\fIname\fR\&. 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 \fB\-z\fR option\&. - .RE - .PP +.RE +.PP \-z \fIzone\fR .RS 4 - (\fBddns\-confgen\fR +(\fBddns\-confgen\fR only\&.) Generate configuration example to allow dynamic updates of a zone: The example \fBnamed\&.conf\fR text shows how to set an update policy for the specified @@ -156,9 +143,9 @@ using the "zonesub" nametype, allowing updates to all subdomain names within tha \fIzone\fR\&. This option cannot be used with the \fB\-s\fR option\&. - .RE - .SH "SEE ALSO" - .PP +.RE +.SH "SEE ALSO" +.PP \fBnsupdate\fR(1), \fBnamed.conf\fR(5), \fBnamed\fR(8), diff --git a/bin/confgen/ddns-confgen.html b/bin/confgen/ddns-confgen.html index fbf723cb0f..1485a104ad 100644 --- a/bin/confgen/ddns-confgen.html +++ b/bin/confgen/ddns-confgen.html @@ -14,63 +14,31 @@
- - - - - -
+

Name

-

- ddns-confgen - — ddns key generation tool -

+

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 - ] -

-
- -
+

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 @@ -80,8 +48,7 @@ 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 @@ -91,32 +58,24 @@ 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 @@ -126,19 +85,15 @@ 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 @@ -148,11 +103,9 @@ 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 @@ -163,11 +116,9 @@ 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 @@ -177,26 +128,16 @@ 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.8 b/bin/confgen/rndc-confgen.8 index d8ca78b55b..eb8be28e95 100644 --- a/bin/confgen/rndc-confgen.8 +++ b/bin/confgen/rndc-confgen.8 @@ -35,24 +35,13 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" rndc-confgen \- rndc key generation tool - .SH "SYNOPSIS" - .HP \w'\fBrndc\-confgen\fR\ 'u - \fBrndc\-confgen\fR - [\fB\-a\fR] - [\fB\-A\ \fR\fB\fIalgorithm\fR\fR] - [\fB\-b\ \fR\fB\fIkeysize\fR\fR] - [\fB\-c\ \fR\fB\fIkeyfile\fR\fR] - [\fB\-h\fR] - [\fB\-k\ \fR\fB\fIkeyname\fR\fR] - [\fB\-p\ \fR\fB\fIport\fR\fR] - [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] - [\fB\-s\ \fR\fB\fIaddress\fR\fR] - [\fB\-t\ \fR\fB\fIchrootdir\fR\fR] - [\fB\-u\ \fR\fB\fIuser\fR\fR] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBrndc\-confgen\fR\ 'u +\fBrndc\-confgen\fR [\fB\-a\fR] [\fB\-A\ \fR\fB\fIalgorithm\fR\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-c\ \fR\fB\fIkeyfile\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\fB\-s\ \fR\fB\fIaddress\fR\fR] [\fB\-t\ \fR\fB\fIchrootdir\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] +.SH "DESCRIPTION" +.PP \fBrndc\-confgen\fR generates configuration files for \fBrndc\fR\&. It can be used as a convenient alternative to writing the @@ -72,11 +61,11 @@ rndc\&.conf file and a \fBcontrols\fR statement altogether\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-a .RS 4 - Do automatic +Do automatic \fBrndc\fR configuration\&. This creates a file rndc\&.key @@ -98,7 +87,7 @@ to communicate with \fBnamed\fR on the local host with no further configuration\&. .sp - Running +Running \fBrndc\-confgen \-a\fR allows BIND 9 and \fBrndc\fR @@ -107,7 +96,7 @@ to be used as drop\-in replacements for BIND 8 and named\&.conf file\&. .sp - If a more elaborate configuration than that generated by +If a more elaborate configuration than that generated by \fBrndc\-confgen \-a\fR is required, for example if rndc is to be used remotely, you should run \fBrndc\-confgen\fR @@ -118,68 +107,68 @@ rndc\&.conf and named\&.conf as directed\&. - .RE - .PP +.RE +.PP \-A \fIalgorithm\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-b \fIkeysize\fR .RS 4 - Specifies the size of the authentication key in bits\&. Must be between 1 and 512 bits; the default is the hash size\&. - .RE - .PP +Specifies the size of the authentication key in bits\&. Must be between 1 and 512 bits; the default is the hash size\&. +.RE +.PP \-c \fIkeyfile\fR .RS 4 - Used with the +Used with the \fB\-a\fR option to specify an alternate location for rndc\&.key\&. - .RE - .PP +.RE +.PP \-h .RS 4 - Prints a short summary of the options and arguments to +Prints a short summary of the options and arguments to \fBrndc\-confgen\fR\&. - .RE - .PP +.RE +.PP \-k \fIkeyname\fR .RS 4 - Specifies the key name of the rndc authentication key\&. This must be a valid domain name\&. The default is +Specifies the key name of the rndc authentication key\&. This must be a valid domain name\&. The default is \fBrndc\-key\fR\&. - .RE - .PP +.RE +.PP \-p \fIport\fR .RS 4 - Specifies the command channel port where +Specifies the command channel port where \fBnamed\fR listens for connections from \fBrndc\fR\&. The default is 953\&. - .RE - .PP +.RE +.PP \-r \fIrandomfile\fR .RS 4 - Specifies a source of random data for generating the authorization\&. If the operating system does not provide a +Specifies a source of random data for generating the authorization\&. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness is keyboard input\&. randomdev specifies the name of a character device or file containing random data to be used instead of the default\&. The special value keyboard indicates that keyboard input should be used\&. - .RE - .PP +.RE +.PP \-s \fIaddress\fR .RS 4 - Specifies the IP address where +Specifies the IP address where \fBnamed\fR listens for command channel connections from \fBrndc\fR\&. The default is the loopback address 127\&.0\&.0\&.1\&. - .RE - .PP +.RE +.PP \-t \fIchrootdir\fR .RS 4 - Used with the +Used with the \fB\-a\fR option to specify a directory where \fBnamed\fR @@ -187,26 +176,26 @@ 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 \fBnamed\fR\&. - .RE - .PP +.RE +.PP \-u \fIuser\fR .RS 4 - Used with the +Used with the \fB\-a\fR option to set the owner of the rndc\&.key file generated\&. If \fB\-t\fR is also specified only the file in the chroot area has its owner changed\&. - .RE - .SH "EXAMPLES" - .PP +.RE +.SH "EXAMPLES" +.PP To allow \fBrndc\fR to be used with no manual configuration, run - .PP +.PP \fBrndc\-confgen \-a\fR - .PP +.PP To print a sample rndc\&.conf file and corresponding @@ -215,10 +204,10 @@ and \fBkey\fR statements to be manually inserted into named\&.conf, run - .PP +.PP \fBrndc\-confgen\fR - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBrndc\fR(8), \fBrndc.conf\fR(5), \fBnamed\fR(8), diff --git a/bin/confgen/rndc-confgen.html b/bin/confgen/rndc-confgen.html index 46a5e20384..d34a294756 100644 --- a/bin/confgen/rndc-confgen.html +++ b/bin/confgen/rndc-confgen.html @@ -14,43 +14,17 @@
- - - - - -
+

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 @@ -63,17 +37,13 @@ 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 @@ -88,7 +58,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 @@ -96,7 +66,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, @@ -107,57 +77,44 @@ 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 @@ -168,30 +125,24 @@ 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. @@ -199,45 +150,33 @@ -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.1 b/bin/delv/delv.1 index de1d902644..276125d71a 100644 --- a/bin/delv/delv.1 +++ b/bin/delv/delv.1 @@ -35,67 +35,44 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" delv \- DNS lookup and validation utility - .SH "SYNOPSIS" - .HP \w'\fBdelv\fR\ 'u - \fBdelv\fR - [@server] - [ - | [\fB\-4\fR] - | [\fB\-6\fR] - ] - [\fB\-a\ \fR\fB\fIanchor\-file\fR\fR] - [\fB\-b\ \fR\fB\fIaddress\fR\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-d\ \fR\fB\fIlevel\fR\fR] - [\fB\-i\fR] - [\fB\-m\fR] - [\fB\-p\ \fR\fB\fIport#\fR\fR] - [\fB\-q\ \fR\fB\fIname\fR\fR] - [\fB\-t\ \fR\fB\fItype\fR\fR] - [\fB\-x\ \fR\fB\fIaddr\fR\fR] - [name] - [type] - [class] - [queryopt...] - .HP \w'\fBdelv\fR\ 'u - \fBdelv\fR - [\fB\-h\fR] - .HP \w'\fBdelv\fR\ 'u - \fBdelv\fR - [\fB\-v\fR] - .HP \w'\fBdelv\fR\ 'u - \fBdelv\fR - [queryopt...] - [query...] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdelv\fR\ 'u +\fBdelv\fR [@server] [[\fB\-4\fR] | [\fB\-6\fR]] [\fB\-a\ \fR\fB\fIanchor\-file\fR\fR] [\fB\-b\ \fR\fB\fIaddress\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-d\ \fR\fB\fIlevel\fR\fR] [\fB\-i\fR] [\fB\-m\fR] [\fB\-p\ \fR\fB\fIport#\fR\fR] [\fB\-q\ \fR\fB\fIname\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-x\ \fR\fB\fIaddr\fR\fR] [name] [type] [class] [queryopt...] +.HP \w'\fBdelv\fR\ 'u +\fBdelv\fR [\fB\-h\fR] +.HP \w'\fBdelv\fR\ 'u +\fBdelv\fR [\fB\-v\fR] +.HP \w'\fBdelv\fR\ 'u +\fBdelv\fR [queryopt...] [query...] +.SH "DESCRIPTION" +.PP \fBdelv\fR is a tool for sending DNS queries and validating the results, using the same internal resolver and validator logic as \fBnamed\fR\&. - .PP +.PP \fBdelv\fR 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 CNAME or DNAME chains, and queries for DNSKEY, DS and DLV records to establish a chain of trust for DNSSEC validation\&. It does not perform iterative resolution, but simulates the behavior of a name server configured for DNSSEC validating and forwarding\&. - .PP +.PP By default, responses are validated using built\-in DNSSEC trust anchor for the root zone ("\&.")\&. Records returned by \fBdelv\fR are either fully validated or were not signed\&. If validation fails, an explanation of the failure is included in the output; the validation process can be traced in detail\&. Because \fBdelv\fR does not rely on an external server to carry out validation, it can be used to check the validity of DNS responses in environments where local name servers may not be trustworthy\&. - .PP +.PP Unless it is told to query a specific name server, \fBdelv\fR will try each of the servers listed in /etc/resolv\&.conf\&. If no usable server addresses are found, \fBdelv\fR will send queries to the localhost addresses (127\&.0\&.0\&.1 for IPv4, ::1 for IPv6)\&. - .PP +.PP When no command line arguments or options are given, \fBdelv\fR will perform an NS query for "\&." (the root zone)\&. - .SH "SIMPLE USAGE" - .PP +.SH "SIMPLE USAGE" +.PP A typical invocation of \fBdelv\fR looks like: @@ -111,10 +88,10 @@ looks like: .\} .sp where: - .PP +.PP \fBserver\fR .RS 4 - 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 +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 \fIserver\fR argument is a hostname, \fBdelv\fR @@ -122,7 +99,7 @@ resolves that name before querying that name server (note, however, that this in \fInot\fR validated by DNSSEC)\&. .sp - If no +If no \fIserver\fR argument is provided, \fBdelv\fR @@ -134,39 +111,39 @@ or options are in use, then only addresses for the corresponding transport will be tried\&. If no usable addresses are found, \fBdelv\fR will send queries to the localhost addresses (127\&.0\&.0\&.1 for IPv4, ::1 for IPv6)\&. - .RE - .PP +.RE +.PP \fBname\fR .RS 4 - is the domain name to be looked up\&. - .RE - .PP +is the domain name to be looked up\&. +.RE +.PP \fBtype\fR .RS 4 - indicates what type of query is required \(em ANY, A, MX, etc\&. +indicates what type of query is required \(em ANY, A, MX, etc\&. \fItype\fR can be any valid query type\&. If no \fItype\fR argument is supplied, \fBdelv\fR will perform a lookup for an A record\&. - .RE - .SH "OPTIONS" - .PP +.RE +.SH "OPTIONS" +.PP \-a \fIanchor\-file\fR .RS 4 - Specifies a file from which to read DNSSEC trust anchors\&. The default is +Specifies a file from which to read DNSSEC trust anchors\&. The default is /etc/bind\&.keys, which is included with BIND 9 and contains one or more trust anchors for the root zone ("\&.")\&. .sp - Keys that do not match the root zone name are ignored\&. An alternate key name can be specified using the +Keys that do not match the root zone name are ignored\&. An alternate key name can be specified using the \fB+root=NAME\fR options\&. DNSSEC Lookaside Validation can also be turned on by using the \fB+dlv=NAME\fR to specify the name of a zone containing DLV records\&. .sp - Note: When reading the trust anchor file, +Note: When reading the trust anchor file, \fBdelv\fR treats \fBmanaged\-keys\fR @@ -183,24 +160,24 @@ is revoked and rolled over, it will be necessary to update /etc/bind\&.keys to use DNSSEC validation in \fBdelv\fR\&. - .RE - .PP +.RE +.PP \-b \fIaddress\fR .RS 4 - Sets the source IP address of the query to +Sets the source IP address of the query to \fIaddress\fR\&. This must be a valid address on one of the host\*(Aqs network interfaces or "0\&.0\&.0\&.0" or "::"\&. An optional source port may be specified by appending "#" - .RE - .PP +.RE +.PP \-c \fIclass\fR .RS 4 - Sets the query class for the requested data\&. Currently, only class "IN" is supported in +Sets the query class for the requested data\&. Currently, only class "IN" is supported in \fBdelv\fR and any other value is ignored\&. - .RE - .PP +.RE +.PP \-d \fIlevel\fR .RS 4 - Set the systemwide debug level to +Set the systemwide debug level to \fBlevel\fR\&. The allowed range is from 0 to 99\&. The default is 0 (no debugging)\&. Debugging traces from \fBdelv\fR become more verbose as the debug level increases\&. See the @@ -208,61 +185,61 @@ become more verbose as the debug level increases\&. See the \fB+rtrace\fR, and \fB+vtrace\fR options below for additional debugging details\&. - .RE - .PP +.RE +.PP \-h .RS 4 - Display the +Display the \fBdelv\fR help usage output and exit\&. - .RE - .PP +.RE +.PP \-i .RS 4 - 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 validation, then it will not return invalid data; this can cause +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 validation, then it will not return invalid data; this can cause \fBdelv\fR to time out\&. When it is necessary to examine invalid data to debug a DNSSEC problem, use \fBdig +cd\fR\&.) - .RE - .PP +.RE +.PP \-m .RS 4 - Enables memory usage debugging\&. - .RE - .PP +Enables memory usage debugging\&. +.RE +.PP \-p \fIport#\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-q \fIname\fR .RS 4 - Sets the query name to +Sets the query name to \fIname\fR\&. While the query name can be specified without using the \fB\-q\fR, 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)\&. - .RE - .PP +.RE +.PP \-t \fItype\fR .RS 4 - Sets the query type to +Sets the query type to \fItype\fR, which can be any valid query type supported in BIND 9 except for zone transfer types AXFR and IXFR\&. As with \fB\-q\fR, this is useful to distinguish query name type or class when they are ambiguous\&. it is sometimes necessary to disambiguate names from types\&. .sp - The default query type is "A", unless the +The default query type is "A", unless the \fB\-x\fR option is supplied to indicate a reverse lookup, in which case it is "PTR"\&. - .RE - .PP +.RE +.PP \-v .RS 4 - Print the +Print the \fBdelv\fR version and exit\&. - .RE - .PP +.RE +.PP \-x \fIaddr\fR .RS 4 - Performs a reverse lookup, mapping an addresses to a name\&. +Performs a reverse lookup, mapping an addresses to a name\&. \fIaddr\fR is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address\&. When \fB\-x\fR @@ -275,108 +252,108 @@ arguments\&. automatically performs a 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\&. - .RE - .PP +.RE +.PP \-4 .RS 4 - Forces +Forces \fBdelv\fR to only use IPv4\&. - .RE - .PP +.RE +.PP \-6 .RS 4 - Forces +Forces \fBdelv\fR to only use IPv6\&. - .RE - .SH "QUERY OPTIONS" - .PP +.RE +.SH "QUERY OPTIONS" +.PP \fBdelv\fR provides a number of query options which affect the way results are displayed, and in some cases the way lookups are performed\&. - .PP +.PP 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 no to negate the meaning of that keyword\&. Other keywords assign values to options like the timeout interval\&. They have the form \fB+keyword=value\fR\&. The query options are: - .PP +.PP \fB+[no]cdflag\fR .RS 4 - Controls whether to set the CD (checking disabled) bit in queries sent by +Controls whether to set the CD (checking disabled) bit in queries sent by \fBdelv\fR\&. This may be useful when troubleshooting DNSSEC problems from behind a validating resolver\&. A validating resolver will block invalid responses, making it difficult to retrieve them for analysis\&. Setting the CD flag on queries will cause the resolver to return invalid responses, which \fBdelv\fR can then validate internally and report the errors in detail\&. - .RE - .PP +.RE +.PP \fB+[no]class\fR .RS 4 - Controls whether to display the CLASS when printing a record\&. The default is to display the CLASS\&. - .RE - .PP +Controls whether to display the CLASS when printing a record\&. The default is to display the CLASS\&. +.RE +.PP \fB+[no]ttl\fR .RS 4 - Controls whether to display the TTL when printing a record\&. The default is to display the TTL\&. - .RE - .PP +Controls whether to display the TTL when printing a record\&. The default is to display the TTL\&. +.RE +.PP \fB+[no]rtrace\fR .RS 4 - Toggle resolver fetch logging\&. This reports the name and type of each query sent by +Toggle resolver fetch logging\&. This reports the name and type of each query sent by \fBdelv\fR in the process of carrying out the resolution and validation process: this includes including the original query and all subsequent queries to follow CNAMEs and to establish a chain of trust for DNSSEC validation\&. .sp - This is equivalent to setting the debug level to 1 in the "resolver" logging category\&. Setting the systemwide debug level to 1 using the +This is equivalent to setting the debug level to 1 in the "resolver" logging category\&. Setting the systemwide debug level to 1 using the \fB\-d\fR option will product the same output (but will affect other logging categories as well)\&. - .RE - .PP +.RE +.PP \fB+[no]mtrace\fR .RS 4 - Toggle message logging\&. This produces a detailed dump of the responses received by +Toggle message logging\&. This produces a detailed dump of the responses received by \fBdelv\fR in the process of carrying out the resolution and validation process\&. .sp - This is equivalent to setting the debug level to 10 for the "packets" module of the "resolver" logging category\&. Setting the systemwide debug level to 10 using the +This is equivalent to setting the debug level to 10 for the "packets" module of the "resolver" logging category\&. Setting the systemwide debug level to 10 using the \fB\-d\fR option will produce the same output (but will affect other logging categories as well)\&. - .RE - .PP +.RE +.PP \fB+[no]vtrace\fR .RS 4 - Toggle validation logging\&. This shows the internal process of the validator as it determines whether an answer is validly signed, unsigned, or invalid\&. +Toggle validation logging\&. This shows the internal process of the validator as it determines whether an answer is validly signed, unsigned, or invalid\&. .sp - This is equivalent to setting the debug level to 3 for the "validator" module of the "dnssec" logging category\&. Setting the systemwide debug level to 3 using the +This is equivalent to setting the debug level to 3 for the "validator" module of the "dnssec" logging category\&. Setting the systemwide debug level to 3 using the \fB\-d\fR option will produce the same output (but will affect other logging categories as well)\&. - .RE - .PP +.RE +.PP \fB+[no]short\fR .RS 4 - Provide a terse answer\&. The default is to print the answer in a verbose form\&. - .RE - .PP +Provide a terse answer\&. The default is to print the answer in a verbose form\&. +.RE +.PP \fB+[no]comments\fR .RS 4 - Toggle the display of comment lines in the output\&. The default is to print comments\&. - .RE - .PP +Toggle the display of comment lines in the output\&. The default is to print comments\&. +.RE +.PP \fB+[no]rrcomments\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fB+[no]crypto\fR .RS 4 - 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 the common failures\&. The default is to display the fields\&. 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 ]"\&. - .RE - .PP +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 the common failures\&. The default is to display the fields\&. 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 ]"\&. +.RE +.PP \fB+[no]trust\fR .RS 4 - Controls whether to display the trust level when printing a record\&. The default is to display the trust level\&. - .RE - .PP +Controls whether to display the trust level when printing a record\&. The default is to display the trust level\&. +.RE +.PP \fB+[no]split[=W]\fR .RS 4 - Split long hex\- or base64\-formatted fields in resource records into chunks of +Split long hex\- or base64\-formatted fields in resource records into chunks of \fIW\fR characters (where \fIW\fR @@ -385,27 +362,27 @@ is rounded up to the nearest multiple of 4)\&. or \fI+split=0\fR causes fields not to be split at all\&. The default is 56 characters, or 44 characters when multiline mode is active\&. - .RE - .PP +.RE +.PP \fB+[no]all\fR .RS 4 - Set or clear the display options +Set or clear the display options \fB+[no]comments\fR, \fB+[no]rrcomments\fR, and \fB+[no]trust\fR as a group\&. - .RE - .PP +.RE +.PP \fB+[no]multiline\fR .RS 4 - 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 +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 \fBdelv\fR output\&. - .RE - .PP +.RE +.PP \fB+[no]dnssec\fR .RS 4 - Indicates whether to display RRSIG records in the +Indicates whether to display RRSIG records in the \fBdelv\fR output\&. The default is to do so\&. Note that (unlike in \fBdig\fR) this does @@ -416,38 +393,38 @@ or \fB+noroot\fR and \fB+nodlv\fR\&. - .RE - .PP +.RE +.PP \fB+[no]root[=ROOT]\fR .RS 4 - 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 a trust anchor of "\&." (the root zone), for which there is a built\-in key\&. If specifying a different trust anchor, then +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 a trust anchor of "\&." (the root zone), for which there is a built\-in key\&. If specifying a different trust anchor, then \fB\-a\fR must be used to specify a file containing the key\&. - .RE - .PP +.RE +.PP \fB+[no]dlv[=DLV]\fR .RS 4 - Indicates whether to perform DNSSEC lookaside validation, and if so, specifies the name of the DLV trust anchor\&. The +Indicates whether to perform DNSSEC lookaside validation, and if so, specifies the name of the DLV trust anchor\&. The \fB\-a\fR option must also be used to specify a file containing the DLV key\&. - .RE - .PP +.RE +.PP \fB+[no]tcp\fR .RS 4 - Controls whether to use TCP when sending queries\&. The default is to use UDP unless a truncated response has been received\&. - .RE - .PP +Controls whether to use TCP when sending queries\&. The default is to use UDP unless a truncated response has been received\&. +.RE +.PP \fB+[no]unknownformat\fR .RS 4 - Print all RDATA in unknown RR type presentation format (RFC 3597)\&. The default is to print RDATA for known types in the type\*(Aqs presentation format\&. - .RE - .SH "FILES" - .PP +Print all RDATA in unknown RR type presentation format (RFC 3597)\&. The default is to print RDATA for known types in the type\*(Aqs presentation format\&. +.RE +.SH "FILES" +.PP /etc/bind\&.keys - .PP +.PP /etc/resolv\&.conf - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBdig\fR(1), \fBnamed\fR(8), RFC4034, diff --git a/bin/delv/delv.html b/bin/delv/delv.html index ce31744f45..96f13c1c35 100644 --- a/bin/delv/delv.html +++ b/bin/delv/delv.html @@ -14,72 +14,25 @@
- - - - - -
+

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 is a tool for sending DNS queries and validating the results, using 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 @@ -89,7 +42,7 @@ behavior of a name server configured for DNSSEC validating and forwarding.

-

+

By default, responses are validated using built-in DNSSEC trust anchor for the root zone ("."). Records returned by delv are either fully validated or @@ -100,7 +53,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 @@ -108,18 +61,15 @@ 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
@@ -130,7 +80,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 @@ -140,7 +90,7 @@ initial lookup is not validated by DNSSEC).

-

+

If no server argument is provided, delv consults /etc/resolv.conf; if an @@ -153,16 +103,13 @@ 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 @@ -170,27 +117,23 @@ 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 one or more trust anchors for the root zone (".").

-

+

Keys that do not match the root zone name are ignored. An alternate key name can be specified using the +root=NAME options. DNSSEC Lookaside @@ -198,7 +141,7 @@ +dlv=NAME to specify the name of a zone containing DLV records.

-

+

Note: When reading the trust anchor file, delv treats managed-keys statements and trusted-keys statements @@ -212,28 +155,23 @@ /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). @@ -242,17 +180,13 @@ 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 @@ -260,37 +194,30 @@ 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 @@ -298,21 +225,18 @@ 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. @@ -322,33 +246,24 @@ 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 @@ -360,8 +275,7 @@

+[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 @@ -370,25 +284,20 @@ 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 @@ -396,69 +305,62 @@ 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 "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 "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 @@ -466,18 +368,14 @@ 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 @@ -486,30 +384,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]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) @@ -519,11 +411,9 @@ 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 @@ -531,62 +421,46 @@ 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 -a option must also be used to specify a file containing the DLV key. -

-
+

+[no]tcp
-
-

+

Controls whether to use TCP when sending queries. The default is to use UDP unless a truncated response has been received. -

-
+

+[no]unknownformat
-
-

+

Print all RDATA in unknown RR type presentation format (RFC 3597). The default is to print RDATA for known types in the type's presentation format. -

-
+

-
- -
+
+

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.1 b/bin/dig/dig.1 index 1b7d09a38e..d9ea58eb94 100644 --- a/bin/dig/dig.1 +++ b/bin/dig/dig.1 @@ -35,46 +35,23 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dig \- DNS lookup utility - .SH "SYNOPSIS" - .HP \w'\fBdig\fR\ 'u - \fBdig\fR - [@server] - [\fB\-b\ \fR\fB\fIaddress\fR\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-f\ \fR\fB\fIfilename\fR\fR] - [\fB\-k\ \fR\fB\fIfilename\fR\fR] - [\fB\-m\fR] - [\fB\-p\ \fR\fB\fIport#\fR\fR] - [\fB\-q\ \fR\fB\fIname\fR\fR] - [\fB\-t\ \fR\fB\fItype\fR\fR] - [\fB\-v\fR] - [\fB\-x\ \fR\fB\fIaddr\fR\fR] - [\fB\-y\ \fR\fB\fI[hmac:]\fR\fIname:key\fR\fR] - [ - | [\fB\-4\fR] - | [\fB\-6\fR] - ] - [name] - [type] - [class] - [queryopt...] - .HP \w'\fBdig\fR\ 'u - \fBdig\fR - [\fB\-h\fR] - .HP \w'\fBdig\fR\ 'u - \fBdig\fR - [global\-queryopt...] - [query...] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdig\fR\ 'u +\fBdig\fR [@server] [\fB\-b\ \fR\fB\fIaddress\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-f\ \fR\fB\fIfilename\fR\fR] [\fB\-k\ \fR\fB\fIfilename\fR\fR] [\fB\-m\fR] [\fB\-p\ \fR\fB\fIport#\fR\fR] [\fB\-q\ \fR\fB\fIname\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\fR] [\fB\-x\ \fR\fB\fIaddr\fR\fR] [\fB\-y\ \fR\fB\fI[hmac:]\fR\fIname:key\fR\fR] [[\fB\-4\fR] | [\fB\-6\fR]] [name] [type] [class] [queryopt...] +.HP \w'\fBdig\fR\ 'u +\fBdig\fR [\fB\-h\fR] +.HP \w'\fBdig\fR\ 'u +\fBdig\fR [global\-queryopt...] [query...] +.SH "DESCRIPTION" +.PP \fBdig\fR 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 were queried\&. Most DNS administrators use \fBdig\fR to troubleshoot DNS problems because of its flexibility, ease of use and clarity of output\&. Other lookup tools tend to have less functionality than \fBdig\fR\&. - .PP +.PP Although \fBdig\fR is normally used with command\-line arguments, it also has a batch mode of operation for reading lookup requests from a file\&. A brief summary of its command\-line arguments and options is printed when the @@ -82,25 +59,25 @@ is normally used with command\-line arguments, it also has a batch mode of opera option is given\&. Unlike earlier versions, the BIND 9 implementation of \fBdig\fR allows multiple lookups to be issued from the command line\&. - .PP +.PP Unless it is told to query a specific name server, \fBdig\fR will try each of the servers listed in /etc/resolv\&.conf\&. If no usable server addresses are found, \fBdig\fR will send the query to the local host\&. - .PP +.PP When no command line arguments or options are given, \fBdig\fR will perform an NS query for "\&." (the root)\&. - .PP +.PP It is possible to set per\-user defaults for \fBdig\fR via ${HOME}/\&.digrc\&. This file is read and any options in it are applied before the command line arguments\&. The \fB\-r\fR option disables this feature, for scripts that need predictable behaviour\&. - .PP +.PP The IN and CH class names overlap with the IN and CH top level domain names\&. Either use the \fB\-t\fR and @@ -108,8 +85,8 @@ and options to specify the type and class, use the \fB\-q\fR the specify the domain name, or use "IN\&." and "CH\&." when looking up these top level domains\&. - .SH "SIMPLE USAGE" - .PP +.SH "SIMPLE USAGE" +.PP A typical invocation of \fBdig\fR looks like: @@ -125,16 +102,16 @@ looks like: .\} .sp where: - .PP +.PP \fBserver\fR .RS 4 - 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 +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 \fIserver\fR argument is a hostname, \fBdig\fR resolves that name before querying that name server\&. .sp - If no +If no \fIserver\fR argument is provided, \fBdig\fR @@ -146,67 +123,67 @@ or options are in use, then only addresses for the corresponding transport will be tried\&. If no usable addresses are found, \fBdig\fR will send the query to the local host\&. The reply from the name server that responds is displayed\&. - .RE - .PP +.RE +.PP \fBname\fR .RS 4 - is the name of the resource record that is to be looked up\&. - .RE - .PP +is the name of the resource record that is to be looked up\&. +.RE +.PP \fBtype\fR .RS 4 - indicates what type of query is required \(em ANY, A, MX, SIG, etc\&. +indicates what type of query is required \(em ANY, A, MX, SIG, etc\&. \fItype\fR can be any valid query type\&. If no \fItype\fR argument is supplied, \fBdig\fR will perform a lookup for an A record\&. - .RE - .SH "OPTIONS" - .PP +.RE +.SH "OPTIONS" +.PP \-4 .RS 4 - Use IPv4 only\&. - .RE - .PP +Use IPv4 only\&. +.RE +.PP \-6 .RS 4 - Use IPv6 only\&. - .RE - .PP +Use IPv6 only\&. +.RE +.PP \-b \fIaddress\fR\fI[#port]\fR .RS 4 - Set the source IP address of the query\&. The +Set the source IP address of the query\&. The \fIaddress\fR must be a valid address on one of the host\*(Aqs network interfaces, or "0\&.0\&.0\&.0" or "::"\&. An optional port may be specified by appending "#" - .RE - .PP +.RE +.PP \-c \fIclass\fR .RS 4 - Set the query class\&. The default +Set the query class\&. The default \fIclass\fR is IN; other classes are HS for Hesiod records or CH for Chaosnet records\&. - .RE - .PP +.RE +.PP \-f \fIfile\fR .RS 4 - Batch mode: +Batch mode: \fBdig\fR reads a list of lookup requests to process from the given \fIfile\fR\&. Each line in the file should be organized in the same way they would be presented as queries to \fBdig\fR using the command\-line interface\&. - .RE - .PP +.RE +.PP \-i .RS 4 - Do reverse IPv6 lookups using the obsolete RFC 1886 IP6\&.INT domain, which is no longer in use\&. Obsolete bit string label queries (RFC 2874) are not attempted\&. - .RE - .PP +Do reverse IPv6 lookups using the obsolete RFC 1886 IP6\&.INT domain, which is no longer in use\&. Obsolete bit string label queries (RFC 2874) are not attempted\&. +.RE +.PP \-k \fIkeyfile\fR .RS 4 - Sign queries using TSIG using a key read from the given file\&. Key files can be generated using +Sign queries using TSIG using a key read from the given file\&. Key files can be generated using \fBtsig-keygen\fR(8)\&. When using TSIG authentication with \fBdig\fR, 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 \fBkey\fR @@ -214,34 +191,34 @@ and \fBserver\fR statements in named\&.conf\&. - .RE - .PP +.RE +.PP \-m .RS 4 - Enable memory usage debugging\&. - .RE - .PP +Enable memory usage debugging\&. +.RE +.PP \-p \fIport\fR .RS 4 - Send the query to a non\-standard port on the server, instead of the default 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\&. - .RE - .PP +Send the query to a non\-standard port on the server, instead of the default 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\&. +.RE +.PP \-q \fIname\fR .RS 4 - The domain name to query\&. This is useful to distinguish the +The domain name to query\&. This is useful to distinguish the \fIname\fR from other arguments\&. - .RE - .PP +.RE +.PP \-r .RS 4 - Do not read options from +Do not read options from ${HOME}/\&.digrc\&. This is useful for scripts that need predictable behaviour\&. - .RE - .PP +.RE +.PP \-t \fItype\fR .RS 4 - The resource record type to query\&. It can be any valid query type\&. If it is a resource record type supported in BIND 9, it can be given by the type mnemonic (such as "NS" or "AAAA")\&. The default query type is "A", unless the +The resource record type to query\&. It can be any valid query type\&. If it is a resource record type supported in BIND 9, it can be given by the type mnemonic (such as "NS" or "AAAA")\&. The default query type is "A", unless the \fB\-x\fR option is supplied to indicate a reverse lookup\&. A zone transfer can be requested by specifying a type of AXFR\&. When an incremental zone transfer (IXFR) is required, set the \fItype\fR @@ -249,22 +226,22 @@ to ixfr=N\&. The incremental zone transfer will contain the changes made to the zone since the serial number in the zone\*(Aqs SOA record was \fIN\fR\&. .sp - All resource record types can be expressed as "TYPEnn", where "nn" is the number of the type\&. If the resource record type is not supported in BIND 9, the result will be displayed as described in RFC 3597\&. - .RE - .PP +All resource record types can be expressed as "TYPEnn", where "nn" is the number of the type\&. If the resource record type is not supported in BIND 9, the result will be displayed as described in RFC 3597\&. +.RE +.PP \-u .RS 4 - Print query times in microseconds instead of milliseconds\&. - .RE - .PP +Print query times in microseconds instead of milliseconds\&. +.RE +.PP \-v .RS 4 - Print the version number and exit\&. - .RE - .PP +Print the version number and exit\&. +.RE +.PP \-x \fIaddr\fR .RS 4 - Simplified reverse lookups, for mapping addresses to names\&. The +Simplified reverse lookups, for mapping addresses to names\&. The \fIaddr\fR is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address\&. When the \fB\-x\fR @@ -280,11 +257,11 @@ automatically performs a lookup for a name like and sets the query type and class to PTR and IN respectively\&. IPv6 addresses are looked up using nibble format under the IP6\&.ARPA domain (but see also the \fB\-i\fR option)\&. - .RE - .PP +.RE +.PP \-y \fI[hmac:]\fR\fIkeyname:secret\fR .RS 4 - Sign queries using TSIG with the given authentication key\&. +Sign queries using TSIG with the given authentication key\&. \fIkeyname\fR is the name of the key, and \fIsecret\fR @@ -303,7 +280,7 @@ hmac\-md5 or if MD5 was disabled hmac\-sha256\&. .sp - NOTE: You should use the +NOTE: You should use the \fB\-k\fR option and avoid the \fB\-y\fR @@ -312,12 +289,12 @@ option, because with the shared secret is supplied as a command line argument in clear text\&. This may be visible in the output from \fBps\fR(1) or in a history file maintained by the user\*(Aqs shell\&. - .RE - .SH "QUERY OPTIONS" - .PP +.RE +.SH "QUERY OPTIONS" +.PP \fBdig\fR 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\&. - .PP +.PP 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 no to negate the meaning of that keyword\&. Other keywords assign values to options like the timeout interval\&. They have the form @@ -325,56 +302,56 @@ to negate the meaning of that keyword\&. Other keywords assign values to options +cd is equivalent to +cdflag\&. The query options are: - .PP +.PP \fB+[no]aaflag\fR .RS 4 - A synonym for +A synonym for \fI+[no]aaonly\fR\&. - .RE - .PP +.RE +.PP \fB+[no]aaonly\fR .RS 4 - Sets the "aa" flag in the query\&. - .RE - .PP +Sets the "aa" flag in the query\&. +.RE +.PP \fB+[no]additional\fR .RS 4 - Display [do not display] the additional section of a reply\&. The default is to display it\&. - .RE - .PP +Display [do not display] the additional section of a reply\&. The default is to display it\&. +.RE +.PP \fB+[no]adflag\fR .RS 4 - 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 been validated as secure according to the security policy of the server\&. AD=1 indicates that all records have been validated as secure and the answer is not 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\&. - .RE - .PP +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 been validated as secure according to the security policy of the server\&. AD=1 indicates that all records have been validated as secure and the answer is not 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\&. +.RE +.PP \fB+[no]all\fR .RS 4 - Set or clear all display flags\&. - .RE - .PP +Set or clear all display flags\&. +.RE +.PP \fB+[no]answer\fR .RS 4 - Display [do not display] the answer section of a reply\&. The default is to display it\&. - .RE - .PP +Display [do not display] the answer section of a reply\&. The default is to display it\&. +.RE +.PP \fB+[no]authority\fR .RS 4 - Display [do not display] the authority section of a reply\&. The default is to display it\&. - .RE - .PP +Display [do not display] the authority section of a reply\&. The default is to display it\&. +.RE +.PP \fB+[no]badcookie\fR .RS 4 - Retry lookup with the new server cookie if a BADCOOKIE response is received\&. - .RE - .PP +Retry lookup with the new server cookie if a BADCOOKIE response is received\&. +.RE +.PP \fB+[no]besteffort\fR .RS 4 - Attempt to display the contents of messages which are malformed\&. The default is to not display malformed answers\&. - .RE - .PP +Attempt to display the contents of messages which are malformed\&. The default is to not display malformed answers\&. +.RE +.PP \fB+bufsize=B\fR .RS 4 - This option sets the UDP message buffer size advertised using EDNS0 to +This option sets the UDP message buffer size advertised using EDNS0 to \fIB\fR bytes\&. The maximum and minimum sizes of this buffer are 65535 and 0, respectively\&. +bufsize=0 @@ -383,97 +360,97 @@ disables EDNS (use to send a EDNS messages with a advertised size of 0 bytes)\&. +bufsize restores the default buffer size\&. - .RE - .PP +.RE +.PP \fB+[no]cdflag\fR .RS 4 - Set [do not set] the CD (checking disabled) bit in the query\&. This requests the server to not perform DNSSEC validation of responses\&. - .RE - .PP +Set [do not set] the CD (checking disabled) bit in the query\&. This requests the server to not perform DNSSEC validation of responses\&. +.RE +.PP \fB+[no]class\fR .RS 4 - Display [do not display] the CLASS when printing the record\&. - .RE - .PP +Display [do not display] the CLASS when printing the record\&. +.RE +.PP \fB+[no]cmd\fR .RS 4 - Toggles the printing of the initial comment in the output, identifying the version of +Toggles the printing of the initial comment in the output, identifying the version of \fBdig\fR and the query options that have been applied\&. This option always has global effect; it cannot be set globally and then overridden on a per\-lookup basis\&. The default is to print this comment\&. - .RE - .PP +.RE +.PP \fB+[no]comments\fR .RS 4 - Toggles the display of some comment lines in the output, containing information about the packet header and OPT pseudosection, and the names of the response section\&. The default is to print these comments\&. +Toggles the display of some comment lines in the output, containing information about the packet header and OPT pseudosection, and the names of the response section\&. The default is to print these comments\&. .sp - Other types of comments in the output are not affected by this option, but can be controlled using other command line switches\&. These include +Other types of comments in the output are not affected by this option, but can be controlled using other command line switches\&. These include \fB+[no]cmd\fR, \fB+[no]question\fR, \fB+[no]stats\fR, and \fB+[no]rrcomments\fR\&. - .RE - .PP +.RE +.PP \fB+[no]cookie\fR\fB[=####]\fR .RS 4 - Send a COOKIE EDNS option, with optional value\&. Replaying a COOKIE from a previous response will allow the server to identify a previous client\&. The default is +Send a COOKIE EDNS option, with optional value\&. Replaying a COOKIE from a previous response will allow the server to identify a previous client\&. The default is \fB+cookie\fR\&. .sp - \fB+cookie\fR +\fB+cookie\fR is also set when +trace is set to better emulate the default queries from a nameserver\&. - .RE - .PP +.RE +.PP \fB+[no]crypto\fR .RS 4 - 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 the common failures\&. The default is to display the fields\&. 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 ]"\&. - .RE - .PP +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 the common failures\&. The default is to display the fields\&. 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 ]"\&. +.RE +.PP \fB+[no]defname\fR .RS 4 - Deprecated, treated as a synonym for +Deprecated, treated as a synonym for \fI+[no]search\fR - .RE - .PP +.RE +.PP \fB+[no]dnssec\fR .RS 4 - Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query\&. - .RE - .PP +Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query\&. +.RE +.PP \fB+domain=somename\fR .RS 4 - Set the search list to contain the single domain +Set the search list to contain the single domain \fIsomename\fR, as if specified in a \fBdomain\fR directive in /etc/resolv\&.conf, and enable search list processing as if the \fI+search\fR option were given\&. - .RE - .PP +.RE +.PP \fB+dscp=value\fR .RS 4 - Set the DSCP code point to be used when sending the query\&. Valid DSCP code points are in the range [0\&.\&.63]\&. By default no code point is explicitly set\&. - .RE - .PP +Set the DSCP code point to be used when sending the query\&. Valid DSCP code points are in the range [0\&.\&.63]\&. By default no code point is explicitly set\&. +.RE +.PP \fB+[no]edns[=#]\fR .RS 4 - 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\&. +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\&. \fB+noedns\fR clears the remembered EDNS version\&. EDNS is set to 0 by default\&. - .RE - .PP +.RE +.PP \fB+[no]ednsflags[=#]\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fB+[no]ednsnegotiation\fR .RS 4 - Enable / disable EDNS version negotiation\&. By default EDNS version negotiation is enabled\&. - .RE - .PP +Enable / disable EDNS version negotiation\&. By default EDNS version negotiation is enabled\&. +.RE +.PP \fB+[no]ednsopt[=code[:value]]\fR .RS 4 - Specify EDNS option with code point +Specify EDNS option with code point \fBcode\fR and optionally payload of \fBvalue\fR @@ -485,71 +462,71 @@ or ECS), or an arbitrary numeric value\&. \fB+noednsopt\fR clears the EDNS options to be sent\&. - .RE - .PP +.RE +.PP \fB+[no]expire\fR .RS 4 - Send an EDNS Expire option\&. - .RE - .PP +Send an EDNS Expire option\&. +.RE +.PP \fB+[no]fail\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fB+[no]header\-only\fR .RS 4 - Send a query with a DNS header without a question section\&. The default is to add a question section\&. The query type and query name are ignored when this is set\&. - .RE - .PP +Send a query with a DNS header without a question section\&. The default is to add a question section\&. The query type and query name are ignored when this is set\&. +.RE +.PP \fB+[no]identify\fR .RS 4 - Show [or do not show] the IP address and port number that supplied the answer when the +Show [or do not show] the IP address and port number that supplied the answer when the \fI+short\fR 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\&. - .RE - .PP +.RE +.PP \fB+[no]idnin\fR .RS 4 - Process [do not process] IDN domain names on input\&. This requires IDN SUPPORT to have been enabled at compile time\&. +Process [do not process] IDN domain names on input\&. This requires IDN SUPPORT to have been enabled at compile time\&. .sp - The default is to process IDN input when standard output is a tty\&. The IDN processing on input is disabled when dig output is redirected to files, pipes, and other non\-tty file descriptors\&. - .RE - .PP +The default is to process IDN input when standard output is a tty\&. The IDN processing on input is disabled when dig output is redirected to files, pipes, and other non\-tty file descriptors\&. +.RE +.PP \fB+[no]idnout\fR .RS 4 - Convert [do not convert] puny code on output\&. This requires IDN SUPPORT to have been enabled at compile time\&. +Convert [do not convert] puny code on output\&. This requires IDN SUPPORT to have been enabled at compile time\&. .sp - The default is to process puny code on output when standard output is a tty\&. The puny code processing on output is disabled when dig output is redirected to files, pipes, and other non\-tty file descriptors\&. - .RE - .PP +The default is to process puny code on output when standard output is a tty\&. The puny code processing on output is disabled when dig output is redirected to files, pipes, and other non\-tty file descriptors\&. +.RE +.PP \fB+[no]ignore\fR .RS 4 - Ignore truncation in UDP responses instead of retrying with TCP\&. By default, TCP retries are performed\&. - .RE - .PP +Ignore truncation in UDP responses instead of retrying with TCP\&. By default, TCP retries are performed\&. +.RE +.PP \fB+[no]keepopen\fR .RS 4 - Keep the TCP socket open between queries and reuse it rather than creating a new TCP socket for each lookup\&. The default is +Keep the TCP socket open between queries and reuse it rather than creating a new TCP socket for each lookup\&. The default is \fB+nokeepopen\fR\&. - .RE - .PP +.RE +.PP \fB+[no]mapped\fR .RS 4 - Allow mapped IPv4 over IPv6 addresses to be used\&. The default is +Allow mapped IPv4 over IPv6 addresses to be used\&. The default is \fB+mapped\fR\&. - .RE - .PP +.RE +.PP \fB+[no]multiline\fR .RS 4 - 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 +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 \fBdig\fR output\&. - .RE - .PP +.RE +.PP \fB+ndots=D\fR .RS 4 - Set the number of dots that have to appear in +Set the number of dots that have to appear in \fIname\fR to \fID\fR @@ -563,103 +540,103 @@ directive in if \fB+search\fR is set\&. - .RE - .PP +.RE +.PP \fB+[no]nsid\fR .RS 4 - Include an EDNS name server ID request when sending a query\&. - .RE - .PP +Include an EDNS name server ID request when sending a query\&. +.RE +.PP \fB+[no]nssearch\fR .RS 4 - When this option is set, +When this option is set, \fBdig\fR 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\&. - .RE - .PP +.RE +.PP \fB+[no]onesoa\fR .RS 4 - Print only one (starting) SOA record when performing an AXFR\&. The default is to print both the starting and ending SOA records\&. - .RE - .PP +Print only one (starting) SOA record when performing an AXFR\&. The default is to print both the starting and ending SOA records\&. +.RE +.PP \fB+[no]opcode=value\fR .RS 4 - Set [restore] the DNS message opcode to the specified value\&. The default value is QUERY (0)\&. - .RE - .PP +Set [restore] the DNS message opcode to the specified value\&. The default value is QUERY (0)\&. +.RE +.PP \fB+[no]qr\fR .RS 4 - Toggles the display of the query message as it is sent\&. By default, the query is not printed\&. - .RE - .PP +Toggles the display of the query message as it is sent\&. By default, the query is not printed\&. +.RE +.PP \fB+[no]question\fR .RS 4 - Toggles the display of the question section of a query when an answer is returned\&. The default is to print the question section as a comment\&. - .RE - .PP +Toggles the display of the question section of a query when an answer is returned\&. The default is to print the question section as a comment\&. +.RE +.PP \fB+[no]rdflag\fR .RS 4 - A synonym for +A synonym for \fI+[no]recurse\fR\&. - .RE - .PP +.RE +.PP \fB+[no]recurse\fR .RS 4 - Toggle the setting of the RD (recursion desired) bit in the query\&. This bit is set by default, which means +Toggle the setting of the RD (recursion desired) bit in the query\&. This bit is set by default, which means \fBdig\fR normally sends recursive queries\&. Recursion is automatically disabled when using the \fI+nssearch\fR option, and when using \fI+trace\fR except for an initial recursive query to get the list of root servers\&. - .RE - .PP +.RE +.PP \fB+retry=T\fR .RS 4 - Sets the number of times to retry UDP queries to server to +Sets the number of times to retry UDP queries to server to \fIT\fR instead of the default, 2\&. Unlike \fI+tries\fR, this does not include the initial query\&. - .RE - .PP +.RE +.PP \fB+[no]rrcomments\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fB+[no]search\fR .RS 4 - Use [do not use] the search list defined by the searchlist or domain directive in +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\&. .sp - \*(Aqndots\*(Aq from +\*(Aqndots\*(Aq from resolv\&.conf (default 1) which may be overridden by \fI+ndots\fR determines if the name will be treated as relative or not and hence whether a search is eventually performed or not\&. - .RE - .PP +.RE +.PP \fB+[no]short\fR .RS 4 - Provide a terse answer\&. The default is to print the answer in a verbose form\&. This option always has global effect; it cannot be set globally and then overridden on a per\-lookup basis\&. - .RE - .PP +Provide a terse answer\&. The default is to print the answer in a verbose form\&. This option always has global effect; it cannot be set globally and then overridden on a per\-lookup basis\&. +.RE +.PP \fB+[no]showsearch\fR .RS 4 - Perform [do not perform] a search showing intermediate results\&. - .RE - .PP +Perform [do not perform] a search showing intermediate results\&. +.RE +.PP \fB+[no]sigchase\fR .RS 4 - Chase DNSSEC signature chains\&. Requires dig be compiled with \-DDIG_SIGCHASE\&. This feature is deprecated\&. Use +Chase DNSSEC signature chains\&. Requires dig be compiled with \-DDIG_SIGCHASE\&. This feature is deprecated\&. Use \fBdelv\fR instead\&. - .RE - .PP +.RE +.PP \fB+split=W\fR .RS 4 - Split long hex\- or base64\-formatted fields in resource records into chunks of +Split long hex\- or base64\-formatted fields in resource records into chunks of \fIW\fR characters (where \fIW\fR @@ -668,76 +645,76 @@ is rounded up to the nearest multiple of 4)\&. or \fI+split=0\fR causes fields not to be split at all\&. The default is 56 characters, or 44 characters when multiline mode is active\&. - .RE - .PP +.RE +.PP \fB+[no]stats\fR .RS 4 - 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 as a comment after each lookup\&. - .RE - .PP +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 as a comment after each lookup\&. +.RE +.PP \fB+[no]subnet=addr[/prefix\-length]\fR .RS 4 - Send (don\*(Aqt send) an EDNS Client Subnet option with the specified IP address or network prefix\&. +Send (don\*(Aqt send) an EDNS Client Subnet option with the specified IP address or network prefix\&. .sp - \fBdig +subnet=0\&.0\&.0\&.0/0\fR, or simply +\fBdig +subnet=0\&.0\&.0\&.0/0\fR, or simply \fBdig +subnet=0\fR for short, sends an EDNS CLIENT\-SUBNET option with an empty address and a source prefix\-length of zero, which signals a resolver that the client\*(Aqs address information must \fInot\fR be used when resolving this query\&. - .RE - .PP +.RE +.PP \fB+[no]tcp\fR .RS 4 - Use [do not use] TCP when querying name servers\&. The default behavior is to use UDP unless a type +Use [do not use] TCP when querying name servers\&. The default behavior is to use UDP unless a type any or ixfr=N query is requested, in which case the default is TCP\&. AXFR queries always use TCP\&. - .RE - .PP +.RE +.PP \fB+timeout=T\fR .RS 4 - Sets the timeout for a query to +Sets the timeout for a query to \fIT\fR seconds\&. The default timeout is 5 seconds\&. An attempt to set \fIT\fR to less than 1 will result in a query timeout of 1 second being applied\&. - .RE - .PP +.RE +.PP \fB+[no]topdown\fR .RS 4 - When chasing DNSSEC signature chains perform a top\-down validation\&. Requires dig be compiled with \-DDIG_SIGCHASE\&. This feature is deprecated\&. Use +When chasing DNSSEC signature chains perform a top\-down validation\&. Requires dig be compiled with \-DDIG_SIGCHASE\&. This feature is deprecated\&. Use \fBdelv\fR instead\&. - .RE - .PP +.RE +.PP \fB+[no]trace\fR .RS 4 - 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, +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, \fBdig\fR makes iterative queries to 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\&. .sp - If @server is also specified, it affects only the initial query for the root zone name servers\&. +If @server is also specified, it affects only the initial query for the root zone name servers\&. .sp - \fB+dnssec\fR +\fB+dnssec\fR is also set when +trace is set to better emulate the default queries from a nameserver\&. - .RE - .PP +.RE +.PP \fB+tries=T\fR .RS 4 - Sets the number of times to try UDP queries to server to +Sets the number of times to try UDP queries to server to \fIT\fR instead of the default, 3\&. If \fIT\fR is less than or equal to zero, the number of tries is silently rounded up to 1\&. - .RE - .PP +.RE +.PP \fB+trusted\-key=####\fR .RS 4 - Specifies a file containing trusted keys to be used with +Specifies a file containing trusted keys to be used with \fB+sigchase\fR\&. Each DNSKEY record must be on its own line\&. .sp - If not specified, +If not specified, \fBdig\fR will look for /etc/trusted\-key\&.key @@ -745,49 +722,49 @@ then trusted\-key\&.key in the current directory\&. .sp - Requires dig be compiled with \-DDIG_SIGCHASE\&. This feature is deprecated\&. Use +Requires dig be compiled with \-DDIG_SIGCHASE\&. This feature is deprecated\&. Use \fBdelv\fR instead\&. - .RE - .PP +.RE +.PP \fB+[no]ttlid\fR .RS 4 - Display [do not display] the TTL when printing the record\&. - .RE - .PP +Display [do not display] the TTL when printing the record\&. +.RE +.PP \fB+[no]ttlunits\fR .RS 4 - Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks\&. Implies +ttlid\&. - .RE - .PP +Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks\&. Implies +ttlid\&. +.RE +.PP \fB+[no]unknownformat\fR .RS 4 - Print all RDATA in unknown RR type presentation format (RFC 3597)\&. The default is to print RDATA for known types in the type\*(Aqs presentation format\&. - .RE - .PP +Print all RDATA in unknown RR type presentation format (RFC 3597)\&. The default is to print RDATA for known types in the type\*(Aqs presentation format\&. +.RE +.PP \fB+[no]vc\fR .RS 4 - Use [do not use] TCP when querying name servers\&. This alternate syntax to +Use [do not use] TCP when querying name servers\&. This alternate syntax to \fI+[no]tcp\fR is provided for backwards compatibility\&. The "vc" stands for "virtual circuit"\&. - .RE - .PP +.RE +.PP \fB+[no]zflag\fR .RS 4 - Set [do not set] the last unassigned DNS header flag in a DNS query\&. This flag is off by default\&. - .RE - .SH "MULTIPLE QUERIES" - .PP +Set [do not set] the last unassigned DNS header flag in a DNS query\&. This flag is off by default\&. +.RE +.SH "MULTIPLE QUERIES" +.PP The BIND 9 implementation of \fBdig \fR supports specifying multiple queries on the command line (in addition to supporting the \fB\-f\fR batch file option)\&. Each of those queries can be supplied with its own set of flags, options and query options\&. - .PP +.PP In this case, each \fIquery\fR argument represent an individual query in the command\-line syntax described above\&. Each consists of any of the standard options and flags, the name to be looked up, an optional query type and class and any query options that should be applied to that query\&. - .PP +.PP 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 supplied on the command line\&. Any global query options (except the \fB+[no]cmd\fR option) can be overridden by a query\-specific set of query options\&. For example: @@ -816,8 +793,8 @@ which means that \fBdig\fR will not print the initial query when it looks up the NS records for isc\&.org\&. - .SH "IDN SUPPORT" - .PP +.SH "IDN SUPPORT" +.PP If \fBdig\fR has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names\&. @@ -826,20 +803,20 @@ appropriately converts character encoding of domain name before sending a reques \fI+noidnin\fR and \fI+noidnout\fR\&. - .SH "FILES" - .PP +.SH "FILES" +.PP /etc/resolv\&.conf - .PP +.PP ${HOME}/\&.digrc - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBdelv\fR(1), \fBhost\fR(1), \fBnamed\fR(8), \fBdnssec-keygen\fR(8), RFC 1035\&. - .SH "BUGS" - .PP +.SH "BUGS" +.PP There are probably too many query options\&. .SH "AUTHOR" .PP diff --git a/bin/dig/dig.html b/bin/dig/dig.html index 9c9362ffcc..82c78bddcf 100644 --- a/bin/dig/dig.html +++ b/bin/dig/dig.html @@ -14,63 +14,19 @@
- - - - - -
+

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 is a flexible tool +

dig 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 were queried. Most DNS administrators use dig to @@ -78,8 +34,7 @@ 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 @@ -90,43 +45,35 @@ 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 -r option disables this feature, for scripts that need predictable behaviour.

- -

+

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
@@ -137,7 +84,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 @@ -145,7 +92,7 @@ dig resolves that name before querying that name server.

-

+

If no server argument is provided, dig consults /etc/resolv.conf; if an @@ -158,16 +105,13 @@ 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 @@ -175,116 +119,87 @@ 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 RFC 1886 IP6.INT domain, which is no longer in use. Obsolete bit string label queries (RFC 2874) 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 default 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. -

-
+

-r
-
-

+

Do not read options from ${HOME}/.digrc. This is useful for scripts that need predictable behaviour. -

-
+

-t type
-

+

The resource record type to query. It can be any valid query type. If it is a resource record type supported in BIND 9, it can be given by the type mnemonic (such as "NS" or "AAAA"). @@ -298,28 +213,23 @@ record was N.

-

+

All resource record types can be expressed as "TYPEnn", where "nn" is the number of the type. If the resource record type is not supported in BIND 9, the result will be displayed as described in RFC 3597.

-
+
-u
-
-

+

Print query times in microseconds instead of milliseconds. -

-
+

-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 @@ -334,11 +244,10 @@ 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. @@ -350,34 +259,28 @@ 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 @@ -393,27 +296,20 @@

+[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 @@ -423,46 +319,34 @@ 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]badcookie
-
-

+

Retry lookup with the new server cookie if a BADCOOKIE response is received. -

-
+

+[no]besteffort
-
-

+

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

-
+

+bufsize=B
-
-

+

This option sets the UDP message buffer size advertised using EDNS0 to B bytes. The maximum and minimum sizes of this buffer are 65535 @@ -471,43 +355,36 @@ to send a EDNS messages with a advertised size of 0 bytes). +bufsize restores the default buffer size. -

-
+

+[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 option always has global effect; it cannot be set globally and then overridden on a per-lookup basis. The default is to print this comment. -

-
+

+[no]comments
-

+

Toggles the display of some comment lines in the output, containing information about the packet header and OPT pseudosection, and the names of the response section. The default is to print these comments.

-

+

Other types of comments in the output are not affected by this option, but can be controlled using other command line switches. These include +[no]cmd, @@ -515,24 +392,23 @@ +[no]stats, and +[no]rrcomments.

-
+
+[no]cookie[=####]
-

+

Send a COOKIE EDNS option, with optional value. Replaying a COOKIE from a previous response will allow the server to identify a previous client. The default is +cookie.

-

+

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

-
+
+[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 @@ -541,71 +417,55 @@ 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. -

-
+

+dscp=value
-
-

+

Set the DSCP code point to be used when sending the query. Valid DSCP code points are in the range [0..63]. By default no code point is explicitly set. -

-
+

+[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. code can be @@ -613,104 +473,86 @@ NSID or ECS), or an arbitrary numeric value. +noednsopt clears the EDNS options 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]header-only
-
-

+

Send a query with a DNS header without a question section. The default is to add a question section. The query type and query name are ignored when this is set. -

-
+

+[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]idnin
-

+

Process [do not process] IDN domain names on input. This requires IDN SUPPORT to have been enabled at compile time.

-

+

The default is to process IDN input when standard output is a tty. The IDN processing on input is disabled when dig output is redirected to files, pipes, and other non-tty file descriptors.

-
+
+[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 process puny code on output when standard output is a tty. The puny code processing on output is disabled when dig output is redirected to files, pipes, and other non-tty file descriptors.

-
+
+[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]mapped
-
-

+

Allow mapped IPv4 over IPv6 addresses to be used. The default is +mapped. -

-
+

+[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 @@ -722,64 +564,48 @@ 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
-
-

+

Toggles the display of the query message as it is sent. By default, the query is not printed. -

-
+

+[no]question
-
-

+

Toggles the display of 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 @@ -788,69 +614,57 @@ when using +trace except for an initial recursive query to get the list of root servers. -

-
+

+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. This option always has global effect; it cannot be set globally and then overridden on a per-lookup basis. -

-
+

+[no]showsearch
-
-

+

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

-
+

+[no]sigchase
-
-

+

Chase DNSSEC signature chains. Requires dig be compiled with -DDIG_SIGCHASE. This feature is deprecated. Use delv instead. -

-
+

+split=W
-
-

+

Split long hex- or base64-formatted fields in resource records into chunks of W characters (where W is rounded @@ -859,23 +673,20 @@ +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
-
-

+

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 as a comment after each lookup. -

-
+

+[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 @@ -884,20 +695,17 @@ 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 a type any or ixfr=N query is requested, in which case the default is TCP. AXFR queries always use TCP. -

-
+

+timeout=T
-
-

+

Sets the timeout for a query to T seconds. The default @@ -905,19 +713,16 @@ 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. This feature is deprecated. Use delv instead. -

-
+

+[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, @@ -925,91 +730,80 @@ 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. This feature is deprecated. Use delv instead.

-
+
+[no]ttlid
-
-

+

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

-
+

+[no]ttlunits
-
-

+

Display [do not display] the TTL in friendly human-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks. Implies +ttlid. -

-
+

+[no]unknownformat
-
-

+

Print all RDATA in unknown RR type presentation format (RFC 3597). The default is to print RDATA for known types in the type's presentation format. -

-
+

+[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". -

-
+

+[no]zflag
-
-

+

Set [do not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. -

-
+

-
- -
+
+

MULTIPLE QUERIES

- - -

+

The BIND 9 implementation of dig supports specifying multiple queries on the command line (in addition to @@ -1017,8 +811,7 @@ 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 @@ -1026,8 +819,7 @@ 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 @@ -1054,13 +846,10 @@ 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 @@ -1070,43 +859,28 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr parameters +noidnin and +noidnout.

-
- -
+
+

FILES

- -

/etc/resolv.conf +

/etc/resolv.conf

-

${HOME}/.digrc +

${HOME}/.digrc

-
- -
+
+

SEE ALSO

- -

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

delv(1), + host(1), + named(8), + dnssec-keygen(8), RFC 1035.

-
- -
+
+

BUGS

- -

+

There are probably too many query options.

-
- +
diff --git a/bin/dig/host.1 b/bin/dig/host.1 index 7dcee9cf2b..21a737553d 100644 --- a/bin/dig/host.1 +++ b/bin/dig/host.1 @@ -35,34 +35,18 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" host \- DNS lookup utility - .SH "SYNOPSIS" - .HP \w'\fBhost\fR\ 'u - \fBhost\fR - [\fB\-aCdlnrsTUwv\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-N\ \fR\fB\fIndots\fR\fR] - [\fB\-p\ \fR\fB\fIport\fR\fR] - [\fB\-R\ \fR\fB\fInumber\fR\fR] - [\fB\-t\ \fR\fB\fItype\fR\fR] - [\fB\-W\ \fR\fB\fIwait\fR\fR] - [\fB\-m\ \fR\fB\fIflag\fR\fR] - [ - | [\fB\-4\fR] - | [\fB\-6\fR] - ] - [\fB\-v\fR] - [\fB\-V\fR] - {name} - [server] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBhost\fR\ 'u +\fBhost\fR [\fB\-aCdlnrsTUwv\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-N\ \fR\fB\fIndots\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-R\ \fR\fB\fInumber\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-W\ \fR\fB\fIwait\fR\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [[\fB\-4\fR] | [\fB\-6\fR]] [\fB\-v\fR] [\fB\-V\fR] {name} [server] +.SH "DESCRIPTION" +.PP \fBhost\fR 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, \fBhost\fR prints a short summary of its command line arguments and options\&. - .PP +.PP \fIname\fR 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 \fBhost\fR @@ -72,74 +56,74 @@ is an optional argument which is either the name or IP address of the name serve \fBhost\fR should query instead of the server or servers listed in /etc/resolv\&.conf\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-4 .RS 4 - Use IPv4 only for query transport\&. See also the +Use IPv4 only for query transport\&. See also the \fB\-6\fR option\&. - .RE - .PP +.RE +.PP \-6 .RS 4 - Use IPv6 only for query transport\&. See also the +Use IPv6 only for query transport\&. See also the \fB\-4\fR option\&. - .RE - .PP +.RE +.PP \-a .RS 4 - "All"\&. The +"All"\&. The \fB\-a\fR option is normally equivalent to \fB\-v \-t \fR\fBANY\fR\&. It also affects the behaviour of the \fB\-l\fR list zone option\&. - .RE - .PP +.RE +.PP \-c \fIclass\fR .RS 4 - Query class: This can be used to lookup HS (Hesiod) or CH (Chaosnet) class resource records\&. The default class is IN (Internet)\&. - .RE - .PP +Query class: This can be used to lookup HS (Hesiod) or CH (Chaosnet) class resource records\&. The default class is IN (Internet)\&. +.RE +.PP \-C .RS 4 - Check consistency: +Check consistency: \fBhost\fR will query the SOA records for zone \fIname\fR 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\&. - .RE - .PP +.RE +.PP \-d .RS 4 - Print debugging traces\&. Equivalent to the +Print debugging traces\&. Equivalent to the \fB\-v\fR verbose option\&. - .RE - .PP +.RE +.PP \-i .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-l .RS 4 - List zone: The +List zone: The \fBhost\fR command performs a zone transfer of zone \fIname\fR and prints out the NS, PTR and address records (A/AAAA)\&. .sp - Together, the +Together, the \fB\-l \-a\fR options print all records in the zone\&. - .RE - .PP +.RE +.PP \-N \fIndots\fR .RS 4 - The number of dots that have to be in +The number of dots that have to be in \fIname\fR for it to be considered absolute\&. The default value is that defined using the ndots statement in /etc/resolv\&.conf, or 1 if no ndots statement is present\&. Names with fewer dots are interpreted as relative names and will be searched for in the domains listed in the @@ -148,47 +132,47 @@ or \fBdomain\fR directive in /etc/resolv\&.conf\&. - .RE - .PP +.RE +.PP \-p \fIport\fR .RS 4 - Specify the port on the server to query\&. The default is 53\&. - .RE - .PP +Specify the port on the server to query\&. The default is 53\&. +.RE +.PP \-r .RS 4 - Non\-recursive query: Setting this option clears the RD (recursion desired) bit in the query\&. This should mean that the name server receiving the query will not attempt to resolve +Non\-recursive query: Setting this option clears the RD (recursion desired) bit in the query\&. This should mean that the name server receiving the query will not attempt to resolve \fIname\fR\&. The \fB\-r\fR option enables \fBhost\fR to mimic the behavior of a name server by making non\-recursive queries and expecting to receive answers to those queries that can be referrals to other name servers\&. - .RE - .PP +.RE +.PP \-R \fInumber\fR .RS 4 - Number of retries for UDP queries: If +Number of retries for UDP queries: If \fInumber\fR is negative or zero, the number of retries will default to 1\&. The default value is 1, or the value of the \fIattempts\fR option in /etc/resolv\&.conf, if set\&. - .RE - .PP +.RE +.PP \-s .RS 4 - Do +Do \fInot\fR send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior\&. - .RE - .PP +.RE +.PP \-t \fItype\fR .RS 4 - Query type: The +Query type: The \fItype\fR argument can be any recognized query type: CNAME, NS, SOA, TXT, DNSKEY, AXFR, etc\&. .sp - When no query type is specified, +When no query type is specified, \fBhost\fR automatically selects an appropriate query type\&. By default, it looks for A, AAAA, and MX records\&. If the \fB\-C\fR @@ -198,73 +182,73 @@ is a dotted\-decimal IPv4 address or colon\-delimited IPv6 address, \fBhost\fR will query for PTR records\&. .sp - 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 +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 \fB\-t \fR\fBIXFR=12345678\fR)\&. - .RE - .PP +.RE +.PP \-T, \-U .RS 4 - TCP/UDP: By default, +TCP/UDP: By default, \fBhost\fR uses UDP when making queries\&. The \fB\-T\fR 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\&. Type ANY queries default to TCP but can be forced to UDP initially using \fB\-U\fR\&. - .RE - .PP +.RE +.PP \-m \fIflag\fR .RS 4 - Memory usage debugging: the flag can be +Memory usage debugging: the flag can be \fIrecord\fR, \fIusage\fR, or \fItrace\fR\&. You can specify the \fB\-m\fR option more than once to set multiple flags\&. - .RE - .PP +.RE +.PP \-v .RS 4 - Verbose output\&. Equivalent to the +Verbose output\&. Equivalent to the \fB\-d\fR debug option\&. Verbose output can also be enabled by setting the \fIdebug\fR option in /etc/resolv\&.conf\&. - .RE - .PP +.RE +.PP \-V .RS 4 - Print the version number and exit\&. - .RE - .PP +Print the version number and exit\&. +.RE +.PP \-w .RS 4 - Wait forever: The query timeout is set to the maximum possible\&. See also the +Wait forever: The query timeout is set to the maximum possible\&. See also the \fB\-W\fR option\&. - .RE - .PP +.RE +.PP \-W \fIwait\fR .RS 4 - Timeout: Wait for up to +Timeout: Wait for up to \fIwait\fR seconds for a reply\&. If \fIwait\fR is less than one, the wait interval is set to one second\&. .sp - By default, +By default, \fBhost\fR will wait for 5 seconds for UDP responses and 10 seconds for TCP connections\&. These defaults can be overridden by the \fItimeout\fR option in /etc/resolv\&.conf\&. .sp - See also the +See also the \fB\-w\fR option\&. - .RE - .SH "IDN SUPPORT" - .PP +.RE +.SH "IDN SUPPORT" +.PP If \fBhost\fR has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names\&. @@ -274,11 +258,11 @@ appropriately converts character encoding of domain name before sending a reques environment variable\&. The IDN support is disabled if the variable is set when \fBhost\fR runs\&. - .SH "FILES" - .PP +.SH "FILES" +.PP /etc/resolv\&.conf - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBdig\fR(1), \fBnamed\fR(8)\&. .SH "AUTHOR" diff --git a/bin/dig/host.html b/bin/dig/host.html index f0273c466b..653c00fd5d 100644 --- a/bin/dig/host.html +++ b/bin/dig/host.html @@ -14,57 +14,24 @@
- - - - - -
+

Name

-

- host - — DNS lookup utility -

+

host — DNS lookup utility

- - - -
+

Synopsis

-

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

-
- -
+

host [-aCdlnrsTUwv] [-c class] [-N ndots] [-p port] [-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 @@ -76,86 +43,68 @@ 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 @@ -165,17 +114,13 @@ searched for in the domains listed in the search or domain directive in /etc/resolv.conf. -

-
+

-p port
-
-

+

Specify the port on the server to query. The default is 53. -

-
+

-r
-
-

+

Non-recursive query: Setting this option clears the RD (recursion desired) bit in the query. This should mean that the name server @@ -186,35 +131,30 @@ 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, or the value of the attempts option in /etc/resolv.conf, if set. -

-
+

-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. @@ -225,18 +165,17 @@ 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, -U
-
-

+

TCP/UDP: By default, host uses UDP when making queries. The -T option makes it use a TCP @@ -244,67 +183,55 @@ automatically selected for queries that require it, such as zone transfer (AXFR) requests. Type ANY queries default to TCP but can be forced to UDP initially using -U. -

-
+

-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. Verbose output can also be enabled by setting the debug option in /etc/resolv.conf. -

-
+

-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. These defaults can be overridden by the timeout option in /etc/resolv.conf.

-

+

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 @@ -315,26 +242,17 @@ 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.1 b/bin/dig/nslookup.1 index 9d34226b83..3863ea635b 100644 --- a/bin/dig/nslookup.1 +++ b/bin/dig/nslookup.1 @@ -35,22 +35,19 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" nslookup \- query Internet name servers interactively - .SH "SYNOPSIS" - .HP \w'\fBnslookup\fR\ 'u - \fBnslookup\fR - [\fB\-option\fR] - [name\ |\ \-] - [server] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBnslookup\fR\ 'u +\fBnslookup\fR [\fB\-option\fR] [name\ |\ \-] [server] +.SH "DESCRIPTION" +.PP \fBNslookup\fR is a program to query Internet domain name servers\&. \fBNslookup\fR has two modes: interactive and non\-interactive\&. Interactive mode allows the user to query name servers for information about various hosts and domains or to print a list of hosts in a domain\&. Non\-interactive mode is used to print just the name and requested information for a host or domain\&. - .SH "ARGUMENTS" - .PP +.SH "ARGUMENTS" +.PP Interactive mode is entered in the following cases: .sp .RS 4 @@ -61,8 +58,8 @@ Interactive mode is entered in the following cases: .sp -1 .IP " 1." 4.2 .\} - when no arguments are given (the default name server will be used) - .RE +when no arguments are given (the default name server will be used) +.RE .sp .RS 4 .ie n \{\ @@ -72,12 +69,11 @@ Interactive mode is entered in the following cases: .sp -1 .IP " 2." 4.2 .\} - when the first argument is a hyphen (\-) and the second argument is the host name or Internet address of a name server\&. - .RE -.sp - .PP +when the first argument is a hyphen (\-) and the second argument is the host name or Internet address of a name server\&. +.RE +.PP 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\&. - .PP +.PP 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 timeout to 10 seconds, type: .sp .if n \{\ @@ -90,203 +86,203 @@ nslookup \-query=hinfo \-timeout=10 .RE .\} .sp - .PP +.PP The \fB\-version\fR option causes \fBnslookup\fR to print the version number and immediately exits\&. - .SH "INTERACTIVE COMMANDS" - .PP +.SH "INTERACTIVE COMMANDS" +.PP \fBhost\fR [server] .RS 4 - 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\&. +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\&. .sp - To look up a host not in the current domain, append a period to the name\&. - .RE - .PP +To look up a host not in the current domain, append a period to the name\&. +.RE +.PP \fBserver\fR \fIdomain\fR .RS 4 - .RE - .PP +.RE +.PP \fBlserver\fR \fIdomain\fR .RS 4 - Change the default server to +Change the default server to \fIdomain\fR; \fBlserver\fR uses the initial server to look up information about \fIdomain\fR, while \fBserver\fR uses the current default server\&. If an authoritative answer can\*(Aqt be found, the names of servers that might have the answer are returned\&. - .RE - .PP +.RE +.PP \fBroot\fR .RS 4 - not implemented - .RE - .PP +not implemented +.RE +.PP \fBfinger\fR .RS 4 - not implemented - .RE - .PP +not implemented +.RE +.PP \fBls\fR .RS 4 - not implemented - .RE - .PP +not implemented +.RE +.PP \fBview\fR .RS 4 - not implemented - .RE - .PP +not implemented +.RE +.PP \fBhelp\fR .RS 4 - not implemented - .RE - .PP +not implemented +.RE +.PP \fB?\fR .RS 4 - not implemented - .RE - .PP +not implemented +.RE +.PP \fBexit\fR .RS 4 - Exits the program\&. - .RE - .PP +Exits the program\&. +.RE +.PP \fBset\fR \fIkeyword\fR\fI[=value]\fR .RS 4 - This command is used to change state information that affects the lookups\&. Valid keywords are: - .PP +This command is used to change state information that affects the lookups\&. Valid keywords are: +.PP \fBall\fR .RS 4 - Prints the current values of the frequently used options to +Prints the current values of the frequently used options to \fBset\fR\&. Information about the current default server and host is also printed\&. - .RE - .PP +.RE +.PP \fBclass=\fR\fIvalue\fR .RS 4 - Change the query class to one of: - .PP +Change the query class to one of: +.PP \fBIN\fR .RS 4 - the Internet class - .RE - .PP +the Internet class +.RE +.PP \fBCH\fR .RS 4 - the Chaos class - .RE - .PP +the Chaos class +.RE +.PP \fBHS\fR .RS 4 - the Hesiod class - .RE - .PP +the Hesiod class +.RE +.PP \fBANY\fR .RS 4 - wildcard - .RE - .sp +wildcard +.RE +.sp The class specifies the protocol group of the information\&. .sp - (Default = IN; abbreviation = cl) - .RE - .PP +(Default = IN; abbreviation = cl) +.RE +.PP \fB\fI[no]\fR\fR\fBdebug\fR .RS 4 - Turn on or off the display of the full response packet and any intermediate response packets when searching\&. +Turn on or off the display of the full response packet and any intermediate response packets when searching\&. .sp - (Default = nodebug; abbreviation = +(Default = nodebug; abbreviation = [no]deb) - .RE - .PP +.RE +.PP \fB\fI[no]\fR\fR\fBd2\fR .RS 4 - Turn debugging mode on or off\&. This displays more about what nslookup is doing\&. +Turn debugging mode on or off\&. This displays more about what nslookup is doing\&. .sp - (Default = nod2) - .RE - .PP +(Default = nod2) +.RE +.PP \fBdomain=\fR\fIname\fR .RS 4 - Sets the search list to +Sets the search list to \fIname\fR\&. - .RE - .PP +.RE +.PP \fB\fI[no]\fR\fR\fBsearch\fR .RS 4 - If the lookup request contains at least one period but doesn\*(Aqt end with a trailing period, append the domain names in the domain search list to the request until an answer is received\&. +If the lookup request contains at least one period but doesn\*(Aqt end with a trailing period, append the domain names in the domain search list to the request until an answer is received\&. .sp - (Default = search) - .RE - .PP +(Default = search) +.RE +.PP \fBport=\fR\fIvalue\fR .RS 4 - Change the default TCP/UDP name server port to +Change the default TCP/UDP name server port to \fIvalue\fR\&. .sp - (Default = 53; abbreviation = po) - .RE - .PP +(Default = 53; abbreviation = po) +.RE +.PP \fBquerytype=\fR\fIvalue\fR .RS 4 - .RE - .PP +.RE +.PP \fBtype=\fR\fIvalue\fR .RS 4 - Change the type of the information query\&. +Change the type of the information query\&. .sp - (Default = A and then AAAA; abbreviations = q, ty) +(Default = A and then AAAA; abbreviations = q, ty) .sp - \fBNote:\fR +\fBNote:\fR It is only possible to specify one query type, only the default behavior looks up both when an alternative is not specified\&. - .RE - .PP +.RE +.PP \fB\fI[no]\fR\fR\fBrecurse\fR .RS 4 - Tell the name server to query other servers if it does not have the information\&. +Tell the name server to query other servers if it does not have the information\&. .sp - (Default = recurse; abbreviation = [no]rec) - .RE - .PP +(Default = recurse; abbreviation = [no]rec) +.RE +.PP \fBndots=\fR\fInumber\fR .RS 4 - Set the number of dots (label separators) in a domain that will disable searching\&. Absolute names always stop searching\&. - .RE - .PP +Set the number of dots (label separators) in a domain that will disable searching\&. Absolute names always stop searching\&. +.RE +.PP \fBretry=\fR\fInumber\fR .RS 4 - Set the number of retries to number\&. - .RE - .PP +Set the number of retries to number\&. +.RE +.PP \fBtimeout=\fR\fInumber\fR .RS 4 - Change the initial timeout interval for waiting for a reply to number seconds\&. - .RE - .PP +Change the initial timeout interval for waiting for a reply to number seconds\&. +.RE +.PP \fB\fI[no]\fR\fR\fBvc\fR .RS 4 - Always use a virtual circuit when sending requests to the server\&. +Always use a virtual circuit when sending requests to the server\&. .sp - (Default = novc) - .RE - .PP +(Default = novc) +.RE +.PP \fB\fI[no]\fR\fR\fBfail\fR .RS 4 - Try the next nameserver if a nameserver responds with SERVFAIL or a referral (nofail) or terminate query (fail) on such a response\&. +Try the next nameserver if a nameserver responds with SERVFAIL or a referral (nofail) or terminate query (fail) on such a response\&. .sp - (Default = nofail) - .RE - .sp - .RE - .SH "RETURN VALUES" - .PP +(Default = nofail) +.RE +.sp +.RE +.SH "RETURN VALUES" +.PP \fBnslookup\fR returns with an exit status of 1 if any query failed, and 0 otherwise\&. - .SH "IDN SUPPORT" - .PP +.SH "IDN SUPPORT" +.PP If \fBnslookup\fR has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names\&. @@ -296,11 +292,11 @@ appropriately converts character encoding of domain name before sending a reques environment variable\&. The IDN support is disabled if the variable is set when \fBnslookup\fR runs or when the standard output is not a tty\&. - .SH "FILES" - .PP +.SH "FILES" +.PP /etc/resolv\&.conf - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBdig\fR(1), \fBhost\fR(1), \fBnamed\fR(8)\&. diff --git a/bin/dig/nslookup.html b/bin/dig/nslookup.html index 0cad7e74d8..dfc510bbaa 100644 --- a/bin/dig/nslookup.html +++ b/bin/dig/nslookup.html @@ -14,35 +14,17 @@
- - - - - -
+

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 @@ -51,37 +33,29 @@ 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 @@ -94,283 +68,238 @@ 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 and then AAAA; abbreviations = q, ty)

-

+

Note: It is only possible to specify one query type, only the default behavior looks up both when an alternative is not specified.

-
+
[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.

-
- -
+
+

IDN SUPPORT

- -

+

If nslookup has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. nslookup appropriately converts character encoding of @@ -382,28 +311,18 @@ nslookup -query=hinfo -timeout=10 nslookup runs or when the standard output is not a tty.

-
- -
+
+

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.8 b/bin/dnssec/dnssec-dsfromkey.8 index 09a821e1eb..ac78ed441f 100644 --- a/bin/dnssec/dnssec-dsfromkey.8 +++ b/bin/dnssec/dnssec-dsfromkey.8 @@ -35,66 +35,19 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-dsfromkey \- DNSSEC DS RR generation tool - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-dsfromkey\fR\ 'u - \fBdnssec\-dsfromkey\fR - [ - | \fB\-1\fR - | \fB\-2\fR - | \fB\-a\ \fR\fB\fIalg\fR\fR - ] - [ - | \fB\-C\fR - | \fB\-l\ \fR\fB\fIdomain\fR\fR - ] - [\fB\-T\ \fR\fB\fITTL\fR\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - {keyfile} - .HP \w'\fBdnssec\-dsfromkey\fR\ 'u - \fBdnssec\-dsfromkey\fR - [ - | \fB\-1\fR - | \fB\-2\fR - | \fB\-a\ \fR\fB\fIalg\fR\fR - ] - [ - | \fB\-C\fR - | \fB\-l\ \fR\fB\fIdomain\fR\fR - ] - [\fB\-T\ \fR\fB\fITTL\fR\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-A\fR] - {\fB\-f\ \fR\fB\fIfile\fR\fR} - [dnsname] - .HP \w'\fBdnssec\-dsfromkey\fR\ 'u - \fBdnssec\-dsfromkey\fR - [ - | \fB\-1\fR - | \fB\-2\fR - | \fB\-a\ \fR\fB\fIalg\fR\fR - ] - [ - | \fB\-C\fR - | \fB\-l\ \fR\fB\fIdomain\fR\fR - ] - [\fB\-T\ \fR\fB\fITTL\fR\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - {\-s} - {dnsname} - .HP \w'\fBdnssec\-dsfromkey\fR\ 'u - \fBdnssec\-dsfromkey\fR - [ - | \fB\-h\fR - | \fB\-V\fR - ] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-dsfromkey\fR\ 'u +\fBdnssec\-dsfromkey\fR [\fB\-1\fR | \fB\-2\fR | \fB\-a\ \fR\fB\fIalg\fR\fR] [\fB\-C\fR | \fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-T\ \fR\fB\fITTL\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] {keyfile} +.HP \w'\fBdnssec\-dsfromkey\fR\ 'u +\fBdnssec\-dsfromkey\fR [\fB\-1\fR | \fB\-2\fR | \fB\-a\ \fR\fB\fIalg\fR\fR] [\fB\-C\fR | \fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-T\ \fR\fB\fITTL\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-A\fR] {\fB\-f\ \fR\fB\fIfile\fR\fR} [dnsname] +.HP \w'\fBdnssec\-dsfromkey\fR\ 'u +\fBdnssec\-dsfromkey\fR [\fB\-1\fR | \fB\-2\fR | \fB\-a\ \fR\fB\fIalg\fR\fR] [\fB\-C\fR | \fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-T\ \fR\fB\fITTL\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] {\-s} {dnsname} +.HP \w'\fBdnssec\-dsfromkey\fR\ 'u +\fBdnssec\-dsfromkey\fR [\fB\-h\fR | \fB\-V\fR] +.SH "DESCRIPTION" +.PP The \fBdnssec\-dsfromkey\fR command outputs DS (Delegation Signer) resource records (RRs) and other similarly\-constructed RRs: with the @@ -102,21 +55,21 @@ command outputs DS (Delegation Signer) resource records (RRs) and other similarl option it outputs DLV (DNSSEC Lookaside Validation) RRs; or with the \fB\-C\fR it outputs CDS (Child DS) RRs\&. - .PP +.PP The input keys can be specified in a number of ways: - .PP +.PP By default, \fBdnssec\-dsfromkey\fR reads a key file named like Knnnn\&.+aaa+iiiii\&.key, as generated by \fBdnssec\-keygen\fR\&. - .PP +.PP With the \fB\-f \fR\fB\fIfile\fR\fR option, \fBdnssec\-dsfromkey\fR reads keys from a zone file or partial zone file (which can contain just the DNSKEY records)\&. - .PP +.PP With the \fB\-s\fR option, @@ -126,147 +79,147 @@ keyset\- file, as generated by \fBdnssec\-keygen\fR \fB\-C\fR\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-1 .RS 4 - An abbreviation for +An abbreviation for \fB\-a SHA1\fR - .RE - .PP +.RE +.PP \-2 .RS 4 - An abbreviation for +An abbreviation for \fB\-a SHA\-256\fR - .RE - .PP +.RE +.PP \-a \fIalgorithm\fR .RS 4 - Specify a digest algorithm to use when converting DNSKEY records to DS records\&. This option can be repeated, so that multiple DS records are created for each DNSKEY record\&. +Specify a digest algorithm to use when converting DNSKEY records to DS records\&. This option can be repeated, so that multiple DS records are created for each DNSKEY record\&. .sp - The +The \fIalgorithm\fR must be one of SHA\-1, SHA\-256, or SHA\-384\&. These values are case insensitive, and the hyphen may be omitted\&. If no algorithm is specified, the default is to use both SHA\-1 and SHA\-256\&. - .RE - .PP +.RE +.PP \-A .RS 4 - Include ZSKs 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 +Include ZSKs 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 \fB\-f\fR zone file mode\&. - .RE - .PP +.RE +.PP \-c \fIclass\fR .RS 4 - Specifies the DNS class (default is IN)\&. Useful only in +Specifies the DNS class (default is IN)\&. Useful only in \fB\-s\fR keyset or \fB\-f\fR zone file mode\&. - .RE - .PP +.RE +.PP \-C .RS 4 - Generate CDS records rather than DS records\&. This is mutually exclusive with the +Generate CDS records rather than DS records\&. This is mutually exclusive with the \fB\-l\fR option for generating DLV records\&. - .RE - .PP +.RE +.PP \-f \fIfile\fR .RS 4 - Zone file mode: +Zone file mode: \fBdnssec\-dsfromkey\fR\*(Aqs final \fIdnsname\fR argument is the DNS domain name of a zone whose master file can be read from \fBfile\fR\&. If the zone name is the same as \fBfile\fR, then it may be omitted\&. .sp - If +If \fIfile\fR is "\-", then the zone data is read from the standard input\&. This makes it possible to use the output of the \fBdig\fR command as input, as in: .sp - \fBdig dnskey example\&.com | dnssec\-dsfromkey \-f \- example\&.com\fR - .RE - .PP +\fBdig dnskey example\&.com | dnssec\-dsfromkey \-f \- example\&.com\fR +.RE +.PP \-h .RS 4 - Prints usage information\&. - .RE - .PP +Prints usage information\&. +.RE +.PP \-K \fIdirectory\fR .RS 4 - Look for key files or +Look for key files or keyset\- files in \fBdirectory\fR\&. - .RE - .PP +.RE +.PP \-l \fIdomain\fR .RS 4 - Generate a DLV set instead of a DS set\&. The specified +Generate a DLV set instead of a DS set\&. The specified \fIdomain\fR is appended to the name for each record in the set\&. This is mutually exclusive with the \fB\-C\fR option for generating CDS records\&. - .RE - .PP +.RE +.PP \-s .RS 4 - Keyset mode: +Keyset mode: \fBdnssec\-dsfromkey\fR\*(Aqs final \fIdnsname\fR argument is the DNS domain name used to locate a keyset\- file\&. - .RE - .PP +.RE +.PP \-T \fITTL\fR .RS 4 - Specifies the TTL of the DS records\&. By default the TTL is omitted\&. - .RE - .PP +Specifies the TTL of the DS records\&. By default the TTL is omitted\&. +.RE +.PP \-v \fIlevel\fR .RS 4 - Sets the debugging level\&. - .RE - .PP +Sets the debugging level\&. +.RE +.PP \-V .RS 4 - Prints version information\&. - .RE - .SH "EXAMPLE" - .PP +Prints version information\&. +.RE +.SH "EXAMPLE" +.PP To build the SHA\-256 DS RR from the \fBKexample\&.com\&.+003+26160\fR keyfile name, you can issue the following command: - .PP +.PP \fBdnssec\-dsfromkey \-2 Kexample\&.com\&.+003+26160\fR - .PP +.PP The command would print something like: - .PP +.PP \fBexample\&.com\&. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0C5EA0B94\fR - .SH "FILES" - .PP +.SH "FILES" +.PP The keyfile can be designated by the key identification Knnnn\&.+aaa+iiiii or the full file name Knnnn\&.+aaa+iiiii\&.key as generated by dnssec\-keygen(8)\&. - .PP +.PP The keyset file name is built from the \fBdirectory\fR, the string keyset\- and the \fBdnsname\fR\&. - .SH "CAVEAT" - .PP +.SH "CAVEAT" +.PP A keyfile error can give a "file not found" even if the file exists\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBdnssec-keygen\fR(8), \fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, diff --git a/bin/dnssec/dnssec-dsfromkey.html b/bin/dnssec/dnssec-dsfromkey.html index 38e06c847f..0f6d5c7565 100644 --- a/bin/dnssec/dnssec-dsfromkey.html +++ b/bin/dnssec/dnssec-dsfromkey.html @@ -14,297 +14,185 @@
- - - - - -
+

Name

-

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

+

dnssec-dsfromkey — DNSSEC DS RR generation tool

- - - -
+

Synopsis

-

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

-

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

-

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

-

- dnssec-dsfromkey - [ - -h - | -V - ] -

-
- -
+

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

+

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

+

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

+

dnssec-dsfromkey [ -h | -V ]

+
+

DESCRIPTION

- -

+

The dnssec-dsfromkey command outputs DS (Delegation Signer) resource records (RRs) and other similarly-constructed RRs: with the -l option it outputs DLV (DNSSEC Lookaside Validation) RRs; or with the -C it outputs CDS (Child DS) RRs.

- -

+

The input keys can be specified in a number of ways:

- -

+

By default, dnssec-dsfromkey reads a key file named like Knnnn.+aaa+iiiii.key, as generated by dnssec-keygen.

- -

+

With the -f file option, dnssec-dsfromkey reads keys from a zone file or partial zone file (which can contain just the DNSKEY records).

- -

+

With the -s option, dnssec-dsfromkey reads a keyset- file, as generated by dnssec-keygen -C.

- -
- -
+
+

OPTIONS

- -
+
-1
-
-

+

An abbreviation for -a SHA1 -

-
+

-2
-
-

+

An abbreviation for -a SHA-256 -

-
+

-a algorithm
-

+

Specify a digest algorithm to use when converting DNSKEY records to DS records. This option can be repeated, so that multiple DS records are created for each DNSKEY record.

-

+

The algorithm must be one of SHA-1, SHA-256, or SHA-384. These values are case insensitive, and the hyphen may be omitted. If no algorithm is specified, the default is to use both SHA-1 and SHA-256.

-
+
-A
-
-

+

Include ZSKs 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 -f zone file mode. -

-
+

-c class
-
-

+

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

-
+

-C
-
-

+

Generate CDS records rather than DS records. This is mutually exclusive with the -l option for generating DLV records. -

-
+

-f file
-

+

Zone file mode: dnssec-dsfromkey's final dnsname argument is the DNS domain name of a zone whose master file can be read from file. If the zone name is the same as file, then it may be omitted.

-

+

If file is "-", 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

-
+
-h
-
-

+

Prints usage information. -

-
+

-K directory
-
-

+

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

-
+

-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. This is mutually exclusive with the -C option for generating CDS records. -

-
+

-s
-
-

+

Keyset mode: dnssec-dsfromkey's final dnsname argument is the DNS domain name used to locate a keyset- file. -

-
+

-T TTL
-
-

+

Specifies the TTL of the DS records. By default the TTL is omitted. -

-
+

-v level
-
-

+

Sets the debugging level. -

-
+

-V
-
-

+

Prints version information. -

-
+

-
- -
+
+

EXAMPLE

- -

+

To build the SHA-256 DS RR from the Kexample.com.+003+26160 keyfile name, you can issue the following command:

-

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 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0C5EA0B94 +

example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0C5EA0B94

- -
- -
+
+

FILES

- -

+

The keyfile can be designated 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 (DS RRs), RFC 4431 (DLV RRs), @@ -312,7 +200,6 @@ RFC 6605 (SHA-384 for DS RRs), RFC 7344 (CDS and CDNSKEY RRs).

-
- +
diff --git a/bin/dnssec/dnssec-importkey.8 b/bin/dnssec/dnssec-importkey.8 index b8f6fd8851..14de556d5b 100644 --- a/bin/dnssec/dnssec-importkey.8 +++ b/bin/dnssec/dnssec-importkey.8 @@ -35,117 +35,96 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-importkey \- import DNSKEY records from external systems so they can be managed - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-importkey\fR\ 'u - \fBdnssec\-importkey\fR - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - [\fB\-L\ \fR\fB\fIttl\fR\fR] - [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-P\ sync\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-h\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - [\fB\-V\fR] - {\fBkeyfile\fR} - .HP \w'\fBdnssec\-importkey\fR\ 'u - \fBdnssec\-importkey\fR - {\fB\-f\ \fR\fB\fIfilename\fR\fR} - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - [\fB\-L\ \fR\fB\fIttl\fR\fR] - [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-P\ sync\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-h\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - [\fB\-V\fR] - [\fBdnsname\fR] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-importkey\fR\ 'u +\fBdnssec\-importkey\fR [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-P\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-h\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] {\fBkeyfile\fR} +.HP \w'\fBdnssec\-importkey\fR\ 'u +\fBdnssec\-importkey\fR {\fB\-f\ \fR\fB\fIfilename\fR\fR} [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-P\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-h\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fBdnsname\fR] +.SH "DESCRIPTION" +.PP \fBdnssec\-importkey\fR 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 will be generated, or it may be read from any other file or from the standard input, in which case both \&.key and \&.private files will be generated\&. - .PP +.PP The newly\-created \&.private file does \fInot\fR contain private key data, and cannot be used for signing\&. However, having a \&.private file makes it possible to set publication (\fB\-P\fR) and deletion (\fB\-D\fR) times for the key, which means the public key can be added to and removed from the DNSKEY RRset on schedule even if the true private key is stored offline\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-f \fIfilename\fR .RS 4 - 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 +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 \fBfile\fR\&. If the domain name is the same as \fBfile\fR, then it may be omitted\&. .sp - If +If \fBfile\fR is set to "\-", then the zone data is read from the standard input\&. - .RE - .PP +.RE +.PP \-K \fIdirectory\fR .RS 4 - Sets the directory in which the key files are to reside\&. - .RE - .PP +Sets the directory in which the key files are to reside\&. +.RE +.PP \-L \fIttl\fR .RS 4 - 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 +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\&. - .RE - .PP +.RE +.PP \-h .RS 4 - Emit usage message and exit\&. - .RE - .PP +Emit usage message and exit\&. +.RE +.PP \-v \fIlevel\fR .RS 4 - Sets the debugging level\&. - .RE - .PP +Sets the debugging level\&. +.RE +.PP \-V .RS 4 - Prints version information\&. - .RE - .SH "TIMING OPTIONS" - .PP +Prints version information\&. +.RE +.SH "TIMING OPTIONS" +.PP Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To explicitly prevent a date from being set, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&. - .PP +.PP \-P \fIdate/offset\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-P sync \fIdate/offset\fR .RS 4 - Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone\&. - .RE - .PP +Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone\&. +.RE +.PP \-D \fIdate/offset\fR .RS 4 - 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\&.) - .RE - .PP +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\&.) +.RE +.PP \-D sync \fIdate/offset\fR .RS 4 - Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted\&. - .RE - .SH "FILES" - .PP +Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted\&. +.RE +.SH "FILES" +.PP 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)\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBdnssec-keygen\fR(8), \fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, diff --git a/bin/dnssec/dnssec-importkey.html b/bin/dnssec/dnssec-importkey.html index 85017b35ee..28a1395555 100644 --- a/bin/dnssec/dnssec-importkey.html +++ b/bin/dnssec/dnssec-importkey.html @@ -14,56 +14,18 @@
- - - - - -
+

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] - [-P sync date/offset] - [-D date/offset] - [-D sync date/offset] - [-h] - [-v level] - [-V] - {keyfile} -

-

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

-
- -
+

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

+

dnssec-importkey {-f filename} [-K directory] [-L ttl] [-P date/offset] [-P sync date/offset] [-D date/offset] [-D sync 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 @@ -71,7 +33,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 @@ -80,68 +42,53 @@ 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 @@ -152,65 +99,47 @@ 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. -

-
+

-P sync date/offset
-
-

+

Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone. -

-
+

-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.) -

-
+

-D sync date/offset
-
-

+

Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. -

-
+

-
- -
+
+

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.8 b/bin/dnssec/dnssec-keyfromlabel.8 index e795905835..1b2a2f4d96 100644 --- a/bin/dnssec/dnssec-keyfromlabel.8 +++ b/bin/dnssec/dnssec-keyfromlabel.8 @@ -35,230 +35,204 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-keyfromlabel \- DNSSEC key generation tool - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-keyfromlabel\fR\ 'u - \fBdnssec\-keyfromlabel\fR - {\-l\ \fIlabel\fR} - [\fB\-3\fR] - [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] - [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-E\ \fR\fB\fIengine\fR\fR] - [\fB\-f\ \fR\fB\fIflag\fR\fR] - [\fB\-G\fR] - [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-i\ \fR\fB\fIinterval\fR\fR] - [\fB\-k\fR] - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - [\fB\-L\ \fR\fB\fIttl\fR\fR] - [\fB\-n\ \fR\fB\fInametype\fR\fR] - [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-P\ sync\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-p\ \fR\fB\fIprotocol\fR\fR] - [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-S\ \fR\fB\fIkey\fR\fR] - [\fB\-t\ \fR\fB\fItype\fR\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - [\fB\-V\fR] - [\fB\-y\fR] - {name} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-keyfromlabel\fR\ 'u +\fBdnssec\-keyfromlabel\fR {\-l\ \fIlabel\fR} [\fB\-3\fR] [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\ \fR\fB\fIflag\fR\fR] [\fB\-G\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-k\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-n\ \fR\fB\fInametype\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-P\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-p\ \fR\fB\fIprotocol\fR\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-S\ \fR\fB\fIkey\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-y\fR] {name} +.SH "DESCRIPTION" +.PP \fBdnssec\-keyfromlabel\fR 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 conventional signing key created by \fBdnssec\-keygen\fR, but the key material is stored within the HSM, and the actual signing takes place there\&. - .PP +.PP The \fBname\fR of the key is specified on the command line\&. This must match the name of the zone for which the key is being generated\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-a \fIalgorithm\fR .RS 4 - Selects the cryptographic algorithm\&. The value of +Selects the cryptographic algorithm\&. The value of \fBalgorithm\fR must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256, ECDSAP384SHA384, ED25519 or ED448\&. These values are case insensitive\&. .sp - If no algorithm is specified, then RSASHA1 will be used by default, unless the +If no algorithm is specified, then RSASHA1 will be used by default, unless the \fB\-3\fR option is specified, in which case NSEC3RSASHA1 will be used instead\&. (If \fB\-3\fR is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3\&.) .sp - Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended\&. +Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended\&. .sp - Note 2: DH automatically sets the \-k flag\&. - .RE - .PP +Note 2: DH automatically sets the \-k flag\&. +.RE +.PP \-3 .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-E \fIengine\fR .RS 4 - Specifies the cryptographic hardware to use\&. +Specifies the cryptographic hardware to use\&. .sp - 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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. - .RE - .PP +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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. +.RE +.PP \-l \fIlabel\fR .RS 4 - Specifies the label for a key pair in the crypto hardware\&. +Specifies the label for a key pair in the crypto hardware\&. .sp - When +When BIND 9 is built with OpenSSL\-based PKCS#11 support, the label is an arbitrary string that identifies a particular key\&. .sp - When +When BIND 9 is built with native PKCS#11 support, the label is a PKCS#11 URI string in the format "pkcs11:\fBkeyword\fR=\fIvalue\fR[;\fBkeyword\fR=\fIvalue\fR;\&.\&.\&.]" Keywords include "token", which identifies the HSM; "object", which identifies the key; and "pin\-source", which identifies a file from which the HSM\*(Aqs PIN code can be obtained\&. The label will be stored in the on\-disk "private" file\&. .sp - If the label contains a +If the label contains a \fBpin\-source\fR field, tools using the generated key files will be able to use the HSM for signing and other operations without any need for an operator to manually enter a PIN\&. Note: Making the HSM\*(Aqs PIN accessible in this manner may reduce the security advantage of using an HSM; be sure this is what you want to do before making use of this feature\&. - .RE - .PP +.RE +.PP \-n \fInametype\fR .RS 4 - Specifies the owner type of the key\&. The value of +Specifies the owner type of the key\&. The value of \fBnametype\fR 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\&. - .RE - .PP +.RE +.PP \-C .RS 4 - Compatibility mode: generates an old\-style key, without any metadata\&. By default, +Compatibility mode: generates an old\-style key, without any metadata\&. By default, \fBdnssec\-keyfromlabel\fR will include the key\*(Aqs creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc)\&. Keys that include this data may be incompatible with older versions of BIND; the \fB\-C\fR option suppresses them\&. - .RE - .PP +.RE +.PP \-c \fIclass\fR .RS 4 - Indicates that the DNS record containing the key should have the specified class\&. If not specified, class IN is used\&. - .RE - .PP +Indicates that the DNS record containing the key should have the specified class\&. If not specified, class IN is used\&. +.RE +.PP \-f \fIflag\fR .RS 4 - Set the specified flag in the flag field of the KEY/DNSKEY record\&. The only recognized flags are KSK (Key Signing Key) and REVOKE\&. - .RE - .PP +Set the specified flag in the flag field of the KEY/DNSKEY record\&. The only recognized flags are KSK (Key Signing Key) and REVOKE\&. +.RE +.PP \-G .RS 4 - Generate a key, but do not publish it or sign with it\&. This option is incompatible with \-P and \-A\&. - .RE - .PP +Generate a key, but do not publish it or sign with it\&. This option is incompatible with \-P and \-A\&. +.RE +.PP \-h .RS 4 - Prints a short summary of the options and arguments to +Prints a short summary of the options and arguments to \fBdnssec\-keyfromlabel\fR\&. - .RE - .PP +.RE +.PP \-K \fIdirectory\fR .RS 4 - Sets the directory in which the key files are to be written\&. - .RE - .PP +Sets the directory in which the key files are to be written\&. +.RE +.PP \-k .RS 4 - Generate KEY records rather than DNSKEY records\&. - .RE - .PP +Generate KEY records rather than DNSKEY records\&. +.RE +.PP \-L \fIttl\fR .RS 4 - 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 +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\&. - .RE - .PP +.RE +.PP \-p \fIprotocol\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-S \fIkey\fR .RS 4 - 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 key will be set to the inactivation date of the existing one\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&. - .RE - .PP +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 key will be set to the inactivation date of the existing one\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&. +.RE +.PP \-t \fItype\fR .RS 4 - Indicates the use of the key\&. +Indicates the use of the key\&. \fBtype\fR 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\&. - .RE - .PP +.RE +.PP \-v \fIlevel\fR .RS 4 - Sets the debugging level\&. - .RE - .PP +Sets the debugging level\&. +.RE +.PP \-V .RS 4 - Prints version information\&. - .RE - .PP +Prints version information\&. +.RE +.PP \-y .RS 4 - 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\*(Aqt be using RFC 5011 trust anchor maintenance with either of the keys involved\&.) - .RE - .SH "TIMING OPTIONS" - .PP +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\*(Aqt be using RFC 5011 trust anchor maintenance with either of the keys involved\&.) +.RE +.SH "TIMING OPTIONS" +.PP Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To explicitly prevent a date from being set, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&. - .PP +.PP \-P \fIdate/offset\fR .RS 4 - 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"\&. - .RE - .PP +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"\&. +.RE +.PP \-P sync \fIdate/offset\fR .RS 4 - Sets the date on which the CDS and CDNSKEY records which match this key are to be published to the zone\&. - .RE - .PP +Sets the date on which the CDS and CDNSKEY records which match this key are to be published to the zone\&. +.RE +.PP \-A \fIdate/offset\fR .RS 4 - 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"\&. - .RE - .PP +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"\&. +.RE +.PP \-R \fIdate/offset\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-I \fIdate/offset\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-D \fIdate/offset\fR .RS 4 - 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\&.) - .RE - .PP +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\&.) +.RE +.PP \-D sync \fIdate/offset\fR .RS 4 - Sets the date on which the CDS and CDNSKEY records which match this key are to be deleted\&. - .RE - .PP +Sets the date on which the CDS and CDNSKEY records which match this key are to be deleted\&. +.RE +.PP \-i \fIinterval\fR .RS 4 - 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 publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&. +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 publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&. .sp - 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\&. +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\&. .sp - As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&. - .RE - .SH "GENERATED KEY FILES" - .PP +As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&. +.RE +.SH "GENERATED KEY FILES" +.PP When \fBdnssec\-keyfromlabel\fR completes successfully, it prints a string of the form @@ -273,9 +247,9 @@ to the standard output\&. This is an identification string for the key files it .sp -1 .IP \(bu 2.3 .\} - nnnn +nnnn is the key name\&. - .RE +.RE .sp .RS 4 .ie n \{\ @@ -285,9 +259,9 @@ is the key name\&. .sp -1 .IP \(bu 2.3 .\} - aaa +aaa is the numeric representation of the algorithm\&. - .RE +.RE .sp .RS 4 .ie n \{\ @@ -297,26 +271,26 @@ is the numeric representation of the algorithm\&. .sp -1 .IP \(bu 2.3 .\} - iiiii +iiiii is the key identifier (or footprint)\&. - .RE - .PP +.RE +.PP \fBdnssec\-keyfromlabel\fR 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\&. - .PP +.PP The \&.key file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement)\&. - .PP +.PP The \&.private file contains algorithm\-specific fields\&. For obvious security reasons, this file does not have general read permission\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBdnssec-keygen\fR(8), \fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, diff --git a/bin/dnssec/dnssec-keyfromlabel.html b/bin/dnssec/dnssec-keyfromlabel.html index f28f5593c1..a37f183118 100644 --- a/bin/dnssec/dnssec-keyfromlabel.html +++ b/bin/dnssec/dnssec-keyfromlabel.html @@ -14,58 +14,17 @@
- - - - - -
+

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] - [-D sync date/offset] - [-E engine] - [-f flag] - [-G] - [-I date/offset] - [-i interval] - [-k] - [-K directory] - [-L ttl] - [-n nametype] - [-P date/offset] - [-P sync 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] [-D sync date/offset] [-E engine] [-f flag] [-G] [-I date/offset] [-i interval] [-k] [-K directory] [-L ttl] [-n nametype] [-P date/offset] [-P sync 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 @@ -73,57 +32,52 @@ 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, ECDSAP384SHA384, ED25519 or ED448. 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 @@ -131,18 +85,18 @@ (--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.

-

+

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;...]" @@ -151,7 +105,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 @@ -160,21 +114,18 @@ 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 @@ -182,71 +133,53 @@ (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 @@ -254,47 +187,35 @@ 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 @@ -305,67 +226,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. If not set, and if the -G option has not been used, the default is "now". -

-
+

-P sync date/offset
-
-

+

Sets the date on which the CDS and CDNSKEY records which match this key are to be published to the zone. -

-
+

-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.) -

-
+

-D sync date/offset
-
-

+

Sets the date on which the CDS and CDNSKEY records which match this key are to be deleted. -

-
+

-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 @@ -374,83 +280,68 @@ 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.8 b/bin/dnssec/dnssec-keygen.8 index 251ac11ef9..3497146d82 100644 --- a/bin/dnssec/dnssec-keygen.8 +++ b/bin/dnssec/dnssec-keygen.8 @@ -35,265 +35,234 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-keygen \- DNSSEC key generation tool - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-keygen\fR\ 'u - \fBdnssec\-keygen\fR - [\fB\-3\fR] - [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] - [\fB\-b\ \fR\fB\fIkeysize\fR\fR] - [\fB\-C\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-E\ \fR\fB\fIengine\fR\fR] - [\fB\-f\ \fR\fB\fIflag\fR\fR] - [\fB\-G\fR] - [\fB\-g\ \fR\fB\fIgenerator\fR\fR] - [\fB\-h\fR] - [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-i\ \fR\fB\fIinterval\fR\fR] - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - [\fB\-k\fR] - [\fB\-L\ \fR\fB\fIttl\fR\fR] - [\fB\-n\ \fR\fB\fInametype\fR\fR] - [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-P\ sync\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-p\ \fR\fB\fIprotocol\fR\fR] - [\fB\-q\fR] - [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] - [\fB\-S\ \fR\fB\fIkey\fR\fR] - [\fB\-s\ \fR\fB\fIstrength\fR\fR] - [\fB\-t\ \fR\fB\fItype\fR\fR] - [\fB\-V\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - {name} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-keygen\fR\ 'u +\fBdnssec\-keygen\fR [\fB\-3\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-C\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\ \fR\fB\fIflag\fR\fR] [\fB\-G\fR] [\fB\-g\ \fR\fB\fIgenerator\fR\fR] [\fB\-h\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-k\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-n\ \fR\fB\fInametype\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-P\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-p\ \fR\fB\fIprotocol\fR\fR] [\fB\-q\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] [\fB\-S\ \fR\fB\fIkey\fR\fR] [\fB\-s\ \fR\fB\fIstrength\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-V\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] {name} +.SH "DESCRIPTION" +.PP \fBdnssec\-keygen\fR 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\&. - .PP +.PP The \fBname\fR 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\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-3 .RS 4 - Use an NSEC3\-capable algorithm to generate a DNSSEC key\&. If this option is used with an algorithm that has both NSEC and NSEC3 versions, then the NSEC3 version will be used; for example, +Use an NSEC3\-capable algorithm to generate a DNSSEC key\&. If this option is used with an algorithm that has both NSEC and NSEC3 versions, then the NSEC3 version will be used; for example, \fBdnssec\-keygen \-3a RSASHA1\fR specifies the NSEC3RSASHA1 algorithm\&. - .RE - .PP +.RE +.PP \-a \fIalgorithm\fR .RS 4 - Selects the cryptographic algorithm\&. For DNSSEC keys, the value of +Selects the cryptographic algorithm\&. For DNSSEC keys, the value of \fBalgorithm\fR must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256, ECDSAP384SHA384, ED25519 or ED448\&. For TSIG/TKEY, the value must be DH (Diffie Hellman), HMAC\-MD5, HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256, HMAC\-SHA384, or HMAC\-SHA512\&. These values are case insensitive\&. .sp - If no algorithm is specified, then RSASHA1 will be used by default, unless the +If no algorithm is specified, then RSASHA1 will be used by default, unless the \fB\-3\fR option is specified, in which case NSEC3RSASHA1 will be used instead\&. (If \fB\-3\fR is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3\&.) .sp - Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended\&. For TSIG, HMAC\-MD5 is mandatory\&. +Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended\&. For TSIG, HMAC\-MD5 is mandatory\&. .sp - Note 2: DH, HMAC\-MD5, and HMAC\-SHA1 through HMAC\-SHA512 automatically set the \-T KEY option\&. - .RE - .PP +Note 2: DH, HMAC\-MD5, and HMAC\-SHA1 through HMAC\-SHA512 automatically set the \-T KEY option\&. +.RE +.PP \-b \fIkeysize\fR .RS 4 - 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 128 and 4096 bits\&. DSA keys must be between 512 and 1024 bits and an exact multiple of 64\&. HMAC keys must be between 1 and 512 bits\&. Elliptic curve algorithms don\*(Aqt need this parameter\&. +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 128 and 4096 bits\&. DSA keys must be between 512 and 1024 bits and an exact multiple of 64\&. HMAC keys must be between 1 and 512 bits\&. Elliptic curve algorithms don\*(Aqt need this parameter\&. .sp - 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 (ZSKs) and 2048 bits for key signing keys (KSKs, generated with +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 (ZSKs) and 2048 bits for key signing keys (KSKs, generated with \fB\-f KSK\fR)\&. However, if an algorithm is explicitly specified with the \fB\-a\fR, then there is no default key size, and the \fB\-b\fR must be used\&. - .RE - .PP +.RE +.PP \-C .RS 4 - Compatibility mode: generates an old\-style key, without any timing metadata\&. By default, +Compatibility mode: generates an old\-style key, without any timing metadata\&. By default, \fBdnssec\-keygen\fR will include the key\*(Aqs creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc)\&. Keys that include this data may be incompatible with older versions of BIND; the \fB\-C\fR option suppresses them\&. - .RE - .PP +.RE +.PP \-c \fIclass\fR .RS 4 - Indicates that the DNS record containing the key should have the specified class\&. If not specified, class IN is used\&. - .RE - .PP +Indicates that the DNS record containing the key should have the specified class\&. If not specified, class IN is used\&. +.RE +.PP \-E \fIengine\fR .RS 4 - Specifies the cryptographic hardware to use, when applicable\&. +Specifies the cryptographic hardware to use, when applicable\&. .sp - 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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. - .RE - .PP +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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. +.RE +.PP \-f \fIflag\fR .RS 4 - Set the specified flag in the flag field of the KEY/DNSKEY record\&. The only recognized flags are KSK (Key Signing Key) and REVOKE\&. - .RE - .PP +Set the specified flag in the flag field of the KEY/DNSKEY record\&. The only recognized flags are KSK (Key Signing Key) and REVOKE\&. +.RE +.PP \-G .RS 4 - Generate a key, but do not publish it or sign with it\&. This option is incompatible with \-P and \-A\&. - .RE - .PP +Generate a key, but do not publish it or sign with it\&. This option is incompatible with \-P and \-A\&. +.RE +.PP \-g \fIgenerator\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-h .RS 4 - Prints a short summary of the options and arguments to +Prints a short summary of the options and arguments to \fBdnssec\-keygen\fR\&. - .RE - .PP +.RE +.PP \-K \fIdirectory\fR .RS 4 - Sets the directory in which the key files are to be written\&. - .RE - .PP +Sets the directory in which the key files are to be written\&. +.RE +.PP \-k .RS 4 - Deprecated in favor of \-T KEY\&. - .RE - .PP +Deprecated in favor of \-T KEY\&. +.RE +.PP \-L \fIttl\fR .RS 4 - 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\&. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL\&. Setting the default TTL to +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\&. If this value is not set and there 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\&. - .RE - .PP +.RE +.PP \-n \fInametype\fR .RS 4 - Specifies the owner type of the key\&. The value of +Specifies the owner type of the key\&. The value of \fBnametype\fR 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\&. Defaults to ZONE for DNSKEY generation\&. - .RE - .PP +.RE +.PP \-p \fIprotocol\fR .RS 4 - Sets the protocol value for the generated key, for use with +Sets the protocol value for the generated key, for use with \fB\-T KEY\fR\&. 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\&. - .RE - .PP +.RE +.PP \-q .RS 4 - Quiet mode: Suppresses unnecessary output, including progress indication\&. Without this option, when +Quiet mode: Suppresses unnecessary output, including progress indication\&. Without this option, when \fBdnssec\-keygen\fR is run interactively to generate an RSA or DSA key pair, it will print a string of symbols to stderr indicating the progress of the key generation\&. A \*(Aq\&.\*(Aq indicates that a random number has been found which passed an initial sieve test; \*(Aq+\*(Aq means a number has passed a single round of the Miller\-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key\&. - .RE - .PP +.RE +.PP \-r \fIrandomdev\fR .RS 4 - Specifies the source of randomness\&. If the operating system does not provide a +Specifies the source of randomness\&. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness is keyboard input\&. randomdev specifies the name of a character device or file containing random data to be used instead of the default\&. The special value keyboard indicates that keyboard input should be used\&. - .RE - .PP +.RE +.PP \-S \fIkey\fR .RS 4 - 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 date of the new key will be set to the inactivation date of the existing one\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&. - .RE - .PP +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 date of the new key will be set to the inactivation date of the existing one\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&. +.RE +.PP \-s \fIstrength\fR .RS 4 - Specifies the strength value of the key\&. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC\&. - .RE - .PP +Specifies the strength value of the key\&. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC\&. +.RE +.PP \-T \fIrrtype\fR .RS 4 - Specifies the resource record type to use for the key\&. +Specifies the resource record type to use for the key\&. \fBrrtype\fR must be either DNSKEY or KEY\&. The default is DNSKEY when using a DNSSEC algorithm, but it can be overridden to KEY for use with SIG(0)\&. Using any TSIG algorithm (HMAC\-* or DH) forces this option to KEY\&. - .RE - .PP +.RE +.PP \-t \fItype\fR .RS 4 - Indicates the use of the key, for use with +Indicates the use of the key, for use with \fB\-T KEY\fR\&. \fBtype\fR 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\&. - .RE - .PP +.RE +.PP \-V .RS 4 - Prints version information\&. - .RE - .PP +Prints version information\&. +.RE +.PP \-v \fIlevel\fR .RS 4 - Sets the debugging level\&. - .RE - .SH "TIMING OPTIONS" - .PP +Sets the debugging level\&. +.RE +.SH "TIMING OPTIONS" +.PP Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To explicitly prevent a date from being set, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&. - .PP +.PP \-P \fIdate/offset\fR .RS 4 - 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"\&. - .RE - .PP +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"\&. +.RE +.PP \-P sync \fIdate/offset\fR .RS 4 - Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone\&. - .RE - .PP +Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone\&. +.RE +.PP \-A \fIdate/offset\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-R \fIdate/offset\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-I \fIdate/offset\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-D \fIdate/offset\fR .RS 4 - 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\&.) - .RE - .PP +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\&.) +.RE +.PP \-D sync \fIdate/offset\fR .RS 4 - Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted\&. - .RE - .PP +Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted\&. +.RE +.PP \-i \fIinterval\fR .RS 4 - 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 publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&. +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 publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&. .sp - 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\&. +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\&. .sp - As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&. - .RE - .SH "GENERATED KEYS" - .PP +As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&. +.RE +.SH "GENERATED KEYS" +.PP When \fBdnssec\-keygen\fR completes successfully, it prints a string of the form @@ -308,9 +277,9 @@ to the standard output\&. This is an identification string for the key it has ge .sp -1 .IP \(bu 2.3 .\} - nnnn +nnnn is the key name\&. - .RE +.RE .sp .RS 4 .ie n \{\ @@ -320,9 +289,9 @@ is the key name\&. .sp -1 .IP \(bu 2.3 .\} - aaa +aaa is the numeric representation of the algorithm\&. - .RE +.RE .sp .RS 4 .ie n \{\ @@ -332,53 +301,53 @@ is the numeric representation of the algorithm\&. .sp -1 .IP \(bu 2.3 .\} - iiiii +iiiii is the key identifier (or footprint)\&. - .RE - .PP +.RE +.PP \fBdnssec\-keygen\fR 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\&. - .PP +.PP The \&.key file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement)\&. - .PP +.PP The \&.private file contains algorithm\-specific fields\&. For obvious security reasons, this file does not have general read permission\&. - .PP +.PP Both \&.key and \&.private files are generated for symmetric cryptography algorithms such as HMAC\-MD5, even though the public and private key are equivalent\&. - .SH "EXAMPLE" - .PP +.SH "EXAMPLE" +.PP To generate a 768\-bit DSA key for the domain \fBexample\&.com\fR, the following command would be issued: - .PP +.PP \fBdnssec\-keygen \-a DSA \-b 768 \-n ZONE example\&.com\fR - .PP +.PP The command would print a string of the form: - .PP +.PP \fBKexample\&.com\&.+003+26160\fR - .PP +.PP In this example, \fBdnssec\-keygen\fR creates the files Kexample\&.com\&.+003+26160\&.key and Kexample\&.com\&.+003+26160\&.private\&. - .PP +.PP To generate a matching key\-signing key, issue the command: - .PP +.PP \fBdnssec\-keygen \-a DSA \-b 768 \-n ZONE \-f KSK example\&.com\fR - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, RFC 2539, diff --git a/bin/dnssec/dnssec-keygen.html b/bin/dnssec/dnssec-keygen.html index 4d383587ed..ac56ee99d9 100644 --- a/bin/dnssec/dnssec-keygen.html +++ b/bin/dnssec/dnssec-keygen.html @@ -14,93 +14,42 @@
- - - - - -
+

Name

-

- dnssec-keygen - — DNSSEC key generation tool -

+

dnssec-keygen — DNSSEC key generation tool

- - - -
+

Synopsis

-

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

-
- -
+

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

- - -
+
-3
-
-

+

Use an NSEC3-capable algorithm to generate a DNSSEC key. If this option is used with an algorithm that has both NSEC and NSEC3 versions, then the NSEC3 version will be used; for example, dnssec-keygen -3a RSASHA1 specifies the NSEC3RSASHA1 algorithm. -

-
+

-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, @@ -110,26 +59,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 @@ -138,7 +87,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 (ZSKs) and 2048 bits for key signing keys (KSKs, @@ -147,10 +96,9 @@ then there is no default key size, and the -b must be used.

-
+
-C
-
-

+

Compatibility mode: generates an old-style key, without any timing metadata. By default, dnssec-keygen will include the key's creation date in the metadata stored with @@ -158,21 +106,18 @@ (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 @@ -180,52 +125,39 @@ (--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 @@ -234,31 +166,25 @@ 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. -

-
+

-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. Defaults to ZONE for DNSKEY generation. -

-
+

-p protocol
-
-

+

Sets the protocol value for the generated key, for use with -T 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 @@ -270,11 +196,9 @@ 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 @@ -284,11 +208,9 @@ 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 @@ -296,19 +218,16 @@ 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 @@ -320,37 +239,28 @@ Using any TSIG algorithm (HMAC-* or DH) forces this option to KEY.

-
+
-t type
-
-

+

Indicates the use of the key, for use with -T 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
-
-

+

Prints version information. -

-
+

-v level
-
-

+

Sets the debugging level. -

-
+

-
- -
+
+

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 @@ -361,69 +271,54 @@ 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". -

-
+

-P sync date/offset
-
-

+

Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone. -

-
+

-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.) -

-
+

-D sync date/offset
-
-

+

Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. -

-
+

-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 @@ -432,51 +327,42 @@ 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 @@ -484,66 +370,59 @@ 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.

-

+

To generate a matching key-signing key, issue the command:

-

+

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

-
- -
+
+

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.8 b/bin/dnssec/dnssec-revoke.8 index 7ebaf099d5..60a196fa22 100644 --- a/bin/dnssec/dnssec-revoke.8 +++ b/bin/dnssec/dnssec-revoke.8 @@ -35,70 +35,62 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-revoke \- set the REVOKED bit on a DNSSEC key - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-revoke\fR\ 'u - \fBdnssec\-revoke\fR - [\fB\-hr\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - [\fB\-V\fR] - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - [\fB\-E\ \fR\fB\fIengine\fR\fR] - [\fB\-f\fR] - [\fB\-R\fR] - {keyfile} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-revoke\fR\ 'u +\fBdnssec\-revoke\fR [\fB\-hr\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\fR] [\fB\-R\fR] {keyfile} +.SH "DESCRIPTION" +.PP \fBdnssec\-revoke\fR 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\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-h .RS 4 - Emit usage message and exit\&. - .RE - .PP +Emit usage message and exit\&. +.RE +.PP \-K \fIdirectory\fR .RS 4 - Sets the directory in which the key files are to reside\&. - .RE - .PP +Sets the directory in which the key files are to reside\&. +.RE +.PP \-r .RS 4 - After writing the new keyset files remove the original keyset files\&. - .RE - .PP +After writing the new keyset files remove the original keyset files\&. +.RE +.PP \-v \fIlevel\fR .RS 4 - Sets the debugging level\&. - .RE - .PP +Sets the debugging level\&. +.RE +.PP \-V .RS 4 - Prints version information\&. - .RE - .PP +Prints version information\&. +.RE +.PP \-E \fIengine\fR .RS 4 - Specifies the cryptographic hardware to use, when applicable\&. +Specifies the cryptographic hardware to use, when applicable\&. .sp - 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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. - .RE - .PP +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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. +.RE +.PP \-f .RS 4 - Force overwrite: Causes +Force overwrite: Causes \fBdnssec\-revoke\fR to write the new key pair even if a file already exists matching the algorithm and key ID of the revoked key\&. - .RE - .PP +.RE +.PP \-R .RS 4 - Print the key tag of the key with the REVOKE bit set but do not revoke the key\&. - .RE - .SH "SEE ALSO" - .PP +Print the key tag of the key with the REVOKE bit set but do not revoke the key\&. +.RE +.SH "SEE ALSO" +.PP \fBdnssec-keygen\fR(8), BIND 9 Administrator Reference Manual, RFC 5011\&. diff --git a/bin/dnssec/dnssec-revoke.html b/bin/dnssec/dnssec-revoke.html index 56114b39de..2578146b40 100644 --- a/bin/dnssec/dnssec-revoke.html +++ b/bin/dnssec/dnssec-revoke.html @@ -14,88 +14,52 @@
- - - - - -
+

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 @@ -103,35 +67,26 @@ (--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.8 b/bin/dnssec/dnssec-settime.8 index c0cf7df5a4..d37f29e353 100644 --- a/bin/dnssec/dnssec-settime.8 +++ b/bin/dnssec/dnssec-settime.8 @@ -35,30 +35,13 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-settime \- set the key timing metadata for a DNSSEC key - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-settime\fR\ 'u - \fBdnssec\-settime\fR - [\fB\-f\fR] - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - [\fB\-L\ \fR\fB\fIttl\fR\fR] - [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-P\ sync\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] - [\fB\-S\ \fR\fB\fIkey\fR\fR] - [\fB\-i\ \fR\fB\fIinterval\fR\fR] - [\fB\-h\fR] - [\fB\-V\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - [\fB\-E\ \fR\fB\fIengine\fR\fR] - {keyfile} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-settime\fR\ 'u +\fBdnssec\-settime\fR [\fB\-f\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-P\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-S\ \fR\fB\fIkey\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-h\fR] [\fB\-V\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] {keyfile} +.SH "DESCRIPTION" +.PP \fBdnssec\-settime\fR reads a DNSSEC private key file and sets the key timing metadata as specified by the \fB\-P\fR, @@ -69,123 +52,123 @@ reads a DNSSEC private key file and sets the key timing metadata as specified by options\&. The metadata can then be used by \fBdnssec\-signzone\fR or other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc\&. - .PP +.PP If none of these options is set on the command line, then \fBdnssec\-settime\fR simply prints the key timing metadata already stored in the key\&. - .PP +.PP When key metadata fields are changed, both files of a key pair (Knnnn\&.+aaa+iiiii\&.key and Knnnn\&.+aaa+iiiii\&.private) are regenerated\&. Metadata fields are stored in the private file\&. A human\-readable description of the metadata is also placed in comments in the key file\&. The private file\*(Aqs permissions are always set to be inaccessible to anyone other than the owner (mode 0600)\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-f .RS 4 - Force an update of an old\-format key with no metadata fields\&. Without this option, +Force an update of an old\-format key with no metadata fields\&. Without this option, \fBdnssec\-settime\fR will fail when attempting to update a legacy key\&. With this option, the key will be recreated in the new format, but with the original key data retained\&. The key\*(Aqs creation date will be set to the present time\&. If no other values are specified, then the key\*(Aqs publication and activation dates will also be set to the present time\&. - .RE - .PP +.RE +.PP \-K \fIdirectory\fR .RS 4 - Sets the directory in which the key files are to reside\&. - .RE - .PP +Sets the directory in which the key files are to reside\&. +.RE +.PP \-L \fIttl\fR .RS 4 - 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\&. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL\&. Setting the default TTL to +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\&. If this value is not set and there 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\&. - .RE - .PP +.RE +.PP \-h .RS 4 - Emit usage message and exit\&. - .RE - .PP +Emit usage message and exit\&. +.RE +.PP \-V .RS 4 - Prints version information\&. - .RE - .PP +Prints version information\&. +.RE +.PP \-v \fIlevel\fR .RS 4 - Sets the debugging level\&. - .RE - .PP +Sets the debugging level\&. +.RE +.PP \-E \fIengine\fR .RS 4 - Specifies the cryptographic hardware to use, when applicable\&. +Specifies the cryptographic hardware to use, when applicable\&. .sp - 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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. - .RE - .SH "TIMING OPTIONS" - .PP +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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. +.RE +.SH "TIMING OPTIONS" +.PP Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To unset a date, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&. - .PP +.PP \-P \fIdate/offset\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-P sync \fIdate/offset\fR .RS 4 - Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone\&. - .RE - .PP +Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone\&. +.RE +.PP \-A \fIdate/offset\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-R \fIdate/offset\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-I \fIdate/offset\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-D \fIdate/offset\fR .RS 4 - 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\&.) - .RE - .PP +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\&.) +.RE +.PP \-D sync \fIdate/offset\fR .RS 4 - Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted\&. - .RE - .PP +Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted\&. +.RE +.PP \-S \fIpredecessor key\fR .RS 4 - 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 modified\&. The activation date of the successor key will be set 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\&. - .RE - .PP +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 modified\&. The activation date of the successor key will be set 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\&. +.RE +.PP \-i \fIinterval\fR .RS 4 - 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 publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&. +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 publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&. .sp - 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\&. +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\&. .sp - As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&. - .RE - .SH "PRINTING OPTIONS" - .PP +As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&. +.RE +.SH "PRINTING OPTIONS" +.PP \fBdnssec\-settime\fR can also be used to print the timing metadata associated with a key\&. - .PP +.PP \-u .RS 4 - Print times in UNIX epoch format\&. - .RE - .PP +Print times in UNIX epoch format\&. +.RE +.PP \-p \fIC/P/Psync/A/R/I/D/Dsync/all\fR .RS 4 - Print a specific metadata value or set of metadata values\&. The +Print a specific metadata value or set of metadata values\&. The \fB\-p\fR option may be followed by one or more of the following letters or strings to indicate which value or values to print: \fBC\fR @@ -205,9 +188,9 @@ for the deletion date, and \fBDsync\fR for the CDS and CDNSKEY deletion date To print all of the metadata, use \fB\-p all\fR\&. - .RE - .SH "SEE ALSO" - .PP +.RE +.SH "SEE ALSO" +.PP \fBdnssec-keygen\fR(8), \fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, diff --git a/bin/dnssec/dnssec-settime.html b/bin/dnssec/dnssec-settime.html index 5e30cf0328..3d3cf09b6e 100644 --- a/bin/dnssec/dnssec-settime.html +++ b/bin/dnssec/dnssec-settime.html @@ -14,49 +14,17 @@
- - - - - -
+

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] - [-P sync date/offset] - [-A date/offset] - [-R date/offset] - [-I date/offset] - [-D date/offset] - [-D sync date/offset] - [-S key] - [-i interval] - [-h] - [-V] - [-v level] - [-E engine] - {keyfile} -

-
- -
+

dnssec-settime [-f] [-K directory] [-L ttl] [-P date/offset] [-P sync date/offset] [-A date/offset] [-R date/offset] [-I date/offset] [-D date/offset] [-D sync date/offset] [-S key] [-i interval] [-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 @@ -65,12 +33,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. @@ -79,16 +47,12 @@ 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, @@ -97,17 +61,13 @@ 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 @@ -116,32 +76,25 @@ 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 @@ -149,14 +102,12 @@ (--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 @@ -166,65 +117,49 @@ 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. -

-
+

-P sync date/offset
-
-

+

Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone. -

-
+

-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.) -

-
+

-D sync date/offset
-
-

+

Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. -

-
+

-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 @@ -232,11 +167,10 @@ 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 @@ -245,40 +179,34 @@ 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/Psync/A/R/I/D/Dsync/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 or strings to indicate which value @@ -292,24 +220,16 @@ D for the deletion date, and Dsync for the CDS and CDNSKEY 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.8 b/bin/dnssec/dnssec-signzone.8 index 32fd7d1d36..53b07337d6 100644 --- a/bin/dnssec/dnssec-signzone.8 +++ b/bin/dnssec/dnssec-signzone.8 @@ -35,132 +35,92 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-signzone \- DNSSEC zone signing tool - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-signzone\fR\ 'u - \fBdnssec\-signzone\fR - [\fB\-a\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-d\ \fR\fB\fIdirectory\fR\fR] - [\fB\-D\fR] - [\fB\-E\ \fR\fB\fIengine\fR\fR] - [\fB\-e\ \fR\fB\fIend\-time\fR\fR] - [\fB\-f\ \fR\fB\fIoutput\-file\fR\fR] - [\fB\-g\fR] - [\fB\-h\fR] - [\fB\-i\ \fR\fB\fIinterval\fR\fR] - [\fB\-I\ \fR\fB\fIinput\-format\fR\fR] - [\fB\-j\ \fR\fB\fIjitter\fR\fR] - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - [\fB\-k\ \fR\fB\fIkey\fR\fR] - [\fB\-L\ \fR\fB\fIserial\fR\fR] - [\fB\-l\ \fR\fB\fIdomain\fR\fR] - [\fB\-M\ \fR\fB\fImaxttl\fR\fR] - [\fB\-N\ \fR\fB\fIsoa\-serial\-format\fR\fR] - [\fB\-o\ \fR\fB\fIorigin\fR\fR] - [\fB\-O\ \fR\fB\fIoutput\-format\fR\fR] - [\fB\-P\fR] - [\fB\-p\fR] - [\fB\-Q\fR] - [\fB\-R\fR] - [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] - [\fB\-S\fR] - [\fB\-s\ \fR\fB\fIstart\-time\fR\fR] - [\fB\-T\ \fR\fB\fIttl\fR\fR] - [\fB\-t\fR] - [\fB\-u\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - [\fB\-V\fR] - [\fB\-X\ \fR\fB\fIextended\ end\-time\fR\fR] - [\fB\-x\fR] - [\fB\-z\fR] - [\fB\-3\ \fR\fB\fIsalt\fR\fR] - [\fB\-H\ \fR\fB\fIiterations\fR\fR] - [\fB\-A\fR] - {zonefile} - [key...] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-signzone\fR\ 'u +\fBdnssec\-signzone\fR [\fB\-a\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-d\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-e\ \fR\fB\fIend\-time\fR\fR] [\fB\-f\ \fR\fB\fIoutput\-file\fR\fR] [\fB\-g\fR] [\fB\-h\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-I\ \fR\fB\fIinput\-format\fR\fR] [\fB\-j\ \fR\fB\fIjitter\fR\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-k\ \fR\fB\fIkey\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-M\ \fR\fB\fImaxttl\fR\fR] [\fB\-N\ \fR\fB\fIsoa\-serial\-format\fR\fR] [\fB\-o\ \fR\fB\fIorigin\fR\fR] [\fB\-O\ \fR\fB\fIoutput\-format\fR\fR] [\fB\-P\fR] [\fB\-p\fR] [\fB\-Q\fR] [\fB\-R\fR] [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] [\fB\-S\fR] [\fB\-s\ \fR\fB\fIstart\-time\fR\fR] [\fB\-T\ \fR\fB\fIttl\fR\fR] [\fB\-t\fR] [\fB\-u\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-X\ \fR\fB\fIextended\ end\-time\fR\fR] [\fB\-x\fR] [\fB\-z\fR] [\fB\-3\ \fR\fB\fIsalt\fR\fR] [\fB\-H\ \fR\fB\fIiterations\fR\fR] [\fB\-A\fR] {zonefile} [key...] +.SH "DESCRIPTION" +.PP \fBdnssec\-signzone\fR 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 (that is, whether the child zones are secure or not) is determined by the presence or absence of a keyset file for each child zone\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-a .RS 4 - Verify all generated signatures\&. - .RE - .PP +Verify all generated signatures\&. +.RE +.PP \-c \fIclass\fR .RS 4 - Specifies the DNS class of the zone\&. - .RE - .PP +Specifies the DNS class of the zone\&. +.RE +.PP \-C .RS 4 - Compatibility mode: Generate a +Compatibility mode: Generate a keyset\-\fIzonename\fR file in addition to dsset\-\fIzonename\fR when signing a zone, for use by older versions of \fBdnssec\-signzone\fR\&. - .RE - .PP +.RE +.PP \-d \fIdirectory\fR .RS 4 - Look for +Look for dsset\- or keyset\- files in \fBdirectory\fR\&. - .RE - .PP +.RE +.PP \-D .RS 4 - Output only those record types automatically managed by +Output only those record types automatically managed by \fBdnssec\-signzone\fR, i\&.e\&. RRSIG, NSEC, NSEC3 and NSEC3PARAM records\&. If smart signing (\fB\-S\fR) is used, DNSKEY records are also included\&. The resulting file can be included in the original zone file with \fB$INCLUDE\fR\&. This option cannot be combined with \fB\-O raw\fR, \fB\-O map\fR, or serial number updating\&. - .RE - .PP +.RE +.PP \-E \fIengine\fR .RS 4 - When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing\&. +When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing\&. .sp - 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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. - .RE - .PP +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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. +.RE +.PP \-g .RS 4 - Generate DS records for child zones from +Generate DS records for child zones from dsset\- or keyset\- file\&. Existing DS records will be removed\&. - .RE - .PP +.RE +.PP \-K \fIdirectory\fR .RS 4 - Key repository: Specify a directory to search for DNSSEC keys\&. If not specified, defaults to the current directory\&. - .RE - .PP +Key repository: Specify a directory to search for DNSSEC keys\&. If not specified, defaults to the current directory\&. +.RE +.PP \-k \fIkey\fR .RS 4 - Treat specified key as a key signing key ignoring any key flags\&. This option may be specified multiple times\&. - .RE - .PP +Treat specified key as a key signing key ignoring any key flags\&. This option may be specified multiple times\&. +.RE +.PP \-l \fIdomain\fR .RS 4 - Generate a DLV set in addition to the key (DNSKEY) and DS sets\&. The domain is appended to the name of the records\&. - .RE - .PP +Generate a DLV set in addition to the key (DNSKEY) and DS sets\&. The domain is appended to the name of the records\&. +.RE +.PP \-M \fImaxttl\fR .RS 4 - Sets the maximum TTL for the signed zone\&. Any TTL higher than +Sets the maximum TTL for the signed zone\&. Any TTL higher than \fImaxttl\fR in the input zone will be reduced to \fImaxttl\fR @@ -169,31 +129,31 @@ in the output\&. This provides certainty as to the largest possible TTL in the s in named\&.conf\&. (Note: This option is incompatible with \fB\-D\fR, because it modifies non\-DNSSEC data in the output zone\&.) - .RE - .PP +.RE +.PP \-s \fIstart\-time\fR .RS 4 - 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 in YYYYMMDDHHMMSS notation; 20000530144500 denotes 14:45:00 UTC on May 30th, 2000\&. A relative start time is indicated by +N, which is N seconds from the current time\&. If no +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 in YYYYMMDDHHMMSS notation; 20000530144500 denotes 14:45:00 UTC on May 30th, 2000\&. A relative start time is indicated by +N, which is N seconds from the current time\&. If no \fBstart\-time\fR is specified, the current time minus 1 hour (to allow for clock skew) is used\&. - .RE - .PP +.RE +.PP \-e \fIend\-time\fR .RS 4 - Specify the date and time when the generated RRSIG records expire\&. As with +Specify the date and time when the generated RRSIG records expire\&. As with \fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation\&. A time relative to the start time is indicated with +N, which is N seconds from the start time\&. A time relative to the current time is indicated with now+N\&. If no \fBend\-time\fR is specified, 30 days from the start time is used as a default\&. \fBend\-time\fR must be later than \fBstart\-time\fR\&. - .RE - .PP +.RE +.PP \-X \fIextended end\-time\fR .RS 4 - 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 signatures on other records; e\&.g\&., when the private component of the KSK is kept offline and the KSK signature is to be refreshed manually\&. +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 signatures on other records; e\&.g\&., when the private component of the KSK is kept offline and the KSK signature is to be refreshed manually\&. .sp - As with +As with \fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation\&. A time relative to the start time is indicated with +N, which is N seconds from the start time\&. A time relative to the current time is indicated with now+N\&. If no \fBextended end\-time\fR is specified, the value of @@ -202,111 +162,110 @@ is used as the default\&. (\fBend\-time\fR, in turn, defaults to 30 days from th \fBextended end\-time\fR must be later than \fBstart\-time\fR\&. - .RE - .PP +.RE +.PP \-f \fIoutput\-file\fR .RS 4 - The name of the output file containing the signed zone\&. The default is to append +The name of the output file containing the signed zone\&. The default is to append \&.signed to the input filename\&. If \fBoutput\-file\fR is set to "\-", then the signed zone is written to the standard output, with a default output format of "full"\&. - .RE - .PP +.RE +.PP \-h .RS 4 - Prints a short summary of the options and arguments to +Prints a short summary of the options and arguments to \fBdnssec\-signzone\fR\&. - .RE - .PP +.RE +.PP \-V .RS 4 - Prints version information\&. - .RE - .PP +Prints version information\&. +.RE +.PP \-i \fIinterval\fR .RS 4 - When a previously\-signed zone is passed as input, records may be resigned\&. The +When a previously\-signed zone is passed as input, records may be resigned\&. The \fBinterval\fR option specifies the cycle interval as an offset from the current time (in seconds)\&. If a RRSIG record expires after the cycle interval, it is retained\&. Otherwise, it is considered to be expiring soon, and it will be replaced\&. .sp - The default cycle interval is one quarter of the difference between the signature end and start times\&. So if neither +The default cycle interval is one quarter of the difference between the signature end and start times\&. So if neither \fBend\-time\fR or \fBstart\-time\fR are specified, \fBdnssec\-signzone\fR generates signatures that are valid for 30 days, with a cycle interval of 7\&.5 days\&. Therefore, if any existing RRSIG records are due to expire in less than 7\&.5 days, they would be replaced\&. - .RE - .PP +.RE +.PP \-I \fIinput\-format\fR .RS 4 - The format of the input zone file\&. Possible formats are +The format of the input zone file\&. Possible formats are \fB"text"\fR (default), \fB"raw"\fR, and \fB"map"\fR\&. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be signed directly\&. The use of this option does not make much sense for non\-dynamic zones\&. - .RE - .PP +.RE +.PP \-j \fIjitter\fR .RS 4 - 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\&. a previously\-signed zone is passed as input to the signer, all expired signatures have to be regenerated at about the same time\&. The +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\&. a previously\-signed zone is passed as input to the signer, all expired signatures have to be regenerated at about the same time\&. The \fBjitter\fR option specifies a jitter window that will be used to randomize the signature expire time, thus spreading incremental signature regeneration over time\&. .sp - Signature lifetime jitter also to some extent benefits validators and servers by spreading out cache expiration, i\&.e\&. if large numbers of RRSIGs don\*(Aqt 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\&. - .RE - .PP +Signature lifetime jitter also to some extent benefits validators and servers by spreading out cache expiration, i\&.e\&. if large numbers of RRSIGs don\*(Aqt 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\&. +.RE +.PP \-L \fIserial\fR .RS 4 - 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\&.) - .RE - .PP +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\&.) +.RE +.PP \-n \fIncpus\fR .RS 4 - Specifies the number of threads to use\&. By default, one thread is started for each detected CPU\&. - .RE - .PP +Specifies the number of threads to use\&. By default, one thread is started for each detected CPU\&. +.RE +.PP \-N \fIsoa\-serial\-format\fR .RS 4 - The SOA serial number format of the signed zone\&. Possible formats are +The SOA serial number format of the signed zone\&. Possible formats are \fB"keep"\fR (default), \fB"increment"\fR, \fB"unixtime"\fR, and \fB"date"\fR\&. - .PP +.PP \fB"keep"\fR .RS 4 - Do not modify the SOA serial number\&. - .RE - .PP +Do not modify the SOA serial number\&. +.RE +.PP \fB"increment"\fR .RS 4 - Increment the SOA serial number using RFC 1982 arithmetics\&. - .RE - .PP +Increment the SOA serial number using RFC 1982 arithmetics\&. +.RE +.PP \fB"unixtime"\fR .RS 4 - Set the SOA serial number to the number of seconds since epoch\&. - .RE - .PP +Set the SOA serial number to the number of seconds since epoch\&. +.RE +.PP \fB"date"\fR .RS 4 - Set the SOA serial number to today\*(Aqs date in YYYYMMDDNN format\&. - .RE - .sp - .RE - .PP +Set the SOA serial number to today\*(Aqs date in YYYYMMDDNN format\&. +.RE +.RE +.PP \-o \fIorigin\fR .RS 4 - The zone origin\&. If not specified, the name of the zone file is assumed to be the origin\&. - .RE - .PP +The zone origin\&. If not specified, the name of the zone file is assumed to be the origin\&. +.RE +.PP \-O \fIoutput\-format\fR .RS 4 - The format of the output file containing the signed zone\&. Possible formats are +The format of the output file containing the signed zone\&. Possible formats are \fB"text"\fR (default), which is the standard textual representation of the zone; \fB"full"\fR, which is text output in a format suitable for processing by external scripts; and @@ -317,152 +276,151 @@ option specifies a jitter window that will be used to randomize the signature ex \fB"raw=N"\fR specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of \fBnamed\fR; if N is 1, the file can be read by release 9\&.9\&.0 or higher; the default is 1\&. - .RE - .PP +.RE +.PP \-p .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-P .RS 4 - Disable post sign verification tests\&. +Disable post sign verification tests\&. .sp - 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\&. - .RE - .PP +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\&. +.RE +.PP \-Q .RS 4 - Remove signatures from keys that are no longer active\&. +Remove signatures from keys that are no longer active\&. .sp - 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 that are still within their validity period are retained\&. This allows the zone to continue to validate with cached copies of the old DNSKEY RRset\&. The +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 that are still within their validity period are retained\&. This allows the zone to continue to validate with cached copies of the old DNSKEY RRset\&. The \fB\-Q\fR forces \fBdnssec\-signzone\fR to remove signatures from keys that are no longer active\&. This enables ZSK rollover using the procedure described in RFC 4641, section 4\&.2\&.1\&.1 ("Pre\-Publish Key Rollover")\&. - .RE - .PP +.RE +.PP \-R .RS 4 - Remove signatures from keys that are no longer published\&. +Remove signatures from keys that are no longer published\&. .sp - This option is similar to +This option is similar to \fB\-Q\fR, except it forces \fBdnssec\-signzone\fR 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")\&. - .RE - .PP +.RE +.PP \-r \fIrandomdev\fR .RS 4 - Specifies the source of randomness\&. If the operating system does not provide a +Specifies the source of randomness\&. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness is keyboard input\&. randomdev specifies the name of a character device or file containing random data to be used instead of the default\&. The special value keyboard indicates that keyboard input should be used\&. - .RE - .PP +.RE +.PP \-S .RS 4 - Smart signing: Instructs +Smart signing: Instructs \fBdnssec\-signzone\fR to search the key repository for keys that match the zone being signed, and to include them in the zone if appropriate\&. .sp - 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: - .PP +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: +.PP .RS 4 - If no timing metadata has been set for the key, the key is published in the zone and used to sign the zone\&. - .RE - .PP +If no timing metadata has been set for the key, the key is published in the zone and used to sign the zone\&. +.RE +.PP .RS 4 - If the key\*(Aqs publication date is set and is in the past, the key is published in the zone\&. - .RE - .PP +If the key\*(Aqs publication date is set and is in the past, the key is published in the zone\&. +.RE +.PP .RS 4 - If the key\*(Aqs activation date is set and in the past, the key is published (regardless of publication date) and used to sign the zone\&. - .RE - .PP +If the key\*(Aqs activation date is set and in the past, the key is published (regardless of publication date) and used to sign the zone\&. +.RE +.PP .RS 4 - If the key\*(Aqs 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\&. - .RE - .PP +If the key\*(Aqs 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\&. +.RE +.PP .RS 4 - If either of the key\*(Aqs 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\&. - .RE - .sp - .RE - .PP +If either of the key\*(Aqs 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\&. +.RE +.RE +.PP \-T \fIttl\fR .RS 4 - 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\*(Aqs SOA record\&. This option is ignored when signing without +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\*(Aqs SOA record\&. This option is ignored when signing without \fB\-S\fR, since DNSKEY records are not imported from the key repository in that case\&. It is also ignored if there are any pre\-existing DNSKEY records at the zone apex, in which case new records\*(Aq TTL values will be set to match 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\&. - .RE - .PP +.RE +.PP \-t .RS 4 - Print statistics at completion\&. - .RE - .PP +Print statistics at completion\&. +.RE +.PP \-u .RS 4 - 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, +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, \fBdnssec\-signzone\fR will retain the existing chain when re\-signing\&. - .RE - .PP +.RE +.PP \-v \fIlevel\fR .RS 4 - Sets the debugging level\&. - .RE - .PP +Sets the debugging level\&. +.RE +.PP \-x .RS 4 - Only sign the DNSKEY RRset with key\-signing keys, and omit signatures from zone\-signing keys\&. (This is similar to the +Only sign the DNSKEY RRset with key\-signing keys, and omit signatures from zone\-signing keys\&. (This is similar to the \fBdnssec\-dnskey\-kskonly yes;\fR zone option in \fBnamed\fR\&.) - .RE - .PP +.RE +.PP \-z .RS 4 - 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 +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 \fBupdate\-check\-ksk no;\fR zone option in \fBnamed\fR\&.) - .RE - .PP +.RE +.PP \-3 \fIsalt\fR .RS 4 - Generate an NSEC3 chain with the given hex encoded salt\&. A dash (\fIsalt\fR) can be used to indicate that no salt is to be used when generating the NSEC3 chain\&. - .RE - .PP +Generate an NSEC3 chain with the given hex encoded salt\&. A dash (\fIsalt\fR) can be used to indicate that no salt is to be used when generating the NSEC3 chain\&. +.RE +.PP \-H \fIiterations\fR .RS 4 - When generating an NSEC3 chain, use this many iterations\&. The default is 10\&. - .RE - .PP +When generating an NSEC3 chain, use this many iterations\&. The default is 10\&. +.RE +.PP \-A .RS 4 - When generating an NSEC3 chain set the OPTOUT flag on all NSEC3 records and do not generate NSEC3 records for insecure delegations\&. +When generating an NSEC3 chain set the OPTOUT flag on all NSEC3 records and do not generate NSEC3 records for insecure delegations\&. .sp - Using this option twice (i\&.e\&., +Using this option twice (i\&.e\&., \fB\-AA\fR) turns the OPTOUT flag off for all records\&. This is useful when using the \fB\-u\fR option to modify an NSEC3 chain which previously had OPTOUT set\&. - .RE - .PP +.RE +.PP zonefile .RS 4 - The file containing the zone to be signed\&. - .RE - .PP +The file containing the zone to be signed\&. +.RE +.PP key .RS 4 - 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\&. - .RE - .SH "EXAMPLE" - .PP +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\&. +.RE +.SH "EXAMPLE" +.PP The following command signs the \fBexample\&.com\fR zone with the DSA key generated by @@ -485,15 +443,14 @@ db\&.example\&.com\&.signed .if n \{\ .RE .\} -.sp - .PP +.PP In the above example, \fBdnssec\-signzone\fR creates the file db\&.example\&.com\&.signed\&. This file should be referenced in a zone statement in a named\&.conf file\&. - .PP +.PP This example re\-signs a previously signed zone with default parameters\&. The private keys are assumed to be in the current directory\&. .sp .if n \{\ @@ -508,9 +465,8 @@ db\&.example\&.com\&.signed .if n \{\ .RE .\} -.sp - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBdnssec-keygen\fR(8), BIND 9 Administrator Reference Manual, RFC 4033, diff --git a/bin/dnssec/dnssec-signzone.html b/bin/dnssec/dnssec-signzone.html index c60ed6394e..8b6ed1c85f 100644 --- a/bin/dnssec/dnssec-signzone.html +++ b/bin/dnssec/dnssec-signzone.html @@ -14,72 +14,17 @@
- - - - - -
+

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] - [-i interval] - [-I input-format] - [-j jitter] - [-K directory] - [-k key] - [-L serial] - [-l domain] - [-M maxttl] - [-N soa-serial-format] - [-o origin] - [-O output-format] - [-P] - [-p] - [-Q] - [-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] [-i interval] [-I input-format] [-j jitter] [-K directory] [-k key] [-L serial] [-l domain] [-M maxttl] [-N soa-serial-format] [-o origin] [-O output-format] [-P] [-p] [-Q] [-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 @@ -87,46 +32,34 @@ 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 @@ -135,16 +68,15 @@ 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 @@ -152,39 +84,30 @@ (--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 @@ -197,11 +120,9 @@ 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 @@ -210,11 +131,9 @@ 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 @@ -224,11 +143,10 @@ 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 @@ -236,7 +154,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 @@ -247,34 +165,28 @@ 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 @@ -282,7 +194,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 @@ -293,10 +205,9 @@ 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". @@ -305,11 +216,10 @@ 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. @@ -320,72 +230,55 @@ 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", "unixtime", and "date".

- -
+
"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.

"date"
-
-

Set the SOA serial number to today's date in - YYYYMMDDNN format.

-
+

Set the SOA serial number to today's date in + YYYYMMDDNN format.

- -
+
-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; @@ -398,36 +291,33 @@ 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 @@ -439,23 +329,22 @@ 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 @@ -465,65 +354,53 @@ 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 @@ -535,102 +412,81 @@ 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 @@ -643,13 +499,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.

@@ -657,18 +513,13 @@ 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.8 b/bin/dnssec/dnssec-verify.8 index c39736d158..5fef4e6336 100644 --- a/bin/dnssec/dnssec-verify.8 +++ b/bin/dnssec/dnssec-verify.8 @@ -35,85 +35,76 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-verify \- DNSSEC zone verification tool - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-verify\fR\ 'u - \fBdnssec\-verify\fR - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-E\ \fR\fB\fIengine\fR\fR] - [\fB\-I\ \fR\fB\fIinput\-format\fR\fR] - [\fB\-o\ \fR\fB\fIorigin\fR\fR] - [\fB\-v\ \fR\fB\fIlevel\fR\fR] - [\fB\-V\fR] - [\fB\-x\fR] - [\fB\-z\fR] - {zonefile} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-verify\fR\ 'u +\fBdnssec\-verify\fR [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-I\ \fR\fB\fIinput\-format\fR\fR] [\fB\-o\ \fR\fB\fIorigin\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-x\fR] [\fB\-z\fR] {zonefile} +.SH "DESCRIPTION" +.PP \fBdnssec\-verify\fR 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\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-c \fIclass\fR .RS 4 - Specifies the DNS class of the zone\&. - .RE - .PP +Specifies the DNS class of the zone\&. +.RE +.PP \-E \fIengine\fR .RS 4 - Specifies the cryptographic hardware to use, when applicable\&. +Specifies the cryptographic hardware to use, when applicable\&. .sp - 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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. - .RE - .PP +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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. +.RE +.PP \-I \fIinput\-format\fR .RS 4 - The format of the input zone file\&. Possible formats are +The format of the input zone file\&. Possible formats are \fB"text"\fR (default) and \fB"raw"\fR\&. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be verified independently\&. The use of this option does not make much sense for non\-dynamic zones\&. - .RE - .PP +.RE +.PP \-o \fIorigin\fR .RS 4 - The zone origin\&. If not specified, the name of the zone file is assumed to be the origin\&. - .RE - .PP +The zone origin\&. If not specified, the name of the zone file is assumed to be the origin\&. +.RE +.PP \-v \fIlevel\fR .RS 4 - Sets the debugging level\&. - .RE - .PP +Sets the debugging level\&. +.RE +.PP \-V .RS 4 - Prints version information\&. - .RE - .PP +Prints version information\&. +.RE +.PP \-x .RS 4 - 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 +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 \fB\-x\fR option in \fBdnssec\-signzone\fR\&. - .RE - .PP +.RE +.PP \-z .RS 4 - 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 DNSKEY with the KSK flag set for each algorithm and that RRsets other than DNSKEY RRset will be signed with a different DNSKEY without the KSK flag set\&. +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 DNSKEY with the KSK flag set for each algorithm and that RRsets other than DNSKEY RRset will be signed with a different DNSKEY without the KSK flag set\&. .sp - 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 will be signed by a non\-revoked key for the same algorithm that includes the self\-signed key; the same key may be used for both purposes\&. This corresponds to the +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 will be signed by a non\-revoked key for the same algorithm that includes the self\-signed key; the same key may be used for both purposes\&. This corresponds to the \fB\-z\fR option in \fBdnssec\-signzone\fR\&. - .RE - .PP +.RE +.PP zonefile .RS 4 - The file containing the zone to be signed\&. - .RE - .SH "SEE ALSO" - .PP +The file containing the zone to be signed\&. +.RE +.SH "SEE ALSO" +.PP \fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, RFC 4033\&. diff --git a/bin/dnssec/dnssec-verify.html b/bin/dnssec/dnssec-verify.html index f6a3018e3d..78d412119f 100644 --- a/bin/dnssec/dnssec-verify.html +++ b/bin/dnssec/dnssec-verify.html @@ -14,64 +14,35 @@
- - - - - -
+

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 @@ -79,10 +50,9 @@ (--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". @@ -91,41 +61,32 @@ 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 @@ -133,7 +94,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 @@ -142,27 +103,20 @@ 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.8 b/bin/named/lwresd.8 index be48ba6e6b..aa2c33b1f8 100644 --- a/bin/named/lwresd.8 +++ b/bin/named/lwresd.8 @@ -35,43 +35,25 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwresd \- lightweight resolver daemon - .SH "SYNOPSIS" - .HP \w'\fBlwresd\fR\ 'u - \fBlwresd\fR - [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] - [\fB\-C\ \fR\fB\fIconfig\-file\fR\fR] - [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] - [\fB\-f\fR] - [\fB\-g\fR] - [\fB\-i\ \fR\fB\fIpid\-file\fR\fR] - [\fB\-m\ \fR\fB\fIflag\fR\fR] - [\fB\-n\ \fR\fB\fI#cpus\fR\fR] - [\fB\-P\ \fR\fB\fIport\fR\fR] - [\fB\-p\ \fR\fB\fIport\fR\fR] - [\fB\-s\fR] - [\fB\-t\ \fR\fB\fIdirectory\fR\fR] - [\fB\-u\ \fR\fB\fIuser\fR\fR] - [\fB\-v\fR] - [ - | [\fB\-4\fR] - | [\fB\-6\fR] - ] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBlwresd\fR\ 'u +\fBlwresd\fR [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-C\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] [\fB\-f\fR] [\fB\-g\fR] [\fB\-i\ \fR\fB\fIpid\-file\fR\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [\fB\-n\ \fR\fB\fI#cpus\fR\fR] [\fB\-P\ \fR\fB\fIport\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-s\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [[\fB\-4\fR] | [\fB\-6\fR]] +.SH "DESCRIPTION" +.PP \fBlwresd\fR 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\&. - .PP +.PP \fBlwresd\fR listens for resolver queries on a UDP port on the IPv4 loopback interface, 127\&.0\&.0\&.1\&. This means that \fBlwresd\fR can only be used by processes running on the local machine\&. By default, UDP port number 921 is used for lightweight resolver requests and responses\&. - .PP +.PP Incoming lightweight resolver requests are decoded by the server which then resolves them using the DNS protocol\&. When the DNS lookup completes, \fBlwresd\fR encodes the answers in the lightweight resolver format and returns them to the client that made the request\&. - .PP +.PP If /etc/resolv\&.conf contains any @@ -83,113 +65,113 @@ sends recursive DNS queries to those servers\&. This is similar to the use of fo entries are present, or if forwarding fails, \fBlwresd\fR resolves the queries autonomously starting at the root name servers, using a built\-in list of root server hints\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-4 .RS 4 - Use IPv4 only even if the host machine is capable of IPv6\&. +Use IPv4 only even if the host machine is capable of IPv6\&. \fB\-4\fR and \fB\-6\fR are mutually exclusive\&. - .RE - .PP +.RE +.PP \-6 .RS 4 - Use IPv6 only even if the host machine is capable of IPv4\&. +Use IPv6 only even if the host machine is capable of IPv4\&. \fB\-4\fR and \fB\-6\fR are mutually exclusive\&. - .RE - .PP +.RE +.PP \-c \fIconfig\-file\fR .RS 4 - Use +Use \fIconfig\-file\fR as the configuration file instead of the default, /etc/lwresd\&.conf\&. \fB\-c\fR can not be used with \fB\-C\fR\&. - .RE - .PP +.RE +.PP \-C \fIconfig\-file\fR .RS 4 - Use +Use \fIconfig\-file\fR as the configuration file instead of the default, /etc/resolv\&.conf\&. \fB\-C\fR can not be used with \fB\-c\fR\&. - .RE - .PP +.RE +.PP \-d \fIdebug\-level\fR .RS 4 - Set the daemon\*(Aqs debug level to +Set the daemon\*(Aqs debug level to \fIdebug\-level\fR\&. Debugging traces from \fBlwresd\fR become more verbose as the debug level increases\&. - .RE - .PP +.RE +.PP \-f .RS 4 - Run the server in the foreground (i\&.e\&. do not daemonize)\&. - .RE - .PP +Run the server in the foreground (i\&.e\&. do not daemonize)\&. +.RE +.PP \-g .RS 4 - Run the server in the foreground and force all logging to +Run the server in the foreground and force all logging to stderr\&. - .RE - .PP +.RE +.PP \-i \fIpid\-file\fR .RS 4 - Use +Use \fIpid\-file\fR as the PID file instead of the default, /var/run/lwresd/lwresd\&.pid\&. - .RE - .PP +.RE +.PP \-m \fIflag\fR .RS 4 - Turn on memory usage debugging flags\&. Possible flags are +Turn on memory usage debugging flags\&. Possible flags are \fIusage\fR, \fItrace\fR, \fIrecord\fR, \fIsize\fR, and \fImctx\fR\&. These correspond to the ISC_MEM_DEBUGXXXX flags described in \&. - .RE - .PP +.RE +.PP \-n \fI#cpus\fR .RS 4 - Create +Create \fI#cpus\fR worker threads to take advantage of multiple CPUs\&. If not specified, \fBlwresd\fR 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\&. - .RE - .PP +.RE +.PP \-P \fIport\fR .RS 4 - Listen for lightweight resolver queries on port +Listen for lightweight resolver queries on port \fIport\fR\&. If not specified, the default is port 921\&. - .RE - .PP +.RE +.PP \-p \fIport\fR .RS 4 - Send DNS lookups to port +Send DNS lookups to port \fIport\fR\&. 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\&. - .RE - .PP +.RE +.PP \-s .RS 4 - Write memory usage statistics to +Write memory usage statistics to stdout on exit\&. - .if n \{\ +.if n \{\ .sp .\} .RS 4 @@ -201,17 +183,17 @@ on exit\&. \fBNote\fR .ps -1 .br - This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&. - .sp .5v +This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&. +.sp .5v .RE - .RE - .PP +.RE +.PP \-t \fIdirectory\fR .RS 4 - Chroot to +Chroot to \fIdirectory\fR after processing the command line arguments, but before reading the configuration file\&. - .if n \{\ +.if n \{\ .sp .\} .RS 4 @@ -223,39 +205,39 @@ after processing the command line arguments, but before reading the configuratio \fBWarning\fR .ps -1 .br - This option should be used in conjunction with the +This option should be used in conjunction with the \fB\-u\fR option, as chrooting a process running as root doesn\*(Aqt enhance security on most systems; the way \fBchroot(2)\fR is defined allows a process with root privileges to escape a chroot jail\&. - .sp .5v +.sp .5v .RE - .RE - .PP +.RE +.PP \-u \fIuser\fR .RS 4 - Setuid to +Setuid to \fIuser\fR after completing privileged operations, such as creating sockets that listen on privileged ports\&. - .RE - .PP +.RE +.PP \-v .RS 4 - Report the version number and exit\&. - .RE - .SH "FILES" - .PP +Report the version number and exit\&. +.RE +.SH "FILES" +.PP /etc/resolv\&.conf .RS 4 - The default configuration file\&. - .RE - .PP +The default configuration file\&. +.RE +.PP /var/run/lwresd\&.pid .RS 4 - The default process\-id file\&. - .RE - .SH "SEE ALSO" - .PP +The default process\-id file\&. +.RE +.SH "SEE ALSO" +.PP \fBnamed\fR(8), \fBlwres\fR(3), \fBresolver\fR(5)\&. diff --git a/bin/named/lwresd.html b/bin/named/lwresd.html index c0631dbaea..ad4bf61815 100644 --- a/bin/named/lwresd.html +++ b/bin/named/lwresd.html @@ -14,59 +14,24 @@
- - - - - -
+

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 @@ -74,14 +39,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 @@ -91,80 +56,60 @@ 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, @@ -173,61 +118,54 @@ 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 @@ -235,61 +173,39 @@ 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.8 b/bin/named/named.8 index a2b75d863c..0acd6b5a2a 100644 --- a/bin/named/named.8 +++ b/bin/named/named.8 @@ -35,67 +35,43 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" named \- Internet domain name server - .SH "SYNOPSIS" - .HP \w'\fBnamed\fR\ 'u - \fBnamed\fR - [ - | [\fB\-4\fR] - | [\fB\-6\fR] - ] - [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] - [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] - [\fB\-D\ \fR\fB\fIstring\fR\fR] - [\fB\-E\ \fR\fB\fIengine\-name\fR\fR] - [\fB\-f\fR] - [\fB\-g\fR] - [\fB\-L\ \fR\fB\fIlogfile\fR\fR] - [\fB\-M\ \fR\fB\fIoption\fR\fR] - [\fB\-m\ \fR\fB\fIflag\fR\fR] - [\fB\-n\ \fR\fB\fI#cpus\fR\fR] - [\fB\-p\ \fR\fB\fIport\fR\fR] - [\fB\-s\fR] - [\fB\-S\ \fR\fB\fI#max\-socks\fR\fR] - [\fB\-t\ \fR\fB\fIdirectory\fR\fR] - [\fB\-U\ \fR\fB\fI#listeners\fR\fR] - [\fB\-u\ \fR\fB\fIuser\fR\fR] - [\fB\-v\fR] - [\fB\-V\fR] - [\fB\-X\ \fR\fB\fIlock\-file\fR\fR] - [\fB\-x\ \fR\fB\fIcache\-file\fR\fR] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBnamed\fR\ 'u +\fBnamed\fR [[\fB\-4\fR] | [\fB\-6\fR]] [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] [\fB\-D\ \fR\fB\fIstring\fR\fR] [\fB\-E\ \fR\fB\fIengine\-name\fR\fR] [\fB\-f\fR] [\fB\-g\fR] [\fB\-L\ \fR\fB\fIlogfile\fR\fR] [\fB\-M\ \fR\fB\fIoption\fR\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [\fB\-n\ \fR\fB\fI#cpus\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-s\fR] [\fB\-S\ \fR\fB\fI#max\-socks\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-U\ \fR\fB\fI#listeners\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-V\fR] [\fB\-X\ \fR\fB\fIlock\-file\fR\fR] [\fB\-x\ \fR\fB\fIcache\-file\fR\fR] +.SH "DESCRIPTION" +.PP \fBnamed\fR 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\&. - .PP +.PP When invoked without arguments, \fBnamed\fR will read the default configuration file /etc/named\&.conf, read any initial data, and listen for queries\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-4 .RS 4 - Use IPv4 only even if the host machine is capable of IPv6\&. +Use IPv4 only even if the host machine is capable of IPv6\&. \fB\-4\fR and \fB\-6\fR are mutually exclusive\&. - .RE - .PP +.RE +.PP \-6 .RS 4 - Use IPv6 only even if the host machine is capable of IPv4\&. +Use IPv6 only even if the host machine is capable of IPv4\&. \fB\-4\fR and \fB\-6\fR are mutually exclusive\&. - .RE - .PP +.RE +.PP \-c \fIconfig\-file\fR .RS 4 - Use +Use \fIconfig\-file\fR as the configuration file instead of the default, /etc/named\&.conf\&. To ensure that reloading the configuration file continues to work after the server has changed its working directory due to to a possible @@ -103,88 +79,88 @@ as the configuration file instead of the default, option in the configuration file, \fIconfig\-file\fR should be an absolute pathname\&. - .RE - .PP +.RE +.PP \-d \fIdebug\-level\fR .RS 4 - Set the daemon\*(Aqs debug level to +Set the daemon\*(Aqs debug level to \fIdebug\-level\fR\&. Debugging traces from \fBnamed\fR become more verbose as the debug level increases\&. - .RE - .PP +.RE +.PP \-D \fIstring\fR .RS 4 - Specifies a string that is used to identify a instance of +Specifies a string that is used to identify a instance of \fBnamed\fR in a process listing\&. The contents of \fIstring\fR are not examined\&. - .RE - .PP +.RE +.PP \-E \fIengine\-name\fR .RS 4 - When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing\&. +When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing\&. .sp - 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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. - .RE - .PP +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 module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. +.RE +.PP \-f .RS 4 - Run the server in the foreground (i\&.e\&. do not daemonize)\&. - .RE - .PP +Run the server in the foreground (i\&.e\&. do not daemonize)\&. +.RE +.PP \-g .RS 4 - Run the server in the foreground and force all logging to +Run the server in the foreground and force all logging to stderr\&. - .RE - .PP +.RE +.PP \-L \fIlogfile\fR .RS 4 - Log to the file +Log to the file \fBlogfile\fR by default instead of the system log\&. - .RE - .PP +.RE +.PP \-M \fIoption\fR .RS 4 - Sets the default memory context options\&. Currently the only supported option is +Sets the default memory context options\&. Currently the only supported option is \fIexternal\fR, which causes the internal memory manager to be bypassed in favor of system\-provided memory allocation functions\&. - .RE - .PP +.RE +.PP \-m \fIflag\fR .RS 4 - Turn on memory usage debugging flags\&. Possible flags are +Turn on memory usage debugging flags\&. Possible flags are \fIusage\fR, \fItrace\fR, \fIrecord\fR, \fIsize\fR, and \fImctx\fR\&. These correspond to the ISC_MEM_DEBUGXXXX flags described in \&. - .RE - .PP +.RE +.PP \-n \fI#cpus\fR .RS 4 - Create +Create \fI#cpus\fR worker threads to take advantage of multiple CPUs\&. If not specified, \fBnamed\fR 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\&. - .RE - .PP +.RE +.PP \-p \fIport\fR .RS 4 - Listen for queries on port +Listen for queries on port \fIport\fR\&. If not specified, the default is port 53\&. - .RE - .PP +.RE +.PP \-s .RS 4 - Write memory usage statistics to +Write memory usage statistics to stdout on exit\&. - .if n \{\ +.if n \{\ .sp .\} .RS 4 @@ -196,19 +172,19 @@ on exit\&. \fBNote\fR .ps -1 .br - This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&. - .sp .5v +This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&. +.sp .5v .RE - .RE - .PP +.RE +.PP \-S \fI#max\-socks\fR .RS 4 - Allow +Allow \fBnamed\fR to use up to \fI#max\-socks\fR sockets\&. The default value is 4096 on systems built with default configuration options, and 21000 on systems built with "configure \-\-with\-tuning=large"\&. - .if n \{\ +.if n \{\ .sp .\} .RS 4 @@ -220,19 +196,19 @@ sockets\&. The default value is 4096 on systems built with default configuration \fBWarning\fR .ps -1 .br - This option should be unnecessary for the vast majority of users\&. The use of this option could even be harmful because the specified value may exceed the limitation of the underlying system API\&. It is therefore set only when the default configuration causes exhaustion of file descriptors and the operational environment is known to support the specified number of sockets\&. Note also that the actual maximum number is normally a little fewer than the specified value because +This option should be unnecessary for the vast majority of users\&. The use of this option could even be harmful because the specified value may exceed the limitation of the underlying system API\&. It is therefore set only when the default configuration causes exhaustion of file descriptors and the operational environment is known to support the specified number of sockets\&. Note also that the actual maximum number is normally a little fewer than the specified value because \fBnamed\fR reserves some file descriptors for its internal use\&. - .sp .5v +.sp .5v .RE - .RE - .PP +.RE +.PP \-t \fIdirectory\fR .RS 4 - Chroot to +Chroot to \fIdirectory\fR after processing the command line arguments, but before reading the configuration file\&. - .if n \{\ +.if n \{\ .sp .\} .RS 4 @@ -244,18 +220,18 @@ after processing the command line arguments, but before reading the configuratio \fBWarning\fR .ps -1 .br - This option should be used in conjunction with the +This option should be used in conjunction with the \fB\-u\fR option, as chrooting a process running as root doesn\*(Aqt enhance security on most systems; the way \fBchroot(2)\fR is defined allows a process with root privileges to escape a chroot jail\&. - .sp .5v +.sp .5v .RE - .RE - .PP +.RE +.PP \-U \fI#listeners\fR .RS 4 - Use +Use \fI#listeners\fR worker threads to listen for incoming UDP packets on each address\&. If not specified, \fBnamed\fR @@ -264,14 +240,14 @@ will calculate a default value based on the number of detected CPUs: 1 for 1 CPU has been set to a higher value than the number of detected CPUs, then \fB\-U\fR may 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\&. - .RE - .PP +.RE +.PP \-u \fIuser\fR .RS 4 - Setuid to +Setuid to \fIuser\fR after completing privileged operations, such as creating sockets that listen on privileged ports\&. - .if n \{\ +.if n \{\ .sp .\} .RS 4 @@ -283,7 +259,7 @@ after completing privileged operations, such as creating sockets that listen on \fBNote\fR .ps -1 .br - On Linux, +On Linux, \fBnamed\fR uses the kernel\*(Aqs capability mechanism to drop all root privileges except the ability to \fBbind(2)\fR @@ -293,37 +269,37 @@ option only works when \fBnamed\fR is run on kernel 2\&.2\&.18 or later, or kernel 2\&.3\&.99\-pre3 or later, since previous kernels did not allow privileges to be retained after \fBsetuid(2)\fR\&. - .sp .5v +.sp .5v .RE - .RE - .PP +.RE +.PP \-v .RS 4 - Report the version number and exit\&. - .RE - .PP +Report the version number and exit\&. +.RE +.PP \-V .RS 4 - Report the version number and build options, and exit\&. - .RE - .PP +Report the version number and build options, and exit\&. +.RE +.PP \-X \fIlock\-file\fR .RS 4 - Acquire a lock on the specified file at runtime; this helps to prevent duplicate +Acquire a lock on the specified file at runtime; this helps to prevent duplicate \fBnamed\fR instances from running simultaneously\&. Use of this option overrides the \fBlock\-file\fR option in named\&.conf\&. If set to none, the lock file check is disabled\&. - .RE - .PP +.RE +.PP \-x \fIcache\-file\fR .RS 4 - Load data from +Load data from \fIcache\-file\fR into the cache of the default view\&. - .if n \{\ +.if n \{\ .sp .\} .RS 4 @@ -335,34 +311,34 @@ into the cache of the default view\&. \fBWarning\fR .ps -1 .br - 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\&. - .sp .5v +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\&. +.sp .5v .RE - .RE - .SH "SIGNALS" - .PP +.RE +.SH "SIGNALS" +.PP In routine operation, signals should not be used to control the nameserver; \fBrndc\fR should be used instead\&. - .PP +.PP SIGHUP .RS 4 - Force a reload of the server\&. - .RE - .PP +Force a reload of the server\&. +.RE +.PP SIGINT, SIGTERM .RS 4 - Shut down the server\&. - .RE - .PP +Shut down the server\&. +.RE +.PP The result of sending any other signals to the server is undefined\&. - .SH "CONFIGURATION" - .PP +.SH "CONFIGURATION" +.PP The \fBnamed\fR configuration file is too complex to describe in detail here\&. A complete description is provided in the BIND 9 Administrator Reference Manual\&. - .PP +.PP \fBnamed\fR inherits the \fBumask\fR @@ -372,19 +348,19 @@ inherits the should be set explicitly in the script used to start the \fBnamed\fR process\&. - .SH "FILES" - .PP +.SH "FILES" +.PP /etc/named\&.conf .RS 4 - The default configuration file\&. - .RE - .PP +The default configuration file\&. +.RE +.PP /var/run/named/named\&.pid .RS 4 - The default process\-id file\&. - .RE - .SH "SEE ALSO" - .PP +The default process\-id file\&. +.RE +.SH "SEE ALSO" +.PP RFC 1033, RFC 1034, RFC 1035, diff --git a/bin/named/named.conf.5 b/bin/named/named.conf.5 index 8de69195e9..7d5b3cadfe 100644 --- a/bin/named/named.conf.5 +++ b/bin/named/named.conf.5 @@ -35,23 +35,23 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" named.conf \- configuration file for \fBnamed\fR - .SH "SYNOPSIS" - .HP \w'\fBnamed\&.conf\fR\ 'u - \fBnamed\&.conf\fR - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBnamed\&.conf\fR\ 'u +\fBnamed\&.conf\fR +.SH "DESCRIPTION" +.PP named\&.conf is the configuration file for \fBnamed\fR\&. 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: - .PP +.PP C style: /* */ - .PP +.PP C++ style: // to end of line - .PP +.PP Unix style: # to end of line - .SH "ACL" +.SH "ACL" .sp .if n \{\ .RS 4 @@ -62,8 +62,7 @@ acl \fIstring\fR { \fIaddress_match_element\fR; \&.\&.\&. }; .if n \{\ .RE .\} -.sp - .SH "CONTROLS" +.SH "CONTROLS" .sp .if n \{\ .RS 4 @@ -84,8 +83,7 @@ controls { .if n \{\ .RE .\} -.sp - .SH "DLZ" +.SH "DLZ" .sp .if n \{\ .RS 4 @@ -99,8 +97,7 @@ dlz \fIstring\fR { .if n \{\ .RE .\} -.sp - .SH "DYNDB" +.SH "DYNDB" .sp .if n \{\ .RS 4 @@ -112,8 +109,7 @@ dyndb \fIstring\fR \fIquoted_string\fR { .if n \{\ .RE .\} -.sp - .SH "KEY" +.SH "KEY" .sp .if n \{\ .RS 4 @@ -127,8 +123,7 @@ key \fIstring\fR { .if n \{\ .RE .\} -.sp - .SH "LOGGING" +.SH "LOGGING" .sp .if n \{\ .RS 4 @@ -153,8 +148,7 @@ logging { .if n \{\ .RE .\} -.sp - .SH "LWRES" +.SH "LWRES" .sp .if n \{\ .RS 4 @@ -173,8 +167,7 @@ lwres { .if n \{\ .RE .\} -.sp - .SH "MANAGED\-KEYS" +.SH "MANAGED\-KEYS" .sp .if n \{\ .RS 4 @@ -186,8 +179,7 @@ managed\-keys { \fIstring\fR \fIstring\fR \fIinteger\fR .if n \{\ .RE .\} -.sp - .SH "MASTERS" +.SH "MASTERS" .sp .if n \{\ .RS 4 @@ -201,8 +193,7 @@ masters \fIstring\fR [ port \fIinteger\fR ] [ dscp .if n \{\ .RE .\} -.sp - .SH "OPTIONS" +.SH "OPTIONS" .sp .if n \{\ .RS 4 @@ -486,8 +477,7 @@ options { .if n \{\ .RE .\} -.sp - .SH "SERVER" +.SH "SERVER" .sp .if n \{\ .RS 4 @@ -527,8 +517,7 @@ server \fInetprefix\fR { .if n \{\ .RE .\} -.sp - .SH "STATISTICS\-CHANNELS" +.SH "STATISTICS\-CHANNELS" .sp .if n \{\ .RS 4 @@ -544,8 +533,7 @@ statistics\-channels { .if n \{\ .RE .\} -.sp - .SH "TRUSTED\-KEYS" +.SH "TRUSTED\-KEYS" .sp .if n \{\ .RS 4 @@ -557,8 +545,7 @@ trusted\-keys { \fIstring\fR \fIinteger\fR \fIinteger\fR .if n \{\ .RE .\} -.sp - .SH "VIEW" +.SH "VIEW" .sp .if n \{\ .RS 4 @@ -917,8 +904,7 @@ view \fIstring\fR [ \fIclass\fR ] { .if n \{\ .RE .\} -.sp - .SH "ZONE" +.SH "ZONE" .sp .if n \{\ .RS 4 @@ -1020,12 +1006,11 @@ zone \fIstring\fR [ \fIclass\fR ] { .if n \{\ .RE .\} -.sp - .SH "FILES" - .PP +.SH "FILES" +.PP /etc/named\&.conf - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBddns-confgen\fR(8), \fBnamed\fR(8), \fBnamed-checkconf\fR(8), diff --git a/bin/named/named.conf.html b/bin/named/named.conf.html index 729b4653c2..e0bcac8f31 100644 --- a/bin/named/named.conf.html +++ b/bin/named/named.conf.html @@ -14,61 +14,42 @@
- - - - - -
+

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; ... };

-
- -
+
+

CONTROLS

- -


+


controls {
inet ( ipv4_address | ipv6_address |
    * ) [ port ( integer | * ) ] allow
@@ -81,43 +62,35 @@ controls     boolean ];
};

-
- -
+
+

DLZ

- -


+


dlz string {
database string;
search boolean;
};

-
- -
+
+

DYNDB

- -


+


dyndb string quoted_string {
    unspecified-text };

-
- -
+
+

KEY

- -


+


key string {
algorithm string;
secret string;
};

-
- -
+
+

LOGGING

- -


+


logging {
category string { string; ... };
channel string {
@@ -134,12 +107,10 @@ logging };
};

-
- -
+
+

LWRES

- -


+


lwres {
listen-on [ port integer ] [ dscp integer ] { ( ipv4_address
    | ipv6_address ) [ port integer ] [ dscp integer ]; ... };
@@ -150,32 +121,26 @@ lwres view string [ class ];
};

-
- -
+
+

MANAGED-KEYS

- -


+


managed-keys { string string integer
    integer integer quoted_string; ... };

-
- -
+
+

MASTERS

- -


+


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

-
- -
+
+

OPTIONS

- -


+


options {
acache-cleaning-interval integer;
acache-enable boolean;
@@ -451,12 +416,10 @@ options zone-statistics ( full | terse | none | boolean );
};

-
- -
+
+

SERVER

- -


+


server netprefix {
bogus boolean;
edns boolean;
@@ -488,12 +451,10 @@ server transfers integer;
};

-
- -
+
+

STATISTICS-CHANNELS

- -


+


statistics-channels {
inet ( ipv4_address | ipv6_address |
    * ) [ port ( integer | * ) ] [
@@ -501,21 +462,17 @@ statistics-channels     } ];
};

-
- -
+
+

TRUSTED-KEYS

- -


+


trusted-keys { string integer integer
    integer quoted_string; ... };

-
- -
+
+

VIEW

- -


+


view string [ class ] {
acache-cleaning-interval integer;
acache-enable boolean;
@@ -866,12 +823,10 @@ view zone-statistics ( full | terse | none | boolean );
};

-
- -
+
+

ZONE

- -


+


zone string [ class ] {
allow-notify { address_match_element; ... };
allow-query { address_match_element; ... };
@@ -965,36 +920,21 @@ zone zone-statistics ( full | terse | none | boolean );
};

-
- -
+
+

FILES

- -

/etc/named.conf +

/etc/named.conf

-
- -
+
+

SEE ALSO

- -

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

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

-
- +
diff --git a/bin/named/named.html b/bin/named/named.html index f35890c181..8637ed8fdc 100644 --- a/bin/named/named.html +++ b/bin/named/named.html @@ -14,93 +14,46 @@
- - - - - -
+

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] - [-L logfile] - [-M option] - [-m flag] - [-n #cpus] - [-p port] - [-s] - [-S #max-socks] - [-t directory] - [-U #listeners] - [-u user] - [-v] - [-V] - [-X lock-file] - [-x cache-file] -

-
- -
+

named [[-4] | [-6]] [-c config-file] [-d debug-level] [-D string] [-E engine-name] [-f] [-g] [-L logfile] [-M option] [-m flag] [-n #cpus] [-p port] [-s] [-S #max-socks] [-t directory] [-U #listeners] [-u user] [-v] [-V] [-X lock-file] [-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 @@ -110,33 +63,28 @@ 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 @@ -144,40 +92,31 @@ (--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. -

-
+

-L logfile
-
-

+

Log to the file logfile by default instead of the system log. -

-
+

-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, @@ -186,51 +125,46 @@ 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 @@ -245,18 +179,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 @@ -264,11 +198,10 @@ 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 @@ -281,18 +214,17 @@ 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 @@ -305,23 +237,18 @@ 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 lock-file
-
-

+

Acquire a lock on the specified file at runtime; this helps to prevent duplicate named instances from running simultaneously. @@ -329,68 +256,54 @@ option in named.conf. If set to none, the lock file check is disabled. -

-
+

-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, @@ -398,59 +311,32 @@ 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.1 b/bin/nsupdate/nsupdate.1 index ecfbbb2bf7..02c9ae1b72 100644 --- a/bin/nsupdate/nsupdate.1 +++ b/bin/nsupdate/nsupdate.1 @@ -35,46 +35,26 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" nsupdate \- Dynamic DNS update utility - .SH "SYNOPSIS" - .HP \w'\fBnsupdate\fR\ 'u - \fBnsupdate\fR - [\fB\-d\fR] - [\fB\-D\fR] - [\fB\-i\fR] - [\fB\-L\ \fR\fB\fIlevel\fR\fR] - [ - | [\fB\-g\fR] - | [\fB\-o\fR] - | [\fB\-l\fR] - | [\fB\-y\ \fR\fB\fI[hmac:]\fR\fIkeyname:secret\fR\fR] - | [\fB\-k\ \fR\fB\fIkeyfile\fR\fR] - ] - [\fB\-t\ \fR\fB\fItimeout\fR\fR] - [\fB\-u\ \fR\fB\fIudptimeout\fR\fR] - [\fB\-r\ \fR\fB\fIudpretries\fR\fR] - [\fB\-R\ \fR\fB\fIrandomdev\fR\fR] - [\fB\-v\fR] - [\fB\-T\fR] - [\fB\-P\fR] - [\fB\-V\fR] - [filename] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBnsupdate\fR\ 'u +\fBnsupdate\fR [\fB\-d\fR] [\fB\-D\fR] [\fB\-i\fR] [\fB\-L\ \fR\fB\fIlevel\fR\fR] [[\fB\-g\fR] | [\fB\-o\fR] | [\fB\-l\fR] | [\fB\-y\ \fR\fB\fI[hmac:]\fR\fIkeyname:secret\fR\fR] | [\fB\-k\ \fR\fB\fIkeyfile\fR\fR]] [\fB\-t\ \fR\fB\fItimeout\fR\fR] [\fB\-u\ \fR\fB\fIudptimeout\fR\fR] [\fB\-r\ \fR\fB\fIudpretries\fR\fR] [\fB\-R\ \fR\fB\fIrandomdev\fR\fR] [\fB\-v\fR] [\fB\-T\fR] [\fB\-P\fR] [\fB\-V\fR] [filename] +.SH "DESCRIPTION" +.PP \fBnsupdate\fR 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 without manually editing the zone file\&. A single update request can contain requests to add or remove more than one resource record\&. - .PP +.PP Zones that are under dynamic control via \fBnsupdate\fR or a DHCP server should not be edited by hand\&. Manual edits could conflict with dynamic updates and cause data to be lost\&. - .PP +.PP The resource records that are dynamically added or removed with \fBnsupdate\fR have to be in the same zone\&. Requests are sent to the zone\*(Aqs master server\&. This is identified by the MNAME field of the zone\*(Aqs SOA record\&. - .PP +.PP 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\&. - .PP +.PP TSIG relies on a shared secret that should only be known to \fBnsupdate\fR and the name server\&. For instance, suitable @@ -92,34 +72,34 @@ uses the or \fB\-k\fR options to provide the TSIG shared secret\&. These options are mutually exclusive\&. - .PP +.PP 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\&. - .PP +.PP GSS\-TSIG uses Kerberos credentials\&. Standard GSS\-TSIG mode is switched on with the \fB\-g\fR flag\&. A non\-standards\-compliant variant of GSS\-TSIG used by Windows 2000 can be switched on with the \fB\-o\fR flag\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-d .RS 4 - Debug mode\&. This provides tracing information about the update requests that are made and the replies received from the name server\&. - .RE - .PP +Debug mode\&. This provides tracing information about the update requests that are made and the replies received from the name server\&. +.RE +.PP \-D .RS 4 - Extra debug mode\&. - .RE - .PP +Extra debug mode\&. +.RE +.PP \-i .RS 4 - Force interactive mode, even when standard input is not a terminal\&. - .RE - .PP +Force interactive mode, even when standard input is not a terminal\&. +.RE +.PP \-k \fIkeyfile\fR .RS 4 - The file containing the TSIG authentication key\&. Keyfiles may be in two formats: a single file containing a +The file containing the TSIG authentication key\&. Keyfiles may be in two formats: a single file containing a named\&.conf\-format \fBkey\fR statement, which may be generated automatically by @@ -130,11 +110,11 @@ K{name}\&.+157\&.+{random}\&.private, which can be generated by \fBdnssec\-keygen\fR\&. The \fB\-k\fR 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\&. - .RE - .PP +.RE +.PP \-l .RS 4 - Local\-host only mode\&. This sets the server address to localhost (disabling the +Local\-host only mode\&. This sets the server address to localhost (disabling the \fBserver\fR so that the server address cannot be overridden)\&. Connections to the local server will use a TSIG key found in /var/run/named/session\&.key, which is automatically generated by @@ -145,50 +125,50 @@ to \fBlocal\fR\&. The location of this key file can be overridden with the \fB\-k\fR option\&. - .RE - .PP +.RE +.PP \-L \fIlevel\fR .RS 4 - Set the logging debug level\&. If zero, logging is disabled\&. - .RE - .PP +Set the logging debug level\&. If zero, logging is disabled\&. +.RE +.PP \-p \fIport\fR .RS 4 - Set the port to use for connections to a name server\&. The default is 53\&. - .RE - .PP +Set the port to use for connections to a name server\&. The default is 53\&. +.RE +.PP \-P .RS 4 - Print the list of private BIND\-specific resource record types whose format is understood by +Print the list of private BIND\-specific resource record types whose format is understood by \fBnsupdate\fR\&. See also the \fB\-T\fR option\&. - .RE - .PP +.RE +.PP \-r \fIudpretries\fR .RS 4 - The number of UDP retries\&. The default is 3\&. If zero, only one update request will be made\&. - .RE - .PP +The number of UDP retries\&. The default is 3\&. If zero, only one update request will be made\&. +.RE +.PP \-R \fIrandomdev\fR .RS 4 - Where to obtain randomness\&. If the operating system does not provide a +Where to obtain randomness\&. If the operating system does not provide a /dev/random or equivalent device, the default source of randomness is keyboard input\&. randomdev specifies the name of a character device or file containing random data to be used instead of the default\&. The special value keyboard indicates that keyboard input should be used\&. This option may be specified multiple times\&. - .RE - .PP +.RE +.PP \-t \fItimeout\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-T .RS 4 - Print the list of IANA standard resource record types whose format is understood by +Print the list of IANA standard resource record types whose format is understood by \fBnsupdate\fR\&. \fBnsupdate\fR will exit after the lists are printed\&. The @@ -197,29 +177,29 @@ option can be combined with the \fB\-P\fR option\&. .sp - 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, ( )\&. - .RE - .PP +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, ( )\&. +.RE +.PP \-u \fIudptimeout\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-v .RS 4 - Use TCP even for small update requests\&. By default, +Use TCP even for small update requests\&. By default, \fBnsupdate\fR 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\&. - .RE - .PP +.RE +.PP \-V .RS 4 - Print the version number and exit\&. - .RE - .PP +Print the version number and exit\&. +.RE +.PP \-y \fI[hmac:]\fR\fIkeyname:secret\fR .RS 4 - Literal TSIG authentication key\&. +Literal TSIG authentication key\&. \fIkeyname\fR is the name of the key, and \fIsecret\fR @@ -238,28 +218,28 @@ hmac\-md5 or if MD5 was disabled hmac\-sha256\&. .sp - NOTE: Use of the +NOTE: Use of the \fB\-y\fR 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 \fBps\fR(1) or in a history file maintained by the user\*(Aqs shell\&. - .RE - .SH "INPUT FORMAT" - .PP +.RE +.SH "INPUT FORMAT" +.PP \fBnsupdate\fR reads input from \fIfilename\fR or standard input\&. Each command is supplied on exactly one line of input\&. Some commands are for administrative purposes\&. The others are either update instructions or prerequisite checks on the contents of the zone\&. These checks set conditions that some name or set of resource records (RRset) either exists or is absent from the zone\&. These conditions must be met if the entire update request is to succeed\&. Updates will be rejected if the tests for the prerequisite conditions fail\&. - .PP +.PP 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 specified resource records are present or missing from the zone\&. A blank input line (or the \fBsend\fR command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server\&. - .PP +.PP The command formats and their meaning are as follows: - .PP +.PP \fBserver\fR {servername} [port] .RS 4 - Sends all dynamic update requests to the name server +Sends all dynamic update requests to the name server \fIservername\fR\&. When no server statement is provided, \fBnsupdate\fR will send updates to the master server of the correct zone\&. The MNAME field of that zone\*(Aqs SOA record will identify the master server for that zone\&. @@ -267,46 +247,46 @@ will send updates to the master server of the correct zone\&. The MNAME field of is the port number on \fIservername\fR where the dynamic update requests get sent\&. If no port number is specified, the default DNS port number of 53 is used\&. - .RE - .PP +.RE +.PP \fBlocal\fR {address} [port] .RS 4 - Sends all dynamic update requests using the local +Sends all dynamic update requests using the local \fIaddress\fR\&. When no local statement is provided, \fBnsupdate\fR will send updates using an address and port chosen by the system\&. \fIport\fR can additionally be used to make requests come from a specific port\&. If no port number is specified, the system will assign one\&. - .RE - .PP +.RE +.PP \fBzone\fR {zonename} .RS 4 - Specifies that all updates are to be made to the zone +Specifies that all updates are to be made to the zone \fIzonename\fR\&. If no \fIzone\fR statement is provided, \fBnsupdate\fR will attempt determine the correct zone to update based on the rest of the input\&. - .RE - .PP +.RE +.PP \fBclass\fR {classname} .RS 4 - Specify the default class\&. If no +Specify the default class\&. If no \fIclass\fR is specified, the default class is \fIIN\fR\&. - .RE - .PP +.RE +.PP \fBttl\fR {seconds} .RS 4 - Specify the default time to live for records to be added\&. The value +Specify the default time to live for records to be added\&. The value \fInone\fR will clear the default ttl\&. - .RE - .PP +.RE +.PP \fBkey\fR [hmac:] {keyname} {secret} .RS 4 - Specifies that all updates are to be TSIG\-signed using the +Specifies that all updates are to be TSIG\-signed using the \fIkeyname\fR \fIsecret\fR pair\&. If @@ -320,62 +300,62 @@ command overrides any key specified on the command line via \fB\-y\fR or \fB\-k\fR\&. - .RE - .PP +.RE +.PP \fBgsstsig\fR .RS 4 - Use GSS\-TSIG to sign the updated\&. This is equivalent to specifying +Use GSS\-TSIG to sign the updated\&. This is equivalent to specifying \fB\-g\fR on the command line\&. - .RE - .PP +.RE +.PP \fBoldgsstsig\fR .RS 4 - Use the Windows 2000 version of GSS\-TSIG to sign the updated\&. This is equivalent to specifying +Use the Windows 2000 version of GSS\-TSIG to sign the updated\&. This is equivalent to specifying \fB\-o\fR on the command line\&. - .RE - .PP +.RE +.PP \fBrealm\fR {[realm_name]} .RS 4 - When using GSS\-TSIG use +When using GSS\-TSIG use \fIrealm_name\fR rather than the default realm in krb5\&.conf\&. If no realm is specified the saved realm is cleared\&. - .RE - .PP +.RE +.PP \fBcheck\-names\fR {[yes_or_no]} .RS 4 - Turn on or off check\-names processing on records to be added\&. Check\-names has no effect on prerequisites or records to be deleted\&. By default check\-names processing is on\&. If check\-names processing fails the record will not be added to the UPDATE message\&. - .RE - .PP +Turn on or off check\-names processing on records to be added\&. Check\-names has no effect on prerequisites or records to be deleted\&. By default check\-names processing is on\&. If check\-names processing fails the record will not be added to the UPDATE message\&. +.RE +.PP \fB[prereq]\fR\fB nxdomain\fR {domain\-name} .RS 4 - Requires that no resource record of any type exists with name +Requires that no resource record of any type exists with name \fIdomain\-name\fR\&. - .RE - .PP +.RE +.PP \fB[prereq]\fR\fB yxdomain\fR {domain\-name} .RS 4 - Requires that +Requires that \fIdomain\-name\fR exists (has as at least one resource record, of any type)\&. - .RE - .PP +.RE +.PP \fB[prereq]\fR\fB nxrrset\fR {domain\-name} [class] {type} .RS 4 - Requires that no resource record exists of the specified +Requires that no resource record exists of the specified \fItype\fR, \fIclass\fR and \fIdomain\-name\fR\&. If \fIclass\fR is omitted, IN (internet) is assumed\&. - .RE - .PP +.RE +.PP \fB[prereq]\fR\fB yxrrset\fR {domain\-name} [class] {type} .RS 4 - This requires that a resource record of the specified +This requires that a resource record of the specified \fItype\fR, \fIclass\fR and @@ -383,11 +363,11 @@ and must exist\&. If \fIclass\fR is omitted, IN (internet) is assumed\&. - .RE - .PP +.RE +.PP \fB[prereq]\fR\fB yxrrset\fR {domain\-name} [class] {type} {data...} .RS 4 - The +The \fIdata\fR from each set of prerequisites of this form sharing a common \fItype\fR, @@ -399,11 +379,11 @@ are combined to form a set of RRs\&. This set of RRs must exactly match the set \fIdomain\-name\fR\&. The \fIdata\fR are written in the standard text representation of the resource record\*(Aqs RDATA\&. - .RE - .PP +.RE +.PP \fB[update]\fR\fB del\fR\fB[ete]\fR {domain\-name} [ttl] [class] [type\ [data...]] .RS 4 - Deletes any resource records named +Deletes any resource records named \fIdomain\-name\fR\&. If \fItype\fR and @@ -413,50 +393,50 @@ is provided, only matching resource records will be removed\&. The internet clas is not supplied\&. The \fIttl\fR is ignored, and is only allowed for compatibility\&. - .RE - .PP +.RE +.PP \fB[update]\fR\fB add\fR {domain\-name} {ttl} [class] {type} {data...} .RS 4 - Adds a new resource record with the specified +Adds a new resource record with the specified \fIttl\fR, \fIclass\fR and \fIdata\fR\&. - .RE - .PP +.RE +.PP \fBshow\fR .RS 4 - Displays the current message, containing all of the prerequisites and updates specified since the last send\&. - .RE - .PP +Displays the current message, containing all of the prerequisites and updates specified since the last send\&. +.RE +.PP \fBsend\fR .RS 4 - Sends the current message\&. This is equivalent to entering a blank line\&. - .RE - .PP +Sends the current message\&. This is equivalent to entering a blank line\&. +.RE +.PP \fBanswer\fR .RS 4 - Displays the answer\&. - .RE - .PP +Displays the answer\&. +.RE +.PP \fBdebug\fR .RS 4 - Turn on debugging\&. - .RE - .PP +Turn on debugging\&. +.RE +.PP \fBversion\fR .RS 4 - Print version number\&. - .RE - .PP +Print version number\&. +.RE +.PP \fBhelp\fR .RS 4 - Print a list of commands\&. - .RE - .PP +Print a list of commands\&. +.RE +.PP Lines beginning with a semicolon are comments and are ignored\&. - .SH "EXAMPLES" - .PP +.SH "EXAMPLES" +.PP The examples below show how \fBnsupdate\fR could be used to insert and delete resource records from the @@ -476,8 +456,7 @@ zone\&. Notice that the input in each example contains a trailing blank line so .if n \{\ .RE .\} -.sp - .PP +.PP Any A records for \fBoldhost\&.example\&.com\fR are deleted\&. And an A record for @@ -496,35 +475,34 @@ with IP address 172\&.16\&.1\&.1 is added\&. The newly\-added record has a 1 day .if n \{\ .RE .\} -.sp - .PP +.PP The prerequisite condition gets the name server to check that there are no resource records of any type for \fBnickname\&.example\&.com\fR\&. If there are, the update request fails\&. If this name does not exist, a CNAME for it is added\&. This ensures that when the CNAME is added, it cannot conflict with the long\-standing rule in RFC 1034 that a name must not exist as any other record type if it exists as a CNAME\&. (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have RRSIG, DNSKEY and NSEC records\&.) - .SH "FILES" - .PP +.SH "FILES" +.PP \fB/etc/resolv\&.conf\fR .RS 4 - used to identify default name server - .RE - .PP +used to identify default name server +.RE +.PP \fB/var/run/named/session\&.key\fR .RS 4 - sets the default TSIG key for use in local\-only mode - .RE - .PP +sets the default TSIG key for use in local\-only mode +.RE +.PP \fBK{name}\&.+157\&.+{random}\&.key\fR .RS 4 - base\-64 encoding of HMAC\-MD5 key created by +base\-64 encoding of HMAC\-MD5 key created by \fBdnssec-keygen\fR(8)\&. - .RE - .PP +.RE +.PP \fBK{name}\&.+157\&.+{random}\&.private\fR .RS 4 - base\-64 encoding of HMAC\-MD5 key created by +base\-64 encoding of HMAC\-MD5 key created by \fBdnssec-keygen\fR(8)\&. - .RE - .SH "SEE ALSO" - .PP +.RE +.SH "SEE ALSO" +.PP RFC 2136, RFC 3007, RFC 2104, @@ -535,8 +513,8 @@ RFC 2931, \fBnamed\fR(8), \fBddns-confgen\fR(8), \fBdnssec-keygen\fR(8)\&. - .SH "BUGS" - .PP +.SH "BUGS" +.PP 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\&. .SH "AUTHOR" .PP diff --git a/bin/nsupdate/nsupdate.html b/bin/nsupdate/nsupdate.html index d9bd2d17e0..f7006b9959 100644 --- a/bin/nsupdate/nsupdate.html +++ b/bin/nsupdate/nsupdate.html @@ -14,51 +14,17 @@
- - - - -
+

Name

-

- nsupdate - — Dynamic DNS update utility -

+

nsupdate — Dynamic DNS update utility

- - - -
+

Synopsis

-

- nsupdate - [-d] - [-D] - [-i] - [-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] [-i] [-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 @@ -67,27 +33,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. @@ -102,47 +68,37 @@ 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. -

-
+

-i
-
-

+

Force interactive mode, even when standard input is not a terminal. -

-
+

-k keyfile
-
-

+

The file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing a named.conf-format key @@ -154,11 +110,9 @@ 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 @@ -167,40 +121,30 @@ 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 @@ -209,60 +153,51 @@ 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. @@ -274,23 +209,19 @@ 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. @@ -304,7 +235,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 @@ -314,7 +245,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:

@@ -323,8 +254,7 @@ {servername} [port] -
-

+

Sends all dynamic update requests to the name server servername. When no server statement is provided, @@ -340,15 +270,13 @@ 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. @@ -360,14 +288,12 @@ 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 @@ -376,38 +302,32 @@ 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 @@ -416,80 +336,66 @@ 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 command line. -

-
+

oldgsstsig
-
-

+

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

-
+

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. -

-
+

check-names {[yes_or_no]}
-
-

+

Turn on or off check-names processing on records to be added. Check-names has no effect on prerequisites or records to be deleted. By default check-names processing is on. If check-names processing fails the record will not be added to the UPDATE message. -

-
+

[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 @@ -498,16 +404,14 @@ 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 @@ -517,8 +421,7 @@ If class is omitted, IN (internet) is assumed. -

-
+

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

+

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

-
+

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

+

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

-
+

[update] add {domain-name} @@ -581,80 +480,62 @@ {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 @@ -675,7 +556,7 @@

-

+

Any A records for oldhost.example.com are deleted. @@ -692,7 +573,7 @@

-

+

The prerequisite condition gets the name server to check that there are no resource records of any type for nickname.example.com. @@ -705,50 +586,33 @@ (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, @@ -756,28 +620,19 @@ 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.8 b/bin/pkcs11/pkcs11-destroy.8 index 3663062368..322836e394 100644 --- a/bin/pkcs11/pkcs11-destroy.8 +++ b/bin/pkcs11/pkcs11-destroy.8 @@ -35,64 +35,56 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" pkcs11-destroy \- destroy PKCS#11 objects - .SH "SYNOPSIS" - .HP \w'\fBpkcs11\-destroy\fR\ 'u - \fBpkcs11\-destroy\fR - [\fB\-m\ \fR\fB\fImodule\fR\fR] - [\fB\-s\ \fR\fB\fIslot\fR\fR] - { - | \-i\ \fIID\fR - | \-l\ \fIlabel\fR - } - [\fB\-p\ \fR\fB\fIPIN\fR\fR] - [\fB\-w\ \fR\fB\fIseconds\fR\fR] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBpkcs11\-destroy\fR\ 'u +\fBpkcs11\-destroy\fR [\fB\-m\ \fR\fB\fImodule\fR\fR] [\fB\-s\ \fR\fB\fIslot\fR\fR] {\-i\ \fIID\fR | \-l\ \fIlabel\fR} [\fB\-p\ \fR\fB\fIPIN\fR\fR] [\fB\-w\ \fR\fB\fIseconds\fR\fR] +.SH "DESCRIPTION" +.PP \fBpkcs11\-destroy\fR destroys keys stored in a PKCS#11 device, identified by their \fBID\fR or \fBlabel\fR\&. - .PP +.PP 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\&. - .SH "ARGUMENTS" - .PP +.SH "ARGUMENTS" +.PP \-m \fImodule\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-s \fIslot\fR .RS 4 - Open the session with the given PKCS#11 slot\&. The default is slot 0\&. - .RE - .PP +Open the session with the given PKCS#11 slot\&. The default is slot 0\&. +.RE +.PP \-i \fIID\fR .RS 4 - Destroy keys with the given object ID\&. - .RE - .PP +Destroy keys with the given object ID\&. +.RE +.PP \-l \fIlabel\fR .RS 4 - Destroy keys with the given label\&. - .RE - .PP +Destroy keys with the given label\&. +.RE +.PP \-p \fIPIN\fR .RS 4 - Specify the PIN for the device\&. If no PIN is provided on the command line, +Specify the PIN for the device\&. If no PIN is provided on the command line, \fBpkcs11\-destroy\fR will prompt for it\&. - .RE - .PP +.RE +.PP \-w \fIseconds\fR .RS 4 - Specify how long to pause before carrying out key destruction\&. The default is five seconds\&. If set to +Specify how long to pause before carrying out key destruction\&. The default is five seconds\&. If set to 0, destruction will be immediate\&. - .RE - .SH "SEE ALSO" - .PP +.RE +.SH "SEE ALSO" +.PP \fBpkcs11-keygen\fR(8), \fBpkcs11-list\fR(8), \fBpkcs11-tokens\fR(8) diff --git a/bin/pkcs11/pkcs11-destroy.html b/bin/pkcs11/pkcs11-destroy.html index e0d7241298..b1c6407d4a 100644 --- a/bin/pkcs11/pkcs11-destroy.html +++ b/bin/pkcs11/pkcs11-destroy.html @@ -14,115 +14,69 @@
- - - - - -
+

Name

-

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

+

pkcs11-destroy — destroy PKCS#11 objects

- - - -
+

Synopsis

-

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

-
- -
+

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.8 b/bin/pkcs11/pkcs11-keygen.8 index 0a771a96e1..ab7d178b65 100644 --- a/bin/pkcs11/pkcs11-keygen.8 +++ b/bin/pkcs11/pkcs11-keygen.8 @@ -35,89 +35,78 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" pkcs11-keygen \- generate keys on a PKCS#11 device - .SH "SYNOPSIS" - .HP \w'\fBpkcs11\-keygen\fR\ 'u - \fBpkcs11\-keygen\fR - {\-a\ \fIalgorithm\fR} - [\fB\-b\ \fR\fB\fIkeysize\fR\fR] - [\fB\-e\fR] - [\fB\-i\ \fR\fB\fIid\fR\fR] - [\fB\-m\ \fR\fB\fImodule\fR\fR] - [\fB\-P\fR] - [\fB\-p\ \fR\fB\fIPIN\fR\fR] - [\fB\-q\fR] - [\fB\-S\fR] - [\fB\-s\ \fR\fB\fIslot\fR\fR] - {label} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBpkcs11\-keygen\fR\ 'u +\fBpkcs11\-keygen\fR {\-a\ \fIalgorithm\fR} [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-e\fR] [\fB\-i\ \fR\fB\fIid\fR\fR] [\fB\-m\ \fR\fB\fImodule\fR\fR] [\fB\-P\fR] [\fB\-p\ \fR\fB\fIPIN\fR\fR] [\fB\-q\fR] [\fB\-S\fR] [\fB\-s\ \fR\fB\fIslot\fR\fR] {label} +.SH "DESCRIPTION" +.PP \fBpkcs11\-keygen\fR causes a PKCS#11 device to generate a new key pair with the given \fBlabel\fR (which must be unique) and with \fBkeysize\fR bits of prime\&. - .SH "ARGUMENTS" - .PP +.SH "ARGUMENTS" +.PP \-a \fIalgorithm\fR .RS 4 - Specify the key algorithm class: Supported classes are RSA, DSA, DH, ECC and ECX\&. In addition to these strings, the +Specify the key algorithm class: Supported classes are RSA, DSA, DH, ECC and ECX\&. In addition to these strings, the \fBalgorithm\fR can be specified as a DNSSEC signing algorithm that will be used with this key; for example, NSEC3RSASHA1 maps to RSA, ECDSAP256SHA256 maps to ECC, and ED25519 to ECX\&. The default class is "RSA"\&. - .RE - .PP +.RE +.PP \-b \fIkeysize\fR .RS 4 - Create the key pair with +Create the key pair with \fBkeysize\fR bits of prime\&. For ECC keys, the only valid values are 256 and 384, and the default is 256\&. For ECX kyes, the only valid values are 256 and 456, and the default is 256\&. - .RE - .PP +.RE +.PP \-e .RS 4 - For RSA keys only, use a large exponent\&. - .RE - .PP +For RSA keys only, use a large exponent\&. +.RE +.PP \-i \fIid\fR .RS 4 - Create key objects with id\&. The id is either an unsigned short 2 byte or an unsigned long 4 byte number\&. - .RE - .PP +Create key objects with id\&. The id is either an unsigned short 2 byte or an unsigned long 4 byte number\&. +.RE +.PP \-m \fImodule\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-P .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-p \fIPIN\fR .RS 4 - Specify the PIN for the device\&. If no PIN is provided on the command line, +Specify the PIN for the device\&. If no PIN is provided on the command line, \fBpkcs11\-keygen\fR will prompt for it\&. - .RE - .PP +.RE +.PP \-q .RS 4 - Quiet mode: suppress unnecessary output\&. - .RE - .PP +Quiet mode: suppress unnecessary output\&. +.RE +.PP \-S .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-s \fIslot\fR .RS 4 - Open the session with the given PKCS#11 slot\&. The default is slot 0\&. - .RE - .SH "SEE ALSO" - .PP +Open the session with the given PKCS#11 slot\&. The default is slot 0\&. +.RE +.SH "SEE ALSO" +.PP \fBpkcs11-destroy\fR(8), \fBpkcs11-list\fR(8), \fBpkcs11-tokens\fR(8), diff --git a/bin/pkcs11/pkcs11-keygen.html b/bin/pkcs11/pkcs11-keygen.html index 31b31628c7..e713fb2cf8 100644 --- a/bin/pkcs11/pkcs11-keygen.html +++ b/bin/pkcs11/pkcs11-keygen.html @@ -14,153 +14,94 @@
- - - - - -
+

Name

-

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

+

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} -

-
- -
+

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, ECC and ECX. 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, ECDSAP256SHA256 maps to ECC, and ED25519 to ECX. 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. For ECX kyes, the only valid values are 256 and 456, 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.8 b/bin/pkcs11/pkcs11-list.8 index f970df6139..bf0751cbd7 100644 --- a/bin/pkcs11/pkcs11-list.8 +++ b/bin/pkcs11/pkcs11-list.8 @@ -35,19 +35,13 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" pkcs11-list \- list PKCS#11 objects - .SH "SYNOPSIS" - .HP \w'\fBpkcs11\-list\fR\ 'u - \fBpkcs11\-list\fR - [\fB\-P\fR] - [\fB\-m\ \fR\fB\fImodule\fR\fR] - [\fB\-s\ \fR\fB\fIslot\fR\fR] - [\-i\ \fIID\fR] - [\-l\ \fIlabel\fR] - [\fB\-p\ \fR\fB\fIPIN\fR\fR] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBpkcs11\-list\fR\ 'u +\fBpkcs11\-list\fR [\fB\-P\fR] [\fB\-m\ \fR\fB\fImodule\fR\fR] [\fB\-s\ \fR\fB\fIslot\fR\fR] [\-i\ \fIID\fR] [\-l\ \fIlabel\fR] [\fB\-p\ \fR\fB\fIPIN\fR\fR] +.SH "DESCRIPTION" +.PP \fBpkcs11\-list\fR lists the PKCS#11 objects with \fBID\fR @@ -57,41 +51,41 @@ or by default all objects\&. The object class, label, and ID are displayed for a true, false, or never\&. - .SH "ARGUMENTS" - .PP +.SH "ARGUMENTS" +.PP \-P .RS 4 - List only the public objects\&. (Note that on some PKCS#11 devices, all objects are private\&.) - .RE - .PP +List only the public objects\&. (Note that on some PKCS#11 devices, all objects are private\&.) +.RE +.PP \-m \fImodule\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-s \fIslot\fR .RS 4 - Open the session with the given PKCS#11 slot\&. The default is slot 0\&. - .RE - .PP +Open the session with the given PKCS#11 slot\&. The default is slot 0\&. +.RE +.PP \-i \fIID\fR .RS 4 - List only key objects with the given object ID\&. - .RE - .PP +List only key objects with the given object ID\&. +.RE +.PP \-l \fIlabel\fR .RS 4 - List only key objects with the given label\&. - .RE - .PP +List only key objects with the given label\&. +.RE +.PP \-p \fIPIN\fR .RS 4 - Specify the PIN for the device\&. If no PIN is provided on the command line, +Specify the PIN for the device\&. If no PIN is provided on the command line, \fBpkcs11\-list\fR will prompt for it\&. - .RE - .SH "SEE ALSO" - .PP +.RE +.SH "SEE ALSO" +.PP \fBpkcs11-destroy\fR(8), \fBpkcs11-keygen\fR(8), \fBpkcs11-tokens\fR(8) diff --git a/bin/pkcs11/pkcs11-list.html b/bin/pkcs11/pkcs11-list.html index fc15d69a35..e9c1416385 100644 --- a/bin/pkcs11/pkcs11-list.html +++ b/bin/pkcs11/pkcs11-list.html @@ -14,38 +14,17 @@
- - - - - -
+

Name

-

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

+

pkcs11-list — list PKCS#11 objects

- - - -
+

Synopsis

-

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

-
- -
+

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. @@ -54,71 +33,48 @@ attribute is also displayed, as either true, false, or never.

-
- -
+
+

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.8 b/bin/pkcs11/pkcs11-tokens.8 index f24e345e22..c20aa46817 100644 --- a/bin/pkcs11/pkcs11-tokens.8 +++ b/bin/pkcs11/pkcs11-tokens.8 @@ -35,30 +35,28 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" pkcs11-tokens \- list PKCS#11 available tokens - .SH "SYNOPSIS" - .HP \w'\fBpkcs11\-tokens\fR\ 'u - \fBpkcs11\-tokens\fR - [\fB\-m\ \fR\fB\fImodule\fR\fR] - [\fB\-v\fR] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBpkcs11\-tokens\fR\ 'u +\fBpkcs11\-tokens\fR [\fB\-m\ \fR\fB\fImodule\fR\fR] [\fB\-v\fR] +.SH "DESCRIPTION" +.PP \fBpkcs11\-tokens\fR lists the PKCS#11 available tokens with defaults from the slot/token scan performed at application initialization\&. - .SH "ARGUMENTS" - .PP +.SH "ARGUMENTS" +.PP \-m \fImodule\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \-v .RS 4 - Make the PKCS#11 libisc initialization verbose\&. - .RE - .SH "SEE ALSO" - .PP +Make the PKCS#11 libisc initialization verbose\&. +.RE +.SH "SEE ALSO" +.PP \fBpkcs11-destroy\fR(8), \fBpkcs11-keygen\fR(8), \fBpkcs11-list\fR(8) diff --git a/bin/pkcs11/pkcs11-tokens.html b/bin/pkcs11/pkcs11-tokens.html index 7e27580733..71eeb2d312 100644 --- a/bin/pkcs11/pkcs11-tokens.html +++ b/bin/pkcs11/pkcs11-tokens.html @@ -14,76 +14,44 @@
- - - - - -
+

Name

-

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

+

pkcs11-tokens — list PKCS#11 available tokens

- - - -
+

Synopsis

-

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

-
- -
+

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.8 b/bin/python/dnssec-checkds.8 index 5563b95b99..22c2fc090d 100644 --- a/bin/python/dnssec-checkds.8 +++ b/bin/python/dnssec-checkds.8 @@ -35,56 +35,46 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-checkds \- DNSSEC delegation consistency checking tool - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-checkds\fR\ 'u - \fBdnssec\-checkds\fR - [\fB\-l\ \fR\fB\fIdomain\fR\fR] - [\fB\-f\ \fR\fB\fIfile\fR\fR] - [\fB\-d\ \fR\fB\fIdig\ path\fR\fR] - [\fB\-D\ \fR\fB\fIdsfromkey\ path\fR\fR] - {zone} - .HP \w'\fBdnssec\-dsfromkey\fR\ 'u - \fBdnssec\-dsfromkey\fR - [\fB\-l\ \fR\fB\fIdomain\fR\fR] - [\fB\-f\ \fR\fB\fIfile\fR\fR] - [\fB\-d\ \fR\fB\fIdig\ path\fR\fR] - [\fB\-D\ \fR\fB\fIdsfromkey\ path\fR\fR] - {zone} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-checkds\fR\ 'u +\fBdnssec\-checkds\fR [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-d\ \fR\fB\fIdig\ path\fR\fR] [\fB\-D\ \fR\fB\fIdsfromkey\ path\fR\fR] {zone} +.HP \w'\fBdnssec\-dsfromkey\fR\ 'u +\fBdnssec\-dsfromkey\fR [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-d\ \fR\fB\fIdig\ path\fR\fR] [\fB\-D\ \fR\fB\fIdsfromkey\ path\fR\fR] {zone} +.SH "DESCRIPTION" +.PP \fBdnssec\-checkds\fR verifies the correctness of Delegation Signer (DS) or DNSSEC Lookaside Validation (DLV) resource records for keys in a specified zone\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-f \fIfile\fR .RS 4 - If a +If a \fBfile\fR 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\&. - .RE - .PP +.RE +.PP \-l \fIdomain\fR .RS 4 - Check for a DLV record in the specified lookaside domain, instead of checking for a DS record in the zone\*(Aqs parent\&. - .RE - .PP +Check for a DLV record in the specified lookaside domain, instead of checking for a DS record in the zone\*(Aqs parent\&. +.RE +.PP \-d \fIdig path\fR .RS 4 - Specifies a path to a +Specifies a path to a \fBdig\fR binary\&. Used for testing\&. - .RE - .PP +.RE +.PP \-D \fIdsfromkey path\fR .RS 4 - Specifies a path to a +Specifies a path to a \fBdnssec\-dsfromkey\fR binary\&. Used for testing\&. - .RE - .SH "SEE ALSO" - .PP +.RE +.SH "SEE ALSO" +.PP \fBdnssec-dsfromkey\fR(8), \fBdnssec-keygen\fR(8), \fBdnssec-signzone\fR(8), diff --git a/bin/python/dnssec-checkds.html b/bin/python/dnssec-checkds.html index 1a0ff22c6f..08f040fe11 100644 --- a/bin/python/dnssec-checkds.html +++ b/bin/python/dnssec-checkds.html @@ -14,102 +14,55 @@
- - - - - -
+

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. -

-
+

-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.8 b/bin/python/dnssec-coverage.8 index 7d77e3ba05..a97c26471a 100644 --- a/bin/python/dnssec-coverage.8 +++ b/bin/python/dnssec-coverage.8 @@ -35,124 +35,114 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-coverage \- checks future DNSKEY coverage for a zone - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-coverage\fR\ 'u - \fBdnssec\-coverage\fR - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - [\fB\-l\ \fR\fB\fIlength\fR\fR] - [\fB\-f\ \fR\fB\fIfile\fR\fR] - [\fB\-d\ \fR\fB\fIDNSKEY\ TTL\fR\fR] - [\fB\-m\ \fR\fB\fImax\ TTL\fR\fR] - [\fB\-r\ \fR\fB\fIinterval\fR\fR] - [\fB\-c\ \fR\fB\fIcompilezone\ path\fR\fR] - [\fB\-k\fR] - [\fB\-z\fR] - [zone...] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-coverage\fR\ 'u +\fBdnssec\-coverage\fR [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-l\ \fR\fB\fIlength\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-d\ \fR\fB\fIDNSKEY\ TTL\fR\fR] [\fB\-m\ \fR\fB\fImax\ TTL\fR\fR] [\fB\-r\ \fR\fB\fIinterval\fR\fR] [\fB\-c\ \fR\fB\fIcompilezone\ path\fR\fR] [\fB\-k\fR] [\fB\-z\fR] [zone...] +.SH "DESCRIPTION" +.PP \fBdnssec\-coverage\fR 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\&. - .PP +.PP If \fBzone\fR 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\&., publication, activation, inactivation, deletion)\&. The list of events is walked in order of occurrence\&. Warnings are generated if any event is scheduled which could cause the zone to enter a state in which validation failures might occur: for example, if the number of published or active keys for a given algorithm drops to zero, or if a key is deleted from the zone too soon after a new key is rolled, and cached data signed by the prior key has not had time to expire from resolver caches\&. - .PP +.PP If \fBzone\fR 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\&.) - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-K \fIdirectory\fR .RS 4 - Sets the directory in which keys can be found\&. Defaults to the current working directory\&. - .RE - .PP +Sets the directory in which keys can be found\&. Defaults to the current working directory\&. +.RE +.PP \-f \fIfile\fR .RS 4 - If a +If a \fBfile\fR 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 \fB\-m\fR and \fB\-d\fR options do not need to be specified on the command line\&. - .RE - .PP +.RE +.PP \-l \fIduration\fR .RS 4 - The length of time to check for DNSSEC coverage\&. Key events scheduled further into the future than +The length of time to check for DNSSEC coverage\&. Key events scheduled further into the future than \fBduration\fR will be ignored, and assumed to be correct\&. .sp - The value of +The value of \fBduration\fR can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. - .RE - .PP +.RE +.PP \-m \fImaximum TTL\fR .RS 4 - 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 deactivated, there must be enough time for the record in the zone with the longest TTL to have expired from resolver caches before that key can be purged from the DNSKEY RRset\&. If that condition does not apply, a warning will be generated\&. +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 deactivated, there must be enough time for the record in the zone with the longest TTL to have expired from resolver caches before that key can be purged from the DNSKEY RRset\&. If that condition does not apply, a warning will be generated\&. .sp - The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. +The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. .sp - This option is not necessary if the +This option is not necessary if the \fB\-f\fR has been used to specify a zone file\&. If \fB\-f\fR has been specified, this option may still be used; it will override the value found in the file\&. .sp - 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\&. - .RE - .PP +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\&. +.RE +.PP \-d \fIDNSKEY TTL\fR .RS 4 - 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 is, replaced with a new key), there must be enough time for the old DNSKEY RRset to have expired from resolver caches before the new key is activated and begins generating signatures\&. If that condition does not apply, a warning will be generated\&. +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 is, replaced with a new key), there must be enough time for the old DNSKEY RRset to have expired from resolver caches before the new key is activated and begins generating signatures\&. If that condition does not apply, a warning will be generated\&. .sp - The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. +The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. .sp - This option is not necessary if +This option is not necessary if \fB\-f\fR 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 set using ith the \fB\-L\fR to \fBdnssec\-keygen\fR\&. If either of those is true, this option may still be used; it will override the values found in the zone file or the key file\&. .sp - 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\&. - .RE - .PP +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\&. +.RE +.PP \-r \fIresign interval\fR .RS 4 - 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 22\&.5 days, which is also the default in +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 22\&.5 days, which is also the default in \fBnamed\fR\&. However, if it has been changed by the \fBsig\-validity\-interval\fR option in named\&.conf, then it should also be changed here\&. .sp - The length of the interval can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. - .RE - .PP +The length of the interval can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. +.RE +.PP \-k .RS 4 - Only check KSK coverage; ignore ZSK events\&. Cannot be used with +Only check KSK coverage; ignore ZSK events\&. Cannot be used with \fB\-z\fR\&. - .RE - .PP +.RE +.PP \-z .RS 4 - Only check ZSK coverage; ignore KSK events\&. Cannot be used with +Only check ZSK coverage; ignore KSK events\&. Cannot be used with \fB\-k\fR\&. - .RE - .PP +.RE +.PP \-c \fIcompilezone path\fR .RS 4 - Specifies a path to a +Specifies a path to a \fBnamed\-compilezone\fR binary\&. Used for testing\&. - .RE - .SH "SEE ALSO" - .PP +.RE +.SH "SEE ALSO" +.PP \fBdnssec-checkds\fR(8), \fBdnssec-dsfromkey\fR(8), \fBdnssec-keygen\fR(8), diff --git a/bin/python/dnssec-coverage.html b/bin/python/dnssec-coverage.html index d5bab6f15a..417f193545 100644 --- a/bin/python/dnssec-coverage.html +++ b/bin/python/dnssec-coverage.html @@ -14,47 +14,22 @@
- - - - - -
+

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., @@ -67,54 +42,47 @@ 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 @@ -123,26 +91,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 @@ -151,12 +119,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 @@ -165,15 +133,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 @@ -183,54 +151,37 @@ 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/python/dnssec-keymgr.8 b/bin/python/dnssec-keymgr.8 index a4a3aaaac0..37c01d9b25 100644 --- a/bin/python/dnssec-keymgr.8 +++ b/bin/python/dnssec-keymgr.8 @@ -35,43 +35,32 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnssec-keymgr \- Ensures correct DNSKEY coverage for a zone based on a defined policy - .SH "SYNOPSIS" - .HP \w'\fBdnssec\-keymgr\fR\ 'u - \fBdnssec\-keymgr\fR - [\fB\-K\ \fR\fB\fIdirectory\fR\fR] - [\fB\-c\ \fR\fB\fIfile\fR\fR] - [\fB\-f\fR] - [\fB\-k\fR] - [\fB\-q\fR] - [\fB\-v\fR] - [\fB\-z\fR] - [\fB\-g\ \fR\fB\fIpath\fR\fR] - [\fB\-r\ \fR\fB\fIpath\fR\fR] - [\fB\-s\ \fR\fB\fIpath\fR\fR] - [zone...] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnssec\-keymgr\fR\ 'u +\fBdnssec\-keymgr\fR [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-c\ \fR\fB\fIfile\fR\fR] [\fB\-f\fR] [\fB\-k\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-z\fR] [\fB\-g\ \fR\fB\fIpath\fR\fR] [\fB\-r\ \fR\fB\fIpath\fR\fR] [\fB\-s\ \fR\fB\fIpath\fR\fR] [zone...] +.SH "DESCRIPTION" +.PP \fBdnssec\-keymgr\fR is a high level Python wrapper to facilitate the key rollover process for zones handled by BIND\&. It uses the BIND commands for manipulating DNSSEC key metadata: \fBdnssec\-keygen\fR and \fBdnssec\-settime\fR\&. - .PP +.PP DNSSEC policy can be read from a configuration file (default /etc/dnssec\-policy\&.conf), from which the key parameters, publication and rollover schedule, and desired coverage duration for any given zone can be determined\&. This file may be used to define individual DNSSEC policies on a per\-zone basis, or to set a "default" policy used for all zones\&. - .PP +.PP When \fBdnssec\-keymgr\fR runs, it examines the DNSSEC keys for one or more zones, comparing their timing metadata against the policies for those zones\&. If key settings do not conform to the DNSSEC policy (for example, because the policy has been changed), they are automatically corrected\&. - .PP +.PP A zone policy can specify a duration for which we want to ensure the key correctness (\fBcoverage\fR)\&. It can also specify a rollover period (\fBroll\-period\fR)\&. If policy indicates that a key should roll over before the coverage period ends, then a successor key will automatically be created and added to the end of the key series\&. - .PP +.PP If zones are specified on the command line, \fBdnssec\-keymgr\fR will examine only those zones\&. If a specified zone does not already have keys in place, then keys will be generated for it according to policy\&. - .PP +.PP If zones are \fInot\fR specified on the command line, then @@ -79,98 +68,98 @@ specified on the command line, then will search the key directory (either the current working directory or the directory set by the \fB\-K\fR option), and check the keys for all the zones represented in the directory\&. - .PP +.PP Key times that are in the past will not be updated unless the \fB\-f\fR is used (see below)\&. Key inactivation and deletion times that are less than five minutes in the future will be delayed by five minutes\&. - .PP +.PP It is expected that this tool will be run automatically and unattended (for example, by \fBcron\fR)\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-c \fIfile\fR .RS 4 - If +If \fB\-c\fR is specified, then the DNSSEC policy is read from \fBfile\fR\&. (If not specified, then the policy is read from /etc/dnssec\-policy\&.conf; if that file doesn\*(Aqt exist, a built\-in global default policy is used\&.) - .RE - .PP +.RE +.PP \-f .RS 4 - Force: allow updating of key events even if they are already in the past\&. This is not recommended for use with zones in which keys have already been published\&. However, if a set of keys has been generated all of which have publication and activation dates in the past, but the keys have not been published in a zone as yet, then this option can be used to clean them up and turn them into a proper series of keys with appropriate rollover intervals\&. - .RE - .PP +Force: allow updating of key events even if they are already in the past\&. This is not recommended for use with zones in which keys have already been published\&. However, if a set of keys has been generated all of which have publication and activation dates in the past, but the keys have not been published in a zone as yet, then this option can be used to clean them up and turn them into a proper series of keys with appropriate rollover intervals\&. +.RE +.PP \-g \fIkeygen\-path\fR .RS 4 - Specifies a path to a +Specifies a path to a \fBdnssec\-keygen\fR binary\&. Used for testing\&. See also the \fB\-s\fR option\&. - .RE - .PP +.RE +.PP \-h .RS 4 - Print the +Print the \fBdnssec\-keymgr\fR help summary and exit\&. - .RE - .PP +.RE +.PP \-K \fIdirectory\fR .RS 4 - Sets the directory in which keys can be found\&. Defaults to the current working directory\&. - .RE - .PP +Sets the directory in which keys can be found\&. Defaults to the current working directory\&. +.RE +.PP \-k .RS 4 - Only apply policies to KSK keys\&. See also the +Only apply policies to KSK keys\&. See also the \fB\-z\fR option\&. - .RE - .PP +.RE +.PP \-q .RS 4 - Quiet: suppress printing of +Quiet: suppress printing of \fBdnssec\-keygen\fR and \fBdnssec\-settime\fR\&. - .RE - .PP +.RE +.PP \-r \fIrandomdev\fR .RS 4 - Specifies a path to a file containing random data\&. This is passed to the +Specifies a path to a file containing random data\&. This is passed to the \fBdnssec\-keygen\fR binary using its \fB\-r\fR option\&. - .RE - .PP +.RE +.PP \-s \fIsettime\-path\fR .RS 4 - Specifies a path to a +Specifies a path to a \fBdnssec\-settime\fR binary\&. Used for testing\&. See also the \fB\-g\fR option\&. - .RE - .PP +.RE +.PP \-v .RS 4 - Print the +Print the \fBdnssec\-keymgr\fR version and exit\&. - .RE - .PP +.RE +.PP \-z .RS 4 - Only apply policies to ZSK keys\&. See also the +Only apply policies to ZSK keys\&. See also the \fB\-k\fR option\&. - .RE - .SH "POLICY CONFIGURATION" - .PP +.RE +.SH "POLICY CONFIGURATION" +.PP The dnssec\-policy\&.conf file can specify three kinds of policies: @@ -183,7 +172,7 @@ file can specify three kinds of policies: .sp -1 .IP \(bu 2.3 .\} - \fIPolicy classes\fR +\fIPolicy classes\fR (\fBpolicy \fR\fB\fIname\fR\fR\fB { \&.\&.\&. };\fR) can be inherited by zone policies or other policy classes; these can be used to create sets of different security profiles\&. For example, a policy class \fBnormal\fR might specify 1024\-bit key sizes, but a class @@ -191,7 +180,7 @@ might specify 1024\-bit key sizes, but a class might specify 2048 bits instead; \fBextra\fR would be used for zones that had unusually high security needs\&. - .RE +.RE .sp .RS 4 .ie n \{\ @@ -201,11 +190,11 @@ would be used for zones that had unusually high security needs\&. .sp -1 .IP \(bu 2.3 .\} - \fIAlgorithm policies:\fR +\fIAlgorithm policies:\fR (\fBalgorithm\-policy \fR\fB\fIalgorithm\fR\fR\fB { \&.\&.\&. };\fR ) override default per\-algorithm settings\&. For example, by default, RSASHA256 keys use 2048\-bit key sizes for both KSK and ZSK\&. This can be modified using \fBalgorithm\-policy\fR, and the new key sizes would then be used for any key of type RSASHA256\&. - .RE +.RE .sp .RS 4 .ie n \{\ @@ -215,64 +204,64 @@ would be used for zones that had unusually high security needs\&. .sp -1 .IP \(bu 2.3 .\} - \fIZone policies:\fR +\fIZone policies:\fR (\fBzone \fR\fB\fIname\fR\fR\fB { \&.\&.\&. };\fR ) set policy for a single zone by name\&. A zone policy can inherit a policy class by including a \fBpolicy\fR option\&. Zone names beginning with digits (i\&.e\&., 0\-9) must be quoted\&. If a zone does not have its own policy then the "default" policy applies\&. - .RE - .PP +.RE +.PP Options that can be specified in policies: - .PP +.PP \fBalgorithm\fR \fIname\fR; .RS 4 - The key algorithm\&. If no policy is defined, the default is RSASHA256\&. - .RE - .PP +The key algorithm\&. If no policy is defined, the default is RSASHA256\&. +.RE +.PP \fBcoverage\fR \fIduration\fR; .RS 4 - The length of time to ensure that keys will be correct; no action will be taken to create new keys to be activated after this time\&. This can be represented as a number of seconds, or as a duration using human\-readable units (examples: "1y" or "6 months")\&. A default value for this option can be set in algorithm policies as well as in policy classes or zone policies\&. If no policy is configured, the default is six months\&. - .RE - .PP +The length of time to ensure that keys will be correct; no action will be taken to create new keys to be activated after this time\&. This can be represented as a number of seconds, or as a duration using human\-readable units (examples: "1y" or "6 months")\&. A default value for this option can be set in algorithm policies as well as in policy classes or zone policies\&. If no policy is configured, the default is six months\&. +.RE +.PP \fBdirectory\fR \fIpath\fR; .RS 4 - Specifies the directory in which keys should be stored\&. - .RE - .PP +Specifies the directory in which keys should be stored\&. +.RE +.PP \fBkey\-size\fR \fIkeytype\fR \fIsize\fR; .RS 4 - Specifies the number of bits to use in creating keys\&. The keytype is either "zsk" or "ksk"\&. A default value for this option can be set in algorithm policies as well as in policy classes or zone policies\&. If no policy is configured, the default is 1024 bits for DSA keys and 2048 for RSA\&. - .RE - .PP +Specifies the number of bits to use in creating keys\&. The keytype is either "zsk" or "ksk"\&. A default value for this option can be set in algorithm policies as well as in policy classes or zone policies\&. If no policy is configured, the default is 1024 bits for DSA keys and 2048 for RSA\&. +.RE +.PP \fBkeyttl\fR \fIduration\fR; .RS 4 - The key TTL\&. If no policy is defined, the default is one hour\&. - .RE - .PP +The key TTL\&. If no policy is defined, the default is one hour\&. +.RE +.PP \fBpost\-publish\fR \fIkeytype\fR \fIduration\fR; .RS 4 - How long after inactivation a key should be deleted from the zone\&. Note: If +How long after inactivation a key should be deleted from the zone\&. Note: If \fBroll\-period\fR is not set, this value is ignored\&. The keytype is either "zsk" or "ksk"\&. A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies\&. The default is one month\&. - .RE - .PP +.RE +.PP \fBpre\-publish\fR \fIkeytype\fR \fIduration\fR; .RS 4 - How long before activation a key should be published\&. Note: If +How long before activation a key should be published\&. Note: If \fBroll\-period\fR is not set, this value is ignored\&. The keytype is either "zsk" or "ksk"\&. A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies\&. The default is one month\&. - .RE - .PP +.RE +.PP \fBroll\-period\fR \fIkeytype\fR \fIduration\fR; .RS 4 - How frequently keys should be rolled over\&. The keytype is either "zsk" or "ksk"\&. A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies\&. If no policy is configured, the default is one year for ZSKs\&. KSKs do not roll over by default\&. - .RE - .PP +How frequently keys should be rolled over\&. The keytype is either "zsk" or "ksk"\&. A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies\&. If no policy is configured, the default is one year for ZSKs\&. KSKs do not roll over by default\&. +.RE +.PP \fBstandby\fR \fIkeytype\fR \fInumber\fR; .RS 4 - Not yet implemented\&. - .RE - .SH "REMAINING WORK" +Not yet implemented\&. +.RE +.SH "REMAINING WORK" .sp .RS 4 .ie n \{\ @@ -282,7 +271,7 @@ is not set, this value is ignored\&. The keytype is either "zsk" or "ksk"\&. A d .sp -1 .IP \(bu 2.3 .\} - Enable scheduling of KSK rollovers using the +Enable scheduling of KSK rollovers using the \fB\-P sync\fR and \fB\-D sync\fR @@ -291,7 +280,7 @@ options to and \fBdnssec\-settime\fR\&. Check the parent zone (as in \fBdnssec\-checkds\fR) to determine when it\*(Aqs safe for the key to roll\&. - .RE +.RE .sp .RS 4 .ie n \{\ @@ -301,10 +290,10 @@ and .sp -1 .IP \(bu 2.3 .\} - Allow configuration of standby keys and use of the REVOKE bit, for keys that use RFC 5011 semantics\&. - .RE - .SH "SEE ALSO" - .PP +Allow configuration of standby keys and use of the REVOKE bit, for keys that use RFC 5011 semantics\&. +.RE +.SH "SEE ALSO" +.PP \fBdnssec-coverage\fR(8), \fBdnssec-keygen\fR(8), \fBdnssec-settime\fR(8), diff --git a/bin/python/dnssec-keymgr.html b/bin/python/dnssec-keymgr.html index 7397eddbb4..3eab70f473 100644 --- a/bin/python/dnssec-keymgr.html +++ b/bin/python/dnssec-keymgr.html @@ -14,49 +14,24 @@
- - - - - -
+

Name

-

- dnssec-keymgr - — Ensures correct DNSKEY coverage for a zone based on a defined policy -

+

dnssec-keymgr — Ensures correct DNSKEY coverage for a zone based on a defined policy

- - - -
+

Synopsis

-

- dnssec-keymgr - [-K directory] - [-c file] - [-f] - [-k] - [-q] - [-v] - [-z] - [-g path] - [-r path] - [-s path] - [zone...] -

-
- -
+

dnssec-keymgr [-K directory] [-c file] [-f] [-k] [-q] [-v] [-z] [-g path] [-r path] [-s path] [zone...]

+
+

DESCRIPTION

-

+

dnssec-keymgr is a high level Python wrapper to facilitate the key rollover process for zones handled by BIND. It uses the BIND commands for manipulating DNSSEC key metadata: dnssec-keygen and dnssec-settime.

-

+

DNSSEC policy can be read from a configuration file (default /etc/dnssec-policy.conf), from which the key parameters, publication and rollover schedule, and desired @@ -65,14 +40,14 @@ per-zone basis, or to set a "default" policy used for all zones.

-

+

When dnssec-keymgr runs, it examines the DNSSEC keys for one or more zones, comparing their timing metadata against the policies for those zones. If key settings do not conform to the DNSSEC policy (for example, because the policy has been changed), they are automatically corrected.

-

+

A zone policy can specify a duration for which we want to ensure the key correctness (coverage). It can also specify a rollover period (roll-period). @@ -80,47 +55,43 @@ coverage period ends, then a successor key will automatically be created and added to the end of the key series.

-

+

If zones are specified on the command line, dnssec-keymgr will examine only those zones. If a specified zone does not already have keys in place, then keys will be generated for it according to policy.

-

+

If zones are not specified on the command line, then dnssec-keymgr will search the key directory (either the current working directory or the directory set by the -K option), and check the keys for all the zones represented in the directory.

-

+

Key times that are in the past will not be updated unless the -f is used (see below). Key inactivation and deletion times that are less than five minutes in the future will be delayed by five minutes.

-

+

It is expected that this tool will be run automatically and unattended (for example, by cron).

-
- -
+
+

OPTIONS

-
+
-c file
-
-

+

If -c is specified, then the DNSSEC policy is read from file. (If not specified, then the policy is read from /etc/dnssec-policy.conf; if that file doesn't exist, a built-in global default policy is used.) -

-
+

-f
-
-

+

Force: allow updating of key events even if they are already in the past. This is not recommended for use with zones in which keys have already been published. However, @@ -129,86 +100,65 @@ keys have not been published in a zone as yet, then this option can be used to clean them up and turn them into a proper series of keys with appropriate rollover intervals. -

-
+

-g keygen-path
-
-

+

Specifies a path to a dnssec-keygen binary. Used for testing. See also the -s option. -

-
+

-h
-
-

+

Print the dnssec-keymgr help summary and exit. -

-
+

-K directory
-
-

+

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

-
+

-k
-
-

+

Only apply policies to KSK keys. See also the -z option. -

-
+

-q
-
-

+

Quiet: suppress printing of dnssec-keygen and dnssec-settime. -

-
+

-r randomdev
-
-

+

Specifies a path to a file containing random data. This is passed to the dnssec-keygen binary using its -r option. -

-
+

-s settime-path
-
-

+

Specifies a path to a dnssec-settime binary. Used for testing. See also the -g option. -

-
+

-v
-
-

+

Print the dnssec-keymgr version and exit. -

-
+

-z
-
-

+

Only apply policies to ZSK keys. See also the -k option. -

-
+

-
- -
+
+

POLICY CONFIGURATION

-

+

The dnssec-policy.conf file can specify three kinds of policies:

-
    -
  • -

    +

      +

    • Policy classes (policy name { ... };) can be inherited by zone policies or other policy classes; these @@ -217,20 +167,16 @@ 1024-bit key sizes, but a class extra might specify 2048 bits instead; extra would be used for zones that had unusually high security needs. -

      -
      • -
    • -

      +

      • +

    • Algorithm policies: (algorithm-policy algorithm { ... }; ) override default per-algorithm settings. For example, by default, RSASHA256 keys use 2048-bit key sizes for both KSK and ZSK. This can be modified using algorithm-policy, and the new key sizes would then be used for any key of type RSASHA256. -

      -
      • -
    • -

      +

      • +

    • Zone policies: (zone name { ... }; ) set policy for a single zone by name. A zone policy can inherit @@ -238,25 +184,21 @@ Zone names beginning with digits (i.e., 0-9) must be quoted. If a zone does not have its own policy then the "default" policy applies. -

      -
      • +

    -

    +

    Options that can be specified in policies:

    -
    +
    algorithm name;
    -
    -

    +

    The key algorithm. If no policy is defined, the default is RSASHA256. -

    -
    +

    coverage duration;
    -
    -

    +

    The length of time to ensure that keys will be correct; no action will be taken to create new keys to be activated after this time. This can be represented as a number of seconds, or as a duration @@ -264,119 +206,89 @@ A default value for this option can be set in algorithm policies as well as in policy classes or zone policies. If no policy is configured, the default is six months. -

    -
    +

    directory path;
    -
    -

    +

    Specifies the directory in which keys should be stored. -

    -
    +

    key-size keytype size;
    -
    -

    +

    Specifies the number of bits to use in creating keys. The keytype is either "zsk" or "ksk". A default value for this option can be set in algorithm policies as well as in policy classes or zone policies. If no policy is configured, the default is 1024 bits for DSA keys and 2048 for RSA. -

    -
    +

    keyttl duration;
    -
    -

    +

    The key TTL. If no policy is defined, the default is one hour. -

    -
    +

    post-publish keytype duration;
    -
    -

    +

    How long after inactivation a key should be deleted from the zone. Note: If roll-period is not set, this value is ignored. The keytype is either "zsk" or "ksk". A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies. The default is one month. -

    -
    +

    pre-publish keytype duration;
    -
    -

    +

    How long before activation a key should be published. Note: If roll-period is not set, this value is ignored. The keytype is either "zsk" or "ksk". A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies. The default is one month. -

    -
    +

    roll-period keytype duration;
    -
    -

    +

    How frequently keys should be rolled over. The keytype is either "zsk" or "ksk". A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies. If no policy is configured, the default is one year for ZSKs. KSKs do not roll over by default. -

    -
    +

    standby keytype number;
    -
    -

    +

    Not yet implemented. -

    -
    +

    -
    - -
    +
    +

    REMAINING WORK

    -
      -
    • -

      +

        +

      • Enable scheduling of KSK rollovers using the -P sync and -D sync options to dnssec-keygen and dnssec-settime. Check the parent zone (as in dnssec-checkds) to determine when it's safe for the key to roll. -

        -
        • -
      • -

        +

        • +

      • Allow configuration of standby keys and use of the REVOKE bit, for keys that use RFC 5011 semantics. -

        -
        • +

      -
    - -
    +
    +

    SEE ALSO

    -

    - - dnssec-coverage(8) - , - - dnssec-keygen(8) - , - - dnssec-settime(8) - , - - dnssec-checkds(8) - +

    + dnssec-coverage(8), + dnssec-keygen(8), + dnssec-settime(8), + dnssec-checkds(8)

    -
    - +
diff --git a/bin/rndc/rndc.8 b/bin/rndc/rndc.8 index 021ec8c2bb..6494709c0f 100644 --- a/bin/rndc/rndc.8 +++ b/bin/rndc/rndc.8 @@ -35,58 +35,48 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" rndc \- name server control utility - .SH "SYNOPSIS" - .HP \w'\fBrndc\fR\ 'u - \fBrndc\fR - [\fB\-b\ \fR\fB\fIsource\-address\fR\fR] - [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] - [\fB\-k\ \fR\fB\fIkey\-file\fR\fR] - [\fB\-s\ \fR\fB\fIserver\fR\fR] - [\fB\-p\ \fR\fB\fIport\fR\fR] - [\fB\-q\fR] - [\fB\-r\fR] - [\fB\-V\fR] - [\fB\-y\ \fR\fB\fIkey_id\fR\fR] - {command} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBrndc\fR\ 'u +\fBrndc\fR [\fB\-b\ \fR\fB\fIsource\-address\fR\fR] [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-k\ \fR\fB\fIkey\-file\fR\fR] [\fB\-s\ \fR\fB\fIserver\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-q\fR] [\fB\-r\fR] [\fB\-V\fR] [\fB\-y\ \fR\fB\fIkey_id\fR\fR] {command} +.SH "DESCRIPTION" +.PP \fBrndc\fR controls the operation of a name server\&. It supersedes the \fBndc\fR utility that was provided in old BIND releases\&. If \fBrndc\fR is invoked with no command line options or arguments, it prints a short summary of the supported commands and the available options and their arguments\&. - .PP +.PP \fBrndc\fR communicates with the name server over a TCP connection, sending commands authenticated with digital signatures\&. In the current versions of \fBrndc\fR and \fBnamed\fR, the only supported authentication algorithms are HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512\&. They use a shared secret on each end of the connection\&. This provides TSIG\-style authentication for the command request and the name server\*(Aqs response\&. All commands sent over the channel must be signed by a key_id known to the server\&. - .PP +.PP \fBrndc\fR reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-b \fIsource\-address\fR .RS 4 - Use +Use \fIsource\-address\fR 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\&. - .RE - .PP +.RE +.PP \-c \fIconfig\-file\fR .RS 4 - Use +Use \fIconfig\-file\fR as the configuration file instead of the default, /etc/rndc\&.conf\&. - .RE - .PP +.RE +.PP \-k \fIkey\-file\fR .RS 4 - Use +Use \fIkey\-file\fR as the key file instead of the default, /etc/rndc\&.key\&. The key in @@ -94,46 +84,46 @@ as the key file instead of the default, will be used to authenticate commands sent to the server if the \fIconfig\-file\fR does not exist\&. - .RE - .PP +.RE +.PP \-s \fIserver\fR .RS 4 - \fIserver\fR +\fIserver\fR is the name or address of the server which matches a server statement in the configuration file for \fBrndc\fR\&. If no server is supplied on the command line, the host named by the default\-server clause in the options statement of the \fBrndc\fR configuration file will be used\&. - .RE - .PP +.RE +.PP \-p \fIport\fR .RS 4 - Send commands to TCP port +Send commands to TCP port \fIport\fR instead of BIND 9\*(Aqs default control channel port, 953\&. - .RE - .PP +.RE +.PP \-q .RS 4 - Quiet mode: Message text returned by the server will not be printed except when there is an error\&. - .RE - .PP +Quiet mode: Message text returned by the server will not be printed except when there is an error\&. +.RE +.PP \-r .RS 4 - Instructs +Instructs \fBrndc\fR to print the result code returned by \fBnamed\fR after executing the requested command (e\&.g\&., ISC_R_SUCCESS, ISC_R_FAILURE, etc)\&. - .RE - .PP +.RE +.PP \-V .RS 4 - Enable verbose logging\&. - .RE - .PP +Enable verbose logging\&. +.RE +.PP \-y \fIkey_id\fR .RS 4 - Use the key +Use the key \fIkey_id\fR from the configuration file\&. \fIkey_id\fR @@ -144,20 +134,20 @@ with the same algorithm and secret string in order for control message validatio is specified, \fBrndc\fR will first look for a key clause in the server statement of the server being used, or if no server statement is present for that host, then the default\-key clause of the options statement\&. Note that the configuration file contains shared secrets which are used to send authenticated control commands to name servers\&. It should therefore not have general read or write access\&. - .RE - .SH "COMMANDS" - .PP +.RE +.SH "COMMANDS" +.PP A list of commands supported by \fBrndc\fR can be seen by running \fBrndc\fR without arguments\&. - .PP +.PP Currently supported commands are: - .PP +.PP \fBaddzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR\fB\fIconfiguration\fR\fR\fB \fR .RS 4 - Add a zone while the server is running\&. This command requires the +Add a zone while the server is running\&. This command requires the \fBallow\-new\-zones\fR option to be set to \fByes\fR\&. The @@ -165,34 +155,34 @@ option to be set to string specified on the command line is the zone configuration text that would ordinarily be placed in named\&.conf\&. .sp - The configuration is saved in a file called +The configuration is saved in a file called \fIname\fR\&.nzf, where \fIname\fR is the name of the view, or if it contains characters that are incompatible with use as a file name, a cryptographic hash generated from the name of the view\&. When \fBnamed\fR is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart\&. .sp - This sample +This sample \fBaddzone\fR command would add the zone example\&.com to the default view: .sp - $\fBrndc addzone example\&.com \*(Aq{ type master; file "example\&.com\&.db"; };\*(Aq\fR +$\fBrndc addzone example\&.com \*(Aq{ type master; file "example\&.com\&.db"; };\*(Aq\fR .sp - (Note the brackets and semi\-colon around the zone configuration text\&.) +(Note the brackets and semi\-colon around the zone configuration text\&.) .sp - See also +See also \fBrndc delzone\fR and \fBrndc modzone\fR\&. - .RE - .PP +.RE +.PP \fBdelzone \fR\fB[\-clean]\fR\fB \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR .RS 4 - Delete a zone while the server is running\&. +Delete a zone while the server is running\&. .sp - If the +If the \fB\-clean\fR argument is specified, the zone\*(Aqs master file (and journal file, if any) will be deleted along with the zone\&. Without the \fB\-clean\fR @@ -200,20 +190,20 @@ option, zone files must be cleaned up by hand\&. (If the zone is of type "slave" \fBrndc delzone\fR command\&.) .sp - If the zone was originally added via +If the zone was originally added via \fBrndc addzone\fR, then it will be removed permanently\&. However, if it was originally configured in named\&.conf, then that original configuration is still in place; when the server is restarted or reconfigured, the zone will come back\&. To remove it permanently, it must also be removed from named\&.conf .sp - See also +See also \fBrndc addzone\fR and \fBrndc modzone\fR\&. - .RE - .PP +.RE +.PP \fBdnstap ( \-reopen | \-roll \fR\fB[\fInumber\fR]\fR\fB )\fR .RS 4 - Close and re\-open DNSTAP output files\&. +Close and re\-open DNSTAP output files\&. \fBrndc dnstap \-reopen\fR allows the output file to be renamed externally, so that \fBnamed\fR @@ -222,72 +212,72 @@ can truncate and re\-open it\&. causes the output file to be rolled automatically, similar to log files; the most recent output file has "\&.0" appended to its name; the previous most recent output file is moved to "\&.1", and so on\&. If \fInumber\fR is specified, then the number of backup log files is limited to that number\&. - .RE - .PP +.RE +.PP \fBdumpdb \fR\fB[\-all|\-cache|\-zones|\-adb|\-bad|\-fail]\fR\fB \fR\fB[\fIview \&.\&.\&.\fR]\fR .RS 4 - Dump the server\*(Aqs caches (default) and/or zones to the dump file for the specified views\&. If no view is specified, all views are dumped\&. (See the +Dump the server\*(Aqs caches (default) and/or zones to the dump file for the specified views\&. If no view is specified, all views are dumped\&. (See the \fBdump\-file\fR option in the BIND 9 Administrator Reference Manual\&.) - .RE - .PP +.RE +.PP \fBflush\fR .RS 4 - Flushes the server\*(Aqs cache\&. - .RE - .PP +Flushes the server\*(Aqs cache\&. +.RE +.PP \fBflushname\fR \fIname\fR [\fIview\fR] .RS 4 - Flushes the given name from the view\*(Aqs DNS cache and, if applicable, from the view\*(Aqs nameserver address database, bad server cache and SERVFAIL cache\&. - .RE - .PP +Flushes the given name from the view\*(Aqs DNS cache and, if applicable, from the view\*(Aqs nameserver address database, bad server cache and SERVFAIL cache\&. +.RE +.PP \fBflushtree\fR \fIname\fR [\fIview\fR] .RS 4 - Flushes the given name, and all of its subdomains, from the view\*(Aqs DNS cache, address database, bad server cache, and SERVFAIL cache\&. - .RE - .PP +Flushes the given name, and all of its subdomains, from the view\*(Aqs DNS cache, address database, bad server cache, and SERVFAIL cache\&. +.RE +.PP \fBfreeze \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR .RS 4 - 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 dynamic update\&. It also causes changes in the journal file to be synced into the master file\&. All dynamic update attempts will be refused while the zone is frozen\&. +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 dynamic update\&. It also causes changes in the journal file to be synced into the master file\&. All dynamic update attempts will be refused while the zone is frozen\&. .sp - See also +See also \fBrndc thaw\fR\&. - .RE - .PP +.RE +.PP \fBhalt \fR\fB[\-p]\fR .RS 4 - 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 journal files when the server is restarted\&. If +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 journal files when the server is restarted\&. If \fB\-p\fR is specified \fBnamed\fR\*(Aqs process id is returned\&. This allows an external process to determine when \fBnamed\fR had completed halting\&. .sp - See also +See also \fBrndc stop\fR\&. - .RE - .PP +.RE +.PP \fBloadkeys \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 - Fetch all DNSSEC keys for the given zone from the key directory\&. If they are within their publication period, merge them into the zone\*(Aqs DNSKEY RRset\&. Unlike +Fetch all DNSSEC keys for the given zone from the key directory\&. If they are within their publication period, merge them into the zone\*(Aqs DNSKEY RRset\&. Unlike \fBrndc sign\fR, however, the zone is not immediately re\-signed by the new keys, but is allowed to incrementally re\-sign over time\&. .sp - This command requires that the +This command requires that the \fBauto\-dnssec\fR zone option be set to maintain, and also requires the zone to be configured to allow dynamic DNS\&. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details\&.) - .RE - .PP +.RE +.PP \fBmanaged\-keys \fR\fB\fI(status | refresh | sync)\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 - When run with the "status" keyword, print the current status of the managed\-keys database for the specified view, or for all views if none is specified\&. When run with the "refresh" keyword, force an immediate refresh of all the managed\-keys in the specified view, or all views\&. When run with the "sync" keyword, force an immediate dump of the managed\-keys database to disk (in the file +When run with the "status" keyword, print the current status of the managed\-keys database for the specified view, or for all views if none is specified\&. When run with the "refresh" keyword, force an immediate refresh of all the managed\-keys in the specified view, or all views\&. When run with the "sync" keyword, force an immediate dump of the managed\-keys database to disk (in the file managed\-keys\&.bind or (\fIviewname\fR\&.mkeys)\&. - .RE - .PP +.RE +.PP \fBmodzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR\fB\fIconfiguration\fR\fR\fB \fR .RS 4 - Modify the configuration of a zone while the server is running\&. This command requires the +Modify the configuration of a zone while the server is running\&. This command requires the \fBallow\-new\-zones\fR option to be set to \fByes\fR\&. As with @@ -296,33 +286,33 @@ option to be set to string specified on the command line is the zone configuration text that would ordinarily be placed in named\&.conf\&. .sp - If the zone was originally added via +If the zone was originally added via \fBrndc addzone\fR, the configuration changes will be recorded permanently and will still be in effect after the server is restarted or reconfigured\&. However, if it was originally configured in named\&.conf, then that original configuration is still in place; when the server is restarted or reconfigured, the zone will revert to its original configuration\&. To make the changes permanent, it must also be modified in named\&.conf .sp - See also +See also \fBrndc addzone\fR and \fBrndc delzone\fR\&. - .RE - .PP +.RE +.PP \fBnotify \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 - Resend NOTIFY messages for the zone\&. - .RE - .PP +Resend NOTIFY messages for the zone\&. +.RE +.PP \fBnotrace\fR .RS 4 - Sets the server\*(Aqs debugging level to 0\&. +Sets the server\*(Aqs debugging level to 0\&. .sp - See also +See also \fBrndc trace\fR\&. - .RE - .PP +.RE +.PP \fBnta \fR\fB[( \-class \fIclass\fR | \-dump | \-force | \-remove | \-lifetime \fIduration\fR)]\fR\fB \fR\fB\fIdomain\fR\fR\fB \fR\fB[\fIview\fR]\fR\fB \fR .RS 4 - Sets a DNSSEC negative trust anchor (NTA) for +Sets a DNSSEC negative trust anchor (NTA) for \fBdomain\fR, with a lifetime of \fBduration\fR\&. The default lifetime is configured in named\&.conf @@ -330,33 +320,33 @@ via the \fBnta\-lifetime\fR option, and defaults to one hour\&. The lifetime cannot exceed one week\&. .sp - A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration rather than an attack\&. When data to be validated is at or below an active NTA (and above any other configured trust anchors), +A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration rather than an attack\&. When data to be validated is at or below an active NTA (and above any other configured trust anchors), \fBnamed\fR will abort the DNSSEC validation process and treat the data as insecure rather than bogus\&. This continues until the NTA\*(Aqs lifetime is elapsed\&. .sp - NTAs persist across restarts of the +NTAs persist across restarts of the \fBnamed\fR server\&. The NTAs for a view are saved in a file called \fIname\fR\&.nta, where \fIname\fR is the name of the view, or if it contains characters that are incompatible with use as a file name, a cryptographic hash generated from the name of the view\&. .sp - An existing NTA can be removed by using the +An existing NTA can be removed by using the \fB\-remove\fR option\&. .sp - An NTA\*(Aqs lifetime can be specified with the +An NTA\*(Aqs lifetime can be specified with the \fB\-lifetime\fR option\&. TTL\-style suffixes can be used to specify the lifetime in seconds, minutes, or hours\&. If the specified NTA already exists, its lifetime will be updated to the new value\&. Setting \fBlifetime\fR to zero is equivalent to \fB\-remove\fR\&. .sp - If the +If the \fB\-dump\fR is used, any other arguments are ignored, and a list of existing NTAs is printed (note that this may include NTAs that are expired but have not yet been cleaned up)\&. .sp - Normally, +Normally, \fBnamed\fR will periodically test to see whether data below an NTA can now be validated (see the \fBnta\-recheck\fR @@ -364,23 +354,23 @@ option in the Administrator Reference Manual for details)\&. If data can be vali \fB\-force\fR overrides this behavior and forces an NTA to persist for its entire lifetime, regardless of whether data could be validated if the NTA were not present\&. .sp - The view class can be specified with +The view class can be specified with \fB\-class\fR\&. The default is class \fBIN\fR, which is the only class for which DNSSEC is currently supported\&. .sp - All of these options can be shortened, i\&.e\&., to +All of these options can be shortened, i\&.e\&., to \fB\-l\fR, \fB\-r\fR, \fB\-d\fR, \fB\-f\fR, and \fB\-c\fR\&. - .RE - .PP +.RE +.PP \fBquerylog\fR [ on | off ] .RS 4 - Enable or disable query logging\&. (For backward compatibility, this command can also be used without an argument to toggle query logging on and 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\&.) .sp - Query logging can also be enabled by explicitly directing the +Query logging can also be enabled by explicitly directing the \fBqueries\fR \fBcategory\fR to a @@ -395,61 +385,61 @@ in the \fBoptions\fR section of named\&.conf\&. - .RE - .PP +.RE +.PP \fBreconfig\fR .RS 4 - Reload the configuration file and load new zones, but do not reload existing zone files even if they have changed\&. This is faster than a full +Reload the configuration file and load new zones, but do not reload existing zone files even if they have changed\&. This is faster than a full \fBreload\fR when there is a large number of zones because it avoids the need to examine the modification times of the zones files\&. - .RE - .PP +.RE +.PP \fBrecursing\fR .RS 4 - Dump the list of queries +Dump the list of queries \fBnamed\fR 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 \fBfetches\-per\-zone\fR option\&.) - .RE - .PP +.RE +.PP \fBrefresh \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 - Schedule zone maintenance for the given zone\&. - .RE - .PP +Schedule zone maintenance for the given zone\&. +.RE +.PP \fBreload\fR .RS 4 - Reload configuration file and zones\&. - .RE - .PP +Reload configuration file and zones\&. +.RE +.PP \fBreload \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 - Reload the given zone\&. - .RE - .PP +Reload the given zone\&. +.RE +.PP \fBretransfer \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 - Retransfer the given slave zone from the master server\&. +Retransfer the given slave zone from the master server\&. .sp - If the zone is configured to use +If the zone is configured to use \fBinline\-signing\fR, the signed version of the zone is discarded; after the retransfer of the unsigned version is complete, the signed version will be regenerated with all new signatures\&. - .RE - .PP +.RE +.PP \fBscan\fR .RS 4 - Scan the list of available network interfaces for changes, without performing a full +Scan the list of available network interfaces for changes, without performing a full \fBreconfig\fR or waiting for the \fBinterface\-interval\fR timer\&. - .RE - .PP +.RE +.PP \fBsecroots \fR\fB[\-]\fR\fB \fR\fB[\fIview \&.\&.\&.\fR]\fR .RS 4 - Dump the server\*(Aqs security roots and negative trust anchors for the specified views\&. If no view is specified, all views are dumped\&. +Dump the server\*(Aqs security roots and negative trust anchors for the specified views\&. If no view is specified, all views are dumped\&. .sp - If the first argument is "\-", then the output is returned via the +If the first argument is "\-", then the output is returned via the \fBrndc\fR response channel and printed to the standard output\&. Otherwise, it is written to the secroots dump file, which defaults to named\&.secroots, but can be overridden via the @@ -457,53 +447,53 @@ named\&.secroots, but can be overridden via the option in named\&.conf\&. .sp - See also +See also \fBrndc managed\-keys\fR\&. - .RE - .PP +.RE +.PP \fBshowzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR .RS 4 - Print the configuration of a running zone\&. +Print the configuration of a running zone\&. .sp - See also +See also \fBrndc zonestatus\fR\&. - .RE - .PP +.RE +.PP \fBsign \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 - Fetch all DNSSEC keys for the given zone from the key directory (see the +Fetch all DNSSEC keys for the given zone from the key directory (see the \fBkey\-directory\fR option in the BIND 9 Administrator Reference Manual)\&. If they are within their publication period, merge them into the zone\*(Aqs DNSKEY RRset\&. If the DNSKEY RRset is changed, then the zone is automatically re\-signed with the new key set\&. .sp - This command requires that the +This command requires that the \fBauto\-dnssec\fR zone option be set to allow or maintain, and also requires the zone to be configured to allow dynamic DNS\&. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details\&.) .sp - See also +See also \fBrndc loadkeys\fR\&. - .RE - .PP +.RE +.PP \fBsigning \fR\fB[( \-list | \-clear \fIkeyid/algorithm\fR | \-clear all | \-nsec3param ( \fIparameters\fR | none ) | \-serial \fIvalue\fR ) ]\fR\fB \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR .RS 4 - List, edit, or remove the DNSSEC signing state records for the specified zone\&. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type +List, edit, or remove the DNSSEC signing state records for the specified zone\&. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type \fBsig\-signing\-type\fR\&. \fBrndc signing \-list\fR converts these records into a human\-readable form, indicating which keys are currently signing or have finished signing the zone, and which NSEC3 chains are being created or removed\&. .sp - \fBrndc signing \-clear\fR +\fBrndc signing \-clear\fR can remove a single key (specified in the same format that \fBrndc signing \-list\fR uses to display it), or all keys\&. In either case, only completed keys are removed; any record indicating that a key has not yet finished signing the zone will be retained\&. .sp - \fBrndc signing \-nsec3param\fR +\fBrndc signing \-nsec3param\fR sets the NSEC3 parameters for a zone\&. This is the only supported mechanism for using NSEC3 with \fBinline\-signing\fR zones\&. Parameters are specified in the same format as an NSEC3PARAM resource record: hash algorithm, flags, iterations, and salt, in that order\&. .sp - Currently, the only defined value for hash algorithm is +Currently, the only defined value for hash algorithm is 1, representing SHA\-1\&. The \fBflags\fR may be set to @@ -518,113 +508,113 @@ auto, which causes \fBnamed\fR to generate a random 64\-bit salt\&. .sp - 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: +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: \fBrndc signing \-nsec3param 1 0 10 FFFF \fR\fB\fIzone\fR\fR\&. To set the opt\-out flag, 15 iterations, and no salt, use: \fBrndc signing \-nsec3param 1 1 15 \- \fR\fB\fIzone\fR\fR\&. .sp - \fBrndc signing \-nsec3param none\fR +\fBrndc signing \-nsec3param none\fR removes an existing NSEC3 chain and replaces it with NSEC\&. .sp - \fBrndc signing \-serial value\fR +\fBrndc signing \-serial value\fR sets the serial number of the zone to value\&. If the value would cause the serial number to go backwards it will be rejected\&. The primary use is to set the serial on inline signed zones\&. - .RE - .PP +.RE +.PP \fBstats\fR .RS 4 - Write server statistics to the statistics file\&. (See the +Write server statistics to the statistics file\&. (See the \fBstatistics\-file\fR option in the BIND 9 Administrator Reference Manual\&.) - .RE - .PP +.RE +.PP \fBstatus\fR .RS 4 - Display status of the server\&. Note that the number of zones includes the internal +Display status of the server\&. Note that the number of zones includes the internal \fBbind/CH\fR zone and the default \fB\&./IN\fR hint zone if there is not an explicit root zone configured\&. - .RE - .PP +.RE +.PP \fBstop \fR\fB[\-p]\fR .RS 4 - 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\&. If +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\&. If \fB\-p\fR is specified \fBnamed\fR\*(Aqs process id is returned\&. This allows an external process to determine when \fBnamed\fR had completed stopping\&. .sp - See also +See also \fBrndc halt\fR\&. - .RE - .PP +.RE +.PP \fBsync \fR\fB[\-clean]\fR\fB \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fBthaw \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR .RS 4 - 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 from disk, and re\-enables dynamic updates after the load has completed\&. After a zone is thawed, dynamic updates will no longer be refused\&. If the zone has changed and the +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 from disk, and re\-enables dynamic updates after the load has completed\&. After a zone is thawed, dynamic updates will no longer be refused\&. If the zone has changed and the \fBixfr\-from\-differences\fR option is in use, then the journal file will be updated to reflect changes in the zone\&. Otherwise, if the zone has changed, any existing journal file will be removed\&. .sp - See also +See also \fBrndc freeze\fR\&. - .RE - .PP +.RE +.PP \fBtrace\fR .RS 4 - Increment the servers debugging level by one\&. - .RE - .PP +Increment the servers debugging level by one\&. +.RE +.PP \fBtrace \fR\fB\fIlevel\fR\fR .RS 4 - Sets the server\*(Aqs debugging level to an explicit value\&. +Sets the server\*(Aqs debugging level to an explicit value\&. .sp - See also +See also \fBrndc notrace\fR\&. - .RE - .PP +.RE +.PP \fBtsig\-delete\fR \fIkeyname\fR [\fIview\fR] .RS 4 - Delete a given TKEY\-negotiated key from the server\&. (This does not apply to statically configured TSIG keys\&.) - .RE - .PP +Delete a given TKEY\-negotiated key from the server\&. (This does not apply to statically configured TSIG keys\&.) +.RE +.PP \fBtsig\-list\fR .RS 4 - List the names of all TSIG keys currently configured for use by +List the names of all TSIG keys currently configured for use by \fBnamed\fR in each view\&. The list includes both statically configured keys and dynamic TKEY\-negotiated keys\&. - .RE - .PP +.RE +.PP \fBvalidation ( on | off | status ) \fR\fB[\fIview \&.\&.\&.\fR]\fR\fB \fR .RS 4 - Enable, disable, or check the current status of DNSSEC validation\&. Note +Enable, disable, or check the current status of DNSSEC validation\&. Note \fBdnssec\-enable\fR also needs to be set to \fByes\fR or \fBauto\fR to be effective\&. It defaults to enabled\&. - .RE - .PP +.RE +.PP \fBzonestatus \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 - 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 recently loaded, the current serial number, the number of nodes, whether the zone supports dynamic updates, whether the zone is DNSSEC signed, whether it uses automatic DNSSEC key management or inline signing, and the scheduled refresh or expiry times for the zone\&. +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 recently loaded, the current serial number, the number of nodes, whether the zone supports dynamic updates, whether the zone is DNSSEC signed, whether it uses automatic DNSSEC key management or inline signing, and the scheduled refresh or expiry times for the zone\&. .sp - See also +See also \fBrndc showzone\fR\&. - .RE - .SH "LIMITATIONS" - .PP +.RE +.SH "LIMITATIONS" +.PP There is currently no way to provide the shared secret for a \fBkey_id\fR without using the configuration file\&. - .PP +.PP Several error messages could be clearer\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBrndc.conf\fR(5), \fBrndc-confgen\fR(8), \fBnamed\fR(8), diff --git a/bin/rndc/rndc.conf.5 b/bin/rndc/rndc.conf.5 index 78fbe0c65d..65a89e564e 100644 --- a/bin/rndc/rndc.conf.5 +++ b/bin/rndc/rndc.conf.5 @@ -35,28 +35,28 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" rndc.conf \- rndc configuration file - .SH "SYNOPSIS" - .HP \w'\fBrndc\&.conf\fR\ 'u - \fBrndc\&.conf\fR - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBrndc\&.conf\fR\ 'u +\fBrndc\&.conf\fR +.SH "DESCRIPTION" +.PP rndc\&.conf is the configuration file for \fBrndc\fR, the BIND 9 name server control utility\&. This file has a similar structure and syntax to named\&.conf\&. 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: - .PP +.PP C style: /* */ - .PP +.PP C++ style: // to end of line - .PP +.PP Unix style: # to end of line - .PP +.PP rndc\&.conf is much simpler than named\&.conf\&. The file uses three statements: an options statement, a server statement and a key statement\&. - .PP +.PP The \fBoptions\fR statement contains five clauses\&. The @@ -85,7 +85,7 @@ statement, this default port will be used to connect\&. The and \fBdefault\-source\-address\-v6\fR clauses which can be used to set the IPv4 and IPv6 source addresses respectively\&. - .PP +.PP After the \fBserver\fR keyword, the server statement includes a string which is the hostname or address for a name server\&. The statement has three possible clauses: @@ -99,7 +99,7 @@ clause is supplied these addresses will be used instead of the server name\&. Ea or \fBsource\-address\-v6\fR of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively\&. - .PP +.PP The \fBkey\fR statement begins with an identifying string, the name of the key\&. The statement has two clauses\&. @@ -107,7 +107,7 @@ statement begins with an identifying string, the name of the key\&. The statemen identifies the authentication algorithm for \fBrndc\fR to use; currently only HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512 are supported\&. This is followed by a secret clause which contains the base\-64 encoding of the algorithm\*(Aqs authentication key\&. The base\-64 string is enclosed in double quotes\&. - .PP +.PP There are two common ways to generate the base\-64 string for the secret\&. The BIND 9 program \fBrndc\-confgen\fR can be used to generate a random key, or the @@ -116,8 +116,8 @@ program, also known as \fBmimencode\fR, can be used to generate a base\-64 string from known input\&. \fBmmencode\fR does not ship with BIND 9 but is available on many systems\&. See the EXAMPLE section for sample command lines for each\&. - .SH "EXAMPLE" - .PP +.SH "EXAMPLE" +.PP .if n \{\ .RS 4 .\} @@ -130,8 +130,7 @@ does not ship with BIND 9 but is available on many systems\&. See the EXAMPLE se .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -143,8 +142,7 @@ does not ship with BIND 9 but is available on many systems\&. See the EXAMPLE se .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -157,8 +155,7 @@ does not ship with BIND 9 but is available on many systems\&. See the EXAMPLE se .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -171,8 +168,7 @@ does not ship with BIND 9 but is available on many systems\&. See the EXAMPLE se .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -185,23 +181,22 @@ does not ship with BIND 9 but is available on many systems\&. See the EXAMPLE se .if n \{\ .RE .\} -.sp - .PP +.PP In the above example, \fBrndc\fR will by default use the server at localhost (127\&.0\&.0\&.1) and the key called samplekey\&. Commands to the localhost server will use the samplekey key, which must also be defined in the server\*(Aqs configuration file with the same name and secret\&. The key statement indicates that samplekey uses the HMAC\-SHA256 algorithm and its secret clause contains the base\-64 encoding of the HMAC\-SHA256 secret enclosed in double quotes\&. - .PP +.PP If \fBrndc \-s testserver\fR is used then \fBrndc\fR will connect to server on localhost port 5353 using the key testkey\&. - .PP +.PP To generate a random secret with \fBrndc\-confgen\fR: - .PP +.PP \fBrndc\-confgen\fR - .PP +.PP A complete rndc\&.conf file, including the randomly generated key, will be written to the standard output\&. Commented\-out @@ -211,21 +206,21 @@ and statements for named\&.conf are also printed\&. - .PP +.PP To generate a base\-64 secret with \fBmmencode\fR: - .PP +.PP \fBecho "known plaintext for a secret" | mmencode\fR - .SH "NAME SERVER CONFIGURATION" - .PP +.SH "NAME SERVER CONFIGURATION" +.PP 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 \fBcontrols\fR statement in the BIND 9 Administrator Reference Manual for details\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBrndc\fR(8), \fBrndc-confgen\fR(8), \fBmmencode\fR(1), diff --git a/bin/rndc/rndc.conf.html b/bin/rndc/rndc.conf.html index 0961ea7592..78f9598a65 100644 --- a/bin/rndc/rndc.conf.html +++ b/bin/rndc/rndc.conf.html @@ -14,32 +14,17 @@
- - - - - -
+

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 @@ -47,21 +32,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 @@ -84,7 +69,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: @@ -98,7 +83,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 @@ -109,7 +94,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 @@ -122,13 +107,10 @@ 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;
@@ -136,14 +118,14 @@
 

 

     

-    
+
       server localhost {
         key             samplekey;
       };
 

 

     

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

 

     

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

 

     

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

 

     

-
-    

+

       In the above example, rndc will by
       default use
       the server at localhost (127.0.0.1) and the key called samplekey.
@@ -178,16 +159,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
@@ -195,40 +176,29 @@
       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 bdb19fe659..2a05302fb1 100644 --- a/bin/rndc/rndc.html +++ b/bin/rndc/rndc.html @@ -14,42 +14,17 @@
- - - - - -
+

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] - [-r] - [-V] - [-y key_id] - {command} -

-
- -
+

rndc [-b source-address] [-c config-file] [-k key-file] [-s server] [-p port] [-q] [-r] [-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 @@ -58,7 +33,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 @@ -72,38 +47,30 @@ 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 @@ -111,52 +78,40 @@ 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. -

-
+

-r
-
-

+

Instructs rndc to print the result code returned by named after executing the requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc). -

-
+

-V
-
-

+

Enable verbose logging. -

-
+

-y key_id
-
-

+

Use the key key_id from the configuration file. key_id @@ -172,26 +127,22 @@ 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 @@ -201,7 +152,7 @@ configuration text that would ordinarily be placed in named.conf.

-

+

The configuration is saved in a file called name.nzf, where name is the @@ -214,28 +165,28 @@ 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 and rndc modzone.

-
+
delzone [-clean] zone [class [view]]
-

+

Delete a zone while the server is running.

-

+

If the -clean argument is specified, the zone's master file (and journal file, if any) will be deleted along with the zone. Without the @@ -245,7 +196,7 @@ be cleaned up will be reported in the output of the rndc delzone command.)

-

+

If the zone was originally added via rndc addzone, then it will be removed permanently. However, if it was originally @@ -255,13 +206,12 @@ come back. To remove it permanently, it must also be removed from named.conf

-

+

See also rndc addzone and rndc modzone.

-
+
dnstap ( -reopen | -roll [number] )
-
-

+

Close and re-open DNSTAP output files. rndc dnstap -reopen allows the output file to be renamed externally, so @@ -272,43 +222,34 @@ previous most recent output file is moved to ".1", and so on. If number is specified, then the number of backup log files is limited to that number. -

-
+

dumpdb [-all|-cache|-zones|-adb|-bad|-fail] [view ...]
-
-

+

Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is specified, all 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 view's DNS cache and, if applicable, from the view's nameserver address database, bad server cache and SERVFAIL cache. -

-
+

flushtree name [view]
-
-

+

Flushes the given name, and all of its subdomains, from the view's DNS cache, address database, bad server cache, and SERVFAIL 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 @@ -317,13 +258,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 @@ -332,13 +273,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 @@ -347,7 +288,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, @@ -356,10 +297,9 @@ (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)

-
+
managed-keys (status | refresh | sync) [class [view]]
-
-

+

When run with the "status" keyword, print the current status of the managed-keys database for the specified view, or for all views if none is specified. When run @@ -369,11 +309,10 @@ immediate dump of the managed-keys database to disk (in the file managed-keys.bind or (viewname.mkeys). -

-
+

modzone zone [class [view]] configuration
-

+

Modify the configuration of a zone while the server is running. This command requires the allow-new-zones option to be @@ -384,7 +323,7 @@ configuration text that would ordinarily be placed in named.conf.

-

+

If the zone was originally added via rndc addzone, the configuration changes will be recorded permanently and will still be @@ -397,32 +336,30 @@ permanent, it must also be modified in named.conf

-

+

See also rndc addzone and rndc delzone.

-
+
notify zone [class [view]]
-
-

+

Resend NOTIFY messages for the zone. -

-
+

notrace
-

+

Sets the server's debugging level to 0.

-

+

See also rndc trace.

-
+
nta [( -class class | -dump | -force | -remove | -lifetime duration)] domain [view]
-

+

Sets a DNSSEC negative trust anchor (NTA) for domain, with a lifetime of duration. The default lifetime is @@ -430,7 +367,7 @@ nta-lifetime option, and defaults to one hour. The lifetime cannot exceed one week.

-

+

A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration rather than @@ -441,7 +378,7 @@ insecure rather than bogus. This continues until the NTA's lifetime is elapsed.

-

+

NTAs persist across restarts of the named server. The NTAs for a view are saved in a file called name.nta, @@ -451,11 +388,11 @@ cryptographic hash generated from the name of the view.

-

+

An existing NTA can be removed by using the -remove option.

-

+

An NTA's lifetime can be specified with the -lifetime option. TTL-style suffixes can be used to specify the lifetime in @@ -464,13 +401,13 @@ new value. Setting lifetime to zero is equivalent to -remove.

-

+

If the -dump is used, any other arguments are ignored, and a list of existing NTAs is printed (note that this may include NTAs that are expired but have not yet been cleaned up).

-

+

Normally, named will periodically test to see whether data below an NTA can now be validated (see the nta-recheck option @@ -482,25 +419,25 @@ lifetime, regardless of whether data could be validated if the NTA were not present.

-

+

The view class can be specified with -class. The default is class IN, which is the only class for which DNSSEC is currently supported.

-

+

All of these options can be shortened, i.e., to -l, -r, -d, -f, and -c.

-
+
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 @@ -511,10 +448,9 @@ 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. @@ -522,43 +458,34 @@ 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 @@ -566,24 +493,22 @@ 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 and negative trust anchors for the specified views. If no view is specified, all views are dumped.

-

+

If the first argument is "-", then the output is returned via the rndc response channel and printed to the standard output. @@ -592,22 +517,22 @@ overridden via the secroots-file option in named.conf.

-

+

See also rndc managed-keys.

-
+
showzone zone [class [view]]
-

+

Print the configuration of a running zone.

-

+

See also rndc zonestatus.

-
+
sign zone [class [view]]
-

+

Fetch all DNSSEC keys for the given zone from the key directory (see the key-directory option in @@ -617,7 +542,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 @@ -627,13 +552,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 ) | -serial value ) ] 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 @@ -646,7 +571,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 @@ -655,7 +580,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 @@ -664,7 +589,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 @@ -679,7 +604,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: @@ -688,40 +613,36 @@ salt, use: rndc signing -nsec3param 1 1 15 - zone.

-

+

rndc signing -nsec3param none removes an existing NSEC3 chain and replaces it with NSEC.

-

+

rndc signing -serial value sets the serial number of the zone to value. If the value would cause the serial number to go backwards it will be rejected. The primary use is to set the serial on inline signed zones.

-
+
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. @@ -729,20 +650,18 @@ 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 @@ -756,55 +675,47 @@ 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 includes both statically configured keys and dynamic TKEY-negotiated keys. -

-
+

validation ( on | off | status ) [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 @@ -815,46 +726,31 @@ management or inline signing, and the scheduled refresh or expiry times for the zone.

-

+

See also rndc showzone.

-
+
-
- -
+
+

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.1 b/bin/tools/arpaname.1 index 0b9c2d335b..98efa5decb 100644 --- a/bin/tools/arpaname.1 +++ b/bin/tools/arpaname.1 @@ -35,18 +35,17 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" arpaname \- translate IP addresses to the corresponding ARPA names - .SH "SYNOPSIS" - .HP \w'\fBarpaname\fR\ 'u - \fBarpaname\fR - {\fIipaddress\ \fR...} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBarpaname\fR\ 'u +\fBarpaname\fR {\fIipaddress\ \fR...} +.SH "DESCRIPTION" +.PP \fBarpaname\fR translates IP addresses (IPv4 and IPv6) to the corresponding IN\-ADDR\&.ARPA or IP6\&.ARPA names\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP diff --git a/bin/tools/arpaname.html b/bin/tools/arpaname.html index 4b21356622..0769773d15 100644 --- a/bin/tools/arpaname.html +++ b/bin/tools/arpaname.html @@ -14,44 +14,26 @@
- - - - -
+

Name

-

- arpaname - — translate IP addresses to the corresponding ARPA names -

+

arpaname — translate IP addresses to the corresponding ARPA names

- - - -
+

Synopsis

-

- arpaname - {ipaddress ...} -

-
- -
+

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/dnstap-read.1 b/bin/tools/dnstap-read.1 index 0ecb5849c5..d722d8aaa6 100644 --- a/bin/tools/dnstap-read.1 +++ b/bin/tools/dnstap-read.1 @@ -35,17 +35,13 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" dnstap-read \- print dnstap data in human\-readable form - .SH "SYNOPSIS" - .HP \w'\fBdnstap\-read\fR\ 'u - \fBdnstap\-read\fR - [\fB\-m\fR] - [\fB\-p\fR] - [\fB\-y\fR] - {\fIfile\fR} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBdnstap\-read\fR\ 'u +\fBdnstap\-read\fR [\fB\-m\fR] [\fB\-p\fR] [\fB\-y\fR] {\fIfile\fR} +.SH "DESCRIPTION" +.PP \fBdnstap\-read\fR reads \fBdnstap\fR @@ -54,30 +50,30 @@ data from a specified file and prints it in a human\-readable format\&. By defau data is printed in a short summary format, but if the \fB\-y\fR option is specified, then a longer and more detailed YAML format is used instead\&. - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-m .RS 4 - Trace memory allocations; used for debugging memory leaks\&. - .RE - .PP +Trace memory allocations; used for debugging memory leaks\&. +.RE +.PP \-p .RS 4 - After printing the +After printing the \fBdnstap\fR data, print the text form of the DNS message that was encapsulated in the \fBdnstap\fR frame\&. - .RE - .PP +.RE +.PP \-y .RS 4 - Print +Print \fBdnstap\fR data in a detailed YAML format\&. - .RE - .SH "SEE ALSO" - .PP +.RE +.SH "SEE ALSO" +.PP \fBnamed\fR(8), \fBrndc\fR(8), BIND 9 Administrator Reference Manual\&. diff --git a/bin/tools/dnstap-read.html b/bin/tools/dnstap-read.html index 4cb1d71c48..378fcb93c1 100644 --- a/bin/tools/dnstap-read.html +++ b/bin/tools/dnstap-read.html @@ -14,36 +14,17 @@
- - - - - -
+

Name

-

- dnstap-read - — print dnstap data in human-readable form -

+

dnstap-read — print dnstap data in human-readable form

- - - -
+

Synopsis

-

- dnstap-read - [-m] - [-p] - [-y] - {file} -

-
- -
+

dnstap-read [-m] [-p] [-y] {file}

+
+

DESCRIPTION

- -

+

dnstap-read reads dnstap data from a specified file and prints it in a human-readable format. By default, @@ -51,50 +32,34 @@ format, but if the -y option is specified, then a longer and more detailed YAML format is used instead.

-
- -
+
+

OPTIONS

- - -
+
-m
-
-

+

Trace memory allocations; used for debugging memory leaks. -

-
+

-p
-
-

+

After printing the dnstap data, print the text form of the DNS message that was encapsulated in the dnstap frame. -

-
+

-y
-
-

+

Print dnstap data in a detailed YAML format. -

-
+

-
- -
+
+

SEE ALSO

- -

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

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

-
- +
diff --git a/bin/tools/genrandom.8 b/bin/tools/genrandom.8 index f7a4cb3bf2..c520322215 100644 --- a/bin/tools/genrandom.8 +++ b/bin/tools/genrandom.8 @@ -35,40 +35,37 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" genrandom \- generate a file containing random data - .SH "SYNOPSIS" - .HP \w'\fBgenrandom\fR\ 'u - \fBgenrandom\fR - [\fB\-n\ \fR\fB\fInumber\fR\fR] - {\fIsize\fR} - {\fIfilename\fR} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBgenrandom\fR\ 'u +\fBgenrandom\fR [\fB\-n\ \fR\fB\fInumber\fR\fR] {\fIsize\fR} {\fIfilename\fR} +.SH "DESCRIPTION" +.PP \fBgenrandom\fR 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\&. - .SH "ARGUMENTS" - .PP +.SH "ARGUMENTS" +.PP \-n \fInumber\fR .RS 4 - In place of generating one file, generates +In place of generating one file, generates \fBnumber\fR (from 2 to 9) files, appending \fBnumber\fR to the name\&. - .RE - .PP +.RE +.PP size .RS 4 - The size of the file, in kilobytes, to generate\&. - .RE - .PP +The size of the file, in kilobytes, to generate\&. +.RE +.PP filename .RS 4 - The file name into which random data should be written\&. - .RE - .SH "SEE ALSO" - .PP +The file name into which random data should be written\&. +.RE +.SH "SEE ALSO" +.PP \fBrand\fR(3), \fBarc4random\fR(3) .SH "AUTHOR" diff --git a/bin/tools/genrandom.html b/bin/tools/genrandom.html index 5976ce5f63..ea0276680c 100644 --- a/bin/tools/genrandom.html +++ b/bin/tools/genrandom.html @@ -14,80 +14,47 @@
- - - - - -
+

Name

-

- genrandom - — generate a file containing random data -

+

genrandom — generate a file containing random data

- - - -
+

Synopsis

-

- genrandom - [-n number] - {size} - {filename} -

-
- -
+

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.8 b/bin/tools/isc-hmac-fixup.8 index 5e79d9e056..1ca3b776e4 100644 --- a/bin/tools/isc-hmac-fixup.8 +++ b/bin/tools/isc-hmac-fixup.8 @@ -35,31 +35,29 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" isc-hmac-fixup \- fixes HMAC keys generated by older versions of BIND - .SH "SYNOPSIS" - .HP \w'\fBisc\-hmac\-fixup\fR\ 'u - \fBisc\-hmac\-fixup\fR - {\fIalgorithm\fR} - {\fIsecret\fR} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBisc\-hmac\-fixup\fR\ 'u +\fBisc\-hmac\-fixup\fR {\fIalgorithm\fR} {\fIsecret\fR} +.SH "DESCRIPTION" +.PP 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 longer than 256 bits, etc) to be used incorrectly, generating a message authentication code that was incompatible with other DNS implementations\&. - .PP +.PP This bug was fixed in BIND 9\&.7\&. However, the fix may cause incompatibility between older and newer versions of BIND, when using long keys\&. \fBisc\-hmac\-fixup\fR modifies those keys to restore compatibility\&. - .PP +.PP To modify a key, run \fBisc\-hmac\-fixup\fR and specify the key\*(Aqs algorithm and secret on the command line\&. If the secret is longer than the digest length of the algorithm (64 bytes for SHA1 through SHA256, or 128 bytes for SHA384 and SHA512), then a new secret will be generated consisting of a hash digest of the old secret\&. (If the secret did not require conversion, then it will be printed without modification\&.) - .SH "SECURITY CONSIDERATIONS" - .PP +.SH "SECURITY CONSIDERATIONS" +.PP Secrets that have been converted by \fBisc\-hmac\-fixup\fR are shortened, but as this is how the HMAC protocol works in operation anyway, it does not affect security\&. RFC 2104 notes, "Keys longer than [the digest length] are acceptable but the extra length would not significantly increase the function strength\&." - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP BIND 9 Administrator Reference Manual, RFC 2104\&. .SH "AUTHOR" diff --git a/bin/tools/isc-hmac-fixup.html b/bin/tools/isc-hmac-fixup.html index 951fbc52fa..f60895e4e2 100644 --- a/bin/tools/isc-hmac-fixup.html +++ b/bin/tools/isc-hmac-fixup.html @@ -14,34 +14,17 @@
- - - - - -
+

Name

-

- isc-hmac-fixup - — fixes HMAC keys generated by older versions of BIND -

+

isc-hmac-fixup — fixes HMAC keys generated by older versions of BIND

- - - -
+

Synopsis

-

- isc-hmac-fixup - {algorithm} - {secret} -

-
- -
+

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 @@ -49,13 +32,13 @@ message authentication code that was incompatible with other DNS implementations.

-

+

This bug was 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 @@ -64,12 +47,10 @@ 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, @@ -77,16 +58,13 @@ extra length would not significantly increase the function strength."

-
- -
+
+

SEE ALSO

- -

+

BIND 9 Administrator Reference Manual, RFC 2104.

-
- +
diff --git a/bin/tools/mdig.1 b/bin/tools/mdig.1 index 9dfc35e79d..ab87ce76ed 100644 --- a/bin/tools/mdig.1 +++ b/bin/tools/mdig.1 @@ -35,46 +35,26 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" mdig \- DNS pipelined lookup utility - .SH "SYNOPSIS" - .HP \w'\fBmdig\fR\ 'u - \fBmdig\fR - {@server} - [\fB\-f\ \fR\fB\fIfilename\fR\fR] - [\fB\-h\fR] - [\fB\-v\fR] - [ - | [\fB\-4\fR] - | [\fB\-6\fR] - ] - [\fB\-m\fR] - [\fB\-b\ \fR\fB\fIaddress\fR\fR] - [\fB\-p\ \fR\fB\fIport#\fR\fR] - [\fB\-c\ \fR\fB\fIclass\fR\fR] - [\fB\-t\ \fR\fB\fItype\fR\fR] - [\fB\-i\fR] - [\fB\-x\ \fR\fB\fIaddr\fR\fR] - [plusopt...] - .HP \w'\fBmdig\fR\ 'u - \fBmdig\fR - {\-h} - .HP \w'\fBmdig\fR\ 'u - \fBmdig\fR - [@server] - {global\-opt...} - {{local\-opt...}\ {query}...} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBmdig\fR\ 'u +\fBmdig\fR {@server} [\fB\-f\ \fR\fB\fIfilename\fR\fR] [\fB\-h\fR] [\fB\-v\fR] [[\fB\-4\fR] | [\fB\-6\fR]] [\fB\-m\fR] [\fB\-b\ \fR\fB\fIaddress\fR\fR] [\fB\-p\ \fR\fB\fIport#\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-i\fR] [\fB\-x\ \fR\fB\fIaddr\fR\fR] [plusopt...] +.HP \w'\fBmdig\fR\ 'u +\fBmdig\fR {\-h} +.HP \w'\fBmdig\fR\ 'u +\fBmdig\fR [@server] {global\-opt...} {{local\-opt...}\ {query}...} +.SH "DESCRIPTION" +.PP \fBmdig\fR is a multiple/pipelined query version of \fBdig\fR: instead of waiting for a response after sending each query, it begins by sending all queries\&. Responses are displayed in the order in which they are received, not in the order the corresponding queries were sent\&. - .PP +.PP \fBmdig\fR options are a subset of the \fBdig\fR options, and are divided into "anywhere options" which can occur anywhere, "global options" which must occur before the query name (or they are ignored with a warning), and "local options" which apply to the next query on the command line\&. - .PP +.PP The {@server} option is a mandatory global option\&. It is the name or IP address of the name server to query\&. (Unlike @@ -84,16 +64,16 @@ option is a mandatory global option\&. It is the name or IP address of the name argument is a hostname, \fBmdig\fR resolves that name before querying the name server\&. - .PP +.PP \fBmdig\fR 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\&. - .PP +.PP 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 no to negate the meaning of that keyword\&. Other keywords assign values to options like the timeout interval\&. They have the form \fB+keyword=value\fR\&. - .SH "ANYWHERE OPTIONS" - .PP +.SH "ANYWHERE OPTIONS" +.PP The \fB\-f\fR option makes @@ -102,41 +82,41 @@ operate in batch mode by reading a list of lookup requests to process from the f \fIfilename\fR\&. The file contains a number of queries, one per line\&. Each entry in the file should be organized in the same way they would be presented as queries to \fBmdig\fR using the command\-line interface\&. - .PP +.PP The \fB\-h\fR causes \fBmdig\fR to print the detailed help with the full list of options and exit\&. - .PP +.PP The \fB\-v\fR causes \fBmdig\fR to print the version number and exit\&. - .SH "GLOBAL OPTIONS" - .PP +.SH "GLOBAL OPTIONS" +.PP The \fB\-4\fR option forces \fBmdig\fR to only use IPv4 query transport\&. - .PP +.PP The \fB\-6\fR option forces \fBmdig\fR to only use IPv6 query transport\&. - .PP +.PP The \fB\-b\fR option sets the source IP address of the query to \fIaddress\fR\&. This must be a valid address on one of the host\*(Aqs network interfaces or "0\&.0\&.0\&.0" or "::"\&. An optional port may be specified by appending "#" - .PP +.PP The \fB\-m\fR option enables memory usage debugging\&. - .PP +.PP The \fB\-p\fR option is used when a non\-standard port number is to be queried\&. @@ -144,89 +124,89 @@ option is used when a non\-standard port number is to be queried\&. is the port number that \fBmdig\fR will send its queries instead of the standard DNS port number 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\&. - .PP +.PP The global query options are: - .PP +.PP \fB+[no]additional\fR .RS 4 - Display [do not display] the additional section of a reply\&. The default is to display it\&. - .RE - .PP +Display [do not display] the additional section of a reply\&. The default is to display it\&. +.RE +.PP \fB+[no]all\fR .RS 4 - Set or clear all display flags\&. - .RE - .PP +Set or clear all display flags\&. +.RE +.PP \fB+[no]answer\fR .RS 4 - Display [do not display] the answer section of a reply\&. The default is to display it\&. - .RE - .PP +Display [do not display] the answer section of a reply\&. The default is to display it\&. +.RE +.PP \fB+[no]authority\fR .RS 4 - Display [do not display] the authority section of a reply\&. The default is to display it\&. - .RE - .PP +Display [do not display] the authority section of a reply\&. The default is to display it\&. +.RE +.PP \fB+[no]besteffort\fR .RS 4 - Attempt to display the contents of messages which are malformed\&. The default is to not display malformed answers\&. - .RE - .PP +Attempt to display the contents of messages which are malformed\&. The default is to not display malformed answers\&. +.RE +.PP \fB+burst\fR .RS 4 - This option delays queries until the start of the next second\&. - .RE - .PP +This option delays queries until the start of the next second\&. +.RE +.PP \fB+[no]cl\fR .RS 4 - Display [do not display] the CLASS when printing the record\&. - .RE - .PP +Display [do not display] the CLASS when printing the record\&. +.RE +.PP \fB+[no]comments\fR .RS 4 - Toggle the display of comment lines in the output\&. The default is to print comments\&. - .RE - .PP +Toggle the display of comment lines in the output\&. The default is to print comments\&. +.RE +.PP \fB+[no]continue\fR .RS 4 - Continue on errors (e\&.g\&. timeouts)\&. - .RE - .PP +Continue on errors (e\&.g\&. timeouts)\&. +.RE +.PP \fB+[no]crypto\fR .RS 4 - 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 the common failures\&. The default is to display the fields\&. 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 ]"\&. - .RE - .PP +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 the common failures\&. The default is to display the fields\&. 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 ]"\&. +.RE +.PP \fB+dscp[=value]\fR .RS 4 - Set the DSCP code point to be used when sending the query\&. Valid DSCP code points are in the range [0\&.\&.63]\&. By default no code point is explicitly set\&. - .RE - .PP +Set the DSCP code point to be used when sending the query\&. Valid DSCP code points are in the range [0\&.\&.63]\&. By default no code point is explicitly set\&. +.RE +.PP \fB+[no]multiline\fR .RS 4 - 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 +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 \fBmdig\fR output\&. - .RE - .PP +.RE +.PP \fB+[no]question\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fB+[no]rrcomments\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fB+[no]short\fR .RS 4 - Provide a terse answer\&. The default is to print the answer in a verbose form\&. - .RE - .PP +Provide a terse answer\&. The default is to print the answer in a verbose form\&. +.RE +.PP \fB+split=W\fR .RS 4 - Split long hex\- or base64\-formatted fields in resource records into chunks of +Split long hex\- or base64\-formatted fields in resource records into chunks of \fIW\fR characters (where \fIW\fR @@ -235,47 +215,47 @@ is rounded up to the nearest multiple of 4)\&. or \fI+split=0\fR causes fields not to be split at all\&. The default is 56 characters, or 44 characters when multiline mode is active\&. - .RE - .PP +.RE +.PP \fB+[no]tcp\fR .RS 4 - Use [do not use] TCP when querying name servers\&. The default behavior is to use UDP\&. - .RE - .PP +Use [do not use] TCP when querying name servers\&. The default behavior is to use UDP\&. +.RE +.PP \fB+[no]ttlid\fR .RS 4 - Display [do not display] the TTL when printing the record\&. - .RE - .PP +Display [do not display] the TTL when printing the record\&. +.RE +.PP \fB+[no]ttlunits\fR .RS 4 - Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks\&. Implies +ttlid\&. - .RE - .PP +Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks\&. Implies +ttlid\&. +.RE +.PP \fB+[no]vc\fR .RS 4 - Use [do not use] TCP when querying name servers\&. This alternate syntax to +Use [do not use] TCP when querying name servers\&. This alternate syntax to \fI+[no]tcp\fR is provided for backwards compatibility\&. The "vc" stands for "virtual circuit"\&. - .RE - .SH "LOCAL OPTIONS" - .PP +.RE +.SH "LOCAL OPTIONS" +.PP The \fB\-c\fR option sets the query class to \fIclass\fR\&. It can be any valid query class which is supported in BIND 9\&. The default query class is "IN"\&. - .PP +.PP The \fB\-t\fR option sets the query type to \fItype\fR\&. It can be any valid query type which is supported in BIND 9\&. The default query type is "A", unless the \fB\-x\fR option is supplied to indicate a reverse lookup with the "PTR" query type\&. - .PP +.PP The \fB\-i\fR option sets the reverse domain for IPv6 addresses to IP6\&.INT\&. - .PP +.PP Reverse lookups \(em mapping addresses to names \(em are simplified by the \fB\-x\fR option\&. @@ -287,141 +267,141 @@ automatically performs a lookup for a query name like and sets the query type and class to PTR and IN respectively\&. By default, IPv6 addresses are looked up using nibble format under the IP6\&.ARPA domain\&. To use the older RFC1886 method using the IP6\&.INT domain specify the \fB\-i\fR option\&. - .PP +.PP The local query options are: - .PP +.PP \fB+[no]aaflag\fR .RS 4 - A synonym for +A synonym for \fI+[no]aaonly\fR\&. - .RE - .PP +.RE +.PP \fB+[no]aaonly\fR .RS 4 - Sets the "aa" flag in the query\&. - .RE - .PP +Sets the "aa" flag in the query\&. +.RE +.PP \fB+[no]adflag\fR .RS 4 - 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 been validated as secure according to the security policy of the server\&. AD=1 indicates that all records have been validated as secure and the answer is not 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\&. - .RE - .PP +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 been validated as secure according to the security policy of the server\&. AD=1 indicates that all records have been validated as secure and the answer is not 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\&. +.RE +.PP \fB+bufsize=B\fR .RS 4 - Set the UDP message buffer size advertised using EDNS0 to +Set the UDP message buffer size advertised using EDNS0 to \fIB\fR 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\&. - .RE - .PP +.RE +.PP \fB+[no]cdflag\fR .RS 4 - Set [do not set] the CD (checking disabled) bit in the query\&. This requests the server to not perform DNSSEC validation of responses\&. - .RE - .PP +Set [do not set] the CD (checking disabled) bit in the query\&. This requests the server to not perform DNSSEC validation of responses\&. +.RE +.PP \fB+[no]cookie\fR\fB[=####]\fR .RS 4 - Send a COOKIE EDNS option, with optional value\&. Replaying a COOKIE from a previous response will allow the server to identify a previous client\&. The default is +Send a COOKIE EDNS option, with optional value\&. Replaying a COOKIE from a previous response will allow the server to identify a previous client\&. The default is \fB+nocookie\fR\&. - .RE - .PP +.RE +.PP \fB+[no]dnssec\fR .RS 4 - Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query\&. - .RE - .PP +Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query\&. +.RE +.PP \fB+[no]edns[=#]\fR .RS 4 - 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\&. +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\&. \fB+noedns\fR clears the remembered EDNS version\&. EDNS is set to 0 by default\&. - .RE - .PP +.RE +.PP \fB+[no]ednsflags[=#]\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fB+[no]ednsopt[=code[:value]]\fR .RS 4 - Specify EDNS option with code point +Specify EDNS option with code point \fBcode\fR and optionally payload of \fBvalue\fR as a hexadecimal string\&. \fB+noednsopt\fR clears the EDNS options to be sent\&. - .RE - .PP +.RE +.PP \fB+[no]expire\fR .RS 4 - Send an EDNS Expire option\&. - .RE - .PP +Send an EDNS Expire option\&. +.RE +.PP \fB+[no]nsid\fR .RS 4 - Include an EDNS name server ID request when sending a query\&. - .RE - .PP +Include an EDNS name server ID request when sending a query\&. +.RE +.PP \fB+[no]recurse\fR .RS 4 - Toggle the setting of the RD (recursion desired) bit in the query\&. This bit is set by default, which means +Toggle the setting of the RD (recursion desired) bit in the query\&. This bit is set by default, which means \fBmdig\fR normally sends recursive queries\&. - .RE - .PP +.RE +.PP \fB+retry=T\fR .RS 4 - Sets the number of times to retry UDP queries to server to +Sets the number of times to retry UDP queries to server to \fIT\fR instead of the default, 2\&. Unlike \fI+tries\fR, this does not include the initial query\&. - .RE - .PP +.RE +.PP \fB+[no]subnet=addr[/prefix\-length]\fR .RS 4 - Send (don\*(Aqt send) an EDNS Client Subnet option with the specified IP address or network prefix\&. +Send (don\*(Aqt send) an EDNS Client Subnet option with the specified IP address or network prefix\&. .sp - \fBmdig +subnet=0\&.0\&.0\&.0/0\fR, or simply +\fBmdig +subnet=0\&.0\&.0\&.0/0\fR, or simply \fBmdig +subnet=0\fR for short, sends an EDNS client\-subnet option with an empty address and a source prefix\-length of zero, which signals a resolver that the client\*(Aqs address information must \fInot\fR be used when resolving this query\&. - .RE - .PP +.RE +.PP \fB+timeout=T\fR .RS 4 - Sets the timeout for a query to +Sets the timeout for a query to \fIT\fR seconds\&. The default timeout is 5 seconds for UDP transport and 10 for TCP\&. An attempt to set \fIT\fR to less than 1 will result in a query timeout of 1 second being applied\&. - .RE - .PP +.RE +.PP \fB+tries=T\fR .RS 4 - Sets the number of times to try UDP queries to server to +Sets the number of times to try UDP queries to server to \fIT\fR instead of the default, 3\&. If \fIT\fR is less than or equal to zero, the number of tries is silently rounded up to 1\&. - .RE - .PP +.RE +.PP \fB+udptimeout=T\fR .RS 4 - Sets the timeout between UDP query retries\&. - .RE - .PP +Sets the timeout between UDP query retries\&. +.RE +.PP \fB+[no]unknownformat\fR .RS 4 - Print all RDATA in unknown RR type presentation format (RFC 3597)\&. The default is to print RDATA for known types in the type\*(Aqs presentation format\&. - .RE - .PP +Print all RDATA in unknown RR type presentation format (RFC 3597)\&. The default is to print RDATA for known types in the type\*(Aqs presentation format\&. +.RE +.PP \fB+[no]zflag\fR .RS 4 - Set [do not set] the last unassigned DNS header flag in a DNS query\&. This flag is off by default\&. - .RE - .SH "SEE ALSO" - .PP +Set [do not set] the last unassigned DNS header flag in a DNS query\&. This flag is off by default\&. +.RE +.SH "SEE ALSO" +.PP \fBdig\fR(1), RFC1035\&. .SH "AUTHOR" diff --git a/bin/tools/mdig.docbook b/bin/tools/mdig.docbook index d59cfe3ff8..90f5b8d61a 100644 --- a/bin/tools/mdig.docbook +++ b/bin/tools/mdig.docbook @@ -243,7 +243,9 @@ - This option delays queries until the start of the next second. + + This option delays queries until the start of the next second. + diff --git a/bin/tools/mdig.html b/bin/tools/mdig.html index f52599be0b..72bf28c069 100644 --- a/bin/tools/mdig.html +++ b/bin/tools/mdig.html @@ -14,69 +14,29 @@
- - - -
+

Name

-

- mdig - — DNS pipelined lookup utility -

+

mdig — DNS pipelined lookup utility

- - - -
+

Synopsis

-

- mdig - {@server} - [-f filename] - [-h] - [-v] - [ - [-4] - | [-6] - ] - [-m] - [-b address] - [-p port#] - [-c class] - [-t type] - [-i] - [-x addr] - [plusopt...] -

- -

- mdig - {-h} -

- -

- mdig - [@server] - {global-opt...} - { +

mdig {@server} [-f filename] [-h] [-v] [[-4] | [-6]] [-m] [-b address] [-p port#] [-c class] [-t type] [-i] [-x addr] [plusopt...]

+

mdig {-h}

+

mdig [@server] {global-opt...} { {local-opt...} {query} - ...} -

-
- -
+ ...}

+
+

DESCRIPTION

- -

mdig +

mdig is a multiple/pipelined query version of dig: instead of waiting for a response after sending each query, it begins by sending all queries. Responses are displayed in the order in which they are received, not in the order the corresponding queries were sent.

- -

+

mdig options are a subset of the dig options, and are divided into "anywhere options" which can occur anywhere, "global options" which must @@ -84,8 +44,7 @@ and "local options" which apply to the next query on the command line.

- -

+

The {@server} option is a mandatory global option. It is the name or IP address of the name server to query. (Unlike dig, this value is not retrieved from @@ -96,16 +55,14 @@ mdig resolves that name before querying the name server.

- -

mdig +

mdig 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 by the string no @@ -113,13 +70,10 @@ values to options like the timeout interval. They have the form +keyword=value.

-
- -
+
+

ANYWHERE OPTIONS

- - -

+

The -f option makes mdig operate in batch mode by reading a list of lookup requests to process from the file filename. The file @@ -127,45 +81,36 @@ file should be organized in the same way they would be presented as queries to mdig using the command-line interface.

- -

+

The -h causes mdig to print the detailed help with the full list of options and exit.

- -

+

The -v causes mdig to print the version number and exit.

-
- -
+
+

GLOBAL OPTIONS

- - -

+

The -4 option forces mdig to only use IPv4 query transport.

- -

+

The -6 option forces mdig to only use IPv6 query transport.

- -

+

The -b option 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 port may be specified by appending "#<port>"

- -

+

The -m option enables memory usage debugging.

- -

+

The -p option is used when a non-standard port number is to be queried. port# is the port number @@ -174,73 +119,55 @@ test a name server that has been configured to listen for queries on a non-standard port number.

- -

+

The global query options are:

+[no]additional
-
-

+

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

-
+

+[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. -

-
+

+burst
-
- This option delays queries until the start of the next second. -
+

+ This option delays queries until the start of the next second. +

+[no]cl
-
-

+

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

-
+

+[no]comments
-
-

+

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

-
+

+[no]continue
-
-

+

Continue on errors (e.g. timeouts). -

-
+

+[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 @@ -249,53 +176,41 @@ are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]". -

-
+

+dscp[=value]
-
-

+

Set the DSCP code point to be used when sending the query. Valid DSCP code points are in the range [0..63]. By default no code point is explicitly set. -

-
+

+[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 mdig output. -

-
+

+[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]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]short
-
-

+

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

-
+

+split=W
-
-

+

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

-
+

+[no]tcp
-
-

+

Use [do not use] TCP when querying name servers. The default behavior is to use UDP. -

-
+

+[no]ttlid
-
-

+

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

-
+

+[no]ttlunits
-
-

+

Display [do not display] the TTL in friendly human-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks. Implies +ttlid. -

-
+

+[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". -

-
+

-
- -
+
+

LOCAL OPTIONS

- - -

+

The -c option sets the query class to class. It can be any valid query class which is supported in BIND 9. The default query class is "IN".

- -

+

The -t option sets the query type to type. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the -x option is supplied to indicate a reverse lookup with the "PTR" query type.

- -

+

The -i option sets the reverse domain for IPv6 addresses to IP6.INT.

- -

+

Reverse lookups — mapping addresses to names — are simplified by the -x option. addr is an IPv4 @@ -378,26 +278,20 @@ under the IP6.ARPA domain. To use the older RFC1886 method using the IP6.INT domain specify the -i option.

- -

+

The local query options are:

+[no]aaflag
-
-

+

A synonym for +[no]aaonly. -

-
+

+[no]aaonly
-
-

+

Sets the "aa" flag in the query. -

-
+

+[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 @@ -407,110 +301,87 @@ 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. -

-
+

+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]cookie[=####]
-
-

+

Send a COOKIE EDNS option, with optional value. Replaying a COOKIE from a previous response will allow the server to identify a previous client. The default is +nocookie. -

-
+

+[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. -

-
+

+[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]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 be sent. -

-
+

+[no]expire
-
-

+

Send an EDNS Expire option. -

-
+

+[no]nsid
-
-

+

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

-
+

+[no]recurse
-
-

+

Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means mdig normally sends recursive queries. -

-
+

+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]subnet=addr[/prefix-length]
-

+

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

-

+

mdig +subnet=0.0.0.0/0, or simply mdig +subnet=0 for short, sends an EDNS client-subnet option with an empty address and a source @@ -519,63 +390,49 @@ not be used when resolving this query.

-
+
+timeout=T
-
-

+

Sets the timeout for a query to T seconds. The default timeout is 5 seconds for UDP transport and 10 for TCP. An attempt to set T to less than 1 will result in a query timeout of 1 second being applied. -

-
+

+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. -

-
+

+udptimeout=T
-
-

+

Sets the timeout between UDP query retries. -

-
+

+[no]unknownformat
-
-

+

Print all RDATA in unknown RR type presentation format (RFC 3597). The default is to print RDATA for known types in the type's presentation format. -

-
+

+[no]zflag
-
-

+

Set [do not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. -

-
+

-
- -
+
+

SEE ALSO

- -

- dig(1) - , +

dig(1), RFC1035.

-
+
diff --git a/bin/tools/named-journalprint.8 b/bin/tools/named-journalprint.8 index 5c64db8a88..56a801fca0 100644 --- a/bin/tools/named-journalprint.8 +++ b/bin/tools/named-journalprint.8 @@ -35,28 +35,27 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" named-journalprint \- print zone journal in human\-readable form - .SH "SYNOPSIS" - .HP \w'\fBnamed\-journalprint\fR\ 'u - \fBnamed\-journalprint\fR - {\fIjournal\fR} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBnamed\-journalprint\fR\ 'u +\fBnamed\-journalprint\fR {\fIjournal\fR} +.SH "DESCRIPTION" +.PP \fBnamed\-journalprint\fR prints the contents of a zone journal file in a human\-readable form\&. - .PP +.PP Journal files are automatically created by \fBnamed\fR when changes are made to dynamic zones (e\&.g\&., by \fBnsupdate\fR)\&. They record each addition or deletion of a resource record, in binary format, allowing the changes to be re\-applied to the zone when the server is restarted after a shutdown or crash\&. By default, the name of the journal file is formed by appending the extension \&.jnl to the name of the corresponding zone file\&. - .PP +.PP \fBnamed\-journalprint\fR 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\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBnamed\fR(8), \fBnsupdate\fR(1), BIND 9 Administrator Reference Manual\&. diff --git a/bin/tools/named-journalprint.html b/bin/tools/named-journalprint.html index 5ff11535bc..e4dded948a 100644 --- a/bin/tools/named-journalprint.html +++ b/bin/tools/named-journalprint.html @@ -14,38 +14,22 @@
- - - - - -
+

Name

-

- named-journalprint - — print zone journal in human-readable form -

+

named-journalprint — print zone journal in human-readable form

- - - -
+

Synopsis

-

- named-journalprint - {journal} -

-
- -
+

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 @@ -56,28 +40,21 @@ .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(1) - , +

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

-
- +
diff --git a/bin/tools/named-nzd2nzf.8 b/bin/tools/named-nzd2nzf.8 index fe2ed9a355..086849d0a9 100644 --- a/bin/tools/named-nzd2nzf.8 +++ b/bin/tools/named-nzd2nzf.8 @@ -35,32 +35,31 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" named-nzd2nzf \- Convert an NZD database to NZF text format - .SH "SYNOPSIS" - .HP \w'\fBnamed\-nzd2nzf\fR\ 'u - \fBnamed\-nzd2nzf\fR - {filename} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBnamed\-nzd2nzf\fR\ 'u +\fBnamed\-nzd2nzf\fR {filename} +.SH "DESCRIPTION" +.PP \fBnamed\-nzd2nzf\fR converts an NZD database to NZF format and prints it to standard output\&. This can be used to review the configuration of zones that were added to \fBnamed\fR via \fBrndc addzone\fR\&. It can also be used to restore the old file format when rolling back from a newer version of BIND to an older version\&. - .SH "ARGUMENTS" - .PP +.SH "ARGUMENTS" +.PP filename .RS 4 - The name of the +The name of the \&.nzd file whose contents should be printed\&. - .RE - .SH "SEE ALSO" - .PP +.RE +.SH "SEE ALSO" +.PP BIND 9 Administrator Reference Manual - .SH "AUTHOR" - .PP +.SH "AUTHOR" +.PP Internet Systems Consortium .SH "COPYRIGHT" .br diff --git a/bin/tools/named-nzd2nzf.docbook b/bin/tools/named-nzd2nzf.docbook index 04322a9795..6e778d4d66 100644 --- a/bin/tools/named-nzd2nzf.docbook +++ b/bin/tools/named-nzd2nzf.docbook @@ -12,7 +12,7 @@ - information regarding copyright ownership. --> - + May 5, 2016 diff --git a/bin/tools/named-nzd2nzf.html b/bin/tools/named-nzd2nzf.html index 1226ad07ee..611e695b05 100644 --- a/bin/tools/named-nzd2nzf.html +++ b/bin/tools/named-nzd2nzf.html @@ -14,34 +14,19 @@
- - - - -
+

Name

-

- named-nzd2nzf - — +

named-nzd2nzf — Convert an NZD database to NZF text format - -

+

- - - -
+

Synopsis

-

- named-nzd2nzf - {filename} -

-
- -
+

named-nzd2nzf {filename}

+
+

DESCRIPTION

- -

+

named-nzd2nzf converts an NZD database to NZF format and prints it to standard output. This can be used to review the configuration of zones that were added to @@ -50,36 +35,27 @@ when rolling back from a newer version of BIND to an older version.

-
- -
+
+

ARGUMENTS

- -
+
filename
-
-

+

The name of the .nzd file whose contents should be printed. -

-
+

-
- -
+
+

SEE ALSO

- -

+

BIND 9 Administrator Reference Manual

-
- -
+
+

AUTHOR

- -

Internet Systems Consortium +

Internet Systems Consortium

-
- +
diff --git a/bin/tools/named-rrchecker.1 b/bin/tools/named-rrchecker.1 index c6a4e442ba..190ce895a9 100644 --- a/bin/tools/named-rrchecker.1 +++ b/bin/tools/named-rrchecker.1 @@ -35,47 +35,40 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" named-rrchecker \- syntax checker for individual DNS resource records - .SH "SYNOPSIS" - .HP \w'\fBnamed\-rrchecker\fR\ 'u - \fBnamed\-rrchecker\fR - [\fB\-h\fR] - [\fB\-o\ \fR\fB\fIorigin\fR\fR] - [\fB\-p\fR] - [\fB\-u\fR] - [\fB\-C\fR] - [\fB\-T\fR] - [\fB\-P\fR] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBnamed\-rrchecker\fR\ 'u +\fBnamed\-rrchecker\fR [\fB\-h\fR] [\fB\-o\ \fR\fB\fIorigin\fR\fR] [\fB\-p\fR] [\fB\-u\fR] [\fB\-C\fR] [\fB\-T\fR] [\fB\-P\fR] +.SH "DESCRIPTION" +.PP \fBnamed\-rrchecker\fR read a individual DNS resource record from standard input and checks if it is syntactically correct\&. - .PP +.PP The \fB\-h\fR prints out the help menu\&. - .PP +.PP The \fB\-o \fR\fB\fIorigin\fR\fR option specifies a origin to be used when interpreting the record\&. - .PP +.PP The \fB\-p\fR 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\&. - .PP +.PP The \fB\-u\fR prints out the resulting record in unknown record form\&. - .PP +.PP The \fB\-C\fR, \fB\-T\fR and \fB\-P\fR print out the known class, standard type and private type mnemonics respectively\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP RFC 1034, RFC 1035, \fBnamed\fR(8) diff --git a/bin/tools/named-rrchecker.html b/bin/tools/named-rrchecker.html index 416a6be3c6..b5486fa170 100644 --- a/bin/tools/named-rrchecker.html +++ b/bin/tools/named-rrchecker.html @@ -14,74 +14,49 @@
- - - -
+

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.8 b/bin/tools/nsec3hash.8 index a1b69790c1..7bfa663ed1 100644 --- a/bin/tools/nsec3hash.8 +++ b/bin/tools/nsec3hash.8 @@ -35,42 +35,38 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" nsec3hash \- generate NSEC3 hash - .SH "SYNOPSIS" - .HP \w'\fBnsec3hash\fR\ 'u - \fBnsec3hash\fR - {\fIsalt\fR} - {\fIalgorithm\fR} - {\fIiterations\fR} - {\fIdomain\fR} - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBnsec3hash\fR\ 'u +\fBnsec3hash\fR {\fIsalt\fR} {\fIalgorithm\fR} {\fIiterations\fR} {\fIdomain\fR} +.SH "DESCRIPTION" +.PP \fBnsec3hash\fR 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\&. - .SH "ARGUMENTS" - .PP +.SH "ARGUMENTS" +.PP salt .RS 4 - The salt provided to the hash algorithm\&. - .RE - .PP +The salt provided to the hash algorithm\&. +.RE +.PP algorithm .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP iterations .RS 4 - The number of additional times the hash should be performed\&. - .RE - .PP +The number of additional times the hash should be performed\&. +.RE +.PP domain .RS 4 - The domain name to be hashed\&. - .RE - .SH "SEE ALSO" - .PP +The domain name to be hashed\&. +.RE +.SH "SEE ALSO" +.PP BIND 9 Administrator Reference Manual, RFC 5155\&. .SH "AUTHOR" diff --git a/bin/tools/nsec3hash.html b/bin/tools/nsec3hash.html index bdb2b6c304..c7506e42f3 100644 --- a/bin/tools/nsec3hash.html +++ b/bin/tools/nsec3hash.html @@ -14,84 +14,52 @@
- - - - - -
+

Name

-

- nsec3hash - — generate NSEC3 hash -

+

nsec3hash — generate NSEC3 hash

- - - -
+

Synopsis

-

- nsec3hash - {salt} - {algorithm} - {iterations} - {domain} -

-
- -
+

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 13bbd3ba8c..80c26728b7 100644 --- a/doc/arm/Bv9ARM.ch01.html +++ b/doc/arm/Bv9ARM.ch01.html @@ -50,8 +50,7 @@
- -

+

The Internet Domain Name System (DNS) consists of the syntax to specify the names of entities in the Internet in a hierarchical @@ -61,12 +60,10 @@ 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 @@ -75,14 +72,12 @@ BIND version 9 software package for system administrators.

-

This version of the manual corresponds to BIND version 9.11.

-
- -
+

This version of the manual corresponds to BIND version 9.11.

+
+

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 @@ -107,18 +102,15 @@ and the Domain Name System.

-
-
+
+

Conventions Used in This Document

- -

+

In this document, we use the following general typographic conventions:

- -
- +
@@ -175,14 +167,11 @@ -
-
- -

+

+

The following conventions are used in descriptions of the BIND configuration file:

-
- +
@@ -237,36 +226,31 @@ -
-
+

-
-
+
+

The Domain Name System (DNS)

- -

+

This document explains the installation and upkeep of the BIND (Berkeley Internet Name Domain) software package. 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. @@ -274,13 +258,11 @@ contains a name server, named, and a resolver library, liblwres.

- -
-
+
+

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 @@ -291,8 +273,7 @@ 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, @@ -304,8 +285,7 @@ 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 @@ -313,32 +293,27 @@ 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 “Requests 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 @@ -350,8 +325,7 @@ 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 @@ -373,8 +347,7 @@ 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 "primary" and "secondary" @@ -384,13 +357,11 @@ be a secondary server for a domain, it is actually asking for secondary 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. @@ -398,19 +369,16 @@ 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 Server

- -

+

The authoritative server where the main copy of the zone data is maintained is called the primary (or @@ -422,19 +390,16 @@ zone file or master file.

- -

+

In some cases, however, the zone file may not be edited by humans at all, but may instead be the result of dynamic update operations.

-
- -
+
+

Secondary Servers

- -

+

The other authoritative servers, called the secondary (or slave) servers, load the zone @@ -445,7 +410,7 @@ secondary. In other words, a secondary server may itself act as a primary to a subordinate secondary server.

-

+

Periodically, the secondary server must send a refresh query to determine whether the zone contents have been updated. This is done by sending a query for the zone's Start of Authority (SOA) record and @@ -458,19 +423,17 @@ max-retry-time, and min-retry-time options.

-

+

If the zone data cannot be updated within the time specified by the SOA EXPIRE option (up to a hard-coded maximum of 24 weeks), the secondary zone expires and no longer responds to queries.

-
- -
+
+

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. @@ -480,8 +443,7 @@ records, but servers that are not present at the zone's top level cannot be listed in the parent's delegation.

- -

+

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 @@ -492,25 +454,19 @@ are inaccessible.

- -

+

A configuration where the primary server itself is a stealth server is often referred to as a "hidden primary" configuration. One use for this configuration is when the primary is behind a firewall and is 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 @@ -522,26 +478,22 @@ 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 @@ -549,8 +501,7 @@ server, commonly referred to as a forwarder.

- -

+

Forwarders are typically used when an administrator does not wish for all the servers at a given site to interact directly with the rest of the Internet. For example, a @@ -560,14 +511,12 @@ which queries Internet DNS servers on the internal servers' behalf.

- -

+

Another scenario (largely now superseded by Response Policy Zones) is to send queries first to a custom server for RBL processing before forwarding them to the wider Internet.

- -

+

There may be one or more forwarders in a given setup. The order in which the forwarders are listed in named.conf does not determine the @@ -581,22 +530,18 @@ queried, even those with slower response times. This permits changes in behavior based on server responsiveness.

-
- -
- -
+
+
+

Name Servers in Multiple Roles

- -

+

The BIND name server can simultaneously act as a primary for some zones, a secondary for other zones, and 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. @@ -611,11 +556,9 @@ does not need to be reachable from the Internet at large and can be placed inside a firewall.

- -
-
- -
+
+
+
@@ -633,6 +576,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.ch02.html b/doc/arm/Bv9ARM.ch02.html index 414e7278de..13fa1a53a5 100644 --- a/doc/arm/Bv9ARM.ch02.html +++ b/doc/arm/Bv9ARM.ch02.html @@ -43,17 +43,16 @@
Supported Operating Systems
- -
+

Hardware requirements

-

+

DNS hardware requirements have traditionally been quite modest. For many installations, servers that have been retired from active duty have performed admirably as DNS servers.

-

+

However, the DNSSEC features of BIND 9 may be quite CPU-intensive, so organizations that make heavy use of these @@ -62,22 +61,22 @@ full utilization of multiprocessor systems for installations that need it.

-
-
+
+

CPU Requirements

-

+

CPU requirements for BIND 9 range from i386-class machines, for serving static zones without caching, to enterprise-class machines to process many dynamic updates and DNSSEC-signed zones, serving many thousands of queries per second.

-
-
+
+

Memory Requirements

-

+

Server memory must be sufficient to hold both the cache and the zones loaded from disk. The max-cache-size option can limit the amount of memory used by the cache, @@ -96,14 +95,11 @@ 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 configurations that may be used. The first is one where clients and any second-level internal name servers query a main name server, which @@ -116,13 +112,11 @@ 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 many Unix-like operating systems and on Microsoft Windows Server 2012 R2, 2016 and Windows 10. @@ -131,8 +125,8 @@ directory of the BIND 9 source distribution.

-
-
+
+
@@ -150,6 +144,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.ch03.html b/doc/arm/Bv9ARM.ch03.html index 883a8f8165..6f48ddac31 100644 --- a/doc/arm/Bv9ARM.ch03.html +++ b/doc/arm/Bv9ARM.ch03.html @@ -49,22 +49,18 @@
- -

+

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 @@ -73,7 +69,6 @@ suitable firewall rules.

- 
 // Two corporate subnets we wish to allow queries from.
 acl corpnets { 192.168.4.0/24; 192.168.7.0/24; };
@@ -91,19 +86,15 @@ 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 primary server for "example.com" and a secondary server for the subdomain "eng.example.com".

- 
 options {
      // Working directory
@@ -142,31 +133,23 @@ 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, assuming three HTTP 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:

- -
- +
@@ -280,51 +263,46 @@ zone "eng.example.com" { -
-
-

+

+

When a resolver queries for these records, BIND rotates them and responds to the query with the records in a different order. In the example above, clients randomly receive records in the order 1, 2, 3; 2, 3, 1; and 3, 1, 2. Most clients 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
-

+

dig is the most versatile and complete of these lookup tools. It has two modes: simple interactive @@ -334,31 +312,22 @@ 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 takes 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 @@ -366,29 +335,16 @@ 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 @@ -397,15 +353,8 @@ 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 is used) or when the first argument is a @@ -413,7 +362,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. @@ -421,76 +370,56 @@ 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 zone 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
-
-

+

This tool is 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 @@ -499,21 +428,11 @@ zone "eng.example.com" { options, it displays 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 @@ -537,8 +456,7 @@ 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 is limited to @@ -550,8 +468,7 @@ zone "eng.example.com" { be shared. The order of statements is not significant.

- -

+

The options statement has three clauses: default-server, default-key, @@ -569,8 +486,7 @@ 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 @@ -599,8 +515,7 @@ zone "eng.example.com" { have any meaning. The secret is a Base64-encoded string as specified in RFC 3548.

- -

+

The server statement associates a key defined using the key @@ -616,11 +531,9 @@ zone "eng.example.com" { connect to on the server.

- -

+

A sample minimal configuration file is as follows:

- 
 key rndc_key {
      algorithm "hmac-sha256";
@@ -632,36 +545,30 @@ options {
      default-key    rndc_key;
 };
- -

+

This file, if installed as /etc/rndc.conf, allows the command:

- -

+

$ rndc reload

- -

+

to connect to 127.0.0.1 port 953 and causes the name server to reload, if a name server on the local machine is running with following controls statements:

- 
 controls {
         inet 127.0.0.1
             allow { localhost; } keys { rndc_key; };
 };
- -

+

and it has an identical key statement for rndc_key.

- -

+

Running the rndc-confgen program conveniently creates an rndc.conf @@ -676,23 +583,19 @@ 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.

-
- +
@@ -730,11 +633,10 @@ controls { -
-
-
-
-
+
+
+
+
@@ -752,6 +654,6 @@ controls {
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.ch04.html b/doc/arm/Bv9ARM.ch04.html index 22f0e7db8a..941d9639c3 100644 --- a/doc/arm/Bv9ARM.ch04.html +++ b/doc/arm/Bv9ARM.ch04.html @@ -112,19 +112,17 @@
- -
+

Notify

-

+

DNS NOTIFY is a mechanism that allows primary servers to notify their secondary servers of changes to a zone's data. In response to a NOTIFY from a primary server, the secondary checks to see that its version of the zone is the current version and, if not, initiates a zone transfer.

- -

+

For more information about DNS NOTIFY, see the description of the notify option in the section called “Boolean Options” and @@ -132,8 +130,7 @@ the section called “Zone Transfers”. The NOTIFY protocol is specified in RFC 1996.

- -
+

Note

As a secondary zone can also be a primary to other secondaries, named, @@ -143,35 +140,29 @@ zones that it loads.

- -
- -
+
+

Dynamic Update

- -

+

Dynamic Update is a method for adding, replacing, or deleting records in a primary 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 are permitted for the key local-ddns, which is 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, either by setting the tkey-gssapi-keytab option, or @@ -181,20 +172,17 @@ 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. @@ -204,8 +192,7 @@ file, unless specifically overridden. The journal file is in a binary format and should not be edited manually.

- -

+

The server also occasionally writes ("dumps") the complete contents of the updated zone to its zone file. This is not done immediately after @@ -218,29 +205,25 @@ are removed when the dump is complete, and can be safely ignored.

- -

+

When a server is restarted after a shutdown or crash, it replays 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 journaled 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.

- -

+

To make changes to a dynamic zone manually, follow these steps: first, disable dynamic updates to the zone using @@ -251,8 +234,7 @@ rndc thaw zone to reload the changed zone and re-enable dynamic updates.

- -

+

rndc sync zone updates the zone file with changes from the journal file without stopping dynamic updates; this may be useful for viewing @@ -260,23 +242,18 @@ file after updating the zone file, use rndc sync -clean.

- -
- -
- -
+
+
+

Incremental Zone Transfers (IXFR)

- -

+

The incremental zone transfer (IXFR) protocol is a way for secondary servers to transfer only changed data, instead of having to transfer an entire zone. The IXFR protocol is specified in RFC 1995. See Proposed Standards.

- -

+

When acting as a primary server, BIND 9 supports IXFR for those zones where the necessary change history information is available. These @@ -287,27 +264,24 @@ ixfr-from-differences is set to yes.

- -

+

When acting as a secondary server, BIND 9 attempts 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 of the DNS space to internal and external resolvers is usually referred to as a split DNS setup. There are several reasons an organization might want to set up its DNS this way.

-

+

One common reason to use split DNS is to hide "internal" DNS information from "external" clients on the Internet. There is some debate as to whether this is actually @@ -321,17 +295,17 @@ choose to use 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 into 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 @@ -339,14 +313,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 sets up two sets of name servers. One set is on the inside network (in the reserved @@ -354,7 +328,7 @@ "proxy" hosts in the DMZ that can talk to both sides of its network.

-

+

The internal servers are configured to forward all queries, except queries for site1.internal, site2.internal, site1.example.com, and site2.example.com, to the servers @@ -363,20 +337,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, are configured to serve the "public" version of the site1.example.com 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.example.com 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 @@ -385,11 +359,11 @@ 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 need to know how to deliver mail to internal hosts. The resolvers @@ -397,72 +371,57 @@ the bastion hosts need to be configured to point to the internal name servers for DNS resolution.

-

+

Queries for internal hostnames are answered by the internal servers, and queries for external hostnames are forwarded back out to the DNS servers on the bastion hosts.

-

+

For all of this to work properly, internal clients 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 are now able to:

-
    +
    • - Look up any hostnames in the site1.example.com 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 users. -
      • + +
    • Look up any hostnames on the Internet.
      • +
    • Exchange mail with both internal and external users.
    -

    +

    Hosts on the Internet are able to:

    -
      +
      • - Look up any hostnames in the site1.example.com and site2.example.com zones. - -
        • +
      • - Exchange mail with anyone in the site1.example.com and site2.example.com zones. - -
        • +
      - -

      +

      Here is an example configuration for the setup just described above. Note that this is only configuration information; for information on how to configure the zone files, see the section called “Sample Configurations”.

      - -

      +

      Internal DNS server config:

      - 
       
 acl internals { 172.16.72.0/24; 192.168.1.0/24; };
@@ -524,11 +483,9 @@ zone "site2.internal" {
   allow-transfer { internals; }
 };
      - -

      +

      External (bastion host) DNS server config:

      - 
       acl internals { 172.16.72.0/24; 192.168.1.0/24; };
 
@@ -563,26 +520,22 @@ 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 @@ -593,12 +546,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 primary to a secondary server.

-

+

This section 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 @@ -606,32 +559,31 @@ 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 @@ -640,26 +592,25 @@ 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 @@ -671,11 +622,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 @@ -683,27 +634,26 @@ 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 is able to verify the signature. If the signature is valid, the response is 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 secondary zone; in this case, all SOA QUERY messages, NOTIFY @@ -713,7 +663,7 @@ key "host1-host2." { or secondary 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 @@ -726,58 +676,56 @@ 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 expects the response to be signed with the same key. If a response is not signed, or if the signature is not valid, the response is 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.

-

+

Here is 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:

    @@ -803,25 +751,23 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; In all of the above cases, the server returns 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 @@ -833,55 +779,51 @@ 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 with 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 is only verified if the key is known and trusted by the server. The server does 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 @@ -892,8 +834,7 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; keyset files to be in the working directory or the directory specified by the -d option.

- -

+

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 @@ -902,23 +843,19 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; delegation point.

- -

+

For other servers to trust data in this zone, they must be statically configured with either 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 @@ -929,17 +866,14 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; designated as "mandatory to implement" by the IETF; currently the only one is RSASHA1.

- -

+

The following command generates a 768-bit RSASHA1 key for the child.example zone:

- -

+

dnssec-keygen -a RSASHA1 -b 768 -n ZONE child.example.

- -

+

Two output files are produced: Kchild.example.+005+12345.key and Kchild.example.+005+12345.private @@ -955,35 +889,29 @@ 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 device 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 sub-zones should be present. The zone signer generates NSEC, NSEC3, @@ -993,18 +921,15 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; is not specified, then DS RRsets for the secure child zones need to be added manually.

- -

+

By default, all zone keys which have an available private key are used to generate signatures. The following command signs the zone, assuming it is in a file called zone.child.example:

- -

+

dnssec-signzone -o child.example zone.child.example

- -

+

One output file is produced: zone.child.example.signed. This file @@ -1012,37 +937,31 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; as the input file for the zone.

- -

dnssec-signzone +

dnssec-signzone also produces keyset and dsset files. 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 for DNSSEC

- -

+

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 option must be set to yes or auto.

- -

+

If dnssec-validation is set to auto, then a default trust anchor for the DNS root zone is used. @@ -1054,8 +973,7 @@ 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 @@ -1063,27 +981,23 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; are deemed to exist and only the listed keys are used to validate 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.

- -

+

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 is established, a typical DNSSEC configuration looks something like the following. It has one or more public keys for the root, which allows answers from @@ -1093,7 +1007,6 @@ allow-update { !{ !localnets; any; }; key host1-host2. ;}; is immune to compromised security in the DNSSEC components of parent zones.

- 
 managed-keys {
         /* Root Key */
@@ -1146,65 +1059,56 @@ 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 rejects any answers from signed, secure zones which fail to validate, and returns 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, the validator 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".

-
-
-
- -
+
+
+
+

DNSSEC, Dynamic Zones, and Automatic Signing

- -
-

-Converting from insecure to secure

- -
-

A zone ca be changed from insecure to secure in two +

+Converting from insecure to secure

+

A zone ca be changed from insecure to secure in two ways: using a dynamic DNS update, or via the auto-dnssec zone option.

-

For either method, +

For either method, named must be configured so that it can see the K* files which contain the public and private parts of the keys that are used to sign the zone. These files @@ -1212,7 +1116,7 @@ options { dnssec-keygen, and they should be placed in the key-directory, as specified in named.conf:

- 
+
 	zone example.net {
 		type master;
 		update-policy local;
@@ -1220,35 +1124,32 @@ 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 causes all records in the zone to be signed
   with the ZSK, and the DNSKEY RRset to be signed with the KSK.
   An NSEC chain is 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 completes almost immediately,
+
While the update request completes almost immediately,
   the zone is not completely signed until
   named has had time to "walk" the zone and
   generate the NSEC and RRSIG records. The NSEC record at the apex
   is added last, to signal that there is a complete NSEC
   chain.

-  
To sign using NSEC3 instead of NSEC,
+
To sign using NSEC3 instead of NSEC,
   add an NSEC3PARAM record to the initial update request.
   The OPTOUT bit in the NSEC3 chain can be set in the
   flags field of the NSEC3PARAM record.

-  
+
 	% nsupdate
 	> ttl 3600
 	> update add example.net DNSKEY 256 3 7 AwEAAZn17pUF0KpbPA2c7Gz76Vb18v0teKT3EyAGfBfL8eQ8al35zz3Y I1m/SAQBxIqMfLtIwqWPdgthsu36azGQAX8=
@@ -1256,32 +1157,29 @@ options {
 	> update add example.net NSEC3PARAM 1 1 100 1234567890
 	> send
 

-  
Again, this update request completes almost
+
Again, this update request completes almost
   immediately; however, the record does not show up until
   named has had a chance to build/remove the
   relevant chain. A private type record is created to record
   the state of the operation (see below for more details), and is
   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 does so only when it receives an
   rndc sign <zonename>.

-  

+

   
   auto-dnssec maintain includes the above
   functionality, but also automatically adjusts the zone's
@@ -1289,7 +1187,7 @@ options {
   (See dnssec-keygen(8) and
   dnssec-settime(8) for more information.)
   

-  

+

   named periodically searches the key directory
   for keys matching the zone; if the keys' metadata indicates
   that any change should be made to the zone - such as adding, removing,
@@ -1299,21 +1197,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 is signed immediately, without waiting for an
   rndc sign or rndc loadkeys
   command. Those commands can still be used when there are unscheduled
   key changes.
   

-  

+

   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,
   the TTL is set to the TTL specified when the key was
   created (using the dnssec-keygen -L option), if
   any, or to the SOA TTL.
   

-  

+

   To sign the zone using NSEC3 instead of NSEC,
   submit an NSEC3PARAM record via dynamic update prior to the
   scheduled publication and activation of the keys.
@@ -1323,28 +1221,25 @@ options {
   the zone is signed and the NSEC3 chain is completed, the NSEC3PARAM
   record appears 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
   fails.

-  

-

-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 with a non-zero initial octet
   have a non-zero value for the final octet.

-  
If the first octet of a private type record is
+
If the first octet of a private type record is
   non-zero, the record indicates either that the zone needs to be
   signed with the key matching the record, or that all signatures
   that match the record should be removed. Here are the meanings
   of the different values of the first octet:

-  

+

     

 


 

@@ -1355,15 +1250,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
   are 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), the
   record indicates that changes to the NSEC3 chains are in progress. The
   rest of the record contains an NSEC3PARAM record, while the flag field
   tells what operation to perform based on the flag bits:

-  

+

     

 


 

@@ -1374,43 +1269,34 @@ options {
 

 

   

-  

-

-DNSKEY Rollovers

-
-  

-  
As with insecure-to-secure conversions, DNSSEC keyrolls
+

+DNSKEY Rollovers

+
As with insecure-to-secure conversions, DNSSEC keyrolls
   can be done in two ways: using a dynamic DNS update, or via the
   auto-dnssec zone option.

-  

-

-Dynamic DNS Update Method

-
-  

-  
 To perform key rollovers via dynamic update,
+

+Dynamic DNS Update Method

+
 To perform key rollovers via dynamic update,
   the K* files for the new keys must be added so that
   named can find them. The new
   DNSKEY RRs can then be added via dynamic update.
   named then causes the zone to be signed
   with the new keys; when the signing is complete, the private type
   records are updated so that the last octet is non-zero.

-  
If this is for a KSK, the parent and any
+
If this is for a KSK, the parent and any
   trust anchor repositories of the new KSK must be informed.

-  
The maximum TTL in the zone must expire before
+
The maximum TTL in the zone must expire before
   removing the old DNSKEY. If it is a KSK that is being updated,
   the DS RRset in the parent must also be
   updated its TTL allowed to expire. This ensures that all clients
   are able to verify at least one signature when the old DNSKEY is removed.

-  
The old DNSKEY can be removed via UPDATE, taking care to
+
The old DNSKEY can be removed via UPDATE, taking care to
   specify the correct key.
   named cleans 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),
   and if the auto-dnssec zone option is set to
   maintain, named
@@ -1423,69 +1309,51 @@ options {
   signature validity periods expire.  By default, this rollover
   completes in 30 days, after which it is safe to remove the
   old key from the DNSKEY RRset.

-  

-

-NSEC3PARAM Rollovers via UPDATE

-
-  

-  
The new NSEC3PARAM record can be added via dynamic update. When the
+

+NSEC3PARAM Rollovers via UPDATE

+
The new NSEC3PARAM record can be added via dynamic update. When the
   new NSEC3 chain has been generated, the NSEC3PARAM flag field
   is set to zero. At that point, the old NSEC3PARAM
   record can be removed. The old chain is removed after the update request
   completes.

-  

-

-Converting From NSEC to NSEC3

-
-  

-  
To do this, an NSEC3PARAM record must be added. When
+

+Converting From NSEC to NSEC3

+
To do this, an NSEC3PARAM record must be added. When
   the conversion is complete, the NSEC chain is removed
   and the NSEC3PARAM record has a zero flag field. The NSEC3
   chain is 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 is 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 are removed automatically.
   This takes 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; otherwise, 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
   periodically re-signs RRsets which have not been re-signed as
   a result of some update action. The signature lifetimes are
   adjusted 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.
@@ -1496,41 +1364,34 @@ options {
   changed, the entire chain must be
   changed.
- -
+

Dynamic Trust Anchor Management

- -

+

BIND is able to maintain DNSSEC trust anchors using RFC 5011 key management. 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 KSKs 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 takes note of the stand-by KSKs in the zone's DNSKEY RRset, and stores them for future reference. The resolver rechecks the zone @@ -1539,63 +1400,61 @@ options { anchor for the zone. Anytime 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 exists with a publication date in the past, but an activation date which is unset or in the future, dnssec-signzone -S includes the DNSKEY record in the zone but does 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, use the command
+
To revoke a key, use the command
     dnssec-revoke. This adds the
     REVOKED bit to the key flags and regenerates 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 is never again
     accepted as a valid trust anchor by the resolver. However,
     validation can proceed using the new active key, which was
     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 IDs exactly 128 apart and one is
+
If two keys have IDs exactly 128 apart and one is
     revoked, the two key IDs will collide, causing several
     problems. To prevent this,
     dnssec-keygen does not generate a new key if
     another key which may collide is present. This checking
     only occurs if the new keys are written to the same directory
     that holds all other keys in use for that zone.

-    
Older versions of BIND 9 did not have this protection.
+
Older versions of BIND 9 did not have this protection.
     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 IDs.

-
- -
+
+

PKCS#11 (Cryptoki) Support

- -

+

Public Key Cryptography Standard #11 (PKCS#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 @@ -1604,13 +1463,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 @@ -1620,21 +1479,19 @@ $ 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 @@ -1646,15 +1503,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
@@ -1664,11 +1521,10 @@ $ ./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
 	
@@ -1686,7 +1542,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).
@@ -1694,20 +1550,19 @@ $ ./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 @@ -1715,23 +1570,20 @@ $ /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 @@ -1742,10 +1594,9 @@ $ /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; @@ -1753,7 +1604,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) @@ -1763,28 +1614,27 @@ $ /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
@@ -1792,93 +1642,87 @@ $ 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
 	(
@@ -1891,13 +1735,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 
@@ -1906,118 +1750,111 @@ $  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 @@ -2027,7 +1864,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 @@ -2036,25 +1873,24 @@ $ ./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
@@ -2063,10 +1899,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,
@@ -2077,31 +1913,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
@@ -2109,31 +1945,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
@@ -2143,13 +1979,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:
@@ -2158,12 +1994,11 @@ 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 @@ -2173,30 +2008,29 @@ 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, @@ -2204,13 +2038,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
@@ -2219,42 +2053,40 @@ $ 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)

    - -

    +

    Dynamically Loadable Zones (DLZ) are 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). @@ -2262,7 +2094,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 @@ -2271,8 +2103,7 @@ $ dnssec-signzone -E '' -S example.netcontrib/dlz/drivers.

    - -

    +

    The DLZ module provides data to named in text format, which is then converted to DNS wire format by named. This conversion, and the lack of any internal caching, places significant @@ -2283,22 +2114,20 @@ $ 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
@@ -2308,11 +2137,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
@@ -2322,7 +2151,7 @@ $ dnssec-signzone -E '' -S example.net
-    
    +
         dlz other {
 	database "dlopen driver.so args";
 	search no;
@@ -2333,12 +2162,11 @@ $ dnssec-signzone -E '' -S example.net
-
    -
    +
    +

    Sample DLZ Driver

    - -

    +

    For guidance in the implementation of DLZ modules, the directory contrib/dlz/example contains a basic dynamically linkable DLZ module - i.e., one which can be @@ -2347,25 +2175,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 can retrieve information about the
       querying client and alter its response on the basis of this
       information.  To demonstrate this feature, the example driver
@@ -2376,21 +2204,19 @@ $ 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.
     
    
-
    - -
    +
    +

    Dynamic Database (DynDB)

    - -

    +

    Dynamic Database, or DynDB, is an extension to BIND 9 which, like DLZ (see the section called “DLZ (Dynamically Loadable Zones)”), allows zone data to be retrieved from an external database. Unlike DLZ, a DynDB module @@ -2402,31 +2228,29 @@ $ dnssec-signzone -E '' -S example.net -

    +

    A DynDB module supporting LDAP has been created by Red Hat and is available from https://pagure.io/bind-dyndb-ldap.

    -

    +

    A sample DynDB module for testing and developer guidance is included with the BIND source code, in the directory bin/tests/system/dyndb/driver.

    - -
    +

    Configuring DynDB

    - -

    +

    A DynDB database is configured with a dyndb statement in named.conf:

    - 
    +
         dyndb example "driver.so" {
         parameters
     };
     
    
-    
    
+
    
       The file driver.so is a DynDB module which
       implements the full DNS database API.  Multiple
       dyndb statements can be specified, to load
@@ -2436,17 +2260,16 @@ $ dnssec-signzone -E '' -S example.net
-    
    
+
    
       The parameters are passed as an opaque
       string to the DynDB module's initialization routine. Configuration
       syntax differs depending on the driver.
     
    
-
    -
    +
    +

    Sample DynDB Module

    - -

    +

    For guidance in the implementation of DynDB modules, the directory bin/tests/system/dyndb/driver contains a basic DynDB module. @@ -2454,37 +2277,35 @@ $ dnssec-signzone -E '' -S example.netdyndb statement:

    - 
    +
         dyndb sample "sample.so" { example.nil. arpa. };
     
    
-    
    
+
    
       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.  86400    IN      SOA     example.nil. example.nil. (
                                                0 28800 7200 604800 86400
                                        )
  example.nil.  86400    IN      NS      example.nil.
  example.nil.  86400    IN      A       127.0.0.1
     
    
-    
    
+
    
       When the zone is updated dynamically, the DynDB module determines
       whether the updated RR is an address (i.e., type A or AAAA); if
       so, it automatically updates the corresponding PTR record in a
       reverse zone.  Note that updates are not stored permanently; all updates are
       lost when the server is restarted.
     
    
-
    - -
    +
    +

    Catalog Zones

    - -

    +

    A "catalog zone" is a special DNS zone that contains a list of other zones to be served, along with their configuration parameters. Zones listed in a catalog zone are called "member zones." @@ -2497,17 +2318,16 @@ $ dnssec-signzone -E '' -S example.net -

    +

    Catalog zones' format and behavior are specified as an Internet draft for interoperability among DNS implementations. The latest revision of the DNS catalog zones draft can be found here: https://datatracker.ietf.org/doc/draft-toorop-dnsop-dns-catalog-zones/.

    - -
    +

    Principle of Operation

    -

    +

    Normally, if a zone is to be served by a secondary server, the named.conf file on the server must list the zone, or the zone must be added using rndc addzone. @@ -2516,13 +2336,13 @@ $ dnssec-signzone -E '' -S example.net -

    +

    A catalog zone is a way to ease this administrative burden: it is a DNS zone that lists member zones that should be served by secondary servers. When a secondary server receives an update to the catalog zone, it adds, removes, or reconfigures member zones based on the data received.

    -

    +

    To use a catalog zone, it must first be set up as a normal zone on both the primary and secondary servers that are configured to use it. It must also be added to a catalog-zones list @@ -2531,25 +2351,21 @@ $ dnssec-signzone -E '' -S example.netresponse-policy statement.

    -

    +

    To use the catalog zone feature to serve a new member zone:

      -
    • -

      +

    • Set up the the member zone to be served on the primary as normal. This can be done by editing named.conf or by running rndc addzone. -

      -
      • -
    • -

      +

      • +

    • Add an entry to the catalog zone for the new member zone. This can be done by editing the catalog zone's zone file and running rndc reload, or by updating the zone using nsupdate. -

      -
      • +

    The change to the catalog zone is propagated from the primary to all @@ -2561,7 +2377,7 @@ $ dnssec-signzone -E '' -S example.net -

    +

    Removing a member zone from a secondary server requires only deleting the member zone's entry in the catalog zone; the change to the catalog zone is propagated to the secondary server using the normal AXFR/IXFR @@ -2572,12 +2388,11 @@ $ dnssec-signzone -E '' -S example.netrndc delzone.)

    -
    - -
    +
    +

    Configuring Catalog Zones

    -

    +

    Catalog zones are configured with a catalog-zones statement in the options or view section of named.conf. For example, @@ -2591,24 +2406,24 @@ catalog-zones { min-update-interval 10; }; -

    +

    This statement specifies that the zone catalog.example is a catalog zone. This zone must be properly configured in the same view. In most configurations, it would be a secondary zone.

    -

    +

    The options following the zone name are not required, and may be specified in any order:

    -

    +

    The default-masters option defines the default primaries for member zones listed in a catalog zone, and can be overridden by options within a catalog zone. If no such options are included, then member zones transfer their contents from the servers listed in this option.

    -

    +

    The in-memory option, if set to yes, causes member zones to be stored only in memory. This is functionally equivalent to configuring a secondary zone without a file @@ -2616,7 +2431,7 @@ catalog-zones { is stored locally in a file whose name is automatically generated from the view name, catalog zone name, and member zone name.

    -

    +

    The zone-directory option causes local copies of member zones' zone files to be stored in the specified directory, if in-memory is not set to yes. @@ -2624,7 +2439,7 @@ catalog-zones { A non-absolute pathname in zone-directory is assumed to be relative to the working directory.

    -

    +

    The min-update-interval option sets the minimum interval between processing of updates to catalog zones, in seconds. If an update to a catalog zone (for example, via IXFR) happens less @@ -2632,24 +2447,23 @@ catalog-zones { recent update, the changes are not carried out until this interval has elapsed. The default is 5 seconds.

    -

    +

    Catalog zones are defined on a per-view basis. Configuring a non-empty catalog-zones statement in a view automatically turns on allow-new-zones for that view. This means that rndc addzone and rndc delzone also work in any view that supports catalog zones.

    -
    - -
    +
    +

    Catalog Zone Format

    -

    +

    A catalog zone is a regular DNS zone; therefore, it must have a single SOA and at least one NS record.

    -

    +

    A record stating the version of the catalog zone format is also required. If the version number listed is not supported by the server, then a catalog zone may not be used by that server. @@ -2659,57 +2473,57 @@ catalog.example. IN SOA . . 2016022901 900 600 86400 1 catalog.example. IN NS nsexample. version.catalog.example. IN TXT "1" -

    +

    Note that this record must have the domain name "version.catalog-zone-name". The data stored in a catalog zone is indicated by the the domain name label immediately before the catalog zone domain.

    -

    +

    Catalog zone options can be set either globally for the whole catalog zone or for a single member zone. Global options override the settings in the configuration file, and member zone options override global options.

    -

    +

    Global options are set at the apex of the catalog zone, e.g.: 

      masters.catalog.example.    IN AAAA 2001:db8::1
    -

    BIND currently supports the following options:

    -
      +

      BIND currently supports the following options:

      +
      • -

        A simple masters definition:

        - 
        +
        A simple masters definition:
        
+
         	 masters.catalog.example.    IN A 192.0.2.1
 	
        
-	
        
+
        
 	  This option defines a primary server for the member zones, which
 	  can be either an A or AAAA record. If multiple primaries are set, the
 	  order in which they are used is random.
 	
        
-
        • +
      • -

        A masters with a TSIG key defined:

        - 
        +
        A masters with a TSIG key defined:
        
+
                  label.masters.catalog.example.     IN A 192.0.2.2
          label.masters.catalog.example.	    IN TXT "tsig_key_name"
         
        
-        
        
+
        
          This option defines a primary server for the member zone with a TSIG
          key set. The TSIG key must be configured in the configuration file.
          label can be any valid DNS label.
         
        
-
        • +
      • -

        allow-query and +

        allow-query and allow-transfer ACLs:

        - 
        +
                  allow-query.catalog.example.	IN APL 1:10.0.0.1/24
          allow-transfer.catalog.example.	IN APL !1:10.0.0.1/32 1:10.0.0.0/24
         
        
-        
        
+
        
           These options are the equivalents of allow-query
           and allow-transfer in a zone declaration in the
           named.conf configuration file. The ACL is
@@ -2717,9 +2531,9 @@ version.catalog.example.    IN TXT "1"
           policy is to deny access.  For the syntax of the APL RR, see RFC
           3123.
         
        
-
        • +
      -

      +

      A member zone is added by including a PTR resource record in the zones sub-domain of the catalog zone. The record label is a SHA-1 hash @@ -2730,7 +2544,7 @@ version.catalog.example. IN TXT "1" 

       5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN PTR domain.example.
      -

      +

      The hash is necessary to identify options for a specific member zone. The member zone-specific options are defined the same way as global options, but in the member zone subdomain: @@ -2741,33 +2555,31 @@ label.masters.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN label.masters.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN TXT "tsig_key" allow-query.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN APL 1:10.0.0.0/24 -

      +

      Options defined for a specific zone override the global options defined in the catalog zone. These in turn override the global options defined in the catalog-zones statement in the configuration file.

      -

      +

      Note that none of the global records for an option are inherited if any records are defined for that option for the specific zone. For example, if the zone had a masters record of type A but not AAAA, it would not inherit the type AAAA record from the global option.

      -
    - -
    +
    +

    IPv6 Support in BIND 9

    -

    +

    BIND 9 fully supports all currently defined forms of IPv6 name-to-address and address-to-name lookups. It also uses 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 @@ -2777,8 +2589,7 @@ allow-query.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN A for A6 records, and accept zone transfer for a zone containing A6 records.

    - -

    +

    For IPv6 reverse lookups, BIND 9 supports the traditional "nibble" format used in the ip6.arpa domain, as well as the older, deprecated @@ -2793,39 +2604,33 @@ allow-query.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN A In particular, an authoritative BIND 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 @@ -2834,16 +2639,14 @@ 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. )
    - -
    -
    -
    +
    +
    +
    @@ -2861,6 +2664,6 @@ $ORIGIN 0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa.
    -

    BIND 9.11.25 (Extended Support Version)

    +

    BIND 9.11.26 (Extended Support Version)

    diff --git a/doc/arm/Bv9ARM.ch05.html b/doc/arm/Bv9ARM.ch05.html index b38cfb6134..e12808e754 100644 --- a/doc/arm/Bv9ARM.ch05.html +++ b/doc/arm/Bv9ARM.ch05.html @@ -40,24 +40,22 @@
    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.

    -

    +

    At first, IPv6 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 @@ -65,20 +63,18 @@ 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 make UDP requests to the IPv4 loopback address (127.0.0.1) on port 921. @@ -87,8 +83,7 @@ lines in /etc/resolv.conf.

    - -

    +

    The lwresd daemon is essentially a caching-only name server that responds to requests using the lightweight @@ -101,7 +96,7 @@ autonomously if none are specified.

    -

    +

    The lwresd daemon may also be configured with a named.conf-style configuration file, @@ -111,14 +106,14 @@ be configured to act as a lightweight resolver daemon using the lwres statement in named.conf.

    -

    +

    The number of client queries that the lwresd daemon serves can be set using the lwres-tasks and lwres-clients statements in the configuration.

    -
    -
    +
+
@@ -136,6 +131,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.ch06.html b/doc/arm/Bv9ARM.ch06.html index 005f5a5c7e..53c18a98d8 100644 --- a/doc/arm/Bv9ARM.ch06.html +++ b/doc/arm/Bv9ARM.ch06.html @@ -98,17 +98,14 @@
- -
+

Configuration File Elements

- -

+

Following is a list of elements used throughout the BIND configuration file documentation:

-
- +
@@ -512,88 +509,68 @@ -
-
-
+
+

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 @@ -613,8 +590,7 @@ 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 is given to the one that came @@ -630,26 +606,22 @@ that problem by blocking 1.2.3.13 via the negation, but all other 1.2.3.* hosts pass through.

    -
-
- -
+
+
+

Comment Syntax

- -

+

The BIND 9 comment syntax allows 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 */

@@ -661,26 +633,25 @@ # 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.
@@ -691,15 +662,14 @@
 

 
           

-
-          

+

             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
@@ -709,15 +679,14 @@
 

 
           

-          

+

             Shell-style (or perl-style) 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
@@ -727,25 +696,22 @@
 

 
           

-
-          

+

 
Warning

-            

+

               The semicolon (";") character
               cannot start a comment, unlike 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 @@ -753,13 +719,10 @@ statements contain a block of sub-statements, which are also terminated with a semicolon.

- -

+

The following statements are supported:

- -
- +
@@ -918,40 +881,33 @@ -
-
- -

+

+

The logging and options statements may only occur once per configuration.

- -
+

acl Statement Grammar

- 
+
 acl string { address_match_element; ... };
 

-
-
+
+

acl Statement Definition and Usage

- -

+

The acl statement assigns a symbolic name to an address match list. It gets its name from one of the primary uses of address match lists: Access Control Lists (ACLs).

- -

+

The following ACLs are built-in:

- -
- +
@@ -1011,13 +967,12 @@ -
-
-
-
+
+
+

controls Statement Grammar

- 
+
 controls {
 	inet ( ipv4_address | ipv6_address |
 	    * ) [ port ( integer | * ) ] allow
@@ -1030,22 +985,19 @@
 	    boolean ];
 };
 

-
- -
+
+

controls Statement Definition and Usage

- -

+

The controls statement declares control channels to be used by system administrators to manage 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 @@ -1058,13 +1010,11 @@ 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. @@ -1074,8 +1024,7 @@ 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, @@ -1084,8 +1033,7 @@ (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. @@ -1094,8 +1042,7 @@ See Remote Name Daemon Control application in the section called “Administrative Tools”) for information about configuring keys in rndc.

- -

+

If the read-only clause is enabled, the control channel is limited to the following set of read-only commands: nta -dump, @@ -1105,8 +1052,7 @@ read-only is not enabled and the control channel allows read-write access.

- -

+

If no controls statement is present, named sets up a default control channel listening on the loopback address 127.0.0.1 @@ -1120,8 +1066,7 @@ To create an rndc.key file, run rndc-confgen -a.

- -

+

The key name and the size of the secret cannot be easily changed; if it is desirable to change those things, make a rndc.conf with a custom key. The rndc.key file @@ -1134,25 +1079,21 @@ rndc.conf file and make it group-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 @@ -1162,32 +1103,28 @@ others. For example, the statement could include private keys that are readable only by the name server.

- -
-
+
+

key Statement Grammar

- 
+
 key string {
 	algorithm string;
 	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 @@ -1198,8 +1135,7 @@ Usage”) must be defined at the top level.

- -

+

The key_id, also known as the key name, is a domain name that uniquely identifies the key. It can be used in a server @@ -1208,8 +1144,7 @@ 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. The named server supports hmac-md5, @@ -1222,12 +1157,11 @@ secret_string is the secret to be used by the algorithm, and is treated as a Base64-encoded string.

- -
-
+
+

logging Statement Grammar

- 
+
 logging {
 	category string { string; ... };
 	channel string {
@@ -1244,13 +1178,11 @@
 	};
 };
 

-
- -
+
+

logging Statement Definition and Usage

- -

+

The logging statement configures a wide variety of logging options for the name server. Its channel phrase @@ -1258,33 +1190,29 @@ 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 desired. If there is no logging statement, the logging configuration is:

- 
logging {
      category default { default_syslog; default_debug; };
      category unmatched { null; };
 };
- -

+

If named is started with the -L option, it logs to the specified file at startup, instead of using syslog. In this case the logging configuration is:

- 
logging {
      category default { default_logfile; default_debug; };
      category unmatched { null; };
 };
- -

+

The logging configuration is only established when the entire configuration file has been parsed. When the server starts up, all logging messages @@ -1292,17 +1220,14 @@ channels, or to standard error if the -g option was specified.

- -
+

The channel Phrase

- -

+

All log output goes to one or more channels; there is no limit to the number of channels that can be created.

- -

+

Every channel definition must include a destination clause that says whether messages selected for the channel go to a file, go to a particular syslog facility, go to the standard error stream, or are @@ -1313,14 +1238,12 @@ category name, and/or the 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 @@ -1328,8 +1251,7 @@ versions of the file are saved each time the file is opened.

- -

+

If the versions log file option is used, then named retains that many backup @@ -1352,8 +1274,7 @@ 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 @@ -1369,20 +1290,17 @@ the file.

- -

+

Here is an example using 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 @@ -1404,10 +1322,10 @@ 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 when writing straight to a file rather than using syslog. @@ -1416,7 +1334,7 @@ levels are accepted.

-

+

When using syslog, the syslog.conf priorities also determine what eventually passes through. For example, defining a channel facility and severity as daemon and debug, but @@ -1428,8 +1346,7 @@ 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 @@ -1437,8 +1354,7 @@ use when the server is running as a foreground process, as when debugging a configuration, for example.

- -

+

The server can supply extensive debugging information when it is in debugging mode. If the server's global debug level is greater @@ -1452,21 +1368,19 @@ level; 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;
 };
- -

+

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 is set to yes, then the date and time are logged. print-time may be specified for a @@ -1484,18 +1398,15 @@ three print- options are on:

- -

+

28-Feb-2000 15:05:32.863 general: notice: running

- -

+

If buffered has been turned on, the output to files is not flushed after each log entry. By default all log messages are flushed.

- -

+

There are four predefined channels that are used for named's default logging, as follows. If named is started with the @@ -1504,7 +1415,6 @@ How they are used is described in the section called “The category Phrase”.

- 
channel default_syslog {
     // send to syslog's daemon facility
     syslog daemon;
@@ -1542,8 +1452,7 @@ channel default_logfile {
     severity dynamic;
 };
- -

+

The default_debug channel has the special property that it only produces output when the server's debug @@ -1551,8 +1460,7 @@ channel default_logfile { non-zero. 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 @@ -1563,19 +1471,16 @@ channel default_logfile { option to specify a default logfile, or the -g option to log to standard error which can be redirected to a file.

- -

+

Once a channel is defined, it cannot be redefined. The built-in channels cannot be altered directly, but the default logging can be modified by pointing categories at defined channels.

-
- -
+
+

The category Phrase

- -

+

There are many categories, so desired logs can be sent anywhere while unwanted logs are ignored. If a list of channels is not specified for a category, log @@ -1584,24 +1489,19 @@ channel default_logfile { instead. If no default category is specified, the following "default default" is used:

- 
category default { default_syslog; default_debug; };
- -

+

If named is started with the -L option, the default category is:

- 
category default { default_logfile; default_debug; };
- -

+

As an example, let's say a user wants to log security events to a file, but also wants to keep the default logging behavior. They would specify the following:

- 
channel my_security_channel {
     file "my_security_file";
     severity info;
@@ -1611,22 +1511,18 @@ category security {
     default_syslog;
     default_debug;
 };
- -

+

To discard all messages in a category, specify the null channel:

- 
category xfer-out { null; };
 category notify { null; };
- -

+

The 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.

-
- +
@@ -2006,13 +1902,12 @@ category notify { null; }; -
+
-
-
+

The query-errors Category

-

+

The query-errors category is used to indicate why and how specific queries resulted in responses which indicate an error. Normally, these messages @@ -2021,27 +1916,26 @@ category notify { null; }; logged at info. The logging levels are described below:

- -

+

At debug level 1 or higher - or at info, when query logging is active - each response with response code 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. Log messages of this level are particularly helpful in identifying the cause of SERVFAIL for an authoritative server.

-

+

At debug level 2 or higher, detailed context information about recursive resolutions that resulted in SERVFAIL is logged. The log message looks like this:

-

+

@@ -2052,14 +1946,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 10.000183 seconds, and the final result that led to the SERVFAIL was determined at line 2970 of source file resolver.c.

-

+

The next part shows the detected final result and the latest result of DNSSEC validation. The latter is always "success" when no validation attempt was made. In this example, @@ -2067,7 +1961,7 @@ badresp:1,adberr:0,findfail:0,valfail:0] servers are down or unreachable, leading to a timeout in 10 seconds. DNSSEC validation was probably not attempted.

-

+

The last part, enclosed in square brackets, shows statistics collected for this particular resolution attempt. The domain field shows the deepest zone that @@ -2075,9 +1969,7 @@ badresp:1,adberr:0,findfail:0,valfail:0] finally detected. The meaning of the other fields is summarized in the following table.

- -
- +
@@ -2228,33 +2120,29 @@ badresp:1,adberr:0,findfail:0,valfail:0] -
-
-

+

+

At debug level 3 or higher, the same messages as those at debug level 1 are logged for errors other than SERVFAIL. Note that negative responses such as NXDOMAIN are not errors, and are not logged at this debug level.

-

+

At debug level 4 or higher, the detailed context information logged at debug level 2 is logged for errors other than SERVFAIL and for negative responses such as NXDOMAIN.

-
-
- -
+
+
+

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 ] ; )
@@ -2267,13 +2155,11 @@ badresp:1,adberr:0,findfail:0,valfail:0]
   [ lwres-clients number; ]
 };
- -
-
+
+

lwres Statement Definition and Usage

- -

+

The lwres statement configures the name server to also act as a lightweight resolver server. (See @@ -2281,8 +2167,7 @@ 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 @@ -2293,8 +2178,7 @@ 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 @@ -2305,8 +2189,7 @@ badresp:1,adberr:0,findfail:0,valfail:0] is used; if there is no default view, an error is triggered.

- -

+

The search statement is equivalent to the search statement in @@ -2314,8 +2197,7 @@ 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 @@ -2324,14 +2206,14 @@ 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.

-

+

The lwres-tasks statement specifies the number of worker threads the lightweight resolver dedicates to serving clients. By default, the number is the same as the number of CPUs on the system; this can be overridden using the -n command-line option when starting the server.

-

+

The lwres-clients statement specifies the number of client objects per thread the lightweight resolver should create to serve client queries. @@ -2344,44 +2226,40 @@ badresp:1,adberr:0,findfail:0,valfail:0] Note that setting too high a value may overconsume system resources.

-

+

The maximum number of client queries that the lightweight resolver can handle at any one time equals lwres-tasks times lwres-clients.

-
-
+
+

masters Statement Grammar

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

-
- -
+
+

masters Statement Definition and Usage

- -

masters +

masters lists allow for a common set of primaries to be easily used by multiple stub and secondary 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 {
 	acache-cleaning-interval integer;
 	acache-enable boolean;
@@ -2657,14 +2535,12 @@ badresp:1,adberr:0,findfail:0,valfail:0]
 	zone-statistics ( full | terse | none | boolean );
 };
 

-
- -
+
+

options Statement Definition and Usage

- -

+

The options statement sets up global options to be used by BIND. This statement @@ -2673,11 +2549,10 @@ badresp:1,adberr:0,findfail:0,valfail:0] statement, an options block with each option set to its default is used.

- -
+
attach-cache
-

+

This option allows multiple views to share a single cache database. Each view has its own cache database by default, but @@ -2686,15 +2561,13 @@ 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 @@ -2704,16 +2577,14 @@ badresp:1,adberr:0,findfail:0,valfail:0] The rest of the views simply refer to the already-created cache.

- -

+

One common configuration to share a cache is to allow all views to share a single cache. This can be done by specifying 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 retain their own caches. @@ -2722,7 +2593,6 @@ badresp:1,adberr:0,findfail:0,valfail:0] attach-cache option as a view of A (or B)'s option, referring to the other view name:

- 
   view "A" {
     // this view has its own cache
@@ -2737,8 +2607,7 @@ 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 @@ -2753,8 +2622,7 @@ 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. @@ -2766,10 +2634,9 @@ badresp:1,adberr:0,findfail:0,valfail:0] configuration differences in different views do not cause disruption with a shared cache.

-
+
directory
-
-

+

This sets the working directory of the server. Any non-absolute pathnames in the configuration file are taken as relative to this directory. The default @@ -2782,11 +2649,10 @@ badresp:1,adberr:0,findfail:0,valfail:0] strongly recommended that the directory be writable by the effective user ID of the named process. -

-
+

dnstap
-

+

dnstap is a fast, flexible method for capturing and logging DNS traffic. Developed by Robert Edmonds at Farsight Security, Inc., and supported @@ -2801,13 +2667,13 @@ badresp:1,adberr:0,findfail:0,valfail:0] by Google, Inc.; see https://developers.google.com/protocol-buffers).

-

+

To enable dnstap at compile time, the fstrm and protobuf-c libraries must be available, and BIND must be configured with --enable-dnstap.

-

+

The dnstap option is a bracketed list of message types to be logged. These may be set differently for each view. Supported types are client, @@ -2816,13 +2682,13 @@ badresp:1,adberr:0,findfail:0,valfail:0] all causes all dnstap messages to be logged, regardless of type.

-

+

Each type may take an additional argument to indicate whether to log query messages or response messages; if not specified, both queries and responses are logged.

-

+

Example: To log all authoritative queries and responses, recursive client responses, and upstream queries sent by the resolver, use: @@ -2835,100 +2701,86 @@ badresp:1,adberr:0,findfail:0,valfail:0]

-

+

Logged dnstap messages can be parsed using the dnstap-read utility (see dnstap-read(1) for details).

-

+

For more information on dnstap, see http://dnstap.info.

-

+

The fstrm library has a number of tunables that are exposed in named.conf, and can be modified if necessary to improve performance or prevent loss of data. These are:

-
    +
    • - fstrm-set-buffer-hint: The threshold number of bytes to accumulate in the output buffer before forcing a buffer flush. The minimum is 1024, the maximum is 65536, and the default is 8192. - -
      • +
    • - fstrm-set-flush-timeout: The number of seconds to allow unflushed data to remain in the output buffer. The minimum is 1 second, the maximum is 600 seconds (10 minutes), and the default is 1 second. - -
      • +
    • - fstrm-set-output-notify-threshold: The number of outstanding queue entries to allow on an input queue before waking the I/O thread. The minimum is 1 and the default is 32. - -
      • +
    • - fstrm-set-output-queue-model: The queuing semantics to use for queue objects. The default is mpsc (multiple producer, single consumer); the other option is spsc (single producer, single consumer). - -
      • +
    • - fstrm-set-input-queue-size: The number of queue entries to allocate for each input queue. This value must be a power of 2. The minimum is 2, the maximum is 16384, and the default is 512. - -
      • +
    • - fstrm-set-output-queue-size: The number of queue entries to allocate for each output queue. The minimum is 2, the maximum is system-dependent and based on IOV_MAX, and the default is 64. - -
      • +
    • - fstrm-set-reopen-interval: The number of seconds to wait between attempts to reopen a closed output stream. The minimum is 1 second, the maximum is 600 seconds (10 minutes), and the default is 5 seconds. - -
      • +
    -

    +

    Note that all of the above minimum, maximum, and default values are set by the libfstrm library, and may be subject to change in future versions of the library. See the libfstrm documentation for more information.

    -
+
dnstap-output
-

+

This configures the path to which the dnstap frame stream is sent if dnstap is enabled at compile time and active.

-

+

The first argument is either file or unix, indicating whether the destination is a file or a Unix domain socket. The second argument @@ -2939,7 +2791,7 @@ badresp:1,adberr:0,findfail:0,valfail:0] (provided with libfstrm) is listening on the socket.)

-

+

dnstap-output can only be set globally in options. Currently, it can only be set once while named is running; @@ -2947,29 +2799,24 @@ badresp:1,adberr:0,findfail:0,valfail:0] rndc reload or rndc reconfig.

-
+
dnstap-identity
-
-

+

This specifies an identity string to send in dnstap messages. If set to hostname, which is the default, the server's hostname is sent. If set to none, no identity string is sent. -

-
+

dnstap-version
-
-

+

This specifies a version string to send in dnstap messages. The default is the version number of the BIND release. If set to none, no version string is sent. -

-
+

geoip-directory
-
-

+

When named is compiled using the MaxMind GeoIP2 geolocation API, or the legacy GeoIP API, this specifies the directory containing GeoIP @@ -2983,11 +2830,9 @@ badresp:1,adberr:0,findfail:0,valfail:0] directory. See the section called “acl Statement Definition and Usage” for details about geoip ACLs. -

-
+

key-directory
-
-

+

This is the directory where the public and private DNSSEC key files should be found when performing a dynamic update of secure zones, if different than the current working @@ -2996,11 +2841,10 @@ badresp:1,adberr:0,findfail:0,valfail:0] bind.keys, rndc.key, or session.key.) -

-
+

lmdb-mapsize
-

+

When named is built with liblmdb, this option sets a maximum size for the memory map of the new-zone database (NZD) in LMDB database format. @@ -3009,7 +2853,7 @@ badresp:1,adberr:0,findfail:0,valfail:0] Note that this is not the NZD database file size, but the largest size that the database may grow to.

-

+

Because the database file is memory mapped, its size is limited by the address space of the named process. The default of 32 megabytes was chosen to be usable with @@ -3019,17 +2863,17 @@ badresp:1,adberr:0,findfail:0,valfail:0] ought to be able to hold configurations of about 100,000 zones.

-
+
managed-keys-directory
-

+

This specifies the directory in which to store the files that track managed DNSSEC keys. By default, this is the working directory. The directory must be writable by the effective user ID of the named process.

-

+

If named is not configured to use views, managed keys for the server are tracked in a single file called managed-keys.bind. @@ -3040,35 +2884,30 @@ badresp:1,adberr:0,findfail:0,valfail:0] followed by the extension .mkeys.

-

+

(Note: in earlier releases, file names for views always used the SHA256 hash of the view name. To ensure compatibility after upgrading, if a file using the old name format is found to exist, it is used instead of the new format.)

-
+
named-xfer
-
-

+

This option is obsolete. In BIND 9, no separate named-xfer program is needed; its functionality is built into the name server. -

-
+

tkey-gssapi-keytab
-
-

+

This is the KRB5 keytab file to use for GSS-TSIG updates. If this option is set and tkey-gssapi-credential is not set, updates are allowed with any key matching a principal in the specified keytab. -

-
+

tkey-gssapi-credential
-
-

+

This is the security credential with which the server should authenticate keys requested by the GSS-TSIG protocol. Currently only Kerberos 5 authentication is available; @@ -3081,11 +2920,9 @@ 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
-
-

+

This domain is appended to the names of all shared keys generated with TKEY. When a client requests a TKEY exchange, @@ -3101,11 +2938,9 @@ badresp:1,adberr:0,findfail:0,valfail:0] "_tkey.domainname". If using GSS-TSIG, this variable must be defined, unless a specific keytab is specified using tkey-gssapi-keytab. -

-
+

tkey-dhkey
-
-

+

This is the Diffie-Hellman key used by the server to generate shared keys with clients using the Diffie-Hellman mode @@ -3114,34 +2949,27 @@ 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
-
-

+

This is 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
-
-

+

This is the pathname of the file the server writes memory usage statistics to on exit. If not specified, the default is named.memstats. -

-
+

lock-file
-

+

This is the pathname of a file on which named attempts to acquire a file lock when starting for the first time; if unsuccessful, the server @@ -3149,7 +2977,7 @@ badresp:1,adberr:0,findfail:0,valfail:0] server is already running. If not specified, the default is none.

-

+

Specifying lock-file none disables the use of a lock file. lock-file is ignored if named was run using the -X @@ -3159,10 +2987,9 @@ badresp:1,adberr:0,findfail:0,valfail:0] reconfigured; it is only effective when the server is first started.

-
+
pid-file
-
-

+

This is the pathname of the file the server writes its process ID in. If not specified, the default is /var/run/named/named.pid. @@ -3174,51 +3001,41 @@ badresp:1,adberr:0,findfail:0,valfail:0] is a keyword, not a filename, and therefore is not enclosed in double quotes. -

-
+

recursing-file
-
-

+

This is the pathname of the file where 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
-
-

+

This is 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
-
-

+

This is the pathname of a file to override the built-in trusted keys provided by named. See the discussion of dnssec-validation for details. If not specified, the default is /etc/bind.keys. -

-
+

secroots-file
-
-

+

This is 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
-
-

+

This is 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 @@ -3228,27 +3045,21 @@ badresp:1,adberr:0,findfail:0,valfail:0] update-policy statement's local option for more information about this feature.) -

-
+

session-keyname
-
-

+

This is the key name to use for the TSIG session key. If not specified, the default is local-ddns. -

-
+

session-keyalg
-
-

+

This is 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
-
-

+

This is the UDP/TCP port number the server uses to receive and send DNS protocol traffic. The default is 53. This option is mainly intended for server @@ -3256,20 +3067,16 @@ badresp:1,adberr:0,findfail:0,valfail:0] a server using a port other than 53 is not able to communicate with the global DNS. -

-
+

dscp
-
-

+

This is 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
-
-

+

This specifies a source of entropy to be used by the server. Entropy is primarily needed for DNSSEC operations, such as TKEY transactions and dynamic @@ -3286,36 +3093,33 @@ 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) is 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
-

+

This turns 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 @@ -3331,26 +3135,24 @@ 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 that 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
-

+

This disables the specified DNSSEC algorithms at and below the specified name. Multiple disable-algorithms @@ -3358,21 +3160,21 @@ options { Only the best-match disable-algorithms clause is used to determine the algorithms.

-

+

If all supported algorithms are disabled, the zones covered by the disable-algorithms setting are treated as insecure.

-

+

Configured trust anchors in trusted-keys or managed-keys that match a disabled algorithm are ignored and treated as if they were not configured.

-
+
disable-ds-digests
-

+

This disables the specified DS digest types at and below the specified name. Multiple disable-ds-digests @@ -3380,15 +3182,15 @@ options { Only the best-match disable-ds-digests clause is used to determine the digest types.

-

+

If all supported digest types are disabled, the zones covered by disable-ds-digests are 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 @@ -3400,12 +3202,12 @@ 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 no, then dnssec-lookaside is not used.

-

+

Note: the ISC-provided DLV service at dlv.isc.org has been shut down. The dnssec-lookaside auto; @@ -3413,10 +3215,9 @@ options { to use ISC DLV with minimal configuration, has accordingly been removed.

-
+
dnssec-must-be-secure
-
-

+

This specifies hierarchies which must be or may not be secure (signed and validated). If yes, then named only accepts answers if @@ -3426,11 +3227,10 @@ options { trusted-keys or managed-keys statement, or dnssec-validation auto 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 @@ -3438,13 +3238,13 @@ 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, per RFC 6052. Bits 64..71 inclusive must be zero, with the most significant bit of the prefix in position 0.

-

+

In addition, a reverse IP6.ARPA zone is created for the prefix to provide a mapping from the IP6.ARPA names to the corresponding IN-ADDR.ARPA names using synthesized @@ -3454,20 +3254,20 @@ options { can be set at the view/options level but not 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 does not apply to a domain name that owns one or more AAAA records; these records are simply returned. The optional @@ -3478,7 +3278,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 @@ -3486,13 +3286,13 @@ options { matching the prefix and mapped IPv4 address must be zero.

-

+

If recursive-only is set to yes, the DNS64 synthesis only happens for recursive queries. The default is no.

-

+

If break-dnssec is set to yes, the DNS64 synthesis happens even if the result, if validated, would @@ -3511,10 +3311,9 @@ 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 @@ -3527,11 +3326,10 @@ 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 @@ -3544,13 +3342,13 @@ options { by regenerating RRSIG records whenever they approach their expiration date.

-

+

If the option is changed to no-resign, then named signs all new or changed records, but scheduled maintenance of signatures is disabled.

-

+

With either of these settings, named rejects updates to a DNSSEC-signed zone when the signing keys are inactive or unavailable to @@ -3559,15 +3357,15 @@ options { signing and allow DNSSEC data to be submitted into a zone via dynamic update; this is not yet implemented.)

-
+
nta-lifetime
-

+

This specifies the default lifetime, in seconds, for negative trust anchors added via rndc nta.

-

+

A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration, rather than @@ -3579,21 +3377,21 @@ options { NTA's lifetime is elapsed. NTAs persist across named restarts.

-

+

For convenience, TTL-style time-unit suffixes can be used to specify the NTA lifetime in seconds, minutes, or hours. nta-lifetime defaults to one hour; it cannot exceed one week.

-
+
nta-recheck
-

+

This specifies how often to check whether negative trust anchors added via rndc nta are still necessary.

-

+

A negative trust anchor is normally used when a domain has stopped validating due to operator error; it temporarily disables DNSSEC validation for that @@ -3604,23 +3402,23 @@ options { to find out whether it can now be validated. If so, the negative trust anchor is allowed to expire early.

-

+

Validity checks can be disabled for an individual NTA by using rndc nta -f, or for all NTAs by setting nta-recheck to zero.

-

+

For convenience, TTL-style time-unit suffixes can be used to specify the NTA recheck interval in seconds, minutes, or hours. The default is five minutes. It cannot be longer than nta-lifetime, which cannot be longer than a week.

-
+
max-zone-ttl
-

+

This specifies a maximum permissible TTL value in seconds. For convenience, TTL-style time-unit suffixes may be used to specify the maximum value. @@ -3631,7 +3429,7 @@ options { max-zone-ttl causes 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 @@ -3639,31 +3437,31 @@ options { that the largest TTL in the zone is no higher than 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 to be used for the zone serial number in the SOA record.

-

+

With the default setting of serial-update-method increment;, the SOA serial number is incremented by one each time the zone is updated.

-

+

When set to serial-update-method unixtime;, the SOA serial number is set to the number of seconds @@ -3671,7 +3469,7 @@ options { already greater than or equal to that value, in which case it is simply incremented by one.

-

+

When set to serial-update-method date;, the new SOA serial number is the current date @@ -3680,10 +3478,10 @@ options { than or equal to that value, in which case it is incremented by one.

-
+
zone-statistics
-

+

If full, the server collects statistical data on all zones, unless specifically turned off on a per-zone basis by specifying @@ -3695,7 +3493,7 @@ options { current serial number, but not query type counters).

-

+

These statistics may be accessed via the statistics-channel or using rndc stats, which @@ -3703,7 +3501,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 @@ -3714,17 +3512,15 @@ options { as none; previously, it was the same as terse.

-
+
- -
+

Boolean Options

- -
+
automatic-interface-scan
-

+

If yes and supported by the operating system, this automatically rescans network interfaces when the interface addresses are added or removed. The default is @@ -3735,21 +3531,21 @@ options { confirms that automatic interface scanning is supported by the operating system.

-

+

The automatic-interface-scan implementation uses routing sockets for the network interface discovery; therefore, the operating system must support the routing sockets for this feature to work.

-
+
allow-new-zones
-

+

If yes, then zones can be added at runtime via rndc addzone. The default is no.

-

+

Newly added zones' configuration parameters are stored so that they can persist after the server is restarted. The configuration information @@ -3763,7 +3559,7 @@ options { incompatible with use as a file name, in which case a cryptographic hash of the view name is used instead.

-

+

Configurations for zones added at runtime are stored either in a new-zone file (NZF) or a new-zone database (NZD), depending on whether @@ -3772,38 +3568,32 @@ options { See rndc(8) for further details about rndc addzone.

-
+
auth-nxdomain
-
-

+

If yes, then the AA bit is always set on NXDOMAIN responses, even if the server is not actually authoritative. The default is no. -

-
+

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
-
-

+

This writes 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 @@ -3818,12 +3608,12 @@ options { normal zone maintenance traffic. The default is no.

-

+

If specified in the view and zone statements, the dialup option overrides the global dialup option.

-

+

If the zone is a primary zone, the server sends out a NOTIFY request to all the secondaries (default). This should trigger the @@ -3835,7 +3625,7 @@ options { by notify and also-notify.

-

+

If the zone is a secondary or stub zone, the server suppresses the regular @@ -3845,7 +3635,7 @@ options { addition to sending NOTIFY requests.

-

+

Finer control can be achieved by using notify, which only sends NOTIFY messages; @@ -3860,9 +3650,7 @@ options { refresh processing.

- -
- +
@@ -4013,27 +3801,21 @@ 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 @@ -4042,31 +3824,25 @@ 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 upon receiving SIGTERM, flush or do not flush any pending zone writes. The default is flush-zones-on-shutdown no. -

-
+

geoip-use-ecs
-
-

+

When BIND is compiled with GeoIP support and configured with "geoip" ACL elements, this option indicates whether the EDNS Client Subnet option, if present in a request, should be used for matching against the GeoIP database. The default is geoip-use-ecs yes. -

-
+

has-old-clients
-
-

+

This option was incorrectly implemented in BIND 8, and is ignored by BIND 9. To achieve the intended effect @@ -4074,28 +3850,22 @@ options { has-old-clients yes, specify the two separate options auth-nxdomain yes and rfc2308-type1 no instead. -

-
+

host-statistics
-
-

+

In BIND 8, this enabled keeping of statistics for every host that the name server interacts with. It is not implemented in BIND 9. -

-
+

root-key-sentinel
-
-

+

If yes, respond to root key sentinel probes as described in draft-ietf-dnsop-kskroll-sentinel-08. The default is yes. -

-
+

maintain-ixfr-base
-
-

+

This option is obsolete. It was used in BIND 8 to determine whether a transaction log was @@ -4103,11 +3873,9 @@ options { log whenever possible. To disable outgoing incremental zone transfers, use provide-ixfr no. -

-
+

message-compression
-
-

+

If yes, DNS name compression is used in responses to regular queries (not including AXFR or IXFR, which always use compression). Setting @@ -4117,18 +3885,17 @@ options { to be processed using TCP; a server with compression disabled is out of compliance with RFC 1123 Section 6.1.3.2. The default is yes. -

-
+

minimal-responses
-

+

If set to yes, then when generating responses the server only adds 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.

-

+

When set to no-auth, the server omits records from the authority section unless they are required, but it may still add @@ -4141,13 +3908,12 @@ options { designed for mixed-mode servers that handle both authoritative and recursive queries.

-

+

The default is no.

-
+
minimal-any
-
-

+

If set to yes, the server replies with only one of the RRsets for the query name, and its covering RRSIGs if any, when @@ -4164,21 +3930,18 @@ options { turned on for these queries, so no unnecessary records are added to the authority or additional sections. 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 primary files and dynamic updates. -

-
+

notify
-

+

If yes (the default), DNS NOTIFY messages are sent when a zone the server is authoritative for @@ -4189,7 +3952,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 primary zones. @@ -4198,7 +3961,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, @@ -4207,10 +3970,9 @@ options { caused secondary zones to crash.

-
+
notify-to-soa
-
-

+

If yes, do not check the name servers in the NS RRset against the SOA MNAME. Normally a NOTIFY message is not sent to the SOA MNAME (SOA ORIGIN), as it is @@ -4219,11 +3981,9 @@ options { hidden primary configurations; in that case, the ultimate primary should be set to still send NOTIFY messages to all the name servers listed in the NS RRset. -

-
+

recursion
-
-

+

If yes, and a DNS query requests recursion, then the server attempts to do @@ -4239,11 +3999,9 @@ 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 @@ -4252,24 +4010,21 @@ options { the resolver category at level info. The default is no. -

-
+

request-sit
-
-

+

This experimental option is obsolete. -

-
+

require-server-cookie
-

+

If yes, require a valid server cookie before sending a full response to a UDP request from a cookie-aware client. BADCOOKIE is sent if there is a bad or nonexistent server cookie. The default is no.

-

+

Users wishing to test that DNS COOKIE clients correctly handle BADCOOKIE, or who are getting a lot of forged DNS requests with DNS COOKIES present, should set this to yes. @@ -4279,10 +4034,10 @@ options { a full response, while also requiring a legitimate client to follow up with a second query with the new, valid, cookie.

-
+
answer-cookie
-

+

When set to the default value of yes, COOKIE EDNS options are sent when applicable in replies to client queries. If set to @@ -4290,7 +4045,7 @@ options { sent in replies. This can only be set at the global options level, not per-view.

-

+

answer-cookie no is only intended as a temporary measure, for use when named shares an IP address with other servers that do not yet @@ -4302,10 +4057,9 @@ options { security mechanism, and should not be disabled unless absolutely necessary.

-
+
send-cookie
-
-

+

If yes, then a COOKIE EDNS option is sent along with the query. If the resolver has previously communicated with the server, the @@ -4322,36 +4076,30 @@ options { to receiving smaller responses via the nocookie-udp-size option. The default is yes. -

-
+

nocookie-udp-size
-
-

+

This sets the maximum size of UDP responses that are sent to queries without a valid server COOKIE. A value below 128 is silently raised to 128. The default - value is 1232, but the max-udp-size - option may further limit the response size. -

-
+ value is 4096, but the max-udp-size + option may further limit the response size as the default + for max-udp-size is 1232. +

sit-secret
-
-

+

This experimental option is obsolete. -

-
+

cookie-algorithm
-
-

+

This sets the algorithm to be used when generating the server cookie; the options are "aes", "sha1", or "sha256". The default is "aes" if supported by the cryptographic library; otherwise, "sha256". -

-
+

cookie-secret
-

+

If set, this is a shared secret used for generating and verifying EDNS COOKIE options within an anycast cluster. If not set, the system @@ -4360,39 +4108,39 @@ options { to be 128 bits for AES128, 160 bits for SHA1, and 256 bits for SHA256.

-

+

If there are multiple secrets specified, the first one listed in named.conf is used to generate new server cookies. The others are only used to verify returned cookies.

-
+
rfc2308-type1
-

+

Setting this to yes causes the server to send NS records along with the SOA record for negative answers. The default is no.

-
+

Note

-

+

This is not yet implemented in BIND 9.

-
-
+
+
trust-anchor-telemetry
-

+

This causes named to send specially formed queries once per day to domains for which trust anchors have been configured via trusted-keys, managed-keys, or dnssec-validation 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 @@ -4400,27 +4148,24 @@ 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 are 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. To disable IXFR to a particular server or servers, see @@ -4429,38 +4174,30 @@ 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”. -

-
+

request-expire
-
-

+

See the description of request-expire 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 @@ -4471,22 +4208,19 @@ 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 @@ -4506,8 +4240,7 @@ 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 are provided as well, @@ -4517,8 +4250,7 @@ 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 @@ -4527,8 +4259,7 @@ 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 @@ -4538,8 +4269,7 @@ 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 @@ -4557,16 +4287,15 @@ options { upwards referrals are not required for the resolution process.

- -
+
match-mapped-addresses
-

+

If yes, then an IPv4-mapped IPv6 address matches 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 @@ -4575,10 +4304,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 @@ -4592,7 +4321,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, @@ -4600,13 +4329,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 causes the response to not verify, because the DNSSEC protocol is designed to 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, @@ -4614,31 +4343,29 @@ options { via IPv4, is 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
-
-

+

This is 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 primary zone from its zone file or receives a new version of a secondary file via zone transfer, it @@ -4648,7 +4375,7 @@ options { transmitted to downstream secondaries 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 @@ -4660,7 +4387,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 @@ -4668,15 +4395,14 @@ options { all primary or secondary zones, respectively. It is off by default.

-

+

Note: if inline signing is enabled for a zone, the user-provided ixfr-from-differences setting is ignored for that zone.

-
+
multi-master
-
-

+

This should be set when there are multiple primary servers for a zone and the addresses refer to different machines. If yes, named does @@ -4684,22 +4410,21 @@ options { when the serial number on the primary 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 a schedule, according to the keys' timing metadata @@ -4722,31 +4447,29 @@ 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 does not return DNSSEC-related resource records unless specifically queried for. The default is yes. -

-
+

dnssec-validation
-

+

This option enables DNSSEC validation in named. Note that dnssec-enable also needs to be set to yes to be effective. If set to no, DNSSEC validation is disabled.

-

+

If set to auto, DNSSEC validation is enabled and a default trust anchor for the DNS root zone is used. If set to yes, @@ -4755,7 +4478,7 @@ options { or managed-keys statement. The default is yes.

-

+

The default root trust anchor is stored in the file bind.keys. named loads that key at @@ -4766,16 +4489,16 @@ options { bind.keys can be downloaded from https://www.isc.org/bind-keys.

-

+

(To prevent problems if bind.keys is not found, the current trust anchor 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 root key expires.)

-
+

Note

-

+

named loads only the root key from bind.keys. The file cannot be used to store keys for other zones. @@ -4783,34 +4506,32 @@ options { if dnssec-validation auto is not in use.

-

+

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
-
-

+

This accepts expired signatures when verifying DNSSEC signatures. The default is no. Setting this option to yes leaves named vulnerable to replay attacks. -

-
+

querylog
-

+

Query logging provides a complete log of all incoming queries and all query errors. This provides more insight into the server's activity, but with a cost to performance which may be significant on heavily loaded servers.

-

+

The querylog option specifies whether query logging should be active when named first starts. @@ -4821,10 +4542,10 @@ options { command rndc querylog on, or deactivated with rndc querylog off.

-
+
check-names
-

+

This option is used to restrict the character set and syntax of certain domain names in zone files and/or DNS responses @@ -4838,11 +4559,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. @@ -4850,29 +4571,24 @@ options { name indicates 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
-
-

+

This checks primary 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
-
-

+

This checks 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 @@ -4880,11 +4596,10 @@ options { This option affects primary zones. The default (yes) is to check for non-terminal wildcards and issue a warning. -

-
+

check-integrity
-

+

This performs post-load zone integrity checks on primary zones. It checks that MX and SRV records refer to address (A or AAAA) records and that glue @@ -4897,7 +4612,7 @@ options { checks, use named-checkzone). The default is yes.

-

+

The use of the SPF record to publish Sender Policy Framework is deprecated, as the migration from using TXT records to SPF records was abandoned. @@ -4907,65 +4622,53 @@ options { TXT record does not exist; they 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, 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
-
-

+

If yes, 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
-
-

+

If yes, when caching a negative response to an 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 @@ -4976,7 +4679,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 @@ -4984,10 +4687,10 @@ options { this requirement is not met, this option is 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) are used @@ -4997,23 +4700,21 @@ 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
-
-

+

If yes, try to refresh the zone using TCP if UDP queries fail. The default is yes. -

-
+

dnssec-secure-to-insecure
-

+

This allows 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. @@ -5021,30 +4722,27 @@ options { at the zone apex is deleted, all RRSIG and NSEC records are removed from the zone as well.

-

+

If the zone uses NSEC3, it is also necessary to delete the NSEC3PARAM RRset from the zone apex; this causes 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 @@ -5054,11 +4752,9 @@ 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 is the default and causes the server to query the forwarders @@ -5068,21 +4764,17 @@ options { the answer itself. If only is specified, the server only queries the forwarders. -

-
+

forwarders
-
-

+

This specifies a list of IP addresses to which queries are forwarded. The default is the empty list (no forwarding). Each address in the list can be associated with an optional port number and/or DSCP value, and a default port number and DSCP value can be set for the entire list. -

-
+

- -

+

Forwarding can also be configured on a per-domain basis, allowing for the global forwarding options to be overridden in a variety of ways. Particular domains can be set to use different @@ -5091,24 +4783,20 @@ 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
-
-

+

This 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 @@ -5116,26 +4804,20 @@ options { machine is dual-stacked, the dual-stack-servers parameter has 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
-
-

+

This ACL specifies which hosts are allowed to notify this secondary server of zone changes in addition to the zone primaries. @@ -5148,11 +4830,10 @@ options { for a secondary zone. If not specified, the default is to process notify messages only from a zone's primary. -

-
+

allow-query
-

+

This specifies which hosts are allowed to ask ordinary DNS questions. allow-query may also be specified in the zone @@ -5161,50 +4842,49 @@ options { If not specified, the default is to allow queries from all hosts.

-
+

Note

-

+

allow-query-cache is used to specify access to the cache.

-
-
+
+
allow-query-on
-

+

This 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 is 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
-
-

+

This specifies which hosts are allowed to get answers from the cache. If allow-query-cache is not set, BIND checks to see if the following parameters @@ -5214,21 +4894,17 @@ options { set, in which case none; is used). If neither of those parameters is set, the default (localnets; localhost;) is used. -

-
+

allow-query-cache-on
-
-

+

This specifies which local addresses can send answers from the cache. If not specified, the default is to allow cache queries on any address, localnets, and localhost. -

-
+

allow-recursion
-
-

+

This specifies which hosts are allowed to make recursive queries through this server. BIND checks to see if the following parameters are set, in order: @@ -5237,30 +4913,25 @@ options { If none of those parameters are set, the default (localnets; localhost;) is used. -

-
+

allow-recursion-on
-
-

+

This specifies which local addresses can accept recursive queries. If not specified, the default is to allow recursive queries on all addresses. -

-
+

allow-update
-
-

+

This specifies which hosts are allowed to submit Dynamic DNS updates for primary 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
-

+

This specifies which hosts are allowed to submit Dynamic DNS updates to secondary zones to be forwarded to the @@ -5277,7 +4948,7 @@ options { with the primary server, not the secondaries.

-

+

Note that enabling the update forwarding feature on a secondary server may expose primary servers to attacks if they rely on insecure @@ -5285,10 +4956,9 @@ options { access control; 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. @@ -5296,11 +4966,9 @@ options { deprecated, this option was also deprecated. It is now ignored with some warning messages. -

-
+

allow-transfer
-
-

+

This specifies which hosts are allowed to receive zone transfers from the server. allow-transfer may also be specified in the zone @@ -5308,40 +4976,33 @@ options { case it overrides the options allow-transfer statement. If not specified, the default is to allow transfers to all hosts. -

-
+

blackhole
-
-

+

This specifies a list of addresses which the server does accept queries from or use to resolve a query. Queries from these addresses are not responded to. The default is none. -

-
+

filter-aaaa
-
-

+

This specifies a list of addresses to which filter-aaaa-on-v4 and filter-aaaa-on-v6 apply. The default is any. -

-
+

keep-response-order
-
-

+

This specifies a list of addresses to which the server sends responses to TCP queries, in the same order in which they were received. This disables the processing of TCP queries in parallel. The default is none. -

-
+

no-case-compress
-

+

This specifies a list of addresses which require responses to use case-insensitive compression. This ACL can be used when named needs to work with @@ -5349,7 +5010,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 is used for all clients. If the ACL is defined and @@ -5357,7 +5018,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 treats @@ -5369,12 +5030,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 does not preserve the case of owner names of records: if a zone file defines records of different types with @@ -5389,10 +5050,9 @@ options { have their case preserved unless the client matches this ACL.

-
+
resolver-query-timeout
-
-

+

This is the amount of time in seconds that the resolver spends attempting to resolve a recursive query before failing. The default and minimum @@ -5400,17 +5060,13 @@ options { 30. Setting it to 0 results in the default being used. -

-
+

- -
- -
+
+

Interfaces

- -

+

The interfaces and ports that the server answers queries from may be specified using the listen-on option. listen-on takes an optional port and an address_match_list @@ -5419,35 +5075,30 @@ options { The server listens on all interfaces allowed by the address match list. If a port is not specified, port 53 is 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; };
- -

+

enables 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 listens 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 listens for incoming queries sent using IPv6. If not specified, the server listens on port 53 on all IPv6 interfaces.

- -

+

When 

{ any; }

is @@ -5462,8 +5113,7 @@ 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 @@ -5472,38 +5122,30 @@ listen-on port 1234 { !1.2.3.4; 1.2/16; }; IPv4 addresses specified in listen-on-v6 are 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; };
- -

+

enables the name server on port 53 for any IPv6 addresses (with a single wildcard socket), and on port 1234 of IPv6 addresses that are not in the prefix 2001:db8::/32 (with separate sockets for each matched address).

- -

+

To instruct the server not to listen on any IPv6 address, use:

- 
listen-on-v6 { none; };
- -
- -
+
+

Query Address

- -

+

If the server does not know the answer to a question, it queries other name servers. query-source specifies the address and port used for such queries. For queries sent over @@ -5512,8 +5154,7 @@ listen-on-v6 port 1234 { !2001:db8::/32; any; }; a wildcard IP address (INADDR_ANY) is used.

- -

+

If port is * or is omitted, a random port number from a pre-configured range is picked up and used for each query. @@ -5524,18 +5165,15 @@ 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 checks whether the operating @@ -5545,12 +5183,10 @@ query-source-v6 address * port *; named uses the corresponding system default range; otherwise, it uses its own defaults:

- 
use-v4-udp-ports { range 1024 65535; };
 use-v6-udp-ports { range 1024 65535; };
- -

+

Note: make sure the ranges are sufficiently large for security. A desirable size depends on several parameters, but we generally recommend it contain at least 16384 ports @@ -5566,8 +5202,7 @@ 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 do not allow @@ -5579,18 +5214,15 @@ 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 @@ -5602,67 +5234,57 @@ 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
-

+

This option defines a global list of IP addresses of name servers that are also sent NOTIFY messages whenever a fresh copy of the @@ -5680,7 +5302,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 overrides @@ -5693,46 +5315,37 @@ avoid-v6-udp-ports {}; the empty list (no global notification list).

-
+
max-transfer-time-in
-
-

+

Inbound zone transfers running longer than this many minutes are 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 are 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 are 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 are terminated. The default is 60 minutes (1 hour). The maximum value is 28 days (40320 minutes). -

-
+

notify-rate
-
-

+

This specifies the rate at which NOTIFY requests are sent during normal zone maintenance operations. (NOTIFY requests due to initial zone loading are subject @@ -5740,22 +5353,18 @@ avoid-v6-udp-ports {}; 20 per second. The lowest possible rate is one per second; when set to zero, it is silently raised to one. -

-
+

startup-notify-rate
-
-

+

This is the rate at which NOTIFY requests are sent when the name server is first starting up, or when zones have been newly added to the name server. The default is 20 per second. The lowest possible rate is one per second; when set to zero, it is silently raised to one. -

-
+

serial-query-rate
-
-

+

Secondary servers periodically query primary servers to find out if zone serial numbers have changed. Each such query uses a minute amount of @@ -5767,21 +5376,16 @@ avoid-v6-udp-ports {}; per second. The default is 20 per second. The lowest possible rate is one per second; when set to zero, it is silently raised to one. -

-
+

serial-queries
-
-

+

BIND 9 does not limit the number of outstanding 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. @@ -5797,12 +5401,10 @@ avoid-v6-udp-ports {}; transfer-format may be overridden on a per-server basis by using the server statement. -

- -
+

transfer-message-size
-

+

This is an upper bound on the uncompressed size of DNS messages used in zone transfers over TCP. If a message grows larger than this size, additional messages are @@ -5812,7 +5414,7 @@ avoid-v6-udp-ports {}; fit within the size limit, a larger message will be permitted so the record can be transferred.)

-

+

Valid values are between 512 and 65535 octets; any values outside that range are adjusted to the nearest value within it. The default is 20480, @@ -5822,35 +5424,30 @@ avoid-v6-udp-ports {}; as effectively, because 16536 is the largest permissible compression offset pointer in a DNS message.

-

+

This option is mainly intended for server testing; there is rarely any benefit in setting a value other than the default.

-
+
transfers-in
-
-

+

This is the maximum number of inbound zone transfers that can run concurrently. The default value is 10. Increasing transfers-in may speed up the convergence of secondary zones, but it also may increase the load on the local system. -

-
+

transfers-out
-
-

+

This is the maximum number of outbound zone transfers that can run concurrently. Zone transfer requests in excess of the limit are refused. The default value is 10. -

-
+

transfers-per-ns
-
-

+

This is the maximum number of inbound zone transfers that can concurrently transfer from a given remote name server. @@ -5862,11 +5459,10 @@ 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 is bound to IPv4 TCP connections used to fetch zones transferred inbound by the server. It also determines the @@ -5887,30 +5483,28 @@ 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
-
-

+

This option is the same as transfer-source, except zone transfers are performed using IPv6. -

-
+

alt-transfer-source
-

+

This indicates an alternate transfer source if the one listed in transfer-source fails and use-alt-transfer-source is set.

-
+

Note

To avoid using the alternate transfer source, @@ -5920,28 +5514,24 @@ avoid-v6-udp-ports {}; query.

-
+
alt-transfer-source-v6
-
-

+

This indicates an alternate transfer source if the one listed in transfer-source-v6 fails and use-alt-transfer-source is set. -

-
+

use-alt-transfer-source
-
-

+

This indicates whether the alternate transfer sources should be used. If views are specified, this defaults to no; otherwise, it defaults to yes. -

-
+

notify-source
-

notify-source +

notify-source determines which local source address, and optionally UDP port, is used to send NOTIFY messages. This address must appear in the secondary @@ -5955,30 +5545,25 @@ 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
-
-

+

This option acts 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 @@ -5989,20 +5574,17 @@ 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 are 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 @@ -6019,13 +5601,11 @@ 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 @@ -6038,8 +5618,7 @@ 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 do not support some or @@ -6047,18 +5626,14 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; an unsupported limit is used.

- -
+
coresize
-
-

+

This sets the maximum size of a core dump. The default is default. -

-
+

datasize
-
-

+

This sets the maximum amount of data memory the server may use. The default is default. This is a hard limit on server memory usage; @@ -6073,49 +5648,37 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; max-cache-size and recursive-clients options instead. -

-
+

files
-
-

+

This sets the maximum number of files the server may have open concurrently. The default is unlimited. -

-
+

stacksize
-
-

+

This sets 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 by 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
-
-

+

This sets a maximum size for each journal file (see the section called “The Journal File”). When the journal file approaches @@ -6126,26 +5689,21 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; unlimited, which also means 2 gigabytes. This option may also be set on a per-zone basis. -

-
+

max-records
-
-

+

This sets the maximum number of records permitted in a zone. The default is zero, which means the maximum is unlimited. -

-
+

host-statistics-max
-
-

+

In BIND 8, this specified the maximum number of host statistics entries to be kept. It is not implemented in BIND 9. -

-
+

recursive-clients
-

+

This sets the maximum number (a "hard quota") of simultaneous recursive lookups the server performs on behalf of clients. The default is @@ -6156,14 +5714,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 are not accepted, and for each incoming request a previous pending request is dropped.

-

+

A "soft quota" is also set. When this lower quota is exceeded, incoming requests are accepted, but for each one, a pending request is dropped. @@ -6173,20 +5731,18 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; otherwise it is set to 90% of recursive-clients.

-
+
tcp-clients
-
-

+

This is the maximum number of simultaneous client TCP connections that the server accepts. The default is 150. -

-
+

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 accepts @@ -6194,7 +5750,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; self-tune this value and changes are 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 exceeds this value, named @@ -6204,22 +5760,22 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; estimate is then lowered in 20 minutes if it has remained unchanged.

-

+

If clients-per-query is set to zero, there is no limit on the number of clients per query and no queries are dropped.

-

+

If max-clients-per-query is set to zero, there is no upper bound other than imposed by recursive-clients.

-
+
fetches-per-zone
-

+

This sets the maximum number of simultaneous iterative queries to any one domain that the server permits before blocking new queries for data @@ -6229,7 +5785,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 are all attached to the same fetch, up to the @@ -6241,7 +5797,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 @@ -6249,12 +5805,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, there is no limit on the number of fetches per query and no queries are 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 @@ -6267,12 +5823,12 @@ 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.)

-
+
fetches-per-server
-

+

This sets the maximum number of simultaneous iterative queries that the server allows to be sent to a single upstream name server before blocking @@ -6282,7 +5838,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 are dropped with no @@ -6291,12 +5847,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, there is no limit on the number of fetches per query and no queries are 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 @@ -6312,15 +5868,15 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; can be used to adjust the parameters for this calculation.

-
+
fetch-quota-params
-

+

This 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 @@ -6328,7 +5884,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 @@ -6343,10 +5899,10 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; precision of 1/100; at most two places after the decimal point are significant.

-
+
reserved-sockets
-

+

This sets 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 plus @@ -6357,13 +5913,12 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; maximum value is 128 fewer than maxsockets (-S). This option may be removed in the future.

-

+

This option has little effect on Windows.

-
+
max-cache-size
-
-

+

This sets the maximum amount of memory to use for the server's cache, in bytes or percentage of total physical memory. When the amount of data in the cache @@ -6386,11 +5941,9 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; once at startup, so named does not adjust the cache size if the amount of physical memory is changed during runtime. -

-
+

tcp-listen-queue
-
-

+

This sets the listen-queue depth. The default and minimum is 10. If the kernel supports the accept filter "dataready", this also controls how @@ -6400,20 +5953,15 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; less than 10 are 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 removed expired resource records from the cache every cleaning-interval minutes. @@ -6422,11 +5970,9 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; rely on periodic cleaning anymore. Specifying this option therefore has no effect on the server's behavior. -

-
+

heartbeat-interval
-
-

+

The server performs zone maintenance tasks for all zones marked as dialup whenever this interval expires. The default is 60 minutes. Reasonable @@ -6434,11 +5980,9 @@ 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 occurs. -

-
+

interface-interval
-
-

+

The server scans the network interface list every interface-interval minutes. The default @@ -6451,11 +5995,10 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; discovered interfaces (provided they are allowed by the listen-on configuration), and stops listening on interfaces that have gone away. -

-
+

statistics-interval
-

+

Name server statistics are logged every statistics-interval minutes. The default is @@ -6464,30 +6007,25 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

Note

-

+

This option is not implemented in BIND 9.

-
-
+
+
topology
-
-

+

In BIND 8, this option indicated network topology so that preferential treatment could be given to the topologically closest name servers when sending queries. It 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 record set (RRset). The name server normally returns the RRs within the RRset in an @@ -6501,8 +6039,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; 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 interprets it in a special way. Each top-level statement in the @@ -6514,7 +6051,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; the query until a match is found. When the addresses in the first element overlap, the first rule to match is selected.

-

+

Once the source address of the query has been matched, if the top-level statement contains only one element, the actual primitive element that matched the source address is used to @@ -6525,7 +6062,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; address in the response with the 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 get responses preferring addresses on any of the locally connected networks. Next most @@ -6538,7 +6075,6 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; the 192.168.5/24 network only prefer other addresses on their directly connected networks.

- 
sortlist {
     // IF the local host
     // THEN first fit on the following nets
@@ -6562,8 +6098,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
     { { 192.168.4/24; 192.168.5/24; };
     };
 };
- -

+

The following example illustrates reasonable behavior for the local host and hosts on directly connected networks. Responses sent to queries from the local host favor any of the directly connected @@ -6571,48 +6106,41 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; directly connected network prefer addresses on that same network. Responses to other queries are not sorted.

- 
sortlist {
            { localhost; localnets; };
            { localnets; };
 };
- -
-
+
+

RRset Ordering

- -
+

Note

-

+

While alternating the order of records in a DNS response between subsequent queries is a known load distribution technique, certain caveats apply (mostly stemming from caching) which usually make it a suboptimal choice for load balancing purposes when used on its own.

-
- -

+

+

The rrset-order statement permits configuration of the ordering of the records in a multiple-record response. See also: the section called “The sortlist Statement”.

- -

+

Each rule in an rrset-order statement is defined as follows:

- -

+

[class <class_name>] [type <type_name>] [name "<domain_name>"] order <ordering>

- -

+

The default qualifiers for each rule are:

    @@ -6631,8 +6159,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

- -

+

<domain_name> only matches the name itself, not any of its subdomains. To make a rule match all subdomains of a given name, a wildcard name @@ -6645,48 +6172,40 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; <domain_name> and one for *.<domain_name>.

- -

+

The legal values for <ordering> are:

- -
+
fixed
-

+

Records are returned in the order they are defined in the zone file.

-
+

Note

-

+

The fixed option is only available if BIND is configured with --enable-fixed-rrset at compile time.

-
-
+
+
random
-
-

+

Records are returned in a random order. -

-
+

cyclic
-
-

+

Records are returned in a cyclic round-robin order, rotating by one record per query. -

-
+

- -

+

By default, records are returned in random order.

- -

+

Note that if multiple rrset-order statements are present in the configuration file (at both the options and view levels), they @@ -6694,16 +6213,13 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; one (view) replaces the less-specific one (options).

- -

+

If multiple rules within a single rrset-order statement match a given RRset, the first matching rule is applied.

- -

+

Example:

- 
rrset-order {
     type A name "foo.isc.org" order random;
     type AAAA name "foo.isc.org" order cyclic;
@@ -6712,13 +6228,10 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
     name "*.baz.isc.org" order cyclic;
 };
- -

+

With the above configuration, the following RRset ordering is used:

- -
- +
@@ -6771,31 +6284,24 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; -

cyclic
-
- -
- -
+
+
+

Tuning

- -
+
lame-ttl
-
-

+

This sets the number of seconds to cache a lame server indication. 0 disables caching. (This is NOT recommended.) The default is 600 (10 minutes) and the maximum value is 1800 (30 minutes). -

- -
+

servfail-ttl
-

+

This sets the number of seconds to cache a SERVFAIL response due to DNSSEC validation failure or other general server failure. If set to @@ -6805,16 +6311,15 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; query that failed due to DNSSEC validation to be retried without waiting for the SERVFAIL TTL to expire.

-

+

The maximum value is 30 seconds; any higher value is silently reduced. The default is 1 second.

-
+
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 @@ -6824,11 +6329,9 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; max-ncache-ttl cannot exceed 7 days and is silently truncated to 7 days if set to a greater value. -

-
+

max-cache-ttl
-
-

+

This sets the maximum time for which the server caches ordinary (positive) answers, in seconds. The default is 604800 (one week). @@ -6836,26 +6339,25 @@ 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
-

+

This sets the minimum number of root servers that is required for a request for the root servers to be accepted. The default is 2.

-
+

Note

-

+

This is not implemented in BIND 9.

-
-
+
+
sig-validity-interval
-

+

This specifies the number of days into the future that DNSSEC signatures that are automatically generated as a result of dynamic updates (the section called “Dynamic Update”) will expire. There @@ -6869,48 +6371,44 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; giving a re-signing interval of 7 1/2 days. The maximum value is 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
-
-

+

This specifies 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
-
-

+

This specifies a threshold number of signatures that terminates processing a quantum, when signing a zone with a new DNSKEY. The default is 10. -

-
+

sig-signing-type
-

+

This specifies a private RDATA type to be used when generating signing-state records. The default is 65534.

-

+

This parameter may be removed in a future version, once there is a standard type.

-

+

Signing-state records are used internally by named to track the current state of a zone-signing process, i.e., whether it is still active @@ -6926,12 +6424,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. Usually the SOA values for the zone are used, @@ -6939,14 +6437,14 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; these values are set by the primary, giving secondary server administrators little control over their contents.

-

+

These options allow the administrator to set a minimum and maximum refresh and retry time in seconds per-zone, per-view, or globally. These options are valid for secondary and stub zones, 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 @@ -6954,10 +6452,10 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; and max-retry-time 1209600 seconds (2 weeks).

-
+
edns-udp-size
-

+

This 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. @@ -6965,19 +6463,19 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; are silently adjusted to the nearest value within it. The default value is 1232.

-

+

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 advertises 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 tries again with plain DNS; if that is successful, it is taken as evidence that the server does not @@ -6988,7 +6486,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; periodically sends 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 advertises progressively @@ -6996,7 +6494,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 exceed edns-udp-size. (The values 1232 and @@ -7004,22 +6502,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
-

+

This sets the maximum EDNS UDP message size that named sends, in bytes. Valid values are 512 to 4096; values outside this range are silently adjusted to the nearest value within it. The default value is 1232.

-

+

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 allow UDP answers to pass through broken @@ -7028,14 +6526,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 encourages additional TCP traffic to the name server.

-
+
masterfile-format
-

This specifies +

This specifies the file format of zone files (see the section called “Additional File Formats”). The default value is text, which is the @@ -7046,7 +6544,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; named-compilezone tool, or dumped by named.

-

+

Note that when a zone file in a format other than text is loaded, named may omit some of the checks which would be performed for a @@ -7060,7 +6558,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 @@ -7069,16 +6567,16 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; view block in the configuration file.

-
+
masterfile-style
-

+

This specifies the formatting of zone files during dump, when the masterfile-format is text. This option is ignored with any other masterfile-format.

-

+

When set to relative, records are printed in a multi-line format, with owner names expressed relative to a shared origin. When set @@ -7091,12 +6589,11 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; zone is to be edited by hand. The default is relative.

-
+
max-recursion-depth
-
-

+

This 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 @@ -7105,49 +6602,44 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; of recursions exceeds this value, the recursive query is terminated and returns SERVFAIL. The default is 7. -

-
+

max-recursion-queries
-
-

+

This sets the maximum number of iterative queries that may be sent while servicing a recursive query. If more queries are sent, the recursive query is terminated and returns SERVFAIL. The default is 100. -

-
+

notify-delay
-

+

This sets the delay, in seconds, between sending sets of NOTIFY messages for a zone. The default is 5 seconds.

-

+

The overall rate at which NOTIFY messages are sent for all zones is controlled by serial-query-rate.

-
+
max-rsa-exponent-size
-
-

+

This sets the maximum RSA exponent size, in bits, that is accepted when validating. Valid values are 35 to 4096 bits. The default, zero, 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.

-

+

prefetch specifies the "trigger" TTL value at which prefetch of the current query takes place; when a cache record with a @@ -7159,7 +6651,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 is accepted for a record to be @@ -7169,24 +6661,19 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; adjusts it upward. The default eligibility TTL is 9.

-
+
v6-bias
-
-

+

When determining the next name server to try, this indicates by how many milliseconds to prefer IPv6 name servers. The default is 50 milliseconds. -

-
+

- -
- -
+
+

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 @@ -7205,18 +6692,17 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; rate-limit is set to allow three responses per second.

-

+

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
-

+

This is the version the server should report via a query of the name version.bind with type TXT and class CHAOS. @@ -7224,15 +6710,14 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; Specifying version none disables processing of the queries.

-

+

Setting version to any value (including none) also disables queries for authors.bind TXT CH.

-
+
hostname
-
-

+

This is the hostname the server should report via a query of the name hostname.bind with type TXT and class CHAOS. @@ -7243,11 +6728,9 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; identify which of a group of anycast servers is actually answering the queries. Specifying hostname none; disables processing of the queries. -

-
+

server-id
-
-

+

This is the ID the server should report when receiving a Name Server Identifier (NSID) query, or a query of the name ID.SERVER with type @@ -7259,17 +6742,13 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; Specifying server-id hostname; causes named to use the hostname as found by the gethostname() function. The default server-id is none. -

-
+

- -
- -
+
+

Built-in Empty Zones

- -

+

The named server has some built-in empty zones, for SOA and NS records only. These are for zones that should normally be answered locally @@ -7282,13 +6761,13 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; IPv6 link local addresses, the IPv6 loopback address, and the IPv6 unknown address.

-

+

The server attempts to determine if a built-in zone already exists or is active (covered by a forward-only forwarding declaration) and does not create an empty zone if either is true.

-

+

The current list of empty zones is:

    @@ -7394,7 +6873,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

-

+

Empty zones can be set 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 @@ -7406,7 +6885,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

-

+

If using the address ranges covered here, reverse zones covering the addresses should already be in place. In practice this appears to not be the case, with many queries @@ -7415,7 +6894,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 @@ -7424,46 +6903,35 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; enables them to return referrals to deeper in the tree.

-
+
empty-server
-
-

+

This specifies the server name that appears in the returned SOA record for empty zones. If none is specified, the zone's name is used. -

-
+

empty-contact
-
-

+

This specifies the contact name that appears in the returned SOA record for empty zones. If none is specified, "." is used. -

-
+

empty-zones-enable
-
-

+

This enables or disables all empty zones. By default, they are enabled. -

-
+

disable-empty-zone
-
-

+

This disables 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 @@ -7473,8 +6941,7 @@ 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 @@ -7482,8 +6949,7 @@ 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.

- -

+

To obtain the maximum performance improvement from additional section caching, setting additional-from-cache @@ -7492,8 +6958,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; does not shortcut 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. @@ -7506,8 +6971,7 @@ 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, @@ -7523,32 +6987,25 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; only a single RR), so the ordering is not significant.

- -

+

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 removes 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 occurs. -

-
+

max-acache-size
-
-

+

This is 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 @@ -7558,17 +7015,13 @@ 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 responses from external DNS servers containing certain types of data in the answer section. @@ -7594,12 +7047,10 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; deny-answer-aliases, 

www.example.com. CNAME xxx.example.com.
- -

+

returned by an "example.com" server is accepted.

- -

+

In the address_match_list of the deny-answer-addresses option, only ip_addr @@ -7607,14 +7058,12 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; are meaningful; any key_id is silently ignored.

- -

+

If a response message is rejected due to the filtering, the entire message is discarded without being cached, and a SERVFAIL error is 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 the user's own network or @@ -7629,48 +7078,39 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; for more details about these attacks.

- -

+

For example, with a domain named "example.net" and an internal network using an IPv4 prefix 192.0.2.0/24, an administrator 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 let a web browser in the 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 would be ignored.

- -

+

On the other hand, if the browser looked up a legitimate internal web server "www.example.net" and the following response were returned to the BIND 9 server:

- 
www.example.net. A 192.0.2.2
- -

+

it would 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 with having an "external" name mapped to an "internal" IP address or domain name @@ -7691,8 +7131,7 @@ deny-answer-aliases { "example.net"; }; no other choice and the attack is a real threat to applications.

- -

+

Care should be particularly taken if using this option for addresses within 127.0.0.0/8. These addresses are obviously "internal," but many @@ -7701,13 +7140,11 @@ 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 rejection lists. @@ -7715,8 +7152,7 @@ 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. @@ -7727,8 +7163,7 @@ 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 @@ -7737,22 +7172,20 @@ deny-answer-aliases { "example.net"; }; in a single response-policy option; more than that is a configuration error.

- -

+

Rules encoded in response policy zones are processed after those defined in Access Control Lists (ACLs). All queries from clients which are not permitted access to the resolver are answered with a status code of REFUSED, regardless of configured RPZ rules.

- -

+

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 @@ -7767,8 +7200,7 @@ 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. @@ -7784,29 +7216,25 @@ 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 the query name, or a parent of a CNAME. @@ -7820,8 +7248,7 @@ deny-answer-aliases { "example.net"; }; triggers off or on for a single policy zone or for all zones.

- -

+

If authoritative nameservers for the query name are not yet known, named recursively looks up the authoritative servers for the query name @@ -7841,10 +7268,10 @@ deny-answer-aliases { "example.net"; }; rules are always applied, even if authoritative servers for the query name need to be looked up first.

-
+
RPZ-NSIP
-

+

NSIP triggers match the IP addresses of authoritative servers. They are enncoded like IP triggers, except as subdomains of rpz-nsip. @@ -7853,7 +7280,7 @@ deny-answer-aliases { "example.net"; }; The default value of min-ns-dots is 1, to exclude top-level domains.

-

+

If a name server's IP address is not yet known, named recursively looks up the IP address before applying an RPZ-NSIP rule, @@ -7872,12 +7299,11 @@ deny-answer-aliases { "example.net"; }; rules are always applied, even if an address needs to be looked up first.

-
+

- -

+

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 @@ -7906,16 +7332,14 @@ 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. @@ -7927,59 +7351,48 @@ deny-answer-aliases { "example.net"; };

PASSTHRU
-
-

+

The auto-acceptance 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 auto-rejection 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 a CNAME whose target is the wildcard top-level domain (*.). It rewrites the response to NODATA or ANCOUNT=0. -

-
+

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 an ordinary CNAME after the asterisk (*) @@ -7987,12 +7400,11 @@ deny-answer-aliases { "example.net"; }; This special form is useful for query logging in the walled garden's authoritative 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 @@ -8003,14 +7415,11 @@ 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. @@ -8020,28 +7429,22 @@ deny-answer-aliases { "example.net"; }; Disabled policy zones should appear first, because they are often not logged if a higher-precedence trigger is found first. -

-
+

PASSTHRU, DROP, TCP-Only, NXDOMAIN, NODATA
-
-

+

each override 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 for @@ -8052,8 +7455,7 @@ 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 the requested name in the original @@ -8064,8 +7466,7 @@ 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. @@ -8092,24 +7493,22 @@ 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 the policy zone. It is then limited to a maximum value. The max-policy-ttl clause changes the maximum number of seconds from its default of 5.

- -

+

For example, an administrator 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
@@ -8151,7 +7550,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 @@ -8166,24 +7565,20 @@ 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.

- -

+

The log clause can be used to optionally turn off rewrite logging for a particular response policy zone. By default, all rewrites are logged.

-
- -
+
+

Response Rate Limiting

- -

+

Excessive, almost identical UDP responses can be controlled by configuring a rate-limit clause in an @@ -8196,8 +7591,7 @@ example.com CNAME rpz-tcp-only. Legitimate clients react to dropped or truncated responses 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 @@ -8205,8 +7599,7 @@ 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 @@ -8225,8 +7618,7 @@ 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 @@ -8235,8 +7627,7 @@ 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 @@ -8260,14 +7651,12 @@ 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). @@ -8278,8 +7667,7 @@ 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 @@ -8303,8 +7691,7 @@ 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 @@ -8317,8 +7704,7 @@ 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, the responses-per-second, @@ -8336,8 +7722,7 @@ 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 @@ -8349,8 +7734,7 @@ 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 @@ -8383,8 +7767,7 @@ example.com CNAME rpz-tcp-only. or parsing DNS requests, 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. @@ -8398,25 +7781,22 @@ 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.

-
- -
+
+

NXDOMAIN Redirection

-

+

named supports NXDOMAIN redirection via two methods:

    @@ -8427,19 +7807,19 @@ example.com CNAME rpz-tcp-only.

-

+

With either method, when named gets an NXDOMAIN response it examines a separate namespace to see if the NXDOMAIN response should be replaced with an alternative response.

-

+

With a redirect zone (zone "." { type redirect; };), the data used to replace the NXDOMAIN is held in a single zone which is not part of the normal namespace. All the redirect information is contained in the zone; there are no delegations.

-

+

With a redirect namespace (option { nxdomain-redirect <suffix> };), the data used to replace the NXDOMAIN is part of the normal namespace and is looked up by @@ -8449,17 +7829,16 @@ example.com CNAME rpz-tcp-only. the replacement data (or a NXDOMAIN indicating that there is no replacement) must be stored.

-

+

If both a redirect zone and a redirect namespace are configured, the redirect zone is tried first.

-
-
- -
+
+
+

server Statement Grammar

- 
+
 server netprefix {
 	bogus boolean;
 	edns boolean;
@@ -8491,14 +7870,12 @@ example.com                 CNAME   rpz-tcp-only.
 	transfers integer;
 };
 

-
- -
+
+

server Statement Definition and Usage

- -

+

The server statement defines characteristics to be associated with a remote name server. If a prefix length is @@ -8507,8 +7884,7 @@ 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 @@ -8523,14 +7899,13 @@ example.com CNAME rpz-tcp-only. used as defaults.

- -

+

If a remote server is giving out bad data, marking it as bogus prevents further queries to it. The default value of bogus is no.

-

+

The provide-ixfr clause determines whether the local server, acting as primary, responds with an @@ -8546,8 +7921,7 @@ 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 secondary, requests incremental zone @@ -8557,8 +7931,7 @@ example.com CNAME rpz-tcp-only. also be set in the zone block; if set there, it overrides the global or view setting for that zone.

- -

+

IXFR requests to servers that do not support IXFR automatically fall back to AXFR. Therefore, there is no need to manually list @@ -8572,8 +7945,7 @@ example.com CNAME rpz-tcp-only. and secondary claim to support it: for example, if one of the servers is buggy and crashes or corrupts data when IXFR is used.

- -

+

The request-expire clause determines whether the local server, when acting as a secondary, requests the EDNS EXPIRE value. The EDNS EXPIRE value @@ -8585,14 +7957,12 @@ example.com CNAME rpz-tcp-only. record instead. The default is yes.

- -

+

The edns clause determines whether the local server attempts 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 @@ -8611,8 +7981,7 @@ example.com CNAME rpz-tcp-only. behavior may be brought into conformance with the options/view behavior in future releases.

- -

+

The edns-version option sets the maximum EDNS VERSION that is sent to the server(s) by the resolver. The actual EDNS version sent is still @@ -8627,8 +7996,7 @@ example.com CNAME rpz-tcp-only. adjusted. This option is not needed until higher EDNS versions than 0 are in use.

- -

+

The max-udp-size option sets the maximum EDNS UDP message size named sends. Valid values are 512 to 4096 bytes; values @@ -8636,15 +8004,13 @@ example.com CNAME rpz-tcp-only. option is useful when 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 single message, which is @@ -8655,16 +8021,14 @@ example.com CNAME rpz-tcp-only. by the options statement is 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”) @@ -8675,12 +8039,10 @@ 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 @@ -8695,8 +8057,7 @@ 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, respectively, to be used for notify @@ -8705,8 +8066,7 @@ 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, respectively, to be used for queries @@ -8715,16 +8075,14 @@ 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 adds an NSID EDNS option to requests sent to the server. This overrides request-nsid set at the view or option level.

- -

+

The send-cookie clause determines whether the local server adds a COOKIE EDNS option to requests sent to the server. This overrides @@ -8733,12 +8091,11 @@ example.com CNAME rpz-tcp-only. determine that COOKIE is not supported by the remote server and not add a COOKIE EDNS option to requests.

-
- -
+
+

statistics-channels Statement Grammar

- 
+
 statistics-channels {
 	inet ( ipv4_address | ipv6_address |
 	    * ) [ port ( integer | * ) ] [
@@ -8746,21 +8103,18 @@ example.com                 CNAME   rpz-tcp-only.
 	    } ];
 };
 

-
- -
+
+

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 on the name server.

- -

+

This statement is intended to be flexible to support multiple communication protocols in the future, but currently only HTTP access is supported. @@ -8770,8 +8124,7 @@ example.com CNAME rpz-tcp-only. still accepted even if it is built without the library, but any HTTP access fails 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 @@ -8782,14 +8135,12 @@ 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.

- -

+

Attempts to open a statistics channel are restricted by the optional allow clause. Connections to the statistics channel are permitted based on the @@ -8801,13 +8152,11 @@ example.com CNAME rpz-tcp-only. recommended to restrict the source of connection requests appropriately.

- -

+

If no statistics-channels statement is present, named does 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 @@ -8819,8 +8168,7 @@ example.com CNAME rpz-tcp-only. charts and graphs using the Google Charts API when using a JavaScript-capable browser.

- -

+

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), @@ -8837,8 +8185,7 @@ example.com CNAME rpz-tcp-only. http://127.0.0.1:8888/xml/v3/traffic (traffic sizes).

- -

+

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 @@ -8857,22 +8204,20 @@ example.com CNAME rpz-tcp-only. http://127.0.0.1:8888/json/v1/traffic (traffic sizes).

-
- -
+
+

trusted-keys Statement Grammar

- 
+
 trusted-keys { string integer integer
     integer quoted_string; ... };
 

-
-
+
+

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 @@ -8883,7 +8228,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 @@ -8891,7 +8236,7 @@ example.com CNAME rpz-tcp-only. used to validate the DNSKEY RRset. The parent's DS RRset is not used.

-

+

The trusted-keys statement can contain multiple key entries, each consisting of the key's domain name, flags, protocol, and algorithm, and the Base64 @@ -8900,33 +8245,31 @@ example.com CNAME rpz-tcp-only. in the key data, so the configuration may be split 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.

-

+

Validation below specified names can be temporarily disabled by using rndc nta.

-
- -
+
+

managed-keys Statement Grammar

- 
+
 managed-keys { string string integer
     integer integer quoted_string; ... };
 

-
-
+
+

managed-keys Statement Definition and Usage

- -

+

The managed-keys statement, like trusted-keys, defines DNSSEC security roots. The difference is that @@ -8934,7 +8277,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 @@ -8944,7 +8287,7 @@ example.com CNAME rpz-tcp-only. continue until the resolver operator updated the trusted-keys statement with the new key.

-

+

If, however, the zone were listed in a managed-keys statement instead, the zone owner could add a "stand-by" key to the zone in advance. @@ -8955,7 +8298,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 @@ -8966,7 +8309,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 statement, differing by the presence of the second field, which contains the keyword @@ -8979,7 +8322,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 @@ -8987,7 +8330,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 @@ -8996,7 +8339,7 @@ example.com CNAME rpz-tcp-only. statement is not used to validate answers; it is 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 @@ -9004,11 +8347,11 @@ example.com CNAME rpz-tcp-only. and RFC 5011 key maintenance is no longer 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 is a separate managed-keys database for each @@ -9017,7 +8360,7 @@ example.com CNAME rpz-tcp-only. 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 are written into a journal file, e.g., @@ -9031,7 +8374,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 automatically initializes a managed key for the @@ -9043,12 +8386,10 @@ example.com CNAME rpz-tcp-only. found, the initializing key is also compiled directly into named.

-
- -
+
+

view Statement Grammar

- 
view view_name [ class ] {
     match-clients { address_match_list } ;
     match-destinations { address_match_list } ;
@@ -9057,13 +8398,11 @@ 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 @@ -9072,8 +8411,7 @@ 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 is seen by a subset of clients. A client @@ -9101,8 +8439,7 @@ example.com CNAME rpz-tcp-only. a client request is resolved in the context of the first view that it matches.

- -

+

Zones defined within a view statement are only accessible to clients that match the view. @@ -9111,8 +8448,7 @@ 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 @@ -9125,14 +8461,12 @@ 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 @@ -9148,12 +8482,10 @@ 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; };
@@ -9186,13 +8518,11 @@ view "external" {
       };
 };
- -
-
+
+

zone Statement Grammar

- 
 zone string [ class ] {
 	type ( master | primary );
@@ -9393,16 +8723,14 @@ view "external" {
 	in-view string;
 };
- -
-
+
+

zone Statement Definition and Usage

- -
+

Zone Types

-

+

The type keyword is required for the zone configuration unless it is an in-view configuration. Its @@ -9412,7 +8740,7 @@ view "external" { forward, redirect, or delegation-only.

-
+

Note

Later versions of BIND added type primary and type secondary as synonyms for @@ -9420,9 +8748,7 @@ view "external" { as those terms are in more common use now. BIND 9.11's configuration syntax predates this change.
- -
- +
@@ -9752,20 +9078,17 @@ 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 was used to share information about various systems databases, such @@ -9773,69 +9096,52 @@ 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
-
-

+

This 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
-
-

+

This option is only meaningful if notify is active for this zone. The set of machines that @@ -9856,11 +9162,9 @@ 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 zone files and/or DNS responses @@ -9869,90 +9173,67 @@ view "external" { For primary zones the default is fail; for secondary 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
-

+

This specifies the type of database to be used to store the zone data. The string following the database keyword is interpreted as a list of whitespace-delimited words. @@ -9963,41 +9244,38 @@ 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
-

+

This flag only applies to forward, hint, and stub zones. If set to yes, then the zone is treated as if it is also a delegation-only type zone.

-

+

See caveats in root-delegation-only.

-
+
file
-
-

+

This sets the zone's filename. In master, hint, and redirect zones which do not have masters @@ -10007,30 +9285,24 @@ view "external" { masters defined, zone data is retrieved from another server and saved in this file. This option is not applicable to other zone types. -

-
+

forward
-
-

+

This option is 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 allows a normal lookup to be tried. -

-
+

forwarders
-
-

+

This is 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
-
-

+

This was used in BIND 8 to specify the name of the transaction log (journal) file for dynamic update @@ -10040,110 +9312,83 @@ view "external" { file by appending ".jnl" to the name of the zone file. -

-
+

ixfr-tmp-file
-
-

+

This was an undocumented option in BIND 8. It is ignored in BIND 9. -

-
+

journal
-
-

+

This allows the default journal's filename to be overridden. The default is the zone's filename with ".jnl" appended. This is applicable to primary (master) and secondary (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 to specify a public zone key for verification of signatures in DNSSEC-signed zones when they were 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
-

+

This option is only meaningful for static-stub zones. This is a list of IP addresses to which queries should be sent in recursive resolution for the @@ -10152,7 +9397,7 @@ view "external" { configures 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, @@ -10161,7 +9406,7 @@ view "external" { 

example.com. NS example.com.
 example.com. A 192.0.2.1
 example.com. AAAA 2001:db8::1234
-

+

These records are used internally to resolve names under the static-stub zone. For instance, if the server receives a query for @@ -10169,10 +9414,10 @@ example.com. AAAA 2001:db8::1234 initiates recursive resolution and sends queries to 192.0.2.1 and/or 2001:db8::1234.

-
+
server-names
-

+

This option is only meaningful for static-stub zones. This is a list of domain names of name servers that act as authoritative servers of the static-stub @@ -10190,7 +9435,7 @@ example.com. AAAA 2001:db8::1234 "ns.example.net" cannot; it is rejected by the configuration parser.

-

+

A non-empty list for this option internally configures the apex NS RR with the specified names. For example, if "example.com" is configured as a @@ -10199,12 +9444,10 @@ example.com. AAAA 2001:db8::1234 in a server-names option, the following RRs are internally configured:

- 
example.com. NS ns1.example.net.
 example.com. NS ns2.example.net.
- -

+

These records are used internally to resolve names under the static-stub zone. For instance, if the server receives a query for @@ -10214,189 +9457,145 @@ example.com. NS ns2.example.net. "ns2.example.net" to IP addresses, and then sends 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 descriptions 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 choices of master and slave 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 an 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 behavior 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 +

BIND 9 supports two methods of granting clients the right to perform dynamic updates to a zone, configured by the allow-update and update-policy options.

-

+

The allow-update clause is a simple access control list. Any client that matches the ACL is granted permission to update any record in the zone.

-

+

The update-policy clause allows more fine-grained control over which updates are allowed. It specifies a set of rules, in which each rule @@ -10409,7 +9608,7 @@ example.com. NS ns2.example.net. to specify update permissions based on client source address.

-

+

update-policy rules are only meaningful for primary zones (type master), and are not allowed in any other zone type. @@ -10417,7 +9616,7 @@ example.com. NS ns2.example.net. allow-update and update-policy at the same time.

-

+

A pre-defined update-policy rule can be switched on with the command update-policy local;. @@ -10439,35 +9638,30 @@ example.com. NS ns2.example.net. 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; };
             

-
-            

+

               with the additional restriction that only clients
               connecting from the local system are permitted to send
               updates.
             

-            

+

               Note that only one session key is generated by
               named; all zones configured to use
               update-policy local accept the same key.
             

-            

+

               The command nsupdate -l implements this
               feature, sending requests to localhost and signing them using
               the key retrieved from the session key file.
             

-
-            

+

               Other rule definitions look like this:
             

-
 
 ( grant | deny ) identity ruletype [ name ] [ types ]
 

-
-            

+

               Each rule grants or denies privileges.  Rules are checked
               in the order in which they are specified in the
               update-policy statement. Once a message
@@ -10477,7 +9671,7 @@ example.com. NS ns2.example.net.
               ruletype field, and the interpretation
               of other fields varies depending on the rule type.
             

-            

+

               In general, a rule is matched when the
               key that signed an update request matches the
               identity field, the name of the record
@@ -10487,7 +9681,7 @@ example.com. NS ns2.example.net.
               types field. Details for each rule type
               are described below.
             

-            

+

               The identity field must be set to
               a fully qualified domain name.  In most cases, this
               represents the name of the TSIG or SIG(0) key that must be
@@ -10501,13 +9695,13 @@ example.com. NS ns2.example.net.
               (e.g, "host/machine@REALM") or
               Windows realm (machine$@REALM).
             

-            

+

               The name field also specifies
               a fully qualified domain name. This often
               represents the name of the record to be updated.
               Interpretation of this field is dependent on rule type.
             

-            

+

               If no types are explicitly specified,
               then a rule matches all types except RRSIG, NS, SOA, NSEC,
               and NSEC3. Types may be specified by name, including
@@ -10516,7 +9710,7 @@ example.com. NS ns2.example.net.
               is made to delete all records associated with a name,
               the rules are checked for each existing record type.
             

-            

+

               The ruletype field has 16
               values:
               name, subdomain,
@@ -10528,8 +9722,7 @@ example.com. NS ns2.example.net.
               krb5-subdomain, tcp-self,
                   6to4-self, and external.
             

-            

-              
+
@@ -10922,15 +10115,12 @@ example.com. NS ns2.example.net.
                     
-

 
 
 

 
 

-            

-
- -
+
+
+

Multiple Views

- -

+

When multiple views are in use, a zone may be referenced by more than one of them. Often, the views contain different zones with the same name, allowing @@ -10941,7 +10131,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; };
 
@@ -10959,11 +10149,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
               , with the exception of forward
@@ -10971,45 +10161,41 @@ view external {
               the behavior of the containing view, rather than change
               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.  Be
               careful 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 type 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 @@ -11019,12 +10205,10 @@ 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:

-
- +
@@ -11099,20 +10283,17 @@ view external { -
-
-

+

+

For a complete list of types of valid RRs, including those that have been obsoleted, please refer to https://en.wikipedia.org/wiki/List_of_DNS_record_types.

- -

+

The following classes of resource records are currently valid in the DNS:

-
- +
@@ -11165,10 +10346,8 @@ view external { -
-
- -

+

+

The owner name is often implicit, rather than forming an integral part of the RR. For example, many name servers internally form @@ -11179,7 +10358,7 @@ view external { that fits the needs of the resource being described.

-

+

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 @@ -11198,18 +10377,17 @@ 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 @@ -11222,13 +10400,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 are 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. To avoid ambiguity @@ -11239,15 +10417,14 @@ view external { values are often omitted from examples in the interest of clarity.

-

+

The resource data or RDATA section of the RR is given using knowledge of the typical representation for the data.

-

+

For example, the RRs carried in a message might be shown as:

-
- +
@@ -11351,23 +10528,21 @@ 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.

-

+

Here is another possible example:

-
- +
@@ -11405,20 +10580,17 @@ 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, @@ -11427,8 +10599,7 @@ 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 @@ -11445,7 +10616,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 is ignored. Instead, @@ -11454,8 +10625,7 @@ view external { pointed to by the CNAME. For example:

-
- +
@@ -11592,20 +10762,18 @@ view external { -
-
+

Mail delivery is attempted to mail.example.com and mail2.example.com (in any order); if neither of those succeeds, delivery to mail.backup.org is attempted.

-
-
+
+

Setting TTLs

- -

+

The time-to- (TTL) 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 an RR can be cached before it @@ -11613,8 +10781,7 @@ view external { currently used in a zone file.

-
- +
@@ -11669,18 +10836,16 @@ 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 @@ -11695,8 +10860,7 @@ view external { PTR records if the machine has more than one name. For example, in the [example.com] domain:

-
- +
@@ -11727,24 +10891,22 @@ view external { -
-
-
+
+

Note

-

+

The $ORIGIN line in this example is only to provide context; it does not necessarily appear in the actual usage. It is only used here to indicate that the example is relative to the listed origin.

-
-
-
+
+
+

Other Zone File Directives

- -

+

The DNS "master file" format was initially defined in RFC 1035 and has subsequently been extended. While the format itself @@ -11752,32 +10914,30 @@ 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 a trailing dot (.).

-
-
+
+

The $ORIGIN Directive

- -

+

Syntax: $ORIGIN domain-name [comment]

-

$ORIGIN +

$ORIGIN sets the domain name that is appended to any unqualified records. When a zone is first read, there is an implicit $ORIGIN @@ -11787,47 +10947,42 @@ 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 ]

-

+

This reads and processes the file filename as if it were included in 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 @@ -11837,33 +10992,31 @@ 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 ]

-

+

This sets 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 Primary File Extension: the $GENERATE Directive

- -

+

Syntax: $GENERATE range lhs @@ -11873,7 +11026,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 @@ -11881,15 +11034,12 @@ 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.
@@ -11897,22 +11047,18 @@ $GENERATE 1-127 $ CNAME $.0
... 127.0.0.192.IN-ADDR.ARPA. CNAME 127.0.0.0.192.IN-ADDR.ARPA. - -

+

Both generate a set of A and MX records. Note the MX's right-hand side is a quoted string. The quotes are 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
@@ -11923,9 +11069,7 @@ HOST-3.EXAMPLE.   MX 0 .
 HOST-127.EXAMPLE. A  1.2.3.127
 HOST-127.EXAMPLE. MX 0 .
- -
- +
@@ -12053,33 +11197,30 @@ HOST-127.EXAMPLE. MX 0 . -
-
-

+

+

The $GENERATE directive is a BIND extension and not part of the standard zone file format.

-

+

BIND 8 did not support the optional TTL and CLASS fields.

-
- -
+
+

Additional File Formats

- -

+

In addition to the standard text 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 can be loaded @@ -12087,7 +11228,7 @@ HOST-127.EXAMPLE. MX 0 . function and 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 @@ -12098,7 +11239,7 @@ HOST-127.EXAMPLE. MX 0 . zone transfer or when applying prior updates, if one of these formats is specified by the masterfile-format option.

-

+

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. Make any @@ -12106,7 +11247,7 @@ HOST-127.EXAMPLE. MX 0 . then convert it to the binary form via the named-compilezone command again.

-

+

Note that map format is extremely architecture-specific. A map file cannot be used on a system @@ -12123,14 +11264,12 @@ HOST-127.EXAMPLE. MX 0 . portable backup of such a file, conversion to text format is recommended.

-
-
- -
+
+
+

BIND 9 Statistics

- -

+

BIND 9 maintains lots of statistics information and provides several interfaces for users to access those statistics. @@ -12138,14 +11277,11 @@ HOST-127.EXAMPLE. MX 0 . that are meaningful in BIND 9, and other information that is considered useful.

- -

+

The statistics information is categorized into the following sections:

- -
- +
@@ -12259,10 +11395,8 @@ 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 @@ -12272,13 +11406,11 @@ 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 plain-text format, dumped to the file specified @@ -12288,18 +11420,16 @@ 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 in seconds since January 1, 1970. @@ -12308,33 +11438,28 @@ 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 the statistics counters that BIND 9 provides. For each row of the tables, the leftmost column is the @@ -12350,13 +11475,10 @@ HOST-127.EXAMPLE. MX 0 . it gives the corresponding counter name of the BIND 8 statistics, if applicable.

- -
+

Name Server Statistics Counters

- -
- +
@@ -12974,16 +12096,12 @@ HOST-127.EXAMPLE. MX 0 . -
-
-
- -
+
+
+

Zone Maintenance Statistics Counters

- -
- +
@@ -13132,16 +12250,12 @@ HOST-127.EXAMPLE. MX 0 . -
-
-
- -
+
+
+

Resolver Statistics Counters

- -
- +
@@ -13517,16 +12631,12 @@ HOST-127.EXAMPLE. MX 0 . -
-
- -
- -
+
+
+

Socket I/O Statistics Counters

- -

+

Socket I/O statistics counters are defined per socket type, which are UDP4 (UDP/IPv4), @@ -13541,9 +12651,7 @@ HOST-127.EXAMPLE. MX 0 . Not all counters are available for all socket types; exceptions are noted in the description field.

- -
- +
@@ -13678,58 +12786,45 @@ 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. -

-
+

-
-
-
- -
+
+
+
+
@@ -13747,6 +12842,6 @@ HOST-127.EXAMPLE. MX 0 .
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.ch07.html b/doc/arm/Bv9ARM.ch07.html index f88429be9f..0c2d8a9ded 100644 --- a/doc/arm/Bv9ARM.ch07.html +++ b/doc/arm/Bv9ARM.ch07.html @@ -45,12 +45,10 @@
Dynamic Update Security
- -
+

Access Control Lists

- -

+

Access Control Lists (ACLs) are address match lists that can be set up and nicknamed for future use in allow-notify, allow-query, @@ -58,27 +56,26 @@ blackhole, allow-transfer, match-clients, etc.

-

+

ACLs give users finer control over who can access the name server, without cluttering up configuration files with huge lists of IP addresses.

-

+

It is a good idea to use ACLs, and to control access. Limiting access to the server by outside parties can help prevent spoofing and denial of service (DoS) attacks against the server.

-

+

ACLs match clients on the basis of up to three characteristics: 1) The client's IP address; 2) the TSIG or SIG(0) key that was used to sign the request, if any; and 3) an address prefix encoded in an EDNS Client-Subnet option, if any.

-

+

Here is an example of ACLs based on client addresses:

- 
 // Set up an ACL named "bogusnets" that blocks
 // RFC 1918 space and some reserved space, which is
@@ -107,14 +104,13 @@ zone "example.com" {
   allow-query { any; };
 };
- -

+

This allows authoritative queries for "example.com" from any address, but recursive queries only from the networks specified in "our-nets", and no queries at all from the networks specified in "bogusnets".

-

+

In addition to network addresses and prefixes, which are matched against the source address of the DNS request, ACLs may include key elements, which specify the @@ -123,7 +119,7 @@ zone "example.com" { if that prefix matches an EDNS client-subnet option included in the request.

-

+

The EDNS Client-Subnet (ECS) option is used by a recursive resolver to inform an authoritative name server of the network address block from which the original query was received, enabling @@ -137,9 +133,9 @@ zone "example.com" { in ACLs that are not prefixed with "ecs" are matched only against the source address.

-
+

Note

-

+

(Note: the authoritative ECS implementation in named is based on an early version of the specification, and is known to have incompatibilities with @@ -149,21 +145,21 @@ zone "example.com" { the configuration. It can be used for testing purposes, but is not recommended for production use.)

-
-

+

+

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 parameter 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", "asnum", and "domain".

-

+

value is the value to search for within the database. A string may be quoted if it contains spaces or other special characters. An "asnum" @@ -178,7 +174,7 @@ zone "example.com" { abbreviation; otherwise, it is treated as 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 @@ -195,7 +191,7 @@ zone "example.com" { the legacy GeoIP API, "netspeed" and "org" databases are also available.)

-

+

By default, if a DNS query includes an EDNS Client-Subnet (ECS) option which encodes a non-zero address prefix, then GeoIP ACL elements are matched against that address prefix. Otherwise, @@ -203,10 +199,10 @@ zone "example.com" { prevent GeoIP ACLs from matching against ECS options, set the geoip-use-ecs to no.

-

+

Some example GeoIP ACLs:

- 
geoip country US;
+
geoip country US;
 geoip country JP;
 geoip db country country Canada;
 geoip region WA;
@@ -216,8 +212,7 @@ geoip postal 95062;
 geoip tz "America/Los_Angeles";
 geoip org "Internet Systems Consortium";
 

-
-        

+

           ACLs use a "first-match" logic rather than "best-match";
           if an address prefix matches an ACL element, then that ACL
           is considered to have matched even if a later element would
@@ -227,7 +222,7 @@ geoip org "Internet Systems Consortium";
           indicates that the query should be accepted, and the second
           element is ignored.
         

-        

+

           When using "nested" ACLs (that is, ACLs included or referenced
           within other ACLs), a negative match of a nested ACL tells
           the containing ACL to continue looking for matches.  This
@@ -237,10 +232,10 @@ geoip org "Internet Systems Consortium";
           it originates from a particular network and
           only when it is signed with a particular key, use:
         

-        
+
 allow-query { !{ !10/8; any; }; key example; };
 

-        

+

           Within the nested ACL, any address that is
           not in the 10/8 network prefix is
           rejected, which terminates processing of the
@@ -252,14 +247,12 @@ allow-query { !{ !10/8; any; }; key example; };
           only matches when both conditions
           are true.
         

-
- -
+
+

Chroot and Setuid

- -

+

On Unix servers, it is possible to run BIND in a chrooted environment (using the chroot() function) by specifying @@ -268,25 +261,23 @@ allow-query { !{ !10/8; any; }; key example; }; BIND in a "sandbox," which limits 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

- -

+

For a chroot environment to work properly in a particular directory (for example, /var/named), the @@ -298,7 +289,7 @@ allow-query { !{ !10/8; any; }; key example; }; options like directory and pid-file must be adjusted to account for this.

-

+

Unlike with earlier versions of BIND, named does not typically need to be compiled statically, nor do shared libraries need to be installed under the new root. @@ -309,13 +300,11 @@ allow-query { !{ !10/8; any; }; key example; }; /dev/log, and /etc/localtime.

-
- -
+
+

Using the setuid Function

- -

+

Prior to running the named daemon, use the touch utility (to change file @@ -326,7 +315,7 @@ allow-query { !{ !10/8; any; }; key example; }; where BIND should write.

-
+

Note

If the named daemon is running as an @@ -334,14 +323,12 @@ allow-query { !{ !10/8; any; }; key example; }; 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 @@ -361,8 +348,7 @@ allow-query { !{ !10/8; any; }; key example; }; forwards it to the primary with its own source IP address - causing the primary 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 @@ -371,8 +357,7 @@ allow-query { !{ !10/8; any; }; key example; }; prefixes. Alternatively, the 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 @@ -380,9 +365,8 @@ allow-query { !{ !10/8; any; }; key example; }; of public web and mail servers, need not allow dynamic update at all.

- -
-
+
+
@@ -400,6 +384,6 @@ allow-query { !{ !10/8; any; }; key example; };
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.ch08.html b/doc/arm/Bv9ARM.ch08.html index c6cd8c5769..914f40e666 100644 --- a/doc/arm/Bv9ARM.ch08.html +++ b/doc/arm/Bv9ARM.ch08.html @@ -42,30 +42,25 @@
Where Can I Get Help?
- -
+

Common Problems

- -
+

It's Not Working; How Can I Figure Out What's Wrong?

- -

+

The best solution to installation and configuration issues is to take preventive measures by setting up logging files beforehand. The log files provide a source of hints and information that can be used to identify what went wrong and fix the problem.

- -
-
-
+
+
+

Incrementing and Changing the Serial Number

- -

+

Zone serial numbers are just numbers — they are not date-related. However, many people set them to a number that represents a date, usually of the form YYYYMMDDRR. @@ -77,32 +72,27 @@ lower than the serial number on the primary, the secondary server attempts to update its copy of the zone.

- -

+

Setting the serial number to a lower number on the primary server than the one on the secondary server means that the secondary 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 secondaries have updated to the new zone serial number, then reset it to the desired number and reload the zone again.

- -
-
+
+

Where Can I Get Help?

- -

+

The BIND-users mailing list, at https://lists.isc.org/mailman/listinfo/bind-users, is an excellent resource for peer user support. In addition, ISC maintains a Knowledgebase of helpful articles at https://kb.isc.org.

- -

+

Internet Systems Consortium (ISC) offers annual support agreements for BIND9, ISC DHCP, and Kea DHCP. @@ -110,15 +100,14 @@ service level agreements (SLAs), premium software features, and increased priority on bug fixes and feature requests.

- -

+

Please contact info@isc.org or visit https://www.isc.org/contact/ for more information.

-
-
+
+
@@ -136,6 +125,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.ch09.html b/doc/arm/Bv9ARM.ch09.html index d98db96939..e321a33bfb 100644 --- a/doc/arm/Bv9ARM.ch09.html +++ b/doc/arm/Bv9ARM.ch09.html @@ -36,11 +36,12 @@

Table of Contents

-
Release Notes for BIND Version 9.11.25
+
Release Notes for BIND Version 9.11.26
Introduction
Download
License Change
+
Notes for BIND 9.11.26
Notes for BIND 9.11.25
Notes for BIND 9.11.24
Notes for BIND 9.11.23
@@ -72,27 +73,26 @@
-
+

-Release Notes for BIND Version 9.11.25

- -
+Release Notes for BIND Version 9.11.26
+

Introduction

-

+

BIND 9.11 (Extended Support Version) is a stable branch of BIND. This document summarizes significant changes since the last production release on that branch.

-

+

Please see the file CHANGES for a more detailed list of changes and bug fixes.

-
+

Download

-

+

The latest versions of BIND 9 software can always be found at https://www.isc.org/download/. There you will find additional information about each release, @@ -100,79 +100,115 @@ operating systems.

-
+

License Change

-

+

With the release of BIND 9.11.0, ISC changed to the open source license for BIND from the ISC license to the Mozilla Public License (MPL 2.0).

-

+

The MPL-2.0 license requires that if you make changes to licensed software (e.g. BIND) and distribute them outside your organization, that you publish those changes under that same license. It does not require that you publish or disclose anything other than the changes you made to our software.

-

+

This requirement will not affect anyone who is using BIND, with or without modifications, without redistributing it, nor anyone redistributing it without changes. Therefore, this change will be without consequence for most individuals and organizations who are using BIND.

-

+

Those unsure whether or not the license change affects their use of BIND, or who wish to discuss how to comply with the license may contact ISC at https://www.isc.org/mission/contact/.

- -
+
+

+Notes for BIND 9.11.26

+
+

+Feature Changes

+
    +

  • + The default value of max-recursion-queries was + increased from 75 to 100. Since the queries sent towards root and TLD + servers are now included in the count (as a result of the fix for + CVE-2020-8616), max-recursion-queries has a higher + chance of being exceeded by non-attack queries, which is the main + reason for increasing its default value. [GL #2305] +

    • +

  • + The default value of nocookie-udp-size was restored + back to 4096 bytes. Since max-udp-size is the upper + bound for nocookie-udp-size, this change relieves + the operator from having to change + nocookie-udp-size together with + max-udp-size in order to increase the default EDNS + buffer size limit. nocookie-udp-size can still be + set to a value lower than max-udp-size, if desired. + [GL #2250] +

    • +
+
+
+

+Bug Fixes

+
    +

  • + Handling of missing DNS COOKIE responses over UDP was tightened by + falling back to TCP. [GL #2275] +

    • +

  • + The CNAME synthesized from a DNAME was incorrectly followed when the + QTYPE was CNAME or ANY. [GL #2280] +

    • +

  • + Building with native PKCS#11 support for AEP Keyper has been broken + since BIND 9.11.22. This has been fixed. [GL #2315] +

    • +
+
+
+

Notes for BIND 9.11.25

- -
+

Bug Fixes

-
    -
  • -

    +

      +

    • named acting as a resolver could incorrectly treat signed zones with no DS record at the parent as bogus. Such zones should be treated as insecure. This has been fixed. [GL #2236] -

      -
      • -
    • -

      +

      • +

    • After a Negative Trust Anchor (NTA) is added, BIND performs periodic checks to see if it is still necessary. If BIND encountered a failure while creating a query to perform such a check, it attempted to dereference a NULL pointer, resulting in a crash. [GL #2244] -

      -
      • -
    • -

      +

      • +

    • A problem obtaining glue records could prevent a stub zone from functioning properly, if the authoritative server for the zone were configured for minimal responses. [GL #1736] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.24

- -
+

Feature Changes

-
  • -

    +

    • DNS Flag Day 2020: The default EDNS buffer size has been changed from 4096 to 1232 bytes. According to measurements done by multiple parties, this should not cause any operational problems as most of @@ -184,93 +220,79 @@ maximum Ethernet payload size, so a useful default for maximum DNS/UDP payload size on reliable networks would be 1400 bytes. [GL #2183] -

      -
    -
- -
+

+
+

Bug Fixes

-
    -
  • -

    +

      +

    • named reported an invalid memory size when running in an environment that did not properly report the number of available memory pages and/or the size of each memory page. [GL #2166] -

      -
      • -
    • -

      +

      • +

    • With multiple forwarders configured, named could fail the REQUIRE(msg->state == (-1)) assertion in lib/dns/message.c, causing it to crash. This has been fixed. [GL #2124] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.23

- -
+

Bug Fixes

-
    -
  • -

    +

      +

    • Parsing of LOC records was made more strict by rejecting a sole period (.) and/or m as a value. These changes prevent zone files using such values from being loaded. Handling of negative altitudes which are not integers was also corrected. [GL #2074] -

      -
      • -
    • -

      +

      • +

    • Several problems found by OSS-Fuzz were fixed. (None of these are security issues.) [GL !3953] [GL !3975] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.22

- -
+

Security Fixes

-
    +
    • -

      +

      It was possible to trigger an assertion failure when verifying the response to a TSIG-signed request. This was disclosed in CVE-2020-8622.

      -

      +

      ISC would like to thank Dave Feldman, Jeff Warren, and Joel Cunningham of Oracle for bringing this vulnerability to our attention. [GL #2028]

      -
      • +
    • -

      +

      When BIND 9 was compiled with native PKCS#11 support, it was possible to trigger an assertion failure in code determining the number of bits in the PKCS#11 RSA public key with a specially crafted packet. This was disclosed in CVE-2020-8623.

      -

      +

      ISC would like to thank Lyu Chiy for bringing this vulnerability to our attention. [GL #2037]

      -
      • +
    • -

      +

      update-policy rules of type subdomain were incorrectly treated as zonesub rules, which allowed keys used in @@ -279,104 +301,82 @@ subdomain rules are again processed as described in the ARM. This was disclosed in CVE-2020-8624.

      -

      +

      ISC would like to thank Joop Boonen of credativ GmbH for bringing this vulnerability to our attention. [GL #2055]

      -
      • +
    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • Wildcard RPZ passthru rules could incorrectly be overridden by other rules that were loaded from RPZ zones which appeared later in the response-policy statement. This has been fixed. [GL #1619] -

      -
      • -
    • -

      +

      • +

    • LMDB locking code was revised to make rndc reconfig work properly on FreeBSD and with LMDB >= 0.9.26. [GL #1976] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.21

- -
+

Bug Fixes

-
    -
  • -

    +

      +

    • named could crash when cleaning dead nodes in lib/dns/rbtdb.c that were being reused. [GL #1968] -

      -
      • -
    • -

      +

      • +

    • Properly handle missing kyua command so that make check does not fail unexpectedly when CMocka is installed, but Kyua is not. [GL #1950] -

      -
      • -
    • -

      +

      • +

    • The validator could fail to accept a properly signed RRset if an unsupported algorithm appeared earlier in the DNSKEY RRset than a supported algorithm. It could also stop if it detected a malformed public key. [GL #1689] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.20

- -
+

Security Fixes

-
  • -

    +

    • It was possible to trigger an INSIST failure when a zone with an interior wildcard label was queried in a certain pattern. This was disclosed in CVE-2020-8619. [GL #1111] [GL #1718] -

      -
    -
- -
+

+
+

New Features

-
  • -

    +

    • dig and other tools can now print the Extended DNS Error (EDE) option when it appears in a request or a response. [GL #1835] -

      -
    -
- -
+

+
+

Bug Fixes

-
    -
  • -

    +

      +

    • When fully updating the NSEC3 chain for a large zone via IXFR, a temporary loss of performance could be experienced on the secondary server when answering queries for nonexistent data that required @@ -384,49 +384,37 @@ the server to find and to return NSEC3 data). The unnecessary processing step that was causing this delay has now been removed. [GL #1834] -

      -
      • -
    • -

      +

      • +

    • A data race in lib/dns/resolver.c:log_formerr() that could lead to an assertion failure was fixed. [GL #1808] -

      -
      • -
    • -

      +

      • +

    • Previously, provide-ixfr no; failed to return up-to-date responses when the serial number was greater than or equal to the current serial number. [GL #1714] -

      -
      • -
    • -

      +

      • +

    • named-checkconf -p could include spurious text in server-addresses statements due to an uninitialized DSCP value. This has been fixed. [GL #1812] -

      -
      • -
    • -

      +

      • +

    • The ARM has been updated to indicate that the TSIG session key is generated when named starts, regardless of whether it is needed. [GL #1842] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.19

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • To prevent exhaustion of server resources by a maliciously configured domain, the number of recursive queries that can be triggered by a request before aborting recursion has been further limited. Root and @@ -434,317 +422,246 @@ max-recursion-queries limit. Fetches for missing name server address records are limited to 4 for any domain. This issue was disclosed in CVE-2020-8616. [GL #1388] -

      -
      • -
    • -

      +

      • +

    • Replaying a TSIG BADTIME response as a request could trigger an assertion failure. This was disclosed in CVE-2020-8617. [GL #1703] -

      -
      • +

    -
- -
+
+

Feature Changes

-
  • -

    +

    • Message IDs in inbound AXFR transfers are now checked for consistency. Log messages are emitted for streams with inconsistent message IDs. [GL #1674] -

      -
    -
- -
+

+
+

Bug Fixes

-
    -
  • -

    +

      +

    • When running on a system with support for Linux capabilities, named drops root privileges very soon after system startup. This was causing a spurious log message, "unable to set effective uid to 0: Operation not permitted", which has now been silenced. [GL #1042] [GL #1090] -

      -
      • -
    • -

      +

      • +

    • When named-checkconf -z was run, it would sometimes incorrectly set its exit code. It reflected the status of the last view found; if zone-loading errors were found in earlier configured views but not in the last one, the exit code indicated success. Thanks to Graham Clinch. [GL #1807] -

      -
      • -
    • -

      +

      • +

    • When built without LMDB support, named failed to restart after a zone with a double quote (") in its name was added with rndc addzone. Thanks to Alberto Fernández. [GL #1695] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.18

- -
+

Security Fixes

-
  • -

    +

    • DNS rebinding protection was ineffective when BIND 9 is configured as a forwarding DNS server. Found and responsibly reported by Tobias Klein. [GL #1574] -

      -
    -
- -
+

+
+

Known Issues

-
  • -

    +

    • We have received reports that in some circumstances, receipt of an IXFR can cause the processing of queries to slow significantly. Some of these are related to RPZ processing, others appear to occur where there are NSEC3-related changes (such as an operator changing the NSEC3 salt used in the hash calculation). These are being investigated. [GL #1685] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.17

- -
+

Feature Changes

-
  • -

    +

    • The configure option --with-libxml2 now uses pkg-config to detect libxml2 library availability. You will either have to install pkg-config or specify the exact path where libxml2 has been installed on your system. [GL #1635] -

      -
    -
- -
+

+
+

Bug Fixes

-
  • -

    +

    • Fixed re-signing issues with inline zones which resulted in records being re-signed late or not at all. -

      -
    -
- +

-
+
+

Notes for BIND 9.11.16

- -
+

Bug Fixes

-
  • -

    +

    • named crashed when it was queried for a nonexistent name in the CHAOS class. [GL #1540] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.15

- -
+

Bug Fixes

-
    -
  • -

    +

      +

    • Fixed a GeoIP2 lookup bug which was triggered when certain libmaxminddb versions were used. [GL #1552] -

      -
      • -
    • -

      +

      • +

    • Fixed several possible race conditions discovered by ThreadSanitizer. -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.14

- -
+

Bug Fixes

-
    -
  • -

    +

      +

    • Fixed a bug that caused named to leak memory on reconfiguration when any GeoIP2 database was in use. [GL #1445] -

      -
      • -
    • -

      +

      • +

    • Fixed several possible race conditions discovered by ThreadSanitizer. -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.13

- -
+

Security Fixes

-
  • -

    +

    • Set a limit on the number of concurrently served pipelined TCP queries. This flaw is disclosed in CVE-2019-6477. [GL #1264] -

      -
    -
- -
+

+
+

New Features

-
  • -

    +

    • Added a new statistics variable tcp-highwater that reports the maximum number of simultaneous TCP clients BIND has handled while running. [GL #1206] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.12

- -

+

None.

-
-
+

Notes for BIND 9.11.11

- -

+

None.

-
-
+

Notes for BIND 9.11.10

- -
+

New Features

-
    +
    • -

      +

      A SipHash 2-4 based DNS Cookie (RFC 7873) algorithm has been added. [GL #605]

      -

      +

      If you are running multiple DNS Servers (different versions of BIND 9 or DNS server from multiple vendors) responding from the same IP address (anycast or load-balancing scenarios), you'll have to make sure that all the servers are configured with the same DNS Cookie algorithm and same Server Secret for the best performance.

      -
      • -
    • -

      +

      • +

    • DS records included in DNS referral messages can now be validated and cached immediately, reducing the number of queries needed for a DNSSEC validation. [GL #964] -

      -
      • +

    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • Interaction between DNS64 and RPZ No Data rule (CNAME *.) could cause unexpected results; this has been fixed. [GL #1106] -

      -
      • -
    • -

      +

      • +

    • named-checkconf now checks DNS64 prefixes to ensure bits 64-71 are zero. [GL #1159] -

      -
      • -
    • -

      +

      • +

    • named-checkconf could crash during configuration if configured to use "geoip continent" ACLs with legacy GeoIP. [GL #1163] -

      -
      • -
    • -

      +

      • +

    • named-checkconf now correctly reports a missing dnstap-output option when dnstap is set. [GL #1136] -

      -
      • -
    • -

      +

      • +

    • Handle ETIMEDOUT error on connect() with a non-blocking socket. [GL #1133] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.9

- -
+

New Features

-
  • -

    +

    • +

      The new GeoIP2 API from MaxMind is now supported when BIND is compiled using configure --with-geoip2. The legacy GeoIP API can be used by compiling with @@ -752,7 +669,7 @@ the databases for the legacy API are no longer maintained by MaxMind.)

      -

      +

      The default path to the GeoIP2 databases will be set based on the location of the libmaxminddb library; for example, if it is in /usr/local/lib, @@ -761,7 +678,7 @@ This value can be overridden in named.conf using the geoip-directory option.

      -

      +

      Some geoip ACL settings that were available with legacy GeoIP, including searches for netspeed, org, and three-letter ISO country codes, will @@ -771,60 +688,48 @@ as. All of the databases support both IPv4 and IPv6 lookups. [GL #182]

      -
    -
- -
+
+
+

Bug Fixes

-
  • -

    +

    • Glue address records were not being returned in responses to root priming queries; this has been corrected. [GL #1092] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.8

- -
+

Security Fixes

-
  • -

    +

    • A race condition could trigger an assertion failure when a large number of incoming packets were being rejected. This flaw is disclosed in CVE-2019-6471. [GL #942] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.7

- -
+

Security Fixes

-
  • -

    +

    • The TCP client quota set using the tcp-clients option could be exceeded in some cases. This could lead to exhaustion of file descriptors. This flaw is disclosed in CVE-2018-5743. [GL #615] -

      -
    -
- -
+

+
+

Feature Changes

-
  • -

    +

    • +

      When trusted-keys and managed-keys are both configured for the same name, or when trusted-keys is used to @@ -833,26 +738,23 @@ auto, automatic RFC 5011 key rollovers will fail.

      -

      +

      This combination of settings was never intended to work, but there was no check for it in the parser. This has been corrected; a warning is now logged. (In BIND 9.15 and higher this error will be fatal.) [GL #868]

      -
    -
- +
-
+
+

Notes for BIND 9.11.6

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • Code change #4964, intended to prevent double signatures when deleting an inactive zone DNSKEY in some situations, introduced a new problem during zone processing in which @@ -863,134 +765,105 @@ NSEC/NSEC3 chain, but incompletely -- this can result in a broken chain, affecting validation of proof of nonexistence for records in the zone. [GL #771] -

      -
      • -
    • -

      +

      • +

    • named could crash if it managed a DNSSEC security root with managed-keys and the authoritative zone rolled the key to an algorithm not supported by BIND 9. This flaw is disclosed in CVE-2018-5745. [GL #780] -

      -
      • -
    • -

      +

      • +

    • named leaked memory when processing a request with multiple Key Tag EDNS options present. ISC would like to thank Toshifumi Sakaguchi for bringing this to our attention. This flaw is disclosed in CVE-2018-5744. [GL #772] -

      -
      • -
    • -

      +

      • +

    • Zone transfer controls for writable DLZ zones were not effective as the allowzonexfr method was not being called for such zones. This flaw is disclosed in CVE-2019-6465. [GL #790] -

      -
      • +

    -
- -
+
+

Feature Changes

-
  • -

    +

    • When compiled with IDN support, the dig and the nslookup commands now disable IDN processing when the standard output is not a tty (e.g. not used by human). The command line options +idnin and +idnout need to be used to enable IDN processing when dig or nslookup is used from the shell scripts. -

      -
    -
- +

-
+
+

Notes for BIND 9.11.5

- -
+

Security Fixes

-
  • -

    +

    • named could crash during recursive processing of DNAME records when deny-answer-aliases was in use. This flaw is disclosed in CVE-2018-5740. [GL #387] -

      -
    -
- -
+

+
+

New Features

-
  • -

    +

    • Two new update policy rule types have been added krb5-selfsub and ms-selfsub which allow machines with Kerberos principals to update the name space at or below the machine names identified in the respective principals. -

      -
    -
- -
+

+
+

Feature Changes

-
  • -

    +

    • The rndc nta command could not differentiate between views of the same name but different class; this has been corrected with the addition of a -class option. [GL #105] -

      -
    -
- -
+

+
+

Bug Fixes

-
  • -

    +

    • When a negative trust anchor was added to multiple views using rndc nta, the text returned via rndc was incorrectly truncated after the first line, making it appear that only one NTA had been added. This has been fixed. [GL #105] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.4

- -
+

Security Fixes

-
  • -

    +

    • When recursion is enabled but the allow-recursion and allow-query-cache ACLs are not specified, they should be limited to local networks, but they were inadvertently set to match the default allow-query, thus allowing remote queries. This flaw is disclosed in CVE-2018-5738. [GL #309] -

      -
    -
- -
+

+
+

New Features

-
    -
  • -

    +

      +

    • named now supports the "root key sentinel" mechanism. This enables validating resolvers to indicate which trust anchors are configured for the root, so that @@ -998,16 +871,15 @@ To disable this feature, add root-key-sentinel no; to named.conf. -

      -
      • +

    • -

      +

      Added the ability not to return a DNS COOKIE option when one is present in the request. To prevent a cookie being returned, add answer-cookie no; to named.conf. [GL #173]

      -

      +

      answer-cookie no is only intended as a temporary measure, for use when named shares an IP address with other servers that do not yet @@ -1019,106 +891,85 @@ mechanism, and should not be disabled unless absolutely necessary.

      -
      • +
    -
- -
+
+

Removed Features

-
  • -

    +

    • named will now log a warning if the old BIND now can be compiled against libidn2 library to add IDNA2008 support. Previously BIND only supported IDNA2003 using (now obsolete) idnkit-1 library. -

      -
    -
- -
+

+
+

Feature Changes

-
    -
  • -

    +

      +

    • dig +noidnin can be used to disable IDN processing on the input domain name, when BIND is compiled with IDN support. -

      -
      • -
    • -

      +

      • +

    • Multiple cookie-secret clause are now supported. The first cookie-secret in named.conf is used to generate new server cookies. Any others are used to accept old server cookies or those generated by other servers using the matching cookie-secret. -

      -
      • +

    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • named now rejects excessively large incremental (IXFR) zone transfers in order to prevent possible corruption of journal files which could cause named to abort when loading zones. [GL #339] -

      -
      • -
    • -

      +

      • +

    • rndc reload could cause named to leak memory if it was invoked before the zone loading actions from a previous rndc reload command were completed. [RT #47076] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.3

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • Addresses could be referenced after being freed during resolver processing, causing an assertion failure. The chances of this happening were remote, but the introduction of a delay in resolution increased them. This bug is disclosed in CVE-2017-3145. [RT #46839] -

      -
      • -
    • -

      +

      • +

    • update-policy rules that otherwise ignore the name field now require that it be set to "." to ensure that any type list present is properly interpreted. If the name field was omitted from the rule declaration and a type list was present it wouldn't be interpreted as expected. -

      -
      • +

    -
- -
+
+

Removed Features

-
    -
  • -

    +

      +

    • The ISC DNSSEC Lookaside Validation (DLV) service has been shut down; all DLV records in the dlv.isc.org zone have been removed. References to the service have been @@ -1128,24 +979,19 @@ Setting dnssec-lookaside to auto or to use dlv.isc.org as a trust anchor results in a warning being issued. -

      -
      • -
    • -

      +

      • +

    • named will now log a warning if the old root DNSSEC key is explicitly configured and has not been updated. [RT #43670] -

      -
      • +

    -
- -
+
+

Protocol Changes

-
    -
  • -

    +

      +

    • BIND can now use the Ed25519 and Ed448 Edwards Curve DNSSEC signing algorithms described in RFC 8080. Note, however, that these algorithms must be supported in OpenSSL; @@ -1154,25 +1000,20 @@ https://github.com/openssl/openssl. [RT #44696] -

      -
      • -
    • -

      +

      • +

    • When parsing DNS messages, EDNS KEY TAG options are checked for correctness. When printing messages (for example, in dig), EDNS KEY TAG options are printed in readable format. -

      -
      • +

    -
- -
+
+

Feature Changes

-
    -
  • -

    +

      +

    • named will no longer start or accept reconfiguration if managed-keys or dnssec-validation auto are in use and @@ -1180,280 +1021,216 @@ managed-keys-directory, and defaulting to the working directory if not specified), is not writable by the effective user ID. [RT #46077] -

      -
      • -
    • -

      +

      • +

    • Previously, update-policy local; accepted updates from any source so long as they were signed by the locally-generated session key. This has been further restricted; updates are now only accepted from locally configured addresses. [RT #45492] -

      -
      • +

    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • Attempting to validate improperly unsigned CNAME responses from secure zones could cause a validator loop. This caused a delay in returning SERVFAIL and also increased the chances of encountering the crash bug described in CVE-2017-3145. [RT #46839] -

      -
      • -
    • -

      +

      • +

    • When named was reconfigured, failure of some zones to load correctly could leave the system in an inconsistent state; while generally harmless, this could lead to a crash later when using rndc addzone. Reconfiguration changes are now fully rolled back in the event of failure. [RT #45841] -

      -
      • -
    • -

      +

      • +

    • Some header files included <isc/util.h> incorrectly as it pollutes with namespace with non ISC_ macros and this should only be done by explicitly including <isc/util.h>. This has been corrected. Some code may depend on <isc/util.h> being implicitly included via other header files. Such code should explicitly include <isc/util.h>. -

      -
      • -
    • -

      +

      • +

    • Zones created with rndc addzone could temporarily fail to inherit the allow-transfer ACL set in the options section of named.conf. [RT #46603] -

      -
      • -
    • -

      +

      • +

    • named failed to properly determine whether there were active KSK and ZSK keys for an algorithm when update-check-ksk was true (which is the default setting). This could leave records unsigned when rolling keys. [RT #46743] [RT #46754] [RT #46774] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.2

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • An error in TSIG handling could permit unauthorized zone transfers or zone updates. These flaws are disclosed in CVE-2017-3142 and CVE-2017-3143. [RT #45383] -

      -
      • -
    • -

      +

      • +

    • The BIND installer on Windows used an unquoted service path, which can enable privilege escalation. This flaw is disclosed in CVE-2017-3141. [RT #45229] -

      -
      • -
    • -

      +

      • +

    • With certain RPZ configurations, a response with TTL 0 could cause named to go into an infinite query loop. This flaw is disclosed in CVE-2017-3140. [RT #45181] -

      -
      • +

    -
- -
+
+

Feature Changes

-
    -
  • -

    +

      +

    • dig +ednsopt now accepts the names for EDNS options in addition to numeric values. For example, an EDNS Client-Subnet option could be sent using dig +ednsopt=ecs:.... Thanks to John Worley of Secure64 for the contribution. [RT #44461] -

      -
      • -
    • -

      +

      • +

    • Threads in named are now set to human-readable names to assist debugging on operating systems that support that. Threads will have names such as "isc-timer", "isc-sockmgr", "isc-worker0001", and so on. This will affect the reporting of subsidiary thread names in ps and top, but not the main thread. [RT #43234] -

      -
      • -
    • -

      +

      • +

    • DiG now warns about .local queries which are reserved for Multicast DNS. [RT #44783] -

      -
      • +

    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • Fixed a bug that was introduced in an earlier development release which caused multi-packet AXFR and IXFR messages to fail validation if not all packets contained TSIG records; this caused interoperability problems with some other DNS implementations. [RT #45509] -

      -
      • -
    • -

      +

      • +

    • Reloading or reconfiguring named could fail on some platforms when LMDB was in use. [RT #45203] -

      -
      • -
    • -

      +

      • +

    • Due to some incorrectly deleted code, when BIND was built with LMDB, zones that were deleted via rndc delzone were removed from the running server but were not removed from the new zone database, so that deletion did not persist after a server restart. This has been corrected. [RT #45185] -

      -
      • -
    • -

      +

      • +

    • Semicolons are no longer escaped when printing CAA and URI records. This may break applications that depend on the presence of the backslash before the semicolon. [RT #45216] -

      -
      • -
    • -

      +

      • +

    • AD could be set on truncated answer with no records present in the answer and authority sections. [RT #45140] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.1

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • rndc "" could trigger an assertion failure in named. This flaw is disclosed in (CVE-2017-3138). [RT #44924] -

      -
      • -
    • -

      +

      • +

    • Some chaining (i.e., type CNAME or DNAME) responses to upstream queries could trigger assertion failures. This flaw is disclosed in CVE-2017-3137. [RT #44734] -

      -
      • -
    • -

      +

      • +

    • dns64 with break-dnssec yes; can result in an assertion failure. This flaw is disclosed in CVE-2017-3136. [RT #44653] -

      -
      • -
    • -

      +

      • +

    • If a server is configured with a response policy zone (RPZ) that rewrites an answer with local data, and is also configured for DNS64 address mapping, a NULL pointer can be read triggering a server crash. This flaw is disclosed in CVE-2017-3135. [RT #44434] -

      -
      • -
    • -

      +

      • +

    • A coding error in the nxdomain-redirect feature could lead to an assertion failure if the redirection namespace was served from a local authoritative data source such as a local zone or a DLZ instead of via recursive lookup. This flaw is disclosed in CVE-2016-9778. [RT #43837] -

      -
      • -
    • -

      +

      • +

    • named could mishandle authority sections with missing RRSIGs, triggering an assertion failure. This flaw is disclosed in CVE-2016-9444. [RT #43632] -

      -
      • -
    • -

      +

      • +

    • named mishandled some responses where covering RRSIG records were returned without the requested data, resulting in an assertion failure. This flaw is disclosed in CVE-2016-9147. [RT #43548] -

      -
      • -
    • -

      +

      • +

    • named incorrectly tried to cache TKEY records which could trigger an assertion failure when there was a class mismatch. This flaw is disclosed in CVE-2016-9131. [RT #43522] -

      -
      • -
    • -

      +

      • +

    • It was possible to trigger assertions when processing responses containing answers of type DNAME. This flaw is disclosed in CVE-2016-8864. [RT #43465] -

      -
      • -
    • -

      +

      • +

    • 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] -

      -
      • +

    -
- -
+
+

Feature Changes

-
    -
  • -

    +

      +

    • dnstap now stores both the local and remote addresses for all messages, instead of only the remote address. The default output format for dnstap-read has @@ -1461,104 +1238,79 @@ address first and the responding address second, separated by "-%gt;" or "%lt;-" to indicate in which direction the message was sent. [RT #43595] -

      -
      • -
    • -

      +

      • +

    • Expanded and improved the YAML output from dnstap-read -y: it now includes packet size and a detailed breakdown of message contents. [RT #43622] [RT #43642] -

      -
      • -
    • -

      +

      • +

    • If an ACL is specified with an address prefix in which the prefix length is longer than the address portion (for example, 192.0.2.1/8), named will now log a warning. In future releases this will be a fatal configuration error. [RT #43367] -

      -
      • +

    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • A synthesized CNAME record appearing in a response before the associated DNAME could be cached, when it should not have been. This was a regression introduced while addressing CVE-2016-8864. [RT #44318] -

      -
      • -
    • -

      +

      • +

    • named could deadlock if multiple changes to NSEC/NSEC3 parameters for the same zone were being processed at the same time. [RT #42770] -

      -
      • -
    • -

      +

      • +

    • named could trigger an assertion when sending NOTIFY messages. [RT #44019] -

      -
      • -
    • -

      +

      • +

    • Referencing a nonexistent zone in a response-policy statement could cause an assertion failure during configuration. [RT #43787] -

      -
      • -
    • -

      +

      • +

    • rndc addzone could cause a crash when attempting to add a zone with a type other than master or slave. Such zones are now rejected. [RT #43665] -

      -
      • -
    • -

      +

      • +

    • named could hang when encountering log file names with large apparent gaps in version number (for example, when files exist called "logfile.0", "logfile.1", and "logfile.1482954169"). This is now handled correctly. [RT #38688] -

      -
      • -
    • -

      +

      • +

    • If a zone was updated while named was processing a query for nonexistent data, it could return out-of-sync NSEC3 records causing potential DNSSEC validation failure. [RT #43247] -

      -
      • +

    -
- -
+
+

Maintenance

-
  • -

    +

    • The built-in root hints have been updated to include an IPv6 address (2001:500:12::d0d) for G.ROOT-SERVERS.NET. -

      -
    -
- -
+

+
+

Miscellaneous Notes

-
  • -

    +

    • Authoritative server support for the EDNS Client Subnet option (ECS), introduced in BIND 9.11.0, was based on an early version of the specification, and is now known to have incompatibilities @@ -1568,51 +1320,43 @@ testing purposes but is not recommended for for production use. This was not made sufficiently clear in the documentation at the time of release. -

      -
    -
- +

-
+
+

Notes for BIND 9.11.0

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • 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] -

      -
      • +

    -
- -
+
+

New Features

-
    +
    • -

      +

      A new method of provisioning secondary servers called "Catalog Zones" has been added. This is an implementation of draft-muks-dnsop-dns-catalog-zones/ .

      -

      +

      A catalog zone is a regular DNS zone which contains a list of "member zones", along with the configuration options for each of those zones. When a server is configured to use a @@ -1625,32 +1369,30 @@ propagated to slaves using the standard AXFR/IXFR update mechanism.

      -

      +

      This feature should be considered experimental. It currently supports only basic features; more advanced features such as ACLs and TSIG keys are not yet supported. Example catalog zone configurations can be found in the Chapter 9 of the BIND Administrator Reference Manual.

      -

      +

      Support for master entries with TSIG keys has been added to catalog zones, as well as support for allow-query and allow-transfer.

      -
      • -
    • -

      +

      • +

    • Added an isc.rndc Python module, which allows rndc commands to be sent from Python programs. -

      -
      • +

    • -

      +

      Added support for DynDB, a new interface for loading zone data from an external database, developed by Red Hat for the FreeIPA project. (Thanks in particular to Adam Tkac and Petr Spacek of Red Hat for the contribution.)

      -

      +

      Unlike the existing DLZ and SDB interfaces, which provide a limited subset of database functionality within BIND - translating DNS queries into real-time database lookups with @@ -1658,22 +1400,22 @@ DNSSEC-signed data - DynDB is able to fully implement and extend the database API used natively by BIND.

      -

      +

      A DynDB module could pre-load data from an external data source, then serve it with the same performance and functionality as conventional BIND zones, and with the ability to take advantage of database features not available in BIND, such as multi-master replication.

      -
      • +
    • -

      +

      Fetch quotas are now compiled in by default: they no longer require BIND to be configured with --enable-fetchlimit, as was the case when the feature was introduced in BIND 9.10.3.

      -

      +

      These quotas limit the queries that are sent by recursive resolvers to authoritative servers experiencing denial-of-service attacks. They can both reduce the harm done to authoritative @@ -1681,9 +1423,8 @@ experienced by recursive servers when they are being used as a vehicle for such an attack.

      -
        -
      • -

        +

          +

        • fetches-per-server limits the number of simultaneous queries that can be sent to any single authoritative server. The configured value is a starting @@ -1691,41 +1432,38 @@ partially or completely non-responsive. The algorithm used to adjust the quota can be configured via the fetch-quota-params option. -

          -
          • -
        • -

          +

          • +

        • fetches-per-zone limits the number of simultaneous queries that can be sent for names within a single domain. (Note: Unlike "fetches-per-server", this value is not self-tuning.) -

          -
          • +

        -

        +

        Statistics counters have also been added to track the number of queries affected by these quotas.

        -
        • +
      • -

        +

        Added support for dnstap, a fast, flexible method for capturing and logging DNS traffic, developed by Robert Edmonds at Farsight Security, Inc., whose assistance is gratefully acknowledged.

        -

        +

        To enable dnstap at compile time, the fstrm and protobuf-c libraries must be available, and BIND must be configured with --enable-dnstap.

        -

        +

        A new utility dnstap-read has been added to allow dnstap data to be presented in a human-readable format.

        -

        +

        rndc dnstap -roll causes dnstap output files to be rolled like log files -- the most recent output file is renamed with a .0 suffix, the next @@ -1735,18 +1473,18 @@ argument specifies how many backup log files to retain; if not specified or set to 0, there is no limit.

        -

        +

        rndc dnstap -reopen simply closes and reopens the dnstap output channel without renaming the output file.

        -

        +

        For more information on dnstap, see https://dnstap.info.

        -
        • +
      • -

        +

        New statistics counters have been added to track traffic sizes, as specified in RSSAC002. Query and response message sizes are broken up into ranges of histogram buckets: @@ -1758,13 +1496,13 @@ or http://localhost:8888/json/v1/traffic.

        -

        +

        Statistics for RSSAC02v3 traffic-volume, traffic-sizes and rcode-volume reporting are now collected.

        -
        • +
      • -

        +

        A new DNSSEC key management utility, dnssec-keymgr, has been added. This tool is meant to run unattended (e.g., under cron). @@ -1778,25 +1516,24 @@ the configured policy changes, keys are corrected automatically. See the dnssec-keymgr man page for full details.

        -

        +

        Note: dnssec-keymgr depends on Python and on the Python lex/yacc module, PLY. The other Python-based tools, dnssec-coverage and dnssec-checkds, have been refactored and updated as part of this work.

        -

        +

        dnssec-keymgr now takes a -r randomfile option.

        -

        +

        (Many thanks to Sebastián Castro for his assistance in developing this tool at the IETF 95 Hackathon in Buenos Aires, April 2016.)

        -
        • -
      • -

        +

        • +

      • The serial number of a dynamically updatable zone can now be set using rndc signing -serial number zonename. @@ -1804,10 +1541,8 @@ zones that have been reset. Setting the serial number to a value larger than that on the slaves will trigger an AXFR-style transfer. -

        -
        • -
      • -

        +

        • +

      • When answering recursive queries, SERVFAIL responses can now be cached by the server for a limited time; subsequent queries for the same query name and type will return another SERVFAIL until @@ -1816,10 +1551,8 @@ on recursive servers. The SERVFAIL cache timeout is controlled by servfail-ttl, which defaults to 1 second and has an upper limit of 30. -

        -
        • -
      • -

        +

        • +

      • The new rndc nta command can now be used to set a "negative trust anchor" (NTA), disabling DNSSEC validation for a specific domain; this can be used when responses from a domain @@ -1831,112 +1564,80 @@ named.conf. When added, NTAs are stored in a file (viewname.nta) in order to persist across restarts of the named server. -

        -
        • -
      • -

        +

        • +

      • The EDNS Client Subnet (ECS) option is now supported for authoritative servers; if a query contains an ECS option then ACLs containing geoip or ecs elements can match against the address encoded in the option. This can be used to select a view for a query, so that different answers can be provided depending on the client network. -

        -
        • -
      • -

        +

        • +

      • The EDNS EXPIRE option has been implemented on the client side, allowing a slave server to set the expiration timer correctly when transferring zone data from another slave server. -

        -
        • -
      • -

        +

        • +

      • A new masterfile-style zone option controls the formatting of text zone files: When set to full, the zone file will dumped in single-line-per-record format. -

        -
        • -
      • -

        +

        • +

      • dig +ednsopt can now be used to set arbitrary EDNS options in DNS requests. -

        -
        • -
      • -

        +

        • +

      • dig +ednsflags can now be used to set yet-to-be-defined EDNS flags in DNS requests. -

        -
        • -
      • -

        +

        • +

      • dig +[no]ednsnegotiation can now be used enable / disable EDNS version negotiation. -

        -
        • -
      • -

        +

        • +

      • dig +header-only can now be used to send queries without a question section. -

        -
        • -
      • -

        +

        • +

      • dig +ttlunits causes dig to print TTL values with time-unit suffixes: w, d, h, m, s for weeks, days, hours, minutes, and seconds. -

        -
        • -
      • -

        +

        • +

      • dig +zflag can be used to set the last unassigned DNS header flag bit. This bit is normally zero. -

        -
        • -
      • -

        +

        • +

      • dig +dscp=value can now be used to set the DSCP code point in outgoing query packets. -

        -
        • -
      • -

        +

        • +

      • dig +mapped can now be used to determine if mapped IPv4 addresses can be used. -

        -
        • -
      • -

        +

        • +

      • nslookup will now look up IPv6 as well as IPv4 addresses by default. [RT #40420] -

        -
        • -
      • -

        +

        • +

      • serial-update-method can now be set to date. On update, the serial number will be set to the current date in YYYYMMDDNN format. -

        -
        • -
      • -

        +

        • +

      • dnssec-signzone -N date also sets the serial number to YYYYMMDDNN. -

        -
        • -
      • -

        +

        • +

      • named -L filename causes named to send log messages to the specified file by default instead of to the system log. -

        -
        • -
      • -

        +

        • +

      • The rate limiter configured by the serial-query-rate option no longer covers NOTIFY messages; those are now separately controlled by @@ -1944,31 +1645,23 @@ startup-notify-rate (the latter of which controls the rate of NOTIFY messages sent when the server is first started up or reconfigured). -

        -
        • -
      • -

        +

        • +

      • The default number of tasks and client objects available for serving lightweight resolver queries have been increased, and are now configurable via the new lwres-tasks and lwres-clients options in named.conf. [RT #35857] -

        -
        • -
      • -

        +

        • +

      • Log output to files can now be buffered by specifying buffered yes; when creating a channel. -

        -
        • -
      • -

        +

        • +

      • delv +tcp will exclusively use TCP when sending queries. -

        -
        • -
      • -

        +

        • +

      • named will now check to see whether other name server processes are running before starting up. This is implemented in two ways: 1) by refusing to start @@ -1980,10 +1673,8 @@ /var/run/named/named.lock. Specifying none will disable the lock file check. -

        -
        • -
      • -

        +

        • +

      • rndc delzone can now be applied to zones which were configured in named.conf; it is no longer restricted to zones which were added by @@ -1991,22 +1682,17 @@ this does not edit named.conf; the zone must be removed from the configuration or it will return when named is restarted or reloaded.) -

        -
        • -
      • -

        +

        • +

      • rndc modzone can be used to reconfigure a zone, using similar syntax to rndc addzone. -

        -
        • -
      • -

        +

        • +

      • rndc showzone displays the current configuration for a specified zone. -

        -
        • +

      • -

        +

        When BIND is built with the lmdb library (Lightning Memory-Mapped Database), named will store the configuration information for zones @@ -2018,70 +1704,61 @@ the contents of a database is much faster than rewriting a text file.

        -

        +

        On startup, if named finds an existing NZF file, it will automatically convert it to the new NZD database format.

        -

        +

        To view the contents of an NZD, or to convert an NZD back to an NZF file (for example, to revert back to an earlier version of BIND which did not support the NZD format), use the new command named-nzd2nzf [RT #39837]

        -
        • +
      • -

        +

        Added server-side support for pipelined TCP queries. Clients may continue sending queries via TCP while previous queries are processed in parallel. Responses are sent when they are ready, not necessarily in the order in which the queries were received.

        -

        +

        To revert to the former behavior for a particular client address or range of addresses, specify the address prefix in the "keep-response-order" option. To revert to the former behavior for all clients, use "keep-response-order { any; };".

        -
        • -
      • -

        +

        • +

      • The new mdig command is a version of dig that sends multiple pipelined queries and then waits for responses, instead of sending one query and waiting the response before sending the next. [RT #38261] -

        -
        • -
      • -

        +

        • +

      • To enable better monitoring and troubleshooting of RFC 5011 trust anchor management, the new rndc managed-keys can be used to check status of trust anchors or to force keys to be refreshed. Also, the managed-keys data file now has easier-to-read comments. [RT #38458] -

        -
        • -
      • -

        +

        • +

      • An --enable-querytrace configure switch is now available to enable very verbose query trace logging. This option can only be set at compile time. This option has a negative performance impact and should be used only for debugging. [RT #37520] -

        -
        • -
      • -

        +

        • +

      • A new tcp-only option can be specified in server statements to force named to connect to the specified server via TCP. [RT #37800] -

        -
        • -
      • -

        +

        • +

      • The nxdomain-redirect option specifies a DNS namespace to use for NXDOMAIN redirection. When a recursive lookup returns NXDOMAIN, a second lookup is @@ -2091,25 +1768,19 @@ queries to other servers. (The older method, using a single type redirect zone, has better average performance but is less flexible.) [RT #37989] -

        -
        • -
      • -

        +

        • +

      • The following types have been implemented: CSYNC, NINFO, RKEY, SINK, TA, TALINK. -

        -
        • -
      • -

        +

        • +

      • A new message-compression option can be used to specify whether or not to use name compression when answering queries. Setting this to no results in larger responses, but reduces CPU consumption and may improve throughput. The default is yes. -

        -
        • -
      • -

        +

        • +

      • A read-only option is now available in the controls statement to grant non-destructive control channel access. In such cases, a restricted set of @@ -2118,28 +1789,22 @@ reconfigure or stop the server. By default, the control channel access is not restricted to these read-only operations. [RT #40498] -

        -
        • -
      • -

        +

        • +

      • 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. -

        -
        • -
      • -

        +

        • +

      • The new minimal-any option reduces the size of answers to UDP queries for type ANY by implementing one of the strategies in "draft-ietf-dnsop-refuse-any": returning a single arbitrarily-selected RRset that matches the query name rather than returning all of the matching RRsets. Thanks to Tony Finch for the contribution. [RT #41615] -

        -
        • -
      • -

        +

        • +

      • named now provides feedback to the owners of zones which have trust anchors configured (trusted-keys, @@ -2149,61 +1814,50 @@ configured trust anchors for the zone. This is controlled by trust-anchor-telemetry and defaults to yes. -

        -
        • +

      -
    - -
    +
    +

    Feature Changes

    -
      +
      • -

        +

        The logging format used for querylog has been altered. It now includes an additional field indicating the address in memory of the client object processing the query.

        -

        +

        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]

        -
        • -
      • -

        +

        • +

      • The timers returned by the statistics channel (indicating current time, server boot time, and most recent reconfiguration time) are now reported with millisecond accuracy. [RT #40082] -

        -
        • -
      • -

        +

        • +

      • Updated the compiled-in addresses for H.ROOT-SERVERS.NET and L.ROOT-SERVERS.NET. -

        -
        • -
      • -

        +

        • +

      • ACLs containing geoip asnum elements were not correctly matched unless the full organization name was specified in the ACL (as in geoip asnum "AS1234 Example, Inc.";). They can now match against the AS number alone (as in geoip asnum "AS1234";). -

        -
        • -
      • -

        +

        • +

      • When using native PKCS#11 cryptography (i.e., configure --enable-native-pkcs11) HSM PINs of up to 256 characters can now be used. -

        -
        • -
      • -

        +

        • +

      • NXDOMAIN responses to queries of type DS are now cached separately from those for other types. This helps when using "grafted" zones of type forward, for which the parent zone does not contain a @@ -2213,29 +1867,21 @@ change is only helpful when DNSSEC validation is not enabled. "Grafted" zones without a delegation in the parent are not a recommended configuration.) -

        -
        • -
      • -

        +

        • +

      • Update forwarding performance has been improved by allowing a single TCP connection to be shared between multiple updates. -

        -
        • -
      • -

        +

        • +

      • By default, nsupdate will now check the correctness of hostnames when adding records of type A, AAAA, MX, SOA, NS, SRV or PTR. This behavior can be disabled with check-names no. -

        -
        • -
      • -

        +

        • +

      • Added support for OPENPGPKEY type. -

        -
        • -
      • -

        +

        • +

      • The names of the files used to store managed keys and added zones for each view are no longer based on the SHA256 hash of the view name, except when this is necessary because the @@ -2248,80 +1894,64 @@ or external.nzf). However, to ensure consistent behavior when upgrading, if a file using the old name format is found to exist, it will continue to be used. -

        -
        • -
      • -

        +

        • +

      • "rndc" can now return text output of arbitrary size to the caller. (Prior to this, certain commands such as "rndc tsig-list" and "rndc zonestatus" could return truncated output.) -

        -
        • -
      • -

        +

        • +

      • Errors reported when running rndc addzone (e.g., when a zone file cannot be loaded) have been clarified to make it easier to diagnose problems. -

        -
        • -
      • -

        +

        • +

      • When encountering an authoritative name server whose name is an alias pointing to another name, the resolver treats this as an error and skips to the next server. Previously this happened silently; now the error will be logged to the newly-created "cname" log category. -

        -
        • -
      • -

        +

        • +

      • If named is not configured to validate answers, then allow fallback to plain DNS on timeout even when we know the server supports EDNS. This will allow the server to potentially resolve signed queries when TCP is being blocked. -

        -
        • -
      • -

        +

        • +

      • Large inline-signing changes should be less disruptive. Signature generation is now done incrementally; the number of signatures to be generated in each quantum is controlled by "sig-signing-signatures number;". [RT #37927] -

        -
        • +

      • -

        +

        The experimental SIT option (code point 65001) of BIND 9.10.0 through BIND 9.10.2 has been replaced with the COOKIE option (code point 10). It is no longer experimental, and is sent by default, by both named and dig.

        -

        +

        The SIT-related named.conf options have been marked as obsolete, and are otherwise ignored.

        -
        • -
      • -

        +

        • +

      • When dig receives a truncated (TC=1) response or a BADCOOKIE response code from a server, it will automatically retry the query using the server COOKIE that was returned by the server in its initial response. [RT #39047] -

        -
        • -
      • -

        +

        • +

      • Retrieving the local port range from net.ipv4.ip_local_port_range on Linux is now supported. -

        -
        • -
      • -

        +

        • +

      • A new nsip-wait-recurse directive has been added to RPZ, specifying whether to look up unknown name server IP addresses and wait for a response before applying RPZ-NSIP rules. @@ -2332,131 +1962,105 @@ be applied on subsequent queries. This improves performance when the cache is cold, at the cost of temporary imprecision in applying policy directives. [RT #35009] -

        -
        • -
      • -

        +

        • +

      • Within the response-policy option, it is now possible to configure RPZ rewrite logging on a per-zone basis using the log clause. -

        -
        • -
      • -

        +

        • +

      • 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. -

        -
        • +

      • -

        +

        Added support for the AVC resource record type (Application Visibility and Control).

        -

        +

        Changed rndc reconfig behavior so that newly added zones are loaded asynchronously and the loading does not block the server.

        -
        • -
      • -

        +

        • +

      • minimal-responses now takes two new arguments: no-auth suppresses populating the authority section but not the additional section; no-auth-recursive does the same but only when answering recursive queries. -

        -
        • -
      • -

        +

        • +

      • At server startup time, the queues for processing notify and zone refresh queries are now processed in LIFO rather than FIFO order, to speed up loading of newly added zones. [RT #42825] -

        -
        • -
      • -

        +

        • +

      • When answering queries of type MX or SRV, TLSA records for the target name are now included in the additional section to speed up DANE processing. [RT #42894] -

        -
        • -
      • -

        +

        • +

      • named can now use the TCP Fast Open mechanism on the server side, if supported by the local operating system. [RT #42866] -

        -
        • +

      -
    - -
    +
    +

    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] -

        -
        • +

      -
    -
    - -
    +
    +

    End of Life

    -

    +

    BIND 9.11 (Extended Support Version) will be supported until at least December, 2021.

    -

    +

    See https://kb.isc.org/docs/aa-00896 for details of ISC's software support policy.

    -
    +

    Thank You

    -

    +

    Thank you to everyone who assisted us in making this release possible.

    -
    +
@@ -2475,6 +2079,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.ch10.html b/doc/arm/Bv9ARM.ch10.html index 08b5a421d3..5ce8b5347a 100644 --- a/doc/arm/Bv9ARM.ch10.html +++ b/doc/arm/Bv9ARM.ch10.html @@ -35,7 +35,7 @@

A Brief History of the DNS and BIND

-

+

Although the Domain Name System "officially" began in 1984 with the publication of RFC 920, the core of the new system was described in 1983 in RFCs 882 and @@ -50,8 +50,7 @@ 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 @@ -69,7 +68,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 @@ -84,7 +83,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 (which became Compaq Computer Corporation and eventually merged with Hewlett-Packard). Paul Vixie, then @@ -96,42 +95,42 @@ 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 Internet Systems Consortium and its predecessor, the Internet Software Consortium, with support 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 corporations who purchase professional support services from ISC (https://www.isc.org/contact/) and/or donate to our mission, and by the tireless efforts of numerous individuals.

-
+
@@ -149,6 +148,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.ch11.html b/doc/arm/Bv9ARM.ch11.html index fcd1e1f81e..c739f5d8dc 100644 --- a/doc/arm/Bv9ARM.ch11.html +++ b/doc/arm/Bv9ARM.ch11.html @@ -45,12 +45,10 @@
- -
+

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, @@ -61,13 +59,13 @@ Unicast address scheme. For more information, see RFC 3587, "IPv6 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 @@ -81,14 +79,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 @@ -96,7 +94,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 @@ -104,16 +102,14 @@ string of zeros that can fit, and can be used only once in an address.

-
-
+
+

Bibliography (and Suggested Reading)

- -
+

Requests for Comments (RFCs)

- -

+

Specification documents for the Internet protocol suite, including the DNS, are published as part of the Request for Comments (RFCs) @@ -121,778 +117,356 @@ by the Internet Engineering Task Force (IETF) and the Internet Engineering Steering Group (IESG). RFCs can be obtained online at:

-

+

https://datatracker.ietf.org/doc/

- -
+

-
+

Standards

- - -
-

[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.

-
-
+
+

Proposed Standards

- - -
-

[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.

-
-
+
+

DNS Security Proposed Standards

- -
-

[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.

-
-
+
+

Other Important RFCs About DNS Implementation

- -
-

[RFC1535] - - E. Gavron. - A Security Problem and Proposed Correction With Widely - Deployed DNS Software. - October 1993. -

+
+

[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. -

+
+

[RFC1536] A. Kumar, J. Postel, C. Neuman, P. Danzig, and S. Miller. Common DNS Implementation + Errors and Suggested Fixes. October 1993.

-
-

[RFC1982] - - R. Elz and R. Bush. - Serial Number Arithmetic. - August 1996. -

+
+

[RFC1982] R. Elz and R. Bush. Serial Number Arithmetic. August 1996.

-
-

[RFC4074] - - Y. Morishita and T. Jinmei. - Common Misbehaviour Against DNS - Queries for IPv6 Addresses. - May 2005. -

+
+

[RFC4074] Y. Morishita and T. Jinmei. Common Misbehaviour Against DNS + Queries for IPv6 Addresses. May 2005.

-
-
+
+

Resource Record Types

- -
-

[RFC1183] - - C.F. Everhart, L. A. Mamakos, R. Ullmann, and P. Mockapetris. - New DNS RR Definitions. - October 1990. -

+
+

[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. -

+
+

[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. -

+
+

[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.

-
-
+
+

DNS and the Internet

- -
-

[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.

-
-
+
+

DNS Operations

- -
-

[RFC1033] - - M. Lottor. - Domain administrators operations guide. - November 1987. -

+
+

[RFC1033] M. Lottor. Domain administrators operations guide. November 1987.

-
-

[RFC1537] - - P. Beertema. - Common DNS Data File - Configuration Errors. - October 1993. -

+
+

[RFC1537] P. Beertema. Common DNS Data File + Configuration Errors. October 1993.

-
-

[RFC1912] - - D. Barr. - Common DNS Operational and - Configuration Errors. - February 1996. -

+
+

[RFC1912] D. Barr. Common DNS Operational and + Configuration Errors. February 1996.

-
-

[RFC2010] - - B. Manning and P. Vixie. - Operational Criteria for Root Name Servers. - October 1996. -

+
+

[RFC2010] B. Manning and P. Vixie. Operational Criteria for Root Name Servers. October 1996.

-
-

[RFC2219] - - M. Hamilton and R. Wright. - Use of DNS Aliases for - Network Services. - October 1997. -

+
+

[RFC2219] M. Hamilton and R. Wright. Use of DNS Aliases for + Network Services. October 1997.

-
-

[RFC8906] - - M. Andrews and R. Bellis. - +

+

[RFC8906] M. Andrews and R. Bellis. A Common Operational Problem in DNS Servers: Failure to Communicate - . - September 2020. -

+ . September 2020.

-
-
+
+

Internationalized Domain Names

- -
-

[RFC2825] - - IAB and R. Daigle. - A Tangled Web: Issues of I18N, Domain Names, - and the Other Internet protocols. - May 2000. -

+
+

[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. -

+
+

[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. -

+
+

[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.

-
-
+
+

Other DNS-related RFCs

- -
+

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. -

-
-

[RFC1713] - - A. Romao. - Tools for DNS Debugging. - November 1994. -

+
+

[RFC1464] R. Rosenbaum. Using the Domain Name System To Store Arbitrary String + Attributes. May 1993.

-
-

[RFC1794] - - T. Brisco. - DNS Support for Load - Balancing. - April 1995. -

+
+

[RFC1713] A. Romao. Tools for DNS Debugging. November 1994.

-
-

[RFC2240] - - O. Vaughan. - A Legal Basis for Domain Name Allocation. - November 1997. -

+
+

[RFC1794] T. Brisco. DNS Support for Load + Balancing. April 1995.

-
-

[RFC2345] - - J. Klensin, T. Wolf, and G. Oglesby. - Domain Names and Company Name Retrieval. - May 1998. -

+
+

[RFC2240] O. Vaughan. A Legal Basis for Domain Name Allocation. November 1997.

-
-

[RFC2352] - - O. Vaughan. - A Convention For Using Legal Names as Domain Names. - May 1998. -

+
+

[RFC2345] J. Klensin, T. Wolf, and G. Oglesby. Domain Names and Company Name Retrieval. May 1998.

-
-

[RFC3071] - - J. Klensin. - Reflections on the DNS, RFC 1591, and Categories of Domains. - February 2001. -

+
+

[RFC2352] O. Vaughan. A Convention For Using Legal Names as Domain Names. May 1998.

-
-

[RFC3258] - - T. Hardie. - Distributing Authoritative Name Servers via - Shared Unicast Addresses. - April 2002. -

+
+

[RFC3071] J. Klensin. Reflections on the DNS, RFC 1591, and Categories of Domains. February 2001.

-
-

[RFC3901] - - A. Durand and J. Ihren. - DNS IPv6 Transport Operational Guidelines. - September 2004. -

+
+

[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.

+
+
+

Obsolete and Unimplemented Experimental RFC

- -
-

[RFC1712] - - C. Farrell, M. Schulze, S. Pleitner, and D. Baldoni. - DNS Encoding of Geographical - Location. - November 1994. -

+
+

[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. -

+
+

[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. -

+
+

[RFC2874] M. Crawford and C. Huitema. DNS Extensions to Support IPv6 Address Aggregation + and Renumbering. July 2000.

-
-
+
+

Obsoleted DNS Security RFCs

- -
+

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. -

-
-

[RFC2137] - - D. Eastlake, 3rd. - Secure Domain Name System Dynamic Update. - April 1997. -

+
+

[RFC2065] D. Eastlake, 3rd and C. Kaufman. Domain Name System Security Extensions. January 1997.

-
-

[RFC2535] - - D. Eastlake, 3rd. - Domain Name System Security Extensions. - March 1999. -

+
+

[RFC2137] D. Eastlake, 3rd. Secure Domain Name System Dynamic Update. April 1997.

-
-

[RFC3008] - - B. Wellington. - Domain Name System Security (DNSSEC) - Signing Authority. - November 2000. -

+
+

[RFC2535] D. Eastlake, 3rd. Domain Name System Security Extensions. March 1999.

-
-

[RFC3090] - - E. Lewis. - DNS Security Extension Clarification on Zone Status. - March 2001. -

+
+

[RFC3008] B. Wellington. Domain Name System Security (DNSSEC) + Signing Authority. November 2000.

-
-

[RFC3445] - - D. Massey and S. Rose. - Limiting the Scope of the KEY Resource Record (RR). - December 2002. -

+
+

[RFC3090] E. Lewis. DNS Security Extension Clarification on Zone Status. March 2001.

-
-

[RFC3655] - - B. Wellington and O. Gudmundsson. - Redefinition of DNS Authenticated Data (AD) bit. - November 2003. -

+
+

[RFC3445] D. Massey and S. Rose. Limiting the Scope of the KEY Resource Record (RR). December 2002.

-
-

[RFC3658] - - O. Gudmundsson. - Delegation Signer (DS) Resource Record (RR). - December 2003. -

+
+

[RFC3655] B. Wellington and O. Gudmundsson. Redefinition of DNS Authenticated Data (AD) bit. November 2003.

-
-

[RFC3755] - - S. Weiler. - Legacy Resolver Compatibility for Delegation Signer (DS). - May 2004. -

+
+

[RFC3658] O. Gudmundsson. Delegation Signer (DS) Resource Record (RR). December 2003.

-
-

[RFC3757] - - O. Kolkman, J. Schlyter, and E. Lewis. - Domain Name System KEY (DNSKEY) Resource Record - (RR) Secure Entry Point (SEP) Flag. - April 2004. -

+
+

[RFC3755] S. Weiler. Legacy Resolver Compatibility for Delegation Signer (DS). May 2004.

-
-

[RFC3845] - - J. Schlyter. - DNS Security (DNSSEC) NextSECure (NSEC) RDATA Format. - August 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.

+
+
+
+
+

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 @@ -902,26 +476,21 @@ 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

- -

-
+

+

-
-

- 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.

+
+
+
+
-
-
-
-
@@ -939,6 +508,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.ch12.html b/doc/arm/Bv9ARM.ch12.html index 6e39da7581..94f6970b91 100644 --- a/doc/arm/Bv9ARM.ch12.html +++ b/doc/arm/Bv9ARM.ch12.html @@ -46,11 +46,10 @@
-
+

BIND 9 DNS Library Support

- -

+

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). Certain library @@ -59,32 +58,27 @@ the calling program initializes the libraries by calling isc_lib_register().

-

+

In addition to DNS-related APIs that are used within BIND 9, the libraries provide the following features:

-
    -
  • -

    +

      +

    • The "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 "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, the standard address-name mapping functions, getaddrinfo() and getnameinfo(), are provided. They use the @@ -93,38 +87,33 @@ 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. -

      -
      • +

    -
    +

    Installation

    - - 
    +
     $ make install
     
    
-    
    
+
    
       Normal installation of BIND also installs library object
       and header files.  Root privilege is normally required.
     
    
-    
    
+
    
       To see how to build a custom application after the installation, see
       lib/samples/Makefile-postinstall.in.
     
    
-
    -
    +
    +

    Known Defects/Restrictions

    - -
      +
      • -

        +

        The "fixed" RRset order is not (currently) supported in the export library. To use "fixed" RRset order for, e.g., named while still building the export library @@ -139,30 +128,25 @@ $ make

        -
        • -
      • -

        +

        • +

      • RFC 5011 is not supported in the validating stub resolver of the export library. In fact, it is not clear whether it should be: trust anchors would be a system-wide configuration which would be managed by an administrator, while the stub resolver is used by ordinary applications 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. -

        -
        • +

      -
    -
    +
    +

    The dns.conf 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. @@ -175,42 +159,38 @@ $ make statement in named.conf. (See the section called “trusted-keys Statement Grammar” for details.)

    -
    -
    +
    +

    Sample Applications

    - -

    +

    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

    - -

    +

    This 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
    -
    -

    +

    specifies the RR type of the query. The default is the A RR. -

    -
    +

    [-a algorithm] [-e] -k keyname -K keystring
    -

    +

    specifies a command-line DNS key to validate the answer. For example, to specify the following DNSKEY of example.com:

    @@ -228,43 +208,36 @@ $ make as "secure entry point"). When -a is omitted rsasha1 is used by default.

    -
    +
    -s domain:alt_server_address
    -
    -

    +

    specifies a separate recursive server address for the specific "domain". Example: -s example.com:2001:db8::1234 -

    -
    +

    server_address
    -
    -

    +

    is an IP(v4/v6) address of the recursive server to which queries are sent. -

    -
    +

    hostname
    -
    -

    +

    is the domain name for the query -

    -
    +

    -
    -
    +
    +

    sample-async: a simple stub resolver, working asynchronously

    - -

    +

    This is 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
    is an IPv4 address of the recursive server to which queries are sent. @@ -284,14 +257,13 @@ $ make       mx.example.net
          ns.xxx.example
          

    - +
    -
    -
    +
    +

    sample-request: a simple DNS transaction client

    - -

    +

    sends a query to a specified server, and prints the response with minimal processing. It does not act as a "stub resolver": it stops the processing once it gets any response from the server, whether @@ -299,39 +271,32 @@ $ make further queries to get the 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
    -
    -

    +

    specifies the RR type of the queries. The default is the A RR. -

    -
    +

    server_address
    -
    -

    +

    is an IP(v4/v6) address of the recursive server to which the query is sent. -

    -
    +

    hostname
    -
    -

    +

    is the domain name for the query -

    -
    +

    -
    -
    +
    +

    sample-gai: getaddrinfo() and getnameinfo() test code

    - -

    +

    is a test program to check getaddrinfo() and getnameinfo() behavior. It takes a host name as an argument, calls getaddrinfo() with the given host @@ -343,153 +308,130 @@ $ make fails with an EAI_INSECUREDATA error when DNSSEC validation fails.

    -

    +

    Usage: sample-gai hostname

    -
    -
    +
    +

    sample-update: a simple dynamic update client program

    - -

    +

    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
    -
    -

    +

    is an IP address of the authoritative server that has authority for the zone containing the update name. This should normally be the primary authoritative server that accepts dynamic updates. It can also be a secondary server that is configured to forward update requests to the primary server. -

    -
    +

    -k keyfile
    -
    -

    +

    is a TSIG key file to secure the update transaction. The keyfile format is the same as that for the nsupdate utility. -

    -
    +

    -p prerequisite
    -
    -

    +

    is a prerequisite for the update; only one prerequisite can be specified. The prerequisite format is the same as that accepted by the nsupdate utility. -

    -
    +

    -r recursive_server
    -
    -

    +

    is an IP address of a recursive server that this utility uses. A recursive server may be necessary to identify the authoritative server address to which the update request is sent. -

    -
    +

    -z zonename
    -
    -

    +

    is the domain name of the zone that it contains. -

    -
    +

    (add|delete)
    -
    -

    +

    specifies the type of update operation. Either "add" or "delete" must be specified. -

    -
    +

    "update data"
    -
    -

    +

    specifies the data to be updated. A typical example of the data looks like "name TTL RRtype RDATA". -

    -
    +

    -
    +

    Note

    -

    +

    In practice, either -a or -r must be specified. Others can be optional; the underlying library routine tries to identify the 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

    - -

    +

    checks a set of domains to ensure 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
    -
    -

    +

    runs in "debug" mode. With this option, nsprobe dumps every RR it receives. -

    -
    +

    -v
    -
    -

    +

    increases verbosity of other normal log messages. This can be specified multiple times. -

    -
    +

    -c cache_address
    -
    -

    +

    specifies an IP address of a recursive (caching) name server. nsprobe uses this server to get the NS RRset of each domain and the A and/or AAAA RRsets for the name servers. The default value is 127.0.0.1. -

    -
    +

    input_file
    -
    -

    +

    is a file name containing a list of domain (zone) names to be probed. when omitted the standard input is used. Each line of the input file specifies a single domain name, such as @@ -499,23 +441,21 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mm for the given domain name, and sends A and AAAA queries to these servers for some widely used names under the zone; specifically, adding "www" and "ftp" to the zone name. -

    -
    +

    -
    -
    -
    +
    +
    +

    Library References

    - -

    +

    As of this writing, there is no formal "manual" for the libraries, except this document, header files (some of which provide pretty detailed explanations), and sample application programs.

    -
    -
    +
    +
    @@ -533,6 +473,6 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mm
    -

    BIND 9.11.25 (Extended Support Version)

    +

    BIND 9.11.26 (Extended Support Version)

    diff --git a/doc/arm/Bv9ARM.ch13.html b/doc/arm/Bv9ARM.ch13.html index c10035a532..22f2317630 100644 --- a/doc/arm/Bv9ARM.ch13.html +++ b/doc/arm/Bv9ARM.ch13.html @@ -157,45 +157,7 @@
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    +
@@ -214,6 +176,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.html b/doc/arm/Bv9ARM.html index 3918bc48c2..1121fcbc72 100644 --- a/doc/arm/Bv9ARM.html +++ b/doc/arm/Bv9ARM.html @@ -32,7 +32,7 @@

BIND 9 Administrator Reference Manual

-

BIND Version 9.11.25

+

BIND Version 9.11.26

Copyright © 2000-2020 Internet Systems Consortium, Inc. ("ISC")

@@ -241,11 +241,12 @@
A. Release Notes
-
Release Notes for BIND Version 9.11.25
+
Release Notes for BIND Version 9.11.26
Introduction
Download
License Change
+
Notes for BIND 9.11.26
Notes for BIND 9.11.25
Notes for BIND 9.11.24
Notes for BIND 9.11.23
@@ -419,34 +420,7 @@
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
@@ -463,6 +437,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/Bv9ARM.pdf b/doc/arm/Bv9ARM.pdf index 74e861089f..1c49bb7374 100644 Binary files a/doc/arm/Bv9ARM.pdf and b/doc/arm/Bv9ARM.pdf differ diff --git a/doc/arm/man.arpaname.html b/doc/arm/man.arpaname.html index e95beb6bbd..95f96f4ad9 100644 --- a/doc/arm/man.arpaname.html +++ b/doc/arm/man.arpaname.html @@ -32,45 +32,27 @@
- - - - -
+

Name

-

- arpaname - — translate IP addresses to the corresponding ARPA names -

+

arpaname — translate IP addresses to the corresponding ARPA names

- - - -
+

Synopsis

-

- arpaname - {ipaddress ...} -

-
- -
+

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.

-
- +
@@ -90,6 +72,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.ddns-confgen.html b/doc/arm/man.ddns-confgen.html index 3ec7ed9cca..1d1c3f5ab1 100644 --- a/doc/arm/man.ddns-confgen.html +++ b/doc/arm/man.ddns-confgen.html @@ -32,63 +32,31 @@
- - - - - -
+

Name

-

- ddns-confgen - — ddns key generation tool -

+

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 - ] -

-
- -
+

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 @@ -98,8 +66,7 @@ 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 @@ -109,32 +76,24 @@ 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 @@ -144,19 +103,15 @@ 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 @@ -166,11 +121,9 @@ 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 @@ -181,11 +134,9 @@ 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 @@ -195,27 +146,17 @@ 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.

-
- +
@@ -235,6 +176,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.delv.html b/doc/arm/man.delv.html index d148ce0894..1a2048342e 100644 --- a/doc/arm/man.delv.html +++ b/doc/arm/man.delv.html @@ -32,72 +32,25 @@
- - - - - -
+

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 is a tool for sending DNS queries and validating the results, using 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 @@ -107,7 +60,7 @@ behavior of a name server configured for DNSSEC validating and forwarding.

-

+

By default, responses are validated using built-in DNSSEC trust anchor for the root zone ("."). Records returned by delv are either fully validated or @@ -118,7 +71,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 @@ -126,18 +79,15 @@ 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
@@ -148,7 +98,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 @@ -158,7 +108,7 @@ initial lookup is not validated by DNSSEC).

-

+

If no server argument is provided, delv consults /etc/resolv.conf; if an @@ -171,16 +121,13 @@ 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 @@ -188,27 +135,23 @@ 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 one or more trust anchors for the root zone (".").

-

+

Keys that do not match the root zone name are ignored. An alternate key name can be specified using the +root=NAME options. DNSSEC Lookaside @@ -216,7 +159,7 @@ +dlv=NAME to specify the name of a zone containing DLV records.

-

+

Note: When reading the trust anchor file, delv treats managed-keys statements and trusted-keys statements @@ -230,28 +173,23 @@ /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). @@ -260,17 +198,13 @@ 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 @@ -278,37 +212,30 @@ 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 @@ -316,21 +243,18 @@ 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. @@ -340,33 +264,24 @@ 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 @@ -378,8 +293,7 @@

+[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 @@ -388,25 +302,20 @@ 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 @@ -414,69 +323,62 @@ 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 "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 "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 @@ -484,18 +386,14 @@ 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 @@ -504,30 +402,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]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) @@ -537,11 +429,9 @@ 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 @@ -549,63 +439,47 @@ 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 -a option must also be used to specify a file containing the DLV key. -

-
+

+[no]tcp
-
-

+

Controls whether to use TCP when sending queries. The default is to use UDP unless a truncated response has been received. -

-
+

+[no]unknownformat
-
-

+

Print all RDATA in unknown RR type presentation format (RFC 3597). The default is to print RDATA for known types in the type's presentation format. -

-
+

-
- -
+
+

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.

-
- +
@@ -625,6 +499,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dig.html b/doc/arm/man.dig.html index 986458daa4..033f38e49f 100644 --- a/doc/arm/man.dig.html +++ b/doc/arm/man.dig.html @@ -32,63 +32,19 @@
- - - - - -
+

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 is a flexible tool +

dig 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 were queried. Most DNS administrators use dig to @@ -96,8 +52,7 @@ 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 @@ -108,43 +63,35 @@ 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 -r option disables this feature, for scripts that need predictable behaviour.

- -

+

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
@@ -155,7 +102,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 @@ -163,7 +110,7 @@ dig resolves that name before querying that name server.

-

+

If no server argument is provided, dig consults /etc/resolv.conf; if an @@ -176,16 +123,13 @@ 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 @@ -193,116 +137,87 @@ 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 RFC 1886 IP6.INT domain, which is no longer in use. Obsolete bit string label queries (RFC 2874) 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 default 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. -

-
+

-r
-
-

+

Do not read options from ${HOME}/.digrc. This is useful for scripts that need predictable behaviour. -

-
+

-t type
-

+

The resource record type to query. It can be any valid query type. If it is a resource record type supported in BIND 9, it can be given by the type mnemonic (such as "NS" or "AAAA"). @@ -316,28 +231,23 @@ record was N.

-

+

All resource record types can be expressed as "TYPEnn", where "nn" is the number of the type. If the resource record type is not supported in BIND 9, the result will be displayed as described in RFC 3597.

-
+
-u
-
-

+

Print query times in microseconds instead of milliseconds. -

-
+

-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 @@ -352,11 +262,10 @@ 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. @@ -368,34 +277,28 @@ 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 @@ -411,27 +314,20 @@

+[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 @@ -441,46 +337,34 @@ 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]badcookie
-
-

+

Retry lookup with the new server cookie if a BADCOOKIE response is received. -

-
+

+[no]besteffort
-
-

+

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

-
+

+bufsize=B
-
-

+

This option sets the UDP message buffer size advertised using EDNS0 to B bytes. The maximum and minimum sizes of this buffer are 65535 @@ -489,43 +373,36 @@ to send a EDNS messages with a advertised size of 0 bytes). +bufsize restores the default buffer size. -

-
+

+[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 option always has global effect; it cannot be set globally and then overridden on a per-lookup basis. The default is to print this comment. -

-
+

+[no]comments
-

+

Toggles the display of some comment lines in the output, containing information about the packet header and OPT pseudosection, and the names of the response section. The default is to print these comments.

-

+

Other types of comments in the output are not affected by this option, but can be controlled using other command line switches. These include +[no]cmd, @@ -533,24 +410,23 @@ +[no]stats, and +[no]rrcomments.

-
+
+[no]cookie[=####]
-

+

Send a COOKIE EDNS option, with optional value. Replaying a COOKIE from a previous response will allow the server to identify a previous client. The default is +cookie.

-

+

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

-
+
+[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 @@ -559,71 +435,55 @@ 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. -

-
+

+dscp=value
-
-

+

Set the DSCP code point to be used when sending the query. Valid DSCP code points are in the range [0..63]. By default no code point is explicitly set. -

-
+

+[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. code can be @@ -631,104 +491,86 @@ NSID or ECS), or an arbitrary numeric value. +noednsopt clears the EDNS options 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]header-only
-
-

+

Send a query with a DNS header without a question section. The default is to add a question section. The query type and query name are ignored when this is set. -

-
+

+[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]idnin
-

+

Process [do not process] IDN domain names on input. This requires IDN SUPPORT to have been enabled at compile time.

-

+

The default is to process IDN input when standard output is a tty. The IDN processing on input is disabled when dig output is redirected to files, pipes, and other non-tty file descriptors.

-
+
+[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 process puny code on output when standard output is a tty. The puny code processing on output is disabled when dig output is redirected to files, pipes, and other non-tty file descriptors.

-
+
+[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]mapped
-
-

+

Allow mapped IPv4 over IPv6 addresses to be used. The default is +mapped. -

-
+

+[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 @@ -740,64 +582,48 @@ 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
-
-

+

Toggles the display of the query message as it is sent. By default, the query is not printed. -

-
+

+[no]question
-
-

+

Toggles the display of 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 @@ -806,69 +632,57 @@ when using +trace except for an initial recursive query to get the list of root servers. -

-
+

+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. This option always has global effect; it cannot be set globally and then overridden on a per-lookup basis. -

-
+

+[no]showsearch
-
-

+

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

-
+

+[no]sigchase
-
-

+

Chase DNSSEC signature chains. Requires dig be compiled with -DDIG_SIGCHASE. This feature is deprecated. Use delv instead. -

-
+

+split=W
-
-

+

Split long hex- or base64-formatted fields in resource records into chunks of W characters (where W is rounded @@ -877,23 +691,20 @@ +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
-
-

+

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 as a comment after each lookup. -

-
+

+[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 @@ -902,20 +713,17 @@ 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 a type any or ixfr=N query is requested, in which case the default is TCP. AXFR queries always use TCP. -

-
+

+timeout=T
-
-

+

Sets the timeout for a query to T seconds. The default @@ -923,19 +731,16 @@ 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. This feature is deprecated. Use delv instead. -

-
+

+[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, @@ -943,91 +748,80 @@ 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. This feature is deprecated. Use delv instead.

-
+
+[no]ttlid
-
-

+

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

-
+

+[no]ttlunits
-
-

+

Display [do not display] the TTL in friendly human-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks. Implies +ttlid. -

-
+

+[no]unknownformat
-
-

+

Print all RDATA in unknown RR type presentation format (RFC 3597). The default is to print RDATA for known types in the type's presentation format. -

-
+

+[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". -

-
+

+[no]zflag
-
-

+

Set [do not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. -

-
+

-
- -
+
+

MULTIPLE QUERIES

- - -

+

The BIND 9 implementation of dig supports specifying multiple queries on the command line (in addition to @@ -1035,8 +829,7 @@ 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 @@ -1044,8 +837,7 @@ 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 @@ -1072,13 +864,10 @@ 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 @@ -1088,44 +877,29 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr parameters +noidnin and +noidnout.

-
- -
+
+

FILES

- -

/etc/resolv.conf +

/etc/resolv.conf

-

${HOME}/.digrc +

${HOME}/.digrc

-
- -
+
+

SEE ALSO

- -

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

delv(1), + host(1), + named(8), + dnssec-keygen(8), RFC 1035.

-
- -
+
+

BUGS

- -

+

There are probably too many query options.

-
- +
@@ -1145,6 +919,6 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-checkds.html b/doc/arm/man.dnssec-checkds.html index 2c99e16d52..13a0861af5 100644 --- a/doc/arm/man.dnssec-checkds.html +++ b/doc/arm/man.dnssec-checkds.html @@ -32,103 +32,56 @@
- - - - - -
+

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. -

-
+

-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),

-
- +
@@ -148,6 +101,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-coverage.html b/doc/arm/man.dnssec-coverage.html index 800dc19d95..d4cc23cad2 100644 --- a/doc/arm/man.dnssec-coverage.html +++ b/doc/arm/man.dnssec-coverage.html @@ -32,47 +32,22 @@
- - - - - -
+

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., @@ -85,54 +60,47 @@ 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 @@ -141,26 +109,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 @@ -169,12 +137,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 @@ -183,15 +151,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 @@ -201,55 +169,38 @@ 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)

-
- +
@@ -270,6 +221,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-dsfromkey.html b/doc/arm/man.dnssec-dsfromkey.html index 834b39fb6a..c5f24e63ba 100644 --- a/doc/arm/man.dnssec-dsfromkey.html +++ b/doc/arm/man.dnssec-dsfromkey.html @@ -32,297 +32,185 @@
- - - - - -
+

Name

-

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

+

dnssec-dsfromkey — DNSSEC DS RR generation tool

- - - -
+

Synopsis

-

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

-

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

-

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

-

- dnssec-dsfromkey - [ - -h - | -V - ] -

-
- -
+

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

+

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

+

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

+

dnssec-dsfromkey [ -h | -V ]

+
+

DESCRIPTION

- -

+

The dnssec-dsfromkey command outputs DS (Delegation Signer) resource records (RRs) and other similarly-constructed RRs: with the -l option it outputs DLV (DNSSEC Lookaside Validation) RRs; or with the -C it outputs CDS (Child DS) RRs.

- -

+

The input keys can be specified in a number of ways:

- -

+

By default, dnssec-dsfromkey reads a key file named like Knnnn.+aaa+iiiii.key, as generated by dnssec-keygen.

- -

+

With the -f file option, dnssec-dsfromkey reads keys from a zone file or partial zone file (which can contain just the DNSKEY records).

- -

+

With the -s option, dnssec-dsfromkey reads a keyset- file, as generated by dnssec-keygen -C.

- -
- -
+
+

OPTIONS

- -
+
-1
-
-

+

An abbreviation for -a SHA1 -

-
+

-2
-
-

+

An abbreviation for -a SHA-256 -

-
+

-a algorithm
-

+

Specify a digest algorithm to use when converting DNSKEY records to DS records. This option can be repeated, so that multiple DS records are created for each DNSKEY record.

-

+

The algorithm must be one of SHA-1, SHA-256, or SHA-384. These values are case insensitive, and the hyphen may be omitted. If no algorithm is specified, the default is to use both SHA-1 and SHA-256.

-
+
-A
-
-

+

Include ZSKs 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 -f zone file mode. -

-
+

-c class
-
-

+

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

-
+

-C
-
-

+

Generate CDS records rather than DS records. This is mutually exclusive with the -l option for generating DLV records. -

-
+

-f file
-

+

Zone file mode: dnssec-dsfromkey's final dnsname argument is the DNS domain name of a zone whose master file can be read from file. If the zone name is the same as file, then it may be omitted.

-

+

If file is "-", 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

-
+
-h
-
-

+

Prints usage information. -

-
+

-K directory
-
-

+

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

-
+

-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. This is mutually exclusive with the -C option for generating CDS records. -

-
+

-s
-
-

+

Keyset mode: dnssec-dsfromkey's final dnsname argument is the DNS domain name used to locate a keyset- file. -

-
+

-T TTL
-
-

+

Specifies the TTL of the DS records. By default the TTL is omitted. -

-
+

-v level
-
-

+

Sets the debugging level. -

-
+

-V
-
-

+

Prints version information. -

-
+

-
- -
+
+

EXAMPLE

- -

+

To build the SHA-256 DS RR from the Kexample.com.+003+26160 keyfile name, you can issue the following command:

-

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 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0C5EA0B94 +

example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0C5EA0B94

- -
- -
+
+

FILES

- -

+

The keyfile can be designated 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 (DS RRs), RFC 4431 (DLV RRs), @@ -330,8 +218,7 @@ RFC 6605 (SHA-384 for DS RRs), RFC 7344 (CDS and CDNSKEY RRs).

-
- +
@@ -352,6 +239,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-importkey.html b/doc/arm/man.dnssec-importkey.html index 76e60ef38a..0c0ef132eb 100644 --- a/doc/arm/man.dnssec-importkey.html +++ b/doc/arm/man.dnssec-importkey.html @@ -32,56 +32,18 @@
- - - - - -
+

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] - [-P sync date/offset] - [-D date/offset] - [-D sync date/offset] - [-h] - [-v level] - [-V] - {keyfile} -

-

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

-
- -
+

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

+

dnssec-importkey {-f filename} [-K directory] [-L ttl] [-P date/offset] [-P sync date/offset] [-D date/offset] [-D sync 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 @@ -89,7 +51,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 @@ -98,68 +60,53 @@ 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 @@ -170,66 +117,48 @@ 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. -

-
+

-P sync date/offset
-
-

+

Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone. -

-
+

-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.) -

-
+

-D sync date/offset
-
-

+

Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. -

-
+

-
- -
+
+

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.

-
- +
@@ -250,6 +179,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-keyfromlabel.html b/doc/arm/man.dnssec-keyfromlabel.html index 0b52184490..a5bcec89fc 100644 --- a/doc/arm/man.dnssec-keyfromlabel.html +++ b/doc/arm/man.dnssec-keyfromlabel.html @@ -32,58 +32,17 @@
- - - - - -
+

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] - [-D sync date/offset] - [-E engine] - [-f flag] - [-G] - [-I date/offset] - [-i interval] - [-k] - [-K directory] - [-L ttl] - [-n nametype] - [-P date/offset] - [-P sync 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] [-D sync date/offset] [-E engine] [-f flag] [-G] [-I date/offset] [-i interval] [-k] [-K directory] [-L ttl] [-n nametype] [-P date/offset] [-P sync 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 @@ -91,57 +50,52 @@ 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, ECDSAP384SHA384, ED25519 or ED448. 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 @@ -149,18 +103,18 @@ (--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.

-

+

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;...]" @@ -169,7 +123,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 @@ -178,21 +132,18 @@ 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 @@ -200,71 +151,53 @@ (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 @@ -272,47 +205,35 @@ 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 @@ -323,67 +244,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. If not set, and if the -G option has not been used, the default is "now". -

-
+

-P sync date/offset
-
-

+

Sets the date on which the CDS and CDNSKEY records which match this key are to be published to the zone. -

-
+

-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.) -

-
+

-D sync date/offset
-
-

+

Sets the date on which the CDS and CDNSKEY records which match this key are to be deleted. -

-
+

-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 @@ -392,84 +298,69 @@ 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).

-
- +
@@ -490,6 +381,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-keygen.html b/doc/arm/man.dnssec-keygen.html index a4ee45b54c..b89f8c33b0 100644 --- a/doc/arm/man.dnssec-keygen.html +++ b/doc/arm/man.dnssec-keygen.html @@ -32,93 +32,42 @@
- - - - - -
+

Name

-

- dnssec-keygen - — DNSSEC key generation tool -

+

dnssec-keygen — DNSSEC key generation tool

- - - -
+

Synopsis

-

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

-
- -
+

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

- - -
+
-3
-
-

+

Use an NSEC3-capable algorithm to generate a DNSSEC key. If this option is used with an algorithm that has both NSEC and NSEC3 versions, then the NSEC3 version will be used; for example, dnssec-keygen -3a RSASHA1 specifies the NSEC3RSASHA1 algorithm. -

-
+

-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, @@ -128,26 +77,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 @@ -156,7 +105,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 (ZSKs) and 2048 bits for key signing keys (KSKs, @@ -165,10 +114,9 @@ then there is no default key size, and the -b must be used.

-
+
-C
-
-

+

Compatibility mode: generates an old-style key, without any timing metadata. By default, dnssec-keygen will include the key's creation date in the metadata stored with @@ -176,21 +124,18 @@ (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 @@ -198,52 +143,39 @@ (--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 @@ -252,31 +184,25 @@ 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. -

-
+

-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. Defaults to ZONE for DNSKEY generation. -

-
+

-p protocol
-
-

+

Sets the protocol value for the generated key, for use with -T 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 @@ -288,11 +214,9 @@ 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 @@ -302,11 +226,9 @@ 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 @@ -314,19 +236,16 @@ 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 @@ -338,37 +257,28 @@ Using any TSIG algorithm (HMAC-* or DH) forces this option to KEY.

-
+
-t type
-
-

+

Indicates the use of the key, for use with -T 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
-
-

+

Prints version information. -

-
+

-v level
-
-

+

Sets the debugging level. -

-
+

-
- -
+
+

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 @@ -379,69 +289,54 @@ 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". -

-
+

-P sync date/offset
-
-

+

Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone. -

-
+

-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.) -

-
+

-D sync date/offset
-
-

+

Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. -

-
+

-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 @@ -450,51 +345,42 @@ 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 @@ -502,67 +388,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.

-

+

To generate a matching key-signing key, issue the command:

-

+

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

-
- -
+
+

SEE ALSO

- -

- dnssec-signzone(8) - , +

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

-
- +
@@ -583,6 +462,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-keymgr.html b/doc/arm/man.dnssec-keymgr.html index cb1306c8a7..8979eb67f6 100644 --- a/doc/arm/man.dnssec-keymgr.html +++ b/doc/arm/man.dnssec-keymgr.html @@ -32,49 +32,24 @@
- - - - - -
+

Name

-

- dnssec-keymgr - — Ensures correct DNSKEY coverage for a zone based on a defined policy -

+

dnssec-keymgr — Ensures correct DNSKEY coverage for a zone based on a defined policy

- - - -
+

Synopsis

-

- dnssec-keymgr - [-K directory] - [-c file] - [-f] - [-k] - [-q] - [-v] - [-z] - [-g path] - [-r path] - [-s path] - [zone...] -

-
- -
+

dnssec-keymgr [-K directory] [-c file] [-f] [-k] [-q] [-v] [-z] [-g path] [-r path] [-s path] [zone...]

+
+

DESCRIPTION

-

+

dnssec-keymgr is a high level Python wrapper to facilitate the key rollover process for zones handled by BIND. It uses the BIND commands for manipulating DNSSEC key metadata: dnssec-keygen and dnssec-settime.

-

+

DNSSEC policy can be read from a configuration file (default /etc/dnssec-policy.conf), from which the key parameters, publication and rollover schedule, and desired @@ -83,14 +58,14 @@ per-zone basis, or to set a "default" policy used for all zones.

-

+

When dnssec-keymgr runs, it examines the DNSSEC keys for one or more zones, comparing their timing metadata against the policies for those zones. If key settings do not conform to the DNSSEC policy (for example, because the policy has been changed), they are automatically corrected.

-

+

A zone policy can specify a duration for which we want to ensure the key correctness (coverage). It can also specify a rollover period (roll-period). @@ -98,47 +73,43 @@ coverage period ends, then a successor key will automatically be created and added to the end of the key series.

-

+

If zones are specified on the command line, dnssec-keymgr will examine only those zones. If a specified zone does not already have keys in place, then keys will be generated for it according to policy.

-

+

If zones are not specified on the command line, then dnssec-keymgr will search the key directory (either the current working directory or the directory set by the -K option), and check the keys for all the zones represented in the directory.

-

+

Key times that are in the past will not be updated unless the -f is used (see below). Key inactivation and deletion times that are less than five minutes in the future will be delayed by five minutes.

-

+

It is expected that this tool will be run automatically and unattended (for example, by cron).

-
- -
+
+

OPTIONS

-
+
-c file
-
-

+

If -c is specified, then the DNSSEC policy is read from file. (If not specified, then the policy is read from /etc/dnssec-policy.conf; if that file doesn't exist, a built-in global default policy is used.) -

-
+

-f
-
-

+

Force: allow updating of key events even if they are already in the past. This is not recommended for use with zones in which keys have already been published. However, @@ -147,86 +118,65 @@ keys have not been published in a zone as yet, then this option can be used to clean them up and turn them into a proper series of keys with appropriate rollover intervals. -

-
+

-g keygen-path
-
-

+

Specifies a path to a dnssec-keygen binary. Used for testing. See also the -s option. -

-
+

-h
-
-

+

Print the dnssec-keymgr help summary and exit. -

-
+

-K directory
-
-

+

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

-
+

-k
-
-

+

Only apply policies to KSK keys. See also the -z option. -

-
+

-q
-
-

+

Quiet: suppress printing of dnssec-keygen and dnssec-settime. -

-
+

-r randomdev
-
-

+

Specifies a path to a file containing random data. This is passed to the dnssec-keygen binary using its -r option. -

-
+

-s settime-path
-
-

+

Specifies a path to a dnssec-settime binary. Used for testing. See also the -g option. -

-
+

-v
-
-

+

Print the dnssec-keymgr version and exit. -

-
+

-z
-
-

+

Only apply policies to ZSK keys. See also the -k option. -

-
+

-
- -
+
+

POLICY CONFIGURATION

-

+

The dnssec-policy.conf file can specify three kinds of policies:

-
    -
  • -

    +

      +

    • Policy classes (policy name { ... };) can be inherited by zone policies or other policy classes; these @@ -235,20 +185,16 @@ 1024-bit key sizes, but a class extra might specify 2048 bits instead; extra would be used for zones that had unusually high security needs. -

      -
      • -
    • -

      +

      • +

    • Algorithm policies: (algorithm-policy algorithm { ... }; ) override default per-algorithm settings. For example, by default, RSASHA256 keys use 2048-bit key sizes for both KSK and ZSK. This can be modified using algorithm-policy, and the new key sizes would then be used for any key of type RSASHA256. -

      -
      • -
    • -

      +

      • +

    • Zone policies: (zone name { ... }; ) set policy for a single zone by name. A zone policy can inherit @@ -256,25 +202,21 @@ Zone names beginning with digits (i.e., 0-9) must be quoted. If a zone does not have its own policy then the "default" policy applies. -

      -
      • +

    -

    +

    Options that can be specified in policies:

    -
    +
    algorithm name;
    -
    -

    +

    The key algorithm. If no policy is defined, the default is RSASHA256. -

    -
    +

    coverage duration;
    -
    -

    +

    The length of time to ensure that keys will be correct; no action will be taken to create new keys to be activated after this time. This can be represented as a number of seconds, or as a duration @@ -282,120 +224,90 @@ A default value for this option can be set in algorithm policies as well as in policy classes or zone policies. If no policy is configured, the default is six months. -

    -
    +

    directory path;
    -
    -

    +

    Specifies the directory in which keys should be stored. -

    -
    +

    key-size keytype size;
    -
    -

    +

    Specifies the number of bits to use in creating keys. The keytype is either "zsk" or "ksk". A default value for this option can be set in algorithm policies as well as in policy classes or zone policies. If no policy is configured, the default is 1024 bits for DSA keys and 2048 for RSA. -

    -
    +

    keyttl duration;
    -
    -

    +

    The key TTL. If no policy is defined, the default is one hour. -

    -
    +

    post-publish keytype duration;
    -
    -

    +

    How long after inactivation a key should be deleted from the zone. Note: If roll-period is not set, this value is ignored. The keytype is either "zsk" or "ksk". A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies. The default is one month. -

    -
    +

    pre-publish keytype duration;
    -
    -

    +

    How long before activation a key should be published. Note: If roll-period is not set, this value is ignored. The keytype is either "zsk" or "ksk". A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies. The default is one month. -

    -
    +

    roll-period keytype duration;
    -
    -

    +

    How frequently keys should be rolled over. The keytype is either "zsk" or "ksk". A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies. If no policy is configured, the default is one year for ZSKs. KSKs do not roll over by default. -

    -
    +

    standby keytype number;
    -
    -

    +

    Not yet implemented. -

    -
    +

    -
    - -
    +
    +

    REMAINING WORK

    -
      -
    • -

      +

        +

      • Enable scheduling of KSK rollovers using the -P sync and -D sync options to dnssec-keygen and dnssec-settime. Check the parent zone (as in dnssec-checkds) to determine when it's safe for the key to roll. -

        -
        • -
      • -

        +

        • +

      • Allow configuration of standby keys and use of the REVOKE bit, for keys that use RFC 5011 semantics. -

        -
        • +

      -
    - -
    +
    +

    SEE ALSO

    -

    - - dnssec-coverage(8) - , - - dnssec-keygen(8) - , - - dnssec-settime(8) - , - - dnssec-checkds(8) - +

    + dnssec-coverage(8), + dnssec-keygen(8), + dnssec-settime(8), + dnssec-checkds(8)

    -
    - +
@@ -416,6 +328,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-revoke.html b/doc/arm/man.dnssec-revoke.html index 3affc950d6..7dffc59f32 100644 --- a/doc/arm/man.dnssec-revoke.html +++ b/doc/arm/man.dnssec-revoke.html @@ -32,88 +32,52 @@
- - - - - -
+

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 @@ -121,36 +85,27 @@ (--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.

-
- +
@@ -171,6 +126,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-settime.html b/doc/arm/man.dnssec-settime.html index e64d3fe651..b215f0004c 100644 --- a/doc/arm/man.dnssec-settime.html +++ b/doc/arm/man.dnssec-settime.html @@ -32,49 +32,17 @@
- - - - - -
+

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] - [-P sync date/offset] - [-A date/offset] - [-R date/offset] - [-I date/offset] - [-D date/offset] - [-D sync date/offset] - [-S key] - [-i interval] - [-h] - [-V] - [-v level] - [-E engine] - {keyfile} -

-
- -
+

dnssec-settime [-f] [-K directory] [-L ttl] [-P date/offset] [-P sync date/offset] [-A date/offset] [-R date/offset] [-I date/offset] [-D date/offset] [-D sync date/offset] [-S key] [-i interval] [-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 @@ -83,12 +51,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. @@ -97,16 +65,12 @@ 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, @@ -115,17 +79,13 @@ 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 @@ -134,32 +94,25 @@ 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 @@ -167,14 +120,12 @@ (--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 @@ -184,65 +135,49 @@ 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. -

-
+

-P sync date/offset
-
-

+

Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone. -

-
+

-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.) -

-
+

-D sync date/offset
-
-

+

Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. -

-
+

-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 @@ -250,11 +185,10 @@ 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 @@ -263,40 +197,34 @@ 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/Psync/A/R/I/D/Dsync/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 or strings to indicate which value @@ -310,25 +238,17 @@ D for the deletion date, and Dsync for the CDS and CDNSKEY 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.

-
- +
@@ -349,6 +269,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-signzone.html b/doc/arm/man.dnssec-signzone.html index e60b7f4604..c9c6a4c92b 100644 --- a/doc/arm/man.dnssec-signzone.html +++ b/doc/arm/man.dnssec-signzone.html @@ -32,72 +32,17 @@
- - - - - -
+

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] - [-i interval] - [-I input-format] - [-j jitter] - [-K directory] - [-k key] - [-L serial] - [-l domain] - [-M maxttl] - [-N soa-serial-format] - [-o origin] - [-O output-format] - [-P] - [-p] - [-Q] - [-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] [-i interval] [-I input-format] [-j jitter] [-K directory] [-k key] [-L serial] [-l domain] [-M maxttl] [-N soa-serial-format] [-o origin] [-O output-format] [-P] [-p] [-Q] [-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 @@ -105,46 +50,34 @@ 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 @@ -153,16 +86,15 @@ 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 @@ -170,39 +102,30 @@ (--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 @@ -215,11 +138,9 @@ 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 @@ -228,11 +149,9 @@ 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 @@ -242,11 +161,10 @@ 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 @@ -254,7 +172,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 @@ -265,34 +183,28 @@ 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 @@ -300,7 +212,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 @@ -311,10 +223,9 @@ 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". @@ -323,11 +234,10 @@ 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. @@ -338,72 +248,55 @@ 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", "unixtime", and "date".

- -
+
"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.

"date"
-
-

Set the SOA serial number to today's date in - YYYYMMDDNN format.

-
+

Set the SOA serial number to today's date in + YYYYMMDDNN format.

- -
+
-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; @@ -416,36 +309,33 @@ 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 @@ -457,23 +347,22 @@ 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 @@ -483,65 +372,53 @@ 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 @@ -553,102 +430,81 @@ 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 @@ -661,13 +517,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.

@@ -675,19 +531,14 @@ 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.

-
- +
@@ -708,6 +559,6 @@ db.example.com.signed
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnssec-verify.html b/doc/arm/man.dnssec-verify.html index 171e12af94..10ffe859a2 100644 --- a/doc/arm/man.dnssec-verify.html +++ b/doc/arm/man.dnssec-verify.html @@ -32,64 +32,35 @@
- - - - - -
+

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 @@ -97,10 +68,9 @@ (--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". @@ -109,41 +79,32 @@ 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 @@ -151,7 +112,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 @@ -160,28 +121,21 @@ 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.

-
- +
@@ -202,6 +156,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.dnstap-read.html b/doc/arm/man.dnstap-read.html index 54bf14b90f..d648e43e8d 100644 --- a/doc/arm/man.dnstap-read.html +++ b/doc/arm/man.dnstap-read.html @@ -32,36 +32,17 @@
- - - - - -
+

Name

-

- dnstap-read - — print dnstap data in human-readable form -

+

dnstap-read — print dnstap data in human-readable form

- - - -
+

Synopsis

-

- dnstap-read - [-m] - [-p] - [-y] - {file} -

-
- -
+

dnstap-read [-m] [-p] [-y] {file}

+
+

DESCRIPTION

- -

+

dnstap-read reads dnstap data from a specified file and prints it in a human-readable format. By default, @@ -69,51 +50,35 @@ format, but if the -y option is specified, then a longer and more detailed YAML format is used instead.

-
- -
+
+

OPTIONS

- - -
+
-m
-
-

+

Trace memory allocations; used for debugging memory leaks. -

-
+

-p
-
-

+

After printing the dnstap data, print the text form of the DNS message that was encapsulated in the dnstap frame. -

-
+

-y
-
-

+

Print dnstap data in a detailed YAML format. -

-
+

-
- -
+
+

SEE ALSO

- -

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

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

-
- +
@@ -134,6 +99,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.genrandom.html b/doc/arm/man.genrandom.html index 20471a63f0..e680f6445a 100644 --- a/doc/arm/man.genrandom.html +++ b/doc/arm/man.genrandom.html @@ -32,81 +32,48 @@
- - - - - -
+

Name

-

- genrandom - — generate a file containing random data -

+

genrandom — generate a file containing random data

- - - -
+

Synopsis

-

- genrandom - [-n number] - {size} - {filename} -

-
- -
+

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)

-
- +
@@ -126,6 +93,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.host.html b/doc/arm/man.host.html index 01f1bc12fa..2ccbab2123 100644 --- a/doc/arm/man.host.html +++ b/doc/arm/man.host.html @@ -32,57 +32,24 @@
- - - - - -
+

Name

-

- host - — DNS lookup utility -

+

host — DNS lookup utility

- - - -
+

Synopsis

-

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

-
- -
+

host [-aCdlnrsTUwv] [-c class] [-N ndots] [-p port] [-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 @@ -94,86 +61,68 @@ 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 @@ -183,17 +132,13 @@ searched for in the domains listed in the search or domain directive in /etc/resolv.conf. -

-
+

-p port
-
-

+

Specify the port on the server to query. The default is 53. -

-
+

-r
-
-

+

Non-recursive query: Setting this option clears the RD (recursion desired) bit in the query. This should mean that the name server @@ -204,35 +149,30 @@ 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, or the value of the attempts option in /etc/resolv.conf, if set. -

-
+

-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. @@ -243,18 +183,17 @@ 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, -U
-
-

+

TCP/UDP: By default, host uses UDP when making queries. The -T option makes it use a TCP @@ -262,67 +201,55 @@ automatically selected for queries that require it, such as zone transfer (AXFR) requests. Type ANY queries default to TCP but can be forced to UDP initially using -U. -

-
+

-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. Verbose output can also be enabled by setting the debug option in /etc/resolv.conf. -

-
+

-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. These defaults can be overridden by the timeout option in /etc/resolv.conf.

-

+

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 @@ -333,27 +260,18 @@ 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).

-
- +
@@ -374,6 +292,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.isc-hmac-fixup.html b/doc/arm/man.isc-hmac-fixup.html index a61d51898d..5e191d821e 100644 --- a/doc/arm/man.isc-hmac-fixup.html +++ b/doc/arm/man.isc-hmac-fixup.html @@ -32,34 +32,17 @@
- - - - - -
+

Name

-

- isc-hmac-fixup - — fixes HMAC keys generated by older versions of BIND -

+

isc-hmac-fixup — fixes HMAC keys generated by older versions of BIND

- - - -
+

Synopsis

-

- isc-hmac-fixup - {algorithm} - {secret} -

-
- -
+

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 @@ -67,13 +50,13 @@ message authentication code that was incompatible with other DNS implementations.

-

+

This bug was 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 @@ -82,12 +65,10 @@ 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, @@ -95,17 +76,14 @@ extra length would not significantly increase the function strength."

-
- -
+
+

SEE ALSO

- -

+

BIND 9 Administrator Reference Manual, RFC 2104.

-
- +
@@ -125,6 +103,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.lwresd.html b/doc/arm/man.lwresd.html index f12f7f95c5..d56e7fdfd5 100644 --- a/doc/arm/man.lwresd.html +++ b/doc/arm/man.lwresd.html @@ -32,59 +32,24 @@
- - - - - -
+

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 @@ -92,14 +57,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 @@ -109,80 +74,60 @@ 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, @@ -191,61 +136,54 @@ 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 @@ -253,62 +191,40 @@ 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).

-
- +
@@ -329,6 +245,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.mdig.html b/doc/arm/man.mdig.html index 4f84fbc9ec..b69a90d876 100644 --- a/doc/arm/man.mdig.html +++ b/doc/arm/man.mdig.html @@ -32,69 +32,29 @@
- - - -
+

Name

-

- mdig - — DNS pipelined lookup utility -

+

mdig — DNS pipelined lookup utility

- - - -
+

Synopsis

-

- mdig - {@server} - [-f filename] - [-h] - [-v] - [ - [-4] - | [-6] - ] - [-m] - [-b address] - [-p port#] - [-c class] - [-t type] - [-i] - [-x addr] - [plusopt...] -

- -

- mdig - {-h} -

- -

- mdig - [@server] - {global-opt...} - { +

mdig {@server} [-f filename] [-h] [-v] [[-4] | [-6]] [-m] [-b address] [-p port#] [-c class] [-t type] [-i] [-x addr] [plusopt...]

+

mdig {-h}

+

mdig [@server] {global-opt...} { {local-opt...} {query} - ...} -

-
- -
+ ...}

+
+

DESCRIPTION

- -

mdig +

mdig is a multiple/pipelined query version of dig: instead of waiting for a response after sending each query, it begins by sending all queries. Responses are displayed in the order in which they are received, not in the order the corresponding queries were sent.

- -

+

mdig options are a subset of the dig options, and are divided into "anywhere options" which can occur anywhere, "global options" which must @@ -102,8 +62,7 @@ and "local options" which apply to the next query on the command line.

- -

+

The {@server} option is a mandatory global option. It is the name or IP address of the name server to query. (Unlike dig, this value is not retrieved from @@ -114,16 +73,14 @@ mdig resolves that name before querying the name server.

- -

mdig +

mdig 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 by the string no @@ -131,13 +88,10 @@ values to options like the timeout interval. They have the form +keyword=value.

-
- -
+
+

ANYWHERE OPTIONS

- - -

+

The -f option makes mdig operate in batch mode by reading a list of lookup requests to process from the file filename. The file @@ -145,45 +99,36 @@ file should be organized in the same way they would be presented as queries to mdig using the command-line interface.

- -

+

The -h causes mdig to print the detailed help with the full list of options and exit.

- -

+

The -v causes mdig to print the version number and exit.

-
- -
+
+

GLOBAL OPTIONS

- - -

+

The -4 option forces mdig to only use IPv4 query transport.

- -

+

The -6 option forces mdig to only use IPv6 query transport.

- -

+

The -b option 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 port may be specified by appending "#<port>"

- -

+

The -m option enables memory usage debugging.

- -

+

The -p option is used when a non-standard port number is to be queried. port# is the port number @@ -192,73 +137,55 @@ test a name server that has been configured to listen for queries on a non-standard port number.

- -

+

The global query options are:

+[no]additional
-
-

+

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

-
+

+[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. -

-
+

+burst
-
- This option delays queries until the start of the next second. -
+

+ This option delays queries until the start of the next second. +

+[no]cl
-
-

+

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

-
+

+[no]comments
-
-

+

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

-
+

+[no]continue
-
-

+

Continue on errors (e.g. timeouts). -

-
+

+[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 @@ -267,53 +194,41 @@ are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]". -

-
+

+dscp[=value]
-
-

+

Set the DSCP code point to be used when sending the query. Valid DSCP code points are in the range [0..63]. By default no code point is explicitly set. -

-
+

+[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 mdig output. -

-
+

+[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]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]short
-
-

+

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

-
+

+split=W
-
-

+

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

-
+

+[no]tcp
-
-

+

Use [do not use] TCP when querying name servers. The default behavior is to use UDP. -

-
+

+[no]ttlid
-
-

+

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

-
+

+[no]ttlunits
-
-

+

Display [do not display] the TTL in friendly human-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks. Implies +ttlid. -

-
+

+[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". -

-
+

-
- -
+
+

LOCAL OPTIONS

- - -

+

The -c option sets the query class to class. It can be any valid query class which is supported in BIND 9. The default query class is "IN".

- -

+

The -t option sets the query type to type. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the -x option is supplied to indicate a reverse lookup with the "PTR" query type.

- -

+

The -i option sets the reverse domain for IPv6 addresses to IP6.INT.

- -

+

Reverse lookups — mapping addresses to names — are simplified by the -x option. addr is an IPv4 @@ -396,26 +296,20 @@ under the IP6.ARPA domain. To use the older RFC1886 method using the IP6.INT domain specify the -i option.

- -

+

The local query options are:

+[no]aaflag
-
-

+

A synonym for +[no]aaonly. -

-
+

+[no]aaonly
-
-

+

Sets the "aa" flag in the query. -

-
+

+[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 @@ -425,110 +319,87 @@ 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. -

-
+

+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]cookie[=####]
-
-

+

Send a COOKIE EDNS option, with optional value. Replaying a COOKIE from a previous response will allow the server to identify a previous client. The default is +nocookie. -

-
+

+[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. -

-
+

+[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]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 be sent. -

-
+

+[no]expire
-
-

+

Send an EDNS Expire option. -

-
+

+[no]nsid
-
-

+

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

-
+

+[no]recurse
-
-

+

Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means mdig normally sends recursive queries. -

-
+

+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]subnet=addr[/prefix-length]
-

+

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

-

+

mdig +subnet=0.0.0.0/0, or simply mdig +subnet=0 for short, sends an EDNS client-subnet option with an empty address and a source @@ -537,64 +408,50 @@ not be used when resolving this query.

-
+
+timeout=T
-
-

+

Sets the timeout for a query to T seconds. The default timeout is 5 seconds for UDP transport and 10 for TCP. An attempt to set T to less than 1 will result in a query timeout of 1 second being applied. -

-
+

+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. -

-
+

+udptimeout=T
-
-

+

Sets the timeout between UDP query retries. -

-
+

+[no]unknownformat
-
-

+

Print all RDATA in unknown RR type presentation format (RFC 3597). The default is to print RDATA for known types in the type's presentation format. -

-
+

+[no]zflag
-
-

+

Set [do not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. -

-
+

-
- -
+
+

SEE ALSO

- -

- dig(1) - , +

dig(1), RFC1035.

-
+
@@ -615,6 +472,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.named-checkconf.html b/doc/arm/man.named-checkconf.html index 101d36acfa..ca032fc77c 100644 --- a/doc/arm/man.named-checkconf.html +++ b/doc/arm/man.named-checkconf.html @@ -32,45 +32,26 @@
- - - - - - - -
+

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 @@ -80,50 +61,37 @@ 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 @@ -131,47 +99,33 @@ 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.

-
+
@@ -192,6 +146,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.named-checkzone.html b/doc/arm/man.named-checkzone.html index e1423071e0..8e57398cce 100644 --- a/doc/arm/man.named-checkzone.html +++ b/doc/arm/man.named-checkzone.html @@ -32,94 +32,24 @@
- - - - - - - -
+

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. @@ -130,62 +60,45 @@ 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", @@ -193,19 +106,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 @@ -214,33 +127,31 @@ 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", @@ -251,10 +162,9 @@ 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" @@ -262,48 +172,38 @@ "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" @@ -311,30 +211,24 @@ "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". @@ -347,102 +241,75 @@ 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.

-
- +
@@ -463,6 +330,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.named-journalprint.html b/doc/arm/man.named-journalprint.html index 52ee564fca..36afaf4ae0 100644 --- a/doc/arm/man.named-journalprint.html +++ b/doc/arm/man.named-journalprint.html @@ -32,38 +32,22 @@
- - - - - -
+

Name

-

- named-journalprint - — print zone journal in human-readable form -

+

named-journalprint — print zone journal in human-readable form

- - - -
+

Synopsis

-

- named-journalprint - {journal} -

-
- -
+

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 @@ -74,29 +58,22 @@ .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(1) - , +

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

-
- +
@@ -117,6 +94,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.named-nzd2nzf.html b/doc/arm/man.named-nzd2nzf.html index 7399bd9b25..152c98dbec 100644 --- a/doc/arm/man.named-nzd2nzf.html +++ b/doc/arm/man.named-nzd2nzf.html @@ -32,34 +32,19 @@
- - - - -
+

Name

-

- named-nzd2nzf - — +

named-nzd2nzf — Convert an NZD database to NZF text format - -

+

- - - -
+

Synopsis

-

- named-nzd2nzf - {filename} -

-
- -
+

named-nzd2nzf {filename}

+
+

DESCRIPTION

- -

+

named-nzd2nzf converts an NZD database to NZF format and prints it to standard output. This can be used to review the configuration of zones that were added to @@ -68,37 +53,28 @@ when rolling back from a newer version of BIND to an older version.

-
- -
+
+

ARGUMENTS

- -
+
filename
-
-

+

The name of the .nzd file whose contents should be printed. -

-
+

-
- -
+
+

SEE ALSO

- -

+

BIND 9 Administrator Reference Manual

-
- -
+
+

AUTHOR

- -

Internet Systems Consortium +

Internet Systems Consortium

-
- +
@@ -119,6 +95,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.named-rrchecker.html b/doc/arm/man.named-rrchecker.html index 293731ae55..79ca8fc299 100644 --- a/doc/arm/man.named-rrchecker.html +++ b/doc/arm/man.named-rrchecker.html @@ -32,75 +32,50 @@
- - - -
+

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)

-
- +
@@ -121,6 +96,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.named.conf.html b/doc/arm/man.named.conf.html index 6047d391df..b4a16f364b 100644 --- a/doc/arm/man.named.conf.html +++ b/doc/arm/man.named.conf.html @@ -32,61 +32,42 @@
- - - - - -
+

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; ... };

-
- -
+
+

CONTROLS

- -


+


controls {
inet ( ipv4_address | ipv6_address |
    * ) [ port ( integer | * ) ] allow
@@ -99,43 +80,35 @@ controls     boolean ];
};

-
- -
+
+

DLZ

- -


+


dlz string {
database string;
search boolean;
};

-
- -
+
+

DYNDB

- -


+


dyndb string quoted_string {
    unspecified-text };

-
- -
+
+

KEY

- -


+


key string {
algorithm string;
secret string;
};

-
- -
+
+

LOGGING

- -


+


logging {
category string { string; ... };
channel string {
@@ -152,12 +125,10 @@ logging };
};

-
- -
+
+

LWRES

- -


+


lwres {
listen-on [ port integer ] [ dscp integer ] { ( ipv4_address
    | ipv6_address ) [ port integer ] [ dscp integer ]; ... };
@@ -168,32 +139,26 @@ lwres view string [ class ];
};

-
- -
+
+

MANAGED-KEYS

- -


+


managed-keys { string string integer
    integer integer quoted_string; ... };

-
- -
+
+

MASTERS

- -


+


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

-
- -
+
+

OPTIONS

- -


+


options {
acache-cleaning-interval integer;
acache-enable boolean;
@@ -469,12 +434,10 @@ options zone-statistics ( full | terse | none | boolean );
};

-
- -
+
+

SERVER

- -


+


server netprefix {
bogus boolean;
edns boolean;
@@ -506,12 +469,10 @@ server transfers integer;
};

-
- -
+
+

STATISTICS-CHANNELS

- -


+


statistics-channels {
inet ( ipv4_address | ipv6_address |
    * ) [ port ( integer | * ) ] [
@@ -519,21 +480,17 @@ statistics-channels     } ];
};

-
- -
+
+

TRUSTED-KEYS

- -


+


trusted-keys { string integer integer
    integer quoted_string; ... };

-
- -
+
+

VIEW

- -


+


view string [ class ] {
acache-cleaning-interval integer;
acache-enable boolean;
@@ -884,12 +841,10 @@ view zone-statistics ( full | terse | none | boolean );
};

-
- -
+
+

ZONE

- -


+


zone string [ class ] {
allow-notify { address_match_element; ... };
allow-query { address_match_element; ... };
@@ -983,37 +938,22 @@ zone zone-statistics ( full | terse | none | boolean );
};

-
- -
+
+

FILES

- -

/etc/named.conf +

/etc/named.conf

-
- -
+
+

SEE ALSO

- -

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

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

-
- +
@@ -1034,6 +974,6 @@ zone
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.named.html b/doc/arm/man.named.html index f34f4b0050..90febff386 100644 --- a/doc/arm/man.named.html +++ b/doc/arm/man.named.html @@ -32,93 +32,46 @@
- - - - - -
+

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] - [-L logfile] - [-M option] - [-m flag] - [-n #cpus] - [-p port] - [-s] - [-S #max-socks] - [-t directory] - [-U #listeners] - [-u user] - [-v] - [-V] - [-X lock-file] - [-x cache-file] -

-
- -
+

named [[-4] | [-6]] [-c config-file] [-d debug-level] [-D string] [-E engine-name] [-f] [-g] [-L logfile] [-M option] [-m flag] [-n #cpus] [-p port] [-s] [-S #max-socks] [-t directory] [-U #listeners] [-u user] [-v] [-V] [-X lock-file] [-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 @@ -128,33 +81,28 @@ 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 @@ -162,40 +110,31 @@ (--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. -

-
+

-L logfile
-
-

+

Log to the file logfile by default instead of the system log. -

-
+

-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, @@ -204,51 +143,46 @@ 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 @@ -263,18 +197,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 @@ -282,11 +216,10 @@ 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 @@ -299,18 +232,17 @@ 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 @@ -323,23 +255,18 @@ 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 lock-file
-
-

+

Acquire a lock on the specified file at runtime; this helps to prevent duplicate named instances from running simultaneously. @@ -347,68 +274,54 @@ option in named.conf. If set to none, the lock file check is disabled. -

-
+

-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, @@ -416,60 +329,33 @@ 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.

-
- +
@@ -490,6 +376,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.nsec3hash.html b/doc/arm/man.nsec3hash.html index ae2b63065a..d94d61a5b9 100644 --- a/doc/arm/man.nsec3hash.html +++ b/doc/arm/man.nsec3hash.html @@ -32,85 +32,53 @@
- - - - - -
+

Name

-

- nsec3hash - — generate NSEC3 hash -

+

nsec3hash — generate NSEC3 hash

- - - -
+

Synopsis

-

- nsec3hash - {salt} - {algorithm} - {iterations} - {domain} -

-
- -
+

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.

-
- +
@@ -130,6 +98,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.nslookup.html b/doc/arm/man.nslookup.html index 7454c97227..e80e980378 100644 --- a/doc/arm/man.nslookup.html +++ b/doc/arm/man.nslookup.html @@ -32,35 +32,17 @@
- - - - - -
+

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 @@ -69,37 +51,29 @@ 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 @@ -112,283 +86,238 @@ 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 and then AAAA; abbreviations = q, ty)

-

+

Note: It is only possible to specify one query type, only the default behavior looks up both when an alternative is not specified.

-
+
[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.

-
- -
+
+

IDN SUPPORT

- -

+

If nslookup has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. nslookup appropriately converts character encoding of @@ -400,29 +329,19 @@ nslookup -query=hinfo -timeout=10 nslookup runs or when the standard output is not a tty.

-
- -
+
+

FILES

- -

/etc/resolv.conf +

/etc/resolv.conf

-
- -
+
+

SEE ALSO

- -

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

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

-
+
@@ -443,6 +362,6 @@ nslookup -query=hinfo -timeout=10
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.nsupdate.html b/doc/arm/man.nsupdate.html index 492fcad3a5..682e06dbff 100644 --- a/doc/arm/man.nsupdate.html +++ b/doc/arm/man.nsupdate.html @@ -32,51 +32,17 @@
- - - - -
+

Name

-

- nsupdate - — Dynamic DNS update utility -

+

nsupdate — Dynamic DNS update utility

- - - -
+

Synopsis

-

- nsupdate - [-d] - [-D] - [-i] - [-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] [-i] [-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 @@ -85,27 +51,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. @@ -120,47 +86,37 @@ 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. -

-
+

-i
-
-

+

Force interactive mode, even when standard input is not a terminal. -

-
+

-k keyfile
-
-

+

The file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing a named.conf-format key @@ -172,11 +128,9 @@ 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 @@ -185,40 +139,30 @@ 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 @@ -227,60 +171,51 @@ 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. @@ -292,23 +227,19 @@ 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. @@ -322,7 +253,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 @@ -332,7 +263,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:

@@ -341,8 +272,7 @@ {servername} [port] -
-

+

Sends all dynamic update requests to the name server servername. When no server statement is provided, @@ -358,15 +288,13 @@ 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. @@ -378,14 +306,12 @@ 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 @@ -394,38 +320,32 @@ 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 @@ -434,80 +354,66 @@ 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 command line. -

-
+

oldgsstsig
-
-

+

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

-
+

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. -

-
+

check-names {[yes_or_no]}
-
-

+

Turn on or off check-names processing on records to be added. Check-names has no effect on prerequisites or records to be deleted. By default check-names processing is on. If check-names processing fails the record will not be added to the UPDATE message. -

-
+

[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 @@ -516,16 +422,14 @@ 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 @@ -535,8 +439,7 @@ If class is omitted, IN (internet) is assumed. -

-
+

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

+

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

-
+

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

+

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

-
+

[update] add {domain-name} @@ -599,80 +498,62 @@ {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 @@ -693,7 +574,7 @@

-

+

Any A records for oldhost.example.com are deleted. @@ -710,7 +591,7 @@

-

+

The prerequisite condition gets the name server to check that there are no resource records of any type for nickname.example.com. @@ -723,50 +604,33 @@ (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, @@ -774,29 +638,20 @@ 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.

-
- +
@@ -816,6 +671,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.pkcs11-destroy.html b/doc/arm/man.pkcs11-destroy.html index b87bf2d7ee..e65dc24edf 100644 --- a/doc/arm/man.pkcs11-destroy.html +++ b/doc/arm/man.pkcs11-destroy.html @@ -32,116 +32,70 @@
- - - - - -
+

Name

-

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

+

pkcs11-destroy — destroy PKCS#11 objects

- - - -
+

Synopsis

-

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

-
- -
+

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)

-
- +
@@ -162,6 +116,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.pkcs11-keygen.html b/doc/arm/man.pkcs11-keygen.html index 81044d9faa..6d66e969a3 100644 --- a/doc/arm/man.pkcs11-keygen.html +++ b/doc/arm/man.pkcs11-keygen.html @@ -32,154 +32,95 @@
- - - - - -
+

Name

-

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

+

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} -

-
- -
+

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, ECC and ECX. 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, ECDSAP256SHA256 maps to ECC, and ED25519 to ECX. 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. For ECX kyes, the only valid values are 256 and 456, 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)

-
- +
@@ -200,6 +141,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.pkcs11-list.html b/doc/arm/man.pkcs11-list.html index 0b2298ff87..349eb57778 100644 --- a/doc/arm/man.pkcs11-list.html +++ b/doc/arm/man.pkcs11-list.html @@ -32,38 +32,17 @@
- - - - - -
+

Name

-

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

+

pkcs11-list — list PKCS#11 objects

- - - -
+

Synopsis

-

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

-
- -
+

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. @@ -72,72 +51,49 @@ attribute is also displayed, as either true, false, or never.

-
- -
+
+

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)

-
- +
@@ -158,6 +114,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.pkcs11-tokens.html b/doc/arm/man.pkcs11-tokens.html index 5e74ca7683..e035863f34 100644 --- a/doc/arm/man.pkcs11-tokens.html +++ b/doc/arm/man.pkcs11-tokens.html @@ -32,77 +32,45 @@
- - - - - -
+

Name

-

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

+

pkcs11-tokens — list PKCS#11 available tokens

- - - -
+

Synopsis

-

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

-
- -
+

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)

-
- +
@@ -123,6 +91,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.rndc-confgen.html b/doc/arm/man.rndc-confgen.html index f031ae309a..11f65597cc 100644 --- a/doc/arm/man.rndc-confgen.html +++ b/doc/arm/man.rndc-confgen.html @@ -32,43 +32,17 @@
- - - - - -
+

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 @@ -81,17 +55,13 @@ 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 @@ -106,7 +76,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 @@ -114,7 +84,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, @@ -125,57 +95,44 @@ 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 @@ -186,30 +143,24 @@ 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. @@ -217,46 +168,34 @@ -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.

-
- +
@@ -277,6 +216,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.rndc.conf.html b/doc/arm/man.rndc.conf.html index 6498811bcc..517eeda1aa 100644 --- a/doc/arm/man.rndc.conf.html +++ b/doc/arm/man.rndc.conf.html @@ -32,32 +32,17 @@
- - - - - -
+

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 @@ -65,21 +50,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 @@ -102,7 +87,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: @@ -116,7 +101,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 @@ -127,7 +112,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 @@ -140,13 +125,10 @@ 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;
@@ -154,14 +136,14 @@
 

 

     

-    
+
       server localhost {
         key             samplekey;
       };
 

 

     

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

 

     

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

 

     

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

 

     

-
-    

+

       In the above example, rndc will by
       default use
       the server at localhost (127.0.0.1) and the key called samplekey.
@@ -196,16 +177,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
@@ -213,41 +194,30 @@
       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.

-
- +
@@ -268,6 +238,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/man.rndc.html b/doc/arm/man.rndc.html index 7f1af7a6ad..ec00632693 100644 --- a/doc/arm/man.rndc.html +++ b/doc/arm/man.rndc.html @@ -30,42 +30,17 @@
- - - - - -
+

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] - [-r] - [-V] - [-y key_id] - {command} -

-
- -
+

rndc [-b source-address] [-c config-file] [-k key-file] [-s server] [-p port] [-q] [-r] [-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 @@ -74,7 +49,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 @@ -88,38 +63,30 @@ 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 @@ -127,52 +94,40 @@ 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. -

-
+

-r
-
-

+

Instructs rndc to print the result code returned by named after executing the requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc). -

-
+

-V
-
-

+

Enable verbose logging. -

-
+

-y key_id
-
-

+

Use the key key_id from the configuration file. key_id @@ -188,26 +143,22 @@ 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 @@ -217,7 +168,7 @@ configuration text that would ordinarily be placed in named.conf.

-

+

The configuration is saved in a file called name.nzf, where name is the @@ -230,28 +181,28 @@ 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 and rndc modzone.

-
+
delzone [-clean] zone [class [view]]
-

+

Delete a zone while the server is running.

-

+

If the -clean argument is specified, the zone's master file (and journal file, if any) will be deleted along with the zone. Without the @@ -261,7 +212,7 @@ be cleaned up will be reported in the output of the rndc delzone command.)

-

+

If the zone was originally added via rndc addzone, then it will be removed permanently. However, if it was originally @@ -271,13 +222,12 @@ come back. To remove it permanently, it must also be removed from named.conf

-

+

See also rndc addzone and rndc modzone.

-
+
dnstap ( -reopen | -roll [number] )
-
-

+

Close and re-open DNSTAP output files. rndc dnstap -reopen allows the output file to be renamed externally, so @@ -288,43 +238,34 @@ previous most recent output file is moved to ".1", and so on. If number is specified, then the number of backup log files is limited to that number. -

-
+

dumpdb [-all|-cache|-zones|-adb|-bad|-fail] [view ...]
-
-

+

Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is specified, all 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 view's DNS cache and, if applicable, from the view's nameserver address database, bad server cache and SERVFAIL cache. -

-
+

flushtree name [view]
-
-

+

Flushes the given name, and all of its subdomains, from the view's DNS cache, address database, bad server cache, and SERVFAIL 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 @@ -333,13 +274,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 @@ -348,13 +289,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 @@ -363,7 +304,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, @@ -372,10 +313,9 @@ (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)

-
+
managed-keys (status | refresh | sync) [class [view]]
-
-

+

When run with the "status" keyword, print the current status of the managed-keys database for the specified view, or for all views if none is specified. When run @@ -385,11 +325,10 @@ immediate dump of the managed-keys database to disk (in the file managed-keys.bind or (viewname.mkeys). -

-
+

modzone zone [class [view]] configuration
-

+

Modify the configuration of a zone while the server is running. This command requires the allow-new-zones option to be @@ -400,7 +339,7 @@ configuration text that would ordinarily be placed in named.conf.

-

+

If the zone was originally added via rndc addzone, the configuration changes will be recorded permanently and will still be @@ -413,32 +352,30 @@ permanent, it must also be modified in named.conf

-

+

See also rndc addzone and rndc delzone.

-
+
notify zone [class [view]]
-
-

+

Resend NOTIFY messages for the zone. -

-
+

notrace
-

+

Sets the server's debugging level to 0.

-

+

See also rndc trace.

-
+
nta [( -class class | -dump | -force | -remove | -lifetime duration)] domain [view]
-

+

Sets a DNSSEC negative trust anchor (NTA) for domain, with a lifetime of duration. The default lifetime is @@ -446,7 +383,7 @@ nta-lifetime option, and defaults to one hour. The lifetime cannot exceed one week.

-

+

A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration rather than @@ -457,7 +394,7 @@ insecure rather than bogus. This continues until the NTA's lifetime is elapsed.

-

+

NTAs persist across restarts of the named server. The NTAs for a view are saved in a file called name.nta, @@ -467,11 +404,11 @@ cryptographic hash generated from the name of the view.

-

+

An existing NTA can be removed by using the -remove option.

-

+

An NTA's lifetime can be specified with the -lifetime option. TTL-style suffixes can be used to specify the lifetime in @@ -480,13 +417,13 @@ new value. Setting lifetime to zero is equivalent to -remove.

-

+

If the -dump is used, any other arguments are ignored, and a list of existing NTAs is printed (note that this may include NTAs that are expired but have not yet been cleaned up).

-

+

Normally, named will periodically test to see whether data below an NTA can now be validated (see the nta-recheck option @@ -498,25 +435,25 @@ lifetime, regardless of whether data could be validated if the NTA were not present.

-

+

The view class can be specified with -class. The default is class IN, which is the only class for which DNSSEC is currently supported.

-

+

All of these options can be shortened, i.e., to -l, -r, -d, -f, and -c.

-
+
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 @@ -527,10 +464,9 @@ 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. @@ -538,43 +474,34 @@ 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 @@ -582,24 +509,22 @@ 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 and negative trust anchors for the specified views. If no view is specified, all views are dumped.

-

+

If the first argument is "-", then the output is returned via the rndc response channel and printed to the standard output. @@ -608,22 +533,22 @@ overridden via the secroots-file option in named.conf.

-

+

See also rndc managed-keys.

-
+
showzone zone [class [view]]
-

+

Print the configuration of a running zone.

-

+

See also rndc zonestatus.

-
+
sign zone [class [view]]
-

+

Fetch all DNSSEC keys for the given zone from the key directory (see the key-directory option in @@ -633,7 +558,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 @@ -643,13 +568,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 ) | -serial value ) ] 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 @@ -662,7 +587,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 @@ -671,7 +596,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 @@ -680,7 +605,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 @@ -695,7 +620,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: @@ -704,40 +629,36 @@ salt, use: rndc signing -nsec3param 1 1 15 - zone.

-

+

rndc signing -nsec3param none removes an existing NSEC3 chain and replaces it with NSEC.

-

+

rndc signing -serial value sets the serial number of the zone to value. If the value would cause the serial number to go backwards it will be rejected. The primary use is to set the serial on inline signed zones.

-
+
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. @@ -745,20 +666,18 @@ 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 @@ -772,55 +691,47 @@ 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 includes both statically configured keys and dynamic TKEY-negotiated keys. -

-
+

validation ( on | off | status ) [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 @@ -831,47 +742,32 @@ management or inline signing, and the scheduled refresh or expiry times for the zone.

-

+

See also rndc showzone.

-
+
-
- -
+
+

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.

-
- +
@@ -890,6 +786,6 @@
-

BIND 9.11.25 (Extended Support Version)

+

BIND 9.11.26 (Extended Support Version)

diff --git a/doc/arm/notes-9.11.26.xml b/doc/arm/notes-9.11.26.xml index 4c78d15ea9..b1a659510b 100644 --- a/doc/arm/notes-9.11.26.xml +++ b/doc/arm/notes-9.11.26.xml @@ -57,7 +57,6 @@ Building with native PKCS#11 support for AEP Keyper has been broken since BIND 9.11.22. This has been fixed. [GL #2315] - #2315] diff --git a/doc/arm/notes.html b/doc/arm/notes.html index 0aeaaef250..1a962094d3 100644 --- a/doc/arm/notes.html +++ b/doc/arm/notes.html @@ -11,29 +11,26 @@ -
- -
+

-Release Notes for BIND Version 9.11.25

- -
+Release Notes for BIND Version 9.11.26
+

Introduction

-

+

BIND 9.11 (Extended Support Version) is a stable branch of BIND. This document summarizes significant changes since the last production release on that branch.

-

+

Please see the file CHANGES for a more detailed list of changes and bug fixes.

-
+

Download

-

+

The latest versions of BIND 9 software can always be found at https://www.isc.org/download/. There you will find additional information about each release, @@ -41,79 +38,115 @@ operating systems.

-
+

License Change

-

+

With the release of BIND 9.11.0, ISC changed to the open source license for BIND from the ISC license to the Mozilla Public License (MPL 2.0).

-

+

The MPL-2.0 license requires that if you make changes to licensed software (e.g. BIND) and distribute them outside your organization, that you publish those changes under that same license. It does not require that you publish or disclose anything other than the changes you made to our software.

-

+

This requirement will not affect anyone who is using BIND, with or without modifications, without redistributing it, nor anyone redistributing it without changes. Therefore, this change will be without consequence for most individuals and organizations who are using BIND.

-

+

Those unsure whether or not the license change affects their use of BIND, or who wish to discuss how to comply with the license may contact ISC at https://www.isc.org/mission/contact/.

- -
+
+

+Notes for BIND 9.11.26

+
+

+Feature Changes

+
    +

  • + The default value of max-recursion-queries was + increased from 75 to 100. Since the queries sent towards root and TLD + servers are now included in the count (as a result of the fix for + CVE-2020-8616), max-recursion-queries has a higher + chance of being exceeded by non-attack queries, which is the main + reason for increasing its default value. [GL #2305] +

    • +

  • + The default value of nocookie-udp-size was restored + back to 4096 bytes. Since max-udp-size is the upper + bound for nocookie-udp-size, this change relieves + the operator from having to change + nocookie-udp-size together with + max-udp-size in order to increase the default EDNS + buffer size limit. nocookie-udp-size can still be + set to a value lower than max-udp-size, if desired. + [GL #2250] +

    • +
+
+
+

+Bug Fixes

+
    +

  • + Handling of missing DNS COOKIE responses over UDP was tightened by + falling back to TCP. [GL #2275] +

    • +

  • + The CNAME synthesized from a DNAME was incorrectly followed when the + QTYPE was CNAME or ANY. [GL #2280] +

    • +

  • + Building with native PKCS#11 support for AEP Keyper has been broken + since BIND 9.11.22. This has been fixed. [GL #2315] +

    • +
+
+
+

Notes for BIND 9.11.25

- -
+

Bug Fixes

-
    -
  • -

    +

      +

    • named acting as a resolver could incorrectly treat signed zones with no DS record at the parent as bogus. Such zones should be treated as insecure. This has been fixed. [GL #2236] -

      -
      • -
    • -

      +

      • +

    • After a Negative Trust Anchor (NTA) is added, BIND performs periodic checks to see if it is still necessary. If BIND encountered a failure while creating a query to perform such a check, it attempted to dereference a NULL pointer, resulting in a crash. [GL #2244] -

      -
      • -
    • -

      +

      • +

    • A problem obtaining glue records could prevent a stub zone from functioning properly, if the authoritative server for the zone were configured for minimal responses. [GL #1736] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.24

- -
+

Feature Changes

-
  • -

    +

    • DNS Flag Day 2020: The default EDNS buffer size has been changed from 4096 to 1232 bytes. According to measurements done by multiple parties, this should not cause any operational problems as most of @@ -125,93 +158,79 @@ maximum Ethernet payload size, so a useful default for maximum DNS/UDP payload size on reliable networks would be 1400 bytes. [GL #2183] -

      -
    -
- -
+

+
+

Bug Fixes

-
    -
  • -

    +

      +

    • named reported an invalid memory size when running in an environment that did not properly report the number of available memory pages and/or the size of each memory page. [GL #2166] -

      -
      • -
    • -

      +

      • +

    • With multiple forwarders configured, named could fail the REQUIRE(msg->state == (-1)) assertion in lib/dns/message.c, causing it to crash. This has been fixed. [GL #2124] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.23

- -
+

Bug Fixes

-
    -
  • -

    +

      +

    • Parsing of LOC records was made more strict by rejecting a sole period (.) and/or m as a value. These changes prevent zone files using such values from being loaded. Handling of negative altitudes which are not integers was also corrected. [GL #2074] -

      -
      • -
    • -

      +

      • +

    • Several problems found by OSS-Fuzz were fixed. (None of these are security issues.) [GL !3953] [GL !3975] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.22

- -
+

Security Fixes

-
    +
    • -

      +

      It was possible to trigger an assertion failure when verifying the response to a TSIG-signed request. This was disclosed in CVE-2020-8622.

      -

      +

      ISC would like to thank Dave Feldman, Jeff Warren, and Joel Cunningham of Oracle for bringing this vulnerability to our attention. [GL #2028]

      -
      • +
    • -

      +

      When BIND 9 was compiled with native PKCS#11 support, it was possible to trigger an assertion failure in code determining the number of bits in the PKCS#11 RSA public key with a specially crafted packet. This was disclosed in CVE-2020-8623.

      -

      +

      ISC would like to thank Lyu Chiy for bringing this vulnerability to our attention. [GL #2037]

      -
      • +
    • -

      +

      update-policy rules of type subdomain were incorrectly treated as zonesub rules, which allowed keys used in @@ -220,104 +239,82 @@ subdomain rules are again processed as described in the ARM. This was disclosed in CVE-2020-8624.

      -

      +

      ISC would like to thank Joop Boonen of credativ GmbH for bringing this vulnerability to our attention. [GL #2055]

      -
      • +
    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • Wildcard RPZ passthru rules could incorrectly be overridden by other rules that were loaded from RPZ zones which appeared later in the response-policy statement. This has been fixed. [GL #1619] -

      -
      • -
    • -

      +

      • +

    • LMDB locking code was revised to make rndc reconfig work properly on FreeBSD and with LMDB >= 0.9.26. [GL #1976] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.21

- -
+

Bug Fixes

-
    -
  • -

    +

      +

    • named could crash when cleaning dead nodes in lib/dns/rbtdb.c that were being reused. [GL #1968] -

      -
      • -
    • -

      +

      • +

    • Properly handle missing kyua command so that make check does not fail unexpectedly when CMocka is installed, but Kyua is not. [GL #1950] -

      -
      • -
    • -

      +

      • +

    • The validator could fail to accept a properly signed RRset if an unsupported algorithm appeared earlier in the DNSKEY RRset than a supported algorithm. It could also stop if it detected a malformed public key. [GL #1689] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.20

- -
+

Security Fixes

-
  • -

    +

    • It was possible to trigger an INSIST failure when a zone with an interior wildcard label was queried in a certain pattern. This was disclosed in CVE-2020-8619. [GL #1111] [GL #1718] -

      -
    -
- -
+

+
+

New Features

-
  • -

    +

    • dig and other tools can now print the Extended DNS Error (EDE) option when it appears in a request or a response. [GL #1835] -

      -
    -
- -
+

+
+

Bug Fixes

-
    -
  • -

    +

      +

    • When fully updating the NSEC3 chain for a large zone via IXFR, a temporary loss of performance could be experienced on the secondary server when answering queries for nonexistent data that required @@ -325,49 +322,37 @@ the server to find and to return NSEC3 data). The unnecessary processing step that was causing this delay has now been removed. [GL #1834] -

      -
      • -
    • -

      +

      • +

    • A data race in lib/dns/resolver.c:log_formerr() that could lead to an assertion failure was fixed. [GL #1808] -

      -
      • -
    • -

      +

      • +

    • Previously, provide-ixfr no; failed to return up-to-date responses when the serial number was greater than or equal to the current serial number. [GL #1714] -

      -
      • -
    • -

      +

      • +

    • named-checkconf -p could include spurious text in server-addresses statements due to an uninitialized DSCP value. This has been fixed. [GL #1812] -

      -
      • -
    • -

      +

      • +

    • The ARM has been updated to indicate that the TSIG session key is generated when named starts, regardless of whether it is needed. [GL #1842] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.19

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • To prevent exhaustion of server resources by a maliciously configured domain, the number of recursive queries that can be triggered by a request before aborting recursion has been further limited. Root and @@ -375,317 +360,246 @@ max-recursion-queries limit. Fetches for missing name server address records are limited to 4 for any domain. This issue was disclosed in CVE-2020-8616. [GL #1388] -

      -
      • -
    • -

      +

      • +

    • Replaying a TSIG BADTIME response as a request could trigger an assertion failure. This was disclosed in CVE-2020-8617. [GL #1703] -

      -
      • +

    -
- -
+
+

Feature Changes

-
  • -

    +

    • Message IDs in inbound AXFR transfers are now checked for consistency. Log messages are emitted for streams with inconsistent message IDs. [GL #1674] -

      -
    -
- -
+

+
+

Bug Fixes

-
    -
  • -

    +

      +

    • When running on a system with support for Linux capabilities, named drops root privileges very soon after system startup. This was causing a spurious log message, "unable to set effective uid to 0: Operation not permitted", which has now been silenced. [GL #1042] [GL #1090] -

      -
      • -
    • -

      +

      • +

    • When named-checkconf -z was run, it would sometimes incorrectly set its exit code. It reflected the status of the last view found; if zone-loading errors were found in earlier configured views but not in the last one, the exit code indicated success. Thanks to Graham Clinch. [GL #1807] -

      -
      • -
    • -

      +

      • +

    • When built without LMDB support, named failed to restart after a zone with a double quote (") in its name was added with rndc addzone. Thanks to Alberto Fernández. [GL #1695] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.18

- -
+

Security Fixes

-
  • -

    +

    • DNS rebinding protection was ineffective when BIND 9 is configured as a forwarding DNS server. Found and responsibly reported by Tobias Klein. [GL #1574] -

      -
    -
- -
+

+
+

Known Issues

-
  • -

    +

    • We have received reports that in some circumstances, receipt of an IXFR can cause the processing of queries to slow significantly. Some of these are related to RPZ processing, others appear to occur where there are NSEC3-related changes (such as an operator changing the NSEC3 salt used in the hash calculation). These are being investigated. [GL #1685] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.17

- -
+

Feature Changes

-
  • -

    +

    • The configure option --with-libxml2 now uses pkg-config to detect libxml2 library availability. You will either have to install pkg-config or specify the exact path where libxml2 has been installed on your system. [GL #1635] -

      -
    -
- -
+

+
+

Bug Fixes

-
  • -

    +

    • Fixed re-signing issues with inline zones which resulted in records being re-signed late or not at all. -

      -
    -
- +

-
+
+

Notes for BIND 9.11.16

- -
+

Bug Fixes

-
  • -

    +

    • named crashed when it was queried for a nonexistent name in the CHAOS class. [GL #1540] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.15

- -
+

Bug Fixes

-
    -
  • -

    +

      +

    • Fixed a GeoIP2 lookup bug which was triggered when certain libmaxminddb versions were used. [GL #1552] -

      -
      • -
    • -

      +

      • +

    • Fixed several possible race conditions discovered by ThreadSanitizer. -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.14

- -
+

Bug Fixes

-
    -
  • -

    +

      +

    • Fixed a bug that caused named to leak memory on reconfiguration when any GeoIP2 database was in use. [GL #1445] -

      -
      • -
    • -

      +

      • +

    • Fixed several possible race conditions discovered by ThreadSanitizer. -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.13

- -
+

Security Fixes

-
  • -

    +

    • Set a limit on the number of concurrently served pipelined TCP queries. This flaw is disclosed in CVE-2019-6477. [GL #1264] -

      -
    -
- -
+

+
+

New Features

-
  • -

    +

    • Added a new statistics variable tcp-highwater that reports the maximum number of simultaneous TCP clients BIND has handled while running. [GL #1206] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.12

- -

+

None.

-
-
+

Notes for BIND 9.11.11

- -

+

None.

-
-
+

Notes for BIND 9.11.10

- -
+

New Features

-
    +
    • -

      +

      A SipHash 2-4 based DNS Cookie (RFC 7873) algorithm has been added. [GL #605]

      -

      +

      If you are running multiple DNS Servers (different versions of BIND 9 or DNS server from multiple vendors) responding from the same IP address (anycast or load-balancing scenarios), you'll have to make sure that all the servers are configured with the same DNS Cookie algorithm and same Server Secret for the best performance.

      -
      • -
    • -

      +

      • +

    • DS records included in DNS referral messages can now be validated and cached immediately, reducing the number of queries needed for a DNSSEC validation. [GL #964] -

      -
      • +

    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • Interaction between DNS64 and RPZ No Data rule (CNAME *.) could cause unexpected results; this has been fixed. [GL #1106] -

      -
      • -
    • -

      +

      • +

    • named-checkconf now checks DNS64 prefixes to ensure bits 64-71 are zero. [GL #1159] -

      -
      • -
    • -

      +

      • +

    • named-checkconf could crash during configuration if configured to use "geoip continent" ACLs with legacy GeoIP. [GL #1163] -

      -
      • -
    • -

      +

      • +

    • named-checkconf now correctly reports a missing dnstap-output option when dnstap is set. [GL #1136] -

      -
      • -
    • -

      +

      • +

    • Handle ETIMEDOUT error on connect() with a non-blocking socket. [GL #1133] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.9

- -
+

New Features

-
  • -

    +

    • +

      The new GeoIP2 API from MaxMind is now supported when BIND is compiled using configure --with-geoip2. The legacy GeoIP API can be used by compiling with @@ -693,7 +607,7 @@ the databases for the legacy API are no longer maintained by MaxMind.)

      -

      +

      The default path to the GeoIP2 databases will be set based on the location of the libmaxminddb library; for example, if it is in /usr/local/lib, @@ -702,7 +616,7 @@ This value can be overridden in named.conf using the geoip-directory option.

      -

      +

      Some geoip ACL settings that were available with legacy GeoIP, including searches for netspeed, org, and three-letter ISO country codes, will @@ -712,60 +626,48 @@ as. All of the databases support both IPv4 and IPv6 lookups. [GL #182]

      -
    -
- -
+
+
+

Bug Fixes

-
  • -

    +

    • Glue address records were not being returned in responses to root priming queries; this has been corrected. [GL #1092] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.8

- -
+

Security Fixes

-
  • -

    +

    • A race condition could trigger an assertion failure when a large number of incoming packets were being rejected. This flaw is disclosed in CVE-2019-6471. [GL #942] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.7

- -
+

Security Fixes

-
  • -

    +

    • The TCP client quota set using the tcp-clients option could be exceeded in some cases. This could lead to exhaustion of file descriptors. This flaw is disclosed in CVE-2018-5743. [GL #615] -

      -
    -
- -
+

+
+

Feature Changes

-
  • -

    +

    • +

      When trusted-keys and managed-keys are both configured for the same name, or when trusted-keys is used to @@ -774,26 +676,23 @@ auto, automatic RFC 5011 key rollovers will fail.

      -

      +

      This combination of settings was never intended to work, but there was no check for it in the parser. This has been corrected; a warning is now logged. (In BIND 9.15 and higher this error will be fatal.) [GL #868]

      -
    -
- +
-
+
+

Notes for BIND 9.11.6

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • Code change #4964, intended to prevent double signatures when deleting an inactive zone DNSKEY in some situations, introduced a new problem during zone processing in which @@ -804,134 +703,105 @@ NSEC/NSEC3 chain, but incompletely -- this can result in a broken chain, affecting validation of proof of nonexistence for records in the zone. [GL #771] -

      -
      • -
    • -

      +

      • +

    • named could crash if it managed a DNSSEC security root with managed-keys and the authoritative zone rolled the key to an algorithm not supported by BIND 9. This flaw is disclosed in CVE-2018-5745. [GL #780] -

      -
      • -
    • -

      +

      • +

    • named leaked memory when processing a request with multiple Key Tag EDNS options present. ISC would like to thank Toshifumi Sakaguchi for bringing this to our attention. This flaw is disclosed in CVE-2018-5744. [GL #772] -

      -
      • -
    • -

      +

      • +

    • Zone transfer controls for writable DLZ zones were not effective as the allowzonexfr method was not being called for such zones. This flaw is disclosed in CVE-2019-6465. [GL #790] -

      -
      • +

    -
- -
+
+

Feature Changes

-
  • -

    +

    • When compiled with IDN support, the dig and the nslookup commands now disable IDN processing when the standard output is not a tty (e.g. not used by human). The command line options +idnin and +idnout need to be used to enable IDN processing when dig or nslookup is used from the shell scripts. -

      -
    -
- +

-
+
+

Notes for BIND 9.11.5

- -
+

Security Fixes

-
  • -

    +

    • named could crash during recursive processing of DNAME records when deny-answer-aliases was in use. This flaw is disclosed in CVE-2018-5740. [GL #387] -

      -
    -
- -
+

+
+

New Features

-
  • -

    +

    • Two new update policy rule types have been added krb5-selfsub and ms-selfsub which allow machines with Kerberos principals to update the name space at or below the machine names identified in the respective principals. -

      -
    -
- -
+

+
+

Feature Changes

-
  • -

    +

    • The rndc nta command could not differentiate between views of the same name but different class; this has been corrected with the addition of a -class option. [GL #105] -

      -
    -
- -
+

+
+

Bug Fixes

-
  • -

    +

    • When a negative trust anchor was added to multiple views using rndc nta, the text returned via rndc was incorrectly truncated after the first line, making it appear that only one NTA had been added. This has been fixed. [GL #105] -

      -
    -
- +

-
+
+

Notes for BIND 9.11.4

- -
+

Security Fixes

-
  • -

    +

    • When recursion is enabled but the allow-recursion and allow-query-cache ACLs are not specified, they should be limited to local networks, but they were inadvertently set to match the default allow-query, thus allowing remote queries. This flaw is disclosed in CVE-2018-5738. [GL #309] -

      -
    -
- -
+

+
+

New Features

-
    -
  • -

    +

      +

    • named now supports the "root key sentinel" mechanism. This enables validating resolvers to indicate which trust anchors are configured for the root, so that @@ -939,16 +809,15 @@ To disable this feature, add root-key-sentinel no; to named.conf. -

      -
      • +

    • -

      +

      Added the ability not to return a DNS COOKIE option when one is present in the request. To prevent a cookie being returned, add answer-cookie no; to named.conf. [GL #173]

      -

      +

      answer-cookie no is only intended as a temporary measure, for use when named shares an IP address with other servers that do not yet @@ -960,106 +829,85 @@ mechanism, and should not be disabled unless absolutely necessary.

      -
      • +
    -
- -
+
+

Removed Features

-
  • -

    +

    • named will now log a warning if the old BIND now can be compiled against libidn2 library to add IDNA2008 support. Previously BIND only supported IDNA2003 using (now obsolete) idnkit-1 library. -

      -
    -
- -
+

+
+

Feature Changes

-
    -
  • -

    +

      +

    • dig +noidnin can be used to disable IDN processing on the input domain name, when BIND is compiled with IDN support. -

      -
      • -
    • -

      +

      • +

    • Multiple cookie-secret clause are now supported. The first cookie-secret in named.conf is used to generate new server cookies. Any others are used to accept old server cookies or those generated by other servers using the matching cookie-secret. -

      -
      • +

    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • named now rejects excessively large incremental (IXFR) zone transfers in order to prevent possible corruption of journal files which could cause named to abort when loading zones. [GL #339] -

      -
      • -
    • -

      +

      • +

    • rndc reload could cause named to leak memory if it was invoked before the zone loading actions from a previous rndc reload command were completed. [RT #47076] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.3

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • Addresses could be referenced after being freed during resolver processing, causing an assertion failure. The chances of this happening were remote, but the introduction of a delay in resolution increased them. This bug is disclosed in CVE-2017-3145. [RT #46839] -

      -
      • -
    • -

      +

      • +

    • update-policy rules that otherwise ignore the name field now require that it be set to "." to ensure that any type list present is properly interpreted. If the name field was omitted from the rule declaration and a type list was present it wouldn't be interpreted as expected. -

      -
      • +

    -
- -
+
+

Removed Features

-
    -
  • -

    +

      +

    • The ISC DNSSEC Lookaside Validation (DLV) service has been shut down; all DLV records in the dlv.isc.org zone have been removed. References to the service have been @@ -1069,24 +917,19 @@ Setting dnssec-lookaside to auto or to use dlv.isc.org as a trust anchor results in a warning being issued. -

      -
      • -
    • -

      +

      • +

    • named will now log a warning if the old root DNSSEC key is explicitly configured and has not been updated. [RT #43670] -

      -
      • +

    -
- -
+
+

Protocol Changes

-
    -
  • -

    +

      +

    • BIND can now use the Ed25519 and Ed448 Edwards Curve DNSSEC signing algorithms described in RFC 8080. Note, however, that these algorithms must be supported in OpenSSL; @@ -1095,25 +938,20 @@ https://github.com/openssl/openssl. [RT #44696] -

      -
      • -
    • -

      +

      • +

    • When parsing DNS messages, EDNS KEY TAG options are checked for correctness. When printing messages (for example, in dig), EDNS KEY TAG options are printed in readable format. -

      -
      • +

    -
- -
+
+

Feature Changes

-
    -
  • -

    +

      +

    • named will no longer start or accept reconfiguration if managed-keys or dnssec-validation auto are in use and @@ -1121,280 +959,216 @@ managed-keys-directory, and defaulting to the working directory if not specified), is not writable by the effective user ID. [RT #46077] -

      -
      • -
    • -

      +

      • +

    • Previously, update-policy local; accepted updates from any source so long as they were signed by the locally-generated session key. This has been further restricted; updates are now only accepted from locally configured addresses. [RT #45492] -

      -
      • +

    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • Attempting to validate improperly unsigned CNAME responses from secure zones could cause a validator loop. This caused a delay in returning SERVFAIL and also increased the chances of encountering the crash bug described in CVE-2017-3145. [RT #46839] -

      -
      • -
    • -

      +

      • +

    • When named was reconfigured, failure of some zones to load correctly could leave the system in an inconsistent state; while generally harmless, this could lead to a crash later when using rndc addzone. Reconfiguration changes are now fully rolled back in the event of failure. [RT #45841] -

      -
      • -
    • -

      +

      • +

    • Some header files included <isc/util.h> incorrectly as it pollutes with namespace with non ISC_ macros and this should only be done by explicitly including <isc/util.h>. This has been corrected. Some code may depend on <isc/util.h> being implicitly included via other header files. Such code should explicitly include <isc/util.h>. -

      -
      • -
    • -

      +

      • +

    • Zones created with rndc addzone could temporarily fail to inherit the allow-transfer ACL set in the options section of named.conf. [RT #46603] -

      -
      • -
    • -

      +

      • +

    • named failed to properly determine whether there were active KSK and ZSK keys for an algorithm when update-check-ksk was true (which is the default setting). This could leave records unsigned when rolling keys. [RT #46743] [RT #46754] [RT #46774] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.2

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • An error in TSIG handling could permit unauthorized zone transfers or zone updates. These flaws are disclosed in CVE-2017-3142 and CVE-2017-3143. [RT #45383] -

      -
      • -
    • -

      +

      • +

    • The BIND installer on Windows used an unquoted service path, which can enable privilege escalation. This flaw is disclosed in CVE-2017-3141. [RT #45229] -

      -
      • -
    • -

      +

      • +

    • With certain RPZ configurations, a response with TTL 0 could cause named to go into an infinite query loop. This flaw is disclosed in CVE-2017-3140. [RT #45181] -

      -
      • +

    -
- -
+
+

Feature Changes

-
    -
  • -

    +

      +

    • dig +ednsopt now accepts the names for EDNS options in addition to numeric values. For example, an EDNS Client-Subnet option could be sent using dig +ednsopt=ecs:.... Thanks to John Worley of Secure64 for the contribution. [RT #44461] -

      -
      • -
    • -

      +

      • +

    • Threads in named are now set to human-readable names to assist debugging on operating systems that support that. Threads will have names such as "isc-timer", "isc-sockmgr", "isc-worker0001", and so on. This will affect the reporting of subsidiary thread names in ps and top, but not the main thread. [RT #43234] -

      -
      • -
    • -

      +

      • +

    • DiG now warns about .local queries which are reserved for Multicast DNS. [RT #44783] -

      -
      • +

    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • Fixed a bug that was introduced in an earlier development release which caused multi-packet AXFR and IXFR messages to fail validation if not all packets contained TSIG records; this caused interoperability problems with some other DNS implementations. [RT #45509] -

      -
      • -
    • -

      +

      • +

    • Reloading or reconfiguring named could fail on some platforms when LMDB was in use. [RT #45203] -

      -
      • -
    • -

      +

      • +

    • Due to some incorrectly deleted code, when BIND was built with LMDB, zones that were deleted via rndc delzone were removed from the running server but were not removed from the new zone database, so that deletion did not persist after a server restart. This has been corrected. [RT #45185] -

      -
      • -
    • -

      +

      • +

    • Semicolons are no longer escaped when printing CAA and URI records. This may break applications that depend on the presence of the backslash before the semicolon. [RT #45216] -

      -
      • -
    • -

      +

      • +

    • AD could be set on truncated answer with no records present in the answer and authority sections. [RT #45140] -

      -
      • +

    -
-
-
+
+

Notes for BIND 9.11.1

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • rndc "" could trigger an assertion failure in named. This flaw is disclosed in (CVE-2017-3138). [RT #44924] -

      -
      • -
    • -

      +

      • +

    • Some chaining (i.e., type CNAME or DNAME) responses to upstream queries could trigger assertion failures. This flaw is disclosed in CVE-2017-3137. [RT #44734] -

      -
      • -
    • -

      +

      • +

    • dns64 with break-dnssec yes; can result in an assertion failure. This flaw is disclosed in CVE-2017-3136. [RT #44653] -

      -
      • -
    • -

      +

      • +

    • If a server is configured with a response policy zone (RPZ) that rewrites an answer with local data, and is also configured for DNS64 address mapping, a NULL pointer can be read triggering a server crash. This flaw is disclosed in CVE-2017-3135. [RT #44434] -

      -
      • -
    • -

      +

      • +

    • A coding error in the nxdomain-redirect feature could lead to an assertion failure if the redirection namespace was served from a local authoritative data source such as a local zone or a DLZ instead of via recursive lookup. This flaw is disclosed in CVE-2016-9778. [RT #43837] -

      -
      • -
    • -

      +

      • +

    • named could mishandle authority sections with missing RRSIGs, triggering an assertion failure. This flaw is disclosed in CVE-2016-9444. [RT #43632] -

      -
      • -
    • -

      +

      • +

    • named mishandled some responses where covering RRSIG records were returned without the requested data, resulting in an assertion failure. This flaw is disclosed in CVE-2016-9147. [RT #43548] -

      -
      • -
    • -

      +

      • +

    • named incorrectly tried to cache TKEY records which could trigger an assertion failure when there was a class mismatch. This flaw is disclosed in CVE-2016-9131. [RT #43522] -

      -
      • -
    • -

      +

      • +

    • It was possible to trigger assertions when processing responses containing answers of type DNAME. This flaw is disclosed in CVE-2016-8864. [RT #43465] -

      -
      • -
    • -

      +

      • +

    • 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] -

      -
      • +

    -
- -
+
+

Feature Changes

-
    -
  • -

    +

      +

    • dnstap now stores both the local and remote addresses for all messages, instead of only the remote address. The default output format for dnstap-read has @@ -1402,104 +1176,79 @@ address first and the responding address second, separated by "-%gt;" or "%lt;-" to indicate in which direction the message was sent. [RT #43595] -

      -
      • -
    • -

      +

      • +

    • Expanded and improved the YAML output from dnstap-read -y: it now includes packet size and a detailed breakdown of message contents. [RT #43622] [RT #43642] -

      -
      • -
    • -

      +

      • +

    • If an ACL is specified with an address prefix in which the prefix length is longer than the address portion (for example, 192.0.2.1/8), named will now log a warning. In future releases this will be a fatal configuration error. [RT #43367] -

      -
      • +

    -
- -
+
+

Bug Fixes

-
    -
  • -

    +

      +

    • A synthesized CNAME record appearing in a response before the associated DNAME could be cached, when it should not have been. This was a regression introduced while addressing CVE-2016-8864. [RT #44318] -

      -
      • -
    • -

      +

      • +

    • named could deadlock if multiple changes to NSEC/NSEC3 parameters for the same zone were being processed at the same time. [RT #42770] -

      -
      • -
    • -

      +

      • +

    • named could trigger an assertion when sending NOTIFY messages. [RT #44019] -

      -
      • -
    • -

      +

      • +

    • Referencing a nonexistent zone in a response-policy statement could cause an assertion failure during configuration. [RT #43787] -

      -
      • -
    • -

      +

      • +

    • rndc addzone could cause a crash when attempting to add a zone with a type other than master or slave. Such zones are now rejected. [RT #43665] -

      -
      • -
    • -

      +

      • +

    • named could hang when encountering log file names with large apparent gaps in version number (for example, when files exist called "logfile.0", "logfile.1", and "logfile.1482954169"). This is now handled correctly. [RT #38688] -

      -
      • -
    • -

      +

      • +

    • If a zone was updated while named was processing a query for nonexistent data, it could return out-of-sync NSEC3 records causing potential DNSSEC validation failure. [RT #43247] -

      -
      • +

    -
- -
+
+

Maintenance

-
  • -

    +

    • The built-in root hints have been updated to include an IPv6 address (2001:500:12::d0d) for G.ROOT-SERVERS.NET. -

      -
    -
- -
+

+
+

Miscellaneous Notes

-
  • -

    +

    • Authoritative server support for the EDNS Client Subnet option (ECS), introduced in BIND 9.11.0, was based on an early version of the specification, and is now known to have incompatibilities @@ -1509,51 +1258,43 @@ testing purposes but is not recommended for for production use. This was not made sufficiently clear in the documentation at the time of release. -

      -
    -
- +

-
+
+

Notes for BIND 9.11.0

- -
+

Security Fixes

-
    -
  • -

    +

      +

    • 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] -

      -
      • +

    -
- -
+
+

New Features

-
    +
    • -

      +

      A new method of provisioning secondary servers called "Catalog Zones" has been added. This is an implementation of draft-muks-dnsop-dns-catalog-zones/ .

      -

      +

      A catalog zone is a regular DNS zone which contains a list of "member zones", along with the configuration options for each of those zones. When a server is configured to use a @@ -1566,32 +1307,30 @@ propagated to slaves using the standard AXFR/IXFR update mechanism.

      -

      +

      This feature should be considered experimental. It currently supports only basic features; more advanced features such as ACLs and TSIG keys are not yet supported. Example catalog zone configurations can be found in the Chapter 9 of the BIND Administrator Reference Manual.

      -

      +

      Support for master entries with TSIG keys has been added to catalog zones, as well as support for allow-query and allow-transfer.

      -
      • -
    • -

      +

      • +

    • Added an isc.rndc Python module, which allows rndc commands to be sent from Python programs. -

      -
      • +

    • -

      +

      Added support for DynDB, a new interface for loading zone data from an external database, developed by Red Hat for the FreeIPA project. (Thanks in particular to Adam Tkac and Petr Spacek of Red Hat for the contribution.)

      -

      +

      Unlike the existing DLZ and SDB interfaces, which provide a limited subset of database functionality within BIND - translating DNS queries into real-time database lookups with @@ -1599,22 +1338,22 @@ DNSSEC-signed data - DynDB is able to fully implement and extend the database API used natively by BIND.

      -

      +

      A DynDB module could pre-load data from an external data source, then serve it with the same performance and functionality as conventional BIND zones, and with the ability to take advantage of database features not available in BIND, such as multi-master replication.

      -
      • +
    • -

      +

      Fetch quotas are now compiled in by default: they no longer require BIND to be configured with --enable-fetchlimit, as was the case when the feature was introduced in BIND 9.10.3.

      -

      +

      These quotas limit the queries that are sent by recursive resolvers to authoritative servers experiencing denial-of-service attacks. They can both reduce the harm done to authoritative @@ -1622,9 +1361,8 @@ experienced by recursive servers when they are being used as a vehicle for such an attack.

      -
        -
      • -

        +

          +

        • fetches-per-server limits the number of simultaneous queries that can be sent to any single authoritative server. The configured value is a starting @@ -1632,41 +1370,38 @@ partially or completely non-responsive. The algorithm used to adjust the quota can be configured via the fetch-quota-params option. -

          -
          • -
        • -

          +

          • +

        • fetches-per-zone limits the number of simultaneous queries that can be sent for names within a single domain. (Note: Unlike "fetches-per-server", this value is not self-tuning.) -

          -
          • +

        -

        +

        Statistics counters have also been added to track the number of queries affected by these quotas.

        -
        • +
      • -

        +

        Added support for dnstap, a fast, flexible method for capturing and logging DNS traffic, developed by Robert Edmonds at Farsight Security, Inc., whose assistance is gratefully acknowledged.

        -

        +

        To enable dnstap at compile time, the fstrm and protobuf-c libraries must be available, and BIND must be configured with --enable-dnstap.

        -

        +

        A new utility dnstap-read has been added to allow dnstap data to be presented in a human-readable format.

        -

        +

        rndc dnstap -roll causes dnstap output files to be rolled like log files -- the most recent output file is renamed with a .0 suffix, the next @@ -1676,18 +1411,18 @@ argument specifies how many backup log files to retain; if not specified or set to 0, there is no limit.

        -

        +

        rndc dnstap -reopen simply closes and reopens the dnstap output channel without renaming the output file.

        -

        +

        For more information on dnstap, see https://dnstap.info.

        -
        • +
      • -

        +

        New statistics counters have been added to track traffic sizes, as specified in RSSAC002. Query and response message sizes are broken up into ranges of histogram buckets: @@ -1699,13 +1434,13 @@ or http://localhost:8888/json/v1/traffic.

        -

        +

        Statistics for RSSAC02v3 traffic-volume, traffic-sizes and rcode-volume reporting are now collected.

        -
        • +
      • -

        +

        A new DNSSEC key management utility, dnssec-keymgr, has been added. This tool is meant to run unattended (e.g., under cron). @@ -1719,25 +1454,24 @@ the configured policy changes, keys are corrected automatically. See the dnssec-keymgr man page for full details.

        -

        +

        Note: dnssec-keymgr depends on Python and on the Python lex/yacc module, PLY. The other Python-based tools, dnssec-coverage and dnssec-checkds, have been refactored and updated as part of this work.

        -

        +

        dnssec-keymgr now takes a -r randomfile option.

        -

        +

        (Many thanks to Sebastián Castro for his assistance in developing this tool at the IETF 95 Hackathon in Buenos Aires, April 2016.)

        -
        • -
      • -

        +

        • +

      • The serial number of a dynamically updatable zone can now be set using rndc signing -serial number zonename. @@ -1745,10 +1479,8 @@ zones that have been reset. Setting the serial number to a value larger than that on the slaves will trigger an AXFR-style transfer. -

        -
        • -
      • -

        +

        • +

      • When answering recursive queries, SERVFAIL responses can now be cached by the server for a limited time; subsequent queries for the same query name and type will return another SERVFAIL until @@ -1757,10 +1489,8 @@ on recursive servers. The SERVFAIL cache timeout is controlled by servfail-ttl, which defaults to 1 second and has an upper limit of 30. -

        -
        • -
      • -

        +

        • +

      • The new rndc nta command can now be used to set a "negative trust anchor" (NTA), disabling DNSSEC validation for a specific domain; this can be used when responses from a domain @@ -1772,112 +1502,80 @@ named.conf. When added, NTAs are stored in a file (viewname.nta) in order to persist across restarts of the named server. -

        -
        • -
      • -

        +

        • +

      • The EDNS Client Subnet (ECS) option is now supported for authoritative servers; if a query contains an ECS option then ACLs containing geoip or ecs elements can match against the address encoded in the option. This can be used to select a view for a query, so that different answers can be provided depending on the client network. -

        -
        • -
      • -

        +

        • +

      • The EDNS EXPIRE option has been implemented on the client side, allowing a slave server to set the expiration timer correctly when transferring zone data from another slave server. -

        -
        • -
      • -

        +

        • +

      • A new masterfile-style zone option controls the formatting of text zone files: When set to full, the zone file will dumped in single-line-per-record format. -

        -
        • -
      • -

        +

        • +

      • dig +ednsopt can now be used to set arbitrary EDNS options in DNS requests. -

        -
        • -
      • -

        +

        • +

      • dig +ednsflags can now be used to set yet-to-be-defined EDNS flags in DNS requests. -

        -
        • -
      • -

        +

        • +

      • dig +[no]ednsnegotiation can now be used enable / disable EDNS version negotiation. -

        -
        • -
      • -

        +

        • +

      • dig +header-only can now be used to send queries without a question section. -

        -
        • -
      • -

        +

        • +

      • dig +ttlunits causes dig to print TTL values with time-unit suffixes: w, d, h, m, s for weeks, days, hours, minutes, and seconds. -

        -
        • -
      • -

        +

        • +

      • dig +zflag can be used to set the last unassigned DNS header flag bit. This bit is normally zero. -

        -
        • -
      • -

        +

        • +

      • dig +dscp=value can now be used to set the DSCP code point in outgoing query packets. -

        -
        • -
      • -

        +

        • +

      • dig +mapped can now be used to determine if mapped IPv4 addresses can be used. -

        -
        • -
      • -

        +

        • +

      • nslookup will now look up IPv6 as well as IPv4 addresses by default. [RT #40420] -

        -
        • -
      • -

        +

        • +

      • serial-update-method can now be set to date. On update, the serial number will be set to the current date in YYYYMMDDNN format. -

        -
        • -
      • -

        +

        • +

      • dnssec-signzone -N date also sets the serial number to YYYYMMDDNN. -

        -
        • -
      • -

        +

        • +

      • named -L filename causes named to send log messages to the specified file by default instead of to the system log. -

        -
        • -
      • -

        +

        • +

      • The rate limiter configured by the serial-query-rate option no longer covers NOTIFY messages; those are now separately controlled by @@ -1885,31 +1583,23 @@ startup-notify-rate (the latter of which controls the rate of NOTIFY messages sent when the server is first started up or reconfigured). -

        -
        • -
      • -

        +

        • +

      • The default number of tasks and client objects available for serving lightweight resolver queries have been increased, and are now configurable via the new lwres-tasks and lwres-clients options in named.conf. [RT #35857] -

        -
        • -
      • -

        +

        • +

      • Log output to files can now be buffered by specifying buffered yes; when creating a channel. -

        -
        • -
      • -

        +

        • +

      • delv +tcp will exclusively use TCP when sending queries. -

        -
        • -
      • -

        +

        • +

      • named will now check to see whether other name server processes are running before starting up. This is implemented in two ways: 1) by refusing to start @@ -1921,10 +1611,8 @@ /var/run/named/named.lock. Specifying none will disable the lock file check. -

        -
        • -
      • -

        +

        • +

      • rndc delzone can now be applied to zones which were configured in named.conf; it is no longer restricted to zones which were added by @@ -1932,22 +1620,17 @@ this does not edit named.conf; the zone must be removed from the configuration or it will return when named is restarted or reloaded.) -

        -
        • -
      • -

        +

        • +

      • rndc modzone can be used to reconfigure a zone, using similar syntax to rndc addzone. -

        -
        • -
      • -

        +

        • +

      • rndc showzone displays the current configuration for a specified zone. -

        -
        • +

      • -

        +

        When BIND is built with the lmdb library (Lightning Memory-Mapped Database), named will store the configuration information for zones @@ -1959,70 +1642,61 @@ the contents of a database is much faster than rewriting a text file.

        -

        +

        On startup, if named finds an existing NZF file, it will automatically convert it to the new NZD database format.

        -

        +

        To view the contents of an NZD, or to convert an NZD back to an NZF file (for example, to revert back to an earlier version of BIND which did not support the NZD format), use the new command named-nzd2nzf [RT #39837]

        -
        • +
      • -

        +

        Added server-side support for pipelined TCP queries. Clients may continue sending queries via TCP while previous queries are processed in parallel. Responses are sent when they are ready, not necessarily in the order in which the queries were received.

        -

        +

        To revert to the former behavior for a particular client address or range of addresses, specify the address prefix in the "keep-response-order" option. To revert to the former behavior for all clients, use "keep-response-order { any; };".

        -
        • -
      • -

        +

        • +

      • The new mdig command is a version of dig that sends multiple pipelined queries and then waits for responses, instead of sending one query and waiting the response before sending the next. [RT #38261] -

        -
        • -
      • -

        +

        • +

      • To enable better monitoring and troubleshooting of RFC 5011 trust anchor management, the new rndc managed-keys can be used to check status of trust anchors or to force keys to be refreshed. Also, the managed-keys data file now has easier-to-read comments. [RT #38458] -

        -
        • -
      • -

        +

        • +

      • An --enable-querytrace configure switch is now available to enable very verbose query trace logging. This option can only be set at compile time. This option has a negative performance impact and should be used only for debugging. [RT #37520] -

        -
        • -
      • -

        +

        • +

      • A new tcp-only option can be specified in server statements to force named to connect to the specified server via TCP. [RT #37800] -

        -
        • -
      • -

        +

        • +

      • The nxdomain-redirect option specifies a DNS namespace to use for NXDOMAIN redirection. When a recursive lookup returns NXDOMAIN, a second lookup is @@ -2032,25 +1706,19 @@ queries to other servers. (The older method, using a single type redirect zone, has better average performance but is less flexible.) [RT #37989] -

        -
        • -
      • -

        +

        • +

      • The following types have been implemented: CSYNC, NINFO, RKEY, SINK, TA, TALINK. -

        -
        • -
      • -

        +

        • +

      • A new message-compression option can be used to specify whether or not to use name compression when answering queries. Setting this to no results in larger responses, but reduces CPU consumption and may improve throughput. The default is yes. -

        -
        • -
      • -

        +

        • +

      • A read-only option is now available in the controls statement to grant non-destructive control channel access. In such cases, a restricted set of @@ -2059,28 +1727,22 @@ reconfigure or stop the server. By default, the control channel access is not restricted to these read-only operations. [RT #40498] -

        -
        • -
      • -

        +

        • +

      • 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. -

        -
        • -
      • -

        +

        • +

      • The new minimal-any option reduces the size of answers to UDP queries for type ANY by implementing one of the strategies in "draft-ietf-dnsop-refuse-any": returning a single arbitrarily-selected RRset that matches the query name rather than returning all of the matching RRsets. Thanks to Tony Finch for the contribution. [RT #41615] -

        -
        • -
      • -

        +

        • +

      • named now provides feedback to the owners of zones which have trust anchors configured (trusted-keys, @@ -2090,61 +1752,50 @@ configured trust anchors for the zone. This is controlled by trust-anchor-telemetry and defaults to yes. -

        -
        • +

      -
    - -
    +
    +

    Feature Changes

    -
      +
      • -

        +

        The logging format used for querylog has been altered. It now includes an additional field indicating the address in memory of the client object processing the query.

        -

        +

        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]

        -
        • -
      • -

        +

        • +

      • The timers returned by the statistics channel (indicating current time, server boot time, and most recent reconfiguration time) are now reported with millisecond accuracy. [RT #40082] -

        -
        • -
      • -

        +

        • +

      • Updated the compiled-in addresses for H.ROOT-SERVERS.NET and L.ROOT-SERVERS.NET. -

        -
        • -
      • -

        +

        • +

      • ACLs containing geoip asnum elements were not correctly matched unless the full organization name was specified in the ACL (as in geoip asnum "AS1234 Example, Inc.";). They can now match against the AS number alone (as in geoip asnum "AS1234";). -

        -
        • -
      • -

        +

        • +

      • When using native PKCS#11 cryptography (i.e., configure --enable-native-pkcs11) HSM PINs of up to 256 characters can now be used. -

        -
        • -
      • -

        +

        • +

      • NXDOMAIN responses to queries of type DS are now cached separately from those for other types. This helps when using "grafted" zones of type forward, for which the parent zone does not contain a @@ -2154,29 +1805,21 @@ change is only helpful when DNSSEC validation is not enabled. "Grafted" zones without a delegation in the parent are not a recommended configuration.) -

        -
        • -
      • -

        +

        • +

      • Update forwarding performance has been improved by allowing a single TCP connection to be shared between multiple updates. -

        -
        • -
      • -

        +

        • +

      • By default, nsupdate will now check the correctness of hostnames when adding records of type A, AAAA, MX, SOA, NS, SRV or PTR. This behavior can be disabled with check-names no. -

        -
        • -
      • -

        +

        • +

      • Added support for OPENPGPKEY type. -

        -
        • -
      • -

        +

        • +

      • The names of the files used to store managed keys and added zones for each view are no longer based on the SHA256 hash of the view name, except when this is necessary because the @@ -2189,80 +1832,64 @@ or external.nzf). However, to ensure consistent behavior when upgrading, if a file using the old name format is found to exist, it will continue to be used. -

        -
        • -
      • -

        +

        • +

      • "rndc" can now return text output of arbitrary size to the caller. (Prior to this, certain commands such as "rndc tsig-list" and "rndc zonestatus" could return truncated output.) -

        -
        • -
      • -

        +

        • +

      • Errors reported when running rndc addzone (e.g., when a zone file cannot be loaded) have been clarified to make it easier to diagnose problems. -

        -
        • -
      • -

        +

        • +

      • When encountering an authoritative name server whose name is an alias pointing to another name, the resolver treats this as an error and skips to the next server. Previously this happened silently; now the error will be logged to the newly-created "cname" log category. -

        -
        • -
      • -

        +

        • +

      • If named is not configured to validate answers, then allow fallback to plain DNS on timeout even when we know the server supports EDNS. This will allow the server to potentially resolve signed queries when TCP is being blocked. -

        -
        • -
      • -

        +

        • +

      • Large inline-signing changes should be less disruptive. Signature generation is now done incrementally; the number of signatures to be generated in each quantum is controlled by "sig-signing-signatures number;". [RT #37927] -

        -
        • +

      • -

        +

        The experimental SIT option (code point 65001) of BIND 9.10.0 through BIND 9.10.2 has been replaced with the COOKIE option (code point 10). It is no longer experimental, and is sent by default, by both named and dig.

        -

        +

        The SIT-related named.conf options have been marked as obsolete, and are otherwise ignored.

        -
        • -
      • -

        +

        • +

      • When dig receives a truncated (TC=1) response or a BADCOOKIE response code from a server, it will automatically retry the query using the server COOKIE that was returned by the server in its initial response. [RT #39047] -

        -
        • -
      • -

        +

        • +

      • Retrieving the local port range from net.ipv4.ip_local_port_range on Linux is now supported. -

        -
        • -
      • -

        +

        • +

      • A new nsip-wait-recurse directive has been added to RPZ, specifying whether to look up unknown name server IP addresses and wait for a response before applying RPZ-NSIP rules. @@ -2273,129 +1900,102 @@ be applied on subsequent queries. This improves performance when the cache is cold, at the cost of temporary imprecision in applying policy directives. [RT #35009] -

        -
        • -
      • -

        +

        • +

      • Within the response-policy option, it is now possible to configure RPZ rewrite logging on a per-zone basis using the log clause. -

        -
        • -
      • -

        +

        • +

      • 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. -

        -
        • +

      • -

        +

        Added support for the AVC resource record type (Application Visibility and Control).

        -

        +

        Changed rndc reconfig behavior so that newly added zones are loaded asynchronously and the loading does not block the server.

        -
        • -
      • -

        +

        • +

      • minimal-responses now takes two new arguments: no-auth suppresses populating the authority section but not the additional section; no-auth-recursive does the same but only when answering recursive queries. -

        -
        • -
      • -

        +

        • +

      • At server startup time, the queues for processing notify and zone refresh queries are now processed in LIFO rather than FIFO order, to speed up loading of newly added zones. [RT #42825] -

        -
        • -
      • -

        +

        • +

      • When answering queries of type MX or SRV, TLSA records for the target name are now included in the additional section to speed up DANE processing. [RT #42894] -

        -
        • -
      • -

        +

        • +

      • named can now use the TCP Fast Open mechanism on the server side, if supported by the local operating system. [RT #42866] -

        -
        • +

      -
    - -
    +
    +

    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] -

        -
        • +

      -
    -
    - -
    +
    +

    End of Life

    -

    +

    BIND 9.11 (Extended Support Version) will be supported until at least December, 2021.

    -

    +

    See https://kb.isc.org/docs/aa-00896 for details of ISC's software support policy.

    -
    +

    Thank You

    -

    +

    Thank you to everyone who assisted us in making this release possible.

    -
    -
    +
diff --git a/doc/arm/notes.pdf b/doc/arm/notes.pdf index 5c85992218..bbf47d2fba 100644 Binary files a/doc/arm/notes.pdf and b/doc/arm/notes.pdf differ diff --git a/doc/arm/notes.txt b/doc/arm/notes.txt index a58cce4ab4..fe285728ff 100644 --- a/doc/arm/notes.txt +++ b/doc/arm/notes.txt @@ -1,4 +1,4 @@ -Release Notes for BIND Version 9.11.25 +Release Notes for BIND Version 9.11.26 Introduction @@ -36,6 +36,35 @@ Those unsure whether or not the license change affects their use of BIND, or who wish to discuss how to comply with the license may contact ISC at https://www.isc.org/mission/contact/. +Notes for BIND 9.11.26 + +Feature Changes + + • The default value of max-recursion-queries was increased from 75 to + 100. Since the queries sent towards root and TLD servers are now + included in the count (as a result of the fix for CVE-2020-8616), + max-recursion-queries has a higher chance of being exceeded by + non-attack queries, which is the main reason for increasing its + default value. [GL #2305] + + • The default value of nocookie-udp-size was restored back to 4096 + bytes. Since max-udp-size is the upper bound for nocookie-udp-size, + this change relieves the operator from having to change + nocookie-udp-size together with max-udp-size in order to increase the + default EDNS buffer size limit. nocookie-udp-size can still be set to + a value lower than max-udp-size, if desired. [GL #2250] + +Bug Fixes + + • Handling of missing DNS COOKIE responses over UDP was tightened by + falling back to TCP. [GL #2275] + + • The CNAME synthesized from a DNAME was incorrectly followed when the + QTYPE was CNAME or ANY. [GL #2280] + + • Building with native PKCS#11 support for AEP Keyper has been broken + since BIND 9.11.22. This has been fixed. [GL #2315] + Notes for BIND 9.11.25 Bug Fixes diff --git a/isc-config.sh.1 b/isc-config.sh.1 index 2ba409861a..65b0ef80b0 100644 --- a/isc-config.sh.1 +++ b/isc-config.sh.1 @@ -35,22 +35,16 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" isc-config.sh \- Get information about the installed version of ISC BIND - .SH "SYNOPSIS" - .HP \w'\fBisc\-config\&.sh\fR\ 'u - \fBisc\-config\&.sh\fR - [\fB\-\-cflags\fR] - [\fB\-\-exec\-prefix\fR] - [\fB\-\-libs\fR] - [\fB\-\-prefix\fR] - [\fB\-\-version\fR] - [libraries...] - .SH "DESCRIPTION" - .PP +.SH "SYNOPSIS" +.HP \w'\fBisc\-config\&.sh\fR\ 'u +\fBisc\-config\&.sh\fR [\fB\-\-cflags\fR] [\fB\-\-exec\-prefix\fR] [\fB\-\-libs\fR] [\fB\-\-prefix\fR] [\fB\-\-version\fR] [libraries...] +.SH "DESCRIPTION" +.PP \fBisc\-config\&.sh\fR 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\&. - .PP +.PP The optional libraries are used to report specific details for compiling and linking for the listed libraries\&. The allowed choices are: \fBisc\fR, \fBisccc\fR, @@ -58,38 +52,38 @@ The optional libraries are used to report specific details for compiling and lin \fBdns\fR, \fBlwres\fR, and \fBbind9\fR\&. Multiple libraries may be listed on the command line\&. (Some libraries require other libraries, so are implied\&.) - .SH "OPTIONS" - .PP +.SH "OPTIONS" +.PP \-\-cflags .RS 4 - Prints the compiler command line options required to compile files that use ISC BIND\&. Use the +Prints the compiler command line options required to compile files that use ISC BIND\&. Use the \fBlibraries\fR command line argument(s) to print additional specific flags to pass to the C compiler\&. - .RE - .PP +.RE +.PP \-\-exec\-prefix .RS 4 - Prints the directory prefix used in the ISC BIND installation for architecture dependent files to standard output\&. - .RE - .PP +Prints the directory prefix used in the ISC BIND installation for architecture dependent files to standard output\&. +.RE +.PP \-\-libs .RS 4 - Prints the linker command line options used to link with the ISC BIND libraries\&. Use the +Prints the linker command line options used to link with the ISC BIND libraries\&. Use the \fBlibraries\fR command line argument(s) to print additional specific flags\&. - .RE - .PP +.RE +.PP \-\-prefix .RS 4 - Prints the directory prefix used in the ISC BIND installation for architecture independent files to standard output\&. - .RE - .PP +Prints the directory prefix used in the ISC BIND installation for architecture independent files to standard output\&. +.RE +.PP \-\-version .RS 4 - Prints the version of the installed ISC BIND suite\&. - .RE - .SH "RETURN VALUES" - .PP +Prints the version of the installed ISC BIND suite\&. +.RE +.SH "RETURN VALUES" +.PP \fBisc\-config\&.sh\fR returns an exit status of 1 if invoked with invalid arguments or no arguments at all\&. It returns 0 if information was successfully printed\&. .SH "AUTHOR" diff --git a/isc-config.sh.html b/isc-config.sh.html index 9e90a3c752..8aba628c46 100644 --- a/isc-config.sh.html +++ b/isc-config.sh.html @@ -14,43 +14,22 @@
- - - - - - - -
+

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: @@ -63,65 +42,47 @@ 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/dns/api b/lib/dns/api index 7b0e1993ca..5a49714773 100644 --- a/lib/dns/api +++ b/lib/dns/api @@ -9,5 +9,5 @@ # 9.11: 160-169,1100-1199 # 9.12: 1200-1299 LIBINTERFACE = 1112 -LIBREVISION = 1 +LIBREVISION = 2 LIBAGE = 0 diff --git a/lib/isc/api b/lib/isc/api index 6f2b35e113..f3271f1919 100644 --- a/lib/isc/api +++ b/lib/isc/api @@ -9,5 +9,5 @@ # 9.11: 160-169,1100-1199 # 9.12: 1200-1299 LIBINTERFACE = 1107 -LIBREVISION = 3 +LIBREVISION = 4 LIBAGE = 0 diff --git a/lib/lwres/man/lwres.3 b/lib/lwres/man/lwres.3 index 517a6433a0..12e1441fbb 100644 --- a/lib/lwres/man/lwres.3 +++ b/lib/lwres/man/lwres.3 @@ -35,23 +35,22 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres \- introduction to the lightweight resolver library - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP 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 transmitting lookup requests to a resolver daemon \fBlwresd\fR running on the local host\&. The resolver daemon performs the lookup using the DNS or possibly other name service protocols, and returns the results to the application through the library\&. The library and resolver daemon communicate using a simple UDP\-based protocol\&. - .SH "OVERVIEW" - .PP +.SH "OVERVIEW" +.PP The lwresd library implements multiple name service APIs\&. The standard \fBgethostbyname()\fR, \fBgethostbyaddr()\fR, @@ -66,61 +65,61 @@ lwres_\&. To define the standard names, applications must include the header fil which contains macro definitions mapping the standard function names into lwres_ prefixed ones\&. Operating system vendors who integrate the lwres library into their base distributions should rename the functions in the library proper so that the renaming macros are not needed\&. - .PP +.PP The library also provides a native API consisting of the functions \fBlwres_getaddrsbyname()\fR and \fBlwres_getnamebyaddr()\fR\&. These may be called by applications that require more detailed control over the lookup process than the standard functions provide\&. - .PP +.PP 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 \fBlwres_getaddrsbyname()\fR function\&. - .PP +.PP 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, and is also used when implementing the server side of the lwres protocol, for example in the \fBlwresd\fR resolver daemon\&. The use of this low\-level API in clients and servers is outlined in the following sections\&. - .SH "CLIENT\-SIDE LOW\-LEVEL API CALL FLOW" - .PP +.SH "CLIENT\-SIDE LOW\-LEVEL API CALL FLOW" +.PP When a client program wishes to make an lwres request using the native low\-level API, it typically performs the following sequence of actions\&. - .PP +.PP (1) Allocate or use an existing \fBlwres_packet_t\fR, called \fIpkt\fR below\&. - .PP +.PP (2) Set \fIpkt\&.recvlength\fR 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: \fBLWRES_RECVLENGTH = 4096\fR\&. - .PP +.PP (3) Set \fIpkt\&.serial\fR to a unique serial number\&. This value is echoed back to the application by the remote server\&. - .PP +.PP (4) Set \fIpkt\&.pktflags\fR\&. Usually this is set to 0\&. - .PP +.PP (5) Set \fIpkt\&.result\fR to 0\&. - .PP +.PP (6) Call \fBlwres_*request_render()\fR, or marshall in the data using the primitives such as \fBlwres_packet_render()\fR and storing the packet data\&. - .PP +.PP (7) Transmit the resulting buffer\&. - .PP +.PP (8) Call \fBlwres_*response_parse()\fR to parse any packets received\&. - .PP +.PP (9) Verify that the opcode and serial match a request, and process the packet specific information contained in the body\&. - .SH "SERVER\-SIDE LOW\-LEVEL API CALL FLOW" - .PP +.SH "SERVER\-SIDE LOW\-LEVEL API CALL FLOW" +.PP 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\&. - .PP +.PP Note that the same \fBlwres_packet_t\fR is used in both the @@ -128,7 +127,7 @@ is used in both the and \fB_render()\fR calls, with only a few modifications made to the packet header\*(Aqs contents between uses\&. This method is recommended as it keeps the serial, opcode, and other fields correct\&. - .PP +.PP (1) When a packet is received, call \fBlwres_*request_parse()\fR to unmarshall it\&. This returns a @@ -136,9 +135,9 @@ to unmarshall it\&. This returns a (also called \fIpkt\fR, below) as well as a data specific type, such as \fBlwres_gabnrequest_t\fR\&. - .PP +.PP (2) Process the request in the data specific type\&. - .PP +.PP (3) Set the \fIpkt\&.result\fR, \fIpkt\&.recvlength\fR @@ -150,14 +149,14 @@ call above\&. If using will be set up properly\&. Otherwise, the \fBLWRES_LWPACKETFLAG_RESPONSE\fR bit should be set\&. - .PP +.PP (4) Call the data specific rendering function, such as \fBlwres_gabnresponse_render()\fR\&. - .PP +.PP (5) Send the resulting packet to the client\&. - .PP - .SH "SEE ALSO" - .PP +.PP +.SH "SEE ALSO" +.PP \fBlwres_gethostent\fR(3), \fBlwres_getipnode\fR(3), \fBlwres_getnameinfo\fR(3), diff --git a/lib/lwres/man/lwres.html b/lib/lwres/man/lwres.html index cc69060830..f7428dd5d9 100644 --- a/lib/lwres/man/lwres.html +++ b/lib/lwres/man/lwres.html @@ -14,31 +14,17 @@
- - - - -
+

Name

-

- lwres - — introduction to the lightweight resolver library -

+

lwres — introduction to the lightweight resolver library

- - - -
+

Synopsis

-
-
#include <lwres/lwres.h>
+
#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 @@ -50,12 +36,10 @@ The library and resolver daemon communicate using a simple UDP-based protocol.

-
- -
+
+

OVERVIEW

- -

+

The lwresd library implements multiple name service APIs. The standard gethostbyname(), @@ -80,7 +64,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 @@ -89,14 +73,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, @@ -106,65 +90,63 @@ 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 @@ -172,15 +154,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 @@ -190,59 +172,38 @@ 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_gethostent(3) - , + lwres_getipnode(3), - - lwres_getipnode(3) - , + lwres_getnameinfo(3), - - lwres_getnameinfo(3) - , + lwres_noop(3), - - lwres_noop(3) - , + lwres_gabn(3), - - lwres_gabn(3) - , + lwres_gnba(3), - - lwres_gnba(3) - , + lwres_context(3), - - lwres_context(3) - , + lwres_config(3), - - lwres_config(3) - , + resolver(5), - - resolver(5) - , - - - lwresd(8) - . + lwresd(8).

-
+
diff --git a/lib/lwres/man/lwres_buffer.3 b/lib/lwres/man/lwres_buffer.3 index 8473c46818..c7a001274f 100644 --- a/lib/lwres/man/lwres_buffer.3 +++ b/lib/lwres/man/lwres_buffer.3 @@ -35,16 +35,15 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "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 - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'void\ lwres_buffer_init('u .BI "void lwres_buffer_init(lwres_buffer_t\ *" "b" ", void\ *" "base" ", unsigned\ int\ " "length" ");" .HP \w'void\ lwres_buffer_invalidate('u @@ -77,18 +76,18 @@ lwres_buffer_init, lwres_buffer_invalidate, lwres_buffer_add, lwres_buffer_subtr .BI "void lwres_buffer_putmem(lwres_buffer_t\ *" "b" ", const\ unsigned\ char\ *" "base" ", unsigned\ int\ " "length" ");" .HP \w'void\ lwres_buffer_getmem('u .BI "void lwres_buffer_getmem(lwres_buffer_t\ *" "b" ", unsigned\ char\ *" "base" ", unsigned\ int\ " "length" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP 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\&. - .PP +.PP A buffer is a region of memory, together with a set of related subregions\&. The \fIused region\fR and the \fIavailable\fR region are disjoint, and their union is the buffer\*(Aqs region\&. The used region extends from the beginning of the buffer region to the last used byte\&. The available region extends from one byte greater than the last used byte to the end of the buffer\*(Aqs region\&. The size of the used region can be changed using various buffer commands\&. Initially, the used region is empty\&. - .PP +.PP The used region is further subdivided into two disjoint regions: the \fIconsumed region\fR and the @@ -97,11 +96,11 @@ and the offset (if any)\&. The \fIremaining\fR region the current pointer to the end of the used region\&. The size of the consumed region can be changed using various buffer commands\&. Initially, the consumed region is empty\&. - .PP +.PP The \fIactive region\fR is an (optional) subregion of the remaining region\&. It extends from the current offset to an offset in the remaining region\&. Initially, the active region is empty\&. If the current offset advances beyond the chosen offset, the active region will also be empty\&. - .PP +.PP .if n \{\ .RS 4 .\} @@ -116,8 +115,7 @@ is an (optional) subregion of the remaining region\&. It extends from the curren .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -131,8 +129,7 @@ is an (optional) subregion of the remaining region\&. It extends from the curren .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -146,8 +143,7 @@ is an (optional) subregion of the remaining region\&. It extends from the curren .if n \{\ .RE .\} -.sp - .PP +.PP \fBlwres_buffer_init()\fR initializes the \fBlwres_buffer_t\fR @@ -156,12 +152,12 @@ and associates it with the memory region of size \fIlength\fR bytes starting at location \fIbase\&.\fR - .PP +.PP \fBlwres_buffer_invalidate()\fR marks the buffer \fI*b\fR as invalid\&. Invalidating a buffer after use is not required, but makes it possible to catch its possible accidental use\&. - .PP +.PP The functions \fBlwres_buffer_add()\fR and @@ -176,7 +172,7 @@ checks for buffer overflow and \fBlwres_buffer_subtract()\fR checks for underflow\&. These functions do not allocate or deallocate memory\&. They just change the value of \fIused\fR\&. - .PP +.PP A buffer is re\-initialised by \fBlwres_buffer_clear()\fR\&. The function sets \fIused\fR, @@ -184,14 +180,14 @@ A buffer is re\-initialised by and \fIactive\fR to zero\&. - .PP +.PP \fBlwres_buffer_first\fR makes the consumed region of buffer \fI*p\fR empty by setting \fIcurrent\fR to zero (the start of the buffer)\&. - .PP +.PP \fBlwres_buffer_forward()\fR increases the consumed region of buffer \fI*b\fR @@ -203,7 +199,7 @@ decreases buffer \fIb\fR\*(Aqs consumed region by \fIn\fR bytes and checks for underflow\&. - .PP +.PP \fBlwres_buffer_getuint8()\fR reads an unsigned 8\-bit integer from \fI*b\fR @@ -213,7 +209,7 @@ writes the unsigned 8\-bit integer \fIval\fR to buffer \fI*b\fR\&. - .PP +.PP \fBlwres_buffer_getuint16()\fR and \fBlwres_buffer_getuint32()\fR @@ -228,7 +224,7 @@ writes the unsigned 16\-bit or 32\-bit integer \fIval\fR to buffer \fIb\fR, in network byte order\&. - .PP +.PP Arbitrary amounts of data are read or written from a lightweight resolver buffer with \fBlwres_buffer_getmem()\fR and diff --git a/lib/lwres/man/lwres_buffer.html b/lib/lwres/man/lwres_buffer.html index 18203ba5fc..323b325499 100644 --- a/lib/lwres/man/lwres_buffer.html +++ b/lib/lwres/man/lwres_buffer.html @@ -14,44 +14,16 @@
- - - - - - - -
+

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>
-
@@ -69,7 +41,6 @@ void
 
-
void @@ -90,7 +61,6 @@ void
 
-
@@ -104,7 +74,6 @@ void
 
-
void @@ -112,7 +81,6 @@ void lwres_buffer_t *b);
 
-
void @@ -120,7 +88,6 @@ void lwres_buffer_t *b);
 
-
@@ -147,7 +114,6 @@ void
 
-
uint8_t @@ -155,7 +121,6 @@ uint8_t lwres_buffer_t *b);
 
-
@@ -169,7 +134,6 @@ void
 
-
uint16_t @@ -177,7 +141,6 @@ uint16_t lwres_buffer_t *b);
 
-
@@ -191,7 +154,6 @@ void
 
-
uint32_t @@ -199,7 +161,6 @@ uint32_t lwres_buffer_t *b);
 
-
@@ -213,7 +174,6 @@ void
 
-
@@ -231,7 +191,6 @@ void
 
-
@@ -249,22 +208,18 @@ 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 @@ -278,7 +233,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. @@ -291,7 +246,7 @@ void buffer commands. Initially, the consumed region is empty.

-

+

The active region is an (optional) subregion of the remaining region. @@ -301,7 +256,7 @@ void If the current offset advances beyond the chosen offset, the active region will also be empty.

- 
+
    /------------entire length---------------\\
    /----- used region -----\\/-- available --\\
    +----------------------------------------+
@@ -311,7 +266,7 @@ void
       

 

     

-    
+
   a == base of buffer.
   b == current pointer.  Can be anywhere between a and d.
   c == active pointer.  Meaningful between b and d.
@@ -320,7 +275,7 @@ void
       

 

     

-    
+
   a-e == entire length of buffer.
   a-d == used region.
   a-b == consumed region.
@@ -329,7 +284,7 @@ void
 

 

     

-    
lwres_buffer_init()
+
lwres_buffer_init()
       initializes the
       lwres_buffer_t
       *b
@@ -338,12 +293,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
@@ -362,7 +317,7 @@ void
       They just change the value of
       used.
     

-    

+

       A buffer is re-initialised by
       lwres_buffer_clear().
       The function sets
@@ -372,14 +327,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
@@ -393,7 +348,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.
@@ -403,7 +358,7 @@ void
       to buffer
       *b.
     

-    
lwres_buffer_getuint16()
+
lwres_buffer_getuint16()
       and
       lwres_buffer_getuint32()
       are identical to
@@ -421,7 +376,7 @@ void
       b,
       in network byte order.
     

-    

+

       Arbitrary amounts of data are read or written from a lightweight
       resolver buffer with
       lwres_buffer_getmem()
@@ -444,6 +399,6 @@ void
       to
       base.
     

-
+
diff --git a/lib/lwres/man/lwres_config.3 b/lib/lwres/man/lwres_config.3 index 6652f9f43a..a20170359c 100644 --- a/lib/lwres/man/lwres_config.3 +++ b/lib/lwres/man/lwres_config.3 @@ -35,16 +35,15 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get \- lightweight resolver configuration - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'void\ lwres_conf_init('u .BI "void lwres_conf_init(lwres_context_t\ *" "ctx" ");" .HP \w'void\ lwres_conf_clear('u @@ -55,20 +54,20 @@ lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_con .BI "lwres_result_t lwres_conf_print(lwres_context_t\ *" "ctx" ", FILE\ *" "fp" ");" .HP \w'lwres_conf_t\ *\ lwres_conf_get('u .BI "lwres_conf_t * lwres_conf_get(lwres_context_t\ *" "ctx" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP \fBlwres_conf_init()\fR creates an empty \fBlwres_conf_t\fR structure for lightweight resolver context \fIctx\fR\&. - .PP +.PP \fBlwres_conf_clear()\fR frees up all the internal memory used by that \fBlwres_conf_t\fR structure in resolver context \fIctx\fR\&. - .PP +.PP \fBlwres_conf_parse()\fR opens the file \fIfilename\fR @@ -76,7 +75,7 @@ and parses it to initialise the resolver context \fIctx\fR\*(Aqs \fBlwres_conf_t\fR structure\&. - .PP +.PP \fBlwres_conf_print()\fR prints the \fBlwres_conf_t\fR @@ -85,8 +84,8 @@ structure for resolver context to the \fBFILE\fR \fIfp\fR\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP \fBlwres_conf_parse()\fR returns \fBLWRES_R_SUCCESS\fR @@ -96,18 +95,18 @@ if it successfully read and parsed if \fIfilename\fR could not be opened or contained incorrect resolver statements\&. - .PP +.PP \fBlwres_conf_print()\fR returns \fBLWRES_R_SUCCESS\fR unless an error occurred when converting the network addresses to a numeric host address string\&. If this happens, the function returns \fBLWRES_R_FAILURE\fR\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBstdio\fR(3), \fBresolver\fR(5)\&. - .SH "FILES" - .PP +.SH "FILES" +.PP /etc/resolv\&.conf .SH "AUTHOR" .PP diff --git a/lib/lwres/man/lwres_config.html b/lib/lwres/man/lwres_config.html index 1c33ae9a28..496f1bcf09 100644 --- a/lib/lwres/man/lwres_config.html +++ b/lib/lwres/man/lwres_config.html @@ -14,28 +14,13 @@
- - - - - - - -
+

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>
@@ -85,28 +70,23 @@ 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 @@ -114,8 +94,7 @@ lwres_conf_t * lwres_conf_t structure.

- -

lwres_conf_print() +

lwres_conf_print() prints the lwres_conf_t structure for resolver context @@ -124,13 +103,10 @@ lwres_conf_t * FILE fp.

-
-
+
+

RETURN VALUES

- - - -

lwres_conf_parse() +

lwres_conf_parse() returns LWRES_R_SUCCESS if it successfully read and parsed filename. @@ -139,31 +115,24 @@ 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.3 b/lib/lwres/man/lwres_context.3 index 229d02b0c4..1b5af11d0a 100644 --- a/lib/lwres/man/lwres_context.3 +++ b/lib/lwres/man/lwres_context.3 @@ -35,16 +35,15 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "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 - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'lwres_result_t\ lwres_context_create('u .BI "lwres_result_t lwres_context_create(lwres_context_t\ **" "contextp" ", void\ *" "arg" ", lwres_malloc_t\ " "malloc_function" ", lwres_free_t\ " "free_function" ");" .HP \w'lwres_result_t\ lwres_context_destroy('u @@ -59,8 +58,8 @@ lwres_context_create, lwres_context_destroy, lwres_context_nextserial, lwres_con .BI "void lwres_context_allocmem(lwres_context_t\ *" "ctx" ", size_t\ " "len" ");" .HP \w'void\ *\ lwres_context_sendrecv('u .BI "void * lwres_context_sendrecv(lwres_context_t\ *" "ctx" ", void\ *" "sendbase" ", int\ " "sendlen" ", void\ *" "recvbase" ", int\ " "recvlen" ", int\ *" "recvd_len" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP \fBlwres_context_create()\fR creates a \fBlwres_context_t\fR @@ -73,7 +72,7 @@ pointer\&. This \fBlwres_context_t\fR pointer must initially be NULL, and is modified to point to the newly created \fBlwres_context_t\fR\&. - .PP +.PP When the lightweight resolver needs to perform dynamic memory allocation, it will call \fImalloc_function\fR to allocate memory and @@ -97,18 +96,18 @@ and are NULL, \fIarg\fR is unused and should be passed as NULL\&. - .PP +.PP Once memory for the structure has been allocated, it is initialized using \fBlwres_conf_init\fR(3) and returned via \fI*contextp\fR\&. - .PP +.PP \fBlwres_context_destroy()\fR destroys a \fBlwres_context_t\fR, closing its socket\&. \fIcontextp\fR 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\&. - .PP +.PP 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 \fBlwres_context_initserial()\fR and @@ -120,7 +119,7 @@ to \fIserial\fR\&. \fBlwres_context_nextserial()\fR increments the serial number and returns the previous value\&. - .PP +.PP Memory for a lightweight resolver context is allocated and freed using \fBlwres_context_allocmem()\fR and @@ -135,7 +134,7 @@ frees \fIlen\fR bytes of space starting at location \fImem\fR\&. - .PP +.PP \fBlwres_context_sendrecv()\fR performs I/O for the context \fIctx\fR\&. Data are read and written from the context\*(Aqs socket\&. It writes data from @@ -143,8 +142,8 @@ performs I/O for the context \(em typically a lightweight resolver query packet \(em and waits for a reply which is copied to the receive buffer at \fIrecvbase\fR\&. The number of bytes that were written to this receive buffer is returned in \fI*recvd_len\fR\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP \fBlwres_context_create()\fR returns \fBLWRES_R_NOMEMORY\fR @@ -153,11 +152,11 @@ if memory for the could not be allocated, \fBLWRES_R_SUCCESS\fR otherwise\&. - .PP +.PP Successful calls to the memory allocator \fBlwres_context_allocmem()\fR return a pointer to the start of the allocated space\&. It returns NULL if memory could not be allocated\&. - .PP +.PP \fBLWRES_R_SUCCESS\fR is returned when \fBlwres_context_sendrecv()\fR @@ -168,8 +167,8 @@ is returned if an I/O error occurs and is returned if \fBlwres_context_sendrecv()\fR times out waiting for a response\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBlwres_conf_init\fR(3), \fBmalloc\fR(3), \fBfree\fR(3)\&. diff --git a/lib/lwres/man/lwres_context.html b/lib/lwres/man/lwres_context.html index d178c1113e..03239dbd20 100644 --- a/lib/lwres/man/lwres_context.html +++ b/lib/lwres/man/lwres_context.html @@ -14,29 +14,13 @@
- - - - - - - -
+

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>
@@ -146,12 +130,10 @@ 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 @@ -162,7 +144,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 @@ -173,13 +155,9 @@ 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 @@ -191,24 +169,19 @@ 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 @@ -220,8 +193,7 @@ 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 @@ -234,8 +206,7 @@ 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 @@ -245,24 +216,21 @@ 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. @@ -273,22 +241,15 @@ void * lwres_context_sendrecv() times out waiting for a response.

-
-
+
+

SEE ALSO

+

lwres_conf_init(3), -

- lwres_conf_init(3) - , + malloc(3), - - malloc(3) - , - - - free(3) - . + free(3).

-
+
diff --git a/lib/lwres/man/lwres_gabn.3 b/lib/lwres/man/lwres_gabn.3 index 7a3c5b5709..9a042255bc 100644 --- a/lib/lwres/man/lwres_gabn.3 +++ b/lib/lwres/man/lwres_gabn.3 @@ -35,16 +35,15 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_gabnrequest_render, lwres_gabnresponse_render, lwres_gabnrequest_parse, lwres_gabnresponse_parse, lwres_gabnresponse_free, lwres_gabnrequest_free \- lightweight resolver getaddrbyname message handling - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'lwres_result_t\ lwres_gabnrequest_render('u .BI "lwres_result_t lwres_gabnrequest_render(lwres_context_t\ *" "ctx" ", lwres_gabnrequest_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");" .HP \w'lwres_result_t\ lwres_gabnresponse_render('u @@ -57,19 +56,19 @@ lwres_gabnrequest_render, lwres_gabnresponse_render, lwres_gabnrequest_parse, lw .BI "void lwres_gabnresponse_free(lwres_context_t\ *" "ctx" ", lwres_gabnresponse_t\ **" "structp" ");" .HP \w'void\ lwres_gabnrequest_free('u .BI "void lwres_gabnrequest_free(lwres_context_t\ *" "ctx" ", lwres_gabnrequest_t\ **" "structp" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP These are low\-level routines for creating and parsing lightweight resolver name\-to\-address lookup request and response messages\&. - .PP +.PP There are four main functions for the getaddrbyname opcode\&. One render function converts a getaddrbyname request structure \(em \fBlwres_gabnrequest_t\fR \(em to the lightweight resolver\*(Aqs canonical format\&. It is complemented by a parse function that converts a packet in this canonical format to a getaddrbyname request structure\&. Another render function converts the getaddrbyname response structure \(em \fBlwres_gabnresponse_t\fR \(em to the canonical format\&. This is complemented by a parse function which converts a packet in canonical format to a getaddrbyname response structure\&. - .PP +.PP These structures are defined in \&. They are shown below\&. - .PP +.PP .if n \{\ .RS 4 .\} @@ -79,8 +78,7 @@ These structures are defined in .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -91,8 +89,7 @@ typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t; .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -107,8 +104,7 @@ typedef struct { .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -129,8 +125,7 @@ typedef struct { .if n \{\ .RE .\} -.sp - .PP +.PP \fBlwres_gabnrequest_render()\fR uses resolver context \fIctx\fR @@ -146,7 +141,7 @@ are then appended to the buffer in canonical format\&. performs the same task, except it converts a getaddrbyname response structure \fBlwres_gabnresponse_t\fR to the lightweight resolver\*(Aqs canonical format\&. - .PP +.PP \fBlwres_gabnrequest_parse()\fR uses context \fIctx\fR @@ -166,7 +161,7 @@ offers the same semantics as except it yields a \fBlwres_gabnresponse_t\fR structure\&. - .PP +.PP \fBlwres_gabnresponse_free()\fR and \fBlwres_gabnrequest_free()\fR @@ -178,8 +173,8 @@ or \fBlwres_gabnrequest_t\fR structures referenced via \fIstructp\fR\&. Any memory associated with ancillary buffers and strings for those structures is also discarded\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP The getaddrbyname opcode functions \fBlwres_gabnrequest_render()\fR, \fBlwres_gabnresponse_render()\fR @@ -211,8 +206,8 @@ if in the packet header structure \fBlwres_lwpacket_t\fR indicate that the packet is not a response to an earlier query\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBlwres_packet\fR(3) .SH "AUTHOR" .PP diff --git a/lib/lwres/man/lwres_gabn.html b/lib/lwres/man/lwres_gabn.html index 5b86a64da1..822f74134e 100644 --- a/lib/lwres/man/lwres_gabn.html +++ b/lib/lwres/man/lwres_gabn.html @@ -14,28 +14,13 @@
- - - - - - - -
+

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>
@@ -148,16 +133,15 @@ 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 — @@ -170,23 +154,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 {
         uint32_t  flags;
         uint32_t  addrtypes;
@@ -196,7 +180,7 @@ typedef struct {
 

 

     

-    
+
 typedef struct {
         uint32_t          flags;
         uint16_t          naliases;
@@ -212,8 +196,7 @@ 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
@@ -227,8 +210,7 @@ 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
@@ -241,8 +223,7 @@ 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
@@ -252,11 +233,10 @@ 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() @@ -291,14 +271,11 @@ 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.3 b/lib/lwres/man/lwres_gai_strerror.3 index 6aa85aca91..5091130786 100644 --- a/lib/lwres/man/lwres_gai_strerror.3 +++ b/lib/lwres/man/lwres_gai_strerror.3 @@ -35,89 +35,88 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_gai_strerror \- print suitable error string - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'char\ *\ gai_strerror('u .BI "char * gai_strerror(int\ " "ecode" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP \fBlwres_gai_strerror()\fR returns an error message corresponding to an error code returned by \fBgetaddrinfo()\fR\&. The following error codes and their meaning are defined in include/lwres/netdb\&.h\&. - .PP +.PP \fBEAI_ADDRFAMILY\fR .RS 4 - address family for hostname not supported - .RE - .PP +address family for hostname not supported +.RE +.PP \fBEAI_AGAIN\fR .RS 4 - temporary failure in name resolution - .RE - .PP +temporary failure in name resolution +.RE +.PP \fBEAI_BADFLAGS\fR .RS 4 - invalid value for +invalid value for \fBai_flags\fR - .RE - .PP +.RE +.PP \fBEAI_FAIL\fR .RS 4 - non\-recoverable failure in name resolution - .RE - .PP +non\-recoverable failure in name resolution +.RE +.PP \fBEAI_FAMILY\fR .RS 4 - \fBai_family\fR +\fBai_family\fR not supported - .RE - .PP +.RE +.PP \fBEAI_MEMORY\fR .RS 4 - memory allocation failure - .RE - .PP +memory allocation failure +.RE +.PP \fBEAI_NODATA\fR .RS 4 - no address associated with hostname - .RE - .PP +no address associated with hostname +.RE +.PP \fBEAI_NONAME\fR .RS 4 - hostname or servname not provided, or not known - .RE - .PP +hostname or servname not provided, or not known +.RE +.PP \fBEAI_SERVICE\fR .RS 4 - servname not supported for +servname not supported for \fBai_socktype\fR - .RE - .PP +.RE +.PP \fBEAI_SOCKTYPE\fR .RS 4 - \fBai_socktype\fR +\fBai_socktype\fR not supported - .RE - .PP +.RE +.PP \fBEAI_SYSTEM\fR .RS 4 - system error returned in errno - .RE - The message +system error returned in errno +.RE +The message invalid error code is returned if \fIecode\fR is out of range\&. - .PP +.PP \fBai_flags\fR, \fBai_family\fR and @@ -126,8 +125,8 @@ are elements of the \fBstruct addrinfo\fR used by \fBlwres_getaddrinfo()\fR\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBstrerror\fR(3), \fBlwres_getaddrinfo\fR(3), \fBgetaddrinfo\fR(3), diff --git a/lib/lwres/man/lwres_gai_strerror.html b/lib/lwres/man/lwres_gai_strerror.html index 1834adca67..f69fdb9c41 100644 --- a/lib/lwres/man/lwres_gai_strerror.html +++ b/lib/lwres/man/lwres_gai_strerror.html @@ -14,24 +14,13 @@
- - - - - - - -
+

Name

-

- lwres_gai_strerror - — print suitable error string -

+

lwres_gai_strerror — print suitable error string

- -
+

Synopsis

-
+
#include <lwres/netdb.h>
@@ -41,13 +30,10 @@ 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 @@ -55,77 +41,55 @@ 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 @@ -134,27 +98,17 @@ char * used by lwres_getaddrinfo().

-
- -
+
+

SEE ALSO

+

strerror(3), -

- strerror(3) - , + lwres_getaddrinfo(3), - - lwres_getaddrinfo(3) - , + getaddrinfo(3), - - getaddrinfo(3) - , - - - RFC2133 - . + RFC2133.

-
+
diff --git a/lib/lwres/man/lwres_getaddrinfo.3 b/lib/lwres/man/lwres_getaddrinfo.3 index 1d235179e4..4e5f215d51 100644 --- a/lib/lwres/man/lwres_getaddrinfo.3 +++ b/lib/lwres/man/lwres_getaddrinfo.3 @@ -35,24 +35,23 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_getaddrinfo, lwres_freeaddrinfo \- socket address structure to host and service name - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'int\ lwres_getaddrinfo('u .BI "int lwres_getaddrinfo(const\ char\ *" "hostname" ", const\ char\ *" "servname" ", const\ struct\ addrinfo\ *" "hints" ", struct\ addrinfo\ **" "res" ");" .HP \w'void\ lwres_freeaddrinfo('u .BI "void lwres_freeaddrinfo(struct\ addrinfo\ *" "ai" ");" - .PP +.PP If the operating system does not provide a \fBstruct addrinfo\fR, the following structure is used: - .PP +.PP .nf struct addrinfo { int ai_flags; /* AI_PASSIVE, AI_CANONNAME */ @@ -66,8 +65,8 @@ struct addrinfo { }; .fi .sp - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP \fBlwres_getaddrinfo()\fR is used to get a list of IP addresses and port numbers for host \fIhostname\fR @@ -85,23 +84,23 @@ is either a host name or a numeric host address string: a dotted decimal IPv4 ad \fIservname\fR is either a decimal port number or a service name as listed in /etc/services\&. - .PP +.PP \fIhints\fR is an optional pointer to a \fBstruct addrinfo\fR\&. This structure can be used to provide hints concerning the type of socket that the caller supports or wishes to use\&. The caller can supply the following structure elements in \fI*hints\fR: - .PP +.PP \fBai_family\fR .RS 4 - The protocol family that should be used\&. When +The protocol family that should be used\&. When \fBai_family\fR is set to \fBPF_UNSPEC\fR, it means the caller will accept any protocol family supported by the operating system\&. - .RE - .PP +.RE +.PP \fBai_socktype\fR .RS 4 - denotes the type of socket \(em +denotes the type of socket \(em \fBSOCK_STREAM\fR, \fBSOCK_DGRAM\fR or @@ -109,18 +108,18 @@ or \(em that is wanted\&. When \fBai_socktype\fR is zero the caller will accept any socket type\&. - .RE - .PP +.RE +.PP \fBai_protocol\fR .RS 4 - indicates which transport protocol is wanted: IPPROTO_UDP or IPPROTO_TCP\&. If +indicates which transport protocol is wanted: IPPROTO_UDP or IPPROTO_TCP\&. If \fBai_protocol\fR is zero the caller will accept any protocol\&. - .RE - .PP +.RE +.PP \fBai_flags\fR .RS 4 - Flag bits\&. If the +Flag bits\&. If the \fBAI_CANONNAME\fR bit is set, a successful call to \fBlwres_getaddrinfo()\fR @@ -139,7 +138,7 @@ for an IPv4 address or \fBIN6ADDR_ANY_INIT\fR for an IPv6 address\&. .sp - When +When \fBai_flags\fR does not set the \fBAI_PASSIVE\fR @@ -158,21 +157,21 @@ pointer and is not set in \fBai_flags\fR\&. .sp - If +If \fBai_flags\fR is set to \fBAI_NUMERICHOST\fR it indicates that \fIhostname\fR should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted\&. - .RE - .PP +.RE +.PP All other elements of the \fBstruct addrinfo\fR passed via \fIhints\fR must be zero\&. - .PP +.PP A \fIhints\fR of @@ -182,7 +181,7 @@ is treated as if the caller provided a initialized to zero with \fBai_family\fRset to \fBPF_UNSPEC\fR\&. - .PP +.PP After a successful call to \fBlwres_getaddrinfo()\fR, \fI*res\fR @@ -207,7 +206,7 @@ structure in the list, the \fBai_addr\fR member points to a filled\-in socket address structure of length \fBai_addrlen\fR\&. - .PP +.PP All of the information returned by \fBlwres_getaddrinfo()\fR is dynamically allocated: the addrinfo structures, and the socket address structures and canonical host name strings pointed to by the @@ -220,8 +219,8 @@ is a pointer to a \fBstruct addrinfo\fR created by a call to \fBlwres_getaddrinfo()\fR\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP \fBlwres_getaddrinfo()\fR returns zero on success or one of the error codes listed in \fBgai_strerror\fR(3) @@ -234,8 +233,8 @@ are \fBlwres_getaddrinfo()\fR returns \fBEAI_NONAME\fR\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBlwres\fR(3), \fBlwres_getaddrinfo\fR(3), \fBlwres_freeaddrinfo\fR(3), diff --git a/lib/lwres/man/lwres_getaddrinfo.html b/lib/lwres/man/lwres_getaddrinfo.html index c155cba79b..be21ce2143 100644 --- a/lib/lwres/man/lwres_getaddrinfo.html +++ b/lib/lwres/man/lwres_getaddrinfo.html @@ -14,24 +14,13 @@
- - - - - - - -
+

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>
@@ -62,13 +51,12 @@ 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 */
@@ -82,14 +70,10 @@ 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. @@ -106,8 +90,7 @@ 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 @@ -119,8 +102,7 @@ struct addrinfo {

ai_family
-
-

+

The protocol family that should be used. When ai_family @@ -129,11 +111,9 @@ 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 @@ -143,21 +123,18 @@ 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 @@ -175,9 +152,7 @@ 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 @@ -188,29 +163,21 @@ 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 @@ -222,7 +189,7 @@ struct addrinfo { is not set in ai_flags.

-

+

If ai_flags is set to @@ -233,25 +200,22 @@ 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 @@ -275,9 +239,7 @@ 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 @@ -285,8 +247,7 @@ 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 @@ -303,72 +264,42 @@ 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(3) - , + lwres_getaddrinfo(3), - - lwres_getaddrinfo(3) - , + lwres_freeaddrinfo(3), - - lwres_freeaddrinfo(3) - , + lwres_gai_strerror(3), - - lwres_gai_strerror(3) - , + RFC2133, - - RFC2133 - , + getservbyname(3), - - getservbyname(3) - , + bind(2), - - bind(2) - , + connect(2), - - connect(2) - , + sendto(2), - - sendto(2) - , + sendmsg(2), - - sendmsg(2) - , - - - socket(2) - . + socket(2).

- -
+
diff --git a/lib/lwres/man/lwres_gethostent.3 b/lib/lwres/man/lwres_gethostent.3 index 87a421a7d5..594e387c7a 100644 --- a/lib/lwres/man/lwres_gethostent.3 +++ b/lib/lwres/man/lwres_gethostent.3 @@ -35,16 +35,15 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "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 - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'struct\ hostent\ *\ lwres_gethostbyname('u .BI "struct hostent * lwres_gethostbyname(const\ char\ *" "name" ");" .HP \w'struct\ hostent\ *\ lwres_gethostbyname2('u @@ -67,15 +66,15 @@ lwres_gethostbyname, lwres_gethostbyname2, lwres_gethostbyaddr, lwres_gethostent .BI "void lwres_sethostent_r(int\ " "stayopen" ");" .HP \w'void\ lwres_endhostent_r('u .BI "void lwres_endhostent_r(void);" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP These functions provide hostname\-to\-address and address\-to\-hostname lookups by means of the lightweight resolver\&. They are similar to the standard \fBgethostent\fR(3) functions provided by most operating systems\&. They use a \fBstruct hostent\fR which is usually defined in \&. - .PP +.PP .if n \{\ .RS 4 .\} @@ -92,45 +91,44 @@ struct hostent { .if n \{\ .RE .\} -.sp - .PP +.PP The members of this structure are: - .PP +.PP \fBh_name\fR .RS 4 - The official (canonical) name of the host\&. - .RE - .PP +The official (canonical) name of the host\&. +.RE +.PP \fBh_aliases\fR .RS 4 - A NULL\-terminated array of alternate names (nicknames) for the host\&. - .RE - .PP +A NULL\-terminated array of alternate names (nicknames) for the host\&. +.RE +.PP \fBh_addrtype\fR .RS 4 - The type of address being returned \(em +The type of address being returned \(em \fBPF_INET\fR or \fBPF_INET6\fR\&. - .RE - .PP +.RE +.PP \fBh_length\fR .RS 4 - The length of the address in bytes\&. - .RE - .PP +The length of the address in bytes\&. +.RE +.PP \fBh_addr_list\fR .RS 4 - A +A \fBNULL\fR terminated array of network addresses for the host\&. Host addresses are returned in network byte order\&. - .RE - .PP +.RE +.PP For backward compatibility with very old software, \fBh_addr\fR is the first address in \fBh_addr_list\&.\fR - .PP +.PP \fBlwres_gethostent()\fR, \fBlwres_sethostent()\fR, \fBlwres_endhostent()\fR, @@ -141,7 +139,7 @@ and provide iteration over the known host entries on systems that provide such functionality through facilities like /etc/hosts or NIS\&. The lightweight resolver does not currently implement these functions; it only provides them as stub functions that always return failure\&. - .PP +.PP \fBlwres_gethostbyname()\fR and \fBlwres_gethostbyname2()\fR @@ -163,7 +161,7 @@ is returned if the lookups by or \fBlwres_gethostbyname2()\fR fail\&. - .PP +.PP Reverse lookups of addresses are performed by \fBlwres_gethostbyaddr()\fR\&. \fIaddr\fR @@ -199,7 +197,7 @@ return \fIresbuf\fR, which is a pointer to the \fBstruct hostent\fR it created\&. - .PP +.PP \fBlwres_gethostbyaddr_r()\fR is a thread\-safe function that performs a reverse lookup of address \fIaddr\fR @@ -234,8 +232,8 @@ return \fIresbuf\fR, which is a pointer to the \fBstruct hostent()\fR it created\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP The functions \fBlwres_gethostbyname()\fR, \fBlwres_gethostbyname2()\fR, @@ -245,36 +243,36 @@ return NULL to indicate an error\&. In this case the global variable \fBlwres_h_errno\fR will contain one of the following error codes defined in : - .PP +.PP \fBHOST_NOT_FOUND\fR .RS 4 - The host or address was not found\&. - .RE - .PP +The host or address was not found\&. +.RE +.PP \fBTRY_AGAIN\fR .RS 4 - A recoverable error occurred, e\&.g\&., a timeout\&. Retrying the lookup may succeed\&. - .RE - .PP +A recoverable error occurred, e\&.g\&., a timeout\&. Retrying the lookup may succeed\&. +.RE +.PP \fBNO_RECOVERY\fR .RS 4 - A non\-recoverable error occurred\&. - .RE - .PP +A non\-recoverable error occurred\&. +.RE +.PP \fBNO_DATA\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fBlwres_hstrerror\fR(3) translates these error codes to suitable error messages\&. - .PP +.PP \fBlwres_gethostent()\fR and \fBlwres_gethostent_r()\fR always return \fBNULL\fR\&. - .PP +.PP Successful calls to \fBlwres_gethostbyname_r()\fR and @@ -301,13 +299,13 @@ set the global variable \fBerrno\fR to \fBERANGE\fR\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBgethostent\fR(3), \fBlwres_getipnode\fR(3), \fBlwres_hstrerror\fR(3) - .SH "BUGS" - .PP +.SH "BUGS" +.PP \fBlwres_gethostbyname()\fR, \fBlwres_gethostbyname2()\fR, \fBlwres_gethostbyaddr()\fR @@ -317,7 +315,7 @@ are not thread safe; they return pointers to static data and provide error codes \fBlwres_gethostbyname_r()\fR, and \fBlwres_gethostbyaddr_r()\fR respectively\&. - .PP +.PP The resolver daemon does not currently support any non\-DNS name services such as /etc/hosts or diff --git a/lib/lwres/man/lwres_gethostent.html b/lib/lwres/man/lwres_gethostent.html index 25dae0277f..efb3637f31 100644 --- a/lib/lwres/man/lwres_gethostent.html +++ b/lib/lwres/man/lwres_gethostent.html @@ -14,33 +14,13 @@
- - - - - - - -
+

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>
@@ -194,25 +174,21 @@ 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 */
@@ -224,56 +200,46 @@ 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(),
@@ -287,8 +253,7 @@ 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
@@ -302,8 +267,7 @@ struct  hostent {
       lwres_gethostbyname() or
       lwres_gethostbyname2() fail.
     

-
-    

+

       Reverse lookups of addresses are performed by
       lwres_gethostbyaddr().
       addr is an address of length
@@ -326,8 +290,7 @@ 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
@@ -349,13 +312,10 @@ struct  hostent {
       resbuf, which is a pointer to the
       struct hostent() it created.
     

-
-
- -
+
+

RETURN VALUES

- -

+

The functions lwres_gethostbyname(), lwres_gethostbyname2(), @@ -370,50 +330,37 @@ 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 @@ -429,29 +376,19 @@ struct hostent { variable errno to ERANGE.

- -
-
+
+

SEE ALSO

+

gethostent(3), -

- gethostent(3) - , + lwres_getipnode(3), - - lwres_getipnode(3) - , - - - lwres_hstrerror(3) - + lwres_hstrerror(3)

-
- -
+
+

BUGS

- -

lwres_gethostbyname(), +

lwres_gethostbyname(), lwres_gethostbyname2(), lwres_gethostbyaddr() and @@ -464,7 +401,7 @@ struct hostent { lwres_gethostbyaddr_r() respectively.

-

+

The resolver daemon does not currently support any non-DNS name services such as /etc/hosts @@ -472,6 +409,6 @@ struct hostent { NIS, consequently the above functions don't, either.

-
+
diff --git a/lib/lwres/man/lwres_getipnode.3 b/lib/lwres/man/lwres_getipnode.3 index f7d1fc0d0d..8ce4876efb 100644 --- a/lib/lwres/man/lwres_getipnode.3 +++ b/lib/lwres/man/lwres_getipnode.3 @@ -35,31 +35,30 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_getipnodebyname, lwres_getipnodebyaddr, lwres_freehostent \- lightweight resolver nodename / address translation API - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'struct\ hostent\ *\ lwres_getipnodebyname('u .BI "struct hostent * lwres_getipnodebyname(const\ char\ *" "name" ", int\ " "af" ", int\ " "flags" ", int\ *" "error_num" ");" .HP \w'struct\ hostent\ *\ lwres_getipnodebyaddr('u .BI "struct hostent * lwres_getipnodebyaddr(const\ void\ *" "src" ", size_t\ " "len" ", int\ " "af" ", int\ *" "error_num" ");" .HP \w'void\ lwres_freehostent('u .BI "void lwres_freehostent(struct\ hostent\ *" "he" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP These functions perform thread safe, protocol independent nodename\-to\-address and address\-to\-nodename translation as defined in RFC2553\&. - .PP +.PP They use a \fBstruct hostent\fR which is defined in namedb\&.h: - .PP +.PP .if n \{\ .RS 4 .\} @@ -76,40 +75,39 @@ struct hostent { .if n \{\ .RE .\} -.sp - .PP +.PP The members of this structure are: - .PP +.PP \fBh_name\fR .RS 4 - The official (canonical) name of the host\&. - .RE - .PP +The official (canonical) name of the host\&. +.RE +.PP \fBh_aliases\fR .RS 4 - A NULL\-terminated array of alternate names (nicknames) for the host\&. - .RE - .PP +A NULL\-terminated array of alternate names (nicknames) for the host\&. +.RE +.PP \fBh_addrtype\fR .RS 4 - The type of address being returned \- usually +The type of address being returned \- usually \fBPF_INET\fR or \fBPF_INET6\fR\&. - .RE - .PP +.RE +.PP \fBh_length\fR .RS 4 - The length of the address in bytes\&. - .RE - .PP +The length of the address in bytes\&. +.RE +.PP \fBh_addr_list\fR .RS 4 - A +A \fBNULL\fR terminated array of network addresses for the host\&. Host addresses are returned in network byte order\&. - .RE - .PP +.RE +.PP \fBlwres_getipnodebyname()\fR looks up addresses of protocol family \fIaf\fR @@ -117,35 +115,35 @@ for the hostname \fIname\fR\&. The \fIflags\fR parameter contains ORed flag bits to specify the types of addresses that are searched for, and the types of addresses that are returned\&. The flag bits are: - .PP +.PP \fBAI_V4MAPPED\fR .RS 4 - This is used with an +This is used with an \fIaf\fR of AF_INET6, and causes IPv4 addresses to be returned as IPv4\-mapped IPv6 addresses\&. - .RE - .PP +.RE +.PP \fBAI_ALL\fR .RS 4 - This is used with an +This is used with an \fIaf\fR of AF_INET6, and causes all known addresses (IPv6 and IPv4) to be returned\&. If AI_V4MAPPED is also set, the IPv4 addresses are return as mapped IPv6 addresses\&. - .RE - .PP +.RE +.PP \fBAI_ADDRCONFIG\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fBAI_DEFAULT\fR .RS 4 - This default sets the +This default sets the \fBAI_V4MAPPED\fR and \fBAI_ADDRCONFIG\fR flag bits\&. - .RE - .PP +.RE +.PP \fBlwres_getipnodebyaddr()\fR performs a reverse lookup of address \fIsrc\fR @@ -157,7 +155,7 @@ denotes the protocol family, typically \fBPF_INET\fR or \fBPF_INET6\fR\&. - .PP +.PP \fBlwres_freehostent()\fR releases all the memory associated with the \fBstruct hostent\fR @@ -170,8 +168,8 @@ and is freed, as is the memory for the \fBhostent\fR structure itself\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP If an error occurs, \fBlwres_getipnodebyname()\fR and @@ -182,31 +180,31 @@ to an appropriate error code and the function returns a \fBNULL\fR pointer\&. The error codes and their meanings are defined in : - .PP +.PP \fBHOST_NOT_FOUND\fR .RS 4 - No such host is known\&. - .RE - .PP +No such host is known\&. +.RE +.PP \fBNO_ADDRESS\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fBTRY_AGAIN\fR .RS 4 - A temporary and possibly transient error occurred, such as a failure of a server to respond\&. The request may succeed if retried\&. - .RE - .PP +A temporary and possibly transient error occurred, such as a failure of a server to respond\&. The request may succeed if retried\&. +.RE +.PP \fBNO_RECOVERY\fR .RS 4 - An unexpected failure occurred, and retrying the request is pointless\&. - .RE - .PP +An unexpected failure occurred, and retrying the request is pointless\&. +.RE +.PP \fBlwres_hstrerror\fR(3) translates these error codes to suitable error messages\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBRFC2553\fR(), \fBlwres\fR(3), \fBlwres_gethostent\fR(3), diff --git a/lib/lwres/man/lwres_getipnode.html b/lib/lwres/man/lwres_getipnode.html index c651805a5c..562ded9bd3 100644 --- a/lib/lwres/man/lwres_getipnode.html +++ b/lib/lwres/man/lwres_getipnode.html @@ -14,25 +14,13 @@
- - - - - - - -
+

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>
@@ -84,25 +72,21 @@ 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 */
@@ -114,54 +98,42 @@ 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
@@ -171,18 +143,15 @@ 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
@@ -190,37 +159,31 @@ 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,
@@ -228,11 +191,10 @@ struct  hostent {
       h_aliases is freed, as is the memory for
       the hostent structure itself.
     

-
-
+
+

RETURN VALUES

- -

+

If an error occurs, lwres_getipnodebyname() and @@ -247,70 +209,47 @@ 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, -

- RFC2553 - , + lwres(3), - - lwres(3) - , + lwres_gethostent(3), - - lwres_gethostent(3) - , + lwres_getaddrinfo(3), - - lwres_getaddrinfo(3) - , + lwres_getnameinfo(3), - - lwres_getnameinfo(3) - , - - - lwres_hstrerror(3) - . + lwres_hstrerror(3).

-
+
diff --git a/lib/lwres/man/lwres_getnameinfo.3 b/lib/lwres/man/lwres_getnameinfo.3 index 6d048c4e9c..d3e48b74f5 100644 --- a/lib/lwres/man/lwres_getnameinfo.3 +++ b/lib/lwres/man/lwres_getnameinfo.3 @@ -35,20 +35,19 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_getnameinfo \- lightweight resolver socket address structure to hostname and service name - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'int\ lwres_getnameinfo('u .BI "int lwres_getnameinfo(const\ struct\ sockaddr\ *" "sa" ", size_t\ " "salen" ", char\ *" "host" ", size_t\ " "hostlen" ", char\ *" "serv" ", size_t\ " "servlen" ", int\ " "flags" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP This function is equivalent to the \fBgetnameinfo\fR(3) function defined in RFC2133\&. @@ -64,7 +63,7 @@ and is returned via \fI*host\&.\fR The maximum length of the hostname is 1025 bytes: \fBNI_MAXHOST\fR\&. - .PP +.PP The name of the service associated with the port number in \fIsa\fR is returned in @@ -74,49 +73,49 @@ It is bytes long\&. The maximum length of the service name is \fBNI_MAXSERV\fR \- 32 bytes\&. - .PP +.PP The \fIflags\fR argument sets the following bits: - .PP +.PP \fBNI_NOFQDN\fR .RS 4 - A fully qualified domain name is not required for local hosts\&. The local part of the fully qualified domain name is returned instead\&. - .RE - .PP +A fully qualified domain name is not required for local hosts\&. The local part of the fully qualified domain name is returned instead\&. +.RE +.PP \fBNI_NUMERICHOST\fR .RS 4 - Return the address in numeric form, as if calling inet_ntop(), instead of a host name\&. - .RE - .PP +Return the address in numeric form, as if calling inet_ntop(), instead of a host name\&. +.RE +.PP \fBNI_NAMEREQD\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fBNI_NUMERICSERV\fR .RS 4 - The service name is returned as a digit string representing the port number\&. - .RE - .PP +The service name is returned as a digit string representing the port number\&. +.RE +.PP \fBNI_DGRAM\fR .RS 4 - 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 required for the few ports (512\-514) that have different services for UDP and TCP\&. - .RE - .SH "RETURN VALUES" - .PP +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 required for the few ports (512\-514) that have different services for UDP and TCP\&. +.RE +.SH "RETURN VALUES" +.PP \fBlwres_getnameinfo()\fR returns 0 on success or a non\-zero error code if an error occurs\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBRFC2133\fR(), \fBgetservbyport\fR(3), \fBlwres\fR(3), \fBlwres_getnameinfo\fR(3), \fBlwres_getnamebyaddr\fR(3)\&. \fBlwres_net_ntop\fR(3)\&. - .SH "BUGS" - .PP +.SH "BUGS" +.PP RFC2133 fails to define what the nonzero return values of \fBgetnameinfo\fR(3) are\&. diff --git a/lib/lwres/man/lwres_getnameinfo.html b/lib/lwres/man/lwres_getnameinfo.html index d185db0b19..b4a381d0af 100644 --- a/lib/lwres/man/lwres_getnameinfo.html +++ b/lib/lwres/man/lwres_getnameinfo.html @@ -14,25 +14,15 @@
- - - - - - - -
+

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>
@@ -68,17 +58,12 @@ 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 @@ -90,56 +75,45 @@ 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 @@ -147,53 +121,34 @@ 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.3 b/lib/lwres/man/lwres_getrrsetbyname.3 index 8d622cee92..2e92ee4b41 100644 --- a/lib/lwres/man/lwres_getrrsetbyname.3 +++ b/lib/lwres/man/lwres_getrrsetbyname.3 @@ -35,31 +35,29 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_getrrsetbyname, lwres_freerrset \- retrieve DNS records - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'int\ lwres_getrrsetbyname('u .BI "int lwres_getrrsetbyname(const\ char\ *" "hostname" ", unsigned\ int\ " "rdclass" ", unsigned\ int\ " "rdtype" ", unsigned\ int\ " "flags" ", struct\ rrsetinfo\ **" "res" ");" .HP \w'void\ lwres_freerrset('u .BI "void lwres_freerrset(struct\ rrsetinfo\ *" "rrset" ");" - .PP +.PP The following structures are used: - .PP +.PP .nf struct rdatainfo { unsigned int rdi_length; /* length of data */ unsigned char *rdi_data; /* record data */ }; .fi -.sp - .PP +.PP .nf struct rrsetinfo { unsigned int rri_flags; /* RRSET_VALIDATED\&.\&.\&. */ @@ -74,8 +72,8 @@ struct rrsetinfo { }; .fi .sp - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP \fBlwres_getrrsetbyname()\fR gets a set of resource records associated with a \fIhostname\fR, @@ -85,7 +83,7 @@ gets a set of resource records associated with a is a pointer a to null\-terminated string\&. The \fIflags\fR field is currently unused and must be zero\&. - .PP +.PP After a successful call to \fBlwres_getrrsetbyname()\fR, \fI*res\fR @@ -110,7 +108,7 @@ and are in uncompressed DNS wire format\&. Properties of the rdataset are represented in the \fBrri_flags\fR bitfield\&. If the RRSET_VALIDATED bit is set, the data has been DNSSEC validated and the signatures verified\&. - .PP +.PP All of the information returned by \fBlwres_getrrsetbyname()\fR is dynamically allocated: the @@ -127,41 +125,41 @@ is a pointer to a \fBstruct rrset\fR created by a call to \fBlwres_getrrsetbyname()\fR\&. - .PP - .SH "RETURN VALUES" - .PP +.PP +.SH "RETURN VALUES" +.PP \fBlwres_getrrsetbyname()\fR returns zero on success, and one of the following error codes if an error occurred: - .PP +.PP \fBERRSET_NONAME\fR .RS 4 - the name does not exist - .RE - .PP +the name does not exist +.RE +.PP \fBERRSET_NODATA\fR .RS 4 - the name exists, but does not have data of the desired type - .RE - .PP +the name exists, but does not have data of the desired type +.RE +.PP \fBERRSET_NOMEMORY\fR .RS 4 - memory could not be allocated - .RE - .PP +memory could not be allocated +.RE +.PP \fBERRSET_INVAL\fR .RS 4 - a parameter is invalid - .RE - .PP +a parameter is invalid +.RE +.PP \fBERRSET_FAIL\fR .RS 4 - other failure - .RE - .PP +other failure +.RE +.PP .RS 4 - .RE - .SH "SEE ALSO" - .PP +.RE +.SH "SEE ALSO" +.PP \fBlwres\fR(3)\&. .SH "AUTHOR" .PP diff --git a/lib/lwres/man/lwres_getrrsetbyname.html b/lib/lwres/man/lwres_getrrsetbyname.html index e8dc4cc02d..14efcaf70a 100644 --- a/lib/lwres/man/lwres_getrrsetbyname.html +++ b/lib/lwres/man/lwres_getrrsetbyname.html @@ -14,24 +14,13 @@
- - - - - - - -
+

Name

-

- lwres_getrrsetbyname, - lwres_freerrset - — retrieve DNS records -

+

lwres_getrrsetbyname, lwres_freerrset — retrieve DNS records

-
+

Synopsis

-
+
#include <lwres/netdb.h>
@@ -66,11 +55,10 @@ void
 
- -

+

The following structures are used:

- 
+
 struct  rdatainfo {
         unsigned int            rdi_length;     /* length of data */
         unsigned char           *rdi_data;      /* record data */
@@ -78,7 +66,7 @@ struct  rdatainfo {
 

 

     

-    
+
 struct  rrsetinfo {
         unsigned int            rri_flags;      /* RRSET_VALIDATED... */
         unsigned int            rri_rdclass;    /* class number */
@@ -93,12 +81,10 @@ struct  rrsetinfo {
 

 

     

-
- -
+
+

DESCRIPTION

- -

lwres_getrrsetbyname() +

lwres_getrrsetbyname() gets a set of resource records associated with a hostname, class, and type. @@ -106,7 +92,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 @@ -125,7 +111,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 @@ -142,63 +128,46 @@ 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.3 b/lib/lwres/man/lwres_gnba.3 index 0c7d45a875..a5785dbefe 100644 --- a/lib/lwres/man/lwres_gnba.3 +++ b/lib/lwres/man/lwres_gnba.3 @@ -35,16 +35,15 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_gnbarequest_render, lwres_gnbaresponse_render, lwres_gnbarequest_parse, lwres_gnbaresponse_parse, lwres_gnbaresponse_free, lwres_gnbarequest_free \- lightweight resolver getnamebyaddress message handling - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'lwres_result_t\ lwres_gnbarequest_render('u .BI "lwres_result_t lwres_gnbarequest_render(lwres_context_t\ *" "ctx" ", lwres_gnbarequest_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");" .HP \w'lwres_result_t\ lwres_gnbaresponse_render('u @@ -57,19 +56,19 @@ lwres_gnbarequest_render, lwres_gnbaresponse_render, lwres_gnbarequest_parse, lw .BI "void lwres_gnbaresponse_free(lwres_context_t\ *" "ctx" ", lwres_gnbaresponse_t\ **" "structp" ");" .HP \w'void\ lwres_gnbarequest_free('u .BI "void lwres_gnbarequest_free(lwres_context_t\ *" "ctx" ", lwres_gnbarequest_t\ **" "structp" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP These are low\-level routines for creating and parsing lightweight resolver address\-to\-name lookup request and response messages\&. - .PP +.PP There are four main functions for the getnamebyaddr opcode\&. One render function converts a getnamebyaddr request structure \(em \fBlwres_gnbarequest_t\fR \(em to the lightweight resolver\*(Aqs canonical format\&. It is complemented by a parse function that converts a packet in this canonical format to a getnamebyaddr request structure\&. Another render function converts the getnamebyaddr response structure \(em \fBlwres_gnbaresponse_t\fR to the canonical format\&. This is complemented by a parse function which converts a packet in canonical format to a getnamebyaddr response structure\&. - .PP +.PP These structures are defined in lwres/lwres\&.h\&. They are shown below\&. - .PP +.PP .if n \{\ .RS 4 .\} @@ -79,8 +78,7 @@ lwres/lwres\&.h\&. They are shown below\&. .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -93,8 +91,7 @@ typedef struct { .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -113,8 +110,7 @@ typedef struct { .if n \{\ .RE .\} -.sp - .PP +.PP \fBlwres_gnbarequest_render()\fR uses resolver context \fIctx\fR @@ -130,7 +126,7 @@ are then appended to the buffer in canonical format\&. performs the same task, except it converts a getnamebyaddr response structure \fBlwres_gnbaresponse_t\fR to the lightweight resolver\*(Aqs canonical format\&. - .PP +.PP \fBlwres_gnbarequest_parse()\fR uses context \fIctx\fR @@ -150,7 +146,7 @@ offers the same semantics as except it yields a \fBlwres_gnbaresponse_t\fR structure\&. - .PP +.PP \fBlwres_gnbaresponse_free()\fR and \fBlwres_gnbarequest_free()\fR @@ -162,8 +158,8 @@ or \fBlwres_gnbarequest_t\fR structures referenced via \fIstructp\fR\&. Any memory associated with ancillary buffers and strings for those structures is also discarded\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP The getnamebyaddr opcode functions \fBlwres_gnbarequest_render()\fR, \fBlwres_gnbaresponse_render()\fR @@ -195,8 +191,8 @@ if in the packet header structure \fBlwres_lwpacket_t\fR indicate that the packet is not a response to an earlier query\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBlwres_packet\fR(3)\&. .SH "AUTHOR" .PP diff --git a/lib/lwres/man/lwres_gnba.html b/lib/lwres/man/lwres_gnba.html index 0aba713ffc..dbb8202c4f 100644 --- a/lib/lwres/man/lwres_gnba.html +++ b/lib/lwres/man/lwres_gnba.html @@ -14,34 +14,16 @@
- - - - - - - -
+

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>
-
@@ -64,7 +46,6 @@ lwres_result_t
 
-
@@ -129,7 +110,6 @@ lwres_result_t
 
-
@@ -158,18 +138,15 @@ 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 — @@ -183,17 +160,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 {
         uint32_t  flags;
         lwres_addr_t    addr;
@@ -201,7 +178,7 @@ typedef struct {
 

 

     

-    
+
 typedef struct {
         uint32_t  flags;
         uint16_t  naliases;
@@ -215,8 +192,7 @@ 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
@@ -228,8 +204,7 @@ 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
@@ -241,8 +216,7 @@ 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
@@ -251,12 +225,10 @@ typedef struct {
       ancillary buffers and strings for those structures is also
       discarded.
     

-
- -
+
+

RETURN VALUES

- -

+

The getnamebyaddr opcode functions lwres_gnbarequest_render(), lwres_gnbaresponse_render() @@ -291,14 +263,11 @@ 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.3 b/lib/lwres/man/lwres_hstrerror.3 index 5b63a12e42..d8ade868c7 100644 --- a/lib/lwres/man/lwres_hstrerror.3 +++ b/lib/lwres/man/lwres_hstrerror.3 @@ -35,22 +35,21 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_herror, lwres_hstrerror \- lightweight resolver error message generation - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'void\ lwres_herror('u .BI "void lwres_herror(const\ char\ *" "s" ");" .HP \w'const\ char\ *\ lwres_hstrerror('u .BI "const char * lwres_hstrerror(int\ " "err" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP \fBlwres_herror()\fR prints the string \fIs\fR @@ -60,37 +59,37 @@ followed by the string generated by \fBlwres_hstrerror()\fR for the error code stored in the global variable \fBlwres_h_errno\fR\&. - .PP +.PP \fBlwres_hstrerror()\fR returns an appropriate string for the error code gievn by \fIerr\fR\&. The values of the error codes and messages are as follows: - .PP +.PP \fBNETDB_SUCCESS\fR .RS 4 - Resolver Error 0 (no error) - .RE - .PP +Resolver Error 0 (no error) +.RE +.PP \fBHOST_NOT_FOUND\fR .RS 4 - Unknown host - .RE - .PP +Unknown host +.RE +.PP \fBTRY_AGAIN\fR .RS 4 - Host name lookup failure - .RE - .PP +Host name lookup failure +.RE +.PP \fBNO_RECOVERY\fR .RS 4 - Unknown server error - .RE - .PP +Unknown server error +.RE +.PP \fBNO_DATA\fR .RS 4 - No address associated with name - .RE - .SH "RETURN VALUES" - .PP +No address associated with name +.RE +.SH "RETURN VALUES" +.PP The string Unknown resolver error is returned by @@ -98,8 +97,8 @@ is returned by when the value of \fBlwres_h_errno\fR is not a valid error code\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBherror\fR(3), \fBlwres_hstrerror\fR(3)\&. .SH "AUTHOR" diff --git a/lib/lwres/man/lwres_hstrerror.html b/lib/lwres/man/lwres_hstrerror.html index a6e6d002ed..e7f7ba3843 100644 --- a/lib/lwres/man/lwres_hstrerror.html +++ b/lib/lwres/man/lwres_hstrerror.html @@ -14,24 +14,13 @@
- - - - - - - -
+

Name

-

- lwres_herror, - lwres_hstrerror - — lightweight resolver error message generation -

+

lwres_herror, lwres_hstrerror — lightweight resolver error message generation

-
+

Synopsis

-
+
#include <lwres/netdb.h>
@@ -48,20 +37,16 @@ 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: @@ -69,58 +54,40 @@ 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), -

- herror(3) - , - - - lwres_hstrerror(3) - . + lwres_hstrerror(3).

- -
+
diff --git a/lib/lwres/man/lwres_inetntop.3 b/lib/lwres/man/lwres_inetntop.3 index 1ed0b22d1c..5f968101fa 100644 --- a/lib/lwres/man/lwres_inetntop.3 +++ b/lib/lwres/man/lwres_inetntop.3 @@ -35,34 +35,33 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_net_ntop \- lightweight resolver IP address presentation - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'const\ char\ *\ lwres_net_ntop('u .BI "const char * lwres_net_ntop(int\ " "af" ", const\ void\ *" "src" ", char\ *" "dst" ", size_t\ " "size" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP \fBlwres_net_ntop()\fR converts an IP address of protocol family \fIaf\fR \(em IPv4 or IPv6 \(em at location \fIsrc\fR from network format to its conventional representation as a string\&. For IPv4 addresses, that string would be a dotted\-decimal\&. An IPv6 address would be represented in colon notation as described in RFC1884\&. - .PP +.PP The generated string is copied to \fIdst\fR provided \fIsize\fR indicates it is long enough to store the ASCII representation of the address\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP If successful, the function returns \fIdst\fR: a pointer to a string containing the presentation format of the address\&. \fBlwres_net_ntop()\fR @@ -75,8 +74,8 @@ to if the protocol family given in \fIaf\fR is not supported\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBRFC1884\fR(), \fBinet_ntop\fR(3), \fBerrno\fR(3)\&. diff --git a/lib/lwres/man/lwres_inetntop.html b/lib/lwres/man/lwres_inetntop.html index 1b60d693ab..d570265875 100644 --- a/lib/lwres/man/lwres_inetntop.html +++ b/lib/lwres/man/lwres_inetntop.html @@ -14,23 +14,13 @@
- - - - - - - -
+

Name

-

- lwres_net_ntop - — lightweight resolver IP address presentation -

+

lwres_net_ntop — lightweight resolver IP address presentation

-
+

Synopsis

-
+
#include <lwres/net.h>
@@ -54,13 +44,10 @@ 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 @@ -68,21 +55,17 @@ 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 @@ -92,21 +75,13 @@ 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.3 b/lib/lwres/man/lwres_noop.3 index bcad99c1df..4a51a28e7b 100644 --- a/lib/lwres/man/lwres_noop.3 +++ b/lib/lwres/man/lwres_noop.3 @@ -35,16 +35,15 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "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 - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'lwres_result_t\ lwres_nooprequest_render('u .BI "lwres_result_t lwres_nooprequest_render(lwres_context_t\ *" "ctx" ", lwres_nooprequest_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");" .HP \w'lwres_result_t\ lwres_noopresponse_render('u @@ -57,23 +56,23 @@ lwres_nooprequest_render, lwres_noopresponse_render, lwres_nooprequest_parse, lw .BI "void lwres_noopresponse_free(lwres_context_t\ *" "ctx" ", lwres_noopresponse_t\ **" "structp" ");" .HP \w'void\ lwres_nooprequest_free('u .BI "void lwres_nooprequest_free(lwres_context_t\ *" "ctx" ", lwres_nooprequest_t\ **" "structp" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP These are low\-level routines for creating and parsing lightweight resolver no\-op request and response messages\&. - .PP +.PP The no\-op message is analogous to a \fBping\fR 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\&. - .PP +.PP There are four main functions for the no\-op opcode\&. One render function converts a no\-op request structure \(em \fBlwres_nooprequest_t\fR \(em to the lightweight resolver\*(Aqs canonical format\&. It is complemented by a parse function that converts a packet in this canonical format to a no\-op request structure\&. Another render function converts the no\-op response structure \(em \fBlwres_noopresponse_t\fR to the canonical format\&. This is complemented by a parse function which converts a packet in canonical format to a no\-op response structure\&. - .PP +.PP These structures are defined in lwres/lwres\&.h\&. They are shown below\&. - .PP +.PP .if n \{\ .RS 4 .\} @@ -83,8 +82,7 @@ lwres/lwres\&.h\&. They are shown below\&. .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -97,8 +95,7 @@ typedef struct { .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -111,10 +108,9 @@ typedef struct { .if n \{\ .RE .\} -.sp - .PP +.PP 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\&. - .PP +.PP \fBlwres_nooprequest_render()\fR uses resolver context \fIctx\fR @@ -130,7 +126,7 @@ are then appended to the buffer in canonical format\&. performs the same task, except it converts a no\-op response structure \fBlwres_noopresponse_t\fR to the lightweight resolver\*(Aqs canonical format\&. - .PP +.PP \fBlwres_nooprequest_parse()\fR uses context \fIctx\fR @@ -150,7 +146,7 @@ offers the same semantics as except it yields a \fBlwres_noopresponse_t\fR structure\&. - .PP +.PP \fBlwres_noopresponse_free()\fR and \fBlwres_nooprequest_free()\fR @@ -162,8 +158,8 @@ or \fBlwres_nooprequest_t\fR structures referenced via \fIstructp\fR\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP The no\-op opcode functions \fBlwres_nooprequest_render()\fR, \fBlwres_noopresponse_render()\fR @@ -195,8 +191,8 @@ if in the packet header structure \fBlwres_lwpacket_t\fR indicate that the packet is not a response to an earlier query\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBlwres_packet\fR(3) .SH "AUTHOR" .PP diff --git a/lib/lwres/man/lwres_noop.html b/lib/lwres/man/lwres_noop.html index 47aa8012ab..57979545f4 100644 --- a/lib/lwres/man/lwres_noop.html +++ b/lib/lwres/man/lwres_noop.html @@ -14,28 +14,13 @@
- - - - - - - -
+

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>
@@ -149,22 +134,21 @@ 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 — @@ -177,18 +161,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 {
         uint16_t  datalength;
         unsigned char   *data;
@@ -196,7 +180,7 @@ typedef struct {
 

 

     

-    
+
 typedef struct {
         uint16_t  datalength;
         unsigned char   *data;
@@ -204,13 +188,12 @@ 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
@@ -223,8 +206,7 @@ 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
@@ -236,20 +218,17 @@ 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(), @@ -285,14 +264,11 @@ 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.3 b/lib/lwres/man/lwres_packet.3 index d506cd7283..ce47a2dd85 100644 --- a/lib/lwres/man/lwres_packet.3 +++ b/lib/lwres/man/lwres_packet.3 @@ -35,27 +35,26 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_lwpacket_renderheader, lwres_lwpacket_parseheader \- lightweight resolver packet handling functions - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'lwres_result_t\ lwres_lwpacket_renderheader('u .BI "lwres_result_t lwres_lwpacket_renderheader(lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ");" .HP \w'lwres_result_t\ lwres_lwpacket_parseheader('u .BI "lwres_result_t lwres_lwpacket_parseheader(lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP These functions rely on a \fBstruct lwres_lwpacket\fR which is defined in lwres/lwpacket\&.h\&. - .PP +.PP .if n \{\ .RS 4 .\} @@ -65,8 +64,7 @@ typedef struct lwres_lwpacket lwres_lwpacket_t; .if n \{\ .RE .\} -.sp - .PP +.PP .if n \{\ .RS 4 .\} @@ -86,80 +84,79 @@ struct lwres_lwpacket { .if n \{\ .RE .\} -.sp - .PP +.PP The elements of this structure are: - .PP +.PP \fBlength\fR .RS 4 - the overall packet length, including the entire packet header\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&. - .RE - .PP +the overall packet length, including the entire packet header\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&. +.RE +.PP \fBversion\fR .RS 4 - the header format\&. There is currently only one format, +the header format\&. There is currently only one format, \fBLWRES_LWPACKETVERSION_0\fR\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&. - .RE - .PP +.RE +.PP \fBpktflags\fR .RS 4 - 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 by the caller\&. This field is filled in by the application with the exception of the LWRES_LWPACKETFLAG_RESPONSE bit, which is set by the library in the lwres_gabn_*() and lwres_gnba_*() calls\&. - .RE - .PP +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 by the caller\&. This field is filled in by the application with the exception of the LWRES_LWPACKETFLAG_RESPONSE bit, which is set by the library in the lwres_gabn_*() and lwres_gnba_*() calls\&. +.RE +.PP \fBserial\fR .RS 4 - 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 from the same source, they are assumed to be duplicates and the latter ones may be dropped\&. This field must be set by the application\&. - .RE - .PP +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 from the same source, they are assumed to be duplicates and the latter ones may be dropped\&. This field must be set by the application\&. +.RE +.PP \fBopcode\fR .RS 4 - indicates the operation\&. Opcodes between 0x00000000 and 0x03ffffff are reserved for use by the lightweight resolver library\&. Opcodes between 0x04000000 and 0xffffffff are application defined\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&. - .RE - .PP +indicates the operation\&. Opcodes between 0x00000000 and 0x03ffffff are reserved for use by the lightweight resolver library\&. Opcodes between 0x04000000 and 0xffffffff are application defined\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&. +.RE +.PP \fBresult\fR .RS 4 - is only valid for replies\&. Results between 0x04000000 and 0xffffffff are application defined\&. Results between 0x00000000 and 0x03ffffff are reserved for library use\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&. - .RE - .PP +is only valid for replies\&. Results between 0x04000000 and 0xffffffff are application defined\&. Results between 0x00000000 and 0x03ffffff are reserved for library use\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&. +.RE +.PP \fBrecvlength\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fBauthtype\fR .RS 4 - 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\&. - .RE - .PP +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\&. +.RE +.PP \fBauthlen\fR .RS 4 - gives the length of the authentication data\&. Since packet authentication is currently not used, this must be zero\&. - .RE - .PP +gives the length of the authentication data\&. Since packet authentication is currently not used, this must be zero\&. +.RE +.PP The following opcodes are currently defined: - .PP +.PP \fBNOOP\fR .RS 4 - Success is always returned and the packet contents are echoed\&. The lwres_noop_*() functions should be used for this type\&. - .RE - .PP +Success is always returned and the packet contents are echoed\&. The lwres_noop_*() functions should be used for this type\&. +.RE +.PP \fBGETADDRSBYNAME\fR .RS 4 - returns all known addresses for a given name\&. The lwres_gabn_*() functions should be used for this type\&. - .RE - .PP +returns all known addresses for a given name\&. The lwres_gabn_*() functions should be used for this type\&. +.RE +.PP \fBGETNAMEBYADDR\fR .RS 4 - return the hostname for the given address\&. The lwres_gnba_*() functions should be used for this type\&. - .RE - .PP +return the hostname for the given address\&. The lwres_gnba_*() functions should be used for this type\&. +.RE +.PP \fBlwres_lwpacket_renderheader()\fR transfers the contents of lightweight resolver packet structure \fBlwres_lwpacket_t\fR \fI*pkt\fR in network byte order to the lightweight resolver buffer, \fI*b\fR\&. - .PP +.PP \fBlwres_lwpacket_parseheader()\fR performs the converse operation\&. It transfers data in network byte order from buffer \fI*b\fR @@ -168,8 +165,8 @@ to resolver packet \fIb\fR should correspond to a \fBlwres_lwpacket_t\fR\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP Successful calls to \fBlwres_lwpacket_renderheader()\fR and diff --git a/lib/lwres/man/lwres_packet.html b/lib/lwres/man/lwres_packet.html index 54872d5aaf..9090647656 100644 --- a/lib/lwres/man/lwres_packet.html +++ b/lib/lwres/man/lwres_packet.html @@ -14,24 +14,13 @@
- - - - - - - -
+

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>
@@ -60,23 +49,21 @@ 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 {
         uint32_t          length;
         uint16_t          version;
@@ -91,32 +78,26 @@ 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
@@ -127,11 +108,9 @@ 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
@@ -140,11 +119,9 @@ 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
@@ -152,11 +129,9 @@ 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.
@@ -164,91 +139,73 @@ 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 @@ -258,7 +215,6 @@ struct lwres_lwpacket { functions return LWRES_R_UNEXPECTEDEND.

- -
+
diff --git a/lib/lwres/man/lwres_resutil.3 b/lib/lwres/man/lwres_resutil.3 index 87fad166d1..360d13c158 100644 --- a/lib/lwres/man/lwres_resutil.3 +++ b/lib/lwres/man/lwres_resutil.3 @@ -35,16 +35,15 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- - .SH "NAME" +.SH "NAME" lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr \- lightweight resolver utility functions - .SH "SYNOPSIS" +.SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft -.sp .HP \w'lwres_result_t\ lwres_string_parse('u .BI "lwres_result_t lwres_string_parse(lwres_buffer_t\ *" "b" ", char\ **" "c" ", uint16_t\ *" "len" ");" .HP \w'lwres_result_t\ lwres_addr_parse('u @@ -53,8 +52,8 @@ lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr .BI "lwres_result_t lwres_getaddrsbyname(lwres_context_t\ *" "ctx" ", const\ char\ *" "name" ", uint32_t\ " "addrtypes" ", lwres_gabnresponse_t\ **" "structp" ");" .HP \w'lwres_result_t\ lwres_getnamebyaddr('u .BI "lwres_result_t lwres_getnamebyaddr(lwres_context_t\ *" "ctx" ", uint32_t\ " "addrtype" ", uint16_t\ " "addrlen" ", const\ unsigned\ char\ *" "addr" ", lwres_gnbaresponse_t\ **" "structp" ");" - .SH "DESCRIPTION" - .PP +.SH "DESCRIPTION" +.PP \fBlwres_string_parse()\fR retrieves a DNS\-encoded string starting the current pointer of lightweight resolver buffer \fIb\fR: i\&.e\&. @@ -64,7 +63,7 @@ and the length of that string is given by \fI*len\fR\&. The buffer\*(Aqs current pointer is advanced to point at the character following the string length, the encoded string, and the trailing \fBNULL\fR character\&. - .PP +.PP \fBlwres_addr_parse()\fR extracts an address from the buffer \fIb\fR\&. The buffer\*(Aqs current pointer @@ -76,7 +75,7 @@ and indicates the size in bytes of the address that was copied\&. \fBb\->current\fR is advanced to point at the next byte of available data in the buffer following the encoded address\&. - .PP +.PP \fBlwres_getaddrsbyname()\fR and \fBlwres_getnamebyaddr()\fR @@ -104,11 +103,11 @@ typedef struct { .if n \{\ .RE .\} - .PP +.PP The contents of this structure are not manipulated directly but they are controlled through the \fBlwres_gabn\fR(3) functions\&. - .PP +.PP The lightweight resolver uses \fBlwres_getaddrsbyname()\fR to perform forward lookups\&. Hostname @@ -123,7 +122,7 @@ for IPv4 addresses and \fBLWRES_ADDRTYPE_V6\fR for IPv6 addresses\&. Results of the lookup are returned in \fI*structp\fR\&. - .PP +.PP \fBlwres_getnamebyaddr()\fR performs reverse lookups\&. Resolver context \fIctx\fR @@ -137,8 +136,8 @@ and its length is \fIaddrlen\fR bytes\&. The result of the function call is made available through \fI*structp\fR\&. - .SH "RETURN VALUES" - .PP +.SH "RETURN VALUES" +.PP Successful calls to \fBlwres_string_parse()\fR and @@ -150,7 +149,7 @@ Both functions return if the buffer is corrupt or \fBLWRES_R_UNEXPECTEDEND\fR if the buffer has less space than expected for the components of the encoded string or address\&. - .PP +.PP \fBlwres_getaddrsbyname()\fR returns \fBLWRES_R_SUCCESS\fR @@ -159,11 +158,11 @@ on success and it returns if the hostname \fIname\fR could not be found\&. - .PP +.PP \fBLWRES_R_SUCCESS\fR is returned by a successful call to \fBlwres_getnamebyaddr()\fR\&. - .PP +.PP Both \fBlwres_getaddrsbyname()\fR and @@ -173,8 +172,8 @@ return when memory allocation requests fail and \fBLWRES_R_UNEXPECTEDEND\fR if the buffers used for sending queries and receiving replies are too small\&. - .SH "SEE ALSO" - .PP +.SH "SEE ALSO" +.PP \fBlwres_buffer\fR(3), \fBlwres_gabn\fR(3)\&. .SH "AUTHOR" diff --git a/lib/lwres/man/lwres_resutil.html b/lib/lwres/man/lwres_resutil.html index f2c77acc82..7ec34dc2c8 100644 --- a/lib/lwres/man/lwres_resutil.html +++ b/lib/lwres/man/lwres_resutil.html @@ -14,26 +14,13 @@
- - - - - - - -
+

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>
@@ -112,13 +99,10 @@ 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, @@ -129,8 +113,7 @@ 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 @@ -143,12 +126,10 @@ 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 {
         uint32_t          flags;
@@ -163,17 +144,13 @@ 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. @@ -187,8 +164,7 @@ 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: @@ -199,12 +175,10 @@ typedef struct { function call is made available through *structp.

-
- -
+
+

RETURN VALUES

- -

+

Successful calls to lwres_string_parse() and @@ -218,18 +192,16 @@ 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 @@ -241,20 +213,13 @@ typedef struct { if the buffers used for sending queries and receiving replies are too small.

- -
-
+
+

SEE ALSO

+

lwres_buffer(3), -

- lwres_buffer(3) - , - - - lwres_gabn(3) - . + lwres_gabn(3).

- -
+
diff --git a/version b/version index 6193d5738c..f003580539 100644 --- a/version +++ b/version @@ -5,7 +5,7 @@ PRODUCT=BIND DESCRIPTION="(Extended Support Version)" MAJORVER=9 MINORVER=11 -PATCHVER=25 +PATCHVER=26 RELEASETYPE= RELEASEVER= EXTENSIONS=