dnssec-keyfromlabel.docbook revision 19c7b1a0293498a3e36692c59646ed6e15ffc8d0
50066670817cdf9e86c832066d73715232b29680Tinderbox User<!--
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User - Copyright (C) 2008-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
50066670817cdf9e86c832066d73715232b29680Tinderbox User -
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 -
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-->
50066670817cdf9e86c832066d73715232b29680Tinderbox User
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">
50066670817cdf9e86c832066d73715232b29680Tinderbox User <info>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <date>2014-02-27</date>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </info>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refentryinfo>
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User <corpname>ISC</corpname>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </refentryinfo>
50066670817cdf9e86c832066d73715232b29680Tinderbox User
50066670817cdf9e86c832066d73715232b29680Tinderbox User <refmeta>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <refentrytitle><application>dnssec-keyfromlabel</application></refentrytitle>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <manvolnum>8</manvolnum>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <refmiscinfo>BIND9</refmiscinfo>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </refmeta>
50066670817cdf9e86c832066d73715232b29680Tinderbox User
50066670817cdf9e86c832066d73715232b29680Tinderbox User <refnamediv>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <refname><application>dnssec-keyfromlabel</application></refname>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <refpurpose>DNSSEC key generation tool</refpurpose>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </refnamediv>
50066670817cdf9e86c832066d73715232b29680Tinderbox User
50066670817cdf9e86c832066d73715232b29680Tinderbox User <docinfo>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <copyright>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <year>2008</year>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <year>2009</year>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <year>2010</year>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <year>2011</year>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <year>2012</year>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <year>2014</year>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <year>2015</year>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </copyright>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </docinfo>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <refsynopsisdiv>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <cmdsynopsis sepchar=" ">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <command>dnssec-keyfromlabel</command>
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>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="req" rep="norepeat">name</arg>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </cmdsynopsis>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </refsynopsisdiv>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <refsection><info><title>DESCRIPTION</title></info>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <para><command>dnssec-keyfromlabel</command>
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.
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para>
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 </para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </refsection>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <refsection><info><title>OPTIONS</title></info>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User
50066670817cdf9e86c832066d73715232b29680Tinderbox User <variablelist>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <term>-a <replaceable class="parameter">algorithm</replaceable></term>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <listitem>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <para>
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.
6f1205897504b8f50b1785975482c995888dd630Tinderbox User </para>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <para>
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 </para>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <para>
50066670817cdf9e86c832066d73715232b29680Tinderbox User Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
50066670817cdf9e86c832066d73715232b29680Tinderbox User algorithm, and DSA is recommended.
50066670817cdf9e86c832066d73715232b29680Tinderbox User </para>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <para>
50066670817cdf9e86c832066d73715232b29680Tinderbox User Note 2: DH automatically sets the -k flag.
50066670817cdf9e86c832066d73715232b29680Tinderbox User </para>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </listitem>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </varlistentry>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
50066670817cdf9e86c832066d73715232b29680Tinderbox User <varlistentry>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <term>-3</term>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para>
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 default.
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <term>-E <replaceable class="parameter">engine</replaceable></term>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User Specifies the cryptographic hardware to use.
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para>
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".
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </para>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </listitem>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User
50066670817cdf9e86c832066d73715232b29680Tinderbox User <varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <term>-l <replaceable class="parameter">label</replaceable></term>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <listitem>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <para>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Specifies the label for a key pair in the crypto hardware.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </para>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <para>
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 </para>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <para>
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 </para>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <para>
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.
50066670817cdf9e86c832066d73715232b29680Tinderbox User </para>
50066670817cdf9e86c832066d73715232b29680Tinderbox User </listitem>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User
50066670817cdf9e86c832066d73715232b29680Tinderbox User <varlistentry>
<term>-n <replaceable class="parameter">nametype</replaceable></term>
<listitem>
<para>
Specifies the owner type of the key. The value of
<option>nametype</option> must either be ZONE (for a DNSSEC
zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
a host (KEY)),
USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
These values are case insensitive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-C</term>
<listitem>
<para>
Compatibility mode: generates an old-style key, without
any metadata. By default, <command>dnssec-keyfromlabel</command>
will include the key's creation date in the metadata stored
with the private key, and other dates may be set there as well
(publication date, activation date, etc). Keys that include
this data may be incompatible with older versions of BIND; the
<option>-C</option> option suppresses them.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-c <replaceable class="parameter">class</replaceable></term>
<listitem>
<para>
Indicates that the DNS record containing the key should have
the specified class. If not specified, class IN is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-f <replaceable class="parameter">flag</replaceable></term>
<listitem>
<para>
Set the specified flag in the flag field of the KEY/DNSKEY record.
The only recognized flags are KSK (Key Signing Key) and REVOKE.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-G</term>
<listitem>
<para>
Generate a key, but do not publish it or sign with it. This
option is incompatible with -P and -A.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-h</term>
<listitem>
<para>
Prints a short summary of the options and arguments to
<command>dnssec-keyfromlabel</command>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-K <replaceable class="parameter">directory</replaceable></term>
<listitem>
<para>
Sets the directory in which the key files are to be written.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-k</term>
<listitem>
<para>
Generate KEY records rather than DNSKEY records.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-L <replaceable class="parameter">ttl</replaceable></term>
<listitem>
<para>
Sets the default TTL to use for this key when it is converted
into a DNSKEY RR. If the key is imported into a zone,
this is the TTL that will be used for it, unless there was
already a DNSKEY RRset in place, in which case the existing TTL
would take precedence. Setting the default TTL to
<literal>0</literal> or <literal>none</literal> removes it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-p <replaceable class="parameter">protocol</replaceable></term>
<listitem>
<para>
Sets the protocol value for the key. The protocol
is a number between 0 and 255. The default is 3 (DNSSEC).
Other possible values for this argument are listed in
RFC 2535 and its successors.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-S <replaceable class="parameter">key</replaceable></term>
<listitem>
<para>
Generate a key as an explicit successor to an existing key.
The name, algorithm, size, and type of the key will be set
to match the predecessor. The activation date of the new
key will be set to the inactivation date of the existing
one. The publication date will be set to the activation
date minus the prepublication interval, which defaults to
30 days.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-t <replaceable class="parameter">type</replaceable></term>
<listitem>
<para>
Indicates the use of the key. <option>type</option> must be
one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
is AUTHCONF. AUTH refers to the ability to authenticate
data, and CONF the ability to encrypt data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-v <replaceable class="parameter">level</replaceable></term>
<listitem>
<para>
Sets the debugging level.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-V</term>
<listitem>
<para>
Prints version information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-y</term>
<listitem>
<para>
Allows DNSSEC key files to be generated even if the key ID
would collide with that of an existing key, in the event of
either key being revoked. (This is only safe to use if you
are sure you won't be using RFC 5011 trust anchor maintenance
with either of the keys involved.)
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection><info><title>TIMING OPTIONS</title></info>
<para>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
If the argument begins with a '+' or '-', it is interpreted as
an offset from the present time. For convenience, if such an offset
is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
then the offset is computed in years (defined as 365 24-hour days,
ignoring leap years), months (defined as 30 24-hour days), weeks,
days, hours, or minutes, respectively. Without a suffix, the offset
is computed in seconds. To explicitly prevent a date from being
set, use 'none' or 'never'.
</para>
<variablelist>
<varlistentry>
<term>-P <replaceable class="parameter">date/offset</replaceable></term>
<listitem>
<para>
Sets the date on which a key is to be published to the zone.
After that date, the key will be included in the zone but will
not be used to sign it. If not set, and if the -G option has
not been used, the default is "now".
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-A <replaceable class="parameter">date/offset</replaceable></term>
<listitem>
<para>
Sets the date on which the key is to be activated. After that
date, the key will be included in the zone and used to sign
it. If not set, and if the -G option has not been used, the
default is "now".
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-R <replaceable class="parameter">date/offset</replaceable></term>
<listitem>
<para>
Sets the date on which the key is to be revoked. After that
date, the key will be flagged as revoked. It will be included
in the zone and will be used to sign it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-I <replaceable class="parameter">date/offset</replaceable></term>
<listitem>
<para>
Sets the date on which the key is to be retired. After that
date, the key will still be included in the zone, but it
will not be used to sign it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-D <replaceable class="parameter">date/offset</replaceable></term>
<listitem>
<para>
Sets the date on which the key is to be deleted. After that
date, the key will no longer be included in the zone. (It
may remain in the key repository, however.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-i <replaceable class="parameter">interval</replaceable></term>
<listitem>
<para>
Sets the prepublication interval for a key. If set, then
the publication and activation dates must be separated by at least
this much time. If the activation date is specified but the
publication date isn't, then the publication date will default
to this much time before the activation date; conversely, if
the publication date is specified but activation date isn't,
then activation will be set to this much time after publication.
</para>
<para>
If the key is being created as an explicit successor to another
key, then the default prepublication interval is 30 days;
otherwise it is zero.
</para>
<para>
As with date offsets, if the argument is followed by one of
the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
interval is measured in years, months, weeks, days, hours,
or minutes, respectively. Without a suffix, the interval is
measured in seconds.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection><info><title>GENERATED KEY FILES</title></info>
<para>
When <command>dnssec-keyfromlabel</command> completes
successfully,
it prints a string of the form <filename>Knnnn.+aaa+iiiii</filename>
to the standard output. This is an identification string for
the key files it has generated.
</para>
<itemizedlist>
<listitem>
<para><filename>nnnn</filename> is the key name.
</para>
</listitem>
<listitem>
<para><filename>aaa</filename> is the numeric representation
of the algorithm.
</para>
</listitem>
<listitem>
<para><filename>iiiii</filename> is the key identifier (or
footprint).
</para>
</listitem>
</itemizedlist>
<para><command>dnssec-keyfromlabel</command>
creates two files, with names based
on the printed string. <filename>Knnnn.+aaa+iiiii.key</filename>
contains the public key, and
<filename>Knnnn.+aaa+iiiii.private</filename> contains the
private key.
</para>
<para>
The <filename>.key</filename> file contains a DNS KEY record
that
can be inserted into a zone file (directly or with a $INCLUDE
statement).
</para>
<para>
The <filename>.private</filename> file contains
algorithm-specific
fields. For obvious security reasons, this file does not have
general read permission.
</para>
</refsection>
<refsection><info><title>SEE ALSO</title></info>
<para><citerefentry>
<refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>BIND 9 Administrator Reference Manual</citetitle>,
<citetitle>RFC 4034</citetitle>,
<citetitle>The PKCS#11 URI Scheme (draft-pechanec-pkcs11uri-13)</citetitle>.
</para>
</refsection>
</refentry>