contrib/bind9/doc/arm/man.dnssec-keyfromlabel.html

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