dnssec-signzone.docbook 32.8 KB
Newer Older
Brian Wellington's avatar
Brian Wellington committed
1
<!--
2
 - Copyright (C) 2000-2009, 2011-2017  Internet Systems Consortium, Inc. ("ISC")
Brian Wellington's avatar
Brian Wellington committed
3
 -
4 5 6
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
Brian Wellington's avatar
Brian Wellington committed
7
-->
Tinderbox User's avatar
Tinderbox User committed
8

Evan Hunt's avatar
Evan Hunt committed
9
<!-- Converted by db4-upgrade version 1.0 -->
10
<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-signzone">
Evan Hunt's avatar
Evan Hunt committed
11 12 13
  <info>
    <date>2014-02-18</date>
  </info>
14
  <refentryinfo>
Evan Hunt's avatar
Evan Hunt committed
15 16
    <corpname>ISC</corpname>
    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
17 18 19 20
  </refentryinfo>

  <refmeta>
    <refentrytitle><application>dnssec-signzone</application></refentrytitle>
21
   <manvolnum>8</manvolnum>
22 23 24 25 26 27 28 29
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

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

30 31
  <docinfo>
    <copyright>
Mark Andrews's avatar
Mark Andrews committed
32 33 34 35
      <year>2000</year>
      <year>2001</year>
      <year>2002</year>
      <year>2003</year>
36 37
      <year>2004</year>
      <year>2005</year>
Mark Andrews's avatar
Mark Andrews committed
38
      <year>2006</year>
Mark Andrews's avatar
Mark Andrews committed
39
      <year>2007</year>
Automatic Updater's avatar
Automatic Updater committed
40
      <year>2008</year>
Automatic Updater's avatar
Automatic Updater committed
41
      <year>2009</year>
Automatic Updater's avatar
Automatic Updater committed
42
      <year>2011</year>
Tinderbox User's avatar
Tinderbox User committed
43
      <year>2012</year>
Tinderbox User's avatar
Tinderbox User committed
44
      <year>2013</year>
Tinderbox User's avatar
Tinderbox User committed
45
      <year>2014</year>
46
      <year>2015</year>
47
      <year>2016</year>
48
      <year>2017</year>
49 50 51 52
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

53
  <refsynopsisdiv>
Evan Hunt's avatar
Evan Hunt committed
54
    <cmdsynopsis sepchar=" ">
55
      <command>dnssec-signzone</command>
Evan Hunt's avatar
Evan Hunt committed
56 57 58 59 60 61 62 63 64
      <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>
Evan Hunt's avatar
Evan Hunt committed
65 66 67
      <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>
Evan Hunt's avatar
Evan Hunt committed
68 69 70 71
      <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>
Evan Hunt's avatar
Evan Hunt committed
72
      <arg choice="opt" rep="norepeat"><option>-M <replaceable class="parameter">maxttl</replaceable></option></arg>
Evan Hunt's avatar
Evan Hunt committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
      <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>
96 97 98
    </cmdsynopsis>
  </refsynopsisdiv>

Evan Hunt's avatar
Evan Hunt committed
99
  <refsection><info><title>DESCRIPTION</title></info>
100

101 102 103 104 105 106 107
    <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.
108
    </para>
Evan Hunt's avatar
Evan Hunt committed
109
  </refsection>
110

Evan Hunt's avatar
Evan Hunt committed
111
  <refsection><info><title>OPTIONS</title></info>
112

113 114 115 116

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

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

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

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

157 158 159 160 161 162 163 164 165 166
      <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
167
	    cannot be combined with <option>-O raw</option>,
Evan Hunt's avatar
Evan Hunt committed
168
            <option>-O map</option>, or serial number updating.
169 170 171 172
          </para>
        </listitem>
      </varlistentry>

Francis Dupont's avatar
Francis Dupont committed
173 174 175 176
      <varlistentry>
        <term>-E <replaceable class="parameter">engine</replaceable></term>
        <listitem>
          <para>
