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