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

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