2 - Copyright (C) 2004-2015 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.
19 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
20 <title>dnssec-settime</title>
21 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
22 <link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
23 <link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
24 <link rel="prev" href="man.dnssec-revoke.html" title="dnssec-revoke">
25 <link rel="next" href="man.dnssec-signzone.html" title="dnssec-signzone">
27 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
28 <div class="navheader">
29 <table width="100%" summary="Navigation header">
30 <tr><th colspan="3" align="center"><span class="application">dnssec-settime</span></th></tr>
32 <td width="20%" align="left">
33 <a accesskey="p" href="man.dnssec-revoke.html">Prev</a> </td>
34 <th width="60%" align="center">Manual pages</th>
35 <td width="20%" align="right"> <a accesskey="n" href="man.dnssec-signzone.html">Next</a>
41 <div class="refentry">
42 <a name="man.dnssec-settime"></a><div class="titlepage"></div>
43 <div class="refnamediv">
45 <p><span class="application">dnssec-settime</span> — Set the key timing metadata for a DNSSEC key</p>
47 <div class="refsynopsisdiv">
49 <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>
51 <div class="refsection">
52 <a name="id-1.14.11.7"></a><h2>DESCRIPTION</h2>
53 <p><span class="command"><strong>dnssec-settime</strong></span>
54 reads a DNSSEC private key file and sets the key timing metadata
55 as specified by the <code class="option">-P</code>, <code class="option">-A</code>,
56 <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code>
57 options. The metadata can then be used by
58 <span class="command"><strong>dnssec-signzone</strong></span> or other signing software to
59 determine when a key is to be published, whether it should be
60 used for signing a zone, etc.
63 If none of these options is set on the command line,
64 then <span class="command"><strong>dnssec-settime</strong></span> simply prints the key timing
65 metadata already stored in the key.
68 When key metadata fields are changed, both files of a key
69 pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and
70 <code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated.
71 Metadata fields are stored in the private file. A human-readable
72 description of the metadata is also placed in comments in the key
73 file. The private file's permissions are always set to be
74 inaccessible to anyone other than the owner (mode 0600).
77 <div class="refsection">
78 <a name="id-1.14.11.8"></a><h2>OPTIONS</h2>
79 <div class="variablelist"><dl class="variablelist">
80 <dt><span class="term">-f</span></dt>
82 Force an update of an old-format key with no metadata fields.
83 Without this option, <span class="command"><strong>dnssec-settime</strong></span> will
84 fail when attempting to update a legacy key. With this option,
85 the key will be recreated in the new format, but with the
86 original key data retained. The key's creation date will be
87 set to the present time. If no other values are specified,
88 then the key's publication and activation dates will also
89 be set to the present time.
91 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
93 Sets the directory in which the key files are to reside.
95 <dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
97 Sets the default TTL to use for this key when it is converted
98 into a DNSKEY RR. If the key is imported into a zone,
99 this is the TTL that will be used for it, unless there was
100 already a DNSKEY RRset in place, in which case the existing TTL
101 would take precedence. If this value is not set and there
102 is no existing DNSKEY RRset, the TTL will default to the
103 SOA TTL. Setting the default TTL to <code class="literal">0</code>
104 or <code class="literal">none</code> removes it from the key.
106 <dt><span class="term">-h</span></dt>
108 Emit usage message and exit.
110 <dt><span class="term">-V</span></dt>
112 Prints version information.
114 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
116 Sets the debugging level.
118 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
120 Use the given OpenSSL engine. When compiled with PKCS#11 support
121 it defaults to pkcs11; the empty name resets it to no engine.
125 <div class="refsection">
126 <a name="id-1.14.11.9"></a><h2>TIMING OPTIONS</h2>
128 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
129 If the argument begins with a '+' or '-', it is interpreted as
130 an offset from the present time. For convenience, if such an offset
131 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
132 then the offset is computed in years (defined as 365 24-hour days,
133 ignoring leap years), months (defined as 30 24-hour days), weeks,
134 days, hours, or minutes, respectively. Without a suffix, the offset
135 is computed in seconds. To unset a date, use 'none' or 'never'.
137 <div class="variablelist"><dl class="variablelist">
138 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
140 Sets the date on which a key is to be published to the zone.
141 After that date, the key will be included in the zone but will
142 not be used to sign it.
144 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
146 Sets the date on which the key is to be activated. After that
147 date, the key will be included in the zone and used to sign
150 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
152 Sets the date on which the key is to be revoked. After that
153 date, the key will be flagged as revoked. It will be included
154 in the zone and will be used to sign it.
156 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
158 Sets the date on which the key is to be retired. After that
159 date, the key will still be included in the zone, but it
160 will not be used to sign it.
162 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
164 Sets the date on which the key is to be deleted. After that
165 date, the key will no longer be included in the zone. (It
166 may remain in the key repository, however.)
168 <dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt>
170 Select a key for which the key being modified will be an
171 explicit successor. The name, algorithm, size, and type of the
172 predecessor key must exactly match those of the key being
173 modified. The activation date of the successor key will be set
174 to the inactivation date of the predecessor. The publication
175 date will be set to the activation date minus the prepublication
176 interval, which defaults to 30 days.
178 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
181 Sets the prepublication interval for a key. If set, then
182 the publication and activation dates must be separated by at least
183 this much time. If the activation date is specified but the
184 publication date isn't, then the publication date will default
185 to this much time before the activation date; conversely, if
186 the publication date is specified but activation date isn't,
187 then activation will be set to this much time after publication.
190 If the key is being set to be an explicit successor to another
191 key, then the default prepublication interval is 30 days;
192 otherwise it is zero.
195 As with date offsets, if the argument is followed by one of
196 the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
197 interval is measured in years, months, weeks, days, hours,
198 or minutes, respectively. Without a suffix, the interval is
204 <div class="refsection">
205 <a name="id-1.14.11.10"></a><h2>PRINTING OPTIONS</h2>
207 <span class="command"><strong>dnssec-settime</strong></span> can also be used to print the
208 timing metadata associated with a key.
210 <div class="variablelist"><dl class="variablelist">
211 <dt><span class="term">-u</span></dt>
213 Print times in UNIX epoch format.
215 <dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/I/D/all</code></em></span></dt>
217 Print a specific metadata value or set of metadata values.
218 The <code class="option">-p</code> option may be followed by one or more
219 of the following letters to indicate which value or values to print:
220 <code class="option">C</code> for the creation date,
221 <code class="option">P</code> for the publication date,
222 <code class="option">A</code> for the activation date,
223 <code class="option">R</code> for the revocation date,
224 <code class="option">I</code> for the inactivation date, or
225 <code class="option">D</code> for the deletion date.
226 To print all of the metadata, use <code class="option">-p all</code>.
230 <div class="refsection">
231 <a name="id-1.14.11.11"></a><h2>SEE ALSO</h2>
232 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
233 <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
234 <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
235 <em class="citetitle">RFC 5011</em>.
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.ch13.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>
258 <p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.9.9-P3 (Extended Support Version)</p>