dnssec-signzone.docbook 32.8 KB
Newer Older
Brian Wellington's avatar
Brian Wellington committed
1
<!--
Tinderbox User's avatar
Tinderbox User committed
2
 - Copyright (C) 2004-2009, 2011-2014  Internet Systems Consortium, Inc. ("ISC")
3
 - Copyright (C) 2000-2003  Internet Software Consortium.
Brian Wellington's avatar
Brian Wellington committed
4
 -
Automatic Updater's avatar
Automatic Updater committed
5
 - Permission to use, copy, modify, and/or distribute this software for any
Brian Wellington's avatar
Brian Wellington committed
6 7 8
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
Mark Andrews's avatar
Mark Andrews committed
9 10 11 12 13 14 15
 - 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,
 - 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.
Brian Wellington's avatar
Brian Wellington committed
16
-->
Evan Hunt's avatar
Evan Hunt committed
17 18 19 20 21
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-signzone">
  <info>
    <date>2014-02-18</date>
  </info>
22
  <refentryinfo>
Evan Hunt's avatar
Evan Hunt committed
23 24
    <corpname>ISC</corpname>
    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
25 26 27 28
  </refentryinfo>

  <refmeta>
    <refentrytitle><application>dnssec-signzone</application></refentrytitle>
29
   <manvolnum>8</manvolnum>
30 31 32 33 34 35 36 37
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname><application>dnssec-signzone</application></refname>
    <refpurpose>DNSSEC zone signing tool</refpurpose>
  </refnamediv>

38 39 40 41
  <docinfo>
    <copyright>
      <year>2004</year>
      <year>2005</year>
Mark Andrews's avatar
Mark Andrews committed
42
      <year>2006</year>
Mark Andrews's avatar
Mark Andrews committed
43
      <year>2007</year>
Automatic Updater's avatar
Automatic Updater committed
44
      <year>2008</year>
Automatic Updater's avatar
Automatic Updater committed
45
      <year>2009</year>
Automatic Updater's avatar
Automatic Updater committed
46
      <year>2011</year>
Tinderbox User's avatar
Tinderbox User committed
47
      <year>2012</year>
Tinderbox User's avatar
Tinderbox User committed
48
      <year>2013</year>
Tinderbox User's avatar
Tinderbox User committed
49
      <year>2014</year>
50 51 52 53 54 55 56
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
    <copyright>
      <year>2000</year>
      <year>2001</year>
      <year>2002</year>
      <year>2003</year>
Mark Andrews's avatar
Mark Andrews committed
57
      <holder>Internet Software Consortium.</holder>
58 59 60
    </copyright>
  </docinfo>

61
  <refsynopsisdiv>
Evan Hunt's avatar
Evan Hunt committed
62
    <cmdsynopsis sepchar=" ">
63
      <command>dnssec-signzone</command>
Evan Hunt's avatar
Evan Hunt committed
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
      <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>-M <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>-Q</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>
104 105 106
    </cmdsynopsis>
  </refsynopsisdiv>

Evan Hunt's avatar
Evan Hunt committed
107 108
  <refsection><info><title>DESCRIPTION</title></info>
    
109 110 111 112 113 114 115
    <para><command>dnssec-signzone</command>
      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
      <filename>keyset</filename> file for each child zone.
116
    </para>
Evan Hunt's avatar
Evan Hunt committed
117
  </refsection>
118

Evan Hunt's avatar
Evan Hunt committed
119 120
  <refsection><info><title>OPTIONS</title></info>
    
121 122 123 124

    <variablelist>
      <varlistentry>
        <term>-a</term>
125 126 127 128 129
        <listitem>
          <para>
            Verify all generated signatures.
          </para>
        </listitem>
130 131 132 133
      </varlistentry>

      <varlistentry>
        <term>-c <replaceable class="parameter">class</replaceable></term>
134 135 136 137 138
        <listitem>
          <para>
            Specifies the DNS class of the zone.
          </para>
        </listitem>
139 140
      </varlistentry>

