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.2 2011-03-21 23:46:58 tbox 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.
  86     </para>
  87   </refsect1>
  88
  89   <refsect1>
  90     <title>OPTIONS</title>
  91
  92     <variablelist>
  93       <varlistentry>
  94         <term>-f</term>
  95         <listitem>
  96           <para>
  97             Force an update of an old-format key with no metadata fields.
  98             Without this option, <command>dnssec-settime</command> will
  99             fail when attempting to update a legacy key.  With this option,
 100             the key will be recreated in the new format, but with the
 101             original key data retained.  The key's creation date will be
 102             set to the present time.  If no other values are specified,
 103             then the key's publication and activation dates will also
 104             be set to the present time.
 105           </para>
 106         </listitem>
 107       </varlistentry>
 108
 109       <varlistentry>
 110         <term>-K <replaceable class="parameter">directory</replaceable></term>
 111         <listitem>
 112           <para>
 113             Sets the directory in which the key files are to reside.
 114           </para>
 115         </listitem>
 116       </varlistentry>
 117
 118       <varlistentry>
 119         <term>-h</term>
 120         <listitem>
 121           <para>
 122             Emit usage message and exit.
 123           </para>
 124         </listitem>
 125       </varlistentry>
 126
 127       <varlistentry>
 128         <term>-v <replaceable class="parameter">level</replaceable></term>
 129         <listitem>
 130           <para>
 131             Sets the debugging level.
 132           </para>
 133         </listitem>
 134       </varlistentry>
 135
 136       <varlistentry>
 137         <term>-E <replaceable class="parameter">engine</replaceable></term>
 138         <listitem>
 139           <para>
 140             Use the given OpenSSL engine. When compiled with PKCS#11 support
 141             it defaults to pkcs11; the empty name resets it to no engine.
 142           </para>
 143         </listitem>
 144       </varlistentry>
 145     </variablelist>
 146   </refsect1>
 147
 148   <refsect1>
 149     <title>TIMING OPTIONS</title>
 150     <para>
 151       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 152       If the argument begins with a '+' or '-', it is interpreted as
 153       an offset from the present time.  For convenience, if such an offset
 154       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 155       then the offset is computed in years (defined as 365 24-hour days,
 156       ignoring leap years), months (defined as 30 24-hour days), weeks,
 157       days, hours, or minutes, respectively.  Without a suffix, the offset
 158       is computed in seconds.  To unset a date, use 'none'.
 159     </para>
 160
 161     <variablelist>
 162       <varlistentry>
 163         <term>-P <replaceable class="parameter">date/offset</replaceable></term>
 164         <listitem>
 165           <para>
 166             Sets the date on which a key is to be published to the zone.
 167             After that date, the key will be included in the zone but will
 168             not be used to sign it.
 169           </para>
 170         </listitem>
 171       </varlistentry>
 172
 173       <varlistentry>
 174         <term>-A <replaceable class="parameter">date/offset</replaceable></term>
 175         <listitem>
 176           <para>
 177             Sets the date on which the key is to be activated.  After that
 178             date, the key will be included in the zone and used to sign
 179             it.
 180           </para>
 181         </listitem>
 182       </varlistentry>
 183
 184       <varlistentry>
 185         <term>-R <replaceable class="parameter">date/offset</replaceable></term>
 186         <listitem>
 187           <para>
 188             Sets the date on which the key is to be revoked.  After that
 189             date, the key will be flagged as revoked.  It will be included
 190             in the zone and will be used to sign it.
 191           </para>
 192         </listitem>
 193       </varlistentry>
 194
 195       <varlistentry>
 196         <term>-I <replaceable class="parameter">date/offset</replaceable></term>
 197         <listitem>
 198           <para>
 199             Sets the date on which the key is to be retired.  After that
 200             date, the key will still be included in the zone, but it
 201             will not be used to sign it.
 202           </para>
 203         </listitem>
 204       </varlistentry>
 205
 206       <varlistentry>
 207         <term>-D <replaceable class="parameter">date/offset</replaceable></term>
 208         <listitem>
 209           <para>
 210             Sets the date on which the key is to be deleted.  After that
 211             date, the key will no longer be included in the zone.  (It
 212             may remain in the key repository, however.)
 213           </para>
 214         </listitem>
 215       </varlistentry>
 216
 217       <varlistentry>
 218         <term>-S <replaceable class="parameter">predecessor key</replaceable></term>
 219         <listitem>
 220           <para>
 221             Select a key for which the key being modified will be an
 222             explicit successor.  The name, algorithm, size, and type of the
 223             predecessor key must exactly match those of the key being
 224             modified.  The activation date of the successor key will be set
 225             to the inactivation date of the predecessor.  The publication
 226             date will be set to the activation date minus the prepublication
 227             interval, which defaults to 30 days.
 228           </para>
 229         </listitem>
 230       </varlistentry>
 231
 232       <varlistentry>
 233         <term>-i <replaceable class="parameter">interval</replaceable></term>
 234         <listitem>
 235           <para>
 236             Sets the prepublication interval for a key.  If set, then
 237             the publication and activation dates must be separated by at least
 238             this much time.  If the activation date is specified but the
 239             publication date isn't, then the publication date will default
 240             to this much time before the activation date; conversely, if
 241             the publication date is specified but activation date isn't,
 242             then activation will be set to this much time after publication.
 243           </para>
 244           <para>
 245             If the key is being set to be an explicit successor to another
 246             key, then the default prepublication interval is 30 days;
 247             otherwise it is zero.
 248           </para>
 249           <para>
 250             As with date offsets, if the argument is followed by one of
 251             the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
 252             interval is measured in years, months, weeks, days, hours,
 253             or minutes, respectively.  Without a suffix, the interval is
 254             measured in seconds.
 255           </para>
 256         </listitem>
 257       </varlistentry>
 258     </variablelist>
 259   </refsect1>
 260
 261   <refsect1>
 262     <title>PRINTING OPTIONS</title>
 263     <para>
 264       <command>dnssec-settime</command> can also be used to print the
 265       timing metadata associated with a key.
 266     </para>
 267
 268     <variablelist>
 269       <varlistentry>
 270         <term>-u</term>
 271         <listitem>
 272           <para>
 273             Print times in UNIX epoch format.
 274           </para>
 275         </listitem>
 276       </varlistentry>
 277
 278       <varlistentry>
 279         <term>-p <replaceable class="parameter">C/P/A/R/I/D/all</replaceable></term>
 280         <listitem>
 281           <para>
 282             Print a specific metadata value or set of metadata values.
 283             The <option>-p</option> option may be followed by one or more
 284             of the following letters to indicate which value or values to print:
 285             <option>C</option> for the creation date,
 286             <option>P</option> for the publication date,
 287             <option>A</option> for the activation date,
 288             <option>R</option> for the revocation date,
 289             <option>I</option> for the inactivation date, or
 290             <option>D</option> for the deletion date.
 291             To print all of the metadata, use <option>-p all</option>.
 292           </para>
 293         </listitem>
 294       </varlistentry>
 295
 296     </variablelist>
 297   </refsect1>
 298
 299   <refsect1>
 300     <title>SEE ALSO</title>
 301     <para><citerefentry>
 302         <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
 303       </citerefentry>,
 304       <citerefentry>
 305         <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
 306       </citerefentry>,
 307       <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
 308       <citetitle>RFC 5011</citetitle>.
 309     </para>
 310   </refsect1>
 311
 312   <refsect1>
 313     <title>AUTHOR</title>
 314     <para><corpauthor>Internet Systems Consortium</corpauthor>
 315     </para>
 316   </refsect1>
 317
 318 </refentry><!--
 319  - Local variables:
 320  - mode: sgml
 321  - End:
 322 -->