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