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