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

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync [<!ENTITY mdash "&#8212;">]>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<refentry id="man.dnssec-keygen">

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <refentryinfo>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <date>June 30, 2000</date>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync </refentryinfo>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <refmeta>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <refentrytitle><application>dnssec-keygen</application></refentrytitle>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <manvolnum>8</manvolnum>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <refmiscinfo>BIND9</refmiscinfo>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync </refmeta>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <refnamediv>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <refname><application>dnssec-keygen</application></refname>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <refpurpose>DNSSEC key generation tool</refpurpose>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync </refnamediv>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <docinfo>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <copyright>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <year>2004</year>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <year>2005</year>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <year>2007</year>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <year>2008</year>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <year>2009</year>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <holder>Internet Systems Consortium, Inc. ("ISC")</holder>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync </copyright>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <copyright>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <year>2000</year>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <year>2001</year>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <year>2002</year>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <year>2003</year>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <holder>Internet Software Consortium.</holder>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync </copyright>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync </docinfo>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <refsynopsisdiv>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <cmdsynopsis>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <command>dnssec-keygen</command>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <arg ><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>

<arg><option>-3</option></arg>

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

<arg><option>-C</option></arg>

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

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

<arg><option>-e</option></arg>

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

<arg><option>-g <replaceable class="parameter">generator</replaceable></option></arg>

<arg><option>-h</option></arg>

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

<arg><option>-k</option></arg>

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

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

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

<arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>

<arg><option>-s <replaceable class="parameter">strength</replaceable></option></arg>

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

<arg><option>-U <replaceable class="parameter">date/offset</replaceable></option></arg>

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

<arg><option>-z</option></arg>

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

</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>DESCRIPTION</title>

<para><command>dnssec-keygen</command>

generates keys for DNSSEC (Secure DNS), as defined in RFC 2535

and RFC 4034. It can also generate keys for use with

TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY

(Transaction Key) as defined in RFC 2930.

</para>

</refsect1>

<refsect1>

<title>OPTIONS</title>

<variablelist>

<varlistentry>

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

<listitem>

<para>

Selects the cryptographic algorithm. For DNSSEC keys, the value

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

DSA, NSEC3RSASHA1, or NSEC3DSA. For TSIG/TKEY, the value must

be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,

HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are

case insensitive.

</para>

<para>

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

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

in which case NSEC3RSASHA1 will be used instead.

</para>

<para>

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

algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is

mandatory.

</para>

<para>

Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512

automatically set the -T KEY option.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-b <replaceable class="parameter">keysize</replaceable></term>

<listitem>

<para>

Specifies the number of bits in the key. The choice of key

size depends on the algorithm used. RSAMD5 / RSASHA1 keys must be

between 512 and 2048 bits. Diffie Hellman keys must be between

128 and 4096 bits. DSA keys must be between 512 and 1024

bits and an exact multiple of 64. HMAC-MD5 keys must be

between 1 and 512 bits.

</para>

<para>

The key size does not need to be specified if using a default

algorithm. The default key size is 1024 bits for zone signing

keys (ZSK's) and 2048 bits for key signing keys (KSK's,

generated with <option>-f KSK</option>). However, if an

algorithm is explicitly specified with the <option>-a</option>,

then there is no default key size, and the <option>-b</option>

must be used.

</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. Defaults to ZONE for DNSKEY

generation.

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

<listitem>

<para>

Compatibility mode: generates an old-style key, without

any metadata. By default, <command>dnssec-keygen</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>-e</term>

<listitem>

<para>

If generating an RSAMD5/RSASHA1 key, use a large exponent.

</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 <replaceable class="parameter">generator</replaceable></term>

<listitem>

<para>

If generating a Diffie Hellman key, use this generator.

Allowed values are 2 and 5. If no generator

is specified, a known prime from RFC 2539 will be used

if possible; otherwise the default is 2.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-h</term>

<listitem>

<para>

Prints a short summary of the options and arguments to

<command>dnssec-keygen</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>

Deprecated in favor of -T KEY.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-p <replaceable class="parameter">protocol</replaceable></term>

<listitem>

<para>

Sets the protocol value for the generated 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>-r <replaceable class="parameter">randomdev</replaceable></term>

<listitem>

<para>

Specifies the source of randomness. If the operating

system does not provide a <filename>/dev/random</filename>

or equivalent device, the default source of randomness

is keyboard input. <filename>randomdev</filename>

specifies

the name of a character device or file containing random

data to be used instead of the default. The special value

<filename>keyboard</filename> indicates that keyboard

input should be used.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-s <replaceable class="parameter">strength</replaceable></term>

<listitem>

<para>

Specifies the strength value of the key. The strength is

a number between 0 and 15, and currently has no defined

purpose in DNSSEC.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-T <replaceable class="parameter">rrtype</replaceable></term>

<listitem>

<para>

Specifies the resource record type to use for the key.

<option>rrtype</option> must be either DNSKEY or KEY. The

default is DNSKEY when using a DNSSEC algorithm, but it can be

overridden to KEY for use with SIG(0).

<para>

</para>

Using any TSIG algorithm (HMAC-* or DH) forces this option

to KEY.

</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. If such an offset is followed

by one of the characters 'y', 'm', 'w', 'd', or 'h', then the

offset is computed in years, months, weeks, days, or hours,

respectively; otherwise it 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.

</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 and the zone and used to sign

it.

</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 unpublished. After that

date, the key will no longer be included in the zone, but it

may remain in the key repository.

</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 can be removed from the key repository.

NOTE: Keys are not currently deleted automatically; this field

is included for informational purposes and for future

development.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>GENERATED KEYS</title>

<para>

When <command>dnssec-keygen</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 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-keygen</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>

<para>

Both <filename>.key</filename> and <filename>.private</filename>

files are generated for symmetric encryption algorithms such as

HMAC-MD5, even though the public and private key are equivalent.

</para>

</refsect1>

<refsect1>

<title>EXAMPLE</title>

<para>

To generate a 768-bit DSA key for the domain

<userinput>example.com</userinput>, the following command would be

issued:

</para>

<para><userinput>dnssec-keygen -a DSA -b 768 -n ZONE example.com</userinput>

</para>

<para>

The command would print a string of the form:

</para>

<para><userinput>Kexample.com.+003+26160</userinput>

</para>

<para>

In this example, <command>dnssec-keygen</command> creates

the files <filename>Kexample.com.+003+26160.key</filename>

and

<filename>Kexample.com.+003+26160.private</filename>.

</para>

</refsect1>

<refsect1>

<title>SEE ALSO</title>

<para><citerefentry>

<refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>,

<citetitle>BIND 9 Administrator Reference Manual</citetitle>,

<citetitle>RFC 2539</citetitle>,

<citetitle>RFC 2845</citetitle>,

<citetitle>RFC 4033</citetitle>.

</para>

</refsect1>

<refsect1>

<title>AUTHOR</title>

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

</para>

</refsect1>

</refentry><!--