dnssec-keygen.docbook 23.7 KB
Newer Older
Brian Wellington's avatar
Brian Wellington committed
1
<!--
2
 - Copyright (C) 2000-2005, 2007-2012, 2014-2017  Internet Systems Consortium, Inc. ("ISC")
Brian Wellington's avatar
Brian Wellington committed
3
 -
4
5
6
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
Brian Wellington's avatar
Brian Wellington committed
7
-->
Tinderbox User's avatar
Tinderbox User committed
8

Evan Hunt's avatar
Evan Hunt committed
9
<!-- Converted by db4-upgrade version 1.0 -->
10
<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-keygen">
Evan Hunt's avatar
Evan Hunt committed
11
12
13
  <info>
    <date>2014-02-06</date>
  </info>
14
  <refentryinfo>
15
    <date>August 21, 2015</date>
Evan Hunt's avatar
Evan Hunt committed
16
17
    <corpname>ISC</corpname>
    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
18
19
20
21
22
23
24
25
26
27
28
29
30
  </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>

31
32
  <docinfo>
    <copyright>
Mark Andrews's avatar
Mark Andrews committed
33
34
35
36
      <year>2000</year>
      <year>2001</year>
      <year>2002</year>
      <year>2003</year>
37
38
      <year>2004</year>
      <year>2005</year>
Mark Andrews's avatar
Mark Andrews committed
39
      <year>2007</year>
Automatic Updater's avatar
Automatic Updater committed
40
      <year>2008</year>
Automatic Updater's avatar
Automatic Updater committed
41
      <year>2009</year>
Automatic Updater's avatar
Automatic Updater committed
42
      <year>2010</year>
Automatic Updater's avatar
Automatic Updater committed
43
      <year>2011</year>
Tinderbox User's avatar
Tinderbox User committed
44
      <year>2012</year>
Tinderbox User's avatar
Tinderbox User committed
45
      <year>2014</year>
46
      <year>2015</year>
47
      <year>2016</year>
48
      <year>2017</year>
49
50
51
52
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

53
  <refsynopsisdiv>
Evan Hunt's avatar
Evan Hunt committed
54
    <cmdsynopsis sepchar=" ">
55
      <command>dnssec-keygen</command>
56
      <arg rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
Evan Hunt's avatar
Evan Hunt committed
57
58
59
60
61
62
63
      <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>
64
      <arg choice="opt" rep="norepeat"><option>-D sync <replaceable class="parameter">date/offset</replaceable></option></arg>
Evan Hunt's avatar
Evan Hunt committed
65
66
67
68
69
70
71
72
73
      <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>-k</option></arg>
74
      <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>
Evan Hunt's avatar
Evan Hunt committed
75
      <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
76
      <arg choice="opt" rep="norepeat"><option>-P sync <replaceable class="parameter">date/offset</replaceable></option></arg>
Evan Hunt's avatar
Evan Hunt committed
77
78
79
80
81
82
83
84
      <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</option></arg>
85
      <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg>
Evan Hunt's avatar
Evan Hunt committed
86
87
      <arg choice="opt" rep="norepeat"><option>-z</option></arg>
      <arg choice="req" rep="norepeat">name</arg>
88
89
90
    </cmdsynopsis>
  </refsynopsisdiv>

Evan Hunt's avatar
Evan Hunt committed
91
  <refsection><info><title>DESCRIPTION</title></info>
92

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
    <para>
      The <command>dnssec-keymgr</command> command acts as a wrapper
      around <command>dnssec-keygen</command>, generating and updating keys
      as needed to enforce defined security policies such as key rollover
      scheduling. Using <command>dnssec-keymgr</command> may be preferable
      to direct use of <command>dnssec-keygen</command>.
    </para>
Evan Hunt's avatar
Evan Hunt committed
111
  </refsection>
112

Evan Hunt's avatar
Evan Hunt committed
113
  <refsection><info><title>OPTIONS</title></info>
114

115
116
117

    <variablelist>
      <varlistentry>
118
119
120
121
122
	<term>-a <replaceable class="parameter">algorithm</replaceable></term>
	<listitem>
	  <para>
	    Selects the cryptographic algorithm.  For DNSSEC keys, the value
	    of <option>algorithm</option> must be one of RSAMD5, RSASHA1,
