external/bsd/bind/dist/bin/dnssec/dnssec-dsfromkey.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2008, 2009  Internet Systems Consortium, Inc. ("ISC")
   6  -
   7  - Permission to use, copy, modify, and/or distribute this software for any
   8  - purpose with or without fee is hereby granted, provided that the above
   9  - copyright notice and this permission notice appear in all copies.
  10  -
  11  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  12  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  13  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  14  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  15  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  16  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17  - PERFORMANCE OF THIS SOFTWARE.
  18 -->
  19
  20 <!-- Id: dnssec-dsfromkey.docbook,v 1.10 2009/08/26 21:56:05 jreed Exp -->
  21 <refentry id="man.dnssec-dsfromkey">
  22   <refentryinfo>
  23     <date>August 26, 2009</date>
  24   </refentryinfo>
  25
  26   <refmeta>
  27     <refentrytitle><application>dnssec-dsfromkey</application></refentrytitle>
  28     <manvolnum>8</manvolnum>
  29     <refmiscinfo>BIND9</refmiscinfo>
  30   </refmeta>
  31
  32   <refnamediv>
  33     <refname><application>dnssec-dsfromkey</application></refname>
  34     <refpurpose>DNSSEC DS RR generation tool</refpurpose>
  35   </refnamediv>
  36
  37   <docinfo>
  38     <copyright>
  39       <year>2008</year>
  40       <year>2009</year>
  41       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  42     </copyright>
  43   </docinfo>
  44
  45   <refsynopsisdiv>
  46     <cmdsynopsis>
  47       <command>dnssec-dsfromkey</command>
  48       <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
  49       <arg><option>-1</option></arg>
  50       <arg><option>-2</option></arg>
  51       <arg><option>-a <replaceable class="parameter">alg</replaceable></option></arg>
  52       <arg><option>-l <replaceable class="parameter">domain</replaceable></option></arg>
  53       <arg choice="req">keyfile</arg>
  54     </cmdsynopsis>
  55     <cmdsynopsis>
  56       <command>dnssec-dsfromkey</command>
  57       <arg choice="req">-s</arg>
  58       <arg><option>-1</option></arg>
  59       <arg><option>-2</option></arg>
  60       <arg><option>-a <replaceable class="parameter">alg</replaceable></option></arg>
  61       <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
  62       <arg><option>-l <replaceable class="parameter">domain</replaceable></option></arg>
  63       <arg><option>-s</option></arg>
  64       <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
  65       <arg><option>-f <replaceable class="parameter">file</replaceable></option></arg>
  66       <arg><option>-A</option></arg>
  67       <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
  68       <arg choice="req">dnsname</arg>
  69    </cmdsynopsis>
  70   </refsynopsisdiv>
  71
  72   <refsect1>
  73     <title>DESCRIPTION</title>
  74     <para><command>dnssec-dsfromkey</command>
  75       outputs the Delegation Signer (DS) resource record (RR), as defined in
  76       RFC 3658 and RFC 4509, for the given key(s).
  77     </para>
  78   </refsect1>
  79
  80   <refsect1>
  81     <title>OPTIONS</title>
  82
  83     <variablelist>
  84       <varlistentry>
  85         <term>-1</term>
  86         <listitem>
  87           <para>
  88             Use SHA-1 as the digest algorithm (the default is to use
  89             both SHA-1 and SHA-256).
  90           </para>
  91         </listitem>
  92       </varlistentry>
  93
  94       <varlistentry>
  95         <term>-2</term>
  96         <listitem>
  97           <para>
  98             Use SHA-256 as the digest algorithm.
  99           </para>
 100         </listitem>
 101       </varlistentry>
 102
 103       <varlistentry>
 104         <term>-a <replaceable class="parameter">algorithm</replaceable></term>
 105         <listitem>
 106           <para>
 107             Select the digest algorithm. The value of
 108             <option>algorithm</option> must be one of SHA-1 (SHA1) or
 109             SHA-256 (SHA256). These values are case insensitive.
 110           </para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term>-K <replaceable class="parameter">directory</replaceable></term>
 116         <listitem>
 117           <para>
 118             Look for key files (or, in keyset mode,
 119             <filename>keyset-</filename> files) in
 120             <option>directory</option>.
 121           </para>
 122         </listitem>
 123       </varlistentry>
 124
 125       <varlistentry>
 126         <term>-f <replaceable class="parameter">file</replaceable></term>
 127         <listitem>
 128           <para>
 129             Zone file mode: in place of the keyfile name, the argument is
 130             the DNS domain name of a zone master file, which can be read
 131             from <option>file</option>.  If the zone name is the same as
 132             <option>file</option>, then it may be omitted.
 133           </para>
 134         </listitem>
 135       </varlistentry>
 136
 137       <varlistentry>
 138         <term>-A</term>
 139         <listitem>
 140           <para>
 141             Include ZSK's when generating DS records.  Without this option,
 142             only keys which have the KSK flag set will be converted to DS
 143             records and printed.  Useful only in zone file mode.
 144           </para>
 145         </listitem>
 146       </varlistentry>
 147
 148       <varlistentry>
 149         <term>-l <replaceable class="parameter">domain</replaceable></term>
 150         <listitem>
 151           <para>
 152             Generate a DLV set instead of a DS set.  The specified
 153             <option>domain</option> is appended to the name for each
 154             record in the set.
 155             The DNSSEC Lookaside Validation (DLV) RR is described
 156             in RFC 4431.
 157           </para>
 158         </listitem>
 159       </varlistentry>
 160
 161       <varlistentry>
 162         <term>-s</term>
 163         <listitem>
 164           <para>
 165             Keyset mode: in place of the keyfile name, the argument is
 166             the DNS domain name of a keyset file.
 167           </para>
 168         </listitem>
 169       </varlistentry>
 170
 171       <varlistentry>
 172         <term>-c <replaceable class="parameter">class</replaceable></term>
 173         <listitem>
 174           <para>
 175             Specifies the DNS class (default is IN).  Useful only
 176             in keyset or zone file mode.
 177           </para>
 178           </listitem>
 179       </varlistentry>
 180
 181       <varlistentry>
 182         <term>-v <replaceable class="parameter">level</replaceable></term>
 183         <listitem>
 184           <para>
 185             Sets the debugging level.
 186           </para>
 187         </listitem>
 188       </varlistentry>
 189     </variablelist>
 190   </refsect1>
 191
 192   <refsect1>
 193     <title>EXAMPLE</title>
 194     <para>
 195       To build the SHA-256 DS RR from the
 196       <userinput>Kexample.com.+003+26160</userinput>
 197       keyfile name, the following command would be issued:
 198     </para>
 199     <para><userinput>dnssec-dsfromkey -2 Kexample.com.+003+26160</userinput>
 200     </para>
 201     <para>
 202       The command would print something like:
 203     </para>
 204     <para><userinput>example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94</userinput>
 205     </para>
 206   </refsect1>
 207
 208   <refsect1>
 209     <title>FILES</title>
 210     <para>
 211       The keyfile can be designed by the key identification
 212       <filename>Knnnn.+aaa+iiiii</filename> or the full file name
 213       <filename>Knnnn.+aaa+iiiii.key</filename> as generated by
 214       <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>.
 215     </para>
 216     <para>
 217       The keyset file name is built from the <option>directory</option>,
 218       the string <filename>keyset-</filename> and the
 219       <option>dnsname</option>.
 220     </para>
 221   </refsect1>
 222
 223   <refsect1>
 224     <title>CAVEAT</title>
 225     <para>
 226       A keyfile error can give a "file not found" even if the file exists.
 227     </para>
 228   </refsect1>
 229
 230   <refsect1>
 231     <title>SEE ALSO</title>
 232     <para><citerefentry>
 233         <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
 234       </citerefentry>,
 235       <citerefentry>
 236         <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
 237       </citerefentry>,
 238       <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
 239       <citetitle>RFC 3658</citetitle>,
 240       <citetitle>RFC 4431</citetitle>.
 241       <citetitle>RFC 4509</citetitle>.
 242     </para>
 243   </refsect1>
 244
 245   <refsect1>
 246     <title>AUTHOR</title>
 247     <para><corpauthor>Internet Systems Consortium</corpauthor>
 248     </para>
 249   </refsect1>
 250
 251 </refentry><!--
 252  - Local variables:
 253  - mode: sgml
 254  - End:
 255 -->