dnssec-keyfromlabel.docbook revision ca4e44ebe8f3b29a426fe047c4192262ca660c6f
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
71cef386fae61275b03e203825680b39fedaa8c6Tinderbox User [<!ENTITY mdash "—">]>
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Copyright (C) 2008-2010 Internet Systems Consortium, Inc. ("ISC")
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - purpose with or without fee is hereby granted, provided that the above
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews - copyright notice and this permission notice appear in all copies.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater - PERFORMANCE OF THIS SOFTWARE.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<!-- $Id: dnssec-keyfromlabel.docbook,v 1.17 2010/01/19 23:48:55 tbox Exp $ -->
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refentryinfo>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </refentryinfo>
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater <refentrytitle><application>dnssec-keyfromlabel</application></refentrytitle>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refnamediv>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <refname><application>dnssec-keyfromlabel</application></refname>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refpurpose>DNSSEC key generation tool</refpurpose>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </refnamediv>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refsynopsisdiv>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <cmdsynopsis>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg choice="req">-l <replaceable class="parameter">label</replaceable></arg>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-f <replaceable class="parameter">flag</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
7e71f05d8643aca84914437c900cb716444507e4Tinderbox User </cmdsynopsis>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </refsynopsisdiv>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews gets keys with the given label from a crypto hardware and builds
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt key files for DNSSEC (Secure DNS), as defined in RFC 2535
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt and RFC 4034.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The <option>name</option> of the key is specified on the command
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews line. This must match the name of the zone for which the key is
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt being generated.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <variablelist>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <term>-a <replaceable class="parameter">algorithm</replaceable></term>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Selects the cryptographic algorithm. The value of
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <option>algorithm</option> must be one of RSAMD5, RSASHA1,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256 or RSASHA512.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews These values are case insensitive.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews If no algorithm is specified, then RSASHA1 will be used by
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt default, unless the <option>-3</option> option is specified,
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt in which case NSEC3RSASHA1 will be used instead. (If
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <option>-3</option> is used and an algorithm is specified,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews that algorithm will be checked for compatibility with NSEC3.)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews algorithm, and DSA is recommended.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Note 2: DH automatically sets the -k flag.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Use an NSEC3-capable algorithm to generate a DNSSEC key.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt If this option is used and no algorithm is explicitly
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews set on the command line, NSEC3RSASHA1 will be used by
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <varlistentry>
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User <term>-E <replaceable class="parameter">engine</replaceable></term>
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User Specifies the name of the crypto hardware (OpenSSL engine).
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User When compiled with PKCS#11 support it defaults to "pkcs11".
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <term>-l <replaceable class="parameter">label</replaceable></term>
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User Specifies the label of the key pair in the crypto hardware.
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User The label may be preceded by an optional OpenSSL engine name,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User separated by a colon, as in "pkcs11:keylabel".
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </varlistentry>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <term>-n <replaceable class="parameter">nametype</replaceable></term>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specifies the owner type of the key. The value of
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <option>nametype</option> must either be ZONE (for a DNSSEC
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews a host (KEY)),
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User These values are case insensitive.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Compatibility mode: generates an old-style key, without
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews any metadata. By default, <command>dnssec-keyfromlabel</command>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User will include the key's creation date in the metadata stored
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User with the private key, and other dates may be set there as well
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt (publication date, activation date, etc). Keys that include
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt this data may be incompatible with older versions of BIND; the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <term>-c <replaceable class="parameter">class</replaceable></term>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Indicates that the DNS record containing the key should have
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews the specified class. If not specified, class IN is used.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <term>-f <replaceable class="parameter">flag</replaceable></term>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Set the specified flag in the flag field of the KEY/DNSKEY record.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User The only recognized flags are KSK (Key Signing Key) and REVOKE.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Generate a key, but do not publish it or sign with it. This
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt option is incompatible with -P and -A.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Prints a short summary of the options and arguments to
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <term>-K <replaceable class="parameter">directory</replaceable></term>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Sets the directory in which the key files are to be written.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Generate KEY records rather than DNSKEY records.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </varlistentry>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <term>-p <replaceable class="parameter">protocol</replaceable></term>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Sets the protocol value for the key. The protocol
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews is a number between 0 and 255. The default is 3 (DNSSEC).
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Other possible values for this argument are listed in
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User RFC 2535 and its successors.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <term>-t <replaceable class="parameter">type</replaceable></term>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Indicates the use of the key. <option>type</option> must be
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User is AUTHCONF. AUTH refers to the ability to authenticate
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User data, and CONF the ability to encrypt data.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <term>-v <replaceable class="parameter">level</replaceable></term>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Sets the debugging level.
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User </varlistentry>
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater <varlistentry>
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark Andrews Allows DNSSEC key files to be generated even if the key ID
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews would collide with that of an existing key, in the event of
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater either key being revoked. (This is only safe to use if you
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater are sure you won't be using RFC 5011 trust anchor maintenance
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews with either of the keys involved.)
350e5eecadfc5ee72b11b2cc46828c9a0bcd717cTinderbox User </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </variablelist>