dnssec-keyfromlabel.html revision bfb7b680bf88c1fdd9949197b71c512c532280a4
f743002678eb67b99bbc29fee116b65d9530fec0wrowe<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5c43d2fb853f84497b5ece2d414ef9484aa87e5fsf - Copyright (C) 2008-2012, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
eeb7898b9c087040d44550f8a6b1a257783c9f0ahumbedooh - This Source Code Form is subject to the terms of the Mozilla Public
eeb7898b9c087040d44550f8a6b1a257783c9f0ahumbedooh - License, v. 2.0. If a copy of the MPL was not distributed with this
eafcc0ebf263d0ba69855b6e10958c4c1a2361bdsf - file, You can obtain one at http://mozilla.org/MPL/2.0/.
eafcc0ebf263d0ba69855b6e10958c4c1a2361bdsf<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
d7ffd2da16d58b1a0de212e4d56f7aebb72bef26sf<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
4576c1a9ef54cd1e5555ee07d016a7f559f80338sf<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
4576c1a9ef54cd1e5555ee07d016a7f559f80338sf<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
e02ff627c1e63137247e20493f6ef44b3bb1a095sf — DNSSEC key generation tool
c896413ef7cc4cf8cea20c6783d0a93a9d77dc21jailletc {-l <em class="replaceable"><code>label</code></em>}
bd3f5647b96d378d9c75c954e3f13582af32c643sf [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>]
bd3f5647b96d378d9c75c954e3f13582af32c643sf [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>]
bd3f5647b96d378d9c75c954e3f13582af32c643sf [<code class="option">-c <em class="replaceable"><code>class</code></em></code>]
bd3f5647b96d378d9c75c954e3f13582af32c643sf [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>]
2a7beea91d46beb41f043a84eaad060047ee04aafabien [<code class="option">-D sync <em class="replaceable"><code>date/offset</code></em></code>]
2a7beea91d46beb41f043a84eaad060047ee04aafabien [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>]
2a7beea91d46beb41f043a84eaad060047ee04aafabien [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>]
9e430d18dde58791589bd699416c8319560dd067jim [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>]
9e430d18dde58791589bd699416c8319560dd067jim [<code class="option">-i <em class="replaceable"><code>interval</code></em></code>]
584a85dd4047e38d3ed3a29b6662fcc9d100ae4csf [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
584a85dd4047e38d3ed3a29b6662fcc9d100ae4csf [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>]
584a85dd4047e38d3ed3a29b6662fcc9d100ae4csf [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>]
f21e9e3d0bfb7a507ecc5bc963f2159d693503d1sf [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>]
f21e9e3d0bfb7a507ecc5bc963f2159d693503d1sf [<code class="option">-P sync <em class="replaceable"><code>date/offset</code></em></code>]
f21e9e3d0bfb7a507ecc5bc963f2159d693503d1sf [<code class="option">-p <em class="replaceable"><code>protocol</code></em></code>]
f6b9c755a0b793e8a3a3aebd327ca20a86478117sf [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>]
f6b9c755a0b793e8a3a3aebd327ca20a86478117sf [<code class="option">-S <em class="replaceable"><code>key</code></em></code>]
f6b9c755a0b793e8a3a3aebd327ca20a86478117sf [<code class="option">-t <em class="replaceable"><code>type</code></em></code>]
132ee6ac1c26d6e8953836316ba50734eefab47bsf [<code class="option">-v <em class="replaceable"><code>level</code></em></code>]
f34da68471f256dca0ff770257c3e1f982f74cf1trawick <p><span class="command"><strong>dnssec-keyfromlabel</strong></span>
f34da68471f256dca0ff770257c3e1f982f74cf1trawick generates a key pair of files that referencing a key object stored
68ba377fc3b124baa759662077c48077ebadb186minfrin in a cryptographic hardware service module (HSM). The private key
68ba377fc3b124baa759662077c48077ebadb186minfrin file can be used for DNSSEC signing of zone data as if it were a
68ba377fc3b124baa759662077c48077ebadb186minfrin conventional signing key created by <span class="command"><strong>dnssec-keygen</strong></span>,
68ba377fc3b124baa759662077c48077ebadb186minfrin but the key material is stored within the HSM, and the actual signing
d776b0a2d2889ce1d13494873368f34327a2e1bbtrawick takes place there.
57db302f0875a6c93a79333b8941cea4c1827272jim The <code class="option">name</code> of the key is specified on the command
57db302f0875a6c93a79333b8941cea4c1827272jim line. This must match the name of the zone for which the key is
57db302f0875a6c93a79333b8941cea4c1827272jim being generated.
70caa242e6b90e0d6f0fabb56b8c5c2fb51717b3jorton<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
70caa242e6b90e0d6f0fabb56b8c5c2fb51717b3jorton Selects the cryptographic algorithm. The value of
109e2a09790de3fb315d36d6232a14ab66c8eb0ahumbedooh <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
109e2a09790de3fb315d36d6232a14ab66c8eb0ahumbedooh DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
109e2a09790de3fb315d36d6232a14ab66c8eb0ahumbedooh ECDSAP256SHA256, ECDSAP384SHA384, ED25519 or ED448.
74e7a30182af5e68f14ccb8d57918b22b982db8bhumbedooh These values are case insensitive.
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh If no algorithm is specified, then RSASHA1 will be used by
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh default, unless the <code class="option">-3</code> option is specified,
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh in which case NSEC3RSASHA1 will be used instead. (If
0448378b899e8df0c060360f17c0af692adf17bchumbedooh <code class="option">-3</code> is used and an algorithm is specified,
0448378b899e8df0c060360f17c0af692adf17bchumbedooh that algorithm will be checked for compatibility with NSEC3.)
60a765cccbd3f3b5997b65b0034220c79f78369etrawick Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
60a765cccbd3f3b5997b65b0034220c79f78369etrawick algorithm, and DSA is recommended.
e7ca863b04ee2a7aea7738cadbf51ce5e6c5245dhumbedooh Note 2: DH automatically sets the -k flag.
79c5787b92ac5f0e1cc82393816c77a006399316trawick Use an NSEC3-capable algorithm to generate a DNSSEC key.
79c5787b92ac5f0e1cc82393816c77a006399316trawick If this option is used and no algorithm is explicitly
79c5787b92ac5f0e1cc82393816c77a006399316trawick set on the command line, NSEC3RSASHA1 will be used by
79c5787b92ac5f0e1cc82393816c77a006399316trawick<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
12b987b969f03ef98d9175a53d849ab62f5684fecovener Specifies the cryptographic hardware to use.
7b395e4e878c28a4784919cfd2e704ddd14a3390jorton When BIND is built with OpenSSL PKCS#11 support, this defaults
7b395e4e878c28a4784919cfd2e704ddd14a3390jorton to the string "pkcs11", which identifies an OpenSSL engine
7b395e4e878c28a4784919cfd2e704ddd14a3390jorton that can drive a cryptographic accelerator or hardware service
536e48c08d674acac5d44929318f2ad928edc361jorton module. When BIND is built with native PKCS#11 cryptography
536e48c08d674acac5d44929318f2ad928edc361jorton (--enable-native-pkcs11), it defaults to the path of the PKCS#11
e81785da447b469da66f218b3f0244aab507958djorton provider library specified via "--with-pkcs11".
3e4e54d4e3fc0123c63d57aa84ac7ad7a8c73ff8jorton<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
459eaf0826f995b73a0dc066f59ea10d2824e72dsf Specifies the label for a key pair in the crypto hardware.
53e9b27aba029b18be814df40bcf6f0428771d1efuankg When <acronym class="acronym">BIND</acronym> 9 is built with OpenSSL-based
53e9b27aba029b18be814df40bcf6f0428771d1efuankg PKCS#11 support, the label is an arbitrary string that
53e9b27aba029b18be814df40bcf6f0428771d1efuankg identifies a particular key. It may be preceded by an
53e9b27aba029b18be814df40bcf6f0428771d1efuankg optional OpenSSL engine name, followed by a colon, as in
53e9b27aba029b18be814df40bcf6f0428771d1efuankg "pkcs11:<em class="replaceable"><code>keylabel</code></em>".
ca61ccd0c306c2c72df153688ba1b49f3eceed80sf When <acronym class="acronym">BIND</acronym> 9 is built with native PKCS#11
6bb524f1895f30265a1431afc460977d391cb36bsf support, the label is a PKCS#11 URI string in the format
e6dd71992459d05a676b98b7963423dc5dc1e24aminfrin "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>]"
e6dd71992459d05a676b98b7963423dc5dc1e24aminfrin Keywords include "token", which identifies the HSM; "object", which
e6dd71992459d05a676b98b7963423dc5dc1e24aminfrin identifies the key; and "pin-source", which identifies a file from
e6dd71992459d05a676b98b7963423dc5dc1e24aminfrin which the HSM's PIN code can be obtained. The label will be
23f1535d6a60817d2846bac0aea230ea475d7dccminfrin stored in the on-disk "private" file.
23f1535d6a60817d2846bac0aea230ea475d7dccminfrin If the label contains a
ec7520b24cd80d34d82bbcaca153cbb23cc04bc0rjung <code class="option">pin-source</code> field, tools using the generated
ec7520b24cd80d34d82bbcaca153cbb23cc04bc0rjung key files will be able to use the HSM for signing and other
ec7520b24cd80d34d82bbcaca153cbb23cc04bc0rjung operations without any need for an operator to manually enter
ec7520b24cd80d34d82bbcaca153cbb23cc04bc0rjung a PIN. Note: Making the HSM's PIN accessible in this manner
ec7520b24cd80d34d82bbcaca153cbb23cc04bc0rjung may reduce the security advantage of using an HSM; be sure
ec7520b24cd80d34d82bbcaca153cbb23cc04bc0rjung this is what you want to do before making use of this feature.
6249dfa569d3b4f1f539665b979a80c6e335d93etrawick<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
6249dfa569d3b4f1f539665b979a80c6e335d93etrawick Specifies the owner type of the key. The value of
ae600ca541efc686b34f8b1f21bd3d0741d37674covener <code class="option">nametype</code> must either be ZONE (for a DNSSEC
6249dfa569d3b4f1f539665b979a80c6e335d93etrawick zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
cfa64348224b66dd1c9979b809406c4d15b1c137fielding a host (KEY)),
74499a117b3b2cd9666715a14f90c0e5d1a4ee8ajim USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
cfa64348224b66dd1c9979b809406c4d15b1c137fielding These values are case insensitive.
cfa64348224b66dd1c9979b809406c4d15b1c137fielding Compatibility mode: generates an old-style key, without