contrib/bind9/bin/dnssec/dnssec-keygen.8

   1 .\" Copyright (C) 2004, 2005, 2007-2010, 2012 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000-2003 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and/or distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14 .\" PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $Id$
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\"     Title: dnssec\-keygen
  21 .\"    Author:
  22 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  23 .\"      Date: June 30, 2000
  24 .\"    Manual: BIND9
  25 .\"    Source: BIND9
  26 .\"
  27 .TH "DNSSEC\-KEYGEN" "8" "June 30, 2000" "BIND9" "BIND9"
  28 .\" disable hyphenation
  29 .nh
  30 .\" disable justification (adjust text to left margin only)
  31 .ad l
  32 .SH "NAME"
  33 dnssec\-keygen \- DNSSEC key generation tool
  34 .SH "SYNOPSIS"
  35 .HP 14
  36 \fBdnssec\-keygen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-n\ \fR\fB\fInametype\fR\fR] [\fB\-3\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-C\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-e\fR] [\fB\-f\ \fR\fB\fIflag\fR\fR] [\fB\-G\fR] [\fB\-g\ \fR\fB\fIgenerator\fR\fR] [\fB\-h\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-k\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-p\ \fR\fB\fIprotocol\fR\fR] [\fB\-q\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] [\fB\-S\ \fR\fB\fIkey\fR\fR] [\fB\-s\ \fR\fB\fIstrength\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-z\fR] {name}
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBdnssec\-keygen\fR
  40 generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034. It can also generate keys for use with TSIG (Transaction Signatures) as defined in RFC 2845, or TKEY (Transaction Key) as defined in RFC 2930.
  41 .PP
  42 The
  43 \fBname\fR
  44 of the key is specified on the command line. For DNSSEC keys, this must match the name of the zone for which the key is being generated.
  45 .SH "OPTIONS"
  46 .PP
  47 \-a \fIalgorithm\fR
  48 .RS 4
  49 Selects the cryptographic algorithm. For DNSSEC keys, the value of
  50 \fBalgorithm\fR
  51 must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384. For TSIG/TKEY, the value must be DH (Diffie Hellman), HMAC\-MD5, HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256, HMAC\-SHA384, or HMAC\-SHA512. These values are case insensitive.
  52 .sp
  53 If no algorithm is specified, then RSASHA1 will be used by default, unless the
  54 \fB\-3\fR
  55 option is specified, in which case NSEC3RSASHA1 will be used instead. (If
  56 \fB\-3\fR
  57 is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.)
  58 .sp
  59 Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended. For TSIG, HMAC\-MD5 is mandatory.
  60 .sp
  61 Note 2: DH, HMAC\-MD5, and HMAC\-SHA1 through HMAC\-SHA512 automatically set the \-T KEY option.
  62 .RE
  63 .PP
  64 \-b \fIkeysize\fR
  65 .RS 4
  66 Specifies the number of bits in the key. The choice of key size depends on the algorithm used. RSA keys must be between 512 and 2048 bits. Diffie Hellman keys must be between 128 and 4096 bits. DSA keys must be between 512 and 1024 bits and an exact multiple of 64. HMAC keys must be between 1 and 512 bits. Elliptic curve algorithms don't need this parameter.
  67 .sp
  68 The key size does not need to be specified if using a default algorithm. The default key size is 1024 bits for zone signing keys (ZSK's) and 2048 bits for key signing keys (KSK's, generated with
  69 \fB\-f KSK\fR). However, if an algorithm is explicitly specified with the
  70 \fB\-a\fR, then there is no default key size, and the
  71 \fB\-b\fR
  72 must be used.
  73 .RE
  74 .PP
  75 \-n \fInametype\fR
  76 .RS 4
  77 Specifies the owner type of the key. The value of
  78 \fBnametype\fR
  79 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. Defaults to ZONE for DNSKEY generation.
  80 .RE
  81 .PP
  82 \-3
  83 .RS 4
  84 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. Note that RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 and ECDSAP384SHA384 algorithms are NSEC3\-capable.
  85 .RE
  86 .PP
  87 \-C
  88 .RS 4
  89 Compatibility mode: generates an old\-style key, without any metadata. By default,
  90 \fBdnssec\-keygen\fR
  91 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
  92 \fB\-C\fR
  93 option suppresses them.
  94 .RE
  95 .PP
  96 \-c \fIclass\fR
  97 .RS 4
  98 Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used.
  99 .RE
 100 .PP
 101 \-E \fIengine\fR
 102 .RS 4
 103 Uses a crypto hardware (OpenSSL engine) for random number and, when supported, key generation. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine.
 104 .RE
 105 .PP
 106 \-e
 107 .RS 4
 108 If generating an RSAMD5/RSASHA1 key, use a large exponent.
 109 .RE
 110 .PP
 111 \-f \fIflag\fR
 112 .RS 4
 113 Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key Signing Key) and REVOKE.
 114 .RE
 115 .PP
 116 \-G
 117 .RS 4
 118 Generate a key, but do not publish it or sign with it. This option is incompatible with \-P and \-A.
 119 .RE
 120 .PP
 121 \-g \fIgenerator\fR
 122 .RS 4
 123 If generating a Diffie Hellman key, use this generator. Allowed values are 2 and 5. If no generator is specified, a known prime from RFC 2539 will be used if possible; otherwise the default is 2.
 124 .RE
 125 .PP
 126 \-h
 127 .RS 4
 128 Prints a short summary of the options and arguments to
 129 \fBdnssec\-keygen\fR.
 130 .RE
 131 .PP
 132 \-K \fIdirectory\fR
 133 .RS 4
 134 Sets the directory in which the key files are to be written.
 135 .RE
 136 .PP
 137 \-k
 138 .RS 4
 139 Deprecated in favor of \-T KEY.
 140 .RE
 141 .PP
 142 \-p \fIprotocol\fR
 143 .RS 4
 144 Sets the protocol value for the generated 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.
 145 .RE
 146 .PP
 147 \-q
 148 .RS 4
 149 Quiet mode: Suppresses unnecessary output, including progress indication. Without this option, when
 150 \fBdnssec\-keygen\fR
 151 is run interactively to generate an RSA or DSA key pair, it will print a string of symbols to
 152 \fIstderr\fR
 153 indicating the progress of the key generation. A '.' indicates that a random number has been found which passed an initial sieve test; '+' means a number has passed a single round of the Miller\-Rabin primality test; a space means that the number has passed all the tests and is a satisfactory key.
 154 .RE
 155 .PP
 156 \-r \fIrandomdev\fR
 157 .RS 4
 158 Specifies the source of randomness. If the operating system does not provide a
 159 \fI/dev/random\fR
 160 or equivalent device, the default source of randomness is keyboard input.
 161 \fIrandomdev\fR
 162 specifies the name of a character device or file containing random data to be used instead of the default. The special value
 163 \fIkeyboard\fR
 164 indicates that keyboard input should be used.
 165 .RE
 166 .PP
 167 \-S \fIkey\fR
 168 .RS 4
 169 Create a new key which is an explicit successor to an existing key. The name, algorithm, size, and type of the key will be set to match the existing key. The activation date of the new key will be set to the inactivation date of the existing one. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days.
 170 .RE
 171 .PP
 172 \-s \fIstrength\fR
 173 .RS 4
 174 Specifies the strength value of the key. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC.
 175 .RE
 176 .PP
 177 \-T \fIrrtype\fR
 178 .RS 4
 179 Specifies the resource record type to use for the key.
 180 \fBrrtype\fR
 181 must be either DNSKEY or KEY. The default is DNSKEY when using a DNSSEC algorithm, but it can be overridden to KEY for use with SIG(0).
 182 Using any TSIG algorithm (HMAC\-* or DH) forces this option to KEY.
 183 .RE
 184 .PP
 185 \-t \fItype\fR
 186 .RS 4
 187 Indicates the use of the key.
 188 \fBtype\fR
 189 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.
 190 .RE
 191 .PP
 192 \-v \fIlevel\fR
 193 .RS 4
 194 Sets the debugging level.
 195 .RE
 196 .SH "TIMING OPTIONS"
 197 .PP
 198 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.
 199 .PP
 200 \-P \fIdate/offset\fR
 201 .RS 4
 202 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".
 203 .RE
 204 .PP
 205 \-A \fIdate/offset\fR
 206 .RS 4
 207 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".
 208 .RE
 209 .PP
 210 \-R \fIdate/offset\fR
 211 .RS 4
 212 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.
 213 .RE
 214 .PP
 215 \-I \fIdate/offset\fR
 216 .RS 4
 217 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.
 218 .RE
 219 .PP
 220 \-D \fIdate/offset\fR
 221 .RS 4
 222 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.)
 223 .RE
 224 .PP
 225 \-i \fIinterval\fR
 226 .RS 4
 227 Sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the publication date isn't, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn't, then activation will be set to this much time after publication.
 228 .sp
 229 If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero.
 230 .sp
 231 As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.
 232 .RE
 233 .SH "GENERATED KEYS"
 234 .PP
 235 When
 236 \fBdnssec\-keygen\fR
 237 completes successfully, it prints a string of the form
 238 \fIKnnnn.+aaa+iiiii\fR
 239 to the standard output. This is an identification string for the key it has generated.
 240 .TP 4
 241 \(bu
 242 \fInnnn\fR
 243 is the key name.
 244 .TP 4
 245 \(bu
 246 \fIaaa\fR
 247 is the numeric representation of the algorithm.
 248 .TP 4
 249 \(bu
 250 \fIiiiii\fR
 251 is the key identifier (or footprint).
 252 .PP
 253 \fBdnssec\-keygen\fR
 254 creates two files, with names based on the printed string.
 255 \fIKnnnn.+aaa+iiiii.key\fR
 256 contains the public key, and
 257 \fIKnnnn.+aaa+iiiii.private\fR
 258 contains the private key.
 259 .PP
 260 The
 261 \fI.key\fR
 262 file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement).
 263 .PP
 264 The
 265 \fI.private\fR
 266 file contains algorithm\-specific fields. For obvious security reasons, this file does not have general read permission.
 267 .PP
 268 Both
 269 \fI.key\fR
 270 and
 271 \fI.private\fR
 272 files are generated for symmetric encryption algorithms such as HMAC\-MD5, even though the public and private key are equivalent.
 273 .SH "EXAMPLE"
 274 .PP
 275 To generate a 768\-bit DSA key for the domain
 276 \fBexample.com\fR, the following command would be issued:
 277 .PP
 278 \fBdnssec\-keygen \-a DSA \-b 768 \-n ZONE example.com\fR
 279 .PP
 280 The command would print a string of the form:
 281 .PP
 282 \fBKexample.com.+003+26160\fR
 283 .PP
 284 In this example,
 285 \fBdnssec\-keygen\fR
 286 creates the files
 287 \fIKexample.com.+003+26160.key\fR
 288 and
 289 \fIKexample.com.+003+26160.private\fR.
 290 .SH "SEE ALSO"
 291 .PP
 292 \fBdnssec\-signzone\fR(8),
 293 BIND 9 Administrator Reference Manual,
 294 RFC 2539,
 295 RFC 2845,
 296 RFC 4034.
 297 .SH "AUTHOR"
 298 .PP
 299 Internet Systems Consortium
 300 .SH "COPYRIGHT"
 301 Copyright \(co 2004, 2005, 2007\-2010, 2012 Internet Systems Consortium, Inc. ("ISC")
 302 .br
 303 Copyright \(co 2000\-2003 Internet Software Consortium.
 304 .br