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