ef20fcd3109bdb6f690852cda027201b8b4f047f
[dragonfly.git] / contrib / bind-9.5.2 / bin / dnssec / dnssec-keygen.html
1 <!--
2  - Copyright (C) 2004, 2005, 2007, 2008 Internet Systems Consortium, Inc. ("ISC")
3  - Copyright (C) 2000-2003 Internet Software Consortium.
4  - 
5  - Permission to use, copy, modify, and/or distribute this software for any
6  - purpose with or without fee is hereby granted, provided that the above
7  - copyright notice and this permission notice appear in all copies.
8  - 
9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15  - PERFORMANCE OF THIS SOFTWARE.
16 -->
17 <!-- $Id: dnssec-keygen.html,v 1.30.130.3 2009/07/11 01:43:27 tbox Exp $ -->
18 <html>
19 <head>
20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
21 <title>dnssec-keygen</title>
22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
23 </head>
24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
25 <a name="man.dnssec-keygen"></a><div class="titlepage"></div>
26 <div class="refnamediv">
27 <h2>Name</h2>
28 <p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
29 </div>
30 <div class="refsynopsisdiv">
31 <h2>Synopsis</h2>
32 <div class="cmdsynopsis"><p><code class="command">dnssec-keygen</code>  {-a <em class="replaceable"><code>algorithm</code></em>} {-b <em class="replaceable"><code>keysize</code></em>} {-n <em class="replaceable"><code>nametype</code></em>} [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-e</code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k</code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-s <em class="replaceable"><code>strength</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] {name}</p></div>
33 </div>
34 <div class="refsect1" lang="en">
35 <a name="id2543477"></a><h2>DESCRIPTION</h2>
36 <p><span><strong class="command">dnssec-keygen</strong></span>
37       generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
38       and RFC 4034.  It can also generate keys for use with
39       TSIG (Transaction Signatures), as defined in RFC 2845.
40     </p>
41 </div>
42 <div class="refsect1" lang="en">
43 <a name="id2543489"></a><h2>OPTIONS</h2>
44 <div class="variablelist"><dl>
45 <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
46 <dd>
47 <p>
48             Selects the cryptographic algorithm.  The value of
49             <code class="option">algorithm</code> must be one of RSAMD5 (RSA) or RSASHA1,
50                       DSA, DH (Diffie Hellman), or HMAC-MD5.  These values
51             are case insensitive.
52           </p>
53 <p>
54             Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
55             algorithm,
56             and DSA is recommended.  For TSIG, HMAC-MD5 is mandatory.
57           </p>
58 <p>
59             Note 2: HMAC-MD5 and DH automatically set the -k flag.
60           </p>
61 </dd>
62 <dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
63 <dd><p>
64             Specifies the number of bits in the key.  The choice of key
65             size depends on the algorithm used.  RSAMD5 / RSASHA1 keys must be
66             between
67             512 and 2048 bits.  Diffie Hellman keys must be between
68             128 and 4096 bits.  DSA keys must be between 512 and 1024
69             bits and an exact multiple of 64.  HMAC-MD5 keys must be
70             between 1 and 512 bits.
71           </p></dd>
72 <dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
73 <dd><p>
74             Specifies the owner type of the key.  The value of
75             <code class="option">nametype</code> must either be ZONE (for a DNSSEC
76             zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
77             a host (KEY)),
78             USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
79             These values are case insensitive.  Defaults to ZONE for DNSKEY
80             generation.
81           </p></dd>
82 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
83 <dd><p>
84             Indicates that the DNS record containing the key should have
85             the specified class.  If not specified, class IN is used.
86           </p></dd>
87 <dt><span class="term">-e</span></dt>
88 <dd><p>
89             If generating an RSAMD5/RSASHA1 key, use a large exponent.
90           </p></dd>
91 <dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
92 <dd><p>
93             Set the specified flag in the flag field of the KEY/DNSKEY record.
94                         The only recognized flag is KSK (Key Signing Key) DNSKEY.
95           </p></dd>
96 <dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
97 <dd><p>
98             If generating a Diffie Hellman key, use this generator.
99             Allowed values are 2 and 5.  If no generator
100             is specified, a known prime from RFC 2539 will be used
101             if possible; otherwise the default is 2.
102           </p></dd>
103 <dt><span class="term">-h</span></dt>
104 <dd><p>
105             Prints a short summary of the options and arguments to
106             <span><strong class="command">dnssec-keygen</strong></span>.
107           </p></dd>
108 <dt><span class="term">-k</span></dt>
109 <dd><p>
110             Generate KEY records rather than DNSKEY records.
111           </p></dd>
112 <dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
113 <dd><p>
114             Sets the protocol value for the generated key.  The protocol
115             is a number between 0 and 255.  The default is 3 (DNSSEC).
116             Other possible values for this argument are listed in
117             RFC 2535 and its successors.
118           </p></dd>
119 <dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
120 <dd><p>
121             Specifies the source of randomness.  If the operating
122             system does not provide a <code class="filename">/dev/random</code>
123             or equivalent device, the default source of randomness
124             is keyboard input.  <code class="filename">randomdev</code>
125             specifies
126             the name of a character device or file containing random
127             data to be used instead of the default.  The special value
128             <code class="filename">keyboard</code> indicates that keyboard
129             input should be used.
130           </p></dd>
131 <dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
132 <dd><p>
133             Specifies the strength value of the key.  The strength is
134             a number between 0 and 15, and currently has no defined
135             purpose in DNSSEC.
136           </p></dd>
137 <dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
138 <dd><p>
139             Indicates the use of the key.  <code class="option">type</code> must be
140             one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF.  The default
141             is AUTHCONF.  AUTH refers to the ability to authenticate
142             data, and CONF the ability to encrypt data.
143           </p></dd>
144 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
145 <dd><p>
146             Sets the debugging level.
147           </p></dd>
148 </dl></div>
149 </div>
150 <div class="refsect1" lang="en">
151 <a name="id2543824"></a><h2>GENERATED KEYS</h2>
152 <p>
153       When <span><strong class="command">dnssec-keygen</strong></span> completes
154       successfully,
155       it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
156       to the standard output.  This is an identification string for
157       the key it has generated.
158     </p>
159 <div class="itemizedlist"><ul type="disc">
160 <li><p><code class="filename">nnnn</code> is the key name.
161         </p></li>
162 <li><p><code class="filename">aaa</code> is the numeric representation
163           of the
164           algorithm.
165         </p></li>
166 <li><p><code class="filename">iiiii</code> is the key identifier (or
167           footprint).
168         </p></li>
169 </ul></div>
170 <p><span><strong class="command">dnssec-keygen</strong></span> 
171       creates two files, with names based
172       on the printed string.  <code class="filename">Knnnn.+aaa+iiiii.key</code>
173       contains the public key, and
174       <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
175       private
176       key.
177     </p>
178 <p>
179       The <code class="filename">.key</code> file contains a DNS KEY record
180       that
181       can be inserted into a zone file (directly or with a $INCLUDE
182       statement).
183     </p>
184 <p>
185       The <code class="filename">.private</code> file contains
186       algorithm-specific
187       fields.  For obvious security reasons, this file does not have
188       general read permission.
189     </p>
190 <p>
191       Both <code class="filename">.key</code> and <code class="filename">.private</code>
192       files are generated for symmetric encryption algorithms such as
193       HMAC-MD5, even though the public and private key are equivalent.
194     </p>
195 </div>
196 <div class="refsect1" lang="en">
197 <a name="id2543906"></a><h2>EXAMPLE</h2>
198 <p>
199       To generate a 768-bit DSA key for the domain
200       <strong class="userinput"><code>example.com</code></strong>, the following command would be
201       issued:
202     </p>
203 <p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
204     </p>
205 <p>
206       The command would print a string of the form:
207     </p>
208 <p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
209     </p>
210 <p>
211       In this example, <span><strong class="command">dnssec-keygen</strong></span> creates
212       the files <code class="filename">Kexample.com.+003+26160.key</code>
213       and
214       <code class="filename">Kexample.com.+003+26160.private</code>.
215     </p>
216 </div>
217 <div class="refsect1" lang="en">
218 <a name="id2543949"></a><h2>SEE ALSO</h2>
219 <p><span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
220       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
221       <em class="citetitle">RFC 2539</em>,
222       <em class="citetitle">RFC 2845</em>,
223       <em class="citetitle">RFC 4033</em>.
224     </p>
225 </div>
226 <div class="refsect1" lang="en">
227 <a name="id2544049"></a><h2>AUTHOR</h2>
228 <p><span class="corpauthor">Internet Systems Consortium</span>
229     </p>
230 </div>
231 </div></body>
232 </html>