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">-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 <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="id2543432"></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="id2543480"></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">-L <em class="replaceable"><code>ttl</code></em></span></dt>
  78 <dd><p>
  79             Sets the default TTL to use for this key when it is converted
  80             into a DNSKEY RR.  If the key is imported into a zone,
  81             this is the TTL that will be used for it, unless there was
  82             already a DNSKEY RRset in place, in which case the existing TTL
  83             would take precedence.  Setting the default TTL to
  84             <code class="literal">0</code> or <code class="literal">none</code> removes it.
  85           </p></dd>
  86 <dt><span class="term">-h</span></dt>
  87 <dd><p>
  88             Emit usage message and exit.
  89           </p></dd>
  90 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
  91 <dd><p>
  92             Sets the debugging level.
  93           </p></dd>
  94 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
  95 <dd><p>
  96             Use the given OpenSSL engine. When compiled with PKCS#11 support
  97             it defaults to pkcs11; the empty name resets it to no engine.
  98           </p></dd>
  99 </dl></div>
 100 </div>
 101 <div class="refsect1" lang="en">
 102 <a name="id2543664"></a><h2>TIMING OPTIONS</h2>
 103 <p>
 104       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 105       If the argument begins with a '+' or '-', it is interpreted as
 106       an offset from the present time.  For convenience, if such an offset
 107       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 108       then the offset is computed in years (defined as 365 24-hour days,
 109       ignoring leap years), months (defined as 30 24-hour days), weeks,
 110       days, hours, or minutes, respectively.  Without a suffix, the offset
 111       is computed in seconds.  To unset a date, use 'none'.
 112     </p>
 113 <div class="variablelist"><dl>
 114 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 115 <dd><p>
 116             Sets the date on which a key is to be published to the zone.
 117             After that date, the key will be included in the zone but will
 118             not be used to sign it.
 119           </p></dd>
 120 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
 121 <dd><p>
 122             Sets the date on which the key is to be activated.  After that
 123             date, the key will be included in the zone and used to sign
 124             it.
 125           </p></dd>
 126 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
 127 <dd><p>
 128             Sets the date on which the key is to be revoked.  After that
 129             date, the key will be flagged as revoked.  It will be included
 130             in the zone and will be used to sign it.
 131           </p></dd>
 132 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
 133 <dd><p>
 134             Sets the date on which the key is to be retired.  After that
 135             date, the key will still be included in the zone, but it
 136             will not be used to sign it.
 137           </p></dd>
 138 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 139 <dd><p>
 140             Sets the date on which the key is to be deleted.  After that
 141             date, the key will no longer be included in the zone.  (It
 142             may remain in the key repository, however.)
 143           </p></dd>
 144 <dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt>
 145 <dd><p>
 146             Select a key for which the key being modified will be an
 147             explicit successor.  The name, algorithm, size, and type of the
 148             predecessor key must exactly match those of the key being
 149             modified.  The activation date of the successor key will be set
 150             to the inactivation date of the predecessor.  The publication
 151             date will be set to the activation date minus the prepublication
 152             interval, which defaults to 30 days.
 153           </p></dd>
 154 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
 155 <dd>
 156 <p>
 157             Sets the prepublication interval for a key.  If set, then
 158             the publication and activation dates must be separated by at least
 159             this much time.  If the activation date is specified but the
 160             publication date isn't, then the publication date will default
 161             to this much time before the activation date; conversely, if
 162             the publication date is specified but activation date isn't,
 163             then activation will be set to this much time after publication.
 164           </p>
 165 <p>
 166             If the key is being set to be an explicit successor to another
 167             key, then the default prepublication interval is 30 days;
 168             otherwise it is zero.
 169           </p>
 170 <p>
 171             As with date offsets, if the argument is followed by one of
 172             the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
 173             interval is measured in years, months, weeks, days, hours,
 174             or minutes, respectively.  Without a suffix, the interval is
 175             measured in seconds.
 176           </p>
 177 </dd>
 178 </dl></div>
 179 </div>
 180 <div class="refsect1" lang="en">
 181 <a name="id2543802"></a><h2>PRINTING OPTIONS</h2>
 182 <p>
 183       <span><strong class="command">dnssec-settime</strong></span> can also be used to print the
 184       timing metadata associated with a key.
 185     </p>
 186 <div class="variablelist"><dl>
 187 <dt><span class="term">-u</span></dt>
 188 <dd><p>
 189             Print times in UNIX epoch format.
 190           </p></dd>
 191 <dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/I/D/all</code></em></span></dt>
 192 <dd><p>
 193             Print a specific metadata value or set of metadata values.
 194             The <code class="option">-p</code> option may be followed by one or more
 195             of the following letters to indicate which value or values to print:
 196             <code class="option">C</code> for the creation date,
 197             <code class="option">P</code> for the publication date,
 198             <code class="option">A</code> for the activation date,
 199             <code class="option">R</code> for the revocation date,
 200             <code class="option">I</code> for the inactivation date, or
 201             <code class="option">D</code> for the deletion date.
 202             To print all of the metadata, use <code class="option">-p all</code>.
 203           </p></dd>
 204 </dl></div>
 205 </div>
 206 <div class="refsect1" lang="en">
 207 <a name="id2543880"></a><h2>SEE ALSO</h2>
 208 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 209       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 210       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 211       <em class="citetitle">RFC 5011</em>.
 212     </p>
 213 </div>
 214 <div class="refsect1" lang="en">
 215 <a name="id2542138"></a><h2>AUTHOR</h2>
 216 <p><span class="corpauthor">Internet Systems Consortium</span>
 217     </p>
 218 </div>
 219 </div></body>
 220 </html>