2 - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
3 - Copyright (C) 2000-2003 Internet Software Consortium.
5 - Permission to use, copy, modify, and/or distribute this software for any
6 - purpose with or without fee is hereby granted, provided that the above
7 - copyright notice and this permission notice appear in all copies.
9 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 - PERFORMANCE OF THIS SOFTWARE.
20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
21 <title>dnssec-signzone</title>
22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
23 <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
24 <link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
25 <link rel="prev" href="man.dnssec-settime.html" title="dnssec-settime">
26 <link rel="next" href="man.dnssec-verify.html" title="dnssec-verify">
28 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
29 <div class="navheader">
30 <table width="100%" summary="Navigation header">
31 <tr><th colspan="3" align="center"><span class="application">dnssec-signzone</span></th></tr>
33 <td width="20%" align="left">
34 <a accesskey="p" href="man.dnssec-settime.html">Prev</a> </td>
35 <th width="60%" align="center">Manual pages</th>
36 <td width="20%" align="right"> <a accesskey="n" href="man.dnssec-verify.html">Next</a>
42 <div class="refentry" lang="en">
43 <a name="man.dnssec-signzone"></a><div class="titlepage"></div>
44 <div class="refnamediv">
46 <p><span class="application">dnssec-signzone</span> — DNSSEC zone signing tool</p>
48 <div class="refsynopsisdiv">
50 <div class="cmdsynopsis"><p><code class="command">dnssec-signzone</code> [<code class="option">-a</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-d <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-D</code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-e <em class="replaceable"><code>end-time</code></em></code>] [<code class="option">-f <em class="replaceable"><code>output-file</code></em></code>] [<code class="option">-g</code>] [<code class="option">-h</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-k <em class="replaceable"><code>key</code></em></code>] [<code class="option">-L <em class="replaceable"><code>serial</code></em></code>] [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-I <em class="replaceable"><code>input-format</code></em></code>] [<code class="option">-j <em class="replaceable"><code>jitter</code></em></code>] [<code class="option">-N <em class="replaceable"><code>soa-serial-format</code></em></code>] [<code class="option">-o <em class="replaceable"><code>origin</code></em></code>] [<code class="option">-O <em class="replaceable"><code>output-format</code></em></code>] [<code class="option">-P</code>] [<code class="option">-p</code>] [<code class="option">-R</code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-S</code>] [<code class="option">-s <em class="replaceable"><code>start-time</code></em></code>] [<code class="option">-T <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-t</code>] [<code class="option">-u</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-X <em class="replaceable"><code>extended end-time</code></em></code>] [<code class="option">-x</code>] [<code class="option">-z</code>] [<code class="option">-3 <em class="replaceable"><code>salt</code></em></code>] [<code class="option">-H <em class="replaceable"><code>iterations</code></em></code>] [<code class="option">-A</code>] {zonefile} [key...]</p></div>
52 <div class="refsect1" lang="en">
53 <a name="id2623744"></a><h2>DESCRIPTION</h2>
54 <p><span><strong class="command">dnssec-signzone</strong></span>
55 signs a zone. It generates
56 NSEC and RRSIG records and produces a signed version of the
57 zone. The security status of delegations from the signed zone
58 (that is, whether the child zones are secure or not) is
59 determined by the presence or absence of a
60 <code class="filename">keyset</code> file for each child zone.
63 <div class="refsect1" lang="en">
64 <a name="id2631682"></a><h2>OPTIONS</h2>
65 <div class="variablelist"><dl>
66 <dt><span class="term">-a</span></dt>
68 Verify all generated signatures.
70 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
72 Specifies the DNS class of the zone.
74 <dt><span class="term">-C</span></dt>
76 Compatibility mode: Generate a
77 <code class="filename">keyset-<em class="replaceable"><code>zonename</code></em></code>
79 <code class="filename">dsset-<em class="replaceable"><code>zonename</code></em></code>
80 when signing a zone, for use by older versions of
81 <span><strong class="command">dnssec-signzone</strong></span>.
83 <dt><span class="term">-d <em class="replaceable"><code>directory</code></em></span></dt>
85 Look for <code class="filename">dsset-</code> or
86 <code class="filename">keyset-</code> files in <code class="option">directory</code>.
88 <dt><span class="term">-D</span></dt>
90 Output only those record types automatically managed by
91 <span><strong class="command">dnssec-signzone</strong></span>, i.e. RRSIG, NSEC,
92 NSEC3 and NSEC3PARAM records. If smart signing
93 (<code class="option">-S</code>) is used, DNSKEY records are also
94 included. The resulting file can be included in the original
95 zone file with <span><strong class="command">$INCLUDE</strong></span>. This option
96 cannot be combined with <code class="option">-O raw</code> or serial
99 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
101 Uses a crypto hardware (OpenSSL engine) for the crypto operations
102 it supports, for instance signing with private keys from
103 a secure key store. When compiled with PKCS#11 support
104 it defaults to pkcs11; the empty name resets it to no engine.
106 <dt><span class="term">-g</span></dt>
108 Generate DS records for child zones from
109 <code class="filename">dsset-</code> or <code class="filename">keyset-</code>
110 file. Existing DS records will be removed.
112 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
114 Key repository: Specify a directory to search for DNSSEC keys.
115 If not specified, defaults to the current directory.
117 <dt><span class="term">-k <em class="replaceable"><code>key</code></em></span></dt>
119 Treat specified key as a key signing key ignoring any
120 key flags. This option may be specified multiple times.
122 <dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
124 Generate a DLV set in addition to the key (DNSKEY) and DS sets.
125 The domain is appended to the name of the records.
127 <dt><span class="term">-s <em class="replaceable"><code>start-time</code></em></span></dt>
129 Specify the date and time when the generated RRSIG records
130 become valid. This can be either an absolute or relative
131 time. An absolute start time is indicated by a number
132 in YYYYMMDDHHMMSS notation; 20000530144500 denotes
133 14:45:00 UTC on May 30th, 2000. A relative start time is
134 indicated by +N, which is N seconds from the current time.
135 If no <code class="option">start-time</code> is specified, the current
136 time minus 1 hour (to allow for clock skew) is used.
138 <dt><span class="term">-e <em class="replaceable"><code>end-time</code></em></span></dt>
140 Specify the date and time when the generated RRSIG records
141 expire. As with <code class="option">start-time</code>, an absolute
142 time is indicated in YYYYMMDDHHMMSS notation. A time relative
143 to the start time is indicated with +N, which is N seconds from
144 the start time. A time relative to the current time is
145 indicated with now+N. If no <code class="option">end-time</code> is
146 specified, 30 days from the start time is used as a default.
147 <code class="option">end-time</code> must be later than
148 <code class="option">start-time</code>.
150 <dt><span class="term">-X <em class="replaceable"><code>extended end-time</code></em></span></dt>
153 Specify the date and time when the generated RRSIG records
154 for the DNSKEY RRset will expire. This is to be used in cases
155 when the DNSKEY signatures need to persist longer than
156 signatures on other records; e.g., when the private component
157 of the KSK is kept offline and the KSK signature is to be
161 As with <code class="option">start-time</code>, an absolute
162 time is indicated in YYYYMMDDHHMMSS notation. A time relative
163 to the start time is indicated with +N, which is N seconds from
164 the start time. A time relative to the current time is
165 indicated with now+N. If no <code class="option">extended end-time</code> is
166 specified, the value of <code class="option">end-time</code> is used as
167 the default. (<code class="option">end-time</code>, in turn, defaults to
168 30 days from the start time.) <code class="option">extended end-time</code>
169 must be later than <code class="option">start-time</code>.
172 <dt><span class="term">-f <em class="replaceable"><code>output-file</code></em></span></dt>
174 The name of the output file containing the signed zone. The
175 default is to append <code class="filename">.signed</code> to
176 the input filename. If <code class="option">output-file</code> is
177 set to <code class="literal">"-"</code>, then the signed zone is
178 written to the standard output, with a default output
181 <dt><span class="term">-h</span></dt>
183 Prints a short summary of the options and arguments to
184 <span><strong class="command">dnssec-signzone</strong></span>.
186 <dt><span class="term">-V</span></dt>
188 Prints version information.
190 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
193 When a previously-signed zone is passed as input, records
194 may be resigned. The <code class="option">interval</code> option
195 specifies the cycle interval as an offset from the current
196 time (in seconds). If a RRSIG record expires after the
197 cycle interval, it is retained. Otherwise, it is considered
198 to be expiring soon, and it will be replaced.
201 The default cycle interval is one quarter of the difference
202 between the signature end and start times. So if neither
203 <code class="option">end-time</code> or <code class="option">start-time</code>
204 are specified, <span><strong class="command">dnssec-signzone</strong></span>
206 signatures that are valid for 30 days, with a cycle
207 interval of 7.5 days. Therefore, if any existing RRSIG records
208 are due to expire in less than 7.5 days, they would be
212 <dt><span class="term">-I <em class="replaceable"><code>input-format</code></em></span></dt>
214 The format of the input zone file.
215 Possible formats are <span><strong class="command">"text"</strong></span> (default)
216 and <span><strong class="command">"raw"</strong></span>.
217 This option is primarily intended to be used for dynamic
218 signed zones so that the dumped zone file in a non-text
219 format containing updates can be signed directly.
220 The use of this option does not make much sense for
223 <dt><span class="term">-j <em class="replaceable"><code>jitter</code></em></span></dt>
226 When signing a zone with a fixed signature lifetime, all
227 RRSIG records issued at the time of signing expires
228 simultaneously. If the zone is incrementally signed, i.e.
229 a previously-signed zone is passed as input to the signer,
230 all expired signatures have to be regenerated at about the
231 same time. The <code class="option">jitter</code> option specifies a
232 jitter window that will be used to randomize the signature
233 expire time, thus spreading incremental signature
234 regeneration over time.
237 Signature lifetime jitter also to some extent benefits
238 validators and servers by spreading out cache expiration,
239 i.e. if large numbers of RRSIGs don't expire at the same time
240 from all caches there will be less congestion than if all
241 validators need to refetch at mostly the same time.
244 <dt><span class="term">-L <em class="replaceable"><code>serial</code></em></span></dt>
246 When writing a signed zone to 'raw' format, set the "source serial"
247 value in the header to the specified serial number. (This is
248 expected to be used primarily for testing purposes.)
250 <dt><span class="term">-n <em class="replaceable"><code>ncpus</code></em></span></dt>
252 Specifies the number of threads to use. By default, one
253 thread is started for each detected CPU.
255 <dt><span class="term">-N <em class="replaceable"><code>soa-serial-format</code></em></span></dt>
258 The SOA serial number format of the signed zone.
259 Possible formats are <span><strong class="command">"keep"</strong></span> (default),
260 <span><strong class="command">"increment"</strong></span> and
261 <span><strong class="command">"unixtime"</strong></span>.
263 <div class="variablelist"><dl>
264 <dt><span class="term"><span><strong class="command">"keep"</strong></span></span></dt>
265 <dd><p>Do not modify the SOA serial number.</p></dd>
266 <dt><span class="term"><span><strong class="command">"increment"</strong></span></span></dt>
267 <dd><p>Increment the SOA serial number using RFC 1982
268 arithmetics.</p></dd>
269 <dt><span class="term"><span><strong class="command">"unixtime"</strong></span></span></dt>
270 <dd><p>Set the SOA serial number to the number of seconds
271 since epoch.</p></dd>
274 <dt><span class="term">-o <em class="replaceable"><code>origin</code></em></span></dt>
276 The zone origin. If not specified, the name of the zone file
277 is assumed to be the origin.
279 <dt><span class="term">-O <em class="replaceable"><code>output-format</code></em></span></dt>
281 The format of the output file containing the signed zone.
282 Possible formats are <span><strong class="command">"text"</strong></span> (default)
283 <span><strong class="command">"full"</strong></span>, which is text output in a
284 format suitable for processing by external scripts,
285 and <span><strong class="command">"raw"</strong></span> or <span><strong class="command">"raw=N"</strong></span>,
286 which store the zone in a binary format for rapid loading
287 by <span><strong class="command">named</strong></span>. <span><strong class="command">"raw=N"</strong></span>
288 specifies the format version of the raw zone file: if N
289 is 0, the raw file can be read by any version of
290 <span><strong class="command">named</strong></span>; if N is 1, the file can be
291 read by release 9.9.0 or higher. The default is 1.
293 <dt><span class="term">-p</span></dt>
295 Use pseudo-random data when signing the zone. This is faster,
296 but less secure, than using real random data. This option
297 may be useful when signing large zones or when the entropy
300 <dt><span class="term">-P</span></dt>
303 Disable post sign verification tests.
306 The post sign verification test ensures that for each algorithm
307 in use there is at least one non revoked self signed KSK key,
308 that all revoked KSK keys are self signed, and that all records
309 in the zone are signed by the algorithm.
310 This option skips these tests.
313 <dt><span class="term">-Q</span></dt>
316 Remove signatures from keys that are no longer active.
319 Normally, when a previously-signed zone is passed as input
320 to the signer, and a DNSKEY record has been removed and
321 replaced with a new one, signatures from the old key
322 that are still within their validity period are retained.
323 This allows the zone to continue to validate with cached
324 copies of the old DNSKEY RRset. The <code class="option">-Q</code>
325 forces <span><strong class="command">dnssec-signzone</strong></span> to remove
326 signatures from keys that are no longer active. This
327 enables ZSK rollover using the procedure described in
328 RFC 4641, section 4.2.1.1 ("Pre-Publish Key Rollover").
331 <dt><span class="term">-R</span></dt>
334 Remove signatures from keys that are no longer published.
337 This option is similar to <code class="option">-Q</code>, except it
338 forces <span><strong class="command">dnssec-signzone</strong></span> to signatures from
339 keys that are no longer published. This enables ZSK rollover
340 using the procedure described in RFC 4641, section 4.2.1.2
341 ("Double Signature Zone Signing Key Rollover").
344 <dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
346 Specifies the source of randomness. If the operating
347 system does not provide a <code class="filename">/dev/random</code>
348 or equivalent device, the default source of randomness
349 is keyboard input. <code class="filename">randomdev</code>
351 the name of a character device or file containing random
352 data to be used instead of the default. The special value
353 <code class="filename">keyboard</code> indicates that keyboard
354 input should be used.
356 <dt><span class="term">-S</span></dt>
359 Smart signing: Instructs <span><strong class="command">dnssec-signzone</strong></span> to
360 search the key repository for keys that match the zone being
361 signed, and to include them in the zone if appropriate.
364 When a key is found, its timing metadata is examined to
365 determine how it should be used, according to the following
366 rules. Each successive rule takes priority over the prior
369 <div class="variablelist"><dl>
372 If no timing metadata has been set for the key, the key is
373 published in the zone and used to sign the zone.
377 If the key's publication date is set and is in the past, the
378 key is published in the zone.
382 If the key's activation date is set and in the past, the
383 key is published (regardless of publication date) and
384 used to sign the zone.
388 If the key's revocation date is set and in the past, and the
389 key is published, then the key is revoked, and the revoked key
390 is used to sign the zone.
394 If either of the key's unpublication or deletion dates are set
395 and in the past, the key is NOT published or used to sign the
396 zone, regardless of any other metadata.
400 <dt><span class="term">-T <em class="replaceable"><code>ttl</code></em></span></dt>
402 Specifies a TTL to be used for new DNSKEY records imported
403 into the zone from the key repository. If not
404 specified, the default is the TTL value from the zone's SOA
405 record. This option is ignored when signing without
406 <code class="option">-S</code>, since DNSKEY records are not imported
407 from the key repository in that case. It is also ignored if
408 there are any pre-existing DNSKEY records at the zone apex,
409 in which case new records' TTL values will be set to match
410 them, or if any of the imported DNSKEY records had a default
411 TTL value. In the event of a a conflict between TTL values in
412 imported keys, the shortest one is used.
414 <dt><span class="term">-t</span></dt>
416 Print statistics at completion.
418 <dt><span class="term">-u</span></dt>
420 Update NSEC/NSEC3 chain when re-signing a previously signed
421 zone. With this option, a zone signed with NSEC can be
422 switched to NSEC3, or a zone signed with NSEC3 can
423 be switch to NSEC or to NSEC3 with different parameters.
424 Without this option, <span><strong class="command">dnssec-signzone</strong></span> will
425 retain the existing chain when re-signing.
427 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
429 Sets the debugging level.
431 <dt><span class="term">-x</span></dt>
433 Only sign the DNSKEY RRset with key-signing keys, and omit
434 signatures from zone-signing keys. (This is similar to the
435 <span><strong class="command">dnssec-dnskey-kskonly yes;</strong></span> zone option in
436 <span><strong class="command">named</strong></span>.)
438 <dt><span class="term">-z</span></dt>
440 Ignore KSK flag on key when determining what to sign. This
441 causes KSK-flagged keys to sign all records, not just the
442 DNSKEY RRset. (This is similar to the
443 <span><strong class="command">update-check-ksk no;</strong></span> zone option in
444 <span><strong class="command">named</strong></span>.)
446 <dt><span class="term">-3 <em class="replaceable"><code>salt</code></em></span></dt>
448 Generate an NSEC3 chain with the given hex encoded salt.
449 A dash (<em class="replaceable"><code>salt</code></em>) can
450 be used to indicate that no salt is to be used when generating the NSEC3 chain.
452 <dt><span class="term">-H <em class="replaceable"><code>iterations</code></em></span></dt>
454 When generating an NSEC3 chain, use this many iterations. The
457 <dt><span class="term">-A</span></dt>
460 When generating an NSEC3 chain set the OPTOUT flag on all
461 NSEC3 records and do not generate NSEC3 records for insecure
465 Using this option twice (i.e., <code class="option">-AA</code>)
466 turns the OPTOUT flag off for all records. This is useful
467 when using the <code class="option">-u</code> option to modify an NSEC3
468 chain which previously had OPTOUT set.
471 <dt><span class="term">zonefile</span></dt>
473 The file containing the zone to be signed.
475 <dt><span class="term">key</span></dt>
477 Specify which keys should be used to sign the zone. If
478 no keys are specified, then the zone will be examined
479 for DNSKEY records at the zone apex. If these are found and
480 there are matching private keys, in the current directory,
481 then these will be used for signing.
485 <div class="refsect1" lang="en">
486 <a name="id2677729"></a><h2>EXAMPLE</h2>
488 The following command signs the <strong class="userinput"><code>example.com</code></strong>
489 zone with the DSA key generated by <span><strong class="command">dnssec-keygen</strong></span>
490 (Kexample.com.+003+17247). Because the <span><strong class="command">-S</strong></span> option
491 is not being used, the zone's keys must be in the master file
492 (<code class="filename">db.example.com</code>). This invocation looks
493 for <code class="filename">dsset</code> files, in the current directory,
494 so that DS records can be imported from them (<span><strong class="command">-g</strong></span>).
496 <pre class="programlisting">% dnssec-signzone -g -o example.com db.example.com \
497 Kexample.com.+003+17247
498 db.example.com.signed
501 In the above example, <span><strong class="command">dnssec-signzone</strong></span> creates
502 the file <code class="filename">db.example.com.signed</code>. This
503 file should be referenced in a zone statement in a
504 <code class="filename">named.conf</code> file.
507 This example re-signs a previously signed zone with default parameters.
508 The private keys are assumed to be in the current directory.
510 <pre class="programlisting">% cp db.example.com.signed db.example.com
511 % dnssec-signzone -o example.com db.example.com
512 db.example.com.signed
515 <div class="refsect1" lang="en">
516 <a name="id2677808"></a><h2>SEE ALSO</h2>
517 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
518 <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
519 <em class="citetitle">RFC 4033</em>, <em class="citetitle">RFC 4641</em>.
522 <div class="refsect1" lang="en">
523 <a name="id2677835"></a><h2>AUTHOR</h2>
524 <p><span class="corpauthor">Internet Systems Consortium</span>
528 <div class="navfooter">
530 <table width="100%" summary="Navigation footer">
532 <td width="40%" align="left">
533 <a accesskey="p" href="man.dnssec-settime.html">Prev</a> </td>
534 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
535 <td width="40%" align="right"> <a accesskey="n" href="man.dnssec-verify.html">Next</a>
539 <td width="40%" align="left" valign="top">
540 <span class="application">dnssec-settime</span> </td>
541 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
542 <td width="40%" align="right" valign="top"> <span class="application">dnssec-verify</span>
547 <p style="text-align: center;">BIND 9.9.8-P2 (Extended Support Version)</p>