dnssec-keyfromlabel.html revision 731cc132f22dbc9e0ecd7035dce314a61076d31b
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - Copyright (C) 2008 Internet Systems Consortium, Inc. ("ISC")
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - Permission to use, copy, modify, and distribute this software for any
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - purpose with or without fee is hereby granted, provided that the above
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - copyright notice and this permission notice appear in all copies.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
c77a61a72b5ecdc507d6cf104142edd371a16c84yz - PERFORMANCE OF THIS SOFTWARE.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<!-- $Id: dnssec-keyfromlabel.html,v 1.4 2008/09/25 04:45:04 tbox Exp $ -->
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
489b7c4ab76ae8df137fbfcc2214f7baa52883a0Raymond Chen<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<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>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz gets keys with the given label from a crypto hardware and builds
c77a61a72b5ecdc507d6cf104142edd371a16c84yz key files for DNSSEC (Secure DNS), as defined in RFC 2535
c77a61a72b5ecdc507d6cf104142edd371a16c84yz and RFC 4034.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Selects the cryptographic algorithm. The value of
c77a61a72b5ecdc507d6cf104142edd371a16c84yz <code class="option">algorithm</code> must be one of RSAMD5 (RSA)
c77a61a72b5ecdc507d6cf104142edd371a16c84yz or RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA or DH (Diffie Hellman).
c77a61a72b5ecdc507d6cf104142edd371a16c84yz These values are case insensitive.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
c77a61a72b5ecdc507d6cf104142edd371a16c84yz algorithm, and DSA is recommended.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Note 2: DH automatically sets the -k flag.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Specifies the label of keys in the crypto hardware
c77a61a72b5ecdc507d6cf104142edd371a16c84yz (PKCS#11 device).
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Specifies the owner type of the key. The value of
c77a61a72b5ecdc507d6cf104142edd371a16c84yz <code class="option">nametype</code> must either be ZONE (for a DNSSEC
c77a61a72b5ecdc507d6cf104142edd371a16c84yz zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
c77a61a72b5ecdc507d6cf104142edd371a16c84yz a host (KEY)),
c77a61a72b5ecdc507d6cf104142edd371a16c84yz USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
c77a61a72b5ecdc507d6cf104142edd371a16c84yz These values are
c77a61a72b5ecdc507d6cf104142edd371a16c84yz case insensitive.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Indicates that the DNS record containing the key should have
c77a61a72b5ecdc507d6cf104142edd371a16c84yz the specified class. If not specified, class IN is used.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Set the specified flag in the flag field of the KEY/DNSKEY record.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz The only recognized flag is KSK (Key Signing Key) DNSKEY.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Prints a short summary of the options and arguments to
c77a61a72b5ecdc507d6cf104142edd371a16c84yz <span><strong class="command">dnssec-keygen</strong></span>.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Generate KEY records rather than DNSKEY records.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Sets the protocol value for the generated key. The protocol
c77a61a72b5ecdc507d6cf104142edd371a16c84yz is a number between 0 and 255. The default is 3 (DNSSEC).
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Other possible values for this argument are listed in
c77a61a72b5ecdc507d6cf104142edd371a16c84yz RFC 2535 and its successors.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Indicates the use of the key. <code class="option">type</code> must be
c77a61a72b5ecdc507d6cf104142edd371a16c84yz one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
c77a61a72b5ecdc507d6cf104142edd371a16c84yz is AUTHCONF. AUTH refers to the ability to authenticate
c77a61a72b5ecdc507d6cf104142edd371a16c84yz data, and CONF the ability to encrypt data.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz Sets the debugging level.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz When <span><strong class="command">dnssec-keyfromlabel</strong></span> completes
c77a61a72b5ecdc507d6cf104142edd371a16c84yz successfully,
c77a61a72b5ecdc507d6cf104142edd371a16c84yz it prints a string of the form <code class="filename">Knnnn.+aaa+iiiii</code>
bf56214c0556fa6864189c826d39dbe156bb22a0stevel to the standard output. This is an identification string for
c77a61a72b5ecdc507d6cf104142edd371a16c84yz the key files it has generated.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<li><p><code class="filename">nnnn</code> is the key name.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<li><p><code class="filename">aaa</code> is the numeric representation
c77a61a72b5ecdc507d6cf104142edd371a16c84yz algorithm.
bf56214c0556fa6864189c826d39dbe156bb22a0stevel<li><p><code class="filename">iiiii</code> is the key identifier (or
c77a61a72b5ecdc507d6cf104142edd371a16c84yz footprint).
c77a61a72b5ecdc507d6cf104142edd371a16c84yz<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz creates two files, with names based
c77a61a72b5ecdc507d6cf104142edd371a16c84yz on the printed string. <code class="filename">Knnnn.+aaa+iiiii.key</code>
c77a61a72b5ecdc507d6cf104142edd371a16c84yz contains the public key, and
c77a61a72b5ecdc507d6cf104142edd371a16c84yz <code class="filename">Knnnn.+aaa+iiiii.private</code> contains the
c77a61a72b5ecdc507d6cf104142edd371a16c84yz The <code class="filename">.key</code> file contains a DNS KEY record
c77a61a72b5ecdc507d6cf104142edd371a16c84yz can be inserted into a zone file (directly or with a $INCLUDE
c77a61a72b5ecdc507d6cf104142edd371a16c84yz statement).
c77a61a72b5ecdc507d6cf104142edd371a16c84yz The <code class="filename">.private</code> file contains algorithm