dnssec-keygen.html revision c6c78f699b55b3344fb6b17ddc854cbae4610468
1727N/A<!--
1727N/A - Copyright (C) 2004, 2005, 2007, 2008 Internet Systems Consortium, Inc. ("ISC")
1727N/A - Copyright (C) 2000-2003 Internet Software Consortium.
1727N/A -
1727N/A - Permission to use, copy, modify, and distribute this software for any
1727N/A - purpose with or without fee is hereby granted, provided that the above
1727N/A - copyright notice and this permission notice appear in all copies.
1727N/A -
1727N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
1727N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
1727N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
1727N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
1727N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
1727N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1727N/A - PERFORMANCE OF THIS SOFTWARE.
1727N/A-->
1727N/A<!-- $Id: dnssec-keygen.html,v 1.32 2008/10/15 01:11:35 tbox Exp $ -->
1727N/A<html>
1727N/A<head>
1727N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3817N/A<title>dnssec-keygen</title>
1727N/A<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
1727N/A</head>
1727N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
1727N/A<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
1727N/A<div class="refnamediv">
1727N/A<h2>Name</h2>
1727N/A<p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
1727N/A</div>
1727N/A<div class="refsynopsisdiv">
1727N/A<h2>Synopsis</h2>
1727N/A<div class="cmdsynopsis"><p><code class="command">dnssec-keygen</code> {-a <em class="replaceable"><code>algorithm</code></em>} {-b <em class="replaceable"><code>keysize</code></em>} {-n <em class="replaceable"><code>nametype</code></em>} [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-e</code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k</code>] [<code class="option">-p <em class="replaceable"><code>protocol</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>] {name}</p></div>
1727N/A</div>
1727N/A<div class="refsect1" lang="en">
2899N/A<a name="id2543477"></a><h2>DESCRIPTION</h2>
2899N/A<p><span><strong class="command">dnssec-keygen</strong></span>
3817N/A generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
3817N/A and RFC 4034. It can also generate keys for use with
3817N/A TSIG (Transaction Signatures), as defined in RFC 2845.
1727N/A </p>
1727N/A</div>
1727N/A<div class="refsect1" lang="en">
1727N/A<a name="id2543489"></a><h2>OPTIONS</h2>
1727N/A<div class="variablelist"><dl>
1727N/A<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
1727N/A<dd>
1727N/A<p>
1727N/A Selects the cryptographic algorithm. The value of
1727N/A <code class="option">algorithm</code> must be one of RSAMD5 (RSA) or RSASHA1,
1727N/A DSA, NSEC3RSASHA1, NSEC3DSA, DH (Diffie Hellman), or HMAC-MD5.
1727N/A These values are case insensitive.
1727N/A </p>
1727N/A<p>
1727N/A Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
1727N/A algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
4911N/A mandatory.
4911N/A </p>
4911N/A<p>
4911N/A Note 2: HMAC-MD5 and DH automatically set the -k flag.
4911N/A </p>
4911N/A</dd>
4911N/A<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
4911N/A<dd><p>
4911N/A Specifies the number of bits in the key. The choice of key
4911N/A size depends on the algorithm used. RSAMD5 / RSASHA1 keys must be
4911N/A between
4911N/A 512 and 2048 bits. Diffie Hellman keys must be between
4911N/A 128 and 4096 bits. DSA keys must be between 512 and 1024
4911N/A bits and an exact multiple of 64. HMAC-MD5 keys must be
4911N/A between 1 and 512 bits.
4911N/A </p></dd>
4911N/A<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
4911N/A<dd><p>
4911N/A Specifies the owner type of the key. The value of
4911N/A <code class="option">nametype</code> must either be ZONE (for a DNSSEC
4911N/A zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
4911N/A a host (KEY)),
1727N/A USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
1727N/A These values are case insensitive. Defaults to ZONE for DNSKEY
1727N/A generation.
1727N/A </p></dd>
1727N/A<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
1727N/A<dd><p>
4911N/A Indicates that the DNS record containing the key should have
1727N/A the specified class. If not specified, class IN is used.
4911N/A </p></dd>
4337N/A<dt><span class="term">-e</span></dt>
1727N/A<dd><p>
3817N/A If generating an RSAMD5/RSASHA1 key, use a large exponent.
3817N/A </p></dd>
3817N/A<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
<dd><p>
Set the specified flag in the flag field of the KEY/DNSKEY record.
The only recognized flag is KSK (Key Signing Key) DNSKEY.
</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</span></dt>
<dd><p>
Generate KEY records rather than DNSKEY records.
</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">-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>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>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>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2543824"></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="id2543906"></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="id2543949"></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 4033</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2544049"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div></body>
</html>