123
	    DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
124
	    ECDSAP256SHA256, ECDSAP384SHA384, ED25519 or ED448.  For
125
126
127
	    TKEY, the value must be DH (Diffie Hellman); specifying
	    his value will automatically set the <option>-T KEY</option>
	    option as well.
128
129
	  </para>
	  <para>
Evan Hunt's avatar
Evan Hunt committed
130
	    TSIG keys can also be generated by setting the value to
131
132
133
134
135
136
137
	    one of HMAC-MD5, HMAC-SHA1, HMAC-SHA224, HMAC-SHA256,
	    HMAC-SHA384, or HMAC-SHA512.  As with DH, specifying these
	    values will automatically set <option>-T KEY</option>. Note,
	    however, that <command>tsig-keygen</command> produces TSIG keys
	    in a more useful format. These algorithms have been deprecated
	    in <command>dnssec-keygen</command>, and will be removed in a
	    future release.
138
139
	  </para>
	  <para>
140
141
142
143
144
	    These values are case insensitive. In some cases, abbreviations
	    are supported, such as ECDSA256 for ECDSAP256SHA256 and
	    ECDSA384 for ECDSAP384SHA384. If RSASHA1 or DSA is specified
	    along with the <option>-3</option> option, then NSEC3RSASHA1
	    or NSEC3DSA will be used instead.
145
146
	  </para>
	  <para>
147
	    As of BIND 9.12.0, this option is mandatory except when using
148
149
	    the <option>-S</option> option, which copies the algorithm from
	    the predecessor key.  Previously, the default for newly
150
	    generated keys was RSASHA1.
151
152
	  </para>
	</listitem>
153
154
155
      </varlistentry>

      <varlistentry>
156
157
158
159
160
	<term>-b <replaceable class="parameter">keysize</replaceable></term>
	<listitem>
	  <para>
	    Specifies the number of bits in the key.  The choice of key
	    size depends on the algorithm used.  RSA keys must be
161
	    between 1024 and 2048 bits.  Diffie Hellman keys must be between
162
163
164
165
166
167
	    128 and 4096 bits.  DSA keys must be between 512 and 1024
	    bits and an exact multiple of 64.  HMAC keys must be
	    between 1 and 512 bits. Elliptic curve algorithms don't need
	    this parameter.
	  </para>
	  <para>
168
169
170
171
172
	    If the key size is not specified, some algorithms have
	    pre-defined defaults.  For example, RSA keys for use as
	    DNSSEC zone signing keys have a default size of 1024 bits;
	    RSA keys for use as key signing keys (KSKs, generated with
	    <option>-f KSK</option>) default to 2048 bits.
173
174
	  </para>
	</listitem>
175
176
177
      </varlistentry>

      <varlistentry>
178
179
180
181
182
	<term>-n <replaceable class="parameter">nametype</replaceable></term>
	<listitem>
	  <para>
	    Specifies the owner type of the key.  The value of
	    <option>nametype</option> must either be ZONE (for a DNSSEC
183
184
185
186
	    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).  These values are case
	    insensitive.  Defaults to ZONE for DNSKEY generation.
187
188
	  </para>
	</listitem>
189
190
      </varlistentry>

191
      <varlistentry>
192
193
194
	<term>-3</term>
	<listitem>
	  <para>
195
	    Use an NSEC3-capable algorithm to generate a DNSSEC key.
196
197
198
199
	    If this option is used with an algorithm that has both
	    NSEC and NSEC3 versions, then the NSEC3 version will be
	    used; for example, <command>dnssec-keygen -3a RSASHA1</command>
	    specifies the NSEC3RSASHA1 algorithm.
200
201
	  </para>
	</listitem>
202
203
204
      </varlistentry>

      <varlistentry>
205
206
207
	<term>-C</term>
	<listitem>
	  <para>
208
209
210
211
212
213
214
	    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.
215
216
	  </para>
	</listitem>
217
218
      </varlistentry>

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

Francis Dupont's avatar
Francis Dupont committed
229
      <varlistentry>
230
231
232
233
234
235
236
237
238
239
240
241
242
243
	<term>-E <replaceable class="parameter">engine</replaceable></term>
	<listitem>
	  <para>
	    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".
	  </para>
	</listitem>
