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

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2008, 2009  Internet Systems Consortium, Inc. ("ISC")
   6  -
   7  - Permission to use, copy, modify, and/or distribute this software for any
   8  - purpose with or without fee is hereby granted, provided that the above
   9  - copyright notice and this permission notice appear in all copies.
  10  -
  11  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  12  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  13  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  14  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  15  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  16  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17  - PERFORMANCE OF THIS SOFTWARE.
  18 -->
  19
  20 <!-- Id: dnssec-keyfromlabel.docbook,v 1.15 2009/11/03 21:44:46 each Exp -->
  21 <refentry id="man.dnssec-keyfromlabel">
  22   <refentryinfo>
  23     <date>February 8, 2008</date>
  24   </refentryinfo>
  25
  26   <refmeta>
  27     <refentrytitle><application>dnssec-keyfromlabel</application></refentrytitle>
  28     <manvolnum>8</manvolnum>
  29     <refmiscinfo>BIND9</refmiscinfo>
  30   </refmeta>
  31
  32   <refnamediv>
  33     <refname><application>dnssec-keyfromlabel</application></refname>
  34     <refpurpose>DNSSEC key generation tool</refpurpose>
  35   </refnamediv>
  36
  37   <docinfo>
  38     <copyright>
  39       <year>2008</year>
  40       <year>2009</year>
  41       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  42     </copyright>
  43   </docinfo>
  44
  45   <refsynopsisdiv>
  46     <cmdsynopsis>
  47       <command>dnssec-keyfromlabel</command>
  48       <arg choice="req">-l <replaceable class="parameter">label</replaceable></arg>
  49       <arg><option>-3</option></arg>
  50       <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
  51       <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
  52       <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
  53       <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
  54       <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
  55       <arg><option>-f <replaceable class="parameter">flag</replaceable></option></arg>
  56       <arg><option>-G</option></arg>
  57       <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>
  58       <arg><option>-k</option></arg>
  59       <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
  60       <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>
  61       <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
  62       <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>
  63       <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
  64       <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg>
  65       <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
  66       <arg choice="req">name</arg>
  67     </cmdsynopsis>
  68   </refsynopsisdiv>
  69
  70   <refsect1>
  71     <title>DESCRIPTION</title>
  72     <para><command>dnssec-keyfromlabel</command>
  73       gets keys with the given label from a crypto hardware and builds
  74       key files for DNSSEC (Secure DNS), as defined in RFC 2535
  75       and RFC 4034.
  76     </para>
  77     <para>
  78       The <option>name</option> of the key is specified on the command
  79       line.  This must match the name of the zone for which the key is
  80       being generated.
  81     </para>
  82   </refsect1>
  83
  84   <refsect1>
  85     <title>OPTIONS</title>
  86
  87     <variablelist>
  88       <varlistentry>
  89         <term>-a <replaceable class="parameter">algorithm</replaceable></term>
  90         <listitem>
  91           <para>
  92             Selects the cryptographic algorithm.  The value of
  93             <option>algorithm</option> must be one of RSAMD5, RSASHA1,
  94             DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256 or RSASHA512.
  95             These values are case insensitive.
  96           </para>
  97           <para>
  98             If no algorithm is specified, then RSASHA1 will be used by
  99             default, unless the <option>-3</option> option is specified,
 100             in which case NSEC3RSASHA1 will be used instead.  (If
 101             <option>-3</option> is used and an algorithm is specified,
 102             that algorithm will be checked for compatibility with NSEC3.)
 103           </para>
 104           <para>
 105             Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
 106             algorithm, and DSA is recommended.
 107           </para>
 108           <para>
 109             Note 2: DH automatically sets the -k flag.
 110           </para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term>-3</term>
 116         <listitem>
 117           <para>
 118             Use an NSEC3-capable algorithm to generate a DNSSEC key.
 119             If this option is used and no algorithm is explicitly
 120             set on the command line, NSEC3RSASHA1 will be used by
 121             default.
 122           </para>
 123         </listitem>
 124       </varlistentry>
 125
 126       <varlistentry>
 127         <term>-E <replaceable class="parameter">engine</replaceable></term>
 128         <listitem>
 129           <para>
 130             Specifies the name of the crypto hardware (OpenSSL engine).
 131             When compiled with PKCS#11 support it defaults to "pkcs11".
 132           </para>
 133         </listitem>
 134       </varlistentry>
 135
 136       <varlistentry>
 137         <term>-l <replaceable class="parameter">label</replaceable></term>
 138         <listitem>
 139           <para>
 140             Specifies the label of the key pair in the crypto hardware.
 141             The label may be preceded by an optional OpenSSL engine name,
 142             separated by a colon, as in "pkcs11:keylabel".
 143           </para>
 144         </listitem>
 145       </varlistentry>
 146
 147       <varlistentry>
 148         <term>-n <replaceable class="parameter">nametype</replaceable></term>
 149         <listitem>
 150           <para>
 151             Specifies the owner type of the key.  The value of
 152             <option>nametype</option> must either be ZONE (for a DNSSEC
 153             zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
 154             a host (KEY)),
 155             USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
 156             These values are case insensitive.
 157           </para>
 158         </listitem>
 159       </varlistentry>
 160
 161       <varlistentry>
 162         <term>-C</term>
 163         <listitem>
 164           <para>
 165             Compatibility mode:  generates an old-style key, without
 166             any metadata.  By default, <command>dnssec-keyfromlabel</command>
 167             will include the key's creation date in the metadata stored
 168             with the private key, and other dates may be set there as well
 169             (publication date, activation date, etc).  Keys that include
 170             this data may be incompatible with older versions of BIND; the
 171             <option>-C</option> option suppresses them.
 172           </para>
 173         </listitem>
 174       </varlistentry>
 175
 176       <varlistentry>
 177         <term>-c <replaceable class="parameter">class</replaceable></term>
 178         <listitem>
 179           <para>
 180             Indicates that the DNS record containing the key should have
 181             the specified class.  If not specified, class IN is used.
 182           </para>
 183         </listitem>
 184       </varlistentry>
 185
 186       <varlistentry>
 187         <term>-f <replaceable class="parameter">flag</replaceable></term>
 188         <listitem>
 189           <para>
 190             Set the specified flag in the flag field of the KEY/DNSKEY record.
 191             The only recognized flags are KSK (Key Signing Key) and REVOKE.
 192           </para>
 193         </listitem>
 194       </varlistentry>
 195
 196       <varlistentry>
 197         <term>-G</term>
 198         <listitem>
 199           <para>
 200             Generate a key, but do not publish it or sign with it.  This
 201             option is incompatible with -P and -A.
 202           </para>
 203         </listitem>
 204       </varlistentry>
 205
 206       <varlistentry>
 207         <term>-h</term>
 208         <listitem>
 209           <para>
 210             Prints a short summary of the options and arguments to
 211             <command>dnssec-keyfromlabel</command>.
 212           </para>
 213         </listitem>
 214       </varlistentry>
 215
 216       <varlistentry>
 217         <term>-K <replaceable class="parameter">directory</replaceable></term>
 218         <listitem>
 219           <para>
 220             Sets the directory in which the key files are to be written.
 221           </para>
 222         </listitem>
 223       </varlistentry>
 224
 225       <varlistentry>
 226         <term>-k</term>
 227         <listitem>
 228           <para>
 229             Generate KEY records rather than DNSKEY records.
 230           </para>
 231         </listitem>
 232       </varlistentry>
 233
 234       <varlistentry>
 235         <term>-p <replaceable class="parameter">protocol</replaceable></term>
 236         <listitem>
 237           <para>
 238             Sets the protocol value for the key.  The protocol
 239             is a number between 0 and 255.  The default is 3 (DNSSEC).
 240             Other possible values for this argument are listed in
 241             RFC 2535 and its successors.
 242           </para>
 243         </listitem>
 244       </varlistentry>
 245
 246       <varlistentry>
 247         <term>-t <replaceable class="parameter">type</replaceable></term>
 248         <listitem>
 249           <para>
 250             Indicates the use of the key.  <option>type</option> must be
 251             one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF.  The default
 252             is AUTHCONF.  AUTH refers to the ability to authenticate
 253             data, and CONF the ability to encrypt data.
 254           </para>
 255         </listitem>
 256       </varlistentry>
 257
 258       <varlistentry>
 259         <term>-v <replaceable class="parameter">level</replaceable></term>
 260         <listitem>
 261           <para>
 262             Sets the debugging level.
 263           </para>
 264         </listitem>
 265       </varlistentry>
 266
 267     </variablelist>
 268   </refsect1>
 269
 270   <refsect1>
 271     <title>TIMING OPTIONS</title>
 272
 273     <para>
 274       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 275       If the argument begins with a '+' or '-', it is interpreted as
 276       an offset from the present time.  For convenience, if such an offset
 277       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 278       then the offset is computed in years (defined as 365 24-hour days,
 279       ignoring leap years), months (defined as 30 24-hour days), weeks,
 280       days, hours, or minutes, respectively.  Without a suffix, the offset
 281       is computed in seconds.
 282     </para>
 283
 284     <variablelist>
 285       <varlistentry>
 286         <term>-P <replaceable class="parameter">date/offset</replaceable></term>
 287         <listitem>
 288           <para>
 289             Sets the date on which a key is to be published to the zone.
 290             After that date, the key will be included in the zone but will
 291             not be used to sign it.  If not set, and if the -G option has
 292             not been used, the default is "now".
 293           </para>
 294         </listitem>
 295       </varlistentry>
 296
 297       <varlistentry>
 298         <term>-A <replaceable class="parameter">date/offset</replaceable></term>
 299         <listitem>
 300           <para>
 301             Sets the date on which the key is to be activated.  After that
 302             date, the key will be included in the zone and used to sign
 303             it.  If not set, and if the -G option has not been used, the
 304             default is "now".
 305           </para>
 306         </listitem>
 307       </varlistentry>
 308
 309       <varlistentry>
 310         <term>-R <replaceable class="parameter">date/offset</replaceable></term>
 311         <listitem>
 312           <para>
 313             Sets the date on which the key is to be revoked.  After that
 314             date, the key will be flagged as revoked.  It will be included
 315             in the zone and will be used to sign it.
 316           </para>
 317         </listitem>
 318       </varlistentry>
 319
 320       <varlistentry>
 321         <term>-U <replaceable class="parameter">date/offset</replaceable></term>
 322         <listitem>
 323           <para>
 324             Sets the date on which the key is to be retired.  After that
 325             date, the key will still be included in the zone, but it
 326             will not be used to sign it.
 327           </para>
 328         </listitem>
 329       </varlistentry>
 330
 331       <varlistentry>
 332         <term>-D <replaceable class="parameter">date/offset</replaceable></term>
 333         <listitem>
 334           <para>
 335             Sets the date on which the key is to be deleted.  After that
 336             date, the key will no longer be included in the zone.  (It
 337             may remain in the key repository, however.)
 338           </para>
 339         </listitem>
 340       </varlistentry>
 341     </variablelist>
 342   </refsect1>
 343
 344   <refsect1>
 345     <title>GENERATED KEY FILES</title>
 346     <para>
 347       When <command>dnssec-keyfromlabel</command> completes
 348       successfully,
 349       it prints a string of the form <filename>Knnnn.+aaa+iiiii</filename>
 350       to the standard output.  This is an identification string for
 351       the key files it has generated.
 352     </para>
 353     <itemizedlist>
 354       <listitem>
 355         <para><filename>nnnn</filename> is the key name.
 356         </para>
 357       </listitem>
 358       <listitem>
 359         <para><filename>aaa</filename> is the numeric representation
 360           of the algorithm.
 361         </para>
 362       </listitem>
 363       <listitem>
 364         <para><filename>iiiii</filename> is the key identifier (or
 365           footprint).
 366         </para>
 367       </listitem>
 368     </itemizedlist>
 369     <para><command>dnssec-keyfromlabel</command>
 370       creates two files, with names based
 371       on the printed string.  <filename>Knnnn.+aaa+iiiii.key</filename>
 372       contains the public key, and
 373       <filename>Knnnn.+aaa+iiiii.private</filename> contains the
 374       private key.
 375     </para>
 376     <para>
 377       The <filename>.key</filename> file contains a DNS KEY record
 378       that
 379       can be inserted into a zone file (directly or with a $INCLUDE
 380       statement).
 381     </para>
 382     <para>
 383       The <filename>.private</filename> file contains
 384       algorithm-specific
 385       fields.  For obvious security reasons, this file does not have
 386       general read permission.
 387     </para>
 388   </refsect1>
 389
 390   <refsect1>
 391     <title>SEE ALSO</title>
 392     <para><citerefentry>
 393         <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
 394       </citerefentry>,
 395       <citerefentry>
 396         <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
 397       </citerefentry>,
 398       <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
 399       <citetitle>RFC 4034</citetitle>.
 400     </para>
 401   </refsect1>
 402
 403   <refsect1>
 404     <title>AUTHOR</title>
 405     <para><corpauthor>Internet Systems Consortium</corpauthor>
 406     </para>
 407   </refsect1>
 408
 409 </refentry><!--
 410  - Local variables:
 411  - mode: sgml
 412  - End:
 413 -->