141 142 143 144 145 146 147 148 149 150 151 152 153 154
      <varlistentry>
        <term>-C</term>
        <listitem>
          <para>
            Compatibility mode: Generate a
            <filename>keyset-<replaceable>zonename</replaceable></filename>
            file in addition to
            <filename>dsset-<replaceable>zonename</replaceable></filename>
            when signing a zone, for use by older versions of
            <command>dnssec-signzone</command>.
          </para>
        </listitem>
      </varlistentry>

155
      <varlistentry>
156
        <term>-d <replaceable class="parameter">directory</replaceable></term>
157 158
        <listitem>
          <para>
159 160
            Look for <filename>dsset-</filename> or
            <filename>keyset-</filename> files in <option>directory</option>.
161 162
          </para>
        </listitem>
163 164
      </varlistentry>

165 166 167 168 169 170 171 172 173 174
      <varlistentry>
        <term>-D</term>
        <listitem>
          <para>
	    Output only those record types automatically managed by
	    <command>dnssec-signzone</command>, i.e. RRSIG, NSEC,
	    NSEC3 and NSEC3PARAM records. If smart signing
	    (<option>-S</option>) is used, DNSKEY records are also
	    included. The resulting file can be included in the original
	    zone file with <command>$INCLUDE</command>. This option
175
	    cannot be combined with <option>-O raw</option>, 
Evan Hunt's avatar
Evan Hunt committed
176
            <option>-O map</option>, or serial number updating.
177 178 179 180
          </para>
        </listitem>
      </varlistentry>

Francis Dupont's avatar
Francis Dupont committed
181 182 183 184
      <varlistentry>
        <term>-E <replaceable class="parameter">engine</replaceable></term>
        <listitem>
          <para>
Evan Hunt's avatar
Evan Hunt committed
185 186 187 188 189 190 191 192 193 194 195
            When applicable, specifies the hardware to use for
            cryptographic operations, such as a secure key store used
            for signing.
          </para>
          <para>
            When BIND is built with OpenSSL PKCS#11 support, this defaults
            to the string "pkcs11", which identifies an OpenSSL engine
            that can drive a cryptographic accelerator or hardware service
            module.  When BIND is built with native PKCS#11 cryptography
            (--enable-native-pkcs11), it defaults to the path of the PKCS#11
            provider library specified via "--with-pkcs11".
Francis Dupont's avatar
Francis Dupont committed
196 197 198 199
          </para>
        </listitem>
      </varlistentry>

200
      <varlistentry>
201
        <term>-g</term>
202 203
        <listitem>
          <para>
204 205 206
            Generate DS records for child zones from
            <filename>dsset-</filename> or <filename>keyset-</filename>
            file.  Existing DS records will be removed.
207 208
          </para>
        </listitem>
209 210
      </varlistentry>

211
      <varlistentry>
212
        <term>-K <replaceable class="parameter">directory</replaceable></term>
213 214
        <listitem>
          <para>
215 216
            Key repository: Specify a directory to search for DNSSEC keys.
            If not specified, defaults to the current directory.
217 218
          </para>
        </listitem>
219 220
      </varlistentry>

221
      <varlistentry>
222
        <term>-k <replaceable class="parameter">key</replaceable></term>
223 224
        <listitem>
          <para>
225 226 227 228 229 230 231 232 233 234 235 236
            Treat specified key as a key signing key ignoring any
            key flags.  This option may be specified multiple times.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-l <replaceable class="parameter">domain</replaceable></term>
        <listitem>
          <para>
            Generate a DLV set in addition to the key (DNSKEY) and DS sets.
            The domain is appended to the name of the records.
237 238
          </para>
        </listitem>
239 240
      </varlistentry>

Evan Hunt's avatar
Evan Hunt committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
      <varlistentry>
        <term>-M <replaceable class="parameter">maxttl</replaceable></term>
        <listitem>
          <para>
            Sets the maximum TTL for the signed zone.
            Any TTL higher than <replaceable>maxttl</replaceable> in the
            input zone will be reduced to <replaceable>maxttl</replaceable>
            in the output. This provides certainty as to the largest
            possible TTL in the signed zone, which is useful to know when
            rolling keys because it is the longest possible time before
            signatures that have been retrieved by resolvers will expire
            from resolver caches.  Zones that are signed with this
            option should be configured to use a matching
            <option>max-zone-ttl</option> in <filename>named.conf</filename>.
            (Note: This option is incompatible with <option>-D</option>,
            because it modifies non-DNSSEC data in the output zone.)
          </para>
        </listitem>
      </varlistentry>

