man.dnssec-keyfromlabel.html revision cefd74ae81cf51692af3a38c1330261a5110fca7
3515994554d167522343ce57417648b39370ccabcilix<!--
3515994554d167522343ce57417648b39370ccabcilix - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
3515994554d167522343ce57417648b39370ccabcilix - Copyright (C) 2000-2003 Internet Software Consortium.
3515994554d167522343ce57417648b39370ccabcilix -
3515994554d167522343ce57417648b39370ccabcilix - Permission to use, copy, modify, and/or distribute this software for any
3515994554d167522343ce57417648b39370ccabcilix - purpose with or without fee is hereby granted, provided that the above
3515994554d167522343ce57417648b39370ccabcilix - copyright notice and this permission notice appear in all copies.
3515994554d167522343ce57417648b39370ccabcilix -
3515994554d167522343ce57417648b39370ccabcilix - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
3515994554d167522343ce57417648b39370ccabcilix - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
3515994554d167522343ce57417648b39370ccabcilix - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
3515994554d167522343ce57417648b39370ccabcilix - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
3515994554d167522343ce57417648b39370ccabcilix - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
3515994554d167522343ce57417648b39370ccabcilix - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f8df4b9f0c17f7a47d467583bd9e4e2e89a9237dcilix - PERFORMANCE OF THIS SOFTWARE.
3515994554d167522343ce57417648b39370ccabcilix-->
3515994554d167522343ce57417648b39370ccabcilix<!-- $Id$ -->
3515994554d167522343ce57417648b39370ccabcilix<html>
3515994554d167522343ce57417648b39370ccabcilix<head>
3515994554d167522343ce57417648b39370ccabcilix<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3515994554d167522343ce57417648b39370ccabcilix<title>dnssec-keyfromlabel</title>
3515994554d167522343ce57417648b39370ccabcilix<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
3515994554d167522343ce57417648b39370ccabcilix<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
3515994554d167522343ce57417648b39370ccabcilix<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
ae07f331747953e1b35a4415004f8be9cf1ea003cilix<link rel="prev" href="man.dnssec-importkey.html" title="dnssec-importkey">
6bbf41c7e0d07ad73b5858518f850966e8170103cilix<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
6bbf41c7e0d07ad73b5858518f850966e8170103cilix</head>
6bbf41c7e0d07ad73b5858518f850966e8170103cilix<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
3515994554d167522343ce57417648b39370ccabcilix<div class="navheader">
3515994554d167522343ce57417648b39370ccabcilix<table width="100%" summary="Navigation header">
3515994554d167522343ce57417648b39370ccabcilix<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
3515994554d167522343ce57417648b39370ccabcilix<tr>
3515994554d167522343ce57417648b39370ccabcilix<td width="20%" align="left">
b8502defa91647a317b285046a49546612f66e6dKris<a accesskey="p" href="man.dnssec-importkey.html">Prev</a>�</td>
3515994554d167522343ce57417648b39370ccabcilix<th width="60%" align="center">Manual pages</th>
3515994554d167522343ce57417648b39370ccabcilix<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
3515994554d167522343ce57417648b39370ccabcilix</td>
3515994554d167522343ce57417648b39370ccabcilix</tr>
3515994554d167522343ce57417648b39370ccabcilix</table>
3515994554d167522343ce57417648b39370ccabcilix<hr>
3515994554d167522343ce57417648b39370ccabcilix</div>
3515994554d167522343ce57417648b39370ccabcilix<div class="refentry" lang="en">
3515994554d167522343ce57417648b39370ccabcilix<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
3515994554d167522343ce57417648b39370ccabcilix<div class="refnamediv">
3515994554d167522343ce57417648b39370ccabcilix<h2>Name</h2>
0b2d8abc1011ad865fce3b883ccb2587cb15cc90Johan B. C. Engelen<p><span class="application">dnssec-keyfromlabel</span> &#8212; DNSSEC key generation tool</p>
3515994554d167522343ce57417648b39370ccabcilix</div>
f68aabe351946119c80978525cd86564dd33e02fJon A. Cruz<div class="refsynopsisdiv">
3515994554d167522343ce57417648b39370ccabcilix<h2>Synopsis</h2>
3515994554d167522343ce57417648b39370ccabcilix<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">-V</code>] [<code class="option">-y</code>] {name}</p></div>
3515994554d167522343ce57417648b39370ccabcilix</div>
3515994554d167522343ce57417648b39370ccabcilix<div class="refsect1" lang="en">
3515994554d167522343ce57417648b39370ccabcilix<a name="id2620593"></a><h2>DESCRIPTION</h2>
3515994554d167522343ce57417648b39370ccabcilix<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
3515994554d167522343ce57417648b39370ccabcilix generates a key pair of files that referencing a key object stored
f8df4b9f0c17f7a47d467583bd9e4e2e89a9237dcilix in a cryptographic hardware service module (HSM). The private key
f8df4b9f0c17f7a47d467583bd9e4e2e89a9237dcilix file can be used for DNSSEC signing of zone data as if it were a
3515994554d167522343ce57417648b39370ccabcilix conventional signing key created by <span><strong class="command">dnssec-keygen</strong></span>,
80a38fd6ed41a1c70f1cc961df821932aafb6764dvlierop but the key material is stored within the HSM, and the actual signing
80a38fd6ed41a1c70f1cc961df821932aafb6764dvlierop takes place there.
3515994554d167522343ce57417648b39370ccabcilix </p>
80a38fd6ed41a1c70f1cc961df821932aafb6764dvlierop<p>
3515994554d167522343ce57417648b39370ccabcilix The <code class="option">name</code> of the key is specified on the command
3515994554d167522343ce57417648b39370ccabcilix line. This must match the name of the zone for which the key is
3515994554d167522343ce57417648b39370ccabcilix being generated.
3515994554d167522343ce57417648b39370ccabcilix </p>
6bbf41c7e0d07ad73b5858518f850966e8170103cilix</div>
80a38fd6ed41a1c70f1cc961df821932aafb6764dvlierop<div class="refsect1" lang="en">
3515994554d167522343ce57417648b39370ccabcilix<a name="id2620618"></a><h2>OPTIONS</h2>
3515994554d167522343ce57417648b39370ccabcilix<div class="variablelist"><dl>
6bbf41c7e0d07ad73b5858518f850966e8170103cilix<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
80a38fd6ed41a1c70f1cc961df821932aafb6764dvlierop<dd>
3515994554d167522343ce57417648b39370ccabcilix<p>
3515994554d167522343ce57417648b39370ccabcilix Selects the cryptographic algorithm. The value of
3515994554d167522343ce57417648b39370ccabcilix <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
80a38fd6ed41a1c70f1cc961df821932aafb6764dvlierop DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
3515994554d167522343ce57417648b39370ccabcilix ECDSAP256SHA256 or ECDSAP384SHA384.
3515994554d167522343ce57417648b39370ccabcilix These values are case insensitive.
3515994554d167522343ce57417648b39370ccabcilix </p>
3515994554d167522343ce57417648b39370ccabcilix<p>
3515994554d167522343ce57417648b39370ccabcilix If no algorithm is specified, then RSASHA1 will be used by
3515994554d167522343ce57417648b39370ccabcilix default, unless the <code class="option">-3</code> option is specified,
3515994554d167522343ce57417648b39370ccabcilix in which case NSEC3RSASHA1 will be used instead. (If
3515994554d167522343ce57417648b39370ccabcilix <code class="option">-3</code> is used and an algorithm is specified,
3515994554d167522343ce57417648b39370ccabcilix that algorithm will be checked for compatibility with NSEC3.)
3515994554d167522343ce57417648b39370ccabcilix </p>
3515994554d167522343ce57417648b39370ccabcilix<p>
3515994554d167522343ce57417648b39370ccabcilix Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
3515994554d167522343ce57417648b39370ccabcilix algorithm, and DSA is recommended.
3515994554d167522343ce57417648b39370ccabcilix </p>
3515994554d167522343ce57417648b39370ccabcilix<p>
3515994554d167522343ce57417648b39370ccabcilix Note 2: DH automatically sets the -k flag.
3515994554d167522343ce57417648b39370ccabcilix </p>
3515994554d167522343ce57417648b39370ccabcilix</dd>
3515994554d167522343ce57417648b39370ccabcilix<dt><span class="term">-3</span></dt>
<dd><p>
Use an NSEC3-capable algorithm to generate a DNSSEC key.
If this option is used and no algorithm is explicitly
set on the command line, NSEC3RSASHA1 will be used by
default.
</p></dd>
<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
<dd>
<p>
Specifies the cryptographic hardware to use.
</p>
<p>
When BIND is built with OpenSSL PKCS#11 support, this defaults
to the string "pkcs11", which identifies an OpenSSL engine
that can drive a cryptographic accelerator or hardware service
module. When BIND is built with native PKCS#11 cryptography
(--enable-native-pkcs11), it defaults to the path of the PKCS#11
provider library specified via "--with-pkcs11".
</p>
</dd>
<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
<dd>
<p>
Specifies the label for a key pair in the crypto hardware.
</p>
<p>
When <acronym class="acronym">BIND</acronym> 9 is built with OpenSSL-based
PKCS#11 support, the label is an arbitrary string that
identifies a particular key. It may be preceded by an
optional OpenSSL engine name, followed by a colon, as in
"pkcs11:<em class="replaceable"><code>keylabel</code></em>".
</p>
<p>
When <acronym class="acronym">BIND</acronym> 9 is built with native PKCS#11
support, the label is a PKCS#11 URI string in the format
"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>]"
Keywords include "token", which identifies the HSM; "object", which
identifies the key; and "pin-source", which identifies a file from
which the HSM's PIN code can be obtained. The label will be
stored in the on-disk "private" file.
</p>
<p>
If the label contains a
<code class="option">pin-source</code> field, tools using the generated
key files will be able to use the HSM for signing and other
operations without any need for an operator to manually enter
a PIN. Note: Making the HSM's PIN accessible in this manner
may reduce the security advantage of using an HSM; be sure
this is what you want to do before making use of this feature.
</p>
</dd>
<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
<dd><p>
Specifies the owner type of the key. The value of
<code class="option">nametype</code> must either be ZONE (for a DNSSEC
zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
a host (KEY)),
USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
These values are case insensitive.
</p></dd>
<dt><span class="term">-C</span></dt>
<dd><p>
Compatibility mode: generates an old-style key, without
any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
will include the key's creation date in the metadata stored
with the private key, and other dates may be set there as well
(publication date, activation date, etc). Keys that include
this data may be incompatible with older versions of BIND; the
<code class="option">-C</code> option suppresses them.
</p></dd>
<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
<dd><p>
Indicates that the DNS record containing the key should have
the specified class. If not specified, class IN is used.
</p></dd>
<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
<dd><p>
Set the specified flag in the flag field of the KEY/DNSKEY record.
The only recognized flags are KSK (Key Signing Key) and REVOKE.
</p></dd>
<dt><span class="term">-G</span></dt>
<dd><p>
Generate a key, but do not publish it or sign with it. This
option is incompatible with -P and -A.
</p></dd>
<dt><span class="term">-h</span></dt>
<dd><p>
Prints a short summary of the options and arguments to
<span><strong class="command">dnssec-keyfromlabel</strong></span>.
</p></dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
<dd><p>
Sets the directory in which the key files are to be written.
</p></dd>
<dt><span class="term">-k</span></dt>
<dd><p>
Generate KEY records rather than DNSKEY records.
</p></dd>
<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
<dd><p>
Sets the default TTL to use for this key when it is converted
into a DNSKEY RR. If the key is imported into a zone,
this is the TTL that will be used for it, unless there was
already a DNSKEY RRset in place, in which case the existing TTL
would take precedence. Setting the default TTL to
<code class="literal">0</code> or <code class="literal">none</code> removes it.
</p></dd>
<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
<dd><p>
Sets the protocol value for the key. The protocol
is a number between 0 and 255. The default is 3 (DNSSEC).
Other possible values for this argument are listed in
RFC 2535 and its successors.
</p></dd>
<dt><span class="term">-S <em class="replaceable"><code>key</code></em></span></dt>
<dd><p>
Generate a key as an explicit successor to an existing key.
The name, algorithm, size, and type of the key will be set
to match the predecessor. The activation date of the new
key will be set to the inactivation date of the existing
one. The publication date will be set to the activation
date minus the prepublication interval, which defaults to
30 days.
</p></dd>
<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
<dd><p>
Indicates the use of the key. <code class="option">type</code> must be
one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
is AUTHCONF. AUTH refers to the ability to authenticate
data, and CONF the ability to encrypt data.
</p></dd>
<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
<dd><p>
Sets the debugging level.
</p></dd>
<dt><span class="term">-V</span></dt>
<dd><p>
Prints version information.
</p></dd>
<dt><span class="term">-y</span></dt>
<dd><p>
Allows DNSSEC key files to be generated even if the key ID
would collide with that of an existing key, in the event of
either key being revoked. (This is only safe to use if you
are sure you won't be using RFC 5011 trust anchor maintenance
with either of the keys involved.)
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2672150"></a><h2>TIMING OPTIONS</h2>
<p>
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
If the argument begins with a '+' or '-', it is interpreted as
an offset from the present time. For convenience, if such an offset
is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
then the offset is computed in years (defined as 365 24-hour days,
ignoring leap years), months (defined as 30 24-hour days), weeks,
days, hours, or minutes, respectively. Without a suffix, the offset
is computed in seconds. To explicitly prevent a date from being
set, use 'none' or 'never'.
</p>
<div class="variablelist"><dl>
<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which a key is to be published to the zone.
After that date, the key will be included in the zone but will
not be used to sign it. If not set, and if the -G option has
not been used, the default is "now".
</p></dd>
<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be activated. After that
date, the key will be included in the zone and used to sign
it. If not set, and if the -G option has not been used, the
default is "now".
</p></dd>
<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be revoked. After that
date, the key will be flagged as revoked. It will be included
in the zone and will be used to sign it.
</p></dd>
<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be retired. After that
date, the key will still be included in the zone, but it
will not be used to sign it.
</p></dd>
<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
<dd><p>
Sets the date on which the key is to be deleted. After that
date, the key will no longer be included in the zone. (It
may remain in the key repository, however.)
</p></dd>
<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt>
<dd>
<p>
Sets the prepublication interval for a key. If set, then
the publication and activation dates must be separated by at least
this much time. If the activation date is specified but the
publication date isn't, then the publication date will default
to this much time before the activation date; conversely, if
the publication date is specified but activation date isn't,
then activation will be set to this much time after publication.
</p>
<p>
If the key is being created as an explicit successor to another
key, then the default prepublication interval is 30 days;
otherwise it is zero.
</p>
<p>
As with date offsets, if the argument is followed by one of
the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
interval is measured in years, months, weeks, days, hours,
or minutes, respectively. Without a suffix, the interval is
measured in seconds.
</p>
</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2672408"></a><h2>GENERATED KEY FILES</h2>
<p>
When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
successfully,
it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
to the standard output. This is an identification string for
the key files it has generated.
</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="filename">nnnn</code> is the key name.
</p></li>
<li><p><code class="filename">aaa</code> is the numeric representation
of the algorithm.
</p></li>
<li><p><code class="filename">iiiii</code> is the key identifier (or
footprint).
</p></li>
</ul></div>
<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
creates two files, with names based
on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
contains the public key, and
<code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
private key.
</p>
<p>
The <code class="filename">.key</code> file contains a DNS KEY record
that
can be inserted into a zone file (directly or with a $INCLUDE
statement).
</p>
<p>
The <code class="filename">.private</code> file contains
algorithm-specific
fields. For obvious security reasons, this file does not have
general read permission.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2672502"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>,
<em class="citetitle">RFC 4034</em>,
<em class="citetitle">The PKCS#11 URI Scheme (draft-pechanec-pkcs11uri-13)</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2672539"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.dnssec-importkey.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span class="application">dnssec-importkey</span>�</td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top">�<span class="application">dnssec-keygen</span>
</td>
</tr>
</table>
</div>
</body>
</html>