dnssec-keyfromlabel.html revision 33d0a7767d53cb366039fd0ac4f63cf8a9c351b0
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - Copyright (C) 2008-2012, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - Permission to use, copy, modify, and/or distribute this software for any
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - purpose with or without fee is hereby granted, provided that the above
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - copyright notice and this permission notice appear in all copies.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync - PERFORMANCE OF THIS SOFTWARE.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync<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>
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync<p><span class="command"><strong>dnssec-keyfromlabel</strong></span>
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync generates a key pair of files that referencing a key object stored
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync in a cryptographic hardware service module (HSM). The private key
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync file can be used for DNSSEC signing of zone data as if it were a
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync conventional signing key created by <span class="command"><strong>dnssec-keygen</strong></span>,
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync but the key material is stored within the HSM, and the actual signing
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync takes place there.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync The <code class="option">name</code> of the key is specified on the command
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync line. This must match the name of the zone for which the key is
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync being generated.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync Selects the cryptographic algorithm. The value of
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync ECDSAP256SHA256 or ECDSAP384SHA384.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync These values are case insensitive.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync If no algorithm is specified, then RSASHA1 will be used by
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync default, unless the <code class="option">-3</code> option is specified,
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync in which case NSEC3RSASHA1 will be used instead. (If
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync <code class="option">-3</code> is used and an algorithm is specified,
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync that algorithm will be checked for compatibility with NSEC3.)
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync algorithm, and DSA is recommended.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync Note 2: DH automatically sets the -k flag.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync Use an NSEC3-capable algorithm to generate a DNSSEC key.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync If this option is used and no algorithm is explicitly
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync set on the command line, NSEC3RSASHA1 will be used by
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync Specifies the cryptographic hardware to use.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync When BIND is built with OpenSSL PKCS#11 support, this defaults
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync to the string "pkcs11", which identifies an OpenSSL engine
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync that can drive a cryptographic accelerator or hardware service
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync module. When BIND is built with native PKCS#11 cryptography
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync (--enable-native-pkcs11), it defaults to the path of the PKCS#11
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync provider library specified via "--with-pkcs11".
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync Specifies the label for a key pair in the crypto hardware.
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync When <acronym class="acronym">BIND</acronym> 9 is built with OpenSSL-based
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync PKCS#11 support, the label is an arbitrary string that
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync identifies a particular key. It may be preceded by an
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync optional OpenSSL engine name, followed by a colon, as in
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync "pkcs11:<em class="replaceable"><code>keylabel</code></em>".
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync When <acronym class="acronym">BIND</acronym> 9 is built with native PKCS#11
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync support, the label is a PKCS#11 URI string in the format
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync "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>]"
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync Keywords include "token", which identifies the HSM; "object", which
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync identifies the key; and "pin-source", which identifies a file from
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync which the HSM's PIN code can be obtained. The label will be
2e848e79ccf2e4285250a0af98ddb9eb28864878vboxsync stored in the on-disk "private" file.