man.dnssec-keygen.html revision ad671240d635376dd8681550eebee799d2e3d1fd
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<!--
1fdd2470b625a58b57d0b155e6caf8c4fc0afe8aAutomatic Updater - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews -
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - Permission to use, copy, modify, and/or distribute this software for any
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - purpose with or without fee is hereby granted, provided that the above
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - copyright notice and this permission notice appear in all copies.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews -
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews-->
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater<!-- $Id: man.dnssec-keygen.html,v 1.128 2009/08/29 01:14:37 tbox Exp $ -->
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<html>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<head>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<title>dnssec-keygen</title>
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<link rel="prev" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<link rel="next" href="man.dnssec-revoke.html" title="dnssec-revoke">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</head>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="navheader">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<table width="100%" summary="Navigation header">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<tr><th colspan="3" align="center"><span class="application">dnssec-keygen</span></th></tr>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<tr>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<td width="20%" align="left">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a>�</td>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<th width="60%" align="center">Manual pages</th>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-revoke.html">Next</a>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</td>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</tr>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</table>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<hr>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="refentry" lang="en">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="refnamediv">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<h2>Name</h2>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="refsynopsisdiv">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<h2>Synopsis</h2>
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater<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</code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>] [<code class="option">-h</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-k</code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-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>strength</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-U <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-z</code>] {name}</p></div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="refsect1" lang="en">
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater<a name="id2607768"></a><h2>DESCRIPTION</h2>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><span><strong class="command">dnssec-keygen</strong></span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews and RFC 4034. It can also generate keys for use with
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews (Transaction Key) as defined in RFC 2930.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The <code class="option">name</code> of the key is specified on the command
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews line. For DNSSEC keys, this must match the name of the zone for
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews which the key is being generated.
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="refsect1" lang="en">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a name="id2607788"></a><h2>OPTIONS</h2>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="variablelist"><dl>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Selects the cryptographic algorithm. For DNSSEC keys, the value
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews DSA, NSEC3RSASHA1, or NSEC3DSA. For TSIG/TKEY, the value must
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews case insensitive.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews If no algorithm is specified, then RSASHA1 will be used by
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews default, unless the <code class="option">-3</code> option is specified,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews in which case NSEC3RSASHA1 will be used instead.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews mandatory.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews automatically set the -T KEY option.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specifies the number of bits in the key. The choice of key
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews size depends on the algorithm used. RSAMD5 / RSASHA1 keys must be
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews between 512 and 2048 bits. Diffie Hellman keys must be between
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews 128 and 4096 bits. DSA keys must be between 512 and 1024
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews bits and an exact multiple of 64. HMAC-MD5 keys must be
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews between 1 and 512 bits.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The key size does not need to be specified if using a default
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews algorithm. The default key size is 1024 bits for zone signing
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews keys (ZSK's) and 2048 bits for key signing keys (KSK's,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews generated with <code class="option">-f KSK</code>). However, if an
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews algorithm is explicitly specified with the <code class="option">-a</code>,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews then there is no default key size, and the <code class="option">-b</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews must be used.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specifies the owner type of the key. The value of
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">nametype</code> must either be ZONE (for a DNSSEC
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews a host (KEY)),
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews These values are case insensitive. Defaults to ZONE for DNSKEY
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews generation.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-3</span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Use an NSEC3-capable algorithm to generate a DNSSEC key.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews If this option is used and no algorithm is explicitly
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews set on the command line, NSEC3RSASHA1 will be used by
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews default.
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-C</span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Compatibility mode: generates an old-style key, without
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews any metadata. By default, <span><strong class="command">dnssec-keygen</strong></span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews will include the key's creation date in the metadata stored
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews with the private key, and other dates may be set there as well
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews (publication date, activation date, etc). Keys that include
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews this data may be incompatible with older versions of BIND; the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">-C</code> option suppresses them.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Indicates that the DNS record containing the key should have
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews the specified class. If not specified, class IN is used.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-e</span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews If generating an RSAMD5/RSASHA1 key, use a large exponent.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Set the specified flag in the flag field of the KEY/DNSKEY record.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The only recognized flags are KSK (Key Signing Key) and REVOKE.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews If generating a Diffie Hellman key, use this generator.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Allowed values are 2 and 5. If no generator
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews is specified, a known prime from RFC 2539 will be used
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews if possible; otherwise the default is 2.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-h</span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Prints a short summary of the options and arguments to
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <span><strong class="command">dnssec-keygen</strong></span>.
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews </p></dd>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Sets the directory in which the key files are to be written.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-k</span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Deprecated in favor of -T KEY.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Sets the protocol value for the generated key. The protocol
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews is a number between 0 and 255. The default is 3 (DNSSEC).
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Other possible values for this argument are listed in
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews RFC 2535 and its successors.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specifies the source of randomness. If the operating
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews system does not provide a <code class="filename">/dev/random</code>
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews or equivalent device, the default source of randomness
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews is keyboard input. <code class="filename">randomdev</code>
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews specifies
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews the name of a character device or file containing random
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews data to be used instead of the default. The special value
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews <code class="filename">keyboard</code> indicates that keyboard
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews input should be used.
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews </p></dd>
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews<dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews<dd><p>
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews Specifies the strength value of the key. The strength is
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews a number between 0 and 15, and currently has no defined
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews purpose in DNSSEC.
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews </p></dd>
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews<dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt>
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews<dd>
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews<p>
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews Specifies the resource record type to use for the key.
52ece689e0265f9a3e518de5b2539e749f6d35acMark Andrews <code class="option">rrtype</code> must be either DNSKEY or KEY. The
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews default is DNSKEY when using a DNSSEC algorithm, but it can be
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews overridden to KEY for use with SIG(0).
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Using any TSIG algorithm (HMAC-* or DH) forces this option
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews to KEY.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Indicates the use of the key. <code class="option">type</code> must be
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews is AUTHCONF. AUTH refers to the ability to authenticate
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews data, and CONF the ability to encrypt data.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater<dd><p>
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater Sets the debugging level.
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater </p></dd>
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater</dl></div>
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater</div>
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater<div class="refsect1" lang="en">
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater<a name="id2659430"></a><h2>TIMING OPTIONS</h2>
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater<p>
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater If the argument begins with a '+' or '-', it is interpreted as
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater an offset from the present time. If such an offset is followed
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater by one of the characters 'y', 'm', 'w', 'd', or 'h', then the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews offset is computed in years, months, weeks, days, or hours,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews respectively; otherwise it is computed in seconds.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="variablelist"><dl>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Sets the date on which a key is to be published to the zone.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews After that date, the key will be included in the zone but will
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews not be used to sign it.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Sets the date on which the key is to be activated. After that
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews date, the key will be included and the zone and used to sign
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews it.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Sets the date on which the key is to be revoked. After that
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews date, the key will be flagged as revoked. It will be included
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews in the zone and will be used to sign it.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></dd>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-U <em class="replaceable"><code>date/offset</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dd><p>
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater Sets the date on which the key is to be unpublished. After that
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater date, the key will no longer be included in the zone, but it
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater may remain in the key repository.
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater </p></dd>
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater<dd><p>
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater Sets the date on which the key is to be deleted. After that
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater date, the key can be removed from the key repository.
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater NOTE: Keys are not currently deleted automatically; this field
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater is included for informational purposes and for future
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater development.
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater </p></dd>
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater</dl></div>
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater</div>
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater<div class="refsect1" lang="en">
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater<a name="id2659528"></a><h2>GENERATED KEYS</h2>
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews When <span><strong class="command">dnssec-keygen</strong></span> completes
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews successfully,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews to the standard output. This is an identification string for
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews the key it has generated.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews<div class="itemizedlist"><ul type="disc">
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews<li><p><code class="filename">nnnn</code> is the key name.
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews </p></li>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews<li><p><code class="filename">aaa</code> is the numeric representation
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews of the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews algorithm.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p></li>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<li><p><code class="filename">iiiii</code> is the key identifier (or
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews footprint).
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater </p></li>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</ul></div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><span><strong class="command">dnssec-keygen</strong></span>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews creates two files, with names based
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews contains the public key, and
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews private
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews key.
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews </p>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews<p>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews The <code class="filename">.key</code> file contains a DNS KEY record
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews that
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews can be inserted into a zone file (directly or with a $INCLUDE
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews statement).
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The <code class="filename">.private</code> file contains
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews algorithm-specific
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews fields. For obvious security reasons, this file does not have
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews general read permission.
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews </p>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews<p>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews Both <code class="filename">.key</code> and <code class="filename">.private</code>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews files are generated for symmetric encryption algorithms such as
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews HMAC-MD5, even though the public and private key are equivalent.
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="refsect1" lang="en">
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater<a name="id2659636"></a><h2>EXAMPLE</h2>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews To generate a 768-bit DSA key for the domain
c6c78f699b55b3344fb6b17ddc854cbae4610468Automatic Updater <strong class="userinput"><code>example.com</code></strong>, the following command would be
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews issued:
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
6283056805887de88040698685b8e1936a1f7a2dAutomatic Updater </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The command would print a string of the form:
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews In this example, <span><strong class="command">dnssec-keygen</strong></span> creates
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews the files <code class="filename">Kexample.com.+003+26160.key</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews and
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="filename">Kexample.com.+003+26160.private</code>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="refsect1" lang="en">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a name="id2659761"></a><h2>SEE ALSO</h2>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark Andrews <em class="citetitle">RFC 2539</em>,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <em class="citetitle">RFC 2845</em>,
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark Andrews <em class="citetitle">RFC 4033</em>.
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark Andrews </p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<div class="refsect1" lang="en">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a name="id2659792"></a><h2>AUTHOR</h2>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><span class="corpauthor">Internet Systems Consortium</span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </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>