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

   1 <!--
   2  - Copyright (C) 2008 Internet Systems Consortium, Inc. ("ISC")
   3  -
   4  - Permission to use, copy, modify, and 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.5 2008/10/15 01:11:35 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>  {-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>
  32 </div>
  33 <div class="refsect1" lang="en">
  34 <a name="id2543413"></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 </div>
  41 <div class="refsect1" lang="en">
  42 <a name="id2543425"></a><h2>OPTIONS</h2>
  43 <div class="variablelist"><dl>
  44 <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
  45 <dd>
  46 <p>
  47             Selects the cryptographic algorithm.  The value of
  48             <code class="option">algorithm</code> must be one of RSAMD5 (RSA)
  49             or RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA or DH (Diffie Hellman).
  50             These values are case insensitive.
  51           </p>
  52 <p>
  53             Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
  54             algorithm, and DSA is recommended.
  55           </p>
  56 <p>
  57             Note 2: DH automatically sets the -k flag.
  58           </p>
  59 </dd>
  60 <dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
  61 <dd><p>
  62             Specifies the label of keys in the crypto hardware
  63             (PKCS#11 device).
  64           </p></dd>
  65 <dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
  66 <dd><p>
  67             Specifies the owner type of the key.  The value of
  68             <code class="option">nametype</code> must either be ZONE (for a DNSSEC
  69             zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
  70             a host (KEY)),
  71             USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
  72             These values are
  73             case insensitive.
  74           </p></dd>
  75 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
  76 <dd><p>
  77             Indicates that the DNS record containing the key should have
  78             the specified class.  If not specified, class IN is used.
  79           </p></dd>
  80 <dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
  81 <dd><p>
  82             Set the specified flag in the flag field of the KEY/DNSKEY record.
  83             The only recognized flag is KSK (Key Signing Key) DNSKEY.
  84           </p></dd>
  85 <dt><span class="term">-h</span></dt>
  86 <dd><p>
  87             Prints a short summary of the options and arguments to
  88             <span><strong class="command">dnssec-keygen</strong></span>.
  89           </p></dd>
  90 <dt><span class="term">-k</span></dt>
  91 <dd><p>
  92             Generate KEY records rather than DNSKEY records.
  93           </p></dd>
  94 <dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
  95 <dd><p>
  96             Sets the protocol value for the generated key.  The protocol
  97             is a number between 0 and 255.  The default is 3 (DNSSEC).
  98             Other possible values for this argument are listed in
  99             RFC 2535 and its successors.
 100           </p></dd>
 101 <dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
 102 <dd><p>
 103             Indicates the use of the key.  <code class="option">type</code> must be
 104             one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF.  The default
 105             is AUTHCONF.  AUTH refers to the ability to authenticate
 106             data, and CONF the ability to encrypt data.
 107           </p></dd>
 108 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 109 <dd><p>
 110             Sets the debugging level.
 111           </p></dd>
 112 </dl></div>
 113 </div>
 114 <div class="refsect1" lang="en">
 115 <a name="id2543619"></a><h2>GENERATED KEY FILES</h2>
 116 <p>
 117       When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
 118       successfully,
 119       it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
 120       to the standard output.  This is an identification string for
 121       the key files it has generated.
 122     </p>
 123 <div class="itemizedlist"><ul type="disc">
 124 <li><p><code class="filename">nnnn</code> is the key name.
 125         </p></li>
 126 <li><p><code class="filename">aaa</code> is the numeric representation
 127           of the
 128           algorithm.
 129         </p></li>
 130 <li><p><code class="filename">iiiii</code> is the key identifier (or
 131           footprint).
 132         </p></li>
 133 </ul></div>
 134 <p><span><strong class="command">dnssec-keyfromlabel</strong></span>
 135       creates two files, with names based
 136       on the printed string.  <code class="filename">Knnnn.+aaa+iiiii.key</code>
 137       contains the public key, and
 138       <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
 139       private
 140       key.
 141     </p>
 142 <p>
 143       The <code class="filename">.key</code> file contains a DNS KEY record
 144       that
 145       can be inserted into a zone file (directly or with a $INCLUDE
 146       statement).
 147     </p>
 148 <p>
 149       The <code class="filename">.private</code> file contains algorithm
 150       specific
 151       fields.  For obvious security reasons, this file does not have
 152       general read permission.
 153     </p>
 154 </div>
 155 <div class="refsect1" lang="en">
 156 <a name="id2543691"></a><h2>SEE ALSO</h2>
 157 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 158       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 159       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 160       <em class="citetitle">RFC 2539</em>,
 161       <em class="citetitle">RFC 2845</em>,
 162       <em class="citetitle">RFC 4033</em>.
 163     </p>
 164 </div>
 165 <div class="refsect1" lang="en">
 166 <a name="id2543731"></a><h2>AUTHOR</h2>
 167 <p><span class="corpauthor">Internet Systems Consortium</span>
 168     </p>
 169 </div>
 170 </div></body>
 171 </html>