From 2eeb74d1cf5355dd98f6d507a10086e16bb08c4b Mon Sep 17 00:00:00 2001 From: Tinderbox User Date: Tue, 6 Oct 2015 05:45:21 +0000 Subject: [PATCH] regen master --- FAQ | 28 +- FAQ.xml | 1 + bin/check/named-checkconf.8 | 86 ++- bin/check/named-checkconf.html | 155 +++-- bin/check/named-checkzone.8 | 176 ++--- bin/check/named-checkzone.docbook | 1 + bin/check/named-checkzone.html | 443 ++++++++----- bin/confgen/ddns-confgen.8 | 98 +-- bin/confgen/ddns-confgen.docbook | 1 + bin/confgen/ddns-confgen.html | 183 +++-- bin/confgen/rndc-confgen.8 | 118 ++-- bin/confgen/rndc-confgen.docbook | 1 + bin/confgen/rndc-confgen.html | 229 ++++--- bin/delv/delv.1 | 219 +++--- bin/delv/delv.html | 423 +++++++----- bin/dig/dig.1 | 373 ++++++----- bin/dig/dig.html | 735 +++++++++++++-------- bin/dig/host.1 | 133 ++-- bin/dig/host.html | 186 ++++-- bin/dig/nslookup.1 | 130 ++-- bin/dig/nslookup.html | 303 +++++---- bin/dnssec/dnssec-dsfromkey.8 | 104 +-- bin/dnssec/dnssec-dsfromkey.docbook | 1 + bin/dnssec/dnssec-dsfromkey.html | 228 ++++--- bin/dnssec/dnssec-importkey.8 | 76 ++- bin/dnssec/dnssec-importkey.docbook | 1 + bin/dnssec/dnssec-importkey.html | 165 +++-- bin/dnssec/dnssec-keyfromlabel.8 | 200 +++--- bin/dnssec/dnssec-keyfromlabel.docbook | 1 + bin/dnssec/dnssec-keyfromlabel.html | 315 ++++++--- bin/dnssec/dnssec-keygen.8 | 242 ++++--- bin/dnssec/dnssec-keygen.docbook | 1 + bin/dnssec/dnssec-keygen.html | 358 ++++++---- bin/dnssec/dnssec-revoke.8 | 58 +- bin/dnssec/dnssec-revoke.docbook | 1 + bin/dnssec/dnssec-revoke.html | 125 ++-- bin/dnssec/dnssec-settime.8 | 102 +-- bin/dnssec/dnssec-settime.docbook | 1 + bin/dnssec/dnssec-settime.html | 220 +++--- bin/dnssec/dnssec-signzone.8 | 290 ++++---- bin/dnssec/dnssec-signzone.docbook | 1 + bin/dnssec/dnssec-signzone.html | 495 +++++++++----- bin/dnssec/dnssec-verify.8 | 68 +- bin/dnssec/dnssec-verify.docbook | 1 + bin/dnssec/dnssec-verify.html | 140 ++-- bin/named/lwresd.8 | 116 ++-- bin/named/lwresd.docbook | 1 + bin/named/lwresd.html | 240 ++++--- bin/named/named.8 | 162 +++-- bin/named/named.conf.5 | 247 ++++--- bin/named/named.conf.docbook | 1 + bin/named/named.conf.html | 197 +++--- bin/named/named.docbook | 1 + bin/named/named.html | 423 +++++++----- bin/nsupdate/nsupdate.1 | 283 ++++---- bin/nsupdate/nsupdate.docbook | 1 + bin/nsupdate/nsupdate.html | 509 ++++++++------ bin/pkcs11/pkcs11-destroy.docbook | 1 + bin/pkcs11/pkcs11-keygen.docbook | 1 + bin/pkcs11/pkcs11-list.docbook | 1 + bin/pkcs11/pkcs11-tokens.docbook | 1 + bin/python/dnssec-checkds.8 | 54 +- bin/python/dnssec-checkds.docbook | 1 + bin/python/dnssec-checkds.html | 119 ++-- bin/python/dnssec-coverage.8 | 90 +-- bin/python/dnssec-coverage.docbook | 1 + bin/python/dnssec-coverage.html | 159 +++-- bin/rndc/rndc.8 | 332 +++++----- bin/rndc/rndc.conf.5 | 125 ++-- bin/rndc/rndc.conf.docbook | 1 + bin/rndc/rndc.conf.html | 146 ++-- bin/rndc/rndc.docbook | 1 + bin/rndc/rndc.html | 582 +++++++++------- bin/tools/arpaname.1 | 34 +- bin/tools/arpaname.docbook | 1 + bin/tools/arpaname.html | 58 +- bin/tools/dnstap-read.docbook | 1 + bin/tools/genrandom.8 | 40 +- bin/tools/genrandom.docbook | 1 + bin/tools/genrandom.html | 97 ++- bin/tools/isc-hmac-fixup.8 | 46 +- bin/tools/isc-hmac-fixup.html | 78 ++- bin/tools/mdig.1 | 181 ++--- bin/tools/mdig.html | 404 +++++++---- bin/tools/named-journalprint.8 | 48 +- bin/tools/named-journalprint.docbook | 1 + bin/tools/named-journalprint.html | 77 ++- bin/tools/named-rrchecker.1 | 47 +- bin/tools/named-rrchecker.docbook | 1 + bin/tools/named-rrchecker.html | 68 +- bin/tools/nsec3hash.8 | 42 +- bin/tools/nsec3hash.docbook | 1 + bin/tools/nsec3hash.html | 96 ++- doc/arm/Bv9ARM-book.xml | 1 + doc/arm/Bv9ARM.ch01.html | 86 +-- doc/arm/Bv9ARM.ch02.html | 40 +- doc/arm/Bv9ARM.ch03.html | 56 +- doc/arm/Bv9ARM.ch04.html | 342 +++++----- doc/arm/Bv9ARM.ch05.html | 18 +- doc/arm/Bv9ARM.ch06.html | 424 ++++++------ doc/arm/Bv9ARM.ch07.html | 34 +- doc/arm/Bv9ARM.ch08.html | 34 +- doc/arm/Bv9ARM.ch09.html | 48 +- doc/arm/Bv9ARM.ch10.html | 14 +- doc/arm/Bv9ARM.ch11.html | 240 +++---- doc/arm/Bv9ARM.ch12.html | 94 +-- doc/arm/Bv9ARM.ch13.html | 6 +- doc/arm/Bv9ARM.html | 216 +++--- doc/arm/dlz.xml | 1 + doc/arm/dnssec.xml | 1 + doc/arm/dyndb.xml | 1 + doc/arm/libdns.xml | 1 + doc/arm/logging-categories.xml | 1 + doc/arm/man.arpaname.html | 14 +- doc/arm/man.ddns-confgen.html | 20 +- doc/arm/man.delv.html | 36 +- doc/arm/man.dig.html | 48 +- doc/arm/man.dnssec-checkds.html | 20 +- doc/arm/man.dnssec-coverage.html | 20 +- doc/arm/man.dnssec-dsfromkey.html | 32 +- doc/arm/man.dnssec-importkey.html | 30 +- doc/arm/man.dnssec-keyfromlabel.html | 32 +- doc/arm/man.dnssec-keygen.html | 36 +- doc/arm/man.dnssec-revoke.html | 20 +- doc/arm/man.dnssec-settime.html | 32 +- doc/arm/man.dnssec-signzone.html | 28 +- doc/arm/man.dnssec-verify.html | 20 +- doc/arm/man.dnstap-read.html | 20 +- doc/arm/man.genrandom.html | 20 +- doc/arm/man.host.html | 22 +- doc/arm/man.isc-hmac-fixup.html | 18 +- doc/arm/man.lwresd.html | 30 +- doc/arm/man.named-checkconf.html | 24 +- doc/arm/man.named-checkzone.html | 24 +- doc/arm/man.named-journalprint.html | 14 +- doc/arm/man.named-rrchecker.html | 14 +- doc/arm/man.named.conf.html | 66 +- doc/arm/man.named.html | 46 +- doc/arm/man.nsec3hash.html | 20 +- doc/arm/man.nsupdate.html | 40 +- doc/arm/man.rndc-confgen.html | 24 +- doc/arm/man.rndc.conf.html | 22 +- doc/arm/man.rndc.html | 30 +- doc/arm/managed-keys.xml | 1 + doc/arm/notes.html | 38 +- doc/xsl/copyright.xsl | 2 + doc/xsl/isc-docbook-text.xsl | 2 + doc/xsl/isc-manpage.xsl.in | 2 + isc-config.sh.1 | 62 +- isc-config.sh.docbook | 1 + isc-config.sh.html | 105 ++- lib/lwres/man/lwres.3 | 119 ++-- lib/lwres/man/lwres.docbook | 1 + lib/lwres/man/lwres.html | 172 +++-- lib/lwres/man/lwres_buffer.3 | 164 +++-- lib/lwres/man/lwres_buffer.docbook | 1 + lib/lwres/man/lwres_buffer.html | 274 ++++---- lib/lwres/man/lwres_config.3 | 65 +- lib/lwres/man/lwres_config.docbook | 1 + lib/lwres/man/lwres_config.html | 133 ++-- lib/lwres/man/lwres_context.3 | 103 +-- lib/lwres/man/lwres_context.html | 203 +++--- lib/lwres/man/lwres_gabn.3 | 105 +-- lib/lwres/man/lwres_gabn.html | 182 +++-- lib/lwres/man/lwres_gai_strerror.3 | 45 +- lib/lwres/man/lwres_gai_strerror.docbook | 1 + lib/lwres/man/lwres_gai_strerror.html | 138 ++-- lib/lwres/man/lwres_getaddrinfo.3 | 101 +-- lib/lwres/man/lwres_getaddrinfo.html | 204 ++++-- lib/lwres/man/lwres_gethostent.3 | 146 ++-- lib/lwres/man/lwres_gethostent.html | 317 ++++----- lib/lwres/man/lwres_getipnode.3 | 94 ++- lib/lwres/man/lwres_getipnode.docbook | 1 + lib/lwres/man/lwres_getipnode.html | 223 ++++--- lib/lwres/man/lwres_getnameinfo.3 | 67 +- lib/lwres/man/lwres_getnameinfo.docbook | 1 + lib/lwres/man/lwres_getnameinfo.html | 165 +++-- lib/lwres/man/lwres_getrrsetbyname.3 | 68 +- lib/lwres/man/lwres_getrrsetbyname.docbook | 1 + lib/lwres/man/lwres_getrrsetbyname.html | 136 ++-- lib/lwres/man/lwres_gnba.3 | 102 +-- lib/lwres/man/lwres_gnba.html | 188 +++--- lib/lwres/man/lwres_hstrerror.3 | 45 +- lib/lwres/man/lwres_hstrerror.docbook | 1 + lib/lwres/man/lwres_hstrerror.html | 112 ++-- lib/lwres/man/lwres_inetntop.3 | 45 +- lib/lwres/man/lwres_inetntop.html | 91 +-- lib/lwres/man/lwres_noop.3 | 102 +-- lib/lwres/man/lwres_noop.html | 185 +++--- lib/lwres/man/lwres_packet.3 | 87 ++- lib/lwres/man/lwres_packet.docbook | 1 + lib/lwres/man/lwres_packet.html | 159 +++-- lib/lwres/man/lwres_resutil.3 | 95 ++- lib/lwres/man/lwres_resutil.docbook | 1 + lib/lwres/man/lwres_resutil.html | 164 ++--- 195 files changed, 11659 insertions(+), 7977 deletions(-) diff --git a/FAQ b/FAQ index 2b71a1930a..0ce0abd344 100644 --- a/FAQ +++ b/FAQ @@ -1,14 +1,10 @@ -Frequently Asked Questions about BIND 9 - -Copyright © 2004-2010, 2013, 2014 Internet Systems Consortium, Inc. +Copyright ? 2004-2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") -Copyright © 2000-2003 Internet Software Consortium. +Copyright ? 2000-2003 Internet Software Consortium. ----------------------------------------------------------------------- -1. Compilation and Installation Questions - Q: I'm trying to compile BIND 9, and "make" is failing due to files not being found. Why? @@ -35,8 +31,6 @@ A: Short Answer: No. answers to all these questions change how you configure even a caching name server. -2. Configuration and Setup Questions - Q: Why does named log the warning message "no TTL specified - using SOA MINTTL instead"? @@ -392,8 +386,6 @@ A: You can use server clauses to stop named making external lookups over server fd81:ec6c:bd62::/48 { bogus no; }; // site ULA prefix server ::/0 { bogus yes; }; -3. Operations Questions - Q: How to change the nameservers for a zone? A: Step 1: Ensure all nameservers, new and old, are serving the same zone @@ -436,8 +428,6 @@ A: Step 1: Ensure all nameservers, new and old, are serving the same zone Note: while it is possible to run the addition and removal stages together it is not recommended. -4. General Questions - Q: I keep getting log messages like the following. Why? Dec 4 23:47:59 client 10.0.0.1#1355: updating zone 'example.com/IN': @@ -609,10 +599,6 @@ A: NSEC3 records are strictly meta data and can only be returned in the records does not bring names into existence that do not exist in the unsigned version of the zone. -5. Operating-System Specific Questions - -5.1. HPUX - Q: I get the following error trying to configure BIND: checking if unistd.h or sys/types.h defines fd_set... no @@ -627,8 +613,6 @@ A: You have attempted to configure BIND with the bundled C compiler. This ./configure CC= ... -5.2. Linux - Q: Why do I get the following errors: general: errno2result.c:109: unexpected error: @@ -813,8 +797,6 @@ A: This is usually due to "/proc/net/if_inet6" not being available in the proc /proc proc defaults 0 0 proc /var/named/proc proc defaults 0 0 -5.3. Windows - Q: Zone transfers from my BIND 9 master to my Windows 2000 slave fail. Why? @@ -839,8 +821,6 @@ A: This is the service manager saying that named exited. You need to Directory "C:\windows\dns\etc"; }; -5.4. FreeBSD - Q: I have FreeBSD 4.x and "rndc-confgen -a" just sits there. A: /dev/random is not configured. Use rndcontrol(8) to tell the kernel to @@ -851,16 +831,12 @@ A: /dev/random is not configured. Use rndcontrol(8) to tell the kernel to See also . -5.5. Solaris - Q: How do I integrate BIND 9 and Solaris SMF A: Sun has a blog entry describing how to do this. -5.6. Apple Mac OS X - Q: How do I run BIND 9 on Apple Mac OS X? A: If you run Tiger(Mac OS 10.4) or later then this is all you need to do: diff --git a/FAQ.xml b/FAQ.xml index e06c82eebd..ff5b6427db 100644 --- a/FAQ.xml +++ b/FAQ.xml @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> +
diff --git a/bin/check/named-checkconf.8 b/bin/check/named-checkconf.8 index 40d356881a..99491717dc 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.76.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,90 +54,91 @@ 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 +directory so that include directives in the configuration file are processed as if run by a similarly chrooted -\fBnamed\fR. +\fBnamed\fR\&. .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, 2015 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.html b/bin/check/named-checkconf.html index 5104b55104..0b3ede2780 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. -

+ 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 47eb574c67..3ae3723574 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: February 19, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-02-19 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NAMED\-CHECKZONE" "8" "February 19, 2014" "BIND9" "BIND9" +.TH "NAMED\-CHECKZONE" "8" "2014\-02\-19" "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\-J\ \fR\fB\fIfilename\fR\fR] [\fB\-i\ \fR\fB\fImode\fR\fR] [\fB\-k\ \fR\fB\fImode\fR\fR] [\fB\-m\ \fR\fB\fImode\fR\fR] [\fB\-M\ \fR\fB\fImode\fR\fR] [\fB\-n\ \fR\fB\fImode\fR\fR] [\fB\-l\ \fR\fB\fIttl\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-o\ \fR\fB\fIfilename\fR\fR] [\fB\-r\ \fR\fB\fImode\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-S\ \fR\fB\fImode\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-T\ \fR\fB\fImode\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {zonename} {filename} @@ -39,86 +54,86 @@ 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 a zone file, read the journal if it exists. The journal file name is assumed to be the zone file name appended with the string -\fI.jnl\fR. +When loading a zone file, read the journal if it exists\&. The journal file name is assumed to be the zone file name appended with the string +\&.jnl\&. .RE .PP \-J \fIfilename\fR .RS 4 -When loading the zone file read the journal from the given file, if it exists. (Implies \-j.) +When loading the zone file read the journal from the given file, if it exists\&. (Implies \-j\&.) .RE .PP \-c \fIclass\fR .RS 4 -Specify the class of the zone. If not specified, "IN" is assumed. +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 @@ -128,26 +143,26 @@ 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), \fB"raw"\fR, and -\fB"map"\fR. +\fB"map"\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 @@ -155,170 +170,171 @@ Possible formats are \fB"map"\fR, \fB"raw"\fR, and \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 \fIttl\fR .RS 4 -Sets a maximum permissible TTL for the input file. Any record with a TTL higher than this value will cause the zone to be rejected. This is similar to using the +Sets a maximum permissible TTL for the input file\&. Any record with a TTL higher than this value will cause the zone to be rejected\&. This is similar to using the \fBmax\-zone\-ttl\fR option in -\fInamed.conf\fR. +named\&.conf\&. .RE .PP \-L \fIserial\fR .RS 4 -When compiling a zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) +When compiling a zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number\&. (This is expected to be used primarily for testing purposes\&.) .RE .PP \-m \fImode\fR .RS 4 -Specify whether MX records should be checked to see if they are addresses. Possible modes are +Specify whether MX records should be checked to see if they are addresses\&. Possible modes are \fB"fail"\fR, \fB"warn"\fR (default) and -\fB"ignore"\fR. +\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 +directory so that include directives in the configuration file are processed as if run by a similarly chrooted -\fBnamed\fR. +\fBnamed\fR\&. .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\-2015 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2002 Internet Software Consortium. +Copyright \(co 2004-2007, 2009-2015 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 f0ad4b3dfd..3f8acbc219 100644 --- a/bin/check/named-checkzone.docbook +++ b/bin/check/named-checkzone.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/check/named-checkzone.html b/bin/check/named-checkzone.html index b64b5fd24e..999156cc50 100644 --- a/bin/check/named-checkzone.html +++ b/bin/check/named-checkzone.html @@ -14,297 +14,424 @@ - 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] [-J filename] [-i mode] [-k mode] [-m mode] [-M mode] [-n mode] [-l ttl] [-L serial] [-o filename] [-r mode] [-s style] [-S mode] [-t directory] [-T mode] [-w directory] [-D] [-W mode] {zonename} {filename}

-

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

-
-
-

DESCRIPTION

-

named-checkzone +

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

+

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

+
+ +
+

DESCRIPTION

+ +

named-checkzone 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 a zone file, read the journal if it exists. The journal file name is assumed to be the zone file name appended with the string .jnl. -

+

+
-J filename
-

+

+

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

+

+
-c class
-

+

+

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

+

+
-i mode
-

+

Perform post-load zone integrity checks. Possible modes are - "full" (default), - "full-sibling", - "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), - "raw", and "map". -

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

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

+ Possible formats are "text" (default), which is the standard textual representation of the zone, - and "map", "raw", - and "raw=N", which store the zone in a - binary format for rapid loading by named. - "raw=N" specifies the format version of + and "map", "raw", + and "raw=N", which store the zone in a + binary format for rapid loading 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 + any version of named; if N is 1, the file can be read by release 9.9.0 or higher; the default is 1.

-
+
-k mode
-

- Perform "check-names" checks with the +

+

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

+

+

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

+

+
-L serial
-

+

+

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

+

+
-m mode
-

+

+

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

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

+ 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 a96135927d..959f5f2b6d 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: March 6, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-03-06 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DDNS\-CONFGEN" "8" "March 6, 2014" "BIND9" "BIND9" +.TH "DDNS\-CONFGEN" "8" "2014\-03\-06" "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 12 \fBtsig\-keygen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [name] @@ -40,13 +55,13 @@ ddns\-confgen \- ddns key generation tool \fBtsig\-keygen\fR and \fBddns\-confgen\fR -are invocation methods for a utility that generates keys for use in TSIG signing. The resulting keys can be used, for example, to secure dynamic DNS updates to a zone or for the +are invocation methods for a utility that generates keys for use in TSIG signing\&. The resulting keys can be used, for example, to secure dynamic DNS updates to a zone or for the \fBrndc\fR -command channel. +command channel\&. .PP When run as -\fBtsig\-keygen\fR, a domain name can be specified on the command line which will be used as the name of the generated key. If no name is specified, the default is -\fBtsig\-key\fR. +\fBtsig\-keygen\fR, a domain name can be specified on the command line which will be used as the name of the generated key\&. If no name is specified, the default is +\fBtsig\-key\fR\&. .PP When run as \fBddns\-confgen\fR, the generated key is accompanied by configuration text and instructions that can be used with @@ -55,34 +70,34 @@ and \fBnamed\fR when setting up dynamic DNS, including an example \fBupdate\-policy\fR -statement. (This usage similar to the +statement\&. (This usage similar to the \fBrndc\-confgen\fR -command for setting up command channel security.) +command for setting up command channel security\&.) .PP Note that \fBnamed\fR itself can configure a local DDNS key for use with \fBnsupdate \-l\fR: it does this when a zone is configured with -\fBupdate\-policy local;\fR. +\fBupdate\-policy local;\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. Options are case\-insensitive, and the "hmac\-" prefix may be omitted. +Specifies the algorithm to use for the TSIG key\&. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512\&. The default is hmac\-sha256\&. Options are case\-insensitive, and the "hmac\-" prefix may be omitted\&. .RE .PP \-h .RS 4 -Prints a short summary of options and arguments. +Prints a short summary of options and arguments\&. .RE .PP \-k \fIkeyname\fR .RS 4 -Specifies the key name of the DDNS authentication key. The default is +Specifies the key name of the DDNS authentication key\&. The default is \fBddns\-key\fR when neither the \fB\-s\fR @@ -90,62 +105,63 @@ 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 (\fBddns\-confgen\fR -only.) Quiet mode: Print only the key, with no explanatory text or usage examples; This is essentially identical to -\fBtsig\-keygen\fR. +only\&.) Quiet mode: Print only the key, with no explanatory text or usage examples; This is essentially identical to +\fBtsig\-keygen\fR\&. .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 (\fBddns\-confgen\fR -only.) Generate configuration example to allow dynamic updates of a single hostname. The example -\fBnamed.conf\fR +only\&.) Generate configuration example to allow dynamic updates of a single hostname\&. The example +\fBnamed\&.conf\fR text shows how to set an update policy for the specified \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 (\fBddns\-confgen\fR -only.) Generate configuration example to allow dynamic updates of a zone: The example -\fBnamed.conf\fR +only\&.) Generate configuration example to allow dynamic updates of a zone: The example +\fBnamed\&.conf\fR text shows how to set an update policy for the specified \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 a4b0c90b78..159c89a318 100644 --- a/bin/confgen/ddns-confgen.docbook +++ b/bin/confgen/ddns-confgen.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/confgen/ddns-confgen.html b/bin/confgen/ddns-confgen.html index ba2b737312..5fddd74d78 100644 --- a/bin/confgen/ddns-confgen.html +++ b/bin/confgen/ddns-confgen.html @@ -13,77 +13,117 @@ - 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

-

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

-

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

-
-
-

DESCRIPTION

- tsig-keygen and ddns-confgen + ddns-confgen + — ddns key generation tool +

+
+ + + +
+

Synopsis

+

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

+

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

+
+ +
+

DESCRIPTION

+ +

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

-

- When run as tsig-keygen, a domain name + +

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

-

- When run as ddns-confgen, the generated + +

+ When run as ddns-confgen, the generated key is accompanied by configuration text and instructions - that can be used with nsupdate and - named when setting up dynamic DNS, - including an example update-policy + that can be used with nsupdate and + named when setting up dynamic DNS, + including an example update-policy statement. (This usage similar to the - rndc-confgen command for setting + rndc-confgen command for setting up command channel security.)

-

- Note that named itself can configure a - local DDNS key for use with nsupdate -l: + +

+ Note that named itself can configure a + local DDNS key for use with nsupdate -l: it does this when a zone is configured with - update-policy local;. - ddns-confgen is only needed when a + update-policy local;. + ddns-confgen is only needed when a more elaborate configuration is required: for instance, - if nsupdate is to be used from a remote + if 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. Options are case-insensitive, and the "hmac-" prefix may be omitted. -

+

+
-h
-

+

+

Prints a short summary of options and arguments. -

+

+
-k keyname
-

+

+

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

+

+
-q
-

- (ddns-confgen only.) Quiet mode: Print +

+

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

+ This is essentially identical to tsig-keygen. +

+
-r randomfile
-

+

+

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

+

+
-s name
-

- (ddns-confgen only.) +

+

+ (ddns-confgen only.) Generate configuration example to allow dynamic updates - of a single hostname. The example named.conf + of a single hostname. The example named.conf text shows how to set an update policy for the specified name using the "name" nametype. The default key name is @@ -124,33 +170,40 @@ Note that the "self" nametype cannot be used, since the name to be updated may differ from the key name. This option cannot be used with the -z option. -

+

+
-z zone
-

- (ddns-confgen only.) +

+

+ (ddns-confgen only.) Generate configuration example to allow dynamic updates - of a zone: The example named.conf text + of a zone: 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 ed27ea22bd..ef4ab962b2 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: March 14, 2013 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2013-03-14 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "RNDC\-CONFGEN" "8" "March 14, 2013" "BIND9" "BIND9" +.TH "RNDC\-CONFGEN" "8" "2013\-03\-14" "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\-A\ \fR\fB\fIalgorithm\fR\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-c\ \fR\fB\fIkeyfile\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\fB\-s\ \fR\fB\fIaddress\fR\fR] [\fB\-t\ \fR\fB\fIchrootdir\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] @@ -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,20 +112,20 @@ 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 \-A \fIalgorithm\fR .RS 4 -Specifies the algorithm to use for the TSIG key. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512. The default is hmac\-md5. +Specifies the algorithm to use for the TSIG key\&. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512\&. The default is hmac\-md5\&. .RE .PP \-b \fIkeysize\fR .RS 4 -Specifies the size of the authentication key in bits. Must be between 1 and 512 bits; the default is the hash size. +Specifies the size of the authentication key in bits\&. Must be between 1 and 512 bits; the default is the hash size\&. .RE .PP \-c \fIkeyfile\fR @@ -118,19 +133,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 @@ -138,18 +153,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 @@ -157,7 +172,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 @@ -166,10 +181,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 @@ -177,10 +192,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 @@ -191,13 +206,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" @@ -205,11 +220,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, 2013, 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 f125a9f550..b0f401c566 100644 --- a/bin/confgen/rndc-confgen.docbook +++ b/bin/confgen/rndc-confgen.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/confgen/rndc-confgen.html b/bin/confgen/rndc-confgen.html index 103ae78a6d..aadcf9862a 100644 --- a/bin/confgen/rndc-confgen.html +++ b/bin/confgen/rndc-confgen.html @@ -14,115 +14,157 @@ - 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] [-A algorithm] [-b keysize] [-c keyfile] [-h] [-k keyname] [-p port] [-r randomfile] [-s address] [-t chrootdir] [-u user]

-
-
-

DESCRIPTION

-

rndc-confgen +

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

+
+ +
+

DESCRIPTION

+ +

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

-
+
-A algorithm
-

+

+

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

+

+
-b keysize
-

+

+

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

+

+
-c keyfile
-

- Used with the -a option to specify +

+

