dnssec-keygen.docbook 24.7 KB
Newer Older
Brian Wellington's avatar
Brian Wellington committed
1
<!--
2
 - Copyright (C) 2004, 2005, 2007-2012, 2014, 2015  Internet Systems Consortium, Inc. ("ISC")
3
 - Copyright (C) 2000-2003  Internet Software Consortium.
Brian Wellington's avatar
Brian Wellington committed
4
 -
Automatic Updater's avatar
Automatic Updater committed
5
 - Permission to use, copy, modify, and/or distribute this software for any
Brian Wellington's avatar
Brian Wellington committed
6 7 8
 - 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
9 10 11 12 13 14 15
 - 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
16
-->
Tinderbox User's avatar
Tinderbox User committed
17

Evan Hunt's avatar
Evan Hunt committed
18 19 20 21 22
<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-keygen">
  <info>
    <date>2014-02-06</date>
  </info>
23
  <refentryinfo>
Evan Hunt's avatar
Evan Hunt committed
24 25
    <corpname>ISC</corpname>
    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
26 27 28 29 30 31 32 33 34 35 36 37 38
  </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>

39 40 41 42
  <docinfo>
    <copyright>
      <year>2004</year>
      <year>2005</year>
Mark Andrews's avatar
Mark Andrews committed
43
      <year>2007</year>
Automatic Updater's avatar
Automatic Updater committed
44
      <year>2008</year>
Automatic Updater's avatar
Automatic Updater committed
45
      <year>2009</year>
Automatic Updater's avatar
Automatic Updater committed
46
      <year>2010</year>
Automatic Updater's avatar
Automatic Updater committed
47
      <year>2011</year>
Tinderbox User's avatar
Tinderbox User committed
48
      <year>2012</year>
Tinderbox User's avatar
Tinderbox User committed
49
      <year>2014</year>
50
      <year>2015</year>
51 52 53 54 55 56 57
      <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
58
      <holder>Internet Software Consortium.</holder>
59 60 61
    </copyright>
  </docinfo>

62
  <refsynopsisdiv>
Evan Hunt's avatar
Evan Hunt committed
63
    <cmdsynopsis sepchar=" ">
64
      <command>dnssec-keygen</command>
Evan Hunt's avatar
Evan Hunt committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
      <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-3</option></arg>
      <arg choice="opt" rep="norepeat"><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-C</option></arg>
      <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">flag</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-G</option></arg>
      <arg choice="opt" rep="norepeat"><option>-g <replaceable class="parameter">generator</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-h</option></arg>
      <arg choice="opt" rep="norepeat"><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">interval</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-k</option></arg>
      <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-q</option></arg>
      <arg choice="opt" rep="norepeat"><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-S <replaceable class="parameter">key</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">strength</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">type</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
      <arg choice="opt" rep="norepeat"><option>-z</option></arg>
      <arg choice="req" rep="norepeat">name</arg>
95 96 97
    </cmdsynopsis>
  </refsynopsisdiv>

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

Evan Hunt's avatar
Evan Hunt committed
113 114
  <refsection><info><title>OPTIONS</title></info>
    
115 116 117 118

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

      <varlistentry>
        <term>-b <replaceable class="parameter">keysize</replaceable></term>
151 152 153
        <listitem>
          <para>
            Specifies the number of bits in the key.  The choice of key
154
            size depends on the algorithm used.  RSA keys must be
155
            between 512 and 2048 bits.  Diffie Hellman keys must be between
156
            128 and 4096 bits.  DSA keys must be between 512 and 1024
157
            bits and an exact multiple of 64.  HMAC keys must be
158 159
            between 1 and 512 bits. Elliptic curve algorithms don't need
            this parameter.
160
          </para>
161
          <para>
162 163
            The key size does not need to be specified if using a default
            algorithm.  The default key size is 1024 bits for zone signing
164
            keys (ZSKs) and 2048 bits for key signing keys (KSKs,
165 166 167 168
            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.
169
          </para>
170
        </listitem>
171 172 173 174
      </varlistentry>

      <varlistentry>
        <term>-n <replaceable class="parameter">nametype</replaceable></term>
175 176 177 178 179 180 181
        <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).
182 183
            These values are case insensitive.  Defaults to ZONE for DNSKEY
	    generation.
184 185
          </para>
        </listitem>
186 187
      </varlistentry>

188 189 190 191 192 193 194
      <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
195 196
            default. Note that RSASHA256, RSASHA512, ECCGOST,
	    ECDSAP256SHA256 and ECDSAP384SHA384 algorithms
197
	    are NSEC3-capable.
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
          </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>

