dnssec-settime.html revision 44d0f0256fbdce130a18655023c3b06bacacbd61
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes - Permission to use, copy, modify, and/or distribute this software for any
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes - purpose with or without fee is hereby granted, provided that the above
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes - copyright notice and this permission notice appear in all copies.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
0662ed52e814f8f08ef0e09956413a792584eddffuankg - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes - PERFORMANCE OF THIS SOFTWARE.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<!-- $Id: dnssec-settime.html,v 1.10 2010/02/04 01:14:16 tbox Exp $ -->
70953fb44a7140fe206c3a5f011e24209c8c5c6abnicholes<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
44f575c8cb19a7a5cd61664a7848be6bc197df02fuankg<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<a name="man.dnssec-settime"></a><div class="titlepage"></div>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<p><span class="application">dnssec-settime</span> — Set the key timing metadata for a DNSSEC key</p>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<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>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<p><span><strong class="command">dnssec-settime</strong></span>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes reads a DNSSEC private key file and sets the key timing metadata
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes as specified by the <code class="option">-P</code>, <code class="option">-A</code>,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes options. The metadata can then be used by
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <span><strong class="command">dnssec-signzone</strong></span> or other signing software to
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes determine when a key is to be published, whether it should be
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes used for signing a zone, etc.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes If none of these options is set on the command line,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes then <span><strong class="command">dnssec-settime</strong></span> simply prints the key timing
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes metadata already stored in the key.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes When key metadata fields are changed, both files of a key
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Metadata fields are stored in the private file. A human-readable
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes description of the metadata is also placed in comments in the key
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Force an update of an old-format key with no metadata fields.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Without this option, <span><strong class="command">dnssec-settime</strong></span> will
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes fail when attempting to update a legacy key. With this option,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes the key will be recreated in the new format, but with the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes original key data retained. The key's creation date will be
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes set to the present time.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg Sets the directory in which the key files are to reside.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Emit usage message and exit.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Sets the debugging level.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Use the given OpenSSL engine. When compiled with PKCS#11 support
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes it defaults to pkcs11; the empty name resets it to no engine.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes If the argument begins with a '+' or '-', it is interpreted as
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg an offset from the present time. For convenience, if such an offset
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes then the offset is computed in years (defined as 365 24-hour days,
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg ignoring leap years), months (defined as 30 24-hour days), weeks,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes days, hours, or minutes, respectively. Without a suffix, the offset
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes is computed in seconds. To unset a date, use 'none'.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Sets the date on which a key is to be published to the zone.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes After that date, the key will be included in the zone but will
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes not be used to sign it.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
0662ed52e814f8f08ef0e09956413a792584eddffuankg Sets the date on which the key is to be activated. After that
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes date, the key will be included in the zone and used to sign
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Sets the date on which the key is to be revoked. After that
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes date, the key will be flagged as revoked. It will be included
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes in the zone and will be used to sign it.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Sets the date on which the key is to be retired. After that
0662ed52e814f8f08ef0e09956413a792584eddffuankg date, the key will still be included in the zone, but it
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes will not be used to sign it.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
0662ed52e814f8f08ef0e09956413a792584eddffuankg Sets the date on which the key is to be deleted. After that
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes date, the key will no longer be included in the zone. (It
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes may remain in the key repository, however.)
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <span><strong class="command">dnssec-settime</strong></span> can also be used to print the
0662ed52e814f8f08ef0e09956413a792584eddffuankg timing metadata associated with a key.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Print times in UNIX epoch format.
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg<dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/U/D/all</code></em></span></dt>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Print a specific metadata value or set of metadata values.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes The <code class="option">-p</code> option may be followed by one or more
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes of the following letters to indicate which value or values to print:
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <code class="option">C</code> for the creation date,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <code class="option">P</code> for the publication date,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <code class="option">A</code> for the activation date,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <code class="option">R</code> for the revocation date,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <code class="option">U</code> for the unpublication date, or
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <code class="option">D</code> for the deletion date.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes To print all of the metadata, use <code class="option">-p all</code>.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<p><span class="corpauthor">Internet Systems Consortium</span>