1193141Sdougb<!-- 2245163Serwin - Copyright (C) 2008-2012 Internet Systems Consortium, Inc. ("ISC") 3193141Sdougb - 4204619Sdougb - Permission to use, copy, modify, and/or distribute this software for any 5193141Sdougb - purpose with or without fee is hereby granted, provided that the above 6193141Sdougb - copyright notice and this permission notice appear in all copies. 7193141Sdougb - 8193141Sdougb - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 9193141Sdougb - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 10193141Sdougb - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 11193141Sdougb - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 12193141Sdougb - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 13193141Sdougb - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 14193141Sdougb - PERFORMANCE OF THIS SOFTWARE. 15193141Sdougb--> 16234010Sdougb<!-- $Id$ --> 17193141Sdougb<html> 18193141Sdougb<head> 19193141Sdougb<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 20193141Sdougb<title>dnssec-keyfromlabel</title> 21193141Sdougb<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> 22193141Sdougb</head> 23193141Sdougb<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> 24193141Sdougb<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div> 25193141Sdougb<div class="refnamediv"> 26193141Sdougb<h2>Name</h2> 27193141Sdougb<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p> 28193141Sdougb</div> 29193141Sdougb<div class="refsynopsisdiv"> 30193141Sdougb<h2>Synopsis</h2> 31254897Serwin<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">-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">-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> 32193141Sdougb</div> 33193141Sdougb<div class="refsect1" lang="en"> 34254897Serwin<a name="id2543507"></a><h2>DESCRIPTION</h2> 35193141Sdougb<p><span><strong class="command">dnssec-keyfromlabel</strong></span> 36193141Sdougb gets keys with the given label from a crypto hardware and builds 37193141Sdougb key files for DNSSEC (Secure DNS), as defined in RFC 2535 38193141Sdougb and RFC 4034. 39193141Sdougb </p> 40224092Sdougb<p> 41224092Sdougb The <code class="option">name</code> of the key is specified on the command 42224092Sdougb line. This must match the name of the zone for which the key is 43224092Sdougb being generated. 44224092Sdougb </p> 45193141Sdougb</div> 46193141Sdougb<div class="refsect1" lang="en"> 47254897Serwin<a name="id2543525"></a><h2>OPTIONS</h2> 48193141Sdougb<div class="variablelist"><dl> 49193141Sdougb<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt> 50193141Sdougb<dd> 51193141Sdougb<p> 52193141Sdougb Selects the cryptographic algorithm. The value of 53224092Sdougb <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1, 54245163Serwin DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, 55245163Serwin ECDSAP256SHA256 or ECDSAP384SHA384. 56193141Sdougb These values are case insensitive. 57193141Sdougb </p> 58193141Sdougb<p> 59204619Sdougb If no algorithm is specified, then RSASHA1 will be used by 60204619Sdougb default, unless the <code class="option">-3</code> option is specified, 61204619Sdougb in which case NSEC3RSASHA1 will be used instead. (If 62204619Sdougb <code class="option">-3</code> is used and an algorithm is specified, 63204619Sdougb that algorithm will be checked for compatibility with NSEC3.) 64204619Sdougb </p> 65204619Sdougb<p> 66193141Sdougb Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement 67193141Sdougb algorithm, and DSA is recommended. 68193141Sdougb </p> 69193141Sdougb<p> 70193141Sdougb Note 2: DH automatically sets the -k flag. 71193141Sdougb </p> 72193141Sdougb</dd> 73224092Sdougb<dt><span class="term">-3</span></dt> 74224092Sdougb<dd><p> 75224092Sdougb Use an NSEC3-capable algorithm to generate a DNSSEC key. 76224092Sdougb If this option is used and no algorithm is explicitly 77224092Sdougb set on the command line, NSEC3RSASHA1 will be used by 78224092Sdougb default. 79224092Sdougb </p></dd> 80224092Sdougb<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt> 81224092Sdougb<dd><p> 82224092Sdougb Specifies the name of the crypto hardware (OpenSSL engine). 83224092Sdougb When compiled with PKCS#11 support it defaults to "pkcs11". 84224092Sdougb </p></dd> 85193141Sdougb<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt> 86193141Sdougb<dd><p> 87224092Sdougb Specifies the label of the key pair in the crypto hardware. 88224092Sdougb The label may be preceded by an optional OpenSSL engine name, 89224092Sdougb separated by a colon, as in "pkcs11:keylabel". 90193141Sdougb </p></dd> 91193141Sdougb<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt> 92193141Sdougb<dd><p> 93193141Sdougb Specifies the owner type of the key. The value of 94193141Sdougb <code class="option">nametype</code> must either be ZONE (for a DNSSEC 95193141Sdougb zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with 96193141Sdougb a host (KEY)), 97193141Sdougb USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). 98224092Sdougb These values are case insensitive. 99193141Sdougb </p></dd> 100224092Sdougb<dt><span class="term">-C</span></dt> 101224092Sdougb<dd><p> 102224092Sdougb Compatibility mode: generates an old-style key, without 103224092Sdougb any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span> 104224092Sdougb will include the key's creation date in the metadata stored 105224092Sdougb with the private key, and other dates may be set there as well 106224092Sdougb (publication date, activation date, etc). Keys that include 107224092Sdougb this data may be incompatible with older versions of BIND; the 108224092Sdougb <code class="option">-C</code> option suppresses them. 109224092Sdougb </p></dd> 110193141Sdougb<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt> 111193141Sdougb<dd><p> 112193141Sdougb Indicates that the DNS record containing the key should have 113193141Sdougb the specified class. If not specified, class IN is used. 114193141Sdougb </p></dd> 115193141Sdougb<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt> 116193141Sdougb<dd><p> 117193141Sdougb Set the specified flag in the flag field of the KEY/DNSKEY record. 118224092Sdougb The only recognized flags are KSK (Key Signing Key) and REVOKE. 119193141Sdougb </p></dd> 120224092Sdougb<dt><span class="term">-G</span></dt> 121224092Sdougb<dd><p> 122224092Sdougb Generate a key, but do not publish it or sign with it. This 123224092Sdougb option is incompatible with -P and -A. 124224092Sdougb </p></dd> 125193141Sdougb<dt><span class="term">-h</span></dt> 126193141Sdougb<dd><p> 127193141Sdougb Prints a short summary of the options and arguments to 128224092Sdougb <span><strong class="command">dnssec-keyfromlabel</strong></span>. 129193141Sdougb </p></dd> 130224092Sdougb<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt> 131224092Sdougb<dd><p> 132224092Sdougb Sets the directory in which the key files are to be written. 133224092Sdougb </p></dd> 134193141Sdougb<dt><span class="term">-k</span></dt> 135193141Sdougb<dd><p> 136193141Sdougb Generate KEY records rather than DNSKEY records. 137193141Sdougb </p></dd> 138254897Serwin<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt> 139254897Serwin<dd><p> 140254897Serwin Sets the default TTL to use for this key when it is converted 141254897Serwin into a DNSKEY RR. If the key is imported into a zone, 142254897Serwin this is the TTL that will be used for it, unless there was 143254897Serwin already a DNSKEY RRset in place, in which case the existing TTL 144254897Serwin would take precedence. Setting the default TTL to 145254897Serwin <code class="literal">0</code> or <code class="literal">none</code> removes it. 146254897Serwin </p></dd> 147193141Sdougb<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt> 148193141Sdougb<dd><p> 149224092Sdougb Sets the protocol value for the key. The protocol 150193141Sdougb is a number between 0 and 255. The default is 3 (DNSSEC). 151193141Sdougb Other possible values for this argument are listed in 152193141Sdougb RFC 2535 and its successors. 153193141Sdougb </p></dd> 154193141Sdougb<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt> 155193141Sdougb<dd><p> 156193141Sdougb Indicates the use of the key. <code class="option">type</code> must be 157193141Sdougb one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default 158193141Sdougb is AUTHCONF. AUTH refers to the ability to authenticate 159193141Sdougb data, and CONF the ability to encrypt data. 160193141Sdougb </p></dd> 161193141Sdougb<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt> 162193141Sdougb<dd><p> 163193141Sdougb Sets the debugging level. 164193141Sdougb </p></dd> 165224092Sdougb<dt><span class="term">-y</span></dt> 166224092Sdougb<dd><p> 167224092Sdougb Allows DNSSEC key files to be generated even if the key ID 168224092Sdougb would collide with that of an existing key, in the event of 169224092Sdougb either key being revoked. (This is only safe to use if you 170224092Sdougb are sure you won't be using RFC 5011 trust anchor maintenance 171224092Sdougb with either of the keys involved.) 172224092Sdougb </p></dd> 173193141Sdougb</dl></div> 174193141Sdougb</div> 175193141Sdougb<div class="refsect1" lang="en"> 176254897Serwin<a name="id2543980"></a><h2>TIMING OPTIONS</h2> 177193141Sdougb<p> 178224092Sdougb Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. 179224092Sdougb If the argument begins with a '+' or '-', it is interpreted as 180224092Sdougb an offset from the present time. For convenience, if such an offset 181224092Sdougb is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', 182224092Sdougb then the offset is computed in years (defined as 365 24-hour days, 183224092Sdougb ignoring leap years), months (defined as 30 24-hour days), weeks, 184224092Sdougb days, hours, or minutes, respectively. Without a suffix, the offset 185224092Sdougb is computed in seconds. 186224092Sdougb </p> 187224092Sdougb<div class="variablelist"><dl> 188224092Sdougb<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt> 189224092Sdougb<dd><p> 190224092Sdougb Sets the date on which a key is to be published to the zone. 191224092Sdougb After that date, the key will be included in the zone but will 192224092Sdougb not be used to sign it. If not set, and if the -G option has 193224092Sdougb not been used, the default is "now". 194224092Sdougb </p></dd> 195224092Sdougb<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt> 196224092Sdougb<dd><p> 197224092Sdougb Sets the date on which the key is to be activated. After that 198224092Sdougb date, the key will be included in the zone and used to sign 199224092Sdougb it. If not set, and if the -G option has not been used, the 200224092Sdougb default is "now". 201224092Sdougb </p></dd> 202224092Sdougb<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt> 203224092Sdougb<dd><p> 204224092Sdougb Sets the date on which the key is to be revoked. After that 205224092Sdougb date, the key will be flagged as revoked. It will be included 206224092Sdougb in the zone and will be used to sign it. 207224092Sdougb </p></dd> 208224092Sdougb<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt> 209224092Sdougb<dd><p> 210224092Sdougb Sets the date on which the key is to be retired. After that 211224092Sdougb date, the key will still be included in the zone, but it 212224092Sdougb will not be used to sign it. 213224092Sdougb </p></dd> 214224092Sdougb<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt> 215224092Sdougb<dd><p> 216224092Sdougb Sets the date on which the key is to be deleted. After that 217224092Sdougb date, the key will no longer be included in the zone. (It 218224092Sdougb may remain in the key repository, however.) 219224092Sdougb </p></dd> 220224092Sdougb</dl></div> 221224092Sdougb</div> 222224092Sdougb<div class="refsect1" lang="en"> 223254897Serwin<a name="id2543054"></a><h2>GENERATED KEY FILES</h2> 224224092Sdougb<p> 225193141Sdougb When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes 226193141Sdougb successfully, 227193141Sdougb it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code> 228193141Sdougb to the standard output. This is an identification string for 229193141Sdougb the key files it has generated. 230193141Sdougb </p> 231193141Sdougb<div class="itemizedlist"><ul type="disc"> 232193141Sdougb<li><p><code class="filename">nnnn</code> is the key name. 233193141Sdougb </p></li> 234193141Sdougb<li><p><code class="filename">aaa</code> is the numeric representation 235224092Sdougb of the algorithm. 236193141Sdougb </p></li> 237193141Sdougb<li><p><code class="filename">iiiii</code> is the key identifier (or 238193141Sdougb footprint). 239193141Sdougb </p></li> 240193141Sdougb</ul></div> 241193141Sdougb<p><span><strong class="command">dnssec-keyfromlabel</strong></span> 242193141Sdougb creates two files, with names based 243193141Sdougb on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code> 244193141Sdougb contains the public key, and 245193141Sdougb <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the 246224092Sdougb private key. 247193141Sdougb </p> 248193141Sdougb<p> 249193141Sdougb The <code class="filename">.key</code> file contains a DNS KEY record 250193141Sdougb that 251193141Sdougb can be inserted into a zone file (directly or with a $INCLUDE 252193141Sdougb statement). 253193141Sdougb </p> 254193141Sdougb<p> 255224092Sdougb The <code class="filename">.private</code> file contains 256224092Sdougb algorithm-specific 257193141Sdougb fields. For obvious security reasons, this file does not have 258193141Sdougb general read permission. 259193141Sdougb </p> 260193141Sdougb</div> 261193141Sdougb<div class="refsect1" lang="en"> 262254897Serwin<a name="id2543127"></a><h2>SEE ALSO</h2> 263193141Sdougb<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, 264193141Sdougb <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, 265193141Sdougb <em class="citetitle">BIND 9 Administrator Reference Manual</em>, 266204619Sdougb <em class="citetitle">RFC 4034</em>. 267193141Sdougb </p> 268193141Sdougb</div> 269193141Sdougb<div class="refsect1" lang="en"> 270254897Serwin<a name="id2543160"></a><h2>AUTHOR</h2> 271193141Sdougb<p><span class="corpauthor">Internet Systems Consortium</span> 272193141Sdougb </p> 273193141Sdougb</div> 274193141Sdougb</div></body> 275193141Sdougb</html> 276