217 218
      <varlistentry>
        <term>-c <replaceable class="parameter">class</replaceable></term>
219 220 221 222 223 224
        <listitem>
          <para>
            Indicates that the DNS record containing the key should have
            the specified class.  If not specified, class IN is used.
          </para>
        </listitem>
225 226
      </varlistentry>

Francis Dupont's avatar
Francis Dupont committed
227 228 229 230
      <varlistentry>
        <term>-E <replaceable class="parameter">engine</replaceable></term>
        <listitem>
          <para>
Evan Hunt's avatar
Evan Hunt committed
231 232 233 234 235 236 237 238 239
            Specifies the cryptographic hardware to use, when applicable.
          </para>
          <para>
            When BIND is built with OpenSSL PKCS#11 support, this defaults
            to the string "pkcs11", which identifies an OpenSSL engine
            that can drive a cryptographic accelerator or hardware service
            module.  When BIND is built with native PKCS#11 cryptography
            (--enable-native-pkcs11), it defaults to the path of the PKCS#11
            provider library specified via "--with-pkcs11".
Francis Dupont's avatar
Francis Dupont committed
240 241 242 243
          </para>
        </listitem>
      </varlistentry>

244 245
      <varlistentry>
        <term>-f <replaceable class="parameter">flag</replaceable></term>
246 247 248
        <listitem>
          <para>
            Set the specified flag in the flag field of the KEY/DNSKEY record.
249
            The only recognized flags are KSK (Key Signing Key) and REVOKE.
250 251
          </para>
        </listitem>
252 253
      </varlistentry>

254 255 256 257 258 259 260 261 262 263
      <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>

264 265
      <varlistentry>
        <term>-g <replaceable class="parameter">generator</replaceable></term>
266 267 268 269 270 271 272 273
        <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>
274 275 276 277
      </varlistentry>

      <varlistentry>
        <term>-h</term>
278 279 280 281 282 283
        <listitem>
          <para>
            Prints a short summary of the options and arguments to
            <command>dnssec-keygen</command>.
          </para>
        </listitem>
284 285
      </varlistentry>

286 287 288 289 290 291 292 293 294
      <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>

295 296
      <varlistentry>
        <term>-k</term>
297 298
        <listitem>
          <para>
299
            Deprecated in favor of -T KEY.
300 301
          </para>
        </listitem>
302 303
      </varlistentry>

304 305 306 307 308 309 310 311
      <varlistentry>
        <term>-L <replaceable class="parameter">ttl</replaceable></term>
        <listitem>
          <para>
            Sets the default TTL to use for this key when it is converted
            into a DNSKEY RR.  If the key is imported into a zone,
            this is the TTL that will be used for it, unless there was
            already a DNSKEY RRset in place, in which case the existing TTL
312 313 314 315
            would take precedence.  If this value is not set and there
            is no existing DNSKEY RRset, the TTL will default to the
            SOA TTL. Setting the default TTL to <literal>0</literal>
            or <literal>none</literal> is the same as leaving it unset.
316 317 318 319
          </para>
        </listitem>
      </varlistentry>

320 321
      <varlistentry>
        <term>-p <replaceable class="parameter">protocol</replaceable></term>
322 323 324 325 326 327 328 329
        <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>
330 331
      </varlistentry>

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
      <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>

351 352
      <varlistentry>
        <term>-r <replaceable class="parameter">randomdev</replaceable></term>
353 354 355 356 357 358 359 360 361 362 363 364 365
        <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>
366 367
      </varlistentry>

368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
      <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>

383 384
      <varlistentry>
        <term>-s <replaceable class="parameter">strength</replaceable></term>
385 386 387 388 389 390 391
        <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>
392 393
      </varlistentry>

394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
      <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>

410 411
      <varlistentry>
        <term>-t <replaceable class="parameter">type</replaceable></term>
412 413 414 415 416 417 418 419
        <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>
420 421 422 423
      </varlistentry>

      <varlistentry>
        <term>-v <replaceable class="parameter">level</replaceable></term>
424 425 426 427 428
        <listitem>
          <para>
            Sets the debugging level.
          </para>
        </listitem>
429 430
      </varlistentry>

431 432 433 434 435 436 437 438 439
      <varlistentry>
	<term>-V</term>
        <listitem>
	  <para>
	    Prints version information.
	  </para>
        </listitem>
      </varlistentry>

440
    </variablelist>
Evan Hunt's avatar
Evan Hunt committed
441
  </refsection>
442

Evan Hunt's avatar
Evan Hunt committed
443 444
  <refsection><info><title>TIMING OPTIONS</title></info>
    
