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

   1 <!--
   2  - Copyright (C) 2008-2012, 2014 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$ -->
  17 <html>
  18 <head>
  19 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  20 <title>dnssec-dsfromkey</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-dsfromkey"></a><div class="titlepage"></div>
  25 <div class="refnamediv">
  26 <h2>Name</h2>
  27 <p><span class="application">dnssec-dsfromkey</span> &#8212; DNSSEC DS RR generation tool</p>
  28 </div>
  29 <div class="refsynopsisdiv">
  30 <h2>Synopsis</h2>
  31 <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>] [<code class="option">-T <em class="replaceable"><code>TTL</code></em></code>] {keyfile}</p></div>
  32 <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>
  33 <div class="cmdsynopsis"><p><code class="command">dnssec-dsfromkey</code>  [<code class="option">-h</code>] [<code class="option">-V</code>]</p></div>
  34 </div>
  35 <div class="refsect1" lang="en">
  36 <a name="id2543514"></a><h2>DESCRIPTION</h2>
  37 <p><span><strong class="command">dnssec-dsfromkey</strong></span>
  38       outputs the Delegation Signer (DS) resource record (RR), as defined in
  39       RFC 3658 and RFC 4509, for the given key(s).
  40     </p>
  41 </div>
  42 <div class="refsect1" lang="en">
  43 <a name="id2543526"></a><h2>OPTIONS</h2>
  44 <div class="variablelist"><dl>
  45 <dt><span class="term">-1</span></dt>
  46 <dd><p>
  47             Use SHA-1 as the digest algorithm (the default is to use
  48             both SHA-1 and SHA-256).
  49           </p></dd>
  50 <dt><span class="term">-2</span></dt>
  51 <dd><p>
  52             Use SHA-256 as the digest algorithm.
  53           </p></dd>
  54 <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
  55 <dd><p>
  56             Select the digest algorithm. The value of
  57             <code class="option">algorithm</code> must be one of SHA-1 (SHA1),
  58             SHA-256 (SHA256), GOST or SHA-384 (SHA384).
  59             These values are case insensitive.
  60           </p></dd>
  61 <dt><span class="term">-T <em class="replaceable"><code>TTL</code></em></span></dt>
  62 <dd><p>
  63             Specifies the TTL of the DS records.
  64           </p></dd>
  65 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
  66 <dd><p>
  67             Look for key files (or, in keyset mode,
  68             <code class="filename">keyset-</code> files) in
  69             <code class="option">directory</code>.
  70           </p></dd>
  71 <dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
  72 <dd>
  73 <p>
  74             Zone file mode: in place of the keyfile name, the argument is
  75             the DNS domain name of a zone master file, which can be read
  76             from <code class="option">file</code>.  If the zone name is the same as
  77             <code class="option">file</code>, then it may be omitted.
  78           </p>
  79 <p>
  80             If <code class="option">file</code> is set to <code class="literal">"-"</code>, then
  81             the zone data is read from the standard input.  This makes it
  82             possible to use the output of the <span><strong class="command">dig</strong></span>
  83             command as input, as in:
  84           </p>
  85 <p>
  86             <strong class="userinput"><code>dig dnskey example.com | dnssec-dsfromkey -f - example.com</code></strong>
  87           </p>
  88 </dd>
  89 <dt><span class="term">-A</span></dt>
  90 <dd><p>
  91             Include ZSK's when generating DS records.  Without this option,
  92             only keys which have the KSK flag set will be converted to DS
  93             records and printed.  Useful only in zone file mode.
  94           </p></dd>
  95 <dt><span class="term">-l <em class="replaceable"><code>domain</code></em></span></dt>
  96 <dd><p>
  97             Generate a DLV set instead of a DS set.  The specified
  98             <code class="option">domain</code> is appended to the name for each
  99             record in the set.
 100             The DNSSEC Lookaside Validation (DLV) RR is described
 101             in RFC 4431.
 102           </p></dd>
 103 <dt><span class="term">-s</span></dt>
 104 <dd><p>
 105             Keyset mode: in place of the keyfile name, the argument is
 106             the DNS domain name of a keyset file.
 107           </p></dd>
 108 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
 109 <dd><p>
 110             Specifies the DNS class (default is IN).  Useful only
 111             in keyset or zone file mode.
 112           </p></dd>
 113 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 114 <dd><p>
 115             Sets the debugging level.
 116           </p></dd>
 117 <dt><span class="term">-h</span></dt>
 118 <dd><p>
 119             Prints usage information.
 120           </p></dd>
 121 <dt><span class="term">-V</span></dt>
 122 <dd><p>
 123             Prints version information.
 124           </p></dd>
 125 </dl></div>
 126 </div>
 127 <div class="refsect1" lang="en">
 128 <a name="id2543780"></a><h2>EXAMPLE</h2>
 129 <p>
 130       To build the SHA-256 DS RR from the
 131       <strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
 132       keyfile name, the following command would be issued:
 133     </p>
 134 <p><strong class="userinput"><code>dnssec-dsfromkey -2 Kexample.com.+003+26160</code></strong>
 135     </p>
 136 <p>
 137       The command would print something like:
 138     </p>
 139 <p><strong class="userinput"><code>example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94</code></strong>
 140     </p>
 141 </div>
 142 <div class="refsect1" lang="en">
 143 <a name="id2543810"></a><h2>FILES</h2>
 144 <p>
 145       The keyfile can be designed by the key identification
 146       <code class="filename">Knnnn.+aaa+iiiii</code> or the full file name
 147       <code class="filename">Knnnn.+aaa+iiiii.key</code> as generated by
 148       <span class="refentrytitle">dnssec-keygen</span>(8).
 149     </p>
 150 <p>
 151       The keyset file name is built from the <code class="option">directory</code>,
 152       the string <code class="filename">keyset-</code> and the
 153       <code class="option">dnsname</code>.
 154     </p>
 155 </div>
 156 <div class="refsect1" lang="en">
 157 <a name="id2543845"></a><h2>CAVEAT</h2>
 158 <p>
 159       A keyfile error can give a "file not found" even if the file exists.
 160     </p>
 161 </div>
 162 <div class="refsect1" lang="en">
 163 <a name="id2543854"></a><h2>SEE ALSO</h2>
 164 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 165       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 166       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 167       <em class="citetitle">RFC 3658</em>,
 168       <em class="citetitle">RFC 4431</em>.
 169       <em class="citetitle">RFC 4509</em>.
 170     </p>
 171 </div>
 172 <div class="refsect1" lang="en">
 173 <a name="id2543894"></a><h2>AUTHOR</h2>
 174 <p><span class="corpauthor">Internet Systems Consortium</span>
 175     </p>
 176 </div>
 177 </div></body>
 178 </html>