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

   1 <!--
   2  - Copyright (C) 2008-2012 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-keyfromlabel</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-keyfromlabel"></a><div class="titlepage"></div>
  25 <div class="refnamediv">
  26 <h2>Name</h2>
  27 <p><span class="application">dnssec-keyfromlabel</span> &#8212; DNSSEC key generation tool</p>
  28 </div>
  29 <div class="refsynopsisdiv">
  30 <h2>Synopsis</h2>
  31 <div class="cmdsynopsis"><p><code class="command">dnssec-keyfromlabel</code>  {-l <em class="replaceable"><code>label</code></em>} [<code class="option">-3</code>] [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-k</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">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-y</code>] {name}</p></div>
  32 </div>
  33 <div class="refsect1" lang="en">
  34 <a name="id2543507"></a><h2>DESCRIPTION</h2>
  35 <p><span><strong class="command">dnssec-keyfromlabel</strong></span>
  36       gets keys with the given label from a crypto hardware and builds
  37       key files for DNSSEC (Secure DNS), as defined in RFC 2535
  38       and RFC 4034.
  39     </p>
  40 <p>
  41       The <code class="option">name</code> of the key is specified on the command
  42       line.  This must match the name of the zone for which the key is
  43       being generated.
  44     </p>
  45 </div>
  46 <div class="refsect1" lang="en">
  47 <a name="id2543525"></a><h2>OPTIONS</h2>
  48 <div class="variablelist"><dl>
  49 <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
  50 <dd>
  51 <p>
  52             Selects the cryptographic algorithm.  The value of
  53             <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
  54             DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
  55             ECDSAP256SHA256 or ECDSAP384SHA384.
  56             These values are case insensitive.
  57           </p>
  58 <p>
  59             If no algorithm is specified, then RSASHA1 will be used by
  60             default, unless the <code class="option">-3</code> option is specified,
  61             in which case NSEC3RSASHA1 will be used instead.  (If
  62             <code class="option">-3</code> is used and an algorithm is specified,
  63             that algorithm will be checked for compatibility with NSEC3.)
  64           </p>
  65 <p>
  66             Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
  67             algorithm, and DSA is recommended.
  68           </p>
  69 <p>
  70             Note 2: DH automatically sets the -k flag.
  71           </p>
  72 </dd>
  73 <dt><span class="term">-3</span></dt>
  74 <dd><p>
  75             Use an NSEC3-capable algorithm to generate a DNSSEC key.
  76             If this option is used and no algorithm is explicitly
  77             set on the command line, NSEC3RSASHA1 will be used by
  78             default.
  79           </p></dd>
  80 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
  81 <dd><p>
  82             Specifies the name of the crypto hardware (OpenSSL engine).
  83             When compiled with PKCS#11 support it defaults to "pkcs11".
  84           </p></dd>
  85 <dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
  86 <dd><p>
  87             Specifies the label of the key pair in the crypto hardware.
  88             The label may be preceded by an optional OpenSSL engine name,
  89             separated by a colon, as in "pkcs11:keylabel".
  90           </p></dd>
  91 <dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
  92 <dd><p>
  93             Specifies the owner type of the key.  The value of
  94             <code class="option">nametype</code> must either be ZONE (for a DNSSEC
  95             zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
  96             a host (KEY)),
  97             USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
  98             These values are case insensitive.
  99           </p></dd>
 100 <dt><span class="term">-C</span></dt>
 101 <dd><p>
 102             Compatibility mode:  generates an old-style key, without
 103             any metadata.  By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
 104             will include the key's creation date in the metadata stored
 105             with the private key, and other dates may be set there as well
 106             (publication date, activation date, etc).  Keys that include
 107             this data may be incompatible with older versions of BIND; the
 108             <code class="option">-C</code> option suppresses them.
 109           </p></dd>
 110 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
 111 <dd><p>
 112             Indicates that the DNS record containing the key should have
 113             the specified class.  If not specified, class IN is used.
 114           </p></dd>
 115 <dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
 116 <dd><p>
 117             Set the specified flag in the flag field of the KEY/DNSKEY record.
 118             The only recognized flags are KSK (Key Signing Key) and REVOKE.
 119           </p></dd>
 120 <dt><span class="term">-G</span></dt>
 121 <dd><p>
 122             Generate a key, but do not publish it or sign with it.  This
 123             option is incompatible with -P and -A.
 124           </p></dd>
 125 <dt><span class="term">-h</span></dt>
 126 <dd><p>
 127             Prints a short summary of the options and arguments to
 128             <span><strong class="command">dnssec-keyfromlabel</strong></span>.
 129           </p></dd>
 130 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
 131 <dd><p>
 132             Sets the directory in which the key files are to be written.
 133           </p></dd>
 134 <dt><span class="term">-k</span></dt>
 135 <dd><p>
 136             Generate KEY records rather than DNSKEY records.
 137           </p></dd>
 138 <dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
 139 <dd><p>
 140             Sets the default TTL to use for this key when it is converted
 141             into a DNSKEY RR.  If the key is imported into a zone,
 142             this is the TTL that will be used for it, unless there was
 143             already a DNSKEY RRset in place, in which case the existing TTL
 144             would take precedence.  Setting the default TTL to
 145             <code class="literal">0</code> or <code class="literal">none</code> removes it.
 146           </p></dd>
 147 <dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
 148 <dd><p>
 149             Sets the protocol value for the key.  The protocol
 150             is a number between 0 and 255.  The default is 3 (DNSSEC).
 151             Other possible values for this argument are listed in
 152             RFC 2535 and its successors.
 153           </p></dd>
 154 <dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
 155 <dd><p>
 156             Indicates the use of the key.  <code class="option">type</code> must be
 157             one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF.  The default
 158             is AUTHCONF.  AUTH refers to the ability to authenticate
 159             data, and CONF the ability to encrypt data.
 160           </p></dd>
 161 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 162 <dd><p>
 163             Sets the debugging level.
 164           </p></dd>
 165 <dt><span class="term">-y</span></dt>
 166 <dd><p>
 167             Allows DNSSEC key files to be generated even if the key ID
 168             would collide with that of an existing key, in the event of
 169             either key being revoked.  (This is only safe to use if you
 170             are sure you won't be using RFC 5011 trust anchor maintenance
 171             with either of the keys involved.)
 172           </p></dd>
 173 </dl></div>
 174 </div>
 175 <div class="refsect1" lang="en">
 176 <a name="id2543980"></a><h2>TIMING OPTIONS</h2>
 177 <p>
 178       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 179       If the argument begins with a '+' or '-', it is interpreted as
 180       an offset from the present time.  For convenience, if such an offset
 181       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 182       then the offset is computed in years (defined as 365 24-hour days,
 183       ignoring leap years), months (defined as 30 24-hour days), weeks,
 184       days, hours, or minutes, respectively.  Without a suffix, the offset
 185       is computed in seconds.
 186     </p>
 187 <div class="variablelist"><dl>
 188 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 189 <dd><p>
 190             Sets the date on which a key is to be published to the zone.
 191             After that date, the key will be included in the zone but will
 192             not be used to sign it.  If not set, and if the -G option has
 193             not been used, the default is "now".
 194           </p></dd>
 195 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
 196 <dd><p>
 197             Sets the date on which the key is to be activated.  After that
 198             date, the key will be included in the zone and used to sign
 199             it.  If not set, and if the -G option has not been used, the
 200             default is "now".
 201           </p></dd>
 202 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
 203 <dd><p>
 204             Sets the date on which the key is to be revoked.  After that
 205             date, the key will be flagged as revoked.  It will be included
 206             in the zone and will be used to sign it.
 207           </p></dd>
 208 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
 209 <dd><p>
 210             Sets the date on which the key is to be retired.  After that
 211             date, the key will still be included in the zone, but it
 212             will not be used to sign it.
 213           </p></dd>
 214 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 215 <dd><p>
 216             Sets the date on which the key is to be deleted.  After that
 217             date, the key will no longer be included in the zone.  (It
 218             may remain in the key repository, however.)
 219           </p></dd>
 220 </dl></div>
 221 </div>
 222 <div class="refsect1" lang="en">
 223 <a name="id2543054"></a><h2>GENERATED KEY FILES</h2>
 224 <p>
 225       When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
 226       successfully,
 227       it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
 228       to the standard output.  This is an identification string for
 229       the key files it has generated.
 230     </p>
 231 <div class="itemizedlist"><ul type="disc">
 232 <li><p><code class="filename">nnnn</code> is the key name.
 233         </p></li>
 234 <li><p><code class="filename">aaa</code> is the numeric representation
 235           of the algorithm.
 236         </p></li>
 237 <li><p><code class="filename">iiiii</code> is the key identifier (or
 238           footprint).
 239         </p></li>
 240 </ul></div>
 241 <p><span><strong class="command">dnssec-keyfromlabel</strong></span>
 242       creates two files, with names based
 243       on the printed string.  <code class="filename">Knnnn.+aaa+iiiii.key</code>
 244       contains the public key, and
 245       <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
 246       private key.
 247     </p>
 248 <p>
 249       The <code class="filename">.key</code> file contains a DNS KEY record
 250       that
 251       can be inserted into a zone file (directly or with a $INCLUDE
 252       statement).
 253     </p>
 254 <p>
 255       The <code class="filename">.private</code> file contains
 256       algorithm-specific
 257       fields.  For obvious security reasons, this file does not have
 258       general read permission.
 259     </p>
 260 </div>
 261 <div class="refsect1" lang="en">
 262 <a name="id2543127"></a><h2>SEE ALSO</h2>
 263 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 264       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 265       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 266       <em class="citetitle">RFC 4034</em>.
 267     </p>
 268 </div>
 269 <div class="refsect1" lang="en">
 270 <a name="id2543160"></a><h2>AUTHOR</h2>
 271 <p><span class="corpauthor">Internet Systems Consortium</span>
 272     </p>
 273 </div>
 274 </div></body>
 275 </html>