dnssec-keyfromlabel.8 8.54 KB
Newer Older
Automatic Updater's avatar
Automatic Updater committed
1
.\" Copyright (C) 2008-2011 Internet Systems Consortium, Inc. ("ISC")
Francis Dupont's avatar
regen  
Francis Dupont committed
2
.\" 
Automatic Updater's avatar
regen  
Automatic Updater committed
3
.\" Permission to use, copy, modify, and/or distribute this software for any
Francis Dupont's avatar
regen  
Francis Dupont committed
4 5 6 7 8 9 10 11 12 13 14
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
.\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
.\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
.\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
Tinderbox User's avatar
Tinderbox User committed
15
.\" $Id$
Francis Dupont's avatar
regen  
Francis Dupont committed
16 17 18 19 20 21
.\"
.hy 0
.ad l
.\"     Title: dnssec\-keyfromlabel
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
Automatic Updater's avatar
regen  
Automatic Updater committed
22
.\"      Date: February 8, 2008
Francis Dupont's avatar
regen  
Francis Dupont committed
23 24 25
.\"    Manual: BIND9
.\"    Source: BIND9
.\"
Automatic Updater's avatar
regen  
Automatic Updater committed
26
.TH "DNSSEC\-KEYFROMLABEL" "8" "February 8, 2008" "BIND9" "BIND9"
Francis Dupont's avatar
regen  
Francis Dupont committed
27 28 29 30 31 32 33 34
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
dnssec\-keyfromlabel \- DNSSEC key generation tool
.SH "SYNOPSIS"
.HP 20
Automatic Updater's avatar
Automatic Updater committed
35
\fBdnssec\-keyfromlabel\fR {\-l\ \fIlabel\fR} [\fB\-3\fR] [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\ \fR\fB\fIflag\fR\fR] [\fB\-G\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-k\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-n\ \fR\fB\fInametype\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-p\ \fR\fB\fIprotocol\fR\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-y\fR] {name}
Francis Dupont's avatar
regen  
Francis Dupont committed
36 37 38 39
.SH "DESCRIPTION"
.PP
\fBdnssec\-keyfromlabel\fR
gets keys with the given label from a crypto hardware and builds key files for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034.
Automatic Updater's avatar
regen  
Automatic Updater committed
40 41 42 43
.PP
The
\fBname\fR
of the key is specified on the command line. This must match the name of the zone for which the key is being generated.
Francis Dupont's avatar
regen  
Francis Dupont committed
44 45 46 47 48 49
.SH "OPTIONS"
.PP
\-a \fIalgorithm\fR
.RS 4
Selects the cryptographic algorithm. The value of
\fBalgorithm\fR
50
must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384. These values are case insensitive.
Francis Dupont's avatar
regen  
Francis Dupont committed
51
.sp
Automatic Updater's avatar
regen  
Automatic Updater committed
52 53
If no algorithm is specified, then RSASHA1 will be used by default, unless the
\fB\-3\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
54 55 56
option is specified, in which case NSEC3RSASHA1 will be used instead. (If
\fB\-3\fR
is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.)
Automatic Updater's avatar
regen  
Automatic Updater committed
57
.sp
Francis Dupont's avatar
regen  
Francis Dupont committed
58 59 60 61 62
Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended.
.sp
Note 2: DH automatically sets the \-k flag.
.RE
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
63 64 65 66 67
\-3
.RS 4
Use an NSEC3\-capable algorithm to generate a DNSSEC key. If this option is used and no algorithm is explicitly set on the command line, NSEC3RSASHA1 will be used by default.
.RE
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
68 69
\-E \fIengine\fR
.RS 4
Automatic Updater's avatar
regen  
Automatic Updater committed
70
Specifies the name of the crypto hardware (OpenSSL engine). When compiled with PKCS#11 support it defaults to "pkcs11".
Automatic Updater's avatar
regen  
Automatic Updater committed
71 72
.RE
.PP
Francis Dupont's avatar
regen  
Francis Dupont committed
73 74
\-l \fIlabel\fR
.RS 4
Automatic Updater's avatar
regen  
Automatic Updater committed
75
Specifies the label of the key pair in the crypto hardware. The label may be preceded by an optional OpenSSL engine name, separated by a colon, as in "pkcs11:keylabel".
Francis Dupont's avatar
regen  
Francis Dupont committed
76 77 78 79 80 81 82 83 84
.RE
.PP
\-n \fInametype\fR
.RS 4
Specifies the owner type of the key. The value of
\fBnametype\fR
must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). These values are case insensitive.
.RE
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
85 86 87 88 89 90 91 92 93
\-C
.RS 4
Compatibility mode: generates an old\-style key, without any metadata. By default,
\fBdnssec\-keyfromlabel\fR
will include the key's creation date in the metadata stored with the private key, and other dates may be set there as well (publication date, activation date, etc). Keys that include this data may be incompatible with older versions of BIND; the
\fB\-C\fR
option suppresses them.
.RE
.PP
Francis Dupont's avatar
regen  
Francis Dupont committed
94 95 96 97 98 99 100
\-c \fIclass\fR
.RS 4
Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used.
.RE
.PP
\-f \fIflag\fR
.RS 4
Automatic Updater's avatar
regen  
Automatic Updater committed
101
Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE.
Francis Dupont's avatar
regen  
Francis Dupont committed
102 103
.RE
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
104 105 106 107 108
\-G
.RS 4
Generate a key, but do not publish it or sign with it. This option is incompatible with \-P and \-A.
.RE
.PP
Francis Dupont's avatar
regen  
Francis Dupont committed
109 110 111
\-h
.RS 4
Prints a short summary of the options and arguments to
Automatic Updater's avatar
regen  
Automatic Updater committed
112
\fBdnssec\-keyfromlabel\fR.
Francis Dupont's avatar
regen  
Francis Dupont committed
113 114
.RE
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
115 116 117 118 119
\-K \fIdirectory\fR
.RS 4
Sets the directory in which the key files are to be written.
.RE
.PP
Francis Dupont's avatar
regen  
Francis Dupont committed
120 121 122 123 124
\-k
.RS 4
Generate KEY records rather than DNSKEY records.
.RE
.PP
Automatic Updater's avatar
Automatic Updater committed
125 126 127 128 129 130 131 132 133
\-L \fIttl\fR
.RS 4
Sets the default TTL to use for this key when it is converted into a DNSKEY RR. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence. Setting the default TTL to
0
or
none
removes it.
.RE
.PP
Francis Dupont's avatar
regen  
Francis Dupont committed
134 135
\-p \fIprotocol\fR
.RS 4
Automatic Updater's avatar
regen  
Automatic Updater committed
136
Sets the protocol value for the key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in RFC 2535 and its successors.
Francis Dupont's avatar
regen  
Francis Dupont committed
137 138 139 140 141 142 143 144 145 146 147 148 149
.RE
.PP
\-t \fItype\fR
.RS 4
Indicates the use of the key.
\fBtype\fR
must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data.
.RE
.PP
\-v \fIlevel\fR
.RS 4
Sets the debugging level.
.RE
Automatic Updater's avatar
regen  
Automatic Updater committed
150 151 152 153 154
.PP
\-y
.RS 4
Allows DNSSEC key files to be generated even if the key ID would collide with that of an existing key, in the event of either key being revoked. (This is only safe to use if you are sure you won't be using RFC 5011 trust anchor maintenance with either of the keys involved.)
.RE
Automatic Updater's avatar
regen  
Automatic Updater committed
155 156 157 158 159 160
.SH "TIMING OPTIONS"
.PP
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '\-', it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds.
.PP
\-P \fIdate/offset\fR
.RS 4
Automatic Updater's avatar
regen  
Automatic Updater committed
161
Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it. If not set, and if the \-G option has not been used, the default is "now".
Automatic Updater's avatar
regen  
Automatic Updater committed
162 163 164 165
.RE
.PP
\-A \fIdate/offset\fR
.RS 4
Automatic Updater's avatar
regen  
Automatic Updater committed
166
Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it. If not set, and if the \-G option has not been used, the default is "now".
Automatic Updater's avatar
regen  
Automatic Updater committed
167 168 169 170 171 172 173
.RE
.PP
\-R \fIdate/offset\fR
.RS 4
Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it.
.RE
.PP
Automatic Updater's avatar
Automatic Updater committed
174
\-I \fIdate/offset\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
175
.RS 4
Automatic Updater's avatar
regen  
Automatic Updater committed
176
Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it.
Automatic Updater's avatar
regen  
Automatic Updater committed
177 178 179 180
.RE
.PP
\-D \fIdate/offset\fR
.RS 4
Automatic Updater's avatar
regen  
Automatic Updater committed
181
Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.)
Automatic Updater's avatar
regen  
Automatic Updater committed
182
.RE
Francis Dupont's avatar
regen  
Francis Dupont committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
.SH "GENERATED KEY FILES"
.PP
When
\fBdnssec\-keyfromlabel\fR
completes successfully, it prints a string of the form
\fIKnnnn.+aaa+iiiii\fR
to the standard output. This is an identification string for the key files it has generated.
.TP 4
\(bu
\fInnnn\fR
is the key name.
.TP 4
\(bu
\fIaaa\fR
is the numeric representation of the algorithm.
.TP 4
\(bu
\fIiiiii\fR
is the key identifier (or footprint).
.PP
\fBdnssec\-keyfromlabel\fR
creates two files, with names based on the printed string.
\fIKnnnn.+aaa+iiiii.key\fR
contains the public key, and
\fIKnnnn.+aaa+iiiii.private\fR
contains the private key.
.PP
The
\fI.key\fR
file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement).
.PP
The
\fI.private\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
216
file contains algorithm\-specific fields. For obvious security reasons, this file does not have general read permission.
Francis Dupont's avatar
regen  
Francis Dupont committed
217 218 219 220 221
.SH "SEE ALSO"
.PP
\fBdnssec\-keygen\fR(8),
\fBdnssec\-signzone\fR(8),
BIND 9 Administrator Reference Manual,
Automatic Updater's avatar
regen  
Automatic Updater committed
222
RFC 4034.
Francis Dupont's avatar
regen  
Francis Dupont committed
223 224 225 226
.SH "AUTHOR"
.PP
Internet Systems Consortium
.SH "COPYRIGHT"
Automatic Updater's avatar
Automatic Updater committed
227
Copyright \(co 2008\-2011 Internet Systems Consortium, Inc. ("ISC")
Francis Dupont's avatar
regen  
Francis Dupont committed
228
.br