2 - Copyright (C) 2004-2013 Internet Systems Consortium, Inc. ("ISC")
3 - Copyright (C) 2000-2003 Internet Software Consortium.
5 - Permission to use, copy, modify, and/or distribute this software for any
6 - purpose with or without fee is hereby granted, provided that the above
7 - copyright notice and this permission notice appear in all copies.
9 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 - PERFORMANCE OF THIS SOFTWARE.
20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
21 <title>dnssec-settime</title>
22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
23 <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
24 <link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
25 <link rel="prev" href="man.dnssec-revoke.html" title="dnssec-revoke">
26 <link rel="next" href="man.dnssec-signzone.html" title="dnssec-signzone">
28 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
29 <div class="navheader">
30 <table width="100%" summary="Navigation header">
31 <tr><th colspan="3" align="center"><span class="application">dnssec-settime</span></th></tr>
33 <td width="20%" align="left">
34 <a accesskey="p" href="man.dnssec-revoke.html">Prev</a> </td>
35 <th width="60%" align="center">Manual pages</th>
36 <td width="20%" align="right"> <a accesskey="n" href="man.dnssec-signzone.html">Next</a>
42 <div class="refentry" lang="en">
43 <a name="man.dnssec-settime"></a><div class="titlepage"></div>
44 <div class="refnamediv">
46 <p><span class="application">dnssec-settime</span> — Set the key timing metadata for a DNSSEC key</p>
48 <div class="refsynopsisdiv">
50 <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>
52 <div class="refsect1" lang="en">
53 <a name="id2618803"></a><h2>DESCRIPTION</h2>
54 <p><span><strong class="command">dnssec-settime</strong></span>
55 reads a DNSSEC private key file and sets the key timing metadata
56 as specified by the <code class="option">-P</code>, <code class="option">-A</code>,
57 <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code>
58 options. The metadata can then be used by
59 <span><strong class="command">dnssec-signzone</strong></span> or other signing software to
60 determine when a key is to be published, whether it should be
61 used for signing a zone, etc.
64 If none of these options is set on the command line,
65 then <span><strong class="command">dnssec-settime</strong></span> simply prints the key timing
66 metadata already stored in the key.
69 When key metadata fields are changed, both files of a key
70 pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and
71 <code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated.
72 Metadata fields are stored in the private file. A human-readable
73 description of the metadata is also placed in comments in the key
74 file. The private file's permissions are always set to be
75 inaccessible to anyone other than the owner (mode 0600).
78 <div class="refsect1" lang="en">
79 <a name="id2618861"></a><h2>OPTIONS</h2>
80 <div class="variablelist"><dl>
81 <dt><span class="term">-f</span></dt>
83 Force an update of an old-format key with no metadata fields.
84 Without this option, <span><strong class="command">dnssec-settime</strong></span> will
85 fail when attempting to update a legacy key. With this option,
86 the key will be recreated in the new format, but with the
87 original key data retained. The key's creation date will be
88 set to the present time. If no other values are specified,
89 then the key's publication and activation dates will also
90 be set to the present time.
92 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
94 Sets the directory in which the key files are to reside.
96 <dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
98 Sets the default TTL to use for this key when it is converted
99 into a DNSKEY RR. If the key is imported into a zone,
100 this is the TTL that will be used for it, unless there was
101 already a DNSKEY RRset in place, in which case the existing TTL
102 would take precedence. Setting the default TTL to
103 <code class="literal">0</code> or <code class="literal">none</code> removes it.
105 <dt><span class="term">-h</span></dt>
107 Emit usage message and exit.
109 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
111 Sets the debugging level.
113 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
115 Use the given OpenSSL engine. When compiled with PKCS#11 support
116 it defaults to pkcs11; the empty name resets it to no engine.
120 <div class="refsect1" lang="en">
121 <a name="id2619051"></a><h2>TIMING OPTIONS</h2>
123 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
124 If the argument begins with a '+' or '-', it is interpreted as
125 an offset from the present time. For convenience, if such an offset
126 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
127 then the offset is computed in years (defined as 365 24-hour days,
128 ignoring leap years), months (defined as 30 24-hour days), weeks,
129 days, hours, or minutes, respectively. Without a suffix, the offset
130 is computed in seconds. To unset a date, use 'none'.
132 <div class="variablelist"><dl>
133 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
135 Sets the date on which a key is to be published to the zone.
136 After that date, the key will be included in the zone but will
137 not be used to sign it.
139 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
141 Sets the date on which the key is to be activated. After that
142 date, the key will be included in the zone and used to sign
145 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
147 Sets the date on which the key is to be revoked. After that
148 date, the key will be flagged as revoked. It will be included
149 in the zone and will be used to sign it.
151 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
153 Sets the date on which the key is to be retired. After that
154 date, the key will still be included in the zone, but it
155 will not be used to sign it.
157 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
159 Sets the date on which the key is to be deleted. After that
160 date, the key will no longer be included in the zone. (It
161 may remain in the key repository, however.)
163 <dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt>
165 Select a key for which the key being modified will be an
166 explicit successor. The name, algorithm, size, and type of the
167 predecessor key must exactly match those of the key being
168 modified. The activation date of the successor key will be set
169 to the inactivation date of the predecessor. The publication
170 date will be set to the activation date minus the prepublication
171 interval, which defaults to 30 days.
173 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
176 Sets the prepublication interval for a key. If set, then
177 the publication and activation dates must be separated by at least
178 this much time. If the activation date is specified but the
179 publication date isn't, then the publication date will default
180 to this much time before the activation date; conversely, if
181 the publication date is specified but activation date isn't,
182 then activation will be set to this much time after publication.
185 If the key is being set to be an explicit successor to another
186 key, then the default prepublication interval is 30 days;
187 otherwise it is zero.
190 As with date offsets, if the argument is followed by one of
191 the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
192 interval is measured in years, months, weeks, days, hours,
193 or minutes, respectively. Without a suffix, the interval is
199 <div class="refsect1" lang="en">
200 <a name="id2619326"></a><h2>PRINTING OPTIONS</h2>
202 <span><strong class="command">dnssec-settime</strong></span> can also be used to print the
203 timing metadata associated with a key.
205 <div class="variablelist"><dl>
206 <dt><span class="term">-u</span></dt>
208 Print times in UNIX epoch format.
210 <dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/I/D/all</code></em></span></dt>
212 Print a specific metadata value or set of metadata values.
213 The <code class="option">-p</code> option may be followed by one or more
214 of the following letters to indicate which value or values to print:
215 <code class="option">C</code> for the creation date,
216 <code class="option">P</code> for the publication date,
217 <code class="option">A</code> for the activation date,
218 <code class="option">R</code> for the revocation date,
219 <code class="option">I</code> for the inactivation date, or
220 <code class="option">D</code> for the deletion date.
221 To print all of the metadata, use <code class="option">-p all</code>.
225 <div class="refsect1" lang="en">
226 <a name="id2619406"></a><h2>SEE ALSO</h2>
227 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
228 <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
229 <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
230 <em class="citetitle">RFC 5011</em>.
233 <div class="refsect1" lang="en">
234 <a name="id2619440"></a><h2>AUTHOR</h2>
235 <p><span class="corpauthor">Internet Systems Consortium</span>
239 <div class="navfooter">
241 <table width="100%" summary="Navigation footer">
243 <td width="40%" align="left">
244 <a accesskey="p" href="man.dnssec-revoke.html">Prev</a> </td>
245 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
246 <td width="40%" align="right"> <a accesskey="n" href="man.dnssec-signzone.html">Next</a>
250 <td width="40%" align="left" valign="top">
251 <span class="application">dnssec-revoke</span> </td>
252 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
253 <td width="40%" align="right" valign="top"> <span class="application">dnssec-signzone</span>