dnssec-keygen.html revision f8e3e03cacd16ffb923a9603fca23a9e1a1fee07
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!--
990d0e893f5b70e735cdf990af66e9ec6e91fa78Tinderbox User - Copyright (C) 2004, 2005, 2007-2009 Internet Systems Consortium, Inc. ("ISC")
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - Permission to use, copy, modify, and/or distribute this software for any
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - purpose with or without fee is hereby granted, provided that the above
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein-->
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User<!-- $Id: dnssec-keygen.html,v 1.40 2009/09/15 01:14:41 tbox Exp $ -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<html>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<head>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<title>dnssec-keygen</title>
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</head>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refnamediv">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<h2>Name</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsynopsisdiv">
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews<h2>Synopsis</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<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</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">-K <em class="replaceable"><code>directory</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">-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>strength</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-z</code>] {name}</p></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsect1" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id2543545"></a><h2>DESCRIPTION</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span><strong class="command">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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein (Transaction Key) as defined in RFC 2930.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <code class="option">name</code> of the key is specified on the command
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews line. For DNSSEC keys, this must match the name of the zone for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein which the key is being generated.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsect1" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id2543563"></a><h2>OPTIONS</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="variablelist"><dl>
e4a70b8fdfc5d2db2d992d884327a1e1fec67a07Tinderbox User<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Selects the cryptographic algorithm. For DNSSEC keys, the value
e4a70b8fdfc5d2db2d992d884327a1e1fec67a07Tinderbox User of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein DSA, NSEC3RSASHA1, or NSEC3DSA. For TSIG/TKEY, the value must
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein case insensitive.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User<p>
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User If no algorithm is specified, then RSASHA1 will be used by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default, unless the <code class="option">-3</code> option is specified,
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User in which case NSEC3RSASHA1 will be used instead.
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User </p>
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User<p>
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User mandatory.
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User </p>
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User<p>
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein automatically set the -T KEY option.
a87790b9d8e062fac1b2dfb8903e77bfe92a3891Tinderbox User </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the number of bits in the key. The choice of key
a1ad6695ed6f988406cf155aa26376f84f73bcb9Automatic Updater size depends on the algorithm used. RSAMD5 / RSASHA1 keys must be
27963ad22062efe8eac2beed51ff70d8f0b35900Tinderbox User between 512 and 2048 bits. Diffie Hellman keys must be between
a1ad6695ed6f988406cf155aa26376f84f73bcb9Automatic Updater 128 and 4096 bits. DSA keys must be between 512 and 1024
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater bits and an exact multiple of 64. HMAC-MD5 keys must be
27963ad22062efe8eac2beed51ff70d8f0b35900Tinderbox User between 1 and 512 bits.
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater </p>
27963ad22062efe8eac2beed51ff70d8f0b35900Tinderbox User<p>
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater 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 (ZSK's) and 2048 bits for key signing keys (KSK's,
27963ad22062efe8eac2beed51ff70d8f0b35900Tinderbox User 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>
f39512a917cdd06c611d366603374f6ef570c80eTinderbox User must be used.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
f39512a917cdd06c611d366603374f6ef570c80eTinderbox User</dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
f39512a917cdd06c611d366603374f6ef570c80eTinderbox User Specifies the owner type of the key. The value of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">nametype</code> must either be ZONE (for a DNSSEC
f39512a917cdd06c611d366603374f6ef570c80eTinderbox User zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
f39512a917cdd06c611d366603374f6ef570c80eTinderbox User a host (KEY)),
f39512a917cdd06c611d366603374f6ef570c80eTinderbox User USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews These values are case insensitive. Defaults to ZONE for DNSKEY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein generation.
507151045be68c671ffd4e2f37e17cdfa0376fc4Automatic Updater </p></dd>
507151045be68c671ffd4e2f37e17cdfa0376fc4Automatic Updater<dt><span class="term">-3</span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Use an NSEC3-capable algorithm to generate a DNSSEC key.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If this option is used and no algorithm is explicitly
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews set on the command line, NSEC3RSASHA1 will be used by
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews default.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews<dt><span class="term">-C</span></dt>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Compatibility mode: generates an old-style key, without
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein any metadata. By default, <span><strong class="command">dnssec-keygen</strong></span>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews 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
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews this data may be incompatible with older versions of BIND; the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">-C</code> option suppresses them.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Indicates that the DNS record containing the key should have
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the specified class. If not specified, class IN is used.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-e</span></dt>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If generating an RSAMD5/RSASHA1 key, use a large exponent.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
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 </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-G</span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
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 </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-h</span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Prints a short summary of the options and arguments to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">dnssec-keygen</strong></span>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the directory in which the key files are to be written.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-k</span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Deprecated in favor of -T KEY.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
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.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specifies the source of randomness. If the operating
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews system does not provide a <code class="filename">/dev/random</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews or equivalent device, the default source of randomness
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews is keyboard input. <code class="filename">randomdev</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews specifies
b05bdb520d83f7ecaad708fe305268c3420be01dMark Andrews the name of a character device or file containing random
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews data to be used instead of the default. The special value
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="filename">keyboard</code> indicates that keyboard
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews input should be used.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews 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 </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
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 </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater<p>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater Using any TSIG algorithm (HMAC-* or DH) forces this option
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater to KEY.
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater </p>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater</dd>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater<dd><p>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater Indicates the use of the key. <code class="option">type</code> must be
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater is AUTHCONF. AUTH refers to the ability to authenticate
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater data, and CONF the ability to encrypt data.
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater </p></dd>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the debugging level.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</dl></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsect1" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id2544075"></a><h2>TIMING OPTIONS</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If the argument begins with a '+' or '-', it is interpreted as
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein an offset from the present time. For convenience, if such an offset
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then the offset is computed in years (defined as 365 24-hour days,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ignoring leap years), months (defined as 30 24-hour days), weeks,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein days, hours, or minutes, respectively. Without a suffix, the offset
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is computed in seconds.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="variablelist"><dl>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the date on which a key is to be published to the zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein After that date, the key will be included in the zone but will
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein not be used to sign it. If not set, and if the -G option has
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein not been used, the default is "now".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the date on which the key is to be activated. After that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein date, the key will be included and 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".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the date on which the key is to be revoked. After that
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews date, the key will be flagged as revoked. It will be included
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews in the zone and will be used to sign it.
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews </p></dd>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews<dd><p>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews Sets the date on which the key is to be retired. After that
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews date, the key will still be included in the zone, but it
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews will not be used to sign it.
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews<dd><p>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews Sets the date on which the key is to be deleted. After that
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews date, the key will no longer be included in the zone. (It
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein may remain in the key repository, however.)
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews </p></dd>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews</dl></div>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsect1" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id2544173"></a><h2>GENERATED KEYS</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein When <span><strong class="command">dnssec-keygen</strong></span> completes
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein successfully,
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 </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="itemizedlist"><ul type="disc">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<li><p><code class="filename">nnnn</code> is the key name.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></li>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<li><p><code class="filename">aaa</code> is the numeric representation
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></li>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User<li><p><code class="filename">iiiii</code> is the key identifier (or
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User footprint).
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User </p></li>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User</ul></div>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User<p><span><strong class="command">dnssec-keygen</strong></span>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User creates two files, with names based
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User contains the public key, and
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User private
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User key.
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User </p>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User<p>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User The <code class="filename">.key</code> file contains a DNS KEY record
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein can be inserted into a zone file (directly or with a $INCLUDE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein statement).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <code class="filename">.private</code> file contains
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm-specific
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fields. For obvious security reasons, this file does not have
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein general read permission.
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Both <code class="filename">.key</code> and <code class="filename">.private</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein files are generated for symmetric encryption algorithms such as
b05bdb520d83f7ecaad708fe305268c3420be01dMark Andrews HMAC-MD5, even though the public and private key are equivalent.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsect1" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id2544256"></a><h2>EXAMPLE</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein issued:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The command would print a string of the form:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein In this example, <span><strong class="command">dnssec-keygen</strong></span> creates
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the files <code class="filename">Kexample.com.+003+26160.key</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="filename">Kexample.com.+003+26160.private</code>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews<div class="refsect1" lang="en">
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews<a name="id2544299"></a><h2>SEE ALSO</h2>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews<p><span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews <em class="citetitle">RFC 2539</em>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="citetitle">RFC 2845</em>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="citetitle">RFC 4033</em>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsect1" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id2544330"></a><h2>AUTHOR</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="corpauthor">Internet Systems Consortium</span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div></body>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</html>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein