man.dnssec-keyfromlabel.html revision 0e9e255d1643375056aa9ed7fe2a279713ffae78
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews - Copyright (C) 2004-2010 Internet Systems Consortium, Inc. ("ISC")
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley - Permission to use, copy, modify, and/or distribute this software for any
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley - purpose with or without fee is hereby granted, provided that the above
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley - copyright notice and this permission notice appear in all copies.
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews<!-- $Id: man.dnssec-keyfromlabel.html,v 1.104 2010/12/24 01:14:20 tbox Exp $ -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
cedb0bd0c1e3c461b7e479a16d3adfd5b150f1f4Mark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<link rel="prev" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a>�</td>
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews<th width="60%" align="center">Manual pages</th>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews<div class="cmdsynopsis"><p><code class="command">dnssec-keyfromlabel</code> {-l <em class="replaceable"><code>label</code></em>} [<code class="option">-3</code>] [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></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">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-G</code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-k</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-y</code>] {name}</p></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein gets keys with the given label from a crypto hardware and builds
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key files for DNSSEC (Secure DNS), as defined in RFC 2535
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and RFC 4034.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <code class="option">name</code> of the key is specified on the command
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein line. This must match the name of the zone for which the key is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein being generated.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Selects the cryptographic algorithm. The value of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512 or ECCGOST.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein These values are case insensitive.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If no algorithm is specified, then RSASHA1 will be used by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default, unless the <code class="option">-3</code> option is specified,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein in which case NSEC3RSASHA1 will be used instead. (If
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">-3</code> is used and an algorithm is specified,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein that algorithm will be checked for compatibility with NSEC3.)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm, and DSA is recommended.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Note 2: DH automatically sets the -k flag.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Use an NSEC3-capable algorithm to generate a DNSSEC key.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If this option is used and no algorithm is explicitly
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein set on the command line, NSEC3RSASHA1 will be used by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the name of the crypto hardware (OpenSSL engine).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein When compiled with PKCS#11 support it defaults to "pkcs11".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the label of the key pair in the crypto hardware.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The label may be preceded by an optional OpenSSL engine name,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein separated by a colon, as in "pkcs11:keylabel".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the owner type of the key. The value of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">nametype</code> must either be ZONE (for a DNSSEC
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a host (KEY)),
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein These values are case insensitive.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Compatibility mode: generates an old-style key, without
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will include the key's creation date in the metadata stored
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein with the private key, and other dates may be set there as well
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein (publication date, activation date, etc). Keys that include
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this data may be incompatible with older versions of BIND; the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">-C</code> option suppresses them.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Indicates that the DNS record containing the key should have
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the specified class. If not specified, class IN is used.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Set the specified flag in the flag field of the KEY/DNSKEY record.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The only recognized flags are KSK (Key Signing Key) and REVOKE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Generate a key, but do not publish it or sign with it. This
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein option is incompatible with -P and -A.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Prints a short summary of the options and arguments to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">dnssec-keyfromlabel</strong></span>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the directory in which the key files are to be written.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Generate KEY records rather than DNSKEY records.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the protocol value for the key. The protocol
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is a number between 0 and 255. The default is 3 (DNSSEC).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Other possible values for this argument are listed in
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein RFC 2535 and its successors.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Indicates the use of the key. <code class="option">type</code> must be
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is AUTHCONF. AUTH refers to the ability to authenticate
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein data, and CONF the ability to encrypt data.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the debugging level.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Allows DNSSEC key files to be generated even if the key ID
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein would collide with that of an existing key, in the event of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein either key being revoked. (This is only safe to use if you
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein are sure you won't be using RFC 5011 trust anchor maintenance
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein with either of the keys involved.)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If the argument begins with a '+' or '-', it is interpreted as
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein an offset from the present time. For convenience, if such an offset
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then the offset is computed in years (defined as 365 24-hour days,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ignoring leap years), months (defined as 30 24-hour days), weeks,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein days, hours, or minutes, respectively. Without a suffix, the offset
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is computed in seconds.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the date on which a key is to be published to the zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein After that date, the key will be included in the zone but will
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein not be used to sign it. If not set, and if the -G option has
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein not been used, the default is "now".
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the date on which the key is to be activated. After that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein date, the key will be included in the zone and used to sign
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein it. If not set, and if the -G option has not been used, the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default is "now".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews Sets the date on which the key is to be revoked. After that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein date, the key will be flagged as revoked. It will be included
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein in the zone and will be used to sign it.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-U <em class="replaceable"><code>date/offset</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the date on which the key is to be retired. After that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein date, the key will still be included in the zone, but it
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will not be used to sign it.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sets the date on which the key is to be deleted. After that
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews date, the key will no longer be included in the zone. (It
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein may remain in the key repository, however.)
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews<a name="id2614874"></a><h2>GENERATED KEY FILES</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein successfully,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews to the standard output. This is an identification string for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the key files it has generated.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<li><p><code class="filename">nnnn</code> is the key name.