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