dnssec-keygen.docbook 19.5 KB
Newer Older
1 2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3
	       [<!ENTITY mdash "&#8212;">]>
Brian Wellington's avatar
Brian Wellington committed
4
<!--
Automatic Updater's avatar
Automatic Updater committed
5
 - Copyright (C) 2004, 2005, 2007-2009  Internet Systems Consortium, Inc. ("ISC")
6
 - Copyright (C) 2000-2003  Internet Software Consortium.
Brian Wellington's avatar
Brian Wellington committed
7
 -
Automatic Updater's avatar
Automatic Updater committed
8
 - Permission to use, copy, modify, and/or distribute this software for any
Brian Wellington's avatar
Brian Wellington committed
9 10 11
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
Mark Andrews's avatar
Mark Andrews committed
12 13 14 15 16 17 18
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
Brian Wellington's avatar
Brian Wellington committed
19
-->
Mark Andrews's avatar
Mark Andrews committed
20

21
<!-- $Id: dnssec-keygen.docbook,v 1.31 2009/10/22 02:21:30 each Exp $ -->
22
<refentry id="man.dnssec-keygen">
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
  <refentryinfo>
    <date>June 30, 2000</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle><application>dnssec-keygen</application></refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname><application>dnssec-keygen</application></refname>
    <refpurpose>DNSSEC key generation tool</refpurpose>
  </refnamediv>

38 39 40 41
  <docinfo>
    <copyright>
      <year>2004</year>
      <year>2005</year>
Mark Andrews's avatar
Mark Andrews committed
42
      <year>2007</year>
Automatic Updater's avatar
Automatic Updater committed
43
      <year>2008</year>
Automatic Updater's avatar
Automatic Updater committed
44
      <year>2009</year>
45 46 47 48 49 50 51
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
    <copyright>
      <year>2000</year>
      <year>2001</year>
      <year>2002</year>
      <year>2003</year>
Mark Andrews's avatar
Mark Andrews committed
52
      <holder>Internet Software Consortium.</holder>
53 54 55
    </copyright>
  </docinfo>

56 57 58
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>dnssec-keygen</command>
59 60 61
      <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
      <arg ><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>
      <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>
62 63 64
      <arg><option>-3</option></arg>
      <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
      <arg><option>-C</option></arg>
65
      <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
66
      <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
Francis Dupont's avatar
Francis Dupont committed
67
      <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
68
      <arg><option>-e</option></arg>
69
      <arg><option>-f <replaceable class="parameter">flag</replaceable></option></arg>
70
      <arg><option>-G</option></arg>
71 72
      <arg><option>-g <replaceable class="parameter">generator</replaceable></option></arg>
      <arg><option>-h</option></arg>
73
      <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>
74
      <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
75
      <arg><option>-k</option></arg>
76
      <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
77
      <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>
78
      <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
79 80 81 82
      <arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>
      <arg><option>-s <replaceable class="parameter">strength</replaceable></option></arg>
      <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg>
      <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
83
      <arg><option>-z</option></arg>
84 85 86 87 88 89
      <arg choice="req">name</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
90 91
    <para><command>dnssec-keygen</command>
      generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
92
      and RFC 4034.  It can also generate keys for use with
93 94
      TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
      (Transaction Key) as defined in RFC 2930.
95
    </para>
96 97 98 99 100
    <para>
      The <option>name</option> of the key is specified on the command
      line.  For DNSSEC keys, this must match the name of the zone for
      which the key is being generated.
    </para>
101 102 103 104 105 106 107 108
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term>-a <replaceable class="parameter">algorithm</replaceable></term>
109 110
        <listitem>
          <para>
111 112
            Selects the cryptographic algorithm.  For DNSSEC keys, the value
            of <option>algorithm</option> must be one of RSAMD5, RSASHA1,
113 114
	    DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256 or RSASHA512.
	    For TSIG/TKEY, the value must
115 116 117 118 119 120 121
            be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
            HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512.  These values are
            case insensitive.
          </para>
          <para>
            If no algorithm is specified, then RSASHA1 will be used by
            default, unless the <option>-3</option> option is specified,
122 123 124
            in which case NSEC3RSASHA1 will be used instead.  (If
            <option>-3</option> is used and an algorithm is specified,
            that algorithm will be checked for compatibility with NSEC3.)
125 126 127
          </para>
          <para>
            Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
128 129
            algorithm, and DSA is recommended.  For TSIG, HMAC-MD5 is
	    mandatory.
