contrib/bind9/doc/arm/man.dnssec-keygen.html

   1 <!--
   2  - Copyright (C) 2004-2013 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$ -->
  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.ch10.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> &#8212; 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">-z</code>] {name}</p></div>
  51 </div>
  52 <div class="refsect1" lang="en">
  53 <a name="id2617453"></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="id2617474"></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><p>
 155             Uses a crypto hardware (OpenSSL engine) for random number
 156             and, when supported, key generation. When compiled with PKCS#11
 157             support it defaults to pkcs11; the empty name resets it to
 158             no engine.
 159           </p></dd>
 160 <dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
 161 <dd><p>
 162             Set the specified flag in the flag field of the KEY/DNSKEY record.
 163             The only recognized flags are KSK (Key Signing Key) and REVOKE.
 164           </p></dd>
 165 <dt><span class="term">-G</span></dt>
 166 <dd><p>
 167             Generate a key, but do not publish it or sign with it.  This
 168             option is incompatible with -P and -A.
 169           </p></dd>
 170 <dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
 171 <dd><p>
 172             If generating a Diffie Hellman key, use this generator.
 173             Allowed values are 2 and 5.  If no generator
 174             is specified, a known prime from RFC 2539 will be used
 175             if possible; otherwise the default is 2.
 176           </p></dd>
 177 <dt><span class="term">-h</span></dt>
 178 <dd><p>
 179             Prints a short summary of the options and arguments to
 180             <span><strong class="command">dnssec-keygen</strong></span>.
 181           </p></dd>
 182 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
 183 <dd><p>
 184             Sets the directory in which the key files are to be written.
 185           </p></dd>
 186 <dt><span class="term">-k</span></dt>
 187 <dd><p>
 188             Deprecated in favor of -T KEY.
 189           </p></dd>
 190 <dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
 191 <dd><p>
 192             Sets the default TTL to use for this key when it is converted
 193             into a DNSKEY RR.  If the key is imported into a zone,
 194             this is the TTL that will be used for it, unless there was
 195             already a DNSKEY RRset in place, in which case the existing TTL
 196             would take precedence.  Setting the default TTL to
 197             <code class="literal">0</code> or <code class="literal">none</code> removes it.
 198           </p></dd>
 199 <dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
 200 <dd><p>
 201             Sets the protocol value for the generated key.  The protocol
 202             is a number between 0 and 255.  The default is 3 (DNSSEC).
 203             Other possible values for this argument are listed in
 204             RFC 2535 and its successors.
 205           </p></dd>
 206 <dt><span class="term">-q</span></dt>
 207 <dd><p>
 208             Quiet mode: Suppresses unnecessary output, including
 209             progress indication.  Without this option, when
 210             <span><strong class="command">dnssec-keygen</strong></span> is run interactively
 211             to generate an RSA or DSA key pair, it will print a string
 212             of symbols to <code class="filename">stderr</code> indicating the
 213             progress of the key generation.  A '.' indicates that a
 214             random number has been found which passed an initial
 215             sieve test; '+' means a number has passed a single
 216             round of the Miller-Rabin primality test; a space
 217             means that the number has passed all the tests and is
 218             a satisfactory key.
 219           </p></dd>
 220 <dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
 221 <dd><p>
 222             Specifies the source of randomness.  If the operating
 223             system does not provide a <code class="filename">/dev/random</code>
 224             or equivalent device, the default source of randomness
 225             is keyboard input.  <code class="filename">randomdev</code>
 226             specifies
 227             the name of a character device or file containing random
 228             data to be used instead of the default.  The special value
 229             <code class="filename">keyboard</code> indicates that keyboard
 230             input should be used.
 231           </p></dd>
 232 <dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
 233 <dd><p>
 234             Create a new key which is an explicit successor to an
 235             existing key.  The name, algorithm, size, and type of the
 236             key will be set to match the existing key.  The activation
 237             date of the new key will be set to the inactivation date of
 238             the existing one.  The publication date will be set to the
 239             activation date minus the prepublication interval, which
 240             defaults to 30 days.
 241           </p></dd>
 242 <dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
 243 <dd><p>
 244             Specifies the strength value of the key.  The strength is
 245             a number between 0 and 15, and currently has no defined
 246             purpose in DNSSEC.
 247           </p></dd>
 248 <dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt>
 249 <dd>
 250 <p>
 251             Specifies the resource record type to use for the key.
 252             <code class="option">rrtype</code> must be either DNSKEY or KEY.  The
 253             default is DNSKEY when using a DNSSEC algorithm, but it can be
 254             overridden to KEY for use with SIG(0).
 255           </p>
 256 <p>
 257           </p>
 258 <p>
 259             Using any TSIG algorithm (HMAC-* or DH) forces this option
 260             to KEY.
 261           </p>
 262 </dd>
 263 <dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
 264 <dd><p>
 265             Indicates the use of the key.  <code class="option">type</code> must be
 266             one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF.  The default
 267             is AUTHCONF.  AUTH refers to the ability to authenticate
 268             data, and CONF the ability to encrypt data.
 269           </p></dd>
 270 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 271 <dd><p>
 272             Sets the debugging level.
 273           </p></dd>
 274 </dl></div>
 275 </div>
 276 <div class="refsect1" lang="en">
 277 <a name="id2669682"></a><h2>TIMING OPTIONS</h2>
 278 <p>
 279       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 280       If the argument begins with a '+' or '-', it is interpreted as
 281       an offset from the present time.  For convenience, if such an offset
 282       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 283       then the offset is computed in years (defined as 365 24-hour days,
 284       ignoring leap years), months (defined as 30 24-hour days), weeks,
 285       days, hours, or minutes, respectively.  Without a suffix, the offset
 286       is computed in seconds.
 287     </p>
 288 <div class="variablelist"><dl>
 289 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 290 <dd><p>
 291             Sets the date on which a key is to be published to the zone.
 292             After that date, the key will be included in the zone but will
 293             not be used to sign it.  If not set, and if the -G option has
 294             not been used, the default is "now".
 295           </p></dd>
 296 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
 297 <dd><p>
 298             Sets the date on which the key is to be activated.  After that
 299             date, the key will be included in the zone and used to sign
 300             it.  If not set, and if the -G option has not been used, the
 301             default is "now".
 302           </p></dd>
 303 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
 304 <dd><p>
 305             Sets the date on which the key is to be revoked.  After that
 306             date, the key will be flagged as revoked.  It will be included
 307             in the zone and will be used to sign it.
 308           </p></dd>
 309 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
 310 <dd><p>
 311             Sets the date on which the key is to be retired.  After that
 312             date, the key will still be included in the zone, but it
 313             will not be used to sign it.
 314           </p></dd>
 315 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 316 <dd><p>
 317             Sets the date on which the key is to be deleted.  After that
 318             date, the key will no longer be included in the zone.  (It
 319             may remain in the key repository, however.)
 320           </p></dd>
 321 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
 322 <dd>
 323 <p>
 324             Sets the prepublication interval for a key.  If set, then
 325             the publication and activation dates must be separated by at least
 326             this much time.  If the activation date is specified but the
 327             publication date isn't, then the publication date will default
 328             to this much time before the activation date; conversely, if
 329             the publication date is specified but activation date isn't,
 330             then activation will be set to this much time after publication.
 331           </p>
 332 <p>
 333             If the key is being created as an explicit successor to another
 334             key, then the default prepublication interval is 30 days;
 335             otherwise it is zero.
 336           </p>
 337 <p>
 338             As with date offsets, if the argument is followed by one of
 339             the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
 340             interval is measured in years, months, weeks, days, hours,
 341             or minutes, respectively.  Without a suffix, the interval is
 342             measured in seconds.
 343           </p>
 344 </dd>
 345 </dl></div>
 346 </div>
 347 <div class="refsect1" lang="en">
 348 <a name="id2669872"></a><h2>GENERATED KEYS</h2>
 349 <p>
 350       When <span><strong class="command">dnssec-keygen</strong></span> completes
 351       successfully,
 352       it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
 353       to the standard output.  This is an identification string for
 354       the key it has generated.
 355     </p>
 356 <div class="itemizedlist"><ul type="disc">
 357 <li><p><code class="filename">nnnn</code> is the key name.
 358         </p></li>
 359 <li><p><code class="filename">aaa</code> is the numeric representation
 360           of the
 361           algorithm.
 362         </p></li>
 363 <li><p><code class="filename">iiiii</code> is the key identifier (or
 364           footprint).
 365         </p></li>
 366 </ul></div>
 367 <p><span><strong class="command">dnssec-keygen</strong></span>
 368       creates two files, with names based
 369       on the printed string.  <code class="filename">Knnnn.+aaa+iiiii.key</code>
 370       contains the public key, and
 371       <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
 372       private
 373       key.
 374     </p>
 375 <p>
 376       The <code class="filename">.key</code> file contains a DNS KEY record
 377       that
 378       can be inserted into a zone file (directly or with a $INCLUDE
 379       statement).
 380     </p>
 381 <p>
 382       The <code class="filename">.private</code> file contains
 383       algorithm-specific
 384       fields.  For obvious security reasons, this file does not have
 385       general read permission.
 386     </p>
 387 <p>
 388       Both <code class="filename">.key</code> and <code class="filename">.private</code>
 389       files are generated for symmetric encryption algorithms such as
 390       HMAC-MD5, even though the public and private key are equivalent.
 391     </p>
 392 </div>
 393 <div class="refsect1" lang="en">
 394 <a name="id2669979"></a><h2>EXAMPLE</h2>
 395 <p>
 396       To generate a 768-bit DSA key for the domain
 397       <strong class="userinput"><code>example.com</code></strong>, the following command would be
 398       issued:
 399     </p>
 400 <p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
 401     </p>
 402 <p>
 403       The command would print a string of the form:
 404     </p>
 405 <p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
 406     </p>
 407 <p>
 408       In this example, <span><strong class="command">dnssec-keygen</strong></span> creates
 409       the files <code class="filename">Kexample.com.+003+26160.key</code>
 410       and
 411       <code class="filename">Kexample.com.+003+26160.private</code>.
 412     </p>
 413 </div>
 414 <div class="refsect1" lang="en">
 415 <a name="id2670036"></a><h2>SEE ALSO</h2>
 416 <p><span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 417       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 418       <em class="citetitle">RFC 2539</em>,
 419       <em class="citetitle">RFC 2845</em>,
 420       <em class="citetitle">RFC 4034</em>.
 421     </p>
 422 </div>
 423 <div class="refsect1" lang="en">
 424 <a name="id2670067"></a><h2>AUTHOR</h2>
 425 <p><span class="corpauthor">Internet Systems Consortium</span>
 426     </p>
 427 </div>
 428 </div>
 429 <div class="navfooter">
 430 <hr>
 431 <table width="100%" summary="Navigation footer">
 432 <tr>
 433 <td width="40%" align="left">
 434 <a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a> </td>
 435 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
 436 <td width="40%" align="right"> <a accesskey="n" href="man.dnssec-revoke.html">Next</a>
 437 </td>
 438 </tr>
 439 <tr>
 440 <td width="40%" align="left" valign="top">
 441 <span class="application">dnssec-keyfromlabel</span> </td>
 442 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 443 <td width="40%" align="right" valign="top"> <span class="application">dnssec-revoke</span>
 444 </td>
 445 </tr>
 446 </table>
 447 </div>
 448 </body>
 449 </html>