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