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