dnssec-keyfromlabel.html revision f8e3e03cacd16ffb923a9603fca23a9e1a1fee07
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<!--
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson - Copyright (C) 2008, 2009 Internet Systems Consortium, Inc. ("ISC")
70e5a7403f0e0a3bd292b8287c5fed5772c15270Automatic Updater -
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson - Permission to use, copy, modify, and/or distribute this software for any
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson - purpose with or without fee is hereby granted, provided that the above
ec5347e2c775f027573ce5648b910361aa926c01Automatic Updater - copyright notice and this permission notice appear in all copies.
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson -
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews-->
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews<!-- $Id: dnssec-keyfromlabel.html,v 1.10 2009/09/15 01:14:41 tbox Exp $ -->
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<html>
fad5116b3d68e825d29f87a1d3cb41409f42e8f5Scott Mann<head>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fad5116b3d68e825d29f87a1d3cb41409f42e8f5Scott Mann<title>dnssec-keyfromlabel</title>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson</head>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<div class="refnamediv">
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<h2>Name</h2>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<p><span class="application">dnssec-keyfromlabel</span> &#8212; DNSSEC key generation tool</p>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson</div>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<div class="refsynopsisdiv">
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<h2>Synopsis</h2>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<div class="cmdsynopsis"><p><code class="command">dnssec-keyfromlabel</code> {-a <em class="replaceable"><code>algorithm</code></em>} {-l <em class="replaceable"><code>label</code></em>} [<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">-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>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson</div>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<div class="refsect1" lang="en">
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<a name="id2543472"></a><h2>DESCRIPTION</h2>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson gets keys with the given label from a crypto hardware and builds
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson key files for DNSSEC (Secure DNS), as defined in RFC 2535
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson and RFC 4034.
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson </p>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson<p>
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson The <code class="option">name</code> of the key is specified on the command
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson line. This must match the name of the zone for which the key is
89485c1d7119644d2a11466ef22bb894dec0905fAndreas Gustafsson being generated.
fad5116b3d68e825d29f87a1d3cb41409f42e8f5Scott Mann </p>
fad5116b3d68e825d29f87a1d3cb41409f42e8f5Scott Mann</div>
fad5116b3d68e825d29f87a1d3cb41409f42e8f5Scott Mann<div class="refsect1" lang="en">
fad5116b3d68e825d29f87a1d3cb41409f42e8f5Scott Mann<a name="id2543490"></a><h2>OPTIONS</h2>
<div class="variablelist"><dl>
<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
<dd>
<p>
Selects the cryptographic algorithm. The value of
<code class="option">algorithm</code> must be one of RSAMD5 (RSA),
RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA or DH (Diffie Hellman).
These values are case insensitive.
</p>
<p>
Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
algorithm, and DSA is recommended.
</p>
<p>
Note 2: DH automatically sets the -k flag.
</p>
</dd>
<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
<dd><p>
Specifies the label of keys in the crypto hardware
(PKCS#11 device).
</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">-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">-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>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2543734"></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.
</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 and 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">-U <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>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2543969"></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="id2544041"></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 2539</em>,
<em class="citetitle">RFC 2845</em>,
<em class="citetitle">RFC 4033</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2544081"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div></body>
</html>