man.dnssec-keygen.html revision 29651c3a80835482fa1612c24653c9b0c0e2e205
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC")
71cef386fae61275b03e203825680b39fedaa8c6Tinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt - Permission to use, copy, modify, and/or distribute this software for any
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt - purpose with or without fee is hereby granted, provided that the above
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt - copyright notice and this permission notice appear in all copies.
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt - PERFORMANCE OF THIS SOFTWARE.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<!-- $Id$ -->
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<link rel="prev" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel">
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<link rel="next" href="man.dnssec-revoke.html" title="dnssec-revoke">
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<tr><th colspan="3" align="center"><span class="application">dnssec-keygen</span></th></tr>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a>�</td>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<th width="60%" align="center">Manual pages</th>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-revoke.html">Next</a>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<p><span class="application">dnssec-keygen</span> — DNSSEC key generation tool</p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<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">-e</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">-z</code>] {name}</p></div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p><span><strong class="command">dnssec-keygen</strong></span>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User and RFC 4034. It can also generate keys for use with
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User (Transaction Key) as defined in RFC 2930.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt The <code class="option">name</code> of the key is specified on the command
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User line. For DNSSEC keys, this must match the name of the zone for
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User which the key is being generated.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Selects the cryptographic algorithm. For DNSSEC keys, the value
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt ECDSAP256SHA256 or ECDSAP384SHA384.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt case insensitive.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User If no algorithm is specified, then RSASHA1 will be used by
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt default, unless the <code class="option">-3</code> option is specified,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User in which case NSEC3RSASHA1 will be used instead. (If
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <code class="option">-3</code> is used and an algorithm is specified,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User that algorithm will be checked for compatibility with NSEC3.)
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User automatically set the -T KEY option.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Specifies the number of bits in the key. The choice of key
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User size depends on the algorithm used. RSA keys must be
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt between 512 and 2048 bits. Diffie Hellman keys must be between
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt 128 and 4096 bits. DSA keys must be between 512 and 1024
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt bits and an exact multiple of 64. HMAC keys must be
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt between 1 and 512 bits. Elliptic curve algorithms don't need
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt this parameter.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt The key size does not need to be specified if using a default
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt algorithm. The default key size is 1024 bits for zone signing
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt keys (ZSK's) and 2048 bits for key signing keys (KSK's,
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt generated with <code class="option">-f KSK</code>). However, if an
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt algorithm is explicitly specified with the <code class="option">-a</code>,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User then there is no default key size, and the <code class="option">-b</code>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt must be used.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Specifies the owner type of the key. The value of
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <code class="option">nametype</code> must either be ZONE (for a DNSSEC
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt a host (KEY)),
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User These values are case insensitive. Defaults to ZONE for DNSKEY
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Use an NSEC3-capable algorithm to generate a DNSSEC key.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt If this option is used and no algorithm is explicitly
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt set on the command line, NSEC3RSASHA1 will be used by
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt default. Note that RSASHA256, RSASHA512, ECCGOST,
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt ECDSAP256SHA256 and ECDSAP384SHA384 algorithms
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User are NSEC3-capable.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Compatibility mode: generates an old-style key, without
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User any metadata. By default, <span><strong class="command">dnssec-keygen</strong></span>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt will include the key's creation date in the metadata stored
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User with the private key, and other dates may be set there as well
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User (publication date, activation date, etc). Keys that include
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User this data may be incompatible with older versions of BIND; the
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt <code class="option">-C</code> option suppresses them.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Indicates that the DNS record containing the key should have
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt the specified class. If not specified, class IN is used.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Uses a crypto hardware (OpenSSL engine) for random number
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt and, when supported, key generation. When compiled with PKCS#11
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User support it defaults to pkcs11; the empty name resets it to
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt If generating an RSAMD5/RSASHA1 key, use a large exponent.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Set the specified flag in the flag field of the KEY/DNSKEY record.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User The only recognized flags are KSK (Key Signing Key) and REVOKE.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Generate a key, but do not publish it or sign with it. This
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User option is incompatible with -P and -A.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User If generating a Diffie Hellman key, use this generator.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Allowed values are 2 and 5. If no generator
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User is specified, a known prime from RFC 2539 will be used
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User if possible; otherwise the default is 2.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Prints a short summary of the options and arguments to
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span><strong class="command">dnssec-keygen</strong></span>.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Sets the directory in which the key files are to be written.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Deprecated in favor of -T KEY.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Sets the default TTL to use for this key when it is converted
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User into a DNSKEY RR. If the key is imported into a zone,
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt this is the TTL that will be used for it, unless there was
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt already a DNSKEY RRset in place, in which case the existing TTL
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt would take precedence. Setting the default TTL to
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <code class="literal">0</code> or <code class="literal">none</code> removes it.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Sets the protocol value for the generated key. The protocol
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt is a number between 0 and 255. The default is 3 (DNSSEC).
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Other possible values for this argument are listed in
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User RFC 2535 and its successors.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Quiet mode: Suppresses unnecessary output, including
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User progress indication. Without this option, when
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span><strong class="command">dnssec-keygen</strong></span> is run interactively
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt to generate an RSA or DSA key pair, it will print a string
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt of symbols to <code class="filename">stderr</code> indicating the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User progress of the key generation. A '.' indicates that a
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt random number has been found which passed an initial
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt sieve test; '+' means a number has passed a single
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt round of the Miller-Rabin primality test; a space
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt means that the number has passed all the tests and is
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User a satisfactory key.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Specifies the source of randomness. If the operating
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt system does not provide a <code class="filename">/dev/random</code>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User or equivalent device, the default source of randomness
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User is keyboard input. <code class="filename">randomdev</code>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User the name of a character device or file containing random
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User data to be used instead of the default. The special value
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt <code class="filename">keyboard</code> indicates that keyboard
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User input should be used.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Create a new key which is an explicit successor to an
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt existing key. The name, algorithm, size, and type of the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User key will be set to match the existing key. The activation
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User date of the new key will be set to the inactivation date of
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt the existing one. The publication date will be set to the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User activation date minus the prepublication interval, which
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User defaults to 30 days.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Specifies the strength value of the key. The strength is
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt a number between 0 and 15, and currently has no defined
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User purpose in DNSSEC.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Specifies the resource record type to use for the key.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <code class="option">rrtype</code> must be either DNSKEY or KEY. The
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt default is DNSKEY when using a DNSSEC algorithm, but it can be
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt overridden to KEY for use with SIG(0).
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Using any TSIG algorithm (HMAC-* or DH) forces this option
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Indicates the use of the key. <code class="option">type</code> must be
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt is AUTHCONF. AUTH refers to the ability to authenticate
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt data, and CONF the ability to encrypt data.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Sets the debugging level.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt If the argument begins with a '+' or '-', it is interpreted as
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt an offset from the present time. For convenience, if such an offset
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt then the offset is computed in years (defined as 365 24-hour days,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User ignoring leap years), months (defined as 30 24-hour days), weeks,
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt days, hours, or minutes, respectively. Without a suffix, the offset
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt is computed in seconds.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Sets the date on which a key is to be published to the zone.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt After that date, the key will be included in the zone but will
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User not be used to sign it. If not set, and if the -G option has
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt not been used, the default is "now".
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Sets the date on which the key is to be activated. After that
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User date, the key will be included in the zone and used to sign
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User it. If not set, and if the -G option has not been used, the
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt default is "now".
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Sets the date on which the key is to be revoked. After that
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User date, the key will be flagged as revoked. It will be included
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt in the zone and will be used to sign it.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Sets the date on which the key is to be retired. After that
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User date, the key will still be included in the zone, but it
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt will not be used to sign it.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Sets the date on which the key is to be deleted. After that
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt date, the key will no longer be included in the zone. (It
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt may remain in the key repository, however.)
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt Sets the prepublication interval for a key. If set, then
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt the publication and activation dates must be separated by at least
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt this much time. If the activation date is specified but the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User publication date isn't, then the publication date will default
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User to this much time before the activation date; conversely, if
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt the publication date is specified but activation date isn't,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User then activation will be set to this much time after publication.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User If the key is being created as an explicit successor to another
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User key, then the default prepublication interval is 30 days;
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt otherwise it is zero.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt As with date offsets, if the argument is followed by one of
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User interval is measured in years, months, weeks, days, hours,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User or minutes, respectively. Without a suffix, the interval is
c32570b3191fdfb38a65567b8bb729fdb42ff847Tinderbox User measured in seconds.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a name="id2669859"></a><h2>GENERATED KEYS</h2>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt When <span><strong class="command">dnssec-keygen</strong></span> completes
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User successfully,
c32570b3191fdfb38a65567b8bb729fdb42ff847Tinderbox User it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt to the standard output. This is an identification string for
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User the key it has generated.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<li><p><code class="filename">nnnn</code> is the key name.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<li><p><code class="filename">aaa</code> is the numeric representation
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<li><p><code class="filename">iiiii</code> is the key identifier (or
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<p><span><strong class="command">dnssec-keygen</strong></span>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User creates two files, with names based
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User contains the public key, and
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User The <code class="filename">.key</code> file contains a DNS KEY record
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User can be inserted into a zone file (directly or with a $INCLUDE
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt The <code class="filename">.private</code> file contains
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User algorithm-specific
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User fields. For obvious security reasons, this file does not have
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User general read permission.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Both <code class="filename">.key</code> and <code class="filename">.private</code>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User files are generated for symmetric encryption algorithms such as
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User HMAC-MD5, even though the public and private key are equivalent.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User To generate a 768-bit DSA key for the domain
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt <strong class="userinput"><code>example.com</code></strong>, the following command would be
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt The command would print a string of the form:
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt In this example, <span><strong class="command">dnssec-keygen</strong></span> creates
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt the files <code class="filename">Kexample.com.+003+26160.key</code>
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt <code class="filename">Kexample.com.+003+26160.private</code>.
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt<p><span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
28a4d32b05736e13299fb10c6c0addfa88c3cf87Evan Hunt <em class="citetitle">BIND 9 Administrator Reference Manual</em>,