contrib/bind9/bin/dnssec/dnssec-signzone.docbook

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <!--
   3  - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   4  - Copyright (C) 2001-2003  Internet Software Consortium.
   5  -
   6  - Permission to use, copy, modify, and distribute this software for any
   7  - purpose with or without fee is hereby granted, provided that the above
   8  - copyright notice and this permission notice appear in all copies.
   9  -
  10  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  11  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  12  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  13  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  14  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  15  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  16  - PERFORMANCE OF THIS SOFTWARE.
  17 -->
  18
  19 <!-- $Id: dnssec-signzone.docbook,v 1.2.2.2.4.8 2004/06/11 01:17:35 marka Exp $ -->
  20
  21 <refentry>
  22   <refentryinfo>
  23     <date>June 30, 2000</date>
  24   </refentryinfo>
  25
  26   <refmeta>
  27     <refentrytitle><application>dnssec-signzone</application></refentrytitle>
  28     <manvolnum>8</manvolnum>
  29     <refmiscinfo>BIND9</refmiscinfo>
  30   </refmeta>
  31
  32   <refnamediv>
  33     <refname><application>dnssec-signzone</application></refname>
  34     <refpurpose>DNSSEC zone signing tool</refpurpose>
  35   </refnamediv>
  36
  37   <refsynopsisdiv>
  38     <cmdsynopsis>
  39       <command>dnssec-signzone</command>
  40       <arg><option>-a</option></arg>
  41       <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
  42       <arg><option>-d <replaceable class="parameter">directory</replaceable></option></arg>
  43       <arg><option>-e <replaceable class="parameter">end-time</replaceable></option></arg>
  44       <arg><option>-f <replaceable class="parameter">output-file</replaceable></option></arg>
  45       <arg><option>-g</option></arg>
  46       <arg><option>-h</option></arg>
  47       <arg><option>-k <replaceable class="parameter">key</replaceable></option></arg>
  48       <arg><option>-l <replaceable class="parameter">domain</replaceable></option></arg>
  49       <arg><option>-i <replaceable class="parameter">interval</replaceable></option></arg>
  50       <arg><option>-n <replaceable class="parameter">nthreads</replaceable></option></arg>
  51       <arg><option>-o <replaceable class="parameter">origin</replaceable></option></arg>
  52       <arg><option>-p</option></arg>
  53       <arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>
  54       <arg><option>-s <replaceable class="parameter">start-time</replaceable></option></arg>
  55       <arg><option>-t</option></arg>
  56       <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
  57       <arg><option>-z</option></arg>
  58       <arg choice="req">zonefile</arg>
  59       <arg rep="repeat">key</arg>
  60     </cmdsynopsis>
  61   </refsynopsisdiv>
  62
  63   <refsect1>
  64     <title>DESCRIPTION</title>
  65     <para>
  66         <command>dnssec-signzone</command> signs a zone.  It generates
  67         NSEC and RRSIG records and produces a signed version of the
  68         zone. The security status of delegations from the signed zone
  69         (that is, whether the child zones are secure or not) is
  70         determined by the presence or absence of a
  71         <filename>keyset</filename> file for each child zone.
  72     </para>
  73   </refsect1>
  74
  75   <refsect1>
  76     <title>OPTIONS</title>
  77
  78     <variablelist>
  79       <varlistentry>
  80         <term>-a</term>
  81         <listitem>
  82           <para>
  83               Verify all generated signatures.
  84           </para>
  85         </listitem>
  86       </varlistentry>
  87
  88       <varlistentry>
  89         <term>-c <replaceable class="parameter">class</replaceable></term>
  90         <listitem>
  91           <para>
  92                Specifies the DNS class of the zone.
  93           </para>
  94         </listitem>
  95       </varlistentry>
  96
  97       <varlistentry>
  98         <term>-k <replaceable class="parameter">key</replaceable></term>
  99         <listitem>
 100           <para>
 101                Treat specified key as a key signing key ignoring any
 102                key flags.  This option may be specified multiple times.
 103           </para>
 104         </listitem>
 105       </varlistentry>
 106
 107       <varlistentry>
 108         <term>-l <replaceable class="parameter">domain</replaceable></term>
 109         <listitem>
 110           <para>
 111                 Generate a DLV set in addition to the key (DNSKEY) and DS sets.
 112                 The domain is appended to the name of the records.
 113           </para>
 114         </listitem>
 115       </varlistentry>
 116
 117       <varlistentry>
 118         <term>-d <replaceable class="parameter">directory</replaceable></term>
 119         <listitem>
 120           <para>
 121                Look for <filename>keyset</filename> files in
 122                <option>directory</option> as the directory
 123           </para>
 124         </listitem>
 125       </varlistentry>
 126
 127       <varlistentry>
 128         <term>-g</term>
 129         <listitem>
 130           <para>
 131                 Generate DS records for child zones from keyset files.
 132                 Existing DS records will be removed.
 133           </para>
 134         </listitem>
 135       </varlistentry>
 136
 137       <varlistentry>
 138         <term>-s <replaceable class="parameter">start-time</replaceable></term>
 139         <listitem>
 140           <para>
 141                Specify the date and time when the generated RRSIG records
 142                become valid.  This can be either an absolute or relative
 143                time.  An absolute start time is indicated by a number
 144                in YYYYMMDDHHMMSS notation; 20000530144500 denotes
 145                14:45:00 UTC on May 30th, 2000.  A relative start time is
 146                indicated by +N, which is N seconds from the current time.
 147                If no <option>start-time</option> is specified, the current
 148                time minus 1 hour (to allow for clock skew) is used.
 149           </para>
 150         </listitem>
 151       </varlistentry>
 152
 153       <varlistentry>
 154         <term>-e <replaceable class="parameter">end-time</replaceable></term>
 155         <listitem>
 156           <para>
 157                Specify the date and time when the generated RRSIG records
 158                expire.  As with <option>start-time</option>, an absolute
 159                time is indicated in YYYYMMDDHHMMSS notation.  A time relative
 160                to the start time is indicated with +N, which is N seconds from
 161                the start time.  A time relative to the current time is
 162                indicated with now+N.  If no <option>end-time</option> is
 163                specified, 30 days from the start time is used as a default.
 164           </para>
 165         </listitem>
 166       </varlistentry>
 167
 168       <varlistentry>
 169         <term>-f <replaceable class="parameter">output-file</replaceable></term>
 170         <listitem>
 171           <para>
 172                The name of the output file containing the signed zone.  The
 173                default is to append <filename>.signed</filename> to the
 174                input file.
 175           </para>
 176         </listitem>
 177       </varlistentry>
 178
 179       <varlistentry>
 180         <term>-h</term>
 181         <listitem>
 182           <para>
 183                Prints a short summary of the options and arguments to
 184                <command>dnssec-signzone</command>.
 185           </para>
 186         </listitem>
 187       </varlistentry>
 188
 189       <varlistentry>
 190         <term>-i <replaceable class="parameter">interval</replaceable></term>
 191         <listitem>
 192           <para>
 193                When a previously signed zone is passed as input, records
 194                may be resigned.  The <option>interval</option> option
 195                specifies the cycle interval as an offset from the current
 196                time (in seconds).  If a RRSIG record expires after the
 197                cycle interval, it is retained.  Otherwise, it is considered
 198                to be expiring soon, and it will be replaced.
 199           </para>
 200           <para>
 201                The default cycle interval is one quarter of the difference
 202                between the signature end and start times.  So if neither
 203                <option>end-time</option> or <option>start-time</option>
 204                are specified, <command>dnssec-signzone</command> generates
 205                signatures that are valid for 30 days, with a cycle
 206                interval of 7.5 days.  Therefore, if any existing RRSIG records
 207                are due to expire in less than 7.5 days, they would be
 208                replaced.
 209           </para>
 210         </listitem>
 211       </varlistentry>
 212
 213       <varlistentry>
 214         <term>-n <replaceable class="parameter">ncpus</replaceable></term>
 215         <listitem>
 216           <para>
 217                Specifies the number of threads to use.  By default, one
 218                thread is started for each detected CPU.
 219           </para>
 220         </listitem>
 221       </varlistentry>
 222
 223       <varlistentry>
 224         <term>-o <replaceable class="parameter">origin</replaceable></term>
 225         <listitem>
 226           <para>
 227                The zone origin.  If not specified, the name of the zone file
 228                is assumed to be the origin.
 229           </para>
 230         </listitem>
 231       </varlistentry>
 232
 233       <varlistentry>
 234         <term>-p</term>
 235         <listitem>
 236           <para>
 237                Use pseudo-random data when signing the zone.  This is faster,
 238                but less secure, than using real random data.  This option
 239                may be useful when signing large zones or when the entropy
 240                source is limited.
 241           </para>
 242         </listitem>
 243       </varlistentry>
 244
 245       <varlistentry>
 246         <term>-r <replaceable class="parameter">randomdev</replaceable></term>
 247         <listitem>
 248           <para>
 249                Specifies the source of randomness.  If the operating
 250                system does not provide a <filename>/dev/random</filename>
 251                or equivalent device, the default source of randomness
 252                is keyboard input.  <filename>randomdev</filename> specifies
 253                the name of a character device or file containing random
 254                data to be used instead of the default.  The special value
 255                <filename>keyboard</filename> indicates that keyboard
 256                input should be used.
 257           </para>
 258         </listitem>
 259       </varlistentry>
 260
 261       <varlistentry>
 262         <term>-t</term>
 263         <listitem>
 264           <para>
 265                Print statistics at completion.
 266           </para>
 267         </listitem>
 268       </varlistentry>
 269
 270       <varlistentry>
 271         <term>-v <replaceable class="parameter">level</replaceable></term>
 272         <listitem>
 273           <para>
 274                Sets the debugging level.
 275           </para>
 276         </listitem>
 277       </varlistentry>
 278
 279       <varlistentry>
 280         <term>-z</term>
 281         <listitem>
 282           <para>
 283                Ignore KSK flag on key when determining what to sign.
 284           </para>
 285         </listitem>
 286       </varlistentry>
 287
 288       <varlistentry>
 289         <term>zonefile</term>
 290         <listitem>
 291           <para>
 292                The file containing the zone to be signed.
 293                Sets the debugging level.
 294           </para>
 295         </listitem>
 296       </varlistentry>
 297
 298       <varlistentry>
 299         <term>key</term>
 300         <listitem>
 301           <para>
 302                The keys used to sign the zone.  If no keys are specified, the
 303                default all zone keys that have private key files in the
 304                current directory.
 305           </para>
 306         </listitem>
 307       </varlistentry>
 308
 309     </variablelist>
 310   </refsect1>
 311
 312   <refsect1>
 313     <title>EXAMPLE</title>
 314     <para>
 315         The following command signs the <userinput>example.com</userinput>
 316         zone with the DSA key generated in the <command>dnssec-keygen</command>
 317         man page.  The zone's keys must be in the zone.  If there are
 318         <filename>keyset</filename> files associated with child zones,
 319         they must be in the current directory.
 320         <userinput>example.com</userinput>, the following command would be
 321         issued:
 322     </para>
 323     <para>
 324         <userinput>dnssec-signzone -o example.com db.example.com Kexample.com.+003+26160</userinput>
 325     </para>
 326     <para>
 327         The command would print a string of the form:
 328     </para>
 329     <para>
 330         In this example, <command>dnssec-signzone</command> creates
 331         the file <filename>db.example.com.signed</filename>.  This file
 332         should be referenced in a zone statement in a
 333         <filename>named.conf</filename> file.
 334     </para>
 335   </refsect1>
 336
 337   <refsect1>
 338     <title>SEE ALSO</title>
 339     <para>
 340       <citerefentry>
 341         <refentrytitle>dnssec-keygen</refentrytitle>
 342         <manvolnum>8</manvolnum>
 343       </citerefentry>,
 344       <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
 345       <citetitle>RFC 2535</citetitle>.
 346     </para>
 347   </refsect1>
 348
 349   <refsect1>
 350     <title>AUTHOR</title>
 351     <para>
 352         <corpauthor>Internet Systems Consortium</corpauthor>
 353     </para>
 354   </refsect1>
 355
 356 </refentry>
 357
 358 <!--
 359  - Local variables:
 360  - mode: sgml
 361  - End:
 362 -->