dnssec-keyfromlabel.html revision aaaf8d4f4873d21e55c3ffb4f656203d08339865
178f6ad061e54bc5babfca3577f72058fa0797c1Bob Halley - Copyright (C) 2008-2011 Internet Systems Consortium, Inc. ("ISC")
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - Permission to use, copy, modify, and/or distribute this software for any
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence - purpose with or without fee is hereby granted, provided that the above
ec5347e2c775f027573ce5648b910361aa926c01Automatic Updater - copyright notice and this permission notice appear in all copies.
178f6ad061e54bc5babfca3577f72058fa0797c1Bob Halley - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews<!-- $Id$ -->
9c3531d72aeaad6c5f01efe6a1c82023e1379e4dDavid Lawrence<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<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>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence gets keys with the given label from a crypto hardware and builds
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence key files for DNSSEC (Secure DNS), as defined in RFC 2535
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley and RFC 4034.
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence The <code class="option">name</code> of the key is specified on the command
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence line. This must match the name of the zone for which the key is
fcb54ce0a4f7377486df5bec83b3aa4711bf4131Mark Andrews being generated.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence Selects the cryptographic algorithm. The value of
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews ECDSAP256SHA256 or ECDSAP384SHA384.
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews These values are case insensitive.
2d46d268ccff30bb50e661b47c6496d23d9156c7Mark Andrews If no algorithm is specified, then RSASHA1 will be used by
2d46d268ccff30bb50e661b47c6496d23d9156c7Mark Andrews default, unless the <code class="option">-3</code> option is specified,
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews in which case NSEC3RSASHA1 will be used instead. (If
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <code class="option">-3</code> is used and an algorithm is specified,
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence that algorithm will be checked for compatibility with NSEC3.)
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence algorithm, and DSA is recommended.
8319af16557b81eba3277ee67215285f0823b587Mark Andrews Note 2: DH automatically sets the -k flag.
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence Use an NSEC3-capable algorithm to generate a DNSSEC key.
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence If this option is used and no algorithm is explicitly
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence set on the command line, NSEC3RSASHA1 will be used by
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence Specifies the name of the crypto hardware (OpenSSL engine).
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence When compiled with PKCS#11 support it defaults to "pkcs11".
b616f6ed69209ab4c87f610b472aeb20760652f2Mark Andrews<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
2320f230995995595438a9d9301d84931fd266ceMark Andrews Specifies the label of the key pair in the crypto hardware.
c427260a8678f2e99a2337fb95ec98d9c9ee8c05Mark Andrews The label may be preceded by an optional OpenSSL engine name,
620a452ebe92fff63e85c5930a6e6dc8d9455918Mark Andrews separated by a colon, as in "pkcs11:keylabel".
6dcb47e37f9f0cdb94bdabc3fa157ff07983c590Mark Andrews<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
43b3337ba58d70ca34f4d91e8c6c5e13a54af690Mark Andrews Specifies the owner type of the key. The value of
43b3337ba58d70ca34f4d91e8c6c5e13a54af690Mark Andrews <code class="option">nametype</code> must either be ZONE (for a DNSSEC
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley a host (KEY)),
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley These values are case insensitive.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Compatibility mode: generates an old-style key, without
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley will include the key's creation date in the metadata stored
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley with the private key, and other dates may be set there as well
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley (publication date, activation date, etc). Keys that include
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley this data may be incompatible with older versions of BIND; the
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <code class="option">-C</code> option suppresses them.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Indicates that the DNS record containing the key should have
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley the specified class. If not specified, class IN is used.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence Set the specified flag in the flag field of the KEY/DNSKEY record.
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence The only recognized flags are KSK (Key Signing Key) and REVOKE.
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence Generate a key, but do not publish it or sign with it. This
a9558a6c63d9c6dbb2f3800b39ccb008652fcde3Mark Andrews option is incompatible with -P and -A.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Prints a short summary of the options and arguments to
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence <span><strong class="command">dnssec-keyfromlabel</strong></span>.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Sets the directory in which the key files are to be written.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Generate KEY records rather than DNSKEY records.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Sets the default TTL to use for this key when it is converted
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley into a DNSKEY RR. If the key is imported into a zone,
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley this is the TTL that will be used for it, unless there was
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley already a DNSKEY RRset in place, in which case the existing TTL
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley would take precedence. Setting the default TTL to
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <code class="literal">0</code> or <code class="literal">none</code> removes it.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Sets the protocol value for the key. The protocol
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley is a number between 0 and 255. The default is 3 (DNSSEC).
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Other possible values for this argument are listed in
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley RFC 2535 and its successors.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Indicates the use of the key. <code class="option">type</code> must be
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley is AUTHCONF. AUTH refers to the ability to authenticate
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley data, and CONF the ability to encrypt data.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Sets the debugging level.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Allows DNSSEC key files to be generated even if the key ID
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley would collide with that of an existing key, in the event of
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley either key being revoked. (This is only safe to use if you
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley are sure you won't be using RFC 5011 trust anchor maintenance