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