diff --git a/CHANGES b/CHANGES index a995793fa1..07cd6be798 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,6 @@ +4237. [doc] Upgraded documentation toolchain to use DocBook 5 + and dblatex. [RT #40766] + 4236. [func] 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 diff --git a/FAQ.xml b/FAQ.xml index 9c56f8123f..e06c82eebd 100644 --- a/FAQ.xml +++ b/FAQ.xml @@ -1,5 +1,3 @@ - - - - -
- Frequently Asked Questions about BIND 9 - + +
+ + 2004 2005 @@ -41,10 +37,10 @@ 2003 Internet Software Consortium. - - + + - Compilation and Installation Questions + @@ -96,7 +92,7 @@ - Configuration and Setup Questions + @@ -501,7 +497,7 @@ Master 10.0.1.1: You are running chrooted (-t) and have not supplied local timezone information in the chroot area. - + FreeBSD: /etc/localtime Solaris: /etc/TIMEZONE and /usr/share/lib/zoneinfo OSF: /etc/zoneinfo/localtime @@ -697,7 +693,7 @@ server ::/0 { bogus yes; }; - Operations Questions + @@ -767,7 +763,7 @@ server ::/0 { bogus yes; }; - General Questions + @@ -807,9 +803,8 @@ server ::/0 { bogus yes; }; of sending dynamic update requests to DNS servers without being specifically configured to do so. If the update requests are coming from a Windows 2000 machine, see - - <http://support.microsoft.com/support/kb/articles/q246/8/04.asp> + + <http://support.microsoft.com/support/kb/articles/q246/8/04.asp> for information about how to turn them off. @@ -959,7 +954,7 @@ serial-query-rate 5; // default 20 usage rules and are leaking queries to the Internet. You should establish your own zones for these addresses to prevent you querying the Internet's name servers for these addresses. - Please see <http://as112.net/> + Please see <http://as112.net/> for details of the problems you are causing and the counter measures that have had to be deployed. @@ -1084,9 +1079,9 @@ empty: - Operating-System Specific Questions + - HPUX + @@ -1112,7 +1107,7 @@ configure: error: need either working unistd.h or sys/select.h - Linux + @@ -1129,7 +1124,7 @@ client: UDP client handler shutting down due to fatal receive error: unexpected See: - <http://marc.theaimsgroup.com/?l=linux-netdev&m=113081708031466&w=2> + <http://marc.theaimsgroup.com/?l=linux-netdev&m=113081708031466&w=2> @@ -1146,9 +1141,9 @@ client: UDP client handler shutting down due to fatal receive error: unexpected non-blocking is ignored. It is reported that setting xfrm_larval_drop to 1 helps but this may have negative side effects. See: -<https://bugzilla.redhat.com/show_bug.cgi?id=427629> +<https://bugzilla.redhat.com/show_bug.cgi?id=427629> and -<http://lkml.org/lkml/2007/12/4/260>. +<http://lkml.org/lkml/2007/12/4/260>. xfrm_larval_drop can be set to 1 by the following procedure: @@ -1244,8 +1239,7 @@ modprobe capability Red Hat have adopted the National Security Agency's - SELinux security policy (see <http://www.nsa.gov/selinux>) + SELinux security policy (see <http://www.nsa.gov/selinux>) and recommendations for BIND security , which are more secure than running named in a chroot and make use of the bind-chroot environment unnecessary . @@ -1403,8 +1397,8 @@ named_cache_t: for files modifiable by named - $ROOTDIR/var/{tmp,named/{slaves,d - Ubuntu uses AppArmor - <http://en.wikipedia.org/wiki/AppArmor> in + Ubuntu uses AppArmor + <http://en.wikipedia.org/wiki/AppArmor> in addition to normal file system permissions to protect the system. @@ -1441,7 +1435,7 @@ proc /var/named/proc proc defaults 0 0 - Windows + @@ -1492,7 +1486,7 @@ options { - FreeBSD + @@ -1513,15 +1507,15 @@ rand_irqs="3 14 15" See also - - <http://people.freebsd.org/~dougb/randomness.html>. + + <http://people.freebsd.org/~dougb/randomness.html>. - Solaris + @@ -1534,17 +1528,16 @@ rand_irqs="3 14 15" Sun has a blog entry describing how to do this. - + <http://blogs.sun.com/roller/page/anay/Weblog?catname=%2FSolaris> - + - Apple Mac OS X + @@ -1558,7 +1551,7 @@ rand_irqs="3 14 15" -% sudo rndc-confgen > /etc/rndc.conf +% sudo rndc-confgen > /etc/rndc.conf Copy the key statement from /etc/rndc.conf into /etc/rndc.key, e.g.: diff --git a/bin/check/named-checkconf.8 b/bin/check/named-checkconf.8 index ad6c497f3a..1b67ad1f46 100644 --- a/bin/check/named-checkconf.8 +++ b/bin/check/named-checkconf.8 @@ -13,24 +13,39 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: named\-checkconf +'\" t +.\" Title: named-checkconf .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: January 10, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2014-01-10 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NAMED\-CHECKCONF" "8" "January 10, 2014" "BIND9" "BIND9" +.TH "NAMED\-CHECKCONF" "8" "2014\-01\-10" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -named\-checkconf \- named configuration file syntax checking tool +named-checkconf \- named configuration file syntax checking tool .SH "SYNOPSIS" .HP 16 \fBnamed\-checkconf\fR [\fB\-h\fR] [\fB\-v\fR] [\fB\-j\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] {filename} [\fB\-p\fR] [\fB\-x\fR] [\fB\-z\fR] @@ -39,89 +54,90 @@ named\-checkconf \- named configuration file syntax checking tool \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, -\fI/etc/named.conf\fR -is read by default. +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 Note: files that \fBnamed\fR reads in separate parser contexts, such as -\fIrndc.key\fR +rndc\&.key and -\fIbind.keys\fR, are not automatically read by -\fBnamed\-checkconf\fR. Configuration errors in these files may cause +bind\&.keys, are not automatically read by +\fBnamed\-checkconf\fR\&. Configuration errors in these files may cause \fBnamed\fR to fail to run, even if \fBnamed\-checkconf\fR -was successful. +was successful\&. \fBnamed\-checkconf\fR -can be run on these files explicitly, however. +can be run on these files explicitly, however\&. .SH "OPTIONS" .PP \-h .RS 4 -Print the usage summary and exit. +Print the usage summary and exit\&. .RE .PP \-t \fIdirectory\fR .RS 4 Chroot to -\fIdirectory\fR -so that include directives in the configuration file are processed as if run by a similarly chrooted named. +directory +so that include directives in the configuration file are processed as if run by a similarly chrooted named\&. .RE .PP \-v .RS 4 Print the version of the \fBnamed\-checkconf\fR -program and exit. +program and exit\&. .RE .PP \-p .RS 4 Print out the -\fInamed.conf\fR -and included files in canonical form if no errors were detected. +named\&.conf +and included files in canonical form if no errors were detected\&. .RE .PP \-x .RS 4 -When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks ('?'). This allows the contents of -\fInamed.conf\fR -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. +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 \-z .RS 4 Perform a test load of all master zones found in -\fInamed.conf\fR. +named\&.conf\&. .RE .PP \-j .RS 4 -When loading a zonefile read the journal if it exists. +When loading a zonefile read the journal if it exists\&. .RE .PP filename .RS 4 -The name of the configuration file to be checked. If not specified, it defaults to -\fI/etc/named.conf\fR. +The name of the configuration file to be checked\&. If not specified, it defaults to +/etc/named\&.conf\&. .RE .SH "RETURN VALUES" .PP \fBnamed\-checkconf\fR -returns an exit status of 1 if errors were detected and 0 otherwise. +returns an exit status of 1 if errors were detected and 0 otherwise\&. .SH "SEE ALSO" .PP \fBnamed\fR(8), -\fBnamed\-checkzone\fR(8), -BIND 9 Administrator Reference Manual. +\fBnamed-checkzone\fR(8), +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2002 Internet Software Consortium. +Copyright \(co 2000-2002 Internet Software Consortium. .br diff --git a/bin/check/named-checkconf.docbook b/bin/check/named-checkconf.docbook index a5e50334e2..e82042ba08 100644 --- a/bin/check/named-checkconf.docbook +++ b/bin/check/named-checkconf.docbook @@ -1,6 +1,5 @@ -]> +]> - - + + + + 2014-01-10 + - January 10, 2014 + ISC + Internet Systems Consortium, Inc. @@ -52,21 +55,21 @@ - + named-checkconf - - - - - filename - - - + + + + + filename + + + - - DESCRIPTION + DESCRIPTION + named-checkconf checks the syntax, but not the semantics, of a named configuration file. The file is parsed @@ -84,10 +87,10 @@ successful. named-checkconf can be run on these files explicitly, however. - + - - OPTIONS + OPTIONS + @@ -176,18 +179,18 @@ - + - - RETURN VALUES + RETURN VALUES + named-checkconf returns an exit status of 1 if errors were detected and 0 otherwise. - + - - SEE ALSO + SEE ALSO + named8 , @@ -196,16 +199,5 @@ , BIND 9 Administrator Reference Manual. - - - - AUTHOR - Internet Systems Consortium - - - - + + diff --git a/bin/check/named-checkconf.html b/bin/check/named-checkconf.html index 8caabf260e..50c07f964a 100644 --- a/bin/check/named-checkconf.html +++ b/bin/check/named-checkconf.html @@ -14,68 +14,102 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - named-checkconf - + -
+
-
+ + + + + + + +

Name

-

named-checkconf — named configuration file syntax checking tool

+

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

-
+ +

Synopsis

-

named-checkconf [-h] [-v] [-j] [-t directory] {filename} [-p] [-x] [-z]

-
-
-

DESCRIPTION

-

named-checkconf +

+ named-checkconf + [-h] + [-v] + [-j] + [-t directory] + {filename} + [-p] + [-x] + [-z] +

+
+ +
+

DESCRIPTION

+ +

named-checkconf checks the syntax, but not the semantics, of a - named configuration file. The file is parsed + 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 +

+ Note: files that named reads in separate parser contexts, such as rndc.key and bind.keys, are not automatically read - by named-checkconf. Configuration - errors in these files may cause named to - fail to run, even if named-checkconf was - successful. named-checkconf can be run + by named-checkconf. Configuration + errors in these files may cause named to + fail to run, even if named-checkconf was + successful. named-checkconf can be run on these files explicitly, however.

-
-
-

OPTIONS

-
+
+ +
+

OPTIONS

+ + +
-h
-

+

+

Print the usage summary and exit. -

+

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

+

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

+

+
-p
-

+

+

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

+

+
-x
-

+

+

When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks ('?'). This allows the @@ -83,41 +117,52 @@ 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. -

+

+
-j
-

+

+

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

+

+
filename
-

+

+

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

+

+
-
-
-

RETURN VALUES

-

named-checkconf + +

+ +
+

RETURN VALUES

+ +

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

-
-
-

SEE ALSO

-

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

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
diff --git a/bin/check/named-checkzone.8 b/bin/check/named-checkzone.8 index f9bba0e73d..87d289223e 100644 --- a/bin/check/named-checkzone.8 +++ b/bin/check/named-checkzone.8 @@ -13,24 +13,39 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: named\-checkzone +'\" t +.\" Title: named-checkzone .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: April 29, 2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2013-04-29 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NAMED\-CHECKZONE" "8" "April 29, 2013" "BIND9" "BIND9" +.TH "NAMED\-CHECKZONE" "8" "2013\-04\-29" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -named\-checkzone, named\-compilezone \- zone file validity checking or converting tool +named-checkzone, named-compilezone \- zone file validity checking or converting tool .SH "SYNOPSIS" .HP 16 \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\-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\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} @@ -39,80 +54,80 @@ named\-checkzone, named\-compilezone \- zone file validity checking or convertin .SH "DESCRIPTION" .PP \fBnamed\-checkzone\fR -checks the syntax and integrity of a zone file. It performs the same checks as +checks the syntax and integrity of a zone file\&. It performs the same checks as \fBnamed\fR -does when loading a zone. This makes +does when loading a zone\&. This makes \fBnamed\-checkzone\fR -useful for checking zone files before configuring them into a name server. +useful for checking zone files before configuring them into a name server\&. .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\-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. +configuration file\&. .SH "OPTIONS" .PP \-d .RS 4 -Enable debugging. +Enable debugging\&. .RE .PP \-h .RS 4 -Print the usage summary and exit. +Print the usage summary and exit\&. .RE .PP \-q .RS 4 -Quiet mode \- exit code only. +Quiet mode \- exit code only\&. .RE .PP \-v .RS 4 Print the version of the \fBnamed\-checkzone\fR -program and exit. +program and exit\&. .RE .PP \-j .RS 4 -When loading the zone file read the journal if it exists. +When loading the zone file read the journal if it exists\&. .RE .PP \-c \fIclass\fR .RS 4 -Specify the class of the zone. If not specified, "IN" is assumed. +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, \fB"local"\fR, \fB"local\-sibling"\fR and -\fB"none"\fR. +\fB"none"\fR\&. .sp Mode \fB"full"\fR -checks that MX records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode +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. +only checks MX records which refer to in\-zone hostnames\&. .sp Mode \fB"full"\fR -checks that SRV records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode +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. +only checks SRV records which refer to in\-zone hostnames\&. .sp 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 +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. +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 \fB"full\-sibling"\fR @@ -122,25 +137,25 @@ disable sibling glue checks but are otherwise the same as \fB"full"\fR and \fB"local"\fR -respectively. +respectively\&. .sp Mode \fB"none"\fR -disables the checks. +disables the checks\&. .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) and -\fB"raw"\fR. +\fB"raw"\fR\&. .RE .PP \-F \fIformat\fR .RS 4 -Specify the format of the output file specified. For -\fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents. +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 \fB"text"\fR @@ -148,161 +163,162 @@ Possible formats are \fB"raw"\fR or \fB"raw=N"\fR, which store the zone in a binary format for rapid loading by -\fBnamed\fR. +\fBnamed\fR\&. \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. +\fBnamed\fR; if N is 1, the file can be read by release 9\&.9\&.0 or higher\&. The default is 1\&. .RE .PP \-k \fImode\fR .RS 4 Perform \fB"check\-names"\fR -checks with the specified failure mode. Possible modes are +checks with the specified failure mode\&. Possible modes are \fB"fail"\fR (default for \fBnamed\-compilezone\fR), \fB"warn"\fR (default for \fBnamed\-checkzone\fR) and -\fB"ignore"\fR. +\fB"ignore"\fR\&. .RE .PP \-L \fIserial\fR .RS 4 -When compiling a zone to 'raw' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) +When compiling a zone to \*(Aqraw\*(Aq 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. +\fB"ignore"\fR\&. .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. +\fB"ignore"\fR\&. .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), \fB"warn"\fR (default for \fBnamed\-checkzone\fR) and -\fB"ignore"\fR. +\fB"ignore"\fR\&. .RE .PP \-o \fIfilename\fR .RS 4 Write zone output to -\fIfilename\fR. If -\fIfilename\fR +filename\&. If +filename is -\fI\-\fR -then write to standard out. This is mandatory for -\fBnamed\-compilezone\fR. +\- +then write to standard out\&. This is mandatory for +\fBnamed\-compilezone\fR\&. .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. +\fB"ignore"\fR\&. .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 +\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. +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 \-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. +\fB"ignore"\fR\&. .RE .PP \-t \fIdirectory\fR .RS 4 Chroot to -\fIdirectory\fR -so that include directives in the configuration file are processed as if run by a similarly chrooted named. +directory +so that include directives in the configuration file are processed as if run by a similarly chrooted named\&. .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. +\fB"ignore"\fR\&. .RE .PP \-w \fIdirectory\fR .RS 4 chdir to -\fIdirectory\fR -so that relative filenames in master file $INCLUDE directives work. This is similar to the directory clause in -\fInamed.conf\fR. +directory +so that relative filenames in master file $INCLUDE directives work\&. This is similar to the directory clause in +named\&.conf\&. .RE .PP \-D .RS 4 -Dump zone file in canonical format. This is always enabled for -\fBnamed\-compilezone\fR. +Dump zone file in canonical format\&. This is always enabled for +\fBnamed\-compilezone\fR\&. .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. +\fB"ignore"\fR\&. .RE .PP zonename .RS 4 -The domain name of the zone being checked. +The domain name of the zone being checked\&. .RE .PP filename .RS 4 -The name of the zone file. +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. +returns an exit status of 1 if errors were detected and 0 otherwise\&. .SH "SEE ALSO" .PP \fBnamed\fR(8), -\fBnamed\-checkconf\fR(8), +\fBnamed-checkconf\fR(8), RFC 1035, -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2007, 2009\-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2002 Internet Software Consortium. +Copyright \(co 2004-2007, 2009-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2002 Internet Software Consortium. .br diff --git a/bin/check/named-checkzone.docbook b/bin/check/named-checkzone.docbook index f1590b5547..979a0f3307 100644 --- a/bin/check/named-checkzone.docbook +++ b/bin/check/named-checkzone.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2013-04-29 + - April 29, 2013 + ISC + Internet Systems Consortium, Inc. @@ -57,64 +58,64 @@ - + named-checkzone - - - - - - - - - - - - - - - - - - - - - - - - zonename - filename + + + + + + + + + + + + + + + + + + + + + + + + zonename + filename - + named-compilezone - - - - - - - - - - - - - - - - - - - - - - zonename - filename + + + + + + + + + + + + + + + + + + + + + + zonename + filename - - DESCRIPTION + DESCRIPTION + named-checkzone checks the syntax and integrity of a zone file. It performs the same checks as named does when loading a @@ -132,10 +133,10 @@ least be as strict as those specified in the named configuration file. - + - - OPTIONS + OPTIONS + @@ -473,18 +474,18 @@ - + - - RETURN VALUES + RETURN VALUES + named-checkzone returns an exit status of 1 if errors were detected and 0 otherwise. - + - - SEE ALSO + SEE ALSO + named8 , @@ -494,16 +495,6 @@ RFC 1035, BIND 9 Administrator Reference Manual. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/check/named-checkzone.html b/bin/check/named-checkzone.html index 7d44053c25..cc1baa5772 100644 --- a/bin/check/named-checkzone.html +++ b/bin/check/named-checkzone.html @@ -14,280 +14,399 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - named-checkzone - + -
+
-
+ + + + + + + +

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] [-i mode] [-k mode] [-m mode] [-M mode] [-n mode] [-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] [-i mode] [-k mode] [-m mode] [-n mode] [-L serial] [-r mode] [-s style] [-t directory] [-T mode] [-w directory] [-D] [-W mode] {-o filename} {zonename} {filename}

-
-
-

DESCRIPTION

-

named-checkzone +

+ named-checkzone + [-d] + [-h] + [-j] + [-q] + [-v] + [-c class] + [-f format] + [-F format] + [-i mode] + [-k mode] + [-m mode] + [-M mode] + [-n mode] + [-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] + [-i mode] + [-k mode] + [-m mode] + [-n mode] + [-L serial] + [-r mode] + [-s style] + [-t directory] + [-T mode] + [-w directory] + [-D] + [-W mode] + {-o filename} + {zonename} + {filename} +

+
+ +
+

DESCRIPTION

+ +

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

+ named-compilezone is similar to + named-checkzone, 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 named. + loaded by named. When manually specified otherwise, the check levels must at least be as strict as those specified in the - named configuration file. + named configuration file.

-
-
-

OPTIONS

-
+
+ +
+

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 +

+

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

+

+
-j
-

+

+

When loading the zone file read the journal if it exists. -

+

+
-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", - "local", - "local-sibling" and - "none". + "full" (default), + "full-sibling", + "local", + "local-sibling" and + "none".

-

- Mode "full" checks that MX records +

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

-

- Mode "full" checks that SRV records +

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

-

- Mode "full" checks that delegation NS +

+ 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 in the zone match those advertised by the child. - Mode "local" only checks NS records which + Mode "local" 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.

-

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

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

+ Mode "none" disables the checks.

-
+
-f format
-

+

+

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

+ Possible formats are "text" (default) + and "raw". +

+
-F format
-

+

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

-

- Possible formats are "text" (default) - and "raw" or "raw=N", +

+ Possible formats are "text" (default) + and "raw" or "raw=N", which store the zone in a binary format for rapid loading - by named. "raw=N" + by named. "raw=N" specifies the format version of 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 + 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 +

+

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

+ Possible modes are "fail" + (default for named-compilezone), + "warn" + (default for named-checkzone) and + "ignore". +

+
-L serial
-

+

+

When compiling a zone to 'raw' 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". -

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

+ 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" - (default for named-compilezone), - "warn" - (default for named-checkzone) and - "ignore". -

+ Possible modes are "fail" + (default for named-compilezone), + "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. -

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

+ 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". + Possible styles are "full" (default) + and "relative". 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 named-checkzone + For named-checkzone 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. -

+

+
-S mode
-

+

+

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

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

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

+ 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) + Possible modes are "warn" (default) and - "ignore". -

+ "ignore". +

+
zonename
-

+

+

The domain name of the zone being checked. -

+

+
filename
-

+

+

The name of the zone file. -

+

+
-
-
-

RETURN VALUES

-

named-checkzone + +

+ +
+

RETURN VALUES

+ +

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

-
-
-

SEE ALSO

-

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

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/confgen/ddns-confgen.8 b/bin/confgen/ddns-confgen.8 index 5ceb80e96a..4bbd9fa4d2 100644 --- a/bin/confgen/ddns-confgen.8 +++ b/bin/confgen/ddns-confgen.8 @@ -12,24 +12,39 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: ddns\-confgen +'\" t +.\" Title: ddns-confgen .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: September 18, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2009-09-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DDNS\-CONFGEN" "8" "September 18, 2009" "BIND9" "BIND9" +.TH "DDNS\-CONFGEN" "8" "2009\-09\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -ddns\-confgen \- ddns key generation tool +ddns-confgen \- ddns key generation tool .SH "SYNOPSIS" .HP 13 \fBddns\-confgen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\-s\ \fIname\fR | \-z\ \fIzone\fR] [\fB\-q\fR] [name] @@ -39,46 +54,46 @@ ddns\-confgen \- ddns key generation tool generates a key for use by \fBnsupdate\fR and -\fBnamed\fR. It simplifies configuration of dynamic zones by generating a key and providing the +\fBnamed\fR\&. It simplifies configuration of dynamic zones by generating a key and providing the \fBnsupdate\fR and -\fBnamed.conf\fR +\fBnamed\&.conf\fR syntax that will be needed to use it, including an example \fBupdate\-policy\fR -statement. +statement\&. .PP If a domain name is specified on the command line, it will be used in the name of the generated key and in the sample -\fBnamed.conf\fR -syntax. For example, -\fBddns\-confgen example.com\fR -would generate a key called "ddns\-key.example.com", and sample -\fBnamed.conf\fR -command that could be used in the zone definition for "example.com". +\fBnamed\&.conf\fR +syntax\&. For example, +\fBddns\-confgen example\&.com\fR +would generate a key called "ddns\-key\&.example\&.com", and sample +\fBnamed\&.conf\fR +command that could be used in the zone definition for "example\&.com"\&. .PP Note that \fBnamed\fR itself can configure a local DDNS key for use with -\fBnsupdate \-l\fR. +\fBnsupdate \-l\fR\&. \fBddns\-confgen\fR is only needed when a more elaborate configuration is required: for instance, if \fBnsupdate\fR -is to be used from a remote system. +is to be used from a remote system\&. .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. +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\&. .RE .PP \-h .RS 4 Prints a short summary of the options and arguments to -\fBddns\-confgen\fR. +\fBddns\-confgen\fR\&. .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 @@ -86,58 +101,59 @@ nor \fB\-z\fR option is specified; otherwise, the default is \fBddns\-key\fR -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. +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 \-q .RS 4 -Quiet mode: Print only the key, with no explanatory text or usage examples. +Quiet mode: Print only the key, with no explanatory text or usage examples\&. .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 -\fI/dev/random\fR -or equivalent device, the default source of randomness is keyboard input. -\fIrandomdev\fR -specifies the name of a character device or file containing random data to be used instead of the default. The special value -\fIkeyboard\fR -indicates that keyboard input should be used. +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 \-s \fIname\fR .RS 4 Single host mode: The example -\fBnamed.conf\fR +\fBnamed\&.conf\fR text shows how to set an update policy for the specified \fIname\fR -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 +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. +option\&. .RE .PP \-z \fIzone\fR .RS 4 zone mode: The example -\fBnamed.conf\fR +\fBnamed\&.conf\fR text shows how to set an update policy for the specified \fIzone\fR using the "zonesub" nametype, allowing updates to all subdomain names within that -\fIzone\fR. This option cannot be used with the +\fIzone\fR\&. This option cannot be used with the \fB\-s\fR -option. +option\&. .RE .SH "SEE ALSO" .PP \fBnsupdate\fR(1), \fBnamed.conf\fR(5), \fBnamed\fR(8), -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/confgen/ddns-confgen.docbook b/bin/confgen/ddns-confgen.docbook index 1627c9ea04..9ca1d02f20 100644 --- a/bin/confgen/ddns-confgen.docbook +++ b/bin/confgen/ddns-confgen.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2009-09-18 + - September 18, 2009 + ISC + Internet Systems Consortium, Inc. @@ -42,23 +43,23 @@ - + ddns-confgen - - - - - - -s name - -z zone + + + + + + -s name + -z zone - - name + + name - - DESCRIPTION + DESCRIPTION + ddns-confgen generates a key for use by nsupdate and named. It simplifies configuration @@ -85,10 +86,10 @@ more elaborate configuration is required: for instance, if nsupdate is to be used from a remote system. - + - - OPTIONS + OPTIONS + @@ -188,10 +189,10 @@ - + - - SEE ALSO + SEE ALSO + nsupdate1 , @@ -203,16 +204,6 @@ , BIND 9 Administrator Reference Manual. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/confgen/ddns-confgen.html b/bin/confgen/ddns-confgen.html index bdbd35ea01..c9cdc75ebd 100644 --- a/bin/confgen/ddns-confgen.html +++ b/bin/confgen/ddns-confgen.html @@ -13,66 +13,100 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - ddns-confgen - + -
+
-
+ + + + + +

Name

-

ddns-confgen — ddns key generation tool

-
-
-

Synopsis

-

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

-
-
-

DESCRIPTION

-

ddns-confgen - generates a key for use by nsupdate - and named. It simplifies configuration - of dynamic zones by generating a key and providing the - nsupdate and named.conf - syntax that will be needed to use it, including an example - update-policy statement. -

+ ddns-confgen + — ddns key generation tool +

+
+ + + +
+

Synopsis

+

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

+
+ +
+

DESCRIPTION

+ +

ddns-confgen + generates a key for use by nsupdate + and named. It simplifies configuration + of dynamic zones by generating a key and providing the + nsupdate and named.conf + syntax that will be needed to use it, including an example + update-policy statement. +

+ +

If a domain name is specified on the command line, it will be used in the name of the generated key and in the sample - named.conf syntax. For example, - ddns-confgen example.com would + named.conf syntax. For example, + ddns-confgen example.com would generate a key called "ddns-key.example.com", and sample - named.conf command that could be used + named.conf command that could be used in the zone definition for "example.com".

-

- Note that named itself can configure a - local DDNS key for use with nsupdate -l. - ddns-confgen is only needed when a + +

+ Note that named itself can configure a + local DDNS key for use with nsupdate -l. + ddns-confgen is only needed when a more elaborate configuration is required: for instance, if - nsupdate is to be used from a remote system. + nsupdate is to be used from a remote system.

-
-
-

OPTIONS

-
+
+ +
+

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

+

+
-h
-

+

+

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

+ ddns-confgen. +

+
-k keyname
-

+

+

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

+

+
-q
-

+

+

Quiet mode: Print only the key, with no explanatory text or usage examples. -

+

+
-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 @@ -99,10 +137,12 @@ instead of the default. The special value keyboard indicates that keyboard input should be used. -

+

+
-s name
-

- Single host mode: The example named.conf text +

+

+ Single host mode: The example named.conf text shows how to set an update policy for the specified name using the "name" nametype. @@ -111,31 +151,38 @@ 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
-

- zone mode: The example named.conf text +

+

+ zone mode: The example named.conf text shows how to set an update policy for the specified zone using the "zonesub" nametype, allowing updates to all subdomain names within that zone. This option cannot be used with the -s option. -

+

+
-
-
-

SEE ALSO

-

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

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/confgen/rndc-confgen.8 b/bin/confgen/rndc-confgen.8 index 1276344e37..35f31be73e 100644 --- a/bin/confgen/rndc-confgen.8 +++ b/bin/confgen/rndc-confgen.8 @@ -13,24 +13,39 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: rndc\-confgen +'\" t +.\" Title: rndc-confgen .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 15, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2009-06-15 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "RNDC\-CONFGEN" "8" "June 15, 2009" "BIND9" "BIND9" +.TH "RNDC\-CONFGEN" "8" "2009\-06\-15" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -rndc\-confgen \- rndc key generation tool +rndc-confgen \- rndc key generation tool .SH "SYNOPSIS" .HP 13 \fBrndc\-confgen\fR [\fB\-a\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] @@ -38,33 +53,33 @@ rndc\-confgen \- rndc key generation tool .PP \fBrndc\-confgen\fR generates configuration files for -\fBrndc\fR. It can be used as a convenient alternative to writing the -\fIrndc.conf\fR +\fBrndc\fR\&. It can be used as a convenient alternative to writing the +rndc\&.conf file and the corresponding \fBcontrols\fR and \fBkey\fR statements in -\fInamed.conf\fR -by hand. Alternatively, it can be run with the +named\&.conf +by hand\&. Alternatively, it can be run with the \fB\-a\fR option to set up a -\fIrndc.key\fR +rndc\&.key file and avoid the need for a -\fIrndc.conf\fR +rndc\&.conf file and a \fBcontrols\fR -statement altogether. +statement altogether\&. .SH "OPTIONS" .PP \-a .RS 4 Do automatic \fBrndc\fR -configuration. This creates a file -\fIrndc.key\fR +configuration\&. This creates a file +rndc\&.key in -\fI/etc\fR +/etc (or whatever \fIsysconfdir\fR was specified as when @@ -73,13 +88,13 @@ was built) that is read by both \fBrndc\fR and \fBnamed\fR -on startup. The -\fIrndc.key\fR +on startup\&. The +rndc\&.key file defines a default command channel and authentication key allowing \fBrndc\fR to communicate with \fBnamed\fR -on the local host with no further configuration. +on the local host with no further configuration\&. .sp Running \fBrndc\-confgen \-a\fR @@ -87,8 +102,8 @@ allows BIND 9 and \fBrndc\fR to be used as drop\-in replacements for BIND 8 and \fBndc\fR, with no changes to the existing BIND 8 -\fInamed.conf\fR -file. +named\&.conf +file\&. .sp If a more elaborate configuration than that generated by \fBrndc\-confgen \-a\fR @@ -97,15 +112,15 @@ is required, for example if rndc is to be used remotely, you should run without the \fB\-a\fR option and set up a -\fIrndc.conf\fR +rndc\&.conf and -\fInamed.conf\fR -as directed. +named\&.conf +as directed\&. .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 128. +Specifies the size of the authentication key in bits\&. Must be between 1 and 512 bits; the default is 128\&. .RE .PP \-c \fIkeyfile\fR @@ -113,19 +128,19 @@ Specifies the size of the authentication key in bits. Must be between 1 and 512 Used with the \fB\-a\fR option to specify an alternate location for -\fIrndc.key\fR. +rndc\&.key\&. .RE .PP \-h .RS 4 Prints a short summary of the options and arguments to -\fBrndc\-confgen\fR. +\fBrndc\-confgen\fR\&. .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 -\fBrndc\-key\fR. +Specifies the key name of the rndc authentication key\&. This must be a valid domain name\&. The default is +\fBrndc\-key\fR\&. .RE .PP \-p \fIport\fR @@ -133,18 +148,18 @@ Specifies the key name of the rndc authentication key. This must be a valid doma Specifies the command channel port where \fBnamed\fR listens for connections from -\fBrndc\fR. The default is 953. +\fBrndc\fR\&. The default is 953\&. .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 -\fI/dev/random\fR -or equivalent device, the default source of randomness is keyboard input. -\fIrandomdev\fR -specifies the name of a character device or file containing random data to be used instead of the default. The special value -\fIkeyboard\fR -indicates that keyboard input should be used. +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 \-s \fIaddress\fR @@ -152,7 +167,7 @@ indicates that keyboard input should be used. 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. +\fBrndc\fR\&. The default is the loopback address 127\&.0\&.0\&.1\&. .RE .PP \-t \fIchrootdir\fR @@ -161,10 +176,10 @@ Used with the \fB\-a\fR option to specify a directory where \fBnamed\fR -will run chrooted. An additional copy of the -\fIrndc.key\fR +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. +\fBnamed\fR\&. .RE .PP \-u \fIuser\fR @@ -172,10 +187,10 @@ will be written relative to this directory so that it will be found by the chroo Used with the \fB\-a\fR option to set the owner of the -\fIrndc.key\fR -file generated. If +rndc\&.key +file generated\&. If \fB\-t\fR -is also specified only the file in the chroot area has its owner changed. +is also specified only the file in the chroot area has its owner changed\&. .RE .SH "EXAMPLES" .PP @@ -186,13 +201,13 @@ to be used with no manual configuration, run \fBrndc\-confgen \-a\fR .PP To print a sample -\fIrndc.conf\fR +rndc\&.conf file and corresponding \fBcontrols\fR and \fBkey\fR statements to be manually inserted into -\fInamed.conf\fR, run +named\&.conf, run .PP \fBrndc\-confgen\fR .SH "SEE ALSO" @@ -200,11 +215,12 @@ statements to be manually inserted into \fBrndc\fR(8), \fBrndc.conf\fR(5), \fBnamed\fR(8), -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2001, 2003 Internet Software Consortium. diff --git a/bin/confgen/rndc-confgen.docbook b/bin/confgen/rndc-confgen.docbook index b3220754ad..9e35f2ebaf 100644 --- a/bin/confgen/rndc-confgen.docbook +++ b/bin/confgen/rndc-confgen.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2009-06-15 + - June 15, 2009 + ISC + Internet Systems Consortium, Inc. @@ -51,23 +52,23 @@ - + rndc-confgen - - - - - - - - - - + + + + + + + + + + - - DESCRIPTION + DESCRIPTION + rndc-confgen generates configuration files for rndc. It can be used as a @@ -82,10 +83,10 @@ and a controls statement altogether. - + - - OPTIONS + OPTIONS + @@ -239,10 +240,10 @@ - + - - EXAMPLES + EXAMPLES + To allow rndc to be used with no manual configuration, run @@ -257,10 +258,10 @@ rndc-confgen - + - - SEE ALSO + SEE ALSO + rndc8 , @@ -272,16 +273,6 @@ , BIND 9 Administrator Reference Manual. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/confgen/rndc-confgen.html b/bin/confgen/rndc-confgen.html index 84eae417d1..000f131e77 100644 --- a/bin/confgen/rndc-confgen.html +++ b/bin/confgen/rndc-confgen.html @@ -14,108 +14,147 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - rndc-confgen - + -
+
-
+ + + + + +

Name

-

rndc-confgen — rndc key generation tool

+

+ rndc-confgen + — rndc key generation tool +

-
+ + + +

Synopsis

-

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

-
-
-

DESCRIPTION

-

rndc-confgen +

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

+
+ +
+

DESCRIPTION

+ +

rndc-confgen generates configuration files - for rndc. It can be used as a + for rndc. It can be used as a convenient alternative to writing the rndc.conf file - and the corresponding controls - and key + and the corresponding controls + and key statements in named.conf by hand. - Alternatively, it can be run with the -a + Alternatively, it can be run with the -a option to set up a rndc.key file and avoid the need for a rndc.conf file - and a controls statement altogether. + and a controls statement altogether.

-
-
-

OPTIONS

-
+ +
+ +
+

OPTIONS

+ + +
-a
-

- Do automatic rndc configuration. +

+ Do automatic rndc configuration. This creates a file rndc.key in /etc (or whatever sysconfdir was specified as when BIND was built) - that is read by both rndc - and named on startup. The + that is read by both rndc + and named on startup. The rndc.key file defines a default command channel and authentication key allowing - rndc to communicate with - named on the local host + rndc to communicate with + named on the local host with no further configuration.

-

- Running rndc-confgen -a allows - BIND 9 and rndc to be used as +

+ Running rndc-confgen -a allows + BIND 9 and rndc to be used as drop-in - replacements for BIND 8 and ndc, + replacements for BIND 8 and ndc, with no changes to the existing BIND 8 named.conf file.

-

+

If a more elaborate configuration than that - generated by rndc-confgen -a + generated by rndc-confgen -a is required, for example if rndc is to be used remotely, - you should run rndc-confgen without + you should run rndc-confgen without the - -a option and set up a + -a option and set up a rndc.conf and named.conf as directed.

-
+
-b keysize
-

+

+

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

+

+
-c keyfile
-

- Used with the -a option to specify +

+

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

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

+

+ 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 @@ -126,63 +165,76 @@ 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 +

+

+ Specifies the IP address where named listens for command channel connections from - rndc. The default is the loopback + 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 +

+

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

+ it will be found by the chrooted named. +

+
-u user
-

- Used with the -a option to set the +

+

+ Used with the -a option to set the owner of the rndc.key file generated. If - -t is also specified only the file + -t is also specified only the file in the chroot area has its owner changed. -

+

+
-
-
-

EXAMPLES

-

- To allow rndc to be used with +

+ +
+

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 + 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), +

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/dig/dig.1 b/bin/dig/dig.1 index f78d556bfb..92a06e6116 100644 --- a/bin/dig/dig.1 +++ b/bin/dig/dig.1 @@ -13,22 +13,37 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: dig .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: February 12, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2014-02-12 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DIG" "1" "February 12, 2014" "BIND9" "BIND9" +.TH "DIG" "1" "2014\-02\-12" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" dig \- DNS lookup utility .SH "SYNOPSIS" @@ -41,117 +56,121 @@ dig \- DNS lookup utility .SH "DESCRIPTION" .PP \fBdig\fR -(domain information groper) is a flexible tool for interrogating DNS name servers. It performs DNS lookups and displays the answers that are returned from the name server(s) that were queried. Most DNS administrators use +(domain information groper) is a flexible tool for interrogating DNS name servers\&. It performs DNS lookups and displays the answers that are returned from the name server(s) that 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. +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 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 +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 \fB\-h\fR -option is given. Unlike earlier versions, the BIND 9 implementation of +option is given\&. Unlike earlier versions, the BIND 9 implementation of \fBdig\fR -allows multiple lookups to be issued from the command line. +allows multiple lookups to be issued from the command line\&. .PP Unless it is told to query a specific name server, \fBdig\fR will try each of the servers listed in -\fI/etc/resolv.conf\fR. If no usable server addresses are found, +/etc/resolv\&.conf\&. If no usable server addresses are found, \fBdig\fR -will send the query to the local host. +will send the query to the local host\&. .PP When no command line arguments or options are given, \fBdig\fR -will perform an NS query for "." (the root). +will perform an NS query for "\&." (the root)\&. .PP It is possible to set per\-user defaults for \fBdig\fR via -\fI${HOME}/.digrc\fR. This file is read and any options in it are applied before the command line arguments. +${HOME}/\&.digrc\&. This file is read and any options in it are applied before the command line arguments\&. .PP -The IN and CH class names overlap with the IN and CH top level domain names. Either use the +The IN and CH class names overlap with the IN and CH top level domain names\&. Either use the \fB\-t\fR and \fB\-c\fR 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. +the specify the domain name, or use "IN\&." and "CH\&." when looking up these top level domains\&. .SH "SIMPLE USAGE" .PP A typical invocation of \fBdig\fR looks like: .sp +.if n \{\ .RS 4 +.\} .nf dig @server name type .fi +.if n \{\ .RE +.\} .sp where: .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. +resolves that name before querying that name server\&. .sp If no \fIserver\fR argument is provided, \fBdig\fR consults -\fI/etc/resolv.conf\fR; if an address is found there, it queries the name server at that address. If either of the +/etc/resolv\&.conf; if an address is found there, it queries the name server at that address\&. If either of the \fB\-4\fR or \fB\-6\fR -options are in use, then only addresses for the corresponding transport will be tried. If no usable addresses are found, +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. +will send the query to the local host\&. The reply from the name server that responds is displayed\&. .RE .PP \fBname\fR .RS 4 -is the name of the resource record that is to be looked up. +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 +can be any valid query type\&. If no \fItype\fR argument is supplied, \fBdig\fR -will perform a lookup for an A record. +will perform a lookup for an A record\&. .RE .SH "OPTIONS" .PP \-4 .RS 4 -Use IPv4 only. +Use IPv4 only\&. .RE .PP \-6 .RS 4 -Use IPv6 only. +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's network interfaces, or "0.0.0.0" or "::". An optional port may be specified by appending "#" +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 \-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. +is IN; other classes are HS for Hesiod records or CH for Chaosnet records\&. .RE .PP \-f \fIfile\fR @@ -159,88 +178,88 @@ is IN; other classes are HS for Hesiod records or CH for Chaosnet records. 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 +\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. +using the command\-line interface\&. .RE .PP \-i .RS 4 -Do reverse IPv6 lookups using the obsolete RFC1886 IP6.INT domain, which is no longer in use. Obsolete bit string label queries (RFC2874) are not attempted. +Do reverse IPv6 lookups using the obsolete RFC1886 IP6\&.INT domain, which is no longer in use\&. Obsolete bit string label queries (RFC2874) are not attempted\&. .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 -\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 +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 and \fBserver\fR statements in -\fInamed.conf\fR. +named\&.conf\&. .RE .PP \-m .RS 4 -Enable memory usage debugging. +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 defaut port 53. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number. +Send the query to a non\-standard port on the server, instead of the defaut port 53\&. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number\&. .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. +from other arguments\&. .RE .PP \-t \fItype\fR .RS 4 -The resource record type to query. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the +The resource record type to query\&. It can be any valid query type which is supported in BIND 9\&. The default query type is "A", unless the \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 +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 to -ixfr=N. The incremental zone transfer will contain the changes made to the zone since the serial number in the zone's SOA record was -\fIN\fR. +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\&. .RE .PP \-v .RS 4 -Print the version number and exit. +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 +is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address\&. When the \fB\-x\fR is used, there is no need to provide the \fIname\fR, \fIclass\fR and \fItype\fR -arguments. +arguments\&. \fBdig\fR automatically performs a lookup for a name like -94.2.0.192.in\-addr.arpa -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 +94\&.2\&.0\&.192\&.in\-addr\&.arpa +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). +option)\&. .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 -is the base64 encoded shared secret. +is the base64 encoded shared secret\&. \fIhmac\fR is the name of the key algorithm; valid choices are hmac\-md5, @@ -248,10 +267,10 @@ hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384, or -hmac\-sha512. If +hmac\-sha512\&. If \fIhmac\fR is not specified, the default is -hmac\-md5. +hmac\-md5\&. .sp NOTE: You should use the \fB\-k\fR @@ -259,91 +278,91 @@ option and avoid the \fB\-y\fR option, because with \fB\-y\fR -the shared secret is supplied as a command line argument in clear text. This may be visible in the output from +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's shell. +or in a history file maintained by the user\*(Aqs shell\&. .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. +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 -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 +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. Keywords may be abbreviated, provided the abbreviation is unambiguous; for example, +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\&. Keywords may be abbreviated, provided the abbreviation is unambiguous; for example, +cd is equivalent to -+cdflag. The query options are: ++cdflag\&. The query options are: .PP \fB+[no]aaflag\fR .RS 4 A synonym for -\fI+[no]aaonly\fR. +\fI+[no]aaonly\fR\&. .RE .PP \fB+[no]aaonly\fR .RS 4 -Sets the "aa" flag in the query. +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. +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. +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. +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. +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. +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. +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 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. +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 \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. +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. +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 \fBdig\fR -and the query options that have been applied. This comment is printed by default. +and the query options that have been applied\&. This comment is printed by default\&. .RE .PP \fB+[no]comments\fR .RS 4 -Toggle the display of comment lines in the output. The default is to print comments. +Toggle the display of comment lines in the output\&. The default is to print comments\&. .RE .PP \fB+[no]defname\fR @@ -354,7 +373,7 @@ Deprecated, treated as a synonym for .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. +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 @@ -363,46 +382,46 @@ Set the search list to contain the single domain \fIsomename\fR, as if specified in a \fBdomain\fR directive in -\fI/etc/resolv.conf\fR, and enable search list processing as if the +/etc/resolv\&.conf, and enable search list processing as if the \fI+search\fR -option were given. +option were given\&. .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. +clears the remembered EDNS version\&. EDNS is set to 0 by default\&. .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. +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]identify\fR .RS 4 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. +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 \fB+[no]ignore\fR .RS 4 -Ignore truncation in UDP responses instead of retrying with TCP. By default, TCP retries are performed. +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 -\fB+nokeepopen\fR. +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 \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. +output\&. .RE .PP \fB+ndots=D\fR @@ -411,101 +430,101 @@ Set the number of dots that have to appear in \fIname\fR to \fID\fR -for it to be considered absolute. The default value is that defined using the ndots statement in -\fI/etc/resolv.conf\fR, 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 +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 \fBsearch\fR or \fBdomain\fR directive in -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf if \fB+search\fR -is set. +is set\&. .RE .PP \fB+[no]nsid\fR .RS 4 -Include an EDNS name server ID request when sending a query. +Include an EDNS name server ID request when sending a query\&. .RE .PP \fB+[no]nssearch\fR .RS 4 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. +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 \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. +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]qr\fR .RS 4 -Print [do not print] the query as it is sent. By default, the query is not printed. +Print [do not print] the query as it is sent\&. By default, the query is not printed\&. .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. +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]rdflag\fR .RS 4 A synonym for -\fI+[no]recurse\fR. +\fI+[no]recurse\fR\&. .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 the +normally sends recursive queries\&. Recursion is automatically disabled when the \fI+nssearch\fR or \fI+trace\fR -query options are used. +query options are used\&. .RE .PP \fB+retry=T\fR .RS 4 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. +instead of the default, 2\&. Unlike +\fI+tries\fR, this does not include the initial query\&. .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. +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 -\fIresolv.conf\fR -(if any). The search list is not used by default. +resolv\&.conf +(if any)\&. The search list is not used by default\&. .sp -\'ndots' from -\fIresolv.conf\fR +\*(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. +determines if the name will be treated as relative or not and hence whether a search is eventually performed or not\&. .RE .PP \fB+[no]short\fR .RS 4 -Provide a terse answer. The default is to print the answer in a verbose form. +Provide a terse answer\&. The default is to print the answer in a verbose form\&. .RE .PP \fB+[no]showsearch\fR .RS 4 -Perform [do not perform] a search showing intermediate results. +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. +Chase DNSSEC signature chains\&. Requires dig be compiled with \-DDIG_SIGCHASE\&. .RE .PP \fB+split=W\fR @@ -514,86 +533,86 @@ Split long hex\- or base64\-formatted fields in resource records into chunks of \fIW\fR characters (where \fIW\fR -is rounded up to the nearest multiple of 4). +is rounded up to the nearest multiple of 4)\&. \fI+nosplit\fR 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. +causes fields not to be split at all\&. The default is 56 characters, or 44 characters when multiline mode is active\&. .RE .PP \fB+[no]stats\fR .RS 4 -This query option toggles the printing of statistics: when the query was made, the size of the reply and so on. The default behavior is to print the query statistics. +This query option toggles the printing of statistics: when the query was made, the size of the reply and so on\&. The default behavior is to print the query statistics\&. .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 an +Use [do not use] TCP when querying name servers\&. The default behavior is to use UDP unless an ixfr=N -query is requested, in which case the default is TCP. AXFR queries always use TCP. +query is requested, in which case the default is TCP\&. AXFR queries always use TCP\&. .RE .PP \fB+time=T\fR .RS 4 Sets the timeout for a query to \fIT\fR -seconds. The default timeout is 5 seconds. An attempt to set +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. +to less than 1 will result in a query timeout of 1 second being applied\&. .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. +When chasing DNSSEC signature chains perform a top\-down validation\&. Requires dig be compiled with \-DDIG_SIGCHASE\&. .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. +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 -is also set when +trace is set to better emulate the default queries from a nameserver. +is also set when +trace is set to better emulate the default queries from a nameserver\&. .RE .PP \fB+tries=T\fR .RS 4 Sets the number of times to try UDP queries to server to \fIT\fR -instead of the default, 3. If +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. +is less than or equal to zero, the number of tries is silently rounded up to 1\&. .RE .PP \fB+trusted\-key=####\fR .RS 4 Specifies a file containing trusted keys to be used with -\fB+sigchase\fR. Each DNSKEY record must be on its own line. +\fB+sigchase\fR\&. Each DNSKEY record must be on its own line\&. .sp If not specified, \fBdig\fR will look for -\fI/etc/trusted\-key.key\fR +/etc/trusted\-key\&.key then -\fItrusted\-key.key\fR -in the current directory. +trusted\-key\&.key +in the current directory\&. .sp -Requires dig be compiled with \-DDIG_SIGCHASE. +Requires dig be compiled with \-DDIG_SIGCHASE\&. .RE .PP \fB+[no]ttlid\fR .RS 4 -Display [do not display] the TTL when printing the record. +Display [do not display] the TTL when printing the record\&. .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". +is provided for backwards compatibility\&. The "vc" stands for "virtual circuit"\&. .RE .SH "MULTIPLE QUERIES" .PP @@ -601,63 +620,71 @@ 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. +batch file option)\&. Each of those queries can be supplied with its own set of flags, options and query options\&. .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. +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 -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 +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: +option) can be overridden by a query\-specific set of query options\&. For example: .sp +.if n \{\ .RS 4 +.\} .nf -dig +qr www.isc.org any \-x 127.0.0.1 isc.org ns +noqr +dig +qr www\&.isc\&.org any \-x 127\&.0\&.0\&.1 isc\&.org ns +noqr .fi +.if n \{\ .RE +.\} .sp shows how \fBdig\fR could be used from the command line to make three lookups: an ANY query for -www.isc.org, a reverse lookup of 127.0.0.1 and a query for the NS records of -isc.org. A global query option of +www\&.isc\&.org, a reverse lookup of 127\&.0\&.0\&.1 and a query for the NS records of +isc\&.org\&. A global query option of \fI+qr\fR is applied, so that \fBdig\fR -shows the initial query it made for each lookup. The final query has a local query option of +shows the initial query it made for each lookup\&. The final query has a local query option of \fI+noqr\fR which means that \fBdig\fR will not print the initial query when it looks up the NS records for -isc.org. +isc\&.org\&. .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. +has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names\&. \fBdig\fR -appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the +appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server\&. If you\*(Aqd like to turn off the IDN support for some reason, defines the \fBIDN_DISABLE\fR -environment variable. The IDN support is disabled if the variable is set when +environment variable\&. The IDN support is disabled if the variable is set when \fBdig\fR -runs. +runs\&. .SH "FILES" .PP -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf .PP -\fI${HOME}/.digrc\fR +${HOME}/\&.digrc .SH "SEE ALSO" .PP \fBhost\fR(1), \fBnamed\fR(8), -\fBdnssec\-keygen\fR(8), -RFC1035. +\fBdnssec-keygen\fR(8), +RFC1035\&. .SH "BUGS" .PP -There are probably too many query options. +There are probably too many query options\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2011, 2013\-2015 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2003 Internet Software Consortium. +Copyright \(co 2004-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2003 Internet Software Consortium. .br diff --git a/bin/dig/dig.docbook b/bin/dig/dig.docbook index 8a3022dfc8..37fd9a5fb3 100644 --- a/bin/dig/dig.docbook +++ b/bin/dig/dig.docbook @@ -1,6 +1,3 @@ -]> + + - - + + 2014-02-12 + - February 12, 2014 + ISC + Internet Systems Consortium, Inc. @@ -60,42 +61,42 @@ - + dig - @server - - - - - - - - - - - - - - name - type - class + @server + + + + + + + + + + + + + + name + type + class queryopt - + dig - + - + dig global-queryopt query - - DESCRIPTION + DESCRIPTION + dig (domain information groper) is a flexible tool for interrogating DNS name servers. It performs DNS lookups and @@ -146,10 +147,10 @@ use "IN." and "CH." when looking up these top level domains. - + - - SIMPLE USAGE + SIMPLE USAGE + A typical invocation of dig looks like: @@ -198,7 +199,7 @@ type - indicates what type of query is required — + indicates what type of query is required — ANY, A, MX, SIG, etc. type can be any valid query type. If no @@ -212,10 +213,10 @@ - + - - OPTIONS + OPTIONS + @@ -415,10 +416,10 @@ - + - - QUERY OPTIONS + QUERY OPTIONS + dig provides a number of query options which affect @@ -1006,10 +1007,10 @@ - + - - MULTIPLE QUERIES + MULTIPLE QUERIES + The BIND 9 implementation of dig @@ -1055,10 +1056,10 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr isc.org. - + - - IDN SUPPORT + IDN SUPPORT + If dig has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. @@ -1070,18 +1071,18 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr The IDN support is disabled if the variable is set when dig runs. - + - - FILES + FILES + /etc/resolv.conf ${HOME}/.digrc - + - - SEE ALSO + SEE ALSO + host1 , @@ -1093,16 +1094,12 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr , RFC1035. - + - - BUGS + BUGS + There are probably too many query options. - - + + diff --git a/bin/dig/dig.html b/bin/dig/dig.html index 6cb32c1189..d0a81d980a 100644 --- a/bin/dig/dig.html +++ b/bin/dig/dig.html @@ -14,195 +14,277 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dig - + -
+
-
+ + + + + + +

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

-
-
-

DESCRIPTION

-

dig +

+ 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 (domain information groper) is a flexible tool for interrogating DNS name servers. It performs DNS lookups and displays the answers that are returned from the name server(s) that - were queried. Most DNS administrators use dig to + were queried. Most DNS administrators use dig to troubleshoot DNS problems because of its flexibility, ease of use and clarity of output. Other lookup tools tend to have less functionality - than dig. + than dig.

-

- Although dig is normally used with + +

+ Although dig 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 -h option is given. Unlike earlier versions, the BIND 9 implementation of - dig allows multiple lookups to be issued + dig allows multiple lookups to be issued from the command line.

-

+ +

Unless it is told to query a specific name server, - dig will try each of the servers listed in + 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 + 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). + dig will perform an NS query for "." (the root).

-

- It is possible to set per-user defaults for dig via + +

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

-

+ +

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

-
-
-

SIMPLE USAGE

-

- A typical invocation of dig looks like: + +

+ +
+

SIMPLE USAGE

+ + +

+ A typical invocation of dig looks like:

 dig @server name type 

where:

-
+
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 server argument is a hostname, - dig resolves that name before querying + dig resolves that name before querying that name server.

-

+

If no server argument is - provided, dig consults + provided, dig consults /etc/resolv.conf; if an address is found there, it queries the name server at that address. If either of the -4 or -6 options are in use, then only addresses for the corresponding transport will be tried. If no usable addresses are found, - dig will send the query to the + dig will send the query to the 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 type. If no type argument is supplied, - dig will perform a lookup for an + dig will perform a lookup for an A record. -

+

+

-
-
-

OPTIONS

-
+ +
+ +
+

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 +

+

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

+ dig using the command-line interface. +

+
-i
-

+

+

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

+

+
-k keyfile
-

+

+

Sign queries using TSIG using a key read from the given file. Key files can be generated using - tsig-keygen(8). - When using TSIG authentication with dig, + + 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 + providing appropriate key + and server statements in named.conf. -

+

+
-m
-

+

+

Enable memory usage debugging. -

+

+
-p port
-

+

+

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

+

+
-q name
-

+

+

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

+

+
-t type
-

+

+

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

+

+
-v
-

+

+

Print the version number and exit. -

+

+
-x addr
-

+

+

Simplified reverse lookups, for mapping addresses to names. The addr is an IPv4 address in dotted-decimal notation, or a colon-delimited IPv6 @@ -228,17 +314,18 @@ need to provide the name, class and type - arguments. dig automatically performs a + arguments. dig automatically performs a lookup for a name like 94.2.0.192.in-addr.arpa 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 -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. @@ -249,28 +336,34 @@ hmac-sha512. If hmac is not specified, the default is hmac-md5.

-

+

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 +

+ +
+

QUERY OPTIONS

+ + +

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 @@ -284,22 +377,29 @@ The query options are:

-
+
+[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 @@ -309,123 +409,161 @@ from a OPT-OUT range. AD=0 indicate that some part of the answer was insecure or not validated. This bit is set by default. -

+

+
+[no]all
-

+

+

Set or clear all display flags. -

+

+
+[no]answer
-

+

+

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

+

+
+[no]authority
-

+

+

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

+

+
+[no]besteffort
-

+

+

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

+

+
+bufsize=B
-

+

+

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

+

+
+[no]cdflag
-

+

+

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

+

+
+[no]class
-

+

+

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

+

+
+[no]cmd
-

+

+

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

+

+
+[no]comments
-

+

+

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

+

+
+[no]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 + a domain directive in /etc/resolv.conf, and enable search list processing as if the +search option were given. -

+

+
+[no]edns[=#]
-

+

+

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

+

+
+[no]fail
-

+

+

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

+

+
+[no]identify
-

+

+

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

+

+
+[no]ignore
-

+

+

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

+

+
+[no]keepopen
-

+

+

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

+

+
+[no]multiline
-

+

+

Print records like the SOA records in a verbose multi-line format with human-readable comments. The default is to print each record on a single line, to - facilitate machine parsing of the dig + 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 @@ -437,97 +575,123 @@ 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 +

+

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

+

+

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

+

+
+[no]question
-

+

+

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

+

+
+[no]rdflag
-

+

+

A synonym for +[no]recurse. -

+

+
+[no]recurse
-

+

+

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

+

+
+retry=T
-

+

+

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

+

+
+[no]rrcomments
-

+

+

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

+

+
+[no]search
-

+

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

-

+

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

-
+
+[no]short
-

+

+

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

+

+
+[no]showsearch
-

+

+

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

+

+
+[no]sigchase
-

+

+

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

+

+
+split=W
-

+

+

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

+

+
+[no]stats
-

+

+

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

+

+
+[no]tcp
-

+

+

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

+

+
+time=T
-

+

+

Sets the timeout for a query to T seconds. The default @@ -561,86 +731,95 @@ An attempt to set T to less than 1 will result in a query timeout of 1 second being applied. -

+

+
+[no]topdown
-

+

+

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

+

+
+[no]trace
-

+

Toggle tracing of the delegation path from the root name servers for the name being looked up. Tracing is disabled by default. When tracing is enabled, - dig makes iterative queries to + dig 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. -

-

+

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

-

- +dnssec is also set when +trace +

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

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

-

+

Requires dig be compiled with -DDIG_SIGCHASE.

-
+
+[no]ttlid
-

+

+

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

+

+
+[no]vc
-

+

+

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

+

+

-
-
-

MULTIPLE QUERIES

-

- The BIND 9 implementation of dig +

+ +
+

MULTIPLE QUERIES

+ + +

+ The BIND 9 implementation of dig supports specifying multiple queries on the command line (in addition to supporting the -f batch file option). Each of those 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 @@ -648,7 +827,8 @@ looked up, an optional query type and class and any query options that should be applied to that query.

-

+ +

A global set of query options, which should be applied to all queries, can also be supplied. These global query options must precede the first tuple of name, class, type, options, flags, and query options @@ -660,7 +840,7 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr

- shows how dig could be used from the + shows how dig could be used from the command line to make three lookups: an ANY query for www.isc.org, a reverse lookup of 127.0.0.1 and a query for the NS records of @@ -668,48 +848,63 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr A global query option of +qr is applied, so - that dig shows the initial query it made + that dig shows the initial query it made for each lookup. The final query has a local query option of - +noqr which means that dig + +noqr which means that dig 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 + +

+ +
+

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 + dig appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the IDN_DISABLE environment variable. The IDN support is disabled if the variable is set when - dig runs. + dig runs.

-
-
-

FILES

-

/etc/resolv.conf +

+ +
+

FILES

+ +

/etc/resolv.conf

-

${HOME}/.digrc +

${HOME}/.digrc

-
-
-

SEE ALSO

-

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

+ +
+

SEE ALSO

+ +

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

-
-
-

BUGS

-

+

+ +
+

BUGS

+ +

There are probably too many query options.

-
+
diff --git a/bin/dig/host.1 b/bin/dig/host.1 index 4ff5a7cc61..56804dc12d 100644 --- a/bin/dig/host.1 +++ b/bin/dig/host.1 @@ -13,22 +13,37 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: host .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: January 20, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2009-01-20 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "HOST" "1" "January 20, 2009" "BIND9" "BIND9" +.TH "HOST" "1" "2009\-01\-20" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" host \- DNS lookup utility .SH "SYNOPSIS" @@ -37,19 +52,19 @@ host \- DNS lookup utility .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, +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. +prints a short summary of its command line arguments and options\&. .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 +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 -will by default perform a reverse lookup for that address. +will by default perform a reverse lookup for that address\&. \fIserver\fR is an optional argument which is either the name or IP address of the name server that \fBhost\fR should query instead of the server or servers listed in -\fI/etc/resolv.conf\fR. +/etc/resolv\&.conf\&. .PP The \fB\-a\fR @@ -57,7 +72,7 @@ The \fB\-v\fR option and asking \fBhost\fR -to make a query of type ANY. +to make a query of type ANY\&. .PP When the \fB\-C\fR @@ -65,12 +80,12 @@ option is used, \fBhost\fR will attempt to display 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. +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\&. .PP The \fB\-c\fR option instructs to make a DNS query of class -\fIclass\fR. This can be used to lookup Hesiod or Chaosnet class resource records. The default class is IN (Internet). +\fIclass\fR\&. This can be used to lookup Hesiod or Chaosnet class resource records\&. The default class is IN (Internet)\&. .PP Verbose output is generated by \fBhost\fR @@ -78,114 +93,113 @@ when the \fB\-d\fR or \fB\-v\fR -option is used. The two options are equivalent. They have been provided for backwards compatibility. In previous versions, the +option is used\&. The two options are equivalent\&. They have been provided for backwards compatibility\&. In previous versions, the \fB\-d\fR option switched on debugging traces and \fB\-v\fR -enabled verbose output. +enabled verbose output\&. .PP List mode is selected by the \fB\-l\fR -option. This makes +option\&. This makes \fBhost\fR perform a zone transfer for zone -\fIname\fR. Transfer the zone printing out the NS, PTR and address records (A/AAAA). If combined with +\fIname\fR\&. Transfer the zone printing out the NS, PTR and address records (A/AAAA)\&. If combined with \fB\-a\fR -all records will be printed. +all records will be printed\&. .PP The \fB\-i\fR -option specifies that reverse lookups of IPv6 addresses should use the IP6.INT domain as defined in RFC1886. The default is to use IP6.ARPA. +option specifies that reverse lookups of IPv6 addresses should use the IP6\&.INT domain as defined in RFC1886\&. The default is to use IP6\&.ARPA\&. .PP The \fB\-N\fR option sets 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 -\fI/etc/resolv.conf\fR, 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 +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 \fBsearch\fR or \fBdomain\fR directive in -\fI/etc/resolv.conf\fR. +/etc/resolv\&.conf\&. .PP The number of UDP retries for a lookup can be changed with the \fB\-R\fR -option. +option\&. \fInumber\fR indicates how many times \fBhost\fR -will repeat a query that does not get answered. The default number of retries is 1. If +will repeat a query that does not get answered\&. The default number of retries is 1\&. If \fInumber\fR -is negative or zero, the number of retries will default to 1. +is negative or zero, the number of retries will default to 1\&. .PP Non\-recursive queries can be made via the \fB\-r\fR -option. Setting this option clears the +option\&. Setting this option clears the \fBRD\fR \(em recursion desired \(em bit in the query which \fBhost\fR -makes. This should mean that the name server receiving the query will not attempt to resolve -\fIname\fR. The +makes\&. 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 are usually referrals to other name servers. +to mimic the behavior of a name server by making non\-recursive queries and expecting to receive answers to those queries that are usually referrals to other name servers\&. .PP By default, \fBhost\fR -uses UDP when making queries. The +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. +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\&. .PP The \fB\-4\fR option forces \fBhost\fR -to only use IPv4 query transport. The +to only use IPv4 query transport\&. The \fB\-6\fR option forces \fBhost\fR -to only use IPv6 query transport. +to only use IPv6 query transport\&. .PP The \fB\-t\fR -option is used to select the query type. +option is used to select the query type\&. \fItype\fR -can be any recognized query type: CNAME, NS, SOA, SIG, KEY, AXFR, etc. When no query type is specified, +can be any recognized query type: CNAME, NS, SOA, SIG, KEY, AXFR, etc\&. When no query type is specified, \fBhost\fR -automatically selects an appropriate query type. By default, it looks for A, AAAA, and MX records, but if the +automatically selects an appropriate query type\&. By default, it looks for A, AAAA, and MX records, but if the \fB\-C\fR option was given, queries will be made for SOA records, and if \fIname\fR is a dotted\-decimal IPv4 address or colon\-delimited IPv6 address, \fBhost\fR -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 (e.g. \-t IXFR=12345678). +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 (e\&.g\&. \-t IXFR=12345678)\&. .PP The time to wait for a reply can be controlled through the \fB\-W\fR and \fB\-w\fR -options. The +options\&. The \fB\-W\fR option makes \fBhost\fR wait for \fIwait\fR -seconds. If +seconds\&. If \fIwait\fR -is less than one, the wait interval is set to one second. When the +is less than one, the wait interval is set to one second\&. When the \fB\-w\fR option is used, \fBhost\fR -will effectively wait forever for a reply. The time to wait for a response will be set to the number of seconds given by the hardware's maximum value for an integer quantity. +will effectively wait forever for a reply\&. The time to wait for a response will be set to the number of seconds given by the hardware\*(Aqs maximum value for an integer quantity\&. .PP The \fB\-s\fR option tells -\fBhost\fR -\fInot\fR -to send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior. +\fBhost\fR\fInot\fR +to send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior\&. .PP The \fB\-m\fR @@ -193,33 +207,37 @@ can be used to set the memory usage debugging flags \fIrecord\fR, \fIusage\fR and -\fItrace\fR. +\fItrace\fR\&. .PP The \fB\-V\fR option causes \fBhost\fR -to print the version number and exit. +to print the version number and exit\&. .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. +has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names\&. \fBhost\fR -appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the +appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server\&. If you\*(Aqd like to turn off the IDN support for some reason, defines the \fBIDN_DISABLE\fR -environment variable. The IDN support is disabled if the variable is set when +environment variable\&. The IDN support is disabled if the variable is set when \fBhost\fR -runs. +runs\&. .SH "FILES" .PP -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf .SH "SEE ALSO" .PP \fBdig\fR(1), -\fBnamed\fR(8). +\fBnamed\fR(8)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004, 2005, 2007\-2009, 2014 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2002 Internet Software Consortium. +Copyright \(co 2004, 2005, 2007-2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2002 Internet Software Consortium. .br diff --git a/bin/dig/host.docbook b/bin/dig/host.docbook index 30fc441044..3712f4f404 100644 --- a/bin/dig/host.docbook +++ b/bin/dig/host.docbook @@ -1,6 +1,5 @@ -]> +]> - - - + + + + 2009-01-20 + - January 20, 2009 + ISC + Internet Systems Consortium, Inc. @@ -54,26 +56,26 @@ - + host - - - - - - - - - - - - name - server + + + + + + + + + + + + name + server - - DESCRIPTION + DESCRIPTION + host is a simple utility for performing DNS lookups. @@ -245,10 +247,10 @@ The option causes host to print the version number and exit. - + - - IDN SUPPORT + IDN SUPPORT + If host has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. @@ -260,16 +262,16 @@ The IDN support is disabled if the variable is set when host runs. - + + + FILES - - FILES /etc/resolv.conf - + + + SEE ALSO - - SEE ALSO dig1 , @@ -277,10 +279,6 @@ named8 . + - - + diff --git a/bin/dig/host.html b/bin/dig/host.html index a04536afec..8cb036d8d7 100644 --- a/bin/dig/host.html +++ b/bin/dig/host.html @@ -14,65 +14,98 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - host - + -
+
-
+ + + + + +

Name

-

host — DNS lookup utility

+

+ host + — DNS lookup utility +

-
+ + + +

Synopsis

-

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

-
-
-

DESCRIPTION

-

host +

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

+
+ +
+

DESCRIPTION

+ + +

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 + 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 + IPv6 address, in which case host will by default perform a reverse lookup for that address. server is an optional argument which is either - the name or IP address of the name server that host + the name or IP address of the name server that host should query instead of the server or servers listed in /etc/resolv.conf.

-

+ +

The -a (all) option is equivalent to setting the - -v option and asking host to make + -v option and asking host to make a query of type ANY.

-

- When the -C option is used, host + +

+ When the -C option is used, host will attempt to display 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.

-

+ +

The -c option instructs to make a DNS query of class class. This can be used to lookup Hesiod or Chaosnet class resource records. The default class is IN (Internet).

-

- Verbose output is generated by host when + +

+ Verbose output is generated by host when the -d or -v option is used. The two options are equivalent. They have been provided for backwards @@ -80,21 +113,24 @@ switched on debugging traces and -v enabled verbose output.

-

+ +

List mode is selected by the -l option. This makes - host perform a zone transfer for zone + host perform a zone transfer for zone name. Transfer the zone printing out the NS, PTR and address records (A/AAAA). If combined with -a all records will be printed.

-

+ +

The -i option specifies that reverse lookups of IPv6 addresses should use the IP6.INT domain as defined in RFC1886. The default is to use IP6.ARPA.

-

+ +

The -N option sets the number of dots that have to be in name for it to be considered absolute. The @@ -106,111 +142,131 @@ or domain directive in /etc/resolv.conf.

-

+ +

The number of UDP retries for a lookup can be changed with the -R option. number indicates - how many times host will repeat a query + how many times host will repeat a query that does not get answered. The default number of retries is 1. If number is negative or zero, the number of retries will default to 1.

-

+ +

Non-recursive queries can be made via the -r option. Setting this option clears the RD — recursion - desired — bit in the query which host makes. + desired — bit in the query which host makes. This should mean that the name server receiving the query will not attempt to resolve name. The - -r option enables host + -r option enables host to mimic the behavior of a name server by making non-recursive queries and expecting to receive answers to those queries that are usually referrals to other name servers.

-

- By default, host uses UDP when making + +

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

-

- The -4 option forces host to only + +

+ The -4 option forces host to only use IPv4 query transport. The -6 option forces - host to only use IPv6 query transport. + host to only use IPv6 query transport.

-

+ +

The -t option is used to select the query type. type can be any recognized query type: CNAME, NS, SOA, SIG, KEY, AXFR, etc. When no query type is specified, - host automatically selects an appropriate + host automatically selects an appropriate query type. By default, it looks for A, AAAA, and MX records, but if the -C option was given, queries will be made for SOA records, and if name is a dotted-decimal IPv4 - address or colon-delimited IPv6 address, host will + address or colon-delimited IPv6 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 (e.g. -t IXFR=12345678).

-

+ +

The time to wait for a reply can be controlled through the -W and -w options. The - -W option makes host + -W option makes host wait for wait seconds. If wait is less than one, the wait interval is set to one second. When the - -w option is used, host + -w option is used, host will effectively wait forever for a reply. The time to wait for a response will be set to the number of seconds given by the hardware's maximum value for an integer quantity.

-

- The -s option tells host + +

+ The -s option tells host not to send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior.

-

+ +

The -m can be used to set the memory usage debugging flags record, usage and trace.

-

- The -V option causes host + +

+ The -V option causes host to print the version number and exit.

-
-
-

IDN SUPPORT

-

- If host has been built with IDN (internationalized +

+ +
+

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 + host appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the IDN_DISABLE environment variable. The IDN support is disabled if the variable is set when - host runs. + host runs.

-
-
-

FILES

-

/etc/resolv.conf +

+ +
+

FILES

+ +

/etc/resolv.conf

-
-
-

SEE ALSO

-

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

+ +
+

SEE ALSO

+ +

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

-
+
+
diff --git a/bin/dig/nslookup.1 b/bin/dig/nslookup.1 index e5ea2396a1..b13c86897a 100644 --- a/bin/dig/nslookup.1 +++ b/bin/dig/nslookup.1 @@ -12,22 +12,37 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: nslookup .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: January 24, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2014-01-24 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NSLOOKUP" "1" "January 24, 2014" "BIND9" "BIND9" +.TH "NSLOOKUP" "1" "2014\-01\-24" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" nslookup \- query Internet name servers interactively .SH "SYNOPSIS" @@ -36,44 +51,61 @@ nslookup \- query Internet name servers interactively .SH "DESCRIPTION" .PP \fBNslookup\fR -is a program to query Internet domain name servers. +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. +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 Interactive mode is entered in the following cases: -.TP 4 -1. -when no arguments are given (the default name server will be used) -.TP 4 -2. -when the first argument is a hyphen (\-) and the second argument is the host name or Internet address of a name server. -.sp -.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 -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 .RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +when no arguments are given (the default name server will be used) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.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 +.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 +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 \{\ +.RS 4 +.\} .nf nslookup \-query=hinfo \-timeout=10 .fi +.if n \{\ .RE -.sp +.\} .PP The \fB\-version\fR option causes \fBnslookup\fR -to print the version number and immediately exits. +to print the version number and immediately exits\&. .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. +To look up a host not in the current domain, append a period to the name\&. .RE .PP \fBserver\fR \fIdomain\fR @@ -88,7 +120,7 @@ Change the default server to uses the initial server to look up information about \fIdomain\fR, while \fBserver\fR -uses the current default server. If an authoritative answer can't be found, the names of servers that might have the answer are returned. +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 \fBroot\fR @@ -123,24 +155,22 @@ not implemented .PP \fBexit\fR .RS 4 -Exits the program. +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: -.RS 4 +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 -\fBset\fR. Information about the current default server and host is also printed. +\fBset\fR\&. Information about the current default server and host is also printed\&. .RE .PP \fBclass=\fR\fIvalue\fR .RS 4 Change the query class to one of: -.RS 4 .PP \fBIN\fR .RS 4 @@ -161,16 +191,15 @@ the Hesiod class .RS 4 wildcard .RE -.RE -.IP "" 4 -The class specifies the protocol group of the information. +.sp +The class specifies the protocol group of the information\&. .sp (Default = IN; abbreviation = cl) .RE .PP \fB \fR\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 = [no]deb) @@ -178,7 +207,7 @@ Turn on or off the display of the full response packet and any intermediate resp .PP \fB \fR\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 @@ -186,12 +215,12 @@ Turn debugging mode on or off. This displays more about what nslookup is doing. \fBdomain=\fR\fIname\fR .RS 4 Sets the search list to -\fIname\fR. +\fIname\fR\&. .RE .PP \fB \fR\fB\fI[no]\fR\fR\fBsearch\fR .RS 4 -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. +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 @@ -199,7 +228,7 @@ If the lookup request contains at least one period but doesn't end with a traili \fBport=\fR\fIvalue\fR .RS 4 Change the default TCP/UDP name server port to -\fIvalue\fR. +\fIvalue\fR\&. .sp (Default = 53; abbreviation = po) .RE @@ -210,60 +239,60 @@ Change the default TCP/UDP name server port to .PP \fBtype=\fR\fIvalue\fR .RS 4 -Change the type of the information query. +Change the type of the information query\&. .sp (Default = A; abbreviations = q, ty) .RE .PP \fB \fR\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 \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. +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. +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. +Change the initial timeout interval for waiting for a reply to number seconds\&. .RE .PP \fB \fR\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 \fB \fR\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 -.RE -.IP "" 4 +.sp .RE .SH "FILES" .PP -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf .SH "SEE ALSO" .PP \fBdig\fR(1), \fBhost\fR(1), -\fBnamed\fR(8). +\fBnamed\fR(8)\&. .SH "AUTHOR" .PP -Andrew Cherenson +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2007, 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2004-2007, 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dig/nslookup.docbook b/bin/dig/nslookup.docbook index 022de672b8..aded8b9446 100644 --- a/bin/dig/nslookup.docbook +++ b/bin/dig/nslookup.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2014-01-24 + - January 24, 2014 + ISC + Internet Systems Consortium, Inc. @@ -76,16 +77,16 @@ - + nslookup - - name | - - server + + name | - + server - - DESCRIPTION + DESCRIPTION + Nslookup is a program to query Internet domain name servers. Nslookup has two modes: interactive and non-interactive. Interactive mode allows @@ -95,13 +96,13 @@ used to print just the name and requested information for a host or domain. - + - - ARGUMENTS + ARGUMENTS + Interactive mode is entered in the following cases: - + when no arguments are given (the default name server will be used) @@ -139,10 +140,10 @@ nslookup -query=hinfo -timeout=10 number and immediately exits. - + - - INTERACTIVE COMMANDS + INTERACTIVE COMMANDS + host server @@ -475,16 +476,16 @@ nslookup -query=hinfo -timeout=10 - + - - FILES + FILES + /etc/resolv.conf - + - - SEE ALSO + SEE ALSO + dig1 , @@ -495,16 +496,5 @@ nslookup -query=hinfo -timeout=10 named8 . - - - - Author - - Andrew Cherenson - - - + + diff --git a/bin/dig/nslookup.html b/bin/dig/nslookup.html index 96777b3106..6e333418bd 100644 --- a/bin/dig/nslookup.html +++ b/bin/dig/nslookup.html @@ -13,27 +13,44 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - nslookup - + -
-
-
+
+
+ + + + + +

Name

-

nslookup — query Internet name servers interactively

+

+ nslookup + — query Internet name servers interactively +

-
+ + + +

Synopsis

-

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

-
-
-

DESCRIPTION

-

Nslookup - is a program to query Internet domain name servers. Nslookup +

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

+
+ +
+

DESCRIPTION

+ +

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 domains or to print a list of hosts in a domain. Non-interactive mode @@ -41,29 +58,37 @@ used to print just the name and requested information for a host or domain.

-
-
-

ARGUMENTS

-

+

+ +
+

ARGUMENTS

+ +

Interactive mode is entered in the following cases:

-
    -
  1. +

      +
    1. +

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

    2. -
    3. +

      +
    4. +
    5. +

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

    6. +

      +

    -

    + +

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

    -

    + +

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

    -

    +

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

    -
-
-

INTERACTIVE COMMANDS

-
+ +
+ +
+

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. + options to set. Information about the current default server and host is also printed. -

+

+
class=value
-

+

Change the query class to one of:

-
+
IN
-

+

+

the Internet class -

+

+
CH
-

+

+

the Chaos class -

+

+
HS
-

+

+

the Hesiod class -

+

+
ANY
-

+

+

wildcard -

+

+

The class specifies the protocol group of the information.

-

+

(Default = IN; abbreviation = cl)

- +
[no]debug
-

+

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

-

+

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

-
+
[no]d2
-

+

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

-

+

(Default = nod2)

-
+
domain=name
-

+

+

Sets the search list to name. -

+

+
[no]search
-

+

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

-

+

(Default = search)

-
+
port=value
-

+

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

-

+

(Default = 53; abbreviation = po)

-
+
querytype=value
-

+
+

+
type=value
-

+

Change the type of the information query.

-

+

(Default = A; abbreviations = q, ty)

-
+
[no]recurse
-

+

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

-

+

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

-
+
ndots=number
-

+

+

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

+

+
retry=number
-

+

+

Set the number of retries to number. -

+

+
timeout=number
-

+

+

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

+

+
[no]vc
-

+

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

-

+

(Default = novc)

-
+
[no]fail
-

+

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

-

+

(Default = nofail)

-
+

- +
-
-
-

FILES

-

/etc/resolv.conf +

+ +
+

FILES

+ +

/etc/resolv.conf

-
-
-

SEE ALSO

-

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

+ +
+

SEE ALSO

+ +

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

-
-
-

Author

-

- Andrew Cherenson -

-
+
diff --git a/bin/dnssec/dnssec-dsfromkey.8 b/bin/dnssec/dnssec-dsfromkey.8 index 229433d5fa..531f8a366a 100644 --- a/bin/dnssec/dnssec-dsfromkey.8 +++ b/bin/dnssec/dnssec-dsfromkey.8 @@ -12,24 +12,39 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-dsfromkey +'\" t +.\" Title: dnssec-dsfromkey .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: May 17, 2012 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2012-05-17 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-DSFROMKEY" "8" "May 17, 2012" "BIND9" "BIND9" +.TH "DNSSEC\-DSFROMKEY" "8" "2012\-05\-17" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-dsfromkey \- DNSSEC DS RR generation tool +dnssec-dsfromkey \- DNSSEC DS RR generation tool .SH "SYNOPSIS" .HP 17 \fBdnssec\-dsfromkey\fR [\fB\-v\ \fR\fB\fIlevel\fR\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] {keyfile} @@ -40,135 +55,136 @@ dnssec\-dsfromkey \- DNSSEC DS RR generation tool .SH "DESCRIPTION" .PP \fBdnssec\-dsfromkey\fR -outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s). +outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s)\&. .SH "OPTIONS" .PP \-1 .RS 4 -Use SHA\-1 as the digest algorithm (the default is to use both SHA\-1 and SHA\-256). +Use SHA\-1 as the digest algorithm (the default is to use both SHA\-1 and SHA\-256)\&. .RE .PP \-2 .RS 4 -Use SHA\-256 as the digest algorithm. +Use SHA\-256 as the digest algorithm\&. .RE .PP \-a \fIalgorithm\fR .RS 4 -Select the digest algorithm. The value of +Select the digest algorithm\&. The value of \fBalgorithm\fR -must be one of SHA\-1 (SHA1), SHA\-256 (SHA256), GOST or SHA\-384 (SHA384). These values are case insensitive. +must be one of SHA\-1 (SHA1), SHA\-256 (SHA256), GOST or SHA\-384 (SHA384)\&. These values are case insensitive\&. .RE .PP \-C .RS 4 -Generate CDS records rather than DS records. This is mutually exclusive with generating lookaside records. +Generate CDS records rather than DS records\&. This is mutually exclusive with generating lookaside records\&. .RE .PP \-T \fITTL\fR .RS 4 -Specifies the TTL of the DS records. +Specifies the TTL of the DS records\&. .RE .PP \-K \fIdirectory\fR .RS 4 Look for key files (or, in keyset mode, -\fIkeyset\-\fR +keyset\- files) in -\fBdirectory\fR. +\fBdirectory\fR\&. .RE .PP \-f \fIfile\fR .RS 4 Zone file mode: in place of the keyfile name, the argument is the DNS domain name of a zone master file, which can be read from -\fBfile\fR. If the zone name is the same as -\fBfile\fR, then it may be omitted. +\fBfile\fR\&. If the zone name is the same as +\fBfile\fR, then it may be omitted\&. .sp If \fBfile\fR is set to -"\-", then the zone data is read from the standard input. This makes it possible to use the output of the +"\-", 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 +\fBdig dnskey example\&.com | dnssec\-dsfromkey \-f \- example\&.com\fR .RE .PP \-A .RS 4 -Include ZSK's when generating DS records. Without this option, only keys which have the KSK flag set will be converted to DS records and printed. Useful only in zone file mode. +Include ZSK\*(Aqs when generating DS records\&. Without this option, only keys which have the KSK flag set will be converted to DS records and printed\&. Useful only in zone file mode\&. .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 \fBdomain\fR -is appended to the name for each record in the set. The DNSSEC Lookaside Validation (DLV) RR is described in RFC 4431. This is mutually exclusive with generating CDS records. +is appended to the name for each record in the set\&. The DNSSEC Lookaside Validation (DLV) RR is described in RFC 4431\&. This is mutually exclusive with generating CDS records\&. .RE .PP \-s .RS 4 -Keyset mode: in place of the keyfile name, the argument is the DNS domain name of a keyset file. +Keyset mode: in place of the keyfile name, the argument is the DNS domain name of a keyset file\&. .RE .PP \-c \fIclass\fR .RS 4 -Specifies the DNS class (default is IN). Useful only in keyset or zone file mode. +Specifies the DNS class (default is IN)\&. Useful only in keyset or zone file mode\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-h .RS 4 -Prints usage information. +Prints usage information\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .SH "EXAMPLE" .PP To build the SHA\-256 DS RR from the -\fBKexample.com.+003+26160\fR +\fBKexample\&.com\&.+003+26160\fR keyfile name, the following command would be issued: .PP -\fBdnssec\-dsfromkey \-2 Kexample.com.+003+26160\fR +\fBdnssec\-dsfromkey \-2 Kexample\&.com\&.+003+26160\fR .PP The command would print something like: .PP -\fBexample.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94\fR +\fBexample\&.com\&. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94\fR .SH "FILES" .PP The keyfile can be designed by the key identification -\fIKnnnn.+aaa+iiiii\fR +Knnnn\&.+aaa+iiiii or the full file name -\fIKnnnn.+aaa+iiiii.key\fR +Knnnn\&.+aaa+iiiii\&.key as generated by -dnssec\-keygen(8). +dnssec\-keygen(8)\&. .PP The keyset file name is built from the \fBdirectory\fR, the string -\fIkeyset\-\fR +keyset\- and the -\fBdnsname\fR. +\fBdnsname\fR\&. .SH "CAVEAT" .PP -A keyfile error can give a "file not found" even if the file exists. +A keyfile error can give a "file not found" even if the file exists\&. .SH "SEE ALSO" .PP -\fBdnssec\-keygen\fR(8), -\fBdnssec\-signzone\fR(8), +\fBdnssec-keygen\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, RFC 3658, -RFC 4431. -RFC 4509. +RFC 4431\&. +RFC 4509\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2008\-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-dsfromkey.docbook b/bin/dnssec/dnssec-dsfromkey.docbook index 1127fa04e8..fc29ca9564 100644 --- a/bin/dnssec/dnssec-dsfromkey.docbook +++ b/bin/dnssec/dnssec-dsfromkey.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2012-05-17 + - May 17, 2012 + ISC + Internet Systems Consortium, Inc. @@ -47,50 +48,50 @@ - + dnssec-dsfromkey - - - - - - - - keyfile + + + + + + + + keyfile - + dnssec-dsfromkey - -s - - - - - - - - - - - - dnsname + -s + + + + + + + + + + + + dnsname - + dnssec-dsfromkey - - + + - - DESCRIPTION + DESCRIPTION + dnssec-dsfromkey outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s). - + - - OPTIONS + OPTIONS + @@ -247,10 +248,10 @@ - + - - EXAMPLE + EXAMPLE + To build the SHA-256 DS RR from the Kexample.com.+003+26160 @@ -263,10 +264,10 @@ example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94 - + - - FILES + FILES + The keyfile can be designed by the key identification Knnnn.+aaa+iiiii or the full file name @@ -278,17 +279,17 @@ the string keyset- and the . - + - - CAVEAT + CAVEAT + A keyfile error can give a "file not found" even if the file exists. - + - - SEE ALSO + SEE ALSO + dnssec-keygen8 , @@ -300,16 +301,6 @@ RFC 4431. RFC 4509. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/dnssec/dnssec-dsfromkey.html b/bin/dnssec/dnssec-dsfromkey.html index 13e9cc5342..37af0340e0 100644 --- a/bin/dnssec/dnssec-dsfromkey.html +++ b/bin/dnssec/dnssec-dsfromkey.html @@ -13,172 +13,250 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-dsfromkey - + -
+
-
+ + + + + +

Name

-

dnssec-dsfromkey — DNSSEC DS RR generation tool

+

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

-
+ + + +

Synopsis

-

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

-

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

-

dnssec-dsfromkey [-h] [-V]

-
-
-

DESCRIPTION

-

dnssec-dsfromkey +

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

+

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

+

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

+
+ +
+

DESCRIPTION

+ +

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

-
-
-

OPTIONS

-
+
+ +
+

OPTIONS

+ + +
-1
-

+

+

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

+

+
-2
-

+

+

Use SHA-256 as the digest algorithm. -

+

+
-a algorithm
-

+

+

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

+

+
-C
-

+

+

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

+

+
-T TTL
-

+

+

Specifies the TTL of the DS records. -

+

+
-K directory
-

+

+

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

+

+
-f file
-

+

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

-

+

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

-

+

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

-
+
-A
-

+

+

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

+

+
-l domain
-

+

+

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

+

+
-s
-

+

+

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

+

+
-c class
-

+

+

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

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-h
-

+

+

Prints usage information. -

+

+
-V
-

+

+

Prints version information. -

+

+
-
-
-

EXAMPLE

-

+

+ +
+

EXAMPLE

+ +

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

-

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

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

-

+

The command would print something like:

-

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

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

-
-
-

FILES

-

+

+ +
+

FILES

+ +

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

-

+

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

-
-
-

CAVEAT

-

+

+ +
+

CAVEAT

+ +

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

-
-
-

SEE ALSO

-

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

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/dnssec/dnssec-importkey.8 b/bin/dnssec/dnssec-importkey.8 index 225077da08..e2ca62ab7b 100644 --- a/bin/dnssec/dnssec-importkey.8 +++ b/bin/dnssec/dnssec-importkey.8 @@ -1,35 +1,50 @@ -.\" Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC") -.\" +.\" Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-importkey +'\" t +.\" Title: dnssec-importkey .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: February 07, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2014-02-07 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-IMPORTKEY" "8" "February 07, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-IMPORTKEY" "8" "2014\-02\-07" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "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\&. .SH "SYNOPSIS" .HP 17 \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\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-h\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] {\fBkeyfile\fR} @@ -38,83 +53,84 @@ dnssec\-importkey \- Import DNSKEY records from external systems so they can be .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. +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 -The newly\-created .private file does +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. +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 \-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 -\fBfile\fR. If the domain name is the same as -\fBfile\fR, then it may be omitted. +\fBfile\fR\&. If the domain name is the same as +\fBfile\fR, then it may be omitted\&. .sp If \fBfile\fR is set to -"\-", then the zone data is read from the standard input. +"\-", then the zone data is read from the standard input\&. .RE .PP \-K \fIdirectory\fR .RS 4 -Sets the directory in which the key files are to reside. +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. +removes it\&. .RE .PP \-h .RS 4 -Emit usage message and exit. +Emit usage message and exit\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .SH "TIMING OPTIONS" .PP -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 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', 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 'none' or 'never'. +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 \-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. +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 \-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.) +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 .SH "FILES" .PP A keyfile can be designed by the key identification -\fIKnnnn.+aaa+iiiii\fR +Knnnn\&.+aaa+iiiii or the full file name -\fIKnnnn.+aaa+iiiii.key\fR +Knnnn\&.+aaa+iiiii\&.key as generated by -dnssec\-keygen(8). +dnssec\-keygen(8)\&. .SH "SEE ALSO" .PP -\fBdnssec\-keygen\fR(8), -\fBdnssec\-signzone\fR(8), +\fBdnssec-keygen\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, -RFC 5011. +RFC 5011\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2013, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-importkey.docbook b/bin/dnssec/dnssec-importkey.docbook index 5893abd270..9cd4a2993a 100644 --- a/bin/dnssec/dnssec-importkey.docbook +++ b/bin/dnssec/dnssec-importkey.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2014-02-07 + - February 07, 2014 + ISC + Internet Systems Consortium, Inc. @@ -42,33 +43,33 @@ - + dnssec-importkey - - - - - - - - + + + + + + + + - + dnssec-importkey - - - - - - - - - + + + + + + + + + - - DESCRIPTION + DESCRIPTION + dnssec-importkey reads a public DNSKEY record and generates a pair of .key/.private files. The DNSKEY record may be read from an @@ -86,10 +87,10 @@ public key can be added to and removed from the DNSKEY RRset on schedule even if the true private key is stored offline. - + - - OPTIONS + OPTIONS + @@ -159,10 +160,10 @@ - + - - TIMING OPTIONS + TIMING OPTIONS + Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as @@ -199,20 +200,20 @@ - + - - FILES + 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-keygen8. - + - - SEE ALSO + SEE ALSO + dnssec-keygen8 , @@ -222,16 +223,6 @@ BIND 9 Administrator Reference Manual, RFC 5011. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/dnssec/dnssec-importkey.html b/bin/dnssec/dnssec-importkey.html index 90f13f295b..5f9f9c46e0 100644 --- a/bin/dnssec/dnssec-importkey.html +++ b/bin/dnssec/dnssec-importkey.html @@ -1,40 +1,72 @@ - - dnssec-importkey - + -
+
-
+ + + + + +

Name

-

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

+

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

-
+ + + +

Synopsis

-

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

-

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

-
-
-

DESCRIPTION

-

dnssec-importkey +

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

+

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

+
+ +
+

DESCRIPTION

+ +

dnssec-importkey 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 @@ -42,7 +74,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 @@ -51,53 +83,68 @@ public key can be added to and removed from the DNSKEY RRset on schedule even if the true private key is stored offline.

-
-
-

OPTIONS

-
+
+ +
+

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

-

+

+ +
+

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 @@ -108,42 +155,51 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

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

+

+
-D date/offset
-

+

+

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

+

+
-
-
-

FILES

-

+

+ +
+

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), +

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/dnssec/dnssec-keyfromlabel.8 b/bin/dnssec/dnssec-keyfromlabel.8 index 24da7c4d9d..dd5708704c 100644 --- a/bin/dnssec/dnssec-keyfromlabel.8 +++ b/bin/dnssec/dnssec-keyfromlabel.8 @@ -12,237 +12,277 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-keyfromlabel +'\" t +.\" Title: dnssec-keyfromlabel .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: February 27, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2014-02-27 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-KEYFROMLABEL" "8" "February 27, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-KEYFROMLABEL" "8" "2014\-02\-27" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-keyfromlabel \- DNSSEC key generation tool +dnssec-keyfromlabel \- DNSSEC key generation tool .SH "SYNOPSIS" .HP 20 \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\-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\ \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. +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 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. +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 \-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 or ECDSAP384SHA384. These values are case insensitive. +must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384\&. These values are case insensitive\&. .sp 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 +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.) +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. +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. +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 name of the crypto hardware (OpenSSL engine). When compiled with PKCS#11 support it defaults to "pkcs11". +Specifies the name of the crypto hardware (OpenSSL engine)\&. When compiled with PKCS#11 support it defaults to "pkcs11"\&. .RE .PP \-l \fIlabel\fR .RS 4 -Specifies the label of the key pair in the crypto hardware. The label may be preceded by an optional OpenSSL engine name, separated by a colon, as in "pkcs11:keylabel". +Specifies the label of the key pair in the crypto hardware\&. The label may be preceded by an optional OpenSSL engine name, separated by a colon, as in "pkcs11:keylabel"\&. .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. +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 \-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's 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 +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. +option suppresses them\&. .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. +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. +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. +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 -\fBdnssec\-keyfromlabel\fR. +\fBdnssec\-keyfromlabel\fR\&. .RE .PP \-K \fIdirectory\fR .RS 4 -Sets the directory in which the key files are to be written. +Sets the directory in which the key files are to be written\&. .RE .PP \-k .RS 4 -Generate KEY records rather than DNSKEY records. +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. +removes it\&. .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. +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. +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. +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 \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-V .RS 4 -Prints version information. +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't be using RFC 5011 trust anchor maintenance with either of the keys involved.) +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 '+' or '\-', it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', 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 'none' or 'never'. +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 \-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". +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 \-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". +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. +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. +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.) +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 \-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't, 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't, 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 '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. +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 -\fIKnnnn.+aaa+iiiii\fR -to the standard output. This is an identification string for the key files it has generated. -.TP 4 -\(bu -\fInnnn\fR -is the key name. -.TP 4 -\(bu -\fIaaa\fR -is the numeric representation of the algorithm. -.TP 4 -\(bu -\fIiiiii\fR -is the key identifier (or footprint). +Knnnn\&.+aaa+iiiii +to the standard output\&. This is an identification string for the key files it has generated\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +nnnn +is the key name\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +aaa +is the numeric representation of the algorithm\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +iiiii +is the key identifier (or footprint)\&. +.RE .PP \fBdnssec\-keyfromlabel\fR -creates two files, with names based on the printed string. -\fIKnnnn.+aaa+iiiii.key\fR +creates two files, with names based on the printed string\&. +Knnnn\&.+aaa+iiiii\&.key contains the public key, and -\fIKnnnn.+aaa+iiiii.private\fR -contains the private key. +Knnnn\&.+aaa+iiiii\&.private +contains the private key\&. .PP The -\fI.key\fR -file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement). +\&.key +file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement)\&. .PP The -\fI.private\fR -file contains algorithm\-specific fields. For obvious security reasons, this file does not have general read permission. +\&.private +file contains algorithm\-specific fields\&. For obvious security reasons, this file does not have general read permission\&. .SH "SEE ALSO" .PP -\fBdnssec\-keygen\fR(8), -\fBdnssec\-signzone\fR(8), +\fBdnssec-keygen\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, -RFC 4034. +RFC 4034\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2008\-2012, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2008-2012, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-keyfromlabel.docbook b/bin/dnssec/dnssec-keyfromlabel.docbook index a47c95589f..12a1ed92cf 100644 --- a/bin/dnssec/dnssec-keyfromlabel.docbook +++ b/bin/dnssec/dnssec-keyfromlabel.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2014-02-27 + - February 27, 2014 + ISC + Internet Systems Consortium, Inc. @@ -46,37 +47,37 @@ - + dnssec-keyfromlabel - -l label - - - - - - - - - - - - - - - - - - - - - - - name + -l label + + + + + + + + + + + + + + + + + + + + + + + name - - DESCRIPTION + DESCRIPTION + dnssec-keyfromlabel generates a key pair of files that referencing a key object stored in a cryptographic hardware service module (HSM). The private key @@ -90,10 +91,10 @@ line. This must match the name of the zone for which the key is being generated. - + - - OPTIONS + OPTIONS + @@ -328,10 +329,10 @@ - + - - TIMING OPTIONS + TIMING OPTIONS + Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. @@ -431,10 +432,10 @@ - + - - GENERATED KEY FILES + GENERATED KEY FILES + When dnssec-keyfromlabel completes successfully, @@ -477,10 +478,10 @@ fields. For obvious security reasons, this file does not have general read permission. - + - - SEE ALSO + SEE ALSO + dnssec-keygen8 , @@ -490,16 +491,6 @@ BIND 9 Administrator Reference Manual, RFC 4034. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/dnssec/dnssec-keyfromlabel.html b/bin/dnssec/dnssec-keyfromlabel.html index 36971c466a..5adb9253b8 100644 --- a/bin/dnssec/dnssec-keyfromlabel.html +++ b/bin/dnssec/dnssec-keyfromlabel.html @@ -13,149 +13,217 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-keyfromlabel - + -
+
-
+ + + + + +

Name

-

dnssec-keyfromlabel — DNSSEC key generation tool

+

+ dnssec-keyfromlabel + — DNSSEC key generation tool +

-
+ + + +

Synopsis

-

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

-
-
-

DESCRIPTION

-

dnssec-keyfromlabel +

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

+
+ +
+

DESCRIPTION

+ +

dnssec-keyfromlabel 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 dnssec-keygen, + conventional signing key created by dnssec-keygen, 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

-
+
+ +
+

OPTIONS

+ + +
-a algorithm
-

+

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

-

+

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

-

+

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

-

+

Note 2: DH automatically sets the -k flag.

-
+
-3
-

+

+

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

+

+
-E engine
-

+

+

Specifies the name of the crypto hardware (OpenSSL engine). When compiled with PKCS#11 support it defaults to "pkcs11". -

+

+
-l label
-

+

+

Specifies the label of the key pair in the crypto hardware. The label may be preceded by an optional OpenSSL engine name, separated by a colon, as in "pkcs11:keylabel". -

+

+
-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 + any metadata. By default, dnssec-keyfromlabel will include the key's 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 -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. -

+ 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 @@ -163,35 +231,47 @@ one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. -

+

+
-t type
-

+

+

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

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-y
-

+

+

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

+

+
-
-
-

TIMING OPTIONS

-

+

+ +
+

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 @@ -202,42 +282,53 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

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

+

+
-A date/offset
-

+

+

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

+

+
-R date/offset
-

+

+

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

+

+
-I date/offset
-

+

+

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

+

+
-D date/offset
-

+

+

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

+

+
-i interval
-

+

Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the @@ -246,72 +337,82 @@ 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 +

+ +
+

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), +

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/dnssec/dnssec-keygen.8 b/bin/dnssec/dnssec-keygen.8 index 2cd5d76ff5..38b4c32449 100644 --- a/bin/dnssec/dnssec-keygen.8 +++ b/bin/dnssec/dnssec-keygen.8 @@ -13,301 +13,341 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-keygen +'\" t +.\" Title: dnssec-keygen .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: February 07, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2014-02-07 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-KEYGEN" "8" "February 07, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-KEYGEN" "8" "2014\-02\-07" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-keygen \- DNSSEC key generation tool +dnssec-keygen \- DNSSEC key generation tool .SH "SYNOPSIS" .HP 14 \fBdnssec\-keygen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-n\ \fR\fB\fInametype\fR\fR] [\fB\-3\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-C\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-D\ \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\-L\ \fR\fB\fIttl\fR\fR] [\fB\-k\fR] [\fB\-P\ \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\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-z\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. +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 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. +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 \-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 or ECDSAP384SHA384. 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. +must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384\&. 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 \fB\-3\fR -option is specified, in which case NSEC3RSASHA1 will be used instead. (If +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.) +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. +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't 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 (ZSK's) and 2048 bits for key signing keys (KSK's, generated with -\fB\-f KSK\fR). However, if an algorithm is explicitly specified with the +The key size does not need to be specified if using a default algorithm\&. The default key size is 1024 bits for zone signing keys (ZSK\*(Aqs) and 2048 bits for key signing keys (KSK\*(Aqs, 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. +must be used\&. .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. +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 \-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. Note that RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 and ECDSAP384SHA384 algorithms are NSEC3\-capable. +Use an NSEC3\-capable algorithm to generate a DNSSEC key\&. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default\&. Note that RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 and ECDSAP384SHA384 algorithms are NSEC3\-capable\&. .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\-keygen\fR -will include the key's 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 +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. +option suppresses them\&. .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. +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 -Uses a crypto hardware (OpenSSL engine) for random number and, when supported, key generation. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. +Uses a crypto hardware (OpenSSL engine) for random number and, when supported, key generation\&. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine\&. .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. +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. +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. +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 -\fBdnssec\-keygen\fR. +\fBdnssec\-keygen\fR\&. .RE .PP \-K \fIdirectory\fR .RS 4 -Sets the directory in which the key files are to be written. +Sets the directory in which the key files are to be written\&. .RE .PP \-k .RS 4 -Deprecated in favor of \-T KEY. +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. +is the same as leaving it unset\&. .RE .PP \-p \fIprotocol\fR .RS 4 -Sets the protocol value for the generated key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in RFC 2535 and its successors. +Sets the protocol value for the generated key\&. The protocol is a number between 0 and 255\&. The default is 3 (DNSSEC)\&. Other possible values for this argument are listed in RFC 2535 and its successors\&. .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 -\fIstderr\fR -indicating the progress of the key generation. A '.' indicates that a random number has been found which passed an initial sieve test; '+' 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. +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 \-r \fIrandomdev\fR .RS 4 -Specifies the source of randomness. If the operating system does not provide a -\fI/dev/random\fR -or equivalent device, the default source of randomness is keyboard input. -\fIrandomdev\fR -specifies the name of a character device or file containing random data to be used instead of the default. The special value -\fIkeyboard\fR -indicates that keyboard input should be used. +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 \-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. +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. +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. +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 \-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. +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 \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .SH "TIMING OPTIONS" .PP -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 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', 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 'none' or 'never'. +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 \-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". +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 \-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. +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. +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. +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.) +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 \-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't, 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't, 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 '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. +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 -\fIKnnnn.+aaa+iiiii\fR -to the standard output. This is an identification string for the key it has generated. -.TP 4 -\(bu -\fInnnn\fR -is the key name. -.TP 4 -\(bu -\fIaaa\fR -is the numeric representation of the algorithm. -.TP 4 -\(bu -\fIiiiii\fR -is the key identifier (or footprint). +Knnnn\&.+aaa+iiiii +to the standard output\&. This is an identification string for the key it has generated\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +nnnn +is the key name\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +aaa +is the numeric representation of the algorithm\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +iiiii +is the key identifier (or footprint)\&. +.RE .PP \fBdnssec\-keygen\fR -creates two files, with names based on the printed string. -\fIKnnnn.+aaa+iiiii.key\fR +creates two files, with names based on the printed string\&. +Knnnn\&.+aaa+iiiii\&.key contains the public key, and -\fIKnnnn.+aaa+iiiii.private\fR -contains the private key. +Knnnn\&.+aaa+iiiii\&.private +contains the private key\&. .PP The -\fI.key\fR -file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement). +\&.key +file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement)\&. .PP The -\fI.private\fR -file contains algorithm\-specific fields. For obvious security reasons, this file does not have general read permission. +\&.private +file contains algorithm\-specific fields\&. For obvious security reasons, this file does not have general read permission\&. .PP Both -\fI.key\fR +\&.key and -\fI.private\fR -files are generated for symmetric encryption algorithms such as HMAC\-MD5, even though the public and private key are equivalent. +\&.private +files are generated for symmetric encryption algorithms such as HMAC\-MD5, even though the public and private key are equivalent\&. .SH "EXAMPLE" .PP To generate a 768\-bit DSA key for the domain -\fBexample.com\fR, the following command would be issued: +\fBexample\&.com\fR, the following command would be issued: .PP -\fBdnssec\-keygen \-a DSA \-b 768 \-n ZONE example.com\fR +\fBdnssec\-keygen \-a DSA \-b 768 \-n ZONE example\&.com\fR .PP The command would print a string of the form: .PP -\fBKexample.com.+003+26160\fR +\fBKexample\&.com\&.+003+26160\fR .PP In this example, \fBdnssec\-keygen\fR creates the files -\fIKexample.com.+003+26160.key\fR +Kexample\&.com\&.+003+26160\&.key and -\fIKexample.com.+003+26160.private\fR. +Kexample\&.com\&.+003+26160\&.private\&. .SH "SEE ALSO" .PP -\fBdnssec\-signzone\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, RFC 2539, RFC 2845, -RFC 4034. +RFC 4034\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004, 2005, 2007\-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2003 Internet Software Consortium. +Copyright \(co 2004, 2005, 2007-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2003 Internet Software Consortium. .br diff --git a/bin/dnssec/dnssec-keygen.docbook b/bin/dnssec/dnssec-keygen.docbook index 472575f0d0..6754583589 100644 --- a/bin/dnssec/dnssec-keygen.docbook +++ b/bin/dnssec/dnssec-keygen.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2014-02-07 + - February 07, 2014 + ISC + Internet Systems Consortium, Inc. @@ -58,43 +59,43 @@ - + dnssec-keygen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + name - - DESCRIPTION + DESCRIPTION + dnssec-keygen generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034. It can also generate keys for use with @@ -106,10 +107,10 @@ line. For DNSSEC keys, this must match the name of the zone for which the key is being generated. - + - - OPTIONS + OPTIONS + @@ -431,10 +432,10 @@ - + - - TIMING OPTIONS + TIMING OPTIONS + Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. @@ -536,11 +537,11 @@ - + - - GENERATED KEYS + GENERATED KEYS + When dnssec-keygen completes successfully, @@ -590,10 +591,10 @@ files are generated for symmetric encryption algorithms such as HMAC-MD5, even though the public and private key are equivalent. - + - - EXAMPLE + EXAMPLE + To generate a 768-bit DSA key for the domain example.com, the following command would be @@ -612,10 +613,10 @@ and Kexample.com.+003+26160.private. - + - - SEE ALSO + SEE ALSO + dnssec-signzone8 , @@ -624,16 +625,6 @@ RFC 2845, RFC 4034. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/dnssec/dnssec-keygen.html b/bin/dnssec/dnssec-keygen.html index 9cf62ebc76..eb4a9e5cfa 100644 --- a/bin/dnssec/dnssec-keygen.html +++ b/bin/dnssec/dnssec-keygen.html @@ -14,43 +14,90 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-keygen - + -
+
-
+ + + + + +

Name

-

dnssec-keygen — DNSSEC key generation tool

+

+ dnssec-keygen + — DNSSEC key generation tool +

-
+ + + +

Synopsis

-

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

-
-
-

DESCRIPTION

-

dnssec-keygen +

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

+
+ +
+

DESCRIPTION

+ +

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

-
+
+ +
+

OPTIONS

+ + +
-a algorithm
-

+

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

-

+

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

-

+

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

-

+

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

-
+
-b keysize
-

+

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

-

+

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

-
+
-n nametype
-

+

+

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

+

+
-3
-

+

+

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

+

+
-C
-

+

+

Compatibility mode: generates an old-style key, without - any metadata. By default, dnssec-keygen + any metadata. By default, dnssec-keygen will include the key's 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 -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
-

+

+

Uses a crypto hardware (OpenSSL engine) for random number and, when supported, key generation. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. -

+

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

+ 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 @@ -179,19 +249,23 @@ is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to 0 or none is the same as leaving it unset. -

+

+
-p protocol
-

+

+

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

+

+
-q
-

+

+

Quiet mode: Suppresses unnecessary output, including progress indication. Without this option, when - dnssec-keygen is run interactively + dnssec-keygen 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 '.' indicates that a @@ -200,9 +274,11 @@ round of the Miller-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key. -

+

+
-r randomdev
-

+

+

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

+

+
-S key
-

+

+

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

+

+
-s strength
-

+

+

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

+

+
-T rrtype
-

+

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

-
+
-t type
-

+

+

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

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-V
-

+

+

Prints version information. -

+

+
-
-
-

TIMING OPTIONS

-

+

+ +
+

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 @@ -274,44 +364,55 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

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

+

+
-A date/offset
-

+

+

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

+

+
-R date/offset
-

+

+

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

+

+
-I date/offset
-

+

+

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

+

+
-D date/offset
-

+

+

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

+

+
-i interval
-

+

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

-

+

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

-

+

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

-
+
-
-
-

GENERATED KEYS

-

- When dnssec-keygen completes +

+ + +
+

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 @@ -363,58 +473,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 encryption algorithms such as HMAC-MD5, even though the public and private key are equivalent.

    -
-
-

EXAMPLE

-

+

+ +
+

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 +

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

-
-
-

SEE ALSO

-

dnssec-signzone(8), +

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/dnssec/dnssec-revoke.8 b/bin/dnssec/dnssec-revoke.8 index eb87545575..d53faa56ab 100644 --- a/bin/dnssec/dnssec-revoke.8 +++ b/bin/dnssec/dnssec-revoke.8 @@ -12,82 +12,95 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-revoke -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: October 20, 2011 +'\" t +.\" Title: dnssec-revoke +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2011-10-20 .\" Manual: BIND9 .\" Source: BIND9 +.\" Language: English .\" -.TH "DNSSEC\-REVOKE" "8" "October 20, 2011" "BIND9" "BIND9" +.TH "DNSSEC\-REVOKE" "8" "2011\-10\-20" "BIND9" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-revoke \- Set the REVOKED bit on a DNSSEC key +dnssec-revoke \- Set the REVOKED bit on a DNSSEC key .SH "SYNOPSIS" .HP 14 \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. +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 \-h .RS 4 -Emit usage message and exit. +Emit usage message and exit\&. .RE .PP \-K \fIdirectory\fR .RS 4 -Sets the directory in which the key files are to reside. +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. +After writing the new keyset files remove the original keyset files\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .PP \-E \fIengine\fR .RS 4 -Use the given OpenSSL engine. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. +Use the given OpenSSL engine\&. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine\&. .RE .PP \-f .RS 4 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. +to write the new key pair even if a file already exists matching the algorithm and key ID of the revoked key\&. .RE .PP \-R .RS 4 -Print the key tag of the key with the REVOKE bit set but do not revoke the key. +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), +\fBdnssec-keygen\fR(8), BIND 9 Administrator Reference Manual, -RFC 5011. -.SH "AUTHOR" -.PP -Internet Systems Consortium +RFC 5011\&. .SH "COPYRIGHT" +.br Copyright \(co 2009, 2011, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-revoke.docbook b/bin/dnssec/dnssec-revoke.docbook index 85463d682c..71109dee8c 100644 --- a/bin/dnssec/dnssec-revoke.docbook +++ b/bin/dnssec/dnssec-revoke.docbook @@ -1,6 +1,3 @@ -]> - - - - October 20, 2011 - + + + + 2011-10-20 + dnssec-revoke @@ -43,30 +40,30 @@ - + dnssec-revoke - - - - - - - - keyfile + + + + + + + + keyfile - - DESCRIPTION + DESCRIPTION + 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 + OPTIONS + @@ -146,26 +143,16 @@ - + - - SEE ALSO + SEE ALSO + dnssec-keygen8 , BIND 9 Administrator Reference Manual, RFC 5011. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/dnssec/dnssec-revoke.html b/bin/dnssec/dnssec-revoke.html index d09b7dcd37..990cff49fb 100644 --- a/bin/dnssec/dnssec-revoke.html +++ b/bin/dnssec/dnssec-revoke.html @@ -13,84 +13,124 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-revoke - + -
+
-
+ + + + +

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}

-
-
-

DESCRIPTION

-

dnssec-revoke +

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

+
+ +
+

DESCRIPTION

+ +

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

-
+
+ +
+

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
-

+

+

Use the given OpenSSL engine. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. -

+

+
-f
-

- Force overwrite: Causes dnssec-revoke to +

+

+ 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), +

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/dnssec/dnssec-settime.8 b/bin/dnssec/dnssec-settime.8 index 821e4db990..5b889d2517 100644 --- a/bin/dnssec/dnssec-settime.8 +++ b/bin/dnssec/dnssec-settime.8 @@ -12,24 +12,39 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-settime +'\" t +.\" Title: dnssec-settime .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: February 07, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2014-02-07 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-SETTIME" "8" "February 07, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-SETTIME" "8" "2014\-02\-07" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-settime \- Set the key timing metadata for a DNSSEC key +dnssec-settime \- Set the key timing metadata for a DNSSEC key .SH "SYNOPSIS" .HP 15 \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\-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\-h\fR] [\fB\-V\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] {keyfile} @@ -42,114 +57,114 @@ reads a DNSSEC private key file and sets the key timing metadata as specified by \fB\-R\fR, \fB\-I\fR, and \fB\-D\fR -options. The metadata can then be used 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. +or other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc\&. .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. +simply prints the key timing metadata already stored in the key\&. .PP -When key metadata fields are changed, both files of a key pair (\fIKnnnn.+aaa+iiiii.key\fR +When key metadata fields are changed, both files of a key pair (Knnnn\&.+aaa+iiiii\&.key and -\fIKnnnn.+aaa+iiiii.private\fR) 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's permissions are always set to be inaccessible to anyone other than the owner (mode 0600). +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 \-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's creation date will be 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. +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 \-K \fIdirectory\fR .RS 4 -Sets the directory in which the key files are to reside. +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. +removes it from the key\&. .RE .PP \-h .RS 4 -Emit usage message and exit. +Emit usage message and exit\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-E \fIengine\fR .RS 4 -Use the given OpenSSL engine. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. +Use the given OpenSSL engine\&. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine\&. .RE .SH "TIMING OPTIONS" .PP -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 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', 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 'none' or 'never'. +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 \-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. +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 \-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. +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. +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. +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.) +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 \-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. +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't, 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't, 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 '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. +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. +can also be used to print the timing metadata associated with a key\&. .PP \-u .RS 4 -Print times in UNIX epoch format. +Print times in UNIX epoch format\&. .RE .PP \-p \fIC/P/A/R/I/D/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 to indicate which value or values to print: \fBC\fR @@ -163,18 +178,19 @@ for the revocation date, \fBI\fR for the inactivation date, or \fBD\fR -for the deletion date. To print all of the metadata, use -\fB\-p all\fR. +for the deletion date\&. To print all of the metadata, use +\fB\-p all\fR\&. .RE .SH "SEE ALSO" .PP -\fBdnssec\-keygen\fR(8), -\fBdnssec\-signzone\fR(8), +\fBdnssec-keygen\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, -RFC 5011. +RFC 5011\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2009\-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2009-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-settime.docbook b/bin/dnssec/dnssec-settime.docbook index 942f1889cf..ccde27fb49 100644 --- a/bin/dnssec/dnssec-settime.docbook +++ b/bin/dnssec/dnssec-settime.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2014-02-07 + - February 07, 2014 + ISC + Internet Systems Consortium, Inc. @@ -45,26 +46,26 @@ - + dnssec-settime - - - - - - - - - - - - - keyfile + + + + + + + + + + + + + keyfile - - DESCRIPTION + DESCRIPTION + dnssec-settime reads a DNSSEC private key file and sets the key timing metadata as specified by the , , @@ -88,10 +89,10 @@ file. The private file's permissions are always set to be inaccessible to anyone other than the owner (mode 0600). - + - - OPTIONS + OPTIONS + @@ -172,10 +173,10 @@ - + - - TIMING OPTIONS + TIMING OPTIONS + Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as @@ -285,10 +286,10 @@ - + - - PRINTING OPTIONS + PRINTING OPTIONS + dnssec-settime can also be used to print the timing metadata associated with a key. @@ -323,10 +324,10 @@ - + - - SEE ALSO + SEE ALSO + dnssec-keygen8 , @@ -336,16 +337,6 @@ BIND 9 Administrator Reference Manual, RFC 5011. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/dnssec/dnssec-settime.html b/bin/dnssec/dnssec-settime.html index 0132e07cee..6173b737a1 100644 --- a/bin/dnssec/dnssec-settime.html +++ b/bin/dnssec/dnssec-settime.html @@ -13,40 +13,67 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-settime - + -
+
-
+ + + + + +

Name

-

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

+

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

-
+ + + +

Synopsis

-

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

-
-
-

DESCRIPTION

-

dnssec-settime +

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

+
+ +
+

DESCRIPTION

+ +

dnssec-settime reads a DNSSEC private key file and sets the key timing metadata as specified by the -P, -A, -R, -I, and -D options. The metadata can then be used by - dnssec-signzone or other signing software to + dnssec-signzone or other signing software to 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 + then dnssec-settime simply prints the key timing metadata already stored in the key.

-

+

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

-
-
-

OPTIONS

-
+
+ +
+

OPTIONS

+ + +
-f
-

+

+

Force an update of an old-format key with no metadata fields. - Without this option, dnssec-settime will + Without this option, dnssec-settime 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's creation date will be set to the present time. If no other values are specified, then the key's publication and activation dates will also be set to the present time. -

+

+
-K directory
-

+

+

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

+

+
-L ttl
-

+

+

Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was @@ -84,29 +119,40 @@ 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
-

+

+

Use the given OpenSSL engine. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. -

+

+
-
-
-

TIMING OPTIONS

-

+

+ +
+

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 @@ -116,39 +162,51 @@ days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To unset a date, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

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

+

+
-A date/offset
-

+

+

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

+

+
-R date/offset
-

+

+

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

+

+
-I date/offset
-

+

+

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

+

+
-D date/offset
-

+

+

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

+

+
-S predecessor key
-

+

+

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

+

+
-i interval
-

+

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

-

+

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

-

+

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

-
+
-
-
-

PRINTING OPTIONS

-

- dnssec-settime can also be used to print the +

+ +
+

PRINTING OPTIONS

+ +

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

-
+ +
-u
-

+

+

Print times in UNIX epoch format. -

+

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

+

+

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

+

+
-
-
-

SEE ALSO

-

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

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/dnssec/dnssec-signzone.8 b/bin/dnssec/dnssec-signzone.8 index be2f5b34e0..a4cbed2d89 100644 --- a/bin/dnssec/dnssec-signzone.8 +++ b/bin/dnssec/dnssec-signzone.8 @@ -13,438 +13,458 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-signzone +'\" t +.\" Title: dnssec-signzone .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: December 11, 2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2013-12-11 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-SIGNZONE" "8" "December 11, 2013" "BIND9" "BIND9" +.TH "DNSSEC\-SIGNZONE" "8" "2013\-12\-11" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-signzone \- DNSSEC zone signing tool +dnssec-signzone \- DNSSEC zone signing tool .SH "SYNOPSIS" .HP 16 \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\-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\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-I\ \fR\fB\fIinput\-format\fR\fR] [\fB\-j\ \fR\fB\fIjitter\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\-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 -\fIkeyset\fR -file for each child zone. +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 \-a .RS 4 -Verify all generated signatures. +Verify all generated signatures\&. .RE .PP \-c \fIclass\fR .RS 4 -Specifies the DNS class of the zone. +Specifies the DNS class of the zone\&. .RE .PP \-C .RS 4 Compatibility mode: Generate a -\fIkeyset\-\fR\fI\fIzonename\fR\fR +keyset\-\fIzonename\fR file in addition to -\fIdsset\-\fR\fI\fIzonename\fR\fR +dsset\-\fIzonename\fR when signing a zone, for use by older versions of -\fBdnssec\-signzone\fR. +\fBdnssec\-signzone\fR\&. .RE .PP \-d \fIdirectory\fR .RS 4 Look for -\fIdsset\-\fR +dsset\- or -\fIkeyset\-\fR +keyset\- files in -\fBdirectory\fR. +\fBdirectory\fR\&. .RE .PP \-D .RS 4 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 +\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 -or serial number updating. +or serial number updating\&. .RE .PP \-E \fIengine\fR .RS 4 -Uses a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance signing with private keys from a secure key store. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. +Uses a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance signing with private keys from a secure key store\&. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine\&. .RE .PP \-g .RS 4 Generate DS records for child zones from -\fIdsset\-\fR +dsset\- or -\fIkeyset\-\fR -file. Existing DS records will be removed. +keyset\- +file\&. Existing DS records will be removed\&. .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. +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. +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. +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 \-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. +is specified, the current time minus 1 hour (to allow for clock skew) is used\&. .RE .PP \-e \fIend\-time\fR .RS 4 -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 +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. +is specified, 30 days from the start time is used as a default\&. \fBend\-time\fR must be later than -\fBstart\-time\fR. +\fBstart\-time\fR\&. .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 -\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 +\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 \fBend\-time\fR -is used as the default. (\fBend\-time\fR, in turn, defaults to 30 days from the start time.) +is used as the default\&. (\fBend\-time\fR, in turn, defaults to 30 days from the start time\&.) \fBextended end\-time\fR must be later than -\fBstart\-time\fR. +\fBstart\-time\fR\&. .RE .PP \-f \fIoutput\-file\fR .RS 4 -The name of the output file containing the signed zone. The default is to append -\fI.signed\fR -to the input filename. If +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". +"\-", then the signed zone is written to the standard output, with a default output format of "full"\&. .RE .PP \-h .RS 4 Prints a short summary of the options and arguments to -\fBdnssec\-signzone\fR. +\fBdnssec\-signzone\fR\&. .RE .PP \-V .RS 4 -Prints version information. +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. +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. +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 \-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 signed directly. The use of this option does not make much sense for non\-dynamic zones. +\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 signed directly\&. The use of this option does not make much sense for non\-dynamic zones\&. .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. +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'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. +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' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) +When writing a signed zone to \*(Aqraw\*(Aq 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. +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 and -\fB"unixtime"\fR. -.RS 4 +\fB"unixtime"\fR\&. .PP \fB"keep"\fR .RS 4 -Do not modify the SOA serial number. +Do not modify the SOA serial number\&. .RE .PP \fB"increment"\fR .RS 4 -Increment the SOA serial number using RFC 1982 arithmetics. +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 +Set the SOA serial number to the number of seconds since epoch\&. .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. +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) \fB"full"\fR, which is text output in a format suitable for processing by external scripts, and \fB"raw"\fR or \fB"raw=N"\fR, which store the zone in a binary format for rapid loading by -\fBnamed\fR. +\fBnamed\fR\&. \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. +\fBnamed\fR; if N is 1, the file can be read by release 9\&.9\&.0 or higher\&. The default is 1\&. .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. +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. +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"). +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 \-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 \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"). +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 \-r \fIrandomdev\fR .RS 4 -Specifies the source of randomness. If the operating system does not provide a -\fI/dev/random\fR -or equivalent device, the default source of randomness is keyboard input. -\fIrandomdev\fR -specifies the name of a character device or file containing random data to be used instead of the default. The special value -\fIkeyboard\fR -indicates that keyboard input should be used. +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 \-S .RS 4 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. +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: -.RS 4 +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. +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's publication date is set and is in the past, the key is published in the zone. +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'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\*(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'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 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'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. -.RE +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's 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' 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. +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 \-t .RS 4 -Print statistics at completion. +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. +will retain the existing chain when re\-signing\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +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.) +\fBnamed\fR\&.) .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.) +\fBnamed\fR\&.) .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. +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. +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., -\fB\-AA\fR) turns the OPTOUT flag off for all records. This is useful when using the +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. +option to modify an NSEC3 chain which previously had OPTOUT set\&. .RE .PP zonefile .RS 4 -The file containing the zone to be signed. +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. +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 +\fBexample\&.com\fR zone with the DSA key generated by \fBdnssec\-keygen\fR -(Kexample.com.+003+17247). Because the +(Kexample\&.com\&.+003+17247)\&. Because the \fB\-S\fR -option is not being used, the zone's keys must be in the master file (\fIdb.example.com\fR). This invocation looks for -\fIdsset\fR -files, in the current directory, so that DS records can be imported from them (\fB\-g\fR). +option is not being used, the zone\*(Aqs keys must be in the master file (db\&.example\&.com)\&. This invocation looks for +dsset +files, in the current directory, so that DS records can be imported from them (\fB\-g\fR)\&. .sp +.if n \{\ .RS 4 +.\} .nf -% dnssec\-signzone \-g \-o example.com db.example.com \\ -Kexample.com.+003+17247 -db.example.com.signed +% dnssec\-signzone \-g \-o example\&.com db\&.example\&.com \e +Kexample\&.com\&.+003+17247 +db\&.example\&.com\&.signed % .fi +.if n \{\ .RE +.\} .PP In the above example, \fBdnssec\-signzone\fR creates the file -\fIdb.example.com.signed\fR. This file should be referenced in a zone statement in a -\fInamed.conf\fR -file. +db\&.example\&.com\&.signed\&. This file should be referenced in a zone statement in a +named\&.conf +file\&. .PP -This example re\-signs a previously signed zone with default parameters. The private keys are assumed to be in the current directory. +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 \{\ .RS 4 +.\} .nf -% cp db.example.com.signed db.example.com -% dnssec\-signzone \-o example.com db.example.com -db.example.com.signed +% cp db\&.example\&.com\&.signed db\&.example\&.com +% dnssec\-signzone \-o example\&.com db\&.example\&.com +db\&.example\&.com\&.signed % .fi +.if n \{\ .RE +.\} .SH "SEE ALSO" .PP -\fBdnssec\-keygen\fR(8), +\fBdnssec-keygen\fR(8), BIND 9 Administrator Reference Manual, RFC 4033, -RFC 4641. +RFC 4641\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2009, 2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2003 Internet Software Consortium. +Copyright \(co 2004-2009, 2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2003 Internet Software Consortium. .br diff --git a/bin/dnssec/dnssec-signzone.docbook b/bin/dnssec/dnssec-signzone.docbook index 4a092112c7..02f796c629 100644 --- a/bin/dnssec/dnssec-signzone.docbook +++ b/bin/dnssec/dnssec-signzone.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2013-12-11 + - December 11, 2013 + ISC + Internet Systems Consortium, Inc. @@ -57,51 +58,51 @@ - + dnssec-signzone - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - zonefile - key + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + zonefile + key - - DESCRIPTION + DESCRIPTION + dnssec-signzone signs a zone. It generates NSEC and RRSIG records and produces a signed version of the @@ -110,10 +111,10 @@ determined by the presence or absence of a keyset file for each child zone. - + - - OPTIONS + OPTIONS + @@ -754,10 +755,10 @@ - + - - EXAMPLE + EXAMPLE + The following command signs the example.com zone with the DSA key generated by dnssec-keygen @@ -785,26 +786,16 @@ db.example.com.signed % dnssec-signzone -o example.com db.example.com db.example.com.signed % - + - - SEE ALSO + SEE ALSO + dnssec-keygen8 , BIND 9 Administrator Reference Manual, RFC 4033, RFC 4641. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/dnssec/dnssec-signzone.html b/bin/dnssec/dnssec-signzone.html index 3995507201..ee6b057b60 100644 --- a/bin/dnssec/dnssec-signzone.html +++ b/bin/dnssec/dnssec-signzone.html @@ -14,26 +14,78 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-signzone - + -
+
-
+ + + + + +

Name

-

dnssec-signzone — DNSSEC zone signing tool

+

+ dnssec-signzone + — DNSSEC zone signing tool +

-
+ + + +

Synopsis

-

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

-
-
-

DESCRIPTION

-

dnssec-signzone +

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

+
+ +
+

DESCRIPTION

+ +

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

-
-
-

OPTIONS

-
+
+ +
+

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

+ 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, + dnssec-signzone, i.e. RRSIG, NSEC, NSEC3 and NSEC3PARAM records. If smart signing (-S) is used, DNSKEY records are also included. The resulting file can be included in the original - zone file with $INCLUDE. This option + zone file with $INCLUDE. This option cannot be combined with -O raw or serial number updating. -

+

+
-E engine
-

+

+

Uses a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance signing with private keys from a secure key store. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. -

+

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

+

+
-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 @@ -116,9 +192,11 @@ indicated by +N, which is N seconds from the current time. If no start-time is specified, the current time minus 1 hour (to allow for clock skew) is used. -

+

+
-e end-time
-

+

+

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

+

+
-X extended end-time
-

+

Specify the date and time when the generated RRSIG records for the DNSKEY RRset will expire. This is to be used in cases when the DNSKEY signatures need to persist longer than @@ -139,7 +218,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 @@ -150,28 +229,34 @@ 30 days from the start time.) extended end-time must be later than start-time.

-
+
-f output-file
-

+

+

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

+

+
-h
-

+

+

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

+ 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 @@ -179,32 +264,34 @@ 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 - are specified, dnssec-signzone + are specified, dnssec-signzone 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.

-
+
-I input-format
-

+

+

The format of the input zone file. - Possible formats are "text" (default) - and "raw". + Possible formats are "text" (default) + and "raw". 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. -

+

+
-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. @@ -215,116 +302,135 @@ 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' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) -

+

+
-n ncpus
-

+

+

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

+

+
-N soa-serial-format
-

+

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

-
-
"keep"
-

Do not modify the SOA serial number.

-
"increment"
-

Increment the SOA serial number using RFC 1982 - arithmetics.

-
"unixtime"
-

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

+ +
+
"keep"
+
+

Do not modify the SOA serial number.

+
+
"increment"
+
+

Increment the SOA serial number using RFC 1982 + arithmetics.

+
+
"unixtime"
+
+

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

+
-
+ +
-o origin
-

+

+

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

+

+
-O output-format
-

+

+

The format of the output file containing the signed zone. - Possible formats are "text" (default) - "full", which is text output in a + Possible formats are "text" (default) + "full", which is text output in a format suitable for processing by external scripts, - and "raw" or "raw=N", + and "raw" or "raw=N", which store the zone in a binary format for rapid loading - by named. "raw=N" + by named. "raw=N" specifies the format version of 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 + 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 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 -Q - forces dnssec-signzone to remove + forces dnssec-signzone 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").

-
+
-R
-

+

Remove signatures from keys that are no longer published.

-

+

This option is similar to -Q, except it - forces dnssec-signzone to signatures from + 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 @@ -334,53 +440,65 @@ data to be used instead of the default. The special value keyboard indicates that keyboard input should be used. -

+

+
-S
-

- Smart signing: Instructs dnssec-signzone to +

+ 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 @@ -392,100 +510,121 @@ 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 + 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.) -

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

+ 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

-

+

+ +
+

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 + zone with the DSA key generated by dnssec-keygen + (Kexample.com.+003+17247). Because the -S option is not being used, the zone's keys must be in the master file (db.example.com). This invocation looks for dsset files, in the current directory, - so that DS records can be imported from them (-g). + so that DS records can be imported from them (-g).

% dnssec-signzone -g -o example.com db.example.com \
 Kexample.com.+003+17247
 db.example.com.signed
 %
-

- In the above example, dnssec-signzone creates +

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

@@ -493,18 +632,18 @@ db.example.com.signed % dnssec-signzone -o example.com db.example.com db.example.com.signed % -
-
-

SEE ALSO

-

dnssec-keygen(8), +

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/dnssec/dnssec-verify.8 b/bin/dnssec/dnssec-verify.8 index df4278333d..aa2ee977ee 100644 --- a/bin/dnssec/dnssec-verify.8 +++ b/bin/dnssec/dnssec-verify.8 @@ -1,102 +1,118 @@ -.\" Copyright (C) 2012, 2014 Internet Systems Consortium, Inc. ("ISC") -.\" +.\" Copyright (C) 2012, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-verify +'\" t +.\" Title: dnssec-verify .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 26, 2012 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2012-06-26 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-VERIFY" "8" "June 26, 2012" "BIND9" "BIND9" +.TH "DNSSEC\-VERIFY" "8" "2012\-06\-26" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-verify \- DNSSEC zone verification tool +dnssec-verify \- DNSSEC zone verification tool .SH "SYNOPSIS" .HP 14 \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. +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 \-c \fIclass\fR .RS 4 -Specifies the DNS class of the zone. +Specifies the DNS class of the zone\&. .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. +\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 \-o \fIorigin\fR .RS 4 -The zone origin. If not specified, the name of the zone file is assumed to be the origin. +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. +Sets the debugging level\&. .RE .PP \-V .RS 4 -Prints version information. +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. +\fBdnssec\-signzone\fR\&. .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. +\fBdnssec\-signzone\fR\&. .RE .PP zonefile .RS 4 -The file containing the zone to be signed. +The file containing the zone to be signed\&. .RE .SH "SEE ALSO" .PP -\fBdnssec\-signzone\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, -RFC 4033. +RFC 4033\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2012, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-verify.docbook b/bin/dnssec/dnssec-verify.docbook index d3c47c9c15..9336887b5f 100644 --- a/bin/dnssec/dnssec-verify.docbook +++ b/bin/dnssec/dnssec-verify.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2012-06-26 + - June 26, 2012 + ISC + Internet Systems Consortium, Inc. @@ -42,31 +43,31 @@ - + dnssec-verify - - - - - - - - - zonefile + + + + + + + + + zonefile - - DESCRIPTION + DESCRIPTION + 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 + OPTIONS + @@ -169,10 +170,10 @@ - + - - SEE ALSO + SEE ALSO + dnssec-signzone8 @@ -180,16 +181,6 @@ BIND 9 Administrator Reference Manual, RFC 4033. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/dnssec/dnssec-verify.html b/bin/dnssec/dnssec-verify.html index 8e23766899..9444bb4e83 100644 --- a/bin/dnssec/dnssec-verify.html +++ b/bin/dnssec/dnssec-verify.html @@ -13,74 +13,112 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-verify - + -
+
-
+ + + + + +

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}

-
-
-

DESCRIPTION

-

dnssec-verify +

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

+
+ +
+

DESCRIPTION

+ +

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

-
+
+ +
+

OPTIONS

+ + +
-c class
-

+

+

Specifies the DNS class of the zone. -

+

+
-I input-format
-

+

+

The format of the input zone file. - Possible formats are "text" (default) - and "raw". + Possible formats are "text" (default) + and "raw". 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. -

+

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

+ 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 @@ -88,34 +126,36 @@ 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 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 -z - option in dnssec-signzone. + option in dnssec-signzone.

-
+
zonefile
-

+

+

The file containing the zone to be signed. -

+

+
-
-
-

SEE ALSO

-

- dnssec-signzone(8), +

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/named/lwresd.8 b/bin/named/lwresd.8 index 5a0560acb6..bfe57791b2 100644 --- a/bin/named/lwresd.8 +++ b/bin/named/lwresd.8 @@ -13,22 +13,37 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwresd .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: January 20, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2009-01-20 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRESD" "8" "January 20, 2009" "BIND9" "BIND9" +.TH "LWRESD" "8" "2009\-01\-20" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwresd \- lightweight resolver daemon .SH "SYNOPSIS" @@ -37,46 +52,46 @@ lwresd \- lightweight resolver daemon .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. +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 \fBlwresd\fR -listens for resolver queries on a UDP port on the IPv4 loopback interface, 127.0.0.1. This means that +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. +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 -Incoming lightweight resolver requests are decoded by the server which then resolves them using the DNS protocol. When the DNS lookup completes, +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. +encodes the answers in the lightweight resolver format and returns them to the client that made the request\&. .PP If -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf contains any \fBnameserver\fR entries, \fBlwresd\fR -sends recursive DNS queries to those servers. This is similar to the use of forwarders in a caching name server. If no +sends recursive DNS queries to those servers\&. This is similar to the use of forwarders in a caching name server\&. If no \fBnameserver\fR 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. +resolves the queries autonomously starting at the root name servers, using a built\-in list of root server hints\&. .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. +are mutually exclusive\&. .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. +are mutually exclusive\&. .RE .PP \-c \fIconfig\-file\fR @@ -84,10 +99,10 @@ are mutually exclusive. Use \fIconfig\-file\fR as the configuration file instead of the default, -\fI/etc/lwresd.conf\fR. +/etc/lwresd\&.conf\&. \fB\-c\fR can not be used with -\fB\-C\fR. +\fB\-C\fR\&. .RE .PP \-C \fIconfig\-file\fR @@ -95,29 +110,29 @@ can not be used with Use \fIconfig\-file\fR as the configuration file instead of the default, -\fI/etc/resolv.conf\fR. +/etc/resolv\&.conf\&. \fB\-C\fR can not be used with -\fB\-c\fR. +\fB\-c\fR\&. .RE .PP \-d \fIdebug\-level\fR .RS 4 -Set the daemon's debug level to -\fIdebug\-level\fR. Debugging traces from +Set the daemon\*(Aqs debug level to +\fIdebug\-level\fR\&. Debugging traces from \fBlwresd\fR -become more verbose as the debug level increases. +become more verbose as the debug level increases\&. .RE .PP \-f .RS 4 -Run the server in the foreground (i.e. do not daemonize). +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 -\fIstderr\fR. +stderr\&. .RE .PP \-i \fIpid\-file\fR @@ -125,49 +140,49 @@ Run the server in the foreground and force all logging to Use \fIpid\-file\fR as the PID file instead of the default, -\fI/var/run/lwresd/lwresd.pid\fR. +/var/run/lwresd/lwresd\&.pid\&. .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 -\fI\fR. +\fImctx\fR\&. These correspond to the ISC_MEM_DEBUGXXXX flags described in +\&. .RE .PP \-n \fI#cpus\fR .RS 4 Create \fI#cpus\fR -worker threads to take advantage of multiple CPUs. If not specified, +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. +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 \-P \fIport\fR .RS 4 Listen for lightweight resolver queries on port -\fIport\fR. If not specified, the default is port 921. +\fIport\fR\&. If not specified, the default is port 921\&. .RE .PP \-p \fIport\fR .RS 4 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. +\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 \-s .RS 4 Write memory usage statistics to -\fIstdout\fR -on exit. +stdout +on exit\&. .RS .B "Note:" -This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release. +This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&. .RE .RE .PP @@ -175,14 +190,14 @@ This option is mainly of interest to BIND 9 developers and may be removed or cha .RS 4 Chroot to \fIdirectory\fR -after processing the command line arguments, but before reading the configuration file. +after processing the command line arguments, but before reading the configuration file\&. .RS .B "Warning:" This option should be used in conjunction with the \fB\-u\fR -option, as chrooting a process running as root doesn't enhance security on most systems; the way +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. +is defined allows a process with root privileges to escape a chroot jail\&. .RE .RE .PP @@ -190,34 +205,35 @@ is defined allows a process with root privileges to escape a chroot jail. .RS 4 Setuid to \fIuser\fR -after completing privileged operations, such as creating sockets that listen on privileged ports. +after completing privileged operations, such as creating sockets that listen on privileged ports\&. .RE .PP \-v .RS 4 -Report the version number and exit. +Report the version number and exit\&. .RE .SH "FILES" .PP -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf .RS 4 -The default configuration file. +The default configuration file\&. .RE .PP -\fI/var/run/lwresd.pid\fR +/var/run/lwresd\&.pid .RS 4 -The default process\-id file. +The default process\-id file\&. .RE .SH "SEE ALSO" .PP \fBnamed\fR(8), \fBlwres\fR(3), -\fBresolver\fR(5). +\fBresolver\fR(5)\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004, 2005, 2007\-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2004, 2005, 2007-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. .br diff --git a/bin/named/lwresd.docbook b/bin/named/lwresd.docbook index e45ce859b7..2a8273b0ef 100644 --- a/bin/named/lwresd.docbook +++ b/bin/named/lwresd.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2009-01-20 + - January 20, 2009 + ISC + Internet Systems Consortium, Inc. @@ -53,29 +54,29 @@ - + lwresd - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + - - DESCRIPTION + DESCRIPTION + lwresd is the daemon providing name lookup @@ -110,10 +111,10 @@ queries autonomously starting at the root name servers, using a built-in list of root server hints. - + - - OPTIONS + OPTIONS + @@ -319,10 +320,10 @@ - + - - FILES + FILES + @@ -346,10 +347,10 @@ - + - - SEE ALSO + SEE ALSO + named8 , @@ -360,16 +361,6 @@ resolver5 . - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/named/lwresd.html b/bin/named/lwresd.html index dc1ebbe85c..0b59c307c9 100644 --- a/bin/named/lwresd.html +++ b/bin/named/lwresd.html @@ -14,111 +14,163 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwresd - + -
+
-
+ + + + + +

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]

-
-
-

DESCRIPTION

-

lwresd +

+ 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 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 + means that lwresd 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.

-

+

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 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 + nameserver entries, lwresd sends recursive DNS queries to those servers. This is similar to the use of forwarders in a caching name server. If no nameserver entries are present, or if - forwarding fails, lwresd resolves the + forwarding fails, lwresd resolves the queries autonomously starting at the root name servers, using a built-in list of root server hints.

-
-
-

OPTIONS

-
+
+ +
+

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 + Debugging traces from lwresd become more verbose as the debug level increases. -

+

+
-f
-

+

+

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

+

+
-g
-

+

+

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

+

+
-i pid-file
-

+

+

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

+

+
-m flag
-

+

+

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

+

+
-n #cpus
-

+

+

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

+

+
-P port
-

+

+

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

+

+
-p port
-

+

+

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

+

+
-s
-

+

Write memory usage statistics to stdout on exit.

-
+

Note

-

+

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

-
-
+
+
-t directory
-

Chroot +

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

-
+

Warning

-

+

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

-
-
+
+
-u user
-

Setuid +

+

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

+

+
-v
-

+

+

Report the version number and exit. -

+

+
-
-
-

FILES

-
+ +
+ +
+

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

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/named/named.8 b/bin/named/named.8 index 09bd4c117d..c9692f5bab 100644 --- a/bin/named/named.8 +++ b/bin/named/named.8 @@ -13,22 +13,37 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: named .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: February 20, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2014-02-20 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NAMED" "8" "February 20, 2014" "BIND9" "BIND9" +.TH "NAMED" "8" "2014\-02\-20" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" named \- Internet domain name server .SH "SYNOPSIS" @@ -37,30 +52,30 @@ named \- Internet domain name server .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. +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 When invoked without arguments, \fBnamed\fR will read the default configuration file -\fI/etc/named.conf\fR, read any initial data, and listen for queries. +/etc/named\&.conf, read any initial data, and listen for queries\&. .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. +are mutually exclusive\&. .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. +are mutually exclusive\&. .RE .PP \-c \fIconfig\-file\fR @@ -68,79 +83,79 @@ are mutually exclusive. Use \fIconfig\-file\fR as the configuration file instead of the default, -\fI/etc/named.conf\fR. To ensure that reloading the configuration file continues to work after the server has changed its working directory due to to a possible +/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 \fBdirectory\fR option in the configuration file, \fIconfig\-file\fR -should be an absolute pathname. +should be an absolute pathname\&. .RE .PP \-d \fIdebug\-level\fR .RS 4 -Set the daemon's debug level to -\fIdebug\-level\fR. Debugging traces from +Set the daemon\*(Aqs debug level to +\fIdebug\-level\fR\&. Debugging traces from \fBnamed\fR -become more verbose as the debug level increases. +become more verbose as the debug level increases\&. .RE .PP \-E \fIengine\-name\fR .RS 4 -Use a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance re\-signing with private keys from a secure key store. When compiled with PKCS#11 support +Use a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance re\-signing with private keys from a secure key store\&. When compiled with PKCS#11 support \fIengine\-name\fR -defaults to pkcs11, the empty name resets it to no engine. +defaults to pkcs11, the empty name resets it to no engine\&. .RE .PP \-f .RS 4 -Run the server in the foreground (i.e. do not daemonize). +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 -\fIstderr\fR. +stderr\&. .RE .PP \-M \fIoption\fR .RS 4 -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. +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 \-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 -\fI\fR. +\fImctx\fR\&. These correspond to the ISC_MEM_DEBUGXXXX flags described in +\&. .RE .PP \-n \fI#cpus\fR .RS 4 Create \fI#cpus\fR -worker threads to take advantage of multiple CPUs. If not specified, +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. +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 \-p \fIport\fR .RS 4 Listen for queries on port -\fIport\fR. If not specified, the default is port 53. +\fIport\fR\&. If not specified, the default is port 53\&. .RE .PP \-s .RS 4 Write memory usage statistics to -\fIstdout\fR -on exit. +stdout +on exit\&. .RS .B "Note:" -This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release. +This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&. .RE .RE .PP @@ -150,12 +165,12 @@ Allow \fBnamed\fR to use up to \fI#max\-socks\fR -sockets. +sockets\&. .RS .B "Warning:" -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. +reserves some file descriptors for its internal use\&. .RE .RE .PP @@ -163,14 +178,14 @@ reserves some file descriptors for its internal use. .RS 4 Chroot to \fIdirectory\fR -after processing the command line arguments, but before reading the configuration file. +after processing the command line arguments, but before reading the configuration file\&. .RS .B "Warning:" This option should be used in conjunction with the \fB\-u\fR -option, as chrooting a process running as root doesn't enhance security on most systems; the way +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. +is defined allows a process with root privileges to escape a chroot jail\&. .RE .RE .PP @@ -178,115 +193,116 @@ is defined allows a process with root privileges to escape a chroot jail. .RS 4 Use \fI#listeners\fR -worker threads to listen for incoming UDP packets on each address. If not specified, +worker threads to listen for incoming UDP packets on each address\&. If not specified, \fBnamed\fR -will calculate a default value based on the number of detected CPUs: 1 for 1 CPU, 2 for 2\-4 CPUs, and the number of detected CPUs divided by 2 for values higher than 4. If +will calculate a default value based on the number of detected CPUs: 1 for 1 CPU, and the number of detected CPUs minus one for machines with more than 1 CPU\&. This cannot be increased to a value higher than the number of CPUs\&. If \fB\-n\fR 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. +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 \-u \fIuser\fR .RS 4 Setuid to \fIuser\fR -after completing privileged operations, such as creating sockets that listen on privileged ports. +after completing privileged operations, such as creating sockets that listen on privileged ports\&. .RS .B "Note:" On Linux, \fBnamed\fR -uses the kernel's capability mechanism to drop all root privileges except the ability to +uses the kernel\*(Aqs capability mechanism to drop all root privileges except the ability to \fBbind(2)\fR -to a privileged port and set process resource limits. Unfortunately, this means that the +to a privileged port and set process resource limits\&. Unfortunately, this means that the \fB\-u\fR 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. +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\&. .RE .RE .PP \-v .RS 4 -Report the version number and exit. +Report the version number and exit\&. .RE .PP \-V .RS 4 -Report the version number and build options, and exit. +Report the version number and build options, and exit\&. .RE .PP \-x \fIcache\-file\fR .RS 4 Load data from \fIcache\-file\fR -into the cache of the default view. +into the cache of the default view\&. .RS .B "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. +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\&. .RE .RE .SH "SIGNALS" .PP In routine operation, signals should not be used to control the nameserver; \fBrndc\fR -should be used instead. +should be used instead\&. .PP SIGHUP .RS 4 -Force a reload of the server. +Force a reload of the server\&. .RE .PP SIGINT, SIGTERM .RS 4 -Shut down the server. +Shut down the server\&. .RE .PP -The result of sending any other signals to the server is undefined. +The result of sending any other signals to the server is undefined\&. .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. +configuration file is too complex to describe in detail here\&. A complete description is provided in the +BIND 9 Administrator Reference Manual\&. .PP \fBnamed\fR inherits the \fBumask\fR -(file creation mode mask) from the parent process. If files created by +(file creation mode mask) from the parent process\&. If files created by \fBnamed\fR, such as journal files, need to have custom permissions, the \fBumask\fR should be set explicitly in the script used to start the \fBnamed\fR -process. +process\&. .SH "FILES" .PP -\fI/etc/named.conf\fR +/etc/named\&.conf .RS 4 -The default configuration file. +The default configuration file\&. .RE .PP -\fI/var/run/named/named.pid\fR +/var/run/named/named\&.pid .RS 4 -The default process\-id file. +The default process\-id file\&. .RE .SH "SEE ALSO" .PP RFC 1033, RFC 1034, RFC 1035, -\fBnamed\-checkconf\fR(8), -\fBnamed\-checkzone\fR(8), +\fBnamed-checkconf\fR(8), +\fBnamed-checkzone\fR(8), \fBrndc\fR(8), \fBlwresd\fR(8), \fBnamed.conf\fR(5), -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2009, 2011, 2013\-2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2004-2009, 2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001, 2003 Internet Software Consortium. .br diff --git a/bin/named/named.conf.5 b/bin/named/named.conf.5 index 74490805b0..03ef605be6 100644 --- a/bin/named/named.conf.5 +++ b/bin/named/named.conf.5 @@ -12,32 +12,47 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: \fInamed.conf\fR +'\" t +.\" Title: named.conf .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: January 08, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2014-01-08 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "\fINAMED.CONF\fR" "5" "January 08, 2014" "BIND9" "BIND9" +.TH "NAMED\&.CONF" "5" "2014\-01\-08" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" named.conf \- configuration file for named .SH "SYNOPSIS" .HP 11 -\fBnamed.conf\fR +\fBnamed\&.conf\fR .SH "DESCRIPTION" .PP -\fInamed.conf\fR +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: +\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 C style: /* */ .PP @@ -46,34 +61,48 @@ C++ style: // to end of line Unix style: # to end of line .SH "ACL" .sp +.if n \{\ .RS 4 +.\} .nf -acl \fIstring\fR { \fIaddress_match_element\fR; ... }; +acl \fIstring\fR { \fIaddress_match_element\fR; \&.\&.\&. }; .fi +.if n \{\ .RE +.\} .SH "KEY" .sp +.if n \{\ .RS 4 +.\} .nf key \fIdomain_name\fR { algorithm \fIstring\fR; secret \fIstring\fR; }; .fi +.if n \{\ .RE +.\} .SH "MASTERS" .sp +.if n \{\ .RS 4 +.\} .nf masters \fIstring\fR [ port \fIinteger\fR ] { ( \fImasters\fR | \fIipv4_address\fR [port \fIinteger\fR] | - \fIipv6_address\fR [port \fIinteger\fR] ) [ key \fIstring\fR ]; ... + \fIipv6_address\fR [port \fIinteger\fR] ) [ key \fIstring\fR ]; \&.\&.\&. }; .fi +.if n \{\ .RE +.\} .SH "SERVER" .sp +.if n \{\ .RS 4 +.\} .nf server ( \fIipv4_address\fR\fI[/prefixlen]\fR | \fIipv6_address\fR\fI[/prefixlen]\fR ) { bogus \fIboolean\fR; @@ -92,41 +121,57 @@ server ( \fIipv4_address\fR\fI[/prefixlen]\fR | \fIipv6_address\fR\fI[/prefixlen support\-ixfr \fIboolean\fR; // obsolete }; .fi +.if n \{\ .RE -.SH "TRUSTED\-KEYS" +.\} +.SH "TRUSTED-KEYS" .sp +.if n \{\ .RS 4 +.\} .nf trusted\-keys { - \fIdomain_name\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; ... + \fIdomain_name\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; \&.\&.\&. }; .fi +.if n \{\ .RE -.SH "MANAGED\-KEYS" +.\} +.SH "MANAGED-KEYS" .sp +.if n \{\ .RS 4 +.\} .nf managed\-keys { - \fIdomain_name\fR \fBinitial\-key\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; ... + \fIdomain_name\fR \fBinitial\-key\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; \&.\&.\&. }; .fi +.if n \{\ .RE +.\} .SH "CONTROLS" .sp +.if n \{\ .RS 4 +.\} .nf controls { inet ( \fIipv4_address\fR | \fIipv6_address\fR | * ) [ port ( \fIinteger\fR | * ) ] - allow { \fIaddress_match_element\fR; ... } - [ keys { \fIstring\fR; ... } ]; + allow { \fIaddress_match_element\fR; \&.\&.\&. } + [ keys { \fIstring\fR; \&.\&.\&. } ]; unix \fIunsupported\fR; // not implemented }; .fi +.if n \{\ .RE +.\} .SH "LOGGING" .sp +.if n \{\ .RS 4 +.\} .nf logging { channel \fIstring\fR { @@ -139,32 +184,40 @@ logging { print\-severity \fIboolean\fR; print\-category \fIboolean\fR; }; - category \fIstring\fR { \fIstring\fR; ... }; + category \fIstring\fR { \fIstring\fR; \&.\&.\&. }; }; .fi +.if n \{\ .RE +.\} .SH "LWRES" .sp +.if n \{\ .RS 4 +.\} .nf lwres { listen\-on [ port \fIinteger\fR ] { - ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ... + ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&. }; view \fIstring\fR \fIoptional_class\fR; - search { \fIstring\fR; ... }; + search { \fIstring\fR; \&.\&.\&. }; ndots \fIinteger\fR; }; .fi +.if n \{\ .RE +.\} .SH "OPTIONS" .sp +.if n \{\ .RS 4 +.\} .nf options { - avoid\-v4\-udp\-ports { \fIport\fR; ... }; - avoid\-v6\-udp\-ports { \fIport\fR; ... }; - blackhole { \fIaddress_match_element\fR; ... }; + avoid\-v4\-udp\-ports { \fIport\fR; \&.\&.\&. }; + avoid\-v6\-udp\-ports { \fIport\fR; \&.\&.\&. }; + blackhole { \fIaddress_match_element\fR; \&.\&.\&. }; coresize \fIsize\fR; datasize \fIsize\fR; directory \fIquoted_string\fR; @@ -175,8 +228,8 @@ options { host\-statistics\-max \fInumber\fR; // not implemented hostname ( \fIquoted_string\fR | none ); interface\-interval \fIinteger\fR; - listen\-on [ port \fIinteger\fR ] { \fIaddress_match_element\fR; ... }; - listen\-on\-v6 [ port \fIinteger\fR ] { \fIaddress_match_element\fR; ... }; + listen\-on [ port \fIinteger\fR ] { \fIaddress_match_element\fR; \&.\&.\&. }; + listen\-on\-v6 [ port \fIinteger\fR ] { \fIaddress_match_element\fR; \&.\&.\&. }; match\-mapped\-addresses \fIboolean\fR; memstatistics\-file \fIquoted_string\fR; pid\-file ( \fIquoted_string\fR | none ); @@ -202,16 +255,16 @@ options { transfers\-out \fIinteger\fR; use\-ixfr \fIboolean\fR; version ( \fIquoted_string\fR | none ); - allow\-recursion { \fIaddress_match_element\fR; ... }; - allow\-recursion\-on { \fIaddress_match_element\fR; ... }; - sortlist { \fIaddress_match_element\fR; ... }; - topology { \fIaddress_match_element\fR; ... }; // not implemented + allow\-recursion { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-recursion\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + sortlist { \fIaddress_match_element\fR; \&.\&.\&. }; + topology { \fIaddress_match_element\fR; \&.\&.\&. }; // not implemented auth\-nxdomain \fIboolean\fR; // default changed minimal\-responses \fIboolean\fR; recursion \fIboolean\fR; rrset\-order { [ class \fIstring\fR ] [ type \fIstring\fR ] - [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; ... + [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; \&.\&.\&. }; provide\-ixfr \fIboolean\fR; request\-ixfr \fIboolean\fR; @@ -246,12 +299,12 @@ options { dual\-stack\-servers [ port \fIinteger\fR ] { ( \fIquoted_string\fR [port \fIinteger\fR] | \fIipv4_address\fR [port \fIinteger\fR] | - \fIipv6_address\fR [port \fIinteger\fR] ); ... + \fIipv6_address\fR [port \fIinteger\fR] ); \&.\&.\&. }; edns\-udp\-size \fIinteger\fR; max\-udp\-size \fIinteger\fR; - root\-delegation\-only [ exclude { \fIquoted_string\fR; ... } ]; - disable\-algorithms \fIstring\fR { \fIstring\fR; ... }; + root\-delegation\-only [ exclude { \fIquoted_string\fR; \&.\&.\&. } ]; + disable\-algorithms \fIstring\fR { \fIstring\fR; \&.\&.\&. }; dnssec\-enable \fIboolean\fR; dnssec\-validation \fIboolean\fR; dnssec\-lookaside ( \fIauto\fR | \fIno\fR | \fIdomain\fR trust\-anchor \fIdomain\fR ); @@ -273,13 +326,13 @@ options { disable\-empty\-zone \fIstring\fR; dialup \fIdialuptype\fR; ixfr\-from\-differences \fIixfrdiff\fR; - allow\-query { \fIaddress_match_element\fR; ... }; - allow\-query\-on { \fIaddress_match_element\fR; ... }; - allow\-query\-cache { \fIaddress_match_element\fR; ... }; - allow\-query\-cache\-on { \fIaddress_match_element\fR; ... }; - allow\-transfer { \fIaddress_match_element\fR; ... }; - allow\-update { \fIaddress_match_element\fR; ... }; - allow\-update\-forwarding { \fIaddress_match_element\fR; ... }; + allow\-query { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-cache { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-cache\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-transfer { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update\-forwarding { \fIaddress_match_element\fR; \&.\&.\&. }; update\-check\-ksk \fIboolean\fR; dnssec\-dnskey\-kskonly \fIboolean\fR; masterfile\-format ( text | raw ); @@ -289,12 +342,12 @@ options { notify\-delay \fIseconds\fR; notify\-to\-soa \fIboolean\fR; also\-notify [ port \fIinteger\fR ] { ( \fIipv4_address\fR | \fIipv6_address\fR ) - [ port \fIinteger\fR ]; ... - [ key \fIkeyname\fR ] ... }; - allow\-notify { \fIaddress_match_element\fR; ... }; + [ port \fIinteger\fR ]; \&.\&.\&. + [ key \fIkeyname\fR ] \&.\&.\&. }; + allow\-notify { \fIaddress_match_element\fR; \&.\&.\&. }; forward ( first | only ); forwarders [ port \fIinteger\fR ] { - ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ... + ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&. }; max\-journal\-size \fIsize_no_default\fR; max\-transfer\-time\-in \fIinteger\fR; @@ -335,7 +388,7 @@ options { \fInamelist\fR } [ except\-from { \fInamelist\fR } ]; nsec3\-test\-zone \fIboolean\fR; // testing only - allow\-v6\-synthesis { \fIaddress_match_element\fR; ... }; // obsolete + allow\-v6\-synthesis { \fIaddress_match_element\fR; \&.\&.\&. }; // obsolete deallocate\-on\-exit \fIboolean\fR; // obsolete fake\-iquery \fIboolean\fR; // obsolete fetch\-glue \fIboolean\fR; // obsolete @@ -349,39 +402,43 @@ options { use\-id\-pool \fIboolean\fR; // obsolete }; .fi +.if n \{\ .RE +.\} .SH "VIEW" .sp +.if n \{\ .RS 4 +.\} .nf view \fIstring\fR \fIoptional_class\fR { - match\-clients { \fIaddress_match_element\fR; ... }; - match\-destinations { \fIaddress_match_element\fR; ... }; + match\-clients { \fIaddress_match_element\fR; \&.\&.\&. }; + match\-destinations { \fIaddress_match_element\fR; \&.\&.\&. }; match\-recursive\-only \fIboolean\fR; key \fIstring\fR { algorithm \fIstring\fR; secret \fIstring\fR; }; zone \fIstring\fR \fIoptional_class\fR { - ... + \&.\&.\&. }; server ( \fIipv4_address\fR\fI[/prefixlen]\fR | \fIipv6_address\fR\fI[/prefixlen]\fR ) { - ... + \&.\&.\&. }; trusted\-keys { \fIstring\fR \fIinteger\fR \fIinteger\fR \fIinteger\fR \fIquoted_string\fR; - [...] + [\&.\&.\&.] }; - allow\-recursion { \fIaddress_match_element\fR; ... }; - allow\-recursion\-on { \fIaddress_match_element\fR; ... }; - sortlist { \fIaddress_match_element\fR; ... }; - topology { \fIaddress_match_element\fR; ... }; // not implemented + allow\-recursion { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-recursion\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + sortlist { \fIaddress_match_element\fR; \&.\&.\&. }; + topology { \fIaddress_match_element\fR; \&.\&.\&. }; // not implemented auth\-nxdomain \fIboolean\fR; // default changed minimal\-responses \fIboolean\fR; recursion \fIboolean\fR; rrset\-order { [ class \fIstring\fR ] [ type \fIstring\fR ] - [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; ... + [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; \&.\&.\&. }; provide\-ixfr \fIboolean\fR; request\-ixfr \fIboolean\fR; @@ -416,12 +473,12 @@ view \fIstring\fR \fIoptional_class\fR { dual\-stack\-servers [ port \fIinteger\fR ] { ( \fIquoted_string\fR [port \fIinteger\fR] | \fIipv4_address\fR [port \fIinteger\fR] | - \fIipv6_address\fR [port \fIinteger\fR] ); ... + \fIipv6_address\fR [port \fIinteger\fR] ); \&.\&.\&. }; edns\-udp\-size \fIinteger\fR; max\-udp\-size \fIinteger\fR; - root\-delegation\-only [ exclude { \fIquoted_string\fR; ... } ]; - disable\-algorithms \fIstring\fR { \fIstring\fR; ... }; + root\-delegation\-only [ exclude { \fIquoted_string\fR; \&.\&.\&. } ]; + disable\-algorithms \fIstring\fR { \fIstring\fR; \&.\&.\&. }; dnssec\-enable \fIboolean\fR; dnssec\-validation \fIboolean\fR; dnssec\-lookaside ( \fIauto\fR | \fIno\fR | \fIdomain\fR trust\-anchor \fIdomain\fR ); @@ -443,13 +500,13 @@ view \fIstring\fR \fIoptional_class\fR { disable\-empty\-zone \fIstring\fR; dialup \fIdialuptype\fR; ixfr\-from\-differences \fIixfrdiff\fR; - allow\-query { \fIaddress_match_element\fR; ... }; - allow\-query\-on { \fIaddress_match_element\fR; ... }; - allow\-query\-cache { \fIaddress_match_element\fR; ... }; - allow\-query\-cache\-on { \fIaddress_match_element\fR; ... }; - allow\-transfer { \fIaddress_match_element\fR; ... }; - allow\-update { \fIaddress_match_element\fR; ... }; - allow\-update\-forwarding { \fIaddress_match_element\fR; ... }; + allow\-query { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-cache { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-cache\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-transfer { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update\-forwarding { \fIaddress_match_element\fR; \&.\&.\&. }; update\-check\-ksk \fIboolean\fR; dnssec\-dnskey\-kskonly \fIboolean\fR; masterfile\-format ( text | raw ); @@ -459,12 +516,12 @@ view \fIstring\fR \fIoptional_class\fR { notify\-delay \fIseconds\fR; notify\-to\-soa \fIboolean\fR; also\-notify [ port \fIinteger\fR ] { ( \fIipv4_address\fR | \fIipv6_address\fR ) - [ port \fIinteger\fR ]; ... - [ key \fIkeyname\fR ] ... }; - allow\-notify { \fIaddress_match_element\fR; ... }; + [ port \fIinteger\fR ]; \&.\&.\&. + [ key \fIkeyname\fR ] \&.\&.\&. }; + allow\-notify { \fIaddress_match_element\fR; \&.\&.\&. }; forward ( first | only ); forwarders [ port \fIinteger\fR ] { - ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ... + ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&. }; max\-journal\-size \fIsize_no_default\fR; max\-transfer\-time\-in \fIinteger\fR; @@ -492,16 +549,20 @@ view \fIstring\fR \fIoptional_class\fR { zero\-no\-soa\-ttl \fIboolean\fR; zero\-no\-soa\-ttl\-cache \fIboolean\fR; dnssec\-secure\-to\-insecure \fIboolean\fR; - allow\-v6\-synthesis { \fIaddress_match_element\fR; ... }; // obsolete + allow\-v6\-synthesis { \fIaddress_match_element\fR; \&.\&.\&. }; // obsolete fetch\-glue \fIboolean\fR; // obsolete maintain\-ixfr\-base \fIboolean\fR; // obsolete max\-ixfr\-log\-size \fIsize\fR; // obsolete }; .fi +.if n \{\ .RE +.\} .SH "ZONE" .sp +.if n \{\ .RS 4 +.\} .nf zone \fIstring\fR \fIoptional_class\fR { type ( master | slave | stub | hint | redirect | @@ -510,7 +571,7 @@ zone \fIstring\fR \fIoptional_class\fR { masters [ port \fIinteger\fR ] { ( \fImasters\fR | \fIipv4_address\fR [port \fIinteger\fR] | - \fIipv6_address\fR [ port \fIinteger\fR ] ) [ key \fIstring\fR ]; ... + \fIipv6_address\fR [ port \fIinteger\fR ] ) [ key \fIstring\fR ]; \&.\&.\&. }; database \fIstring\fR; delegation\-only \fIboolean\fR; @@ -524,18 +585,18 @@ zone \fIstring\fR \fIoptional_class\fR { journal \fIquoted_string\fR; zero\-no\-soa\-ttl \fIboolean\fR; dnssec\-secure\-to\-insecure \fIboolean\fR; - allow\-query { \fIaddress_match_element\fR; ... }; - allow\-query\-on { \fIaddress_match_element\fR; ... }; - allow\-transfer { \fIaddress_match_element\fR; ... }; - allow\-update { \fIaddress_match_element\fR; ... }; - allow\-update\-forwarding { \fIaddress_match_element\fR; ... }; + allow\-query { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-transfer { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update\-forwarding { \fIaddress_match_element\fR; \&.\&.\&. }; update\-policy \fIlocal\fR | \fI { ( grant | deny ) \fR\fI\fIstring\fR\fR\fI ( name | subdomain | wildcard | self | selfsub | selfwild | krb5\-self | ms\-self | krb5\-subdomain | ms\-subdomain | tcp\-self | zonesub | 6to4\-self ) \fR\fI\fIstring\fR\fR\fI \fR\fI\fIrrtypelist\fR\fR\fI; - \fR\fI[...]\fR\fI + \fR\fI[\&.\&.\&.]\fR\fI }\fR; update\-check\-ksk \fIboolean\fR; dnssec\-dnskey\-kskonly \fIboolean\fR; @@ -546,12 +607,12 @@ zone \fIstring\fR \fIoptional_class\fR { notify\-delay \fIseconds\fR; notify\-to\-soa \fIboolean\fR; also\-notify [ port \fIinteger\fR ] { ( \fIipv4_address\fR | \fIipv6_address\fR ) - [ port \fIinteger\fR ]; ... - [ key \fIkeyname\fR ] ... }; - allow\-notify { \fIaddress_match_element\fR; ... }; + [ port \fIinteger\fR ]; \&.\&.\&. + [ key \fIkeyname\fR ] \&.\&.\&. }; + allow\-notify { \fIaddress_match_element\fR; \&.\&.\&. }; forward ( first | only ); forwarders [ port \fIinteger\fR ] { - ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ... + ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&. }; max\-journal\-size \fIsize_no_default\fR; max\-transfer\-time\-in \fIinteger\fR; @@ -585,16 +646,22 @@ zone \fIstring\fR \fIoptional_class\fR { pubkey \fIinteger\fR \fIinteger\fR \fIinteger\fR \fIquoted_string\fR; // obsolete }; .fi +.if n \{\ .RE +.\} .SH "FILES" .PP -\fI/etc/named.conf\fR +/etc/named\&.conf .SH "SEE ALSO" .PP \fBnamed\fR(8), -\fBnamed\-checkconf\fR(8), +\fBnamed-checkconf\fR(8), \fBrndc\fR(8), -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2011, 2013\-2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2004-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/named/named.conf.docbook b/bin/named/named.conf.docbook index 8076439347..f16be3704b 100644 --- a/bin/named/named.conf.docbook +++ b/bin/named/named.conf.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2014-01-08 + - January 08, 2014 + ISC + Internet Systems Consortium, Inc. @@ -51,13 +52,13 @@ - + named.conf - - DESCRIPTION + DESCRIPTION + named.conf is the configuration file for named. Statements are enclosed @@ -74,39 +75,39 @@ Unix style: # to end of line - + - - ACL - + ACL + + acl string { address_match_element; ... }; - + - - KEY - + KEY + + key domain_name { algorithm string; secret string; }; - + - - MASTERS - + MASTERS + + masters string port integer { ( masters | ipv4_address port integer | ipv6_address port integer ) key string ; ... }; - + - - SERVER - + SERVER + + server ( ipv4_address/prefixlen | ipv6_address/prefixlen ) { bogus boolean; edns boolean; @@ -125,29 +126,29 @@ server ( ipv4_address/prefixlen support-ixfr boolean; // obsolete }; - + - - TRUSTED-KEYS - + TRUSTED-KEYS + + trusted-keys { domain_name flags protocol algorithm key; ... }; - + - - MANAGED-KEYS - + MANAGED-KEYS + + managed-keys { domain_name initial-key flags protocol algorithm key; ... }; - + - - CONTROLS - + CONTROLS + + controls { inet ( ipv4_address | ipv6_address | * ) port ( integer | * ) @@ -156,11 +157,11 @@ controls { unix unsupported; // not implemented }; - + - - LOGGING - + LOGGING + + logging { channel string { file log_file; @@ -175,11 +176,11 @@ logging { category string { string; ... }; }; - + - - LWRES - + LWRES + + lwres { listen-on port integer { ( ipv4_address | ipv6_address ) port integer ; ... @@ -189,11 +190,11 @@ lwres { ndots integer; }; - + - - OPTIONS - + OPTIONS + + options { avoid-v4-udp-ports { port; ... }; avoid-v6-udp-ports { port; ... }; @@ -395,11 +396,11 @@ options { use-id-pool boolean; // obsolete }; - + - - VIEW - + VIEW + + view string optional_class { match-clients { address_match_element; ... }; match-destinations { address_match_element; ... }; @@ -560,11 +561,11 @@ view string optional_class max-ixfr-log-size size; // obsolete }; - + - - ZONE - + ZONE + + zone string optional_class { type ( master | slave | stub | hint | redirect | forward | delegation-only ); @@ -658,16 +659,16 @@ zone string optional_class pubkey integer integer integer quoted_string; // obsolete }; - + - - FILES + FILES + /etc/named.conf - + - - SEE ALSO + SEE ALSO + named8 , @@ -679,10 +680,6 @@ zone string optional_class , BIND 9 Administrator Reference Manual. - + - + diff --git a/bin/named/named.conf.html b/bin/named/named.conf.html index b6f1c10032..f71625103c 100644 --- a/bin/named/named.conf.html +++ b/bin/named/named.conf.html @@ -13,70 +13,92 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - named.conf - + -
+
-
+ + + + + +

Name

-

named.conf — configuration file for named

+

+ named.conf + — configuration file for named +

-
+ + + +

Synopsis

-

named.conf

-
-
-

DESCRIPTION

-

named.conf is the configuration file +

+ named.conf +

+
+ +
+

DESCRIPTION

+ +

named.conf is the configuration file for - named. Statements are enclosed + 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

+ +


acl string { address_match_element; ... };

-
-
-

KEY

-


+

+ +
+

KEY

+ +


key domain_name {
algorithm string;
secret string;
};

-
-
-

MASTERS

-


+

+ +
+

MASTERS

+ +


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

-
-
-

SERVER

-


+

+ +
+

SERVER

+ +


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

-
-
-

TRUSTED-KEYS

-


+

+ +
+

TRUSTED-KEYS

+ +


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

-
-
-

MANAGED-KEYS

-


+

+ +
+

MANAGED-KEYS

+ +


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

-
-
-

CONTROLS

-


+

+ +
+

CONTROLS

+ +


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

-
-
-

LOGGING

-


+

+ +
+

LOGGING

+ +


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

-
-
-

LWRES

-


+

+ +
+

LWRES

+ +


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

-
-
-

OPTIONS

-


+

+ +
+

OPTIONS

+ +


options {
avoid-v4-udp-ports { port; ... };
avoid-v6-udp-ports { port; ... };
@@ -258,9 +292,9 @@ options dns64-server string;
dns64-contact string;
dns64 prefix {
- clients { <replacable>acl</replacable>; };
- exclude { <replacable>acl</replacable>; };
- mapped { <replacable>acl</replacable>; };
+ clients { <replacable>acl</replacable>; };
+ exclude { <replacable>acl</replacable>; };
+ mapped { <replacable>acl</replacable>; };
break-dnssec boolean;
recursive-only boolean;
suffix ipv6_address;
@@ -359,10 +393,12 @@ options use-id-pool boolean; // obsolete
};

-
-
-

VIEW

-


+

+ +
+

VIEW

+ +


view string optional_class {
match-clients { address_match_element; ... };
match-destinations { address_match_element; ... };
@@ -445,9 +481,9 @@ view dns64-server string;
dns64-contact string;
dns64 prefix {
- clients { <replacable>acl</replacable>; };
- exclude { <replacable>acl</replacable>; };
- mapped { <replacable>acl</replacable>; };
+ clients { <replacable>acl</replacable>; };
+ exclude { <replacable>acl</replacable>; };
+ mapped { <replacable>acl</replacable>; };
break-dnssec boolean;
recursive-only boolean;
suffix ipv6_address;
@@ -523,10 +559,12 @@ view max-ixfr-log-size size; // obsolete
};

-
-
-

ZONE

-


+

+ +
+

ZONE

+ +


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

-
-
-

FILES

-

/etc/named.conf +

+ +
+

FILES

+ +

/etc/named.conf

-
-
-

SEE ALSO

-

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

+ +
+

SEE ALSO

+ +

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

-
+
+
diff --git a/bin/named/named.docbook b/bin/named/named.docbook index f00b1631cd..e172b0dc67 100644 --- a/bin/named/named.docbook +++ b/bin/named/named.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2014-02-20 + - February 20, 2014 + ISC + Internet Systems Consortium, Inc. @@ -57,32 +58,32 @@ - + named - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + - - DESCRIPTION + DESCRIPTION + named is a Domain Name System (DNS) server, part of the BIND 9 distribution from ISC. For more @@ -95,10 +96,10 @@ /etc/named.conf, read any initial data, and listen for queries. - + - - OPTIONS + OPTIONS + @@ -382,10 +383,10 @@ - + - - SIGNALS + SIGNALS + In routine operation, signals should not be used to control the nameserver; rndc should be used @@ -418,10 +419,10 @@ The result of sending any other signals to the server is undefined. - + - - CONFIGURATION + CONFIGURATION + The named configuration file is too complex to describe in detail here. A complete description is provided @@ -438,10 +439,10 @@ named process. - + - - FILES + FILES + @@ -465,10 +466,10 @@ - + - - SEE ALSO + SEE ALSO + RFC 1033, RFC 1034, RFC 1035, @@ -494,16 +495,6 @@ , BIND 9 Administrator Reference Manual. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/named/named.html b/bin/named/named.html index 83494ee5d9..62c8acb610 100644 --- a/bin/named/named.html +++ b/bin/named/named.html @@ -14,55 +14,96 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - named - + -
+
-
+ + + + + +

Name

-

named — Internet domain name server

+

+ named + — Internet domain name server +

-
+ + + +

Synopsis

-

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

-
-
-

DESCRIPTION

-

named +

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

+
+ +
+

DESCRIPTION

+ +

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

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

-
-
-

OPTIONS

-
+
+ +
+

OPTIONS

+ + +
-4
-

+

+

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

+

+
-6
-

+

+

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

+

+
-c config-file
-

+

+

Use config-file as the configuration file instead of the default, /etc/named.conf. To @@ -72,40 +113,52 @@ 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 + Debugging traces from named become more verbose as the debug level increases. -

+

+
-E engine-name
-

+

+

Use a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance re-signing with private keys from a secure key store. When compiled with PKCS#11 support engine-name defaults to pkcs11, the empty name resets it to no engine. -

+

+
-f
-

+

+

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

+

+
-g
-

+

+

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

+

+
-M option
-

+

+

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

+

+
-m flag
-

+

+

Turn on memory usage debugging flags. Possible flags are usage, trace, @@ -114,43 +167,48 @@ 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 + 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 +

+ Allow named to use up to #max-socks sockets.

-
+

Warning

-

+

This option should be unnecessary for the vast majority of users. The use of this option could even be harmful because the @@ -162,21 +220,21 @@ specified number of sockets. Note also that the actual maximum number is normally a little fewer than the specified value because - named reserves some file descriptors + 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 @@ -184,137 +242,181 @@ 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 + address. If not specified, named will calculate a default value based on the number of detected - CPUs: 1 for 1 CPU, 2 for 2-4 CPUs, and the number of - detected CPUs divided by 2 for values higher than 4. + CPUs: 1 for 1 CPU, and the number of detected CPUs + minus one for machines with more than 1 CPU. This cannot + be increased to a value higher than the number of CPUs. If -n has been set to a higher value than the number of detected CPUs, then -U 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. +

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

+ On Linux, named uses the kernel's capability mechanism to drop all root privileges except the ability to bind(2) to a privileged port and set process resource limits. Unfortunately, this means that the -u - option only works when named is + option only works when named 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 setuid(2).

-
-
+
+
-v
-

+

+

Report the version number and exit. -

+

+
-V
-

+

+

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

+

+
-x cache-file
-

+

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

-
+

Warning

-

+

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

-
-
+
+
-
-
-

SIGNALS

-

+ +

+ +
+

SIGNALS

+ +

In routine operation, signals should not be used to control - the nameserver; rndc should be used + 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 + +

+ +
+

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

+ named inherits the umask (file creation mode mask) from the parent process. If files - created by named, such as journal files, + created by named, such as journal files, need to have custom permissions, the umask should be set explicitly in the script used to start the - named process. + named process.

-
-
-

FILES

-
+ +
+ +
+

FILES

+ + +
/etc/named.conf
-

+

+

The default configuration file. -

+

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

+

+

The default process-id file. -

+

+
-
-
-

SEE ALSO

-

RFC 1033, + +

+ +
+

SEE ALSO

+ +

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.

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/nsupdate/nsupdate.1 b/bin/nsupdate/nsupdate.1 index 28d5f42d78..1b69eb4b5e 100644 --- a/bin/nsupdate/nsupdate.1 +++ b/bin/nsupdate/nsupdate.1 @@ -13,22 +13,37 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: nsupdate .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: April 18, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2014-04-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NSUPDATE" "1" "April 18, 2014" "BIND9" "BIND9" +.TH "NSUPDATE" "1" "2014\-04\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" nsupdate \- Dynamic DNS update utility .SH "SYNOPSIS" @@ -37,140 +52,140 @@ nsupdate \- Dynamic DNS update utility .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. +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 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. +or a DHCP server should not be edited by hand\&. Manual edits could conflict with dynamic updates and cause data to be lost\&. .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's master server. This is identified by the MNAME field of the zone's SOA record. +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 -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. +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 TSIG relies on a shared secret that should only be known to \fBnsupdate\fR -and the name server. For instance, suitable +and the name server\&. For instance, suitable \fBkey\fR and \fBserver\fR statements would be added to -\fI/etc/named.conf\fR -so that the name server can associate the appropriate secret key and algorithm with the IP address of the client application that will be using TSIG authentication. You can use +/etc/named\&.conf +so that the name server can associate the appropriate secret key and algorithm with the IP address of the client application that will be using TSIG authentication\&. You can use \fBddns\-confgen\fR -to generate suitable configuration fragments. +to generate suitable configuration fragments\&. \fBnsupdate\fR uses the \fB\-y\fR or \fB\-k\fR -options to provide the TSIG shared secret. These options are mutually exclusive. +options to provide the TSIG shared secret\&. These options are mutually exclusive\&. .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. +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 -GSS\-TSIG uses Kerberos credentials. Standard GSS\-TSIG mode is switched on with the +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 +flag\&. A non\-standards\-compliant variant of GSS\-TSIG used by Windows 2000 can be switched on with the \fB\-o\fR -flag. +flag\&. .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. +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. +Extra debug mode\&. .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 -\fInamed.conf\fR\-format +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 \fBddns\-confgen\fR, or a pair of files whose names are of the format -\fIK{name}.+157.+{random}.key\fR +K{name}\&.+157\&.+{random}\&.key and -\fIK{name}.+157.+{random}.private\fR, which can be generated by -\fBdnssec\-keygen\fR. The +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. +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 \-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 -\fI/var/run/named/session.key\fR, which is automatically generated by +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 \fBnamed\fR if any local master zone has set \fBupdate\-policy\fR to -\fBlocal\fR. The location of this key file can be overridden with the +\fBlocal\fR\&. The location of this key file can be overridden with the \fB\-k\fR -option. +option\&. .RE .PP \-L \fIlevel\fR .RS 4 -Set the logging debug level. If zero, logging is disabled. +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. +Set the port to use for connections to a name server\&. The default is 53\&. .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. +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 -\fI/dev/random\fR -or equivalent device, the default source of randomness is keyboard input. -\fIrandomdev\fR -specifies the name of a character device or file containing random data to be used instead of the default. The special value -\fIkeyboard\fR -indicates that keyboard input should be used. This option may be specified multiple times. +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 \-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. +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 \-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. +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. +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 \-V .RS 4 -Print the version number and exit. +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 -is the base64 encoded shared secret. +is the base64 encoded shared secret\&. \fIhmac\fR is the name of the key algorithm; valid choices are hmac\-md5, @@ -178,105 +193,104 @@ hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384, or -hmac\-sha512. If +hmac\-sha512\&. If \fIhmac\fR is not specified, the default is -hmac\-md5. +hmac\-md5\&. .sp 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 +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's shell. +or in a history file maintained by the user\*(Aqs shell\&. .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. +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 -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 +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. +command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server\&. .PP The command formats and their meaning are as follows: .PP \fBserver\fR {servername} [port] .RS 4 Sends all dynamic update requests to the name server -\fIservername\fR. When no server statement is provided, +\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's SOA record will identify the master server for that zone. +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\&. \fIport\fR 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. +where the dynamic update requests get sent\&. If no port number is specified, the default DNS port number of 53 is used\&. .RE .PP \fBlocal\fR {address} [port] .RS 4 Sends all dynamic update requests using the local -\fIaddress\fR. When no local statement is provided, +\fIaddress\fR\&. When no local statement is provided, \fBnsupdate\fR -will send updates using an address and port chosen by the system. +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. +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 \fBzone\fR {zonename} .RS 4 Specifies that all updates are to be made to the zone -\fIzonename\fR. If no +\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. +will attempt determine the correct zone to update based on the rest of the input\&. .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. +\fIIN\fR\&. .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. +will clear the default ttl\&. .RE .PP \fBkey\fR [hmac:] {keyname} {secret} .RS 4 Specifies that all updates are to be TSIG\-signed using the -\fIkeyname\fR -\fIsecret\fR -pair. If +\fIkeyname\fR\fIsecret\fR +pair\&. If \fIhmac\fR is specified, then it sets the signing algorithm in use; the default is -hmac\-md5. The +hmac\-md5\&. The \fBkey\fR command overrides any key specified on the command line via \fB\-y\fR or -\fB\-k\fR. +\fB\-k\fR\&. .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 commandline. +on the commandline\&. .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 commandline. +on the commandline\&. .RE .PP \fBrealm\fR {[realm_name]} @@ -284,20 +298,20 @@ on the commandline. When using GSS\-TSIG use \fIrealm_name\fR rather than the default realm in -\fIkrb5.conf\fR. If no realm is specified the saved realm is cleared. +krb5\&.conf\&. If no realm is specified the saved realm is cleared\&. .RE .PP \fB[prereq]\fR\fB nxdomain\fR {domain\-name} .RS 4 Requires that no resource record of any type exists with name -\fIdomain\-name\fR. +\fIdomain\-name\fR\&. .RE .PP \fB[prereq]\fR\fB yxdomain\fR {domain\-name} .RS 4 Requires that \fIdomain\-name\fR -exists (has as at least one resource record, of any type). +exists (has as at least one resource record, of any type)\&. .RE .PP \fB[prereq]\fR\fB nxrrset\fR {domain\-name} [class] {type} @@ -306,9 +320,9 @@ Requires that no resource record exists of the specified \fItype\fR, \fIclass\fR and -\fIdomain\-name\fR. If +\fIdomain\-name\fR\&. If \fIclass\fR -is omitted, IN (internet) is assumed. +is omitted, IN (internet) is assumed\&. .RE .PP \fB[prereq]\fR\fB yxrrset\fR {domain\-name} [class] {type} @@ -318,9 +332,9 @@ This requires that a resource record of the specified \fIclass\fR and \fIdomain\-name\fR -must exist. If +must exist\&. If \fIclass\fR -is omitted, IN (internet) is assumed. +is omitted, IN (internet) is assumed\&. .RE .PP \fB[prereq]\fR\fB yxrrset\fR {domain\-name} [class] {type} {data...} @@ -331,26 +345,26 @@ from each set of prerequisites of this form sharing a common \fItype\fR, \fIclass\fR, and \fIdomain\-name\fR -are combined to form a set of RRs. This set of RRs must exactly match the set of RRs existing in the zone at the given +are combined to form a set of RRs\&. This set of RRs must exactly match the set of RRs existing in the zone at the given \fItype\fR, \fIclass\fR, and -\fIdomain\-name\fR. The +\fIdomain\-name\fR\&. The \fIdata\fR -are written in the standard text representation of the resource record's RDATA. +are written in the standard text representation of the resource record\*(Aqs RDATA\&. .RE .PP \fB[update]\fR\fB del\fR\fB[ete]\fR {domain\-name} [ttl] [class] [type\ [data...]] .RS 4 Deletes any resource records named -\fIdomain\-name\fR. If +\fIdomain\-name\fR\&. If \fItype\fR and \fIdata\fR -is provided, only matching resource records will be removed. The internet class is assumed if +is provided, only matching resource records will be removed\&. The internet class is assumed if \fIclass\fR -is not supplied. The +is not supplied\&. The \fIttl\fR -is ignored, and is only allowed for compatibility. +is ignored, and is only allowed for compatibility\&. .RE .PP \fB[update]\fR\fB add\fR {domain\-name} {ttl} [class] {type} {data...} @@ -359,99 +373,105 @@ Adds a new resource record with the specified \fIttl\fR, \fIclass\fR and -\fIdata\fR. +\fIdata\fR\&. .RE .PP \fBshow\fR .RS 4 -Displays the current message, containing all of the prerequisites and updates specified since the last send. +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. +Sends the current message\&. This is equivalent to entering a blank line\&. .RE .PP \fBanswer\fR .RS 4 -Displays the answer. +Displays the answer\&. .RE .PP \fBdebug\fR .RS 4 -Turn on debugging. +Turn on debugging\&. .RE .PP \fBversion\fR .RS 4 -Print version number. +Print version number\&. .RE .PP \fBhelp\fR .RS 4 -Print a list of commands. +Print a list of commands\&. .RE .PP -Lines beginning with a semicolon are comments and are ignored. +Lines beginning with a semicolon are comments and are ignored\&. .SH "EXAMPLES" .PP The examples below show how \fBnsupdate\fR could be used to insert and delete resource records from the -\fBexample.com\fR -zone. Notice that the input in each example contains a trailing blank line so that a group of commands are sent as one dynamic update request to the master name server for -\fBexample.com\fR. +\fBexample\&.com\fR +zone\&. Notice that the input in each example contains a trailing blank line so that a group of commands are sent as one dynamic update request to the master name server for +\fBexample\&.com\fR\&. .sp +.if n \{\ .RS 4 +.\} .nf # nsupdate -> update delete oldhost.example.com A -> update add newhost.example.com 86400 A 172.16.1.1 +> update delete oldhost\&.example\&.com A +> update add newhost\&.example\&.com 86400 A 172\&.16\&.1\&.1 > send .fi +.if n \{\ .RE -.sp +.\} .PP Any A records for -\fBoldhost.example.com\fR -are deleted. And an A record for -\fBnewhost.example.com\fR -with IP address 172.16.1.1 is added. The newly\-added record has a 1 day TTL (86400 seconds). +\fBoldhost\&.example\&.com\fR +are deleted\&. And an A record for +\fBnewhost\&.example\&.com\fR +with IP address 172\&.16\&.1\&.1 is added\&. The newly\-added record has a 1 day TTL (86400 seconds)\&. .sp +.if n \{\ .RS 4 +.\} .nf # nsupdate -> prereq nxdomain nickname.example.com -> update add nickname.example.com 86400 CNAME somehost.example.com +> prereq nxdomain nickname\&.example\&.com +> update add nickname\&.example\&.com 86400 CNAME somehost\&.example\&.com > send .fi +.if n \{\ .RE -.sp +.\} .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.) +\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 -\fB/etc/resolv.conf\fR +\fB/etc/resolv\&.conf\fR .RS 4 used to identify default name server .RE .PP -\fB/var/run/named/session.key\fR +\fB/var/run/named/session\&.key\fR .RS 4 sets the default TSIG key for use in local\-only mode .RE .PP -\fBK{name}.+157.+{random}.key\fR +\fBK{name}\&.+157\&.+{random}\&.key\fR .RS 4 base\-64 encoding of HMAC\-MD5 key created by -\fBdnssec\-keygen\fR(8). +\fBdnssec-keygen\fR(8)\&. .RE .PP -\fBK{name}.+157.+{random}.private\fR +\fBK{name}\&.+157\&.+{random}\&.private\fR .RS 4 base\-64 encoding of HMAC\-MD5 key created by -\fBdnssec\-keygen\fR(8). +\fBdnssec-keygen\fR(8)\&. .RE .SH "SEE ALSO" .PP @@ -463,13 +483,17 @@ RFC 1034, RFC 2535, RFC 2931, \fBnamed\fR(8), -\fBddns\-confgen\fR(8), -\fBdnssec\-keygen\fR(8). +\fBddns-confgen\fR(8), +\fBdnssec-keygen\fR(8)\&. .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. +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 +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2003 Internet Software Consortium. +Copyright \(co 2004-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2003 Internet Software Consortium. .br diff --git a/bin/nsupdate/nsupdate.docbook b/bin/nsupdate/nsupdate.docbook index b973c1f693..876dc8e113 100644 --- a/bin/nsupdate/nsupdate.docbook +++ b/bin/nsupdate/nsupdate.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2014-04-18 + - April 18, 2014 + ISC + Internet Systems Consortium, Inc. nsupdate @@ -57,30 +58,30 @@ - + nsupdate - - - - - - - - - + + + + + + + + + - - - - - - - filename + + + + + + + filename - - DESCRIPTION + DESCRIPTION + nsupdate is used to submit Dynamic DNS Update requests as defined in RFC 2136 to a name server. @@ -136,10 +137,10 @@ non-standards-compliant variant of GSS-TSIG used by Windows 2000 can be switched on with the flag. - + - - OPTIONS + OPTIONS + @@ -313,10 +314,10 @@ - + - - INPUT FORMAT + INPUT FORMAT + nsupdate reads input from filename @@ -348,8 +349,8 @@ server - servername - port + servername + port @@ -375,8 +376,8 @@ local - address - port + address + port @@ -398,7 +399,7 @@ zone - zonename + zonename @@ -417,7 +418,7 @@ class - classname + classname @@ -432,7 +433,7 @@ ttl - seconds + seconds @@ -446,8 +447,8 @@ key - hmac:keyname - secret + hmac:keyname + secret @@ -490,7 +491,7 @@ realm - realm_name + realm_name @@ -504,7 +505,7 @@ prereq nxdomain - domain-name + domain-name @@ -518,7 +519,7 @@ prereq yxdomain - domain-name + domain-name @@ -532,9 +533,9 @@ prereq nxrrset - domain-name - class - type + domain-name + class + type @@ -554,9 +555,9 @@ prereq yxrrset - domain-name - class - type + domain-name + class + type @@ -576,9 +577,9 @@ prereq yxrrset - domain-name - class - type + domain-name + class + type data @@ -610,10 +611,10 @@ update delete - domain-name - ttl - class - type data + domain-name + ttl + class + type data @@ -636,10 +637,10 @@ update add - domain-name - ttl - class - type + domain-name + ttl + class + type data @@ -729,10 +730,10 @@ Lines beginning with a semicolon are comments and are ignored. - + - - EXAMPLES + EXAMPLES + The examples below show how nsupdate @@ -780,10 +781,10 @@ (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have RRSIG, DNSKEY and NSEC records.) - + - - FILES + FILES + @@ -829,10 +830,10 @@ - + - - SEE ALSO + SEE ALSO + RFC 2136, RFC 3007, @@ -851,19 +852,15 @@ dnssec-keygen8 . - + - - BUGS + 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/nsupdate/nsupdate.html b/bin/nsupdate/nsupdate.html index 76c54db290..f05e065b42 100644 --- a/bin/nsupdate/nsupdate.html +++ b/bin/nsupdate/nsupdate.html @@ -14,26 +14,55 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - nsupdate - + -
+
-
+ + + +

Name

-

nsupdate — Dynamic DNS update utility

+

+ nsupdate + — Dynamic DNS update utility +

-
+ + + +

Synopsis

-

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

-
-
-

DESCRIPTION

-

nsupdate +

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

+
+ +
+

DESCRIPTION

+ +

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

-

+

Zones that are under dynamic control via - nsupdate + 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 + 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. + nsupdate and the name server. For instance, suitable key and server statements would be added to /etc/named.conf so that the name server can associate the appropriate secret key and algorithm with the IP address of the client application that will be using - TSIG authentication. You can use ddns-confgen + TSIG authentication. You can use ddns-confgen to generate suitable configuration fragments. - nsupdate + nsupdate 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

-
+
+ +
+

OPTIONS

+ + +
-d
-

+

+

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

+

+
-D
-

+

+

Extra debug mode. -

+

+
-k keyfile
-

+

+

The file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing - a named.conf-format key + a named.conf-format key statement, which may be generated automatically by - ddns-confgen, or a pair of files whose names are + ddns-confgen, or a pair of files whose names are of the format K{name}.+157.+{random}.key and K{name}.+157.+{random}.private, which can be - generated by dnssec-keygen. + generated by dnssec-keygen. 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 + localhost (disabling the server 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 named if any - local master zone has set update-policy to - local. The location of this key file can be + which is automatically generated by named if any + 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. -

+

+
-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 @@ -151,34 +198,43 @@ 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. -

+

+
-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 + 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. @@ -189,19 +245,23 @@ hmac-sha512. If hmac is not specified, the default is hmac-md5.

-

+

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 +

+ +
+

INPUT FORMAT

+ +

nsupdate reads input from filename or standard input. @@ -215,30 +275,31 @@ 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 specified resource records are present or missing from the zone. - A blank input line (or the send command) + A blank input line (or the send command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server.

-

+

The command formats and their meaning are as follows:

-
+
- server + server {servername} [port]
-

+

+

Sends all dynamic update requests to the name server servername. When no server statement is provided, - nsupdate + nsupdate will send updates to the master server of the correct zone. The MNAME field of that zone's SOA record will identify the master @@ -250,120 +311,142 @@ If no port number is specified, the default DNS port number of 53 is used. -

+

+
- local + local {address} [port]
-

+

+

Sends all dynamic update requests using the local address. When no local statement is provided, - nsupdate + nsupdate will send updates using an address and port chosen by the system. port can additionally be used to make requests come from a specific port. If no port number is specified, the system will assign one. -

+

+
- zone + zone {zonename}
-

+

+

Specifies that all updates are to be made to the zone zonename. If no zone statement is provided, - nsupdate + nsupdate will attempt determine the correct zone to update based on the rest of the input. -

+

+
- class + class {classname}
-

+

+

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

+

+
- ttl + ttl {seconds}
-

+

+

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

+

+
- key + 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 signing algorithm in use; the default is - hmac-md5. The key + hmac-md5. The key command overrides any key specified on the command line via -y or -k. -

+

+
- gsstsig + gsstsig
-

+

+

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

+

+
- oldgsstsig + oldgsstsig
-

+

+

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

+

+
- realm + realm {[realm_name]}
-

+

+

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

+

+
- [prereq] nxdomain + [prereq] nxdomain {domain-name}
-

+

+

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

+

+
- [prereq] yxdomain + [prereq] yxdomain {domain-name}
-

+

+

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

+

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

+

+

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

+

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

+

+

This requires that a resource record of the specified type, class @@ -389,15 +474,17 @@ If class is omitted, IN (internet) is assumed. -

+

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

+

+

The data from each set of prerequisites of this form @@ -418,15 +505,17 @@ are written in the standard text representation of the resource record's RDATA. -

+

+
- [update] del[ete] + [update] del[ete] {domain-name} [ttl] [class] [type [data...]]
-

+

+

Deletes any resource records named domain-name. If @@ -439,73 +528,92 @@ is not supplied. The ttl is ignored, and is only allowed for compatibility. -

+

+
- [update] add + [update] add {domain-name} {ttl} [class] {type} {data...}
-

+

+

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

+

+
- show + show
-

+

+

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

+

+
- send + send
-

+

+

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

+

+
- answer + answer
-

+

+

Displays the answer. -

+

+
- debug + debug
-

+

+

Turn on debugging. -

+

+
- version + version
-

+

+

Print version number. -

+

+
- help + help
-

+

+

Print a list of commands. -

+

+

-

+ +

Lines beginning with a semicolon are comments and are ignored.

-
-
-

EXAMPLES

-

+ +

+ +
+

EXAMPLES

+ +

The examples below show how - nsupdate + nsupdate could be used to insert and delete resource records from the example.com zone. @@ -524,7 +632,7 @@

-

+

Any A records for oldhost.example.com are deleted. @@ -541,7 +649,7 @@

-

+

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

-
-
-

FILES

-
+
+ +
+

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

-

+

+ +
+

SEE ALSO

+ +

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

-
-
-

BUGS

-

+

+ +
+

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.docbook b/bin/pkcs11/pkcs11-destroy.docbook index 3ccd6b9d68..5ab3938fe9 100644 --- a/bin/pkcs11/pkcs11-destroy.docbook +++ b/bin/pkcs11/pkcs11-destroy.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2009-10-05 + - October 05, 2009 + ISC + Internet Systems Consortium, Inc. @@ -42,20 +43,20 @@ - + pkcs11-destroy - - - - -i ID - -l label + + + + -i ID + -l label - + - - DESCRIPTION + DESCRIPTION + pkcs11-destroy destroys keys stored in a PKCS#11 device, identified by their or @@ -66,10 +67,10 @@ five second delay to allow the user to interrupt the process before the destruction takes place. - + - - ARGUMENTS + ARGUMENTS + -m module @@ -120,10 +121,10 @@ - + - - SEE ALSO + SEE ALSO + pkcs11-keygen8 @@ -132,16 +133,6 @@ pkcs11-list8 - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/pkcs11/pkcs11-keygen.docbook b/bin/pkcs11/pkcs11-keygen.docbook index f073d4aede..e894dd3c7f 100644 --- a/bin/pkcs11/pkcs11-keygen.docbook +++ b/bin/pkcs11/pkcs11-keygen.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2009-10-05 + - October 05, 2009 + ISC + Internet Systems Consortium, Inc. @@ -42,30 +43,30 @@ - + pkcs11-keygen - - - - - -b keysize - -l label - - + + + + + -b keysize + -l label + + - - DESCRIPTION + DESCRIPTION + pkcs11-keygen causes a PKCS#11 device to generate a new RSA key pair with the specified and with bits of modulus. - + - - ARGUMENTS + ARGUMENTS + -P @@ -149,10 +150,10 @@ - + - - SEE ALSO + SEE ALSO + pkcs11-list3 @@ -164,21 +165,11 @@ dnssec-keyfromlabel3 , - + - - CAVEAT + CAVEAT + Some PKCS#11 providers crash with big public exponent. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/pkcs11/pkcs11-list.docbook b/bin/pkcs11/pkcs11-list.docbook index 3949364024..66d153cc46 100644 --- a/bin/pkcs11/pkcs11-list.docbook +++ b/bin/pkcs11/pkcs11-list.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2009-10-05 + - October 05, 2009 + ISC + Internet Systems Consortium, Inc. @@ -42,28 +43,28 @@ - + pkcs11-list - - - - -i ID - -l label - + + + + -i ID + -l label + - - DESCRIPTION + DESCRIPTION + pkcs11-list lists the PKCS#11 objects with or or by default all objects. - + - - ARGUMENTS + ARGUMENTS + -P @@ -124,10 +125,10 @@ - + - - SEE ALSO + SEE ALSO + pkcs11-destroy8 @@ -136,16 +137,6 @@ pkcs11-keygen8 - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/python/dnssec-checkds.8 b/bin/python/dnssec-checkds.8 index 958502bd45..3030864a41 100644 --- a/bin/python/dnssec-checkds.8 +++ b/bin/python/dnssec-checkds.8 @@ -1,35 +1,50 @@ -.\" Copyright (C) 2012-2014 Internet Systems Consortium, Inc. ("ISC") -.\" +.\" Copyright (C) 2012-2014 Internet Systems Consortium, Inc. ("ISC") +.\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-checkds +'\" t +.\" Title: dnssec-checkds .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: January 02, 2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2013-01-02 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-CHECKDS" "8" "January 02, 2013" "BIND9" "BIND9" +.TH "DNSSEC\-CHECKDS" "8" "2013\-01\-02" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-checkds \- A DNSSEC delegation consistency checking tool. +dnssec-checkds \- A DNSSEC delegation consistency checking tool\&. .SH "SYNOPSIS" .HP 15 \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} @@ -38,43 +53,44 @@ dnssec\-checkds \- A DNSSEC delegation consistency checking tool. .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. +verifies the correctness of Delegation Signer (DS) or DNSSEC Lookaside Validation (DLV) resource records for keys in a specified zone\&. .SH "OPTIONS" .PP \-f \fIfile\fR .RS 4 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. +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 \-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's parent. For example, to check for DLV records for "example.com" in ISC's DLV zone, use: -\fBdnssec\-checkds \-l dlv.isc.org example.com\fR +Check for a DLV record in the specified lookaside domain, instead of checking for a DS record in the zone\*(Aqs parent\&. For example, to check for DLV records for "example\&.com" in ISC\*(Aqs DLV zone, use: +\fBdnssec\-checkds \-l dlv\&.isc\&.org example\&.com\fR .RE .PP \-d \fIdig path\fR .RS 4 Specifies a path to a \fBdig\fR -binary. Used for testing. +binary\&. Used for testing\&. .RE .PP \-D \fIdsfromkey path\fR .RS 4 Specifies a path to a \fBdnssec\-dsfromkey\fR -binary. Used for testing. +binary\&. Used for testing\&. .RE .SH "SEE ALSO" .PP -\fBdnssec\-dsfromkey\fR(8), -\fBdnssec\-keygen\fR(8), -\fBdnssec\-signzone\fR(8), +\fBdnssec-dsfromkey\fR(8), +\fBdnssec-keygen\fR(8), +\fBdnssec-signzone\fR(8), .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2012\-2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2012-2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/python/dnssec-checkds.docbook b/bin/python/dnssec-checkds.docbook index 71ca015110..55e6fd5129 100644 --- a/bin/python/dnssec-checkds.docbook +++ b/bin/python/dnssec-checkds.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2013-01-02 + - January 02, 2013 + ISC + Internet Systems Consortium, Inc. @@ -43,35 +44,35 @@ - + dnssec-checkds - - - - - zone + + + + + zone - + dnssec-dsfromkey - - - - - zone + + + + + zone - - DESCRIPTION + DESCRIPTION + dnssec-checkds verifies the correctness of Delegation Signer (DS) or DNSSEC Lookaside Validation (DLV) resource records for keys in a specified zone. - + - - OPTIONS + OPTIONS + @@ -118,10 +119,10 @@ - + - - SEE ALSO + SEE ALSO + dnssec-dsfromkey8 , @@ -132,16 +133,6 @@ dnssec-signzone8 , - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/python/dnssec-checkds.html b/bin/python/dnssec-checkds.html index 91cecd5f9e..bc8c3a71ad 100644 --- a/bin/python/dnssec-checkds.html +++ b/bin/python/dnssec-checkds.html @@ -13,72 +13,113 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-checkds - + -
+
-
+ + + + + +

Name

-

dnssec-checkds — A DNSSEC delegation consistency checking tool.

+

+ dnssec-checkds + — A 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}

-
-
-

DESCRIPTION

-

dnssec-checkds +

+ 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 verifies the correctness of Delegation Signer (DS) or DNSSEC Lookaside Validation (DLV) resource records for keys in a specified zone.

-
-
-

OPTIONS

-
+
+ +
+

OPTIONS

+ + +
-f file
-

+

+

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

+

+
-l domain
-

+

+

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

+ dnssec-checkds -l dlv.isc.org example.com +

+
-d dig path
-

- Specifies a path to a dig binary. Used +

+

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

+

+
-D dsfromkey path
-

- Specifies a path to a dnssec-dsfromkey binary. +

+

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

+

+
-
-
-

SEE ALSO

-

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

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/python/dnssec-coverage.8 b/bin/python/dnssec-coverage.8 index de9fa05329..fc895af7a6 100644 --- a/bin/python/dnssec-coverage.8 +++ b/bin/python/dnssec-coverage.8 @@ -1,50 +1,65 @@ -.\" Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC") -.\" +.\" Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-coverage +'\" t +.\" Title: dnssec-coverage .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: March 21, 2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2013-03-21 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-COVERAGE" "8" "March 21, 2013" "BIND9" "BIND9" +.TH "DNSSEC\-COVERAGE" "8" "2013\-03\-21" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-coverage \- checks future DNSKEY coverage for a zone +dnssec-coverage \- checks future DNSKEY coverage for a zone .SH "SYNOPSIS" .HP 16 \fBdnssec\-coverage\fR [\fB\-K\ \fR\fB\fIdirectory\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] [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. +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 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. +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 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.) +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 \-f \fIfile\fR @@ -55,67 +70,68 @@ is specified, then the zone is read from that file; the largest TTL and the DNSK \fB\-m\fR and \fB\-d\fR -options do not need to be specified on the command line. +options do not need to be specified on the command line\&. .RE .PP \-K \fIdirectory\fR .RS 4 -Sets the directory in which keys can be found. Defaults to the current working directory. +Sets the directory in which keys can be found\&. Defaults to the current working directory\&. .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: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' 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 mandatory unless the \fB\-f\fR -has been used to specify a zone file. (If +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.) +has been specified, this option may still be used; it will override the value found in the file\&.) .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: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' 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 mandatory unless the \fB\-f\fR has been used to specify a zone file, or a default key TTL was set with the \fB\-L\fR to -\fBdnssec\-keygen\fR. (If either of those is true, this option may still be used; it will override the value found in the zone or key file.) +\fBdnssec\-keygen\fR\&. (If either of those is true, this option may still be used; it will override the value found in the zone or key file\&.) .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 -\fBnamed\fR. However, if it has been changed by the +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 -\fInamed.conf\fR, then it should also be changed here. +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: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years. +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 \-c \fIcompilezone path\fR .RS 4 Specifies a path to a \fBnamed\-compilezone\fR -binary. Used for testing. +binary\&. Used for testing\&. .RE .SH "SEE ALSO" .PP -\fBdnssec\-checkds\fR(8), -\fBdnssec\-dsfromkey\fR(8), -\fBdnssec\-keygen\fR(8), -\fBdnssec\-signzone\fR(8) +\fBdnssec-checkds\fR(8), +\fBdnssec-dsfromkey\fR(8), +\fBdnssec-keygen\fR(8), +\fBdnssec-signzone\fR(8) .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2013, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/python/dnssec-coverage.docbook b/bin/python/dnssec-coverage.docbook index f6b2666cf6..6943543d23 100644 --- a/bin/python/dnssec-coverage.docbook +++ b/bin/python/dnssec-coverage.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2013-03-21 + - March 21, 2013 + ISC + Internet Systems Consortium, Inc. @@ -42,20 +43,20 @@ - + dnssec-coverage - - - - - - - zone + + + + + + + zone - - DESCRIPTION + DESCRIPTION + 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 @@ -81,10 +82,10 @@ accurate if all the zones that have keys in a given repository share the same TTL parameters.) - + - - OPTIONS + OPTIONS + @@ -196,10 +197,10 @@ - + - - SEE ALSO + SEE ALSO + dnssec-checkds8 @@ -214,16 +215,6 @@ dnssec-signzone8 - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/python/dnssec-coverage.html b/bin/python/dnssec-coverage.html index 9279087f5f..d1f54f624b 100644 --- a/bin/python/dnssec-coverage.html +++ b/bin/python/dnssec-coverage.html @@ -1,44 +1,64 @@ - - dnssec-coverage - + -
+
-
+ + + + + +

Name

-

dnssec-coverage — checks future DNSKEY coverage for a zone

+

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

-
+ + + +

Synopsis

-

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

-
-
-

DESCRIPTION

-

dnssec-coverage +

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

+
+ +
+

DESCRIPTION

+ +

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., @@ -51,33 +71,40 @@ 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

-
+
+ +
+

OPTIONS

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

+

+
-K directory
-

+

+

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

+

+
-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 @@ -86,21 +113,21 @@ 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 mandatory unless 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.)

-
+
-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 @@ -110,58 +137,66 @@ 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 mandatory unless the -f has been used to specify a zone file, or a default key TTL was set with the -L to - dnssec-keygen. (If either of those is true, + dnssec-keygen. (If either of those is true, this option may still be used; it will override the value found in the zone or key file.)

-
+
-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 22.5 days, which is also the default in - named. However, if it has been changed + named. However, if it has been changed by the sig-validity-interval option in 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.

-
+
-c compilezone path
-

- Specifies a path to a named-compilezone binary. +

+

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

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/rndc/rndc.8 b/bin/rndc/rndc.8 index 503108e692..3b31215e25 100644 --- a/bin/rndc/rndc.8 +++ b/bin/rndc/rndc.8 @@ -13,22 +13,37 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: rndc .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: December 04, 2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2013-12-04 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "RNDC" "8" "December 04, 2013" "BIND9" "BIND9" +.TH "RNDC" "8" "2013\-12\-04" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" rndc \- name server control utility .SH "SYNOPSIS" @@ -37,27 +52,27 @@ rndc \- name server control utility .SH "DESCRIPTION" .PP \fBrndc\fR -controls the operation of a name server. It supersedes the +controls the operation of a name server\&. It supersedes the \fBndc\fR -utility that was provided in old BIND releases. If +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. +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 \fBrndc\fR -communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of +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 algorithm is HMAC\-MD5, which uses a shared secret on each end of the connection. This provides TSIG\-style authentication for the command request and the name server's response. All commands sent over the channel must be signed by a key_id known to the server. +\fBnamed\fR, the only supported authentication algorithm is HMAC\-MD5, which uses 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 \fBrndc\fR -reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use. +reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use\&. .SH "OPTIONS" .PP \-b \fIsource\-address\fR .RS 4 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. +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 \-c \fIconfig\-file\fR @@ -65,7 +80,7 @@ as the source address for the connection to the server. Multiple instances are p Use \fIconfig\-file\fR as the configuration file instead of the default, -\fI/etc/rndc.conf\fR. +/etc/rndc\&.conf\&. .RE .PP \-k \fIkey\-file\fR @@ -73,47 +88,47 @@ as the configuration file instead of the default, Use \fIkey\-file\fR as the key file instead of the default, -\fI/etc/rndc.key\fR. The key in -\fI/etc/rndc.key\fR +/etc/rndc\&.key\&. The key in +/etc/rndc\&.key will be used to authenticate commands sent to the server if the \fIconfig\-file\fR -does not exist. +does not exist\&. .RE .PP \-s \fIserver\fR .RS 4 \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\&. 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. +configuration file will be used\&. .RE .PP \-p \fIport\fR .RS 4 Send commands to TCP port \fIport\fR -instead of BIND 9's default control channel port, 953. +instead of BIND 9\*(Aqs default control channel port, 953\&. .RE .PP \-V .RS 4 -Enable verbose logging. +Enable verbose logging\&. .RE .PP \-y \fIkey_id\fR .RS 4 Use the key \fIkey_id\fR -from the configuration file. +from the configuration file\&. \fIkey_id\fR must be known by \fBnamed\fR -with the same algorithm and secret string in order for control message validation to succeed. If no +with the same algorithm and secret string in order for control message validation to succeed\&. If no \fIkey_id\fR 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. +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 @@ -121,338 +136,338 @@ A list of commands supported by \fBrndc\fR can be seen by running \fBrndc\fR -without arguments. +without arguments\&. .PP Currently supported commands are: .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 +\fByes\fR\&. The \fIconfiguration\fR string specified on the command line is the zone configuration text that would ordinarily be placed in -\fInamed.conf\fR. +named\&.conf\&. .sp The configuration is saved in a file called -\fI\fIhash\fR\fR\fI.nzf\fR, where +\fIhash\fR\&.nzf, where \fIhash\fR -is a cryptographic hash generated from the name of the view. When +is 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. +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 \fBaddzone\fR command would add the zone -example.com +example\&.com to the default view: .sp -$\fBrndc addzone example.com '{ type master; file "example.com.db"; };'\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 -\fBrndc delzone\fR. +\fBrndc delzone\fR\&. .RE .PP \fBdelzone \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. Only zones that were originally added via +Delete a zone while the server is running\&. Only zones that were originally added via \fBrndc addzone\fR -can be deleted in this manner. +can be deleted in this manner\&. .sp See also \fBrndc addzone\fR .RE .PP -\fBdumpdb \fR\fB[\-all|\-cache|\-zone|\-adb|\-bad]\fR\fB \fR\fB[\fIview ...\fR]\fR +\fBdumpdb \fR\fB[\-all|\-cache|\-zone|\-adb|\-bad]\fR\fB \fR\fB[\fIview \&.\&.\&.\fR]\fR .RS 4 -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 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.) +option in the BIND 9 Administrator Reference Manual\&.) .RE .PP \fBflush\fR .RS 4 -Flushes the server's cache. +Flushes the server\*(Aqs cache\&. .RE .PP \fBflushname\fR \fIname\fR [\fIview\fR] .RS 4 -Flushes the given name from the view's DNS cache and, if applicable, from the view's nameserver address database or bad\-server cache. +Flushes the given name from the view\*(Aqs DNS cache and, if applicable, from the view\*(Aqs nameserver address database or bad\-server cache\&. .RE .PP \fBflushtree\fR \fIname\fR [\fIview\fR] .RS 4 -Flushes the given name, and all of its subdomains, from the view's DNS cache. Note that this does +Flushes the given name, and all of its subdomains, from the view\*(Aqs DNS cache\&. Note that this does \fInot\fR -affect he server's address database or bad\-server cache. +affect he server\*(Aqs address database or bad\-server 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 -\fBrndc thaw\fR. +\fBrndc thaw\fR\&. .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's process id is returned. This allows an external process to determine when +\fBnamed\fR\*(Aqs process id is returned\&. This allows an external process to determine when \fBnamed\fR -had completed halting. +had completed halting\&. .sp See also -\fBrndc stop\fR. +\fBrndc stop\fR\&. .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's 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. +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 \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.) +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 \fBnotify \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 -Resend NOTIFY messages for the zone. +Resend NOTIFY messages for the zone\&. .RE .PP \fBnotrace\fR .RS 4 -Sets the server's debugging level to 0. +Sets the server\*(Aqs debugging level to 0\&. .sp See also -\fBrndc trace\fR. +\fBrndc trace\fR\&. .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 -\fBqueries\fR -\fBcategory\fR +\fBqueries\fR\fBcategory\fR to a \fBchannel\fR in the \fBlogging\fR section of -\fInamed.conf\fR +named\&.conf or by specifying \fBquerylog yes;\fR in the \fBoptions\fR section of -\fInamed.conf\fR. +named\&.conf\&. .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. +when there is a large number of zones because it avoids the need to examine the modification times of the zones files\&. .RE .PP \fBrecursing\fR .RS 4 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 +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.) +option\&.) .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. +Schedule zone maintenance for the given zone\&. .RE .PP \fBreload\fR .RS 4 -Reload configuration file and zones. +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. +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 -\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. +\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 -\fBsecroots \fR\fB[\fIview ...\fR]\fR +\fBsecroots \fR\fB[\fIview \&.\&.\&.\fR]\fR .RS 4 -Dump the server's security roots to the secroots file for the specified views. If no view is specified, security roots for all views are dumped. +Dump the server\*(Aqs security roots to the secroots file for the specified views\&. If no view is specified, security roots for all views are dumped\&. .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 \fBkey\-directory\fR -option in the BIND 9 Administrator Reference Manual). If they are within their publication period, merge them into the zone's DNSKEY RRset. If the DNSKEY RRset is changed, then the zone is automatically re\-signed with the new key set. +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 \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.) +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 -\fBrndc loadkeys\fR. +\fBrndc loadkeys\fR\&. .RE .PP \fBsigning \fR\fB[( \-list | \-clear \fIkeyid/algorithm\fR | \-clear all | \-nsec3param ( \fIparameters\fR | none ) ) ]\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 -\fBsig\-signing\-type\fR. +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. +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 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. +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 -sets the NSEC3 parameters for a zone. This is the only supported mechanism for using NSEC3 with +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. +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 -1, representing SHA\-1. The +1, representing SHA\-1\&. The \fBflags\fR may be set to 0 or -1, depending on whether you wish to set the opt\-out bit in the NSEC3 chain. +1, depending on whether you wish to set the opt\-out bit in the NSEC3 chain\&. \fBiterations\fR -defines the number of additional times to apply the algorithm when generating an NSEC3 hash. The +defines the number of additional times to apply the algorithm when generating an NSEC3 hash\&. The \fBsalt\fR -is a string of data expressed in hexadecimal, or a hyphen (`\-') if no salt is to be used. +is a string of data expressed in hexadecimal, or a hyphen (`\-\*(Aq) if no salt is to be used\&. .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: -\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. +\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 -removes an existing NSEC3 chain and replaces it with NSEC. +removes an existing NSEC3 chain and replaces it with NSEC\&. .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.) +option in the BIND 9 Administrator Reference Manual\&.) .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. +\fB\&./IN\fR +hint zone if there is not an explicit root zone configured\&. .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's process id is returned. This allows an external process to determine when +\fBnamed\fR\*(Aqs process id is returned\&. This allows an external process to determine when \fBnamed\fR -had completed stopping. +had completed stopping\&. .sp See also -\fBrndc halt\fR. +\fBrndc halt\fR\&. .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. +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. +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 -\fBrndc freeze\fR. +\fBrndc freeze\fR\&. .RE .PP \fBtrace\fR .RS 4 -Increment the servers debugging level by one. +Increment the servers debugging level by one\&. .RE .PP \fBtrace \fR\fB\fIlevel\fR\fR .RS 4 -Sets the server's debugging level to an explicit value. +Sets the server\*(Aqs debugging level to an explicit value\&. .sp See also -\fBrndc notrace\fR. +\fBrndc notrace\fR\&. .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.) +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 \fBnamed\fR -in each view. The list both statically configured keys and dynamic TKEY\-negotiated keys. +in each view\&. The list both statically configured keys and dynamic TKEY\-negotiated keys\&. .RE .PP -\fBvalidation ( on | off | check ) \fR\fB[\fIview ...\fR]\fR\fB \fR +\fBvalidation ( on | off | check ) \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. +to be effective\&. It defaults to enabled\&. .RE .SH "LIMITATIONS" .PP There is currently no way to provide the shared secret for a \fBkey_id\fR -without using the configuration file. +without using the configuration file\&. .PP -Several error messages could be clearer. +Several error messages could be clearer\&. .SH "SEE ALSO" .PP \fBrndc.conf\fR(5), -\fBrndc\-confgen\fR(8), +\fBrndc-confgen\fR(8), \fBnamed\fR(8), \fBnamed.conf\fR(5), \fBndc\fR(8), -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004, 2005, 2007, 2013\-2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2004, 2005, 2007, 2013-2015 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. .br diff --git a/bin/rndc/rndc.conf.5 b/bin/rndc/rndc.conf.5 index ce7b09930e..961c0bfa97 100644 --- a/bin/rndc/rndc.conf.5 +++ b/bin/rndc/rndc.conf.5 @@ -13,33 +13,48 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: \fIrndc.conf\fR +'\" t +.\" Title: rndc.conf .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "\fIRNDC.CONF\fR" "5" "June 18, 2007" "BIND9" "BIND9" +.TH "RNDC\&.CONF" "5" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" rndc.conf \- rndc configuration file .SH "SYNOPSIS" .HP 10 -\fBrndc.conf\fR +\fBrndc\&.conf\fR .SH "DESCRIPTION" .PP -\fIrndc.conf\fR +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 -\fInamed.conf\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: +\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 C style: /* */ .PP @@ -47,129 +62,144 @@ C++ style: // to end of line .PP Unix style: # to end of line .PP -\fIrndc.conf\fR +rndc\&.conf is much simpler than -\fInamed.conf\fR. The file uses three statements: an options statement, a server statement and a key statement. +named\&.conf\&. The file uses three statements: an options statement, a server statement and a key statement\&. .PP The \fBoptions\fR -statement contains five clauses. The +statement contains five clauses\&. The \fBdefault\-server\fR -clause is followed by the name or address of a name server. This host will be used when no name server is given as an argument to -\fBrndc\fR. The +clause is followed by the name or address of a name server\&. This host will be used when no name server is given as an argument to +\fBrndc\fR\&. The \fBdefault\-key\fR clause is followed by the name of a key which is identified by a \fBkey\fR -statement. If no +statement\&. If no \fBkeyid\fR is provided on the rndc command line, and no \fBkey\fR clause is found in a matching \fBserver\fR -statement, this default key will be used to authenticate the server's commands and responses. The +statement, this default key will be used to authenticate the server\*(Aqs commands and responses\&. The \fBdefault\-port\fR -clause is followed by the port to connect to on the remote name server. If no +clause is followed by the port to connect to on the remote name server\&. If no \fBport\fR option is provided on the rndc command line, and no \fBport\fR clause is found in a matching \fBserver\fR -statement, this default port will be used to connect. The +statement, this default port will be used to connect\&. The \fBdefault\-source\-address\fR and \fBdefault\-source\-address\-v6\fR -clauses which can be used to set the IPv4 and IPv6 source addresses respectively. +clauses which can be used to set the IPv4 and IPv6 source addresses respectively\&. .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: +keyword, the server statement includes a string which is the hostname or address for a name server\&. The statement has three possible clauses: \fBkey\fR, \fBport\fR and -\fBaddresses\fR. The key name must match the name of a key statement in the file. The port number specifies the port to connect to. If an +\fBaddresses\fR\&. The key name must match the name of a key statement in the file\&. The port number specifies the port to connect to\&. If an \fBaddresses\fR -clause is supplied these addresses will be used instead of the server name. Each address can take an optional port. If an +clause is supplied these addresses will be used instead of the server name\&. Each address can take an optional port\&. If an \fBsource\-address\fR or \fBsource\-address\-v6\fR -of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively. +of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively\&. .PP The \fBkey\fR -statement begins with an identifying string, the name of the key. The statement has two clauses. +statement begins with an identifying string, the name of the key\&. The statement has two clauses\&. \fBalgorithm\fR identifies the encryption algorithm for \fBrndc\fR -to use; currently only HMAC\-MD5 is supported. This is followed by a secret clause which contains the base\-64 encoding of the algorithm's encryption key. The base\-64 string is enclosed in double quotes. +to use; currently only HMAC\-MD5 is supported\&. This is followed by a secret clause which contains the base\-64 encoding of the algorithm\*(Aqs encryption key\&. The base\-64 string is enclosed in double quotes\&. .PP -There are two common ways to generate the base\-64 string for the secret. The BIND 9 program +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 \fBmmencode\fR program, also known as -\fBmimencode\fR, can be used to generate a base\-64 string from known input. +\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. +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 +.if n \{\ .RS 4 +.\} .nf options { default\-server localhost; default\-key samplekey; }; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf server localhost { key samplekey; }; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf server testserver { key testkey; addresses { localhost port 5353; }; }; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf key samplekey { algorithm hmac\-md5; secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz"; }; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf key testkey { algorithm hmac\-md5; secret "R3HI8P6BKw9ZwXwN3VZKuQ=="; }; .fi +.if n \{\ .RE -.sp +.\} .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's configuration file with the same name and secret. The key statement indicates that samplekey uses the HMAC\-MD5 algorithm and its secret clause contains the base\-64 encoding of the HMAC\-MD5 secret enclosed in double quotes. +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\-MD5 algorithm and its secret clause contains the base\-64 encoding of the HMAC\-MD5 secret enclosed in double quotes\&. .PP If \fBrndc \-s testserver\fR is used then \fBrndc\fR -will connect to server on localhost port 5353 using the key testkey. +will connect to server on localhost port 5353 using the key testkey\&. .PP To generate a random secret with \fBrndc\-confgen\fR: @@ -177,14 +207,14 @@ To generate a random secret with \fBrndc\-confgen\fR .PP A complete -\fIrndc.conf\fR -file, including the randomly generated key, will be written to the standard output. Commented\-out +rndc\&.conf +file, including the randomly generated key, will be written to the standard output\&. Commented\-out \fBkey\fR and \fBcontrols\fR statements for -\fInamed.conf\fR -are also printed. +named\&.conf +are also printed\&. .PP To generate a base\-64 secret with \fBmmencode\fR: @@ -193,21 +223,22 @@ To generate a base\-64 secret with .SH "NAME SERVER CONFIGURATION" .PP The name server must be configured to accept rndc connections and to recognize the key specified in the -\fIrndc.conf\fR +rndc\&.conf file, using the controls statement in -\fInamed.conf\fR. See the sections on the +named\&.conf\&. See the sections on the \fBcontrols\fR -statement in the BIND 9 Administrator Reference Manual for details. +statement in the BIND 9 Administrator Reference Manual for details\&. .SH "SEE ALSO" .PP \fBrndc\fR(8), -\fBrndc\-confgen\fR(8), +\fBrndc-confgen\fR(8), \fBmmencode\fR(1), -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/bin/rndc/rndc.conf.docbook b/bin/rndc/rndc.conf.docbook index 8dcdef8197..b1865bcd86 100644 --- a/bin/rndc/rndc.conf.docbook +++ b/bin/rndc/rndc.conf.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -50,13 +51,13 @@ - + rndc.conf - - DESCRIPTION + DESCRIPTION + rndc.conf is the configuration file for rndc, the BIND 9 name server control utility. This file has a similar structure and syntax to @@ -139,10 +140,10 @@ ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each. - + - - EXAMPLE + EXAMPLE + options { @@ -211,10 +212,10 @@ echo "known plaintext for a secret" | mmencode - + - - NAME SERVER CONFIGURATION + NAME SERVER CONFIGURATION + The name server must be configured to accept rndc connections and to recognize the key specified in the rndc.conf @@ -222,10 +223,10 @@ See the sections on the statement in the BIND 9 Administrator Reference Manual for details. - + - - SEE ALSO + SEE ALSO + rndc8 , @@ -237,16 +238,6 @@ , BIND 9 Administrator Reference Manual. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/rndc/rndc.conf.html b/bin/rndc/rndc.conf.html index 5b33584b98..22683ada82 100644 --- a/bin/rndc/rndc.conf.html +++ b/bin/rndc/rndc.conf.html @@ -14,53 +14,67 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - rndc.conf - + -
+
-
+ + + + + +

Name

-

rndc.conf — rndc configuration file

+

+ rndc.conf + — rndc configuration file +

-
+ + + +

Synopsis

-

rndc.conf

-
-
-

DESCRIPTION

-

rndc.conf is the configuration file - for rndc, the BIND 9 name server control +

+ rndc.conf +

+
+ +
+

DESCRIPTION

+ +

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

-

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 no name server is given as an argument to - rndc. The default-key + rndc. The default-key clause is followed by the name of a key which is identified by a key statement. If no keyid is provided on the rndc command line, @@ -78,7 +92,7 @@ can be used to set the IPv4 and IPv6 source addresses respectively.

-

+

After the server keyword, the server statement includes a string which is the hostname or address for a name server. The statement has three possible clauses: @@ -92,33 +106,36 @@ 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 encryption algorithm - for rndc to use; currently only HMAC-MD5 + for rndc to use; currently only HMAC-MD5 is supported. This is followed by a secret clause which contains the base-64 encoding of the algorithm's encryption 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 + secret. The BIND 9 program rndc-confgen can be used to generate a random key, or the - mmencode program, also known as - mimencode, can be used to generate a + mmencode program, also known as + mimencode, can be used to generate a base-64 - string from known input. mmencode does + string from known input. mmencode does not ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each.

-
-
-

EXAMPLE

-
+  
+ +
+

EXAMPLE

+ + +
       options {
         default-server  localhost;
         default-key     samplekey;
@@ -126,14 +143,14 @@
 

-
+    
       server localhost {
         key             samplekey;
       };
 

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

-
+    
       key samplekey {
         algorithm       hmac-md5;
         secret          "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
@@ -149,7 +166,7 @@
 

-
+    
       key testkey {
         algorithm	hmac-md5;
         secret		"R3HI8P6BKw9ZwXwN3VZKuQ==";
@@ -157,8 +174,9 @@
     

-

- In the above example, rndc will by + +

+ In the above example, rndc 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 @@ -167,16 +185,16 @@ uses the HMAC-MD5 algorithm and its secret clause contains the base-64 encoding of the HMAC-MD5 secret enclosed in double quotes.

-

- If rndc -s testserver is used then rndc will +

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

+ 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 @@ -184,34 +202,40 @@ controls statements for named.conf are also printed.

-

- To generate a base-64 secret with mmencode: +

+ 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

-

+

+ +
+

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), +

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/rndc/rndc.docbook b/bin/rndc/rndc.docbook index 141ce5f37c..5007e8d818 100644 --- a/bin/rndc/rndc.docbook +++ b/bin/rndc/rndc.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2013-12-04 + - December 04, 2013 + ISC + Internet Systems Consortium, Inc. @@ -52,21 +53,21 @@ - + rndc - - - - - - - - command + + + + + + + + command - - DESCRIPTION + DESCRIPTION + rndc controls the operation of a name server. It supersedes the ndc utility @@ -93,10 +94,10 @@ determine how to contact the name server and decide what algorithm and key it should use. - + - - OPTIONS + OPTIONS + @@ -196,10 +197,10 @@ - + - - COMMANDS + COMMANDS + A list of commands supported by rndc can be seen by running rndc without arguments. @@ -726,10 +727,10 @@ - + - - LIMITATIONS + LIMITATIONS + There is currently no way to provide the shared secret for a without using the configuration file. @@ -737,10 +738,10 @@ Several error messages could be clearer. - + - - SEE ALSO + SEE ALSO + rndc.conf5 , @@ -758,16 +759,6 @@ , BIND 9 Administrator Reference Manual. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/rndc/rndc.html b/bin/rndc/rndc.html index 0daea8a285..d2c850390d 100644 --- a/bin/rndc/rndc.html +++ b/bin/rndc/rndc.html @@ -14,39 +14,61 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - rndc - + -
+
-
+ + + + + +

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

-
-
-

DESCRIPTION

-

rndc +

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

+
+ +
+

DESCRIPTION

+ +

rndc controls the operation of a name - server. It supersedes the ndc utility + server. It supersedes the ndc utility that was provided in old BIND releases. If - rndc is invoked with no command line + rndc 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.

-

rndc +

rndc communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of - rndc and named, + rndc and named, the only supported authentication algorithm is HMAC-MD5, which uses a shared secret on each end of the connection. This provides TSIG-style authentication for the command @@ -54,30 +76,38 @@ over the channel must be signed by a key_id known to the server.

-

rndc +

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

-
-
-

OPTIONS

-
+
+ +
+

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 @@ -85,37 +115,45 @@ 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 + 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 + 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. -

+

+
-V
-

+

+

Enable verbose logging. -

+

+
-y key_id
-

+

+

Use the key key_id from the configuration file. key_id must be - known by named with the same algorithm and secret string + known by named with the same algorithm and secret string in order for control message validation to succeed. If no key_id - is specified, rndc will first look + is specified, rndc 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. @@ -123,99 +161,111 @@ 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. +

+ +
+

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 + allow-new-zones option to be set to yes. The configuration string specified on the command line is the zone configuration text that would ordinarily be placed in named.conf.

-

+

The configuration is saved in a file called hash.nzf, where hash is a cryptographic hash generated from the name of - the view. When named is + the view. When named is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart.

-

- This sample addzone command +

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

+ See also rndc delzone.

-
+
delzone zone [class [view]]
-

+

Delete a zone while the server is running. Only zones that were originally added via - rndc addzone can be deleted + rndc addzone can be deleted in this manner.

-

- See also rndc addzone +

+ See also rndc addzone

-
+
dumpdb [-all|-cache|-zone|-adb|-bad] [view ...]
-

+

+

Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is specified, all views are dumped. - (See the dump-file option in + (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 or bad-server cache. -

+

+
flushtree name [view]
-

+

+

Flushes the given name, and all of its subdomains, from the view's DNS cache. Note that this does not affect he server's address database or bad-server cache. -

+

+
freeze [zone [class [view]]]
-

+

Suspend updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by @@ -224,145 +274,159 @@ All dynamic update attempts will be refused while the zone is frozen.

-

- See also rndc thaw. +

+ 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 journal files when the server is restarted. - If -p is specified named's process id is returned. - This allows an external process to determine when named + If -p is specified named's process id is returned. + This allows an external process to determine when named had completed halting.

-

- See also rndc stop. +

+ 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 - zone's DNSKEY RRset. Unlike rndc + zone's DNSKEY RRset. Unlike rndc sign, however, the zone is not 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 + auto-dnssec 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.)

-
+
notify zone [class [view]]
-

+

+

Resend NOTIFY messages for the zone. -

+

+
notrace
-

+

Sets the server's debugging level to 0.

-

- See also rndc trace. +

+ See also rndc trace.

-
+
querylog [on|off]
-

+

Enable or disable query logging. (For backward compatibility, this command can also be used without an argument to toggle query logging on and off.)

-

+

Query logging can also be enabled - by explicitly directing the queries - category to a - channel in the - logging section of + by explicitly directing the queries + category to a + channel in the + logging section of named.conf or by specifying - querylog yes; in the - options section of + querylog yes; in the + 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. - This is faster than a full reload when there + This is faster than a full reload when there 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 +

+

+ 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 + inline-signing, 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.

-
+
secroots [view ...]
-

+

+

Dump the server's security roots to the secroots file for the specified views. If no view is specified, security roots for all views are dumped. -

+

+
sign zone [class [view]]
-

+

Fetch all DNSSEC keys for the given zone from the key directory (see the - key-directory option in + key-directory option in the BIND 9 Administrator Reference Manual). If they are within their publication period, merge them into the zone's DNSKEY RRset. If the DNSKEY RRset 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 + auto-dnssec zone option be set to allow or maintain, and also requires the zone to be configured to @@ -370,44 +434,44 @@ (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)

-

- See also rndc loadkeys. +

+ See also rndc loadkeys.

-
+
signing [( -list | -clear keyid/algorithm | -clear all | -nsec3param ( parameters | none ) ) ] zone [class [view]]
-

+

List, edit, or remove the DNSSEC signing state records for the specified zone. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type - sig-signing-type. - rndc signing -list converts + sig-signing-type. + rndc signing -list 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.

-

- rndc signing -clear can remove +

+ rndc signing -clear can remove a single key (specified in the same format that - rndc signing -list uses to + rndc signing -list 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.

-

- rndc signing -nsec3param sets +

+ rndc signing -nsec3param sets the NSEC3 parameters for a zone. This is the only supported mechanism for using NSEC3 with - inline-signing zones. + inline-signing zones. Parameters are specified in the same format as 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 @@ -420,57 +484,63 @@ in hexadecimal, or a hyphen (`-') if no salt is to be used.

-

+

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: - rndc signing -nsec3param 1 0 10 FFFF zone. + rndc signing -nsec3param 1 0 10 FFFF zone. To set the opt-out flag, 15 iterations, and no salt, use: - rndc signing -nsec3param 1 1 15 - zone. + rndc signing -nsec3param 1 1 15 - zone.

-

- rndc signing -nsec3param none +

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

-
+
stats
-

+

+

Write server statistics to the statistics file. - (See the statistics-file option in + (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 + 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. - If -p is specified named's process id is returned. - This allows an external process to determine when named + If -p is specified named's process id is returned. + 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 @@ -478,76 +548,94 @@ load has completed. After a zone is thawed, dynamic updates will no longer be refused. If the zone has changed and the - ixfr-from-differences option is + ixfr-from-differences 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.

-

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

+ 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 + for use by named in each view. The list both statically configured keys and dynamic TKEY-negotiated keys. -

+

+
validation ( on | off | check ) [view ...]
-

+

+

Enable, disable, or check the current status of DNSSEC validation. - Note dnssec-enable also needs to be + Note dnssec-enable also needs to be set to yes or auto to be effective. It defaults to enabled. -

+

+
-
-
-

LIMITATIONS

-

+

+ +
+

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), +

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/tools/arpaname.1 b/bin/tools/arpaname.1 index d8a43171f5..261b2edc93 100644 --- a/bin/tools/arpaname.1 +++ b/bin/tools/arpaname.1 @@ -12,22 +12,37 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: arpaname .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: March 03, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2009-03-03 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "ARPANAME" "1" "March 03, 2009" "BIND9" "BIND9" +.TH "ARPANAME" "1" "2009\-03\-03" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" arpaname \- translate IP addresses to the corresponding ARPA names .SH "SYNOPSIS" @@ -36,13 +51,14 @@ arpaname \- translate IP addresses to the corresponding ARPA names .SH "DESCRIPTION" .PP \fBarpaname\fR -translates IP addresses (IPv4 and IPv6) to the corresponding IN\-ADDR.ARPA or IP6.ARPA names. +translates IP addresses (IPv4 and IPv6) to the corresponding IN\-ADDR\&.ARPA or IP6\&.ARPA names\&. .SH "SEE ALSO" .PP -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/arpaname.docbook b/bin/tools/arpaname.docbook index 04fd54aec5..77b430e39a 100644 --- a/bin/tools/arpaname.docbook +++ b/bin/tools/arpaname.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2009-03-03 + - March 03, 2009 + ISC + Internet Systems Consortium, Inc. - arpaname 1 @@ -42,35 +42,25 @@ - + arpaname ipaddress - - DESCRIPTION + DESCRIPTION + arpaname translates IP addresses (IPv4 and IPv6) to the corresponding IN-ADDR.ARPA or IP6.ARPA names. - + - - SEE ALSO + SEE ALSO + BIND 9 Administrator Reference Manual. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/tools/arpaname.html b/bin/tools/arpaname.html index 29ea03b513..7b2080c5b4 100644 --- a/bin/tools/arpaname.html +++ b/bin/tools/arpaname.html @@ -13,40 +13,52 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - arpaname - + -
+
-
+ + + + +

Name

-

arpaname — translate IP addresses to the corresponding ARPA names

-
-
-

Synopsis

-

arpaname {ipaddress ...}

-
-
-

DESCRIPTION

- arpaname translates IP addresses (IPv4 and + arpaname + — translate IP addresses to the corresponding ARPA names +

+
+ + + +
+

Synopsis

+

+ arpaname + {ipaddress ...} +

+
+ +
+

DESCRIPTION

+ +

+ arpaname translates IP addresses (IPv4 and IPv6) to the corresponding IN-ADDR.ARPA or IP6.ARPA names.

-
-
-

SEE ALSO

-

+

+ +
+

SEE ALSO

+ +

BIND 9 Administrator Reference Manual.

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/tools/genrandom.8 b/bin/tools/genrandom.8 index 30d50d7eaa..d9bc40b6f2 100644 --- a/bin/tools/genrandom.8 +++ b/bin/tools/genrandom.8 @@ -12,22 +12,37 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: genrandom .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: August 08, 2011 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2011-08-08 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "GENRANDOM" "8" "August 08, 2011" "BIND9" "BIND9" +.TH "GENRANDOM" "8" "2011\-08\-08" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" genrandom \- generate a file containing random data .SH "SYNOPSIS" @@ -36,7 +51,7 @@ genrandom \- generate a file containing random data .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. +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 \-n \fInumber\fR @@ -45,17 +60,17 @@ In place of generating one file, generates \fBnumber\fR (from 2 to 9) files, appending \fBnumber\fR -to the name. +to the name\&. .RE .PP size .RS 4 -The size of the file, in kilobytes, to generate. +The size of the file, in kilobytes, to generate\&. .RE .PP filename .RS 4 -The file name into which random data should be written. +The file name into which random data should be written\&. .RE .SH "SEE ALSO" .PP @@ -63,7 +78,8 @@ The file name into which random data should be written. \fBarc4random\fR(3) .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2009\-2011, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2009-2011, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/genrandom.docbook b/bin/tools/genrandom.docbook index ecc206a549..a53cd90b50 100644 --- a/bin/tools/genrandom.docbook +++ b/bin/tools/genrandom.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2011-08-08 + - August 08, 2011 + ISC + Internet Systems Consortium, Inc. @@ -44,26 +45,26 @@ - + genrandom - - size - filename + + size + filename - - DESCRIPTION + 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 + ARGUMENTS + -n number @@ -93,10 +94,10 @@ - + - - SEE ALSO + SEE ALSO + rand3 @@ -105,16 +106,6 @@ arc4random3 - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/tools/genrandom.html b/bin/tools/genrandom.html index e125a01208..36afe6bcdf 100644 --- a/bin/tools/genrandom.html +++ b/bin/tools/genrandom.html @@ -13,61 +13,88 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - genrandom - + -
+
-
+ + + + + +

Name

-

genrandom — generate a file containing random data

-
-
-

Synopsis

-

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

-
-
-

DESCRIPTION

- genrandom + genrandom + — generate a file containing random data +

+
+ + + +
+

Synopsis

+

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

+
+ +
+

DESCRIPTION

+ +

+ genrandom generates a file or a set of files containing a specified quantity of pseudo-random data, which can be used as a source of entropy for other commands on systems with no random device.

-
-
-

ARGUMENTS

-
+
+ +
+

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

+ +
+

SEE ALSO

+ +

+ + rand(3) + , + + arc4random(3) +

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/tools/isc-hmac-fixup.8 b/bin/tools/isc-hmac-fixup.8 index 1b842fbd00..2c428a4769 100644 --- a/bin/tools/isc-hmac-fixup.8 +++ b/bin/tools/isc-hmac-fixup.8 @@ -12,50 +12,66 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: isc\-hmac\-fixup +'\" t +.\" Title: isc-hmac-fixup .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: April 28, 2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2013-04-28 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "ISC\-HMAC\-FIXUP" "8" "April 28, 2013" "BIND9" "BIND9" +.TH "ISC\-HMAC\-FIXUP" "8" "2013\-04\-28" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "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 .SH "SYNOPSIS" .HP 15 \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. +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 -This bug has been fixed in BIND 9.7. However, the fix may cause incompatibility between older and newer versions of BIND, when using long keys. +This bug has been fixed in BIND 9\&.7\&. However, the fix may cause incompatibility between older and newer versions of BIND, when using long keys\&. \fBisc\-hmac\-fixup\fR -modifies those keys to restore compatibility. +modifies those keys to restore compatibility\&. .PP To modify a key, run \fBisc\-hmac\-fixup\fR -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 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.) +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 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." +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 BIND 9 Administrator Reference Manual, -RFC 2104. +RFC 2104\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/isc-hmac-fixup.docbook b/bin/tools/isc-hmac-fixup.docbook index 986c30b855..2d2774a2ae 100644 --- a/bin/tools/isc-hmac-fixup.docbook +++ b/bin/tools/isc-hmac-fixup.docbook @@ -1,8 +1,6 @@ -]> + - - + + + 2013-04-28 + - April 28, 2013 + ISC + Internet Systems Consortium, Inc. @@ -43,15 +44,15 @@ - + isc-hmac-fixup - algorithm - secret + algorithm + secret - - DESCRIPTION + 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 @@ -75,10 +76,10 @@ secret. (If the secret did not require conversion, then it will be printed without modification.) - + - - SECURITY CONSIDERATIONS + SECURITY CONSIDERATIONS + Secrets that have been converted by isc-hmac-fixup are shortened, but as this is how the HMAC protocol works in @@ -87,24 +88,14 @@ extra length would not significantly increase the function strength." - + - - SEE ALSO + SEE ALSO + BIND 9 Administrator Reference Manual, RFC 2104. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/tools/isc-hmac-fixup.html b/bin/tools/isc-hmac-fixup.html index cb975589c2..38f82c0d97 100644 --- a/bin/tools/isc-hmac-fixup.html +++ b/bin/tools/isc-hmac-fixup.html @@ -13,26 +13,42 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - isc-hmac-fixup - + -
+
-
+ + + + + +

Name

-

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

-
-
-

Synopsis

-

isc-hmac-fixup {algorithm} {secret}

-
-
-

DESCRIPTION

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

+
+ + + +
+

Synopsis

+

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

+
+ +
+

DESCRIPTION

+ +

Versions of BIND 9 up to and including BIND 9.6 had a bug causing HMAC-SHA* TSIG keys which were longer than the digest length of the hash algorithm (i.e., SHA1 keys longer than 160 bits, SHA256 keys @@ -40,14 +56,14 @@ message authentication code that was incompatible with other DNS implementations.

-

+

This bug has been fixed in BIND 9.7. However, the fix may cause incompatibility between older and newer versions of - BIND, when using long keys. isc-hmac-fixup + BIND, when using long keys. isc-hmac-fixup modifies those keys to restore compatibility.

-

- To modify a key, run isc-hmac-fixup and +

+ 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 for SHA1 through SHA256, or 128 bytes for SHA384 and SHA512), then a @@ -55,29 +71,29 @@ 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 +

+ +
+

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, "Keys longer than [the digest length] are acceptable but the extra length would not significantly increase the function strength."

-
-
-

SEE ALSO

-

+

+ +
+

SEE ALSO

+ +

BIND 9 Administrator Reference Manual, RFC 2104.

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/tools/named-journalprint.8 b/bin/tools/named-journalprint.8 index ec91eb2734..6054854b01 100644 --- a/bin/tools/named-journalprint.8 +++ b/bin/tools/named-journalprint.8 @@ -12,49 +12,65 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: named\-journalprint +'\" t +.\" Title: named-journalprint .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: December 04, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2009-12-04 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NAMED\-JOURNALPRINT" "8" "December 04, 2009" "BIND9" "BIND9" +.TH "NAMED\-JOURNALPRINT" "8" "2009\-12\-04" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -named\-journalprint \- print zone journal in human\-readable form +named-journalprint \- print zone journal in human\-readable form .SH "SYNOPSIS" .HP 19 \fBnamed\-journalprint\fR {\fIjournal\fR} .SH "DESCRIPTION" .PP \fBnamed\-journalprint\fR -prints the contents of a zone journal file in a human\-readable form. +prints the contents of a zone journal file in a human\-readable form\&. .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 -\fI.jnl\fR -to the name of the corresponding zone file. +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 \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. +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 \fBnamed\fR(8), \fBnsupdate\fR(8), -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/named-journalprint.docbook b/bin/tools/named-journalprint.docbook index 8d65c8e300..b985254f95 100644 --- a/bin/tools/named-journalprint.docbook +++ b/bin/tools/named-journalprint.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2009-12-04 + - December 04, 2009 + ISC + Internet Systems Consortium, Inc. @@ -42,14 +43,14 @@ - + named-journalprint - journal + journal - - DESCRIPTION + DESCRIPTION + named-journalprint prints the contents of a zone journal file in a human-readable @@ -73,10 +74,10 @@ deleted, and continues with the resource record in master-file format. - + - - SEE ALSO + SEE ALSO + named8 @@ -86,16 +87,6 @@ , BIND 9 Administrator Reference Manual. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/tools/named-journalprint.html b/bin/tools/named-journalprint.html index 3e5e19f239..6d872083ff 100644 --- a/bin/tools/named-journalprint.html +++ b/bin/tools/named-journalprint.html @@ -13,34 +13,49 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - named-journalprint - + -
+
-
+ + + + + +

Name

-

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

-
-
-

Synopsis

-

named-journalprint {journal}

-
-
-

DESCRIPTION

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

+
+ + + +
+

Synopsis

+

+ named-journalprint + {journal} +

+
+ +
+

DESCRIPTION

+ +

+ named-journalprint prints the contents of a zone journal file in a human-readable form.

-

- Journal files are automatically created by named +

+ Journal files are automatically created by named when changes are made to dynamic zones (e.g., by - nsupdate). They record each addition + nsupdate). 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 @@ -48,26 +63,28 @@ .jnl to the name of the corresponding zone file.

-

- named-journalprint converts the contents of a given +

+ named-journalprint converts the contents of a given journal file into a human-readable text format. Each line begins with "add" or "del", to indicate whether the record was added or deleted, and continues with the resource record in master-file format.

-
-
-

SEE ALSO

-

- named(8), - nsupdate(8), +

+ +
+

SEE ALSO

+ +

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

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/tools/nsec3hash.8 b/bin/tools/nsec3hash.8 index d4444ce8e2..8939177ef9 100644 --- a/bin/tools/nsec3hash.8 +++ b/bin/tools/nsec3hash.8 @@ -12,22 +12,37 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: nsec3hash .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: March 02, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2009-03-02 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NSEC3HASH" "8" "March 02, 2009" "BIND9" "BIND9" +.TH "NSEC3HASH" "8" "2009\-03\-02" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" nsec3hash \- generate NSEC3 hash .SH "SYNOPSIS" @@ -36,35 +51,36 @@ nsec3hash \- generate NSEC3 hash .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. +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 salt .RS 4 -The salt provided to the hash algorithm. +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. +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. +The number of additional times the hash should be performed\&. .RE .PP domain .RS 4 -The domain name to be hashed. +The domain name to be hashed\&. .RE .SH "SEE ALSO" .PP BIND 9 Administrator Reference Manual, -RFC 5155. +RFC 5155\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/nsec3hash.docbook b/bin/tools/nsec3hash.docbook index 618e53a1aa..6125fb44c0 100644 --- a/bin/tools/nsec3hash.docbook +++ b/bin/tools/nsec3hash.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2009-03-02 + - March 02, 2009 + ISC + Internet Systems Consortium, Inc. @@ -42,26 +43,26 @@ - + nsec3hash - salt - algorithm - iterations - domain + salt + algorithm + iterations + domain - - DESCRIPTION + 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 + ARGUMENTS + salt @@ -102,24 +103,14 @@ - + - - SEE ALSO + SEE ALSO + BIND 9 Administrator Reference Manual, RFC 5155. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/bin/tools/nsec3hash.html b/bin/tools/nsec3hash.html index acb83e6ee1..aac44a6c64 100644 --- a/bin/tools/nsec3hash.html +++ b/bin/tools/nsec3hash.html @@ -13,66 +13,92 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - nsec3hash - + -
+
-
+ + + + + +

Name

-

nsec3hash — generate NSEC3 hash

-
-
-

Synopsis

-

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

-
-
-

DESCRIPTION

- nsec3hash generates an NSEC3 hash based on + nsec3hash + — generate NSEC3 hash +

+
+ + + +
+

Synopsis

+

+ nsec3hash + {salt} + {algorithm} + {iterations} + {domain} +

+
+ +
+

DESCRIPTION

+ +

+ nsec3hash generates an NSEC3 hash based on a set of NSEC3 parameters. This can be used to check the validity of NSEC3 records in a signed zone.

-
-
-

ARGUMENTS

-
+
+ +
+

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

-

+

+ +
+

SEE ALSO

+ +

BIND 9 Administrator Reference Manual, RFC 5155.

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/configure b/configure index cd23e43887..d2e2825065 100755 --- a/configure +++ b/configure @@ -667,6 +667,7 @@ SO_CFLAGS SO BIND9_CONFIGARGS BIND9_SRCID +BIND9_VERSIONSHORT BIND9_VERSIONSTRING BIND9_MAJOR BIND9_VERSION @@ -684,8 +685,8 @@ ATFLIBS ATFBIN ATFBUILD IDNLIBS -XSLT_DB2LATEX_ADMONITIONS -XSLT_DB2LATEX_STYLE +XSLT_DBLATEX_FASTBOOK +XSLT_DBLATEX_STYLE XSLT_DOCBOOK_MAKETOC_XHTML XSLT_DOCBOOK_MAKETOC_HTML XSLT_DOCBOOK_CHUNKTOC_XHTML @@ -700,6 +701,7 @@ DOXYGEN XMLLINT XSLTPROC W3M +DBLATEX PDFLATEX LATEX ISC_ARCH_DIR @@ -18951,6 +18953,54 @@ test -n "$PDFLATEX" || PDFLATEX="pdflatex" +for ac_prog in dblatex +do + # Extract the first word of "$ac_prog", so it can be a program name with args. +set dummy $ac_prog; ac_word=$2 +{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +$as_echo_n "checking for $ac_word... " >&6; } +if ${ac_cv_path_DBLATEX+:} false; then : + $as_echo_n "(cached) " >&6 +else + case $DBLATEX in + [\\/]* | ?:[\\/]*) + ac_cv_path_DBLATEX="$DBLATEX" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir/$ac_word$ac_exec_ext"; then + ac_cv_path_DBLATEX="$as_dir/$ac_word$ac_exec_ext" + $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + + ;; +esac +fi +DBLATEX=$ac_cv_path_DBLATEX +if test -n "$DBLATEX"; then + { $as_echo "$as_me:${as_lineno-$LINENO}: result: $DBLATEX" >&5 +$as_echo "$DBLATEX" >&6; } +else + { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 +$as_echo "no" >&6; } +fi + + + test -n "$DBLATEX" && break +done +test -n "$DBLATEX" || DBLATEX="dblatex" + + + # # Look for w3m # @@ -19448,67 +19498,56 @@ fi # -# Same dance for db2latex -# -# No idea where this lives except on FreeBSD. +# Same dance for dblatex # +dblatex_xsl_trees="/usr/local/share/xml/docbook/stylesheet/dblatex /usr/pkg/share/xml/docbook/stylesheet/dblatex /usr/share/xml/docbook/stylesheet/dblatex" -db2latex_xsl_trees="/usr/local/share" - -# -# Look for stylesheets we need. -# - - -XSLT_DB2LATEX_STYLE="" -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for db2latex/xsl/docbook.xsl" >&5 -$as_echo_n "checking for db2latex/xsl/docbook.xsl... " >&6; } -for d in $db2latex_xsl_trees +XSLT_DBLATEX_STYLE="" +{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for xsl/docbook.xsl" >&5 +$as_echo_n "checking for xsl/docbook.xsl... " >&6; } +for d in $dblatex_xsl_trees do - f=$d/db2latex/xsl/docbook.xsl + f=$d/xsl/docbook.xsl if test -f $f then - XSLT_DB2LATEX_STYLE=$f + XSLT_DBLATEX_STYLE=$f { $as_echo "$as_me:${as_lineno-$LINENO}: result: $f" >&5 $as_echo "$f" >&6; } break fi done -if test "X$XSLT_DB2LATEX_STYLE" = "X" +if test "X$XSLT_DBLATEX_STYLE" = "X" then { $as_echo "$as_me:${as_lineno-$LINENO}: result: \"not found\"" >&5 $as_echo "\"not found\"" >&6; }; - XSLT_DB2LATEX_STYLE=db2latex/xsl/docbook.xsl + XSLT_DBLATEX_STYLE=xsl/docbook.xsl fi -# -# Look for "admonition" image directory. Can't use NOM_PATH_FILE() -# because it's a directory, so just do the same things, inline. -# - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for db2latex/xsl/figures" >&5 -$as_echo_n "checking for db2latex/xsl/figures... " >&6; } -for d in $db2latex_xsl_trees +XSLT_DBLATEX_FASTBOOK="" +{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for xsl/latex_book_fast.xsl" >&5 +$as_echo_n "checking for xsl/latex_book_fast.xsl... " >&6; } +for d in $dblatex_xsl_trees do - dd=$d/db2latex/xsl/figures - if test -d $dd + f=$d/xsl/latex_book_fast.xsl + if test -f $f then - XSLT_DB2LATEX_ADMONITIONS=$dd - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $dd" >&5 -$as_echo "$dd" >&6; } + XSLT_DBLATEX_FASTBOOK=$f + { $as_echo "$as_me:${as_lineno-$LINENO}: result: $f" >&5 +$as_echo "$f" >&6; } break fi done -if test "X$XSLT_DB2LATEX_ADMONITIONS" = "X" +if test "X$XSLT_DBLATEX_FASTBOOK" = "X" then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: not found" >&5 -$as_echo "not found" >&6; } - XSLT_DB2LATEX_ADMONITIONS=db2latex/xsl/figures + { $as_echo "$as_me:${as_lineno-$LINENO}: result: \"not found\"" >&5 +$as_echo "\"not found\"" >&6; }; + XSLT_DBLATEX_FASTBOOK=xsl/latex_book_fast.xsl fi + # # IDN support # @@ -19737,6 +19776,8 @@ BIND9_MAJOR="MAJOR=${MAJORVER}.${MINORVER}" BIND9_VERSIONSTRING="${PRODUCT} ${MAJORVER}.${MINORVER}${PATCHVER:+.}${PATCHVER}${RELEASETYPE}${RELEASEVER}${EXTENSIONS}${DESCRIPTION:+ }${DESCRIPTION}" +BIND9_VERSIONSHORT="${PRODUCT} ${MAJORVER}.${MINORVER}${PATCHVER:+.}${PATCHVER}${RELEASETYPE}${RELEASEVER}${EXTENSIONS}" + BIND9_SRCID="SRCID=unset" if test -f "${srcdir}/srcid"; then @@ -20924,7 +20965,7 @@ ac_config_commands="$ac_config_commands chmod" # elsewhere if there's a good reason for doing so. # -ac_config_files="$ac_config_files make/Makefile make/mkdep Makefile bin/Makefile bin/check/Makefile bin/confgen/Makefile bin/confgen/unix/Makefile bin/dig/Makefile bin/dnssec/Makefile bin/named/Makefile bin/named/unix/Makefile bin/nsupdate/Makefile bin/pkcs11/Makefile bin/python/Makefile bin/python/dnssec-checkds.py bin/python/dnssec-coverage.py bin/rndc/Makefile bin/tests/Makefile bin/tests/atomic/Makefile bin/tests/db/Makefile bin/tests/dst/Makefile bin/tests/dst/Kdh.+002+18602.key bin/tests/dst/Kdh.+002+18602.private bin/tests/dst/Kdh.+002+48957.key bin/tests/dst/Kdh.+002+48957.private bin/tests/dst/Ktest.+001+00002.key bin/tests/dst/Ktest.+001+54622.key bin/tests/dst/Ktest.+001+54622.private bin/tests/dst/Ktest.+003+23616.key bin/tests/dst/Ktest.+003+23616.private bin/tests/dst/Ktest.+003+49667.key bin/tests/dst/dst_2_data bin/tests/dst/t2_data_1 bin/tests/dst/t2_data_2 bin/tests/dst/t2_dsasig bin/tests/dst/t2_rsasig bin/tests/hashes/Makefile bin/tests/headerdep_test.sh bin/tests/master/Makefile bin/tests/mem/Makefile bin/tests/names/Makefile bin/tests/net/Makefile bin/tests/rbt/Makefile bin/tests/resolver/Makefile bin/tests/sockaddr/Makefile bin/tests/system/Makefile bin/tests/system/conf.sh bin/tests/system/builtin/Makefile bin/tests/system/dlz/prereq.sh bin/tests/system/dlzexternal/Makefile bin/tests/system/dlzexternal/ns1/named.conf bin/tests/system/fetchlimit/Makefile bin/tests/system/filter-aaaa/Makefile bin/tests/system/inline/checkdsa.sh bin/tests/system/lwresd/Makefile bin/tests/system/statistics/Makefile bin/tests/system/rpz/Makefile bin/tests/system/rrl/Makefile bin/tests/system/rsabigexponent/Makefile bin/tests/system/tkey/Makefile bin/tests/system/tsiggss/Makefile bin/tests/tasks/Makefile bin/tests/timers/Makefile bin/tests/virtual-time/Makefile bin/tests/virtual-time/conf.sh bin/tools/Makefile contrib/check-secure-delegation.pl contrib/zone-edit.sh doc/Makefile doc/arm/Makefile doc/doxygen/Doxyfile doc/doxygen/Makefile doc/doxygen/doxygen-input-filter doc/misc/Makefile doc/xsl/Makefile doc/xsl/isc-docbook-chunk.xsl doc/xsl/isc-docbook-html.xsl doc/xsl/isc-docbook-latex.xsl doc/xsl/isc-manpage.xsl doc/xsl/isc-notes-html.xsl doc/xsl/isc-notes-latex.xsl isc-config.sh lib/Makefile lib/bind9/Makefile lib/bind9/include/Makefile lib/bind9/include/bind9/Makefile lib/dns/Makefile lib/dns/include/Makefile lib/dns/include/dns/Makefile lib/dns/include/dst/Makefile lib/dns/tests/Makefile lib/export/Makefile lib/export/dns/Makefile lib/export/dns/include/Makefile lib/export/dns/include/dns/Makefile lib/export/dns/include/dst/Makefile lib/export/irs/Makefile lib/export/irs/include/Makefile lib/export/irs/include/irs/Makefile lib/export/isc/$thread_dir/Makefile lib/export/isc/$thread_dir/include/Makefile lib/export/isc/$thread_dir/include/isc/Makefile lib/export/isc/Makefile lib/export/isc/include/Makefile lib/export/isc/include/isc/Makefile lib/export/isc/nls/Makefile lib/export/isc/unix/Makefile lib/export/isc/unix/include/Makefile lib/export/isc/unix/include/isc/Makefile lib/export/isccfg/Makefile lib/export/isccfg/include/Makefile lib/export/isccfg/include/isccfg/Makefile lib/export/samples/Makefile lib/export/samples/Makefile-postinstall lib/irs/Makefile lib/irs/include/Makefile lib/irs/include/irs/Makefile lib/irs/include/irs/netdb.h lib/irs/include/irs/platform.h lib/isc/$arch/Makefile lib/isc/$arch/include/Makefile lib/isc/$arch/include/isc/Makefile lib/isc/$thread_dir/Makefile lib/isc/$thread_dir/include/Makefile lib/isc/$thread_dir/include/isc/Makefile lib/isc/Makefile lib/isc/include/Makefile lib/isc/include/isc/Makefile lib/isc/include/isc/platform.h lib/isc/tests/Makefile lib/isc/nls/Makefile lib/isc/unix/Makefile lib/isc/unix/include/Makefile lib/isc/unix/include/isc/Makefile lib/isccc/Makefile lib/isccc/include/Makefile lib/isccc/include/isccc/Makefile lib/isccfg/Makefile lib/isccfg/include/Makefile lib/isccfg/include/isccfg/Makefile lib/lwres/Makefile lib/lwres/include/Makefile lib/lwres/include/lwres/Makefile lib/lwres/include/lwres/netdb.h lib/lwres/include/lwres/platform.h lib/lwres/man/Makefile lib/lwres/tests/Makefile lib/lwres/unix/Makefile lib/lwres/unix/include/Makefile lib/lwres/unix/include/lwres/Makefile lib/tests/Makefile lib/tests/include/Makefile lib/tests/include/tests/Makefile unit/Makefile unit/unittest.sh" +ac_config_files="$ac_config_files make/Makefile make/mkdep Makefile bin/Makefile bin/check/Makefile bin/confgen/Makefile bin/confgen/unix/Makefile bin/dig/Makefile bin/dnssec/Makefile bin/named/Makefile bin/named/unix/Makefile bin/nsupdate/Makefile bin/pkcs11/Makefile bin/python/Makefile bin/python/dnssec-checkds.py bin/python/dnssec-coverage.py bin/rndc/Makefile bin/tests/Makefile bin/tests/atomic/Makefile bin/tests/db/Makefile bin/tests/dst/Makefile bin/tests/dst/Kdh.+002+18602.key bin/tests/dst/Kdh.+002+18602.private bin/tests/dst/Kdh.+002+48957.key bin/tests/dst/Kdh.+002+48957.private bin/tests/dst/Ktest.+001+00002.key bin/tests/dst/Ktest.+001+54622.key bin/tests/dst/Ktest.+001+54622.private bin/tests/dst/Ktest.+003+23616.key bin/tests/dst/Ktest.+003+23616.private bin/tests/dst/Ktest.+003+49667.key bin/tests/dst/dst_2_data bin/tests/dst/t2_data_1 bin/tests/dst/t2_data_2 bin/tests/dst/t2_dsasig bin/tests/dst/t2_rsasig bin/tests/hashes/Makefile bin/tests/headerdep_test.sh bin/tests/master/Makefile bin/tests/mem/Makefile bin/tests/names/Makefile bin/tests/net/Makefile bin/tests/rbt/Makefile bin/tests/resolver/Makefile bin/tests/sockaddr/Makefile bin/tests/system/Makefile bin/tests/system/conf.sh bin/tests/system/builtin/Makefile bin/tests/system/dlz/prereq.sh bin/tests/system/dlzexternal/Makefile bin/tests/system/dlzexternal/ns1/named.conf bin/tests/system/fetchlimit/Makefile bin/tests/system/filter-aaaa/Makefile bin/tests/system/inline/checkdsa.sh bin/tests/system/lwresd/Makefile bin/tests/system/statistics/Makefile bin/tests/system/rpz/Makefile bin/tests/system/rrl/Makefile bin/tests/system/rsabigexponent/Makefile bin/tests/system/tkey/Makefile bin/tests/system/tsiggss/Makefile bin/tests/tasks/Makefile bin/tests/timers/Makefile bin/tests/virtual-time/Makefile bin/tests/virtual-time/conf.sh bin/tools/Makefile contrib/check-secure-delegation.pl contrib/zone-edit.sh doc/Makefile doc/arm/Makefile doc/doxygen/Doxyfile doc/doxygen/Makefile doc/doxygen/doxygen-input-filter doc/misc/Makefile doc/tex/Makefile doc/tex/armstyle.sty doc/xsl/Makefile doc/xsl/isc-docbook-chunk.xsl doc/xsl/isc-docbook-html.xsl doc/xsl/isc-manpage.xsl doc/xsl/isc-notes-html.xsl isc-config.sh lib/Makefile lib/bind9/Makefile lib/bind9/include/Makefile lib/bind9/include/bind9/Makefile lib/dns/Makefile lib/dns/include/Makefile lib/dns/include/dns/Makefile lib/dns/include/dst/Makefile lib/dns/tests/Makefile lib/export/Makefile lib/export/dns/Makefile lib/export/dns/include/Makefile lib/export/dns/include/dns/Makefile lib/export/dns/include/dst/Makefile lib/export/irs/Makefile lib/export/irs/include/Makefile lib/export/irs/include/irs/Makefile lib/export/isc/$thread_dir/Makefile lib/export/isc/$thread_dir/include/Makefile lib/export/isc/$thread_dir/include/isc/Makefile lib/export/isc/Makefile lib/export/isc/include/Makefile lib/export/isc/include/isc/Makefile lib/export/isc/nls/Makefile lib/export/isc/unix/Makefile lib/export/isc/unix/include/Makefile lib/export/isc/unix/include/isc/Makefile lib/export/isccfg/Makefile lib/export/isccfg/include/Makefile lib/export/isccfg/include/isccfg/Makefile lib/export/samples/Makefile lib/export/samples/Makefile-postinstall lib/irs/Makefile lib/irs/include/Makefile lib/irs/include/irs/Makefile lib/irs/include/irs/netdb.h lib/irs/include/irs/platform.h lib/isc/$arch/Makefile lib/isc/$arch/include/Makefile lib/isc/$arch/include/isc/Makefile lib/isc/$thread_dir/Makefile lib/isc/$thread_dir/include/Makefile lib/isc/$thread_dir/include/isc/Makefile lib/isc/Makefile lib/isc/include/Makefile lib/isc/include/isc/Makefile lib/isc/include/isc/platform.h lib/isc/tests/Makefile lib/isc/nls/Makefile lib/isc/unix/Makefile lib/isc/unix/include/Makefile lib/isc/unix/include/isc/Makefile lib/isccc/Makefile lib/isccc/include/Makefile lib/isccc/include/isccc/Makefile lib/isccfg/Makefile lib/isccfg/include/Makefile lib/isccfg/include/isccfg/Makefile lib/lwres/Makefile lib/lwres/include/Makefile lib/lwres/include/lwres/Makefile lib/lwres/include/lwres/netdb.h lib/lwres/include/lwres/platform.h lib/lwres/man/Makefile lib/lwres/tests/Makefile lib/lwres/unix/Makefile lib/lwres/unix/include/Makefile lib/lwres/unix/include/lwres/Makefile lib/tests/Makefile lib/tests/include/Makefile lib/tests/include/tests/Makefile unit/Makefile unit/unittest.sh" # @@ -21992,13 +22033,13 @@ do "doc/doxygen/Makefile") CONFIG_FILES="$CONFIG_FILES doc/doxygen/Makefile" ;; "doc/doxygen/doxygen-input-filter") CONFIG_FILES="$CONFIG_FILES doc/doxygen/doxygen-input-filter" ;; "doc/misc/Makefile") CONFIG_FILES="$CONFIG_FILES doc/misc/Makefile" ;; + "doc/tex/Makefile") CONFIG_FILES="$CONFIG_FILES doc/tex/Makefile" ;; + "doc/tex/armstyle.sty") CONFIG_FILES="$CONFIG_FILES doc/tex/armstyle.sty" ;; "doc/xsl/Makefile") CONFIG_FILES="$CONFIG_FILES doc/xsl/Makefile" ;; "doc/xsl/isc-docbook-chunk.xsl") CONFIG_FILES="$CONFIG_FILES doc/xsl/isc-docbook-chunk.xsl" ;; "doc/xsl/isc-docbook-html.xsl") CONFIG_FILES="$CONFIG_FILES doc/xsl/isc-docbook-html.xsl" ;; - "doc/xsl/isc-docbook-latex.xsl") CONFIG_FILES="$CONFIG_FILES doc/xsl/isc-docbook-latex.xsl" ;; "doc/xsl/isc-manpage.xsl") CONFIG_FILES="$CONFIG_FILES doc/xsl/isc-manpage.xsl" ;; "doc/xsl/isc-notes-html.xsl") CONFIG_FILES="$CONFIG_FILES doc/xsl/isc-notes-html.xsl" ;; - "doc/xsl/isc-notes-latex.xsl") CONFIG_FILES="$CONFIG_FILES doc/xsl/isc-notes-latex.xsl" ;; "isc-config.sh") CONFIG_FILES="$CONFIG_FILES isc-config.sh" ;; "lib/Makefile") CONFIG_FILES="$CONFIG_FILES lib/Makefile" ;; "lib/bind9/Makefile") CONFIG_FILES="$CONFIG_FILES lib/bind9/Makefile" ;; diff --git a/configure.in b/configure.in index 7b42ba0c8c..f2e1e6fe71 100644 --- a/configure.in +++ b/configure.in @@ -3366,6 +3366,9 @@ AC_SUBST(LATEX) AC_PATH_PROGS(PDFLATEX, pdflatex, pdflatex) AC_SUBST(PDFLATEX) +AC_PATH_PROGS(DBLATEX, dblatex, dblatex) +AC_SUBST(DBLATEX) + # # Look for w3m # @@ -3471,41 +3474,11 @@ NOM_PATH_FILE(XSLT_DOCBOOK_MAKETOC_HTML, html/maketoc.xsl, $docbook_xsl_trees) NOM_PATH_FILE(XSLT_DOCBOOK_MAKETOC_XHTML, xhtml/maketoc.xsl, $docbook_xsl_trees) # -# Same dance for db2latex +# Same dance for dblatex # -# No idea where this lives except on FreeBSD. -# - -db2latex_xsl_trees="/usr/local/share" - -# -# Look for stylesheets we need. -# - -NOM_PATH_FILE(XSLT_DB2LATEX_STYLE, db2latex/xsl/docbook.xsl, $db2latex_xsl_trees) - -# -# Look for "admonition" image directory. Can't use NOM_PATH_FILE() -# because it's a directory, so just do the same things, inline. -# - -AC_MSG_CHECKING(for db2latex/xsl/figures) -for d in $db2latex_xsl_trees -do - dd=$d/db2latex/xsl/figures - if test -d $dd - then - XSLT_DB2LATEX_ADMONITIONS=$dd - AC_MSG_RESULT($dd) - break - fi -done -if test "X$XSLT_DB2LATEX_ADMONITIONS" = "X" -then - AC_MSG_RESULT(not found) - XSLT_DB2LATEX_ADMONITIONS=db2latex/xsl/figures -fi -AC_SUBST(XSLT_DB2LATEX_ADMONITIONS) +dblatex_xsl_trees="/usr/local/share/xml/docbook/stylesheet/dblatex /usr/pkg/share/xml/docbook/stylesheet/dblatex /usr/share/xml/docbook/stylesheet/dblatex" +NOM_PATH_FILE(XSLT_DBLATEX_STYLE, xsl/docbook.xsl, $dblatex_xsl_trees) +NOM_PATH_FILE(XSLT_DBLATEX_FASTBOOK, xsl/latex_book_fast.xsl, $dblatex_xsl_trees) # # IDN support @@ -3687,6 +3660,8 @@ BIND9_MAJOR="MAJOR=${MAJORVER}.${MINORVER}" AC_SUBST(BIND9_MAJOR) BIND9_VERSIONSTRING="${PRODUCT} ${MAJORVER}.${MINORVER}${PATCHVER:+.}${PATCHVER}${RELEASETYPE}${RELEASEVER}${EXTENSIONS}${DESCRIPTION:+ }${DESCRIPTION}" AC_SUBST(BIND9_VERSIONSTRING) +BIND9_VERSIONSHORT="${PRODUCT} ${MAJORVER}.${MINORVER}${PATCHVER:+.}${PATCHVER}${RELEASETYPE}${RELEASEVER}${EXTENSIONS}" +AC_SUBST(BIND9_VERSIONSHORT) BIND9_SRCID="SRCID=unset" if test -f "${srcdir}/srcid"; then @@ -4080,13 +4055,13 @@ AC_CONFIG_FILES([ doc/doxygen/Makefile doc/doxygen/doxygen-input-filter doc/misc/Makefile + doc/tex/Makefile + doc/tex/armstyle.sty doc/xsl/Makefile doc/xsl/isc-docbook-chunk.xsl doc/xsl/isc-docbook-html.xsl - doc/xsl/isc-docbook-latex.xsl doc/xsl/isc-manpage.xsl doc/xsl/isc-notes-html.xsl - doc/xsl/isc-notes-latex.xsl isc-config.sh lib/Makefile lib/bind9/Makefile diff --git a/doc/Makefile.in b/doc/Makefile.in index 29074b53fb..bc9b3a432c 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -13,8 +13,6 @@ # OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR # PERFORMANCE OF THIS SOFTWARE. -# $Id: Makefile.in,v 1.11 2007/06/19 23:47:13 tbox Exp $ - # This Makefile is a placeholder. It exists merely to make # sure that its directory gets created in the object directory # tree when doing a build using separate object directories. @@ -23,7 +21,7 @@ srcdir = @srcdir@ VPATH = @srcdir@ top_srcdir = @top_srcdir@ -SUBDIRS = arm misc xsl doxygen +SUBDIRS = arm misc xsl doxygen tex TARGETS = @BIND9_MAKE_RULES@ diff --git a/doc/arm/.gitignore b/doc/arm/.gitignore new file mode 100644 index 0000000000..05964d527b --- /dev/null +++ b/doc/arm/.gitignore @@ -0,0 +1,3 @@ +noteversion.xml +pkgversion.xml +releaseinfo.xml diff --git a/doc/arm/Bv9ARM-book.xml b/doc/arm/Bv9ARM-book.xml index 393af9393f..e1347405f8 100644 --- a/doc/arm/Bv9ARM-book.xml +++ b/doc/arm/Bv9ARM-book.xml @@ -1,27 +1,7 @@ -]> - - - - BIND 9 Administrator Reference Manual - - + + + + BIND 9 Administrator Reference Manual 2004 2005 @@ -44,11 +24,11 @@ 2003 Internet Software Consortium. - - + + - - Introduction + Introduction + The Internet Domain Name System (DNS) consists of the syntax @@ -60,8 +40,8 @@ hierarchical databases. - - Scope of Document +
Scope of Document + The Berkeley Internet Name Domain @@ -72,11 +52,11 @@ BIND version 9 software package for system administrators. - - + +
- - Organization of This Document +
Organization of This Document + In this document, Chapter 1 introduces the basic DNS and BIND concepts. Chapter 2 @@ -102,9 +82,9 @@ and the Domain Name System. - - - Conventions Used in This Document +
+
Conventions Used in This Document + In this document, we use the following general typographic @@ -229,9 +209,9 @@ - - - The Domain Name System (<acronym>DNS</acronym>) +
+
The Domain Name System (<acronym>DNS</acronym>) + The purpose of this document is to explain the installation and upkeep of the BIND (Berkeley Internet @@ -240,8 +220,8 @@ (DNS) as they relate to BIND. - - DNS Fundamentals +
DNS Fundamentals + The Domain Name System (DNS) is a hierarchical, distributed @@ -263,8 +243,8 @@ from ISC as a separate download. - - Domains and Domain Names +
Domains and Domain Names + The data stored in the DNS is identified by domain names that are organized as a tree according to @@ -312,10 +292,10 @@ the DNS protocol, please refer to the standards documents listed in . - +
- - Zones +
Zones + To properly operate a name server, it is important to understand the difference between a zone @@ -368,10 +348,10 @@ be a slave server for your domain, you are actually asking for slave service for some collection of zones. - +
- - Authoritative Name Servers +
Authoritative Name Servers + Each zone is served by at least @@ -389,8 +369,8 @@ dig (). - - The Primary Master +
The Primary Master + The authoritative server where the master copy of the zone @@ -409,10 +389,10 @@ by humans at all, but may instead be the result of dynamic update operations. - +
- - Slave Servers +
Slave Servers + The other authoritative servers, the slave servers (also known as secondary servers) @@ -425,10 +405,10 @@ to transfer it from another slave. In other words, a slave server may itself act as a master to a subordinate slave server. - +
- - Stealth Servers +
Stealth Servers + Usually all of the zone's authoritative servers are listed in @@ -463,12 +443,12 @@ with the outside world. - +
- - +
+
Caching Name Servers - Caching Name Servers + - +
- - Name Server Intensive Environment Issues +
Name Server Intensive Environment Issues + For name server intensive environments, there are two alternative configurations that may be used. The first is where clients and @@ -639,10 +619,10 @@ this has the disadvantage of making many more external queries, as none of the name servers share their cached data. - +
- - Supported Operating Systems +
Supported Operating Systems + ISC BIND 9 compiles and runs on a large number @@ -653,21 +633,21 @@ directory of the BIND 9 source distribution. - +
- - Name Server Configuration + Name Server Configuration + 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 +
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 @@ -696,10 +676,10 @@ zone "0.0.127.in-addr.arpa" { }; - +
- - An Authoritative-only Name Server +
An Authoritative-only Name Server + This sample configuration is for an authoritative-only server that is the master server for "example.com" @@ -745,11 +725,11 @@ zone "eng.example.com" { }; - - +
+
- - Load Balancing +
Load Balancing + - Standards + RFC974 - - Partridge - C. - - Mail Routing and the Domain System + PartridgeC. + Mail Routing and the Domain System January 1986 RFC1034 - - Mockapetris - P.V. - - Domain Names — Concepts and Facilities + MockapetrisP.V. + Domain Names — Concepts and Facilities November 1987 RFC1035 - - Mockapetris - P. V. - Domain Names — Implementation and - Specification + MockapetrisP. V. Domain Names — Implementation and + Specification November 1987 - + Proposed Standards - Proposed Standards + RFC2181 - - Elz - R., R. Bush - - Clarifications to the <acronym>DNS</acronym> - Specification + ElzR., R. Bush + Clarifications to the DNS + Specification July 1997 RFC2308 - - Andrews - M. - - Negative Caching of <acronym>DNS</acronym> - Queries + AndrewsM. + Negative Caching of DNS + Queries March 1998 RFC1995 - - Ohta - M. - - Incremental Zone Transfer in <acronym>DNS</acronym> + OhtaM. + Incremental Zone Transfer in DNS August 1996 RFC1996 - - Vixie - P. - - A Mechanism for Prompt Notification of Zone Changes + VixieP. + A Mechanism for Prompt Notification of Zone Changes August 1996 RFC2136 - - Vixie - P. - - - S. - Thomson - - - Y. - Rekhter - - - J. - Bound - + VixieP. + S.Thomson + Y.Rekhter + J.Bound - Dynamic Updates in the Domain Name System + Dynamic Updates in the Domain Name System April 1997 RFC2671 - - P. - Vixie - + P.Vixie - Extension Mechanisms for DNS (EDNS0) + Extension Mechanisms for DNS (EDNS0) August 1997 RFC2672 - - M. - Crawford - + M.Crawford - Non-Terminal DNS Name Redirection + Non-Terminal DNS Name Redirection August 1999 RFC2845 - - Vixie - P. - - - O. - Gudmundsson - - - D. - Eastlake - 3rd - - - B. - Wellington - + VixieP. + O.Gudmundsson + D.Eastlake3rd + B.Wellington - Secret Key Transaction Authentication for <acronym>DNS</acronym> (TSIG) + Secret Key Transaction Authentication for DNS (TSIG) May 2000 RFC2930 - - D. - Eastlake - 3rd - + D.Eastlake3rd - Secret Key Establishment for DNS (TKEY RR) + Secret Key Establishment for DNS (TKEY RR) September 2000 RFC2931 - - D. - Eastlake - 3rd - + D.Eastlake3rd - DNS Request and Transaction Signatures (SIG(0)s) + DNS Request and Transaction Signatures (SIG(0)s) September 2000 RFC3007 - - B. - Wellington - + B.Wellington - Secure Domain Name System (DNS) Dynamic Update + Secure Domain Name System (DNS) Dynamic Update November 2000 RFC3645 - - S. - Kwan - - - P. - Garg - - - J. - Gilroy - - - L. - Esibov - - - J. - Westhead - - - R. - Hall - + S.Kwan + P.Garg + J.Gilroy + L.Esibov + J.Westhead + R.Hall - Generic Security Service Algorithm for Secret + <citetitle>Generic Security Service Algorithm for Secret Key Transaction Authentication for DNS - (GSS-TSIG) + (GSS-TSIG) October 2003 - - <acronym>DNS</acronym> Security Proposed Standards + <acronym>DNS</acronym> Security Proposed Standards + RFC3225 - - D. - Conrad - + D.Conrad - Indicating Resolver Support of DNSSEC + Indicating Resolver Support of DNSSEC December 2001 RFC3833 - - D. - Atkins - - - R. - Austein - + D.Atkins + R.Austein - Threat Analysis of the Domain Name System (DNS) + Threat Analysis of the Domain Name System (DNS) August 2004 RFC4033 - - R. - Arends - - - R. - Austein - - - M. - Larson - - - D. - Massey - - - S. - Rose - + R.Arends + R.Austein + M.Larson + D.Massey + S.Rose - DNS Security Introduction and Requirements + DNS Security Introduction and Requirements March 2005 RFC4034 - - R. - Arends - - - R. - Austein - - - M. - Larson - - - D. - Massey - - - S. - Rose - + R.Arends + R.Austein + M.Larson + D.Massey + S.Rose - Resource Records for the DNS Security Extensions + Resource Records for the DNS Security Extensions March 2005 RFC4035 - - R. - Arends - - - R. - Austein - - - M. - Larson - - - D. - Massey - - - S. - Rose - + R.Arends + R.Austein + M.Larson + D.Massey + S.Rose - Protocol Modifications for the DNS - Security Extensions + Protocol Modifications for the DNS + Security Extensions March 2005 - - Other Important RFCs About <acronym>DNS</acronym> - Implementation + Other Important RFCs About <acronym>DNS</acronym> + Implementation + RFC1535 - - Gavron - E. - - A Security Problem and Proposed Correction With Widely - Deployed <acronym>DNS</acronym> Software. + GavronE. + A Security Problem and Proposed Correction With Widely + Deployed DNS Software. October 1993 RFC1536 - - Kumar - A. - - - J. - Postel - - - C. - Neuman - - - P. - Danzig - - - S. - Miller - + KumarA. + J.Postel + C.Neuman + P.Danzig + S.Miller - Common <acronym>DNS</acronym> Implementation - Errors and Suggested Fixes + Common DNS Implementation + Errors and Suggested Fixes October 1993 RFC1982 - - Elz - R. - - - R. - Bush - + ElzR. + R.Bush - Serial Number Arithmetic + Serial Number Arithmetic August 1996 RFC4074 - - Morishita - Y. - - - T. - Jinmei - + MorishitaY. + T.Jinmei - Common Misbehaviour Against <acronym>DNS</acronym> - Queries for IPv6 Addresses + Common Misbehaviour Against DNS + Queries for IPv6 Addresses May 2005 - - Resource Record Types + Resource Record Types + RFC1183 - - Everhart - C.F. - - - L. A. - Mamakos - - - R. - Ullmann - - - P. - Mockapetris - + EverhartC.F. + L. A.Mamakos + R.Ullmann + P.Mockapetris - New <acronym>DNS</acronym> RR Definitions + New DNS RR Definitions October 1990 RFC1706 - - Manning - B. - - - R. - Colella - + ManningB. + R.Colella - <acronym>DNS</acronym> NSAP Resource Records + DNS NSAP Resource Records October 1994 RFC2168 - - Daniel - R. - - - M. - Mealling - + DanielR. + M.Mealling - Resolution of Uniform Resource Identifiers using - the Domain Name System + Resolution of Uniform Resource Identifiers using + the Domain Name System June 1997 RFC1876 - - Davis - C. - - - P. - Vixie - - - T. - Goodwin - - - I. - Dickinson - + DavisC. + P.Vixie + T.Goodwin + I.Dickinson - A Means for Expressing Location Information in the + <citetitle>A Means for Expressing Location Information in the Domain - Name System + Name System January 1996 RFC2052 - - Gulbrandsen - A. - - - P. - Vixie - + GulbrandsenA. + P.Vixie - A <acronym>DNS</acronym> RR for Specifying the + <citetitle>A <acronym>DNS</acronym> RR for Specifying the Location of - Services. + Services. October 1996 RFC2163 - - Allocchio - A. - - Using the Internet <acronym>DNS</acronym> to + <author><personname><surname>Allocchio</surname><firstname>A.</firstname></personname></author> + <citetitle>Using the Internet <acronym>DNS</acronym> to Distribute MIXER - Conformant Global Address Mapping + Conformant Global Address Mapping January 1998 RFC2230 - - Atkinson - R. - - Key Exchange Delegation Record for the <acronym>DNS</acronym> + AtkinsonR. + Key Exchange Delegation Record for the DNS October 1997 RFC2536 - - Eastlake - D. - 3rd - - DSA KEYs and SIGs in the Domain Name System (DNS) + EastlakeD.3rd + DSA KEYs and SIGs in the Domain Name System (DNS) March 1999 RFC2537 - - Eastlake - D. - 3rd - - RSA/MD5 KEYs and SIGs in the Domain Name System (DNS) + EastlakeD.3rd + RSA/MD5 KEYs and SIGs in the Domain Name System (DNS) March 1999 RFC2538 - - Eastlake - D. - 3rd - - - Gudmundsson - O. - + EastlakeD.3rd + GudmundssonO. - Storing Certificates in the Domain Name System (DNS) + Storing Certificates in the Domain Name System (DNS) March 1999 RFC2539 - - Eastlake - D. - 3rd - + EastlakeD.3rd - Storage of Diffie-Hellman Keys in the Domain Name System (DNS) + Storage of Diffie-Hellman Keys in the Domain Name System (DNS) March 1999 RFC2540 - - Eastlake - D. - 3rd - + EastlakeD.3rd - Detached Domain Name System (DNS) Information + Detached Domain Name System (DNS) Information March 1999 RFC2782 - - Gulbrandsen - A. - - - Vixie - P. - - - Esibov - L. - - A DNS RR for specifying the location of services (DNS SRV) + GulbrandsenA. + VixieP. + EsibovL. + A DNS RR for specifying the location of services (DNS SRV) February 2000 RFC2915 - - Mealling - M. - - - Daniel - R. - - The Naming Authority Pointer (NAPTR) DNS Resource Record + MeallingM. + DanielR. + The Naming Authority Pointer (NAPTR) DNS Resource Record September 2000 RFC3110 - - Eastlake - D. - 3rd - - RSA/SHA-1 SIGs and RSA KEYs in the Domain Name System (DNS) + EastlakeD.3rd + RSA/SHA-1 SIGs and RSA KEYs in the Domain Name System (DNS) May 2001 RFC3123 - - Koch - P. - - A DNS RR Type for Lists of Address Prefixes (APL RR) + KochP. + A DNS RR Type for Lists of Address Prefixes (APL RR) June 2001 RFC3596 - - Thomson - S. - - - C. - Huitema - - - V. - Ksinant - - - M. - Souissi - + ThomsonS. + C.Huitema + V.Ksinant + M.Souissi - <acronym>DNS</acronym> Extensions to support IP - version 6 + DNS Extensions to support IP + version 6 October 2003 RFC3597 - - Gustafsson - A. - - Handling of Unknown DNS Resource Record (RR) Types + GustafssonA. + Handling of Unknown DNS Resource Record (RR) Types September 2003 - - <acronym>DNS</acronym> and the Internet + <acronym>DNS</acronym> and the Internet + RFC1101 - - Mockapetris - P. V. - - <acronym>DNS</acronym> Encoding of Network Names - and Other Types + MockapetrisP. V. + DNS Encoding of Network Names + and Other Types April 1989 RFC1123 - - Braden - R. - - Requirements for Internet Hosts - Application and - Support + BradenR. + Requirements for Internet Hosts - Application and + Support October 1989 RFC1591 - - Postel - J. - - Domain Name System Structure and Delegation + PostelJ. + Domain Name System Structure and Delegation March 1994 RFC2317 - - Eidnes - H. - - - G. - de Groot - - - P. - Vixie - + EidnesH. + G.de Groot + P.Vixie - Classless IN-ADDR.ARPA Delegation + Classless IN-ADDR.ARPA Delegation March 1998 RFC2826 - - Internet Architecture Board - + Internet Architecture Board - IAB Technical Comment on the Unique DNS Root + IAB Technical Comment on the Unique DNS Root May 2000 RFC2929 - - Eastlake - D. - 3rd - - - Brunner-Williams - E. - - - Manning - B. - + EastlakeD.3rd + Brunner-WilliamsE. + ManningB. - Domain Name System (DNS) IANA Considerations + Domain Name System (DNS) IANA Considerations September 2000 - - <acronym>DNS</acronym> Operations + <acronym>DNS</acronym> Operations + RFC1033 - - Lottor - M. - - Domain administrators operations guide. + LottorM. + Domain administrators operations guide. November 1987 RFC1537 - - Beertema - P. - - Common <acronym>DNS</acronym> Data File - Configuration Errors + BeertemaP. + Common DNS Data File + Configuration Errors October 1993 RFC1912 - - Barr - D. - - Common <acronym>DNS</acronym> Operational and - Configuration Errors + BarrD. + Common DNS Operational and + Configuration Errors February 1996 RFC2010 - - Manning - B. - - - P. - Vixie - + ManningB. + P.Vixie - Operational Criteria for Root Name Servers. + Operational Criteria for Root Name Servers. October 1996 RFC2219 - - Hamilton - M. - - - R. - Wright - + HamiltonM. + R.Wright - Use of <acronym>DNS</acronym> Aliases for - Network Services. + Use of DNS Aliases for + Network Services. October 1997 - - Internationalized Domain Names + Internationalized Domain Names + RFC2825 - - IAB - - - Daigle - R. - + IAB + DaigleR. - A Tangled Web: Issues of I18N, Domain Names, - and the Other Internet protocols + A Tangled Web: Issues of I18N, Domain Names, + and the Other Internet protocols May 2000 RFC3490 - - Faltstrom - P. - - - Hoffman - P. - - - Costello - A. - + FaltstromP. + HoffmanP. + CostelloA. - Internationalizing Domain Names in Applications (IDNA) + Internationalizing Domain Names in Applications (IDNA) March 2003 RFC3491 - - Hoffman - P. - - - Blanchet - M. - + HoffmanP. + BlanchetM. - Nameprep: A Stringprep Profile for Internationalized Domain Names + Nameprep: A Stringprep Profile for Internationalized Domain Names March 2003 RFC3492 - - Costello - A. - + CostelloA. - Punycode: A Bootstring encoding of Unicode + <citetitle>Punycode: A Bootstring encoding of Unicode for Internationalized Domain Names in - Applications (IDNA) + Applications (IDNA) March 2003 - - Other <acronym>DNS</acronym>-related RFCs + Other <acronym>DNS</acronym>-related RFCs + Note: the following list of RFCs, although @@ -16971,165 +16598,108 @@ zone "example.com" { RFC1464 - - Rosenbaum - R. - - Using the Domain Name System To Store Arbitrary String - Attributes + RosenbaumR. + Using the Domain Name System To Store Arbitrary String + Attributes May 1993 RFC1713 - - Romao - A. - - Tools for <acronym>DNS</acronym> Debugging + RomaoA. + Tools for DNS Debugging November 1994 RFC1794 - - Brisco - T. - - <acronym>DNS</acronym> Support for Load - Balancing + BriscoT. + DNS Support for Load + Balancing April 1995 RFC2240 - - Vaughan - O. - - A Legal Basis for Domain Name Allocation + VaughanO. + A Legal Basis for Domain Name Allocation November 1997 RFC2345 - - Klensin - J. - - - T. - Wolf - - - G. - Oglesby - + KlensinJ. + T.Wolf + G.Oglesby - Domain Names and Company Name Retrieval + Domain Names and Company Name Retrieval May 1998 RFC2352 - - Vaughan - O. - - A Convention For Using Legal Names as Domain Names + VaughanO. + A Convention For Using Legal Names as Domain Names May 1998 RFC3071 - - Klensin - J. - + KlensinJ. - Reflections on the DNS, RFC 1591, and Categories of Domains + Reflections on the DNS, RFC 1591, and Categories of Domains February 2001 RFC3258 - - Hardie - T. - + HardieT. - Distributing Authoritative Name Servers via - Shared Unicast Addresses + Distributing Authoritative Name Servers via + Shared Unicast Addresses April 2002 RFC3901 - - Durand - A. - - - J. - Ihren - + DurandA. + J.Ihren - DNS IPv6 Transport Operational Guidelines + DNS IPv6 Transport Operational Guidelines September 2004 - - Obsolete and Unimplemented Experimental RFC + Obsolete and Unimplemented Experimental RFC + RFC1712 - - Farrell - C. - - - M. - Schulze - - - S. - Pleitner - - - D. - Baldoni - + FarrellC. + M.Schulze + S.Pleitner + D.Baldoni - <acronym>DNS</acronym> Encoding of Geographical - Location + DNS Encoding of Geographical + Location November 1994 RFC2673 - - Crawford - M. - + CrawfordM. - Binary Labels in the Domain Name System + Binary Labels in the Domain Name System August 1999 RFC2874 - - Crawford - M. - - - Huitema - C. - + CrawfordM. + HuitemaC. - DNS Extensions to Support IPv6 Address Aggregation - and Renumbering + DNS Extensions to Support IPv6 Address Aggregation + and Renumbering July 2000 - - Obsoleted DNS Security RFCs + Obsoleted DNS Security RFCs + Most of these have been consolidated into RFC4033, @@ -17139,152 +16709,101 @@ zone "example.com" { RFC2065 - - Eastlake - 3rd - D. - - - C. - Kaufman - + Eastlake3rdD. + C.Kaufman - Domain Name System Security Extensions + Domain Name System Security Extensions January 1997 RFC2137 - - Eastlake - 3rd - D. - - Secure Domain Name System Dynamic Update + Eastlake3rdD. + Secure Domain Name System Dynamic Update April 1997 RFC2535 - - Eastlake - 3rd - D. - + Eastlake3rdD. - Domain Name System Security Extensions + Domain Name System Security Extensions March 1999 RFC3008 - - Wellington - B. - + WellingtonB. - Domain Name System Security (DNSSEC) - Signing Authority + Domain Name System Security (DNSSEC) + Signing Authority November 2000 RFC3090 - - Lewis - E. - + LewisE. - DNS Security Extension Clarification on Zone Status + DNS Security Extension Clarification on Zone Status March 2001 RFC3445 - - Massey - D. - - - Rose - S. - + MasseyD. + RoseS. - Limiting the Scope of the KEY Resource Record (RR) + Limiting the Scope of the KEY Resource Record (RR) December 2002 RFC3655 - - Wellington - B. - - - Gudmundsson - O. - + WellingtonB. + GudmundssonO. - Redefinition of DNS Authenticated Data (AD) bit + Redefinition of DNS Authenticated Data (AD) bit November 2003 RFC3658 - - Gudmundsson - O. - + GudmundssonO. - Delegation Signer (DS) Resource Record (RR) + Delegation Signer (DS) Resource Record (RR) December 2003 RFC3755 - - Weiler - S. - + WeilerS. - Legacy Resolver Compatibility for Delegation Signer (DS) + Legacy Resolver Compatibility for Delegation Signer (DS) May 2004 RFC3757 - - Kolkman - O. - - - Schlyter - J. - - - Lewis - E. - + KolkmanO. + SchlyterJ. + LewisE. - Domain Name System KEY (DNSKEY) Resource Record - (RR) Secure Entry Point (SEP) Flag + Domain Name System KEY (DNSKEY) Resource Record + (RR) Secure Entry Point (SEP) Flag April 2004 RFC3845 - - Schlyter - J. - + SchlyterJ. - DNS Security (DNSSEC) NextSECure (NSEC) RDATA Format + DNS Security (DNSSEC) NextSECure (NSEC) RDATA Format August 2004 - - - Internet Drafts +
+
Internet Drafts + Internet Drafts (IDs) are rough-draft working documents of the Internet Engineering Task Force. They are, in essence, RFCs @@ -17295,73 +16814,61 @@ zone "example.com" { 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 <acronym>BIND</acronym> +
+
Other Documents About <acronym>BIND</acronym> + - - Albitz - Paul - - - Cricket - Liu - + AlbitzPaul + CricketLiu - <acronym>DNS</acronym> and <acronym>BIND</acronym> + DNS and BIND 1998 Sebastopol, CA: O'Reilly and Associates - - +
+
- - BIND 9 DNS Library Support - + BIND 9 DNS Library Support + + - - Manual pages - - - - - - - - - - - - - - - - - - - - - - - - - - - + Manual pages + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- - diff --git a/doc/arm/Bv9ARM.ch01.html b/doc/arm/Bv9ARM.ch01.html index ea3a6b6827..4bafbc8fdc 100644 --- a/doc/arm/Bv9ARM.ch01.html +++ b/doc/arm/Bv9ARM.ch01.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Chapter 1. Introduction - - + + @@ -39,27 +38,28 @@
-
-

-Chapter 1. Introduction

+
+

+Chapter 1. Introduction

-

+ +

The Internet Domain Name System (DNS) consists of the syntax to specify the names of entities in the Internet in a hierarchical @@ -69,10 +69,13 @@ group of distributed hierarchical databases.

-
+ +

-Scope of Document

-

+Scope of Document

+ + +

The Berkeley Internet Name Domain (BIND) implements a domain name server for a number of operating systems. This @@ -81,12 +84,14 @@ BIND version 9 software package for system administrators.

-

This version of the manual corresponds to BIND version 9.9.

-
-
+

This version of the manual corresponds to BIND version 9.9 (Subscription Edition).

+
+ +

-Organization of This Document

-

+Organization of This Document

+ +

In this document, Chapter 1 introduces the basic DNS and BIND concepts. Chapter 2 describes resource requirements for running BIND in various @@ -111,18 +116,22 @@ and the Domain Name System.

-
-
+
+

-Conventions Used in This Document

-

+Conventions Used in This Document

+ + +

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

-
+ +
+
--++ @@ -176,14 +185,17 @@ -
-

+ +

+ +

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

-
+
+
--++ @@ -235,46 +247,55 @@ -
+ +

-
-
+
+

-The Domain Name System (DNS)

-

+The Domain Name System (DNS)

+ +

The purpose of this document is to explain the installation and upkeep of the BIND (Berkeley Internet Name Domain) software package, and we begin by reviewing the fundamentals of the Domain Name System (DNS) as they relate to BIND.

-
+ +

-DNS Fundamentals

-

+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. The BIND 9 software distribution contains a - name server, named, and a resolver - library, liblwres. The older - libbind resolver library is also available + name server, named, and a resolver + library, liblwres. The older + libbind resolver library is also available from ISC as a separate download.

-
-
+ +
+

-Domains and Domain Names

-

+Domains and Domain Names

+ + +

The data stored in the DNS is identified by domain names that are organized as a tree according to organizational or administrative boundaries. Each node of the tree, called a domain, is given a label. The domain @@ -285,7 +306,8 @@ separated by dots. A label need only be unique within its parent domain.

-

+ +

For example, a domain name for a host at the company Example, Inc. could be ourhost.example.com, @@ -297,7 +319,8 @@ ourhost is the name of the host.

-

+ +

For administrative purposes, the name space is partitioned into areas called zones, each starting at a node and extending down to the leaf nodes or to nodes where other zones @@ -305,27 +328,32 @@ The data for each zone is stored in a name server, which answers queries about the zone using the DNS protocol.

-

+ +

The data associated with each domain name is stored in the form of resource records (RRs). Some of the supported resource record types are described in - the section called “Types of Resource Records and When to Use Them”. + the section called “Types of Resource Records and When to Use Them”.

-

+ +

For more detailed information about the design of the DNS and the DNS protocol, please refer to the standards documents listed in - the section called “Request for Comments (RFCs)”. + the section called “Request for Comments (RFCs)”.

-
-
+
+ +

-Zones

-

+Zones

+ +

To properly operate a name server, it is important to understand the difference between a zone and a domain.

-

+ +

As stated previously, a zone is a point of delegation in the DNS tree. A zone consists of those contiguous parts of the domain @@ -337,7 +365,8 @@ parent zone, which should be matched by equivalent NS records at the root of the delegated zone.

-

+ +

For instance, consider the example.com domain which includes names such as host.aaa.example.com and @@ -359,7 +388,8 @@ gain a complete understanding of this difficult and subtle topic.

-

+ +

Though BIND is called a "domain name server", it deals primarily in terms of zones. The master and slave @@ -369,11 +399,14 @@ be a slave server for your domain, you are actually asking for slave service for some collection of zones.

-
-
+
+ +

-Authoritative Name Servers

-

+Authoritative Name Servers

+ + +

Each zone is served by at least one authoritative name server, which contains the complete data for the zone. @@ -381,16 +414,20 @@ 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”). + dig (the section called “Diagnostic Tools”).

-
+ +

-The Primary Master

-

+The Primary Master

+ + +

The authoritative server where the master copy of the zone data is maintained is called the primary master server, or simply the @@ -401,16 +438,19 @@ zone file or master file.

-

+ +

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

-
-
+
+ +

-Slave Servers

-

+Slave Servers

+ +

The other authoritative servers, the slave servers (also known as secondary servers) load @@ -422,11 +462,14 @@ to transfer it from another slave. In other words, a slave server may itself act as a master to a subordinate slave server.

-
-
+
+ +

-Stealth Servers

-

+Stealth Servers

+ + +

Usually all of the zone's authoritative servers are listed in NS records in the parent zone. These NS records constitute a delegation of the zone from the parent. @@ -437,7 +480,8 @@ list servers in the parent's delegation that are not present at the zone's top level.

-

+ +

A stealth server is a server that is authoritative for a zone but is not listed in that zone's NS records. Stealth servers can be used for keeping a local copy of @@ -448,7 +492,8 @@ are inaccessible.

-

+ +

A configuration where the primary master server itself is a stealth server is often referred to as a "hidden primary" configuration. One use for this configuration is when the primary @@ -456,12 +501,19 @@ is behind a firewall and therefore unable to communicate directly with the outside world.

-
-
-
+ +
+ +
+

-Caching Name Servers

-

+Caching Name Servers

+ + + + + +

The resolver libraries provided by most operating systems are stub resolvers, meaning that they are not capable of @@ -473,22 +525,27 @@ 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

-

+Forwarding

+ + +

Even a caching name server does not necessarily perform the complete recursive lookup itself. Instead, it can forward some or all of the queries @@ -496,7 +553,8 @@ server, commonly referred to as a forwarder.

-

+ +

There may be one or more forwarders, and they are queried in turn until the list is exhausted or an answer @@ -510,18 +568,23 @@ that can do it, and that server would query the Internet DNS servers on the internal server's behalf.

-
-
-
+
+ +
+ +

-Name Servers in Multiple Roles

-

+Name Servers in Multiple Roles

+ + +

The BIND name server can simultaneously act as a master for some zones, a slave for other zones, and as a caching (recursive) server for a set of local clients.

-

+ +

However, since the functions of authoritative name service and caching/recursive name service are logically separate, it is often advantageous to run them on separate server machines. @@ -536,9 +599,11 @@ does not need to be reachable from the Internet at large and can be placed inside a firewall.

-
-
-
+ +
+
+ +
-

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch02.html b/doc/arm/Bv9ARM.ch02.html index f2f95dd8eb..e50fca7eeb 100644 --- a/doc/arm/Bv9ARM.ch02.html +++ b/doc/arm/Bv9ARM.ch02.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Chapter 2. BIND Resource Requirements - - + + @@ -39,29 +38,33 @@
-
-

-Chapter 2. BIND Resource Requirements

+ + + +

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

-

+

The DNSSEC features of BIND 9 may prove to be quite CPU intensive however, so organizations that make heavy use of these @@ -70,30 +73,33 @@ full utilization of multiprocessor systems for installations that need it.

-
-
+
+

-CPU Requirements

-

+CPU Requirements

+ +

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

-
-
+
+ +

-Memory Requirements

-

+Memory Requirements

+ +

The memory of the server has to be large enough to fit the - cache and zones loaded off disk. The max-cache-size + cache and zones loaded off disk. The max-cache-size option can be used to limit the amount of memory used by the cache, at the expense of reducing cache hit rates and causing more DNS traffic. Additionally, if additional section caching - (the section called “Additional Section Caching”) is enabled, - the max-acache-size option can be used to + (the section called “Additional Section Caching”) is enabled, + the max-acache-size option can be used to limit the amount of memory used by the mechanism. It is still good practice to have enough memory to load @@ -104,11 +110,14 @@ a relatively stable size where entries are expiring from the cache as fast as they are being inserted.

-
-
+ +
+ +

-Name Server Intensive Environment Issues

-

+Name Server Intensive Environment Issues

+ +

For name server intensive environments, there are two alternative configurations that may be used. The first is where clients and any second-level internal name servers query a main name server, which @@ -121,11 +130,13 @@ this has the disadvantage of making many more external queries, as none of the name servers share their cached data.

-
-
+
+ +

-Supported Operating Systems

-

+Supported Operating Systems

+ +

ISC BIND 9 compiles and runs on a large number of Unix-like operating systems and on @@ -135,8 +146,8 @@ directory of the BIND 9 source distribution.

-
-
+
+
-

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch03.html b/doc/arm/Bv9ARM.ch03.html index d019d62c0a..6e7c195c02 100644 --- a/doc/arm/Bv9ARM.ch03.html +++ b/doc/arm/Bv9ARM.ch03.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Chapter 3. Name Server Configuration - - + + @@ -39,45 +38,50 @@
-
-

-Chapter 3. Name Server Configuration

+
+

+Chapter 3. Name Server Configuration

-

+ +

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

-

+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 - from outside clients are refused using the allow-query + from outside clients are refused using the allow-query option. Alternatively, the same effect could be achieved using suitable firewall rules.

+
 // Two corporate subnets we wish to allow queries from.
 acl corpnets { 192.168.4.0/24; 192.168.7.0/24; };
@@ -95,15 +99,19 @@ zone "0.0.127.in-addr.arpa" {
      notify no;
 };
 
-
-
+ +
+ +

-An Authoritative-only Name Server

-

+An Authoritative-only Name Server

+ +

This sample configuration is for an authoritative-only server that is the master server for "example.com" and a slave for the subdomain "eng.example.com".

+
 options {
      // Working directory
@@ -142,29 +150,37 @@ zone "eng.example.com" {
      masters { 192.168.4.12; };
 };
 
-
-
-
+ +
+
+ +

-Load Balancing

-

+Load Balancing

+ + + +

A primitive form of load balancing can be achieved in the DNS by using multiple records (such as multiple A records) for one name.

-

+ +

For example, if you have three WWW servers with network addresses of 10.0.0.1, 10.0.0.2 and 10.0.0.3, a set of records such as the following means that clients will connect to each machine one third of the time:

-
+ +
+
-----+++++ @@ -272,48 +288,56 @@ zone "eng.example.com" { -
-

+ +

+

When a resolver queries for these records, BIND will rotate them and respond to the query with the records in a different order. In the example above, clients will randomly receive records in the order 1, 2, 3; 2, 3, 1; and 3, 1, 2. Most clients will use the first record returned and discard the rest.

-

+

For more detail on ordering responses, check the - rrset-order sub-statement in the - options statement, see - RRset Ordering. + rrset-order sub-statement in the + options statement, see + RRset Ordering.

-
-
+ +
+ +

-Name Server Operations

-
+Name Server Operations
+ + +

-Tools for Use With the Name Server Daemon

-

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

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

- The domain information groper (dig) +

+ The domain information groper (dig) is the most versatile and complete of these lookup tools. It has two modes: simple interactive mode for a single query, and batch mode which executes a @@ -322,39 +346,61 @@ zone "eng.example.com" { accessible from the command line.

-

dig [@server] domain [query-type] [query-class] [+query-option] [-dig-option] [%comment]

-

- The usual simple use of dig will take the form +

+ dig + [@server] + domain + [query-type] + [query-class] + [+query-option] + [-dig-option] + [%comment] +

+

+ The usual simple use of dig will take the form

-

- dig @server domain query-type query-class +

+ dig @server domain query-type query-class

-

+

For more information and a list of available commands and - options, see the dig man + options, see the dig man page.

-
-
host
+ +
host
-

- The host utility emphasizes +

+ The host utility emphasizes simplicity and ease of use. By default, it converts between host names and Internet addresses, but its 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 + options, see the host man page.

-
-
nslookup
+ +
nslookup
-

nslookup +

nslookup has two modes: interactive and non-interactive. Interactive mode allows the user to query name servers for information about various @@ -363,8 +409,15 @@ zone "eng.example.com" { the name and requested information for a host or domain.

-

nslookup [-option...] [[host-to-find] | [- [server]]]

-

+

+ nslookup + [-option...] + [ + [host-to-find] + | [- [server]] + ] +

+

Interactive mode is entered when no arguments are given (the default name server will be used) or when the first argument is a @@ -372,7 +425,7 @@ zone "eng.example.com" { Internet address of a name server.

-

+

Non-interactive mode is used when the name or Internet address of the host to be looked up is given as the first argument. @@ -380,171 +433,207 @@ 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. + 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 +named-checkconf
-

- The named-checkconf program +

+ 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 +named-checkzone
-

- The named-checkzone program +

+ The named-checkzone program checks a master file for syntax and consistency.

-

named-checkzone [-djqvD] [-c class] [-o output] [-t directory] [-w directory] [-k (ignore|warn|fail)] [-n (ignore|warn|fail)] [-W (ignore|warn)] zone [filename]

-
+

+ named-checkzone + [-djqvD] + [-c class] + [-o output] + [-t directory] + [-w directory] + [-k (ignore|warn|fail)] + [-n (ignore|warn|fail)] + [-W (ignore|warn)] + zone + [filename] +

+
-named-compilezone -
-

- Similar to named-checkzone, but - it always dumps the zone content to a specified file - (typically in a different format). -

-
-rndc +named-compilezone
-

+

+ Similar to named-checkzone, but + it always dumps the zone content to a specified file + (typically in a different format). +

+
+
+rndc +
+
+

The remote name daemon control - (rndc) program allows the + (rndc) program allows the system administrator to control the operation of a name server. - Since BIND 9.2, rndc - supports all the commands of the BIND 8 ndc - utility except ndc start and - ndc restart, which were also - not supported in ndc's + Since BIND 9.2, rndc + supports all the commands of the BIND 8 ndc + utility except ndc start and + ndc restart, which were also + not supported in ndc's channel mode. - If you run rndc without any + If you run rndc without any options it will display a usage message as follows:

-

rndc [-c config] [-s server] [-p port] [-y key] command [command...]

-

See rndc(8) for details of - the available rndc commands. +

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

+ rndc requires a configuration file, since all communication with the server is authenticated with digital signatures that rely on a shared secret, and there is no way to provide that secret other than with a configuration file. The default location for the - rndc configuration file is + rndc configuration file is /etc/rndc.conf, but an alternate location can be specified with the -c option. If the configuration file is not found, - rndc will also look in + rndc will also look in /etc/rndc.key (or whatever sysconfdir was defined when the BIND build was configured). The rndc.key file is generated by - running rndc-confgen -a as + running rndc-confgen -a as described in - the section called “controls Statement Definition and + the section called “controls Statement Definition and Usage”.

-

+ +

The format of the configuration file is similar to that of named.conf, but limited to - only four statements, the options, - key, server and - include + only four statements, the options, + key, server and + include statements. These statements are what associate the secret keys to the servers with which they are meant to be shared. The order of statements is not significant.

-

- The options statement has + +

+ The options statement has three clauses: - default-server, default-key, - and default-port. - default-server takes a + default-server, default-key, + and default-port. + default-server takes a host name or address argument and represents the server that will be contacted if no -s option is provided on the command line. - default-key takes - the name of a key as its argument, as defined by a key statement. - default-port specifies the + default-key takes + the name of a key as its argument, as defined by a key statement. + default-port specifies the port to which - rndc should connect if no + rndc should connect if no port is given on the command line or in a - server statement. + server statement.

-

- The key statement defines a + +

+ The key statement defines a key to be used - by rndc when authenticating + by rndc when authenticating with - named. Its syntax is + named. Its syntax is identical to the - key statement in named.conf. + key statement in named.conf. The keyword key is followed by a key name, which must be a valid domain name, though it need not actually be hierarchical; thus, a string like "rndc_key" is a valid name. - The key statement has two + The key statement has two clauses: - algorithm and secret. + algorithm and secret. While the configuration parser will accept any string as the argument to algorithm, currently only the string "hmac-md5" has any meaning. The secret is a base-64 encoded string as specified in RFC 3548.

-

- The server statement + +

+ The server statement associates a key - defined using the key + defined using the key statement with a server. The keyword server is followed by a - host name or address. The server statement - has two clauses: key and port. - The key clause specifies the + host name or address. The server statement + has two clauses: key and port. + The key clause specifies the name of the key to be used when communicating with this server, and the - port clause can be used to - specify the port rndc should + port clause can be used to + specify the port rndc should connect to on the server.

-

+ +

A sample minimal configuration file is as follows:

+
 key rndc_key {
      algorithm "hmac-md5";
@@ -556,65 +645,76 @@ options {
      default-key    rndc_key;
 };
 
-

+ +

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

-

+ +

$ rndc reload

-

+ +

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

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

+ +

and it had an identical key statement for rndc_key.

-

- Running the rndc-confgen + +

+ Running the rndc-confgen program will conveniently create a rndc.conf file for you, and also display the - corresponding controls + corresponding controls statement that you need to add to named.conf. Alternatively, - you can run rndc-confgen -a + you can run rndc-confgen -a to set up a rndc.key file and not modify named.conf at all.

-
+ +
-
-
-
+ +
+
+

-Signals

-

+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. + be sent using the kill command.

-
+
+
--++ -
-

SIGHUP

+

SIGHUP

@@ -625,7 +725,7 @@ controls {

-

SIGTERM

+

SIGTERM

@@ -635,7 +735,7 @@ controls {

-

SIGINT

+

SIGINT

@@ -644,10 +744,11 @@ controls {

-
-
-
+ +
+
+
+
-

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch04.html b/doc/arm/Bv9ARM.ch04.html index b0ca7ad8b3..2ed7b10cdd 100644 --- a/doc/arm/Bv9ARM.ch04.html +++ b/doc/arm/Bv9ARM.ch04.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Chapter 4. Advanced DNS Features - - + + @@ -39,141 +38,158 @@
-
-

-Chapter 4. Advanced DNS Features

+
+

+Chapter 4. Advanced DNS Features

Table of Contents

-
-
Notify
-
Dynamic Update
-
The journal file
-
Incremental Zone Transfers (IXFR)
-
Split DNS
-
Example split DNS setup
-
TSIG
+
+
Notify
+
Dynamic Update
+
The journal file
+
Incremental Zone Transfers (IXFR)
+
Split DNS
+
Example split DNS setup
+
TSIG
-
Generate Shared Keys for Each Pair of Hosts
-
Copying the Shared Secret to Both Machines
-
Informing the Servers of the Key's Existence
-
Instructing the Server to Use the Key
-
TSIG Key Based Access Control
-
Errors
+
Generate Shared Keys for Each Pair of Hosts
+
Copying the Shared Secret to Both Machines
+
Informing the Servers of the Key's Existence
+
Instructing the Server to Use the Key
+
TSIG Key Based Access Control
+
Errors
-
TKEY
-
SIG(0)
-
DNSSEC
+
TKEY
+
SIG(0)
+
DNSSEC
-
Generating Keys
-
Signing the Zone
-
Configuring Servers
+
Generating Keys
+
Signing the Zone
+
Configuring Servers
-
DNSSEC, Dynamic Zones, and Automatic Signing
+
DNSSEC, Dynamic Zones, and Automatic Signing
-
Converting from insecure to secure
-
Dynamic DNS update method
-
Fully automatic zone signing
-
Private-type records
-
DNSKEY rollovers
-
Dynamic DNS update method
-
Automatic key rollovers
-
NSEC3PARAM rollovers via UPDATE
-
Converting from NSEC to NSEC3
-
Converting from NSEC3 to NSEC
-
Converting from secure to insecure
-
Periodic re-signing
-
NSEC3 and OPTOUT
+
Converting from insecure to secure
+
Dynamic DNS update method
+
Fully automatic zone signing
+
Private-type records
+
DNSKEY rollovers
+
Dynamic DNS update method
+
Automatic key rollovers
+
NSEC3PARAM rollovers via UPDATE
+
Converting from NSEC to NSEC3
+
Converting from NSEC3 to NSEC
+
Converting from secure to insecure
+
Periodic re-signing
+
NSEC3 and OPTOUT
-
Dynamic Trust Anchor Management
+
Dynamic Trust Anchor Management
-
Validating Resolver
-
Authoritative Server
+
Validating Resolver
+
Authoritative Server
-
PKCS #11 (Cryptoki) support
+
PKCS #11 (Cryptoki) support
-
Prerequisites
-
Building BIND 9 with PKCS#11
-
PKCS #11 Tools
-
Using the HSM
-
Specifying the engine on the command line
-
Running named with automatic zone re-signing
+
Prerequisites
+
Building BIND 9 with PKCS#11
+
PKCS #11 Tools
+
Using the HSM
+
Specifying the engine on the command line
+
Running named with automatic zone re-signing
-
IPv6 Support in BIND 9
+
IPv6 Support in BIND 9
-
Address Lookups Using AAAA Records
-
Address to Name Lookups Using Nibble Format
+
Address Lookups Using AAAA Records
+
Address to Name Lookups Using Nibble Format
-
+ + +

Notify

-

+ + +

DNS NOTIFY is a mechanism that allows master servers to notify their slave servers of changes to a zone's data. In - response to a NOTIFY from a master server, the + response to a NOTIFY from a master server, the slave will check to see that its version of the zone is the current version and, if not, initiate a zone transfer.

-

+ +

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

-
+ +

Note

- As a slave zone can also be a master to other slaves, named, - by default, sends NOTIFY messages for every zone - it loads. Specifying notify master-only; will - cause named to only send NOTIFY for master + As a slave zone can also be a master to other slaves, named, + by default, sends NOTIFY messages for every zone + it loads. Specifying notify master-only; will + cause named to only send NOTIFY for master zones that it loads.
-
-
+ +
+ +

Dynamic Update

-

+ + +

Dynamic Update is a method for adding, replacing or deleting records in a master server by sending it a special form of DNS messages. The format and meaning of these messages is specified in RFC 2136.

-

+ +

Dynamic update is enabled by including an - allow-update or an update-policy - clause in the zone statement. + allow-update or an update-policy + clause in the zone statement.

-

- If the zone's update-policy is set to + +

+ If the zone's update-policy is set to local, updates to the zone will be permitted for the key local-ddns, - which will be generated by named at startup. - See the section called “Dynamic Update Policies” for more details. + which will be generated by named at startup. + See the section called “Dynamic Update Policies” for more details.

-

+ +

Dynamic updates using Kerberos signed requests can be made using the TKEY/GSS protocol by setting either the - tkey-gssapi-keytab option, or alternatively - by setting both the tkey-gssapi-credential - and tkey-domain options. Once enabled, + tkey-gssapi-keytab option, or alternatively + by setting both the tkey-gssapi-credential + and tkey-domain options. Once enabled, Kerberos signed requests will be matched against the update 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. @@ -183,7 +199,8 @@ file unless specifically overridden. The journal file is in a binary format and should not be edited manually.

-

+ +

The server will also occasionally write ("dump") the complete contents of the updated zone to its zone file. This is not done immediately after @@ -196,55 +213,66 @@ will be removed when the dump is complete, and can be safely ignored.

-

+ +

When a server is restarted after a shutdown or crash, it will replay the journal file to incorporate into the zone any updates that took place after the last zone dump.

-

+ +

Changes that result from incoming incremental zone transfers are also journalled in a similar way.

-

+ +

The zone files of dynamic zones cannot normally be edited by hand because they are not guaranteed to contain the most recent dynamic changes — those are only in the journal file. The only way to ensure that the zone file of a dynamic zone - is up to date is to run rndc stop. + is up to date is to run rndc stop.

-

+ +

If you have to make changes to a dynamic zone manually, the following procedure will work: Disable dynamic updates to the zone using - rndc freeze zone. + rndc freeze zone. This will update the zone's master file with the changes stored in its .jnl file. Edit the zone file. Run - rndc thaw zone + rndc thaw zone to reload the changed zone and re-enable dynamic updates.

-

- rndc sync zone + +

+ rndc sync zone will update the zone file with changes from the journal file without stopping dynamic updates; this may be useful for viewing the current zone state. To remove the .jnl file after updating the zone file, use - rndc sync -clean. + rndc sync -clean.

-
-
-
+ +
+ +
+ +

Incremental Zone Transfers (IXFR)

-

+ + +

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

-

+ +

When acting as a master, BIND 9 supports IXFR for those zones where the necessary change history information is available. These @@ -252,27 +280,30 @@ whose data was obtained by IXFR. For manually maintained master zones, and for slave zones obtained by performing a full zone transfer (AXFR), IXFR is supported only if the option - ixfr-from-differences is set + ixfr-from-differences is set to yes.

-

+ +

When acting as a slave, BIND 9 will attempt to use IXFR unless it is explicitly disabled. For more information about disabling - IXFR, see the description of the request-ixfr clause - of the server statement. + IXFR, see the description of the request-ixfr clause + of the server statement.

-
-
+
+ +

-Split DNS

-

+Split DNS

+ +

Setting up different views, or visibility, of the DNS space to internal and external resolvers is usually referred to as a Split DNS setup. There are several reasons an organization would want to set up its DNS this way.

-

+

One common reason for setting up a DNS system this way is to hide "internal" DNS information from "external" clients on the Internet. There is some debate as to whether or not this is actually @@ -286,17 +317,18 @@ choose to use a Split DNS to present a consistent view of itself to the outside world.

-

+

Another common reason for setting up a Split DNS system is to allow internal networks that are behind filters or in RFC 1918 space (reserved IP space, as documented in RFC 1918) to resolve DNS on the Internet. Split DNS can also be used to allow mail from outside back in to the internal network.

-
+

-Example split DNS setup

-

+Example split DNS setup

+ +

Let's say a company named Example, Inc. (example.com) has several corporate sites that have an internal network with @@ -304,14 +336,14 @@ Internet Protocol (IP) space and an external demilitarized zone (DMZ), or "outside" section of a network, that is available to the public.

-

+

Example, Inc. wants its internal clients to be able to resolve external hostnames and to exchange mail with people on the outside. The company also wants its internal resolvers to have access to certain internal-only zones that are not available at all outside of the internal network.

-

+

In order to accomplish this, the company will set up two sets of name servers. One set will be on the inside network (in the reserved @@ -319,7 +351,7 @@ "proxy" hosts that can talk to both sides of its network, in the DMZ.

-

+

The internal servers will be configured to forward all queries, except queries for site1.internal, site2.internal, site1.example.com, and site2.example.com, to the servers @@ -328,20 +360,20 @@ for site1.example.com, site2.example.com, site1.internal, and site2.internal.

-

+

To protect the site1.internal and site2.internal domains, the internal name servers must be configured to disallow all queries to these domains from any external hosts, including the bastion hosts.

-

+

The external servers, which are on the bastion hosts, will be configured to serve the "public" version of the site1 and site2.example.com zones. This could include things such as the host records for public servers (www.example.com and ftp.example.com), and mail exchange (MX) records (a.mx.example.com and b.mx.example.com).

-

+

In addition, the public site1 and site2.example.com zones should have special MX records that contain wildcard (`*') records pointing to the bastion hosts. This is needed because external mail @@ -350,11 +382,11 @@ be delivered to the bastion host, which can then forward it on to internal hosts.

-

+

Here's an example of a wildcard MX record:

-
*   IN MX 10 external1.example.com.
-

+

*   IN MX 10 external1.example.com.
+

Now that they accept mail on behalf of anything in the internal network, the bastion hosts will need to know how to deliver mail to internal hosts. In order for this to work properly, the resolvers @@ -362,57 +394,72 @@ the bastion hosts will need to be configured to point to the internal name servers for DNS resolution.

-

+

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

-

+

In order for all this to work properly, internal clients will need to be configured to query only the internal name servers for DNS queries. This could also be enforced via selective filtering on the network.

-

+

If everything has been set properly, Example, Inc.'s internal clients will now be able to:

-
    -
  • +
      +
    • + Look up any hostnames in the site1 and site2.example.com zones. -
    • -
    • + +
    • +
    • + Look up any hostnames in the site1.internal and site2.internal domains. -
    • -
    • Look up any hostnames on the Internet.
    • -
    • Exchange mail with both internal and external people.
    • + + +
    • + Look up any hostnames on the Internet. +
    • +
    • + Exchange mail with both internal and external people. +
    -

    +

    Hosts on the Internet will be able to:

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

      + +

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

      -

      + +

      Internal DNS server config:

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

      + +

      External (bastion host) DNS server config:

      +
       acl internals { 172.16.72.0/24; 192.168.1.0/24; };
       
      @@ -511,190 +560,214 @@ 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

-

+ +

This is a short guide to setting up Transaction SIGnatures (TSIG) based transaction security in BIND. It describes changes to the configuration file as well as what changes are required for different features, including the process of creating transaction keys and using transaction signatures with BIND.

-

+

BIND primarily supports TSIG for server to server communication. This includes zone transfer, notify, and recursive query messages. Resolvers based on newer versions of BIND 8 have limited support for TSIG.

-

+ +

TSIG can also be useful for dynamic update. A primary server for a dynamic zone should control access to the dynamic update service, but IP-based access control is insufficient. The cryptographic access control provided by TSIG - is far superior. The nsupdate + is far superior. The nsupdate program supports TSIG via the -k and -y command line options or inline by use - of the key. + of the key.

-
+ +

-Generate Shared Keys for Each Pair of Hosts

-

+Generate Shared Keys for Each Pair of Hosts

+ +

A shared secret is generated to be shared between host1 and host2. An arbitrary key name is chosen: "host1-host2.". The key name must be the same on both hosts.

-
+

-Automatic Generation

-

+Automatic Generation

+ +

The following command will generate a 128-bit (16 byte) HMAC-SHA256 key as described above. Longer keys are better, but shorter keys are easier to read. Note that the maximum key length is the digest length, here 256 bits.

-

+

dnssec-keygen -a hmac-sha256 -b 128 -n HOST host1-host2.

-

+

The key is in the file Khost1-host2.+163+00000.private. Nothing directly uses this file, but the base-64 encoded string following "Key:" can be extracted from the file and used as a shared secret:

-
Key: La/E5CjG9O+os1jq0a2jdA==
-

+

Key: La/E5CjG9O+os1jq0a2jdA==
+

The string "La/E5CjG9O+os1jq0a2jdA==" can be used as the shared secret.

-
-
+
+

-Manual Generation

-

+Manual Generation

+ +

The shared secret is simply a random sequence of bits, encoded in base-64. Most ASCII strings are valid base-64 strings (assuming the length is a multiple of 4 and only valid characters are used), so the shared secret can be manually generated.

-

- Also, a known string can be run through mmencode or +

+ Also, a known string can be run through mmencode or a similar program to generate base-64 encoded data.

-
-
-
+
+
+

-Copying the Shared Secret to Both Machines

-

+Copying the Shared Secret to Both Machines

+ +

This is beyond the scope of DNS. A secure transport mechanism should be used. This could be secure FTP, ssh, telephone, etc.

- -
+
+

-Informing the Servers of the Key's Existence

-

+Informing the Servers of the Key's Existence

+ +

Imagine host1 and host 2 are both servers. The following is added to each server's named.conf file:

+
 key host1-host2. {
   algorithm hmac-sha256;
   secret "La/E5CjG9O+os1jq0a2jdA==";
 };
 
-

+ +

The secret is the one generated above. Since this is a secret, it is recommended that either named.conf be non-world readable, or the key directive be added to a non-world readable file that is included by named.conf.

-

+

At this point, the key is recognized. This means that if the server receives a message signed by this key, it can verify the signature. If the signature is successfully verified, the response is signed by the same key.

- -
+
+ +

-Instructing the Server to Use the Key

-

+Instructing the Server to Use the Key

+ +

Since keys are shared between two hosts only, the server must be told when keys are to be used. The following is added to the named.conf file for host1, if the IP address of host2 is 10.1.2.3:

+
 server 10.1.2.3 {
   keys { host1-host2. ;};
 };
 
-

+ +

Multiple keys may be present, but only the first is used. This directive does not contain any secrets, so it may be in a world-readable file.

-

+

If host1 sends a message that is a request to that address, the message will be signed with the specified key. host1 will expect any responses to signed messages to be signed with the same key.

-

+

A similar statement must be present in host2's configuration file (with host1's address) for host2 to sign request messages to host1.

- -
+
+

-TSIG Key Based Access Control

-

+TSIG Key Based Access Control

+ +

BIND allows IP addresses and ranges to be specified in ACL definitions and - allow-{ query | transfer | update } + allow-{ query | transfer | update } directives. This has been extended to allow TSIG keys also. The above key would - be denoted key host1-host2. + be denoted key host1-host2.

-

- An example of an allow-update directive would be: +

+ An example of an allow-update directive would be:

+
 allow-update { key host1-host2. ;};
 
-

+ +

This allows dynamic updates to succeed only if the request - was signed by a key named "host1-host2.". + was signed by a key named "host1-host2.".

-

- See the section called “Dynamic Update Policies” for a discussion of - the more flexible update-policy statement. + +

+ See the section called “Dynamic Update Policies” for a discussion of + the more flexible update-policy statement.

- -
+ +
+

-Errors

-

+Errors

+ + +

The processing of TSIG signed messages can result in several errors. If a signed message is sent to a non-TSIG aware server, a FORMERR (format error) will be returned, since the server will not @@ -702,7 +775,8 @@ allow-update { key host1-host2. ;}; since the server must be explicitly configured to send a TSIG signed message to a specific server.

-

+ +

If a TSIG aware server receives a message signed by an unknown key, the response will be unsigned with the TSIG extended error code set to BADKEY. If a TSIG aware server @@ -715,48 +789,55 @@ allow-update { key host1-host2. ;}; verified. In any of these cases, the message's rcode (response code) is set to NOTAUTH (not authenticated).

- - -
+ +
+ +

-TKEY

-

TKEY +TKEY

+ + +

TKEY is a mechanism for automatically generating a shared secret between two hosts. There are several "modes" of - TKEY that specify how the key is generated + TKEY that specify how the key is generated or assigned. BIND 9 implements only one of these modes, the Diffie-Hellman key exchange. Both hosts are required to have a Diffie-Hellman KEY record (although this record is not required to be present in a zone). The - TKEY process must use signed messages, + TKEY process must use signed messages, signed either by TSIG or SIG(0). The result of - TKEY is a shared secret that can be used to - sign messages with TSIG. TKEY can also be + TKEY is a shared secret that can be used to + sign messages with TSIG. TKEY can also be used to delete shared secrets that it had previously generated.

-

- The TKEY process is initiated by a + +

+ The TKEY process is initiated by a client - or server by sending a signed TKEY + or server by sending a signed TKEY query (including any appropriate KEYs) to a TKEY-aware server. The server response, if it indicates success, will contain a - TKEY record and any appropriate keys. + TKEY record and any appropriate keys. After this exchange, both participants have enough information to determine the shared secret; the exact process depends on the - TKEY mode. When using the + TKEY mode. When using the Diffie-Hellman - TKEY mode, Diffie-Hellman keys are + TKEY mode, Diffie-Hellman keys are exchanged, and the shared secret is derived by both participants.

- -
+ +
+

-SIG(0)

-

+SIG(0)

+ + +

BIND 9 partially supports DNSSEC SIG(0) transaction signatures as specified in RFC 2535 and RFC 2931. SIG(0) @@ -764,30 +845,37 @@ allow-update { key host1-host2. ;}; is performed in the same manner as TSIG keys; privileges can be granted or denied based on the key name.

-

+ +

When a SIG(0) signed message is received, it will only be verified if the key is known and trusted by the server; the server will not attempt to locate and/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. + 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 @@ -800,7 +888,8 @@ allow-update { key host1-host2. ;}; that the tools shipped with BIND 9.2.x and earlier are not compatible with the current ones.

-

+ +

There must also be communication with the administrators of the parent and/or child zone to transmit keys. A zone's security status must be indicated by the parent zone for a DNSSEC capable @@ -809,37 +898,45 @@ allow-update { key host1-host2. ;}; delegation point.

-

+ +

For other servers to trust data in this zone, they must either be statically configured with this zone's zone key or the zone key of another zone above this one in the DNS tree.

-
+ +

-Generating Keys

-

- The dnssec-keygen program is used to +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 have the same name as the zone, a name type of - ZONE, and must be usable for + ZONE, and must be usable for authentication. It is recommended that zone keys use a cryptographic algorithm designated as "mandatory to implement" by the IETF; currently the only one is RSASHA1.

-

+ +

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

-

+ +

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

-

+ +

Two output files will be produced: Kchild.example.+005+12345.key and Kchild.example.+005+12345.private @@ -855,29 +952,36 @@ allow-update { 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 + +

+ The dnssec-keyfromlabel program is used to get a key pair from a crypto hardware and build the key - files. Its usage is similar to dnssec-keygen. + 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. + $INCLUDE statements.

- -
+ +
+

-Signing the Zone

-

- The dnssec-signzone program is used +Signing the Zone

+ + +

+ The dnssec-signzone program is used to sign a zone.

-

+ +

Any keyset files corresponding to secure subzones should be present. The zone signer will generate NSEC, NSEC3 @@ -887,16 +991,19 @@ allow-update { key host1-host2. ;}; is not specified, then DS RRsets for the secure child zones need to be added manually.

-

+ +

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

-

+ +

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

-

+ +

One output file is produced: zone.child.example.signed. This file @@ -904,76 +1011,89 @@ allow-update { key host1-host2. ;}; as the input file for the zone.

-

dnssec-signzone + +

dnssec-signzone will also produce a keyset and dsset files and optionally a dlvset file. These are used to provide the parent zone administrators with the DNSKEYs (or their corresponding DS records) that are the secure entry point to the zone.

- -
+ +
+ +

-Configuring Servers

-

- To enable named to respond appropriately +Configuring Servers

+ + +

+ To enable named to respond appropriately to DNS requests from DNSSEC aware clients, - dnssec-enable must be set to yes. + 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 + +

+ To enable named to validate answers from + other servers, the dnssec-enable option must be set to yes, and the - dnssec-validation options must be set to + dnssec-validation options must be set to yes or auto.

-

- If dnssec-validation is set to + +

+ If dnssec-validation is set to auto, then a default trust anchor for the DNS root zone will be used. If it is set to yes, however, then at least one trust anchor must be configured - with a trusted-keys or - managed-keys statement in + with a trusted-keys or + managed-keys statement in named.conf, or DNSSEC validation will not occur. The default setting is yes.

-

- trusted-keys are copies of DNSKEY RRs + +

+ 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 - trusted-keys (and corresponding zones) + trusted-keys (and corresponding zones) are deemed to exist and only the listed keys will be used to validated the DNSKEY RRset that they are from.

-

- managed-keys are trusted keys which are + +

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

+ trusted-keys and + managed-keys are described in more detail later in this document.

-

+ +

Unlike BIND 8, BIND 9 does not verify signatures on load, so zone keys for authoritative zones do not need to be specified in the configuration file.

-

+ +

After DNSSEC gets established, a typical DNSSEC configuration will look something like the following. It has one or more public keys for the root. This allows answers from outside the organization to be validated. It will also have several keys for parts of the namespace the organization - controls. These are here to ensure that named + controls. These are here to ensure that named is immune to compromises in the DNSSEC components of the security of parent zones.

+
 managed-keys {
         /* Root Key */
@@ -1026,67 +1146,77 @@ options {
         dnssec-validation yes;
 };
 
-
+ +

Note

None of the keys listed in this example are valid. In particular, the root key is not valid.
-

+ +

When DNSSEC validation is enabled and properly configured, the resolver will reject any answers from signed, secure zones which fail to validate, and will return SERVFAIL to the client.

-

+ +

Responses may fail to validate for any of several reasons, including missing, expired, or invalid signatures, a key which does not match the DS RRset in the parent zone, or an insecure response from a zone which, according to its parent, should have been secure.

-
+ +

Note

-

+

When the validator receives a response from an unsigned zone that has a signed parent, it must confirm with the parent that the zone was intentionally left unsigned. It does this by verifying, via signed and validated NSEC/NSEC3 records, that the parent zone contains no DS records for the child.

-

+

If the validator can prove that the zone is insecure, then the response is accepted. However, if it cannot, then it must assume an insecure response to be a forgery; it rejects the response and logs an error.

-

+

The logged error reads "insecurity proof failed" and "got insecure response; parent indicates it should be secure". (Prior to BIND 9.7, the logged error was "not insecure". This referred to the zone, not the response.)

-
-
-
-
+
+ + + + +

DNSSEC, Dynamic Zones, and Automatic Signing

-

As of BIND 9.7.0 it is possible to change a dynamic zone + +

As of BIND 9.7.0 it is possible to change a dynamic zone from insecure to signed and back again. A secure zone can use either NSEC or NSEC3 chains.

-

-Converting from insecure to secure

-

Changing a zone from insecure to secure can be done in two +

+

+Converting from insecure to secure

+ +
+

Changing a zone from insecure to secure can be done in two ways: using a dynamic DNS update, or the - auto-dnssec zone option.

-

For either method, you need to configure - named so that it can see the + auto-dnssec zone option.

+

For either method, you need to configure + named so that it can see the K* files which contain the public and private parts of the keys that will be used to sign the zone. These files will have been generated by - dnssec-keygen. You can do this by placing them + dnssec-keygen. You can do this by placing them in the key-directory, as specified in named.conf:

-
+  
         zone example.net {
                 type master;
                 update-policy local;
@@ -1094,32 +1224,35 @@ options {
                 key-directory "dynamic/example.net";
         };
 
-

If one KSK and one ZSK DNSKEY key have been generated, this +

If one KSK and one ZSK DNSKEY key have been generated, this configuration will cause all records in the zone to be signed with the ZSK, and the DNSKEY RRset to be signed with the KSK as well. An NSEC chain will be generated as part of the initial signing process.

-

-Dynamic DNS update method

-

To insert the keys via dynamic update:

-
+  
+

+Dynamic DNS update method

+ +
+

To insert the keys via dynamic update:

+
         % nsupdate
         > ttl 3600
         > update add example.net DNSKEY 256 3 7 AwEAAZn17pUF0KpbPA2c7Gz76Vb18v0teKT3EyAGfBfL8eQ8al35zz3Y I1m/SAQBxIqMfLtIwqWPdgthsu36azGQAX8=
         > update add example.net DNSKEY 257 3 7 AwEAAd/7odU/64o2LGsifbLtQmtO8dFDtTAZXSX2+X3e/UNlq9IHq3Y0 XtC0Iuawl/qkaKVxXe2lo8Ct+dM6UehyCqk=
         > send
 
-

While the update request will complete almost immediately, +

While the update request will complete almost immediately, the zone will not be completely signed until - named has had time to walk the zone and + named has had time to walk the zone and generate the NSEC and RRSIG records. The NSEC record at the apex will be added last, to signal that there is a complete NSEC chain.

-

If you wish to sign using NSEC3 instead of NSEC, you should +

If you wish to sign using NSEC3 instead of NSEC, you should add an NSEC3PARAM record to the initial update request. If you wish the NSEC3 chain to have the OPTOUT bit set, set it in the flags field of the NSEC3PARAM record.

-
+  
         % nsupdate
         > ttl 3600
         > update add example.net DNSKEY 256 3 7 AwEAAZn17pUF0KpbPA2c7Gz76Vb18v0teKT3EyAGfBfL8eQ8al35zz3Y I1m/SAQBxIqMfLtIwqWPdgthsu36azGQAX8=
@@ -1127,61 +1260,64 @@ options {
         > update add example.net NSEC3PARAM 1 1 100 1234567890
         > send
 
-

Again, this update request will complete almost +

Again, this update request will complete almost immediately; however, the record won't show up until - named has had a chance to build/remove the + named has had a chance to build/remove the relevant chain. A private type record will be created to record the state of the operation (see below for more details), and will be removed once the operation completes.

-

While the initial signing and NSEC/NSEC3 chain generation +

While the initial signing and NSEC/NSEC3 chain generation is happening, other updates are possible as well.

-

-Fully automatic zone signing

-

To enable automatic signing, add the - auto-dnssec option to the zone statement in +

+

+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: + auto-dnssec has two possible arguments: allow or maintain.

-

With - auto-dnssec allow, - named can search the key directory for keys +

With + auto-dnssec allow, + named can search the key directory for keys matching the zone, insert them into the zone, and use them to sign the zone. It will do so only when it receives an - rndc sign <zonename>.

-

+ rndc sign <zonename>.

+

- auto-dnssec maintain includes the above + auto-dnssec maintain includes the above functionality, but will also automatically adjust the zone's DNSKEY records on schedule according to the keys' timing metadata. - (See dnssec-keygen(8) and - dnssec-settime(8) for more information.) + (See dnssec-keygen(8) and + dnssec-settime(8) for more information.)

-

- named will periodically search the key directory +

+ named will periodically search the key directory for keys matching the zone, and if the keys' metadata indicates that any change should be made the zone, such as adding, removing, or revoking a key, then that action will be carried out. By default, the key directory is checked for changes every 60 minutes; this period can be adjusted with the dnssec-loadkeys-interval, up - to a maximum of 24 hours. The rndc loadkeys forces - named to check for key updates immediately. + to a maximum of 24 hours. The rndc loadkeys forces + named to check for key updates immediately.

-

+

If keys are present in the key directory the first time the zone is loaded, the zone will be signed immediately, without waiting for an - rndc sign or rndc loadkeys + rndc sign or rndc loadkeys command. (Those commands can still be used when there are unscheduled key changes, however.)

-

+

When new keys are added to a zone, the TTL is set to match that of any existing DNSKEY RRset. If there is no existing DNSKEY RRset, then the TTL will be set to the TTL specified when the key was - created (using the dnssec-keygen -L option), if + created (using the dnssec-keygen -L option), if any, or to the SOA TTL.

-

+

If you wish the zone to be signed using NSEC3 instead of NSEC, submit an NSEC3PARAM record via dynamic update prior to the scheduled publication and activation of the keys. If you wish the @@ -1191,25 +1327,28 @@ options { the zone is signed and the NSEC3 chain is completed, the NSEC3PARAM record will appear in the zone.

-

Using the - auto-dnssec option requires the zone to be +

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 + allow-update or + update-policy statement to the zone configuration. If this has not been done, the configuration will fail.

-

-Private-type records

-

The state of the signing process is signaled by +

+

+Private-type records

+ +
+

The state of the signing process is signaled by private-type records (with a default type value of 65534). When signing is complete, these records will have a nonzero value for the final octet (for those records which have a nonzero initial octet).

-

The private type record format: If the first octet is +

The private type record format: If the first octet is non-zero then the record indicates that the zone needs to be signed with the key matching the record, or that all signatures that match the record should be removed.

-

+



@@ -1220,15 +1359,15 @@ options {

-

Only records flagged as "complete" can be removed via +

Only records flagged as "complete" can be removed via dynamic update. Attempts to remove other private type records will be silently ignored.

-

If the first octet is zero (this is a reserved algorithm +

If the first octet is zero (this is a reserved algorithm number that should never appear in a DNSKEY record) then the record indicates changes to the NSEC3 chains are in progress. The rest of the record contains an NSEC3PARAM record. The flag field tells what operation to perform based on the flag bits.

-

+



@@ -1239,39 +1378,48 @@ options {

-

-DNSKEY rollovers

-

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

+

+DNSKEY rollovers

+ +
+

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

-

-Dynamic DNS update method

-

To perform key rollovers via dynamic update, you need to add + auto-dnssec zone option.

+
+

+Dynamic DNS update method

+ +
+

To perform key rollovers via dynamic update, you need to add the K* files for the new keys so that - named can find them. You can then add the new + named can find them. You can then add the new DNSKEY RRs via dynamic update. - named will then cause the zone to be signed + named will then cause the zone to be signed with the new keys. When the signing is complete the private type records will be updated so that the last octet is non zero.

-

If this is for a KSK you need to inform the parent and any +

If this is for a KSK you need to inform the parent and any trust anchor repositories of the new KSK.

-

You should then wait for the maximum TTL in the zone before +

You should then wait for the maximum TTL in the zone before removing the old DNSKEY. If it is a KSK that is being updated, you also need to wait for the DS RRset in the parent to be updated and its TTL to expire. This ensures that all clients will be able to verify at least one signature when you remove the old DNSKEY.

-

The old DNSKEY can be removed via UPDATE. Take care to +

The old DNSKEY can be removed via UPDATE. Take care to specify the correct key. - named will clean out any signatures generated + named will clean out any signatures generated by the old key after the update completes.

-

-Automatic key rollovers

-

When a new key reaches its activation date (as set by - dnssec-keygen or dnssec-settime), - if the auto-dnssec zone option is set to - maintain, named will +

+

+Automatic key rollovers

+ +
+

When a new key reaches its activation date (as set by + dnssec-keygen or dnssec-settime), + if the auto-dnssec zone option is set to + maintain, named will automatically carry out the key rollover. If the key's algorithm has not previously been used to sign the zone, then the zone will be fully signed as quickly as possible. However, if the new key @@ -1281,89 +1429,112 @@ options { signature validity periods expire. By default, this rollover completes in 30 days, after which it will be safe to remove the old key from the DNSKEY RRset.

-

-NSEC3PARAM rollovers via UPDATE

-

Add the new NSEC3PARAM record via dynamic update. When the +

+

+NSEC3PARAM rollovers via UPDATE

+ +
+

Add the new NSEC3PARAM record via dynamic update. When the new NSEC3 chain has been generated, the NSEC3PARAM flag field will be zero. At this point you can remove the old NSEC3PARAM record. The old chain will be removed after the update request completes.

-

-Converting from NSEC to NSEC3

-

To do this, you just need to add an NSEC3PARAM record. When +

+

+Converting from NSEC to NSEC3

+ +
+

To do this, you just need to add an NSEC3PARAM record. When the conversion is complete, the NSEC chain will have been removed and the NSEC3PARAM record will have a zero flag field. The NSEC3 chain will be generated before the NSEC chain is destroyed.

-

-Converting from NSEC3 to NSEC

-

To do this, use nsupdate to +

+

+Converting from NSEC3 to NSEC

+ +
+

To do this, use nsupdate to remove all NSEC3PARAM records with a zero flag field. The NSEC chain will be generated before the NSEC3 chain is removed.

-

-Converting from secure to insecure

-

To convert a signed zone to unsigned using dynamic DNS, +

+

+Converting from secure to insecure

+ +
+

To convert a signed zone to unsigned using dynamic DNS, delete all the DNSKEY records from the zone apex using - nsupdate. All signatures, NSEC or NSEC3 chains, + nsupdate. All signatures, NSEC or NSEC3 chains, and associated NSEC3PARAM records will be removed automatically. This will take place after the update request completes.

-

This requires the - dnssec-secure-to-insecure option to be set to +

This requires the + dnssec-secure-to-insecure option to be set to yes in named.conf.

-

In addition, if the auto-dnssec maintain +

In addition, if the auto-dnssec maintain zone statement is used, it should be removed or changed to - allow instead (or it will re-sign). + allow instead (or it will re-sign).

-

-Periodic re-signing

-

In any secure zone which supports dynamic updates, named +

+

+Periodic re-signing

+ +
+

In any secure zone which supports dynamic updates, named will periodically re-sign RRsets which have not been re-signed as a result of some update action. The signature lifetimes will be adjusted so as to spread the re-sign load over time rather than all at once.

-

-NSEC3 and OPTOUT

-

- named only supports creating new NSEC3 chains +

+

+NSEC3 and OPTOUT

+ +
+

+ named only supports creating new NSEC3 chains where all the NSEC3 records in the zone have the same OPTOUT state. - named supports UPDATES to zones where the NSEC3 + named supports UPDATES to zones where the NSEC3 records in the chain have mixed OPTOUT state. - named does not support changing the OPTOUT + named does not support changing the OPTOUT state of an individual NSEC3 record, the entire chain needs to be changed if the OPTOUT state of an individual NSEC3 needs to be changed.

-
+ +

Dynamic Trust Anchor Management

-

BIND 9.7.0 introduces support for RFC 5011, dynamic trust + +

BIND 9.7.0 introduces support for RFC 5011, dynamic trust anchor management. Using this feature allows - named to keep track of changes to critical + 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 +Validating Resolver

+ + +

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 + managed-keys statement. Information about this can be found in - the section called “managed-keys Statement Definition + the section called “managed-keys Statement Definition and Usage”.

-
-
+ +
+

-Authoritative Server

-

To set up an authoritative zone for RFC 5011 trust anchor +Authoritative Server

+ +

To set up an authoritative zone for RFC 5011 trust anchor maintenance, generate two (or more) key signing keys (KSKs) for the zone. Sign the zone with one of them; this is the "active" KSK. All KSK's which do not sign the zone are "stand-by" keys.

-

Any validating resolver which is configured to use the +

Any validating resolver which is configured to use the active KSK as an RFC 5011-managed trust anchor will take note of the stand-by KSKs in the zone's DNSKEY RRset, and store them for future reference. The resolver will recheck the zone @@ -1372,90 +1543,96 @@ options { anchor for the zone. Any time after this 30-day acceptance timer has completed, the active KSK can be revoked, and the zone can be "rolled over" to the newly accepted key.

-

The easiest way to place a stand-by key in a zone is to +

The easiest way to place a stand-by key in a zone is to use the "smart signing" features of - dnssec-keygen and - dnssec-signzone. If a key with a publication + dnssec-keygen and + dnssec-signzone. If a key with a publication date in the past, but an activation date which is unset or in the future, " - dnssec-signzone -S" will include the DNSKEY + dnssec-signzone -S" will include the DNSKEY record in the zone, but will not sign with it:

-
+    
 $ dnssec-keygen -K keys -f KSK -P now -A now+2y example.net
 $ dnssec-signzone -S -K keys example.net
 
-

To revoke a key, the new command - dnssec-revoke has been added. This adds the +

To revoke a key, the new command + dnssec-revoke has been added. This adds the REVOKED bit to the key flags and re-generates the K*.key and K*.private files.

-

After revoking the active key, the zone must be signed +

After revoking the active key, the zone must be signed with both the revoked KSK and the new active KSK. (Smart signing takes care of this automatically.)

-

Once a key has been revoked and used to sign the DNSKEY +

Once a key has been revoked and used to sign the DNSKEY RRset in which it appears, that key will never again be accepted as a valid trust anchor by the resolver. However, validation can proceed using the new active key (which had been accepted by the resolver when it was a stand-by key).

-

See RFC 5011 for more details on key rollover +

See RFC 5011 for more details on key rollover scenarios.

-

When a key has been revoked, its key ID changes, +

When a key has been revoked, its key ID changes, increasing by 128, and wrapping around at 65535. So, for example, the key "Kexample.com.+005+10000" becomes "Kexample.com.+005+10128".

-

If two keys have ID's exactly 128 apart, and one is +

If two keys have ID's exactly 128 apart, and one is revoked, then the two key ID's will collide, causing several problems. To prevent this, - dnssec-keygen will not generate a new key if + dnssec-keygen will not generate a new key if another key is present which may collide. This checking will only occur if the new keys are written to the same directory which holds all other keys in use for that zone.

-

Older versions of BIND 9 did not have this precaution. +

Older versions of BIND 9 did not have this precaution. Exercise caution if using key revocation on keys that were generated by previous releases, or if using keys stored in multiple directories or on multiple machines.

-

It is expected that a future release of BIND 9 will +

It is expected that a future release of BIND 9 will address this problem in a different way, by storing revoked keys with their original unrevoked key ID's.

+ - -
+ +

PKCS #11 (Cryptoki) support

-

PKCS #11 (Public Key Cryptography Standard #11) defines a + +

PKCS #11 (Public Key Cryptography Standard #11) defines a platform- independent API for the control of hardware security modules (HSMs) and other cryptographic support devices.

-

BIND 9 is known to work with two HSMs: The Sun SCA 6000 +

BIND 9 is known to work with two HSMs: The Sun SCA 6000 cryptographic acceleration board, tested under Solaris x86, and the AEP Keyper network-attached key storage device, tested with Debian Linux, Solaris x86 and Windows Server 2003.

-
+

-Prerequisites

-

See the HSM vendor documentation for information about +Prerequisites

+ +

See the HSM vendor documentation for information about installing, initializing, testing and troubleshooting the HSM.

-

BIND 9 uses OpenSSL for cryptography, but stock OpenSSL +

BIND 9 uses OpenSSL for cryptography, but stock OpenSSL does not yet fully support PKCS #11. However, a PKCS #11 engine for OpenSSL is available from the OpenSolaris project. It has been modified by ISC to work with with BIND 9, and to provide new features such as PIN management and key by reference.

-

The patched OpenSSL depends on a "PKCS #11 provider". +

The patched OpenSSL depends on a "PKCS #11 provider". This is a shared library object, providing a low-level PKCS #11 interface to the HSM hardware. It is dynamically loaded by OpenSSL at runtime. The PKCS #11 provider comes from the HSM vendor, and is specific to the HSM to be controlled.

-

There are two "flavors" of PKCS #11 support provided by +

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 +

      +
    • +

      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 + 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 are not necessarily any faster at cryptography than the @@ -1464,9 +1641,10 @@ $ dnssec-signzone -S -K keys example.net< functions that require access to the secured private key, 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.

    • + 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, and 1.0.1 are supported; there are @@ -1474,98 +1652,104 @@ $ dnssec-signzone -S -K keys example.net< we use OpenSSL 0.9.8, but the same methods work with OpenSSL 1.0.0 and 1.0.1.

    -
    +

    Note

    The latest OpenSSL versions at the time of the BIND release are 0.9.8y, 1.0.0k and 1.0.1e. ISC will provide an updated patch as new versions of OpenSSL are released. The version number in the following examples is expected to change.
    -

    +

    Before building BIND 9 with PKCS #11 support, it will be necessary to build OpenSSL with this patch in place and inform it of the path to the HSM-specific PKCS #11 provider library.

    -

    Obtain OpenSSL 0.9.8s:

    -
    -$ wget http://www.openssl.org/source/openssl-0.9.8s.tar.gz
    +    

    Obtain OpenSSL 0.9.8s:

    +
    +$ wget http://www.openssl.org/source/openssl-0.9.8s.tar.gz
     
    -

    Extract the tarball:

    -
    +    

    Extract the tarball:

    +
     $ tar zxf openssl-0.9.8s.tar.gz
     
    -

    Apply the patch from the BIND 9 release:

    -
    +    

    Apply the patch from the BIND 9 release:

    +
     $ patch -p1 -d openssl-0.9.8s \
                 < bind9/bin/pkcs11/openssl-0.9.8s-patch
     
    -
    +

    Note

    (Note that the patch file may not be compatible with the "patch" utility on all operating systems. You may need to install GNU patch.)
    -

    When building OpenSSL, place it in a non-standard +

    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.

    -
    +

    -Building OpenSSL for the AEP Keyper on Linux

    -

    The AEP Keyper is a highly secure key storage device, +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 +

    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
     
    -

    This library is only available for Linux as a 32-bit +

    This library is only available for Linux as a 32-bit binary. If we are compiling on a 64-bit Linux system, it is necessary to force a 32-bit build, by specifying -m32 in the build options.

    -

    Finally, the Keyper library requires threads, so we +

    Finally, the Keyper library requires threads, so we must specify -pthread.

    -
    +      
     $ cd openssl-0.9.8s
     $ ./Configure linux-generic32 -m32 -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 +

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

In this example, we are building on Solaris x86 on an AMD64 system.

-
+      
 $ cd openssl-0.9.8s
 $ ./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 +

(For a 32-bit build, use "solaris-x86-cc" and /usr/lib/libpkcs11.so.)

-

After configuring, run - make and - make test.

- -
+

After configuring, run + make and + make test.

+
+

-Building OpenSSL for SoftHSM

-

SoftHSM is a software library provided by the OpenDNSSEC +Building OpenSSL for SoftHSM

+ + +

SoftHSM is a software library provided by the OpenDNSSEC project (http://www.opendnssec.org) which provides a PKCS#11 interface to a virtual HSM, implemented in the form of encrypted data on the local filesystem. It uses the Botan library for @@ -1573,11 +1757,11 @@ $ ./Configure solaris64-x86_64-cc \ than a true HSM, it can provide more secure key storage than traditional key files, and can allow you to experiment with PKCS#11 when an HSM is not available.

-

The SoftHSM cryptographic store must be installed and +

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.0 
 $  configure --prefix=/opt/pkcs11/usr 
 $  make 
@@ -1586,195 +1770,205 @@ $  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 +

SoftHSM can perform all cryptographic operations, but since it only uses your system CPU, there is no need to use it for anything but signing. Therefore, we choose the 'sign-only' flavor when building OpenSSL.

-
+      
 $ cd openssl-0.9.8s
 $ ./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".

- -

Once you have built OpenSSL, run - "apps/openssl engine pkcs11" to confirm +

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 +

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

+

If the output is correct, run + "make install" which will install the modified OpenSSL suite to /opt/pkcs11/usr.

- -
+
+

-Building BIND 9 with PKCS#11

-

When building BIND 9, the location of the custom-built +Building BIND 9 with PKCS#11

+ +

When building BIND 9, the location of the custom-built OpenSSL library must be specified via configure.

-
+

-Configuring BIND 9 for Linux with the AEP Keyper

-

To link with the PKCS #11 provider, threads must be +Configuring BIND 9 for Linux with the AEP Keyper

+ + +

To link with the PKCS #11 provider, threads must be enabled in the BIND 9 build.

-

The PKCS #11 library for the AEP Keyper is currently +

The PKCS #11 library for the AEP Keyper is currently only available as a 32-bit binary. If we are building on a 64-bit host, we must force a 32-bit build by adding "-m32" to the CC options on the "configure" command line.

-
+      
 $ cd ../bind9
 $ ./configure CC="gcc -m32" --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 +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".)

-

If configure complains about OpenSSL not working, you +

(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

-
+Configuring BIND 9 for SoftHSM
+ + +
 $ cd ../bind9
 $ ./configure --enable-threads \
            --with-openssl=/opt/pkcs11/usr \
            --with-pkcs11=/opt/pkcs11/usr/lib/libpkcs11.so
 
- -

After configuring, run - "make", - "make test" and - "make install".

-

(Note: If "make test" fails in the "pkcs11" system test, you may + +

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 +PKCS #11 Tools

+ +

BIND 9 includes a minimal set of tools to operate the HSM, including - pkcs11-keygen to generate a new key pair + pkcs11-keygen to generate a new key pair within the HSM, - pkcs11-list to list objects currently + pkcs11-list to list objects currently available, and - pkcs11-destroy to remove objects.

-

In UNIX/Linux builds, these tools are built only if BIND + pkcs11-destroy to remove objects.

+

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 PKCS #11 provider, then the tools will be built but the provider will be left undefined. Use the -m option or the PKCS11_PROVIDER environment variable to specify the path to the provider.)

- -
+
+

-Using the HSM

-

First, we must set up the runtime environment so the +Using the HSM

+ +

First, we must 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}
 
-

When operating an AEP Keyper, it is also necessary to +

When operating an AEP Keyper, it is also necessary to specify the location of the "machine" file, which stores information about the Keyper for use by PKCS #11 provider library. If the machine file is in /opt/Keyper/PKCS11Provider/machine, use:

-
+    
 $ export KEYPER_LIBRARY_PATH=/opt/Keyper/PKCS11Provider
 
-

These environment variables must be set whenever running + +

These environment variables must be set whenever running any tool that uses the HSM, including - pkcs11-keygen, - pkcs11-list, - pkcs11-destroy, - dnssec-keyfromlabel, - dnssec-signzone, - dnssec-keygen(which will use the HSM for + pkcs11-keygen, + pkcs11-list, + pkcs11-destroy, + dnssec-keyfromlabel, + dnssec-signzone, + dnssec-keygen(which will use the HSM for random number generation), and - named.

-

We can now create and use keys in the HSM. In this case, + 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 +

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 +

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 public key data, plus an identifier for the private key which remains stored within the HSM. The HSM handles signing with the private key.

-

If you wish to generate a second key in the HSM for use +

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:

-
+    
 $ pkcs11-keygen -b 1024 -l sample-zsk
 $ dnssec-keyfromlabel -l sample-zsk example.net
 
-

Alternatively, you may prefer to generate a conventional +

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 +

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 frequent key-signing operation. The zone-signing key can be rolled more frequently, if you wish, to compensate for a reduction in key security.

-

Now you can sign the zone. (Note: If not using the -S +

Now you can sign the zone. (Note: If not using the -S option to - dnssec-signzone, it will be necessary to add + 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:
@@ -1783,43 +1977,45 @@ 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

-

The OpenSSL engine can be specified in - named and all of the BIND - dnssec-* tools by using the "-E +Specifying the engine on the command line

+ +

The OpenSSL engine can be specified in + named and all of the BIND + dnssec-* tools by using the "-E <engine>" command line option. If BIND 9 is built with the --with-pkcs11 option, this option defaults to "pkcs11". Specifying the engine will generally not be necessary unless for some reason you wish to use a different OpenSSL engine.

-

If you wish to disable use of the "pkcs11" 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 +

This causes + dnssec-signzone to run as if it were compiled without the --with-pkcs11 option.

- -
+
+

-Running named with automatic zone re-signing

-

If you want - named to dynamically re-sign zones using HSM +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. This can be accomplished by placing the PIN into the openssl.cnf file (in the above examples, /opt/pkcs11/usr/ssl/openssl.cnf).

-

The location of the openssl.cnf file can be overridden by +

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
@@ -1828,29 +2024,36 @@ $ dnssec-signzone -E '' -S example.net<PLACE PIN HERE>
 
-

This will also allow the dnssec-* tools to access the HSM +

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

-
+ +

Warning

-

Placing the HSM's PIN in a text file in +

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 OpenSSL in this way.

+
+
+ + - - -
+ +

-IPv6 Support in BIND 9

-

+IPv6 Support in BIND 9

+ + +

BIND 9 fully supports all currently defined forms of IPv6 name to address and address to name lookups. It will also use IPv6 addresses to make queries when running on an IPv6 capable system.

-

+ +

For forward lookups, BIND 9 supports only AAAA records. RFC 3363 deprecated the use of A6 records, and client-side support for A6 records was accordingly removed @@ -1860,7 +2063,8 @@ $ dnssec-signzone -E '' -S example.net -

+ +

For IPv6 reverse lookups, BIND 9 supports the traditional "nibble" format used in the ip6.arpa domain, as well as the older, deprecated @@ -1875,33 +2079,41 @@ $ dnssec-signzone -E '' -S example.netBIND 9 name server will not load a zone file containing binary labels.

-

+ +

For an overview of the format and structure of IPv6 addresses, - see the section called “IPv6 addresses (AAAA)”. + see the section called “IPv6 addresses (AAAA)”.

-
+ +

-Address Lookups Using AAAA Records

-

+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

-

+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 @@ -1910,14 +2122,16 @@ host 3600 IN AAAA 2001:db8::1 a host with address 2001:db8::1.

+
 $ORIGIN 0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa.
 1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0  14400   IN    PTR    (
                                     host.example.com. )
 
- - - + + + + -

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch05.html b/doc/arm/Bv9ARM.ch05.html index d9c6e3a425..c21a56431a 100644 --- a/doc/arm/Bv9ARM.ch05.html +++ b/doc/arm/Bv9ARM.ch05.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Chapter 5. The BIND 9 Lightweight Resolver - - + + @@ -39,32 +38,34 @@
-
-

-Chapter 5. The BIND 9 Lightweight Resolver

+
+

+Chapter 5. The BIND 9 Lightweight Resolver

-
+ +

-The Lightweight Resolver Library

-

+The Lightweight Resolver Library

+ +

Traditionally applications have been linked with a stub resolver library that sends recursive DNS queries to a local caching name server.

-

+

IPv6 once introduced new complexity into the resolution process, such as following A6 chains and DNAME records, and simultaneous lookup of IPv4 and IPv6 addresses. Though most of the complexity was then removed, these are hard or impossible to implement in a traditional stub resolver.

-

+

BIND 9 therefore can also provide resolution services to local clients using a combination of a lightweight resolver library and a resolver @@ -72,56 +73,62 @@ 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 + run the resolver daemon lwresd or a local - name server configured with a lwres + name server configured with a lwres statement.

-

+ +

By default, applications using the lightweight resolver library will make UDP requests to the IPv4 loopback address (127.0.0.1) on port 921. The - address can be overridden by lwserver + address can be overridden by lwserver lines in /etc/resolv.conf.

-

+ +

The daemon currently only looks in the DNS, but in the future it may use other sources such as /etc/hosts, NIS, etc.

-

- The lwresd daemon is essentially a + +

+ The lwresd daemon is essentially a caching-only name server that responds to requests using the lightweight resolver protocol rather than the DNS protocol. Because it needs to run on each host, it is designed to require no or minimal configuration. Unless configured otherwise, it uses the name servers listed on - nameserver lines in /etc/resolv.conf + nameserver lines in /etc/resolv.conf as forwarders, but is also capable of doing the resolution autonomously if none are specified.

-

- The lwresd daemon may also be +

+ The lwresd daemon may also be configured with a named.conf style configuration file, in /etc/lwresd.conf by default. A name server may also be configured to act as a lightweight resolver daemon using the - lwres statement in named.conf. + lwres statement in named.conf.

-
- + + + -

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch06.html b/doc/arm/Bv9ARM.ch06.html index cdda3eb558..2859bc0b35 100644 --- a/doc/arm/Bv9ARM.ch06.html +++ b/doc/arm/Bv9ARM.ch06.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Chapter 6. BIND 9 Configuration Reference - - + + @@ -39,74 +38,79 @@
-
-

-Chapter 6. BIND 9 Configuration Reference

+
+

+Chapter 6. BIND 9 Configuration Reference

Table of Contents

-
-
Configuration File Elements
+
+
Configuration File Elements
-
Address Match Lists
-
Comment Syntax
+
Address Match Lists
+
Comment Syntax
-
Configuration File Grammar
+
Configuration File Grammar
-
acl Statement Grammar
-
acl Statement Definition and +
acl Statement Grammar
+
acl Statement Definition and Usage
-
controls Statement Grammar
-
controls Statement Definition and +
controls Statement Grammar
+
controls Statement Definition and Usage
-
include Statement Grammar
-
include Statement Definition and +
include Statement Grammar
+
include Statement Definition and Usage
-
key Statement Grammar
-
key Statement Definition and Usage
-
logging Statement Grammar
-
logging Statement Definition and +
key Statement Grammar
+
key Statement Definition and Usage
+
logging Statement Grammar
+
logging Statement Definition and Usage
-
lwres Statement Grammar
-
lwres Statement Definition and Usage
-
masters Statement Grammar
-
masters Statement Definition and +
lwres Statement Grammar
+
lwres Statement Definition and Usage
+
masters Statement Grammar
+
masters Statement Definition and Usage
-
options Statement Grammar
-
options Statement Definition and +
options Statement Grammar
+
options Statement Definition and Usage
-
server Statement Grammar
-
server Statement Definition and +
server Statement Grammar
+
server Statement Definition and Usage
-
statistics-channels Statement Grammar
-
statistics-channels Statement Definition and +
statistics-channels Statement Grammar
+
statistics-channels Statement Definition and Usage
-
trusted-keys Statement Grammar
-
trusted-keys Statement Definition +
trusted-keys Statement Grammar
+
trusted-keys Statement Definition and Usage
-
managed-keys Statement Grammar
-
managed-keys Statement Definition +
managed-keys Statement Grammar
+
managed-keys Statement Definition and Usage
-
view Statement Grammar
-
view Statement Definition and Usage
-
zone +
view Statement Grammar
+
view Statement Definition and Usage
+
zone Statement Grammar
-
zone Statement Definition and Usage
+
zone Statement Definition and Usage
-
Zone File
+
Zone File
-
Types of Resource Records and When to Use Them
-
Discussion of MX Records
-
Setting TTLs
-
Inverse Mapping in IPv4
-
Other Zone File Directives
-
BIND Master File Extension: the $GENERATE Directive
-
Additional File Formats
+
Types of Resource Records and When to Use Them
+
Discussion of MX Records
+
Setting TTLs
+
Inverse Mapping in IPv4
+
Other Zone File Directives
+
BIND Master File Extension: the $GENERATE Directive
+
Additional File Formats
+
+
BIND9 Statistics
+
+
The Statistics File
+
Statistics Counters
-
BIND9 Statistics
-
Statistics Counters
-

+ + +

BIND 9 configuration is broadly similar to BIND 8; however, there are a few new areas @@ -116,23 +120,26 @@ if they can be more efficiently implemented using the new features found in BIND 9.

-

+ +

BIND 4 configuration files can be converted to the new format using the shell script contrib/named-bootconf/named-bootconf.sh.

-
+

Configuration File Elements

-

+ +

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

-
+
+
--++ @@ -144,7 +151,7 @@ @@ -160,7 +167,7 @@ ip_addr, ip_prefix, key_id, or acl_name elements, see - the section called “Address Match Lists”. + the section called “Address Match Lists”.

@@ -215,8 +222,8 @@ @@ -241,7 +248,7 @@ -

The name of an address_match_list as - defined by the acl statement. + defined by the acl statement.

One to four integers valued 0 through - 255 separated by dots (`.'), such as 123, - 45.67 or 89.123.45.67. + 255 separated by dots (`.'), such as 123, + 45.67 or 89.123.45.67.

- An IPv6 address, such as 2001:db8::1234. + An IPv6 address, such as 2001:db8::1234. IPv6 scoped addresses that have ambiguity on their scope zones must be disambiguated by an appropriate zone ID with the percent character (`%') as @@ -253,9 +260,9 @@ currently only interface names as link identifiers are supported, assuming one-to-one mapping between interfaces and links. For example, a link-local - address fe80::1 on the link - attached to the interface ne0 - can be specified as fe80::1%ne0. + address fe80::1 on the link + attached to the interface ne0 + can be specified as fe80::1%ne0. Note that on most systems link-local addresses always have the ambiguity, and need to be disambiguated. @@ -306,10 +313,10 @@ netmask. Trailing zeros in a ip_addr may omitted. - For example, 127/8 is the - network 127.0.0.0 with - netmask 255.0.0.0 and 1.2.3.0/28 is - network 1.2.3.0 with netmask 255.255.255.240. + For example, 127/8 is the + network 127.0.0.0 with + netmask 255.0.0.0 and 1.2.3.0/28 is + network 1.2.3.0 with netmask 255.255.255.240.

When specifying a prefix involving a IPv6 scoped address @@ -417,7 +424,7 @@ Integers may take values 0 <= value <= 18446744073709551615, though certain parameters - (such as max-journal-size) may + (such as max-journal-size) may use a more limited range within these extremes. In most cases, setting a value to 0 does not literally mean zero; it means "undefined" or @@ -487,86 +494,108 @@

-
+ +
+

Address Match Lists

-
+ +

-Syntax

+Syntax
+ +
address_match_list = address_match_list_element ;
   [ address_match_list_element; ... ]
 address_match_list_element = [ ! ] (ip_address [/length] |
    key key_id | acl_name | { address_match_list } )
 
-
-
+ +
+

-Definition and Usage

-

+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 + 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)
  • -
  • - a key ID, as defined by the key +
      +
    • + 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 acl statement -
    • -
    • a nested address match list enclosed in braces
    • + + +
    • + the name of an address match list defined with + the acl statement + +
    • +
    • + 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. + 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 - allow-notify, - allow-recursion, - allow-recursion-on, - allow-query, - allow-query-on, - allow-query-cache, - allow-query-cache-on, - allow-transfer, - allow-update, - allow-update-forwarding, and - blackhole all use address match - lists. Similarly, the listen-on option will cause the + allow-notify, + allow-recursion, + allow-recursion-on, + allow-query, + allow-query-on, + allow-query-cache, + allow-query-cache-on, + allow-transfer, + allow-update, + allow-update-forwarding, and + blackhole all use address match + lists. Similarly, the listen-on option will cause the server to refuse queries on any of the machine's addresses which do not match the list.

    -

    + +

    Order of insertion is significant. If more than one element in an ACL is found to match a given IP address or prefix, preference will be given to the one that came @@ -575,29 +604,35 @@ defines a subset of another element in the list should come before the broader element, regardless of whether either is negated. For example, in - 1.2.3/24; ! 1.2.3.13; + 1.2.3/24; ! 1.2.3.13; the 1.2.3.13 element is completely useless because the algorithm will match any lookup for 1.2.3.13 to the 1.2.3/24 - element. Using ! 1.2.3.13; 1.2.3/24 fixes + element. Using ! 1.2.3.13; 1.2.3/24 fixes that problem by having 1.2.3.13 blocked by the negation, but all other 1.2.3.* hosts fall through.

    -
-
-
+
+ + +

-Comment Syntax

-

+Comment Syntax

+ + +

The BIND 9 comment syntax allows for comments to appear anywhere that whitespace may appear in a BIND configuration file. To appeal to programmers of all kinds, they can be written in the C, C++, or shell/perl style.

-
+ +

-Syntax

-

+Syntax

+ + +

/* This is a BIND comment as in C */

@@ -609,25 +644,26 @@ # and perl

- -
+
+

-Definition and Usage

-

+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.
@@ -638,14 +674,15 @@
 

-

+ +

C++-style comments start with the two characters // (slash, slash) and continue to the end of the physical line. They cannot be continued across multiple physical lines; to have one logical comment span multiple lines, each line must use the // pair. For example:

-

+

// This is the start of a comment.  The next line
@@ -655,14 +692,15 @@
 

-

+

Shell-style (or perl-style, if you prefer) comments start with the character # (number sign) and continue to the end of the physical line, as in C++ comments. For example:

-

+ +

# This is the start of a comment.  The next line
@@ -672,22 +710,26 @@
 

-
+ +

Warning

-

+

You cannot use the semicolon (`;') character to start a comment such as you would in a zone file. The semicolon indicates the end of a configuration statement.

-
-
- - -
+
+ + + + +

Configuration File Grammar

-

+ + +

A BIND 9 configuration consists of statements and comments. Statements end with a semicolon. Statements and comments are the @@ -695,18 +737,21 @@ statements contain a block of sub-statements, which are also terminated with a semicolon.

-

+ +

The following statements are supported:

-
+ +
+
--++ -
-

acl

+

acl

@@ -717,18 +762,18 @@

-

controls

+

controls

declares control channels to be used - by the rndc utility. + by the rndc utility.

-

include

+

include

@@ -738,7 +783,7 @@

-

key

+

key

@@ -749,7 +794,7 @@

-

logging

+

logging

@@ -760,31 +805,31 @@

-

lwres

+

lwres

- configures named to - also act as a light-weight resolver daemon (lwresd). + configures named to + also act as a light-weight resolver daemon (lwresd).

-

masters

+

masters

defines a named masters list for inclusion in stub and slave zones' - masters or - also-notify lists. + masters or + also-notify lists.

-

options

+

options

@@ -795,7 +840,7 @@

-

server

+

server

@@ -806,18 +851,18 @@

-

statistics-channels

+

statistics-channels

declares communication channels to get access to - named statistics. + named statistics.

-

trusted-keys

+

trusted-keys

@@ -827,7 +872,7 @@

-

managed-keys

+

managed-keys

@@ -838,7 +883,7 @@

-

view

+

view

@@ -848,7 +893,7 @@

-

zone

+

zone

@@ -857,42 +902,53 @@

-

- The logging and - options statements may only occur once + +

+ +

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

-
+ +

-acl Statement Grammar

-
acl acl-name {
+acl Statement Grammar
+ + +
acl acl-name {
     address_match_list
 };
 
- -
+ +
+

-acl Statement Definition and +acl Statement Definition and Usage

-

- The acl statement assigns a symbolic + + +

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

-

+ +

The following ACLs are built-in:

-
+ +
+
--++ -
-

any

+

any

@@ -902,7 +958,7 @@

-

none

+

none

@@ -912,44 +968,48 @@

-

localhost

+

localhost

Matches the IPv4 and IPv6 addresses of all network interfaces on the system. When addresses are - added or removed, the localhost + added or removed, the localhost ACL element is updated to reflect the changes.

-

localnets

+

localnets

Matches any host on an IPv4 or IPv6 network for which the system has an interface. When addresses are added or removed, - the localnets + the localnets ACL element is updated to reflect the changes. Some systems do not provide a way to determine the prefix lengths of local IPv6 addresses. - In such a case, localnets + In such a case, localnets only matches the local - IPv6 addresses, just like localhost. + IPv6 addresses, just like localhost.

-
-
+ +
+ + +

-controls Statement Grammar

-
controls {
+controls Statement Grammar
+ + +
controls {
    [ inet ( ip_addr | * ) [ port ip_port ]
                 allow {  address_match_list  }
                 keys { key_list }; ]
@@ -959,91 +1019,103 @@
    [ unix ...; ]
 };
 
- -
+ +
+ +

-controls Statement Definition and +controls Statement Definition and Usage

-

- The controls statement declares control + + +

+ The controls statement declares control channels to be used by system administrators to control the operation of the name server. These control channels are - used by the rndc utility to send + 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 - address. An ip_addr of * (asterisk) is + +

+ 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 + address. An ip_addr of * (asterisk) is interpreted as the IPv4 wildcard address; connections will be accepted on any of the system's IPv4 addresses. To listen on the IPv6 wildcard address, - use an ip_addr of ::. - If you will only use rndc on the local host, + use an ip_addr of ::. + If you will only use rndc on the local host, 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. + "*" cannot be used for ip_port.

-

+ +

The ability to issue commands over the control channel is - restricted by the allow and - keys clauses. + restricted by the allow and + keys clauses. Connections to the control channel are permitted based on the - address_match_list. This is for simple - IP address based filtering only; any key_id - elements of the address_match_list + address_match_list. This is for simple + IP address based filtering only; any key_id + elements of the address_match_list are ignored.

-

- A unix control channel is a UNIX domain + +

+ 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, - owner and group clauses. + Access to the socket is specified by the perm, + owner and group clauses. Note on some platforms (SunOS and Solaris) the permissions - (perm) are applied to the parent directory + (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. - Each key_id in the key_list + channel is the key_list, which + contains a list of key_ids. + Each key_id in the key_list is authorized to execute commands over the control channel. - See Remote Name Daemon Control application in the section called “Administrative Tools”) - for information about configuring keys in rndc. + See Remote Name Daemon Control application in the section called “Administrative Tools”) + for information about configuring keys in rndc.

-

- If no controls statement is present, - named will set up a default + +

+ If no controls statement is present, + named will set up a default control channel listening on the loopback address 127.0.0.1 and its IPv6 counterpart ::1. - In this case, and also when the controls statement - is present but does not have a keys clause, - named will attempt to load the command channel key + In this case, and also when the controls statement + is present but does not have a keys clause, + named will attempt to load the command channel key from the file rndc.key in /etc (or whatever sysconfdir was specified as when BIND was built). To create a rndc.key file, run rndc-confgen -a.

-

+ +

The rndc.key feature was created to ease the transition of systems from BIND 8, which did not have digital signatures on its command channel - messages and thus did not have a keys clause. + messages and thus did not have a keys clause. It makes it possible to use an existing BIND 8 configuration file in BIND 9 unchanged, - and still have rndc work the same way - ndc worked in BIND 8, simply by executing the + and still have rndc work the same way + ndc worked in BIND 8, simply by executing the command rndc-confgen -a after BIND 9 is installed.

-

+ +

Since the rndc.key feature is only intended to allow the backward-compatible usage of BIND 8 configuration files, this @@ -1055,83 +1127,96 @@ those things. The rndc.key file also has its permissions set such that only the owner of the file (the user that - named is running as) can access it. + named is running as) can access it. If you desire greater flexibility in allowing other users to access - rndc commands, then you need to create + rndc commands, then you need to create a 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 { };. + controls statement: + controls { };.

-
-
+ +
+

-include Statement Grammar

-
include filename;
-
-
+include Statement Grammar
+ +
include filename;
+ +

-include Statement Definition and +include Statement Definition and Usage

-

- The include statement inserts the - specified file at the point where the include - statement is encountered. The include + + +

+ The include statement inserts the + specified file at the point where the include + statement is encountered. The include statement facilitates the administration of configuration files by permitting the reading or writing of some things but not others. For example, the statement could include private keys that are readable only by the name server.

-
-
+ +
+

-key Statement Grammar

-
key key_id {
+key Statement Grammar
+ + +
key key_id {
     algorithm algorithm_id;
     secret secret_string;
 };
 
- -
+ +
+ +

-key Statement Definition and Usage

-

- The key statement defines a shared - secret key for use with TSIG (see the section called “TSIG”) +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 + (see the section called “controls Statement Definition and Usage”).

-

- The key statement can occur at the + +

+ The key statement can occur at the top level - of the configuration file or inside a view - statement. Keys defined in top-level key + of the configuration file or inside a view + statement. Keys defined in top-level key statements can be used in all views. Keys intended for use in - a controls statement - (see the section called “controls Statement Definition and + a controls statement + (see the section called “controls Statement Definition and Usage”) must be defined at the top level.

-

+ +

The key_id, also known as the key name, is a domain name uniquely identifying the key. It can - be used in a server + be used in a server statement to cause requests sent to that server to be signed with this key, or in address match lists to verify that incoming requests have been signed with a key matching this name, algorithm, and secret.

-

+ +

The algorithm_id is a string that specifies a security/authentication algorithm. Named supports hmac-md5, @@ -1145,100 +1230,116 @@ to be used by the algorithm, and is treated as a base-64 encoded string.

- -
+ +
+

-logging Statement Grammar

-
logging {
-   [ channel channel_name {
-     ( file path_name
-         [ versions ( number | unlimited ) ]
-         [ size size_spec ]
-       | syslog syslog_facility
-       | stderr
-       | null );
-     [ severity (critical | error | warning | notice |
+logging Statement Grammar
+ + +
logging {
+   [ channel channel_name {
+     ( file path_name
+         [ versions ( number | unlimited ) ]
+         [ size size_spec ]
+       | syslog syslog_facility
+       | stderr
+       | null );
+     [ severity (critical | error | warning | notice |
                  info | debug [ level ] | dynamic ); ]
-     [ print-category yes or no; ]
-     [ print-severity yes or no; ]
-     [ print-time yes or no; ]
+     [ print-category yes or no; ]
+     [ print-severity yes or no; ]
+     [ print-time yes or no; ]
    }; ]
-   [ category category_name {
+   [ category category_name {
      channel_name ; [ channel_name ; ... ]
    }; ]
    ...
 };
 
- -
+ +
+ +

-logging Statement Definition and +logging Statement Definition and Usage

-

- The logging statement configures a + + +

+ The logging statement configures a wide - variety of logging options for the name server. Its channel phrase + variety of logging options for the name server. Its channel phrase associates output methods, format options and severity levels with - a name that can then be used with the category phrase + 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 +

+ Only one logging statement is used to define - as many channels and categories as are wanted. If there is no logging statement, + as many channels and categories as are wanted. If there is no logging statement, the logging configuration will be:

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

+ +

In BIND 9, the logging configuration is only established when the entire configuration file has been parsed. In BIND 8, it was - established as soon as the logging + established as soon as the logging statement was parsed. When the server is starting up, all logging messages regarding syntax errors in the configuration file go to the default channels, or to standard error if the "-g" option was specified.

-
+ +

-The channel Phrase

-

+The channel Phrase

+ + +

All log output goes to one or more channels; you can make as many of them as you want.

-

+ +

Every channel definition must include a destination clause that says whether messages selected for the channel go to a file, to a particular syslog facility, to the standard error stream, or are discarded. It can optionally also limit the message severity level that will be accepted by the channel (the default is - info), and whether to include a - named-generated time stamp, the + info), and whether to include a + named-generated time stamp, the category name and/or severity level (the default is not to include any).

-

- The null destination clause + +

+ 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 file destination clause directs the channel to a disk file. It can include limitations both on how large the file is allowed to become, and how many versions of the file will be saved each time the file is opened.

-

- If you use the versions log file + +

+ If you use the versions log file option, then - named will retain that many backup + named will retain that many backup versions of the file by renaming them when opening. For example, if you choose to keep three old versions @@ -1248,25 +1349,26 @@ lamers.log.2, lamers.log.0 is renamed to lamers.log.1, and lamers.log is renamed to lamers.log.0. - You can say versions unlimited to + You can say versions unlimited to not limit the number of versions. - If a size option is associated with + If a size option is associated with the log file, then renaming is only done when the file being opened exceeds the indicated size. No backup versions are kept by default; any existing log file is simply appended.

-

- The size option for files is used + +

+ The size option for files is used to limit log - growth. If the file ever exceeds the size, then named will - stop writing to the file unless it has a versions option + growth. If the file ever exceeds the size, then named will + stop writing to the file unless it has a versions option associated with it. If backup versions are kept, the files are rolled as described above and a new one begun. If there is no - versions option, no more data will + versions option, no more data will be written to the log until some out-of-band mechanism removes or truncates the log to less than the @@ -1274,64 +1376,68 @@ the file.

-

- Example usage of the size and - versions options: + +

+ Example usage of the size and + versions options:

+
channel an_example_channel {
     file "example.log" versions 3 size 20m;
     print-time yes;
     print-category yes;
 };
 
-

- The syslog destination clause + +

+ The syslog destination clause directs the channel to the system log. Its argument is a - syslog facility as described in the syslog man - page. Known facilities are kern, user, - mail, daemon, auth, - syslog, lpr, news, - uucp, cron, authpriv, - ftp, local0, local1, - local2, local3, local4, - local5, local6 and - local7, however not all facilities + syslog facility as described in the syslog man + page. Known facilities are kern, user, + mail, daemon, auth, + syslog, lpr, news, + uucp, cron, authpriv, + ftp, local0, local1, + local2, local3, local4, + local5, local6 and + local7, however not all facilities are supported on all operating systems. - How syslog will handle messages + How syslog will handle messages sent to - this facility is described in the syslog.conf man - page. If you have a system which uses a very old version of syslog that - only uses two arguments to the openlog() function, + this facility is described in the syslog.conf man + page. If you have a system which uses a very old version of syslog that + 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 +

+ The severity clause works like syslog's "priorities", except that they can also be used if you are writing - straight to a file rather than using syslog. + straight to a file rather than using syslog. Messages which are not at least of the severity level given will not be selected for the channel; messages of higher severity levels will be accepted.

-

- If you are using syslog, then the syslog.conf priorities +

+ If you are using syslog, then the syslog.conf priorities will also determine what eventually passes through. For example, - defining a channel facility and severity as daemon and debug but - only logging daemon.warning via syslog.conf will - cause messages of severity info and - notice to - be dropped. If the situation were reversed, with named writing - messages of only warning or higher, - then syslogd would + defining a channel facility and severity as daemon and debug but + only logging daemon.warning via syslog.conf will + cause messages of severity info and + notice to + be dropped. If the situation were reversed, with named writing + messages of only warning or higher, + then syslogd would print all messages it received from the channel.

-

- The stderr destination clause + +

+ The stderr destination clause directs the channel to the server's standard error stream. This is intended for @@ -1339,59 +1445,65 @@ example when debugging a configuration.

-

+ +

The server can supply extensive debugging information when it is in debugging mode. If the server's global debug level is greater than zero, then debugging mode will be active. The global debug - level is set either by starting the named server + level is set either by starting the named server with the -d flag followed by a positive integer, - or by running rndc trace. + or by running rndc trace. The global debug level - can be set to zero, and debugging mode turned off, by running rndc + can be set to zero, and debugging mode turned off, by running rndc notrace. All debugging messages in the server have a debug level, and higher debug levels give more detailed output. Channels that specify a specific debug severity, for example:

+
channel specific_debug_level {
     file "foo";
     severity debug 3;
 };
 
-

+ +

will get debugging output of level 3 or less any time the server is in debugging mode, regardless of the global debugging - level. Channels with dynamic + level. Channels with dynamic severity use the server's global debug level to determine what messages to print.

-

- If print-time has been turned on, +

+ If print-time has been turned on, then - the date and time will be logged. print-time may - be specified for a syslog channel, + the date and time will be logged. print-time may + be specified for a syslog channel, but is usually - pointless since syslog also logs + pointless since syslog also logs the date and - time. If print-category is + time. If print-category is requested, then the - category of the message will be logged as well. Finally, if print-severity is - on, then the severity level of the message will be logged. The print- options may + category of the message will be logged as well. Finally, if print-severity is + on, then the severity level of the message will be logged. The print- options may be used in any combination, and will always be printed in the following order: time, category, severity. Here is an example where all - three print- options + three print- options are on:

-

+ +

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

-

+ +

There are four predefined channels that are used for - named's default logging as follows. + named's default logging as follows. How they are - used is described in the section called “The category Phrase”. + used is described in the section called “The category Phrase”.

+
channel default_syslog {
     // send to syslog's daemon facility
     syslog daemon;
@@ -1419,50 +1531,59 @@ channel null {
    null;
 };
 
-

- The default_debug channel has the + +

+ The default_debug channel has the special property that it only produces output when the server's debug level is nonzero. It normally writes to a file called named.run in the server's working directory.

-

+ +

For security reasons, when the "-u" command line option is used, the named.run file - is created only after named has + is created only after named has changed to the - new UID, and any debug output generated while named is + new UID, and any debug output generated while named is starting up and still running as root is discarded. If you need to capture this output, you must run the server with the "-g" option and redirect standard error to a file.

-

+ +

Once a channel is defined, it cannot be redefined. Thus you cannot alter the built-in channels directly, but you can modify the default logging by pointing categories at channels you have defined.

- -
+
+ +

-The category Phrase

-

+The category Phrase

+ + +

There are many categories, so you can send the logs you want to see wherever you want, without seeing logs you don't want. If you don't specify a list of channels for a category, then log messages - in that category will be sent to the default category + in that category will be sent to the default category instead. If you don't specify a default category, the following "default default" is used:

+
category default { default_syslog; default_debug; };
 
-

+ +

As an example, let's say you want to log security events to a file, but you also want keep the default logging behavior. You'd specify the following:

+
channel my_security_channel {
     file "my_security_file";
     severity info;
@@ -1472,26 +1593,30 @@ category security {
     default_syslog;
     default_debug;
 };
-

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

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

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

+ +

Following are the available categories and brief descriptions of the types of log information they contain. More categories may be added in future BIND releases.

-
+
+
--++ -
-

client

+

client

@@ -1501,7 +1626,7 @@ category notify { null; };

-

cname

+

cname

@@ -1512,7 +1637,7 @@ category notify { null; };

-

config

+

config

@@ -1522,7 +1647,7 @@ category notify { null; };

-

database

+

database

@@ -1534,7 +1659,7 @@ category notify { null; };

-

default

+

default

@@ -1547,21 +1672,21 @@ category notify { null; };

-

delegation-only

+

delegation-only

Delegation only. Logs queries that have been forced to NXDOMAIN as the result of a delegation-only zone or a - delegation-only in a + delegation-only in a forward, hint or stub zone declaration.

-

dispatch

+

dispatch

@@ -1572,7 +1697,7 @@ category notify { null; };

-

dnssec

+

dnssec

@@ -1582,7 +1707,7 @@ category notify { null; };

-

edns-disabled

+

edns-disabled

@@ -1604,7 +1729,7 @@ category notify { null; }; number of false-positive reports.

- Note: eventually named will have to stop + Note: eventually named will have to stop treating such timeouts as due to RFC 1034 non compliance and start treating it as plain packet loss. Falsely classifying packet @@ -1616,7 +1741,7 @@ category notify { null; };

-

general

+

general

@@ -1627,7 +1752,7 @@ category notify { null; };

-

lame-servers

+

lame-servers

@@ -1639,7 +1764,7 @@ category notify { null; };

-

network

+

network

@@ -1649,7 +1774,7 @@ category notify { null; };

-

notify

+

notify

@@ -1659,15 +1784,15 @@ category notify { null; };

-

queries

+

queries

Specify where queries should be logged to.

- At startup, specifying the category queries will also - enable query logging unless querylog option has been + At startup, specifying the category queries will also + enable query logging unless querylog option has been specified.

@@ -1700,7 +1825,7 @@ category notify { null; };
-

query-errors

+

query-errors

@@ -1711,7 +1836,7 @@ category notify { null; };

-

rate-limit

+

rate-limit

@@ -1722,7 +1847,7 @@ category notify { null; };

The start, periodic, and final notices of the rate limiting of a stream of responses are logged at - info severity in this category. + info severity in this category. These messages include a hash value of the domain name of the response and the name itself, except when there is insufficient memory to record @@ -1736,13 +1861,13 @@ category notify { null; };

Rate limiting of individual requests - is logged in the query-errors category. + is logged in the query-errors category.

-

resolver

+

resolver

@@ -1754,20 +1879,20 @@ category notify { null; };

-

rpz

+

rpz

Information about errors in response policy zone files, rewritten responses, and at the highest - debug levels, mere rewriting + debug levels, mere rewriting attempts.

-

security

+

security

@@ -1777,7 +1902,7 @@ category notify { null; };

-

spill

+

spill

@@ -1789,22 +1914,22 @@ category notify { null; };

-

unmatched

+

unmatched

- Messages that named was unable to determine the - class of or for which there was no matching view. - A one line summary is also logged to the client category. + Messages that named was unable to determine the + class of or for which there was no matching view. + A one line summary is also logged to the client category. This category is best sent to a file or stderr, by default it is sent to - the null channel. + the null channel.

-

update

+

update

@@ -1814,7 +1939,7 @@ category notify { null; };

-

update-security

+

update-security

@@ -1824,7 +1949,7 @@ category notify { null; };

-

xfer-in

+

xfer-in

@@ -1834,7 +1959,7 @@ category notify { null; };

-

xfer-out

+

xfer-out

@@ -1843,27 +1968,30 @@ category notify { null; };

+ -
+
+

-The query-errors Category

-

- The query-errors category is +The query-errors Category

+ +

+ The query-errors category is specifically intended for debugging purposes: To identify why and how specific queries result in responses which indicate an error. Messages of this category are therefore only logged - with debug levels. + with debug levels.

-

+ +

At the debug levels of 1 or higher, each response with the rcode of SERVFAIL is logged as follows:

-

+

client 127.0.0.1#61502: query failed (SERVFAIL) for www.example.com/IN/AAAA at query.c:3880

-

+

This means an error resulting in SERVFAIL was detected at line 3880 of source file query.c. @@ -1871,13 +1999,13 @@ category notify { null; }; help identify the cause of SERVFAIL for an authoritative server.

-

+

At the debug levels of 2 or higher, detailed context information of recursive resolutions that resulted in SERVFAIL is logged. The log message will look like as follows:

-

+

@@ -1888,14 +2016,14 @@ badresp:1,adberr:0,findfail:0,valfail:0]
             

-

+

The first part before the colon shows that a recursive resolution for AAAA records of www.example.com completed in 30.000183 seconds and the final result that led to the SERVFAIL was determined at line 2970 of source file resolver.c.

-

+

The following part shows the detected final result and the latest result of DNSSEC validation. The latter is always success when no validation attempt @@ -1905,7 +2033,7 @@ badresp:1,adberr:0,findfail:0,valfail:0] to a timeout in 30 seconds. DNSSEC validation was probably not attempted.

-

+

The last part enclosed in square brackets shows statistics information collected for this particular resolution attempt. @@ -1915,10 +2043,12 @@ badresp:1,adberr:0,findfail:0,valfail:0] The meaning of the other fields is summarized in the following table.

-
+ +
+
--++ @@ -2054,15 +2184,16 @@ badresp:1,adberr:0,findfail:0,valfail:0] -
-

+ + +

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

-

+

At the debug levels of 4 or higher, the same messages as those at the debug 2 level are logged for other errors than SERVFAIL. @@ -2071,16 +2202,20 @@ badresp:1,adberr:0,findfail:0,valfail:0] This is because any unexpected results can be difficult to debug in the recursion case.

- - -
+
+ + +

-lwres Statement Grammar

-

- This is the grammar of the lwres +lwres Statement Grammar

+ + +

+ This is the grammar of the lwres statement in the named.conf file:

-
lwres {
+
+
lwres {
     [ listen-on { ip_addr [port ip_port] ;
                 [ ip_addr [port ip_port] ; ... ] }; ]
     [ view view_name; ]
@@ -2088,20 +2223,24 @@ badresp:1,adberr:0,findfail:0,valfail:0]
     [ ndots number; ]
 };
 
- -
+ +
+

-lwres Statement Definition and Usage

-

- The lwres statement configures the +lwres Statement Definition and Usage

+ + +

+ The lwres statement configures the name server to also act as a lightweight resolver server. (See - the section called “Running a Resolver Daemon”.) There may be multiple - lwres statements configuring + the section called “Running a Resolver Daemon”.) There may be multiple + lwres statements configuring lightweight resolver servers with different properties.

-

- The listen-on statement specifies a + +

+ The listen-on statement specifies a list of IPv4 addresses (and ports) that this instance of a lightweight resolver daemon @@ -2111,8 +2250,9 @@ badresp:1,adberr:0,findfail:0,valfail:0] 127.0.0.1, port 921.

-

- The view statement binds this + +

+ The view statement binds this instance of a lightweight resolver daemon to a view in the DNS namespace, so that the @@ -2122,50 +2262,61 @@ badresp:1,adberr:0,findfail:0,valfail:0] is used, and if there is no default view, an error is triggered.

-

- The search statement is equivalent to + +

+ The search statement is equivalent to the - search statement in + search statement in /etc/resolv.conf. It provides a list of domains which are appended to relative names in queries.

-

- The ndots statement is equivalent to + +

+ The ndots statement is equivalent to the - ndots statement in + ndots statement in /etc/resolv.conf. It indicates the minimum number of dots in a relative domain name that should result in an exact match lookup before search path elements are appended.

- -
+
+

-masters Statement Grammar

+masters Statement Grammar
+ +
-masters name [port ip_port] { ( masters_list |
+masters name [port ip_port] { ( masters_list |
       ip_addr [port ip_port] [key key] ) ; [...] };
 
- -
+ +
+ +

-masters Statement Definition and +masters Statement Definition and Usage

-

masters + +

masters lists allow for a common set of masters to be easily used by - multiple stub and slave zones in their masters - or also-notify lists. + multiple stub and slave zones in their masters + or also-notify lists.

-
-
+
+ +

-options Statement Grammar

-

- This is the grammar of the options +options Statement Grammar

+ + +

+ This is the grammar of the options statement in the named.conf file:

-
options {
+
+
options {
     [ attach-cache cache_name; ]
     [ version version_string; ]
     [ hostname hostname_string; ]
@@ -2402,24 +2553,29 @@ badresp:1,adberr:0,findfail:0,valfail:0]
     ; ]
 };
 
- -
+ +
+ +

-options Statement Definition and +options Statement Definition and Usage

-

- The options statement sets up global + + +

+ The options statement sets up global options to be used by BIND. This statement may appear only - once in a configuration file. If there is no options + once in a configuration file. If there is no options statement, an options block with each option set to its default will be used.

-
-
attach-cache
+ +
+
attach-cache
-

+

Allows multiple views to share a single cache database. Each view has its own cache database by default, but @@ -2428,38 +2584,43 @@ 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 + +

+ The attach-cache option + may also be specified in view statements, in which case it overrides the - global attach-cache option. + global attach-cache option.

-

+ +

The cache_name specifies the cache to be shared. - When the named server configures + When the named server configures views which are supposed to share a cache, it creates a cache with the specified name for the first view of these sharing views. The rest of the views will simply refer to the already created cache.

-

+ +

One common configuration to share a cache would be to allow all views to share a single cache. This can be done by specifying - the attach-cache as a global + the attach-cache as a global option with an arbitrary name.

-

+ +

Another possible operation is to allow a subset of all views to share a cache while the others to retain their own caches. For example, if there are three views A, B, and C, and only A and B should share a cache, specify the - attach-cache option as a view A (or + attach-cache option as a view A (or B)'s option, referring to the other view name:

+
   view "A" {
     // this view has its own cache
@@ -2474,22 +2635,24 @@ 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 configurable options be consistent among these views: - check-names, - cleaning-interval, - dnssec-accept-expired, - dnssec-validation, - max-cache-ttl, - max-ncache-ttl, - max-cache-size, and - zero-no-soa-ttl. + check-names, + cleaning-interval, + dnssec-accept-expired, + dnssec-validation, + max-cache-ttl, + max-ncache-ttl, + 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. @@ -2501,9 +2664,10 @@ badresp:1,adberr:0,findfail:0,valfail:0] configuration differences in different views do not cause disruption with a shared cache.

-
-
directory
-

+

+
directory
+
+

The working directory of the server. Any non-absolute pathnames in the configuration file will be taken @@ -2516,9 +2680,11 @@ badresp:1,adberr:0,findfail:0,valfail:0] which the server was started. The directory specified should be an absolute path. -

-
key-directory
-

+

+
+
key-directory
+
+

When performing dynamic update of secure zones, the directory where the public and private DNSSEC key files should be found, if different than the current working @@ -2527,16 +2693,17 @@ badresp:1,adberr:0,findfail:0,valfail:0] bind.keys, rndc.key or session.key.) -

-
managed-keys-directory
+

+ +
managed-keys-directory
-

+

Specifies the directory in which to store the files that track managed DNSSEC keys. By default, this is the working directory.

-

- If named is not configured to use views, +

+ If named is not configured to use views, then managed keys for the server will be tracked in a single file called managed-keys.bind. Otherwise, managed keys will be tracked in separate files, @@ -2544,25 +2711,30 @@ badresp:1,adberr:0,findfail:0,valfail:0] of the view name, followed by the extension .mkeys.

-
-
named-xfer
-

+

+
named-xfer
+
+

This option is obsolete. It was used in BIND 8 to specify - the pathname to the named-xfer + the pathname to the named-xfer program. In BIND 9, no separate - named-xfer program is needed; + named-xfer program is needed; its functionality is built into the name server. -

-
tkey-gssapi-keytab
-

+

+
+
tkey-gssapi-keytab
+
+

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

-
tkey-gssapi-credential
-

+

+
+
tkey-gssapi-credential
+
+

The security credential with which the server should authenticate keys requested by the GSS-TSIG protocol. Currently only Kerberos 5 authentication is available @@ -2572,129 +2744,157 @@ badresp:1,adberr:0,findfail:0,valfail:0] The location keytab file can be overridden using the tkey-gssapi-keytab option. Normally this principal is of the form "DNS/server.domain". - To use GSS-TSIG, tkey-domain must + To use GSS-TSIG, tkey-domain must also be set if a specific keytab is not set with tkey-gssapi-keytab. -

-
tkey-domain
-

+

+
+
tkey-domain
+
+

The domain appended to the names of all shared keys - generated with TKEY. When a - client requests a TKEY exchange, + generated with TKEY. When a + client requests a TKEY exchange, it may or may not specify the desired name for the key. If present, the name of the shared key will be client specified part + tkey-domain. Otherwise, the name of the shared key will be random hex digits + tkey-domain. - In most cases, the domainname + In most cases, the domainname should be the server's domain name, or an otherwise non-existent subdomain like "_tkey.domainname". If you are using GSS-TSIG, this variable must be defined, unless you specify a specific keytab using tkey-gssapi-keytab. -

-
tkey-dhkey
-

+

+
+
tkey-dhkey
+
+

The Diffie-Hellman key used by the server to generate shared keys with clients using the Diffie-Hellman mode - of TKEY. The server must be + of TKEY. The server must be able to load the public and private keys from files in the working directory. In most cases, the keyname should be the server's host name. -

-
cache-file
-

+

+
+
cache-file
+
+

This is for testing only. Do not use. -

-
dump-file
-

+

+
+
dump-file
+
+

The pathname of the file the server dumps the database to when instructed to do so with - rndc dumpdb. + rndc dumpdb. If not specified, the default is named_dump.db. -

-
memstatistics-file
-

+

+
+
memstatistics-file
+
+

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

-
pid-file
-

+

+
+
pid-file
+
+

The pathname of the file the server writes its process ID in. If not specified, the default is /var/run/named/named.pid. The PID file is used by programs that want to send signals to the running - name server. Specifying pid-file none disables the + name server. Specifying pid-file none disables the use of a PID file — no file will be written and any - existing one will be removed. Note that none + existing one will be removed. Note that none is a keyword, not a filename, and therefore is not enclosed in double quotes. -

-
recursing-file
-

+

+
+
recursing-file
+
+

The pathname of the file the server dumps the queries that are currently recursing when instructed - to do so with rndc recursing. + to do so with rndc recursing. If not specified, the default is named.recursing. -

-
statistics-file
-

+

+
+
statistics-file
+
+

The pathname of the file the server appends statistics - to when instructed to do so using rndc stats. + 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
-

+ in the section called “The Statistics File”. +

+
+
bindkeys-file
+
+

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

-
secroots-file
-

+

+
+
secroots-file
+
+

The pathname of the file the server dumps security roots to when instructed to do so with - rndc secroots. + rndc secroots. If not specified, the default is named.secroots. -

-
session-keyfile
-

+

+
+
session-keyfile
+
+

The pathname of the file into which to write a TSIG - session key generated by named for use by - nsupdate -l. If not specified, the + session key generated by named for use by + nsupdate -l. If not specified, the default is /var/run/named/session.key. - (See the section called “Dynamic Update Policies”, and in + (See the section called “Dynamic Update Policies”, and in particular the discussion of the - update-policy statement's + update-policy statement's local option for more information about this feature.) -

-
session-keyname
-

+

+
+
session-keyname
+
+

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

-
session-keyalg
-

+

+
+
session-keyalg
+
+

The algorithm to use for the TSIG session key. Valid values are hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, hmac-sha512 and hmac-md5. If not specified, the default is hmac-sha256. -

-
port
-

+

+
+
port
+
+

The UDP/TCP port number the server uses for receiving and sending DNS protocol traffic. The default is 53. This option is mainly intended for server @@ -2702,9 +2902,11 @@ badresp:1,adberr:0,findfail:0,valfail:0] a server using a port other than 53 will not be able to communicate with the global DNS. -

-
random-device
-

+

+
+
random-device
+
+

The source of entropy to be used by the server. Entropy is primarily needed for DNSSEC operations, such as TKEY transactions and dynamic @@ -2717,37 +2919,40 @@ badresp:1,adberr:0,findfail:0,valfail:0] is /dev/random (or equivalent) when present, and none otherwise. The - random-device option takes + random-device option takes effect during the initial configuration load at server startup time and is ignored on subsequent reloads. -

-
preferred-glue
-

+

+
+
preferred-glue
+
+

If specified, the listed type (A or AAAA) will be emitted before other glue in the additional section of a query response. The default is to prefer A records when responding to queries that arrived via IPv4 and AAAA when responding to queries that arrived via IPv6. -

+

+
-root-delegation-only +root-delegation-only
-

+

Turn on enforcement of delegation-only in TLDs (top level domains) and root zones with an optional exclude list.

-

+

DS queries are expected to be made to and be answered by delegation only zones. Such queries and responses are treated as an exception to delegation-only processing and are not converted to NXDOMAIN responses provided a CNAME is not discovered at the query name.

-

+

If a delegation only zone server also serves a child zone it is not always possible to determine whether an answer comes from the delegation only zone or the @@ -2763,159 +2968,165 @@ badresp:1,adberr:0,findfail:0,valfail:0] all these checks there is still a possibility of false negatives when a child zone is being served.

-

+

Similarly false positives can arise from empty nodes (no records at the name) in the delegation only zone when the query type is not ANY.

-

+

Note some TLDs are not delegation only (e.g. "DE", "LV", "US" and "MUSEUM"). This list is not exhaustive.

+
 options {
         root-delegation-only exclude { "de"; "lv"; "us"; "museum"; };
 };
 
-
-
disable-algorithms
-

+ +

+
disable-algorithms
+
+

Disable the specified DNSSEC algorithms at and below the specified name. - Multiple disable-algorithms + Multiple disable-algorithms statements are allowed. Only the most specific will be applied. -

-
dnssec-lookaside
+

+ +
dnssec-lookaside
-

- When set, dnssec-lookaside provides the +

+ 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 below a domain specified by the deepest - dnssec-lookaside, and the normal DNSSEC + dnssec-lookaside, and the normal DNSSEC validation has left the key untrusted, the trust-anchor will be appended to the key name and a DLV record will be looked up to see if it can validate the key. If the DLV 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 +

+ If dnssec-lookaside is set to auto, then built-in default values for the DLV domain and trust anchor will be used, along with a built-in key for validation.

-

- If dnssec-lookaside is set to +

+ If dnssec-lookaside is set to no, then dnssec-lookaside is not used.

-

+

The default DLV key is stored in the file bind.keys; - named will load that key at - startup if dnssec-lookaside is set to + named will load that key at + startup if dnssec-lookaside is set to auto. A copy of the file is installed along with BIND 9, and is current as of the release date. If the DLV key expires, a new copy of bind.keys can be downloaded - from https://www.isc.org/solutions/dlv/. + from https://www.isc.org/solutions/dlv/.

-

+

(To prevent problems if bind.keys is not found, the current key is also compiled in to - named. Relying on this is not - recommended, however, as it requires named + named. Relying on this is not + recommended, however, as it requires named to be recompiled with a new key when the DLV key expires.)

-

- NOTE: named only loads certain specific +

+ NOTE: named only loads certain specific keys from bind.keys: those for the DLV zone and for the DNS root zone. The file cannot be used to store keys for other zones.

-
-
dnssec-must-be-secure
-

+

+
dnssec-must-be-secure
+
+

Specify hierarchies which must be or may not be secure (signed and validated). If yes, - then named will only accept answers if + then named will only accept answers if they are secure. If no, then normal DNSSEC validation applies allowing for insecure answers to be accepted. The specified domain must be under a - trusted-keys or - managed-keys statement, or - dnssec-lookaside must be active. -

-
dns64
+ trusted-keys or + managed-keys statement, or + dnssec-lookaside must be active. +

+ +
dns64
-

- This directive instructs named to +

+ This directive instructs named to return mapped IPv4 addresses to AAAA queries when there are no AAAA records. It is intended to be used in conjunction with a NAT64. Each - dns64 defines one DNS64 prefix. + dns64 defines one DNS64 prefix. Multiple DNS64 prefixes can be defined.

-

+

Compatible IPv6 prefixes have lengths of 32, 40, 48, 56, 64 and 96 as per RFC 6052.

-

+

Additionally a reverse IP6.ARPA zone will be created for the prefix to provide a mapping from the IP6.ARPA names to the corresponding IN-ADDR.ARPA names using synthesized - CNAMEs. dns64-server and - dns64-contact can be used to specify + CNAMEs. dns64-server and + dns64-contact can be used to specify the name of the server and contact for the zones. These are settable at the view / options level. These are not settable on a per-prefix basis.

-

- Each dns64 supports an optional - clients ACL that determines which +

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

+ Each dns64 supports an optional + mapped ACL that selects which IPv4 addresses are to be mapped in the corresponding A RRset. If not defined it defaults to any;.

-

+

Normally, DNS64 won't apply to a domain name that owns one or more AAAA records; these records will simply be returned. The optional - exclude ACL allows specification + exclude ACL allows specification of a list of IPv6 addresses that will be ignored if they appear in a domain name's AAAA records, and DNS64 will be applied to any A records the domain - name owns. If not defined, exclude + name owns. If not defined, exclude defaults to none.

-

- A optional suffix can also +

+ A optional suffix can also be defined to set the bits trailing the mapped IPv4 address bits. By default these bits are set to ::. The bits matching the prefix and mapped IPv4 address must be zero.

-

- If recursive-only is set to - yes the DNS64 synthesis will +

+ If recursive-only is set to + yes the DNS64 synthesis will only happen for recursive queries. The default - is no. + is no.

-

- If break-dnssec is set to - yes the DNS64 synthesis will +

+ If break-dnssec is set to + yes the DNS64 synthesis will happen even if the result, if validated, would cause a DNSSEC validation failure. If this option - is set to no (the default), the DO + is set to no (the default), the DO is set on the incoming query, and there are RRSIGs on the applicable records, then synthesis will not happen.

@@ -2929,121 +3140,129 @@ options { suffix ::; };
- -
dnssec-loadkeys-interval
-

- When a zone is configured with auto-dnssec +

+
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 or any existing keys' timing metadata has been updated - (see dnssec-keygen(8) and - dnssec-settime(8)). The - dnssec-loadkeys-interval option + (see dnssec-keygen(8) and + dnssec-settime(8)). The + dnssec-loadkeys-interval option sets the frequency of automatic repository checks, in minutes. The default is 60 (1 hour), the minimum is 1 (1 minute), and the maximum is 1440 (24 hours); any higher value is silently reduced. -

-
dnssec-update-mode
+

+ +
dnssec-update-mode
-

+

If this option is set to its default value of maintain in a zone of type master which is DNSSEC-signed and configured to allow dynamic updates (see - the section called “Dynamic Update Policies”), and - if named has access to the + the section called “Dynamic Update Policies”), and + if named has access to the private signing key(s) for the zone, then - named will automatically sign all new + named will automatically sign all new or changed records and maintain signatures for the zone by regenerating RRSIG records whenever they approach their expiration date.

-

+

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

-

- With either of these settings, named +

+ With either of these settings, named will reject updates to a DNSSEC-signed zone when the signing keys are inactive or unavailable to - named. (A planned third option, + named. (A planned third option, external, will disable all automatic signing and allow DNSSEC data to be submitted into a zone via dynamic update; this is not yet implemented.)

-
-
serial-update-method
+ +
serial-update-method
-

+

Zones configured for dynamic DNS may use this option to set the update method that will be used for the zone serial number in the SOA record.

-

+

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

-

+

When set to - serial-update-method unixtime;, the + serial-update-method unixtime;, the SOA serial number will be set to the number of seconds since the UNIX epoch, unless the serial number is already greater than or equal to that value, in which case it is simply incremented by one.

-
-
zone-statistics
+ +
zone-statistics
-

+

If full, the server will collect statistical data on all zones (unless specifically turned off on a per-zone basis by specifying - zone-statistics terse or - zone-statistics none - in the zone statement). + zone-statistics terse or + zone-statistics none + in the zone statement). The default is terse, providing minimal statistics on zones (including name and current serial number, but not query type counters).

-

+

These statistics may be accessed via the - statistics-channel or - using rndc stats, which + statistics-channel or + using rndc stats, which will dump them to the file listed - in the statistics-file. See - also the section called “The Statistics File”. + in the statistics-file. See + also the section called “The Statistics File”.

-

+

For backward compatibility with earlier versions - of BIND 9, the zone-statistics + of BIND 9, the zone-statistics option can also accept yes or no, which have the same effect as full and terse, respectively.

-
+ -
+ +

Boolean Options

-
-
allow-new-zones
-

+ + +

+
allow-new-zones
+
+

If yes, then zones can be - added at runtime via rndc addzone - or deleted via rndc delzone. + added at runtime via rndc addzone + or deleted via rndc delzone. The default is no. -

-
auth-nxdomain
-

- If yes, then the AA bit +

+
+
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; @@ -3051,25 +3270,30 @@ options { a change from BIND 8. If you are using very old DNS software, you may need to set it to yes. -

-
deallocate-on-exit
-

+

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

+

+
+
memstatistics
+
+

Write memory statistics to the file specified by - memstatistics-file at exit. + memstatistics-file at exit. The default is no unless '-m record' is specified on the command line in which case it is yes. -

-
dialup
+

+
+
dialup
-

+

If yes, then the server treats all zones as if they are doing zone transfers across @@ -3079,19 +3303,19 @@ options { according to zone type and concentrates the zone maintenance so that it all - happens in a short interval, once every heartbeat-interval and + happens in a short interval, once every heartbeat-interval and hopefully during the one call. It also suppresses some of the normal zone maintenance traffic. The default is no.

-

- The dialup option - may also be specified in the view and - zone statements, - in which case it overrides the global dialup +

+ The dialup option + may also be specified in the view and + zone statements, + in which case it overrides the global dialup option.

-

+

If the zone is a master zone, then the server will send out a NOTIFY request to all the slaves (default). This should trigger the @@ -3101,19 +3325,19 @@ options { to verify the zone while the connection is active. The set of servers to which NOTIFY is sent can be controlled by - notify and also-notify. + notify and also-notify.

-

+

If the zone is a slave or stub zone, then the server will suppress the regular "zone up to date" (refresh) queries and only perform them when the - heartbeat-interval expires in + heartbeat-interval expires in addition to sending NOTIFY requests.

-

+

Finer control can be achieved by using notify which only sends NOTIFY messages, @@ -3122,18 +3346,20 @@ options { suppresses the normal refresh queries, refresh which suppresses normal refresh processing and sends refresh queries - when the heartbeat-interval + when the heartbeat-interval expires, and passive which just disables normal refresh processing.

-
+ +
+
----++++ @@ -3160,7 +3386,7 @@ options { -
-

no (default)

+

no (default)

@@ -3180,7 +3406,7 @@ options {

-

yes

+

yes

@@ -3200,7 +3426,7 @@ options {

-

notify

+

notify

@@ -3220,7 +3446,7 @@ options {

-

refresh

+

refresh

@@ -3240,7 +3466,7 @@ options {

-

passive

+

passive

@@ -3260,7 +3486,7 @@ options {

-

notify-passive

+

notify-passive

@@ -3279,21 +3505,27 @@ options {

-

+ +

+ +

Note that normal NOTIFY processing is not affected by - dialup. + dialup.

- -
fake-iquery
-

+ +

+
fake-iquery
+
+

In BIND 8, this option enabled simulating the obsolete DNS query type IQUERY. BIND 9 never does IQUERY simulation. -

-
fetch-glue
-

+

+
+
fetch-glue
+
+

This option is obsolete. In BIND 8, fetch-glue yes caused the server to attempt to fetch glue resource records @@ -3302,92 +3534,106 @@ options { data section of a response. This is now considered a bad idea and BIND 9 never does it. -

-
flush-zones-on-shutdown
-

+

+
+
flush-zones-on-shutdown
+
+

When the nameserver exits due receiving SIGTERM, flush or do not flush any pending zone writes. The default is - flush-zones-on-shutdown no. -

-
has-old-clients
-

+ flush-zones-on-shutdown no. +

+
+
has-old-clients
+
+

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

-
host-statistics
-

+ has-old-clients yes, specify + the two separate options auth-nxdomain yes + and rfc2308-type1 no instead. +

+
+
host-statistics
+
+

In BIND 8, this enables keeping of statistics for every host that the name server interacts with. Not implemented in BIND 9. -

-
maintain-ixfr-base
-

+

+
+
maintain-ixfr-base
+
+

This option is obsolete. It was used in BIND 8 to determine whether a transaction log was kept for Incremental Zone Transfer. BIND 9 maintains a transaction log whenever possible. If you need to disable outgoing incremental zone - transfers, use provide-ixfr no. -

-
minimal-responses
-

+ transfers, use provide-ixfr no. +

+
+
minimal-responses
+
+

If yes, then when generating responses the server will only add records to the authority and additional data sections when they are required (e.g. delegations, negative responses). This may improve the performance of the server. The default is no. -

-
multiple-cnames
-

+

+
+
multiple-cnames
+
+

This option was used in BIND 8 to allow a domain name to have multiple CNAME records in violation of the DNS standards. BIND 9.2 onwards always strictly enforces the CNAME rules both in master files and dynamic updates. -

-
notify
+

+ +
notify
-

+

If yes (the default), DNS NOTIFY messages are sent when a zone the server is authoritative for - changes, see the section called “Notify”. The messages are + changes, see the section called “Notify”. The messages are sent to the servers listed in the zone's NS records (except the master server identified in the SOA MNAME field), and to any servers listed in the - also-notify option. + also-notify option.

-

+

If master-only, notifies are only sent for master zones. If explicit, notifies are sent only to - servers explicitly listed using also-notify. + servers explicitly listed using also-notify. If no, no notifies are sent.

-

- The notify option may also be - specified in the zone +

+ The notify option may also be + specified in the zone statement, - in which case it overrides the options notify statement. + in which case it overrides the options notify statement. It would only be necessary to turn off this option if it caused slaves to crash.

-
-
notify-to-soa
-

+

+
notify-to-soa
+
+

If yes do not check the nameservers in the NS RRset against the SOA MNAME. Normally a NOTIFY message is not sent to the SOA MNAME (SOA ORIGIN) as it is @@ -3396,9 +3642,11 @@ options { hidden master configurations and in that case you would want the ultimate master to still send NOTIFY messages to all the nameservers listed in the NS RRset. -

-
recursion
-

+

+
+
recursion
+
+

If yes, and a DNS query requests recursion, then the server will attempt to do @@ -3408,100 +3656,112 @@ options { return a referral response. The default is yes. - Note that setting recursion no does not prevent + Note that setting recursion no does not prevent clients from getting data from the server's cache; it only prevents new data from being cached as an effect of client queries. Caching may still occur as an effect the server's internal operation, such as NOTIFY address lookups. - See also fetch-glue above. -

-
request-nsid
-

+ See also fetch-glue above. +

+
+
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 resolution. If the authoritative server returns an NSID option in its response, then its contents are logged in - the resolver category at level - info. + the resolver category at level + info. The default is no. -

-
rfc2308-type1
+

+ +
rfc2308-type1
-

+

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

-
+

Note

-

+

Not yet implemented in BIND 9.

-
-
-
use-id-pool
-

+

+ +
use-id-pool
+
+

This option is obsolete. BIND 9 always allocates query IDs from a pool. -

-
use-ixfr
-

+

+
+
use-ixfr
+
+

This option is obsolete. If you need to disable IXFR to a particular server or servers, see - the information on the provide-ixfr option - in the section called “server Statement Definition and + the information on the provide-ixfr option + in the section called “server Statement Definition and Usage”. See also - the section called “Incremental Zone Transfers (IXFR)”. -

-
provide-ixfr
-

+ the section called “Incremental Zone Transfers (IXFR)”. +

+
+
provide-ixfr
+
+

See the description of - provide-ixfr in - the section called “server Statement Definition and + provide-ixfr in + the section called “server Statement Definition and Usage”. -

-
request-ixfr
-

+

+
+
request-ixfr
+
+

See the description of - request-ixfr in - the section called “server Statement Definition and + request-ixfr in + the section called “server Statement Definition and Usage”. -

-
treat-cr-as-space
-

+

+
+
treat-cr-as-space
+
+

This option was used in BIND 8 to make - the server treat carriage return ("\r") characters the same way + the server treat carriage return ("\r") characters the same way as a space or tab character, to facilitate loading of zone files on a UNIX system that were generated - on an NT or DOS machine. In BIND 9, both UNIX "\n" - and NT/DOS "\r\n" newlines + on an NT or DOS machine. In BIND 9, both UNIX "\n" + and NT/DOS "\r\n" newlines are always accepted, and the option is ignored. -

+

+
-additional-from-auth, additional-from-cache +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 @@ -3521,27 +3781,30 @@ options { what would otherwise be provided in the additional section.

-

+ +

For example, if a query asks for an MX record for host foo.example.com, and the record found is "MX 10 mail.example.net", normally the address records (A and AAAA) for mail.example.net will be provided as well, if known, even though they are not in the example.com zone. - Setting these options to no + Setting these options to no disables this behavior and makes 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 + them to no without also specifying - recursion no will cause the + recursion no will cause the server to ignore the options and log a warning message.

-

- Specifying additional-from-cache no actually + +

+ Specifying additional-from-cache no actually disables the use of the cache not only for additional data lookups but also when looking up the answer. This is usually the @@ -3550,7 +3813,8 @@ options { correctness of the cached data is an issue.

-

+ +

When a name server is non-recursively queried for a name that is not below the apex of any served zone, it normally answers with @@ -3561,34 +3825,35 @@ options { upwards referral comes from the cache, the server will not be able to provide upwards - referrals when additional-from-cache no + referrals when additional-from-cache no has been specified. Instead, it will respond to such queries with REFUSED. This should not cause any problems since upwards referrals are not required for the resolution process.

-
-
match-mapped-addresses
+ + +
match-mapped-addresses
-

+

If yes, then an IPv4-mapped IPv6 address will match any address match list entries that match the corresponding IPv4 address.

-

+

This option was introduced to work around a kernel quirk in some operating systems that causes IPv4 TCP connections, such as zone transfers, to be accepted on an IPv6 socket using mapped addresses. This caused address match lists designed for IPv4 to fail to match. However, - named now solves this problem + named now solves this problem internally. The use of this option is discouraged.

-
-
filter-aaaa-on-v4
+ +
filter-aaaa-on-v4
-

+

This option is only available when BIND 9 is compiled with the --enable-filter-aaaa option on the @@ -3597,26 +3862,26 @@ options { to DNS clients unless they have connections to the IPv6 Internet. This is not recommended unless absolutely necessary. The default is no. - The filter-aaaa-on-v4 option - may also be specified in view statements - to override the global filter-aaaa-on-v4 + The filter-aaaa-on-v4 option + may also be specified in view statements + to override the global filter-aaaa-on-v4 option.

-

+

If yes, - the DNS client is at an IPv4 address, in filter-aaaa, + the DNS client is at an IPv4 address, in filter-aaaa, and if the response does not include DNSSEC signatures, then all AAAA records are deleted from the response. This filtering applies to all responses and not only authoritative responses.

-

+

If break-dnssec, then AAAA records are deleted even when dnssec is enabled. As suggested by the name, this makes the response not verify, because the DNSSEC protocol is designed detect deletions.

-

+

This mechanism can erroneously cause other servers to not give AAAA records to their clients. A recursing server with both IPv6 and IPv4 network connections @@ -3624,22 +3889,22 @@ options { via IPv4 will be denied AAAA records even if its client is using IPv6.

-

+

This mechanism is applied to authoritative as well as non-authoritative records. A client using IPv4 that is not allowed recursion can erroneously be given AAAA records because the server is not allowed to check for A records.

-

+

Some AAAA records are given to IPv4 clients in glue records. IPv4 clients that are servers can then erroneously answer requests for AAAA records received via IPv4.

-
-
ixfr-from-differences
+ +
ixfr-from-differences
-

+

When yes and the server loads a new version of a master zone from its zone file or receives a new version of a slave file via zone transfer, it will @@ -3649,7 +3914,7 @@ options { transmitted to downstream slaves as an incremental zone transfer.

-

+

By allowing incremental zone transfers to be used for non-dynamic zones, this option saves bandwidth at the expense of increased CPU and memory consumption at the @@ -3661,80 +3926,84 @@ options { temporarily allocate memory to hold this complete difference set.

-

ixfr-from-differences - also accepts master and - slave at the view and options +

ixfr-from-differences + also accepts master and + slave at the view and options levels which causes - ixfr-from-differences to be enabled for - all master or - slave zones respectively. + ixfr-from-differences to be enabled for + all master or + slave zones respectively. It is off by default.

-
-
multi-master
-

+

+
multi-master
+
+

This should be set when you have multiple masters for a zone and the - addresses refer to different machines. If yes, named will + addresses refer to different machines. If yes, named will not log - when the serial number on the master is less than what named + when the serial number on the master is less than what named currently has. The default is no. -

-
auto-dnssec
+

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

+ auto-dnssec allow; permits keys to be updated and the zone fully re-signed - whenever the user issues the command rndc sign + whenever the user issues the command rndc sign zonename.

-

- auto-dnssec maintain; includes the +

+ auto-dnssec maintain; includes the above, but also automatically adjusts the zone's DNSSEC keys on schedule, according to the keys' timing metadata - (see dnssec-keygen(8) and - dnssec-settime(8)). The command - rndc sign + (see dnssec-keygen(8) and + dnssec-settime(8)). The command + rndc sign zonename causes - named to load keys from the key + named to load keys from the key repository and sign the zone with all keys that are active. - rndc loadkeys + rndc loadkeys zonename causes - named to load keys from the key + named to load keys from the key repository and schedule key maintenance events to occur in the future, but it does not sign the full zone immediately. Note: once keys have been loaded for a zone the first time, the repository will be searched for changes periodically, regardless of whether - rndc loadkeys is used. The recheck + rndc loadkeys is used. The recheck interval is defined by - dnssec-loadkeys-interval.) + dnssec-loadkeys-interval.)

-

- The default setting is auto-dnssec off. +

+ The default setting is auto-dnssec off.

-
-
dnssec-enable
-

+

+
dnssec-enable
+
+

This indicates whether DNSSEC-related resource - records are to be returned by named. + records are to be returned by named. If set to no, - named will not return DNSSEC-related + named will not return DNSSEC-related resource records unless specifically queried for. The default is yes. -

-
dnssec-validation
+

+ +
dnssec-validation
-

- Enable DNSSEC validation in named. - Note dnssec-enable also needs to be +

+ Enable DNSSEC validation in named. + Note dnssec-enable also needs to be set to yes to be effective. If set to no, DNSSEC validation is disabled. If set to auto, @@ -3742,56 +4011,60 @@ options { trust-anchor for the DNS root zone is used. If set to yes, DNSSEC validation is enabled, but a trust anchor must be manually configured using - a trusted-keys or - managed-keys statement. The default + a trusted-keys or + managed-keys statement. The default is yes.

-
+

Note

-

+

Whenever the resolver sends out queries to an EDNS-compliant server, it always sets the DO bit indicating it can support DNSSEC responses even if - dnssec-validation is off. + dnssec-validation is off.

-
-
-
dnssec-accept-expired
-

+

+ +
dnssec-accept-expired
+
+

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

-
querylog
-

- Specify whether query logging should be started when named - starts. - If querylog is not specified, - then the query logging - is determined by the presence of the logging category queries. -

-
check-names
+

+ +
querylog
-

+

+ Specify whether query logging should be started when named + starts. + If querylog is not specified, + then the query logging + is determined by the presence of the logging category queries. +

+
+
check-names
+
+

This option is used to restrict the character set and syntax of certain domain names in master files and/or DNS responses received from the network. The default varies according to usage area. For - master zones the default is fail. - For slave zones the default - is warn. - For answers received from the network (response) - the default is ignore. + master zones the default is fail. + For slave zones the default + is warn. + 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. @@ -3799,48 +4072,54 @@ options { name indicated that it is a reverse lookup of a hostname (the owner name ends in IN-ADDR.ARPA, IP6.ARPA, or IP6.INT).

-
-
check-dup-records
-

+

+
check-dup-records
+
+

Check master zones for records that are treated as different by DNSSEC but are semantically equal in plain DNS. The - default is to warn. Other possible - values are fail and - ignore. -

-
check-mx
-

+ default is to warn. Other possible + values are fail and + ignore. +

+
+
check-mx
+
+

Check whether the MX record appears to refer to a IP address. - The default is to warn. Other possible - values are fail and - ignore. -

-
check-wildcard
-

+ 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 to understand the wildcard matching algorithm (RFC 1034). This option - affects master zones. The default (yes) is to check + affects master zones. The default (yes) is to check for non-terminal wildcards and issue a warning. -

-
check-integrity
+

+ +
check-integrity
-

+

Perform post load zone integrity checks on master zones. This checks that MX and SRV records refer to address (A or AAAA) records and that glue address records exist for delegated zones. For MX and SRV records only in-zone hostnames are checked (for out-of-zone hostnames use - named-checkzone). + named-checkzone). For NS records only names below top of zone are checked (for out-of-zone names and glue consistency - checks use named-checkzone). - The default is yes. + checks use named-checkzone). + The default is yes.

-

+

The use of the SPF record for publishing Sender Policy Framework is deprecated as the migration from using TXT records to SPF records was abandoned. @@ -3848,55 +4127,67 @@ options { Policy Framework record exists (starts with "v=spf1") if there is an SPF record. Warnings are emitted if the TXT record does not exist and can be suppressed with - check-spf. + check-spf.

-
-
check-mx-cname
-

- If check-integrity is set then +

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

+ to CNAMES. The default is to warn. +

+
+
check-sibling
+
+

When performing integrity checks, also check that - sibling glue exists. The default is yes. -

-
check-spf
-

- If check-integrity is set then + sibling glue exists. The default is yes. +

+
+
check-spf
+
+

+ If check-integrity is set then check that there is a TXT Sender Policy Framework record present (starts with "v=spf1") if there is an SPF record present. The default is - warn. -

-
zero-no-soa-ttl
-

+ warn. +

+
+
zero-no-soa-ttl
+
+

When returning authoritative negative responses to SOA queries set the TTL of the SOA record returned in the authority section to zero. - The default is yes. -

-
zero-no-soa-ttl-cache
-

+ The default is yes. +

+
+
zero-no-soa-ttl-cache
+
+

When caching a negative response to a SOA query set the TTL to zero. - The default is no. -

-
update-check-ksk
+ 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 @@ -3904,10 +4195,10 @@ options { However, if this option is set to no, then the KSK bit is ignored; KSKs are treated as if they were ZSKs and are used to sign the entire zone. This is - similar to the dnssec-signzone -z + 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 @@ -3915,62 +4206,67 @@ options { this requirement is not met, this option will be ignored for that algorithm.

-
-
dnssec-dnskey-kskonly
+ +
dnssec-dnskey-kskonly
-

- When this option and update-check-ksk +

+ When this option and update-check-ksk are both set to yes, only key-signing keys (that is, keys with the KSK bit set) will be used to sign the DNSKEY RRset at the zone apex. Zone-signing keys (keys without the KSK bit set) will be used to sign the remainder of the zone, but not the DNSKEY RRset. This is similar to the - dnssec-signzone -x command line option. + dnssec-signzone -x command line option.

-

- The default is no. If - update-check-ksk is set to +

+ The default is no. If + update-check-ksk is set to no, this option is ignored.

-
-
try-tcp-refresh
-

+

+
try-tcp-refresh
+
+

Try to refresh the zone using TCP if UDP queries fail. For BIND 8 compatibility, the default is - yes. -

-
dnssec-secure-to-insecure
+ yes. +

+ +
dnssec-secure-to-insecure
-

+

Allow a dynamic zone to transition from secure to insecure (i.e., signed to unsigned) by deleting all - of the DNSKEY records. The default is no. - If set to yes, and if the DNSKEY RRset + of the DNSKEY records. The default is no. + If set to yes, and if the DNSKEY RRset at the zone apex is deleted, all RRSIG and NSEC records will be removed from the zone as well.

-

+

If the zone uses NSEC3, then it is also necessary to delete the NSEC3PARAM RRset from the zone apex; this will cause the removal of all corresponding NSEC3 records. (It is expected that this requirement will be eliminated in a future release.)

-

+

Note that if a zone has been configured with - auto-dnssec maintain and the + 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. + next time named is started.

-
+ - -
+ +
+ +

-Forwarding

-

+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 @@ -3980,9 +4276,11 @@ options { the server is not authoritative and does not have the answer in its cache.

-
-
forward
-

+ +

+
forward
+
+

This option is only meaningful if the forwarders list is not empty. A value of first, the default, causes the server to query the forwarders @@ -3992,173 +4290,197 @@ options { the answer itself. If only is specified, the server will only query the forwarders. -

-
forwarders
-

+

+
+
forwarders
+
+

Specifies the IP addresses to be used for forwarding. The default is the empty list (no forwarding). -

+

+
-

+ +

Forwarding can also be configured on a per-domain basis, allowing for the global forwarding options to be overridden in a variety of ways. You can set particular domains to use different forwarders, - or have a different forward only/first behavior, - or not forward at all, see the section called “zone + or have a different forward only/first behavior, + or not forward at all, see the section called “zone Statement Grammar”.

- -
+
+ +

-Dual-stack Servers

-

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

+ +

+
dual-stack-servers
+
+

Specifies host names or addresses of machines with access to both IPv4 and IPv6 transports. If a hostname is used, the server must be able to resolve the name using only the transport it has. If the machine is dual - stacked, then the dual-stack-servers have no effect unless + stacked, then the dual-stack-servers have no effect unless access to a transport has been disabled on the command line - (e.g. named -4). -

+ (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 + of the requesting system. See the section called “Address Match Lists” for details on how to specify IP address lists.

-
-
allow-notify
-

+ +

+
allow-notify
+
+

Specifies which hosts are allowed to notify this server, a slave, of zone changes in addition to the zone masters. - allow-notify may also be + allow-notify may also be specified in the - zone statement, in which case + zone statement, in which case it overrides the - options allow-notify + options allow-notify statement. It is only meaningful for a slave zone. If not specified, the default is to process notify messages only from a zone's master. -

-
allow-query
+

+
+
allow-query
-

+

Specifies which hosts are allowed to ask ordinary - DNS questions. allow-query may - also be specified in the zone + DNS questions. allow-query may + also be specified in the zone statement, in which case it overrides the - options allow-query statement. + options allow-query statement. If not specified, the default is to allow queries from all hosts.

-
+

Note

-

- allow-query-cache is now +

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

-
-
-
allow-query-on
+
+ +
allow-query-on
-

+

Specifies which local addresses can accept ordinary DNS questions. This makes it possible, for instance, to allow queries on internal-facing interfaces but disallow them on external-facing ones, without necessarily knowing the internal network's addresses.

-

- Note that allow-query-on is only +

+ Note that allow-query-on is only checked for queries that are permitted by - allow-query. A query must be + allow-query. A query must be allowed by both ACLs, or it will be refused.

-

- allow-query-on may - also be specified in the zone +

+ allow-query-on may + also be specified in the zone statement, in which case it overrides the - options allow-query-on statement. + options allow-query-on statement.

-

+

If not specified, the default is to allow queries on all addresses.

-
+

Note

-

- allow-query-cache is +

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

-
-
-
allow-query-cache
-

+

+ +
allow-query-cache
+
+

Specifies which hosts are allowed to get answers - from the cache. If allow-query-cache - is not set then allow-recursion - is used if set, otherwise allow-query - is used if set unless recursion no; is - set in which case none; is used, - otherwise the default (localnets; - localhost;) is used. -

-
allow-query-cache-on
-

+ from the cache. If allow-query-cache + is not set then allow-recursion + is used if set, otherwise allow-query + is used if set unless recursion no; is + set in which case none; is used, + otherwise the default (localnets; + localhost;) is used. +

+
+
allow-query-cache-on
+
+

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

-
allow-recursion
-

+ localnets and + localhost. +

+
+
allow-recursion
+
+

Specifies which hosts are allowed to make recursive queries through this server. If - allow-recursion is not set - then allow-query-cache is - used if set, otherwise allow-query + allow-recursion is not set + then allow-query-cache is + used if set, otherwise allow-query is used if set, otherwise the default - (localnets; - localhost;) is used. -

-
allow-recursion-on
-

+ (localnets; + localhost;) is used. +

+
+
allow-recursion-on
+
+

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

-
allow-update
-

+

+
+
allow-update
+
+

Specifies which hosts are allowed to submit Dynamic DNS updates for master zones. The default is to deny updates from all hosts. Note that allowing updates based on the requestor's IP address is insecure; see - the section called “Dynamic Update Security” for details. -

-
allow-update-forwarding
+ the section called “Dynamic Update Security” for details. +

+ +
allow-update-forwarding
-

+

Specifies which hosts are allowed to submit Dynamic DNS updates to slave zones to be forwarded to the @@ -4175,17 +4497,18 @@ options { with the master server, not the slaves.

-

+

Note that enabling the update forwarding feature on a slave server may expose master servers relying on insecure IP address based - access control to attacks; see the section called “Dynamic Update Security” + access control to attacks; see the section called “Dynamic Update Security” for more details.

-
-
allow-v6-synthesis
-

+

+
allow-v6-synthesis
+
+

This option was introduced for the smooth transition from AAAA to A6 and from "nibble labels" to binary labels. @@ -4193,50 +4516,57 @@ options { deprecated, this option was also deprecated. It is now ignored with some warning messages. -

-
allow-transfer
-

+

+
+
allow-transfer
+
+

Specifies which hosts are allowed to - receive zone transfers from the server. allow-transfer may - also be specified in the zone + receive zone transfers from the server. allow-transfer may + also be specified in the zone statement, in which - case it overrides the options allow-transfer statement. + case it overrides the options allow-transfer statement. If not specified, the default is to allow transfers to all hosts. -

-
blackhole
-

+

+
+
blackhole
+
+

Specifies a list of addresses that the server will not accept queries from or use to resolve a query. Queries from these addresses will not be responded to. The default is none. -

-
filter-aaaa
-

- Specifies a list of addresses to which - filter-aaaa-on-v4 - is applies. The default is any. -

-
no-case-compress
+

+ +
filter-aaaa
-

+

+ Specifies a list of addresses to which + filter-aaaa-on-v4 + is applies. The default is any. +

+
+
no-case-compress
+
+

Specifies a list of addresses which require responses to use case-insensitive compression. This ACL can be - used when named needs to work with + used when named needs to work with clients that do not comply with the requirement in RFC 1034 to use case-insensitive name comparisons when checking for matching domain names.

-

+

If left undefined, the ACL defaults to - none: case-insensitive compression + none: case-insensitive compression will be used for all clients. If the ACL is defined and matches a client, then case will be ignored when compressing domain names in DNS responses sent to that client.

-

+

This can result in slightly smaller responses: if a response contains the names "example.com" and "example.COM", case-insensitive compression would treat @@ -4248,13 +4578,13 @@ 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 +

+ There are circumstances in which named will not preserve the case of owner names of records: if a zone file defines records of different types with the same name, but the capitalization of the name is @@ -4268,59 +4598,69 @@ options { have their case preserved unless the client matches this ACL.

-
-
resolver-query-timeout
-

+

+
resolver-query-timeout
+
+

The amount of time the resolver will spend attempting to resolve a recursive query before failing. The default and minimum is 10 and the maximum is 30. Setting it to 0 will result in the default being used. -

+

+ - -
+ +
+ +

-Interfaces

-

+Interfaces

+ +

The interfaces and ports that the server will answer queries - from may be specified using the listen-on option. listen-on takes + from may be specified using the listen-on option. listen-on takes an optional port and an address_match_list of IPv4 addresses. (IPv6 addresses are ignored, with a logged warning.) The server will listen on all interfaces allowed by the address match list. If a port is not specified, port 53 will be used.

-

- Multiple listen-on statements are +

+ Multiple listen-on statements are allowed. For example,

+
listen-on { 5.6.7.8; };
 listen-on port 1234 { !1.2.3.4; 1.2/16; };
 
-

+ +

will enable the name server on port 53 for the IP address 5.6.7.8, and on port 1234 of an address on the machine in net 1.2 that is not 1.2.3.4.

-

- If no listen-on is specified, the + +

+ If no listen-on is specified, the server will listen on port 53 on all IPv4 interfaces.

-

- The listen-on-v6 option is used to + +

+ The listen-on-v6 option is used to specify the interfaces and the ports on which the server will listen for incoming queries sent using IPv6.

-

+ +

When

{ any; }

is specified as the address_match_list for the - listen-on-v6 option, + listen-on-v6 option, the server does not bind a separate socket to each IPv6 interface address as it does for IPv4 if the operating system has enough API support for IPv6 (specifically if it conforms to RFC 3493 and RFC @@ -4329,107 +4669,123 @@ 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 address, regardless of whether the desired API is supported by the system. - IPv4 addresses specified in listen-on-v6 + IPv4 addresses specified in listen-on-v6 will be ignored, with a logged warning.

-

- Multiple listen-on-v6 options can + +

+ Multiple listen-on-v6 options can be used. For example,

+
listen-on-v6 { any; };
 listen-on-v6 port 1234 { !2001:db8::/32; any; };
 
-

+ +

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

-

+ +

To make the server not listen on any IPv6 address, use

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

- If no listen-on-v6 option is + +

+ If no listen-on-v6 option is specified, the server will not listen on any IPv6 address - unless -6 is specified when named is - invoked. If -6 is specified then - named will listen on port 53 on all IPv6 interfaces by default. + unless -6 is specified when named is + invoked. If -6 is specified then + named will listen on port 53 on all IPv6 interfaces by default.

- -
+
+ +

Query Address

-

+ +

If the server doesn't know the answer to a question, it will - query other name servers. query-source specifies + query other name servers. query-source specifies the address and port used for such queries. For queries sent over - IPv6, there is a separate query-source-v6 option. - If address is * (asterisk) or is omitted, - a wildcard IP address (INADDR_ANY) + IPv6, there is a separate query-source-v6 option. + If address is * (asterisk) or is omitted, + a wildcard IP address (INADDR_ANY) will be used.

-

- If port is * or is omitted, + +

+ If port is * or is omitted, a random port number from a pre-configured range is picked up and will be used for each query. The port range(s) is that specified in - the use-v4-udp-ports (for IPv4) - and use-v6-udp-ports (for IPv6) + the use-v4-udp-ports (for IPv4) + and use-v6-udp-ports (for IPv6) options, excluding the ranges specified in - the avoid-v4-udp-ports - and avoid-v6-udp-ports options, respectively. + the avoid-v4-udp-ports + and avoid-v6-udp-ports options, respectively.

-

- The defaults of the query-source and - query-source-v6 options + +

+ The defaults of the query-source and + query-source-v6 options are:

+
query-source address * port *;
 query-source-v6 address * port *;
 
-

- If use-v4-udp-ports or - use-v6-udp-ports is unspecified, - named will check if the operating + +

+ If use-v4-udp-ports or + use-v6-udp-ports is unspecified, + named will check if the operating system provides a programming interface to retrieve the system's default range for ephemeral ports. If such an interface is available, - named will use the corresponding system + named will use the corresponding system default range; otherwise, it will use its own defaults:

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

+ +

Note: make sure the ranges be sufficiently large for security. A desirable size depends on various parameters, but we generally recommend it contain at least 16384 ports (14 bits of entropy). Note also that the system's default range when used may be too small for this purpose, and that the range may even be - changed while named is running; the new - range will automatically be applied when named + changed while named is running; the new + range will automatically be applied when named is reloaded. It is encouraged to - configure use-v4-udp-ports and - use-v6-udp-ports explicitly so that the + configure use-v4-udp-ports and + use-v6-udp-ports explicitly so that the 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 + where named runs may prohibit the use of some ports. For example, UNIX systems will not allow - named running without a root privilege + named running without a root privilege to use ports less than 1024. If such ports are included in the specified (or detected) set of query ports, the corresponding query attempts will @@ -4437,77 +4793,90 @@ 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 + +

+ 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 + the use-queryport-pool option to support a pool of such random ports, but this option is now obsolete because reusing the same ports in the pool may not be sufficiently secure. For the same reason, it is generally strongly discouraged to specify a particular port for the - query-source or - query-source-v6 options; + query-source or + query-source-v6 options; it implicitly disables the use of randomized port numbers.

-
-
use-queryport-pool
-

+ +

+
use-queryport-pool
+
+

This option is obsolete. -

-
queryport-pool-ports
-

+

+
+
queryport-pool-ports
+
+

This option is obsolete. -

-
queryport-pool-updateinterval
-

+

+
+
queryport-pool-updateinterval
+
+

This option is obsolete. -

+

+
-
+

Note

-

- The address specified in the query-source option +

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

+ 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
+ +
+
also-notify
-

+

Defines a global list of IP addresses of name servers that are also sent NOTIFY messages whenever a fresh copy of the @@ -4516,146 +4885,166 @@ avoid-v6-udp-ports {}; This helps to ensure that copies of the zones will quickly converge on stealth servers. Optionally, a port may be specified with each - also-notify address to send + also-notify address to send the notify messages to a port other than the default of 53. An optional TSIG key can also be specified with each address to cause the notify messages to be signed; this can be useful when sending notifies to multiple views. In place of explicit addresses, one or more named - masters lists can be used. + masters lists can be used.

-

- If an also-notify list - is given in a zone statement, +

+ If an also-notify list + is given in a zone statement, it will override - the options also-notify - statement. When a zone notify + the options also-notify + statement. When a zone notify statement - is set to no, the IP - addresses in the global also-notify list will + is set to no, the IP + addresses in the global also-notify list will not be sent NOTIFY messages for that zone. The default is the empty list (no global notification list).

-
-
max-transfer-time-in
-

+

+
max-transfer-time-in
+
+

Inbound zone transfers running longer than this many minutes will be terminated. The default is 120 minutes (2 hours). The maximum value is 28 days (40320 minutes). -

-
max-transfer-idle-in
-

+

+
+
max-transfer-idle-in
+
+

Inbound zone transfers making no progress in this many minutes will be terminated. The default is 60 minutes (1 hour). The maximum value is 28 days (40320 minutes). -

-
max-transfer-time-out
-

+

+
+
max-transfer-time-out
+
+

Outbound zone transfers running longer than this many minutes will be terminated. The default is 120 minutes (2 hours). The maximum value is 28 days (40320 minutes). -

-
max-transfer-idle-out
-

+

+
+
max-transfer-idle-out
+
+

Outbound zone transfers making no progress in this many minutes will be terminated. The default is 60 minutes (1 hour). The maximum value is 28 days (40320 minutes). -

-
serial-query-rate
+

+ +
serial-query-rate
-

+

Slave servers will periodically query master servers to find out if zone serial numbers have changed. Each such query uses a minute amount of the slave server's network bandwidth. To limit the amount of bandwidth used, BIND 9 limits the rate at which queries are sent. The value of the - serial-query-rate option, an + serial-query-rate option, an integer, is the maximum number of queries sent per second. The default is 20 per second. The lowest possible rate is one per second; when set to zero, it will be silently raised to one.

-

+

In addition to controlling the rate SOA refresh queries are issued at, - serial-query-rate also controls + serial-query-rate also controls the rate at which NOTIFY messages are sent from both master and slave zones.

-
-
serial-queries
-

- In BIND 8, the serial-queries +

+
serial-queries
+
+

+ In BIND 8, the serial-queries option set the maximum number of concurrent serial number queries allowed to be outstanding at any given time. BIND 9 does not limit the number of outstanding - serial queries and ignores the serial-queries option. + 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
-

+ as defined using the serial-query-rate option. +

+
+
transfer-format
+
+ +

Zone transfers can be sent using two different formats, - one-answer and - many-answers. - The transfer-format option is used + one-answer and + many-answers. + The transfer-format option is used on the master server to determine which format it sends. - one-answer uses one DNS message per + one-answer uses one DNS message per resource record transferred. - many-answers packs as many resource + many-answers packs as many resource records as possible into a message. - many-answers is more efficient, but is + many-answers is more efficient, but is only supported by relatively new slave servers, such as BIND 9, BIND 8.x and BIND 4.9.5 onwards. - The many-answers format is also supported by + The many-answers format is also supported by recent Microsoft Windows nameservers. - The default is many-answers. - transfer-format may be overridden on a - per-server basis by using the server + The default is many-answers. + transfer-format may be overridden on a + per-server basis by using the server statement. -

-
transfers-in
-

+

+ +
+
transfers-in
+
+

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

-
transfers-out
-

+

+
+
transfers-out
+
+

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

-
transfers-per-ns
-

+

+
+
transfers-per-ns
+
+

The maximum number of inbound zone transfers that can be concurrently transferring from a given remote name server. The default value is 2. - Increasing transfers-per-ns + Increasing transfers-per-ns may speed up the convergence of slave zones, but it also may increase - 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
+ the load on the remote name server. transfers-per-ns may + be overridden on a per-server basis by using the transfers phrase + of the server statement. +

+ +
transfer-source
-

transfer-source +

transfer-source determines which local address will be bound to IPv4 TCP connections used to fetch zones transferred inbound by the server. It also determines the @@ -4665,122 +5054,136 @@ avoid-v6-udp-ports {}; controlled value which will usually be the address of the interface "closest to" the remote end. This address must appear in the remote end's - allow-transfer option for the + allow-transfer option for the zone being transferred, if one is specified. This statement sets the - transfer-source for all zones, + transfer-source for all zones, but can be overridden on a per-view or per-zone basis by including a - transfer-source statement within - the view or - zone block in the configuration + transfer-source statement within + the view or + zone block in the configuration file.

-
+

Note

-

+

Solaris 2.5.1 and earlier does not support setting the source address for TCP sockets.

-
-
-
transfer-source-v6
-

- The same as transfer-source, - except zone transfers are performed using IPv6. -

-
alt-transfer-source
+
+ +
transfer-source-v6
-

+

+ The same as transfer-source, + except zone transfers are performed using IPv6. +

+
+
alt-transfer-source
+
+

An alternate transfer source if the one listed in - transfer-source fails and - use-alt-transfer-source is + transfer-source fails and + use-alt-transfer-source is set.

-
+

Note

If you do not wish the alternate transfer source to be used, you should set - use-alt-transfer-source + use-alt-transfer-source appropriately and you should not depend upon getting an answer back to the first refresh query.
-
-
alt-transfer-source-v6
-

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

-
use-alt-transfer-source
-

- Use the alternate transfer sources or not. If views are - specified this defaults to no - otherwise it defaults to - yes (for BIND 8 - compatibility). -

-
notify-source
+ +
alt-transfer-source-v6
-

notify-source +

+ An alternate transfer source if the one listed in + transfer-source-v6 fails and + use-alt-transfer-source is + set. +

+
+
use-alt-transfer-source
+
+

+ Use the alternate transfer sources or not. If views are + specified this defaults to no + otherwise it defaults to + yes (for BIND 8 + compatibility). +

+
+
notify-source
+
+

notify-source determines which local source address, and optionally UDP port, will be used to send NOTIFY messages. This address must appear in the slave - server's masters zone clause or - in an allow-notify clause. This - statement sets the notify-source + server's masters zone clause or + in an allow-notify clause. This + statement sets the notify-source for all zones, but can be overridden on a per-zone or per-view basis by including a - notify-source statement within - the zone or - view block in the configuration + notify-source statement within + the zone or + view block in the configuration file.

-
+

Note

-

+

Solaris 2.5.1 and earlier does not support setting the source address for TCP sockets.

-
-
-
notify-source-v6
-

- Like notify-source, +

+ +
notify-source-v6
+
+

+ Like notify-source, but applies to notify messages sent to IPv6 addresses. -

+

+
- -
+ +
+ +

-UDP Port Lists

-

- use-v4-udp-ports, - avoid-v4-udp-ports, - use-v6-udp-ports, and - avoid-v6-udp-ports +UDP Port Lists

+ +

+ use-v4-udp-ports, + avoid-v4-udp-ports, + use-v6-udp-ports, and + avoid-v6-udp-ports specify a list of IPv4 and IPv6 UDP ports that will be used or not used as source ports for UDP messages. - See the section called “Query Address” about how the + See the section called “Query Address” about how the available ports are determined. For example, with the following configuration

+
 use-v6-udp-ports { range 32768 65535; };
 avoid-v6-udp-ports { 40000; range 50000 60000; };
 
-

+ +

UDP ports of IPv6 messages sent - from named will be in one + from named will be in one of the following ranges: 32768 to 39999, 40001 to 49999, and 60001 to 65535.

-

- avoid-v4-udp-ports and - avoid-v6-udp-ports can be used - to prevent named from choosing as its random source port a + +

+ avoid-v4-udp-ports and + avoid-v6-udp-ports can be used + to prevent named from choosing as its random source port a port that is blocked by your firewall or a port that is used by other applications; if a query went out with a source port blocked by a @@ -4788,30 +5191,34 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; answer would not get by the firewall and the name server would have to query again. Note: the desired range can also be represented only with - use-v4-udp-ports and - use-v6-udp-ports, and the - avoid- options are redundant in that + use-v4-udp-ports and + use-v6-udp-ports, and the + avoid- options are redundant in that sense; they are provided for backward compatibility and to possibly simplify the port specification.

- -
+
+ +

-Operating System Resource Limits

-

+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 - 1073741824 to specify a limit of + example, 1G can be used instead of + 1073741824 to specify a limit of one - gigabyte. unlimited requests + gigabyte. unlimited requests unlimited use, or the - maximum available amount. default + maximum available amount. default uses the limit that was in force when the server was started. See the description - of size_spec in the section called “Configuration File Elements”. + of size_spec in the section called “Configuration File Elements”.

-

+ +

The following options set operating system resource limits for the name server process. Some operating systems don't support some or @@ -4819,14 +5226,18 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; the unsupported limit is used.

-
-
coresize
-

+ +

+
coresize
+
+

The maximum size of a core dump. The default is default. -

-
datasize
-

+

+
+
datasize
+
+

The maximum amount of data memory the server may use. The default is default. This is a hard limit on server memory usage. @@ -4838,42 +5249,55 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; to raise an operating system data size limit that is too small by default. If you wish to limit the amount of memory used by the server, use the - max-cache-size and - recursive-clients + max-cache-size and + recursive-clients options instead. -

-
files
-

+

+
+
files
+
+

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

-
stacksize
-

+

+
+
stacksize
+
+

The maximum amount of stack memory the server may use. The default is default. -

+

+
- -
+ +
+ +

Server Resource Limits

-

+ + +

The following options set limits on the server's resource consumption that are enforced internally by the server rather than the operating system.

-
-
max-ixfr-log-size
-

+ +

+
max-ixfr-log-size
+
+

This option is obsolete; it is accepted and ignored for BIND 8 compatibility. The option - max-journal-size performs a + max-journal-size performs a similar function in BIND 9. -

-
max-journal-size
-

+

+
+
max-journal-size
+
+

Sets a maximum size for each journal file - (see the section called “The journal file”). When the journal file + (see the section called “The journal file”). When the journal file approaches the specified size, some of the oldest transactions in the journal @@ -4882,16 +5306,19 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; unlimited, which also means 2 gigabytes. This may also be set on a per-zone basis. -

-
host-statistics-max
-

+

+
+
host-statistics-max
+
+

In BIND 8, specifies the maximum number of host statistics entries to be kept. Not implemented in BIND 9. -

-
recursive-clients
+

+
+
recursive-clients
-

+

The maximum number ("hard quota") of simultaneous recursive lookups the server will perform on behalf of clients. The default is @@ -4899,17 +5326,17 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; client uses a fair bit of memory (on the order of 20 kilobytes), the value of the - recursive-clients option may + recursive-clients option may have to be decreased on hosts with limited memory.

-

+

recursive-clients defines a "hard quota" limit for pending recursive clients: when more clients than this are pending, new incoming requests will not be accepted, and for each incoming request a previous pending request will also be dropped.

-

+

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

-
-
tcp-clients
-

+

+
tcp-clients
+
+

The maximum number of simultaneous client TCP connections that the server will accept. The default is 100. -

+

+
-clients-per-query, max-clients-per-query +clients-per-query, max-clients-per-query
-

These set the +

These set the initial value (minimum) and maximum number of recursive simultaneous clients for any given query (<qname,qtype,qclass>) that the server will accept - before dropping additional clients. named will attempt to + before dropping additional clients. named will attempt to self tune this value and changes will be logged. The default values are 10 and 100.

-

+

This value should reflect how many queries come in for a given name in the time it takes to resolve that name. - If the number of queries exceed this value, named will + If the number of queries exceed this value, named will assume that it is dealing with a non-responsive zone and will drop additional queries. If it gets a response after dropping queries, it will raise the estimate. The estimate will then be lowered in 20 minutes if it has remained unchanged.

-

- If clients-per-query is set to zero, +

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

-

- If max-clients-per-query is set to zero, +

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

-
+
-fetches-per-zone +fetches-per-zone
-

+

The maximum number of simultaneous iterative queries to any one domain that the server will permit before blocking new queries for data @@ -4973,7 +5402,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; would take to resolve them. It should be smaller than recursive-clients.

-

+

When many clients simultaneously query for the same name and type, the clients will all be attached to the same fetch, up to the @@ -4985,7 +5414,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 @@ -4993,14 +5422,14 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; or answered with SERVFAIL. The default is drop.

-

- If fetches-per-zone is set to zero, +

+ If fetches-per-zone is set to zero, then there is no limit on the number of fetches per query and no queries will be dropped. The default is zero.

-

+

The current list of active fetches can be dumped by - running rndc recursing. The list + running rndc recursing. The list includes the number of active fetches for each domain and the number of queries that have been passed or dropped as a result of the @@ -5011,16 +5440,16 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; next time a fetch is sent to that domain, it is recreated with the counters set to zero.)

-

+

(Note: This option is only available when BIND is - built with configure --enable-fetchlimit.) + built with configure --enable-fetchlimit.)

-
+
-fetches-per-server +fetches-per-server
-

+

The maximum number of simultaneous iterative queries that the server will allow to be sent to a single upstream name server before blocking @@ -5030,7 +5459,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; would take to resolve them. It should be smaller than recursive-clients.

-

+

Optionally, this value may be followed by the keyword drop or fail, indicating whether queries will be dropped with no @@ -5039,40 +5468,40 @@ 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, +

+ If fetches-per-server is set to zero, then there is no limit on the number of fetches per query and no queries will be dropped. The default is zero.

-

- The fetches-per-server quota is +

+ The fetches-per-server quota is dynamically adjusted in response to detected congestion. As queries are sent to a server and are either answered or time out, an exponentially weighted moving average is calculated of the ratio of timeouts to responses. If the current average timeout ratio rises above a "high" - threshold, then fetches-per-server + threshold, then fetches-per-server is reduced for that server. If the timeout ratio drops below a "low" threshold, then - fetches-per-server is increased. - The fetch-quota-params options + fetches-per-server is increased. + The fetch-quota-params options can be used to adjust the parameters for this calculation.

-

+

(Note: This option is only available when BIND is - built with configure --enable-fetchlimit.) + built with configure --enable-fetchlimit.)

-
-
fetch-quota-params
+ +
fetch-quota-params
-

+

Sets the parameters to use for dynamic resizing of the fetches-per-server quota in response to detected congestion.

-

+

The first argument is an integer value indicating how frequently to recalculate the moving average of the ratio of timeouts to responses for each @@ -5080,7 +5509,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 @@ -5095,29 +5524,30 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; precision of 1/100: at most two places after the decimal point are significant.

-

+

(Note: This option is only available when BIND is - built with configure --enable-fetchlimit.) + built with configure --enable-fetchlimit.)

-
-
reserved-sockets
+ +
reserved-sockets
-

+

The number of file descriptors reserved for TCP, stdio, etc. This needs to be big enough to cover the number of - interfaces named listens on, tcp-clients as well as + interfaces named listens on, tcp-clients as well as to provide room for outgoing TCP queries and incoming zone transfers. The default is 512. The minimum value is 128 and the maximum value is 128 less than maxsockets (-S). This option may be removed in the future.

-

+

This option has little effect on Windows.

-
-
max-cache-size
-

+

+
max-cache-size
+
+

The maximum amount of memory to use for the server's cache, in bytes. When the amount of data in the cache @@ -5137,9 +5567,11 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; In a server with multiple views, the limit applies separately to the cache of each view. The default is 0. -

-
tcp-listen-queue
-

+

+
+
tcp-listen-queue
+
+

The listen queue depth. The default and minimum is 10. If the kernel supports the accept filter "dataready" this also controls how @@ -5149,38 +5581,48 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; less than 10 will be silently raised. A value of 0 may also be used; on most platforms this sets the listen queue length to a system-defined default value. -

+

+
-
-
+ +
+ +

-Periodic Task Intervals

-
-
cleaning-interval
-

+Periodic Task Intervals

+ + +
+
cleaning-interval
+
+

This interval is effectively obsolete. Previously, the server would remove expired resource records - from the cache every cleaning-interval minutes. + from the cache every cleaning-interval minutes. BIND 9 now manages cache memory in a more sophisticated manner and does not rely on the periodic cleaning any more. Specifying this option therefore has no effect on the server's behavior. -

-
heartbeat-interval
-

+

+
+
heartbeat-interval
+
+

The server will perform zone maintenance tasks - for all zones marked as dialup whenever this + for all zones marked as dialup whenever this interval expires. The default is 60 minutes. Reasonable values are up to 1 day (1440 minutes). The maximum value is 28 days (40320 minutes). If set to 0, no zone maintenance for these zones will occur. -

-
interface-interval
-

+

+
+
interface-interval
+
+

The server will scan the network interface list - every interface-interval + every interface-interval minutes. The default is 60 minutes. The maximum value is 28 days (40320 minutes). If set to 0, interface scanning will only occur when @@ -5188,38 +5630,43 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; server will begin listening for queries on any newly discovered interfaces (provided they are allowed by the - listen-on configuration), and + listen-on configuration), and will stop listening on interfaces that have gone away. -

-
statistics-interval
+

+ +
statistics-interval
-

+

Name server statistics will be logged - every statistics-interval + every statistics-interval minutes. The default is 60. The maximum value is 28 days (40320 minutes). If set to 0, no statistics will be logged.

Note

-

+

Not yet implemented in BIND 9.

-
-
+
+ - -
+ +
+ +

Topology

-

+ + +

All other things being equal, when the server chooses a name server to query from a list of name servers, it prefers the one that is - topologically closest to itself. The topology statement - takes an address_match_list and + topologically closest to itself. The topology statement + takes an address_match_list and interprets it in a special way. Each top-level list element is assigned a distance. @@ -5231,40 +5678,48 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; any non-negated list element, and closer than any negated element. For example,

+
topology {
     10/8;
     !1.2.3/24;
     { 1.2/16; 3/8; };
 };
-

+ +

will prefer servers on network 10 the most, followed by hosts on network 1.2.0.0 (netmask 255.255.0.0) and network 3, with the exception of hosts on network 1.2.3 (netmask 255.255.255.0), which is preferred least of all.

-

+

The default topology is

+
    topology { localhost; localnets; };
 
-
+ +

Note

-

- The topology option +

+ The topology option is not implemented in BIND 9.

-
-
-
+
+
+ +

-The sortlist Statement

-

+The sortlist Statement

+ + + +

The response to a DNS query may consist of multiple resource records (RRs) forming a resource records set (RRset). The name server will normally return the RRs within the RRset in an indeterminate order - (but see the rrset-order - statement in the section called “RRset Ordering”). + (but see the rrset-order + statement in the section called “RRset Ordering”). The client resolver code should rearrange the RRs as appropriate, that is, using any addresses on the local net in preference to other addresses. @@ -5274,23 +5729,24 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; in the server, based on the client's address. This only requires configuring the name servers, not all the clients.

-

- The sortlist statement (see below) + +

+ The sortlist statement (see below) takes - an address_match_list and + an address_match_list and interprets it even - more specifically than the topology + more specifically than the topology statement - does (the section called “Topology”). - Each top level statement in the sortlist must - itself be an explicit address_match_list with + does (the section called “Topology”). + Each top level statement in the sortlist must + itself be an explicit address_match_list with one or two elements. The first element (which may be an IP address, - an IP prefix, an ACL name or a nested address_match_list) + an IP prefix, an ACL name or a nested address_match_list) of each top level list is checked against the source address of the query until a match is found.

-

+

Once the source address of the query has been matched, if the top level statement contains only one element, the actual primitive @@ -5298,14 +5754,14 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; address in the response to move to the beginning of the response. If the statement is a list of two elements, then the second element is - treated the same as the address_match_list in - a topology statement. Each top + treated the same as the address_match_list in + a topology statement. Each top level element is assigned a distance and the 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 will get responses preferring addresses @@ -5323,6 +5779,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; or the 192.168.5/24 network will only prefer other addresses on their directly connected networks.

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

+ +

The following example will give reasonable behavior for the local host and hosts on directly connected networks. It is similar to the behavior of the address sort in BIND 4.9.x. Responses sent @@ -5358,52 +5816,57 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; Responses to other queries will not be sorted.

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

RRset Ordering

-

+ +

When multiple records are returned in an answer it may be useful to configure the order of the records placed into the response. - The rrset-order statement permits + The rrset-order statement permits configuration of the ordering of the records in a multiple record response. - See also the sortlist statement, - the section called “The sortlist Statement”. + See also the sortlist statement, + the section called “The sortlist Statement”.

-

- An order_spec is defined as + +

+ An order_spec is defined as follows:

-

+

[class class_name] [type type_name] [name "domain_name"] order ordering

-

- If no class is specified, the default is ANY. - If no type is specified, the default is ANY. - If no name is specified, the default is "*" (asterisk). +

+ If no class is specified, the default is ANY. + If no type is specified, the default is ANY. + If no name is specified, the default is "*" (asterisk).

-

- The legal values for ordering are: +

+ The legal values for ordering are:

-
+
+
--++ -
-

fixed

+

fixed

@@ -5414,7 +5877,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

-

random

+

random

@@ -5424,7 +5887,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

-

cyclic

+

cyclic

@@ -5439,46 +5902,53 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

-

+ +

+

For example:

+
rrset-order {
    class IN type A name "host.example.com" order random;
    order cyclic;
 };
 
-

+ +

will cause any responses for type A records in class IN that have "host.example.com" as a suffix, to always be returned in random order. All other records are returned in cyclic order.

-

- If multiple rrset-order statements +

+ If multiple rrset-order statements appear, they are not combined — the last one applies.

-

+

By default, all records are returned in random order.

-
+ +

Note

-

+

In this release of BIND 9, the - rrset-order statement does not support + rrset-order statement does not support "fixed" ordering by default. Fixed ordering can be enabled at compile time by specifying "--enable-fixed-rrset" on the "configure" command line.

-
-
-
+
+ + +

Tuning

-
-
lame-ttl
+ + +
+
lame-ttl
-

+

Sets the number of seconds to cache a lame server indication. 0 disables caching. (This is NOT recommended.) @@ -5486,27 +5956,32 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; maximum value is 1800 (30 minutes).

-

+ +

Lame-ttl also controls the amount of time DNSSEC validation failures are cached. There is a minimum of 30 seconds applied to bad cache entries if the lame-ttl is set to less than 30 seconds.

-
-
max-ncache-ttl
-

+ +

+
max-ncache-ttl
+
+

To reduce network traffic and increase performance, - the server stores negative answers. max-ncache-ttl is + the server stores negative answers. max-ncache-ttl is used to set a maximum retention time for these answers in the server in seconds. The default - max-ncache-ttl is 10800 seconds (3 hours). - max-ncache-ttl cannot exceed + max-ncache-ttl is 10800 seconds (3 hours). + max-ncache-ttl cannot exceed 7 days and will be silently truncated to 7 days if set to a greater value. -

-
max-cache-ttl
-

+

+
+
max-cache-ttl
+
+

Sets the maximum time for which the server will cache ordinary (positive) answers. The default is one week (7 days). @@ -5514,28 +5989,29 @@ 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
+

+ +
min-roots
-

+

The minimum number of root servers that is required for a request for the root servers to be accepted. The default is 2.

-
+

Note

-

+

Not implemented in BIND 9.

-
-
-
sig-validity-interval
+
+ +
sig-validity-interval
-

+

Specifies the number of days into the future when DNSSEC signatures automatically generated as a - result of dynamic updates (the section called “Dynamic Update”) will expire. There + result of dynamic updates (the section called “Dynamic Update”) will expire. There is an optional second field which specifies how long before expiry that the signatures will be regenerated. If not specified, the signatures will @@ -5546,65 +6022,69 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; giving a re-signing interval of 7 1/2 days. The maximum values are 10 years (3660 days).

-

+

The signature inception time is unconditionally set to one hour before the current time to allow for a limited amount of clock skew.

-

- The sig-validity-interval +

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

+

+
sig-signing-nodes
+
+

Specify the maximum number of nodes to be examined in each quantum when signing a zone with a new DNSKEY. The default is 100. -

-
sig-signing-signatures
-

+

+
+
sig-signing-signatures
+
+

Specify a threshold number of signatures that will terminate processing a quantum when signing a zone with a new DNSKEY. The default is 10. -

-
sig-signing-type
+

+ +
sig-signing-type
-

+

Specify a private RDATA type to be used when generating signing state records. The default is 65534.

-

+

It is expected that this parameter may be removed in a future version once there is a standard type.

-

+

Signing state records are used to internally by - named to track the current state of + named to track the current state of a zone-signing process, i.e., whether it is still active or has been completed. The records can be inspected using the command - rndc signing -list zone. - Once named has finished signing + rndc signing -list zone. + Once named has finished signing a zone with a particular key, the signing state record associated with that key can be removed from the zone by running - rndc signing -clear keyid/algorithm zone. + rndc signing -clear keyid/algorithm zone. To clear all of the completed signing state records for a zone, use - rndc signing -clear all zone. + rndc signing -clear all zone.

-
+
-min-refresh-time, max-refresh-time, min-retry-time, max-retry-time +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. @@ -5614,7 +6094,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; little control over their contents.

-

+

These options allow the administrator to set a minimum and maximum refresh and retry time either per-zone, per-view, or @@ -5623,92 +6103,93 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; and clamp the SOA refresh and retry times to the specified values.

-

+

The following defaults apply. - min-refresh-time 300 seconds, - max-refresh-time 2419200 seconds - (4 weeks), min-retry-time 500 seconds, - and max-retry-time 1209600 seconds + min-refresh-time 300 seconds, + max-refresh-time 2419200 seconds + (4 weeks), min-retry-time 500 seconds, + and max-retry-time 1209600 seconds (2 weeks).

-
-
edns-udp-size
+ +
edns-udp-size
-

+

Sets the advertised EDNS UDP buffer size in bytes to control the size of packets received. Valid values are 512 to 4096 (values outside this range will be silently adjusted). The default value is 4096. The usual reason for setting - edns-udp-size to a non-default + 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 packets that are greater than 512 bytes.

-

- named will fallback to using 512 bytes +

+ named will fallback to using 512 bytes if it get a series of timeout at the initial value. 512 bytes is not being offered to encourage sites to fix their firewalls. Small EDNS UDP sizes will result in the excessive use of TCP.

-
-
max-udp-size
+ +
max-udp-size
-

+

Sets the maximum EDNS UDP message size - named will send in bytes. + named will send in bytes. Valid values are 512 to 4096 (values outside this range will be silently adjusted). The default value is 4096. The usual reason for setting - max-udp-size to a non-default + max-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 packets that are greater than 512 bytes. This is independent of the advertised receive - buffer (edns-udp-size). + buffer (edns-udp-size).

-

+

Setting this to a low value will encourage additional TCP traffic to the nameserver.

-
-
masterfile-format
+ +
masterfile-format
-

Specifies +

Specifies the file format of zone files (see - the section called “Additional File Formats”). + the section called “Additional File Formats”). The default value is text, which is the standard textual representation, except for slave zones, in which the default value is raw. Files in other formats than text are typically expected to be generated by the - named-compilezone tool, or dumped by - named. + named-compilezone tool, or dumped by + named.

-

+

Note that when a zone file in a different format than - text is loaded, named + text is loaded, named may omit some of the checks which would be performed for a file in the text format. In particular, - check-names checks do not apply + check-names checks do not apply for the raw format. This means a zone file in the raw format must be generated with the same check level as that - specified in the named configuration + specified in the named configuration file. This statement sets the - masterfile-format for all zones, + masterfile-format for all zones, but can be overridden on a per-zone or per-view basis - by including a masterfile-format - statement within the zone or - view block in the configuration + by including a masterfile-format + statement within the zone or + view block in the configuration file.

-
+
-max-recursion-depth +max-recursion-depth
-

+

+

Sets the maximum number of levels of recursion that are permitted at any one time while servicing a recursive query. Resolving a name may require @@ -5717,11 +6198,13 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; of indirections exceeds this value, the recursive query is terminated and returns SERVFAIL. The default is 7. -

+

+
-max-recursion-queries +max-recursion-queries
-

+

+

Sets the maximum number of iterative queries that may be sent while servicing a recursive query. If more queries are sent, the recursive query @@ -5729,97 +6212,114 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; look up top level comains such as "com" and "net" and the DNS root zone are exempt from this limitation. The default is 75. -

-
notify-delay
+

+ +
notify-delay
-

+

The delay, in seconds, between sending sets of notify messages for a zone. The default is five (5) seconds.

-

+

The overall rate that NOTIFY messages are sent for all - zones is controlled by serial-query-rate. + zones is controlled by serial-query-rate.

-
-
max-rsa-exponent-size
-

+

+
max-rsa-exponent-size
+
+

The maximum RSA exponent size, in bits, that will be accepted when validating. Valid values are 35 to 4096 bits. The default zero (0) is also accepted and is equivalent to 4096. -

+

+
-
-
+ +
+ +

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 - CHAOS class. These zones are part + CHAOS class. These zones are part of a - built-in view (see the section called “view Statement Grammar”) of + built-in view (see the section called “view Statement Grammar”) of class - CHAOS which is separate from the - default view of class IN. Most global - configuration options (allow-query, + CHAOS which is separate from the + default view of class IN. Most global + configuration options (allow-query, etc) will apply to this view, but some are locally - overridden: notify, - recursion and - allow-new-zones are + overridden: notify, + recursion and + allow-new-zones are always set to no.

-

+

If you need to disable these zones, use the options - below, or hide the built-in CHAOS + below, or hide the built-in CHAOS view by - defining an explicit view of class CHAOS + defining an explicit view of class CHAOS that matches all clients.

-
-
version
-

+ +

+
version
+
+

The version the server should report via a query of the name version.bind - with type TXT, class CHAOS. + with type TXT, class CHAOS. The default is the real version number of this server. - Specifying version none + Specifying version none disables processing of the queries. -

-
hostname
-

+

+
+
hostname
+
+

The hostname the server should report via a query of the name hostname.bind - with type TXT, class CHAOS. + with type TXT, class CHAOS. This defaults to the hostname of the machine hosting the name server as found by the gethostname() function. The primary purpose of such queries is to identify which of a group of anycast servers is actually - answering your queries. Specifying hostname none; + answering your queries. Specifying hostname none; disables processing of the queries. -

-
server-id
-

+

+
+
server-id
+
+

The ID the server should report when receiving a Name Server Identifier (NSID) query, or a query of the name ID.SERVER with type - TXT, class CHAOS. + TXT, class CHAOS. The primary purpose of such queries is to identify which of a group of anycast servers is actually - answering your queries. Specifying server-id none; + answering your queries. Specifying server-id none; disables processing of the queries. - Specifying server-id hostname; will cause named to + Specifying server-id hostname; will cause named to use the hostname as found by the gethostname() function. - The default server-id is none. -

+ The default server-id is none. +

+
-
-
+ +
+ +

Built-in Empty Zones

-

+ +

Named has some built-in empty zones (SOA and NS records only). These are for zones that should normally be answered locally and which queries should not be sent to the Internet's root @@ -5831,116 +6331,116 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; IPv6 link local addresses, the IPv6 loopback address and the IPv6 unknown address.

-

+

Named will attempt to determine if a built-in zone already exists or is active (covered by a forward-only forwarding declaration) and will not create an empty zone in that case.

-

+

The current list of empty zones is:

-
    -
  • 10.IN-ADDR.ARPA
  • -
  • 16.172.IN-ADDR.ARPA
  • -
  • 17.172.IN-ADDR.ARPA
  • -
  • 18.172.IN-ADDR.ARPA
  • -
  • 19.172.IN-ADDR.ARPA
  • -
  • 20.172.IN-ADDR.ARPA
  • -
  • 21.172.IN-ADDR.ARPA
  • -
  • 22.172.IN-ADDR.ARPA
  • -
  • 23.172.IN-ADDR.ARPA
  • -
  • 24.172.IN-ADDR.ARPA
  • -
  • 25.172.IN-ADDR.ARPA
  • -
  • 26.172.IN-ADDR.ARPA
  • -
  • 27.172.IN-ADDR.ARPA
  • -
  • 28.172.IN-ADDR.ARPA
  • -
  • 29.172.IN-ADDR.ARPA
  • -
  • 30.172.IN-ADDR.ARPA
  • -
  • 31.172.IN-ADDR.ARPA
  • -
  • 168.192.IN-ADDR.ARPA
  • -
  • 64.100.IN-ADDR.ARPA
  • -
  • 65.100.IN-ADDR.ARPA
  • -
  • 66.100.IN-ADDR.ARPA
  • -
  • 67.100.IN-ADDR.ARPA
  • -
  • 68.100.IN-ADDR.ARPA
  • -
  • 69.100.IN-ADDR.ARPA
  • -
  • 70.100.IN-ADDR.ARPA
  • -
  • 71.100.IN-ADDR.ARPA
  • -
  • 72.100.IN-ADDR.ARPA
  • -
  • 73.100.IN-ADDR.ARPA
  • -
  • 74.100.IN-ADDR.ARPA
  • -
  • 75.100.IN-ADDR.ARPA
  • -
  • 76.100.IN-ADDR.ARPA
  • -
  • 77.100.IN-ADDR.ARPA
  • -
  • 78.100.IN-ADDR.ARPA
  • -
  • 79.100.IN-ADDR.ARPA
  • -
  • 80.100.IN-ADDR.ARPA
  • -
  • 81.100.IN-ADDR.ARPA
  • -
  • 82.100.IN-ADDR.ARPA
  • -
  • 83.100.IN-ADDR.ARPA
  • -
  • 84.100.IN-ADDR.ARPA
  • -
  • 85.100.IN-ADDR.ARPA
  • -
  • 86.100.IN-ADDR.ARPA
  • -
  • 87.100.IN-ADDR.ARPA
  • -
  • 88.100.IN-ADDR.ARPA
  • -
  • 89.100.IN-ADDR.ARPA
  • -
  • 90.100.IN-ADDR.ARPA
  • -
  • 91.100.IN-ADDR.ARPA
  • -
  • 92.100.IN-ADDR.ARPA
  • -
  • 93.100.IN-ADDR.ARPA
  • -
  • 94.100.IN-ADDR.ARPA
  • -
  • 95.100.IN-ADDR.ARPA
  • -
  • 96.100.IN-ADDR.ARPA
  • -
  • 97.100.IN-ADDR.ARPA
  • -
  • 98.100.IN-ADDR.ARPA
  • -
  • 99.100.IN-ADDR.ARPA
  • -
  • 100.100.IN-ADDR.ARPA
  • -
  • 101.100.IN-ADDR.ARPA
  • -
  • 102.100.IN-ADDR.ARPA
  • -
  • 103.100.IN-ADDR.ARPA
  • -
  • 104.100.IN-ADDR.ARPA
  • -
  • 105.100.IN-ADDR.ARPA
  • -
  • 106.100.IN-ADDR.ARPA
  • -
  • 107.100.IN-ADDR.ARPA
  • -
  • 108.100.IN-ADDR.ARPA
  • -
  • 109.100.IN-ADDR.ARPA
  • -
  • 110.100.IN-ADDR.ARPA
  • -
  • 111.100.IN-ADDR.ARPA
  • -
  • 112.100.IN-ADDR.ARPA
  • -
  • 113.100.IN-ADDR.ARPA
  • -
  • 114.100.IN-ADDR.ARPA
  • -
  • 115.100.IN-ADDR.ARPA
  • -
  • 116.100.IN-ADDR.ARPA
  • -
  • 117.100.IN-ADDR.ARPA
  • -
  • 118.100.IN-ADDR.ARPA
  • -
  • 119.100.IN-ADDR.ARPA
  • -
  • 120.100.IN-ADDR.ARPA
  • -
  • 121.100.IN-ADDR.ARPA
  • -
  • 122.100.IN-ADDR.ARPA
  • -
  • 123.100.IN-ADDR.ARPA
  • -
  • 124.100.IN-ADDR.ARPA
  • -
  • 125.100.IN-ADDR.ARPA
  • -
  • 126.100.IN-ADDR.ARPA
  • -
  • 127.100.IN-ADDR.ARPA
  • -
  • 0.IN-ADDR.ARPA
  • -
  • 127.IN-ADDR.ARPA
  • -
  • 254.169.IN-ADDR.ARPA
  • -
  • 2.0.192.IN-ADDR.ARPA
  • -
  • 100.51.198.IN-ADDR.ARPA
  • -
  • 113.0.203.IN-ADDR.ARPA
  • -
  • 255.255.255.255.IN-ADDR.ARPA
  • -
  • 0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.IP6.ARPA
  • -
  • 1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.IP6.ARPA
  • -
  • 8.B.D.0.1.0.0.2.IP6.ARPA
  • -
  • D.F.IP6.ARPA
  • -
  • 8.E.F.IP6.ARPA
  • -
  • 9.E.F.IP6.ARPA
  • -
  • A.E.F.IP6.ARPA
  • -
  • B.E.F.IP6.ARPA
  • +
      +
    • 10.IN-ADDR.ARPA
    • +
    • 16.172.IN-ADDR.ARPA
    • +
    • 17.172.IN-ADDR.ARPA
    • +
    • 18.172.IN-ADDR.ARPA
    • +
    • 19.172.IN-ADDR.ARPA
    • +
    • 20.172.IN-ADDR.ARPA
    • +
    • 21.172.IN-ADDR.ARPA
    • +
    • 22.172.IN-ADDR.ARPA
    • +
    • 23.172.IN-ADDR.ARPA
    • +
    • 24.172.IN-ADDR.ARPA
    • +
    • 25.172.IN-ADDR.ARPA
    • +
    • 26.172.IN-ADDR.ARPA
    • +
    • 27.172.IN-ADDR.ARPA
    • +
    • 28.172.IN-ADDR.ARPA
    • +
    • 29.172.IN-ADDR.ARPA
    • +
    • 30.172.IN-ADDR.ARPA
    • +
    • 31.172.IN-ADDR.ARPA
    • +
    • 168.192.IN-ADDR.ARPA
    • +
    • 64.100.IN-ADDR.ARPA
    • +
    • 65.100.IN-ADDR.ARPA
    • +
    • 66.100.IN-ADDR.ARPA
    • +
    • 67.100.IN-ADDR.ARPA
    • +
    • 68.100.IN-ADDR.ARPA
    • +
    • 69.100.IN-ADDR.ARPA
    • +
    • 70.100.IN-ADDR.ARPA
    • +
    • 71.100.IN-ADDR.ARPA
    • +
    • 72.100.IN-ADDR.ARPA
    • +
    • 73.100.IN-ADDR.ARPA
    • +
    • 74.100.IN-ADDR.ARPA
    • +
    • 75.100.IN-ADDR.ARPA
    • +
    • 76.100.IN-ADDR.ARPA
    • +
    • 77.100.IN-ADDR.ARPA
    • +
    • 78.100.IN-ADDR.ARPA
    • +
    • 79.100.IN-ADDR.ARPA
    • +
    • 80.100.IN-ADDR.ARPA
    • +
    • 81.100.IN-ADDR.ARPA
    • +
    • 82.100.IN-ADDR.ARPA
    • +
    • 83.100.IN-ADDR.ARPA
    • +
    • 84.100.IN-ADDR.ARPA
    • +
    • 85.100.IN-ADDR.ARPA
    • +
    • 86.100.IN-ADDR.ARPA
    • +
    • 87.100.IN-ADDR.ARPA
    • +
    • 88.100.IN-ADDR.ARPA
    • +
    • 89.100.IN-ADDR.ARPA
    • +
    • 90.100.IN-ADDR.ARPA
    • +
    • 91.100.IN-ADDR.ARPA
    • +
    • 92.100.IN-ADDR.ARPA
    • +
    • 93.100.IN-ADDR.ARPA
    • +
    • 94.100.IN-ADDR.ARPA
    • +
    • 95.100.IN-ADDR.ARPA
    • +
    • 96.100.IN-ADDR.ARPA
    • +
    • 97.100.IN-ADDR.ARPA
    • +
    • 98.100.IN-ADDR.ARPA
    • +
    • 99.100.IN-ADDR.ARPA
    • +
    • 100.100.IN-ADDR.ARPA
    • +
    • 101.100.IN-ADDR.ARPA
    • +
    • 102.100.IN-ADDR.ARPA
    • +
    • 103.100.IN-ADDR.ARPA
    • +
    • 104.100.IN-ADDR.ARPA
    • +
    • 105.100.IN-ADDR.ARPA
    • +
    • 106.100.IN-ADDR.ARPA
    • +
    • 107.100.IN-ADDR.ARPA
    • +
    • 108.100.IN-ADDR.ARPA
    • +
    • 109.100.IN-ADDR.ARPA
    • +
    • 110.100.IN-ADDR.ARPA
    • +
    • 111.100.IN-ADDR.ARPA
    • +
    • 112.100.IN-ADDR.ARPA
    • +
    • 113.100.IN-ADDR.ARPA
    • +
    • 114.100.IN-ADDR.ARPA
    • +
    • 115.100.IN-ADDR.ARPA
    • +
    • 116.100.IN-ADDR.ARPA
    • +
    • 117.100.IN-ADDR.ARPA
    • +
    • 118.100.IN-ADDR.ARPA
    • +
    • 119.100.IN-ADDR.ARPA
    • +
    • 120.100.IN-ADDR.ARPA
    • +
    • 121.100.IN-ADDR.ARPA
    • +
    • 122.100.IN-ADDR.ARPA
    • +
    • 123.100.IN-ADDR.ARPA
    • +
    • 124.100.IN-ADDR.ARPA
    • +
    • 125.100.IN-ADDR.ARPA
    • +
    • 126.100.IN-ADDR.ARPA
    • +
    • 127.100.IN-ADDR.ARPA
    • +
    • 0.IN-ADDR.ARPA
    • +
    • 127.IN-ADDR.ARPA
    • +
    • 254.169.IN-ADDR.ARPA
    • +
    • 2.0.192.IN-ADDR.ARPA
    • +
    • 100.51.198.IN-ADDR.ARPA
    • +
    • 113.0.203.IN-ADDR.ARPA
    • +
    • 255.255.255.255.IN-ADDR.ARPA
    • +
    • 0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.IP6.ARPA
    • +
    • 1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.IP6.ARPA
    • +
    • 8.B.D.0.1.0.0.2.IP6.ARPA
    • +
    • D.F.IP6.ARPA
    • +
    • 8.E.F.IP6.ARPA
    • +
    • 9.E.F.IP6.ARPA
    • +
    • A.E.F.IP6.ARPA
    • +
    • B.E.F.IP6.ARPA

    -

    +

    Empty zones are settable at the view level and only apply to views of class IN. Disabled empty zones are only inherited from options if there are no disabled empty zones specified @@ -5952,7 +6452,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };

-

+

If you are using the address ranges covered here, you should already have reverse zones covering the addresses you use. In practice this appears to not be the case with many queries @@ -5961,52 +6461,64 @@ 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 empty zone under the parent zone they serve. For the real root servers, this is all built-in empty zones. This will enable them to return referrals to deeper in the tree.
-
-
empty-server
-

+

+
empty-server
+
+

Specify what server name will appear in the returned SOA record for empty zones. If none is specified, then the zone's name will be used. -

-
empty-contact
-

+

+
+
empty-contact
+
+

Specify what contact name will appear in the returned SOA record for empty zones. If none is specified, then "." will be used. -

-
empty-zones-enable
-

+

+
+
empty-zones-enable
+
+

Enable or disable all empty zones. By default, they are enabled. -

-
disable-empty-zone
-

+

+
+
disable-empty-zone
+
+

Disable individual empty zones. By default, none are disabled. This option can be specified multiple times. -

+

+
-
-
+
+ +

Additional Section Caching

-

- The additional section cache, also called acache, + + +

+ The additional section cache, also called acache, is an internal cache to improve the response performance of BIND 9. When additional section caching is enabled, BIND 9 will cache an internal short-cut to the additional section content for each answer RR. - Note that acache is an internal caching + Note that acache is an internal caching 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 @@ -6014,64 +6526,74 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; It is particularly effective when BIND 9 acts as an authoritative server for a zone that has many delegations with many glue RRs.

-

+ +

In order to obtain the maximum performance improvement from additional section caching, setting - additional-from-cache - to no is recommended, since the current - implementation of acache + additional-from-cache + to no is recommended, since the current + implementation of acache does not short-cut of additional section information from the DNS cache data.

-

- One obvious disadvantage of acache is + +

+ One obvious disadvantage of acache is that it requires much more memory for the internal cached data. Thus, if the response performance does not matter and memory consumption is much more critical, the - acache mechanism can be - disabled by setting acache-enable to - no. + acache mechanism can be + disabled by setting acache-enable to + no. It is also possible to specify the upper limit of memory consumption - for acache by using max-acache-size. + 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, - cyclic order is effective for the additional + Without acache, + cyclic order is effective for the additional section as well as the answer and authority sections. However, additional section caching fixes the ordering when it first caches an RRset for the additional section, and the same ordering will be kept in succeeding responses, regardless of the - setting of rrset-order. + setting of rrset-order. The effect of this should be minor, however, since an RRset in the additional section typically only contains a small number of RRs (and in many cases it only contains a single RR), in which case the ordering does not matter much.

-

+ +

The following is a summary of options related to - acache. + acache.

-
-
acache-enable
-

- If yes, additional section caching is - enabled. The default value is no. -

-
acache-cleaning-interval
-

+ +

+
acache-enable
+
+

+ If yes, additional section caching is + enabled. The default value is no. +

+
+
acache-cleaning-interval
+
+

The server will remove stale cache entries, based on an LRU based - algorithm, every acache-cleaning-interval minutes. + algorithm, every acache-cleaning-interval minutes. The default is 60 minutes. If set to 0, no periodic cleaning will occur. -

-
max-acache-size
-

+

+
+
max-acache-size
+
+

The maximum amount of memory in bytes to use for the server's acache. When the amount of data in the acache reaches this limit, the server @@ -6081,55 +6603,63 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; separately to the acache of each view. The default is 16M. -

+

+
-
-
+ +
+ +

-Content Filtering

-

+Content Filtering

+ +

BIND 9 provides the ability to filter out DNS responses from external DNS servers containing certain types of data in the answer section. Specifically, it can reject address (A or AAAA) records if the corresponding IPv4 or IPv6 addresses match the given address_match_list of the - deny-answer-addresses option. + deny-answer-addresses option. It can also reject CNAME or DNAME records if the "alias" name (i.e., the CNAME alias or the substituted query name due to DNAME) matches the given namelist of the - deny-answer-aliases option, where + deny-answer-aliases option, where "match" means the alias name is a subdomain of one of the name_list elements. If the optional namelist is specified - with except-from, records whose query name + with except-from, records whose query name matches the list will be accepted regardless of the filter setting. Likewise, if the alias name is a subdomain of the - corresponding zone, the deny-answer-aliases + corresponding zone, the deny-answer-aliases filter will not apply; for example, even if "example.com" is specified for - deny-answer-aliases, + deny-answer-aliases,

www.example.com. CNAME xxx.example.com.
-

+ +

returned by an "example.com" server will be accepted.

-

+ +

In the address_match_list of the - deny-answer-addresses option, only + deny-answer-addresses option, only ip_addr and ip_prefix are meaningful; any key_id will be silently ignored.

-

+ +

If a response message is rejected due to the filtering, the entire message is discarded without being cached, and a SERVFAIL error will be returned to the client.

-

+ +

This filtering is intended to prevent "DNS rebinding attacks," in which an attacker, in response to a query for a domain name the attacker controls, returns an IP address within your own network or @@ -6139,44 +6669,53 @@ avoid-v6-udp-ports { 40000; range 50000 60000; }; to get access to an internal node of your local network that couldn't be externally accessed otherwise. See the paper available at - + http://portal.acm.org/citation.cfm?id=1315245.1315298 for more details about the attacks.

-

+ +

For example, if you own a domain named "example.net" and your internal network uses an IPv4 prefix 192.0.2.0/24, you might specify the following rules:

+
deny-answer-addresses { 192.0.2.0/24; } except-from { "example.net"; };
 deny-answer-aliases { "example.net"; };
 
-

+ +

If an external attacker lets a web browser in your local network look up an IPv4 address of "attacker.example.com", the attacker's DNS server would return a response like this:

+
attacker.example.com. A 192.0.2.1
-

+ +

in the answer section. Since the rdata of this record (the IPv4 address) matches the specified prefix 192.0.2.0/24, this response will be ignored.

-

+ +

On the other hand, if the browser looks up a legitimate internal web server "www.example.net" and the following response is returned to the BIND 9 server

+
www.example.net. A 192.0.2.2
-

+ +

it will be accepted since the owner name "www.example.net" - matches the except-from element, + matches the except-from element, "example.net".

-

+ +

Note that this is not really an attack on the DNS per se. In fact, there is nothing wrong for an "external" name to be mapped to your "internal" IP address or domain name @@ -6197,7 +6736,8 @@ deny-answer-aliases { "example.net"; }; very sure you have no other choice and the attack is a real threat for your applications.

-

+ +

Care should be particularly taken if you want to use this option for addresses within 127.0.0.0/8. These addresses are obviously "internal", but many @@ -6206,11 +6746,13 @@ deny-answer-aliases { "example.net"; }; Filtering out DNS records containing this address spuriously can break such applications.

- -
+
+ +

-Response Policy Zone (RPZ) Rewriting

-

+Response Policy Zone (RPZ) Rewriting

+ +

BIND 9 includes a limited mechanism to modify DNS responses for requests analogous to email anti-spam DNS blacklists. @@ -6218,16 +6760,18 @@ 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 + response-policy option for the view or among the global options if there is no response-policy option for the view. RPZs are ordinary DNS zones containing RRsets that can be queried normally if allowed. It is usually best to restrict those queries with something like - allow-query { localhost; };. + allow-query { localhost; };.

-

+ +

Four policy triggers are encoded in RPZ records, QNAME, IP, NSIP, and NSDNAME. QNAME RPZ records triggered by query names of requests and targets @@ -6235,7 +6779,8 @@ deny-answer-aliases { "example.net"; }; The owner name of a QNAME RPZ record is the query name relativized to the RPZ.

-

+ +

The second kind of RPZ trigger is an IP address in an A and AAAA record in the ANSWER section of a response. IP address triggers are encoded in records that have owner names @@ -6258,7 +6803,8 @@ deny-answer-aliases { "example.net"; }; analogous to double colons (::) in standard IPv6 text encodings. The prefix length must be between 1 and 128.

-

+ +

NSDNAME triggers match names of authoritative servers for the query name, a parent of the query name, a CNAME for query name, or a parent of a CNAME. @@ -6271,59 +6817,62 @@ deny-answer-aliases { "example.net"; }; NSIP triggers are encoded like IP triggers except as subdomains of rpz-nsip. NSDNAME and NSIP triggers are checked only for names with at - least min-ns-dots dots. - The default value of min-ns-dots is 1 to + least min-ns-dots dots. + The default value of min-ns-dots is 1 to exclude top level domains.

-

+ +

The query response is checked against all RPZs, so two or more policy records can be triggered by a response. Because DNS responses can be rewritten according to at most one policy record, a single record encoding an action (other than - DISABLED actions) must be chosen. + DISABLED actions) must be chosen. Triggers or the records that encode them are chosen in the following order:

-
    -
  • Choose the triggered record in the zone that appears +
      +
    • Choose the triggered record in the zone that appears first in the response-policy option.
    • -
    • Prefer QNAME to IP to NSDNAME to NSIP triggers +
    • Prefer QNAME to IP to NSDNAME to NSIP triggers in a single zone.
    • -
    • Among NSDNAME triggers, prefer the +
    • Among NSDNAME triggers, prefer the trigger that matches the smallest name under the DNSSEC ordering.
    • -
    • Among IP or NSIP triggers, prefer the trigger +
    • Among IP or NSIP triggers, prefer the trigger with the longest prefix.
    • -
    • Among triggers with the same prefix length, +
    • Among triggers with the same prefix length, prefer the IP or NSIP trigger that matches the smallest IP address.

    -

    + +

    When the processing of a response is restarted to resolve DNAME or CNAME records and a policy record set has not been triggered, all RPZs are again consulted for the DNAME or CNAME names and addresses.

    -

    + +

    RPZ record sets are sets of any types of DNS record except DNAME or DNSSEC that encode actions or responses to queries.

    -
      -
    • The NXDOMAIN response is encoded +
        +
      • The NXDOMAIN response is encoded by a CNAME whose target is the root domain (.)
      • -
      • A CNAME whose target is the wildcard top-level - domain (*.) specifies the NODATA action, +
      • A CNAME whose target is the wildcard top-level + domain (*.) specifies the NODATA action, which rewrites the response to NODATA or ANCOUNT=1.
      • -
      • The Local Data action is +
      • The Local Data action is represented by a set ordinary DNS records that are used to answer queries. Queries for record types not the set are answered with NODATA. @@ -6335,8 +6884,8 @@ deny-answer-aliases { "example.net"; }; The purpose for this special form is query logging in the walled garden's authority DNS server.
      • -
      • The PASSTHRU policy is specified - by a CNAME whose target is rpz-passthru. +
      • The PASSTHRU 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. @@ -6346,20 +6895,21 @@ deny-answer-aliases { "example.net"; };

      -

      + +

      The actions specified in an RPZ can be overridden with a - policy clause in the - response-policy option. + policy clause in the + response-policy option. An organization using an RPZ provided by another organization might use this mechanism to redirect domains to its own walled garden.

      -
        -
      • -GIVEN says "do not override but +
          +
        • +GIVEN says "do not override but perform the action specified in the zone."
        • -
        • -DISABLED causes policy records to do +
        • +DISABLED causes policy records to do nothing but log what they might have done. The response to the DNS query will be written according to any triggered policy records that are not disabled. @@ -6367,64 +6917,68 @@ deny-answer-aliases { "example.net"; }; because they will often not be logged if a higher precedence trigger is found first.
        • -
        • -PASSTHRU causes all policy records +
        • +PASSTHRU causes all policy records to act as if they were CNAME records with targets the variable part of their owner name. They protect the response from being changed.
        • -
        • -NXDOMAIN causes all RPZ records +
        • +NXDOMAIN causes all RPZ records to specify NXDOMAIN policies.
        • -
        • -NODATA overrides with the +
        • +NODATA overrides with the NODATA policy
        • -
        • -CNAME domain causes all RPZ +
        • +CNAME domain causes all RPZ policy records to act as if they were "cname domain" records.

        -

        + +

        By default, the actions encoded in an RPZ are applied only to queries that ask for recursion (RD=1). That default can be changed for a single RPZ or all RPZs in a view - with a recursive-only no clause. + with a recursive-only no clause. This feature is useful for serving the same zone files both inside and outside an RFC 1918 cloud and using RPZ to delete answers that would otherwise contain RFC 1918 values on the externally visible name server or view.

        -

        + +

        Also by default, RPZ actions are applied only to DNS requests that either do not request DNSSEC metadata (DO=0) or when no DNSSEC records are available for request name in the original zone (not the response policy zone). This default can be changed for all RPZs in a view with a - break-dnssec yes clause. + break-dnssec yes clause. In that case, RPZ actions are applied regardless of DNSSEC. The name of the clause option reflects the fact that results rewritten by RPZ actions cannot verify.

        -

        + +

        The TTL of a record modified by RPZ policies is set from the TTL of the relevant record in policy zone. It is then limited to a maximum value. - The max-policy-ttl clause changes that + The max-policy-ttl clause changes that maximum from its default of 5.

        -

        + +

        For example, you might use this option statement

            response-policy { zone "badlist"; };
        -

        +

        and this zone statement

            zone "badlist" {type master; file "master/badlist"; allow-query {none;}; };
        -

        +

        with this zone file

        $TTL 1H
        @@ -6454,7 +7008,7 @@ bzone.domain.com        CNAME   garden.example.com.
         ns.domain.com.rpz-nsdname   CNAME   .
         48.zz.2.2001.rpz-nsip       CNAME   .
         
        -

        +

        RPZ can affect server performance. Each configured response policy zone requires the server to perform one to four additional database lookups before a @@ -6469,24 +7023,27 @@ ns.domain.com.rpz-nsdname CNAME . 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. + RPZRewrites statistics.

        -
      -
      +
      + +

      -Response Rate Limiting

      -

      +Response Rate Limiting

+ +

This feature is only available when BIND 9 is compiled with the --enable-rrl option on the "configure" command line.

-

+

Excessive almost identical UDP responses can be controlled by configuring a - rate-limit clause in an - options or view statement. + rate-limit clause in an + options or view statement. This mechanism keeps authoritative BIND 9 from being used in amplifying reflection denial of service (DoS) attacks. Short truncated (TC=1) responses can be sent to provide @@ -6495,7 +7052,8 @@ ns.domain.com.rpz-nsdname CNAME . Legitimate clients react to dropped or truncated response by retrying with UDP or with TCP respectively.

-

+ +

This mechanism is intended for authoritative DNS servers. It can be used on recursive servers but can slow applications such as SMTP servers (mail receivers) and @@ -6503,7 +7061,8 @@ ns.domain.com.rpz-nsdname CNAME . 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 @@ -6513,65 +7072,70 @@ ns.domain.com.rpz-nsdname CNAME . while the account is negative. Responses are tracked within a rolling window of time which defaults to 15 seconds, but can be configured with - the window option to any value from + the window option to any value from 1 to 3600 seconds (1 hour). The account cannot become more positive than the per-second limit - or more negative than window + or more negative than window times the per-second limit. 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 single client. The prefix lengths of addresses blocks are - specified with ipv4-prefix-length (default 24) - and ipv6-prefix-length (default 56). + 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 + with responses-per-second (default 0 or no limit). All empty (NODATA) responses for a valid domain, regardless of query type, are identical. Responses in the NODATA class are limited by - nodata-per-second - (default responses-per-second). + nodata-per-second + (default responses-per-second). Requests for any and all undefined subdomains of a given valid domain result in NXDOMAIN errors, and are identical regardless of query type. - They are limited by nxdomain-per-second - (default responses-per-second). + They are limited by nxdomain-per-second + (default responses-per-second). This controls some attacks using random names, but can be relaxed or turned off (set to 0) on servers that expect many legitimate NXDOMAIN responses, such as from anti-spam blacklists. Referrals or delegations to the server of a given domain are identical and are limited by - referrals-per-second - (default responses-per-second). + 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). This controls attacks using invalid requests or distant, broken authoritative servers. By default the limit on errors is the same as the - responses-per-second value, + responses-per-second value, but it can be set separately with - errors-per-second. + 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 @@ -6579,13 +7143,13 @@ ns.domain.com.rpz-nsdname CNAME . but could let a third party block responses to legitimate requests. There is a mechanism that can answer some legitimate requests from a client whose address is being forged in a flood. - Setting slip to 2 (its default) causes every + Setting slip to 2 (its default) causes every other UDP request to be answered with a small truncated (TC=1) response. The small size and reduced frequency, and so lack of amplification, of "slipped" responses make them unattractive for reflection DoS attacks. - slip must be between 0 and 10. + slip must be between 0 and 10. A value of 0 does not "slip": no truncated responses are sent due to rate limiting, all responses are dropped. @@ -6593,9 +7157,10 @@ ns.domain.com.rpz-nsdname CNAME . values between 2 and 10 cause every n'th response to slip. Some error responses including REFUSED and SERVFAIL cannot be replaced with truncated responses and are instead - leaked at the slip rate. + 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 @@ -6604,21 +7169,22 @@ ns.domain.com.rpz-nsdname CNAME . to validate the responses. When this is not an option, operators who are more concerned with response integrity than with flood mitigation may consider setting - slip to 1, causing all rate-limited + slip to 1, causing all rate-limited responses to be truncated rather than dropped. This reduces the effectiveness of rate-limiting against reflection attacks.)

-

+ +

When the approximate query per second rate exceeds - the qps-scale value, - then the responses-per-second, - errors-per-second, - nxdomains-per-second and - all-per-second values are reduced by the - ratio of the current rate to the qps-scale value. + the qps-scale value, + then the responses-per-second, + errors-per-second, + nxdomains-per-second and + all-per-second values are reduced by the + ratio of the current rate to the qps-scale value. This feature can tighten defenses during attacks. For example, with - qps-scale 250; responses-per-second 20; and + qps-scale 250; responses-per-second 20; and a total query rate of 1000 queries/second for all queries from all DNS clients including via TCP, then the effective responses/second limit changes to @@ -6626,33 +7192,35 @@ ns.domain.com.rpz-nsdname CNAME . 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 - statements instead of the global option + rate-limit statements in view + statements instead of the global option statement. - A rate-limit statement in a view replaces, - rather than supplementing, a rate-limit + A rate-limit statement in a view replaces, + rather than supplementing, a rate-limit statement among the main options. DNS clients within a view can be exempted from rate limits - with the exempt-clients clause. + with the exempt-clients clause.

-

+ +

UDP responses of all kinds can be limited with the - all-per-second phrase. + all-per-second phrase. This rate limiting is unlike the rate limiting provided by - responses-per-second, - errors-per-second, and - nxdomains-per-second on a DNS server + responses-per-second, + errors-per-second, and + nxdomains-per-second on a DNS server which are often invisible to the victim of a DNS reflection attack. Unless the forged requests of the attack are the same as the legitimate requests of the victim, the victim's requests are not affected. - Responses affected by an all-per-second limit - are always dropped; the slip value has no + Responses affected by an all-per-second limit + are always dropped; the slip value has no effect. - An all-per-second limit should be + An all-per-second limit should be at least 4 times as large as the other limits, because single DNS clients often send bursts of legitimate requests. @@ -6660,11 +7228,11 @@ ns.domain.com.rpz-nsdname CNAME . requests from an SMTP server for NS, PTR, A, and AAAA records as the incoming SMTP/TCP/IP connection is considered. The SMTP server can need additional NS, A, AAAA, MX, TXT, and SPF - records as it considers the STMP Mail From + records as it considers the STMP Mail From command. Web browsers often repeatedly resolve the same names that are repeated in HTML <IMG> tags in a page. - All-per-second is similar to the + All-per-second is similar to the rate limiting offered by firewalls but often inferior. Attacks that justify ignoring the contents of DNS responses are likely to be attacks on the @@ -6674,37 +7242,43 @@ ns.domain.com.rpz-nsdname CNAME . 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. + rate limit responses is set with max-table-size. Each entry in the table is between 40 and 80 bytes. The table needs approximately as many entries as the number of requests received per second. The default is 20,000. To reduce the cold start of growing the table, - min-table-size (default 500) + min-table-size (default 500) can set the minimum table size. - Enable rate-limit category logging to monitor + Enable rate-limit category logging to monitor expansions of the table and inform choices for the initial and maximum table size.

-

- Use log-only yes to test rate limiting parameters + +

+ 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 + RateDropped and QryDropped statistics. Responses that truncated by rate limits are included in - RateSlipped and RespTruncated. + RateSlipped and RespTruncated.

- - -
+
+ + +

-server Statement Grammar

-
server ip_addr[/prefixlen] {
+server Statement Grammar
+ + +
server ip_addr[/prefixlen] {
     [ bogus yes_or_no ; ]
     [ provide-ixfr yes_or_no ; ]
     [ request-ixfr yes_or_no ; ]
@@ -6728,13 +7302,17 @@ ns.domain.com.rpz-nsdname   CNAME   .
     [ queryport-pool-updateinterval number; ]
 };
 
- -
+ +
+ +

-server Statement Definition and +server Statement Definition and Usage

-

- The server statement defines + + +

+ The server statement defines characteristics to be associated with a remote name server. If a prefix length is specified, then a range of servers is covered. Only the most @@ -6742,114 +7320,124 @@ ns.domain.com.rpz-nsdname CNAME . server clause applies regardless of the order in named.conf.

-

- The server statement can occur at + +

+ The server statement can occur at the top level of the - configuration file or inside a view + configuration file or inside a view statement. - If a view statement contains - one or more server statements, only + If a view statement contains + one or more server statements, only those apply to the view and any top-level ones are ignored. - If a view contains no server + If a view contains no server statements, - any top-level server statements are + any top-level server statements are used as defaults.

-

+ +

If you discover that a remote server is giving out bad data, marking it as bogus will prevent further queries to it. The default - value of bogus is no. + value of bogus is no.

-

- The provide-ixfr clause determines +

+ The provide-ixfr clause determines whether the local server, acting as master, will respond with an incremental zone transfer when the given remote server, a slave, requests it. - If set to yes, incremental transfer + If set to yes, incremental transfer will be provided - whenever possible. If set to no, + whenever possible. If set to no, all transfers to the remote server will be non-incremental. If not set, the value - of the provide-ixfr option in the + of the provide-ixfr option in the view or global options block is used as a default.

-

- The request-ixfr clause determines + +

+ The request-ixfr clause determines whether the local server, acting as a slave, will request incremental zone transfers from the given remote server, a master. If not set, the - value of the request-ixfr option in + value of the request-ixfr option in the view or global options block is used as a default. It may also be set in the zone block and, if set there, it will override the global or view setting for that zone.

-

+ +

IXFR requests to servers that do not support IXFR will automatically fall back to AXFR. Therefore, there is no need to manually list which servers support IXFR and which ones do not; the global default - of yes should always work. - The purpose of the provide-ixfr and - request-ixfr clauses is + of yes should always work. + The purpose of the provide-ixfr and + request-ixfr clauses is to make it possible to disable the use of IXFR even when both master and slave claim to support it, for example if one of the servers is buggy and crashes or corrupts data when IXFR is used.

-

- The edns clause determines whether + +

+ The edns clause determines whether the local server will attempt to use EDNS when communicating - with the remote server. The default is yes. + 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. + +

+ The edns-udp-size option sets the EDNS UDP size + that is advertised by named when querying the remote server. Valid values are 512 to 4096 bytes (values outside this range will be silently adjusted). This option is useful when you wish to advertises a different value to this server than the value you advertise globally, for example, when there is a firewall at the remote site that is blocking large replies.

-

- The max-udp-size option sets the - maximum EDNS UDP message size named will send. Valid + +

+ The max-udp-size option sets the + maximum EDNS UDP message size named will send. Valid values are 512 to 4096 bytes (values outside this range will be silently adjusted). This option is useful when you know that there is a firewall that is blocking large - replies from named. + replies from named.

-

- The server supports two zone transfer methods. The first, one-answer, - uses one DNS message per resource record transferred. many-answers packs - as many resource records as possible into a message. many-answers is + +

+ The server supports two zone transfer methods. The first, one-answer, + uses one DNS message per resource record transferred. many-answers packs + as many resource records as possible into a message. many-answers is more efficient, but is only known to be understood by BIND 9, BIND 8.x, and patched versions of BIND 4.9.5. You can specify which method - to use for a server with the transfer-format option. - If transfer-format is not - specified, the transfer-format + to use for a server with the transfer-format option. + If transfer-format is not + specified, the transfer-format specified - by the options statement will be + by the options statement will be used.

-

transfers + +

transfers is used to limit the number of concurrent inbound zone transfers from the specified server. If no - transfers clause is specified, the + transfers clause is specified, the limit is set according to the - transfers-per-ns option. + 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”) + +

+ The keys clause identifies a + key_id defined by the key statement, + to be used for transaction security (TSIG, the section called “TSIG”) when talking to the remote server. When a request is sent to the remote server, a request signature will be generated using the key specified here and appended to the @@ -6857,116 +7445,133 @@ ns.domain.com.rpz-nsdname CNAME . 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 transfer-source and + transfer-source-v6 clauses specify the IPv4 and IPv6 source address to be used for zone transfer with the remote server, respectively. - For an IPv4 remote server, only transfer-source can + For an IPv4 remote server, only transfer-source can be specified. Similarly, for an IPv6 remote server, only - transfer-source-v6 can be + transfer-source-v6 can be specified. For more details, see the description of - transfer-source and - transfer-source-v6 in - the section called “Zone Transfers”. + transfer-source and + transfer-source-v6 in + the section called “Zone Transfers”.

-

- The notify-source and - notify-source-v6 clauses specify the + +

+ The notify-source and + notify-source-v6 clauses specify the IPv4 and IPv6 source address to be used for notify messages sent to remote servers, respectively. For an - IPv4 remote server, only notify-source + IPv4 remote server, only notify-source can be specified. Similarly, for an IPv6 remote server, - only notify-source-v6 can be specified. + only notify-source-v6 can be specified.

-

- The query-source and - query-source-v6 clauses specify the + +

+ The query-source and + query-source-v6 clauses specify the IPv4 and IPv6 source address to be used for queries sent to remote servers, respectively. For an IPv4 - remote server, only query-source can + remote server, only query-source can be specified. Similarly, for an IPv6 remote server, - only query-source-v6 can be specified. + only query-source-v6 can be specified.

-

- The request-nsid clause determines + +

+ The request-nsid clause determines whether the local server will add a NSID EDNS option to requests sent to the server. This overrides - request-nsid set at the view or + request-nsid set at the view or option level.

-
-
+
+ +

-statistics-channels Statement Grammar

-
statistics-channels {
+statistics-channels Statement Grammar
+ + +
statistics-channels {
    [ inet ( ip_addr | * ) [ port ip_port ]
    [ allow {  address_match_list  } ]; ]
    [ inet ...; ]
 };
 
- -
+
+ +

-statistics-channels Statement Definition and +statistics-channels Statement Definition and Usage

-

- The statistics-channels statement + + +

+ The statistics-channels statement declares communication channels to be used by system administrators to get access to statistics information of the name server.

-

+ +

This statement intends to be flexible to support multiple communication protocols in the future, but currently only HTTP access is supported. It requires that BIND 9 be compiled with libxml2; - the statistics-channels statement is + the statistics-channels statement is still accepted even if it is built without the library, but any HTTP access will fail with an error.

-

- An inet control channel is a TCP socket - listening at the specified ip_port on the - specified ip_addr, which can be an IPv4 or IPv6 - address. An ip_addr of * (asterisk) is + +

+ 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 + address. An ip_addr of * (asterisk) is interpreted as the IPv4 wildcard address; connections will be accepted on any of the system's IPv4 addresses. To listen on the IPv6 wildcard address, - use an ip_addr of ::. + 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. + ip_port.

-

+ +

The attempt of opening a statistics channel is - restricted by the optional allow clause. + restricted by the optional allow clause. Connections to the statistics channel are permitted based on the - address_match_list. - If no allow clause is present, - named accepts connection + address_match_list. + If no allow clause is present, + named accepts connection attempts from any address; since the statistics may contain sensitive internal information, it is highly recommended to restrict the source of connection requests appropriately.

-

- If no statistics-channels statement is present, - named will not open any communication channels. + +

+ If no statistics-channels statement is present, + named will not open any communication channels.

-

+ +

If the statistics channel is configured to listen on 127.0.0.1 port 8888, then the statistics are accessible in XML format at - http://127.0.0.1:8888/ or - http://127.0.0.1:8888/xml. A CSS file is + http://127.0.0.1:8888/ or + http://127.0.0.1:8888/xml. A CSS file is included which can format the XML statistics into tables when viewed with a stylesheet-capable browser. When BIND 9 is configured with --enable-newstats, @@ -6976,33 +7581,39 @@ ns.domain.com.rpz-nsdname CNAME . to render data into into charts and graphs when using a javascript-capable browser.

-

+ +

Applications that depend on a particular XML schema can request - http://127.0.0.1:8888/xml/v2 for version 2 + http://127.0.0.1:8888/xml/v2 for version 2 of the statistics XML schema or - http://127.0.0.1:8888/xml/v3 for version 3. + http://127.0.0.1:8888/xml/v3 for version 3. If the requested schema is supported by the server, then it will respond; if not, it will return a "page not found" error.

-
-
+
+ +

-trusted-keys Statement Grammar

-
trusted-keys {
+trusted-keys Statement Grammar
+ + +
trusted-keys {
     string number number number string ;
     [ string number number number string ; [...]]
 };
 
- -
+ +
+

-trusted-keys Statement Definition +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 + +

+ 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 cannot be securely obtained through DNS, either because it is the DNS root zone or because its parent zone is @@ -7011,16 +7622,16 @@ ns.domain.com.rpz-nsdname CNAME . 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 + trusted-keys are deemed to exist regardless of what parent zones say. Similarly for all keys listed in - trusted-keys only those keys are + trusted-keys only those keys are used to validate the DNSKEY RRset. The parent's DS RRset will not be used.

-

- The trusted-keys statement can contain +

+ The trusted-keys statement can contain multiple key entries, each consisting of the key's domain name, flags, protocol, algorithm, and the Base-64 representation of the key data. @@ -7028,112 +7639,117 @@ ns.domain.com.rpz-nsdname CNAME . in the key data, so the configuration may be split up into multiple lines.

-

- trusted-keys may be set at the top level +

+ trusted-keys may be set at the top level of named.conf or within a view. If it is set in both places, they are additive: keys defined at the top level are inherited by all views, but keys defined in a view are only used within that view.

-
-
+
+ +

-managed-keys Statement Grammar

-
managed-keys {
+managed-keys Statement Grammar
+ + +
managed-keys {
     name initial-key flags protocol algorithm key-data ;
     [ name initial-key flags protocol algorithm key-data ; [...]]
 };
 
- -
+ +
+

-managed-keys Statement Definition +managed-keys Statement Definition and Usage

-

- The managed-keys statement, like - trusted-keys, defines DNSSEC + +

+ The managed-keys statement, like + trusted-keys, defines DNSSEC security roots. The difference is that - managed-keys can be kept up to date + managed-keys can be kept up to date 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 - trusted-keys statement would be + trusted-keys statement would be unable to validate this zone any longer; it would reply with a SERVFAIL response code. This would continue until the resolver operator had updated the - trusted-keys statement with the new key. + trusted-keys statement with the new key.

-

+

If, however, the zone were listed in a - managed-keys statement instead, then the + managed-keys statement instead, then the zone owner could add a "stand-by" key to the zone in advance. - named would store the stand-by key, and - when the original key was revoked, named + named would store the stand-by key, and + when the original key was revoked, named would be able to transition smoothly to the new key. It would also recognize that the old key had been revoked, and cease using that key to validate answers, minimizing the damage that the compromised key could do.

-

- A managed-keys statement contains a list of +

+ 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 initialization method currently supported (as of BIND 9.7.0) is initial-key. - This means the managed-keys statement must + This means the managed-keys statement must contain a copy of the initializing key. (Future releases may allow keys to be initialized by other methods, eliminating this requirement.)

-

- Consequently, a managed-keys statement - appears similar to a trusted-keys, differing +

+ Consequently, a managed-keys statement + appears similar to a trusted-keys, differing in the presence of the second field, containing the keyword initial-key. The difference is, whereas the - keys listed in a trusted-keys continue to be + keys listed in a trusted-keys continue to be trusted until they are removed from named.conf, an initializing key listed - in a managed-keys statement is only trusted + in a managed-keys statement is only trusted once: for as long as it takes to load the managed key database and start the RFC 5011 key maintenance process.

-

- The first time named runs with a managed key +

+ 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 - using the key specified in the managed-keys + using the key specified in the managed-keys 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 +

+ 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 for the specified domain, and if so, it simply moves on. The - key specified in the managed-keys is not + key specified in the managed-keys is not used to validate answers; it has been superseded by the key or keys stored in the managed keys database.

-

- The next time named runs after a name +

+ The next time named runs after a name has been removed from the - managed-keys statement, the corresponding + managed-keys statement, the corresponding zone will be removed from the managed keys database, and RFC 5011 key maintenance will no longer be used for that domain.

-

- named only maintains a single managed keys - database; consequently, unlike trusted-keys, - managed-keys may only be set at the top +

+ named only maintains a single managed keys + database; consequently, unlike trusted-keys, + managed-keys may only be set at the top level of named.conf, not within a view.

-

+

In the current implementation, the managed keys database is stored as a master-format zone file called managed-keys.bind. When the key database @@ -7142,29 +7758,32 @@ ns.domain.com.rpz-nsdname CNAME . managed-keys.bind.jnl. They are committed to the master file as soon as possible afterward; in the case of the managed key database, this will usually occur within 30 - seconds. So, whenever named is using + seconds. So, whenever named is using automatic key maintenance, those two files can be expected to exist in the working directory. (For this reason among others, the working directory should be always be writable by - named.) + named.)

-

- If the dnssec-validation option is - set to auto, named +

+ If the dnssec-validation option is + set to auto, named will automatically initialize a managed key for the - root zone. Similarly, if the dnssec-lookaside + root zone. Similarly, if the dnssec-lookaside option is set to auto, - named will automatically initialize + named will automatically initialize a managed key for the zone dlv.isc.org. In both cases, the key that is used to initialize the key - maintenance process is built into named, - and can be overridden from bindkeys-file. + maintenance process is built into named, + and can be overridden from bindkeys-file.

-
-
+
+ +

-view Statement Grammar

-
view view_name
+view Statement Grammar
+ + +
view view_name
       [class] {
       match-clients { address_match_list };
       match-destinations { address_match_list };
@@ -7173,12 +7792,15 @@ ns.domain.com.rpz-nsdname   CNAME   .
       [ zone_statement; ...]
 };
 
- -
+ +
+

-view Statement Definition and Usage

-

- The view statement is a powerful +view Statement Definition and Usage

+ + +

+ The view statement is a powerful feature of BIND 9 that lets a name server answer a DNS query differently @@ -7186,81 +7808,88 @@ ns.domain.com.rpz-nsdname CNAME . implementing split DNS setups without having to run multiple servers.

-

- Each view statement defines a view + +

+ Each view statement defines a view of the DNS namespace that will be seen by a subset of clients. A client matches a view if its source IP address matches the address_match_list of the view's - match-clients clause and its + match-clients clause and its destination IP address matches the address_match_list of the view's - match-destinations clause. If not + match-destinations clause. If not specified, both - match-clients and match-destinations + match-clients and match-destinations default to matching all addresses. In addition to checking IP addresses - match-clients and match-destinations - can also take keys which provide an + match-clients and match-destinations + can also take keys which provide an mechanism for the client to select the view. A view can also be specified - as match-recursive-only, which + as match-recursive-only, which means that only recursive requests from matching clients will match that view. - The order of the view statements is + The order of the view statements is significant — a client request will be resolved in the context of the first - view that it matches. + view that it matches.

-

- Zones defined within a view + +

+ Zones defined within a view statement will - only be accessible to clients that match the view. + only be accessible to clients that match the view. By defining a zone of the same name in multiple views, different zone data can be given to different clients, for example, "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 + +

+ Many of the options given in the options statement + can also be used within a view statement, and then apply only when resolving queries with that view. When no view-specific - value is given, the value in the options statement + value is given, the value in the options statement is used as a default. Also, zone options can have default values specified - in the view statement; these + in the view statement; these view-specific defaults - take precedence over those in the options statement. + 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 + +

+ If there are no view statements in the config file, a default view that matches any client is automatically created - in class IN. Any zone statements + in class IN. Any zone statements specified on the top level of the configuration file are considered to be part of - this default view, and the options + this default view, and the options statement will - apply to the default view. If any explicit view - statements are present, all zone + apply to the default view. If any explicit view + statements are present, all zone statements must - occur inside view statements. + occur inside view statements.

-

+ +

Here is an example of a typical split DNS setup implemented - using view statements: + using view statements:

+
view "internal" {
       // This should match our internal networks.
       match-clients { 10.0.0.0/8; };
@@ -7293,12 +7922,15 @@ view "external" {
       };
 };
 
- -
+ +
+

-zone +zone Statement Grammar

-
zone zone_name [class] {
+          
+
+
zone zone_name [class] {
     type master;
     [ allow-query { address_match_list }; ]
     [ allow-query-on { address_match_list }; ]
@@ -7485,26 +8117,32 @@ zone zone_name [
-
-
+ +
+

-zone Statement Definition and Usage

-
+zone Statement Definition and Usage
+ +

-Zone Types

-

- The type keyword is required - for the zone configuration. Its +Zone Types

+ + +

+ The type keyword is required + for the zone configuration. Its acceptable values include: delegation-only, forward, hint, master, redirect, slave, static-stub, and stub.

-
+ +
+
--++ @@ -7531,7 +8169,7 @@ zone zone_name [

A slave zone is a replica of a master - zone. The masters list + zone. The masters list specifies one or more IP addresses of master servers that the slave contacts to update its copy of the zone. @@ -7646,14 +8284,14 @@ zone zone_name [

Zone data is configured via the - server-addresses and - server-names zone options. + server-addresses and + server-names zone options.

The zone data is maintained in the form of NS and (if necessary) glue A or AAAA RRs internally, which can be seen by dumping zone - databases by rndc dumpdb -all. + databases by rndc dumpdb -all. The configured RRs are considered local configuration parameters rather than public data. Non recursive queries (i.e., those with the RD @@ -7684,22 +8322,22 @@ zone zone_name [

A "forward zone" is a way to configure - forwarding on a per-domain basis. A zone statement - of type forward can - contain a forward - and/or forwarders + forwarding on a per-domain basis. A zone statement + of type forward can + contain a forward + and/or forwarders statement, which will apply to queries within the domain given by the zone - name. If no forwarders + name. If no forwarders statement is present or - an empty list for forwarders is given, then no + an empty list for forwarders is given, then no forwarding will be done for the domain, canceling the effects of - any forwarders in the options statement. Thus + any forwarders in the options statement. Thus if you want to use this type of zone to change the behavior of the - global forward option + global forward option (that is, "forward first" to, then "forward only", or vice versa, but want to use the same @@ -7741,7 +8379,7 @@ zone zone_name [allow-query can be + per view. allow-query can be used to restrict which clients see these answers.

@@ -7778,10 +8416,10 @@ zone zone_name [rndc reload + rndc reload zonename to reload a redirect zone. However, when using - rndc reload without specifying + rndc reload without specifying a zone name, redirect zones will be reloaded along with other zones.

@@ -7809,22 +8447,25 @@ zone zone_name [

- See caveats in root-delegation-only. + See caveats in root-delegation-only.

-
- -
+ +
+ + +

-Class

-

+Class

+ +

The zone's name may optionally be followed by a class. If a class is not specified, class IN (for Internet), is assumed. This is correct for the vast majority of cases.

-

+

The hesiod class is named for an information service from MIT's Project Athena. It is @@ -7833,53 +8474,71 @@ zone zone_name [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
-

+Zone Options

+ + + +
+
allow-notify
+
+

See the description of - allow-notify in the section called “Access Control”. -

-
allow-query
-

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

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

+ allow-query-on in the section called “Access Control”. +

+
+
allow-transfer
+
+

+ See the description of allow-transfer + in the section called “Access Control”. +

+
+
allow-update
+
+

+ See the description of allow-update + in the section called “Access Control”. +

+
+
update-policy
+
+

Specifies a "Simple Secure Update" policy. See - the section called “Dynamic Update Policies”. -

-
allow-update-forwarding
-

- See the description of allow-update-forwarding - in the section called “Access Control”. -

-
also-notify
-

- Only meaningful if notify + the section called “Dynamic Update Policies”. +

+
+
allow-update-forwarding
+
+

+ See the description of allow-update-forwarding + in the section called “Access Control”. +

+
+
also-notify
+
+

+ Only meaningful if notify is active for this zone. The set of machines that will receive a @@ -7888,92 +8547,115 @@ zone zone_name [also-notify. A port + with also-notify. A port may be specified - with each also-notify + with each also-notify address to send the notify messages to a port other than the default of 53. A TSIG key may also be specified to cause the NOTIFY to be signed by the given key. - also-notify is not + also-notify is not meaningful for stub zones. The default is the empty list. -

-
check-names
-

+

+
+
check-names
+
+

This option is used to restrict the character set and syntax of certain domain names in master files and/or DNS responses received from the - network. The default varies according to zone type. For master zones the default is fail. For slave - zones the default is warn. - It is not implemented for hint zones. -

-
check-mx
-

- See the description of - check-mx in the section called “Boolean Options”. -

-
check-spf
-

- See the description of - check-spf in the section called “Boolean Options”. -

-
check-wildcard
-

- See the description of - check-wildcard in the section called “Boolean Options”. -

-
check-integrity
-

- See the description of - check-integrity in the section called “Boolean Options”. -

-
check-sibling
-

- See the description of - check-sibling in the section called “Boolean Options”. -

-
zero-no-soa-ttl
-

- See the description of - zero-no-soa-ttl in the section called “Boolean Options”. -

-
update-check-ksk
-

- See the description of - update-check-ksk in the section called “Boolean Options”. -

-
dnssec-loadkeys-interval
-

- See the description of - dnssec-loadkeys-interval in the section called “options Statement Definition and - Usage”. -

-
dnssec-update-mode
-

- See the description of - dnssec-update-mode in the section called “options Statement Definition and - Usage”. -

-
dnssec-dnskey-kskonly
-

- See the description of - dnssec-dnskey-kskonly in the section called “Boolean Options”. -

-
try-tcp-refresh
-

- See the description of - try-tcp-refresh in the section called “Boolean Options”. -

-
database
+ network. The default varies according to zone type. For master zones the default is fail. For slave + zones the default is warn. + It is not implemented for hint zones. +

+ +
check-mx
-

+

+ See the description of + check-mx in the section called “Boolean Options”. +

+
+
check-spf
+
+

+ See the description of + check-spf in the section called “Boolean Options”. +

+
+
check-wildcard
+
+

+ See the description of + check-wildcard in the section called “Boolean Options”. +

+
+
check-integrity
+
+

+ See the description of + check-integrity in the section called “Boolean Options”. +

+
+
check-sibling
+
+

+ See the description of + check-sibling in the section called “Boolean Options”. +

+
+
zero-no-soa-ttl
+
+

+ See the description of + zero-no-soa-ttl in the section called “Boolean Options”. +

+
+
update-check-ksk
+
+

+ See the description of + update-check-ksk in the section called “Boolean Options”. +

+
+
dnssec-loadkeys-interval
+
+

+ See the description of + dnssec-loadkeys-interval in the section called “options Statement Definition and + Usage”. +

+
+
dnssec-update-mode
+
+

+ See the description of + dnssec-update-mode in the section called “options Statement Definition and + Usage”. +

+
+
dnssec-dnskey-kskonly
+
+

+ See the description of + dnssec-dnskey-kskonly in the section called “Boolean Options”. +

+
+
try-tcp-refresh
+
+

+ See the description of + try-tcp-refresh in the section called “Boolean Options”. +

+
+
database
+
+

Specify the type of database to be used for storing the - zone data. The string following the database keyword + zone data. The string following the database keyword is interpreted as a list of whitespace-delimited words. The first word identifies the database type, and any subsequent words are @@ -7982,53 +8664,60 @@ zone zone_name [ -

+

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

+

+ See the description of + dialup in the section called “Boolean Options”. +

+
+
delegation-only
+
+

The flag only applies to forward, hint and stub zones. If set to yes, then the zone will also be treated as if it is also a delegation-only type zone.

-

- See caveats in root-delegation-only. +

+ See caveats in root-delegation-only.

-
-
forward
-

+

+
forward
+
+

Only meaningful if the zone has a forwarders - list. The only value causes + list. The only value causes the lookup to fail - after trying the forwarders and getting no answer, while first would + after trying the forwarders and getting no answer, while first would allow a normal lookup to be tried. -

-
forwarders
-

+

+
+
forwarders
+
+

Used to override the list of global forwarders. - If it is not specified in a zone of type forward, + 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
-

+

+
+
ixfr-base
+
+

Was used in BIND 8 to specify the name of the transaction log (journal) file for dynamic update @@ -8038,79 +8727,103 @@ zone zone_name [.jnl" to the name of the zone file. -

-
ixfr-tmp-file
-

+

+
+
ixfr-tmp-file
+
+

Was an undocumented option in BIND 8. Ignored in BIND 9. -

-
journal
-

+

+
+
journal
+
+

Allow the default journal's filename to be overridden. The default is the zone's filename with ".jnl" appended. - This is applicable to master and slave zones. -

-
max-journal-size
-

+ This is applicable to master and slave zones. +

+
+
max-journal-size
+
+

See the description of - max-journal-size in the section called “Server Resource Limits”. -

-
max-transfer-time-in
-

+ max-journal-size 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
-

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

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

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

+ max-transfer-idle-out in the section called “Zone Transfers”. +

+
+
notify
+
+

See the description of - notify in the section called “Boolean Options”. -

-
notify-delay
-

+ notify in the section called “Boolean Options”. +

+
+
notify-delay
+
+

See the description of - notify-delay in the section called “Tuning”. -

-
notify-to-soa
-

+ notify-delay in the section called “Tuning”. +

+
+
notify-to-soa
+
+

See the description of - notify-to-soa in - the section called “Boolean Options”. -

-
pubkey
-

+ notify-to-soa in + the section called “Boolean Options”. +

+
+
pubkey
+
+

In BIND 8, this option was intended for specifying a public zone key for verification of signatures in DNSSEC signed zones when they are loaded from disk. BIND 9 does not verify signatures on load and ignores the option. -

-
zone-statistics
-

- See the description of - zone-statistics in - the section called “options Statement Definition and - Usage”. -

-
server-addresses
+

+ +
zone-statistics
-

+

+ See the description of + zone-statistics in + the section called “options Statement Definition and + Usage”. +

+
+
server-addresses
+
+

Only meaningful for static-stub zones. This is a list of IP addresses to which queries should be sent in recursive resolution for the @@ -8119,16 +8832,16 @@ zone zone_name [ -

+

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, + in a server-addresses option, the following RRs will be internally configured.

example.com. NS example.com.
 example.com. A 192.0.2.1
 example.com. AAAA 2001:db8::1234
-

+

These records are internally used to resolve names under the static-stub zone. For instance, if the server receives a query for @@ -8136,16 +8849,16 @@ example.com. AAAA 2001:db8::1234

will initiate recursive resolution and send queries to 192.0.2.1 and/or 2001:db8::1234.

- -
server-names
+ +
server-names
-

+

Only meaningful for static-stub zones. This is a list of domain names of nameservers that act as authoritative servers of the static-stub zone. These names will be resolved to IP addresses when - named needs to send queries to + named needs to send queries to these servers. To make this supplemental resolution successful, these names must not be a subdomain of the origin @@ -8153,23 +8866,23 @@ example.com. AAAA 2001:db8::1234

That is, when "example.net" is the origin of a static-stub zone, "ns.example" and "master.example.com" can be specified in the - server-names option, but + server-names option, but "ns.example.net" cannot, and will be rejected by the configuration parser.

-

+

A non empty list for this option will internally configure the apex NS RR with the specified names. For example, if "example.com" is configured as a static-stub zone with "ns1.example.net" and "ns2.example.net" - in a server-names option, + in a server-names option, the following RRs will be internally configured.

example.com. NS ns1.example.net.
 example.com. NS ns2.example.net.
 
-

+

These records are internally used to resolve names under the static-stub zone. For instance, if the server receives a query for @@ -8179,143 +8892,182 @@ example.com. NS ns2.example.net. "ns2.example.net" to IP addresses, and then send queries to (one or more of) these addresses.

- -
sig-validity-interval
-

+

+
sig-validity-interval
+
+

See the description of - sig-validity-interval in the section called “Tuning”. -

-
sig-signing-nodes
-

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

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

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

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

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

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

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

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

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

+ notify-source in the section called “Zone Transfers”. +

+
+
notify-source-v6
+
+

See the description of - notify-source-v6 in the section called “Zone Transfers”. -

+ notify-source-v6 in the section called “Zone Transfers”. +

+
-min-refresh-time, max-refresh-time, min-retry-time, max-retry-time +min-refresh-time, max-refresh-time, min-retry-time, max-retry-time
-

- See the description in the section called “Tuning”. -

-
ixfr-from-differences
-

+

+

+ See the description 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 + ixfr-from-differences in the section called “Boolean Options”. + (Note that the ixfr-from-differences master and slave choices are not available at the zone level.) -

-
key-directory
-

+

+
+
key-directory
+
+

See the description of - key-directory in the section called “options Statement Definition and + key-directory in the section called “options Statement Definition and Usage”. -

-
auto-dnssec
-

+

+
+
auto-dnssec
+
+

See the description of - auto-dnssec in - the section called “options Statement Definition and + auto-dnssec in + the section called “options Statement Definition and Usage”. -

-
serial-update-method
-

+

+
+
serial-update-method
+
+

See the description of - serial-update-method in - the section called “options Statement Definition and + serial-update-method in + the section called “options Statement Definition and Usage”. -

-
inline-signing
-

+

+
+
inline-signing
+
+

If yes, this enables "bump in the wire" signing of a zone, where a unsigned zone is transferred in or loaded from disk and a signed version of the zone is served, with possibly, a different serial number. This behaviour is disabled by default. -

-
multi-master
-

- See the description of multi-master in - the section called “Boolean Options”. -

-
masterfile-format
-

- See the description of masterfile-format - in the section called “Tuning”. -

-
dnssec-secure-to-insecure
-

+

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

+
+
dnssec-secure-to-insecure
+
+

See the description of - dnssec-secure-to-insecure in the section called “Boolean Options”. -

+ dnssec-secure-to-insecure in the section called “Boolean Options”. +

+ - -
+ +
+

Dynamic Update Policies

-

BIND 9 supports two alternative + +

BIND 9 supports two alternative methods of granting clients the right to perform dynamic updates to a zone, configured by the - allow-update and - update-policy option, respectively. + allow-update and + update-policy option, respectively.

-

- The allow-update clause works the +

+ The allow-update clause works the same way as in previous versions of BIND. It grants given clients the permission to update any record of any name in the zone.

-

- The update-policy clause +

+ The update-policy clause allows more fine-grained control over what updates are allowed. A set of rules is specified, where each rule either grants or denies permissions for one or more @@ -8324,51 +9076,56 @@ example.com. NS ns2.example.net. it includes either a TSIG or SIG(0) record), the identity of the signer can be determined.

-

- Rules are specified in the update-policy +

+ Rules are specified in the update-policy zone option, and are only meaningful for master zones. - When the update-policy statement + When the update-policy statement is present, it is a configuration error for the - allow-update statement to be - present. The update-policy statement + allow-update statement to be + present. The update-policy statement only examines the signer of a message; the source address is not relevant.

-

- There is a pre-defined update-policy +

+ There is a pre-defined update-policy rule which can be switched on with the command - update-policy local;. + update-policy local;. Switching on this rule in a zone causes - named to generate a TSIG session + named to generate a TSIG session key and place it in a file, and to allow that key to update the zone. (By default, the file is /var/run/named/session.key, the key name is "local-ddns" and the key algorithm is HMAC-SHA256, but these values are configurable with the - session-keyfile, - session-keyname and - session-keyalg options, respectively). + session-keyfile, + session-keyname and + session-keyalg options, respectively).

-

+

A client running on the local system, and with appropriate permissions, may read that file and use the key to sign update requests. The zone's update policy will be set to allow that key to change any record within the zone. Assuming the key name is "local-ddns", this policy is equivalent to:

-
update-policy { grant local-ddns zonesub any; };
+
+            
update-policy { grant local-ddns zonesub any; };
             
-

- The command nsupdate -l sends update + +

+ The command nsupdate -l sends update requests to localhost, and signs them using the session key.

-

+ +

Other rule definitions look like this:

+
-( grant | deny ) identity nametype [ name ] [ types ]
+( grant | deny ) identity nametype [ name ] [ types ]
 
-

+ +

Each rule grants or denies privileges. Once a message has successfully matched a rule, the operation is immediately granted or denied and no further rules are examined. A rule @@ -8377,13 +9134,13 @@ example.com. NS ns2.example.net. field, and the type matches the types specified in the type field.

-

+

No signer is required for tcp-self or 6to4-self however the standard reverse mapping / prefix conversion must match the identity field.

-

+

The identity field specifies a name or a wildcard name. Normally, this is the name of the TSIG or SIG(0) key used to sign the update request. When a @@ -8400,14 +9157,14 @@ example.com. NS ns2.example.net. The identity field must contain a fully-qualified domain name.

-

+

For nametypes krb5-self, ms-self, krb5-subdomain, and ms-subdomain the identity field specifies the Windows or Kerberos realm of the machine belongs to.

-

+

The nametype field has 13 values: name, subdomain, @@ -8419,10 +9176,11 @@ example.com. NS ns2.example.net. tcp-self, 6to4-self, zonesub, and external.

-
+
+
--++ @@ -8466,10 +9224,10 @@ example.com. NS ns2.example.net. This rule is similar to subdomain, except that it matches when the name being updated is a subdomain of the zone in which the - update-policy statement + update-policy statement appears. This obviates the need to type the zone name twice, and enables the use of a standard - update-policy statement in + update-policy statement in multiple zones without modification.

@@ -8662,7 +9420,7 @@ example.com. NS ns2.example.net.

-

- This rule allows named + This rule allows named to defer the decision of whether to allow a given update to an external daemon.

@@ -8699,12 +9457,15 @@ example.com. NS ns2.example.net.
-

+ +

+ +

In all cases, the name field must specify a fully-qualified domain name.

-

+ +

If no types are explicitly specified, this rule matches all types except RRSIG, NS, SOA, NSEC and NSEC3. Types may be specified by name, including "ANY" (ANY matches @@ -8713,26 +9474,30 @@ example.com. NS ns2.example.net. all records associated with a name, the rules are checked for each existing record type.

- - - -
+
+ + +

-Zone File

-
+Zone File
+ +

Types of Resource Records and When to Use Them

-

+ +

This section, largely borrowed from RFC 1034, describes the concept of a Resource Record (RR) and explains when each is used. Since the publication of RFC 1034, several new RRs have been identified and implemented in the DNS. These are also included.

-
+

-Resource Records

-

+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 @@ -8740,15 +9505,17 @@ example.com. NS ns2.example.net. need not be preserved by name servers, resolvers, or other parts of the DNS. However, sorting of multiple RRs is 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”. + 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:

-
+
+
--++ @@ -8820,14 +9587,16 @@ example.com. NS ns2.example.net. -
-

+ + +

The following are types of valid RRs:

-
+
+
--++ @@ -9805,15 +10574,17 @@ example.com. NS ns2.example.net. -
-

+ + +

The following classes of resource records are currently valid in the DNS:

-
+
+
--++ @@ -9863,8 +10634,10 @@ example.com. NS ns2.example.net. -
-

+ + + +

The owner name is often implicit, rather than forming an integral part of the RR. For example, many name servers internally form @@ -9875,7 +10648,7 @@ example.com. NS ns2.example.net. that fits the needs of the resource being described.

-

+

The meaning of the TTL field is a time limit on how long an RR can be kept in a cache. This limit does not apply to authoritative @@ -9895,17 +10668,18 @@ example.com. NS ns2.example.net. 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

-

+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 @@ -9918,13 +10692,13 @@ example.com. NS ns2.example.net. possible using parentheses.

-

+

The start of the line gives the owner of the RR. If a line begins with a blank, then the owner is assumed to be the same as that of the previous RR. Blank lines are often included for readability.

-

+

Following the owner, we list the TTL, type, and class of the RR. Class and type use the mnemonics defined above, and TTL is an integer before the type field. In order to avoid ambiguity @@ -9935,18 +10709,19 @@ example.com. NS ns2.example.net. values are often omitted from examples in the interests of clarity.

-

+

The resource data or RDATA section of the RR are given using knowledge of the typical representation for the data.

-

+

For example, we might show the RRs carried in a message as:

-
+
+
---+++ @@ -10046,25 +10821,27 @@ example.com. NS ns2.example.net. -
-

+ + +

The MX RRs have an RDATA section which consists of a 16-bit number followed by a domain name. The address RRs use a standard IP address format to contain a 32-bit internet address.

-

+

The above example shows six RRs, with two RRs at each of three domain names.

-

+

Similarly we might see:

-
+
+
---+++ @@ -10098,17 +10875,21 @@ example.com. NS ns2.example.net. -
-

+ + +

This example shows two addresses for XX.LCS.MIT.EDU, each of a different class.

- - -
+
+ + +

-Discussion of MX Records

-

+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, @@ -10117,7 +10898,8 @@ example.com. NS ns2.example.net. 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 @@ -10134,7 +10916,7 @@ example.com. NS ns2.example.net. It must have an associated address record (A or AAAA) — CNAME is not sufficient.

-

+

For a given domain, if there is both a CNAME record and an MX record, the MX record is in error, and will be ignored. Instead, @@ -10143,13 +10925,14 @@ example.com. NS ns2.example.net. pointed to by the CNAME. For example:

-
+
+
-----+++++ @@ -10280,18 +11063,20 @@ example.com. NS ns2.example.net. -
+ +

Mail delivery will be attempted to mail.example.com and mail2.example.com (in any order), and if neither of those succeed, delivery to mail.backup.org will be attempted.

- -
+
+

Setting TTLs

-

+ +

The time-to-live of the RR field is a 32-bit integer represented in units of seconds, and is primarily used by resolvers when they cache RRs. The TTL describes how long a RR can be cached before it @@ -10299,10 +11084,11 @@ example.com. NS ns2.example.net. currently used in a zone file.

-
+
+
--++ @@ -10354,16 +11140,18 @@ example.com. NS ns2.example.net. -
-

+ +

+

All of these TTLs default to units of seconds, though units can be explicitly specified, for example, 1h30m.

- -
+
+

-Inverse Mapping in IPv4

-

+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 @@ -10378,10 +11166,11 @@ example.com. NS ns2.example.net. PTR records if the machine has more than one name. For example, in the [example.com] domain:

-
+
+
--++ @@ -10409,22 +11198,24 @@ example.com. NS ns2.example.net. -
-
+ +
+

Note

-

- The $ORIGIN lines in the examples +

+ The $ORIGIN lines in the examples are for providing context to the examples only — they do not necessarily appear in the actual usage. They are only used here to indicate that the example is relative to the listed origin.

-
- -
+
+ +

-Other Zone File Directives

-

+Other Zone File Directives

+ +

The Master File Format was initially defined in RFC 1035 and has subsequently been extended. While the Master File Format itself @@ -10432,110 +11223,119 @@ example.com. NS ns2.example.net. same class.

-

- Master File Directives include $ORIGIN, $INCLUDE, - and $TTL. +

+ Master File Directives include $ORIGIN, $INCLUDE, + and $TTL.

-
+

-The @ (at-sign)

-

+The @ (at-sign)

+ +

When used in the label (or name) field, the asperand or at-sign (@) symbol represents the current origin. At the start of the zone file, it is the <zone_name> (followed by trailing dot).

- -
+
+

-The $ORIGIN Directive

-

- Syntax: $ORIGIN +The $ORIGIN Directive

+ +

+ Syntax: $ORIGIN domain-name [comment]

-

$ORIGIN +

$ORIGIN sets the domain name that will be appended to any unqualified records. When a zone is first read in there - is an implicit $ORIGIN - <zone_name>. + is an implicit $ORIGIN + <zone_name>. (followed by trailing dot). - The current $ORIGIN is appended to - the domain specified in the $ORIGIN + The current $ORIGIN is appended to + 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 +The $INCLUDE Directive

+ +

+ Syntax: $INCLUDE filename [ origin ] [ comment ]

-

+

Read and process the file filename as - if it were included into the file at this point. If origin is - specified the file is processed with $ORIGIN set - to that value, otherwise the current $ORIGIN is + if it were included into the file at this point. If origin is + specified the file is processed with $ORIGIN set + to that value, otherwise the current $ORIGIN is used.

-

+

The origin and the current domain name - revert to the values they had prior to the $INCLUDE once + 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 + an $INCLUDE, but it is silent on whether the current domain name should also be restored. BIND 9 restores both of them. This could be construed as a deviation from RFC 1035, a feature, or both.

-
-
-
+
+ +

-The $TTL Directive

-

- Syntax: $TTL +The $TTL Directive

+ +

+ Syntax: $TTL default-ttl [ comment ]

-

+

Set the default Time To Live (TTL) for subsequent records with undefined TTLs. Valid TTLs are of the range 0-2147483647 seconds.

-

$TTL +

$TTL is defined in RFC 2308.

- - -
+
+ +

-BIND Master File Extension: the $GENERATE Directive

-

- Syntax: $GENERATE +BIND Master File Extension: the $GENERATE Directive

+ +

+ Syntax: $GENERATE range lhs [ttl] @@ -10544,20 +11344,23 @@ 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 + iterator. $GENERATE can be used to easily generate the sets of records required to support 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.
@@ -10565,18 +11368,22 @@ $GENERATE 1-127 $ CNAME $.0
... 127.0.0.192.IN-ADDR.ARPA. CNAME 127.0.0.0.192.IN-ADDR.ARPA.
-

+ +

Generate a set of A and MX records. Note the MX's right hand side is a quoted string. The quotes will be stripped when the right hand side is processed.

+
 $ORIGIN EXAMPLE.
 $GENERATE 1-127 HOST-$ A 1.2.3.$
 $GENERATE 1-127 HOST-$ MX "0 ."
-

+ +

is equivalent to

+
HOST-1.EXAMPLE.   A  1.2.3.1
 HOST-1.EXAMPLE.   MX 0 .
 HOST-2.EXAMPLE.   A  1.2.3.2
@@ -10587,15 +11394,17 @@ HOST-3.EXAMPLE.   MX 0 .
 HOST-127.EXAMPLE. A  1.2.3.127
 HOST-127.EXAMPLE. MX 0 .
 
-
+ +
+
--++ -
-

range

+

range

@@ -10609,43 +11418,43 @@ HOST-127.EXAMPLE. MX 0 .

-

lhs

+

lhs

This describes the owner name of the resource records - to be created. Any single $ + to be created. Any single $ (dollar sign) - symbols within the lhs string + symbols within the lhs string are replaced by the iterator value. To get a $ in the output, you need to escape the - $ using a backslash - \, - e.g. \$. The - $ may optionally be followed + $ using a backslash + \, + e.g. \$. The + $ may optionally be followed by modifiers which change the offset from the iterator, field width and base. Modifiers are introduced by a - { (left brace) immediately following the - $ as - ${offset[,width[,base]]}. - For example, ${-20,3,d} + { (left brace) immediately following the + $ as + ${offset[,width[,base]]}. + For example, ${-20,3,d} subtracts 20 from the current value, prints the result as a decimal in a zero-padded field of width 3. Available output forms are decimal - (d), octal - (o), hexadecimal - (x or X + (d), octal + (o), hexadecimal + (x or X for uppercase) and nibble - (n or N\ + (n or N\ for uppercase). The default modifier is - ${0,0,d}. If the - lhs is not absolute, the - current $ORIGIN is appended + ${0,0,d}. If the + lhs is not absolute, the + current $ORIGIN is appended to the name.

@@ -10657,14 +11466,14 @@ HOST-127.EXAMPLE. MX 0 .

For compatibility with earlier versions, - $$ is still recognized as + $$ is still recognized as indicating a literal $ in the output.

-

ttl

+

ttl

@@ -10672,15 +11481,15 @@ HOST-127.EXAMPLE. MX 0 . not specified this will be inherited using the normal TTL inheritance rules.

-

class - and ttl can be +

class + and ttl can be entered in either order.

-

class

+

class

@@ -10688,15 +11497,15 @@ HOST-127.EXAMPLE. MX 0 . This must match the zone class if it is specified.

-

class - and ttl can be +

class + and ttl can be entered in either order.

-

type

+

type

@@ -10706,28 +11515,31 @@ HOST-127.EXAMPLE. MX 0 .

-

rhs

+

rhs

- rhs, optionally, quoted string. + rhs, optionally, quoted string.

-

- The $GENERATE directive is a BIND extension + + +

+ The $GENERATE directive is a BIND extension and not part of the standard zone file format.

-

+

BIND 8 does not support the optional TTL and CLASS fields.

- -
+
+ +

Additional File Formats

-

+ +

In addition to the standard textual format, BIND 9 supports the ability to read or dump to zone files in other formats. The raw format is @@ -10736,26 +11548,26 @@ HOST-127.EXAMPLE. MX 0 . structure directly, thereby remarkably improving the loading time.

-

+

For a primary server, a zone file in the raw format is expected to be generated from a textual zone file by the - named-compilezone command. For a + named-compilezone command. For a secondary server or for a dynamic zone, it is automatically generated (if this format is specified by the - masterfile-format option) when - named dumps the zone contents after + masterfile-format option) when + named dumps the zone contents after zone transfer or when applying prior updates.

-

+

If a zone file in a binary format needs manual modification, it first must be converted to a textual form by the - named-compilezone command. All + named-compilezone command. All necessary modification should go to the text file, which should then be converted to the binary form by the - named-compilezone command again. + named-compilezone command again.

-

+

Although the raw format uses the network byte order and avoids architecture-dependent data alignment so that it is as much portable as @@ -10765,12 +11577,14 @@ HOST-127.EXAMPLE. MX 0 . portable backup of the file, it is recommended to convert the file to the standard textual representation.

-
- -
+
+ + +

BIND9 Statistics

-

+ +

BIND 9 maintains lots of statistics information and provides several interfaces for users to get access to the statistics. @@ -10779,14 +11593,17 @@ HOST-127.EXAMPLE. MX 0 . are meaningful in BIND 9, and other information that is considered useful.

-

+ +

The statistics information is categorized into the following sections.

-
+ +
+
--++ @@ -10881,42 +11698,47 @@ 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 + zone-statistics is set to full (or yes for backward compatibility. See the description of - zone-statistics in the section called “options Statement Definition and + zone-statistics in the section called “options Statement Definition and Usage” for further details.

-

+ +

These statistics counters are shown with their zone and view names. The view name is omitted when the server is not configured with explicit views.

-

+ +

There are currently two user interfaces to get access to the statistics. One is in the plain text format dumped to the file specified - by the statistics-file configuration option. + by the statistics-file configuration option. The other is remotely accessible via a statistics channel - when the statistics-channels statement + when the statistics-channels statement is specified in the configuration file - (see the section called “statistics-channels Statement Grammar”.) + (see the section called “statistics-channels Statement Grammar”.)

-
-

-The Statistics File

-

+ +

+

+The Statistics File

+ +

The text format statistics dump begins with a line, like:

-

- +++ Statistics Dump +++ (973798949) +

+ +++ Statistics Dump +++ (973798949)

-

+

The number in parentheses is a standard Unix-style timestamp, measured as seconds since January 1, 1970. @@ -10925,28 +11747,33 @@ HOST-127.EXAMPLE. MX 0 . as described above. Each section begins with a line, like:

-

- ++ Name Server Statistics ++ + +

+ ++ 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 Dump --- (973798949)

-
-
+
+ +

Statistics Counters

-

+ +

The following tables summarize statistics counters that BIND 9 provides. For each row of the tables, the leftmost column is the @@ -10962,14 +11789,18 @@ HOST-127.EXAMPLE. MX 0 . it gives the corresponding counter name of the BIND 8 statistics, if applicable.

-
+ +

-Name Server Statistics Counters

-
+Name Server Statistics Counters + + +
+
---+++ @@ -10991,10 +11822,10 @@ HOST-127.EXAMPLE. MX 0 . -
-

Requestv4

+

Requestv4

-

RQ

+

RQ

@@ -11005,10 +11836,10 @@ HOST-127.EXAMPLE. MX 0 .

-

Requestv6

+

Requestv6

-

RQ

+

RQ

@@ -11019,10 +11850,10 @@ HOST-127.EXAMPLE. MX 0 .

-

ReqEdns0

+

ReqEdns0

-

+

@@ -11032,10 +11863,10 @@ HOST-127.EXAMPLE. MX 0 .

-

ReqBadEDNSVer

+

ReqBadEDNSVer

-

+

@@ -11045,10 +11876,10 @@ HOST-127.EXAMPLE. MX 0 .

-

ReqTSIG

+

ReqTSIG

-

+

@@ -11058,10 +11889,10 @@ HOST-127.EXAMPLE. MX 0 .

-

ReqSIG0

+

ReqSIG0

-

+

@@ -11071,10 +11902,10 @@ HOST-127.EXAMPLE. MX 0 .

-

ReqBadSIG

+

ReqBadSIG

-

+

@@ -11084,10 +11915,10 @@ HOST-127.EXAMPLE. MX 0 .

-

ReqTCP

+

ReqTCP

-

RTCP

+

RTCP

@@ -11097,10 +11928,10 @@ HOST-127.EXAMPLE. MX 0 .

-

AuthQryRej

+

AuthQryRej

-

RUQ

+

RUQ

@@ -11110,10 +11941,10 @@ HOST-127.EXAMPLE. MX 0 .

-

RecQryRej

+

RecQryRej

-

RURQ

+

RURQ

@@ -11123,10 +11954,10 @@ HOST-127.EXAMPLE. MX 0 .

-

XfrRej

+

XfrRej

-

RUXFR

+

RUXFR

@@ -11136,10 +11967,10 @@ HOST-127.EXAMPLE. MX 0 .

-

UpdateRej

+

UpdateRej

-

RUUpd

+

RUUpd

@@ -11149,10 +11980,10 @@ HOST-127.EXAMPLE. MX 0 .

-

Response

+

Response

-

SAns

+

SAns

@@ -11162,10 +11993,10 @@ HOST-127.EXAMPLE. MX 0 .

-

RespTruncated

+

RespTruncated

-

+

@@ -11175,10 +12006,10 @@ HOST-127.EXAMPLE. MX 0 .

-

RespEDNS0

+

RespEDNS0

-

+

@@ -11188,10 +12019,10 @@ HOST-127.EXAMPLE. MX 0 .

-

RespTSIG

+

RespTSIG

-

+

@@ -11201,10 +12032,10 @@ HOST-127.EXAMPLE. MX 0 .

-

RespSIG0

+

RespSIG0

-

+

@@ -11214,10 +12045,10 @@ HOST-127.EXAMPLE. MX 0 .

-

QrySuccess

+

QrySuccess

-

+

@@ -11225,7 +12056,7 @@ HOST-127.EXAMPLE. MX 0 . This means the query which returns a NOERROR response with at least one answer RR. This corresponds to the - success counter + success counter of previous versions of BIND 9.

@@ -11233,10 +12064,10 @@ HOST-127.EXAMPLE. MX 0 .
-

QryAuthAns

+

QryAuthAns

-

+

@@ -11246,10 +12077,10 @@ HOST-127.EXAMPLE. MX 0 .

-

QryNoauthAns

+

QryNoauthAns

-

SNaAns

+

SNaAns

@@ -11259,16 +12090,16 @@ HOST-127.EXAMPLE. MX 0 .

-

QryReferral

+

QryReferral

-

+

Queries resulted in referral answer. This corresponds to the - referral counter + referral counter of previous versions of BIND 9.

@@ -11276,16 +12107,16 @@ HOST-127.EXAMPLE. MX 0 .
-

QryNxrrset

+

QryNxrrset

-

+

Queries resulted in NOERROR responses with no data. This corresponds to the - nxrrset counter + nxrrset counter of previous versions of BIND 9.

@@ -11293,10 +12124,10 @@ HOST-127.EXAMPLE. MX 0 .
-

QrySERVFAIL

+

QrySERVFAIL

-

SFail

+

SFail

@@ -11306,10 +12137,10 @@ HOST-127.EXAMPLE. MX 0 .

-

QryFORMERR

+

QryFORMERR

-

SFErr

+

SFErr

@@ -11319,16 +12150,16 @@ HOST-127.EXAMPLE. MX 0 .

-

QryNXDOMAIN

+

QryNXDOMAIN

-

SNXD

+

SNXD

Queries resulted in NXDOMAIN. This corresponds to the - nxdomain counter + nxdomain counter of previous versions of BIND 9.

@@ -11336,17 +12167,17 @@ HOST-127.EXAMPLE. MX 0 .
-

QryRecursion

+

QryRecursion

-

RFwdQ

+

RFwdQ

Queries which caused the server to perform recursion in order to find the final answer. This corresponds to the - recursion counter + recursion counter of previous versions of BIND 9.

@@ -11354,10 +12185,10 @@ HOST-127.EXAMPLE. MX 0 .
-

QryDuplicate

+

QryDuplicate

-

RDupQ

+

RDupQ

@@ -11366,7 +12197,7 @@ HOST-127.EXAMPLE. MX 0 . IP address, port, query ID, name, type and class already being processed. This corresponds to the - duplicate counter + duplicate counter of previous versions of BIND 9.

@@ -11374,10 +12205,10 @@ HOST-127.EXAMPLE. MX 0 .
-

QryDropped

+

QryDropped

-

+

@@ -11387,14 +12218,14 @@ HOST-127.EXAMPLE. MX 0 . class and were subsequently dropped. This is the number of dropped queries due to the reason explained with the - clients-per-query + clients-per-query and - max-clients-per-query + max-clients-per-query options (see the description about - clients-per-query.) + clients-per-query.) This corresponds to the - dropped counter + dropped counter of previous versions of BIND 9.

@@ -11402,23 +12233,23 @@ HOST-127.EXAMPLE. MX 0 .
-

QryFailure

+

QryFailure

-

+

Other query failures. This corresponds to the - failure counter + failure counter of previous versions of BIND 9. Note: this counter is provided mainly for backward compatibility with the previous versions. Normally a more fine-grained counters such as - AuthQryRej and - RecQryRej + AuthQryRej and + RecQryRej that would also fall into this counter are provided, and so this counter would not be of much interest in practice. @@ -11427,10 +12258,10 @@ HOST-127.EXAMPLE. MX 0 .

-

XfrReqDone

+

XfrReqDone

-

+

@@ -11440,10 +12271,10 @@ HOST-127.EXAMPLE. MX 0 .

-

UpdateReqFwd

+

UpdateReqFwd

-

+

@@ -11453,10 +12284,10 @@ HOST-127.EXAMPLE. MX 0 .

-

UpdateRespFwd

+

UpdateRespFwd

-

+

@@ -11466,10 +12297,10 @@ HOST-127.EXAMPLE. MX 0 .

-

UpdateFwdFail

+

UpdateFwdFail

-

+

@@ -11479,10 +12310,10 @@ HOST-127.EXAMPLE. MX 0 .

-

UpdateDone

+

UpdateDone

-

+

@@ -11492,10 +12323,10 @@ HOST-127.EXAMPLE. MX 0 .

-

UpdateFail

+

UpdateFail

-

+

@@ -11505,10 +12336,10 @@ HOST-127.EXAMPLE. MX 0 .

-

UpdateBadPrereq

+

UpdateBadPrereq

-

+

@@ -11518,10 +12349,10 @@ HOST-127.EXAMPLE. MX 0 .

-

RPZRewrites

+

RPZRewrites

-

+

@@ -11531,10 +12362,10 @@ HOST-127.EXAMPLE. MX 0 .

-

RateDropped

+

RateDropped

-

+

@@ -11544,10 +12375,10 @@ HOST-127.EXAMPLE. MX 0 .

-

RateSlipped

+

RateSlipped

-

+

@@ -11556,15 +12387,20 @@ HOST-127.EXAMPLE. MX 0 .

-
-
+ +
+
+ +

-Zone Maintenance Statistics Counters

-
+Zone Maintenance Statistics Counters + + +
+
--++ @@ -11581,7 +12417,7 @@ HOST-127.EXAMPLE. MX 0 . -
-

NotifyOutv4

+

NotifyOutv4

@@ -11591,7 +12427,7 @@ HOST-127.EXAMPLE. MX 0 .

-

NotifyOutv6

+

NotifyOutv6

@@ -11601,7 +12437,7 @@ HOST-127.EXAMPLE. MX 0 .

-

NotifyInv4

+

NotifyInv4

@@ -11611,7 +12447,7 @@ HOST-127.EXAMPLE. MX 0 .

-

NotifyInv6

+

NotifyInv6

@@ -11621,7 +12457,7 @@ HOST-127.EXAMPLE. MX 0 .

-

NotifyRej

+

NotifyRej

@@ -11631,7 +12467,7 @@ HOST-127.EXAMPLE. MX 0 .

-

SOAOutv4

+

SOAOutv4

@@ -11641,7 +12477,7 @@ HOST-127.EXAMPLE. MX 0 .

-

SOAOutv6

+

SOAOutv6

@@ -11651,7 +12487,7 @@ HOST-127.EXAMPLE. MX 0 .

-

AXFRReqv4

+

AXFRReqv4

@@ -11661,7 +12497,7 @@ HOST-127.EXAMPLE. MX 0 .

-

AXFRReqv6

+

AXFRReqv6

@@ -11671,7 +12507,7 @@ HOST-127.EXAMPLE. MX 0 .

-

IXFRReqv4

+

IXFRReqv4

@@ -11681,7 +12517,7 @@ HOST-127.EXAMPLE. MX 0 .

-

IXFRReqv6

+

IXFRReqv6

@@ -11691,7 +12527,7 @@ HOST-127.EXAMPLE. MX 0 .

-

XfrSuccess

+

XfrSuccess

@@ -11701,7 +12537,7 @@ HOST-127.EXAMPLE. MX 0 .

-

XfrFail

+

XfrFail

@@ -11710,16 +12546,21 @@ HOST-127.EXAMPLE. MX 0 .

-
-
+ +
+
+ +

-Resolver Statistics Counters

-
+Resolver Statistics Counters + + +
+
---+++ @@ -11741,10 +12582,10 @@ HOST-127.EXAMPLE. MX 0 . -
-

Queryv4

+

Queryv4

-

SFwdQ

+

SFwdQ

@@ -11754,10 +12595,10 @@ HOST-127.EXAMPLE. MX 0 .

-

Queryv6

+

Queryv6

-

SFwdQ

+

SFwdQ

@@ -11767,10 +12608,10 @@ HOST-127.EXAMPLE. MX 0 .

-

Responsev4

+

Responsev4

-

RR

+

RR

@@ -11780,10 +12621,10 @@ HOST-127.EXAMPLE. MX 0 .

-

Responsev6

+

Responsev6

-

RR

+

RR

@@ -11793,10 +12634,10 @@ HOST-127.EXAMPLE. MX 0 .

-

NXDOMAIN

+

NXDOMAIN

-

RNXD

+

RNXD

@@ -11806,10 +12647,10 @@ HOST-127.EXAMPLE. MX 0 .

-

SERVFAIL

+

SERVFAIL

-

RFail

+

RFail

@@ -11819,10 +12660,10 @@ HOST-127.EXAMPLE. MX 0 .

-

FORMERR

+

FORMERR

-

RFErr

+

RFErr

@@ -11832,10 +12673,10 @@ HOST-127.EXAMPLE. MX 0 .

-

OtherError

+

OtherError

-

RErr

+

RErr

@@ -11845,10 +12686,10 @@ HOST-127.EXAMPLE. MX 0 .

-

EDNS0Fail

+

EDNS0Fail

-

+

@@ -11858,10 +12699,10 @@ HOST-127.EXAMPLE. MX 0 .

-

Mismatch

+

Mismatch

-

RDupR

+

RDupR

@@ -11870,7 +12711,7 @@ HOST-127.EXAMPLE. MX 0 . and/or the response's source port does not match what was expected. (The port must be 53 or as defined by - the port option.) + the port option.) This may be an indication of a cache poisoning attempt.

@@ -11878,10 +12719,10 @@ HOST-127.EXAMPLE. MX 0 .
-

Truncated

+

Truncated

-

+

@@ -11891,10 +12732,10 @@ HOST-127.EXAMPLE. MX 0 .

-

Lame

+

Lame

-

RLame

+

RLame

@@ -11904,10 +12745,10 @@ HOST-127.EXAMPLE. MX 0 .

-

Retry

+

Retry

-

SDupQ

+

SDupQ

@@ -11917,10 +12758,10 @@ HOST-127.EXAMPLE. MX 0 .

-

QueryAbort

+

QueryAbort

-

+

@@ -11930,10 +12771,10 @@ HOST-127.EXAMPLE. MX 0 .

-

QuerySockFail

+

QuerySockFail

-

+

@@ -11946,10 +12787,10 @@ HOST-127.EXAMPLE. MX 0 .

-

QueryTimeout

+

QueryTimeout

-

+

@@ -11959,10 +12800,10 @@ HOST-127.EXAMPLE. MX 0 .

-

GlueFetchv4

+

GlueFetchv4

-

SSysQ

+

SSysQ

@@ -11972,10 +12813,10 @@ HOST-127.EXAMPLE. MX 0 .

-

GlueFetchv6

+

GlueFetchv6

-

SSysQ

+

SSysQ

@@ -11985,10 +12826,10 @@ HOST-127.EXAMPLE. MX 0 .

-

GlueFetchv4Fail

+

GlueFetchv4Fail

-

+

@@ -11998,10 +12839,10 @@ HOST-127.EXAMPLE. MX 0 .

-

GlueFetchv6Fail

+

GlueFetchv6Fail

-

+

@@ -12011,10 +12852,10 @@ HOST-127.EXAMPLE. MX 0 .

-

ValAttempt

+

ValAttempt

-

+

@@ -12024,10 +12865,10 @@ HOST-127.EXAMPLE. MX 0 .

-

ValOk

+

ValOk

-

+

@@ -12037,10 +12878,10 @@ HOST-127.EXAMPLE. MX 0 .

-

ValNegOk

+

ValNegOk

-

+

@@ -12050,10 +12891,10 @@ HOST-127.EXAMPLE. MX 0 .

-

ValFail

+

ValFail

-

+

@@ -12063,60 +12904,67 @@ HOST-127.EXAMPLE. MX 0 .

-

QryRTTnn

+

QryRTTnn

-

+

Frequency table on round trip times (RTTs) of queries. - Each nn specifies the corresponding + Each nn specifies the corresponding frequency. In the sequence of - nn_1, - nn_2, + nn_1, + nn_2, ..., - nn_m, - the value of nn_i is the + nn_m, + the value of nn_i is the number of queries whose RTTs are between - nn_(i-1) (inclusive) and - nn_i (exclusive) milliseconds. + nn_(i-1) (inclusive) and + nn_i (exclusive) milliseconds. For the sake of convenience we define - nn_0 to be 0. + nn_0 to be 0. The last entry should be represented as - nn_m+, which means the + nn_m+, which means the number of queries whose RTTs are equal to or over - nn_m milliseconds. + nn_m milliseconds.

-
-
+ +
+ +
+ +

-Socket I/O Statistics Counters

-

+Socket I/O Statistics Counters

+ + +

Socket I/O statistics counters are defined per socket types, which are - UDP4 (UDP/IPv4), - UDP6 (UDP/IPv6), - TCP4 (TCP/IPv4), - TCP6 (TCP/IPv6), - Unix (Unix Domain), and - FDwatch (sockets opened outside the + UDP4 (UDP/IPv4), + UDP6 (UDP/IPv6), + TCP4 (TCP/IPv4), + TCP6 (TCP/IPv6), + Unix (Unix Domain), and + FDwatch (sockets opened outside the socket module). - In the following table <TYPE> + In the following table <TYPE> represents a socket type. Not all counters are available for all socket types; exceptions are noted in the description field.

-
+ +
+
--++ @@ -12133,31 +12981,31 @@ HOST-127.EXAMPLE. MX 0 . -
-

<TYPE>Open

+

<TYPE>Open

Sockets opened successfully. This counter is not applicable to the - FDwatch type. + FDwatch type.

-

<TYPE>OpenFail

+

<TYPE>OpenFail

Failures of opening sockets. This counter is not applicable to the - FDwatch type. + FDwatch type.

-

<TYPE>Close

+

<TYPE>Close

@@ -12167,7 +13015,7 @@ HOST-127.EXAMPLE. MX 0 .

-

<TYPE>BindFail

+

<TYPE>BindFail

@@ -12177,7 +13025,7 @@ HOST-127.EXAMPLE. MX 0 .

-

<TYPE>ConnFail

+

<TYPE>ConnFail

@@ -12187,7 +13035,7 @@ HOST-127.EXAMPLE. MX 0 .

-

<TYPE>Conn

+

<TYPE>Conn

@@ -12197,46 +13045,46 @@ HOST-127.EXAMPLE. MX 0 .

-

<TYPE>AcceptFail

+

<TYPE>AcceptFail

Failures of accepting incoming connection requests. This counter is not applicable to the - UDP and - FDwatch types. + UDP and + FDwatch types.

-

<TYPE>Accept

+

<TYPE>Accept

Incoming connections successfully accepted. This counter is not applicable to the - UDP and - FDwatch types. + UDP and + FDwatch types.

-

<TYPE>SendErr

+

<TYPE>SendErr

Errors in socket send operations. This counter corresponds - to SErr counter of - BIND 8. + to SErr counter of + BIND 8.

-

<TYPE>RecvErr

+

<TYPE>RecvErr

@@ -12248,45 +13096,57 @@ HOST-127.EXAMPLE. MX 0 .

- -
+ +
+ +

-Compatibility with BIND 8 Counters

-

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

+ +

+
RFwdR,SFwdR
+
+

These counters are not supported - because BIND 9 does not adopt + because BIND 9 does not adopt the notion of forwarding - as BIND 8 did. -

-
RAXFR
-

+ as BIND 8 did. +

+
+
RAXFR
+
+

This counter is accessible in the Incoming Queries section. -

-
RIQ
-

+

+
+
RIQ
+
+

This counter is accessible in the Incoming Requests section. -

-
ROpts
-

+

+
+
ROpts
+
+

This counter is not supported - because BIND 9 does not care + because BIND 9 does not care about IP options in the first place. -

+

+
- - - - + + + + + -

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch07.html b/doc/arm/Bv9ARM.ch07.html index 3f54b4aad6..7906807b31 100644 --- a/doc/arm/Bv9ARM.ch07.html +++ b/doc/arm/Bv9ARM.ch07.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Chapter 7. BIND 9 Security Considerations - - + + @@ -39,46 +38,49 @@
-
-

-Chapter 7. BIND 9 Security Considerations

+
+

+Chapter 7. BIND 9 Security Considerations

-
+ +

Access Control Lists

-

+ +

Access Control Lists (ACLs) are address match lists that - you can set up and nickname for future use in allow-notify, - allow-query, allow-query-on, - allow-recursion, allow-recursion-on, - blackhole, allow-transfer, + you can set up and nickname for future use in allow-notify, + allow-query, allow-query-on, + allow-recursion, allow-recursion-on, + blackhole, allow-transfer, etc.

-

+

Using ACLs allows you to have finer control over who can access your name server, without cluttering up your config files with huge lists of IP addresses.

-

+

It is a good idea to use ACLs, and to control access to your server. Limiting access to your server by outside parties can help prevent spoofing and denial of service (DoS) attacks against your server.

-

+

Here is an example of how to properly apply ACLs:

+
 // Set up an ACL named "bogusnets" that will block
 // RFC1918 space and some reserved space, which is
@@ -107,42 +109,47 @@ zone "example.com" {
   allow-query { any; };
 };
 
-

+ +

This allows recursive queries of the server from the outside unless recursion has been previously disabled.

-
-
+
+

-Chroot and Setuid +Chroot and Setuid

-

+ +

On UNIX servers, it is possible to run BIND in a chrooted environment (using - the chroot() function) by specifying - the "-t" option for named. + the chroot() function) by specifying + the "-t" option for named. This can help improve system security by placing BIND in a "sandbox", which will limit the damage done if a server is compromised.

-

+

Another useful feature in the UNIX version of BIND is the ability to run the daemon as an unprivileged user ( -u user ). - We suggest running as an unprivileged user when using the chroot feature. + 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 +

+ Here is an example command line to load BIND in a chroot sandbox, + /var/named, and to run named setuid to user 202:

-

+

/usr/local/sbin/named -u 202 -t /var/named

-
+ +

-The chroot Environment

-

- In order for a chroot environment +The chroot Environment

+ + +

+ In order for a chroot environment to work properly in a particular directory (for example, /var/named), @@ -151,12 +158,12 @@ zone "example.com" { From BIND's point of view, /var/named is the root of the filesystem. You will need to adjust the values of options like - like directory and pid-file to account + like directory and pid-file to account for this.

-

+

Unlike with earlier versions of BIND, you typically will - not need to compile named + not need to compile named statically nor install shared libraries under the new root. However, depending on your operating system, you may need to set up things like @@ -165,45 +172,51 @@ zone "example.com" { /dev/log, and /etc/localtime.

-
-
+
+ +

-Using the setuid Function

-

- Prior to running the named daemon, +Using the setuid Function

+ + +

+ Prior to running the named daemon, use - the touch utility (to change file + the touch utility (to change file access and - modification times) or the chown + modification times) or the chown utility (to set the user id and/or group id) on files to which you want BIND to write.

-
+

Note

- Note that if the named daemon is running as an + Note that if the named daemon is running as an unprivileged user, it will not be able to bind to new restricted 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 based on the IP address of the host requesting the update, by listing an IP address or - network prefix in the allow-update + network prefix in the allow-update zone option. This method is insecure since the source address of the update UDP packet is easily forged. Also note that if the IP addresses allowed by the - allow-update option include the + allow-update option include the address of a slave server which performs forwarding of dynamic updates, the master can be @@ -211,16 +224,18 @@ zone "example.com" { forward it to the master with its own source IP address causing the master to approve it without question.

-

+ +

For these reasons, we strongly recommend that updates be cryptographically authenticated by means of transaction signatures - (TSIG). That is, the allow-update + (TSIG). That is, the allow-update option should list only TSIG key names, not IP addresses or network - prefixes. Alternatively, the new update-policy + prefixes. Alternatively, the new update-policy option can be used.

-

+ +

Some sites choose to keep all dynamically-updated DNS data in a subdomain and delegate that subdomain to a separate zone. This way, the top-level zone containing critical data such as the IP @@ -228,8 +243,9 @@ zone "example.com" { of public web and mail servers need not allow dynamic update at all.

-
- + + + -

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch08.html b/doc/arm/Bv9ARM.ch08.html index a0f549f639..417b60a7b7 100644 --- a/doc/arm/Bv9ARM.ch08.html +++ b/doc/arm/Bv9ARM.ch08.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Chapter 8. Troubleshooting - - + + @@ -39,37 +38,44 @@
-
-

-Chapter 8. Troubleshooting

+
+

+Chapter 8. Troubleshooting

-
+ +

-Common Problems

-
+Common Problems
+ +

-It's not working; how can I figure out what's wrong?

-

+It's not working; how can I figure out what's wrong?

+ + +

The best solution to solving installation and configuration issues is to take preventative measures by setting up logging files beforehand. The log files provide a source of hints and information that can be used to figure out what went wrong and how to fix the problem.

- - -
+ +
+ +

-Incrementing and Changing the Serial Number

-

+Incrementing and Changing the Serial Number

+ + +

Zone serial numbers are just numbers — they aren't date related. A lot of people set them to a number that represents a date, usually of the form YYYYMMDDRR. @@ -81,22 +87,27 @@ lower than the serial number on the master, the slave server will attempt to update its copy of the zone.

-

+ +

Setting the serial number to a lower number on the master server than the slave server means that the slave will not perform updates to its copy of the zone.

-

+ +

The solution to this is to add 2147483647 (2^31-1) to the number, reload the zone and make sure all slaves have updated to the new zone serial number, then reset the number to what you want it to be, and reload the zone again.

- -
+ +
+

-Where Can I Get Help?

-

+Where Can I Get Help?

+ + +

The Internet Systems Consortium (ISC) offers a wide range of support and service agreements for BIND and DHCP servers. Four @@ -109,15 +120,16 @@ fix announcements to remote support. It also includes training in BIND and DHCP.

-

+ +

To discuss arrangements for support, contact - info@isc.org or visit the + info@isc.org or visit the ISC web page at - http://www.isc.org/services/support/ + http://www.isc.org/services/support/ to read more.

- - + + -

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch09.html b/doc/arm/Bv9ARM.ch09.html index 77d32c6959..b1fb192469 100644 --- a/doc/arm/Bv9ARM.ch09.html +++ b/doc/arm/Bv9ARM.ch09.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Appendix A. Release Notes - - + + @@ -39,96 +38,104 @@
-
-

-Appendix A. Release Notes

+
+

+Appendix A. Release Notes

-
+ +

-Release Notes for BIND Version 9.9.8

-
+Release Notes for BIND Version 9.9.8-S1
+ +

Introduction

-

+ +

This document summarizes changes since the last production release of BIND on the corresponding major release branch.

-
-
+
+

Download

-

+ +

The latest versions of BIND 9 software can always be found at - http://www.isc.org/downloads/. + http://www.isc.org/downloads/. There you will find additional information about each release, source code, and pre-compiled versions for Microsoft Windows operating systems.

-
-
+
+

Security Fixes

-
    -
  • + +

      +
    • +

      An incorrect boundary check in the OPENPGPKEY rdatatype could trigger an assertion failure. This flaw is disclosed in CVE-2015-5986. [RT #40286] -

    • -
    • -

      +

      +
    • +
    • +

      A buffer accounting error could trigger an assertion failure when parsing certain malformed DNSSEC keys.

      -

      - This flaw was discovered by Hanno B쎶ck of the Fuzzing +

      + This flaw was discovered by Hanno Böck of the Fuzzing Project, and is disclosed in CVE-2015-5722. [RT #40212]

      -
    • -
    • -

      +

    • +
    • +

      A specially crafted query could trigger an assertion failure in message.c.

      -

      +

      This flaw was discovered by Jonathan Foote, and is disclosed in CVE-2015-5477. [RT #40046]

      -
    • -
    • -

      +

    • +
    • +

      On servers configured to perform DNSSEC validation, an assertion failure could be triggered on answers from a specially configured server.

      -

      +

      This flaw was discovered by Breno Silveira Soares, and is disclosed in CVE-2015-4620. [RT #39795]

      -
    • +
    -
-
+
+

New Features

-
    -
  • -

    + +

      +
    • +

      New quotas have been added to limit the queries that are sent by recursive resolvers to authoritative servers experiencing denial-of-service attacks. When configured, @@ -137,13 +144,14 @@ experienced by recursives when they are being used as a vehicle for such an attack.

      -

      +

      NOTE: These options are not available by default; use - configure --enable-fetchlimit to include + configure --enable-fetchlimit to include them in the build.

      -
        -
      • +

          +
        • +

          fetches-per-server limits the number of simultaneous queries that can be sent to any single authoritative server. The configured value is a starting @@ -151,144 +159,186 @@ 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.

        -
      • -
      • - An --enable-querytrace configure switch is +

      • +
      • +

        + An --enable-querytrace configure switch is now available to enable very verbose query tracelogging. 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] -

      • -
      • +

        +
      • +
      • +

        The following types have been implemented: CSYNC, NINFO, RKEY, SINK, TA, TALINK. -

      • -
      • +

        +
      • +
      • +

        EDNS COOKIE options content is now displayed as "COOKIE: <hexvalue>". -

      • +

        +
      -
    -
    +
    +

    Feature Changes

    -
      -
    • + +

        +
      • +

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

      • -
      • +

        +
      • +
      • +

        Retrieving the local port range from net.ipv4.ip_local_port_range on Linux is now supported. -

      • -
      • +

        +
      • +
      • +

        Active Directory names of the form gc._msdcs.<forest> are now accepted as valid hostnames when using the check-names option. <forest> is still restricted to letters, digits and hyphens. -

      • -
      • +

        +
      • +
      • +

        Names containing rich text are now accepted as valid hostnames in PTR records in DNS-SD reverse lookup zones, as specified in RFC 6763. [RT #37889] -

      • -
      • +

        +
      • +
      • +

        The default preferred glue is now the address type of the transport the query was received over. -

      • -
      • - On machines with 4 or more processors (CPU), the default value +

        +
      • +
      • +

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

      • +

        +
      -
    -
    +
    +

    Porting Changes

    -
    • + +

      • +

        The Microsoft Windows install tool - BINDInstall.exe which requires a + BINDInstall.exe which requires a non-free version of Visual Studio to be built, now uses two files (lists of flags and files) created by the Configure perl script with all the needed information which were previously compiled in the binary. Read win32utils/build.txt for more details. [RT #38915] -

      -
    -
    +

    +
+
+

Bug Fixes

-
    -
  • + +

      +
    • +

      Asynchronous zone loads were not handled correctly when the zone load was already in progress; this could trigger a crash in zt.c. [RT #37573] -

    • -
    • +

      +
    • +
    • +

      A race during shutdown or reconfiguration could cause an assertion failure in mem.c. [RT #38979] -

    • -
    • +

      +
    • +
    • +

      Some answer formatting options didn't work correctly with - dig +short. [RT #39291] -

    • -
    • + dig +short. [RT #39291] +

      +
    • +
    • +

      Malformed records of some types, including NSAP and UNSPEC, could trigger assertion failures when loading text zone files. [RT #40274] [RT #40285] -

    • -
    • +

      +
    • +
    • +

      Fixed a possible crash in ratelimiter.c caused by NOTIFY messages being removed from the wrong rate limiter queue. [RT #40350] -

    • -
    • +

      +
    • +
    • +

      The default rrset-order of random was inconsistently applied. [RT #40456] -

    • -
    • +

      +
    • +
    • +

      BADVERS responses from broken authoritative name servers were not handled correctly. [RT #40427] -

    • +

      +
    -
-
+
+

End of Life

-

+ +

The BIND 9.9 (Extended Support Version) will be supported until June, 2017. - https://www.isc.org/downloads/software-support-policy/ + https://www.isc.org/downloads/software-support-policy/

-
-
+
+

Thank You

-

+ +

Thank you to everyone who assisted us in making this release possible. If you would like to contribute to ISC to assist us in continuing to make quality open source software, please visit our donations page at - http://www.isc.org/donate/. + http://www.isc.org/donate/.

+
-
-
+
-

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch10.html b/doc/arm/Bv9ARM.ch10.html index 1a67f6fabe..d1d4486af1 100644 --- a/doc/arm/Bv9ARM.ch10.html +++ b/doc/arm/Bv9ARM.ch10.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Appendix B. A Brief History of the DNS and BIND - - + + @@ -40,17 +39,22 @@
-
-

+
+

Appendix B. A Brief History of the DNS and BIND -

+

Table of Contents

-
+
+
DNS
+
BIND
+
-
-
-

+ +

+

+DNS

+

Although the "official" beginning of the Domain Name System occurred in 1984 with the publication of RFC 920, the core of the new system was described in 1983 in RFCs 882 and @@ -65,7 +69,8 @@ became the standards upon which all DNS implementations are built.

-

+ +

The first working domain name server, called "Jeeves", was written in 1983-84 by Paul Mockapetris for operation on DEC Tops-20 @@ -83,7 +88,12 @@ Administration (DARPA).

-

+

+ +
+

+BIND

+

Versions of BIND through 4.8.3 were maintained by the Computer Systems Research Group (CSRG) at UC Berkeley. Douglas Terry, Mark @@ -98,7 +108,7 @@ Mike Muuss, Jim Bloom and Mike Schwartz. BIND maintenance was subsequently handled by Mike Karels and Øivind Kure.

-

+

BIND versions 4.9 and 4.9.1 were released by Digital Equipment Corporation (now Compaq Computer Corporation). Paul Vixie, then @@ -110,42 +120,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 the Internet Systems Consortium and its predecessor, the Internet Software Consortium, with support being provided by ISC's sponsors.

-

+

As co-architects/programmers, Bob Halley and Paul Vixie released the first production-ready version of BIND version 8 in May 1997.

-

+

BIND version 9 was released in September 2000 and is a major rewrite of nearly all aspects of the underlying BIND architecture.

-

+

BIND versions 4 and 8 are officially deprecated. No additional development is done on BIND version 4 or BIND version 8.

-

+

BIND development work is made possible today by the sponsorship of several corporations, and by the tireless work efforts of numerous individuals.

-
-
+
+ -

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch11.html b/doc/arm/Bv9ARM.ch11.html index 8b76a7d299..00c54ed6f0 100644 --- a/doc/arm/Bv9ARM.ch11.html +++ b/doc/arm/Bv9ARM.ch11.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Appendix C. General DNS Reference Information - - + + @@ -39,25 +38,27 @@
-
-

-Appendix C. General DNS Reference Information

+
+

+Appendix C. General DNS Reference Information

-
+ +

IPv6 addresses (AAAA)

-

+ +

IPv6 addresses are 128-bit identifiers for interfaces and sets of interfaces which were introduced in the DNS to facilitate scalable Internet routing. There are three types of addresses: Unicast, @@ -68,13 +69,13 @@ Unicast address scheme. For more information, see RFC 3587, "Global Unicast Address Format."

-

+

IPv6 unicast addresses consist of a global routing prefix, a subnet identifier, and an interface identifier.

-

+

The global routing prefix is provided by the upstream provider or ISP, and (roughly) corresponds to the IPv4 network section @@ -88,22 +89,22 @@ 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 override the default setting if necessary. A typical IPv6 address might look like: - 2001:db8:201:9:a00:20ff:fe81:2b32 + 2001:db8:201:9:a00:20ff:fe81:2b32

-

+

IPv6 address specifications often contain long strings of zeros, so the architects have included a shorthand for specifying @@ -111,14 +112,16 @@ string of zeros that can fit, and can be used only once in an address.

-
-
+
+

Bibliography (and Suggested Reading)

-
+ +

Request for Comments (RFCs)

-

+ +

Specification documents for the Internet protocol suite, including the DNS, are published as part of the Request for Comments (RFCs) @@ -126,352 +129,776 @@ by the Internet Engineering Task Force (IETF) and the Internet Engineering Steering Group (IESG). RFCs can be obtained online via FTP at:

-

- +

+ ftp://www.isi.edu/in-notes/RFCxxxx.txt

-

+

(where xxxx is the number of the RFC). RFCs are also available via the Web at:

-

- http://www.ietf.org/rfc/. +

+ http://www.ietf.org/rfc/.

-
+

-Bibliography

-
-

Standards

-
-

[RFC974] C. Partridge. Mail Routing and the Domain System. January 1986.

+Bibliography
+
+

+Standards

+ + +
+

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

+DNS Security Proposed Standards + +
+

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

+
+

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

-
-

Resource Record Types

-
-

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

+DNS and the Internet + +
+

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

+DNS Operations + +
+

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

+
+
+

+Internationalized Domain Names

+ +
+

[RFC2825] + + IAB and R. Daigle. + A Tangled Web: Issues of I18N, Domain Names, + and the Other Internet protocols. + May 2000. +

-
-

Internationalized Domain Names

-
-

[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

-
+
+
+

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

-
-

[RFC1464] R. Rosenbaum. Using the Domain Name System To Store Arbitrary String - Attributes. May 1993.

+
+

[RFC1713] + + A. Romao. + Tools for DNS Debugging. + November 1994. +

-
-

[RFC1713] A. Romao. Tools for DNS Debugging. November 1994.

+
+

[RFC1794] + + T. Brisco. + DNS Support for Load + Balancing. + April 1995. +

-
-

[RFC1794] T. Brisco. DNS Support for Load - Balancing. April 1995.

+
+

[RFC2240] + + O. Vaughan. + A Legal Basis for Domain Name Allocation. + November 1997. +

-
-

[RFC2240] O. Vaughan. A Legal Basis for Domain Name Allocation. November 1997.

+
+

[RFC2345] + + J. Klensin, T. Wolf, and G. Oglesby. + Domain Names and Company Name Retrieval. + May 1998. +

-
-

[RFC2345] J. Klensin, T. Wolf, and G. Oglesby. Domain Names and Company Name Retrieval. May 1998.

+
+

[RFC2352] + + O. Vaughan. + A Convention For Using Legal Names as Domain Names. + May 1998. +

-
-

[RFC2352] O. Vaughan. A Convention For Using Legal Names as Domain Names. May 1998.

+
+

[RFC3071] + + J. Klensin. + Reflections on the DNS, RFC 1591, and Categories of Domains. + February 2001. +

-
-

[RFC3071] J. Klensin. Reflections on the DNS, RFC 1591, and Categories of Domains. February 2001.

+
+

[RFC3258] + + T. Hardie. + Distributing Authoritative Name Servers via + Shared Unicast Addresses. + April 2002. +

-
-

[RFC3258] T. Hardie. Distributing Authoritative Name Servers via - Shared Unicast Addresses. April 2002.

+
+

[RFC3901] + + A. Durand and J. Ihren. + DNS IPv6 Transport Operational Guidelines. + September 2004. +

-
-

[RFC3901] A. Durand and J. Ihren. DNS IPv6 Transport Operational Guidelines. September 2004.

+
+
+

+Obsolete and Unimplemented Experimental RFC

+ +
+

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

-
-

Obsolete and Unimplemented Experimental RFC

-
-

[RFC1712] C. Farrell, M. Schulze, S. Pleitner, and D. Baldoni. DNS Encoding of Geographical - Location. November 1994.

+
+

[RFC2874] + + M. Crawford and C. Huitema. + DNS Extensions to Support IPv6 Address Aggregation + and Renumbering. + July 2000. +

-
-

[RFC2673] M. Crawford. Binary Labels in the Domain Name System. August 1999.

-
-
-

[RFC2874] M. Crawford and C. Huitema. DNS Extensions to Support IPv6 Address Aggregation - and Renumbering. July 2000.

-
-
-
-

Obsoleted DNS Security RFCs

-
+
+
+

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

-
-

[RFC2065] D. Eastlake, 3rd and C. Kaufman. Domain Name System Security Extensions. January 1997.

+
+

[RFC2137] + + D. Eastlake, 3rd. + Secure Domain Name System Dynamic Update. + April 1997. +

-
-

[RFC2137] D. Eastlake, 3rd. Secure Domain Name System Dynamic Update. April 1997.

+
+

[RFC2535] + + D. Eastlake, 3rd. + Domain Name System Security Extensions. + March 1999. +

-
-

[RFC2535] D. Eastlake, 3rd. Domain Name System Security Extensions. March 1999.

+
+

[RFC3008] + + B. Wellington. + Domain Name System Security (DNSSEC) + Signing Authority. + November 2000. +

-
-

[RFC3008] B. Wellington. Domain Name System Security (DNSSEC) - Signing Authority. November 2000.

+
+

[RFC3090] + + E. Lewis. + DNS Security Extension Clarification on Zone Status. + March 2001. +

-
-

[RFC3090] E. Lewis. DNS Security Extension Clarification on Zone Status. March 2001.

+
+

[RFC3445] + + D. Massey and S. Rose. + Limiting the Scope of the KEY Resource Record (RR). + December 2002. +

-
-

[RFC3445] D. Massey and S. Rose. Limiting the Scope of the KEY Resource Record (RR). December 2002.

+
+

[RFC3655] + + B. Wellington and O. Gudmundsson. + Redefinition of DNS Authenticated Data (AD) bit. + November 2003. +

-
-

[RFC3655] B. Wellington and O. Gudmundsson. Redefinition of DNS Authenticated Data (AD) bit. November 2003.

+
+

[RFC3658] + + O. Gudmundsson. + Delegation Signer (DS) Resource Record (RR). + December 2003. +

-
-

[RFC3658] O. Gudmundsson. Delegation Signer (DS) Resource Record (RR). December 2003.

+
+

[RFC3755] + + S. Weiler. + Legacy Resolver Compatibility for Delegation Signer (DS). + May 2004. +

-
-

[RFC3755] S. Weiler. Legacy Resolver Compatibility for Delegation Signer (DS). May 2004.

+
+

[RFC3757] + + O. Kolkman, J. Schlyter, and E. Lewis. + Domain Name System KEY (DNSKEY) Resource Record + (RR) Secure Entry Point (SEP) Flag. + April 2004. +

-
-

[RFC3757] O. Kolkman, J. Schlyter, and E. Lewis. Domain Name System KEY (DNSKEY) Resource Record - (RR) Secure Entry Point (SEP) Flag. April 2004.

+
+

[RFC3845] + + J. Schlyter. + DNS Security (DNSSEC) NextSECure (NSEC) RDATA Format. + August 2004. +

-
-

[RFC3845] J. Schlyter. DNS Security (DNSSEC) NextSECure (NSEC) RDATA Format. August 2004.

-
-
-
-
-
+
+
+
+

Internet Drafts

-

+ +

Internet Drafts (IDs) are rough-draft working documents of the Internet Engineering Task Force. They are, in essence, RFCs in the preliminary stages of development. Implementors are @@ -481,22 +908,27 @@ they are "works in progress." IDs have a lifespan of six months after which they are deleted unless updated by their authors.

-
-
+
+

-Other Documents About BIND +Other Documents About BIND

-

-
+ +

+

-Bibliography

-
-

Paul Albitz and Cricket Liu. DNS and BIND. Copyright © 1998 Sebastopol, CA: O'Reilly and Associates.

-
-
-
-
+Bibliography
+
+

+ Paul Albitz and Cricket Liu. + DNS and BIND. + Copyright © 1998 Sebastopol, CA: O'Reilly and Associates. +

+
+
+
+
-

BIND 9.9.8 (Extended Support Version)

+

BIND 9.9.8-S1 (Subscription Edition)

diff --git a/doc/arm/Bv9ARM.ch12.html b/doc/arm/Bv9ARM.ch12.html index a8b159d69d..95876e03b2 100644 --- a/doc/arm/Bv9ARM.ch12.html +++ b/doc/arm/Bv9ARM.ch12.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Appendix D. BIND 9 DNS Library Support - - + + @@ -39,111 +38,128 @@
-
-

-Appendix D. BIND 9 DNS Library Support

+
+

+Appendix D. BIND 9 DNS Library Support

-
+ +

BIND 9 DNS Library Support

-

This version of BIND 9 "exports" its internal libraries so + +

This version of BIND 9 "exports" its internal libraries so that they can be used by third-party applications more easily (we call them "export" libraries in this document). In addition to all major DNS-related APIs BIND 9 is currently using, the export libraries provide the following features:

-
    -
  • The newly created "DNS client" module. This is a higher +

      +
    • +

      The newly created "DNS client" module. This is a higher level API that provides an interface to name resolution, single DNS transaction with a particular server, and dynamic update. Regarding name resolution, it supports advanced features such as DNSSEC validation and caching. This module - supports both synchronous and asynchronous mode.

    • -
    • The new "IRS" (Information Retrieval System) library. + supports both synchronous and asynchronous mode.

      +
    • +
    • +

      The new "IRS" (Information Retrieval System) library. It provides an interface to parse the traditional resolv.conf file and more advanced, DNS-specific configuration file for the rest of this package (see the description for the - dns.conf file below).

    • -
    • As part of the IRS library, newly implemented standard + dns.conf file below).

      +
    • +
    • +

      As part of the IRS library, newly implemented standard address-name mapping functions, getaddrinfo() and getnameinfo(), are provided. They use the DNSSEC-aware validating resolver backend, and could use other advanced features of the BIND 9 libraries such as caching. The getaddrinfo() function resolves both A and AAAA RRs - concurrently (when the address family is unspecified).

    • -
    • An experimental framework to support other event - libraries than BIND 9's internal event task system.

    • + concurrently (when the address family is unspecified).

      + +
    • +

      An experimental framework to support other event + libraries than BIND 9's internal event task system.

      +
    -
    +

    -Prerequisite

    -

    GNU make is required to build the export libraries (other +Prerequisite

+ +

GNU make is required to build the export libraries (other part of BIND 9 can still be built with other types of make). In the reminder of this document, "make" means GNU make. Note that in some platforms you may need to invoke a different command name than "make" (e.g. "gmake") to indicate it's GNU make.

-
-
+
+

-Compilation

-
+Compilation
+ +
 $ ./configure --enable-exportlib [other flags]
 $ make
 
-

+

This will create (in addition to usual BIND 9 programs) and a separate set of libraries under the lib/export directory. For example, lib/export/dns/libdns.a is the archive file of the export version of the BIND 9 DNS library. Sample application programs using the libraries will also be built under the lib/export/samples directory (see below).

-
-
+
+

-Installation

-
+Installation
+ +
 $ cd lib/export
 $ make install
 
-

+

This will install library object files under the directory specified by the --with-export-libdir configure option (default: EPREFIX/lib/bind9), and header files under the directory specified by the --with-export-includedir configure option (default: PREFIX/include/bind9). Root privilege is normally required. - "make install" at the top directory will do the + "make install" at the top directory will do the same.

-

+

To see how to build your own application after the installation, see lib/export/samples/Makefile-postinstall.in.

-
-
+
+

-Known Defects/Restrictions

-
    -
  • Currently, win32 is not supported for the export +Known Defects/Restrictions

+ +
    +
  • + +

    Currently, win32 is not supported for the export library. (Normal BIND 9 application can be built as - before).

  • -
  • -

    The "fixed" RRset order is not (currently) supported in + before).

    +
  • +
  • +

    The "fixed" RRset order is not (currently) supported in the export library. If you want to use "fixed" RRset order - for, e.g. named while still building the + for, e.g. named while still building the export library even without the fixed order support, build them separately:

    @@ -156,27 +172,34 @@ $ make

- -
  • The client module and the IRS library currently do not +

  • +
  • +

    The client module and the IRS library currently do not support DNSSEC validation using DLV (the underlying modules can handle it, but there is no tunable interface to enable - the feature).

  • -
  • RFC 5011 is not supported in the validating stub + the feature).

    +
  • +
  • +

    RFC 5011 is not supported in the validating stub resolver of the export library. In fact, it is not clear whether it should: trust anchors would be a system-wide configuration which would be managed by an administrator, while the stub resolver will be used by ordinary applications - run by a normal user.

  • -
  • Not all common /etc/resolv.conf + run by a normal user.

    +
  • +
  • +

    Not all common /etc/resolv.conf options are supported in the IRS library. The only available options in this - version are "debug" and "ndots".

  • + version are "debug" and "ndots".

    + - -
    +
    +

    -The dns.conf File

    -

    The IRS library supports an "advanced" configuration file +The 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. @@ -186,95 +209,98 @@ $ make This module is very experimental and the configuration syntax or library interfaces may change in future versions. Currently, only the - trusted-keys + trusted-keys statement is supported, whose syntax is the same as the same name of statement for named.conf. (See - the section called “trusted-keys Statement Grammar” for details.)

    - - +

    -Sample Applications

    -

    Some sample application programs using this API are +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

    -

    +sample: a simple stub resolver utility

    + +

    It sends a query of a given name (of a given optional RR type) to a specified recursive server, and prints the result as a list of RRs. It can also act as a validating stub resolver if a trust anchor is given via a set of command line options.

    -

    +

    Usage: sample [options] server_address hostname

    -

    +

    Options and Arguments:

    -
    +
    -t RRtype

    - specify the RR type of the query. The default is the A RR. + specify the RR type of the query. The default is the A RR.

    [-a algorithm] [-e] -k keyname -K keystring

    - specify a command-line DNS key to validate the answer. For - example, to specify the following DNSKEY of example.com: + specify a command-line DNS key to validate the answer. For + example, to specify the following DNSKEY of example.com:


    -                example.com. 3600 IN DNSKEY 257 3 5 xxx
    + example.com. 3600 IN DNSKEY 257 3 5 xxx

    - specify the options as follows: + specify the options as follows:

     
    -          -e -k example.com -K "xxx"
    +	  -e -k example.com -K "xxx"
     
     

    - -e means that this key is a zone's "key signing key" (as known - as "secure Entry point"). - When -a is omitted rsasha1 will be used by default. + -e means that this key is a zone's "key signing key" (as known + as "secure Entry point"). + When -a is omitted rsasha1 will be used by default.

    -s domain:alt_server_address

    - specify a separate recursive server address for the specific - "domain". Example: -s example.com:2001:db8::1234 + specify a separate recursive server address for the specific + "domain". Example: -s example.com:2001:db8::1234

    server_address

    - an IP(v4/v6) address of the recursive server to which queries - are sent. + an IP(v4/v6) address of the recursive server to which queries + are sent.

    hostname

    - the domain name for the query + the domain name for the query

    -
    -
    +
    +

    -sample-async: a simple stub resolver, working asynchronously

    -

    +sample-async: a simple stub resolver, working asynchronously

    + +

    Similar to "sample", but accepts a list of (query) domain names as a separate file and resolves the names asynchronously.

    -

    +

    Usage: sample-async [-s server_address] [-t RR_type] input_file

    -

    +

    Options and Arguments:

    -
    +
    -s server_address
    @@ -300,54 +326,62 @@ $ make   mx.example.net
      ns.xxx.example

    - +
    - -
    +
    +

    -sample-request: a simple DNS transaction client

    -

    +sample-request: a simple DNS transaction client

    + +

    It sends a query to a specified server, and prints the response with minimal processing. It doesn't act as a "stub resolver": it stops the processing once it gets any response from the server, whether it's a referral or an alias (CNAME or DNAME) that would require further queries to get the ultimate answer. In other words, this utility acts as a very - simplified dig. + simplified dig.

    -

    +

    Usage: sample-request [-t RRtype] server_address hostname

    -

    +

    Options and Arguments:

    -
    +
    -t RRtype
    -

    +

    +

    specify the RR type of the queries. The default is the A RR. -

    +

    +
    server_address
    -

    +

    +

    an IP(v4/v6) address of the recursive server to which the query is sent. -

    +

    +
    hostname
    -

    +

    +

    the domain name for the query -

    +

    +
    -
    -
    +
    +

    -sample-gai: getaddrinfo() and getnameinfo() test code

    -

    +sample-gai: getaddrinfo() and getnameinfo() test code

    + +

    This is a test program to check getaddrinfo() and getnameinfo() behavior. It takes a host name as an argument, calls getaddrinfo() with the given host @@ -357,172 +391,178 @@ $ make validating resolver, and getaddrinfo()/getnameinfo() will fail with an EAI_INSECUREDATA error when DNSSEC validation fails.

    -

    +

    Usage: sample-gai hostname

    - -
    +
    +

    -sample-update: a simple dynamic update client program

    -

    +sample-update: a simple dynamic update client program

    + +

    It accepts a single update command as a command-line argument, sends an update request message to the authoritative server, and shows the response from the server. In - other words, this is a simplified nsupdate. + other words, this is a simplified nsupdate.

    -

    +

    Usage: sample-update [options] (add|delete) "update data"

    -

    +

    Options and Arguments:

    -
    +
    -a auth_server

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

    - A TSIG key file to secure the update transaction. The keyfile - format is the same as that for the nsupdate utility. + A TSIG key file to secure the update transaction. The keyfile + format is the same as that for the nsupdate utility.

    -p prerequisite

    - A prerequisite for the update (only one prerequisite can be - specified). The prerequisite format is the same as that is - accepted by the nsupdate utility. + A prerequisite for the update (only one prerequisite can be + specified). The prerequisite format is the same as that is + accepted by the nsupdate utility.

    -r recursive_server

    - An IP address of a recursive server that this utility will - use. A recursive server may be necessary to identify the - authoritative server address to which the update request is - sent. + An IP address of a recursive server that this utility will + use. A recursive server may be necessary to identify the + authoritative server address to which the update request is + sent.

    -z zonename

    - The domain name of the zone that contains + The domain name of the zone that contains

    (add|delete)

    - Specify the type of update operation. Either "add" or "delete" - must be specified. + Specify the type of update operation. Either "add" or "delete" + must be specified.

    "update data"

    - Specify the data to be updated. A typical example of the data - would look like "name TTL RRtype RDATA". + Specify the data to be updated. A typical example of the data + would look 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

    -

    +nsprobe: domain/name server checker in terms of RFC 4074

    + +

    It checks a set of domains to see the name servers of the domains behave correctly in terms of RFC 4074. This is included in the set of sample programs to show how the export library can be used in a DNS-related application.

    -

    +

    Usage: nsprobe [-d] [-v [-v...]] [-c cache_address] [input_file]

    -

    +

    Options

    -
    + +
    -d

    - run in the "debug" mode. with this option nsprobe will dump - every RRs it receives. + run in the "debug" mode. with this option nsprobe will dump + every RRs it receives.

    -v

    - increase verbosity of other normal log messages. This can be - specified multiple times + increase verbosity of other normal log messages. This can be + specified multiple times

    -c cache_address

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

    - a file name containing a list of domain (zone) names to be - probed. when omitted the standard input will be used. Each - line of the input file specifies a single domain name such as - "example.com". In general this domain name must be the apex - name of some DNS zone (unlike normal "host names" such as - "www.example.com"). nsprobe first identifies the NS RRsets 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. + a file name containing a list of domain (zone) names to be + probed. when omitted the standard input will be used. Each + line of the input file specifies a single domain name such as + "example.com". In general this domain name must be the apex + name of some DNS zone (unlike normal "host names" such as + "www.example.com"). nsprobe first identifies the NS RRsets 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" of the +Library References

    + +

    As of this writing, there is no formal "manual" of the libraries, except this document, header files (some of them provide pretty detailed explanations), and sample application programs.

    + - - + -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/Bv9ARM.ch13.html b/doc/arm/Bv9ARM.ch13.html index f548d2c35d..55cd751fdb 100644 --- a/doc/arm/Bv9ARM.ch13.html +++ b/doc/arm/Bv9ARM.ch13.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - Manual pages - - + + @@ -39,7 +38,7 @@
    -
    +

    Manual pages

    @@ -47,7 +46,7 @@

    Table of Contents

    -
    +
    dig — DNS lookup utility
    @@ -131,7 +130,35 @@
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/Bv9ARM.conf b/doc/arm/Bv9ARM.conf new file mode 100644 index 0000000000..cf095caa92 --- /dev/null +++ b/doc/arm/Bv9ARM.conf @@ -0,0 +1,3 @@ +TexInputs: ../tex// +TexStyle: armstyle +XslParam: ../xsl/arm-param.xsl diff --git a/doc/arm/Bv9ARM.html b/doc/arm/Bv9ARM.html index 74450d4eb5..deb90bf4f3 100644 --- a/doc/arm/Bv9ARM.html +++ b/doc/arm/Bv9ARM.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - BIND 9 Administrator Reference Manual - - + + @@ -36,12 +35,12 @@
    -
    +

    -BIND 9 Administrator Reference Manual

    -

    BIND Version 9.9.8

    +BIND 9 Administrator Reference Manual
    +

    BIND Version 9.9.8-S1

    @@ -49,227 +48,233 @@

    Table of Contents

    -
    +
    1. Introduction
    -
    Scope of Document
    -
    Organization of This Document
    -
    Conventions Used in This Document
    -
    The Domain Name System (DNS)
    +
    Scope of Document
    +
    Organization of This Document
    +
    Conventions Used in This Document
    +
    The Domain Name System (DNS)
    -
    DNS Fundamentals
    -
    Domains and Domain Names
    -
    Zones
    -
    Authoritative Name Servers
    -
    Caching Name Servers
    -
    Name Servers in Multiple Roles
    +
    DNS Fundamentals
    +
    Domains and Domain Names
    +
    Zones
    +
    Authoritative Name Servers
    +
    Caching Name Servers
    +
    Name Servers in Multiple Roles
    2. BIND Resource Requirements
    -
    Hardware requirements
    -
    CPU Requirements
    -
    Memory Requirements
    -
    Name Server Intensive Environment Issues
    -
    Supported Operating Systems
    +
    Hardware requirements
    +
    CPU Requirements
    +
    Memory Requirements
    +
    Name Server Intensive Environment Issues
    +
    Supported Operating Systems
    3. Name Server Configuration
    -
    Sample Configurations
    +
    Sample Configurations
    -
    A Caching-only Name Server
    -
    An Authoritative-only Name Server
    +
    A Caching-only Name Server
    +
    An Authoritative-only Name Server
    -
    Load Balancing
    -
    Name Server Operations
    +
    Load Balancing
    +
    Name Server Operations
    -
    Tools for Use With the Name Server Daemon
    -
    Signals
    +
    Tools for Use With the Name Server Daemon
    +
    Signals
    4. Advanced DNS Features
    -
    Notify
    -
    Dynamic Update
    -
    The journal file
    -
    Incremental Zone Transfers (IXFR)
    -
    Split DNS
    -
    Example split DNS setup
    -
    TSIG
    +
    Notify
    +
    Dynamic Update
    +
    The journal file
    +
    Incremental Zone Transfers (IXFR)
    +
    Split DNS
    +
    Example split DNS setup
    +
    TSIG
    -
    Generate Shared Keys for Each Pair of Hosts
    -
    Copying the Shared Secret to Both Machines
    -
    Informing the Servers of the Key's Existence
    -
    Instructing the Server to Use the Key
    -
    TSIG Key Based Access Control
    -
    Errors
    +
    Generate Shared Keys for Each Pair of Hosts
    +
    Copying the Shared Secret to Both Machines
    +
    Informing the Servers of the Key's Existence
    +
    Instructing the Server to Use the Key
    +
    TSIG Key Based Access Control
    +
    Errors
    -
    TKEY
    -
    SIG(0)
    -
    DNSSEC
    +
    TKEY
    +
    SIG(0)
    +
    DNSSEC
    -
    Generating Keys
    -
    Signing the Zone
    -
    Configuring Servers
    +
    Generating Keys
    +
    Signing the Zone
    +
    Configuring Servers
    -
    DNSSEC, Dynamic Zones, and Automatic Signing
    +
    DNSSEC, Dynamic Zones, and Automatic Signing
    -
    Converting from insecure to secure
    -
    Dynamic DNS update method
    -
    Fully automatic zone signing
    -
    Private-type records
    -
    DNSKEY rollovers
    -
    Dynamic DNS update method
    -
    Automatic key rollovers
    -
    NSEC3PARAM rollovers via UPDATE
    -
    Converting from NSEC to NSEC3
    -
    Converting from NSEC3 to NSEC
    -
    Converting from secure to insecure
    -
    Periodic re-signing
    -
    NSEC3 and OPTOUT
    +
    Converting from insecure to secure
    +
    Dynamic DNS update method
    +
    Fully automatic zone signing
    +
    Private-type records
    +
    DNSKEY rollovers
    +
    Dynamic DNS update method
    +
    Automatic key rollovers
    +
    NSEC3PARAM rollovers via UPDATE
    +
    Converting from NSEC to NSEC3
    +
    Converting from NSEC3 to NSEC
    +
    Converting from secure to insecure
    +
    Periodic re-signing
    +
    NSEC3 and OPTOUT
    -
    Dynamic Trust Anchor Management
    +
    Dynamic Trust Anchor Management
    -
    Validating Resolver
    -
    Authoritative Server
    +
    Validating Resolver
    +
    Authoritative Server
    -
    PKCS #11 (Cryptoki) support
    +
    PKCS #11 (Cryptoki) support
    -
    Prerequisites
    -
    Building BIND 9 with PKCS#11
    -
    PKCS #11 Tools
    -
    Using the HSM
    -
    Specifying the engine on the command line
    -
    Running named with automatic zone re-signing
    +
    Prerequisites
    +
    Building BIND 9 with PKCS#11
    +
    PKCS #11 Tools
    +
    Using the HSM
    +
    Specifying the engine on the command line
    +
    Running named with automatic zone re-signing
    -
    IPv6 Support in BIND 9
    +
    IPv6 Support in BIND 9
    -
    Address Lookups Using AAAA Records
    -
    Address to Name Lookups Using Nibble Format
    +
    Address Lookups Using AAAA Records
    +
    Address to Name Lookups Using Nibble Format
    5. The BIND 9 Lightweight Resolver
    -
    The Lightweight Resolver Library
    -
    Running a Resolver Daemon
    +
    The Lightweight Resolver Library
    +
    Running a Resolver Daemon
    6. BIND 9 Configuration Reference
    -
    Configuration File Elements
    +
    Configuration File Elements
    -
    Address Match Lists
    -
    Comment Syntax
    +
    Address Match Lists
    +
    Comment Syntax
    -
    Configuration File Grammar
    +
    Configuration File Grammar
    -
    acl Statement Grammar
    -
    acl Statement Definition and +
    acl Statement Grammar
    +
    acl Statement Definition and Usage
    -
    controls Statement Grammar
    -
    controls Statement Definition and +
    controls Statement Grammar
    +
    controls Statement Definition and Usage
    -
    include Statement Grammar
    -
    include Statement Definition and +
    include Statement Grammar
    +
    include Statement Definition and Usage
    -
    key Statement Grammar
    -
    key Statement Definition and Usage
    -
    logging Statement Grammar
    -
    logging Statement Definition and +
    key Statement Grammar
    +
    key Statement Definition and Usage
    +
    logging Statement Grammar
    +
    logging Statement Definition and Usage
    -
    lwres Statement Grammar
    -
    lwres Statement Definition and Usage
    -
    masters Statement Grammar
    -
    masters Statement Definition and +
    lwres Statement Grammar
    +
    lwres Statement Definition and Usage
    +
    masters Statement Grammar
    +
    masters Statement Definition and Usage
    -
    options Statement Grammar
    -
    options Statement Definition and +
    options Statement Grammar
    +
    options Statement Definition and Usage
    -
    server Statement Grammar
    -
    server Statement Definition and +
    server Statement Grammar
    +
    server Statement Definition and Usage
    -
    statistics-channels Statement Grammar
    -
    statistics-channels Statement Definition and +
    statistics-channels Statement Grammar
    +
    statistics-channels Statement Definition and Usage
    -
    trusted-keys Statement Grammar
    -
    trusted-keys Statement Definition +
    trusted-keys Statement Grammar
    +
    trusted-keys Statement Definition and Usage
    -
    managed-keys Statement Grammar
    -
    managed-keys Statement Definition +
    managed-keys Statement Grammar
    +
    managed-keys Statement Definition and Usage
    -
    view Statement Grammar
    -
    view Statement Definition and Usage
    -
    zone +
    view Statement Grammar
    +
    view Statement Definition and Usage
    +
    zone Statement Grammar
    -
    zone Statement Definition and Usage
    +
    zone Statement Definition and Usage
    -
    Zone File
    +
    Zone File
    -
    Types of Resource Records and When to Use Them
    -
    Discussion of MX Records
    -
    Setting TTLs
    -
    Inverse Mapping in IPv4
    -
    Other Zone File Directives
    -
    BIND Master File Extension: the $GENERATE Directive
    -
    Additional File Formats
    +
    Types of Resource Records and When to Use Them
    +
    Discussion of MX Records
    +
    Setting TTLs
    +
    Inverse Mapping in IPv4
    +
    Other Zone File Directives
    +
    BIND Master File Extension: the $GENERATE Directive
    +
    Additional File Formats
    +
    +
    BIND9 Statistics
    +
    +
    The Statistics File
    +
    Statistics Counters
    -
    BIND9 Statistics
    -
    Statistics Counters
    7. BIND 9 Security Considerations
    -
    Access Control Lists
    -
    Chroot and Setuid
    +
    Access Control Lists
    +
    Chroot and Setuid
    -
    The chroot Environment
    -
    Using the setuid Function
    +
    The chroot Environment
    +
    Using the setuid Function
    -
    Dynamic Update Security
    +
    Dynamic Update Security
    8. Troubleshooting
    -
    Common Problems
    -
    It's not working; how can I figure out what's wrong?
    -
    Incrementing and Changing the Serial Number
    -
    Where Can I Get Help?
    +
    Common Problems
    +
    It's not working; how can I figure out what's wrong?
    +
    Incrementing and Changing the Serial Number
    +
    Where Can I Get Help?
    A. Release Notes
    -
    Release Notes for BIND Version 9.9.8
    +
    Release Notes for BIND Version 9.9.8-S1
    -
    Introduction
    -
    Download
    -
    Security Fixes
    -
    New Features
    -
    Feature Changes
    -
    Porting Changes
    -
    Bug Fixes
    -
    End of Life
    -
    Thank You
    +
    Introduction
    +
    Download
    +
    Security Fixes
    +
    New Features
    +
    Feature Changes
    +
    Porting Changes
    +
    Bug Fixes
    +
    End of Life
    +
    Thank You
    B. A Brief History of the DNS and BIND
    -
    +
    +
    DNS
    +
    BIND
    +
    C. General DNS Reference Information
    -
    IPv6 addresses (AAAA)
    -
    Bibliography (and Suggested Reading)
    +
    IPv6 addresses (AAAA)
    +
    Bibliography (and Suggested Reading)
    -
    Request for Comments (RFCs)
    -
    Internet Drafts
    -
    Other Documents About BIND
    +
    Request for Comments (RFCs)
    +
    Internet Drafts
    +
    Other Documents About BIND
    D. BIND 9 DNS Library Support
    -
    BIND 9 DNS Library Support
    +
    BIND 9 DNS Library Support
    -
    Prerequisite
    -
    Compilation
    -
    Installation
    -
    Known Defects/Restrictions
    -
    The dns.conf File
    -
    Sample Applications
    -
    Library References
    +
    Prerequisite
    +
    Compilation
    +
    Installation
    +
    Known Defects/Restrictions
    +
    The dns.conf File
    +
    Sample Applications
    +
    Library References
    I. Manual pages
    @@ -358,7 +363,34 @@
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/Bv9ARM.pdf b/doc/arm/Bv9ARM.pdf index 86d4f828f1..6108cb980e 100644 Binary files a/doc/arm/Bv9ARM.pdf and b/doc/arm/Bv9ARM.pdf differ diff --git a/doc/arm/Makefile.in b/doc/arm/Makefile.in index 501133e0db..4b2aa72822 100644 --- a/doc/arm/Makefile.in +++ b/doc/arm/Makefile.in @@ -13,8 +13,6 @@ # OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR # PERFORMANCE OF THIS SOFTWARE. -# $Id: Makefile.in,v 1.22 2009/02/12 23:47:56 tbox Exp $ - srcdir = @srcdir@ VPATH = @srcdir@ top_srcdir = @top_srcdir@ @@ -33,9 +31,9 @@ doc man:: ${MANOBJS} ${PDFOBJS} clean:: rm -f Bv9ARM.aux Bv9ARM.brf Bv9ARM.glo Bv9ARM.idx Bv9ARM.toc - rm -f Bv9ARM.log Bv9ARM.out Bv9ARM.tex Bv9ARM.tex.tmp + rm -f Bv9ARM.log Bv9ARM.out rm -f notes.aux notes.brf notes.glo notes.idx notes.toc - rm -f notes.log notes.out notes.tex notes.tex.tmp + rm -f notes.log notes.out docclean manclean maintainer-clean:: clean rm -f *.html ${PDFOBJS} @@ -47,19 +45,11 @@ docclean manclean maintainer-clean distclean:: notes.html: notes-wrapper.xml notes.xml releaseinfo.xml pkgversion.xml noteversion.xml expand notes-wrapper.xml | \ - ${XSLTPROC} --stringparam generate.toc "" ../xsl/isc-notes-html.xsl - |\ - @PERL@ html-fixup.pl > notes.html + ${XSLTPROC} --stringparam generate.toc "" ../xsl/isc-notes-html.xsl - > notes.html -notes.tex: notes-wrapper.xml notes.xml releaseinfo.xml pkgversion.xml noteversion.xml - expand notes-wrapper.xml | \ - ${XSLTPROC} --stringparam generate.toc "book toc" ${top_srcdir}/doc/xsl/pre-latex.xsl - | \ - ${XSLTPROC} ${top_srcdir}/doc/xsl/isc-notes-latex.xsl - | \ - @PERL@ latex-fixup.pl >$@.tmp - if test -s $@.tmp; then mv $@.tmp $@; else rm -f $@.tmp; exit 1; fi - -notes.pdf: notes.tex releaseinfo.xml pkgversion.xml noteversion.xml - rm -f notes-wrapper.aux notes.pdf notes.log - ${PDFLATEX} '\batchmode\input notes.tex' || (rm -f $@ ; exit 1) +notes.pdf: notes-wrapper.xml notes.xml releaseinfo.xml pkgversion.xml noteversion.xml + ${XSLTPROC} ${top_srcdir}/doc/xsl/pre-latex.xsl notes-wrapper.xml | \ + ${DBLATEX} -c notes.conf -Pdoc.layout="mainmatter" -o notes.pdf - Bv9ARM.html: Bv9ARM-book.xml releaseinfo.xml pkgversion.xml noteversion.xml expand Bv9ARM-book.xml | \ @@ -70,24 +60,10 @@ Bv9ARM-all.html: Bv9ARM-book.xml releaseinfo.xml pkgversion.xml noteversion.xml expand Bv9ARM-book.xml | \ ${XSLTPROC} -o Bv9ARM-all.html ../xsl/isc-docbook-html.xsl - -Bv9ARM.tex: Bv9ARM-book.xml releaseinfo.xml pkgversion.xml noteversion.xml +Bv9ARM.pdf: Bv9ARM-book.xml releaseinfo.xml pkgversion.xml noteversion.xml expand Bv9ARM-book.xml | \ ${XSLTPROC} ${top_srcdir}/doc/xsl/pre-latex.xsl - | \ - ${XSLTPROC} ${top_srcdir}/doc/xsl/isc-docbook-latex.xsl - | \ - @PERL@ latex-fixup.pl >$@.tmp - if test -s $@.tmp; then mv $@.tmp $@; else rm -f $@.tmp; exit 1; fi - -Bv9ARM.dvi: Bv9ARM.tex releaseinfo.xml pkgversion.xml noteversion.xml - rm -f Bv9ARM-book.aux Bv9ARM-book.dvi Bv9ARM-book.log - ${LATEX} '\batchmode\input Bv9ARM.tex' || (rm -f $@ ; exit 1) - ${LATEX} '\batchmode\input Bv9ARM.tex' || (rm -f $@ ; exit 1) - ${LATEX} '\batchmode\input Bv9ARM.tex' || (rm -f $@ ; exit 1) - -Bv9ARM.pdf: Bv9ARM.tex releaseinfo.xml pkgversion.xml noteversion.xml - rm -f Bv9ARM-book.aux Bv9ARM-book.pdf Bv9ARM-book.log - ${PDFLATEX} '\batchmode\input Bv9ARM.tex' || (rm -f $@ ; exit 1) - ${PDFLATEX} '\batchmode\input Bv9ARM.tex' || (rm -f $@ ; exit 1) - ${PDFLATEX} '\batchmode\input Bv9ARM.tex' || (rm -f $@ ; exit 1) + ${DBLATEX} -c Bv9ARM.conf -o Bv9ARM.pdf - FORCE: diff --git a/doc/arm/dnssec.xml b/doc/arm/dnssec.xml index 4b058eb8b0..229bb63df2 100644 --- a/doc/arm/dnssec.xml +++ b/doc/arm/dnssec.xml @@ -1,4 +1,3 @@ - - - - DNSSEC, Dynamic Zones, and Automatic Signing + +
    DNSSEC, Dynamic Zones, and Automatic Signing + As of BIND 9.7.0 it is possible to change a dynamic zone from insecure to signed and back again. A secure zone can use either NSEC or NSEC3 chains. - - Converting from insecure to secure - +
    Converting from insecure to secure + +
    Changing a zone from insecure to secure can be done in two ways: using a dynamic DNS update, or the auto-dnssec zone option. @@ -47,9 +46,9 @@ with the ZSK, and the DNSKEY RRset to be signed with the KSK as well. An NSEC chain will be generated as part of the initial signing process. - - Dynamic DNS update method - +
    Dynamic DNS update method + +
    To insert the keys via dynamic update: % nsupdate @@ -84,9 +83,9 @@ be removed once the operation completes. While the initial signing and NSEC/NSEC3 chain generation is happening, other updates are possible as well. - - Fully automatic zone signing - +
    Fully automatic zone signing + +
    To enable automatic signing, add the auto-dnssec option to the zone statement in named.conf. @@ -148,9 +147,9 @@ update-policy statement to the zone configuration. If this has not been done, the configuration will fail. - - Private-type records - +
    Private-type records + +
    The state of the signing process is signaled by private-type records (with a default type value of 65534). When signing is complete, these records will have a nonzero value for @@ -186,15 +185,15 @@ 0x20 NONSEC - - DNSKEY rollovers - +
    DNSKEY rollovers + +
    As with insecure-to-secure conversions, rolling DNSSEC keys can be done in two ways: using a dynamic DNS update, or the auto-dnssec zone option. - - Dynamic DNS update method - +
    Dynamic DNS update method + +
    To perform key rollovers via dynamic update, you need to add the K* files for the new keys so that named can find them. You can then add the new @@ -215,9 +214,9 @@ specify the correct key. named will clean out any signatures generated by the old key after the update completes. - - Automatic key rollovers - +
    Automatic key rollovers + +
    When a new key reaches its activation date (as set by dnssec-keygen or dnssec-settime), if the auto-dnssec zone option is set to @@ -231,32 +230,32 @@ signature validity periods expire. By default, this rollover completes in 30 days, after which it will be safe to remove the old key from the DNSKEY RRset. - - NSEC3PARAM rollovers via UPDATE - +
    NSEC3PARAM rollovers via UPDATE + +
    Add the new NSEC3PARAM record via dynamic update. When the new NSEC3 chain has been generated, the NSEC3PARAM flag field will be zero. At this point you can remove the old NSEC3PARAM record. The old chain will be removed after the update request completes. - - Converting from NSEC to NSEC3 - +
    Converting from NSEC to NSEC3 + +
    To do this, you just need to add an NSEC3PARAM record. When the conversion is complete, the NSEC chain will have been removed and the NSEC3PARAM record will have a zero flag field. The NSEC3 chain will be generated before the NSEC chain is destroyed. - - Converting from NSEC3 to NSEC - +
    Converting from NSEC3 to NSEC + +
    To do this, use nsupdate to remove all NSEC3PARAM records with a zero flag field. The NSEC chain will be generated before the NSEC3 chain is removed. - - Converting from secure to insecure - +
    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, @@ -270,17 +269,17 @@ zone statement is used, it should be removed or changed to allow instead (or it will re-sign). - - Periodic re-signing - +
    Periodic re-signing + +
    In any secure zone which supports dynamic updates, named will periodically re-sign RRsets which have not been re-signed as a result of some update action. The signature lifetimes will be adjusted so as to spread the re-sign load over time rather than all at once. - - NSEC3 and OPTOUT - +
    NSEC3 and OPTOUT + +
    named only supports creating new NSEC3 chains where all the NSEC3 records in the zone have the same OPTOUT @@ -291,4 +290,4 @@ state of an individual NSEC3 record, the entire chain needs to be changed if the OPTOUT state of an individual NSEC3 needs to be changed. - +
    diff --git a/doc/arm/latex-fixup.pl b/doc/arm/latex-fixup.pl deleted file mode 100644 index bad6e9f99b..0000000000 --- a/doc/arm/latex-fixup.pl +++ /dev/null @@ -1,51 +0,0 @@ -#!/usr/bin/perl -w -# -# Copyright (C) 2005, 2007, 2012, 2015 Internet Systems Consortium, Inc. ("ISC") -# -# Permission to use, copy, modify, and/or distribute this software for any -# purpose with or without fee is hereby granted, provided that the above -# copyright notice and this permission notice appear in all copies. -# -# THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH -# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -# AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, -# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM -# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE -# OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR -# PERFORMANCE OF THIS SOFTWARE. - -# $Id: latex-fixup.pl,v 1.5 2007/06/19 23:47:13 tbox Exp $ - -# Sadly, the final stages of generating a presentable PDF file always -# seem to require some manual tweaking. Doesn't seem to matter what -# typesetting tool one uses, sane forms of automation only go so far, -# at least with present technology. -# -# This script is intended to be a collection of tweaks. The theory is -# that, while we can't avoid the need for tweaking, we can at least -# write the silly things down in a form that a program might be able -# to execute. Undoubtedly everythig in here will break, eventually, -# at which point it will need to be updated, but since the alternative -# is to do the final editing by hand every time, this approach seems -# the lesser of two evils. - -while (<>) { - - # Fix a db2latex oops. LaTeX2e does not like having tables with - # duplicate names. Perhaps the dblatex project will fix this - # someday, but we can get by with just deleting the offending - # LaTeX commands for now. - - s/\\addtocounter\{table\}\{-1\}//g; - - # Line break in the middle of quoting one period looks weird. - - s/{\\texttt{{\.\\dbz{}}}}/\\mbox{{\\texttt{{\.\\dbz{}}}}}/; - - # Add any further tweaking here. - # https://en.wikibooks.org/wiki/LaTeX/Special_Characters - s/쎶/{\\"o}/; # umlaut o 쎶 or 쎶 - - # Write out whatever we have now. - print; -} diff --git a/doc/arm/libdns.xml b/doc/arm/libdns.xml index 6b5e81739d..cda668a575 100644 --- a/doc/arm/libdns.xml +++ b/doc/arm/libdns.xml @@ -1,4 +1,3 @@ - - - - BIND 9 DNS Library Support + +
    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). In addition to @@ -52,16 +51,16 @@ libraries than BIND 9's internal event task system. - - Prerequisite +
    Prerequisite + GNU make is required to build the export libraries (other part of BIND 9 can still be built with other types of make). In the reminder of this document, "make" means GNU make. Note that in some platforms you may need to invoke a different command name than "make" (e.g. "gmake") to indicate it's GNU make. - - - Compilation +
    +
    Compilation + $ ./configure --enable-exportlib [other flags] $ make @@ -73,9 +72,9 @@ $ make export version of the BIND 9 DNS library. Sample application programs using the libraries will also be built under the lib/export/samples directory (see below). - - - Installation +
    +
    Installation + $ cd lib/export $ make install @@ -94,9 +93,9 @@ $ make install To see how to build your own application after the installation, see lib/export/samples/Makefile-postinstall.in. - - - Known Defects/Restrictions +
    +
    Known Defects/Restrictions + @@ -140,9 +139,9 @@ $ make version are "debug" and "ndots". - - - The dns.conf File +
    +
    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 @@ -156,16 +155,16 @@ $ make trusted-keys statement is supported, whose syntax is the same as the same name of statement for named.conf. (See - for details.) - - - Sample Applications + 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 +
    sample: a simple stub resolver utility + It sends a query of a given name (of a given optional RR type) to a specified recursive server, and prints the result as a list of @@ -183,7 +182,7 @@ $ make -t RRtype - specify the RR type of the query. The default is the A RR. + specify the RR type of the query. The default is the A RR. @@ -191,20 +190,20 @@ $ make [-a algorithm] [-e] -k keyname -K keystring - specify a command-line DNS key to validate the answer. For - example, to specify the following DNSKEY of example.com: + specify a command-line DNS key to validate the answer. For + example, to specify the following DNSKEY of example.com: - example.com. 3600 IN DNSKEY 257 3 5 xxx + example.com. 3600 IN DNSKEY 257 3 5 xxx - specify the options as follows: + specify the options as follows: - -e -k example.com -K "xxx" + -e -k example.com -K "xxx" - -e means that this key is a zone's "key signing key" (as known - as "secure Entry point"). - When -a is omitted rsasha1 will be used by default. + -e means that this key is a zone's "key signing key" (as known + as "secure Entry point"). + When -a is omitted rsasha1 will be used by default. @@ -212,27 +211,27 @@ $ make -s domain:alt_server_address - specify a separate recursive server address for the specific - "domain". Example: -s example.com:2001:db8::1234 + specify a separate recursive server address for the specific + "domain". Example: -s example.com:2001:db8::1234 server_address - an IP(v4/v6) address of the recursive server to which queries - are sent. + an IP(v4/v6) address of the recursive server to which queries + are sent. hostname - the domain name for the query + the domain name for the query - - - sample-async: a simple stub resolver, working asynchronously +
    +
    sample-async: a simple stub resolver, working asynchronously + Similar to "sample", but accepts a list of (query) domain names as a separate file and resolves the names @@ -276,9 +275,9 @@ $ make - - - sample-request: a simple DNS transaction client +
    +
    sample-request: a simple DNS transaction client + It sends a query to a specified server, and prints the response with minimal processing. It doesn't act as a @@ -328,9 +327,9 @@ $ make - - - sample-gai: getaddrinfo() and getnameinfo() test code +
    +
    sample-gai: getaddrinfo() and getnameinfo() test code + This is a test program to check getaddrinfo() and getnameinfo() behavior. It takes a @@ -344,9 +343,9 @@ $ make Usage: sample-gai hostname - - - sample-update: a simple dynamic update client program +
    +
    sample-update: a simple dynamic update client program + It accepts a single update command as a command-line argument, sends an update request message to the @@ -365,11 +364,11 @@ $ make -a auth_server - 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. + 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. @@ -377,8 +376,8 @@ $ make -k keyfile - A TSIG key file to secure the update transaction. The keyfile - format is the same as that for the nsupdate utility. + A TSIG key file to secure the update transaction. The keyfile + format is the same as that for the nsupdate utility. @@ -386,9 +385,9 @@ $ make -p prerequisite - A prerequisite for the update (only one prerequisite can be - specified). The prerequisite format is the same as that is - accepted by the nsupdate utility. + A prerequisite for the update (only one prerequisite can be + specified). The prerequisite format is the same as that is + accepted by the nsupdate utility. @@ -396,10 +395,10 @@ $ make -r recursive_server - An IP address of a recursive server that this utility will - use. A recursive server may be necessary to identify the - authoritative server address to which the update request is - sent. + An IP address of a recursive server that this utility will + use. A recursive server may be necessary to identify the + authoritative server address to which the update request is + sent. @@ -407,7 +406,7 @@ $ make -z zonename - The domain name of the zone that contains + The domain name of the zone that contains @@ -415,8 +414,8 @@ $ make (add|delete) - Specify the type of update operation. Either "add" or "delete" - must be specified. + Specify the type of update operation. Either "add" or "delete" + must be specified. @@ -424,8 +423,8 @@ $ make "update data" - Specify the data to be updated. A typical example of the data - would look like "name TTL RRtype RDATA". + Specify the data to be updated. A typical example of the data + would look like "name TTL RRtype RDATA". @@ -453,9 +452,9 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mmmm.key delete "foo.dy removes all RRs for foo.dynamic.example.com using the given key. - - - nsprobe: domain/name server checker in terms of RFC 4074 +
    +
    nsprobe: domain/name server checker in terms of RFC 4074 + It checks a set of domains to see the name servers of the domains behave @@ -476,8 +475,8 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mmmm.key delete "foo.dy -d - run in the "debug" mode. with this option nsprobe will dump - every RRs it receives. + run in the "debug" mode. with this option nsprobe will dump + every RRs it receives. @@ -485,8 +484,8 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mmmm.key delete "foo.dy -v - increase verbosity of other normal log messages. This can be - specified multiple times + increase verbosity of other normal log messages. This can be + specified multiple times @@ -494,10 +493,10 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mmmm.key delete "foo.dy -c cache_address - specify 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. + specify 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. @@ -505,26 +504,25 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mmmm.key delete "foo.dy input_file - a file name containing a list of domain (zone) names to be - probed. when omitted the standard input will be used. Each - line of the input file specifies a single domain name such as - "example.com". In general this domain name must be the apex - name of some DNS zone (unlike normal "host names" such as - "www.example.com"). nsprobe first identifies the NS RRsets 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. + a file name containing a list of domain (zone) names to be + probed. when omitted the standard input will be used. Each + line of the input file specifies a single domain name such as + "example.com". In general this domain name must be the apex + name of some DNS zone (unlike normal "host names" such as + "www.example.com"). nsprobe first identifies the NS RRsets 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 +
    +
    +
    Library References + As of this writing, there is no formal "manual" of the libraries, except this document, header files (some of them provide pretty detailed explanations), and sample application programs. - - - +
    +
    diff --git a/doc/arm/logging-categories.xml b/doc/arm/logging-categories.xml index 76b2555112..a216bb7b0c 100644 --- a/doc/arm/logging-categories.xml +++ b/doc/arm/logging-categories.xml @@ -13,8 +13,8 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - - + + diff --git a/doc/arm/man.arpaname.html b/doc/arm/man.arpaname.html index a88cddba65..9e0b7e8a2b 100644 --- a/doc/arm/man.arpaname.html +++ b/doc/arm/man.arpaname.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - arpaname - - + + @@ -39,34 +38,47 @@
    -
    +
    -
    + + + + +

    Name

    -

    arpaname — translate IP addresses to the corresponding ARPA names

    -
    -
    -

    Synopsis

    -

    arpaname {ipaddress ...}

    -
    -
    -

    DESCRIPTION

    - arpaname translates IP addresses (IPv4 and + arpaname + — translate IP addresses to the corresponding ARPA names +

    +
    + + + +
    +

    Synopsis

    +

    + arpaname + {ipaddress ...} +

    +
    + +
    +

    DESCRIPTION

    + +

    + arpaname translates IP addresses (IPv4 and IPv6) to the corresponding IN-ADDR.ARPA or IP6.ARPA names.

    -
    -
    -

    SEE ALSO

    -

    +

    + +
    +

    SEE ALSO

    + +

    BIND 9 Administrator Reference Manual.

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.ddns-confgen.html b/doc/arm/man.ddns-confgen.html index 283792f66a..11aef4d9b0 100644 --- a/doc/arm/man.ddns-confgen.html +++ b/doc/arm/man.ddns-confgen.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - ddns-confgen - - + + @@ -39,59 +38,94 @@
    -
    +
    -
    + + + + + +

    Name

    -

    ddns-confgen — ddns key generation tool

    -
    -
    -

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    -

    ddns-confgen - generates a key for use by nsupdate - and named. It simplifies configuration - of dynamic zones by generating a key and providing the - nsupdate and named.conf - syntax that will be needed to use it, including an example - update-policy statement. -

    + ddns-confgen + — ddns key generation tool +

    +
    + + + +
    +

    Synopsis

    +

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

    +
    + +
    +

    DESCRIPTION

    + +

    ddns-confgen + generates a key for use by nsupdate + and named. It simplifies configuration + of dynamic zones by generating a key and providing the + nsupdate and named.conf + syntax that will be needed to use it, including an example + update-policy statement. +

    + +

    If a domain name is specified on the command line, it will be used in the name of the generated key and in the sample - named.conf syntax. For example, - ddns-confgen example.com would + named.conf syntax. For example, + ddns-confgen example.com would generate a key called "ddns-key.example.com", and sample - named.conf command that could be used + named.conf command that could be used in the zone definition for "example.com".

    -

    - Note that named itself can configure a - local DDNS key for use with nsupdate -l. - ddns-confgen is only needed when a + +

    + Note that named itself can configure a + local DDNS key for use with nsupdate -l. + ddns-confgen is only needed when a more elaborate configuration is required: for instance, if - nsupdate is to be used from a remote system. + nsupdate is to be used from a remote system.

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

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

    +

    +
    -h
    -

    +

    +

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

    + ddns-confgen. +

    +
    -k keyname
    -

    +

    +

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

    +

    +
    -q
    -

    +

    +

    Quiet mode: Print only the key, with no explanatory text or usage examples. -

    +

    +
    -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 @@ -118,10 +156,12 @@ instead of the default. The special value keyboard indicates that keyboard input should be used. -

    +

    +
    -s name
    -

    - Single host mode: The example named.conf text +

    +

    + Single host mode: The example named.conf text shows how to set an update policy for the specified name using the "name" nametype. @@ -130,32 +170,39 @@ 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
    -

    - zone mode: The example named.conf text +

    +

    + zone mode: The example named.conf text shows how to set an update policy for the specified zone using the "zonesub" nametype, allowing updates to all subdomain names within that zone. This option cannot be used with the -s option. -

    +

    +
    -
    -
    -

    SEE ALSO

    -

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

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dig.html b/doc/arm/man.dig.html index 0e2198e6af..efc78d8ef6 100644 --- a/doc/arm/man.dig.html +++ b/doc/arm/man.dig.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dig - - + + @@ -39,188 +38,271 @@
    -
    +
    -
    + + + + + + +

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

    -
    -
    -

    DESCRIPTION

    -

    dig +

    + 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 (domain information groper) is a flexible tool for interrogating DNS name servers. It performs DNS lookups and displays the answers that are returned from the name server(s) that - were queried. Most DNS administrators use dig to + were queried. Most DNS administrators use dig to troubleshoot DNS problems because of its flexibility, ease of use and clarity of output. Other lookup tools tend to have less functionality - than dig. + than dig.

    -

    - Although dig is normally used with + +

    + Although dig 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 -h option is given. Unlike earlier versions, the BIND 9 implementation of - dig allows multiple lookups to be issued + dig allows multiple lookups to be issued from the command line.

    -

    + +

    Unless it is told to query a specific name server, - dig will try each of the servers listed in + 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 + 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). + dig will perform an NS query for "." (the root).

    -

    - It is possible to set per-user defaults for dig via + +

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

    -

    + +

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

    -
    -
    -

    SIMPLE USAGE

    -

    - A typical invocation of dig looks like: + +

    + +
    +

    SIMPLE USAGE

    + + +

    + A typical invocation of dig looks like:

     dig @server name type 

    where:

    -
    +
    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 server argument is a hostname, - dig resolves that name before querying + dig resolves that name before querying that name server.

    -

    +

    If no server argument is - provided, dig consults + provided, dig consults /etc/resolv.conf; if an address is found there, it queries the name server at that address. If either of the -4 or -6 options are in use, then only addresses for the corresponding transport will be tried. If no usable addresses are found, - dig will send the query to the + dig will send the query to the 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 type. If no type argument is supplied, - dig will perform a lookup for an + dig will perform a lookup for an A record. -

    +

    +

    -
    -
    -

    OPTIONS

    -
    + +
    + +
    +

    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 +

    +

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

    + dig using the command-line interface. +

    +
    -i
    -

    +

    +

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

    +

    +
    -k keyfile
    -

    +

    +

    Sign queries using TSIG using a key read from the given file. Key files can be generated using - tsig-keygen(8). - When using TSIG authentication with dig, + + 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 + providing appropriate key + and server statements in named.conf. -

    +

    +
    -m
    -

    +

    +

    Enable memory usage debugging. -

    +

    +
    -p port
    -

    +

    +

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

    +

    +
    -q name
    -

    +

    +

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

    +

    +
    -t type
    -

    +

    +

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

    +

    +
    -v
    -

    +

    +

    Print the version number and exit. -

    +

    +
    -x addr
    -

    +

    +

    Simplified reverse lookups, for mapping addresses to names. The addr is an IPv4 address in dotted-decimal notation, or a colon-delimited IPv6 @@ -246,17 +332,18 @@ need to provide the name, class and type - arguments. dig automatically performs a + arguments. dig automatically performs a lookup for a name like 94.2.0.192.in-addr.arpa 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 -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. @@ -267,28 +354,34 @@ hmac-sha512. If hmac is not specified, the default is hmac-md5.

    -

    +

    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 +

    + +
    +

    QUERY OPTIONS

    + + +

    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 @@ -302,22 +395,29 @@ The query options are:

    -
    +
    +[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 @@ -327,123 +427,161 @@ from a OPT-OUT range. AD=0 indicate that some part of the answer was insecure or not validated. This bit is set by default. -

    +

    +
    +[no]all
    -

    +

    +

    Set or clear all display flags. -

    +

    +
    +[no]answer
    -

    +

    +

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

    +

    +
    +[no]authority
    -

    +

    +

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

    +

    +
    +[no]besteffort
    -

    +

    +

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

    +

    +
    +bufsize=B
    -

    +

    +

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

    +

    +
    +[no]cdflag
    -

    +

    +

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

    +

    +
    +[no]class
    -

    +

    +

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

    +

    +
    +[no]cmd
    -

    +

    +

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

    +

    +
    +[no]comments
    -

    +

    +

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

    +

    +
    +[no]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 + a domain directive in /etc/resolv.conf, and enable search list processing as if the +search option were given. -

    +

    +
    +[no]edns[=#]
    -

    +

    +

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

    +

    +
    +[no]fail
    -

    +

    +

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

    +

    +
    +[no]identify
    -

    +

    +

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

    +

    +
    +[no]ignore
    -

    +

    +

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

    +

    +
    +[no]keepopen
    -

    +

    +

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

    +

    +
    +[no]multiline
    -

    +

    +

    Print records like the SOA records in a verbose multi-line format with human-readable comments. The default is to print each record on a single line, to - facilitate machine parsing of the dig + 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 @@ -455,97 +593,123 @@ 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 +

    +

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

    +

    +

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

    +

    +
    +[no]question
    -

    +

    +

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

    +

    +
    +[no]rdflag
    -

    +

    +

    A synonym for +[no]recurse. -

    +

    +
    +[no]recurse
    -

    +

    +

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

    +

    +
    +retry=T
    -

    +

    +

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

    +

    +
    +[no]rrcomments
    -

    +

    +

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

    +

    +
    +[no]search
    -

    +

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

    -

    +

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

    -
    +
    +[no]short
    -

    +

    +

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

    +

    +
    +[no]showsearch
    -

    +

    +

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

    +

    +
    +[no]sigchase
    -

    +

    +

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

    +

    +
    +split=W
    -

    +

    +

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

    +

    +
    +[no]stats
    -

    +

    +

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

    +

    +
    +[no]tcp
    -

    +

    +

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

    +

    +
    +time=T
    -

    +

    +

    Sets the timeout for a query to T seconds. The default @@ -579,86 +749,95 @@ An attempt to set T to less than 1 will result in a query timeout of 1 second being applied. -

    +

    +
    +[no]topdown
    -

    +

    +

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

    +

    +
    +[no]trace
    -

    +

    Toggle tracing of the delegation path from the root name servers for the name being looked up. Tracing is disabled by default. When tracing is enabled, - dig makes iterative queries to + dig 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. -

    -

    +

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

    -

    - +dnssec is also set when +trace +

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

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

    -

    +

    Requires dig be compiled with -DDIG_SIGCHASE.

    -
    +
    +[no]ttlid
    -

    +

    +

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

    +

    +
    +[no]vc
    -

    +

    +

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

    +

    +

    -
    -
    -

    MULTIPLE QUERIES

    -

    - The BIND 9 implementation of dig +

    + +
    +

    MULTIPLE QUERIES

    + + +

    + The BIND 9 implementation of dig supports specifying multiple queries on the command line (in addition to supporting the -f batch file option). Each of those 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 @@ -666,7 +845,8 @@ looked up, an optional query type and class and any query options that should be applied to that query.

    -

    + +

    A global set of query options, which should be applied to all queries, can also be supplied. These global query options must precede the first tuple of name, class, type, options, flags, and query options @@ -678,7 +858,7 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr

    - shows how dig could be used from the + shows how dig could be used from the command line to make three lookups: an ANY query for www.isc.org, a reverse lookup of 127.0.0.1 and a query for the NS records of @@ -686,49 +866,64 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr A global query option of +qr is applied, so - that dig shows the initial query it made + that dig shows the initial query it made for each lookup. The final query has a local query option of - +noqr which means that dig + +noqr which means that dig 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 + +

    + +
    +

    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 + dig appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the IDN_DISABLE environment variable. The IDN support is disabled if the variable is set when - dig runs. + dig runs.

    -
    -
    -

    FILES

    -

    /etc/resolv.conf +

    + +
    +

    FILES

    + +

    /etc/resolv.conf

    -

    ${HOME}/.digrc +

    ${HOME}/.digrc

    -
    -
    -

    SEE ALSO

    -

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

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    BUGS

    -

    +

    + +
    +

    BUGS

    + +

    There are probably too many query options.

    -
    + -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dnssec-checkds.html b/doc/arm/man.dnssec-checkds.html index 0d963a1b16..57b42f709f 100644 --- a/doc/arm/man.dnssec-checkds.html +++ b/doc/arm/man.dnssec-checkds.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-checkds - - + + @@ -39,66 +38,108 @@
    -
    +
    -
    + + + + + +

    Name

    -

    dnssec-checkds — A DNSSEC delegation consistency checking tool.

    +

    + dnssec-checkds + — A 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}

    -
    -
    -

    DESCRIPTION

    -

    dnssec-checkds +

    + 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 verifies the correctness of Delegation Signer (DS) or DNSSEC Lookaside Validation (DLV) resource records for keys in a specified zone.

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

    OPTIONS

    + + +
    -f file
    -

    +

    +

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

    +

    +
    -l domain
    -

    +

    +

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

    + dnssec-checkds -l dlv.isc.org example.com +

    +
    -d dig path
    -

    - Specifies a path to a dig binary. Used +

    +

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

    +

    +
    -D dsfromkey path
    -

    - Specifies a path to a dnssec-dsfromkey binary. +

    +

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

    +

    +
    -
    -
    -

    SEE ALSO

    -

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

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dnssec-coverage.html b/doc/arm/man.dnssec-coverage.html index 99b93ee349..4b6ef3c0b6 100644 --- a/doc/arm/man.dnssec-coverage.html +++ b/doc/arm/man.dnssec-coverage.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-coverage - - + + @@ -39,24 +38,46 @@
    -
    +
    -
    + + + + + +

    Name

    -

    dnssec-coverage — checks future DNSKEY coverage for a zone

    +

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

    -
    + + + +

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    -

    dnssec-coverage +

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

    +
    + +
    +

    DESCRIPTION

    + +

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

    -

    +

    If zone is specified, then keys found in the key repository matching that zone are scanned, and an ordered list is generated of the events scheduled for that key (i.e., @@ -69,33 +90,40 @@ 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

    -
    +
    + +
    +

    OPTIONS

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

    +

    +
    -K directory
    -

    +

    +

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

    +

    +
    -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 @@ -104,21 +132,21 @@ 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 mandatory unless 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.)

    -
    +
    -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 @@ -128,59 +156,67 @@ 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 mandatory unless the -f has been used to specify a zone file, or a default key TTL was set with the -L to - dnssec-keygen. (If either of those is true, + dnssec-keygen. (If either of those is true, this option may still be used; it will override the value found in the zone or key file.)

    -
    +
    -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 22.5 days, which is also the default in - named. However, if it has been changed + named. However, if it has been changed by the sig-validity-interval option in 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.

    -
    +
    -c compilezone path
    -

    - Specifies a path to a named-compilezone binary. +

    +

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

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dnssec-dsfromkey.html b/doc/arm/man.dnssec-dsfromkey.html index 080bd802e0..bf30406fff 100644 --- a/doc/arm/man.dnssec-dsfromkey.html +++ b/doc/arm/man.dnssec-dsfromkey.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-dsfromkey - - + + @@ -39,166 +38,245 @@
    -
    +
    -
    + + + + + +

    Name

    -

    dnssec-dsfromkey — DNSSEC DS RR generation tool

    +

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

    -
    + + + +

    Synopsis

    -

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

    -

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

    -

    dnssec-dsfromkey [-h] [-V]

    -
    -
    -

    DESCRIPTION

    -

    dnssec-dsfromkey +

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

    +

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

    +

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

    +
    + +
    +

    DESCRIPTION

    + +

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

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

    OPTIONS

    + + +
    -1
    -

    +

    +

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

    +

    +
    -2
    -

    +

    +

    Use SHA-256 as the digest algorithm. -

    +

    +
    -a algorithm
    -

    +

    +

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

    +

    +
    -C
    -

    +

    +

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

    +

    +
    -T TTL
    -

    +

    +

    Specifies the TTL of the DS records. -

    +

    +
    -K directory
    -

    +

    +

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

    +

    +
    -f file
    -

    +

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

    -

    +

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

    -

    +

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

    -
    +
    -A
    -

    +

    +

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

    +

    +
    -l domain
    -

    +

    +

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

    +

    +
    -s
    -

    +

    +

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

    +

    +
    -c class
    -

    +

    +

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

    +

    +
    -v level
    -

    +

    +

    Sets the debugging level. -

    +

    +
    -h
    -

    +

    +

    Prints usage information. -

    +

    +
    -V
    -

    +

    +

    Prints version information. -

    +

    +
    -
    -
    -

    EXAMPLE

    -

    +

    + +
    +

    EXAMPLE

    + +

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

    -

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

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

    -

    +

    The command would print something like:

    -

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

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

    -
    -
    -

    FILES

    -

    +

    + +
    +

    FILES

    + +

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

    -

    +

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

    -
    -
    -

    CAVEAT

    -

    +

    + +
    +

    CAVEAT

    + +

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

    -
    -
    -

    SEE ALSO

    -

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

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dnssec-importkey.html b/doc/arm/man.dnssec-importkey.html index 5e2d13f9c9..d3b826141d 100644 --- a/doc/arm/man.dnssec-importkey.html +++ b/doc/arm/man.dnssec-importkey.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-importkey - - + + @@ -39,20 +38,54 @@
    -
    +
    -
    + + + + + +

    Name

    -

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

    +

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

    -
    + + + +

    Synopsis

    -

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

    -

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

    -
    -
    -

    DESCRIPTION

    -

    dnssec-importkey +

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

    +

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

    +
    + +
    +

    DESCRIPTION

    + +

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

    -

    +

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

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

    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

    -

    +

    + +
    +

    TIMING OPTIONS

    + +

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

    -
    + +
    -P date/offset
    -

    +

    +

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

    +

    +
    -D date/offset
    -

    +

    +

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

    +

    +
    -
    -
    -

    FILES

    -

    +

    + +
    +

    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), +

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dnssec-keyfromlabel.html b/doc/arm/man.dnssec-keyfromlabel.html index cd1e843392..e4b1b539ab 100644 --- a/doc/arm/man.dnssec-keyfromlabel.html +++ b/doc/arm/man.dnssec-keyfromlabel.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-keyfromlabel - - + + @@ -39,142 +38,211 @@
    -
    +
    -
    + + + + + +

    Name

    -

    dnssec-keyfromlabel — DNSSEC key generation tool

    +

    + dnssec-keyfromlabel + — DNSSEC key generation tool +

    -
    + + + +

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    -

    dnssec-keyfromlabel +

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

    +
    + +
    +

    DESCRIPTION

    + +

    dnssec-keyfromlabel 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 dnssec-keygen, + conventional signing key created by dnssec-keygen, 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

    -
    +
    + +
    +

    OPTIONS

    + + +
    -a algorithm
    -

    +

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

    -

    +

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

    -

    +

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

    -

    +

    Note 2: DH automatically sets the -k flag.

    -
    +
    -3
    -

    +

    +

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

    +

    +
    -E engine
    -

    +

    +

    Specifies the name of the crypto hardware (OpenSSL engine). When compiled with PKCS#11 support it defaults to "pkcs11". -

    +

    +
    -l label
    -

    +

    +

    Specifies the label of the key pair in the crypto hardware. The label may be preceded by an optional OpenSSL engine name, separated by a colon, as in "pkcs11:keylabel". -

    +

    +
    -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 + any metadata. By default, dnssec-keyfromlabel will include the key's 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 -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. -

    + 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 @@ -182,35 +250,47 @@ one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. -

    +

    +
    -t type
    -

    +

    +

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

    +

    +
    -v level
    -

    +

    +

    Sets the debugging level. -

    +

    +
    -V
    -

    +

    +

    Prints version information. -

    +

    +
    -y
    -

    +

    +

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

    +

    +
    -
    -
    -

    TIMING OPTIONS

    -

    +

    + +
    +

    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 @@ -221,42 +301,53 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

    -
    + +
    -P date/offset
    -

    +

    +

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

    +

    +
    -A date/offset
    -

    +

    +

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

    +

    +
    -R date/offset
    -

    +

    +

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

    +

    +
    -I date/offset
    -

    +

    +

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

    +

    +
    -D date/offset
    -

    +

    +

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

    +

    +
    -i interval
    -

    +

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

    -

    +

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

    -

    +

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

    -
    +
    -
    -
    -

    GENERATED KEY FILES

    -

    - When dnssec-keyfromlabel completes +

    + +
    +

    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), +

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dnssec-keygen.html b/doc/arm/man.dnssec-keygen.html index ea94dfe3f8..30679e4a9e 100644 --- a/doc/arm/man.dnssec-keygen.html +++ b/doc/arm/man.dnssec-keygen.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-keygen - - + + @@ -39,36 +38,84 @@
    -
    +
    -
    + + + + + +

    Name

    -

    dnssec-keygen — DNSSEC key generation tool

    +

    + dnssec-keygen + — DNSSEC key generation tool +

    -
    + + + +

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    -

    dnssec-keygen +

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

    +
    + +
    +

    DESCRIPTION

    + +

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

    -
    +
    + +
    +

    OPTIONS

    + + +
    -a algorithm
    -

    +

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

    -

    +

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

    -

    +

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

    -

    +

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

    -
    +
    -b keysize
    -

    +

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

    -

    +

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

    -
    +
    -n nametype
    -

    +

    +

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

    +

    +
    -3
    -

    +

    +

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

    +

    +
    -C
    -

    +

    +

    Compatibility mode: generates an old-style key, without - any metadata. By default, dnssec-keygen + any metadata. By default, dnssec-keygen will include the key's 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 -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
    -

    +

    +

    Uses a crypto hardware (OpenSSL engine) for random number and, when supported, key generation. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. -

    +

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

    + 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 @@ -197,19 +267,23 @@ is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to 0 or none is the same as leaving it unset. -

    +

    +
    -p protocol
    -

    +

    +

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

    +

    +
    -q
    -

    +

    +

    Quiet mode: Suppresses unnecessary output, including progress indication. Without this option, when - dnssec-keygen is run interactively + dnssec-keygen 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 '.' indicates that a @@ -218,9 +292,11 @@ round of the Miller-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key. -

    +

    +
    -r randomdev
    -

    +

    +

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

    +

    +
    -S key
    -

    +

    +

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

    +

    +
    -s strength
    -

    +

    +

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

    +

    +
    -T rrtype
    -

    +

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

    -
    +
    -t type
    -

    +

    +

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

    +

    +
    -v level
    -

    +

    +

    Sets the debugging level. -

    +

    +
    -V
    -

    +

    +

    Prints version information. -

    +

    +
    -
    -
    -

    TIMING OPTIONS

    -

    +

    + +
    +

    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 @@ -292,44 +382,55 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

    -
    + +
    -P date/offset
    -

    +

    +

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

    +

    +
    -A date/offset
    -

    +

    +

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

    +

    +
    -R date/offset
    -

    +

    +

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

    +

    +
    -I date/offset
    -

    +

    +

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

    +

    +
    -D date/offset
    -

    +

    +

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

    +

    +
    -i interval
    -

    +

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

    -

    +

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

    -

    +

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

    -
    +
    -
    -
    -

    GENERATED KEYS

    -

    - When dnssec-keygen completes +

    + + +
    +

    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 @@ -381,59 +491,61 @@ private key.

      -

      +

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

      -

      +

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

      -

      +

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

      -
    -
    -

    EXAMPLE

    -

    +

    + +
    +

    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 +

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

    -
    -
    -

    SEE ALSO

    -

    dnssec-signzone(8), +

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dnssec-revoke.html b/doc/arm/man.dnssec-revoke.html index 1398b82cc1..fd6d19a6e4 100644 --- a/doc/arm/man.dnssec-revoke.html +++ b/doc/arm/man.dnssec-revoke.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-revoke - - + + @@ -39,78 +38,119 @@
    -
    +
    -
    + + + + +

    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}

    -
    -
    -

    DESCRIPTION

    -

    dnssec-revoke +

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

    +
    + +
    +

    DESCRIPTION

    + +

    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

    -
    +
    + +
    +

    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
    -

    +

    +

    Use the given OpenSSL engine. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. -

    +

    +
    -f
    -

    - Force overwrite: Causes dnssec-revoke to +

    +

    + 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), +

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dnssec-settime.html b/doc/arm/man.dnssec-settime.html index 98e0d2d4ec..b5bc6f2856 100644 --- a/doc/arm/man.dnssec-settime.html +++ b/doc/arm/man.dnssec-settime.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-settime - - + + @@ -39,33 +38,61 @@
    -
    +
    -
    + + + + + +

    Name

    -

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

    +

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

    -
    + + + +

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    -

    dnssec-settime +

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

    +
    + +
    +

    DESCRIPTION

    + +

    dnssec-settime reads a DNSSEC private key file and sets the key timing metadata as specified by the -P, -A, -R, -I, and -D options. The metadata can then be used by - dnssec-signzone or other signing software to + dnssec-signzone or other signing software to 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 + then dnssec-settime simply prints the key timing metadata already stored in the key.

    -

    +

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

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

    OPTIONS

    + + +
    -f
    -

    +

    +

    Force an update of an old-format key with no metadata fields. - Without this option, dnssec-settime will + Without this option, dnssec-settime 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's creation date will be set to the present time. If no other values are specified, then the key's publication and activation dates will also be set to the present time. -

    +

    +
    -K directory
    -

    +

    +

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

    +

    +
    -L ttl
    -

    +

    +

    Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was @@ -103,29 +138,40 @@ 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
    -

    +

    +

    Use the given OpenSSL engine. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. -

    +

    +
    -
    -
    -

    TIMING OPTIONS

    -

    +

    + +
    +

    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 @@ -135,39 +181,51 @@ days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To unset a date, use 'none' or 'never'.

    -
    + +
    -P date/offset
    -

    +

    +

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

    +

    +
    -A date/offset
    -

    +

    +

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

    +

    +
    -R date/offset
    -

    +

    +

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

    +

    +
    -I date/offset
    -

    +

    +

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

    +

    +
    -D date/offset
    -

    +

    +

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

    +

    +
    -S predecessor key
    -

    +

    +

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

    +

    +
    -i interval
    -

    +

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

    -

    +

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

    -

    +

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

    -
    +
    -
    -
    -

    PRINTING OPTIONS

    -

    - dnssec-settime can also be used to print the +

    + +
    +

    PRINTING OPTIONS

    + +

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

    -
    + +
    -u
    -

    +

    +

    Print times in UNIX epoch format. -

    +

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

    +

    +

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

    +

    +
    -
    -
    -

    SEE ALSO

    -

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

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dnssec-signzone.html b/doc/arm/man.dnssec-signzone.html index 76cf589e7e..c5ca0b1394 100644 --- a/doc/arm/man.dnssec-signzone.html +++ b/doc/arm/man.dnssec-signzone.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-signzone - - + + @@ -39,19 +38,72 @@
    -
    +
    -
    + + + + + +

    Name

    -

    dnssec-signzone — DNSSEC zone signing tool

    +

    + dnssec-signzone + — DNSSEC zone signing tool +

    -
    + + + +

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    -

    dnssec-signzone +

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

    +
    + +
    +

    DESCRIPTION

    + +

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

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

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

    + 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, + dnssec-signzone, i.e. RRSIG, NSEC, NSEC3 and NSEC3PARAM records. If smart signing (-S) is used, DNSKEY records are also included. The resulting file can be included in the original - zone file with $INCLUDE. This option + zone file with $INCLUDE. This option cannot be combined with -O raw or serial number updating. -

    +

    +
    -E engine
    -

    +

    +

    Uses a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance signing with private keys from a secure key store. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. -

    +

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

    +

    +
    -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 @@ -134,9 +210,11 @@ indicated by +N, which is N seconds from the current time. If no start-time is specified, the current time minus 1 hour (to allow for clock skew) is used. -

    +

    +
    -e end-time
    -

    +

    +

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

    +

    +
    -X extended end-time
    -

    +

    Specify the date and time when the generated RRSIG records for the DNSKEY RRset will expire. This is to be used in cases when the DNSKEY signatures need to persist longer than @@ -157,7 +236,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 @@ -168,28 +247,34 @@ 30 days from the start time.) extended end-time must be later than start-time.

    -
    +
    -f output-file
    -

    +

    +

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

    +

    +
    -h
    -

    +

    +

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

    + 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 @@ -197,32 +282,34 @@ 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 - are specified, dnssec-signzone + are specified, dnssec-signzone 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.

    -
    +
    -I input-format
    -

    +

    +

    The format of the input zone file. - Possible formats are "text" (default) - and "raw". + Possible formats are "text" (default) + and "raw". 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. -

    +

    +
    -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. @@ -233,116 +320,135 @@ 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' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) -

    +

    +
    -n ncpus
    -

    +

    +

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

    +

    +
    -N soa-serial-format
    -

    +

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

    -
    -
    "keep"
    -

    Do not modify the SOA serial number.

    -
    "increment"
    -

    Increment the SOA serial number using RFC 1982 - arithmetics.

    -
    "unixtime"
    -

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

    + +
    +
    "keep"
    +
    +

    Do not modify the SOA serial number.

    +
    +
    "increment"
    +
    +

    Increment the SOA serial number using RFC 1982 + arithmetics.

    +
    +
    "unixtime"
    +
    +

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

    +
    -
    + +
    -o origin
    -

    +

    +

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

    +

    +
    -O output-format
    -

    +

    +

    The format of the output file containing the signed zone. - Possible formats are "text" (default) - "full", which is text output in a + Possible formats are "text" (default) + "full", which is text output in a format suitable for processing by external scripts, - and "raw" or "raw=N", + and "raw" or "raw=N", which store the zone in a binary format for rapid loading - by named. "raw=N" + by named. "raw=N" specifies the format version of 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 + 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 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 -Q - forces dnssec-signzone to remove + forces dnssec-signzone 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").

    -
    +
    -R
    -

    +

    Remove signatures from keys that are no longer published.

    -

    +

    This option is similar to -Q, except it - forces dnssec-signzone to signatures from + 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 @@ -352,53 +458,65 @@ data to be used instead of the default. The special value keyboard indicates that keyboard input should be used. -

    +

    +
    -S
    -

    - Smart signing: Instructs dnssec-signzone to +

    + 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 @@ -410,100 +528,121 @@ 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 + 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.) -

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

    + 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

    -

    +

    + +
    +

    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 + zone with the DSA key generated by dnssec-keygen + (Kexample.com.+003+17247). Because the -S option is not being used, the zone's keys must be in the master file (db.example.com). This invocation looks for dsset files, in the current directory, - so that DS records can be imported from them (-g). + so that DS records can be imported from them (-g).

    % dnssec-signzone -g -o example.com db.example.com \
     Kexample.com.+003+17247
     db.example.com.signed
     %
    -

    - In the above example, dnssec-signzone creates +

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

    @@ -511,19 +650,19 @@ db.example.com.signed % dnssec-signzone -o example.com db.example.com db.example.com.signed %
    - -
    -

    SEE ALSO

    -

    dnssec-keygen(8), +

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    + + -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.dnssec-verify.html b/doc/arm/man.dnssec-verify.html index 8226402f23..4342d26c57 100644 --- a/doc/arm/man.dnssec-verify.html +++ b/doc/arm/man.dnssec-verify.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - dnssec-verify - - + + @@ -39,67 +38,106 @@
    -
    +
    -
    + + + + + +

    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}

    -
    -
    -

    DESCRIPTION

    -

    dnssec-verify +

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

    +
    + +
    +

    DESCRIPTION

    + +

    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

    -
    +
    + +
    +

    OPTIONS

    + + +
    -c class
    -

    +

    +

    Specifies the DNS class of the zone. -

    +

    +
    -I input-format
    -

    +

    +

    The format of the input zone file. - Possible formats are "text" (default) - and "raw". + Possible formats are "text" (default) + and "raw". 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. -

    +

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

    + 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 @@ -107,35 +145,37 @@ 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 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 -z - option in dnssec-signzone. + option in dnssec-signzone.

    -
    +
    zonefile
    -

    +

    +

    The file containing the zone to be signed. -

    +

    +
    -
    -
    -

    SEE ALSO

    -

    - dnssec-signzone(8), +

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.genrandom.html b/doc/arm/man.genrandom.html index b6205d8f71..b77cc4108a 100644 --- a/doc/arm/man.genrandom.html +++ b/doc/arm/man.genrandom.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - genrandom - - + + @@ -39,55 +38,83 @@
    -
    +
    -
    + + + + + +

    Name

    -

    genrandom — generate a file containing random data

    -
    -
    -

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    - genrandom + genrandom + — generate a file containing random data +

    +
    + + + +
    +

    Synopsis

    +

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

    +
    + +
    +

    DESCRIPTION

    + +

    + genrandom generates a file or a set of files containing a specified quantity of pseudo-random data, which can be used as a source of entropy for other commands on systems with no random device.

    -
    -
    -

    ARGUMENTS

    -
    +
    + +
    +

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

    + +
    +

    SEE ALSO

    + +

    + + rand(3) + , + + arc4random(3) +

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.host.html b/doc/arm/man.host.html index f88ac121bf..4548492e48 100644 --- a/doc/arm/man.host.html +++ b/doc/arm/man.host.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - host - - + + @@ -39,58 +38,92 @@
    -
    +
    -
    + + + + + +

    Name

    -

    host — DNS lookup utility

    +

    + host + — DNS lookup utility +

    -
    + + + +

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    -

    host +

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

    +
    + +
    +

    DESCRIPTION

    + + +

    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 + 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 + IPv6 address, in which case host will by default perform a reverse lookup for that address. server is an optional argument which is either - the name or IP address of the name server that host + the name or IP address of the name server that host should query instead of the server or servers listed in /etc/resolv.conf.

    -

    + +

    The -a (all) option is equivalent to setting the - -v option and asking host to make + -v option and asking host to make a query of type ANY.

    -

    - When the -C option is used, host + +

    + When the -C option is used, host will attempt to display 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.

    -

    + +

    The -c option instructs to make a DNS query of class class. This can be used to lookup Hesiod or Chaosnet class resource records. The default class is IN (Internet).

    -

    - Verbose output is generated by host when + +

    + Verbose output is generated by host when the -d or -v option is used. The two options are equivalent. They have been provided for backwards @@ -98,21 +131,24 @@ switched on debugging traces and -v enabled verbose output.

    -

    + +

    List mode is selected by the -l option. This makes - host perform a zone transfer for zone + host perform a zone transfer for zone name. Transfer the zone printing out the NS, PTR and address records (A/AAAA). If combined with -a all records will be printed.

    -

    + +

    The -i option specifies that reverse lookups of IPv6 addresses should use the IP6.INT domain as defined in RFC1886. The default is to use IP6.ARPA.

    -

    + +

    The -N option sets the number of dots that have to be in name for it to be considered absolute. The @@ -124,112 +160,132 @@ or domain directive in /etc/resolv.conf.

    -

    + +

    The number of UDP retries for a lookup can be changed with the -R option. number indicates - how many times host will repeat a query + how many times host will repeat a query that does not get answered. The default number of retries is 1. If number is negative or zero, the number of retries will default to 1.

    -

    + +

    Non-recursive queries can be made via the -r option. Setting this option clears the RD — recursion - desired — bit in the query which host makes. + desired — bit in the query which host makes. This should mean that the name server receiving the query will not attempt to resolve name. The - -r option enables host + -r option enables host to mimic the behavior of a name server by making non-recursive queries and expecting to receive answers to those queries that are usually referrals to other name servers.

    -

    - By default, host uses UDP when making + +

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

    -

    - The -4 option forces host to only + +

    + The -4 option forces host to only use IPv4 query transport. The -6 option forces - host to only use IPv6 query transport. + host to only use IPv6 query transport.

    -

    + +

    The -t option is used to select the query type. type can be any recognized query type: CNAME, NS, SOA, SIG, KEY, AXFR, etc. When no query type is specified, - host automatically selects an appropriate + host automatically selects an appropriate query type. By default, it looks for A, AAAA, and MX records, but if the -C option was given, queries will be made for SOA records, and if name is a dotted-decimal IPv4 - address or colon-delimited IPv6 address, host will + address or colon-delimited IPv6 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 (e.g. -t IXFR=12345678).

    -

    + +

    The time to wait for a reply can be controlled through the -W and -w options. The - -W option makes host + -W option makes host wait for wait seconds. If wait is less than one, the wait interval is set to one second. When the - -w option is used, host + -w option is used, host will effectively wait forever for a reply. The time to wait for a response will be set to the number of seconds given by the hardware's maximum value for an integer quantity.

    -

    - The -s option tells host + +

    + The -s option tells host not to send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior.

    -

    + +

    The -m can be used to set the memory usage debugging flags record, usage and trace.

    -

    - The -V option causes host + +

    + The -V option causes host to print the version number and exit.

    -
    -
    -

    IDN SUPPORT

    -

    - If host has been built with IDN (internationalized +

    + +
    +

    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 + host appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the IDN_DISABLE environment variable. The IDN support is disabled if the variable is set when - host runs. + host runs.

    -
    -
    -

    FILES

    -

    /etc/resolv.conf +

    + +
    +

    FILES

    + +

    /etc/resolv.conf

    -
    -
    -

    SEE ALSO

    -

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

    + +
    +

    SEE ALSO

    + +

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

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.isc-hmac-fixup.html b/doc/arm/man.isc-hmac-fixup.html index 99dba6b1a8..c64b2c7b0f 100644 --- a/doc/arm/man.isc-hmac-fixup.html +++ b/doc/arm/man.isc-hmac-fixup.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - isc-hmac-fixup - - + + @@ -39,19 +38,36 @@
    -
    +
    -
    + + + + + +

    Name

    -

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

    -
    -
    -

    Synopsis

    -

    isc-hmac-fixup {algorithm} {secret}

    -
    -
    -

    DESCRIPTION

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

    +
    + + + +
    +

    Synopsis

    +

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

    +
    + +
    +

    DESCRIPTION

    + +

    Versions of BIND 9 up to and including BIND 9.6 had a bug causing HMAC-SHA* TSIG keys which were longer than the digest length of the hash algorithm (i.e., SHA1 keys longer than 160 bits, SHA256 keys @@ -59,14 +75,14 @@ message authentication code that was incompatible with other DNS implementations.

    -

    +

    This bug has been fixed in BIND 9.7. However, the fix may cause incompatibility between older and newer versions of - BIND, when using long keys. isc-hmac-fixup + BIND, when using long keys. isc-hmac-fixup modifies those keys to restore compatibility.

    -

    - To modify a key, run isc-hmac-fixup and +

    + 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 for SHA1 through SHA256, or 128 bytes for SHA384 and SHA512), then a @@ -74,30 +90,30 @@ 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 +

    + +
    +

    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, "Keys longer than [the digest length] are acceptable but the extra length would not significantly increase the function strength."

    -
    -
    -

    SEE ALSO

    -

    +

    + +
    +

    SEE ALSO

    + +

    BIND 9 Administrator Reference Manual, RFC 2104.

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.lwresd.html b/doc/arm/man.lwresd.html index ada130891d..a503e575c7 100644 --- a/doc/arm/man.lwresd.html +++ b/doc/arm/man.lwresd.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwresd - - + + @@ -39,104 +38,157 @@
    -
    +
    -
    + + + + + +

    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]

    -
    -
    -

    DESCRIPTION

    -

    lwresd +

    + 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 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 + means that lwresd 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.

    -

    +

    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 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 + nameserver entries, lwresd sends recursive DNS queries to those servers. This is similar to the use of forwarders in a caching name server. If no nameserver entries are present, or if - forwarding fails, lwresd resolves the + forwarding fails, lwresd resolves the queries autonomously starting at the root name servers, using a built-in list of root server hints.

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

    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 + Debugging traces from lwresd become more verbose as the debug level increases. -

    +

    +
    -f
    -

    +

    +

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

    +

    +
    -g
    -

    +

    +

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

    +

    +
    -i pid-file
    -

    +

    +

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

    +

    +
    -m flag
    -

    +

    +

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

    +

    +
    -n #cpus
    -

    +

    +

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

    +

    +
    -P port
    -

    +

    +

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

    +

    +
    -p port
    -

    +

    +

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

    +

    +
    -s
    -

    +

    Write memory usage statistics to stdout on exit.

    -
    +

    Note

    -

    +

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

    -
    -
    +
    +
    -t directory
    -

    Chroot +

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

    -
    +

    Warning

    -

    +

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

    -
    -
    +
    +
    -u user
    -

    Setuid +

    +

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

    +

    +
    -v
    -

    +

    +

    Report the version number and exit. -

    +

    +
    -
    -
    -

    FILES

    -
    + +
    + +
    +

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

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.named-checkconf.html b/doc/arm/man.named-checkconf.html index db25d9ab28..4d09af1405 100644 --- a/doc/arm/man.named-checkconf.html +++ b/doc/arm/man.named-checkconf.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - named-checkconf - - + + @@ -39,61 +38,96 @@
    -
    +
    -
    + + + + + + + +

    Name

    -

    named-checkconf — named configuration file syntax checking tool

    +

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

    -
    + +

    Synopsis

    -

    named-checkconf [-h] [-v] [-j] [-t directory] {filename} [-p] [-x] [-z]

    -
    -
    -

    DESCRIPTION

    -

    named-checkconf +

    + named-checkconf + [-h] + [-v] + [-j] + [-t directory] + {filename} + [-p] + [-x] + [-z] +

    +
    + +
    +

    DESCRIPTION

    + +

    named-checkconf checks the syntax, but not the semantics, of a - named configuration file. The file is parsed + 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 +

    + Note: files that named reads in separate parser contexts, such as rndc.key and bind.keys, are not automatically read - by named-checkconf. Configuration - errors in these files may cause named to - fail to run, even if named-checkconf was - successful. named-checkconf can be run + by named-checkconf. Configuration + errors in these files may cause named to + fail to run, even if named-checkconf was + successful. named-checkconf can be run on these files explicitly, however.

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

    OPTIONS

    + + +
    -h
    -

    +

    +

    Print the usage summary and exit. -

    +

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

    +

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

    +

    +
    -p
    -

    +

    +

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

    +

    +
    -x
    -

    +

    +

    When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks ('?'). This allows the @@ -101,42 +135,53 @@ 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. -

    +

    +
    -j
    -

    +

    +

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

    +

    +
    filename
    -

    +

    +

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

    +

    +
    -
    -
    -

    RETURN VALUES

    -

    named-checkconf + +

    + +
    +

    RETURN VALUES

    + +

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

    -
    -
    -

    SEE ALSO

    -

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

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.named-checkzone.html b/doc/arm/man.named-checkzone.html index e5108ba441..617f57843b 100644 --- a/doc/arm/man.named-checkzone.html +++ b/doc/arm/man.named-checkzone.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - named-checkzone - - + + @@ -39,274 +38,394 @@
    -
    +
    -
    + + + + + + + +

    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] [-i mode] [-k mode] [-m mode] [-M mode] [-n mode] [-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] [-i mode] [-k mode] [-m mode] [-n mode] [-L serial] [-r mode] [-s style] [-t directory] [-T mode] [-w directory] [-D] [-W mode] {-o filename} {zonename} {filename}

    -
    -
    -

    DESCRIPTION

    -

    named-checkzone +

    + named-checkzone + [-d] + [-h] + [-j] + [-q] + [-v] + [-c class] + [-f format] + [-F format] + [-i mode] + [-k mode] + [-m mode] + [-M mode] + [-n mode] + [-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] + [-i mode] + [-k mode] + [-m mode] + [-n mode] + [-L serial] + [-r mode] + [-s style] + [-t directory] + [-T mode] + [-w directory] + [-D] + [-W mode] + {-o filename} + {zonename} + {filename} +

    +
    + +
    +

    DESCRIPTION

    + +

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

    + named-compilezone is similar to + named-checkzone, 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 named. + loaded by named. When manually specified otherwise, the check levels must at least be as strict as those specified in the - named configuration file. + named configuration file.

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

    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 +

    +

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

    +

    +
    -j
    -

    +

    +

    When loading the zone file read the journal if it exists. -

    +

    +
    -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", - "local", - "local-sibling" and - "none". + "full" (default), + "full-sibling", + "local", + "local-sibling" and + "none".

    -

    - Mode "full" checks that MX records +

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

    -

    - Mode "full" checks that SRV records +

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

    -

    - Mode "full" checks that delegation NS +

    + 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 in the zone match those advertised by the child. - Mode "local" only checks NS records which + Mode "local" 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.

    -

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

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

    + Mode "none" disables the checks.

    -
    +
    -f format
    -

    +

    +

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

    + Possible formats are "text" (default) + and "raw". +

    +
    -F format
    -

    +

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

    -

    - Possible formats are "text" (default) - and "raw" or "raw=N", +

    + Possible formats are "text" (default) + and "raw" or "raw=N", which store the zone in a binary format for rapid loading - by named. "raw=N" + by named. "raw=N" specifies the format version of 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 + 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 +

    +

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

    + Possible modes are "fail" + (default for named-compilezone), + "warn" + (default for named-checkzone) and + "ignore". +

    +
    -L serial
    -

    +

    +

    When compiling a zone to 'raw' 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". -

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

    + 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" - (default for named-compilezone), - "warn" - (default for named-checkzone) and - "ignore". -

    + Possible modes are "fail" + (default for named-compilezone), + "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. -

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

    + 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". + Possible styles are "full" (default) + and "relative". 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 named-checkzone + For named-checkzone 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. -

    +

    +
    -S mode
    -

    +

    +

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

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

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

    + 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) + Possible modes are "warn" (default) and - "ignore". -

    + "ignore". +

    +
    zonename
    -

    +

    +

    The domain name of the zone being checked. -

    +

    +
    filename
    -

    +

    +

    The name of the zone file. -

    +

    +
    -
    -
    -

    RETURN VALUES

    -

    named-checkzone + +

    + +
    +

    RETURN VALUES

    + +

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

    -
    -
    -

    SEE ALSO

    -

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

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.named-journalprint.html b/doc/arm/man.named-journalprint.html index a531e478d6..2ab4dd059f 100644 --- a/doc/arm/man.named-journalprint.html +++ b/doc/arm/man.named-journalprint.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - named-journalprint - - + + @@ -39,27 +38,43 @@
    -
    +
    -
    + + + + + +

    Name

    -

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

    -
    -
    -

    Synopsis

    -

    named-journalprint {journal}

    -
    -
    -

    DESCRIPTION

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

    +
    + + + +
    +

    Synopsis

    +

    + named-journalprint + {journal} +

    +
    + +
    +

    DESCRIPTION

    + +

    + named-journalprint prints the contents of a zone journal file in a human-readable form.

    -

    - Journal files are automatically created by named +

    + Journal files are automatically created by named when changes are made to dynamic zones (e.g., by - nsupdate). They record each addition + nsupdate). 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 @@ -67,27 +82,29 @@ .jnl to the name of the corresponding zone file.

    -

    - named-journalprint converts the contents of a given +

    + named-journalprint converts the contents of a given journal file into a human-readable text format. Each line begins with "add" or "del", to indicate whether the record was added or deleted, and continues with the resource record in master-file format.

    -
    -
    -

    SEE ALSO

    -

    - named(8), - nsupdate(8), +

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.named.conf.html b/doc/arm/man.named.conf.html index 92c12f1be1..d60d374db0 100644 --- a/doc/arm/man.named.conf.html +++ b/doc/arm/man.named.conf.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - named.conf - - + + @@ -39,63 +38,86 @@
    -
    +
    -
    + + + + + +

    Name

    -

    named.conf — configuration file for named

    +

    + named.conf + — configuration file for named +

    -
    + + + +

    Synopsis

    -

    named.conf

    -
    -
    -

    DESCRIPTION

    -

    named.conf is the configuration file +

    + named.conf +

    +
    + +
    +

    DESCRIPTION

    + +

    named.conf is the configuration file for - named. Statements are enclosed + 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

    + +


    acl string { address_match_element; ... };

    -
    -
    -

    KEY

    -


    +

    + +
    +

    KEY

    + +


    key domain_name {
    algorithm string;
    secret string;
    };

    -
    -
    -

    MASTERS

    -


    +

    + +
    +

    MASTERS

    + +


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

    -
    -
    -

    SERVER

    -


    +

    + +
    +

    SERVER

    + +


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

    -
    -
    -

    TRUSTED-KEYS

    -


    +

    + +
    +

    TRUSTED-KEYS

    + +


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

    -
    -
    -

    MANAGED-KEYS

    -


    +

    + +
    +

    MANAGED-KEYS

    + +


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

    -
    -
    -

    CONTROLS

    -


    +

    + +
    +

    CONTROLS

    + +


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

    -
    -
    -

    LOGGING

    -


    +

    + +
    +

    LOGGING

    + +


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

    -
    -
    -

    LWRES

    -


    +

    + +
    +

    LWRES

    + +


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

    -
    -
    -

    OPTIONS

    -


    +

    + +
    +

    OPTIONS

    + +


    options {
    avoid-v4-udp-ports { port; ... };
    avoid-v6-udp-ports { port; ... };
    @@ -277,9 +311,9 @@ options dns64-server string;
    dns64-contact string;
    dns64 prefix {
    - clients { <replacable>acl</replacable>; };
    - exclude { <replacable>acl</replacable>; };
    - mapped { <replacable>acl</replacable>; };
    + clients { <replacable>acl</replacable>; };
    + exclude { <replacable>acl</replacable>; };
    + mapped { <replacable>acl</replacable>; };
    break-dnssec boolean;
    recursive-only boolean;
    suffix ipv6_address;
    @@ -378,10 +412,12 @@ options use-id-pool boolean; // obsolete
    };

    -
    -
    -

    VIEW

    -


    +

    + +
    +

    VIEW

    + +


    view string optional_class {
    match-clients { address_match_element; ... };
    match-destinations { address_match_element; ... };
    @@ -464,9 +500,9 @@ view dns64-server string;
    dns64-contact string;
    dns64 prefix {
    - clients { <replacable>acl</replacable>; };
    - exclude { <replacable>acl</replacable>; };
    - mapped { <replacable>acl</replacable>; };
    + clients { <replacable>acl</replacable>; };
    + exclude { <replacable>acl</replacable>; };
    + mapped { <replacable>acl</replacable>; };
    break-dnssec boolean;
    recursive-only boolean;
    suffix ipv6_address;
    @@ -542,10 +578,12 @@ view max-ixfr-log-size size; // obsolete
    };

    -
    -
    -

    ZONE

    -


    +

    + +
    +

    ZONE

    + +


    zone string optional_class {
    type ( master | slave | stub | hint | redirect |
    forward | delegation-only );
    @@ -639,20 +677,31 @@ zone pubkey integer integer integer quoted_string; // obsolete
    };

    -
    -
    -

    FILES

    -

    /etc/named.conf +

    + +
    +

    FILES

    + +

    /etc/named.conf

    -
    -
    -

    SEE ALSO

    -

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

    + +
    +

    SEE ALSO

    + +

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

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.named.html b/doc/arm/man.named.html index 6ed489a1b0..5694d48994 100644 --- a/doc/arm/man.named.html +++ b/doc/arm/man.named.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - named - - + + @@ -39,48 +38,90 @@
    -
    +
    -
    + + + + + +

    Name

    -

    named — Internet domain name server

    +

    + named + — Internet domain name server +

    -
    + + + +

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    -

    named +

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

    +
    + +
    +

    DESCRIPTION

    + +

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

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

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

    OPTIONS

    + + +
    -4
    -

    +

    +

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

    +

    +
    -6
    -

    +

    +

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

    +

    +
    -c config-file
    -

    +

    +

    Use config-file as the configuration file instead of the default, /etc/named.conf. To @@ -90,40 +131,52 @@ 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 + Debugging traces from named become more verbose as the debug level increases. -

    +

    +
    -E engine-name
    -

    +

    +

    Use a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance re-signing with private keys from a secure key store. When compiled with PKCS#11 support engine-name defaults to pkcs11, the empty name resets it to no engine. -

    +

    +
    -f
    -

    +

    +

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

    +

    +
    -g
    -

    +

    +

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

    +

    +
    -M option
    -

    +

    +

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

    +

    +
    -m flag
    -

    +

    +

    Turn on memory usage debugging flags. Possible flags are usage, trace, @@ -132,43 +185,48 @@ 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 + 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 +

    + Allow named to use up to #max-socks sockets.

    -
    +

    Warning

    -

    +

    This option should be unnecessary for the vast majority of users. The use of this option could even be harmful because the @@ -180,21 +238,21 @@ specified number of sockets. Note also that the actual maximum number is normally a little fewer than the specified value because - named reserves some file descriptors + named reserves some file descriptors for its internal use.

    -
    -
    +
    +
    -t directory
    -

    Chroot +

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

    -
    +

    Warning

    -

    +

    This option should be used in conjunction with the -u option, as chrooting a process running as root doesn't enhance security on most @@ -202,138 +260,182 @@ 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 + address. If not specified, named will calculate a default value based on the number of detected - CPUs: 1 for 1 CPU, 2 for 2-4 CPUs, and the number of - detected CPUs divided by 2 for values higher than 4. + CPUs: 1 for 1 CPU, and the number of detected CPUs + minus one for machines with more than 1 CPU. This cannot + be increased to a value higher than the number of CPUs. If -n has been set to a higher value than the number of detected CPUs, then -U 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. +

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

    + On Linux, named uses the kernel's capability mechanism to drop all root privileges except the ability to bind(2) to a privileged port and set process resource limits. Unfortunately, this means that the -u - option only works when named is + option only works when named 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 setuid(2).

    -
    -
    +
    +
    -v
    -

    +

    +

    Report the version number and exit. -

    +

    +
    -V
    -

    +

    +

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

    +

    +
    -x cache-file
    -

    +

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

    -
    +

    Warning

    -

    +

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

    -
    -
    +
    +
    -
    -
    -

    SIGNALS

    -

    + +

    + +
    +

    SIGNALS

    + +

    In routine operation, signals should not be used to control - the nameserver; rndc should be used + 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 + +

    + +
    +

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

    + named inherits the umask (file creation mode mask) from the parent process. If files - created by named, such as journal files, + created by named, such as journal files, need to have custom permissions, the umask should be set explicitly in the script used to start the - named process. + named process.

    -
    -
    -

    FILES

    -
    + +
    + +
    +

    FILES

    + + +
    /etc/named.conf
    -

    +

    +

    The default configuration file. -

    +

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

    +

    +

    The default process-id file. -

    +

    +
    -
    -
    -

    SEE ALSO

    -

    RFC 1033, + +

    + +
    +

    SEE ALSO

    + +

    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.

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.nsec3hash.html b/doc/arm/man.nsec3hash.html index c12905e9e8..4217478d2f 100644 --- a/doc/arm/man.nsec3hash.html +++ b/doc/arm/man.nsec3hash.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - nsec3hash - - + + @@ -37,60 +36,87 @@
    -
    +
    -
    + + + + + +

    Name

    -

    nsec3hash — generate NSEC3 hash

    -
    -
    -

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    - nsec3hash generates an NSEC3 hash based on + nsec3hash + — generate NSEC3 hash +

    +
    + + + +
    +

    Synopsis

    +

    + nsec3hash + {salt} + {algorithm} + {iterations} + {domain} +

    +
    + +
    +

    DESCRIPTION

    + +

    + nsec3hash generates an NSEC3 hash based on a set of NSEC3 parameters. This can be used to check the validity of NSEC3 records in a signed zone.

    -
    -
    -

    ARGUMENTS

    -
    +
    + +
    +

    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

    -

    +

    + +
    +

    SEE ALSO

    + +

    BIND 9 Administrator Reference Manual, RFC 5155.

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.nsupdate.html b/doc/arm/man.nsupdate.html index a59f47e512..e931ef1812 100644 --- a/doc/arm/man.nsupdate.html +++ b/doc/arm/man.nsupdate.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - nsupdate - - + + @@ -39,19 +38,49 @@
    -
    +
    -
    + + + +

    Name

    -

    nsupdate — Dynamic DNS update utility

    +

    + nsupdate + — Dynamic DNS update utility +

    -
    + + + +

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    -

    nsupdate +

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

    +
    + +
    +

    DESCRIPTION

    + +

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

    -

    +

    Zones that are under dynamic control via - nsupdate + 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 + 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. + nsupdate and the name server. For instance, suitable key and server statements would be added to /etc/named.conf so that the name server can associate the appropriate secret key and algorithm with the IP address of the client application that will be using - TSIG authentication. You can use ddns-confgen + TSIG authentication. You can use ddns-confgen to generate suitable configuration fragments. - nsupdate + nsupdate 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

    -
    +
    + +
    +

    OPTIONS

    + + +
    -d
    -

    +

    +

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

    +

    +
    -D
    -

    +

    +

    Extra debug mode. -

    +

    +
    -k keyfile
    -

    +

    +

    The file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing - a named.conf-format key + a named.conf-format key statement, which may be generated automatically by - ddns-confgen, or a pair of files whose names are + ddns-confgen, or a pair of files whose names are of the format K{name}.+157.+{random}.key and K{name}.+157.+{random}.private, which can be - generated by dnssec-keygen. + generated by dnssec-keygen. 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 + localhost (disabling the server 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 named if any - local master zone has set update-policy to - local. The location of this key file can be + which is automatically generated by named if any + 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. -

    +

    +
    -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 @@ -169,34 +216,43 @@ 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. -

    +

    +
    -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 + 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. @@ -207,19 +263,23 @@ hmac-sha512. If hmac is not specified, the default is hmac-md5.

    -

    +

    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 +

    + +
    +

    INPUT FORMAT

    + +

    nsupdate reads input from filename or standard input. @@ -233,30 +293,31 @@ 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 specified resource records are present or missing from the zone. - A blank input line (or the send command) + A blank input line (or the send command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server.

    -

    +

    The command formats and their meaning are as follows:

    -
    +
    - server + server {servername} [port]
    -

    +

    +

    Sends all dynamic update requests to the name server servername. When no server statement is provided, - nsupdate + nsupdate will send updates to the master server of the correct zone. The MNAME field of that zone's SOA record will identify the master @@ -268,120 +329,142 @@ If no port number is specified, the default DNS port number of 53 is used. -

    +

    +
    - local + local {address} [port]
    -

    +

    +

    Sends all dynamic update requests using the local address. When no local statement is provided, - nsupdate + nsupdate will send updates using an address and port chosen by the system. port can additionally be used to make requests come from a specific port. If no port number is specified, the system will assign one. -

    +

    +
    - zone + zone {zonename}
    -

    +

    +

    Specifies that all updates are to be made to the zone zonename. If no zone statement is provided, - nsupdate + nsupdate will attempt determine the correct zone to update based on the rest of the input. -

    +

    +
    - class + class {classname}
    -

    +

    +

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

    +

    +
    - ttl + ttl {seconds}
    -

    +

    +

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

    +

    +
    - key + 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 signing algorithm in use; the default is - hmac-md5. The key + hmac-md5. The key command overrides any key specified on the command line via -y or -k. -

    +

    +
    - gsstsig + gsstsig
    -

    +

    +

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

    +

    +
    - oldgsstsig + oldgsstsig
    -

    +

    +

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

    +

    +
    - realm + realm {[realm_name]}
    -

    +

    +

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

    +

    +
    - [prereq] nxdomain + [prereq] nxdomain {domain-name}
    -

    +

    +

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

    +

    +
    - [prereq] yxdomain + [prereq] yxdomain {domain-name}
    -

    +

    +

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

    +

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

    +

    +

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

    +

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

    +

    +

    This requires that a resource record of the specified type, class @@ -407,15 +492,17 @@ If class is omitted, IN (internet) is assumed. -

    +

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

    +

    +

    The data from each set of prerequisites of this form @@ -436,15 +523,17 @@ are written in the standard text representation of the resource record's RDATA. -

    +

    +
    - [update] del[ete] + [update] del[ete] {domain-name} [ttl] [class] [type [data...]]
    -

    +

    +

    Deletes any resource records named domain-name. If @@ -457,73 +546,92 @@ is not supplied. The ttl is ignored, and is only allowed for compatibility. -

    +

    +
    - [update] add + [update] add {domain-name} {ttl} [class] {type} {data...}
    -

    +

    +

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

    +

    +
    - show + show
    -

    +

    +

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

    +

    +
    - send + send
    -

    +

    +

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

    +

    +
    - answer + answer
    -

    +

    +

    Displays the answer. -

    +

    +
    - debug + debug
    -

    +

    +

    Turn on debugging. -

    +

    +
    - version + version
    -

    +

    +

    Print version number. -

    +

    +
    - help + help
    -

    +

    +

    Print a list of commands. -

    +

    +

    -

    + +

    Lines beginning with a semicolon are comments and are ignored.

    -
    -
    -

    EXAMPLES

    -

    + +

    + +
    +

    EXAMPLES

    + +

    The examples below show how - nsupdate + nsupdate could be used to insert and delete resource records from the example.com zone. @@ -542,7 +650,7 @@

    -

    +

    Any A records for oldhost.example.com are deleted. @@ -559,7 +667,7 @@

    -

    +

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

    - -
    -

    FILES

    -
    +
    + +
    +

    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

    -

    +

    + +
    +

    SEE ALSO

    + +

    RFC 2136, RFC 3007, RFC 2104, @@ -606,20 +731,28 @@ RFC 1034, RFC 2535, RFC 2931, - named(8), - ddns-confgen(8), - dnssec-keygen(8). + + named(8) + , + + ddns-confgen(8) + , + + dnssec-keygen(8) + .

    -
    -
    -

    BUGS

    -

    +

    + +
    +

    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.

    -
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.rndc-confgen.html b/doc/arm/man.rndc-confgen.html index 59a3a4598a..1d264c0d0a 100644 --- a/doc/arm/man.rndc-confgen.html +++ b/doc/arm/man.rndc-confgen.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - rndc-confgen - - + + @@ -39,101 +38,141 @@
    -
    +
    -
    + + + + + +

    Name

    -

    rndc-confgen — rndc key generation tool

    +

    + rndc-confgen + — rndc key generation tool +

    -
    + + + +

    Synopsis

    -

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

    -
    -
    -

    DESCRIPTION

    -

    rndc-confgen +

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

    +
    + +
    +

    DESCRIPTION

    + +

    rndc-confgen generates configuration files - for rndc. It can be used as a + for rndc. It can be used as a convenient alternative to writing the rndc.conf file - and the corresponding controls - and key + and the corresponding controls + and key statements in named.conf by hand. - Alternatively, it can be run with the -a + Alternatively, it can be run with the -a option to set up a rndc.key file and avoid the need for a rndc.conf file - and a controls statement altogether. + and a controls statement altogether.

    -
    -
    -

    OPTIONS

    -
    + +
    + +
    +

    OPTIONS

    + + +
    -a
    -

    - Do automatic rndc configuration. +

    + Do automatic rndc configuration. This creates a file rndc.key in /etc (or whatever sysconfdir was specified as when BIND was built) - that is read by both rndc - and named on startup. The + that is read by both rndc + and named on startup. The rndc.key file defines a default command channel and authentication key allowing - rndc to communicate with - named on the local host + rndc to communicate with + named on the local host with no further configuration.

    -

    - Running rndc-confgen -a allows - BIND 9 and rndc to be used as +

    + Running rndc-confgen -a allows + BIND 9 and rndc to be used as drop-in - replacements for BIND 8 and ndc, + replacements for BIND 8 and ndc, with no changes to the existing BIND 8 named.conf file.

    -

    +

    If a more elaborate configuration than that - generated by rndc-confgen -a + generated by rndc-confgen -a is required, for example if rndc is to be used remotely, - you should run rndc-confgen without + you should run rndc-confgen without the - -a option and set up a + -a option and set up a rndc.conf and named.conf as directed.

    -
    +
    -b keysize
    -

    +

    +

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

    +

    +
    -c keyfile
    -

    - Used with the -a option to specify +

    +

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

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

    +

    + 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 @@ -144,64 +183,77 @@ 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 +

    +

    + Specifies the IP address where named listens for command channel connections from - rndc. The default is the loopback + 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 +

    +

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

    + it will be found by the chrooted named. +

    +
    -u user
    -

    - Used with the -a option to set the +

    +

    + Used with the -a option to set the owner of the rndc.key file generated. If - -t is also specified only the file + -t is also specified only the file in the chroot area has its owner changed. -

    +

    +
    -
    -
    -

    EXAMPLES

    -

    - To allow rndc to be used with +

    + +
    +

    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 + 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), +

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.rndc.conf.html b/doc/arm/man.rndc.conf.html index be9cea6c51..df0e6eb222 100644 --- a/doc/arm/man.rndc.conf.html +++ b/doc/arm/man.rndc.conf.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - rndc.conf - - + + @@ -39,46 +38,61 @@
    -
    +
    -
    + + + + + +

    Name

    -

    rndc.conf — rndc configuration file

    +

    + rndc.conf + — rndc configuration file +

    -
    + + + +

    Synopsis

    -

    rndc.conf

    -
    -
    -

    DESCRIPTION

    -

    rndc.conf is the configuration file - for rndc, the BIND 9 name server control +

    + rndc.conf +

    +
    + +
    +

    DESCRIPTION

    + +

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

    -

    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 no name server is given as an argument to - rndc. The default-key + rndc. The default-key clause is followed by the name of a key which is identified by a key statement. If no keyid is provided on the rndc command line, @@ -96,7 +110,7 @@ can be used to set the IPv4 and IPv6 source addresses respectively.

    -

    +

    After the server keyword, the server statement includes a string which is the hostname or address for a name server. The statement has three possible clauses: @@ -110,33 +124,36 @@ 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 encryption algorithm - for rndc to use; currently only HMAC-MD5 + for rndc to use; currently only HMAC-MD5 is supported. This is followed by a secret clause which contains the base-64 encoding of the algorithm's encryption 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 + secret. The BIND 9 program rndc-confgen can be used to generate a random key, or the - mmencode program, also known as - mimencode, can be used to generate a + mmencode program, also known as + mimencode, can be used to generate a base-64 - string from known input. mmencode does + string from known input. mmencode does not ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each.

    -
    -
    -

    EXAMPLE

    -
    +  
    + +
    +

    EXAMPLE

    + + +
           options {
             default-server  localhost;
             default-key     samplekey;
    @@ -144,14 +161,14 @@
     

    -
    +    
           server localhost {
             key             samplekey;
           };
     

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

    -
    +    
           key samplekey {
             algorithm       hmac-md5;
             secret          "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
    @@ -167,7 +184,7 @@
     

    -
    +    
           key testkey {
             algorithm	hmac-md5;
             secret		"R3HI8P6BKw9ZwXwN3VZKuQ==";
    @@ -175,8 +192,9 @@
         

    -

    - In the above example, rndc will by + +

    + In the above example, rndc 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 @@ -185,16 +203,16 @@ uses the HMAC-MD5 algorithm and its secret clause contains the base-64 encoding of the HMAC-MD5 secret enclosed in double quotes.

    -

    - If rndc -s testserver is used then rndc will +

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

    + 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 @@ -202,35 +220,41 @@ controls statements for named.conf are also printed.

    -

    - To generate a base-64 secret with mmencode: +

    + 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

    -

    +

    + +
    +

    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), +

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/man.rndc.html b/doc/arm/man.rndc.html index a220c9f3f2..b486328d81 100644 --- a/doc/arm/man.rndc.html +++ b/doc/arm/man.rndc.html @@ -14,13 +14,12 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - rndc - - + + @@ -39,32 +38,55 @@
    -
    +
    -
    + + + + + +

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

    -
    -
    -

    DESCRIPTION

    -

    rndc +

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

    +
    + +
    +

    DESCRIPTION

    + +

    rndc controls the operation of a name - server. It supersedes the ndc utility + server. It supersedes the ndc utility that was provided in old BIND releases. If - rndc is invoked with no command line + rndc 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.

    -

    rndc +

    rndc communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of - rndc and named, + rndc and named, the only supported authentication algorithm is HMAC-MD5, which uses a shared secret on each end of the connection. This provides TSIG-style authentication for the command @@ -72,30 +94,38 @@ over the channel must be signed by a key_id known to the server.

    -

    rndc +

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

    -
    -
    -

    OPTIONS

    -
    +
    + +
    +

    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 @@ -103,37 +133,45 @@ 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 + 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 + 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. -

    +

    +
    -V
    -

    +

    +

    Enable verbose logging. -

    +

    +
    -y key_id
    -

    +

    +

    Use the key key_id from the configuration file. key_id must be - known by named with the same algorithm and secret string + known by named with the same algorithm and secret string in order for control message validation to succeed. If no key_id - is specified, rndc will first look + is specified, rndc 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. @@ -141,99 +179,111 @@ 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. +

    + +
    +

    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 + allow-new-zones option to be set to yes. The configuration string specified on the command line is the zone configuration text that would ordinarily be placed in named.conf.

    -

    +

    The configuration is saved in a file called hash.nzf, where hash is a cryptographic hash generated from the name of - the view. When named is + the view. When named is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart.

    -

    - This sample addzone command +

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

    + See also rndc delzone.

    -
    +
    delzone zone [class [view]]
    -

    +

    Delete a zone while the server is running. Only zones that were originally added via - rndc addzone can be deleted + rndc addzone can be deleted in this manner.

    -

    - See also rndc addzone +

    + See also rndc addzone

    -
    +
    dumpdb [-all|-cache|-zone|-adb|-bad] [view ...]
    -

    +

    +

    Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is specified, all views are dumped. - (See the dump-file option in + (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 or bad-server cache. -

    +

    +
    flushtree name [view]
    -

    +

    +

    Flushes the given name, and all of its subdomains, from the view's DNS cache. Note that this does not affect he server's address database or bad-server cache. -

    +

    +
    freeze [zone [class [view]]]
    -

    +

    Suspend updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by @@ -242,145 +292,159 @@ All dynamic update attempts will be refused while the zone is frozen.

    -

    - See also rndc thaw. +

    + 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 journal files when the server is restarted. - If -p is specified named's process id is returned. - This allows an external process to determine when named + If -p is specified named's process id is returned. + This allows an external process to determine when named had completed halting.

    -

    - See also rndc stop. +

    + 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 - zone's DNSKEY RRset. Unlike rndc + zone's DNSKEY RRset. Unlike rndc sign, however, the zone is not 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 + auto-dnssec 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.)

    -
    +
    notify zone [class [view]]
    -

    +

    +

    Resend NOTIFY messages for the zone. -

    +

    +
    notrace
    -

    +

    Sets the server's debugging level to 0.

    -

    - See also rndc trace. +

    + See also rndc trace.

    -
    +
    querylog [on|off]
    -

    +

    Enable or disable query logging. (For backward compatibility, this command can also be used without an argument to toggle query logging on and off.)

    -

    +

    Query logging can also be enabled - by explicitly directing the queries - category to a - channel in the - logging section of + by explicitly directing the queries + category to a + channel in the + logging section of named.conf or by specifying - querylog yes; in the - options section of + querylog yes; in the + 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. - This is faster than a full reload when there + This is faster than a full reload when there 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 +

    +

    + 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 + inline-signing, 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.

    -
    +
    secroots [view ...]
    -

    +

    +

    Dump the server's security roots to the secroots file for the specified views. If no view is specified, security roots for all views are dumped. -

    +

    +
    sign zone [class [view]]
    -

    +

    Fetch all DNSSEC keys for the given zone from the key directory (see the - key-directory option in + key-directory option in the BIND 9 Administrator Reference Manual). If they are within their publication period, merge them into the zone's DNSKEY RRset. If the DNSKEY RRset 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 + auto-dnssec zone option be set to allow or maintain, and also requires the zone to be configured to @@ -388,44 +452,44 @@ (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)

    -

    - See also rndc loadkeys. +

    + See also rndc loadkeys.

    -
    +
    signing [( -list | -clear keyid/algorithm | -clear all | -nsec3param ( parameters | none ) ) ] zone [class [view]]
    -

    +

    List, edit, or remove the DNSSEC signing state records for the specified zone. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type - sig-signing-type. - rndc signing -list converts + sig-signing-type. + rndc signing -list 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.

    -

    - rndc signing -clear can remove +

    + rndc signing -clear can remove a single key (specified in the same format that - rndc signing -list uses to + rndc signing -list 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.

    -

    - rndc signing -nsec3param sets +

    + rndc signing -nsec3param sets the NSEC3 parameters for a zone. This is the only supported mechanism for using NSEC3 with - inline-signing zones. + inline-signing zones. Parameters are specified in the same format as 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 @@ -438,57 +502,63 @@ in hexadecimal, or a hyphen (`-') if no salt is to be used.

    -

    +

    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: - rndc signing -nsec3param 1 0 10 FFFF zone. + rndc signing -nsec3param 1 0 10 FFFF zone. To set the opt-out flag, 15 iterations, and no salt, use: - rndc signing -nsec3param 1 1 15 - zone. + rndc signing -nsec3param 1 1 15 - zone.

    -

    - rndc signing -nsec3param none +

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

    -
    +
    stats
    -

    +

    +

    Write server statistics to the statistics file. - (See the statistics-file option in + (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 + 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. - If -p is specified named's process id is returned. - This allows an external process to determine when named + If -p is specified named's process id is returned. + 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 @@ -496,77 +566,95 @@ load has completed. After a zone is thawed, dynamic updates will no longer be refused. If the zone has changed and the - ixfr-from-differences option is + ixfr-from-differences 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.

    -

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

    + 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 + for use by named in each view. The list both statically configured keys and dynamic TKEY-negotiated keys. -

    +

    +
    validation ( on | off | check ) [view ...]
    -

    +

    +

    Enable, disable, or check the current status of DNSSEC validation. - Note dnssec-enable also needs to be + Note dnssec-enable also needs to be set to yes or auto to be effective. It defaults to enabled. -

    +

    +
    -
    -
    -

    LIMITATIONS

    -

    +

    + +
    +

    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), +

    + +
    +

    SEE ALSO

    + +

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

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    -

    BIND 9.9.8 (Extended Support Version)

    +

    BIND 9.9.8-S1 (Subscription Edition)

    diff --git a/doc/arm/managed-keys.xml b/doc/arm/managed-keys.xml index 51949487fb..5d2f731d2f 100644 --- a/doc/arm/managed-keys.xml +++ b/doc/arm/managed-keys.xml @@ -1,4 +1,3 @@ - - - - - - Dynamic Trust Anchor Management + +
    Dynamic Trust Anchor Management + BIND 9.7.0 introduces support for RFC 5011, dynamic trust anchor management. Using this feature allows named to keep track of changes to critical DNSSEC keys without any need for the operator to make changes to configuration files. - - Validating Resolver +
    Validating Resolver + 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 - . + . - - - Authoritative Server +
    +
    Authoritative Server + 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" @@ -96,5 +93,5 @@ $ dnssec-signzone -S -K keys example.net It is expected that a future release of BIND 9 will address this problem in a different way, by storing revoked keys with their original unrevoked key ID's. - - +
    +
    diff --git a/doc/arm/notes-wrapper.xml b/doc/arm/notes-wrapper.xml index 9d31ef8b6d..f35964985e 100644 --- a/doc/arm/notes-wrapper.xml +++ b/doc/arm/notes-wrapper.xml @@ -1,8 +1,7 @@ -]> +]> - -
    - - <xi:include href="notes.xml"/> +<!-- Converted by db4-upgrade version 1.0 --> +<article xmlns="http://docbook.org/ns/docbook" version="5.0"><info><title/></info> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="notes.xml"/> </article> - -<!-- - - Local variables: - - mode: sgml - - End: - --> diff --git a/doc/arm/notes.conf b/doc/arm/notes.conf new file mode 100644 index 0000000000..f8dd8326f5 --- /dev/null +++ b/doc/arm/notes.conf @@ -0,0 +1,3 @@ +TexInputs: ../tex// +TexStyle: notestyle +XslParam: ../xsl/notes-param.xsl diff --git a/doc/arm/notes.html b/doc/arm/notes.html index 603d3816bc..9e5fbb5ac6 100644 --- a/doc/arm/notes.html +++ b/doc/arm/notes.html @@ -17,78 +17,87 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title> - + -
    +
    + +

    -Release Notes for BIND Version 9.9.8

    -
    +Release Notes for BIND Version 9.9.8-S1
    + +

    Introduction

    -

    + +

    This document summarizes changes since the last production release of BIND on the corresponding major release branch.

    -
    -
    +
    +

    Download

    -

    + +

    The latest versions of BIND 9 software can always be found at - http://www.isc.org/downloads/. + http://www.isc.org/downloads/. There you will find additional information about each release, source code, and pre-compiled versions for Microsoft Windows operating systems.

    -
    -
    +
    +

    Security Fixes

    -
      -
    • + +

        +
      • +

        An incorrect boundary check in the OPENPGPKEY rdatatype could trigger an assertion failure. This flaw is disclosed in CVE-2015-5986. [RT #40286] -

      • -
      • -

        +

        +
      • +
      • +

        A buffer accounting error could trigger an assertion failure when parsing certain malformed DNSSEC keys.

        -

        - This flaw was discovered by Hanno Böck of the Fuzzing +

        + This flaw was discovered by Hanno Böck of the Fuzzing Project, and is disclosed in CVE-2015-5722. [RT #40212]

        -
      • -
      • -

        +

      • +
      • +

        A specially crafted query could trigger an assertion failure in message.c.

        -

        +

        This flaw was discovered by Jonathan Foote, and is disclosed in CVE-2015-5477. [RT #40046]

        -
      • -
      • -

        +

      • +
      • +

        On servers configured to perform DNSSEC validation, an assertion failure could be triggered on answers from a specially configured server.

        -

        +

        This flaw was discovered by Breno Silveira Soares, and is disclosed in CVE-2015-4620. [RT #39795]

        -
      • +
      -
    -
    +
    +

    New Features

    -
      -
    • -

      + +

        +
      • +

        New quotas have been added to limit the queries that are sent by recursive resolvers to authoritative servers experiencing denial-of-service attacks. When configured, @@ -97,13 +106,14 @@ experienced by recursives when they are being used as a vehicle for such an attack.

        -

        +

        NOTE: These options are not available by default; use - configure --enable-fetchlimit to include + configure --enable-fetchlimit to include them in the build.

        -
          -
        • +

            +
          • +

            fetches-per-server limits the number of simultaneous queries that can be sent to any single authoritative server. The configured value is a starting @@ -111,141 +121,184 @@ 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.

          -
        • -
        • - An --enable-querytrace configure switch is +

        • +
        • +

          + An --enable-querytrace configure switch is now available to enable very verbose query tracelogging. 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] -

        • -
        • +

          +
        • +
        • +

          The following types have been implemented: CSYNC, NINFO, RKEY, SINK, TA, TALINK. -

        • -
        • +

          +
        • +
        • +

          EDNS COOKIE options content is now displayed as "COOKIE: <hexvalue>". -

        • +

          +
        -
      -
      +
      +

      Feature Changes

      -
        -
      • + +

          +
        • +

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

        • -
        • +

          +
        • +
        • +

          Retrieving the local port range from net.ipv4.ip_local_port_range on Linux is now supported. -

        • -
        • +

          +
        • +
        • +

          Active Directory names of the form gc._msdcs.<forest> are now accepted as valid hostnames when using the check-names option. <forest> is still restricted to letters, digits and hyphens. -

        • -
        • +

          +
        • +
        • +

          Names containing rich text are now accepted as valid hostnames in PTR records in DNS-SD reverse lookup zones, as specified in RFC 6763. [RT #37889] -

        • -
        • +

          +
        • +
        • +

          The default preferred glue is now the address type of the transport the query was received over. -

        • -
        • - On machines with 4 or more processors (CPU), the default value +

          +
        • +
        • +

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

        • +

          +
        -
      -
      +
      +

      Porting Changes

      -
      • + +

        • +

          The Microsoft Windows install tool - BINDInstall.exe which requires a + BINDInstall.exe which requires a non-free version of Visual Studio to be built, now uses two files (lists of flags and files) created by the Configure perl script with all the needed information which were previously compiled in the binary. Read win32utils/build.txt for more details. [RT #38915] -

        -
      -
      +

      +
    +
    +

    Bug Fixes

    -
      -
    • + +

        +
      • +

        Asynchronous zone loads were not handled correctly when the zone load was already in progress; this could trigger a crash in zt.c. [RT #37573] -

      • -
      • +

        +
      • +
      • +

        A race during shutdown or reconfiguration could cause an assertion failure in mem.c. [RT #38979] -

      • -
      • +

        +
      • +
      • +

        Some answer formatting options didn't work correctly with - dig +short. [RT #39291] -

      • -
      • + dig +short. [RT #39291] +

        +
      • +
      • +

        Malformed records of some types, including NSAP and UNSPEC, could trigger assertion failures when loading text zone files. [RT #40274] [RT #40285] -

      • -
      • +

        +
      • +
      • +

        Fixed a possible crash in ratelimiter.c caused by NOTIFY messages being removed from the wrong rate limiter queue. [RT #40350] -

      • -
      • +

        +
      • +
      • +

        The default rrset-order of random was inconsistently applied. [RT #40456] -

      • -
      • +

        +
      • +
      • +

        BADVERS responses from broken authoritative name servers were not handled correctly. [RT #40427] -

      • +

        +
      -
    -
    +
    +

    End of Life

    -

    + +

    The BIND 9.9 (Extended Support Version) will be supported until June, 2017. - https://www.isc.org/downloads/software-support-policy/ + https://www.isc.org/downloads/software-support-policy/

    -
    -
    +
    +

    Thank You

    -

    + +

    Thank you to everyone who assisted us in making this release possible. If you would like to contribute to ISC to assist us in continuing to make quality open source software, please visit our donations page at - http://www.isc.org/donate/. + http://www.isc.org/donate/.

    +
    -
    +
    diff --git a/doc/arm/notes.pdf b/doc/arm/notes.pdf index a59a87a8ae..41705dcd36 100644 Binary files a/doc/arm/notes.pdf and b/doc/arm/notes.pdf differ diff --git a/doc/arm/notes.xml b/doc/arm/notes.xml index 4cd3eade88..7e57588a3b 100644 --- a/doc/arm/notes.xml +++ b/doc/arm/notes.xml @@ -1,4 +1,6 @@ - + +]> - - - - - Introduction + +
    + +
    Introduction + This document summarizes changes since the last production release of BIND on the corresponding major release branch. - - - Download +
    +
    Download + The latest versions of BIND 9 software can always be found at - http://www.isc.org/downloads/. + http://www.isc.org/downloads/. There you will find additional information about each release, source code, and pre-compiled versions for Microsoft Windows operating systems. - - - Security Fixes +
    +
    Security Fixes + @@ -51,7 +52,7 @@ when parsing certain malformed DNSSEC keys. - This flaw was discovered by Hanno B쎶ck of the Fuzzing + This flaw was discovered by Hanno Böck of the Fuzzing Project, and is disclosed in CVE-2015-5722. [RT #40212] @@ -77,9 +78,9 @@ - - - New Features +
    +
    New Features + @@ -144,9 +145,9 @@ - - - Feature Changes +
    +
    Feature Changes + @@ -192,9 +193,9 @@ - - - Porting Changes +
    +
    Porting Changes + @@ -209,9 +210,9 @@ - - - Bug Fixes +
    +
    Bug Fixes + @@ -259,23 +260,21 @@ - - - End of Life +
    +
    End of Life + The BIND 9.9 (Extended Support Version) will be supported until June, 2017. - https://www.isc.org/downloads/software-support-policy/ + https://www.isc.org/downloads/software-support-policy/ - - - Thank You +
    +
    Thank You + Thank you to everyone who assisted us in making this release possible. If you would like to contribute to ISC to assist us in continuing to make quality open source software, please visit our donations page at - http://www.isc.org/donate/. + http://www.isc.org/donate/. - - +
    +
    diff --git a/doc/arm/pkcs11.xml b/doc/arm/pkcs11.xml index d5a841295a..73a4266e7b 100644 --- a/doc/arm/pkcs11.xml +++ b/doc/arm/pkcs11.xml @@ -1,6 +1,3 @@ -]> - - - - - PKCS #11 (Cryptoki) support + +
    PKCS #11 (Cryptoki) support + PKCS #11 (Public Key Cryptography Standard #11) defines a platform- independent API for the control of hardware security modules (HSMs) and other cryptographic support devices. @@ -28,8 +23,8 @@ cryptographic acceleration board, tested under Solaris x86, and the AEP Keyper network-attached key storage device, tested with Debian Linux, Solaris x86 and Windows Server 2003. - - Prerequisites +
    Prerequisites + See the HSM vendor documentation for information about installing, initializing, testing and troubleshooting the HSM. @@ -60,7 +55,7 @@ function primarily as secure key storage devices, but lack hardware acceleration. These devices are highly secure, but are not necessarily any faster at cryptography than the - system CPU — often, they are slower. It is therefore + system CPU — often, they are slower. It is therefore most efficient to use them only for those cryptographic functions that require access to the secured private key, such as zone signing, and to use the system CPU for all @@ -89,7 +84,7 @@ library. Obtain OpenSSL 0.9.8s: -$ wget http://www.openssl.org/source/openssl-0.9.8s.tar.gz +$ wget http://www.openssl.org/source/openssl-0.9.8s.tar.gz Extract the tarball: @@ -108,9 +103,9 @@ $ patch -p1 -d openssl-0.9.8s \ 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. - +
    Building OpenSSL for the AEP Keyper on Linux - 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 @@ -139,10 +134,10 @@ $ ./Configure linux-generic32 -m32 -pthread \ 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 - 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 @@ -161,10 +156,10 @@ $ ./Configure solaris64-x86_64-cc \ After configuring, run make and make test. - - +
    +
    Building OpenSSL for SoftHSM - Building OpenSSL for SoftHSM + SoftHSM is a software library provided by the OpenDNSSEC project (http://www.opendnssec.org) which provides a PKCS#11 interface to a virtual HSM, implemented in the form of encrypted @@ -183,7 +178,7 @@ $ configure --prefix=/opt/pkcs11/usr $ make $ make install $ export SOFTHSM_CONF=/opt/pkcs11/softhsm.conf -$ echo "0:/opt/pkcs11/softhsm.db" > $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 @@ -199,7 +194,7 @@ $ ./Configure linux-x86_64 -pthread \ 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 @@ -221,14 +216,14 @@ $ ./Configure linux-x86_64 -pthread \ "make install" which will install the modified OpenSSL suite to /opt/pkcs11/usr. - - - Building BIND 9 with PKCS#11 +
    +
    Building BIND 9 with PKCS#11 + When building BIND 9, the location of the custom-built OpenSSL library must be specified via configure. - +
    Configuring BIND 9 for Linux with the AEP Keyper - Configuring BIND 9 for Linux with the AEP Keyper + To link with the PKCS #11 provider, threads must be enabled in the BIND 9 build. The PKCS #11 library for the AEP Keyper is currently @@ -241,10 +236,10 @@ $ ./configure CC="gcc -m32" --enable-threads \ --with-openssl=/opt/pkcs11/usr \ --with-pkcs11=/opt/pkcs11/usr/lib/libpkcs11.so - - +
    +
    Configuring BIND 9 for Solaris with the SCA 6000 - 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. @@ -259,26 +254,26 @@ $ ./configure CC="cc -xarch=amd64" --enable-threads \ incorrectly specified the path to OpenSSL (it should be the same as the --prefix argument to the OpenSSL Configure). - - +
    +
    Configuring BIND 9 for SoftHSM - Configuring BIND 9 for SoftHSM + $ cd ../bind9 $ ./configure --enable-threads \ --with-openssl=/opt/pkcs11/usr \ --with-pkcs11=/opt/pkcs11/usr/lib/libpkcs11.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 +
    +
    PKCS #11 Tools + BIND 9 includes a minimal set of tools to operate the HSM, including pkcs11-keygen to generate a new key pair @@ -293,9 +288,9 @@ $ ./configure --enable-threads \ provider will be left undefined. Use the -m option or the PKCS11_PROVIDER environment variable to specify the path to the provider.) - - - Using the HSM +
    +
    Using the HSM + First, we must set up the runtime environment so the OpenSSL and PKCS #11 libraries can be loaded: @@ -381,9 +376,9 @@ 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 +
    +
    Specifying the engine on the command line + The OpenSSL engine can be specified in named and all of the BIND dnssec-* tools by using the "-E @@ -392,18 +387,18 @@ example.net.signed Specifying the engine will generally not be necessary unless for some reason you wish to use a different OpenSSL engine. - If you wish to disable use of the "pkcs11" 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: + — 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. - - - Running named with automatic zone re-signing +
    +
    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 @@ -439,7 +434,7 @@ a problem because it probably won't be running on a terminal HSM. Be sure this is what you want to do before configuring OpenSSL in this way. - +
    - +
    diff --git a/doc/tex/.gitignore b/doc/tex/.gitignore new file mode 100644 index 0000000000..764b6ada73 --- /dev/null +++ b/doc/tex/.gitignore @@ -0,0 +1 @@ +armstyle.sty diff --git a/doc/arm/html-fixup.pl b/doc/tex/Makefile.in similarity index 75% rename from doc/arm/html-fixup.pl rename to doc/tex/Makefile.in index 2763813601..62a3742daa 100644 --- a/doc/arm/html-fixup.pl +++ b/doc/tex/Makefile.in @@ -1,6 +1,4 @@ -#!/usr/bin/perl -w -# -# Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC") +# Copyright (C) 2005, 2007, 2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above @@ -14,7 +12,14 @@ # OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR # PERFORMANCE OF THIS SOFTWARE. -while (<>) { - s/쎶/ö/; - print; -} +srcdir = @srcdir@ +VPATH = @srcdir@ +top_srcdir = @top_srcdir@ + +SUBDIRS = +TARGETS = + +@BIND9_MAKE_RULES@ + +distclean:: + rm -f armstyle.sty diff --git a/doc/tex/armstyle.sty.in b/doc/tex/armstyle.sty.in new file mode 100644 index 0000000000..0aa766cdef --- /dev/null +++ b/doc/tex/armstyle.sty.in @@ -0,0 +1,107 @@ +%% +%% This style is derivated from the docbook one +%% +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{armstyle}[] + +%% Just use the original package and pass the options +\RequirePackageWithOptions{db2latex} + +% 2015-09-03 reed -- used with figure +\usepackage{float} + +% For page layout +\usepackage{geometry} + +% don't want date on the cover page +\let\@date\@empty + +% get rid of "Chapter" on start of each chapter +\def\@makechapterhead#1{% + \vspace*{50\p@}% + {\parindent \z@ \raggedright \normalfont + \ifnum \c@secnumdepth >\m@ne + \if@mainmatter + \Huge\bfseries\sffamily \thechapter\space\space\space\space% + \fi + \fi + \interlinepenalty\@M + \Huge \bfseries \sffamily #1\par\nobreak + \vskip 40\p@ + }} + +% for use of \titleformat +\usepackage{titlesec} + +\titleformat*{\section}{\Large\bfseries\scshape\sffamily} +\titleformat*{\subsection}{\large\bfseries\sffamily} + +% Contents font too ; note I don't know what last parts of this are for +\titleformat{\chapter}{\Huge\bfseries\sffamily}{\thechapter}{1em}{} \vspace{6pt} + +% font for the Index headline also +\titleformat{\index}{\Huge\bfseries\sffamily}{Index}{1em}{} \vspace{6pt} + +% following two lines for no indenting paragraphs and spacing between +\setlength\parskip{\medskipamount} +\setlength\parindent{0pt} + +% fancy footers +\pagestyle{fancy} +\fancyfoot[ce,co]{\thepage} +\fancyfoot[le,ro]{@BIND9_VERSIONSHORT@} +\renewcommand{\headrulewidth}{0.4 pt} +\fancypagestyle{plain}{% + \fancyhf{}% + \fancyfoot[ce,co]{\thepage}% + \fancyfoot[le,ro]{@BIND9_VERSIONSHORT@} + \renewcommand{\headrulewidth}{0 pt} +} +\fancypagestyle{empty}{% + \fancyhf{}% + \renewcommand{\headrulewidth}{0 pt} + \renewcommand{\footrulewidth}{0 pt} +} + +% custom title and copyright pages +\def\maketitle{ + \thispagestyle{empty} + \null\vfil + \vskip 60pt + \begin{center}% + { %\LARGE + \Huge + \bfseries + \DBKtitle \\ + \par + } + \vskip 3em% + { %\large + \Large + \lineskip .75em% + @BIND9_VERSIONSTRING@ + \par + } + \vfil\null + % Not sure exactly how much to trim logo, but given that + % this is a centered environment, we need not be too precise + % so long as the image is centered in the input PDF, we + % trim enough for it to fit on page, and we do not trim + % so much that we clip out part of the graphic itself. + % This seems to work, anyway. + \includegraphics[trim=400 400 400 400,scale=2.5]{isc-logo} + \end{center}\par + \newpage + \thispagestyle{empty} + \vfill + \DBKcopyright \\ + \vfill\null + \begin{center} + Internet Systems Consortium \\ + 950 Charter Street \\ + Redwood City, California \\ + USA \\ + https://www.isc.org/ + \end{center} + \vfil\null +} diff --git a/doc/tex/notestyle.sty b/doc/tex/notestyle.sty new file mode 100644 index 0000000000..6ae2d0caf4 --- /dev/null +++ b/doc/tex/notestyle.sty @@ -0,0 +1,17 @@ +%% +%% This style is derivated from the docbook one +%% +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{notestyle}[] + +%% Just use the original package and pass the options +\RequirePackageWithOptions{db2latex} + +%% My Cover Page +\def\maketitle{% +} + +%% Suppress header +\fancyhead{} +\renewcommand{\headrulewidth}{0pt} +\renewcommand{\footrulewidth}{0pt} diff --git a/doc/xsl/Makefile.in b/doc/xsl/Makefile.in index e77194c1ad..ed925ca41c 100644 --- a/doc/xsl/Makefile.in +++ b/doc/xsl/Makefile.in @@ -23,5 +23,4 @@ TARGETS = distclean:: rm -f isc-docbook-chunk.xsl isc-docbook-html.xsl \ - isc-docbook-latex.xsl isc-manpage.xsl \ - isc-notes-html.xsl isc-notes-latex.xsl + isc-manpage.xsl isc-notes-html.xsl diff --git a/doc/xsl/arm-param.xsl b/doc/xsl/arm-param.xsl new file mode 100644 index 0000000000..89feb5bf66 --- /dev/null +++ b/doc/xsl/arm-param.xsl @@ -0,0 +1,123 @@ + + + + + + + + + + + + + + + + + + + + + + + + + 2 + + + + + + + + + + + + + + + + + + + + + + book + + + + + nohyperlink,colorlinks,linkcolor=black,urlcolor=black + + + 1 + + + 2 + + + 1 + + + + + + + + + + + + + + + + + + + \textsf{ + + } + + + + + + default + + + qanda + + + 5 + 0 + + + + + \\ + + + + \def\DBKtitle{ + + } + + \def\DBKcopyright{ + + } + + + diff --git a/doc/xsl/copyright.xsl b/doc/xsl/copyright.xsl index 395f89a111..2a6b35385e 100644 --- a/doc/xsl/copyright.xsl +++ b/doc/xsl/copyright.xsl @@ -14,11 +14,12 @@ - PERFORMANCE OF THIS SOFTWARE. --> - - - + @@ -52,20 +53,20 @@ - + Copyright (C) - + - + + - - - - + @@ -44,6 +44,10 @@ - + + + + @@ -52,8 +56,6 @@ - $Id$ - diff --git a/doc/xsl/isc-docbook-html.xsl.in b/doc/xsl/isc-docbook-html.xsl.in index 6efd5dd433..8b91a29fc2 100644 --- a/doc/xsl/isc-docbook-html.xsl.in +++ b/doc/xsl/isc-docbook-html.xsl.in @@ -14,11 +14,11 @@ - PERFORMANCE OF THIS SOFTWARE. --> - - - + @@ -37,6 +37,10 @@ - + + + + @@ -45,8 +49,6 @@ - $Id$ - diff --git a/doc/xsl/isc-docbook-latex-mappings.xml b/doc/xsl/isc-docbook-latex-mappings.xml deleted file mode 100644 index 97c7cef810..0000000000 --- a/doc/xsl/isc-docbook-latex-mappings.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - % - % ------------------------------------------------------------- - % Refentry - % ------------------------------------------------------------- - \section{%title%} - \label{%id%}\hypertarget{%id%}{}% - - - diff --git a/doc/xsl/isc-docbook-latex.xsl.in b/doc/xsl/isc-docbook-latex.xsl.in deleted file mode 100644 index a9c32621a6..0000000000 --- a/doc/xsl/isc-docbook-latex.xsl.in +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - 10pt,twoside,openright - - - - - - - - - - ansi - - - - - - - - - , - - - - - - - - % - - - - - - - - - - - \par - - - - - [ - - ] - - - - - - \begin{titlepage} - \null\vfil - \vskip 60pt - \begin{center}% - { %\LARGE - \Huge - \bfseries - - - - - - \par}% - \vskip 3em% - { %\large - \Large - \lineskip .75em% - - - - - - \par} - %\vskip 1.5em% - \vfil - % Not sure exactly how much to trim logo, but given that - % this is a centered environment, we need not be too precise - % so long as the image is centered in the input PDF, we - % trim enough for it to fit on page, and we do not trim - % so much that we clip out part of the graphic itself. - % This seems to work, anyway. - \includegraphics[trim=400 400 400 400,scale=2.5]{isc-logo} - \end{center}\par - \vfil\null - \end{titlepage} - - - - - - - - \pagestyle{fancy} - \fancyfoot[ce,co]{\thepage} - \fancyfoot[le,ro]{@BIND9_VERSIONSTRING@} - \renewcommand{\headrulewidth}{0.4 pt} - \fancypagestyle{plain}{% - \fancyhf{}% - \fancyfoot[ce,co]{\thepage}% - \fancyfoot[le,ro]{@BIND9_VERSIONSTRING@}% - \renewcommand{\headrulewidth}{0 pt} - } - - - - - - \thispagestyle{empty} - - \begin{center} - - \end{center} - - \begin{center} - - \end{center} - - - \vfill - \begin{center} - Internet Systems Consortium \\ - 950 Charter Street \\ - Redwood City, California \\ - USA \\ - http://www.isc.org/ - \end{center} - - - \newpage - \pagenumbering{roman} - \tableofcontents - \newpage - \pagenumbering{arabic} - - - - - - \mbox{ - - } - - - - - diff --git a/doc/xsl/isc-docbook-text.xsl b/doc/xsl/isc-docbook-text.xsl index abca9eaafc..79a945013e 100644 --- a/doc/xsl/isc-docbook-text.xsl +++ b/doc/xsl/isc-docbook-text.xsl @@ -14,8 +14,6 @@ - PERFORMANCE OF THIS SOFTWARE. --> - - - - - + - - + + .\" + - + ansi @@ -40,8 +41,6 @@ - .\" - .\" $Id$ .\" .hy 0 .ad l diff --git a/doc/xsl/isc-notes-html.xsl.in b/doc/xsl/isc-notes-html.xsl.in index a9b7e29e75..f5b42f9f01 100644 --- a/doc/xsl/isc-notes-html.xsl.in +++ b/doc/xsl/isc-notes-html.xsl.in @@ -16,7 +16,9 @@ - + @@ -35,6 +37,10 @@ - + + + + diff --git a/doc/xsl/isc-notes-latex.xsl.in b/doc/xsl/isc-notes-latex.xsl.in deleted file mode 100644 index 721471ccaf..0000000000 --- a/doc/xsl/isc-notes-latex.xsl.in +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - - - - - - - - - - - - 10pt,twoside,openright - - - - - - - - - - ansi - - - - - - - - - , - - - - - - - - - - - - - - a4paper,10pt,twoside,openright - - - - - \par - - - - - [ - - ] - - - - - \mbox{ - - } - - - - - diff --git a/doc/xsl/notes-param.xsl b/doc/xsl/notes-param.xsl new file mode 100644 index 0000000000..8701a6e70d --- /dev/null +++ b/doc/xsl/notes-param.xsl @@ -0,0 +1,28 @@ + + + + + + + + diff --git a/doc/xsl/pre-latex.xsl b/doc/xsl/pre-latex.xsl index 9473556c6a..81d82c5056 100644 --- a/doc/xsl/pre-latex.xsl +++ b/doc/xsl/pre-latex.xsl @@ -21,7 +21,9 @@ - There's probably a better way to do this, but this will work for now. --> - + diff --git a/isc-config.sh.1 b/isc-config.sh.1 index add96b0204..6fa8e186fb 100644 --- a/isc-config.sh.1 +++ b/isc-config.sh.1 @@ -1,87 +1,103 @@ -.\" Copyright (C) 2009, 2012, 2014 Internet Systems Consortium, Inc. ("ISC") -.\" +.\" Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: isc\-config.sh +'\" t +.\" Title: isc-config.sh .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: February 18, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2009-02-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "ISC\-CONFIG.SH" "1" "February 18, 2009" "BIND9" "BIND9" +.TH "ISC\-CONFIG\&.SH" "1" "2009\-02\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "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 .SH "SYNOPSIS" .HP 14 -\fBisc\-config.sh\fR [\fB\-\-cflags\fR] [\fB\-\-exec\-prefix\fR] [\fB\-\-libs\fR] [\fB\-\-prefix\fR] [\fB\-\-version\fR] [libraries...] +\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. +\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 -The optional libraries are used to report specific details for compiling and linking for the listed libraries. The allowed choices are: +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, \fBisccfg\fR, \fBdns\fR, \fBlwres\fR, and -\fBbind9\fR. Multiple libraries may be listed on the command line. (Some libraries require other libraries, so are implied.) +\fBbind9\fR\&. Multiple libraries may be listed on the command line\&. (Some libraries require other libraries, so are implied\&.) .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. +command line argument(s) to print additional specific flags to pass to the C compiler\&. .RE .PP \-\-exec\-prefix .RS 4 -Prints the directory prefix used in the ISC BIND installation for architecture dependent files to standard output. +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. +command line argument(s) to print additional specific flags\&. .RE .PP \-\-prefix .RS 4 -Prints the directory prefix used in the ISC BIND installation for architecture independent files to standard output. +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. +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. +\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" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/isc-config.sh.docbook b/isc-config.sh.docbook index dcf2120a79..7a411cc210 100644 --- a/isc-config.sh.docbook +++ b/isc-config.sh.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2009-02-18 + - February 18, 2009 + ISC + Internet Systems Consortium, Inc. @@ -42,19 +43,19 @@ - + isc-config.sh - - - - - + + + + + libraries - - DESCRIPTION + DESCRIPTION + isc-config.sh prints information related to the installed version of ISC BIND, such as the compiler and linker flags required to compile @@ -74,10 +75,10 @@ (Some libraries require other libraries, so are implied.) - + - - OPTIONS + OPTIONS + @@ -136,25 +137,15 @@ - + - - RETURN VALUES + RETURN VALUES + 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. - + - - AUTHOR - Internet Systems Consortium - - - - + diff --git a/isc-config.sh.html b/isc-config.sh.html index 8bb2f4f2cd..804580e527 100644 --- a/isc-config.sh.html +++ b/isc-config.sh.html @@ -1,44 +1,63 @@ - - isc-config.sh - + -
    +
    -
    + + + + + + + +

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

    -
    -
    -

    DESCRIPTION

    -

    isc-config.sh +

    + isc-config.sh + [--cflags] + [--exec-prefix] + [--libs] + [--prefix] + [--version] + [libraries...] +

    +
    + +
    +

    DESCRIPTION

    + +

    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: @@ -51,52 +70,65 @@ Multiple libraries may be listed on the command line. (Some libraries require other libraries, so are implied.)

    -
    -
    -

    OPTIONS

    -
    + +
    + +
    +

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

    + +
    +

    RETURN VALUES

    + +

    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.

    -
    -
    -

    AUTHOR

    -

    Internet Systems Consortium -

    -
    +
    +
    diff --git a/lib/lwres/man/lwres.3 b/lib/lwres/man/lwres.3 index 2c03e3ae9f..2b1e1463eb 100644 --- a/lib/lwres/man/lwres.3 +++ b/lib/lwres/man/lwres.3 @@ -13,36 +13,51 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres \- introduction to the lightweight resolver library .SH "SYNOPSIS" .nf -#include +#include .fi .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 +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. +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 -The lwresd library implements multiple name service APIs. The standard +The lwresd library implements multiple name service APIs\&. The standard \fBgethostbyname()\fR, \fBgethostbyaddr()\fR, \fBgethostbyname_r()\fR, @@ -50,66 +65,66 @@ The lwresd library implements multiple name service APIs. The standard \fBgetaddrinfo()\fR, \fBgetipnodebyname()\fR, and \fBgetipnodebyaddr()\fR -functions are all supported. To allow the lwres library to coexist with system libraries that define functions of the same name, the library defines these functions with names prefixed by -lwres_. To define the standard names, applications must include the header file -\fI\fR +functions are all supported\&. To allow the lwres library to coexist with system libraries that define functions of the same name, the library defines these functions with names prefixed by +lwres_\&. To define the standard names, applications must include the header file + 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. +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 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. +\fBlwres_getnamebyaddr()\fR\&. These may be called by applications that require more detailed control over the lookup process than the standard functions provide\&. .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. +function\&. .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 +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" +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 -When a client program wishes to make an lwres request using the native low\-level API, it typically performs the following sequence of actions. +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 (1) Allocate or use an existing \fBlwres_packet_t\fR, called \fIpkt\fR -below. +below\&. .PP (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 -\fIlwres.h\fR: -\fBLWRES_RECVLENGTH = 4096\fR. +\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 (3) Set -pkt.serial -to a unique serial number. This value is echoed back to the application by the remote server. +\fIpkt\&.serial\fR +to a unique serial number\&. This value is echoed back to the application by the remote server\&. .PP (4) Set -pkt.pktflags. Usually this is set to 0. +\fIpkt\&.pktflags\fR\&. Usually this is set to 0\&. .PP (5) Set -pkt.result -to 0. +\fIpkt\&.result\fR +to 0\&. .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. +and storing the packet data\&. .PP -(7) Transmit the resulting buffer. +(7) Transmit the resulting buffer\&. .PP (8) Call \fBlwres_*response_parse()\fR -to parse any packets received. +to parse any packets received\&. .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" +(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 -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. +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 Note that the same \fBlwres_packet_t\fR @@ -117,34 +132,34 @@ is used in both the \fB_parse()\fR and \fB_render()\fR -calls, with only a few modifications made to the packet header's contents between uses. This method is recommended as it keeps the serial, opcode, and other fields correct. +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 (1) When a packet is received, call \fBlwres_*request_parse()\fR -to unmarshall it. This returns a +to unmarshall it\&. This returns a \fBlwres_packet_t\fR (also called \fIpkt\fR, below) as well as a data specific type, such as -\fBlwres_gabnrequest_t\fR. +\fBlwres_gabnrequest_t\fR\&. .PP -(2) Process the request in the data specific type. +(2) Process the request in the data specific type\&. .PP (3) Set the -pkt.result, -pkt.recvlength -as above. All other fields can be left untouched since they were filled in by the +\fIpkt\&.result\fR, +\fIpkt\&.recvlength\fR +as above\&. All other fields can be left untouched since they were filled in by the \fB*_parse()\fR -call above. If using +call above\&. If using \fBlwres_*response_render()\fR, -pkt.pktflags -will be set up properly. Otherwise, the +\fIpkt\&.pktflags\fR +will be set up properly\&. Otherwise, the \fBLWRES_LWPACKETFLAG_RESPONSE\fR -bit should be set. +bit should be set\&. .PP (4) Call the data specific rendering function, such as -\fBlwres_gabnresponse_render()\fR. +\fBlwres_gabnresponse_render()\fR\&. .PP -(5) Send the resulting packet to the client. +(5) Send the resulting packet to the client\&. .PP .SH "SEE ALSO" .PP @@ -157,8 +172,12 @@ bit should be set. \fBlwres_context\fR(3), \fBlwres_config\fR(3), \fBresolver\fR(5), -\fBlwresd\fR(8). +\fBlwresd\fR(8)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres.docbook b/lib/lwres/man/lwres.docbook index 26723e5f0c..2988ac2d0d 100644 --- a/lib/lwres/man/lwres.docbook +++ b/lib/lwres/man/lwres.docbook @@ -1,6 +1,3 @@ -]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -55,8 +55,8 @@ - - DESCRIPTION + DESCRIPTION + The BIND 9 lightweight resolver library is a simple, name service independent stub resolver library. It provides hostname-to-address @@ -69,10 +69,10 @@ The library and resolver daemon communicate using a simple UDP-based protocol. - + - - OVERVIEW + OVERVIEW + The lwresd library implements multiple name service APIs. The standard @@ -124,9 +124,9 @@ 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 + + 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 @@ -137,23 +137,23 @@ called pkt below. - (2) Set pkt.recvlength to the maximum length + (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 + (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 + (4) Set pkt.pktflags. Usually this is set to 0. - (5) Set pkt.result to 0. + (5) Set pkt.result to 0. (6) Call lwres_*request_render(), @@ -172,9 +172,9 @@ (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 + + 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 @@ -197,12 +197,12 @@ (2) Process the request in the data specific type. - (3) Set the pkt.result, - pkt.recvlength as above. All other fields + (3) Set the pkt.result, + pkt.recvlength as above. All other fields can be left untouched since they were filled in by the *_parse() call above. If using lwres_*response_render(), - pkt.pktflags will be set up + pkt.pktflags will be set up properly. Otherwise, the LWRES_LWPACKETFLAG_RESPONSE bit should be set. @@ -213,10 +213,10 @@ (5) Send the resulting packet to the client. - - - - SEE ALSO + + + SEE ALSO + lwres_gethostent3 , @@ -258,9 +258,5 @@ . - - + + diff --git a/lib/lwres/man/lwres.html b/lib/lwres/man/lwres.html index 1fd396135e..6a3d90d42b 100644 --- a/lib/lwres/man/lwres.html +++ b/lib/lwres/man/lwres.html @@ -14,41 +14,56 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres - + -
    -
    -
    +
    +
    + + + + +

    Name

    -

    lwres — introduction to the lightweight resolver library

    -
    -
    -

    Synopsis

    -
    #include <lwres/lwres.h>
    -
    -
    -

    DESCRIPTION

    + lwres + — introduction to the lightweight resolver library +

    +
    + + + +
    +

    Synopsis

    +
    +
    #include <lwres/lwres.h>
    +
    +
    + +
    +

    DESCRIPTION

    + +

    The BIND 9 lightweight resolver library is a simple, name service independent stub resolver library. It provides hostname-to-address and address-to-hostname lookup services to applications by transmitting lookup requests to a resolver daemon - lwresd + lwresd 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.

    -
    -
    -

    OVERVIEW

    -

    +

    + +
    +

    OVERVIEW

    + +

    The lwresd library implements multiple name service APIs. The standard gethostbyname(), @@ -73,7 +88,7 @@ library into their base distributions should rename the functions in the library proper so that the renaming macros are not needed.

    -

    +

    The library also provides a native API consisting of the functions lwres_getaddrsbyname() and @@ -82,80 +97,82 @@ 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, and is also used when implementing the server side of the lwres protocol, for example in the - lwresd + lwresd 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

    -

    +

    +
    +

    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 +

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

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

    + (4) Set pkt.pktflags. Usually this is set to 0.

    -

    - (5) Set pkt.result 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

    -

    +

    +
    +

    SERVER-SIDE LOW-LEVEL API CALL FLOW

    + +

    When implementing the server side of the lightweight resolver protocol using the lwres library, a sequence of actions like the following is typically involved in processing each request packet.

    -

    +

    Note that the same lwres_packet_t is used in both the _parse() and _render() calls, with only a few modifications made @@ -163,56 +180,77 @@ 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 +

    + (3) Set the pkt.result, + pkt.recvlength as above. All other fields can be left untouched since they were filled in by the *_parse() call above. If using lwres_*response_render(), - pkt.pktflags will be set up + pkt.pktflags will be set up 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), +

    +
    +
    +

    SEE ALSO

    + +

    + 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 22b14ab2e6..6956e639e1 100644 --- a/lib/lwres/man/lwres_buffer.3 +++ b/lib/lwres/man/lwres_buffer.3 @@ -13,132 +13,155 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_buffer .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_BUFFER" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_BUFFER" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .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" .nf -#include +#include .fi -.HP 23 +.HP \w'void\ lwres_buffer_init('u .BI "void lwres_buffer_init(lwres_buffer_t\ *" "b" ", void\ *" "base" ", unsigned\ int\ " "length" ");" -.HP 29 +.HP \w'void\ lwres_buffer_invalidate('u .BI "void lwres_buffer_invalidate(lwres_buffer_t\ *" "b" ");" -.HP 22 +.HP \w'void\ lwres_buffer_add('u .BI "void lwres_buffer_add(lwres_buffer_t\ *" "b" ", unsigned\ int\ " "n" ");" -.HP 27 +.HP \w'void\ lwres_buffer_subtract('u .BI "void lwres_buffer_subtract(lwres_buffer_t\ *" "b" ", unsigned\ int\ " "n" ");" -.HP 24 +.HP \w'void\ lwres_buffer_clear('u .BI "void lwres_buffer_clear(lwres_buffer_t\ *" "b" ");" -.HP 24 +.HP \w'void\ lwres_buffer_first('u .BI "void lwres_buffer_first(lwres_buffer_t\ *" "b" ");" -.HP 26 +.HP \w'void\ lwres_buffer_forward('u .BI "void lwres_buffer_forward(lwres_buffer_t\ *" "b" ", unsigned\ int\ " "n" ");" -.HP 23 +.HP \w'void\ lwres_buffer_back('u .BI "void lwres_buffer_back(lwres_buffer_t\ *" "b" ", unsigned\ int\ " "n" ");" -.HP 36 +.HP \w'lwres_uint8_t\ lwres_buffer_getuint8('u .BI "lwres_uint8_t lwres_buffer_getuint8(lwres_buffer_t\ *" "b" ");" -.HP 27 +.HP \w'void\ lwres_buffer_putuint8('u .BI "void lwres_buffer_putuint8(lwres_buffer_t\ *" "b" ", lwres_uint8_t\ " "val" ");" -.HP 38 +.HP \w'lwres_uint16_t\ lwres_buffer_getuint16('u .BI "lwres_uint16_t lwres_buffer_getuint16(lwres_buffer_t\ *" "b" ");" -.HP 28 +.HP \w'void\ lwres_buffer_putuint16('u .BI "void lwres_buffer_putuint16(lwres_buffer_t\ *" "b" ", lwres_uint16_t\ " "val" ");" -.HP 38 +.HP \w'lwres_uint32_t\ lwres_buffer_getuint32('u .BI "lwres_uint32_t lwres_buffer_getuint32(lwres_buffer_t\ *" "b" ");" -.HP 28 +.HP \w'void\ lwres_buffer_putuint32('u .BI "void lwres_buffer_putuint32(lwres_buffer_t\ *" "b" ", lwres_uint32_t\ " "val" ");" -.HP 25 +.HP \w'void\ lwres_buffer_putmem('u .BI "void lwres_buffer_putmem(lwres_buffer_t\ *" "b" ", const\ unsigned\ char\ *" "base" ", unsigned\ int\ " "length" ");" -.HP 25 +.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 -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 +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. +functions in the ISC library\&. .PP -A buffer is a region of memory, together with a set of related subregions. The +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's 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's region. The size of the used region can be changed using various buffer commands. Initially, the used region is empty. +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 The used region is further subdivided into two disjoint regions: the \fIconsumed region\fR and the -\fIremaining region\fR. The union of these two regions is the used region. The consumed region extends from the beginning of the used region to the byte before the +\fIremaining region\fR\&. The union of these two regions is the used region\&. The consumed region extends from the beginning of the used region to the byte before the \fIcurrent\fR -offset (if any). 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. +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 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. +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 +.if n \{\ .RS 4 +.\} .nf - /\-\-\-\-\-\-\-\-\-\-\-\-entire length\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\\\\ - /\-\-\-\-\- used region \-\-\-\-\-\\\\/\-\- available \-\-\\\\ + /\-\-\-\-\-\-\-\-\-\-\-\-entire length\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\e\e + /\-\-\-\-\- used region \-\-\-\-\-\e\e/\-\- available \-\-\e\e +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | consumed | remaining | | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ a b c d e .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf - a == base of buffer. - b == current pointer. Can be anywhere between a and d. - c == active pointer. Meaningful between b and d. - d == used pointer. - e == length of buffer. + a == base of buffer\&. + b == current pointer\&. Can be anywhere between a and d\&. + c == active pointer\&. Meaningful between b and d\&. + d == used pointer\&. + e == length of buffer\&. .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf - a\-e == entire length of buffer. - a\-d == used region. - a\-b == consumed region. - b\-d == remaining region. - b\-c == optional active region. + a\-e == entire length of buffer\&. + a\-d == used region\&. + a\-b == consumed region\&. + b\-d == remaining region\&. + b\-c == optional active region\&. .fi +.if n \{\ .RE -.sp +.\} .PP \fBlwres_buffer_init()\fR initializes the -\fBlwres_buffer_t\fR -\fI*b\fR +\fBlwres_buffer_t\fR\fI*b\fR and assocates it with the memory region of size \fIlength\fR bytes starting at location -\fIbase.\fR +\fIbase\&.\fR .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. +as invalid\&. Invalidating a buffer after use is not required, but makes it possible to catch its possible accidental use\&. .PP The functions \fBlwres_buffer_add()\fR @@ -148,49 +171,49 @@ respectively increase and decrease the used space in buffer \fI*b\fR by \fIn\fR -bytes. +bytes\&. \fBlwres_buffer_add()\fR 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 -used. +checks for underflow\&. These functions do not allocate or deallocate memory\&. They just change the value of +\fIused\fR\&. .PP A buffer is re\-initialised by -\fBlwres_buffer_clear()\fR. The function sets -used, -current +\fBlwres_buffer_clear()\fR\&. The function sets +\fIused\fR, +\fIcurrent\fR and -active -to zero. +\fIactive\fR +to zero\&. .PP \fBlwres_buffer_first\fR makes the consumed region of buffer \fI*p\fR empty by setting -current -to zero (the start of the buffer). +\fIcurrent\fR +to zero (the start of the buffer)\&. .PP \fBlwres_buffer_forward()\fR increases the consumed region of buffer \fI*b\fR by \fIn\fR -bytes, checking for overflow. Similarly, +bytes, checking for overflow\&. Similarly, \fBlwres_buffer_back()\fR decreases buffer -\fIb\fR's consumed region by +\fIb\fR\*(Aqs consumed region by \fIn\fR -bytes and checks for underflow. +bytes and checks for underflow\&. .PP \fBlwres_buffer_getuint8()\fR reads an unsigned 8\-bit integer from \fI*b\fR -and returns it. +and returns it\&. \fBlwres_buffer_putuint8()\fR writes the unsigned 8\-bit integer \fIval\fR to buffer -\fI*b\fR. +\fI*b\fR\&. .PP \fBlwres_buffer_getuint16()\fR and @@ -198,35 +221,39 @@ and are identical to \fBlwres_buffer_putuint8()\fR except that they respectively read an unsigned 16\-bit or 32\-bit integer in network byte order from -\fIb\fR. Similarly, +\fIb\fR\&. Similarly, \fBlwres_buffer_putuint16()\fR and \fBlwres_buffer_putuint32()\fR writes the unsigned 16\-bit or 32\-bit integer \fIval\fR to buffer -\fIb\fR, in network byte order. +\fIb\fR, in network byte order\&. .PP Arbitrary amounts of data are read or written from a lightweight resolver buffer with \fBlwres_buffer_getmem()\fR and \fBlwres_buffer_putmem()\fR -respectively. +respectively\&. \fBlwres_buffer_putmem()\fR copies \fIlength\fR bytes of memory at \fIbase\fR to -\fIb\fR. Conversely, +\fIb\fR\&. Conversely, \fBlwres_buffer_getmem()\fR copies \fIlength\fR bytes of memory from \fIb\fR to -\fIbase\fR. +\fIbase\fR\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_buffer.docbook b/lib/lwres/man/lwres_buffer.docbook index 17ccbf549f..1377ae66ce 100644 --- a/lib/lwres/man/lwres_buffer.docbook +++ b/lib/lwres/man/lwres_buffer.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -199,9 +200,9 @@ void - + DESCRIPTION - DESCRIPTION + These functions provide bounds checked access to a region of memory where data is being read or written. @@ -302,23 +303,23 @@ void checks for underflow. These functions do not allocate or deallocate memory. They just change the value of - used. + used. A buffer is re-initialised by lwres_buffer_clear(). The function sets - used, - current + used, + current and - active + active to zero. lwres_buffer_first makes the consumed region of buffer *p empty by setting - current + current to zero (the start of the buffer). lwres_buffer_forward() @@ -386,9 +387,5 @@ void to base. - - + + diff --git a/lib/lwres/man/lwres_buffer.html b/lib/lwres/man/lwres_buffer.html index 4d29441ca1..32bde8d2e9 100644 --- a/lib/lwres/man/lwres_buffer.html +++ b/lib/lwres/man/lwres_buffer.html @@ -14,263 +14,265 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_buffer - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
     
    - + +
    - - + - - + - - +
    void lwres_buffer_init(lwres_buffer_t *  -b, lwres_buffer_t *b,
     void *  -base, void *base,
     unsigned int   -length);unsigned int length);
    - +
     
    + +
    - - +
    void lwres_buffer_invalidate(lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    +
    - - + - - +
    void lwres_buffer_add(lwres_buffer_t *  -b, lwres_buffer_t *b,
     unsigned int   -n);unsigned int n);
    - +
     
    + +
    - - + - - +
    void lwres_buffer_subtract(lwres_buffer_t *  -b, lwres_buffer_t *b,
     unsigned int   -n);unsigned int n);
    - +
     
    + +
    - - +
    void lwres_buffer_clear(lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    + +
    - - +
    void lwres_buffer_first(lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    + +
    - - + - - +
    void lwres_buffer_forward(lwres_buffer_t *  -b, lwres_buffer_t *b,
     unsigned int   -n);unsigned int n);
    - +
     
    +
    - - + - - +
    void lwres_buffer_back(lwres_buffer_t *  -b, lwres_buffer_t *b,
     unsigned int   -n);unsigned int n);
    - +
     
    + +
    - - +
    lwres_uint8_t lwres_buffer_getuint8(lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    + +
    - - + - - +
    void lwres_buffer_putuint8(lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_uint8_t   -val);lwres_uint8_t val);
    - +
     
    + +
    - - +
    lwres_uint16_t lwres_buffer_getuint16(lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    + +
    - - + - - +
    void lwres_buffer_putuint16(lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_uint16_t   -val);lwres_uint16_t val);
    - +
     
    + +
    - - +
    lwres_uint32_t lwres_buffer_getuint32(lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    + +
    - - + - - +
    void lwres_buffer_putuint32(lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_uint32_t   -val);lwres_uint32_t val);
    - +
     
    + +
    - - + - - + - - +
    void lwres_buffer_putmem(lwres_buffer_t *  -b, lwres_buffer_t *b,
     const unsigned char *  -base, const unsigned char *base,
     unsigned int   -length);unsigned int length);
    - +
     
    + +
    - - + - - + - - +
    void lwres_buffer_getmem(lwres_buffer_t *  -b, lwres_buffer_t *b,
     unsigned char *  -base, unsigned char *base,
     unsigned int   -length);unsigned int length);
    +
     
    +
    -
    -
    -

    DESCRIPTION

    -

    +

    + +
    +

    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 @@ -284,7 +286,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. @@ -297,7 +299,7 @@ void buffer commands. Initially, the consumed region is empty.

    -

    +

    The active region is an (optional) subregion of the remaining region. @@ -307,7 +309,7 @@ void If the current offset advances beyond the chosen offset, the active region will also be empty.

    -
    +    
        /------------entire length---------------\\
        /----- used region -----\\/-- available --\\
        +----------------------------------------+
    @@ -317,7 +319,7 @@ void
           

    -
    +    
       a == base of buffer.
       b == current pointer.  Can be anywhere between a and d.
       c == active pointer.  Meaningful between b and d.
    @@ -326,7 +328,7 @@ void
           

    -
    +    
       a-e == entire length of buffer.
       a-d == used region.
       a-b == consumed region.
    @@ -335,7 +337,7 @@ void
     

    -

    lwres_buffer_init() +

    lwres_buffer_init() initializes the lwres_buffer_t *b @@ -344,12 +346,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 @@ -366,26 +368,26 @@ void checks for underflow. These functions do not allocate or deallocate memory. They just change the value of - used. + used.

    -

    +

    A buffer is re-initialised by lwres_buffer_clear(). The function sets - used, - current + used, + current and - active + active to zero.

    -

    lwres_buffer_first +

    lwres_buffer_first makes the consumed region of buffer *p empty by setting - current + current to zero (the start of the buffer).

    -

    lwres_buffer_forward() +

    lwres_buffer_forward() increases the consumed region of buffer *b by @@ -399,7 +401,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. @@ -409,7 +411,7 @@ void to buffer *b.

    -

    lwres_buffer_getuint16() +

    lwres_buffer_getuint16() and lwres_buffer_getuint32() are identical to @@ -427,7 +429,7 @@ void b, in network byte order.

    -

    +

    Arbitrary amounts of data are read or written from a lightweight resolver buffer with lwres_buffer_getmem() @@ -450,6 +452,6 @@ void to base.

    -
    +
    diff --git a/lib/lwres/man/lwres_config.3 b/lib/lwres/man/lwres_config.3 index 25b1181005..e944cd8baf 100644 --- a/lib/lwres/man/lwres_config.3 +++ b/lib/lwres/man/lwres_config.3 @@ -13,37 +13,52 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_config .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_CONFIG" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_CONFIG" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get \- lightweight resolver configuration .SH "SYNOPSIS" .nf -#include +#include .fi -.HP 21 +.HP \w'void\ lwres_conf_init('u .BI "void lwres_conf_init(lwres_context_t\ *" "ctx" ");" -.HP 22 +.HP \w'void\ lwres_conf_clear('u .BI "void lwres_conf_clear(lwres_context_t\ *" "ctx" ");" -.HP 32 +.HP \w'lwres_result_t\ lwres_conf_parse('u .BI "lwres_result_t lwres_conf_parse(lwres_context_t\ *" "ctx" ", const\ char\ *" "filename" ");" -.HP 32 +.HP \w'lwres_result_t\ lwres_conf_print('u .BI "lwres_result_t lwres_conf_print(lwres_context_t\ *" "ctx" ", FILE\ *" "fp" ");" -.HP 30 +.HP \w'lwres_conf_t\ *\ lwres_conf_get('u .BI "lwres_conf_t * lwres_conf_get(lwres_context_t\ *" "ctx" ");" .SH "DESCRIPTION" .PP @@ -51,21 +66,21 @@ lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_con creates an empty \fBlwres_conf_t\fR structure for lightweight resolver context -\fIctx\fR. +\fIctx\fR\&. .PP \fBlwres_conf_clear()\fR frees up all the internal memory used by that \fBlwres_conf_t\fR structure in resolver context -\fIctx\fR. +\fIctx\fR\&. .PP \fBlwres_conf_parse()\fR opens the file \fIfilename\fR and parses it to initialise the resolver context -\fIctx\fR's +\fIctx\fR\*(Aqs \fBlwres_conf_t\fR -structure. +structure\&. .PP \fBlwres_conf_print()\fR prints the @@ -73,33 +88,36 @@ prints the structure for resolver context \fIctx\fR to the -\fBFILE\fR -\fIfp\fR. +\fBFILE\fR\fIfp\fR\&. .SH "RETURN VALUES" .PP \fBlwres_conf_parse()\fR returns \fBLWRES_R_SUCCESS\fR if it successfully read and parsed -\fIfilename\fR. It returns +\fIfilename\fR\&. It returns \fBLWRES_R_FAILURE\fR if \fIfilename\fR -could not be opened or contained incorrect resolver statements. +could not be opened or contained incorrect resolver statements\&. .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. +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 \fBstdio\fR(3), -\fBresolver\fR(5). +\fBresolver\fR(5)\&. .SH "FILES" .PP -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_config.docbook b/lib/lwres/man/lwres_config.docbook index 5af37eaf7c..0ad795f3a2 100644 --- a/lib/lwres/man/lwres_config.docbook +++ b/lib/lwres/man/lwres_config.docbook @@ -1,6 +1,3 @@ -]> - - + + + + 2007-06-18 + - - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -92,8 +92,8 @@ lwres_conf_t * - - DESCRIPTION + DESCRIPTION + lwres_conf_init() creates an empty @@ -128,10 +128,10 @@ lwres_conf_t * FILE fp. - - + + RETURN VALUES - RETURN VALUES + lwres_conf_parse() returns LWRES_R_SUCCESS @@ -150,9 +150,9 @@ lwres_conf_t * If this happens, the function returns LWRES_R_FAILURE. - - - SEE ALSO + + SEE ALSO + stdio3 , @@ -160,14 +160,10 @@ lwres_conf_t * resolver5 . - - - FILES + + FILES + /etc/resolv.conf - - + + diff --git a/lib/lwres/man/lwres_config.html b/lib/lwres/man/lwres_config.html index 3fc8826342..182108d73e 100644 --- a/lib/lwres/man/lwres_config.html +++ b/lib/lwres/man/lwres_config.html @@ -14,97 +14,107 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_config - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
    - +
    - - +
    void lwres_conf_init(lwres_context_t *  -ctx);lwres_context_t *ctx);
    - +
     
    +
    - - +
    void lwres_conf_clear(lwres_context_t *  -ctx);lwres_context_t *ctx);
    - +
     
    +
    - - + - - +
    lwres_result_t lwres_conf_parse(lwres_context_t *  -ctx, lwres_context_t *ctx,
     const char *  -filename);const char *filename);
    - +
     
    +
    - - + - - +
    lwres_result_t lwres_conf_print(lwres_context_t *  -ctx, lwres_context_t *ctx,
     FILE *  -fp);FILE *fp);
    - +
     
    +
    - - +
    lwres_conf_t * lwres_conf_get(lwres_context_t *  -ctx);lwres_context_t *ctx);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    lwres_conf_init() +

    + +
    +

    DESCRIPTION

    + + +

    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 @@ -112,7 +122,8 @@ lwres_conf_t * lwres_conf_t structure.

    -

    lwres_conf_print() + +

    lwres_conf_print() prints the lwres_conf_t structure for resolver context @@ -121,10 +132,13 @@ lwres_conf_t * FILE fp.

    -
    -
    -

    RETURN VALUES

    -

    lwres_conf_parse() +

    +
    +

    RETURN VALUES

    + + + +

    lwres_conf_parse() returns LWRES_R_SUCCESS if it successfully read and parsed filename. @@ -133,24 +147,31 @@ lwres_conf_t * could not be opened or contained incorrect resolver statements.

    -

    lwres_conf_print() + +

    lwres_conf_print() returns LWRES_R_SUCCESS unless an error occurred when converting the network addresses to a numeric host address string. If this happens, the function returns LWRES_R_FAILURE.

    -
    -
    -

    SEE ALSO

    -

    stdio(3), - resolver(5). +

    +
    +

    SEE ALSO

    + +

    + stdio(3) + , + + resolver(5) + .

    -
    -
    -

    FILES

    -

    /etc/resolv.conf +

    +
    +

    FILES

    + +

    /etc/resolv.conf

    -
    +
    diff --git a/lib/lwres/man/lwres_context.3 b/lib/lwres/man/lwres_context.3 index d544a3c398..b9bb9be84f 100644 --- a/lib/lwres/man/lwres_context.3 +++ b/lib/lwres/man/lwres_context.3 @@ -13,126 +13,141 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_context .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_CONTEXT" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_CONTEXT" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .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" .nf -#include +#include .fi -.HP 36 +.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 37 +.HP \w'lwres_result_t\ lwres_context_destroy('u .BI "lwres_result_t lwres_context_destroy(lwres_context_t\ **" "contextp" ");" -.HP 30 +.HP \w'void\ lwres_context_initserial('u .BI "void lwres_context_initserial(lwres_context_t\ *" "ctx" ", lwres_uint32_t\ " "serial" ");" -.HP 40 +.HP \w'lwres_uint32_t\ lwres_context_nextserial('u .BI "lwres_uint32_t lwres_context_nextserial(lwres_context_t\ *" "ctx" ");" -.HP 27 +.HP \w'void\ lwres_context_freemem('u .BI "void lwres_context_freemem(lwres_context_t\ *" "ctx" ", void\ *" "mem" ", size_t\ " "len" ");" -.HP 28 +.HP \w'void\ lwres_context_allocmem('u .BI "void lwres_context_allocmem(lwres_context_t\ *" "ctx" ", size_t\ " "len" ");" -.HP 30 +.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 \fBlwres_context_create()\fR creates a \fBlwres_context_t\fR -structure for use in lightweight resolver operations. It holds a socket and other data needed for communicating with a resolver daemon. The new +structure for use in lightweight resolver operations\&. It holds a socket and other data needed for communicating with a resolver daemon\&. The new \fBlwres_context_t\fR is returned through \fIcontextp\fR, a pointer to a \fBlwres_context_t\fR -pointer. This +pointer\&. This \fBlwres_context_t\fR pointer must initially be NULL, and is modified to point to the newly created -\fBlwres_context_t\fR. +\fBlwres_context_t\fR\&. .PP When the lightweight resolver needs to perform dynamic memory allocation, it will call \fImalloc_function\fR to allocate memory and \fIfree_function\fR -to free it. If +to free it\&. If \fImalloc_function\fR and \fIfree_function\fR are NULL, memory is allocated using -\fBmalloc\fR(3). and -\fBfree\fR(3). It is not permitted to have a NULL +\fBmalloc\fR(3)\&. and +\fBfree\fR(3)\&. It is not permitted to have a NULL \fImalloc_function\fR and a non\-NULL \fIfree_function\fR -or vice versa. +or vice versa\&. \fIarg\fR -is passed as the first parameter to the memory allocation functions. If +is passed as the first parameter to the memory allocation functions\&. If \fImalloc_function\fR and \fIfree_function\fR are NULL, \fIarg\fR -is unused and should be passed as NULL. +is unused and should be passed as NULL\&. .PP Once memory for the structure has been allocated, it is initialized using \fBlwres_conf_init\fR(3) and returned via -\fI*contextp\fR. +\fI*contextp\fR\&. .PP \fBlwres_context_destroy()\fR destroys a -\fBlwres_context_t\fR, closing its socket. +\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. +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 -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 +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 -\fBlwres_context_nextserial()\fR. +\fBlwres_context_nextserial()\fR\&. \fBlwres_context_initserial()\fR sets the serial number for context \fI*ctx\fR to -\fIserial\fR. +\fIserial\fR\&. \fBlwres_context_nextserial()\fR -increments the serial number and returns the previous value. +increments the serial number and returns the previous value\&. .PP Memory for a lightweight resolver context is allocated and freed using \fBlwres_context_allocmem()\fR and -\fBlwres_context_freemem()\fR. These use whatever allocations were defined when the context was created with -\fBlwres_context_create()\fR. +\fBlwres_context_freemem()\fR\&. These use whatever allocations were defined when the context was created with +\fBlwres_context_create()\fR\&. \fBlwres_context_allocmem()\fR allocates \fIlen\fR -bytes of memory and if successful returns a pointer to the allocated storage. +bytes of memory and if successful returns a pointer to the allocated storage\&. \fBlwres_context_freemem()\fR frees \fIlen\fR bytes of space starting at location -\fImem\fR. +\fImem\fR\&. .PP \fBlwres_context_sendrecv()\fR performs I/O for the context -\fIctx\fR. Data are read and written from the context's socket. It writes data from +\fIctx\fR\&. Data are read and written from the context\*(Aqs socket\&. It writes data from \fIsendbase\fR \(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. +\fIrecvbase\fR\&. The number of bytes that were written to this receive buffer is returned in +\fI*recvd_len\fR\&. .SH "RETURN VALUES" .PP \fBlwres_context_create()\fR @@ -142,28 +157,32 @@ if memory for the \fBstruct lwres_context\fR could not be allocated, \fBLWRES_R_SUCCESS\fR -otherwise. +otherwise\&. .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. +return a pointer to the start of the allocated space\&. It returns NULL if memory could not be allocated\&. .PP \fBLWRES_R_SUCCESS\fR is returned when \fBlwres_context_sendrecv()\fR -completes successfully. +completes successfully\&. \fBLWRES_R_IOERROR\fR is returned if an I/O error occurs and \fBLWRES_R_TIMEOUT\fR is returned if \fBlwres_context_sendrecv()\fR -times out waiting for a response. +times out waiting for a response\&. .SH "SEE ALSO" .PP \fBlwres_conf_init\fR(3), \fBmalloc\fR(3), -\fBfree\fR(3). +\fBfree\fR(3)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001, 2003 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_context.docbook b/lib/lwres/man/lwres_context.docbook index e0a45eecf3..e100c6579d 100644 --- a/lib/lwres/man/lwres_context.docbook +++ b/lib/lwres/man/lwres_context.docbook @@ -1,6 +1,5 @@ -]> +]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -115,8 +117,8 @@ void * - - DESCRIPTION + DESCRIPTION + lwres_context_create() creates a lwres_context_t structure for use in @@ -212,10 +214,10 @@ void * written to this receive buffer is returned in *recvd_len. - + - - RETURN VALUES + RETURN VALUES + lwres_context_create() returns LWRES_R_NOMEMORY if memory for @@ -239,9 +241,9 @@ void * lwres_context_sendrecv() times out waiting for a response. - - - SEE ALSO + + SEE ALSO + lwres_conf_init3 , @@ -254,9 +256,5 @@ void * free3 . - - + + diff --git a/lib/lwres/man/lwres_context.html b/lib/lwres/man/lwres_context.html index 6ca8be4fdc..2540bba073 100644 --- a/lib/lwres/man/lwres_context.html +++ b/lib/lwres/man/lwres_context.html @@ -14,166 +14,152 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_context - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
    - +
    - - + - - + - - + - - +
    lwres_result_t lwres_context_create(lwres_context_t **  -contextp, lwres_context_t **contextp,
     void *  -arg, void *arg,
     lwres_malloc_t   -malloc_function, lwres_malloc_t malloc_function,
     lwres_free_t   -free_function);lwres_free_t free_function);
    - +
     
    +
    - - +
    lwres_result_t lwres_context_destroy(lwres_context_t **  -contextp);lwres_context_t **contextp);
    - +
     
    +
    - - + - - +
    void lwres_context_initserial(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_uint32_t   -serial);lwres_uint32_t serial);
    - +
     
    +
    - - +
    lwres_uint32_t lwres_context_nextserial(lwres_context_t *  -ctx);lwres_context_t *ctx);
    - +
     
    +
    - - + - - + - - +
    void lwres_context_freemem(lwres_context_t *  -ctx, lwres_context_t *ctx,
     void *  -mem, void *mem,
     size_t   -len);size_t len);
    - +
     
    +
    - - + - - +
    void lwres_context_allocmem(lwres_context_t *  -ctx, lwres_context_t *ctx,
     size_t   -len);size_t len);
    - +
     
    +
    - - + - - + - - + - - + - - + - - +
    void * lwres_context_sendrecv(lwres_context_t *  -ctx, lwres_context_t *ctx,
     void *  -sendbase, void *sendbase,
     int   -sendlen, int sendlen,
     void *  -recvbase, void *recvbase,
     int   -recvlen, int recvlen,
     int *  -recvd_len);int *recvd_len);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    lwres_context_create() +

    +
    +

    DESCRIPTION

    + + +

    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 @@ -184,7 +170,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 @@ -195,9 +181,13 @@ void * and free_function are NULL, memory is allocated using - malloc(3). + + malloc(3) + . and - free(3). + + free(3) + . It is not permitted to have a NULL malloc_function and a non-NULL @@ -209,19 +199,24 @@ void * arg is unused and should be passed as NULL.

    -

    + +

    Once memory for the structure has been allocated, it is initialized using - lwres_conf_init(3) + + lwres_conf_init(3) + and returned via *contextp.

    -

    lwres_context_destroy() + +

    lwres_context_destroy() destroys a lwres_context_t, closing its socket. contextp is a pointer to a pointer to the context that is to be destroyed. The pointer will be set to NULL when the context has been destroyed.

    -

    + +

    The context holds a serial number that is used to identify resolver request packets and associate responses with the corresponding requests. This serial number is controlled using @@ -233,7 +228,8 @@ void * lwres_context_nextserial() increments the serial number and returns the previous value.

    -

    + +

    Memory for a lightweight resolver context is allocated and freed using lwres_context_allocmem() and lwres_context_freemem(). These use @@ -246,7 +242,8 @@ void * len bytes of space starting at location mem.

    -

    lwres_context_sendrecv() + +

    lwres_context_sendrecv() performs I/O for the context ctx. Data are read and written from the context's socket. It writes data from sendbase — typically a @@ -256,21 +253,24 @@ void * written to this receive buffer is returned in *recvd_len.

    -
    -
    -

    RETURN VALUES

    -

    lwres_context_create() +

    + +
    +

    RETURN VALUES

    + + +

    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. @@ -281,15 +281,22 @@ void * lwres_context_sendrecv() times out waiting for a response.

    -
    -
    -

    SEE ALSO

    -

    lwres_conf_init(3), +

    +
    +

    SEE ALSO

    + +

    + 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 f67126eb54..d0594cea54 100644 --- a/lib/lwres/man/lwres_gabn.3 +++ b/lib/lwres/man/lwres_gabn.3 @@ -13,69 +13,92 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_gabn .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_GABN" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_GABN" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .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" .nf -#include +#include .fi -.HP 40 +.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 41 +.HP \w'lwres_result_t\ lwres_gabnresponse_render('u .BI "lwres_result_t lwres_gabnresponse_render(lwres_context_t\ *" "ctx" ", lwres_gabnresponse_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");" -.HP 39 +.HP \w'lwres_result_t\ lwres_gabnrequest_parse('u .BI "lwres_result_t lwres_gabnrequest_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_gabnrequest_t\ **" "structp" ");" -.HP 40 +.HP \w'lwres_result_t\ lwres_gabnresponse_parse('u .BI "lwres_result_t lwres_gabnresponse_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_gabnresponse_t\ **" "structp" ");" -.HP 29 +.HP \w'void\ lwres_gabnresponse_free('u .BI "void lwres_gabnresponse_free(lwres_context_t\ *" "ctx" ", lwres_gabnresponse_t\ **" "structp" ");" -.HP 28 +.HP \w'void\ lwres_gabnrequest_free('u .BI "void lwres_gabnrequest_free(lwres_context_t\ *" "ctx" ", lwres_gabnrequest_t\ **" "structp" ");" .SH "DESCRIPTION" .PP -These are low\-level routines for creating and parsing lightweight resolver name\-to\-address lookup request and response messages. +These are low\-level routines for creating and parsing lightweight resolver name\-to\-address lookup request and response messages\&. .PP -There are four main functions for the getaddrbyname opcode. One render function converts a getaddrbyname request structure \(em +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's 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 +\(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. +\(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 These structures are defined in -\fI\fR. They are shown below. +\&. They are shown below\&. .PP +.if n \{\ .RS 4 +.\} .nf #define LWRES_OPCODE_GETADDRSBYNAME 0x00010001U .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf typedef struct lwres_addr lwres_addr_t; typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf typedef struct { lwres_uint32_t flags; @@ -84,10 +107,13 @@ typedef struct { char *name; } lwres_gabnrequest_t; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf typedef struct { lwres_uint32_t flags; @@ -102,24 +128,25 @@ typedef struct { size_t baselen; } lwres_gabnresponse_t; .fi +.if n \{\ .RE -.sp +.\} .PP \fBlwres_gabnrequest_render()\fR uses resolver context \fIctx\fR to convert getaddrbyname request structure \fIreq\fR -to canonical format. The packet header structure +to canonical format\&. The packet header structure \fIpkt\fR is initialised and transferred to buffer -\fIb\fR. The contents of +\fIb\fR\&. The contents of \fI*req\fR -are then appended to the buffer in canonical format. +are then appended to the buffer in canonical format\&. \fBlwres_gabnresponse_render()\fR performs the same task, except it converts a getaddrbyname response structure \fBlwres_gabnresponse_t\fR -to the lightweight resolver's canonical format. +to the lightweight resolver\*(Aqs canonical format\&. .PP \fBlwres_gabnrequest_parse()\fR uses context @@ -128,18 +155,18 @@ to convert the contents of packet \fIpkt\fR to a \fBlwres_gabnrequest_t\fR -structure. Buffer +structure\&. Buffer \fIb\fR -provides space to be used for storing this structure. When the function succeeds, the resulting +provides space to be used for storing this structure\&. When the function succeeds, the resulting \fBlwres_gabnrequest_t\fR is made available through -\fI*structp\fR. +\fI*structp\fR\&. \fBlwres_gabnresponse_parse()\fR offers the same semantics as \fBlwres_gabnrequest_parse()\fR except it yields a \fBlwres_gabnresponse_t\fR -structure. +structure\&. .PP \fBlwres_gabnresponse_free()\fR and @@ -151,20 +178,19 @@ that was allocated to the or \fBlwres_gabnrequest_t\fR structures referenced via -\fIstructp\fR. Any memory associated with ancillary buffers and strings for those structures is also discarded. +\fIstructp\fR\&. Any memory associated with ancillary buffers and strings for those structures is also discarded\&. .SH "RETURN VALUES" .PP The getaddrbyname opcode functions \fBlwres_gabnrequest_render()\fR, -\fBlwres_gabnresponse_render()\fR -\fBlwres_gabnrequest_parse()\fR +\fBlwres_gabnresponse_render()\fR\fBlwres_gabnrequest_parse()\fR and \fBlwres_gabnresponse_parse()\fR all return \fBLWRES_R_SUCCESS\fR -on success. They return +on success\&. They return \fBLWRES_R_NOMEMORY\fR -if memory allocation fails. +if memory allocation fails\&. \fBLWRES_R_UNEXPECTEDEND\fR is returned if the available space in the buffer \fIb\fR @@ -172,23 +198,27 @@ is too small to accommodate the packet header or the \fBlwres_gabnrequest_t\fR and \fBlwres_gabnresponse_t\fR -structures. +structures\&. \fBlwres_gabnrequest_parse()\fR and \fBlwres_gabnresponse_parse()\fR will return \fBLWRES_R_UNEXPECTEDEND\fR -if the buffer is not empty after decoding the received packet. These functions will return +if the buffer is not empty after decoding the received packet\&. These functions will return \fBLWRES_R_FAILURE\fR if -pktflags +\fIpktflags\fR in the packet header structure \fBlwres_lwpacket_t\fR -indicate that the packet is not a response to an earlier query. +indicate that the packet is not a response to an earlier query\&. .SH "SEE ALSO" .PP \fBlwres_packet\fR(3) +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_gabn.docbook b/lib/lwres/man/lwres_gabn.docbook index 8743696c12..3f7fc8d475 100644 --- a/lib/lwres/man/lwres_gabn.docbook +++ b/lib/lwres/man/lwres_gabn.docbook @@ -1,6 +1,5 @@ -]> +]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -109,8 +111,8 @@ void - - DESCRIPTION + DESCRIPTION + These are low-level routines for creating and parsing lightweight resolver name-to-address lookup request and @@ -207,9 +209,9 @@ typedef struct { Any memory associated with ancillary buffers and strings for those structures is also discarded. - - - RETURN VALUES + + RETURN VALUES + The getaddrbyname opcode functions lwres_gabnrequest_render(), @@ -240,21 +242,17 @@ typedef struct { These functions will return LWRES_R_FAILURE if - pktflags + pktflags in the packet header structure lwres_lwpacket_t indicate that the packet is not a response to an earlier query. - - - SEE ALSO + + SEE ALSO + lwres_packet3 - - + + diff --git a/lib/lwres/man/lwres_gabn.html b/lib/lwres/man/lwres_gabn.html index dfc6c28038..eea1369e94 100644 --- a/lib/lwres/man/lwres_gabn.html +++ b/lib/lwres/man/lwres_gabn.html @@ -14,177 +14,158 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_gabn - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
    - +
    - - + - - + - - + - - +
    lwres_result_t lwres_gabnrequest_render(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_gabnrequest_t *  -req, lwres_gabnrequest_t *req,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    +
    - - + - - + - - + - - +
    lwres_result_t lwres_gabnresponse_render(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_gabnresponse_t *  -req, lwres_gabnresponse_t *req,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    +
    - - + - - + - - + - - +
    lwres_result_t lwres_gabnrequest_parse(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_gabnrequest_t **  -structp);lwres_gabnrequest_t **structp);
    - +
     
    +
    - - + - - + - - + - - +
    lwres_result_t lwres_gabnresponse_parse(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_gabnresponse_t **  -structp);lwres_gabnresponse_t **structp);
    - +
     
    +
    - - + - - +
    void lwres_gabnresponse_free(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_gabnresponse_t **  -structp);lwres_gabnresponse_t **structp);
    - +
     
    +
    - - + - - +
    void lwres_gabnrequest_free(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_gabnrequest_t **  -structp);lwres_gabnrequest_t **structp);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    +

    +
    +

    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 — @@ -197,23 +178,23 @@ void This is complemented by a parse function which converts a packet in canonical format to a getaddrbyname response structure.

    -

    +

    These structures are defined in <lwres/lwres.h>. They are shown below.

    -
    +    
     #define LWRES_OPCODE_GETADDRSBYNAME     0x00010001U
     

    -
    +    
     typedef struct lwres_addr lwres_addr_t;
     typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t;
     

    -
    +    
     typedef struct {
             lwres_uint32_t  flags;
             lwres_uint32_t  addrtypes;
    @@ -223,7 +204,7 @@ typedef struct {
     

    -
    +    
     typedef struct {
             lwres_uint32_t          flags;
             lwres_uint16_t          naliases;
    @@ -239,7 +220,8 @@ typedef struct {
     

    -

    lwres_gabnrequest_render() + +

    lwres_gabnrequest_render() uses resolver context ctx to convert getaddrbyname request structure req to canonical format. The packet header structure @@ -253,7 +235,8 @@ typedef struct { lwres_gabnresponse_t to the lightweight resolver's canonical format.

    -

    lwres_gabnrequest_parse() + +

    lwres_gabnrequest_parse() uses context ctx to convert the contents of packet pkt to a lwres_gabnrequest_t structure. Buffer @@ -266,7 +249,8 @@ typedef struct { semantics as lwres_gabnrequest_parse() except it yields a lwres_gabnresponse_t structure.

    -

    lwres_gabnresponse_free() + +

    lwres_gabnresponse_free() and lwres_gabnrequest_free() release the memory in resolver context ctx that was allocated to the lwres_gabnresponse_t or @@ -276,10 +260,11 @@ typedef struct { Any memory associated with ancillary buffers and strings for those structures is also discarded.

    -
    -
    -

    RETURN VALUES

    -

    +

    +
    +

    RETURN VALUES

    + +

    The getaddrbyname opcode functions lwres_gabnrequest_render(), lwres_gabnresponse_render() @@ -309,16 +294,19 @@ typedef struct { These functions will return LWRES_R_FAILURE if - pktflags + pktflags in the packet header structure lwres_lwpacket_t indicate that the packet is not a response to an earlier query.

    -
    -
    -

    SEE ALSO

    -

    lwres_packet(3) +

    +
    +

    SEE ALSO

    + +

    + lwres_packet(3) +

    -
    +
    diff --git a/lib/lwres/man/lwres_gai_strerror.3 b/lib/lwres/man/lwres_gai_strerror.3 index 8da3828f91..f646c4c116 100644 --- a/lib/lwres/man/lwres_gai_strerror.3 +++ b/lib/lwres/man/lwres_gai_strerror.3 @@ -13,36 +13,51 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_gai_strerror .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_GAI_STRERROR" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_GAI_STRERROR" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres_gai_strerror \- print suitable error string .SH "SYNOPSIS" .nf -#include +#include .fi -.HP 20 +.HP \w'char\ *\ gai_strerror('u .BI "char * gai_strerror(int\ " "ecode" ");" .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 -\fIinclude/lwres/netdb.h\fR. +\fBgetaddrinfo()\fR\&. The following error codes and their meaning are defined in +include/lwres/netdb\&.h\&. .PP \fBEAI_ADDRFAMILY\fR .RS 4 @@ -106,7 +121,7 @@ The message invalid error code is returned if \fIecode\fR -is out of range. +is out of range\&. .PP \fBai_flags\fR, \fBai_family\fR @@ -115,14 +130,18 @@ and are elements of the \fBstruct addrinfo\fR used by -\fBlwres_getaddrinfo()\fR. +\fBlwres_getaddrinfo()\fR\&. .SH "SEE ALSO" .PP \fBstrerror\fR(3), \fBlwres_getaddrinfo\fR(3), \fBgetaddrinfo\fR(3), -\fBRFC2133\fR(). +\fBRFC2133\fR()\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_gai_strerror.docbook b/lib/lwres/man/lwres_gai_strerror.docbook index a9314d3199..61636fa025 100644 --- a/lib/lwres/man/lwres_gai_strerror.docbook +++ b/lib/lwres/man/lwres_gai_strerror.docbook @@ -1,6 +1,3 @@ -]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -62,8 +62,8 @@ char * - - DESCRIPTION + DESCRIPTION + lwres_gai_strerror() returns an error message corresponding to an error code returned by @@ -172,10 +172,10 @@ char * used by lwres_getaddrinfo(). - + - - SEE ALSO + SEE ALSO + strerror3 , @@ -192,9 +192,5 @@ char * RFC2133 . - - + + diff --git a/lib/lwres/man/lwres_gai_strerror.html b/lib/lwres/man/lwres_gai_strerror.html index 615f983391..aaae94e906 100644 --- a/lib/lwres/man/lwres_gai_strerror.html +++ b/lib/lwres/man/lwres_gai_strerror.html @@ -14,92 +14,126 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_gai_strerror - + -
    -
    -
    +
    +
    + + + + + + + +

    Name

    -

    lwres_gai_strerror — print suitable error string

    +

    + lwres_gai_strerror + — print suitable error string +

    -
    + +

    Synopsis

    -
    +
    #include <lwres/netdb.h>
    - +
    - - +
    char * gai_strerror(int   -ecode);int ecode);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    lwres_gai_strerror() +

    + +
    +

    DESCRIPTION

    + + +

    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 include/lwres/netdb.h.

    -
    +
    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 @@ -108,17 +142,27 @@ char * used by lwres_getaddrinfo().

    -
    -
    -

    SEE ALSO

    -

    strerror(3), +

    - lwres_getaddrinfo(3), +
    +

    SEE ALSO

    + +

    + strerror(3) + , - getaddrinfo(3), + + lwres_getaddrinfo(3) + , - RFC2133. + + getaddrinfo(3) + , + + + RFC2133 + .

    -
    +
    diff --git a/lib/lwres/man/lwres_getaddrinfo.3 b/lib/lwres/man/lwres_getaddrinfo.3 index 88b4beabd2..750c3091cd 100644 --- a/lib/lwres/man/lwres_getaddrinfo.3 +++ b/lib/lwres/man/lwres_getaddrinfo.3 @@ -13,37 +13,51 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_getaddrinfo .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_GETADDRINFO" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_GETADDRINFO" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres_getaddrinfo, lwres_freeaddrinfo \- socket address structure to host and service name .SH "SYNOPSIS" .nf -#include +#include .fi -.HP 22 +.HP \w'int\ lwres_getaddrinfo('u .BI "int lwres_getaddrinfo(const\ char\ *" "hostname" ", const\ char\ *" "servname" ", const\ struct\ addrinfo\ *" "hints" ", struct\ addrinfo\ **" "res" ");" -.HP 24 +.HP \w'void\ lwres_freeaddrinfo('u .BI "void lwres_freeaddrinfo(struct\ addrinfo\ *" "ai" ");" .PP If the operating system does not provide a \fBstruct addrinfo\fR, the following structure is used: .PP -.RS 4 .nf struct addrinfo { int ai_flags; /* AI_PASSIVE, AI_CANONNAME */ @@ -56,7 +70,6 @@ struct addrinfo { struct addrinfo *ai_next; /* next structure in linked list */ }; .fi -.RE .sp .SH "DESCRIPTION" .PP @@ -64,31 +77,31 @@ struct addrinfo { is used to get a list of IP addresses and port numbers for host \fIhostname\fR and service -\fIservname\fR. The function is the lightweight resolver's implementation of +\fIservname\fR\&. The function is the lightweight resolver\*(Aqs implementation of \fBgetaddrinfo()\fR -as defined in RFC2133. +as defined in RFC2133\&. \fIhostname\fR and \fIservname\fR are pointers to null\-terminated strings or -\fBNULL\fR. +\fBNULL\fR\&. \fIhostname\fR -is either a host name or a numeric host address string: a dotted decimal IPv4 address or an IPv6 address. +is either a host name or a numeric host address string: a dotted decimal IPv4 address or an IPv6 address\&. \fIservname\fR is either a decimal port number or a service name as listed in -\fI/etc/services\fR. +/etc/services\&. .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 +\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 \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. +\fBPF_UNSPEC\fR, it means the caller will accept any protocol family supported by the operating system\&. .RE .PP \fBai_socktype\fR @@ -98,21 +111,21 @@ denotes the type of socket \(em \fBSOCK_DGRAM\fR or \fBSOCK_RAW\fR -\(em that is wanted. When +\(em that is wanted\&. When \fBai_socktype\fR -is zero the caller will accept any socket type. +is zero the caller will accept any socket type\&. .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. +is zero the caller will accept any protocol\&. .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 @@ -120,16 +133,16 @@ will return a null\-terminated string containing the canonical name of the speci \fBai_canonname\fR of the first \fBaddrinfo\fR -structure returned. Setting the +structure returned\&. Setting the \fBAI_PASSIVE\fR bit indicates that the returned socket address structure is intended for used in a call to -\fBbind\fR(2). In this case, if the hostname argument is a +\fBbind\fR(2)\&. In this case, if the hostname argument is a \fBNULL\fR pointer, then the IP address portion of the socket address structure will be set to \fBINADDR_ANY\fR for an IPv4 address or \fBIN6ADDR_ANY_INIT\fR -for an IPv6 address. +for an IPv6 address\&. .sp When \fBai_flags\fR @@ -141,14 +154,14 @@ for a connection\-oriented protocol or \fBconnect\fR(2), \fBsendto\fR(2), or \fBsendmsg\fR(2) -if a connectionless protocol was chosen. The IP address portion of the socket address structure will be set to the loopback address if +if a connectionless protocol was chosen\&. The IP address portion of the socket address structure will be set to the loopback address if \fIhostname\fR is a \fBNULL\fR pointer and \fBAI_PASSIVE\fR is not set in -\fBai_flags\fR. +\fBai_flags\fR\&. .sp If \fBai_flags\fR @@ -156,14 +169,14 @@ 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. +should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted\&. .RE .PP All other elements of the \fBstruct addrinfo\fR passed via \fIhints\fR -must be zero. +must be zero\&. .PP A \fIhints\fR @@ -173,59 +186,58 @@ is treated as if the caller provided a \fBstruct addrinfo\fR initialized to zero with \fBai_family\fRset to -\fBPF_UNSPEC\fR. +\fBPF_UNSPEC\fR\&. .PP After a successful call to \fBlwres_getaddrinfo()\fR, \fI*res\fR is a pointer to a linked list of one or more \fBaddrinfo\fR -structures. Each +structures\&. Each \fBstruct addrinfo\fR in this list cn be processed by following the \fBai_next\fR pointer, until a \fBNULL\fR -pointer is encountered. The three members +pointer is encountered\&. The three members \fBai_family\fR, \fBai_socktype\fR, and \fBai_protocol\fR in each returned \fBaddrinfo\fR structure contain the corresponding arguments for a call to -\fBsocket\fR(2). For each +\fBsocket\fR(2)\&. For each \fBaddrinfo\fR structure in the list, the \fBai_addr\fR member points to a filled\-in socket address structure of length -\fBai_addrlen\fR. +\fBai_addrlen\fR\&. .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 -\fBaddrinfo\fRstructures. Memory allocated for the dynamically allocated structures created by a successful call to +\fBaddrinfo\fRstructures\&. Memory allocated for the dynamically allocated structures created by a successful call to \fBlwres_getaddrinfo()\fR is released by -\fBlwres_freeaddrinfo()\fR. +\fBlwres_freeaddrinfo()\fR\&. \fIai\fR is a pointer to a \fBstruct addrinfo\fR created by a call to -\fBlwres_getaddrinfo()\fR. +\fBlwres_getaddrinfo()\fR\&. .SH "RETURN VALUES" .PP \fBlwres_getaddrinfo()\fR returns zero on success or one of the error codes listed in \fBgai_strerror\fR(3) -if an error occurs. If both +if an error occurs\&. If both \fIhostname\fR and \fIservname\fR are -\fBNULL\fR -\fBlwres_getaddrinfo()\fR +\fBNULL\fR\fBlwres_getaddrinfo()\fR returns -\fBEAI_NONAME\fR. +\fBEAI_NONAME\fR\&. .SH "SEE ALSO" .PP \fBlwres\fR(3), @@ -238,8 +250,12 @@ returns \fBconnect\fR(2), \fBsendto\fR(2), \fBsendmsg\fR(2), -\fBsocket\fR(2). +\fBsocket\fR(2)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001, 2003 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_getaddrinfo.docbook b/lib/lwres/man/lwres_getaddrinfo.docbook index 76927fd822..a7cdc0938a 100644 --- a/lib/lwres/man/lwres_getaddrinfo.docbook +++ b/lib/lwres/man/lwres_getaddrinfo.docbook @@ -1,6 +1,5 @@ -]> +]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -92,8 +94,8 @@ struct addrinfo { - - DESCRIPTION + DESCRIPTION + lwres_getaddrinfo() is used to get a list of IP addresses and port numbers for host @@ -316,10 +318,10 @@ struct addrinfo { lwres_getaddrinfo(). - + - - RETURN VALUES + RETURN VALUES + lwres_getaddrinfo() returns zero on success or one of the error codes listed in @@ -331,9 +333,9 @@ struct addrinfo { lwres_getaddrinfo() returns EAI_NONAME. - - - SEE ALSO + + SEE ALSO + lwres3 , @@ -379,9 +381,5 @@ struct addrinfo { . - - + + diff --git a/lib/lwres/man/lwres_getaddrinfo.html b/lib/lwres/man/lwres_getaddrinfo.html index ac9c3a8d9a..62ad083a51 100644 --- a/lib/lwres/man/lwres_getaddrinfo.html +++ b/lib/lwres/man/lwres_getaddrinfo.html @@ -14,66 +14,69 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_getaddrinfo - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
    - +
    - - + - - + - - + - - +
    int lwres_getaddrinfo(const char *  -hostname, const char *hostname,
     const char *  -servname, const char *servname,
     const struct addrinfo *  -hints, const struct addrinfo *hints,
     struct addrinfo **  -res);struct addrinfo **res);
    - +
     
    +
    - - +
    void lwres_freeaddrinfo(struct addrinfo *  -ai);struct addrinfo *ai);
    +
     
    -

    + +

    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 */
    @@ -87,10 +90,14 @@ struct  addrinfo {
     

    -
    -
    -

    DESCRIPTION

    -

    lwres_getaddrinfo() + +

    + +
    +

    DESCRIPTION

    + + +

    lwres_getaddrinfo() is used to get a list of IP addresses and port numbers for host hostname and service servname. @@ -107,7 +114,8 @@ struct addrinfo { decimal port number or a service name as listed in /etc/services.

    -

    hints + +

    hints is an optional pointer to a struct addrinfo. This structure can be used to provide hints concerning the type of @@ -117,9 +125,10 @@ struct addrinfo { *hints:

    -
    +
    ai_family
    -

    +

    +

    The protocol family that should be used. When ai_family @@ -128,9 +137,11 @@ struct addrinfo { it means the caller will accept any protocol family supported by the operating system. -

    +

    +
    ai_socktype
    -

    +

    +

    denotes the type of socket — SOCK_STREAM, SOCK_DGRAM @@ -140,18 +151,21 @@ struct addrinfo { When ai_socktype is zero the caller will accept any socket type. -

    +

    +
    ai_protocol
    -

    +

    +

    indicates which transport protocol is wanted: IPPROTO_UDP or IPPROTO_TCP. If ai_protocol is zero the caller will accept any protocol. -

    +

    +
    ai_flags
    -

    +

    Flag bits. If the AI_CANONNAME @@ -169,7 +183,9 @@ struct addrinfo { bit indicates that the returned socket address structure is intended for used in a call to - bind(2). + + bind(2) + . In this case, if the hostname argument is a NULL @@ -180,21 +196,29 @@ struct addrinfo { IN6ADDR_ANY_INIT for an IPv6 address.

    -

    +

    When ai_flags does not set the AI_PASSIVE bit, the returned socket address structure will be ready for use in a call to - connect(2) + + connect(2) + for a connection-oriented protocol or - connect(2), + + connect(2) + , - sendto(2), + + sendto(2) + , or - sendmsg(2) + + sendmsg(2) + if a connectionless protocol was chosen. The IP address portion of the socket address structure will be set to the loopback address if @@ -206,7 +230,7 @@ struct addrinfo { is not set in ai_flags.

    -

    +

    If ai_flags is set to @@ -217,22 +241,25 @@ struct addrinfo { address and no name resolution should be attempted.

    -
    +

    -

    + +

    All other elements of the struct addrinfo passed via hints must be zero.

    -

    + +

    A hints of NULL is treated as if the caller provided a struct addrinfo initialized to zero with ai_familyset to PF_UNSPEC.

    -

    + +

    After a successful call to lwres_getaddrinfo(), *res @@ -256,7 +283,9 @@ struct addrinfo { returned addrinfo structure contain the corresponding arguments for a call to - socket(2). + + socket(2) + . For each addrinfo structure in the list, the @@ -264,7 +293,8 @@ struct addrinfo { member points to a filled-in socket address structure of length ai_addrlen.

    -

    + +

    All of the information returned by lwres_getaddrinfo() is dynamically allocated: the addrinfo structures, and the socket @@ -281,42 +311,72 @@ struct addrinfo { created by a call to lwres_getaddrinfo().

    -
    -
    -

    RETURN VALUES

    -

    lwres_getaddrinfo() + +

    + +
    +

    RETURN VALUES

    + + +

    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), +

    +
    +

    SEE ALSO

    + +

    + 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 e53aa33c17..124bc85945 100644 --- a/lib/lwres/man/lwres_gethostent.3 +++ b/lib/lwres/man/lwres_gethostent.3 @@ -13,60 +13,77 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_gethostent .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_GETHOSTENT" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_GETHOSTENT" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .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" .nf -#include +#include .fi -.HP 37 +.HP \w'struct\ hostent\ *\ lwres_gethostbyname('u .BI "struct hostent * lwres_gethostbyname(const\ char\ *" "name" ");" -.HP 38 +.HP \w'struct\ hostent\ *\ lwres_gethostbyname2('u .BI "struct hostent * lwres_gethostbyname2(const\ char\ *" "name" ", int\ " "af" ");" -.HP 37 +.HP \w'struct\ hostent\ *\ lwres_gethostbyaddr('u .BI "struct hostent * lwres_gethostbyaddr(const\ char\ *" "addr" ", int\ " "len" ", int\ " "type" ");" -.HP 34 +.HP \w'struct\ hostent\ *\ lwres_gethostent('u .BI "struct hostent * lwres_gethostent(void);" -.HP 22 +.HP \w'void\ lwres_sethostent('u .BI "void lwres_sethostent(int\ " "stayopen" ");" -.HP 22 +.HP \w'void\ lwres_endhostent('u .BI "void lwres_endhostent(void);" -.HP 39 +.HP \w'struct\ hostent\ *\ lwres_gethostbyname_r('u .BI "struct hostent * lwres_gethostbyname_r(const\ char\ *" "name" ", struct\ hostent\ *" "resbuf" ", char\ *" "buf" ", int\ " "buflen" ", int\ *" "error" ");" -.HP 39 +.HP \w'struct\ hostent\ *\ lwres_gethostbyaddr_r('u .BI "struct hostent * lwres_gethostbyaddr_r(const\ char\ *" "addr" ", int\ " "len" ", int\ " "type" ", struct\ hostent\ *" "resbuf" ", char\ *" "buf" ", int\ " "buflen" ", int\ *" "error" ");" -.HP 36 +.HP \w'struct\ hostent\ *\ lwres_gethostent_r('u .BI "struct hostent * lwres_gethostent_r(struct\ hostent\ *" "resbuf" ", char\ *" "buf" ", int\ " "buflen" ", int\ *" "error" ");" -.HP 24 +.HP \w'void\ lwres_sethostent_r('u .BI "void lwres_sethostent_r(int\ " "stayopen" ");" -.HP 24 +.HP \w'void\ lwres_endhostent_r('u .BI "void lwres_endhostent_r(void);" .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 +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 +functions provided by most operating systems\&. They use a \fBstruct hostent\fR which is usually defined in -\fI\fR. +\&. .PP +.if n \{\ .RS 4 +.\} .nf struct hostent { char *h_name; /* official name of host */ @@ -77,19 +94,20 @@ struct hostent { }; #define h_addr h_addr_list[0] /* address, for backward compatibility */ .fi +.if n \{\ .RE -.sp +.\} .PP The members of this structure are: .PP \fBh_name\fR .RS 4 -The official (canonical) name of the host. +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. +A NULL\-terminated array of alternate names (nicknames) for the host\&. .RE .PP \fBh_addrtype\fR @@ -97,25 +115,25 @@ A NULL\-terminated array of alternate names (nicknames) for the host. The type of address being returned \(em \fBPF_INET\fR or -\fBPF_INET6\fR. +\fBPF_INET6\fR\&. .RE .PP \fBh_length\fR .RS 4 -The length of the address in bytes. +The length of the address in bytes\&. .RE .PP \fBh_addr_list\fR .RS 4 A \fBNULL\fR -terminated array of network addresses for the host. Host addresses are returned in network byte order. +terminated array of network addresses for the host\&. Host addresses are returned in network byte order\&. .RE .PP For backward compatibility with very old software, \fBh_addr\fR is the first address in -\fBh_addr_list.\fR +\fBh_addr_list\&.\fR .PP \fBlwres_gethostent()\fR, \fBlwres_sethostent()\fR, @@ -125,14 +143,14 @@ is the first address in and \fBlwres_endhostent_r()\fR provide iteration over the known host entries on systems that provide such functionality through facilities like -\fI/etc/hosts\fR -or NIS. The lightweight resolver does not currently implement these functions; it only provides them as stub functions that always return failure. +/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 \fBlwres_gethostbyname()\fR and \fBlwres_gethostbyname2()\fR look up the hostname -\fIname\fR. +\fIname\fR\&. \fBlwres_gethostbyname()\fR always looks for an IPv4 address while \fBlwres_gethostbyname2()\fR @@ -141,17 +159,17 @@ looks for an address of protocol family \fBPF_INET\fR or \fBPF_INET6\fR -\(em IPv4 or IPV6 addresses respectively. Successful calls of the functions return a -\fBstruct hostent\fRfor the name that was looked up. +\(em IPv4 or IPV6 addresses respectively\&. Successful calls of the functions return a +\fBstruct hostent\fRfor the name that was looked up\&. \fBNULL\fR is returned if the lookups by \fBlwres_gethostbyname()\fR or \fBlwres_gethostbyname2()\fR -fail. +fail\&. .PP Reverse lookups of addresses are performed by -\fBlwres_gethostbyaddr()\fR. +\fBlwres_gethostbyaddr()\fR\&. \fIaddr\fR is an address of length \fIlen\fR @@ -160,15 +178,15 @@ bytes and protocol family \(em \fBPF_INET\fR or -\fBPF_INET6\fR. +\fBPF_INET6\fR\&. \fBlwres_gethostbyname_r()\fR -is a thread\-safe function for forward lookups. If an error occurs, an error code is returned in -\fI*error\fR. +is a thread\-safe function for forward lookups\&. If an error occurs, an error code is returned in +\fI*error\fR\&. \fIresbuf\fR is a pointer to a \fBstruct hostent\fR which is initialised by a successful call to -\fBlwres_gethostbyname_r()\fR. +\fBlwres_gethostbyname_r()\fR\&. \fIbuf\fR is a buffer of length \fIlen\fR @@ -179,12 +197,12 @@ bytes which is used to store the elements of the \fBstruct hostent\fR returned in -\fIresbuf\fR. Successful calls to +\fIresbuf\fR\&. Successful calls to \fBlwres_gethostbyname_r()\fR return \fIresbuf\fR, which is a pointer to the \fBstruct hostent\fR -it created. +it created\&. .PP \fBlwres_gethostbyaddr_r()\fR is a thread\-safe function that performs a reverse lookup of address @@ -196,14 +214,14 @@ bytes long and is of protocol family \(em \fBPF_INET\fR or -\fBPF_INET6\fR. If an error occurs, the error code is returned in -\fI*error\fR. The other function parameters are identical to those in -\fBlwres_gethostbyname_r()\fR. +\fBPF_INET6\fR\&. If an error occurs, the error code is returned in +\fI*error\fR\&. The other function parameters are identical to those in +\fBlwres_gethostbyname_r()\fR\&. \fIresbuf\fR is a pointer to a \fBstruct hostent\fR which is initialised by a successful call to -\fBlwres_gethostbyaddr_r()\fR. +\fBlwres_gethostbyaddr_r()\fR\&. \fIbuf\fR is a buffer of length \fIlen\fR @@ -214,12 +232,12 @@ bytes which is used to store the elements of the \fBstruct hostent\fR returned in -\fIresbuf\fR. Successful calls to +\fIresbuf\fR\&. Successful calls to \fBlwres_gethostbyaddr_r()\fR return \fIresbuf\fR, which is a pointer to the \fBstruct hostent()\fR -it created. +it created\&. .SH "RETURN VALUES" .PP The functions @@ -227,39 +245,39 @@ The functions \fBlwres_gethostbyname2()\fR, \fBlwres_gethostbyaddr()\fR, and \fBlwres_gethostent()\fR -return NULL to indicate an error. In this case the global variable +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 -\fI\fR: +: .PP \fBHOST_NOT_FOUND\fR .RS 4 -The host or address was not found. +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. +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. +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. +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. +translates these error codes to suitable error messages\&. .PP \fBlwres_gethostent()\fR and \fBlwres_gethostent_r()\fR always return -\fBNULL\fR. +\fBNULL\fR\&. .PP Successful calls to \fBlwres_gethostbyname_r()\fR @@ -268,7 +286,7 @@ and return \fIresbuf\fR, a pointer to the \fBstruct hostent\fR -that was initialised by these functions. They return +that was initialised by these functions\&. They return \fBNULL\fR if the lookups fail or if \fIbuf\fR @@ -277,7 +295,7 @@ was too small to hold the list of addresses and names referenced by the \fBh_aliases\fR, and \fBh_addr_list\fR elements of the -\fBstruct hostent\fR. If +\fBstruct hostent\fR\&. If \fIbuf\fR was too small, both \fBlwres_gethostbyname_r()\fR @@ -286,7 +304,7 @@ and set the global variable \fBerrno\fR to -\fBERANGE\fR. +\fBERANGE\fR\&. .SH "SEE ALSO" .PP \fBgethostent\fR(3), @@ -299,16 +317,20 @@ to \fBlwres_gethostbyaddr()\fR and \fBlwres_endhostent()\fR -are not thread safe; they return pointers to static data and provide error codes through a global variable. Thread\-safe versions for name and address lookup are provided by +are not thread safe; they return pointers to static data and provide error codes through a global variable\&. Thread\-safe versions for name and address lookup are provided by \fBlwres_gethostbyname_r()\fR, and \fBlwres_gethostbyaddr_r()\fR -respectively. +respectively\&. .PP The resolver daemon does not currently support any non\-DNS name services such as -\fI/etc/hosts\fR +/etc/hosts or -\fBNIS\fR, consequently the above functions don't, either. +\fBNIS\fR, consequently the above functions don\*(Aqt, either\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_gethostent.docbook b/lib/lwres/man/lwres_gethostent.docbook index 487fb7f9ea..8dd999ffa3 100644 --- a/lib/lwres/man/lwres_gethostent.docbook +++ b/lib/lwres/man/lwres_gethostent.docbook @@ -1,6 +1,5 @@ -]> +]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -146,8 +148,8 @@ void - - DESCRIPTION + DESCRIPTION + These functions provide hostname-to-address and address-to-hostname lookups by means of the lightweight resolver. @@ -306,10 +308,10 @@ struct hostent { struct hostent() it created. - + - - RETURN VALUES + RETURN VALUES + The functions lwres_gethostbyname(), @@ -391,9 +393,9 @@ struct hostent { errno to ERANGE. - - - SEE ALSO + + SEE ALSO + gethostent3 , @@ -406,10 +408,10 @@ struct hostent { lwres_hstrerror3 - + - - BUGS + BUGS + lwres_gethostbyname(), lwres_gethostbyname2(), lwres_gethostbyaddr() @@ -431,9 +433,5 @@ struct hostent { NIS, consequently the above functions don't, either. - - + + diff --git a/lib/lwres/man/lwres_gethostent.html b/lib/lwres/man/lwres_gethostent.html index bc81732ff7..0eb3399416 100644 --- a/lib/lwres/man/lwres_gethostent.html +++ b/lib/lwres/man/lwres_gethostent.html @@ -14,233 +14,213 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_gethostent - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
    - +
    - - +
    struct hostent * lwres_gethostbyname(const char *  -name);const char *name);
    - +
     
    +
    - - + - - +
    struct hostent * lwres_gethostbyname2(const char *  -name, const char *name,
     int   -af);int af);
    - +
     
    +
    - - + - - + - - +
    struct hostent * lwres_gethostbyaddr(const char *  -addr, const char *addr,
     int   -len, int len,
     int   -type);int type);
    - +
     
    +
    - - +
    struct hostent * lwres_gethostent(  -);void);
    - +
     
    +
    - - +
    void lwres_sethostent(int   -stayopen);int stayopen);
    - +
     
    +
    - - +
    void lwres_endhostent(  -);void);
    - +
     
    +
    - - + - - + - - + - - + - - +
    struct hostent * lwres_gethostbyname_r(const char *  -name, const char *name,
     struct hostent *  -resbuf, struct hostent *resbuf,
     char *  -buf, char *buf,
     int   -buflen, int buflen,
     int *  -error);int *error);
    - +
     
    +
    - - + - - + - - + - - + - - + - - + - - +
    struct hostent * lwres_gethostbyaddr_r(const char *  -addr, const char *addr,
     int   -len, int len,
     int   -type, int type,
     struct hostent *  -resbuf, struct hostent *resbuf,
     char *  -buf, char *buf,
     int   -buflen, int buflen,
     int *  -error);int *error);
    - +
     
    +
    - - + - - + - - + - - +
    struct hostent * lwres_gethostent_r(struct hostent *  -resbuf, struct hostent *resbuf,
     char *  -buf, char *buf,
     int   -buflen, int buflen,
     int *  -error);int *error);
    - +
     
    +
    - - +
    void lwres_sethostent_r(int   -stayopen);int stayopen);
    - +
     
    +
    - - +
    void lwres_endhostent_r(  -);void);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    +

    + +
    +

    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 */
    @@ -252,46 +232,56 @@ struct  hostent {
     

    -

    +

    The members of this structure are:

    -
    +
    h_name
    -

    +

    +

    The official (canonical) name of the host. -

    +

    +
    h_aliases
    -

    +

    +

    A NULL-terminated array of alternate names (nicknames) for the host. -

    +

    +
    h_addrtype
    -

    +

    +

    The type of address being returned — PF_INET or PF_INET6. -

    +

    +
    h_length
    -

    +

    +

    The length of the address in bytes. -

    +

    +
    h_addr_list
    -

    +

    +

    A NULL terminated array of network addresses for the host. Host addresses are returned in network byte order. -

    +

    +

    -

    +

    For backward compatibility with very old software, h_addr is the first address in h_addr_list.

    -

    lwres_gethostent(), +

    lwres_gethostent(), lwres_sethostent(), lwres_endhostent(), lwres_gethostent_r(), @@ -305,7 +295,8 @@ struct hostent { these functions; it only provides them as stub functions that always return failure.

    -

    lwres_gethostbyname() + +

    lwres_gethostbyname() and lwres_gethostbyname2() look up the hostname name. lwres_gethostbyname() always looks for an @@ -319,7 +310,8 @@ struct hostent { lwres_gethostbyname() or lwres_gethostbyname2() fail.

    -

    + +

    Reverse lookups of addresses are performed by lwres_gethostbyaddr(). addr is an address of length @@ -342,7 +334,8 @@ struct hostent { return resbuf, which is a pointer to the struct hostent it created.

    -

    lwres_gethostbyaddr_r() + +

    lwres_gethostbyaddr_r() is a thread-safe function that performs a reverse lookup of address addr which is len bytes long and is of @@ -364,10 +357,13 @@ struct hostent { resbuf, which is a pointer to the struct hostent() it created.

    -
    -
    -

    RETURN VALUES

    -

    + +

    + +
    +

    RETURN VALUES

    + +

    The functions lwres_gethostbyname(), lwres_gethostbyname2(), @@ -380,39 +376,52 @@ struct hostent { <lwres/netdb.h>:

    -
    +
    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 @@ -428,19 +437,29 @@ struct hostent { variable errno to ERANGE.

    -
    -
    -

    SEE ALSO

    -

    gethostent(3), - lwres_getipnode(3), +

    +
    +

    SEE ALSO

    + +

    + gethostent(3) + , - lwres_hstrerror(3) + + lwres_getipnode(3) + , + + + lwres_hstrerror(3) +

    -
    -
    -

    BUGS

    -

    lwres_gethostbyname(), +

    + +
    +

    BUGS

    + +

    lwres_gethostbyname(), lwres_gethostbyname2(), lwres_gethostbyaddr() and @@ -453,7 +472,7 @@ struct hostent { lwres_gethostbyaddr_r() respectively.

    -

    +

    The resolver daemon does not currently support any non-DNS name services such as /etc/hosts @@ -461,6 +480,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 4eb58cc2b1..1dcfdade34 100644 --- a/lib/lwres/man/lwres_getipnode.3 +++ b/lib/lwres/man/lwres_getipnode.3 @@ -13,44 +13,61 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_getipnode .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_GETIPNODE" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_GETIPNODE" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres_getipnodebyname, lwres_getipnodebyaddr, lwres_freehostent \- lightweight resolver nodename / address translation API .SH "SYNOPSIS" .nf -#include +#include .fi -.HP 39 +.HP \w'struct\ hostent\ *\ lwres_getipnodebyname('u .BI "struct hostent * lwres_getipnodebyname(const\ char\ *" "name" ", int\ " "af" ", int\ " "flags" ", int\ *" "error_num" ");" -.HP 39 +.HP \w'struct\ hostent\ *\ lwres_getipnodebyaddr('u .BI "struct hostent * lwres_getipnodebyaddr(const\ void\ *" "src" ", size_t\ " "len" ", int\ " "af" ", int\ *" "error_num" ");" -.HP 23 +.HP \w'void\ lwres_freehostent('u .BI "void lwres_freehostent(struct\ hostent\ *" "he" ");" .SH "DESCRIPTION" .PP -These functions perform thread safe, protocol independent nodename\-to\-address and address\-to\-nodename translation as defined in RFC2553. +These functions perform thread safe, protocol independent nodename\-to\-address and address\-to\-nodename translation as defined in RFC2553\&. .PP They use a \fBstruct hostent\fR which is defined in -\fInamedb.h\fR: +namedb\&.h: .PP +.if n \{\ .RS 4 +.\} .nf struct hostent { char *h_name; /* official name of host */ @@ -61,19 +78,20 @@ struct hostent { }; #define h_addr h_addr_list[0] /* address, for backward compatibility */ .fi +.if n \{\ .RE -.sp +.\} .PP The members of this structure are: .PP \fBh_name\fR .RS 4 -The official (canonical) name of the host. +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. +A NULL\-terminated array of alternate names (nicknames) for the host\&. .RE .PP \fBh_addrtype\fR @@ -81,46 +99,46 @@ A NULL\-terminated array of alternate names (nicknames) for the host. The type of address being returned \- usually \fBPF_INET\fR or -\fBPF_INET6\fR. +\fBPF_INET6\fR\&. .RE .PP \fBh_length\fR .RS 4 -The length of the address in bytes. +The length of the address in bytes\&. .RE .PP \fBh_addr_list\fR .RS 4 A \fBNULL\fR -terminated array of network addresses for the host. Host addresses are returned in network byte order. +terminated array of network addresses for the host\&. Host addresses are returned in network byte order\&. .RE .PP \fBlwres_getipnodebyname()\fR looks up addresses of protocol family \fIaf\fR for the hostname -\fIname\fR. The +\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: +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 \fBAI_V4MAPPED\fR .RS 4 This is used with an \fIaf\fR -of AF_INET6, and causes IPv4 addresses to be returned as IPv4\-mapped IPv6 addresses. +of AF_INET6, and causes IPv4 addresses to be returned as IPv4\-mapped IPv6 addresses\&. .RE .PP \fBAI_ALL\fR .RS 4 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. +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 \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. +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 @@ -129,7 +147,7 @@ This default sets the \fBAI_V4MAPPED\fR and \fBAI_ADDRCONFIG\fR -flag bits. +flag bits\&. .RE .PP \fBlwres_getipnodebyaddr()\fR @@ -137,25 +155,25 @@ performs a reverse lookup of address \fIsrc\fR which is \fIlen\fR -bytes long. +bytes long\&. \fIaf\fR denotes the protocol family, typically \fBPF_INET\fR or -\fBPF_INET6\fR. +\fBPF_INET6\fR\&. .PP \fBlwres_freehostent()\fR releases all the memory associated with the \fBstruct hostent\fR pointer -\fIhe\fR. Any memory allocated for the +\fIhe\fR\&. Any memory allocated for the \fBh_name\fR, \fBh_addr_list\fR and \fBh_aliases\fR is freed, as is the memory for the \fBhostent\fR -structure itself. +structure itself\&. .SH "RETURN VALUES" .PP If an error occurs, @@ -166,31 +184,31 @@ set \fI*error_num\fR to an appropriate error code and the function returns a \fBNULL\fR -pointer. The error codes and their meanings are defined in -\fI\fR: +pointer\&. The error codes and their meanings are defined in +: .PP \fBHOST_NOT_FOUND\fR .RS 4 -No such host is known. +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. +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. +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. +An unexpected failure occurred, and retrying the request is pointless\&. .RE .PP \fBlwres_hstrerror\fR(3) -translates these error codes to suitable error messages. +translates these error codes to suitable error messages\&. .SH "SEE ALSO" .PP \fBRFC2553\fR(), @@ -198,8 +216,12 @@ translates these error codes to suitable error messages. \fBlwres_gethostent\fR(3), \fBlwres_getaddrinfo\fR(3), \fBlwres_getnameinfo\fR(3), -\fBlwres_hstrerror\fR(3). +\fBlwres_hstrerror\fR(3)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001, 2003 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_getipnode.docbook b/lib/lwres/man/lwres_getipnode.docbook index 44b628b558..06e358ccdf 100644 --- a/lib/lwres/man/lwres_getipnode.docbook +++ b/lib/lwres/man/lwres_getipnode.docbook @@ -1,6 +1,3 @@ -]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -82,8 +82,8 @@ void - - DESCRIPTION + DESCRIPTION + These functions perform thread safe, protocol independent @@ -236,9 +236,9 @@ struct hostent { h_aliases is freed, as is the memory for the hostent structure itself. - - - RETURN VALUES + + RETURN VALUES + If an error occurs, lwres_getipnodebyname() @@ -296,9 +296,9 @@ struct hostent { translates these error codes to suitable error messages. - - - SEE ALSO + + SEE ALSO + RFC2553 , @@ -323,9 +323,5 @@ struct hostent { lwres_hstrerror3 . - - + + diff --git a/lib/lwres/man/lwres_getipnode.html b/lib/lwres/man/lwres_getipnode.html index f3aeef3b30..5e7f15a38b 100644 --- a/lib/lwres/man/lwres_getipnode.html +++ b/lib/lwres/man/lwres_getipnode.html @@ -14,103 +14,103 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_getipnode - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
    - +
    - - + - - + - - + - - +
    struct hostent * lwres_getipnodebyname(const char *  -name, const char *name,
     int   -af, int af,
     int   -flags, int flags,
     int *  -error_num);int *error_num);
    - +
     
    +
    - - + - - + - - + - - +
    struct hostent * lwres_getipnodebyaddr(const void *  -src, const void *src,
     size_t   -len, size_t len,
     int   -af, int af,
     int *  -error_num);int *error_num);
    - +
     
    +
    - - +
    void lwres_freehostent(struct hostent *  -he);struct hostent *he);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    +

    + +
    +

    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 */
    @@ -122,42 +122,54 @@ struct  hostent {
     

    -

    + +

    The members of this structure are:

    -
    +
    h_name
    -

    +

    +

    The official (canonical) name of the host. -

    +

    +
    h_aliases
    -

    +

    +

    A NULL-terminated array of alternate names (nicknames) for the host. -

    +

    +
    h_addrtype
    -

    +

    +

    The type of address being returned - usually PF_INET or PF_INET6. -

    +

    +
    h_length
    -

    +

    +

    The length of the address in bytes. -

    +

    +
    h_addr_list
    -

    +

    +

    A NULL terminated array of network addresses for the host. Host addresses are returned in network byte order. -

    +

    +

    -

    lwres_getipnodebyname() + +

    lwres_getipnodebyname() looks up addresses of protocol family af for the hostname name. The flags parameter contains ORed flag bits @@ -165,17 +177,20 @@ struct hostent { types of addresses that are returned. The flag bits are:

    -
    +
    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 @@ -183,31 +198,37 @@ struct hostent { If AI_V4MAPPED is also set, the IPv4 addresses are return as mapped IPv6 addresses. -

    +

    +
    AI_ADDRCONFIG
    -

    +

    +

    Only return an IPv6 or IPv4 address if here is an active network interface of that type. This is not currently implemented in the BIND 9 lightweight resolver, and the flag is ignored. -

    +

    +
    AI_DEFAULT
    -

    +

    +

    This default sets the AI_V4MAPPED and AI_ADDRCONFIG flag bits. -

    +

    +

    -

    lwres_getipnodebyaddr() + +

    lwres_getipnodebyaddr() performs a reverse lookup of address src which is len bytes long. af denotes the protocol family, typically PF_INET or PF_INET6.

    -

    lwres_freehostent() +

    lwres_freehostent() releases all the memory associated with the struct hostent pointer he. Any memory allocated for the h_name, @@ -215,10 +236,11 @@ struct hostent { h_aliases is freed, as is the memory for the hostent structure itself.

    -
    -
    -

    RETURN VALUES

    -

    +

    +
    +

    RETURN VALUES

    + +

    If an error occurs, lwres_getipnodebyname() and @@ -231,49 +253,72 @@ struct hostent { The error codes and their meanings are defined in <lwres/netdb.h>:

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

    +
    +

    SEE ALSO

    + +

    + 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 993b172144..d2584f4977 100644 --- a/lib/lwres/man/lwres_getnameinfo.3 +++ b/lib/lwres/man/lwres_getnameinfo.3 @@ -13,57 +13,71 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_getnameinfo .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_GETNAMEINFO" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_GETNAMEINFO" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres_getnameinfo \- lightweight resolver socket address structure to hostname and service name .SH "SYNOPSIS" .nf -#include +#include .fi -.HP 22 +.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 This function is equivalent to the \fBgetnameinfo\fR(3) -function defined in RFC2133. +function defined in RFC2133\&. \fBlwres_getnameinfo()\fR returns the hostname for the -\fBstruct sockaddr\fR -\fIsa\fR +\fBstruct sockaddr\fR\fIsa\fR which is \fIsalen\fR -bytes long. The hostname is of length +bytes long\&. The hostname is of length \fIhostlen\fR and is returned via -\fI*host.\fR +\fI*host\&.\fR The maximum length of the hostname is 1025 bytes: -\fBNI_MAXHOST\fR. +\fBNI_MAXHOST\fR\&. .PP The name of the service associated with the port number in \fIsa\fR is returned in -\fI*serv.\fR +\fI*serv\&.\fR It is \fIservlen\fR -bytes long. The maximum length of the service name is +bytes long\&. The maximum length of the service name is \fBNI_MAXSERV\fR -\- 32 bytes. +\- 32 bytes\&. .PP The \fIflags\fR @@ -71,46 +85,50 @@ argument sets the following bits: .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. +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. +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. +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. +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. +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. +returns 0 on success or a non\-zero error code if an error occurs\&. .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). +\fBlwres_getnamebyaddr\fR(3)\&. +\fBlwres_net_ntop\fR(3)\&. .SH "BUGS" .PP RFC2133 fails to define what the nonzero return values of \fBgetnameinfo\fR(3) -are. +are\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_getnameinfo.docbook b/lib/lwres/man/lwres_getnameinfo.docbook index 34a72cb884..92fd66f0b6 100644 --- a/lib/lwres/man/lwres_getnameinfo.docbook +++ b/lib/lwres/man/lwres_getnameinfo.docbook @@ -1,6 +1,3 @@ -]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -69,8 +69,8 @@ int - - DESCRIPTION + DESCRIPTION + This function is equivalent to the @@ -158,16 +158,16 @@ int - + - - RETURN VALUES + RETURN VALUES + lwres_getnameinfo() returns 0 on success or a non-zero error code if an error occurs. - - - SEE ALSO + + SEE ALSO + RFC2133 , @@ -187,9 +187,9 @@ int lwres_net_ntop3 . - - - BUGS + + BUGS + RFC2133 fails to define what the nonzero return values of @@ -197,9 +197,5 @@ int are. - - + + diff --git a/lib/lwres/man/lwres_getnameinfo.html b/lib/lwres/man/lwres_getnameinfo.html index 72efdfc206..5eb8b7ce4a 100644 --- a/lib/lwres/man/lwres_getnameinfo.html +++ b/lib/lwres/man/lwres_getnameinfo.html @@ -14,78 +14,79 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_getnameinfo - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
    - +
    - - + - - + - - + - - + - - + - - + - - +
    int lwres_getnameinfo(const struct sockaddr *  -sa, const struct sockaddr *sa,
     size_t   -salen, size_t salen,
     char *  -host, char *host,
     size_t   -hostlen, size_t hostlen,
     char *  -serv, char *serv,
     size_t   -servlen, size_t servlen,
     int   -flags);int flags);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    +

    + +
    +

    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 @@ -97,45 +98,56 @@ int hostname is 1025 bytes: NI_MAXHOST.

    -

    The name of the service associated with the port number in + +

    The name of the service associated with the port number in sa is returned in *serv. It is servlen bytes long. The maximum length of the service name is NI_MAXSERV - 32 bytes.

    -

    + +

    The flags argument sets the following bits:

    -
    +
    NI_NOFQDN
    -

    +

    +

    A fully qualified domain name is not required for local hosts. The local part of the fully qualified domain name is returned instead. -

    +

    +
    NI_NUMERICHOST
    -

    +

    +

    Return the address in numeric form, as if calling inet_ntop(), instead of a host name. -

    +

    +
    NI_NAMEREQD
    -

    +

    +

    A name is required. If the hostname cannot be found in the DNS and this flag is set, a non-zero error code is returned. If the hostname is not found and the flag is not set, the address is returned in numeric form. -

    +

    +
    NI_NUMERICSERV
    -

    +

    +

    The service name is returned as a digit string representing the port number. -

    +

    +
    NI_DGRAM
    -

    +

    +

    Specifies that the service being looked up is a datagram service, and causes getservbyport() to be called with a second argument of "udp" instead of its default of "tcp". This is @@ -143,34 +155,53 @@ int for the few ports (512-514) that have different services for UDP and TCP. -

    +

    +

    -
    -
    -

    RETURN VALUES

    -

    lwres_getnameinfo() +

    + +
    +

    RETURN VALUES

    + +

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

    +
    +

    SEE ALSO

    + +

    + RFC2133 + , + + getservbyport(3) + , + + lwres(3) + , + + lwres_getnameinfo(3) + , + + lwres_getnamebyaddr(3) + . + + lwres_net_ntop(3) + .

    -
    -
    -

    BUGS

    -

    +

    +
    +

    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 6397a6e0fe..a89a051229 100644 --- a/lib/lwres/man/lwres_getrrsetbyname.3 +++ b/lib/lwres/man/lwres_getrrsetbyname.3 @@ -13,49 +13,60 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_getrrsetbyname .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_GETRRSETBYNAME" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_GETRRSETBYNAME" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres_getrrsetbyname, lwres_freerrset \- retrieve DNS records .SH "SYNOPSIS" .nf -#include +#include .fi -.HP 25 +.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 21 +.HP \w'void\ lwres_freerrset('u .BI "void lwres_freerrset(struct\ rrsetinfo\ *" "rrset" ");" .PP The following structures are used: .PP -.RS 4 .nf struct rdatainfo { unsigned int rdi_length; /* length of data */ unsigned char *rdi_data; /* record data */ }; .fi -.RE -.sp .PP -.RS 4 .nf struct rrsetinfo { - unsigned int rri_flags; /* RRSET_VALIDATED... */ + unsigned int rri_flags; /* RRSET_VALIDATED\&.\&.\&. */ unsigned int rri_rdclass; /* class number */ unsigned int rri_rdtype; /* RR type number */ unsigned int rri_ttl; /* time to live */ @@ -66,7 +77,6 @@ struct rrsetinfo { struct rdatainfo *rri_sigs; /* individual signatures */ }; .fi -.RE .sp .SH "DESCRIPTION" .PP @@ -74,11 +84,11 @@ struct rrsetinfo { gets a set of resource records associated with a \fIhostname\fR, \fIclass\fR, and -\fItype\fR. +\fItype\fR\&. \fIhostname\fR -is a pointer a to null\-terminated string. The +is a pointer a to null\-terminated string\&. The \fIflags\fR -field is currently unused and must be zero. +field is currently unused and must be zero\&. .PP After a successful call to \fBlwres_getrrsetbyname()\fR, @@ -89,21 +99,21 @@ structure, containing a list of one or more \fBrdatainfo\fR structures containing resource records and potentially another list of \fBrdatainfo\fR -structures containing SIG resource records associated with those records. The members +structures containing SIG resource records associated with those records\&. The members \fBrri_rdclass\fR and \fBrri_rdtype\fR -are copied from the parameters. +are copied from the parameters\&. \fBrri_ttl\fR and \fBrri_name\fR -are properties of the obtained rrset. The resource records contained in +are properties of the obtained rrset\&. The resource records contained in \fBrri_rdatas\fR and \fBrri_sigs\fR -are in uncompressed DNS wire format. Properties of the rdataset are represented in the +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. +bitfield\&. If the RRSET_VALIDATED bit is set, the data has been DNSSEC validated and the signatures verified\&. .PP All of the information returned by \fBlwres_getrrsetbyname()\fR @@ -112,15 +122,15 @@ is dynamically allocated: the and \fBrdatainfo\fR structures, and the canonical host name strings pointed to by the -\fBrrsetinfo\fRstructure. Memory allocated for the dynamically allocated structures created by a successful call to +\fBrrsetinfo\fRstructure\&. Memory allocated for the dynamically allocated structures created by a successful call to \fBlwres_getrrsetbyname()\fR is released by -\fBlwres_freerrset()\fR. +\fBlwres_freerrset()\fR\&. \fIrrset\fR is a pointer to a \fBstruct rrset\fR created by a call to -\fBlwres_getrrsetbyname()\fR. +\fBlwres_getrrsetbyname()\fR\&. .PP .SH "RETURN VALUES" .PP @@ -156,8 +166,12 @@ other failure .RE .SH "SEE ALSO" .PP -\fBlwres\fR(3). +\fBlwres\fR(3)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_getrrsetbyname.docbook b/lib/lwres/man/lwres_getrrsetbyname.docbook index aceb5a1f9f..0cea4f6951 100644 --- a/lib/lwres/man/lwres_getrrsetbyname.docbook +++ b/lib/lwres/man/lwres_getrrsetbyname.docbook @@ -1,6 +1,3 @@ -]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -97,8 +97,8 @@ struct rrsetinfo { - - DESCRIPTION + DESCRIPTION + lwres_getrrsetbyname() gets a set of resource records associated with a hostname, class, @@ -143,10 +143,10 @@ struct rrsetinfo { rrset created by a call to lwres_getrrsetbyname(). - - - - RETURN VALUES + + + RETURN VALUES + lwres_getrrsetbyname() returns zero on success, and one of the following error codes if an error occurred: @@ -200,24 +200,20 @@ struct rrsetinfo { - + - - - SEE ALSO + + SEE ALSO + lwres3 . - - + + diff --git a/lib/lwres/man/lwres_getrrsetbyname.html b/lib/lwres/man/lwres_getrrsetbyname.html index 6865feae23..9147668596 100644 --- a/lib/lwres/man/lwres_getrrsetbyname.html +++ b/lib/lwres/man/lwres_getrrsetbyname.html @@ -14,70 +14,71 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_getrrsetbyname - + -
    -
    -
    +
    +
    + + + + + + + +

    Name

    -

    lwres_getrrsetbyname, lwres_freerrset — retrieve DNS records

    +

    + lwres_getrrsetbyname, + lwres_freerrset + — retrieve DNS records +

    -
    +

    Synopsis

    -
    +
    #include <lwres/netdb.h>
    - +
    - - + - - + - - + - - + - - +
    int lwres_getrrsetbyname(const char *  -hostname, const char *hostname,
     unsigned int   -rdclass, unsigned int rdclass,
     unsigned int   -rdtype, unsigned int rdtype,
     unsigned int   -flags, unsigned int flags,
     struct rrsetinfo **  -res);struct rrsetinfo **res);
    - +
     
    +
    - - +
    void lwres_freerrset(struct rrsetinfo *  -rrset);struct rrsetinfo *rrset);
    +
     
    -

    + +

    The following structures are used:

    -
    +    
     struct  rdatainfo {
             unsigned int            rdi_length;     /* length of data */
             unsigned char           *rdi_data;      /* record data */
    @@ -85,7 +86,7 @@ struct  rdatainfo {
     

    -
    +    
     struct  rrsetinfo {
             unsigned int            rri_flags;      /* RRSET_VALIDATED... */
             unsigned int            rri_rdclass;    /* class number */
    @@ -100,10 +101,12 @@ struct  rrsetinfo {
     

    -
    -
    -

    DESCRIPTION

    -

    lwres_getrrsetbyname() +

    + +
    +

    DESCRIPTION

    + +

    lwres_getrrsetbyname() gets a set of resource records associated with a hostname, class, and type. @@ -111,7 +114,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 @@ -130,7 +133,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 @@ -147,46 +150,63 @@ struct rrsetinfo { rrset created by a call to lwres_getrrsetbyname().

    -

    -
    -
    -

    RETURN VALUES

    -

    lwres_getrrsetbyname() +

    +
    +
    +

    RETURN VALUES

    + +

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

    +
    +

    SEE ALSO

    + +

    + lwres(3) + .

    -
    + +
    diff --git a/lib/lwres/man/lwres_gnba.3 b/lib/lwres/man/lwres_gnba.3 index 5c64f07142..0e67fae923 100644 --- a/lib/lwres/man/lwres_gnba.3 +++ b/lib/lwres/man/lwres_gnba.3 @@ -13,71 +13,94 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_gnba .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_GNBA" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_GNBA" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .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" .nf -#include +#include .fi -.HP 40 +.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 41 +.HP \w'lwres_result_t\ lwres_gnbaresponse_render('u .BI "lwres_result_t lwres_gnbaresponse_render(lwres_context_t\ *" "ctx" ", lwres_gnbaresponse_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");" -.HP 39 +.HP \w'lwres_result_t\ lwres_gnbarequest_parse('u .BI "lwres_result_t lwres_gnbarequest_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_gnbarequest_t\ **" "structp" ");" -.HP 40 +.HP \w'lwres_result_t\ lwres_gnbaresponse_parse('u .BI "lwres_result_t lwres_gnbaresponse_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_gnbaresponse_t\ **" "structp" ");" -.HP 29 +.HP \w'void\ lwres_gnbaresponse_free('u .BI "void lwres_gnbaresponse_free(lwres_context_t\ *" "ctx" ", lwres_gnbaresponse_t\ **" "structp" ");" -.HP 28 +.HP \w'void\ lwres_gnbarequest_free('u .BI "void lwres_gnbarequest_free(lwres_context_t\ *" "ctx" ", lwres_gnbarequest_t\ **" "structp" ");" .SH "DESCRIPTION" .PP -These are low\-level routines for creating and parsing lightweight resolver address\-to\-name lookup request and response messages. +These are low\-level routines for creating and parsing lightweight resolver address\-to\-name lookup request and response messages\&. .PP -There are four main functions for the getnamebyaddr opcode. One render function converts a getnamebyaddr request structure \(em +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's 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 +\(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. +to the canonical format\&. This is complemented by a parse function which converts a packet in canonical format to a getnamebyaddr response structure\&. .PP These structures are defined in -\fIlwres/lwres.h\fR. They are shown below. +lwres/lwres\&.h\&. They are shown below\&. .PP +.if n \{\ .RS 4 +.\} .nf #define LWRES_OPCODE_GETNAMEBYADDR 0x00010002U .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf typedef struct { lwres_uint32_t flags; lwres_addr_t addr; } lwres_gnbarequest_t; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf typedef struct { lwres_uint32_t flags; @@ -90,24 +113,25 @@ typedef struct { size_t baselen; } lwres_gnbaresponse_t; .fi +.if n \{\ .RE -.sp +.\} .PP \fBlwres_gnbarequest_render()\fR uses resolver context \fIctx\fR to convert getnamebyaddr request structure \fIreq\fR -to canonical format. The packet header structure +to canonical format\&. The packet header structure \fIpkt\fR is initialised and transferred to buffer -\fIb\fR. The contents of +\fIb\fR\&. The contents of \fI*req\fR -are then appended to the buffer in canonical format. +are then appended to the buffer in canonical format\&. \fBlwres_gnbaresponse_render()\fR performs the same task, except it converts a getnamebyaddr response structure \fBlwres_gnbaresponse_t\fR -to the lightweight resolver's canonical format. +to the lightweight resolver\*(Aqs canonical format\&. .PP \fBlwres_gnbarequest_parse()\fR uses context @@ -116,18 +140,18 @@ to convert the contents of packet \fIpkt\fR to a \fBlwres_gnbarequest_t\fR -structure. Buffer +structure\&. Buffer \fIb\fR -provides space to be used for storing this structure. When the function succeeds, the resulting +provides space to be used for storing this structure\&. When the function succeeds, the resulting \fBlwres_gnbarequest_t\fR is made available through -\fI*structp\fR. +\fI*structp\fR\&. \fBlwres_gnbaresponse_parse()\fR offers the same semantics as \fBlwres_gnbarequest_parse()\fR except it yields a \fBlwres_gnbaresponse_t\fR -structure. +structure\&. .PP \fBlwres_gnbaresponse_free()\fR and @@ -139,20 +163,19 @@ that was allocated to the or \fBlwres_gnbarequest_t\fR structures referenced via -\fIstructp\fR. Any memory associated with ancillary buffers and strings for those structures is also discarded. +\fIstructp\fR\&. Any memory associated with ancillary buffers and strings for those structures is also discarded\&. .SH "RETURN VALUES" .PP The getnamebyaddr opcode functions \fBlwres_gnbarequest_render()\fR, -\fBlwres_gnbaresponse_render()\fR -\fBlwres_gnbarequest_parse()\fR +\fBlwres_gnbaresponse_render()\fR\fBlwres_gnbarequest_parse()\fR and \fBlwres_gnbaresponse_parse()\fR all return \fBLWRES_R_SUCCESS\fR -on success. They return +on success\&. They return \fBLWRES_R_NOMEMORY\fR -if memory allocation fails. +if memory allocation fails\&. \fBLWRES_R_UNEXPECTEDEND\fR is returned if the available space in the buffer \fIb\fR @@ -160,23 +183,27 @@ is too small to accommodate the packet header or the \fBlwres_gnbarequest_t\fR and \fBlwres_gnbaresponse_t\fR -structures. +structures\&. \fBlwres_gnbarequest_parse()\fR and \fBlwres_gnbaresponse_parse()\fR will return \fBLWRES_R_UNEXPECTEDEND\fR -if the buffer is not empty after decoding the received packet. These functions will return +if the buffer is not empty after decoding the received packet\&. These functions will return \fBLWRES_R_FAILURE\fR if -pktflags +\fIpktflags\fR in the packet header structure \fBlwres_lwpacket_t\fR -indicate that the packet is not a response to an earlier query. +indicate that the packet is not a response to an earlier query\&. .SH "SEE ALSO" .PP -\fBlwres_packet\fR(3). +\fBlwres_packet\fR(3)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_gnba.docbook b/lib/lwres/man/lwres_gnba.docbook index ebb7487b03..098ec2bbc1 100644 --- a/lib/lwres/man/lwres_gnba.docbook +++ b/lib/lwres/man/lwres_gnba.docbook @@ -1,6 +1,5 @@ -]> +]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -121,8 +123,8 @@ void - - DESCRIPTION + DESCRIPTION + These are low-level routines for creating and parsing lightweight resolver address-to-name lookup request and @@ -207,10 +209,10 @@ typedef struct { ancillary buffers and strings for those structures is also discarded. - + - - RETURN VALUES + RETURN VALUES + The getnamebyaddr opcode functions lwres_gnbarequest_render(), @@ -241,21 +243,17 @@ typedef struct { These functions will return LWRES_R_FAILURE if - pktflags + pktflags in the packet header structure lwres_lwpacket_t indicate that the packet is not a response to an earlier query. - - - SEE ALSO + + SEE ALSO + lwres_packet3 . - - + + diff --git a/lib/lwres/man/lwres_gnba.html b/lib/lwres/man/lwres_gnba.html index d6b7c27c74..c5ee7f9852 100644 --- a/lib/lwres/man/lwres_gnba.html +++ b/lib/lwres/man/lwres_gnba.html @@ -14,182 +14,170 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_gnba - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
     
    - + +
    - - + - - + - - + - - +
    lwres_result_t lwres_gnbarequest_render (lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_gnbarequest_t *  -req, lwres_gnbarequest_t *req,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    + +
    - - + - - + - - + - - +
    lwres_result_t lwres_gnbaresponse_render (lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_gnbaresponse_t *  -req, lwres_gnbaresponse_t *req,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    +
    - - + - - + - - + - - +
    lwres_result_t lwres_gnbarequest_parse(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_gnbarequest_t **  -structp);lwres_gnbarequest_t **structp);
    - +
     
    +
    - - + - - + - - + - - +
    lwres_result_t lwres_gnbaresponse_parse(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_gnbaresponse_t **  -structp);lwres_gnbaresponse_t **structp);
    - +
     
    + +
    - - + - - +
    void lwres_gnbaresponse_free (lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_gnbaresponse_t **  -structp);lwres_gnbaresponse_t **structp);
    - +
     
    +
    - - + - - +
    void lwres_gnbarequest_free(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_gnbarequest_t **  -structp);lwres_gnbarequest_t **structp);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    + +

    + +
    +

    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 — @@ -203,17 +191,17 @@ void This is complemented by a parse function which converts a packet in canonical format to a getnamebyaddr response structure.

    -

    +

    These structures are defined in lwres/lwres.h. They are shown below.

    -
    +    
     #define LWRES_OPCODE_GETNAMEBYADDR      0x00010002U
     

    -
    +    
     typedef struct {
             lwres_uint32_t  flags;
             lwres_addr_t    addr;
    @@ -221,7 +209,7 @@ typedef struct {
     

    -
    +    
     typedef struct {
             lwres_uint32_t  flags;
             lwres_uint16_t  naliases;
    @@ -235,7 +223,8 @@ typedef struct {
     

    -

    lwres_gnbarequest_render() + +

    lwres_gnbarequest_render() uses resolver context ctx to convert getnamebyaddr request structure req to canonical format. The packet header structure @@ -247,7 +236,8 @@ typedef struct { lwres_gnbaresponse_t to the lightweight resolver's canonical format.

    -

    lwres_gnbarequest_parse() + +

    lwres_gnbarequest_parse() uses context ctx to convert the contents of packet pkt to a lwres_gnbarequest_t structure. Buffer @@ -259,7 +249,8 @@ typedef struct { semantics as lwres_gnbarequest_parse() except it yields a lwres_gnbaresponse_t structure.

    -

    lwres_gnbaresponse_free() + +

    lwres_gnbaresponse_free() and lwres_gnbarequest_free() release the memory in resolver context ctx that was allocated to the lwres_gnbaresponse_t or @@ -268,10 +259,12 @@ typedef struct { ancillary buffers and strings for those structures is also discarded.

    -
    -
    -

    RETURN VALUES

    -

    +

    + +
    +

    RETURN VALUES

    + +

    The getnamebyaddr opcode functions lwres_gnbarequest_render(), lwres_gnbaresponse_render() @@ -301,16 +294,19 @@ typedef struct { These functions will return LWRES_R_FAILURE if - pktflags + pktflags in the packet header structure lwres_lwpacket_t indicate that the packet is not a response to an earlier query.

    -
    -
    -

    SEE ALSO

    -

    lwres_packet(3). +

    +
    +

    SEE ALSO

    + +

    + lwres_packet(3) + .

    -
    +
    diff --git a/lib/lwres/man/lwres_hstrerror.3 b/lib/lwres/man/lwres_hstrerror.3 index a8fa9788b4..dc0b3288b7 100644 --- a/lib/lwres/man/lwres_hstrerror.3 +++ b/lib/lwres/man/lwres_hstrerror.3 @@ -13,31 +13,46 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_hstrerror .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_HSTRERROR" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_HSTRERROR" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres_herror, lwres_hstrerror \- lightweight resolver error message generation .SH "SYNOPSIS" .nf -#include +#include .fi -.HP 18 +.HP \w'void\ lwres_herror('u .BI "void lwres_herror(const\ char\ *" "s" ");" -.HP 29 +.HP \w'const\ char\ *\ lwres_hstrerror('u .BI "const char * lwres_hstrerror(int\ " "err" ");" .SH "DESCRIPTION" .PP @@ -49,11 +64,11 @@ on followed by the string generated by \fBlwres_hstrerror()\fR for the error code stored in the global variable -\fBlwres_h_errno\fR. +\fBlwres_h_errno\fR\&. .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: +\fIerr\fR\&. The values of the error codes and messages are as follows: .PP \fBNETDB_SUCCESS\fR .RS 4 @@ -87,12 +102,16 @@ is returned by \fBlwres_hstrerror()\fR when the value of \fBlwres_h_errno\fR -is not a valid error code. +is not a valid error code\&. .SH "SEE ALSO" .PP \fBherror\fR(3), -\fBlwres_hstrerror\fR(3). +\fBlwres_hstrerror\fR(3)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_hstrerror.docbook b/lib/lwres/man/lwres_hstrerror.docbook index d091b347da..0786194046 100644 --- a/lib/lwres/man/lwres_hstrerror.docbook +++ b/lib/lwres/man/lwres_hstrerror.docbook @@ -1,6 +1,3 @@ -]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -68,8 +68,8 @@ const char * - - DESCRIPTION + DESCRIPTION + lwres_herror() prints the string s on @@ -121,10 +121,10 @@ const char * - + - - RETURN VALUES + RETURN VALUES + The string Unknown resolver error is returned by lwres_hstrerror() @@ -132,9 +132,9 @@ const char * lwres_h_errno is not a valid error code. - - - SEE ALSO + + SEE ALSO + herror3 , @@ -144,9 +144,5 @@ const char * . - - + + diff --git a/lib/lwres/man/lwres_hstrerror.html b/lib/lwres/man/lwres_hstrerror.html index 39713fb413..ac89c5de06 100644 --- a/lib/lwres/man/lwres_hstrerror.html +++ b/lib/lwres/man/lwres_hstrerror.html @@ -14,91 +14,121 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_hstrerror - + -
    -
    -
    +
    +
    + + + + + + + +

    Name

    -

    lwres_herror, lwres_hstrerror — lightweight resolver error message generation

    +

    + lwres_herror, + lwres_hstrerror + — lightweight resolver error message generation +

    -
    +

    Synopsis

    -
    +
    #include <lwres/netdb.h>
    - +
    - - +
    void lwres_herror(const char *  -s);const char *s);
    - +
     
    +
    - - +
    const char * lwres_hstrerror(int   -err);int err);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    lwres_herror() +

    + +
    +

    DESCRIPTION

    + + +

    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:

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

    -

    +

    + +
    +

    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), +

    +
    +

    SEE ALSO

    + +

    + 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 c27b25e3d5..ac4d2cc6c5 100644 --- a/lib/lwres/man/lwres_inetntop.3 +++ b/lib/lwres/man/lwres_inetntop.3 @@ -13,29 +13,44 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_inetntop .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_INETNTOP" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_INETNTOP" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres_net_ntop \- lightweight resolver IP address presentation .SH "SYNOPSIS" .nf -#include +#include .fi -.HP 28 +.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 @@ -44,17 +59,17 @@ 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. +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 The generated string is copied to \fIdst\fR provided \fIsize\fR -indicates it is long enough to store the ASCII representation of the address. +indicates it is long enough to store the ASCII representation of the address\&. .SH "RETURN VALUES" .PP If successful, the function returns -\fIdst\fR: a pointer to a string containing the presentation format of the address. +\fIdst\fR: a pointer to a string containing the presentation format of the address\&. \fBlwres_net_ntop()\fR returns \fBNULL\fR @@ -64,13 +79,17 @@ to \fBEAFNOSUPPORT\fR if the protocol family given in \fIaf\fR -is not supported. +is not supported\&. .SH "SEE ALSO" .PP \fBRFC1884\fR(), \fBinet_ntop\fR(3), -\fBerrno\fR(3). +\fBerrno\fR(3)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_inetntop.docbook b/lib/lwres/man/lwres_inetntop.docbook index b2d170f297..6bc33cd063 100644 --- a/lib/lwres/man/lwres_inetntop.docbook +++ b/lib/lwres/man/lwres_inetntop.docbook @@ -1,6 +1,5 @@ -]> +]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -64,8 +66,8 @@ const char * - - DESCRIPTION + DESCRIPTION + lwres_net_ntop() converts an IP address of protocol family @@ -84,9 +86,9 @@ const char * ASCII representation of the address. - - - RETURN VALUES + + RETURN VALUES + If successful, the function returns dst: @@ -99,9 +101,9 @@ const char * supported. - - - SEE ALSO + + SEE ALSO + RFC1884 , @@ -112,9 +114,5 @@ const char * errno3 . - - + + diff --git a/lib/lwres/man/lwres_inetntop.html b/lib/lwres/man/lwres_inetntop.html index fb3264ceb4..e6c6caf406 100644 --- a/lib/lwres/man/lwres_inetntop.html +++ b/lib/lwres/man/lwres_inetntop.html @@ -14,56 +14,61 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_inetntop - + -
    -
    -
    +
    +
    + + + + + + + +

    Name

    -

    lwres_net_ntop — lightweight resolver IP address presentation

    +

    + lwres_net_ntop + — lightweight resolver IP address presentation +

    -
    +

    Synopsis

    -
    +
    #include <lwres/net.h>
    - +
    - - + - - + - - + - - +
    const char * lwres_net_ntop(int   -af, int af,
     const void *  -src, const void *src,
     char *  -dst, char *dst,
     size_t   -size);size_t size);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    lwres_net_ntop() +

    + +
    +

    DESCRIPTION

    + + +

    lwres_net_ntop() converts an IP address of protocol family af — IPv4 or IPv6 — at location src from network format to its @@ -71,17 +76,21 @@ const char * that string would be a dotted-decimal. An IPv6 address would be represented in colon notation as described in RFC1884.

    -

    + +

    The generated string is copied to dst provided size indicates it is long enough to store the ASCII representation of the address.

    -
    -
    -

    RETURN VALUES

    -

    + +

    +
    +

    RETURN VALUES

    + + +

    If successful, the function returns dst: a pointer to a string containing the presentation format of the address. lwres_net_ntop() returns @@ -91,13 +100,21 @@ const char * not supported.

    -
    -
    -

    SEE ALSO

    -

    RFC1884, - inet_ntop(3), - errno(3). + +

    +
    +

    SEE ALSO

    + +

    + RFC1884 + , + + inet_ntop(3) + , + + errno(3) + .

    -
    +
    diff --git a/lib/lwres/man/lwres_noop.3 b/lib/lwres/man/lwres_noop.3 index cacbd4b6a4..b3a3113b2f 100644 --- a/lib/lwres/man/lwres_noop.3 +++ b/lib/lwres/man/lwres_noop.3 @@ -13,101 +13,125 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_noop .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_NOOP" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_NOOP" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .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" .nf -#include +#include .fi -.HP 40 +.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 41 +.HP \w'lwres_result_t\ lwres_noopresponse_render('u .BI "lwres_result_t lwres_noopresponse_render(lwres_context_t\ *" "ctx" ", lwres_noopresponse_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");" -.HP 39 +.HP \w'lwres_result_t\ lwres_nooprequest_parse('u .BI "lwres_result_t lwres_nooprequest_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_nooprequest_t\ **" "structp" ");" -.HP 40 +.HP \w'lwres_result_t\ lwres_noopresponse_parse('u .BI "lwres_result_t lwres_noopresponse_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_noopresponse_t\ **" "structp" ");" -.HP 29 +.HP \w'void\ lwres_noopresponse_free('u .BI "void lwres_noopresponse_free(lwres_context_t\ *" "ctx" ", lwres_noopresponse_t\ **" "structp" ");" -.HP 28 +.HP \w'void\ lwres_nooprequest_free('u .BI "void lwres_nooprequest_free(lwres_context_t\ *" "ctx" ", lwres_nooprequest_t\ **" "structp" ");" .SH "DESCRIPTION" .PP -These are low\-level routines for creating and parsing lightweight resolver no\-op request and response messages. +These are low\-level routines for creating and parsing lightweight resolver no\-op request and response messages\&. .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. +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 -There are four main functions for the no\-op opcode. One render function converts a no\-op request structure \(em +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's 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 +\(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. +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 These structures are defined in -\fIlwres/lwres.h\fR. They are shown below. +lwres/lwres\&.h\&. They are shown below\&. .PP +.if n \{\ .RS 4 +.\} .nf #define LWRES_OPCODE_NOOP 0x00000000U .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf typedef struct { lwres_uint16_t datalength; unsigned char *data; } lwres_nooprequest_t; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf typedef struct { lwres_uint16_t datalength; unsigned char *data; } lwres_noopresponse_t; .fi +.if n \{\ .RE -.sp +.\} .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. +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 \fBlwres_nooprequest_render()\fR uses resolver context \fIctx\fR to convert no\-op request structure \fIreq\fR -to canonical format. The packet header structure +to canonical format\&. The packet header structure \fIpkt\fR is initialised and transferred to buffer -\fIb\fR. The contents of +\fIb\fR\&. The contents of \fI*req\fR -are then appended to the buffer in canonical format. +are then appended to the buffer in canonical format\&. \fBlwres_noopresponse_render()\fR performs the same task, except it converts a no\-op response structure \fBlwres_noopresponse_t\fR -to the lightweight resolver's canonical format. +to the lightweight resolver\*(Aqs canonical format\&. .PP \fBlwres_nooprequest_parse()\fR uses context @@ -116,18 +140,18 @@ to convert the contents of packet \fIpkt\fR to a \fBlwres_nooprequest_t\fR -structure. Buffer +structure\&. Buffer \fIb\fR -provides space to be used for storing this structure. When the function succeeds, the resulting +provides space to be used for storing this structure\&. When the function succeeds, the resulting \fBlwres_nooprequest_t\fR is made available through -\fI*structp\fR. +\fI*structp\fR\&. \fBlwres_noopresponse_parse()\fR offers the same semantics as \fBlwres_nooprequest_parse()\fR except it yields a \fBlwres_noopresponse_t\fR -structure. +structure\&. .PP \fBlwres_noopresponse_free()\fR and @@ -139,20 +163,19 @@ that was allocated to the or \fBlwres_nooprequest_t\fR structures referenced via -\fIstructp\fR. +\fIstructp\fR\&. .SH "RETURN VALUES" .PP The no\-op opcode functions \fBlwres_nooprequest_render()\fR, -\fBlwres_noopresponse_render()\fR -\fBlwres_nooprequest_parse()\fR +\fBlwres_noopresponse_render()\fR\fBlwres_nooprequest_parse()\fR and \fBlwres_noopresponse_parse()\fR all return \fBLWRES_R_SUCCESS\fR -on success. They return +on success\&. They return \fBLWRES_R_NOMEMORY\fR -if memory allocation fails. +if memory allocation fails\&. \fBLWRES_R_UNEXPECTEDEND\fR is returned if the available space in the buffer \fIb\fR @@ -160,23 +183,27 @@ is too small to accommodate the packet header or the \fBlwres_nooprequest_t\fR and \fBlwres_noopresponse_t\fR -structures. +structures\&. \fBlwres_nooprequest_parse()\fR and \fBlwres_noopresponse_parse()\fR will return \fBLWRES_R_UNEXPECTEDEND\fR -if the buffer is not empty after decoding the received packet. These functions will return +if the buffer is not empty after decoding the received packet\&. These functions will return \fBLWRES_R_FAILURE\fR if \fBpktflags\fR in the packet header structure \fBlwres_lwpacket_t\fR -indicate that the packet is not a response to an earlier query. +indicate that the packet is not a response to an earlier query\&. .SH "SEE ALSO" .PP \fBlwres_packet\fR(3) +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_noop.docbook b/lib/lwres/man/lwres_noop.docbook index 8f40990b47..751ab69109 100644 --- a/lib/lwres/man/lwres_noop.docbook +++ b/lib/lwres/man/lwres_noop.docbook @@ -1,6 +1,5 @@ -]> +]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -110,8 +112,8 @@ void - - DESCRIPTION + DESCRIPTION + These are low-level routines for creating and parsing lightweight resolver no-op request and response messages. @@ -201,9 +203,9 @@ typedef struct { structp. - - - RETURN VALUES + + RETURN VALUES + The no-op opcode functions lwres_nooprequest_render(), @@ -240,16 +242,12 @@ typedef struct { lwres_lwpacket_t indicate that the packet is not a response to an earlier query. - - - SEE ALSO + + SEE ALSO + lwres_packet3 - - + + diff --git a/lib/lwres/man/lwres_noop.html b/lib/lwres/man/lwres_noop.html index 274a2c9038..994e1cdbc6 100644 --- a/lib/lwres/man/lwres_noop.html +++ b/lib/lwres/man/lwres_noop.html @@ -14,184 +14,165 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_noop - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
    - +
    - - + - - + - - + - - +
    lwres_result_t lwres_nooprequest_render(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_nooprequest_t *  -req, lwres_nooprequest_t *req,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    +
    - - + - - + - - + - - +
    lwres_result_t lwres_noopresponse_render(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_noopresponse_t *  -req, lwres_noopresponse_t *req,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_buffer_t *  -b);lwres_buffer_t *b);
    - +
     
    +
    - - + - - + - - + - - +
    lwres_result_t lwres_nooprequest_parse(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_nooprequest_t **  -structp);lwres_nooprequest_t **structp);
    - +
     
    +
    - - + - - + - - + - - +
    lwres_result_t lwres_noopresponse_parse(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_lwpacket_t *  -pkt, lwres_lwpacket_t *pkt,
     lwres_noopresponse_t **  -structp);lwres_noopresponse_t **structp);
    - +
     
    +
    - - + - - +
    void lwres_noopresponse_free(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_noopresponse_t **  -structp);lwres_noopresponse_t **structp);
    - +
     
    +
    - - + - - +
    void lwres_nooprequest_free(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_nooprequest_t **  -structp);lwres_nooprequest_t **structp);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    +

    +
    +

    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 +

    + 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 — @@ -204,18 +185,18 @@ void This is complemented by a parse function which converts a packet in canonical format to a no-op response structure.

    -

    +

    These structures are defined in lwres/lwres.h. They are shown below.

    -
    +    
     #define LWRES_OPCODE_NOOP       0x00000000U
     

    -
    +    
     typedef struct {
             lwres_uint16_t  datalength;
             unsigned char   *data;
    @@ -223,7 +204,7 @@ typedef struct {
     

    -
    +    
     typedef struct {
             lwres_uint16_t  datalength;
             unsigned char   *data;
    @@ -231,12 +212,13 @@ typedef struct {
     

    -

    +

    Although the structures have different types, they are identical. This is because the no-op opcode simply echos whatever data was sent: the response is therefore identical to the request.

    -

    lwres_nooprequest_render() + +

    lwres_nooprequest_render() uses resolver context ctx to convert no-op request structure req to canonical format. The packet header structure pkt @@ -249,7 +231,8 @@ typedef struct { lwres_noopresponse_t to the lightweight resolver's canonical format.

    -

    lwres_nooprequest_parse() + +

    lwres_nooprequest_parse() uses context ctx to convert the contents of packet pkt to a lwres_nooprequest_t structure. Buffer @@ -261,17 +244,20 @@ typedef struct { semantics as lwres_nooprequest_parse() except it yields a lwres_noopresponse_t structure.

    -

    lwres_noopresponse_free() + +

    lwres_noopresponse_free() and lwres_nooprequest_free() release the memory in resolver context ctx that was allocated to the lwres_noopresponse_t or lwres_nooprequest_t structures referenced via structp.

    -
    -
    -

    RETURN VALUES

    -

    + +

    +
    +

    RETURN VALUES

    + +

    The no-op opcode functions lwres_nooprequest_render(), @@ -307,11 +293,14 @@ typedef struct { lwres_lwpacket_t indicate that the packet is not a response to an earlier query.

    -
    -
    -

    SEE ALSO

    -

    lwres_packet(3) +

    +
    +

    SEE ALSO

    + +

    + lwres_packet(3) +

    -
    +
    diff --git a/lib/lwres/man/lwres_packet.3 b/lib/lwres/man/lwres_packet.3 index a33990fc3d..6b16ee301e 100644 --- a/lib/lwres/man/lwres_packet.3 +++ b/lib/lwres/man/lwres_packet.3 @@ -13,47 +13,67 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_packet .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_PACKET" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_PACKET" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres_lwpacket_renderheader, lwres_lwpacket_parseheader \- lightweight resolver packet handling functions .SH "SYNOPSIS" .nf -#include +#include .fi -.HP 43 +.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 42 +.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 These functions rely on a \fBstruct lwres_lwpacket\fR which is defined in -\fIlwres/lwpacket.h\fR. +lwres/lwpacket\&.h\&. .PP +.if n \{\ .RS 4 +.\} .nf typedef struct lwres_lwpacket lwres_lwpacket_t; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf struct lwres_lwpacket { lwres_uint32_t length; @@ -67,89 +87,89 @@ struct lwres_lwpacket { lwres_uint16_t authlength; }; .fi +.if n \{\ .RE -.sp +.\} .PP The elements of this structure are: .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. +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, -\fBLWRES_LWPACKETVERSION_0\fR. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls. +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 \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 wit the exception of the LWRES_LWPACKETFLAG_RESPONSE bit, which is set by the library in the lwres_gabn_*() and lwres_gnba_*() calls. +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 wit 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. +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. +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. +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. +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. +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. +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 \fBNOOP\fR .RS 4 -Success is always returned and the packet contents are echoed. The lwres_noop_*() functions should be used for this type. +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. +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. +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 +\fBlwres_lwpacket_t\fR\fI*pkt\fR in network byte order to the lightweight resolver buffer, -\fI*b\fR. +\fI*b\fR\&. .PP \fBlwres_lwpacket_parseheader()\fR -performs the converse operation. It transfers data in network byte order from buffer +performs the converse operation\&. It transfers data in network byte order from buffer \fI*b\fR to resolver packet -\fI*pkt\fR. The contents of the buffer +\fI*pkt\fR\&. The contents of the buffer \fIb\fR should correspond to a -\fBlwres_lwpacket_t\fR. +\fBlwres_lwpacket_t\fR\&. .SH "RETURN VALUES" .PP Successful calls to @@ -157,13 +177,17 @@ Successful calls to and \fBlwres_lwpacket_parseheader()\fR return -\fBLWRES_R_SUCCESS\fR. If there is insufficient space to copy data between the buffer +\fBLWRES_R_SUCCESS\fR\&. If there is insufficient space to copy data between the buffer \fI*b\fR and lightweight resolver packet \fI*pkt\fR both functions return -\fBLWRES_R_UNEXPECTEDEND\fR. +\fBLWRES_R_UNEXPECTEDEND\fR\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_packet.docbook b/lib/lwres/man/lwres_packet.docbook index b946263502..7e4a80ecc3 100644 --- a/lib/lwres/man/lwres_packet.docbook +++ b/lib/lwres/man/lwres_packet.docbook @@ -1,6 +1,3 @@ -]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -69,8 +69,8 @@ lwres_result_t - - DESCRIPTION + DESCRIPTION + These functions rely on a struct lwres_lwpacket @@ -268,10 +268,10 @@ struct lwres_lwpacket { lwres_lwpacket_t. - + - - RETURN VALUES + RETURN VALUES + Successful calls to lwres_lwpacket_renderheader() and @@ -283,9 +283,5 @@ struct lwres_lwpacket { return LWRES_R_UNEXPECTEDEND. - - + + diff --git a/lib/lwres/man/lwres_packet.html b/lib/lwres/man/lwres_packet.html index 648417bd8f..0b84b7c197 100644 --- a/lib/lwres/man/lwres_packet.html +++ b/lib/lwres/man/lwres_packet.html @@ -14,71 +14,77 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_packet - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
    - +
    - - + - - +
    lwres_result_t lwres_lwpacket_renderheader(lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_lwpacket_t *  -pkt);lwres_lwpacket_t *pkt);
    - +
     
    +
    - - + - - +
    lwres_result_t lwres_lwpacket_parseheader(lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_lwpacket_t *  -pkt);lwres_lwpacket_t *pkt);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    +

    +
    +

    DESCRIPTION

    + +

    These functions rely on a struct lwres_lwpacket which is defined in lwres/lwpacket.h.

    -
    +
    +    
     typedef struct lwres_lwpacket lwres_lwpacket_t;
           

    -
    +    
     struct lwres_lwpacket {
             lwres_uint32_t          length;
             lwres_uint16_t          version;
    @@ -93,26 +99,32 @@ struct lwres_lwpacket {
     

    -

    + +

    The elements of this structure are:

    -
    +
    length
    -

    +

    +

    the overall packet length, including the entire packet header. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls. -

    +

    +
    version
    -

    +

    +

    the header format. There is currently only one format, LWRES_LWPACKETVERSION_0. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls. -

    +

    +
    pktflags
    -

    +

    +

    library-defined flags for this packet: for instance whether the packet is a request or a reply. Flag values can be set, but not defined @@ -123,9 +135,11 @@ struct lwres_lwpacket { LWRES_LWPACKETFLAG_RESPONSE bit, which is set by the library in the lwres_gabn_*() and lwres_gnba_*() calls. -

    +

    +
    serial
    -

    +

    +

    is set by the requestor and is returned in all replies. If two or more packets from the same source have the same serial number and are @@ -134,9 +148,11 @@ struct lwres_lwpacket { latter ones may be dropped. This field must be set by the application. -

    +

    +
    opcode
    -

    +

    +

    indicates the operation. Opcodes between 0x00000000 and 0x03ffffff are reserved for use by the lightweight resolver library. Opcodes @@ -144,9 +160,11 @@ struct lwres_lwpacket { 0x04000000 and 0xffffffff are application defined. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls. -

    +

    +
    result
    -

    +

    +

    is only valid for replies. Results between 0x04000000 and 0xffffffff are application defined. @@ -154,73 +172,91 @@ struct lwres_lwpacket { library use. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls. -

    +

    +
    recvlength
    -

    +

    +

    is the maximum buffer size that the receiver can handle on requests and the size of the buffer needed to satisfy a request when the buffer is too large for replies. This field is supplied by the application. -

    +

    +
    authtype
    -

    +

    +

    defines the packet level authentication that is used. Authorisation types between 0x1000 and 0xffff are application defined and types between 0x0000 and 0x0fff are reserved for library use. Currently these are not used and must be zero. -

    +

    +
    authlen
    -

    +

    +

    gives the length of the authentication data. Since packet authentication is currently not used, this must be zero. -

    +

    +

    -

    +

    The following opcodes are currently defined:

    -
    +
    NOOP
    -

    +

    +

    Success is always returned and the packet contents are echoed. The lwres_noop_*() functions should be used for this type. -

    +

    +
    GETADDRSBYNAME
    -

    +

    +

    returns all known addresses for a given name. The lwres_gabn_*() functions should be used for this type. -

    +

    +
    GETNAMEBYADDR
    -

    +

    +

    return the hostname for the given address. The lwres_gnba_*() functions should be used for this type. -

    +

    +

    -

    lwres_lwpacket_renderheader() + +

    lwres_lwpacket_renderheader() transfers the contents of lightweight resolver packet structure lwres_lwpacket_t *pkt in network byte order to the lightweight resolver buffer, *b.

    -

    lwres_lwpacket_parseheader() + +

    lwres_lwpacket_parseheader() performs the converse operation. It transfers data in network byte order from buffer *b to resolver packet *pkt. The contents of the buffer b should correspond to a lwres_lwpacket_t.

    -
    -
    -

    RETURN VALUES

    -

    + +

    + +
    +

    RETURN VALUES

    + +

    Successful calls to lwres_lwpacket_renderheader() and lwres_lwpacket_parseheader() return @@ -230,6 +266,7 @@ 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 0125c788d1..2082aadd95 100644 --- a/lib/lwres/man/lwres_resutil.3 +++ b/lib/lwres/man/lwres_resutil.3 @@ -13,59 +13,74 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l +'\" t .\" Title: lwres_resutil .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "LWRES_RESUTIL" "3" "June 18, 2007" "BIND9" "BIND9" +.TH "LWRES_RESUTIL" "3" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr \- lightweight resolver utility functions .SH "SYNOPSIS" .nf -#include +#include .fi -.HP 34 +.HP \w'lwres_result_t\ lwres_string_parse('u .BI "lwres_result_t lwres_string_parse(lwres_buffer_t\ *" "b" ", char\ **" "c" ", lwres_uint16_t\ *" "len" ");" -.HP 32 +.HP \w'lwres_result_t\ lwres_addr_parse('u .BI "lwres_result_t lwres_addr_parse(lwres_buffer_t\ *" "b" ", lwres_addr_t\ *" "addr" ");" -.HP 36 +.HP \w'lwres_result_t\ lwres_getaddrsbyname('u .BI "lwres_result_t lwres_getaddrsbyname(lwres_context_t\ *" "ctx" ", const\ char\ *" "name" ", lwres_uint32_t\ " "addrtypes" ", lwres_gabnresponse_t\ **" "structp" ");" -.HP 35 +.HP \w'lwres_result_t\ lwres_getnamebyaddr('u .BI "lwres_result_t lwres_getnamebyaddr(lwres_context_t\ *" "ctx" ", lwres_uint32_t\ " "addrtype" ", lwres_uint16_t\ " "addrlen" ", const\ unsigned\ char\ *" "addr" ", lwres_gnbaresponse_t\ **" "structp" ");" .SH "DESCRIPTION" .PP \fBlwres_string_parse()\fR retrieves a DNS\-encoded string starting the current pointer of lightweight resolver buffer -\fIb\fR: i.e. -\fBb\->current\fR. When the function returns, the address of the first byte of the encoded string is returned via +\fIb\fR: i\&.e\&. +\fBb\->current\fR\&. When the function returns, the address of the first byte of the encoded string is returned via \fI*c\fR and the length of that string is given by -\fI*len\fR. The buffer's current pointer is advanced to point at the character following the string length, the encoded string, and the trailing +\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. +character\&. .PP \fBlwres_addr_parse()\fR extracts an address from the buffer -\fIb\fR. The buffer's current pointer +\fIb\fR\&. The buffer\*(Aqs current pointer \fBb\->current\fR -is presumed to point at an encoded address: the address preceded by a 32\-bit protocol family identifier and a 16\-bit length field. The encoded address is copied to +is presumed to point at an encoded address: the address preceded by a 32\-bit protocol family identifier and a 16\-bit length field\&. The encoded address is copied to \fBaddr\->address\fR and \fBaddr\->length\fR -indicates the size in bytes of the address that was copied. +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. +is advanced to point at the next byte of available data in the buffer following the encoded address\&. .PP \fBlwres_getaddrsbyname()\fR and @@ -74,7 +89,9 @@ use the \fBlwres_gnbaresponse_t\fR structure defined below: .PP +.if n \{\ .RS 4 +.\} .nf typedef struct { lwres_uint32_t flags; @@ -89,40 +106,42 @@ typedef struct { size_t baselen; } lwres_gabnresponse_t; .fi +.if n \{\ .RE +.\} .PP The contents of this structure are not manipulated directly but they are controlled through the \fBlwres_gabn\fR(3) -functions. +functions\&. .PP The lightweight resolver uses \fBlwres_getaddrsbyname()\fR -to perform forward lookups. Hostname +to perform forward lookups\&. Hostname \fIname\fR is looked up using the resolver context \fIctx\fR -for memory allocation. +for memory allocation\&. \fIaddrtypes\fR -is a bitmask indicating which type of addresses are to be looked up. Current values for this bitmask are +is a bitmask indicating which type of addresses are to be looked up\&. Current values for this bitmask are \fBLWRES_ADDRTYPE_V4\fR for IPv4 addresses and \fBLWRES_ADDRTYPE_V6\fR -for IPv6 addresses. Results of the lookup are returned in -\fI*structp\fR. +for IPv6 addresses\&. Results of the lookup are returned in +\fI*structp\fR\&. .PP \fBlwres_getnamebyaddr()\fR -performs reverse lookups. Resolver context +performs reverse lookups\&. Resolver context \fIctx\fR -is used for memory allocation. The address type is indicated by +is used for memory allocation\&. The address type is indicated by \fIaddrtype\fR: \fBLWRES_ADDRTYPE_V4\fR or -\fBLWRES_ADDRTYPE_V6\fR. The address to be looked up is given by +\fBLWRES_ADDRTYPE_V6\fR\&. The address to be looked up is given by \fIaddr\fR and its length is \fIaddrlen\fR -bytes. The result of the function call is made available through -\fI*structp\fR. +bytes\&. The result of the function call is made available through +\fI*structp\fR\&. .SH "RETURN VALUES" .PP Successful calls to @@ -130,12 +149,12 @@ Successful calls to and \fBlwres_addr_parse()\fR return -\fBLWRES_R_SUCCESS.\fR +\fBLWRES_R_SUCCESS\&.\fR Both functions return \fBLWRES_R_FAILURE\fR 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. +if the buffer has less space than expected for the components of the encoded string or address\&. .PP \fBlwres_getaddrsbyname()\fR returns @@ -144,11 +163,11 @@ on success and it returns \fBLWRES_R_NOTFOUND\fR if the hostname \fIname\fR -could not be found. +could not be found\&. .PP \fBLWRES_R_SUCCESS\fR is returned by a successful call to -\fBlwres_getnamebyaddr()\fR. +\fBlwres_getnamebyaddr()\fR\&. .PP Both \fBlwres_getaddrsbyname()\fR @@ -158,12 +177,16 @@ return \fBLWRES_R_NOMEMORY\fR when memory allocation requests fail and \fBLWRES_R_UNEXPECTEDEND\fR -if the buffers used for sending queries and receiving replies are too small. +if the buffers used for sending queries and receiving replies are too small\&. .SH "SEE ALSO" .PP \fBlwres_buffer\fR(3), -\fBlwres_gabn\fR(3). +\fBlwres_gabn\fR(3)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. diff --git a/lib/lwres/man/lwres_resutil.docbook b/lib/lwres/man/lwres_resutil.docbook index 0a0c4704aa..4fa3733ecf 100644 --- a/lib/lwres/man/lwres_resutil.docbook +++ b/lib/lwres/man/lwres_resutil.docbook @@ -1,6 +1,3 @@ -]> - - - + + + + 2007-06-18 + - June 18, 2007 + ISC + Internet Systems Consortium, Inc. @@ -92,8 +92,8 @@ lwres_result_t - - DESCRIPTION + DESCRIPTION + lwres_string_parse() retrieves a DNS-encoded string starting the current pointer of @@ -176,10 +176,10 @@ typedef struct { function call is made available through *structp. - + - - RETURN VALUES + RETURN VALUES + Successful calls to lwres_string_parse() @@ -218,9 +218,9 @@ typedef struct { small. - - - SEE ALSO + + SEE ALSO + lwres_buffer3 , @@ -230,9 +230,5 @@ typedef struct { . - - + + diff --git a/lib/lwres/man/lwres_resutil.html b/lib/lwres/man/lwres_resutil.html index c62a289d96..14468b69fe 100644 --- a/lib/lwres/man/lwres_resutil.html +++ b/lib/lwres/man/lwres_resutil.html @@ -14,128 +14,119 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - lwres_resutil - + -
    -
    -
    +
    +
    + + + + + + + +

    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>
    - +
    - - + - - + - - +
    lwres_result_t lwres_string_parse(lwres_buffer_t *  -b, lwres_buffer_t *b,
     char **  -c, char **c,
     lwres_uint16_t *  -len);lwres_uint16_t *len);
    - +
     
    +
    - - + - - +
    lwres_result_t lwres_addr_parse(lwres_buffer_t *  -b, lwres_buffer_t *b,
     lwres_addr_t *  -addr);lwres_addr_t *addr);
    - +
     
    +
    - - + - - + - - + - - +
    lwres_result_t lwres_getaddrsbyname(lwres_context_t *  -ctx, lwres_context_t *ctx,
     const char *  -name, const char *name,
     lwres_uint32_t   -addrtypes, lwres_uint32_t addrtypes,
     lwres_gabnresponse_t **  -structp);lwres_gabnresponse_t **structp);
    - +
     
    +
    - - + - - + - - + - - + - - +
    lwres_result_t lwres_getnamebyaddr(lwres_context_t *  -ctx, lwres_context_t *ctx,
     lwres_uint32_t   -addrtype, lwres_uint32_t addrtype,
     lwres_uint16_t   -addrlen, lwres_uint16_t addrlen,
     const unsigned char *  -addr, const unsigned char *addr,
     lwres_gnbaresponse_t **  -structp);lwres_gnbaresponse_t **structp);
    +
     
    -
    -
    -

    DESCRIPTION

    -

    lwres_string_parse() +

    + +
    +

    DESCRIPTION

    + + +

    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, @@ -146,7 +137,8 @@ lwres_result_t string length, the encoded string, and the trailing NULL character.

    -

    lwres_addr_parse() + +

    lwres_addr_parse() extracts an address from the buffer b. The buffer's current pointer b->current is presumed to point at an encoded address: the address preceded @@ -159,10 +151,12 @@ lwres_result_t next byte of available data in the buffer following the encoded address.

    -

    lwres_getaddrsbyname() + +

    lwres_getaddrsbyname() and lwres_getnamebyaddr() use the lwres_gnbaresponse_t structure defined below:

    +
     typedef struct {
             lwres_uint32_t          flags;
    @@ -177,13 +171,17 @@ typedef struct {
             size_t                  baselen;
     } lwres_gabnresponse_t;
     
    -

    + +

    The contents of this structure are not manipulated directly but they are controlled through the - lwres_gabn(3) + + lwres_gabn(3) + functions.

    -

    + +

    The lightweight resolver uses lwres_getaddrsbyname() to perform forward lookups. @@ -197,7 +195,8 @@ typedef struct { LWRES_ADDRTYPE_V6 for IPv6 addresses. Results of the lookup are returned in *structp.

    -

    lwres_getnamebyaddr() + +

    lwres_getnamebyaddr() performs reverse lookups. Resolver context ctx is used for memory allocation. The address type is indicated by addrtype: @@ -208,10 +207,12 @@ typedef struct { function call is made available through *structp.

    -
    -
    -

    RETURN VALUES

    -

    +

    + +
    +

    RETURN VALUES

    + +

    Successful calls to lwres_string_parse() and @@ -225,16 +226,18 @@ typedef struct { if the buffer has less space than expected for the components of the encoded string or address.

    -

    lwres_getaddrsbyname() + +

    lwres_getaddrsbyname() returns LWRES_R_SUCCESS on success and it returns LWRES_R_NOTFOUND if the hostname name could not be found.

    -

    LWRES_R_SUCCESS +

    LWRES_R_SUCCESS is returned by a successful call to lwres_getnamebyaddr().

    -

    + +

    Both lwres_getaddrsbyname() and @@ -246,13 +249,20 @@ typedef struct { if the buffers used for sending queries and receiving replies are too small.

    -
    -
    -

    SEE ALSO

    -

    lwres_buffer(3), - lwres_gabn(3). +

    +
    +

    SEE ALSO

    + +

    + lwres_buffer(3) + , + + + lwres_gabn(3) + .

    -
    + +
    diff --git a/make/rules.in b/make/rules.in index 2a412f6c03..47ee41c4aa 100644 --- a/make/rules.in +++ b/make/rules.in @@ -314,6 +314,7 @@ XSLTPROC = @XSLTPROC@ --novalid --xinclude --nonet PERL = @PERL@ LATEX = @LATEX@ PDFLATEX = @PDFLATEX@ +DBLATEX = @DBLATEX@ W3M = @W3M@ ###