445 446 447 448

    <para>
      Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
      If the argument begins with a '+' or '-', it is interpreted as
449 450 451 452 453
      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
Evan Hunt's avatar
Evan Hunt committed
454 455
      is computed in seconds.  To explicitly prevent a date from being
      set, use 'none' or 'never'.
456 457 458 459 460 461 462 463 464
    </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
465 466
            not be used to sign it.  If not set, and if the -G option has
            not been used, the default is "now".
467 468 469 470 471 472 473 474 475
          </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
476
            date, the key will be included in the zone and used to sign
477
            it.  If not set, and if the -G option has not been used, the
Evan Hunt's avatar
Evan Hunt committed
478 479 480
            default is "now".  If set, if and -P is not set, then
            the publication date will be set to the activation date
            minus the prepublication interval.
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
          </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>
497
        <term>-I <replaceable class="parameter">date/offset</replaceable></term>
498 499
        <listitem>
          <para>
500 501 502
            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.
503 504 505 506 507 508 509 510 511
          </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
512 513
            date, the key will no longer be included in the zone.  (It
            may remain in the key repository, however.)
514 515 516
          </para>
        </listitem>
      </varlistentry>
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

      <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>

545
    </variablelist>
Evan Hunt's avatar
Evan Hunt committed
546
  </refsection>
547 548


Evan Hunt's avatar
Evan Hunt committed
549 550
  <refsection><info><title>GENERATED KEYS</title></info>
    
551
    <para>
552 553 554 555
      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
556
      the key it has generated.
557
    </para>
Brian Wellington's avatar
Brian Wellington committed
558 559
    <itemizedlist>
      <listitem>
560
        <para><filename>nnnn</filename> is the key name.
Brian Wellington's avatar
Brian Wellington committed
561 562 563
        </para>
      </listitem>
      <listitem>
564 565
        <para><filename>aaa</filename> is the numeric representation
          of the
Brian Wellington's avatar
Brian Wellington committed
566 567 568 569
          algorithm.
        </para>
      </listitem>
      <listitem>
570 571
        <para><filename>iiiii</filename> is the key identifier (or
          footprint).
Brian Wellington's avatar
Brian Wellington committed
572 573 574
        </para>
      </listitem>
    </itemizedlist>
575
    <para><command>dnssec-keygen</command> 
576
      creates two files, with names based
577 578 579 580 581
      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.
582 583
    </para>
    <para>
584 585 586 587
      The <filename>.key</filename> file contains a DNS KEY record
      that
      can be inserted into a zone file (directly or with a $INCLUDE
      statement).
588 589
    </para>
    <para>
590 591
      The <filename>.private</filename> file contains
      algorithm-specific
592 593
      fields.  For obvious security reasons, this file does not have
      general read permission.
594 595
    </para>
    <para>
596
      Both <filename>.key</filename> and <filename>.private</filename>
597
      files are generated for symmetric encryption algorithms such as
598
      HMAC-MD5, even though the public and private key are equivalent.
599
    </para>
Evan Hunt's avatar
Evan Hunt committed
600
  </refsection>
601

Evan Hunt's avatar
Evan Hunt committed
602 603
  <refsection><info><title>EXAMPLE</title></info>
    
604
    <para>
605 606 607
      To generate a 768-bit DSA key for the domain
      <userinput>example.com</userinput>, the following command would be
      issued:
608
    </para>
609
    <para><userinput>dnssec-keygen -a DSA -b 768 -n ZONE example.com</userinput>
610 611
    </para>
    <para>
612
      The command would print a string of the form:
613
    </para>
614
    <para><userinput>Kexample.com.+003+26160</userinput>
615 616
    </para>
    <para>
617 618 619
      In this example, <command>dnssec-keygen</command> creates
      the files <filename>Kexample.com.+003+26160.key</filename>
      and
620
      <filename>Kexample.com.+003+26160.private</filename>.
621
    </para>
Evan Hunt's avatar
Evan Hunt committed
622
  </refsection>
623

Evan Hunt's avatar
Evan Hunt committed
624 625
  <refsection><info><title>SEE ALSO</title></info>
    
626 627
    <para><citerefentry>
        <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
628 629
      </citerefentry>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
630
      <citetitle>RFC 2539</citetitle>,
631
      <citetitle>RFC 2845</citetitle>,
632
      <citetitle>RFC 4034</citetitle>.
633
    </para>
Evan Hunt's avatar
Evan Hunt committed
634
  </refsection>
635

Evan Hunt's avatar
Evan Hunt committed
636
</refentry>