contrib/bind9/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-2012  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.17 2011/10/25 01:54:18 marka 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       <year>2010</year>
  42       <year>2011</year>
  43       <year>2012</year>
  44       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  45     </copyright>
  46   </docinfo>
  47
  48   <refsynopsisdiv>
  49     <cmdsynopsis>
  50       <command>dnssec-dsfromkey</command>
  51       <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
  52       <arg><option>-1</option></arg>
  53       <arg><option>-2</option></arg>
  54       <arg><option>-a <replaceable class="parameter">alg</replaceable></option></arg>
  55       <arg><option>-l <replaceable class="parameter">domain</replaceable></option></arg>
  56       <arg><option>-T <replaceable class="parameter">TTL</replaceable></option></arg>
  57       <arg choice="req">keyfile</arg>
  58     </cmdsynopsis>
  59     <cmdsynopsis>
  60       <command>dnssec-dsfromkey</command>
  61       <arg choice="req">-s</arg>
  62       <arg><option>-1</option></arg>
  63       <arg><option>-2</option></arg>
  64       <arg><option>-a <replaceable class="parameter">alg</replaceable></option></arg>
  65       <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
  66       <arg><option>-l <replaceable class="parameter">domain</replaceable></option></arg>
  67       <arg><option>-s</option></arg>
  68       <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
  69       <arg><option>-T <replaceable class="parameter">TTL</replaceable></option></arg>
  70       <arg><option>-f <replaceable class="parameter">file</replaceable></option></arg>
  71       <arg><option>-A</option></arg>
  72       <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
  73       <arg choice="req">dnsname</arg>
  74    </cmdsynopsis>
  75   </refsynopsisdiv>
  76
  77   <refsect1>
  78     <title>DESCRIPTION</title>
  79     <para><command>dnssec-dsfromkey</command>
  80       outputs the Delegation Signer (DS) resource record (RR), as defined in
  81       RFC 3658 and RFC 4509, for the given key(s).
  82     </para>
  83   </refsect1>
  84
  85   <refsect1>
  86     <title>OPTIONS</title>
  87
  88     <variablelist>
  89       <varlistentry>
  90         <term>-1</term>
  91         <listitem>
  92           <para>
  93             Use SHA-1 as the digest algorithm (the default is to use
  94             both SHA-1 and SHA-256).
  95           </para>
  96         </listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term>-2</term>
 101         <listitem>
 102           <para>
 103             Use SHA-256 as the digest algorithm.
 104           </para>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term>-a <replaceable class="parameter">algorithm</replaceable></term>
 110         <listitem>
 111           <para>
 112             Select the digest algorithm. The value of
 113             <option>algorithm</option> must be one of SHA-1 (SHA1),
 114             SHA-256 (SHA256), GOST or SHA-384 (SHA384).
 115             These values are case insensitive.
 116           </para>
 117         </listitem>
 118       </varlistentry>
 119
 120       <varlistentry>
 121         <term>-T <replaceable class="parameter">TTL</replaceable></term>
 122         <listitem>
 123           <para>
 124             Specifies the TTL of the DS records.
 125           </para>
 126           </listitem>
 127       </varlistentry>
 128
 129       <varlistentry>
 130         <term>-K <replaceable class="parameter">directory</replaceable></term>
 131         <listitem>
 132           <para>
 133             Look for key files (or, in keyset mode,
 134             <filename>keyset-</filename> files) in
 135             <option>directory</option>.
 136           </para>
 137         </listitem>
 138       </varlistentry>
 139
 140       <varlistentry>
 141         <term>-f <replaceable class="parameter">file</replaceable></term>
 142         <listitem>
 143           <para>
 144             Zone file mode: in place of the keyfile name, the argument is
 145             the DNS domain name of a zone master file, which can be read
 146             from <option>file</option>.  If the zone name is the same as
 147             <option>file</option>, then it may be omitted.
 148           </para>
 149           <para>
 150             If <option>file</option> is set to <literal>"-"</literal>, then
 151             the zone data is read from the standard input.  This makes it
 152             possible to use the output of the <command>dig</command>
 153             command as input, as in:
 154           </para>
 155           <para>
 156             <userinput>dig dnskey example.com | dnssec-dsfromkey -f - example.com</userinput>
 157           </para>
 158         </listitem>
 159       </varlistentry>
 160
 161       <varlistentry>
 162         <term>-A</term>
 163         <listitem>
 164           <para>
 165             Include ZSK's when generating DS records.  Without this option,
 166             only keys which have the KSK flag set will be converted to DS
 167             records and printed.  Useful only in zone file mode.
 168           </para>
 169         </listitem>
 170       </varlistentry>
 171
 172       <varlistentry>
 173         <term>-l <replaceable class="parameter">domain</replaceable></term>
 174         <listitem>
 175           <para>
 176             Generate a DLV set instead of a DS set.  The specified
 177             <option>domain</option> is appended to the name for each
 178             record in the set.
 179             The DNSSEC Lookaside Validation (DLV) RR is described
 180             in RFC 4431.
 181           </para>
 182         </listitem>
 183       </varlistentry>
 184
 185       <varlistentry>
 186         <term>-s</term>
 187         <listitem>
 188           <para>
 189             Keyset mode: in place of the keyfile name, the argument is
 190             the DNS domain name of a keyset file.
 191           </para>
 192         </listitem>
 193       </varlistentry>
 194
 195       <varlistentry>
 196         <term>-c <replaceable class="parameter">class</replaceable></term>
 197         <listitem>
 198           <para>
 199             Specifies the DNS class (default is IN).  Useful only
 200             in keyset or zone file mode.
 201           </para>
 202           </listitem>
 203       </varlistentry>
 204
 205       <varlistentry>
 206         <term>-v <replaceable class="parameter">level</replaceable></term>
 207         <listitem>
 208           <para>
 209             Sets the debugging level.
 210           </para>
 211         </listitem>
 212       </varlistentry>
 213     </variablelist>
 214   </refsect1>
 215
 216   <refsect1>
 217     <title>EXAMPLE</title>
 218     <para>
 219       To build the SHA-256 DS RR from the
 220       <userinput>Kexample.com.+003+26160</userinput>
 221       keyfile name, the following command would be issued:
 222     </para>
 223     <para><userinput>dnssec-dsfromkey -2 Kexample.com.+003+26160</userinput>
 224     </para>
 225     <para>
 226       The command would print something like:
 227     </para>
 228     <para><userinput>example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94</userinput>
 229     </para>
 230   </refsect1>
 231
 232   <refsect1>
 233     <title>FILES</title>
 234     <para>
 235       The keyfile can be designed by the key identification
 236       <filename>Knnnn.+aaa+iiiii</filename> or the full file name
 237       <filename>Knnnn.+aaa+iiiii.key</filename> as generated by
 238       <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>.
 239     </para>
 240     <para>
 241       The keyset file name is built from the <option>directory</option>,
 242       the string <filename>keyset-</filename> and the
 243       <option>dnsname</option>.
 244     </para>
 245   </refsect1>
 246
 247   <refsect1>
 248     <title>CAVEAT</title>
 249     <para>
 250       A keyfile error can give a "file not found" even if the file exists.
 251     </para>
 252   </refsect1>
 253
 254   <refsect1>
 255     <title>SEE ALSO</title>
 256     <para><citerefentry>
 257         <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
 258       </citerefentry>,
 259       <citerefentry>
 260         <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
 261       </citerefentry>,
 262       <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
 263       <citetitle>RFC 3658</citetitle>,
 264       <citetitle>RFC 4431</citetitle>.
 265       <citetitle>RFC 4509</citetitle>.
 266     </para>
 267   </refsect1>
 268
 269   <refsect1>
 270     <title>AUTHOR</title>
 271     <para><corpauthor>Internet Systems Consortium</corpauthor>
 272     </para>
 273   </refsect1>
 274
 275 </refentry><!--
 276  - Local variables:
 277  - mode: sgml
 278  - End:
 279 -->