dnssec-signzone.docbook 28 KB
Newer Older
1 2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3
	       [<!ENTITY mdash "&#8212;">]>
Brian Wellington's avatar
Brian Wellington committed
4
<!--
Automatic Updater's avatar
Automatic Updater committed
5
 - Copyright (C) 2004-2009, 2011  Internet Systems Consortium, Inc. ("ISC")
6
 - Copyright (C) 2000-2003  Internet Software Consortium.
Brian Wellington's avatar
Brian Wellington committed
7
 -
Automatic Updater's avatar
Automatic Updater committed
8
 - Permission to use, copy, modify, and/or distribute this software for any
Brian Wellington's avatar
Brian Wellington committed
9 10 11
 - 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
12 13 14 15 16 17 18
 - 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
19
-->
Mark Andrews's avatar
Mark Andrews committed
20

21
<!-- $Id: dnssec-signzone.docbook,v 1.50 2011/11/07 23:16:31 each Exp $ -->
22
<refentry id="man.dnssec-signzone">
23
  <refentryinfo>
24
    <date>June 05, 2009</date>
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>
47 48 49 50 51 52 53
      <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
54
      <holder>Internet Software Consortium.</holder>
55 56 57
    </copyright>
  </docinfo>

58 59 60 61 62 63
  <refsynopsisdiv>
    <cmdsynopsis>
      <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>
64
      <arg><option>-D</option></arg>
Francis Dupont's avatar
Francis Dupont committed
65
      <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
66 67
      <arg><option>-e <replaceable class="parameter">end-time</replaceable></option></arg>
      <arg><option>-f <replaceable class="parameter">output-file</replaceable></option></arg>
68
      <arg><option>-g</option></arg>
69
      <arg><option>-h</option></arg>
70
      <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
71
      <arg><option>-k <replaceable class="parameter">key</replaceable></option></arg>
72
      <arg><option>-l <replaceable class="parameter">domain</replaceable></option></arg>
73
      <arg><option>-i <replaceable class="parameter">interval</replaceable></option></arg>
74
      <arg><option>-I <replaceable class="parameter">input-format</replaceable></option></arg>
75
      <arg><option>-j <replaceable class="parameter">jitter</replaceable></option></arg>
76
      <arg><option>-N <replaceable class="parameter">soa-serial-format</replaceable></option></arg>
77
      <arg><option>-o <replaceable class="parameter">origin</replaceable></option></arg>
78
      <arg><option>-O <replaceable class="parameter">output-format</replaceable></option></arg>
79
      <arg><option>-P</option></arg>
80 81
      <arg><option>-p</option></arg>
      <arg><option>-R</option></arg>
82
      <arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>
83
      <arg><option>-S</option></arg>
84
      <arg><option>-s <replaceable class="parameter">start-time</replaceable></option></arg>
85
      <arg><option>-T <replaceable class="parameter">ttl</replaceable></option></arg>
86
      <arg><option>-t</option></arg>
87
      <arg><option>-u</option></arg>
88
      <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
89
      <arg><option>-X <replaceable class="parameter">extended end-time</replaceable></option></arg>
90
      <arg><option>-x</option></arg>
91
      <arg><option>-z</option></arg>
92 93 94
      <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>
95 96 97 98 99 100 101
      <arg choice="req">zonefile</arg>
      <arg rep="repeat">key</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
102 103 104 105 106 107 108
    <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.
109 110 111 112 113 114 115 116 117
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term>-a</term>
118 119 120 121 122
        <listitem>
          <para>
            Verify all generated signatures.
          </para>
        </listitem>
123 124 125 126
      </varlistentry>

      <varlistentry>
        <term>-c <replaceable class="parameter">class</replaceable></term>
127 128 129 130 131
        <listitem>
          <para>
            Specifies the DNS class of the zone.
          </para>
        </listitem>
132 133
      </varlistentry>

134 135 136 137 138 139 140 141 142 143 144 145 146 147
      <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>

148
      <varlistentry>
149
        <term>-d <replaceable class="parameter">directory</replaceable></term>
150 151
        <listitem>
          <para>
152 153
            Look for <filename>dsset-</filename> or
            <filename>keyset-</filename> files in <option>directory</option>.
154 155
          </para>
        </listitem>
156 157
      </varlistentry>

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
      <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
	    cannot be combined with <option>-O raw</option> or serial
	    number updating.
          </para>
        </listitem>
      </varlistentry>

Francis Dupont's avatar
Francis Dupont committed
174 175 176 177 178 179 180
      <varlistentry>
        <term>-E <replaceable class="parameter">engine</replaceable></term>
        <listitem>
          <para>
            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