261 262
      <varlistentry>
        <term>-s <replaceable class="parameter">start-time</replaceable></term>
263 264 265 266 267 268 269 270 271 272 273 274
        <listitem>
          <para>
            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 <option>start-time</option> is specified, the current
            time minus 1 hour (to allow for clock skew) is used.
          </para>
        </listitem>
275 276 277 278
      </varlistentry>

      <varlistentry>
        <term>-e <replaceable class="parameter">end-time</replaceable></term>
279 280 281 282 283 284 285 286 287
        <listitem>
          <para>
            Specify the date and time when the generated RRSIG records
            expire.  As with <option>start-time</option>, 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 <option>end-time</option> is
            specified, 30 days from the start time is used as a default.
288 289
            <option>end-time</option> must be later than
            <option>start-time</option>.
290 291
          </para>
        </listitem>
292 293
      </varlistentry>

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
      <varlistentry>
        <term>-X <replaceable class="parameter">extended end-time</replaceable></term>
        <listitem>
          <para>
            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.
          </para>
          <para>
            As with <option>start-time</option>, 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 <option>extended end-time</option> is
            specified, the value of <option>end-time</option> is used as
            the default.  (<option>end-time</option>, in turn, defaults to
            30 days from the start time.) <option>extended end-time</option>
            must be later than <option>start-time</option>.
          </para>
        </listitem>
      </varlistentry>

319 320
      <varlistentry>
        <term>-f <replaceable class="parameter">output-file</replaceable></term>
321 322 323 324
        <listitem>
          <para>
            The name of the output file containing the signed zone.  The
            default is to append <filename>.signed</filename> to
325 326 327 328
            the input filename.  If <option>output-file</option> is
            set to <literal>"-"</literal>, then the signed zone is
            written to the standard output, with a default output
            format of "full".
329 330
          </para>
        </listitem>
331 332 333 334
      </varlistentry>

      <varlistentry>
        <term>-h</term>
335 336 337 338 339 340
        <listitem>
          <para>
            Prints a short summary of the options and arguments to
            <command>dnssec-signzone</command>.
          </para>
        </listitem>
341 342
      </varlistentry>

343 344 345 346 347 348 349 350 351
      <varlistentry>
	<term>-V</term>
        <listitem>
	  <para>
	    Prints version information.
	  </para>
        </listitem>
      </varlistentry>

352 353
      <varlistentry>
        <term>-i <replaceable class="parameter">interval</replaceable></term>
354 355
        <listitem>
          <para>
356
            When a previously-signed zone is passed as input, records
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
            may be resigned.  The <option>interval</option> 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.
          </para>
          <para>
            The default cycle interval is one quarter of the difference
            between the signature end and start times.  So if neither
            <option>end-time</option> or <option>start-time</option>
            are specified, <command>dnssec-signzone</command>
            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.
          </para>
        </listitem>
375 376
      </varlistentry>

377 378 379 380 381
      <varlistentry>
        <term>-I <replaceable class="parameter">input-format</replaceable></term>
        <listitem>
          <para>
            The format of the input zone file.
382
	    Possible formats are <command>"text"</command> (default),
Evan Hunt's avatar
Evan Hunt committed
383
	    <command>"raw"</command>, and <command>"map"</command>.
384 385 386 387 388 389 390 391 392
	    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.
          </para>
        </listitem>
      </varlistentry>

393
      <varlistentry>
394 395 396 397 398 399
        <term>-j <replaceable class="parameter">jitter</replaceable></term>
        <listitem>
          <para>
            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.
400 401
            a previously-signed zone is passed as input to the signer,
            all expired signatures have to be regenerated at about the
402 403 404 405 406 407 408 409 410 411 412 413 414
            same time.  The <option>jitter</option> option specifies a
            jitter window that will be used to randomize the signature
            expire time, thus spreading incremental signature
            regeneration over time.
          </para>
          <para>
            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.
          </para>
        </listitem>
415 416
      </varlistentry>

