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

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