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