0N/A - Copyright (C) 2000-2018 Internet Systems Consortium, Inc. ("ISC") 0N/A - This Source Code Form is subject to the terms of the Mozilla Public 0N/A - License, v. 2.0. If a copy of the MPL was not distributed with this 0N/A<
meta http-
equiv="Content-Type" content="text/html; charset=ISO-8859-1">
0N/A<
title>dnssec-keyfromlabel</
title>
0N/A<
meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
0N/A<
link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
873N/A<
body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
0N/A<
div class="navheader">
0N/A<
table width="100%" summary="Navigation header">
0N/A<
tr><
th colspan="3" align="center"><
span class="application">dnssec-keyfromlabel</
span></
th></
tr>
0N/A<
td width="20%" align="left">
0N/A<
th width="60%" align="center">Manual pages</
th>
0N/A <
div class="refnamediv">
0N/A <
span class="application">dnssec-keyfromlabel</
span>
776N/A — DNSSEC key generation tool
2086N/A <
div class="refsynopsisdiv">
0N/A <
div class="cmdsynopsis"><
p>
0N/A <
code class="command">dnssec-keyfromlabel</
code>
1177N/A {-l <
em class="replaceable"><
code>label</
code></
em>}
776N/A [<
code class="option">-3</
code>]
776N/A [<
code class="option">-a <
em class="replaceable"><
code>algorithm</
code></
em></
code>]
0N/A [<
code class="option">-A <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
0N/A [<
code class="option">-c <
em class="replaceable"><
code>class</
code></
em></
code>]
0N/A [<
code class="option">-D <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
0N/A [<
code class="option">-D sync <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
0N/A [<
code class="option">-E <
em class="replaceable"><
code>engine</
code></
em></
code>]
2488N/A [<
code class="option">-f <
em class="replaceable"><
code>flag</
code></
em></
code>]
2488N/A [<
code class="option">-G</
code>]
0N/A [<
code class="option">-I <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
0N/A [<
code class="option">-i <
em class="replaceable"><
code>interval</
code></
em></
code>]
0N/A [<
code class="option">-k</
code>]
0N/A [<
code class="option">-K <
em class="replaceable"><
code>directory</
code></
em></
code>]
0N/A [<
code class="option">-L <
em class="replaceable"><
code>ttl</
code></
em></
code>]
0N/A [<
code class="option">-n <
em class="replaceable"><
code>nametype</
code></
em></
code>]
0N/A [<
code class="option">-P <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
1400N/A [<
code class="option">-P sync <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
1400N/A [<
code class="option">-p <
em class="replaceable"><
code>protocol</
code></
em></
code>]
1400N/A [<
code class="option">-R <
em class="replaceable"><
code>
date/
offset</
code></
em></
code>]
1400N/A [<
code class="option">-S <
em class="replaceable"><
code>key</
code></
em></
code>]
1400N/A [<
code class="option">-t <
em class="replaceable"><
code>type</
code></
em></
code>]
0N/A [<
code class="option">-v <
em class="replaceable"><
code>level</
code></
em></
code>]
2488N/A [<
code class="option">-V</
code>]
2488N/A [<
code class="option">-y</
code>]
2488N/A<
a name="id-1.14.11.7"></
a><
h2>DESCRIPTION</
h2>
2488N/A <
p><
span class="command"><
strong>dnssec-keyfromlabel</
strong></
span>
2488N/A generates a key pair of files that referencing a key object stored
2488N/A in a cryptographic hardware service module (HSM). The private key
2488N/A file can be used for DNSSEC signing of zone data as if it were a
2488N/A conventional signing key created by <
span class="command"><
strong>dnssec-keygen</
strong></
span>,
2488N/A but the key material is stored within the HSM, and the actual signing
2488N/A The <
code class="option">name</
code> of the key is specified on the command
2488N/A line. This must match the name of the zone for which the key is
2488N/A<
a name="id-1.14.11.8"></
a><
h2>OPTIONS</
h2>
2488N/A <
div class="variablelist"><
dl class="variablelist">
2488N/A<
dt><
span class="term">-a <
em class="replaceable"><
code>algorithm</
code></
em></
span></
dt>
2488N/A Selects the cryptographic algorithm. The value of
2488N/A <
code class="option">algorithm</
code> must be one of RSAMD5, RSASHA1,
2488N/A DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST,
2488N/A ECDSAP256SHA256, ECDSAP384SHA384, ED25519 or ED448.
2488N/A These values are case insensitive.
2488N/A If no algorithm is specified, then RSASHA1 will be used by
2488N/A default, unless the <
code class="option">-3</
code> option is specified,
2488N/A in which case NSEC3RSASHA1 will be used instead. (If
2488N/A <
code class="option">-3</
code> is used and an algorithm is specified,
2488N/A that algorithm will be checked for compatibility with NSEC3.)
2488N/A Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
2488N/A algorithm, and DSA is recommended.
2488N/A Note 2: DH automatically sets the -k flag.
2488N/A<
dt><
span class="term">-3</
span></
dt>
2488N/A Use an NSEC3-capable algorithm to generate a DNSSEC key.
2488N/A If this option is used and no algorithm is explicitly
2488N/A set on the command line, NSEC3RSASHA1 will be used by
2488N/A<
dt><
span class="term">-E <
em class="replaceable"><
code>engine</
code></
em></
span></
dt>
2488N/A Specifies the cryptographic hardware to use.
2488N/A When BIND is built with OpenSSL PKCS#11 support, this defaults
2488N/A to the string "pkcs11", which identifies an OpenSSL engine
2488N/A that can drive a cryptographic accelerator or hardware service
2488N/A module. When BIND is built with native PKCS#11 cryptography
2488N/A (--enable-native-pkcs11), it defaults to the path of the PKCS#11
2488N/A provider library specified via "--with-pkcs11".
0N/A<
dt><
span class="term">-l <
em class="replaceable"><
code>label</
code></
em></
span></
dt>
0N/A Specifies the label for a key pair in the crypto hardware.
0N/A When <
acronym class="acronym">BIND</
acronym> 9 is built with OpenSSL-based
1932N/A PKCS#11 support, the label is an arbitrary string that
0N/A identifies a particular key. It may be preceded by an
0N/A optional OpenSSL engine name, followed by a colon, as in
1773N/A "pkcs11:<
em class="replaceable"><
code>keylabel</
code></
em>".
0N/A When <
acronym class="acronym">BIND</
acronym> 9 is built with native PKCS#11
0N/A support, the label is a PKCS#11 URI string in the format
0N/A "pkcs11:<
code class="option">keyword</
code>=<
em class="replaceable"><
code>value</
code></
em>[<
span class="optional">;<
code class="option">keyword</
code>=<
em class="replaceable"><
code>value</
code></
em>;...</
span>]"
0N/A Keywords include "token", which identifies the HSM; "object", which
0N/A identifies the key; and "pin-source", which identifies a file from
0N/A which the HSM's PIN code can be obtained. The label will be
0N/A stored in the on-disk "private" file.
2488N/A <
code class="option">pin-source</
code> field, tools using the generated
2488N/A key files will be able to use the HSM for signing and other
2488N/A operations without any need for an operator to manually enter
2488N/A a PIN. Note: Making the HSM's PIN accessible in this manner
2488N/A may reduce the security advantage of using an HSM; be sure
2488N/A this is what you want to do before making use of this feature.
2488N/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 zone key (
KEY/
DNSKEY)), HOST or ENTITY (for a key associated with
0N/A USER (for a key associated with a user(KEY)) or OTHER (DNSKEY).
776N/A These values are case insensitive.
776N/A<
dt><
span class="term">-C</
span></
dt>
776N/A Compatibility mode: generates an old-style key, without
776N/A any metadata. By default, <
span class="command"><
strong>dnssec-keyfromlabel</
strong></
span>
2086N/A will include the key's creation date in the metadata stored
776N/A with the private key, and other dates may be set there as well
2086N/A (publication date, activation date, etc). Keys that include
776N/A this data may be incompatible with older versions of BIND; the
776N/A <
code class="option">-C</
code> option suppresses them.
0N/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
0N/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>
0N/A Set the specified flag in the flag field of the
KEY/
DNSKEY record.
0N/A The only recognized flags are KSK (Key Signing Key) and REVOKE.
1773N/A<
dt><
span class="term">-G</
span></
dt>
0N/A Generate a key, but do not publish it or sign with it. This
1932N/A option is incompatible with -P and -A.
0N/A<
dt><
span class="term">-h</
span></
dt>
0N/A Prints a short summary of the options and arguments to
0N/A <
span class="command"><
strong>dnssec-keyfromlabel</
strong></
span>.
0N/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>
0N/A Generate KEY records rather than DNSKEY records.
0N/A<
dt><
span class="term">-L <
em class="replaceable"><
code>ttl</
code></
em></
span></
dt>
1773N/A Sets the default TTL to use for this key when it is converted
1773N/A into a DNSKEY RR. If the key is imported into a zone,
1773N/A this is the TTL that will be used for it, unless there was
0N/A already a DNSKEY RRset in place, in which case the existing TTL
0N/A would take precedence. Setting the default TTL to
0N/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>
0N/A Sets the protocol value for the key. The protocol
0N/A is a number between 0 and 255. The default is 3 (DNSSEC).
0N/A Other possible values for this argument are listed in
0N/A RFC 2535 and its successors.
0N/A<
dt><
span class="term">-S <
em class="replaceable"><
code>key</
code></
em></
span></
dt>
0N/A Generate a key as an explicit successor to an existing key.
0N/A The name, algorithm, size, and type of the key will be set
0N/A to match the predecessor. The activation date of the new
0N/A key will be set to the inactivation date of the existing
0N/A one. The publication date will be set to the activation
0N/A date minus the prepublication interval, which defaults to
0N/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
0N/A one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default
0N/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>
0N/A Sets the debugging level.
0N/A<
dt><
span class="term">-V</
span></
dt>
1773N/A Prints version information.
1773N/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.)
1932N/A<
a name="id-1.14.11.9"></
a><
h2>TIMING OPTIONS</
h2>
1932N/A Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
2086N/A If the argument begins with a '+' or '-', it is interpreted as
2086N/A an offset from the present time. For convenience, if such an offset
2086N/A is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
1932N/A then the offset is computed in years (defined as 365 24-hour days,
1932N/A ignoring leap years), months (defined as 30 24-hour days), weeks,
1987N/A days, hours, or minutes, respectively. Without a suffix, the offset
1987N/A is computed in seconds. To explicitly prevent a date from being
1987N/A set, use 'none' or 'never'.
1987N/A <
div class="variablelist"><
dl class="variablelist">
1987N/A<
dt><
span class="term">-P <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
1987N/A Sets the date on which a key is to be published to the zone.
1987N/A After that date, the key will be included in the zone but will
1987N/A not be used to sign it. If not set, and if the -G option has
1987N/A not been used, the default is "now".
1987N/A<
dt><
span class="term">-P sync <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
2086N/A Sets the date on which the CDS and CDNSKEY records which match
1987N/A this key are to be published to the zone.
2086N/A<
dt><
span class="term">-A <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
1987N/A Sets the date on which the key is to be activated. After that
1987N/A date, the key will be included in the zone and used to sign
1987N/A it. If not set, and if the -G option has not been used, the
1987N/A<
dt><
span class="term">-R <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
1987N/A Sets the date on which the key is to be revoked. After that
1987N/A date, the key will be flagged as revoked. It will be included
1987N/A in the zone and will be used to sign it.
1987N/A<
dt><
span class="term">-I <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
2086N/A Sets the date on which the key is to be retired. After that
2086N/A date, the key will still be included in the zone, but it
1987N/A will not be used to sign it.
2086N/A<
dt><
span class="term">-D <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
1987N/A Sets the date on which the key is to be deleted. After that
1987N/A date, the key will no longer be included in the zone. (It
1987N/A may remain in the key repository, however.)
1987N/A<
dt><
span class="term">-D sync <
em class="replaceable"><
code>
date/
offset</
code></
em></
span></
dt>
1987N/A Sets the date on which the CDS and CDNSKEY records which match
1987N/A this key are to be deleted.
1987N/A<
dt><
span class="term">-i <
em class="replaceable"><
code>interval</
code></
em></
span></
dt>
1987N/A Sets the prepublication interval for a key. If set, then
2086N/A the publication and activation dates must be separated by at least
2086N/A this much time. If the activation date is specified but the
2086N/A publication date isn't, then the publication date will default
1987N/A to this much time before the activation date; conversely, if
1987N/A the publication date is specified but activation date isn't,
1987N/A then activation will be set to this much time after publication.
1987N/A If the key is being created as an explicit successor to another
1987N/A key, then the default prepublication interval is 30 days;
1987N/A As with date offsets, if the argument is followed by one of
2086N/A the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the
2086N/A interval is measured in years, months, weeks, days, hours,
2086N/A or minutes, respectively. Without a suffix, the interval is
1932N/A<
a name="id-1.14.11.10"></
a><
h2>GENERATED KEY FILES</
h2>
1932N/A When <
span class="command"><
strong>dnssec-keyfromlabel</
strong></
span> completes
1932N/A it prints a string of the form <
code class="filename">Knnnn.+aaa+iiiii</
code>
2086N/A to the standard output. This is an identification string for
2086N/A the key files it has generated.
1987N/A <
div class="itemizedlist"><
ul class="itemizedlist" style="list-style-type: disc; ">
1987N/A <
p><
code class="filename">nnnn</
code> is the key name.
1932N/A <
p><
code class="filename">aaa</
code> is the numeric representation
1932N/A <
p><
code class="filename">iiiii</
code> is the key identifier (or
1932N/A <
p><
span class="command"><
strong>dnssec-keyfromlabel</
strong></
span>
1932N/A creates two files, with names based
1932N/A on the printed string. <
code class="filename">Knnnn.+aaa+
iiiii.key</
code>
1932N/A contains the public key, and
1932N/A The <
code class="filename">.key</
code> file contains a DNS KEY record
1932N/A can be inserted into a zone file (directly or with a $INCLUDE
1932N/A The <
code class="filename">.private</
code> file contains
1932N/A fields. For obvious security reasons, this file does not have
1932N/A<
a name="id-1.14.11.11"></
a><
h2>SEE ALSO</
h2>
1932N/A <
p><
span class="citerefentry">
1987N/A <
span class="refentrytitle">dnssec-keygen</
span>(8)
1987N/A <
span class="citerefentry">
1987N/A <
span class="refentrytitle">dnssec-signzone</
span>(8)
1987N/A <
em class="citetitle">BIND 9 Administrator Reference Manual</
em>,
1987N/A <
em class="citetitle">RFC 4034</
em>,
1987N/A <
em class="citetitle">The PKCS#11 URI Scheme (draft-pechanec-pkcs11uri-13)</
em>.
2086N/A<
table width="100%" summary="Navigation footer">
1987N/A<
td width="40%" align="left">
0N/A<
td width="40%" align="left" valign="top">
0N/A<
span class="application">dnssec-importkey</
span>�</
td>
0N/A<
td width="20%" align="center"><
a accesskey="h" href="Bv9ARM.html">Home</
a></
td>
0N/A<
td width="40%" align="right" valign="top">�<
span class="application">dnssec-keygen</
span>