contrib/bind-9.3/bin/dnssec/dnssec-signzone.html

   1 <!--
   2  - Copyright (C) 2004, 2005 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: dnssec-signzone.html,v 1.4.2.1.4.16 2006/06/29 13:02:30 marka 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.70.1">
  23 </head>
  24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
  25 <a name="id2482688"></a><div class="titlepage"></div>
  26 <div class="refnamediv">
  27 <h2>Name</h2>
  28 <p><span class="application">dnssec-signzone</span> &#8212; DNSSEC zone signing tool</p>
  29 </div>
  30 <div class="refsynopsisdiv">
  31 <h2>Synopsis</h2>
  32 <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">-n <em class="replaceable"><code>nthreads</code></em></code>] [<code class="option">-o <em class="replaceable"><code>origin</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>
  33 </div>
  34 <div class="refsect1" lang="en">
  35 <a name="id2549544"></a><h2>DESCRIPTION</h2>
  36 <p>
  37         <span><strong class="command">dnssec-signzone</strong></span> signs a zone.  It generates
  38         NSEC and RRSIG records and produces a signed version of the
  39         zone. The security status of delegations from the signed zone
  40         (that is, whether the child zones are secure or not) is
  41         determined by the presence or absence of a
  42         <code class="filename">keyset</code> file for each child zone.
  43     </p>
  44 </div>
  45 <div class="refsect1" lang="en">
  46 <a name="id2549560"></a><h2>OPTIONS</h2>
  47 <div class="variablelist"><dl>
  48 <dt><span class="term">-a</span></dt>
  49 <dd><p>
  50               Verify all generated signatures.
  51           </p></dd>
  52 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
  53 <dd><p>
  54                Specifies the DNS class of the zone.
  55           </p></dd>
  56 <dt><span class="term">-k <em class="replaceable"><code>key</code></em></span></dt>
  57 <dd><p>
  58                Treat specified key as a key signing key ignoring any
  59                key flags.  This option may be specified multiple times.
  60           </p></dd>
  61 <dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
  62 <dd><p>
  63                 Generate a DLV set in addition to the key (DNSKEY) and DS sets.
  64                 The domain is appended to the name of the records.
  65           </p></dd>
  66 <dt><span class="term">-d <em class="replaceable"><code>directory</code></em></span></dt>
  67 <dd><p>
  68                Look for <code class="filename">keyset</code> files in
  69                <code class="option">directory</code> as the directory
  70           </p></dd>
  71 <dt><span class="term">-g</span></dt>
  72 <dd><p>
  73                 Generate DS records for child zones from keyset files.
  74                 Existing DS records will be removed.
  75           </p></dd>
  76 <dt><span class="term">-s <em class="replaceable"><code>start-time</code></em></span></dt>
  77 <dd><p>
  78                Specify the date and time when the generated RRSIG records
  79                become valid.  This can be either an absolute or relative
  80                time.  An absolute start time is indicated by a number
  81                in YYYYMMDDHHMMSS notation; 20000530144500 denotes
  82                14:45:00 UTC on May 30th, 2000.  A relative start time is
  83                indicated by +N, which is N seconds from the current time.
  84                If no <code class="option">start-time</code> is specified, the current
  85                time minus 1 hour (to allow for clock skew) is used.
  86           </p></dd>
  87 <dt><span class="term">-e <em class="replaceable"><code>end-time</code></em></span></dt>
  88 <dd><p>
  89                Specify the date and time when the generated RRSIG records
  90                expire.  As with <code class="option">start-time</code>, an absolute
  91                time is indicated in YYYYMMDDHHMMSS notation.  A time relative
  92                to the start time is indicated with +N, which is N seconds from
  93                the start time.  A time relative to the current time is
  94                indicated with now+N.  If no <code class="option">end-time</code> is
  95                specified, 30 days from the start time is used as a default.
  96           </p></dd>
  97 <dt><span class="term">-f <em class="replaceable"><code>output-file</code></em></span></dt>
  98 <dd><p>
  99                The name of the output file containing the signed zone.  The
 100                default is to append <code class="filename">.signed</code> to the
 101                input file.
 102           </p></dd>
 103 <dt><span class="term">-h</span></dt>
 104 <dd><p>
 105                Prints a short summary of the options and arguments to
 106                <span><strong class="command">dnssec-signzone</strong></span>.
 107           </p></dd>
 108 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
 109 <dd>
 110 <p>
 111                When a previously signed zone is passed as input, records
 112                may be resigned.  The <code class="option">interval</code> option
 113                specifies the cycle interval as an offset from the current
 114                time (in seconds).  If a RRSIG record expires after the
 115                cycle interval, it is retained.  Otherwise, it is considered
 116                to be expiring soon, and it will be replaced.
 117           </p>
 118 <p>
 119                The default cycle interval is one quarter of the difference
 120                between the signature end and start times.  So if neither
 121                <code class="option">end-time</code> or <code class="option">start-time</code>
 122                are specified, <span><strong class="command">dnssec-signzone</strong></span> generates
 123                signatures that are valid for 30 days, with a cycle
 124                interval of 7.5 days.  Therefore, if any existing RRSIG records
 125                are due to expire in less than 7.5 days, they would be
 126                replaced.
 127           </p>
 128 </dd>
 129 <dt><span class="term">-n <em class="replaceable"><code>ncpus</code></em></span></dt>
 130 <dd><p>
 131                Specifies the number of threads to use.  By default, one
 132                thread is started for each detected CPU.
 133           </p></dd>
 134 <dt><span class="term">-o <em class="replaceable"><code>origin</code></em></span></dt>
 135 <dd><p>
 136                The zone origin.  If not specified, the name of the zone file
 137                is assumed to be the origin.
 138           </p></dd>
 139 <dt><span class="term">-p</span></dt>
 140 <dd><p>
 141                Use pseudo-random data when signing the zone.  This is faster,
 142                but less secure, than using real random data.  This option
 143                may be useful when signing large zones or when the entropy
 144                source is limited.
 145           </p></dd>
 146 <dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
 147 <dd><p>
 148                Specifies the source of randomness.  If the operating
 149                system does not provide a <code class="filename">/dev/random</code>
 150                or equivalent device, the default source of randomness
 151                is keyboard input.  <code class="filename">randomdev</code> specifies
 152                the name of a character device or file containing random
 153                data to be used instead of the default.  The special value
 154                <code class="filename">keyboard</code> indicates that keyboard
 155                input should be used.
 156           </p></dd>
 157 <dt><span class="term">-t</span></dt>
 158 <dd><p>
 159                Print statistics at completion.
 160           </p></dd>
 161 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 162 <dd><p>
 163                Sets the debugging level.
 164           </p></dd>
 165 <dt><span class="term">-z</span></dt>
 166 <dd><p>
 167                Ignore KSK flag on key when determining what to sign.
 168           </p></dd>
 169 <dt><span class="term">zonefile</span></dt>
 170 <dd><p>
 171                The file containing the zone to be signed.
 172           </p></dd>
 173 <dt><span class="term">key</span></dt>
 174 <dd><p>
 175                The keys used to sign the zone.  If no keys are specified, the
 176                default all zone keys that have private key files in the
 177                current directory.
 178           </p></dd>
 179 </dl></div>
 180 </div>
 181 <div class="refsect1" lang="en">
 182 <a name="id2550068"></a><h2>EXAMPLE</h2>
 183 <p>
 184         The following command signs the <strong class="userinput"><code>example.com</code></strong>
 185         zone with the DSA key generated in the <span><strong class="command">dnssec-keygen</strong></span>
 186         man page.  The zone's keys must be in the zone.  If there are
 187         <code class="filename">keyset</code> files associated with child zones,
 188         they must be in the current directory.
 189         <strong class="userinput"><code>example.com</code></strong>, the following command would be
 190         issued:
 191     </p>
 192 <p>
 193         <strong class="userinput"><code>dnssec-signzone -o example.com db.example.com Kexample.com.+003+26160</code></strong>
 194     </p>
 195 <p>
 196         The command would print a string of the form:
 197     </p>
 198 <p>
 199         In this example, <span><strong class="command">dnssec-signzone</strong></span> creates
 200         the file <code class="filename">db.example.com.signed</code>.  This file
 201         should be referenced in a zone statement in a
 202         <code class="filename">named.conf</code> file.
 203     </p>
 204 </div>
 205 <div class="refsect1" lang="en">
 206 <a name="id2550118"></a><h2>SEE ALSO</h2>
 207 <p>
 208       <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 209       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 210       <em class="citetitle">RFC 2535</em>.
 211     </p>
 212 </div>
 213 <div class="refsect1" lang="en">
 214 <a name="id2550145"></a><h2>AUTHOR</h2>
 215 <p>
 216         <span class="corpauthor">Internet Systems Consortium</span>
 217     </p>
 218 </div>
 219 </div></body>
 220 </html>