diff options
Diffstat (limited to 'contrib/bind9/bin/dnssec/dnssec-keyfromlabel.html')
| -rw-r--r-- | contrib/bind9/bin/dnssec/dnssec-keyfromlabel.html | 275 |
1 files changed, 0 insertions, 275 deletions
diff --git a/contrib/bind9/bin/dnssec/dnssec-keyfromlabel.html b/contrib/bind9/bin/dnssec/dnssec-keyfromlabel.html deleted file mode 100644 index f0e2c5c..0000000 --- a/contrib/bind9/bin/dnssec/dnssec-keyfromlabel.html +++ /dev/null @@ -1,275 +0,0 @@ -<!-- - - Copyright (C) 2008-2012 Internet Systems Consortium, Inc. ("ISC") - - - - Permission to use, copy, modify, and/or distribute this software for any - - purpose with or without fee is hereby granted, provided that the above - - copyright notice and this permission notice appear in all copies. - - - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - - PERFORMANCE OF THIS SOFTWARE. ---> -<!-- $Id$ --> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> -<title>dnssec-keyfromlabel</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> -<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2>Name</h2> -<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p> -</div> -<div class="refsynopsisdiv"> -<h2>Synopsis</h2> -<div class="cmdsynopsis"><p><code class="command">dnssec-keyfromlabel</code> {-l <em class="replaceable"><code>label</code></em>} [<code class="option">-3</code>] [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<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">-E <em class="replaceable"><code>engine</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">-L <em class="replaceable"><code>ttl</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>] [<code class="option">-y</code>] {name}</p></div> -</div> -<div class="refsect1" lang="en"> -<a name="id2543507"></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> -<p> - The <code class="option">name</code> of the key is specified on the command - line. This must match the name of the zone for which the key is - being generated. - </p> -</div> -<div class="refsect1" lang="en"> -<a name="id2543525"></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, RSASHA1, - DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, - ECDSAP256SHA256 or ECDSAP384SHA384. - These values are case insensitive. - </p> -<p> - If no algorithm is specified, then RSASHA1 will be used by - default, unless the <code class="option">-3</code> option is specified, - in which case NSEC3RSASHA1 will be used instead. (If - <code class="option">-3</code> is used and an algorithm is specified, - that algorithm will be checked for compatibility with NSEC3.) - </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">-3</span></dt> -<dd><p> - Use an NSEC3-capable algorithm to generate a DNSSEC key. - If this option is used and no algorithm is explicitly - set on the command line, NSEC3RSASHA1 will be used by - default. - </p></dd> -<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt> -<dd><p> - Specifies the name of the crypto hardware (OpenSSL engine). - When compiled with PKCS#11 support it defaults to "pkcs11". - </p></dd> -<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt> -<dd><p> - Specifies the label of the key pair in the crypto hardware. - The label may be preceded by an optional OpenSSL engine name, - separated by a colon, as in "pkcs11:keylabel". - </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">-L <em class="replaceable"><code>ttl</code></em></span></dt> -<dd><p> - Sets the default TTL to use for this key when it is converted - into a DNSKEY RR. If the key is imported into a zone, - this is the TTL that will be used for it, unless there was - already a DNSKEY RRset in place, in which case the existing TTL - would take precedence. Setting the default TTL to - <code class="literal">0</code> or <code class="literal">none</code> removes it. - </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> -<dt><span class="term">-y</span></dt> -<dd><p> - Allows DNSSEC key files to be generated even if the key ID - would collide with that of an existing key, in the event of - either key being revoked. (This is only safe to use if you - are sure you won't be using RFC 5011 trust anchor maintenance - with either of the keys involved.) - </p></dd> -</dl></div> -</div> -<div class="refsect1" lang="en"> -<a name="id2543980"></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 in 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">-I <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="id2543054"></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="id2543127"></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 4034</em>. - </p> -</div> -<div class="refsect1" lang="en"> -<a name="id2543160"></a><h2>AUTHOR</h2> -<p><span class="corpauthor">Internet Systems Consortium</span> - </p> -</div> -</div></body> -</html> |
