man.dnssec-keygen.html revision 6c8a888822cfe45f0525e7496dcaa27d341b6a5e
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<!--
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync - Copyright (C) 2004-2010 Internet Systems Consortium, Inc. ("ISC")
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync - Copyright (C) 2000-2003 Internet Software Consortium.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync -
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync - Permission to use, copy, modify, and/or distribute this software for any
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync - purpose with or without fee is hereby granted, provided that the above
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync - copyright notice and this permission notice appear in all copies.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync -
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync - PERFORMANCE OF THIS SOFTWARE.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync-->
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<!-- $Id: man.dnssec-keygen.html,v 1.160 2010/03/05 01:14:15 tbox Exp $ -->
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<html>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<head>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<title>dnssec-keygen</title>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<link rel="prev" href="man.dnssec-keyfromlabel.html" title="dnssec-keyfromlabel">
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<link rel="next" href="man.dnssec-revoke.html" title="dnssec-revoke">
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync</head>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<div class="navheader">
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<table width="100%" summary="Navigation header">
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<tr><th colspan="3" align="center"><span class="application">dnssec-keygen</span></th></tr>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<tr>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<td width="20%" align="left">
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<a accesskey="p" href="man.dnssec-keyfromlabel.html">Prev</a>�</td>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<th width="60%" align="center">Manual pages</th>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-revoke.html">Next</a>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</td>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</tr>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</table>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<hr>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="refentry" lang="en">
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="refnamediv">
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<h2>Name</h2>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="refsynopsisdiv">
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<h2>Synopsis</h2>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<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">-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">-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>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>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="refsect1" lang="en">
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<a name="id2612055"></a><h2>DESCRIPTION</h2>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<p><span><strong class="command">dnssec-keygen</strong></span>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync and RFC 4034. It can also generate keys for use with
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync (Transaction Key) as defined in RFC 2930.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync The <code class="option">name</code> of the key is specified on the command
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync line. For DNSSEC keys, this must match the name of the zone for
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync which the key is being generated.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="refsect1" lang="en">
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<a name="id2612075"></a><h2>OPTIONS</h2>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="variablelist"><dl>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Selects the cryptographic algorithm. For DNSSEC keys, the value
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256 or RSASHA512.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync For TSIG/TKEY, the value must
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync case insensitive.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync If no algorithm is specified, then RSASHA1 will be used by
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync default, unless the <code class="option">-3</code> option is specified,
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync in which case NSEC3RSASHA1 will be used instead. (If
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync <code class="option">-3</code> is used and an algorithm is specified,
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync that algorithm will be checked for compatibility with NSEC3.)
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync mandatory.
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync </p>
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync<p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync automatically set the -T KEY option.
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync </p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync</dd>
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync<dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<p>
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync Specifies the number of bits in the key. The choice of key
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync size depends on the algorithm used. RSA keys must be
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync between 512 and 2048 bits. Diffie Hellman keys must be between
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync 128 and 4096 bits. DSA keys must be between 512 and 1024
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync bits and an exact multiple of 64. HMAC keys must be
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync between 1 and 512 bits.
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync </p>
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync<p>
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync The key size does not need to be specified if using a default
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync algorithm. The default key size is 1024 bits for zone signing
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync keys (ZSK's) and 2048 bits for key signing keys (KSK's,
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync generated with <code class="option">-f KSK</code>). However, if an
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync algorithm is explicitly specified with the <code class="option">-a</code>,
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync then there is no default key size, and the <code class="option">-b</code>
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync must be used.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync </p>
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync</dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync<dd><p>
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync Specifies the owner type of the key. The value of
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync <code class="option">nametype</code> must either be ZONE (for a DNSSEC
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync a host (KEY)),
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync These values are case insensitive. Defaults to ZONE for DNSKEY
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync generation.
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync </p></dd>
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<dt><span class="term">-3</span></dt>
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<dd><p>
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync Use an NSEC3-capable algorithm to generate a DNSSEC key.
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync If this option is used and no algorithm is explicitly
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync set on the command line, NSEC3RSASHA1 will be used by
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync default. Note that RSASHA256 and RSASHA512 algorithms
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync are NSEC3-capable.
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync </p></dd>
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<dt><span class="term">-C</span></dt>
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<dd><p>
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync Compatibility mode: generates an old-style key, without
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync any metadata. By default, <span><strong class="command">dnssec-keygen</strong></span>
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync will include the key's creation date in the metadata stored
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync with the private key, and other dates may be set there as well
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync (publication date, activation date, etc). Keys that include
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync this data may be incompatible with older versions of BIND; the
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync <code class="option">-C</code> option suppresses them.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync </p></dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<dd><p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Indicates that the DNS record containing the key should have
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync the specified class. If not specified, class IN is used.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync </p></dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dd><p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Uses a crypto hardware (OpenSSL engine) for random number
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync and, when supported, key generation. When compiled with PKCS#11
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync support it defaults to pkcs11; the empty name resets it to
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync no engine.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync </p></dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dt><span class="term">-e</span></dt>
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync<dd><p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync If generating an RSAMD5/RSASHA1 key, use a large exponent.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync </p></dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dd><p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Set the specified flag in the flag field of the KEY/DNSKEY record.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync The only recognized flags are KSK (Key Signing Key) and REVOKE.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync </p></dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dt><span class="term">-G</span></dt>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dd><p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Generate a key, but do not publish it or sign with it. This
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync option is incompatible with -P and -A.
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync </p></dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dd><p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync If generating a Diffie Hellman key, use this generator.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Allowed values are 2 and 5. If no generator
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync is specified, a known prime from RFC 2539 will be used
f7ed3d6aa35a94b7778d693b375c5bf90dc417eevboxsync if possible; otherwise the default is 2.
f7ed3d6aa35a94b7778d693b375c5bf90dc417eevboxsync </p></dd>
f7ed3d6aa35a94b7778d693b375c5bf90dc417eevboxsync<dt><span class="term">-h</span></dt>
174fce8819e86042b6c749b155bbd5242822e968vboxsync<dd><p>
f7ed3d6aa35a94b7778d693b375c5bf90dc417eevboxsync Prints a short summary of the options and arguments to
f7ed3d6aa35a94b7778d693b375c5bf90dc417eevboxsync <span><strong class="command">dnssec-keygen</strong></span>.
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync </p></dd>
ade72f257bc4fd129248d872991a77015ca258f4vboxsync<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
ade72f257bc4fd129248d872991a77015ca258f4vboxsync<dd><p>
ade72f257bc4fd129248d872991a77015ca258f4vboxsync Sets the directory in which the key files are to be written.
ade72f257bc4fd129248d872991a77015ca258f4vboxsync </p></dd>
ade72f257bc4fd129248d872991a77015ca258f4vboxsync<dt><span class="term">-k</span></dt>
ade72f257bc4fd129248d872991a77015ca258f4vboxsync<dd><p>
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync Deprecated in favor of -T KEY.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync </p></dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dd><p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Sets the protocol value for the generated key. The protocol
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync is a number between 0 and 255. The default is 3 (DNSSEC).
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Other possible values for this argument are listed in
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync RFC 2535 and its successors.
c558b8f73de73ad85632b07ca3fb1a5b2a808ad9vboxsync </p></dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dt><span class="term">-q</span></dt>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dd><p>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync Quiet mode: Suppresses unnecessary output, including
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync progress indication. Without this option, when
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync <span><strong class="command">dnssec-keygen</strong></span> is run interactively
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync to generate an RSA or DSA key pair, it will print a string
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync of symbols to <code class="filename">stderr</code> indicating the
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync progress of the key generation. A '.' indicates that a
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync random number has been found which passed an initial
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync sieve test; '+' means a number has passed a single
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync round of the Miller-Rabin primality test; a space
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync means that the number has passed all the tests and is
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync a satisfactory key.
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync </p></dd>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
5ad4f48b2792391dd4a1aea599953037dfc8f456vboxsync<dd><p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Specifies the source of randomness. If the operating
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync system does not provide a <code class="filename">/dev/random</code>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync or equivalent device, the default source of randomness
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync is keyboard input. <code class="filename">randomdev</code>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync specifies
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync the name of a character device or file containing random
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync data to be used instead of the default. The special value
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync <code class="filename">keyboard</code> indicates that keyboard
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync input should be used.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></dd>
2dfcb21ddfd2e62718e31d5a671ff347ce32ab49vboxsync<dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
b7e7a7fe0d001d8c5af04f3448d42c6b4a3be23fvboxsync<dd><p>
b7e7a7fe0d001d8c5af04f3448d42c6b4a3be23fvboxsync Specifies the strength value of the key. The strength is
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync a number between 0 and 15, and currently has no defined
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync purpose in DNSSEC.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Specifies the resource record type to use for the key.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync <code class="option">rrtype</code> must be either DNSKEY or KEY. The
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync default is DNSKEY when using a DNSSEC algorithm, but it can be
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync overridden to KEY for use with SIG(0).
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
2dfcb21ddfd2e62718e31d5a671ff347ce32ab49vboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Using any TSIG algorithm (HMAC-* or DH) forces this option
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync to KEY.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dd><p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Indicates the use of the key. <code class="option">type</code> must be
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync is AUTHCONF. AUTH refers to the ability to authenticate
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync data, and CONF the ability to encrypt data.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dd><p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Sets the debugging level.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</dl></div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="refsect1" lang="en">
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<a name="id2666026"></a><h2>TIMING OPTIONS</h2>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync If the argument begins with a '+' or '-', it is interpreted as
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync an offset from the present time. For convenience, if such an offset
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync then the offset is computed in years (defined as 365 24-hour days,
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync ignoring leap years), months (defined as 30 24-hour days), weeks,
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync days, hours, or minutes, respectively. Without a suffix, the offset
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync is computed in seconds.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="variablelist"><dl>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dd><p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Sets the date on which a key is to be published to the zone.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync After that date, the key will be included in the zone but will
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync not be used to sign it. If not set, and if the -G option has
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync not been used, the default is "now".
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dd><p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Sets the date on which the key is to be activated. After that
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync date, the key will be included in the zone and used to sign
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync it. If not set, and if the -G option has not been used, the
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync default is "now".
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dd><p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Sets the date on which the key is to be revoked. After that
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync date, the key will be flagged as revoked. It will be included
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync in the zone and will be used to sign it.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dd><p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Sets the date on which the key is to be retired. After that
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync date, the key will still be included in the zone, but it
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync will not be used to sign it.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<dd><p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Sets the date on which the key is to be deleted. After that
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync date, the key will no longer be included in the zone. (It
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync may remain in the key repository, however.)
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></dd>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</dl></div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="refsect1" lang="en">
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<a name="id2666124"></a><h2>GENERATED KEYS</h2>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync When <span><strong class="command">dnssec-keygen</strong></span> completes
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync successfully,
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync to the standard output. This is an identification string for
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync the key it has generated.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="itemizedlist"><ul type="disc">
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<li><p><code class="filename">nnnn</code> is the key name.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></li>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<li><p><code class="filename">aaa</code> is the numeric representation
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync of the
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync algorithm.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></li>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<li><p><code class="filename">iiiii</code> is the key identifier (or
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync footprint).
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p></li>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</ul></div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p><span><strong class="command">dnssec-keygen</strong></span>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync creates two files, with names based
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync contains the public key, and
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync private
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync key.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync The <code class="filename">.key</code> file contains a DNS KEY record
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync that
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync can be inserted into a zone file (directly or with a $INCLUDE
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync statement).
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync The <code class="filename">.private</code> file contains
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync algorithm-specific
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync fields. For obvious security reasons, this file does not have
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync general read permission.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync Both <code class="filename">.key</code> and <code class="filename">.private</code>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync files are generated for symmetric encryption algorithms such as
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync HMAC-MD5, even though the public and private key are equivalent.
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync</div>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<div class="refsect1" lang="en">
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<a name="id2666369"></a><h2>EXAMPLE</h2>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync To generate a 768-bit DSA key for the domain
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync <strong class="userinput"><code>example.com</code></strong>, the following command would be
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync issued:
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync The command would print a string of the form:
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync </p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync<p>
9d6ab2e4cb34fe72107aec65496ee8c880fd95advboxsync 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="id2666425"></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="id2666456"></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>