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: dnssec-settime.html,v 1.14.70.1 2011-03-22 02:37:44 tbox Exp $ -->
  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="id2543422"></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.
  56     </p>
  57 </div>
  58 <div class="refsect1" lang="en">
  59 <a name="id2543470"></a><h2>OPTIONS</h2>
  60 <div class="variablelist"><dl>
  61 <dt><span class="term">-f</span></dt>
  62 <dd><p>
  63             Force an update of an old-format key with no metadata fields.
  64             Without this option, <span><strong class="command">dnssec-settime</strong></span> will
  65             fail when attempting to update a legacy key.  With this option,
  66             the key will be recreated in the new format, but with the
  67             original key data retained.  The key's creation date will be
  68             set to the present time.  If no other values are specified,
  69             then the key's publication and activation dates will also
  70             be set to the present time.
  71           </p></dd>
  72 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
  73 <dd><p>
  74             Sets the directory in which the key files are to reside.
  75           </p></dd>
  76 <dt><span class="term">-h</span></dt>
  77 <dd><p>
  78             Emit usage message and exit.
  79           </p></dd>
  80 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
  81 <dd><p>
  82             Sets the debugging level.
  83           </p></dd>
  84 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
  85 <dd><p>
  86             Use the given OpenSSL engine. When compiled with PKCS#11 support
  87             it defaults to pkcs11; the empty name resets it to no engine.
  88           </p></dd>
  89 </dl></div>
  90 </div>
  91 <div class="refsect1" lang="en">
  92 <a name="id2543562"></a><h2>TIMING OPTIONS</h2>
  93 <p>
  94       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
  95       If the argument begins with a '+' or '-', it is interpreted as
  96       an offset from the present time.  For convenience, if such an offset
  97       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
  98       then the offset is computed in years (defined as 365 24-hour days,
  99       ignoring leap years), months (defined as 30 24-hour days), weeks,
 100       days, hours, or minutes, respectively.  Without a suffix, the offset
 101       is computed in seconds.  To unset a date, use 'none'.
 102     </p>
 103 <div class="variablelist"><dl>
 104 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 105 <dd><p>
 106             Sets the date on which a key is to be published to the zone.
 107             After that date, the key will be included in the zone but will
 108             not be used to sign it.
 109           </p></dd>
 110 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
 111 <dd><p>
 112             Sets the date on which the key is to be activated.  After that
 113             date, the key will be included in the zone and used to sign
 114             it.
 115           </p></dd>
 116 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
 117 <dd><p>
 118             Sets the date on which the key is to be revoked.  After that
 119             date, the key will be flagged as revoked.  It will be included
 120             in the zone and will be used to sign it.
 121           </p></dd>
 122 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
 123 <dd><p>
 124             Sets the date on which the key is to be retired.  After that
 125             date, the key will still be included in the zone, but it
 126             will not be used to sign it.
 127           </p></dd>
 128 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 129 <dd><p>
 130             Sets the date on which the key is to be deleted.  After that
 131             date, the key will no longer be included in the zone.  (It
 132             may remain in the key repository, however.)
 133           </p></dd>
 134 <dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt>
 135 <dd><p>
 136             Select a key for which the key being modified will be an
 137             explicit successor.  The name, algorithm, size, and type of the
 138             predecessor key must exactly match those of the key being
 139             modified.  The activation date of the successor key will be set
 140             to the inactivation date of the predecessor.  The publication
 141             date will be set to the activation date minus the prepublication
 142             interval, which defaults to 30 days.
 143           </p></dd>
 144 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
 145 <dd>
 146 <p>
 147             Sets the prepublication interval for a key.  If set, then
 148             the publication and activation dates must be separated by at least
 149             this much time.  If the activation date is specified but the
 150             publication date isn't, then the publication date will default
 151             to this much time before the activation date; conversely, if
 152             the publication date is specified but activation date isn't,
 153             then activation will be set to this much time after publication.
 154           </p>
 155 <p>
 156             If the key is being set to be an explicit successor to another
 157             key, then the default prepublication interval is 30 days;
 158             otherwise it is zero.
 159           </p>
 160 <p>
 161             As with date offsets, if the argument is followed by one of
 162             the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
 163             interval is measured in years, months, weeks, days, hours,
 164             or minutes, respectively.  Without a suffix, the interval is
 165             measured in seconds.
 166           </p>
 167 </dd>
 168 </dl></div>
 169 </div>
 170 <div class="refsect1" lang="en">
 171 <a name="id2543701"></a><h2>PRINTING OPTIONS</h2>
 172 <p>
 173       <span><strong class="command">dnssec-settime</strong></span> can also be used to print the
 174       timing metadata associated with a key.
 175     </p>
 176 <div class="variablelist"><dl>
 177 <dt><span class="term">-u</span></dt>
 178 <dd><p>
 179             Print times in UNIX epoch format.
 180           </p></dd>
 181 <dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/I/D/all</code></em></span></dt>
 182 <dd><p>
 183             Print a specific metadata value or set of metadata values.
 184             The <code class="option">-p</code> option may be followed by one or more
 185             of the following letters to indicate which value or values to print:
 186             <code class="option">C</code> for the creation date,
 187             <code class="option">P</code> for the publication date,
 188             <code class="option">A</code> for the activation date,
 189             <code class="option">R</code> for the revocation date,
 190             <code class="option">I</code> for the inactivation date, or
 191             <code class="option">D</code> for the deletion date.
 192             To print all of the metadata, use <code class="option">-p all</code>.
 193           </p></dd>
 194 </dl></div>
 195 </div>
 196 <div class="refsect1" lang="en">
 197 <a name="id2543915"></a><h2>SEE ALSO</h2>
 198 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 199       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 200       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 201       <em class="citetitle">RFC 5011</em>.
 202     </p>
 203 </div>
 204 <div class="refsect1" lang="en">
 205 <a name="id2543948"></a><h2>AUTHOR</h2>
 206 <p><span class="corpauthor">Internet Systems Consortium</span>
 207     </p>
 208 </div>
 209 </div></body>
 210 </html>