1DNSSEC-KEYFROMLABEL(8) BIND9 DNSSEC-KEYFROMLABEL(8)
2
6 dnssec-keyfromlabel - DNSSEC key generation tool
7
9 dnssec-keyfromlabel {-l label} [-3] [-a algorithm] [-A date/offset]
10 [-c class] [-D date/offset] [-D sync date/offset]
11 [-E engine] [-f flag] [-G] [-I date/offset]
12 [-i interval] [-k] [-K directory] [-L ttl]
13 [-n nametype] [-P date/offset]
14 [-P sync date/offset] [-p protocol]
15 [-R date/offset] [-S key] [-t type] [-v level] [-V]
16 [-y] {name}
17
19 dnssec-keyfromlabel generates a key pair of files that referencing a
20 key object stored in a cryptographic hardware service module (HSM). The
21 private key file can be used for DNSSEC signing of zone data as if it
22 were a conventional signing key created by dnssec-keygen, but the key
23 material is stored within the HSM, and the actual signing takes place
24 there.
25 The name of the key is specified on the command line. This must match
27 the name of the zone for which the key is being generated.
28
30 -a algorithm
31 Selects the cryptographic algorithm. The value of algorithm must be
32 one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256,
33 RSASHA512, ECCGOST, ECDSAP256SHA256, ECDSAP384SHA384, ED25519 or
34 ED448. These values are case insensitive.
35 If no algorithm is specified, then RSASHA1 will be used by default,
37 unless the -3 option is specified, in which case NSEC3RSASHA1 will
38 be used instead. (If -3 is used and an algorithm is specified, that
39 algorithm will be checked for compatibility with NSEC3.)
40 Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
42 algorithm, and DSA is recommended.
43 Note 2: DH automatically sets the -k flag.
45 -3
47 Use an NSEC3-capable algorithm to generate a DNSSEC key. If this
48 option is used and no algorithm is explicitly set on the command
49 line, NSEC3RSASHA1 will be used by default.
50 -E engine
52 Specifies the cryptographic hardware to use.
53 When BIND is built with OpenSSL PKCS#11 support, this defaults to
55 the string "pkcs11", which identifies an OpenSSL engine that can
56 drive a cryptographic accelerator or hardware service module. When
57 BIND is built with native PKCS#11 cryptography
58 (--enable-native-pkcs11), it defaults to the path of the PKCS#11
59 provider library specified via "--with-pkcs11".
60 -l label
62 Specifies the label for a key pair in the crypto hardware.
63 When BIND 9 is built with OpenSSL-based PKCS#11 support, the label
65 is an arbitrary string that identifies a particular key.
66 When BIND 9 is built with native PKCS#11 support, the label is a
68 PKCS#11 URI string in the format
69 "pkcs11:keyword=value[;keyword=value;...]" Keywords include
70 "token", which identifies the HSM; "object", which identifies the
71 key; and "pin-source", which identifies a file from which the HSM's
72 PIN code can be obtained. The label will be stored in the on-disk
73 "private" file.
74 If the label contains a pin-source field, tools using the generated
76 key files will be able to use the HSM for signing and other
77 operations without any need for an operator to manually enter a
78 PIN. Note: Making the HSM's PIN accessible in this manner may
79 reduce the security advantage of using an HSM; be sure this is what
80 you want to do before making use of this feature.
81 -n nametype
83 Specifies the owner type of the key. The value of nametype must
84 either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY
85 (for a key associated with a host (KEY)), USER (for a key
86 associated with a user(KEY)) or OTHER (DNSKEY). These values are
87 case insensitive.
88 -C
90 Compatibility mode: generates an old-style key, without any
91 metadata. By default, dnssec-keyfromlabel will include the key's
92 creation date in the metadata stored with the private key, and
93 other dates may be set there as well (publication date, activation
94 date, etc). Keys that include this data may be incompatible with
95 older versions of BIND; the -C option suppresses them.
96 -c class
98 Indicates that the DNS record containing the key should have the
99 specified class. If not specified, class IN is used.
100 -f flag
102 Set the specified flag in the flag field of the KEY/DNSKEY record.
103 The only recognized flags are KSK (Key Signing Key) and REVOKE.
104 -G
106 Generate a key, but do not publish it or sign with it. This option
107 is incompatible with -P and -A.
108 -h
110 Prints a short summary of the options and arguments to
111 dnssec-keyfromlabel.
112 -K directory
114 Sets the directory in which the key files are to be written.
115 -k
117 Generate KEY records rather than DNSKEY records.
118 -L ttl
120 Sets the default TTL to use for this key when it is converted into
121 a DNSKEY RR. If the key is imported into a zone, this is the TTL
122 that will be used for it, unless there was already a DNSKEY RRset
123 in place, in which case the existing TTL would take precedence.
124 Setting the default TTL to 0 or none removes it.
125 -p protocol
127 Sets the protocol value for the key. The protocol is a number
128 between 0 and 255. The default is 3 (DNSSEC). Other possible values
129 for this argument are listed in RFC 2535 and its successors.
130 -S key
132 Generate a key as an explicit successor to an existing key. The
133 name, algorithm, size, and type of the key will be set to match the
134 predecessor. The activation date of the new key will be set to the
135 inactivation date of the existing one. The publication date will be
136 set to the activation date minus the prepublication interval, which
137 defaults to 30 days.
138 -t type
140 Indicates the use of the key. type must be one of AUTHCONF,
141 NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers
142 to the ability to authenticate data, and CONF the ability to
143 encrypt data.
144 -v level
146 Sets the debugging level.
147 -V
149 Prints version information.
150 -y
152 Allows DNSSEC key files to be generated even if the key ID would
153 collide with that of an existing key, in the event of either key
154 being revoked. (This is only safe to use if you are sure you won't
155 be using RFC 5011 trust anchor maintenance with either of the keys
156 involved.)
157
159 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the
160 argument begins with a '+' or '-', it is interpreted as an offset from
161 the present time. For convenience, if such an offset is followed by one
162 of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is
163 computed in years (defined as 365 24-hour days, ignoring leap years),
164 months (defined as 30 24-hour days), weeks, days, hours, or minutes,
165 respectively. Without a suffix, the offset is computed in seconds. To
166 explicitly prevent a date from being set, use 'none' or 'never'.
167 -P date/offset
169 Sets the date on which a key is to be published to the zone. After
170 that date, the key will be included in the zone but will not be
171 used to sign it. If not set, and if the -G option has not been
172 used, the default is "now".
173 -P sync date/offset
175 Sets the date on which the CDS and CDNSKEY records which match this
176 key are to be published to the zone.
177 -A date/offset
179 Sets the date on which the key is to be activated. After that date,
180 the key will be included in the zone and used to sign it. If not
181 set, and if the -G option has not been used, the default is "now".
182 -R date/offset
184 Sets the date on which the key is to be revoked. After that date,
185 the key will be flagged as revoked. It will be included in the zone
186 and will be used to sign it.
187 -I date/offset
189 Sets the date on which the key is to be retired. After that date,
190 the key will still be included in the zone, but it will not be used
191 to sign it.
192 -D date/offset
194 Sets the date on which the key is to be deleted. After that date,
195 the key will no longer be included in the zone. (It may remain in
196 the key repository, however.)
197 -D sync date/offset
199 Sets the date on which the CDS and CDNSKEY records which match this
200 key are to be deleted.
201 -i interval
203 Sets the prepublication interval for a key. If set, then the
204 publication and activation dates must be separated by at least this
205 much time. If the activation date is specified but the publication
206 date isn't, then the publication date will default to this much
207 time before the activation date; conversely, if the publication
208 date is specified but activation date isn't, then activation will
209 be set to this much time after publication.
210 If the key is being created as an explicit successor to another
212 key, then the default prepublication interval is 30 days; otherwise
213 it is zero.
214 As with date offsets, if the argument is followed by one of the
216 suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is
217 measured in years, months, weeks, days, hours, or minutes,
218 respectively. Without a suffix, the interval is measured in
219 seconds.
220
222 When dnssec-keyfromlabel completes successfully, it prints a string of
223 the form Knnnn.+aaa+iiiii to the standard output. This is an
224 identification string for the key files it has generated.
225 · nnnn is the key name.
227 · aaa is the numeric representation of the algorithm.
229 · iiiii is the key identifier (or footprint).
231 dnssec-keyfromlabel creates two files, with names based on the printed
233 string. Knnnn.+aaa+iiiii.key contains the public key, and
234 Knnnn.+aaa+iiiii.private contains the private key.
235 The .key file contains a DNS KEY record that can be inserted into a
237 zone file (directly or with a $INCLUDE statement).
238 The .private file contains algorithm-specific fields. For obvious
240 security reasons, this file does not have general read permission.
241
243 dnssec-keygen(8), dnssec-signzone(8), BIND 9 Administrator Reference
244 Manual, RFC 4034, The PKCS#11 URI Scheme (draft-pechanec-pkcs11uri-13).
245
247 Internet Systems Consortium, Inc.
248
250 Copyright © 2008-2012, 2014-2021 Internet Systems Consortium, Inc.
251 ("ISC")
252ISC August 27, 2015 DNSSEC-KEYFROMLABEL(8)