3393N/A<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">

3393N/A

3393N/A

3393N/A<refentry>

3393N/A <refentryinfo>

3393N/A <date>June 30, 2000</date>

3393N/A </refentryinfo>

3393N/A

3393N/A <refmeta>

3393N/A <refentrytitle><application>dnssec-keygen</application></refentrytitle>

3393N/A <manvolnum>8</manvolnum>

3393N/A <refmiscinfo>BIND9</refmiscinfo>

3393N/A </refmeta>

3393N/A

3393N/A <refnamediv>

3393N/A <refname><application>dnssec-keygen</application></refname>

3393N/A <refpurpose>DNSSEC key generation tool</refpurpose>

3393N/A </refnamediv>

3393N/A

3393N/A <refsynopsisdiv>

3393N/A <cmdsynopsis>

3393N/A <command>dnssec-keygen</command>

3393N/A <arg choice="req">-a <replaceable class="parameter">algorithm</replaceable></arg>

3393N/A <arg choice="req">-b <replaceable class="parameter">keysize</replaceable></arg>

3393N/A <arg choice="req">-n <replaceable class="parameter">nametype</replaceable></arg>

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

3393N/A <arg><option>-e</option></arg>

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

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

3393N/A <arg><option>-h</option></arg>

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

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

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

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

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

3393N/A <arg choice="req">name</arg>

3393N/A </cmdsynopsis>

3393N/A </refsynopsisdiv>

3393N/A

3393N/A <refsect1>

3393N/A <title>DESCRIPTION</title>

3393N/A <para>

3393N/A <command>dnssec-keygen</command> generates keys for DNSSEC

3393N/A (Secure DNS), as defined in RFC 2535. It can also generate

3393N/A keys for use with TSIG (Transaction Signatures), as

3393N/A defined in RFC 2845.

3393N/A </para>

3393N/A </refsect1>

3393N/A

3393N/A <refsect1>

3393N/A <title>OPTIONS</title>

3393N/A

3393N/A <variablelist>

3393N/A <varlistentry>

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

3393N/A <listitem>

3393N/A <para>

3393N/A Selects the cryptographic algorithm. The value of

3393N/A <option>algorithm</option> must be one of RSAMD5 or RSA,

3393N/A DSA, DH (Diffie Hellman), or HMAC-MD5. These values

3393N/A are case insensitive.

3393N/A </para>

3393N/A <para>

3393N/A Note that for DNSSEC, DSA is a mandatory to implement algorithm,

3393N/A and RSA is recommended. For TSIG, HMAC-MD5 is mandatory.

3393N/A </para>

3393N/A </listitem>

3393N/A </varlistentry>

3393N/A

3393N/A <varlistentry>

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

3393N/A <listitem>

3393N/A <para>

3393N/A Specifies the number of bits in the key. The choice of key

3393N/A size depends on the algorithm used. RSA keys must be between

3393N/A 512 and 2048 bits. Diffie Hellman keys must be between

3393N/A 128 and 4096 bits. DSA keys must be between 512 and 1024

3393N/A bits and an exact multiple of 64. HMAC-MD5 keys must be

3393N/A between 1 and 512 bits.

3393N/A </para>

3393N/A </listitem>

3393N/A </varlistentry>

3393N/A

3393N/A <varlistentry>

3393N/A <term>-n <replaceable class="parameter">nametype</replaceable></term>

3393N/A <listitem>

3393N/A <para>

3393N/A Specifies the owner type of the key. The value of

3393N/A <option>nametype</option> must either be ZONE (for a DNSSEC

3393N/A zone key), HOST or ENTITY (for a key associated with a host),

3393N/A or USER (for a key associated with a user). These values are

3393N/A case insensitive.

3393N/A </para>

3393N/A </listitem>

3393N/A </varlistentry>

3393N/A

3393N/A <varlistentry>

3393N/A <term>-c <replaceable class="parameter">class</replaceable></term>

3393N/A <listitem>

3393N/A <para>

3393N/A Indicates that the DNS record containing the key should have

3393N/A the specified class. If not specified, class IN is used.

3393N/A </para>

3393N/A </listitem>

3393N/A </varlistentry>

3393N/A

3393N/A <varlistentry>

3393N/A <term>-e</term>

3393N/A <listitem>

3393N/A <para>

3393N/A If generating an RSA key, use a large exponent.

3393N/A </para>

3393N/A </listitem>

3393N/A </varlistentry>

3393N/A

3393N/A <varlistentry>

3393N/A <term>-f <replaceable class="parameter">flag</replaceable></term>

3393N/A <listitem>

3393N/A <para>

3393N/A Set the specified flag in the flag field of the key record.

3393N/A The only recognized flag is KSK (Key Signing Key).

3393N/A </para>

3393N/A </listitem>

3393N/A </varlistentry>

3393N/A

3393N/A <varlistentry>

3393N/A <term>-g <replaceable class="parameter">generator</replaceable></term>

3393N/A <listitem>

3393N/A <para>

3393N/A If generating a Diffie Hellman key, use this generator.

3393N/A Allowed values are 2 and 5. If no generator

3393N/A is specified, a known prime from RFC 2539 will be used

3393N/A if possible; otherwise the default is 2.

3393N/A </para>

3393N/A </listitem>

3393N/A </varlistentry>

3393N/A

3393N/A <varlistentry>

3393N/A <term>-h</term>

3393N/A <listitem>

3393N/A <para>

3393N/A Prints a short summary of the options and arguments to

3393N/A <command>dnssec-keygen</command>.

3393N/A </para>

3393N/A </listitem>

3393N/A </varlistentry>

3393N/A

3393N/A <varlistentry>

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

3393N/A <listitem>

3393N/A <para>

3393N/A Sets the protocol value for the generated key. The protocol

3393N/A is a number between 0 and 255. The default is 3 (DNSSEC).

3393N/A Other possible values for this argument are listed in

3393N/A RFC 2535 and its successors.

3393N/A </para>

3393N/A </listitem>

3393N/A </varlistentry>

3393N/A

3393N/A <varlistentry>

3393N/A <term>-r <replaceable class="parameter">randomdev</replaceable></term>

3393N/A <listitem>

3393N/A <para>

3393N/A 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. These strings can be used as arguments

to <command>dnssec-makekeyset</command>.

</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 file, 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 algorithm 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-makekeyset</refentrytitle>

<manvolnum>8</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>dnssec-signkey</refentrytitle>

<manvolnum>8</manvolnum>

</citerefentry>,

<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 Software Consortium</corpauthor>

</para>

</refsect1>

</refentry>