9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-keygen">

9b2bd54c98edb185a3985410367754ab33217362bnicholes <info>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <date>2014-02-06</date>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </info>

70953fb44a7140fe206c3a5f011e24209c8c5c6abnicholes <refentryinfo>

70953fb44a7140fe206c3a5f011e24209c8c5c6abnicholes <corpname>ISC</corpname>

70953fb44a7140fe206c3a5f011e24209c8c5c6abnicholes <corpauthor>Internet Systems Consortium, Inc.</corpauthor>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </refentryinfo>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <refmeta>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <refentrytitle><application>dnssec-keygen</application></refentrytitle>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <manvolnum>8</manvolnum>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <refmiscinfo>BIND9</refmiscinfo>

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes </refmeta>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <refnamediv>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <refname><application>dnssec-keygen</application></refname>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <refpurpose>DNSSEC key generation tool</refpurpose>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </refnamediv>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <docinfo>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <copyright>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2004</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2005</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2007</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2008</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2009</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2010</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2011</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2012</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2014</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2015</year>

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes </copyright>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <copyright>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2000</year>

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes <year>2001</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2002</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <year>2003</year>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <holder>Internet Software Consortium.</holder>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </copyright>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </docinfo>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes <refsynopsisdiv>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <cmdsynopsis sepchar=" ">

9b2bd54c98edb185a3985410367754ab33217362bnicholes <command>dnssec-keygen</command>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-3</option></arg>

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes <arg choice="opt" rep="norepeat"><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-C</option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-E <replaceable class="parameter">engine</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">flag</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-G</option></arg>

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes <arg choice="opt" rep="norepeat"><option>-g <replaceable class="parameter">generator</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-h</option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">interval</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">ttl</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-k</option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-q</option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-S <replaceable class="parameter">key</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">strength</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">type</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-v <replaceable class="parameter">level</replaceable></option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-V</option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="opt" rep="norepeat"><option>-z</option></arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <arg choice="req" rep="norepeat">name</arg>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </cmdsynopsis>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </refsynopsisdiv>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <refsection><info><title>DESCRIPTION</title></info>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

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

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

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

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes (Transaction Key) as defined in RFC 2930.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes The <option>name</option> of the key is specified on the command

9b2bd54c98edb185a3985410367754ab33217362bnicholes line. For DNSSEC keys, this must match the name of the zone for

9b2bd54c98edb185a3985410367754ab33217362bnicholes which the key is being generated.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </refsection>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <refsection><info><title>OPTIONS</title></info>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes <variablelist>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <varlistentry>

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes <listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes Selects the cryptographic algorithm. For DNSSEC keys, the value

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,

9b2bd54c98edb185a3985410367754ab33217362bnicholes ECDSAP256SHA256 or ECDSAP384SHA384.

9b2bd54c98edb185a3985410367754ab33217362bnicholes For TSIG/TKEY, the value must

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

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes case insensitive.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

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

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes in which case NSEC3RSASHA1 will be used instead. (If

9b2bd54c98edb185a3985410367754ab33217362bnicholes <option>-3</option> is used and an algorithm is specified,

9b2bd54c98edb185a3985410367754ab33217362bnicholes that algorithm will be checked for compatibility with NSEC3.)

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

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

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes mandatory.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes <para>

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes automatically set the -T KEY option.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes <varlistentry>

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes <listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes size depends on the algorithm used. RSA keys must be

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

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes bits and an exact multiple of 64. HMAC keys must be

9b2bd54c98edb185a3985410367754ab33217362bnicholes between 1 and 512 bits. Elliptic curve algorithms don't need

