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