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] [-E engine] [-f flag]
11 [-G] [-I date/offset] [-k] [-K directory] [-L ttl]
12 [-n nametype] [-P date/offset] [-p protocol]
13 [-R date/offset] [-t type] [-v level] [-y] {name}
14
16 dnssec-keyfromlabel gets keys with the given label from a crypto
17 hardware and builds key files for DNSSEC (Secure DNS), as defined in
18 RFC 2535 and RFC 4034.
19 The name of the key is specified on the command line. This must match
21 the name of the zone for which the key is being generated.
22
24 -a algorithm
25 Selects the cryptographic algorithm. The value of algorithm must be
26 one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256,
27 RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384. These
28 values are case insensitive.
29 If no algorithm is specified, then RSASHA1 will be used by default,
31 unless the -3 option is specified, in which case NSEC3RSASHA1 will
32 be used instead. (If -3 is used and an algorithm is specified, that
33 algorithm will be checked for compatibility with NSEC3.)
34 Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
36 algorithm, and DSA is recommended.
37 Note 2: DH automatically sets the -k flag.
39 -3
41 Use an NSEC3-capable algorithm to generate a DNSSEC key. If this
42 option is used and no algorithm is explicitly set on the command
43 line, NSEC3RSASHA1 will be used by default.
44 -E engine
46 Specifies the name of the crypto hardware (OpenSSL engine). When
47 compiled with PKCS#11 support it defaults to "pkcs11".
48 -l label
50 Specifies the label of the key pair in the crypto hardware. The
51 label may be preceded by an optional OpenSSL engine name, separated
52 by a colon, as in "pkcs11:keylabel".
53 -n nametype
55 Specifies the owner type of the key. The value of nametype must
56 either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY
57 (for a key associated with a host (KEY)), USER (for a key
58 associated with a user(KEY)) or OTHER (DNSKEY). These values are
59 case insensitive.
60 -C
62 Compatibility mode: generates an old-style key, without any
63 metadata. By default, dnssec-keyfromlabel will include the key's
64 creation date in the metadata stored with the private key, and
65 other dates may be set there as well (publication date, activation
66 date, etc). Keys that include this data may be incompatible with
67 older versions of BIND; the -C option suppresses them.
68 -c class
70 Indicates that the DNS record containing the key should have the
71 specified class. If not specified, class IN is used.
72 -f flag
74 Set the specified flag in the flag field of the KEY/DNSKEY record.
75 The only recognized flags are KSK (Key Signing Key) and REVOKE.
76 -G
78 Generate a key, but do not publish it or sign with it. This option
79 is incompatible with -P and -A.
80 -h
82 Prints a short summary of the options and arguments to
83 dnssec-keyfromlabel.
84 -K directory
86 Sets the directory in which the key files are to be written.
87 -k
89 Generate KEY records rather than DNSKEY records.
90 -L ttl
92 Sets the default TTL to use for this key when it is converted into
93 a DNSKEY RR. If the key is imported into a zone, this is the TTL
94 that will be used for it, unless there was already a DNSKEY RRset
95 in place, in which case the existing TTL would take precedence.
96 Setting the default TTL to 0 or none removes it.
97 -p protocol
99 Sets the protocol value for the key. The protocol is a number
100 between 0 and 255. The default is 3 (DNSSEC). Other possible values
101 for this argument are listed in RFC 2535 and its successors.
102 -t type
104 Indicates the use of the key. type must be one of AUTHCONF,
105 NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers
106 to the ability to authenticate data, and CONF the ability to
107 encrypt data.
108 -v level
110 Sets the debugging level.
111 -y
113 Allows DNSSEC key files to be generated even if the key ID would
114 collide with that of an existing key, in the event of either key
115 being revoked. (This is only safe to use if you are sure you won't
116 be using RFC 5011 trust anchor maintenance with either of the keys
117 involved.)
118
120 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the
121 argument begins with a '+' or '-', it is interpreted as an offset from
122 the present time. For convenience, if such an offset is followed by one
123 of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is
124 computed in years (defined as 365 24-hour days, ignoring leap years),
125 months (defined as 30 24-hour days), weeks, days, hours, or minutes,
126 respectively. Without a suffix, the offset is computed in seconds.
127 -P date/offset
129 Sets the date on which a key is to be published to the zone. After
130 that date, the key will be included in the zone but will not be
131 used to sign it. If not set, and if the -G option has not been
132 used, the default is "now".
133 -A date/offset
135 Sets the date on which the key is to be activated. After that date,
136 the key will be included in the zone and used to sign it. If not
137 set, and if the -G option has not been used, the default is "now".
138 -R date/offset
140 Sets the date on which the key is to be revoked. After that date,
141 the key will be flagged as revoked. It will be included in the zone
142 and will be used to sign it.
143 -I date/offset
145 Sets the date on which the key is to be retired. After that date,
146 the key will still be included in the zone, but it will not be used
147 to sign it.
148 -D date/offset
150 Sets the date on which the key is to be deleted. After that date,
151 the key will no longer be included in the zone. (It may remain in
152 the key repository, however.)
153
155 When dnssec-keyfromlabel completes successfully, it prints a string of
156 the form Knnnn.+aaa+iiiii to the standard output. This is an
157 identification string for the key files it has generated.
158 · nnnn is the key name.
160 · aaa is the numeric representation of the algorithm.
162 · iiiii is the key identifier (or footprint).
164 dnssec-keyfromlabel creates two files, with names based on the printed
166 string. Knnnn.+aaa+iiiii.key contains the public key, and
167 Knnnn.+aaa+iiiii.private contains the private key.
168 The .key file contains a DNS KEY record that can be inserted into a
170 zone file (directly or with a $INCLUDE statement).
171 The .private file contains algorithm-specific fields. For obvious
173 security reasons, this file does not have general read permission.
174
176 dnssec-keygen(8), dnssec-signzone(8), BIND 9 Administrator Reference
177 Manual, RFC 4034.
178
180 Internet Systems Consortium
181
183 Copyright © 2008-2012 Internet Systems Consortium, Inc. ("ISC")
184BIND9 February 8, 2008 DNSSEC-KEYFROMLABEL(8)