dnssec-keygen.docbook 22.4 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.34 2010/08/16 22:21:06 marka 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>-i <replaceable class="parameter">interval</replaceable></option></arg>
75
      <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
76
      <arg><option>-k</option></arg>
77
      <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
78
      <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>
79
      <arg><option>-q</option></arg>
80
      <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
81
      <arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>
82
      <arg><option>-S <replaceable class="parameter">key</replaceable></option></arg>
83 84 85
      <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>
86
      <arg><option>-z</option></arg>
87 88 89 90 91 92
      <arg choice="req">name</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
93 94
    <para><command>dnssec-keygen</command>
      generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
95
      and RFC 4034.  It can also generate keys for use with
96 97
      TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
      (Transaction Key) as defined in RFC 2930.
98
    </para>
99 100 101 102 103
    <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>
104 105 106 107 108 109 110 111
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term>-a <replaceable class="parameter">algorithm</replaceable></term>
112 113
        <listitem>
          <para>
114 115
            Selects the cryptographic algorithm.  For DNSSEC keys, the value
            of <option>algorithm</option> must be one of RSAMD5, RSASHA1,
116 117
	    DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256 or RSASHA512.
	    For TSIG/TKEY, the value must
118 119 120 121 122 123 124
            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,
125 126 127
            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.)
128 129 130
          </para>
          <para>
            Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
131 132
            algorithm, and DSA is recommended.  For TSIG, HMAC-MD5 is
	    mandatory.
133 134
          </para>
          <para>
135 136
            Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
            automatically set the -T KEY option.
137 138
          </para>
        </listitem>
139 140 141 142
      </varlistentry>

      <varlistentry>
        <term>-b <replaceable class="parameter">keysize</replaceable></term>
143 144 145
        <listitem>
          <para>
            Specifies the number of bits in the key.  The choice of key
146
            size depends on the algorithm used.  RSA keys must be
147
            between 512 and 2048 bits.  Diffie Hellman keys must be between
148
            128 and 4096 bits.  DSA keys must be between 512 and 1024
149
            bits and an exact multiple of 64.  HMAC keys must be
150 151
            between 1 and 512 bits.
          </para>
152
          <para>
153 154 155 156 157 158 159
            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.
160
          </para>
161
        </listitem>
162 163 164 165
      </varlistentry>

      <varlistentry>
        <term>-n <replaceable class="parameter">nametype</replaceable></term>
166 167 168 169 170 171 172
        <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).
173 174
            These values are case insensitive.  Defaults to ZONE for DNSKEY
	    generation.
175 176
          </para>
        </listitem>
177 178
      </varlistentry>

179 180 181 182 183 184 185
      <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
186 187
            default. Note that RSASHA256 and RSASHA512 algorithms
	    are NSEC3-capable.
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
          </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>

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

Francis Dupont's avatar
Francis Dupont committed
217 218 219 220 221 222
      <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
Evan Hunt's avatar
Evan Hunt committed
223
            support it defaults to pkcs11; the empty name resets it to
Francis Dupont's avatar
Francis Dupont committed
224 225 226 227 228
            no engine.
          </para>
        </listitem>
      </varlistentry>

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

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

248 249 250 251 252 253 254 255 256 257
      <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>

258 259
      <varlistentry>
        <term>-g <replaceable class="parameter">generator</replaceable></term>
260 261 262 263 264 265 266 267
        <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>
268 269 270 271
      </varlistentry>

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

280 281 282 283 284 285 286 287 288
      <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>

289 290
      <varlistentry>
        <term>-k</term>
291 292
        <listitem>
          <para>
293
            Deprecated in favor of -T KEY.
294 295
          </para>
        </listitem>
296 297
      </varlistentry>

298 299
      <varlistentry>
        <term>-p <replaceable class="parameter">protocol</replaceable></term>
300 301 302 303 304 305 306 307
        <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>
308 309
      </varlistentry>

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
      <varlistentry>
        <term>-q</term>
        <listitem>
          <para>
            Quiet mode: Suppresses unnecessary output, including
            progress indication.  Without this option, when
            <command>dnssec-keygen</command> is run interactively
            to generate an RSA or DSA key pair, it will print a string
            of symbols to <filename>stderr</filename> indicating the
            progress of the key generation.  A '.' indicates that a
            random number has been found which passed an initial
            sieve test; '+' means a number has passed a single
            round of the Miller-Rabin primality test; a space
            means that the number has passed all the tests and is
            a satisfactory key.
          </para>
        </listitem>
      </varlistentry>

329 330
      <varlistentry>
        <term>-r <replaceable class="parameter">randomdev</replaceable></term>
331 332 333 334 335 336 337 338 339 340 341 342 343
        <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>
344 345
      </varlistentry>

346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
      <varlistentry>
        <term>-S <replaceable class="parameter">key</replaceable></term>
        <listitem>
          <para>
            Create a new key which is an explicit successor to an
            existing key.  The name, algorithm, size, and type of the
            key will be set to match the existing key.  The activation
            date of the new key will be set to the inactivation date of
            the existing one.  The publication date will be set to the
            activation date minus the prepublication interval, which
            defaults to 30 days.
          </para>
        </listitem>
      </varlistentry>

361 362
      <varlistentry>
        <term>-s <replaceable class="parameter">strength</replaceable></term>
