1DNSSEC-KEYFROMLABEL(8)               BIND9              DNSSEC-KEYFROMLABEL(8)
2
3
4

NAME

6       dnssec-keyfromlabel - DNSSEC key generation tool
7

SYNOPSIS

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]
12                           [-n nametype] [-P date/offset] [-p protocol]
13                           [-R date/offset] [-t type] [-v level] [-y] {name}
14

DESCRIPTION

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
20       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

OPTIONS

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 or ECCGOST. These values are case insensitive.
28
29           If no algorithm is specified, then RSASHA1 will be used by default,
30           unless the -3 option is specified, in which case NSEC3RSASHA1 will
31           be used instead. (If -3 is used and an algorithm is specified, that
32           algorithm will be checked for compatibility with NSEC3.)
33
34           Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement
35           algorithm, and DSA is recommended.
36
37           Note 2: DH automatically sets the -k flag.
38
39       -3
40           Use an NSEC3-capable algorithm to generate a DNSSEC key. If this
41           option is used and no algorithm is explicitly set on the command
42           line, NSEC3RSASHA1 will be used by default.
43
44       -E engine
45           Specifies the name of the crypto hardware (OpenSSL engine). When
46           compiled with PKCS#11 support it defaults to "pkcs11".
47
48       -l label
49           Specifies the label of the key pair in the crypto hardware. The
50           label may be preceded by an optional OpenSSL engine name, separated
51           by a colon, as in "pkcs11:keylabel".
52
53       -n nametype
54           Specifies the owner type of the key. The value of nametype must
55           either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY
56           (for a key associated with a host (KEY)), USER (for a key
57           associated with a user(KEY)) or OTHER (DNSKEY). These values are
58           case insensitive.
59
60       -C
61           Compatibility mode: generates an old-style key, without any
62           metadata. By default, dnssec-keyfromlabel will include the key's
63           creation date in the metadata stored with the private key, and
64           other dates may be set there as well (publication date, activation
65           date, etc). Keys that include this data may be incompatible with
66           older versions of BIND; the -C option suppresses them.
67
68       -c class
69           Indicates that the DNS record containing the key should have the
70           specified class. If not specified, class IN is used.
71
72       -f flag
73           Set the specified flag in the flag field of the KEY/DNSKEY record.
74           The only recognized flags are KSK (Key Signing Key) and REVOKE.
75
76       -G
77           Generate a key, but do not publish it or sign with it. This option
78           is incompatible with -P and -A.
79
80       -h
81           Prints a short summary of the options and arguments to
82           dnssec-keyfromlabel.
83
84       -K directory
85           Sets the directory in which the key files are to be written.
86
87       -k
88           Generate KEY records rather than DNSKEY records.
89
90       -p protocol
91           Sets the protocol value for the key. The protocol is a number
92           between 0 and 255. The default is 3 (DNSSEC). Other possible values
93           for this argument are listed in RFC 2535 and its successors.
94
95       -t type
96           Indicates the use of the key.  type must be one of AUTHCONF,
97           NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers
98           to the ability to authenticate data, and CONF the ability to
99           encrypt data.
100
101       -v level
102           Sets the debugging level.
103
104       -y
105           Allows DNSSEC key files to be generated even if the key ID would
106           collide with that of an existing key, in the event of either key
107           being revoked. (This is only safe to use if you are sure you won't
108           be using RFC 5011 trust anchor maintenance with either of the keys
109           involved.)
110

TIMING OPTIONS

112       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the
113       argument begins with a '+' or '-', it is interpreted as an offset from
114       the present time. For convenience, if such an offset is followed by one
115       of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is
116       computed in years (defined as 365 24-hour days, ignoring leap years),
117       months (defined as 30 24-hour days), weeks, days, hours, or minutes,
118       respectively. Without a suffix, the offset is computed in seconds.
119
120       -P date/offset
121           Sets the date on which a key is to be published to the zone. After
122           that date, the key will be included in the zone but will not be
123           used to sign it. If not set, and if the -G option has not been
124           used, the default is "now".
125
126       -A date/offset
127           Sets the date on which the key is to be activated. After that date,
128           the key will be included in the zone and used to sign it. If not
129           set, and if the -G option has not been used, the default is "now".
130
131       -R date/offset
132           Sets the date on which the key is to be revoked. After that date,
133           the key will be flagged as revoked. It will be included in the zone
134           and will be used to sign it.
135
136       -I date/offset
137           Sets the date on which the key is to be retired. After that date,
138           the key will still be included in the zone, but it will not be used
139           to sign it.
140
141       -D date/offset
142           Sets the date on which the key is to be deleted. After that date,
143           the key will no longer be included in the zone. (It may remain in
144           the key repository, however.)
145

GENERATED KEY FILES

147       When dnssec-keyfromlabel completes successfully, it prints a string of
148       the form Knnnn.+aaa+iiiii to the standard output. This is an
149       identification string for the key files it has generated.
150
151       ·   nnnn is the key name.
152
153       ·   aaa is the numeric representation of the algorithm.
154
155       ·   iiiii is the key identifier (or footprint).
156
157       dnssec-keyfromlabel creates two files, with names based on the printed
158       string.  Knnnn.+aaa+iiiii.key contains the public key, and
159       Knnnn.+aaa+iiiii.private contains the private key.
160
161       The .key file contains a DNS KEY record that can be inserted into a
162       zone file (directly or with a $INCLUDE statement).
163
164       The .private file contains algorithm-specific fields. For obvious
165       security reasons, this file does not have general read permission.
166

SEE ALSO

168       dnssec-keygen(8), dnssec-signzone(8), BIND 9 Administrator Reference
169       Manual, RFC 4034.
170

AUTHOR

172       Internet Systems Consortium
173
175       Copyright © 2008-2011 Internet Systems Consortium, Inc. ("ISC")
176
177
178
179BIND9                          February 8, 2008         DNSSEC-KEYFROMLABEL(8)
Impressum