1<!-- 2 - Copyright (C) 2004-2015 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: man.dnssec-keygen.html,v 1.5 2015/09/03 07:33:34 christos 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<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual"> 24<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages"> 25<link rel="prev" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel"> 26<link rel="next" href="man.dnssec-revoke.html" title="dnssec-revoke"> 27</head> 28<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 29<div class="navheader"> 30<table width="100%" summary="Navigation header"> 31<tr><th colspan="3" align="center"><span class="application">dnssec-keygen</span></th></tr> 32<tr> 33<td width="20%" align="left"> 34<a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a>�</td> 35<th width="60%" align="center">Manual pages</th> 36<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-revoke.html">Next</a> 37</td> 38</tr> 39</table> 40<hr> 41</div> 42<div class="refentry" lang="en"> 43<a name="man.dnssec-keygen"></a><div class="titlepage"></div> 44<div class="refnamediv"> 45<h2>Name</h2> 46<p><span class="application">dnssec-keygen</span> — DNSSEC key generation tool</p> 47</div> 48<div class="refsynopsisdiv"> 49<h2>Synopsis</h2> 50<div class="cmdsynopsis"><p><code class="command">dnssec-keygen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-3</code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-C</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>] [<code class="option">-h</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-k</code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-q</code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-S <em class="replaceable"><code>key</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>] [<code class="option">-V</code>] [<code class="option">-z</code>] {name}</p></div> 51</div> 52<div class="refsect1" lang="en"> 53<a name="id2622369"></a><h2>DESCRIPTION</h2> 54<p><span><strong class="command">dnssec-keygen</strong></span> 55 generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 56 and RFC 4034. It can also generate keys for use with 57 TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY 58 (Transaction Key) as defined in RFC 2930. 59 </p> 60<p> 61 The <code class="option">name</code> of the key is specified on the command 62 line. For DNSSEC keys, this must match the name of the zone for 63 which the key is being generated. 64 </p> 65</div> 66<div class="refsect1" lang="en"> 67<a name="id2622389"></a><h2>OPTIONS</h2> 68<div class="variablelist"><dl> 69<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt> 70<dd> 71<p> 72 Selects the cryptographic algorithm. For DNSSEC keys, the value 73 of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1, 74 DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, 75 ECDSAP256SHA256 or ECDSAP384SHA384. 76 For TSIG/TKEY, the value must 77 be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224, 78 HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are 79 case insensitive. 80 </p> 81<p> 82 If no algorithm is specified, then RSASHA1 will be used by 83 default, unless the <code class="option">-3</code> option is specified, 84 in which case NSEC3RSASHA1 will be used instead. (If 85 <code class="option">-3</code> is used and an algorithm is specified, 86 that algorithm will be checked for compatibility with NSEC3.) 87 </p> 88<p> 89 Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement 90 algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is 91 mandatory. 92 </p> 93<p> 94 Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512 95 automatically set the -T KEY option. 96 </p> 97</dd> 98<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt> 99<dd> 100<p> 101 Specifies the number of bits in the key. The choice of key 102 size depends on the algorithm used. RSA keys must be 103 between 512 and 2048 bits. Diffie Hellman keys must be between 104 128 and 4096 bits. DSA keys must be between 512 and 1024 105 bits and an exact multiple of 64. HMAC keys must be 106 between 1 and 512 bits. Elliptic curve algorithms don't need 107 this parameter. 108 </p> 109<p> 110 The key size does not need to be specified if using a default 111 algorithm. The default key size is 1024 bits for zone signing 112 keys (ZSK's) and 2048 bits for key signing keys (KSK's, 113 generated with <code class="option">-f KSK</code>). However, if an 114 algorithm is explicitly specified with the <code class="option">-a</code>, 115 then there is no default key size, and the <code class="option">-b</code> 116 must be used. 117 </p> 118</dd> 119<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt> 120<dd><p> 121 Specifies the owner type of the key. The value of 122 <code class="option">nametype</code> must either be ZONE (for a DNSSEC 123 zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with 124 a host (KEY)), 125 USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). 126 These values are case insensitive. Defaults to ZONE for DNSKEY 127 generation. 128 </p></dd> 129<dt><span class="term">-3</span></dt> 130<dd><p> 131 Use an NSEC3-capable algorithm to generate a DNSSEC key. 132 If this option is used and no algorithm is explicitly 133 set on the command line, NSEC3RSASHA1 will be used by 134 default. Note that RSASHA256, RSASHA512, ECCGOST, 135 ECDSAP256SHA256 and ECDSAP384SHA384 algorithms 136 are NSEC3-capable. 137 </p></dd> 138<dt><span class="term">-C</span></dt> 139<dd><p> 140 Compatibility mode: generates an old-style key, without 141 any metadata. By default, <span><strong class="command">dnssec-keygen</strong></span> 142 will include the key's creation date in the metadata stored 143 with the private key, and other dates may be set there as well 144 (publication date, activation date, etc). Keys that include 145 this data may be incompatible with older versions of BIND; the 146 <code class="option">-C</code> option suppresses them. 147 </p></dd> 148<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt> 149<dd><p> 150 Indicates that the DNS record containing the key should have 151 the specified class. If not specified, class IN is used. 152 </p></dd> 153<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt> 154<dd> 155<p> 156 Specifies the cryptographic hardware to use, when applicable. 157 </p> 158<p> 159 When BIND is built with OpenSSL PKCS#11 support, this defaults 160 to the string "pkcs11", which identifies an OpenSSL engine 161 that can drive a cryptographic accelerator or hardware service 162 module. When BIND is built with native PKCS#11 cryptography 163 (--enable-native-pkcs11), it defaults to the path of the PKCS#11 164 provider library specified via "--with-pkcs11". 165 </p> 166</dd> 167<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt> 168<dd><p> 169 Set the specified flag in the flag field of the KEY/DNSKEY record. 170 The only recognized flags are KSK (Key Signing Key) and REVOKE. 171 </p></dd> 172<dt><span class="term">-G</span></dt> 173<dd><p> 174 Generate a key, but do not publish it or sign with it. This 175 option is incompatible with -P and -A. 176 </p></dd> 177<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt> 178<dd><p> 179 If generating a Diffie Hellman key, use this generator. 180 Allowed values are 2 and 5. If no generator 181 is specified, a known prime from RFC 2539 will be used 182 if possible; otherwise the default is 2. 183 </p></dd> 184<dt><span class="term">-h</span></dt> 185<dd><p> 186 Prints a short summary of the options and arguments to 187 <span><strong class="command">dnssec-keygen</strong></span>. 188 </p></dd> 189<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt> 190<dd><p> 191 Sets the directory in which the key files are to be written. 192 </p></dd> 193<dt><span class="term">-k</span></dt> 194<dd><p> 195 Deprecated in favor of -T KEY. 196 </p></dd> 197<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt> 198<dd><p> 199 Sets the default TTL to use for this key when it is converted 200 into a DNSKEY RR. If the key is imported into a zone, 201 this is the TTL that will be used for it, unless there was 202 already a DNSKEY RRset in place, in which case the existing TTL 203 would take precedence. If this value is not set and there 204 is no existing DNSKEY RRset, the TTL will default to the 205 SOA TTL. Setting the default TTL to <code class="literal">0</code> 206 or <code class="literal">none</code> is the same as leaving it unset. 207 </p></dd> 208<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt> 209<dd><p> 210 Sets the protocol value for the generated key. The protocol 211 is a number between 0 and 255. The default is 3 (DNSSEC). 212 Other possible values for this argument are listed in 213 RFC 2535 and its successors. 214 </p></dd> 215<dt><span class="term">-q</span></dt> 216<dd><p> 217 Quiet mode: Suppresses unnecessary output, including 218 progress indication. Without this option, when 219 <span><strong class="command">dnssec-keygen</strong></span> is run interactively 220 to generate an RSA or DSA key pair, it will print a string 221 of symbols to <code class="filename">stderr</code> indicating the 222 progress of the key generation. A '.' indicates that a 223 random number has been found which passed an initial 224 sieve test; '+' means a number has passed a single 225 round of the Miller-Rabin primality test; a space 226 means that the number has passed all the tests and is 227 a satisfactory key. 228 </p></dd> 229<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt> 230<dd><p> 231 Specifies the source of randomness. If the operating 232 system does not provide a <code class="filename">/dev/random</code> 233 or equivalent device, the default source of randomness 234 is keyboard input. <code class="filename">randomdev</code> 235 specifies 236 the name of a character device or file containing random 237 data to be used instead of the default. The special value 238 <code class="filename">keyboard</code> indicates that keyboard 239 input should be used. 240 </p></dd> 241<dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt> 242<dd><p> 243 Create a new key which is an explicit successor to an 244 existing key. The name, algorithm, size, and type of the 245 key will be set to match the existing key. The activation 246 date of the new key will be set to the inactivation date of 247 the existing one. The publication date will be set to the 248 activation date minus the prepublication interval, which 249 defaults to 30 days. 250 </p></dd> 251<dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt> 252<dd><p> 253 Specifies the strength value of the key. The strength is 254 a number between 0 and 15, and currently has no defined 255 purpose in DNSSEC. 256 </p></dd> 257<dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt> 258<dd> 259<p> 260 Specifies the resource record type to use for the key. 261 <code class="option">rrtype</code> must be either DNSKEY or KEY. The 262 default is DNSKEY when using a DNSSEC algorithm, but it can be 263 overridden to KEY for use with SIG(0). 264 </p> 265<p> 266 </p> 267<p> 268 Using any TSIG algorithm (HMAC-* or DH) forces this option 269 to KEY. 270 </p> 271</dd> 272<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt> 273<dd><p> 274 Indicates the use of the key. <code class="option">type</code> must be 275 one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default 276 is AUTHCONF. AUTH refers to the ability to authenticate 277 data, and CONF the ability to encrypt data. 278 </p></dd> 279<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt> 280<dd><p> 281 Sets the debugging level. 282 </p></dd> 283<dt><span class="term">-V</span></dt> 284<dd><p> 285 Prints version information. 286 </p></dd> 287</dl></div> 288</div> 289<div class="refsect1" lang="en"> 290<a name="id2673181"></a><h2>TIMING OPTIONS</h2> 291<p> 292 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. 293 If the argument begins with a '+' or '-', it is interpreted as 294 an offset from the present time. For convenience, if such an offset 295 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', 296 then the offset is computed in years (defined as 365 24-hour days, 297 ignoring leap years), months (defined as 30 24-hour days), weeks, 298 days, hours, or minutes, respectively. Without a suffix, the offset 299 is computed in seconds. To explicitly prevent a date from being 300 set, use 'none' or 'never'. 301 </p> 302<div class="variablelist"><dl> 303<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt> 304<dd><p> 305 Sets the date on which a key is to be published to the zone. 306 After that date, the key will be included in the zone but will 307 not be used to sign it. If not set, and if the -G option has 308 not been used, the default is "now". 309 </p></dd> 310<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt> 311<dd><p> 312 Sets the date on which the key is to be activated. After that 313 date, the key will be included in the zone and used to sign 314 it. If not set, and if the -G option has not been used, the 315 default is "now". If set, if and -P is not set, then 316 the publication date will be set to the activation date 317 minus the prepublication interval. 318 </p></dd> 319<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt> 320<dd><p> 321 Sets the date on which the key is to be revoked. After that 322 date, the key will be flagged as revoked. It will be included 323 in the zone and will be used to sign it. 324 </p></dd> 325<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt> 326<dd><p> 327 Sets the date on which the key is to be retired. After that 328 date, the key will still be included in the zone, but it 329 will not be used to sign it. 330 </p></dd> 331<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt> 332<dd><p> 333 Sets the date on which the key is to be deleted. After that 334 date, the key will no longer be included in the zone. (It 335 may remain in the key repository, however.) 336 </p></dd> 337<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt> 338<dd> 339<p> 340 Sets the prepublication interval for a key. If set, then 341 the publication and activation dates must be separated by at least 342 this much time. If the activation date is specified but the 343 publication date isn't, then the publication date will default 344 to this much time before the activation date; conversely, if 345 the publication date is specified but activation date isn't, 346 then activation will be set to this much time after publication. 347 </p> 348<p> 349 If the key is being created as an explicit successor to another 350 key, then the default prepublication interval is 30 days; 351 otherwise it is zero. 352 </p> 353<p> 354 As with date offsets, if the argument is followed by one of 355 the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the 356 interval is measured in years, months, weeks, days, hours, 357 or minutes, respectively. Without a suffix, the interval is 358 measured in seconds. 359 </p> 360</dd> 361</dl></div> 362</div> 363<div class="refsect1" lang="en"> 364<a name="id2673371"></a><h2>GENERATED KEYS</h2> 365<p> 366 When <span><strong class="command">dnssec-keygen</strong></span> completes 367 successfully, 368 it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code> 369 to the standard output. This is an identification string for 370 the key it has generated. 371 </p> 372<div class="itemizedlist"><ul type="disc"> 373<li><p><code class="filename">nnnn</code> is the key name. 374 </p></li> 375<li><p><code class="filename">aaa</code> is the numeric representation 376 of the 377 algorithm. 378 </p></li> 379<li><p><code class="filename">iiiii</code> is the key identifier (or 380 footprint). 381 </p></li> 382</ul></div> 383<p><span><strong class="command">dnssec-keygen</strong></span> 384 creates two files, with names based 385 on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code> 386 contains the public key, and 387 <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the 388 private 389 key. 390 </p> 391<p> 392 The <code class="filename">.key</code> file contains a DNS KEY record 393 that 394 can be inserted into a zone file (directly or with a $INCLUDE 395 statement). 396 </p> 397<p> 398 The <code class="filename">.private</code> file contains 399 algorithm-specific 400 fields. For obvious security reasons, this file does not have 401 general read permission. 402 </p> 403<p> 404 Both <code class="filename">.key</code> and <code class="filename">.private</code> 405 files are generated for symmetric encryption algorithms such as 406 HMAC-MD5, even though the public and private key are equivalent. 407 </p> 408</div> 409<div class="refsect1" lang="en"> 410<a name="id2673547"></a><h2>EXAMPLE</h2> 411<p> 412 To generate a 768-bit DSA key for the domain 413 <strong class="userinput"><code>example.com</code></strong>, the following command would be 414 issued: 415 </p> 416<p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong> 417 </p> 418<p> 419 The command would print a string of the form: 420 </p> 421<p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong> 422 </p> 423<p> 424 In this example, <span><strong class="command">dnssec-keygen</strong></span> creates 425 the files <code class="filename">Kexample.com.+003+26160.key</code> 426 and 427 <code class="filename">Kexample.com.+003+26160.private</code>. 428 </p> 429</div> 430<div class="refsect1" lang="en"> 431<a name="id2673604"></a><h2>SEE ALSO</h2> 432<p><span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, 433 <em class="citetitle">BIND 9 Administrator Reference Manual</em>, 434 <em class="citetitle">RFC 2539</em>, 435 <em class="citetitle">RFC 2845</em>, 436 <em class="citetitle">RFC 4034</em>. 437 </p> 438</div> 439<div class="refsect1" lang="en"> 440<a name="id2673635"></a><h2>AUTHOR</h2> 441<p><span class="corpauthor">Internet Systems Consortium</span> 442 </p> 443</div> 444</div> 445<div class="navfooter"> 446<hr> 447<table width="100%" summary="Navigation footer"> 448<tr> 449<td width="40%" align="left"> 450<a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a>�</td> 451<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td> 452<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-revoke.html">Next</a> 453</td> 454</tr> 455<tr> 456<td width="40%" align="left" valign="top"> 457<span class="application">dnssec-keyfromlabel</span>�</td> 458<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td> 459<td width="40%" align="right" valign="top">�<span class="application">dnssec-revoke</span> 460</td> 461</tr> 462</table> 463</div> 464<p style="text-align: center;">BIND 9.10.2-P4</p> 465</body> 466</html> 467