417 418 419 420
      <varlistentry>
        <term>-L <replaceable class="parameter">serial</replaceable></term>
        <listitem>
          <para>
Evan Hunt's avatar
Evan Hunt committed
421
            When writing a signed zone to "raw" or "map" format, set the
422 423 424
            "source serial" value in the header to the specified serial
            number.  (This is expected to be used primarily for testing
            purposes.)
425 426 427 428
          </para>
        </listitem>
      </varlistentry>

429 430
      <varlistentry>
        <term>-n <replaceable class="parameter">ncpus</replaceable></term>
431 432 433 434 435 436
        <listitem>
          <para>
            Specifies the number of threads to use.  By default, one
            thread is started for each detected CPU.
          </para>
        </listitem>
437 438
      </varlistentry>

439 440 441 442 443 444
      <varlistentry>
        <term>-N <replaceable class="parameter">soa-serial-format</replaceable></term>
        <listitem>
          <para>
            The SOA serial number format of the signed zone.
	    Possible formats are <command>"keep"</command> (default),
Evan Hunt's avatar
Evan Hunt committed
445 446
            <command>"increment"</command>, <command>"unixtime"</command>,
            and <command>"date"</command>.
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
          </para>

          <variablelist>
	    <varlistentry>
	      <term><command>"keep"</command></term>
              <listitem>
                <para>Do not modify the SOA serial number.</para>
	      </listitem>
            </varlistentry>

	    <varlistentry>
	      <term><command>"increment"</command></term>
              <listitem>
                <para>Increment the SOA serial number using RFC 1982
                      arithmetics.</para>
	      </listitem>
            </varlistentry>

	    <varlistentry>
	      <term><command>"unixtime"</command></term>
              <listitem>
                <para>Set the SOA serial number to the number of seconds
	        since epoch.</para>
	      </listitem>
            </varlistentry>
Evan Hunt's avatar
Evan Hunt committed
472 473 474 475 476 477 478 479

	    <varlistentry>
	      <term><command>"date"</command></term>
              <listitem>
                <para>Set the SOA serial number to today's date in
                YYYYMMDDNN format.</para>
	      </listitem>
            </varlistentry>
480 481 482 483 484
	 </variablelist>

        </listitem>
      </varlistentry>

485 486
      <varlistentry>
        <term>-o <replaceable class="parameter">origin</replaceable></term>
487 488 489 490 491 492
        <listitem>
          <para>
            The zone origin.  If not specified, the name of the zone file
            is assumed to be the origin.
          </para>
        </listitem>
493 494
      </varlistentry>

495 496 497 498 499
      <varlistentry>
        <term>-O <replaceable class="parameter">output-format</replaceable></term>
        <listitem>
          <para>
            The format of the output file containing the signed zone.
500 501
	    Possible formats are <command>"text"</command> (default),
            which is the standard textual representation of the zone;
502
	    <command>"full"</command>, which is text output in a
503
            format suitable for processing by external scripts;
Evan Hunt's avatar
Evan Hunt committed
504
            and <command>"map"</command>, <command>"raw"</command>,
505 506 507 508 509 510
            and <command>"raw=N"</command>, which store the zone in
            binary formats for rapid loading by <command>named</command>.
            <command>"raw=N"</command> specifies the format version of
            the raw zone file: if N is 0, the raw file can be read by
            any version of <command>named</command>; if N is 1, the file
            can be read by release 9.9.0 or higher; the default is 1.
511 512 513 514
          </para>
        </listitem>
      </varlistentry>

515 516
      <varlistentry>
        <term>-p</term>
517 518 519 520 521 522 523 524
        <listitem>
          <para>
            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.
          </para>
        </listitem>
525 526
      </varlistentry>

527 528 529 530 531 532 533 534
      <varlistentry>
        <term>-P</term>
        <listitem>
          <para>
	    Disable post sign verification tests.
          </para>
          <para>
	    The post sign verification test ensures that for each algorithm
535 536
	    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
537
	    in the zone are signed by the algorithm.
538
	    This option skips these tests.
539 540 541 542
          </para>
        </listitem>
      </varlistentry>

543
      <varlistentry>
Evan Hunt's avatar
Evan Hunt committed
544
        <term>-Q</term>
