File Manager

Editing File: /usr/share/doc/bind-9.11.4/man.dnssec-keygen.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>dnssec-keygen</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel">
<link rel="next" href="man.dnssec-keymgr.html" title="dnssec-keymgr">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">dnssec-keygen</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a> </td>
<th width="60%" align="center">Manual pages</th>
<td width="20%" align="right"> <a accesskey="n" href="man.dnssec-keymgr.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="refentry">
<a name="man.dnssec-keygen"></a><div class="titlepage"></div>

<div class="refnamediv">
<h2>Name</h2>

 dnssec-keygen
 &#8212; DNSSEC key generation tool
 
</div>

<div class="refsynopsisdiv">
<h2>Synopsis</h2>
 <div class="cmdsynopsis">
 <code class="command">dnssec-keygen</code> 
 [<code class="option">-a <code>algorithm</code></code>]
 [<code class="option">-b <code>keysize</code></code>]
 [<code class="option">-n <code>nametype</code></code>]
 [<code class="option">-3</code>]
 [<code class="option">-A <code>date/offset</code></code>]
 [<code class="option">-C</code>]
 [<code class="option">-c <code>class</code></code>]
 [<code class="option">-D <code>date/offset</code></code>]
 [<code class="option">-D sync <code>date/offset</code></code>]
 [<code class="option">-E <code>engine</code></code>]
 [<code class="option">-f <code>flag</code></code>]
 [<code class="option">-G</code>]
 [<code class="option">-g <code>generator</code></code>]
 [<code class="option">-h</code>]
 [<code class="option">-I <code>date/offset</code></code>]
 [<code class="option">-i <code>interval</code></code>]
 [<code class="option">-K <code>directory</code></code>]
 [<code class="option">-k</code>]
 [<code class="option">-L <code>ttl</code></code>]
 [<code class="option">-P <code>date/offset</code></code>]
 [<code class="option">-P sync <code>date/offset</code></code>]
 [<code class="option">-p <code>protocol</code></code>]
 [<code class="option">-q</code>]
 [<code class="option">-R <code>date/offset</code></code>]
 [<code class="option">-r <code>randomdev</code></code>]
 [<code class="option">-S <code>key</code></code>]
 [<code class="option">-s <code>strength</code></code>]
 [<code class="option">-t <code>type</code></code>]
 [<code class="option">-V</code>]
 [<code class="option">-v <code>level</code></code>]
 [<code class="option">-z</code>]
 {name}
 </div>
 </div>

<div class="refsection">
<a name="id-1.14.12.7"></a><h2>DESCRIPTION</h2>

dnssec-keygen
 generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
 and RFC 4034. It can also generate keys for use with
 TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
 (Transaction Key) as defined in RFC 2930.
 
 
 The <code class="option">name</code> of the key is specified on the command
 line. For DNSSEC keys, this must match the name of the zone for
 which the key is being generated.
 
 </div>

<div class="refsection">
<a name="id-1.14.12.8"></a><h2>OPTIONS</h2>

<div class="variablelist"><dl class="variablelist">
<dt>-a <code>algorithm</code></dt>
<dd>
	 
	 Selects the cryptographic algorithm. For DNSSEC keys, the value
	 of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
	 DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
	 ECDSAP256SHA256, ECDSAP384SHA384, ED25519 or ED448.
	 For TSIG/TKEY, the value must
	 be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
	 HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
	 case insensitive.
	 
	 
	 If no algorithm is specified, then RSASHA1 will be used by
	 default, unless the <code class="option">-3</code> option is specified,
	 in which case NSEC3RSASHA1 will be used instead. (If
	 <code class="option">-3</code> is used and an algorithm is specified,
	 that algorithm will be checked for compatibility with NSEC3.)
	 
	 
	 Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
	 algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
	 mandatory.
	 
	 
	 Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
	 automatically set the -T KEY option.
	 
	</dd>
<dt>-b <code>keysize</code></dt>
<dd>
	 
	 Specifies the number of bits in the key. The choice of key
	 size depends on the algorithm used. RSA keys must be
	 between 512 and 2048 bits. Diffie Hellman keys must be between
	 128 and 4096 bits. DSA keys must be between 512 and 1024
	 bits and an exact multiple of 64. HMAC keys must be
	 between 1 and 512 bits. Elliptic curve algorithms don't need
	 this parameter.
	 
	 
	 The key size does not need to be specified if using a default
	 algorithm. The default key size is 1024 bits for zone signing
	 keys (ZSKs) and 2048 bits for key signing keys (KSKs,
	 generated with <code class="option">-f KSK</code>). However, if an
	 algorithm is explicitly specified with the <code class="option">-a</code>,
	 then there is no default key size, and the <code class="option">-b</code>
	 must be used.
	 
	</dd>
<dt>-n <code>nametype</code></dt>
<dd>
	 
	 Specifies the owner type of the key. The value of
	 <code class="option">nametype</code> must either be ZONE (for a DNSSEC
	 zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
	 a host (KEY)),
	 USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
	 These values are case insensitive. Defaults to ZONE for DNSKEY
	 generation.
	 
	</dd>
<dt>-3</dt>
<dd>
	 
	 Use an NSEC3-capable algorithm to generate a DNSSEC key.
	 If this option is used and no algorithm is explicitly
	 set on the command line, NSEC3RSASHA1 will be used by
	 default. Note that RSASHA256, RSASHA512, ECCGOST,
	 ECDSAP256SHA256, ECDSAP384SHA384, ED25519 and ED448
	 algorithms are NSEC3-capable.
	 
	</dd>
<dt>-C</dt>
<dd>
	 
	 Compatibility mode: generates an old-style key, without
	 any metadata. By default, dnssec-keygen
	 will include the key's creation date in the metadata stored
	 with the private key, and other dates may be set there as well
	 (publication date, activation date, etc). Keys that include
	 this data may be incompatible with older versions of BIND; the
	 <code class="option">-C</code> option suppresses them.
	 
	</dd>
<dt>-c <code>class</code></dt>
<dd>
	 
	 Indicates that the DNS record containing the key should have
	 the specified class. If not specified, class IN is used.
	 
	</dd>
<dt>-E <code>engine</code></dt>
<dd>
	 
	 Specifies the cryptographic hardware to use, when applicable.
	 
	 
	 When BIND is built with OpenSSL PKCS#11 support, this defaults
	 to the string "pkcs11", which identifies an OpenSSL engine
	 that can drive a cryptographic accelerator or hardware service
	 module. When BIND is built with native PKCS#11 cryptography
	 (--enable-native-pkcs11), it defaults to the path of the PKCS#11
	 provider library specified via "--with-pkcs11".
	 
	</dd>
<dt>-f <code>flag</code></dt>
<dd>
	 
	 Set the specified flag in the flag field of the KEY/DNSKEY record.
	 The only recognized flags are KSK (Key Signing Key) and REVOKE.
	 
	</dd>
<dt>-G</dt>
<dd>
	 
	 Generate a key, but do not publish it or sign with it. This
	 option is incompatible with -P and -A.
	 
	</dd>
<dt>-g <code>generator</code></dt>
<dd>
	 
	 If generating a Diffie Hellman key, use this generator.
	 Allowed values are 2 and 5. If no generator
	 is specified, a known prime from RFC 2539 will be used
	 if possible; otherwise the default is 2.
	 
	</dd>
<dt>-h</dt>
<dd>
	 
	 Prints a short summary of the options and arguments to
	 dnssec-keygen.
	 
	</dd>
<dt>-K <code>directory</code></dt>
<dd>
	 
	 Sets the directory in which the key files are to be written.
	 
	</dd>
<dt>-k</dt>
<dd>
	 
	 Deprecated in favor of -T KEY.
	 
	</dd>
<dt>-L <code>ttl</code></dt>
<dd>
	 
	 Sets the default TTL to use for this key when it is converted
	 into a DNSKEY RR. If the key is imported into a zone,
	 this is the TTL that will be used for it, unless there was
	 already a DNSKEY RRset in place, in which case the existing TTL
	 would take precedence. If this value is not set and there
	 is no existing DNSKEY RRset, the TTL will default to the
	 SOA TTL. Setting the default TTL to <code class="literal">0</code>
	 or <code class="literal">none</code> is the same as leaving it unset.
	 
	</dd>
<dt>-p <code>protocol</code></dt>
<dd>
	 
	 Sets the protocol value for the generated key. The protocol
	 is a number between 0 and 255. The default is 3 (DNSSEC).
	 Other possible values for this argument are listed in
	 RFC 2535 and its successors.
	 
	</dd>
<dt>-q</dt>
<dd>
	 
	 Quiet mode: Suppresses unnecessary output, including
	 progress indication. Without this option, when
	 dnssec-keygen is run interactively
	 to generate an RSA or DSA key pair, it will print a string
	 of symbols to <code class="filename">stderr</code> indicating the
	 progress of the key generation. A '.' indicates that a
	 random number has been found which passed an initial
	 sieve test; '+' means a number has passed a single
	 round of the Miller-Rabin primality test; a space
	 means that the number has passed all the tests and is
	 a satisfactory key.
	 
	</dd>
<dt>-r <code>randomdev</code></dt>
<dd>
	 
	 Specifies the source of randomness. If the operating
	 system does not provide a <code class="filename">/dev/random</code>
	 or equivalent device, the default source of randomness
	 is keyboard input. <code class="filename">randomdev</code>
	 specifies
	 the name of a character device or file containing random
	 data to be used instead of the default. The special value
	 <code class="filename">keyboard</code> indicates that keyboard
	 input should be used.
	 
	</dd>
<dt>-S <code>key</code></dt>
<dd>
	 
	 Create a new key which is an explicit successor to an
	 existing key. The name, algorithm, size, and type of the
	 key will be set to match the existing key. The activation
	 date of the new key will be set to the inactivation date of
	 the existing one. The publication date will be set to the
	 activation date minus the prepublication interval, which
	 defaults to 30 days.
	 
	</dd>
<dt>-s <code>strength</code></dt>
<dd>
	 
	 Specifies the strength value of the key. The strength is
	 a number between 0 and 15, and currently has no defined
	 purpose in DNSSEC.
	 
	</dd>
<dt>-T <code>rrtype</code></dt>
<dd>
	 
	 Specifies the resource record type to use for the key.
	 <code class="option">rrtype</code> must be either DNSKEY or KEY. The
	 default is DNSKEY when using a DNSSEC algorithm, but it can be
	 overridden to KEY for use with SIG(0).
	 

	 

	 Using any TSIG algorithm (HMAC-* or DH) forces this option
	 to KEY.
	 
	</dd>
<dt>-t <code>type</code></dt>
<dd>
	 
	 Indicates the use of the key. <code class="option">type</code> must be
	 one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
	 is AUTHCONF. AUTH refers to the ability to authenticate
	 data, and CONF the ability to encrypt data.
	 
	</dd>
<dt>-v <code>level</code></dt>
<dd>
	 
	 Sets the debugging level.
	 
	</dd>
<dt>-V</dt>
<dd>
	 
	 Prints version information.
	 
	</dd>
</dl></div>
 </div>

<div class="refsection">
<a name="id-1.14.12.9"></a><h2>TIMING OPTIONS</h2>

Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
 If the argument begins with a '+' or '-', it is interpreted as
 an offset from the present time. For convenience, if such an offset
 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
 then the offset is computed in years (defined as 365 24-hour days,
 ignoring leap years), months (defined as 30 24-hour days), weeks,
 days, hours, or minutes, respectively. Without a suffix, the offset
 is computed in seconds. To explicitly prevent a date from being
 set, use 'none' or 'never'.

<div class="variablelist"><dl class="variablelist">
<dt>-P <code>date/offset</code></dt>
<dd>
	 
	 Sets the date on which a key is to be published to the zone.
	 After that date, the key will be included in the zone but will
	 not be used to sign it. If not set, and if the -G option has
	 not been used, the default is "now".
	 
	</dd>
<dt>-P sync <code>date/offset</code></dt>
<dd>
	 
	 Sets the date on which CDS and CDNSKEY records that match this
	 key are to be published to the zone.
	 
	</dd>
<dt>-A <code>date/offset</code></dt>
<dd>
	 
	 Sets the date on which the key is to be activated. After that
	 date, the key will be included in the zone and used to sign
	 it. If not set, and if the -G option has not been used, the
	 default is "now". If set, if and -P is not set, then
	 the publication date will be set to the activation date
	 minus the prepublication interval.
	 
	</dd>
<dt>-R <code>date/offset</code></dt>
<dd>
	 
	 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.
	 
	</dd>
<dt>-I <code>date/offset</code></dt>
<dd>
	 
	 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.
	 
	</dd>
<dt>-D <code>date/offset</code></dt>
<dd>
	 
	 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.)
	 
	</dd>
<dt>-D sync <code>date/offset</code></dt>
<dd>
	 
	 Sets the date on which the CDS and CDNSKEY records that match this
	 key are to be deleted.
	 
	</dd>
<dt>-i <code>interval</code></dt>
<dd>
 
 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;
 otherwise it is zero.
 
 
 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
 measured in seconds.
 
 </dd>
</dl></div>
 </div>

<div class="refsection">
<a name="id-1.14.12.10"></a><h2>GENERATED KEYS</h2>

When dnssec-keygen completes
 successfully,
 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 class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
	<code class="filename">nnnn</code> is the key name.
	
 </li>
<li class="listitem">
	<code class="filename">aaa</code> is the numeric representation
	 of the
	 algorithm.
	
 </li>
<li class="listitem">
	<code class="filename">iiiii</code> is the key identifier (or
	 footprint).
	
 </li>
</ul></div>
 dnssec-keygen
 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
 private
 key.
 
 
 The <code class="filename">.key</code> file contains a DNS KEY record
 that
 can be inserted into a zone file (directly or with a $INCLUDE
 statement).
 
 
 The <code class="filename">.private</code> file contains
 algorithm-specific
 fields. For obvious security reasons, this file does not have
 general read permission.
 
 
 Both <code class="filename">.key</code> and <code class="filename">.private</code>
 files are generated for symmetric cryptography algorithms such as
 HMAC-MD5, even though the public and private key are equivalent.
 
 </div>

<div class="refsection">
<a name="id-1.14.12.11"></a><h2>EXAMPLE</h2>

To generate a 768-bit DSA key for the domain
 <code>example.com</code>, the following command would be
 issued:
 
 <code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code>
 
 
 The command would print a string of the form:
 
 <code>Kexample.com.+003+26160</code>
 
 
 In this example, dnssec-keygen creates
 the files <code class="filename">Kexample.com.+003+26160.key</code>
 and
 <code class="filename">Kexample.com.+003+26160.private</code>.
 
 </div>

dnssec-signzone(8)
 ,
 BIND 9 Administrator Reference Manual,
 RFC 2539,
 RFC 2845,
 RFC 4034.
 
 </div>

</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a> </td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
<td width="40%" align="right"> <a accesskey="n" href="man.dnssec-keymgr.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
dnssec-keyfromlabel </td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top"> dnssec-keymgr
</td>
</tr>
</table>
</div>
BIND 9.11.4-P2 (Extended Support Version)
</body>
</html>

Back to Directory File Manager