man.dnssec-keyfromlabel.html revision 80383d03604b92a452564592e84c2bf831077a41
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<!--
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - Copyright (C) 2000-2003 Internet Software Consortium.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync -
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - Permission to use, copy, modify, and distribute this software for any
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - purpose with or without fee is hereby granted, provided that the above
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - copyright notice and this permission notice appear in all copies.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync -
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - PERFORMANCE OF THIS SOFTWARE.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync-->
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<!-- $Id: man.dnssec-keyfromlabel.html,v 1.53 2009/06/18 01:13:02 tbox Exp $ -->
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<html>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<head>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<title>dnssec-keyfromlabel</title>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<link rel="prev" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync</head>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<div class="navheader">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<table width="100%" summary="Navigation header">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<tr>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<td width="20%" align="left">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a>�</td>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<th width="60%" align="center">Manual pages</th>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync</td>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync</tr>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync</table>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<hr>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync</div>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<div class="refentry" lang="en">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<div class="refnamediv">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<h2>Name</h2>
<p><span class="application">dnssec-keyfromlabel</span> &#8212; DNSSEC key generation tool</p>
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<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">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-f <em class="replaceable"><code>flag</code></em></code>] [<code class="option">-k</code>] [<code class="option">-n <em class="replaceable"><code>nametype</code></em></code>] [<code class="option">-p <em class="replaceable"><code>protocol</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>
</div>
<div class="refsect1" lang="en">
<a name="id2605395"></a><h2>DESCRIPTION</h2>
<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
gets keys with the given label from a crypto hardware and builds
key files for DNSSEC (Secure DNS), as defined in RFC 2535
and RFC 4034.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2605409"></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)
or 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 <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 flag is KSK (Key Signing Key) DNSKEY.
</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-keygen</strong></span>.
</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 generated 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="id2605741"></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="id2605835"></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="id2606353"></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-dsfromkey.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-dsfromkey</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>