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