contrib/bind9/doc/arm/man.dnssec-signzone.html

   1 <!--
   2  - Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2003 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and distribute this software for any
   6  - purpose with or without fee is hereby granted, provided that the above
   7  - copyright notice and this permission notice appear in all copies.
   8  -
   9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17 <!-- $Id: man.dnssec-signzone.html,v 1.2.2.65 2008/10/18 01:29:59 tbox Exp $ -->
  18 <html>
  19 <head>
  20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21 <title>dnssec-signzone</title>
  22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  23 <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
  24 <link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
  25 <link rel="prev" href="man.dnssec-keygen.html" title="dnssec-keygen">
  26 <link rel="next" href="man.named-checkconf.html" title="named-checkconf">
  27 </head>
  28 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  29 <div class="navheader">
  30 <table width="100%" summary="Navigation header">
  31 <tr><th colspan="3" align="center"><span class="application">dnssec-signzone</span></th></tr>
  32 <tr>
  33 <td width="20%" align="left">
  34 <a accesskey="p" href="man.dnssec-keygen.html">Prev</a> </td>
  35 <th width="60%" align="center">Manual pages</th>
  36 <td width="20%" align="right"> <a accesskey="n" href="man.named-checkconf.html">Next</a>
  37 </td>
  38 </tr>
  39 </table>
  40 <hr>
  41 </div>
  42 <div class="refentry" lang="en">
  43 <a name="man.dnssec-signzone"></a><div class="titlepage"></div>
  44 <div class="refnamediv">
  45 <h2>Name</h2>
  46 <p><span class="application">dnssec-signzone</span> &#8212; DNSSEC zone signing tool</p>
  47 </div>
  48 <div class="refsynopsisdiv">
  49 <h2>Synopsis</h2>
  50 <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">-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>key</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">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-s <em class="replaceable"><code>start-time</code></em></code>] [<code class="option">-t</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-z</code>] {zonefile} [key...]</p></div>
  51 </div>
  52 <div class="refsect1" lang="en">
  53 <a name="id2599262"></a><h2>DESCRIPTION</h2>
  54 <p><span><strong class="command">dnssec-signzone</strong></span>
  55       signs a zone.  It generates
  56       NSEC and RRSIG records and produces a signed version of the
  57       zone. The security status of delegations from the signed zone
  58       (that is, whether the child zones are secure or not) is
  59       determined by the presence or absence of a
  60       <code class="filename">keyset</code> file for each child zone.
  61     </p>
  62 </div>
  63 <div class="refsect1" lang="en">
  64 <a name="id2599282"></a><h2>OPTIONS</h2>
  65 <div class="variablelist"><dl>
  66 <dt><span class="term">-a</span></dt>
  67 <dd><p>
  68             Verify all generated signatures.
  69           </p></dd>
  70 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
  71 <dd><p>
  72             Specifies the DNS class of the zone.
  73           </p></dd>
  74 <dt><span class="term">-k <em class="replaceable"><code>key</code></em></span></dt>
  75 <dd><p>
  76             Treat specified key as a key signing key ignoring any
  77             key flags.  This option may be specified multiple times.
  78           </p></dd>
  79 <dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
  80 <dd><p>
  81             Generate a DLV set in addition to the key (DNSKEY) and DS sets.
  82             The domain is appended to the name of the records.
  83           </p></dd>
  84 <dt><span class="term">-d <em class="replaceable"><code>directory</code></em></span></dt>
  85 <dd><p>
  86             Look for <code class="filename">keyset</code> files in
  87             <code class="option">directory</code> as the directory
  88           </p></dd>
  89 <dt><span class="term">-g</span></dt>
  90 <dd><p>
  91             Generate DS records for child zones from keyset files.
  92             Existing DS records will be removed.
  93           </p></dd>
  94 <dt><span class="term">-s <em class="replaceable"><code>start-time</code></em></span></dt>
  95 <dd><p>
  96             Specify the date and time when the generated RRSIG records
  97             become valid.  This can be either an absolute or relative
  98             time.  An absolute start time is indicated by a number
  99             in YYYYMMDDHHMMSS notation; 20000530144500 denotes
 100             14:45:00 UTC on May 30th, 2000.  A relative start time is
 101             indicated by +N, which is N seconds from the current time.
 102             If no <code class="option">start-time</code> is specified, the current
 103             time minus 1 hour (to allow for clock skew) is used.
 104           </p></dd>
 105 <dt><span class="term">-e <em class="replaceable"><code>end-time</code></em></span></dt>
 106 <dd><p>
 107             Specify the date and time when the generated RRSIG records
 108             expire.  As with <code class="option">start-time</code>, an absolute
 109             time is indicated in YYYYMMDDHHMMSS notation.  A time relative
 110             to the start time is indicated with +N, which is N seconds from
 111             the start time.  A time relative to the current time is
 112             indicated with now+N.  If no <code class="option">end-time</code> is
 113             specified, 30 days from the start time is used as a default.
 114           </p></dd>
 115 <dt><span class="term">-f <em class="replaceable"><code>output-file</code></em></span></dt>
 116 <dd><p>
 117             The name of the output file containing the signed zone.  The
 118             default is to append <code class="filename">.signed</code> to
 119             the
 120             input filename.
 121           </p></dd>
 122 <dt><span class="term">-h</span></dt>
 123 <dd><p>
 124             Prints a short summary of the options and arguments to
 125             <span><strong class="command">dnssec-signzone</strong></span>.
 126           </p></dd>
 127 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
 128 <dd>
 129 <p>
 130             When a previously-signed zone is passed as input, records
 131             may be resigned.  The <code class="option">interval</code> option
 132             specifies the cycle interval as an offset from the current
 133             time (in seconds).  If a RRSIG record expires after the
 134             cycle interval, it is retained.  Otherwise, it is considered
 135             to be expiring soon, and it will be replaced.
 136           </p>
 137 <p>
 138             The default cycle interval is one quarter of the difference
 139             between the signature end and start times.  So if neither
 140             <code class="option">end-time</code> or <code class="option">start-time</code>
 141             are specified, <span><strong class="command">dnssec-signzone</strong></span>
 142             generates
 143             signatures that are valid for 30 days, with a cycle
 144             interval of 7.5 days.  Therefore, if any existing RRSIG records
 145             are due to expire in less than 7.5 days, they would be
 146             replaced.
 147           </p>
 148 </dd>
 149 <dt><span class="term">-I <em class="replaceable"><code>input-format</code></em></span></dt>
 150 <dd><p>
 151             The format of the input zone file.
 152             Possible formats are <span><strong class="command">"text"</strong></span> (default)
 153             and <span><strong class="command">"raw"</strong></span>.
 154             This option is primarily intended to be used for dynamic
 155             signed zones so that the dumped zone file in a non-text
 156             format containing updates can be signed directly.
 157             The use of this option does not make much sense for
 158             non-dynamic zones.
 159           </p></dd>
 160 <dt><span class="term">-j <em class="replaceable"><code>jitter</code></em></span></dt>
 161 <dd>
 162 <p>
 163             When signing a zone with a fixed signature lifetime, all
 164             RRSIG records issued at the time of signing expires
 165             simultaneously.  If the zone is incrementally signed, i.e.
 166             a previously-signed zone is passed as input to the signer,
 167             all expired signatures have to be regenerated at about the
 168             same time.  The <code class="option">jitter</code> option specifies a
 169             jitter window that will be used to randomize the signature
 170             expire time, thus spreading incremental signature
 171             regeneration over time.
 172           </p>
 173 <p>
 174             Signature lifetime jitter also to some extent benefits
 175             validators and servers by spreading out cache expiration,
 176             i.e. if large numbers of RRSIGs don't expire at the same time
 177             from all caches there will be less congestion than if all
 178             validators need to refetch at mostly the same time.
 179           </p>
 180 </dd>
 181 <dt><span class="term">-n <em class="replaceable"><code>ncpus</code></em></span></dt>
 182 <dd><p>
 183             Specifies the number of threads to use.  By default, one
 184             thread is started for each detected CPU.
 185           </p></dd>
 186 <dt><span class="term">-N <em class="replaceable"><code>soa-serial-format</code></em></span></dt>
 187 <dd>
 188 <p>
 189             The SOA serial number format of the signed zone.
 190             Possible formats are <span><strong class="command">"keep"</strong></span> (default),
 191             <span><strong class="command">"increment"</strong></span> and
 192             <span><strong class="command">"unixtime"</strong></span>.
 193           </p>
 194 <div class="variablelist"><dl>
 195 <dt><span class="term"><span><strong class="command">"keep"</strong></span></span></dt>
 196 <dd><p>Do not modify the SOA serial number.</p></dd>
 197 <dt><span class="term"><span><strong class="command">"increment"</strong></span></span></dt>
 198 <dd><p>Increment the SOA serial number using RFC 1982
 199                       arithmetics.</p></dd>
 200 <dt><span class="term"><span><strong class="command">"unixtime"</strong></span></span></dt>
 201 <dd><p>Set the SOA serial number to the number of seconds
 202                 since epoch.</p></dd>
 203 </dl></div>
 204 </dd>
 205 <dt><span class="term">-o <em class="replaceable"><code>origin</code></em></span></dt>
 206 <dd><p>
 207             The zone origin.  If not specified, the name of the zone file
 208             is assumed to be the origin.
 209           </p></dd>
 210 <dt><span class="term">-O <em class="replaceable"><code>output-format</code></em></span></dt>
 211 <dd><p>
 212             The format of the output file containing the signed zone.
 213             Possible formats are <span><strong class="command">"text"</strong></span> (default)
 214             and <span><strong class="command">"raw"</strong></span>.
 215           </p></dd>
 216 <dt><span class="term">-p</span></dt>
 217 <dd><p>
 218             Use pseudo-random data when signing the zone.  This is faster,
 219             but less secure, than using real random data.  This option
 220             may be useful when signing large zones or when the entropy
 221             source is limited.
 222           </p></dd>
 223 <dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
 224 <dd><p>
 225             Specifies the source of randomness.  If the operating
 226             system does not provide a <code class="filename">/dev/random</code>
 227             or equivalent device, the default source of randomness
 228             is keyboard input.  <code class="filename">randomdev</code>
 229             specifies
 230             the name of a character device or file containing random
 231             data to be used instead of the default.  The special value
 232             <code class="filename">keyboard</code> indicates that keyboard
 233             input should be used.
 234           </p></dd>
 235 <dt><span class="term">-t</span></dt>
 236 <dd><p>
 237             Print statistics at completion.
 238           </p></dd>
 239 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 240 <dd><p>
 241             Sets the debugging level.
 242           </p></dd>
 243 <dt><span class="term">-z</span></dt>
 244 <dd><p>
 245             Ignore KSK flag on key when determining what to sign.
 246           </p></dd>
 247 <dt><span class="term">zonefile</span></dt>
 248 <dd><p>
 249             The file containing the zone to be signed.
 250           </p></dd>
 251 <dt><span class="term">key</span></dt>
 252 <dd><p>
 253             Specify which keys should be used to sign the zone.  If
 254             no keys are specified, then the zone will be examined
 255             for DNSKEY records at the zone apex.  If these are found and
 256             there are matching private keys, in the current directory,
 257             then these will be used for signing.
 258           </p></dd>
 259 </dl></div>
 260 </div>
 261 <div class="refsect1" lang="en">
 262 <a name="id2653693"></a><h2>EXAMPLE</h2>
 263 <p>
 264       The following command signs the <strong class="userinput"><code>example.com</code></strong>
 265       zone with the DSA key generated by <span><strong class="command">dnssec-keygen</strong></span>
 266       (Kexample.com.+003+17247).  The zone's keys must be in the master
 267       file (<code class="filename">db.example.com</code>).  This invocation looks
 268       for <code class="filename">keyset</code> files, in the current directory,
 269       so that DS records can be generated from them (<span><strong class="command">-g</strong></span>).
 270     </p>
 271 <pre class="programlisting">% dnssec-signzone -g -o example.com db.example.com \
 272 Kexample.com.+003+17247
 273 db.example.com.signed
 274 %</pre>
 275 <p>
 276       In the above example, <span><strong class="command">dnssec-signzone</strong></span> creates
 277       the file <code class="filename">db.example.com.signed</code>.  This
 278       file should be referenced in a zone statement in a
 279       <code class="filename">named.conf</code> file.
 280     </p>
 281 <p>
 282       This example re-signs a previously signed zone with default parameters.
 283       The private keys are assumed to be in the current directory.
 284     </p>
 285 <pre class="programlisting">% cp db.example.com.signed db.example.com
 286 % dnssec-signzone -o example.com db.example.com
 287 db.example.com.signed
 288 %</pre>
 289 </div>
 290 <div class="refsect1" lang="en">
 291 <a name="id2653766"></a><h2>SEE ALSO</h2>
 292 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 293       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 294       <em class="citetitle">RFC 4033</em>.
 295     </p>
 296 </div>
 297 <div class="refsect1" lang="en">
 298 <a name="id2653790"></a><h2>AUTHOR</h2>
 299 <p><span class="corpauthor">Internet Systems Consortium</span>
 300     </p>
 301 </div>
 302 </div>
 303 <div class="navfooter">
 304 <hr>
 305 <table width="100%" summary="Navigation footer">
 306 <tr>
 307 <td width="40%" align="left">
 308 <a accesskey="p" href="man.dnssec-keygen.html">Prev</a> </td>
 309 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
 310 <td width="40%" align="right"> <a accesskey="n" href="man.named-checkconf.html">Next</a>
 311 </td>
 312 </tr>
 313 <tr>
 314 <td width="40%" align="left" valign="top">
 315 <span class="application">dnssec-keygen</span> </td>
 316 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 317 <td width="40%" align="right" valign="top"> <span class="application">named-checkconf</span>
 318 </td>
 319 </tr>
 320 </table>
 321 </div>
 322 </body>
 323 </html>