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