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