man.dnssec-keyfromlabel.html revision 0a7ed88633a680bb881868b75ded4d09a7bbbc50
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<!--
7d32c065c7bb56f281651ae3dd2888f32ce4f1d9Bob Halley - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence - Copyright (C) 2000-2003 Internet Software Consortium.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence -
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence - Permission to use, copy, modify, and/or distribute this software for any
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence - purpose with or without fee is hereby granted, provided that the above
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence - copyright notice and this permission notice appear in all copies.
15a44745412679c30a6d022733925af70a38b715David Lawrence -
15a44745412679c30a6d022733925af70a38b715David Lawrence - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
15a44745412679c30a6d022733925af70a38b715David Lawrence - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
15a44745412679c30a6d022733925af70a38b715David Lawrence - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
15a44745412679c30a6d022733925af70a38b715David Lawrence - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15a44745412679c30a6d022733925af70a38b715David Lawrence - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
15a44745412679c30a6d022733925af70a38b715David Lawrence - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15a44745412679c30a6d022733925af70a38b715David Lawrence - PERFORMANCE OF THIS SOFTWARE.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence-->
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<!-- $Id: man.dnssec-keyfromlabel.html,v 1.57 2009/07/19 04:27:55 tbox Exp $ -->
911ed0d3bee586b3bec42cb6c376d5cc6c0e1e24Brian Wellington<html>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<head>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<title>dnssec-keyfromlabel</title>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
b09983678f5d116d3c8387aaeab4f2dc4deb0454David Lawrence<link rel="prev" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence</head>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<div class="navheader">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<table width="100%" summary="Navigation header">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
5fe5a0c02634eaadfcbc3528bf2c184557110a3bAndreas Gustafsson<tr>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<td width="20%" align="left">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a>�</td>
249aa1914b5462a77f24c4a8dc9a1b9f0ff8ee5fJames Brister<th width="60%" align="center">Manual pages</th>
230bc05e7e4a6ba7fa4ee396048ab669552dcbe2Andreas Gustafsson<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
2c2cda0045ec97d0db445ed777411930f27c0dd0Bob Halley</td>
81ae5e1ae678320e46342d4bbb71bfb81227a248Andreas Gustafsson</tr>
81ae5e1ae678320e46342d4bbb71bfb81227a248Andreas Gustafsson</table>
20c266cbc999c724e03e6edd437fb4181b92f095Michael Graff<hr>
230bc05e7e4a6ba7fa4ee396048ab669552dcbe2Andreas Gustafsson</div>
5fe5a0c02634eaadfcbc3528bf2c184557110a3bAndreas Gustafsson<div class="refentry" lang="en">
5fe5a0c02634eaadfcbc3528bf2c184557110a3bAndreas Gustafsson<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
5fe5a0c02634eaadfcbc3528bf2c184557110a3bAndreas Gustafsson<div class="refnamediv">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<h2>Name</h2>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<p><span class="application">dnssec-keyfromlabel</span> &#8212; DNSSEC key generation tool</p>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence</div>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<div class="refsynopsisdiv">
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<h2>Synopsis</h2>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<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">-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>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>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence</div>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<div class="refsect1" lang="en">
249aa1914b5462a77f24c4a8dc9a1b9f0ff8ee5fJames Brister<a name="id2605851"></a><h2>DESCRIPTION</h2>
2c2cda0045ec97d0db445ed777411930f27c0dd0Bob Halley<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
70f6053bd1c18f0a0ebe5b52c8ddbf464e92a1c5Mark Andrews gets keys with the given label from a crypto hardware and builds
61ba96e2f90930c7dfde73e05ac6d2c5a611afa7Andreas Gustafsson key files for DNSSEC (Secure DNS), as defined in RFC 2535
cfec676d095c14a8f79bb84939d74f22272309c6Michael Graff and RFC 4034.
81ae5e1ae678320e46342d4bbb71bfb81227a248Andreas Gustafsson </p>
81ae5e1ae678320e46342d4bbb71bfb81227a248Andreas Gustafsson</div>
6017f424ee3c02d7f22132c77576ea38542fa949Andreas Gustafsson<div class="refsect1" lang="en">
230bc05e7e4a6ba7fa4ee396048ab669552dcbe2Andreas Gustafsson<a name="id2605865"></a><h2>OPTIONS</h2>
20c266cbc999c724e03e6edd437fb4181b92f095Michael Graff<div class="variablelist"><dl>
8b61d2012063306528286680bd9f086fa868d86eMark Andrews<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
84fcfe530b60140f3f95f1d3894358d8c8ba4391Andreas Gustafsson<dd>
d4edcfe5eb6862ff4d5922e974e509d1f6cdf76fBrian Wellington<p>
d4edcfe5eb6862ff4d5922e974e509d1f6cdf76fBrian Wellington Selects the cryptographic algorithm. The value of
eac8e1d5fcccaa2af0041861f2d1edbaea234329Andreas Gustafsson <code class="option">algorithm</code> must be one of RSAMD5 (RSA)
911ed0d3bee586b3bec42cb6c376d5cc6c0e1e24Brian Wellington or RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA or DH (Diffie Hellman).
20c266cbc999c724e03e6edd437fb4181b92f095Michael Graff These values are case insensitive.
b09983678f5d116d3c8387aaeab4f2dc4deb0454David Lawrence </p>
b09983678f5d116d3c8387aaeab4f2dc4deb0454David Lawrence<p>
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrence Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence algorithm, and DSA is recommended.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence </p>
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff<p>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence Note 2: DH automatically sets the -k flag.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence </p>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence</dd>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<dd><p>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence Specifies the label of keys in the crypto hardware
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence (PKCS#11 device).
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence </p></dd>
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrence<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
edcd1247ad7e81bb8b430e610d9718f64c70f05dDavid Lawrence<dd><p>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence Specifies the owner type of the key. The value of
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence <code class="option">nametype</code> must either be ZONE (for a DNSSEC
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff a host (KEY)),
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff These values are
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff case insensitive.
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff </p></dd>
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff<dd><p>
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff Indicates that the DNS record containing the key should have
c90f5e8d1edbd5c277f2ee320167a12a30ba7c7bMichael Graff the specified class. If not specified, class IN is used.
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence </p></dd>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
fc80027fb54b501cdd88461bf879d078259e0226David Lawrence<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 <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 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="id2606215"></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="id2606445"></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="id2606485"></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>