363 364 365 366 367 368 369
        <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>
370 371
      </varlistentry>

372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
      <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>

388 389
      <varlistentry>
        <term>-t <replaceable class="parameter">type</replaceable></term>
390 391 392 393 394 395 396 397
        <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>
398 399 400 401
      </varlistentry>

      <varlistentry>
        <term>-v <replaceable class="parameter">level</replaceable></term>
402 403 404 405 406
        <listitem>
          <para>
            Sets the debugging level.
          </para>
        </listitem>
407 408 409 410 411
      </varlistentry>

    </variablelist>
  </refsect1>

412 413 414 415 416 417
  <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
418 419 420 421 422 423
      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.
424 425 426 427 428 429 430 431 432
    </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
433 434
            not be used to sign it.  If not set, and if the -G option has
            not been used, the default is "now".
435 436 437 438 439 440 441 442 443
          </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
444
            date, the key will be included in the zone and used to sign
445 446
            it.  If not set, and if the -G option has not been used, the
            default is "now".
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
          </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>
463
        <term>-I <replaceable class="parameter">date/offset</replaceable></term>
464 465
        <listitem>
          <para>
466 467 468
            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.
469 470 471 472 473 474 475 476 477
          </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
478 479
            date, the key will no longer be included in the zone.  (It
            may remain in the key repository, however.)
480 481 482
          </para>
        </listitem>
      </varlistentry>
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510

      <varlistentry>
        <term>-i <replaceable class="parameter">interval</replaceable></term>
        <listitem>
          <para>
            Sets the prepublication interval for a key.  If set, then
            the publication and activation dates must be separated by at least
            this much time.  If the activation date is specified but the
            publication date isn't, then the publication date will default
            to this much time before the activation date; conversely, if
            the publication date is specified but activation date isn't,
            then activation will be set to this much time after publication.
          </para>
          <para>
            If the key is being created as an explicit successor to another
            key, then the default prepublication interval is 30 days; 
            otherwise it is zero.
          </para>
          <para>
            As with date offsets, if the argument is followed by one of
            the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
            interval is measured in years, months, weeks, days, hours,
            or minutes, respectively.  Without a suffix, the interval is
            measured in seconds.
          </para>
        </listitem>
      </varlistentry>

511 512 513 514
    </variablelist>
  </refsect1>


515 516 517
  <refsect1>
    <title>GENERATED KEYS</title>
    <para>
518 519 520 521
      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
522
      the key it has generated.
523
    </para>
Brian Wellington's avatar
Brian Wellington committed
524 525
    <itemizedlist>
      <listitem>
526
        <para><filename>nnnn</filename> is the key name.
Brian Wellington's avatar
Brian Wellington committed
527 528 529
        </para>
      </listitem>
      <listitem>
530 531
        <para><filename>aaa</filename> is the numeric representation
          of the
Brian Wellington's avatar
Brian Wellington committed
532 533 534 535
          algorithm.
        </para>
      </listitem>
      <listitem>
536 537
        <para><filename>iiiii</filename> is the key identifier (or
          footprint).
Brian Wellington's avatar
Brian Wellington committed
538 539 540
        </para>
      </listitem>
    </itemizedlist>
541
    <para><command>dnssec-keygen</command> 
542
      creates two files, with names based
543 544 545 546 547
      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.
548 549
    </para>
    <para>
550 551 552 553
      The <filename>.key</filename> file contains a DNS KEY record
      that
      can be inserted into a zone file (directly or with a $INCLUDE
      statement).
554 555
    </para>
    <para>
556 557
      The <filename>.private</filename> file contains
      algorithm-specific
558 559
      fields.  For obvious security reasons, this file does not have
      general read permission.
560 561
    </para>
    <para>
562
      Both <filename>.key</filename> and <filename>.private</filename>
563
      files are generated for symmetric encryption algorithms such as
564
      HMAC-MD5, even though the public and private key are equivalent.
565 566 567 568 569 570
    </para>
  </refsect1>

  <refsect1>
    <title>EXAMPLE</title>
    <para>
571 572 573
      To generate a 768-bit DSA key for the domain
      <userinput>example.com</userinput>, the following command would be
      issued:
574
    </para>
575
    <para><userinput>dnssec-keygen -a DSA -b 768 -n ZONE example.com</userinput>
576 577
    </para>
    <para>
578
      The command would print a string of the form:
579
    </para>
580
    <para><userinput>Kexample.com.+003+26160</userinput>
581 582
    </para>
    <para>
583 584 585
      In this example, <command>dnssec-keygen</command> creates
      the files <filename>Kexample.com.+003+26160.key</filename>
      and
586
      <filename>Kexample.com.+003+26160.private</filename>.
587 588 589 590 591
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
592 593
    <para><citerefentry>
        <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
594 595
      </citerefentry>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
596
      <citetitle>RFC 2539</citetitle>,
597
      <citetitle>RFC 2845</citetitle>,
598
      <citetitle>RFC 4034</citetitle>.
599 600 601 602 603
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
604
    <para><corpauthor>Internet Systems Consortium</corpauthor>
605 606 607
    </para>
  </refsect1>

608
</refentry><!--
609 610 611 612
 - Local variables:
 - mode: sgml
 - End:
-->