man.dnssec-keyfromlabel.html revision f0aad5341752aefe5059832f6cf3abc3283c6e16
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000-2016 Internet Systems Consortium, Inc. ("ISC")
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - This Source Code Form is subject to the terms of the Mozilla Public
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - License, v. 2.0. If a copy of the MPL was not distributed with this
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - file, You can obtain one at http://mozilla.org/MPL/2.0/.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="prev" href="man.dnssec-importkey.html" title="dnssec-importkey">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<table width="100%" summary="Navigation header">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.dnssec-importkey.html">Prev</a>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="command"><strong>dnssec-keyfromlabel</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User generates a key pair of files that referencing a key object stored
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User in a cryptographic hardware service module (HSM). The private key
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt file can be used for DNSSEC signing of zone data as if it were a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein conventional signing key created by <span class="command"><strong>dnssec-keygen</strong></span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein but the key material is stored within the HSM, and the actual signing
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User takes place there.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User The <code class="option">name</code> of the key is specified on the command
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein line. This must match the name of the zone for which the key is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein being generated.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="variablelist"><dl class="variablelist">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Selects the cryptographic algorithm. The value of
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ECDSAP256SHA256 or ECDSAP384SHA384.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein These values are case insensitive.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If no algorithm is specified, then RSASHA1 will be used by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default, unless the <code class="option">-3</code> option is specified,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User in which case NSEC3RSASHA1 will be used instead. (If
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <code class="option">-3</code> is used and an algorithm is specified,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein that algorithm will be checked for compatibility with NSEC3.)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt algorithm, and DSA is recommended.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Note 2: DH automatically sets the -k flag.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Use an NSEC3-capable algorithm to generate a DNSSEC key.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If this option is used and no algorithm is explicitly
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt set on the command line, NSEC3RSASHA1 will be used by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the cryptographic hardware to use.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User When BIND is built with OpenSSL PKCS#11 support, this defaults
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt to the string "pkcs11", which identifies an OpenSSL engine
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein that can drive a cryptographic accelerator or hardware service
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein module. When BIND is built with native PKCS#11 cryptography
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein (--enable-native-pkcs11), it defaults to the path of the PKCS#11
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein provider library specified via "--with-pkcs11".
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the label for a key pair in the crypto hardware.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt When <acronym class="acronym">BIND</acronym> 9 is built with OpenSSL-based
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein PKCS#11 support, the label is an arbitrary string that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein identifies a particular key. It may be preceded by an
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein optional OpenSSL engine name, followed by a colon, as in
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "pkcs11:<em class="replaceable"><code>keylabel</code></em>".
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt When <acronym class="acronym">BIND</acronym> 9 is built with native PKCS#11
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein support, the label is a PKCS#11 URI string in the format
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User "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>]"
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Keywords include "token", which identifies the HSM; "object", which
fc74b733bf679e1b3fb1599e32d445dffe325208Tinderbox User identifies the key; and "pin-source", which identifies a file from
5d564da348e890e42f63eebf2dced9a05b41f4fbTinderbox User which the HSM's PIN code can be obtained. The label will be
fc74b733bf679e1b3fb1599e32d445dffe325208Tinderbox User stored in the on-disk "private" file.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User If the label contains a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">pin-source</code> field, tools using the generated
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key files will be able to use the HSM for signing and other
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein operations without any need for an operator to manually enter
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a PIN. Note: Making the HSM's PIN accessible in this manner
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein may reduce the security advantage of using an HSM; be sure
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this is what you want to do before making use of this feature.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the owner type of the key. The value of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">nametype</code> must either be ZONE (for a DNSSEC
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews a host (KEY)),
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein These values are case insensitive.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Compatibility mode: generates an old-style key, without