external/bsd/bind/dist/bin/dnssec/dnssec-keygen.html

   1 <!--
   2  - Copyright (C) 2004, 2005, 2007-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2003 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and/or distribute this software for any
   6  - purpose with or without fee is hereby granted, provided that the above
   7  - copyright notice and this permission notice appear in all copies.
   8  -
   9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17 <!-- Id -->
  18 <html>
  19 <head>
  20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21 <title>dnssec-keygen</title>
  22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  23 </head>
  24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
  25 <a name="man.dnssec-keygen"></a><div class="titlepage"></div>
  26 <div class="refnamediv">
  27 <h2>Name</h2>
  28 <p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
  29 </div>
  30 <div class="refsynopsisdiv">
  31 <h2>Synopsis</h2>
  32 <div class="cmdsynopsis"><p><code class="command">dnssec-keygen</code>  [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-3</code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-C</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>] [<code class="option">-h</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-k</code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-q</code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-S <em class="replaceable"><code>key</code></em></code>] [<code class="option">-s <em class="replaceable"><code>strength</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-V</code>] [<code class="option">-z</code>] {name}</p></div>
  33 </div>
  34 <div class="refsect1" lang="en">
  35 <a name="id2543608"></a><h2>DESCRIPTION</h2>
  36 <p><span><strong class="command">dnssec-keygen</strong></span>
  37       generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
  38       and RFC 4034.  It can also generate keys for use with
  39       TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
  40       (Transaction Key) as defined in RFC 2930.
  41     </p>
  42 <p>
  43       The <code class="option">name</code> of the key is specified on the command
  44       line.  For DNSSEC keys, this must match the name of the zone for
  45       which the key is being generated.
  46     </p>
  47 </div>
  48 <div class="refsect1" lang="en">
  49 <a name="id2543626"></a><h2>OPTIONS</h2>
  50 <div class="variablelist"><dl>
  51 <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
  52 <dd>
  53 <p>
  54             Selects the cryptographic algorithm.  For DNSSEC keys, the value
  55             of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
  56             DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
  57             ECDSAP256SHA256 or ECDSAP384SHA384.
  58             For TSIG/TKEY, the value must
  59             be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
  60             HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512.  These values are
  61             case insensitive.
  62           </p>
  63 <p>
  64             If no algorithm is specified, then RSASHA1 will be used by
  65             default, unless the <code class="option">-3</code> option is specified,
  66             in which case NSEC3RSASHA1 will be used instead.  (If
  67             <code class="option">-3</code> is used and an algorithm is specified,
  68             that algorithm will be checked for compatibility with NSEC3.)
  69           </p>
  70 <p>
  71             Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
  72             algorithm, and DSA is recommended.  For TSIG, HMAC-MD5 is
  73             mandatory.
  74           </p>
  75 <p>
  76             Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
  77             automatically set the -T KEY option.
  78           </p>
  79 </dd>
  80 <dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
  81 <dd>
  82 <p>
  83             Specifies the number of bits in the key.  The choice of key
  84             size depends on the algorithm used.  RSA keys must be
  85             between 512 and 2048 bits.  Diffie Hellman keys must be between
  86             128 and 4096 bits.  DSA keys must be between 512 and 1024
  87             bits and an exact multiple of 64.  HMAC keys must be
  88             between 1 and 512 bits. Elliptic curve algorithms don't need
  89             this parameter.
  90           </p>
  91 <p>
  92             The key size does not need to be specified if using a default
  93             algorithm.  The default key size is 1024 bits for zone signing
  94             keys (ZSK's) and 2048 bits for key signing keys (KSK's,
  95             generated with <code class="option">-f KSK</code>).  However, if an
  96             algorithm is explicitly specified with the <code class="option">-a</code>,
  97             then there is no default key size, and the <code class="option">-b</code>
  98             must be used.
  99           </p>
 100 </dd>
 101 <dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
 102 <dd><p>
 103             Specifies the owner type of the key.  The value of
 104             <code class="option">nametype</code> must either be ZONE (for a DNSSEC
 105             zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
 106             a host (KEY)),
 107             USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
 108             These values are case insensitive.  Defaults to ZONE for DNSKEY
 109             generation.
 110           </p></dd>
 111 <dt><span class="term">-3</span></dt>
 112 <dd><p>
 113             Use an NSEC3-capable algorithm to generate a DNSSEC key.
 114             If this option is used and no algorithm is explicitly
 115             set on the command line, NSEC3RSASHA1 will be used by
 116             default. Note that RSASHA256, RSASHA512, ECCGOST,
 117             ECDSAP256SHA256 and ECDSAP384SHA384 algorithms
 118             are NSEC3-capable.
 119           </p></dd>
 120 <dt><span class="term">-C</span></dt>
 121 <dd><p>
 122             Compatibility mode:  generates an old-style key, without
 123             any metadata.  By default, <span><strong class="command">dnssec-keygen</strong></span>
 124             will include the key's creation date in the metadata stored
 125             with the private key, and other dates may be set there as well
 126             (publication date, activation date, etc).  Keys that include
 127             this data may be incompatible with older versions of BIND; the
 128             <code class="option">-C</code> option suppresses them.
 129           </p></dd>
 130 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
 131 <dd><p>
 132             Indicates that the DNS record containing the key should have
 133             the specified class.  If not specified, class IN is used.
 134           </p></dd>
 135 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
 136 <dd>
 137 <p>
 138             Specifies the cryptographic hardware to use, when applicable.
 139           </p>
 140 <p>
 141             When BIND is built with OpenSSL PKCS#11 support, this defaults
 142             to the string "pkcs11", which identifies an OpenSSL engine
 143             that can drive a cryptographic accelerator or hardware service
 144             module.  When BIND is built with native PKCS#11 cryptography
 145             (--enable-native-pkcs11), it defaults to the path of the PKCS#11
 146             provider library specified via "--with-pkcs11".
 147           </p>
 148 </dd>
 149 <dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
 150 <dd><p>
 151             Set the specified flag in the flag field of the KEY/DNSKEY record.
 152             The only recognized flags are KSK (Key Signing Key) and REVOKE.
 153           </p></dd>
 154 <dt><span class="term">-G</span></dt>
 155 <dd><p>
 156             Generate a key, but do not publish it or sign with it.  This
 157             option is incompatible with -P and -A.
 158           </p></dd>
 159 <dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
 160 <dd><p>
 161             If generating a Diffie Hellman key, use this generator.
 162             Allowed values are 2 and 5.  If no generator
 163             is specified, a known prime from RFC 2539 will be used
 164             if possible; otherwise the default is 2.
 165           </p></dd>
 166 <dt><span class="term">-h</span></dt>
 167 <dd><p>
 168             Prints a short summary of the options and arguments to
 169             <span><strong class="command">dnssec-keygen</strong></span>.
 170           </p></dd>
 171 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
 172 <dd><p>
 173             Sets the directory in which the key files are to be written.
 174           </p></dd>
 175 <dt><span class="term">-k</span></dt>
 176 <dd><p>
 177             Deprecated in favor of -T KEY.
 178           </p></dd>
 179 <dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
 180 <dd><p>
 181             Sets the default TTL to use for this key when it is converted
 182             into a DNSKEY RR.  If the key is imported into a zone,
 183             this is the TTL that will be used for it, unless there was
 184             already a DNSKEY RRset in place, in which case the existing TTL
 185             would take precedence.  If this value is not set and there
 186             is no existing DNSKEY RRset, the TTL will default to the
 187             SOA TTL. Setting the default TTL to <code class="literal">0</code>
 188             or <code class="literal">none</code> is the same as leaving it unset.
 189           </p></dd>
 190 <dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
 191 <dd><p>
 192             Sets the protocol value for the generated key.  The protocol
 193             is a number between 0 and 255.  The default is 3 (DNSSEC).
 194             Other possible values for this argument are listed in
 195             RFC 2535 and its successors.
 196           </p></dd>
 197 <dt><span class="term">-q</span></dt>
 198 <dd><p>
 199             Quiet mode: Suppresses unnecessary output, including
 200             progress indication.  Without this option, when
 201             <span><strong class="command">dnssec-keygen</strong></span> is run interactively
 202             to generate an RSA or DSA key pair, it will print a string
 203             of symbols to <code class="filename">stderr</code> indicating the
 204             progress of the key generation.  A '.' indicates that a
 205             random number has been found which passed an initial
 206             sieve test; '+' means a number has passed a single
 207             round of the Miller-Rabin primality test; a space
 208             means that the number has passed all the tests and is
 209             a satisfactory key.
 210           </p></dd>
 211 <dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
 212 <dd><p>
 213             Specifies the source of randomness.  If the operating
 214             system does not provide a <code class="filename">/dev/random</code>
 215             or equivalent device, the default source of randomness
 216             is keyboard input.  <code class="filename">randomdev</code>
 217             specifies
 218             the name of a character device or file containing random
 219             data to be used instead of the default.  The special value
 220             <code class="filename">keyboard</code> indicates that keyboard
 221             input should be used.
 222           </p></dd>
 223 <dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
 224 <dd><p>
 225             Create a new key which is an explicit successor to an
 226             existing key.  The name, algorithm, size, and type of the
 227             key will be set to match the existing key.  The activation
 228             date of the new key will be set to the inactivation date of
 229             the existing one.  The publication date will be set to the
 230             activation date minus the prepublication interval, which
 231             defaults to 30 days.
 232           </p></dd>
 233 <dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
 234 <dd><p>
 235             Specifies the strength value of the key.  The strength is
 236             a number between 0 and 15, and currently has no defined
 237             purpose in DNSSEC.
 238           </p></dd>
 239 <dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt>
 240 <dd>
 241 <p>
 242             Specifies the resource record type to use for the key.
 243             <code class="option">rrtype</code> must be either DNSKEY or KEY.  The
 244             default is DNSKEY when using a DNSSEC algorithm, but it can be
 245             overridden to KEY for use with SIG(0).
 246           </p>
 247 <p>
 248           </p>
 249 <p>
 250             Using any TSIG algorithm (HMAC-* or DH) forces this option
 251             to KEY.
 252           </p>
 253 </dd>
 254 <dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
 255 <dd><p>
 256             Indicates the use of the key.  <code class="option">type</code> must be
 257             one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF.  The default
 258             is AUTHCONF.  AUTH refers to the ability to authenticate
 259             data, and CONF the ability to encrypt data.
 260           </p></dd>
 261 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 262 <dd><p>
 263             Sets the debugging level.
 264           </p></dd>
 265 <dt><span class="term">-V</span></dt>
 266 <dd><p>
 267             Prints version information.
 268           </p></dd>
 269 </dl></div>
 270 </div>
 271 <div class="refsect1" lang="en">
 272 <a name="id2544292"></a><h2>TIMING OPTIONS</h2>
 273 <p>
 274       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 275       If the argument begins with a '+' or '-', it is interpreted as
 276       an offset from the present time.  For convenience, if such an offset
 277       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 278       then the offset is computed in years (defined as 365 24-hour days,
 279       ignoring leap years), months (defined as 30 24-hour days), weeks,
 280       days, hours, or minutes, respectively.  Without a suffix, the offset
 281       is computed in seconds.  To explicitly prevent a date from being
 282       set, use 'none' or 'never'.
 283     </p>
 284 <div class="variablelist"><dl>
 285 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 286 <dd><p>
 287             Sets the date on which a key is to be published to the zone.
 288             After that date, the key will be included in the zone but will
 289             not be used to sign it.  If not set, and if the -G option has
 290             not been used, the default is "now".
 291           </p></dd>
 292 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
 293 <dd><p>
 294             Sets the date on which the key is to be activated.  After that
 295             date, the key will be included in the zone and used to sign
 296             it.  If not set, and if the -G option has not been used, the
 297             default is "now".  If set, if and -P is not set, then
 298             the publication date will be set to the activation date
 299             minus the prepublication interval.
 300           </p></dd>
 301 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
 302 <dd><p>
 303             Sets the date on which the key is to be revoked.  After that
 304             date, the key will be flagged as revoked.  It will be included
 305             in the zone and will be used to sign it.
 306           </p></dd>
 307 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
 308 <dd><p>
 309             Sets the date on which the key is to be retired.  After that
 310             date, the key will still be included in the zone, but it
 311             will not be used to sign it.
 312           </p></dd>
 313 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 314 <dd><p>
 315             Sets the date on which the key is to be deleted.  After that
 316             date, the key will no longer be included in the zone.  (It
 317             may remain in the key repository, however.)
 318           </p></dd>
 319 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
 320 <dd>
 321 <p>
 322             Sets the prepublication interval for a key.  If set, then
 323             the publication and activation dates must be separated by at least
 324             this much time.  If the activation date is specified but the
 325             publication date isn't, then the publication date will default
 326             to this much time before the activation date; conversely, if
 327             the publication date is specified but activation date isn't,
 328             then activation will be set to this much time after publication.
 329           </p>
 330 <p>
 331             If the key is being created as an explicit successor to another
 332             key, then the default prepublication interval is 30 days;
 333             otherwise it is zero.
 334           </p>
 335 <p>
 336             As with date offsets, if the argument is followed by one of
 337             the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
 338             interval is measured in years, months, weeks, days, hours,
 339             or minutes, respectively.  Without a suffix, the interval is
 340             measured in seconds.
 341           </p>
 342 </dd>
 343 </dl></div>
 344 </div>
 345 <div class="refsect1" lang="en">
 346 <a name="id2544413"></a><h2>GENERATED KEYS</h2>
 347 <p>
 348       When <span><strong class="command">dnssec-keygen</strong></span> completes
 349       successfully,
 350       it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
 351       to the standard output.  This is an identification string for
 352       the key it has generated.
 353     </p>
 354 <div class="itemizedlist"><ul type="disc">
 355 <li><p><code class="filename">nnnn</code> is the key name.
 356         </p></li>
 357 <li><p><code class="filename">aaa</code> is the numeric representation
 358           of the
 359           algorithm.
 360         </p></li>
 361 <li><p><code class="filename">iiiii</code> is the key identifier (or
 362           footprint).
 363         </p></li>
 364 </ul></div>
 365 <p><span><strong class="command">dnssec-keygen</strong></span>
 366       creates two files, with names based
 367       on the printed string.  <code class="filename">Knnnn.+aaa+iiiii.key</code>
 368       contains the public key, and
 369       <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
 370       private
 371       key.
 372     </p>
 373 <p>
 374       The <code class="filename">.key</code> file contains a DNS KEY record
 375       that
 376       can be inserted into a zone file (directly or with a $INCLUDE
 377       statement).
 378     </p>
 379 <p>
 380       The <code class="filename">.private</code> file contains
 381       algorithm-specific
 382       fields.  For obvious security reasons, this file does not have
 383       general read permission.
 384     </p>
 385 <p>
 386       Both <code class="filename">.key</code> and <code class="filename">.private</code>
 387       files are generated for symmetric encryption algorithms such as
 388       HMAC-MD5, even though the public and private key are equivalent.
 389     </p>
 390 </div>
 391 <div class="refsect1" lang="en">
 392 <a name="id2544496"></a><h2>EXAMPLE</h2>
 393 <p>
 394       To generate a 768-bit DSA key for the domain
 395       <strong class="userinput"><code>example.com</code></strong>, the following command would be
 396       issued:
 397     </p>
 398 <p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
 399     </p>
 400 <p>
 401       The command would print a string of the form:
 402     </p>
 403 <p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
 404     </p>
 405 <p>
 406       In this example, <span><strong class="command">dnssec-keygen</strong></span> creates
 407       the files <code class="filename">Kexample.com.+003+26160.key</code>
 408       and
 409       <code class="filename">Kexample.com.+003+26160.private</code>.
 410     </p>
 411 </div>
 412 <div class="refsect1" lang="en">
 413 <a name="id2544608"></a><h2>SEE ALSO</h2>
 414 <p><span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 415       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 416       <em class="citetitle">RFC 2539</em>,
 417       <em class="citetitle">RFC 2845</em>,
 418       <em class="citetitle">RFC 4034</em>.
 419     </p>
 420 </div>
 421 <div class="refsect1" lang="en">
 422 <a name="id2544638"></a><h2>AUTHOR</h2>
 423 <p><span class="corpauthor">Internet Systems Consortium</span>
 424     </p>
 425 </div>
 426 </div></body>
 427 </html>