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