man.dnssec-keygen.html revision 6bf6622b7b9053dc52527478473b572f042c4b5b
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<!--
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - Copyright (C) 2004-2006 Internet Systems Consortium, Inc. ("ISC")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - Copyright (C) 2000-2003 Internet Software Consortium.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster -
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - Permission to use, copy, modify, and distribute this software for any
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - purpose with or without fee is hereby granted, provided that the above
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - copyright notice and this permission notice appear in all copies.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster -
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster - PERFORMANCE OF THIS SOFTWARE.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster-->
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<!-- $Id: man.dnssec-keygen.html,v 1.29 2006/06/04 23:38:17 marka Exp $ -->
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<html>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<head>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<title>dnssec-keygen</title>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<link rel="prev" href="man.host.html" title="host">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<link rel="next" href="man.dnssec-signzone.html" title="dnssec-signzone">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster</head>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<div class="navheader">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<table width="100%" summary="Navigation header">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<tr><th colspan="3" align="center"><span class="application">dnssec-keygen</span></th></tr>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<tr>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<td width="20%" align="left">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<a accesskey="p" href="man.host.html">Prev</a>�</td>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<th width="60%" align="center">Manual pages</th>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster</td>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster</tr>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster</table>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<hr>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster</div>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<div class="refentry" lang="en">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<div class="refnamediv">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<h2>Name</h2>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster</div>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<div class="refsynopsisdiv">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<h2>Synopsis</h2>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<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>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster</div>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<div class="refsect1" lang="en">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<a name="id2578452"></a><h2>DESCRIPTION</h2>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<p><span><strong class="command">dnssec-keygen</strong></span>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster and RFC &lt;TBA\&gt;. It can also generate keys for use with
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster TSIG (Transaction Signatures), as defined in RFC 2845.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster</div>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<div class="refsect1" lang="en">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<a name="id2578466"></a><h2>OPTIONS</h2>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<div class="variablelist"><dl>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Selects the cryptographic algorithm. The value of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster <code class="option">algorithm</code> must be one of RSAMD5 (RSA) or RSASHA1,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSA, DH (Diffie Hellman), or HMAC-MD5. These values
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster are case insensitive.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster algorithm,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster and DSA is recommended. For TSIG, HMAC-MD5 is mandatory.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Note 2: HMAC-MD5 and DH automatically set the -k flag.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster</dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd><p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Specifies the number of bits in the key. The choice of key
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster size depends on the algorithm used. RSAMD5 / RSASHA1 keys must be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster between
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster 512 and 2048 bits. Diffie Hellman keys must be between
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster 128 and 4096 bits. DSA keys must be between 512 and 1024
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster bits and an exact multiple of 64. HMAC-MD5 keys must be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster between 1 and 512 bits.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p></dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd><p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Specifies the owner type of the key. The value of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster <code class="option">nametype</code> must either be ZONE (for a DNSSEC
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster a host (KEY)),
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster These values are
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster case insensitive.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p></dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd><p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Indicates that the DNS record containing the key should have
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster the specified class. If not specified, class IN is used.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p></dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-e</span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd><p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster If generating an RSAMD5/RSASHA1 key, use a large exponent.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p></dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd><p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Set the specified flag in the flag field of the KEY/DNSKEY record.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster The only recognized flag is KSK (Key Signing Key) DNSKEY.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p></dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd><p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster If generating a Diffie Hellman key, use this generator.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Allowed values are 2 and 5. If no generator
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster is specified, a known prime from RFC 2539 will be used
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if possible; otherwise the default is 2.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p></dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-h</span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd><p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Prints a short summary of the options and arguments to
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster <span><strong class="command">dnssec-keygen</strong></span>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p></dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-k</span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd><p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Generate KEY records rather than DNSKEY records.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p></dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd><p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Sets the protocol value for the generated key. The protocol
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster is a number between 0 and 255. The default is 3 (DNSSEC).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Other possible values for this argument are listed in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster RFC 2535 and its successors.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </p></dd>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster<dd><p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Specifies the source of randomness. If the operating
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster 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="id2579150"></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 file, 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 algorithm such as
HMAC-MD5, even though the public and private key are equivalent.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2579258"></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="id2579315"></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 2535</em>,
<em class="citetitle">RFC 2845</em>,
<em class="citetitle">RFC 2539</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2582554"></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.host.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-signzone.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">host�</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-signzone</span></td>
</tr>
</table>
</div>
</body>
</html>