man.dnssec-settime.html revision 4cfb5ea3a5dd28477df37004d6345992d5f41a3f
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC")
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - Copyright (C) 2000-2003 Internet Software Consortium.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - Permission to use, copy, modify, and/or distribute this software for any
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - purpose with or without fee is hereby granted, provided that the above
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - copyright notice and this permission notice appear in all copies.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - PERFORMANCE OF THIS SOFTWARE.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<!-- $Id$ -->
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
5a6ccfa98c3fe8a3eb2016fa5109c951c00cf439sd<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<link rel="prev" href="man.dnssec-revoke.html" title="dnssec-revoke">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<link rel="next" href="man.dnssec-signzone.html" title="dnssec-signzone">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<tr><th colspan="3" align="center"><span class="application">dnssec-settime</span></th></tr>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<a accesskey="p" href="man.dnssec-revoke.html">Prev</a>�</td>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<a name="man.dnssec-settime"></a><div class="titlepage"></div>
14ea4bb737263733ad80a36b4f73f681c30a6b45sd<p><span class="application">dnssec-settime</span> — Set the key timing metadata for a DNSSEC key</p>
14ea4bb737263733ad80a36b4f73f681c30a6b45sd<div class="cmdsynopsis"><p><code class="command">dnssec-settime</code> [<code class="option">-f</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] {keyfile}</p></div>
5a6ccfa98c3fe8a3eb2016fa5109c951c00cf439sd<p><span><strong class="command">dnssec-settime</strong></span>
14ea4bb737263733ad80a36b4f73f681c30a6b45sd reads a DNSSEC private key file and sets the key timing metadata
14ea4bb737263733ad80a36b4f73f681c30a6b45sd as specified by the <code class="option">-P</code>, <code class="option">-A</code>,
5a6ccfa98c3fe8a3eb2016fa5109c951c00cf439sd <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code>
14ea4bb737263733ad80a36b4f73f681c30a6b45sd options. The metadata can then be used by
5a6ccfa98c3fe8a3eb2016fa5109c951c00cf439sd <span><strong class="command">dnssec-signzone</strong></span> or other signing software to
14ea4bb737263733ad80a36b4f73f681c30a6b45sd determine when a key is to be published, whether it should be
14ea4bb737263733ad80a36b4f73f681c30a6b45sd used for signing a zone, etc.
ca6d7ba96138ee0d42364692a5e413bb220c4675jl If none of these options is set on the command line,
ca6d7ba96138ee0d42364692a5e413bb220c4675jl then <span><strong class="command">dnssec-settime</strong></span> simply prints the key timing
ca6d7ba96138ee0d42364692a5e413bb220c4675jl metadata already stored in the key.
ca6d7ba96138ee0d42364692a5e413bb220c4675jl When key metadata fields are changed, both files of a key
29b85469dc7bfb63a751e537fb0f51f164df4efawillard pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and
29b85469dc7bfb63a751e537fb0f51f164df4efawillard <code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated.
29b85469dc7bfb63a751e537fb0f51f164df4efawillard Metadata fields are stored in the private file. A human-readable
29b85469dc7bfb63a751e537fb0f51f164df4efawillard description of the metadata is also placed in comments in the key
29b85469dc7bfb63a751e537fb0f51f164df4efawillard file. The private file's permissions are always set to be
9f275dd8de877c986b2f531692a1aacfc3d0d4bcky inaccessible to anyone other than the owner (mode 0600).
8696d418011068e5cedf3a229f7a6613e7798e92ky Force an update of an old-format key with no metadata fields.
8696d418011068e5cedf3a229f7a6613e7798e92ky Without this option, <span><strong class="command">dnssec-settime</strong></span> will
8696d418011068e5cedf3a229f7a6613e7798e92ky fail when attempting to update a legacy key. With this option,
8696d418011068e5cedf3a229f7a6613e7798e92ky the key will be recreated in the new format, but with the
8696d418011068e5cedf3a229f7a6613e7798e92ky original key data retained. The key's creation date will be
8696d418011068e5cedf3a229f7a6613e7798e92ky set to the present time. If no other values are specified,
8696d418011068e5cedf3a229f7a6613e7798e92ky then the key's publication and activation dates will also
8696d418011068e5cedf3a229f7a6613e7798e92ky be set to the present time.
8696d418011068e5cedf3a229f7a6613e7798e92ky<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
13faa91230bde46da937bf33010b9accc5bdeb59sd Sets the directory in which the key files are to reside.
13faa91230bde46da937bf33010b9accc5bdeb59sd<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
13faa91230bde46da937bf33010b9accc5bdeb59sd Sets the default TTL to use for this key when it is converted
13faa91230bde46da937bf33010b9accc5bdeb59sd into a DNSKEY RR. If the key is imported into a zone,
13faa91230bde46da937bf33010b9accc5bdeb59sd this is the TTL that will be used for it, unless there was
13faa91230bde46da937bf33010b9accc5bdeb59sd already a DNSKEY RRset in place, in which case the existing TTL
13faa91230bde46da937bf33010b9accc5bdeb59sd would take precedence. Setting the default TTL to
13faa91230bde46da937bf33010b9accc5bdeb59sd <code class="literal">0</code> or <code class="literal">none</code> removes it.
6343349bf9d42501532d1ee2e75718d86ee366feanovick Emit usage message and exit.
6343349bf9d42501532d1ee2e75718d86ee366feanovick<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
6343349bf9d42501532d1ee2e75718d86ee366feanovick Sets the debugging level.
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
14ea4bb737263733ad80a36b4f73f681c30a6b45sd Use the given OpenSSL engine. When compiled with PKCS#11 support
14ea4bb737263733ad80a36b4f73f681c30a6b45sd it defaults to pkcs11; the empty name resets it to no engine.
59ac0c1669407488b67ae9e273667a340dccc611davemq Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
59ac0c1669407488b67ae9e273667a340dccc611davemq If the argument begins with a '+' or '-', it is interpreted as
59ac0c1669407488b67ae9e273667a340dccc611davemq an offset from the present time. For convenience, if such an offset
59ac0c1669407488b67ae9e273667a340dccc611davemq is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
59ac0c1669407488b67ae9e273667a340dccc611davemq then the offset is computed in years (defined as 365 24-hour days,
59ac0c1669407488b67ae9e273667a340dccc611davemq ignoring leap years), months (defined as 30 24-hour days), weeks,
59ac0c1669407488b67ae9e273667a340dccc611davemq days, hours, or minutes, respectively. Without a suffix, the offset
14ea4bb737263733ad80a36b4f73f681c30a6b45sd is computed in seconds. To unset a date, use 'none'.
13faa91230bde46da937bf33010b9accc5bdeb59sd<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
ca6d7ba96138ee0d42364692a5e413bb220c4675jl Sets the date on which a key is to be published to the zone.
ca6d7ba96138ee0d42364692a5e413bb220c4675jl After that date, the key will be included in the zone but will
ca6d7ba96138ee0d42364692a5e413bb220c4675jl not be used to sign it.
29b85469dc7bfb63a751e537fb0f51f164df4efawillard<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
8696d418011068e5cedf3a229f7a6613e7798e92ky Sets the date on which the key is to be activated. After that
8696d418011068e5cedf3a229f7a6613e7798e92ky date, the key will be included in the zone and used to sign
6343349bf9d42501532d1ee2e75718d86ee366feanovick<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Sets the date on which the key is to be revoked. After that
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi date, the key will be flagged as revoked. It will be included
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi in the zone and will be used to sign it.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Sets the date on which the key is to be retired. After that
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi date, the key will still be included in the zone, but it
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi will not be used to sign it.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Sets the date on which the key is to be deleted. After that
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi date, the key will no longer be included in the zone. (It
0eb822a1c0c2bea495647510b75f77f0e57633ebcindi may remain in the key repository, however.)
14ea4bb737263733ad80a36b4f73f681c30a6b45sd<dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt>
14ea4bb737263733ad80a36b4f73f681c30a6b45sd Select a key for which the key being modified will be an
14ea4bb737263733ad80a36b4f73f681c30a6b45sd explicit successor. The name, algorithm, size, and type of the
14ea4bb737263733ad80a36b4f73f681c30a6b45sd predecessor key must exactly match those of the key being
59ac0c1669407488b67ae9e273667a340dccc611davemq modified. The activation date of the successor key will be set
59ac0c1669407488b67ae9e273667a340dccc611davemq to the inactivation date of the predecessor. The publication
59ac0c1669407488b67ae9e273667a340dccc611davemq date will be set to the activation date minus the prepublication
59ac0c1669407488b67ae9e273667a340dccc611davemq interval, which defaults to 30 days.
59ac0c1669407488b67ae9e273667a340dccc611davemq<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
13faa91230bde46da937bf33010b9accc5bdeb59sd Sets the prepublication interval for a key. If set, then
13faa91230bde46da937bf33010b9accc5bdeb59sd the publication and activation dates must be separated by at least
13faa91230bde46da937bf33010b9accc5bdeb59sd this much time. If the activation date is specified but the
29b85469dc7bfb63a751e537fb0f51f164df4efawillard publication date isn't, then the publication date will default
8696d418011068e5cedf3a229f7a6613e7798e92ky to this much time before the activation date; conversely, if
8696d418011068e5cedf3a229f7a6613e7798e92ky the publication date is specified but activation date isn't,
8696d418011068e5cedf3a229f7a6613e7798e92ky then activation will be set to this much time after publication.
ca6d7ba96138ee0d42364692a5e413bb220c4675jl If the key is being set to be an explicit successor to another
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi key, then the default prepublication interval is 30 days;
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi otherwise it is zero.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi As with date offsets, if the argument is followed by one of
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi interval is measured in years, months, weeks, days, hours,
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi or minutes, respectively. Without a suffix, the interval is
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi measured in seconds.