545 546
        <listitem>
          <para>
Evan Hunt's avatar
Evan Hunt committed
547
	    Remove signatures from keys that are no longer active.
548 549 550 551 552 553 554
          </para>
          <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 
            that are still within their validity period are retained.
	    This allows the zone to continue to validate with cached
Evan Hunt's avatar
Evan Hunt committed
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
	    copies of the old DNSKEY RRset.  The <option>-Q</option>
            forces <command>dnssec-signzone</command> 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").
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>-R</term>
        <listitem>
          <para>
	    Remove signatures from keys that are no longer published.
          </para>
          <para>
            This option is similar to <option>-Q</option>, except it
            forces <command>dnssec-signzone</command> 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").
575 576 577
          </para>
        </listitem>
      </varlistentry>
578 579
      <varlistentry>
        <term>-r <replaceable class="parameter">randomdev</replaceable></term>
580 581 582 583 584 585 586 587 588 589 590 591 592
        <listitem>
          <para>
            Specifies the source of randomness.  If the operating
            system does not provide a <filename>/dev/random</filename>
            or equivalent device, the default source of randomness
            is keyboard input.  <filename>randomdev</filename>
            specifies
            the name of a character device or file containing random
            data to be used instead of the default.  The special value
            <filename>keyboard</filename> indicates that keyboard
            input should be used.
          </para>
        </listitem>
593 594
      </varlistentry>

595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
      <varlistentry>
        <term>-S</term>
        <listitem>
          <para>
            Smart signing: Instructs <command>dnssec-signzone</command> to
            search the key repository for keys that match the zone being
            signed, and to include them in the zone if appropriate.
          </para>
          <para>
            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:
          </para>
          <variablelist>
	    <varlistentry>
              <listitem>
                <para>
                  If no timing metadata has been set for the key, the key is
                  published in the zone and used to sign the zone.
                </para>
	      </listitem>
            </varlistentry>

	    <varlistentry>
              <listitem>
                <para>
                  If the key's publication date is set and is in the past, the
                  key is published in the zone.
                </para>
	      </listitem>
            </varlistentry>

	    <varlistentry>
              <listitem>
                <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.  
                </para>
	      </listitem>
            </varlistentry>

	    <varlistentry>
              <listitem>
                <para>
                  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.
                </para>
	      </listitem>
            </varlistentry>

	    <varlistentry>
              <listitem>
                <para>
                  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.
                </para>
	      </listitem>
            </varlistentry>
	 </variablelist>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-T <replaceable class="parameter">ttl</replaceable></term>
        <listitem>
          <para>
665 666 667
            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
668 669 670 671 672
            record.  This option is ignored when signing without
            <option>-S</option>, 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
673 674 675
            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.
676 677 678 679
          </para>
        </listitem>
      </varlistentry>

680 681
      <varlistentry>
        <term>-t</term>
682 683 684 685 686
        <listitem>
          <para>
            Print statistics at completion.
          </para>
        </listitem>
687 688
      </varlistentry>

689 690 691 692 693 694 695 696 697 698 699 700 701 702
      <varlistentry>
        <term>-u</term>
        <listitem>
          <para>
            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, <command>dnssec-signzone</command> will
            retain the existing chain when re-signing.
          </para>
        </listitem>
      </varlistentry>

703 704
      <varlistentry>
        <term>-v <replaceable class="parameter">level</replaceable></term>
705 706 707 708 709
        <listitem>
          <para>
            Sets the debugging level.
          </para>
        </listitem>
710 711
      </varlistentry>

712 713 714 715 716
      <varlistentry>
        <term>-x</term>
        <listitem>
          <para>
            Only sign the DNSKEY RRset with key-signing keys, and omit
Evan Hunt's avatar
Evan Hunt committed
717
            signatures from zone-signing keys.  (This is similar to the
718
            <command>dnssec-dnskey-kskonly yes;</command> zone option in
Evan Hunt's avatar
Evan Hunt committed
719
            <command>named</command>.)
720 721 722 723
          </para>
        </listitem>
      </varlistentry>

724 725
      <varlistentry>
        <term>-z</term>
726 727
        <listitem>
          <para>
728 729
            Ignore KSK flag on key when determining what to sign.  This
            causes KSK-flagged keys to sign all records, not just the
Evan Hunt's avatar
Evan Hunt committed
730 731 732
            DNSKEY RRset.  (This is similar to the
            <command>update-check-ksk no;</command> zone option in
            <command>named</command>.)
733 734
          </para>
        </listitem>
735 736
      </varlistentry>

737 738 739 740
      <varlistentry>
        <term>-3 <replaceable class="parameter">salt</replaceable></term>
        <listitem>
          <para>
741
            Generate an NSEC3 chain with the given hex encoded salt.
742 743 744 745 746 747 748 749 750 751
	    A dash (<replaceable class="parameter">salt</replaceable>) can
	    be used to indicate that no salt is to be used when generating		    the NSEC3 chain.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-H <replaceable class="parameter">iterations</replaceable></term>
        <listitem>
          <para>
Mark Andrews's avatar
typos  
Mark Andrews committed
752
	    When generating an NSEC3 chain, use this many iterations.  The
753
	    default is 10.
754 755 756 757 758 759 760 761
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-A</term>
        <listitem>
          <para>
762
	    When generating an NSEC3 chain set the OPTOUT flag on all
763 764 765
	    NSEC3 records and do not generate NSEC3 records for insecure
	    delegations.
          </para>
766 767 768 769 770 771
          <para>
	    Using this option twice (i.e., <option>-AA</option>)
	    turns the OPTOUT flag off for all records.  This is useful
	    when using the <option>-u</option> option to modify an NSEC3
	    chain which previously had OPTOUT set.
          </para>
772 773 774
        </listitem>
      </varlistentry>

775 776
      <varlistentry>
        <term>zonefile</term>
777 778 779 780 781
        <listitem>
          <para>
            The file containing the zone to be signed.
          </para>
        </listitem>
782 783 784 785
      </varlistentry>

      <varlistentry>
        <term>key</term>
786 787
        <listitem>
          <para>
788 789 790 791 792
	    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.
793 794
          </para>
        </listitem>
795 796 797
      </varlistentry>

    </variablelist>
Evan Hunt's avatar
Evan Hunt committed
798
  </refsection>
799

Evan Hunt's avatar
Evan Hunt committed
800 801
  <refsection><info><title>EXAMPLE</title></info>
    
802
    <para>
803
      The following command signs the <userinput>example.com</userinput>
804
      zone with the DSA key generated by <command>dnssec-keygen</command>
805 806 807 808 809
      (Kexample.com.+003+17247).  Because the <command>-S</command> option
      is not being used, the zone's keys must be in the master file
      (<filename>db.example.com</filename>).  This invocation looks
      for <filename>dsset</filename> files, in the current directory,
      so that DS records can be imported from them (<command>-g</command>).
810
    </para>
811 812 813 814
<programlisting>% dnssec-signzone -g -o example.com db.example.com \
Kexample.com.+003+17247
db.example.com.signed
%</programlisting>
815
    <para>
816
      In the above example, <command>dnssec-signzone</command> creates
817
      the file <filename>db.example.com.signed</filename>.  This
818
      file should be referenced in a zone statement in a
819
      <filename>named.conf</filename> file.
820
    </para>
821 822 823 824 825 826 827 828
    <para>
      This example re-signs a previously signed zone with default parameters.
      The private keys are assumed to be in the current directory.
    </para>
<programlisting>% cp db.example.com.signed db.example.com
% dnssec-signzone -o example.com db.example.com
db.example.com.signed
%</programlisting>
Evan Hunt's avatar
Evan Hunt committed
829
  </refsection>
830

Evan Hunt's avatar
Evan Hunt committed
831 832
  <refsection><info><title>SEE ALSO</title></info>
    
833 834
    <para><citerefentry>
        <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
835 836
      </citerefentry>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
Evan Hunt's avatar
Evan Hunt committed
837
      <citetitle>RFC 4033</citetitle>, <citetitle>RFC 4641</citetitle>.
838
    </para>
Evan Hunt's avatar
Evan Hunt committed
839
  </refsection>
840

Evan Hunt's avatar
Evan Hunt committed
841
</refentry>