dnssec-keyfromlabel.html revision 6f1205897504b8f50b1785975482c995888dd630
28b3569d6248168e6c00caab951521cc8141a49dAutomatic Updater - Copyright (C) 2008-2012, 2014 Internet Systems Consortium, Inc. ("ISC")
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - Permission to use, copy, modify, and/or distribute this software for any
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont - purpose with or without fee is hereby granted, provided that the above
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont - copyright notice and this permission notice appear in all copies.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont - PERFORMANCE OF THIS SOFTWARE.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater<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>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater<a name="id2543530"></a><h2>DESCRIPTION</h2>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont generates a key pair of files that referencing a key object stored
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont in a cryptographic hardware service module (HSM). The private key
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont file can be used for DNSSEC signing of zone data as if it were a
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont conventional signing key created by <span><strong class="command">dnssec-keygen</strong></span>,
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont but the key material is stored within the HSM, and the actual signing
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont takes place there.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont The <code class="option">name</code> of the key is specified on the command
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont line. This must match the name of the zone for which the key is
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont being generated.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Selects the cryptographic algorithm. The value of
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont ECDSAP256SHA256 or ECDSAP384SHA384.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont These values are case insensitive.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont If no algorithm is specified, then RSASHA1 will be used by
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont default, unless the <code class="option">-3</code> option is specified,
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont in which case NSEC3RSASHA1 will be used instead. (If
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont <code class="option">-3</code> is used and an algorithm is specified,
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont that algorithm will be checked for compatibility with NSEC3.)
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont algorithm, and DSA is recommended.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Note 2: DH automatically sets the -k flag.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Use an NSEC3-capable algorithm to generate a DNSSEC key.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont If this option is used and no algorithm is explicitly
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont set on the command line, NSEC3RSASHA1 will be used by
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Specifies the cryptographic hardware to use.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont When BIND is built with OpenSSL PKCS#11 support, this defaults
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater to the string "pkcs11", which identifies an OpenSSL engine
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater that can drive a cryptographic accelerator or hardware service
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater module. When BIND is built with native PKCS#11 cryptography
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater (--enable-native-pkcs11), it defaults to the path of the PKCS#11
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont provider library specified via "--with-pkcs11".
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Specifies the label for a key pair in the crypto hardware.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont When <acronym class="acronym">BIND</acronym> 9 is built with OpenSSL-based
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont PKCS#11 support, the label is an arbitrary string that
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont identifies a particular key. It may be preceded by an
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont optional OpenSSL engine name, followed by a colon, as in
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont "pkcs11:<em class="replaceable"><code>keylabel</code></em>".
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont When <acronym class="acronym">BIND</acronym> 9 is built with native PKCS#11
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont support, the label is a PKCS#11 URI string in the format
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont "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>]"
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Keywords include "token", which identifies the HSM; "object", which
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont identifies the key; and "pin-source", which identifies a file from
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont which the HSM's PIN code can be obtained. The label will be
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont stored in the on-disk "private" file.
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater If the label contains a
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont <code class="option">pin-source</code> field, tools using the generated
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont key files will be able to use the HSM for signing and other
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont operations without any need for an operator to manually enter
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont a PIN. Note: Making the HSM's PIN accessible in this manner
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont may reduce the security advantage of using an HSM; be sure
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont this is what you want to do before making use of this feature.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Specifies the owner type of the key. The value of
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont <code class="option">nametype</code> must either be ZONE (for a DNSSEC
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont a host (KEY)),
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont These values are case insensitive.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Compatibility mode: generates an old-style key, without
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont will include the key's creation date in the metadata stored
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont with the private key, and other dates may be set there as well
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont (publication date, activation date, etc). Keys that include
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont this data may be incompatible with older versions of BIND; the
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont <code class="option">-C</code> option suppresses them.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Indicates that the DNS record containing the key should have
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont the specified class. If not specified, class IN is used.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Set the specified flag in the flag field of the KEY/DNSKEY record.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont The only recognized flags are KSK (Key Signing Key) and REVOKE.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Generate a key, but do not publish it or sign with it. This
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater option is incompatible with -P and -A.
c6c78f699b55b3344fb6b17ddc854cbae4610468Automatic Updater Prints a short summary of the options and arguments to
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont <span><strong class="command">dnssec-keyfromlabel</strong></span>.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Sets the directory in which the key files are to be written.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont Generate KEY records rather than DNSKEY records.
90f35c2f2a1c660f3b96eec413036d238df395f6Francis Dupont<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>