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

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