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

   1 <!--
   2  - Copyright (C) 2004-2012 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-dsfromkey</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.host.html" title="host">
  26 <link rel="next" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel">
  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-dsfromkey</span></th></tr>
  32 <tr>
  33 <td width="20%" align="left">
  34 <a accesskey="p" href="man.host.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-keyfromlabel.html">Next</a>
  37 </td>
  38 </tr>
  39 </table>
  40 <hr>
  41 </div>
  42 <div class="refentry" lang="en">
  43 <a name="man.dnssec-dsfromkey"></a><div class="titlepage"></div>
  44 <div class="refnamediv">
  45 <h2>Name</h2>
  46 <p><span class="application">dnssec-dsfromkey</span> &#8212; DNSSEC DS RR generation tool</p>
  47 </div>
  48 <div class="refsynopsisdiv">
  49 <h2>Synopsis</h2>
  50 <div class="cmdsynopsis"><p><code class="command">dnssec-dsfromkey</code>  [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-1</code>] [<code class="option">-2</code>] [<code class="option">-a <em class="replaceable"><code>alg</code></em></code>] [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] {keyfile}</p></div>
  51 <div class="cmdsynopsis"><p><code class="command">dnssec-dsfromkey</code>  {-s} [<code class="option">-1</code>] [<code class="option">-2</code>] [<code class="option">-a <em class="replaceable"><code>alg</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-s</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-f <em class="replaceable"><code>file</code></em></code>] [<code class="option">-A</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] {dnsname}</p></div>
  52 </div>
  53 <div class="refsect1" lang="en">
  54 <a name="id2611633"></a><h2>DESCRIPTION</h2>
  55 <p><span><strong class="command">dnssec-dsfromkey</strong></span>
  56       outputs the Delegation Signer (DS) resource record (RR), as defined in
  57       RFC 3658 and RFC 4509, for the given key(s).
  58     </p>
  59 </div>
  60 <div class="refsect1" lang="en">
  61 <a name="id2611646"></a><h2>OPTIONS</h2>
  62 <div class="variablelist"><dl>
  63 <dt><span class="term">-1</span></dt>
  64 <dd><p>
  65             Use SHA-1 as the digest algorithm (the default is to use
  66             both SHA-1 and SHA-256).
  67           </p></dd>
  68 <dt><span class="term">-2</span></dt>
  69 <dd><p>
  70             Use SHA-256 as the digest algorithm.
  71           </p></dd>
  72 <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
  73 <dd><p>
  74             Select the digest algorithm. The value of
  75             <code class="option">algorithm</code> must be one of SHA-1 (SHA1),
  76             SHA-256 (SHA256), GOST or SHA-384 (SHA384).
  77             These values are case insensitive.
  78           </p></dd>
  79 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
  80 <dd><p>
  81             Look for key files (or, in keyset mode,
  82             <code class="filename">keyset-</code> files) in
  83             <code class="option">directory</code>.
  84           </p></dd>
  85 <dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
  86 <dd><p>
  87             Zone file mode: in place of the keyfile name, the argument is
  88             the DNS domain name of a zone master file, which can be read
  89             from <code class="option">file</code>.  If the zone name is the same as
  90             <code class="option">file</code>, then it may be omitted.
  91           </p></dd>
  92 <dt><span class="term">-A</span></dt>
  93 <dd><p>
  94             Include ZSK's when generating DS records.  Without this option,
  95             only keys which have the KSK flag set will be converted to DS
  96             records and printed.  Useful only in zone file mode.
  97           </p></dd>
  98 <dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
  99 <dd><p>
 100             Generate a DLV set instead of a DS set.  The specified
 101             <code class="option">domain</code> is appended to the name for each
 102             record in the set.
 103             The DNSSEC Lookaside Validation (DLV) RR is described
 104             in RFC 4431.
 105           </p></dd>
 106 <dt><span class="term">-s</span></dt>
 107 <dd><p>
 108             Keyset mode: in place of the keyfile name, the argument is
 109             the DNS domain name of a keyset file.
 110           </p></dd>
 111 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
 112 <dd><p>
 113             Specifies the DNS class (default is IN).  Useful only
 114             in keyset or zone file mode.
 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="id2611835"></a><h2>EXAMPLE</h2>
 124 <p>
 125       To build the SHA-256 DS RR from the
 126       <strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
 127       keyfile name, the following command would be issued:
 128     </p>
 129 <p><strong class="userinput"><code>dnssec-dsfromkey -2 Kexample.com.+003+26160</code></strong>
 130     </p>
 131 <p>
 132       The command would print something like:
 133     </p>
 134 <p><strong class="userinput"><code>example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94</code></strong>
 135     </p>
 136 </div>
 137 <div class="refsect1" lang="en">
 138 <a name="id2611872"></a><h2>FILES</h2>
 139 <p>
 140       The keyfile can be designed by the key identification
 141       <code class="filename">Knnnn.+aaa+iiiii</code> or the full file name
 142       <code class="filename">Knnnn.+aaa+iiiii.key</code> as generated by
 143       <span class="refentrytitle">dnssec-keygen</span>(8).
 144     </p>
 145 <p>
 146       The keyset file name is built from the <code class="option">directory</code>,
 147       the string <code class="filename">keyset-</code> and the
 148       <code class="option">dnsname</code>.
 149     </p>
 150 </div>
 151 <div class="refsect1" lang="en">
 152 <a name="id2611913"></a><h2>CAVEAT</h2>
 153 <p>
 154       A keyfile error can give a "file not found" even if the file exists.
 155     </p>
 156 </div>
 157 <div class="refsect1" lang="en">
 158 <a name="id2611923"></a><h2>SEE ALSO</h2>
 159 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 160       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 161       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 162       <em class="citetitle">RFC 3658</em>,
 163       <em class="citetitle">RFC 4431</em>.
 164       <em class="citetitle">RFC 4509</em>.
 165     </p>
 166 </div>
 167 <div class="refsect1" lang="en">
 168 <a name="id2611962"></a><h2>AUTHOR</h2>
 169 <p><span class="corpauthor">Internet Systems Consortium</span>
 170     </p>
 171 </div>
 172 </div>
 173 <div class="navfooter">
 174 <hr>
 175 <table width="100%" summary="Navigation footer">
 176 <tr>
 177 <td width="40%" align="left">
 178 <a accesskey="p" href="man.host.html">Prev</a> </td>
 179 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
 180 <td width="40%" align="right"> <a accesskey="n" href="man.dnssec-keyfromlabel.html">Next</a>
 181 </td>
 182 </tr>
 183 <tr>
 184 <td width="40%" align="left" valign="top">host </td>
 185 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 186 <td width="40%" align="right" valign="top"> <span class="application">dnssec-keyfromlabel</span>
 187 </td>
 188 </tr>
 189 </table>
 190 </div>
 191 </body>
 192 </html>