man.dnssec-keygen.html revision 2f8d63983c297c62630044d28a6f66676b4d339d
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!--
03831d35f7499c87d51205817c93e9a8d42c4baestevel - Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
03831d35f7499c87d51205817c93e9a8d42c4baestevel - Copyright (C) 2000-2003 Internet Software Consortium.
03831d35f7499c87d51205817c93e9a8d42c4baestevel -
03831d35f7499c87d51205817c93e9a8d42c4baestevel - Permission to use, copy, modify, and 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 -
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-->
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!-- $Id: man.dnssec-keygen.html,v 1.51 2007/06/18 23:37:20 marka Exp $ -->
03831d35f7499c87d51205817c93e9a8d42c4baestevel<html>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<head>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<title>dnssec-keygen</title>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<link rel="prev" href="man.host.html" title="host">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<link rel="next" href="man.dnssec-signzone.html" title="dnssec-signzone">
03831d35f7499c87d51205817c93e9a8d42c4baestevel</head>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<div class="navheader">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<table width="100%" summary="Navigation header">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<tr><th colspan="3" align="center"><span class="application">dnssec-keygen</span></th></tr>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<tr>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<td width="20%" align="left">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<a accesskey="p" href="man.host.html">Prev</a>�</td>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<th width="60%" align="center">Manual pages</th>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a>
03831d35f7499c87d51205817c93e9a8d42c4baestevel</td>
03831d35f7499c87d51205817c93e9a8d42c4baestevel</tr>
03831d35f7499c87d51205817c93e9a8d42c4baestevel</table>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<hr>
03831d35f7499c87d51205817c93e9a8d42c4baestevel</div>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<div class="refentry" lang="en">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<div class="refnamediv">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<h2>Name</h2>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel</div>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<div class="refsynopsisdiv">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<h2>Synopsis</h2>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<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>
03831d35f7499c87d51205817c93e9a8d42c4baestevel</div>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<div class="refsect1" lang="en">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<a name="id2598262"></a><h2>DESCRIPTION</h2>
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.
03831d35f7499c87d51205817c93e9a8d42c4baestevel </p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel</div>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<div class="refsect1" lang="en">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<a name="id2598276"></a><h2>OPTIONS</h2>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<div class="variablelist"><dl>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dd>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel Selects the cryptographic algorithm. The value of
03831d35f7499c87d51205817c93e9a8d42c4baestevel <code class="option">algorithm</code> must be one of RSAMD5 (RSA) or RSASHA1,
03831d35f7499c87d51205817c93e9a8d42c4baestevel DSA, DH (Diffie Hellman), or HMAC-MD5. These values
03831d35f7499c87d51205817c93e9a8d42c4baestevel are case insensitive.
03831d35f7499c87d51205817c93e9a8d42c4baestevel </p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
03831d35f7499c87d51205817c93e9a8d42c4baestevel algorithm,
03831d35f7499c87d51205817c93e9a8d42c4baestevel and DSA is recommended. For TSIG, HMAC-MD5 is mandatory.
03831d35f7499c87d51205817c93e9a8d42c4baestevel </p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p>
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe Note 2: HMAC-MD5 and DH automatically set the -k flag.
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe </p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel</dd>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dd><p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel Specifies the number of bits in the key. The choice of key
03831d35f7499c87d51205817c93e9a8d42c4baestevel size depends on the algorithm used. RSAMD5 / RSASHA1 keys must be
03831d35f7499c87d51205817c93e9a8d42c4baestevel between
03831d35f7499c87d51205817c93e9a8d42c4baestevel 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-MD5 keys must be
03831d35f7499c87d51205817c93e9a8d42c4baestevel between 1 and 512 bits.
03831d35f7499c87d51205817c93e9a8d42c4baestevel </p></dd>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dd><p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel Specifies the owner type of the key. The value of
03831d35f7499c87d51205817c93e9a8d42c4baestevel <code class="option">nametype</code> must either be ZONE (for a DNSSEC
03831d35f7499c87d51205817c93e9a8d42c4baestevel zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
03831d35f7499c87d51205817c93e9a8d42c4baestevel a host (KEY)),
03831d35f7499c87d51205817c93e9a8d42c4baestevel USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
03831d35f7499c87d51205817c93e9a8d42c4baestevel These values are case insensitive. Defaults to ZONE for DNSKEY
03831d35f7499c87d51205817c93e9a8d42c4baestevel generation.
03831d35f7499c87d51205817c93e9a8d42c4baestevel </p></dd>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dd><p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel Indicates that the DNS record containing the key should have
03831d35f7499c87d51205817c93e9a8d42c4baestevel the specified class. If not specified, class IN is used.
03831d35f7499c87d51205817c93e9a8d42c4baestevel </p></dd>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dt><span class="term">-e</span></dt>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dd><p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel If generating an RSAMD5/RSASHA1 key, use a large exponent.
03831d35f7499c87d51205817c93e9a8d42c4baestevel </p></dd>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dd><p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel Set the specified flag in the flag field of the KEY/DNSKEY record.
03831d35f7499c87d51205817c93e9a8d42c4baestevel The only recognized flag is KSK (Key Signing Key) DNSKEY.
03831d35f7499c87d51205817c93e9a8d42c4baestevel </p></dd>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<dd><p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel 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="id2598619"></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="id2600570"></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="id2600695"></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="id2600726"></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>