10139N/A - Copyright (C) 2000-2017 Internet Systems Consortium, Inc. ("ISC") 10139N/A - This Source Code Form is subject to the terms of the Mozilla Public 10139N/A - License, v. 2.0. If a copy of the MPL was not distributed with this 10139N/A<
meta http-
equiv="Content-Type" content="text/html; charset=ISO-8859-1">
10139N/A<
meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
10139N/A<
body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
10139N/A<
table width="100%" summary="Navigation header">
10139N/A<
tr><
th colspan="3" align="center"><
span class="application">dnssec-keygen</
span></
th></
tr>
10139N/A<
th width="60%" align="center">Manual pages</
th>
10139N/A <
span class="application">dnssec-keygen</
span>
10139N/A — DNSSEC key generation tool
10139N/A <
code class="command">dnssec-keygen</
code>
10139N/A [<
code class="option">-a <
em class="replaceable"><
code>algorithm</
code></
em></
code>]
10139N/A [<
code class="option">-b <
em class="replaceable"><
code>keysize</
code></
em></
code>]
10139N/A [<
code class="option">-n <
em class="replaceable"><
code>nametype</
code></
em></
code>]
10139N/A [<
code class="option">-3</
code>]
10139N/A [<
code class="option">-A <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
10139N/A [<
code class="option">-C</
code>]
13931N/A [<
code class="option">-c <
em class="replaceable"><
code>class</
code></
em></
code>]
10139N/A [<
code class="option">-D <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
10139N/A [<
code class="option">-D sync <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
10139N/A [<
code class="option">-E <
em class="replaceable"><
code>engine</
code></
em></
code>]
10139N/A [<
code class="option">-f <
em class="replaceable"><
code>flag</
code></
em></
code>]
10139N/A [<
code class="option">-G</
code>]
10139N/A [<
code class="option">-g <
em class="replaceable"><
code>generator</
code></
em></
code>]
10139N/A [<
code class="option">-h</
code>]
10139N/A [<
code class="option">-I <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
13570N/A [<
code class="option">-i <
em class="replaceable"><
code>interval</
code></
em></
code>]
10139N/A [<
code class="option">-K <
em class="replaceable"><
code>directory</
code></
em></
code>]
10139N/A [<
code class="option">-k</
code>]
10139N/A [<
code class="option">-L <
em class="replaceable"><
code>ttl</
code></
em></
code>]
14177N/A [<
code class="option">-P <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
11965N/A [<
code class="option">-P sync <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
11965N/A [<
code class="option">-p <
em class="replaceable"><
code>protocol</
code></
em></
code>]
13678N/A [<
code class="option">-q</
code>]
10139N/A [<
code class="option">-R <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
10139N/A [<
code class="option">-r <
em class="replaceable"><
code>randomdev</
code></
em></
code>]
13680N/A [<
code class="option">-S <
em class="replaceable"><
code>key</
code></
em></
code>]
10139N/A [<
code class="option">-s <
em class="replaceable"><
code>strength</
code></
em></
code>]
10139N/A [<
code class="option">-t <
em class="replaceable"><
code>type</
code></
em></
code>]
11933N/A [<
code class="option">-V</
code>]
10139N/A [<
code class="option">-v <
em class="replaceable"><
code>level</
code></
em></
code>]
10139N/A [<
code class="option">-z</
code>]
10139N/A<
a name="id-1.14.12.7"></
a><
h2>DESCRIPTION</
h2>
10139N/A <
p><
span class="command"><
strong>dnssec-keygen</
strong></
span>
10139N/A generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
10139N/A and RFC 4034. It can also generate keys for use with
10139N/A TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
10139N/A (Transaction Key) as defined in RFC 2930.
10139N/A The <
code class="option">name</
code> of the key is specified on the command
10139N/A line. For DNSSEC keys, this must match the name of the zone for
10139N/A which the key is being generated.
12787N/A<
a name="id-1.14.12.8"></
a><
h2>OPTIONS</
h2>
10139N/A <
div class="variablelist"><
dl class="variablelist">
11232N/A<
dt><
span class="term">-a <
em class="replaceable"><
code>algorithm</
code></
em></
span></
dt>
10139N/A Selects the cryptographic algorithm. For DNSSEC keys, the value
10139N/A of <
code class="option">algorithm</
code> must be one of RSAMD5, RSASHA1,
10139N/A DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
10139N/A ECDSAP256SHA256 or ECDSAP384SHA384.
11925N/A be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
10139N/A HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
10139N/A If no algorithm is specified, then RSASHA1 will be used by
10139N/A default, unless the <
code class="option">-3</
code> option is specified,
10139N/A in which case NSEC3RSASHA1 will be used instead. (If
10139N/A <
code class="option">-3</
code> is used and an algorithm is specified,
10139N/A that algorithm will be checked for compatibility with NSEC3.)
10139N/A Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
10139N/A algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
10139N/A Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
13727N/A automatically set the -T KEY option.
10139N/A<
dt><
span class="term">-b <
em class="replaceable"><
code>keysize</
code></
em></
span></
dt>
10697N/A Specifies the number of bits in the key. The choice of key
12374N/A size depends on the algorithm used. RSA keys must be
10915N/A between 512 and 2048 bits. Diffie Hellman keys must be between
11161N/A 128 and 4096 bits. DSA keys must be between 512 and 1024
12385N/A bits and an exact multiple of 64. HMAC keys must be
13698N/A between 1 and 512 bits. Elliptic curve algorithms don't need
12780N/A The key size does not need to be specified if using a default
13092N/A algorithm. The default key size is 1024 bits for zone signing
13360N/A keys (ZSKs) and 2048 bits for key signing keys (KSKs,
13409N/A generated with <
code class="option">-f KSK</
code>). However, if an
13685N/A algorithm is explicitly specified with the <
code class="option">-a</
code>,
13695N/A then there is no default key size, and the <
code class="option">-b</
code>
13738N/A<
dt><
span class="term">-n <
em class="replaceable"><
code>nametype</
code></
em></
span></
dt>
13891N/A Specifies the owner type of the key. The value of
13980N/A <
code class="option">nametype</
code> must either be ZONE (for a DNSSEC
14132N/A USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
10139N/A These values are case insensitive. Defaults to ZONE for DNSKEY
10139N/A<
dt><
span class="term">-3</
span></
dt>
10139N/A Use an NSEC3-capable algorithm to generate a DNSSEC key.
10139N/A If this option is used and no algorithm is explicitly
10139N/A set on the command line, NSEC3RSASHA1 will be used by
10139N/A default. Note that RSASHA256, RSASHA512, ECCGOST,
10139N/A ECDSAP256SHA256 and ECDSAP384SHA384 algorithms
10139N/A<
dt><
span class="term">-C</
span></
dt>
10139N/A Compatibility mode: generates an old-style key, without
10139N/A any metadata. By default, <
span class="command"><
strong>dnssec-keygen</
strong></
span>
10139N/A will include the key's creation date in the metadata stored
10139N/A with the private key, and other dates may be set there as well
10139N/A (publication date, activation date, etc). Keys that include
10139N/A this data may be incompatible with older versions of BIND; the
10139N/A <
code class="option">-C</
code> option suppresses them.
10139N/A<
dt><
span class="term">-c <
em class="replaceable"><
code>class</
code></
em></
span></
dt>
10139N/A Indicates that the DNS record containing the key should have
10139N/A the specified class. If not specified, class IN is used.
10139N/A<
dt><
span class="term">-E <
em class="replaceable"><
code>engine</
code></
em></
span></
dt>
10139N/A Specifies the cryptographic hardware to use, when applicable.
10139N/A When BIND is built with OpenSSL PKCS#11 support, this defaults
10139N/A to the string "pkcs11", which identifies an OpenSSL engine
10139N/A that can drive a cryptographic accelerator or hardware service
10139N/A module. When BIND is built with native PKCS#11 cryptography
10139N/A (--enable-native-pkcs11), it defaults to the path of the PKCS#11
10139N/A provider library specified via "--with-pkcs11".
10139N/A<
dt><
span class="term">-f <
em class="replaceable"><
code>flag</
code></
em></
span></
dt>
10139N/A The only recognized flags are KSK (Key Signing Key) and REVOKE.
10139N/A<
dt><
span class="term">-G</
span></
dt>
10139N/A Generate a key, but do not publish it or sign with it. This
10139N/A option is incompatible with -P and -A.
10139N/A<
dt><
span class="term">-g <
em class="replaceable"><
code>generator</
code></
em></
span></
dt>
10139N/A If generating a Diffie Hellman key, use this generator.
10139N/A Allowed values are 2 and 5. If no generator
10139N/A is specified, a known prime from RFC 2539 will be used
10139N/A if possible; otherwise the default is 2.
10139N/A<
dt><
span class="term">-h</
span></
dt>
10139N/A Prints a short summary of the options and arguments to
10139N/A <
span class="command"><
strong>dnssec-keygen</
strong></
span>.
10139N/A<
dt><
span class="term">-K <
em class="replaceable"><
code>directory</
code></
em></
span></
dt>
10139N/A Sets the directory in which the key files are to be written.
10139N/A<
dt><
span class="term">-k</
span></
dt>
10139N/A<
dt><
span class="term">-L <
em class="replaceable"><
code>ttl</
code></
em></
span></
dt>
10139N/A Sets the default TTL to use for this key when it is converted
10139N/A into a DNSKEY RR. If the key is imported into a zone,
10139N/A this is the TTL that will be used for it, unless there was
10139N/A already a DNSKEY RRset in place, in which case the existing TTL
10139N/A would take precedence. If this value is not set and there
10139N/A is no existing DNSKEY RRset, the TTL will default to the
10139N/A SOA TTL. Setting the default TTL to <
code class="literal">0</
code>
10139N/A or <
code class="literal">none</
code> is the same as leaving it unset.
10139N/A<
dt><
span class="term">-p <
em class="replaceable"><
code>protocol</
code></
em></
span></
dt>
10139N/A Sets the protocol value for the generated key. The protocol
10139N/A is a number between 0 and 255. The default is 3 (DNSSEC).
10139N/A Other possible values for this argument are listed in
10139N/A<
dt><
span class="term">-q</
span></
dt>
10139N/A Quiet mode: Suppresses unnecessary output, including
10139N/A progress indication. Without this option, when
10139N/A <
span class="command"><
strong>dnssec-keygen</
strong></
span> is run interactively
14177N/A to generate an RSA or DSA key pair, it will print a string
14177N/A of symbols to <
code class="filename">stderr</
code> indicating the
14177N/A progress of the key generation. A '.' indicates that a
14177N/A random number has been found which passed an initial
11965N/A sieve test; '+' means a number has passed a single
11965N/A round of the Miller-Rabin primality test; a space
13931N/A means that the number has passed all the tests and is
13931N/A<
dt><
span class="term">-r <
em class="replaceable"><
code>randomdev</
code></
em></
span></
dt>
11965N/A Specifies the source of randomness. If the operating
11965N/A or equivalent device, the default source of randomness
11965N/A is keyboard input. <
code class="filename">randomdev</
code>
13678N/A the name of a character device or file containing random
13678N/A data to be used instead of the default. The special value
13678N/A <
code class="filename">keyboard</
code> indicates that keyboard
10139N/A<
dt><
span class="term">-S <
em class="replaceable"><
code>key</
code></
em></
span></
dt>
10139N/A Create a new key which is an explicit successor to an
10139N/A existing key. The name, algorithm, size, and type of the
10139N/A key will be set to match the existing key. The activation
10139N/A date of the new key will be set to the inactivation date of
10139N/A the existing one. The publication date will be set to the
10139N/A activation date minus the prepublication interval, which
10139N/A<
dt><
span class="term">-s <
em class="replaceable"><
code>strength</
code></
em></
span></
dt>
13806N/A Specifies the strength value of the key. The strength is
13806N/A a number between 0 and 15, and currently has no defined
13680N/A<
dt><
span class="term">-T <
em class="replaceable"><
code>rrtype</
code></
em></
span></
dt>
10139N/A Specifies the resource record type to use for the key.
10139N/A <
code class="option">rrtype</
code> must be either DNSKEY or KEY. The
10139N/A default is DNSKEY when using a DNSSEC algorithm, but it can be
10139N/A overridden to KEY for use with SIG(0).
10139N/A Using any TSIG algorithm (HMAC-* or DH) forces this option
10139N/A<
dt><
span class="term">-t <
em class="replaceable"><
code>type</
code></
em></
span></
dt>
13760N/A Indicates the use of the key. <
code class="option">type</
code> must be
10139N/A one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
10139N/A is AUTHCONF. AUTH refers to the ability to authenticate
13760N/A data, and CONF the ability to encrypt data.
10139N/A<
dt><
span class="term">-v <
em class="replaceable"><
code>level</
code></
em></
span></
dt>
11161N/A<
dt><
span class="term">-V</
span></
dt>
10139N/A<
a name="id-1.14.12.9"></
a><
h2>TIMING OPTIONS</
h2>
10139N/A Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
10139N/A If the argument begins with a '+' or '-', it is interpreted as
10139N/A an offset from the present time. For convenience, if such an offset
10139N/A is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
10139N/A then the offset is computed in years (defined as 365 24-hour days,
10139N/A ignoring leap years), months (defined as 30 24-hour days), weeks,
10139N/A days, hours, or minutes, respectively. Without a suffix, the offset
10139N/A is computed in seconds. To explicitly prevent a date from being
10139N/A <
div class="variablelist"><
dl class="variablelist">
10139N/A<
dt><
span class="term">-P <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
10139N/A Sets the date on which a key is to be published to the zone.
10139N/A After that date, the key will be included in the zone but will
10139N/A not be used to sign it. If not set, and if the -G option has
10139N/A not been used, the default is "now".
10139N/A<
dt><
span class="term">-P sync <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
10139N/A Sets the date on which CDS and CDNSKEY records that match this
10139N/A key are to be published to the zone.
10139N/A<
dt><
span class="term">-A <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
11193N/A Sets the date on which the key is to be activated. After that
13036N/A date, the key will be included in the zone and used to sign
10139N/A it. If not set, and if the -G option has not been used, the
10139N/A default is "now". If set, if and -P is not set, then
10139N/A the publication date will be set to the activation date
10139N/A minus the prepublication interval.
10139N/A<
dt><
span class="term">-R <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
10139N/A Sets the date on which the key is to be revoked. After that
10139N/A date, the key will be flagged as revoked. It will be included
10139N/A in the zone and will be used to sign it.
10139N/A<
dt><
span class="term">-I <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
10139N/A Sets the date on which the key is to be retired. After that
10139N/A date, the key will still be included in the zone, but it
10139N/A<
dt><
span class="term">-D <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
10139N/A Sets the date on which the key is to be deleted. After that
10139N/A date, the key will no longer be included in the zone. (It
10139N/A may remain in the key repository, however.)
10139N/A<
dt><
span class="term">-D sync <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
10139N/A Sets the date on which the CDS and CDNSKEY records that match this
10139N/A<
dt><
span class="term">-i <
em class="replaceable"><
code>interval</
code></
em></
span></
dt>
10139N/A Sets the prepublication interval for a key. If set, then
10139N/A the publication and activation dates must be separated by at least
10139N/A this much time. If the activation date is specified but the
10139N/A publication date isn't, then the publication date will default
10139N/A to this much time before the activation date; conversely, if
10139N/A the publication date is specified but activation date isn't,
10139N/A then activation will be set to this much time after publication.
10139N/A If the key is being created as an explicit successor to another
10139N/A key, then the default prepublication interval is 30 days;
10139N/A As with date offsets, if the argument is followed by one of
10139N/A the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
10139N/A interval is measured in years, months, weeks, days, hours,
10139N/A or minutes, respectively. Without a suffix, the interval is
10139N/A<
a name="id-1.14.12.10"></
a><
h2>GENERATED KEYS</
h2>
10139N/A When <
span class="command"><
strong>dnssec-keygen</
strong></
span> completes
10139N/A it prints a string of the form <
code class="filename">Knnnn.+aaa+iiiii</
code>
10139N/A to the standard output. This is an identification string for
10139N/A <
div class="itemizedlist"><
ul class="itemizedlist" style="list-style-type: disc; ">
10139N/A <
p><
code class="filename">nnnn</
code> is the key name.
11904N/A <
p><
code class="filename">aaa</
code> is the numeric representation
10139N/A <
p><
code class="filename">iiiii</
code> is the key identifier (or
10139N/A <
p><
span class="command"><
strong>dnssec-keygen</
strong></
span>
10139N/A creates two files, with names based
10139N/A The <
code class="filename">.key</
code> file contains a DNS KEY record
10139N/A can be inserted into a zone file (directly or with a $INCLUDE
10139N/A The <
code class="filename">.private</
code> file contains
10139N/A fields. For obvious security reasons, this file does not have
10139N/A Both <
code class="filename">.key</
code> and <
code class="filename">.private</
code>
10139N/A files are generated for symmetric cryptography algorithms such as
10139N/A HMAC-MD5, even though the public and private key are equivalent.
13688N/A<
a name="id-1.14.12.11"></
a><
h2>EXAMPLE</
h2>
10139N/A To generate a 768-bit DSA key for the domain
12787N/A <
strong class="userinput"><
code>
example.com</
code></
strong>, the following command would be
12787N/A <
p><
strong class="userinput"><
code>dnssec-keygen -a DSA -b 768 -n ZONE
example.com</
code></
strong>
12787N/A The command would print a string of the form:
13285N/A In this example, <
span class="command"><
strong>dnssec-keygen</
strong></
span> creates
10139N/A<
a name="id-1.14.12.12"></
a><
h2>SEE ALSO</
h2>
10139N/A <
span class="refentrytitle">dnssec-signzone</
span>(8)
10139N/A <
em class="citetitle">BIND 9 Administrator Reference Manual</
em>,
10139N/A <
em class="citetitle">RFC 2539</
em>,
10139N/A <
em class="citetitle">RFC 2845</
em>,
10139N/A <
em class="citetitle">RFC 4034</
em>.
12741N/A<
table width="100%" summary="Navigation footer">
11925N/A<
td width="40%" align="left" valign="top">
10139N/A<
span class="application">dnssec-keyfromlabel</
span>�</
td>
11232N/A<
td width="40%" align="right" valign="top">�<
span class="application">dnssec-keymgr</
span>