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

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