Francis Dupont's avatar
Francis Dupont committed
244
245
      </varlistentry>

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

256
      <varlistentry>
257
258
259
260
261
262
263
	<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>
264
265
      </varlistentry>

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

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

288
      <varlistentry>
289
290
291
292
293
294
	<term>-K <replaceable class="parameter">directory</replaceable></term>
	<listitem>
	  <para>
	    Sets the directory in which the key files are to be written.
	  </para>
	</listitem>
295
296
      </varlistentry>

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

306
      <varlistentry>
307
308
309
310
311
312
313
314
315
316
317
318
319
	<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
	    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.
	  </para>
	</listitem>
320
321
      </varlistentry>

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

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

353
      <varlistentry>
354
355
356
	<term>-r <replaceable class="parameter">randomdev</replaceable></term>
	<listitem>
	  <para>
357
358
359
360
361
362
363
364
365
	    Specifies a source of randomness.  Normally, when generating
	    DNSSEC keys, this option has no effect; the random number
	    generation function provided by the cryptographic library will
	    be used.
	  </para>
	  <para>
	    If that behavior is disabled at compile time, however,
	    the specified file will be used as entropy source
	    for key generation.  <filename>randomdev</filename> is
366
	    the name of a character device or file containing random
367
368
369
370
371
372
373
	    data to be used.  The special value <filename>keyboard</filename>
	    indicates that keyboard input should be used.
	  </para>
	  <para>
	    The default is <filename>/dev/random</filename> if the
	    operating system provides it or an equivalent device;
	    if not, the default source of randomness is keyboard input.
374
375
	  </para>
	</listitem>
376
377
      </varlistentry>

378
      <varlistentry>
379
380
381
382
383
384
385
386
387
388
389
390
	<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>
391
392
      </varlistentry>

393
      <varlistentry>
394
395
396
397
398
399
400
401
	<term>-s <replaceable class="parameter">strength</replaceable></term>
	<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>
402
403
      </varlistentry>

404
      <varlistentry>
405
406
407
408
409
410
411
412
413
	<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>
414
415
	    Specifying any TSIG algorithm (HMAC-* or DH) with
	    <option>-a</option> forces this option to KEY.
416
417
	  </para>
	</listitem>
418
419
      </varlistentry>

420
      <varlistentry>
421
422
423
424
425
426
427
428
429
	<term>-t <replaceable class="parameter">type</replaceable></term>
	<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>
430
431
432
      </varlistentry>

      <varlistentry>
433
434
435
436
437
438
	<term>-v <replaceable class="parameter">level</replaceable></term>
	<listitem>
	  <para>
	    Sets the debugging level.
	  </para>
	</listitem>
439
440
      </varlistentry>

441
442
      <varlistentry>
	<term>-V</term>
443
	<listitem>
444
445
446
	  <para>
	    Prints version information.
	  </para>
447
	</listitem>
448
449
      </varlistentry>

450
    </variablelist>
Evan Hunt's avatar
Evan Hunt committed
451
  </refsection>
452

Evan Hunt's avatar
Evan Hunt committed
453
  <refsection><info><title>TIMING OPTIONS</title></info>
454

455
456
457
458

    <para>
      Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
      If the argument begins with a '+' or '-', it is interpreted as
459
460
461
462
463
      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
464
465
      is computed in seconds.  To explicitly prevent a date from being
      set, use 'none' or 'never'.
466
467
468
469
    </para>

    <variablelist>
      <varlistentry>
470
471
472
473
474
475
476
477
478
	<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
	    not be used to sign it.  If not set, and if the -G option has
	    not been used, the default is "now".
	  </para>
	</listitem>
479
480
481
      </varlistentry>

      <varlistentry>
482
483
484
485
486
487
488
	<term>-P sync <replaceable class="parameter">date/offset</replaceable></term>
	<listitem>
	  <para>
	    Sets the date on which CDS and CDNSKEY records that match this
	    key are to be published to the zone.
	  </para>
	</listitem>
489
490
491
      </varlistentry>

      <varlistentry>
