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

   1 <!--
   2  - Copyright (C) 2004-2015 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.ch13.html" title="Manual pages">
  25 <link rel="prev" href="man.dnssec-coverage.html" title="dnssec-coverage">
  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.dnssec-coverage.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">-C</code>] [<code class="option">-l <em class="replaceable"><code>domain</code></em></code>] [<code class="option">-T <em class="replaceable"><code>TTL</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">-T <em class="replaceable"><code>TTL</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 class="cmdsynopsis"><p><code class="command">dnssec-dsfromkey</code>  [<code class="option">-h</code>] [<code class="option">-V</code>]</p></div>
  53 </div>
  54 <div class="refsect1" lang="en">
  55 <a name="id2616576"></a><h2>DESCRIPTION</h2>
  56 <p><span><strong class="command">dnssec-dsfromkey</strong></span>
  57       outputs the Delegation Signer (DS) resource record (RR), as defined in
  58       RFC 3658 and RFC 4509, for the given key(s).
  59     </p>
  60 </div>
  61 <div class="refsect1" lang="en">
  62 <a name="id2616589"></a><h2>OPTIONS</h2>
  63 <div class="variablelist"><dl>
  64 <dt><span class="term">-1</span></dt>
  65 <dd><p>
  66             Use SHA-1 as the digest algorithm (the default is to use
  67             both SHA-1 and SHA-256).
  68           </p></dd>
  69 <dt><span class="term">-2</span></dt>
  70 <dd><p>
  71             Use SHA-256 as the digest algorithm.
  72           </p></dd>
  73 <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
  74 <dd><p>
  75             Select the digest algorithm. The value of
  76             <code class="option">algorithm</code> must be one of SHA-1 (SHA1),
  77             SHA-256 (SHA256), GOST or SHA-384 (SHA384).
  78             These values are case insensitive.
  79           </p></dd>
  80 <dt><span class="term">-C</span></dt>
  81 <dd><p>
  82             Generate CDS records rather than DS records.  This is mutually
  83             exclusive with generating lookaside records.
  84           </p></dd>
  85 <dt><span class="term">-T <em class="replaceable"><code>TTL</code></em></span></dt>
  86 <dd><p>
  87             Specifies the TTL of the DS records.
  88           </p></dd>
  89 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
  90 <dd><p>
  91             Look for key files (or, in keyset mode,
  92             <code class="filename">keyset-</code> files) in
  93             <code class="option">directory</code>.
  94           </p></dd>
  95 <dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
  96 <dd>
  97 <p>
  98             Zone file mode: in place of the keyfile name, the argument is
  99             the DNS domain name of a zone master file, which can be read
 100             from <code class="option">file</code>.  If the zone name is the same as
 101             <code class="option">file</code>, then it may be omitted.
 102           </p>
 103 <p>
 104             If <code class="option">file</code> is set to <code class="literal">"-"</code>, then
 105             the zone data is read from the standard input.  This makes it
 106             possible to use the output of the <span><strong class="command">dig</strong></span>
 107             command as input, as in:
 108           </p>
 109 <p>
 110             <strong class="userinput"><code>dig dnskey example.com | dnssec-dsfromkey -f - example.com</code></strong>
 111           </p>
 112 </dd>
 113 <dt><span class="term">-A</span></dt>
 114 <dd><p>
 115             Include ZSK's when generating DS records.  Without this option,
 116             only keys which have the KSK flag set will be converted to DS
 117             records and printed.  Useful only in zone file mode.
 118           </p></dd>
 119 <dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
 120 <dd><p>
 121             Generate a DLV set instead of a DS set.  The specified
 122             <code class="option">domain</code> is appended to the name for each
 123             record in the set.
 124             The DNSSEC Lookaside Validation (DLV) RR is described
 125             in RFC 4431.  This is mutually exclusive with generating
 126             CDS records.
 127           </p></dd>
 128 <dt><span class="term">-s</span></dt>
 129 <dd><p>
 130             Keyset mode: in place of the keyfile name, the argument is
 131             the DNS domain name of a keyset file.
 132           </p></dd>
 133 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
 134 <dd><p>
 135             Specifies the DNS class (default is IN).  Useful only
 136             in keyset or zone file mode.
 137           </p></dd>
 138 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 139 <dd><p>
 140             Sets the debugging level.
 141           </p></dd>
 142 <dt><span class="term">-h</span></dt>
 143 <dd><p>
 144             Prints usage information.
 145           </p></dd>
 146 <dt><span class="term">-V</span></dt>
 147 <dd><p>
 148             Prints version information.
 149           </p></dd>
 150 </dl></div>
 151 </div>
 152 <div class="refsect1" lang="en">
 153 <a name="id2617274"></a><h2>EXAMPLE</h2>
 154 <p>
 155       To build the SHA-256 DS RR from the
 156       <strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
 157       keyfile name, the following command would be issued:
 158     </p>
 159 <p><strong class="userinput"><code>dnssec-dsfromkey -2 Kexample.com.+003+26160</code></strong>
 160     </p>
 161 <p>
 162       The command would print something like:
 163     </p>
 164 <p><strong class="userinput"><code>example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94</code></strong>
 165     </p>
 166 </div>
 167 <div class="refsect1" lang="en">
 168 <a name="id2617310"></a><h2>FILES</h2>
 169 <p>
 170       The keyfile can be designed by the key identification
 171       <code class="filename">Knnnn.+aaa+iiiii</code> or the full file name
 172       <code class="filename">Knnnn.+aaa+iiiii.key</code> as generated by
 173       <span class="refentrytitle">dnssec-keygen</span>(8).
 174     </p>
 175 <p>
 176       The keyset file name is built from the <code class="option">directory</code>,
 177       the string <code class="filename">keyset-</code> and the
 178       <code class="option">dnsname</code>.
 179     </p>
 180 </div>
 181 <div class="refsect1" lang="en">
 182 <a name="id2618649"></a><h2>CAVEAT</h2>
 183 <p>
 184       A keyfile error can give a "file not found" even if the file exists.
 185     </p>
 186 </div>
 187 <div class="refsect1" lang="en">
 188 <a name="id2618659"></a><h2>SEE ALSO</h2>
 189 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 190       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 191       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 192       <em class="citetitle">RFC 3658</em>,
 193       <em class="citetitle">RFC 4431</em>.
 194       <em class="citetitle">RFC 4509</em>.
 195     </p>
 196 </div>
 197 <div class="refsect1" lang="en">
 198 <a name="id2618698"></a><h2>AUTHOR</h2>
 199 <p><span class="corpauthor">Internet Systems Consortium</span>
 200     </p>
 201 </div>
 202 </div>
 203 <div class="navfooter">
 204 <hr>
 205 <table width="100%" summary="Navigation footer">
 206 <tr>
 207 <td width="40%" align="left">
 208 <a accesskey="p" href="man.dnssec-coverage.html">Prev</a> </td>
 209 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
 210 <td width="40%" align="right"> <a accesskey="n" href="man.dnssec-keyfromlabel.html">Next</a>
 211 </td>
 212 </tr>
 213 <tr>
 214 <td width="40%" align="left" valign="top">
 215 <span class="application">dnssec-coverage</span> </td>
 216 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 217 <td width="40%" align="right" valign="top"> <span class="application">dnssec-keyfromlabel</span>
 218 </td>
 219 </tr>
 220 </table>
 221 </div>
 222 <p style="text-align: center;">BIND 9.9.8-P2 (Extended Support Version)</p>
 223 </body>
 224 </html>