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