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 <!-- $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.ch13.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> &#8212; 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="id2617876"></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="id2617901"></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><p>
 104             Specifies the name of the crypto hardware (OpenSSL engine).
 105             When compiled with PKCS#11 support it defaults to "pkcs11".
 106           </p></dd>
 107 <dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
 108 <dd><p>
 109             Specifies the label of the key pair in the crypto hardware.
 110             The label may be preceded by an optional OpenSSL engine name,
 111             separated by a colon, as in "pkcs11:keylabel".
 112           </p></dd>
 113 <dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
 114 <dd><p>
 115             Specifies the owner type of the key.  The value of
 116             <code class="option">nametype</code> must either be ZONE (for a DNSSEC
 117             zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
 118             a host (KEY)),
 119             USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
 120             These values are case insensitive.
 121           </p></dd>
 122 <dt><span class="term">-C</span></dt>
 123 <dd><p>
 124             Compatibility mode:  generates an old-style key, without
 125             any metadata.  By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
 126             will include the key's creation date in the metadata stored
 127             with the private key, and other dates may be set there as well
 128             (publication date, activation date, etc).  Keys that include
 129             this data may be incompatible with older versions of BIND; the
 130             <code class="option">-C</code> option suppresses them.
 131           </p></dd>
 132 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
 133 <dd><p>
 134             Indicates that the DNS record containing the key should have
 135             the specified class.  If not specified, class IN is used.
 136           </p></dd>
 137 <dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
 138 <dd><p>
 139             Set the specified flag in the flag field of the KEY/DNSKEY record.
 140             The only recognized flags are KSK (Key Signing Key) and REVOKE.
 141           </p></dd>
 142 <dt><span class="term">-G</span></dt>
 143 <dd><p>
 144             Generate a key, but do not publish it or sign with it.  This
 145             option is incompatible with -P and -A.
 146           </p></dd>
 147 <dt><span class="term">-h</span></dt>
 148 <dd><p>
 149             Prints a short summary of the options and arguments to
 150             <span><strong class="command">dnssec-keyfromlabel</strong></span>.
 151           </p></dd>
 152 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
 153 <dd><p>
 154             Sets the directory in which the key files are to be written.
 155           </p></dd>
 156 <dt><span class="term">-k</span></dt>
 157 <dd><p>
 158             Generate KEY records rather than DNSKEY records.
 159           </p></dd>
 160 <dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
 161 <dd><p>
 162             Sets the default TTL to use for this key when it is converted
 163             into a DNSKEY RR.  If the key is imported into a zone,
 164             this is the TTL that will be used for it, unless there was
 165             already a DNSKEY RRset in place, in which case the existing TTL
 166             would take precedence.  Setting the default TTL to
 167             <code class="literal">0</code> or <code class="literal">none</code> removes it.
 168           </p></dd>
 169 <dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
 170 <dd><p>
 171             Sets the protocol value for the key.  The protocol
 172             is a number between 0 and 255.  The default is 3 (DNSSEC).
 173             Other possible values for this argument are listed in
 174             RFC 2535 and its successors.
 175           </p></dd>
 176 <dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
 177 <dd><p>
 178             Generate a key as an explicit successor to an existing key.
 179             The name, algorithm, size, and type of the key will be set
 180             to match the predecessor. The activation date of the new
 181             key will be set to the inactivation date of the existing
 182             one. The publication date will be set to the activation
 183             date minus the prepublication interval, which defaults to
 184             30 days.
 185           </p></dd>
 186 <dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
 187 <dd><p>
 188             Indicates the use of the key.  <code class="option">type</code> must be
 189             one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF.  The default
 190             is AUTHCONF.  AUTH refers to the ability to authenticate
 191             data, and CONF the ability to encrypt data.
 192           </p></dd>
 193 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
 194 <dd><p>
 195             Sets the debugging level.
 196           </p></dd>
 197 <dt><span class="term">-V</span></dt>
 198 <dd><p>
 199             Prints version information.
 200           </p></dd>
 201 <dt><span class="term">-y</span></dt>
 202 <dd><p>
 203             Allows DNSSEC key files to be generated even if the key ID
 204             would collide with that of an existing key, in the event of
 205             either key being revoked.  (This is only safe to use if you
 206             are sure you won't be using RFC 5011 trust anchor maintenance
 207             with either of the keys involved.)
 208           </p></dd>
 209 </dl></div>
 210 </div>
 211 <div class="refsect1" lang="en">
 212 <a name="id2620171"></a><h2>TIMING OPTIONS</h2>
 213 <p>
 214       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 215       If the argument begins with a '+' or '-', it is interpreted as
 216       an offset from the present time.  For convenience, if such an offset
 217       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 218       then the offset is computed in years (defined as 365 24-hour days,
 219       ignoring leap years), months (defined as 30 24-hour days), weeks,
 220       days, hours, or minutes, respectively.  Without a suffix, the offset
 221       is computed in seconds.  To explicitly prevent a date from being
 222       set, use 'none' or 'never'.
 223     </p>
 224 <div class="variablelist"><dl>
 225 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
 226 <dd><p>
 227             Sets the date on which a key is to be published to the zone.
 228             After that date, the key will be included in the zone but will
 229             not be used to sign it.  If not set, and if the -G option has
 230             not been used, the default is "now".
 231           </p></dd>
 232 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
 233 <dd><p>
 234             Sets the date on which the key is to be activated.  After that
 235             date, the key will be included in the zone and used to sign
 236             it.  If not set, and if the -G option has not been used, the
 237             default is "now".
 238           </p></dd>
 239 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
 240 <dd><p>
 241             Sets the date on which the key is to be revoked.  After that
 242             date, the key will be flagged as revoked.  It will be included
 243             in the zone and will be used to sign it.
 244           </p></dd>
 245 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
 246 <dd><p>
 247             Sets the date on which the key is to be retired.  After that
 248             date, the key will still be included in the zone, but it
 249             will not be used to sign it.
 250           </p></dd>
 251 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
 252 <dd><p>
 253             Sets the date on which the key is to be deleted.  After that
 254             date, the key will no longer be included in the zone.  (It
 255             may remain in the key repository, however.)
 256           </p></dd>
 257 <dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
 258 <dd>
 259 <p>
 260             Sets the prepublication interval for a key.  If set, then
 261             the publication and activation dates must be separated by at least
 262             this much time.  If the activation date is specified but the
 263             publication date isn't, then the publication date will default
 264             to this much time before the activation date; conversely, if
 265             the publication date is specified but activation date isn't,
 266             then activation will be set to this much time after publication.
 267           </p>
 268 <p>
 269             If the key is being created as an explicit successor to another
 270             key, then the default prepublication interval is 30 days;
 271             otherwise it is zero.
 272           </p>
 273 <p>
 274             As with date offsets, if the argument is followed by one of
 275             the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
 276             interval is measured in years, months, weeks, days, hours,
 277             or minutes, respectively.  Without a suffix, the interval is
 278             measured in seconds.
 279           </p>
 280 </dd>
 281 </dl></div>
 282 </div>
 283 <div class="refsect1" lang="en">
 284 <a name="id2671220"></a><h2>GENERATED KEY FILES</h2>
 285 <p>
 286       When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
 287       successfully,
 288       it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
 289       to the standard output.  This is an identification string for
 290       the key files it has generated.
 291     </p>
 292 <div class="itemizedlist"><ul type="disc">
 293 <li><p><code class="filename">nnnn</code> is the key name.
 294         </p></li>
 295 <li><p><code class="filename">aaa</code> is the numeric representation
 296           of the algorithm.
 297         </p></li>
 298 <li><p><code class="filename">iiiii</code> is the key identifier (or
 299           footprint).
 300         </p></li>
 301 </ul></div>
 302 <p><span><strong class="command">dnssec-keyfromlabel</strong></span>
 303       creates two files, with names based
 304       on the printed string.  <code class="filename">Knnnn.+aaa+iiiii.key</code>
 305       contains the public key, and
 306       <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
 307       private key.
 308     </p>
 309 <p>
 310       The <code class="filename">.key</code> file contains a DNS KEY record
 311       that
 312       can be inserted into a zone file (directly or with a $INCLUDE
 313       statement).
 314     </p>
 315 <p>
 316       The <code class="filename">.private</code> file contains
 317       algorithm-specific
 318       fields.  For obvious security reasons, this file does not have
 319       general read permission.
 320     </p>
 321 </div>
 322 <div class="refsect1" lang="en">
 323 <a name="id2671314"></a><h2>SEE ALSO</h2>
 324 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 325       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 326       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 327       <em class="citetitle">RFC 4034</em>.
 328     </p>
 329 </div>
 330 <div class="refsect1" lang="en">
 331 <a name="id2671347"></a><h2>AUTHOR</h2>
 332 <p><span class="corpauthor">Internet Systems Consortium</span>
 333     </p>
 334 </div>
 335 </div>
 336 <div class="navfooter">
 337 <hr>
 338 <table width="100%" summary="Navigation footer">
 339 <tr>
 340 <td width="40%" align="left">
 341 <a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a> </td>
 342 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
 343 <td width="40%" align="right"> <a accesskey="n" href="man.dnssec-keygen.html">Next</a>
 344 </td>
 345 </tr>
 346 <tr>
 347 <td width="40%" align="left" valign="top">
 348 <span class="application">dnssec-dsfromkey</span> </td>
 349 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 350 <td width="40%" align="right" valign="top"> <span class="application">dnssec-keygen</span>
 351 </td>
 352 </tr>
 353 </table>
 354 </div>
 355 <p style="text-align: center;">BIND 9.9.8 (Extended Support Version)</p>
 356 </body>
 357 </html>