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