2 - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC")
3 - Copyright (C) 2000-2003 Internet Software Consortium.
5 - Permission to use, copy, modify, and/or distribute this software for any
6 - purpose with or without fee is hereby granted, provided that the above
7 - copyright notice and this permission notice appear in all copies.
9 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 - PERFORMANCE OF THIS SOFTWARE.
20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
21 <title>dnssec-keyfromlabel</title>
22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
23 <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
24 <link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
25 <link rel="prev" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
26 <link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
28 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
29 <div class="navheader">
30 <table width="100%" summary="Navigation header">
31 <tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
33 <td width="20%" align="left">
34 <a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a> </td>
35 <th width="60%" align="center">Manual pages</th>
36 <td width="20%" align="right"> <a accesskey="n" href="man.dnssec-keygen.html">Next</a>
42 <div class="refentry" lang="en">
43 <a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
44 <div class="refnamediv">
46 <p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
48 <div class="refsynopsisdiv">
50 <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>] [<code class="option">-y</code>] {name}</p></div>
52 <div class="refsect1" lang="en">
53 <a name="id2612614"></a><h2>DESCRIPTION</h2>
54 <p><span><strong class="command">dnssec-keyfromlabel</strong></span>
55 gets keys with the given label from a crypto hardware and builds
56 key files for DNSSEC (Secure DNS), as defined in RFC 2535
60 The <code class="option">name</code> of the key is specified on the command
61 line. This must match the name of the zone for which the key is
65 <div class="refsect1" lang="en">
66 <a name="id2612634"></a><h2>OPTIONS</h2>
67 <div class="variablelist"><dl>
68 <dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
71 Selects the cryptographic algorithm. The value of
72 <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
73 DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
74 ECDSAP256SHA256 or ECDSAP384SHA384.
75 These values are case insensitive.
78 If no algorithm is specified, then RSASHA1 will be used by
79 default, unless the <code class="option">-3</code> option is specified,
80 in which case NSEC3RSASHA1 will be used instead. (If
81 <code class="option">-3</code> is used and an algorithm is specified,
82 that algorithm will be checked for compatibility with NSEC3.)
85 Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
86 algorithm, and DSA is recommended.
89 Note 2: DH automatically sets the -k flag.
92 <dt><span class="term">-3</span></dt>
94 Use an NSEC3-capable algorithm to generate a DNSSEC key.
95 If this option is used and no algorithm is explicitly
96 set on the command line, NSEC3RSASHA1 will be used by
99 <dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
101 Specifies the name of the crypto hardware (OpenSSL engine).
102 When compiled with PKCS#11 support it defaults to "pkcs11".
104 <dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
106 Specifies the label of the key pair in the crypto hardware.
107 The label may be preceded by an optional OpenSSL engine name,
108 separated by a colon, as in "pkcs11:keylabel".
110 <dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
112 Specifies the owner type of the key. The value of
113 <code class="option">nametype</code> must either be ZONE (for a DNSSEC
114 zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
116 USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
117 These values are case insensitive.
119 <dt><span class="term">-C</span></dt>
121 Compatibility mode: generates an old-style key, without
122 any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
123 will include the key's creation date in the metadata stored
124 with the private key, and other dates may be set there as well
125 (publication date, activation date, etc). Keys that include
126 this data may be incompatible with older versions of BIND; the
127 <code class="option">-C</code> option suppresses them.
129 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
131 Indicates that the DNS record containing the key should have
132 the specified class. If not specified, class IN is used.
134 <dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
136 Set the specified flag in the flag field of the KEY/DNSKEY record.
137 The only recognized flags are KSK (Key Signing Key) and REVOKE.
139 <dt><span class="term">-G</span></dt>
141 Generate a key, but do not publish it or sign with it. This
142 option is incompatible with -P and -A.
144 <dt><span class="term">-h</span></dt>
146 Prints a short summary of the options and arguments to
147 <span><strong class="command">dnssec-keyfromlabel</strong></span>.
149 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
151 Sets the directory in which the key files are to be written.
153 <dt><span class="term">-k</span></dt>
155 Generate KEY records rather than DNSKEY records.
157 <dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
159 Sets the protocol value for the key. The protocol
160 is a number between 0 and 255. The default is 3 (DNSSEC).
161 Other possible values for this argument are listed in
162 RFC 2535 and its successors.
164 <dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
166 Indicates the use of the key. <code class="option">type</code> must be
167 one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
168 is AUTHCONF. AUTH refers to the ability to authenticate
169 data, and CONF the ability to encrypt data.
171 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
173 Sets the debugging level.
175 <dt><span class="term">-y</span></dt>
177 Allows DNSSEC key files to be generated even if the key ID
178 would collide with that of an existing key, in the event of
179 either key being revoked. (This is only safe to use if you
180 are sure you won't be using RFC 5011 trust anchor maintenance
181 with either of the keys involved.)
185 <div class="refsect1" lang="en">
186 <a name="id2613344"></a><h2>TIMING OPTIONS</h2>
188 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
189 If the argument begins with a '+' or '-', it is interpreted as
190 an offset from the present time. For convenience, if such an offset
191 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
192 then the offset is computed in years (defined as 365 24-hour days,
193 ignoring leap years), months (defined as 30 24-hour days), weeks,
194 days, hours, or minutes, respectively. Without a suffix, the offset
195 is computed in seconds.
197 <div class="variablelist"><dl>
198 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
200 Sets the date on which a key is to be published to the zone.
201 After that date, the key will be included in the zone but will
202 not be used to sign it. If not set, and if the -G option has
203 not been used, the default is "now".
205 <dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
207 Sets the date on which the key is to be activated. After that
208 date, the key will be included in the zone and used to sign
209 it. If not set, and if the -G option has not been used, the
212 <dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
214 Sets the date on which the key is to be revoked. After that
215 date, the key will be flagged as revoked. It will be included
216 in the zone and will be used to sign it.
218 <dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
220 Sets the date on which the key is to be retired. After that
221 date, the key will still be included in the zone, but it
222 will not be used to sign it.
224 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
226 Sets the date on which the key is to be deleted. After that
227 date, the key will no longer be included in the zone. (It
228 may remain in the key repository, however.)
232 <div class="refsect1" lang="en">
233 <a name="id2615080"></a><h2>GENERATED KEY FILES</h2>
235 When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
237 it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
238 to the standard output. This is an identification string for
239 the key files it has generated.
241 <div class="itemizedlist"><ul type="disc">
242 <li><p><code class="filename">nnnn</code> is the key name.
244 <li><p><code class="filename">aaa</code> is the numeric representation
247 <li><p><code class="filename">iiiii</code> is the key identifier (or
251 <p><span><strong class="command">dnssec-keyfromlabel</strong></span>
252 creates two files, with names based
253 on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
254 contains the public key, and
255 <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
259 The <code class="filename">.key</code> file contains a DNS KEY record
261 can be inserted into a zone file (directly or with a $INCLUDE
265 The <code class="filename">.private</code> file contains
267 fields. For obvious security reasons, this file does not have
268 general read permission.
271 <div class="refsect1" lang="en">
272 <a name="id2615447"></a><h2>SEE ALSO</h2>
273 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
274 <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
275 <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
276 <em class="citetitle">RFC 4034</em>.
279 <div class="refsect1" lang="en">
280 <a name="id2615480"></a><h2>AUTHOR</h2>
281 <p><span class="corpauthor">Internet Systems Consortium</span>
285 <div class="navfooter">
287 <table width="100%" summary="Navigation footer">
289 <td width="40%" align="left">
290 <a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a> </td>
291 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
292 <td width="40%" align="right"> <a accesskey="n" href="man.dnssec-keygen.html">Next</a>
296 <td width="40%" align="left" valign="top">
297 <span class="application">dnssec-dsfromkey</span> </td>
298 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
299 <td width="40%" align="right" valign="top"> <span class="application">dnssec-keygen</span>