Evan Hunt's avatar
Evan Hunt committed
177 178 179 180 181 182 183 184 185 186 187
            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
188 189 190 191
          </para>
        </listitem>
      </varlistentry>

192
      <varlistentry>
193
        <term>-g</term>
194 195
        <listitem>
          <para>
196 197 198
            Generate DS records for child zones from
            <filename>dsset-</filename> or <filename>keyset-</filename>
            file.  Existing DS records will be removed.
199 200
          </para>
        </listitem>
201 202
      </varlistentry>

203
      <varlistentry>
204
        <term>-K <replaceable class="parameter">directory</replaceable></term>
205 206
        <listitem>
          <para>
207 208
            Key repository: Specify a directory to search for DNSSEC keys.
            If not specified, defaults to the current directory.
209 210
          </para>
        </listitem>
211 212
      </varlistentry>

213
      <varlistentry>
214
        <term>-k <replaceable class="parameter">key</replaceable></term>
215 216
        <listitem>
          <para>
217 218 219 220 221 222 223 224 225 226 227 228
            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.
229 230
          </para>
        </listitem>
231 232
      </varlistentry>

Evan Hunt's avatar
Evan Hunt committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
      <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>

253 254
      <varlistentry>
        <term>-s <replaceable class="parameter">start-time</replaceable></term>
255 256 257 258 259 260 261 262 263 264 265 266
        <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>
267 268 269 270
      </varlistentry>

      <varlistentry>
        <term>-e <replaceable class="parameter">end-time</replaceable></term>
271 272 273 274 275 276 277 278 279
        <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.
280 281
            <option>end-time</option> must be later than
            <option>start-time</option>.
282 283
          </para>
        </listitem>
284 285
      </varlistentry>

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
      <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>

311 312
      <varlistentry>
        <term>-f <replaceable class="parameter">output-file</replaceable></term>
313 314 315 316
        <listitem>
          <para>
            The name of the output file containing the signed zone.  The
            default is to append <filename>.signed</filename> to
317 318 319 320
            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".
321 322
          </para>
        </listitem>
323 324 325 326
      </varlistentry>

      <varlistentry>
        <term>-h</term>
327 328 329 330 331 332
        <listitem>
          <para>
            Prints a short summary of the options and arguments to
            <command>dnssec-signzone</command>.
          </para>
        </listitem>
333 334
      </varlistentry>

335 336 337 338 339 340 341 342 343
      <varlistentry>
	<term>-V</term>
        <listitem>
	  <para>
	    Prints version information.
	  </para>
        </listitem>
      </varlistentry>

344 345
      <varlistentry>
        <term>-i <replaceable class="parameter">interval</replaceable></term>
346 347
        <listitem>
          <para>
348
            When a previously-signed zone is passed as input, records
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
            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>
367 368
      </varlistentry>

369 370 371 372 373
      <varlistentry>
        <term>-I <replaceable class="parameter">input-format</replaceable></term>
        <listitem>
          <para>
            The format of the input zone file.
374
	    Possible formats are <command>"text"</command> (default),
Evan Hunt's avatar
Evan Hunt committed
375
	    <command>"raw"</command>, and <command>"map"</command>.
376 377 378 379 380 381 382 383 384
	    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>

385
      <varlistentry>
386 387 388 389 390 391
        <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.
392 393
            a previously-signed zone is passed as input to the signer,
            all expired signatures have to be regenerated at about the
394 395 396 397 398 399 400 401 402 403 404 405 406
            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>
407 408
      </varlistentry>

409 410 411 412
      <varlistentry>
        <term>-L <replaceable class="parameter">serial</replaceable></term>
        <listitem>
          <para>
Evan Hunt's avatar
Evan Hunt committed
413
            When writing a signed zone to "raw" or "map" format, set the
414 415 416
            "source serial" value in the header to the specified serial
            number.  (This is expected to be used primarily for testing
            purposes.)
417 418 419 420
          </para>
        </listitem>
      </varlistentry>

