5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - Copyright (C) 2000-2005, 2007-2012, 2014-2017 Internet Systems Consortium, Inc. ("ISC")
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - This Source Code Form is subject to the terms of the Mozilla Public
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - License, v. 2.0. If a copy of the MPL was not distributed with this
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland - file, You can obtain one at http://mozilla.org/MPL/2.0/.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <span class="application">dnssec-keygen</span>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland — DNSSEC key generation tool
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-D sync <em class="replaceable"><code>date/offset</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-P sync <em class="replaceable"><code>date/offset</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-S <em class="replaceable"><code>key</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-s <em class="replaceable"><code>strength</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-t <em class="replaceable"><code>type</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <p><span class="command"><strong>dnssec-keygen</strong></span>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland and RFC 4034. It can also generate keys for use with
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland (Transaction Key) as defined in RFC 2930.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland The <code class="option">name</code> of the key is specified on the command
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland line. For DNSSEC keys, this must match the name of the zone for
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland which the key is being generated.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <div class="variablelist"><dl class="variablelist">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Selects the cryptographic algorithm. For DNSSEC keys, the value
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland ECDSAP256SHA256, ECDSAP384SHA384, ED25519 or ED448.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland case insensitive.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland If no algorithm is specified, then RSASHA1 will be used by
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland default, unless the <code class="option">-3</code> option is specified,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland in which case NSEC3RSASHA1 will be used instead. (If
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="option">-3</code> is used and an algorithm is specified,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland that algorithm will be checked for compatibility with NSEC3.)
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland automatically set the -T KEY option.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Specifies the number of bits in the key. The choice of key
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland size depends on the algorithm used. RSA keys must be
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland between 512 and 2048 bits. Diffie Hellman keys must be between
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland 128 and 4096 bits. DSA keys must be between 512 and 1024
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland bits and an exact multiple of 64. HMAC keys must be
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland between 1 and 512 bits. Elliptic curve algorithms don't need
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland this parameter.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland The key size does not need to be specified if using a default
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland algorithm. The default key size is 1024 bits for zone signing
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland keys (ZSKs) and 2048 bits for key signing keys (KSKs,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland generated with <code class="option">-f KSK</code>). However, if an
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland algorithm is explicitly specified with the <code class="option">-a</code>,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland then there is no default key size, and the <code class="option">-b</code>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland must be used.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Specifies the owner type of the key. The value of
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="option">nametype</code> must either be ZONE (for a DNSSEC
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland a host (KEY)),
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland These values are case insensitive. Defaults to ZONE for DNSKEY
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Use an NSEC3-capable algorithm to generate a DNSSEC key.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland If this option is used and no algorithm is explicitly
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland set on the command line, NSEC3RSASHA1 will be used by
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland default. Note that RSASHA256, RSASHA512, ECCGOST,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland ECDSAP256SHA256, ECDSAP384SHA384, ED25519 and ED448
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland algorithms are NSEC3-capable.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Compatibility mode: generates an old-style key, without
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland any metadata. By default, <span class="command"><strong>dnssec-keygen</strong></span>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland will include the key's creation date in the metadata stored
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland with the private key, and other dates may be set there as well
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland (publication date, activation date, etc). Keys that include
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland this data may be incompatible with older versions of BIND; the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="option">-C</code> option suppresses them.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Indicates that the DNS record containing the key should have
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland the specified class. If not specified, class IN is used.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Specifies the cryptographic hardware to use, when applicable.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland When BIND is built with OpenSSL PKCS#11 support, this defaults
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland to the string "pkcs11", which identifies an OpenSSL engine
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland that can drive a cryptographic accelerator or hardware service
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland module. When BIND is built with native PKCS#11 cryptography
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland (--enable-native-pkcs11), it defaults to the path of the PKCS#11
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland provider library specified via "--with-pkcs11".
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Set the specified flag in the flag field of the KEY/DNSKEY record.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland The only recognized flags are KSK (Key Signing Key) and REVOKE.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Generate a key, but do not publish it or sign with it. This
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland option is incompatible with -P and -A.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland If generating a Diffie Hellman key, use this generator.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Allowed values are 2 and 5. If no generator
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland is specified, a known prime from RFC 2539 will be used
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland if possible; otherwise the default is 2.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Prints a short summary of the options and arguments to
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <span class="command"><strong>dnssec-keygen</strong></span>.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the directory in which the key files are to be written.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Deprecated in favor of -T KEY.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the default TTL to use for this key when it is converted
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland into a DNSKEY RR. If the key is imported into a zone,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland this is the TTL that will be used for it, unless there was
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland already a DNSKEY RRset in place, in which case the existing TTL
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland would take precedence. If this value is not set and there
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland is no existing DNSKEY RRset, the TTL will default to the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland SOA TTL. Setting the default TTL to <code class="literal">0</code>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland or <code class="literal">none</code> is the same as leaving it unset.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the protocol value for the generated key. The protocol
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland is a number between 0 and 255. The default is 3 (DNSSEC).
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Other possible values for this argument are listed in
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland RFC 2535 and its successors.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Quiet mode: Suppresses unnecessary output, including
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland progress indication. Without this option, when
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <span class="command"><strong>dnssec-keygen</strong></span> is run interactively
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland to generate an RSA or DSA key pair, it will print a string
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland of symbols to <code class="filename">stderr</code> indicating the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland progress of the key generation. A '.' indicates that a
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland random number has been found which passed an initial
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland sieve test; '+' means a number has passed a single
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland round of the Miller-Rabin primality test; a space
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland means that the number has passed all the tests and is
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland a satisfactory key.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Specifies the source of randomness. If the operating
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland system does not provide a <code class="filename">/dev/random</code>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland or equivalent device, the default source of randomness
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland is keyboard input. <code class="filename">randomdev</code>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland the name of a character device or file containing random
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland data to be used instead of the default. The special value
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="filename">keyboard</code> indicates that keyboard
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland input should be used.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Create a new key which is an explicit successor to an
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland existing key. The name, algorithm, size, and type of the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland key will be set to match the existing key. The activation
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland date of the new key will be set to the inactivation date of
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland the existing one. The publication date will be set to the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland activation date minus the prepublication interval, which
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland defaults to 30 days.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Specifies the strength value of the key. The strength is
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland a number between 0 and 15, and currently has no defined
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland purpose in DNSSEC.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Specifies the resource record type to use for the key.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="option">rrtype</code> must be either DNSKEY or KEY. The
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland default is DNSKEY when using a DNSSEC algorithm, but it can be
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland overridden to KEY for use with SIG(0).
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Using any TSIG algorithm (HMAC-* or DH) forces this option
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Indicates the use of the key. <code class="option">type</code> must be
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland is AUTHCONF. AUTH refers to the ability to authenticate
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland data, and CONF the ability to encrypt data.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the debugging level.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Prints version information.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<a name="id-1.9"></a><h2>TIMING OPTIONS</h2>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland If the argument begins with a '+' or '-', it is interpreted as
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland an offset from the present time. For convenience, if such an offset
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland then the offset is computed in years (defined as 365 24-hour days,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland ignoring leap years), months (defined as 30 24-hour days), weeks,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland days, hours, or minutes, respectively. Without a suffix, the offset
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland is computed in seconds. To explicitly prevent a date from being
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland set, use 'none' or 'never'.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <div class="variablelist"><dl class="variablelist">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the date on which a key is to be published to the zone.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland After that date, the key will be included in the zone but will
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland not be used to sign it. If not set, and if the -G option has
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland not been used, the default is "now".
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-P sync <em class="replaceable"><code>date/offset</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the date on which CDS and CDNSKEY records that match this
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland key are to be published to the zone.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the date on which the key is to be activated. After that
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland date, the key will be included in the zone and used to sign
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland it. If not set, and if the -G option has not been used, the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland default is "now". If set, if and -P is not set, then
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland the publication date will be set to the activation date
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland minus the prepublication interval.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the date on which the key is to be revoked. After that
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland date, the key will be flagged as revoked. It will be included
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland in the zone and will be used to sign it.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the date on which the key is to be retired. After that
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland date, the key will still be included in the zone, but it
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland will not be used to sign it.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the date on which the key is to be deleted. After that
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland date, the key will no longer be included in the zone. (It
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland may remain in the key repository, however.)
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-D sync <em class="replaceable"><code>date/offset</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the date on which the CDS and CDNSKEY records that match this
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland key are to be deleted.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Sets the prepublication interval for a key. If set, then
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland the publication and activation dates must be separated by at least
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland this much time. If the activation date is specified but the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland publication date isn't, then the publication date will default
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland to this much time before the activation date; conversely, if
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland the publication date is specified but activation date isn't,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland then activation will be set to this much time after publication.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland If the key is being created as an explicit successor to another
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland key, then the default prepublication interval is 30 days;
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland otherwise it is zero.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland As with date offsets, if the argument is followed by one of
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland interval is measured in years, months, weeks, days, hours,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland or minutes, respectively. Without a suffix, the interval is
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland measured in seconds.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland<a name="id-1.10"></a><h2>GENERATED KEYS</h2>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland When <span class="command"><strong>dnssec-keygen</strong></span> completes
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland successfully,
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland to the standard output. This is an identification string for
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland the key it has generated.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <p><code class="filename">nnnn</code> is the key name.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <p><code class="filename">aaa</code> is the numeric representation
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <p><code class="filename">iiiii</code> is the key identifier (or
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <p><span class="command"><strong>dnssec-keygen</strong></span>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland creates two files, with names based
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland contains the public key, and
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland The <code class="filename">.key</code> file contains a DNS KEY record
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland can be inserted into a zone file (directly or with a $INCLUDE
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland The <code class="filename">.private</code> file contains
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland algorithm-specific
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland fields. For obvious security reasons, this file does not have
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland general read permission.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland Both <code class="filename">.key</code> and <code class="filename">.private</code>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland files are generated for symmetric cryptography algorithms such as
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland HMAC-MD5, even though the public and private key are equivalent.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland To generate a 768-bit DSA key for the domain
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <strong class="userinput"><code>example.com</code></strong>, the following command would be
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland The command would print a string of the form:
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland In this example, <span class="command"><strong>dnssec-keygen</strong></span> creates
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland the files <code class="filename">Kexample.com.+003+26160.key</code>
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <code class="filename">Kexample.com.+003+26160.private</code>.
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <span class="refentrytitle">dnssec-signzone</span>(8)
5c51f1241dbbdf2656d0e10011981411ed0c9673Moriah Waterland <em class="citetitle">BIND 9 Administrator Reference Manual</em>,