dnssec-keygen.html revision a3f8c8e20780e488141d200acdfea6c5f3303513
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt - Copyright (C) 2004, 2005, 2007-2011 Internet Systems Consortium, Inc. ("ISC")
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt - Copyright (C) 2000-2003 Internet Software Consortium.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - Permission to use, copy, modify, and/or distribute this software for any
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - purpose with or without fee is hereby granted, provided that the above
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt - copyright notice and this permission notice appear in all copies.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont - PERFORMANCE OF THIS SOFTWARE.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<!-- $Id: dnssec-keygen.html,v 1.48 2011/03/18 01:14:33 tbox Exp $ -->
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<p><span class="application">dnssec-keygen</span> — DNSSEC key generation tool</p>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<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">-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">-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>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont<p><span><strong class="command">dnssec-keygen</strong></span>
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt and RFC 4034. It can also generate keys for use with
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont (Transaction Key) as defined in RFC 2930.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont The <code class="option">name</code> of the key is specified on the command
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt line. For DNSSEC keys, this must match the name of the zone for
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont which the key is being generated.
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt Selects the cryptographic algorithm. For DNSSEC keys, the value
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512 or ECCGOST.
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt case insensitive.
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt If no algorithm is specified, then RSASHA1 will be used by
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt default, unless the <code class="option">-3</code> option is specified,
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt in which case NSEC3RSASHA1 will be used instead. (If
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt <code class="option">-3</code> is used and an algorithm is specified,
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont that algorithm will be checked for compatibility with NSEC3.)
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt automatically set the -T KEY option.
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont Specifies the number of bits in the key. The choice of key
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt size depends on the algorithm used. RSA keys must be
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt between 512 and 2048 bits. Diffie Hellman keys must be between
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt 128 and 4096 bits. DSA keys must be between 512 and 1024
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont bits and an exact multiple of 64. HMAC keys must be
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt between 1 and 512 bits.
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont The key size does not need to be specified if using a default
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt algorithm. The default key size is 1024 bits for zone signing
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont keys (ZSK's) and 2048 bits for key signing keys (KSK's,
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt generated with <code class="option">-f KSK</code>). However, if an
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt algorithm is explicitly specified with the <code class="option">-a</code>,
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt then there is no default key size, and the <code class="option">-b</code>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont must be used.
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont Specifies the owner type of the key. The value of
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont <code class="option">nametype</code> must either be ZONE (for a DNSSEC
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont a host (KEY)),
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont These values are case insensitive. Defaults to ZONE for DNSKEY
247806c82065fc5dcc3d25cfdb0de2725553f237Francis Dupont Use an NSEC3-capable algorithm to generate a DNSSEC key.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont If this option is used and no algorithm is explicitly
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont set on the command line, NSEC3RSASHA1 will be used by
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont default. Note that RSASHA256, RSASHA512 and ECCGOST algorithms
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt are NSEC3-capable.
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont Compatibility mode: generates an old-style key, without
b091b4bb803b830d2d5a9e71b6648b669655d7dcFrancis Dupont any metadata. By default, <span><strong class="command">dnssec-keygen</strong></span>