421 422
      <varlistentry>
        <term>-n <replaceable class="parameter">ncpus</replaceable></term>
423 424 425 426 427 428
        <listitem>
          <para>
            Specifies the number of threads to use.  By default, one
            thread is started for each detected CPU.
          </para>
        </listitem>
429 430
      </varlistentry>

431 432 433 434 435 436
      <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
437 438
            <command>"increment"</command>, <command>"unixtime"</command>,
            and <command>"date"</command>.
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
          </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
464 465 466 467 468 469 470 471

	    <varlistentry>
	      <term><command>"date"</command></term>
              <listitem>
                <para>Set the SOA serial number to today's date in
                YYYYMMDDNN format.</para>
	      </listitem>
            </varlistentry>
472 473 474 475 476
	 </variablelist>

        </listitem>
      </varlistentry>

477 478
      <varlistentry>
        <term>-o <replaceable class="parameter">origin</replaceable></term>
479 480 481 482 483 484
        <listitem>
          <para>
            The zone origin.  If not specified, the name of the zone file
            is assumed to be the origin.
          </para>
        </listitem>
485 486
      </varlistentry>

487 488 489 490 491
      <varlistentry>
        <term>-O <replaceable class="parameter">output-format</replaceable></term>
        <listitem>
          <para>
            The format of the output file containing the signed zone.
492 493
	    Possible formats are <command>"text"</command> (default),
            which is the standard textual representation of the zone;
494
	    <command>"full"</command>, which is text output in a
495
            format suitable for processing by external scripts;
Evan Hunt's avatar
Evan Hunt committed
496
            and <command>"map"</command>, <command>"raw"</command>,
497 498 499 500 501 502
            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.
503 504 505 506
          </para>
        </listitem>
      </varlistentry>

507 508
      <varlistentry>
        <term>-p</term>
509 510 511 512 513 514 515 516
        <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>
517 518
      </varlistentry>

519 520 521 522 523 524 525 526
      <varlistentry>
        <term>-P</term>
        <listitem>
          <para>
	    Disable post sign verification tests.
          </para>
          <para>
	    The post sign verification test ensures that for each algorithm
527 528
	    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
529
	    in the zone are signed by the algorithm.
530
	    This option skips these tests.
531 532 533 534
          </para>
        </listitem>
      </varlistentry>

535
      <varlistentry>
Evan Hunt's avatar
Evan Hunt committed
536
        <term>-Q</term>
537 538
        <listitem>
          <para>
Evan Hunt's avatar
Evan Hunt committed
539
	    Remove signatures from keys that are no longer active.
540 541 542 543
          </para>
          <para>
            Normally, when a previously-signed zone is passed as input
            to the signer, and a DNSKEY record has been removed and
544
            replaced with a new one, signatures from the old key
545 546
            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
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
	    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").
567 568 569
          </para>
        </listitem>
      </varlistentry>
570 571
      <varlistentry>
        <term>-r <replaceable class="parameter">randomdev</replaceable></term>
572 573 574 575 576 577 578 579 580 581 582 583 584
        <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>
585 586
      </varlistentry>

587 588 589 590 591 592 593 594 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
      <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
625
                  used to sign the zone.
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
                </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>
Evan Hunt's avatar
Evan Hunt committed
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668

	    <varlistentry>
              <listitem>
                <para>
                  If key's sync publication date is set and in the past,
		  synchronization records (type CDS and/or CDNSKEY) are
		  created.
                </para>
	      </listitem>
            </varlistentry>

	    <varlistentry>
              <listitem>
                <para>
                  If key's sync deletion date is set and in the past,
		  synchronization records (type CDS and/or CDNSKEY) are
		  removed.
                </para>
	      </listitem>
            </varlistentry>
669 670 671 672 673 674 675 676
	 </variablelist>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-T <replaceable class="parameter">ttl</replaceable></term>
        <listitem>
          <para>
677 678 679
            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
680 681 682 683 684
            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
685 686 687
            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.
688 689 690 691
          </para>
        </listitem>
      </varlistentry>

