man.dnssec-keyfromlabel.html revision fde6bfde6ec1d7a5f9907aeea8618db9dbd02f4c
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - Copyright (C) 2004-2010 Internet Systems Consortium, Inc. ("ISC")
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - Copyright (C) 2000-2003 Internet Software Consortium.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - Permission to use, copy, modify, and/or distribute this software for any
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - purpose with or without fee is hereby granted, provided that the above
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - copyright notice and this permission notice appear in all copies.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan - PERFORMANCE OF THIS SOFTWARE.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<!-- $Id: man.dnssec-keyfromlabel.html,v 1.99 2010/08/21 01:13:58 tbox Exp $ -->
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<link rel="prev" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
65aec3bcc15efc129284b5f4b6ea08df488018a9Phill Cunnington<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a>�</td>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<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>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan gets keys with the given label from a crypto hardware and builds
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan key files for DNSSEC (Secure DNS), as defined in RFC 2535
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan and RFC 4034.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan The <code class="option">name</code> of the key is specified on the command
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan line. This must match the name of the zone for which the key is
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan being generated.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan Selects the cryptographic algorithm. The value of
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256 or RSASHA512.
65aec3bcc15efc129284b5f4b6ea08df488018a9Phill Cunnington These values are case insensitive.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan If no algorithm is specified, then RSASHA1 will be used by
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan default, unless the <code class="option">-3</code> option is specified,
65aec3bcc15efc129284b5f4b6ea08df488018a9Phill Cunnington in which case NSEC3RSASHA1 will be used instead. (If
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan <code class="option">-3</code> is used and an algorithm is specified,
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan that algorithm will be checked for compatibility with NSEC3.)
65aec3bcc15efc129284b5f4b6ea08df488018a9Phill Cunnington Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan algorithm, and DSA is recommended.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan Note 2: DH automatically sets the -k flag.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan Use an NSEC3-capable algorithm to generate a DNSSEC key.
669362f1b4a40a59cfe461728c8765dbdf63159fPhill Cunnington If this option is used and no algorithm is explicitly
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan set on the command line, NSEC3RSASHA1 will be used by
65aec3bcc15efc129284b5f4b6ea08df488018a9Phill Cunnington<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan Specifies the name of the crypto hardware (OpenSSL engine).
669362f1b4a40a59cfe461728c8765dbdf63159fPhill Cunnington When compiled with PKCS#11 support it defaults to "pkcs11".
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan Specifies the label of the key pair in the crypto hardware.
669362f1b4a40a59cfe461728c8765dbdf63159fPhill Cunnington The label may be preceded by an optional OpenSSL engine name,
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan separated by a colon, as in "pkcs11:keylabel".
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
65aec3bcc15efc129284b5f4b6ea08df488018a9Phill Cunnington Specifies the owner type of the key. The value of
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan <code class="option">nametype</code> must either be ZONE (for a DNSSEC
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan a host (KEY)),
65aec3bcc15efc129284b5f4b6ea08df488018a9Phill Cunnington USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan These values are case insensitive.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan Compatibility mode: generates an old-style key, without
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan will include the key's creation date in the metadata stored
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan with the private key, and other dates may be set there as well
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan (publication date, activation date, etc). Keys that include
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan this data may be incompatible with older versions of BIND; the
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan <code class="option">-C</code> option suppresses them.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan Indicates that the DNS record containing the key should have
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan the specified class. If not specified, class IN is used.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan Set the specified flag in the flag field of the KEY/DNSKEY record.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan The only recognized flags are KSK (Key Signing Key) and REVOKE.
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan Generate a key, but do not publish it or sign with it. This
857bccfd8dc68379dcdc70acd07c6966dea365d5Dirk Hogan option is incompatible with -P and -A.