/contrib/bind9/bin/dnssec/dnssec-settime.docbook

  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 "&#8212;">]>
  4<!--
  5 - Copyright (C) 2009-2011  Internet Systems Consortium, Inc. ("ISC")
  6 -
  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.
 10 -
 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.
 18-->
 19
 20<!-- $Id: dnssec-settime.docbook,v 1.11.70.3 2011/11/03 20:21:30 each Exp $ -->
 21<refentry id="man.dnssec-settime">
 22  <refentryinfo>
 23    <date>July 15, 2009</date>
 24  </refentryinfo>
 25
 26  <refmeta>
 27    <refentrytitle><application>dnssec-settime</application></refentrytitle>
 28    <manvolnum>8</manvolnum>
 29    <refmiscinfo>BIND9</refmiscinfo>
 30  </refmeta>
 31
 32  <refnamediv>
 33    <refname><application>dnssec-settime</application></refname>
 34    <refpurpose>Set the key timing metadata for a DNSSEC key</refpurpose>
 35  </refnamediv>
 36
 37  <docinfo>
 38    <copyright>
 39      <year>2009</year>
 40      <year>2010</year>
 41      <year>2011</year>
 42      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
 43    </copyright>
 44  </docinfo>
 45
 46  <refsynopsisdiv>
 47    <cmdsynopsis>
 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>
 60    </cmdsynopsis>
 61  </refsynopsisdiv>
 62
 63  <refsect1>
 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.
 73    </para>
 74    <para>
 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.
 78    </para>
 79    <para>
 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).
 87    </para>
 88  </refsect1>
 89
 90  <refsect1>
 91    <title>OPTIONS</title>
 92
 93    <variablelist>
 94      <varlistentry>
 95	<term>-f</term>
 96        <listitem>
 97	  <para>
 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.
106	  </para>
107        </listitem>
108      </varlistentry>
109  
110      <varlistentry>
111        <term>-K <replaceable class="parameter">directory</replaceable></term>
112        <listitem>
113          <para>
114            Sets the directory in which the key files are to reside.
115          </para>
116        </listitem>
117      </varlistentry>
118
119      <varlistentry>
120	<term>-h</term>
121        <listitem>
122	  <para>
123	    Emit usage message and exit.
124	  </para>
125        </listitem>
126      </varlistentry>
127  
128      <varlistentry>
129        <term>-v <replaceable class="parameter">level</replaceable></term>
130        <listitem>
131          <para>
132            Sets the debugging level.
133          </para>
134        </listitem>
135      </varlistentry>
136
137      <varlistentry>
138        <term>-E <replaceable class="parameter">engine</replaceable></term>
139        <listitem>
140          <para>
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.
143          </para>
144        </listitem>
145      </varlistentry>
146    </variablelist>
147  </refsect1>
148
149  <refsect1>
150    <title>TIMING OPTIONS</title>
151    <para>
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'.
160    </para>
161
162    <variablelist>
163      <varlistentry>
164        <term>-P <replaceable class="parameter">date/offset</replaceable></term>
165        <listitem>
166          <para>
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.
170          </para>
171        </listitem>
172      </varlistentry>
173
174      <varlistentry>
175        <term>-A <replaceable class="parameter">date/offset</replaceable></term>
176        <listitem>
177          <para>
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
180            it.
181          </para>
182        </listitem>
183      </varlistentry>
184
185      <varlistentry>
186        <term>-R <replaceable class="parameter">date/offset</replaceable></term>
187        <listitem>
188          <para>
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.
192          </para>
193        </listitem>
194      </varlistentry>
195
196      <varlistentry>
197        <term>-I <replaceable class="parameter">date/offset</replaceable></term>
198        <listitem>
199          <para>
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.
203          </para>
204        </listitem>
205      </varlistentry>
206
207      <varlistentry>
208        <term>-D <replaceable class="parameter">date/offset</replaceable></term>
209        <listitem>
210          <para>
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.)
214          </para>
215        </listitem>
216      </varlistentry>
217
218      <varlistentry>
219        <term>-S <replaceable class="parameter">predecessor key</replaceable></term>
220        <listitem>
221          <para>
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.
229          </para>
230        </listitem>
231      </varlistentry>
232
233      <varlistentry>
234        <term>-i <replaceable class="parameter">interval</replaceable></term>
235        <listitem>
236          <para>
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.
244          </para>
245          <para>
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.
249          </para>
250          <para>
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
255            measured in seconds.
256          </para>
257        </listitem>
258      </varlistentry>
259    </variablelist>
260  </refsect1>
261
262  <refsect1>
263    <title>PRINTING OPTIONS</title>
264    <para>
265      <command>dnssec-settime</command> can also be used to print the
266      timing metadata associated with a key.
267    </para>
268
269    <variablelist>
270      <varlistentry>
271	<term>-u</term>
272        <listitem>
273	  <para>
274	    Print times in UNIX epoch format.
275	  </para>
276        </listitem>
277      </varlistentry>
278
279      <varlistentry>
280        <term>-p <replaceable class="parameter">C/P/A/R/I/D/all</replaceable></term>
281        <listitem>
282	  <para>
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>.
293	  </para>
294        </listitem>
295      </varlistentry>
296
297    </variablelist>
298  </refsect1>
299
300  <refsect1>
301    <title>SEE ALSO</title>
302    <para><citerefentry>
303        <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
304      </citerefentry>,
305      <citerefentry>
306        <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
307      </citerefentry>,
308      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
309      <citetitle>RFC 5011</citetitle>.
310    </para>
311  </refsect1>
312
313  <refsect1>
314    <title>AUTHOR</title>
315    <para><corpauthor>Internet Systems Consortium</corpauthor>
316    </para>
317  </refsect1>
318
319</refentry><!--
320 - Local variables:
321 - mode: sgml
322 - End:
323-->