130 131
          </para>
          <para>
132 133
            Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
            automatically set the -T KEY option.
134 135
          </para>
        </listitem>
136 137 138 139
      </varlistentry>

      <varlistentry>
        <term>-b <replaceable class="parameter">keysize</replaceable></term>
140 141 142
        <listitem>
          <para>
            Specifies the number of bits in the key.  The choice of key
143
            size depends on the algorithm used.  RSA keys must be
144
            between 512 and 2048 bits.  Diffie Hellman keys must be between
145
            128 and 4096 bits.  DSA keys must be between 512 and 1024
146
            bits and an exact multiple of 64.  HMAC keys must be
147 148
            between 1 and 512 bits.
          </para>
149
          <para>
150 151 152 153 154 155 156
            The key size does not need to be specified if using a default
            algorithm.  The default key size is 1024 bits for zone signing
            keys (ZSK's) and 2048 bits for key signing keys (KSK's,
            generated with <option>-f KSK</option>).  However, if an
            algorithm is explicitly specified with the <option>-a</option>,
            then there is no default key size, and the <option>-b</option>
            must be used.
157
          </para>
158
        </listitem>
159 160 161 162
      </varlistentry>

      <varlistentry>
        <term>-n <replaceable class="parameter">nametype</replaceable></term>
163 164 165 166 167 168 169
        <listitem>
          <para>
            Specifies the owner type of the key.  The value of
            <option>nametype</option> must either be ZONE (for a DNSSEC
            zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
            a host (KEY)),
            USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
170 171
            These values are case insensitive.  Defaults to ZONE for DNSKEY
	    generation.
172 173
          </para>
        </listitem>
174 175
      </varlistentry>

176 177 178 179 180 181 182
      <varlistentry>
        <term>-3</term>
        <listitem>
          <para>
	    Use an NSEC3-capable algorithm to generate a DNSSEC key.
            If this option is used and no algorithm is explicitly
            set on the command line, NSEC3RSASHA1 will be used by
183 184
            default. Note that RSASHA256 and RSASHA512 algorithms
	    are NSEC3-capable.
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-C</term>
        <listitem>
          <para>
	    Compatibility mode:  generates an old-style key, without
	    any metadata.  By default, <command>dnssec-keygen</command>
	    will include the key's creation date in the metadata stored
	    with the private key, and other dates may be set there as well
	    (publication date, activation date, etc).  Keys that include
	    this data may be incompatible with older versions of BIND; the
	    <option>-C</option> option suppresses them.
          </para>
        </listitem>
      </varlistentry>

204 205
      <varlistentry>
        <term>-c <replaceable class="parameter">class</replaceable></term>
206 207 208 209 210 211
        <listitem>
          <para>
            Indicates that the DNS record containing the key should have
            the specified class.  If not specified, class IN is used.
          </para>
        </listitem>
212 213
      </varlistentry>

Francis Dupont's avatar
Francis Dupont committed
214 215 216 217 218 219 220 221 222 223 224 225
      <varlistentry>
        <term>-E <replaceable class="parameter">engine</replaceable></term>
        <listitem>
          <para>
            Uses a crypto hardware (OpenSSL engine) for random number
            and, when supported, key generation. When compiled with PKCS#11
            support it defaults to pcks11, the empty name resets it to
            no engine.
          </para>
        </listitem>
      </varlistentry>

226 227
      <varlistentry>
        <term>-e</term>
228 229 230 231 232
        <listitem>
          <para>
            If generating an RSAMD5/RSASHA1 key, use a large exponent.
          </para>
        </listitem>
233 234
      </varlistentry>

235 236
      <varlistentry>
        <term>-f <replaceable class="parameter">flag</replaceable></term>
237 238 239
        <listitem>
          <para>
            Set the specified flag in the flag field of the KEY/DNSKEY record.
240
            The only recognized flags are KSK (Key Signing Key) and REVOKE.
241 242
          </para>
        </listitem>
243 244
      </varlistentry>

245 246 247 248 249 250 251 252 253 254
      <varlistentry>
        <term>-G</term>
        <listitem>
          <para>
            Generate a key, but do not publish it or sign with it.  This
            option is incompatible with -P and -A.
          </para>
        </listitem>
      </varlistentry>

255 256
      <varlistentry>
        <term>-g <replaceable class="parameter">generator</replaceable></term>
