dnssec-keygen.html revision cd791043c8a6edbcacc2392575a9816d19b8157c
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<!--
50d79c1309ae865ee83d3b6dc56b3d39825947b2Automatic Updater - Copyright (C) 2004, 2005, 2007-2012 Internet Systems Consortium, Inc. ("ISC")
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence -
ec5347e2c775f027573ce5648b910361aa926c01Automatic Updater - Permission to use, copy, modify, and/or distribute this software for any
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson - purpose with or without fee is hereby granted, provided that the above
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson - copyright notice and this permission notice appear in all copies.
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence -
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson-->
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<!-- $Id$ -->
bc298cd0f77dce2d452efd3e3d3153e2a9a17dbfMark Andrews<html>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein<head>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<title>dnssec-keygen</title>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson</head>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
6028d1ce0380d0ba7f6c6ecd1ad20b31ddd1becbDavid Lawrence<a name="man.dnssec-keygen"></a><div class="titlepage"></div>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<div class="refnamediv">
cc6d67469cf390842adf1bd35dd2b21fc3b7df18Mark Andrews<h2>Name</h2>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<p><span class="application">dnssec-keygen</span> &#8212; DNSSEC key generation tool</p>
16a68807e13caea3183a41a5292f1b3f48b81a26Mark Andrews</div>
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence<div class="refsynopsisdiv">
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews<h2>Synopsis</h2>
21a0926b4fa495f53371f89961e7560b0b235192Andreas Gustafsson<div class="cmdsynopsis"><p><code class="command">dnssec-keygen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-3</code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-C</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] [<code class="option">-e</code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-g <em class="replaceable"><code>generator</code></em></code>] [<code class="option">-h</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-k</code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-q</code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-S <em class="replaceable"><code>key</code></em></code>] [<code class="option">-s <em class="replaceable"><code>strength</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-z</code>] {name}</p></div>
364a82f7c25b62967678027043425201a5e5171aBob Halley</div>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<div class="refsect1" lang="en">
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<a name="id2543594"></a><h2>DESCRIPTION</h2>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<p><span><strong class="command">dnssec-keygen</strong></span>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson generates keys for DNSSEC (Secure DNS), as defined in RFC 2535
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson and RFC 4034. It can also generate keys for use with
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff (Transaction Key) as defined in RFC 2930.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<p>
f3ca27e9fe307b55e35ea8d7b37351650630e5a3Andreas Gustafsson The <code class="option">name</code> of the key is specified on the command
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson line. For DNSSEC keys, this must match the name of the zone for
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson which the key is being generated.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson</div>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews<div class="refsect1" lang="en">
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews<a name="id2543612"></a><h2>OPTIONS</h2>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews<div class="variablelist"><dl>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dd>
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence<p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Selects the cryptographic algorithm. For DNSSEC keys, the value
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson of <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews ECDSAP256SHA256 or ECDSAP384SHA384.
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews For TSIG/TKEY, the value must
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews be DH (Diffie Hellman), HMAC-MD5, HMAC-SHA1, HMAC-SHA224,
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. These values are
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews case insensitive.
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews </p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson If no algorithm is specified, then RSASHA1 will be used by
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson default, unless the <code class="option">-3</code> option is specified,
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson in which case NSEC3RSASHA1 will be used instead. (If
34b394b43e2207e8f8f3703f0402422121455638David Lawrence <code class="option">-3</code> is used and an algorithm is specified,
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson that algorithm will be checked for compatibility with NSEC3.)
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson algorithm, and DSA is recommended. For TSIG, HMAC-MD5 is
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson mandatory.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Note 2: DH, HMAC-MD5, and HMAC-SHA1 through HMAC-SHA512
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson automatically set the -T KEY option.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson</dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Specifies the number of bits in the key. The choice of key
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson size depends on the algorithm used. RSA keys must be
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson between 512 and 2048 bits. Diffie Hellman keys must be between
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson 128 and 4096 bits. DSA keys must be between 512 and 1024
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson bits and an exact multiple of 64. HMAC keys must be
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson between 1 and 512 bits. Elliptic curve algorithms don't need
6ea5cc5f021928d4f25fa0d9ef0e66e21fba4087David Lawrence this parameter.
806c235ecf533b98d068b3f8df9d7abbe1e30cf9Mark Andrews </p>
806c235ecf533b98d068b3f8df9d7abbe1e30cf9Mark Andrews<p>
806c235ecf533b98d068b3f8df9d7abbe1e30cf9Mark Andrews The key size does not need to be specified if using a default
806c235ecf533b98d068b3f8df9d7abbe1e30cf9Mark Andrews algorithm. The default key size is 1024 bits for zone signing
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson keys (ZSK's) and 2048 bits for key signing keys (KSK's,
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence generated with <code class="option">-f KSK</code>). However, if an
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson algorithm is explicitly specified with the <code class="option">-a</code>,
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson then there is no default key size, and the <code class="option">-b</code>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson must be used.
419590499823ce15b5d2ad4fe71eaf04bd5a86c0Michael Graff </p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson</dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dd><p>
419590499823ce15b5d2ad4fe71eaf04bd5a86c0Michael Graff Specifies the owner type of the key. The value of
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <code class="option">nametype</code> must either be ZONE (for a DNSSEC
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
bc298cd0f77dce2d452efd3e3d3153e2a9a17dbfMark Andrews a host (KEY)),
bc298cd0f77dce2d452efd3e3d3153e2a9a17dbfMark Andrews USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
21a0926b4fa495f53371f89961e7560b0b235192Andreas Gustafsson These values are case insensitive. Defaults to ZONE for DNSKEY
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson generation.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p></dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-3</span></dt>
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence<dd><p>
21a0926b4fa495f53371f89961e7560b0b235192Andreas Gustafsson Use an NSEC3-capable algorithm to generate a DNSSEC key.
21a0926b4fa495f53371f89961e7560b0b235192Andreas Gustafsson If this option is used and no algorithm is explicitly
21a0926b4fa495f53371f89961e7560b0b235192Andreas Gustafsson set on the command line, NSEC3RSASHA1 will be used by
21a0926b4fa495f53371f89961e7560b0b235192Andreas Gustafsson default. Note that RSASHA256, RSASHA512, ECCGOST,
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence ECDSAP256SHA256 and ECDSAP384SHA384 algorithms
21a0926b4fa495f53371f89961e7560b0b235192Andreas Gustafsson are NSEC3-capable.
21a0926b4fa495f53371f89961e7560b0b235192Andreas Gustafsson </p></dd>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews<dt><span class="term">-C</span></dt>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews<dd><p>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews Compatibility mode: generates an old-style key, without
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews any metadata. By default, <span><strong class="command">dnssec-keygen</strong></span>
bc298cd0f77dce2d452efd3e3d3153e2a9a17dbfMark Andrews will include the key's creation date in the metadata stored
bc298cd0f77dce2d452efd3e3d3153e2a9a17dbfMark Andrews with the private key, and other dates may be set there as well
bc298cd0f77dce2d452efd3e3d3153e2a9a17dbfMark Andrews (publication date, activation date, etc). Keys that include
bc298cd0f77dce2d452efd3e3d3153e2a9a17dbfMark Andrews this data may be incompatible with older versions of BIND; the
bc298cd0f77dce2d452efd3e3d3153e2a9a17dbfMark Andrews <code class="option">-C</code> option suppresses them.
bc298cd0f77dce2d452efd3e3d3153e2a9a17dbfMark Andrews </p></dd>
bc298cd0f77dce2d452efd3e3d3153e2a9a17dbfMark Andrews<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dd><p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Indicates that the DNS record containing the key should have
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff the specified class. If not specified, class IN is used.
8f674b13e8e7cd6309751e4971e1b00d04a418b8Brian Wellington </p></dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dd><p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Uses a crypto hardware (OpenSSL engine) for random number
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson and, when supported, key generation. When compiled with PKCS#11
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson support it defaults to pkcs11; the empty name resets it to
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson no engine.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p></dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-e</span></dt>
34b394b43e2207e8f8f3703f0402422121455638David Lawrence<dd><p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson If generating an RSAMD5/RSASHA1 key, use a large exponent.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p></dd>
5eb91bd90e3ad3426e5e3213031556a737cf3809Mark Andrews<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dd><p>
cc6d67469cf390842adf1bd35dd2b21fc3b7df18Mark Andrews Set the specified flag in the flag field of the KEY/DNSKEY record.
cc6d67469cf390842adf1bd35dd2b21fc3b7df18Mark Andrews The only recognized flags are KSK (Key Signing Key) and REVOKE.
cc6d67469cf390842adf1bd35dd2b21fc3b7df18Mark Andrews </p></dd>
cc6d67469cf390842adf1bd35dd2b21fc3b7df18Mark Andrews<dt><span class="term">-G</span></dt>
cc6d67469cf390842adf1bd35dd2b21fc3b7df18Mark Andrews<dd><p>
cc6d67469cf390842adf1bd35dd2b21fc3b7df18Mark Andrews Generate a key, but do not publish it or sign with it. This
cc6d67469cf390842adf1bd35dd2b21fc3b7df18Mark Andrews option is incompatible with -P and -A.
cc6d67469cf390842adf1bd35dd2b21fc3b7df18Mark Andrews </p></dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-g <em class="replaceable"><code>generator</code></em></span></dt>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dd><p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson If generating a Diffie Hellman key, use this generator.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Allowed values are 2 and 5. If no generator
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews is specified, a known prime from RFC 2539 will be used
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson if possible; otherwise the default is 2.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p></dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-h</span></dt>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dd><p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Prints a short summary of the options and arguments to
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence <span><strong class="command">dnssec-keygen</strong></span>.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p></dd>
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews<dd><p>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews Sets the directory in which the key files are to be written.
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence </p></dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-k</span></dt>
f1b68725503ff3e46001eee5a1751e29a43a09d1Andreas Gustafsson<dd><p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Deprecated in favor of -T KEY.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p></dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews<dd><p>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews Sets the default TTL to use for this key when it is converted
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews into a DNSKEY RR. If the key is imported into a zone,
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews this is the TTL that will be used for it, unless there was
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews already a DNSKEY RRset in place, in which case the existing TTL
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews would take precedence. Setting the default TTL to
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews <code class="literal">0</code> or <code class="literal">none</code> removes it.
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews </p></dd>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
215ef83bbed20727813a52ddcdbcd1455856638bMark Andrews<dd><p>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Sets the protocol value for the generated key. The protocol
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson is a number between 0 and 255. The default is 3 (DNSSEC).
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson Other possible values for this argument are listed in
419590499823ce15b5d2ad4fe71eaf04bd5a86c0Michael Graff RFC 2535 and its successors.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </p></dd>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson<dt><span class="term">-q</span></dt>
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff<dd><p>
8f674b13e8e7cd6309751e4971e1b00d04a418b8Brian Wellington Quiet mode: Suppresses unnecessary output, including
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson progress indication. Without this option, when
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff <span><strong class="command">dnssec-keygen</strong></span> is run interactively
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson to generate an RSA or DSA key pair, it will print a string
419590499823ce15b5d2ad4fe71eaf04bd5a86c0Michael Graff of symbols to <code class="filename">stderr</code> indicating the
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson progress of the key generation. A '.' indicates that a
28b863e609ff2d97b78663b46894494cfa2ea411Mark Andrews random number has been found which passed an initial
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson sieve test; '+' means a number has passed a single
34b394b43e2207e8f8f3703f0402422121455638David Lawrence round of the Miller-Rabin primality test; a space
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson means that the number has passed all the tests and is
a satisfactory key.
</p></dd>
<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
<dd><p>
Specifies the source of randomness. If the operating
system does not provide a <code class="filename">/dev/random</code>
or equivalent device, the default source of randomness
is keyboard input. <code class="filename">randomdev</code>
specifies
the name of a character device or file containing random
data to be used instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard
input should be used.
</p></dd>
<dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
<dd><p>
Create a new key which is an explicit successor to an
existing key. The name, algorithm, size, and type of the
key will be set to match the existing key. The activation
date of the new key will be set to the inactivation date of
the existing one. The publication date will be set to the
activation date minus the prepublication interval, which
defaults to 30 days.
</p></dd>
<dt><span class="term">-s <em class="replaceable"><code>strength</code></em></span></dt>
<dd><p>
Specifies the strength value of the key. The strength is
a number between 0 and 15, and currently has no defined
purpose in DNSSEC.
</p></dd>
<dt><span class="term">-T <em class="replaceable"><code>rrtype</code></em></span></dt>
<dd>
<p>
Specifies the resource record type to use for the key.
<code class="option">rrtype</code> must be either DNSKEY or KEY. The
default is DNSKEY when using a DNSSEC algorithm, but it can be
overridden to KEY for use with SIG(0).
</p>
<p>
</p>
<p>
Using any TSIG algorithm (HMAC-* or DH) forces this option
to KEY.
</p>
</dd>
<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
<dd><p>
Indicates the use of the key. <code class="option">type</code> must be
one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
is AUTHCONF. AUTH refers to the ability to authenticate
data, and CONF the ability to encrypt data.
</p></dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
<dd><p>
Sets the debugging level.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2544204"></a><h2>TIMING OPTIONS</h2>
<p>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
If the argument begins with a '+' or '-', it is interpreted as
an offset from the present time. For convenience, if such an offset
is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
then the offset is computed in years (defined as 365 24-hour days,
ignoring leap years), months (defined as 30 24-hour days), weeks,
days, hours, or minutes, respectively. Without a suffix, the offset
is computed in seconds.
</p>
<div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which a key is to be published to the zone.
After that date, the key will be included in the zone but will
not be used to sign it. If not set, and if the -G option has
not been used, the default is "now".
</p></dd>
<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be activated. After that
date, the key will be included in the zone and used to sign
it. If not set, and if the -G option has not been used, the
default is "now".
</p></dd>
<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be revoked. After that
date, the key will be flagged as revoked. It will be included
in the zone and will be used to sign it.
</p></dd>
<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be retired. After that
date, the key will still be included in the zone, but it
will not be used to sign it.
</p></dd>
<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be deleted. After that
date, the key will no longer be included in the zone. (It
may remain in the key repository, however.)
</p></dd>
<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
<dd>
<p>
Sets the prepublication interval for a key. If set, then
the publication and activation dates must be separated by at least
this much time. If the activation date is specified but the
publication date isn't, then the publication date will default
to this much time before the activation date; conversely, if
the publication date is specified but activation date isn't,
then activation will be set to this much time after publication.
</p>
<p>
If the key is being created as an explicit successor to another
key, then the default prepublication interval is 30 days;
otherwise it is zero.
</p>
<p>
As with date offsets, if the argument is followed by one of
the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
interval is measured in years, months, weeks, days, hours,
or minutes, respectively. Without a suffix, the interval is
measured in seconds.
</p>
</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2544394"></a><h2>GENERATED KEYS</h2>
<p>
When <span><strong class="command">dnssec-keygen</strong></span> completes
successfully,
it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
to the standard output. This is an identification string for
the key it has generated.
</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="filename">nnnn</code> is the key name.
</p></li>
<li><p><code class="filename">aaa</code> is the numeric representation
of the
algorithm.
</p></li>
<li><p><code class="filename">iiiii</code> is the key identifier (or
footprint).
</p></li>
</ul></div>
<p><span><strong class="command">dnssec-keygen</strong></span>
creates two files, with names based
on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
contains the public key, and
<code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
private
key.
</p>
<p>
The <code class="filename">.key</code> file contains a DNS KEY record
that
can be inserted into a zone file (directly or with a $INCLUDE
statement).
</p>
<p>
The <code class="filename">.private</code> file contains
algorithm-specific
fields. For obvious security reasons, this file does not have
general read permission.
</p>
<p>
Both <code class="filename">.key</code> and <code class="filename">.private</code>
files are generated for symmetric encryption algorithms such as
HMAC-MD5, even though the public and private key are equivalent.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2544476"></a><h2>EXAMPLE</h2>
<p>
To generate a 768-bit DSA key for the domain
<strong class="userinput"><code>example.com</code></strong>, the following command would be
issued:
</p>
<p><strong class="userinput"><code>dnssec-keygen -a DSA -b 768 -n ZONE example.com</code></strong>
</p>
<p>
The command would print a string of the form:
</p>
<p><strong class="userinput"><code>Kexample.com.+003+26160</code></strong>
</p>
<p>
In this example, <span><strong class="command">dnssec-keygen</strong></span> creates
the files <code class="filename">Kexample.com.+003+26160.key</code>
and
<code class="filename">Kexample.com.+003+26160.private</code>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2544588"></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="id2544619"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div></body>
</html>