1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3 [<!ENTITY mdash "—">]>
5 - Copyright (C) 2009-2011 Internet Systems Consortium, Inc. ("ISC")
7 - Permission to use, copy, modify, and/or distribute this software for any
8 - purpose with or without fee is hereby granted, provided that the above
9 - copyright notice and this permission notice appear in all copies.
11 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17 - PERFORMANCE OF THIS SOFTWARE.
20 <!-- $Id: dnssec-settime.docbook,v 1.11.70.3 2011/11/03 20:21:30 each Exp $ -->
21 <refentry id="man.dnssec-settime">
23 <date>July 15, 2009</date>
27 <refentrytitle><application>dnssec-settime</application></refentrytitle>
28 <manvolnum>8</manvolnum>
29 <refmiscinfo>BIND9</refmiscinfo>
33 <refname><application>dnssec-settime</application></refname>
34 <refpurpose>Set the key timing metadata for a DNSSEC key</refpurpose>
42 <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
48 <command>dnssec-settime</command>
49 <arg><option>-f</option></arg>
50 <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
51 <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
52 <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
53 <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
54 <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>
55 <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
56 <arg><option>-h</option></arg>
57 <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
58 <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
59 <arg choice="req">keyfile</arg>
64 <title>DESCRIPTION</title>
65 <para><command>dnssec-settime</command>
66 reads a DNSSEC private key file and sets the key timing metadata
67 as specified by the <option>-P</option>, <option>-A</option>,
68 <option>-R</option>, <option>-I</option>, and <option>-D</option>
69 options. The metadata can then be used by
70 <command>dnssec-signzone</command> or other signing software to
71 determine when a key is to be published, whether it should be
72 used for signing a zone, etc.
75 If none of these options is set on the command line,
76 then <command>dnssec-settime</command> simply prints the key timing
77 metadata already stored in the key.
80 When key metadata fields are changed, both files of a key
81 pair (<filename>Knnnn.+aaa+iiiii.key</filename> and
82 <filename>Knnnn.+aaa+iiiii.private</filename>) are regenerated.
83 Metadata fields are stored in the private file. A human-readable
84 description of the metadata is also placed in comments in the key
85 file. The private file's permissions are always set to be
86 inaccessible to anyone other than the owner (mode 0600).
91 <title>OPTIONS</title>
98 Force an update of an old-format key with no metadata fields.
99 Without this option, <command>dnssec-settime</command> will
100 fail when attempting to update a legacy key. With this option,
101 the key will be recreated in the new format, but with the
102 original key data retained. The key's creation date will be
103 set to the present time. If no other values are specified,
104 then the key's publication and activation dates will also
105 be set to the present time.
111 <term>-K <replaceable class="parameter">directory</replaceable></term>
114 Sets the directory in which the key files are to reside.
123 Emit usage message and exit.
129 <term>-v <replaceable class="parameter">level</replaceable></term>
132 Sets the debugging level.
138 <term>-E <replaceable class="parameter">engine</replaceable></term>
141 Use the given OpenSSL engine. When compiled with PKCS#11 support
142 it defaults to pkcs11; the empty name resets it to no engine.
150 <title>TIMING OPTIONS</title>
152 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
153 If the argument begins with a '+' or '-', it is interpreted as
154 an offset from the present time. For convenience, if such an offset
155 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
156 then the offset is computed in years (defined as 365 24-hour days,
157 ignoring leap years), months (defined as 30 24-hour days), weeks,
158 days, hours, or minutes, respectively. Without a suffix, the offset
159 is computed in seconds. To unset a date, use 'none'.
164 <term>-P <replaceable class="parameter">date/offset</replaceable></term>
167 Sets the date on which a key is to be published to the zone.
168 After that date, the key will be included in the zone but will
169 not be used to sign it.
175 <term>-A <replaceable class="parameter">date/offset</replaceable></term>
178 Sets the date on which the key is to be activated. After that
179 date, the key will be included in the zone and used to sign
186 <term>-R <replaceable class="parameter">date/offset</replaceable></term>
189 Sets the date on which the key is to be revoked. After that
190 date, the key will be flagged as revoked. It will be included
191 in the zone and will be used to sign it.
197 <term>-I <replaceable class="parameter">date/offset</replaceable></term>
200 Sets the date on which the key is to be retired. After that
201 date, the key will still be included in the zone, but it
202 will not be used to sign it.
208 <term>-D <replaceable class="parameter">date/offset</replaceable></term>
211 Sets the date on which the key is to be deleted. After that
212 date, the key will no longer be included in the zone. (It
213 may remain in the key repository, however.)
219 <term>-S <replaceable class="parameter">predecessor key</replaceable></term>
222 Select a key for which the key being modified will be an
223 explicit successor. The name, algorithm, size, and type of the
224 predecessor key must exactly match those of the key being
225 modified. The activation date of the successor key will be set
226 to the inactivation date of the predecessor. The publication
227 date will be set to the activation date minus the prepublication
228 interval, which defaults to 30 days.
234 <term>-i <replaceable class="parameter">interval</replaceable></term>
237 Sets the prepublication interval for a key. If set, then
238 the publication and activation dates must be separated by at least
239 this much time. If the activation date is specified but the
240 publication date isn't, then the publication date will default
241 to this much time before the activation date; conversely, if
242 the publication date is specified but activation date isn't,
243 then activation will be set to this much time after publication.
246 If the key is being set to be an explicit successor to another
247 key, then the default prepublication interval is 30 days;
248 otherwise it is zero.
251 As with date offsets, if the argument is followed by one of
252 the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
253 interval is measured in years, months, weeks, days, hours,
254 or minutes, respectively. Without a suffix, the interval is
263 <title>PRINTING OPTIONS</title>
265 <command>dnssec-settime</command> can also be used to print the
266 timing metadata associated with a key.
274 Print times in UNIX epoch format.
280 <term>-p <replaceable class="parameter">C/P/A/R/I/D/all</replaceable></term>
283 Print a specific metadata value or set of metadata values.
284 The <option>-p</option> option may be followed by one or more
285 of the following letters to indicate which value or values to print:
286 <option>C</option> for the creation date,
287 <option>P</option> for the publication date,
288 <option>A</option> for the activation date,
289 <option>R</option> for the revocation date,
290 <option>I</option> for the inactivation date, or
291 <option>D</option> for the deletion date.
292 To print all of the metadata, use <option>-p all</option>.
301 <title>SEE ALSO</title>
303 <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
306 <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
308 <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
309 <citetitle>RFC 5011</citetitle>.
314 <title>AUTHOR</title>
315 <para><corpauthor>Internet Systems Consortium</corpauthor>