dnssec-keygen.html revision 794b79e6bbc3f5db1ea6ae154d739b9f1ef1a375
03831d35f7499c87d51205817c93e9a8d42c4baestevel - Copyright (C) 2004, 2005, 2007-2012, 2014 Internet Systems Consortium, Inc. ("ISC")
03831d35f7499c87d51205817c93e9a8d42c4baestevel - Copyright (C) 2000-2003 Internet Software Consortium.
03831d35f7499c87d51205817c93e9a8d42c4baestevel - Permission to use, copy, modify, and/or distribute this software for any
03831d35f7499c87d51205817c93e9a8d42c4baestevel - purpose with or without fee is hereby granted, provided that the above
03831d35f7499c87d51205817c93e9a8d42c4baestevel - copyright notice and this permission notice appear in all copies.
03831d35f7499c87d51205817c93e9a8d42c4baestevel - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
03831d35f7499c87d51205817c93e9a8d42c4baestevel - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
03831d35f7499c87d51205817c93e9a8d42c4baestevel - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
03831d35f7499c87d51205817c93e9a8d42c4baestevel - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
03831d35f7499c87d51205817c93e9a8d42c4baestevel - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
03831d35f7499c87d51205817c93e9a8d42c4baestevel - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
03831d35f7499c87d51205817c93e9a8d42c4baestevel - PERFORMANCE OF THIS SOFTWARE.
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!-- $Id$ -->
03831d35f7499c87d51205817c93e9a8d42c4baestevel<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p><span class="application">dnssec-keygen</span> — DNSSEC key generation tool</p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<div class="cmdsynopsis"><p><code class="command">dnssec-keygen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-3</code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-C</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>] [<code class="option">-h</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-k</code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-q</code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-S <em class="replaceable"><code>key</code></em></code>] [<code class="option">-s <em class="replaceable"><code>strength</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-z</code>] {name}</p></div>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p><span><strong class="command">dnssec-keygen</strong></span>
03831d35f7499c87d51205817c93e9a8d42c4baestevel generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
03831d35f7499c87d51205817c93e9a8d42c4baestevel and RFC 4034. It can also generate keys for use with
03831d35f7499c87d51205817c93e9a8d42c4baestevel TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
03831d35f7499c87d51205817c93e9a8d42c4baestevel (Transaction Key) as defined in RFC 2930.
03831d35f7499c87d51205817c93e9a8d42c4baestevel The <code class="option">name</code> of the key is specified on the command
03831d35f7499c87d51205817c93e9a8d42c4baestevel line. For DNSSEC keys, this must match the name of the zone for
03831d35f7499c87d51205817c93e9a8d42c4baestevel which the key is being generated.
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
03831d35f7499c87d51205817c93e9a8d42c4baestevel Selects the cryptographic algorithm. For DNSSEC keys, the value
03831d35f7499c87d51205817c93e9a8d42c4baestevel of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
03831d35f7499c87d51205817c93e9a8d42c4baestevel DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
03831d35f7499c87d51205817c93e9a8d42c4baestevel ECDSAP256SHA256 or ECDSAP384SHA384.
03831d35f7499c87d51205817c93e9a8d42c4baestevel be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
03831d35f7499c87d51205817c93e9a8d42c4baestevel HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe case insensitive.
03831d35f7499c87d51205817c93e9a8d42c4baestevel If no algorithm is specified, then RSASHA1 will be used by
03831d35f7499c87d51205817c93e9a8d42c4baestevel default, unless the <code class="option">-3</code> option is specified,
03831d35f7499c87d51205817c93e9a8d42c4baestevel in which case NSEC3RSASHA1 will be used instead. (If
03831d35f7499c87d51205817c93e9a8d42c4baestevel <code class="option">-3</code> is used and an algorithm is specified,
03831d35f7499c87d51205817c93e9a8d42c4baestevel that algorithm will be checked for compatibility with NSEC3.)
03831d35f7499c87d51205817c93e9a8d42c4baestevel Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
03831d35f7499c87d51205817c93e9a8d42c4baestevel algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
03831d35f7499c87d51205817c93e9a8d42c4baestevel Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
03831d35f7499c87d51205817c93e9a8d42c4baestevel automatically set the -T KEY option.
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
03831d35f7499c87d51205817c93e9a8d42c4baestevel Specifies the number of bits in the key. The choice of key
03831d35f7499c87d51205817c93e9a8d42c4baestevel size depends on the algorithm used. RSA keys must be
03831d35f7499c87d51205817c93e9a8d42c4baestevel between 512 and 2048 bits. Diffie Hellman keys must be between
03831d35f7499c87d51205817c93e9a8d42c4baestevel 128 and 4096 bits. DSA keys must be between 512 and 1024
03831d35f7499c87d51205817c93e9a8d42c4baestevel bits and an exact multiple of 64. HMAC keys must be
03831d35f7499c87d51205817c93e9a8d42c4baestevel between 1 and 512 bits. Elliptic curve algorithms don't need
03831d35f7499c87d51205817c93e9a8d42c4baestevel this parameter.
03831d35f7499c87d51205817c93e9a8d42c4baestevel The key size does not need to be specified if using a default
03831d35f7499c87d51205817c93e9a8d42c4baestevel algorithm. The default key size is 1024 bits for zone signing
03831d35f7499c87d51205817c93e9a8d42c4baestevel keys (ZSK's) and 2048 bits for key signing keys (KSK's,
03831d35f7499c87d51205817c93e9a8d42c4baestevel generated with <code class="option">-f KSK</code>). However, if an
03831d35f7499c87d51205817c93e9a8d42c4baestevel algorithm is explicitly specified with the <code class="option">-a</code>,
03831d35f7499c87d51205817c93e9a8d42c4baestevel then there is no default key size, and the <code class="option">-b</code>
03831d35f7499c87d51205817c93e9a8d42c4baestevel must be used.