man.dnssec-keygen.html revision a3f8c8e20780e488141d200acdfea6c5f3303513
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<!--
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User - Copyright (C) 2004-2011 Internet Systems Consortium, Inc. ("ISC")
3e02c9e33656dcd9c364633d42dd785d3e6fdd66Automatic Updater - Copyright (C) 2000-2003 Internet Software Consortium.
3e02c9e33656dcd9c364633d42dd785d3e6fdd66Automatic Updater -
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater - Permission to use, copy, modify, and/or distribute this software for any
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater - purpose with or without fee is hereby granted, provided that the above
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater - copyright notice and this permission notice appear in all copies.
3e02c9e33656dcd9c364633d42dd785d3e6fdd66Automatic Updater -
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
3e02c9e33656dcd9c364633d42dd785d3e6fdd66Automatic Updater - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater - PERFORMANCE OF THIS SOFTWARE.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater-->
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User<!-- $Id: man.dnssec-keygen.html,v 1.183 2011/03/18 01:14:34 tbox Exp $ -->
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<html>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<head>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<title>dnssec-keygen</title>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<link rel="prev" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<link rel="next" href="man.dnssec-revoke.html" title="dnssec-revoke">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</head>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<div class="navheader">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<table width="100%" summary="Navigation header">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<tr><th colspan="3" align="center"><span class="application">dnssec-keygen</span></th></tr>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<tr>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<td width="20%" align="left">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a>�</td>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<th width="60%" align="center">Manual pages</th>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-revoke.html">Next</a>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</td>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</tr>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</table>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<hr>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</div>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<div class="refentry" lang="en">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<div class="refnamediv">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<h2>Name</h2>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</div>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<div class="refsynopsisdiv">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<h2>Synopsis</h2>
6f1205897504b8f50b1785975482c995888dd630Tinderbox User<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">-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">-z</code>] {name}</p></div>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</div>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<div class="refsect1" lang="en">
ef8014e56f35bb36daa5fd2c313f5e7963e97aa1Tinderbox User<a name="id2614018"></a><h2>DESCRIPTION</h2>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p><span><strong class="command">dnssec-keygen</strong></span>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater and RFC 4034. It can also generate keys for use with
f8e3e03cacd16ffb923a9603fca23a9e1a1fee07Automatic Updater TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater (Transaction Key) as defined in RFC 2930.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater The <code class="option">name</code> of the key is specified on the command
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater line. For DNSSEC keys, this must match the name of the zone for
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater which the key is being generated.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</div>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<div class="refsect1" lang="en">
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<a name="id2614038"></a><h2>OPTIONS</h2>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<div class="variablelist"><dl>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater Selects the cryptographic algorithm. For DNSSEC keys, the value
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512 or ECCGOST.
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater For TSIG/TKEY, the value must
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater case insensitive.
ef8014e56f35bb36daa5fd2c313f5e7963e97aa1Tinderbox User </p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater If no algorithm is specified, then RSASHA1 will be used by
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater default, unless the <code class="option">-3</code> option is specified,
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater in which case NSEC3RSASHA1 will be used instead. (If
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater <code class="option">-3</code> is used and an algorithm is specified,
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater that algorithm will be checked for compatibility with NSEC3.)
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p>
7717ec7a6a898cdd3c35cbfba66010b7304ffd9bAutomatic Updater Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
7717ec7a6a898cdd3c35cbfba66010b7304ffd9bAutomatic Updater algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
7717ec7a6a898cdd3c35cbfba66010b7304ffd9bAutomatic Updater mandatory.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater automatically set the -T KEY option.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p>
a3f8c8e20780e488141d200acdfea6c5f3303513Automatic Updater</dd>
a3f8c8e20780e488141d200acdfea6c5f3303513Automatic Updater<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
a3f8c8e20780e488141d200acdfea6c5f3303513Automatic Updater<dd>
a3f8c8e20780e488141d200acdfea6c5f3303513Automatic Updater<p>
a3f8c8e20780e488141d200acdfea6c5f3303513Automatic Updater Specifies the number of bits in the key. The choice of key
a3f8c8e20780e488141d200acdfea6c5f3303513Automatic Updater size depends on the algorithm used. RSA keys must be
ef8014e56f35bb36daa5fd2c313f5e7963e97aa1Tinderbox User between 512 and 2048 bits. Diffie Hellman keys must be between
ef8014e56f35bb36daa5fd2c313f5e7963e97aa1Tinderbox User 128 and 4096 bits. DSA keys must be between 512 and 1024
ef8014e56f35bb36daa5fd2c313f5e7963e97aa1Tinderbox User bits and an exact multiple of 64. HMAC keys must be
ef8014e56f35bb36daa5fd2c313f5e7963e97aa1Tinderbox User between 1 and 512 bits.
a3f8c8e20780e488141d200acdfea6c5f3303513Automatic Updater </p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater The key size does not need to be specified if using a default
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater algorithm. The default key size is 1024 bits for zone signing
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater keys (ZSK's) and 2048 bits for key signing keys (KSK's,
6f1205897504b8f50b1785975482c995888dd630Tinderbox User generated with <code class="option">-f KSK</code>). However, if an
6f1205897504b8f50b1785975482c995888dd630Tinderbox User algorithm is explicitly specified with the <code class="option">-a</code>,
6f1205897504b8f50b1785975482c995888dd630Tinderbox User then there is no default key size, and the <code class="option">-b</code>
6f1205897504b8f50b1785975482c995888dd630Tinderbox User must be used.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd><p>
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater Specifies the owner type of the key. The value of
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User <code class="option">nametype</code> must either be ZONE (for a DNSSEC
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User a host (KEY)),
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User These values are case insensitive. Defaults to ZONE for DNSKEY
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User generation.
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User </p></dd>
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User<dt><span class="term">-3</span></dt>
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User<dd><p>
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User Use an NSEC3-capable algorithm to generate a DNSSEC key.
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User If this option is used and no algorithm is explicitly
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User set on the command line, NSEC3RSASHA1 will be used by
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User default. Note that RSASHA256, RSASHA512 and ECCGOST algorithms
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater are NSEC3-capable.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p></dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dt><span class="term">-C</span></dt>
ef8014e56f35bb36daa5fd2c313f5e7963e97aa1Tinderbox User<dd><p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater Compatibility mode: generates an old-style key, without
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater any metadata. By default, <span><strong class="command">dnssec-keygen</strong></span>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater will include the key's creation date in the metadata stored
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater with the private key, and other dates may be set there as well
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater (publication date, activation date, etc). Keys that include
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater this data may be incompatible with older versions of BIND; the
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater <code class="option">-C</code> option suppresses them.
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater </p></dd>
bbbf2e27d3a981163dab139497d6b2dc85449db0Tinderbox User<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd><p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater Indicates that the DNS record containing the key should have
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater the specified class. If not specified, class IN is used.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p></dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd><p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater Uses a crypto hardware (OpenSSL engine) for random number
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater and, when supported, key generation. When compiled with PKCS#11
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater support it defaults to pkcs11; the empty name resets it to
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater no engine.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p></dd>
5a24d24c8fba3480d707c0c902379ddb36501e12Automatic Updater<dt><span class="term">-e</span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd><p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater If generating an RSAMD5/RSASHA1 key, use a large exponent.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p></dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd><p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater Set the specified flag in the flag field of the KEY/DNSKEY record.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater The only recognized flags are KSK (Key Signing Key) and REVOKE.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p></dd>
f8e3e03cacd16ffb923a9603fca23a9e1a1fee07Automatic Updater<dt><span class="term">-G</span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd><p>
f8e3e03cacd16ffb923a9603fca23a9e1a1fee07Automatic Updater Generate a key, but do not publish it or sign with it. This
f8e3e03cacd16ffb923a9603fca23a9e1a1fee07Automatic Updater option is incompatible with -P and -A.
f8e3e03cacd16ffb923a9603fca23a9e1a1fee07Automatic Updater </p></dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd><p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater If generating a Diffie Hellman key, use this generator.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater Allowed values are 2 and 5. If no generator
f8e3e03cacd16ffb923a9603fca23a9e1a1fee07Automatic Updater is specified, a known prime from RFC 2539 will be used
f8e3e03cacd16ffb923a9603fca23a9e1a1fee07Automatic Updater if possible; otherwise the default is 2.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p></dd>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dt><span class="term">-h</span></dt>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dd><p>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater Prints a short summary of the options and arguments to
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater <span><strong class="command">dnssec-keygen</strong></span>.
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater </p></dd>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dd><p>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater Sets the directory in which the key files are to be written.
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater </p></dd>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dt><span class="term">-k</span></dt>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dd><p>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater Deprecated in favor of -T KEY.
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater </p></dd>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dd><p>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater Sets the default TTL to use for this key when it is converted
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater into a DNSKEY RR. If the key is imported into a zone,
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater this is the TTL that will be used for it, unless there was
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater already a DNSKEY RRset in place, in which case the existing TTL
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater would take precedence. Setting the default TTL to
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater <code class="literal">0</code> or <code class="literal">none</code> removes it.
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater </p></dd>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dd><p>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater Sets the protocol value for the generated key. The protocol
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater is a number between 0 and 255. The default is 3 (DNSSEC).
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater Other possible values for this argument are listed in
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater RFC 2535 and its successors.
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater </p></dd>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dt><span class="term">-q</span></dt>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater<dd><p>
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater Quiet mode: Suppresses unnecessary output, including
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater progress indication. Without this option, when
3acf5eb97cebc2ba868e6ac4a4e01e6d1be0c892Automatic Updater <span><strong class="command">dnssec-keygen</strong></span> is run interactively
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater to generate an RSA or DSA key pair, it will print a string
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater of symbols to <code class="filename">stderr</code> indicating the
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater progress of the key generation. A '.' indicates that a
ef8014e56f35bb36daa5fd2c313f5e7963e97aa1Tinderbox User random number has been found which passed an initial
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater sieve test; '+' means a number has passed a single
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater round of the Miller-Rabin primality test; a space
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater means that the number has passed all the tests and is
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater a satisfactory key.
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater </p></dd>
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater<dd><p>
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater Specifies the source of randomness. If the operating
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater system does not provide a <code class="filename">/dev/random</code>
83f43b00a50c9c932c81691a3828041643a0d6f6Automatic Updater or equivalent device, the default source of randomness
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater is keyboard input. <code class="filename">randomdev</code>
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater specifies
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater the name of a character device or file containing random
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater data to be used instead of the default. The special value
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater <code class="filename">keyboard</code> indicates that keyboard
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater input should be used.
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater </p></dd>
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater<dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
83f43b00a50c9c932c81691a3828041643a0d6f6Automatic Updater<dd><p>
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater Create a new key which is an explicit successor to an
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater existing key. The name, algorithm, size, and type of the
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater key will be set to match the existing key. The activation
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater date of the new key will be set to the inactivation date of
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater the existing one. The publication date will be set to the
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater activation date minus the prepublication interval, which
ef8014e56f35bb36daa5fd2c313f5e7963e97aa1Tinderbox User defaults to 30 days.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p></dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd><p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater Specifies the strength value of the key. The strength is
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater a number between 0 and 15, and currently has no defined
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater purpose in DNSSEC.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p></dd>
ef8014e56f35bb36daa5fd2c313f5e7963e97aa1Tinderbox User<dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater Specifies the resource record type to use for the key.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater <code class="option">rrtype</code> must be either DNSKEY or KEY. The
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater default is DNSKEY when using a DNSSEC algorithm, but it can be
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater overridden to KEY for use with SIG(0).
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<p>
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User Using any TSIG algorithm (HMAC-* or DH) forces this option
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater to KEY.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd><p>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater Indicates the use of the key. <code class="option">type</code> must be
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater is AUTHCONF. AUTH refers to the ability to authenticate
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater data, and CONF the ability to encrypt data.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p></dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater<dd><p>
30c0c7470d5bfabd8f43c563f4eca636d06cc484Tinderbox User Sets the debugging level.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater </p></dd>
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2667761"></a><h2>TIMING OPTIONS</h2>
<p>
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.
</p>
<div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
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".
</p></dd>
<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
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".
</p></dd>
<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
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.
</p></dd>
<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
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.
</p></dd>
<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
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.)
</p></dd>
<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
<dd>
<p>
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.
</p>
<p>
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.
</p>
<p>
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.
</p>
</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2668019"></a><h2>GENERATED KEYS</h2>
<p>
When <span><strong class="command">dnssec-keygen</strong></span> 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.
</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="filename">nnnn</code> is the key name.
</p></li>
<li><p><code class="filename">aaa</code> is the numeric representation
of the
algorithm.
</p></li>
<li><p><code class="filename">iiiii</code> is the key identifier (or
footprint).
</p></li>
</ul></div>
<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
private
key.
</p>
<p>
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).
</p>
<p>
The <code class="filename">.private</code> file contains
algorithm-specific
fields. For obvious security reasons, this file does not have
general read permission.
</p>
<p>
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.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2668126"></a><h2>EXAMPLE</h2>
<p>
To generate a 768-bit DSA key for the domain
<strong class="userinput"><code>example.com</code></strong>, the following command would be
issued:
</p>
<p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
</p>
<p>
The command would print a string of the form:
</p>
<p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
</p>
<p>
In this example, <span><strong class="command">dnssec-keygen</strong></span> creates
the files <code class="filename">Kexample.com.+003+26160.key</code>
and
<code class="filename">Kexample.com.+003+26160.private</code>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2668183"></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>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2668214"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</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.ch10.html">Up</a></td>
<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-revoke.html">Next</a>
</td>
</tr>
<tr>
<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>
</td>
</tr>
</table>
</div>
</body>
</html>