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