external/bsd/bind/dist/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  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.7 2009/11/03 21:44:46 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       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  41     </copyright>
  42   </docinfo>
  43
  44   <refsynopsisdiv>
  45     <cmdsynopsis>
  46       <command>dnssec-settime</command>
  47       <arg><option>-f</option></arg>
  48       <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
  49       <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
  50       <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
  51       <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
  52       <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>
  53       <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
  54       <arg><option>-h</option></arg>
  55       <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
  56       <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
  57       <arg choice="req">keyfile</arg>
  58     </cmdsynopsis>
  59   </refsynopsisdiv>
  60
  61   <refsect1>
  62     <title>DESCRIPTION</title>
  63     <para><command>dnssec-settime</command>
  64       reads a DNSSEC private key file and sets the key timing metadata
  65       as specified by the <option>-P</option>, <option>-A</option>,
  66       <option>-R</option>, <option>-I</option>, and <option>-D</option>
  67       options.  The metadata can then be used by
  68       <command>dnssec-signzone</command> or other signing software to
  69       determine when a key is to be published, whether it should be
  70       used for signing a zone, etc.
  71     </para>
  72     <para>
  73       If none of these options is set on the command line,
  74       then <command>dnssec-settime</command> simply prints the key timing
  75       metadata already stored in the key.
  76     </para>
  77     <para>
  78       When key metadata fields are changed, both files of a key
  79       pair (<filename>Knnnn.+aaa+iiiii.key</filename> and
  80       <filename>Knnnn.+aaa+iiiii.private</filename>) are regenerated.
  81       Metadata fields are stored in the private file.  A human-readable
  82       description of the metadata is also placed in comments in the key
  83       file.
  84     </para>
  85   </refsect1>
  86
  87   <refsect1>
  88     <title>OPTIONS</title>
  89
  90     <variablelist>
  91       <varlistentry>
  92         <term>-f</term>
  93         <listitem>
  94           <para>
  95             Force an update of an old-format key with no metadata fields.
  96             Without this option, <command>dnssec-settime</command> will
  97             fail when attempting to update a legacy key.  With this option,
  98             the key will be recreated in the new format, but with the
  99             original key data retained.  The key's creation date will be
 100             set to the present time.
 101           </para>
 102         </listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term>-K <replaceable class="parameter">directory</replaceable></term>
 107         <listitem>
 108           <para>
 109             Sets the directory in which the key files are to reside.
 110           </para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term>-h</term>
 116         <listitem>
 117           <para>
 118             Emit usage message and exit.
 119           </para>
 120         </listitem>
 121       </varlistentry>
 122
 123       <varlistentry>
 124         <term>-v <replaceable class="parameter">level</replaceable></term>
 125         <listitem>
 126           <para>
 127             Sets the debugging level.
 128           </para>
 129         </listitem>
 130       </varlistentry>
 131
 132       <varlistentry>
 133         <term>-E <replaceable class="parameter">engine</replaceable></term>
 134         <listitem>
 135           <para>
 136             Use the given OpenSSL engine. When compiled with PKCS#11 support
 137             it defaults to pkcs11; the empty name resets it to no engine.
 138           </para>
 139         </listitem>
 140       </varlistentry>
 141     </variablelist>
 142   </refsect1>
 143
 144   <refsect1>
 145     <title>TIMING OPTIONS</title>
 146     <para>
 147       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 148       If the argument begins with a '+' or '-', it is interpreted as
 149       an offset from the present time.  For convenience, if such an offset
 150       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 151       then the offset is computed in years (defined as 365 24-hour days,
 152       ignoring leap years), months (defined as 30 24-hour days), weeks,
 153       days, hours, or minutes, respectively.  Without a suffix, the offset
 154       is computed in seconds.  To unset a date, use 'none'.
 155     </para>
 156
 157     <variablelist>
 158       <varlistentry>
 159         <term>-P <replaceable class="parameter">date/offset</replaceable></term>
 160         <listitem>
 161           <para>
 162             Sets the date on which a key is to be published to the zone.
 163             After that date, the key will be included in the zone but will
 164             not be used to sign it.
 165           </para>
 166         </listitem>
 167       </varlistentry>
 168
 169       <varlistentry>
 170         <term>-A <replaceable class="parameter">date/offset</replaceable></term>
 171         <listitem>
 172           <para>
 173             Sets the date on which the key is to be activated.  After that
 174             date, the key will be included in the zone and used to sign
 175             it.
 176           </para>
 177         </listitem>
 178       </varlistentry>
 179
 180       <varlistentry>
 181         <term>-R <replaceable class="parameter">date/offset</replaceable></term>
 182         <listitem>
 183           <para>
 184             Sets the date on which the key is to be revoked.  After that
 185             date, the key will be flagged as revoked.  It will be included
 186             in the zone and will be used to sign it.
 187           </para>
 188         </listitem>
 189       </varlistentry>
 190
 191       <varlistentry>
 192         <term>-I <replaceable class="parameter">date/offset</replaceable></term>
 193         <listitem>
 194           <para>
 195             Sets the date on which the key is to be retired.  After that
 196             date, the key will still be included in the zone, but it
 197             will not be used to sign it.
 198           </para>
 199         </listitem>
 200       </varlistentry>
 201
 202       <varlistentry>
 203         <term>-D <replaceable class="parameter">date/offset</replaceable></term>
 204         <listitem>
 205           <para>
 206             Sets the date on which the key is to be deleted.  After that
 207             date, the key will no longer be included in the zone.  (It
 208             may remain in the key repository, however.)
 209           </para>
 210         </listitem>
 211       </varlistentry>
 212
 213     </variablelist>
 214   </refsect1>
 215
 216   <refsect1>
 217     <title>PRINTING OPTIONS</title>
 218     <para>
 219       <command>dnssec-settime</command> can also be used to print the
 220       timing metadata associated with a key.
 221     </para>
 222
 223     <variablelist>
 224       <varlistentry>
 225         <term>-u</term>
 226         <listitem>
 227           <para>
 228             Print times in UNIX epoch format.
 229           </para>
 230         </listitem>
 231       </varlistentry>
 232
 233       <varlistentry>
 234         <term>-p <replaceable class="parameter">C/P/A/R/U/D/all</replaceable></term>
 235         <listitem>
 236           <para>
 237             Print a specific metadata value or set of metadata values.
 238             The <option>-p</option> option may be followed by one or more
 239             of the following letters to indicate which value or values to print:
 240             <option>C</option> for the creation date,
 241             <option>P</option> for the publication date,
 242             <option>A</option> for the activation date,
 243             <option>R</option> for the revokation date,
 244             <option>U</option> for the unpublication date, or
 245             <option>D</option> for the deletion date.
 246             To print all of the metadata, use <option>-p all</option>.
 247           </para>
 248         </listitem>
 249       </varlistentry>
 250
 251     </variablelist>
 252   </refsect1>
 253
 254   <refsect1>
 255     <title>SEE ALSO</title>
 256     <para><citerefentry>
 257         <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
 258       </citerefentry>,
 259       <citerefentry>
 260         <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
 261       </citerefentry>,
 262       <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
 263       <citetitle>RFC 5011</citetitle>.
 264     </para>
 265   </refsect1>
 266
 267   <refsect1>
 268     <title>AUTHOR</title>
 269     <para><corpauthor>Internet Systems Consortium</corpauthor>
 270     </para>
 271   </refsect1>
 272
 273 </refentry><!--
 274  - Local variables:
 275  - mode: sgml
 276  - End:
 277 -->