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