dnssec-keygen.docbook revision eab9975bcf5830a73f18ed8f320ae18ea32775ee
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai [<!ENTITY mdash "—">]>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - Copyright (C) 2004, 2005, 2007-2009 Internet Systems Consortium, Inc. ("ISC")
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - Copyright (C) 2000-2003 Internet Software Consortium.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - Permission to use, copy, modify, and/or distribute this software for any
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - purpose with or without fee is hereby granted, provided that the above
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - copyright notice and this permission notice appear in all copies.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai - PERFORMANCE OF THIS SOFTWARE.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai<!-- $Id: dnssec-keygen.docbook,v 1.27 2009/09/02 06:29:00 each Exp $ -->
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <refentryinfo>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai </refentryinfo>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <refentrytitle><application>dnssec-keygen</application></refentrytitle>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <refname><application>dnssec-keygen</application></refname>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <refpurpose>DNSSEC key generation tool</refpurpose>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <holder>Internet Software Consortium.</holder>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <refsynopsisdiv>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg ><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-f <replaceable class="parameter">flag</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-g <replaceable class="parameter">generator</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-s <replaceable class="parameter">strength</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-U <replaceable class="parameter">date/offset</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai </cmdsynopsis>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai </refsynopsisdiv>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai and RFC 4034. It can also generate keys for use with
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai (Transaction Key) as defined in RFC 2930.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai The <option>name</option> of the key is specified on the command
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai line. For DNSSEC keys, this must match the name of the zone for
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai which the key is being generated.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <variablelist>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <varlistentry>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <term>-a <replaceable class="parameter">algorithm</replaceable></term>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai Selects the cryptographic algorithm. For DNSSEC keys, the value
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai of <option>algorithm</option> must be one of RSAMD5, RSASHA1,
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai DSA, NSEC3RSASHA1, or NSEC3DSA. For TSIG/TKEY, the value must
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai case insensitive.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai If no algorithm is specified, then RSASHA1 will be used by
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai default, unless the <option>-3</option> option is specified,
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai in which case NSEC3RSASHA1 will be used instead.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai automatically set the -T KEY option.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai </varlistentry>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <varlistentry>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai <term>-b <replaceable class="parameter">keysize</replaceable></term>
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai Specifies the number of bits in the key. The choice of key
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai size depends on the algorithm used. RSAMD5 / RSASHA1 keys must be
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai between 512 and 2048 bits. Diffie Hellman keys must be between
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai 128 and 4096 bits. DSA keys must be between 512 and 1024
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai bits and an exact multiple of 64. HMAC-MD5 keys must be
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai between 1 and 512 bits.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai The key size does not need to be specified if using a default