+ 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 @@ -133,63 +175,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/delv/delv.1 b/bin/delv/delv.1 index 5a7a7ddb4a..7e062710d6 100644 --- a/bin/delv/delv.1 +++ b/bin/delv/delv.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: delv .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: April 23, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-04-23 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DELV" "1" "April 23, 2014" "BIND9" "BIND9" +.TH "DELV" "1" "2014\-04\-23" "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" delv \- DNS lookup and validation utility .SH "SYNOPSIS" @@ -43,94 +58,98 @@ delv \- DNS lookup and validation utility .PP \fBdelv\fR (Domain Entity Lookup & Validation) is a tool for sending DNS queries and validating the results, using the same internal resolver and validator logic as -\fBnamed\fR. +\fBnamed\fR\&. .PP \fBdelv\fR -will send to a specified name server all queries needed to fetch and validate the requested data; this includes the original requested query, subsequent queries to follow CNAME or DNAME chains, and queries for DNSKEY, DS and DLV records to establish a chain of trust for DNSSEC validation. It does not perform iterative resolution, but simulates the behavior of a name server configured for DNSSEC validating and forwarding. +will send to a specified name server all queries needed to fetch and validate the requested data; this includes the original requested query, subsequent queries to follow CNAME or DNAME chains, and queries for DNSKEY, DS and DLV records to establish a chain of trust for DNSSEC validation\&. It does not perform iterative resolution, but simulates the behavior of a name server configured for DNSSEC validating and forwarding\&. .PP -By default, responses are validated using built\-in DNSSEC trust anchors for the root zone (".") and for the ISC DNSSEC lookaside validation zone ("dlv.isc.org"). Records returned by +By default, responses are validated using built\-in DNSSEC trust anchors for the root zone ("\&.") and for the ISC DNSSEC lookaside validation zone ("dlv\&.isc\&.org")\&. Records returned by \fBdelv\fR -are either fully validated or were not signed. If validation fails, an explanation of the failure is included in the output; the validation process can be traced in detail. Because +are either fully validated or were not signed\&. If validation fails, an explanation of the failure is included in the output; the validation process can be traced in detail\&. Because \fBdelv\fR -does not rely on an external server to carry out validation, it can be used to check the validity of DNS responses in environments where local name servers may not be trustworthy. +does not rely on an external server to carry out validation, it can be used to check the validity of DNS responses in environments where local name servers may not be trustworthy\&. .PP Unless it is told to query a specific name server, \fBdelv\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, \fBdelv\fR -will send queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6). +will send queries to the localhost addresses (127\&.0\&.0\&.1 for IPv4, ::1 for IPv6)\&. .PP When no command line arguments or options are given, \fBdelv\fR -will perform an NS query for "." (the root zone). +will perform an NS query for "\&." (the root zone)\&. .SH "SIMPLE USAGE" .PP A typical invocation of \fBdelv\fR looks like: .sp +.if n \{\ .RS 4 +.\} .nf delv @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, \fBdelv\fR resolves that name before querying that name server (note, however, that this initial lookup is \fInot\fR -validated by DNSSEC). +validated by DNSSEC)\&. .sp If no \fIserver\fR argument is provided, \fBdelv\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, \fBdelv\fR -will send queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6). +will send queries to the localhost addresses (127\&.0\&.0\&.1 for IPv4, ::1 for IPv6)\&. .RE .PP \fBname\fR .RS 4 -is the domain name to be looked up. +is the domain name to be looked up\&. .RE .PP \fBtype\fR .RS 4 -indicates what type of query is required \(em ANY, A, MX, etc. +indicates what type of query is required \(em ANY, A, MX, etc\&. \fItype\fR -can be any valid query type. If no +can be any valid query type\&. If no \fItype\fR argument is supplied, \fBdelv\fR -will perform a lookup for an A record. +will perform a lookup for an A record\&. .RE .SH "OPTIONS" .PP \-a \fIanchor\-file\fR .RS 4 -Specifies a file from which to read DNSSEC trust anchors. The default is -\fI/etc/bind.keys\fR, which is included with +Specifies a file from which to read DNSSEC trust anchors\&. The default is +/etc/bind\&.keys, which is included with BIND -9 and contains trust anchors for the root zone (".") and for the ISC DNSSEC lookaside validation zone ("dlv.isc.org"). +9 and contains trust anchors for the root zone ("\&.") and for the ISC DNSSEC lookaside validation zone ("dlv\&.isc\&.org")\&. .sp Keys that do not match the root or DLV trust\-anchor names are ignored; these key names can be overridden using the \fB+dlv=NAME\fR or \fB+root=NAME\fR -options. +options\&. .sp Note: When reading the trust anchor file, \fBdelv\fR @@ -138,206 +157,206 @@ treats \fBmanaged\-keys\fR statements and \fBtrusted\-keys\fR -statements identically. That is, for a managed key, it is the +statements identically\&. That is, for a managed key, it is the \fIinitial\fR -key that is trusted; RFC 5011 key management is not supported. +key that is trusted; RFC 5011 key management is not supported\&. \fBdelv\fR will not consult the managed\-keys database maintained by -\fBnamed\fR. This means that if either of the keys in -\fI/etc/bind.keys\fR +\fBnamed\fR\&. This means that if either of the keys in +/etc/bind\&.keys is revoked and rolled over, it will be necessary to update -\fI/etc/bind.keys\fR +/etc/bind\&.keys to use DNSSEC validation in -\fBdelv\fR. +\fBdelv\fR\&. .RE .PP \-b \fIaddress\fR .RS 4 Sets the source IP address of the query to -\fIaddress\fR. This must be a valid address on one of the host's network interfaces or "0.0.0.0" or "::". An optional source port may be specified by appending "#" +\fIaddress\fR\&. This must be a valid address on one of the host\*(Aqs network interfaces or "0\&.0\&.0\&.0" or "::"\&. An optional source port may be specified by appending "#" .RE .PP \-c \fIclass\fR .RS 4 -Sets the query class for the requested data. Currently, only class "IN" is supported in +Sets the query class for the requested data\&. Currently, only class "IN" is supported in \fBdelv\fR -and any other value is ignored. +and any other value is ignored\&. .RE .PP \-d \fIlevel\fR .RS 4 Set the systemwide debug level to -\fBlevel\fR. The allowed range is from 0 to 99. The default is 0 (no debugging). Debugging traces from +\fBlevel\fR\&. The allowed range is from 0 to 99\&. The default is 0 (no debugging)\&. Debugging traces from \fBdelv\fR -become more verbose as the debug level increases. See the +become more verbose as the debug level increases\&. See the \fB+mtrace\fR, \fB+rtrace\fR, and \fB+vtrace\fR -options below for additional debugging details. +options below for additional debugging details\&. .RE .PP \-h .RS 4 Display the \fBdelv\fR -help usage output and exit. +help usage output and exit\&. .RE .PP \-i .RS 4 -Insecure mode. This disables internal DNSSEC validation. (Note, however, this does not set the CD bit on upstream queries. If the server being queried is performing DNSSEC validation, then it will not return invalid data; this can cause +Insecure mode\&. This disables internal DNSSEC validation\&. (Note, however, this does not set the CD bit on upstream queries\&. If the server being queried is performing DNSSEC validation, then it will not return invalid data; this can cause \fBdelv\fR -to time out. When it is necessary to examine invalid data to debug a DNSSEC problem, use -\fBdig +cd\fR.) +to time out\&. When it is necessary to examine invalid data to debug a DNSSEC problem, use +\fBdig +cd\fR\&.) .RE .PP \-m .RS 4 -Enables memory usage debugging. +Enables memory usage debugging\&. .RE .PP \-p \fIport#\fR .RS 4 -Specifies a destination port to use for queries instead of the standard DNS port number 53. This option would be used with a name server that has been configured to listen for queries on a non\-standard port number. +Specifies a destination port to use for queries instead of the standard DNS port number 53\&. This option would be used with a name server that has been configured to listen for queries on a non\-standard port number\&. .RE .PP \-q \fIname\fR .RS 4 Sets the query name to -\fIname\fR. While the query name can be specified without using the -\fB\-q\fR, it is sometimes necessary to disambiguate names from types or classes (for example, when looking up the name "ns", which could be misinterpreted as the type NS, or "ch", which could be misinterpreted as class CH). +\fIname\fR\&. While the query name can be specified without using the +\fB\-q\fR, it is sometimes necessary to disambiguate names from types or classes (for example, when looking up the name "ns", which could be misinterpreted as the type NS, or "ch", which could be misinterpreted as class CH)\&. .RE .PP \-t \fItype\fR .RS 4 Sets the query type to -\fItype\fR, which can be any valid query type supported in BIND 9 except for zone transfer types AXFR and IXFR. As with -\fB\-q\fR, this is useful to distinguish query name type or class when they are ambiguous. it is sometimes necessary to disambiguate names from types. +\fItype\fR, which can be any valid query type supported in BIND 9 except for zone transfer types AXFR and IXFR\&. As with +\fB\-q\fR, this is useful to distinguish query name type or class when they are ambiguous\&. it is sometimes necessary to disambiguate names from types\&. .sp The default query type is "A", unless the \fB\-x\fR -option is supplied to indicate a reverse lookup, in which case it is "PTR". +option is supplied to indicate a reverse lookup, in which case it is "PTR"\&. .RE .PP \-v .RS 4 Print the \fBdelv\fR -version and exit. +version and exit\&. .RE .PP \-x \fIaddr\fR .RS 4 -Performs a reverse lookup, mapping an addresses to a name. +Performs a reverse lookup, mapping an addresses to a name\&. \fIaddr\fR -is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address. When +is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address\&. When \fB\-x\fR is used, there is no need to provide the \fIname\fR or \fItype\fR -arguments. +arguments\&. \fBdelv\fR automatically performs a lookup for a name like -11.12.13.10.in\-addr.arpa -and sets the query type to PTR. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. +11\&.12\&.13\&.10\&.in\-addr\&.arpa +and sets the query type to PTR\&. IPv6 addresses are looked up using nibble format under the IP6\&.ARPA domain\&. .RE .PP \-4 .RS 4 Forces \fBdelv\fR -to only use IPv4. +to only use IPv4\&. .RE .PP \-6 .RS 4 Forces \fBdelv\fR -to only use IPv6. +to only use IPv6\&. .RE .SH "QUERY OPTIONS" .PP \fBdelv\fR -provides a number of query options which affect the way results are displayed, and in some cases the way lookups are performed. +provides a number of query options which affect the way results are displayed, and in some cases the way lookups are performed\&. .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. The query options are: +to negate the meaning of that keyword\&. Other keywords assign values to options like the timeout interval\&. They have the form +\fB+keyword=value\fR\&. The query options are: .PP \fB+[no]cdflag\fR .RS 4 Controls whether to set the CD (checking disabled) bit in queries sent by -\fBdelv\fR. This may be useful when troubleshooting DNSSEC problems from behind a validating resolver. A validating resolver will block invalid responses, making it difficult to retrieve them for analysis. Setting the CD flag on queries will cause the resolver to return invalid responses, which +\fBdelv\fR\&. This may be useful when troubleshooting DNSSEC problems from behind a validating resolver\&. A validating resolver will block invalid responses, making it difficult to retrieve them for analysis\&. Setting the CD flag on queries will cause the resolver to return invalid responses, which \fBdelv\fR -can then validate internally and report the errors in detail. +can then validate internally and report the errors in detail\&. .RE .PP \fB+[no]class\fR .RS 4 -Controls whether to display the CLASS when printing a record. The default is to display the CLASS. +Controls whether to display the CLASS when printing a record\&. The default is to display the CLASS\&. .RE .PP \fB+[no]ttl\fR .RS 4 -Controls whether to display the TTL when printing a record. The default is to display the TTL. +Controls whether to display the TTL when printing a record\&. The default is to display the TTL\&. .RE .PP \fB+[no]rtrace\fR .RS 4 -Toggle resolver fetch logging. This reports the name and type of each query sent by +Toggle resolver fetch logging\&. This reports the name and type of each query sent by \fBdelv\fR -in the process of carrying out the resolution and validation process: this includes including the original query and all subsequent queries to follow CNAMEs and to establish a chain of trust for DNSSEC validation. +in the process of carrying out the resolution and validation process: this includes including the original query and all subsequent queries to follow CNAMEs and to establish a chain of trust for DNSSEC validation\&. .sp -This is equivalent to setting the debug level to 1 in the "resolver" logging category. Setting the systemwide debug level to 1 using the +This is equivalent to setting the debug level to 1 in the "resolver" logging category\&. Setting the systemwide debug level to 1 using the \fB\-d\fR -option will product the same output (but will affect other logging categories as well). +option will product the same output (but will affect other logging categories as well)\&. .RE .PP \fB+[no]mtrace\fR .RS 4 -Toggle message logging. This produces a detailed dump of the responses received by +Toggle message logging\&. This produces a detailed dump of the responses received by \fBdelv\fR -in the process of carrying out the resolution and validation process. +in the process of carrying out the resolution and validation process\&. .sp -This is equivalent to setting the debug level to 10 for the "packets" module of the "resolver" logging category. Setting the systemwide debug level to 10 using the +This is equivalent to setting the debug level to 10 for the "packets" module of the "resolver" logging category\&. Setting the systemwide debug level to 10 using the \fB\-d\fR -option will produce the same output (but will affect other logging categories as well). +option will produce the same output (but will affect other logging categories as well)\&. .RE .PP \fB+[no]vtrace\fR .RS 4 -Toggle validation logging. This shows the internal process of the validator as it determines whether an answer is validly signed, unsigned, or invalid. +Toggle validation logging\&. This shows the internal process of the validator as it determines whether an answer is validly signed, unsigned, or invalid\&. .sp -This is equivalent to setting the debug level to 3 for the "validator" module of the "dnssec" logging category. Setting the systemwide debug level to 3 using the +This is equivalent to setting the debug level to 3 for the "validator" module of the "dnssec" logging category\&. Setting the systemwide debug level to 3 using the \fB\-d\fR -option will produce the same output (but will affect other logging categories as well). +option will produce the same output (but will affect other logging categories as well)\&. .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]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]rrcomments\fR .RS 4 -Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records). The default is to print per\-record comments. +Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records)\&. The default is to print per\-record comments\&. .RE .PP \fB+[no]crypto\fR .RS 4 -Toggle the display of cryptographic fields in DNSSEC records. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures. The default is to display the fields. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]". +Toggle the display of cryptographic fields in DNSSEC records\&. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures\&. The default is to display the fields\&. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e\&.g\&. "[ key id = value ]"\&. .RE .PP \fB+[no]trust\fR .RS 4 -Controls whether to display the trust level when printing a record. The default is to display the trust level. +Controls whether to display the trust level when printing a record\&. The default is to display the trust level\&. .RE .PP \fB+[no]split[=W]\fR @@ -346,11 +365,11 @@ 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]all\fR @@ -359,54 +378,54 @@ Set or clear the display options \fB+[no]comments\fR, \fB+[no]rrcomments\fR, and \fB+[no]trust\fR -as a group. +as a group\&. .RE .PP \fB+[no]multiline\fR .RS 4 -Print long records (such as RRSIG, DNSKEY, and SOA records) in a verbose multi\-line format with human\-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the +Print long records (such as RRSIG, DNSKEY, and SOA records) in a verbose multi\-line format with human\-readable comments\&. The default is to print each record on a single line, to facilitate machine parsing of the \fBdelv\fR -output. +output\&. .RE .PP \fB+[no]dnssec\fR .RS 4 Indicates whether to display RRSIG records in the \fBdelv\fR -output. The default is to do so. Note that (unlike in +output\&. The default is to do so\&. Note that (unlike in \fBdig\fR) this does \fInot\fR -control whether to request DNSSEC records or whether to validate them. DNSSEC records are always requested, and validation will always occur unless suppressed by the use of +control whether to request DNSSEC records or whether to validate them\&. DNSSEC records are always requested, and validation will always occur unless suppressed by the use of \fB\-i\fR or \fB+noroot\fR and -\fB+nodlv\fR. +\fB+nodlv\fR\&. .RE .PP \fB+[no]root[=ROOT]\fR .RS 4 -Indicates whether to perform conventional (non\-lookaside) DNSSEC validation, and if so, specifies the name of a trust anchor. The default is to validate using a trust anchor of "." (the root zone), for which there is a built\-in key. If specifying a different trust anchor, then +Indicates whether to perform conventional (non\-lookaside) DNSSEC validation, and if so, specifies the name of a trust anchor\&. The default is to validate using a trust anchor of "\&." (the root zone), for which there is a built\-in key\&. If specifying a different trust anchor, then \fB\-a\fR -must be used to specify a file containing the key. +must be used to specify a file containing the key\&. .RE .PP \fB+[no]dlv[=DLV]\fR .RS 4 -Indicates whether to perform DNSSEC lookaside validation, and if so, specifies the name of the DLV trust anchor. The default is to perform lookaside validation using a trust anchor of "dlv.isc.org", for which there is a built\-in key. If specifying a different name, then +Indicates whether to perform DNSSEC lookaside validation, and if so, specifies the name of the DLV trust anchor\&. The default is to perform lookaside validation using a trust anchor of "dlv\&.isc\&.org", for which there is a built\-in key\&. If specifying a different name, then \fB\-a\fR -must be used to specify a file containing the DLV key. +must be used to specify a file containing the DLV key\&. .RE .PP \fB+[no]tcp\fR .RS 4 -Controls whether to use TCP when sending queries. The default is to use UDP unless a truncated response has been received. +Controls whether to use TCP when sending queries\&. The default is to use UDP unless a truncated response has been received\&. .RE .SH "FILES" .PP -\fI/etc/bind.keys\fR +/etc/bind\&.keys .PP -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf .SH "SEE ALSO" .PP \fBdig\fR(1), @@ -415,7 +434,11 @@ RFC4034, RFC4035, RFC4431, RFC5074, -RFC5155. +RFC5155\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/delv/delv.html b/bin/delv/delv.html index 6f2cf1c709..3983856b0c 100644 --- a/bin/delv/delv.html +++ b/bin/delv/delv.html @@ -14,35 +14,79 @@ - PERFORMANCE OF THIS SOFTWARE. --> - delv - + -
+
-
+ + + + + +

Name

-

delv — DNS lookup and validation utility

+

+ delv + — DNS lookup and validation utility +

-
+ + + +

Synopsis

-

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

-

delv [-h]

-

delv [-v]

-

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

-
-
-

DESCRIPTION

-

delv +

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

+ +

+ delv + [-h] +

+ +

+ delv + [-v] +

+ +

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

+
+ +
+

DESCRIPTION

+ +

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

-

- delv will send to a specified name server all +

+ delv will send to a specified name server all queries needed to fetch and validate the requested data; this includes the original requested query, subsequent queries to follow CNAME or DNAME chains, and queries for DNSKEY, DS and DLV records @@ -51,36 +95,39 @@ behavior of a name server configured for DNSSEC validating and forwarding.

-

+

By default, responses are validated using built-in DNSSEC trust anchors for the root zone (".") and for the ISC DNSSEC lookaside validation zone ("dlv.isc.org"). Records returned by - delv are either fully validated or + delv are either fully validated or were not signed. If validation fails, an explanation of the failure is included in the output; the validation process - can be traced in detail. Because delv does + can be traced in detail. Because delv does not rely on an external server to carry out validation, it can be used to check the validity of DNS responses in environments where local name servers may not be trustworthy.

-

+

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

-

+

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

-
-
-

SIMPLE USAGE

-

- A typical invocation of delv looks like: +

+ +
+

SIMPLE USAGE

+ + +

+ A typical invocation of delv looks like: 

 delv @server name type

@@ -90,143 +137,166 @@

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, - delv resolves that name before + delv resolves that name before querying that name server (note, however, that this initial lookup is not validated by DNSSEC).

-

+

If no server argument is - provided, delv consults + provided, delv 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, - delv will send queries to + delv will send queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6).

-
+
name
-

+

+

is the domain name to be looked up. -

+

+
type
-

+

+

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

+

+

-
-
-

OPTIONS

-
+ +
+ +
+

OPTIONS

+ +
-a anchor-file
-

+

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

-

+

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

-

+

Note: When reading the trust anchor file, - delv treats managed-keys + delv treats managed-keys statements and trusted-keys statements identically. That is, for a managed key, it is the initial key that is trusted; RFC 5011 - key management is not supported. delv + key management is not supported. delv will not consult the managed-keys database maintained by - named. This means that if either of the + named. This means that if either of the keys in /etc/bind.keys is revoked and rolled over, it will be necessary to update /etc/bind.keys to use DNSSEC - validation in delv. + validation in delv.

-
+
-b address
-

+

+

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

+

+
-c class
-

+

+

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

+

+
-d level
-

+

+

Set the systemwide debug level to level. The allowed range is from 0 to 99. The default is 0 (no debugging). - Debugging traces from delv become + Debugging traces from delv become more verbose as the debug level increases. See the +mtrace, +rtrace, and +vtrace options below for additional debugging details. -

+

+
-h
-

- Display the delv help usage output and exit. -

+
+

+ Display the delv help usage output and exit. +

+
-i
-

+

+

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

+ problem, use dig +cd.) +

+
-m
-

+

+

Enables memory usage debugging. -

+

+
-p port#
-

+

+

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

+

+
-q name
-

+

+

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

+

+
-t type
-

+

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

-

+

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

-
+
-v
-

- Print the delv version and exit. -

+
+

+ Print the delv version and exit. +

+
-x addr
-

+

+

Performs a reverse lookup, mapping an addresses to a name. addr is an IPv4 address in dotted-decimal notation, or a colon-delimited IPv6 address. When -x is used, there is no need to provide the name or type - arguments. delv automatically performs a + arguments. delv automatically performs a lookup for a name like 11.12.13.10.in-addr.arpa and sets the query type to PTR. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. -

+

+
-4
-

- Forces delv to only use IPv4. -

+
+

+ Forces delv to only use IPv4. +

+
-6
-

- Forces delv to only use IPv6. -

+
+

+ Forces delv to only use IPv6. +

+
-
-
-

QUERY OPTIONS

-

delv +

+ +
+

QUERY OPTIONS

+ + +

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

-

+ +

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

+[no]cdflag
-

+

+

Controls whether to set the CD (checking disabled) bit in - queries sent by delv. This may be useful + queries sent by delv. This may be useful when troubleshooting DNSSEC problems from behind a validating resolver. A validating resolver will block invalid responses, making it difficult to retrieve them for analysis. Setting the CD flag on queries will cause the resolver to return - invalid responses, which delv can then + invalid responses, which delv can then validate internally and report the errors in detail. -

+

+
+[no]class
-

+

+

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

+

+
+[no]ttl
-

+

+

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

+

+
+[no]rtrace
-

+

Toggle resolver fetch logging. This reports the - name and type of each query sent by delv + name and type of each query sent by delv in the process of carrying out the resolution and validation process: this includes including the original query and all subsequent queries to follow CNAMEs and to establish a chain of trust for DNSSEC validation.

-

+

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

-
+
+[no]mtrace
-

+

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

-

+

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

-
+
+[no]vtrace
-

+

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

-

+

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

-
+
+[no]short
-

+

+

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

+

+
+[no]comments
-

+

+

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

+

+
+[no]rrcomments
-

+

+

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

+

+
+[no]crypto
-

+

+

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

+

+
+[no]trust
-

+

+

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

+

+
+[no]split[=W]
-

+

+

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

+

+
+[no]all
-

+

+

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

+

+
+[no]multiline
-

+

+

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

+

+
+[no]dnssec
-

+

+

Indicates whether to display RRSIG records in the - delv output. The default is to - do so. Note that (unlike in dig) + delv output. The default is to + do so. Note that (unlike in dig) this does not control whether to request DNSSEC records or whether to validate them. DNSSEC records are always requested, and validation will always occur unless suppressed by the use of -i or +noroot and +nodlv. -

+

+
+[no]root[=ROOT]
-

+

+

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

+

+
+[no]dlv[=DLV]
-

+

+

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

+

+
+[no]tcp
-

+

+

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

+

+

-
-
-

FILES

-

/etc/bind.keys

-

/etc/resolv.conf

-
-
-

SEE ALSO

-

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

+ +
+

FILES

+ +

/etc/bind.keys

+

/etc/resolv.conf

+
+ +
+

SEE ALSO

+ +

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