9b2bd54c98edb185a3985410367754ab33217362bnicholes this parameter.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

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

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes keys (ZSKs) and 2048 bits for key signing keys (KSKs,

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

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

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes must be used.

bf1e7c075ccc3e6597d17de7641332ff6ff92e8astriker </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </listitem>

f628b5980b3f4ae688b70ae449a1f50aea687384bnicholes </varlistentry>

f628b5980b3f4ae688b70ae449a1f50aea687384bnicholes

f628b5980b3f4ae688b70ae449a1f50aea687384bnicholes <varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <term>-n <replaceable class="parameter">nametype</replaceable></term>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes Specifies the owner type of the key. The value of

9b2bd54c98edb185a3985410367754ab33217362bnicholes <option>nametype</option> must either be ZONE (for a DNSSEC

9b2bd54c98edb185a3985410367754ab33217362bnicholes zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with

9b2bd54c98edb185a3985410367754ab33217362bnicholes a host (KEY)),

9b2bd54c98edb185a3985410367754ab33217362bnicholes USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes These values are case insensitive. Defaults to ZONE for DNSKEY

9b2bd54c98edb185a3985410367754ab33217362bnicholes generation.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <term>-3</term>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes Use an NSEC3-capable algorithm to generate a DNSSEC key.

9b2bd54c98edb185a3985410367754ab33217362bnicholes If this option is used and no algorithm is explicitly

9b2bd54c98edb185a3985410367754ab33217362bnicholes set on the command line, NSEC3RSASHA1 will be used by

9b2bd54c98edb185a3985410367754ab33217362bnicholes default. Note that RSASHA256, RSASHA512, ECCGOST,

9b2bd54c98edb185a3985410367754ab33217362bnicholes ECDSAP256SHA256 and ECDSAP384SHA384 algorithms

9b2bd54c98edb185a3985410367754ab33217362bnicholes are NSEC3-capable.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <term>-C</term>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes Compatibility mode: generates an old-style key, without

9b2bd54c98edb185a3985410367754ab33217362bnicholes any metadata. By default, <command>dnssec-keygen</command>

9b2bd54c98edb185a3985410367754ab33217362bnicholes will include the key's creation date in the metadata stored

9b2bd54c98edb185a3985410367754ab33217362bnicholes with the private key, and other dates may be set there as well

9b2bd54c98edb185a3985410367754ab33217362bnicholes (publication date, activation date, etc). Keys that include

9b2bd54c98edb185a3985410367754ab33217362bnicholes this data may be incompatible with older versions of BIND; the

9b2bd54c98edb185a3985410367754ab33217362bnicholes <option>-C</option> option suppresses them.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <term>-c <replaceable class="parameter">class</replaceable></term>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes Indicates that the DNS record containing the key should have

9b2bd54c98edb185a3985410367754ab33217362bnicholes the specified class. If not specified, class IN is used.

104b0ed445d0cb91b55b8bdd80fa95f3bbc22d15bnicholes </para>

104b0ed445d0cb91b55b8bdd80fa95f3bbc22d15bnicholes </listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

609ef720afd62ca63391c9fdb415cd2faf29aa46bnicholes <varlistentry>

609ef720afd62ca63391c9fdb415cd2faf29aa46bnicholes <term>-E <replaceable class="parameter">engine</replaceable></term>

609ef720afd62ca63391c9fdb415cd2faf29aa46bnicholes <listitem>

609ef720afd62ca63391c9fdb415cd2faf29aa46bnicholes <para>

609ef720afd62ca63391c9fdb415cd2faf29aa46bnicholes Specifies the cryptographic hardware to use, when applicable.

609ef720afd62ca63391c9fdb415cd2faf29aa46bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes When BIND is built with OpenSSL PKCS#11 support, this defaults

9b2bd54c98edb185a3985410367754ab33217362bnicholes to the string "pkcs11", which identifies an OpenSSL engine

9b2bd54c98edb185a3985410367754ab33217362bnicholes that can drive a cryptographic accelerator or hardware service

9b2bd54c98edb185a3985410367754ab33217362bnicholes module. When BIND is built with native PKCS#11 cryptography

9b2bd54c98edb185a3985410367754ab33217362bnicholes (--enable-native-pkcs11), it defaults to the path of the PKCS#11

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes provider library specified via "--with-pkcs11".

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <varlistentry>

be06f010941d039a422f1bbd7e321a1a0e92e291bnicholes <term>-f <replaceable class="parameter">flag</replaceable></term>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes Set the specified flag in the flag field of the KEY/DNSKEY record.

9b2bd54c98edb185a3985410367754ab33217362bnicholes The only recognized flags are KSK (Key Signing Key) and REVOKE.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <term>-G</term>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes Generate a key, but do not publish it or sign with it. This

9b2bd54c98edb185a3985410367754ab33217362bnicholes option is incompatible with -P and -A.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </varlistentry>

9b2bd54c98edb185a3985410367754ab33217362bnicholes

9b2bd54c98edb185a3985410367754ab33217362bnicholes <varlistentry>

bdcbf81429c581d9d1d0c7cb11634a78e424c140bnicholes <term>-g <replaceable class="parameter">generator</replaceable></term>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <listitem>

9b2bd54c98edb185a3985410367754ab33217362bnicholes <para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes If generating a Diffie Hellman key, use this generator.

9b2bd54c98edb185a3985410367754ab33217362bnicholes Allowed values are 2 and 5. If no generator

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

9b2bd54c98edb185a3985410367754ab33217362bnicholes if possible; otherwise the default is 2.

9b2bd54c98edb185a3985410367754ab33217362bnicholes </para>

9b2bd54c98edb185a3985410367754ab33217362bnicholes </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>-L <replaceable class="parameter">ttl</replaceable></term>

<listitem>

<para>

Sets the default TTL to use for this key when it is converted

into a DNSKEY RR. If the key is imported into a zone,

this is the TTL that will be used for it, unless there was

already a DNSKEY RRset in place, in which case the existing TTL

would take precedence. If this value is not set and there

is no existing DNSKEY RRset, the TTL will default to the

SOA TTL. Setting the default TTL to <literal>0</literal>

or <literal>none</literal> is the same as leaving it unset.

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

<listitem>

<para>

Quiet mode: Suppresses unnecessary output, including

progress indication. Without this option, when

<command>dnssec-keygen</command> is run interactively

to generate an RSA or DSA key pair, it will print a string

of symbols to <filename>stderr</filename> indicating the

progress of the key generation. A '.' indicates that a

random number has been found which passed an initial

sieve test; '+' means a number has passed a single

round of the Miller-Rabin primality test; a space

means that the number has passed all the tests and is

a satisfactory key.

</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">key</replaceable></term>

<listitem>

<para>

Create a new key which is an explicit successor to an

existing key. The name, algorithm, size, and type of the

key will be set to match the existing key. The activation

date of the new key will be set to the inactivation date of

the existing one. The publication date will be set to the

activation date minus the prepublication interval, which

defaults to 30 days.

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

<varlistentry>

<term>-V</term>

<listitem>

<para>

Prints version information.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsection>

<refsection><info><title>TIMING OPTIONS</title></info>

<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. To explicitly prevent a date from being

set, use 'none' or 'never'.

</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". If set, if and -P is not set, then

the publication date will be set to the activation date

minus the prepublication interval.

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

<varlistentry>

<term>-i <replaceable class="parameter">interval</replaceable></term>

<listitem>

<para>

Sets the prepublication interval for a key. If set, then

the publication and activation dates must be separated by at least

this much time. If the activation date is specified but the

publication date isn't, then the publication date will default

to this much time before the activation date; conversely, if

the publication date is specified but activation date isn't,

then activation will be set to this much time after publication.

</para>

<para>

If the key is being created as an explicit successor to another

key, then the default prepublication interval is 30 days;

otherwise it is zero.

</para>

<para>

As with date offsets, if the argument is followed by one of

the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the

interval is measured in years, months, weeks, days, hours,

or minutes, respectively. Without a suffix, the interval is

measured in seconds.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsection>

<refsection><info><title>GENERATED KEYS</title></info>

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

</refsection>

<refsection><info><title>EXAMPLE</title></info>

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

</refsection>

<refsection><info><title>SEE ALSO</title></info>

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

</para>

</refsection>

</refentry>