c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe [<!ENTITY mdash "&#8212;">]>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refentry id="man.dnssec-keyfromlabel">

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <refentryinfo>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <date>February 8, 2008</date>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </refentryinfo>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <refmeta>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <refentrytitle><application>dnssec-keyfromlabel</application></refentrytitle>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <manvolnum>8</manvolnum>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <refmiscinfo>BIND9</refmiscinfo>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </refmeta>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <refnamediv>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <refname><application>dnssec-keyfromlabel</application></refname>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <refpurpose>DNSSEC key generation tool</refpurpose>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </refnamediv>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <docinfo>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <copyright>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <year>2008</year>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <year>2009</year>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <holder>Internet Systems Consortium, Inc. ("ISC")</holder>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </copyright>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </docinfo>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <refsynopsisdiv>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <cmdsynopsis>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <command>dnssec-keyfromlabel</command>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg choice="req">-l <replaceable class="parameter">label</replaceable></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-3</option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-f <replaceable class="parameter">flag</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-G</option></arg>

ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2abYuri Pankov <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-k</option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <arg choice="req">name</arg>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </cmdsynopsis>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </refsynopsisdiv>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <refsect1>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <title>DESCRIPTION</title>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <para><command>dnssec-keyfromlabel</command>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe gets keys with the given label from a crypto hardware and builds

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe key files for DNSSEC (Secure DNS), as defined in RFC 2535

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe and RFC 4034.

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </para>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <para>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe The <option>name</option> of the key is specified on the command

ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2abYuri Pankov line. This must match the name of the zone for which the key is

ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2abYuri Pankov being generated.

ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2abYuri Pankov </para>

ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2abYuri Pankov </refsect1>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe

ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2abYuri Pankov <refsect1>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <title>OPTIONS</title>

ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2abYuri Pankov

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <variablelist>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <varlistentry>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <term>-a <replaceable class="parameter">algorithm</replaceable></term>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <listitem>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <para>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe Selects the cryptographic algorithm. The value of

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <option>algorithm</option> must be one of RSAMD5, RSASHA1,

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256 or RSASHA512.

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe These values are case insensitive.

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </para>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <para>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe If no algorithm is specified, then RSASHA1 will be used by

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe default, unless the <option>-3</option> option is specified,

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe in which case NSEC3RSASHA1 will be used instead. (If

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <option>-3</option> is used and an algorithm is specified,

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe that algorithm will be checked for compatibility with NSEC3.)

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </para>

c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <para>

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

algorithm, and DSA is recommended.

</para>

<para>

Note 2: DH automatically sets the -k flag.

</para>

</listitem>

</varlistentry>

<varlistentry>

<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 name of the crypto hardware (OpenSSL engine).

When compiled with PKCS#11 support it defaults to "pcks11".

</para>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<para>

Specifies the label of the key pair in the crypto hardware.

The label may be preceded by an optional OpenSSL engine name,

separated by a colon, as in "pkcs11:keylabel".

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

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

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

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

</para>

</refsect1>

<refsect1>

<title>AUTHOR</title>

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

</para>

</refsect1>

</refentry><!--