man.dnssec-keyfromlabel.html revision 2a6d4c9948b3f4f31311bd799d114585a30419a9
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac - Copyright (C) 2000-2003 Internet Software Consortium.
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac - Permission to use, copy, modify, and/or distribute this software for any
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac - purpose with or without fee is hereby granted, provided that the above
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac - copyright notice and this permission notice appear in all copies.
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac - PERFORMANCE OF THIS SOFTWARE.
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac<!-- $Id: man.dnssec-keyfromlabel.html,v 1.66 2009/10/07 01:14:42 tbox Exp $ -->
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
8d6b9f0c5f555667b93ed82bb8e86aa4faa26270JnRouvignac<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<link rel="prev" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac<a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a>�</td>
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
df8c05001b58a2b0333f9fc103610fa7692547a4nicolas.capponi@forgerock.com<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">-k</code>] [<code class="option">-K <em class="replaceable"><code>directory</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">-t <em class="replaceable"><code>type</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] {name}</p></div>
8d6b9f0c5f555667b93ed82bb8e86aa4faa26270JnRouvignac<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac gets keys with the given label from a crypto hardware and builds
6c58a977fafb8c688d2d20de67cf43875ad1127dnicolas.capponi@forgerock.com key files for DNSSEC (Secure DNS), as defined in RFC 2535
c190ea7bf13f0ab658e3eaf68d3f9318f3d9e004JnRouvignac The <code class="option">name</code> of the key is specified on the command
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac line. This must match the name of the zone for which the key is
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac being generated.
c190ea7bf13f0ab658e3eaf68d3f9318f3d9e004JnRouvignac<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac Selects the cryptographic algorithm. The value of
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac <code class="option">algorithm</code> must be one of RSAMD5 (RSA),
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA or DH (Diffie Hellman).
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac These values are case insensitive.
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac If no algorithm is specified, then RSASHA1 will be used by
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac default, unless the <code class="option">-3</code> option is specified,
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac in which case NSEC3RSASHA1 will be used instead.
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac algorithm, and DSA is recommended.
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac Note 2: DH automatically sets the -k flag.
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac Use an NSEC3-capable algorithm to generate a DNSSEC key.
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac If this option is used and no algorithm is explicitly
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac set on the command line, NSEC3RSASHA1 will be used by
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac Specifies the name of the crypto hardware (OpenSSL engine).
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac When compiled with PKCS#11 support it defaults to "pcks11".
4898390c35228d0fbc81d02272be86f427c9811bJnRouvignac<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
4898390c35228d0fbc81d02272be86f427c9811bJnRouvignac Specifies the label of the key pair in the crypto hardware.
8d6b9f0c5f555667b93ed82bb8e86aa4faa26270JnRouvignac The label may be preceded by an optional OpenSSL engine name,
4898390c35228d0fbc81d02272be86f427c9811bJnRouvignac separated by a colon, as in "pkcs11:keylabel".
9b8b643556a747fb3a2f6a721375caef88951af4JnRouvignac<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
4898390c35228d0fbc81d02272be86f427c9811bJnRouvignac Specifies the owner type of the key. The value of
4898390c35228d0fbc81d02272be86f427c9811bJnRouvignac <code class="option">nametype</code> must either be ZONE (for a DNSSEC
4898390c35228d0fbc81d02272be86f427c9811bJnRouvignac zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
8d6b9f0c5f555667b93ed82bb8e86aa4faa26270JnRouvignac a host (KEY)),
8d6b9f0c5f555667b93ed82bb8e86aa4faa26270JnRouvignac USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
8d6b9f0c5f555667b93ed82bb8e86aa4faa26270JnRouvignac These values are case insensitive.
8d6b9f0c5f555667b93ed82bb8e86aa4faa26270JnRouvignac Compatibility mode: generates an old-style key, without
8d6b9f0c5f555667b93ed82bb8e86aa4faa26270JnRouvignac any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac will include the key's creation date in the metadata stored
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac with the private key, and other dates may be set there as well
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac (publication date, activation date, etc). Keys that include
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac this data may be incompatible with older versions of BIND; the
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac <code class="option">-C</code> option suppresses them.
2410a34f9dd986cc91a17252988c3a48329e5f49JnRouvignac<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
2410a34f9dd986cc91a17252988c3a48329e5f49JnRouvignac Indicates that the DNS record containing the key should have
2410a34f9dd986cc91a17252988c3a48329e5f49JnRouvignac the specified class. If not specified, class IN is used.
2410a34f9dd986cc91a17252988c3a48329e5f49JnRouvignac<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
2410a34f9dd986cc91a17252988c3a48329e5f49JnRouvignac Set the specified flag in the flag field of the KEY/DNSKEY record.
2410a34f9dd986cc91a17252988c3a48329e5f49JnRouvignac The only recognized flags are KSK (Key Signing Key) and REVOKE.
2410a34f9dd986cc91a17252988c3a48329e5f49JnRouvignac Generate a key, but do not publish it or sign with it. This
2410a34f9dd986cc91a17252988c3a48329e5f49JnRouvignac option is incompatible with -P and -A.
475a5b1c76f5461562b728a36c0246a097a22dc9JnRouvignac Prints a short summary of the options and arguments to
2410a34f9dd986cc91a17252988c3a48329e5f49JnRouvignac <span><strong class="command">dnssec-keyfromlabel</strong></span>.
53e35ce54ead02709dff9de1879b1f415fe033eaJnRouvignac<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
53e35ce54ead02709dff9de1879b1f415fe033eaJnRouvignac Sets the directory in which the key files are to be written.
2410a34f9dd986cc91a17252988c3a48329e5f49JnRouvignac Generate KEY records rather than DNSKEY records.
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac Sets the protocol value for the key. The protocol
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac is a number between 0 and 255. The default is 3 (DNSSEC).
bf05a42e7411a065f90e023239d5420b077a730fJnRouvignac Other possible values for this argument are listed in
bf05a42e7411a065f90e023239d5420b077a730fJnRouvignac RFC 2535 and its successors.
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac Indicates the use of the key. <code class="option">type</code> must be
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac is AUTHCONF. AUTH refers to the ability to authenticate
bf05a42e7411a065f90e023239d5420b077a730fJnRouvignac data, and CONF the ability to encrypt data.
bf05a42e7411a065f90e023239d5420b077a730fJnRouvignac<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac Sets the debugging level.
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac If the argument begins with a '+' or '-', it is interpreted as
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac an offset from the present time. For convenience, if such an offset
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac then the offset is computed in years (defined as 365 24-hour days,
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac ignoring leap years), months (defined as 30 24-hour days), weeks,
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac days, hours, or minutes, respectively. Without a suffix, the offset
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac is computed in seconds.
c190ea7bf13f0ab658e3eaf68d3f9318f3d9e004JnRouvignac<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac Sets the date on which a key is to be published to the zone.
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac After that date, the key will be included in the zone but will
c659b84a8d9bee6e6a8c56bf2a090513d2d75f2eJnRouvignac not be used to sign it. If not set, and if the -G option has
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac not been used, the default is "now".
a5442e823365a75298efccb1f4e10737f2967142JnRouvignac<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
839b0b63233f53bc898a87608c08f51df3ee60dbJnRouvignac Sets the date on which the key is to be activated. After that
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac date, the key will be included and the zone and used to sign
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac it. If not set, and if the -G option has not been used, the
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac default is "now".
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac Sets the date on which the key is to be revoked. After that
a5442e823365a75298efccb1f4e10737f2967142JnRouvignac date, the key will be flagged as revoked. It will be included
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac in the zone and will be used to sign it.
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac<dt><span class="term">-U <em class="replaceable"><code>date/offset</code></em></span></dt>
475a5b1c76f5461562b728a36c0246a097a22dc9JnRouvignac Sets the date on which the key is to be retired. After that
839b0b63233f53bc898a87608c08f51df3ee60dbJnRouvignac date, the key will still be included in the zone, but it
475a5b1c76f5461562b728a36c0246a097a22dc9JnRouvignac will not be used to sign it.
839b0b63233f53bc898a87608c08f51df3ee60dbJnRouvignac<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
839b0b63233f53bc898a87608c08f51df3ee60dbJnRouvignac Sets the date on which the key is to be deleted. After that
9b8b643556a747fb3a2f6a721375caef88951af4JnRouvignac date, the key will no longer be included in the zone. (It
475a5b1c76f5461562b728a36c0246a097a22dc9JnRouvignac may remain in the key repository, however.)
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac<a name="id2609237"></a><h2>GENERATED KEY FILES</h2>
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac successfully,
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac to the standard output. This is an identification string for
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac the key files it has generated.
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac<li><p><code class="filename">nnnn</code> is the key name.
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac<li><p><code class="filename">aaa</code> is the numeric representation
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac of the algorithm.
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac<li><p><code class="filename">iiiii</code> is the key identifier (or
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac creates two files, with names based
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac contains the public key, and
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
f822a77d55916f2b26e8fe22035510b0a89ca281JnRouvignac private key.
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac The <code class="filename">.key</code> file contains a DNS KEY record
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac can be inserted into a zone file (directly or with a $INCLUDE
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac The <code class="filename">.private</code> file contains
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac algorithm-specific
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac fields. For obvious security reasons, this file does not have
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac general read permission.
18d70922e52e438970c1e3315bed0af8ed8eea1cJnRouvignac<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
bc84853de441471ad2a24a04ea5f17366da6cc6dJnRouvignac<p><span class="corpauthor">Internet Systems Consortium</span>
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac<a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a>�</td>
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac<span class="application">dnssec-dsfromkey</span>�</td>
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
ac4cab695882ae50025bfc8c70e38146ff87e268JnRouvignac<td width="40%" align="right" valign="top">�<span class="application">dnssec-keygen</span>