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

   1 <!--
   2  - Copyright (C) 2004-2010 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: man.dnssec-keyfromlabel.html,v 1.31.14.17.2.1 2010/02/25 12:16:49 tbox Exp $ -->
  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>  {-a <em class="replaceable"><code>algorithm</code></em>} {-l <em class="replaceable"><code>label</code></em>} [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-k</code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</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>] {name}</p></div>
  51 </div>
  52 <div class="refsect1" lang="en">
  53 <a name="id2604588"></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 </div>
  60 <div class="refsect1" lang="en">
  61 <a name="id2604602"></a><h2>OPTIONS</h2>
  62 <div class="variablelist"><dl>
  63 <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
  64 <dd>
  65 <p>
  66             Selects the cryptographic algorithm.  The value of
  67             <code class="option">algorithm</code> must be one of RSAMD5,
  68             RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256,
  69             RSASHA512 or DH (Diffie Hellman).
  70             These values are case insensitive.
  71           </p>
  72 <p>
  73             If no algorithm is specified, then RSASHA1 will be used by
  74             default, unless the <code class="option">-3</code> option is specified,
  75             in which case NSEC3RSASHA1 will be used instead.  (If
  76             <code class="option">-3</code> is used and an algorithm is specified,
  77             that algorithm will be checked for compatibility with NSEC3.)
  78           </p>
  79 <p>
  80             Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
  81             algorithm, and DSA is recommended.
  82           </p>
  83 <p>
  84             Note 2: DH automatically sets the -k flag.
  85           </p>
  86 </dd>
  87 <dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
  88 <dd><p>
  89             Specifies the label of keys in the crypto hardware
  90             (PKCS#11 device).
  91           </p></dd>
  92 <dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
  93 <dd><p>
  94             Specifies the owner type of the key.  The value of
  95             <code class="option">nametype</code> must either be ZONE (for a DNSSEC
  96             zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
  97             a host (KEY)),
  98             USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
  99             These values are
 100             case insensitive.
 101           </p></dd>
 102 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
 103 <dd><p>
 104             Indicates that the DNS record containing the key should have
 105             the specified class.  If not specified, class IN is used.
 106           </p></dd>
 107 <dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
 108 <dd><p>
 109             Set the specified flag in the flag field of the KEY/DNSKEY record.
 110             The only recognized flag is KSK (Key Signing Key) DNSKEY.
 111           </p></dd>
 112 <dt><span class="term">-h</span></dt>
 113 <dd><p>
 114             Prints a short summary of the options and arguments to
 115             <span><strong class="command">dnssec-keygen</strong></span>.
 116           </p></dd>
 117 <dt><span class="term">-k</span></dt>
 118 <dd><p>
 119             Generate KEY records rather than DNSKEY records.
 120           </p></dd>
 121 <dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
 122 <dd><p>
 123             Sets the protocol value for the generated key.  The protocol
 124             is a number between 0 and 255.  The default is 3 (DNSSEC).
 125             Other possible values for this argument are listed in
 126             RFC 2535 and its successors.
 127           </p></dd>
 128 <dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
 129 <dd><p>
 130             Indicates the use of the key.  <code class="option">type</code> must be
 131             one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF.  The default
 132             is AUTHCONF.  AUTH refers to the ability to authenticate
 133             data, and CONF the ability to encrypt data.
 134           </p></dd>
 135 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 136 <dd><p>
 137             Sets the debugging level.
 138           </p></dd>
 139 </dl></div>
 140 </div>
 141 <div class="refsect1" lang="en">
 142 <a name="id2604945"></a><h2>GENERATED KEY FILES</h2>
 143 <p>
 144       When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
 145       successfully,
 146       it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
 147       to the standard output.  This is an identification string for
 148       the key files it has generated.
 149     </p>
 150 <div class="itemizedlist"><ul type="disc">
 151 <li><p><code class="filename">nnnn</code> is the key name.
 152         </p></li>
 153 <li><p><code class="filename">aaa</code> is the numeric representation
 154           of the
 155           algorithm.
 156         </p></li>
 157 <li><p><code class="filename">iiiii</code> is the key identifier (or
 158           footprint).
 159         </p></li>
 160 </ul></div>
 161 <p><span><strong class="command">dnssec-keyfromlabel</strong></span>
 162       creates two files, with names based
 163       on the printed string.  <code class="filename">Knnnn.+aaa+iiiii.key</code>
 164       contains the public key, and
 165       <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
 166       private
 167       key.
 168     </p>
 169 <p>
 170       The <code class="filename">.key</code> file contains a DNS KEY record
 171       that
 172       can be inserted into a zone file (directly or with a $INCLUDE
 173       statement).
 174     </p>
 175 <p>
 176       The <code class="filename">.private</code> file contains algorithm
 177       specific
 178       fields.  For obvious security reasons, this file does not have
 179       general read permission.
 180     </p>
 181 </div>
 182 <div class="refsect1" lang="en">
 183 <a name="id2605038"></a><h2>SEE ALSO</h2>
 184 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 185       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 186       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 187       <em class="citetitle">RFC 4034</em>.
 188     </p>
 189 </div>
 190 <div class="refsect1" lang="en">
 191 <a name="id2605072"></a><h2>AUTHOR</h2>
 192 <p><span class="corpauthor">Internet Systems Consortium</span>
 193     </p>
 194 </div>
 195 </div>
 196 <div class="navfooter">
 197 <hr>
 198 <table width="100%" summary="Navigation footer">
 199 <tr>
 200 <td width="40%" align="left">
 201 <a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a> </td>
 202 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
 203 <td width="40%" align="right"> <a accesskey="n" href="man.dnssec-keygen.html">Next</a>
 204 </td>
 205 </tr>
 206 <tr>
 207 <td width="40%" align="left" valign="top">
 208 <span class="application">dnssec-dsfromkey</span> </td>
 209 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 210 <td width="40%" align="right" valign="top"> <span class="application">dnssec-keygen</span>
 211 </td>
 212 </tr>
 213 </table>
 214 </div>
 215 </body>
 216 </html>