1<!-- 2 - Copyright (C) 2004-2015 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: man.dnssec-keyfromlabel.html,v 1.5 2015/09/03 07:33:34 christos Exp $ --> 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.ch13.html" title="Manual pages"> 25<link rel="prev" href="man.dnssec-importkey.html" title="dnssec-importkey"> 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-importkey.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">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-k</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">-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">-S <em class="replaceable"><code>key</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">-V</code>] [<code class="option">-y</code>] {name}</p></div> 51</div> 52<div class="refsect1" lang="en"> 53<a name="id2621113"></a><h2>DESCRIPTION</h2> 54<p><span><strong class="command">dnssec-keyfromlabel</strong></span> 55 generates a key pair of files that referencing a key object stored 56 in a cryptographic hardware service module (HSM). The private key 57 file can be used for DNSSEC signing of zone data as if it were a 58 conventional signing key created by <span><strong class="command">dnssec-keygen</strong></span>, 59 but the key material is stored within the HSM, and the actual signing 60 takes place there. 61 </p> 62<p> 63 The <code class="option">name</code> of the key is specified on the command 64 line. This must match the name of the zone for which the key is 65 being generated. 66 </p> 67</div> 68<div class="refsect1" lang="en"> 69<a name="id2621139"></a><h2>OPTIONS</h2> 70<div class="variablelist"><dl> 71<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt> 72<dd> 73<p> 74 Selects the cryptographic algorithm. The value of 75 <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1, 76 DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, 77 ECDSAP256SHA256 or ECDSAP384SHA384. 78 These values are case insensitive. 79 </p> 80<p> 81 If no algorithm is specified, then RSASHA1 will be used by 82 default, unless the <code class="option">-3</code> option is specified, 83 in which case NSEC3RSASHA1 will be used instead. (If 84 <code class="option">-3</code> is used and an algorithm is specified, 85 that algorithm will be checked for compatibility with NSEC3.) 86 </p> 87<p> 88 Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement 89 algorithm, and DSA is recommended. 90 </p> 91<p> 92 Note 2: DH automatically sets the -k flag. 93 </p> 94</dd> 95<dt><span class="term">-3</span></dt> 96<dd><p> 97 Use an NSEC3-capable algorithm to generate a DNSSEC key. 98 If this option is used and no algorithm is explicitly 99 set on the command line, NSEC3RSASHA1 will be used by 100 default. 101 </p></dd> 102<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt> 103<dd> 104<p> 105 Specifies the cryptographic hardware to use. 106 </p> 107<p> 108 When BIND is built with OpenSSL PKCS#11 support, this defaults 109 to the string "pkcs11", which identifies an OpenSSL engine 110 that can drive a cryptographic accelerator or hardware service 111 module. When BIND is built with native PKCS#11 cryptography 112 (--enable-native-pkcs11), it defaults to the path of the PKCS#11 113 provider library specified via "--with-pkcs11". 114 </p> 115</dd> 116<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt> 117<dd> 118<p> 119 Specifies the label for a key pair in the crypto hardware. 120 </p> 121<p> 122 When <acronym class="acronym">BIND</acronym> 9 is built with OpenSSL-based 123 PKCS#11 support, the label is an arbitrary string that 124 identifies a particular key. It may be preceded by an 125 optional OpenSSL engine name, followed by a colon, as in 126 "pkcs11:<em class="replaceable"><code>keylabel</code></em>". 127 </p> 128<p> 129 When <acronym class="acronym">BIND</acronym> 9 is built with native PKCS#11 130 support, the label is a PKCS#11 URI string in the format 131 "pkcs11:<code class="option">keyword</code>=<em class="replaceable"><code>value</code></em>[<span class="optional">;<code class="option">keyword</code>=<em class="replaceable"><code>value</code></em>;...</span>]" 132 Keywords include "token", which identifies the HSM; "object", which 133 identifies the key; and "pin-source", which identifies a file from 134 which the HSM's PIN code can be obtained. The label will be 135 stored in the on-disk "private" file. 136 </p> 137<p> 138 If the label contains a 139 <code class="option">pin-source</code> field, tools using the generated 140 key files will be able to use the HSM for signing and other 141 operations without any need for an operator to manually enter 142 a PIN. Note: Making the HSM's PIN accessible in this manner 143 may reduce the security advantage of using an HSM; be sure 144 this is what you want to do before making use of this feature. 145 </p> 146</dd> 147<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt> 148<dd><p> 149 Specifies the owner type of the key. The value of 150 <code class="option">nametype</code> must either be ZONE (for a DNSSEC 151 zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with 152 a host (KEY)), 153 USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). 154 These values are case insensitive. 155 </p></dd> 156<dt><span class="term">-C</span></dt> 157<dd><p> 158 Compatibility mode: generates an old-style key, without 159 any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span> 160 will include the key's creation date in the metadata stored 161 with the private key, and other dates may be set there as well 162 (publication date, activation date, etc). Keys that include 163 this data may be incompatible with older versions of BIND; the 164 <code class="option">-C</code> option suppresses them. 165 </p></dd> 166<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt> 167<dd><p> 168 Indicates that the DNS record containing the key should have 169 the specified class. If not specified, class IN is used. 170 </p></dd> 171<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt> 172<dd><p> 173 Set the specified flag in the flag field of the KEY/DNSKEY record. 174 The only recognized flags are KSK (Key Signing Key) and REVOKE. 175 </p></dd> 176<dt><span class="term">-G</span></dt> 177<dd><p> 178 Generate a key, but do not publish it or sign with it. This 179 option is incompatible with -P and -A. 180 </p></dd> 181<dt><span class="term">-h</span></dt> 182<dd><p> 183 Prints a short summary of the options and arguments to 184 <span><strong class="command">dnssec-keyfromlabel</strong></span>. 185 </p></dd> 186<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt> 187<dd><p> 188 Sets the directory in which the key files are to be written. 189 </p></dd> 190<dt><span class="term">-k</span></dt> 191<dd><p> 192 Generate KEY records rather than DNSKEY records. 193 </p></dd> 194<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt> 195<dd><p> 196 Sets the default TTL to use for this key when it is converted 197 into a DNSKEY RR. If the key is imported into a zone, 198 this is the TTL that will be used for it, unless there was 199 already a DNSKEY RRset in place, in which case the existing TTL 200 would take precedence. Setting the default TTL to 201 <code class="literal">0</code> or <code class="literal">none</code> removes it. 202 </p></dd> 203<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt> 204<dd><p> 205 Sets the protocol value for the key. The protocol 206 is a number between 0 and 255. The default is 3 (DNSSEC). 207 Other possible values for this argument are listed in 208 RFC 2535 and its successors. 209 </p></dd> 210<dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt> 211<dd><p> 212 Generate a key as an explicit successor to an existing key. 213 The name, algorithm, size, and type of the key will be set 214 to match the predecessor. The activation date of the new 215 key will be set to the inactivation date of the existing 216 one. The publication date will be set to the activation 217 date minus the prepublication interval, which defaults to 218 30 days. 219 </p></dd> 220<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt> 221<dd><p> 222 Indicates the use of the key. <code class="option">type</code> must be 223 one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default 224 is AUTHCONF. AUTH refers to the ability to authenticate 225 data, and CONF the ability to encrypt data. 226 </p></dd> 227<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt> 228<dd><p> 229 Sets the debugging level. 230 </p></dd> 231<dt><span class="term">-V</span></dt> 232<dd><p> 233 Prints version information. 234 </p></dd> 235<dt><span class="term">-y</span></dt> 236<dd><p> 237 Allows DNSSEC key files to be generated even if the key ID 238 would collide with that of an existing key, in the event of 239 either key being revoked. (This is only safe to use if you 240 are sure you won't be using RFC 5011 trust anchor maintenance 241 with either of the keys involved.) 242 </p></dd> 243</dl></div> 244</div> 245<div class="refsect1" lang="en"> 246<a name="id2672193"></a><h2>TIMING OPTIONS</h2> 247<p> 248 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. 249 If the argument begins with a '+' or '-', it is interpreted as 250 an offset from the present time. For convenience, if such an offset 251 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', 252 then the offset is computed in years (defined as 365 24-hour days, 253 ignoring leap years), months (defined as 30 24-hour days), weeks, 254 days, hours, or minutes, respectively. Without a suffix, the offset 255 is computed in seconds. To explicitly prevent a date from being 256 set, use 'none' or 'never'. 257 </p> 258<div class="variablelist"><dl> 259<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt> 260<dd><p> 261 Sets the date on which a key is to be published to the zone. 262 After that date, the key will be included in the zone but will 263 not be used to sign it. If not set, and if the -G option has 264 not been used, the default is "now". 265 </p></dd> 266<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt> 267<dd><p> 268 Sets the date on which the key is to be activated. After that 269 date, the key will be included in the zone and used to sign 270 it. If not set, and if the -G option has not been used, the 271 default is "now". 272 </p></dd> 273<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt> 274<dd><p> 275 Sets the date on which the key is to be revoked. After that 276 date, the key will be flagged as revoked. It will be included 277 in the zone and will be used to sign it. 278 </p></dd> 279<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt> 280<dd><p> 281 Sets the date on which the key is to be retired. After that 282 date, the key will still be included in the zone, but it 283 will not be used to sign it. 284 </p></dd> 285<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt> 286<dd><p> 287 Sets the date on which the key is to be deleted. After that 288 date, the key will no longer be included in the zone. (It 289 may remain in the key repository, however.) 290 </p></dd> 291<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt> 292<dd> 293<p> 294 Sets the prepublication interval for a key. If set, then 295 the publication and activation dates must be separated by at least 296 this much time. If the activation date is specified but the 297 publication date isn't, then the publication date will default 298 to this much time before the activation date; conversely, if 299 the publication date is specified but activation date isn't, 300 then activation will be set to this much time after publication. 301 </p> 302<p> 303 If the key is being created as an explicit successor to another 304 key, then the default prepublication interval is 30 days; 305 otherwise it is zero. 306 </p> 307<p> 308 As with date offsets, if the argument is followed by one of 309 the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the 310 interval is measured in years, months, weeks, days, hours, 311 or minutes, respectively. Without a suffix, the interval is 312 measured in seconds. 313 </p> 314</dd> 315</dl></div> 316</div> 317<div class="refsect1" lang="en"> 318<a name="id2672451"></a><h2>GENERATED KEY FILES</h2> 319<p> 320 When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes 321 successfully, 322 it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code> 323 to the standard output. This is an identification string for 324 the key files it has generated. 325 </p> 326<div class="itemizedlist"><ul type="disc"> 327<li><p><code class="filename">nnnn</code> is the key name. 328 </p></li> 329<li><p><code class="filename">aaa</code> is the numeric representation 330 of the algorithm. 331 </p></li> 332<li><p><code class="filename">iiiii</code> is the key identifier (or 333 footprint). 334 </p></li> 335</ul></div> 336<p><span><strong class="command">dnssec-keyfromlabel</strong></span> 337 creates two files, with names based 338 on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code> 339 contains the public key, and 340 <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the 341 private key. 342 </p> 343<p> 344 The <code class="filename">.key</code> file contains a DNS KEY record 345 that 346 can be inserted into a zone file (directly or with a $INCLUDE 347 statement). 348 </p> 349<p> 350 The <code class="filename">.private</code> file contains 351 algorithm-specific 352 fields. For obvious security reasons, this file does not have 353 general read permission. 354 </p> 355</div> 356<div class="refsect1" lang="en"> 357<a name="id2672545"></a><h2>SEE ALSO</h2> 358<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, 359 <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, 360 <em class="citetitle">BIND 9 Administrator Reference Manual</em>, 361 <em class="citetitle">RFC 4034</em>, 362 <em class="citetitle">The PKCS#11 URI Scheme (draft-pechanec-pkcs11uri-13)</em>. 363 </p> 364</div> 365<div class="refsect1" lang="en"> 366<a name="id2672582"></a><h2>AUTHOR</h2> 367<p><span class="corpauthor">Internet Systems Consortium</span> 368 </p> 369</div> 370</div> 371<div class="navfooter"> 372<hr> 373<table width="100%" summary="Navigation footer"> 374<tr> 375<td width="40%" align="left"> 376<a accesskey="p" href="man.dnssec-importkey.html">Prev</a>�</td> 377<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td> 378<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a> 379</td> 380</tr> 381<tr> 382<td width="40%" align="left" valign="top"> 383<span class="application">dnssec-importkey</span>�</td> 384<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td> 385<td width="40%" align="right" valign="top">�<span class="application">dnssec-keygen</span> 386</td> 387</tr> 388</table> 389</div> 390<p style="text-align: center;">BIND 9.10.2-P4</p> 391</body> 392</html> 393