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