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

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

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk [<!ENTITY mdash "&#8212;">]>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

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

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <refentryinfo>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <date>June 30, 2000</date>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </refentryinfo>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <refmeta>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <refentrytitle><application>dnssec-keygen</application></refentrytitle>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <manvolnum>8</manvolnum>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <refmiscinfo>BIND9</refmiscinfo>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </refmeta>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <refnamediv>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <refname><application>dnssec-keygen</application></refname>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <refpurpose>DNSSEC key generation tool</refpurpose>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </refnamediv>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <docinfo>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <copyright>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <year>2004</year>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <year>2005</year>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <year>2007</year>

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

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </copyright>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <copyright>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <year>2000</year>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <year>2001</year>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <year>2002</year>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <year>2003</year>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <holder>Internet Software Consortium.</holder>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </copyright>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </docinfo>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <refsynopsisdiv>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <cmdsynopsis>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <command>dnssec-keygen</command>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg choice="req">-a <replaceable class="parameter">algorithm</replaceable></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg choice="req">-b <replaceable class="parameter">keysize</replaceable></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg choice="req">-n <replaceable class="parameter">nametype</replaceable></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-e</option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-f <replaceable class="parameter">flag</replaceable></option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-g <replaceable class="parameter">generator</replaceable></option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-h</option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-k</option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-s <replaceable class="parameter">strength</replaceable></option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <arg choice="req">name</arg>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </cmdsynopsis>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </refsynopsisdiv>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <refsect1>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <title>DESCRIPTION</title>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <para><command>dnssec-keygen</command>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk generates keys for DNSSEC (Secure DNS), as defined in RFC 2535

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

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk TSIG (Transaction Signatures), as defined in RFC 2845.

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </refsect1>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <refsect1>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <title>OPTIONS</title>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <variablelist>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <term>-a <replaceable class="parameter">algorithm</replaceable></term>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Selects the cryptographic algorithm. The value of

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <option>algorithm</option> must be one of RSAMD5 (RSA) or RSASHA1,

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk DSA, DH (Diffie Hellman), or HMAC-MD5. These values

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk are case insensitive.

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk algorithm,

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk and DSA is recommended. For TSIG, HMAC-MD5 is mandatory.

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Note 2: HMAC-MD5 and DH automatically set the -k flag.

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <term>-b <replaceable class="parameter">keysize</replaceable></term>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Specifies the number of bits in the key. The choice of key

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

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk between

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk 512 and 2048 bits. Diffie Hellman keys must be between

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

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

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk between 1 and 512 bits.

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <term>-n <replaceable class="parameter">nametype</replaceable></term>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Specifies the owner type of the key. The value of

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <option>nametype</option> must either be ZONE (for a DNSSEC

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk a host (KEY)),

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk These values are case insensitive. Defaults to ZONE for DNSKEY

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk generation.

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <term>-c <replaceable class="parameter">class</replaceable></term>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Indicates that the DNS record containing the key should have

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk the specified class. If not specified, class IN is used.

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <term>-e</term>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <para>

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

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <term>-f <replaceable class="parameter">flag</replaceable></term>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Set the specified flag in the flag field of the KEY/DNSKEY record.

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk The only recognized flag is KSK (Key Signing Key) DNSKEY.

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </para>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </listitem>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk </varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <varlistentry>

4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <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</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 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">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>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 2535</citetitle>,

<citetitle>RFC 2845</citetitle>,

<citetitle>RFC 2539</citetitle>.

</para>

</refsect1>

<refsect1>

<title>AUTHOR</title>

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

</para>

</refsect1>

</refentry><!--