man.dnssec-keyfromlabel.html revision c11135d39e82f0cd1c67869c535f4af77cd8eda6
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - Copyright (C) 2004-2013 Internet Systems Consortium, Inc. ("ISC")
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - Copyright (C) 2000-2003 Internet Software Consortium.
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - Permission to use, copy, modify, and/or distribute this software for any
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - purpose with or without fee is hereby granted, provided that the above
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - copyright notice and this permission notice appear in all copies.
e64031e20c39650a7bc902a3e1aba613b9415deevboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - PERFORMANCE OF THIS SOFTWARE.
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<!-- $Id$ -->
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
ecbaea9ad65eebbee668d1023015855b750e6505vboxsync<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync<link rel="prev" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync<link rel="next" href="man.dnssec-keygen.html" title="dnssec-keygen">
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<tr><th colspan="3" align="center"><span class="application">dnssec-keyfromlabel</span></th></tr>
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<a accesskey="p" href="man.dnssec-dsfromkey.html">Prev</a>�</td>
7d0e86eb12c7c54294ac4dc772ab8b871b228195vboxsync<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-keygen.html">Next</a>
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<a name="man.dnssec-keyfromlabel"></a><div class="titlepage"></div>
d9992886d98f1ab92fe43b15a58f75a374cb3f1evboxsync<p><span class="application">dnssec-keyfromlabel</span> — DNSSEC key generation tool</p>
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<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>
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<p><span><strong class="command">dnssec-keyfromlabel</strong></span>
4ae63d882a8b26f59972d1ff15c64de2cf8bd419vboxsync gets keys with the given label from a crypto hardware and builds
4ae63d882a8b26f59972d1ff15c64de2cf8bd419vboxsync key files for DNSSEC (Secure DNS), as defined in RFC 2535
4ae63d882a8b26f59972d1ff15c64de2cf8bd419vboxsync and RFC 4034.
5c0a93a5d23fb128f357893b6d8c60f9ab62038fvboxsync The <code class="option">name</code> of the key is specified on the command
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync line. This must match the name of the zone for which the key is
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync being generated.
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync Selects the cryptographic algorithm. The value of
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync <code class="option">algorithm</code> must be one of RSAMD5, RSASHA1,
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync ECDSAP256SHA256 or ECDSAP384SHA384.
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync These values are case insensitive.
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync If no algorithm is specified, then RSASHA1 will be used by
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync default, unless the <code class="option">-3</code> option is specified,
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync in which case NSEC3RSASHA1 will be used instead. (If
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync <code class="option">-3</code> is used and an algorithm is specified,
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync that algorithm will be checked for compatibility with NSEC3.)
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync algorithm, and DSA is recommended.
d41601138ae19f7b0060d732dbaec22ddf098fd3vboxsync Note 2: DH automatically sets the -k flag.
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync Use an NSEC3-capable algorithm to generate a DNSSEC key.
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync If this option is used and no algorithm is explicitly
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync set on the command line, NSEC3RSASHA1 will be used by
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt>
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync Specifies the name of the crypto hardware (OpenSSL engine).
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync When compiled with PKCS#11 support it defaults to "pkcs11".
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<dt><span class="term">-l <em class="replaceable"><code>label</code></em></span></dt>
825db58c151df44ce202858bdb1ddf3335f8f594vboxsync Specifies the label of the key pair in the crypto hardware.
84441951a5b61de7771f68e9879850c2ededd446vboxsync The label may be preceded by an optional OpenSSL engine name,
825db58c151df44ce202858bdb1ddf3335f8f594vboxsync separated by a colon, as in "pkcs11:keylabel".
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync<dt><span class="term">-n <em class="replaceable"><code>nametype</code></em></span></dt>
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync Specifies the owner type of the key. The value of
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync <code class="option">nametype</code> must either be ZONE (for a DNSSEC
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync a host (KEY)),
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync These values are case insensitive.
ab1d5e37b7348dabe3fa0e3746db9935036a0ba0vboxsync Compatibility mode: generates an old-style key, without
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync any metadata. By default, <span><strong class="command">dnssec-keyfromlabel</strong></span>
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync will include the key's creation date in the metadata stored
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync with the private key, and other dates may be set there as well
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync (publication date, activation date, etc). Keys that include
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync this data may be incompatible with older versions of BIND; the
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync <code class="option">-C</code> option suppresses them.
b60b7a09ef453f080de66c9536c27d33b7f3db29vboxsync<dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
d032d95c3ed2b2118df5f39597bc890f416013bevboxsync Indicates that the DNS record containing the key should have
d41601138ae19f7b0060d732dbaec22ddf098fd3vboxsync the specified class. If not specified, class IN is used.
1c79e7873ca8bcb13a2ca77de7b1878ee153e11bvboxsync<dt><span class="term">-f <em class="replaceable"><code>flag</code></em></span></dt>
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Set the specified flag in the flag field of the KEY/DNSKEY record.
83bc7e18d2f888bdf38f0f59ab098db913377ab6vboxsync The only recognized flags are KSK (Key Signing Key) and REVOKE.
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync Generate a key, but do not publish it or sign with it. This
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync option is incompatible with -P and -A.
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync Prints a short summary of the options and arguments to
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync <span><strong class="command">dnssec-keyfromlabel</strong></span>.
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Sets the directory in which the key files are to be written.
51a716fe483262ec1d9eecc7d2df1253abf27df0vboxsync Generate KEY records rather than DNSKEY records.
51a716fe483262ec1d9eecc7d2df1253abf27df0vboxsync<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Sets the default TTL to use for this key when it is converted
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync into a DNSKEY RR. If the key is imported into a zone,
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync this is the TTL that will be used for it, unless there was
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync already a DNSKEY RRset in place, in which case the existing TTL
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync would take precedence. Setting the default TTL to
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync <code class="literal">0</code> or <code class="literal">none</code> removes it.
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync<dt><span class="term">-p <em class="replaceable"><code>protocol</code></em></span></dt>
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Sets the protocol value for the key. The protocol
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync is a number between 0 and 255. The default is 3 (DNSSEC).
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Other possible values for this argument are listed in
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync RFC 2535 and its successors.
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync<dt><span class="term">-t <em class="replaceable"><code>type</code></em></span></dt>
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Indicates the use of the key. <code class="option">type</code> must be
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync is AUTHCONF. AUTH refers to the ability to authenticate
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync data, and CONF the ability to encrypt data.
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Sets the debugging level.
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Allows DNSSEC key files to be generated even if the key ID
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync would collide with that of an existing key, in the event of
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync either key being revoked. (This is only safe to use if you
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync are sure you won't be using RFC 5011 trust anchor maintenance
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync with either of the keys involved.)
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
2e1486246f81c66189020361c3bdc93ec90ebdd2vboxsync If the argument begins with a '+' or '-', it is interpreted as
2e1486246f81c66189020361c3bdc93ec90ebdd2vboxsync an offset from the present time. For convenience, if such an offset
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync then the offset is computed in years (defined as 365 24-hour days,
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync ignoring leap years), months (defined as 30 24-hour days), weeks,
d41601138ae19f7b0060d732dbaec22ddf098fd3vboxsync days, hours, or minutes, respectively. Without a suffix, the offset
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync is computed in seconds.
7d0e86eb12c7c54294ac4dc772ab8b871b228195vboxsync<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Sets the date on which a key is to be published to the zone.
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync After that date, the key will be included in the zone but will
f084064b60f110b8d5d184c8dd41e5a157f0d4fevboxsync not be used to sign it. If not set, and if the -G option has
f084064b60f110b8d5d184c8dd41e5a157f0d4fevboxsync not been used, the default is "now".
f084064b60f110b8d5d184c8dd41e5a157f0d4fevboxsync<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt>
f084064b60f110b8d5d184c8dd41e5a157f0d4fevboxsync Sets the date on which the key is to be activated. After that
de8b06c5b3504cbc59cb0585b881d315e724ef4evboxsync date, the key will be included in the zone and used to sign
f084064b60f110b8d5d184c8dd41e5a157f0d4fevboxsync it. If not set, and if the -G option has not been used, the
f084064b60f110b8d5d184c8dd41e5a157f0d4fevboxsync default is "now".
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt>
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Sets the date on which the key is to be revoked. After that
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync date, the key will be flagged as revoked. It will be included
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync in the zone and will be used to sign it.
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt>
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync Sets the date on which the key is to be retired. After that
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync date, the key will still be included in the zone, but it
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync will not be used to sign it.
453ae3ee24693b7cc05e53375f90331a8d2fad40vboxsync<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>