dnssec-signzone.html revision ea94d370123a5892f6c47a97f21d1b28d44bb168
7d32c065c7bb56f281651ae3dd2888f32ce4f1d9Bob Halley - Copyright (C) 2004-2009, 2011 Internet Systems Consortium, Inc. ("ISC")
2f072c2982861ec2e86e97f8a3ed199fe45c1f70Michael Graff - Copyright (C) 2000-2003 Internet Software Consortium.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews - Permission to use, copy, modify, and/or distribute this software for any
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews - purpose with or without fee is hereby granted, provided that the above
2f072c2982861ec2e86e97f8a3ed199fe45c1f70Michael Graff - copyright notice and this permission notice appear in all copies.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<!-- $Id$ -->
5d3cca55ebb009e337c1093bf67cef0d52ec97eeMichael Graff<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
e1cc8e9a0828f3239009bc8c6b0adf61ca1e2ef6Michael Graff<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
854d0238dbc2908490197984b3b9d558008a53dfMark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
854d0238dbc2908490197984b3b9d558008a53dfMark Andrews<a name="man.dnssec-signzone"></a><div class="titlepage"></div>
6324997211a5e2d82528dcde98e8981190a35faeMichael Graff<p><span class="application">dnssec-signzone</span> — DNSSEC zone signing tool</p>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<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>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<p><span><strong class="command">dnssec-signzone</strong></span>
e1cc8e9a0828f3239009bc8c6b0adf61ca1e2ef6Michael Graff signs a zone. It generates
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews NSEC and RRSIG records and produces a signed version of the
34b394b43e2207e8f8f3703f0402422121455638David Lawrence zone. The security status of delegations from the signed zone
34b394b43e2207e8f8f3703f0402422121455638David Lawrence (that is, whether the child zones are secure or not) is
34b394b43e2207e8f8f3703f0402422121455638David Lawrence determined by the presence or absence of a
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <code class="filename">keyset</code> file for each child zone.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Verify all generated signatures.
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Specifies the DNS class of the zone.
6d12fdf96621801e80f3f4c2a8a569fe48766a20David Lawrence Compatibility mode: Generate a
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <code class="filename">keyset-<em class="replaceable"><code>zonename</code></em></code>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews file in addition to
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <code class="filename">dsset-<em class="replaceable"><code>zonename</code></em></code>
0e8cf9a887c70f96ac448b06c069d90b830215ccMark Andrews when signing a zone, for use by older versions of
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <span><strong class="command">dnssec-signzone</strong></span>.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<dt><span class="term">-d <em class="replaceable"><code>directory</code></em></span></dt>
0e8cf9a887c70f96ac448b06c069d90b830215ccMark Andrews Look for <code class="filename">dsset-</code> or
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <code class="filename">keyset-</code> files in <code class="option">directory</code>.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Output only those record types automatically managed by
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <span><strong class="command">dnssec-signzone</strong></span>, i.e. RRSIG, NSEC,
0e8cf9a887c70f96ac448b06c069d90b830215ccMark Andrews NSEC3 and NSEC3PARAM records. If smart signing
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews (<code class="option">-S</code>) is used, DNSKEY records are also
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews included. The resulting file can be included in the original
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson zone file with <span><strong class="command">$INCLUDE</strong></span>. This option
e1cc8e9a0828f3239009bc8c6b0adf61ca1e2ef6Michael Graff cannot be combined with <code class="option">-O raw</code> or serial
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews number updating.
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Uses a crypto hardware (OpenSSL engine) for the crypto operations
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews it supports, for instance signing with private keys from
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews a secure key store. When compiled with PKCS#11 support
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews it defaults to pkcs11; the empty name resets it to no engine.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Generate DS records for child zones from
94a08e09db3dc844b6ee4841c368a2d7074a9c3fAndreas Gustafsson <code class="filename">dsset-</code> or <code class="filename">keyset-</code>
1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews file. Existing DS records will be removed.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence Key repository: Specify a directory to search for DNSSEC keys.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews If not specified, defaults to the current directory.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<dt><span class="term">-k <em class="replaceable"><code>key</code></em></span></dt>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Treat specified key as a key signing key ignoring any
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews key flags. This option may be specified multiple times.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Generate a DLV set in addition to the key (DNSKEY) and DS sets.
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff The domain is appended to the name of the records.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<dt><span class="term">-s <em class="replaceable"><code>start-time</code></em></span></dt>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Specify the date and time when the generated RRSIG records
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews become valid. This can be either an absolute or relative
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews time. An absolute start time is indicated by a number
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews in YYYYMMDDHHMMSS notation; 20000530144500 denotes
94a08e09db3dc844b6ee4841c368a2d7074a9c3fAndreas Gustafsson 14:45:00 UTC on May 30th, 2000. A relative start time is
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence indicated by +N, which is N seconds from the current time.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews If no <code class="option">start-time</code> is specified, the current
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews time minus 1 hour (to allow for clock skew) is used.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<dt><span class="term">-e <em class="replaceable"><code>end-time</code></em></span></dt>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Specify the date and time when the generated RRSIG records
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews expire. As with <code class="option">start-time</code>, an absolute
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews time is indicated in YYYYMMDDHHMMSS notation. A time relative
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews to the start time is indicated with +N, which is N seconds from
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews the start time. A time relative to the current time is
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews indicated with now+N. If no <code class="option">end-time</code> is
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews specified, 30 days from the start time is used as a default.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <code class="option">end-time</code> must be later than
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<dt><span class="term">-X <em class="replaceable"><code>extended end-time</code></em></span></dt>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Specify the date and time when the generated RRSIG records
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews for the DNSKEY RRset will expire. This is to be used in cases
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews when the DNSKEY signatures need to persist longer than
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews signatures on other records; e.g., when the private component
d981ca645597116d227a48bf37cc5edc061c854dBob Halley of the KSK is kept offline and the KSK signature is to be
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews refreshed manually.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews As with <code class="option">start-time</code>, an absolute
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews time is indicated in YYYYMMDDHHMMSS notation. A time relative
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews to the start time is indicated with +N, which is N seconds from
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews the start time. A time relative to the current time is
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews indicated with now+N. If no <code class="option">extended end-time</code> is
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews specified, the value of <code class="option">end-time</code> is used as
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews the default. (<code class="option">end-time</code>, in turn, defaults to
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews 30 days from the start time.) <code class="option">extended end-time</code>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews must be later than <code class="option">start-time</code>.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<dt><span class="term">-f <em class="replaceable"><code>output-file</code></em></span></dt>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews The name of the output file containing the signed zone. The
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews default is to append <code class="filename">.signed</code> to
7c0539bea56022274da04263eb41fbb5b8835c38Mark Andrews the input filename. If <code class="option">output-file</code> is
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews set to <code class="literal">"-"</code>, then the signed zone is
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews written to the standard output, with a default output
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff format of "full".
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Prints a short summary of the options and arguments to
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <span><strong class="command">dnssec-signzone</strong></span>.
373ce67419680a398ba3dc51a14a486caaf0afb0Mark Andrews<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
373ce67419680a398ba3dc51a14a486caaf0afb0Mark Andrews When a previously-signed zone is passed as input, records
373ce67419680a398ba3dc51a14a486caaf0afb0Mark Andrews may be resigned. The <code class="option">interval</code> option
373ce67419680a398ba3dc51a14a486caaf0afb0Mark Andrews specifies the cycle interval as an offset from the current
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews time (in seconds). If a RRSIG record expires after the
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews cycle interval, it is retained. Otherwise, it is considered
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff to be expiring soon, and it will be replaced.
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews The default cycle interval is one quarter of the difference
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews between the signature end and start times. So if neither
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews <code class="option">end-time</code> or <code class="option">start-time</code>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews are specified, <span><strong class="command">dnssec-signzone</strong></span>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews signatures that are valid for 30 days, with a cycle
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews interval of 7.5 days. Therefore, if any existing RRSIG records
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews are due to expire in less than 7.5 days, they would be
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews<dt><span class="term">-I <em class="replaceable"><code>input-format</code></em></span></dt>
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews The format of the input zone file.
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews Possible formats are <span><strong class="command">"text"</strong></span> (default)
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews and <span><strong class="command">"raw"</strong></span>.
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews This option is primarily intended to be used for dynamic
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews signed zones so that the dumped zone file in a non-text
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews format containing updates can be signed directly.
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews The use of this option does not make much sense for
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews non-dynamic zones.
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews<dt><span class="term">-j <em class="replaceable"><code>jitter</code></em></span></dt>
4529cdaedaf1a0a5f8ff89aeca510b7a4475446cBob Halley When signing a zone with a fixed signature lifetime, all
6d12fdf96621801e80f3f4c2a8a569fe48766a20David Lawrence RRSIG records issued at the time of signing expires
94a3bcd132e515b4baa0884ba9dd0f361d2e17bcMark Andrews simultaneously. If the zone is incrementally signed, i.e.
94a3bcd132e515b4baa0884ba9dd0f361d2e17bcMark Andrews a previously-signed zone is passed as input to the signer,
94a3bcd132e515b4baa0884ba9dd0f361d2e17bcMark Andrews all expired signatures have to be regenerated at about the
94a3bcd132e515b4baa0884ba9dd0f361d2e17bcMark Andrews same time. The <code class="option">jitter</code> option specifies a
82ca33427bdd4f3bc4ed3431e86bd810fe751674Andreas Gustafsson jitter window that will be used to randomize the signature
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews expire time, thus spreading incremental signature
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews regeneration over time.
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews Signature lifetime jitter also to some extent benefits
94a3bcd132e515b4baa0884ba9dd0f361d2e17bcMark Andrews validators and servers by spreading out cache expiration,
d981ca645597116d227a48bf37cc5edc061c854dBob Halley i.e. if large numbers of RRSIGs don't expire at the same time
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff from all caches there will be less congestion than if all
6d12fdf96621801e80f3f4c2a8a569fe48766a20David Lawrence validators need to refetch at mostly the same time.
b1bc194f94c0b3cbc5999582f08e8d7a20b91e2eBob Halley<dt><span class="term">-L <em class="replaceable"><code>serial</code></em></span></dt>
d981ca645597116d227a48bf37cc5edc061c854dBob Halley When writing a signed zone to 'raw' format, set the "source serial"
b1bc194f94c0b3cbc5999582f08e8d7a20b91e2eBob Halley value in the header to the specified serial number. (This is
b1bc194f94c0b3cbc5999582f08e8d7a20b91e2eBob Halley expected to be used primarily for testing purposes.)
b1bc194f94c0b3cbc5999582f08e8d7a20b91e2eBob Halley<dt><span class="term">-n <em class="replaceable"><code>ncpus</code></em></span></dt>
b1bc194f94c0b3cbc5999582f08e8d7a20b91e2eBob Halley Specifies the number of threads to use. By default, one
d981ca645597116d227a48bf37cc5edc061c854dBob Halley thread is started for each detected CPU.
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff<dt><span class="term">-N <em class="replaceable"><code>soa-serial-format</code></em></span></dt>
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley The SOA serial number format of the signed zone.
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley Possible formats are <span><strong class="command">"keep"</strong></span> (default),
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley <span><strong class="command">"increment"</strong></span> and
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley <span><strong class="command">"unixtime"</strong></span>.
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley<dt><span class="term"><span><strong class="command">"keep"</strong></span></span></dt>
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley<dd><p>Do not modify the SOA serial number.</p></dd>
f31f0b63cbe841720f154c570bcdede9d79e64b8Michael Graff<dt><span class="term"><span><strong class="command">"increment"</strong></span></span></dt>
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley<dd><p>Increment the SOA serial number using RFC 1982
64339caa4380e3df1a789ac328e616df434ed61fDavid Lawrence<dt><span class="term"><span><strong class="command">"unixtime"</strong></span></span></dt>
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley<dd><p>Set the SOA serial number to the number of seconds
and <span><strong class="command">"raw"</strong></span> or <span><strong class="command">"raw=N"</strong></span>,
by <span><strong class="command">named</strong></span>. <span><strong class="command">"raw=N"</strong></span>
Kexample.com.+003+17247