2 - Copyright (C) 2004-2009, 2011, 2013 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">
24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
25 <a name="man.dnssec-signzone"></a><div class="titlepage"></div>
26 <div class="refnamediv">
28 <p><span class="application">dnssec-signzone</span> — DNSSEC zone signing tool</p>
30 <div class="refsynopsisdiv">
32 <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">-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>
34 <div class="refsect1" lang="en">
35 <a name="id2543629"></a><h2>DESCRIPTION</h2>
36 <p><span><strong class="command">dnssec-signzone</strong></span>
37 signs a zone. It generates
38 NSEC and RRSIG records and produces a signed version of the
39 zone. The security status of delegations from the signed zone
40 (that is, whether the child zones are secure or not) is
41 determined by the presence or absence of a
42 <code class="filename">keyset</code> file for each child zone.
45 <div class="refsect1" lang="en">
46 <a name="id2543644"></a><h2>OPTIONS</h2>
47 <div class="variablelist"><dl>
48 <dt><span class="term">-a</span></dt>
50 Verify all generated signatures.
52 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
54 Specifies the DNS class of the zone.
56 <dt><span class="term">-C</span></dt>
58 Compatibility mode: Generate a
59 <code class="filename">keyset-<em class="replaceable"><code>zonename</code></em></code>
61 <code class="filename">dsset-<em class="replaceable"><code>zonename</code></em></code>
62 when signing a zone, for use by older versions of
63 <span><strong class="command">dnssec-signzone</strong></span>.
65 <dt><span class="term">-d <em class="replaceable"><code>directory</code></em></span></dt>
67 Look for <code class="filename">dsset-</code> or
68 <code class="filename">keyset-</code> files in <code class="option">directory</code>.
70 <dt><span class="term">-D</span></dt>
72 Output only those record types automatically managed by
73 <span><strong class="command">dnssec-signzone</strong></span>, i.e. RRSIG, NSEC,
74 NSEC3 and NSEC3PARAM records. If smart signing
75 (<code class="option">-S</code>) is used, DNSKEY records are also
76 included. The resulting file can be included in the original
77 zone file with <span><strong class="command">$INCLUDE</strong></span>. This option
78 cannot be combined with <code class="option">-O raw</code> or serial
81 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
83 Uses a crypto hardware (OpenSSL engine) for the crypto operations
84 it supports, for instance signing with private keys from
85 a secure key store. When compiled with PKCS#11 support
86 it defaults to pkcs11; the empty name resets it to no engine.
88 <dt><span class="term">-g</span></dt>
90 Generate DS records for child zones from
91 <code class="filename">dsset-</code> or <code class="filename">keyset-</code>
92 file. Existing DS records will be removed.
94 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
96 Key repository: Specify a directory to search for DNSSEC keys.
97 If not specified, defaults to the current directory.
99 <dt><span class="term">-k <em class="replaceable"><code>key</code></em></span></dt>
101 Treat specified key as a key signing key ignoring any
102 key flags. This option may be specified multiple times.
104 <dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
106 Generate a DLV set in addition to the key (DNSKEY) and DS sets.
107 The domain is appended to the name of the records.
109 <dt><span class="term">-s <em class="replaceable"><code>start-time</code></em></span></dt>
111 Specify the date and time when the generated RRSIG records
112 become valid. This can be either an absolute or relative
113 time. An absolute start time is indicated by a number
114 in YYYYMMDDHHMMSS notation; 20000530144500 denotes
115 14:45:00 UTC on May 30th, 2000. A relative start time is
116 indicated by +N, which is N seconds from the current time.
117 If no <code class="option">start-time</code> is specified, the current
118 time minus 1 hour (to allow for clock skew) is used.
120 <dt><span class="term">-e <em class="replaceable"><code>end-time</code></em></span></dt>
122 Specify the date and time when the generated RRSIG records
123 expire. As with <code class="option">start-time</code>, an absolute
124 time is indicated in YYYYMMDDHHMMSS notation. A time relative
125 to the start time is indicated with +N, which is N seconds from
126 the start time. A time relative to the current time is
127 indicated with now+N. If no <code class="option">end-time</code> is
128 specified, 30 days from the start time is used as a default.
129 <code class="option">end-time</code> must be later than
130 <code class="option">start-time</code>.
132 <dt><span class="term">-X <em class="replaceable"><code>extended end-time</code></em></span></dt>
135 Specify the date and time when the generated RRSIG records
136 for the DNSKEY RRset will expire. This is to be used in cases
137 when the DNSKEY signatures need to persist longer than
138 signatures on other records; e.g., when the private component
139 of the KSK is kept offline and the KSK signature is to be
143 As with <code class="option">start-time</code>, an absolute
144 time is indicated in YYYYMMDDHHMMSS notation. A time relative
145 to the start time is indicated with +N, which is N seconds from
146 the start time. A time relative to the current time is
147 indicated with now+N. If no <code class="option">extended end-time</code> is
148 specified, the value of <code class="option">end-time</code> is used as
149 the default. (<code class="option">end-time</code>, in turn, defaults to
150 30 days from the start time.) <code class="option">extended end-time</code>
151 must be later than <code class="option">start-time</code>.
154 <dt><span class="term">-f <em class="replaceable"><code>output-file</code></em></span></dt>
156 The name of the output file containing the signed zone. The
157 default is to append <code class="filename">.signed</code> to
158 the input filename. If <code class="option">output-file</code> is
159 set to <code class="literal">"-"</code>, then the signed zone is
160 written to the standard output, with a default output
163 <dt><span class="term">-h</span></dt>
165 Prints a short summary of the options and arguments to
166 <span><strong class="command">dnssec-signzone</strong></span>.
168 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
171 When a previously-signed zone is passed as input, records
172 may be resigned. The <code class="option">interval</code> option
173 specifies the cycle interval as an offset from the current
174 time (in seconds). If a RRSIG record expires after the
175 cycle interval, it is retained. Otherwise, it is considered
176 to be expiring soon, and it will be replaced.
179 The default cycle interval is one quarter of the difference
180 between the signature end and start times. So if neither
181 <code class="option">end-time</code> or <code class="option">start-time</code>
182 are specified, <span><strong class="command">dnssec-signzone</strong></span>
184 signatures that are valid for 30 days, with a cycle
185 interval of 7.5 days. Therefore, if any existing RRSIG records
186 are due to expire in less than 7.5 days, they would be
190 <dt><span class="term">-I <em class="replaceable"><code>input-format</code></em></span></dt>
192 The format of the input zone file.
193 Possible formats are <span><strong class="command">"text"</strong></span> (default)
194 and <span><strong class="command">"raw"</strong></span>.
195 This option is primarily intended to be used for dynamic
196 signed zones so that the dumped zone file in a non-text
197 format containing updates can be signed directly.
198 The use of this option does not make much sense for
201 <dt><span class="term">-j <em class="replaceable"><code>jitter</code></em></span></dt>
204 When signing a zone with a fixed signature lifetime, all
205 RRSIG records issued at the time of signing expires
206 simultaneously. If the zone is incrementally signed, i.e.
207 a previously-signed zone is passed as input to the signer,
208 all expired signatures have to be regenerated at about the
209 same time. The <code class="option">jitter</code> option specifies a
210 jitter window that will be used to randomize the signature
211 expire time, thus spreading incremental signature
212 regeneration over time.
215 Signature lifetime jitter also to some extent benefits
216 validators and servers by spreading out cache expiration,
217 i.e. if large numbers of RRSIGs don't expire at the same time
218 from all caches there will be less congestion than if all
219 validators need to refetch at mostly the same time.
222 <dt><span class="term">-L <em class="replaceable"><code>serial</code></em></span></dt>
224 When writing a signed zone to 'raw' format, set the "source serial"
225 value in the header to the specified serial number. (This is
226 expected to be used primarily for testing purposes.)
228 <dt><span class="term">-n <em class="replaceable"><code>ncpus</code></em></span></dt>
230 Specifies the number of threads to use. By default, one
231 thread is started for each detected CPU.
233 <dt><span class="term">-N <em class="replaceable"><code>soa-serial-format</code></em></span></dt>
236 The SOA serial number format of the signed zone.
237 Possible formats are <span><strong class="command">"keep"</strong></span> (default),
238 <span><strong class="command">"increment"</strong></span> and
239 <span><strong class="command">"unixtime"</strong></span>.
241 <div class="variablelist"><dl>
242 <dt><span class="term"><span><strong class="command">"keep"</strong></span></span></dt>
243 <dd><p>Do not modify the SOA serial number.</p></dd>
244 <dt><span class="term"><span><strong class="command">"increment"</strong></span></span></dt>
245 <dd><p>Increment the SOA serial number using RFC 1982
246 arithmetics.</p></dd>
247 <dt><span class="term"><span><strong class="command">"unixtime"</strong></span></span></dt>
248 <dd><p>Set the SOA serial number to the number of seconds
249 since epoch.</p></dd>
252 <dt><span class="term">-o <em class="replaceable"><code>origin</code></em></span></dt>
254 The zone origin. If not specified, the name of the zone file
255 is assumed to be the origin.
257 <dt><span class="term">-O <em class="replaceable"><code>output-format</code></em></span></dt>
259 The format of the output file containing the signed zone.
260 Possible formats are <span><strong class="command">"text"</strong></span> (default)
261 <span><strong class="command">"full"</strong></span>, which is text output in a
262 format suitable for processing by external scripts,
263 and <span><strong class="command">"raw"</strong></span> or <span><strong class="command">"raw=N"</strong></span>,
264 which store the zone in a binary format for rapid loading
265 by <span><strong class="command">named</strong></span>. <span><strong class="command">"raw=N"</strong></span>
266 specifies the format version of the raw zone file: if N
267 is 0, the raw file can be read by any version of
268 <span><strong class="command">named</strong></span>; if N is 1, the file can be
269 read by release 9.9.0 or higher. The default is 1.
271 <dt><span class="term">-p</span></dt>
273 Use pseudo-random data when signing the zone. This is faster,
274 but less secure, than using real random data. This option
275 may be useful when signing large zones or when the entropy
278 <dt><span class="term">-P</span></dt>
281 Disable post sign verification tests.
284 The post sign verification test ensures that for each algorithm
285 in use there is at least one non revoked self signed KSK key,
286 that all revoked KSK keys are self signed, and that all records
287 in the zone are signed by the algorithm.
288 This option skips these tests.
291 <dt><span class="term">-Q</span></dt>
294 Remove signatures from keys that are no longer active.
297 Normally, when a previously-signed zone is passed as input
298 to the signer, and a DNSKEY record has been removed and
299 replaced with a new one, signatures from the old key
300 that are still within their validity period are retained.
301 This allows the zone to continue to validate with cached
302 copies of the old DNSKEY RRset. The <code class="option">-Q</code>
303 forces <span><strong class="command">dnssec-signzone</strong></span> to remove
304 signatures from keys that are no longer active. This
305 enables ZSK rollover using the procedure described in
306 RFC 4641, section 4.2.1.1 ("Pre-Publish Key Rollover").
309 <dt><span class="term">-R</span></dt>
312 Remove signatures from keys that are no longer published.
315 This option is similar to <code class="option">-Q</code>, except it
316 forces <span><strong class="command">dnssec-signzone</strong></span> to signatures from
317 keys that are no longer published. This enables ZSK rollover
318 using the procedure described in RFC 4641, section 4.2.1.2
319 ("Double Signature Zone Signing Key Rollover").
322 <dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
324 Specifies the source of randomness. If the operating
325 system does not provide a <code class="filename">/dev/random</code>
326 or equivalent device, the default source of randomness
327 is keyboard input. <code class="filename">randomdev</code>
329 the name of a character device or file containing random
330 data to be used instead of the default. The special value
331 <code class="filename">keyboard</code> indicates that keyboard
332 input should be used.
334 <dt><span class="term">-S</span></dt>
337 Smart signing: Instructs <span><strong class="command">dnssec-signzone</strong></span> to
338 search the key repository for keys that match the zone being
339 signed, and to include them in the zone if appropriate.
342 When a key is found, its timing metadata is examined to
343 determine how it should be used, according to the following
344 rules. Each successive rule takes priority over the prior
347 <div class="variablelist"><dl>
350 If no timing metadata has been set for the key, the key is
351 published in the zone and used to sign the zone.
355 If the key's publication date is set and is in the past, the
356 key is published in the zone.
360 If the key's activation date is set and in the past, the
361 key is published (regardless of publication date) and
362 used to sign the zone.
366 If the key's revocation date is set and in the past, and the
367 key is published, then the key is revoked, and the revoked key
368 is used to sign the zone.
372 If either of the key's unpublication or deletion dates are set
373 and in the past, the key is NOT published or used to sign the
374 zone, regardless of any other metadata.
378 <dt><span class="term">-T <em class="replaceable"><code>ttl</code></em></span></dt>
380 Specifies a TTL to be used for new DNSKEY records imported
381 into the zone from the key repository. If not
382 specified, the default is the TTL value from the zone's SOA
383 record. This option is ignored when signing without
384 <code class="option">-S</code>, since DNSKEY records are not imported
385 from the key repository in that case. It is also ignored if
386 there are any pre-existing DNSKEY records at the zone apex,
387 in which case new records' TTL values will be set to match
388 them, or if any of the imported DNSKEY records had a default
389 TTL value. In the event of a a conflict between TTL values in
390 imported keys, the shortest one is used.
392 <dt><span class="term">-t</span></dt>
394 Print statistics at completion.
396 <dt><span class="term">-u</span></dt>
398 Update NSEC/NSEC3 chain when re-signing a previously signed
399 zone. With this option, a zone signed with NSEC can be
400 switched to NSEC3, or a zone signed with NSEC3 can
401 be switch to NSEC or to NSEC3 with different parameters.
402 Without this option, <span><strong class="command">dnssec-signzone</strong></span> will
403 retain the existing chain when re-signing.
405 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
407 Sets the debugging level.
409 <dt><span class="term">-x</span></dt>
411 Only sign the DNSKEY RRset with key-signing keys, and omit
412 signatures from zone-signing keys. (This is similar to the
413 <span><strong class="command">dnssec-dnskey-kskonly yes;</strong></span> zone option in
414 <span><strong class="command">named</strong></span>.)
416 <dt><span class="term">-z</span></dt>
418 Ignore KSK flag on key when determining what to sign. This
419 causes KSK-flagged keys to sign all records, not just the
420 DNSKEY RRset. (This is similar to the
421 <span><strong class="command">update-check-ksk no;</strong></span> zone option in
422 <span><strong class="command">named</strong></span>.)
424 <dt><span class="term">-3 <em class="replaceable"><code>salt</code></em></span></dt>
426 Generate an NSEC3 chain with the given hex encoded salt.
427 A dash (<em class="replaceable"><code>salt</code></em>) can
428 be used to indicate that no salt is to be used when generating the NSEC3 chain.
430 <dt><span class="term">-H <em class="replaceable"><code>iterations</code></em></span></dt>
432 When generating an NSEC3 chain, use this many iterations. The
435 <dt><span class="term">-A</span></dt>
438 When generating an NSEC3 chain set the OPTOUT flag on all
439 NSEC3 records and do not generate NSEC3 records for insecure
443 Using this option twice (i.e., <code class="option">-AA</code>)
444 turns the OPTOUT flag off for all records. This is useful
445 when using the <code class="option">-u</code> option to modify an NSEC3
446 chain which previously had OPTOUT set.
449 <dt><span class="term">zonefile</span></dt>
451 The file containing the zone to be signed.
453 <dt><span class="term">key</span></dt>
455 Specify which keys should be used to sign the zone. If
456 no keys are specified, then the zone will be examined
457 for DNSKEY records at the zone apex. If these are found and
458 there are matching private keys, in the current directory,
459 then these will be used for signing.
463 <div class="refsect1" lang="en">
464 <a name="id2545153"></a><h2>EXAMPLE</h2>
466 The following command signs the <strong class="userinput"><code>example.com</code></strong>
467 zone with the DSA key generated by <span><strong class="command">dnssec-keygen</strong></span>
468 (Kexample.com.+003+17247). Because the <span><strong class="command">-S</strong></span> option
469 is not being used, the zone's keys must be in the master file
470 (<code class="filename">db.example.com</code>). This invocation looks
471 for <code class="filename">dsset</code> files, in the current directory,
472 so that DS records can be imported from them (<span><strong class="command">-g</strong></span>).
474 <pre class="programlisting">% dnssec-signzone -g -o example.com db.example.com \
475 Kexample.com.+003+17247
476 db.example.com.signed
479 In the above example, <span><strong class="command">dnssec-signzone</strong></span> creates
480 the file <code class="filename">db.example.com.signed</code>. This
481 file should be referenced in a zone statement in a
482 <code class="filename">named.conf</code> file.
485 This example re-signs a previously signed zone with default parameters.
486 The private keys are assumed to be in the current directory.
488 <pre class="programlisting">% cp db.example.com.signed db.example.com
489 % dnssec-signzone -o example.com db.example.com
490 db.example.com.signed
493 <div class="refsect1" lang="en">
494 <a name="id2545208"></a><h2>SEE ALSO</h2>
495 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
496 <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
497 <em class="citetitle">RFC 4033</em>, <em class="citetitle">RFC 4641</em>.
500 <div class="refsect1" lang="en">
501 <a name="id2545236"></a><h2>AUTHOR</h2>
502 <p><span class="corpauthor">Internet Systems Consortium</span>