man.dnssec-keygen.html revision 990d0e893f5b70e735cdf990af66e9ec6e91fa78
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen - Copyright (C) 2000-2003 Internet Software Consortium.
a8fe899601735459641edae975c0fa08be8482e2Timo Sirainen - Permission to use, copy, modify, and/or distribute this software for any
a8fe899601735459641edae975c0fa08be8482e2Timo Sirainen - purpose with or without fee is hereby granted, provided that the above
de0971aff3009fe6906c3631e8322908658a5e93Stephan Bosch - copyright notice and this permission notice appear in all copies.
629cb309f6f1bfce4ce0037c0ef089b66281f482Timo Sirainen - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
629cb309f6f1bfce4ce0037c0ef089b66281f482Timo Sirainen - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
3d7828efd92ecc0d08049f727d9be0154d1d681bStephan Bosch - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
44f3f472a49078312432b785fddcfe7b95928391Timo Sirainen - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
f9db221d0793f05c4631885e71f98145428a7e1bTimo Sirainen - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen - PERFORMANCE OF THIS SOFTWARE.
4ee00532a265bdfb38539d811fcd12d51210ac35Timo Sirainen<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
44f3f472a49078312432b785fddcfe7b95928391Timo Sirainen<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen<link rel="prev" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel">
0f72f253d5a117dad2f28b2ce336190a5e6b79c8Stephan Bosch<link rel="next" href="man.dnssec-revoke.html" title="dnssec-revoke">
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
6b6011c2242e470b41316f92512b282b5e306dacTimo Sirainen<table width="100%" summary="Navigation header">
6b6011c2242e470b41316f92512b282b5e306dacTimo Sirainen<tr><th colspan="3" align="center"><span class="application">dnssec-keygen</span></th></tr>
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen<a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a>�</td>
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen<th width="60%" align="center">Manual pages</th>
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-revoke.html">Next</a>
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
de0971aff3009fe6906c3631e8322908658a5e93Stephan Bosch<p><span class="application">dnssec-keygen</span> — DNSSEC key generation tool</p>
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen<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">-3</code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-C</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>] [<code class="option">-h</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-k</code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-q</code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-S <em class="replaceable"><code>key</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>] [<code class="option">-z</code>] {name}</p></div>
2ef5254ab6b446b93ce7733bc96eeefa6f731ee4Timo Sirainen<p><span><strong class="command">dnssec-keygen</strong></span>
2ef5254ab6b446b93ce7733bc96eeefa6f731ee4Timo Sirainen generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
2ef5254ab6b446b93ce7733bc96eeefa6f731ee4Timo Sirainen and RFC 4034. It can also generate keys for use with
2ef5254ab6b446b93ce7733bc96eeefa6f731ee4Timo Sirainen TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
2ef5254ab6b446b93ce7733bc96eeefa6f731ee4Timo Sirainen (Transaction Key) as defined in RFC 2930.
291f1e54dcb8c7f38e5b78afc1eaf518e3756692Timo Sirainen The <code class="option">name</code> of the key is specified on the command
b9dce659b9135c87c7708b2bb0f14e8742db7e15Timo Sirainen line. For DNSSEC keys, this must match the name of the zone for
b9dce659b9135c87c7708b2bb0f14e8742db7e15Timo Sirainen which the key is being generated.
6682872f15fc74c1aa8898d4dc5745ff6a5dc51eTimo Sirainen<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
6cc815e209fa75989ad2a309119d4f286a6ea00fTimo Sirainen Selects the cryptographic algorithm. For DNSSEC keys, the value
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
f9db221d0793f05c4631885e71f98145428a7e1bTimo Sirainen ECDSAP256SHA256 or ECDSAP384SHA384.
f9db221d0793f05c4631885e71f98145428a7e1bTimo Sirainen be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
f9db221d0793f05c4631885e71f98145428a7e1bTimo Sirainen HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
f9db221d0793f05c4631885e71f98145428a7e1bTimo Sirainen case insensitive.
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen If no algorithm is specified, then RSASHA1 will be used by
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen default, unless the <code class="option">-3</code> option is specified,
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen in which case NSEC3RSASHA1 will be used instead. (If
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen <code class="option">-3</code> is used and an algorithm is specified,
6b6011c2242e470b41316f92512b282b5e306dacTimo Sirainen that algorithm will be checked for compatibility with NSEC3.)
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
3d7828efd92ecc0d08049f727d9be0154d1d681bStephan Bosch Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
3d7828efd92ecc0d08049f727d9be0154d1d681bStephan Bosch automatically set the -T KEY option.
44f3f472a49078312432b785fddcfe7b95928391Timo Sirainen<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
f9db221d0793f05c4631885e71f98145428a7e1bTimo Sirainen Specifies the number of bits in the key. The choice of key
f9db221d0793f05c4631885e71f98145428a7e1bTimo Sirainen size depends on the algorithm used. RSA keys must be
f9db221d0793f05c4631885e71f98145428a7e1bTimo Sirainen between 512 and 2048 bits. Diffie Hellman keys must be between
f9db221d0793f05c4631885e71f98145428a7e1bTimo Sirainen 128 and 4096 bits. DSA keys must be between 512 and 1024
258adfa09081ea8600a39759d486e678b5aa5f60Timo Sirainen bits and an exact multiple of 64. HMAC keys must be
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen between 1 and 512 bits. Elliptic curve algorithms don't need
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen this parameter.
21fdf5394fbc307673b6c4b33f2497751a9ca1feTimo Sirainen The key size does not need to be specified if using a default
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen algorithm. The default key size is 1024 bits for zone signing
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen keys (ZSK's) and 2048 bits for key signing keys (KSK's,
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen generated with <code class="option">-f KSK</code>). However, if an
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen algorithm is explicitly specified with the <code class="option">-a</code>,
92e6bb6497f8c9d57bff334a5c9f31bc2f040394Timo Sirainen then there is no default key size, and the <code class="option">-b</code>
92e6bb6497f8c9d57bff334a5c9f31bc2f040394Timo Sirainen must be used.
eed56fe22f1fc61f2003d5e66373d03dacbc9aaaTimo Sirainen<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
eed56fe22f1fc61f2003d5e66373d03dacbc9aaaTimo Sirainen Specifies the owner type of the key. The value of
58c61ac5650583d21c891e61e051c614290d31fbTimo Sirainen <code class="option">nametype</code> must either be ZONE (for a DNSSEC