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

   1 .\" Copyright (C) 2008-2012 Internet Systems Consortium, Inc. ("ISC")
   2 .\"
   3 .\" Permission to use, copy, modify, and/or distribute this software for any
   4 .\" purpose with or without fee is hereby granted, provided that the above
   5 .\" copyright notice and this permission notice appear in all copies.
   6 .\"
   7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   8 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
   9 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  10 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  11 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  12 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  13 .\" PERFORMANCE OF THIS SOFTWARE.
  14 .\"
  15 .\" $Id$
  16 .\"
  17 .hy 0
  18 .ad l
  19 .\"     Title: dnssec\-keyfromlabel
  20 .\"    Author:
  21 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  22 .\"      Date: February 8, 2008
  23 .\"    Manual: BIND9
  24 .\"    Source: BIND9
  25 .\"
  26 .TH "DNSSEC\-KEYFROMLABEL" "8" "February 8, 2008" "BIND9" "BIND9"
  27 .\" disable hyphenation
  28 .nh
  29 .\" disable justification (adjust text to left margin only)
  30 .ad l
  31 .SH "NAME"
  32 dnssec\-keyfromlabel \- DNSSEC key generation tool
  33 .SH "SYNOPSIS"
  34 .HP 20
  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}
  36 .SH "DESCRIPTION"
  37 .PP
  38 \fBdnssec\-keyfromlabel\fR
  39 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.
  40 .PP
  41 The
  42 \fBname\fR
  43 of the key is specified on the command line. This must match the name of the zone for which the key is being generated.
  44 .SH "OPTIONS"
  45 .PP
  46 \-a \fIalgorithm\fR
  47 .RS 4
  48 Selects the cryptographic algorithm. The value of
  49 \fBalgorithm\fR
  50 must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512, ECCGOST, ECDSAP256SHA256 or ECDSAP384SHA384. These values are case insensitive.
  51 .sp
  52 If no algorithm is specified, then RSASHA1 will be used by default, unless the
  53 \fB\-3\fR
  54 option is specified, in which case NSEC3RSASHA1 will be used instead. (If
  55 \fB\-3\fR
  56 is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.)
  57 .sp
  58 Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended.
  59 .sp
  60 Note 2: DH automatically sets the \-k flag.
  61 .RE
  62 .PP
  63 \-3
  64 .RS 4
  65 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.
  66 .RE
  67 .PP
  68 \-E \fIengine\fR
  69 .RS 4
  70 Specifies the name of the crypto hardware (OpenSSL engine). When compiled with PKCS#11 support it defaults to "pkcs11".
  71 .RE
  72 .PP
  73 \-l \fIlabel\fR
  74 .RS 4
  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".
  76 .RE
  77 .PP
  78 \-n \fInametype\fR
  79 .RS 4
  80 Specifies the owner type of the key. The value of
  81 \fBnametype\fR
  82 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.
  83 .RE
  84 .PP
  85 \-C
  86 .RS 4
  87 Compatibility mode: generates an old\-style key, without any metadata. By default,
  88 \fBdnssec\-keyfromlabel\fR
  89 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
  90 \fB\-C\fR
  91 option suppresses them.
  92 .RE
  93 .PP
  94 \-c \fIclass\fR
  95 .RS 4
  96 Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used.
  97 .RE
  98 .PP
  99 \-f \fIflag\fR
 100 .RS 4
 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.
 102 .RE
 103 .PP
 104 \-G
 105 .RS 4
 106 Generate a key, but do not publish it or sign with it. This option is incompatible with \-P and \-A.
 107 .RE
 108 .PP
 109 \-h
 110 .RS 4
 111 Prints a short summary of the options and arguments to
 112 \fBdnssec\-keyfromlabel\fR.
 113 .RE
 114 .PP
 115 \-K \fIdirectory\fR
 116 .RS 4
 117 Sets the directory in which the key files are to be written.
 118 .RE
 119 .PP
 120 \-k
 121 .RS 4
 122 Generate KEY records rather than DNSKEY records.
 123 .RE
 124 .PP
 125 \-L \fIttl\fR
 126 .RS 4
 127 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
 128 0
 129 or
 130 none
 131 removes it.
 132 .RE
 133 .PP
 134 \-p \fIprotocol\fR
 135 .RS 4
 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.
 137 .RE
 138 .PP
 139 \-t \fItype\fR
 140 .RS 4
 141 Indicates the use of the key.
 142 \fBtype\fR
 143 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.
 144 .RE
 145 .PP
 146 \-v \fIlevel\fR
 147 .RS 4
 148 Sets the debugging level.
 149 .RE
 150 .PP
 151 \-y
 152 .RS 4
 153 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.)
 154 .RE
 155 .SH "TIMING OPTIONS"
 156 .PP
 157 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.
 158 .PP
 159 \-P \fIdate/offset\fR
 160 .RS 4
 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".
 162 .RE
 163 .PP
 164 \-A \fIdate/offset\fR
 165 .RS 4
 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".
 167 .RE
 168 .PP
 169 \-R \fIdate/offset\fR
 170 .RS 4
 171 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.
 172 .RE
 173 .PP
 174 \-I \fIdate/offset\fR
 175 .RS 4
 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.
 177 .RE
 178 .PP
 179 \-D \fIdate/offset\fR
 180 .RS 4
 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.)
 182 .RE
 183 .SH "GENERATED KEY FILES"
 184 .PP
 185 When
 186 \fBdnssec\-keyfromlabel\fR
 187 completes successfully, it prints a string of the form
 188 \fIKnnnn.+aaa+iiiii\fR
 189 to the standard output. This is an identification string for the key files it has generated.
 190 .TP 4
 191 \(bu
 192 \fInnnn\fR
 193 is the key name.
 194 .TP 4
 195 \(bu
 196 \fIaaa\fR
 197 is the numeric representation of the algorithm.
 198 .TP 4
 199 \(bu
 200 \fIiiiii\fR
 201 is the key identifier (or footprint).
 202 .PP
 203 \fBdnssec\-keyfromlabel\fR
 204 creates two files, with names based on the printed string.
 205 \fIKnnnn.+aaa+iiiii.key\fR
 206 contains the public key, and
 207 \fIKnnnn.+aaa+iiiii.private\fR
 208 contains the private key.
 209 .PP
 210 The
 211 \fI.key\fR
 212 file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement).
 213 .PP
 214 The
 215 \fI.private\fR
 216 file contains algorithm\-specific fields. For obvious security reasons, this file does not have general read permission.
 217 .SH "SEE ALSO"
 218 .PP
 219 \fBdnssec\-keygen\fR(8),
 220 \fBdnssec\-signzone\fR(8),
 221 BIND 9 Administrator Reference Manual,
 222 RFC 4034.
 223 .SH "AUTHOR"
 224 .PP
 225 Internet Systems Consortium
 226 .SH "COPYRIGHT"
 227 Copyright \(co 2008\-2012 Internet Systems Consortium, Inc. ("ISC")
 228 .br