Evan Hunt's avatar
Evan Hunt committed
181
            it defaults to pkcs11; the empty name resets it to no engine.
Francis Dupont's avatar
Francis Dupont committed
182 183 184 185
          </para>
        </listitem>
      </varlistentry>

186
      <varlistentry>
187
        <term>-g</term>
188 189
        <listitem>
          <para>
190 191 192
            Generate DS records for child zones from
            <filename>dsset-</filename> or <filename>keyset-</filename>
            file.  Existing DS records will be removed.
193 194
          </para>
        </listitem>
195 196
      </varlistentry>

197
      <varlistentry>
198
        <term>-K <replaceable class="parameter">directory</replaceable></term>
199 200
        <listitem>
          <para>
201 202
            Key repository: Specify a directory to search for DNSSEC keys.
            If not specified, defaults to the current directory.
203 204
          </para>
        </listitem>
205 206
      </varlistentry>

207
      <varlistentry>
208
        <term>-k <replaceable class="parameter">key</replaceable></term>
209 210
        <listitem>
          <para>
211 212 213 214 215 216 217 218 219 220 221 222
            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.
223 224
          </para>
        </listitem>
225 226
      </varlistentry>

227 228
      <varlistentry>
        <term>-s <replaceable class="parameter">start-time</replaceable></term>
229 230 231 232 233 234 235 236 237 238 239 240
        <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>
241 242 243 244
      </varlistentry>

      <varlistentry>
        <term>-e <replaceable class="parameter">end-time</replaceable></term>
245 246 247 248 249 250 251 252 253
        <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.
254 255
            <option>end-time</option> must be later than
            <option>start-time</option>.
256 257
          </para>
        </listitem>
258 259
      </varlistentry>

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
      <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>

285 286
      <varlistentry>
        <term>-f <replaceable class="parameter">output-file</replaceable></term>
287 288 289 290
        <listitem>
          <para>
            The name of the output file containing the signed zone.  The
            default is to append <filename>.signed</filename> to
291 292 293 294
            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".
295 296
          </para>
        </listitem>
297 298 299 300
      </varlistentry>

      <varlistentry>
        <term>-h</term>
301 302 303 304 305 306
        <listitem>
          <para>
            Prints a short summary of the options and arguments to
            <command>dnssec-signzone</command>.
          </para>
        </listitem>
307 308 309 310
      </varlistentry>

      <varlistentry>
        <term>-i <replaceable class="parameter">interval</replaceable></term>
311 312
        <listitem>
          <para>
313
            When a previously-signed zone is passed as input, records
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
            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>
332 333
      </varlistentry>

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
      <varlistentry>
        <term>-I <replaceable class="parameter">input-format</replaceable></term>
        <listitem>
          <para>
            The format of the input zone file.
	    Possible formats are <command>"text"</command> (default)
	    and <command>"raw"</command>.
	    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>

350
      <varlistentry>
351 352 353 354 355 356
        <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.
357 358
            a previously-signed zone is passed as input to the signer,
            all expired signatures have to be regenerated at about the
359 360 361 362 363 364 365 366 367 368 369 370 371
            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>
372 373
      </varlistentry>

374 375
      <varlistentry>
        <term>-n <replaceable class="parameter">ncpus</replaceable></term>
376 377 378 379 380 381
        <listitem>
          <para>
            Specifies the number of threads to use.  By default, one
            thread is started for each detected CPU.
          </para>
        </listitem>
382 383
      </varlistentry>

384 385 386 387 388 389
      <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),
Mark Andrews's avatar
Mark Andrews committed
390
            <command>"increment"</command> and
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
	    <command>"unixtime"</command>.
          </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>
	 </variablelist>

        </listitem>
      </varlistentry>

422 423
      <varlistentry>
        <term>-o <replaceable class="parameter">origin</replaceable></term>
424 425 426 427 428 429
        <listitem>
          <para>
            The zone origin.  If not specified, the name of the zone file
            is assumed to be the origin.
          </para>
        </listitem>
430 431
      </varlistentry>

432 433 434 435 436 437
      <varlistentry>
        <term>-O <replaceable class="parameter">output-format</replaceable></term>
        <listitem>
          <para>
            The format of the output file containing the signed zone.
	    Possible formats are <command>"text"</command> (default)
438 439 440
	    <command>"raw"</command>, and <command>"full"</command>,
            which is text output in a format suitable for processing
            by external scripts.
441 442 443 444
          </para>
        </listitem>
      </varlistentry>

445 446
      <varlistentry>
        <term>-p</term>
447 448 449 450 451 452 453 454
        <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>
455 456
      </varlistentry>

457 458 459 460 461 462 463 464
      <varlistentry>
        <term>-P</term>
        <listitem>
          <para>
	    Disable post sign verification tests.
          </para>
          <para>
	    The post sign verification test ensures that for each algorithm
465 466
	    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
467
	    in the zone are signed by the algorithm.
468
	    This option skips these tests.
469 470 471 472
          </para>
        </listitem>
      </varlistentry>

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
      <varlistentry>
        <term>-R</term>
        <listitem>
          <para>
	    Remove signatures from keys that no longer exist.
          </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
	    copies of the old DNSKEY RRset.  The <option>-R</option> forces
            <command>dnssec-signzone</command> to remove all orphaned
            signatures.
          </para>
        </listitem>
      </varlistentry>
491 492
      <varlistentry>
        <term>-r <replaceable class="parameter">randomdev</replaceable></term>
493 494 495 496 497 498 499 500 501 502 503 504 505
        <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>
506 507
      </varlistentry>

508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
      <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>
578 579 580
            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
581 582 583 584 585
            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
586 587 588
            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.
589 590 591 592
          </para>
        </listitem>
      </varlistentry>

593 594
      <varlistentry>
        <term>-t</term>
595 596 597 598 599
        <listitem>
          <para>
            Print statistics at completion.
          </para>
        </listitem>
600 601
      </varlistentry>

602 603 604 605 606 607 608 609 610 611 612 613 614 615
      <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>

616 617
      <varlistentry>
        <term>-v <replaceable class="parameter">level</replaceable></term>
618 619 620 621 622
        <listitem>
          <para>
            Sets the debugging level.
          </para>
        </listitem>
623 624
      </varlistentry>

625 626 627 628 629
      <varlistentry>
        <term>-x</term>
        <listitem>
          <para>
            Only sign the DNSKEY RRset with key-signing keys, and omit
Evan Hunt's avatar
Evan Hunt committed
630
            signatures from zone-signing keys.  (This is similar to the
631
            <command>dnssec-dnskey-kskonly yes;</command> zone option in
Evan Hunt's avatar
Evan Hunt committed
632
            <command>named</command>.)
633 634 635 636
          </para>
        </listitem>
      </varlistentry>

637 638
      <varlistentry>
        <term>-z</term>
639 640
        <listitem>
          <para>
641 642
            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
643 644 645
            DNSKEY RRset.  (This is similar to the
            <command>update-check-ksk no;</command> zone option in
            <command>named</command>.)
646 647
          </para>
        </listitem>
648 649
      </varlistentry>

650 651 652 653
      <varlistentry>
        <term>-3 <replaceable class="parameter">salt</replaceable></term>
        <listitem>
          <para>
654
            Generate an NSEC3 chain with the given hex encoded salt.
655 656 657 658 659 660 661 662 663 664
	    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>
665 666
	    When generating an NSEC3 chain, use this many interations.  The
	    default is 10.
667 668 669 670 671 672 673 674
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-A</term>
        <listitem>
          <para>
675
	    When generating an NSEC3 chain set the OPTOUT flag on all
676 677 678
	    NSEC3 records and do not generate NSEC3 records for insecure
	    delegations.
          </para>
679 680 681 682 683 684
          <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>
685 686 687
        </listitem>
      </varlistentry>

688 689
      <varlistentry>
        <term>zonefile</term>
690 691 692 693 694
        <listitem>
          <para>
            The file containing the zone to be signed.
          </para>
        </listitem>
695 696 697 698
      </varlistentry>

      <varlistentry>
        <term>key</term>
699 700
        <listitem>
          <para>
701 702 703 704 705
	    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.
706 707
          </para>
        </listitem>
708 709 710 711 712 713 714 715
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>EXAMPLE</title>
    <para>
716
      The following command signs the <userinput>example.com</userinput>
717
      zone with the DSA key generated by <command>dnssec-keygen</command>
718 719 720 721 722
      (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>).
723
    </para>
724 725 726 727
<programlisting>% dnssec-signzone -g -o example.com db.example.com \
Kexample.com.+003+17247
db.example.com.signed
%</programlisting>
728
    <para>
729
      In the above example, <command>dnssec-signzone</command> creates
730
      the file <filename>db.example.com.signed</filename>.  This
731
      file should be referenced in a zone statement in a
732
      <filename>named.conf</filename> file.
733
    </para>
734 735 736 737 738 739 740 741
    <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>
742 743 744 745
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
746 747
    <para><citerefentry>
        <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
748 749
      </citerefentry>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
750
      <citetitle>RFC 4033</citetitle>.
751 752 753 754 755
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
756
    <para><corpauthor>Internet Systems Consortium</corpauthor>
757 758 759
    </para>
  </refsect1>

760
</refentry><!--
761 762 763 764
 - Local variables:
 - mode: sgml
 - End:
-->