3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews [<!ENTITY mdash "&#8212;">]>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews<refentry id="man.dnssec-keyfromlabel">

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refentryinfo>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <date>February 27, 2014</date>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </refentryinfo>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refmeta>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refentrytitle><application>dnssec-keyfromlabel</application></refentrytitle>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <manvolnum>8</manvolnum>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refmiscinfo>BIND9</refmiscinfo>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </refmeta>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refnamediv>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refname><application>dnssec-keyfromlabel</application></refname>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refpurpose>DNSSEC key generation tool</refpurpose>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </refnamediv>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <docinfo>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <copyright>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2008</year>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2009</year>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2010</year>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2011</year>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2012</year>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2014</year>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <holder>Internet Systems Consortium, Inc. ("ISC")</holder>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </copyright>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </docinfo>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refsynopsisdiv>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <cmdsynopsis>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <command>dnssec-keyfromlabel</command>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg choice="req">-l <replaceable class="parameter">label</replaceable></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-3</option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-f <replaceable class="parameter">flag</replaceable></option></arg>

30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt <arg><option>-G</option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-i <replaceable class="parameter">interval</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-k</option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-S <replaceable class="parameter">key</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-y</option></arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg choice="req">name</arg>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </cmdsynopsis>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </refsynopsisdiv>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refsect1>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <title>DESCRIPTION</title>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para><command>dnssec-keyfromlabel</command>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews generates a key pair of files that referencing a key object stored

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews in a cryptographic hardware service module (HSM). The private key

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews file can be used for DNSSEC signing of zone data as if it were a

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews conventional signing key created by <command>dnssec-keygen</command>,

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews but the key material is stored within the HSM, and the actual signing

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews takes place there.

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews The <option>name</option> of the key is specified on the command

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews line. This must match the name of the zone for which the key is

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews being generated.

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </refsect1>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refsect1>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <title>OPTIONS</title>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <variablelist>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <varlistentry>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <term>-a <replaceable class="parameter">algorithm</replaceable></term>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <listitem>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews Selects the cryptographic algorithm. The value of

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <option>algorithm</option> must be one of RSAMD5, RSASHA1,

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews ECDSAP256SHA256 or ECDSAP384SHA384.

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews These values are case insensitive.

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews If no algorithm is specified, then RSASHA1 will be used by

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews default, unless the <option>-3</option> option is specified,

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews in which case NSEC3RSASHA1 will be used instead. (If

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <option>-3</option> is used and an algorithm is specified,

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews that algorithm will be checked for compatibility with NSEC3.)

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews algorithm, and DSA is recommended.

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews Note 2: DH automatically sets the -k flag.

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </listitem>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </varlistentry>

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews

3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <varlistentry>

c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <term>-3</term>

<listitem>

<para>

Use an NSEC3-capable algorithm to generate a DNSSEC key.

If this option is used and no algorithm is explicitly

set on the command line, NSEC3RSASHA1 will be used by

default.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-E <replaceable class="parameter">engine</replaceable></term>

<listitem>

<para>

Specifies the cryptographic hardware to use.

</para>

<para>

When BIND is built with OpenSSL PKCS#11 support, this defaults

to the string "pkcs11", which identifies an OpenSSL engine

that can drive a cryptographic accelerator or hardware service

module. When BIND is built with native PKCS#11 cryptography

(--enable-native-pkcs11), it defaults to the path of the PKCS#11

provider library specified via "--with-pkcs11".

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-l <replaceable class="parameter">label</replaceable></term>

<listitem>

<para>

Specifies the label for a key pair in the crypto hardware.

</para>

<para>

When <acronym>BIND</acronym> 9 is built with OpenSSL-based

PKCS#11 support, the label is an arbitrary string that

identifies a particular key. It may be preceded by an

optional OpenSSL engine name, followed by a colon, as in

"pkcs11:<replaceable>keylabel</replaceable>".

</para>

<para>

When <acronym>BIND</acronym> 9 is built with native PKCS#11

support, the label is a PKCS#11 URI string in the format

"pkcs11:<option>keyword</option>=<replaceable>value</replaceable><optional>;<option>keyword</option>=<replaceable>value</replaceable>;...</optional>"

Keywords include "token", which identifies the HSM; "object", which

identifies the key; and "pin-source", which identifies a file from

which the HSM's PIN code can be obtained. The label will be

stored in the on-disk "private" file.

</para>

<para>

If the label contains a

<option>pin-source</option> field, tools using the generated

key files will be able to use the HSM for signing and other

operations without any need for an operator to manually enter

a PIN. Note: Making the HSM's PIN accessible in this manner

may reduce the security advantage of using an HSM; be sure

this is what you want to do before making use of this feature.

</para>

</listitem>

</varlistentry>

<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>-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>

</refsect1>

<refsect1>

<title>TIMING OPTIONS</title>

<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>

</refsect1>

<refsect1>

<title>GENERATED KEY FILES</title>

<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>

</refsect1>

<refsect1>

<title>SEE ALSO</title>

<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>

</refsect1>

<refsect1>

<title>AUTHOR</title>

<para><corpauthor>Internet Systems Consortium</corpauthor>

</para>

</refsect1>

</refentry><!--