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