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

   1 <!--
   2  - Copyright (C) 2009-2011 Internet Systems Consortium, Inc. ("ISC")
   3  -
   4  - Permission to use, copy, modify, and/or distribute this software for any
   5  - purpose with or without fee is hereby granted, provided that the above
   6  - copyright notice and this permission notice appear in all copies.
   7  -
   8  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14  - PERFORMANCE OF THIS SOFTWARE.
  15 -->
  16 <!-- $Id$ -->
  17 <html>
  18 <head>
  19 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  20 <title>dnssec-settime</title>
  21 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  22 </head>
  23 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
  24 <a name="man.dnssec-settime"></a><div class="titlepage"></div>
  25 <div class="refnamediv">
  26 <h2>Name</h2>
  27 <p><span class="application">dnssec-settime</span> &#8212; Set the key timing metadata for a DNSSEC key</p>
  28 </div>
  29 <div class="refsynopsisdiv">
  30 <h2>Synopsis</h2>
  31 <div class="cmdsynopsis"><p><code class="command">dnssec-settime</code>  [<code class="option">-f</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] {keyfile}</p></div>
  32 </div>
  33 <div class="refsect1" lang="en">
  34 <a name="id2543424"></a><h2>DESCRIPTION</h2>
  35 <p><span><strong class="command">dnssec-settime</strong></span>
  36       reads a DNSSEC private key file and sets the key timing metadata
  37       as specified by the <code class="option">-P</code>, <code class="option">-A</code>,
  38       <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code>
  39       options.  The metadata can then be used by
  40       <span><strong class="command">dnssec-signzone</strong></span> or other signing software to
  41       determine when a key is to be published, whether it should be
  42       used for signing a zone, etc.
  43     </p>
  44 <p>
  45       If none of these options is set on the command line,
  46       then <span><strong class="command">dnssec-settime</strong></span> simply prints the key timing
  47       metadata already stored in the key.
  48     </p>
  49 <p>
  50       When key metadata fields are changed, both files of a key
  51       pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and
  52       <code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated.
  53       Metadata fields are stored in the private file.  A human-readable
  54       description of the metadata is also placed in comments in the key
  55       file.  The private file's permissions are always set to be
  56       inaccessible to anyone other than the owner (mode 0600).
  57     </p>
  58 </div>
  59 <div class="refsect1" lang="en">
  60 <a name="id2543472"></a><h2>OPTIONS</h2>
  61 <div class="variablelist"><dl>
  62 <dt><span class="term">-f</span></dt>
  63 <dd><p>
  64             Force an update of an old-format key with no metadata fields.
  65             Without this option, <span><strong class="command">dnssec-settime</strong></span> will
  66             fail when attempting to update a legacy key.  With this option,
  67             the key will be recreated in the new format, but with the
  68             original key data retained.  The key's creation date will be
  69             set to the present time.  If no other values are specified,
  70             then the key's publication and activation dates will also
  71             be set to the present time.
  72           </p></dd>
  73 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
  74 <dd><p>
  75             Sets the directory in which the key files are to reside.
  76           </p></dd>
  77 <dt><span class="term">-h</span></dt>
  78 <dd><p>
  79             Emit usage message and exit.
  80           </p></dd>
  81 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
  82 <dd><p>
  83             Sets the debugging level.
  84           </p></dd>
  85 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
  86 <dd><p>
  87             Use the given OpenSSL engine. When compiled with PKCS#11 support
  88             it defaults to pkcs11; the empty name resets it to no engine.
  89           </p></dd>
  90 </dl></div>
  91 </div>
  92 <div class="refsect1" lang="en">
  93 <a name="id2543563"></a><h2>TIMING OPTIONS</h2>
  94 <p>
  95       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
  96       If the argument begins with a '+' or '-', it is interpreted as
  97       an offset from the present time.  For convenience, if such an offset
  98       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
  99       then the offset is computed in years (defined as 365 24-hour days,
 100       ignoring leap years), months (defined as 30 24-hour days), weeks,
 101       days, hours, or minutes, respectively.  Without a suffix, the offset
 102       is computed in seconds.  To unset a date, use 'none'.
 103     </p>
 104 <div class="variablelist"><dl>
 105 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 106 <dd><p>
 107             Sets the date on which a key is to be published to the zone.
 108             After that date, the key will be included in the zone but will
 109             not be used to sign it.
 110           </p></dd>
 111 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
 112 <dd><p>
 113             Sets the date on which the key is to be activated.  After that
 114             date, the key will be included in the zone and used to sign
 115             it.
 116           </p></dd>
 117 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
 118 <dd><p>
 119             Sets the date on which the key is to be revoked.  After that
 120             date, the key will be flagged as revoked.  It will be included
 121             in the zone and will be used to sign it.
 122           </p></dd>
 123 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
 124 <dd><p>
 125             Sets the date on which the key is to be retired.  After that
 126             date, the key will still be included in the zone, but it
 127             will not be used to sign it.
 128           </p></dd>
 129 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 130 <dd><p>
 131             Sets the date on which the key is to be deleted.  After that
 132             date, the key will no longer be included in the zone.  (It
 133             may remain in the key repository, however.)
 134           </p></dd>
 135 <dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt>
 136 <dd><p>
 137             Select a key for which the key being modified will be an
 138             explicit successor.  The name, algorithm, size, and type of the
 139             predecessor key must exactly match those of the key being
 140             modified.  The activation date of the successor key will be set
 141             to the inactivation date of the predecessor.  The publication
 142             date will be set to the activation date minus the prepublication
 143             interval, which defaults to 30 days.
 144           </p></dd>
 145 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
 146 <dd>
 147 <p>
 148             Sets the prepublication interval for a key.  If set, then
 149             the publication and activation dates must be separated by at least
 150             this much time.  If the activation date is specified but the
 151             publication date isn't, then the publication date will default
 152             to this much time before the activation date; conversely, if
 153             the publication date is specified but activation date isn't,
 154             then activation will be set to this much time after publication.
 155           </p>
 156 <p>
 157             If the key is being set to be an explicit successor to another
 158             key, then the default prepublication interval is 30 days;
 159             otherwise it is zero.
 160           </p>
 161 <p>
 162             As with date offsets, if the argument is followed by one of
 163             the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
 164             interval is measured in years, months, weeks, days, hours,
 165             or minutes, respectively.  Without a suffix, the interval is
 166             measured in seconds.
 167           </p>
 168 </dd>
 169 </dl></div>
 170 </div>
 171 <div class="refsect1" lang="en">
 172 <a name="id2543770"></a><h2>PRINTING OPTIONS</h2>
 173 <p>
 174       <span><strong class="command">dnssec-settime</strong></span> can also be used to print the
 175       timing metadata associated with a key.
 176     </p>
 177 <div class="variablelist"><dl>
 178 <dt><span class="term">-u</span></dt>
 179 <dd><p>
 180             Print times in UNIX epoch format.
 181           </p></dd>
 182 <dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/I/D/all</code></em></span></dt>
 183 <dd><p>
 184             Print a specific metadata value or set of metadata values.
 185             The <code class="option">-p</code> option may be followed by one or more
 186             of the following letters to indicate which value or values to print:
 187             <code class="option">C</code> for the creation date,
 188             <code class="option">P</code> for the publication date,
 189             <code class="option">A</code> for the activation date,
 190             <code class="option">R</code> for the revocation date,
 191             <code class="option">I</code> for the inactivation date, or
 192             <code class="option">D</code> for the deletion date.
 193             To print all of the metadata, use <code class="option">-p all</code>.
 194           </p></dd>
 195 </dl></div>
 196 </div>
 197 <div class="refsect1" lang="en">
 198 <a name="id2543848"></a><h2>SEE ALSO</h2>
 199 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 200       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 201       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 202       <em class="citetitle">RFC 5011</em>.
 203     </p>
 204 </div>
 205 <div class="refsect1" lang="en">
 206 <a name="id2543881"></a><h2>AUTHOR</h2>
 207 <p><span class="corpauthor">Internet Systems Consortium</span>
 208     </p>
 209 </div>
 210 </div></body>
 211 </html>