external/bsd/bind/dist/bin/dnssec/dnssec-keyfromlabel.html

   1 <!--
   2  - Copyright (C) 2008-2012, 2014 Internet Systems Consortium, Inc. ("ISC")
   3  -
   4  - Permission to use, copy, modify, and/or distribute this software for any
   5  - purpose with or without fee is hereby granted, provided that the above
   6  - copyright notice and this permission notice appear in all copies.
   7  -
   8  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14  - PERFORMANCE OF THIS SOFTWARE.
  15 -->
  16 <!-- Id -->
  17 <html>
  18 <head>
  19 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  20 <title>dnssec-keyfromlabel</title>
  21 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  22 </head>
  23 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
  24 <a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
  25 <div class="refnamediv">
  26 <h2>Name</h2>
  27 <p><span class="application">dnssec-keyfromlabel</span> &#8212; DNSSEC key generation tool</p>
  28 </div>
  29 <div class="refsynopsisdiv">
  30 <h2>Synopsis</h2>
  31 <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>
  32 </div>
  33 <div class="refsect1" lang="en">
  34 <a name="id2543539"></a><h2>DESCRIPTION</h2>
  35 <p><span><strong class="command">dnssec-keyfromlabel</strong></span>
  36       generates a key pair of files that referencing a key object stored
  37       in a cryptographic hardware service module (HSM).  The private key
  38       file can be used for DNSSEC signing of zone data as if it were a
  39       conventional signing key created by <span><strong class="command">dnssec-keygen</strong></span>,
  40       but the key material is stored within the HSM, and the actual signing
  41       takes place there.
  42     </p>
  43 <p>
  44       The <code class="option">name</code> of the key is specified on the command
  45       line.  This must match the name of the zone for which the key is
  46       being generated.
  47     </p>
  48 </div>
  49 <div class="refsect1" lang="en">
  50 <a name="id2543560"></a><h2>OPTIONS</h2>
  51 <div class="variablelist"><dl>
  52 <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
  53 <dd>
  54 <p>
  55             Selects the cryptographic algorithm.  The value of
  56             <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
  57             DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
  58             ECDSAP256SHA256 or ECDSAP384SHA384.
  59             These values are case insensitive.
  60           </p>
  61 <p>
  62             If no algorithm is specified, then RSASHA1 will be used by
  63             default, unless the <code class="option">-3</code> option is specified,
  64             in which case NSEC3RSASHA1 will be used instead.  (If
  65             <code class="option">-3</code> is used and an algorithm is specified,
  66             that algorithm will be checked for compatibility with NSEC3.)
  67           </p>
  68 <p>
  69             Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
  70             algorithm, and DSA is recommended.
  71           </p>
  72 <p>
  73             Note 2: DH automatically sets the -k flag.
  74           </p>
  75 </dd>
  76 <dt><span class="term">-3</span></dt>
  77 <dd><p>
  78             Use an NSEC3-capable algorithm to generate a DNSSEC key.
  79             If this option is used and no algorithm is explicitly
  80             set on the command line, NSEC3RSASHA1 will be used by
  81             default.
  82           </p></dd>
  83 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
  84 <dd>
  85 <p>
  86             Specifies the cryptographic hardware to use.
  87           </p>
  88 <p>
  89             When BIND is built with OpenSSL PKCS#11 support, this defaults
  90             to the string "pkcs11", which identifies an OpenSSL engine
  91             that can drive a cryptographic accelerator or hardware service
  92             module.  When BIND is built with native PKCS#11 cryptography
  93             (--enable-native-pkcs11), it defaults to the path of the PKCS#11
  94             provider library specified via "--with-pkcs11".
  95           </p>
  96 </dd>
  97 <dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
  98 <dd>
  99 <p>
 100             Specifies the label for a key pair in the crypto hardware.
 101           </p>
 102 <p>
 103             When <acronym class="acronym">BIND</acronym> 9 is built with OpenSSL-based
 104             PKCS#11 support, the label is an arbitrary string that
 105             identifies a particular key.  It may be preceded by an
 106             optional OpenSSL engine name, followed by a colon, as in
 107             "pkcs11:<em class="replaceable"><code>keylabel</code></em>".
 108           </p>
 109 <p>
 110             When <acronym class="acronym">BIND</acronym> 9 is built with native PKCS#11
 111             support, the label is a PKCS#11 URI string in the format
 112             "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>]"
 113             Keywords include "token", which identifies the HSM; "object", which
 114             identifies the key; and "pin-source", which identifies a file from
 115             which the HSM's PIN code can be obtained.  The label will be
 116             stored in the on-disk "private" file.
 117           </p>
 118 <p>
 119             If the label contains a
 120             <code class="option">pin-source</code> field, tools using the generated
 121             key files will be able to use the HSM for signing and other
 122             operations without any need for an operator to manually enter
 123             a PIN.  Note: Making the HSM's PIN accessible in this manner
 124             may reduce the security advantage of using an HSM; be sure
 125             this is what you want to do before making use of this feature.
 126           </p>
 127 </dd>
 128 <dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
 129 <dd><p>
 130             Specifies the owner type of the key.  The value of
 131             <code class="option">nametype</code> must either be ZONE (for a DNSSEC
 132             zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
 133             a host (KEY)),
 134             USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
 135             These values are case insensitive.
 136           </p></dd>
 137 <dt><span class="term">-C</span></dt>
 138 <dd><p>
 139             Compatibility mode:  generates an old-style key, without
 140             any metadata.  By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
 141             will include the key's creation date in the metadata stored
 142             with the private key, and other dates may be set there as well
 143             (publication date, activation date, etc).  Keys that include
 144             this data may be incompatible with older versions of BIND; the
 145             <code class="option">-C</code> option suppresses them.
 146           </p></dd>
 147 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
 148 <dd><p>
 149             Indicates that the DNS record containing the key should have
 150             the specified class.  If not specified, class IN is used.
 151           </p></dd>
 152 <dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
 153 <dd><p>
 154             Set the specified flag in the flag field of the KEY/DNSKEY record.
 155             The only recognized flags are KSK (Key Signing Key) and REVOKE.
 156           </p></dd>
 157 <dt><span class="term">-G</span></dt>
 158 <dd><p>
 159             Generate a key, but do not publish it or sign with it.  This
 160             option is incompatible with -P and -A.
 161           </p></dd>
 162 <dt><span class="term">-h</span></dt>
 163 <dd><p>
 164             Prints a short summary of the options and arguments to
 165             <span><strong class="command">dnssec-keyfromlabel</strong></span>.
 166           </p></dd>
 167 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
 168 <dd><p>
 169             Sets the directory in which the key files are to be written.
 170           </p></dd>
 171 <dt><span class="term">-k</span></dt>
 172 <dd><p>
 173             Generate KEY records rather than DNSKEY records.
 174           </p></dd>
 175 <dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
 176 <dd><p>
 177             Sets the default TTL to use for this key when it is converted
 178             into a DNSKEY RR.  If the key is imported into a zone,
 179             this is the TTL that will be used for it, unless there was
 180             already a DNSKEY RRset in place, in which case the existing TTL
 181             would take precedence.  Setting the default TTL to
 182             <code class="literal">0</code> or <code class="literal">none</code> removes it.
 183           </p></dd>
 184 <dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
 185 <dd><p>
 186             Sets the protocol value for the key.  The protocol
 187             is a number between 0 and 255.  The default is 3 (DNSSEC).
 188             Other possible values for this argument are listed in
 189             RFC 2535 and its successors.
 190           </p></dd>
 191 <dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
 192 <dd><p>
 193             Generate a key as an explicit successor to an existing key.
 194             The name, algorithm, size, and type of the key will be set
 195             to match the predecessor. The activation date of the new
 196             key will be set to the inactivation date of the existing
 197             one. The publication date will be set to the activation
 198             date minus the prepublication interval, which defaults to
 199             30 days.
 200           </p></dd>
 201 <dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
 202 <dd><p>
 203             Indicates the use of the key.  <code class="option">type</code> must be
 204             one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF.  The default
 205             is AUTHCONF.  AUTH refers to the ability to authenticate
 206             data, and CONF the ability to encrypt data.
 207           </p></dd>
 208 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 209 <dd><p>
 210             Sets the debugging level.
 211           </p></dd>
 212 <dt><span class="term">-V</span></dt>
 213 <dd><p>
 214             Prints version information.
 215           </p></dd>
 216 <dt><span class="term">-y</span></dt>
 217 <dd><p>
 218             Allows DNSSEC key files to be generated even if the key ID
 219             would collide with that of an existing key, in the event of
 220             either key being revoked.  (This is only safe to use if you
 221             are sure you won't be using RFC 5011 trust anchor maintenance
 222             with either of the keys involved.)
 223           </p></dd>
 224 </dl></div>
 225 </div>
 226 <div class="refsect1" lang="en">
 227 <a name="id2544020"></a><h2>TIMING OPTIONS</h2>
 228 <p>
 229       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 230       If the argument begins with a '+' or '-', it is interpreted as
 231       an offset from the present time.  For convenience, if such an offset
 232       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 233       then the offset is computed in years (defined as 365 24-hour days,
 234       ignoring leap years), months (defined as 30 24-hour days), weeks,
 235       days, hours, or minutes, respectively.  Without a suffix, the offset
 236       is computed in seconds.  To explicitly prevent a date from being
 237       set, use 'none' or 'never'.
 238     </p>
 239 <div class="variablelist"><dl>
 240 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 241 <dd><p>
 242             Sets the date on which a key is to be published to the zone.
 243             After that date, the key will be included in the zone but will
 244             not be used to sign it.  If not set, and if the -G option has
 245             not been used, the default is "now".
 246           </p></dd>
 247 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
 248 <dd><p>
 249             Sets the date on which the key is to be activated.  After that
 250             date, the key will be included in the zone and used to sign
 251             it.  If not set, and if the -G option has not been used, the
 252             default is "now".
 253           </p></dd>
 254 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
 255 <dd><p>
 256             Sets the date on which the key is to be revoked.  After that
 257             date, the key will be flagged as revoked.  It will be included
 258             in the zone and will be used to sign it.
 259           </p></dd>
 260 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
 261 <dd><p>
 262             Sets the date on which the key is to be retired.  After that
 263             date, the key will still be included in the zone, but it
 264             will not be used to sign it.
 265           </p></dd>
 266 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 267 <dd><p>
 268             Sets the date on which the key is to be deleted.  After that
 269             date, the key will no longer be included in the zone.  (It
 270             may remain in the key repository, however.)
 271           </p></dd>
 272 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
 273 <dd>
 274 <p>
 275             Sets the prepublication interval for a key.  If set, then
 276             the publication and activation dates must be separated by at least
 277             this much time.  If the activation date is specified but the
 278             publication date isn't, then the publication date will default
 279             to this much time before the activation date; conversely, if
 280             the publication date is specified but activation date isn't,
 281             then activation will be set to this much time after publication.
 282           </p>
 283 <p>
 284             If the key is being created as an explicit successor to another
 285             key, then the default prepublication interval is 30 days;
 286             otherwise it is zero.
 287           </p>
 288 <p>
 289             As with date offsets, if the argument is followed by one of
 290             the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
 291             interval is measured in years, months, weeks, days, hours,
 292             or minutes, respectively.  Without a suffix, the interval is
 293             measured in seconds.
 294           </p>
 295 </dd>
 296 </dl></div>
 297 </div>
 298 <div class="refsect1" lang="en">
 299 <a name="id2544278"></a><h2>GENERATED KEY FILES</h2>
 300 <p>
 301       When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
 302       successfully,
 303       it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
 304       to the standard output.  This is an identification string for
 305       the key files it has generated.
 306     </p>
 307 <div class="itemizedlist"><ul type="disc">
 308 <li><p><code class="filename">nnnn</code> is the key name.
 309         </p></li>
 310 <li><p><code class="filename">aaa</code> is the numeric representation
 311           of the algorithm.
 312         </p></li>
 313 <li><p><code class="filename">iiiii</code> is the key identifier (or
 314           footprint).
 315         </p></li>
 316 </ul></div>
 317 <p><span><strong class="command">dnssec-keyfromlabel</strong></span>
 318       creates two files, with names based
 319       on the printed string.  <code class="filename">Knnnn.+aaa+iiiii.key</code>
 320       contains the public key, and
 321       <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
 322       private key.
 323     </p>
 324 <p>
 325       The <code class="filename">.key</code> file contains a DNS KEY record
 326       that
 327       can be inserted into a zone file (directly or with a $INCLUDE
 328       statement).
 329     </p>
 330 <p>
 331       The <code class="filename">.private</code> file contains
 332       algorithm-specific
 333       fields.  For obvious security reasons, this file does not have
 334       general read permission.
 335     </p>
 336 </div>
 337 <div class="refsect1" lang="en">
 338 <a name="id2544350"></a><h2>SEE ALSO</h2>
 339 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 340       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 341       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 342       <em class="citetitle">RFC 4034</em>,
 343       <em class="citetitle">The PKCS#11 URI Scheme (draft-pechanec-pkcs11uri-13)</em>.
 344     </p>
 345 </div>
 346 <div class="refsect1" lang="en">
 347 <a name="id2544388"></a><h2>AUTHOR</h2>
 348 <p><span class="corpauthor">Internet Systems Consortium</span>
 349     </p>
 350 </div>
 351 </div></body>
 352 </html>