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

2cacab200fb387e290386593d9b2fca2e7beef33csovant "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"

2cacab200fb387e290386593d9b2fca2e7beef33csovant [<!ENTITY mdash "&#8212;">]>

2cacab200fb387e290386593d9b2fca2e7beef33csovant

2cacab200fb387e290386593d9b2fca2e7beef33csovant<refentry id="man.dnssec-keygen">

2cacab200fb387e290386593d9b2fca2e7beef33csovant <refentryinfo>

d81f6d00c343633159fc5ea08599d145135612c0ludovicp <date>June 30, 2000</date>

d6b1be7037488b905b5c6330ba50269a01635bf7csovant </refentryinfo>

2cacab200fb387e290386593d9b2fca2e7beef33csovant

2cacab200fb387e290386593d9b2fca2e7beef33csovant <refmeta>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <refentrytitle><application>dnssec-keygen</application></refentrytitle>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <manvolnum>8</manvolnum>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <refmiscinfo>BIND9</refmiscinfo>

2cacab200fb387e290386593d9b2fca2e7beef33csovant </refmeta>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <refnamediv>

2cacab200fb387e290386593d9b2fca2e7beef33csovant <refname><application>dnssec-keygen</application></refname>

2cacab200fb387e290386593d9b2fca2e7beef33csovant <refpurpose>DNSSEC key generation tool</refpurpose>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </refnamediv>

28eeffb99d4c7f8ff501c22d1d21501cbfe3ad32csovant

f9fdabbe3ac731fa9c04b95ec6864f6b0e2c34a2csovant <docinfo>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <copyright>

35c0b3d7ac44d5c1f361f026e87b0dfa6a2e1076gary.williams <year>2004</year>

f9fdabbe3ac731fa9c04b95ec6864f6b0e2c34a2csovant <year>2005</year>

f9fdabbe3ac731fa9c04b95ec6864f6b0e2c34a2csovant <year>2007</year>

f9fdabbe3ac731fa9c04b95ec6864f6b0e2c34a2csovant <year>2008</year>

9a4b47e50eaed3431847d0e05a80db3c6931acacgary.williams <year>2009</year>

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

30bc8f42b7a3f724edb7cbc8e4e22e84e86c34cemadiot </copyright>

30bc8f42b7a3f724edb7cbc8e4e22e84e86c34cemadiot <copyright>

f9fdabbe3ac731fa9c04b95ec6864f6b0e2c34a2csovant <year>2000</year>

30bc8f42b7a3f724edb7cbc8e4e22e84e86c34cemadiot <year>2001</year>

eda829585653ed50fc05afe1c87ae2803f6862a6csovant <year>2002</year>

30bc8f42b7a3f724edb7cbc8e4e22e84e86c34cemadiot <year>2003</year>

2cacab200fb387e290386593d9b2fca2e7beef33csovant <holder>Internet Software Consortium.</holder>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </copyright>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </docinfo>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <refsynopsisdiv>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <cmdsynopsis>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <command>dnssec-keygen</command>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>

62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <arg ><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>

62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>

62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <arg><option>-3</option></arg>

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

62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <arg><option>-C</option></arg>

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

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

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <arg><option>-e</option></arg>

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

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <arg><option>-G</option></arg>

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

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

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

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

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <arg><option>-k</option></arg>

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

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

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

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

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

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

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

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <arg><option>-z</option></arg>

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

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </cmdsynopsis>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </refsynopsisdiv>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <refsect1>

471bdba2108ce1967325d949b1bf2b6944ac3b68ludo <title>DESCRIPTION</title>

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

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

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

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

f5aaa49dba43db0e99f06476534a8749820515dbcsovant (Transaction Key) as defined in RFC 2930.

f5aaa49dba43db0e99f06476534a8749820515dbcsovant </para>

f5aaa49dba43db0e99f06476534a8749820515dbcsovant <para>

2cacab200fb387e290386593d9b2fca2e7beef33csovant The <option>name</option> of the key is specified on the command

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant line. For DNSSEC keys, this must match the name of the zone for

d81f6d00c343633159fc5ea08599d145135612c0ludovicp which the key is being generated.

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </para>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </refsect1>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <refsect1>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <title>OPTIONS</title>

d81f6d00c343633159fc5ea08599d145135612c0ludovicp

d81f6d00c343633159fc5ea08599d145135612c0ludovicp <variablelist>

2cacab200fb387e290386593d9b2fca2e7beef33csovant <varlistentry>

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

2cacab200fb387e290386593d9b2fca2e7beef33csovant <listitem>

2cacab200fb387e290386593d9b2fca2e7beef33csovant <para>

2cacab200fb387e290386593d9b2fca2e7beef33csovant Selects the cryptographic algorithm. For DNSSEC keys, the value

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

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

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

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

7f086ee299e1aac25ddd618b5c33c74a26d14beegary.williams case insensitive.

e9b001c71b6faae15a50ff2612396796556120c3gary.williams </para>

23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>

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

90504765059fc59c00f751b5f482c87521fab4cfgary.williams default, unless the <option>-3</option> option is specified,

62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift in which case NSEC3RSASHA1 will be used instead.

7105a7fae63b264b6fab32f41a1990c75bfdf524csovant </para>

7105a7fae63b264b6fab32f41a1990c75bfdf524csovant <para>

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

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

ff542c9adb1e1f109168c9a12ad118e4038196c8csovant mandatory.

f9fdabbe3ac731fa9c04b95ec6864f6b0e2c34a2csovant </para>

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

<listitem>

<para>

Uses a crypto hardware (OpenSSL engine) for random number

and, when supported, key generation. When compiled with PKCS#11

support it defaults to pcks11, the empty name resets it to

no engine.

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

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