dnssec-keyfromlabel.docbook revision 19c7b1a0293498a3e36692c59646ed6e15ffc8d0
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User - Copyright (C) 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
50066670817cdf9e86c832066d73715232b29680Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
50066670817cdf9e86c832066d73715232b29680Tinderbox User - purpose with or without fee is hereby granted, provided that the above
50066670817cdf9e86c832066d73715232b29680Tinderbox User - copyright notice and this permission notice appear in all copies.
50066670817cdf9e86c832066d73715232b29680Tinderbox User - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
50066670817cdf9e86c832066d73715232b29680Tinderbox User - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
50066670817cdf9e86c832066d73715232b29680Tinderbox User - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
50066670817cdf9e86c832066d73715232b29680Tinderbox User - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
50066670817cdf9e86c832066d73715232b29680Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
50066670817cdf9e86c832066d73715232b29680Tinderbox User - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
50066670817cdf9e86c832066d73715232b29680Tinderbox User - PERFORMANCE OF THIS SOFTWARE.
50066670817cdf9e86c832066d73715232b29680Tinderbox User<!-- Converted by db4-upgrade version 1.0 -->
50066670817cdf9e86c832066d73715232b29680Tinderbox User<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-keyfromlabel">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refentryinfo>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </refentryinfo>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <refentrytitle><application>dnssec-keyfromlabel</application></refentrytitle>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <refname><application>dnssec-keyfromlabel</application></refname>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <refpurpose>DNSSEC key generation tool</refpurpose>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </refnamediv>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <refsynopsisdiv>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="req" rep="norepeat">-l <replaceable class="parameter">label</replaceable></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-3</option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">flag</replaceable></option></arg>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat"><option>-G</option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">interval</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-k</option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat"><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat"><option>-S <replaceable class="parameter">key</replaceable></option></arg>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">type</replaceable></option></arg>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-V</option></arg>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <arg choice="opt" rep="norepeat"><option>-y</option></arg>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </cmdsynopsis>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </refsynopsisdiv>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <refsection><info><title>DESCRIPTION</title></info>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User generates a key pair of files that referencing a key object stored
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User in a cryptographic hardware service module (HSM). The private key
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User file can be used for DNSSEC signing of zone data as if it were a
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User conventional signing key created by <command>dnssec-keygen</command>,
50066670817cdf9e86c832066d73715232b29680Tinderbox User but the key material is stored within the HSM, and the actual signing
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User takes place there.
50066670817cdf9e86c832066d73715232b29680Tinderbox User The <option>name</option> of the key is specified on the command
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User line. This must match the name of the zone for which the key is
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User being generated.
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </refsection>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <refsection><info><title>OPTIONS</title></info>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <variablelist>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <term>-a <replaceable class="parameter">algorithm</replaceable></term>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Selects the cryptographic algorithm. The value of
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <option>algorithm</option> must be one of RSAMD5, RSASHA1,
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
6f1205897504b8f50b1785975482c995888dd630Tinderbox User ECDSAP256SHA256 or ECDSAP384SHA384.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User These values are case insensitive.
50066670817cdf9e86c832066d73715232b29680Tinderbox User If no algorithm is specified, then RSASHA1 will be used by
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User default, unless the <option>-3</option> option is specified,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User in which case NSEC3RSASHA1 will be used instead. (If
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <option>-3</option> is used and an algorithm is specified,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User that algorithm will be checked for compatibility with NSEC3.)
50066670817cdf9e86c832066d73715232b29680Tinderbox User Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
50066670817cdf9e86c832066d73715232b29680Tinderbox User algorithm, and DSA is recommended.
50066670817cdf9e86c832066d73715232b29680Tinderbox User Note 2: DH automatically sets the -k flag.
50066670817cdf9e86c832066d73715232b29680Tinderbox User </varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User Use an NSEC3-capable algorithm to generate a DNSSEC key.
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User If this option is used and no algorithm is explicitly
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User set on the command line, NSEC3RSASHA1 will be used by
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </varlistentry>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <term>-E <replaceable class="parameter">engine</replaceable></term>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User Specifies the cryptographic hardware to use.
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User When BIND is built with OpenSSL PKCS#11 support, this defaults
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User to the string "pkcs11", which identifies an OpenSSL engine
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User that can drive a cryptographic accelerator or hardware service
50066670817cdf9e86c832066d73715232b29680Tinderbox User module. When BIND is built with native PKCS#11 cryptography
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User (--enable-native-pkcs11), it defaults to the path of the PKCS#11
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User provider library specified via "--with-pkcs11".
50066670817cdf9e86c832066d73715232b29680Tinderbox User </varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <term>-l <replaceable class="parameter">label</replaceable></term>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Specifies the label for a key pair in the crypto hardware.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User When <acronym>BIND</acronym> 9 is built with OpenSSL-based
50066670817cdf9e86c832066d73715232b29680Tinderbox User PKCS#11 support, the label is an arbitrary string that
50066670817cdf9e86c832066d73715232b29680Tinderbox User identifies a particular key. It may be preceded by an
50066670817cdf9e86c832066d73715232b29680Tinderbox User optional OpenSSL engine name, followed by a colon, as in
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User "pkcs11:<replaceable>keylabel</replaceable>".
50066670817cdf9e86c832066d73715232b29680Tinderbox User When <acronym>BIND</acronym> 9 is built with native PKCS#11
50066670817cdf9e86c832066d73715232b29680Tinderbox User support, the label is a PKCS#11 URI string in the format
50066670817cdf9e86c832066d73715232b29680Tinderbox User "pkcs11:<option>keyword</option>=<replaceable>value</replaceable><optional>;<option>keyword</option>=<replaceable>value</replaceable>;...</optional>"
50066670817cdf9e86c832066d73715232b29680Tinderbox User Keywords include "token", which identifies the HSM; "object", which
50066670817cdf9e86c832066d73715232b29680Tinderbox User identifies the key; and "pin-source", which identifies a file from
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User which the HSM's PIN code can be obtained. The label will be
50066670817cdf9e86c832066d73715232b29680Tinderbox User stored in the on-disk "private" file.
50066670817cdf9e86c832066d73715232b29680Tinderbox User If the label contains a
50066670817cdf9e86c832066d73715232b29680Tinderbox User <option>pin-source</option> field, tools using the generated
50066670817cdf9e86c832066d73715232b29680Tinderbox User key files will be able to use the HSM for signing and other
50066670817cdf9e86c832066d73715232b29680Tinderbox User operations without any need for an operator to manually enter
50066670817cdf9e86c832066d73715232b29680Tinderbox User a PIN. Note: Making the HSM's PIN accessible in this manner
50066670817cdf9e86c832066d73715232b29680Tinderbox User may reduce the security advantage of using an HSM; be sure
50066670817cdf9e86c832066d73715232b29680Tinderbox User this is what you want to do before making use of this feature.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <varlistentry>