man.dnssec-settime.html revision dba3c818ae00b10388d31703e86a28415db398ac
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<!--
d9ef684564c53b70e20e0d8a98aa721687cf2605kess - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC")
d9ef684564c53b70e20e0d8a98aa721687cf2605kess - Copyright (C) 2000-2003 Internet Software Consortium.
d9ef684564c53b70e20e0d8a98aa721687cf2605kess -
d9ef684564c53b70e20e0d8a98aa721687cf2605kess - Permission to use, copy, modify, and/or distribute this software for any
d9ef684564c53b70e20e0d8a98aa721687cf2605kess - purpose with or without fee is hereby granted, provided that the above
d9ef684564c53b70e20e0d8a98aa721687cf2605kess - copyright notice and this permission notice appear in all copies.
96ad5d81ee4a2cc66a4ae19893efc8aa6d06fae7jailletc -
d9ef684564c53b70e20e0d8a98aa721687cf2605kess - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
d9ef684564c53b70e20e0d8a98aa721687cf2605kess - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2e545ce2450a9953665f701bb05350f0d3f26275nd - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
d9ef684564c53b70e20e0d8a98aa721687cf2605kess - PERFORMANCE OF THIS SOFTWARE.
d9ef684564c53b70e20e0d8a98aa721687cf2605kess-->
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<!-- $Id$ -->
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<html>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<head>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<title>dnssec-settime</title>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd<link rel="prev" href="man.dnssec-revoke.html" title="dnssec-revoke">
d05d0eb4ae6d2a5e513fc3bf2555ce33da416634nd<link rel="next" href="man.dnssec-signzone.html" title="dnssec-signzone">
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd</head>
ecc5150d35c0dc5ee5119c2717e6660fa331abbftakashi<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
d474d8ef01ec5c2a09341cd148851ed383c3287crbowen<div class="navheader">
d474d8ef01ec5c2a09341cd148851ed383c3287crbowen<table width="100%" summary="Navigation header">
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd<tr><th colspan="3" align="center"><span class="application">dnssec-settime</span></th></tr>
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem<tr>
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem<td width="20%" align="left">
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem<a accesskey="p" href="man.dnssec-revoke.html">Prev</a>�</td>
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd<th width="60%" align="center">Manual pages</th>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess</td>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess</tr>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess</table>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<hr>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess</div>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<div class="refentry" lang="en">
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<a name="man.dnssec-settime"></a><div class="titlepage"></div>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<div class="refnamediv">
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<h2>Name</h2>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<p><span class="application">dnssec-settime</span> &#8212; Set the key timing metadata for a DNSSEC key</p>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess</div>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<div class="refsynopsisdiv">
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<h2>Synopsis</h2>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<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 <em class="replaceable"><code>level</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] {keyfile}</p></div>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess</div>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<div class="refsect1" lang="en">
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<a name="id2617626"></a><h2>DESCRIPTION</h2>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<p><span><strong class="command">dnssec-settime</strong></span>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess reads a DNSSEC private key file and sets the key timing metadata
d9ef684564c53b70e20e0d8a98aa721687cf2605kess as specified by the <code class="option">-P</code>, <code class="option">-A</code>,
d9ef684564c53b70e20e0d8a98aa721687cf2605kess <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess options. The metadata can then be used by
d9ef684564c53b70e20e0d8a98aa721687cf2605kess <span><strong class="command">dnssec-signzone</strong></span> or other signing software to
d9ef684564c53b70e20e0d8a98aa721687cf2605kess determine when a key is to be published, whether it should be
d9ef684564c53b70e20e0d8a98aa721687cf2605kess used for signing a zone, etc.
d9ef684564c53b70e20e0d8a98aa721687cf2605kess </p>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<p>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess If none of these options is set on the command line,
d9ef684564c53b70e20e0d8a98aa721687cf2605kess then <span><strong class="command">dnssec-settime</strong></span> simply prints the key timing
d9ef684564c53b70e20e0d8a98aa721687cf2605kess metadata already stored in the key.
d9ef684564c53b70e20e0d8a98aa721687cf2605kess </p>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<p>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess When key metadata fields are changed, both files of a key
d9ef684564c53b70e20e0d8a98aa721687cf2605kess pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and
d9ef684564c53b70e20e0d8a98aa721687cf2605kess <code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated.
d9ef684564c53b70e20e0d8a98aa721687cf2605kess Metadata fields are stored in the private file. A human-readable
d9ef684564c53b70e20e0d8a98aa721687cf2605kess description of the metadata is also placed in comments in the key
d9ef684564c53b70e20e0d8a98aa721687cf2605kess file. The private file's permissions are always set to be
d9ef684564c53b70e20e0d8a98aa721687cf2605kess inaccessible to anyone other than the owner (mode 0600).
d9ef684564c53b70e20e0d8a98aa721687cf2605kess </p>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess</div>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<div class="refsect1" lang="en">
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<a name="id2617685"></a><h2>OPTIONS</h2>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<div class="variablelist"><dl>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<dt><span class="term">-f</span></dt>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<dd><p>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess Force an update of an old-format key with no metadata fields.
d9ef684564c53b70e20e0d8a98aa721687cf2605kess Without this option, <span><strong class="command">dnssec-settime</strong></span> will
d9ef684564c53b70e20e0d8a98aa721687cf2605kess fail when attempting to update a legacy key. With this option,
d9ef684564c53b70e20e0d8a98aa721687cf2605kess the key will be recreated in the new format, but with the
d9ef684564c53b70e20e0d8a98aa721687cf2605kess original key data retained. The key's creation date will be
d9ef684564c53b70e20e0d8a98aa721687cf2605kess set to the present time. If no other values are specified,
d9ef684564c53b70e20e0d8a98aa721687cf2605kess then the key's publication and activation dates will also
d9ef684564c53b70e20e0d8a98aa721687cf2605kess be set to the present time.
d9ef684564c53b70e20e0d8a98aa721687cf2605kess </p></dd>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<dd><p>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess Sets the directory in which the key files are to reside.
d9ef684564c53b70e20e0d8a98aa721687cf2605kess </p></dd>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<dd><p>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess Sets the default TTL to use for this key when it is converted
d9ef684564c53b70e20e0d8a98aa721687cf2605kess into a DNSKEY RR. If the key is imported into a zone,
d9ef684564c53b70e20e0d8a98aa721687cf2605kess this is the TTL that will be used for it, unless there was
d9ef684564c53b70e20e0d8a98aa721687cf2605kess already a DNSKEY RRset in place, in which case the existing TTL
d9ef684564c53b70e20e0d8a98aa721687cf2605kess would take precedence. Setting the default TTL to
4301c61a5ee07ed0059e24ad6ebc6491ac1b7b61nd <code class="literal">0</code> or <code class="literal">none</code> removes it.
4301c61a5ee07ed0059e24ad6ebc6491ac1b7b61nd </p></dd>
4301c61a5ee07ed0059e24ad6ebc6491ac1b7b61nd<dt><span class="term">-h</span></dt>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<dd><p>
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd Emit usage message and exit.
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd </p></dd>
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
d05d0eb4ae6d2a5e513fc3bf2555ce33da416634nd<dd><p>
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd Sets the debugging level.
ecc5150d35c0dc5ee5119c2717e6660fa331abbftakashi </p></dd>
d474d8ef01ec5c2a09341cd148851ed383c3287crbowen<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
d474d8ef01ec5c2a09341cd148851ed383c3287crbowen<dd><p>
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd Use the given OpenSSL engine. When compiled with PKCS#11 support
07dc96d063d49299da433f84b5c5681da9bbdf68rbowen it defaults to pkcs11; the empty name resets it to no engine.
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen </p></dd>
0d0ba3a410038e179b695446bb149cce6264e0abnd</dl></div>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd</div>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd<div class="refsect1" lang="en">
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd<a name="id2618011"></a><h2>TIMING OPTIONS</h2>
d9ef684564c53b70e20e0d8a98aa721687cf2605kess<p>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
If the argument begins with a '+' or '-', it is interpreted as
an offset from the present time. For convenience, if such an offset
is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
then the offset is computed in years (defined as 365 24-hour days,
ignoring leap years), months (defined as 30 24-hour days), weeks,
days, hours, or minutes, respectively. Without a suffix, the offset
is computed in seconds. To unset a date, use 'none'.
</p>
<div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which a key is to be published to the zone.
After that date, the key will be included in the zone but will
not be used to sign it.
</p></dd>
<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be activated. After that
date, the key will be included in the zone and used to sign
it.
</p></dd>
<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be revoked. After that
date, the key will be flagged as revoked. It will be included
in the zone and will be used to sign it.
</p></dd>
<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be retired. After that
date, the key will still be included in the zone, but it
will not be used to sign it.
</p></dd>
<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be deleted. After that
date, the key will no longer be included in the zone. (It
may remain in the key repository, however.)
</p></dd>
<dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt>
<dd><p>
Select a key for which the key being modified will be an
explicit successor. The name, algorithm, size, and type of the
predecessor key must exactly match those of the key being
modified. The activation date of the successor key will be set
to the inactivation date of the predecessor. The publication
date will be set to the activation date minus the prepublication
interval, which defaults to 30 days.
</p></dd>
<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
<dd>
<p>
Sets the prepublication interval for a key. If set, then
the publication and activation dates must be separated by at least
this much time. If the activation date is specified but the
publication date isn't, then the publication date will default
to this much time before the activation date; conversely, if
the publication date is specified but activation date isn't,
then activation will be set to this much time after publication.
</p>
<p>
If the key is being set to be an explicit successor to another
key, then the default prepublication interval is 30 days;
otherwise it is zero.
</p>
<p>
As with date offsets, if the argument is followed by one of
the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
interval is measured in years, months, weeks, days, hours,
or minutes, respectively. Without a suffix, the interval is
measured in seconds.
</p>
</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2618150"></a><h2>PRINTING OPTIONS</h2>
<p>
<span><strong class="command">dnssec-settime</strong></span> can also be used to print the
timing metadata associated with a key.
</p>
<div class="variablelist"><dl>
<dt><span class="term">-u</span></dt>
<dd><p>
Print times in UNIX epoch format.
</p></dd>
<dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/I/D/all</code></em></span></dt>
<dd><p>
Print a specific metadata value or set of metadata values.
The <code class="option">-p</code> option may be followed by one or more
of the following letters to indicate which value or values to print:
<code class="option">C</code> for the creation date,
<code class="option">P</code> for the publication date,
<code class="option">A</code> for the activation date,
<code class="option">R</code> for the revocation date,
<code class="option">I</code> for the inactivation date, or
<code class="option">D</code> for the deletion date.
To print all of the metadata, use <code class="option">-p all</code>.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2618571"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 5011</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2618604"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.dnssec-revoke.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span class="application">dnssec-revoke</span>�</td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top">�<span class="application">dnssec-signzone</span>
</td>
</tr>
</table>
</div>
</body>
</html>