dnssec-keygen.docbook revision 37dee1ff94960a61243f611c0f87f8c316815c53
ff062a2768af33d794327e053abbb40f548545b8johanengelen<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow [<!ENTITY mdash "—">]>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow - Copyright (C) 2004, 2005, 2007-2010 Internet Systems Consortium, Inc. ("ISC")
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow - Copyright (C) 2000-2003 Internet Software Consortium.
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow - Permission to use, copy, modify, and/or distribute this software for any
ff062a2768af33d794327e053abbb40f548545b8johanengelen - purpose with or without fee is hereby granted, provided that the above
3c147b1dc203f9815cb45e24add22478e936d1e8verbalshadow - copyright notice and this permission notice appear in all copies.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow - PERFORMANCE OF THIS SOFTWARE.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow<!-- $Id: dnssec-keygen.docbook,v 1.36 2010/12/23 04:07:59 marka Exp $ -->
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <refentryinfo>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </refentryinfo>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <refentrytitle><application>dnssec-keygen</application></refentrytitle>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <refnamediv>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <refname><application>dnssec-keygen</application></refname>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <refpurpose>DNSSEC key generation tool</refpurpose>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </refnamediv>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </copyright>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </copyright>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <refsynopsisdiv>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <cmdsynopsis>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg ><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-n <replaceable class="parameter">nametype</replaceable></option></arg>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <arg><option>-A <replaceable class="parameter">date/offset</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-D <replaceable class="parameter">date/offset</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-E <replaceable class="parameter">engine</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-f <replaceable class="parameter">flag</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-g <replaceable class="parameter">generator</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-I <replaceable class="parameter">date/offset</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-i <replaceable class="parameter">interval</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-P <replaceable class="parameter">date/offset</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-p <replaceable class="parameter">protocol</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-R <replaceable class="parameter">date/offset</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-S <replaceable class="parameter">key</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-s <replaceable class="parameter">strength</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </cmdsynopsis>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </refsynopsisdiv>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow and RFC 4034. It can also generate keys for use with
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow (Transaction Key) as defined in RFC 2930.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow The <option>name</option> of the key is specified on the command
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow line. For DNSSEC keys, this must match the name of the zone for
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow which the key is being generated.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <variablelist>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-a <replaceable class="parameter">algorithm</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Selects the cryptographic algorithm. For DNSSEC keys, the value
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow of <option>algorithm</option> must be one of RSAMD5, RSASHA1,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512 or ECCGOST.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow case insensitive.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow If no algorithm is specified, then RSASHA1 will be used by
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow default, unless the <option>-3</option> option is specified,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow in which case NSEC3RSASHA1 will be used instead. (If
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <option>-3</option> is used and an algorithm is specified,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow that algorithm will be checked for compatibility with NSEC3.)
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow automatically set the -T KEY option.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-b <replaceable class="parameter">keysize</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Specifies the number of bits in the key. The choice of key
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow size depends on the algorithm used. RSA keys must be
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow between 512 and 2048 bits. Diffie Hellman keys must be between
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow 128 and 4096 bits. DSA keys must be between 512 and 1024
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow bits and an exact multiple of 64. HMAC keys must be
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow between 1 and 512 bits.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow The key size does not need to be specified if using a default
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow algorithm. The default key size is 1024 bits for zone signing
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow keys (ZSK's) and 2048 bits for key signing keys (KSK's,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow generated with <option>-f KSK</option>). However, if an
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow algorithm is explicitly specified with the <option>-a</option>,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow then there is no default key size, and the <option>-b</option>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow must be used.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-n <replaceable class="parameter">nametype</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Specifies the owner type of the key. The value of
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <option>nametype</option> must either be ZONE (for a DNSSEC
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow a host (KEY)),
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow These values are case insensitive. Defaults to ZONE for DNSKEY
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Use an NSEC3-capable algorithm to generate a DNSSEC key.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow If this option is used and no algorithm is explicitly
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow set on the command line, NSEC3RSASHA1 will be used by
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow default. Note that RSASHA256, RSASHA512 and ECCGOST algorithms
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow are NSEC3-capable.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Compatibility mode: generates an old-style key, without
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow any metadata. By default, <command>dnssec-keygen</command>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow will include the key's creation date in the metadata stored
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow with the private key, and other dates may be set there as well
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow (publication date, activation date, etc). Keys that include
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow this data may be incompatible with older versions of BIND; the
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-c <replaceable class="parameter">class</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Indicates that the DNS record containing the key should have
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow the specified class. If not specified, class IN is used.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-E <replaceable class="parameter">engine</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Uses a crypto hardware (OpenSSL engine) for random number
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow and, when supported, key generation. When compiled with PKCS#11
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow support it defaults to pkcs11; the empty name resets it to
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow If generating an RSAMD5/RSASHA1 key, use a large exponent.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-f <replaceable class="parameter">flag</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Set the specified flag in the flag field of the KEY/DNSKEY record.
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow The only recognized flags are KSK (Key Signing Key) and REVOKE.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Generate a key, but do not publish it or sign with it. This
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow option is incompatible with -P and -A.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-g <replaceable class="parameter">generator</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow If generating a Diffie Hellman key, use this generator.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Allowed values are 2 and 5. If no generator
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow is specified, a known prime from RFC 2539 will be used
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow if possible; otherwise the default is 2.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Prints a short summary of the options and arguments to
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-K <replaceable class="parameter">directory</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Sets the directory in which the key files are to be written.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Deprecated in favor of -T KEY.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-p <replaceable class="parameter">protocol</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Sets the protocol value for the generated key. The protocol
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow is a number between 0 and 255. The default is 3 (DNSSEC).
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Other possible values for this argument are listed in
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow RFC 2535 and its successors.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Quiet mode: Suppresses unnecessary output, including
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow progress indication. Without this option, when
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <command>dnssec-keygen</command> is run interactively
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow to generate an RSA or DSA key pair, it will print a string
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow of symbols to <filename>stderr</filename> indicating the
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow progress of the key generation. A '.' indicates that a
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow random number has been found which passed an initial
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow sieve test; '+' means a number has passed a single
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow round of the Miller-Rabin primality test; a space
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow means that the number has passed all the tests and is
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow a satisfactory key.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-r <replaceable class="parameter">randomdev</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Specifies the source of randomness. If the operating
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow system does not provide a <filename>/dev/random</filename>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow or equivalent device, the default source of randomness
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow is keyboard input. <filename>randomdev</filename>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow the name of a character device or file containing random
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow data to be used instead of the default. The special value
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <filename>keyboard</filename> indicates that keyboard
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow input should be used.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-S <replaceable class="parameter">key</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Create a new key which is an explicit successor to an
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow existing key. The name, algorithm, size, and type of the
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow key will be set to match the existing key. The activation
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow date of the new key will be set to the inactivation date of
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow the existing one. The publication date will be set to the
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow activation date minus the prepublication interval, which
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow defaults to 30 days.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-s <replaceable class="parameter">strength</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Specifies the strength value of the key. The strength is
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow a number between 0 and 15, and currently has no defined
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow purpose in DNSSEC.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-T <replaceable class="parameter">rrtype</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Specifies the resource record type to use for the key.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <option>rrtype</option> must be either DNSKEY or KEY. The
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow default is DNSKEY when using a DNSSEC algorithm, but it can be
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow overridden to KEY for use with SIG(0).
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Using any TSIG algorithm (HMAC-* or DH) forces this option
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-t <replaceable class="parameter">type</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Indicates the use of the key. <option>type</option> must be
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow is AUTHCONF. AUTH refers to the ability to authenticate
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow data, and CONF the ability to encrypt data.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-v <replaceable class="parameter">level</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Sets the debugging level.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </variablelist>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow If the argument begins with a '+' or '-', it is interpreted as
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow an offset from the present time. For convenience, if such an offset
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow then the offset is computed in years (defined as 365 24-hour days,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow ignoring leap years), months (defined as 30 24-hour days), weeks,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow days, hours, or minutes, respectively. Without a suffix, the offset
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow is computed in seconds.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <variablelist>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-P <replaceable class="parameter">date/offset</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Sets the date on which a key is to be published to the zone.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow After that date, the key will be included in the zone but will
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow not be used to sign it. If not set, and if the -G option has
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow not been used, the default is "now".
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-A <replaceable class="parameter">date/offset</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Sets the date on which the key is to be activated. After that
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow date, the key will be included in the zone and used to sign
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow it. If not set, and if the -G option has not been used, the
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow default is "now".
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-R <replaceable class="parameter">date/offset</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Sets the date on which the key is to be revoked. After that
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow date, the key will be flagged as revoked. It will be included
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow in the zone and will be used to sign it.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-I <replaceable class="parameter">date/offset</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Sets the date on which the key is to be retired. After that
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow date, the key will still be included in the zone, but it
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow will not be used to sign it.
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-D <replaceable class="parameter">date/offset</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Sets the date on which the key is to be deleted. After that
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow date, the key will no longer be included in the zone. (It
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow may remain in the key repository, however.)
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow </varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <varlistentry>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow <term>-i <replaceable class="parameter">interval</replaceable></term>
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow Sets the prepublication interval for a key. If set, then
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow the publication and activation dates must be separated by at least
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow this much time. If the activation date is specified but the
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow publication date isn't, then the publication date will default
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow to this much time before the activation date; conversely, if
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow the publication date is specified but activation date isn't,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow then activation will be set to this much time after publication.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow If the key is being created as an explicit successor to another
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow key, then the default prepublication interval is 30 days;
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow otherwise it is zero.
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow As with date offsets, if the argument is followed by one of
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow interval is measured in years, months, weeks, days, hours,
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow or minutes, respectively. Without a suffix, the interval is
f79096fa559ff21d316e9f2561d982ba25b70986verbalshadow measured in seconds.
fb48f2d077b22740e62995c9fdb2cbd3251d153dverbalshadow </varlistentry>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow </variablelist>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow When <command>dnssec-keygen</command> completes
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow successfully,
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow it prints a string of the form <filename>Knnnn.+aaa+iiiii</filename>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow to the standard output. This is an identification string for
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow the key it has generated.
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <itemizedlist>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <para><filename>nnnn</filename> is the key name.
6570f8d51a024c24544ef162a76f15d2d2470de1verbalshadow <para><filename>aaa</filename> is the numeric representation
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <para><filename>iiiii</filename> is the key identifier (or
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow </itemizedlist>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow creates two files, with names based
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow on the printed string. <filename>Knnnn.+aaa+iiiii.key</filename>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow contains the public key, and
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <filename>Knnnn.+aaa+iiiii.private</filename> contains the
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow The <filename>.key</filename> file contains a DNS KEY record
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow can be inserted into a zone file (directly or with a $INCLUDE
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow The <filename>.private</filename> file contains
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow algorithm-specific
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow fields. For obvious security reasons, this file does not have
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow general read permission.
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow Both <filename>.key</filename> and <filename>.private</filename>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow files are generated for symmetric encryption algorithms such as
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow HMAC-MD5, even though the public and private key are equivalent.
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow To generate a 768-bit DSA key for the domain
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <userinput>example.com</userinput>, the following command would be
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <para><userinput>dnssec-keygen -a DSA -b 768 -n ZONE example.com</userinput>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow The command would print a string of the form:
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <para><userinput>Kexample.com.+003+26160</userinput>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow In this example, <command>dnssec-keygen</command> creates
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow the files <filename>Kexample.com.+003+26160.key</filename>
09c5fb3f2c6c797cb91d3a8d5ae0ff62ab1b301everbalshadow <filename>Kexample.com.+003+26160.private</filename>.
ff062a2768af33d794327e053abbb40f548545b8johanengelen <refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
ccaa842a0dc9cbeb8214cf55f3b454713f084477verbalshadow </citerefentry>,
d9193e62c7b56f295e16cf2212401cff13ad254everbalshadow <citetitle>BIND 9 Administrator Reference Manual</citetitle>,