3853N/A - Copyright (C) 2004-2010 Internet Systems Consortium, Inc. ("ISC") 3853N/A - Copyright (C) 2000-2003 Internet Software Consortium. 3853N/A - Permission to use, copy, modify, and/or distribute this software for any 3853N/A - purpose with or without fee is hereby granted, provided that the above 3853N/A - copyright notice and this permission notice appear in all copies. 3853N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 3853N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 3853N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 3853N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 3853N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 3853N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 3853N/A - PERFORMANCE OF THIS SOFTWARE. 3853N/A<
meta http-
equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3853N/A<
title>dnssec-keygen</
title>
3853N/A<
meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
3853N/A<
link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
3853N/A<
body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
3853N/A<
table width="100%" summary="Navigation header">
3853N/A<
tr><
th colspan="3" align="center"><
span class="application">dnssec-keygen</
span></
th></
tr>
3853N/A<
td width="20%" align="left">
3853N/A<
th width="60%" align="center">Manual pages</
th>
3853N/A<
div class="refentry" lang="en">
3853N/A<
p><
span class="application">dnssec-keygen</
span> — DNSSEC key generation tool</
p>
3853N/A<
div class="refsynopsisdiv">
3853N/A<
div class="cmdsynopsis"><
p><
code class="command">dnssec-keygen</
code> [<
code class="option">-a <
em class="replaceable"><
code>algorithm</
code></
em></
code>] [<
code class="option">-b <
em class="replaceable"><
code>keysize</
code></
em></
code>] [<
code class="option">-n <
em class="replaceable"><
code>nametype</
code></
em></
code>] [<
code class="option">-3</
code>] [<
code class="option">-A <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>] [<
code class="option">-C</
code>] [<
code class="option">-c <
em class="replaceable"><
code>class</
code></
em></
code>] [<
code class="option">-D <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>] [<
code class="option">-E <
em class="replaceable"><
code>engine</
code></
em></
code>] [<
code class="option">-e</
code>] [<
code class="option">-f <
em class="replaceable"><
code>flag</
code></
em></
code>] [<
code class="option">-G</
code>] [<
code class="option">-g <
em class="replaceable"><
code>generator</
code></
em></
code>] [<
code class="option">-h</
code>] [<
code class="option">-I <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>] [<
code class="option">-i <
em class="replaceable"><
code>interval</
code></
em></
code>] [<
code class="option">-K <
em class="replaceable"><
code>directory</
code></
em></
code>] [<
code class="option">-k</
code>] [<
code class="option">-P <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>] [<
code class="option">-p <
em class="replaceable"><
code>protocol</
code></
em></
code>] [<
code class="option">-q</
code>] [<
code class="option">-R <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>] [<
code class="option">-r <
em class="replaceable"><
code>randomdev</
code></
em></
code>] [<
code class="option">-S <
em class="replaceable"><
code>key</
code></
em></
code>] [<
code class="option">-s <
em class="replaceable"><
code>strength</
code></
em></
code>] [<
code class="option">-t <
em class="replaceable"><
code>type</
code></
em></
code>] [<
code class="option">-v <
em class="replaceable"><
code>level</
code></
em></
code>] [<
code class="option">-z</
code>] {name}</
p></
div>
3853N/A<
div class="refsect1" lang="en">
3853N/A<
a name="id2613067"></
a><
h2>DESCRIPTION</
h2>
3853N/A<
p><
span><
strong class="command">dnssec-keygen</
strong></
span>
3853N/A generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
3853N/A and RFC 4034. It can also generate keys for use with
3853N/A TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
3853N/A (Transaction Key) as defined in RFC 2930.
3853N/A The <
code class="option">name</
code> of the key is specified on the command
3853N/A line. For DNSSEC keys, this must match the name of the zone for
3853N/A which the key is being generated.
3853N/A<
div class="refsect1" lang="en">
3853N/A<
a name="id2613088"></
a><
h2>OPTIONS</
h2>
3853N/A<
div class="variablelist"><
dl>
3853N/A<
dt><
span class="term">-a <
em class="replaceable"><
code>algorithm</
code></
em></
span></
dt>
3853N/A Selects the cryptographic algorithm. For DNSSEC keys, the value
3853N/A of <
code class="option">algorithm</
code> must be one of RSAMD5, RSASHA1,
3853N/A DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256 or RSASHA512.
3853N/A be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
3853N/A HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
3853N/A If no algorithm is specified, then RSASHA1 will be used by
3853N/A default, unless the <
code class="option">-3</
code> option is specified,
3853N/A in which case NSEC3RSASHA1 will be used instead. (If
3853N/A <
code class="option">-3</
code> is used and an algorithm is specified,
3853N/A that algorithm will be checked for compatibility with NSEC3.)
3853N/A Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
3853N/A algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
3853N/A Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
3853N/A automatically set the -T KEY option.
3853N/A<
dt><
span class="term">-b <
em class="replaceable"><
code>keysize</
code></
em></
span></
dt>
3853N/A Specifies the number of bits in the key. The choice of key
3853N/A size depends on the algorithm used. RSA keys must be
3853N/A between 512 and 2048 bits. Diffie Hellman keys must be between
3853N/A 128 and 4096 bits. DSA keys must be between 512 and 1024
3853N/A bits and an exact multiple of 64. HMAC keys must be
3853N/A The key size does not need to be specified if using a default
3853N/A algorithm. The default key size is 1024 bits for zone signing
3853N/A keys (ZSK's) and 2048 bits for key signing keys (KSK's,
3853N/A generated with <
code class="option">-f KSK</
code>). However, if an
3853N/A algorithm is explicitly specified with the <
code class="option">-a</
code>,
3853N/A then there is no default key size, and the <
code class="option">-b</
code>
3853N/A<
dt><
span class="term">-n <
em class="replaceable"><
code>nametype</
code></
em></
span></
dt>
3853N/A Specifies the owner type of the key. The value of
3853N/A <
code class="option">nametype</
code> must either be ZONE (for a DNSSEC
3853N/A USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
3853N/A These values are case insensitive. Defaults to ZONE for DNSKEY
3853N/A<
dt><
span class="term">-3</
span></
dt>
3853N/A Use an NSEC3-capable algorithm to generate a DNSSEC key.
3853N/A If this option is used and no algorithm is explicitly
3853N/A set on the command line, NSEC3RSASHA1 will be used by
3853N/A default. Note that RSASHA256 and RSASHA512 algorithms
3853N/A<
dt><
span class="term">-C</
span></
dt>
3853N/A Compatibility mode: generates an old-style key, without
3853N/A any metadata. By default, <
span><
strong class="command">dnssec-keygen</
strong></
span>
3853N/A will include the key's creation date in the metadata stored
3853N/A with the private key, and other dates may be set there as well
3853N/A (publication date, activation date, etc). Keys that include
3853N/A this data may be incompatible with older versions of BIND; the
3853N/A <
code class="option">-C</
code> option suppresses them.
3853N/A<
dt><
span class="term">-c <
em class="replaceable"><
code>class</
code></
em></
span></
dt>
3853N/A Indicates that the DNS record containing the key should have
3853N/A the specified class. If not specified, class IN is used.
3853N/A<
dt><
span class="term">-E <
em class="replaceable"><
code>engine</
code></
em></
span></
dt>
3853N/A Uses a crypto hardware (OpenSSL engine) for random number
3853N/A and, when supported, key generation. When compiled with PKCS#11
3853N/A support it defaults to pkcs11; the empty name resets it to
3853N/A<
dt><
span class="term">-e</
span></
dt>
3853N/A<
dt><
span class="term">-f <
em class="replaceable"><
code>flag</
code></
em></
span></
dt>
3853N/A The only recognized flags are KSK (Key Signing Key) and REVOKE.
3853N/A<
dt><
span class="term">-G</
span></
dt>
3853N/A Generate a key, but do not publish it or sign with it. This
3853N/A option is incompatible with -P and -A.
3853N/A<
dt><
span class="term">-g <
em class="replaceable"><
code>generator</
code></
em></
span></
dt>
3853N/A If generating a Diffie Hellman key, use this generator.
3853N/A Allowed values are 2 and 5. If no generator
3853N/A is specified, a known prime from RFC 2539 will be used
3853N/A if possible; otherwise the default is 2.
3853N/A<
dt><
span class="term">-h</
span></
dt>
3853N/A Prints a short summary of the options and arguments to
3853N/A <
span><
strong class="command">dnssec-keygen</
strong></
span>.
3853N/A<
dt><
span class="term">-K <
em class="replaceable"><
code>directory</
code></
em></
span></
dt>
3853N/A Sets the directory in which the key files are to be written.
3853N/A<
dt><
span class="term">-k</
span></
dt>
3853N/A Deprecated in favor of -T KEY.
3853N/A<
dt><
span class="term">-p <
em class="replaceable"><
code>protocol</
code></
em></
span></
dt>
3853N/A Sets the protocol value for the generated key. The protocol
3853N/A is a number between 0 and 255. The default is 3 (DNSSEC).
3853N/A Other possible values for this argument are listed in
3853N/A RFC 2535 and its successors.
3853N/A<
dt><
span class="term">-q</
span></
dt>
3853N/A Quiet mode: Suppresses unnecessary output, including
3853N/A progress indication. Without this option, when
3853N/A <
span><
strong class="command">dnssec-keygen</
strong></
span> is run interactively
3853N/A to generate an RSA or DSA key pair, it will print a string
3853N/A of symbols to <
code class="filename">stderr</
code> indicating the
3853N/A progress of the key generation. A '.' indicates that a
3853N/A random number has been found which passed an initial
3853N/A sieve test; '+' means a number has passed a single
3853N/A round of the Miller-Rabin primality test; a space
3853N/A means that the number has passed all the tests and is
3853N/A<
dt><
span class="term">-r <
em class="replaceable"><
code>randomdev</
code></
em></
span></
dt>
3853N/A Specifies the source of randomness. If the operating
3853N/A or equivalent device, the default source of randomness
3853N/A is keyboard input. <
code class="filename">randomdev</
code>
3853N/A the name of a character device or file containing random
3853N/A data to be used instead of the default. The special value
3853N/A <
code class="filename">keyboard</
code> indicates that keyboard
3853N/A<
dt><
span class="term">-S <
em class="replaceable"><
code>key</
code></
em></
span></
dt>
3853N/A Create a new key which is an explicit successor to an
3853N/A existing key. The name, algorithm, size, and type of the
3853N/A key will be set to match the existing key. The activation
3853N/A date of the new key will be set to the inactivation date of
3853N/A the existing one. The publication date will be set to the
3853N/A activation date minus the prepublication interval, which
3853N/A<
dt><
span class="term">-s <
em class="replaceable"><
code>strength</
code></
em></
span></
dt>
3853N/A Specifies the strength value of the key. The strength is
3853N/A a number between 0 and 15, and currently has no defined
3853N/A<
dt><
span class="term">-T <
em class="replaceable"><
code>rrtype</
code></
em></
span></
dt>
3853N/A Specifies the resource record type to use for the key.
3853N/A <
code class="option">rrtype</
code> must be either DNSKEY or KEY. The
3853N/A default is DNSKEY when using a DNSSEC algorithm, but it can be
3853N/A overridden to KEY for use with SIG(0).
3853N/A Using any TSIG algorithm (HMAC-* or DH) forces this option
3853N/A<
dt><
span class="term">-t <
em class="replaceable"><
code>type</
code></
em></
span></
dt>
3853N/A Indicates the use of the key. <
code class="option">type</
code> must be
3853N/A one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
3853N/A is AUTHCONF. AUTH refers to the ability to authenticate
3853N/A data, and CONF the ability to encrypt data.
3853N/A<
dt><
span class="term">-v <
em class="replaceable"><
code>level</
code></
em></
span></
dt>
3853N/A<
div class="refsect1" lang="en">
3853N/A<
a name="id2666578"></
a><
h2>TIMING OPTIONS</
h2>
3853N/A Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
3853N/A If the argument begins with a '+' or '-', it is interpreted as
3853N/A an offset from the present time. For convenience, if such an offset
3853N/A is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
3853N/A then the offset is computed in years (defined as 365 24-hour days,
3853N/A ignoring leap years), months (defined as 30 24-hour days), weeks,
3853N/A days, hours, or minutes, respectively. Without a suffix, the offset
3853N/A<
div class="variablelist"><
dl>
3853N/A<
dt><
span class="term">-P <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
3853N/A Sets the date on which a key is to be published to the zone.
3853N/A After that date, the key will be included in the zone but will
3853N/A not be used to sign it. If not set, and if the -G option has
3853N/A not been used, the default is "now".
3853N/A<
dt><
span class="term">-A <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
3853N/A Sets the date on which the key is to be activated. After that
3853N/A date, the key will be included in the zone and used to sign
3853N/A it. If not set, and if the -G option has not been used, the
3853N/A<
dt><
span class="term">-R <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
3853N/A Sets the date on which the key is to be revoked. After that
3853N/A date, the key will be flagged as revoked. It will be included
3853N/A in the zone and will be used to sign it.
3853N/A<
dt><
span class="term">-I <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
3853N/A Sets the date on which the key is to be retired. After that
3853N/A date, the key will still be included in the zone, but it
3853N/A will not be used to sign it.
3853N/A<
dt><
span class="term">-D <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
3853N/A Sets the date on which the key is to be deleted. After that
3853N/A date, the key will no longer be included in the zone. (It
3853N/A may remain in the key repository, however.)
3853N/A<
dt><
span class="term">-i <
em class="replaceable"><
code>interval</
code></
em></
span></
dt>
3853N/A Sets the prepublication interval for a key. If set, then
3853N/A the publication and activation dates must be separated by at least
3853N/A this much time. If the activation date is specified but the
3853N/A publication date isn't, then the publication date will default
3853N/A to this much time before the activation date; conversely, if
3853N/A the publication date is specified but activation date isn't,
3853N/A then activation will be set to this much time after publication.
3853N/A If the key is being created as an explicit successor to another
3853N/A key, then the default prepublication interval is 30 days;
3853N/A As with date offsets, if the argument is followed by one of
3853N/A the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
3853N/A interval is measured in years, months, weeks, days, hours,
3853N/A or minutes, respectively. Without a suffix, the interval is
3853N/A<
div class="refsect1" lang="en">
3853N/A<
a name="id2666699"></
a><
h2>GENERATED KEYS</
h2>
3853N/A When <
span><
strong class="command">dnssec-keygen</
strong></
span> completes
3853N/A it prints a string of the form <
code class="filename">Knnnn.+aaa+iiiii</
code>
3853N/A to the standard output. This is an identification string for
3853N/A<
div class="itemizedlist"><
ul type="disc">
3853N/A<
li><
p><
code class="filename">nnnn</
code> is the key name.
3853N/A<
li><
p><
code class="filename">aaa</
code> is the numeric representation
3853N/A<
li><
p><
code class="filename">iiiii</
code> is the key identifier (or
3853N/A<
p><
span><
strong class="command">dnssec-keygen</
strong></
span>
3853N/A creates two files, with names based
3853N/A on the printed string. <
code class="filename">Knnnn.+aaa+
iiiii.key</
code>
3853N/A contains the public key, and
3853N/A The <
code class="filename">.key</
code> file contains a DNS KEY record
3853N/A can be inserted into a zone file (directly or with a $INCLUDE
3853N/A The <
code class="filename">.private</
code> file contains
3853N/A fields. For obvious security reasons, this file does not have
3853N/A Both <
code class="filename">.key</
code> and <
code class="filename">.private</
code>
3853N/A files are generated for symmetric encryption algorithms such as
3853N/A HMAC-MD5, even though the public and private key are equivalent.
3853N/A<
div class="refsect1" lang="en">
3853N/A<
a name="id2666807"></
a><
h2>EXAMPLE</
h2>
3853N/A To generate a 768-bit DSA key for the domain
3853N/A <
strong class="userinput"><
code>
example.com</
code></
strong>, the following command would be
3853N/A<
p><
strong class="userinput"><
code>dnssec-keygen -a DSA -b 768 -n ZONE
example.com</
code></
strong>
3853N/A The command would print a string of the form:
3853N/A In this example, <
span><
strong class="command">dnssec-keygen</
strong></
span> creates
3853N/A<
div class="refsect1" lang="en">
3853N/A<
a name="id2666932"></
a><
h2>SEE ALSO</
h2>
3853N/A<
p><
span class="citerefentry"><
span class="refentrytitle">dnssec-signzone</
span>(8)</
span>,
3853N/A <
em class="citetitle">BIND 9 Administrator Reference Manual</
em>,
3853N/A <
em class="citetitle">RFC 2539</
em>,
3853N/A <
em class="citetitle">RFC 2845</
em>,
3853N/A <
em class="citetitle">RFC 4034</
em>.
3853N/A<
div class="refsect1" lang="en">
3853N/A<
a name="id2666963"></
a><
h2>AUTHOR</
h2>
<
p><
span class="corpauthor">Internet Systems Consortium</
span>
<
table width="100%" summary="Navigation footer">
<
td width="40%" align="left">
<
td width="20%" align="center"><
a accesskey="u" href="Bv9ARM.ch10.html">Up</
a></
td>
<
td width="40%" align="left" valign="top">
<
span class="application">dnssec-keyfromlabel</
span>�</
td>
<
td width="20%" align="center"><
a accesskey="h" href="Bv9ARM.html">Home</
a></
td>
<
td width="40%" align="right" valign="top">�<
span class="application">dnssec-revoke</
span>