diff options
Diffstat (limited to 'bin')
109 files changed, 4751 insertions, 4064 deletions
diff --git a/bin/check/Makefile.in b/bin/check/Makefile.in index b88be3cb85bf..fb6c304db5dc 100644 --- a/bin/check/Makefile.in +++ b/bin/check/Makefile.in @@ -1,4 +1,4 @@ -# Copyright (C) 2004-2007, 2009, 2012, 2014 Internet Systems Consortium, Inc. ("ISC") +# Copyright (C) 2004-2007, 2009, 2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") # Copyright (C) 2000-2003 Internet Software Consortium. # # Permission to use, copy, modify, and/or distribute this software for any @@ -19,7 +19,7 @@ srcdir = @srcdir@ VPATH = @srcdir@ top_srcdir = @top_srcdir@ -@BIND9_VERSION@ +VERSION=@BIND9_VERSION@ @BIND9_MAKE_INCLUDES@ diff --git a/bin/check/named-checkconf.8 b/bin/check/named-checkconf.8 index ad6c497f3a31..cab8e22f8a00 100644 --- a/bin/check/named-checkconf.8 +++ b/bin/check/named-checkconf.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" Copyright (C) 2000-2002 Internet Software Consortium. .\" .\" Permission to use, copy, modify, and/or distribute this software for any @@ -13,115 +13,131 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: January 10, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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 +.HP \w'\fBnamed\-checkconf\fR\ 'u \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] .SH "DESCRIPTION" .PP \fBnamed\-checkconf\fR checks the syntax, but not the semantics, of a \fBnamed\fR -configuration file. The file is parsed and checked for syntax errors, along with all files included by it. If no file is specified, -\fI/etc/named.conf\fR -is read by default. +configuration file\&. The file is parsed and checked for syntax errors, along with all files included by it\&. If no file is specified, +/etc/named\&.conf +is read by default\&. .PP Note: files that \fBnamed\fR reads in separate parser contexts, such as -\fIrndc.key\fR +rndc\&.key and -\fIbind.keys\fR, are not automatically read by -\fBnamed\-checkconf\fR. Configuration errors in these files may cause +bind\&.keys, are not automatically read by +\fBnamed\-checkconf\fR\&. Configuration errors in these files may cause \fBnamed\fR to fail to run, even if \fBnamed\-checkconf\fR -was successful. +was successful\&. \fBnamed\-checkconf\fR -can be run on these files explicitly, however. +can be run on these files explicitly, however\&. .SH "OPTIONS" .PP \-h .RS 4 -Print the usage summary and exit. +Print the usage summary and exit\&. .RE .PP \-t \fIdirectory\fR .RS 4 Chroot to -\fIdirectory\fR -so that include directives in the configuration file are processed as if run by a similarly chrooted named. +directory +so that include directives in the configuration file are processed as if run by a similarly chrooted named\&. .RE .PP \-v .RS 4 Print the version of the \fBnamed\-checkconf\fR -program and exit. +program and exit\&. .RE .PP \-p .RS 4 Print out the -\fInamed.conf\fR -and included files in canonical form if no errors were detected. +named\&.conf +and included files in canonical form if no errors were detected\&. .RE .PP \-x .RS 4 -When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks ('?'). This allows the contents of -\fInamed.conf\fR -and related files to be shared \(em for example, when submitting bug reports \(em without compromising private data. This option cannot be used without -\fB\-p\fR. +When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks (\*(Aq?\*(Aq)\&. This allows the contents of +named\&.conf +and related files to be shared \(em for example, when submitting bug reports \(em without compromising private data\&. This option cannot be used without +\fB\-p\fR\&. .RE .PP \-z .RS 4 Perform a test load of all master zones found in -\fInamed.conf\fR. +named\&.conf\&. .RE .PP \-j .RS 4 -When loading a zonefile read the journal if it exists. +When loading a zonefile read the journal if it exists\&. .RE .PP filename .RS 4 -The name of the configuration file to be checked. If not specified, it defaults to -\fI/etc/named.conf\fR. +The name of the configuration file to be checked\&. If not specified, it defaults to +/etc/named\&.conf\&. .RE .SH "RETURN VALUES" .PP \fBnamed\-checkconf\fR -returns an exit status of 1 if errors were detected and 0 otherwise. +returns an exit status of 1 if errors were detected and 0 otherwise\&. .SH "SEE ALSO" .PP \fBnamed\fR(8), -\fBnamed\-checkzone\fR(8), -BIND 9 Administrator Reference Manual. +\fBnamed-checkzone\fR(8), +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -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, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2002 Internet Software Consortium. .br diff --git a/bin/check/named-checkconf.c b/bin/check/named-checkconf.c index a2a0856de475..be05a35e7b01 100644 --- a/bin/check/named-checkconf.c +++ b/bin/check/named-checkconf.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2004-2007, 2009-2015 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2004-2007, 2009-2016 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 1999-2002 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -421,15 +421,27 @@ configure_view(const char *vclass, const char *view, const cfg_obj_t *config, return (result); } +static isc_result_t +config_getclass(const cfg_obj_t *classobj, dns_rdataclass_t defclass, + dns_rdataclass_t *classp) +{ + isc_textregion_t r; + + if (!cfg_obj_isstring(classobj)) { + *classp = defclass; + return (ISC_R_SUCCESS); + } + DE_CONST(cfg_obj_asstring(classobj), r.base); + r.length = strlen(r.base); + return (dns_rdataclass_fromtext(classp, &r)); +} /*% load zones from the configuration */ static isc_result_t load_zones_fromconfig(const cfg_obj_t *config, isc_mem_t *mctx) { const cfg_listelt_t *element; - const cfg_obj_t *classobj; const cfg_obj_t *views; const cfg_obj_t *vconfig; - const char *vclass; isc_result_t result = ISC_R_SUCCESS; isc_result_t tresult; @@ -440,17 +452,24 @@ load_zones_fromconfig(const cfg_obj_t *config, isc_mem_t *mctx) { element != NULL; element = cfg_list_next(element)) { + const cfg_obj_t *classobj; + dns_rdataclass_t viewclass; const char *vname; + char buf[sizeof("CLASS65535")]; - vclass = "IN"; vconfig = cfg_listelt_value(element); - if (vconfig != NULL) { - classobj = cfg_tuple_get(vconfig, "class"); - if (cfg_obj_isstring(classobj)) - vclass = cfg_obj_asstring(classobj); - } + if (vconfig == NULL) + continue; + + classobj = cfg_tuple_get(vconfig, "class"); + CHECK(config_getclass(classobj, dns_rdataclass_in, + &viewclass)); + if (dns_rdataclass_ismeta(viewclass)) + CHECK(ISC_R_FAILURE); + + dns_rdataclass_format(viewclass, buf, sizeof(buf)); vname = cfg_obj_asstring(cfg_tuple_get(vconfig, "name")); - tresult = configure_view(vclass, vname, config, vconfig, mctx); + tresult = configure_view(buf, vname, config, vconfig, mctx); if (tresult != ISC_R_SUCCESS) result = tresult; } @@ -460,6 +479,8 @@ load_zones_fromconfig(const cfg_obj_t *config, isc_mem_t *mctx) { if (tresult != ISC_R_SUCCESS) result = tresult; } + +cleanup: return (result); } diff --git a/bin/check/named-checkconf.docbook b/bin/check/named-checkconf.docbook index a5e50334e2ae..87b68f365df9 100644 --- a/bin/check/named-checkconf.docbook +++ b/bin/check/named-checkconf.docbook @@ -1,8 +1,7 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> +<!DOCTYPE book [ +<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2002 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -18,9 +17,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.named-checkconf"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-checkconf"> + <info> + <date>2014-01-10</date> + </info> <refentryinfo> - <date>January 10, 2014</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -36,6 +40,7 @@ <year>2007</year> <year>2009</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> <copyright> @@ -52,21 +57,21 @@ </refnamediv> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>named-checkconf</command> - <arg><option>-h</option></arg> - <arg><option>-v</option></arg> - <arg><option>-j</option></arg> - <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg> - <arg choice="req">filename</arg> - <arg><option>-p</option></arg> - <arg><option>-x</option></arg> - <arg><option>-z</option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-v</option></arg> + <arg choice="opt" rep="norepeat"><option>-j</option></arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="req" rep="norepeat">filename</arg> + <arg choice="opt" rep="norepeat"><option>-p</option></arg> + <arg choice="opt" rep="norepeat"><option>-x</option></arg> + <arg choice="opt" rep="norepeat"><option>-z</option></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>named-checkconf</command> checks the syntax, but not the semantics, of a <command>named</command> configuration file. The file is parsed @@ -84,10 +89,10 @@ successful. <command>named-checkconf</command> can be run on these files explicitly, however. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -176,18 +181,18 @@ </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>RETURN VALUES</title></info> - <refsect1> - <title>RETURN VALUES</title> <para><command>named-checkconf</command> returns an exit status of 1 if errors were detected and 0 otherwise. </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, @@ -196,16 +201,5 @@ </citerefentry>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>. </para> - </refsect1> - - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> + </refsection> +</refentry> diff --git a/bin/check/named-checkconf.html b/bin/check/named-checkconf.html index 8caabf260e1e..89524ab0db15 100644 --- a/bin/check/named-checkconf.html +++ b/bin/check/named-checkconf.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2002 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>named-checkconf</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.named-checkconf"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -31,29 +30,29 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">named-checkconf</code> [<code class="option">-h</code>] [<code class="option">-v</code>] [<code class="option">-j</code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] {filename} [<code class="option">-p</code>] [<code class="option">-x</code>] [<code class="option">-z</code>]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543411"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">named-checkconf</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>named-checkconf</strong></span> checks the syntax, but not the semantics, of a - <span><strong class="command">named</strong></span> configuration file. The file is parsed + <span class="command"><strong>named</strong></span> configuration file. The file is parsed and checked for syntax errors, along with all files included by it. If no file is specified, <code class="filename">/etc/named.conf</code> is read by default. </p> <p> - Note: files that <span><strong class="command">named</strong></span> reads in separate + Note: files that <span class="command"><strong>named</strong></span> reads in separate parser contexts, such as <code class="filename">rndc.key</code> and <code class="filename">bind.keys</code>, are not automatically read - by <span><strong class="command">named-checkconf</strong></span>. Configuration - errors in these files may cause <span><strong class="command">named</strong></span> to - fail to run, even if <span><strong class="command">named-checkconf</strong></span> was - successful. <span><strong class="command">named-checkconf</strong></span> can be run + by <span class="command"><strong>named-checkconf</strong></span>. Configuration + errors in these files may cause <span class="command"><strong>named</strong></span> to + fail to run, even if <span class="command"><strong>named-checkconf</strong></span> was + successful. <span class="command"><strong>named-checkconf</strong></span> can be run on these files explicitly, however. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543460"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-h</span></dt> <dd><p> Print the usage summary and exit. @@ -66,7 +65,7 @@ </p></dd> <dt><span class="term">-v</span></dt> <dd><p> - Print the version of the <span><strong class="command">named-checkconf</strong></span> + Print the version of the <span class="command"><strong>named-checkconf</strong></span> program and exit. </p></dd> <dt><span class="term">-p</span></dt> @@ -100,24 +99,19 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543604"></a><h2>RETURN VALUES</h2> -<p><span><strong class="command">named-checkconf</strong></span> +<div class="refsection"> +<a name="id-1.9"></a><h2>RETURN VALUES</h2> +<p><span class="command"><strong>named-checkconf</strong></span> returns an exit status of 1 if errors were detected and 0 otherwise. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543616"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543645"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/check/named-checkzone.8 b/bin/check/named-checkzone.8 index f9bba0e73de2..3f8ca0550d3a 100644 --- a/bin/check/named-checkzone.8 +++ b/bin/check/named-checkzone.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2004-2007, 2009-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2004-2007, 2009-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") .\" Copyright (C) 2000-2002 Internet Software Consortium. .\" .\" Permission to use, copy, modify, and/or distribute this software for any @@ -13,106 +13,121 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: April 29, 2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2013-04-29 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NAMED\-CHECKZONE" "8" "April 29, 2013" "BIND9" "BIND9" +.TH "NAMED\-CHECKZONE" "8" "2013\-04\-29" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -named\-checkzone, named\-compilezone \- zone file validity checking or converting tool +named-checkzone, named-compilezone \- zone file validity checking or converting tool .SH "SYNOPSIS" -.HP 16 +.HP \w'\fBnamed\-checkzone\fR\ 'u \fBnamed\-checkzone\fR [\fB\-d\fR] [\fB\-h\fR] [\fB\-j\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-f\ \fR\fB\fIformat\fR\fR] [\fB\-F\ \fR\fB\fIformat\fR\fR] [\fB\-i\ \fR\fB\fImode\fR\fR] [\fB\-k\ \fR\fB\fImode\fR\fR] [\fB\-m\ \fR\fB\fImode\fR\fR] [\fB\-M\ \fR\fB\fImode\fR\fR] [\fB\-n\ \fR\fB\fImode\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-o\ \fR\fB\fIfilename\fR\fR] [\fB\-r\ \fR\fB\fImode\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-S\ \fR\fB\fImode\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-T\ \fR\fB\fImode\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {zonename} {filename} -.HP 18 +.HP \w'\fBnamed\-compilezone\fR\ 'u \fBnamed\-compilezone\fR [\fB\-d\fR] [\fB\-j\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-C\ \fR\fB\fImode\fR\fR] [\fB\-f\ \fR\fB\fIformat\fR\fR] [\fB\-F\ \fR\fB\fIformat\fR\fR] [\fB\-i\ \fR\fB\fImode\fR\fR] [\fB\-k\ \fR\fB\fImode\fR\fR] [\fB\-m\ \fR\fB\fImode\fR\fR] [\fB\-n\ \fR\fB\fImode\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-r\ \fR\fB\fImode\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-T\ \fR\fB\fImode\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {\fB\-o\ \fR\fB\fIfilename\fR\fR} {zonename} {filename} .SH "DESCRIPTION" .PP \fBnamed\-checkzone\fR -checks the syntax and integrity of a zone file. It performs the same checks as +checks the syntax and integrity of a zone file\&. It performs the same checks as \fBnamed\fR -does when loading a zone. This makes +does when loading a zone\&. This makes \fBnamed\-checkzone\fR -useful for checking zone files before configuring them into a name server. +useful for checking zone files before configuring them into a name server\&. .PP \fBnamed\-compilezone\fR is similar to -\fBnamed\-checkzone\fR, but it always dumps the zone contents to a specified file in a specified format. Additionally, it applies stricter check levels by default, since the dump output will be used as an actual zone file loaded by -\fBnamed\fR. When manually specified otherwise, the check levels must at least be as strict as those specified in the +\fBnamed\-checkzone\fR, but it always dumps the zone contents to a specified file in a specified format\&. Additionally, it applies stricter check levels by default, since the dump output will be used as an actual zone file loaded by +\fBnamed\fR\&. When manually specified otherwise, the check levels must at least be as strict as those specified in the \fBnamed\fR -configuration file. +configuration file\&. .SH "OPTIONS" .PP \-d .RS 4 -Enable debugging. +Enable debugging\&. .RE .PP \-h .RS 4 -Print the usage summary and exit. +Print the usage summary and exit\&. .RE .PP \-q .RS 4 -Quiet mode \- exit code only. +Quiet mode \- exit code only\&. .RE .PP \-v .RS 4 Print the version of the \fBnamed\-checkzone\fR -program and exit. +program and exit\&. .RE .PP \-j .RS 4 -When loading the zone file read the journal if it exists. +When loading the zone file read the journal if it exists\&. .RE .PP \-c \fIclass\fR .RS 4 -Specify the class of the zone. If not specified, "IN" is assumed. +Specify the class of the zone\&. If not specified, "IN" is assumed\&. .RE .PP \-i \fImode\fR .RS 4 -Perform post\-load zone integrity checks. Possible modes are +Perform post\-load zone integrity checks\&. Possible modes are \fB"full"\fR (default), \fB"full\-sibling"\fR, \fB"local"\fR, \fB"local\-sibling"\fR and -\fB"none"\fR. +\fB"none"\fR\&. .sp Mode \fB"full"\fR -checks that MX records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode +checks that MX records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames)\&. Mode \fB"local"\fR -only checks MX records which refer to in\-zone hostnames. +only checks MX records which refer to in\-zone hostnames\&. .sp Mode \fB"full"\fR -checks that SRV records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode +checks that SRV records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames)\&. Mode \fB"local"\fR -only checks SRV records which refer to in\-zone hostnames. +only checks SRV records which refer to in\-zone hostnames\&. .sp Mode \fB"full"\fR -checks that delegation NS records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). It also checks that glue address records in the zone match those advertised by the child. Mode +checks that delegation NS records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames)\&. It also checks that glue address records in the zone match those advertised by the child\&. Mode \fB"local"\fR -only checks NS records which refer to in\-zone hostnames or that some required glue exists, that is when the nameserver is in a child zone. +only checks NS records which refer to in\-zone hostnames or that some required glue exists, that is when the nameserver is in a child zone\&. .sp Mode \fB"full\-sibling"\fR @@ -122,25 +137,25 @@ disable sibling glue checks but are otherwise the same as \fB"full"\fR and \fB"local"\fR -respectively. +respectively\&. .sp Mode \fB"none"\fR -disables the checks. +disables the checks\&. .RE .PP \-f \fIformat\fR .RS 4 -Specify the format of the zone file. Possible formats are +Specify the format of the zone file\&. Possible formats are \fB"text"\fR (default) and -\fB"raw"\fR. +\fB"raw"\fR\&. .RE .PP \-F \fIformat\fR .RS 4 -Specify the format of the output file specified. For -\fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents. +Specify the format of the output file specified\&. For +\fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents\&. .sp Possible formats are \fB"text"\fR @@ -148,161 +163,162 @@ Possible formats are \fB"raw"\fR or \fB"raw=N"\fR, which store the zone in a binary format for rapid loading by -\fBnamed\fR. +\fBnamed\fR\&. \fB"raw=N"\fR specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of -\fBnamed\fR; if N is 1, the file can be read by release 9.9.0 or higher. The default is 1. +\fBnamed\fR; if N is 1, the file can be read by release 9\&.9\&.0 or higher\&. The default is 1\&. .RE .PP \-k \fImode\fR .RS 4 Perform \fB"check\-names"\fR -checks with the specified failure mode. Possible modes are +checks with the specified failure mode\&. Possible modes are \fB"fail"\fR (default for \fBnamed\-compilezone\fR), \fB"warn"\fR (default for \fBnamed\-checkzone\fR) and -\fB"ignore"\fR. +\fB"ignore"\fR\&. .RE .PP \-L \fIserial\fR .RS 4 -When compiling a zone to 'raw' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) +When compiling a zone to \*(Aqraw\*(Aq format, set the "source serial" value in the header to the specified serial number\&. (This is expected to be used primarily for testing purposes\&.) .RE .PP \-m \fImode\fR .RS 4 -Specify whether MX records should be checked to see if they are addresses. Possible modes are +Specify whether MX records should be checked to see if they are addresses\&. Possible modes are \fB"fail"\fR, \fB"warn"\fR (default) and -\fB"ignore"\fR. +\fB"ignore"\fR\&. .RE .PP \-M \fImode\fR .RS 4 -Check if a MX record refers to a CNAME. Possible modes are +Check if a MX record refers to a CNAME\&. Possible modes are \fB"fail"\fR, \fB"warn"\fR (default) and -\fB"ignore"\fR. +\fB"ignore"\fR\&. .RE .PP \-n \fImode\fR .RS 4 -Specify whether NS records should be checked to see if they are addresses. Possible modes are +Specify whether NS records should be checked to see if they are addresses\&. Possible modes are \fB"fail"\fR (default for \fBnamed\-compilezone\fR), \fB"warn"\fR (default for \fBnamed\-checkzone\fR) and -\fB"ignore"\fR. +\fB"ignore"\fR\&. .RE .PP \-o \fIfilename\fR .RS 4 Write zone output to -\fIfilename\fR. If -\fIfilename\fR +filename\&. If +filename is -\fI\-\fR -then write to standard out. This is mandatory for -\fBnamed\-compilezone\fR. +\- +then write to standard out\&. This is mandatory for +\fBnamed\-compilezone\fR\&. .RE .PP \-r \fImode\fR .RS 4 -Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS. Possible modes are +Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS\&. Possible modes are \fB"fail"\fR, \fB"warn"\fR (default) and -\fB"ignore"\fR. +\fB"ignore"\fR\&. .RE .PP \-s \fIstyle\fR .RS 4 -Specify the style of the dumped zone file. Possible styles are +Specify the style of the dumped zone file\&. Possible styles are \fB"full"\fR (default) and -\fB"relative"\fR. The full format is most suitable for processing automatically by a separate script. On the other hand, the relative format is more human\-readable and is thus suitable for editing by hand. For +\fB"relative"\fR\&. The full format is most suitable for processing automatically by a separate script\&. On the other hand, the relative format is more human\-readable and is thus suitable for editing by hand\&. For \fBnamed\-checkzone\fR -this does not cause any effects unless it dumps the zone contents. It also does not have any meaning if the output format is not text. +this does not cause any effects unless it dumps the zone contents\&. It also does not have any meaning if the output format is not text\&. .RE .PP \-S \fImode\fR .RS 4 -Check if a SRV record refers to a CNAME. Possible modes are +Check if a SRV record refers to a CNAME\&. Possible modes are \fB"fail"\fR, \fB"warn"\fR (default) and -\fB"ignore"\fR. +\fB"ignore"\fR\&. .RE .PP \-t \fIdirectory\fR .RS 4 Chroot to -\fIdirectory\fR -so that include directives in the configuration file are processed as if run by a similarly chrooted named. +directory +so that include directives in the configuration file are processed as if run by a similarly chrooted named\&. .RE .PP \-T \fImode\fR .RS 4 -Check if Sender Policy Framework (SPF) records exist and issues a warning if an SPF\-formatted TXT record is not also present. Possible modes are +Check if Sender Policy Framework (SPF) records exist and issues a warning if an SPF\-formatted TXT record is not also present\&. Possible modes are \fB"warn"\fR (default), -\fB"ignore"\fR. +\fB"ignore"\fR\&. .RE .PP \-w \fIdirectory\fR .RS 4 chdir to -\fIdirectory\fR -so that relative filenames in master file $INCLUDE directives work. This is similar to the directory clause in -\fInamed.conf\fR. +directory +so that relative filenames in master file $INCLUDE directives work\&. This is similar to the directory clause in +named\&.conf\&. .RE .PP \-D .RS 4 -Dump zone file in canonical format. This is always enabled for -\fBnamed\-compilezone\fR. +Dump zone file in canonical format\&. This is always enabled for +\fBnamed\-compilezone\fR\&. .RE .PP \-W \fImode\fR .RS 4 -Specify whether to check for non\-terminal wildcards. Non\-terminal wildcards are almost always the result of a failure to understand the wildcard matching algorithm (RFC 1034). Possible modes are +Specify whether to check for non\-terminal wildcards\&. Non\-terminal wildcards are almost always the result of a failure to understand the wildcard matching algorithm (RFC 1034)\&. Possible modes are \fB"warn"\fR (default) and -\fB"ignore"\fR. +\fB"ignore"\fR\&. .RE .PP zonename .RS 4 -The domain name of the zone being checked. +The domain name of the zone being checked\&. .RE .PP filename .RS 4 -The name of the zone file. +The name of the zone file\&. .RE .SH "RETURN VALUES" .PP \fBnamed\-checkzone\fR -returns an exit status of 1 if errors were detected and 0 otherwise. +returns an exit status of 1 if errors were detected and 0 otherwise\&. .SH "SEE ALSO" .PP \fBnamed\fR(8), -\fBnamed\-checkconf\fR(8), +\fBnamed-checkconf\fR(8), RFC 1035, -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2007, 2009\-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2002 Internet Software Consortium. +Copyright \(co 2004-2007, 2009-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2002 Internet Software Consortium. .br diff --git a/bin/check/named-checkzone.c b/bin/check/named-checkzone.c index b1b871d09bd8..f731a1388a3f 100644 --- a/bin/check/named-checkzone.c +++ b/bin/check/named-checkzone.c @@ -58,7 +58,7 @@ dns_zone_t *zone = NULL; dns_zonetype_t zonetype = dns_zone_master; static int dumpzone = 0; static const char *output_filename; -static char *prog_name = NULL; +static const char *prog_name = NULL; static const dns_master_style_t *outputstyle = NULL; static enum { progmode_check, progmode_compile } progmode; diff --git a/bin/check/named-checkzone.docbook b/bin/check/named-checkzone.docbook index f1590b55474a..31cd6a311691 100644 --- a/bin/check/named-checkzone.docbook +++ b/bin/check/named-checkzone.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004-2007, 2009-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004-2007, 2009-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2002 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -18,9 +15,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.named-checkzone"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-checkzone"> + <info> + <date>2013-04-29</date> + </info> <refentryinfo> - <date>April 29, 2013</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -40,6 +42,7 @@ <year>2011</year> <year>2013</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> <copyright> @@ -57,64 +60,64 @@ </refnamediv> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>named-checkzone</command> - <arg><option>-d</option></arg> - <arg><option>-h</option></arg> - <arg><option>-j</option></arg> - <arg><option>-q</option></arg> - <arg><option>-v</option></arg> - <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg> - <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg> - <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg> - <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-M <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-L <replaceable class="parameter">serial</replaceable></option></arg> - <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg> - <arg><option>-r <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg> - <arg><option>-S <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-T <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-D</option></arg> - <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg> - <arg choice="req">zonename</arg> - <arg choice="req">filename</arg> + <arg choice="opt" rep="norepeat"><option>-d</option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-j</option></arg> + <arg choice="opt" rep="norepeat"><option>-q</option></arg> + <arg choice="opt" rep="norepeat"><option>-v</option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">format</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-F <replaceable class="parameter">format</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-M <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">serial</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">filename</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">style</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-S <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-T <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-w <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-D</option></arg> + <arg choice="opt" rep="norepeat"><option>-W <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="req" rep="norepeat">zonename</arg> + <arg choice="req" rep="norepeat">filename</arg> </cmdsynopsis> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>named-compilezone</command> - <arg><option>-d</option></arg> - <arg><option>-j</option></arg> - <arg><option>-q</option></arg> - <arg><option>-v</option></arg> - <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg> - <arg><option>-C <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg> - <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg> - <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-L <replaceable class="parameter">serial</replaceable></option></arg> - <arg><option>-r <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg> - <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-T <replaceable class="parameter">mode</replaceable></option></arg> - <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-D</option></arg> - <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg> - <arg choice="req"><option>-o <replaceable class="parameter">filename</replaceable></option></arg> - <arg choice="req">zonename</arg> - <arg choice="req">filename</arg> + <arg choice="opt" rep="norepeat"><option>-d</option></arg> + <arg choice="opt" rep="norepeat"><option>-j</option></arg> + <arg choice="opt" rep="norepeat"><option>-q</option></arg> + <arg choice="opt" rep="norepeat"><option>-v</option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-C <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">format</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-F <replaceable class="parameter">format</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">serial</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">style</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-T <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-w <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-D</option></arg> + <arg choice="opt" rep="norepeat"><option>-W <replaceable class="parameter">mode</replaceable></option></arg> + <arg choice="req" rep="norepeat"><option>-o <replaceable class="parameter">filename</replaceable></option></arg> + <arg choice="req" rep="norepeat">zonename</arg> + <arg choice="req" rep="norepeat">filename</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>named-checkzone</command> checks the syntax and integrity of a zone file. It performs the same checks as <command>named</command> does when loading a @@ -132,10 +135,10 @@ least be as strict as those specified in the <command>named</command> configuration file. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -289,7 +292,7 @@ <term>-L <replaceable class="parameter">serial</replaceable></term> <listitem> <para> - When compiling a zone to 'raw' format, set the "source serial" + When compiling a zone to 'raw' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) </para> @@ -352,7 +355,7 @@ <listitem> <para> Check for records that are treated as different by DNSSEC but - are semantically equal in plain DNS. + are semantically equal in plain DNS. Possible modes are <command>"fail"</command>, <command>"warn"</command> (default) and <command>"ignore"</command>. @@ -473,37 +476,27 @@ </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>RETURN VALUES</title></info> - <refsect1> - <title>RETURN VALUES</title> <para><command>named-checkzone</command> returns an exit status of 1 if errors were detected and 0 otherwise. </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, <citerefentry> - <refentrytitle>named-checkconf</refentrytitle><manvolnum>8</manvolnum> + <refentrytitle>named-checkconf</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, <citetitle>RFC 1035</citetitle>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/check/named-checkzone.html b/bin/check/named-checkzone.html index 7d44053c252d..ec0173d2b608 100644 --- a/bin/check/named-checkzone.html +++ b/bin/check/named-checkzone.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2004-2007, 2009-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004-2007, 2009-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2002 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>named-checkzone</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.named-checkzone"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -32,29 +31,29 @@ <div class="cmdsynopsis"><p><code class="command">named-checkzone</code> [<code class="option">-d</code>] [<code class="option">-h</code>] [<code class="option">-j</code>] [<code class="option">-q</code>] [<code class="option">-v</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-f <em class="replaceable"><code>format</code></em></code>] [<code class="option">-F <em class="replaceable"><code>format</code></em></code>] [<code class="option">-i <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-k <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-m <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-M <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-n <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-L <em class="replaceable"><code>serial</code></em></code>] [<code class="option">-o <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-r <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-s <em class="replaceable"><code>style</code></em></code>] [<code class="option">-S <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-T <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-w <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-D</code>] [<code class="option">-W <em class="replaceable"><code>mode</code></em></code>] {zonename} {filename}</p></div> <div class="cmdsynopsis"><p><code class="command">named-compilezone</code> [<code class="option">-d</code>] [<code class="option">-j</code>] [<code class="option">-q</code>] [<code class="option">-v</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-C <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-f <em class="replaceable"><code>format</code></em></code>] [<code class="option">-F <em class="replaceable"><code>format</code></em></code>] [<code class="option">-i <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-k <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-m <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-n <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-L <em class="replaceable"><code>serial</code></em></code>] [<code class="option">-r <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-s <em class="replaceable"><code>style</code></em></code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-T <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-w <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-D</code>] [<code class="option">-W <em class="replaceable"><code>mode</code></em></code>] {<code class="option">-o <em class="replaceable"><code>filename</code></em></code>} {zonename} {filename}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543747"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">named-checkzone</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>named-checkzone</strong></span> checks the syntax and integrity of a zone file. It performs the - same checks as <span><strong class="command">named</strong></span> does when loading a - zone. This makes <span><strong class="command">named-checkzone</strong></span> useful for + same checks as <span class="command"><strong>named</strong></span> does when loading a + zone. This makes <span class="command"><strong>named-checkzone</strong></span> useful for checking zone files before configuring them into a name server. </p> <p> - <span><strong class="command">named-compilezone</strong></span> is similar to - <span><strong class="command">named-checkzone</strong></span>, but it always dumps the + <span class="command"><strong>named-compilezone</strong></span> is similar to + <span class="command"><strong>named-checkzone</strong></span>, 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 <span><strong class="command">named</strong></span>. + loaded by <span class="command"><strong>named</strong></span>. When manually specified otherwise, the check levels must at least be as strict as those specified in the - <span><strong class="command">named</strong></span> configuration file. + <span class="command"><strong>named</strong></span> configuration file. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543782"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-d</span></dt> <dd><p> Enable debugging. @@ -69,7 +68,7 @@ </p></dd> <dt><span class="term">-v</span></dt> <dd><p> - Print the version of the <span><strong class="command">named-checkzone</strong></span> + Print the version of the <span class="command"><strong>named-checkzone</strong></span> program and exit. </p></dd> <dt><span class="term">-j</span></dt> @@ -84,133 +83,133 @@ <dd> <p> Perform post-load zone integrity checks. Possible modes are - <span><strong class="command">"full"</strong></span> (default), - <span><strong class="command">"full-sibling"</strong></span>, - <span><strong class="command">"local"</strong></span>, - <span><strong class="command">"local-sibling"</strong></span> and - <span><strong class="command">"none"</strong></span>. + <span class="command"><strong>"full"</strong></span> (default), + <span class="command"><strong>"full-sibling"</strong></span>, + <span class="command"><strong>"local"</strong></span>, + <span class="command"><strong>"local-sibling"</strong></span> and + <span class="command"><strong>"none"</strong></span>. </p> <p> - Mode <span><strong class="command">"full"</strong></span> checks that MX records + Mode <span class="command"><strong>"full"</strong></span> checks that MX records refer to A or AAAA record (both in-zone and out-of-zone - hostnames). Mode <span><strong class="command">"local"</strong></span> only + hostnames). Mode <span class="command"><strong>"local"</strong></span> only checks MX records which refer to in-zone hostnames. </p> <p> - Mode <span><strong class="command">"full"</strong></span> checks that SRV records + Mode <span class="command"><strong>"full"</strong></span> checks that SRV records refer to A or AAAA record (both in-zone and out-of-zone - hostnames). Mode <span><strong class="command">"local"</strong></span> only + hostnames). Mode <span class="command"><strong>"local"</strong></span> only checks SRV records which refer to in-zone hostnames. </p> <p> - Mode <span><strong class="command">"full"</strong></span> checks that delegation NS + Mode <span class="command"><strong>"full"</strong></span> 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 <span><strong class="command">"local"</strong></span> only checks NS records which + Mode <span class="command"><strong>"local"</strong></span> 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. </p> <p> - Mode <span><strong class="command">"full-sibling"</strong></span> and - <span><strong class="command">"local-sibling"</strong></span> disable sibling glue - checks but are otherwise the same as <span><strong class="command">"full"</strong></span> - and <span><strong class="command">"local"</strong></span> respectively. + Mode <span class="command"><strong>"full-sibling"</strong></span> and + <span class="command"><strong>"local-sibling"</strong></span> disable sibling glue + checks but are otherwise the same as <span class="command"><strong>"full"</strong></span> + and <span class="command"><strong>"local"</strong></span> respectively. </p> <p> - Mode <span><strong class="command">"none"</strong></span> disables the checks. + Mode <span class="command"><strong>"none"</strong></span> disables the checks. </p> </dd> <dt><span class="term">-f <em class="replaceable"><code>format</code></em></span></dt> <dd><p> Specify the format of the zone file. - Possible formats are <span><strong class="command">"text"</strong></span> (default) - and <span><strong class="command">"raw"</strong></span>. + Possible formats are <span class="command"><strong>"text"</strong></span> (default) + and <span class="command"><strong>"raw"</strong></span>. </p></dd> <dt><span class="term">-F <em class="replaceable"><code>format</code></em></span></dt> <dd> <p> Specify the format of the output file specified. - For <span><strong class="command">named-checkzone</strong></span>, + For <span class="command"><strong>named-checkzone</strong></span>, this does not cause any effects unless it dumps the zone contents. </p> <p> - Possible formats are <span><strong class="command">"text"</strong></span> (default) - and <span><strong class="command">"raw"</strong></span> or <span><strong class="command">"raw=N"</strong></span>, + Possible formats are <span class="command"><strong>"text"</strong></span> (default) + and <span class="command"><strong>"raw"</strong></span> or <span class="command"><strong>"raw=N"</strong></span>, which store the zone in a binary format for rapid loading - by <span><strong class="command">named</strong></span>. <span><strong class="command">"raw=N"</strong></span> + by <span class="command"><strong>named</strong></span>. <span class="command"><strong>"raw=N"</strong></span> specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of - <span><strong class="command">named</strong></span>; if N is 1, the file can be read + <span class="command"><strong>named</strong></span>; if N is 1, the file can be read by release 9.9.0 or higher. The default is 1. </p> </dd> <dt><span class="term">-k <em class="replaceable"><code>mode</code></em></span></dt> <dd><p> - Perform <span><strong class="command">"check-names"</strong></span> checks with the + Perform <span class="command"><strong>"check-names"</strong></span> checks with the specified failure mode. - Possible modes are <span><strong class="command">"fail"</strong></span> - (default for <span><strong class="command">named-compilezone</strong></span>), - <span><strong class="command">"warn"</strong></span> - (default for <span><strong class="command">named-checkzone</strong></span>) and - <span><strong class="command">"ignore"</strong></span>. + Possible modes are <span class="command"><strong>"fail"</strong></span> + (default for <span class="command"><strong>named-compilezone</strong></span>), + <span class="command"><strong>"warn"</strong></span> + (default for <span class="command"><strong>named-checkzone</strong></span>) and + <span class="command"><strong>"ignore"</strong></span>. </p></dd> <dt><span class="term">-L <em class="replaceable"><code>serial</code></em></span></dt> <dd><p> - When compiling a zone to 'raw' format, set the "source serial" + When compiling a zone to 'raw' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) </p></dd> <dt><span class="term">-m <em class="replaceable"><code>mode</code></em></span></dt> <dd><p> Specify whether MX records should be checked to see if they - are addresses. Possible modes are <span><strong class="command">"fail"</strong></span>, - <span><strong class="command">"warn"</strong></span> (default) and - <span><strong class="command">"ignore"</strong></span>. + are addresses. Possible modes are <span class="command"><strong>"fail"</strong></span>, + <span class="command"><strong>"warn"</strong></span> (default) and + <span class="command"><strong>"ignore"</strong></span>. </p></dd> <dt><span class="term">-M <em class="replaceable"><code>mode</code></em></span></dt> <dd><p> Check if a MX record refers to a CNAME. - Possible modes are <span><strong class="command">"fail"</strong></span>, - <span><strong class="command">"warn"</strong></span> (default) and - <span><strong class="command">"ignore"</strong></span>. + Possible modes are <span class="command"><strong>"fail"</strong></span>, + <span class="command"><strong>"warn"</strong></span> (default) and + <span class="command"><strong>"ignore"</strong></span>. </p></dd> <dt><span class="term">-n <em class="replaceable"><code>mode</code></em></span></dt> <dd><p> Specify whether NS records should be checked to see if they are addresses. - Possible modes are <span><strong class="command">"fail"</strong></span> - (default for <span><strong class="command">named-compilezone</strong></span>), - <span><strong class="command">"warn"</strong></span> - (default for <span><strong class="command">named-checkzone</strong></span>) and - <span><strong class="command">"ignore"</strong></span>. + Possible modes are <span class="command"><strong>"fail"</strong></span> + (default for <span class="command"><strong>named-compilezone</strong></span>), + <span class="command"><strong>"warn"</strong></span> + (default for <span class="command"><strong>named-checkzone</strong></span>) and + <span class="command"><strong>"ignore"</strong></span>. </p></dd> <dt><span class="term">-o <em class="replaceable"><code>filename</code></em></span></dt> <dd><p> Write zone output to <code class="filename">filename</code>. If <code class="filename">filename</code> is <code class="filename">-</code> then write to standard out. - This is mandatory for <span><strong class="command">named-compilezone</strong></span>. + This is mandatory for <span class="command"><strong>named-compilezone</strong></span>. </p></dd> <dt><span class="term">-r <em class="replaceable"><code>mode</code></em></span></dt> <dd><p> Check for records that are treated as different by DNSSEC but - are semantically equal in plain DNS. - Possible modes are <span><strong class="command">"fail"</strong></span>, - <span><strong class="command">"warn"</strong></span> (default) and - <span><strong class="command">"ignore"</strong></span>. + are semantically equal in plain DNS. + Possible modes are <span class="command"><strong>"fail"</strong></span>, + <span class="command"><strong>"warn"</strong></span> (default) and + <span class="command"><strong>"ignore"</strong></span>. </p></dd> <dt><span class="term">-s <em class="replaceable"><code>style</code></em></span></dt> <dd><p> Specify the style of the dumped zone file. - Possible styles are <span><strong class="command">"full"</strong></span> (default) - and <span><strong class="command">"relative"</strong></span>. + Possible styles are <span class="command"><strong>"full"</strong></span> (default) + and <span class="command"><strong>"relative"</strong></span>. 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 <span><strong class="command">named-checkzone</strong></span> + For <span class="command"><strong>named-checkzone</strong></span> this does not cause any effects unless it dumps the zone contents. It also does not have any meaning if the output format @@ -219,9 +218,9 @@ <dt><span class="term">-S <em class="replaceable"><code>mode</code></em></span></dt> <dd><p> Check if a SRV record refers to a CNAME. - Possible modes are <span><strong class="command">"fail"</strong></span>, - <span><strong class="command">"warn"</strong></span> (default) and - <span><strong class="command">"ignore"</strong></span>. + Possible modes are <span class="command"><strong>"fail"</strong></span>, + <span class="command"><strong>"warn"</strong></span> (default) and + <span class="command"><strong>"ignore"</strong></span>. </p></dd> <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt> <dd><p> @@ -234,8 +233,8 @@ <dd><p> 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 <span><strong class="command">"warn"</strong></span> - (default), <span><strong class="command">"ignore"</strong></span>. + not also present. Possible modes are <span class="command"><strong>"warn"</strong></span> + (default), <span class="command"><strong>"ignore"</strong></span>. </p></dd> <dt><span class="term">-w <em class="replaceable"><code>directory</code></em></span></dt> <dd><p> @@ -248,16 +247,16 @@ <dt><span class="term">-D</span></dt> <dd><p> Dump zone file in canonical format. - This is always enabled for <span><strong class="command">named-compilezone</strong></span>. + This is always enabled for <span class="command"><strong>named-compilezone</strong></span>. </p></dd> <dt><span class="term">-W <em class="replaceable"><code>mode</code></em></span></dt> <dd><p> 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 <span><strong class="command">"warn"</strong></span> (default) + Possible modes are <span class="command"><strong>"warn"</strong></span> (default) and - <span><strong class="command">"ignore"</strong></span>. + <span class="command"><strong>"ignore"</strong></span>. </p></dd> <dt><span class="term">zonename</span></dt> <dd><p> @@ -269,25 +268,20 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2544622"></a><h2>RETURN VALUES</h2> -<p><span><strong class="command">named-checkzone</strong></span> +<div class="refsection"> +<a name="id-1.9"></a><h2>RETURN VALUES</h2> +<p><span class="command"><strong>named-checkzone</strong></span> returns an exit status of 1 if errors were detected and 0 otherwise. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2544634"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>, <em class="citetitle">RFC 1035</em>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2544667"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/confgen/Makefile.in b/bin/confgen/Makefile.in index 8b3e5aa1c4de..205069e7e126 100644 --- a/bin/confgen/Makefile.in +++ b/bin/confgen/Makefile.in @@ -1,4 +1,4 @@ -# Copyright (C) 2009, 2012 Internet Systems Consortium, Inc. ("ISC") +# Copyright (C) 2009, 2012, 2015 Internet Systems Consortium, Inc. ("ISC") # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above @@ -18,7 +18,7 @@ srcdir = @srcdir@ VPATH = @srcdir@ top_srcdir = @top_srcdir@ -@BIND9_VERSION@ +VERSION=@BIND9_VERSION@ @BIND9_MAKE_INCLUDES@ @@ -74,11 +74,11 @@ rndc-confgen.@O@: rndc-confgen.c ddns-confgen.@O@: ddns-confgen.c ${LIBTOOL_MODE_COMPILE} ${CC} ${ALL_CFLAGS} -c ${srcdir}/ddns-confgen.c -rndc-confgen@EXEEXT@: rndc-confgen.@O@ util.@O@ keygen.@O@ ${UOBJS} ${CONFDEPLIBS} +rndc-confgen@EXEEXT@: rndc-confgen.@O@ util.@O@ keygen.@O@ ${UOBJS} ${CONFDEPLIBS} export BASEOBJS="rndc-confgen.@O@ util.@O@ keygen.@O@ ${UOBJS}"; \ ${FINALBUILDCMD} -ddns-confgen@EXEEXT@: ddns-confgen.@O@ util.@O@ keygen.@O@ ${UOBJS} ${CONFDEPLIBS} +ddns-confgen@EXEEXT@: ddns-confgen.@O@ util.@O@ keygen.@O@ ${UOBJS} ${CONFDEPLIBS} export BASEOBJS="ddns-confgen.@O@ util.@O@ keygen.@O@ ${UOBJS}"; \ ${FINALBUILDCMD} diff --git a/bin/confgen/ddns-confgen.8 b/bin/confgen/ddns-confgen.8 index 5ceb80e96af4..aa40e4edc77b 100644 --- a/bin/confgen/ddns-confgen.8 +++ b/bin/confgen/ddns-confgen.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -12,26 +12,41 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: September 18, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2009-09-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DDNS\-CONFGEN" "8" "September 18, 2009" "BIND9" "BIND9" +.TH "DDNS\-CONFGEN" "8" "2009\-09\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -ddns\-confgen \- ddns key generation tool +ddns-confgen \- ddns key generation tool .SH "SYNOPSIS" -.HP 13 +.HP \w'\fBddns\-confgen\fR\ 'u \fBddns\-confgen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\-s\ \fIname\fR | \-z\ \fIzone\fR] [\fB\-q\fR] [name] .SH "DESCRIPTION" .PP @@ -39,46 +54,46 @@ ddns\-confgen \- ddns key generation tool generates a key for use by \fBnsupdate\fR and -\fBnamed\fR. It simplifies configuration of dynamic zones by generating a key and providing the +\fBnamed\fR\&. It simplifies configuration of dynamic zones by generating a key and providing the \fBnsupdate\fR and -\fBnamed.conf\fR +\fBnamed\&.conf\fR syntax that will be needed to use it, including an example \fBupdate\-policy\fR -statement. +statement\&. .PP If a domain name is specified on the command line, it will be used in the name of the generated key and in the sample -\fBnamed.conf\fR -syntax. For example, -\fBddns\-confgen example.com\fR -would generate a key called "ddns\-key.example.com", and sample -\fBnamed.conf\fR -command that could be used in the zone definition for "example.com". +\fBnamed\&.conf\fR +syntax\&. For example, +\fBddns\-confgen example\&.com\fR +would generate a key called "ddns\-key\&.example\&.com", and sample +\fBnamed\&.conf\fR +command that could be used in the zone definition for "example\&.com"\&. .PP Note that \fBnamed\fR itself can configure a local DDNS key for use with -\fBnsupdate \-l\fR. +\fBnsupdate \-l\fR\&. \fBddns\-confgen\fR is only needed when a more elaborate configuration is required: for instance, if \fBnsupdate\fR -is to be used from a remote system. +is to be used from a remote system\&. .SH "OPTIONS" .PP \-a \fIalgorithm\fR .RS 4 -Specifies the algorithm to use for the TSIG key. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512. The default is hmac\-sha256. +Specifies the algorithm to use for the TSIG key\&. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512\&. The default is hmac\-sha256\&. .RE .PP \-h .RS 4 Prints a short summary of the options and arguments to -\fBddns\-confgen\fR. +\fBddns\-confgen\fR\&. .RE .PP \-k \fIkeyname\fR .RS 4 -Specifies the key name of the DDNS authentication key. The default is +Specifies the key name of the DDNS authentication key\&. The default is \fBddns\-key\fR when neither the \fB\-s\fR @@ -86,58 +101,59 @@ nor \fB\-z\fR option is specified; otherwise, the default is \fBddns\-key\fR -as a separate label followed by the argument of the option, e.g., -\fBddns\-key.example.com.\fR -The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods. +as a separate label followed by the argument of the option, e\&.g\&., +\fBddns\-key\&.example\&.com\&.\fR +The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods\&. .RE .PP \-q .RS 4 -Quiet mode: Print only the key, with no explanatory text or usage examples. +Quiet mode: Print only the key, with no explanatory text or usage examples\&. .RE .PP \-r \fIrandomfile\fR .RS 4 -Specifies a source of random data for generating the authorization. If the operating system does not provide a -\fI/dev/random\fR -or equivalent device, the default source of randomness is keyboard input. -\fIrandomdev\fR -specifies the name of a character device or file containing random data to be used instead of the default. The special value -\fIkeyboard\fR -indicates that keyboard input should be used. +Specifies a source of random data for generating the authorization\&. If the operating system does not provide a +/dev/random +or equivalent device, the default source of randomness is keyboard input\&. +randomdev +specifies the name of a character device or file containing random data to be used instead of the default\&. The special value +keyboard +indicates that keyboard input should be used\&. .RE .PP \-s \fIname\fR .RS 4 Single host mode: The example -\fBnamed.conf\fR +\fBnamed\&.conf\fR text shows how to set an update policy for the specified \fIname\fR -using the "name" nametype. The default key name is ddns\-key.\fIname\fR. Note that the "self" nametype cannot be used, since the name to be updated may differ from the key name. This option cannot be used with the +using the "name" nametype\&. The default key name is ddns\-key\&.\fIname\fR\&. Note that the "self" nametype cannot be used, since the name to be updated may differ from the key name\&. This option cannot be used with the \fB\-z\fR -option. +option\&. .RE .PP \-z \fIzone\fR .RS 4 zone mode: The example -\fBnamed.conf\fR +\fBnamed\&.conf\fR text shows how to set an update policy for the specified \fIzone\fR using the "zonesub" nametype, allowing updates to all subdomain names within that -\fIzone\fR. This option cannot be used with the +\fIzone\fR\&. This option cannot be used with the \fB\-s\fR -option. +option\&. .RE .SH "SEE ALSO" .PP \fBnsupdate\fR(1), \fBnamed.conf\fR(5), \fBnamed\fR(8), -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/confgen/ddns-confgen.docbook b/bin/confgen/ddns-confgen.docbook index 1627c9ea04f8..44a6409158ff 100644 --- a/bin/confgen/ddns-confgen.docbook +++ b/bin/confgen/ddns-confgen.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.ddns-confgen"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.ddns-confgen"> + <info> + <date>2009-09-18</date> + </info> <refentryinfo> - <date>September 18, 2009</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -37,28 +39,29 @@ <copyright> <year>2009</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>ddns-confgen</command> - <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg> - <arg><option>-h</option></arg> - <arg><option>-k <replaceable class="parameter">keyname</replaceable></option></arg> - <arg><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg> - <group> - <arg choice="plain">-s <replaceable class="parameter">name</replaceable></arg> - <arg choice="plain">-z <replaceable class="parameter">zone</replaceable></arg> + <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">keyname</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg> + <group choice="opt" rep="norepeat"> + <arg choice="plain" rep="norepeat">-s <replaceable class="parameter">name</replaceable></arg> + <arg choice="plain" rep="norepeat">-z <replaceable class="parameter">zone</replaceable></arg> </group> - <arg><option>-q</option></arg> - <arg choice="opt">name</arg> + <arg choice="opt" rep="norepeat"><option>-q</option></arg> + <arg choice="opt" rep="norepeat">name</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>ddns-confgen</command> generates a key for use by <command>nsupdate</command> and <command>named</command>. It simplifies configuration @@ -81,14 +84,14 @@ <para> Note that <command>named</command> itself can configure a local DDNS key for use with <command>nsupdate -l</command>. - <command>ddns-confgen</command> is only needed when a + <command>ddns-confgen</command> is only needed when a more elaborate configuration is required: for instance, if <command>nsupdate</command> is to be used from a remote system. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -188,10 +191,10 @@ </listitem> </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>nsupdate</refentrytitle><manvolnum>1</manvolnum> </citerefentry>, @@ -203,16 +206,6 @@ </citerefentry>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/confgen/ddns-confgen.html b/bin/confgen/ddns-confgen.html index bdbd35ea0148..025d6638b584 100644 --- a/bin/confgen/ddns-confgen.html +++ b/bin/confgen/ddns-confgen.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>ddns-confgen</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.ddns-confgen"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -30,36 +29,36 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">ddns-confgen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [ -s <em class="replaceable"><code>name</code></em> | -z <em class="replaceable"><code>zone</code></em> ] [<code class="option">-q</code>] [name]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543406"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">ddns-confgen</strong></span> - generates a key for use by <span><strong class="command">nsupdate</strong></span> - and <span><strong class="command">named</strong></span>. It simplifies configuration +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>ddns-confgen</strong></span> + generates a key for use by <span class="command"><strong>nsupdate</strong></span> + and <span class="command"><strong>named</strong></span>. It simplifies configuration of dynamic zones by generating a key and providing the - <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span> + <span class="command"><strong>nsupdate</strong></span> and <span class="command"><strong>named.conf</strong></span> syntax that will be needed to use it, including an example - <span><strong class="command">update-policy</strong></span> statement. + <span class="command"><strong>update-policy</strong></span> statement. </p> <p> If a domain name is specified on the command line, it will be used in the name of the generated key and in the sample - <span><strong class="command">named.conf</strong></span> syntax. For example, - <span><strong class="command">ddns-confgen example.com</strong></span> would + <span class="command"><strong>named.conf</strong></span> syntax. For example, + <span class="command"><strong>ddns-confgen example.com</strong></span> would generate a key called "ddns-key.example.com", and sample - <span><strong class="command">named.conf</strong></span> command that could be used + <span class="command"><strong>named.conf</strong></span> command that could be used in the zone definition for "example.com". </p> <p> - Note that <span><strong class="command">named</strong></span> itself can configure a - local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>. - <span><strong class="command">ddns-confgen</strong></span> is only needed when a + Note that <span class="command"><strong>named</strong></span> itself can configure a + local DDNS key for use with <span class="command"><strong>nsupdate -l</strong></span>. + <span class="command"><strong>ddns-confgen</strong></span> is only needed when a more elaborate configuration is required: for instance, if - <span><strong class="command">nsupdate</strong></span> is to be used from a remote system. + <span class="command"><strong>nsupdate</strong></span> is to be used from a remote system. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543466"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt> <dd><p> Specifies the algorithm to use for the TSIG key. Available @@ -69,7 +68,7 @@ <dt><span class="term">-h</span></dt> <dd><p> Prints a short summary of the options and arguments to - <span><strong class="command">ddns-confgen</strong></span>. + <span class="command"><strong>ddns-confgen</strong></span>. </p></dd> <dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt> <dd><p> @@ -102,7 +101,7 @@ </p></dd> <dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt> <dd><p> - Single host mode: The example <span><strong class="command">named.conf</strong></span> text + Single host mode: The example <span class="command"><strong>named.conf</strong></span> text shows how to set an update policy for the specified <em class="replaceable"><code>name</code></em> using the "name" nametype. @@ -114,7 +113,7 @@ </p></dd> <dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt> <dd><p> - zone mode: The example <span><strong class="command">named.conf</strong></span> text + zone mode: The example <span class="command"><strong>named.conf</strong></span> text shows how to set an update policy for the specified <em class="replaceable"><code>zone</code></em> using the "zonesub" nametype, allowing updates to all subdomain @@ -124,18 +123,13 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543654"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>, <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>, <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543692"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/confgen/rndc-confgen.8 b/bin/confgen/rndc-confgen.8 index 1276344e372e..85d31510049e 100644 --- a/bin/confgen/rndc-confgen.8 +++ b/bin/confgen/rndc-confgen.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" Copyright (C) 2001, 2003 Internet Software Consortium. .\" .\" Permission to use, copy, modify, and/or distribute this software for any @@ -13,58 +13,73 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: June 15, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2009-06-15 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "RNDC\-CONFGEN" "8" "June 15, 2009" "BIND9" "BIND9" +.TH "RNDC\-CONFGEN" "8" "2009\-06\-15" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -rndc\-confgen \- rndc key generation tool +rndc-confgen \- rndc key generation tool .SH "SYNOPSIS" -.HP 13 +.HP \w'\fBrndc\-confgen\fR\ 'u \fBrndc\-confgen\fR [\fB\-a\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-c\ \fR\fB\fIkeyfile\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\fB\-s\ \fR\fB\fIaddress\fR\fR] [\fB\-t\ \fR\fB\fIchrootdir\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] .SH "DESCRIPTION" .PP \fBrndc\-confgen\fR generates configuration files for -\fBrndc\fR. It can be used as a convenient alternative to writing the -\fIrndc.conf\fR +\fBrndc\fR\&. It can be used as a convenient alternative to writing the +rndc\&.conf file and the corresponding \fBcontrols\fR and \fBkey\fR statements in -\fInamed.conf\fR -by hand. Alternatively, it can be run with the +named\&.conf +by hand\&. Alternatively, it can be run with the \fB\-a\fR option to set up a -\fIrndc.key\fR +rndc\&.key file and avoid the need for a -\fIrndc.conf\fR +rndc\&.conf file and a \fBcontrols\fR -statement altogether. +statement altogether\&. .SH "OPTIONS" .PP \-a .RS 4 Do automatic \fBrndc\fR -configuration. This creates a file -\fIrndc.key\fR +configuration\&. This creates a file +rndc\&.key in -\fI/etc\fR +/etc (or whatever \fIsysconfdir\fR was specified as when @@ -73,13 +88,13 @@ was built) that is read by both \fBrndc\fR and \fBnamed\fR -on startup. The -\fIrndc.key\fR +on startup\&. The +rndc\&.key file defines a default command channel and authentication key allowing \fBrndc\fR to communicate with \fBnamed\fR -on the local host with no further configuration. +on the local host with no further configuration\&. .sp Running \fBrndc\-confgen \-a\fR @@ -87,8 +102,8 @@ allows BIND 9 and \fBrndc\fR to be used as drop\-in replacements for BIND 8 and \fBndc\fR, with no changes to the existing BIND 8 -\fInamed.conf\fR -file. +named\&.conf +file\&. .sp If a more elaborate configuration than that generated by \fBrndc\-confgen \-a\fR @@ -97,15 +112,15 @@ is required, for example if rndc is to be used remotely, you should run without the \fB\-a\fR option and set up a -\fIrndc.conf\fR +rndc\&.conf and -\fInamed.conf\fR -as directed. +named\&.conf +as directed\&. .RE .PP \-b \fIkeysize\fR .RS 4 -Specifies the size of the authentication key in bits. Must be between 1 and 512 bits; the default is 128. +Specifies the size of the authentication key in bits\&. Must be between 1 and 512 bits; the default is 128\&. .RE .PP \-c \fIkeyfile\fR @@ -113,19 +128,19 @@ Specifies the size of the authentication key in bits. Must be between 1 and 512 Used with the \fB\-a\fR option to specify an alternate location for -\fIrndc.key\fR. +rndc\&.key\&. .RE .PP \-h .RS 4 Prints a short summary of the options and arguments to -\fBrndc\-confgen\fR. +\fBrndc\-confgen\fR\&. .RE .PP \-k \fIkeyname\fR .RS 4 -Specifies the key name of the rndc authentication key. This must be a valid domain name. The default is -\fBrndc\-key\fR. +Specifies the key name of the rndc authentication key\&. This must be a valid domain name\&. The default is +\fBrndc\-key\fR\&. .RE .PP \-p \fIport\fR @@ -133,18 +148,18 @@ Specifies the key name of the rndc authentication key. This must be a valid doma Specifies the command channel port where \fBnamed\fR listens for connections from -\fBrndc\fR. The default is 953. +\fBrndc\fR\&. The default is 953\&. .RE .PP \-r \fIrandomfile\fR .RS 4 -Specifies a source of random data for generating the authorization. If the operating system does not provide a -\fI/dev/random\fR -or equivalent device, the default source of randomness is keyboard input. -\fIrandomdev\fR -specifies the name of a character device or file containing random data to be used instead of the default. The special value -\fIkeyboard\fR -indicates that keyboard input should be used. +Specifies a source of random data for generating the authorization\&. If the operating system does not provide a +/dev/random +or equivalent device, the default source of randomness is keyboard input\&. +randomdev +specifies the name of a character device or file containing random data to be used instead of the default\&. The special value +keyboard +indicates that keyboard input should be used\&. .RE .PP \-s \fIaddress\fR @@ -152,7 +167,7 @@ indicates that keyboard input should be used. Specifies the IP address where \fBnamed\fR listens for command channel connections from -\fBrndc\fR. The default is the loopback address 127.0.0.1. +\fBrndc\fR\&. The default is the loopback address 127\&.0\&.0\&.1\&. .RE .PP \-t \fIchrootdir\fR @@ -161,10 +176,10 @@ Used with the \fB\-a\fR option to specify a directory where \fBnamed\fR -will run chrooted. An additional copy of the -\fIrndc.key\fR +will run chrooted\&. An additional copy of the +rndc\&.key will be written relative to this directory so that it will be found by the chrooted -\fBnamed\fR. +\fBnamed\fR\&. .RE .PP \-u \fIuser\fR @@ -172,10 +187,10 @@ will be written relative to this directory so that it will be found by the chroo Used with the \fB\-a\fR option to set the owner of the -\fIrndc.key\fR -file generated. If +rndc\&.key +file generated\&. If \fB\-t\fR -is also specified only the file in the chroot area has its owner changed. +is also specified only the file in the chroot area has its owner changed\&. .RE .SH "EXAMPLES" .PP @@ -186,13 +201,13 @@ to be used with no manual configuration, run \fBrndc\-confgen \-a\fR .PP To print a sample -\fIrndc.conf\fR +rndc\&.conf file and corresponding \fBcontrols\fR and \fBkey\fR statements to be manually inserted into -\fInamed.conf\fR, run +named\&.conf, run .PP \fBrndc\-confgen\fR .SH "SEE ALSO" @@ -200,12 +215,13 @@ 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" -Copyright \(co 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2001, 2003 Internet Software Consortium. .br diff --git a/bin/confgen/rndc-confgen.docbook b/bin/confgen/rndc-confgen.docbook index b3220754ad66..0887da2b5710 100644 --- a/bin/confgen/rndc-confgen.docbook +++ b/bin/confgen/rndc-confgen.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2001, 2003 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -18,9 +15,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.rndc-confgen"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.rndc-confgen"> + <info> + <date>2009-06-15</date> + </info> <refentryinfo> - <date>June 15, 2009</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -41,6 +43,7 @@ <year>2007</year> <year>2009</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> <copyright> @@ -51,23 +54,23 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>rndc-confgen</command> - <arg><option>-a</option></arg> - <arg><option>-b <replaceable class="parameter">keysize</replaceable></option></arg> - <arg><option>-c <replaceable class="parameter">keyfile</replaceable></option></arg> - <arg><option>-h</option></arg> - <arg><option>-k <replaceable class="parameter">keyname</replaceable></option></arg> - <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg> - <arg><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg> - <arg><option>-s <replaceable class="parameter">address</replaceable></option></arg> - <arg><option>-t <replaceable class="parameter">chrootdir</replaceable></option></arg> - <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-a</option></arg> + <arg choice="opt" rep="norepeat"><option>-b <replaceable class="parameter">keysize</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">keyfile</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">keyname</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">address</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">chrootdir</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-u <replaceable class="parameter">user</replaceable></option></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>rndc-confgen</command> generates configuration files for <command>rndc</command>. It can be used as a @@ -82,10 +85,10 @@ and a <command>controls</command> statement altogether. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -239,10 +242,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>EXAMPLES</title></info> - <refsect1> - <title>EXAMPLES</title> <para> To allow <command>rndc</command> to be used with no manual configuration, run @@ -257,10 +260,10 @@ </para> <para><userinput>rndc-confgen</userinput> </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>rndc</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, @@ -272,16 +275,6 @@ </citerefentry>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/confgen/rndc-confgen.html b/bin/confgen/rndc-confgen.html index 84eae417d1f4..a5c02451dcee 100644 --- a/bin/confgen/rndc-confgen.html +++ b/bin/confgen/rndc-confgen.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2001, 2003 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>rndc-confgen</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.rndc-confgen"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -31,57 +30,57 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">rndc-confgen</code> [<code class="option">-a</code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [<code class="option">-s <em class="replaceable"><code>address</code></em></code>] [<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543444"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">rndc-confgen</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>rndc-confgen</strong></span> generates configuration files - for <span><strong class="command">rndc</strong></span>. It can be used as a + for <span class="command"><strong>rndc</strong></span>. It can be used as a convenient alternative to writing the <code class="filename">rndc.conf</code> file - and the corresponding <span><strong class="command">controls</strong></span> - and <span><strong class="command">key</strong></span> + and the corresponding <span class="command"><strong>controls</strong></span> + and <span class="command"><strong>key</strong></span> statements in <code class="filename">named.conf</code> by hand. - Alternatively, it can be run with the <span><strong class="command">-a</strong></span> + Alternatively, it can be run with the <span class="command"><strong>-a</strong></span> option to set up a <code class="filename">rndc.key</code> file and avoid the need for a <code class="filename">rndc.conf</code> file - and a <span><strong class="command">controls</strong></span> statement altogether. + and a <span class="command"><strong>controls</strong></span> statement altogether. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543489"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-a</span></dt> <dd> <p> - Do automatic <span><strong class="command">rndc</strong></span> configuration. + Do automatic <span class="command"><strong>rndc</strong></span> configuration. This creates a file <code class="filename">rndc.key</code> in <code class="filename">/etc</code> (or whatever <code class="varname">sysconfdir</code> was specified as when <acronym class="acronym">BIND</acronym> was built) - that is read by both <span><strong class="command">rndc</strong></span> - and <span><strong class="command">named</strong></span> on startup. The + that is read by both <span class="command"><strong>rndc</strong></span> + and <span class="command"><strong>named</strong></span> on startup. The <code class="filename">rndc.key</code> file defines a default command channel and authentication key allowing - <span><strong class="command">rndc</strong></span> to communicate with - <span><strong class="command">named</strong></span> on the local host + <span class="command"><strong>rndc</strong></span> to communicate with + <span class="command"><strong>named</strong></span> on the local host with no further configuration. </p> <p> - Running <span><strong class="command">rndc-confgen -a</strong></span> allows - BIND 9 and <span><strong class="command">rndc</strong></span> to be used as + Running <span class="command"><strong>rndc-confgen -a</strong></span> allows + BIND 9 and <span class="command"><strong>rndc</strong></span> to be used as drop-in - replacements for BIND 8 and <span><strong class="command">ndc</strong></span>, + replacements for BIND 8 and <span class="command"><strong>ndc</strong></span>, with no changes to the existing BIND 8 <code class="filename">named.conf</code> file. </p> <p> If a more elaborate configuration than that - generated by <span><strong class="command">rndc-confgen -a</strong></span> + generated by <span class="command"><strong>rndc-confgen -a</strong></span> is required, for example if rndc is to be used remotely, - you should run <span><strong class="command">rndc-confgen</strong></span> without + you should run <span class="command"><strong>rndc-confgen</strong></span> without the - <span><strong class="command">-a</strong></span> option and set up a + <span class="command"><strong>-a</strong></span> option and set up a <code class="filename">rndc.conf</code> and <code class="filename">named.conf</code> as directed. @@ -94,13 +93,13 @@ </p></dd> <dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt> <dd><p> - Used with the <span><strong class="command">-a</strong></span> option to specify + Used with the <span class="command"><strong>-a</strong></span> option to specify an alternate location for <code class="filename">rndc.key</code>. </p></dd> <dt><span class="term">-h</span></dt> <dd><p> Prints a short summary of the options and arguments to - <span><strong class="command">rndc-confgen</strong></span>. + <span class="command"><strong>rndc-confgen</strong></span>. </p></dd> <dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt> <dd><p> @@ -110,8 +109,8 @@ </p></dd> <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt> <dd><p> - Specifies the command channel port where <span><strong class="command">named</strong></span> - listens for connections from <span><strong class="command">rndc</strong></span>. + Specifies the command channel port where <span class="command"><strong>named</strong></span> + listens for connections from <span class="command"><strong>rndc</strong></span>. The default is 953. </p></dd> <dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt> @@ -129,60 +128,55 @@ </p></dd> <dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt> <dd><p> - Specifies the IP address where <span><strong class="command">named</strong></span> + Specifies the IP address where <span class="command"><strong>named</strong></span> listens for command channel connections from - <span><strong class="command">rndc</strong></span>. The default is the loopback + <span class="command"><strong>rndc</strong></span>. The default is the loopback address 127.0.0.1. </p></dd> <dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt> <dd><p> - Used with the <span><strong class="command">-a</strong></span> option to specify - a directory where <span><strong class="command">named</strong></span> will run + Used with the <span class="command"><strong>-a</strong></span> option to specify + a directory where <span class="command"><strong>named</strong></span> will run chrooted. An additional copy of the <code class="filename">rndc.key</code> will be written relative to this directory so that - it will be found by the chrooted <span><strong class="command">named</strong></span>. + it will be found by the chrooted <span class="command"><strong>named</strong></span>. </p></dd> <dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt> <dd><p> - Used with the <span><strong class="command">-a</strong></span> option to set the + Used with the <span class="command"><strong>-a</strong></span> option to set the owner of the <code class="filename">rndc.key</code> file generated. If - <span><strong class="command">-t</strong></span> is also specified only the file + <span class="command"><strong>-t</strong></span> is also specified only the file in the chroot area has its owner changed. </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543802"></a><h2>EXAMPLES</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>EXAMPLES</h2> <p> - To allow <span><strong class="command">rndc</strong></span> to be used with + To allow <span class="command"><strong>rndc</strong></span> to be used with no manual configuration, run </p> <p><strong class="userinput"><code>rndc-confgen -a</code></strong> </p> <p> To print a sample <code class="filename">rndc.conf</code> file and - corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span> + corresponding <span class="command"><strong>controls</strong></span> and <span class="command"><strong>key</strong></span> statements to be manually inserted into <code class="filename">named.conf</code>, run </p> <p><strong class="userinput"><code>rndc-confgen</code></strong> </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543844"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>, <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543882"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/dig/Makefile.in b/bin/dig/Makefile.in index 5bc4db0a32aa..f705312756a8 100644 --- a/bin/dig/Makefile.in +++ b/bin/dig/Makefile.in @@ -1,4 +1,4 @@ -# Copyright (C) 2004, 2005, 2007, 2009, 2012, 2013 Internet Systems Consortium, Inc. ("ISC") +# Copyright (C) 2004, 2005, 2007, 2009, 2012, 2013, 2015 Internet Systems Consortium, Inc. ("ISC") # Copyright (C) 2000-2002 Internet Software Consortium. # # Permission to use, copy, modify, and/or distribute this software for any @@ -19,7 +19,7 @@ srcdir = @srcdir@ VPATH = @srcdir@ top_srcdir = @top_srcdir@ -@BIND9_VERSION@ +VERSION=@BIND9_VERSION@ @BIND9_MAKE_INCLUDES@ diff --git a/bin/dig/dig.1 b/bin/dig/dig.1 index f78d556bfbd7..380dba101299 100644 --- a/bin/dig/dig.1 +++ b/bin/dig/dig.1 @@ -13,145 +13,164 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: February 12, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2014-02-12 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DIG" "1" "February 12, 2014" "BIND9" "BIND9" +.TH "DIG" "1" "2014\-02\-12" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" dig \- DNS lookup utility .SH "SYNOPSIS" -.HP 4 +.HP \w'\fBdig\fR\ 'u \fBdig\fR [@server] [\fB\-b\ \fR\fB\fIaddress\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-f\ \fR\fB\fIfilename\fR\fR] [\fB\-k\ \fR\fB\fIfilename\fR\fR] [\fB\-m\fR] [\fB\-p\ \fR\fB\fIport#\fR\fR] [\fB\-q\ \fR\fB\fIname\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\fR] [\fB\-x\ \fR\fB\fIaddr\fR\fR] [\fB\-y\ \fR\fB\fI[hmac:]\fR\fIname:key\fR\fR] [\fB\-4\fR] [\fB\-6\fR] [name] [type] [class] [queryopt...] -.HP 4 +.HP \w'\fBdig\fR\ 'u \fBdig\fR [\fB\-h\fR] -.HP 4 +.HP \w'\fBdig\fR\ 'u \fBdig\fR [global\-queryopt...] [query...] .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 "#<port>" +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 "#<port>" .RE .PP \-c \fIclass\fR .RS 4 -Set the query class. The default +Set the query class\&. The default \fIclass\fR -is IN; other classes are HS for Hesiod records or CH for Chaosnet records. +is IN; other classes are HS for Hesiod records or CH for Chaosnet records\&. .RE .PP \-f \fIfile\fR @@ -159,88 +178,88 @@ is IN; other classes are HS for Hesiod records or CH for Chaosnet records. Batch mode: \fBdig\fR reads a list of lookup requests to process from the given -\fIfile\fR. Each line in the file should be organized in the same way they would be presented as queries to +\fIfile\fR\&. Each line in the file should be organized in the same way they would be presented as queries to \fBdig\fR -using the command\-line interface. +using the command\-line interface\&. .RE .PP \-i .RS 4 -Do reverse IPv6 lookups using the obsolete RFC1886 IP6.INT domain, which is no longer in use. Obsolete bit string label queries (RFC2874) are not attempted. +Do reverse IPv6 lookups using the obsolete RFC1886 IP6\&.INT domain, which is no longer in use\&. Obsolete bit string label queries (RFC2874) are not attempted\&. .RE .PP \-k \fIkeyfile\fR .RS 4 -Sign queries using TSIG using a key read from the given file. Key files can be generated using -\fBtsig\-keygen\fR(8). When using TSIG authentication with -\fBdig\fR, the name server that is queried needs to know the key and algorithm that is being used. In BIND, this is done by providing appropriate +Sign queries using TSIG using a key read from the given file\&. Key files can be generated using +\fBtsig-keygen\fR(8)\&. When using TSIG authentication with +\fBdig\fR, the name server that is queried needs to know the key and algorithm that is being used\&. In BIND, this is done by providing appropriate \fBkey\fR and \fBserver\fR statements in -\fInamed.conf\fR. +named\&.conf\&. .RE .PP \-m .RS 4 -Enable memory usage debugging. +Enable memory usage debugging\&. .RE .PP \-p \fIport\fR .RS 4 -Send the query to a non\-standard port on the server, instead of the defaut port 53. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number. +Send the query to a non\-standard port on the server, instead of the defaut port 53\&. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number\&. .RE .PP \-q \fIname\fR .RS 4 -The domain name to query. This is useful to distinguish the +The domain name to query\&. This is useful to distinguish the \fIname\fR -from other arguments. +from other arguments\&. .RE .PP \-t \fItype\fR .RS 4 -The resource record type to query. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the +The resource record type to query\&. It can be any valid query type which is supported in BIND 9\&. The default query type is "A", unless the \fB\-x\fR -option is supplied to indicate a reverse lookup. A zone transfer can be requested by specifying a type of AXFR. When an incremental zone transfer (IXFR) is required, set the +option is supplied to indicate a reverse lookup\&. A zone transfer can be requested by specifying a type of AXFR\&. When an incremental zone transfer (IXFR) is required, set the \fItype\fR to -ixfr=N. The incremental zone transfer will contain the changes made to the zone since the serial number in the zone's SOA record was -\fIN\fR. +ixfr=N\&. The incremental zone transfer will contain the changes made to the zone since the serial number in the zone\*(Aqs SOA record was +\fIN\fR\&. .RE .PP \-v .RS 4 -Print the version number and exit. +Print the version number and exit\&. .RE .PP \-x \fIaddr\fR .RS 4 -Simplified reverse lookups, for mapping addresses to names. The +Simplified reverse lookups, for mapping addresses to names\&. The \fIaddr\fR -is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address. When the +is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address\&. When the \fB\-x\fR is used, there is no need to provide the \fIname\fR, \fIclass\fR and \fItype\fR -arguments. +arguments\&. \fBdig\fR automatically performs a lookup for a name like -94.2.0.192.in\-addr.arpa -and sets the query type and class to PTR and IN respectively. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain (but see also the +94\&.2\&.0\&.192\&.in\-addr\&.arpa +and sets the query type and class to PTR and IN respectively\&. IPv6 addresses are looked up using nibble format under the IP6\&.ARPA domain (but see also the \fB\-i\fR -option). +option)\&. .RE .PP \-y \fI[hmac:]\fR\fIkeyname:secret\fR .RS 4 -Sign queries using TSIG with the given authentication key. +Sign queries using TSIG with the given authentication key\&. \fIkeyname\fR is the name of the key, and \fIsecret\fR -is the base64 encoded shared secret. +is the base64 encoded shared secret\&. \fIhmac\fR is the name of the key algorithm; valid choices are hmac\-md5, @@ -248,10 +267,10 @@ hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384, or -hmac\-sha512. If +hmac\-sha512\&. If \fIhmac\fR is not specified, the default is -hmac\-md5. +hmac\-md5\&. .sp NOTE: You should use the \fB\-k\fR @@ -259,91 +278,91 @@ option and avoid the \fB\-y\fR option, because with \fB\-y\fR -the shared secret is supplied as a command line argument in clear text. This may be visible in the output from +the shared secret is supplied as a command line argument in clear text\&. This may be visible in the output from \fBps\fR(1) -or in a history file maintained by the user's shell. +or in a history file maintained by the user\*(Aqs shell\&. .RE .SH "QUERY OPTIONS" .PP \fBdig\fR -provides a number of query options which affect the way in which lookups are made and the results displayed. Some of these set or reset flag bits in the query header, some determine which sections of the answer get printed, and others determine the timeout and retry strategies. +provides a number of query options which affect the way in which lookups are made and the results displayed\&. Some of these set or reset flag bits in the query header, some determine which sections of the answer get printed, and others determine the timeout and retry strategies\&. .PP -Each query option is identified by a keyword preceded by a plus sign (+). Some keywords set or reset an option. These may be preceded by the string +Each query option is identified by a keyword preceded by a plus sign (+)\&. Some keywords set or reset an option\&. These may be preceded by the string no -to negate the meaning of that keyword. Other keywords assign values to options like the timeout interval. They have the form -\fB+keyword=value\fR. Keywords may be abbreviated, provided the abbreviation is unambiguous; for example, +to negate the meaning of that keyword\&. Other keywords assign values to options like the timeout interval\&. They have the form +\fB+keyword=value\fR\&. Keywords may be abbreviated, provided the abbreviation is unambiguous; for example, +cd is equivalent to -+cdflag. The query options are: ++cdflag\&. The query options are: .PP \fB+[no]aaflag\fR .RS 4 A synonym for -\fI+[no]aaonly\fR. +\fI+[no]aaonly\fR\&. .RE .PP \fB+[no]aaonly\fR .RS 4 -Sets the "aa" flag in the query. +Sets the "aa" flag in the query\&. .RE .PP \fB+[no]additional\fR .RS 4 -Display [do not display] the additional section of a reply. The default is to display it. +Display [do not display] the additional section of a reply\&. The default is to display it\&. .RE .PP \fB+[no]adflag\fR .RS 4 -Set [do not set] the AD (authentic data) bit in the query. This requests the server to return whether all of the answer and authority sections have all been validated as secure according to the security policy of the server. AD=1 indicates that all records have been validated as secure and the answer is not from a OPT\-OUT range. AD=0 indicate that some part of the answer was insecure or not validated. This bit is set by default. +Set [do not set] the AD (authentic data) bit in the query\&. This requests the server to return whether all of the answer and authority sections have all been validated as secure according to the security policy of the server\&. AD=1 indicates that all records have been validated as secure and the answer is not from a OPT\-OUT range\&. AD=0 indicate that some part of the answer was insecure or not validated\&. This bit is set by default\&. .RE .PP \fB+[no]all\fR .RS 4 -Set or clear all display flags. +Set or clear all display flags\&. .RE .PP \fB+[no]answer\fR .RS 4 -Display [do not display] the answer section of a reply. The default is to display it. +Display [do not display] the answer section of a reply\&. The default is to display it\&. .RE .PP \fB+[no]authority\fR .RS 4 -Display [do not display] the authority section of a reply. The default is to display it. +Display [do not display] the authority section of a reply\&. The default is to display it\&. .RE .PP \fB+[no]besteffort\fR .RS 4 -Attempt to display the contents of messages which are malformed. The default is to not display malformed answers. +Attempt to display the contents of messages which are malformed\&. The default is to not display malformed answers\&. .RE .PP \fB+bufsize=B\fR .RS 4 Set the UDP message buffer size advertised using EDNS0 to \fIB\fR -bytes. The maximum and minimum sizes of this buffer are 65535 and 0 respectively. Values outside this range are rounded up or down appropriately. Values other than zero will cause a EDNS query to be sent. +bytes\&. The maximum and minimum sizes of this buffer are 65535 and 0 respectively\&. Values outside this range are rounded up or down appropriately\&. Values other than zero will cause a EDNS query to be sent\&. .RE .PP \fB+[no]cdflag\fR .RS 4 -Set [do not set] the CD (checking disabled) bit in the query. This requests the server to not perform DNSSEC validation of responses. +Set [do not set] the CD (checking disabled) bit in the query\&. This requests the server to not perform DNSSEC validation of responses\&. .RE .PP \fB+[no]class\fR .RS 4 -Display [do not display] the CLASS when printing the record. +Display [do not display] the CLASS when printing the record\&. .RE .PP \fB+[no]cmd\fR .RS 4 Toggles the printing of the initial comment in the output identifying the version of \fBdig\fR -and the query options that have been applied. This comment is printed by default. +and the query options that have been applied\&. This comment is printed by default\&. .RE .PP \fB+[no]comments\fR .RS 4 -Toggle the display of comment lines in the output. The default is to print comments. +Toggle the display of comment lines in the output\&. The default is to print comments\&. .RE .PP \fB+[no]defname\fR @@ -354,7 +373,7 @@ Deprecated, treated as a synonym for .PP \fB+[no]dnssec\fR .RS 4 -Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query. +Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query\&. .RE .PP \fB+domain=somename\fR @@ -363,46 +382,46 @@ Set the search list to contain the single domain \fIsomename\fR, as if specified in a \fBdomain\fR directive in -\fI/etc/resolv.conf\fR, and enable search list processing as if the +/etc/resolv\&.conf, and enable search list processing as if the \fI+search\fR -option were given. +option were given\&. .RE .PP \fB+[no]edns[=#]\fR .RS 4 -Specify the EDNS version to query with. Valid values are 0 to 255. Setting the EDNS version will cause a EDNS query to be sent. +Specify the EDNS version to query with\&. Valid values are 0 to 255\&. Setting the EDNS version will cause a EDNS query to be sent\&. \fB+noedns\fR -clears the remembered EDNS version. EDNS is set to 0 by default. +clears the remembered EDNS version\&. EDNS is set to 0 by default\&. .RE .PP \fB+[no]fail\fR .RS 4 -Do not try the next server if you receive a SERVFAIL. The default is to not try the next server which is the reverse of normal stub resolver behavior. +Do not try the next server if you receive a SERVFAIL\&. The default is to not try the next server which is the reverse of normal stub resolver behavior\&. .RE .PP \fB+[no]identify\fR .RS 4 Show [or do not show] the IP address and port number that supplied the answer when the \fI+short\fR -option is enabled. If short form answers are requested, the default is not to show the source address and port number of the server that provided the answer. +option is enabled\&. If short form answers are requested, the default is not to show the source address and port number of the server that provided the answer\&. .RE .PP \fB+[no]ignore\fR .RS 4 -Ignore truncation in UDP responses instead of retrying with TCP. By default, TCP retries are performed. +Ignore truncation in UDP responses instead of retrying with TCP\&. By default, TCP retries are performed\&. .RE .PP \fB+[no]keepopen\fR .RS 4 -Keep the TCP socket open between queries and reuse it rather than creating a new TCP socket for each lookup. The default is -\fB+nokeepopen\fR. +Keep the TCP socket open between queries and reuse it rather than creating a new TCP socket for each lookup\&. The default is +\fB+nokeepopen\fR\&. .RE .PP \fB+[no]multiline\fR .RS 4 -Print records like the SOA records in a verbose multi\-line format with human\-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the +Print records like the SOA records in a verbose multi\-line format with human\-readable comments\&. The default is to print each record on a single line, to facilitate machine parsing of the \fBdig\fR -output. +output\&. .RE .PP \fB+ndots=D\fR @@ -411,101 +430,101 @@ Set the number of dots that have to appear in \fIname\fR to \fID\fR -for it to be considered absolute. The default value is that defined using the ndots statement in -\fI/etc/resolv.conf\fR, or 1 if no ndots statement is present. Names with fewer dots are interpreted as relative names and will be searched for in the domains listed in the +for it to be considered absolute\&. The default value is that defined using the ndots statement in +/etc/resolv\&.conf, or 1 if no ndots statement is present\&. Names with fewer dots are interpreted as relative names and will be searched for in the domains listed in the \fBsearch\fR or \fBdomain\fR directive in -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf if \fB+search\fR -is set. +is set\&. .RE .PP \fB+[no]nsid\fR .RS 4 -Include an EDNS name server ID request when sending a query. +Include an EDNS name server ID request when sending a query\&. .RE .PP \fB+[no]nssearch\fR .RS 4 When this option is set, \fBdig\fR -attempts to find the authoritative name servers for the zone containing the name being looked up and display the SOA record that each name server has for the zone. +attempts to find the authoritative name servers for the zone containing the name being looked up and display the SOA record that each name server has for the zone\&. .RE .PP \fB+[no]onesoa\fR .RS 4 -Print only one (starting) SOA record when performing an AXFR. The default is to print both the starting and ending SOA records. +Print only one (starting) SOA record when performing an AXFR\&. The default is to print both the starting and ending SOA records\&. .RE .PP \fB+[no]qr\fR .RS 4 -Print [do not print] the query as it is sent. By default, the query is not printed. +Print [do not print] the query as it is sent\&. By default, the query is not printed\&. .RE .PP \fB+[no]question\fR .RS 4 -Print [do not print] the question section of a query when an answer is returned. The default is to print the question section as a comment. +Print [do not print] the question section of a query when an answer is returned\&. The default is to print the question section as a comment\&. .RE .PP \fB+[no]rdflag\fR .RS 4 A synonym for -\fI+[no]recurse\fR. +\fI+[no]recurse\fR\&. .RE .PP \fB+[no]recurse\fR .RS 4 -Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means +Toggle the setting of the RD (recursion desired) bit in the query\&. This bit is set by default, which means \fBdig\fR -normally sends recursive queries. Recursion is automatically disabled when the +normally sends recursive queries\&. Recursion is automatically disabled when the \fI+nssearch\fR or \fI+trace\fR -query options are used. +query options are used\&. .RE .PP \fB+retry=T\fR .RS 4 Sets the number of times to retry UDP queries to server to \fIT\fR -instead of the default, 2. Unlike -\fI+tries\fR, this does not include the initial query. +instead of the default, 2\&. Unlike +\fI+tries\fR, this does not include the initial query\&. .RE .PP \fB+[no]rrcomments\fR .RS 4 -Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records). The default is not to print record comments unless multiline mode is active. +Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records)\&. The default is not to print record comments unless multiline mode is active\&. .RE .PP \fB+[no]search\fR .RS 4 Use [do not use] the search list defined by the searchlist or domain directive in -\fIresolv.conf\fR -(if any). The search list is not used by default. +resolv\&.conf +(if any)\&. The search list is not used by default\&. .sp -\'ndots' from -\fIresolv.conf\fR +\*(Aqndots\*(Aq from +resolv\&.conf (default 1) which may be overridden by \fI+ndots\fR -determines if the name will be treated as relative or not and hence whether a search is eventually performed or not. +determines if the name will be treated as relative or not and hence whether a search is eventually performed or not\&. .RE .PP \fB+[no]short\fR .RS 4 -Provide a terse answer. The default is to print the answer in a verbose form. +Provide a terse answer\&. The default is to print the answer in a verbose form\&. .RE .PP \fB+[no]showsearch\fR .RS 4 -Perform [do not perform] a search showing intermediate results. +Perform [do not perform] a search showing intermediate results\&. .RE .PP \fB+[no]sigchase\fR .RS 4 -Chase DNSSEC signature chains. Requires dig be compiled with \-DDIG_SIGCHASE. +Chase DNSSEC signature chains\&. Requires dig be compiled with \-DDIG_SIGCHASE\&. .RE .PP \fB+split=W\fR @@ -514,86 +533,86 @@ Split long hex\- or base64\-formatted fields in resource records into chunks of \fIW\fR characters (where \fIW\fR -is rounded up to the nearest multiple of 4). +is rounded up to the nearest multiple of 4)\&. \fI+nosplit\fR or \fI+split=0\fR -causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active. +causes fields not to be split at all\&. The default is 56 characters, or 44 characters when multiline mode is active\&. .RE .PP \fB+[no]stats\fR .RS 4 -This query option toggles the printing of statistics: when the query was made, the size of the reply and so on. The default behavior is to print the query statistics. +This query option toggles the printing of statistics: when the query was made, the size of the reply and so on\&. The default behavior is to print the query statistics\&. .RE .PP \fB+[no]tcp\fR .RS 4 -Use [do not use] TCP when querying name servers. The default behavior is to use UDP unless an +Use [do not use] TCP when querying name servers\&. The default behavior is to use UDP unless an ixfr=N -query is requested, in which case the default is TCP. AXFR queries always use TCP. +query is requested, in which case the default is TCP\&. AXFR queries always use TCP\&. .RE .PP \fB+time=T\fR .RS 4 Sets the timeout for a query to \fIT\fR -seconds. The default timeout is 5 seconds. An attempt to set +seconds\&. The default timeout is 5 seconds\&. An attempt to set \fIT\fR -to less than 1 will result in a query timeout of 1 second being applied. +to less than 1 will result in a query timeout of 1 second being applied\&. .RE .PP \fB+[no]topdown\fR .RS 4 -When chasing DNSSEC signature chains perform a top\-down validation. Requires dig be compiled with \-DDIG_SIGCHASE. +When chasing DNSSEC signature chains perform a top\-down validation\&. Requires dig be compiled with \-DDIG_SIGCHASE\&. .RE .PP \fB+[no]trace\fR .RS 4 -Toggle tracing of the delegation path from the root name servers for the name being looked up. Tracing is disabled by default. When tracing is enabled, +Toggle tracing of the delegation path from the root name servers for the name being looked up\&. Tracing is disabled by default\&. When tracing is enabled, \fBdig\fR -makes iterative queries to resolve the name being looked up. It will follow referrals from the root servers, showing the answer from each server that was used to resolve the lookup. +makes iterative queries to resolve the name being looked up\&. It will follow referrals from the root servers, showing the answer from each server that was used to resolve the lookup\&. .sp -If @server is also specified, it affects only the initial query for the root zone name servers. +If @server is also specified, it affects only the initial query for the root zone name servers\&. .sp \fB+dnssec\fR -is also set when +trace is set to better emulate the default queries from a nameserver. +is also set when +trace is set to better emulate the default queries from a nameserver\&. .RE .PP \fB+tries=T\fR .RS 4 Sets the number of times to try UDP queries to server to \fIT\fR -instead of the default, 3. If +instead of the default, 3\&. If \fIT\fR -is less than or equal to zero, the number of tries is silently rounded up to 1. +is less than or equal to zero, the number of tries is silently rounded up to 1\&. .RE .PP \fB+trusted\-key=####\fR .RS 4 Specifies a file containing trusted keys to be used with -\fB+sigchase\fR. Each DNSKEY record must be on its own line. +\fB+sigchase\fR\&. Each DNSKEY record must be on its own line\&. .sp If not specified, \fBdig\fR will look for -\fI/etc/trusted\-key.key\fR +/etc/trusted\-key\&.key then -\fItrusted\-key.key\fR -in the current directory. +trusted\-key\&.key +in the current directory\&. .sp -Requires dig be compiled with \-DDIG_SIGCHASE. +Requires dig be compiled with \-DDIG_SIGCHASE\&. .RE .PP \fB+[no]ttlid\fR .RS 4 -Display [do not display] the TTL when printing the record. +Display [do not display] the TTL when printing the record\&. .RE .PP \fB+[no]vc\fR .RS 4 -Use [do not use] TCP when querying name servers. This alternate syntax to +Use [do not use] TCP when querying name servers\&. This alternate syntax to \fI+[no]tcp\fR -is provided for backwards compatibility. The "vc" stands for "virtual circuit". +is provided for backwards compatibility\&. The "vc" stands for "virtual circuit"\&. .RE .SH "MULTIPLE QUERIES" .PP @@ -601,63 +620,71 @@ The BIND 9 implementation of \fBdig \fR supports specifying multiple queries on the command line (in addition to supporting the \fB\-f\fR -batch file option). Each of those queries can be supplied with its own set of flags, options and query options. +batch file option)\&. Each of those queries can be supplied with its own set of flags, options and query options\&. .PP In this case, each \fIquery\fR -argument represent an individual query in the command\-line syntax described above. Each consists of any of the standard options and flags, the name to be looked up, an optional query type and class and any query options that should be applied to that query. +argument represent an individual query in the command\-line syntax described above\&. Each consists of any of the standard options and flags, the name to be looked up, an optional query type and class and any query options that should be applied to that query\&. .PP -A global set of query options, which should be applied to all queries, can also be supplied. These global query options must precede the first tuple of name, class, type, options, flags, and query options supplied on the command line. Any global query options (except the +A global set of query options, which should be applied to all queries, can also be supplied\&. These global query options must precede the first tuple of name, class, type, options, flags, and query options supplied on the command line\&. Any global query options (except the \fB+[no]cmd\fR -option) can be overridden by a query\-specific set of query options. For example: +option) can be overridden by a query\-specific set of query options\&. For example: .sp +.if n \{\ .RS 4 +.\} .nf -dig +qr www.isc.org any \-x 127.0.0.1 isc.org ns +noqr +dig +qr www\&.isc\&.org any \-x 127\&.0\&.0\&.1 isc\&.org ns +noqr .fi +.if n \{\ .RE +.\} .sp shows how \fBdig\fR could be used from the command line to make three lookups: an ANY query for -www.isc.org, a reverse lookup of 127.0.0.1 and a query for the NS records of -isc.org. A global query option of +www\&.isc\&.org, a reverse lookup of 127\&.0\&.0\&.1 and a query for the NS records of +isc\&.org\&. A global query option of \fI+qr\fR is applied, so that \fBdig\fR -shows the initial query it made for each lookup. The final query has a local query option of +shows the initial query it made for each lookup\&. The final query has a local query option of \fI+noqr\fR which means that \fBdig\fR will not print the initial query when it looks up the NS records for -isc.org. +isc\&.org\&. .SH "IDN SUPPORT" .PP If \fBdig\fR -has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names. +has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names\&. \fBdig\fR -appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the +appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server\&. If you\*(Aqd like to turn off the IDN support for some reason, defines the \fBIDN_DISABLE\fR -environment variable. The IDN support is disabled if the variable is set when +environment variable\&. The IDN support is disabled if the variable is set when \fBdig\fR -runs. +runs\&. .SH "FILES" .PP -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf .PP -\fI${HOME}/.digrc\fR +${HOME}/\&.digrc .SH "SEE ALSO" .PP \fBhost\fR(1), \fBnamed\fR(8), -\fBdnssec\-keygen\fR(8), -RFC1035. +\fBdnssec-keygen\fR(8), +RFC1035\&. .SH "BUGS" .PP -There are probably too many query options. +There are probably too many query options\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2011, 2013\-2015 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2003 Internet Software Consortium. +Copyright \(co 2004-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2003 Internet Software Consortium. .br diff --git a/bin/dig/dig.c b/bin/dig/dig.c index 145e6107ad33..d5f872dd3864 100644 --- a/bin/dig/dig.c +++ b/bin/dig/dig.c @@ -67,9 +67,12 @@ static char domainopt[DNS_NAME_MAXTEXT]; static isc_boolean_t short_form = ISC_FALSE, printcmd = ISC_TRUE, ip6_int = ISC_FALSE, plusquest = ISC_FALSE, pluscomm = ISC_FALSE, multiline = ISC_FALSE, nottl = ISC_FALSE, noclass = ISC_FALSE, - onesoa = ISC_FALSE, rrcomments = ISC_FALSE; + onesoa = ISC_FALSE; static isc_uint32_t splitwidth = 0xffffffff; +/*% rrcomments are neither explicitly enabled nor disabled by default */ +static int rrcomments = 0; + /*% opcode text */ static const char * const opcodetext[] = { "QUERY", @@ -319,7 +322,8 @@ say_message(dns_rdata_t *rdata, dig_query_t *query, isc_buffer_t *buf) { ADD_STRING(buf, " "); } - if (rrcomments) + /* Turn on rrcomments if explicitly enabled */ + if (rrcomments > 0) styleflags |= DNS_STYLEFLAG_RRCOMMENT; result = dns_rdata_tofmttext(rdata, NULL, styleflags, 0, splitwidth, " ", buf); @@ -404,7 +408,8 @@ printrdataset(dns_name_t *owner_name, dns_rdataset_t *rdataset, styleflags |= DNS_STYLEFLAG_NO_TTL; if (noclass) styleflags |= DNS_STYLEFLAG_NO_CLASS; - if (rrcomments) + /* Turn on rrcomments if explicitly enabled */ + if (rrcomments > 0) styleflags |= DNS_STYLEFLAG_RRCOMMENT; if (multiline) { styleflags |= DNS_STYLEFLAG_OMIT_OWNER; @@ -414,7 +419,9 @@ printrdataset(dns_name_t *owner_name, dns_rdataset_t *rdataset, styleflags |= DNS_STYLEFLAG_TTL; styleflags |= DNS_STYLEFLAG_MULTILINE; styleflags |= DNS_STYLEFLAG_COMMENT; - styleflags |= DNS_STYLEFLAG_RRCOMMENT; + /* Turn on rrcomments if not explicitly disabled */ + if (rrcomments >= 0) + styleflags |= DNS_STYLEFLAG_RRCOMMENT; } if (multiline || (nottl && noclass)) @@ -455,7 +462,8 @@ printmessage(dig_query_t *query, dns_message_t *msg, isc_boolean_t headers) { styleflags |= DNS_STYLEFLAG_REL_OWNER; if (query->lookup->comments) styleflags |= DNS_STYLEFLAG_COMMENT; - if (rrcomments) + /* Turn on rrcomments if explicitly enabled */ + if (rrcomments > 0) styleflags |= DNS_STYLEFLAG_RRCOMMENT; if (nottl) styleflags |= DNS_STYLEFLAG_NO_TTL; @@ -468,7 +476,9 @@ printmessage(dig_query_t *query, dns_message_t *msg, isc_boolean_t headers) { styleflags |= DNS_STYLEFLAG_OMIT_TTL; styleflags |= DNS_STYLEFLAG_TTL; styleflags |= DNS_STYLEFLAG_MULTILINE; - styleflags |= DNS_STYLEFLAG_RRCOMMENT; + /* Turn on rrcomments unless explicitly disabled */ + if (rrcomments >= 0) + styleflags |= DNS_STYLEFLAG_RRCOMMENT; } if (multiline || (nottl && noclass)) result = dns_master_stylecreate2(&style, styleflags, @@ -720,7 +730,7 @@ printgreeting(int argc, char **argv, dig_lookup_t *lookup) { */ static void -plus_option(char *option, isc_boolean_t is_batchfile, +plus_option(const char *option, isc_boolean_t is_batchfile, dig_lookup_t *lookup) { isc_result_t result; @@ -735,7 +745,7 @@ plus_option(char *option, isc_boolean_t is_batchfile, strncpy(option_store, option, sizeof(option_store)); option_store[sizeof(option_store)-1]=0; ptr = option_store; - cmd = next_token(&ptr,"="); + cmd = next_token(&ptr, "="); if (cmd == NULL) { printf(";; Invalid option %s\n", option_store); return; @@ -789,7 +799,6 @@ plus_option(char *option, isc_boolean_t is_batchfile, lookup->section_answer = state; lookup->section_additional = state; lookup->comments = state; - rrcomments = state; lookup->stats = state; printcmd = state; break; @@ -955,13 +964,13 @@ plus_option(char *option, isc_boolean_t is_batchfile, lookup->identify = ISC_TRUE; lookup->stats = ISC_FALSE; lookup->comments = ISC_FALSE; - rrcomments = ISC_FALSE; lookup->section_additional = ISC_FALSE; lookup->section_authority = ISC_FALSE; lookup->section_question = ISC_FALSE; lookup->rdtype = dns_rdatatype_ns; lookup->rdtypeset = ISC_TRUE; short_form = ISC_TRUE; + rrcomments = 0; } break; default: @@ -1022,7 +1031,7 @@ plus_option(char *option, isc_boolean_t is_batchfile, break; case 'r': /* rrcomments */ FULLCHECK("rrcomments"); - rrcomments = state; + rrcomments = state ? 1 : -1; break; default: goto invalid_option; @@ -1050,8 +1059,8 @@ plus_option(char *option, isc_boolean_t is_batchfile, lookup->section_authority = ISC_FALSE; lookup->section_question = ISC_FALSE; lookup->comments = ISC_FALSE; - rrcomments = ISC_FALSE; lookup->stats = ISC_FALSE; + rrcomments = -1; } break; case 'w': /* showsearch */ @@ -1149,7 +1158,7 @@ plus_option(char *option, isc_boolean_t is_batchfile, lookup->recurse = ISC_FALSE; lookup->identify = ISC_TRUE; lookup->comments = ISC_FALSE; - rrcomments = ISC_FALSE; + rrcomments = 0; lookup->stats = ISC_FALSE; lookup->section_additional = ISC_FALSE; lookup->section_authority = ISC_TRUE; @@ -1207,7 +1216,7 @@ plus_option(char *option, isc_boolean_t is_batchfile, invalid_option: need_value: fprintf(stderr, "Invalid option: +%s\n", - option); + option); usage(); } return; @@ -1434,14 +1443,14 @@ dash_option(char *option, char *next, dig_lookup_t **lookup, value); return (value_from_next); case 'y': - ptr = next_token(&value,":"); /* hmac type or name */ + ptr = next_token(&value, ":"); /* hmac type or name */ if (ptr == NULL) { usage(); } ptr2 = next_token(&value, ":"); /* name or secret */ if (ptr2 == NULL) usage(); - ptr3 = next_token(&value,":"); /* secret or NULL */ + ptr3 = next_token(&value, ":"); /* secret or NULL */ if (ptr3 != NULL) { parse_hmac(ptr); ptr = ptr2; diff --git a/bin/dig/dig.docbook b/bin/dig/dig.docbook index 8a3022dfc893..8b7e3829b448 100644 --- a/bin/dig/dig.docbook +++ b/bin/dig/dig.docbook @@ -1,6 +1,3 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - Copyright (C) 2004-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2003 Internet Software Consortium. @@ -18,10 +15,15 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.dig"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dig"> + <info> + <date>2014-02-12</date> + </info> <refentryinfo> - <date>February 12, 2014</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -60,42 +62,42 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dig</command> - <arg choice="opt">@server</arg> - <arg><option>-b <replaceable class="parameter">address</replaceable></option></arg> - <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg> - <arg><option>-f <replaceable class="parameter">filename</replaceable></option></arg> - <arg><option>-k <replaceable class="parameter">filename</replaceable></option></arg> - <arg><option>-m</option></arg> - <arg><option>-p <replaceable class="parameter">port#</replaceable></option></arg> - <arg><option>-q <replaceable class="parameter">name</replaceable></option></arg> - <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg> - <arg><option>-v</option></arg> - <arg><option>-x <replaceable class="parameter">addr</replaceable></option></arg> - <arg><option>-y <replaceable class="parameter"><optional>hmac:</optional>name:key</replaceable></option></arg> - <arg><option>-4</option></arg> - <arg><option>-6</option></arg> - <arg choice="opt">name</arg> - <arg choice="opt">type</arg> - <arg choice="opt">class</arg> + <arg choice="opt" rep="norepeat">@server</arg> + <arg choice="opt" rep="norepeat"><option>-b <replaceable class="parameter">address</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">filename</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">filename</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-m</option></arg> + <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port#</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-q <replaceable class="parameter">name</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">type</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-v</option></arg> + <arg choice="opt" rep="norepeat"><option>-x <replaceable class="parameter">addr</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-y <replaceable class="parameter"><optional>hmac:</optional>name:key</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-4</option></arg> + <arg choice="opt" rep="norepeat"><option>-6</option></arg> + <arg choice="opt" rep="norepeat">name</arg> + <arg choice="opt" rep="norepeat">type</arg> + <arg choice="opt" rep="norepeat">class</arg> <arg choice="opt" rep="repeat">queryopt</arg> </cmdsynopsis> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dig</command> - <arg><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> </cmdsynopsis> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dig</command> <arg choice="opt" rep="repeat">global-queryopt</arg> <arg choice="opt" rep="repeat">query</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>dig</command> (domain information groper) is a flexible tool for interrogating DNS name servers. It performs DNS lookups and @@ -141,15 +143,15 @@ <para> The IN and CH class names overlap with the IN and CH top level domain names. Either use the <option>-t</option> and - <option>-c</option> options to specify the type and class, + <option>-c</option> options to specify the type and class, use the <option>-q</option> the specify the domain name, or use "IN." and "CH." when looking up these top level domains. </para> - </refsect1> + </refsection> + + <refsection><info><title>SIMPLE USAGE</title></info> - <refsect1> - <title>SIMPLE USAGE</title> <para> A typical invocation of <command>dig</command> looks like: @@ -198,7 +200,7 @@ <term><constant>type</constant></term> <listitem> <para> - indicates what type of query is required — + indicates what type of query is required — ANY, A, MX, SIG, etc. <parameter>type</parameter> can be any valid query type. If no @@ -212,10 +214,10 @@ </variablelist> </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -415,10 +417,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>QUERY OPTIONS</title></info> - <refsect1> - <title>QUERY OPTIONS</title> <para><command>dig</command> provides a number of query options which affect @@ -1006,10 +1008,10 @@ </variablelist> </para> - </refsect1> + </refsection> + + <refsection><info><title>MULTIPLE QUERIES</title></info> - <refsect1> - <title>MULTIPLE QUERIES</title> <para> The BIND 9 implementation of <command>dig </command> @@ -1055,10 +1057,10 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr <literal>isc.org</literal>. </para> - </refsect1> + </refsection> + + <refsection><info><title>IDN SUPPORT</title></info> - <refsect1> - <title>IDN SUPPORT</title> <para> If <command>dig</command> has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. @@ -1067,21 +1069,21 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr reply from the server. If you'd like to turn off the IDN support for some reason, defines the <envar>IDN_DISABLE</envar> environment variable. - The IDN support is disabled if the variable is set when + The IDN support is disabled if the variable is set when <command>dig</command> runs. </para> - </refsect1> + </refsection> + + <refsection><info><title>FILES</title></info> - <refsect1> - <title>FILES</title> <para><filename>/etc/resolv.conf</filename> </para> <para><filename>${HOME}/.digrc</filename> </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>host</refentrytitle><manvolnum>1</manvolnum> </citerefentry>, @@ -1093,16 +1095,12 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr </citerefentry>, <citetitle>RFC1035</citetitle>. </para> - </refsect1> + </refsection> + + <refsection><info><title>BUGS</title></info> - <refsect1> - <title>BUGS</title> <para> There are probably too many query options. </para> - </refsect1> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> + </refsection> +</refentry> diff --git a/bin/dig/dig.html b/bin/dig/dig.html index 6cb32c118946..6f92efcefb9f 100644 --- a/bin/dig/dig.html +++ b/bin/dig/dig.html @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>dig</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.dig"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -33,41 +32,41 @@ <div class="cmdsynopsis"><p><code class="command">dig</code> [<code class="option">-h</code>]</p></div> <div class="cmdsynopsis"><p><code class="command">dig</code> [global-queryopt...] [query...]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543547"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">dig</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>dig</strong></span> (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 <span><strong class="command">dig</strong></span> to + were queried. Most DNS administrators use <span class="command"><strong>dig</strong></span> to troubleshoot DNS problems because of its flexibility, ease of use and clarity of output. Other lookup tools tend to have less functionality - than <span><strong class="command">dig</strong></span>. + than <span class="command"><strong>dig</strong></span>. </p> <p> - Although <span><strong class="command">dig</strong></span> is normally used with + Although <span class="command"><strong>dig</strong></span> 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 <code class="option">-h</code> option is given. Unlike earlier versions, the BIND 9 implementation of - <span><strong class="command">dig</strong></span> allows multiple lookups to be issued + <span class="command"><strong>dig</strong></span> allows multiple lookups to be issued from the command line. </p> <p> Unless it is told to query a specific name server, - <span><strong class="command">dig</strong></span> will try each of the servers listed in + <span class="command"><strong>dig</strong></span> will try each of the servers listed in <code class="filename">/etc/resolv.conf</code>. If no usable server addresses - are found, <span><strong class="command">dig</strong></span> will send the query to the local + are found, <span class="command"><strong>dig</strong></span> will send the query to the local host. </p> <p> When no command line arguments or options are given, - <span><strong class="command">dig</strong></span> will perform an NS query for "." (the root). + <span class="command"><strong>dig</strong></span> will perform an NS query for "." (the root). </p> <p> - It is possible to set per-user defaults for <span><strong class="command">dig</strong></span> via + It is possible to set per-user defaults for <span class="command"><strong>dig</strong></span> via <code class="filename">${HOME}/.digrc</code>. This file is read and any options in it are applied before the command line arguments. @@ -75,22 +74,22 @@ <p> The IN and CH class names overlap with the IN and CH top level domain names. Either use the <code class="option">-t</code> and - <code class="option">-c</code> options to specify the type and class, + <code class="option">-c</code> options to specify the type and class, use the <code class="option">-q</code> the specify the domain name, or use "IN." and "CH." when looking up these top level domains. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543626"></a><h2>SIMPLE USAGE</h2> +<div class="refsection"> +<a name="id-1.8"></a><h2>SIMPLE USAGE</h2> <p> - A typical invocation of <span><strong class="command">dig</strong></span> looks like: + A typical invocation of <span class="command"><strong>dig</strong></span> looks like: </p> <pre class="programlisting"> dig @server name type </pre> <p> where: </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term"><code class="constant">server</code></span></dt> <dd> <p> @@ -98,19 +97,19 @@ can be an IPv4 address in dotted-decimal notation or an IPv6 address in colon-delimited notation. When the supplied <em class="parameter"><code>server</code></em> argument is a hostname, - <span><strong class="command">dig</strong></span> resolves that name before querying + <span class="command"><strong>dig</strong></span> resolves that name before querying that name server. </p> <p> If no <em class="parameter"><code>server</code></em> argument is - provided, <span><strong class="command">dig</strong></span> consults + provided, <span class="command"><strong>dig</strong></span> consults <code class="filename">/etc/resolv.conf</code>; if an address is found there, it queries the name server at that address. If either of the <code class="option">-4</code> or <code class="option">-6</code> options are in use, then only addresses for the corresponding transport will be tried. If no usable addresses are found, - <span><strong class="command">dig</strong></span> will send the query to the + <span class="command"><strong>dig</strong></span> will send the query to the local host. The reply from the name server that responds is displayed. </p> @@ -126,16 +125,16 @@ <em class="parameter"><code>type</code></em> can be any valid query type. If no <em class="parameter"><code>type</code></em> argument is supplied, - <span><strong class="command">dig</strong></span> will perform a lookup for an + <span class="command"><strong>dig</strong></span> will perform a lookup for an A record. </p></dd> </dl></div> <p> </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543730"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.9"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-4</span></dt> <dd><p> Use IPv4 only. @@ -159,12 +158,12 @@ </p></dd> <dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt> <dd><p> - Batch mode: <span><strong class="command">dig</strong></span> reads a list of lookup + Batch mode: <span class="command"><strong>dig</strong></span> reads a list of lookup requests to process from the given <em class="parameter"><code>file</code></em>. Each line in the file should be organized in the same way they would be presented as queries to - <span><strong class="command">dig</strong></span> using the command-line interface. + <span class="command"><strong>dig</strong></span> using the command-line interface. </p></dd> <dt><span class="term">-i</span></dt> <dd><p> @@ -177,11 +176,11 @@ Sign queries using TSIG using a key read from the given file. Key files can be generated using <span class="citerefentry"><span class="refentrytitle">tsig-keygen</span>(8)</span>. - When using TSIG authentication with <span><strong class="command">dig</strong></span>, + When using TSIG authentication with <span class="command"><strong>dig</strong></span>, 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 <span><strong class="command">key</strong></span> - and <span><strong class="command">server</strong></span> statements in + providing appropriate <span class="command"><strong>key</strong></span> + and <span class="command"><strong>server</strong></span> statements in <code class="filename">named.conf</code>. </p></dd> <dt><span class="term">-m</span></dt> @@ -228,7 +227,7 @@ need to provide the <em class="parameter"><code>name</code></em>, <em class="parameter"><code>class</code></em> and <em class="parameter"><code>type</code></em> - arguments. <span><strong class="command">dig</strong></span> automatically performs a + arguments. <span class="command"><strong>dig</strong></span> automatically performs a lookup for a name like <code class="literal">94.2.0.192.in-addr.arpa</code> and sets the query type and class to PTR and IN respectively. IPv6 @@ -261,9 +260,9 @@ </dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2544181"></a><h2>QUERY OPTIONS</h2> -<p><span><strong class="command">dig</strong></span> +<div class="refsection"> +<a name="id-1.10"></a><h2>QUERY OPTIONS</h2> +<p><span class="command"><strong>dig</strong></span> 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 @@ -284,7 +283,7 @@ The query options are: </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term"><code class="option">+[no]aaflag</code></span></dt> <dd><p> A synonym for <em class="parameter"><code>+[no]aaonly</code></em>. @@ -353,7 +352,7 @@ <dt><span class="term"><code class="option">+[no]cmd</code></span></dt> <dd><p> Toggles the printing of the initial comment in the - output identifying the version of <span><strong class="command">dig</strong></span> + output identifying the version of <span class="command"><strong>dig</strong></span> and the query options that have been applied. This comment is printed by default. </p></dd> @@ -377,7 +376,7 @@ <dd><p> Set the search list to contain the single domain <em class="parameter"><code>somename</code></em>, as if specified in - a <span><strong class="command">domain</strong></span> directive in + a <span class="command"><strong>domain</strong></span> directive in <code class="filename">/etc/resolv.conf</code>, and enable search list processing as if the <em class="parameter"><code>+search</code></em> option were given. @@ -421,7 +420,7 @@ 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 <span><strong class="command">dig</strong></span> + facilitate machine parsing of the <span class="command"><strong>dig</strong></span> output. </p></dd> <dt><span class="term"><code class="option">+ndots=D</code></span></dt> @@ -445,7 +444,7 @@ </p></dd> <dt><span class="term"><code class="option">+[no]nssearch</code></span></dt> <dd><p> - When this option is set, <span><strong class="command">dig</strong></span> + When this option is set, <span class="command"><strong>dig</strong></span> 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 @@ -476,7 +475,7 @@ <dd><p> Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means - <span><strong class="command">dig</strong></span> normally sends recursive + <span class="command"><strong>dig</strong></span> normally sends recursive queries. Recursion is automatically disabled when the <em class="parameter"><code>+nssearch</code></em> or <em class="parameter"><code>+trace</code></em> query options are used. @@ -573,7 +572,7 @@ 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, - <span><strong class="command">dig</strong></span> makes iterative queries to + <span class="command"><strong>dig</strong></span> 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. @@ -583,7 +582,7 @@ initial query for the root zone name servers. </p> <p> - <span><strong class="command">+dnssec</strong></span> is also set when +trace + <span class="command"><strong>+dnssec</strong></span> is also set when +trace is set to better emulate the default queries from a nameserver. </p> @@ -604,7 +603,7 @@ must be on its own line. </p> <p> - If not specified, <span><strong class="command">dig</strong></span> will look + If not specified, <span class="command"><strong>dig</strong></span> will look for <code class="filename">/etc/trusted-key.key</code> then <code class="filename">trusted-key.key</code> in the current directory. @@ -630,10 +629,10 @@ </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545576"></a><h2>MULTIPLE QUERIES</h2> +<div class="refsection"> +<a name="id-1.11"></a><h2>MULTIPLE QUERIES</h2> <p> - The BIND 9 implementation of <span><strong class="command">dig </strong></span> + The BIND 9 implementation of <span class="command"><strong>dig </strong></span> supports specifying multiple queries on the command line (in addition to supporting the <code class="option">-f</code> batch file option). Each of those @@ -660,7 +659,7 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr </pre> <p> - shows how <span><strong class="command">dig</strong></span> could be used from the + shows how <span class="command"><strong>dig</strong></span> could be used from the command line to make three lookups: an ANY query for <code class="literal">www.isc.org</code>, a reverse lookup of 127.0.0.1 and a query for the NS records of @@ -668,45 +667,45 @@ dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr A global query option of <em class="parameter"><code>+qr</code></em> is applied, so - that <span><strong class="command">dig</strong></span> shows the initial query it made + that <span class="command"><strong>dig</strong></span> shows the initial query it made for each lookup. The final query has a local query option of - <em class="parameter"><code>+noqr</code></em> which means that <span><strong class="command">dig</strong></span> + <em class="parameter"><code>+noqr</code></em> which means that <span class="command"><strong>dig</strong></span> will not print the initial query when it looks up the NS records for <code class="literal">isc.org</code>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545638"></a><h2>IDN SUPPORT</h2> +<div class="refsection"> +<a name="id-1.12"></a><h2>IDN SUPPORT</h2> <p> - If <span><strong class="command">dig</strong></span> has been built with IDN (internationalized + If <span class="command"><strong>dig</strong></span> has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. - <span><strong class="command">dig</strong></span> appropriately converts character encoding of + <span class="command"><strong>dig</strong></span> 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 <code class="envar">IDN_DISABLE</code> environment variable. - The IDN support is disabled if the variable is set when - <span><strong class="command">dig</strong></span> runs. + The IDN support is disabled if the variable is set when + <span class="command"><strong>dig</strong></span> runs. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545660"></a><h2>FILES</h2> +<div class="refsection"> +<a name="id-1.13"></a><h2>FILES</h2> <p><code class="filename">/etc/resolv.conf</code> </p> <p><code class="filename">${HOME}/.digrc</code> </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545677"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.14"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">host</span>(1)</span>, <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, <em class="citetitle">RFC1035</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545715"></a><h2>BUGS</h2> +<div class="refsection"> +<a name="id-1.15"></a><h2>BUGS</h2> <p> There are probably too many query options. </p> diff --git a/bin/dig/dighost.c b/bin/dig/dighost.c index 45dac2f5a112..36e7d4405f6f 100644 --- a/bin/dig/dighost.c +++ b/bin/dig/dighost.c @@ -456,7 +456,7 @@ append(const char *text, int len, char **p, char *end) { static isc_result_t reverse_octets(const char *in, char **p, char *end) { - char *dot = strchr(in, '.'); + const char *dot = strchr(in, '.'); int len; if (dot != NULL) { isc_result_t result; @@ -3400,6 +3400,8 @@ recv_done(isc_task_t *task, isc_event_t *event) { n = requeue_lookup(l, ISC_TRUE); n->tcp_mode = ISC_TRUE; n->origin = query->lookup->origin; + if (l->trace && l->trace_root) + n->rdtype = l->qrdtype; dns_message_destroy(&msg); isc_event_free(&event); clear_query(query); diff --git a/bin/dig/host.1 b/bin/dig/host.1 index 4ff5a7cc6177..f654d97763e3 100644 --- a/bin/dig/host.1 +++ b/bin/dig/host.1 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2004, 2005, 2007-2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2004, 2005, 2007-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" Copyright (C) 2000-2002 Internet Software Consortium. .\" .\" Permission to use, copy, modify, and/or distribute this software for any @@ -13,43 +13,58 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: January 20, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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" -.HP 5 +.HP \w'\fBhost\fR\ 'u \fBhost\fR [\fB\-aCdlnrsTwv\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-N\ \fR\fB\fIndots\fR\fR] [\fB\-R\ \fR\fB\fInumber\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-W\ \fR\fB\fIwait\fR\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [\fB\-4\fR] [\fB\-6\fR] [\fB\-v\fR] [\fB\-V\fR] {name} [server] .SH "DESCRIPTION" .PP \fBhost\fR -is a simple utility for performing DNS lookups. It is normally used to convert names to IP addresses and vice versa. When no arguments or options are given, +is a simple utility for performing DNS lookups\&. It is normally used to convert names to IP addresses and vice versa\&. When no arguments or options are given, \fBhost\fR -prints a short summary of its command line arguments and options. +prints a short summary of its command line arguments and options\&. .PP \fIname\fR -is the domain name that is to be looked up. It can also be a dotted\-decimal IPv4 address or a colon\-delimited IPv6 address, in which case +is the domain name that is to be looked up\&. It can also be a dotted\-decimal IPv4 address or a colon\-delimited IPv6 address, in which case \fBhost\fR -will by default perform a reverse lookup for that address. +will by default perform a reverse lookup for that address\&. \fIserver\fR is an optional argument which is either the name or IP address of the name server that \fBhost\fR should query instead of the server or servers listed in -\fI/etc/resolv.conf\fR. +/etc/resolv\&.conf\&. .PP The \fB\-a\fR @@ -57,7 +72,7 @@ The \fB\-v\fR option and asking \fBhost\fR -to make a query of type ANY. +to make a query of type ANY\&. .PP When the \fB\-C\fR @@ -65,12 +80,12 @@ option is used, \fBhost\fR will attempt to display the SOA records for zone \fIname\fR -from all the listed authoritative name servers for that zone. The list of name servers is defined by the NS records that are found for the zone. +from all the listed authoritative name servers for that zone\&. The list of name servers is defined by the NS records that are found for the zone\&. .PP The \fB\-c\fR option instructs to make a DNS query of class -\fIclass\fR. This can be used to lookup Hesiod or Chaosnet class resource records. The default class is IN (Internet). +\fIclass\fR\&. This can be used to lookup Hesiod or Chaosnet class resource records\&. The default class is IN (Internet)\&. .PP Verbose output is generated by \fBhost\fR @@ -78,114 +93,113 @@ when the \fB\-d\fR or \fB\-v\fR -option is used. The two options are equivalent. They have been provided for backwards compatibility. In previous versions, the +option is used\&. The two options are equivalent\&. They have been provided for backwards compatibility\&. In previous versions, the \fB\-d\fR option switched on debugging traces and \fB\-v\fR -enabled verbose output. +enabled verbose output\&. .PP List mode is selected by the \fB\-l\fR -option. This makes +option\&. This makes \fBhost\fR perform a zone transfer for zone -\fIname\fR. Transfer the zone printing out the NS, PTR and address records (A/AAAA). If combined with +\fIname\fR\&. Transfer the zone printing out the NS, PTR and address records (A/AAAA)\&. If combined with \fB\-a\fR -all records will be printed. +all records will be printed\&. .PP The \fB\-i\fR -option specifies that reverse lookups of IPv6 addresses should use the IP6.INT domain as defined in RFC1886. The default is to use IP6.ARPA. +option specifies that reverse lookups of IPv6 addresses should use the IP6\&.INT domain as defined in RFC1886\&. The default is to use IP6\&.ARPA\&. .PP The \fB\-N\fR option sets the number of dots that have to be in \fIname\fR -for it to be considered absolute. The default value is that defined using the ndots statement in -\fI/etc/resolv.conf\fR, or 1 if no ndots statement is present. Names with fewer dots are interpreted as relative names and will be searched for in the domains listed in the +for it to be considered absolute\&. The default value is that defined using the ndots statement in +/etc/resolv\&.conf, or 1 if no ndots statement is present\&. Names with fewer dots are interpreted as relative names and will be searched for in the domains listed in the \fBsearch\fR or \fBdomain\fR directive in -\fI/etc/resolv.conf\fR. +/etc/resolv\&.conf\&. .PP The number of UDP retries for a lookup can be changed with the \fB\-R\fR -option. +option\&. \fInumber\fR indicates how many times \fBhost\fR -will repeat a query that does not get answered. The default number of retries is 1. If +will repeat a query that does not get answered\&. The default number of retries is 1\&. If \fInumber\fR -is negative or zero, the number of retries will default to 1. +is negative or zero, the number of retries will default to 1\&. .PP Non\-recursive queries can be made via the \fB\-r\fR -option. Setting this option clears the +option\&. Setting this option clears the \fBRD\fR \(em recursion desired \(em bit in the query which \fBhost\fR -makes. This should mean that the name server receiving the query will not attempt to resolve -\fIname\fR. The +makes\&. This should mean that the name server receiving the query will not attempt to resolve +\fIname\fR\&. The \fB\-r\fR option enables \fBhost\fR -to mimic the behavior of a name server by making non\-recursive queries and expecting to receive answers to those queries that are usually referrals to other name servers. +to mimic the behavior of a name server by making non\-recursive queries and expecting to receive answers to those queries that are usually referrals to other name servers\&. .PP By default, \fBhost\fR -uses UDP when making queries. The +uses UDP when making queries\&. The \fB\-T\fR -option makes it use a TCP connection when querying the name server. TCP will be automatically selected for queries that require it, such as zone transfer (AXFR) requests. +option makes it use a TCP connection when querying the name server\&. TCP will be automatically selected for queries that require it, such as zone transfer (AXFR) requests\&. .PP The \fB\-4\fR option forces \fBhost\fR -to only use IPv4 query transport. The +to only use IPv4 query transport\&. The \fB\-6\fR option forces \fBhost\fR -to only use IPv6 query transport. +to only use IPv6 query transport\&. .PP The \fB\-t\fR -option is used to select the query type. +option is used to select the query type\&. \fItype\fR -can be any recognized query type: CNAME, NS, SOA, SIG, KEY, AXFR, etc. When no query type is specified, +can be any recognized query type: CNAME, NS, SOA, SIG, KEY, AXFR, etc\&. When no query type is specified, \fBhost\fR -automatically selects an appropriate query type. By default, it looks for A, AAAA, and MX records, but if the +automatically selects an appropriate query type\&. By default, it looks for A, AAAA, and MX records, but if the \fB\-C\fR option was given, queries will be made for SOA records, and if \fIname\fR is a dotted\-decimal IPv4 address or colon\-delimited IPv6 address, \fBhost\fR -will query for PTR records. If a query type of IXFR is chosen the starting serial number can be specified by appending an equal followed by the starting serial number (e.g. \-t IXFR=12345678). +will query for PTR records\&. If a query type of IXFR is chosen the starting serial number can be specified by appending an equal followed by the starting serial number (e\&.g\&. \-t IXFR=12345678)\&. .PP The time to wait for a reply can be controlled through the \fB\-W\fR and \fB\-w\fR -options. The +options\&. The \fB\-W\fR option makes \fBhost\fR wait for \fIwait\fR -seconds. If +seconds\&. If \fIwait\fR -is less than one, the wait interval is set to one second. When the +is less than one, the wait interval is set to one second\&. When the \fB\-w\fR option is used, \fBhost\fR -will effectively wait forever for a reply. The time to wait for a response will be set to the number of seconds given by the hardware's maximum value for an integer quantity. +will effectively wait forever for a reply\&. The time to wait for a response will be set to the number of seconds given by the hardware\*(Aqs maximum value for an integer quantity\&. .PP The \fB\-s\fR option tells -\fBhost\fR -\fInot\fR -to send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior. +\fBhost\fR\fInot\fR +to send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior\&. .PP The \fB\-m\fR @@ -193,33 +207,37 @@ can be used to set the memory usage debugging flags \fIrecord\fR, \fIusage\fR and -\fItrace\fR. +\fItrace\fR\&. .PP The \fB\-V\fR option causes \fBhost\fR -to print the version number and exit. +to print the version number and exit\&. .SH "IDN SUPPORT" .PP If \fBhost\fR -has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names. +has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names\&. \fBhost\fR -appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the +appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server\&. If you\*(Aqd like to turn off the IDN support for some reason, defines the \fBIDN_DISABLE\fR -environment variable. The IDN support is disabled if the variable is set when +environment variable\&. The IDN support is disabled if the variable is set when \fBhost\fR -runs. +runs\&. .SH "FILES" .PP -\fI/etc/resolv.conf\fR +/etc/resolv\&.conf .SH "SEE ALSO" .PP \fBdig\fR(1), -\fBnamed\fR(8). +\fBnamed\fR(8)\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004, 2005, 2007\-2009, 2014 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2002 Internet Software Consortium. +Copyright \(co 2004, 2005, 2007-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2002 Internet Software Consortium. .br diff --git a/bin/dig/host.docbook b/bin/dig/host.docbook index 30fc441044ef..b004fb10a868 100644 --- a/bin/dig/host.docbook +++ b/bin/dig/host.docbook @@ -1,8 +1,7 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> +<!DOCTYPE book [ +<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004, 2005, 2007-2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2002 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -18,10 +17,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.host"> - +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.host"> + <info> + <date>2009-01-20</date> + </info> <refentryinfo> - <date>January 20, 2009</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -43,6 +46,7 @@ <year>2008</year> <year>2009</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> <copyright> @@ -54,26 +58,26 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>host</command> - <arg><option>-aCdlnrsTwv</option></arg> - <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg> - <arg><option>-N <replaceable class="parameter">ndots</replaceable></option></arg> - <arg><option>-R <replaceable class="parameter">number</replaceable></option></arg> - <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg> - <arg><option>-W <replaceable class="parameter">wait</replaceable></option></arg> - <arg><option>-m <replaceable class="parameter">flag</replaceable></option></arg> - <arg><option>-4</option></arg> - <arg><option>-6</option></arg> - <arg><option>-v</option></arg> - <arg><option>-V</option></arg> - <arg choice="req">name</arg> - <arg choice="opt">server</arg> + <arg choice="opt" rep="norepeat"><option>-aCdlnrsTwv</option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-N <replaceable class="parameter">ndots</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-R <replaceable class="parameter">number</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">type</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-W <replaceable class="parameter">wait</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">flag</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-4</option></arg> + <arg choice="opt" rep="norepeat"><option>-6</option></arg> + <arg choice="opt" rep="norepeat"><option>-v</option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="req" rep="norepeat">name</arg> + <arg choice="opt" rep="norepeat">server</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>host</command> is a simple utility for performing DNS lookups. @@ -228,7 +232,7 @@ </para> <para> - The <option>-s</option> option tells <command>host</command> + The <option>-s</option> option tells <command>host</command> <emphasis>not</emphasis> 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. @@ -245,13 +249,13 @@ The <option>-V</option> option causes <command>host</command> to print the version number and exit. </para> - </refsect1> + </refsection> + + <refsection><info><title>IDN SUPPORT</title></info> - <refsect1> - <title>IDN SUPPORT</title> <para> If <command>host</command> has been built with IDN (internationalized - domain name) support, it can accept and display non-ASCII domain names. + domain name) support, it can accept and display non-ASCII domain names. <command>host</command> appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. @@ -260,16 +264,16 @@ The IDN support is disabled if the variable is set when <command>host</command> runs. </para> - </refsect1> + </refsection> + + <refsection><info><title>FILES</title></info> - <refsect1> - <title>FILES</title> <para><filename>/etc/resolv.conf</filename> </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>dig</refentrytitle><manvolnum>1</manvolnum> </citerefentry>, @@ -277,10 +281,6 @@ <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum> </citerefentry>. </para> + </refsection> - </refsect1> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/dig/host.html b/bin/dig/host.html index a04536afec56..fb8c08f67e4e 100644 --- a/bin/dig/host.html +++ b/bin/dig/host.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2004, 2005, 2007-2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2002 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>host</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.host"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -31,34 +30,34 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">host</code> [<code class="option">-aCdlnrsTwv</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-N <em class="replaceable"><code>ndots</code></em></code>] [<code class="option">-R <em class="replaceable"><code>number</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-W <em class="replaceable"><code>wait</code></em></code>] [<code class="option">-m <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-4</code>] [<code class="option">-6</code>] [<code class="option">-v</code>] [<code class="option">-V</code>] {name} [server]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543454"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">host</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>host</strong></span> 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, - <span><strong class="command">host</strong></span> + <span class="command"><strong>host</strong></span> prints a short summary of its command line arguments and options. </p> <p><em class="parameter"><code>name</code></em> 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 <span><strong class="command">host</strong></span> will by + IPv6 address, in which case <span class="command"><strong>host</strong></span> will by default perform a reverse lookup for that address. <em class="parameter"><code>server</code></em> is an optional argument which is either - the name or IP address of the name server that <span><strong class="command">host</strong></span> + the name or IP address of the name server that <span class="command"><strong>host</strong></span> should query instead of the server or servers listed in <code class="filename">/etc/resolv.conf</code>. </p> <p> The <code class="option">-a</code> (all) option is equivalent to setting the - <code class="option">-v</code> option and asking <span><strong class="command">host</strong></span> to make + <code class="option">-v</code> option and asking <span class="command"><strong>host</strong></span> to make a query of type ANY. </p> <p> - When the <code class="option">-C</code> option is used, <span><strong class="command">host</strong></span> + When the <code class="option">-C</code> option is used, <span class="command"><strong>host</strong></span> will attempt to display the SOA records for zone <em class="parameter"><code>name</code></em> from all the listed authoritative name @@ -72,7 +71,7 @@ Chaosnet class resource records. The default class is IN (Internet). </p> <p> - Verbose output is generated by <span><strong class="command">host</strong></span> when + Verbose output is generated by <span class="command"><strong>host</strong></span> when the <code class="option">-d</code> or <code class="option">-v</code> option is used. The two options are equivalent. They have been provided for backwards @@ -82,7 +81,7 @@ </p> <p> List mode is selected by the <code class="option">-l</code> option. This makes - <span><strong class="command">host</strong></span> perform a zone transfer for zone + <span class="command"><strong>host</strong></span> perform a zone transfer for zone <em class="parameter"><code>name</code></em>. Transfer the zone printing out the NS, PTR and address records (A/AAAA). If combined with <code class="option">-a</code> @@ -110,7 +109,7 @@ The number of UDP retries for a lookup can be changed with the <code class="option">-R</code> option. <em class="parameter"><code>number</code></em> indicates - how many times <span><strong class="command">host</strong></span> will repeat a query + how many times <span class="command"><strong>host</strong></span> will repeat a query that does not get answered. The default number of retries is 1. If <em class="parameter"><code>number</code></em> is negative or zero, the @@ -120,39 +119,39 @@ <p> Non-recursive queries can be made via the <code class="option">-r</code> option. Setting this option clears the <span class="type">RD</span> — recursion - desired — bit in the query which <span><strong class="command">host</strong></span> makes. + desired — bit in the query which <span class="command"><strong>host</strong></span> makes. This should mean that the name server receiving the query will not attempt to resolve <em class="parameter"><code>name</code></em>. The - <code class="option">-r</code> option enables <span><strong class="command">host</strong></span> + <code class="option">-r</code> option enables <span class="command"><strong>host</strong></span> 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. </p> <p> - By default, <span><strong class="command">host</strong></span> uses UDP when making + By default, <span class="command"><strong>host</strong></span> uses UDP when making queries. The <code class="option">-T</code> 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. </p> <p> - The <code class="option">-4</code> option forces <span><strong class="command">host</strong></span> to only + The <code class="option">-4</code> option forces <span class="command"><strong>host</strong></span> to only use IPv4 query transport. The <code class="option">-6</code> option forces - <span><strong class="command">host</strong></span> to only use IPv6 query transport. + <span class="command"><strong>host</strong></span> to only use IPv6 query transport. </p> <p> The <code class="option">-t</code> option is used to select the query type. <em class="parameter"><code>type</code></em> can be any recognized query type: CNAME, NS, SOA, SIG, KEY, AXFR, etc. When no query type is specified, - <span><strong class="command">host</strong></span> automatically selects an appropriate + <span class="command"><strong>host</strong></span> automatically selects an appropriate query type. By default, it looks for A, AAAA, and MX records, but if the <code class="option">-C</code> option was given, queries will be made for SOA records, and if <em class="parameter"><code>name</code></em> is a dotted-decimal IPv4 - address or colon-delimited IPv6 address, <span><strong class="command">host</strong></span> will + address or colon-delimited IPv6 address, <span class="command"><strong>host</strong></span> 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). @@ -160,18 +159,18 @@ <p> The time to wait for a reply can be controlled through the <code class="option">-W</code> and <code class="option">-w</code> options. The - <code class="option">-W</code> option makes <span><strong class="command">host</strong></span> + <code class="option">-W</code> option makes <span class="command"><strong>host</strong></span> wait for <em class="parameter"><code>wait</code></em> seconds. If <em class="parameter"><code>wait</code></em> is less than one, the wait interval is set to one second. When the - <code class="option">-w</code> option is used, <span><strong class="command">host</strong></span> + <code class="option">-w</code> option is used, <span class="command"><strong>host</strong></span> 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. </p> <p> - The <code class="option">-s</code> option tells <span><strong class="command">host</strong></span> + The <code class="option">-s</code> option tells <span class="command"><strong>host</strong></span> <span class="emphasis"><em>not</em></span> 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. @@ -183,31 +182,31 @@ <em class="parameter"><code>trace</code></em>. </p> <p> - The <code class="option">-V</code> option causes <span><strong class="command">host</strong></span> + The <code class="option">-V</code> option causes <span class="command"><strong>host</strong></span> to print the version number and exit. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543831"></a><h2>IDN SUPPORT</h2> +<div class="refsection"> +<a name="id-1.8"></a><h2>IDN SUPPORT</h2> <p> - If <span><strong class="command">host</strong></span> has been built with IDN (internationalized - domain name) support, it can accept and display non-ASCII domain names. - <span><strong class="command">host</strong></span> appropriately converts character encoding of + If <span class="command"><strong>host</strong></span> has been built with IDN (internationalized + domain name) support, it can accept and display non-ASCII domain names. + <span class="command"><strong>host</strong></span> 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 <code class="envar">IDN_DISABLE</code> environment variable. The IDN support is disabled if the variable is set when - <span><strong class="command">host</strong></span> runs. + <span class="command"><strong>host</strong></span> runs. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543853"></a><h2>FILES</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>FILES</h2> <p><code class="filename">/etc/resolv.conf</code> </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543865"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">dig</span>(1)</span>, <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>. </p> diff --git a/bin/dig/nslookup.1 b/bin/dig/nslookup.1 index e5ea2396a12d..c9c4c2f1b346 100644 --- a/bin/dig/nslookup.1 +++ b/bin/dig/nslookup.1 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2004-2007, 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2004-2007, 2010, 2013-2016 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -12,68 +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 +'\" t .\" Title: nslookup .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> -.\" Date: January 24, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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" -.HP 9 +.HP \w'\fBnslookup\fR\ 'u \fBnslookup\fR [\fB\-option\fR] [name\ |\ \-] [server] .SH "DESCRIPTION" .PP \fBNslookup\fR -is a program to query Internet domain name servers. +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. +.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) -.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. +.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. +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: +Options can also be specified on the command line if they precede the arguments and are prefixed with a hyphen\&. For example, to change the default query type to host information, and the initial timeout to 10 seconds, type: .sp +.if n \{\ .RS 4 +.\} .nf nslookup \-query=hinfo \-timeout=10 .fi +.if n \{\ .RE -.sp +.\} .PP The \fB\-version\fR option causes \fBnslookup\fR -to print the version number and immediately exits. +to print the version number and immediately exits\&. .SH "INTERACTIVE COMMANDS" .PP \fBhost\fR [server] .RS 4 -Look up information for host using the current default server or using server, if specified. If host is an Internet address and the query type is A or PTR, the name of the host is returned. If host is a name and does not have a trailing period, the search list is used to qualify the name. +Look up information for host using the current default server or using server, if specified\&. If host is an Internet address and the query type is A or PTR, the name of the host is returned\&. If host is a name and does not have a trailing period, the search list is used to qualify the name\&. .sp -To look up a host not in the current domain, append a period to the name. +To look up a host not in the current domain, append a period to the name\&. .RE .PP \fBserver\fR \fIdomain\fR @@ -88,7 +120,7 @@ Change the default server to uses the initial server to look up information about \fIdomain\fR, while \fBserver\fR -uses the current default server. If an authoritative answer can't be found, the names of servers that might have the answer are returned. +uses the current default server\&. If an authoritative answer can\*(Aqt be found, the names of servers that might have the answer are returned\&. .RE .PP \fBroot\fR @@ -123,24 +155,22 @@ not implemented .PP \fBexit\fR .RS 4 -Exits the program. +Exits the program\&. .RE .PP \fBset\fR \fIkeyword\fR\fI[=value]\fR .RS 4 -This command is used to change state information that affects the lookups. Valid keywords are: -.RS 4 +This command is used to change state information that affects the lookups\&. Valid keywords are: .PP \fBall\fR .RS 4 Prints the current values of the frequently used options to -\fBset\fR. Information about the current default server and host is also printed. +\fBset\fR\&. Information about the current default server and host is also printed\&. .RE .PP \fBclass=\fR\fIvalue\fR .RS 4 Change the query class to one of: -.RS 4 .PP \fBIN\fR .RS 4 @@ -161,16 +191,15 @@ the Hesiod class .RS 4 wildcard .RE -.RE -.IP "" 4 -The class specifies the protocol group of the information. +.sp +The class specifies the protocol group of the information\&. .sp (Default = IN; abbreviation = cl) .RE .PP \fB \fR\fB\fI[no]\fR\fR\fBdebug\fR .RS 4 -Turn on or off the display of the full response packet and any intermediate response packets when searching. +Turn on or off the display of the full response packet and any intermediate response packets when searching\&. .sp (Default = nodebug; abbreviation = [no]deb) @@ -178,7 +207,7 @@ Turn on or off the display of the full response packet and any intermediate resp .PP \fB \fR\fB\fI[no]\fR\fR\fBd2\fR .RS 4 -Turn debugging mode on or off. This displays more about what nslookup is doing. +Turn debugging mode on or off\&. This displays more about what nslookup is doing\&. .sp (Default = nod2) .RE @@ -186,12 +215,12 @@ Turn debugging mode on or off. This displays more about what nslookup is doing. \fBdomain=\fR\fIname\fR .RS 4 Sets the search list to -\fIname\fR. +\fIname\fR\&. .RE .PP \fB \fR\fB\fI[no]\fR\fR\fBsearch\fR .RS 4 -If the lookup request contains at least one period but doesn't end with a trailing period, append the domain names in the domain search list to the request until an answer is received. +If the lookup request contains at least one period but doesn\*(Aqt end with a trailing period, append the domain names in the domain search list to the request until an answer is received\&. .sp (Default = search) .RE @@ -199,7 +228,7 @@ If the lookup request contains at least one period but doesn't end with a traili \fBport=\fR\fIvalue\fR .RS 4 Change the default TCP/UDP name server port to -\fIvalue\fR. +\fIvalue\fR\&. .sp (Default = 53; abbreviation = po) .RE @@ -210,60 +239,64 @@ 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 +.sp .RE -.IP "" 4 -.RE +.SH "RETURN VALUES" +.PP +\fBnslookup\fR +returns with an exit status of 1 if any query failed, and 0 otherwise\&. .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-2016 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dig/nslookup.docbook b/bin/dig/nslookup.docbook index 022de672b80f..bd6d7b1fe092 100644 --- a/bin/dig/nslookup.docbook +++ b/bin/dig/nslookup.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004-2007, 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004-2007, 2010, 2013-2016 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -45,10 +42,14 @@ - OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - SUCH DAMAGE. --> -<refentry> - +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0"> + <info> + <date>2014-01-24</date> + </info> <refentryinfo> - <date>January 24, 2014</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -71,21 +72,23 @@ <year>2010</year> <year>2013</year> <year>2014</year> + <year>2015</year> + <year>2016</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>nslookup</command> - <arg><option>-option</option></arg> - <arg choice="opt">name | -</arg> - <arg choice="opt">server</arg> + <arg choice="opt" rep="norepeat"><option>-option</option></arg> + <arg choice="opt" rep="norepeat">name | -</arg> + <arg choice="opt" rep="norepeat">server</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>Nslookup</command> is a program to query Internet domain name servers. <command>Nslookup</command> has two modes: interactive and non-interactive. Interactive mode allows @@ -95,13 +98,13 @@ used to print just the name and requested information for a host or domain. </para> - </refsect1> + </refsection> + + <refsection><info><title>ARGUMENTS</title></info> - <refsect1> - <title>ARGUMENTS</title> <para> Interactive mode is entered in the following cases: - <orderedlist numeration="loweralpha"> + <orderedlist numeration="loweralpha" inheritnum="ignore" continuation="restarts"> <listitem> <para> when no arguments are given (the default name server will be used) @@ -139,10 +142,10 @@ nslookup -query=hinfo -timeout=10 number and immediately exits. </para> - </refsect1> + </refsection> + + <refsection><info><title>INTERACTIVE COMMANDS</title></info> - <refsect1> - <title>INTERACTIVE COMMANDS</title> <variablelist> <varlistentry> <term><constant>host</constant> <optional>server</optional></term> @@ -475,16 +478,23 @@ nslookup -query=hinfo -timeout=10 </listitem> </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>RETURN VALUES</title></info> + <para> + <command>nslookup</command> returns with an exit status of 1 + if any query failed, and 0 otherwise. + </para> + </refsection> + + <refsection><info><title>FILES</title></info> - <refsect1> - <title>FILES</title> <para><filename>/etc/resolv.conf</filename> </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>dig</refentrytitle><manvolnum>1</manvolnum> </citerefentry>, @@ -495,16 +505,5 @@ nslookup -query=hinfo -timeout=10 <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum> </citerefentry>. </para> - </refsect1> - - <refsect1> - <title>Author</title> - <para> - Andrew Cherenson - </para> - </refsect1> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> + </refsection> +</refentry> diff --git a/bin/dig/nslookup.html b/bin/dig/nslookup.html index 96777b3106e5..439ae2631672 100644 --- a/bin/dig/nslookup.html +++ b/bin/dig/nslookup.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2004-2007, 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004-2007, 2010, 2013-2016 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,15 +13,14 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>nslookup</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> -<a name="id2476283"></a><div class="titlepage"></div> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> +<a name="id-1"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> <p>nslookup — query Internet name servers interactively</p> @@ -30,10 +29,10 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">nslookup</code> [<code class="option">-option</code>] [name | -] [server]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543442"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">Nslookup</strong></span> - is a program to query Internet domain name servers. <span><strong class="command">Nslookup</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>Nslookup</strong></span> + is a program to query Internet domain name servers. <span class="command"><strong>Nslookup</strong></span> 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 @@ -42,16 +41,16 @@ domain. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543458"></a><h2>ARGUMENTS</h2> +<div class="refsection"> +<a name="id-1.8"></a><h2>ARGUMENTS</h2> <p> Interactive mode is entered in the following cases: </p> -<div class="orderedlist"><ol type="a"> -<li><p> +<div class="orderedlist"><ol class="orderedlist" type="a"> +<li class="listitem"><p> when no arguments are given (the default name server will be used) </p></li> -<li><p> +<li class="listitem"><p> when the first argument is a hyphen (-) and the second argument is the host name or Internet address of a name server. </p></li> @@ -78,13 +77,13 @@ nslookup -query=hinfo -timeout=10 </p> <p> The <code class="option">-version</code> option causes - <span><strong class="command">nslookup</strong></span> to print the version + <span class="command"><strong>nslookup</strong></span> to print the version number and immediately exits. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543512"></a><h2>INTERACTIVE COMMANDS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.9"></a><h2>INTERACTIVE COMMANDS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term"><code class="constant">host</code> [<span class="optional">server</span>]</span></dt> <dd> <p> @@ -144,11 +143,11 @@ nslookup -query=hinfo -timeout=10 This command is used to change state information that affects the lookups. Valid keywords are: </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term"><code class="constant">all</code></span></dt> <dd><p> Prints the current values of the frequently used - options to <span><strong class="command">set</strong></span>. + options to <span class="command"><strong>set</strong></span>. Information about the current default server and host is also printed. </p></dd> @@ -157,7 +156,7 @@ nslookup -query=hinfo -timeout=10 <p> Change the query class to one of: </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term"><code class="constant">IN</code></span></dt> <dd><p> the Internet class @@ -298,23 +297,24 @@ nslookup -query=hinfo -timeout=10 </dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2546326"></a><h2>FILES</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>RETURN VALUES</h2> +<p> + <span class="command"><strong>nslookup</strong></span> returns with an exit status of 1 + if any query failed, and 0 otherwise. + </p> +</div> +<div class="refsection"> +<a name="id-1.11"></a><h2>FILES</h2> <p><code class="filename">/etc/resolv.conf</code> </p> </div> -<div class="refsect1" lang="en"> -<a name="id2546338"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.12"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">dig</span>(1)</span>, <span class="citerefentry"><span class="refentrytitle">host</span>(1)</span>, <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2546372"></a><h2>Author</h2> -<p> - Andrew Cherenson - </p> -</div> </div></body> </html> diff --git a/bin/dnssec/Makefile.in b/bin/dnssec/Makefile.in index 81f65938a0c3..107bea9074e4 100644 --- a/bin/dnssec/Makefile.in +++ b/bin/dnssec/Makefile.in @@ -1,4 +1,4 @@ -# Copyright (C) 2004, 2005, 2007-2009, 2012-2014 Internet Systems Consortium, Inc. ("ISC") +# Copyright (C) 2004, 2005, 2007-2009, 2012-2015 Internet Systems Consortium, Inc. ("ISC") # Copyright (C) 2000-2002 Internet Software Consortium. # # Permission to use, copy, modify, and/or distribute this software for any @@ -19,7 +19,7 @@ srcdir = @srcdir@ VPATH = @srcdir@ top_srcdir = @top_srcdir@ -@BIND9_VERSION@ +VERSION=@BIND9_VERSION@ @BIND9_MAKE_INCLUDES@ @@ -51,7 +51,7 @@ OBJS = dnssectool.@O@ SRCS = dnssec-dsfromkey.c dnssec-keyfromlabel.c dnssec-keygen.c \ dnssec-revoke.c dnssec-settime.c dnssec-signzone.c \ - dnssec-verify.c dnssec-importkey.c dnssectool.c + dnssec-verify.c dnssec-importkey.c dnssectool.c MANPAGES = dnssec-dsfromkey.8 dnssec-keyfromlabel.8 dnssec-keygen.8 \ dnssec-revoke.8 dnssec-settime.8 dnssec-signzone.8 \ diff --git a/bin/dnssec/dnssec-dsfromkey.8 b/bin/dnssec/dnssec-dsfromkey.8 index 229433d5fa5a..5f6312177c40 100644 --- a/bin/dnssec/dnssec-dsfromkey.8 +++ b/bin/dnssec/dnssec-dsfromkey.8 @@ -12,163 +12,179 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: May 17, 2012 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2012-05-17 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-DSFROMKEY" "8" "May 17, 2012" "BIND9" "BIND9" +.TH "DNSSEC\-DSFROMKEY" "8" "2012\-05\-17" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-dsfromkey \- DNSSEC DS RR generation tool +dnssec-dsfromkey \- DNSSEC DS RR generation tool .SH "SYNOPSIS" -.HP 17 +.HP \w'\fBdnssec\-dsfromkey\fR\ 'u \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} -.HP 17 +.HP \w'\fBdnssec\-dsfromkey\fR\ 'u \fBdnssec\-dsfromkey\fR {\-s} [\fB\-1\fR] [\fB\-2\fR] [\fB\-a\ \fR\fB\fIalg\fR\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-s\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-T\ \fR\fB\fITTL\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-A\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] {dnsname} -.HP 17 +.HP \w'\fBdnssec\-dsfromkey\fR\ 'u \fBdnssec\-dsfromkey\fR [\fB\-h\fR] [\fB\-V\fR] .SH "DESCRIPTION" .PP \fBdnssec\-dsfromkey\fR -outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s). +outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s)\&. .SH "OPTIONS" .PP \-1 .RS 4 -Use SHA\-1 as the digest algorithm (the default is to use both SHA\-1 and SHA\-256). +Use SHA\-1 as the digest algorithm (the default is to use both SHA\-1 and SHA\-256)\&. .RE .PP \-2 .RS 4 -Use SHA\-256 as the digest algorithm. +Use SHA\-256 as the digest algorithm\&. .RE .PP \-a \fIalgorithm\fR .RS 4 -Select the digest algorithm. The value of +Select the digest algorithm\&. The value of \fBalgorithm\fR -must be one of SHA\-1 (SHA1), SHA\-256 (SHA256), GOST or SHA\-384 (SHA384). These values are case insensitive. +must be one of SHA\-1 (SHA1), SHA\-256 (SHA256), GOST or SHA\-384 (SHA384)\&. These values are case insensitive\&. .RE .PP \-C .RS 4 -Generate CDS records rather than DS records. This is mutually exclusive with generating lookaside records. +Generate CDS records rather than DS records\&. This is mutually exclusive with generating lookaside records\&. .RE .PP \-T \fITTL\fR .RS 4 -Specifies the TTL of the DS records. +Specifies the TTL of the DS records\&. .RE .PP \-K \fIdirectory\fR .RS 4 Look for key files (or, in keyset mode, -\fIkeyset\-\fR +keyset\- files) in -\fBdirectory\fR. +\fBdirectory\fR\&. .RE .PP \-f \fIfile\fR .RS 4 Zone file mode: in place of the keyfile name, the argument is the DNS domain name of a zone master file, which can be read from -\fBfile\fR. If the zone name is the same as -\fBfile\fR, then it may be omitted. +\fBfile\fR\&. If the zone name is the same as +\fBfile\fR, then it may be omitted\&. .sp If \fBfile\fR is set to -"\-", then the zone data is read from the standard input. This makes it possible to use the output of the +"\-", then the zone data is read from the standard input\&. This makes it possible to use the output of the \fBdig\fR command as input, as in: .sp -\fBdig dnskey example.com | dnssec\-dsfromkey \-f \- example.com\fR +\fBdig dnskey example\&.com | dnssec\-dsfromkey \-f \- example\&.com\fR .RE .PP \-A .RS 4 -Include ZSK's when generating DS records. Without this option, only keys which have the KSK flag set will be converted to DS records and printed. Useful only in zone file mode. +Include ZSK\*(Aqs when generating DS records\&. Without this option, only keys which have the KSK flag set will be converted to DS records and printed\&. Useful only in zone file mode\&. .RE .PP \-l \fIdomain\fR .RS 4 -Generate a DLV set instead of a DS set. The specified +Generate a DLV set instead of a DS set\&. The specified \fBdomain\fR -is appended to the name for each record in the set. The DNSSEC Lookaside Validation (DLV) RR is described in RFC 4431. This is mutually exclusive with generating CDS records. +is appended to the name for each record in the set\&. The DNSSEC Lookaside Validation (DLV) RR is described in RFC 4431\&. This is mutually exclusive with generating CDS records\&. .RE .PP \-s .RS 4 -Keyset mode: in place of the keyfile name, the argument is the DNS domain name of a keyset file. +Keyset mode: in place of the keyfile name, the argument is the DNS domain name of a keyset file\&. .RE .PP \-c \fIclass\fR .RS 4 -Specifies the DNS class (default is IN). Useful only in keyset or zone file mode. +Specifies the DNS class (default is IN)\&. Useful only in keyset or zone file mode\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-h .RS 4 -Prints usage information. +Prints usage information\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .SH "EXAMPLE" .PP To build the SHA\-256 DS RR from the -\fBKexample.com.+003+26160\fR +\fBKexample\&.com\&.+003+26160\fR keyfile name, the following command would be issued: .PP -\fBdnssec\-dsfromkey \-2 Kexample.com.+003+26160\fR +\fBdnssec\-dsfromkey \-2 Kexample\&.com\&.+003+26160\fR .PP The command would print something like: .PP -\fBexample.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94\fR +\fBexample\&.com\&. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94\fR .SH "FILES" .PP The keyfile can be designed by the key identification -\fIKnnnn.+aaa+iiiii\fR +Knnnn\&.+aaa+iiiii or the full file name -\fIKnnnn.+aaa+iiiii.key\fR +Knnnn\&.+aaa+iiiii\&.key as generated by -dnssec\-keygen(8). +dnssec\-keygen(8)\&. .PP The keyset file name is built from the \fBdirectory\fR, the string -\fIkeyset\-\fR +keyset\- and the -\fBdnsname\fR. +\fBdnsname\fR\&. .SH "CAVEAT" .PP -A keyfile error can give a "file not found" even if the file exists. +A keyfile error can give a "file not found" even if the file exists\&. .SH "SEE ALSO" .PP -\fBdnssec\-keygen\fR(8), -\fBdnssec\-signzone\fR(8), +\fBdnssec-keygen\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, RFC 3658, -RFC 4431. -RFC 4509. +RFC 4431\&. +RFC 4509\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2008\-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-dsfromkey.docbook b/bin/dnssec/dnssec-dsfromkey.docbook index 1127fa04e8b0..6cf7ac3ea85e 100644 --- a/bin/dnssec/dnssec-dsfromkey.docbook +++ b/bin/dnssec/dnssec-dsfromkey.docbook @@ -1,6 +1,3 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - Copyright (C) 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.dnssec-dsfromkey"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-dsfromkey"> + <info> + <date>2012-05-17</date> + </info> <refentryinfo> - <date>May 17, 2012</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -47,50 +49,50 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-dsfromkey</command> - <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg> - <arg><option>-1</option></arg> - <arg><option>-2</option></arg> - <arg><option>-a <replaceable class="parameter">alg</replaceable></option></arg> - <arg><option>-C</option></arg> - <arg><option>-l <replaceable class="parameter">domain</replaceable></option></arg> - <arg><option>-T <replaceable class="parameter">TTL</replaceable></option></arg> - <arg choice="req">keyfile</arg> + <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-1</option></arg> + <arg choice="opt" rep="norepeat"><option>-2</option></arg> + <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">alg</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-C</option></arg> + <arg choice="opt" rep="norepeat"><option>-l <replaceable class="parameter">domain</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-T <replaceable class="parameter">TTL</replaceable></option></arg> + <arg choice="req" rep="norepeat">keyfile</arg> </cmdsynopsis> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-dsfromkey</command> - <arg choice="req">-s</arg> - <arg><option>-1</option></arg> - <arg><option>-2</option></arg> - <arg><option>-a <replaceable class="parameter">alg</replaceable></option></arg> - <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-l <replaceable class="parameter">domain</replaceable></option></arg> - <arg><option>-s</option></arg> - <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg> - <arg><option>-T <replaceable class="parameter">TTL</replaceable></option></arg> - <arg><option>-f <replaceable class="parameter">file</replaceable></option></arg> - <arg><option>-A</option></arg> - <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg> - <arg choice="req">dnsname</arg> + <arg choice="req" rep="norepeat">-s</arg> + <arg choice="opt" rep="norepeat"><option>-1</option></arg> + <arg choice="opt" rep="norepeat"><option>-2</option></arg> + <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">alg</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-l <replaceable class="parameter">domain</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-s</option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-T <replaceable class="parameter">TTL</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">file</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-A</option></arg> + <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg> + <arg choice="req" rep="norepeat">dnsname</arg> </cmdsynopsis> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-dsfromkey</command> - <arg><option>-h</option></arg> - <arg><option>-V</option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>dnssec-dsfromkey</command> outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s). </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -181,7 +183,7 @@ <para> Include ZSK's when generating DS records. Without this option, only keys which have the KSK flag set will be converted to DS - records and printed. Useful only in zone file mode. + records and printed. Useful only in zone file mode. </para> </listitem> </varlistentry> @@ -247,10 +249,10 @@ </listitem> </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>EXAMPLE</title></info> - <refsect1> - <title>EXAMPLE</title> <para> To build the SHA-256 DS RR from the <userinput>Kexample.com.+003+26160</userinput> @@ -263,10 +265,10 @@ </para> <para><userinput>example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94</userinput> </para> - </refsect1> + </refsection> + + <refsection><info><title>FILES</title></info> - <refsect1> - <title>FILES</title> <para> The keyfile can be designed by the key identification <filename>Knnnn.+aaa+iiiii</filename> or the full file name @@ -278,17 +280,17 @@ the string <filename>keyset-</filename> and the <option>dnsname</option>. </para> - </refsect1> + </refsection> + + <refsection><info><title>CAVEAT</title></info> - <refsect1> - <title>CAVEAT</title> <para> A keyfile error can give a "file not found" even if the file exists. </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, @@ -300,16 +302,6 @@ <citetitle>RFC 4431</citetitle>. <citetitle>RFC 4509</citetitle>. </para> - </refsect1> - - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> + </refsection> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/dnssec/dnssec-dsfromkey.html b/bin/dnssec/dnssec-dsfromkey.html index 13e9cc5342a3..d470db327254 100644 --- a/bin/dnssec/dnssec-dsfromkey.html +++ b/bin/dnssec/dnssec-dsfromkey.html @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>dnssec-dsfromkey</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.dnssec-dsfromkey"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -32,16 +31,16 @@ <div class="cmdsynopsis"><p><code class="command">dnssec-dsfromkey</code> {-s} [<code class="option">-1</code>] [<code class="option">-2</code>] [<code class="option">-a <em class="replaceable"><code>alg</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-s</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-T <em class="replaceable"><code>TTL</code></em></code>] [<code class="option">-f <em class="replaceable"><code>file</code></em></code>] [<code class="option">-A</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] {dnsname}</p></div> <div class="cmdsynopsis"><p><code class="command">dnssec-dsfromkey</code> [<code class="option">-h</code>] [<code class="option">-V</code>]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543522"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">dnssec-dsfromkey</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>dnssec-dsfromkey</strong></span> outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s). </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543533"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-1</span></dt> <dd><p> Use SHA-1 as the digest algorithm (the default is to use @@ -84,7 +83,7 @@ <p> If <code class="option">file</code> is set to <code class="literal">"-"</code>, then the zone data is read from the standard input. This makes it - possible to use the output of the <span><strong class="command">dig</strong></span> + possible to use the output of the <span class="command"><strong>dig</strong></span> command as input, as in: </p> <p> @@ -95,7 +94,7 @@ <dd><p> Include ZSK's when generating DS records. Without this option, only keys which have the KSK flag set will be converted to DS - records and printed. Useful only in zone file mode. + records and printed. Useful only in zone file mode. </p></dd> <dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt> <dd><p> @@ -130,8 +129,8 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543800"></a><h2>EXAMPLE</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>EXAMPLE</h2> <p> To build the SHA-256 DS RR from the <strong class="userinput"><code>Kexample.com.+003+26160</code></strong> @@ -145,8 +144,8 @@ <p><strong class="userinput"><code>example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94</code></strong> </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543830"></a><h2>FILES</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>FILES</h2> <p> The keyfile can be designed by the key identification <code class="filename">Knnnn.+aaa+iiiii</code> or the full file name @@ -159,14 +158,14 @@ <code class="option">dnsname</code>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543865"></a><h2>CAVEAT</h2> +<div class="refsection"> +<a name="id-1.11"></a><h2>CAVEAT</h2> <p> A keyfile error can give a "file not found" even if the file exists. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543875"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.12"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>, @@ -175,10 +174,5 @@ <em class="citetitle">RFC 4509</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543914"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/dnssec/dnssec-importkey.8 b/bin/dnssec/dnssec-importkey.8 index 225077da0878..de57caa3d3fb 100644 --- a/bin/dnssec/dnssec-importkey.8 +++ b/bin/dnssec/dnssec-importkey.8 @@ -1,120 +1,136 @@ -.\" Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC") -.\" +.\" Copyright (C) 2013-2015 Internet Systems Consortium, Inc. ("ISC") +.\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-importkey +'\" t +.\" Title: dnssec-importkey .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> -.\" Date: February 07, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2014-02-07 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-IMPORTKEY" "8" "February 07, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-IMPORTKEY" "8" "2014\-02\-07" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-importkey \- Import DNSKEY records from external systems so they can be managed. +dnssec-importkey \- Import DNSKEY records from external systems so they can be managed\&. .SH "SYNOPSIS" -.HP 17 +.HP \w'\fBdnssec\-importkey\fR\ 'u \fBdnssec\-importkey\fR [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-h\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] {\fBkeyfile\fR} -.HP 17 +.HP \w'\fBdnssec\-importkey\fR\ 'u \fBdnssec\-importkey\fR {\fB\-f\ \fR\fB\fIfilename\fR\fR} [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-h\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fBdnsname\fR] .SH "DESCRIPTION" .PP \fBdnssec\-importkey\fR -reads a public DNSKEY record and generates a pair of .key/.private files. The DNSKEY record may be read from an existing .key file, in which case a corresponding .private file will be generated, or it may be read from any other file or from the standard input, in which case both .key and .private files will be generated. +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" -Copyright \(co 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2013-2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-importkey.docbook b/bin/dnssec/dnssec-importkey.docbook index 5893abd270a3..0fc469175483 100644 --- a/bin/dnssec/dnssec-importkey.docbook +++ b/bin/dnssec/dnssec-importkey.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2013-2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.dnssec-importkey"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-importkey"> + <info> + <date>2014-02-07</date> + </info> <refentryinfo> - <date>February 07, 2014</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -37,38 +39,39 @@ <copyright> <year>2013</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-importkey</command> - <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-L <replaceable class="parameter">ttl</replaceable></option></arg> - <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-h</option></arg> - <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg> - <arg><option>-V</option></arg> - <arg choice="req"><option>keyfile</option></arg> + <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="req" rep="norepeat"><option>keyfile</option></arg> </cmdsynopsis> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-importkey</command> - <arg choice="req"><option>-f <replaceable class="parameter">filename</replaceable></option></arg> - <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-L <replaceable class="parameter">ttl</replaceable></option></arg> - <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-h</option></arg> - <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg> - <arg><option>-V</option></arg> - <arg><option>dnsname</option></arg> + <arg choice="req" rep="norepeat"><option>-f <replaceable class="parameter">filename</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="opt" rep="norepeat"><option>dnsname</option></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>dnssec-importkey</command> reads a public DNSKEY record and generates a pair of .key/.private files. The DNSKEY record may be read from an @@ -86,10 +89,10 @@ public key can be added to and removed from the DNSKEY RRset on schedule even if the true private key is stored offline. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -107,7 +110,7 @@ </para> </listitem> </varlistentry> - + <varlistentry> <term>-K <replaceable class="parameter">directory</replaceable></term> <listitem> @@ -139,7 +142,7 @@ </para> </listitem> </varlistentry> - + <varlistentry> <term>-v <replaceable class="parameter">level</replaceable></term> <listitem> @@ -159,10 +162,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>TIMING OPTIONS</title></info> - <refsect1> - <title>TIMING OPTIONS</title> <para> Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as @@ -199,20 +202,20 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>FILES</title></info> - <refsect1> - <title>FILES</title> <para> A keyfile can be designed by the key identification <filename>Knnnn.+aaa+iiiii</filename> or the full file name <filename>Knnnn.+aaa+iiiii.key</filename> as generated by <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>. </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, @@ -222,16 +225,6 @@ <citetitle>BIND 9 Administrator Reference Manual</citetitle>, <citetitle>RFC 5011</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/dnssec/dnssec-importkey.html b/bin/dnssec/dnssec-importkey.html index 90f13f295b65..c0347d147b8d 100644 --- a/bin/dnssec/dnssec-importkey.html +++ b/bin/dnssec/dnssec-importkey.html @@ -1,27 +1,25 @@ <!-- - - Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC") - - + - Copyright (C) 2013-2015 Internet Systems Consortium, Inc. ("ISC") + - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>dnssec-importkey</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.dnssec-importkey"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -32,9 +30,9 @@ <div class="cmdsynopsis"><p><code class="command">dnssec-importkey</code> [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] {<code class="option">keyfile</code>}</p></div> <div class="cmdsynopsis"><p><code class="command">dnssec-importkey</code> {<code class="option">-f <em class="replaceable"><code>filename</code></em></code>} [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">dnsname</code>]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543475"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">dnssec-importkey</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>dnssec-importkey</strong></span> 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 @@ -52,9 +50,9 @@ on schedule even if the true private key is stored offline. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543500"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-f <em class="replaceable"><code>filename</code></em></span></dt> <dd> <p> @@ -95,8 +93,8 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543632"></a><h2>TIMING OPTIONS</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>TIMING OPTIONS</h2> <p> Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as @@ -108,7 +106,7 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'. </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt> <dd><p> Sets the date on which a key is to be published to the zone. @@ -123,8 +121,8 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543678"></a><h2>FILES</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>FILES</h2> <p> A keyfile can be designed by the key identification <code class="filename">Knnnn.+aaa+iiiii</code> or the full file name @@ -132,18 +130,13 @@ <span class="refentrytitle">dnssec-keygen</span>(8). </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543700"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.11"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>, <em class="citetitle">RFC 5011</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543733"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/dnssec/dnssec-keyfromlabel.8 b/bin/dnssec/dnssec-keyfromlabel.8 index 24da7c4d9df7..9e108fcfc03f 100644 --- a/bin/dnssec/dnssec-keyfromlabel.8 +++ b/bin/dnssec/dnssec-keyfromlabel.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2008-2012, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -12,237 +12,277 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-keyfromlabel +'\" t +.\" Title: dnssec-keyfromlabel .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> -.\" Date: February 27, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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 +.HP \w'\fBdnssec\-keyfromlabel\fR\ 'u \fBdnssec\-keyfromlabel\fR {\-l\ \fIlabel\fR} [\fB\-3\fR] [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\ \fR\fB\fIflag\fR\fR] [\fB\-G\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-k\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-n\ \fR\fB\fInametype\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-p\ \fR\fB\fIprotocol\fR\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-S\ \fR\fB\fIkey\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-y\fR] {name} .SH "DESCRIPTION" .PP \fBdnssec\-keyfromlabel\fR -generates a key pair of files that referencing a key object stored in a cryptographic hardware service module (HSM). The private key file can be used for DNSSEC signing of zone data as if it were a conventional signing key created by -\fBdnssec\-keygen\fR, but the key material is stored within the HSM, and the actual signing takes place there. +generates a key pair of files that referencing a key object stored in a cryptographic hardware service module (HSM)\&. The private key file can be used for DNSSEC signing of zone data as if it were a conventional signing key created by +\fBdnssec\-keygen\fR, but the key material is stored within the HSM, and the actual signing takes place there\&. .PP The \fBname\fR -of the key is specified on the command line. This must match the name of the zone for which the key is being generated. +of the key is specified on the command line\&. This must match the name of the zone for which the key is being generated\&. .SH "OPTIONS" .PP \-a \fIalgorithm\fR .RS 4 -Selects the cryptographic algorithm. The value of +Selects the cryptographic algorithm\&. The value of \fBalgorithm\fR -must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384. These values are case insensitive. +must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384\&. These values are case insensitive\&. .sp If no algorithm is specified, then RSASHA1 will be used by default, unless the \fB\-3\fR -option is specified, in which case NSEC3RSASHA1 will be used instead. (If +option is specified, in which case NSEC3RSASHA1 will be used instead\&. (If \fB\-3\fR -is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.) +is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3\&.) .sp -Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended. +Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended\&. .sp -Note 2: DH automatically sets the \-k flag. +Note 2: DH automatically sets the \-k flag\&. .RE .PP \-3 .RS 4 -Use an NSEC3\-capable algorithm to generate a DNSSEC key. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default. +Use an NSEC3\-capable algorithm to generate a DNSSEC key\&. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default\&. .RE .PP \-E \fIengine\fR .RS 4 -Specifies the name of the crypto hardware (OpenSSL engine). When compiled with PKCS#11 support it defaults to "pkcs11". +Specifies the name of the crypto hardware (OpenSSL engine)\&. When compiled with PKCS#11 support it defaults to "pkcs11"\&. .RE .PP \-l \fIlabel\fR .RS 4 -Specifies the label of the key pair in the crypto hardware. The label may be preceded by an optional OpenSSL engine name, separated by a colon, as in "pkcs11:keylabel". +Specifies the label of the key pair in the crypto hardware\&. The label may be preceded by an optional OpenSSL engine name, separated by a colon, as in "pkcs11:keylabel"\&. .RE .PP \-n \fInametype\fR .RS 4 -Specifies the owner type of the key. The value of +Specifies the owner type of the key\&. The value of \fBnametype\fR -must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). These values are case insensitive. +must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY)\&. These values are case insensitive\&. .RE .PP \-C .RS 4 -Compatibility mode: generates an old\-style key, without any metadata. By default, +Compatibility mode: generates an old\-style key, without any metadata\&. By default, \fBdnssec\-keyfromlabel\fR -will include the key's creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc). Keys that include this data may be incompatible with older versions of BIND; the +will include the key\*(Aqs creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc)\&. Keys that include this data may be incompatible with older versions of BIND; the \fB\-C\fR -option suppresses them. +option suppresses them\&. .RE .PP \-c \fIclass\fR .RS 4 -Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. +Indicates that the DNS record containing the key should have the specified class\&. If not specified, class IN is used\&. .RE .PP \-f \fIflag\fR .RS 4 -Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE. +Set the specified flag in the flag field of the KEY/DNSKEY record\&. The only recognized flags are KSK (Key Signing Key) and REVOKE\&. .RE .PP \-G .RS 4 -Generate a key, but do not publish it or sign with it. This option is incompatible with \-P and \-A. +Generate a key, but do not publish it or sign with it\&. This option is incompatible with \-P and \-A\&. .RE .PP \-h .RS 4 Prints a short summary of the options and arguments to -\fBdnssec\-keyfromlabel\fR. +\fBdnssec\-keyfromlabel\fR\&. .RE .PP \-K \fIdirectory\fR .RS 4 -Sets the directory in which the key files are to be written. +Sets the directory in which the key files are to be written\&. .RE .PP \-k .RS 4 -Generate KEY records rather than DNSKEY records. +Generate KEY records rather than DNSKEY records\&. .RE .PP \-L \fIttl\fR .RS 4 -Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. Setting the default TTL to +Sets the default TTL to use for this key when it is converted into a DNSKEY RR\&. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence\&. Setting the default TTL to 0 or none -removes it. +removes it\&. .RE .PP \-p \fIprotocol\fR .RS 4 -Sets the protocol value for the key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in RFC 2535 and its successors. +Sets the protocol value for the key\&. The protocol is a number between 0 and 255\&. The default is 3 (DNSSEC)\&. Other possible values for this argument are listed in RFC 2535 and its successors\&. .RE .PP \-S \fIkey\fR .RS 4 -Generate a key as an explicit successor to an existing key. The name, algorithm, size, and type of the key will be set to match the predecessor. The activation date of the new key will be set to the inactivation date of the existing one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. +Generate a key as an explicit successor to an existing key\&. The name, algorithm, size, and type of the key will be set to match the predecessor\&. The activation date of the new key will be set to the inactivation date of the existing one\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&. .RE .PP \-t \fItype\fR .RS 4 -Indicates the use of the key. +Indicates the use of the key\&. \fBtype\fR -must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data. +must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF\&. The default is AUTHCONF\&. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .PP \-y .RS 4 -Allows DNSSEC key files to be generated even if the key ID would collide with that of an existing key, in the event of either key being revoked. (This is only safe to use if you are sure you won't be using RFC 5011 trust anchor maintenance with either of the keys involved.) +Allows DNSSEC key files to be generated even if the key ID would collide with that of an existing key, in the event of either key being revoked\&. (This is only safe to use if you are sure you won\*(Aqt be using RFC 5011 trust anchor maintenance with either of the keys involved\&.) .RE .SH "TIMING OPTIONS" .PP -Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '\-', it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'. +Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To explicitly prevent a date from being set, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&. .PP \-P \fIdate/offset\fR .RS 4 -Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. If not set, and if the \-G option has not been used, the default is "now". +Sets the date on which a key is to be published to the zone\&. After that date, the key will be included in the zone but will not be used to sign it\&. If not set, and if the \-G option has not been used, the default is "now"\&. .RE .PP \-A \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. If not set, and if the \-G option has not been used, the default is "now". +Sets the date on which the key is to be activated\&. After that date, the key will be included in the zone and used to sign it\&. If not set, and if the \-G option has not been used, the default is "now"\&. .RE .PP \-R \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it. +Sets the date on which the key is to be revoked\&. After that date, the key will be flagged as revoked\&. It will be included in the zone and will be used to sign it\&. .RE .PP \-I \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it. +Sets the date on which the key is to be retired\&. After that date, the key will still be included in the zone, but it will not be used to sign it\&. .RE .PP \-D \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) +Sets the date on which the key is to be deleted\&. After that date, the key will no longer be included in the zone\&. (It may remain in the key repository, however\&.) .RE .PP \-i \fIinterval\fR .RS 4 -Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the publication date isn't, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn't, then activation will be set to this much time after publication. +Sets the prepublication interval for a key\&. If set, then the publication and activation dates must be separated by at least this much time\&. If the activation date is specified but the publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&. .sp -If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero. +If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero\&. .sp -As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds. +As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&. .RE .SH "GENERATED KEY FILES" .PP When \fBdnssec\-keyfromlabel\fR completes successfully, it prints a string of the form -\fIKnnnn.+aaa+iiiii\fR -to the standard output. This is an identification string for the key files it has generated. -.TP 4 -\(bu -\fInnnn\fR -is the key name. -.TP 4 -\(bu -\fIaaa\fR -is the numeric representation of the algorithm. -.TP 4 -\(bu -\fIiiiii\fR -is the key identifier (or footprint). +Knnnn\&.+aaa+iiiii +to the standard output\&. This is an identification string for the key files it has generated\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +nnnn +is the key name\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +aaa +is the numeric representation of the algorithm\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +iiiii +is the key identifier (or footprint)\&. +.RE .PP \fBdnssec\-keyfromlabel\fR -creates two files, with names based on the printed string. -\fIKnnnn.+aaa+iiiii.key\fR +creates two files, with names based on the printed string\&. +Knnnn\&.+aaa+iiiii\&.key contains the public key, and -\fIKnnnn.+aaa+iiiii.private\fR -contains the private key. +Knnnn\&.+aaa+iiiii\&.private +contains the private key\&. .PP The -\fI.key\fR -file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement). +\&.key +file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement)\&. .PP The -\fI.private\fR -file contains algorithm\-specific fields. For obvious security reasons, this file does not have general read permission. +\&.private +file contains algorithm\-specific fields\&. For obvious security reasons, this file does not have general read permission\&. .SH "SEE ALSO" .PP -\fBdnssec\-keygen\fR(8), -\fBdnssec\-signzone\fR(8), +\fBdnssec-keygen\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, -RFC 4034. +RFC 4034\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2008\-2012, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-keyfromlabel.docbook b/bin/dnssec/dnssec-keyfromlabel.docbook index a47c95589f64..6ee9f952e66c 100644 --- a/bin/dnssec/dnssec-keyfromlabel.docbook +++ b/bin/dnssec/dnssec-keyfromlabel.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2008-2012, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.dnssec-keyfromlabel"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-keyfromlabel"> + <info> + <date>2014-02-27</date> + </info> <refentryinfo> - <date>February 27, 2014</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -41,42 +43,43 @@ <year>2011</year> <year>2012</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-keyfromlabel</command> - <arg choice="req">-l <replaceable class="parameter">label</replaceable></arg> - <arg><option>-3</option></arg> - <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg> - <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg> - <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg> - <arg><option>-f <replaceable class="parameter">flag</replaceable></option></arg> - <arg><option>-G</option></arg> - <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-i <replaceable class="parameter">interval</replaceable></option></arg> - <arg><option>-k</option></arg> - <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-L <replaceable class="parameter">ttl</replaceable></option></arg> - <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg> - <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg> - <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-S <replaceable class="parameter">key</replaceable></option></arg> - <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg> - <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg> - <arg><option>-V</option></arg> - <arg><option>-y</option></arg> - <arg choice="req">name</arg> + <arg choice="req" rep="norepeat">-l <replaceable class="parameter">label</replaceable></arg> + <arg choice="opt" rep="norepeat"><option>-3</option></arg> + <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-E <replaceable class="parameter">engine</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">flag</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-G</option></arg> + <arg choice="opt" rep="norepeat"><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">interval</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-k</option></arg> + <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">nametype</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">protocol</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-S <replaceable class="parameter">key</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">type</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="opt" rep="norepeat"><option>-y</option></arg> + <arg choice="req" rep="norepeat">name</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>dnssec-keyfromlabel</command> generates a key pair of files that referencing a key object stored in a cryptographic hardware service module (HSM). The private key @@ -90,10 +93,10 @@ line. This must match the name of the zone for which the key is being generated. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -328,10 +331,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>TIMING OPTIONS</title></info> - <refsect1> - <title>TIMING OPTIONS</title> <para> Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. @@ -417,7 +420,7 @@ </para> <para> If the key is being created as an explicit successor to another - key, then the default prepublication interval is 30 days; + key, then the default prepublication interval is 30 days; otherwise it is zero. </para> <para> @@ -431,10 +434,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>GENERATED KEY FILES</title></info> - <refsect1> - <title>GENERATED KEY FILES</title> <para> When <command>dnssec-keyfromlabel</command> completes successfully, @@ -458,7 +461,7 @@ </para> </listitem> </itemizedlist> - <para><command>dnssec-keyfromlabel</command> + <para><command>dnssec-keyfromlabel</command> creates two files, with names based on the printed string. <filename>Knnnn.+aaa+iiiii.key</filename> contains the public key, and @@ -477,10 +480,10 @@ fields. For obvious security reasons, this file does not have general read permission. </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, @@ -490,16 +493,6 @@ <citetitle>BIND 9 Administrator Reference Manual</citetitle>, <citetitle>RFC 4034</citetitle>. </para> - </refsect1> - - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> + </refsection> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/dnssec/dnssec-keyfromlabel.html b/bin/dnssec/dnssec-keyfromlabel.html index 36971c466adc..eeb5345913ad 100644 --- a/bin/dnssec/dnssec-keyfromlabel.html +++ b/bin/dnssec/dnssec-keyfromlabel.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2008-2012, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>dnssec-keyfromlabel</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -30,13 +29,13 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">dnssec-keyfromlabel</code> {-l <em class="replaceable"><code>label</code></em>} [<code class="option">-3</code>] [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-k</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-S <em class="replaceable"><code>key</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-y</code>] {name}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543539"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">dnssec-keyfromlabel</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>dnssec-keyfromlabel</strong></span> 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 <span><strong class="command">dnssec-keygen</strong></span>, + conventional signing key created by <span class="command"><strong>dnssec-keygen</strong></span>, but the key material is stored within the HSM, and the actual signing takes place there. </p> @@ -46,9 +45,9 @@ being generated. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543560"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt> <dd> <p> @@ -103,7 +102,7 @@ <dt><span class="term">-C</span></dt> <dd><p> Compatibility mode: generates an old-style key, without - any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span> + any metadata. By default, <span class="command"><strong>dnssec-keyfromlabel</strong></span> 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 @@ -128,7 +127,7 @@ <dt><span class="term">-h</span></dt> <dd><p> Prints a short summary of the options and arguments to - <span><strong class="command">dnssec-keyfromlabel</strong></span>. + <span class="command"><strong>dnssec-keyfromlabel</strong></span>. </p></dd> <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt> <dd><p> @@ -189,8 +188,8 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2544046"></a><h2>TIMING OPTIONS</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>TIMING OPTIONS</h2> <p> Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as @@ -202,7 +201,7 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'. </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt> <dd><p> Sets the date on which a key is to be published to the zone. @@ -248,7 +247,7 @@ </p> <p> If the key is being created as an explicit successor to another - key, then the default prepublication interval is 30 days; + key, then the default prepublication interval is 30 days; otherwise it is zero. </p> <p> @@ -261,26 +260,26 @@ </dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543008"></a><h2>GENERATED KEY FILES</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>GENERATED KEY FILES</h2> <p> - When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes + When <span class="command"><strong>dnssec-keyfromlabel</strong></span> completes successfully, it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code> to the standard output. This is an identification string for the key files it has generated. </p> -<div class="itemizedlist"><ul type="disc"> -<li><p><code class="filename">nnnn</code> is the key name. +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="filename">nnnn</code> is the key name. </p></li> -<li><p><code class="filename">aaa</code> is the numeric representation +<li class="listitem"><p><code class="filename">aaa</code> is the numeric representation of the algorithm. </p></li> -<li><p><code class="filename">iiiii</code> is the key identifier (or +<li class="listitem"><p><code class="filename">iiiii</code> is the key identifier (or footprint). </p></li> </ul></div> -<p><span><strong class="command">dnssec-keyfromlabel</strong></span> +<p><span class="command"><strong>dnssec-keyfromlabel</strong></span> creates two files, with names based on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code> contains the public key, and @@ -300,18 +299,13 @@ general read permission. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543080"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.11"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>, <em class="citetitle">RFC 4034</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543113"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/dnssec/dnssec-keygen.8 b/bin/dnssec/dnssec-keygen.8 index 2cd5d76ff516..acbbbbd0e6fe 100644 --- a/bin/dnssec/dnssec-keygen.8 +++ b/bin/dnssec/dnssec-keygen.8 @@ -13,301 +13,341 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-keygen +'\" t +.\" Title: dnssec-keygen .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> -.\" Date: February 07, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2014-02-07 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-KEYGEN" "8" "February 07, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-KEYGEN" "8" "2014\-02\-07" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-keygen \- DNSSEC key generation tool +dnssec-keygen \- DNSSEC key generation tool .SH "SYNOPSIS" -.HP 14 +.HP \w'\fBdnssec\-keygen\fR\ 'u \fBdnssec\-keygen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-n\ \fR\fB\fInametype\fR\fR] [\fB\-3\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-C\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\ \fR\fB\fIflag\fR\fR] [\fB\-G\fR] [\fB\-g\ \fR\fB\fIgenerator\fR\fR] [\fB\-h\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-k\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-p\ \fR\fB\fIprotocol\fR\fR] [\fB\-q\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] [\fB\-S\ \fR\fB\fIkey\fR\fR] [\fB\-s\ \fR\fB\fIstrength\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-z\fR] {name} .SH "DESCRIPTION" .PP \fBdnssec\-keygen\fR -generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034. It can also generate keys for use with TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY (Transaction Key) as defined in RFC 2930. +generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034\&. It can also generate keys for use with TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY (Transaction Key) as defined in RFC 2930\&. .PP The \fBname\fR -of the key is specified on the command line. For DNSSEC keys, this must match the name of the zone for which the key is being generated. +of the key is specified on the command line\&. For DNSSEC keys, this must match the name of the zone for which the key is being generated\&. .SH "OPTIONS" .PP \-a \fIalgorithm\fR .RS 4 -Selects the cryptographic algorithm. For DNSSEC keys, the value of +Selects the cryptographic algorithm\&. For DNSSEC keys, the value of \fBalgorithm\fR -must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384. For TSIG/TKEY, the value must be DH (Diffie Hellman), HMAC\-MD5, HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256, HMAC\-SHA384, or HMAC\-SHA512. These values are case insensitive. +must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384\&. For TSIG/TKEY, the value must be DH (Diffie Hellman), HMAC\-MD5, HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256, HMAC\-SHA384, or HMAC\-SHA512\&. These values are case insensitive\&. .sp If no algorithm is specified, then RSASHA1 will be used by default, unless the \fB\-3\fR -option is specified, in which case NSEC3RSASHA1 will be used instead. (If +option is specified, in which case NSEC3RSASHA1 will be used instead\&. (If \fB\-3\fR -is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.) +is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3\&.) .sp -Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended. For TSIG, HMAC\-MD5 is mandatory. +Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended\&. For TSIG, HMAC\-MD5 is mandatory\&. .sp -Note 2: DH, HMAC\-MD5, and HMAC\-SHA1 through HMAC\-SHA512 automatically set the \-T KEY option. +Note 2: DH, HMAC\-MD5, and HMAC\-SHA1 through HMAC\-SHA512 automatically set the \-T KEY option\&. .RE .PP \-b \fIkeysize\fR .RS 4 -Specifies the number of bits in the key. The choice of key size depends on the algorithm used. RSA keys must be between 512 and 2048 bits. Diffie Hellman keys must be between 128 and 4096 bits. DSA keys must be between 512 and 1024 bits and an exact multiple of 64. HMAC keys must be between 1 and 512 bits. Elliptic curve algorithms don't need this parameter. +Specifies the number of bits in the key\&. The choice of key size depends on the algorithm used\&. RSA keys must be between 512 and 2048 bits\&. Diffie Hellman keys must be between 128 and 4096 bits\&. DSA keys must be between 512 and 1024 bits and an exact multiple of 64\&. HMAC keys must be between 1 and 512 bits\&. Elliptic curve algorithms don\*(Aqt need this parameter\&. .sp -The key size does not need to be specified if using a default algorithm. The default key size is 1024 bits for zone signing keys (ZSK's) and 2048 bits for key signing keys (KSK's, generated with -\fB\-f KSK\fR). However, if an algorithm is explicitly specified with the +The key size does not need to be specified if using a default algorithm\&. The default key size is 1024 bits for zone signing keys (ZSK\*(Aqs) and 2048 bits for key signing keys (KSK\*(Aqs, generated with +\fB\-f KSK\fR)\&. However, if an algorithm is explicitly specified with the \fB\-a\fR, then there is no default key size, and the \fB\-b\fR -must be used. +must be used\&. .RE .PP \-n \fInametype\fR .RS 4 -Specifies the owner type of the key. The value of +Specifies the owner type of the key\&. The value of \fBnametype\fR -must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). These values are case insensitive. Defaults to ZONE for DNSKEY generation. +must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY)\&. These values are case insensitive\&. Defaults to ZONE for DNSKEY generation\&. .RE .PP \-3 .RS 4 -Use an NSEC3\-capable algorithm to generate a DNSSEC key. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default. Note that RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 and ECDSAP384SHA384 algorithms are NSEC3\-capable. +Use an NSEC3\-capable algorithm to generate a DNSSEC key\&. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default\&. Note that RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 and ECDSAP384SHA384 algorithms are NSEC3\-capable\&. .RE .PP \-C .RS 4 -Compatibility mode: generates an old\-style key, without any metadata. By default, +Compatibility mode: generates an old\-style key, without any metadata\&. By default, \fBdnssec\-keygen\fR -will include the key's creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc). Keys that include this data may be incompatible with older versions of BIND; the +will include the key\*(Aqs creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc)\&. Keys that include this data may be incompatible with older versions of BIND; the \fB\-C\fR -option suppresses them. +option suppresses them\&. .RE .PP \-c \fIclass\fR .RS 4 -Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. +Indicates that the DNS record containing the key should have the specified class\&. If not specified, class IN is used\&. .RE .PP \-E \fIengine\fR .RS 4 -Uses a crypto hardware (OpenSSL engine) for random number and, when supported, key generation. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. +Uses a crypto hardware (OpenSSL engine) for random number and, when supported, key generation\&. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine\&. .RE .PP \-f \fIflag\fR .RS 4 -Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE. +Set the specified flag in the flag field of the KEY/DNSKEY record\&. The only recognized flags are KSK (Key Signing Key) and REVOKE\&. .RE .PP \-G .RS 4 -Generate a key, but do not publish it or sign with it. This option is incompatible with \-P and \-A. +Generate a key, but do not publish it or sign with it\&. This option is incompatible with \-P and \-A\&. .RE .PP \-g \fIgenerator\fR .RS 4 -If generating a Diffie Hellman key, use this generator. Allowed values are 2 and 5. If no generator is specified, a known prime from RFC 2539 will be used if possible; otherwise the default is 2. +If generating a Diffie Hellman key, use this generator\&. Allowed values are 2 and 5\&. If no generator is specified, a known prime from RFC 2539 will be used if possible; otherwise the default is 2\&. .RE .PP \-h .RS 4 Prints a short summary of the options and arguments to -\fBdnssec\-keygen\fR. +\fBdnssec\-keygen\fR\&. .RE .PP \-K \fIdirectory\fR .RS 4 -Sets the directory in which the key files are to be written. +Sets the directory in which the key files are to be written\&. .RE .PP \-k .RS 4 -Deprecated in favor of \-T KEY. +Deprecated in favor of \-T KEY\&. .RE .PP \-L \fIttl\fR .RS 4 -Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to +Sets the default TTL to use for this key when it is converted into a DNSKEY RR\&. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence\&. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL\&. Setting the default TTL to 0 or none -is the same as leaving it unset. +is the same as leaving it unset\&. .RE .PP \-p \fIprotocol\fR .RS 4 -Sets the protocol value for the generated key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in RFC 2535 and its successors. +Sets the protocol value for the generated key\&. The protocol is a number between 0 and 255\&. The default is 3 (DNSSEC)\&. Other possible values for this argument are listed in RFC 2535 and its successors\&. .RE .PP \-q .RS 4 -Quiet mode: Suppresses unnecessary output, including progress indication. Without this option, when +Quiet mode: Suppresses unnecessary output, including progress indication\&. Without this option, when \fBdnssec\-keygen\fR is run interactively to generate an RSA or DSA key pair, it will print a string of symbols to -\fIstderr\fR -indicating the progress of the key generation. A '.' indicates that a random number has been found which passed an initial sieve test; '+' means a number has passed a single round of the Miller\-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key. +stderr +indicating the progress of the key generation\&. A \*(Aq\&.\*(Aq indicates that a random number has been found which passed an initial sieve test; \*(Aq+\*(Aq means a number has passed a single round of the Miller\-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key\&. .RE .PP \-r \fIrandomdev\fR .RS 4 -Specifies the source of randomness. If the operating system does not provide a -\fI/dev/random\fR -or equivalent device, the default source of randomness is keyboard input. -\fIrandomdev\fR -specifies the name of a character device or file containing random data to be used instead of the default. The special value -\fIkeyboard\fR -indicates that keyboard input should be used. +Specifies the source of randomness\&. If the operating system does not provide a +/dev/random +or equivalent device, the default source of randomness is keyboard input\&. +randomdev +specifies the name of a character device or file containing random data to be used instead of the default\&. The special value +keyboard +indicates that keyboard input should be used\&. .RE .PP \-S \fIkey\fR .RS 4 -Create a new key which is an explicit successor to an existing key. The name, algorithm, size, and type of the key will be set to match the existing key. The activation date of the new key will be set to the inactivation date of the existing one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. +Create a new key which is an explicit successor to an existing key\&. The name, algorithm, size, and type of the key will be set to match the existing key\&. The activation date of the new key will be set to the inactivation date of the existing one\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&. .RE .PP \-s \fIstrength\fR .RS 4 -Specifies the strength value of the key. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC. +Specifies the strength value of the key\&. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC\&. .RE .PP \-T \fIrrtype\fR .RS 4 -Specifies the resource record type to use for the key. +Specifies the resource record type to use for the key\&. \fBrrtype\fR -must be either DNSKEY or KEY. The default is DNSKEY when using a DNSSEC algorithm, but it can be overridden to KEY for use with SIG(0). -Using any TSIG algorithm (HMAC\-* or DH) forces this option to KEY. +must be either DNSKEY or KEY\&. The default is DNSKEY when using a DNSSEC algorithm, but it can be overridden to KEY for use with SIG(0)\&. +Using any TSIG algorithm (HMAC\-* or DH) forces this option to KEY\&. .RE .PP \-t \fItype\fR .RS 4 -Indicates the use of the key. +Indicates the use of the key\&. \fBtype\fR -must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data. +must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF\&. The default is AUTHCONF\&. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .SH "TIMING OPTIONS" .PP -Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '\-', it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'. +Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To explicitly prevent a date from being set, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&. .PP \-P \fIdate/offset\fR .RS 4 -Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. If not set, and if the \-G option has not been used, the default is "now". +Sets the date on which a key is to be published to the zone\&. After that date, the key will be included in the zone but will not be used to sign it\&. If not set, and if the \-G option has not been used, the default is "now"\&. .RE .PP \-A \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. If not set, and if the \-G option has not been used, the default is "now". If set, if and \-P is not set, then the publication date will be set to the activation date minus the prepublication interval. +Sets the date on which the key is to be activated\&. After that date, the key will be included in the zone and used to sign it\&. If not set, and if the \-G option has not been used, the default is "now"\&. If set, if and \-P is not set, then the publication date will be set to the activation date minus the prepublication interval\&. .RE .PP \-R \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it. +Sets the date on which the key is to be revoked\&. After that date, the key will be flagged as revoked\&. It will be included in the zone and will be used to sign it\&. .RE .PP \-I \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it. +Sets the date on which the key is to be retired\&. After that date, the key will still be included in the zone, but it will not be used to sign it\&. .RE .PP \-D \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) +Sets the date on which the key is to be deleted\&. After that date, the key will no longer be included in the zone\&. (It may remain in the key repository, however\&.) .RE .PP \-i \fIinterval\fR .RS 4 -Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the publication date isn't, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn't, then activation will be set to this much time after publication. +Sets the prepublication interval for a key\&. If set, then the publication and activation dates must be separated by at least this much time\&. If the activation date is specified but the publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&. .sp -If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero. +If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero\&. .sp -As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds. +As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&. .RE .SH "GENERATED KEYS" .PP When \fBdnssec\-keygen\fR completes successfully, it prints a string of the form -\fIKnnnn.+aaa+iiiii\fR -to the standard output. This is an identification string for the key it has generated. -.TP 4 -\(bu -\fInnnn\fR -is the key name. -.TP 4 -\(bu -\fIaaa\fR -is the numeric representation of the algorithm. -.TP 4 -\(bu -\fIiiiii\fR -is the key identifier (or footprint). +Knnnn\&.+aaa+iiiii +to the standard output\&. This is an identification string for the key it has generated\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +nnnn +is the key name\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +aaa +is the numeric representation of the algorithm\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +iiiii +is the key identifier (or footprint)\&. +.RE .PP \fBdnssec\-keygen\fR -creates two files, with names based on the printed string. -\fIKnnnn.+aaa+iiiii.key\fR +creates two files, with names based on the printed string\&. +Knnnn\&.+aaa+iiiii\&.key contains the public key, and -\fIKnnnn.+aaa+iiiii.private\fR -contains the private key. +Knnnn\&.+aaa+iiiii\&.private +contains the private key\&. .PP The -\fI.key\fR -file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement). +\&.key +file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement)\&. .PP The -\fI.private\fR -file contains algorithm\-specific fields. For obvious security reasons, this file does not have general read permission. +\&.private +file contains algorithm\-specific fields\&. For obvious security reasons, this file does not have general read permission\&. .PP Both -\fI.key\fR +\&.key and -\fI.private\fR -files are generated for symmetric encryption algorithms such as HMAC\-MD5, even though the public and private key are equivalent. +\&.private +files are generated for symmetric encryption algorithms such as HMAC\-MD5, even though the public and private key are equivalent\&. .SH "EXAMPLE" .PP To generate a 768\-bit DSA key for the domain -\fBexample.com\fR, the following command would be issued: +\fBexample\&.com\fR, the following command would be issued: .PP -\fBdnssec\-keygen \-a DSA \-b 768 \-n ZONE example.com\fR +\fBdnssec\-keygen \-a DSA \-b 768 \-n ZONE example\&.com\fR .PP The command would print a string of the form: .PP -\fBKexample.com.+003+26160\fR +\fBKexample\&.com\&.+003+26160\fR .PP In this example, \fBdnssec\-keygen\fR creates the files -\fIKexample.com.+003+26160.key\fR +Kexample\&.com\&.+003+26160\&.key and -\fIKexample.com.+003+26160.private\fR. +Kexample\&.com\&.+003+26160\&.private\&. .SH "SEE ALSO" .PP -\fBdnssec\-signzone\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, RFC 2539, RFC 2845, -RFC 4034. +RFC 4034\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004, 2005, 2007\-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2003 Internet Software Consortium. +Copyright \(co 2004, 2005, 2007-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2003 Internet Software Consortium. .br diff --git a/bin/dnssec/dnssec-keygen.docbook b/bin/dnssec/dnssec-keygen.docbook index 472575f0d002..4737f5a821ca 100644 --- a/bin/dnssec/dnssec-keygen.docbook +++ b/bin/dnssec/dnssec-keygen.docbook @@ -1,6 +1,3 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - Copyright (C) 2004, 2005, 2007-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2003 Internet Software Consortium. @@ -18,9 +15,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.dnssec-keygen"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-keygen"> + <info> + <date>2014-02-07</date> + </info> <refentryinfo> - <date>February 07, 2014</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -58,43 +60,43 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-keygen</command> - <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg> - <arg ><option>-b <replaceable class="parameter">keysize</replaceable></option></arg> - <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg> - <arg><option>-3</option></arg> - <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-C</option></arg> - <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg> - <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg> - <arg><option>-f <replaceable class="parameter">flag</replaceable></option></arg> - <arg><option>-G</option></arg> - <arg><option>-g <replaceable class="parameter">generator</replaceable></option></arg> - <arg><option>-h</option></arg> - <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-i <replaceable class="parameter">interval</replaceable></option></arg> - <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-L <replaceable class="parameter">ttl</replaceable></option></arg> - <arg><option>-k</option></arg> - <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg> - <arg><option>-q</option></arg> - <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg> - <arg><option>-S <replaceable class="parameter">key</replaceable></option></arg> - <arg><option>-s <replaceable class="parameter">strength</replaceable></option></arg> - <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg> - <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg> - <arg><option>-V</option></arg> - <arg><option>-z</option></arg> - <arg choice="req">name</arg> + <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-b <replaceable class="parameter">keysize</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">nametype</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-3</option></arg> + <arg choice="opt" rep="norepeat"><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-C</option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-E <replaceable class="parameter">engine</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">flag</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-G</option></arg> + <arg choice="opt" rep="norepeat"><option>-g <replaceable class="parameter">generator</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">interval</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-k</option></arg> + <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">protocol</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-q</option></arg> + <arg choice="opt" rep="norepeat"><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-S <replaceable class="parameter">key</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">strength</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">type</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="opt" rep="norepeat"><option>-z</option></arg> + <arg choice="req" rep="norepeat">name</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>dnssec-keygen</command> generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034. It can also generate keys for use with @@ -106,10 +108,10 @@ line. For DNSSEC keys, this must match the name of the zone for which the key is being generated. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -431,10 +433,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>TIMING OPTIONS</title></info> - <refsect1> - <title>TIMING OPTIONS</title> <para> Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. @@ -522,7 +524,7 @@ </para> <para> If the key is being created as an explicit successor to another - key, then the default prepublication interval is 30 days; + key, then the default prepublication interval is 30 days; otherwise it is zero. </para> <para> @@ -536,11 +538,11 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> - <refsect1> - <title>GENERATED KEYS</title> + <refsection><info><title>GENERATED KEYS</title></info> + <para> When <command>dnssec-keygen</command> completes successfully, @@ -565,7 +567,7 @@ </para> </listitem> </itemizedlist> - <para><command>dnssec-keygen</command> + <para><command>dnssec-keygen</command> creates two files, with names based on the printed string. <filename>Knnnn.+aaa+iiiii.key</filename> contains the public key, and @@ -590,10 +592,10 @@ files are generated for symmetric encryption algorithms such as HMAC-MD5, even though the public and private key are equivalent. </para> - </refsect1> + </refsection> + + <refsection><info><title>EXAMPLE</title></info> - <refsect1> - <title>EXAMPLE</title> <para> To generate a 768-bit DSA key for the domain <userinput>example.com</userinput>, the following command would be @@ -612,10 +614,10 @@ and <filename>Kexample.com.+003+26160.private</filename>. </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, @@ -624,16 +626,6 @@ <citetitle>RFC 2845</citetitle>, <citetitle>RFC 4034</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/dnssec/dnssec-keygen.html b/bin/dnssec/dnssec-keygen.html index 9cf62ebc7660..a8917a374c90 100644 --- a/bin/dnssec/dnssec-keygen.html +++ b/bin/dnssec/dnssec-keygen.html @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>dnssec-keygen</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.dnssec-keygen"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -31,9 +30,9 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">dnssec-keygen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-3</code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-C</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>] [<code class="option">-h</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-k</code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-q</code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-S <em class="replaceable"><code>key</code></em></code>] [<code class="option">-s <em class="replaceable"><code>strength</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-z</code>] {name}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543608"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">dnssec-keygen</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>dnssec-keygen</strong></span> 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 @@ -45,9 +44,9 @@ which the key is being generated. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543626"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt> <dd> <p> @@ -120,7 +119,7 @@ <dt><span class="term">-C</span></dt> <dd><p> Compatibility mode: generates an old-style key, without - any metadata. By default, <span><strong class="command">dnssec-keygen</strong></span> + any metadata. By default, <span class="command"><strong>dnssec-keygen</strong></span> 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 @@ -159,7 +158,7 @@ <dt><span class="term">-h</span></dt> <dd><p> Prints a short summary of the options and arguments to - <span><strong class="command">dnssec-keygen</strong></span>. + <span class="command"><strong>dnssec-keygen</strong></span>. </p></dd> <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt> <dd><p> @@ -191,7 +190,7 @@ <dd><p> Quiet mode: Suppresses unnecessary output, including progress indication. Without this option, when - <span><strong class="command">dnssec-keygen</strong></span> is run interactively + <span class="command"><strong>dnssec-keygen</strong></span> is run interactively to generate an RSA or DSA key pair, it will print a string of symbols to <code class="filename">stderr</code> indicating the progress of the key generation. A '.' indicates that a @@ -261,8 +260,8 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2544220"></a><h2>TIMING OPTIONS</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>TIMING OPTIONS</h2> <p> Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as @@ -274,7 +273,7 @@ is computed in seconds. To explicitly prevent a date from being set, use 'none' or 'never'. </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt> <dd><p> Sets the date on which a key is to be published to the zone. @@ -322,7 +321,7 @@ </p> <p> If the key is being created as an explicit successor to another - key, then the default prepublication interval is 30 days; + key, then the default prepublication interval is 30 days; otherwise it is zero. </p> <p> @@ -335,27 +334,27 @@ </dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2544410"></a><h2>GENERATED KEYS</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>GENERATED KEYS</h2> <p> - When <span><strong class="command">dnssec-keygen</strong></span> completes + When <span class="command"><strong>dnssec-keygen</strong></span> completes successfully, it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code> to the standard output. This is an identification string for the key it has generated. </p> -<div class="itemizedlist"><ul type="disc"> -<li><p><code class="filename">nnnn</code> is the key name. +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="filename">nnnn</code> is the key name. </p></li> -<li><p><code class="filename">aaa</code> is the numeric representation +<li class="listitem"><p><code class="filename">aaa</code> is the numeric representation of the algorithm. </p></li> -<li><p><code class="filename">iiiii</code> is the key identifier (or +<li class="listitem"><p><code class="filename">iiiii</code> is the key identifier (or footprint). </p></li> </ul></div> -<p><span><strong class="command">dnssec-keygen</strong></span> +<p><span class="command"><strong>dnssec-keygen</strong></span> creates two files, with names based on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code> contains the public key, and @@ -381,8 +380,8 @@ HMAC-MD5, even though the public and private key are equivalent. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2544492"></a><h2>EXAMPLE</h2> +<div class="refsection"> +<a name="id-1.11"></a><h2>EXAMPLE</h2> <p> To generate a 768-bit DSA key for the domain <strong class="userinput"><code>example.com</code></strong>, the following command would be @@ -396,14 +395,14 @@ <p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong> </p> <p> - In this example, <span><strong class="command">dnssec-keygen</strong></span> creates + In this example, <span class="command"><strong>dnssec-keygen</strong></span> creates the files <code class="filename">Kexample.com.+003+26160.key</code> and <code class="filename">Kexample.com.+003+26160.private</code>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2544604"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.12"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>, <em class="citetitle">RFC 2539</em>, @@ -411,10 +410,5 @@ <em class="citetitle">RFC 4034</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2544635"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/dnssec/dnssec-revoke.8 b/bin/dnssec/dnssec-revoke.8 index eb8754557556..15ac846aaac7 100644 --- a/bin/dnssec/dnssec-revoke.8 +++ b/bin/dnssec/dnssec-revoke.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2009, 2011, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2009, 2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -12,82 +12,95 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-revoke -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> -.\" Date: October 20, 2011 +'\" t +.\" Title: dnssec-revoke +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2011-10-20 .\" Manual: BIND9 .\" Source: BIND9 +.\" Language: English .\" -.TH "DNSSEC\-REVOKE" "8" "October 20, 2011" "BIND9" "BIND9" +.TH "DNSSEC\-REVOKE" "8" "2011\-10\-20" "BIND9" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-revoke \- Set the REVOKED bit on a DNSSEC key +dnssec-revoke \- Set the REVOKED bit on a DNSSEC key .SH "SYNOPSIS" -.HP 14 +.HP \w'\fBdnssec\-revoke\fR\ 'u \fBdnssec\-revoke\fR [\fB\-hr\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\fR] [\fB\-R\fR] {keyfile} .SH "DESCRIPTION" .PP \fBdnssec\-revoke\fR -reads a DNSSEC key file, sets the REVOKED bit on the key as defined in RFC 5011, and creates a new pair of key files containing the now\-revoked key. +reads a DNSSEC key file, sets the REVOKED bit on the key as defined in RFC 5011, and creates a new pair of key files containing the now\-revoked key\&. .SH "OPTIONS" .PP \-h .RS 4 -Emit usage message and exit. +Emit usage message and exit\&. .RE .PP \-K \fIdirectory\fR .RS 4 -Sets the directory in which the key files are to reside. +Sets the directory in which the key files are to reside\&. .RE .PP \-r .RS 4 -After writing the new keyset files remove the original keyset files. +After writing the new keyset files remove the original keyset files\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .PP \-E \fIengine\fR .RS 4 -Use the given OpenSSL engine. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. +Use the given OpenSSL engine\&. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine\&. .RE .PP \-f .RS 4 Force overwrite: Causes \fBdnssec\-revoke\fR -to write the new key pair even if a file already exists matching the algorithm and key ID of the revoked key. +to write the new key pair even if a file already exists matching the algorithm and key ID of the revoked key\&. .RE .PP \-R .RS 4 -Print the key tag of the key with the REVOKE bit set but do not revoke the key. +Print the key tag of the key with the REVOKE bit set but do not revoke the key\&. .RE .SH "SEE ALSO" .PP -\fBdnssec\-keygen\fR(8), +\fBdnssec-keygen\fR(8), BIND 9 Administrator Reference Manual, -RFC 5011. -.SH "AUTHOR" -.PP -Internet Systems Consortium +RFC 5011\&. .SH "COPYRIGHT" -Copyright \(co 2009, 2011, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2009, 2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-revoke.c b/bin/dnssec/dnssec-revoke.c index 6756a38129e0..4e2a18a93683 100644 --- a/bin/dnssec/dnssec-revoke.c +++ b/bin/dnssec/dnssec-revoke.c @@ -79,7 +79,8 @@ main(int argc, char **argv) { #else const char *engine = NULL; #endif - char *filename = NULL, *dir = NULL; + char const *filename = NULL; + char *dir = NULL; char newname[1024], oldname[1024]; char keystr[DST_KEY_FORMATSIZE]; char *endp; diff --git a/bin/dnssec/dnssec-revoke.docbook b/bin/dnssec/dnssec-revoke.docbook index 85463d682cda..19708d2b3d4d 100644 --- a/bin/dnssec/dnssec-revoke.docbook +++ b/bin/dnssec/dnssec-revoke.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2009, 2011, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009, 2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,10 +14,11 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.dnssec-revoke"> - <refentryinfo> - <date>October 20, 2011</date> - </refentryinfo> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-revoke"> + <info> + <date>2011-10-20</date> + </info> <refmeta> <refentrytitle><application>dnssec-revoke</application></refentrytitle> @@ -38,35 +36,36 @@ <year>2009</year> <year>2011</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-revoke</command> - <arg><option>-hr</option></arg> - <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg> - <arg><option>-V</option></arg> - <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg> - <arg><option>-f</option></arg> - <arg><option>-R</option></arg> - <arg choice="req">keyfile</arg> + <arg choice="opt" rep="norepeat"><option>-hr</option></arg> + <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-E <replaceable class="parameter">engine</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-f</option></arg> + <arg choice="opt" rep="norepeat"><option>-R</option></arg> + <arg choice="req" rep="norepeat">keyfile</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>dnssec-revoke</command> 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. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -77,7 +76,7 @@ </para> </listitem> </varlistentry> - + <varlistentry> <term>-K <replaceable class="parameter">directory</replaceable></term> <listitem> @@ -146,26 +145,16 @@ </listitem> </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>, <citetitle>RFC 5011</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/dnssec/dnssec-revoke.html b/bin/dnssec/dnssec-revoke.html index d09b7dcd378a..58bbdae4155f 100644 --- a/bin/dnssec/dnssec-revoke.html +++ b/bin/dnssec/dnssec-revoke.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2009, 2011, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009, 2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>dnssec-revoke</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.dnssec-revoke"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -30,17 +29,17 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">dnssec-revoke</code> [<code class="option">-hr</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f</code>] [<code class="option">-R</code>] {keyfile}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543397"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">dnssec-revoke</strong></span> +<div class="refsection"> +<a name="id-1.6"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>dnssec-revoke</strong></span> 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. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543409"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.7"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-h</span></dt> <dd><p> Emit usage message and exit. @@ -69,7 +68,7 @@ </p></dd> <dt><span class="term">-f</span></dt> <dd><p> - Force overwrite: Causes <span><strong class="command">dnssec-revoke</strong></span> to + Force overwrite: Causes <span class="command"><strong>dnssec-revoke</strong></span> to write the new key pair even if a file already exists matching the algorithm and key ID of the revoked key. </p></dd> @@ -80,17 +79,12 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543541"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.8"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>, <em class="citetitle">RFC 5011</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543565"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/dnssec/dnssec-settime.8 b/bin/dnssec/dnssec-settime.8 index 821e4db990f1..37951ad2e0df 100644 --- a/bin/dnssec/dnssec-settime.8 +++ b/bin/dnssec/dnssec-settime.8 @@ -12,26 +12,41 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: February 07, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2014-02-07 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-SETTIME" "8" "February 07, 2014" "BIND9" "BIND9" +.TH "DNSSEC\-SETTIME" "8" "2014\-02\-07" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-settime \- Set the key timing metadata for a DNSSEC key +dnssec-settime \- Set the key timing metadata for a DNSSEC key .SH "SYNOPSIS" -.HP 15 +.HP \w'\fBdnssec\-settime\fR\ 'u \fBdnssec\-settime\fR [\fB\-f\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-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} .SH "DESCRIPTION" .PP @@ -42,114 +57,114 @@ reads a DNSSEC private key file and sets the key timing metadata as specified by \fB\-R\fR, \fB\-I\fR, and \fB\-D\fR -options. The metadata can then be used by +options\&. The metadata can then be used by \fBdnssec\-signzone\fR -or other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc. +or other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc\&. .PP If none of these options is set on the command line, then \fBdnssec\-settime\fR -simply prints the key timing metadata already stored in the key. +simply prints the key timing metadata already stored in the key\&. .PP -When key metadata fields are changed, both files of a key pair (\fIKnnnn.+aaa+iiiii.key\fR +When key metadata fields are changed, both files of a key pair (Knnnn\&.+aaa+iiiii\&.key and -\fIKnnnn.+aaa+iiiii.private\fR) are regenerated. Metadata fields are stored in the private file. A human\-readable description of the metadata is also placed in comments in the key file. The private file's permissions are always set to be inaccessible to anyone other than the owner (mode 0600). +Knnnn\&.+aaa+iiiii\&.private) are regenerated\&. Metadata fields are stored in the private file\&. A human\-readable description of the metadata is also placed in comments in the key file\&. The private file\*(Aqs permissions are always set to be inaccessible to anyone other than the owner (mode 0600)\&. .SH "OPTIONS" .PP \-f .RS 4 -Force an update of an old\-format key with no metadata fields. Without this option, +Force an update of an old\-format key with no metadata fields\&. Without this option, \fBdnssec\-settime\fR -will fail when attempting to update a legacy key. With this option, the key will be recreated in the new format, but with the original key data retained. The key's creation date will be set to the present time. If no other values are specified, then the key's publication and activation dates will also be set to the present time. +will fail when attempting to update a legacy key\&. With this option, the key will be recreated in the new format, but with the original key data retained\&. The key\*(Aqs creation date will be set to the present time\&. If no other values are specified, then the key\*(Aqs publication and activation dates will also be set to the present time\&. .RE .PP \-K \fIdirectory\fR .RS 4 -Sets the directory in which the key files are to reside. +Sets the directory in which the key files are to reside\&. .RE .PP \-L \fIttl\fR .RS 4 -Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL. Setting the default TTL to +Sets the default TTL to use for this key when it is converted into a DNSKEY RR\&. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence\&. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL\&. Setting the default TTL to 0 or none -removes it from the key. +removes it from the key\&. .RE .PP \-h .RS 4 -Emit usage message and exit. +Emit usage message and exit\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-E \fIengine\fR .RS 4 -Use the given OpenSSL engine. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. +Use the given OpenSSL engine\&. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine\&. .RE .SH "TIMING OPTIONS" .PP -Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '\-', it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To unset a date, use 'none' or 'never'. +Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively\&. Without a suffix, the offset is computed in seconds\&. To unset a date, use \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&. .PP \-P \fIdate/offset\fR .RS 4 -Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. +Sets the date on which a key is to be published to the zone\&. After that date, the key will be included in the zone but will not be used to sign it\&. .RE .PP \-A \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. +Sets the date on which the key is to be activated\&. After that date, the key will be included in the zone and used to sign it\&. .RE .PP \-R \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it. +Sets the date on which the key is to be revoked\&. After that date, the key will be flagged as revoked\&. It will be included in the zone and will be used to sign it\&. .RE .PP \-I \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it. +Sets the date on which the key is to be retired\&. After that date, the key will still be included in the zone, but it will not be used to sign it\&. .RE .PP \-D \fIdate/offset\fR .RS 4 -Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.) +Sets the date on which the key is to be deleted\&. After that date, the key will no longer be included in the zone\&. (It may remain in the key repository, however\&.) .RE .PP \-S \fIpredecessor key\fR .RS 4 -Select a key for which the key being modified will be an explicit successor. The name, algorithm, size, and type of the predecessor key must exactly match those of the key being modified. The activation date of the successor key will be set to the inactivation date of the predecessor. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days. +Select a key for which the key being modified will be an explicit successor\&. The name, algorithm, size, and type of the predecessor key must exactly match those of the key being modified\&. The activation date of the successor key will be set to the inactivation date of the predecessor\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&. .RE .PP \-i \fIinterval\fR .RS 4 -Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the publication date isn't, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn't, then activation will be set to this much time after publication. +Sets the prepublication interval for a key\&. If set, then the publication and activation dates must be separated by at least this much time\&. If the activation date is specified but the publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&. .sp -If the key is being set to be an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero. +If the key is being set to be an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero\&. .sp -As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds. +As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&. .RE .SH "PRINTING OPTIONS" .PP \fBdnssec\-settime\fR -can also be used to print the timing metadata associated with a key. +can also be used to print the timing metadata associated with a key\&. .PP \-u .RS 4 -Print times in UNIX epoch format. +Print times in UNIX epoch format\&. .RE .PP \-p \fIC/P/A/R/I/D/all\fR .RS 4 -Print a specific metadata value or set of metadata values. The +Print a specific metadata value or set of metadata values\&. The \fB\-p\fR option may be followed by one or more of the following letters to indicate which value or values to print: \fBC\fR @@ -163,18 +178,19 @@ for the revocation date, \fBI\fR for the inactivation date, or \fBD\fR -for the deletion date. To print all of the metadata, use -\fB\-p all\fR. +for the deletion date\&. To print all of the metadata, use +\fB\-p all\fR\&. .RE .SH "SEE ALSO" .PP -\fBdnssec\-keygen\fR(8), -\fBdnssec\-signzone\fR(8), +\fBdnssec-keygen\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, -RFC 5011. +RFC 5011\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2009\-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2009-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-settime.c b/bin/dnssec/dnssec-settime.c index e26356c788b1..a95d39a23660 100644 --- a/bin/dnssec/dnssec-settime.c +++ b/bin/dnssec/dnssec-settime.c @@ -122,7 +122,8 @@ main(int argc, char **argv) { #else const char *engine = NULL; #endif - char *filename = NULL, *directory = NULL; + const char *filename = NULL; + char *directory = NULL; char newname[1024]; char keystr[DST_KEY_FORMATSIZE]; char *endp, *p; diff --git a/bin/dnssec/dnssec-settime.docbook b/bin/dnssec/dnssec-settime.docbook index 942f1889cf60..db2b90a1c976 100644 --- a/bin/dnssec/dnssec-settime.docbook +++ b/bin/dnssec/dnssec-settime.docbook @@ -1,6 +1,3 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - Copyright (C) 2009-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.dnssec-settime"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-settime"> + <info> + <date>2014-02-07</date> + </info> <refentryinfo> - <date>February 07, 2014</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -45,26 +47,26 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-settime</command> - <arg><option>-f</option></arg> - <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-L <replaceable class="parameter">ttl</replaceable></option></arg> - <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg> - <arg><option>-h</option></arg> - <arg><option>-V</option></arg> - <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg> - <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg> - <arg choice="req">keyfile</arg> + <arg choice="opt" rep="norepeat"><option>-f</option></arg> + <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-E <replaceable class="parameter">engine</replaceable></option></arg> + <arg choice="req" rep="norepeat">keyfile</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>dnssec-settime</command> reads a DNSSEC private key file and sets the key timing metadata as specified by the <option>-P</option>, <option>-A</option>, @@ -88,10 +90,10 @@ file. The private file's permissions are always set to be inaccessible to anyone other than the owner (mode 0600). </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -103,13 +105,13 @@ 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 + 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. </para> </listitem> </varlistentry> - + <varlistentry> <term>-K <replaceable class="parameter">directory</replaceable></term> <listitem> @@ -143,7 +145,7 @@ </para> </listitem> </varlistentry> - + <varlistentry> <term>-V</term> <listitem> @@ -172,10 +174,10 @@ </listitem> </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>TIMING OPTIONS</title></info> - <refsect1> - <title>TIMING OPTIONS</title> <para> Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as @@ -272,7 +274,7 @@ </para> <para> If the key is being set to be an explicit successor to another - key, then the default prepublication interval is 30 days; + key, then the default prepublication interval is 30 days; otherwise it is zero. </para> <para> @@ -285,10 +287,10 @@ </listitem> </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>PRINTING OPTIONS</title></info> - <refsect1> - <title>PRINTING OPTIONS</title> <para> <command>dnssec-settime</command> can also be used to print the timing metadata associated with a key. @@ -323,10 +325,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, @@ -336,16 +338,6 @@ <citetitle>BIND 9 Administrator Reference Manual</citetitle>, <citetitle>RFC 5011</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/dnssec/dnssec-settime.html b/bin/dnssec/dnssec-settime.html index 0132e07ceee6..d66bf73e34cf 100644 --- a/bin/dnssec/dnssec-settime.html +++ b/bin/dnssec/dnssec-settime.html @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>dnssec-settime</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.dnssec-settime"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -30,20 +29,20 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">dnssec-settime</code> [<code class="option">-f</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-V</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] {keyfile}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543450"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">dnssec-settime</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>dnssec-settime</strong></span> reads a DNSSEC private key file and sets the key timing metadata as specified by the <code class="option">-P</code>, <code class="option">-A</code>, <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code> options. The metadata can then be used by - <span><strong class="command">dnssec-signzone</strong></span> or other signing software to + <span class="command"><strong>dnssec-signzone</strong></span> or other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc. </p> <p> If none of these options is set on the command line, - then <span><strong class="command">dnssec-settime</strong></span> simply prints the key timing + then <span class="command"><strong>dnssec-settime</strong></span> simply prints the key timing metadata already stored in the key. </p> <p> @@ -56,18 +55,18 @@ inaccessible to anyone other than the owner (mode 0600). </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543498"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-f</span></dt> <dd><p> Force an update of an old-format key with no metadata fields. - Without this option, <span><strong class="command">dnssec-settime</strong></span> will + Without this option, <span class="command"><strong>dnssec-settime</strong></span> 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 + 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. </p></dd> <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt> @@ -104,8 +103,8 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543697"></a><h2>TIMING OPTIONS</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>TIMING OPTIONS</h2> <p> Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '-', it is interpreted as @@ -116,7 +115,7 @@ days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To unset a date, use 'none' or 'never'. </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt> <dd><p> Sets the date on which a key is to be published to the zone. @@ -170,7 +169,7 @@ </p> <p> If the key is being set to be an explicit successor to another - key, then the default prepublication interval is 30 days; + key, then the default prepublication interval is 30 days; otherwise it is zero. </p> <p> @@ -183,13 +182,13 @@ </dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543835"></a><h2>PRINTING OPTIONS</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>PRINTING OPTIONS</h2> <p> - <span><strong class="command">dnssec-settime</strong></span> can also be used to print the + <span class="command"><strong>dnssec-settime</strong></span> can also be used to print the timing metadata associated with a key. </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-u</span></dt> <dd><p> Print times in UNIX epoch format. @@ -209,18 +208,13 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543913"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.11"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>, <em class="citetitle">RFC 5011</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543946"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/dnssec/dnssec-signzone.8 b/bin/dnssec/dnssec-signzone.8 index be2f5b34e0ad..214bb55123e0 100644 --- a/bin/dnssec/dnssec-signzone.8 +++ b/bin/dnssec/dnssec-signzone.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2004-2009, 2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2004-2009, 2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") .\" Copyright (C) 2000-2003 Internet Software Consortium. .\" .\" Permission to use, copy, modify, and/or distribute this software for any @@ -13,438 +13,458 @@ .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-signzone +'\" t +.\" Title: dnssec-signzone .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> -.\" Date: December 11, 2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2013-12-11 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-SIGNZONE" "8" "December 11, 2013" "BIND9" "BIND9" +.TH "DNSSEC\-SIGNZONE" "8" "2013\-12\-11" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-signzone \- DNSSEC zone signing tool +dnssec-signzone \- DNSSEC zone signing tool .SH "SYNOPSIS" -.HP 16 +.HP \w'\fBdnssec\-signzone\fR\ 'u \fBdnssec\-signzone\fR [\fB\-a\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-d\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-e\ \fR\fB\fIend\-time\fR\fR] [\fB\-f\ \fR\fB\fIoutput\-file\fR\fR] [\fB\-g\fR] [\fB\-h\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-k\ \fR\fB\fIkey\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-I\ \fR\fB\fIinput\-format\fR\fR] [\fB\-j\ \fR\fB\fIjitter\fR\fR] [\fB\-N\ \fR\fB\fIsoa\-serial\-format\fR\fR] [\fB\-o\ \fR\fB\fIorigin\fR\fR] [\fB\-O\ \fR\fB\fIoutput\-format\fR\fR] [\fB\-P\fR] [\fB\-p\fR] [\fB\-R\fR] [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] [\fB\-S\fR] [\fB\-s\ \fR\fB\fIstart\-time\fR\fR] [\fB\-T\ \fR\fB\fIttl\fR\fR] [\fB\-t\fR] [\fB\-u\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-X\ \fR\fB\fIextended\ end\-time\fR\fR] [\fB\-x\fR] [\fB\-z\fR] [\fB\-3\ \fR\fB\fIsalt\fR\fR] [\fB\-H\ \fR\fB\fIiterations\fR\fR] [\fB\-A\fR] {zonefile} [key...] .SH "DESCRIPTION" .PP \fBdnssec\-signzone\fR -signs a zone. It generates NSEC and RRSIG records and produces a signed version of the zone. The security status of delegations from the signed zone (that is, whether the child zones are secure or not) is determined by the presence or absence of a -\fIkeyset\fR -file for each child zone. +signs a zone\&. It generates NSEC and RRSIG records and produces a signed version of the zone\&. The security status of delegations from the signed zone (that is, whether the child zones are secure or not) is determined by the presence or absence of a +keyset +file for each child zone\&. .SH "OPTIONS" .PP \-a .RS 4 -Verify all generated signatures. +Verify all generated signatures\&. .RE .PP \-c \fIclass\fR .RS 4 -Specifies the DNS class of the zone. +Specifies the DNS class of the zone\&. .RE .PP \-C .RS 4 Compatibility mode: Generate a -\fIkeyset\-\fR\fI\fIzonename\fR\fR +keyset\-\fIzonename\fR file in addition to -\fIdsset\-\fR\fI\fIzonename\fR\fR +dsset\-\fIzonename\fR when signing a zone, for use by older versions of -\fBdnssec\-signzone\fR. +\fBdnssec\-signzone\fR\&. .RE .PP \-d \fIdirectory\fR .RS 4 Look for -\fIdsset\-\fR +dsset\- or -\fIkeyset\-\fR +keyset\- files in -\fBdirectory\fR. +\fBdirectory\fR\&. .RE .PP \-D .RS 4 Output only those record types automatically managed by -\fBdnssec\-signzone\fR, i.e. RRSIG, NSEC, NSEC3 and NSEC3PARAM records. If smart signing (\fB\-S\fR) is used, DNSKEY records are also included. The resulting file can be included in the original zone file with -\fB$INCLUDE\fR. This option cannot be combined with +\fBdnssec\-signzone\fR, i\&.e\&. RRSIG, NSEC, NSEC3 and NSEC3PARAM records\&. If smart signing (\fB\-S\fR) is used, DNSKEY records are also included\&. The resulting file can be included in the original zone file with +\fB$INCLUDE\fR\&. This option cannot be combined with \fB\-O raw\fR -or serial number updating. +or serial number updating\&. .RE .PP \-E \fIengine\fR .RS 4 -Uses a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance signing with private keys from a secure key store. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine. +Uses a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance signing with private keys from a secure key store\&. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine\&. .RE .PP \-g .RS 4 Generate DS records for child zones from -\fIdsset\-\fR +dsset\- or -\fIkeyset\-\fR -file. Existing DS records will be removed. +keyset\- +file\&. Existing DS records will be removed\&. .RE .PP \-K \fIdirectory\fR .RS 4 -Key repository: Specify a directory to search for DNSSEC keys. If not specified, defaults to the current directory. +Key repository: Specify a directory to search for DNSSEC keys\&. If not specified, defaults to the current directory\&. .RE .PP \-k \fIkey\fR .RS 4 -Treat specified key as a key signing key ignoring any key flags. This option may be specified multiple times. +Treat specified key as a key signing key ignoring any key flags\&. This option may be specified multiple times\&. .RE .PP \-l \fIdomain\fR .RS 4 -Generate a DLV set in addition to the key (DNSKEY) and DS sets. The domain is appended to the name of the records. +Generate a DLV set in addition to the key (DNSKEY) and DS sets\&. The domain is appended to the name of the records\&. .RE .PP \-s \fIstart\-time\fR .RS 4 -Specify the date and time when the generated RRSIG records become valid. This can be either an absolute or relative time. An absolute start time is indicated by a number in YYYYMMDDHHMMSS notation; 20000530144500 denotes 14:45:00 UTC on May 30th, 2000. A relative start time is indicated by +N, which is N seconds from the current time. If no +Specify the date and time when the generated RRSIG records become valid\&. This can be either an absolute or relative time\&. An absolute start time is indicated by a number in YYYYMMDDHHMMSS notation; 20000530144500 denotes 14:45:00 UTC on May 30th, 2000\&. A relative start time is indicated by +N, which is N seconds from the current time\&. If no \fBstart\-time\fR -is specified, the current time minus 1 hour (to allow for clock skew) is used. +is specified, the current time minus 1 hour (to allow for clock skew) is used\&. .RE .PP \-e \fIend\-time\fR .RS 4 -Specify the date and time when the generated RRSIG records expire. As with -\fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative to the start time is indicated with +N, which is N seconds from the start time. A time relative to the current time is indicated with now+N. If no +Specify the date and time when the generated RRSIG records expire\&. As with +\fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation\&. A time relative to the start time is indicated with +N, which is N seconds from the start time\&. A time relative to the current time is indicated with now+N\&. If no \fBend\-time\fR -is specified, 30 days from the start time is used as a default. +is specified, 30 days from the start time is used as a default\&. \fBend\-time\fR must be later than -\fBstart\-time\fR. +\fBstart\-time\fR\&. .RE .PP \-X \fIextended end\-time\fR .RS 4 -Specify the date and time when the generated RRSIG records for the DNSKEY RRset will expire. This is to be used in cases when the DNSKEY signatures need to persist longer than signatures on other records; e.g., when the private component of the KSK is kept offline and the KSK signature is to be refreshed manually. +Specify the date and time when the generated RRSIG records for the DNSKEY RRset will expire\&. This is to be used in cases when the DNSKEY signatures need to persist longer than signatures on other records; e\&.g\&., when the private component of the KSK is kept offline and the KSK signature is to be refreshed manually\&. .sp As with -\fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative to the start time is indicated with +N, which is N seconds from the start time. A time relative to the current time is indicated with now+N. If no +\fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation\&. A time relative to the start time is indicated with +N, which is N seconds from the start time\&. A time relative to the current time is indicated with now+N\&. If no \fBextended end\-time\fR is specified, the value of \fBend\-time\fR -is used as the default. (\fBend\-time\fR, in turn, defaults to 30 days from the start time.) +is used as the default\&. (\fBend\-time\fR, in turn, defaults to 30 days from the start time\&.) \fBextended end\-time\fR must be later than -\fBstart\-time\fR. +\fBstart\-time\fR\&. .RE .PP \-f \fIoutput\-file\fR .RS 4 -The name of the output file containing the signed zone. The default is to append -\fI.signed\fR -to the input filename. If +The name of the output file containing the signed zone\&. The default is to append +\&.signed +to the input filename\&. If \fBoutput\-file\fR is set to -"\-", then the signed zone is written to the standard output, with a default output format of "full". +"\-", then the signed zone is written to the standard output, with a default output format of "full"\&. .RE .PP \-h .RS 4 Prints a short summary of the options and arguments to -\fBdnssec\-signzone\fR. +\fBdnssec\-signzone\fR\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .PP \-i \fIinterval\fR .RS 4 -When a previously\-signed zone is passed as input, records may be resigned. The +When a previously\-signed zone is passed as input, records may be resigned\&. The \fBinterval\fR -option specifies the cycle interval as an offset from the current time (in seconds). If a RRSIG record expires after the cycle interval, it is retained. Otherwise, it is considered to be expiring soon, and it will be replaced. +option specifies the cycle interval as an offset from the current time (in seconds)\&. If a RRSIG record expires after the cycle interval, it is retained\&. Otherwise, it is considered to be expiring soon, and it will be replaced\&. .sp -The default cycle interval is one quarter of the difference between the signature end and start times. So if neither +The default cycle interval is one quarter of the difference between the signature end and start times\&. So if neither \fBend\-time\fR or \fBstart\-time\fR are specified, \fBdnssec\-signzone\fR -generates signatures that are valid for 30 days, with a cycle interval of 7.5 days. Therefore, if any existing RRSIG records are due to expire in less than 7.5 days, they would be replaced. +generates signatures that are valid for 30 days, with a cycle interval of 7\&.5 days\&. Therefore, if any existing RRSIG records are due to expire in less than 7\&.5 days, they would be replaced\&. .RE .PP \-I \fIinput\-format\fR .RS 4 -The format of the input zone file. Possible formats are +The format of the input zone file\&. Possible formats are \fB"text"\fR (default) and -\fB"raw"\fR. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be signed directly. The use of this option does not make much sense for non\-dynamic zones. +\fB"raw"\fR\&. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be signed directly\&. The use of this option does not make much sense for non\-dynamic zones\&. .RE .PP \-j \fIjitter\fR .RS 4 -When signing a zone with a fixed signature lifetime, all RRSIG records issued at the time of signing expires simultaneously. If the zone is incrementally signed, i.e. a previously\-signed zone is passed as input to the signer, all expired signatures have to be regenerated at about the same time. The +When signing a zone with a fixed signature lifetime, all RRSIG records issued at the time of signing expires simultaneously\&. If the zone is incrementally signed, i\&.e\&. a previously\-signed zone is passed as input to the signer, all expired signatures have to be regenerated at about the same time\&. The \fBjitter\fR -option specifies a jitter window that will be used to randomize the signature expire time, thus spreading incremental signature regeneration over time. +option specifies a jitter window that will be used to randomize the signature expire time, thus spreading incremental signature regeneration over time\&. .sp -Signature lifetime jitter also to some extent benefits validators and servers by spreading out cache expiration, i.e. if large numbers of RRSIGs don't expire at the same time from all caches there will be less congestion than if all validators need to refetch at mostly the same time. +Signature lifetime jitter also to some extent benefits validators and servers by spreading out cache expiration, i\&.e\&. if large numbers of RRSIGs don\*(Aqt expire at the same time from all caches there will be less congestion than if all validators need to refetch at mostly the same time\&. .RE .PP \-L \fIserial\fR .RS 4 -When writing a signed zone to 'raw' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) +When writing a signed zone to \*(Aqraw\*(Aq format, set the "source serial" value in the header to the specified serial number\&. (This is expected to be used primarily for testing purposes\&.) .RE .PP \-n \fIncpus\fR .RS 4 -Specifies the number of threads to use. By default, one thread is started for each detected CPU. +Specifies the number of threads to use\&. By default, one thread is started for each detected CPU\&. .RE .PP \-N \fIsoa\-serial\-format\fR .RS 4 -The SOA serial number format of the signed zone. Possible formats are +The SOA serial number format of the signed zone\&. Possible formats are \fB"keep"\fR (default), \fB"increment"\fR and -\fB"unixtime"\fR. -.RS 4 +\fB"unixtime"\fR\&. .PP \fB"keep"\fR .RS 4 -Do not modify the SOA serial number. +Do not modify the SOA serial number\&. .RE .PP \fB"increment"\fR .RS 4 -Increment the SOA serial number using RFC 1982 arithmetics. +Increment the SOA serial number using RFC 1982 arithmetics\&. .RE .PP \fB"unixtime"\fR .RS 4 -Set the SOA serial number to the number of seconds since epoch. -.RE +Set the SOA serial number to the number of seconds since epoch\&. .RE .RE .PP \-o \fIorigin\fR .RS 4 -The zone origin. If not specified, the name of the zone file is assumed to be the origin. +The zone origin\&. If not specified, the name of the zone file is assumed to be the origin\&. .RE .PP \-O \fIoutput\-format\fR .RS 4 -The format of the output file containing the signed zone. Possible formats are +The format of the output file containing the signed zone\&. Possible formats are \fB"text"\fR (default) \fB"full"\fR, which is text output in a format suitable for processing by external scripts, and \fB"raw"\fR or \fB"raw=N"\fR, which store the zone in a binary format for rapid loading by -\fBnamed\fR. +\fBnamed\fR\&. \fB"raw=N"\fR specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of -\fBnamed\fR; if N is 1, the file can be read by release 9.9.0 or higher. The default is 1. +\fBnamed\fR; if N is 1, the file can be read by release 9\&.9\&.0 or higher\&. The default is 1\&. .RE .PP \-p .RS 4 -Use pseudo\-random data when signing the zone. This is faster, but less secure, than using real random data. This option may be useful when signing large zones or when the entropy source is limited. +Use pseudo\-random data when signing the zone\&. This is faster, but less secure, than using real random data\&. This option may be useful when signing large zones or when the entropy source is limited\&. .RE .PP \-P .RS 4 -Disable post sign verification tests. +Disable post sign verification tests\&. .sp -The post sign verification test ensures that for each algorithm in use there is at least one non revoked self signed KSK key, that all revoked KSK keys are self signed, and that all records in the zone are signed by the algorithm. This option skips these tests. +The post sign verification test ensures that for each algorithm in use there is at least one non revoked self signed KSK key, that all revoked KSK keys are self signed, and that all records in the zone are signed by the algorithm\&. This option skips these tests\&. .RE .PP \-Q .RS 4 -Remove signatures from keys that are no longer active. +Remove signatures from keys that are no longer active\&. .sp -Normally, when a previously\-signed zone is passed as input to the signer, and a DNSKEY record has been removed and replaced with a new one, signatures from the old key that are still within their validity period are retained. This allows the zone to continue to validate with cached copies of the old DNSKEY RRset. The +Normally, when a previously\-signed zone is passed as input to the signer, and a DNSKEY record has been removed and replaced with a new one, signatures from the old key that are still within their validity period are retained\&. This allows the zone to continue to validate with cached copies of the old DNSKEY RRset\&. The \fB\-Q\fR forces \fBdnssec\-signzone\fR -to remove signatures from keys that are no longer active. This enables ZSK rollover using the procedure described in RFC 4641, section 4.2.1.1 ("Pre\-Publish Key Rollover"). +to remove signatures from keys that are no longer active\&. This enables ZSK rollover using the procedure described in RFC 4641, section 4\&.2\&.1\&.1 ("Pre\-Publish Key Rollover")\&. .RE .PP \-R .RS 4 -Remove signatures from keys that are no longer published. +Remove signatures from keys that are no longer published\&. .sp This option is similar to \fB\-Q\fR, except it forces \fBdnssec\-signzone\fR -to signatures from keys that are no longer published. This enables ZSK rollover using the procedure described in RFC 4641, section 4.2.1.2 ("Double Signature Zone Signing Key Rollover"). +to signatures from keys that are no longer published\&. This enables ZSK rollover using the procedure described in RFC 4641, section 4\&.2\&.1\&.2 ("Double Signature Zone Signing Key Rollover")\&. .RE .PP \-r \fIrandomdev\fR .RS 4 -Specifies the source of randomness. If the operating system does not provide a -\fI/dev/random\fR -or equivalent device, the default source of randomness is keyboard input. -\fIrandomdev\fR -specifies the name of a character device or file containing random data to be used instead of the default. The special value -\fIkeyboard\fR -indicates that keyboard input should be used. +Specifies the source of randomness\&. If the operating system does not provide a +/dev/random +or equivalent device, the default source of randomness is keyboard input\&. +randomdev +specifies the name of a character device or file containing random data to be used instead of the default\&. The special value +keyboard +indicates that keyboard input should be used\&. .RE .PP \-S .RS 4 Smart signing: Instructs \fBdnssec\-signzone\fR -to search the key repository for keys that match the zone being signed, and to include them in the zone if appropriate. +to search the key repository for keys that match the zone being signed, and to include them in the zone if appropriate\&. .sp -When a key is found, its timing metadata is examined to determine how it should be used, according to the following rules. Each successive rule takes priority over the prior ones: -.RS 4 +When a key is found, its timing metadata is examined to determine how it should be used, according to the following rules\&. Each successive rule takes priority over the prior ones: .PP .RS 4 -If no timing metadata has been set for the key, the key is published in the zone and used to sign the zone. +If no timing metadata has been set for the key, the key is published in the zone and used to sign the zone\&. .RE .PP .RS 4 -If the key's publication date is set and is in the past, the key is published in the zone. +If the key\*(Aqs publication date is set and is in the past, the key is published in the zone\&. .RE .PP .RS 4 -If the key's activation date is set and in the past, the key is published (regardless of publication date) and used to sign the zone. +If the key\*(Aqs activation date is set and in the past, the key is published (regardless of publication date) and used to sign the zone\&. .RE .PP .RS 4 -If the key's revocation date is set and in the past, and the key is published, then the key is revoked, and the revoked key is used to sign the zone. +If the key\*(Aqs revocation date is set and in the past, and the key is published, then the key is revoked, and the revoked key is used to sign the zone\&. .RE .PP .RS 4 -If either of the key's unpublication or deletion dates are set and in the past, the key is NOT published or used to sign the zone, regardless of any other metadata. -.RE +If either of the key\*(Aqs unpublication or deletion dates are set and in the past, the key is NOT published or used to sign the zone, regardless of any other metadata\&. .RE .RE .PP \-T \fIttl\fR .RS 4 -Specifies a TTL to be used for new DNSKEY records imported into the zone from the key repository. If not specified, the default is the TTL value from the zone's SOA record. This option is ignored when signing without -\fB\-S\fR, since DNSKEY records are not imported from the key repository in that case. It is also ignored if there are any pre\-existing DNSKEY records at the zone apex, in which case new records' TTL values will be set to match them, or if any of the imported DNSKEY records had a default TTL value. In the event of a a conflict between TTL values in imported keys, the shortest one is used. +Specifies a TTL to be used for new DNSKEY records imported into the zone from the key repository\&. If not specified, the default is the TTL value from the zone\*(Aqs SOA record\&. This option is ignored when signing without +\fB\-S\fR, since DNSKEY records are not imported from the key repository in that case\&. It is also ignored if there are any pre\-existing DNSKEY records at the zone apex, in which case new records\*(Aq TTL values will be set to match them, or if any of the imported DNSKEY records had a default TTL value\&. In the event of a a conflict between TTL values in imported keys, the shortest one is used\&. .RE .PP \-t .RS 4 -Print statistics at completion. +Print statistics at completion\&. .RE .PP \-u .RS 4 -Update NSEC/NSEC3 chain when re\-signing a previously signed zone. With this option, a zone signed with NSEC can be switched to NSEC3, or a zone signed with NSEC3 can be switch to NSEC or to NSEC3 with different parameters. Without this option, +Update NSEC/NSEC3 chain when re\-signing a previously signed zone\&. With this option, a zone signed with NSEC can be switched to NSEC3, or a zone signed with NSEC3 can be switch to NSEC or to NSEC3 with different parameters\&. Without this option, \fBdnssec\-signzone\fR -will retain the existing chain when re\-signing. +will retain the existing chain when re\-signing\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-x .RS 4 -Only sign the DNSKEY RRset with key\-signing keys, and omit signatures from zone\-signing keys. (This is similar to the +Only sign the DNSKEY RRset with key\-signing keys, and omit signatures from zone\-signing keys\&. (This is similar to the \fBdnssec\-dnskey\-kskonly yes;\fR zone option in -\fBnamed\fR.) +\fBnamed\fR\&.) .RE .PP \-z .RS 4 -Ignore KSK flag on key when determining what to sign. This causes KSK\-flagged keys to sign all records, not just the DNSKEY RRset. (This is similar to the +Ignore KSK flag on key when determining what to sign\&. This causes KSK\-flagged keys to sign all records, not just the DNSKEY RRset\&. (This is similar to the \fBupdate\-check\-ksk no;\fR zone option in -\fBnamed\fR.) +\fBnamed\fR\&.) .RE .PP \-3 \fIsalt\fR .RS 4 -Generate an NSEC3 chain with the given hex encoded salt. A dash (\fIsalt\fR) can be used to indicate that no salt is to be used when generating the NSEC3 chain. +Generate an NSEC3 chain with the given hex encoded salt\&. A dash (\fIsalt\fR) can be used to indicate that no salt is to be used when generating the NSEC3 chain\&. .RE .PP \-H \fIiterations\fR .RS 4 -When generating an NSEC3 chain, use this many iterations. The default is 10. +When generating an NSEC3 chain, use this many iterations\&. The default is 10\&. .RE .PP \-A .RS 4 -When generating an NSEC3 chain set the OPTOUT flag on all NSEC3 records and do not generate NSEC3 records for insecure delegations. +When generating an NSEC3 chain set the OPTOUT flag on all NSEC3 records and do not generate NSEC3 records for insecure delegations\&. .sp -Using this option twice (i.e., -\fB\-AA\fR) turns the OPTOUT flag off for all records. This is useful when using the +Using this option twice (i\&.e\&., +\fB\-AA\fR) turns the OPTOUT flag off for all records\&. This is useful when using the \fB\-u\fR -option to modify an NSEC3 chain which previously had OPTOUT set. +option to modify an NSEC3 chain which previously had OPTOUT set\&. .RE .PP zonefile .RS 4 -The file containing the zone to be signed. +The file containing the zone to be signed\&. .RE .PP key .RS 4 -Specify which keys should be used to sign the zone. If no keys are specified, then the zone will be examined for DNSKEY records at the zone apex. If these are found and there are matching private keys, in the current directory, then these will be used for signing. +Specify which keys should be used to sign the zone\&. If no keys are specified, then the zone will be examined for DNSKEY records at the zone apex\&. If these are found and there are matching private keys, in the current directory, then these will be used for signing\&. .RE .SH "EXAMPLE" .PP The following command signs the -\fBexample.com\fR +\fBexample\&.com\fR zone with the DSA key generated by \fBdnssec\-keygen\fR -(Kexample.com.+003+17247). Because the +(Kexample\&.com\&.+003+17247)\&. Because the \fB\-S\fR -option is not being used, the zone's keys must be in the master file (\fIdb.example.com\fR). This invocation looks for -\fIdsset\fR -files, in the current directory, so that DS records can be imported from them (\fB\-g\fR). +option is not being used, the zone\*(Aqs keys must be in the master file (db\&.example\&.com)\&. This invocation looks for +dsset +files, in the current directory, so that DS records can be imported from them (\fB\-g\fR)\&. .sp +.if n \{\ .RS 4 +.\} .nf -% dnssec\-signzone \-g \-o example.com db.example.com \\ -Kexample.com.+003+17247 -db.example.com.signed +% dnssec\-signzone \-g \-o example\&.com db\&.example\&.com \e +Kexample\&.com\&.+003+17247 +db\&.example\&.com\&.signed % .fi +.if n \{\ .RE +.\} .PP In the above example, \fBdnssec\-signzone\fR creates the file -\fIdb.example.com.signed\fR. This file should be referenced in a zone statement in a -\fInamed.conf\fR -file. +db\&.example\&.com\&.signed\&. This file should be referenced in a zone statement in a +named\&.conf +file\&. .PP -This example re\-signs a previously signed zone with default parameters. The private keys are assumed to be in the current directory. +This example re\-signs a previously signed zone with default parameters\&. The private keys are assumed to be in the current directory\&. .sp +.if n \{\ .RS 4 +.\} .nf -% cp db.example.com.signed db.example.com -% dnssec\-signzone \-o example.com db.example.com -db.example.com.signed +% cp db\&.example\&.com\&.signed db\&.example\&.com +% dnssec\-signzone \-o example\&.com db\&.example\&.com +db\&.example\&.com\&.signed % .fi +.if n \{\ .RE +.\} .SH "SEE ALSO" .PP -\fBdnssec\-keygen\fR(8), +\fBdnssec-keygen\fR(8), BIND 9 Administrator Reference Manual, RFC 4033, -RFC 4641. +RFC 4641\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2009, 2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2003 Internet Software Consortium. +Copyright \(co 2004-2009, 2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2003 Internet Software Consortium. .br diff --git a/bin/dnssec/dnssec-signzone.c b/bin/dnssec/dnssec-signzone.c index 6ef8e44b9d3a..6e85fe1107dc 100644 --- a/bin/dnssec/dnssec-signzone.c +++ b/bin/dnssec/dnssec-signzone.c @@ -1,5 +1,5 @@ /* - * Portions Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC") + * Portions Copyright (C) 2004-2016 Internet Systems Consortium, Inc. ("ISC") * Portions Copyright (C) 1999-2003 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -1099,6 +1099,10 @@ signname(dns_dbnode_t *node, dns_name_t *name) { dns_diff_clear(&add); } +/* + * See if the node contains any non RRSIG/NSEC records and report to + * caller. Clean out extranous RRSIG records for node. + */ static inline isc_boolean_t active_node(dns_dbnode_t *node) { dns_rdatasetiter_t *rdsiter = NULL; @@ -1771,9 +1775,12 @@ nsecify(void) { continue; } - if (dns_name_equal(name, gorigin)) + if (dns_name_equal(name, gorigin)) { remove_records(node, dns_rdatatype_nsec3param, ISC_TRUE); + /* Clean old rrsigs at apex. */ + (void)active_node(node); + } if (is_delegation(gdb, gversion, gorigin, name, node, &nsttl)) { zonecut = dns_fixedname_name(&fzonecut); @@ -2189,8 +2196,11 @@ nsec3ify(unsigned int hashalg, dns_iterations_t iterations, continue; } - if (dns_name_equal(name, gorigin)) + if (dns_name_equal(name, gorigin)) { remove_records(node, dns_rdatatype_nsec, ISC_TRUE); + /* Clean old rrsigs at apex. */ + (void)active_node(node); + } result = dns_dbiterator_next(dbiter); nextnode = NULL; diff --git a/bin/dnssec/dnssec-signzone.docbook b/bin/dnssec/dnssec-signzone.docbook index 4a092112c76f..75e9b2d518da 100644 --- a/bin/dnssec/dnssec-signzone.docbook +++ b/bin/dnssec/dnssec-signzone.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004-2009, 2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004-2009, 2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2003 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -18,9 +15,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.dnssec-signzone"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-signzone"> + <info> + <date>2013-12-11</date> + </info> <refentryinfo> - <date>December 11, 2013</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -45,6 +47,7 @@ <year>2011</year> <year>2013</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> <copyright> @@ -57,51 +60,51 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-signzone</command> - <arg><option>-a</option></arg> - <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg> - <arg><option>-d <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-D</option></arg> - <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg> - <arg><option>-e <replaceable class="parameter">end-time</replaceable></option></arg> - <arg><option>-f <replaceable class="parameter">output-file</replaceable></option></arg> - <arg><option>-g</option></arg> - <arg><option>-h</option></arg> - <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-k <replaceable class="parameter">key</replaceable></option></arg> - <arg><option>-L <replaceable class="parameter">serial</replaceable></option></arg> - <arg><option>-l <replaceable class="parameter">domain</replaceable></option></arg> - <arg><option>-i <replaceable class="parameter">interval</replaceable></option></arg> - <arg><option>-I <replaceable class="parameter">input-format</replaceable></option></arg> - <arg><option>-j <replaceable class="parameter">jitter</replaceable></option></arg> - <arg><option>-N <replaceable class="parameter">soa-serial-format</replaceable></option></arg> - <arg><option>-o <replaceable class="parameter">origin</replaceable></option></arg> - <arg><option>-O <replaceable class="parameter">output-format</replaceable></option></arg> - <arg><option>-P</option></arg> - <arg><option>-p</option></arg> - <arg><option>-R</option></arg> - <arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg> - <arg><option>-S</option></arg> - <arg><option>-s <replaceable class="parameter">start-time</replaceable></option></arg> - <arg><option>-T <replaceable class="parameter">ttl</replaceable></option></arg> - <arg><option>-t</option></arg> - <arg><option>-u</option></arg> - <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg> - <arg><option>-V</option></arg> - <arg><option>-X <replaceable class="parameter">extended end-time</replaceable></option></arg> - <arg><option>-x</option></arg> - <arg><option>-z</option></arg> - <arg><option>-3 <replaceable class="parameter">salt</replaceable></option></arg> - <arg><option>-H <replaceable class="parameter">iterations</replaceable></option></arg> - <arg><option>-A</option></arg> - <arg choice="req">zonefile</arg> - <arg rep="repeat">key</arg> + <arg choice="opt" rep="norepeat"><option>-a</option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-d <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-D</option></arg> + <arg choice="opt" rep="norepeat"><option>-E <replaceable class="parameter">engine</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-e <replaceable class="parameter">end-time</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">output-file</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-g</option></arg> + <arg choice="opt" rep="norepeat"><option>-h</option></arg> + <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">key</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">serial</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-l <replaceable class="parameter">domain</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">interval</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-I <replaceable class="parameter">input-format</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-j <replaceable class="parameter">jitter</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-N <replaceable class="parameter">soa-serial-format</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">origin</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-O <replaceable class="parameter">output-format</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-P</option></arg> + <arg choice="opt" rep="norepeat"><option>-p</option></arg> + <arg choice="opt" rep="norepeat"><option>-R</option></arg> + <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-S</option></arg> + <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">start-time</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-T <replaceable class="parameter">ttl</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-t</option></arg> + <arg choice="opt" rep="norepeat"><option>-u</option></arg> + <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="opt" rep="norepeat"><option>-X <replaceable class="parameter">extended end-time</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-x</option></arg> + <arg choice="opt" rep="norepeat"><option>-z</option></arg> + <arg choice="opt" rep="norepeat"><option>-3 <replaceable class="parameter">salt</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-H <replaceable class="parameter">iterations</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-A</option></arg> + <arg choice="req" rep="norepeat">zonefile</arg> + <arg rep="repeat" choice="opt">key</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>dnssec-signzone</command> signs a zone. It generates NSEC and RRSIG records and produces a signed version of the @@ -110,10 +113,10 @@ determined by the presence or absence of a <filename>keyset</filename> file for each child zone. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -387,7 +390,7 @@ <term>-L <replaceable class="parameter">serial</replaceable></term> <listitem> <para> - When writing a signed zone to 'raw' format, set the "source serial" + When writing a signed zone to 'raw' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) </para> @@ -508,7 +511,7 @@ <para> 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 + 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 <option>-Q</option> @@ -589,7 +592,7 @@ <para> 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. + used to sign the zone. </para> </listitem> </varlistentry> @@ -754,10 +757,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>EXAMPLE</title></info> - <refsect1> - <title>EXAMPLE</title> <para> The following command signs the <userinput>example.com</userinput> zone with the DSA key generated by <command>dnssec-keygen</command> @@ -785,26 +788,16 @@ db.example.com.signed % dnssec-signzone -o example.com db.example.com db.example.com.signed %</programlisting> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>, <citetitle>RFC 4033</citetitle>, <citetitle>RFC 4641</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/dnssec/dnssec-signzone.html b/bin/dnssec/dnssec-signzone.html index 3995507201b6..fec6c8f76673 100644 --- a/bin/dnssec/dnssec-signzone.html +++ b/bin/dnssec/dnssec-signzone.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2004-2009, 2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004-2009, 2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2003 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>dnssec-signzone</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.dnssec-signzone"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -31,9 +30,9 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">dnssec-signzone</code> [<code class="option">-a</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-d <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-D</code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-e <em class="replaceable"><code>end-time</code></em></code>] [<code class="option">-f <em class="replaceable"><code>output-file</code></em></code>] [<code class="option">-g</code>] [<code class="option">-h</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-k <em class="replaceable"><code>key</code></em></code>] [<code class="option">-L <em class="replaceable"><code>serial</code></em></code>] [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-I <em class="replaceable"><code>input-format</code></em></code>] [<code class="option">-j <em class="replaceable"><code>jitter</code></em></code>] [<code class="option">-N <em class="replaceable"><code>soa-serial-format</code></em></code>] [<code class="option">-o <em class="replaceable"><code>origin</code></em></code>] [<code class="option">-O <em class="replaceable"><code>output-format</code></em></code>] [<code class="option">-P</code>] [<code class="option">-p</code>] [<code class="option">-R</code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-S</code>] [<code class="option">-s <em class="replaceable"><code>start-time</code></em></code>] [<code class="option">-T <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-t</code>] [<code class="option">-u</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-X <em class="replaceable"><code>extended end-time</code></em></code>] [<code class="option">-x</code>] [<code class="option">-z</code>] [<code class="option">-3 <em class="replaceable"><code>salt</code></em></code>] [<code class="option">-H <em class="replaceable"><code>iterations</code></em></code>] [<code class="option">-A</code>] {zonefile} [key...]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543644"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">dnssec-signzone</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>dnssec-signzone</strong></span> 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 @@ -42,9 +41,9 @@ <code class="filename">keyset</code> file for each child zone. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543659"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-a</span></dt> <dd><p> Verify all generated signatures. @@ -60,7 +59,7 @@ file in addition to <code class="filename">dsset-<em class="replaceable"><code>zonename</code></em></code> when signing a zone, for use by older versions of - <span><strong class="command">dnssec-signzone</strong></span>. + <span class="command"><strong>dnssec-signzone</strong></span>. </p></dd> <dt><span class="term">-d <em class="replaceable"><code>directory</code></em></span></dt> <dd><p> @@ -70,11 +69,11 @@ <dt><span class="term">-D</span></dt> <dd><p> Output only those record types automatically managed by - <span><strong class="command">dnssec-signzone</strong></span>, i.e. RRSIG, NSEC, + <span class="command"><strong>dnssec-signzone</strong></span>, i.e. RRSIG, NSEC, NSEC3 and NSEC3PARAM records. If smart signing (<code class="option">-S</code>) is used, DNSKEY records are also included. The resulting file can be included in the original - zone file with <span><strong class="command">$INCLUDE</strong></span>. This option + zone file with <span class="command"><strong>$INCLUDE</strong></span>. This option cannot be combined with <code class="option">-O raw</code> or serial number updating. </p></dd> @@ -163,7 +162,7 @@ <dt><span class="term">-h</span></dt> <dd><p> Prints a short summary of the options and arguments to - <span><strong class="command">dnssec-signzone</strong></span>. + <span class="command"><strong>dnssec-signzone</strong></span>. </p></dd> <dt><span class="term">-V</span></dt> <dd><p> @@ -183,7 +182,7 @@ The default cycle interval is one quarter of the difference between the signature end and start times. So if neither <code class="option">end-time</code> or <code class="option">start-time</code> - are specified, <span><strong class="command">dnssec-signzone</strong></span> + are specified, <span class="command"><strong>dnssec-signzone</strong></span> generates signatures that are valid for 30 days, with a cycle interval of 7.5 days. Therefore, if any existing RRSIG records @@ -194,8 +193,8 @@ <dt><span class="term">-I <em class="replaceable"><code>input-format</code></em></span></dt> <dd><p> The format of the input zone file. - Possible formats are <span><strong class="command">"text"</strong></span> (default) - and <span><strong class="command">"raw"</strong></span>. + Possible formats are <span class="command"><strong>"text"</strong></span> (default) + and <span class="command"><strong>"raw"</strong></span>. 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. @@ -225,7 +224,7 @@ </dd> <dt><span class="term">-L <em class="replaceable"><code>serial</code></em></span></dt> <dd><p> - When writing a signed zone to 'raw' format, set the "source serial" + When writing a signed zone to 'raw' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.) </p></dd> @@ -238,17 +237,17 @@ <dd> <p> The SOA serial number format of the signed zone. - Possible formats are <span><strong class="command">"keep"</strong></span> (default), - <span><strong class="command">"increment"</strong></span> and - <span><strong class="command">"unixtime"</strong></span>. + Possible formats are <span class="command"><strong>"keep"</strong></span> (default), + <span class="command"><strong>"increment"</strong></span> and + <span class="command"><strong>"unixtime"</strong></span>. </p> -<div class="variablelist"><dl> -<dt><span class="term"><span><strong class="command">"keep"</strong></span></span></dt> +<div class="variablelist"><dl class="variablelist"> +<dt><span class="term"><span class="command"><strong>"keep"</strong></span></span></dt> <dd><p>Do not modify the SOA serial number.</p></dd> -<dt><span class="term"><span><strong class="command">"increment"</strong></span></span></dt> +<dt><span class="term"><span class="command"><strong>"increment"</strong></span></span></dt> <dd><p>Increment the SOA serial number using RFC 1982 arithmetics.</p></dd> -<dt><span class="term"><span><strong class="command">"unixtime"</strong></span></span></dt> +<dt><span class="term"><span class="command"><strong>"unixtime"</strong></span></span></dt> <dd><p>Set the SOA serial number to the number of seconds since epoch.</p></dd> </dl></div> @@ -261,15 +260,15 @@ <dt><span class="term">-O <em class="replaceable"><code>output-format</code></em></span></dt> <dd><p> The format of the output file containing the signed zone. - Possible formats are <span><strong class="command">"text"</strong></span> (default) - <span><strong class="command">"full"</strong></span>, which is text output in a + Possible formats are <span class="command"><strong>"text"</strong></span> (default) + <span class="command"><strong>"full"</strong></span>, which is text output in a format suitable for processing by external scripts, - and <span><strong class="command">"raw"</strong></span> or <span><strong class="command">"raw=N"</strong></span>, + and <span class="command"><strong>"raw"</strong></span> or <span class="command"><strong>"raw=N"</strong></span>, which store the zone in a binary format for rapid loading - by <span><strong class="command">named</strong></span>. <span><strong class="command">"raw=N"</strong></span> + by <span class="command"><strong>named</strong></span>. <span class="command"><strong>"raw=N"</strong></span> specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of - <span><strong class="command">named</strong></span>; if N is 1, the file can be + <span class="command"><strong>named</strong></span>; if N is 1, the file can be read by release 9.9.0 or higher. The default is 1. </p></dd> <dt><span class="term">-p</span></dt> @@ -300,11 +299,11 @@ <p> 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 + 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 <code class="option">-Q</code> - forces <span><strong class="command">dnssec-signzone</strong></span> to remove + forces <span class="command"><strong>dnssec-signzone</strong></span> 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"). @@ -317,7 +316,7 @@ </p> <p> This option is similar to <code class="option">-Q</code>, except it - forces <span><strong class="command">dnssec-signzone</strong></span> to signatures from + forces <span class="command"><strong>dnssec-signzone</strong></span> 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"). @@ -338,7 +337,7 @@ <dt><span class="term">-S</span></dt> <dd> <p> - Smart signing: Instructs <span><strong class="command">dnssec-signzone</strong></span> to + Smart signing: Instructs <span class="command"><strong>dnssec-signzone</strong></span> to search the key repository for keys that match the zone being signed, and to include them in the zone if appropriate. </p> @@ -348,7 +347,7 @@ rules. Each successive rule takes priority over the prior ones: </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt></dt> <dd><p> If no timing metadata has been set for the key, the key is @@ -363,7 +362,7 @@ <dd><p> 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. + used to sign the zone. </p></dd> <dt></dt> <dd><p> @@ -403,7 +402,7 @@ 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, <span><strong class="command">dnssec-signzone</strong></span> will + Without this option, <span class="command"><strong>dnssec-signzone</strong></span> will retain the existing chain when re-signing. </p></dd> <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt> @@ -414,16 +413,16 @@ <dd><p> Only sign the DNSKEY RRset with key-signing keys, and omit signatures from zone-signing keys. (This is similar to the - <span><strong class="command">dnssec-dnskey-kskonly yes;</strong></span> zone option in - <span><strong class="command">named</strong></span>.) + <span class="command"><strong>dnssec-dnskey-kskonly yes;</strong></span> zone option in + <span class="command"><strong>named</strong></span>.) </p></dd> <dt><span class="term">-z</span></dt> <dd><p> 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 - <span><strong class="command">update-check-ksk no;</strong></span> zone option in - <span><strong class="command">named</strong></span>.) + <span class="command"><strong>update-check-ksk no;</strong></span> zone option in + <span class="command"><strong>named</strong></span>.) </p></dd> <dt><span class="term">-3 <em class="replaceable"><code>salt</code></em></span></dt> <dd><p> @@ -464,23 +463,23 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2545181"></a><h2>EXAMPLE</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>EXAMPLE</h2> <p> The following command signs the <strong class="userinput"><code>example.com</code></strong> - zone with the DSA key generated by <span><strong class="command">dnssec-keygen</strong></span> - (Kexample.com.+003+17247). Because the <span><strong class="command">-S</strong></span> option + zone with the DSA key generated by <span class="command"><strong>dnssec-keygen</strong></span> + (Kexample.com.+003+17247). Because the <span class="command"><strong>-S</strong></span> option is not being used, the zone's keys must be in the master file (<code class="filename">db.example.com</code>). This invocation looks for <code class="filename">dsset</code> files, in the current directory, - so that DS records can be imported from them (<span><strong class="command">-g</strong></span>). + so that DS records can be imported from them (<span class="command"><strong>-g</strong></span>). </p> <pre class="programlisting">% dnssec-signzone -g -o example.com db.example.com \ Kexample.com.+003+17247 db.example.com.signed %</pre> <p> - In the above example, <span><strong class="command">dnssec-signzone</strong></span> creates + In the above example, <span class="command"><strong>dnssec-signzone</strong></span> creates the file <code class="filename">db.example.com.signed</code>. This file should be referenced in a zone statement in a <code class="filename">named.conf</code> file. @@ -494,17 +493,12 @@ db.example.com.signed db.example.com.signed %</pre> </div> -<div class="refsect1" lang="en"> -<a name="id2545237"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>, <em class="citetitle">RFC 4033</em>, <em class="citetitle">RFC 4641</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545265"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/dnssec/dnssec-verify.8 b/bin/dnssec/dnssec-verify.8 index df4278333dd7..6add24745664 100644 --- a/bin/dnssec/dnssec-verify.8 +++ b/bin/dnssec/dnssec-verify.8 @@ -1,102 +1,118 @@ -.\" Copyright (C) 2012, 2014 Internet Systems Consortium, Inc. ("ISC") -.\" +.\" Copyright (C) 2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id$ -.\" .hy 0 .ad l -.\" Title: dnssec\-verify +'\" t +.\" Title: dnssec-verify .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> -.\" Date: June 26, 2012 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2012-06-26 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "DNSSEC\-VERIFY" "8" "June 26, 2012" "BIND9" "BIND9" +.TH "DNSSEC\-VERIFY" "8" "2012\-06\-26" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -dnssec\-verify \- DNSSEC zone verification tool +dnssec-verify \- DNSSEC zone verification tool .SH "SYNOPSIS" -.HP 14 +.HP \w'\fBdnssec\-verify\fR\ 'u \fBdnssec\-verify\fR [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-I\ \fR\fB\fIinput\-format\fR\fR] [\fB\-o\ \fR\fB\fIorigin\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-x\fR] [\fB\-z\fR] {zonefile} .SH "DESCRIPTION" .PP \fBdnssec\-verify\fR -verifies that a zone is fully signed for each algorithm found in the DNSKEY RRset for the zone, and that the NSEC / NSEC3 chains are complete. +verifies that a zone is fully signed for each algorithm found in the DNSKEY RRset for the zone, and that the NSEC / NSEC3 chains are complete\&. .SH "OPTIONS" .PP \-c \fIclass\fR .RS 4 -Specifies the DNS class of the zone. +Specifies the DNS class of the zone\&. .RE .PP \-I \fIinput\-format\fR .RS 4 -The format of the input zone file. Possible formats are +The format of the input zone file\&. Possible formats are \fB"text"\fR (default) and -\fB"raw"\fR. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be verified independently. The use of this option does not make much sense for non\-dynamic zones. +\fB"raw"\fR\&. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be verified independently\&. The use of this option does not make much sense for non\-dynamic zones\&. .RE .PP \-o \fIorigin\fR .RS 4 -The zone origin. If not specified, the name of the zone file is assumed to be the origin. +The zone origin\&. If not specified, the name of the zone file is assumed to be the origin\&. .RE .PP \-v \fIlevel\fR .RS 4 -Sets the debugging level. +Sets the debugging level\&. .RE .PP \-V .RS 4 -Prints version information. +Prints version information\&. .RE .PP \-x .RS 4 -Only verify that the DNSKEY RRset is signed with key\-signing keys. Without this flag, it is assumed that the DNSKEY RRset will be signed by all active keys. When this flag is set, it will not be an error if the DNSKEY RRset is not signed by zone\-signing keys. This corresponds to the +Only verify that the DNSKEY RRset is signed with key\-signing keys\&. Without this flag, it is assumed that the DNSKEY RRset will be signed by all active keys\&. When this flag is set, it will not be an error if the DNSKEY RRset is not signed by zone\-signing keys\&. This corresponds to the \fB\-x\fR option in -\fBdnssec\-signzone\fR. +\fBdnssec\-signzone\fR\&. .RE .PP \-z .RS 4 -Ignore the KSK flag on the keys when determining whether the zone if correctly signed. Without this flag it is assumed that there will be a non\-revoked, self\-signed DNSKEY with the KSK flag set for each algorithm and that RRsets other than DNSKEY RRset will be signed with a different DNSKEY without the KSK flag set. +Ignore the KSK flag on the keys when determining whether the zone if correctly signed\&. Without this flag it is assumed that there will be a non\-revoked, self\-signed DNSKEY with the KSK flag set for each algorithm and that RRsets other than DNSKEY RRset will be signed with a different DNSKEY without the KSK flag set\&. .sp -With this flag set, we only require that for each algorithm, there will be at least one non\-revoked, self\-signed DNSKEY, regardless of the KSK flag state, and that other RRsets will be signed by a non\-revoked key for the same algorithm that includes the self\-signed key; the same key may be used for both purposes. This corresponds to the +With this flag set, we only require that for each algorithm, there will be at least one non\-revoked, self\-signed DNSKEY, regardless of the KSK flag state, and that other RRsets will be signed by a non\-revoked key for the same algorithm that includes the self\-signed key; the same key may be used for both purposes\&. This corresponds to the \fB\-z\fR option in -\fBdnssec\-signzone\fR. +\fBdnssec\-signzone\fR\&. .RE .PP zonefile .RS 4 -The file containing the zone to be signed. +The file containing the zone to be signed\&. .RE .SH "SEE ALSO" .PP -\fBdnssec\-signzone\fR(8), +\fBdnssec-signzone\fR(8), BIND 9 Administrator Reference Manual, -RFC 4033. +RFC 4033\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2012, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/dnssec/dnssec-verify.docbook b/bin/dnssec/dnssec-verify.docbook index d3c47c9c15a6..22f88998d31c 100644 --- a/bin/dnssec/dnssec-verify.docbook +++ b/bin/dnssec/dnssec-verify.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2012, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.dnssec-verify"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-verify"> + <info> + <date>2012-06-26</date> + </info> <refentryinfo> - <date>June 26, 2012</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -37,36 +39,37 @@ <copyright> <year>2012</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>dnssec-verify</command> - <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg> - <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg> - <arg><option>-I <replaceable class="parameter">input-format</replaceable></option></arg> - <arg><option>-o <replaceable class="parameter">origin</replaceable></option></arg> - <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg> - <arg><option>-V</option></arg> - <arg><option>-x</option></arg> - <arg><option>-z</option></arg> - <arg choice="req">zonefile</arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-E <replaceable class="parameter">engine</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-I <replaceable class="parameter">input-format</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">origin</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="opt" rep="norepeat"><option>-x</option></arg> + <arg choice="opt" rep="norepeat"><option>-z</option></arg> + <arg choice="req" rep="norepeat">zonefile</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>dnssec-verify</command> 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. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -169,10 +172,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para> <citerefentry> <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum> @@ -180,16 +183,6 @@ <citetitle>BIND 9 Administrator Reference Manual</citetitle>, <citetitle>RFC 4033</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/dnssec/dnssec-verify.html b/bin/dnssec/dnssec-verify.html index 8e237668992a..b973634e054b 100644 --- a/bin/dnssec/dnssec-verify.html +++ b/bin/dnssec/dnssec-verify.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2012, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>dnssec-verify</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.dnssec-verify"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -30,17 +29,17 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">dnssec-verify</code> [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-I <em class="replaceable"><code>input-format</code></em></code>] [<code class="option">-o <em class="replaceable"><code>origin</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-x</code>] [<code class="option">-z</code>] {zonefile}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543405"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">dnssec-verify</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>dnssec-verify</strong></span> 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. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543417"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt> <dd><p> Specifies the DNS class of the zone. @@ -48,8 +47,8 @@ <dt><span class="term">-I <em class="replaceable"><code>input-format</code></em></span></dt> <dd><p> The format of the input zone file. - Possible formats are <span><strong class="command">"text"</strong></span> (default) - and <span><strong class="command">"raw"</strong></span>. + Possible formats are <span class="command"><strong>"text"</strong></span> (default) + and <span class="command"><strong>"raw"</strong></span>. 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. @@ -76,7 +75,7 @@ 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 <code class="option">-x</code> - option in <span><strong class="command">dnssec-signzone</strong></span>. + option in <span class="command"><strong>dnssec-signzone</strong></span>. </p></dd> <dt><span class="term">-z</span></dt> <dd> @@ -95,7 +94,7 @@ 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 <code class="option">-z</code> - option in <span><strong class="command">dnssec-signzone</strong></span>. + option in <span class="command"><strong>dnssec-signzone</strong></span>. </p> </dd> <dt><span class="term">zonefile</span></dt> @@ -104,18 +103,13 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543640"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>SEE ALSO</h2> <p> <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>, <em class="citetitle">RFC 4033</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543666"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/named/Makefile.in b/bin/named/Makefile.in index 1d4a365d552f..3af6d83b83c9 100644 --- a/bin/named/Makefile.in +++ b/bin/named/Makefile.in @@ -1,4 +1,4 @@ -# Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC") +# Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC") # Copyright (C) 1998-2002 Internet Software Consortium. # # Permission to use, copy, modify, and/or distribute this software for any @@ -19,7 +19,7 @@ srcdir = @srcdir@ VPATH = @srcdir@ top_srcdir = @top_srcdir@ -@BIND9_VERSION@ +VERSION=@BIND9_VERSION@ @BIND9_PRODUCT@ diff --git a/bin/named/client.c b/bin/named/client.c index de2d596c8832..9ad78be84f66 100644 --- a/bin/named/client.c +++ b/bin/named/client.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2004-2016 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 1999-2003 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -953,6 +953,12 @@ ns_client_send(ns_client_t *client) { else if (client->view->preferred_glue == dns_rdatatype_aaaa) preferred_glue = DNS_MESSAGERENDER_PREFER_AAAA; } + if (preferred_glue == 0) { + if (isc_sockaddr_pf(&client->peeraddr) == AF_INET) + preferred_glue = DNS_MESSAGERENDER_PREFER_A; + else + preferred_glue = DNS_MESSAGERENDER_PREFER_AAAA; + } #ifdef ALLOW_FILTER_AAAA_ON_V4 /* @@ -1194,7 +1200,7 @@ ns_client_error(ns_client_t *client, isc_result_t result) { */ if (wouldlog) { ns_client_log(client, - NS_LOGCATEGORY_QUERY_EERRORS, + NS_LOGCATEGORY_QUERY_ERRORS, NS_LOGMODULE_CLIENT, loglevel, "%s", log_buf); @@ -1666,7 +1672,7 @@ client_request(isc_task_t *task, isc_event_t *event) { (void)client_addopt(client); ns_client_log(client, NS_LOGCATEGORY_CLIENT, - NS_LOGMODULE_CLIENT, ISC_LOG_WARNING, + NS_LOGMODULE_CLIENT, ISC_LOG_DEBUG(1), "message parsing failed: %s", isc_result_totext(result)); ns_client_error(client, result); diff --git a/bin/named/config.c b/bin/named/config.c index cab6f1fd0db8..4798272ac353 100644 --- a/bin/named/config.c +++ b/bin/named/config.c @@ -103,9 +103,9 @@ options {\n\ transfers-per-ns 2;\n\ transfers-in 10;\n\ transfers-out 10;\n\ - treat-cr-as-space true;\n\ - use-id-pool true;\n\ - use-ixfr true;\n\ +# treat-cr-as-space <obsolete>;\n\ +# use-id-pool <obsolete>;\n\ +# use-ixfr <obsolete>;\n\ edns-udp-size 4096;\n\ max-udp-size 4096;\n\ request-nsid false;\n\ diff --git a/bin/named/control.c b/bin/named/control.c index 37e3a38437b3..b1b744f2ceab 100644 --- a/bin/named/control.c +++ b/bin/named/control.c @@ -24,6 +24,7 @@ #include <isc/app.h> #include <isc/event.h> +#include <isc/lex.h> #include <isc/mem.h> #include <isc/string.h> #include <isc/timer.h> @@ -36,6 +37,7 @@ #include <isccc/result.h> #include <named/control.h> +#include <named/globals.h> #include <named/log.h> #include <named/os.h> #include <named/server.h> @@ -43,15 +45,30 @@ #include <named/ns_smf_globals.h> #endif -static isc_boolean_t -command_compare(const char *text, const char *command) { - unsigned int commandlen = strlen(command); - if (strncasecmp(text, command, commandlen) == 0 && - (text[commandlen] == '\0' || - text[commandlen] == ' ' || - text[commandlen] == '\t')) - return (ISC_TRUE); - return (ISC_FALSE); +static isc_result_t +getcommand(isc_lex_t *lex, char **cmdp) { + isc_result_t result; + isc_token_t token; + + REQUIRE(cmdp != NULL && *cmdp == NULL); + + result = isc_lex_gettoken(lex, ISC_LEXOPT_EOF, &token); + if (result != ISC_R_SUCCESS) + return (result); + + isc_lex_ungettoken(lex, &token); + + if (token.type != isc_tokentype_string) + return (ISC_R_FAILURE); + + *cmdp = token.value.as_textregion.base; + + return (ISC_R_SUCCESS); +} + +static inline isc_boolean_t +command_compare(const char *str, const char *command) { + return ISC_TF(strcasecmp(str, command) == 0); } /*% @@ -61,9 +78,12 @@ command_compare(const char *text, const char *command) { isc_result_t ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text) { isccc_sexpr_t *data; + char *cmdline = NULL; char *command = NULL; isc_result_t result; int log_level; + isc_buffer_t src; + isc_lex_t *lex = NULL; #ifdef HAVE_LIBSCF ns_smf_want_disable = 0; #endif @@ -76,7 +96,7 @@ ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text) { return (ISC_R_FAILURE); } - result = isccc_cc_lookupstring(data, "type", &command); + result = isccc_cc_lookupstring(data, "type", &cmdline); if (result != ISC_R_SUCCESS) { /* * We have no idea what this is. @@ -84,6 +104,20 @@ ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text) { return (result); } + result = isc_lex_create(ns_g_mctx, strlen(cmdline), &lex); + if (result != ISC_R_SUCCESS) + return (result); + + isc_buffer_init(&src, cmdline, strlen(cmdline)); + isc_buffer_add(&src, strlen(cmdline)); + result = isc_lex_openbuffer(lex, &src); + if (result != ISC_R_SUCCESS) + goto cleanup; + + result = getcommand(lex, &command); + if (result != ISC_R_SUCCESS) + goto cleanup; + /* * Compare the 'command' parameter against all known control commands. */ @@ -93,20 +127,21 @@ ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text) { } else { log_level = ISC_LOG_INFO; } + isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL, NS_LOGMODULE_CONTROL, log_level, "received control channel command '%s'", command); if (command_compare(command, NS_COMMAND_RELOAD)) { - result = ns_server_reloadcommand(ns_g_server, command, text); + result = ns_server_reloadcommand(ns_g_server, lex, text); } else if (command_compare(command, NS_COMMAND_RECONFIG)) { result = ns_server_reconfigcommand(ns_g_server); } else if (command_compare(command, NS_COMMAND_REFRESH)) { - result = ns_server_refreshcommand(ns_g_server, command, text); + result = ns_server_refreshcommand(ns_g_server, lex, text); } else if (command_compare(command, NS_COMMAND_RETRANSFER)) { result = ns_server_retransfercommand(ns_g_server, - command, text); + lex, text); } else if (command_compare(command, NS_COMMAND_HALT)) { #ifdef HAVE_LIBSCF /* @@ -116,7 +151,7 @@ ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text) { */ if (ns_smf_got_instance == 1 && ns_smf_chroot == 1) { result = ns_smf_add_message(text); - return (result); + goto cleanup; } /* * If we are managed by smf(5) but not in chroot, @@ -132,7 +167,7 @@ ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text) { #endif /* Do not flush master files */ ns_server_flushonshutdown(ns_g_server, ISC_FALSE); - ns_os_shutdownmsg(command, text); + ns_os_shutdownmsg(cmdline, text); isc_app_shutdown(); result = ISC_R_SUCCESS; } else if (command_compare(command, NS_COMMAND_STOP)) { @@ -143,51 +178,51 @@ ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text) { #ifdef HAVE_LIBSCF if (ns_smf_got_instance == 1 && ns_smf_chroot == 1) { result = ns_smf_add_message(text); - return (result); + goto cleanup; } if (ns_smf_got_instance == 1 && ns_smf_chroot == 0) ns_smf_want_disable = 1; #endif ns_server_flushonshutdown(ns_g_server, ISC_TRUE); - ns_os_shutdownmsg(command, text); + ns_os_shutdownmsg(cmdline, text); isc_app_shutdown(); result = ISC_R_SUCCESS; } else if (command_compare(command, NS_COMMAND_DUMPSTATS)) { result = ns_server_dumpstats(ns_g_server); } else if (command_compare(command, NS_COMMAND_QUERYLOG)) { - result = ns_server_togglequerylog(ns_g_server, command); + result = ns_server_togglequerylog(ns_g_server, lex); } else if (command_compare(command, NS_COMMAND_DUMPDB)) { - ns_server_dumpdb(ns_g_server, command); + ns_server_dumpdb(ns_g_server, lex); result = ISC_R_SUCCESS; } else if (command_compare(command, NS_COMMAND_SECROOTS)) { - result = ns_server_dumpsecroots(ns_g_server, command); + result = ns_server_dumpsecroots(ns_g_server, lex); } else if (command_compare(command, NS_COMMAND_TRACE)) { - result = ns_server_setdebuglevel(ns_g_server, command); + result = ns_server_setdebuglevel(ns_g_server, lex); } else if (command_compare(command, NS_COMMAND_NOTRACE)) { ns_g_debuglevel = 0; isc_log_setdebuglevel(ns_g_lctx, ns_g_debuglevel); result = ISC_R_SUCCESS; } else if (command_compare(command, NS_COMMAND_FLUSH)) { - result = ns_server_flushcache(ns_g_server, command); + result = ns_server_flushcache(ns_g_server, lex); } else if (command_compare(command, NS_COMMAND_FLUSHNAME)) { - result = ns_server_flushnode(ns_g_server, command, ISC_FALSE); + result = ns_server_flushnode(ns_g_server, lex, ISC_FALSE); } else if (command_compare(command, NS_COMMAND_FLUSHTREE)) { - result = ns_server_flushnode(ns_g_server, command, ISC_TRUE); + result = ns_server_flushnode(ns_g_server, lex, ISC_TRUE); } else if (command_compare(command, NS_COMMAND_STATUS)) { result = ns_server_status(ns_g_server, text); } else if (command_compare(command, NS_COMMAND_TSIGLIST)) { result = ns_server_tsiglist(ns_g_server, text); } else if (command_compare(command, NS_COMMAND_TSIGDELETE)) { - result = ns_server_tsigdelete(ns_g_server, command, text); + result = ns_server_tsigdelete(ns_g_server, lex, text); } else if (command_compare(command, NS_COMMAND_FREEZE)) { - result = ns_server_freeze(ns_g_server, ISC_TRUE, command, + result = ns_server_freeze(ns_g_server, ISC_TRUE, lex, text); } else if (command_compare(command, NS_COMMAND_UNFREEZE) || command_compare(command, NS_COMMAND_THAW)) { - result = ns_server_freeze(ns_g_server, ISC_FALSE, command, + result = ns_server_freeze(ns_g_server, ISC_FALSE, lex, text); } else if (command_compare(command, NS_COMMAND_SYNC)) { - result = ns_server_sync(ns_g_server, command, text); + result = ns_server_sync(ns_g_server, lex, text); } else if (command_compare(command, NS_COMMAND_RECURSING)) { result = ns_server_dumprecursing(ns_g_server); } else if (command_compare(command, NS_COMMAND_TIMERPOKE)) { @@ -196,18 +231,18 @@ ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text) { } else if (command_compare(command, NS_COMMAND_NULL)) { result = ISC_R_SUCCESS; } else if (command_compare(command, NS_COMMAND_NOTIFY)) { - result = ns_server_notifycommand(ns_g_server, command, text); + result = ns_server_notifycommand(ns_g_server, lex, text); } else if (command_compare(command, NS_COMMAND_VALIDATION)) { - result = ns_server_validation(ns_g_server, command); + result = ns_server_validation(ns_g_server, lex); } else if (command_compare(command, NS_COMMAND_SIGN) || command_compare(command, NS_COMMAND_LOADKEYS)) { - result = ns_server_rekey(ns_g_server, command, text); + result = ns_server_rekey(ns_g_server, lex, text); } else if (command_compare(command, NS_COMMAND_ADDZONE)) { - result = ns_server_add_zone(ns_g_server, command, text); + result = ns_server_add_zone(ns_g_server, cmdline, text); } else if (command_compare(command, NS_COMMAND_DELZONE)) { - result = ns_server_del_zone(ns_g_server, command, text); + result = ns_server_del_zone(ns_g_server, lex, text); } else if (command_compare(command, NS_COMMAND_SIGNING)) { - result = ns_server_signing(ns_g_server, command, text); + result = ns_server_signing(ns_g_server, lex, text); } else { isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL, NS_LOGMODULE_CONTROL, ISC_LOG_WARNING, @@ -216,5 +251,9 @@ ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text) { result = DNS_R_UNKNOWNCOMMAND; } + cleanup: + if (lex != NULL) + isc_lex_destroy(&lex); + return (result); } diff --git a/bin/named/controlconf.c b/bin/named/controlconf.c index ddb7000ca7aa..afe4a801f999 100644 --- a/bin/named/controlconf.c +++ b/bin/named/controlconf.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2004-2008, 2011-2014, 2016 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2004-2008, 2011-2016 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 2001-2003 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -539,6 +539,10 @@ newconnection(controllistener_t *listener, isc_socket_t *sock) { conn->sock = sock; isccc_ccmsg_init(listener->mctx, sock, &conn->ccmsg); + + /* Set a 32 KiB upper limit on incoming message. */ + isccc_ccmsg_setmaxsize(&conn->ccmsg, 32768); + conn->ccmsg_valid = ISC_TRUE; conn->sending = ISC_FALSE; conn->timer = NULL; diff --git a/bin/named/include/named/log.h b/bin/named/include/named/log.h index 032743acbfb2..adc9ae2897dc 100644 --- a/bin/named/include/named/log.h +++ b/bin/named/include/named/log.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2004, 2005, 2007, 2009 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2004, 2005, 2007, 2009, 2015 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 1999-2002 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -36,7 +36,7 @@ #define NS_LOGCATEGORY_QUERIES (&ns_g_categories[4]) #define NS_LOGCATEGORY_UNMATCHED (&ns_g_categories[5]) #define NS_LOGCATEGORY_UPDATE_SECURITY (&ns_g_categories[6]) -#define NS_LOGCATEGORY_QUERY_EERRORS (&ns_g_categories[7]) +#define NS_LOGCATEGORY_QUERY_ERRORS (&ns_g_categories[7]) /* * Backwards compatibility. diff --git a/bin/named/include/named/query.h b/bin/named/include/named/query.h index 444729a98f77..312602dc805f 100644 --- a/bin/named/include/named/query.h +++ b/bin/named/include/named/query.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2004, 2005, 2007, 2010, 2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2004, 2005, 2007, 2010, 2011, 2013, 2014, 2016 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 1999-2002 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -46,6 +46,7 @@ struct ns_query { isc_boolean_t timerset; dns_name_t * qname; dns_name_t * origqname; + dns_rdatatype_t qtype; unsigned int dboptions; unsigned int fetchoptions; dns_db_t * gluedb; diff --git a/bin/named/include/named/server.h b/bin/named/include/named/server.h index a3696f1614c1..3cb4674a9f29 100644 --- a/bin/named/include/named/server.h +++ b/bin/named/include/named/server.h @@ -15,8 +15,6 @@ * PERFORMANCE OF THIS SOFTWARE. */ -/* $Id$ */ - #ifndef NAMED_SERVER_H #define NAMED_SERVER_H 1 @@ -223,7 +221,8 @@ ns_server_flushonshutdown(ns_server_t *server, isc_boolean_t flush); */ isc_result_t -ns_server_reloadcommand(ns_server_t *server, char *args, isc_buffer_t *text); +ns_server_reloadcommand(ns_server_t *server, isc_lex_t *lex, + isc_buffer_t *text); /*%< * Act on a "reload" command from the command channel. */ @@ -235,26 +234,28 @@ ns_server_reconfigcommand(ns_server_t *server); */ isc_result_t -ns_server_notifycommand(ns_server_t *server, char *args, isc_buffer_t *text); +ns_server_notifycommand(ns_server_t *server, isc_lex_t *lex, + isc_buffer_t *text); /*%< * Act on a "notify" command from the command channel. */ isc_result_t -ns_server_refreshcommand(ns_server_t *server, char *args, isc_buffer_t *text); +ns_server_refreshcommand(ns_server_t *server, isc_lex_t *lex, + isc_buffer_t *text); /*%< * Act on a "refresh" command from the command channel. */ isc_result_t -ns_server_retransfercommand(ns_server_t *server, char *args, +ns_server_retransfercommand(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text); /*%< * Act on a "retransfer" command from the command channel. */ isc_result_t -ns_server_togglequerylog(ns_server_t *server, char *args); +ns_server_togglequerylog(ns_server_t *server, isc_lex_t *lex); /*%< * Enable/disable logging of queries. (Takes "yes" or "no" argument, * but can also be used as a toggle for backward comptibility.) @@ -270,25 +271,25 @@ ns_server_dumpstats(ns_server_t *server); * Dump the current cache to the dump file. */ isc_result_t -ns_server_dumpdb(ns_server_t *server, char *args); +ns_server_dumpdb(ns_server_t *server, isc_lex_t *lex); /*% * Dump the current security roots to the secroots file. */ isc_result_t -ns_server_dumpsecroots(ns_server_t *server, char *args); +ns_server_dumpsecroots(ns_server_t *server, isc_lex_t *lex); /*% * Change or increment the server debug level. */ isc_result_t -ns_server_setdebuglevel(ns_server_t *server, char *args); +ns_server_setdebuglevel(ns_server_t *server, isc_lex_t *lex); /*% * Flush the server's cache(s) */ isc_result_t -ns_server_flushcache(ns_server_t *server, char *args); +ns_server_flushcache(ns_server_t *server, isc_lex_t *lex); /*% * Flush a particular name from the server's cache. If 'tree' is false, @@ -296,7 +297,8 @@ ns_server_flushcache(ns_server_t *server, char *args); * flush all the names under the specified name. */ isc_result_t -ns_server_flushnode(ns_server_t *server, char *args, isc_boolean_t tree); +ns_server_flushnode(ns_server_t *server, isc_lex_t *lex, + isc_boolean_t tree); /*% * Report the server's status. @@ -314,20 +316,21 @@ ns_server_tsiglist(ns_server_t *server, isc_buffer_t *text); * Delete a specific key (with optional view). */ isc_result_t -ns_server_tsigdelete(ns_server_t *server, char *command, isc_buffer_t *text); +ns_server_tsigdelete(ns_server_t *server, isc_lex_t *lex, + isc_buffer_t *text); /*% * Enable or disable updates for a zone. */ isc_result_t -ns_server_freeze(ns_server_t *server, isc_boolean_t freeze, char *args, - isc_buffer_t *text); +ns_server_freeze(ns_server_t *server, isc_boolean_t freeze, + isc_lex_t *lex, isc_buffer_t *text); /*% * Dump zone updates to disk, optionally removing the journal file */ isc_result_t -ns_server_sync(ns_server_t *server, char *args, isc_buffer_t *text); +ns_server_sync(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text); /*% * Update a zone's DNSKEY set from the key repository. If @@ -337,7 +340,7 @@ ns_server_sync(ns_server_t *server, char *args, isc_buffer_t *text); * take place incrementally. */ isc_result_t -ns_server_rekey(ns_server_t *server, char *args, isc_buffer_t *text); +ns_server_rekey(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text); /*% * Dump the current recursive queries. @@ -355,7 +358,7 @@ ns_add_reserved_dispatch(ns_server_t *server, const isc_sockaddr_t *addr); * Enable or disable dnssec validation. */ isc_result_t -ns_server_validation(ns_server_t *server, char *args); +ns_server_validation(ns_server_t *server, isc_lex_t *lex); /*% * Add a zone to a running process @@ -367,11 +370,11 @@ ns_server_add_zone(ns_server_t *server, char *args, isc_buffer_t *text); * Deletes a zone from a running process */ isc_result_t -ns_server_del_zone(ns_server_t *server, char *args, isc_buffer_t *text); +ns_server_del_zone(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text); /*% * Lists the status of the signing records for a given zone. */ isc_result_t -ns_server_signing(ns_server_t *server, char *args, isc_buffer_t *text); +ns_server_signing(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text); #endif /* NAMED_SERVER_H */ diff --git a/bin/named/lwdgrbn.c b/bin/named/lwdgrbn.c index 3e7b15bbdbbf..85dbafdc21d6 100644 --- a/bin/named/lwdgrbn.c +++ b/bin/named/lwdgrbn.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2004-2007, 2009, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2004-2007, 2009, 2013-2016 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 2000, 2001, 2003 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -184,7 +184,7 @@ iterate_node(lwres_grbnresponse_t *grbn, dns_db_t *db, dns_dbnode_t *node, if (oldlens != NULL) isc_mem_put(mctx, oldlens, oldsize * sizeof(*oldlens)); if (newrdatas != NULL) - isc_mem_put(mctx, newrdatas, used * sizeof(*oldrdatas)); + isc_mem_put(mctx, newrdatas, used * sizeof(*newrdatas)); return (result); } @@ -403,14 +403,18 @@ start_lookup(ns_lwdclient_t *client) { INSIST(client->lookup == NULL); dns_fixedname_init(&absname); - result = ns_lwsearchctx_current(&client->searchctx, - dns_fixedname_name(&absname)); + /* - * This will return failure if relative name + suffix is too long. - * In this case, just go on to the next entry in the search path. + * Perform search across all search domains until success + * is returned. Return in case of failure. */ - if (result != ISC_R_SUCCESS) - start_lookup(client); + while (ns_lwsearchctx_current(&client->searchctx, + dns_fixedname_name(&absname)) != ISC_R_SUCCESS) { + if (ns_lwsearchctx_next(&client->searchctx) != ISC_R_SUCCESS) { + ns_lwdclient_errorpktsend(client, LWRES_R_FAILURE); + return; + } + } result = dns_lookup_create(cm->mctx, dns_fixedname_name(&absname), diff --git a/bin/named/lwresd.8 b/bin/named/lwresd.8 index 400e8a7e531b..5c209ea057d0 100644 --- a/bin/named/lwresd.8 +++ b/bin/named/lwresd.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2004, 2005, 2007-2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2004, 2005, 2007-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" Copyright (C) 2000, 2001 Internet Software Consortium. .\" .\" Permission to use, copy, modify, and/or distribute this software for any @@ -13,70 +13,85 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: January 20, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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" -.HP 7 +.HP \w'\fBlwresd\fR\ 'u \fBlwresd\fR [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-C\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] [\fB\-f\fR] [\fB\-g\fR] [\fB\-i\ \fR\fB\fIpid\-file\fR\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [\fB\-n\ \fR\fB\fI#cpus\fR\fR] [\fB\-P\ \fR\fB\fIport\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-s\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-4\fR] [\fB\-6\fR] .SH "DESCRIPTION" .PP \fBlwresd\fR -is the daemon providing name lookup services to clients that use the BIND 9 lightweight resolver library. It is essentially a stripped\-down, caching\-only name server that answers queries using the BIND 9 lightweight resolver protocol rather than the DNS protocol. +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,60 @@ 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<isc/mem.h>\fR. +\fImctx\fR\&. These correspond to the ISC_MEM_DEBUGXXXX flags described in +<isc/mem\&.h>\&. .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. -.RS -.B "Note:" -This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release. +stdout +on exit\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&. +.sp .5v .RE .RE .PP @@ -175,14 +201,25 @@ 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. -.RS -.B "Warning:" +after processing the command line arguments, but before reading the configuration file\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBWarning\fR +.ps -1 +.br 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\&. +.sp .5v .RE .RE .PP @@ -190,34 +227,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 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 307131ad8475..6e3399ecb186 100644 --- a/bin/named/lwresd.docbook +++ b/bin/named/lwresd.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004, 2005, 2007-2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -18,9 +15,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.lwresd"> + <info> + <date>2009-01-20</date> + </info> <refentryinfo> - <date>January 20, 2009</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -42,6 +44,7 @@ <year>2008</year> <year>2009</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> <copyright> @@ -52,29 +55,29 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>lwresd</command> - <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg> - <arg><option>-C <replaceable class="parameter">config-file</replaceable></option></arg> - <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg> - <arg><option>-f</option></arg> - <arg><option>-g</option></arg> - <arg><option>-i <replaceable class="parameter">pid-file</replaceable></option></arg> - <arg><option>-m <replaceable class="parameter">flag</replaceable></option></arg> - <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg> - <arg><option>-P <replaceable class="parameter">port</replaceable></option></arg> - <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg> - <arg><option>-s</option></arg> - <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg> - <arg><option>-v</option></arg> - <arg><option>-4</option></arg> - <arg><option>-6</option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">config-file</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-C <replaceable class="parameter">config-file</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-f</option></arg> + <arg choice="opt" rep="norepeat"><option>-g</option></arg> + <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">pid-file</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">flag</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">port</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-s</option></arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-u <replaceable class="parameter">user</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-v</option></arg> + <arg choice="opt" rep="norepeat"><option>-4</option></arg> + <arg choice="opt" rep="norepeat"><option>-6</option></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>lwresd</command> is the daemon providing name lookup @@ -84,7 +87,7 @@ resolver protocol rather than the DNS protocol. </para> - <para><command>lwresd</command> + <para><command>lwresd</command> listens for resolver queries on a UDP port on the IPv4 loopback interface, 127.0.0.1. This means that <command>lwresd</command> can only be used by @@ -109,10 +112,10 @@ queries autonomously starting at the root name servers, using a built-in list of root server hints. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> @@ -214,7 +217,7 @@ <replaceable class="parameter">trace</replaceable>, <replaceable class="parameter">record</replaceable>, <replaceable class="parameter">size</replaceable>, and - <replaceable class="parameter">mctx</replaceable>. + <replaceable class="parameter">mctx</replaceable>. These correspond to the ISC_MEM_DEBUGXXXX flags described in <filename><isc/mem.h></filename>. </para> @@ -318,10 +321,10 @@ </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>FILES</title></info> - <refsect1> - <title>FILES</title> <variablelist> @@ -345,10 +348,10 @@ </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, @@ -359,16 +362,6 @@ <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum> </citerefentry>. </para> - </refsect1> - - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> + </refsection> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/named/lwresd.html b/bin/named/lwresd.html index 4bef3e262593..c6afd57f6211 100644 --- a/bin/named/lwresd.html +++ b/bin/named/lwresd.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2004, 2005, 2007-2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007-2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -14,15 +14,14 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>lwresd</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> -<a name="id2476282"></a><div class="titlepage"></div> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> +<a name="man.lwresd"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> <p><span class="application">lwresd</span> — lightweight resolver daemon</p> @@ -31,19 +30,19 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">lwresd</code> [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-C <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-d <em class="replaceable"><code>debug-level</code></em></code>] [<code class="option">-f</code>] [<code class="option">-g</code>] [<code class="option">-i <em class="replaceable"><code>pid-file</code></em></code>] [<code class="option">-m <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-n <em class="replaceable"><code>#cpus</code></em></code>] [<code class="option">-P <em class="replaceable"><code>port</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-s</code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>] [<code class="option">-v</code>] [<code class="option">-4</code>] [<code class="option">-6</code>]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543479"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">lwresd</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>lwresd</strong></span> 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. </p> -<p><span><strong class="command">lwresd</strong></span> +<p><span class="command"><strong>lwresd</strong></span> listens for resolver queries on a UDP port on the IPv4 loopback interface, 127.0.0.1. This - means that <span><strong class="command">lwresd</strong></span> can only be used by + means that <span class="command"><strong>lwresd</strong></span> 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. @@ -51,24 +50,24 @@ <p> Incoming lightweight resolver requests are decoded by the server which then resolves them using the DNS protocol. When - the DNS lookup completes, <span><strong class="command">lwresd</strong></span> encodes + the DNS lookup completes, <span class="command"><strong>lwresd</strong></span> encodes the answers in the lightweight resolver format and returns them to the client that made the request. </p> <p> If <code class="filename">/etc/resolv.conf</code> contains any - <code class="option">nameserver</code> entries, <span><strong class="command">lwresd</strong></span> + <code class="option">nameserver</code> entries, <span class="command"><strong>lwresd</strong></span> sends recursive DNS queries to those servers. This is similar to the use of forwarders in a caching name server. If no <code class="option">nameserver</code> entries are present, or if - forwarding fails, <span><strong class="command">lwresd</strong></span> resolves the + forwarding fails, <span class="command"><strong>lwresd</strong></span> resolves the queries autonomously starting at the root name servers, using a built-in list of root server hints. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543526"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-4</span></dt> <dd><p> Use IPv4 only even if the host machine is capable of IPv6. @@ -99,7 +98,7 @@ <dt><span class="term">-d <em class="replaceable"><code>debug-level</code></em></span></dt> <dd><p> Set the daemon's debug level to <em class="replaceable"><code>debug-level</code></em>. - Debugging traces from <span><strong class="command">lwresd</strong></span> become + Debugging traces from <span class="command"><strong>lwresd</strong></span> become more verbose as the debug level increases. </p></dd> <dt><span class="term">-f</span></dt> @@ -124,7 +123,7 @@ <em class="replaceable"><code>trace</code></em>, <em class="replaceable"><code>record</code></em>, <em class="replaceable"><code>size</code></em>, and - <em class="replaceable"><code>mctx</code></em>. + <em class="replaceable"><code>mctx</code></em>. These correspond to the ISC_MEM_DEBUGXXXX flags described in <code class="filename"><isc/mem.h></code>. </p></dd> @@ -132,7 +131,7 @@ <dd><p> Create <em class="replaceable"><code>#cpus</code></em> worker threads to take advantage of multiple CPUs. If not specified, - <span><strong class="command">lwresd</strong></span> will try to determine the + <span class="command"><strong>lwresd</strong></span> 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. @@ -196,9 +195,9 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543943"></a><h2>FILES</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.9"></a><h2>FILES</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term"><code class="filename">/etc/resolv.conf</code></span></dt> <dd><p> The default configuration file. @@ -209,17 +208,12 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543982"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>, <span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2544017"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/named/main.c b/bin/named/main.c index 5664e6545e4c..539366d8b660 100644 --- a/bin/named/main.c +++ b/bin/named/main.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2004-2016 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 1999-2003 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -298,11 +298,13 @@ static void lwresd_usage(void) { fprintf(stderr, "usage: lwresd [-4|-6] [-c conffile | -C resolvconffile] " - "[-d debuglevel]\n" - " [-f|-g] [-n number_of_cpus] [-p port] " - "[-P listen-port] [-s]\n" - " [-t chrootdir] [-u username] [-i pidfile]\n" - " [-m {usage|trace|record|size|mctx}]\n"); + "[-d debuglevel] [-f|-g]\n" + " [-i pidfile] [-n number_of_cpus] " + "[-p port] [-P listen-port]\n" + " [-s] [-S sockets] [-t chrootdir] [-u username] " + "[-U listeners]\n" + " [-m {usage|trace|record|size|mctx}]\n" + "usage: lwresd [-v|-V]\n"); } static void @@ -315,8 +317,10 @@ usage(void) { "usage: named [-4|-6] [-c conffile] [-d debuglevel] " "[-E engine] [-f|-g]\n" " [-n number_of_cpus] [-p port] [-s] " - "[-t chrootdir] [-u username]\n" - " [-m {usage|trace|record|size|mctx}]\n"); + "[-S sockets] [-t chrootdir]\n" + " [-u username] [-U listeners] " + "[-m {usage|trace|record|size|mctx}]\n" + "usage: named [-v|-V]\n"); } static void @@ -609,6 +613,7 @@ parse_command_line(int argc, char *argv[]) { printf("%s %s%s%s <id:%s>\n", ns_g_product, ns_g_version, (*ns_g_description != '\0') ? " " : "", ns_g_description, ns_g_srcid); + printf("running on %s\n", ns_os_uname()); printf("built by %s with %s\n", ns_g_builder, ns_g_configargs); #ifdef __clang__ @@ -677,6 +682,8 @@ create_managers(void) { isc_result_t result; unsigned int socks; + INSIST(ns_g_cpus_detected > 0); + #ifdef ISC_PLATFORM_USETHREADS if (ns_g_cpus == 0) ns_g_cpus = ns_g_cpus_detected; @@ -693,10 +700,8 @@ create_managers(void) { if (ns_g_udpdisp == 0) { if (ns_g_cpus_detected == 1) ns_g_udpdisp = 1; - else if (ns_g_cpus_detected < 4) - ns_g_udpdisp = 2; else - ns_g_udpdisp = ns_g_cpus_detected / 2; + ns_g_udpdisp = ns_g_cpus_detected - 1; } if (ns_g_udpdisp > ns_g_cpus) ns_g_udpdisp = ns_g_cpus; @@ -909,6 +914,9 @@ setup(void) { ns_g_srcid, saved_command_line); isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL, NS_LOGMODULE_MAIN, + ISC_LOG_NOTICE, "running on %s", ns_os_uname()); + + isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL, NS_LOGMODULE_MAIN, ISC_LOG_NOTICE, "built with %s", ns_g_configargs); isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL, NS_LOGMODULE_MAIN, diff --git a/bin/named/named.8 b/bin/named/named.8 index 09bd4c117d28..23e35e580e21 100644 --- a/bin/named/named.8 +++ b/bin/named/named.8 @@ -13,54 +13,69 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: February 20, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2014-02-20 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "NAMED" "8" "February 20, 2014" "BIND9" "BIND9" +.TH "NAMED" "8" "2014\-02\-20" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" named \- Internet domain name server .SH "SYNOPSIS" -.HP 6 +.HP \w'\fBnamed\fR\ 'u \fBnamed\fR [\fB\-4\fR] [\fB\-6\fR] [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] [\fB\-E\ \fR\fB\fIengine\-name\fR\fR] [\fB\-f\fR] [\fB\-g\fR] [\fB\-M\ \fR\fB\fIoption\fR\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [\fB\-n\ \fR\fB\fI#cpus\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-s\fR] [\fB\-S\ \fR\fB\fI#max\-socks\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-U\ \fR\fB\fI#listeners\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-V\fR] [\fB\-x\ \fR\fB\fIcache\-file\fR\fR] .SH "DESCRIPTION" .PP \fBnamed\fR -is a Domain Name System (DNS) server, part of the BIND 9 distribution from ISC. For more information on the DNS, see RFCs 1033, 1034, and 1035. +is a Domain Name System (DNS) server, part of the BIND 9 distribution from ISC\&. For more information on the DNS, see RFCs 1033, 1034, and 1035\&. .PP When invoked without arguments, \fBnamed\fR will read the default configuration file -\fI/etc/named.conf\fR, read any initial data, and listen for queries. +/etc/named\&.conf, read any initial data, and listen for queries\&. .SH "OPTIONS" .PP \-4 .RS 4 -Use IPv4 only even if the host machine is capable of IPv6. +Use IPv4 only even if the host machine is capable of IPv6\&. \fB\-4\fR and \fB\-6\fR -are mutually exclusive. +are mutually exclusive\&. .RE .PP \-6 .RS 4 -Use IPv6 only even if the host machine is capable of IPv4. +Use IPv6 only even if the host machine is capable of IPv4\&. \fB\-4\fR and \fB\-6\fR -are mutually exclusive. +are mutually exclusive\&. .RE .PP \-c \fIconfig\-file\fR @@ -68,79 +83,90 @@ are mutually exclusive. Use \fIconfig\-file\fR as the configuration file instead of the default, -\fI/etc/named.conf\fR. To ensure that reloading the configuration file continues to work after the server has changed its working directory due to to a possible +/etc/named\&.conf\&. To ensure that reloading the configuration file continues to work after the server has changed its working directory due to to a possible \fBdirectory\fR option in the configuration file, \fIconfig\-file\fR -should be an absolute pathname. +should be an absolute pathname\&. .RE .PP \-d \fIdebug\-level\fR .RS 4 -Set the daemon's debug level to -\fIdebug\-level\fR. Debugging traces from +Set the daemon\*(Aqs debug level to +\fIdebug\-level\fR\&. Debugging traces from \fBnamed\fR -become more verbose as the debug level increases. +become more verbose as the debug level increases\&. .RE .PP \-E \fIengine\-name\fR .RS 4 -Use a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance re\-signing with private keys from a secure key store. When compiled with PKCS#11 support +Use a crypto hardware (OpenSSL engine) for the crypto operations it supports, for instance re\-signing with private keys from a secure key store\&. When compiled with PKCS#11 support \fIengine\-name\fR -defaults to pkcs11, the empty name resets it to no engine. +defaults to pkcs11, the empty name resets it to no engine\&. .RE .PP \-f .RS 4 -Run the server in the foreground (i.e. do not daemonize). +Run the server in the foreground (i\&.e\&. do not daemonize)\&. .RE .PP \-g .RS 4 Run the server in the foreground and force all logging to -\fIstderr\fR. +stderr\&. .RE .PP \-M \fIoption\fR .RS 4 -Sets the default memory context options. Currently the only supported option is -\fIexternal\fR, which causes the internal memory manager to be bypassed in favor of system\-provided memory allocation functions. +Sets the default memory context options\&. Currently the only supported option is +\fIexternal\fR, which causes the internal memory manager to be bypassed in favor of system\-provided memory allocation functions\&. .RE .PP \-m \fIflag\fR .RS 4 -Turn on memory usage debugging flags. Possible flags are +Turn on memory usage debugging flags\&. Possible flags are \fIusage\fR, \fItrace\fR, \fIrecord\fR, \fIsize\fR, and -\fImctx\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in -\fI<isc/mem.h>\fR. +\fImctx\fR\&. These correspond to the ISC_MEM_DEBUGXXXX flags described in +<isc/mem\&.h>\&. .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. -.RS -.B "Note:" -This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release. +stdout +on exit\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&. +.sp .5v .RE .RE .PP @@ -150,12 +176,23 @@ Allow \fBnamed\fR to use up to \fI#max\-socks\fR -sockets. -.RS -.B "Warning:" -This option should be unnecessary for the vast majority of users. The use of this option could even be harmful because the specified value may exceed the limitation of the underlying system API. It is therefore set only when the default configuration causes exhaustion of file descriptors and the operational environment is known to support the specified number of sockets. Note also that the actual maximum number is normally a little fewer than the specified value because +sockets\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBWarning\fR +.ps -1 +.br +This option should be unnecessary for the vast majority of users\&. The use of this option could even be harmful because the specified value may exceed the limitation of the underlying system API\&. It is therefore set only when the default configuration causes exhaustion of file descriptors and the operational environment is known to support the specified number of sockets\&. Note also that the actual maximum number is normally a little fewer than the specified value because \fBnamed\fR -reserves some file descriptors for its internal use. +reserves some file descriptors for its internal use\&. +.sp .5v .RE .RE .PP @@ -163,14 +200,25 @@ 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. -.RS -.B "Warning:" +after processing the command line arguments, but before reading the configuration file\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBWarning\fR +.ps -1 +.br 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\&. +.sp .5v .RE .RE .PP @@ -178,115 +226,138 @@ 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. -.RS -.B "Note:" +after completing privileged operations, such as creating sockets that listen on privileged ports\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br 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\&. +.sp .5v .RE .RE .PP \-v .RS 4 -Report the version number and exit. +Report the version number and exit\&. .RE .PP \-V .RS 4 -Report the version number and build options, and exit. +Report the version number and build options, and exit\&. .RE .PP \-x \fIcache\-file\fR .RS 4 Load data from \fIcache\-file\fR -into the cache of the default view. -.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. +into the cache of the default view\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBWarning\fR +.ps -1 +.br +This option must not be used\&. It is only of interest to BIND 9 developers and may be removed or changed in a future release\&. +.sp .5v .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 c4d75437da2e..532e83def831 100644 --- a/bin/named/named.conf.5 +++ b/bin/named/named.conf.5 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2004-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2004-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -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 <http://docbook.sf.net/> -.\" Date: January 08, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2014-01-08 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "\fINAMED.CONF\fR" "5" "January 08, 2014" "BIND9" "BIND9" +.TH "NAMED\&.CONF" "5" "2014\-01\-08" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" named.conf \- configuration file for named .SH "SYNOPSIS" -.HP 11 -\fBnamed.conf\fR +.HP \w'\fBnamed\&.conf\fR\ 'u +\fBnamed\&.conf\fR .SH "DESCRIPTION" .PP -\fInamed.conf\fR +named\&.conf is the configuration file for -\fBnamed\fR. Statements are enclosed in braces and terminated with a semi\-colon. Clauses in the statements are also semi\-colon terminated. The usual comment styles are supported: +\fBnamed\fR\&. Statements are enclosed in braces and terminated with a semi\-colon\&. Clauses in the statements are also semi\-colon terminated\&. The usual comment styles are supported: .PP C style: /* */ .PP @@ -46,34 +61,48 @@ C++ style: // to end of line Unix style: # to end of line .SH "ACL" .sp +.if n \{\ .RS 4 +.\} .nf -acl \fIstring\fR { \fIaddress_match_element\fR; ... }; +acl \fIstring\fR { \fIaddress_match_element\fR; \&.\&.\&. }; .fi +.if n \{\ .RE +.\} .SH "KEY" .sp +.if n \{\ .RS 4 +.\} .nf key \fIdomain_name\fR { algorithm \fIstring\fR; secret \fIstring\fR; }; .fi +.if n \{\ .RE +.\} .SH "MASTERS" .sp +.if n \{\ .RS 4 +.\} .nf masters \fIstring\fR [ port \fIinteger\fR ] { ( \fImasters\fR | \fIipv4_address\fR [port \fIinteger\fR] | - \fIipv6_address\fR [port \fIinteger\fR] ) [ key \fIstring\fR ]; ... + \fIipv6_address\fR [port \fIinteger\fR] ) [ key \fIstring\fR ]; \&.\&.\&. }; .fi +.if n \{\ .RE +.\} .SH "SERVER" .sp +.if n \{\ .RS 4 +.\} .nf server ( \fIipv4_address\fR\fI[/prefixlen]\fR | \fIipv6_address\fR\fI[/prefixlen]\fR ) { bogus \fIboolean\fR; @@ -92,41 +121,57 @@ server ( \fIipv4_address\fR\fI[/prefixlen]\fR | \fIipv6_address\fR\fI[/prefixlen support\-ixfr \fIboolean\fR; // obsolete }; .fi +.if n \{\ .RE -.SH "TRUSTED\-KEYS" +.\} +.SH "TRUSTED-KEYS" .sp +.if n \{\ .RS 4 +.\} .nf trusted\-keys { - \fIdomain_name\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; ... + \fIdomain_name\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; \&.\&.\&. }; .fi +.if n \{\ .RE -.SH "MANAGED\-KEYS" +.\} +.SH "MANAGED-KEYS" .sp +.if n \{\ .RS 4 +.\} .nf managed\-keys { - \fIdomain_name\fR \fBinitial\-key\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; ... + \fIdomain_name\fR \fBinitial\-key\fR \fIflags\fR \fIprotocol\fR \fIalgorithm\fR \fIkey\fR; \&.\&.\&. }; .fi +.if n \{\ .RE +.\} .SH "CONTROLS" .sp +.if n \{\ .RS 4 +.\} .nf controls { inet ( \fIipv4_address\fR | \fIipv6_address\fR | * ) [ port ( \fIinteger\fR | * ) ] - allow { \fIaddress_match_element\fR; ... } - [ keys { \fIstring\fR; ... } ]; + allow { \fIaddress_match_element\fR; \&.\&.\&. } + [ keys { \fIstring\fR; \&.\&.\&. } ]; unix \fIunsupported\fR; // not implemented }; .fi +.if n \{\ .RE +.\} .SH "LOGGING" .sp +.if n \{\ .RS 4 +.\} .nf logging { channel \fIstring\fR { @@ -139,32 +184,40 @@ logging { print\-severity \fIboolean\fR; print\-category \fIboolean\fR; }; - category \fIstring\fR { \fIstring\fR; ... }; + category \fIstring\fR { \fIstring\fR; \&.\&.\&. }; }; .fi +.if n \{\ .RE +.\} .SH "LWRES" .sp +.if n \{\ .RS 4 +.\} .nf lwres { listen\-on [ port \fIinteger\fR ] { - ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ... + ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&. }; view \fIstring\fR \fIoptional_class\fR; - search { \fIstring\fR; ... }; + search { \fIstring\fR; \&.\&.\&. }; ndots \fIinteger\fR; }; .fi +.if n \{\ .RE +.\} .SH "OPTIONS" .sp +.if n \{\ .RS 4 +.\} .nf options { - avoid\-v4\-udp\-ports { \fIport\fR; ... }; - avoid\-v6\-udp\-ports { \fIport\fR; ... }; - blackhole { \fIaddress_match_element\fR; ... }; + avoid\-v4\-udp\-ports { \fIport\fR; \&.\&.\&. }; + avoid\-v6\-udp\-ports { \fIport\fR; \&.\&.\&. }; + blackhole { \fIaddress_match_element\fR; \&.\&.\&. }; coresize \fIsize\fR; datasize \fIsize\fR; directory \fIquoted_string\fR; @@ -175,8 +228,8 @@ options { host\-statistics\-max \fInumber\fR; // not implemented hostname ( \fIquoted_string\fR | none ); interface\-interval \fIinteger\fR; - listen\-on [ port \fIinteger\fR ] { \fIaddress_match_element\fR; ... }; - listen\-on\-v6 [ port \fIinteger\fR ] { \fIaddress_match_element\fR; ... }; + listen\-on [ port \fIinteger\fR ] { \fIaddress_match_element\fR; \&.\&.\&. }; + listen\-on\-v6 [ port \fIinteger\fR ] { \fIaddress_match_element\fR; \&.\&.\&. }; match\-mapped\-addresses \fIboolean\fR; memstatistics\-file \fIquoted_string\fR; pid\-file ( \fIquoted_string\fR | none ); @@ -200,18 +253,17 @@ options { transfers\-per\-ns \fIinteger\fR; transfers\-in \fIinteger\fR; transfers\-out \fIinteger\fR; - use\-ixfr \fIboolean\fR; version ( \fIquoted_string\fR | none ); - allow\-recursion { \fIaddress_match_element\fR; ... }; - allow\-recursion\-on { \fIaddress_match_element\fR; ... }; - sortlist { \fIaddress_match_element\fR; ... }; - topology { \fIaddress_match_element\fR; ... }; // not implemented + allow\-recursion { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-recursion\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + sortlist { \fIaddress_match_element\fR; \&.\&.\&. }; + topology { \fIaddress_match_element\fR; \&.\&.\&. }; // not implemented auth\-nxdomain \fIboolean\fR; // default changed minimal\-responses \fIboolean\fR; recursion \fIboolean\fR; rrset\-order { [ class \fIstring\fR ] [ type \fIstring\fR ] - [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; ... + [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; \&.\&.\&. }; provide\-ixfr \fIboolean\fR; request\-ixfr \fIboolean\fR; @@ -246,12 +298,12 @@ options { dual\-stack\-servers [ port \fIinteger\fR ] { ( \fIquoted_string\fR [port \fIinteger\fR] | \fIipv4_address\fR [port \fIinteger\fR] | - \fIipv6_address\fR [port \fIinteger\fR] ); ... + \fIipv6_address\fR [port \fIinteger\fR] ); \&.\&.\&. }; edns\-udp\-size \fIinteger\fR; max\-udp\-size \fIinteger\fR; - root\-delegation\-only [ exclude { \fIquoted_string\fR; ... } ]; - disable\-algorithms \fIstring\fR { \fIstring\fR; ... }; + root\-delegation\-only [ exclude { \fIquoted_string\fR; \&.\&.\&. } ]; + disable\-algorithms \fIstring\fR { \fIstring\fR; \&.\&.\&. }; dnssec\-enable \fIboolean\fR; dnssec\-validation \fIboolean\fR; dnssec\-lookaside ( \fIauto\fR | \fIno\fR | \fIdomain\fR trust\-anchor \fIdomain\fR ); @@ -273,13 +325,13 @@ options { disable\-empty\-zone \fIstring\fR; dialup \fIdialuptype\fR; ixfr\-from\-differences \fIixfrdiff\fR; - allow\-query { \fIaddress_match_element\fR; ... }; - allow\-query\-on { \fIaddress_match_element\fR; ... }; - allow\-query\-cache { \fIaddress_match_element\fR; ... }; - allow\-query\-cache\-on { \fIaddress_match_element\fR; ... }; - allow\-transfer { \fIaddress_match_element\fR; ... }; - allow\-update { \fIaddress_match_element\fR; ... }; - allow\-update\-forwarding { \fIaddress_match_element\fR; ... }; + allow\-query { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-cache { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-cache\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-transfer { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update\-forwarding { \fIaddress_match_element\fR; \&.\&.\&. }; update\-check\-ksk \fIboolean\fR; dnssec\-dnskey\-kskonly \fIboolean\fR; masterfile\-format ( text | raw ); @@ -289,12 +341,12 @@ options { notify\-delay \fIseconds\fR; notify\-to\-soa \fIboolean\fR; also\-notify [ port \fIinteger\fR ] { ( \fIipv4_address\fR | \fIipv6_address\fR ) - [ port \fIinteger\fR ]; ... - [ key \fIkeyname\fR ] ... }; - allow\-notify { \fIaddress_match_element\fR; ... }; + [ port \fIinteger\fR ]; \&.\&.\&. + [ key \fIkeyname\fR ] \&.\&.\&. }; + allow\-notify { \fIaddress_match_element\fR; \&.\&.\&. }; forward ( first | only ); forwarders [ port \fIinteger\fR ] { - ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ... + ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&. }; max\-journal\-size \fIsize_no_default\fR; max\-transfer\-time\-in \fIinteger\fR; @@ -335,7 +387,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 @@ -347,41 +399,46 @@ options { serial\-queries \fIinteger\fR; // obsolete treat\-cr\-as\-space \fIboolean\fR; // obsolete use\-id\-pool \fIboolean\fR; // obsolete + use\-ixfr \fIboolean\fR; // obsolete }; .fi +.if n \{\ .RE +.\} .SH "VIEW" .sp +.if n \{\ .RS 4 +.\} .nf view \fIstring\fR \fIoptional_class\fR { - match\-clients { \fIaddress_match_element\fR; ... }; - match\-destinations { \fIaddress_match_element\fR; ... }; + match\-clients { \fIaddress_match_element\fR; \&.\&.\&. }; + match\-destinations { \fIaddress_match_element\fR; \&.\&.\&. }; match\-recursive\-only \fIboolean\fR; key \fIstring\fR { algorithm \fIstring\fR; secret \fIstring\fR; }; zone \fIstring\fR \fIoptional_class\fR { - ... + \&.\&.\&. }; server ( \fIipv4_address\fR\fI[/prefixlen]\fR | \fIipv6_address\fR\fI[/prefixlen]\fR ) { - ... + \&.\&.\&. }; trusted\-keys { \fIstring\fR \fIinteger\fR \fIinteger\fR \fIinteger\fR \fIquoted_string\fR; - [...] + [\&.\&.\&.] }; - allow\-recursion { \fIaddress_match_element\fR; ... }; - allow\-recursion\-on { \fIaddress_match_element\fR; ... }; - sortlist { \fIaddress_match_element\fR; ... }; - topology { \fIaddress_match_element\fR; ... }; // not implemented + allow\-recursion { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-recursion\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + sortlist { \fIaddress_match_element\fR; \&.\&.\&. }; + topology { \fIaddress_match_element\fR; \&.\&.\&. }; // not implemented auth\-nxdomain \fIboolean\fR; // default changed minimal\-responses \fIboolean\fR; recursion \fIboolean\fR; rrset\-order { [ class \fIstring\fR ] [ type \fIstring\fR ] - [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; ... + [ name \fIquoted_string\fR ] \fIstring\fR \fIstring\fR; \&.\&.\&. }; provide\-ixfr \fIboolean\fR; request\-ixfr \fIboolean\fR; @@ -416,12 +473,12 @@ view \fIstring\fR \fIoptional_class\fR { dual\-stack\-servers [ port \fIinteger\fR ] { ( \fIquoted_string\fR [port \fIinteger\fR] | \fIipv4_address\fR [port \fIinteger\fR] | - \fIipv6_address\fR [port \fIinteger\fR] ); ... + \fIipv6_address\fR [port \fIinteger\fR] ); \&.\&.\&. }; edns\-udp\-size \fIinteger\fR; max\-udp\-size \fIinteger\fR; - root\-delegation\-only [ exclude { \fIquoted_string\fR; ... } ]; - disable\-algorithms \fIstring\fR { \fIstring\fR; ... }; + root\-delegation\-only [ exclude { \fIquoted_string\fR; \&.\&.\&. } ]; + disable\-algorithms \fIstring\fR { \fIstring\fR; \&.\&.\&. }; dnssec\-enable \fIboolean\fR; dnssec\-validation \fIboolean\fR; dnssec\-lookaside ( \fIauto\fR | \fIno\fR | \fIdomain\fR trust\-anchor \fIdomain\fR ); @@ -443,13 +500,13 @@ view \fIstring\fR \fIoptional_class\fR { disable\-empty\-zone \fIstring\fR; dialup \fIdialuptype\fR; ixfr\-from\-differences \fIixfrdiff\fR; - allow\-query { \fIaddress_match_element\fR; ... }; - allow\-query\-on { \fIaddress_match_element\fR; ... }; - allow\-query\-cache { \fIaddress_match_element\fR; ... }; - allow\-query\-cache\-on { \fIaddress_match_element\fR; ... }; - allow\-transfer { \fIaddress_match_element\fR; ... }; - allow\-update { \fIaddress_match_element\fR; ... }; - allow\-update\-forwarding { \fIaddress_match_element\fR; ... }; + allow\-query { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-cache { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-cache\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-transfer { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update\-forwarding { \fIaddress_match_element\fR; \&.\&.\&. }; update\-check\-ksk \fIboolean\fR; dnssec\-dnskey\-kskonly \fIboolean\fR; masterfile\-format ( text | raw ); @@ -459,12 +516,12 @@ view \fIstring\fR \fIoptional_class\fR { notify\-delay \fIseconds\fR; notify\-to\-soa \fIboolean\fR; also\-notify [ port \fIinteger\fR ] { ( \fIipv4_address\fR | \fIipv6_address\fR ) - [ port \fIinteger\fR ]; ... - [ key \fIkeyname\fR ] ... }; - allow\-notify { \fIaddress_match_element\fR; ... }; + [ port \fIinteger\fR ]; \&.\&.\&. + [ key \fIkeyname\fR ] \&.\&.\&. }; + allow\-notify { \fIaddress_match_element\fR; \&.\&.\&. }; forward ( first | only ); forwarders [ port \fIinteger\fR ] { - ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ... + ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&. }; max\-journal\-size \fIsize_no_default\fR; max\-transfer\-time\-in \fIinteger\fR; @@ -492,16 +549,20 @@ view \fIstring\fR \fIoptional_class\fR { zero\-no\-soa\-ttl \fIboolean\fR; zero\-no\-soa\-ttl\-cache \fIboolean\fR; dnssec\-secure\-to\-insecure \fIboolean\fR; - allow\-v6\-synthesis { \fIaddress_match_element\fR; ... }; // obsolete + allow\-v6\-synthesis { \fIaddress_match_element\fR; \&.\&.\&. }; // obsolete fetch\-glue \fIboolean\fR; // obsolete maintain\-ixfr\-base \fIboolean\fR; // obsolete max\-ixfr\-log\-size \fIsize\fR; // obsolete }; .fi +.if n \{\ .RE +.\} .SH "ZONE" .sp +.if n \{\ .RS 4 +.\} .nf zone \fIstring\fR \fIoptional_class\fR { type ( master | slave | stub | hint | redirect | @@ -510,7 +571,7 @@ zone \fIstring\fR \fIoptional_class\fR { masters [ port \fIinteger\fR ] { ( \fImasters\fR | \fIipv4_address\fR [port \fIinteger\fR] | - \fIipv6_address\fR [ port \fIinteger\fR ] ) [ key \fIstring\fR ]; ... + \fIipv6_address\fR [ port \fIinteger\fR ] ) [ key \fIstring\fR ]; \&.\&.\&. }; database \fIstring\fR; delegation\-only \fIboolean\fR; @@ -524,18 +585,18 @@ zone \fIstring\fR \fIoptional_class\fR { journal \fIquoted_string\fR; zero\-no\-soa\-ttl \fIboolean\fR; dnssec\-secure\-to\-insecure \fIboolean\fR; - allow\-query { \fIaddress_match_element\fR; ... }; - allow\-query\-on { \fIaddress_match_element\fR; ... }; - allow\-transfer { \fIaddress_match_element\fR; ... }; - allow\-update { \fIaddress_match_element\fR; ... }; - allow\-update\-forwarding { \fIaddress_match_element\fR; ... }; + allow\-query { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-query\-on { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-transfer { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update { \fIaddress_match_element\fR; \&.\&.\&. }; + allow\-update\-forwarding { \fIaddress_match_element\fR; \&.\&.\&. }; update\-policy \fIlocal\fR | \fI { ( grant | deny ) \fR\fI\fIstring\fR\fR\fI ( name | subdomain | wildcard | self | selfsub | selfwild | krb5\-self | ms\-self | krb5\-subdomain | ms\-subdomain | tcp\-self | zonesub | 6to4\-self ) \fR\fI\fIstring\fR\fR\fI \fR\fI\fIrrtypelist\fR\fR\fI; - \fR\fI[...]\fR\fI + \fR\fI[\&.\&.\&.]\fR\fI }\fR; update\-check\-ksk \fIboolean\fR; dnssec\-dnskey\-kskonly \fIboolean\fR; @@ -546,12 +607,12 @@ zone \fIstring\fR \fIoptional_class\fR { notify\-delay \fIseconds\fR; notify\-to\-soa \fIboolean\fR; also\-notify [ port \fIinteger\fR ] { ( \fIipv4_address\fR | \fIipv6_address\fR ) - [ port \fIinteger\fR ]; ... - [ key \fIkeyname\fR ] ... }; - allow\-notify { \fIaddress_match_element\fR; ... }; + [ port \fIinteger\fR ]; \&.\&.\&. + [ key \fIkeyname\fR ] \&.\&.\&. }; + allow\-notify { \fIaddress_match_element\fR; \&.\&.\&. }; forward ( first | only ); forwarders [ port \fIinteger\fR ] { - ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; ... + ( \fIipv4_address\fR | \fIipv6_address\fR ) [ port \fIinteger\fR ]; \&.\&.\&. }; max\-journal\-size \fIsize_no_default\fR; max\-transfer\-time\-in \fIinteger\fR; @@ -585,16 +646,22 @@ zone \fIstring\fR \fIoptional_class\fR { pubkey \fIinteger\fR \fIinteger\fR \fIinteger\fR \fIquoted_string\fR; // obsolete }; .fi +.if n \{\ .RE +.\} .SH "FILES" .PP -\fI/etc/named.conf\fR +/etc/named\&.conf .SH "SEE ALSO" .PP \fBnamed\fR(8), -\fBnamed\-checkconf\fR(8), +\fBnamed-checkconf\fR(8), \fBrndc\fR(8), -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2004-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/named/named.conf.docbook b/bin/named/named.conf.docbook index 85d13db95d39..01cb62aaa009 100644 --- a/bin/named/named.conf.docbook +++ b/bin/named/named.conf.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named.conf"> + <info> + <date>2014-01-08</date> + </info> <refentryinfo> - <date>January 08, 2014</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -45,18 +47,19 @@ <year>2011</year> <year>2013</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>named.conf</command> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><filename>named.conf</filename> is the configuration file for <command>named</command>. Statements are enclosed @@ -73,39 +76,39 @@ <para> Unix style: # to end of line </para> - </refsect1> + </refsection> + + <refsection><info><title>ACL</title></info> - <refsect1> - <title>ACL</title> - <literallayout> + <literallayout class="normal"> acl <replaceable>string</replaceable> { <replaceable>address_match_element</replaceable>; ... }; </literallayout> - </refsect1> + </refsection> - <refsect1> - <title>KEY</title> - <literallayout> + <refsection><info><title>KEY</title></info> + + <literallayout class="normal"> key <replaceable>domain_name</replaceable> { algorithm <replaceable>string</replaceable>; secret <replaceable>string</replaceable>; }; </literallayout> - </refsect1> + </refsection> + + <refsection><info><title>MASTERS</title></info> - <refsect1> - <title>MASTERS</title> - <literallayout> + <literallayout class="normal"> masters <replaceable>string</replaceable> <optional> port <replaceable>integer</replaceable> </optional> { ( <replaceable>masters</replaceable> | <replaceable>ipv4_address</replaceable> <optional>port <replaceable>integer</replaceable></optional> | <replaceable>ipv6_address</replaceable> <optional>port <replaceable>integer</replaceable></optional> ) <optional> key <replaceable>string</replaceable> </optional>; ... }; </literallayout> - </refsect1> + </refsection> - <refsect1> - <title>SERVER</title> - <literallayout> + <refsection><info><title>SERVER</title></info> + + <literallayout class="normal"> server ( <replaceable>ipv4_address<optional>/prefixlen</optional></replaceable> | <replaceable>ipv6_address<optional>/prefixlen</optional></replaceable> ) { bogus <replaceable>boolean</replaceable>; edns <replaceable>boolean</replaceable>; @@ -124,29 +127,29 @@ server ( <replaceable>ipv4_address<optional>/prefixlen</optional></replaceable> support-ixfr <replaceable>boolean</replaceable>; // obsolete }; </literallayout> - </refsect1> + </refsection> + + <refsection><info><title>TRUSTED-KEYS</title></info> - <refsect1> - <title>TRUSTED-KEYS</title> - <literallayout> + <literallayout class="normal"> trusted-keys { - <replaceable>domain_name</replaceable> <replaceable>flags</replaceable> <replaceable>protocol</replaceable> <replaceable>algorithm</replaceable> <replaceable>key</replaceable>; ... + <replaceable>domain_name</replaceable> <replaceable>flags</replaceable> <replaceable>protocol</replaceable> <replaceable>algorithm</replaceable> <replaceable>key</replaceable>; ... }; </literallayout> - </refsect1> + </refsection> - <refsect1> - <title>MANAGED-KEYS</title> - <literallayout> + <refsection><info><title>MANAGED-KEYS</title></info> + + <literallayout class="normal"> managed-keys { - <replaceable>domain_name</replaceable> <constant>initial-key</constant> <replaceable>flags</replaceable> <replaceable>protocol</replaceable> <replaceable>algorithm</replaceable> <replaceable>key</replaceable>; ... + <replaceable>domain_name</replaceable> <constant>initial-key</constant> <replaceable>flags</replaceable> <replaceable>protocol</replaceable> <replaceable>algorithm</replaceable> <replaceable>key</replaceable>; ... }; </literallayout> - </refsect1> + </refsection> + + <refsection><info><title>CONTROLS</title></info> - <refsect1> - <title>CONTROLS</title> - <literallayout> + <literallayout class="normal"> controls { inet ( <replaceable>ipv4_address</replaceable> | <replaceable>ipv6_address</replaceable> | * ) <optional> port ( <replaceable>integer</replaceable> | * ) </optional> @@ -155,11 +158,11 @@ controls { unix <replaceable>unsupported</replaceable>; // not implemented }; </literallayout> - </refsect1> + </refsection> - <refsect1> - <title>LOGGING</title> - <literallayout> + <refsection><info><title>LOGGING</title></info> + + <literallayout class="normal"> logging { channel <replaceable>string</replaceable> { file <replaceable>log_file</replaceable>; @@ -174,11 +177,11 @@ logging { category <replaceable>string</replaceable> { <replaceable>string</replaceable>; ... }; }; </literallayout> - </refsect1> + </refsection> + + <refsection><info><title>LWRES</title></info> - <refsect1> - <title>LWRES</title> - <literallayout> + <literallayout class="normal"> lwres { listen-on <optional> port <replaceable>integer</replaceable> </optional> { ( <replaceable>ipv4_address</replaceable> | <replaceable>ipv6_address</replaceable> ) <optional> port <replaceable>integer</replaceable> </optional>; ... @@ -188,11 +191,11 @@ lwres { ndots <replaceable>integer</replaceable>; }; </literallayout> - </refsect1> + </refsection> - <refsect1> - <title>OPTIONS</title> - <literallayout> + <refsection><info><title>OPTIONS</title></info> + + <literallayout class="normal"> options { avoid-v4-udp-ports { <replaceable>port</replaceable>; ... }; avoid-v6-udp-ports { <replaceable>port</replaceable>; ... }; @@ -232,7 +235,6 @@ options { transfers-per-ns <replaceable>integer</replaceable>; transfers-in <replaceable>integer</replaceable>; transfers-out <replaceable>integer</replaceable>; - use-ixfr <replaceable>boolean</replaceable>; version ( <replaceable>quoted_string</replaceable> | none ); allow-recursion { <replaceable>address_match_element</replaceable>; ... }; allow-recursion-on { <replaceable>address_match_element</replaceable>; ... }; @@ -392,13 +394,14 @@ options { serial-queries <replaceable>integer</replaceable>; // obsolete treat-cr-as-space <replaceable>boolean</replaceable>; // obsolete use-id-pool <replaceable>boolean</replaceable>; // obsolete + use-ixfr <replaceable>boolean</replaceable>; // obsolete }; </literallayout> - </refsect1> + </refsection> + + <refsection><info><title>VIEW</title></info> - <refsect1> - <title>VIEW</title> - <literallayout> + <literallayout class="normal"> view <replaceable>string</replaceable> <replaceable>optional_class</replaceable> { match-clients { <replaceable>address_match_element</replaceable>; ... }; match-destinations { <replaceable>address_match_element</replaceable>; ... }; @@ -559,11 +562,11 @@ view <replaceable>string</replaceable> <replaceable>optional_class</replaceable> max-ixfr-log-size <replaceable>size</replaceable>; // obsolete }; </literallayout> - </refsect1> + </refsection> - <refsect1> - <title>ZONE</title> - <literallayout> + <refsection><info><title>ZONE</title></info> + + <literallayout class="normal"> zone <replaceable>string</replaceable> <replaceable>optional_class</replaceable> { type ( master | slave | stub | hint | redirect | forward | delegation-only ); @@ -657,16 +660,16 @@ zone <replaceable>string</replaceable> <replaceable>optional_class</replaceable> pubkey <replaceable>integer</replaceable> <replaceable>integer</replaceable> <replaceable>integer</replaceable> <replaceable>quoted_string</replaceable>; // obsolete }; </literallayout> - </refsect1> + </refsection> + + <refsection><info><title>FILES</title></info> - <refsect1> - <title>FILES</title> <para><filename>/etc/named.conf</filename> </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, @@ -678,10 +681,6 @@ zone <replaceable>string</replaceable> <replaceable>optional_class</replaceable> </citerefentry>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>. </para> - </refsect1> + </refsection> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/named/named.conf.html b/bin/named/named.conf.html index 0e1d2eb60da3..e21dd36c886f 100644 --- a/bin/named/named.conf.html +++ b/bin/named/named.conf.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2004-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,15 +13,14 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>named.conf</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> -<a name="id2476282"></a><div class="titlepage"></div> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> +<a name="man.named.conf"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> <p><code class="filename">named.conf</code> — configuration file for named</p> @@ -30,11 +29,11 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">named.conf</code> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543367"></a><h2>DESCRIPTION</h2> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> <p><code class="filename">named.conf</code> is the configuration file for - <span><strong class="command">named</strong></span>. Statements are enclosed + <span class="command"><strong>named</strong></span>. 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: @@ -49,15 +48,15 @@ Unix style: # to end of line </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543395"></a><h2>ACL</h2> +<div class="refsection"> +<a name="id-1.8"></a><h2>ACL</h2> <div class="literallayout"><p><br> acl <em class="replaceable"><code>string</code></em> { <em class="replaceable"><code>address_match_element</code></em>; ... };<br> <br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543411"></a><h2>KEY</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>KEY</h2> <div class="literallayout"><p><br> key <em class="replaceable"><code>domain_name</code></em> {<br> algorithm <em class="replaceable"><code>string</code></em>;<br> @@ -65,8 +64,8 @@ key <em class="replaceable"><code>domain_name</code></em> {<br> };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543430"></a><h2>MASTERS</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>MASTERS</h2> <div class="literallayout"><p><br> masters <em class="replaceable"><code>string</code></em> [<span class="optional"> port <em class="replaceable"><code>integer</code></em> </span>] {<br> ( <em class="replaceable"><code>masters</code></em> | <em class="replaceable"><code>ipv4_address</code></em> [<span class="optional">port <em class="replaceable"><code>integer</code></em></span>] |<br> @@ -74,8 +73,8 @@ masters <em class="replaceable"><code>string</code></em> [<span class="optional" };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543476"></a><h2>SERVER</h2> +<div class="refsection"> +<a name="id-1.11"></a><h2>SERVER</h2> <div class="literallayout"><p><br> server ( <em class="replaceable"><code>ipv4_address[<span class="optional">/prefixlen</span>]</code></em> | <em class="replaceable"><code>ipv6_address[<span class="optional">/prefixlen</span>]</code></em> ) {<br> bogus <em class="replaceable"><code>boolean</code></em>;<br> @@ -96,24 +95,24 @@ server ( <em class="replaceable"><code>ipv4_address[<span class="optional">/pref };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543544"></a><h2>TRUSTED-KEYS</h2> +<div class="refsection"> +<a name="id-1.12"></a><h2>TRUSTED-KEYS</h2> <div class="literallayout"><p><br> trusted-keys {<br> - <em class="replaceable"><code>domain_name</code></em> <em class="replaceable"><code>flags</code></em> <em class="replaceable"><code>protocol</code></em> <em class="replaceable"><code>algorithm</code></em> <em class="replaceable"><code>key</code></em>; ... <br> + <em class="replaceable"><code>domain_name</code></em> <em class="replaceable"><code>flags</code></em> <em class="replaceable"><code>protocol</code></em> <em class="replaceable"><code>algorithm</code></em> <em class="replaceable"><code>key</code></em>; ...<br> };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543570"></a><h2>MANAGED-KEYS</h2> +<div class="refsection"> +<a name="id-1.13"></a><h2>MANAGED-KEYS</h2> <div class="literallayout"><p><br> managed-keys {<br> - <em class="replaceable"><code>domain_name</code></em> <code class="constant">initial-key</code> <em class="replaceable"><code>flags</code></em> <em class="replaceable"><code>protocol</code></em> <em class="replaceable"><code>algorithm</code></em> <em class="replaceable"><code>key</code></em>; ... <br> + <em class="replaceable"><code>domain_name</code></em> <code class="constant">initial-key</code> <em class="replaceable"><code>flags</code></em> <em class="replaceable"><code>protocol</code></em> <em class="replaceable"><code>algorithm</code></em> <em class="replaceable"><code>key</code></em>; ...<br> };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543598"></a><h2>CONTROLS</h2> +<div class="refsection"> +<a name="id-1.14"></a><h2>CONTROLS</h2> <div class="literallayout"><p><br> controls {<br> inet ( <em class="replaceable"><code>ipv4_address</code></em> | <em class="replaceable"><code>ipv6_address</code></em> | * )<br> @@ -124,8 +123,8 @@ controls {<br> };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543634"></a><h2>LOGGING</h2> +<div class="refsection"> +<a name="id-1.15"></a><h2>LOGGING</h2> <div class="literallayout"><p><br> logging {<br> channel <em class="replaceable"><code>string</code></em> {<br> @@ -142,8 +141,8 @@ logging {<br> };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543672"></a><h2>LWRES</h2> +<div class="refsection"> +<a name="id-1.16"></a><h2>LWRES</h2> <div class="literallayout"><p><br> lwres {<br> listen-on [<span class="optional"> port <em class="replaceable"><code>integer</code></em> </span>] {<br> @@ -155,8 +154,8 @@ lwres {<br> };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543714"></a><h2>OPTIONS</h2> +<div class="refsection"> +<a name="id-1.17"></a><h2>OPTIONS</h2> <div class="literallayout"><p><br> options {<br> avoid-v4-udp-ports { <em class="replaceable"><code>port</code></em>; ... };<br> @@ -197,7 +196,6 @@ options {<br> transfers-per-ns <em class="replaceable"><code>integer</code></em>;<br> transfers-in <em class="replaceable"><code>integer</code></em>;<br> transfers-out <em class="replaceable"><code>integer</code></em>;<br> - use-ixfr <em class="replaceable"><code>boolean</code></em>;<br> version ( <em class="replaceable"><code>quoted_string</code></em> | none );<br> allow-recursion { <em class="replaceable"><code>address_match_element</code></em>; ... };<br> allow-recursion-on { <em class="replaceable"><code>address_match_element</code></em>; ... };<br> @@ -258,9 +256,9 @@ options {<br> dns64-server <em class="replaceable"><code>string</code></em>;<br> dns64-contact <em class="replaceable"><code>string</code></em>;<br> dns64 <em class="replaceable"><code>prefix</code></em> {<br> - clients { <font color="red"><replacable>acl</replacable></font>; };<br> - exclude { <font color="red"><replacable>acl</replacable></font>; };<br> - mapped { <font color="red"><replacable>acl</replacable></font>; };<br> + clients { <span style="color: red"><replacable>acl</replacable></span>; };<br> + exclude { <span style="color: red"><replacable>acl</replacable></span>; };<br> + mapped { <span style="color: red"><replacable>acl</replacable></span>; };<br> break-dnssec <em class="replaceable"><code>boolean</code></em>;<br> recursive-only <em class="replaceable"><code>boolean</code></em>;<br> suffix <em class="replaceable"><code>ipv6_address</code></em>;<br> @@ -357,11 +355,12 @@ options {<br> serial-queries <em class="replaceable"><code>integer</code></em>; // obsolete<br> treat-cr-as-space <em class="replaceable"><code>boolean</code></em>; // obsolete<br> use-id-pool <em class="replaceable"><code>boolean</code></em>; // obsolete<br> + use-ixfr <em class="replaceable"><code>boolean</code></em>; // obsolete<br> };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2544593"></a><h2>VIEW</h2> +<div class="refsection"> +<a name="id-1.18"></a><h2>VIEW</h2> <div class="literallayout"><p><br> view <em class="replaceable"><code>string</code></em> <em class="replaceable"><code>optional_class</code></em> {<br> match-clients { <em class="replaceable"><code>address_match_element</code></em>; ... };<br> @@ -445,9 +444,9 @@ view <em class="replaceable"><code>string</code></em> <em class="replaceable"><c dns64-server <em class="replaceable"><code>string</code></em>;<br> dns64-contact <em class="replaceable"><code>string</code></em>;<br> dns64 <em class="replaceable"><code>prefix</code></em> {<br> - clients { <font color="red"><replacable>acl</replacable></font>; };<br> - exclude { <font color="red"><replacable>acl</replacable></font>; };<br> - mapped { <font color="red"><replacable>acl</replacable></font>; };<br> + clients { <span style="color: red"><replacable>acl</replacable></span>; };<br> + exclude { <span style="color: red"><replacable>acl</replacable></span>; };<br> + mapped { <span style="color: red"><replacable>acl</replacable></span>; };<br> break-dnssec <em class="replaceable"><code>boolean</code></em>;<br> recursive-only <em class="replaceable"><code>boolean</code></em>;<br> suffix <em class="replaceable"><code>ipv6_address</code></em>;<br> @@ -524,8 +523,8 @@ view <em class="replaceable"><code>string</code></em> <em class="replaceable"><c };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2545308"></a><h2>ZONE</h2> +<div class="refsection"> +<a name="id-1.19"></a><h2>ZONE</h2> <div class="literallayout"><p><br> zone <em class="replaceable"><code>string</code></em> <em class="replaceable"><code>optional_class</code></em> {<br> type ( master | slave | stub | hint | redirect |<br> @@ -621,13 +620,13 @@ zone <em class="replaceable"><code>string</code></em> <em class="replaceable"><c };<br> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2545698"></a><h2>FILES</h2> +<div class="refsection"> +<a name="id-1.20"></a><h2>FILES</h2> <p><code class="filename">/etc/named.conf</code> </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545709"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.21"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>, diff --git a/bin/named/named.docbook b/bin/named/named.docbook index 0ea469d35766..ff6c00f87e46 100644 --- a/bin/named/named.docbook +++ b/bin/named/named.docbook @@ -1,6 +1,3 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - Copyright (C) 2004-2009, 2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000, 2001, 2003 Internet Software Consortium. @@ -18,9 +15,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.named"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named"> + <info> + <date>2014-02-20</date> + </info> <refentryinfo> - <date>February 20, 2014</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -57,32 +59,32 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>named</command> - <arg><option>-4</option></arg> - <arg><option>-6</option></arg> - <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg> - <arg><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg> - <arg><option>-E <replaceable class="parameter">engine-name</replaceable></option></arg> - <arg><option>-f</option></arg> - <arg><option>-g</option></arg> - <arg><option>-M <replaceable class="parameter">option</replaceable></option></arg> - <arg><option>-m <replaceable class="parameter">flag</replaceable></option></arg> - <arg><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg> - <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg> - <arg><option>-s</option></arg> - <arg><option>-S <replaceable class="parameter">#max-socks</replaceable></option></arg> - <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg> - <arg><option>-U <replaceable class="parameter">#listeners</replaceable></option></arg> - <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg> - <arg><option>-v</option></arg> - <arg><option>-V</option></arg> - <arg><option>-x <replaceable class="parameter">cache-file</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-4</option></arg> + <arg choice="opt" rep="norepeat"><option>-6</option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">config-file</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-d <replaceable class="parameter">debug-level</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-E <replaceable class="parameter">engine-name</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-f</option></arg> + <arg choice="opt" rep="norepeat"><option>-g</option></arg> + <arg choice="opt" rep="norepeat"><option>-M <replaceable class="parameter">option</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">flag</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">#cpus</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-s</option></arg> + <arg choice="opt" rep="norepeat"><option>-S <replaceable class="parameter">#max-socks</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-U <replaceable class="parameter">#listeners</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-u <replaceable class="parameter">user</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-v</option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="opt" rep="norepeat"><option>-x <replaceable class="parameter">cache-file</replaceable></option></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>named</command> is a Domain Name System (DNS) server, part of the BIND 9 distribution from ISC. For more @@ -95,10 +97,10 @@ <filename>/etc/named.conf</filename>, read any initial data, and listen for queries. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -307,11 +309,14 @@ worker threads to listen for incoming UDP packets on each address. If not specified, <command>named</command> 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 <option>-n</option> has been set to a higher value than the number of detected CPUs, then <option>-U</option> 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. </para> </listitem> </varlistentry> @@ -379,10 +384,10 @@ </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>SIGNALS</title></info> - <refsect1> - <title>SIGNALS</title> <para> In routine operation, signals should not be used to control the nameserver; <command>rndc</command> should be used @@ -415,10 +420,10 @@ The result of sending any other signals to the server is undefined. </para> - </refsect1> + </refsection> + + <refsection><info><title>CONFIGURATION</title></info> - <refsect1> - <title>CONFIGURATION</title> <para> The <command>named</command> configuration file is too complex to describe in detail here. A complete description is provided @@ -435,10 +440,10 @@ <command>named</command> process. </para> - </refsect1> + </refsection> + + <refsection><info><title>FILES</title></info> - <refsect1> - <title>FILES</title> <variablelist> @@ -462,10 +467,10 @@ </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citetitle>RFC 1033</citetitle>, <citetitle>RFC 1034</citetitle>, <citetitle>RFC 1035</citetitle>, @@ -491,16 +496,6 @@ </citerefentry>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>. </para> - </refsect1> - - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> + </refsection> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/named/named.html b/bin/named/named.html index 83494ee5d9c0..04a6b19530b0 100644 --- a/bin/named/named.html +++ b/bin/named/named.html @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>named</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.named"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -31,24 +30,24 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">named</code> [<code class="option">-4</code>] [<code class="option">-6</code>] [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-d <em class="replaceable"><code>debug-level</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine-name</code></em></code>] [<code class="option">-f</code>] [<code class="option">-g</code>] [<code class="option">-M <em class="replaceable"><code>option</code></em></code>] [<code class="option">-m <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-n <em class="replaceable"><code>#cpus</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-s</code>] [<code class="option">-S <em class="replaceable"><code>#max-socks</code></em></code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-U <em class="replaceable"><code>#listeners</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>] [<code class="option">-v</code>] [<code class="option">-V</code>] [<code class="option">-x <em class="replaceable"><code>cache-file</code></em></code>]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543518"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">named</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>named</strong></span> 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. </p> <p> - When invoked without arguments, <span><strong class="command">named</strong></span> + When invoked without arguments, <span class="command"><strong>named</strong></span> will read the default configuration file <code class="filename">/etc/named.conf</code>, read any initial data, and listen for queries. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543543"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-4</span></dt> <dd><p> Use IPv4 only even if the host machine is capable of IPv6. @@ -76,7 +75,7 @@ <dt><span class="term">-d <em class="replaceable"><code>debug-level</code></em></span></dt> <dd><p> Set the daemon's debug level to <em class="replaceable"><code>debug-level</code></em>. - Debugging traces from <span><strong class="command">named</strong></span> become + Debugging traces from <span class="command"><strong>named</strong></span> become more verbose as the debug level increases. </p></dd> <dt><span class="term">-E <em class="replaceable"><code>engine-name</code></em></span></dt> @@ -119,7 +118,7 @@ <dd><p> Create <em class="replaceable"><code>#cpus</code></em> worker threads to take advantage of multiple CPUs. If not specified, - <span><strong class="command">named</strong></span> will try to determine the + <span class="command"><strong>named</strong></span> 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. @@ -145,7 +144,7 @@ <dt><span class="term">-S <em class="replaceable"><code>#max-socks</code></em></span></dt> <dd> <p> - Allow <span><strong class="command">named</strong></span> to use up to + Allow <span class="command"><strong>named</strong></span> to use up to <em class="replaceable"><code>#max-socks</code></em> sockets. </p> <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> @@ -162,7 +161,7 @@ specified number of sockets. Note also that the actual maximum number is normally a little fewer than the specified value because - <span><strong class="command">named</strong></span> reserves some file descriptors + <span class="command"><strong>named</strong></span> reserves some file descriptors for its internal use. </p> </div> @@ -190,13 +189,16 @@ <dd><p> Use <em class="replaceable"><code>#listeners</code></em> worker threads to listen for incoming UDP packets on each - address. If not specified, <span><strong class="command">named</strong></span> will + address. If not specified, <span class="command"><strong>named</strong></span> 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 <code class="option">-n</code> has been set to a higher value than the number of detected CPUs, then <code class="option">-U</code> 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. </p></dd> <dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt> <dd> @@ -208,13 +210,13 @@ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> <h3 class="title">Note</h3> <p> - On Linux, <span><strong class="command">named</strong></span> uses the kernel's + On Linux, <span class="command"><strong>named</strong></span> uses the kernel's capability mechanism to drop all root privileges except the ability to <code class="function">bind(2)</code> to a privileged port and set process resource limits. Unfortunately, this means that the <code class="option">-u</code> - option only works when <span><strong class="command">named</strong></span> is + option only works when <span class="command"><strong>named</strong></span> is run on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or later, since previous kernels did not allow privileges @@ -247,14 +249,14 @@ </dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2544192"></a><h2>SIGNALS</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>SIGNALS</h2> <p> In routine operation, signals should not be used to control - the nameserver; <span><strong class="command">rndc</strong></span> should be used + the nameserver; <span class="command"><strong>rndc</strong></span> should be used instead. </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">SIGHUP</span></dt> <dd><p> Force a reload of the server. @@ -268,26 +270,26 @@ The result of sending any other signals to the server is undefined. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2544308"></a><h2>CONFIGURATION</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>CONFIGURATION</h2> <p> - The <span><strong class="command">named</strong></span> configuration file is too complex + The <span class="command"><strong>named</strong></span> configuration file is too complex to describe in detail here. A complete description is provided in the <em class="citetitle">BIND 9 Administrator Reference Manual</em>. </p> <p> - <span><strong class="command">named</strong></span> inherits the <code class="function">umask</code> + <span class="command"><strong>named</strong></span> inherits the <code class="function">umask</code> (file creation mode mask) from the parent process. If files - created by <span><strong class="command">named</strong></span>, such as journal files, + created by <span class="command"><strong>named</strong></span>, such as journal files, need to have custom permissions, the <code class="function">umask</code> should be set explicitly in the script used to start the - <span><strong class="command">named</strong></span> process. + <span class="command"><strong>named</strong></span> process. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2544344"></a><h2>FILES</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.11"></a><h2>FILES</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term"><code class="filename">/etc/named.conf</code></span></dt> <dd><p> The default configuration file. @@ -298,8 +300,8 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2544384"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.12"></a><h2>SEE ALSO</h2> <p><em class="citetitle">RFC 1033</em>, <em class="citetitle">RFC 1034</em>, <em class="citetitle">RFC 1035</em>, @@ -311,10 +313,5 @@ <em class="citetitle">BIND 9 Administrator Reference Manual</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2544454"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/named/query.c b/bin/named/query.c index 8df3c714514a..d780671eb539 100644 --- a/bin/named/query.c +++ b/bin/named/query.c @@ -26,6 +26,7 @@ #include <isc/print.h> #include <isc/serial.h> #include <isc/stats.h> +#include <isc/thread.h> #include <isc/util.h> #include <dns/adb.h> @@ -90,6 +91,9 @@ /*% Want Recursion? */ #define WANTRECURSION(c) (((c)->query.attributes & \ NS_QUERYATTR_WANTRECURSION) != 0) +/*% Is TCP? */ +#define TCP(c) (((c)->attributes & NS_CLIENTATTR_TCP) != 0) + /*% Want DNSSEC? */ #define WANTDNSSEC(c) (((c)->attributes & \ NS_CLIENTATTR_WANTDNSSEC) != 0) @@ -118,26 +122,37 @@ DNS_RDATASETATTR_NOQNAME) != 0) #ifdef WANT_QUERYTRACE -#define CTRACE(l,m) do { \ - if (client != NULL && client->query.qname != NULL) { \ - if (isc_log_wouldlog(ns_g_lctx, l)) { \ - char qbuf[DNS_NAME_FORMATSIZE]; \ - dns_name_format(client->query.qname, \ - qbuf, sizeof(qbuf)); \ - isc_log_write(ns_g_lctx, \ - NS_LOGCATEGORY_CLIENT, \ - NS_LOGMODULE_QUERY, \ - l, "client %p (%s): %s", \ - client, qbuf, (m)); \ - } \ - } else { \ - isc_log_write(ns_g_lctx, \ - NS_LOGCATEGORY_CLIENT, \ - NS_LOGMODULE_QUERY, \ - l, "client %p (<unknown-name>): %s", \ - client, (m)); \ - } \ -} while(0) +static inline void +client_trace(ns_client_t *client, int level, const char *message) { + if (client != NULL && client->query.qname != NULL) { + if (isc_log_wouldlog(ns_g_lctx, level)) { + char qbuf[DNS_NAME_FORMATSIZE]; + char tbuf[DNS_RDATATYPE_FORMATSIZE]; + dns_name_format(client->query.qname, + qbuf, sizeof(qbuf)); + dns_rdatatype_format(client->query.qtype, + tbuf, sizeof(tbuf)); + isc_log_write(ns_g_lctx, + NS_LOGCATEGORY_CLIENT, + NS_LOGMODULE_QUERY, level, + "query client=%p thread=0x%lx " + "(%s/%s): %s", + client, + (unsigned long) isc_thread_self(), + qbuf, tbuf, message); + } + } else { + isc_log_write(ns_g_lctx, + NS_LOGCATEGORY_CLIENT, + NS_LOGMODULE_QUERY, level, + "query client=%p thread=0x%lx " + "(<unknown-query>): %s", + client, + (unsigned long) isc_thread_self(), + message); + } +} +#define CTRACE(l,m) client_trace(client, l, m) #else #define CTRACE(l,m) ((void)m) #endif /* WANT_QUERYTRACE */ @@ -330,6 +345,8 @@ query_reset(ns_client_t *client, isc_boolean_t everything) { isc_buffer_t *dbuf, *dbuf_next; ns_dbversion_t *dbversion, *dbversion_next; + CTRACE(ISC_LOG_DEBUG(3), "query_reset"); + /*% * Reset the query state of a client to its default state. */ @@ -471,7 +488,7 @@ query_getnamebuf(ns_client_t *client) { dbuf = ISC_LIST_TAIL(client->query.namebufs); INSIST(dbuf != NULL); isc_buffer_availableregion(dbuf, &r); - if (r.length < 255) { + if (r.length < DNS_NAME_MAXWIRE) { result = query_newnamebuf(client); if (result != ISC_R_SUCCESS) { CTRACE(ISC_LOG_DEBUG(3), @@ -951,7 +968,7 @@ rpz_log_fail(ns_client_t *client, int level, */ dns_name_format(client->query.qname, namebuf1, sizeof(namebuf1)); dns_name_format(name, namebuf2, sizeof(namebuf2)); - ns_client_log(client, NS_LOGCATEGORY_QUERY_EERRORS, + ns_client_log(client, NS_LOGCATEGORY_QUERY_ERRORS, NS_LOGMODULE_QUERY, level, "rpz %s rewrite %s via %s %sfailed: %s", dns_rpz_type2str(rpz_type), @@ -3732,7 +3749,7 @@ query_resume(isc_task_t *task, isc_event_t *event) { ns_client_t *client; isc_boolean_t fetch_canceled, client_shuttingdown; isc_result_t result; - isc_logcategory_t *logcategory = NS_LOGCATEGORY_QUERY_EERRORS; + isc_logcategory_t *logcategory = NS_LOGCATEGORY_QUERY_ERRORS; int errorloglevel; /* @@ -4419,8 +4436,6 @@ rpz_find(ns_client_t *client, dns_rdatatype_t qtype, dns_name_t *qnamef, policy = DNS_RPZ_POLICY_MISS; break; default: - dns_db_detach(dbp); - dns_zone_detach(zonep); rpz_log_fail(client, DNS_RPZ_ERROR_LEVEL, rpz_type, qnamef, "", result); CTRACE(ISC_LOG_ERROR, @@ -5668,6 +5683,10 @@ query_find(ns_client_t *client, dns_fetchevent_t *event, dns_rdatatype_t qtype) isc_boolean_t associated; dns_section_t section; dns_ttl_t ttl; +#ifdef WANT_QUERYTRACE + char mbuf[BUFSIZ]; + char qbuf[DNS_NAME_FORMATSIZE]; +#endif CTRACE(ISC_LOG_DEBUG(3), "query_find"); @@ -5702,6 +5721,25 @@ query_find(ns_client_t *client, dns_fetchevent_t *event, dns_rdatatype_t qtype) dns_clientinfomethods_init(&cm, ns_client_sourceip); dns_clientinfo_init(&ci, client); +#ifdef WANT_QUERYTRACE + if (client->query.origqname != NULL) + dns_name_format(client->query.origqname, qbuf, + sizeof(qbuf)); + else + snprintf(qbuf, sizeof(qbuf), "<unset>"); + + snprintf(mbuf, sizeof(mbuf) - 1, + "client attr:0x%x, query attr:0x%X, restarts:%d, " + "origqname:%s, timer:%d, authdb:%d, referral:%d", + client->attributes, + client->query.attributes, + client->query.restarts, qbuf, + (int) client->query.timerset, + (int) client->query.authdbset, + (int) client->query.isreferral); + CTRACE(ISC_LOG_DEBUG(3), mbuf); +#endif + if (event != NULL) { /* * We're returning from recursion. Restore the query context @@ -5711,7 +5749,33 @@ query_find(ns_client_t *client, dns_fetchevent_t *event, dns_rdatatype_t qtype) rpz_st = client->query.rpz_st; if (rpz_st != NULL && - (rpz_st->state & DNS_RPZ_RECURSING) != 0) { + (rpz_st->state & DNS_RPZ_RECURSING) != 0) + { + CTRACE(ISC_LOG_DEBUG(3), "resume from RPZ recursion"); +#ifdef WANT_QUERYTRACE + { + char rbuf[DNS_NAME_FORMATSIZE] = "<unset>"; + char fbuf[DNS_NAME_FORMATSIZE] = "<unset>"; + if (rpz_st->qname != NULL) + dns_name_format(rpz_st->qname, + qbuf, sizeof(qbuf)); + else + snprintf(qbuf, sizeof(qbuf), + "<unset>"); + if (rpz_st->r_name != NULL) + dns_name_format(rpz_st->r_name, + rbuf, sizeof(rbuf)); + if (rpz_st->fname != NULL) + dns_name_format(rpz_st->fname, + fbuf, sizeof(fbuf)); + + snprintf(mbuf, sizeof(mbuf) - 1, + "rpz qname %s, rname:%s, fname:%s", + qbuf, rbuf, fbuf); + CTRACE(ISC_LOG_DEBUG(3), mbuf); + } +#endif + is_zone = rpz_st->q.is_zone; authoritative = rpz_st->q.authoritative; zone = rpz_st->q.zone; @@ -5741,6 +5805,7 @@ query_find(ns_client_t *client, dns_fetchevent_t *event, dns_rdatatype_t qtype) rdataset = event->rdataset; sigrdataset = event->sigrdataset; } + INSIST(rdataset != NULL); if (qtype == dns_rdatatype_rrsig || qtype == dns_rdatatype_sig) type = dns_rdatatype_any; @@ -5846,11 +5911,14 @@ query_find(ns_client_t *client, dns_fetchevent_t *event, dns_rdatatype_t qtype) options |= DNS_GETDB_NOEXACT; result = query_getdb(client, client->query.qname, qtype, options, &zone, &db, &version, &is_zone); - if ((result != ISC_R_SUCCESS || !is_zone) && !RECURSIONOK(client) && - (options & DNS_GETDB_NOEXACT) != 0 && qtype == dns_rdatatype_ds) { + if (ISC_UNLIKELY((result != ISC_R_SUCCESS || !is_zone) && + qtype == dns_rdatatype_ds && + !RECURSIONOK(client) && + (options & DNS_GETDB_NOEXACT) != 0)) + { /* - * Look to see if we are authoritative for the - * child zone if the query type is DS. + * If the query type is DS, look to see if we are + * authoritative for the child zone. */ dns_db_t *tdb = NULL; dns_zone_t *tzone = NULL; @@ -5923,7 +5991,7 @@ query_find(ns_client_t *client, dns_fetchevent_t *event, dns_rdatatype_t qtype) * We'll need some resources... */ dbuf = query_getnamebuf(client); - if (dbuf == NULL) { + if (ISC_UNLIKELY(dbuf == NULL)) { CTRACE(ISC_LOG_ERROR, "query_find: query_getnamebuf failed (2)"); QUERY_ERROR(DNS_R_SERVFAIL); @@ -5931,7 +5999,7 @@ query_find(ns_client_t *client, dns_fetchevent_t *event, dns_rdatatype_t qtype) } fname = query_newname(client, dbuf, &b); rdataset = query_newrdataset(client); - if (fname == NULL || rdataset == NULL) { + if (ISC_UNLIKELY(fname == NULL || rdataset == NULL)) { CTRACE(ISC_LOG_ERROR, "query_find: query_newname failed (2)"); QUERY_ERROR(DNS_R_SERVFAIL); @@ -6072,7 +6140,7 @@ query_find(ns_client_t *client, dns_fetchevent_t *event, dns_rdatatype_t qtype) inc_stats(client, dns_nsstatscounter_rateslipped); client->message->flags |= - DNS_MESSAGEFLAG_TC; + DNS_MESSAGEFLAG_TC; if (resp_result == DNS_R_NXDOMAIN) client->message->rcode = dns_rcode_nxdomain; @@ -7737,7 +7805,7 @@ log_queryerror(ns_client_t *client, isc_result_t result, int line, int level) { } } - ns_client_log(client, NS_LOGCATEGORY_QUERY_EERRORS, NS_LOGMODULE_QUERY, + ns_client_log(client, NS_LOGCATEGORY_QUERY_ERRORS, NS_LOGMODULE_QUERY, level, "query failed (%s)%s%s%s%s%s%s at %s:%d", isc_result_totext(result), sep1, namep, sep2, classp, sep2, typep, __FILE__, line); @@ -7758,8 +7826,16 @@ ns_query_start(ns_client_t *client) { /* * Test only. */ - if (ns_g_clienttest && (client->attributes & NS_CLIENTATTR_TCP) == 0) - RUNTIME_CHECK(ns_client_replace(client) == ISC_R_SUCCESS); + if (ns_g_clienttest && !TCP(client)) { + result = ns_client_replace(client); + if (result == ISC_R_SHUTTINGDOWN) { + ns_client_next(client, result); + return; + } else if (result != ISC_R_SUCCESS) { + query_error(client, result, __LINE__); + return; + } + } /* * Ensure that appropriate cleanups occur. @@ -7806,6 +7882,14 @@ ns_query_start(ns_client_t *client) { } /* + * Check for multiple question queries, since edns1 is dead. + */ + if (message->counts[DNS_SECTION_QUESTION] > 1) { + query_error(client, DNS_R_FORMERR, __LINE__); + return; + } + + /* * Get the question name. */ result = dns_message_firstname(message, DNS_SECTION_QUESTION); @@ -7833,19 +7917,11 @@ ns_query_start(ns_client_t *client) { log_query(client, saved_flags, saved_extflags); /* - * Check for multiple question queries, since edns1 is dead. - */ - if (message->counts[DNS_SECTION_QUESTION] > 1) { - query_error(client, DNS_R_FORMERR, __LINE__); - return; - } - - /* * Check for meta-queries like IXFR and AXFR. */ rdataset = ISC_LIST_HEAD(client->query.qname->list); INSIST(rdataset != NULL); - qtype = rdataset->type; + client->query.qtype = qtype = rdataset->type; dns_rdatatypestats_increment(ns_g_server->rcvquerystats, qtype); if (dns_rdatatype_ismeta(qtype)) { diff --git a/bin/named/server.c b/bin/named/server.c index d7d1a59fc16c..e6a1651f22d6 100644 --- a/bin/named/server.c +++ b/bin/named/server.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2004-2016 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 1999-2003 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -188,6 +188,7 @@ struct ns_cache { dns_view_t *primaryview; isc_boolean_t needflush; isc_boolean_t adbsizeadjusted; + dns_rdataclass_t rdclass; ISC_LINK(ns_cache_t) link; }; @@ -1388,13 +1389,16 @@ setquerystats(dns_zone_t *zone, isc_mem_t *mctx, dns_zonestat_level_t level) { } static ns_cache_t * -cachelist_find(ns_cachelist_t *cachelist, const char *cachename) { +cachelist_find(ns_cachelist_t *cachelist, const char *cachename, + dns_rdataclass_t rdclass) +{ ns_cache_t *nsc; for (nsc = ISC_LIST_HEAD(*cachelist); nsc != NULL; nsc = ISC_LIST_NEXT(nsc, link)) { - if (strcmp(dns_cache_getname(nsc->cache), cachename) == 0) + if (nsc->rdclass == rdclass && + strcmp(dns_cache_getname(nsc->cache), cachename) == 0) return (nsc); } @@ -1405,7 +1409,8 @@ static isc_boolean_t cache_reusable(dns_view_t *originview, dns_view_t *view, isc_boolean_t new_zero_no_soattl) { - if (originview->checknames != view->checknames || + if (originview->rdclass != view->rdclass || + originview->checknames != view->checknames || dns_resolver_getzeronosoattl(originview->resolver) != new_zero_no_soattl || originview->acceptexpired != view->acceptexpired || @@ -2595,7 +2600,7 @@ configure_view(dns_view_t *view, cfg_obj_t *config, cfg_obj_t *vconfig, else cachename = view->name; cache = NULL; - nsc = cachelist_find(cachelist, cachename); + nsc = cachelist_find(cachelist, cachename, view->rdclass); if (nsc != NULL) { if (!cache_sharable(nsc->primaryview, view, zero_no_soattl, cleaning_interval, max_cache_size)) { @@ -2677,6 +2682,7 @@ configure_view(dns_view_t *view, cfg_obj_t *config, cfg_obj_t *vconfig, nsc->primaryview = view; nsc->needflush = ISC_FALSE; nsc->adbsizeadjusted = ISC_FALSE; + nsc->rdclass = view->rdclass; ISC_LINK_INIT(nsc, link); ISC_LIST_APPEND(*cachelist, nsc, link); } @@ -3760,8 +3766,15 @@ get_viewinfo(const cfg_obj_t *vconfig, const char **namep, viewname = cfg_obj_asstring(cfg_tuple_get(vconfig, "name")); classobj = cfg_tuple_get(vconfig, "class"); - result = ns_config_getclass(classobj, dns_rdataclass_in, - &viewclass); + CHECK(ns_config_getclass(classobj, dns_rdataclass_in, + &viewclass)); + if (dns_rdataclass_ismeta(viewclass)) { + isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL, + NS_LOGMODULE_SERVER, ISC_LOG_ERROR, + "view '%s': class must not be meta", + viewname); + CHECK(ISC_R_FAILURE); + } } else { viewname = "_default"; viewclass = dns_rdataclass_in; @@ -3770,6 +3783,7 @@ get_viewinfo(const cfg_obj_t *vconfig, const char **namep, *namep = viewname; *classp = viewclass; +cleanup: return (result); } @@ -6603,28 +6617,61 @@ ns_server_reloadwanted(ns_server_t *server) { } static char * -next_token(char **stringp, const char *delim) { - char *res; +next_token(isc_lex_t *lex, isc_buffer_t *text) { + isc_result_t result; + isc_token_t token; - do { - res = strsep(stringp, delim); - if (res == NULL) - break; - } while (*res == '\0'); - return (res); + token.type = isc_tokentype_unknown; + result = isc_lex_gettoken(lex, ISC_LEXOPT_EOF|ISC_LEXOPT_QSTRING, + &token); + + switch (result) { + case ISC_R_NOMORE: + (void) isc_lex_close(lex); + break; + case ISC_R_SUCCESS: + if (token.type == isc_tokentype_eof) + (void) isc_lex_close(lex); + break; + case ISC_R_NOSPACE: + if (text != NULL) { + (void) putstr(text, "token too large"); + (void) putnull(text); + } + return (NULL); + default: + if (text != NULL) { + (void) putstr(text, isc_result_totext(result)); + (void) putnull(text); + } + return (NULL); + } + + if (token.type == isc_tokentype_string || + token.type == isc_tokentype_qstring) + return (token.value.as_textregion.base); + + return (NULL); } /* - * Find the zone specified in the control channel command 'args', - * if any. If a zone is specified, point '*zonep' at it, otherwise - * set '*zonep' to NULL. + * Find the zone specified in the control channel command, if any. + * If a zone is specified, point '*zonep' at it, otherwise + * set '*zonep' to NULL, and f 'zonename' is not NULL, copy + * the zone name into it (N.B. 'zonename' must have space to hold + * a full DNS name). + * + * If 'zonetxt' is set, the caller has already pulled a token + * off the command line that is to be used as the zone name. (This + * is sometimes done when it's necessary to check for an optional + * argument before the zone name, as in "rndc sync [-clean] zone".) */ static isc_result_t -zone_from_args(ns_server_t *server, char *args, const char *zonetxt, - dns_zone_t **zonep, const char **zonename, +zone_from_args(ns_server_t *server, isc_lex_t *lex, const char *zonetxt, + dns_zone_t **zonep, char *zonename, isc_buffer_t *text, isc_boolean_t skip) { - char *input, *ptr; + char *ptr; char *classtxt; const char *viewtxt = NULL; dns_fixedname_t fname; @@ -6633,43 +6680,42 @@ zone_from_args(ns_server_t *server, char *args, const char *zonetxt, dns_view_t *view = NULL; dns_rdataclass_t rdclass; char problem[DNS_NAME_FORMATSIZE + 500] = ""; + char zonebuf[DNS_NAME_FORMATSIZE]; REQUIRE(zonep != NULL && *zonep == NULL); - REQUIRE(zonename == NULL || *zonename == NULL); - - input = args; if (skip) { /* Skip the command name. */ - ptr = next_token(&input, " \t"); + ptr = next_token(lex, text); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); } /* Look for the zone name. */ if (zonetxt == NULL) - zonetxt = next_token(&input, " \t"); + zonetxt = next_token(lex, text); if (zonetxt == NULL) return (ISC_R_SUCCESS); - if (zonename != NULL) - *zonename = zonetxt; - /* Look for the optional class name. */ - classtxt = next_token(&input, " \t"); - if (classtxt != NULL) { - /* Look for the optional view name. */ - viewtxt = next_token(&input, " \t"); - } + /* Copy zonetxt because it'll be overwritten by next_token() */ + strlcpy(zonebuf, zonetxt, DNS_NAME_FORMATSIZE); + if (zonename != NULL) + strlcpy(zonename, zonetxt, DNS_NAME_FORMATSIZE); dns_fixedname_init(&fname); name = dns_fixedname_name(&fname); - CHECK(dns_name_fromstring(name, zonetxt, 0, NULL)); + CHECK(dns_name_fromstring(name, zonebuf, 0, NULL)); + /* Look for the optional class name. */ + classtxt = next_token(lex, text); if (classtxt != NULL) { isc_textregion_t r; r.base = classtxt; r.length = strlen(classtxt); CHECK(dns_rdataclass_fromtext(&rdclass, &r)); + + /* Look for the optional view name. */ + viewtxt = next_token(lex, text); } else rdclass = dns_rdataclass_in; @@ -6680,11 +6726,11 @@ zone_from_args(ns_server_t *server, char *args, const char *zonetxt, if (result == ISC_R_NOTFOUND) snprintf(problem, sizeof(problem), "no matching zone '%s' in any view", - zonetxt); + zonebuf); else if (result == ISC_R_MULTIPLE) snprintf(problem, sizeof(problem), "zone '%s' was found in multiple views", - zonetxt); + zonebuf); } else { result = dns_viewlist_find(&server->viewlist, viewtxt, rdclass, &view); @@ -6698,7 +6744,7 @@ zone_from_args(ns_server_t *server, char *args, const char *zonetxt, if (result != ISC_R_SUCCESS) snprintf(problem, sizeof(problem), "no matching zone '%s' in view '%s'", - zonetxt, viewtxt); + zonebuf, viewtxt); } /* Partial match? */ @@ -6726,7 +6772,7 @@ zone_from_args(ns_server_t *server, char *args, const char *zonetxt, * Act on a "retransfer" command from the command channel. */ isc_result_t -ns_server_retransfercommand(ns_server_t *server, char *args, +ns_server_retransfercommand(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text) { isc_result_t result; @@ -6734,7 +6780,7 @@ ns_server_retransfercommand(ns_server_t *server, char *args, dns_zone_t *raw = NULL; dns_zonetype_t type; - result = zone_from_args(server, args, NULL, &zone, NULL, + result = zone_from_args(server, lex, NULL, &zone, NULL, text, ISC_TRUE); if (result != ISC_R_SUCCESS) return (result); @@ -6759,13 +6805,15 @@ ns_server_retransfercommand(ns_server_t *server, char *args, * Act on a "reload" command from the command channel. */ isc_result_t -ns_server_reloadcommand(ns_server_t *server, char *args, isc_buffer_t *text) { +ns_server_reloadcommand(ns_server_t *server, isc_lex_t *lex, + isc_buffer_t *text) +{ isc_result_t result; dns_zone_t *zone = NULL; dns_zonetype_t type; const char *msg = NULL; - result = zone_from_args(server, args, NULL, &zone, NULL, + result = zone_from_args(server, lex, NULL, &zone, NULL, text, ISC_TRUE); if (result != ISC_R_SUCCESS) return (result); @@ -6833,12 +6881,14 @@ cleanup: * Act on a "notify" command from the command channel. */ isc_result_t -ns_server_notifycommand(ns_server_t *server, char *args, isc_buffer_t *text) { +ns_server_notifycommand(ns_server_t *server, isc_lex_t *lex, + isc_buffer_t *text) +{ isc_result_t result; dns_zone_t *zone = NULL; const unsigned char msg[] = "zone notify queued"; - result = zone_from_args(server, args, NULL, &zone, NULL, + result = zone_from_args(server, lex, NULL, &zone, NULL, text, ISC_TRUE); if (result != ISC_R_SUCCESS) return (result); @@ -6857,14 +6907,16 @@ ns_server_notifycommand(ns_server_t *server, char *args, isc_buffer_t *text) { * Act on a "refresh" command from the command channel. */ isc_result_t -ns_server_refreshcommand(ns_server_t *server, char *args, isc_buffer_t *text) { +ns_server_refreshcommand(ns_server_t *server, isc_lex_t *lex, + isc_buffer_t *text) +{ isc_result_t result; dns_zone_t *zone = NULL, *raw = NULL; const unsigned char msg1[] = "zone refresh queued"; const unsigned char msg2[] = "not a slave or stub zone"; dns_zonetype_t type; - result = zone_from_args(server, args, NULL, &zone, NULL, + result = zone_from_args(server, lex, NULL, &zone, NULL, text, ISC_TRUE); if (result != ISC_R_SUCCESS) return (result); @@ -6894,16 +6946,16 @@ ns_server_refreshcommand(ns_server_t *server, char *args, isc_buffer_t *text) { } isc_result_t -ns_server_togglequerylog(ns_server_t *server, char *args) { +ns_server_togglequerylog(ns_server_t *server, isc_lex_t *lex) { isc_boolean_t value; char *ptr; /* Skip the command name. */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); if (ptr == NULL) value = server->log_queries ? ISC_FALSE : ISC_TRUE; else if (strcasecmp(ptr, "yes") == 0 || strcasecmp(ptr, "on") == 0) @@ -7239,7 +7291,7 @@ dumpdone(void *arg, isc_result_t result) { } isc_result_t -ns_server_dumpdb(ns_server_t *server, char *args) { +ns_server_dumpdb(ns_server_t *server, isc_lex_t *lex) { struct dumpcontext *dctx = NULL; dns_view_t *view; isc_result_t result; @@ -7247,7 +7299,7 @@ ns_server_dumpdb(ns_server_t *server, char *args) { const char *sep; /* Skip the command name. */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); @@ -7275,37 +7327,37 @@ ns_server_dumpdb(ns_server_t *server, char *args) { CHECKMF(isc_stdio_open(server->dumpfile, "w", &dctx->fp), "could not open dump file", server->dumpfile); - sep = (args == NULL) ? "" : ": "; + ptr = next_token(lex, NULL); + sep = (ptr == NULL) ? "" : ": "; isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL, NS_LOGMODULE_SERVER, ISC_LOG_INFO, - "dumpdb started%s%s", sep, (args != NULL) ? args : ""); + "dumpdb started%s%s", sep, (ptr != NULL) ? ptr : ""); - ptr = next_token(&args, " \t"); if (ptr != NULL && strcmp(ptr, "-all") == 0) { /* also dump zones */ dctx->dumpzones = ISC_TRUE; - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); } else if (ptr != NULL && strcmp(ptr, "-cache") == 0) { /* this is the default */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); } else if (ptr != NULL && strcmp(ptr, "-zones") == 0) { /* only dump zones, suppress caches */ dctx->dumpadb = ISC_FALSE; dctx->dumpbad = ISC_FALSE; dctx->dumpcache = ISC_FALSE; dctx->dumpzones = ISC_TRUE; - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); #ifdef ENABLE_FETCHLIMIT } else if (ptr != NULL && strcmp(ptr, "-adb") == 0) { /* only dump adb, suppress other caches */ dctx->dumpbad = ISC_FALSE; dctx->dumpcache = ISC_FALSE; - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); } else if (ptr != NULL && strcmp(ptr, "-bad") == 0) { /* only dump badcache, suppress other caches */ dctx->dumpadb = ISC_FALSE; dctx->dumpcache = ISC_FALSE; - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); #endif /* ENABLE_FETCHLIMIT */ } @@ -7319,7 +7371,7 @@ ns_server_dumpdb(ns_server_t *server, char *args) { CHECK(add_view_tolist(dctx, view)); } if (ptr != NULL) { - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); if (ptr != NULL) goto nextview; } @@ -7333,7 +7385,7 @@ ns_server_dumpdb(ns_server_t *server, char *args) { } isc_result_t -ns_server_dumpsecroots(ns_server_t *server, char *args) { +ns_server_dumpsecroots(ns_server_t *server, isc_lex_t *lex) { dns_view_t *view; dns_keytable_t *secroots = NULL; isc_result_t result; @@ -7343,11 +7395,11 @@ ns_server_dumpsecroots(ns_server_t *server, char *args) { char tbuf[64]; /* Skip the command name. */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); CHECKMF(isc_stdio_open(server->secrootsfile, "w", &fp), "could not open secroots dump file", server->secrootsfile); @@ -7376,7 +7428,7 @@ ns_server_dumpsecroots(ns_server_t *server, char *args) { isc_result_totext(result)); } if (ptr != NULL) - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); } while (ptr != NULL); cleanup: @@ -7438,26 +7490,25 @@ ns_server_dumprecursing(ns_server_t *server) { } isc_result_t -ns_server_setdebuglevel(ns_server_t *server, char *args) { +ns_server_setdebuglevel(ns_server_t *server, isc_lex_t *lex) { char *ptr; - char *levelstr; char *endp; long newlevel; UNUSED(server); /* Skip the command name. */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); /* Look for the new level name. */ - levelstr = next_token(&args, " \t"); - if (levelstr == NULL) { + ptr = next_token(lex, NULL); + if (ptr == NULL) { if (ns_g_debuglevel < 99) ns_g_debuglevel++; } else { - newlevel = strtol(levelstr, &endp, 10); + newlevel = strtol(ptr, &endp, 10); if (*endp != '\0' || newlevel < 0 || newlevel > 99) return (ISC_R_RANGE); ns_g_debuglevel = (unsigned int)newlevel; @@ -7470,20 +7521,20 @@ ns_server_setdebuglevel(ns_server_t *server, char *args) { } isc_result_t -ns_server_validation(ns_server_t *server, char *args) { - char *ptr, *viewname; +ns_server_validation(ns_server_t *server, isc_lex_t *lex) { + char *ptr; dns_view_t *view; isc_boolean_t changed = ISC_FALSE; isc_result_t result; isc_boolean_t enable; /* Skip the command name. */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); /* Find out what we are to do. */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); @@ -7497,7 +7548,7 @@ ns_server_validation(ns_server_t *server, char *args) { return (DNS_R_SYNTAX); /* Look for the view name. */ - viewname = next_token(&args, " \t"); + ptr = next_token(lex, NULL); result = isc_task_beginexclusive(server->task); RUNTIME_CHECK(result == ISC_R_SUCCESS); @@ -7505,7 +7556,7 @@ ns_server_validation(ns_server_t *server, char *args) { view != NULL; view = ISC_LIST_NEXT(view, link)) { - if (viewname != NULL && strcasecmp(viewname, view->name) != 0) + if (ptr != NULL && strcasecmp(ptr, view->name) != 0) continue; result = dns_view_flushcache(view); if (result != ISC_R_SUCCESS) @@ -7523,8 +7574,8 @@ ns_server_validation(ns_server_t *server, char *args) { } isc_result_t -ns_server_flushcache(ns_server_t *server, char *args) { - char *ptr, *viewname; +ns_server_flushcache(ns_server_t *server, isc_lex_t *lex) { + char *ptr; dns_view_t *view; isc_boolean_t flushed; isc_boolean_t found; @@ -7532,12 +7583,12 @@ ns_server_flushcache(ns_server_t *server, char *args) { ns_cache_t *nsc; /* Skip the command name. */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); /* Look for the view name. */ - viewname = next_token(&args, " \t"); + ptr = next_token(lex, NULL); result = isc_task_beginexclusive(server->task); RUNTIME_CHECK(result == ISC_R_SUCCESS); @@ -7550,7 +7601,7 @@ ns_server_flushcache(ns_server_t *server, char *args) { * list, flush these caches, and then update other views that refer to * the flushed cache DB. */ - if (viewname != NULL) { + if (ptr != NULL) { /* * Mark caches that need to be flushed. This is an O(#view^2) * operation in the very worst case, but should be normally @@ -7561,7 +7612,7 @@ ns_server_flushcache(ns_server_t *server, char *args) { view != NULL; view = ISC_LIST_NEXT(view, link)) { - if (strcasecmp(viewname, view->name) != 0) + if (strcasecmp(ptr, view->name) != 0) continue; found = ISC_TRUE; for (nsc = ISC_LIST_HEAD(server->cachelist); @@ -7580,7 +7631,7 @@ ns_server_flushcache(ns_server_t *server, char *args) { for (nsc = ISC_LIST_HEAD(server->cachelist); nsc != NULL; nsc = ISC_LIST_NEXT(nsc, link)) { - if (viewname != NULL && !nsc->needflush) + if (ptr != NULL && !nsc->needflush) continue; nsc->needflush = ISC_TRUE; result = dns_view_flushcache2(nsc->primaryview, ISC_FALSE); @@ -7634,11 +7685,11 @@ ns_server_flushcache(ns_server_t *server, char *args) { } if (flushed && found) { - if (viewname != NULL) + if (ptr != NULL) isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL, NS_LOGMODULE_SERVER, ISC_LOG_INFO, "flushing cache in view '%s' succeeded", - viewname); + ptr); else isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL, NS_LOGMODULE_SERVER, ISC_LOG_INFO, @@ -7649,7 +7700,7 @@ ns_server_flushcache(ns_server_t *server, char *args) { isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL, NS_LOGMODULE_SERVER, ISC_LOG_ERROR, "flushing cache in view '%s' failed: " - "view not found", viewname); + "view not found", ptr); result = ISC_R_NOTFOUND; } else result = ISC_R_FAILURE; @@ -7659,8 +7710,9 @@ ns_server_flushcache(ns_server_t *server, char *args) { } isc_result_t -ns_server_flushnode(ns_server_t *server, char *args, isc_boolean_t tree) { - char *ptr, *target, *viewname; +ns_server_flushnode(ns_server_t *server, isc_lex_t *lex, isc_boolean_t tree) { + char *ptr, *viewname; + char target[DNS_NAME_FORMATSIZE]; dns_view_t *view; isc_boolean_t flushed; isc_boolean_t found; @@ -7670,15 +7722,16 @@ ns_server_flushnode(ns_server_t *server, char *args, isc_boolean_t tree) { dns_name_t *name; /* Skip the command name. */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, NULL); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); /* Find the domain name to flush. */ - target = next_token(&args, " \t"); - if (target == NULL) + ptr = next_token(lex, NULL); + if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); + strlcpy(target, ptr, DNS_NAME_FORMATSIZE); isc_buffer_constinit(&b, target, strlen(target)); isc_buffer_add(&b, strlen(target)); dns_fixedname_init(&fixed); @@ -7688,7 +7741,7 @@ ns_server_flushnode(ns_server_t *server, char *args, isc_boolean_t tree) { return (result); /* Look for the view name. */ - viewname = next_token(&args, " \t"); + viewname = next_token(lex, NULL); result = isc_task_beginexclusive(server->task); RUNTIME_CHECK(result == ISC_R_SUCCESS); @@ -7868,19 +7921,22 @@ delete_keynames(dns_tsig_keyring_t *ring, char *target, } isc_result_t -ns_server_tsigdelete(ns_server_t *server, char *command, isc_buffer_t *text) { +ns_server_tsigdelete(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text) { isc_result_t result; unsigned int n; dns_view_t *view; unsigned int foundkeys = 0; - char *target; - char *viewname; + char *ptr, *viewname; + char target[DNS_NAME_FORMATSIZE]; + + (void)next_token(lex, text); /* skip command name */ - (void)next_token(&command, " \t"); /* skip command name */ - target = next_token(&command, " \t"); - if (target == NULL) + ptr = next_token(lex, text); + if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); - viewname = next_token(&command, " \t"); + strlcpy(target, ptr, DNS_NAME_FORMATSIZE); + + viewname = next_token(lex, text); result = isc_task_beginexclusive(server->task); RUNTIME_CHECK(result == ISC_R_SUCCESS); @@ -8039,18 +8095,23 @@ ns_server_tsiglist(ns_server_t *server, isc_buffer_t *text) { * Act on a "sign" or "loadkeys" command from the command channel. */ isc_result_t -ns_server_rekey(ns_server_t *server, char *args, isc_buffer_t *text) { +ns_server_rekey(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text) { isc_result_t result; dns_zone_t *zone = NULL; dns_zonetype_t type; isc_uint16_t keyopts; isc_boolean_t fullsign = ISC_FALSE; + char *ptr; - if (strncasecmp(args, NS_COMMAND_SIGN, strlen(NS_COMMAND_SIGN)) == 0) - fullsign = ISC_TRUE; + ptr = next_token(lex, text); + if (ptr == NULL) + return (ISC_R_UNEXPECTEDEND); - result = zone_from_args(server, args, NULL, &zone, NULL, - text, ISC_TRUE); + if (strcasecmp(ptr, NS_COMMAND_SIGN) == 0) + fullsign = ISC_TRUE; + + result = zone_from_args(server, lex, NULL, &zone, NULL, + text, ISC_FALSE); if (result != ISC_R_SUCCESS) return (result); if (zone == NULL) @@ -8105,7 +8166,7 @@ synczone(dns_zone_t *zone, void *uap) { } isc_result_t -ns_server_sync(ns_server_t *server, char *args, isc_buffer_t *text) { +ns_server_sync(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text) { isc_result_t result, tresult; dns_view_t *view; dns_zone_t *zone = NULL; @@ -8114,16 +8175,16 @@ ns_server_sync(ns_server_t *server, char *args, isc_buffer_t *text) { const char *vname, *sep, *msg = NULL, *arg; isc_boolean_t cleanup = ISC_FALSE; - (void) next_token(&args, " \t"); + (void) next_token(lex, text); - arg = next_token(&args, " \t"); + arg = next_token(lex, text); if (arg != NULL && (strcmp(arg, "-clean") == 0 || strcmp(arg, "-clear") == 0)) { cleanup = ISC_TRUE; - arg = next_token(&args, " \t"); + arg = next_token(lex, text); } - result = zone_from_args(server, args, arg, &zone, NULL, + result = zone_from_args(server, lex, arg, &zone, NULL, text, ISC_FALSE); if (result != ISC_R_SUCCESS) return (result); @@ -8187,8 +8248,8 @@ ns_server_sync(ns_server_t *server, char *args, isc_buffer_t *text) { * Act on a "freeze" or "thaw" command from the command channel. */ isc_result_t -ns_server_freeze(ns_server_t *server, isc_boolean_t freeze, char *args, - isc_buffer_t *text) +ns_server_freeze(ns_server_t *server, isc_boolean_t freeze, + isc_lex_t *lex, isc_buffer_t *text) { isc_result_t result, tresult; dns_zone_t *zone = NULL, *raw = NULL; @@ -8200,7 +8261,7 @@ ns_server_freeze(ns_server_t *server, isc_boolean_t freeze, char *args, isc_boolean_t frozen; const char *msg = NULL; - result = zone_from_args(server, args, NULL, &zone, NULL, + result = zone_from_args(server, lex, NULL, &zone, NULL, text, ISC_TRUE); if (result != ISC_R_SUCCESS) return (result); @@ -8388,7 +8449,7 @@ ns_server_add_zone(ns_server_t *server, char *args, isc_buffer_t *text) { dns_fixedname_init(&fname); dnsname = dns_fixedname_name(&fname); - CHECK(dns_name_fromtext(dnsname, &buf, dns_rootname, ISC_FALSE, NULL)); + CHECK(dns_name_fromtext(dnsname, &buf, dns_rootname, 0, NULL)); /* Make sense of optional class argument */ obj = cfg_tuple_get(parms, "class"); @@ -8562,21 +8623,21 @@ ns_server_add_zone(ns_server_t *server, char *args, isc_buffer_t *text) { * Act on a "delzone" command from the command channel. */ isc_result_t -ns_server_del_zone(ns_server_t *server, char *args, isc_buffer_t *text) { - isc_result_t result; +ns_server_del_zone(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text) { + isc_result_t result, tresult; dns_zone_t *zone = NULL; dns_view_t *view = NULL; dns_db_t *dbp = NULL; const char *filename = NULL; char *tmpname = NULL; char buf[1024]; - const char *zonename = NULL; + char zonename[DNS_NAME_FORMATSIZE]; size_t znamelen = 0; FILE *ifp = NULL, *ofp = NULL; isc_boolean_t inheader = ISC_TRUE; /* Parse parameters */ - CHECK(zone_from_args(server, args, NULL, &zone, &zonename, + CHECK(zone_from_args(server, lex, NULL, &zone, zonename, text, ISC_TRUE)); if (zone == NULL) { @@ -8593,7 +8654,16 @@ ns_server_del_zone(ns_server_t *server, char *args, isc_buffer_t *text) { goto cleanup; } - INSIST(zonename != NULL); + /* Is this a policy zone? */ + if (dns_zone_get_rpz(zone)) { + TCHECK(putstr(text, "zone '")); + TCHECK(putstr(text, zonename)); + TCHECK(putstr(text, + "' cannot be deleted: response-policy zone.")); + result = ISC_R_FAILURE; + goto cleanup; + } + znamelen = strlen(zonename); /* Dig out configuration for this zone */ @@ -8774,7 +8844,7 @@ newzone_cfgctx_destroy(void **cfgp) { } isc_result_t -ns_server_signing(ns_server_t *server, char *args, isc_buffer_t *text) { +ns_server_signing(ns_server_t *server, isc_lex_t *lex, isc_buffer_t *text) { isc_result_t result = ISC_R_SUCCESS; dns_zone_t *zone = NULL; dns_name_t *origin; @@ -8795,43 +8865,51 @@ ns_server_signing(ns_server_t *server, char *args, isc_buffer_t *text) { dns_rdataset_init(&privset); /* Skip the command name. */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, text); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); /* Find out what we are to do. */ - ptr = next_token(&args, " \t"); + ptr = next_token(lex, text); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); if (strcasecmp(ptr, "-list") == 0) list = ISC_TRUE; else if ((strcasecmp(ptr, "-clear") == 0) || - (strcasecmp(ptr, "-clean") == 0)) { + (strcasecmp(ptr, "-clean") == 0)) + { clear = ISC_TRUE; - ptr = next_token(&args, " \t"); + ptr = next_token(lex, text); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); strlcpy(keystr, ptr, sizeof(keystr)); } else if (strcasecmp(ptr, "-nsec3param") == 0) { - const char *hashstr, *flagstr, *iterstr; - char nbuf[512]; + char hashbuf[64], flagbuf[64], iterbuf[64]; + char nbuf[256]; chain = ISC_TRUE; - hashstr = next_token(&args, " \t"); - if (hashstr == NULL) + ptr = next_token(lex, text); + if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); - if (strcasecmp(hashstr, "none") == 0) + if (strcasecmp(ptr, "none") == 0) hash = 0; else { - flagstr = next_token(&args, " \t"); - iterstr = next_token(&args, " \t"); - if (flagstr == NULL || iterstr == NULL) + strlcpy(hashbuf, ptr, sizeof(hashbuf)); + + ptr = next_token(lex, text); + if (ptr == NULL) + return (ISC_R_UNEXPECTEDEND); + strlcpy(flagbuf, ptr, sizeof(flagbuf)); + + ptr = next_token(lex, text); + if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); + strlcpy(iterbuf, ptr, sizeof(iterbuf)); n = snprintf(nbuf, sizeof(nbuf), "%s %s %s", - hashstr, flagstr, iterstr); + hashbuf, flagbuf, iterbuf); if (n == sizeof(nbuf)) return (ISC_R_NOSPACE); n = sscanf(nbuf, "%hu %hu %hu", &hash, &flags, &iter); @@ -8841,7 +8919,7 @@ ns_server_signing(ns_server_t *server, char *args, isc_buffer_t *text) { if (hash > 0xffU || flags > 0xffU) return (ISC_R_RANGE); - ptr = next_token(&args, " \t"); + ptr = next_token(lex, text); if (ptr == NULL) return (ISC_R_UNEXPECTEDEND); if (strcmp(ptr, "-") != 0) { @@ -8855,7 +8933,7 @@ ns_server_signing(ns_server_t *server, char *args, isc_buffer_t *text) { } else CHECK(DNS_R_SYNTAX); - CHECK(zone_from_args(server, args, NULL, &zone, NULL, + CHECK(zone_from_args(server, lex, NULL, &zone, NULL, text, ISC_FALSE)); if (zone == NULL) CHECK(ISC_R_UNEXPECTEDEND); diff --git a/bin/named/statschannel.c b/bin/named/statschannel.c index 4bfd52176a9a..06eb43224342 100644 --- a/bin/named/statschannel.c +++ b/bin/named/statschannel.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2008-2015 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2008-2016 Internet Systems Consortium, Inc. ("ISC") * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -2028,10 +2028,12 @@ ns_stats_dump(ns_server_t *server, FILE *fp) { if (zonestats != NULL) { char zonename[DNS_NAME_FORMATSIZE]; - dns_name_format(dns_zone_getorigin(zone), - zonename, sizeof(zonename)); view = dns_zone_getview(zone); + if (view == NULL) + continue; + dns_name_format(dns_zone_getorigin(zone), + zonename, sizeof(zonename)); fprintf(fp, "[%s", zonename); if (strcmp(view->name, "_default") != 0) fprintf(fp, " (view: %s)", view->name); diff --git a/bin/named/unix/include/named/os.h b/bin/named/unix/include/named/os.h index c979e53871d7..b0ac1d568ce2 100644 --- a/bin/named/unix/include/named/os.h +++ b/bin/named/unix/include/named/os.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2004, 2005, 2007-2009 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2004, 2005, 2007-2009, 2016 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 1999-2002 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -15,8 +15,6 @@ * PERFORMANCE OF THIS SOFTWARE. */ -/* $Id: os.h,v 1.31 2009/08/05 23:47:43 tbox Exp $ */ - #ifndef NS_OS_H #define NS_OS_H 1 @@ -72,4 +70,7 @@ ns_os_tzset(void); void ns_os_started(void); +char * +ns_os_uname(void); + #endif /* NS_OS_H */ diff --git a/bin/named/unix/os.c b/bin/named/unix/os.c index 18e8c3910373..953bbdd163b4 100644 --- a/bin/named/unix/os.c +++ b/bin/named/unix/os.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2004-2011, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + * Copyright (C) 2004-2011, 2013, 2014, 2016 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 1999-2002 Internet Software Consortium. * * Permission to use, copy, modify, and/or distribute this software for any @@ -15,8 +15,6 @@ * PERFORMANCE OF THIS SOFTWARE. */ -/* $Id: os.c,v 1.107 2011/03/02 00:02:54 marka Exp $ */ - /*! \file */ #include <config.h> @@ -24,6 +22,9 @@ #include <sys/types.h> /* dev_t FreeBSD 2.1 */ #include <sys/stat.h> +#ifdef HAVE_UNAME +#include <sys/utsname.h> +#endif #include <ctype.h> #include <errno.h> @@ -966,3 +967,33 @@ ns_os_tzset(void) { tzset(); #endif } + +static char unamebuf[BUFSIZ]; +static char *unamep = NULL; + +static void +getuname(void) { +#ifdef HAVE_UNAME + struct utsname uts; + + memset(&uts, 0, sizeof(uts)); + if (uname(&uts) < 0) { + strcpy(unamebuf, "unknown architecture"); + return; + } + + snprintf(unamebuf, sizeof(unamebuf), + "%s %s %s %s", + uts.sysname, uts.machine, uts.release, uts.version); +#else + strcpy(unamebuf, "unknown architecture"); +#endif + unamep = unamebuf; +} + +char * +ns_os_uname(void) { + if (unamep == NULL) + getuname(); + return (unamep); +} diff --git a/bin/named/xfrout.c b/bin/named/xfrout.c index f8535b21ea7b..351b6166559e 100644 --- a/bin/named/xfrout.c +++ b/bin/named/xfrout.c @@ -1246,6 +1246,7 @@ sendstream(xfrout_ctx_t *xfr) { dns_rdataset_t *msgrds = NULL; dns_compress_t cctx; isc_boolean_t cleanup_cctx = ISC_FALSE; + isc_boolean_t is_tcp; int n_rrs; @@ -1253,7 +1254,8 @@ sendstream(xfrout_ctx_t *xfr) { isc_buffer_clear(&xfr->txlenbuf); isc_buffer_clear(&xfr->txbuf); - if ((xfr->client->attributes & NS_CLIENTATTR_TCP) == 0) { + is_tcp = ISC_TF((xfr->client->attributes & NS_CLIENTATTR_TCP) != 0); + if (!is_tcp) { /* * In the UDP case, we put the response data directly into * the client message. @@ -1442,9 +1444,17 @@ sendstream(xfrout_ctx_t *xfr) { if (! xfr->many_answers) break; + /* + * At this stage, at least 1 RR has been rendered into + * the message. Check if we want to clamp this message + * here (TCP only). 20480 was set as an upper limit to + * improve message compression. + */ + if ((isc_buffer_usedlength(&xfr->buf) >= 20480) && is_tcp) + break; } - if ((xfr->client->attributes & NS_CLIENTATTR_TCP) != 0) { + if (is_tcp) { CHECK(dns_compress_init(&cctx, -1, xfr->mctx)); dns_compress_setsensitive(&cctx, ISC_TRUE); cleanup_cctx = ISC_TRUE; diff --git a/bin/nsupdate/Makefile.in b/bin/nsupdate/Makefile.in index 5dc20ad90714..50734189070f 100644 --- a/bin/nsupdate/Makefile.in +++ b/bin/nsupdate/Makefile.in @@ -1,4 +1,4 @@ -# Copyright (C) 2004, 2006-2009, 2012-2014 Internet Systems Consortium, Inc. ("ISC") +# Copyright (C) 2004, 2006-2009, 2012-2015 Internet Systems Consortium, Inc. ("ISC") # Copyright (C) 2000-2002 Internet Software Consortium. # # Permission to use, copy, modify, and/or distribute this software for any @@ -19,7 +19,7 @@ srcdir = @srcdir@ VPATH = @srcdir@ top_srcdir = @top_srcdir@ -@BIND9_VERSION@ +VERSION=@BIND9_VERSION@ @BIND9_MAKE_INCLUDES@ diff --git a/bin/nsupdate/nsupdate.1 b/bin/nsupdate/nsupdate.1 index 28d5f42d7834..f5669ccec6cc 100644 --- a/bin/nsupdate/nsupdate.1 +++ b/bin/nsupdate/nsupdate.1 @@ -13,164 +13,179 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: April 18, 2014 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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" -.HP 9 +.HP \w'\fBnsupdate\fR\ 'u \fBnsupdate\fR [\fB\-d\fR] [\fB\-D\fR] [\fB\-L\ \fR\fB\fIlevel\fR\fR] [[\fB\-g\fR] | [\fB\-o\fR] | [\fB\-l\fR] | [\fB\-y\ \fR\fB\fI[hmac:]\fR\fIkeyname:secret\fR\fR] | [\fB\-k\ \fR\fB\fIkeyfile\fR\fR]] [\fB\-t\ \fR\fB\fItimeout\fR\fR] [\fB\-u\ \fR\fB\fIudptimeout\fR\fR] [\fB\-r\ \fR\fB\fIudpretries\fR\fR] [\fB\-R\ \fR\fB\fIrandomdev\fR\fR] [\fB\-v\fR] [\fB\-V\fR] [filename] .SH "DESCRIPTION" .PP \fBnsupdate\fR -is used to submit Dynamic DNS Update requests as defined in RFC 2136 to a name server. This allows resource records to be added or removed from a zone without manually editing the zone file. A single update request can contain requests to add or remove more than one resource record. +is used to submit Dynamic DNS Update requests as defined in RFC 2136 to a name server\&. This allows resource records to be added or removed from a zone without manually editing the zone file\&. A single update request can contain requests to add or remove more than one resource record\&. .PP Zones that are under dynamic control via \fBnsupdate\fR -or a DHCP server should not be edited by hand. Manual edits could conflict with dynamic updates and cause data to be lost. +or a DHCP server should not be edited by hand\&. Manual edits could conflict with dynamic updates and cause data to be lost\&. .PP The resource records that are dynamically added or removed with \fBnsupdate\fR -have to be in the same zone. Requests are sent to the zone's master server. This is identified by the MNAME field of the zone's SOA record. +have to be in the same zone\&. Requests are sent to the zone\*(Aqs master server\&. This is identified by the MNAME field of the zone\*(Aqs SOA record\&. .PP -Transaction signatures can be used to authenticate the Dynamic DNS updates. These use the TSIG resource record type described in RFC 2845 or the SIG(0) record described in RFC 2535 and RFC 2931 or GSS\-TSIG as described in RFC 3645. +Transaction signatures can be used to authenticate the Dynamic DNS updates\&. These use the TSIG resource record type described in RFC 2845 or the SIG(0) record described in RFC 2535 and RFC 2931 or GSS\-TSIG as described in RFC 3645\&. .PP TSIG relies on a shared secret that should only be known to \fBnsupdate\fR -and the name server. For instance, suitable +and the name server\&. For instance, suitable \fBkey\fR and \fBserver\fR statements would be added to -\fI/etc/named.conf\fR -so that the name server can associate the appropriate secret key and algorithm with the IP address of the client application that will be using TSIG authentication. You can use +/etc/named\&.conf +so that the name server can associate the appropriate secret key and algorithm with the IP address of the client application that will be using TSIG authentication\&. You can use \fBddns\-confgen\fR -to generate suitable configuration fragments. +to generate suitable configuration fragments\&. \fBnsupdate\fR uses the \fB\-y\fR or \fB\-k\fR -options to provide the TSIG shared secret. These options are mutually exclusive. +options to provide the TSIG shared secret\&. These options are mutually exclusive\&. .PP -SIG(0) uses public key cryptography. To use a SIG(0) key, the public key must be stored in a KEY record in a zone served by the name server. +SIG(0) uses public key cryptography\&. To use a SIG(0) key, the public key must be stored in a KEY record in a zone served by the name server\&. .PP -GSS\-TSIG uses Kerberos credentials. Standard GSS\-TSIG mode is switched on with the +GSS\-TSIG uses Kerberos credentials\&. Standard GSS\-TSIG mode is switched on with the \fB\-g\fR -flag. A non\-standards\-compliant variant of GSS\-TSIG used by Windows 2000 can be switched on with the +flag\&. A non\-standards\-compliant variant of GSS\-TSIG used by Windows 2000 can be switched on with the \fB\-o\fR -flag. +flag\&. .SH "OPTIONS" .PP \-d .RS 4 -Debug mode. This provides tracing information about the update requests that are made and the replies received from the name server. +Debug mode\&. This provides tracing information about the update requests that are made and the replies received from the name server\&. .RE .PP \-D .RS 4 -Extra debug mode. +Extra debug mode\&. .RE .PP \-k \fIkeyfile\fR .RS 4 -The file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing a -\fInamed.conf\fR\-format +The file containing the TSIG authentication key\&. Keyfiles may be in two formats: a single file containing a +named\&.conf\-format \fBkey\fR statement, which may be generated automatically by \fBddns\-confgen\fR, or a pair of files whose names are of the format -\fIK{name}.+157.+{random}.key\fR +K{name}\&.+157\&.+{random}\&.key and -\fIK{name}.+157.+{random}.private\fR, which can be generated by -\fBdnssec\-keygen\fR. The +K{name}\&.+157\&.+{random}\&.private, which can be generated by +\fBdnssec\-keygen\fR\&. The \fB\-k\fR -may also be used to specify a SIG(0) key used to authenticate Dynamic DNS update requests. In this case, the key specified is not an HMAC\-MD5 key. +may also be used to specify a SIG(0) key used to authenticate Dynamic DNS update requests\&. In this case, the key specified is not an HMAC\-MD5 key\&. .RE .PP \-l .RS 4 -Local\-host only mode. This sets the server address to localhost (disabling the +Local\-host only mode\&. This sets the server address to localhost (disabling the \fBserver\fR -so that the server address cannot be overridden). Connections to the local server will use a TSIG key found in -\fI/var/run/named/session.key\fR, which is automatically generated by +so that the server address cannot be overridden)\&. Connections to the local server will use a TSIG key found in +/var/run/named/session\&.key, which is automatically generated by \fBnamed\fR if any local master zone has set \fBupdate\-policy\fR to -\fBlocal\fR. The location of this key file can be overridden with the +\fBlocal\fR\&. The location of this key file can be overridden with the \fB\-k\fR -option. +option\&. .RE .PP \-L \fIlevel\fR .RS 4 -Set the logging debug level. If zero, logging is disabled. +Set the logging debug level\&. If zero, logging is disabled\&. .RE .PP \-p \fIport\fR .RS 4 -Set the port to use for connections to a name server. The default is 53. +Set the port to use for connections to a name server\&. The default is 53\&. .RE .PP \-r \fIudpretries\fR .RS 4 -The number of UDP retries. The default is 3. If zero, only one update request will be made. +The number of UDP retries\&. The default is 3\&. If zero, only one update request will be made\&. .RE .PP \-R \fIrandomdev\fR .RS 4 -Where to obtain randomness. If the operating system does not provide a -\fI/dev/random\fR -or equivalent device, the default source of randomness is keyboard input. -\fIrandomdev\fR -specifies the name of a character device or file containing random data to be used instead of the default. The special value -\fIkeyboard\fR -indicates that keyboard input should be used. This option may be specified multiple times. +Where to obtain randomness\&. If the operating system does not provide a +/dev/random +or equivalent device, the default source of randomness is keyboard input\&. +randomdev +specifies the name of a character device or file containing random data to be used instead of the default\&. The special value +keyboard +indicates that keyboard input should be used\&. This option may be specified multiple times\&. .RE .PP \-t \fItimeout\fR .RS 4 -The maximum time an update request can take before it is aborted. The default is 300 seconds. Zero can be used to disable the timeout. +The maximum time an update request can take before it is aborted\&. The default is 300 seconds\&. Zero can be used to disable the timeout\&. .RE .PP \-u \fIudptimeout\fR .RS 4 -The UDP retry interval. The default is 3 seconds. If zero, the interval will be computed from the timeout interval and number of UDP retries. +The UDP retry interval\&. The default is 3 seconds\&. If zero, the interval will be computed from the timeout interval and number of UDP retries\&. .RE .PP \-v .RS 4 -Use TCP even for small update requests. By default, +Use TCP even for small update requests\&. By default, \fBnsupdate\fR -uses UDP to send update requests to the name server unless they are too large to fit in a UDP request in which case TCP will be used. TCP may be preferable when a batch of update requests is made. +uses UDP to send update requests to the name server unless they are too large to fit in a UDP request in which case TCP will be used\&. TCP may be preferable when a batch of update requests is made\&. .RE .PP \-V .RS 4 -Print the version number and exit. +Print the version number and exit\&. .RE .PP \-y \fI[hmac:]\fR\fIkeyname:secret\fR .RS 4 -Literal TSIG authentication key. +Literal TSIG authentication key\&. \fIkeyname\fR is the name of the key, and \fIsecret\fR -is the base64 encoded shared secret. +is the base64 encoded shared secret\&. \fIhmac\fR is the name of the key algorithm; valid choices are hmac\-md5, @@ -178,105 +193,104 @@ hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384, or -hmac\-sha512. If +hmac\-sha512\&. If \fIhmac\fR is not specified, the default is -hmac\-md5. +hmac\-md5\&. .sp NOTE: Use of the \fB\-y\fR -option is discouraged because the shared secret is supplied as a command line argument in clear text. This may be visible in the output from +option is discouraged because the shared secret is supplied as a command line argument in clear text\&. This may be visible in the output from \fBps\fR(1) -or in a history file maintained by the user's shell. +or in a history file maintained by the user\*(Aqs shell\&. .RE .SH "INPUT FORMAT" .PP \fBnsupdate\fR reads input from \fIfilename\fR -or standard input. Each command is supplied on exactly one line of input. Some commands are for administrative purposes. The others are either update instructions or prerequisite checks on the contents of the zone. These checks set conditions that some name or set of resource records (RRset) either exists or is absent from the zone. These conditions must be met if the entire update request is to succeed. Updates will be rejected if the tests for the prerequisite conditions fail. +or standard input\&. Each command is supplied on exactly one line of input\&. Some commands are for administrative purposes\&. The others are either update instructions or prerequisite checks on the contents of the zone\&. These checks set conditions that some name or set of resource records (RRset) either exists or is absent from the zone\&. These conditions must be met if the entire update request is to succeed\&. Updates will be rejected if the tests for the prerequisite conditions fail\&. .PP -Every update request consists of zero or more prerequisites and zero or more updates. This allows a suitably authenticated update request to proceed if some specified resource records are present or missing from the zone. A blank input line (or the +Every update request consists of zero or more prerequisites and zero or more updates\&. This allows a suitably authenticated update request to proceed if some specified resource records are present or missing from the zone\&. A blank input line (or the \fBsend\fR -command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server. +command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server\&. .PP The command formats and their meaning are as follows: .PP \fBserver\fR {servername} [port] .RS 4 Sends all dynamic update requests to the name server -\fIservername\fR. When no server statement is provided, +\fIservername\fR\&. When no server statement is provided, \fBnsupdate\fR -will send updates to the master server of the correct zone. The MNAME field of that zone's SOA record will identify the master server for that zone. +will send updates to the master server of the correct zone\&. The MNAME field of that zone\*(Aqs SOA record will identify the master server for that zone\&. \fIport\fR is the port number on \fIservername\fR -where the dynamic update requests get sent. If no port number is specified, the default DNS port number of 53 is used. +where the dynamic update requests get sent\&. If no port number is specified, the default DNS port number of 53 is used\&. .RE .PP \fBlocal\fR {address} [port] .RS 4 Sends all dynamic update requests using the local -\fIaddress\fR. When no local statement is provided, +\fIaddress\fR\&. When no local statement is provided, \fBnsupdate\fR -will send updates using an address and port chosen by the system. +will send updates using an address and port chosen by the system\&. \fIport\fR -can additionally be used to make requests come from a specific port. If no port number is specified, the system will assign one. +can additionally be used to make requests come from a specific port\&. If no port number is specified, the system will assign one\&. .RE .PP \fBzone\fR {zonename} .RS 4 Specifies that all updates are to be made to the zone -\fIzonename\fR. If no +\fIzonename\fR\&. If no \fIzone\fR statement is provided, \fBnsupdate\fR -will attempt determine the correct zone to update based on the rest of the input. +will attempt determine the correct zone to update based on the rest of the input\&. .RE .PP \fBclass\fR {classname} .RS 4 -Specify the default class. If no +Specify the default class\&. If no \fIclass\fR is specified, the default class is -\fIIN\fR. +\fIIN\fR\&. .RE .PP \fBttl\fR {seconds} .RS 4 -Specify the default time to live for records to be added. The value +Specify the default time to live for records to be added\&. The value \fInone\fR -will clear the default ttl. +will clear the default ttl\&. .RE .PP \fBkey\fR [hmac:] {keyname} {secret} .RS 4 Specifies that all updates are to be TSIG\-signed using the -\fIkeyname\fR -\fIsecret\fR -pair. If +\fIkeyname\fR\fIsecret\fR +pair\&. If \fIhmac\fR is specified, then it sets the signing algorithm in use; the default is -hmac\-md5. The +hmac\-md5\&. The \fBkey\fR command overrides any key specified on the command line via \fB\-y\fR or -\fB\-k\fR. +\fB\-k\fR\&. .RE .PP \fBgsstsig\fR .RS 4 -Use GSS\-TSIG to sign the updated. This is equivalent to specifying +Use GSS\-TSIG to sign the updated\&. This is equivalent to specifying \fB\-g\fR -on the commandline. +on the commandline\&. .RE .PP \fBoldgsstsig\fR .RS 4 -Use the Windows 2000 version of GSS\-TSIG to sign the updated. This is equivalent to specifying +Use the Windows 2000 version of GSS\-TSIG to sign the updated\&. This is equivalent to specifying \fB\-o\fR -on the commandline. +on the commandline\&. .RE .PP \fBrealm\fR {[realm_name]} @@ -284,20 +298,20 @@ on the commandline. When using GSS\-TSIG use \fIrealm_name\fR rather than the default realm in -\fIkrb5.conf\fR. If no realm is specified the saved realm is cleared. +krb5\&.conf\&. If no realm is specified the saved realm is cleared\&. .RE .PP \fB[prereq]\fR\fB nxdomain\fR {domain\-name} .RS 4 Requires that no resource record of any type exists with name -\fIdomain\-name\fR. +\fIdomain\-name\fR\&. .RE .PP \fB[prereq]\fR\fB yxdomain\fR {domain\-name} .RS 4 Requires that \fIdomain\-name\fR -exists (has as at least one resource record, of any type). +exists (has as at least one resource record, of any type)\&. .RE .PP \fB[prereq]\fR\fB nxrrset\fR {domain\-name} [class] {type} @@ -306,9 +320,9 @@ Requires that no resource record exists of the specified \fItype\fR, \fIclass\fR and -\fIdomain\-name\fR. If +\fIdomain\-name\fR\&. If \fIclass\fR -is omitted, IN (internet) is assumed. +is omitted, IN (internet) is assumed\&. .RE .PP \fB[prereq]\fR\fB yxrrset\fR {domain\-name} [class] {type} @@ -318,9 +332,9 @@ This requires that a resource record of the specified \fIclass\fR and \fIdomain\-name\fR -must exist. If +must exist\&. If \fIclass\fR -is omitted, IN (internet) is assumed. +is omitted, IN (internet) is assumed\&. .RE .PP \fB[prereq]\fR\fB yxrrset\fR {domain\-name} [class] {type} {data...} @@ -331,26 +345,26 @@ from each set of prerequisites of this form sharing a common \fItype\fR, \fIclass\fR, and \fIdomain\-name\fR -are combined to form a set of RRs. This set of RRs must exactly match the set of RRs existing in the zone at the given +are combined to form a set of RRs\&. This set of RRs must exactly match the set of RRs existing in the zone at the given \fItype\fR, \fIclass\fR, and -\fIdomain\-name\fR. The +\fIdomain\-name\fR\&. The \fIdata\fR -are written in the standard text representation of the resource record's RDATA. +are written in the standard text representation of the resource record\*(Aqs RDATA\&. .RE .PP \fB[update]\fR\fB del\fR\fB[ete]\fR {domain\-name} [ttl] [class] [type\ [data...]] .RS 4 Deletes any resource records named -\fIdomain\-name\fR. If +\fIdomain\-name\fR\&. If \fItype\fR and \fIdata\fR -is provided, only matching resource records will be removed. The internet class is assumed if +is provided, only matching resource records will be removed\&. The internet class is assumed if \fIclass\fR -is not supplied. The +is not supplied\&. The \fIttl\fR -is ignored, and is only allowed for compatibility. +is ignored, and is only allowed for compatibility\&. .RE .PP \fB[update]\fR\fB add\fR {domain\-name} {ttl} [class] {type} {data...} @@ -359,99 +373,105 @@ Adds a new resource record with the specified \fIttl\fR, \fIclass\fR and -\fIdata\fR. +\fIdata\fR\&. .RE .PP \fBshow\fR .RS 4 -Displays the current message, containing all of the prerequisites and updates specified since the last send. +Displays the current message, containing all of the prerequisites and updates specified since the last send\&. .RE .PP \fBsend\fR .RS 4 -Sends the current message. This is equivalent to entering a blank line. +Sends the current message\&. This is equivalent to entering a blank line\&. .RE .PP \fBanswer\fR .RS 4 -Displays the answer. +Displays the answer\&. .RE .PP \fBdebug\fR .RS 4 -Turn on debugging. +Turn on debugging\&. .RE .PP \fBversion\fR .RS 4 -Print version number. +Print version number\&. .RE .PP \fBhelp\fR .RS 4 -Print a list of commands. +Print a list of commands\&. .RE .PP -Lines beginning with a semicolon are comments and are ignored. +Lines beginning with a semicolon are comments and are ignored\&. .SH "EXAMPLES" .PP The examples below show how \fBnsupdate\fR could be used to insert and delete resource records from the -\fBexample.com\fR -zone. Notice that the input in each example contains a trailing blank line so that a group of commands are sent as one dynamic update request to the master name server for -\fBexample.com\fR. +\fBexample\&.com\fR +zone\&. Notice that the input in each example contains a trailing blank line so that a group of commands are sent as one dynamic update request to the master name server for +\fBexample\&.com\fR\&. .sp +.if n \{\ .RS 4 +.\} .nf # nsupdate -> update delete oldhost.example.com A -> update add newhost.example.com 86400 A 172.16.1.1 +> update delete oldhost\&.example\&.com A +> update add newhost\&.example\&.com 86400 A 172\&.16\&.1\&.1 > send .fi +.if n \{\ .RE -.sp +.\} .PP Any A records for -\fBoldhost.example.com\fR -are deleted. And an A record for -\fBnewhost.example.com\fR -with IP address 172.16.1.1 is added. The newly\-added record has a 1 day TTL (86400 seconds). +\fBoldhost\&.example\&.com\fR +are deleted\&. And an A record for +\fBnewhost\&.example\&.com\fR +with IP address 172\&.16\&.1\&.1 is added\&. The newly\-added record has a 1 day TTL (86400 seconds)\&. .sp +.if n \{\ .RS 4 +.\} .nf # nsupdate -> prereq nxdomain nickname.example.com -> update add nickname.example.com 86400 CNAME somehost.example.com +> prereq nxdomain nickname\&.example\&.com +> update add nickname\&.example\&.com 86400 CNAME somehost\&.example\&.com > send .fi +.if n \{\ .RE -.sp +.\} .PP The prerequisite condition gets the name server to check that there are no resource records of any type for -\fBnickname.example.com\fR. If there are, the update request fails. If this name does not exist, a CNAME for it is added. This ensures that when the CNAME is added, it cannot conflict with the long\-standing rule in RFC 1034 that a name must not exist as any other record type if it exists as a CNAME. (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have RRSIG, DNSKEY and NSEC records.) +\fBnickname\&.example\&.com\fR\&. If there are, the update request fails\&. If this name does not exist, a CNAME for it is added\&. This ensures that when the CNAME is added, it cannot conflict with the long\-standing rule in RFC 1034 that a name must not exist as any other record type if it exists as a CNAME\&. (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have RRSIG, DNSKEY and NSEC records\&.) .SH "FILES" .PP -\fB/etc/resolv.conf\fR +\fB/etc/resolv\&.conf\fR .RS 4 used to identify default name server .RE .PP -\fB/var/run/named/session.key\fR +\fB/var/run/named/session\&.key\fR .RS 4 sets the default TSIG key for use in local\-only mode .RE .PP -\fBK{name}.+157.+{random}.key\fR +\fBK{name}\&.+157\&.+{random}\&.key\fR .RS 4 base\-64 encoding of HMAC\-MD5 key created by -\fBdnssec\-keygen\fR(8). +\fBdnssec-keygen\fR(8)\&. .RE .PP -\fBK{name}.+157.+{random}.private\fR +\fBK{name}\&.+157\&.+{random}\&.private\fR .RS 4 base\-64 encoding of HMAC\-MD5 key created by -\fBdnssec\-keygen\fR(8). +\fBdnssec-keygen\fR(8)\&. .RE .SH "SEE ALSO" .PP @@ -463,13 +483,17 @@ RFC 1034, RFC 2535, RFC 2931, \fBnamed\fR(8), -\fBddns\-confgen\fR(8), -\fBdnssec\-keygen\fR(8). +\fBddns-confgen\fR(8), +\fBdnssec-keygen\fR(8)\&. .SH "BUGS" .PP -The TSIG key is redundantly stored in two separate files. This is a consequence of nsupdate using the DST library for its cryptographic operations, and may change in future releases. +The TSIG key is redundantly stored in two separate files\&. This is a consequence of nsupdate using the DST library for its cryptographic operations, and may change in future releases\&. +.SH "AUTHOR" +.PP +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004\-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br -Copyright \(co 2000\-2003 Internet Software Consortium. +Copyright \(co 2004-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000-2003 Internet Software Consortium. .br diff --git a/bin/nsupdate/nsupdate.c b/bin/nsupdate/nsupdate.c index bf907f1580fb..683e42b9be7b 100644 --- a/bin/nsupdate/nsupdate.c +++ b/bin/nsupdate/nsupdate.c @@ -219,6 +219,8 @@ typedef struct nsu_gssinfo { } nsu_gssinfo_t; static void +failed_gssrequest(); +static void start_gssrequest(dns_name_t *master); static void send_gssrequest(isc_sockaddr_t *destaddr, dns_message_t *msg, @@ -640,6 +642,8 @@ read_sessionkey(isc_mem_t *mctx, isc_log_t *lctx) { len = strlen(algorithm) + strlen(mykeyname) + strlen(secretstr) + 3; keystr = isc_mem_allocate(mctx, len); + if (keystr == NULL) + fatal("out of memory"); snprintf(keystr, len, "%s:%s:%s", algorithm, mykeyname, secretstr); setup_keystr(); @@ -2614,7 +2618,8 @@ get_ticket_realm(isc_mem_t *mctx) { krb5_error_code rc; krb5_ccache ccache; krb5_principal princ; - char *name, *ticket_realm; + char *name; + const char * ticket_realm; rc = krb5_init_context(&ctx); if (rc != 0) @@ -2654,6 +2659,15 @@ get_ticket_realm(isc_mem_t *mctx) { fprintf(stderr, "Found realm from ticket: %s\n", realm+1); } +static void +failed_gssrequest() { + seenerror = ISC_TRUE; + + dns_name_free(&tmpzonename, gmctx); + dns_name_free(&restart_master, gmctx); + + done_update(); +} static void start_gssrequest(dns_name_t *master) { @@ -2661,7 +2675,7 @@ start_gssrequest(dns_name_t *master) { isc_buffer_t buf; isc_result_t result; isc_uint32_t val = 0; - dns_message_t *rmsg; + dns_message_t *rmsg = NULL; dns_request_t *request = NULL; dns_name_t *servname; dns_fixedname_t fname; @@ -2741,14 +2755,24 @@ start_gssrequest(dns_name_t *master) { result = dns_tkey_buildgssquery(rmsg, keyname, servname, NULL, 0, &context, use_win2k_gsstsig, gmctx, &err_message); - if (result == ISC_R_FAILURE) - fatal("tkey query failed: %s", - err_message != NULL ? err_message : "unknown error"); + if (result == ISC_R_FAILURE) { + fprintf(stderr, "tkey query failed: %s\n", + err_message != NULL ? err_message : "unknown error"); + goto failure; + } if (result != ISC_R_SUCCESS) fatal("dns_tkey_buildgssquery failed: %s", isc_result_totext(result)); send_gssrequest(kserver, rmsg, &request, context); + return; + +failure: + if (rmsg != NULL) + dns_message_destroy(&rmsg); + if (err_message != NULL) + isc_mem_free(gmctx, err_message); + failed_gssrequest(); } static void diff --git a/bin/nsupdate/nsupdate.docbook b/bin/nsupdate/nsupdate.docbook index b973c1f693e9..f88144b27c4a 100644 --- a/bin/nsupdate/nsupdate.docbook +++ b/bin/nsupdate/nsupdate.docbook @@ -1,6 +1,3 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - Copyright (C) 2004-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000-2003 Internet Software Consortium. @@ -18,9 +15,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.nsupdate"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.nsupdate"> + <info> + <date>2014-04-18</date> + </info> <refentryinfo> - <date>April 18, 2014</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> <refentrytitle><application>nsupdate</application></refentrytitle> @@ -57,30 +59,30 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>nsupdate</command> - <arg><option>-d</option></arg> - <arg><option>-D</option></arg> - <arg><option>-L <replaceable class="parameter">level</replaceable></option></arg> - <group> - <arg><option>-g</option></arg> - <arg><option>-o</option></arg> - <arg><option>-l</option></arg> - <arg><option>-y <replaceable class="parameter"><optional>hmac:</optional>keyname:secret</replaceable></option></arg> - <arg><option>-k <replaceable class="parameter">keyfile</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-d</option></arg> + <arg choice="opt" rep="norepeat"><option>-D</option></arg> + <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">level</replaceable></option></arg> + <group choice="opt" rep="norepeat"> + <arg choice="opt" rep="norepeat"><option>-g</option></arg> + <arg choice="opt" rep="norepeat"><option>-o</option></arg> + <arg choice="opt" rep="norepeat"><option>-l</option></arg> + <arg choice="opt" rep="norepeat"><option>-y <replaceable class="parameter"><optional>hmac:</optional>keyname:secret</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">keyfile</replaceable></option></arg> </group> - <arg><option>-t <replaceable class="parameter">timeout</replaceable></option></arg> - <arg><option>-u <replaceable class="parameter">udptimeout</replaceable></option></arg> - <arg><option>-r <replaceable class="parameter">udpretries</replaceable></option></arg> - <arg><option>-R <replaceable class="parameter">randomdev</replaceable></option></arg> - <arg><option>-v</option></arg> - <arg><option>-V</option></arg> - <arg>filename</arg> + <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">timeout</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-u <replaceable class="parameter">udptimeout</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">udpretries</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-R <replaceable class="parameter">randomdev</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-v</option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="opt" rep="norepeat">filename</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>nsupdate</command> is used to submit Dynamic DNS Update requests as defined in RFC 2136 to a name server. @@ -136,10 +138,10 @@ non-standards-compliant variant of GSS-TSIG used by Windows 2000 can be switched on with the <option>-o</option> flag. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -313,10 +315,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>INPUT FORMAT</title></info> - <refsect1> - <title>INPUT FORMAT</title> <para><command>nsupdate</command> reads input from <parameter>filename</parameter> @@ -348,8 +350,8 @@ <varlistentry> <term> <command>server</command> - <arg choice="req">servername</arg> - <arg choice="opt">port</arg> + <arg choice="req" rep="norepeat">servername</arg> + <arg choice="opt" rep="norepeat">port</arg> </term> <listitem> <para> @@ -375,8 +377,8 @@ <varlistentry> <term> <command>local</command> - <arg choice="req">address</arg> - <arg choice="opt">port</arg> + <arg choice="req" rep="norepeat">address</arg> + <arg choice="opt" rep="norepeat">port</arg> </term> <listitem> <para> @@ -398,7 +400,7 @@ <varlistentry> <term> <command>zone</command> - <arg choice="req">zonename</arg> + <arg choice="req" rep="norepeat">zonename</arg> </term> <listitem> <para> @@ -417,7 +419,7 @@ <varlistentry> <term> <command>class</command> - <arg choice="req">classname</arg> + <arg choice="req" rep="norepeat">classname</arg> </term> <listitem> <para> @@ -432,7 +434,7 @@ <varlistentry> <term> <command>ttl</command> - <arg choice="req">seconds</arg> + <arg choice="req" rep="norepeat">seconds</arg> </term> <listitem> <para> @@ -446,8 +448,8 @@ <varlistentry> <term> <command>key</command> - <arg choice="opt">hmac:</arg><arg choice="req">keyname</arg> - <arg choice="req">secret</arg> + <arg choice="opt" rep="norepeat">hmac:</arg><arg choice="req" rep="norepeat">keyname</arg> + <arg choice="req" rep="norepeat">secret</arg> </term> <listitem> <para> @@ -490,7 +492,7 @@ <varlistentry> <term> <command>realm</command> - <arg choice="req"><optional>realm_name</optional></arg> + <arg choice="req" rep="norepeat"><optional>realm_name</optional></arg> </term> <listitem> <para> @@ -504,7 +506,7 @@ <varlistentry> <term> <command><optional>prereq</optional> nxdomain</command> - <arg choice="req">domain-name</arg> + <arg choice="req" rep="norepeat">domain-name</arg> </term> <listitem> <para> @@ -518,7 +520,7 @@ <varlistentry> <term> <command><optional>prereq</optional> yxdomain</command> - <arg choice="req">domain-name</arg> + <arg choice="req" rep="norepeat">domain-name</arg> </term> <listitem> <para> @@ -532,9 +534,9 @@ <varlistentry> <term> <command><optional>prereq</optional> nxrrset</command> - <arg choice="req">domain-name</arg> - <arg choice="opt">class</arg> - <arg choice="req">type</arg> + <arg choice="req" rep="norepeat">domain-name</arg> + <arg choice="opt" rep="norepeat">class</arg> + <arg choice="req" rep="norepeat">type</arg> </term> <listitem> <para> @@ -554,9 +556,9 @@ <varlistentry> <term> <command><optional>prereq</optional> yxrrset</command> - <arg choice="req">domain-name</arg> - <arg choice="opt">class</arg> - <arg choice="req">type</arg> + <arg choice="req" rep="norepeat">domain-name</arg> + <arg choice="opt" rep="norepeat">class</arg> + <arg choice="req" rep="norepeat">type</arg> </term> <listitem> <para> @@ -576,9 +578,9 @@ <varlistentry> <term> <command><optional>prereq</optional> yxrrset</command> - <arg choice="req">domain-name</arg> - <arg choice="opt">class</arg> - <arg choice="req">type</arg> + <arg choice="req" rep="norepeat">domain-name</arg> + <arg choice="opt" rep="norepeat">class</arg> + <arg choice="req" rep="norepeat">type</arg> <arg choice="req" rep="repeat">data</arg> </term> <listitem> @@ -610,10 +612,10 @@ <varlistentry> <term> <command><optional>update</optional> del<optional>ete</optional></command> - <arg choice="req">domain-name</arg> - <arg choice="opt">ttl</arg> - <arg choice="opt">class</arg> - <arg choice="opt">type <arg choice="opt" rep="repeat">data</arg></arg> + <arg choice="req" rep="norepeat">domain-name</arg> + <arg choice="opt" rep="norepeat">ttl</arg> + <arg choice="opt" rep="norepeat">class</arg> + <arg choice="opt" rep="norepeat">type <arg choice="opt" rep="repeat">data</arg></arg> </term> <listitem> <para> @@ -636,10 +638,10 @@ <varlistentry> <term> <command><optional>update</optional> add</command> - <arg choice="req">domain-name</arg> - <arg choice="req">ttl</arg> - <arg choice="opt">class</arg> - <arg choice="req">type</arg> + <arg choice="req" rep="norepeat">domain-name</arg> + <arg choice="req" rep="norepeat">ttl</arg> + <arg choice="opt" rep="norepeat">class</arg> + <arg choice="req" rep="norepeat">type</arg> <arg choice="req" rep="repeat">data</arg> </term> <listitem> @@ -729,10 +731,10 @@ Lines beginning with a semicolon are comments and are ignored. </para> - </refsect1> + </refsection> + + <refsection><info><title>EXAMPLES</title></info> - <refsect1> - <title>EXAMPLES</title> <para> The examples below show how <command>nsupdate</command> @@ -780,10 +782,10 @@ (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have RRSIG, DNSKEY and NSEC records.) </para> - </refsect1> + </refsection> + + <refsection><info><title>FILES</title></info> - <refsect1> - <title>FILES</title> <variablelist> <varlistentry> @@ -829,10 +831,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para> <citetitle>RFC 2136</citetitle>, <citetitle>RFC 3007</citetitle>, @@ -851,19 +853,15 @@ <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum> </citerefentry>. </para> - </refsect1> + </refsection> + + <refsection><info><title>BUGS</title></info> - <refsect1> - <title>BUGS</title> <para> 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. </para> - </refsect1> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> + </refsection> +</refentry> diff --git a/bin/nsupdate/nsupdate.html b/bin/nsupdate/nsupdate.html index 76c54db290d5..7f1c8c229410 100644 --- a/bin/nsupdate/nsupdate.html +++ b/bin/nsupdate/nsupdate.html @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>nsupdate</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.nsupdate"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -31,9 +30,9 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">nsupdate</code> [<code class="option">-d</code>] [<code class="option">-D</code>] [<code class="option">-L <em class="replaceable"><code>level</code></em></code>] [[<code class="option">-g</code>] | [<code class="option">-o</code>] | [<code class="option">-l</code>] | [<code class="option">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></code>] | [<code class="option">-k <em class="replaceable"><code>keyfile</code></em></code>]] [<code class="option">-t <em class="replaceable"><code>timeout</code></em></code>] [<code class="option">-u <em class="replaceable"><code>udptimeout</code></em></code>] [<code class="option">-r <em class="replaceable"><code>udpretries</code></em></code>] [<code class="option">-R <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-v</code>] [<code class="option">-V</code>] [filename]</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543491"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">nsupdate</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>nsupdate</strong></span> 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 @@ -44,14 +43,14 @@ </p> <p> Zones that are under dynamic control via - <span><strong class="command">nsupdate</strong></span> + <span class="command"><strong>nsupdate</strong></span> or a DHCP server should not be edited by hand. Manual edits could conflict with dynamic updates and cause data to be lost. </p> <p> The resource records that are dynamically added or removed with - <span><strong class="command">nsupdate</strong></span> + <span class="command"><strong>nsupdate</strong></span> 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. @@ -65,15 +64,15 @@ <p> TSIG relies on a shared secret that should only be known to - <span><strong class="command">nsupdate</strong></span> and the name server. + <span class="command"><strong>nsupdate</strong></span> and the name server. For instance, suitable <span class="type">key</span> and <span class="type">server</span> statements would be added to <code class="filename">/etc/named.conf</code> 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 <span><strong class="command">ddns-confgen</strong></span> + TSIG authentication. You can use <span class="command"><strong>ddns-confgen</strong></span> to generate suitable configuration fragments. - <span><strong class="command">nsupdate</strong></span> + <span class="command"><strong>nsupdate</strong></span> uses the <code class="option">-y</code> or <code class="option">-k</code> options to provide the TSIG shared secret. These options are mutually exclusive. </p> @@ -89,9 +88,9 @@ 2000 can be switched on with the <code class="option">-o</code> flag. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543564"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-d</span></dt> <dd><p> Debug mode. This provides tracing information about the @@ -106,12 +105,12 @@ <dd><p> The file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing - a <code class="filename">named.conf</code>-format <span><strong class="command">key</strong></span> + a <code class="filename">named.conf</code>-format <span class="command"><strong>key</strong></span> statement, which may be generated automatically by - <span><strong class="command">ddns-confgen</strong></span>, or a pair of files whose names are + <span class="command"><strong>ddns-confgen</strong></span>, or a pair of files whose names are of the format <code class="filename">K{name}.+157.+{random}.key</code> and <code class="filename">K{name}.+157.+{random}.private</code>, which can be - generated by <span><strong class="command">dnssec-keygen</strong></span>. + generated by <span class="command"><strong>dnssec-keygen</strong></span>. The <code class="option">-k</code> 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. @@ -119,12 +118,12 @@ <dt><span class="term">-l</span></dt> <dd><p> Local-host only mode. This sets the server address to - localhost (disabling the <span><strong class="command">server</strong></span> so that the server + localhost (disabling the <span class="command"><strong>server</strong></span> so that the server address cannot be overridden). Connections to the local server will use a TSIG key found in <code class="filename">/var/run/named/session.key</code>, - which is automatically generated by <span><strong class="command">named</strong></span> if any - local master zone has set <span><strong class="command">update-policy</strong></span> to - <span><strong class="command">local</strong></span>. The location of this key file can be + which is automatically generated by <span class="command"><strong>named</strong></span> if any + local master zone has set <span class="command"><strong>update-policy</strong></span> to + <span class="command"><strong>local</strong></span>. The location of this key file can be overridden with the <code class="option">-k</code> option. </p></dd> <dt><span class="term">-L <em class="replaceable"><code>level</code></em></span></dt> @@ -167,7 +166,7 @@ <dt><span class="term">-v</span></dt> <dd><p> Use TCP even for small update requests. - By default, <span><strong class="command">nsupdate</strong></span> + By default, <span class="command"><strong>nsupdate</strong></span> 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. @@ -199,9 +198,9 @@ </dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543963"></a><h2>INPUT FORMAT</h2> -<p><span><strong class="command">nsupdate</strong></span> +<div class="refsection"> +<a name="id-1.9"></a><h2>INPUT FORMAT</h2> +<p><span class="command"><strong>nsupdate</strong></span> reads input from <em class="parameter"><code>filename</code></em> or standard input. @@ -220,7 +219,7 @@ 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 <span><strong class="command">send</strong></span> command) + A blank input line (or the <span class="command"><strong>send</strong></span> command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server. @@ -228,9 +227,9 @@ <p> The command formats and their meaning are as follows: </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term"> - <span><strong class="command">server</strong></span> + <span class="command"><strong>server</strong></span> {servername} [port] </span></dt> @@ -238,7 +237,7 @@ Sends all dynamic update requests to the name server <em class="parameter"><code>servername</code></em>. When no server statement is provided, - <span><strong class="command">nsupdate</strong></span> + <span class="command"><strong>nsupdate</strong></span> will send updates to the master server of the correct zone. The MNAME field of that zone's SOA record will identify the master @@ -252,7 +251,7 @@ used. </p></dd> <dt><span class="term"> - <span><strong class="command">local</strong></span> + <span class="command"><strong>local</strong></span> {address} [port] </span></dt> @@ -261,7 +260,7 @@ <em class="parameter"><code>address</code></em>. When no local statement is provided, - <span><strong class="command">nsupdate</strong></span> + <span class="command"><strong>nsupdate</strong></span> will send updates using an address and port chosen by the system. <em class="parameter"><code>port</code></em> @@ -270,7 +269,7 @@ If no port number is specified, the system will assign one. </p></dd> <dt><span class="term"> - <span><strong class="command">zone</strong></span> + <span class="command"><strong>zone</strong></span> {zonename} </span></dt> <dd><p> @@ -279,12 +278,12 @@ If no <em class="parameter"><code>zone</code></em> statement is provided, - <span><strong class="command">nsupdate</strong></span> + <span class="command"><strong>nsupdate</strong></span> will attempt determine the correct zone to update based on the rest of the input. </p></dd> <dt><span class="term"> - <span><strong class="command">class</strong></span> + <span class="command"><strong>class</strong></span> {classname} </span></dt> <dd><p> @@ -294,7 +293,7 @@ <em class="parameter"><code>IN</code></em>. </p></dd> <dt><span class="term"> - <span><strong class="command">ttl</strong></span> + <span class="command"><strong>ttl</strong></span> {seconds} </span></dt> <dd><p> @@ -303,7 +302,7 @@ ttl. </p></dd> <dt><span class="term"> - <span><strong class="command">key</strong></span> + <span class="command"><strong>key</strong></span> [hmac:] {keyname} {secret} </span></dt> @@ -312,19 +311,19 @@ <em class="parameter"><code>keyname</code></em> <em class="parameter"><code>secret</code></em> pair. If <em class="parameter"><code>hmac</code></em> is specified, then it sets the signing algorithm in use; the default is - <code class="literal">hmac-md5</code>. The <span><strong class="command">key</strong></span> + <code class="literal">hmac-md5</code>. The <span class="command"><strong>key</strong></span> command overrides any key specified on the command line via <code class="option">-y</code> or <code class="option">-k</code>. </p></dd> <dt><span class="term"> - <span><strong class="command">gsstsig</strong></span> + <span class="command"><strong>gsstsig</strong></span> </span></dt> <dd><p> Use GSS-TSIG to sign the updated. This is equivalent to specifying <code class="option">-g</code> on the commandline. </p></dd> <dt><span class="term"> - <span><strong class="command">oldgsstsig</strong></span> + <span class="command"><strong>oldgsstsig</strong></span> </span></dt> <dd><p> Use the Windows 2000 version of GSS-TSIG to sign the updated. @@ -332,7 +331,7 @@ commandline. </p></dd> <dt><span class="term"> - <span><strong class="command">realm</strong></span> + <span class="command"><strong>realm</strong></span> {[<span class="optional">realm_name</span>]} </span></dt> <dd><p> @@ -341,7 +340,7 @@ realm is specified the saved realm is cleared. </p></dd> <dt><span class="term"> - <span><strong class="command">[<span class="optional">prereq</span>] nxdomain</strong></span> + <span class="command"><strong>[<span class="optional">prereq</span>] nxdomain</strong></span> {domain-name} </span></dt> <dd><p> @@ -349,7 +348,7 @@ <em class="parameter"><code>domain-name</code></em>. </p></dd> <dt><span class="term"> - <span><strong class="command">[<span class="optional">prereq</span>] yxdomain</strong></span> + <span class="command"><strong>[<span class="optional">prereq</span>] yxdomain</strong></span> {domain-name} </span></dt> <dd><p> @@ -358,7 +357,7 @@ exists (has as at least one resource record, of any type). </p></dd> <dt><span class="term"> - <span><strong class="command">[<span class="optional">prereq</span>] nxrrset</strong></span> + <span class="command"><strong>[<span class="optional">prereq</span>] nxrrset</strong></span> {domain-name} [class] {type} @@ -374,7 +373,7 @@ is omitted, IN (internet) is assumed. </p></dd> <dt><span class="term"> - <span><strong class="command">[<span class="optional">prereq</span>] yxrrset</strong></span> + <span class="command"><strong>[<span class="optional">prereq</span>] yxrrset</strong></span> {domain-name} [class] {type} @@ -391,7 +390,7 @@ is omitted, IN (internet) is assumed. </p></dd> <dt><span class="term"> - <span><strong class="command">[<span class="optional">prereq</span>] yxrrset</strong></span> + <span class="command"><strong>[<span class="optional">prereq</span>] yxrrset</strong></span> {domain-name} [class] {type} @@ -420,7 +419,7 @@ RDATA. </p></dd> <dt><span class="term"> - <span><strong class="command">[<span class="optional">update</span>] del[<span class="optional">ete</span>]</strong></span> + <span class="command"><strong>[<span class="optional">update</span>] del[<span class="optional">ete</span>]</strong></span> {domain-name} [ttl] [class] @@ -441,7 +440,7 @@ is ignored, and is only allowed for compatibility. </p></dd> <dt><span class="term"> - <span><strong class="command">[<span class="optional">update</span>] add</strong></span> + <span class="command"><strong>[<span class="optional">update</span>] add</strong></span> {domain-name} {ttl} [class] @@ -456,7 +455,7 @@ <em class="parameter"><code>data</code></em>. </p></dd> <dt><span class="term"> - <span><strong class="command">show</strong></span> + <span class="command"><strong>show</strong></span> </span></dt> <dd><p> Displays the current message, containing all of the @@ -464,32 +463,32 @@ updates specified since the last send. </p></dd> <dt><span class="term"> - <span><strong class="command">send</strong></span> + <span class="command"><strong>send</strong></span> </span></dt> <dd><p> Sends the current message. This is equivalent to entering a blank line. </p></dd> <dt><span class="term"> - <span><strong class="command">answer</strong></span> + <span class="command"><strong>answer</strong></span> </span></dt> <dd><p> Displays the answer. </p></dd> <dt><span class="term"> - <span><strong class="command">debug</strong></span> + <span class="command"><strong>debug</strong></span> </span></dt> <dd><p> Turn on debugging. </p></dd> <dt><span class="term"> - <span><strong class="command">version</strong></span> + <span class="command"><strong>version</strong></span> </span></dt> <dd><p> Print version number. </p></dd> <dt><span class="term"> - <span><strong class="command">help</strong></span> + <span class="command"><strong>help</strong></span> </span></dt> <dd><p> Print a list of commands. @@ -501,11 +500,11 @@ Lines beginning with a semicolon are comments and are ignored. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545067"></a><h2>EXAMPLES</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>EXAMPLES</h2> <p> The examples below show how - <span><strong class="command">nsupdate</strong></span> + <span class="command"><strong>nsupdate</strong></span> could be used to insert and delete resource records from the <span class="type">example.com</span> zone. @@ -555,9 +554,9 @@ RRSIG, DNSKEY and NSEC records.) </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545111"></a><h2>FILES</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.11"></a><h2>FILES</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term"><code class="constant">/etc/resolv.conf</code></span></dt> <dd><p> used to identify default name server @@ -578,8 +577,8 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2545197"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.12"></a><h2>SEE ALSO</h2> <p> <em class="citetitle">RFC 2136</em>, <em class="citetitle">RFC 3007</em>, @@ -593,8 +592,8 @@ <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545255"></a><h2>BUGS</h2> +<div class="refsection"> +<a name="id-1.13"></a><h2>BUGS</h2> <p> The TSIG key is redundantly stored in two separate files. This is a consequence of nsupdate using the DST library diff --git a/bin/rndc/Makefile.in b/bin/rndc/Makefile.in index f6100df9e16c..a1a0ec3989ed 100644 --- a/bin/rndc/Makefile.in +++ b/bin/rndc/Makefile.in @@ -1,4 +1,4 @@ -# Copyright (C) 2004, 2007, 2009, 2012 Internet Systems Consortium, Inc. ("ISC") +# Copyright (C) 2004, 2007, 2009, 2012, 2015 Internet Systems Consortium, Inc. ("ISC") # Copyright (C) 2000-2002 Internet Software Consortium. # # Permission to use, copy, modify, and/or distribute this software for any @@ -19,7 +19,7 @@ srcdir = @srcdir@ VPATH = @srcdir@ top_srcdir = @top_srcdir@ -@BIND9_VERSION@ +VERSION=@BIND9_VERSION@ @BIND9_MAKE_INCLUDES@ diff --git a/bin/rndc/rndc.8 b/bin/rndc/rndc.8 index 503108e69216..bbdda2a97b21 100644 --- a/bin/rndc/rndc.8 +++ b/bin/rndc/rndc.8 @@ -13,51 +13,66 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: December 04, 2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2013-12-04 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "RNDC" "8" "December 04, 2013" "BIND9" "BIND9" +.TH "RNDC" "8" "2013\-12\-04" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" rndc \- name server control utility .SH "SYNOPSIS" -.HP 5 +.HP \w'\fBrndc\fR\ 'u \fBrndc\fR [\fB\-b\ \fR\fB\fIsource\-address\fR\fR] [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-k\ \fR\fB\fIkey\-file\fR\fR] [\fB\-s\ \fR\fB\fIserver\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-V\fR] [\fB\-y\ \fR\fB\fIkey_id\fR\fR] {command} .SH "DESCRIPTION" .PP \fBrndc\fR -controls the operation of a name server. It supersedes the +controls the operation of a name server\&. It supersedes the \fBndc\fR -utility that was provided in old BIND releases. If +utility that was provided in old BIND releases\&. If \fBrndc\fR -is invoked with no command line options or arguments, it prints a short summary of the supported commands and the available options and their arguments. +is invoked with no command line options or arguments, it prints a short summary of the supported commands and the available options and their arguments\&. .PP \fBrndc\fR -communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of +communicates with the name server over a TCP connection, sending commands authenticated with digital signatures\&. In the current versions of \fBrndc\fR and -\fBnamed\fR, the only supported authentication algorithm is HMAC\-MD5, which uses a shared secret on each end of the connection. This provides TSIG\-style authentication for the command request and the name server's response. All commands sent over the channel must be signed by a key_id known to the server. +\fBnamed\fR, the only supported authentication algorithm is HMAC\-MD5, which uses a shared secret on each end of the connection\&. This provides TSIG\-style authentication for the command request and the name server\*(Aqs response\&. All commands sent over the channel must be signed by a key_id known to the server\&. .PP \fBrndc\fR -reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use. +reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use\&. .SH "OPTIONS" .PP \-b \fIsource\-address\fR .RS 4 Use \fIsource\-address\fR -as the source address for the connection to the server. Multiple instances are permitted to allow setting of both the IPv4 and IPv6 source addresses. +as the source address for the connection to the server\&. Multiple instances are permitted to allow setting of both the IPv4 and IPv6 source addresses\&. .RE .PP \-c \fIconfig\-file\fR @@ -65,7 +80,7 @@ as the source address for the connection to the server. Multiple instances are p Use \fIconfig\-file\fR as the configuration file instead of the default, -\fI/etc/rndc.conf\fR. +/etc/rndc\&.conf\&. .RE .PP \-k \fIkey\-file\fR @@ -73,47 +88,47 @@ as the configuration file instead of the default, Use \fIkey\-file\fR as the key file instead of the default, -\fI/etc/rndc.key\fR. The key in -\fI/etc/rndc.key\fR +/etc/rndc\&.key\&. The key in +/etc/rndc\&.key will be used to authenticate commands sent to the server if the \fIconfig\-file\fR -does not exist. +does not exist\&. .RE .PP \-s \fIserver\fR .RS 4 \fIserver\fR is the name or address of the server which matches a server statement in the configuration file for -\fBrndc\fR. If no server is supplied on the command line, the host named by the default\-server clause in the options statement of the +\fBrndc\fR\&. If no server is supplied on the command line, the host named by the default\-server clause in the options statement of the \fBrndc\fR -configuration file will be used. +configuration file will be used\&. .RE .PP \-p \fIport\fR .RS 4 Send commands to TCP port \fIport\fR -instead of BIND 9's default control channel port, 953. +instead of BIND 9\*(Aqs default control channel port, 953\&. .RE .PP \-V .RS 4 -Enable verbose logging. +Enable verbose logging\&. .RE .PP \-y \fIkey_id\fR .RS 4 Use the key \fIkey_id\fR -from the configuration file. +from the configuration file\&. \fIkey_id\fR must be known by \fBnamed\fR -with the same algorithm and secret string in order for control message validation to succeed. If no +with the same algorithm and secret string in order for control message validation to succeed\&. If no \fIkey_id\fR is specified, \fBrndc\fR -will first look for a key clause in the server statement of the server being used, or if no server statement is present for that host, then the default\-key clause of the options statement. Note that the configuration file contains shared secrets which are used to send authenticated control commands to name servers. It should therefore not have general read or write access. +will first look for a key clause in the server statement of the server being used, or if no server statement is present for that host, then the default\-key clause of the options statement\&. Note that the configuration file contains shared secrets which are used to send authenticated control commands to name servers\&. It should therefore not have general read or write access\&. .RE .SH "COMMANDS" .PP @@ -121,338 +136,338 @@ A list of commands supported by \fBrndc\fR can be seen by running \fBrndc\fR -without arguments. +without arguments\&. .PP Currently supported commands are: .PP \fBaddzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR\fB\fIconfiguration\fR\fR\fB \fR .RS 4 -Add a zone while the server is running. This command requires the +Add a zone while the server is running\&. This command requires the \fBallow\-new\-zones\fR option to be set to -\fByes\fR. The +\fByes\fR\&. The \fIconfiguration\fR string specified on the command line is the zone configuration text that would ordinarily be placed in -\fInamed.conf\fR. +named\&.conf\&. .sp The configuration is saved in a file called -\fI\fIhash\fR\fR\fI.nzf\fR, where +\fIhash\fR\&.nzf, where \fIhash\fR -is a cryptographic hash generated from the name of the view. When +is a cryptographic hash generated from the name of the view\&. When \fBnamed\fR -is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart. +is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart\&. .sp This sample \fBaddzone\fR command would add the zone -example.com +example\&.com to the default view: .sp -$\fBrndc addzone example.com '{ type master; file "example.com.db"; };'\fR +$\fBrndc addzone example\&.com \*(Aq{ type master; file "example\&.com\&.db"; };\*(Aq\fR .sp -(Note the brackets and semi\-colon around the zone configuration text.) +(Note the brackets and semi\-colon around the zone configuration text\&.) .sp See also -\fBrndc delzone\fR. +\fBrndc delzone\fR\&. .RE .PP \fBdelzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR .RS 4 -Delete a zone while the server is running. Only zones that were originally added via +Delete a zone while the server is running\&. Only zones that were originally added via \fBrndc addzone\fR -can be deleted in this manner. +can be deleted in this manner\&. .sp See also \fBrndc addzone\fR .RE .PP -\fBdumpdb \fR\fB[\-all|\-cache|\-zone|\-adb|\-bad]\fR\fB \fR\fB[\fIview ...\fR]\fR +\fBdumpdb \fR\fB[\-all|\-cache|\-zone|\-adb|\-bad]\fR\fB \fR\fB[\fIview \&.\&.\&.\fR]\fR .RS 4 -Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is specified, all views are dumped. (See the +Dump the server\*(Aqs caches (default) and/or zones to the dump file for the specified views\&. If no view is specified, all views are dumped\&. (See the \fBdump\-file\fR -option in the BIND 9 Administrator Reference Manual.) +option in the BIND 9 Administrator Reference Manual\&.) .RE .PP \fBflush\fR .RS 4 -Flushes the server's cache. +Flushes the server\*(Aqs cache\&. .RE .PP \fBflushname\fR \fIname\fR [\fIview\fR] .RS 4 -Flushes the given name from the view's DNS cache and, if applicable, from the view's nameserver address database or bad\-server cache. +Flushes the given name from the view\*(Aqs DNS cache and, if applicable, from the view\*(Aqs nameserver address database or bad\-server cache\&. .RE .PP \fBflushtree\fR \fIname\fR [\fIview\fR] .RS 4 -Flushes the given name, and all of its subdomains, from the view's DNS cache. Note that this does +Flushes the given name, and all of its subdomains, from the view\*(Aqs DNS cache\&. Note that this does \fInot\fR -affect he server's address database or bad\-server cache. +affect he server\*(Aqs address database or bad\-server cache\&. .RE .PP \fBfreeze \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR .RS 4 -Suspend updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by dynamic update. It also causes changes in the journal file to be synced into the master file. All dynamic update attempts will be refused while the zone is frozen. +Suspend updates to a dynamic zone\&. If no zone is specified, then all zones are suspended\&. This allows manual edits to be made to a zone normally updated by dynamic update\&. It also causes changes in the journal file to be synced into the master file\&. All dynamic update attempts will be refused while the zone is frozen\&. .sp See also -\fBrndc thaw\fR. +\fBrndc thaw\fR\&. .RE .PP \fBhalt \fR\fB[\-p]\fR .RS 4 -Stop the server immediately. Recent changes made through dynamic update or IXFR are not saved to the master files, but will be rolled forward from the journal files when the server is restarted. If +Stop the server immediately\&. Recent changes made through dynamic update or IXFR are not saved to the master files, but will be rolled forward from the journal files when the server is restarted\&. If \fB\-p\fR is specified -\fBnamed\fR's process id is returned. This allows an external process to determine when +\fBnamed\fR\*(Aqs process id is returned\&. This allows an external process to determine when \fBnamed\fR -had completed halting. +had completed halting\&. .sp See also -\fBrndc stop\fR. +\fBrndc stop\fR\&. .RE .PP \fBloadkeys \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 -Fetch all DNSSEC keys for the given zone from the key directory. If they are within their publication period, merge them into the zone's DNSKEY RRset. Unlike -\fBrndc sign\fR, however, the zone is not immediately re\-signed by the new keys, but is allowed to incrementally re\-sign over time. +Fetch all DNSSEC keys for the given zone from the key directory\&. If they are within their publication period, merge them into the zone\*(Aqs DNSKEY RRset\&. Unlike +\fBrndc sign\fR, however, the zone is not immediately re\-signed by the new keys, but is allowed to incrementally re\-sign over time\&. .sp This command requires that the \fBauto\-dnssec\fR zone option be set to -maintain, and also requires the zone to be configured to allow dynamic DNS. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.) +maintain, and also requires the zone to be configured to allow dynamic DNS\&. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details\&.) .RE .PP \fBnotify \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 -Resend NOTIFY messages for the zone. +Resend NOTIFY messages for the zone\&. .RE .PP \fBnotrace\fR .RS 4 -Sets the server's debugging level to 0. +Sets the server\*(Aqs debugging level to 0\&. .sp See also -\fBrndc trace\fR. +\fBrndc trace\fR\&. .RE .PP \fBquerylog\fR [on|off] .RS 4 -Enable or disable query logging. (For backward compatibility, this command can also be used without an argument to toggle query logging on and off.) +Enable or disable query logging\&. (For backward compatibility, this command can also be used without an argument to toggle query logging on and off\&.) .sp Query logging can also be enabled by explicitly directing the -\fBqueries\fR -\fBcategory\fR +\fBqueries\fR\fBcategory\fR to a \fBchannel\fR in the \fBlogging\fR section of -\fInamed.conf\fR +named\&.conf or by specifying \fBquerylog yes;\fR in the \fBoptions\fR section of -\fInamed.conf\fR. +named\&.conf\&. .RE .PP \fBreconfig\fR .RS 4 -Reload the configuration file and load new zones, but do not reload existing zone files even if they have changed. This is faster than a full +Reload the configuration file and load new zones, but do not reload existing zone files even if they have changed\&. This is faster than a full \fBreload\fR -when there is a large number of zones because it avoids the need to examine the modification times of the zones files. +when there is a large number of zones because it avoids the need to examine the modification times of the zones files\&. .RE .PP \fBrecursing\fR .RS 4 Dump the list of queries \fBnamed\fR -is currently recursing on, and the list of domains to which iterative queries are currently being sent. (The second list includes the number of fetches currently active for the given domain, and how many have been passed or dropped because of the +is currently recursing on, and the list of domains to which iterative queries are currently being sent\&. (The second list includes the number of fetches currently active for the given domain, and how many have been passed or dropped because of the \fBfetches\-per\-zone\fR -option.) +option\&.) .RE .PP \fBrefresh \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 -Schedule zone maintenance for the given zone. +Schedule zone maintenance for the given zone\&. .RE .PP \fBreload\fR .RS 4 -Reload configuration file and zones. +Reload configuration file and zones\&. .RE .PP \fBreload \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 -Reload the given zone. +Reload the given zone\&. .RE .PP \fBretransfer \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 -Retransfer the given slave zone from the master server. +Retransfer the given slave zone from the master server\&. .sp If the zone is configured to use -\fBinline\-signing\fR, the signed version of the zone is discarded; after the retransfer of the unsigned version is complete, the signed version will be regenerated with all new signatures. +\fBinline\-signing\fR, the signed version of the zone is discarded; after the retransfer of the unsigned version is complete, the signed version will be regenerated with all new signatures\&. .RE .PP -\fBsecroots \fR\fB[\fIview ...\fR]\fR +\fBsecroots \fR\fB[\fIview \&.\&.\&.\fR]\fR .RS 4 -Dump the server's security roots to the secroots file for the specified views. If no view is specified, security roots for all views are dumped. +Dump the server\*(Aqs security roots to the secroots file for the specified views\&. If no view is specified, security roots for all views are dumped\&. .RE .PP \fBsign \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR .RS 4 Fetch all DNSSEC keys for the given zone from the key directory (see the \fBkey\-directory\fR -option in the BIND 9 Administrator Reference Manual). If they are within their publication period, merge them into the zone's DNSKEY RRset. If the DNSKEY RRset is changed, then the zone is automatically re\-signed with the new key set. +option in the BIND 9 Administrator Reference Manual)\&. If they are within their publication period, merge them into the zone\*(Aqs DNSKEY RRset\&. If the DNSKEY RRset is changed, then the zone is automatically re\-signed with the new key set\&. .sp This command requires that the \fBauto\-dnssec\fR zone option be set to allow or -maintain, and also requires the zone to be configured to allow dynamic DNS. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.) +maintain, and also requires the zone to be configured to allow dynamic DNS\&. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details\&.) .sp See also -\fBrndc loadkeys\fR. +\fBrndc loadkeys\fR\&. .RE .PP \fBsigning \fR\fB[( \-list | \-clear \fIkeyid/algorithm\fR | \-clear all | \-nsec3param ( \fIparameters\fR | none ) ) ]\fR\fB \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR .RS 4 -List, edit, or remove the DNSSEC signing state records for the specified zone. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type -\fBsig\-signing\-type\fR. +List, edit, or remove the DNSSEC signing state records for the specified zone\&. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type +\fBsig\-signing\-type\fR\&. \fBrndc signing \-list\fR -converts these records into a human\-readable form, indicating which keys are currently signing or have finished signing the zone, and which NSEC3 chains are being created or removed. +converts these records into a human\-readable form, indicating which keys are currently signing or have finished signing the zone, and which NSEC3 chains are being created or removed\&. .sp \fBrndc signing \-clear\fR can remove a single key (specified in the same format that \fBrndc signing \-list\fR -uses to display it), or all keys. In either case, only completed keys are removed; any record indicating that a key has not yet finished signing the zone will be retained. +uses to display it), or all keys\&. In either case, only completed keys are removed; any record indicating that a key has not yet finished signing the zone will be retained\&. .sp \fBrndc signing \-nsec3param\fR -sets the NSEC3 parameters for a zone. This is the only supported mechanism for using NSEC3 with +sets the NSEC3 parameters for a zone\&. This is the only supported mechanism for using NSEC3 with \fBinline\-signing\fR -zones. Parameters are specified in the same format as an NSEC3PARAM resource record: hash algorithm, flags, iterations, and salt, in that order. +zones\&. Parameters are specified in the same format as an NSEC3PARAM resource record: hash algorithm, flags, iterations, and salt, in that order\&. .sp Currently, the only defined value for hash algorithm is -1, representing SHA\-1. The +1, representing SHA\-1\&. The \fBflags\fR may be set to 0 or -1, depending on whether you wish to set the opt\-out bit in the NSEC3 chain. +1, depending on whether you wish to set the opt\-out bit in the NSEC3 chain\&. \fBiterations\fR -defines the number of additional times to apply the algorithm when generating an NSEC3 hash. The +defines the number of additional times to apply the algorithm when generating an NSEC3 hash\&. The \fBsalt\fR -is a string of data expressed in hexadecimal, or a hyphen (`\-') if no salt is to be used. +is a string of data expressed in hexadecimal, or a hyphen (`\-\*(Aq) if no salt is to be used\&. .sp So, for example, to create an NSEC3 chain using the SHA\-1 hash algorithm, no opt\-out flag, 10 iterations, and a salt value of "FFFF", use: -\fBrndc signing \-nsec3param 1 0 10 FFFF \fR\fB\fIzone\fR\fR. To set the opt\-out flag, 15 iterations, and no salt, use: -\fBrndc signing \-nsec3param 1 1 15 \- \fR\fB\fIzone\fR\fR. +\fBrndc signing \-nsec3param 1 0 10 FFFF \fR\fB\fIzone\fR\fR\&. To set the opt\-out flag, 15 iterations, and no salt, use: +\fBrndc signing \-nsec3param 1 1 15 \- \fR\fB\fIzone\fR\fR\&. .sp \fBrndc signing \-nsec3param none\fR -removes an existing NSEC3 chain and replaces it with NSEC. +removes an existing NSEC3 chain and replaces it with NSEC\&. .RE .PP \fBstats\fR .RS 4 -Write server statistics to the statistics file. (See the +Write server statistics to the statistics file\&. (See the \fBstatistics\-file\fR -option in the BIND 9 Administrator Reference Manual.) +option in the BIND 9 Administrator Reference Manual\&.) .RE .PP \fBstatus\fR .RS 4 -Display status of the server. Note that the number of zones includes the internal +Display status of the server\&. Note that the number of zones includes the internal \fBbind/CH\fR zone and the default -\fB./IN\fR -hint zone if there is not an explicit root zone configured. +\fB\&./IN\fR +hint zone if there is not an explicit root zone configured\&. .RE .PP \fBstop \fR\fB[\-p]\fR .RS 4 -Stop the server, making sure any recent changes made through dynamic update or IXFR are first saved to the master files of the updated zones. If +Stop the server, making sure any recent changes made through dynamic update or IXFR are first saved to the master files of the updated zones\&. If \fB\-p\fR is specified -\fBnamed\fR's process id is returned. This allows an external process to determine when +\fBnamed\fR\*(Aqs process id is returned\&. This allows an external process to determine when \fBnamed\fR -had completed stopping. +had completed stopping\&. .sp See also -\fBrndc halt\fR. +\fBrndc halt\fR\&. .RE .PP \fBsync \fR\fB[\-clean]\fR\fB \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR .RS 4 -Sync changes in the journal file for a dynamic zone to the master file. If the "\-clean" option is specified, the journal file is also removed. If no zone is specified, then all zones are synced. +Sync changes in the journal file for a dynamic zone to the master file\&. If the "\-clean" option is specified, the journal file is also removed\&. If no zone is specified, then all zones are synced\&. .RE .PP \fBthaw \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR .RS 4 -Enable updates to a frozen dynamic zone. If no zone is specified, then all frozen zones are enabled. This causes the server to reload the zone from disk, and re\-enables dynamic updates after the load has completed. After a zone is thawed, dynamic updates will no longer be refused. If the zone has changed and the +Enable updates to a frozen dynamic zone\&. If no zone is specified, then all frozen zones are enabled\&. This causes the server to reload the zone from disk, and re\-enables dynamic updates after the load has completed\&. After a zone is thawed, dynamic updates will no longer be refused\&. If the zone has changed and the \fBixfr\-from\-differences\fR -option is in use, then the journal file will be updated to reflect changes in the zone. Otherwise, if the zone has changed, any existing journal file will be removed. +option is in use, then the journal file will be updated to reflect changes in the zone\&. Otherwise, if the zone has changed, any existing journal file will be removed\&. .sp See also -\fBrndc freeze\fR. +\fBrndc freeze\fR\&. .RE .PP \fBtrace\fR .RS 4 -Increment the servers debugging level by one. +Increment the servers debugging level by one\&. .RE .PP \fBtrace \fR\fB\fIlevel\fR\fR .RS 4 -Sets the server's debugging level to an explicit value. +Sets the server\*(Aqs debugging level to an explicit value\&. .sp See also -\fBrndc notrace\fR. +\fBrndc notrace\fR\&. .RE .PP \fBtsig\-delete\fR \fIkeyname\fR [\fIview\fR] .RS 4 -Delete a given TKEY\-negotiated key from the server. (This does not apply to statically configured TSIG keys.) +Delete a given TKEY\-negotiated key from the server\&. (This does not apply to statically configured TSIG keys\&.) .RE .PP \fBtsig\-list\fR .RS 4 List the names of all TSIG keys currently configured for use by \fBnamed\fR -in each view. The list both statically configured keys and dynamic TKEY\-negotiated keys. +in each view\&. The list both statically configured keys and dynamic TKEY\-negotiated keys\&. .RE .PP -\fBvalidation ( on | off | check ) \fR\fB[\fIview ...\fR]\fR\fB \fR +\fBvalidation ( on | off | check ) \fR\fB[\fIview \&.\&.\&.\fR]\fR\fB \fR .RS 4 -Enable, disable, or check the current status of DNSSEC validation. Note +Enable, disable, or check the current status of DNSSEC validation\&. Note \fBdnssec\-enable\fR also needs to be set to \fByes\fR or \fBauto\fR -to be effective. It defaults to enabled. +to be effective\&. It defaults to enabled\&. .RE .SH "LIMITATIONS" .PP There is currently no way to provide the shared secret for a \fBkey_id\fR -without using the configuration file. +without using the configuration file\&. .PP -Several error messages could be clearer. +Several error messages could be clearer\&. .SH "SEE ALSO" .PP \fBrndc.conf\fR(5), -\fBrndc\-confgen\fR(8), +\fBrndc-confgen\fR(8), \fBnamed\fR(8), \fBnamed.conf\fR(5), \fBndc\fR(8), -BIND 9 Administrator Reference Manual. +BIND 9 Administrator Reference Manual\&. .SH "AUTHOR" .PP -Internet Systems Consortium +\fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" -Copyright \(co 2004, 2005, 2007, 2013\-2015 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2004, 2005, 2007, 2013-2015 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. .br diff --git a/bin/rndc/rndc.conf.5 b/bin/rndc/rndc.conf.5 index ce7b09930e96..1bb0ab6a8cf0 100644 --- a/bin/rndc/rndc.conf.5 +++ b/bin/rndc/rndc.conf.5 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" Copyright (C) 2000, 2001 Internet Software Consortium. .\" .\" Permission to use, copy, modify, and/or distribute this software for any @@ -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 <http://docbook.sf.net/> -.\" Date: June 18, 2007 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 2007-06-18 .\" Manual: BIND9 -.\" Source: BIND9 +.\" Source: ISC +.\" Language: English .\" -.TH "\fIRNDC.CONF\fR" "5" "June 18, 2007" "BIND9" "BIND9" +.TH "RNDC\&.CONF" "5" "2007\-06\-18" "ISC" "BIND9" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" rndc.conf \- rndc configuration file .SH "SYNOPSIS" -.HP 10 -\fBrndc.conf\fR +.HP \w'\fBrndc\&.conf\fR\ 'u +\fBrndc\&.conf\fR .SH "DESCRIPTION" .PP -\fIrndc.conf\fR +rndc\&.conf is the configuration file for -\fBrndc\fR, the BIND 9 name server control utility. This file has a similar structure and syntax to -\fInamed.conf\fR. Statements are enclosed in braces and terminated with a semi\-colon. Clauses in the statements are also semi\-colon terminated. The usual comment styles are supported: +\fBrndc\fR, the BIND 9 name server control utility\&. This file has a similar structure and syntax to +named\&.conf\&. Statements are enclosed in braces and terminated with a semi\-colon\&. Clauses in the statements are also semi\-colon terminated\&. The usual comment styles are supported: .PP C style: /* */ .PP @@ -47,129 +62,144 @@ C++ style: // to end of line .PP Unix style: # to end of line .PP -\fIrndc.conf\fR +rndc\&.conf is much simpler than -\fInamed.conf\fR. The file uses three statements: an options statement, a server statement and a key statement. +named\&.conf\&. The file uses three statements: an options statement, a server statement and a key statement\&. .PP The \fBoptions\fR -statement contains five clauses. The +statement contains five clauses\&. The \fBdefault\-server\fR -clause is followed by the name or address of a name server. This host will be used when no name server is given as an argument to -\fBrndc\fR. The +clause is followed by the name or address of a name server\&. This host will be used when no name server is given as an argument to +\fBrndc\fR\&. The \fBdefault\-key\fR clause is followed by the name of a key which is identified by a \fBkey\fR -statement. If no +statement\&. If no \fBkeyid\fR is provided on the rndc command line, and no \fBkey\fR clause is found in a matching \fBserver\fR -statement, this default key will be used to authenticate the server's commands and responses. The +statement, this default key will be used to authenticate the server\*(Aqs commands and responses\&. The \fBdefault\-port\fR -clause is followed by the port to connect to on the remote name server. If no +clause is followed by the port to connect to on the remote name server\&. If no \fBport\fR option is provided on the rndc command line, and no \fBport\fR clause is found in a matching \fBserver\fR -statement, this default port will be used to connect. The +statement, this default port will be used to connect\&. The \fBdefault\-source\-address\fR and \fBdefault\-source\-address\-v6\fR -clauses which can be used to set the IPv4 and IPv6 source addresses respectively. +clauses which can be used to set the IPv4 and IPv6 source addresses respectively\&. .PP After the \fBserver\fR -keyword, the server statement includes a string which is the hostname or address for a name server. The statement has three possible clauses: +keyword, the server statement includes a string which is the hostname or address for a name server\&. The statement has three possible clauses: \fBkey\fR, \fBport\fR and -\fBaddresses\fR. The key name must match the name of a key statement in the file. The port number specifies the port to connect to. If an +\fBaddresses\fR\&. The key name must match the name of a key statement in the file\&. The port number specifies the port to connect to\&. If an \fBaddresses\fR -clause is supplied these addresses will be used instead of the server name. Each address can take an optional port. If an +clause is supplied these addresses will be used instead of the server name\&. Each address can take an optional port\&. If an \fBsource\-address\fR or \fBsource\-address\-v6\fR -of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively. +of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively\&. .PP The \fBkey\fR -statement begins with an identifying string, the name of the key. The statement has two clauses. +statement begins with an identifying string, the name of the key\&. The statement has two clauses\&. \fBalgorithm\fR identifies the encryption algorithm for \fBrndc\fR -to use; currently only HMAC\-MD5 is supported. This is followed by a secret clause which contains the base\-64 encoding of the algorithm's encryption key. The base\-64 string is enclosed in double quotes. +to use; currently only HMAC\-MD5 is supported\&. This is followed by a secret clause which contains the base\-64 encoding of the algorithm\*(Aqs encryption key\&. The base\-64 string is enclosed in double quotes\&. .PP -There are two common ways to generate the base\-64 string for the secret. The BIND 9 program +There are two common ways to generate the base\-64 string for the secret\&. The BIND 9 program \fBrndc\-confgen\fR can be used to generate a random key, or the \fBmmencode\fR program, also known as -\fBmimencode\fR, can be used to generate a base\-64 string from known input. +\fBmimencode\fR, can be used to generate a base\-64 string from known input\&. \fBmmencode\fR -does not ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each. +does not ship with BIND 9 but is available on many systems\&. See the EXAMPLE section for sample command lines for each\&. .SH "EXAMPLE" .PP +.if n \{\ .RS 4 +.\} .nf options { default\-server localhost; default\-key samplekey; }; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf server localhost { key samplekey; }; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf server testserver { key testkey; addresses { localhost port 5353; }; }; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf key samplekey { algorithm hmac\-md5; secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz"; }; .fi +.if n \{\ .RE -.sp +.\} .PP +.if n \{\ .RS 4 +.\} .nf key testkey { algorithm hmac\-md5; secret "R3HI8P6BKw9ZwXwN3VZKuQ=="; }; .fi +.if n \{\ .RE -.sp +.\} .PP In the above example, \fBrndc\fR -will by default use the server at localhost (127.0.0.1) and the key called samplekey. Commands to the localhost server will use the samplekey key, which must also be defined in the server's configuration file with the same name and secret. The key statement indicates that samplekey uses the HMAC\-MD5 algorithm and its secret clause contains the base\-64 encoding of the HMAC\-MD5 secret enclosed in double quotes. +will by default use the server at localhost (127\&.0\&.0\&.1) and the key called samplekey\&. Commands to the localhost server will use the samplekey key, which must also be defined in the server\*(Aqs configuration file with the same name and secret\&. The key statement indicates that samplekey uses the HMAC\-MD5 algorithm and its secret clause contains the base\-64 encoding of the HMAC\-MD5 secret enclosed in double quotes\&. .PP If \fBrndc \-s testserver\fR is used then \fBrndc\fR -will connect to server on localhost port 5353 using the key testkey. +will connect to server on localhost port 5353 using the key testkey\&. .PP To generate a random secret with \fBrndc\-confgen\fR: @@ -177,14 +207,14 @@ To generate a random secret with \fBrndc\-confgen\fR .PP A complete -\fIrndc.conf\fR -file, including the randomly generated key, will be written to the standard output. Commented\-out +rndc\&.conf +file, including the randomly generated key, will be written to the standard output\&. Commented\-out \fBkey\fR and \fBcontrols\fR statements for -\fInamed.conf\fR -are also printed. +named\&.conf +are also printed\&. .PP To generate a base\-64 secret with \fBmmencode\fR: @@ -193,22 +223,23 @@ 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" -Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br Copyright \(co 2000, 2001 Internet Software Consortium. .br diff --git a/bin/rndc/rndc.conf.docbook b/bin/rndc/rndc.conf.docbook index 8dcdef819718..4cb5d40b6f5a 100644 --- a/bin/rndc/rndc.conf.docbook +++ b/bin/rndc/rndc.conf.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -18,9 +15,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.rndc.conf"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.rndc.conf"> + <info> + <date>2007-06-18</date> + </info> <refentryinfo> - <date>June 18, 2007</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -40,6 +42,7 @@ <year>2005</year> <year>2007</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> <copyright> @@ -50,13 +53,13 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>rndc.conf</command> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><filename>rndc.conf</filename> is the configuration file for <command>rndc</command>, the BIND 9 name server control utility. This file has a similar structure and syntax to @@ -139,10 +142,10 @@ ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each. </para> - </refsect1> + </refsection> + + <refsection><info><title>EXAMPLE</title></info> - <refsect1> - <title>EXAMPLE</title> <para><programlisting> options { @@ -211,10 +214,10 @@ </para> <para><userinput>echo "known plaintext for a secret" | mmencode</userinput> </para> - </refsect1> + </refsection> + + <refsection><info><title>NAME SERVER CONFIGURATION</title></info> - <refsect1> - <title>NAME SERVER CONFIGURATION</title> <para> The name server must be configured to accept rndc connections and to recognize the key specified in the <filename>rndc.conf</filename> @@ -222,10 +225,10 @@ See the sections on the <option>controls</option> statement in the BIND 9 Administrator Reference Manual for details. </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>rndc</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, @@ -237,16 +240,6 @@ </citerefentry>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/rndc/rndc.conf.html b/bin/rndc/rndc.conf.html index 5b33584b9848..46fab0855401 100644 --- a/bin/rndc/rndc.conf.html +++ b/bin/rndc/rndc.conf.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>rndc.conf</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.rndc.conf"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -31,10 +30,10 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">rndc.conf</code> </p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543364"></a><h2>DESCRIPTION</h2> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> <p><code class="filename">rndc.conf</code> is the configuration file - for <span><strong class="command">rndc</strong></span>, the BIND 9 name server control + for <span class="command"><strong>rndc</strong></span>, the BIND 9 name server control utility. This file has a similar structure and syntax to <code class="filename">named.conf</code>. Statements are enclosed in braces and terminated with a semi-colon. Clauses in @@ -60,7 +59,7 @@ The <code class="option">default-server</code> 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 - <span><strong class="command">rndc</strong></span>. The <code class="option">default-key</code> + <span class="command"><strong>rndc</strong></span>. The <code class="option">default-key</code> clause is followed by the name of a key which is identified by a <code class="option">key</code> statement. If no <code class="option">keyid</code> is provided on the rndc command line, @@ -96,7 +95,7 @@ The <code class="option">key</code> statement begins with an identifying string, the name of the key. The statement has two clauses. <code class="option">algorithm</code> identifies the encryption algorithm - for <span><strong class="command">rndc</strong></span> to use; currently only HMAC-MD5 + for <span class="command"><strong>rndc</strong></span> to use; currently only HMAC-MD5 is supported. This is followed by a secret clause which contains the base-64 encoding of the algorithm's encryption key. The @@ -104,20 +103,20 @@ </p> <p> There are two common ways to generate the base-64 string for the - secret. The BIND 9 program <span><strong class="command">rndc-confgen</strong></span> + secret. The BIND 9 program <span class="command"><strong>rndc-confgen</strong></span> can be used to generate a random key, or the - <span><strong class="command">mmencode</strong></span> program, also known as - <span><strong class="command">mimencode</strong></span>, can be used to generate a + <span class="command"><strong>mmencode</strong></span> program, also known as + <span class="command"><strong>mimencode</strong></span>, can be used to generate a base-64 - string from known input. <span><strong class="command">mmencode</strong></span> does + string from known input. <span class="command"><strong>mmencode</strong></span> does not ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543512"></a><h2>EXAMPLE</h2> +<div class="refsection"> +<a name="id-1.8"></a><h2>EXAMPLE</h2> <pre class="programlisting"> options { default-server localhost; @@ -158,7 +157,7 @@ <p> </p> <p> - In the above example, <span><strong class="command">rndc</strong></span> will by + In the above example, <span class="command"><strong>rndc</strong></span> 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,11 +167,11 @@ base-64 encoding of the HMAC-MD5 secret enclosed in double quotes. </p> <p> - If <span><strong class="command">rndc -s testserver</strong></span> is used then <span><strong class="command">rndc</strong></span> will + If <span class="command"><strong>rndc -s testserver</strong></span> is used then <span class="command"><strong>rndc</strong></span> will connect to server on localhost port 5353 using the key testkey. </p> <p> - To generate a random secret with <span><strong class="command">rndc-confgen</strong></span>: + To generate a random secret with <span class="command"><strong>rndc-confgen</strong></span>: </p> <p><strong class="userinput"><code>rndc-confgen</code></strong> </p> @@ -185,13 +184,13 @@ <code class="filename">named.conf</code> are also printed. </p> <p> - To generate a base-64 secret with <span><strong class="command">mmencode</strong></span>: + To generate a base-64 secret with <span class="command"><strong>mmencode</strong></span>: </p> <p><strong class="userinput"><code>echo "known plaintext for a secret" | mmencode</code></strong> </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543604"></a><h2>NAME SERVER CONFIGURATION</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>NAME SERVER CONFIGURATION</h2> <p> The name server must be configured to accept rndc connections and to recognize the key specified in the <code class="filename">rndc.conf</code> @@ -200,18 +199,13 @@ BIND 9 Administrator Reference Manual for details. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543625"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">mmencode</span>(1)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543664"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/rndc/rndc.docbook b/bin/rndc/rndc.docbook index 141ce5f37ca2..913e11b9d373 100644 --- a/bin/rndc/rndc.docbook +++ b/bin/rndc/rndc.docbook @@ -1,6 +1,3 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - Copyright (C) 2004, 2005, 2007, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000, 2001 Internet Software Consortium. @@ -18,9 +15,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.rndc"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.rndc"> + <info> + <date>2013-12-04</date> + </info> <refentryinfo> - <date>December 04, 2013</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -52,21 +54,21 @@ </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>rndc</command> - <arg><option>-b <replaceable class="parameter">source-address</replaceable></option></arg> - <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg> - <arg><option>-k <replaceable class="parameter">key-file</replaceable></option></arg> - <arg><option>-s <replaceable class="parameter">server</replaceable></option></arg> - <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg> - <arg><option>-V</option></arg> - <arg><option>-y <replaceable class="parameter">key_id</replaceable></option></arg> - <arg choice="req">command</arg> + <arg choice="opt" rep="norepeat"><option>-b <replaceable class="parameter">source-address</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">config-file</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">key-file</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">server</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port</replaceable></option></arg> + <arg choice="opt" rep="norepeat"><option>-V</option></arg> + <arg choice="opt" rep="norepeat"><option>-y <replaceable class="parameter">key_id</replaceable></option></arg> + <arg choice="req" rep="norepeat">command</arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para><command>rndc</command> controls the operation of a name server. It supersedes the <command>ndc</command> utility @@ -93,10 +95,10 @@ determine how to contact the name server and decide what algorithm and key it should use. </para> - </refsect1> + </refsection> + + <refsection><info><title>OPTIONS</title></info> - <refsect1> - <title>OPTIONS</title> <variablelist> <varlistentry> @@ -196,10 +198,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>COMMANDS</title></info> - <refsect1> - <title>COMMANDS</title> <para> A list of commands supported by <command>rndc</command> can be seen by running <command>rndc</command> without arguments. @@ -258,7 +260,7 @@ Delete a zone while the server is running. Only zones that were originally added via <command>rndc addzone</command> can be deleted - in this manner. + in this manner. </para> <para> See also <command>rndc addzone</command> @@ -506,7 +508,7 @@ <listitem> <para> Fetch all DNSSEC keys for the given zone - from the key directory (see the + from the key directory (see the <command>key-directory</command> option in the BIND 9 Administrator Reference Manual). If they are within their publication period, merge them into the @@ -539,7 +541,7 @@ operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type - <command>sig-signing-type</command>. + <command>sig-signing-type</command>. <command>rndc signing -list</command> converts these records into a human-readable form, indicating which keys are currently signing @@ -565,7 +567,7 @@ flags, iterations, and salt, in that order. </para> <para> - Currently, the only defined value for hash algorithm + Currently, the only defined value for hash algorithm is <literal>1</literal>, representing SHA-1. The <option>flags</option> may be set to <literal>0</literal> or <literal>1</literal>, @@ -726,10 +728,10 @@ </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>LIMITATIONS</title></info> - <refsect1> - <title>LIMITATIONS</title> <para> There is currently no way to provide the shared secret for a <option>key_id</option> without using the configuration file. @@ -737,10 +739,10 @@ <para> Several error messages could be clearer. </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para><citerefentry> <refentrytitle>rndc.conf</refentrytitle><manvolnum>5</manvolnum> </citerefentry>, @@ -758,16 +760,6 @@ </citerefentry>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>. </para> - </refsect1> - - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> + </refsection> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/rndc/rndc.html b/bin/rndc/rndc.html index 0daea8a28549..7aa8f6cc9992 100644 --- a/bin/rndc/rndc.html +++ b/bin/rndc/rndc.html @@ -14,14 +14,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>rndc</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.rndc"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -31,22 +30,22 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">rndc</code> [<code class="option">-b <em class="replaceable"><code>source-address</code></em></code>] [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-k <em class="replaceable"><code>key-file</code></em></code>] [<code class="option">-s <em class="replaceable"><code>server</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-V</code>] [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>] {command}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543431"></a><h2>DESCRIPTION</h2> -<p><span><strong class="command">rndc</strong></span> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> +<p><span class="command"><strong>rndc</strong></span> controls the operation of a name - server. It supersedes the <span><strong class="command">ndc</strong></span> utility + server. It supersedes the <span class="command"><strong>ndc</strong></span> utility that was provided in old BIND releases. If - <span><strong class="command">rndc</strong></span> is invoked with no command line + <span class="command"><strong>rndc</strong></span> 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. </p> -<p><span><strong class="command">rndc</strong></span> +<p><span class="command"><strong>rndc</strong></span> communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of - <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>, + <span class="command"><strong>rndc</strong></span> and <span class="command"><strong>named</strong></span>, the only supported authentication algorithm is HMAC-MD5, which uses a shared secret on each end of the connection. This provides TSIG-style authentication for the command @@ -54,15 +53,15 @@ over the channel must be signed by a key_id known to the server. </p> -<p><span><strong class="command">rndc</strong></span> +<p><span class="command"><strong>rndc</strong></span> reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543466"></a><h2>OPTIONS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt> <dd><p> Use <em class="replaceable"><code>source-address</code></em> @@ -90,9 +89,9 @@ <dd><p><em class="replaceable"><code>server</code></em> is the name or address of the server which matches a server statement in the configuration file for - <span><strong class="command">rndc</strong></span>. If no server is supplied on the + <span class="command"><strong>rndc</strong></span>. If no server is supplied on the command line, the host named by the default-server clause - in the options statement of the <span><strong class="command">rndc</strong></span> + in the options statement of the <span class="command"><strong>rndc</strong></span> configuration file will be used. </p></dd> <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt> @@ -112,10 +111,10 @@ from the configuration file. <em class="replaceable"><code>key_id</code></em> must be - known by <span><strong class="command">named</strong></span> with the same algorithm and secret string + known by <span class="command"><strong>named</strong></span> with the same algorithm and secret string in order for control message validation to succeed. If no <em class="replaceable"><code>key_id</code></em> - is specified, <span><strong class="command">rndc</strong></span> will first look + is specified, <span class="command"><strong>rndc</strong></span> 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. @@ -126,22 +125,22 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543667"></a><h2>COMMANDS</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>COMMANDS</h2> <p> - A list of commands supported by <span><strong class="command">rndc</strong></span> can - be seen by running <span><strong class="command">rndc</strong></span> without arguments. + A list of commands supported by <span class="command"><strong>rndc</strong></span> can + be seen by running <span class="command"><strong>rndc</strong></span> without arguments. </p> <p> Currently supported commands are: </p> -<div class="variablelist"><dl> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term"><strong class="userinput"><code>addzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] <em class="replaceable"><code>configuration</code></em> </code></strong></span></dt> <dd> <p> Add a zone while the server is running. This command requires the - <span><strong class="command">allow-new-zones</strong></span> option to be set + <span class="command"><strong>allow-new-zones</strong></span> option to be set to <strong class="userinput"><code>yes</code></strong>. The <em class="replaceable"><code>configuration</code></em> string specified on the command line is the zone @@ -153,13 +152,13 @@ <code class="filename"><em class="replaceable"><code>hash</code></em>.nzf</code>, where <em class="replaceable"><code>hash</code></em> is a cryptographic hash generated from the name of - the view. When <span><strong class="command">named</strong></span> is + the view. When <span class="command"><strong>named</strong></span> is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart. </p> <p> - This sample <span><strong class="command">addzone</strong></span> command + This sample <span class="command"><strong>addzone</strong></span> command would add the zone <code class="literal">example.com</code> to the default view: </p> @@ -171,7 +170,7 @@ configuration text.) </p> <p> - See also <span><strong class="command">rndc delzone</strong></span>. + See also <span class="command"><strong>rndc delzone</strong></span>. </p> </dd> <dt><span class="term"><strong class="userinput"><code>delzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt> @@ -179,11 +178,11 @@ <p> Delete a zone while the server is running. Only zones that were originally added via - <span><strong class="command">rndc addzone</strong></span> can be deleted - in this manner. + <span class="command"><strong>rndc addzone</strong></span> can be deleted + in this manner. </p> <p> - See also <span><strong class="command">rndc addzone</strong></span> + See also <span class="command"><strong>rndc addzone</strong></span> </p> </dd> <dt><span class="term"><strong class="userinput"><code>dumpdb [<span class="optional">-all|-cache|-zone|-adb|-bad</span>] [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt> @@ -193,7 +192,7 @@ dump file for the specified views. If no view is specified, all views are dumped. - (See the <span><strong class="command">dump-file</strong></span> option in + (See the <span class="command"><strong>dump-file</strong></span> option in the BIND 9 Administrator Reference Manual.) </p></dd> <dt><span class="term"><strong class="userinput"><code>flush</code></strong></span></dt> @@ -225,7 +224,7 @@ the zone is frozen. </p> <p> - See also <span><strong class="command">rndc thaw</strong></span>. + See also <span class="command"><strong>rndc thaw</strong></span>. </p> </dd> <dt><span class="term"><strong class="userinput"><code>halt [<span class="optional">-p</span>]</code></strong></span></dt> @@ -235,12 +234,12 @@ 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 <code class="option">-p</code> is specified <span><strong class="command">named</strong></span>'s process id is returned. - This allows an external process to determine when <span><strong class="command">named</strong></span> + If <code class="option">-p</code> is specified <span class="command"><strong>named</strong></span>'s process id is returned. + This allows an external process to determine when <span class="command"><strong>named</strong></span> had completed halting. </p> <p> - See also <span><strong class="command">rndc stop</strong></span>. + See also <span class="command"><strong>rndc stop</strong></span>. </p> </dd> <dt><span class="term"><strong class="userinput"><code>loadkeys <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt> @@ -249,14 +248,14 @@ 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 <span><strong class="command">rndc + zone's DNSKEY RRset. Unlike <span class="command"><strong>rndc sign</strong></span>, however, the zone is not immediately re-signed by the new keys, but is allowed to incrementally re-sign over time. </p> <p> This command requires that the - <span><strong class="command">auto-dnssec</strong></span> zone option + <span class="command"><strong>auto-dnssec</strong></span> zone option be set to <code class="literal">maintain</code>, and also requires the zone to be configured to allow dynamic DNS. @@ -274,7 +273,7 @@ Sets the server's debugging level to 0. </p> <p> - See also <span><strong class="command">rndc trace</strong></span>. + See also <span class="command"><strong>rndc trace</strong></span>. </p> </dd> <dt><span class="term"><strong class="userinput"><code>querylog</code></strong> [<span class="optional">on|off</span>] </span></dt> @@ -286,13 +285,13 @@ </p> <p> Query logging can also be enabled - by explicitly directing the <span><strong class="command">queries</strong></span> - <span><strong class="command">category</strong></span> to a - <span><strong class="command">channel</strong></span> in the - <span><strong class="command">logging</strong></span> section of + by explicitly directing the <span class="command"><strong>queries</strong></span> + <span class="command"><strong>category</strong></span> to a + <span class="command"><strong>channel</strong></span> in the + <span class="command"><strong>logging</strong></span> section of <code class="filename">named.conf</code> or by specifying - <span><strong class="command">querylog yes;</strong></span> in the - <span><strong class="command">options</strong></span> section of + <span class="command"><strong>querylog yes;</strong></span> in the + <span class="command"><strong>options</strong></span> section of <code class="filename">named.conf</code>. </p> </dd> @@ -301,14 +300,14 @@ 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 <span><strong class="command">reload</strong></span> when there + This is faster than a full <span class="command"><strong>reload</strong></span> when there is a large number of zones because it avoids the need to examine the modification times of the zones files. </p></dd> <dt><span class="term"><strong class="userinput"><code>recursing</code></strong></span></dt> <dd><p> - Dump the list of queries <span><strong class="command">named</strong></span> is currently + Dump the list of queries <span class="command"><strong>named</strong></span> 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, @@ -334,7 +333,7 @@ </p> <p> If the zone is configured to use - <span><strong class="command">inline-signing</strong></span>, the signed + <span class="command"><strong>inline-signing</strong></span>, 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 @@ -352,8 +351,8 @@ <dd> <p> Fetch all DNSSEC keys for the given zone - from the key directory (see the - <span><strong class="command">key-directory</strong></span> option in + from the key directory (see the + <span class="command"><strong>key-directory</strong></span> 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 @@ -362,7 +361,7 @@ </p> <p> This command requires that the - <span><strong class="command">auto-dnssec</strong></span> zone option be set + <span class="command"><strong>auto-dnssec</strong></span> zone option be set to <code class="literal">allow</code> or <code class="literal">maintain</code>, and also requires the zone to be configured to @@ -371,7 +370,7 @@ Reference Manual for more details.) </p> <p> - See also <span><strong class="command">rndc loadkeys</strong></span>. + See also <span class="command"><strong>rndc loadkeys</strong></span>. </p> </dd> <dt><span class="term"><strong class="userinput"><code>signing [<span class="optional">( -list | -clear <em class="replaceable"><code>keyid/algorithm</code></em> | -clear <code class="literal">all</code> | -nsec3param ( <em class="replaceable"><code>parameters</code></em> | <code class="literal">none</code> ) ) </span>] <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt> @@ -382,33 +381,33 @@ operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type - <span><strong class="command">sig-signing-type</strong></span>. - <span><strong class="command">rndc signing -list</strong></span> converts + <span class="command"><strong>sig-signing-type</strong></span>. + <span class="command"><strong>rndc signing -list</strong></span> 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. </p> <p> - <span><strong class="command">rndc signing -clear</strong></span> can remove + <span class="command"><strong>rndc signing -clear</strong></span> can remove a single key (specified in the same format that - <span><strong class="command">rndc signing -list</strong></span> uses to + <span class="command"><strong>rndc signing -list</strong></span> 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. </p> <p> - <span><strong class="command">rndc signing -nsec3param</strong></span> sets + <span class="command"><strong>rndc signing -nsec3param</strong></span> sets the NSEC3 parameters for a zone. This is the only supported mechanism for using NSEC3 with - <span><strong class="command">inline-signing</strong></span> zones. + <span class="command"><strong>inline-signing</strong></span> zones. Parameters are specified in the same format as an NSEC3PARAM resource record: hash algorithm, flags, iterations, and salt, in that order. </p> <p> - Currently, the only defined value for hash algorithm + Currently, the only defined value for hash algorithm is <code class="literal">1</code>, representing SHA-1. The <code class="option">flags</code> may be set to <code class="literal">0</code> or <code class="literal">1</code>, @@ -424,13 +423,13 @@ 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: - <span><strong class="command">rndc signing -nsec3param 1 0 10 FFFF <em class="replaceable"><code>zone</code></em></strong></span>. + <span class="command"><strong>rndc signing -nsec3param 1 0 10 FFFF <em class="replaceable"><code>zone</code></em></strong></span>. To set the opt-out flag, 15 iterations, and no salt, use: - <span><strong class="command">rndc signing -nsec3param 1 1 15 - <em class="replaceable"><code>zone</code></em></strong></span>. + <span class="command"><strong>rndc signing -nsec3param 1 1 15 - <em class="replaceable"><code>zone</code></em></strong></span>. </p> <p> - <span><strong class="command">rndc signing -nsec3param none</strong></span> + <span class="command"><strong>rndc signing -nsec3param none</strong></span> removes an existing NSEC3 chain and replaces it with NSEC. </p> @@ -438,14 +437,14 @@ <dt><span class="term"><strong class="userinput"><code>stats</code></strong></span></dt> <dd><p> Write server statistics to the statistics file. - (See the <span><strong class="command">statistics-file</strong></span> option in + (See the <span class="command"><strong>statistics-file</strong></span> option in the BIND 9 Administrator Reference Manual.) </p></dd> <dt><span class="term"><strong class="userinput"><code>status</code></strong></span></dt> <dd><p> Display status of the server. - Note that the number of zones includes the internal <span><strong class="command">bind/CH</strong></span> zone - and the default <span><strong class="command">./IN</strong></span> + Note that the number of zones includes the internal <span class="command"><strong>bind/CH</strong></span> zone + and the default <span class="command"><strong>./IN</strong></span> hint zone if there is not an explicit root zone configured. </p></dd> @@ -455,11 +454,11 @@ 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 <code class="option">-p</code> is specified <span><strong class="command">named</strong></span>'s process id is returned. - This allows an external process to determine when <span><strong class="command">named</strong></span> + If <code class="option">-p</code> is specified <span class="command"><strong>named</strong></span>'s process id is returned. + This allows an external process to determine when <span class="command"><strong>named</strong></span> had completed stopping. </p> -<p>See also <span><strong class="command">rndc halt</strong></span>.</p> +<p>See also <span class="command"><strong>rndc halt</strong></span>.</p> </dd> <dt><span class="term"><strong class="userinput"><code>sync [<span class="optional">-clean</span>] [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt> <dd><p> @@ -478,13 +477,13 @@ load has completed. After a zone is thawed, dynamic updates will no longer be refused. If the zone has changed and the - <span><strong class="command">ixfr-from-differences</strong></span> option is + <span class="command"><strong>ixfr-from-differences</strong></span> 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. </p> -<p>See also <span><strong class="command">rndc freeze</strong></span>.</p> +<p>See also <span class="command"><strong>rndc freeze</strong></span>.</p> </dd> <dt><span class="term"><strong class="userinput"><code>trace</code></strong></span></dt> <dd><p> @@ -497,7 +496,7 @@ value. </p> <p> - See also <span><strong class="command">rndc notrace</strong></span>. + See also <span class="command"><strong>rndc notrace</strong></span>. </p> </dd> <dt><span class="term"><strong class="userinput"><code>tsig-delete</code></strong> <em class="replaceable"><code>keyname</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span></dt> @@ -509,7 +508,7 @@ <dt><span class="term"><strong class="userinput"><code>tsig-list</code></strong></span></dt> <dd><p> List the names of all TSIG keys currently configured - for use by <span><strong class="command">named</strong></span> in each view. The + for use by <span class="command"><strong>named</strong></span> in each view. The list both statically configured keys and dynamic TKEY-negotiated keys. </p></dd> @@ -517,15 +516,15 @@ <dd><p> Enable, disable, or check the current status of DNSSEC validation. - Note <span><strong class="command">dnssec-enable</strong></span> also needs to be + Note <span class="command"><strong>dnssec-enable</strong></span> also needs to be set to <strong class="userinput"><code>yes</code></strong> or <strong class="userinput"><code>auto</code></strong> to be effective. It defaults to enabled. </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2544994"></a><h2>LIMITATIONS</h2> +<div class="refsection"> +<a name="id-1.10"></a><h2>LIMITATIONS</h2> <p> There is currently no way to provide the shared secret for a <code class="option">key_id</code> without using the configuration file. @@ -534,8 +533,8 @@ Several error messages could be clearer. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545012"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.11"></a><h2>SEE ALSO</h2> <p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>, <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, @@ -544,10 +543,5 @@ <em class="citetitle">BIND 9 Administrator Reference Manual</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2545067"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/tools/Makefile.in b/bin/tools/Makefile.in index a3960051c252..0255a6240519 100644 --- a/bin/tools/Makefile.in +++ b/bin/tools/Makefile.in @@ -1,4 +1,4 @@ -# Copyright (C) 2009, 2010, 2012 Internet Systems Consortium, Inc. ("ISC") +# Copyright (C) 2009, 2010, 2012, 2015 Internet Systems Consortium, Inc. ("ISC") # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above @@ -12,8 +12,6 @@ # OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR # PERFORMANCE OF THIS SOFTWARE. -# $Id: Makefile.in,v 1.13 2010/01/07 23:48:53 tbox Exp $ - srcdir = @srcdir@ VPATH = @srcdir@ top_srcdir = @top_srcdir@ @@ -40,7 +38,7 @@ LWRESDEPLIBS = ../../lib/lwres/liblwres.@A@ LIBS = ${ISCLIBS} @LIBS@ NOSYMLIBS = ${ISCNOSYMLIBS} @LIBS@ -SUBDIRS = +SUBDIRS = TARGETS = arpaname@EXEEXT@ named-journalprint@EXEEXT@ nsec3hash@EXEEXT@ \ genrandom@EXEEXT@ isc-hmac-fixup@EXEEXT@ diff --git a/bin/tools/arpaname.1 b/bin/tools/arpaname.1 index d8a43171f502..d5bb1b5af75a 100644 --- a/bin/tools/arpaname.1 +++ b/bin/tools/arpaname.1 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -12,37 +12,53 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: March 03, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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" -.HP 9 +.HP \w'\fBarpaname\fR\ 'u \fBarpaname\fR {\fIipaddress\ \fR...} .SH "DESCRIPTION" .PP \fBarpaname\fR -translates IP addresses (IPv4 and IPv6) to the corresponding IN\-ADDR.ARPA or IP6.ARPA names. +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" -Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/arpaname.docbook b/bin/tools/arpaname.docbook index 04fd54aec593..a0651f3e424b 100644 --- a/bin/tools/arpaname.docbook +++ b/bin/tools/arpaname.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,11 +14,15 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.arpaname"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.arpaname"> + <info> + <date>2009-03-03</date> + </info> <refentryinfo> - <date>March 03, 2009</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> - <refmeta> <refentrytitle><application>arpaname</application></refentrytitle> <manvolnum>1</manvolnum> @@ -37,40 +38,31 @@ <copyright> <year>2009</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>arpaname</command> <arg choice="req" rep="repeat"><replaceable class="parameter">ipaddress </replaceable></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para> <command>arpaname</command> translates IP addresses (IPv4 and IPv6) to the corresponding IN-ADDR.ARPA or IP6.ARPA names. </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para> <citetitle>BIND 9 Administrator Reference Manual</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/tools/arpaname.html b/bin/tools/arpaname.html index 29ea03b51399..b54ddd1614b1 100644 --- a/bin/tools/arpaname.html +++ b/bin/tools/arpaname.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>arpaname</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.arpaname"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -30,23 +29,18 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">arpaname</code> {<em class="replaceable"><code>ipaddress </code></em>...}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543356"></a><h2>DESCRIPTION</h2> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> <p> - <span><strong class="command">arpaname</strong></span> translates IP addresses (IPv4 and + <span class="command"><strong>arpaname</strong></span> translates IP addresses (IPv4 and IPv6) to the corresponding IN-ADDR.ARPA or IP6.ARPA names. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543369"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.8"></a><h2>SEE ALSO</h2> <p> <em class="citetitle">BIND 9 Administrator Reference Manual</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543383"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/tools/genrandom.8 b/bin/tools/genrandom.8 index 30d50d7eaabc..d51956b3269c 100644 --- a/bin/tools/genrandom.8 +++ b/bin/tools/genrandom.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2009-2011, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2009-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -12,31 +12,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: genrandom .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> -.\" Date: August 08, 2011 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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" -.HP 10 +.HP \w'\fBgenrandom\fR\ 'u \fBgenrandom\fR [\fB\-n\ \fR\fB\fInumber\fR\fR] {\fIsize\fR} {\fIfilename\fR} .SH "DESCRIPTION" .PP \fBgenrandom\fR -generates a file or a set of files containing a specified quantity of pseudo\-random data, which can be used as a source of entropy for other commands on systems with no random device. +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, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/genrandom.docbook b/bin/tools/genrandom.docbook index ecc206a5496c..a79926c827e7 100644 --- a/bin/tools/genrandom.docbook +++ b/bin/tools/genrandom.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2009-2011, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.genrandom"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.genrandom"> + <info> + <date>2011-08-08</date> + </info> <refentryinfo> - <date>August 08, 2011</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -39,31 +41,32 @@ <year>2010</year> <year>2011</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>genrandom</command> - <arg><option>-n <replaceable class="parameter">number</replaceable></option></arg> - <arg choice="req"><replaceable class="parameter">size</replaceable></arg> - <arg choice="req"><replaceable class="parameter">filename</replaceable></arg> + <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">number</replaceable></option></arg> + <arg choice="req" rep="norepeat"><replaceable class="parameter">size</replaceable></arg> + <arg choice="req" rep="norepeat"><replaceable class="parameter">filename</replaceable></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para> <command>genrandom</command> 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. </para> - </refsect1> + </refsection> + + <refsection><info><title>ARGUMENTS</title></info> - <refsect1> - <title>ARGUMENTS</title> <variablelist> <varlistentry> <term>-n <replaceable class="parameter">number</replaceable></term> @@ -93,10 +96,10 @@ </listitem> </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para> <citerefentry> <refentrytitle>rand</refentrytitle><manvolnum>3</manvolnum> @@ -105,16 +108,6 @@ <refentrytitle>arc4random</refentrytitle><manvolnum>3</manvolnum> </citerefentry> </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/tools/genrandom.html b/bin/tools/genrandom.html index e125a0120889..f61f57a38fb8 100644 --- a/bin/tools/genrandom.html +++ b/bin/tools/genrandom.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2009-2011, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>genrandom</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.genrandom"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -30,18 +29,18 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">genrandom</code> [<code class="option">-n <em class="replaceable"><code>number</code></em></code>] {<em class="replaceable"><code>size</code></em>} {<em class="replaceable"><code>filename</code></em>}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543378"></a><h2>DESCRIPTION</h2> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> <p> - <span><strong class="command">genrandom</strong></span> + <span class="command"><strong>genrandom</strong></span> 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. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543390"></a><h2>ARGUMENTS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>ARGUMENTS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">-n <em class="replaceable"><code>number</code></em></span></dt> <dd><p> In place of generating one file, generates <code class="option">number</code> @@ -57,17 +56,12 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543451"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>SEE ALSO</h2> <p> <span class="citerefentry"><span class="refentrytitle">rand</span>(3)</span>, <span class="citerefentry"><span class="refentrytitle">arc4random</span>(3)</span> </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543478"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/tools/isc-hmac-fixup.8 b/bin/tools/isc-hmac-fixup.8 index 1b842fbd00b7..0f60791043c7 100644 --- a/bin/tools/isc-hmac-fixup.8 +++ b/bin/tools/isc-hmac-fixup.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2010, 2013-2015 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -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 <http://docbook.sf.net/> -.\" Date: April 28, 2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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 +.HP \w'\fBisc\-hmac\-fixup\fR\ 'u \fBisc\-hmac\-fixup\fR {\fIalgorithm\fR} {\fIsecret\fR} .SH "DESCRIPTION" .PP -Versions of BIND 9 up to and including BIND 9.6 had a bug causing HMAC\-SHA* TSIG keys which were longer than the digest length of the hash algorithm (i.e., SHA1 keys longer than 160 bits, SHA256 keys longer than 256 bits, etc) to be used incorrectly, generating a message authentication code that was incompatible with other DNS implementations. +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" -Copyright \(co 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2010, 2013-2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/isc-hmac-fixup.docbook b/bin/tools/isc-hmac-fixup.docbook index 986c30b8551c..931086348a9c 100644 --- a/bin/tools/isc-hmac-fixup.docbook +++ b/bin/tools/isc-hmac-fixup.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2010, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.isc-hmac-fixup"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.isc-hmac-fixup"> + <info> + <date>2013-04-28</date> + </info> <refentryinfo> - <date>April 28, 2013</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -38,20 +40,21 @@ <year>2010</year> <year>2013</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>isc-hmac-fixup</command> - <arg choice="req"><replaceable class="parameter">algorithm</replaceable></arg> - <arg choice="req"><replaceable class="parameter">secret</replaceable></arg> + <arg choice="req" rep="norepeat"><replaceable class="parameter">algorithm</replaceable></arg> + <arg choice="req" rep="norepeat"><replaceable class="parameter">secret</replaceable></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para> Versions of BIND 9 up to and including BIND 9.6 had a bug causing HMAC-SHA* TSIG keys which were longer than the digest length of the @@ -75,10 +78,10 @@ secret. (If the secret did not require conversion, then it will be printed without modification.) </para> - </refsect1> + </refsection> + + <refsection><info><title>SECURITY CONSIDERATIONS</title></info> - <refsect1> - <title>SECURITY CONSIDERATIONS</title> <para> Secrets that have been converted by <command>isc-hmac-fixup</command> are shortened, but as this is how the HMAC protocol works in @@ -87,24 +90,14 @@ extra length would not significantly increase the function strength." </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para> <citetitle>BIND 9 Administrator Reference Manual</citetitle>, <citetitle>RFC 2104</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/tools/isc-hmac-fixup.html b/bin/tools/isc-hmac-fixup.html index cb975589c25e..5bd25586feca 100644 --- a/bin/tools/isc-hmac-fixup.html +++ b/bin/tools/isc-hmac-fixup.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2010, 2013-2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>isc-hmac-fixup</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.isc-hmac-fixup"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -30,8 +29,8 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">isc-hmac-fixup</code> {<em class="replaceable"><code>algorithm</code></em>} {<em class="replaceable"><code>secret</code></em>}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543366"></a><h2>DESCRIPTION</h2> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> <p> 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 @@ -43,11 +42,11 @@ <p> 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. <span><strong class="command">isc-hmac-fixup</strong></span> + BIND, when using long keys. <span class="command"><strong>isc-hmac-fixup</strong></span> modifies those keys to restore compatibility. </p> <p> - To modify a key, run <span><strong class="command">isc-hmac-fixup</strong></span> and + To modify a key, run <span class="command"><strong>isc-hmac-fixup</strong></span> 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 @@ -56,10 +55,10 @@ printed without modification.) </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543389"></a><h2>SECURITY CONSIDERATIONS</h2> +<div class="refsection"> +<a name="id-1.8"></a><h2>SECURITY CONSIDERATIONS</h2> <p> - Secrets that have been converted by <span><strong class="command">isc-hmac-fixup</strong></span> + Secrets that have been converted by <span class="command"><strong>isc-hmac-fixup</strong></span> 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 @@ -67,17 +66,12 @@ strength." </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543403"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>SEE ALSO</h2> <p> <em class="citetitle">BIND 9 Administrator Reference Manual</em>, <em class="citetitle">RFC 2104</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543489"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/tools/named-journalprint.8 b/bin/tools/named-journalprint.8 index ec91eb273494..8363739c0126 100644 --- a/bin/tools/named-journalprint.8 +++ b/bin/tools/named-journalprint.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -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 <http://docbook.sf.net/> -.\" Date: December 04, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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 +.HP \w'\fBnamed\-journalprint\fR\ 'u \fBnamed\-journalprint\fR {\fIjournal\fR} .SH "DESCRIPTION" .PP \fBnamed\-journalprint\fR -prints the contents of a zone journal file in a human\-readable form. +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" -Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/named-journalprint.docbook b/bin/tools/named-journalprint.docbook index 8d65c8e30093..4fd019f28bfa 100644 --- a/bin/tools/named-journalprint.docbook +++ b/bin/tools/named-journalprint.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.named-journalprint"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-journalprint"> + <info> + <date>2009-12-04</date> + </info> <refentryinfo> - <date>December 04, 2009</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -37,26 +39,27 @@ <copyright> <year>2009</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>named-journalprint</command> - <arg choice="req"><replaceable class="parameter">journal</replaceable></arg> + <arg choice="req" rep="norepeat"><replaceable class="parameter">journal</replaceable></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para> <command>named-journalprint</command> prints the contents of a zone journal file in a human-readable - form. + form. </para> <para> - Journal files are automatically created by <command>named</command> + Journal files are automatically created by <command>named</command> when changes are made to dynamic zones (e.g., by <command>nsupdate</command>). They record each addition or deletion of a resource record, in binary format, allowing the @@ -73,10 +76,10 @@ deleted, and continues with the resource record in master-file format. </para> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para> <citerefentry> <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum> @@ -86,16 +89,6 @@ </citerefentry>, <citetitle>BIND 9 Administrator Reference Manual</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/tools/named-journalprint.html b/bin/tools/named-journalprint.html index 3e5e19f239f2..66b91a7441d6 100644 --- a/bin/tools/named-journalprint.html +++ b/bin/tools/named-journalprint.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>named-journalprint</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.named-journalprint"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -30,17 +29,17 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">named-journalprint</code> {<em class="replaceable"><code>journal</code></em>}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543354"></a><h2>DESCRIPTION</h2> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> <p> - <span><strong class="command">named-journalprint</strong></span> + <span class="command"><strong>named-journalprint</strong></span> prints the contents of a zone journal file in a human-readable - form. + form. </p> <p> - Journal files are automatically created by <span><strong class="command">named</strong></span> + Journal files are automatically created by <span class="command"><strong>named</strong></span> when changes are made to dynamic zones (e.g., by - <span><strong class="command">nsupdate</strong></span>). They record each addition + <span class="command"><strong>nsupdate</strong></span>). 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 @@ -49,25 +48,20 @@ zone file. </p> <p> - <span><strong class="command">named-journalprint</strong></span> converts the contents of a given + <span class="command"><strong>named-journalprint</strong></span> 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. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543389"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.8"></a><h2>SEE ALSO</h2> <p> <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, <span class="citerefentry"><span class="refentrytitle">nsupdate</span>(8)</span>, <em class="citetitle">BIND 9 Administrator Reference Manual</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543420"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> diff --git a/bin/tools/nsec3hash.8 b/bin/tools/nsec3hash.8 index d4444ce8e2c3..39ff3b48f4d1 100644 --- a/bin/tools/nsec3hash.8 +++ b/bin/tools/nsec3hash.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -12,59 +12,75 @@ .\" 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 <http://docbook.sf.net/> -.\" Date: March 02, 2009 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" 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" -.HP 10 +.HP \w'\fBnsec3hash\fR\ 'u \fBnsec3hash\fR {\fIsalt\fR} {\fIalgorithm\fR} {\fIiterations\fR} {\fIdomain\fR} .SH "DESCRIPTION" .PP \fBnsec3hash\fR -generates an NSEC3 hash based on a set of NSEC3 parameters. This can be used to check the validity of NSEC3 records in a signed zone. +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" -Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/tools/nsec3hash.docbook b/bin/tools/nsec3hash.docbook index 618e53a1aae7..2750d2218dbc 100644 --- a/bin/tools/nsec3hash.docbook +++ b/bin/tools/nsec3hash.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -17,9 +14,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry id="man.nsec3hash"> +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.nsec3hash"> + <info> + <date>2009-03-02</date> + </info> <refentryinfo> - <date>March 02, 2009</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -37,31 +39,32 @@ <copyright> <year>2009</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> </docinfo> <refsynopsisdiv> - <cmdsynopsis> + <cmdsynopsis sepchar=" "> <command>nsec3hash</command> - <arg choice="req"><replaceable class="parameter">salt</replaceable></arg> - <arg choice="req"><replaceable class="parameter">algorithm</replaceable></arg> - <arg choice="req"><replaceable class="parameter">iterations</replaceable></arg> - <arg choice="req"><replaceable class="parameter">domain</replaceable></arg> + <arg choice="req" rep="norepeat"><replaceable class="parameter">salt</replaceable></arg> + <arg choice="req" rep="norepeat"><replaceable class="parameter">algorithm</replaceable></arg> + <arg choice="req" rep="norepeat"><replaceable class="parameter">iterations</replaceable></arg> + <arg choice="req" rep="norepeat"><replaceable class="parameter">domain</replaceable></arg> </cmdsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para> <command>nsec3hash</command> 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. </para> - </refsect1> + </refsection> + + <refsection><info><title>ARGUMENTS</title></info> - <refsect1> - <title>ARGUMENTS</title> <variablelist> <varlistentry> <term>salt</term> @@ -102,24 +105,14 @@ </listitem> </varlistentry> </variablelist> - </refsect1> + </refsection> + + <refsection><info><title>SEE ALSO</title></info> - <refsect1> - <title>SEE ALSO</title> <para> <citetitle>BIND 9 Administrator Reference Manual</citetitle>, <citetitle>RFC 5155</citetitle>. </para> - </refsect1> + </refsection> - <refsect1> - <title>AUTHOR</title> - <para><corpauthor>Internet Systems Consortium</corpauthor> - </para> - </refsect1> - -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> +</refentry> diff --git a/bin/tools/nsec3hash.html b/bin/tools/nsec3hash.html index acb83e6ee152..e5de8fca9a47 100644 --- a/bin/tools/nsec3hash.html +++ b/bin/tools/nsec3hash.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - - Permission to use, copy, modify, and/or distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -13,14 +13,13 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id$ --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>nsec3hash</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> </head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"> <a name="man.nsec3hash"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Name</h2> @@ -30,17 +29,17 @@ <h2>Synopsis</h2> <div class="cmdsynopsis"><p><code class="command">nsec3hash</code> {<em class="replaceable"><code>salt</code></em>} {<em class="replaceable"><code>algorithm</code></em>} {<em class="replaceable"><code>iterations</code></em>} {<em class="replaceable"><code>domain</code></em>}</p></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543379"></a><h2>DESCRIPTION</h2> +<div class="refsection"> +<a name="id-1.7"></a><h2>DESCRIPTION</h2> <p> - <span><strong class="command">nsec3hash</strong></span> generates an NSEC3 hash based on + <span class="command"><strong>nsec3hash</strong></span> 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. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543392"></a><h2>ARGUMENTS</h2> -<div class="variablelist"><dl> +<div class="refsection"> +<a name="id-1.8"></a><h2>ARGUMENTS</h2> +<div class="variablelist"><dl class="variablelist"> <dt><span class="term">salt</span></dt> <dd><p> The salt provided to the hash algorithm. @@ -62,17 +61,12 @@ </p></dd> </dl></div> </div> -<div class="refsect1" lang="en"> -<a name="id2543453"></a><h2>SEE ALSO</h2> +<div class="refsection"> +<a name="id-1.9"></a><h2>SEE ALSO</h2> <p> <em class="citetitle">BIND 9 Administrator Reference Manual</em>, <em class="citetitle">RFC 5155</em>. </p> </div> -<div class="refsect1" lang="en"> -<a name="id2543470"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> </div></body> </html> |