257 258 259 260 261 262 263 264
        <listitem>
          <para>
            If generating a Diffie Hellman key, use this generator.
            Allowed values are 2 and 5.  If no generator
            is specified, a known prime from RFC 2539 will be used
            if possible; otherwise the default is 2.
          </para>
        </listitem>
265 266 267 268
      </varlistentry>

      <varlistentry>
        <term>-h</term>
269 270 271 272 273 274
        <listitem>
          <para>
            Prints a short summary of the options and arguments to
            <command>dnssec-keygen</command>.
          </para>
        </listitem>
275 276
      </varlistentry>

277 278 279 280 281 282 283 284 285
      <varlistentry>
        <term>-K <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
            Sets the directory in which the key files are to be written.
          </para>
        </listitem>
      </varlistentry>

286 287
      <varlistentry>
        <term>-k</term>
288 289
        <listitem>
          <para>
290
            Deprecated in favor of -T KEY.
291 292
          </para>
        </listitem>
293 294
      </varlistentry>

295 296
      <varlistentry>
        <term>-p <replaceable class="parameter">protocol</replaceable></term>
297 298 299 300 301 302 303 304
        <listitem>
          <para>
            Sets the protocol value for the generated key.  The protocol
            is a number between 0 and 255.  The default is 3 (DNSSEC).
            Other possible values for this argument are listed in
            RFC 2535 and its successors.
          </para>
        </listitem>
305 306 307 308
      </varlistentry>

      <varlistentry>
        <term>-r <replaceable class="parameter">randomdev</replaceable></term>
309 310 311 312 313 314 315 316 317 318 319 320 321
        <listitem>
          <para>
            Specifies the source of randomness.  If the operating
            system does not provide a <filename>/dev/random</filename>
            or equivalent device, the default source of randomness
            is keyboard input.  <filename>randomdev</filename>
            specifies
            the name of a character device or file containing random
            data to be used instead of the default.  The special value
            <filename>keyboard</filename> indicates that keyboard
            input should be used.
          </para>
        </listitem>
322 323 324 325
      </varlistentry>

      <varlistentry>
        <term>-s <replaceable class="parameter">strength</replaceable></term>
326 327 328 329 330 331 332
        <listitem>
          <para>
            Specifies the strength value of the key.  The strength is
            a number between 0 and 15, and currently has no defined
            purpose in DNSSEC.
          </para>
        </listitem>
333 334
      </varlistentry>

335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
      <varlistentry>
        <term>-T <replaceable class="parameter">rrtype</replaceable></term>
        <listitem>
          <para>
            Specifies the resource record type to use for the key.
            <option>rrtype</option> must be either DNSKEY or KEY.  The
            default is DNSKEY when using a DNSSEC algorithm, but it can be
            overridden to KEY for use with SIG(0).
          <para>
          </para>
            Using any TSIG algorithm (HMAC-* or DH) forces this option
            to KEY.
          </para>
        </listitem>
      </varlistentry>

351 352
      <varlistentry>
        <term>-t <replaceable class="parameter">type</replaceable></term>
353 354 355 356 357 358 359 360
        <listitem>
          <para>
            Indicates the use of the key.  <option>type</option> must be
            one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF.  The default
            is AUTHCONF.  AUTH refers to the ability to authenticate
            data, and CONF the ability to encrypt data.
          </para>
        </listitem>
361 362 363 364
      </varlistentry>

      <varlistentry>
        <term>-v <replaceable class="parameter">level</replaceable></term>
365 366 367 368 369
        <listitem>
          <para>
            Sets the debugging level.
          </para>
        </listitem>
370 371 372 373 374
      </varlistentry>

    </variablelist>
  </refsect1>

375 376 377 378 379 380
  <refsect1>
    <title>TIMING OPTIONS</title>

    <para>
      Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
      If the argument begins with a '+' or '-', it is interpreted as
381 382 383 384 385 386
      an offset from the present time.  For convenience, if such an offset
      is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
      then the offset is computed in years (defined as 365 24-hour days,
      ignoring leap years), months (defined as 30 24-hour days), weeks,
      days, hours, or minutes, respectively.  Without a suffix, the offset
      is computed in seconds.
387 388 389 390 391 392 393 394 395
    </para>

    <variablelist>
      <varlistentry>
        <term>-P <replaceable class="parameter">date/offset</replaceable></term>
        <listitem>
          <para>
            Sets the date on which a key is to be published to the zone.
            After that date, the key will be included in the zone but will
396 397
            not be used to sign it.  If not set, and if the -G option has
            not been used, the default is "now".
