3909N/A - Copyright (C) 2008-2012, 2014 Internet Systems Consortium, Inc. ("ISC") 0N/A - Permission to use, copy, modify, and/or distribute this software for any 0N/A - purpose with or without fee is hereby granted, provided that the above 0N/A - copyright notice and this permission notice appear in all copies. 0N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 2362N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 0N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 0N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 0N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 0N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 0N/A - PERFORMANCE OF THIS SOFTWARE. 0N/A<
meta http-
equiv="Content-Type" content="text/html; charset=ISO-8859-1">
0N/A<
title>dnssec-keyfromlabel</
title>
2362N/A<
meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
2362N/A<
body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><
div class="refentry" lang="en">
0N/A<
div class="refnamediv">
0N/A<
p><
span class="application">dnssec-keyfromlabel</
span> — DNSSEC key generation tool</
p>
2956N/A<
div class="refsynopsisdiv">
4066N/A<
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>
2956N/A<
div class="refsect1" lang="en">
2956N/A<
a name="id2543510"></
a><
h2>DESCRIPTION</
h2>
2956N/A<
p><
span><
strong class="command">dnssec-keyfromlabel</
strong></
span>
2956N/A gets keys with the given label from a crypto hardware and builds
2956N/A key files for DNSSEC (Secure DNS), as defined in RFC 2535
2956N/A The <
code class="option">name</
code> of the key is specified on the command
0N/A line. This must match the name of the zone for which the key is
0N/A<
div class="refsect1" lang="en">
0N/A<
a name="id2543528"></
a><
h2>OPTIONS</
h2>
0N/A<
div class="variablelist"><
dl>
0N/A<
dt><
span class="term">-a <
em class="replaceable"><
code>algorithm</
code></
em></
span></
dt>
0N/A Selects the cryptographic algorithm. The value of
0N/A <
code class="option">algorithm</
code> must be one of RSAMD5, RSASHA1,
0N/A DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
0N/A ECDSAP256SHA256 or ECDSAP384SHA384.
0N/A These values are case insensitive.
0N/A If no algorithm is specified, then RSASHA1 will be used by
0N/A default, unless the <
code class="option">-3</
code> option is specified,
0N/A in which case NSEC3RSASHA1 will be used instead. (If
0N/A <
code class="option">-3</
code> is used and an algorithm is specified,
0N/A that algorithm will be checked for compatibility with NSEC3.)
0N/A Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
0N/A algorithm, and DSA is recommended.
0N/A Note 2: DH automatically sets the -k flag.
0N/A<
dt><
span class="term">-3</
span></
dt>
0N/A Use an NSEC3-capable algorithm to generate a DNSSEC key.
2638N/A If this option is used and no algorithm is explicitly
2638N/A set on the command line, NSEC3RSASHA1 will be used by
0N/A<
dt><
span class="term">-E <
em class="replaceable"><
code>engine</
code></
em></
span></
dt>
2638N/A Specifies the cryptographic hardware to use.
0N/A When BIND is built with OpenSSL PKCS#11 support, this defaults
2956N/A to the string "pkcs11", which identifies an OpenSSL engine
2956N/A that can drive a cryptographic accelerator or hardware service
2956N/A module. When BIND is built with native PKCS#11 cryptography
2956N/A (--enable-native-pkcs11), it defaults to the path of the PKCS#11
2956N/A provider library specified via "--with-pkcs11".
2956N/A<
dt><
span class="term">-l <
em class="replaceable"><
code>label</
code></
em></
span></
dt>
2956N/A Specifies the label of the key pair in the crypto hardware.
2956N/A The label may be preceded by an optional OpenSSL engine name,
0N/A separated by a colon, as in "pkcs11:keylabel".
0N/A<
dt><
span class="term">-n <
em class="replaceable"><
code>nametype</
code></
em></
span></
dt>
0N/A Specifies the owner type of the key. The value of
0N/A <
code class="option">nametype</
code> must either be ZONE (for a DNSSEC
0N/A USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
0N/A These values are case insensitive.
0N/A<
dt><
span class="term">-C</
span></
dt>
0N/A Compatibility mode: generates an old-style key, without
2638N/A any metadata. By default, <
span><
strong class="command">dnssec-keyfromlabel</
strong></
span>
0N/A will include the key's creation date in the metadata stored
2956N/A with the private key, and other dates may be set there as well
2638N/A (publication date, activation date, etc). Keys that include
0N/A this data may be incompatible with older versions of BIND; the
0N/A <
code class="option">-C</
code> option suppresses them.
2956N/A<
dt><
span class="term">-c <
em class="replaceable"><
code>class</
code></
em></
span></
dt>
0N/A Indicates that the DNS record containing the key should have
2638N/A the specified class. If not specified, class IN is used.
0N/A<
dt><
span class="term">-f <
em class="replaceable"><
code>flag</
code></
em></
span></
dt>
2638N/A The only recognized flags are KSK (Key Signing Key) and REVOKE.
2956N/A<
dt><
span class="term">-G</
span></
dt>
0N/A Generate a key, but do not publish it or sign with it. This
2956N/A option is incompatible with -P and -A.
2956N/A<
dt><
span class="term">-h</
span></
dt>
2956N/A Prints a short summary of the options and arguments to
2956N/A <
span><
strong class="command">dnssec-keyfromlabel</
strong></
span>.
2956N/A<
dt><
span class="term">-K <
em class="replaceable"><
code>directory</
code></
em></
span></
dt>
0N/A Sets the directory in which the key files are to be written.
0N/A<
dt><
span class="term">-k</
span></
dt>
2956N/A Generate KEY records rather than DNSKEY records.
2956N/A<
dt><
span class="term">-L <
em class="replaceable"><
code>ttl</
code></
em></
span></
dt>
2956N/A Sets the default TTL to use for this key when it is converted
2956N/A into a DNSKEY RR. If the key is imported into a zone,
2956N/A this is the TTL that will be used for it, unless there was
2956N/A already a DNSKEY RRset in place, in which case the existing TTL
2956N/A would take precedence. Setting the default TTL to
2956N/A <
code class="literal">0</
code> or <
code class="literal">none</
code> removes it.
0N/A<
dt><
span class="term">-p <
em class="replaceable"><
code>protocol</
code></
em></
span></
dt>
2638N/A Sets the protocol value for the key. The protocol
2956N/A is a number between 0 and 255. The default is 3 (DNSSEC).
2638N/A Other possible values for this argument are listed in
2638N/A RFC 2535 and its successors.
2638N/A<
dt><
span class="term">-t <
em class="replaceable"><
code>type</
code></
em></
span></
dt>
0N/A Indicates the use of the key. <
code class="option">type</
code> must be
2956N/A one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
2956N/A is AUTHCONF. AUTH refers to the ability to authenticate
0N/A data, and CONF the ability to encrypt data.
0N/A<
dt><
span class="term">-v <
em class="replaceable"><
code>level</
code></
em></
span></
dt>
2638N/A<
dt><
span class="term">-y</
span></
dt>
0N/A Allows DNSSEC key files to be generated even if the key ID
0N/A would collide with that of an existing key, in the event of
0N/A either key being revoked. (This is only safe to use if you
0N/A are sure you won't be using RFC 5011 trust anchor maintenance
0N/A with either of the keys involved.)
0N/A<
div class="refsect1" lang="en">
2956N/A<
a name="id2543987"></
a><
h2>TIMING OPTIONS</
h2>
0N/A Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
2956N/A If the argument begins with a '+' or '-', it is interpreted as
2956N/A an offset from the present time. For convenience, if such an offset
2956N/A is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
2956N/A then the offset is computed in years (defined as 365 24-hour days,
2956N/A ignoring leap years), months (defined as 30 24-hour days), weeks,
2956N/A days, hours, or minutes, respectively. Without a suffix, the offset
2956N/A<
div class="variablelist"><
dl>
2956N/A<
dt><
span class="term">-P <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
2956N/A Sets the date on which a key is to be published to the zone.
2956N/A After that date, the key will be included in the zone but will
0N/A not be used to sign it. If not set, and if the -G option has
2956N/A not been used, the default is "now".
2956N/A<
dt><
span class="term">-A <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
2956N/A Sets the date on which the key is to be activated. After that
2956N/A date, the key will be included in the zone and used to sign
2956N/A it. If not set, and if the -G option has not been used, the
2956N/A<
dt><
span class="term">-R <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
2956N/A Sets the date on which the key is to be revoked. After that
2956N/A date, the key will be flagged as revoked. It will be included
2956N/A in the zone and will be used to sign it.
2956N/A<
dt><
span class="term">-I <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
2956N/A Sets the date on which the key is to be retired. After that
2956N/A date, the key will still be included in the zone, but it
2956N/A will not be used to sign it.
2956N/A<
dt><
span class="term">-D <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
2956N/A Sets the date on which the key is to be deleted. After that
2956N/A date, the key will no longer be included in the zone. (It
2956N/A may remain in the key repository, however.)
2956N/A<
div class="refsect1" lang="en">
2956N/A<
a name="id2544085"></
a><
h2>GENERATED KEY FILES</
h2>
2956N/A When <
span><
strong class="command">dnssec-keyfromlabel</
strong></
span> completes
0N/A it prints a string of the form <
code class="filename">Knnnn.+aaa+iiiii</
code>
0N/A to the standard output. This is an identification string for
0N/A the key files it has generated.
2956N/A<
div class="itemizedlist"><
ul type="disc">
2956N/A<
li><
p><
code class="filename">nnnn</
code> is the key name.
2956N/A<
li><
p><
code class="filename">aaa</
code> is the numeric representation
2956N/A<
li><
p><
code class="filename">iiiii</
code> is the key identifier (or
2956N/A<
p><
span><
strong class="command">dnssec-keyfromlabel</
strong></
span>
4066N/A creates two files, with names based
4066N/A on the printed string. <
code class="filename">Knnnn.+aaa+
iiiii.key</
code>
2956N/A contains the public key, and
2956N/A The <
code class="filename">.key</
code> file contains a DNS KEY record
2956N/A can be inserted into a zone file (directly or with a $INCLUDE
2956N/A The <
code class="filename">.private</
code> file contains
2956N/A fields. For obvious security reasons, this file does not have
2956N/A<
div class="refsect1" lang="en">
2956N/A<
a name="id2544157"></
a><
h2>SEE ALSO</
h2>
2956N/A<
p><
span class="citerefentry"><
span class="refentrytitle">dnssec-keygen</
span>(8)</
span>,
2956N/A <
span class="citerefentry"><
span class="refentrytitle">dnssec-signzone</
span>(8)</
span>,
2956N/A <
em class="citetitle">BIND 9 Administrator Reference Manual</
em>,
2956N/A <
em class="citetitle">RFC 4034</
em>.
2956N/A<
div class="refsect1" lang="en">
2956N/A<
a name="id2544190"></
a><
h2>AUTHOR</
h2>
2956N/A<
p><
span class="corpauthor">Internet Systems Consortium</
span>