man.dnssec-settime.html revision 5347c0fcb04eaea19d9f39795646239f487c6207
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync - Copyright (C) 2000-2015 Internet Systems Consortium, Inc. ("ISC")
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync - This Source Code Form is subject to the terms of the Mozilla Public
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync - License, v. 2.0. If a copy of the MPL was not distributed with this
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync - file, You can obtain one at http://mozilla.org/MPL/2.0/.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<link rel="prev" href="man.dnssec-revoke.html" title="dnssec-revoke">
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<link rel="next" href="man.dnssec-signzone.html" title="dnssec-signzone">
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<tr><th colspan="3" align="center"><span class="application">dnssec-settime</span></th></tr>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<a accesskey="p" href="man.dnssec-revoke.html">Prev</a>�</td>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a>
7870a295fdec1b57c4546425f2e591fd3091a7b3vboxsync<a name="man.dnssec-settime"></a><div class="titlepage"></div>
5ffb8839e755b3d3d6a45131c530ea13f8e9a2b9vboxsync<p><span class="application">dnssec-settime</span> — set the key timing metadata for a DNSSEC key</p>
0575222e3e7455c3ea1fb8f5aa7c4b58aea40a08vboxsync<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 <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>
7870a295fdec1b57c4546425f2e591fd3091a7b3vboxsync<p><span class="command"><strong>dnssec-settime</strong></span>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync reads a DNSSEC private key file and sets the key timing metadata
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync as specified by the <code class="option">-P</code>, <code class="option">-A</code>,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync options. The metadata can then be used by
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync <span class="command"><strong>dnssec-signzone</strong></span> or other signing software to
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync determine when a key is to be published, whether it should be
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync used for signing a zone, etc.
e3d1df74cd5c2d182013559f64184fdea625b8e2vboxsync If none of these options is set on the command line,
682a27d94b9116c719038882487b99053985f91avboxsync then <span class="command"><strong>dnssec-settime</strong></span> simply prints the key timing
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync metadata already stored in the key.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync When key metadata fields are changed, both files of a key
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync <code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Metadata fields are stored in the private file. A human-readable
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync description of the metadata is also placed in comments in the key
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync file. The private file's permissions are always set to be
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync inaccessible to anyone other than the owner (mode 0600).
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Force an update of an old-format key with no metadata fields.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Without this option, <span class="command"><strong>dnssec-settime</strong></span> will
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync fail when attempting to update a legacy key. With this option,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync the key will be recreated in the new format, but with the
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync original key data retained. The key's creation date will be
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync set to the present time. If no other values are specified,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync then the key's publication and activation dates will also
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync be set to the present time.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the directory in which the key files are to reside.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the default TTL to use for this key when it is converted
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync into a DNSKEY RR. If the key is imported into a zone,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync this is the TTL that will be used for it, unless there was
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync already a DNSKEY RRset in place, in which case the existing TTL
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync would take precedence. If this value is not set and there
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync is no existing DNSKEY RRset, the TTL will default to the
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync SOA TTL. Setting the default TTL to <code class="literal">0</code>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync or <code class="literal">none</code> removes it from the key.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Emit usage message and exit.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Prints version information.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the debugging level.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Specifies the cryptographic hardware to use, when applicable.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync When BIND is built with OpenSSL PKCS#11 support, this defaults
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync to the string "pkcs11", which identifies an OpenSSL engine
f65e6cba3e74ffd3dc9e6053828dcc82b367e8devboxsync that can drive a cryptographic accelerator or hardware service
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync module. When BIND is built with native PKCS#11 cryptography
0575222e3e7455c3ea1fb8f5aa7c4b58aea40a08vboxsync (--enable-native-pkcs11), it defaults to the path of the PKCS#11
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync provider library specified via "--with-pkcs11".
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync If the argument begins with a '+' or '-', it is interpreted as
f44b6583d60e03aa9366a491b16071532cf92357vboxsync an offset from the present time. For convenience, if such an offset
f44b6583d60e03aa9366a491b16071532cf92357vboxsync is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
f44b6583d60e03aa9366a491b16071532cf92357vboxsync then the offset is computed in years (defined as 365 24-hour days,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync ignoring leap years), months (defined as 30 24-hour days), weeks,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync days, hours, or minutes, respectively. Without a suffix, the offset
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync is computed in seconds. To unset a date, use 'none' or 'never'.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the date on which a key is to be published to the zone.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync After that date, the key will be included in the zone but will
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync not be used to sign it.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-P sync <em class="replaceable"><code>date/offset</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the date on which CDS and CDNSKEY records that match this
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync key are to be published to the zone.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the date on which the key is to be activated. After that
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync date, the key will be included in the zone and used to sign
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the date on which the key is to be revoked. After that
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync date, the key will be flagged as revoked. It will be included
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync in the zone and will be used to sign it.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the date on which the key is to be retired. After that
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync date, the key will still be included in the zone, but it
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync will not be used to sign it.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the date on which the key is to be deleted. After that
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync date, the key will no longer be included in the zone. (It
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync may remain in the key repository, however.)
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-D sync <em class="replaceable"><code>date/offset</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the date on which the CDS and CDNSKEY records that match this
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync key are to be deleted.
e3d1df74cd5c2d182013559f64184fdea625b8e2vboxsync<dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt>
741a0ea8ed7567b7784172852371782a5562c5a5vboxsync Select a key for which the key being modified will be an
741a0ea8ed7567b7784172852371782a5562c5a5vboxsync explicit successor. The name, algorithm, size, and type of the
e3d1df74cd5c2d182013559f64184fdea625b8e2vboxsync predecessor key must exactly match those of the key being
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync modified. The activation date of the successor key will be set
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync to the inactivation date of the predecessor. The publication
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync date will be set to the activation date minus the prepublication
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync interval, which defaults to 30 days.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Sets the prepublication interval for a key. If set, then
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync the publication and activation dates must be separated by at least
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync this much time. If the activation date is specified but the
1222ff94540f6426532c1f1714f0717fdcf92e46vboxsync publication date isn't, then the publication date will default
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync to this much time before the activation date; conversely, if
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync the publication date is specified but activation date isn't,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync then activation will be set to this much time after publication.
0575222e3e7455c3ea1fb8f5aa7c4b58aea40a08vboxsync If the key is being set to be an explicit successor to another
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync key, then the default prepublication interval is 30 days;
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync otherwise it is zero.
0575222e3e7455c3ea1fb8f5aa7c4b58aea40a08vboxsync As with date offsets, if the argument is followed by one of
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync interval is measured in years, months, weeks, days, hours,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync or minutes, respectively. Without a suffix, the interval is
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync measured in seconds.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<a name="id-1.14.12.10"></a><h2>PRINTING OPTIONS</h2>
0575222e3e7455c3ea1fb8f5aa7c4b58aea40a08vboxsync <span class="command"><strong>dnssec-settime</strong></span> can also be used to print the
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync timing metadata associated with a key.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Print times in UNIX epoch format.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<dt><span class="term">-p <em class="replaceable"><code>C/P/Psync/A/R/I/D/Dsync/all</code></em></span></dt>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync Print a specific metadata value or set of metadata values.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync The <code class="option">-p</code> option may be followed by one or more
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync of the following letters or strings to indicate which value
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync or values to print:
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync <code class="option">C</code> for the creation date,
0575222e3e7455c3ea1fb8f5aa7c4b58aea40a08vboxsync <code class="option">P</code> for the publication date,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync <code class="option">Psync</code> for the CDS and CDNSKEY publication date,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync <code class="option">A</code> for the activation date,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync <code class="option">R</code> for the revocation date,
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync <code class="option">I</code> for the inactivation date,
366bfe2e04063776613f5e68fcc7fa1faa0c7650vboxsync <code class="option">D</code> for the deletion date, and
4faf92053d9cec5599c0ab8577231df0f7d615b3vboxsync <code class="option">Dsync</code> for the CDS and CDNSKEY deletion date
4faf92053d9cec5599c0ab8577231df0f7d615b3vboxsync To print all of the metadata, use <code class="option">-p all</code>.
adf5f1f964bb309d1306e270ed8679d02bf14c23vboxsync<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
adf5f1f964bb309d1306e270ed8679d02bf14c23vboxsync <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
adf5f1f964bb309d1306e270ed8679d02bf14c23vboxsync <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
adf5f1f964bb309d1306e270ed8679d02bf14c23vboxsync<a accesskey="p" href="man.dnssec-revoke.html">Prev</a>�</td>
adf5f1f964bb309d1306e270ed8679d02bf14c23vboxsync<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
adf5f1f964bb309d1306e270ed8679d02bf14c23vboxsync<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<span class="application">dnssec-revoke</span>�</td>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync<td width="40%" align="right" valign="top">�<span class="application">dnssec-signzone</span>
366bfe2e04063776613f5e68fcc7fa1faa0c7650vboxsync<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.0b2</p>