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

   1 .\" Copyright (C) 2004-2009 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: dnssec-signzone.8,v 1.47.44.8 2009/11/07 01:56:11 tbox Exp $
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\"     Title: dnssec\-signzone
  21 .\"    Author:
  22 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  23 .\"      Date: June 08, 2009
  24 .\"    Manual: BIND9
  25 .\"    Source: BIND9
  26 .\"
  27 .TH "DNSSEC\-SIGNZONE" "8" "June 08, 2009" "BIND9" "BIND9"
  28 .\" disable hyphenation
  29 .nh
  30 .\" disable justification (adjust text to left margin only)
  31 .ad l
  32 .SH "NAME"
  33 dnssec\-signzone \- DNSSEC zone signing tool
  34 .SH "SYNOPSIS"
  35 .HP 16
  36 \fBdnssec\-signzone\fR [\fB\-a\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-d\ \fR\fB\fIdirectory\fR\fR] [\fB\-e\ \fR\fB\fIend\-time\fR\fR] [\fB\-f\ \fR\fB\fIoutput\-file\fR\fR] [\fB\-g\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkey\fR\fR] [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-I\ \fR\fB\fIinput\-format\fR\fR] [\fB\-j\ \fR\fB\fIjitter\fR\fR] [\fB\-N\ \fR\fB\fIsoa\-serial\-format\fR\fR] [\fB\-o\ \fR\fB\fIorigin\fR\fR] [\fB\-O\ \fR\fB\fIoutput\-format\fR\fR] [\fB\-p\fR] [\fB\-P\fR] [\fB\-r\ \fR\fB\fIrandomdev\fR\fR] [\fB\-s\ \fR\fB\fIstart\-time\fR\fR] [\fB\-t\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-z\fR] [\fB\-3\ \fR\fB\fIsalt\fR\fR] [\fB\-H\ \fR\fB\fIiterations\fR\fR] [\fB\-A\fR] {zonefile} [key...]
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBdnssec\-signzone\fR
  40 signs a zone. It generates NSEC and RRSIG records and produces a signed version of the zone. It also generates a
  41 \fIkeyset\-\fR
  42 file containing the key\-signing keys for the zone, and if signing a zone which contains delegations, it can optionally generate DS records for the child zones from their
  43 \fIkeyset\-\fR
  44 files.
  45 .SH "OPTIONS"
  46 .PP
  47 \-a
  48 .RS 4
  49 Verify all generated signatures.
  50 .RE
  51 .PP
  52 \-c \fIclass\fR
  53 .RS 4
  54 Specifies the DNS class of the zone.
  55 .RE
  56 .PP
  57 \-k \fIkey\fR
  58 .RS 4
  59 Treat specified key as a key signing key ignoring any key flags. This option may be specified multiple times.
  60 .RE
  61 .PP
  62 \-l \fIdomain\fR
  63 .RS 4
  64 Generate a DLV set in addition to the key (DNSKEY) and DS sets. The domain is appended to the name of the records.
  65 .RE
  66 .PP
  67 \-d \fIdirectory\fR
  68 .RS 4
  69 Look for
  70 \fIkeyset\fR
  71 files in
  72 \fBdirectory\fR
  73 as the directory
  74 .RE
  75 .PP
  76 \-g
  77 .RS 4
  78 If the zone contains any delegations, and there are
  79 \fIkeyset\-\fR
  80 files for any of the child zones, then DS records for the child zones will be generated from the keys in those files. Existing DS records will be removed.
  81 .RE
  82 .PP
  83 \-s \fIstart\-time\fR
  84 .RS 4
  85 Specify the date and time when the generated RRSIG records become valid. This can be either an absolute or relative time. An absolute start time is indicated by a number in YYYYMMDDHHMMSS notation; 20000530144500 denotes 14:45:00 UTC on May 30th, 2000. A relative start time is indicated by +N, which is N seconds from the current time. If no
  86 \fBstart\-time\fR
  87 is specified, the current time minus 1 hour (to allow for clock skew) is used.
  88 .RE
  89 .PP
  90 \-e \fIend\-time\fR
  91 .RS 4
  92 Specify the date and time when the generated RRSIG records expire. As with
  93 \fBstart\-time\fR, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative to the start time is indicated with +N, which is N seconds from the start time. A time relative to the current time is indicated with now+N. If no
  94 \fBend\-time\fR
  95 is specified, 30 days from the start time is used as a default.
  96 .RE
  97 .PP
  98 \-f \fIoutput\-file\fR
  99 .RS 4
 100 The name of the output file containing the signed zone. The default is to append
 101 \fI.signed\fR
 102 to the input filename.
 103 .RE
 104 .PP
 105 \-h
 106 .RS 4
 107 Prints a short summary of the options and arguments to
 108 \fBdnssec\-signzone\fR.
 109 .RE
 110 .PP
 111 \-i \fIinterval\fR
 112 .RS 4
 113 When a previously\-signed zone is passed as input, records may be resigned. The
 114 \fBinterval\fR
 115 option specifies the cycle interval as an offset from the current time (in seconds). If a RRSIG record expires after the cycle interval, it is retained. Otherwise, it is considered to be expiring soon, and it will be replaced.
 116 .sp
 117 The default cycle interval is one quarter of the difference between the signature end and start times. So if neither
 118 \fBend\-time\fR
 119 or
 120 \fBstart\-time\fR
 121 are specified,
 122 \fBdnssec\-signzone\fR
 123 generates signatures that are valid for 30 days, with a cycle interval of 7.5 days. Therefore, if any existing RRSIG records are due to expire in less than 7.5 days, they would be replaced.
 124 .RE
 125 .PP
 126 \-I \fIinput\-format\fR
 127 .RS 4
 128 The format of the input zone file. Possible formats are
 129 \fB"text"\fR
 130 (default) and
 131 \fB"raw"\fR. This option is primarily intended to be used for dynamic signed zones so that the dumped zone file in a non\-text format containing updates can be signed directly. The use of this option does not make much sense for non\-dynamic zones.
 132 .RE
 133 .PP
 134 \-j \fIjitter\fR
 135 .RS 4
 136 When signing a zone with a fixed signature lifetime, all RRSIG records issued at the time of signing expires simultaneously. If the zone is incrementally signed, i.e. a previously\-signed zone is passed as input to the signer, all expired signatures have to be regenerated at about the same time. The
 137 \fBjitter\fR
 138 option specifies a jitter window that will be used to randomize the signature expire time, thus spreading incremental signature regeneration over time.
 139 .sp
 140 Signature lifetime jitter also to some extent benefits validators and servers by spreading out cache expiration, i.e. if large numbers of RRSIGs don't expire at the same time from all caches there will be less congestion than if all validators need to refetch at mostly the same time.
 141 .RE
 142 .PP
 143 \-n \fIncpus\fR
 144 .RS 4
 145 Specifies the number of threads to use. By default, one thread is started for each detected CPU.
 146 .RE
 147 .PP
 148 \-N \fIsoa\-serial\-format\fR
 149 .RS 4
 150 The SOA serial number format of the signed zone. Possible formats are
 151 \fB"keep"\fR
 152 (default),
 153 \fB"increment"\fR
 154 and
 155 \fB"unixtime"\fR.
 156 .RS 4
 157 .PP
 158 \fB"keep"\fR
 159 .RS 4
 160 Do not modify the SOA serial number.
 161 .RE
 162 .PP
 163 \fB"increment"\fR
 164 .RS 4
 165 Increment the SOA serial number using RFC 1982 arithmetics.
 166 .RE
 167 .PP
 168 \fB"unixtime"\fR
 169 .RS 4
 170 Set the SOA serial number to the number of seconds since epoch.
 171 .RE
 172 .RE
 173 .RE
 174 .PP
 175 \-o \fIorigin\fR
 176 .RS 4
 177 The zone origin. If not specified, the name of the zone file is assumed to be the origin.
 178 .RE
 179 .PP
 180 \-O \fIoutput\-format\fR
 181 .RS 4
 182 The format of the output file containing the signed zone. Possible formats are
 183 \fB"text"\fR
 184 (default) and
 185 \fB"raw"\fR.
 186 .RE
 187 .PP
 188 \-p
 189 .RS 4
 190 Use pseudo\-random data when signing the zone. This is faster, but less secure, than using real random data. This option may be useful when signing large zones or when the entropy source is limited.
 191 .RE
 192 .PP
 193 \-P
 194 .RS 4
 195 Disable post sign verification tests.
 196 .sp
 197 The post sign verification test ensures that for each algorithm in use there is at least one non revoked self signed KSK key, that all revoked KSK keys are self signed, and that all records in the zone are signed by the algorithm. This option skips these tests.
 198 .RE
 199 .PP
 200 \-r \fIrandomdev\fR
 201 .RS 4
 202 Specifies the source of randomness. If the operating system does not provide a
 203 \fI/dev/random\fR
 204 or equivalent device, the default source of randomness is keyboard input.
 205 \fIrandomdev\fR
 206 specifies the name of a character device or file containing random data to be used instead of the default. The special value
 207 \fIkeyboard\fR
 208 indicates that keyboard input should be used.
 209 .RE
 210 .PP
 211 \-t
 212 .RS 4
 213 Print statistics at completion.
 214 .RE
 215 .PP
 216 \-v \fIlevel\fR
 217 .RS 4
 218 Sets the debugging level.
 219 .RE
 220 .PP
 221 \-z
 222 .RS 4
 223 Ignore KSK flag on key when determining what to sign.
 224 .RE
 225 .PP
 226 \-3 \fIsalt\fR
 227 .RS 4
 228 Generate a NSEC3 chain with the given hex encoded salt. A dash (\fIsalt\fR) can be used to indicate that no salt is to be used when generating the NSEC3 chain.
 229 .RE
 230 .PP
 231 \-H \fIiterations\fR
 232 .RS 4
 233 When generating a NSEC3 chain use this many interations. The default is 100.
 234 .RE
 235 .PP
 236 \-A
 237 .RS 4
 238 When generating a NSEC3 chain set the OPTOUT flag on all NSEC3 records and do not generate NSEC3 records for insecure delegations.
 239 .RE
 240 .PP
 241 zonefile
 242 .RS 4
 243 The file containing the zone to be signed.
 244 .RE
 245 .PP
 246 key
 247 .RS 4
 248 Specify which keys should be used to sign the zone. If no keys are specified, then the zone will be examined for DNSKEY records at the zone apex. If these are found and there are matching private keys, in the current directory, then these will be used for signing.
 249 .RE
 250 .SH "EXAMPLE"
 251 .PP
 252 The following command signs the
 253 \fBexample.com\fR
 254 zone with the DSA key generated by
 255 \fBdnssec\-keygen\fR
 256 (Kexample.com.+003+17247). The zone's keys must be in the master file (\fIdb.example.com\fR). This invocation looks for
 257 \fIkeyset\fR
 258 files, in the current directory, so that DS records can be generated from them (\fB\-g\fR).
 259 .sp
 260 .RS 4
 261 .nf
 262 % dnssec\-signzone \-g \-o example.com db.example.com \\
 263 Kexample.com.+003+17247
 264 db.example.com.signed
 265 %
 266 .fi
 267 .RE
 268 .PP
 269 In the above example,
 270 \fBdnssec\-signzone\fR
 271 creates the file
 272 \fIdb.example.com.signed\fR. This file should be referenced in a zone statement in a
 273 \fInamed.conf\fR
 274 file.
 275 .PP
 276 This example re\-signs a previously signed zone with default parameters. The private keys are assumed to be in the current directory.
 277 .sp
 278 .RS 4
 279 .nf
 280 % cp db.example.com.signed db.example.com
 281 % dnssec\-signzone \-o example.com db.example.com
 282 db.example.com.signed
 283 %
 284 .fi
 285 .RE
 286 .SH "KNOWN BUGS"
 287 .PP
 288 \fBdnssec\-signzone\fR
 289 was designed so that it could sign a zone partially, using only a subset of the DNSSEC keys needed to produce a fully\-signed zone. This permits a zone administrator, for example, to sign a zone with one key on one machine, move the resulting partially\-signed zone to a second machine, and sign it again with a second key.
 290 .PP
 291 An unfortunate side\-effect of this flexibility is that
 292 \fBdnssec\-signzone\fR
 293 does not check to make sure it's signing a zone with any valid keys at all. An attempt to sign a zone without any keys will appear to succeed, producing a "signed" zone with no signatures. There is no warning issued when a zone is not fully signed.
 294 .PP
 295 This will be corrected in a future release. In the meantime, ISC recommends examining the output of
 296 \fBdnssec\-signzone\fR
 297 to confirm that the zone is properly signed by all keys before using it.
 298 .SH "SEE ALSO"
 299 .PP
 300 \fBdnssec\-keygen\fR(8),
 301 BIND 9 Administrator Reference Manual,
 302 RFC 4033.
 303 .SH "AUTHOR"
 304 .PP
 305 Internet Systems Consortium
 306 .SH "COPYRIGHT"
 307 Copyright \(co 2004\-2009 Internet Systems Consortium, Inc. ("ISC")
 308 .br
 309 Copyright \(co 2000\-2003 Internet Software Consortium.
 310 .br