man.dnssec-settime.html revision e2e4d321999340802f77adaacd19c797d04b4b95
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<!--
66b665fac6215b07ef71fd7876590d4c0143e739lutoff - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
66b665fac6215b07ef71fd7876590d4c0143e739lutoff - Copyright (C) 2000-2003 Internet Software Consortium.
66b665fac6215b07ef71fd7876590d4c0143e739lutoff -
66b665fac6215b07ef71fd7876590d4c0143e739lutoff - Permission to use, copy, modify, and/or distribute this software for any
66b665fac6215b07ef71fd7876590d4c0143e739lutoff - purpose with or without fee is hereby granted, provided that the above
66b665fac6215b07ef71fd7876590d4c0143e739lutoff - copyright notice and this permission notice appear in all copies.
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac -
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
66b665fac6215b07ef71fd7876590d4c0143e739lutoff - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
66b665fac6215b07ef71fd7876590d4c0143e739lutoff - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
66b665fac6215b07ef71fd7876590d4c0143e739lutoff - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
66b665fac6215b07ef71fd7876590d4c0143e739lutoff - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac - PERFORMANCE OF THIS SOFTWARE.
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac-->
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac<!-- $Id: man.dnssec-settime.html,v 1.30 2009/12/04 22:22:25 tbox Exp $ -->
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<html>
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<head>
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<title>dnssec-settime</title>
65e99be301d5a19db33f25841f671756e8dbb9b5ludovicp<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<link rel="prev" href="man.dnssec-revoke.html" title="dnssec-revoke">
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<link rel="next" href="man.dnssec-signzone.html" title="dnssec-signzone">
66b665fac6215b07ef71fd7876590d4c0143e739lutoff</head>
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<div class="navheader">
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<table width="100%" summary="Navigation header">
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<tr><th colspan="3" align="center"><span class="application">dnssec-settime</span></th></tr>
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<tr>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<td width="20%" align="left">
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<a accesskey="p" href="man.dnssec-revoke.html">Prev</a>�</td>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<th width="60%" align="center">Manual pages</th>
66b665fac6215b07ef71fd7876590d4c0143e739lutoff<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff</td>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff</tr>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff</table>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<hr>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff</div>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<div class="refentry" lang="en">
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<a name="man.dnssec-settime"></a><div class="titlepage"></div>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<div class="refnamediv">
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<h2>Name</h2>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<p><span class="application">dnssec-settime</span> &#8212; Set the key timing metadata for a DNSSEC key</p>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff</div>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<div class="refsynopsisdiv">
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<h2>Synopsis</h2>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff<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>
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff</div>
a487f129b43692428fc0e85d81f0f893bf8e3575lutoff<div class="refsect1" lang="en">
<a name="id2609787"></a><h2>DESCRIPTION</h2>
<p><span><strong class="command">dnssec-settime</strong></span>
reads a DNSSEC private key file and sets the key timing metadata
as specified by the <code class="option">-P</code>, <code class="option">-A</code>,
<code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code>
options. The metadata can then be used by
<span><strong class="command">dnssec-signzone</strong></span> or other signing software to
determine when a key is to be published, whether it should be
used for signing a zone, etc.
</p>
<p>
If none of these options is set on the command line,
then <span><strong class="command">dnssec-settime</strong></span> simply prints the key timing
metadata already stored in the key.
</p>
<p>
When key metadata fields are changed, both files of a key
pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and
<code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated.
Metadata fields are stored in the private file. A human-readable
description of the metadata is also placed in comments in the key
file.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2609846"></a><h2>OPTIONS</h2>
<div class="variablelist"><dl>
<dt><span class="term">-f</span></dt>
<dd><p>
Force an update of an old-format key with no metadata fields.
Without this option, <span><strong class="command">dnssec-settime</strong></span> will
fail when attempting to update a legacy key. With this option,
the key will be recreated in the new format, but with the
original key data retained. The key's creation date will be
set to the present time.
</p></dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
<dd><p>
Sets the directory in which the key files are to reside.
</p></dd>
<dt><span class="term">-h</span></dt>
<dd><p>
Emit usage message and exit.
</p></dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
<dd><p>
Sets the debugging level.
</p></dd>
<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
<dd><p>
Use the given OpenSSL engine. When compiled with PKCS#11 support
it defaults to pkcs11; the empty name resets it to no engine.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2610554"></a><h2>TIMING OPTIONS</h2>
<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>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2610652"></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/U/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 revokation date,
<code class="option">U</code> for the unpublication 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="id2611552"></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="id2611585"></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>