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