692 693
      <varlistentry>
        <term>-t</term>
694 695 696 697 698
        <listitem>
          <para>
            Print statistics at completion.
          </para>
        </listitem>
699 700
      </varlistentry>

701 702 703 704 705 706 707 708 709 710 711 712 713 714
      <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>

715 716
      <varlistentry>
        <term>-v <replaceable class="parameter">level</replaceable></term>
717 718 719 720 721
        <listitem>
          <para>
            Sets the debugging level.
          </para>
        </listitem>
722 723
      </varlistentry>

724 725 726 727
      <varlistentry>
        <term>-x</term>
        <listitem>
          <para>
728 729 730
            Only sign the DNSKEY, CDNSKEY, and CDS RRsets with
            key-signing keys, and omit signatures from zone-signing
            keys. (This is similar to the
731
            <command>dnssec-dnskey-kskonly yes;</command> zone option in
Evan Hunt's avatar
Evan Hunt committed
732
            <command>named</command>.)
733 734 735 736
          </para>
        </listitem>
      </varlistentry>

737 738
      <varlistentry>
        <term>-z</term>
739 740
        <listitem>
          <para>
741 742
            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
743 744 745
            DNSKEY RRset.  (This is similar to the
            <command>update-check-ksk no;</command> zone option in
            <command>named</command>.)
746 747
          </para>
        </listitem>
748 749
      </varlistentry>

750 751 752 753
      <varlistentry>
        <term>-3 <replaceable class="parameter">salt</replaceable></term>
        <listitem>
          <para>
754
            Generate an NSEC3 chain with the given hex encoded salt.
755 756 757 758 759 760 761 762 763 764
	    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
765
	    When generating an NSEC3 chain, use this many iterations.  The
766
	    default is 10.
767 768 769 770 771 772 773 774
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-A</term>
        <listitem>
          <para>
775
	    When generating an NSEC3 chain set the OPTOUT flag on all
776 777 778
	    NSEC3 records and do not generate NSEC3 records for insecure
	    delegations.
          </para>
779 780 781 782 783 784
          <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>
785 786 787
        </listitem>
      </varlistentry>

788 789
      <varlistentry>
        <term>zonefile</term>
790 791 792 793 794
        <listitem>
          <para>
            The file containing the zone to be signed.
          </para>
        </listitem>
795 796 797 798
      </varlistentry>

      <varlistentry>
        <term>key</term>
799 800
        <listitem>
          <para>
801 802 803 804 805
	    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.
806 807
          </para>
        </listitem>
808 809 810
      </varlistentry>

    </variablelist>
Evan Hunt's avatar
Evan Hunt committed
811
  </refsection>
812

Evan Hunt's avatar
Evan Hunt committed
813
  <refsection><info><title>EXAMPLE</title></info>
814

815
    <para>
816
      The following command signs the <userinput>example.com</userinput>
817
      zone with the DSA key generated by <command>dnssec-keygen</command>
818 819 820 821 822
      (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>).
823
    </para>
824 825 826 827
<programlisting>% dnssec-signzone -g -o example.com db.example.com \
Kexample.com.+003+17247
db.example.com.signed
%</programlisting>
828
    <para>
829
      In the above example, <command>dnssec-signzone</command> creates
830
      the file <filename>db.example.com.signed</filename>.  This
831
      file should be referenced in a zone statement in a
832
      <filename>named.conf</filename> file.
833
    </para>
834 835 836 837 838 839 840 841
    <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
842
  </refsection>
843

Evan Hunt's avatar
Evan Hunt committed
844
  <refsection><info><title>SEE ALSO</title></info>
845

846 847
    <para><citerefentry>
        <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
848 849
      </citerefentry>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
Evan Hunt's avatar
Evan Hunt committed
850
      <citetitle>RFC 4033</citetitle>, <citetitle>RFC 4641</citetitle>.
851
    </para>
Evan Hunt's avatar
Evan Hunt committed
852
  </refsection>
853

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