492
493
494
495
496
497
498
499
500
501
502
	<term>-A <replaceable class="parameter">date/offset</replaceable></term>
	<listitem>
	  <para>
	    Sets the date on which the key is to be activated.  After that
	    date, the key will be included in the zone and used to sign
	    it.  If not set, and if the -G option has not been used, the
	    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.
	  </para>
	</listitem>
503
504
505
      </varlistentry>

      <varlistentry>
506
507
508
509
510
511
512
513
	<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>
514
515
516
      </varlistentry>

      <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
545
	<term>-I <replaceable class="parameter">date/offset</replaceable></term>
	<listitem>
	  <para>
	    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.
	  </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
	    date, the key will no longer be included in the zone.  (It
	    may remain in the key repository, however.)
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>-D sync <replaceable class="parameter">date/offset</replaceable></term>
	<listitem>
	  <para>
	    Sets the date on which the CDS and CDNSKEY records that match this
	    key are to be deleted.
	  </para>
	</listitem>
546
      </varlistentry>
547
548

      <varlistentry>
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
	<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>
573
574
      </varlistentry>

575
    </variablelist>
Evan Hunt's avatar
Evan Hunt committed
576
  </refsection>
577
578


Evan Hunt's avatar
Evan Hunt committed
579
  <refsection><info><title>GENERATED KEYS</title></info>
580

581
    <para>
582
583
584
585
      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
586
      the key it has generated.
587
    </para>
Brian Wellington's avatar
Brian Wellington committed
588
589
    <itemizedlist>
      <listitem>
590
591
	<para><filename>nnnn</filename> is the key name.
	</para>
Brian Wellington's avatar
Brian Wellington committed
592
593
      </listitem>
      <listitem>
594
595
596
597
	<para><filename>aaa</filename> is the numeric representation
	  of the
	  algorithm.
	</para>
Brian Wellington's avatar
Brian Wellington committed
598
599
      </listitem>
      <listitem>
600
601
602
	<para><filename>iiiii</filename> is the key identifier (or
	  footprint).
	</para>
Brian Wellington's avatar
Brian Wellington committed
603
604
      </listitem>
    </itemizedlist>
605
    <para><command>dnssec-keygen</command>
606
      creates two files, with names based
607
608
609
610
611
      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.
612
613
    </para>
    <para>
614
615
616
617
      The <filename>.key</filename> file contains a DNS KEY record
      that
      can be inserted into a zone file (directly or with a $INCLUDE
      statement).
618
619
    </para>
    <para>
620
621
      The <filename>.private</filename> file contains
      algorithm-specific
622
623
      fields.  For obvious security reasons, this file does not have
      general read permission.
624
625
    </para>
    <para>
626
      Both <filename>.key</filename> and <filename>.private</filename>
627
      files are generated for symmetric cryptography algorithms such as
628
      HMAC-MD5, even though the public and private key are equivalent.
629
    </para>
Evan Hunt's avatar
Evan Hunt committed
630
  </refsection>
631

Evan Hunt's avatar
Evan Hunt committed
632
  <refsection><info><title>EXAMPLE</title></info>
633

634
    <para>
635
636
637
      To generate a 768-bit DSA key for the domain
      <userinput>example.com</userinput>, the following command would be
      issued:
638
    </para>
639
    <para><userinput>dnssec-keygen -a DSA -b 768 -n ZONE example.com</userinput>
640
641
    </para>
    <para>
642
      The command would print a string of the form:
643
    </para>
644
    <para><userinput>Kexample.com.+003+26160</userinput>
645
646
    </para>
    <para>
647
648
649
      In this example, <command>dnssec-keygen</command> creates
      the files <filename>Kexample.com.+003+26160.key</filename>
      and
650
      <filename>Kexample.com.+003+26160.private</filename>.
651
    </para>
Evan Hunt's avatar
Evan Hunt committed
652
  </refsection>
653

Evan Hunt's avatar
Evan Hunt committed
654
  <refsection><info><title>SEE ALSO</title></info>
655

656
    <para><citerefentry>
657
	<refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
658
659
      </citerefentry>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
660
      <citetitle>RFC 2539</citetitle>,
661
      <citetitle>RFC 2845</citetitle>,
662
      <citetitle>RFC 4034</citetitle>.
663
    </para>
Evan Hunt's avatar
Evan Hunt committed
664
  </refsection>
665

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