-
+
+
diff --git a/bin/dig/dig.1 b/bin/dig/dig.1 index f06b943d91..e45c77bc78 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 19, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-02-19 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DIG" "1" "February 19, 2014" "BIND9" "BIND9" +.TH "DIG" "1" "2014\-02\-19" "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,110 +278,110 @@ 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]badcookie\fR .RS 4 -Retry lookup with the new server cookie if a BADCOOKIE response is received. +Retry lookup with the new server cookie if a BADCOOKIE response is received\&. .RE .PP \fB+[no]besteffort\fR .RS 4 -Attempt to display the contents of messages which are malformed. The default is to not display malformed answers. +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]cookie\fR\fB[=####]\fR .RS 4 -Send a COOKIE EDNS option, with optional value. Replaying a COOKIE from a previous response will allow the server to identify a previous client. The default is -\fB+cookie\fR. +Send a COOKIE EDNS option, with optional value\&. Replaying a COOKIE from a previous response will allow the server to identify a previous client\&. The default is +\fB+cookie\fR\&. .sp \fB+cookie\fR -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+[no]crypto\fR .RS 4 -Toggle the display of cryptographic fields in DNSSEC records. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures. The default is to display the fields. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]". +Toggle the display of cryptographic fields in DNSSEC records\&. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures\&. The default is to display the fields\&. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e\&.g\&. "[ key id = value ]"\&. .RE .PP \fB+[no]defname\fR @@ -373,7 +392,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 @@ -382,31 +401,31 @@ 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+dscp=value\fR .RS 4 -Set the DSCP code point to be used when sending the query. Valid DSCP code points are in the range [0..63]. By default no code point is explicitly set. +Set the DSCP code point to be used when sending the query\&. Valid DSCP code points are in the range [0\&.\&.63]\&. By default no code point is explicitly set\&. .RE .PP \fB+[no]edns[=#]\fR .RS 4 -Specify the EDNS version to query with. Valid values are 0 to 255. Setting the EDNS version will cause a EDNS query to be sent. +Specify the EDNS version to query with\&. Valid values are 0 to 255\&. Setting the EDNS version will cause a EDNS query to be sent\&. \fB+noedns\fR -clears the remembered EDNS version. EDNS is set to 0 by default. +clears the remembered EDNS version\&. EDNS is set to 0 by default\&. .RE .PP \fB+[no]ednsflags[=#]\fR .RS 4 -Set the must\-be\-zero EDNS flags bits (Z bits) to the specified value. Decimal, hex and octal encodings are accepted. Setting a named flag (e.g. DO) will silently be ignored. By default, no Z bits are set. +Set the must\-be\-zero EDNS flags bits (Z bits) to the specified value\&. Decimal, hex and octal encodings are accepted\&. Setting a named flag (e\&.g\&. DO) will silently be ignored\&. By default, no Z bits are set\&. .RE .PP \fB+[no]ednsnegotiation\fR .RS 4 -Enable / disable EDNS version negotiation. By default EDNS version negotiation is enabled. +Enable / disable EDNS version negotiation\&. By default EDNS version negotiation is enabled\&. .RE .PP \fB+[no]ednsopt[=code[:value]]\fR @@ -415,49 +434,49 @@ Specify EDNS option with code point \fBcode\fR and optionally payload of \fBvalue\fR -as a hexadecimal string. +as a hexadecimal string\&. \fB+noednsopt\fR -clears the EDNS options to be sent. +clears the EDNS options to be sent\&. .RE .PP \fB+[no]expire\fR .RS 4 -Send an EDNS Expire option. +Send an EDNS Expire option\&. .RE .PP \fB+[no]fail\fR .RS 4 -Do not try the next server if you receive a SERVFAIL. The default is to not try the next server which is the reverse of normal stub resolver behavior. +Do not try the next server if you receive a SERVFAIL\&. The default is to not try the next server which is the reverse of normal stub resolver behavior\&. .RE .PP \fB+[no]header\-only\fR .RS 4 -Send a query with a DNS header without a question section. The default is to add a question section. The query type and query name are ignored when this is set. +Send a query with a DNS header without a question section\&. The default is to add a question section\&. The query type and query name are ignored when this is set\&. .RE .PP \fB+[no]identify\fR .RS 4 Show [or do not show] the IP address and port number that supplied the answer when the \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 @@ -466,106 +485,106 @@ 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]opcode=value\fR .RS 4 -Set [restore] the DNS message opcode to the specified value. The default value is QUERY (0). +Set [restore] the DNS message opcode to the specified value\&. The default value is QUERY (0)\&. .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 @@ -574,101 +593,101 @@ 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]subnet=addr/prefix\fR .RS 4 -Send an EDNS Client Subnet option with the specified IP address or network prefix. +Send an EDNS Client Subnet option with the specified IP address or network prefix\&. .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+timeout=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]ttlunits\fR .RS 4 -Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks. Implies +ttlid. +Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks\&. Implies +ttlid\&. .RE .PP \fB+[no]vc\fR .RS 4 -Use [do not use] TCP when querying name servers. This alternate syntax to +Use [do not use] TCP when querying name servers\&. This alternate syntax to \fI+[no]tcp\fR -is provided for backwards compatibility. The "vc" stands for "virtual circuit". +is provided for backwards compatibility\&. The "vc" stands for "virtual circuit"\&. .RE .PP \fB+[no]zflag\fR .RS 4 -Set [do not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. +Set [do not set] the last unassigned DNS header flag in a DNS query\&. This flag is off by default\&. .RE .SH "MULTIPLE QUERIES" .PP @@ -676,63 +695,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.html b/bin/dig/dig.html index c88c133df4..3ac4100c77 100644 --- a/bin/dig/dig.html +++ b/bin/dig/dig.html @@ -14,76 +14,126 @@ - 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

@@ -93,116 +143,147 @@

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 +295,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 +313,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 +335,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 @@ -286,20 +378,27 @@

+[no]aaflag
-

+

+

A synonym for +[no]aaonly. -

+

+
+[no]aaonly
-

+

+

Sets the "aa" flag in the query. -

+

+
+[no]additional
-

+

+

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

+

+
+[no]adflag
-

+

+

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

+

+
+[no]all
-

+

+

Set or clear all display flags. -

+

+
+[no]answer
-

+

+

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

+

+
+[no]authority
-

+

+

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

+

+
+[no]badcookie
-

+

+

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

+

+
+[no]besteffort
-

+

+

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

+

+
+bufsize=B
-

+

+

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

+

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

-

- +cookie is also set when +trace +

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

-
+
+[no]crypto
-

+

+

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

+

+
+[no]defname
-

+

+

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

+

+
+[no]dnssec
-

+

+

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

+

+
+domain=somename
-

+

+

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

+

+
+dscp=value
-

+

+

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

+

+
+[no]edns[=#]
-

+

+

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

+

+
+[no]ednsflags[=#]
-

+

+

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

+

+
+[no]ednsnegotiation
-

+

+

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

+

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

+

+

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

+

+
+[no]expire
-

+

+

Send an EDNS Expire option. -

+

+
+[no]fail
-

+

+

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

+

+
+[no]header-only
-

+

+

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

+

+
+[no]identify
-

+

+

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

+

+
+[no]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 @@ -502,102 +655,130 @@ 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]opcode=value
-

+

+

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

+

+
+[no]qr
-

+

+

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

+

+
+[no]question
-

+

+

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

+

+
+[no]rdflag
-

+

+

A synonym for +[no]recurse. -

+

+
+[no]recurse
-

+

+

Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means - dig normally sends recursive + 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 @@ -606,29 +787,37 @@ +split=0 causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active. -

+

+
+[no]stats
-

+

+

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

+

+
+[no]subnet=addr/prefix
-

+

+

Send an EDNS Client Subnet option with the specified IP address or network prefix. -

+

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

+

+
+timeout=T
-

+

+

Sets the timeout for a query to T seconds. The default @@ -636,97 +825,110 @@ 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]ttlunits
-

+

+

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

+

+
+[no]vc
-

+

+

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

+

+
+[no]zflag
-

+

+

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

+

+

-
-
-

MULTIPLE QUERIES

-

- The BIND 9 implementation of dig +

+ +
+

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 @@ -734,7 +936,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 @@ -746,7 +949,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 @@ -754,48 +957,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.

-
+
+
diff --git a/bin/dig/host.1 b/bin/dig/host.1 index 94af9bf82f..1e1378c08f 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.76.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,125 +93,125 @@ 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. Verbose output can also be enabled by setting the +enabled verbose output\&. Verbose output can also be enabled by setting the \fIdebug\fR option in -\fI/etc/resolv.conf\fR. +/etc/resolv\&.conf\&. .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. If +will repeat a query that does not get answered\&. If \fInumber\fR -is negative or zero, the number of retries will default to 1. The default value is 1, or the value of the +is negative or zero, the number of retries will default to 1\&. The default value is 1, or the value of the \fIattempts\fR option in -\fI/etc/resolv.conf\fR, if set. +/etc/resolv\&.conf, if set\&. .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. By default, +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\&. By default, \fBhost\fR -will wait for 5 seconds for UDP responses and 10 seconds for TCP connections. These defaults can be overridden by the +will wait for 5 seconds for UDP responses and 10 seconds for TCP connections\&. These defaults can be overridden by the \fItimeout\fR option in -\fI/etc/resolv.conf\fR. +/etc/resolv\&.conf\&. .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. +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 @@ -204,33 +219,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.html b/bin/dig/host.html index 3a886fab72..67ba9de7b4 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 @@ -82,21 +115,24 @@ debug option in /etc/resolv.conf.

-

+ +

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 @@ -108,11 +144,12 @@ 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. If number is negative or zero, the @@ -121,104 +158,123 @@ the value of the attempts option in /etc/resolv.conf, if set.

-

+ +

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. By default, host + value for an integer quantity. By default, host will wait for 5 seconds for UDP responses and 10 seconds for TCP connections. These defaults can be overridden by the timeout option in /etc/resolv.conf.

-

- 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..0af9b21acf 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.76.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,62 @@ 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 +121,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 +156,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 +192,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 +208,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 +216,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 +229,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 +240,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.html b/bin/dig/nslookup.html index 96777b3106..0377940582 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. -

    2. +

      +
      3. +
    3. +

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

      4. +

      +

    -

    + +

    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 2a7c00cc51..35002e7144 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 02, 2012 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2012-05-02 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-DSFROMKEY" "8" "May 02, 2012" "BIND9" "BIND9" +.TH "DNSSEC\-DSFROMKEY" "8" "2012\-05\-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\-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 ZSKs when generating DS records. Without this option, only keys which have the KSK flag set will be converted to DS records and printed. Useful only in zone file mode. +Include ZSKs when generating DS records\&. Without this option, only keys which have the KSK flag set will be converted to DS records and printed\&. Useful only in 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 a75d2054ad..5911d49458 100644 --- a/bin/dnssec/dnssec-dsfromkey.docbook +++ b/bin/dnssec/dnssec-dsfromkey.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/dnssec/dnssec-dsfromkey.html b/bin/dnssec/dnssec-dsfromkey.html index fbb6c513b0..e71cb094e1 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 ZSKs when generating DS records. Without this option, only keys which have the KSK flag set will be converted to DS records and printed. Useful only in 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 c76446a542..f4fc82490c 100644 --- a/bin/dnssec/dnssec-importkey.8 +++ b/bin/dnssec/dnssec-importkey.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\-importkey +'\" t +.\" Title: dnssec-importkey .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: February 20, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-02-20 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-IMPORTKEY" "8" "February 20, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-IMPORTKEY" "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" -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 b6dbb069ae..aa3a1079b4 100644 --- a/bin/dnssec/dnssec-importkey.docbook +++ b/bin/dnssec/dnssec-importkey.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/dnssec/dnssec-importkey.html b/bin/dnssec/dnssec-importkey.html index 90f13f295b..0b8aff252d 100644 --- a/bin/dnssec/dnssec-importkey.html +++ b/bin/dnssec/dnssec-importkey.html @@ -14,27 +14,60 @@ - PERFORMANCE OF THIS SOFTWARE. --> - 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 +75,7 @@ from the standard input, in which case both .key and .private files will be generated.

-

+

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

-
-
-

OPTIONS

-
+
+ +
+

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

-
+ +
-P date/offset
-

+

+

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

+

+
-D date/offset
-

+

+

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

+

+
-
-
-

FILES

-

+

+ +
+

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 26cdf00690..88d88821ed 100644 --- a/bin/dnssec/dnssec-keyfromlabel.8 +++ b/bin/dnssec/dnssec-keyfromlabel.8 @@ -12,252 +12,292 @@ .\" 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.76.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 cryptographic hardware to use. +Specifies the cryptographic hardware to use\&. .sp -When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11". +When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. .RE .PP \-l \fIlabel\fR .RS 4 -Specifies the label for a key pair in the crypto hardware. +Specifies the label for a key pair in the crypto hardware\&. .sp When BIND -9 is built with OpenSSL\-based PKCS#11 support, the label is an arbitrary string that identifies a particular key. It may be preceded by an optional OpenSSL engine name, followed by a colon, as in "pkcs11:\fIkeylabel\fR". +9 is built with OpenSSL\-based PKCS#11 support, the label is an arbitrary string that identifies a particular key\&. It may be preceded by an optional OpenSSL engine name, followed by a colon, as in "pkcs11:\fIkeylabel\fR"\&. .sp When BIND -9 is built with native PKCS#11 support, the label is a PKCS#11 URI string in the format "pkcs11:\fBkeyword\fR=\fIvalue\fR[;\fBkeyword\fR=\fIvalue\fR;...]" Keywords include "token", which identifies the HSM; "object", which identifies the key; and "pin\-source", which identifies a file from which the HSM's PIN code can be obtained. The label will be stored in the on\-disk "private" file. +9 is built with native PKCS#11 support, the label is a PKCS#11 URI string in the format "pkcs11:\fBkeyword\fR=\fIvalue\fR[;\fBkeyword\fR=\fIvalue\fR;\&.\&.\&.]" Keywords include "token", which identifies the HSM; "object", which identifies the key; and "pin\-source", which identifies a file from which the HSM\*(Aqs PIN code can be obtained\&. The label will be stored in the on\-disk "private" file\&. .sp If the label contains a \fBpin\-source\fR -field, tools using the generated key files will be able to use the HSM for signing and other operations without any need for an operator to manually enter a PIN. Note: Making the HSM's PIN accessible in this manner may reduce the security advantage of using an HSM; be sure this is what you want to do before making use of this feature. +field, tools using the generated key files will be able to use the HSM for signing and other operations without any need for an operator to manually enter a PIN\&. Note: Making the HSM\*(Aqs PIN accessible in this manner may reduce the security advantage of using an HSM; be sure this is what you want to do before making use of this feature\&. .RE .PP \-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, -The PKCS#11 URI Scheme (draft\-pechanec\-pkcs11uri\-13). +The PKCS#11 URI Scheme (draft\-pechanec\-pkcs11uri\-13)\&. .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 6944930d4c..4c6413e38e 100644 --- a/bin/dnssec/dnssec-keyfromlabel.docbook +++ b/bin/dnssec/dnssec-keyfromlabel.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/dnssec/dnssec-keyfromlabel.html b/bin/dnssec/dnssec-keyfromlabel.html index ec99942033..f484c5a675 100644 --- a/bin/dnssec/dnssec-keyfromlabel.html +++ b/bin/dnssec/dnssec-keyfromlabel.html @@ -13,79 +13,122 @@ - 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 cryptographic hardware to use.

-

+

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

-
+
-l label
-

+

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

-

+

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

-

+

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

-

+

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

-
+
-n nametype
-

+

+

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

+

+
-C
-

+

+

Compatibility mode: generates an old-style key, without - any metadata. By default, dnssec-keyfromlabel + 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 @@ -197,35 +261,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 @@ -236,42 +312,53 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

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

+

+
-A date/offset
-

+

+

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

+

+
-R date/offset
-

+

+

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

+

+
-I date/offset
-

+

+

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

+

+
-D date/offset
-

+

+

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

+

+
-i interval
-

+

Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the @@ -280,73 +367,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, The PKCS#11 URI Scheme (draft-pechanec-pkcs11uri-13).

-
-
-

AUTHOR

-

Internet Systems Consortium -

-
+
+
diff --git a/bin/dnssec/dnssec-keygen.8 b/bin/dnssec/dnssec-keygen.8 index c97130a3d8..2204fcd5cc 100644 --- a/bin/dnssec/dnssec-keygen.8 +++ b/bin/dnssec/dnssec-keygen.8 @@ -13,303 +13,343 @@ .\" 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 06, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-02-06 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-KEYGEN" "8" "February 06, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-KEYGEN" "8" "2014\-02\-06" "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 (ZSKs) and 2048 bits for key signing keys (KSKs, 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 (ZSKs) and 2048 bits for key signing keys (KSKs, generated with +\fB\-f KSK\fR)\&. However, if an algorithm is explicitly specified with the \fB\-a\fR, then there is no default key size, and the \fB\-b\fR -must be used. +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 -Specifies the cryptographic hardware to use, when applicable. +Specifies the cryptographic hardware to use, when applicable\&. .sp -When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11". +When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. .RE .PP \-f \fIflag\fR .RS 4 -Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE. +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 c751e43e0b..3a20294c95 100644 --- a/bin/dnssec/dnssec-keygen.docbook +++ b/bin/dnssec/dnssec-keygen.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/dnssec/dnssec-keygen.html b/bin/dnssec/dnssec-keygen.html index 88c02a6b88..2a10f67878 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 (ZSKs) and 2048 bits for key signing keys (KSKs, @@ -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,37 +155,44 @@ 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
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

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

-
+
-f flag
-

+

+

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

+

+
-G
-

+

+

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

+

+
-g generator
-

+

+

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

+

+
-h
-

+

+

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

+ dnssec-keygen. +

+
-K directory
-

+

+

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

+

+
-k
-

+

+

Deprecated in favor of -T KEY. -

+

+
-L ttl
-

+

+

Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was @@ -186,19 +254,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 @@ -207,9 +279,11 @@ round of the Miller-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key. -

+

+
-r randomdev
-

+

+

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

+

+
-S key
-

+

+

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

+

+
-s strength
-

+

+

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

+

+
-T rrtype
-

+

Specifies the resource record type to use for the key. rrtype must be either DNSKEY or KEY. The default is DNSKEY when using a DNSSEC algorithm, but it can be @@ -250,27 +329,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 @@ -281,44 +369,55 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'.

-
+ +
-P date/offset
-

+

+

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

+

+
-A date/offset
-

+

+

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

+

+
-R date/offset
-

+

+

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

+

+
-I date/offset
-

+

+

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

+

+
-D date/offset
-

+

+

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

+

+
-i interval
-

+

Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the @@ -327,42 +426,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 @@ -370,58 +478,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 0d70162ffb..28f60aff27 100644 --- a/bin/dnssec/dnssec-revoke.8 +++ b/bin/dnssec/dnssec-revoke.8 @@ -12,84 +12,100 @@ .\" 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 +'\" t +.\" Title: dnssec-revoke .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: January 15, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-01-15 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-REVOKE" "8" "January 15, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-REVOKE" "8" "2014\-01\-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" -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 -Specifies the cryptographic hardware to use, when applicable. +Specifies the cryptographic hardware to use, when applicable\&. .sp -When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11". +When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. .RE .PP \-f .RS 4 Force overwrite: Causes \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. +RFC 5011\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .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 b058725a1d..46e5867739 100644 --- a/bin/dnssec/dnssec-revoke.docbook +++ b/bin/dnssec/dnssec-revoke.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/dnssec/dnssec-revoke.html b/bin/dnssec/dnssec-revoke.html index 54c01f0aea..b4038cdb99 100644 --- a/bin/dnssec/dnssec-revoke.html +++ b/bin/dnssec/dnssec-revoke.html @@ -13,61 +13,96 @@ - 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
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

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

-
+
-f
-

- Force overwrite: Causes dnssec-revoke to +

+

+ 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 5068f356c0..873a4fc3d1 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 06, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-02-06 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-SETTIME" "8" "February 06, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-SETTIME" "8" "2014\-02\-06" "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,116 +57,116 @@ 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 -Specifies the cryptographic hardware to use, when applicable. +Specifies the cryptographic hardware to use, when applicable\&. .sp -When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11". +When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. .RE .SH "TIMING OPTIONS" .PP -Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' 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 @@ -165,18 +180,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 44933aa0ed..66c1663eb4 100644 --- a/bin/dnssec/dnssec-settime.docbook +++ b/bin/dnssec/dnssec-settime.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/dnssec/dnssec-settime.html b/bin/dnssec/dnssec-settime.html index 62fdad7dae..71e030baf2 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,25 +119,32 @@ is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to 0 or none removes it from the key. -

+

+
-h
-

+

+

Emit usage message and exit. -

+

+
-V
-

+

+

Prints version information. -

+

+
-v level
-

+

+

Sets the debugging level. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

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

-
+
-
-
-

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

-
+ +
-P date/offset
-

+

+

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

+

+
-A date/offset
-

+

+

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

+

+
-R date/offset
-

+

+

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

+

+
-I date/offset
-

+

+

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

+

+
-D date/offset
-

+

+

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

+

+
-S predecessor key
-

+

+

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

+

+
-i interval
-

+

Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the @@ -177,34 +234,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: @@ -215,21 +278,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 4e14edf5d5..a3fae4e5e6 100644 --- a/bin/dnssec/dnssec-signzone.8 +++ b/bin/dnssec/dnssec-signzone.8 @@ -13,459 +13,479 @@ .\" 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: February 18, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-02-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-SIGNZONE" "8" "February 18, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-SIGNZONE" "8" "2014\-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" -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\-M\ \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\-Q\fR] [\fB\-R\fR] [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] [\fB\-S\fR] [\fB\-s\ \fR\fB\fIstart\-time\fR\fR] [\fB\-T\ \fR\fB\fIttl\fR\fR] [\fB\-t\fR] [\fB\-u\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-X\ \fR\fB\fIextended\ end\-time\fR\fR] [\fB\-x\fR] [\fB\-z\fR] [\fB\-3\ \fR\fB\fIsalt\fR\fR] [\fB\-H\ \fR\fB\fIiterations\fR\fR] [\fB\-A\fR] {zonefile} [key...] .SH "DESCRIPTION" .PP \fBdnssec\-signzone\fR -signs a zone. It generates NSEC and RRSIG records and produces a signed version of the zone. The security status of delegations from the signed zone (that is, whether the child zones are secure or not) is determined by the presence or absence of a -\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, -\fB\-O map\fR, or serial number updating. +\fB\-O map\fR, or serial number updating\&. .RE .PP \-E \fIengine\fR .RS 4 -When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing. +When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing\&. .sp -When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11". +When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. .RE .PP \-g .RS 4 Generate DS records for child zones from -\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 \-M \fImaxttl\fR .RS 4 -Sets the maximum TTL for the signed zone. Any TTL higher than +Sets the maximum TTL for the signed zone\&. Any TTL higher than \fImaxttl\fR in the input zone will be reduced to \fImaxttl\fR -in the output. This provides certainty as to the largest possible TTL in the signed zone, which is useful to know when rolling keys because it is the longest possible time before signatures that have been retrieved by resolvers will expire from resolver caches. Zones that are signed with this option should be configured to use a matching +in the output\&. This provides certainty as to the largest possible TTL in the signed zone, which is useful to know when rolling keys because it is the longest possible time before signatures that have been retrieved by resolvers will expire from resolver caches\&. Zones that are signed with this option should be configured to use a matching \fBmax\-zone\-ttl\fR in -\fInamed.conf\fR. (Note: This option is incompatible with -\fB\-D\fR, because it modifies non\-DNSSEC data in the output zone.) +named\&.conf\&. (Note: This option is incompatible with +\fB\-D\fR, because it modifies non\-DNSSEC data in the output zone\&.) .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), \fB"raw"\fR, and -\fB"map"\fR. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be signed directly. The use of this option does not make much sense for non\-dynamic zones. +\fB"map"\fR\&. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be signed directly\&. The use of this option does not make much sense for non\-dynamic zones\&. .RE .PP \-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" or "map" format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) +When writing a signed zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number\&. (This is expected to be used primarily for testing purposes\&.) .RE .PP \-n \fIncpus\fR .RS 4 -Specifies the number of threads to use. By default, one thread is started for each detected CPU. +Specifies the number of threads to use\&. By default, one thread is started for each detected CPU\&. .RE .PP \-N \fIsoa\-serial\-format\fR .RS 4 -The SOA serial number format of the signed zone. Possible formats are +The SOA serial number format of the signed zone\&. Possible formats are \fB"keep"\fR (default), \fB"increment"\fR, \fB"unixtime"\fR, and -\fB"date"\fR. -.RS 4 +\fB"date"\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. +Set the SOA serial number to the number of seconds since epoch\&. .RE .PP \fB"date"\fR .RS 4 -Set the SOA serial number to today's date in YYYYMMDDNN format. -.RE +Set the SOA serial number to today\*(Aqs date in YYYYMMDDNN format\&. .RE .RE .PP \-o \fIorigin\fR .RS 4 -The zone origin. If not specified, the name of the zone file is assumed to be the origin. +The zone origin\&. If not specified, the name of the zone file is assumed to be the origin\&. .RE .PP \-O \fIoutput\-format\fR .RS 4 -The format of the output file containing the signed zone. Possible formats are +The format of the output file containing the signed zone\&. Possible formats are \fB"text"\fR (default), which is the standard textual representation of the zone; \fB"full"\fR, which is text output in a format suitable for processing by external scripts; and \fB"map"\fR, \fB"raw"\fR, and \fB"raw=N"\fR, which store the zone in binary formats 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\-2014 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2003 Internet Software Consortium. +Copyright \(co 2004-2009, 2011-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 81159f4570..89d3da0b42 100644 --- a/bin/dnssec/dnssec-signzone.docbook +++ b/bin/dnssec/dnssec-signzone.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/dnssec/dnssec-signzone.html b/bin/dnssec/dnssec-signzone.html index 87e7eec97d..f9b50060c5 100644 --- a/bin/dnssec/dnssec-signzone.html +++ b/bin/dnssec/dnssec-signzone.html @@ -14,26 +14,80 @@ - 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] [-M domain] [-i interval] [-I input-format] [-j jitter] [-N soa-serial-format] [-o origin] [-O output-format] [-P] [-p] [-Q] [-R] [-r randomdev] [-S] [-s start-time] [-T ttl] [-t] [-u] [-v level] [-V] [-X extended end-time] [-x] [-z] [-3 salt] [-H iterations] [-A] {zonefile} [key...]

-
-
-

DESCRIPTION

-

dnssec-signzone +

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

+
+ +
+

DESCRIPTION

+ +

dnssec-signzone 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,51 +95,64 @@ 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, -O map, or serial number updating. -

+

+
-E engine
-

+

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

-

+

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

-
+
-g
-

+

+

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

+

+
-K directory
-

+

+

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

+

+
-k key
-

+

+

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

+

+
-l domain
-

+

+

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

+

+
-M maxttl
-

+

+

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

+

+
-s start-time
-

+

+

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

+

+
-e end-time
-

+

+

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

+

+
-X extended end-time
-

+

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

-

+

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

-
+
-f output-file
-

+

+

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

+

+
-h
-

+

+

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

+ dnssec-signzone. +

+
-V
-

+

+

Prints version information. -

+

+
-i interval
-

+

When a previously-signed zone is passed as input, records may be resigned. The interval option specifies the cycle interval as an offset from the current @@ -203,32 +290,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), - "raw", and "map". + Possible formats are "text" (default), + "raw", and "map". 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. @@ -239,121 +328,142 @@ expire time, thus spreading incremental signature regeneration over time.

-

+

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

-
+
-L serial
-

+

+

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

+

+
-n ncpus
-

+

+

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

+

+
-N soa-serial-format
-

+

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

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

-
"date"
-

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

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

+
+
"date"
+
+

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

+
-
+ +
-o origin
-

+

+

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

+

+
-O output-format
-

+

+

The format of the output file containing the signed zone. - Possible formats are "text" (default), + Possible formats are "text" (default), which is the standard textual representation of the zone; - "full", which is text output in a + "full", which is text output in a format suitable for processing by external scripts; - and "map", "raw", - and "raw=N", which store the zone in - binary formats for rapid loading by named. - "raw=N" specifies the format version of + and "map", "raw", + and "raw=N", which store the zone in + binary formats for rapid loading 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 + any version of named; if N is 1, the file can be read by release 9.9.0 or higher; the default is 1. -

+

+
-p
-

+

+

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

+

+
-P
-

+

Disable post sign verification tests.

-

+

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

-
+
-Q
-

+

Remove signatures from keys that are no longer active.

-

+

Normally, when a previously-signed zone is passed as input to the signer, and a DNSKEY record has been removed and replaced with a new one, signatures from the old key 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 @@ -363,53 +473,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 @@ -421,100 +543,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.

@@ -522,18 +665,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 1aa3e48d79..ca90259a0d 100644 --- a/bin/dnssec/dnssec-verify.8 +++ b/bin/dnssec/dnssec-verify.8 @@ -12,98 +12,114 @@ .\" 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: January 15, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-01-15 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-VERIFY" "8" "January 15, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-VERIFY" "8" "2014\-01\-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" -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 \-E \fIengine\fR .RS 4 -Specifies the cryptographic hardware to use, when applicable. +Specifies the cryptographic hardware to use, when applicable\&. .sp -When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11". +When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. .RE .PP \-I \fIinput\-format\fR .RS 4 -The format of the input zone file. Possible formats are +The format of the input zone file\&. Possible formats are \fB"text"\fR (default) and -\fB"raw"\fR. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be verified independently. The use of this option does not make much sense for non\-dynamic zones. +\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 08754f0b92..0a673213f7 100644 --- a/bin/dnssec/dnssec-verify.docbook +++ b/bin/dnssec/dnssec-verify.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/dnssec/dnssec-verify.html b/bin/dnssec/dnssec-verify.html index 9988b05567..87b884cb50 100644 --- a/bin/dnssec/dnssec-verify.html +++ b/bin/dnssec/dnssec-verify.html @@ -13,44 +13,72 @@ - 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. -

+

+
-E engine
-

+

Specifies the cryptographic hardware to use, when applicable.

-

+

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

-
+
-I input-format
-

+

+

The format of the input zone file. - Possible formats are "text" (default) - and "raw". + 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 @@ -102,34 +140,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..951472d4f3 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.76.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 2a8273b0ef..037868dab0 100644 --- a/bin/named/lwresd.docbook +++ b/bin/named/lwresd.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/named/lwresd.html b/bin/named/lwresd.html index dc1ebbe85c..463e8ae1c6 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 3ef55ac2ae..bfae930cb6 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 19, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-02-19 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NAMED" "8" "February 19, 2014" "BIND9" "BIND9" +.TH "NAMED" "8" "2014\-02\-19" "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,95 +83,95 @@ 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 \-D \fIstring\fR .RS 4 Specifies a string that is used to identify a instance of \fBnamed\fR -in a process listing. The contents of +in a process listing\&. The contents of \fIstring\fR -are not examined. +are not examined\&. .RE .PP \-E \fIengine\-name\fR .RS 4 -When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing. +When applicable, specifies the hardware to use for cryptographic operations, such as a secure key store used for signing\&. .sp -When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11". +When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&. .RE .PP \-f .RS 4 -Run the server in the foreground (i.e. do not daemonize). +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 \-L \fIlogfile\fR .RS 4 Log to the file \fBlogfile\fR -by default instead of the system log. +by default instead of the system log\&. .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 @@ -166,12 +181,12 @@ Allow \fBnamed\fR to use up to \fI#max\-socks\fR -sockets. The default value is 4096 on systems built with default configuration options, and 21000 on systems built with "configure \-\-with\-tuning=large". +sockets\&. The default value is 4096 on systems built with default configuration options, and 21000 on systems built with "configure \-\-with\-tuning=large"\&. .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 @@ -179,14 +194,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 @@ -194,126 +209,127 @@ 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 \fIlock\-file\fR .RS 4 Acquire a lock on the specified file at runtime; this helps to prevent duplicate \fBnamed\fR -instances from running simultaneously. Use of this option overrides the +instances from running simultaneously\&. Use of this option overrides the \fBlock\-file\fR option in -\fInamed.conf\fR. If set to -none, the lock file check is disabled. +named\&.conf\&. If set to +none, the lock file check is disabled\&. .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 8fd4b994b7..5a25feb0a2 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.76.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 +named.conf \- configuration file for \fBnamed\fR .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; @@ -93,41 +122,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 { @@ -140,34 +185,42 @@ 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; lwres\-tasks \fIinteger\fR; lwres\-clients \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; @@ -178,9 +231,9 @@ options { host\-statistics\-max \fInumber\fR; // not implemented hostname ( \fIquoted_string\fR | none ); interface\-interval \fIinteger\fR; - keep\-response\-order { \fIaddress_match_element\fR; ... }; - listen\-on [ port \fIinteger\fR ] { \fIaddress_match_element\fR; ... }; - listen\-on\-v6 [ port \fIinteger\fR ] { \fIaddress_match_element\fR; ... }; + keep\-response\-order { \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 ); @@ -206,16 +259,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; @@ -250,13 +303,13 @@ 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; ... }; - disable\-ds\-digests \fIstring\fR { \fIstring\fR; ... }; + root\-delegation\-only [ exclude { \fIquoted_string\fR; \&.\&.\&. } ]; + disable\-algorithms \fIstring\fR { \fIstring\fR; \&.\&.\&. }; + disable\-ds\-digests \fIstring\fR { \fIstring\fR; \&.\&.\&. }; dnssec\-enable \fIboolean\fR; dnssec\-validation \fIboolean\fR; dnssec\-lookaside ( \fIauto\fR | \fIno\fR | \fIdomain\fR trust\-anchor \fIdomain\fR ); @@ -278,13 +331,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 | map ); @@ -294,12 +347,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; @@ -345,7 +398,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 @@ -359,39 +412,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; @@ -426,13 +483,13 @@ 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; ... }; - disable\-ds\-digests \fIstring\fR { \fIstring\fR; ... }; + root\-delegation\-only [ exclude { \fIquoted_string\fR; \&.\&.\&. } ]; + disable\-algorithms \fIstring\fR { \fIstring\fR; \&.\&.\&. }; + disable\-ds\-digests \fIstring\fR { \fIstring\fR; \&.\&.\&. }; dnssec\-enable \fIboolean\fR; dnssec\-validation \fIboolean\fR; dnssec\-lookaside ( \fIauto\fR | \fIno\fR | \fIdomain\fR trust\-anchor \fIdomain\fR ); @@ -454,13 +511,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 | map ); @@ -470,12 +527,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; @@ -506,16 +563,20 @@ view \fIstring\fR \fIoptional_class\fR { require\-server\-cookie \fIboolean\fR; send\-cookie \fIboolean\fR; nocookie\-udp\-size \fIinteger\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 | @@ -524,7 +585,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; @@ -538,18 +599,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; @@ -560,12 +621,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; @@ -599,16 +660,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\-2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2004-2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/named/named.conf.docbook b/bin/named/named.conf.docbook index afaece268b..9051da0d23 100644 --- a/bin/named/named.conf.docbook +++ b/bin/named/named.conf.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/named/named.conf.html b/bin/named/named.conf.html index 4d58e1683d..1683fa642b 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;
@@ -96,26 +118,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 | * ) ]
@@ -124,10 +152,12 @@ controls unix unsupported; // not implemented
};

-
-
-

LOGGING

-


+

+ +
+

LOGGING

+ +


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

-
-
-

LWRES

-


+

+ +
+

LWRES

+ +


