1<!-- 2 - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC") 3 - Copyright (C) 2000-2003 Internet Software Consortium. 4 - 5 - Permission to use, copy, modify, and/or distribute this software for any 6 - purpose with or without fee is hereby granted, provided that the above 7 - copyright notice and this permission notice appear in all copies. 8 - 9 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 10 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 11 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 12 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 13 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 14 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 15 - PERFORMANCE OF THIS SOFTWARE. 16--> 17<!-- $Id$ --> 18<html> 19<head> 20<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 21<title>dnssec-keyfromlabel</title> 22<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> 23<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual"> 24<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages"> 25<link rel="prev" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey"> 26<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen"> 27</head> 28<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 29<div class="navheader"> 30<table width="100%" summary="Navigation header"> 31<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr> 32<tr> 33<td width="20%" align="left"> 34<a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a>�</td> 35<th width="60%" align="center">Manual pages</th> 36<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a> 37</td> 38</tr> 39</table> 40<hr> 41</div> 42<div class="refentry" lang="en"> 43<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div> 44<div class="refnamediv"> 45<h2>Name</h2> 46<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p> 47</div> 48<div class="refsynopsisdiv"> 49<h2>Synopsis</h2> 50<div class="cmdsynopsis"><p><code class="command">dnssec-keyfromlabel</code> {-l <em class="replaceable"><code>label</code></em>} [<code class="option">-3</code>] [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></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">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-k</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></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">-R <em class="replaceable"><code>date/offset</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">-y</code>] {name}</p></div> 51</div> 52<div class="refsect1" lang="en"> 53<a name="id2613302"></a><h2>DESCRIPTION</h2> 54<p><span><strong class="command">dnssec-keyfromlabel</strong></span> 55 gets keys with the given label from a crypto hardware and builds 56 key files for DNSSEC (Secure DNS), as defined in RFC 2535 57 and RFC 4034. 58 </p> 59<p> 60 The <code class="option">name</code> of the key is specified on the command 61 line. This must match the name of the zone for which the key is 62 being generated. 63 </p> 64</div> 65<div class="refsect1" lang="en"> 66<a name="id2613322"></a><h2>OPTIONS</h2> 67<div class="variablelist"><dl> 68<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt> 69<dd> 70<p> 71 Selects the cryptographic algorithm. The value of 72 <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1, 73 DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512 or ECCGOST. 74 These values are case insensitive. 75 </p> 76<p> 77 If no algorithm is specified, then RSASHA1 will be used by 78 default, unless the <code class="option">-3</code> option is specified, 79 in which case NSEC3RSASHA1 will be used instead. (If 80 <code class="option">-3</code> is used and an algorithm is specified, 81 that algorithm will be checked for compatibility with NSEC3.) 82 </p> 83<p> 84 Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement 85 algorithm, and DSA is recommended. 86 </p> 87<p> 88 Note 2: DH automatically sets the -k flag. 89 </p> 90</dd> 91<dt><span class="term">-3</span></dt> 92<dd><p> 93 Use an NSEC3-capable algorithm to generate a DNSSEC key. 94 If this option is used and no algorithm is explicitly 95 set on the command line, NSEC3RSASHA1 will be used by 96 default. 97 </p></dd> 98<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt> 99<dd><p> 100 Specifies the name of the crypto hardware (OpenSSL engine). 101 When compiled with PKCS#11 support it defaults to "pkcs11". 102 </p></dd> 103<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt> 104<dd><p> 105 Specifies the label of the key pair in the crypto hardware. 106 The label may be preceded by an optional OpenSSL engine name, 107 separated by a colon, as in "pkcs11:keylabel". 108 </p></dd> 109<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt> 110<dd><p> 111 Specifies the owner type of the key. The value of 112 <code class="option">nametype</code> must either be ZONE (for a DNSSEC 113 zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with 114 a host (KEY)), 115 USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). 116 These values are case insensitive. 117 </p></dd> 118<dt><span class="term">-C</span></dt> 119<dd><p> 120 Compatibility mode: generates an old-style key, without 121 any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span> 122 will include the key's creation date in the metadata stored 123 with the private key, and other dates may be set there as well 124 (publication date, activation date, etc). Keys that include 125 this data may be incompatible with older versions of BIND; the 126 <code class="option">-C</code> option suppresses them. 127 </p></dd> 128<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt> 129<dd><p> 130 Indicates that the DNS record containing the key should have 131 the specified class. If not specified, class IN is used. 132 </p></dd> 133<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt> 134<dd><p> 135 Set the specified flag in the flag field of the KEY/DNSKEY record. 136 The only recognized flags are KSK (Key Signing Key) and REVOKE. 137 </p></dd> 138<dt><span class="term">-G</span></dt> 139<dd><p> 140 Generate a key, but do not publish it or sign with it. This 141 option is incompatible with -P and -A. 142 </p></dd> 143<dt><span class="term">-h</span></dt> 144<dd><p> 145 Prints a short summary of the options and arguments to 146 <span><strong class="command">dnssec-keyfromlabel</strong></span>. 147 </p></dd> 148<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt> 149<dd><p> 150 Sets the directory in which the key files are to be written. 151 </p></dd> 152<dt><span class="term">-k</span></dt> 153<dd><p> 154 Generate KEY records rather than DNSKEY records. 155 </p></dd> 156<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt> 157<dd><p> 158 Sets the protocol value for the key. The protocol 159 is a number between 0 and 255. The default is 3 (DNSSEC). 160 Other possible values for this argument are listed in 161 RFC 2535 and its successors. 162 </p></dd> 163<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt> 164<dd><p> 165 Indicates the use of the key. <code class="option">type</code> must be 166 one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default 167 is AUTHCONF. AUTH refers to the ability to authenticate 168 data, and CONF the ability to encrypt data. 169 </p></dd> 170<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt> 171<dd><p> 172 Sets the debugging level. 173 </p></dd> 174<dt><span class="term">-y</span></dt> 175<dd><p> 176 Allows DNSSEC key files to be generated even if the key ID 177 would collide with that of an existing key, in the event of 178 either key being revoked. (This is only safe to use if you 179 are sure you won't be using RFC 5011 trust anchor maintenance 180 with either of the keys involved.) 181 </p></dd> 182</dl></div> 183</div> 184<div class="refsect1" lang="en"> 185<a name="id2614168"></a><h2>TIMING OPTIONS</h2> 186<p> 187 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. 188 If the argument begins with a '+' or '-', it is interpreted as 189 an offset from the present time. For convenience, if such an offset 190 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', 191 then the offset is computed in years (defined as 365 24-hour days, 192 ignoring leap years), months (defined as 30 24-hour days), weeks, 193 days, hours, or minutes, respectively. Without a suffix, the offset 194 is computed in seconds. 195 </p> 196<div class="variablelist"><dl> 197<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt> 198<dd><p> 199 Sets the date on which a key is to be published to the zone. 200 After that date, the key will be included in the zone but will 201 not be used to sign it. If not set, and if the -G option has 202 not been used, the default is "now". 203 </p></dd> 204<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt> 205<dd><p> 206 Sets the date on which the key is to be activated. After that 207 date, the key will be included in the zone and used to sign 208 it. If not set, and if the -G option has not been used, the 209 default is "now". 210 </p></dd> 211<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt> 212<dd><p> 213 Sets the date on which the key is to be revoked. After that 214 date, the key will be flagged as revoked. It will be included 215 in the zone and will be used to sign it. 216 </p></dd> 217<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt> 218<dd><p> 219 Sets the date on which the key is to be retired. After that 220 date, the key will still be included in the zone, but it 221 will not be used to sign it. 222 </p></dd> 223<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt> 224<dd><p> 225 Sets the date on which the key is to be deleted. After that 226 date, the key will no longer be included in the zone. (It 227 may remain in the key repository, however.) 228 </p></dd> 229</dl></div> 230</div> 231<div class="refsect1" lang="en"> 232<a name="id2614266"></a><h2>GENERATED KEY FILES</h2> 233<p> 234 When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes 235 successfully, 236 it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code> 237 to the standard output. This is an identification string for 238 the key files it has generated. 239 </p> 240<div class="itemizedlist"><ul type="disc"> 241<li><p><code class="filename">nnnn</code> is the key name. 242 </p></li> 243<li><p><code class="filename">aaa</code> is the numeric representation 244 of the algorithm. 245 </p></li> 246<li><p><code class="filename">iiiii</code> is the key identifier (or 247 footprint). 248 </p></li> 249</ul></div> 250<p><span><strong class="command">dnssec-keyfromlabel</strong></span> 251 creates two files, with names based 252 on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code> 253 contains the public key, and 254 <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the 255 private key. 256 </p> 257<p> 258 The <code class="filename">.key</code> file contains a DNS KEY record 259 that 260 can be inserted into a zone file (directly or with a $INCLUDE 261 statement). 262 </p> 263<p> 264 The <code class="filename">.private</code> file contains 265 algorithm-specific 266 fields. For obvious security reasons, this file does not have 267 general read permission. 268 </p> 269</div> 270<div class="refsect1" lang="en"> 271<a name="id2615589"></a><h2>SEE ALSO</h2> 272<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, 273 <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, 274 <em class="citetitle">BIND 9 Administrator Reference Manual</em>, 275 <em class="citetitle">RFC 4034</em>. 276 </p> 277</div> 278<div class="refsect1" lang="en"> 279<a name="id2615622"></a><h2>AUTHOR</h2> 280<p><span class="corpauthor">Internet Systems Consortium</span> 281 </p> 282</div> 283</div> 284<div class="navfooter"> 285<hr> 286<table width="100%" summary="Navigation footer"> 287<tr> 288<td width="40%" align="left"> 289<a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a>�</td> 290<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td> 291<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a> 292</td> 293</tr> 294<tr> 295<td width="40%" align="left" valign="top"> 296<span class="application">dnssec-dsfromkey</span>�</td> 297<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td> 298<td width="40%" align="right" valign="top">�<span class="application">dnssec-keygen</span> 299</td> 300</tr> 301</table> 302</div> 303</body> 304</html> 305