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