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

   1 <!--
   2  - Copyright (C) 2009-2011, 2014, 2015 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 <html>
  17 <head>
  18 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  19 <title>dnssec-settime</title>
  20 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
  21 </head>
  22 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
  23 <a name="man.dnssec-settime"></a><div class="titlepage"></div>
  24 <div class="refnamediv">
  25 <h2>Name</h2>
  26 <p><span class="application">dnssec-settime</span> &#8212; Set the key timing metadata for a DNSSEC key</p>
  27 </div>
  28 <div class="refsynopsisdiv">
  29 <h2>Synopsis</h2>
  30 <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>
  31 </div>
  32 <div class="refsection">
  33 <a name="id-1.7"></a><h2>DESCRIPTION</h2>
  34 <p><span class="command"><strong>dnssec-settime</strong></span>
  35       reads a DNSSEC private key file and sets the key timing metadata
  36       as specified by the <code class="option">-P</code>, <code class="option">-A</code>,
  37       <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code>
  38       options.  The metadata can then be used by
  39       <span class="command"><strong>dnssec-signzone</strong></span> or other signing software to
  40       determine when a key is to be published, whether it should be
  41       used for signing a zone, etc.
  42     </p>
  43 <p>
  44       If none of these options is set on the command line,
  45       then <span class="command"><strong>dnssec-settime</strong></span> simply prints the key timing
  46       metadata already stored in the key.
  47     </p>
  48 <p>
  49       When key metadata fields are changed, both files of a key
  50       pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and
  51       <code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated.
  52       Metadata fields are stored in the private file.  A human-readable
  53       description of the metadata is also placed in comments in the key
  54       file.  The private file's permissions are always set to be
  55       inaccessible to anyone other than the owner (mode 0600).
  56     </p>
  57 </div>
  58 <div class="refsection">
  59 <a name="id-1.8"></a><h2>OPTIONS</h2>
  60 <div class="variablelist"><dl class="variablelist">
  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 class="command"><strong>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">-L <em class="replaceable"><code>ttl</code></em></span></dt>
  77 <dd><p>
  78             Sets the default TTL to use for this key when it is converted
  79             into a DNSKEY RR.  If the key is imported into a zone,
  80             this is the TTL that will be used for it, unless there was
  81             already a DNSKEY RRset in place, in which case the existing TTL
  82             would take precedence.  If this value is not set and there
  83             is no existing DNSKEY RRset, the TTL will default to the
  84             SOA TTL. Setting the default TTL to <code class="literal">0</code>
  85             or <code class="literal">none</code> removes it from the key.
  86           </p></dd>
  87 <dt><span class="term">-h</span></dt>
  88 <dd><p>
  89             Emit usage message and exit.
  90           </p></dd>
  91 <dt><span class="term">-V</span></dt>
  92 <dd><p>
  93             Prints version information.
  94           </p></dd>
  95 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
  96 <dd><p>
  97             Sets the debugging level.
  98           </p></dd>
  99 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
 100 <dd><p>
 101             Use the given OpenSSL engine. When compiled with PKCS#11 support
 102             it defaults to pkcs11; the empty name resets it to no engine.
 103           </p></dd>
 104 </dl></div>
 105 </div>
 106 <div class="refsection">
 107 <a name="id-1.9"></a><h2>TIMING OPTIONS</h2>
 108 <p>
 109       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 110       If the argument begins with a '+' or '-', it is interpreted as
 111       an offset from the present time.  For convenience, if such an offset
 112       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 113       then the offset is computed in years (defined as 365 24-hour days,
 114       ignoring leap years), months (defined as 30 24-hour days), weeks,
 115       days, hours, or minutes, respectively.  Without a suffix, the offset
 116       is computed in seconds.  To unset a date, use 'none' or 'never'.
 117     </p>
 118 <div class="variablelist"><dl class="variablelist">
 119 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 120 <dd><p>
 121             Sets the date on which a key is to be published to the zone.
 122             After that date, the key will be included in the zone but will
 123             not be used to sign it.
 124           </p></dd>
 125 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
 126 <dd><p>
 127             Sets the date on which the key is to be activated.  After that
 128             date, the key will be included in the zone and used to sign
 129             it.
 130           </p></dd>
 131 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
 132 <dd><p>
 133             Sets the date on which the key is to be revoked.  After that
 134             date, the key will be flagged as revoked.  It will be included
 135             in the zone and will be used to sign it.
 136           </p></dd>
 137 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
 138 <dd><p>
 139             Sets the date on which the key is to be retired.  After that
 140             date, the key will still be included in the zone, but it
 141             will not be used to sign it.
 142           </p></dd>
 143 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 144 <dd><p>
 145             Sets the date on which the key is to be deleted.  After that
 146             date, the key will no longer be included in the zone.  (It
 147             may remain in the key repository, however.)
 148           </p></dd>
 149 <dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt>
 150 <dd><p>
 151             Select a key for which the key being modified will be an
 152             explicit successor.  The name, algorithm, size, and type of the
 153             predecessor key must exactly match those of the key being
 154             modified.  The activation date of the successor key will be set
 155             to the inactivation date of the predecessor.  The publication
 156             date will be set to the activation date minus the prepublication
 157             interval, which defaults to 30 days.
 158           </p></dd>
 159 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
 160 <dd>
 161 <p>
 162             Sets the prepublication interval for a key.  If set, then
 163             the publication and activation dates must be separated by at least
 164             this much time.  If the activation date is specified but the
 165             publication date isn't, then the publication date will default
 166             to this much time before the activation date; conversely, if
 167             the publication date is specified but activation date isn't,
 168             then activation will be set to this much time after publication.
 169           </p>
 170 <p>
 171             If the key is being set to be an explicit successor to another
 172             key, then the default prepublication interval is 30 days;
 173             otherwise it is zero.
 174           </p>
 175 <p>
 176             As with date offsets, if the argument is followed by one of
 177             the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
 178             interval is measured in years, months, weeks, days, hours,
 179             or minutes, respectively.  Without a suffix, the interval is
 180             measured in seconds.
 181           </p>
 182 </dd>
 183 </dl></div>
 184 </div>
 185 <div class="refsection">
 186 <a name="id-1.10"></a><h2>PRINTING OPTIONS</h2>
 187 <p>
 188       <span class="command"><strong>dnssec-settime</strong></span> can also be used to print the
 189       timing metadata associated with a key.
 190     </p>
 191 <div class="variablelist"><dl class="variablelist">
 192 <dt><span class="term">-u</span></dt>
 193 <dd><p>
 194             Print times in UNIX epoch format.
 195           </p></dd>
 196 <dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/I/D/all</code></em></span></dt>
 197 <dd><p>
 198             Print a specific metadata value or set of metadata values.
 199             The <code class="option">-p</code> option may be followed by one or more
 200             of the following letters to indicate which value or values to print:
 201             <code class="option">C</code> for the creation date,
 202             <code class="option">P</code> for the publication date,
 203             <code class="option">A</code> for the activation date,
 204             <code class="option">R</code> for the revocation date,
 205             <code class="option">I</code> for the inactivation date, or
 206             <code class="option">D</code> for the deletion date.
 207             To print all of the metadata, use <code class="option">-p all</code>.
 208           </p></dd>
 209 </dl></div>
 210 </div>
 211 <div class="refsection">
 212 <a name="id-1.11"></a><h2>SEE ALSO</h2>
 213 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 214       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 215       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 216       <em class="citetitle">RFC 5011</em>.
 217     </p>
 218 </div>
 219 </div></body>
 220 </html>