man.dnssec-keygen.html revision 8ee776c51b1c7e77bdde29dedd2b50ff48a0d002
9bff67898d55cddfcec9ce30cc2b1bb6211ec691David Lawrence<!--
9bff67898d55cddfcec9ce30cc2b1bb6211ec691David Lawrence - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
9bff67898d55cddfcec9ce30cc2b1bb6211ec691David Lawrence - Copyright (C) 2000-2003 Internet Software Consortium.
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence -
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff - Permission to use, copy, modify, and distribute this software for any
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff - purpose with or without fee is hereby granted, provided that the above
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff - copyright notice and this permission notice appear in all copies.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff -
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence - PERFORMANCE OF THIS SOFTWARE.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff-->
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<!-- $Id: man.dnssec-keygen.html,v 1.112 2009/04/09 01:12:31 tbox Exp $ -->
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<html>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<head>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<title>dnssec-keygen</title>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<link rel="prev" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<link rel="next" href="man.dnssec-signzone.html" title="dnssec-signzone">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff</head>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<div class="navheader">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<table width="100%" summary="Navigation header">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<tr><th colspan="3" align="center"><span class="application">dnssec-keygen</span></th></tr>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<tr>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<td width="20%" align="left">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a>�</td>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<th width="60%" align="center">Manual pages</th>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff</td>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff</tr>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff</table>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<hr>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff</div>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<div class="refentry" lang="en">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<div class="refnamediv">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<h2>Name</h2>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff</div>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<div class="refsynopsisdiv">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<h2>Synopsis</h2>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<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>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff</div>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<div class="refsect1" lang="en">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<a name="id2606172"></a><h2>DESCRIPTION</h2>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<p><span><strong class="command">dnssec-keygen</strong></span>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff and RFC 4034. It can also generate keys for use with
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff TSIG (Transaction Signatures), as defined in RFC 2845.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff </p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff</div>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<div class="refsect1" lang="en">
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<a name="id2606186"></a><h2>OPTIONS</h2>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<div class="variablelist"><dl>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dd>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff Selects the cryptographic algorithm. The value of
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff <code class="option">algorithm</code> must be one of RSAMD5 (RSA) or RSASHA1,
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff DSA, NSEC3RSASHA1, NSEC3DSA, DH (Diffie Hellman), or HMAC-MD5.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff These values are case insensitive.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff </p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff mandatory.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff </p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff Note 2: HMAC-MD5 and DH automatically set the -k flag.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff </p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff</dd>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dd><p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff Specifies the number of bits in the key. The choice of key
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff size depends on the algorithm used. RSAMD5 / RSASHA1 keys must be
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff between
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff 512 and 2048 bits. Diffie Hellman keys must be between
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff 128 and 4096 bits. DSA keys must be between 512 and 1024
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff bits and an exact multiple of 64. HMAC-MD5 keys must be
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff between 1 and 512 bits.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff </p></dd>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dd><p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff Specifies the owner type of the key. The value of
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff <code class="option">nametype</code> must either be ZONE (for a DNSSEC
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff a host (KEY)),
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff These values are case insensitive. Defaults to ZONE for DNSKEY
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff generation.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff </p></dd>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dd><p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff Indicates that the DNS record containing the key should have
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff the specified class. If not specified, class IN is used.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff </p></dd>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dt><span class="term">-e</span></dt>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dd><p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff If generating an RSAMD5/RSASHA1 key, use a large exponent.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff </p></dd>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dd><p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff Set the specified flag in the flag field of the KEY/DNSKEY record.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff The only recognized flag is KSK (Key Signing Key) DNSKEY.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff </p></dd>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff<dd><p>
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff If generating a Diffie Hellman key, use this generator.
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff Allowed values are 2 and 5. If no generator
79d29bd3206f9dfc77521bcdc516c5e255bc717dMichael Graff 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="id2606803"></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="id2606910"></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="id2608742"></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="id2608773"></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.dnssec-keyfromlabel.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">
<span class="application">dnssec-keyfromlabel</span>�</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>