man.dnssec-keyfromlabel.html revision cd3ee12f1d34107678bde7be68b1d7f0f45cf2c9
823N/A<!--
823N/A - Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
823N/A - Copyright (C) 2000-2003 Internet Software Consortium.
823N/A -
823N/A - Permission to use, copy, modify, and distribute this software for any
823N/A - purpose with or without fee is hereby granted, provided that the above
823N/A - copyright notice and this permission notice appear in all copies.
823N/A -
6983N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
6983N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
823N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
823N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
823N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
823N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
6983N/A - PERFORMANCE OF THIS SOFTWARE.
6983N/A-->
6983N/A<!-- $Id: man.dnssec-keyfromlabel.html,v 1.25 2008/10/18 01:11:39 tbox Exp $ -->
6983N/A<html>
823N/A<head>
823N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
823N/A<title>dnssec-keyfromlabel</title>
823N/A<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
823N/A<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
5034N/A<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
6489N/A<link rel="prev" href="man.host.html" title="host">
823N/A<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
823N/A</head>
823N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
2086N/A<div class="navheader">
897N/A<table width="100%" summary="Navigation header">
6489N/A<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
6489N/A<tr>
6489N/A<td width="20%" align="left">
6489N/A<a accesskey="p" href="man.host.html">Prev</a>�</td>
6489N/A<th width="60%" align="center">Manual pages</th>
823N/A<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
823N/A</td>
823N/A</tr>
823N/A</table>
823N/A<hr>
823N/A</div>
823N/A<div class="refentry" lang="en">
823N/A<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
823N/A<div class="refnamediv">
1928N/A<h2>Name</h2>
1928N/A<p><span class="application">dnssec-keyfromlabel</span> &#8212; DNSSEC key generation tool</p>
823N/A</div>
823N/A<div class="refsynopsisdiv">
897N/A<h2>Synopsis</h2>
6489N/A<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>
823N/A</div>
823N/A<div class="refsect1" lang="en">
823N/A<a name="id2602753"></a><h2>DESCRIPTION</h2>
897N/A<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
6489N/A gets keys with the given label from a crypto hardware and builds
823N/A key files for DNSSEC (Secure DNS), as defined in RFC 2535
823N/A and RFC 4034.
823N/A </p>
897N/A</div>
6489N/A<div class="refsect1" lang="en">
823N/A<a name="id2602766"></a><h2>OPTIONS</h2>
823N/A<div class="variablelist"><dl>
823N/A<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
897N/A<dd>
6489N/A<p>
823N/A Selects the cryptographic algorithm. The value of
823N/A <code class="option">algorithm</code> must be one of RSAMD5 (RSA)
823N/A or RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA or DH (Diffie Hellman).
823N/A These values are case insensitive.
6489N/A </p>
897N/A<p>
897N/A Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
897N/A algorithm, and DSA is recommended.
897N/A </p>
1898N/A<p>
1898N/A Note 2: DH automatically sets the -k flag.
1898N/A </p>
1898N/A</dd>
1898N/A<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
1928N/A<dd><p>
1928N/A Specifies the label of keys in the crypto hardware
1928N/A (PKCS#11 device).
1928N/A </p></dd>
1928N/A<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
6489N/A<dd><p>
897N/A Specifies the owner type of the key. The value of
897N/A <code class="option">nametype</code> must either be ZONE (for a DNSSEC
823N/A zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
823N/A a host (KEY)),
897N/A USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
6489N/A These values are
897N/A case insensitive.
897N/A </p></dd>
823N/A<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
897N/A<dd><p>
6489N/A Indicates that the DNS record containing the key should have
897N/A the specified class. If not specified, class IN is used.
897N/A </p></dd>
897N/A<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
897N/A<dd><p>
6489N/A Set the specified flag in the flag field of the KEY/DNSKEY record.
897N/A The only recognized flag is KSK (Key Signing Key) DNSKEY.
897N/A </p></dd>
897N/A<dt><span class="term">-h</span></dt>
897N/A<dd><p>
6489N/A Prints a short summary of the options and arguments to
897N/A <span><strong class="command">dnssec-keygen</strong></span>.
823N/A </p></dd>
823N/A<dt><span class="term">-k</span></dt>
897N/A<dd><p>
897N/A Generate KEY records rather than DNSKEY records.
897N/A </p></dd>
897N/A<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
897N/A<dd><p>
823N/A Sets the protocol value for the generated key. The protocol
6489N/A is a number between 0 and 255. The default is 3 (DNSSEC).
6489N/A Other possible values for this argument are listed in
6489N/A RFC 2535 and its successors.
823N/A </p></dd>
823N/A<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
6489N/A<dd><p>
823N/A Indicates the use of the key. <code class="option">type</code> must be
823N/A one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
823N/A is AUTHCONF. AUTH refers to the ability to authenticate
823N/A data, and CONF the ability to encrypt data.
823N/A </p></dd>
823N/A<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
823N/A<dd><p>
823N/A Sets the debugging level.
823N/A </p></dd>
823N/A</dl></div>
823N/A</div>
823N/A<div class="refsect1" lang="en">
823N/A<a name="id2603236"></a><h2>GENERATED KEY FILES</h2>
823N/A<p>
823N/A When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
823N/A successfully,
823N/A it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
823N/A to the standard output. This is an identification string for
823N/A the key files it has generated.
823N/A </p>
6489N/A<div class="itemizedlist"><ul type="disc">
823N/A<li><p><code class="filename">nnnn</code> is the key name.
823N/A </p></li>
823N/A<li><p><code class="filename">aaa</code> is the numeric representation
1928N/A of the
1928N/A algorithm.
1928N/A </p></li>
1928N/A<li><p><code class="filename">iiiii</code> is the key identifier (or
1928N/A footprint).
1928N/A </p></li>
1928N/A</ul></div>
1928N/A<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
1928N/A creates two files, with names based
823N/A on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
823N/A contains the public key, and
823N/A <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
897N/A private
1898N/A key.
1928N/A </p>
1928N/A<p>
823N/A The <code class="filename">.key</code> file contains a DNS KEY record
823N/A that
823N/A can be inserted into a zone file (directly or with a $INCLUDE
823N/A statement).
897N/A </p>
1898N/A<p>
1928N/A The <code class="filename">.private</code> file contains algorithm
823N/A specific
823N/A fields. For obvious security reasons, this file does not have
823N/A general read permission.
823N/A </p>
823N/A</div>
823N/A<div class="refsect1" lang="en">
823N/A<a name="id2603330"></a><h2>SEE ALSO</h2>
823N/A<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
1831N/A <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
823N/A <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
823N/A <em class="citetitle">RFC 2539</em>,
823N/A <em class="citetitle">RFC 2845</em>,
823N/A <em class="citetitle">RFC 4033</em>.
823N/A </p>
823N/A</div>
823N/A<div class="refsect1" lang="en">
823N/A<a name="id2603369"></a><h2>AUTHOR</h2>
823N/A<p><span class="corpauthor">Internet Systems Consortium</span>
823N/A </p>
823N/A</div>
823N/A</div>
823N/A<div class="navfooter">
823N/A<hr>
823N/A<table width="100%" summary="Navigation footer">
823N/A<tr>
823N/A<td width="40%" align="left">
823N/A<a accesskey="p" href="man.host.html">Prev</a>�</td>
823N/A<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
823N/A<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
823N/A</td>
823N/A</tr>
823N/A<tr>
823N/A<td width="40%" align="left" valign="top">host�</td>
823N/A<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
823N/A<td width="40%" align="right" valign="top">�<span class="application">dnssec-keygen</span>
823N/A</td>
823N/A</tr>
823N/A</table>
897N/A</div>
897N/A</body>
897N/A</html>
897N/A