dnssec-keygen.docbook 20.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.32 2009/10/28 00:27:10 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>-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>-q</option></arg>
79
      <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
80
81
82
83
      <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>
84
      <arg><option>-z</option></arg>
85
86
87
88
89
90
      <arg choice="req">name</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

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

  <refsect1>
    <title>OPTIONS</title>

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

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

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

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

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

Francis Dupont's avatar
Francis Dupont committed
215
216
217
218
219
220
221
222
223
224
225
226
      <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>

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

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

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

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

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

278
279
280
281
282
283
284
285
286
      <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>

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

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

308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
      <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>

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

      <varlistentry>
        <term>-s <replaceable class="parameter">strength</replaceable></term>
346
347
348
349
350
351
352
        <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>
353
354
      </varlistentry>

355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
      <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>

371
372
      <varlistentry>
        <term>-t <replaceable class="parameter">type</replaceable></term>
373
374
375
376
377
378
379
380
        <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>
381
382
383
384
      </varlistentry>

      <varlistentry>
        <term>-v <replaceable class="parameter">level</replaceable></term>
385
386
387
388
389
        <listitem>
          <para>
            Sets the debugging level.
          </para>
        </listitem>
390
391
392
393
394
      </varlistentry>

    </variablelist>
  </refsect1>

395
396
397
398
399
400
  <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
401
402
403
404
405
406
      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.
407
408
409
410
411
412
413
414
415
    </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
416
417
            not be used to sign it.  If not set, and if the -G option has
            not been used, the default is "now".
418
419
420
421
422
423
424
425
426
          </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
427
            date, the key will be included in the zone and used to sign
428
429
            it.  If not set, and if the -G option has not been used, the
            default is "now".
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
          </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>
446
        <term>-I <replaceable class="parameter">date/offset</replaceable></term>
447
448
        <listitem>
          <para>
449
450
451
            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.
452
453
454
455
456
457
458
459
460
          </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
461
462
            date, the key will no longer be included in the zone.  (It
            may remain in the key repository, however.)
463
464
465
466
467
468
469
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>


470
471
472
  <refsect1>
    <title>GENERATED KEYS</title>
    <para>
473
474
475
476
      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
477
      the key it has generated.
478
    </para>
Brian Wellington's avatar
Brian Wellington committed
479
480
    <itemizedlist>
      <listitem>
481
        <para><filename>nnnn</filename> is the key name.
Brian Wellington's avatar
Brian Wellington committed
482
483
484
        </para>
      </listitem>
      <listitem>
485
486
        <para><filename>aaa</filename> is the numeric representation
          of the
Brian Wellington's avatar
Brian Wellington committed
487
488
489
490
          algorithm.
        </para>
      </listitem>
      <listitem>
491
492
        <para><filename>iiiii</filename> is the key identifier (or
          footprint).
Brian Wellington's avatar
Brian Wellington committed
493
494
495
        </para>
      </listitem>
    </itemizedlist>
496
    <para><command>dnssec-keygen</command> 
497
      creates two files, with names based
498
499
500
501
502
      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.
503
504
    </para>
    <para>
505
506
507
508
      The <filename>.key</filename> file contains a DNS KEY record
      that
      can be inserted into a zone file (directly or with a $INCLUDE
      statement).
509
510
    </para>
    <para>
511
512
      The <filename>.private</filename> file contains
      algorithm-specific
513
514
      fields.  For obvious security reasons, this file does not have
      general read permission.
515
516
    </para>
    <para>
517
      Both <filename>.key</filename> and <filename>.private</filename>
518
      files are generated for symmetric encryption algorithms such as
519
      HMAC-MD5, even though the public and private key are equivalent.
520
521
522
523
524
525
    </para>
  </refsect1>

  <refsect1>
    <title>EXAMPLE</title>
    <para>
526
527
528
      To generate a 768-bit DSA key for the domain
      <userinput>example.com</userinput>, the following command would be
      issued:
529
    </para>
530
    <para><userinput>dnssec-keygen -a DSA -b 768 -n ZONE example.com</userinput>
531
532
    </para>
    <para>
533
      The command would print a string of the form:
534
    </para>
535
    <para><userinput>Kexample.com.+003+26160</userinput>
536
537
    </para>
    <para>
538
539
540
      In this example, <command>dnssec-keygen</command> creates
      the files <filename>Kexample.com.+003+26160.key</filename>
      and
541
      <filename>Kexample.com.+003+26160.private</filename>.
542
543
544
545
546
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
547
548
    <para><citerefentry>
        <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
549
550
      </citerefentry>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
551
      <citetitle>RFC 2539</citetitle>,
552
      <citetitle>RFC 2845</citetitle>,
553
      <citetitle>RFC 4034</citetitle>.
554
555
556
557
558
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
559
    <para><corpauthor>Internet Systems Consortium</corpauthor>
560
561
562
    </para>
  </refsect1>

563
</refentry><!--
564
565
566
567
 - Local variables:
 - mode: sgml
 - End:
-->