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