man.dnssec-keyfromlabel.html revision 70b01b2d03d66b28d97f5cf4fd49ecd74418b065
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
a7ff1335befc75bdbfc0addba7306dec7bb6202ccolm - Copyright (C) 2000-2003 Internet Software Consortium.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - Permission to use, copy, modify, and/or distribute this software for any
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - purpose with or without fee is hereby granted, provided that the above
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - copyright notice and this permission notice appear in all copies.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
92adf051614160febf3e95c5b51ffd0a0908f052wrowe - PERFORMANCE OF THIS SOFTWARE.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<!-- $Id$ -->
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<link rel="prev" href="man.dnssec-importkey.html" title="dnssec-importkey">
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<a accesskey="p" href="man.dnssec-importkey.html">Prev</a>�</td>
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<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">-i <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-k</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">-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">-S <em class="replaceable"><code>key</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>
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
92adf051614160febf3e95c5b51ffd0a0908f052wrowe generates a key pair of files that referencing a key object stored
92adf051614160febf3e95c5b51ffd0a0908f052wrowe in a cryptographic hardware service module (HSM). The private key
92adf051614160febf3e95c5b51ffd0a0908f052wrowe file can be used for DNSSEC signing of zone data as if it were a
92adf051614160febf3e95c5b51ffd0a0908f052wrowe conventional signing key created by <span><strong class="command">dnssec-keygen</strong></span>,
92adf051614160febf3e95c5b51ffd0a0908f052wrowe but the key material is stored within the HSM, and the actual signing
92adf051614160febf3e95c5b51ffd0a0908f052wrowe takes place there.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe The <code class="option">name</code> of the key is specified on the command
92adf051614160febf3e95c5b51ffd0a0908f052wrowe line. This must match the name of the zone for which the key is
92adf051614160febf3e95c5b51ffd0a0908f052wrowe being generated.
695cbdea48fde06a0da432a4e3a4a316d7751d0achrisd<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
a7ff1335befc75bdbfc0addba7306dec7bb6202ccolm Selects the cryptographic algorithm. The value of
92adf051614160febf3e95c5b51ffd0a0908f052wrowe <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
92adf051614160febf3e95c5b51ffd0a0908f052wrowe DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
92adf051614160febf3e95c5b51ffd0a0908f052wrowe ECDSAP256SHA256 or ECDSAP384SHA384.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe These values are case insensitive.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe If no algorithm is specified, then RSASHA1 will be used by
92adf051614160febf3e95c5b51ffd0a0908f052wrowe default, unless the <code class="option">-3</code> option is specified,
92adf051614160febf3e95c5b51ffd0a0908f052wrowe in which case NSEC3RSASHA1 will be used instead. (If
92adf051614160febf3e95c5b51ffd0a0908f052wrowe <code class="option">-3</code> is used and an algorithm is specified,
92adf051614160febf3e95c5b51ffd0a0908f052wrowe that algorithm will be checked for compatibility with NSEC3.)
92adf051614160febf3e95c5b51ffd0a0908f052wrowe Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
92adf051614160febf3e95c5b51ffd0a0908f052wrowe algorithm, and DSA is recommended.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe Note 2: DH automatically sets the -k flag.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe Use an NSEC3-capable algorithm to generate a DNSSEC key.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe If this option is used and no algorithm is explicitly
92adf051614160febf3e95c5b51ffd0a0908f052wrowe set on the command line, NSEC3RSASHA1 will be used by
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
92adf051614160febf3e95c5b51ffd0a0908f052wrowe Specifies the cryptographic hardware to use.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe When BIND is built with OpenSSL PKCS#11 support, this defaults
92adf051614160febf3e95c5b51ffd0a0908f052wrowe to the string "pkcs11", which identifies an OpenSSL engine
92adf051614160febf3e95c5b51ffd0a0908f052wrowe that can drive a cryptographic accelerator or hardware service
92adf051614160febf3e95c5b51ffd0a0908f052wrowe module. When BIND is built with native PKCS#11 cryptography
92adf051614160febf3e95c5b51ffd0a0908f052wrowe (--enable-native-pkcs11), it defaults to the path of the PKCS#11
92adf051614160febf3e95c5b51ffd0a0908f052wrowe provider library specified via "--with-pkcs11".
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
92adf051614160febf3e95c5b51ffd0a0908f052wrowe Specifies the label for a key pair in the crypto hardware.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe When <acronym class="acronym">BIND</acronym> 9 is built with OpenSSL-based
92adf051614160febf3e95c5b51ffd0a0908f052wrowe PKCS#11 support, the label is an arbitrary string that
92adf051614160febf3e95c5b51ffd0a0908f052wrowe identifies a particular key. It may be preceded by an
92adf051614160febf3e95c5b51ffd0a0908f052wrowe optional OpenSSL engine name, followed by a colon, as in
92adf051614160febf3e95c5b51ffd0a0908f052wrowe "pkcs11:<em class="replaceable"><code>keylabel</code></em>".
92adf051614160febf3e95c5b51ffd0a0908f052wrowe When <acronym class="acronym">BIND</acronym> 9 is built with native PKCS#11
92adf051614160febf3e95c5b51ffd0a0908f052wrowe support, the label is a PKCS#11 URI string in the format
92adf051614160febf3e95c5b51ffd0a0908f052wrowe "pkcs11:<code class="option">keyword</code>=<em class="replaceable"><code>value</code></em>[<span class="optional">;<code class="option">keyword</code>=<em class="replaceable"><code>value</code></em>;...</span>]"
92adf051614160febf3e95c5b51ffd0a0908f052wrowe Keywords include "token", which identifies the HSM; "object", which
92adf051614160febf3e95c5b51ffd0a0908f052wrowe identifies the key; and "pin-source", which identifies a file from
92adf051614160febf3e95c5b51ffd0a0908f052wrowe which the HSM's PIN code can be obtained. The label will be
92adf051614160febf3e95c5b51ffd0a0908f052wrowe stored in the on-disk "private" file.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe If the label contains a
92adf051614160febf3e95c5b51ffd0a0908f052wrowe <code class="option">pin-source</code> field, tools using the generated
92adf051614160febf3e95c5b51ffd0a0908f052wrowe key files will be able to use the HSM for signing and other
92adf051614160febf3e95c5b51ffd0a0908f052wrowe operations without any need for an operator to manually enter
92adf051614160febf3e95c5b51ffd0a0908f052wrowe a PIN. Note: Making the HSM's PIN accessible in this manner
92adf051614160febf3e95c5b51ffd0a0908f052wrowe may reduce the security advantage of using an HSM; be sure
92adf051614160febf3e95c5b51ffd0a0908f052wrowe this is what you want to do before making use of this feature.
92adf051614160febf3e95c5b51ffd0a0908f052wrowe<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
92adf051614160febf3e95c5b51ffd0a0908f052wrowe Specifies the owner type of the key. The value of
92adf051614160febf3e95c5b51ffd0a0908f052wrowe <code class="option">nametype</code> must either be ZONE (for a DNSSEC
92adf051614160febf3e95c5b51ffd0a0908f052wrowe zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
92adf051614160febf3e95c5b51ffd0a0908f052wrowe a host (KEY)),
92adf051614160febf3e95c5b51ffd0a0908f052wrowe USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
92adf051614160febf3e95c5b51ffd0a0908f052wrowe These values are case insensitive.