398 399 400 401 402 403 404 405 406
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-A <replaceable class="parameter">date/offset</replaceable></term>
        <listitem>
          <para>
            Sets the date on which the key is to be activated.  After that
407
            date, the key will be included in the zone and used to sign
408 409
            it.  If not set, and if the -G option has not been used, the
            default is "now".
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-R <replaceable class="parameter">date/offset</replaceable></term>
        <listitem>
          <para>
            Sets the date on which the key is to be revoked.  After that
            date, the key will be flagged as revoked.  It will be included
            in the zone and will be used to sign it.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
426
        <term>-I <replaceable class="parameter">date/offset</replaceable></term>
427 428
        <listitem>
          <para>
429 430 431
            Sets the date on which the key is to be retired.  After that
            date, the key will still be included in the zone, but it
            will not be used to sign it.
432 433 434 435 436 437 438 439 440
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-D <replaceable class="parameter">date/offset</replaceable></term>
        <listitem>
          <para>
            Sets the date on which the key is to be deleted.  After that
441 442
            date, the key will no longer be included in the zone.  (It
            may remain in the key repository, however.)
443 444 445 446 447 448 449
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>


450 451 452
  <refsect1>
    <title>GENERATED KEYS</title>
    <para>
453 454 455 456
      When <command>dnssec-keygen</command> completes
      successfully,
      it prints a string of the form <filename>Knnnn.+aaa+iiiii</filename>
      to the standard output.  This is an identification string for
Mark Andrews's avatar
Mark Andrews committed
457
      the key it has generated.
458
    </para>
Brian Wellington's avatar
Brian Wellington committed
459 460
    <itemizedlist>
      <listitem>
461
        <para><filename>nnnn</filename> is the key name.
Brian Wellington's avatar
Brian Wellington committed
462 463 464
        </para>
      </listitem>
      <listitem>
465 466
        <para><filename>aaa</filename> is the numeric representation
          of the
Brian Wellington's avatar
Brian Wellington committed
467 468 469 470
          algorithm.
        </para>
      </listitem>
      <listitem>
471 472
        <para><filename>iiiii</filename> is the key identifier (or
          footprint).
Brian Wellington's avatar
Brian Wellington committed
473 474 475
        </para>
      </listitem>
    </itemizedlist>
476
    <para><command>dnssec-keygen</command> 
477
      creates two files, with names based
478 479 480 481 482
      on the printed string.  <filename>Knnnn.+aaa+iiiii.key</filename>
      contains the public key, and
      <filename>Knnnn.+aaa+iiiii.private</filename> contains the
      private
      key.
483 484
    </para>
    <para>
485 486 487 488
      The <filename>.key</filename> file contains a DNS KEY record
      that
      can be inserted into a zone file (directly or with a $INCLUDE
      statement).
489 490
    </para>
    <para>
491 492
      The <filename>.private</filename> file contains
      algorithm-specific
493 494
      fields.  For obvious security reasons, this file does not have
      general read permission.
495 496
    </para>
    <para>
497
      Both <filename>.key</filename> and <filename>.private</filename>
498
      files are generated for symmetric encryption algorithms such as
499
      HMAC-MD5, even though the public and private key are equivalent.
500 501 502 503 504 505
    </para>
  </refsect1>

  <refsect1>
    <title>EXAMPLE</title>
    <para>
506 507 508
      To generate a 768-bit DSA key for the domain
      <userinput>example.com</userinput>, the following command would be
      issued:
509
    </para>
510
    <para><userinput>dnssec-keygen -a DSA -b 768 -n ZONE example.com</userinput>
511 512
    </para>
    <para>
513
      The command would print a string of the form:
514
    </para>
515
    <para><userinput>Kexample.com.+003+26160</userinput>
516 517
    </para>
    <para>
518 519 520
      In this example, <command>dnssec-keygen</command> creates
      the files <filename>Kexample.com.+003+26160.key</filename>
      and
521
      <filename>Kexample.com.+003+26160.private</filename>.
522 523 524 525 526
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
527 528
    <para><citerefentry>
        <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
529 530
      </citerefentry>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
531
      <citetitle>RFC 2539</citetitle>,
532
      <citetitle>RFC 2845</citetitle>,
533
      <citetitle>RFC 4034</citetitle>.
534 535 536 537 538
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
539
    <para><corpauthor>Internet Systems Consortium</corpauthor>
540 541 542
    </para>
  </refsect1>

543
</refentry><!--
544 545 546 547
 - Local variables:
 - mode: sgml
 - End:
-->