lwres {
listen-on [ port integer ] {
( ipv4_address | ipv6_address ) [ port integer ]; ...
@@ -157,10 +189,12 @@ lwres lwres-clients integer;
};

-
-
-

OPTIONS

-


+

+ +
+

OPTIONS

+ +


options {
avoid-v4-udp-ports { port; ... };
avoid-v6-udp-ports { port; ... };
@@ -371,10 +405,12 @@ options use-id-pool boolean; // obsolete
};

-
-
-

VIEW

-


+

+ +
+

VIEW

+ +


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

-
-
-

ZONE

-


+

+ +
+

ZONE

+ +


zone string optional_class {
type ( master | slave | stub | hint | redirect |
forward | delegation-only );
@@ -637,19 +675,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 fb10190e3a..c5741442fb 100644 --- a/bin/named/named.docbook +++ b/bin/named/named.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/named/named.html b/bin/named/named.html index 20187aab5e..7294260179 100644 --- a/bin/named/named.html +++ b/bin/named/named.html @@ -14,55 +14,99 @@ - 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] [-D string] [-E engine-name] [-f] [-g] [-L logfile] [-M option] [-m flag] [-n #cpus] [-p port] [-s] [-S #max-socks] [-t directory] [-U #listeners] [-u user] [-v] [-V] [-X lock-file] [-x cache-file]

-
-
-

DESCRIPTION

-

named +

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

+
+ +
+

DESCRIPTION

+ +

named 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,28 +116,33 @@ directory option in the configuration file, config-file should be an absolute pathname. -

+

+
-d debug-level
-

+

+

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

+

+
-D string
-

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

+
+

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

+
-E engine-name
-

+

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

-

+

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

-
+
-f
-

+

+

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

+

+
-g
-

+

+

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

+

+
-L logfile
-

+

+

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

+

+
-M option
-

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

+
+

+ 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, - record, - size, and - mctx. - These correspond to the ISC_MEM_DEBUGXXXX flags described in - <isc/mem.h>. -

+
+

+ Turn on memory usage debugging flags. Possible flags are + usage, + trace, + record, + size, and + 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 - #max-socks sockets. +

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

-
+

+

Warning

-

+

This option should be unnecessary for the vast majority of users. - The use of this option could even be harmful because the + 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 + 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 + Note also that the actual maximum number is normally a little fewer than the specified value because - named reserves some file descriptors - for its internal use. + named reserves some file descriptors + for its internal use.

-
-
+
+
-t directory
-

Chroot - to directory after +

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 @@ -207,147 +270,193 @@ 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 - to user after completing +

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

-
+

Note

-

- On Linux, named uses the kernel's - capability mechanism to drop all root privileges +

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

+

+

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

+

+
-x cache-file
-

+

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

-
+

Warning

-

+

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

-
-
+
+
-
-
-

SIGNALS

-

+ +

+ +
+

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 94b029e485..6cf8d9169c 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.76.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,162 +52,162 @@ 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 \-P .RS 4 Print the list of private BIND\-specific resource record types whose format is understood by -\fBnsupdate\fR. See also the +\fBnsupdate\fR\&. See also the \fB\-T\fR -option. +option\&. .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 \-T .RS 4 Print the list of IANA standard resource record types whose format is understood by -\fBnsupdate\fR. +\fBnsupdate\fR\&. \fBnsupdate\fR -will exit after the lists are printed. The +will exit after the lists are printed\&. The \fB\-T\fR option can be combined with the \fB\-P\fR -option. +option\&. .sp -Other types can be entered using "TYPEXXXXX" where "XXXXX" is the decimal value of the type with no leading zeros. The rdata, if present, will be parsed using the UNKNOWN rdata format, ( ). +Other types can be entered using "TYPEXXXXX" where "XXXXX" is the decimal value of the type with no leading zeros\&. The rdata, if present, will be parsed using the UNKNOWN rdata format, ( )\&. .RE .PP \-u \fIudptimeout\fR .RS 4 -The UDP retry interval. The default is 3 seconds. If zero, the interval will be computed from the timeout interval and number of UDP retries. +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, @@ -200,75 +215,75 @@ 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} @@ -276,29 +291,29 @@ will clear the default ttl. Specifies that all updates are to be TSIG\-signed using the \fIkeyname\fR \fIsecret\fR -pair. If +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 command line. +on the command line\&. .RE .PP \fBoldgsstsig\fR .RS 4 -Use the Windows 2000 version of GSS\-TSIG to sign the updated. This is equivalent to specifying +Use the Windows 2000 version of GSS\-TSIG to sign the updated\&. This is equivalent to specifying \fB\-o\fR -on the command line. +on the command line\&. .RE .PP \fBrealm\fR {[realm_name]} @@ -306,25 +321,25 @@ on the command line. 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 \fBcheck\-names\fR {[yes_or_no]} .RS 4 -Turn on or off check\-names processing on records to be added. Check\-names has no effect on prerequisites or records to be deleted. By default check\-names processing is on. If check\-names processing fails the record will not be added to the UPDATE message. +Turn on or off check\-names processing on records to be added\&. Check\-names has no effect on prerequisites or records to be deleted\&. By default check\-names processing is on\&. If check\-names processing fails the record will not be added to the UPDATE message\&. .RE .PP \fB[prereq]\fR\fB nxdomain\fR {domain\-name} .RS 4 Requires that no resource record of any type exists with name -\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} @@ -333,9 +348,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} @@ -345,9 +360,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...} @@ -358,26 +373,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...} @@ -386,99 +401,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 @@ -490,13 +511,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 058ea215f4..584f16340a 100644 --- a/bin/nsupdate/nsupdate.docbook +++ b/bin/nsupdate/nsupdate.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/nsupdate/nsupdate.html b/bin/nsupdate/nsupdate.html index 80b20d5997..3356d1ad26 100644 --- a/bin/nsupdate/nsupdate.html +++ b/bin/nsupdate/nsupdate.html @@ -14,26 +14,58 @@ - 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] [-T] [-P] [-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] + [-T] + [-P] + [-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,114 +74,134 @@ 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. -

+

+
-P
-

+

+

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

+

+
-r udpretries
-

+

+

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

+

+
-R randomdev
-

+

+

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

+

+
-t timeout
-

+

+

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

+

+
-T
-

+

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

-

+

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

-
+
-u udptimeout
-

+

+

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

+

+
-v
-

+

+

Use TCP even for small update requests. - By default, nsupdate + 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. @@ -213,19 +274,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. @@ -239,30 +304,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 @@ -274,131 +340,155 @@ 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 command line. -

+

+
- oldgsstsig + oldgsstsig
-

+

+

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

+

+
- realm + realm {[realm_name]}
-

+

+

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

+

+
- check-names + check-names {[yes_or_no]}
-

+

+

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

+

+
- [prereq] nxdomain + [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 @@ -407,14 +497,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 @@ -424,15 +516,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 @@ -453,15 +547,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 @@ -474,73 +570,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. @@ -559,7 +674,7 @@

-

+

Any A records for oldhost.example.com are deleted. @@ -576,7 +691,7 @@

-

+

The prerequisite condition gets the name server to check that there are no resource records of any type for nickname.example.com. @@ -589,33 +704,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, @@ -623,19 +755,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.

-
+
+
diff --git a/bin/pkcs11/pkcs11-destroy.docbook b/bin/pkcs11/pkcs11-destroy.docbook index aad8b55066..9ca88205d9 100644 --- a/bin/pkcs11/pkcs11-destroy.docbook +++ b/bin/pkcs11/pkcs11-destroy.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/pkcs11/pkcs11-keygen.docbook b/bin/pkcs11/pkcs11-keygen.docbook index ada18dd531..de01b74e4d 100644 --- a/bin/pkcs11/pkcs11-keygen.docbook +++ b/bin/pkcs11/pkcs11-keygen.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/pkcs11/pkcs11-list.docbook b/bin/pkcs11/pkcs11-list.docbook index 4123d0c372..9c080fdb2e 100644 --- a/bin/pkcs11/pkcs11-list.docbook +++ b/bin/pkcs11/pkcs11-list.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/pkcs11/pkcs11-tokens.docbook b/bin/pkcs11/pkcs11-tokens.docbook index 4f16c188eb..302b3714ce 100644 --- a/bin/pkcs11/pkcs11-tokens.docbook +++ b/bin/pkcs11/pkcs11-tokens.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/python/dnssec-checkds.8 b/bin/python/dnssec-checkds.8 index 81172abb67..06c2f5f619 100644 --- a/bin/python/dnssec-checkds.8 +++ b/bin/python/dnssec-checkds.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\-checkds +'\" t +.\" Title: dnssec-checkds .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: January 01, 2013 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2013-01-01 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-CHECKDS" "8" "January 01, 2013" "BIND9" "BIND9" +.TH "DNSSEC\-CHECKDS" "8" "2013\-01\-01" "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 7a7f866a13..3c984003fe 100644 --- a/bin/python/dnssec-checkds.docbook +++ b/bin/python/dnssec-checkds.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/python/dnssec-checkds.html b/bin/python/dnssec-checkds.html index 91cecd5f9e..05d8c553a8 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 7fe9a57781..d11eec67d8 100644 --- a/bin/python/dnssec-coverage.8 +++ b/bin/python/dnssec-coverage.8 @@ -12,44 +12,59 @@ .\" 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: January 11, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-01-11 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-COVERAGE" "8" "January 11, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-COVERAGE" "8" "2014\-01\-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\-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\-l\ \fR\fB\fIlength\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-d\ \fR\fB\fIDNSKEY\ TTL\fR\fR] [\fB\-m\ \fR\fB\fImax\ TTL\fR\fR] [\fB\-r\ \fR\fB\fIinterval\fR\fR] [\fB\-c\ \fR\fB\fIcompilezone\ path\fR\fR] [\fB\-k\fR] [\fB\-z\fR] [zone] .SH "DESCRIPTION" .PP \fBdnssec\-coverage\fR -verifies that the DNSSEC keys for a given zone or a set of zones have timing metadata set properly to ensure no future lapses in DNSSEC coverage. +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 \-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 \-f \fIfile\fR @@ -60,85 +75,86 @@ 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 \-l \fIduration\fR .RS 4 -The length of time to check for DNSSEC coverage. Key events scheduled further into the future than +The length of time to check for DNSSEC coverage\&. Key events scheduled further into the future than \fBduration\fR -will be ignored, and assumed to be correct. +will be ignored, and assumed to be correct\&. .sp The value of \fBduration\fR -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. +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 \-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 \-k .RS 4 -Only check KSK coverage; ignore ZSK events. Cannot be used with -\fB\-z\fR. +Only check KSK coverage; ignore ZSK events\&. Cannot be used with +\fB\-z\fR\&. .RE .PP \-z .RS 4 -Only check ZSK coverage; ignore KSK events. Cannot be used with -\fB\-k\fR. +Only check ZSK coverage; ignore KSK events\&. Cannot be used with +\fB\-k\fR\&. .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 e5d902584f..cacfed2bca 100644 --- a/bin/python/dnssec-coverage.docbook +++ b/bin/python/dnssec-coverage.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/python/dnssec-coverage.html b/bin/python/dnssec-coverage.html index b3ac5ed874..1e2bc61dad 100644 --- a/bin/python/dnssec-coverage.html +++ b/bin/python/dnssec-coverage.html @@ -14,31 +14,55 @@ - PERFORMANCE OF THIS SOFTWARE. --> - 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] [-l length] [-f file] [-d DNSKEY TTL] [-m max TTL] [-r interval] [-c compilezone path] [-k] [-z] [zone]

-
-
-

DESCRIPTION

-

dnssec-coverage +

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

+
+ +
+

DESCRIPTION

+ +

dnssec-coverage 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,47 +75,54 @@ key is rolled, and cached data signed by the prior key has not had time to expire from resolver caches.

-

+

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

-
-
-

OPTIONS

-
+
+ +
+

OPTIONS

+ + +
-K directory
-

+

+

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

+

+
-f file
-

+

+

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

+

+
-l duration
-

+

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

-

+

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

-
+
-m maximum TTL
-

+

Sets the value to be used as the maximum TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure. When a zone-signing key is @@ -100,21 +131,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 @@ -124,68 +155,80 @@ 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.

-
+
-k
-

+

+

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

+

+
-z
-

+

+

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

+

+
-c compilezone path
-

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

+

+ 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 d159b66f5b..a2ea645585 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: August 15, 2014 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2014-08-15 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "RNDC" "8" "August 15, 2014" "BIND9" "BIND9" +.TH "RNDC" "8" "2014\-08\-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 \- 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 algorithms are HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512. They use a shared secret on each end of the connection. This provides TSIG\-style authentication for the command request and the name server'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 algorithms are HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512\&. They use a shared secret on each end of the connection\&. This provides TSIG\-style authentication for the command request and the name server\*(Aqs response\&. All commands sent over the channel must be signed by a key_id known to the server\&. .PP \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,32 +88,32 @@ 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 \-q .RS 4 -Quiet mode: Message text returned by the server will not be printed except when there is an error. +Quiet mode: Message text returned by the server will not be printed except when there is an error\&. .RE .PP \-r @@ -107,27 +122,27 @@ Instructs \fBrndc\fR to print the result code returned by \fBnamed\fR -after executing the requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc). +after executing the requested command (e\&.g\&., ISC_R_SUCCESS, ISC_R_FAILURE, etc)\&. .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 @@ -135,216 +150,216 @@ 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\fIname\fR\fR\fI.nzf\fR, where +\fIname\fR\&.nzf, where \fIname\fR -is the name of the view, or if it contains characters that are incompatible with use as a file name, a cryptographic hash generated from the name of the view. When +is the name of the view, or if it contains characters that are incompatible with use as a file name, a cryptographic hash generated from the name of the view\&. When \fBnamed\fR -is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart. +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 and -\fBrndc modzone\fR. +\fBrndc modzone\fR\&. .RE .PP \fBdelzone \fR\fB[\-clean]\fR\fB \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR .RS 4 -Delete a zone while the server is running. +Delete a zone while the server is running\&. .sp If the \fB\-clean\fR -argument is specified, the zone's master file (and journal file, if any) will be deleted along with the zone. Without the +argument is specified, the zone\*(Aqs master file (and journal file, if any) will be deleted along with the zone\&. Without the \fB\-clean\fR -option, zone files must be cleaned up by hand. (If the zone is of type "slave" or "stub", the files needing to be cleaned up will be reported in the output of the +option, zone files must be cleaned up by hand\&. (If the zone is of type "slave" or "stub", the files needing to be cleaned up will be reported in the output of the \fBrndc delzone\fR -command.) +command\&.) .sp If the zone was originally added via -\fBrndc addzone\fR, then it will be removed permanently. However, if it was originally configured in -\fInamed.conf\fR, then that original configuration is still in place; when the server is restarted or reconfigured, the zone will come back. To remove it permanently, it must also be removed from -\fInamed.conf\fR +\fBrndc addzone\fR, then it will be removed permanently\&. However, if it was originally configured in +named\&.conf, then that original configuration is still in place; when the server is restarted or reconfigured, the zone will come back\&. To remove it permanently, it must also be removed from +named\&.conf .sp See also \fBrndc addzone\fR and -\fBrndc modzone\fR. +\fBrndc modzone\fR\&. .RE .PP -\fBdumpdb \fR\fB[\-all|\-cache|\-zone|\-adb|\-bad|\-fail]\fR\fB \fR\fB[\fIview ...\fR]\fR +\fBdumpdb \fR\fB[\-all|\-cache|\-zone|\-adb|\-bad|\-fail]\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, bad server cache and SERVFAIL cache. +Flushes the given name from the view\*(Aqs DNS cache and, if applicable, from the view\*(Aqs nameserver address database, bad server cache and SERVFAIL cache\&. .RE .PP \fBflushtree\fR \fIname\fR [\fIview\fR] .RS 4 -Flushes the given name, and all of its subdomains, from the view's DNS cache, address database, bad server cache, and SERVFAIL cache. +Flushes the given name, and all of its subdomains, from the view\*(Aqs DNS cache, address database, bad server cache, and SERVFAIL cache\&. .RE .PP \fBfreeze \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR .RS 4 -Suspend updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by dynamic update. It also causes changes in the journal file to be synced into the master file. All dynamic update attempts will be refused while the zone is frozen. +Suspend updates to a dynamic zone\&. If no zone is specified, then all zones are suspended\&. This allows manual edits to be made to a zone normally updated by dynamic update\&. It also causes changes in the journal file to be synced into the master file\&. All dynamic update attempts will be refused while the zone is frozen\&. .sp See also -\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 \fBmanaged\-keys \fR\fB\fI(status | refresh | sync)\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 -When run with the "status" keyword, print the current status of the managed\-keys database for the specified view, or for all views if none is specified. When run with the "refresh" keyword, force an immediate refresh of all the managed\-keys in the specified view, or all views. When run with the "sync" keyword, force an immediate dump of the managed\-keys database to disk (in the file -\fImanaged\-keys.bind\fR -or (\fI\fIviewname\fR\fR\fI.mkeys\fR). +When run with the "status" keyword, print the current status of the managed\-keys database for the specified view, or for all views if none is specified\&. When run with the "refresh" keyword, force an immediate refresh of all the managed\-keys in the specified view, or all views\&. When run with the "sync" keyword, force an immediate dump of the managed\-keys database to disk (in the file +managed\-keys\&.bind +or (\fIviewname\fR\&.mkeys)\&. .RE .PP \fBmodzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR\fB\fIconfiguration\fR\fR\fB \fR .RS 4 -Modify the configuration of a zone while the server is running. This command requires the +Modify the configuration of a zone while the server is running\&. This command requires the \fBallow\-new\-zones\fR option to be set to -\fByes\fR. As with +\fByes\fR\&. As with \fBaddzone\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 If the zone was originally added via -\fBrndc addzone\fR, the configuration changes will be recorded permanently and will still be in effect after the server is restarted or reconfigured. However, if it was originally configured in -\fInamed.conf\fR, then that original configuration is still in place; when the server is restarted or reconfigured, the zone will revert to its original configuration. To make the changes permanent, it must also be modified in -\fInamed.conf\fR +\fBrndc addzone\fR, the configuration changes will be recorded permanently and will still be in effect after the server is restarted or reconfigured\&. However, if it was originally configured in +named\&.conf, then that original configuration is still in place; when the server is restarted or reconfigured, the zone will revert to its original configuration\&. To make the changes permanent, it must also be modified in +named\&.conf .sp See also \fBrndc addzone\fR and -\fBrndc delzone\fR. +\fBrndc delzone\fR\&. .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 \fBnta \fR\fB[( \-d | \-f | \-r | \-l \fIduration\fR)]\fR\fB \fR\fB\fIdomain\fR\fR\fB \fR\fB[\fIview\fR]\fR\fB \fR .RS 4 Sets a DNSSEC negative trust anchor (NTA) for \fBdomain\fR, with a lifetime of -\fBduration\fR. The default lifetime is configured in -\fInamed.conf\fR +\fBduration\fR\&. The default lifetime is configured in +named\&.conf via the \fBnta\-lifetime\fR -option, and defaults to one hour. The lifetime cannot exceed one week. +option, and defaults to one hour\&. The lifetime cannot exceed one week\&. .sp -A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration rather than an attack. When data to be validated is at or below an active NTA (and above any other configured trust anchors), +A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration rather than an attack\&. When data to be validated is at or below an active NTA (and above any other configured trust anchors), \fBnamed\fR -will abort the DNSSEC validation process and treat the data as insecure rather than bogus. This continues until the NTA's lifetime is elapsed. +will abort the DNSSEC validation process and treat the data as insecure rather than bogus\&. This continues until the NTA\*(Aqs lifetime is elapsed\&. .sp NTAs persist across restarts of the \fBnamed\fR -server. The NTAs for a view are saved in a file called -\fI\fIname\fR\fR\fI.nta\fR, where +server\&. The NTAs for a view are saved in a file called +\fIname\fR\&.nta, where \fIname\fR -is the name of the view, or if it contains characters that are incompatible with use as a file name, a cryptographic hash generated from the name of the view. +is the name of the view, or if it contains characters that are incompatible with use as a file name, a cryptographic hash generated from the name of the view\&. .sp An existing NTA can be removed by using the \fB\-remove\fR -option. +option\&. .sp -An NTA's lifetime can be specified with the +An NTA\*(Aqs lifetime can be specified with the \fB\-lifetime\fR -option. TTL\-style suffixes can be used to specify the lifetime in seconds, minutes, or hours. If the specified NTA already exists, its lifetime will be updated to the new value. Setting +option\&. TTL\-style suffixes can be used to specify the lifetime in seconds, minutes, or hours\&. If the specified NTA already exists, its lifetime will be updated to the new value\&. Setting \fBlifetime\fR to zero is equivalent to -\fB\-remove\fR. +\fB\-remove\fR\&. .sp If \fB\-dump\fR -is used, any other arguments are ignored, and a list of existing NTAs is printed (note that this may include NTAs that are expired but have not yet been cleaned up). +is used, any other arguments are ignored, and a list of existing NTAs is printed (note that this may include NTAs that are expired but have not yet been cleaned up)\&. .sp Normally, \fBnamed\fR will periodically test to see whether data below an NTA can now be validated (see the \fBnta\-recheck\fR -option in the Administrator Reference Manual for details). If data can be validated, then the NTA is regarded as no longer necessary, and will be allowed to expire early. The +option in the Administrator Reference Manual for details)\&. If data can be validated, then the NTA is regarded as no longer necessary, and will be allowed to expire early\&. The \fB\-force\fR -overrides this behavior and forces an NTA to persist for its entire lifetime, regardless of whether data could be validated if the NTA were not present. +overrides this behavior and forces an NTA to persist for its entire lifetime, regardless of whether data could be validated if the NTA were not present\&. .sp -All of these options can be shortened, i.e., to +All of these options can be shortened, i\&.e\&., to \fB\-l\fR, \fB\-r\fR, \fB\-d\fR, and -\fB\-f\fR. +\fB\-f\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 @@ -354,52 +369,52 @@ to a 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 \fBscan\fR @@ -408,200 +423,201 @@ Scan the list of available network interfaces for changes, without performing a \fBreconfig\fR or waiting for the \fBinterface\-interval\fR -timer. +timer\&. .RE .PP -\fBsecroots \fR\fB[\-]\fR\fB \fR\fB[\fIview ...\fR]\fR +\fBsecroots \fR\fB[\-]\fR\fB \fR\fB[\fIview \&.\&.\&.\fR]\fR .RS 4 -Dump the server's security roots and negative trust anchors for the specified views. If no view is specified, all views are dumped. +Dump the server\*(Aqs security roots and negative trust anchors for the specified views\&. If no view is specified, all views are dumped\&. .sp If the first argument is "\-", then the output is returned via the \fBrndc\fR -response channel and printed to the standard output. Otherwise, it is written to the secroots dump file, which defaults to -\fInamed.secroots\fR, but can be overridden via the +response channel and printed to the standard output\&. Otherwise, it is written to the secroots dump file, which defaults to +named\&.secroots, but can be overridden via the \fBsecroots\-file\fR option in -\fInamed.conf\fR. +named\&.conf\&. .sp See also -\fBrndc managed\-keys\fR. +\fBrndc managed\-keys\fR\&. .RE .PP \fBshowzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR .RS 4 -Print the configuration of a running zone. +Print the configuration of a running zone\&. .sp See also -\fBrndc zonestatus\fR. +\fBrndc zonestatus\fR\&. .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 ) | \-serial \fIvalue\fR ) ]\fR\fB \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR .RS 4 -List, edit, or remove the DNSSEC signing state records for the specified zone. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type -\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, a hyphen (`\-') if no salt is to be used, or the keyword +is a string of data expressed in hexadecimal, a hyphen (`\-\*(Aq) if no salt is to be used, or the keyword auto, which causes \fBnamed\fR -to generate a random 64\-bit salt. +to generate a random 64\-bit salt\&. .sp So, for example, to create an NSEC3 chain using the SHA\-1 hash algorithm, no opt\-out flag, 10 iterations, and a salt value of "FFFF", use: -\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\&. .sp \fBrndc signing \-serial value\fR -sets the serial number of the zone to value. If the value would cause the serial number to go backwards it will be rejected. The primary use is to set the serial on inline signed zones. +sets the serial number of the zone to value\&. If the value would cause the serial number to go backwards it will be rejected\&. The primary use is to set the serial on inline signed zones\&. .RE .PP \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 .PP \fBzonestatus \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 -Displays the current status of the given zone, including the master file name and any include files from which it was loaded, when it was most recently loaded, the current serial number, the number of nodes, whether the zone supports dynamic updates, whether the zone is DNSSEC signed, whether it uses automatic DNSSEC key management or inline signing, and the scheduled refresh or expiry times for the zone. +Displays the current status of the given zone, including the master file name and any include files from which it was loaded, when it was most recently loaded, the current serial number, the number of nodes, whether the zone supports dynamic updates, whether the zone is DNSSEC signed, whether it uses automatic DNSSEC key management or inline signing, and the scheduled refresh or expiry times for the zone\&. .sp See also -\fBrndc showzone\fR. +\fBrndc showzone\fR\&. .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 9a8f8268f9..3d00b79cd8 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: March 14, 2013 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2013-03-14 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "\fIRNDC.CONF\fR" "5" "March 14, 2013" "BIND9" "BIND9" +.TH "RNDC\&.CONF" "5" "2013\-03\-14" "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 authentication algorithm for \fBrndc\fR -to use; currently only HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512 are supported. This is followed by a secret clause which contains the base\-64 encoding of the algorithm's authentication key. The base\-64 string is enclosed in double quotes. +to use; currently only HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512 are supported\&. This is followed by a secret clause which contains the base\-64 encoding of the algorithm\*(Aqs authentication key\&. The base\-64 string is enclosed in double quotes\&. .PP -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\-sha256; secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz"; }; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf key testkey { algorithm hmac\-sha256; 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\-SHA256 algorithm and its secret clause contains the base\-64 encoding of the HMAC\-SHA256 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\-SHA256 algorithm and its secret clause contains the base\-64 encoding of the HMAC\-SHA256 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, 2013, 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 83ed4f35e6..b39bbb7b1f 100644 --- a/bin/rndc/rndc.conf.docbook +++ b/bin/rndc/rndc.conf.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/rndc/rndc.conf.html b/bin/rndc/rndc.conf.html index 7e782fc3f4..9046ea4d73 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,34 +106,37 @@ of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively.

-

+

The key statement begins with an identifying string, the name of the key. The statement has two clauses. algorithm identifies the authentication algorithm - for rndc to use; currently only HMAC-MD5 + for rndc to use; currently only HMAC-MD5 (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256 (default), HMAC-SHA384 and HMAC-SHA512 are supported. This is followed by a secret clause which contains the base-64 encoding of the algorithm's authentication key. The base-64 string is enclosed in double quotes.

-

+

There are two common ways to generate the base-64 string for the - secret. The BIND 9 program rndc-confgen + 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;
@@ -127,14 +144,14 @@

-
+    
       server localhost {
         key             samplekey;
       };
 

 

     

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

 

     

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

 

     

-
+    
       key testkey {
         algorithm	hmac-sha256;
         secret		"R3HI8P6BKw9ZwXwN3VZKuQ==";
@@ -158,8 +175,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
@@ -168,16 +186,16 @@
       uses the HMAC-SHA256 algorithm and its secret clause contains the
       base-64 encoding of the HMAC-SHA256 secret enclosed in double quotes.
     

-

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

+      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
@@ -185,34 +203,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 d8846369d5..74dab39395 100644 --- a/bin/rndc/rndc.docbook +++ b/bin/rndc/rndc.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/rndc/rndc.html b/bin/rndc/rndc.html index 7437a4fd9a..242743f0e5 100644 --- a/bin/rndc/rndc.html +++ b/bin/rndc/rndc.html @@ -14,39 +14,63 @@ - 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] [-q] [-r] [-V] [-y key_id] {command}

-
-
-

DESCRIPTION

-

rndc +

+ rndc + [-b source-address] + [-c config-file] + [-k key-file] + [-s server] + [-p port] + [-q] + [-r] + [-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 algorithms are HMAC-MD5 (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256 (default), HMAC-SHA384 and HMAC-SHA512. @@ -56,30 +80,38 @@ over the channel must be signed by a key_id known to the server.

-

rndc +

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

-
-
-

OPTIONS

-
+
+ +
+

OPTIONS

+ + +
-b source-address
-

+

+

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

+

+
-c config-file
-

+

+

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

+

+
-k key-file
-

+

+

Use key-file as the key file instead of the default, /etc/rndc.key. The key in @@ -87,48 +119,60 @@ 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. -

+

+
-q
-

+

+

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

+

+
-r
-

- Instructs rndc to print the result code - returned by named after executing the +

+

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

+

+
-V
-

+

+

Enable verbose logging. -

+

+
-y key_id
-

+

+

Use the key key_id from the configuration file. key_id 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. @@ -136,32 +180,36 @@ 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 name.nzf, where name is the @@ -169,33 +217,33 @@ that are incompatible with use as a file name, a cryptographic hash generated from the name of the view. - When named is + 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 and rndc modzone. +

+ See also rndc delzone and rndc modzone.

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

+

Delete a zone while the server is running.

-

+

If the -clean argument is specified, the zone's master file (and journal file, if any) will be deleted along with the zone. Without the @@ -203,11 +251,11 @@ be cleaned up by hand. (If the zone is of type "slave" or "stub", the files needing to be cleaned up will be reported in the output - of the rndc delzone command.) + of the rndc delzone command.)

-

+

If the zone was originally added via - rndc addzone, then it will be + rndc addzone, then it will be removed permanently. However, if it was originally configured in named.conf, then that original configuration is still in place; when @@ -215,39 +263,47 @@ come back. To remove it permanently, it must also be removed from named.conf

-

- See also rndc addzone and rndc modzone. +

+ See also rndc addzone and rndc modzone.

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

+

+

Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is specified, all views are dumped. - (See the dump-file option in + (See the dump-file option in the BIND 9 Administrator Reference Manual.) -

+

+
flush
-

+

+

Flushes the server's cache. -

+

+
flushname name [view]
-

+

+

Flushes the given name from the view's DNS cache and, if applicable, from the view's nameserver address database, bad server cache and SERVFAIL cache. -

+

+
flushtree name [view]
-

+

+

Flushes the given name, and all of its subdomains, from the view's DNS cache, address database, bad server cache, and SERVFAIL cache. -

+

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

+

Suspend updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by @@ -256,48 +312,49 @@ 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.)

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

+

+

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

+

+
modzone zone [class [view]] configuration
-

+

Modify the configuration of a zone while the server is running. This command requires the - allow-new-zones option to be + allow-new-zones option to be set to yes. As with - addzone, the + addzone, the configuration string specified on the command line is the zone configuration text that would ordinarily be placed in named.conf.

-

+

If the zone was originally added via - rndc addzone, the configuration + rndc addzone, the configuration changes will be recorded permanently and will still be in effect after the server is restarted or reconfigured. However, if it was originally configured in @@ -334,30 +392,32 @@ permanent, it must also be modified in named.conf

-

- See also rndc addzone and rndc delzone. +

+ See also rndc addzone and rndc delzone.

-
+
notify zone [class [view]]
-

+

+

Resend NOTIFY messages for the zone. -

+

+
notrace
-

+

Sets the server's debugging level to 0.

-

- See also rndc trace. +

+ See also rndc trace.

-
+
nta [( -d | -f | -r | -l duration)] domain [view]
-

+

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

-

+

A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration rather than an attack. When data to be validated is at or below an active NTA (and above any other - configured trust anchors), named will + configured trust anchors), named will abort the DNSSEC validation process and treat the data as insecure rather than bogus. This continues until the NTA's lifetime is elapsed.

-

- NTAs persist across restarts of the named server. +

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

-

+

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

-

+

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

-

+

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

-

- Normally, named will periodically +

+ Normally, named will periodically test to see whether data below an NTA can now be validated (see the nta-recheck option in the Administrator Reference Manual for details). @@ -417,127 +477,139 @@ lifetime, regardless of whether data could be validated if the NTA were not present.

-

+

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

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

-
+
scan
-

+

+

Scan the list of available network interfaces for changes, without performing a full - reconfig or waiting for the - interface-interval timer. -

+ reconfig or waiting for the + interface-interval timer. +

+
secroots [-] [view ...]
-

+

Dump the server's security roots and negative trust anchors for the specified views. If no view is specified, all views are dumped.

-

+

If the first argument is "-", then the output is - returned via the rndc response channel + returned via the rndc response channel and printed to the standard output. Otherwise, it is written to the secroots dump file, which defaults to named.secroots, but can be overridden via the secroots-file option in named.conf.

-

- See also rndc managed-keys. +

+ See also rndc managed-keys.

-
+
showzone zone [class [view]]
-

+

Print the configuration of a running zone.

-

- See also rndc zonestatus. +

+ See also rndc zonestatus.

-
+
sign zone [class [view]]
-

+

Fetch all DNSSEC keys for the given zone from the key directory (see the - key-directory option in + 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 @@ -545,44 +617,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 ) | -serial value ) ] zone [class [view]]
-

+

List, edit, or remove the DNSSEC signing state records for the specified zone. The status of ongoing DNSSEC operations (such as signing or generating 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 @@ -594,67 +666,73 @@ salt is a string of data expressed in hexadecimal, a hyphen (`-') if no salt is to be used, or the keyword auto, - which causes named to generate a + which causes named to generate a random 64-bit salt.

-

+

So, for example, to create an NSEC3 chain using the SHA-1 hash algorithm, no opt-out flag, 10 iterations, and a salt value of "FFFF", use: - 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.

-

- rndc signing -serial value sets +

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

-
+
stats
-

+

+

Write server statistics to the statistics file. - (See the statistics-file option in + (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 @@ -662,53 +740,61 @@ 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. -

+

+
zonestatus zone [class [view]]
-

+

Displays the current status of the given zone, including the master file name and any include files from which it was loaded, when it was most @@ -719,36 +805,46 @@ management or inline signing, and the scheduled refresh or expiry times for the zone.

-

- See also rndc showzone. +

+ See also rndc showzone.

-
+
-
-
-

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..f63e0a2955 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.76.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 77b430e39a..03cd024c9f 100644 --- a/bin/tools/arpaname.docbook +++ b/bin/tools/arpaname.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/tools/arpaname.html b/bin/tools/arpaname.html index 29ea03b513..9e8eb7af14 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/dnstap-read.docbook b/bin/tools/dnstap-read.docbook index 2b80d7d074..93b4b601f0 100644 --- a/bin/tools/dnstap-read.docbook +++ b/bin/tools/dnstap-read.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/tools/genrandom.8 b/bin/tools/genrandom.8 index 30d50d7eaa..2b2839587d 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.76.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 a53cd90b50..7383d72e67 100644 --- a/bin/tools/genrandom.docbook +++ b/bin/tools/genrandom.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/tools/genrandom.html b/bin/tools/genrandom.html index e125a01208..4be0e4c093 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..d0007fe061 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.76.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.html b/bin/tools/isc-hmac-fixup.html index cb975589c2..0734155125 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/mdig.1 b/bin/tools/mdig.1 index 2813c0e35e..573f078602 100644 --- a/bin/tools/mdig.1 +++ b/bin/tools/mdig.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: mdig .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: January 5, 2015 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2015-01-05 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "MDIG" "1" "January 5, 2015" "BIND9" "BIND9" +.TH "MDIG" "1" "2015\-01\-05" "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" mdig \- DNS pipelined lookup utility .SH "SYNOPSIS" @@ -41,30 +56,30 @@ mdig \- DNS pipelined lookup utility .PP \fBmdig\fR is a multiple/pipelined query version of -\fBdig\fR: instead of waiting for a response after sending each query, it begins by sending all queries. Responses are displayed in the order in which they are received, not in the order the corresponding queries were sent. +\fBdig\fR: instead of waiting for a response after sending each query, it begins by sending all queries\&. Responses are displayed in the order in which they are received, not in the order the corresponding queries were sent\&. .PP \fBmdig\fR options are a subset of the \fBdig\fR -options, and are divided into "anywhere options" which can occur anywhere, "global options" which must occur before the query name (or they are ignored with a warning), and "local options" which apply to the next query on the command line. +options, and are divided into "anywhere options" which can occur anywhere, "global options" which must occur before the query name (or they are ignored with a warning), and "local options" which apply to the next query on the command line\&. .PP The {@server} -option is a mandatory global option. It is the name or IP address of the name server to query. (Unlike +option is a mandatory global option\&. It is the name or IP address of the name server to query\&. (Unlike \fBdig\fR, this value is not retrieved from -\fI/etc/resolv.conf\fR.) It can be an IPv4 address in dotted\-decimal notation, an IPv6 address in colon\-delimited notation, or a hostname. When the supplied +/etc/resolv\&.conf\&.) It can be an IPv4 address in dotted\-decimal notation, an IPv6 address in colon\-delimited notation, or a hostname\&. When the supplied \fIserver\fR argument is a hostname, \fBmdig\fR -resolves that name before querying the name server. +resolves that name before querying the name server\&. .PP \fBmdig\fR -provides a number of query options which affect the way in which lookups are made and the results displayed. Some of these set or reset flag bits in the query header, some determine which sections of the answer get printed, and others determine the timeout and retry strategies. +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. +to negate the meaning of that keyword\&. Other keywords assign values to options like the timeout interval\&. They have the form +\fB+keyword=value\fR\&. .SH "ANYWHERE OPTIONS" .PP The @@ -72,115 +87,115 @@ The option makes \fBmdig\fR operate in batch mode by reading a list of lookup requests to process from the file -\fIfilename\fR. The file contains a number of queries, one per line. Each entry in the file should be organized in the same way they would be presented as queries to +\fIfilename\fR\&. The file contains a number of queries, one per line\&. Each entry in the file should be organized in the same way they would be presented as queries to \fBmdig\fR -using the command\-line interface. +using the command\-line interface\&. .PP The \fB\-h\fR causes \fBmdig\fR -to print the detailed help with the full list of options and exit. +to print the detailed help with the full list of options and exit\&. .PP The \fB\-v\fR causes \fBmdig\fR -to print the version number and exit. +to print the version number and exit\&. .SH "GLOBAL OPTIONS" .PP The \fB\-4\fR option forces \fBmdig\fR -to only use IPv4 query transport. +to only use IPv4 query transport\&. .PP The \fB\-6\fR option forces \fBmdig\fR -to only use IPv6 query transport. +to only use IPv6 query transport\&. .PP The \fB\-b\fR option sets the source IP address of the query to -\fIaddress\fR. This must be a valid address on one of the host's network interfaces or "0.0.0.0" or "::". An optional port may be specified by appending "#" +\fIaddress\fR\&. This must be a valid address on one of the host\*(Aqs network interfaces or "0\&.0\&.0\&.0" or "::"\&. An optional port may be specified by appending "#" .PP The \fB\-p\fR -option is used when a non\-standard port number is to be queried. +option is used when a non\-standard port number is to be queried\&. \fIport#\fR is the port number that \fBmdig\fR -will send its queries instead of the standard DNS port number 53. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number. +will send its queries instead of the standard DNS port number 53\&. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number\&. .PP The global query options are: .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]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+[no]cl\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]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]crypto\fR .RS 4 -Toggle the display of cryptographic fields in DNSSEC records. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures. The default is to display the fields. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e.g. "[ key id = value ]". +Toggle the display of cryptographic fields in DNSSEC records\&. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures\&. The default is to display the fields\&. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e\&.g\&. "[ key id = value ]"\&. .RE .PP \fB+dscp[=value]\fR .RS 4 -Set the DSCP code point to be used when sending the query. Valid DSCP code points are in the range [0..63]. By default no code point is explicitly set. +Set the DSCP code point to be used when sending the query\&. Valid DSCP code points are in the range [0\&.\&.63]\&. By default no code point is explicitly set\&. .RE .PP \fB+[no]multiline\fR .RS 4 -Print records like the SOA records in a verbose multi\-line format with human\-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the +Print records like the SOA records in a verbose multi\-line format with human\-readable comments\&. The default is to print each record on a single line, to facilitate machine parsing of the \fBmdig\fR -output. +output\&. .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]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]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+split=W\fR @@ -189,115 +204,115 @@ 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]tcp\fR .RS 4 -Use [do not use] TCP when querying name servers. The default behavior is to use UDP. +Use [do not use] TCP when querying name servers\&. The default behavior is to use UDP\&. .RE .PP \fB+[no]ttlid\fR .RS 4 -Display [do not display] the TTL when printing the record. +Display [do not display] the TTL when printing the record\&. .RE .PP \fB+[no]ttlunits\fR .RS 4 -Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks. Implies +ttlid. +Display [do not display] the TTL in friendly human\-readable time units of "s", "m", "h", "d", and "w", representing seconds, minutes, hours, days and weeks\&. Implies +ttlid\&. .RE .PP \fB+[no]vc\fR .RS 4 -Use [do not use] TCP when querying name servers. This alternate syntax to +Use [do not use] TCP when querying name servers\&. This alternate syntax to \fI+[no]tcp\fR -is provided for backwards compatibility. The "vc" stands for "virtual circuit". +is provided for backwards compatibility\&. The "vc" stands for "virtual circuit"\&. .RE .SH "LOCAL OPTIONS" .PP The \fB\-c\fR option sets the query class to -\fIclass\fR. It can be any valid query class which is supported in BIND 9. The default query class is "IN". +\fIclass\fR\&. It can be any valid query class which is supported in BIND 9\&. The default query class is "IN"\&. .PP The \fB\-t\fR option sets the query type to -\fItype\fR. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the +\fItype\fR\&. It can be any valid query type which is supported in BIND 9\&. The default query type is "A", unless the \fB\-x\fR -option is supplied to indicate a reverse lookup with the "PTR" query type. +option is supplied to indicate a reverse lookup with the "PTR" query type\&. .PP The \fB\-i\fR -option sets the reverse domain for IPv6 addresses to IP6.INT. +option sets the reverse domain for IPv6 addresses to IP6\&.INT\&. .PP Reverse lookups \(em mapping addresses to names \(em are simplified by the \fB\-x\fR -option. +option\&. \fIaddr\fR -is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address. +is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address\&. \fBmdig\fR automatically performs a lookup for a query name like -11.12.13.10.in\-addr.arpa -and sets the query type and class to PTR and IN respectively. By default, IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. To use the older RFC1886 method using the IP6.INT domain specify the +11\&.12\&.13\&.10\&.in\-addr\&.arpa +and sets the query type and class to PTR and IN respectively\&. By default, IPv6 addresses are looked up using nibble format under the IP6\&.ARPA domain\&. To use the older RFC1886 method using the IP6\&.INT domain specify the \fB\-i\fR -option. +option\&. .PP The local 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]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+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]cookie\fR\fB[=####]\fR .RS 4 -Send a COOKIE EDNS option, with optional value. Replaying a COOKIE from a previous response will allow the server to identify a previous client. The default is -\fB+nocookie\fR. +Send a COOKIE EDNS option, with optional value\&. Replaying a COOKIE from a previous response will allow the server to identify a previous client\&. The default is +\fB+nocookie\fR\&. .RE .PP \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+[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]ednsflags[=#]\fR .RS 4 -Set the must\-be\-zero EDNS flags bits (Z bits) to the specified value. Decimal, hex and octal encodings are accepted. Setting a named flag (e.g. DO) will silently be ignored. By default, no Z bits are set. +Set the must\-be\-zero EDNS flags bits (Z bits) to the specified value\&. Decimal, hex and octal encodings are accepted\&. Setting a named flag (e\&.g\&. DO) will silently be ignored\&. By default, no Z bits are set\&. .RE .PP \fB+[no]ednsopt[=code[:value]]\fR @@ -306,72 +321,76 @@ Specify EDNS option with code point \fBcode\fR and optionally payload of \fBvalue\fR -as a hexadecimal string. +as a hexadecimal string\&. \fB+noednsopt\fR -clears the EDNS options to be sent. +clears the EDNS options to be sent\&. .RE .PP \fB+[no]expire\fR .RS 4 -Send an EDNS Expire option. +Send an EDNS Expire option\&. .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]recurse\fR .RS 4 -Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means +Toggle the setting of the RD (recursion desired) bit in the query\&. This bit is set by default, which means \fBmdig\fR -normally sends recursive queries. +normally sends recursive queries\&. .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]subnet=addr/prefix\fR .RS 4 -Send an EDNS Client Subnet option with the specified IP address or network prefix. +Send an EDNS Client Subnet option with the specified IP address or network prefix\&. .RE .PP \fB+timeout=T\fR .RS 4 Sets the timeout for a query to \fIT\fR -seconds. The default timeout is 5 seconds for UDP transport and 10 for TCP. An attempt to set +seconds\&. The default timeout is 5 seconds for UDP transport and 10 for TCP\&. An attempt to set \fIT\fR -to less than 1 will result in a query timeout of 1 second being applied. +to less than 1 will result in a query timeout of 1 second being applied\&. .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+udptimeout=T\fR .RS 4 -Sets the timeout between UDP query retries. +Sets the timeout between UDP query retries\&. .RE .PP \fB+[no]zflag\fR .RS 4 -Set [do not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. +Set [do not set] the last unassigned DNS header flag in a DNS query\&. This flag is off by default\&. .RE .SH "SEE ALSO" .PP \fBdig\fR(1), -RFC1035. +RFC1035\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/mdig.html b/bin/tools/mdig.html index 66bcdafcb9..1213d0758a 100644 --- a/bin/tools/mdig.html +++ b/bin/tools/mdig.html @@ -13,64 +13,103 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - mdig - + -
+
-
+ + + +

Name

-

mdig — DNS pipelined lookup utility

+

+ mdig + — DNS pipelined lookup utility +

-
+ + + +

Synopsis

-

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

-

mdig {-h}

-

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

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

+ +

+ mdig + {-h} +

+ +

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

-
-
-

DESCRIPTION

-

mdig - is a multiple/pipelined query version of dig: + ...} +

+
+ +
+

DESCRIPTION

+ +

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

-

- mdig options are a subset of the - dig options, and are divided into "anywhere + +

+ mdig options are a subset of the + dig options, and are divided into "anywhere options" which can occur anywhere, "global options" which must occur before the query name (or they are ignored with a warning), and "local options" which apply to the next query on the command line.

-

+ +

The {@server} option is a mandatory global option. It is the name or IP address of the name server to query. - (Unlike dig, this value is not retrieved from + (Unlike dig, this value is not retrieved from /etc/resolv.conf.) It can be an IPv4 address in dotted-decimal notation, an IPv6 address in colon-delimited notation, or a hostname. When the supplied server argument is a hostname, - mdig resolves that name before querying + mdig resolves that name before querying the name server.

-

mdig + +

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

-

+ +

Each query option is identified by a keyword preceded by a plus sign (+). Some keywords set or reset an option. These may be preceded by the string no @@ -78,93 +117,120 @@ values to options like the timeout interval. They have the form +keyword=value.

-
-
-

ANYWHERE OPTIONS

-

- The -f option makes mdig +

+ +
+

ANYWHERE OPTIONS

+ + +

+ The -f option makes mdig operate in batch mode by reading a list of lookup requests to process from the file filename. The file contains a number of queries, one per line. Each entry in the file should be organized in the same way they would be presented - as queries to mdig using the command-line interface. + as queries to mdig using the command-line interface.

-

- The -h causes mdig to + +

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

-

- The -v causes mdig to + +

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

-
-
-

GLOBAL OPTIONS

-

- The -4 option forces mdig to +

+ +
+

GLOBAL OPTIONS

+ + +

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

-

- The -6 option forces mdig to + +

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

-

+ +

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

-

+ +

The -p option is used when a non-standard port number is to be queried. port# is the port number - that mdig will send its queries instead of + that mdig will send its queries instead of the standard DNS port number 53. This option would be used to test a name server that has been configured to listen for queries on a non-standard port number.

-

+ +

The global query options are:

+[no]additional
-

+

+

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

+

+
+[no]all
-

+

+

Set or clear all display flags. -

+

+
+[no]answer
-

+

+

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

+

+
+[no]authority
-

+

+

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

+

+
+[no]besteffort
-

+

+

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

+

+
+[no]cl
-

+

+

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

+

+
+[no]comments
-

+

+

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

+

+
+[no]crypto
-

+

+

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

+

+
+dscp[=value]
-

+

+

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

+

+
+[no]multiline
-

+

+

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

+

+
+[no]question
-

+

+

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

+

+
+[no]rrcomments
-

+

+

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

+

+
+[no]short
-

+

+

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

+

+
+split=W
-

+

+

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

+

+
+[no]tcp
-

+

+

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

+

+
+[no]ttlid
-

+

+

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

+

+
+[no]ttlunits
-

+

+

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

+

+
+[no]vc
-

+

+

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

+

+

-
-
-

LOCAL OPTIONS

-

+

+ +
+

LOCAL OPTIONS

+ + +

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

-

+ +

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

-

+ +

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

-

+ +

Reverse lookups — mapping addresses to names — are simplified by the -x option. addr is an IPv4 address in dotted-decimal notation, or a colon-delimited IPv6 address. - mdig automatically performs a lookup for a + mdig automatically performs a lookup for a query name like 11.12.13.10.in-addr.arpa and sets the query type and class to PTR and IN respectively. By default, IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. To use the older RFC1886 method using the IP6.INT domain specify the -i option.

-

+ +

The local query options are:

+[no]aaflag
-

+

+

A synonym for +[no]aaonly. -

+

+
+[no]aaonly
-

+

+

Sets the "aa" flag in the query. -

+

+
+[no]adflag
-

+

+

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

+

+
+bufsize=B
-

+

+

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

+

+
+[no]cdflag
-

+

+

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

+

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

+

+

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

+

+
+[no]dnssec
-

+

+

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

+

+
+[no]edns[=#]
-

+

+

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

+

+
+[no]ednsflags[=#]
-

+

+

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

+

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

+

+

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

+

+
+[no]expire
-

+

+

Send an EDNS Expire option. -

+

+
+[no]nsid
-

+

+

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

+

+
+[no]recurse
-

+

+

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

+

+
+retry=T
-

+

+

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

+

+
+[no]subnet=addr/prefix
-

+

+

Send an EDNS Client Subnet option with the specified IP address or network prefix. -

+

+
+timeout=T
-

+

+

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

+

+
+tries=T
-

+

+

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

+

+
+udptimeout=T
-

+

+

Sets the timeout between UDP query retries. -

+

+
+[no]zflag
-

+

+

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

+

+

-
-
-

SEE ALSO

-

dig(1), +

+ +
+

SEE ALSO

+ +

+ dig(1) + , RFC1035.

-
+
diff --git a/bin/tools/named-journalprint.8 b/bin/tools/named-journalprint.8 index ec91eb2734..e48deece30 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.76.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 b985254f95..98bf53e9da 100644 --- a/bin/tools/named-journalprint.docbook +++ b/bin/tools/named-journalprint.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/tools/named-journalprint.html b/bin/tools/named-journalprint.html index 3e5e19f239..b29061d7fe 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/named-rrchecker.1 b/bin/tools/named-rrchecker.1 index 452ba6d44f..87d6008d1d 100644 --- a/bin/tools/named-rrchecker.1 +++ b/bin/tools/named-rrchecker.1 @@ -12,59 +12,78 @@ .\" 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\-rrchecker +'\" t +.\" Title: named-rrchecker .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 -.\" Date: November 12, 2013 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 2013-11-12 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NAMED\-RRCHECKER" "1" "November 12, 2013" "BIND9" "BIND9" +.TH "NAMED\-RRCHECKER" "1" "2013\-11\-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" -named\-rrchecker \- A syntax checker for individual DNS resource records +named-rrchecker \- A syntax checker for individual DNS resource records .SH "SYNOPSIS" .HP 16 \fBnamed\-rrchecker\fR [\fB\-h\fR] [\fB\-o\ \fR\fB\fIorigin\fR\fR] [\fB\-p\fR] [\fB\-u\fR] [\fB\-C\fR] [\fB\-T\fR] [\fB\-P\fR] .SH "DESCRIPTION" .PP \fBnamed\-rrchecker\fR -read a individual DNS resource record from standard input and checks if it is syntactically correct. +read a individual DNS resource record from standard input and checks if it is syntactically correct\&. .PP The \fB\-h\fR -prints out the help menu. +prints out the help menu\&. .PP The \fB\-o \fR\fB\fIorigin\fR\fR -option specifies a origin to be used when interpreting the record. +option specifies a origin to be used when interpreting the record\&. .PP The \fB\-p\fR -prints out the resulting record in canonical form. If there is no canonical form defined then the record will be printed in unknown record format. +prints out the resulting record in canonical form\&. If there is no canonical form defined then the record will be printed in unknown record format\&. .PP The \fB\-u\fR -prints out the resulting record in unknown record form. +prints out the resulting record in unknown record form\&. .PP The \fB\-C\fR, \fB\-T\fR and \fB\-P\fR -print out the known class, standard type and private type mnemonics respectively. +print out the known class, standard type and private type mnemonics respectively\&. .SH "SEE ALSO" .PP RFC 1034, RFC 1035, \fBnamed\fR(8) +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" +.br Copyright \(co 2013, 2014 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/named-rrchecker.docbook b/bin/tools/named-rrchecker.docbook index 705d0da406..1624be021f 100644 --- a/bin/tools/named-rrchecker.docbook +++ b/bin/tools/named-rrchecker.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/tools/named-rrchecker.html b/bin/tools/named-rrchecker.html index a11cc5f08d..ad8834b6fa 100644 --- a/bin/tools/named-rrchecker.html +++ b/bin/tools/named-rrchecker.html @@ -14,58 +14,82 @@ - PERFORMANCE OF THIS SOFTWARE. --> - named-rrchecker - + -
+
-
+ + + +

Name

-

named-rrchecker — A syntax checker for individual DNS resource records

+

+ named-rrchecker + — A syntax checker for individual DNS resource records +

-
+ + + +

Synopsis

-

named-rrchecker [-h] [-o origin] [-p] [-u] [-C] [-T] [-P]

-
-
-

DESCRIPTION

-

named-rrchecker +

+ named-rrchecker + [-h] + [-o origin] + [-p] + [-u] + [-C] + [-T] + [-P] +

+
+ +
+

DESCRIPTION

+ +

named-rrchecker read a individual DNS resource record from standard input and checks if it is syntactically correct.

-

+

The -h prints out the help menu.

-

+

The -o origin option specifies a origin to be used when interpreting the record.

-

+

The -p prints out the resulting record in canonical form. If there is no canonical form defined then the record will be printed in unknown record format.

-

+

The -u prints out the resulting record in unknown record form.

-

+

The -C, -T and -P print out the known class, standard type and private type mnemonics respectively.

-
-
-

SEE ALSO

-

+

+ +
+

SEE ALSO

+ +

RFC 1034, RFC 1035, - named(8) + + named(8) +

-
+
+
diff --git a/bin/tools/nsec3hash.8 b/bin/tools/nsec3hash.8 index d4444ce8e2..be3465a09f 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.76.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 6125fb44c0..20c0da17aa 100644 --- a/bin/tools/nsec3hash.docbook +++ b/bin/tools/nsec3hash.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/bin/tools/nsec3hash.html b/bin/tools/nsec3hash.html index acb83e6ee1..e161b46899 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/doc/arm/Bv9ARM-book.xml b/doc/arm/Bv9ARM-book.xml index 02885f6e63..f494ffbb3a 100644 --- a/doc/arm/Bv9ARM-book.xml +++ b/doc/arm/Bv9ARM-book.xml @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/doc/arm/Bv9ARM.ch01.html b/doc/arm/Bv9ARM.ch01.html index 288705f158..f911bb3a5e 100644 --- a/doc/arm/Bv9ARM.ch01.html +++ b/doc/arm/Bv9ARM.ch01.html @@ -18,7 +18,7 @@ Chapter 1. Introduction - + @@ -38,23 +38,23 @@
-
-

-Chapter 1. Introduction

+
+

+Chapter 1. Introduction

Table of Contents

-
-
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
@@ -70,9 +70,9 @@ hierarchical databases.

-
+

-Scope of Document

+Scope of Document

@@ -87,9 +87,9 @@

This version of the manual corresponds to BIND version 9.11.

-
+

-Organization of This Document

+Organization of This Document

In this document, Chapter 1 introduces @@ -117,9 +117,9 @@ System.

-
+

-Conventions Used in This Document

+Conventions Used in This Document

@@ -252,9 +252,9 @@

-
+

-The Domain Name System (DNS)

+The Domain Name System (DNS)

The purpose of this document is to explain the installation @@ -264,9 +264,9 @@ (DNS) as they relate to BIND.

-
+

-DNS Fundamentals

+DNS Fundamentals

@@ -290,9 +290,9 @@

-
+

-Domains and Domain Names

+Domains and Domain Names

@@ -343,9 +343,9 @@

-
+

-Zones

+Zones

To properly operate a name server, it is important to understand @@ -401,9 +401,9 @@

-
+

-Authoritative Name Servers

+Authoritative Name Servers

@@ -422,9 +422,9 @@ dig (the section called “Diagnostic Tools”).

-
+

-The Primary Master

+The Primary Master

@@ -446,9 +446,9 @@

-
+

-Slave Servers

+Slave Servers

The other authoritative servers, the slave @@ -464,9 +464,9 @@

-
+

-Stealth Servers

+Stealth Servers

@@ -505,9 +505,9 @@

-
+

-Caching Name Servers

+Caching Name Servers
@@ -540,9 +540,9 @@ Time To Live (TTL) field associated with each resource record.

-
+

-Forwarding

+Forwarding

@@ -572,9 +572,9 @@

-
+

-Name Servers in Multiple Roles

+Name Servers in Multiple Roles

diff --git a/doc/arm/Bv9ARM.ch02.html b/doc/arm/Bv9ARM.ch02.html index 9e7ce8cb91..add10c5229 100644 --- a/doc/arm/Bv9ARM.ch02.html +++ b/doc/arm/Bv9ARM.ch02.html @@ -18,7 +18,7 @@ Chapter 2. BIND Resource Requirements - + @@ -38,24 +38,24 @@

-
-

-Chapter 2. BIND Resource Requirements

+
+

+Chapter 2. BIND Resource Requirements

Table of Contents

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

-Hardware requirements

+Hardware requirements

@@ -74,9 +74,9 @@ multiprocessor systems for installations that need it.

-
+

-CPU Requirements

+CPU Requirements

CPU requirements for BIND 9 range from @@ -87,9 +87,9 @@

-
+

-Memory Requirements

+Memory Requirements

The memory of the server has to be large enough to fit the @@ -113,9 +113,9 @@

-
+

-Name Server Intensive Environment Issues

+Name Server Intensive Environment Issues

For name server intensive environments, there are two alternative @@ -132,9 +132,9 @@

-
+

-Supported Operating Systems

+Supported Operating Systems

ISC BIND 9 compiles and runs on a large diff --git a/doc/arm/Bv9ARM.ch03.html b/doc/arm/Bv9ARM.ch03.html index 1d4b7590f6..b804ecc7ca 100644 --- a/doc/arm/Bv9ARM.ch03.html +++ b/doc/arm/Bv9ARM.ch03.html @@ -18,7 +18,7 @@ Chapter 3. Name Server Configuration - + @@ -38,22 +38,22 @@

-
-

-Chapter 3. Name Server Configuration

+
+

+Chapter 3. Name Server Configuration

Table of Contents

-
+
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
@@ -64,13 +64,13 @@ 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 @@ -102,9 +102,9 @@ 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 @@ -154,9 +154,9 @@ zone "eng.example.com" {

-
+

-Load Balancing

+Load Balancing
@@ -306,14 +306,14 @@ zone "eng.example.com" {
-
+

-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, @@ -321,7 +321,7 @@ zone "eng.example.com" { administrator for controlling and debugging the name server daemon.

-
+

Diagnostic Tools

@@ -333,7 +333,7 @@ zone "eng.example.com" { output format.

-
+
dig

@@ -442,7 +442,7 @@ zone "eng.example.com" {

-
+

Administrative Tools

@@ -450,7 +450,7 @@ zone "eng.example.com" { Administrative tools play an integral part in the management of a server.

-
+
named-checkconf
@@ -701,9 +701,9 @@ controls {
-
+

-Signals

+Signals

diff --git a/doc/arm/Bv9ARM.ch04.html b/doc/arm/Bv9ARM.ch04.html index ca7b94acaa..bc55510312 100644 --- a/doc/arm/Bv9ARM.ch04.html +++ b/doc/arm/Bv9ARM.ch04.html @@ -18,7 +18,7 @@ Chapter 4. Advanced DNS Features - + @@ -38,86 +38,86 @@

-
-

-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
+
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)
+
TKEY
+
SIG(0)
DNSSEC
-
Generating Keys
-
Signing the Zone
-
Configuring Servers
+
Generating Keys
+
Signing the Zone
+
Configuring Servers
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
-
Validating Resolver
-
Authoritative Server
+
Validating Resolver
+
Authoritative Server
PKCS#11 (Cryptoki) support
-
Prerequisites
-
Native PKCS#11
-
OpenSSL-based PKCS#11
-
PKCS#11 Tools
-
Using the HSM
-
Specifying the engine on the command line
-
Running named with automatic zone re-signing
+
Prerequisites
+
Native PKCS#11
+
OpenSSL-based PKCS#11
+
PKCS#11 Tools
+
Using the HSM
+
Specifying the engine on the command line
+
Running named with automatic zone re-signing
DLZ (Dynamically Loadable Zones)
-
Configuring DLZ
-
Sample DLZ Driver
+
Configuring DLZ
+
Sample DLZ Driver
DynDB (Dynamic Database)
-
Configuring DynDB
-
Sample DynDB Module
+
Configuring DynDB
+
Sample DynDB Module
-
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

@@ -139,7 +139,7 @@ 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 @@ -150,7 +150,7 @@
-
+

Dynamic Update

@@ -195,7 +195,7 @@ signatures and an explicit server policy.

-
+

The journal file

@@ -271,7 +271,7 @@
-
+

Incremental Zone Transfers (IXFR)

@@ -304,9 +304,9 @@

-
+

-Split DNS

+Split DNS

Setting up different views, or visibility, of the DNS space to @@ -335,9 +335,9 @@ 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. @@ -421,7 +421,7 @@ If everything has been set properly, Example, Inc.'s internal clients will now be able to:

-
    +
    • Look up any hostnames in the site1 @@ -445,7 +445,7 @@

      Hosts on the Internet will be able to:

      -
        +
        • Look up any hostnames in the site1 @@ -586,7 +586,7 @@ nameserver 172.16.72.4
      -
      +

      TSIG

      @@ -616,18 +616,18 @@ nameserver 172.16.72.4 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 @@ -650,9 +650,9 @@ nameserver 172.16.72.4 be used as the shared secret.

    -
    +

    -Manual Generation

    +Manual Generation

The shared secret is simply a random sequence of bits, encoded @@ -666,18 +666,18 @@ nameserver 172.16.72.4

-
+

-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 @@ -706,9 +706,9 @@ key host1-host2. {

-
+

-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 @@ -741,9 +741,9 @@ server 10.1.2.3 { sign request messages to host1.

-
+

-TSIG Key Based Access Control

+TSIG Key Based Access Control

BIND allows IP addresses and ranges @@ -773,9 +773,9 @@ allow-update { key host1-host2. ;};

-
+

-Errors

+Errors

@@ -803,9 +803,9 @@ allow-update { key host1-host2. ;};

-
+

-TKEY

+TKEY

TKEY @@ -843,9 +843,9 @@ allow-update { key host1-host2. ;};

-
+

-SIG(0)

+SIG(0)

@@ -874,7 +874,7 @@ allow-update { key host1-host2. ;};

-
+

DNSSEC

@@ -916,9 +916,9 @@ allow-update { key host1-host2. ;}; zone key of another zone above this one in the DNS tree.

-
+

-Generating Keys

+Generating Keys

@@ -982,9 +982,9 @@ allow-update { key host1-host2. ;};

-
+

-Signing the Zone

+Signing the Zone

@@ -1033,9 +1033,9 @@ allow-update { key host1-host2. ;};

-
+

-Configuring Servers

+Configuring Servers

@@ -1158,7 +1158,7 @@ options { }; -

+

Note

None of the keys listed in this example are valid. In particular, the root key is not valid. @@ -1178,7 +1178,7 @@ options { been secure.

-
+

Note

When the validator receives a response from an unsigned zone @@ -1203,16 +1203,16 @@ options {

-
+

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 @@ -1239,9 +1239,9 @@ options { 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:

@@ -1278,9 +1278,9 @@ options { 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 @@ -1344,9 +1344,9 @@ options { 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 @@ -1388,17 +1388,17 @@ options {

-
+

-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 @@ -1421,9 +1421,9 @@ options { 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 @@ -1439,9 +1439,9 @@ 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

+NSEC3PARAM rollovers via UPDATE

Add the new NSEC3PARAM record via dynamic update. When the @@ -1449,9 +1449,9 @@ options { 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 @@ -1459,18 +1459,18 @@ options { 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, @@ -1486,9 +1486,9 @@ options { 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 @@ -1496,9 +1496,9 @@ options { 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

@@ -1513,7 +1513,7 @@ options { changed.

-
+

Dynamic Trust Anchor Management

@@ -1522,9 +1522,9 @@ options { 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 @@ -1535,9 +1535,9 @@ options { and Usage”.

-
+

-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 @@ -1601,7 +1601,7 @@ $ dnssec-signzone -S -K keys example.net<

-
+

PKCS#11 (Cryptoki) support

@@ -1635,9 +1635,9 @@ $ dnssec-signzone -S -K keys example.net< OpenSSL completely; BIND loads the provider library itself, and uses the PKCS#11 API to drive the HSM directly.

-
+

-Prerequisites

+Prerequisites

See the documentation provided by your HSM vendor for @@ -1645,9 +1645,9 @@ $ dnssec-signzone -S -K keys example.net< troubleshooting the HSM.

-
+

-Native PKCS#11

+Native PKCS#11

Native PKCS#11 mode will only work with an HSM capable of carrying @@ -1679,9 +1679,9 @@ $ ./configure --enable-native-pkcs11 \ dnssec-* tools, or the -m in the pkcs11-* tools.)

-
+

-Building SoftHSMv2

+Building SoftHSMv2

SoftHSMv2, the latest development version of SoftHSM, is available @@ -1718,9 +1718,9 @@ $ /opt/pkcs11/usr/bin/softhsm-util --init-token

-
+

-OpenSSL-based PKCS#11

+OpenSSL-based PKCS#11

OpenSSL-based PKCS#11 mode uses a modified version of the @@ -1736,7 +1736,7 @@ $ /opt/pkcs11/usr/bin/softhsm-util --init-token configuration time. The correct choice depends on the HSM hardware:

-
    +

    • Use 'crypto-accelerator' with HSMs that have hardware @@ -1768,7 +1768,7 @@ $ /opt/pkcs11/usr/bin/softhsm-util --init-token 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 as of this writing (January 2015) are 0.9.8zc, 1.0.0o, and 1.0.1j. @@ -1781,9 +1781,9 @@ $ /opt/pkcs11/usr/bin/softhsm-util --init-token necessary to build OpenSSL with the patch in place, and configure it with the path to your HSM's PKCS#11 provider library.

      -
      +

      -Patching OpenSSL

      +Patching OpenSSL
       $ wget http://www.openssl.org/source/openssl-0.9.8zc.tar.gz
@@ -1797,7 +1797,7 @@ $ tar zxf openssl-0.9.8zc.tar.gz
 $ patch -p1 -d openssl-0.9.8zc \
 	      < bind9/bin/pkcs11/openssl-0.9.8zc-patch
      -
      +

      Note

      Note that the patch file may not be compatible with the "patch" utility on all operating systems. You may need to @@ -1815,9 +1815,9 @@ $ patch -p1 -d openssl-0.9.8zc \ OpenSSL library will need to be specified via configure.

      -
      +

      -Building OpenSSL for the AEP Keyper on Linux

      +Building OpenSSL for the AEP Keyper on Linux

      @@ -1859,9 +1859,9 @@ $ ./Configure linux-generic32 -m32 -pthread \ add the -pthread above.

      -
      +

      -Building OpenSSL for the SCA 6000 on Solaris

      +Building OpenSSL for the SCA 6000 on Solaris

    @@ -1890,9 +1890,9 @@ $ ./Configure solaris64-x86_64-cc \ make test.

-
+

-Building OpenSSL for SoftHSM

+Building OpenSSL for SoftHSM

@@ -1967,9 +1967,9 @@ $ ./Configure linux-x86_64 -pthread \ "make install" which will install the modified OpenSSL suite to /opt/pkcs11/usr.

-
+

-Configuring BIND 9 for Linux with the AEP Keyper

+Configuring BIND 9 for Linux with the AEP Keyper

@@ -1989,9 +1989,9 @@ $ ./configure CC="gcc -m32" --enable-threads \ --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

@@ -2013,9 +2013,9 @@ $ ./configure CC="cc -xarch=amd64" --enable-thre Configure).

-
+

-Configuring BIND 9 for SoftHSM

+Configuring BIND 9 for SoftHSM
@@ -2036,9 +2036,9 @@ $ ./configure --enable-threads \
       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 @@ -2060,9 +2060,9 @@ $ ./configure --enable-threads \ provider.)

-
+

-Using the HSM

+Using the HSM

For OpenSSL-based PKCS#11, we must first set up the runtime @@ -2182,9 +2182,9 @@ 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

When using OpenSSL-based PKCS#11, the "engine" to be used by @@ -2215,9 +2215,9 @@ $ dnssec-signzone -E '' -S example.net

-
+

-Running named with automatic zone re-signing

+Running named with automatic zone re-signing

If you want named to dynamically re-sign zones @@ -2255,7 +2255,7 @@ $ dnssec-signzone -E '' -S example.net/etc/hsmpin.

-
+

Warning

Placing the HSM's PIN in a text file in this manner may reduce the @@ -2266,7 +2266,7 @@ $ dnssec-signzone -E '' -S example.net

-
+

DLZ (Dynamically Loadable Zones)

@@ -2307,9 +2307,9 @@ $ dnssec-signzone -E '' -S example.net -
+

-Configuring DLZ

+Configuring DLZ

A DLZ database is configured with a dlz @@ -2357,9 +2357,9 @@ $ dnssec-signzone -E '' -S example.net

-
+

-Sample DLZ Driver

+Sample DLZ Driver

For guidance in implementation of DLZ modules, the directory @@ -2409,7 +2409,7 @@ $ dnssec-signzone -E '' -S example.net -

+

DynDB (Dynamic Database)

@@ -2436,9 +2436,9 @@ $ dnssec-signzone -E '' -S example.netbin/tests/system/dyndb/driver.

-
+

-Configuring DynDB

+Configuring DynDB

A DynDB database is configured with a dyndb @@ -2465,9 +2465,9 @@ $ dnssec-signzone -E '' -S example.net

-
+

-Sample DynDB Module

+Sample DynDB Module

For guidance in implementation of DynDB modules, the directory @@ -2503,9 +2503,9 @@ $ dnssec-signzone -E '' -S example.net -

+

-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 @@ -2545,9 +2545,9 @@ $ dnssec-signzone -E '' -S example.netthe section called “IPv6 addresses (AAAA)”.

-
+

-Address Lookups Using AAAA Records

+Address Lookups Using AAAA Records

@@ -2568,9 +2568,9 @@ host 3600 IN AAAA 2001:db8::1 the address.

-
+

-Address to Name Lookups Using Nibble Format

+Address to Name Lookups Using Nibble Format

diff --git a/doc/arm/Bv9ARM.ch05.html b/doc/arm/Bv9ARM.ch05.html index 8fca93ea55..306d3fcc9a 100644 --- a/doc/arm/Bv9ARM.ch05.html +++ b/doc/arm/Bv9ARM.ch05.html @@ -18,7 +18,7 @@ Chapter 5. The BIND 9 Lightweight Resolver - + @@ -38,20 +38,20 @@

-
-

-Chapter 5. The BIND 9 Lightweight Resolver

+
+

+Chapter 5. The BIND 9 Lightweight Resolver

Table of Contents

-
-
The Lightweight Resolver Library
+
+
The Lightweight Resolver Library
Running a Resolver Daemon
-
+

-The Lightweight Resolver Library

+The Lightweight Resolver Library

Traditionally applications have been linked with a stub resolver @@ -74,7 +74,7 @@ that is distinct from and simpler than the full DNS protocol.

-
+

Running a Resolver Daemon

diff --git a/doc/arm/Bv9ARM.ch06.html b/doc/arm/Bv9ARM.ch06.html index 25cb9f05fb..0d96ab4729 100644 --- a/doc/arm/Bv9ARM.ch06.html +++ b/doc/arm/Bv9ARM.ch06.html @@ -18,7 +18,7 @@ Chapter 6. BIND 9 Configuration Reference - + @@ -38,67 +38,67 @@
-
-

-Chapter 6. BIND 9 Configuration Reference

+
+

+Chapter 6. BIND 9 Configuration Reference

Table of Contents

-
+
Configuration File Elements
Address Match Lists
-
Comment Syntax
+
Comment Syntax
Configuration File Grammar
-
acl Statement Grammar
+
acl Statement Grammar
acl Statement Definition and Usage
-
controls Statement Grammar
+
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 Grammar
options Statement Definition and Usage
server Statement Grammar
server Statement Definition and Usage
statistics-channels Statement Grammar
-
statistics-channels Statement Definition and +
statistics-channels Statement Definition and Usage
trusted-keys Statement Grammar
-
trusted-keys Statement Definition +
trusted-keys Statement Definition and Usage
-
managed-keys Statement Grammar
+
managed-keys Statement Grammar
managed-keys Statement Definition and Usage
view Statement Grammar
-
view Statement Definition and Usage
+
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
+
Discussion of MX Records
Setting TTLs
-
Inverse Mapping in IPv4
-
Other Zone File Directives
-
BIND Master File Extension: the $GENERATE Directive
+
Inverse Mapping in IPv4
+
Other Zone File Directives
+
BIND Master File Extension: the $GENERATE Directive
Additional File Formats
BIND9 Statistics
@@ -127,7 +127,7 @@ using the shell script contrib/named-bootconf/named-bootconf.sh.

-
+

Configuration File Elements

@@ -526,13 +526,13 @@
-
+

Address Match Lists

-
+

-Syntax

+Syntax
address_match_list = address_match_list_element ;
@@ -542,9 +542,9 @@
-
+

-Definition and Usage

+Definition and Usage

Address match lists are primarily used to determine access @@ -553,7 +553,7 @@ statements. The elements which constitute an address match list can be any of the following:

-
    +
    • an IP address (IPv4 or IPv6)
      • @@ -645,9 +645,9 @@
-
+

-Comment Syntax

+Comment Syntax

@@ -658,9 +658,9 @@ in the C, C++, or shell/perl style.

-
+

-Syntax

+Syntax

@@ -676,9 +676,9 @@

-
+

-Definition and Usage

+Definition and Usage

Comments may appear anywhere that whitespace may appear in @@ -742,7 +742,7 @@

-
+

Warning

You cannot use the semicolon (`;') character @@ -755,7 +755,7 @@

-
+

Configuration File Grammar

@@ -943,9 +943,9 @@ configuration.

-
+

-acl Statement Grammar

+acl Statement Grammar
acl acl-name {
@@ -954,7 +954,7 @@
-
+

acl Statement Definition and Usage

@@ -1034,9 +1034,9 @@
-
+

-controls Statement Grammar

+controls Statement Grammar
controls {
@@ -1052,7 +1052,7 @@
 
       
 
-      

+      

 

 controls Statement Definition and
           Usage

@@ -1174,15 +1174,15 @@
         

 
       

-      

+      

 

-include Statement Grammar

+include Statement Grammar

         
         
include filename;

       
-      

+      

 

-include Statement Definition and
+include Statement Definition and
           Usage

         
 
@@ -1198,9 +1198,9 @@
         

 
       

-      

+      

 

-key Statement Grammar

+key Statement Grammar

         
 
 
key key_id {
@@ -1211,9 +1211,9 @@
 
       
 
-      

+      

 

-key Statement Definition and Usage

+key Statement Definition and Usage

         
 
         

@@ -1262,9 +1262,9 @@
         

 
       
-      

+      

 

-logging Statement Grammar

+logging Statement Grammar

         
 
 
logging {
@@ -1291,9 +1291,9 @@
 
       
 
-      

+      

 

-logging Statement Definition and
+logging Statement Definition and
           Usage

         
 
@@ -1343,9 +1343,9 @@
           was specified.
         

 
-        

+        

 

-The channel Phrase

+The channel Phrase

           
 
           

@@ -1623,7 +1623,7 @@ channel default_logfile {
           

         

 
-        

+        

 

 The category Phrase

           
@@ -2050,9 +2050,9 @@ category notify { null; };
 
 

         

-        

+        

 

-The query-errors Category

+The query-errors Category

           

             The query-errors category is
             specifically intended for debugging purposes: To identify
@@ -2283,9 +2283,9 @@ badresp:1,adberr:0,findfail:0,valfail:0]
         
       
 
-      

+      

 

-lwres Statement Grammar

+lwres Statement Grammar

         
 
         

@@ -2305,9 +2305,9 @@ badresp:1,adberr:0,findfail:0,valfail:0]
 

 
       
-      

+      

 

-lwres Statement Definition and Usage

+lwres Statement Definition and Usage

         
 
         

@@ -2387,9 +2387,9 @@ badresp:1,adberr:0,findfail:0,valfail:0]
           lwres-tasks times lwres-clients.
         

       
-      

+      

 

-masters Statement Grammar

+masters Statement Grammar

         
 
 
@@ -2399,9 +2399,9 @@ badresp:1,adberr:0,findfail:0,valfail:0]
 
       
 
-      

+      

 

-masters Statement Definition and
+masters Statement Definition and
           Usage

         
         
masters
@@ -2411,9 +2411,9 @@ badresp:1,adberr:0,findfail:0,valfail:0]
         

       

 
-      

+      

 

-options Statement Grammar

+options Statement Grammar

         
 
         

@@ -2701,7 +2701,7 @@ badresp:1,adberr:0,findfail:0,valfail:0]
 
       
 
-      

+      

 

 options Statement Definition and
           Usage

@@ -2717,7 +2717,7 @@ badresp:1,adberr:0,findfail:0,valfail:0]
           be used.
         

 
-        

+        

 
attach-cache

 

                 

@@ -3672,12 +3672,12 @@ options {
             

 

 
-        

+        

 

 Boolean Options

           
 
-          

+          

 
automatic-interface-scan

 

                 

@@ -4210,7 +4210,7 @@ options {
                   record for negative
                   answers. The default is no.
                 

-                

+                

 
Note

                   

                     Not yet implemented in BIND
@@ -4557,7 +4557,7 @@ options {
                   managed-keys statement.  The default
                   is yes.
                 

-                

+                

 
Note

                   

                     Whenever the resolver sends out queries to an
@@ -4804,9 +4804,9 @@ options {
 
         

 
-        

+        

 

-Forwarding

+Forwarding

           
           

             The forwarding facility can be used to create a large site-wide
@@ -4819,7 +4819,7 @@ options {
             its cache.
           

 
-          

+          

 
forward

 

                 

@@ -4855,9 +4855,9 @@ options {
           

         

 
-        

+        

 

-Dual-stack Servers

+Dual-stack Servers

           
           

             Dual-stack servers are used as servers of last resort to work
@@ -4867,7 +4867,7 @@ options {
             on the host machine.
           

 
-          

+          

 
dual-stack-servers

 

                 

@@ -4884,7 +4884,7 @@ options {
 

         

 
-        

+        

 

 Access Control

           
@@ -4895,7 +4895,7 @@ options {
             details on how to specify IP address lists.
           

 
-          

+          

 
allow-notify

 

                 

@@ -4924,7 +4924,7 @@ options {
                   If not specified, the default is to allow queries
                   from all hosts.
                 

-                

+                

 
Note

                   

                     allow-query-cache is now
@@ -4957,7 +4957,7 @@ options {
                   If not specified, the default is to allow queries
                   on all addresses.
                 

-                

+                

 
Note

                   

                     allow-query-cache is
@@ -5167,9 +5167,9 @@ options {
 
         

 
-        

+        

 

-Interfaces

+Interfaces

           
           

             The interfaces and ports that the server will answer queries
@@ -5260,7 +5260,7 @@ listen-on-v6 port 1234 { !2001:db8::/32; any; };
 
         

 
-        

+        

 

 Query Address

           
@@ -5364,7 +5364,7 @@ avoid-v6-udp-ports {};
             it implicitly disables the use of randomized port numbers.
           

 
-          

+          

 
use-queryport-pool

 

                 

@@ -5384,7 +5384,7 @@ avoid-v6-udp-ports {};
                 

               

 

-          

+          

 
Note

             

               The address specified in the query-source option
@@ -5393,14 +5393,14 @@ avoid-v6-udp-ports {};
               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
@@ -5409,7 +5409,7 @@ avoid-v6-udp-ports {};
           

         

 
-        

+        

 

 Zone Transfers

           
@@ -5420,7 +5420,7 @@ avoid-v6-udp-ports {};
             system. The following options apply to zone transfers.
           

 
-          

+          

 
also-notify

 

                 

@@ -5628,7 +5628,7 @@ avoid-v6-udp-ports {};
                   zone block in the configuration
                   file.
                 

-                

+                

 
Note

                   

                     Solaris 2.5.1 and earlier does not support setting the
@@ -5651,7 +5651,7 @@ avoid-v6-udp-ports {};
                   use-alt-transfer-source is
                   set.
                 

-                

+                

 
Note

                   If you do not wish the alternate transfer source
                   to be used, you should set
@@ -5696,7 +5696,7 @@ avoid-v6-udp-ports {};
                   view block in the configuration
                   file.
                 

-                

+                

 
Note

                   

                     Solaris 2.5.1 and earlier does not support setting the
@@ -5715,9 +5715,9 @@ avoid-v6-udp-ports {};
 
         

 
-        

+        

 

-UDP Port Lists

+UDP Port Lists

           
           

             use-v4-udp-ports,
@@ -5762,9 +5762,9 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
            

         

 
-        

+        

 

-Operating System Resource Limits

+Operating System Resource Limits

           
 
           

@@ -5790,7 +5790,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
             unsupported limit is used.
           

 
-          

+          

 
coresize

 

                 

@@ -5835,7 +5835,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
 
         

 
-        

+        

 

 Server  Resource Limits

           
@@ -5846,7 +5846,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
             server rather than the operating system.
           

 
-          

+          

 
max-ixfr-log-size

 

                 

@@ -6141,12 +6141,12 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
 
         

 
-        

+        

 

-Periodic Task Intervals

+Periodic Task Intervals

           
 
-          

+          

 
cleaning-interval

 

                 

@@ -6198,7 +6198,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
                   60. The maximum value is 28 days (40320 minutes).
                   If set to 0, no statistics will be logged.
                   

-

+

 
Note

                   

                     Not yet implemented in
@@ -6210,7 +6210,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
 
         

 
-        

+        

 

 Topology

           
@@ -6252,7 +6252,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
 
    topology { localhost; localnets; };
 

 
-          

+          

 
Note

             

               The topology option
@@ -6261,7 +6261,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
           

         

 
-        

+        

 

 The sortlist Statement

 
@@ -6378,7 +6378,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
 

 
         
-        

+        

 

 RRset Ordering

           
@@ -6482,7 +6482,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
             By default, all records are returned in random order.
           

 
-          

+          

 
Note

             

               In this release of BIND 9, the
@@ -6494,12 +6494,12 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
           

         

 
-        

+        

 

 Tuning

           
 
-          

+          

 
lame-ttl

 

                 

@@ -6565,7 +6565,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
                   accepted. The default
                   is 2.
                 

-                

+                

 
Note

                   

                     Not implemented in BIND 9.
@@ -6907,7 +6907,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
 
         

 
-        

+        

 

 Built-in server information zones

           
@@ -6939,7 +6939,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
             that matches all clients.
           

 
-          

+          

 
version

 

                 

@@ -6986,7 +6986,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
 
         

 
-        

+        

 

 Built-in Empty Zones

           
@@ -7012,7 +7012,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
           

             The current list of empty zones is:
             

-
    
+
      
 
    • 10.IN-ADDR.ARPA
      • 
 
    • 16.172.IN-ADDR.ARPA
      • 
 
    • 17.172.IN-ADDR.ARPA
      • 
@@ -7134,14 +7134,14 @@ 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
      
 
      
                 
      
@@ -7175,7 +7175,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
 
      
         
      
 
-        
      
+        
      
 
      
 Additional Section Caching
      
           
@@ -7246,7 +7246,7 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
             acache.
           
      
 
-          
      
+          
      
 
      acache-enable
      
 
      
                 
      
@@ -7282,9 +7282,9 @@ avoid-v6-udp-ports { 40000; range 50000 60000; };
 
         
      
 
-        
      
+        
      
 
      
-Content Filtering
      
+Content Filtering
      
           
           
      
             BIND 9 provides the ability to filter
@@ -7421,9 +7421,9 @@ deny-answer-aliases { "example.net"; };
           
      
         
      
 
-        
      
+        
      
 
      
-Response Policy Zone (RPZ) Rewriting
      
+Response Policy Zone (RPZ) Rewriting
      
           
           
      
             BIND 9 includes a limited
@@ -7457,7 +7457,7 @@ deny-answer-aliases { "example.net"; };
           
      
             Five policy triggers can be encoded in RPZ records.
             
      
-
      
+
      
 
      RPZ-CLIENT-IP
      
 
      
                   
      
@@ -7589,7 +7589,7 @@ deny-answer-aliases { "example.net"; };
             it can be used with any type of trigger to force the use of
             TCP for responses with owner names in a zone.
             
      
-
      
+
      
 
      PASSTHRU
      
 
      
                   
      
@@ -7665,7 +7665,7 @@ deny-answer-aliases { "example.net"; };
             organization might use this mechanism to redirect domains
             to its own walled garden.
             
      
-
      
+
      
 
      GIVEN
      
 
      
                   
      The placeholder policy says "do not override but
@@ -7843,9 +7843,9 @@ example.com                 CNAME   rpz-tcp-only.
           
      
         
      
 
-        
      
+        
      
 
      
-Response Rate Limiting
      
+Response Rate Limiting
      
           
           
      
             Excessive almost identical UDP responses
@@ -8109,7 +8109,7 @@ example.com                 CNAME   rpz-tcp-only.
           
      
             Named supports NXDOMAIN redirection via two methods:
             
      
-
      
 
-      
      
+      
      
 
      
 server Statement Grammar
      
         
@@ -8182,7 +8182,7 @@ example.com                 CNAME   rpz-tcp-only.
 
         
      
 
-        
      
+        
      
 
      
 server Statement Definition and
             Usage
      
@@ -8429,7 +8429,7 @@ example.com                 CNAME   rpz-tcp-only.
           
      
         
      
 
-      
      
+      
      
 
      
 statistics-channels Statement Grammar
      
         
@@ -8442,9 +8442,9 @@ example.com                 CNAME   rpz-tcp-only.
 

       
 
-      

+      

 

-statistics-channels Statement Definition and
+statistics-channels Statement Definition and
             Usage

           
 
@@ -8565,7 +8565,7 @@ example.com                 CNAME   rpz-tcp-only.
         

       

 
-        

+        

 

 trusted-keys Statement Grammar

           
@@ -8577,9 +8577,9 @@ example.com                 CNAME   rpz-tcp-only.
-
+

-trusted-keys Statement Definition +trusted-keys Statement Definition and Usage

@@ -8623,9 +8623,9 @@ example.com CNAME rpz-tcp-only.

-
+

-managed-keys Statement Grammar

+managed-keys Statement Grammar
managed-keys {
@@ -8635,7 +8635,7 @@ example.com                 CNAME   rpz-tcp-only.
-
+

managed-keys Statement Definition and Usage

@@ -8753,7 +8753,7 @@ example.com CNAME rpz-tcp-only.

-
+

view Statement Grammar

@@ -8769,9 +8769,9 @@ example.com CNAME rpz-tcp-only.
-
+

-view Statement Definition and Usage

+view Statement Definition and Usage

@@ -8899,7 +8899,7 @@ view "external" {

-
+

zone Statement Grammar

@@ -9104,13 +9104,13 @@ zone zone_name [
-
+

-zone Statement Definition and Usage

+zone Statement Definition and Usage
-
+

-Zone Types

+Zone Types

The type keyword is required for the zone configuration unless @@ -9440,9 +9440,9 @@ zone zone_name [ -

+

-Class

+Class

The zone's name may optionally be followed by a class. If @@ -9464,12 +9464,12 @@ zone zone_name [ -

+

-Zone Options

+Zone Options
-
+
allow-notify

@@ -10042,7 +10042,7 @@ example.com. NS ns2.example.net.

-
+

Dynamic Update Policies

@@ -10376,7 +10376,7 @@ example.com. NS ns2.example.net. IP address into the IN-ADDR.ARPA and IP6.ARPA namespaces match the name to be updated.

-
+

Note

It is theoretically possible to spoof these TCP sessions. @@ -10397,7 +10397,7 @@ example.com. NS ns2.example.net. to allow NS or DNAME RRsets to be added to the reverse tree.

-
+

Note

It is theoretically possible to spoof these TCP sessions. @@ -10468,9 +10468,9 @@ example.com. NS ns2.example.net.

-
+

-Multiple views

+Multiple views

When multiple views are in use, a zone may be @@ -10532,11 +10532,11 @@ view external {

-
+

-Zone File

+Zone File
-
+

Types of Resource Records and When to Use Them

@@ -10547,9 +10547,9 @@ view external { identified and implemented in the DNS. These are also included.

-
+

-Resource Records

+Resource Records

@@ -11730,9 +11730,9 @@ view external { 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 @@ -11939,9 +11939,9 @@ view external { -

+

-Discussion of MX Records

+Discussion of MX Records

@@ -12127,7 +12127,7 @@ view external { be attempted.

-
+

Setting TTLs

@@ -12202,9 +12202,9 @@ view external { can be explicitly specified, for example, 1h30m.

-
+

-Inverse Mapping in IPv4

+Inverse Mapping in IPv4

Reverse name resolution (that is, translation from IP address @@ -12255,7 +12255,7 @@ view external { -

+

Note

The $ORIGIN lines in the examples @@ -12266,9 +12266,9 @@ view external {

-
+

-Other Zone File Directives

+Other Zone File Directives

The Master File Format was initially defined in RFC 1035 and @@ -12282,9 +12282,9 @@ view external { 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 @@ -12294,9 +12294,9 @@ view external { trailing dot).

-
+

-The $ORIGIN Directive

+The $ORIGIN Directive

Syntax: $ORIGIN @@ -12328,9 +12328,9 @@ WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM. -

+

-The $INCLUDE Directive

+The $INCLUDE Directive

Syntax: $INCLUDE @@ -12351,7 +12351,7 @@ WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM. 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 @@ -12365,9 +12365,9 @@ WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM.

-
+

-The $TTL Directive

+The $TTL Directive

Syntax: $TTL @@ -12385,9 +12385,9 @@ WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM.

-
+

-BIND Master File Extension: the $GENERATE Directive

+BIND Master File Extension: the $GENERATE Directive

Syntax: $GENERATE @@ -12590,7 +12590,7 @@ HOST-127.EXAMPLE. MX 0 .

-
+

Additional File Formats

@@ -12652,7 +12652,7 @@ HOST-127.EXAMPLE. MX 0 .
-
+

BIND9 Statistics

@@ -12801,7 +12801,7 @@ HOST-127.EXAMPLE. MX 0 . (see the section called “statistics-channels Statement Grammar”.)

-
+

The Statistics File

@@ -12842,7 +12842,7 @@ HOST-127.EXAMPLE. MX 0 .

-
+

Statistics Counters

@@ -12863,9 +12863,9 @@ HOST-127.EXAMPLE. MX 0 . BIND 8 statistics, if applicable.

-
+

-Name Server Statistics Counters

+Name Server Statistics Counters
@@ -13491,9 +13491,9 @@ HOST-127.EXAMPLE. MX 0 .
-
+

-Zone Maintenance Statistics Counters

+Zone Maintenance Statistics Counters
@@ -13650,9 +13650,9 @@ HOST-127.EXAMPLE. MX 0 .
-
+

-Resolver Statistics Counters

+Resolver Statistics Counters
@@ -14039,9 +14039,9 @@ HOST-127.EXAMPLE. MX 0 .
-
+

-Socket I/O Statistics Counters

+Socket I/O Statistics Counters

@@ -14199,9 +14199,9 @@ HOST-127.EXAMPLE. MX 0 . -

+

-Compatibility with BIND 8 Counters

+Compatibility with BIND 8 Counters

Most statistics counters that were available @@ -14211,7 +14211,7 @@ HOST-127.EXAMPLE. MX 0 . in these tables.

-
+
RFwdR,SFwdR

diff --git a/doc/arm/Bv9ARM.ch07.html b/doc/arm/Bv9ARM.ch07.html index ec016207fd..7b164e0690 100644 --- a/doc/arm/Bv9ARM.ch07.html +++ b/doc/arm/Bv9ARM.ch07.html @@ -18,7 +18,7 @@ Chapter 7. BIND 9 Security Considerations - + @@ -38,23 +38,23 @@

-
-

-Chapter 7. BIND 9 Security Considerations

+
+

+Chapter 7. BIND 9 Security Considerations

Table of Contents

-
+
Access Control Lists
-
Chroot and Setuid
+
Chroot and Setuid
-
The chroot Environment
-
Using the setuid Function
+
The chroot Environment
+
Using the setuid Function
Dynamic Update Security
-
+

Access Control Lists

@@ -248,9 +248,9 @@ allow-query { !{ !10/8; any; }; key example; };

-
+

-Chroot and Setuid +Chroot and Setuid

@@ -276,9 +276,9 @@ allow-query { !{ !10/8; any; }; key example; }; /usr/local/sbin/named -u 202 -t /var/named

-
+

-The chroot Environment

+The chroot Environment

@@ -307,9 +307,9 @@ allow-query { !{ !10/8; any; }; key example; };

-
+

-Using the setuid Function

+Using the setuid Function

@@ -323,7 +323,7 @@ allow-query { !{ !10/8; any; }; key example; }; to which you want BIND to write.

-
+

Note

Note that if the named daemon is running as an unprivileged user, it will not be able to bind to new restricted @@ -332,7 +332,7 @@ allow-query { !{ !10/8; any; }; key example; };
-
+

Dynamic Update Security

diff --git a/doc/arm/Bv9ARM.ch08.html b/doc/arm/Bv9ARM.ch08.html index dd5587624a..3d3c63c014 100644 --- a/doc/arm/Bv9ARM.ch08.html +++ b/doc/arm/Bv9ARM.ch08.html @@ -18,7 +18,7 @@ Chapter 8. Troubleshooting - + @@ -38,26 +38,26 @@
-
-

-Chapter 8. Troubleshooting

+
+

+Chapter 8. Troubleshooting

Table of Contents

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

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

@@ -70,9 +70,9 @@

-
+

-Incrementing and Changing the Serial Number

+Incrementing and Changing the Serial Number

@@ -102,9 +102,9 @@

-
+

-Where Can I Get Help?

+Where Can I Get Help?

diff --git a/doc/arm/Bv9ARM.ch09.html b/doc/arm/Bv9ARM.ch09.html index 624679ddb7..662b9c60b7 100644 --- a/doc/arm/Bv9ARM.ch09.html +++ b/doc/arm/Bv9ARM.ch09.html @@ -18,7 +18,7 @@ Appendix A. Release Notes - + @@ -38,13 +38,13 @@

-
-

-Appendix A. Release Notes

+
+

+Appendix A. Release Notes

Table of Contents

-
-
Release Notes for BIND Version 9.11.0pre-alpha
+
+
Release Notes for BIND Version 9.11.0pre-alpha
Introduction
Download
@@ -59,11 +59,11 @@
-
+

-Release Notes for BIND Version 9.11.0pre-alpha

+Release Notes for BIND Version 9.11.0pre-alpha
-
+

Introduction

@@ -72,7 +72,7 @@ of BIND on the corresponding major release branch.

-
+

Download

@@ -84,11 +84,11 @@ operating systems.

-
+

Security Fixes

-
    +

    • An incorrect boundary check in the OPENPGPKEY rdatatype @@ -186,11 +186,11 @@

-
+

New Features

-
    +

    • Added support for DynDB, a new interface for loading zone data @@ -224,7 +224,7 @@ experienced by recursives when they are being used as a vehicle for such an attack.

      -
        +

        • fetches-per-server limits the number of @@ -555,11 +555,11 @@

      -
      +

      Feature Changes

      -
        +

        • ACLs containing geoip asnum elements were @@ -725,11 +725,11 @@

      -
      +

      Porting Changes

      -
      • +

        • The Microsoft Windows install tool BINDInstall.exe which requires a @@ -742,11 +742,11 @@

      -
      +

      Bug Fixes

      -
        +

        • dig, host and @@ -872,7 +872,7 @@

          Several bugs have been fixed in the RPZ implementation:

          -
            +

            • Policy zones that did not specifically require recursion @@ -921,7 +921,7 @@

          -
          +

          End of Life

          @@ -931,7 +931,7 @@ https://www.isc.org/downloads/software-support-policy/

          -
          +

          Thank You

          diff --git a/doc/arm/Bv9ARM.ch10.html b/doc/arm/Bv9ARM.ch10.html index bdf4b4d77b..524ac66dcb 100644 --- a/doc/arm/Bv9ARM.ch10.html +++ b/doc/arm/Bv9ARM.ch10.html @@ -18,7 +18,7 @@ Appendix B. A Brief History of the DNS and BIND - + @@ -39,19 +39,19 @@
          -
          -

          +
          +

          Appendix B. A Brief History of the DNS and BIND -

          +

          Table of Contents

          -
          +
          DNS
          BIND
          -
          +

          DNS

          @@ -90,7 +90,7 @@

          -
          +

          BIND

          diff --git a/doc/arm/Bv9ARM.ch11.html b/doc/arm/Bv9ARM.ch11.html index 035906aa1c..6aa82f8427 100644 --- a/doc/arm/Bv9ARM.ch11.html +++ b/doc/arm/Bv9ARM.ch11.html @@ -18,7 +18,7 @@ Appendix C. General DNS Reference Information - + @@ -38,23 +38,23 @@

          -
          -

          -Appendix C. General DNS Reference Information

          +
          +

          +Appendix C. General DNS Reference Information

          Table of Contents

          -
          +
          IPv6 addresses (AAAA)
          Bibliography (and Suggested Reading)
          Request for Comments (RFCs)
          Internet Drafts
          -
          Other Documents About BIND
          +
          Other Documents About BIND
          -
          +

          IPv6 addresses (AAAA)

          @@ -113,11 +113,11 @@ of zeros that can fit, and can be used only once in an address.

          -
          +

          Bibliography (and Suggested Reading)

          -
          +

          Request for Comments (RFCs)

          @@ -141,16 +141,16 @@

          http://www.ietf.org/rfc/.

          -
          +

          -Bibliography

          -
          +Bibliography
          +

          -Standards

          +Standards
          -

          [RFC974] +

          [RFC974] C. Partridge. Mail Routing and the Domain System. @@ -158,7 +158,7 @@

          -

          [RFC1034] +

          [RFC1034] P.V. Mockapetris. Domain Names — Concepts and Facilities. @@ -166,7 +166,7 @@

          -

          [RFC1035] +

          [RFC1035] P. V. Mockapetris. Domain Names — Implementation and Specification. @@ -174,14 +174,14 @@

          -
          +

          Proposed Standards

          -

          [RFC2181] +

          [RFC2181] R., R. Bush Elz. Clarifications to the DNS @@ -190,7 +190,7 @@

          -

          [RFC2308] +

          [RFC2308] M. Andrews. Negative Caching of DNS @@ -199,7 +199,7 @@

          -

          [RFC1995] +

          [RFC1995] M. Ohta. Incremental Zone Transfer in DNS. @@ -207,7 +207,7 @@

          -

          [RFC1996] +

          [RFC1996] P. Vixie. A Mechanism for Prompt Notification of Zone Changes. @@ -215,7 +215,7 @@

          -

          [RFC2136] +

          [RFC2136] P. Vixie, S. Thomson, Y. Rekhter, and J. Bound. Dynamic Updates in the Domain Name System. @@ -223,7 +223,7 @@

          -

          [RFC2671] +

          [RFC2671] P. Vixie. Extension Mechanisms for DNS (EDNS0). @@ -231,7 +231,7 @@

          -

          [RFC2672] +

          [RFC2672] M. Crawford. Non-Terminal DNS Name Redirection. @@ -239,7 +239,7 @@

          -

          [RFC2845] +

          [RFC2845] P. Vixie, O. Gudmundsson, D. Eastlake, 3rd, and B. Wellington. Secret Key Transaction Authentication for DNS (TSIG). @@ -247,7 +247,7 @@

          -

          [RFC2930] +

          [RFC2930] D. Eastlake, 3rd. Secret Key Establishment for DNS (TKEY RR). @@ -255,7 +255,7 @@

          -

          [RFC2931] +

          [RFC2931] D. Eastlake, 3rd. DNS Request and Transaction Signatures (SIG(0)s). @@ -263,7 +263,7 @@

          -

          [RFC3007] +

          [RFC3007] B. Wellington. Secure Domain Name System (DNS) Dynamic Update. @@ -271,7 +271,7 @@

          -

          [RFC3645] +

          [RFC3645] S. Kwan, P. Garg, J. Gilroy, L. Esibov, J. Westhead, and R. Hall. Generic Security Service Algorithm for Secret @@ -281,12 +281,12 @@

          -
          +

          -DNS Security Proposed Standards

          +DNS Security Proposed Standards
          -

          [RFC3225] +

          [RFC3225] D. Conrad. Indicating Resolver Support of DNSSEC. @@ -294,7 +294,7 @@

          -

          [RFC3833] +

          [RFC3833] D. Atkins and R. Austein. Threat Analysis of the Domain Name System (DNS). @@ -302,7 +302,7 @@

          -

          [RFC4033] +

          [RFC4033] R. Arends, R. Austein, M. Larson, D. Massey, and S. Rose. DNS Security Introduction and Requirements. @@ -310,7 +310,7 @@

          -

          [RFC4034] +

          [RFC4034] R. Arends, R. Austein, M. Larson, D. Massey, and S. Rose. Resource Records for the DNS Security Extensions. @@ -318,7 +318,7 @@

          -

          [RFC4035] +

          [RFC4035] R. Arends, R. Austein, M. Larson, D. Massey, and S. Rose. Protocol Modifications for the DNS @@ -327,13 +327,13 @@

          -
          +

          -Other Important RFCs About DNS +Other Important RFCs About DNS Implementation

          -

          [RFC1535] +

          [RFC1535] E. Gavron. A Security Problem and Proposed Correction With Widely @@ -342,7 +342,7 @@

          -

          [RFC1536] +

          [RFC1536] A. Kumar, J. Postel, C. Neuman, P. Danzig, and S. Miller. Common DNS Implementation @@ -351,7 +351,7 @@

          -

          [RFC1982] +

          [RFC1982] R. Elz and R. Bush. Serial Number Arithmetic. @@ -359,7 +359,7 @@

          -

          [RFC4074] +

          [RFC4074] Y. Morishita and T. Jinmei. Common Misbehaviour Against DNS @@ -368,12 +368,12 @@

          -
          +

          -Resource Record Types

          +Resource Record Types
          -

          [RFC1183] +

          [RFC1183] C.F. Everhart, L. A. Mamakos, R. Ullmann, and P. Mockapetris. New DNS RR Definitions. @@ -381,7 +381,7 @@

          -

          [RFC1706] +

          [RFC1706] B. Manning and R. Colella. DNS NSAP Resource Records. @@ -389,7 +389,7 @@

          -

          [RFC2168] +

          [RFC2168] R. Daniel and M. Mealling. Resolution of Uniform Resource Identifiers using @@ -398,7 +398,7 @@

          -

          [RFC1876] +

          [RFC1876] C. Davis, P. Vixie, T., and I. Dickinson. A Means for Expressing Location Information in the @@ -408,7 +408,7 @@

          -

          [RFC2052] +

          [RFC2052] A. Gulbrandsen and P. Vixie. A DNS RR for Specifying the @@ -418,7 +418,7 @@

          -

          [RFC2163] +

          [RFC2163] A. Allocchio. Using the Internet DNS to @@ -428,7 +428,7 @@

          -

          [RFC2230] +

          [RFC2230] R. Atkinson. Key Exchange Delegation Record for the DNS. @@ -436,7 +436,7 @@

          -

          [RFC2536] +

          [RFC2536] D. Eastlake, 3rd. DSA KEYs and SIGs in the Domain Name System (DNS). @@ -444,7 +444,7 @@

          -

          [RFC2537] +

          [RFC2537] D. Eastlake, 3rd. RSA/MD5 KEYs and SIGs in the Domain Name System (DNS). @@ -452,7 +452,7 @@

          -

          [RFC2538] +

          [RFC2538] D. Eastlake, 3rd and O. Gudmundsson. Storing Certificates in the Domain Name System (DNS). @@ -460,7 +460,7 @@

          -

          [RFC2539] +

          [RFC2539] D. Eastlake, 3rd. Storage of Diffie-Hellman Keys in the Domain Name System (DNS). @@ -468,7 +468,7 @@

          -

          [RFC2540] +

          [RFC2540] D. Eastlake, 3rd. Detached Domain Name System (DNS) Information. @@ -476,7 +476,7 @@

          -

          [RFC2782] +

          [RFC2782] A. Gulbrandsen. P. Vixie. @@ -486,7 +486,7 @@

          -

          [RFC2915] +

          [RFC2915] M. Mealling. R. Daniel. @@ -495,7 +495,7 @@

          -

          [RFC3110] +

          [RFC3110] D. Eastlake, 3rd. RSA/SHA-1 SIGs and RSA KEYs in the Domain Name System (DNS). @@ -503,7 +503,7 @@

          -

          [RFC3123] +

          [RFC3123] P. Koch. A DNS RR Type for Lists of Address Prefixes (APL RR). @@ -511,7 +511,7 @@

          -

          [RFC3596] +

          [RFC3596] S. Thomson, C. Huitema, V. Ksinant, and M. Souissi. DNS Extensions to support IP @@ -520,7 +520,7 @@

          -

          [RFC3597] +

          [RFC3597] A. Gustafsson. Handling of Unknown DNS Resource Record (RR) Types. @@ -528,12 +528,12 @@

          -
          +

          -DNS and the Internet

          +DNS and the Internet
          -

          [RFC1101] +

          [RFC1101] P. V. Mockapetris. DNS Encoding of Network Names @@ -542,7 +542,7 @@

          -

          [RFC1123] +

          [RFC1123] Braden. Requirements for Internet Hosts - Application and @@ -551,7 +551,7 @@

          -

          [RFC1591] +

          [RFC1591] J. Postel. Domain Name System Structure and Delegation. @@ -559,7 +559,7 @@

          -

          [RFC2317] +

          [RFC2317] H. Eidnes, G. de Groot, and P. Vixie. Classless IN-ADDR.ARPA Delegation. @@ -567,7 +567,7 @@

          -

          [RFC2826] +

          [RFC2826] Internet Architecture Board. IAB Technical Comment on the Unique DNS Root. @@ -575,7 +575,7 @@

          -

          [RFC2929] +

          [RFC2929] D. Eastlake, 3rd, E. Brunner-Williams, and B. Manning. Domain Name System (DNS) IANA Considerations. @@ -583,12 +583,12 @@

          -
          +

          -DNS Operations

          +DNS Operations
          -

          [RFC1033] +

          [RFC1033] M. Lottor. Domain administrators operations guide. @@ -596,7 +596,7 @@

          -

          [RFC1537] +

          [RFC1537] P. Beertema. Common DNS Data File @@ -605,7 +605,7 @@

          -

          [RFC1912] +

          [RFC1912] D. Barr. Common DNS Operational and @@ -614,7 +614,7 @@

          -

          [RFC2010] +

          [RFC2010] B. Manning and P. Vixie. Operational Criteria for Root Name Servers. @@ -622,7 +622,7 @@

          -

          [RFC2219] +

          [RFC2219] M. Hamilton and R. Wright. Use of DNS Aliases for @@ -631,12 +631,12 @@

          -
          +

          -Internationalized Domain Names

          +Internationalized Domain Names
          -

          [RFC2825] +

          [RFC2825] IAB and R. Daigle. A Tangled Web: Issues of I18N, Domain Names, @@ -645,7 +645,7 @@

          -

          [RFC3490] +

          [RFC3490] P. Faltstrom, P. Hoffman, and A. Costello. Internationalizing Domain Names in Applications (IDNA). @@ -653,7 +653,7 @@

          -

          [RFC3491] +

          [RFC3491] P. Hoffman and M. Blanchet. Nameprep: A Stringprep Profile for Internationalized Domain Names. @@ -661,7 +661,7 @@

          -

          [RFC3492] +

          [RFC3492] A. Costello. Punycode: A Bootstring encoding of Unicode @@ -671,11 +671,11 @@

          -
          +

          -Other DNS-related RFCs

          +Other DNS-related RFCs -
          +

          Note

          Note: the following list of RFCs, although @@ -684,7 +684,7 @@

          -

          [RFC1464] +

          [RFC1464] R. Rosenbaum. Using the Domain Name System To Store Arbitrary String @@ -693,7 +693,7 @@

          -

          [RFC1713] +

          [RFC1713] A. Romao. Tools for DNS Debugging. @@ -701,7 +701,7 @@

          -

          [RFC1794] +

          [RFC1794] T. Brisco. DNS Support for Load @@ -710,7 +710,7 @@

          -

          [RFC2240] +

          [RFC2240] O. Vaughan. A Legal Basis for Domain Name Allocation. @@ -718,7 +718,7 @@

          -

          [RFC2345] +

          [RFC2345] J. Klensin, T. Wolf, and G. Oglesby. Domain Names and Company Name Retrieval. @@ -726,7 +726,7 @@

          -

          [RFC2352] +

          [RFC2352] O. Vaughan. A Convention For Using Legal Names as Domain Names. @@ -734,7 +734,7 @@

          -

          [RFC3071] +

          [RFC3071] J. Klensin. Reflections on the DNS, RFC 1591, and Categories of Domains. @@ -742,7 +742,7 @@

          -

          [RFC3258] +

          [RFC3258] T. Hardie. Distributing Authoritative Name Servers via @@ -751,7 +751,7 @@

          -

          [RFC3901] +

          [RFC3901] A. Durand and J. Ihren. DNS IPv6 Transport Operational Guidelines. @@ -759,12 +759,12 @@

          -
          +

          -Obsolete and Unimplemented Experimental RFC

          +Obsolete and Unimplemented Experimental RFC
          -

          [RFC1712] +

          [RFC1712] C. Farrell, M. Schulze, S. Pleitner, and D. Baldoni. DNS Encoding of Geographical @@ -773,7 +773,7 @@

          -

          [RFC2673] +

          [RFC2673] M. Crawford. Binary Labels in the Domain Name System. @@ -781,7 +781,7 @@

          -

          [RFC2874] +

          [RFC2874] M. Crawford and C. Huitema. DNS Extensions to Support IPv6 Address Aggregation @@ -790,11 +790,11 @@

          -
          +

          -Obsoleted DNS Security RFCs

          +Obsoleted DNS Security RFCs -
          +

          Note

          Most of these have been consolidated into RFC4033, @@ -802,7 +802,7 @@

          -

          [RFC2065] +

          [RFC2065] D. Eastlake, 3rd and C. Kaufman. Domain Name System Security Extensions. @@ -810,7 +810,7 @@

          -

          [RFC2137] +

          [RFC2137] D. Eastlake, 3rd. Secure Domain Name System Dynamic Update. @@ -818,7 +818,7 @@

          -

          [RFC2535] +

          [RFC2535] D. Eastlake, 3rd. Domain Name System Security Extensions. @@ -826,7 +826,7 @@

          -

          [RFC3008] +

          [RFC3008] B. Wellington. Domain Name System Security (DNSSEC) @@ -835,7 +835,7 @@

          -

          [RFC3090] +

          [RFC3090] E. Lewis. DNS Security Extension Clarification on Zone Status. @@ -843,7 +843,7 @@

          -

          [RFC3445] +

          [RFC3445] D. Massey and S. Rose. Limiting the Scope of the KEY Resource Record (RR). @@ -851,7 +851,7 @@

          -

          [RFC3655] +

          [RFC3655] B. Wellington and O. Gudmundsson. Redefinition of DNS Authenticated Data (AD) bit. @@ -859,7 +859,7 @@

          -

          [RFC3658] +

          [RFC3658] O. Gudmundsson. Delegation Signer (DS) Resource Record (RR). @@ -867,7 +867,7 @@

          -

          [RFC3755] +

          [RFC3755] S. Weiler. Legacy Resolver Compatibility for Delegation Signer (DS). @@ -875,7 +875,7 @@

          -

          [RFC3757] +

          [RFC3757] O. Kolkman, J. Schlyter, and E. Lewis. Domain Name System KEY (DNSKEY) Resource Record @@ -884,7 +884,7 @@

          -

          [RFC3845] +

          [RFC3845] J. Schlyter. DNS Security (DNSSEC) NextSECure (NSEC) RDATA Format. @@ -894,7 +894,7 @@

          -
          +

          Internet Drafts

          @@ -909,17 +909,17 @@ after which they are deleted unless updated by their authors.

          -
          +

          -Other Documents About BIND +Other Documents About BIND

          -
          +

          -Bibliography

          +Bibliography
          -

          +

          Paul Albitz and Cricket Liu. DNS and BIND. Copyright © 1998 Sebastopol, CA: O'Reilly and Associates. diff --git a/doc/arm/Bv9ARM.ch12.html b/doc/arm/Bv9ARM.ch12.html index 7c33aeed6d..9226198746 100644 --- a/doc/arm/Bv9ARM.ch12.html +++ b/doc/arm/Bv9ARM.ch12.html @@ -18,7 +18,7 @@ Appendix D. BIND 9 DNS Library Support - + @@ -38,26 +38,26 @@

          -
          -

          -Appendix D. BIND 9 DNS Library Support

          +
          +

          +Appendix D. BIND 9 DNS Library Support

          Table of Contents

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

          BIND 9 DNS Library Support

          @@ -66,7 +66,7 @@ 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 level API that provides an interface to name resolution, @@ -96,9 +96,9 @@ 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 @@ -106,9 +106,9 @@ 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]
@@ -122,9 +122,9 @@ $ make
   programs using the libraries will also be built under the
   lib/export/samples directory (see below).
          -
          +

          -Installation

          +Installation
           $ cd lib/export
@@ -145,11 +145,11 @@ $ make install
   application after the installation, see
   lib/export/samples/Makefile-postinstall.in.
          -
          +

          -Known Defects/Restrictions

          +Known Defects/Restrictions
          -
            +

            • Currently, win32 is not supported for the export @@ -195,9 +195,9 @@ $ make

          -
          +

          -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 @@ -214,17 +214,17 @@ $ make of statement for named.conf. (See the section called “trusted-keys Statement Grammar” for details.)

          -
          +

          -Sample Applications

          +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 @@ -237,7 +237,7 @@ $ make

          Options and Arguments:

          -
          +
          -t RRtype
          @@ -287,9 +287,9 @@ $ make

          -
          +

          -sample-async: a simple stub resolver, working asynchronously

          +sample-async: a simple stub resolver, working asynchronously

          Similar to "sample", but accepts a list @@ -300,7 +300,7 @@ $ make

          Options and Arguments:

          -
          +
          -s server_address
          @@ -329,9 +329,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 @@ -348,7 +348,7 @@ $ make

          Options and Arguments:

          -
          +
          -t RRtype
          @@ -377,9 +377,9 @@ $ make
          -
          +

          -sample-gai: getaddrinfo() and getnameinfo() test code

          +sample-gai: getaddrinfo() and getnameinfo() test code

          This is a test program @@ -395,9 +395,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 @@ -411,7 +411,7 @@ $ make

          Options and Arguments:

          -
          +
          -a auth_server
          @@ -468,7 +468,7 @@ $ make

          -
          +

          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.
          @@ -493,9 +493,9 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mm 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 @@ -511,7 +511,7 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mm Options

          -
          +
          -d
          @@ -552,9 +552,9 @@ $ sample-update -a sample-update -k Kxxx.+nnn+mm
          -
          +

          -Library References

          +Library References

          As of this writing, there is no formal "manual" of the libraries, except this document, header files (some of them diff --git a/doc/arm/Bv9ARM.ch13.html b/doc/arm/Bv9ARM.ch13.html index 5704eb90ac..f4c03c841d 100644 --- a/doc/arm/Bv9ARM.ch13.html +++ b/doc/arm/Bv9ARM.ch13.html @@ -18,7 +18,7 @@ Manual pages - + @@ -38,7 +38,7 @@

          -
          +

          Manual pages

          @@ -46,7 +46,7 @@

          Table of Contents

          -
          +
          dig — DNS lookup utility
          diff --git a/doc/arm/Bv9ARM.html b/doc/arm/Bv9ARM.html index ef4d150c9c..0488fd2e27 100644 --- a/doc/arm/Bv9ARM.html +++ b/doc/arm/Bv9ARM.html @@ -18,7 +18,7 @@ BIND 9 Administrator Reference Manual - + @@ -35,11 +35,11 @@
          -
          +

          -BIND 9 Administrator Reference Manual

          +BIND 9 Administrator Reference Manual

          BIND Version 9.11.0pre-alpha

          Copyright © 2004-2015 Internet Systems Consortium, Inc. ("ISC")

          Copyright © 2000-2003 Internet Software Consortium.

          @@ -48,42 +48,42 @@

          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
          -
          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
          @@ -92,75 +92,75 @@
          Dynamic Update
          The journal file
          Incremental Zone Transfers (IXFR)
          -
          Split DNS
          -
          Example split DNS setup
          +
          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)
          +
          TKEY
          +
          SIG(0)
          DNSSEC
          -
          Generating Keys
          -
          Signing the Zone
          -
          Configuring Servers
          +
          Generating Keys
          +
          Signing the Zone
          +
          Configuring Servers
          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
          -
          Validating Resolver
          -
          Authoritative Server
          +
          Validating Resolver
          +
          Authoritative Server
          PKCS#11 (Cryptoki) support
          -
          Prerequisites
          -
          Native PKCS#11
          -
          OpenSSL-based PKCS#11
          -
          PKCS#11 Tools
          -
          Using the HSM
          -
          Specifying the engine on the command line
          -
          Running named with automatic zone re-signing
          +
          Prerequisites
          +
          Native PKCS#11
          +
          OpenSSL-based PKCS#11
          +
          PKCS#11 Tools
          +
          Using the HSM
          +
          Specifying the engine on the command line
          +
          Running named with automatic zone re-signing
          DLZ (Dynamically Loadable Zones)
          -
          Configuring DLZ
          -
          Sample DLZ Driver
          +
          Configuring DLZ
          +
          Sample DLZ Driver
          DynDB (Dynamic Database)
          -
          Configuring DynDB
          -
          Sample DynDB Module
          +
          Configuring DynDB
          +
          Sample DynDB Module
          -
          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
          +
          The Lightweight Resolver Library
          Running a Resolver Daemon
          6. BIND 9 Configuration Reference
          @@ -168,58 +168,58 @@
          Configuration File Elements
          Address Match Lists
          -
          Comment Syntax
          +
          Comment Syntax
          Configuration File Grammar
          -
          acl Statement Grammar
          +
          acl Statement Grammar
          acl Statement Definition and Usage
          -
          controls Statement Grammar
          +
          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 Grammar
          options Statement Definition and Usage
          server Statement Grammar
          server Statement Definition and Usage
          statistics-channels Statement Grammar
          -
          statistics-channels Statement Definition and +
          statistics-channels Statement Definition and Usage
          trusted-keys Statement Grammar
          -
          trusted-keys Statement Definition +
          trusted-keys Statement Definition and Usage
          -
          managed-keys Statement Grammar
          +
          managed-keys Statement Grammar
          managed-keys Statement Definition and Usage
          view Statement Grammar
          -
          view Statement Definition and Usage
          +
          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
          +
          Discussion of MX Records
          Setting TTLs
          -
          Inverse Mapping in IPv4
          -
          Other Zone File Directives
          -
          BIND Master File Extension: the $GENERATE Directive
          +
          Inverse Mapping in IPv4
          +
          Other Zone File Directives
          +
          BIND Master File Extension: the $GENERATE Directive
          Additional File Formats
          BIND9 Statistics
          @@ -231,23 +231,23 @@
          7. BIND 9 Security Considerations
          Access Control Lists
          -
          Chroot and Setuid
          +
          Chroot and Setuid
          -
          The chroot Environment
          -
          Using the setuid Function
          +
          The chroot Environment
          +
          Using the setuid Function
          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.11.0pre-alpha
          +
          Release Notes for BIND Version 9.11.0pre-alpha
          Introduction
          Download
          @@ -272,20 +272,20 @@
          Request for Comments (RFCs)
          Internet Drafts
          -
          Other Documents About BIND
          +
          Other Documents About BIND
          D. 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
          diff --git a/doc/arm/dlz.xml b/doc/arm/dlz.xml index 0583778ba2..4d4aabd25a 100644 --- a/doc/arm/dlz.xml +++ b/doc/arm/dlz.xml @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> +
          DLZ (Dynamically Loadable Zones) diff --git a/doc/arm/dnssec.xml b/doc/arm/dnssec.xml index 7a56a60e1c..33b0cdc7f8 100644 --- a/doc/arm/dnssec.xml +++ b/doc/arm/dnssec.xml @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> +
          DNSSEC, Dynamic Zones, and Automatic Signing diff --git a/doc/arm/dyndb.xml b/doc/arm/dyndb.xml index 61888a7ffa..6f6ae7201b 100644 --- a/doc/arm/dyndb.xml +++ b/doc/arm/dyndb.xml @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> +
          DynDB (Dynamic Database) diff --git a/doc/arm/libdns.xml b/doc/arm/libdns.xml index cda668a575..9cd16c4ce8 100644 --- a/doc/arm/libdns.xml +++ b/doc/arm/libdns.xml @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> +
          BIND 9 DNS Library Support diff --git a/doc/arm/logging-categories.xml b/doc/arm/logging-categories.xml index 64df919d63..1d53849abb 100644 --- a/doc/arm/logging-categories.xml +++ b/doc/arm/logging-categories.xml @@ -13,6 +13,7 @@ - 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 a3b0b14c5d..8f71dd85d0 100644 --- a/doc/arm/man.arpaname.html +++ b/doc/arm/man.arpaname.html @@ -18,7 +18,7 @@ arpaname - + @@ -38,7 +38,7 @@
          -
          +
          @@ -54,7 +54,7 @@ -
          +

          Synopsis

          arpaname @@ -62,8 +62,8 @@

          -
          -

          DESCRIPTION

          +
          +

          DESCRIPTION

          arpaname translates IP addresses (IPv4 and @@ -71,8 +71,8 @@

          -
          -

          SEE ALSO

          +
          +

          SEE ALSO

          BIND 9 Administrator Reference Manual. diff --git a/doc/arm/man.ddns-confgen.html b/doc/arm/man.ddns-confgen.html index a398f174bc..6b67a94768 100644 --- a/doc/arm/man.ddns-confgen.html +++ b/doc/arm/man.ddns-confgen.html @@ -18,7 +18,7 @@ ddns-confgen - + @@ -38,7 +38,7 @@

          -
          +
          @@ -55,7 +55,7 @@ -
          +

          Synopsis

          tsig-keygen @@ -78,8 +78,8 @@

          -
          -

          DESCRIPTION

          +
          +

          DESCRIPTION

          tsig-keygen and ddns-confgen @@ -119,11 +119,11 @@

          -
          -

          OPTIONS

          +
          +

          OPTIONS

          -
          +
          -a algorithm

          @@ -208,8 +208,8 @@

          -
          -

          SEE ALSO

          +
          +

          SEE ALSO

          nsupdate(1) diff --git a/doc/arm/man.delv.html b/doc/arm/man.delv.html index d67587d29f..4dff2d31a4 100644 --- a/doc/arm/man.delv.html +++ b/doc/arm/man.delv.html @@ -18,7 +18,7 @@ delv - + @@ -38,7 +38,7 @@

          -
          +
          @@ -55,7 +55,7 @@ -
          +

          Synopsis

          delv @@ -95,8 +95,8 @@

          -
          -

          DESCRIPTION

          +
          +

          DESCRIPTION

          delv (Domain Entity Lookup & Validation) is a tool for sending @@ -140,8 +140,8 @@

          -
          -

          SIMPLE USAGE

          +
          +

          SIMPLE USAGE

          @@ -152,7 +152,7 @@ where:

          -
          +
          server

          @@ -203,10 +203,10 @@

          -
          -

          OPTIONS

          +
          +

          OPTIONS

          -
          +
          -a anchor-file

          @@ -363,8 +363,8 @@

          -
          -

          QUERY OPTIONS

          +
          +

          QUERY OPTIONS

          delv @@ -382,7 +382,7 @@ The query options are:

          -
          +
          +[no]cdflag

          @@ -583,15 +583,15 @@

          -
          -

          FILES

          +
          +

          FILES

          /etc/bind.keys

          /etc/resolv.conf

          -
          -

          SEE ALSO

          +
          +

          SEE ALSO

          dig(1) diff --git a/doc/arm/man.dig.html b/doc/arm/man.dig.html index 012a39bcaa..d8e6f38636 100644 --- a/doc/arm/man.dig.html +++ b/doc/arm/man.dig.html @@ -18,7 +18,7 @@ dig - + @@ -38,7 +38,7 @@

          -
          +
          @@ -55,7 +55,7 @@ -
          +

          Synopsis

          dig @@ -91,8 +91,8 @@

          -
          -

          DESCRIPTION

          +
          +

          DESCRIPTION

          dig (domain information groper) is a flexible tool @@ -146,8 +146,8 @@

          -
          -

          SIMPLE USAGE

          +
          +

          SIMPLE USAGE

          @@ -158,7 +158,7 @@ where:

          -
          +
          server

          @@ -207,11 +207,11 @@

          -
          -

          OPTIONS

          +
          +

          OPTIONS

          -
          +
          -4

          @@ -368,8 +368,8 @@

          -
          -

          QUERY OPTIONS

          +
          +

          QUERY OPTIONS

          dig @@ -394,7 +394,7 @@ The query options are:

          -
          +
          +[no]aaflag

          @@ -933,8 +933,8 @@

          -
          -

          MULTIPLE QUERIES

          +
          +

          MULTIPLE QUERIES

          @@ -985,8 +985,8 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr

          -
          -

          IDN SUPPORT

          +
          +

          IDN SUPPORT

          If dig has been built with IDN (internationalized @@ -1001,8 +1001,8 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr

          -
          -

          FILES

          +
          +

          FILES

          /etc/resolv.conf

          @@ -1010,8 +1010,8 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr

          -
          -

          SEE ALSO

          +
          +

          SEE ALSO

          host(1) @@ -1026,8 +1026,8 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr

          -
          -

          BUGS

          +
          +

          BUGS

          There are probably too many query options. diff --git a/doc/arm/man.dnssec-checkds.html b/doc/arm/man.dnssec-checkds.html index 7610521e42..7134fa6b8e 100644 --- a/doc/arm/man.dnssec-checkds.html +++ b/doc/arm/man.dnssec-checkds.html @@ -18,7 +18,7 @@ dnssec-checkds - + @@ -38,7 +38,7 @@

          -
          +
          @@ -55,7 +55,7 @@ -
          +

          Synopsis

          dnssec-checkds @@ -75,8 +75,8 @@

          -
          -

          DESCRIPTION

          +
          +

          DESCRIPTION

          dnssec-checkds verifies the correctness of Delegation Signer (DS) or DNSSEC @@ -85,11 +85,11 @@

          -
          -

          OPTIONS

          +
          +

          OPTIONS

          -
          +
          -f file

          @@ -125,8 +125,8 @@

          -
          -

          SEE ALSO

          +
          +

          SEE ALSO

          dnssec-dsfromkey(8) diff --git a/doc/arm/man.dnssec-coverage.html b/doc/arm/man.dnssec-coverage.html index 7bfb590faf..84c795863a 100644 --- a/doc/arm/man.dnssec-coverage.html +++ b/doc/arm/man.dnssec-coverage.html @@ -18,7 +18,7 @@ dnssec-coverage - + @@ -38,7 +38,7 @@

          -
          +
          @@ -55,7 +55,7 @@ -
          +

          Synopsis

          dnssec-coverage @@ -72,8 +72,8 @@

          -
          -

          DESCRIPTION

          +
          +

          DESCRIPTION

          dnssec-coverage verifies that the DNSSEC keys for a given zone or a set of zones @@ -102,11 +102,11 @@

          -
          -

          OPTIONS

          +
          +

          OPTIONS

          -
          +
          -K directory

          @@ -229,8 +229,8 @@

          -
          -

          SEE ALSO

          +
          +

          SEE ALSO

          diff --git a/doc/arm/man.dnssec-dsfromkey.html b/doc/arm/man.dnssec-dsfromkey.html index 21d6fb7eb6..240a869de6 100644 --- a/doc/arm/man.dnssec-dsfromkey.html +++ b/doc/arm/man.dnssec-dsfromkey.html @@ -18,7 +18,7 @@ dnssec-dsfromkey - + @@ -38,7 +38,7 @@

          -
          +
          @@ -55,7 +55,7 @@ -
          +

          Synopsis

          dnssec-dsfromkey @@ -91,8 +91,8 @@

          -
          -

          DESCRIPTION

          +
          +

          DESCRIPTION

          dnssec-dsfromkey outputs the Delegation Signer (DS) resource record (RR), as defined in @@ -100,11 +100,11 @@

          -
          -

          OPTIONS

          +
          +

          OPTIONS

          -
          +
          -1

          @@ -220,8 +220,8 @@

          -
          -

          EXAMPLE

          +
          +

          EXAMPLE

          To build the SHA-256 DS RR from the @@ -237,8 +237,8 @@

          -
          -

          FILES

          +
          +

          FILES

          The keyfile can be designed by the key identification @@ -253,16 +253,16 @@

          -
          -

          CAVEAT

          +
          +

          CAVEAT

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

          -
          -

          SEE ALSO

          +
          +

          SEE ALSO

          dnssec-keygen(8) diff --git a/doc/arm/man.dnssec-importkey.html b/doc/arm/man.dnssec-importkey.html index d34785a275..70c39a1268 100644 --- a/doc/arm/man.dnssec-importkey.html +++ b/doc/arm/man.dnssec-importkey.html @@ -18,7 +18,7 @@ dnssec-importkey - + @@ -38,7 +38,7 @@

          -
          +
          @@ -55,7 +55,7 @@ -
          +

          Synopsis

          dnssec-importkey @@ -82,8 +82,8 @@

          -
          -

          DESCRIPTION

          +
          +

          DESCRIPTION

          dnssec-importkey reads a public DNSKEY record and generates a pair of @@ -104,11 +104,11 @@

          -
          -

          OPTIONS

          +
          +

          OPTIONS

          -
          +
          -f filename

          @@ -160,8 +160,8 @@

          -
          -

          TIMING OPTIONS

          +
          +

          TIMING OPTIONS

          Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. @@ -175,7 +175,7 @@ set, use 'none' or 'never'.

          -
          +
          -P date/offset

          @@ -195,8 +195,8 @@

          -
          -

          FILES

          +
          +

          FILES

          A keyfile can be designed by the key identification @@ -206,8 +206,8 @@

          -
          -

          SEE ALSO

          +
          +

          SEE ALSO

          dnssec-keygen(8) diff --git a/doc/arm/man.dnssec-keyfromlabel.html b/doc/arm/man.dnssec-keyfromlabel.html index 6a96e841e6..ceae1daa27 100644 --- a/doc/arm/man.dnssec-keyfromlabel.html +++ b/doc/arm/man.dnssec-keyfromlabel.html @@ -18,7 +18,7 @@ dnssec-keyfromlabel - + @@ -38,7 +38,7 @@

          -
          +
          @@ -55,7 +55,7 @@ -
          +

          Synopsis

          dnssec-keyfromlabel @@ -86,8 +86,8 @@

          -
          -

          DESCRIPTION

          +
          +

          DESCRIPTION

          dnssec-keyfromlabel generates a key pair of files that referencing a key object stored @@ -104,11 +104,11 @@

          -
          -

          OPTIONS

          +
          +

          OPTIONS

          -
          +
          -a algorithm

          @@ -316,8 +316,8 @@

          -
          -

          TIMING OPTIONS

          +
          +

          TIMING OPTIONS

          @@ -332,7 +332,7 @@ set, use 'none' or 'never'.

          -
          +
          -P date/offset

          @@ -402,8 +402,8 @@

          -
          -

          GENERATED KEY FILES

          +
          +

          GENERATED KEY FILES

          When dnssec-keyfromlabel completes @@ -412,7 +412,7 @@ to the standard output. This is an identification string for the key files it has generated.

          -
            +

            • nnnn is the key name.

              @@ -449,8 +449,8 @@

            -
            -

            SEE ALSO

            +
            +

            SEE ALSO

            dnssec-keygen(8) diff --git a/doc/arm/man.dnssec-keygen.html b/doc/arm/man.dnssec-keygen.html index 217046141f..28346cccb3 100644 --- a/doc/arm/man.dnssec-keygen.html +++ b/doc/arm/man.dnssec-keygen.html @@ -18,7 +18,7 @@ dnssec-keygen - + @@ -38,7 +38,7 @@

            -
            +
            @@ -55,7 +55,7 @@ -
            +

            Synopsis

            dnssec-keygen @@ -92,8 +92,8 @@

            -
            -

            DESCRIPTION

            +
            +

            DESCRIPTION

            dnssec-keygen generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 @@ -108,11 +108,11 @@

            -
            -

            OPTIONS

            +
            +

            OPTIONS

            -
            +
            -a algorithm

            @@ -372,8 +372,8 @@

            -
            -

            TIMING OPTIONS

            +
            +

            TIMING OPTIONS

            @@ -388,7 +388,7 @@ set, use 'none' or 'never'.

            -
            +
            -P date/offset

            @@ -461,8 +461,8 @@

            -
            -

            GENERATED KEYS

            +
            +

            GENERATED KEYS

            When dnssec-keygen completes @@ -471,7 +471,7 @@ to the standard output. This is an identification string for the key it has generated.

            -
              +

              • nnnn is the key name.

                @@ -515,8 +515,8 @@

              -
              -

              EXAMPLE

              +
              +

              EXAMPLE

              To generate a 768-bit DSA key for the domain @@ -538,8 +538,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              dnssec-signzone(8) diff --git a/doc/arm/man.dnssec-revoke.html b/doc/arm/man.dnssec-revoke.html index 50f9fa1a09..4a43e867cd 100644 --- a/doc/arm/man.dnssec-revoke.html +++ b/doc/arm/man.dnssec-revoke.html @@ -18,7 +18,7 @@ dnssec-revoke - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              dnssec-revoke @@ -70,8 +70,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              dnssec-revoke reads a DNSSEC key file, sets the REVOKED bit on the key as defined @@ -80,11 +80,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -h

              @@ -148,8 +148,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              dnssec-keygen(8) diff --git a/doc/arm/man.dnssec-settime.html b/doc/arm/man.dnssec-settime.html index 89ea5a16d7..7f5441c111 100644 --- a/doc/arm/man.dnssec-settime.html +++ b/doc/arm/man.dnssec-settime.html @@ -18,7 +18,7 @@ dnssec-settime - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              dnssec-settime @@ -75,8 +75,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              dnssec-settime reads a DNSSEC private key file and sets the key timing metadata @@ -103,11 +103,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -f

              @@ -175,8 +175,8 @@

              -
              -

              TIMING OPTIONS

              +
              +

              TIMING OPTIONS

              Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. @@ -189,7 +189,7 @@ is computed in seconds. To unset a date, use 'none' or 'never'.

              -
              +
              -P date/offset

              @@ -269,15 +269,15 @@

              -
              -

              PRINTING OPTIONS

              +
              +

              PRINTING OPTIONS

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

              -
              +
              -u

              @@ -302,8 +302,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              dnssec-keygen(8) diff --git a/doc/arm/man.dnssec-signzone.html b/doc/arm/man.dnssec-signzone.html index 850802d6a1..98236e425b 100644 --- a/doc/arm/man.dnssec-signzone.html +++ b/doc/arm/man.dnssec-signzone.html @@ -18,7 +18,7 @@ dnssec-signzone - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              dnssec-signzone @@ -102,8 +102,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              dnssec-signzone signs a zone. It generates @@ -115,11 +115,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -a

              @@ -379,7 +379,7 @@ and "date".

              -
              +
              "keep"

              Do not modify the SOA serial number.

              @@ -506,7 +506,7 @@ rules. Each successive rule takes priority over the prior ones:

              -
              +

              @@ -653,8 +653,8 @@

              -
              -

              EXAMPLE

              +
              +

              EXAMPLE

              The following command signs the example.com @@ -685,8 +685,8 @@ db.example.com.signed %

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              dnssec-keygen(8) diff --git a/doc/arm/man.dnssec-verify.html b/doc/arm/man.dnssec-verify.html index a9e7472863..3cc99d3668 100644 --- a/doc/arm/man.dnssec-verify.html +++ b/doc/arm/man.dnssec-verify.html @@ -18,7 +18,7 @@ dnssec-verify - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              dnssec-verify @@ -71,8 +71,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              dnssec-verify verifies that a zone is fully signed for each algorithm found @@ -81,11 +81,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -c class

              @@ -178,8 +178,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              diff --git a/doc/arm/man.dnstap-read.html b/doc/arm/man.dnstap-read.html index 6977185f79..9fa5ffd939 100644 --- a/doc/arm/man.dnstap-read.html +++ b/doc/arm/man.dnstap-read.html @@ -18,7 +18,7 @@ dnstap-read - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              dnstap-read @@ -66,8 +66,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              dnstap-read @@ -79,11 +79,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -m

              @@ -108,8 +108,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              diff --git a/doc/arm/man.genrandom.html b/doc/arm/man.genrandom.html index b41621edb4..6632431c64 100644 --- a/doc/arm/man.genrandom.html +++ b/doc/arm/man.genrandom.html @@ -18,7 +18,7 @@ genrandom - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              genrandom @@ -65,8 +65,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              genrandom @@ -76,10 +76,10 @@

              -
              -

              ARGUMENTS

              +
              +

              ARGUMENTS

              -
              +
              -n number

              @@ -102,8 +102,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              diff --git a/doc/arm/man.host.html b/doc/arm/man.host.html index f4bf100518..0039c5169e 100644 --- a/doc/arm/man.host.html +++ b/doc/arm/man.host.html @@ -18,7 +18,7 @@ host - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              host @@ -75,8 +75,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              host @@ -259,8 +259,8 @@

              -
              -

              IDN SUPPORT

              +
              +

              IDN SUPPORT

              If host has been built with IDN (internationalized @@ -275,15 +275,15 @@

              -
              -

              FILES

              +
              +

              FILES

              /etc/resolv.conf

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              dig(1) diff --git a/doc/arm/man.isc-hmac-fixup.html b/doc/arm/man.isc-hmac-fixup.html index ef7a35db67..de57e27cb7 100644 --- a/doc/arm/man.isc-hmac-fixup.html +++ b/doc/arm/man.isc-hmac-fixup.html @@ -18,7 +18,7 @@ isc-hmac-fixup - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              isc-hmac-fixup @@ -64,8 +64,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              Versions of BIND 9 up to and including BIND 9.6 had a bug causing @@ -92,8 +92,8 @@

              -
              -

              SECURITY CONSIDERATIONS

              +
              +

              SECURITY CONSIDERATIONS

              Secrets that have been converted by isc-hmac-fixup @@ -105,8 +105,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              BIND 9 Administrator Reference Manual, diff --git a/doc/arm/man.lwresd.html b/doc/arm/man.lwresd.html index 6582762d0a..2d163c0719 100644 --- a/doc/arm/man.lwresd.html +++ b/doc/arm/man.lwresd.html @@ -18,7 +18,7 @@ lwresd - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              lwresd @@ -78,8 +78,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              lwresd @@ -117,11 +117,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -4

              @@ -234,7 +234,7 @@ Write memory usage statistics to stdout on exit.

              -
              +

              Note

              This option is mainly of interest to BIND 9 developers @@ -249,7 +249,7 @@ processing the command line arguments, but before reading the configuration file.

              -
              +

              Warning

              This option should be used in conjunction with the @@ -279,11 +279,11 @@

              -
              -

              FILES

              +
              +

              FILES

              -
              +
              /etc/resolv.conf

              @@ -300,8 +300,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              named(8) diff --git a/doc/arm/man.named-checkconf.html b/doc/arm/man.named-checkconf.html index cc41170ffa..05f4c83f28 100644 --- a/doc/arm/man.named-checkconf.html +++ b/doc/arm/man.named-checkconf.html @@ -18,7 +18,7 @@ named-checkconf - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@

              -
              +

              Synopsis

              named-checkconf @@ -70,8 +70,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              named-checkconf checks the syntax, but not the semantics, of a @@ -92,11 +92,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -h

              @@ -161,8 +161,8 @@

              -
              -

              RETURN VALUES

              +
              +

              RETURN VALUES

              named-checkconf returns an exit status of 1 if @@ -170,8 +170,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              named(8) diff --git a/doc/arm/man.named-checkzone.html b/doc/arm/man.named-checkzone.html index ba80bbb07e..ef494bbd08 100644 --- a/doc/arm/man.named-checkzone.html +++ b/doc/arm/man.named-checkzone.html @@ -18,7 +18,7 @@ named-checkzone - + @@ -38,7 +38,7 @@

              -
              +
              @@ -56,7 +56,7 @@

              -
              +

              Synopsis

              named-checkzone @@ -118,8 +118,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              named-checkzone checks the syntax and integrity of a zone file. It performs the @@ -140,11 +140,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -d

              @@ -428,8 +428,8 @@

              -
              -

              RETURN VALUES

              +
              +

              RETURN VALUES

              named-checkzone returns an exit status of 1 if @@ -437,8 +437,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              named(8) diff --git a/doc/arm/man.named-journalprint.html b/doc/arm/man.named-journalprint.html index 04445593f8..00ea800398 100644 --- a/doc/arm/man.named-journalprint.html +++ b/doc/arm/man.named-journalprint.html @@ -18,7 +18,7 @@ named-journalprint - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              named-journalprint @@ -63,8 +63,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              named-journalprint @@ -91,8 +91,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              diff --git a/doc/arm/man.named-rrchecker.html b/doc/arm/man.named-rrchecker.html index 0bf60fa201..adeeb66659 100644 --- a/doc/arm/man.named-rrchecker.html +++ b/doc/arm/man.named-rrchecker.html @@ -18,7 +18,7 @@ named-rrchecker - + @@ -38,7 +38,7 @@

              -
              +
              @@ -53,7 +53,7 @@ -
              +

              Synopsis

              named-rrchecker @@ -67,8 +67,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              named-rrchecker read a individual DNS resource record from standard input and checks if it @@ -97,8 +97,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              RFC 1034, diff --git a/doc/arm/man.named.conf.html b/doc/arm/man.named.conf.html index 45082331a2..860873fba2 100644 --- a/doc/arm/man.named.conf.html +++ b/doc/arm/man.named.conf.html @@ -18,7 +18,7 @@ named.conf - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,15 +55,15 @@ -
              +

              Synopsis

              named.conf

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              named.conf is the configuration file for @@ -83,8 +83,8 @@

              -
              -

              ACL

              +
              +

              ACL


              acl string { address_match_element; ... };
              @@ -92,8 +92,8 @@ acl

              -
              -

              KEY

              +
              +

              KEY


              key domain_name {
              @@ -103,8 +103,8 @@ key

              -
              -

              MASTERS

              +
              +

              MASTERS


              masters string [ port integer ] {
              @@ -114,8 +114,8 @@ masters

              -
              -

              SERVER

              +
              +

              SERVER


              server ( ipv4_address[/prefixlen] | ipv6_address[/prefixlen] ) {
              @@ -139,8 +139,8 @@ server

              -
              -

              TRUSTED-KEYS

              +
              +

              TRUSTED-KEYS


              trusted-keys {
              @@ -149,8 +149,8 @@ trusted-keys

              -
              -

              MANAGED-KEYS

              +
              +

              MANAGED-KEYS


              managed-keys {
              @@ -159,8 +159,8 @@ managed-keys

              -
              -

              CONTROLS

              +
              +

              CONTROLS


              controls {
              @@ -173,8 +173,8 @@ controls

              -
              -

              LOGGING

              +
              +

              LOGGING


              logging {
              @@ -193,8 +193,8 @@ logging

              -
              -

              LWRES

              +
              +

              LWRES


              lwres {
              @@ -210,8 +210,8 @@ lwres

              -
              -

              OPTIONS

              +
              +

              OPTIONS


              options {
              @@ -426,8 +426,8 @@ options

              -
              -

              VIEW

              +
              +

              VIEW


              view string optional_class {
              @@ -597,8 +597,8 @@ view

              -
              -

              ZONE

              +
              +

              ZONE


              zone string optional_class {
              @@ -696,15 +696,15 @@ zone

              -
              -

              FILES

              +
              +

              FILES

              /etc/named.conf

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              named(8) diff --git a/doc/arm/man.named.html b/doc/arm/man.named.html index 1ba6274df3..dafced2346 100644 --- a/doc/arm/man.named.html +++ b/doc/arm/man.named.html @@ -18,7 +18,7 @@ named - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              named @@ -84,8 +84,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              named is a Domain Name System (DNS) server, @@ -101,11 +101,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -4

              @@ -235,7 +235,7 @@

              Write memory usage statistics to stdout on exit.

              -
              +

              Note

              This option is mainly of interest to BIND 9 developers @@ -252,7 +252,7 @@ configuration options, and 21000 on systems built with "configure --with-tuning=large".

              -
              +

              Warning

              This option should be unnecessary for the vast majority @@ -278,7 +278,7 @@ processing the command line arguments, but before reading the configuration file.

              -
              +

              Warning

              This option should be used in conjunction with the @@ -314,7 +314,7 @@ privileged operations, such as creating sockets that listen on privileged ports.

              -
              +

              Note

              On Linux, named uses the kernel's @@ -361,7 +361,7 @@ Load data from cache-file into the cache of the default view.

              -
              +

              Warning

              This option must not be used. It is only of interest @@ -374,8 +374,8 @@

              -
              -

              SIGNALS

              +
              +

              SIGNALS

              In routine operation, signals should not be used to control @@ -383,7 +383,7 @@ instead.

              -
              +
              SIGHUP

              @@ -404,8 +404,8 @@

              -
              -

              CONFIGURATION

              +
              +

              CONFIGURATION

              The named configuration file is too complex @@ -425,11 +425,11 @@

              -
              -

              FILES

              +
              +

              FILES

              -
              +
              /etc/named.conf

              @@ -446,8 +446,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              RFC 1033, RFC 1034, diff --git a/doc/arm/man.nsec3hash.html b/doc/arm/man.nsec3hash.html index 7c0c5c142a..aa5ff0cbbe 100644 --- a/doc/arm/man.nsec3hash.html +++ b/doc/arm/man.nsec3hash.html @@ -18,7 +18,7 @@ nsec3hash - + @@ -36,7 +36,7 @@

              -
              +
              @@ -53,7 +53,7 @@ -
              +

              Synopsis

              nsec3hash @@ -64,8 +64,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              nsec3hash generates an NSEC3 hash based on @@ -74,10 +74,10 @@

              -
              -

              ARGUMENTS

              +
              +

              ARGUMENTS

              -
              +
              salt

              @@ -108,8 +108,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              BIND 9 Administrator Reference Manual, diff --git a/doc/arm/man.nsupdate.html b/doc/arm/man.nsupdate.html index ffe426c79b..7a4ea29770 100644 --- a/doc/arm/man.nsupdate.html +++ b/doc/arm/man.nsupdate.html @@ -18,7 +18,7 @@ nsupdate - + @@ -38,7 +38,7 @@

              -
              +
              @@ -54,7 +54,7 @@ -
              +

              Synopsis

              nsupdate @@ -80,8 +80,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              nsupdate is used to submit Dynamic DNS Update requests as defined in RFC 2136 @@ -140,11 +140,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -d

              @@ -305,8 +305,8 @@

              -
              -

              INPUT FORMAT

              +
              +

              INPUT FORMAT

              nsupdate reads input from @@ -335,7 +335,7 @@

              The command formats and their meaning are as follows:

              -
              +
              server {servername} @@ -668,8 +668,8 @@
              -
              -

              EXAMPLES

              +
              +

              EXAMPLES

              The examples below show how @@ -724,11 +724,11 @@

              -
              -

              FILES

              +
              +

              FILES

              -
              +
              /etc/resolv.conf

              @@ -762,8 +762,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              RFC 2136, @@ -785,8 +785,8 @@

              -
              -

              BUGS

              +
              +

              BUGS

              The TSIG key is redundantly stored in two separate files. diff --git a/doc/arm/man.rndc-confgen.html b/doc/arm/man.rndc-confgen.html index 3adcda6219..40242873ad 100644 --- a/doc/arm/man.rndc-confgen.html +++ b/doc/arm/man.rndc-confgen.html @@ -18,7 +18,7 @@ rndc-confgen - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              rndc-confgen @@ -73,8 +73,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              rndc-confgen generates configuration files @@ -92,11 +92,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -a

              @@ -229,8 +229,8 @@

              -
              -

              EXAMPLES

              +
              +

              EXAMPLES

              To allow rndc to be used with @@ -248,8 +248,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              rndc(8) diff --git a/doc/arm/man.rndc.conf.html b/doc/arm/man.rndc.conf.html index 8de79cfd51..4a2cb38247 100644 --- a/doc/arm/man.rndc.conf.html +++ b/doc/arm/man.rndc.conf.html @@ -18,7 +18,7 @@ rndc.conf - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,15 +55,15 @@ -
              +

              Synopsis

              rndc.conf

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

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

              -
              -

              EXAMPLE

              +
              +

              EXAMPLE

              @@ -228,8 +228,8 @@
              -
              -

              NAME SERVER CONFIGURATION

              +
              +

              NAME SERVER CONFIGURATION

              The name server must be configured to accept rndc connections and @@ -240,8 +240,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              rndc(8) diff --git a/doc/arm/man.rndc.html b/doc/arm/man.rndc.html index d397fd4895..1e85fd30b0 100644 --- a/doc/arm/man.rndc.html +++ b/doc/arm/man.rndc.html @@ -18,7 +18,7 @@ rndc - + @@ -38,7 +38,7 @@

              -
              +
              @@ -55,7 +55,7 @@ -
              +

              Synopsis

              rndc @@ -72,8 +72,8 @@

              -
              -

              DESCRIPTION

              +
              +

              DESCRIPTION

              rndc controls the operation of a name @@ -105,11 +105,11 @@

              -
              -

              OPTIONS

              +
              +

              OPTIONS

              -
              +
              -b source-address

              @@ -203,8 +203,8 @@

              -
              -

              COMMANDS

              +
              +

              COMMANDS

              A list of commands supported by rndc can @@ -214,7 +214,7 @@ Currently supported commands are:

              -
              +
              addzone zone [class [view]] configuration

              @@ -830,8 +830,8 @@

              -
              -

              LIMITATIONS

              +
              +

              LIMITATIONS

              There is currently no way to provide the shared secret for a @@ -842,8 +842,8 @@

              -
              -

              SEE ALSO

              +
              +

              SEE ALSO

              rndc.conf(5) diff --git a/doc/arm/managed-keys.xml b/doc/arm/managed-keys.xml index 361c25baa7..8c1e420b70 100644 --- a/doc/arm/managed-keys.xml +++ b/doc/arm/managed-keys.xml @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> +

              Dynamic Trust Anchor Management diff --git a/doc/arm/notes.html b/doc/arm/notes.html index e023618aed..922dd77216 100644 --- a/doc/arm/notes.html +++ b/doc/arm/notes.html @@ -17,15 +17,15 @@ - +
              -
              +

              -Release Notes for BIND Version 9.11.0pre-alpha

              +Release Notes for BIND Version 9.11.0pre-alpha
              -
              +

              Introduction

              @@ -34,7 +34,7 @@ of BIND on the corresponding major release branch.

              -
              +

              Download

              @@ -46,11 +46,11 @@ operating systems.

              -
              +

              Security Fixes

              -
                +

                • An incorrect boundary check in the OPENPGPKEY rdatatype @@ -148,11 +148,11 @@

              -
              +

              New Features

              -
                +

                • Added support for DynDB, a new interface for loading zone data @@ -186,7 +186,7 @@ experienced by recursives when they are being used as a vehicle for such an attack.

                  -
                    +

                    • fetches-per-server limits the number of @@ -517,11 +517,11 @@

                  -
                  +

                  Feature Changes

                  -
                    +

                    • ACLs containing geoip asnum elements were @@ -687,11 +687,11 @@

                  -
                  +

                  Porting Changes

                  -
                  • +

                    • The Microsoft Windows install tool BINDInstall.exe which requires a @@ -704,11 +704,11 @@

                  -
                  +

                  Bug Fixes

                  -
                    +

                    • dig, host and @@ -834,7 +834,7 @@

                      Several bugs have been fixed in the RPZ implementation:

                      -
                        +

                        • Policy zones that did not specifically require recursion @@ -883,7 +883,7 @@

                      -
                      +

                      End of Life

                      @@ -893,7 +893,7 @@ https://www.isc.org/downloads/software-support-policy/

                      -
                      +

                      Thank You

                      diff --git a/doc/xsl/copyright.xsl b/doc/xsl/copyright.xsl index 2a6b35385e..fcf5f7f546 100644 --- a/doc/xsl/copyright.xsl +++ b/doc/xsl/copyright.xsl @@ -14,6 +14,8 @@ - PERFORMANCE OF THIS SOFTWARE. --> + + + + + + -.\" Date: February 18, 2009 +.\" Generator: DocBook XSL Stylesheets v1.76.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 7a411cc210..416f57ac21 100644 --- a/isc-config.sh.docbook +++ b/isc-config.sh.docbook @@ -13,6 +13,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/isc-config.sh.html b/isc-config.sh.html index 8bb2f4f2cd..987f06d8e8 100644 --- a/isc-config.sh.html +++ b/isc-config.sh.html @@ -14,31 +14,51 @@ - PERFORMANCE OF THIS SOFTWARE. --> - 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 +71,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..31562bcda9 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.76.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 2988ac2d0d..4e6f428a64 100644 --- a/lib/lwres/man/lwres.docbook +++ b/lib/lwres/man/lwres.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/lib/lwres/man/lwres.html b/lib/lwres/man/lwres.html index 1fd396135e..a62abff2d1 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..6851a53b85 100644 --- a/lib/lwres/man/lwres_buffer.3 +++ b/lib/lwres/man/lwres_buffer.3 @@ -13,118 +13,142 @@ .\" 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.76.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 @@ -133,12 +157,12 @@ initializes the 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 +172,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 +222,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 1377ae66ce..91347e6314 100644 --- a/lib/lwres/man/lwres_buffer.docbook +++ b/lib/lwres/man/lwres_buffer.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/lib/lwres/man/lwres_buffer.html b/lib/lwres/man/lwres_buffer.html index 4d29441ca1..4a9c8f5eba 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..7fb700fad0 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.76.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 @@ -74,32 +89,36 @@ structure for resolver context \fIctx\fR to the \fBFILE\fR -\fIfp\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 0ad795f3a2..664f4ba598 100644 --- a/lib/lwres/man/lwres_config.docbook +++ b/lib/lwres/man/lwres_config.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/lib/lwres/man/lwres_config.html b/lib/lwres/man/lwres_config.html index 3fc8826342..4f8ead1879 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..7a33e43600 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.76.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.html b/lib/lwres/man/lwres_context.html index 6ca8be4fdc..e6936f7c88 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..689b3b03c4 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.76.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,7 +178,7 @@ 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 @@ -162,9 +189,9 @@ 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 +199,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.html b/lib/lwres/man/lwres_gabn.html index dfc6c28038..e27269cb7e 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..09bac6a18c 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.76.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 61636fa025..e5ab2fbee3 100644 --- a/lib/lwres/man/lwres_gai_strerror.docbook +++ b/lib/lwres/man/lwres_gai_strerror.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/lib/lwres/man/lwres_gai_strerror.html b/lib/lwres/man/lwres_gai_strerror.html index 615f983391..7155ceb275 100644 --- a/lib/lwres/man/lwres_gai_strerror.html +++ b/lib/lwres/man/lwres_gai_strerror.html @@ -14,36 +14,48 @@ - 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 @@ -51,55 +63,77 @@ char *

              EAI_ADDRFAMILY
              -

              +

              +

              address family for hostname not supported -

              +

              +
              EAI_AGAIN
              -

              +

              +

              temporary failure in name resolution -

              +

              +
              EAI_BADFLAGS
              -

              +

              +

              invalid value for ai_flags -

              +

              +
              EAI_FAIL
              -

              +

              +

              non-recoverable failure in name resolution -

              +

              +
              EAI_FAMILY
              -

              ai_family not supported -

              +
              +

              ai_family not supported +

              +
              EAI_MEMORY
              -

              +

              +

              memory allocation failure -

              +

              +
              EAI_NODATA
              -

              +

              +

              no address associated with hostname -

              +

              +
              EAI_NONAME
              -

              +

              +

              hostname or servname not provided, or not known -

              +

              +
              EAI_SERVICE
              -

              +

              +

              servname not supported for ai_socktype -

              +

              +
              EAI_SOCKTYPE
              -

              ai_socktype not supported -

              +
              +

              ai_socktype not supported +

              +
              EAI_SYSTEM
              -

              +

              +

              system error returned in errno -

              +

              +

              The message invalid error code is returned if ecode is out of range.

              -

              ai_flags, +

              ai_flags, ai_family and ai_socktype @@ -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..b05b9578d2 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.76.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,51 +186,51 @@ 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 @@ -225,7 +238,7 @@ are \fBNULL\fR \fBlwres_getaddrinfo()\fR returns -\fBEAI_NONAME\fR. +\fBEAI_NONAME\fR\&. .SH "SEE ALSO" .PP \fBlwres\fR(3), @@ -238,8 +251,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.html b/lib/lwres/man/lwres_getaddrinfo.html index ac9c3a8d9a..234b880b11 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 @@ -119,7 +127,8 @@ struct addrinfo {

              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..2ca27ed006 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.76.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.html b/lib/lwres/man/lwres_gethostent.html index bc81732ff7..343b9b8656 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(), @@ -382,37 +378,50 @@ struct hostent {

              HOST_NOT_FOUND
              -

              +

              +

              The host or address was not found. -

              +

              +
              TRY_AGAIN
              -

              +

              +

              A recoverable error occurred, e.g., a timeout. Retrying the lookup may succeed. -

              +

              +
              NO_RECOVERY
              -

              +

              +

              A non-recoverable error occurred. -

              +

              +
              NO_DATA
              -

              +

              +

              The name exists, but has no address information associated with it (or vice versa in the case of a reverse lookup). The code NO_ADDRESS is accepted as a synonym for NO_DATA for backwards compatibility. -

              +

              +

              -

              lwres_hstrerror(3) + +

              + lwres_hstrerror(3) + translates these error codes to suitable error messages.

              -

              lwres_gethostent() + +

              lwres_gethostent() and lwres_gethostent_r() always return NULL.

              -

              + +

              Successful calls to lwres_gethostbyname_r() and lwres_gethostbyaddr_r() return resbuf, a pointer to the @@ -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..091ffc707f 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.76.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 06e358ccdf..4e845e1b4e 100644 --- a/lib/lwres/man/lwres_getipnode.docbook +++ b/lib/lwres/man/lwres_getipnode.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/lib/lwres/man/lwres_getipnode.html b/lib/lwres/man/lwres_getipnode.html index f3aeef3b30..0e25817039 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
@@ -167,15 +179,18 @@ struct  hostent {
       
              
 
              
 
              AI_V4MAPPED
              
-
              
+
              
+            
              
               This is used with an
               af
               of AF_INET6, and causes IPv4 addresses to be returned as
               IPv4-mapped
               IPv6 addresses.
-            
              
+            
              
+          
 
              AI_ALL
              
-
              
+
              
+            
              
               This is used with an
               af
               of AF_INET6, and causes all known addresses (IPv6 and IPv4) to
@@ -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 @@ -233,47 +255,70 @@ struct hostent {

              HOST_NOT_FOUND
              -

              +

              +

              No such host is known. -

              +

              +
              NO_ADDRESS
              -

              +

              +

              The server recognised the request and the name but no address is available. Another type of request to the name server for the domain might return an answer. -

              +

              +
              TRY_AGAIN
              -

              +

              +

              A temporary and possibly transient error occurred, such as a failure of a server to respond. The request may succeed if retried. -

              +

              +
              NO_RECOVERY
              -

              +

              +

              An unexpected failure occurred, and retrying the request is pointless. -

              +

              +

              -

              lwres_hstrerror(3) +

              + lwres_hstrerror(3) + translates these error codes to suitable error messages.

              -
              -
              -

              SEE ALSO

              -

              RFC2553, +

              +
              +

              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..fdd40c376a 100644 --- a/lib/lwres/man/lwres_getnameinfo.3 +++ b/lib/lwres/man/lwres_getnameinfo.3 @@ -13,57 +13,72 @@ .\" 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.76.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 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 +86,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 92fd66f0b6..62e4d9f2f0 100644 --- a/lib/lwres/man/lwres_getnameinfo.docbook +++ b/lib/lwres/man/lwres_getnameinfo.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/lib/lwres/man/lwres_getnameinfo.html b/lib/lwres/man/lwres_getnameinfo.html index 72efdfc206..b9c241b025 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..888a741d13 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.76.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 0cea4f6951..c9b7826d90 100644 --- a/lib/lwres/man/lwres_getrrsetbyname.docbook +++ b/lib/lwres/man/lwres_getrrsetbyname.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/lib/lwres/man/lwres_getrrsetbyname.html b/lib/lwres/man/lwres_getrrsetbyname.html index 6865feae23..7ee059bc0a 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..659d5d224f 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.76.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,7 +163,7 @@ 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 @@ -150,9 +174,9 @@ 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 +184,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.html b/lib/lwres/man/lwres_gnba.html index d6b7c27c74..4649fe887c 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..eb6fb4adbb 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.76.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 0786194046..9f954e663e 100644 --- a/lib/lwres/man/lwres_hstrerror.docbook +++ b/lib/lwres/man/lwres_hstrerror.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/lib/lwres/man/lwres_hstrerror.html b/lib/lwres/man/lwres_hstrerror.html index 39713fb413..02689b107c 100644 --- a/lib/lwres/man/lwres_hstrerror.html +++ b/lib/lwres/man/lwres_hstrerror.html @@ -14,50 +14,62 @@ - 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: @@ -65,40 +77,58 @@ const char *

              NETDB_SUCCESS
              -

              Resolver Error 0 (no error) -

              +
              +

              Resolver Error 0 (no error) +

              +
              HOST_NOT_FOUND
              -

              Unknown host -

              +
              +

              Unknown host +

              +
              TRY_AGAIN
              -

              Host name lookup failure -

              +
              +

              Host name lookup failure +

              +
              NO_RECOVERY
              -

              Unknown server error -

              +
              +

              Unknown server error +

              +
              NO_DATA
              -

              No address associated with name -

              +
              +

              No address associated with name +

              +

              -
              -
              -

              RETURN VALUES

              -

              +

              + +
              +

              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..4e96deded9 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.76.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.html b/lib/lwres/man/lwres_inetntop.html index fb3264ceb4..8686cb43e7 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..5140bba3a4 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.76.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,7 +163,7 @@ 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 @@ -150,9 +174,9 @@ 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 +184,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.html b/lib/lwres/man/lwres_noop.html index 274a2c9038..17f24f53dc 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..1ec18558ba 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.76.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,72 +87,73 @@ 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 @@ -140,16 +161,16 @@ transfers the contents of lightweight resolver packet structure \fBlwres_lwpacket_t\fR \fI*pkt\fR in network byte order to the lightweight resolver buffer, -\fI*b\fR. +\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 +178,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 7e4a80ecc3..9b03eff7f7 100644 --- a/lib/lwres/man/lwres_packet.docbook +++ b/lib/lwres/man/lwres_packet.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/lib/lwres/man/lwres_packet.html b/lib/lwres/man/lwres_packet.html index 648417bd8f..d390cac6b1 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..d2e7451b10 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.76.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 4fa3733ecf..eea985d634 100644 --- a/lib/lwres/man/lwres_resutil.docbook +++ b/lib/lwres/man/lwres_resutil.docbook @@ -14,6 +14,7 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> + diff --git a/lib/lwres/man/lwres_resutil.html b/lib/lwres/man/lwres_resutil.html index c62a289d96..57b2adfbe8 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) + .

              -
              + +