contrib/bind9/doc/arm/man.dnssec-settime.html

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