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, 2014  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 <refentry id="man.dnssec-settime">
  21   <refentryinfo>
  22     <date>February 07, 2014</date>
  23   </refentryinfo>
  24
  25   <refmeta>
  26     <refentrytitle><application>dnssec-settime</application></refentrytitle>
  27     <manvolnum>8</manvolnum>
  28     <refmiscinfo>BIND9</refmiscinfo>
  29   </refmeta>
  30
  31   <refnamediv>
  32     <refname><application>dnssec-settime</application></refname>
  33     <refpurpose>Set the key timing metadata for a DNSSEC key</refpurpose>
  34   </refnamediv>
  35
  36   <docinfo>
  37     <copyright>
  38       <year>2009</year>
  39       <year>2010</year>
  40       <year>2011</year>
  41       <year>2014</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>-L <replaceable class="parameter">ttl</replaceable></option></arg>
  52       <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
  53       <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
  54       <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
  55       <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>
  56       <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
  57       <arg><option>-h</option></arg>
  58       <arg><option>-V</option></arg>
  59       <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
  60       <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
  61       <arg choice="req">keyfile</arg>
  62     </cmdsynopsis>
  63   </refsynopsisdiv>
  64
  65   <refsect1>
  66     <title>DESCRIPTION</title>
  67     <para><command>dnssec-settime</command>
  68       reads a DNSSEC private key file and sets the key timing metadata
  69       as specified by the <option>-P</option>, <option>-A</option>,
  70       <option>-R</option>, <option>-I</option>, and <option>-D</option>
  71       options.  The metadata can then be used by
  72       <command>dnssec-signzone</command> or other signing software to
  73       determine when a key is to be published, whether it should be
  74       used for signing a zone, etc.
  75     </para>
  76     <para>
  77       If none of these options is set on the command line,
  78       then <command>dnssec-settime</command> simply prints the key timing
  79       metadata already stored in the key.
  80     </para>
  81     <para>
  82       When key metadata fields are changed, both files of a key
  83       pair (<filename>Knnnn.+aaa+iiiii.key</filename> and
  84       <filename>Knnnn.+aaa+iiiii.private</filename>) are regenerated.
  85       Metadata fields are stored in the private file.  A human-readable
  86       description of the metadata is also placed in comments in the key
  87       file.  The private file's permissions are always set to be
  88       inaccessible to anyone other than the owner (mode 0600).
  89     </para>
  90   </refsect1>
  91
  92   <refsect1>
  93     <title>OPTIONS</title>
  94
  95     <variablelist>
  96       <varlistentry>
  97         <term>-f</term>
  98         <listitem>
  99           <para>
 100             Force an update of an old-format key with no metadata fields.
 101             Without this option, <command>dnssec-settime</command> will
 102             fail when attempting to update a legacy key.  With this option,
 103             the key will be recreated in the new format, but with the
 104             original key data retained.  The key's creation date will be
 105             set to the present time.  If no other values are specified,
 106             then the key's publication and activation dates will also
 107             be set to the present time.
 108           </para>
 109         </listitem>
 110       </varlistentry>
 111
 112       <varlistentry>
 113         <term>-K <replaceable class="parameter">directory</replaceable></term>
 114         <listitem>
 115           <para>
 116             Sets the directory in which the key files are to reside.
 117           </para>
 118         </listitem>
 119       </varlistentry>
 120
 121       <varlistentry>
 122         <term>-L <replaceable class="parameter">ttl</replaceable></term>
 123         <listitem>
 124           <para>
 125             Sets the default TTL to use for this key when it is converted
 126             into a DNSKEY RR.  If the key is imported into a zone,
 127             this is the TTL that will be used for it, unless there was
 128             already a DNSKEY RRset in place, in which case the existing TTL
 129             would take precedence.  Setting the default TTL to
 130             <literal>0</literal> or <literal>none</literal> removes it.
 131           </para>
 132         </listitem>
 133       </varlistentry>
 134
 135       <varlistentry>
 136         <term>-h</term>
 137         <listitem>
 138           <para>
 139             Emit usage message and exit.
 140           </para>
 141         </listitem>
 142       </varlistentry>
 143
 144       <varlistentry>
 145         <term>-V</term>
 146         <listitem>
 147           <para>
 148             Prints version information.
 149           </para>
 150         </listitem>
 151       </varlistentry>
 152
 153       <varlistentry>
 154         <term>-v <replaceable class="parameter">level</replaceable></term>
 155         <listitem>
 156           <para>
 157             Sets the debugging level.
 158           </para>
 159         </listitem>
 160       </varlistentry>
 161
 162       <varlistentry>
 163         <term>-E <replaceable class="parameter">engine</replaceable></term>
 164         <listitem>
 165           <para>
 166             Use the given OpenSSL engine. When compiled with PKCS#11 support
 167             it defaults to pkcs11; the empty name resets it to no engine.
 168           </para>
 169         </listitem>
 170       </varlistentry>
 171     </variablelist>
 172   </refsect1>
 173
 174   <refsect1>
 175     <title>TIMING OPTIONS</title>
 176     <para>
 177       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 178       If the argument begins with a '+' or '-', it is interpreted as
 179       an offset from the present time.  For convenience, if such an offset
 180       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 181       then the offset is computed in years (defined as 365 24-hour days,
 182       ignoring leap years), months (defined as 30 24-hour days), weeks,
 183       days, hours, or minutes, respectively.  Without a suffix, the offset
 184       is computed in seconds.  To unset a date, use 'none' or 'never'.
 185     </para>
 186
 187     <variablelist>
 188       <varlistentry>
 189         <term>-P <replaceable class="parameter">date/offset</replaceable></term>
 190         <listitem>
 191           <para>
 192             Sets the date on which a key is to be published to the zone.
 193             After that date, the key will be included in the zone but will
 194             not be used to sign it.
 195           </para>
 196         </listitem>
 197       </varlistentry>
 198
 199       <varlistentry>
 200         <term>-A <replaceable class="parameter">date/offset</replaceable></term>
 201         <listitem>
 202           <para>
 203             Sets the date on which the key is to be activated.  After that
 204             date, the key will be included in the zone and used to sign
 205             it.
 206           </para>
 207         </listitem>
 208       </varlistentry>
 209
 210       <varlistentry>
 211         <term>-R <replaceable class="parameter">date/offset</replaceable></term>
 212         <listitem>
 213           <para>
 214             Sets the date on which the key is to be revoked.  After that
 215             date, the key will be flagged as revoked.  It will be included
 216             in the zone and will be used to sign it.
 217           </para>
 218         </listitem>
 219       </varlistentry>
 220
 221       <varlistentry>
 222         <term>-I <replaceable class="parameter">date/offset</replaceable></term>
 223         <listitem>
 224           <para>
 225             Sets the date on which the key is to be retired.  After that
 226             date, the key will still be included in the zone, but it
 227             will not be used to sign it.
 228           </para>
 229         </listitem>
 230       </varlistentry>
 231
 232       <varlistentry>
 233         <term>-D <replaceable class="parameter">date/offset</replaceable></term>
 234         <listitem>
 235           <para>
 236             Sets the date on which the key is to be deleted.  After that
 237             date, the key will no longer be included in the zone.  (It
 238             may remain in the key repository, however.)
 239           </para>
 240         </listitem>
 241       </varlistentry>
 242
 243       <varlistentry>
 244         <term>-S <replaceable class="parameter">predecessor key</replaceable></term>
 245         <listitem>
 246           <para>
 247             Select a key for which the key being modified will be an
 248             explicit successor.  The name, algorithm, size, and type of the
 249             predecessor key must exactly match those of the key being
 250             modified.  The activation date of the successor key will be set
 251             to the inactivation date of the predecessor.  The publication
 252             date will be set to the activation date minus the prepublication
 253             interval, which defaults to 30 days.
 254           </para>
 255         </listitem>
 256       </varlistentry>
 257
 258       <varlistentry>
 259         <term>-i <replaceable class="parameter">interval</replaceable></term>
 260         <listitem>
 261           <para>
 262             Sets the prepublication interval for a key.  If set, then
 263             the publication and activation dates must be separated by at least
 264             this much time.  If the activation date is specified but the
 265             publication date isn't, then the publication date will default
 266             to this much time before the activation date; conversely, if
 267             the publication date is specified but activation date isn't,
 268             then activation will be set to this much time after publication.
 269           </para>
 270           <para>
 271             If the key is being set to be an explicit successor to another
 272             key, then the default prepublication interval is 30 days;
 273             otherwise it is zero.
 274           </para>
 275           <para>
 276             As with date offsets, if the argument is followed by one of
 277             the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
 278             interval is measured in years, months, weeks, days, hours,
 279             or minutes, respectively.  Without a suffix, the interval is
 280             measured in seconds.
 281           </para>
 282         </listitem>
 283       </varlistentry>
 284     </variablelist>
 285   </refsect1>
 286
 287   <refsect1>
 288     <title>PRINTING OPTIONS</title>
 289     <para>
 290       <command>dnssec-settime</command> can also be used to print the
 291       timing metadata associated with a key.
 292     </para>
 293
 294     <variablelist>
 295       <varlistentry>
 296         <term>-u</term>
 297         <listitem>
 298           <para>
 299             Print times in UNIX epoch format.
 300           </para>
 301         </listitem>
 302       </varlistentry>
 303
 304       <varlistentry>
 305         <term>-p <replaceable class="parameter">C/P/A/R/I/D/all</replaceable></term>
 306         <listitem>
 307           <para>
 308             Print a specific metadata value or set of metadata values.
 309             The <option>-p</option> option may be followed by one or more
 310             of the following letters to indicate which value or values to print:
 311             <option>C</option> for the creation date,
 312             <option>P</option> for the publication date,
 313             <option>A</option> for the activation date,
 314             <option>R</option> for the revocation date,
 315             <option>I</option> for the inactivation date, or
 316             <option>D</option> for the deletion date.
 317             To print all of the metadata, use <option>-p all</option>.
 318           </para>
 319         </listitem>
 320       </varlistentry>
 321
 322     </variablelist>
 323   </refsect1>
 324
 325   <refsect1>
 326     <title>SEE ALSO</title>
 327     <para><citerefentry>
 328         <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
 329       </citerefentry>,
 330       <citerefentry>
 331         <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
 332       </citerefentry>,
 333       <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
 334       <citetitle>RFC 5011</citetitle>.
 335     </para>
 336   </refsect1>
 337
 338   <refsect1>
 339     <title>AUTHOR</title>
 340     <para><corpauthor>Internet Systems Consortium</corpauthor>
 341     </para>
 342   </refsect1>
 343
 344 </refentry><!--
 345  - Local variables:
 346  - mode: sgml
 347  - End:
 348 -->