components/bind/Solaris/dnssec-signzone.8
changeset 6227 a498cb624014
parent 6226 cebcbbd80341
child 6228 37f9819bc49d
equal deleted inserted replaced
6226:cebcbbd80341 6227:a498cb624014
     1 '\" te
       
     2 .\" Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
       
     3 .\" Permission to use, copy, modify, and/or distribute this software for any 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.
       
     4 .\" Portions Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved.
       
     5 .TH dnssec-signzone 8 "19 Oct 2015" "SunOS 5.12" "System Administration Commands"
       
     6 .SH NAME
       
     7 dnssec-signzone \- DNSSEC zone signing tool
       
     8 .SH SYNOPSIS
       
     9 .LP
       
    10 .nf
       
    11 \fBdnssec-signzone\fR [\fB-Aaghptz\fR] [\fB-c\fR \fIclass\fR] [\fB-d\fR \fIdirectory\fR] 
       
    12      [\fB-e\fR \fIend-time\fR] [\fB-f\fR \fIoutput-file\fR] [\fB-H\fR \fIiterations\fR] [\fB-I\fR \fIinput_format\fR]
       
    13      [\fB-i\fR \fIinterval\fR] [\fB-k\fR \fIkey\fR] [\fB-l\fR \fIdomain\fR] [\fB-N\fR \fIsoa-serial-format\fR] [\fB-n\fR \fIncpus\fR]
       
    14      [\fB-O\fR \fIoutput_format\fR] [\fB-o\fR \fIorigin\fR] [\fB-r\fR \fIrandomdev\fR] [\fB-s\fR \fIstart-time\fR]
       
    15      [\fB-v\fR \fIlevel\fR] [\fB-3\fR \fIsalt\fR] \fIzonefile\fR [\fIkey\fR]...
       
    16 .fi
       
    17 
       
    18 .SH DESCRIPTION
       
    19 .sp
       
    20 .LP
       
    21 The \fBdnssec-signzone\fR utility signs a zone. It generates \fBNSEC\fR and \fBRRSIG\fR records and produces a signed version of the zone. The security status of delegations from the signed zone (that is, whether the child zones are secure or not) is determined by the presence or absence of a \fBkeyset\fR file for each child zone.
       
    22 .SH OPTIONS
       
    23 .sp
       
    24 .LP
       
    25 The following options are supported:
       
    26 .sp
       
    27 .ne 2
       
    28 .mk
       
    29 .na
       
    30 \fB\fB-A\fR\fR
       
    31 .ad
       
    32 .sp .6
       
    33 .RS 4n
       
    34 When generating an NSEC3 chain, set the \fBOPTOUT\fR flag on all NSEC3 records and do not generate NSEC3 records for insecure delegations.
       
    35 .RE
       
    36 
       
    37 .sp
       
    38 .ne 2
       
    39 .mk
       
    40 .na
       
    41 \fB\fB-a\fR\fR
       
    42 .ad
       
    43 .sp .6
       
    44 .RS 4n
       
    45 Verify all generated signatures.
       
    46 .RE
       
    47 
       
    48 .sp
       
    49 .ne 2
       
    50 .mk
       
    51 .na
       
    52 \fB\fB-c\fR \fIclass\fR\fR
       
    53 .ad
       
    54 .sp .6
       
    55 .RS 4n
       
    56 Specify the \fBDNS\fR class of the zone.
       
    57 .RE
       
    58 
       
    59 .sp
       
    60 .ne 2
       
    61 .mk
       
    62 .na
       
    63 \fB\fB-d\fR \fIdirectory\fR\fR
       
    64 .ad
       
    65 .sp .6
       
    66 .RS 4n
       
    67 Look for \fBkeyset\fR files in \fIdirectory\fR.
       
    68 .RE
       
    69 
       
    70 .sp
       
    71 .ne 2
       
    72 .mk
       
    73 .na
       
    74 \fB\fB-e\fR \fIend-time\fR\fR
       
    75 .ad
       
    76 .sp .6
       
    77 .RS 4n
       
    78 Specify the date and time when the generated \fBRRSIG\fR records expire. As with \fBstart-time\fR, an absolute time is indicated in \fBYYYYMMDDHHMMSS\fR notation. A time relative to the start time is indicated with +\fIN\fR, which is \fIN\fR seconds from the start time. A time relative to the current time is indicated with \fBnow\fR+\fIN\fR. If no \fIend-time\fR is specified, 30 days from the start time is used as a default.
       
    79 .RE
       
    80 
       
    81 .sp
       
    82 .ne 2
       
    83 .mk
       
    84 .na
       
    85 \fB\fB-f\fR \fIoutput-file\fR\fR
       
    86 .ad
       
    87 .sp .6
       
    88 .RS 4n
       
    89 The name of the output file containing the signed zone. The default is to append \fB\&.signed\fR to the input file name.
       
    90 .RE
       
    91 
       
    92 .sp
       
    93 .ne 2
       
    94 .mk
       
    95 .na
       
    96 \fB\fB-g\fR\fR
       
    97 .ad
       
    98 .sp .6
       
    99 .RS 4n
       
   100 Generate DS records for child zones from \fBkeyset\fR files. Existing DS records will be removed.
       
   101 .RE
       
   102 
       
   103 .sp
       
   104 .ne 2
       
   105 .mk
       
   106 .na
       
   107 \fB\fB-H\fR \fIiterations\fR\fR
       
   108 .ad
       
   109 .sp .6
       
   110 .RS 4n
       
   111 When generating a NSEC3 chain use the number of interations specified by \fIiterations\fR. The default is 100.
       
   112 .RE
       
   113 
       
   114 .sp
       
   115 .ne 2
       
   116 .mk
       
   117 .na
       
   118 \fB\fB-h\fR\fR
       
   119 .ad
       
   120 .sp .6
       
   121 .RS 4n
       
   122 Prints a short summary of the options and arguments to \fBdnssec-signzone()\fR.
       
   123 .RE
       
   124 
       
   125 .sp
       
   126 .ne 2
       
   127 .mk
       
   128 .na
       
   129 \fB\fB-I\fR \fIinput-format\fR\fR
       
   130 .ad
       
   131 .sp .6
       
   132 .RS 4n
       
   133 The format of the input zone file. Possible formats are \fBtext\fR (default) and \fBraw\fR. This option is primarily intended 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 serves no purpose for non-dynamic zones.
       
   134 .RE
       
   135 
       
   136 .sp
       
   137 .ne 2
       
   138 .mk
       
   139 .na
       
   140 \fB\fB-i\fR \fIinterval\fR\fR
       
   141 .ad
       
   142 .sp .6
       
   143 .RS 4n
       
   144 Specify the cycle interval as an offset from the current time (in seconds). When a previously signed zone is passed as input, records could be resigned. If an \fBRRSIG\fR record expires after the cycle interval, it is retained. Otherwise, it is considered to be expiring soon and will be replaced.
       
   145 .sp
       
   146 The default cycle interval is one quarter of the difference between the signature end and start times. If neither \fIend-time\fR or \fIstart-time\fR are specified, \fBdnssec-signzone\fR generates signatures that are valid for 30 days, with a cycle interval of 7.5 days. Any existing \fBRRSIG\fR records due to expire in less than 7.5 days would be replaced.
       
   147 .RE
       
   148 
       
   149 .sp
       
   150 .ne 2
       
   151 .mk
       
   152 .na
       
   153 \fB\fB-j\fR \fIjitter\fR\fR
       
   154 .ad
       
   155 .sp .6
       
   156 .RS 4n
       
   157 When signing a zone with a fixed signature lifetime, all \fBRRSIG\fR records issued at the time of signing expire simultaneously. If the zone is incrementally signed, that is, a previously-signed zone is passed as input to the signer, all expired signatures have to be regenerated at about the same time. The jitter option specifies a jitter window that will be used to randomize the signature-expire time, thus spreading incremental  signature regeneration over time.
       
   158 .sp
       
   159 Signature lifetime jitter also benefits, to some extent, validators and servers by spreading out cache expiration. That is, if large numbers of \fBRRSIG\fRs from all caches do not expire at the same time, there will be less congestion than if all validators needed to refetch at almost the same time.
       
   160 .RE
       
   161 
       
   162 .sp
       
   163 .ne 2
       
   164 .mk
       
   165 .na
       
   166 \fB\fB-k\fR \fIkey\fR\fR
       
   167 .ad
       
   168 .sp .6
       
   169 .RS 4n
       
   170 Treat specified \fIkey\fR as a key-signing key, ignoring any key flags. This option can be specified multiple times.
       
   171 .RE
       
   172 
       
   173 .sp
       
   174 .ne 2
       
   175 .mk
       
   176 .na
       
   177 \fB\fB-l\fR \fIdomain\fR\fR
       
   178 .ad
       
   179 .sp .6
       
   180 .RS 4n
       
   181 Generate a DLV set in addition to the key (DNSKEY) and DS sets. The domain is appended to the name of the records.
       
   182 .RE
       
   183 
       
   184 .sp
       
   185 .ne 2
       
   186 .mk
       
   187 .na
       
   188 \fB\fB-N\fR \fIsoa-serial-format\fR\fR
       
   189 .ad
       
   190 .sp .6
       
   191 .RS 4n
       
   192 The SOA serial number format of the signed zone. Possible formats are \fBkeep\fR (default), \fBincrement\fR and \fBunixtime\fR, described as follows.
       
   193 .sp
       
   194 .ne 2
       
   195 .mk
       
   196 .na
       
   197 \fB\fBkeep\fR\fR
       
   198 .ad
       
   199 .sp .6
       
   200 .RS 4n
       
   201 Do not modify the SOA serial number.
       
   202 .RE
       
   203 
       
   204 .sp
       
   205 .ne 2
       
   206 .mk
       
   207 .na
       
   208 \fB\fBincrement\fR\fR
       
   209 .ad
       
   210 .sp .6
       
   211 .RS 4n
       
   212 Increment the SOA serial number using RFC 1982 arithmetic.
       
   213 .RE
       
   214 
       
   215 .sp
       
   216 .ne 2
       
   217 .mk
       
   218 .na
       
   219 \fB\fBunixtime\fR\fR
       
   220 .ad
       
   221 .sp .6
       
   222 .RS 4n
       
   223 Set the SOA serial number to the number of seconds since epoch.
       
   224 .RE
       
   225 
       
   226 .RE
       
   227 
       
   228 .sp
       
   229 .ne 2
       
   230 .mk
       
   231 .na
       
   232 \fB\fB-n\fR \fInthreads\fR\fR
       
   233 .ad
       
   234 .sp .6
       
   235 .RS 4n
       
   236 Specifies the number of threads to use. By default, one thread is started for each detected CPU.
       
   237 .RE
       
   238 
       
   239 .sp
       
   240 .ne 2
       
   241 .mk
       
   242 .na
       
   243 \fB\fB-O\fR \fIoutput_format\fR\fR
       
   244 .ad
       
   245 .sp .6
       
   246 .RS 4n
       
   247 The format of the output file containing the signed zone. Possible formats are \fBtext\fR (default) and \fBraw\fR.
       
   248 .RE
       
   249 
       
   250 .sp
       
   251 .ne 2
       
   252 .mk
       
   253 .na
       
   254 \fB\fB-o\fR \fIorigin\fR\fR
       
   255 .ad
       
   256 .sp .6
       
   257 .RS 4n
       
   258 Specify the zone origin. If not specified, the name of the zone file is assumed to be the origin.
       
   259 .RE
       
   260 
       
   261 .sp
       
   262 .ne 2
       
   263 .mk
       
   264 .na
       
   265 \fB\fB-p\fR\fR
       
   266 .ad
       
   267 .sp .6
       
   268 .RS 4n
       
   269 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.
       
   270 .RE
       
   271 
       
   272 .sp
       
   273 .ne 2
       
   274 .mk
       
   275 .na
       
   276 \fB\fB-r\fR \fIrandomdev\fR\fR
       
   277 .ad
       
   278 .sp .6
       
   279 .RS 4n
       
   280 Specifies the source of randomness. If the operating system does not provide a \fB/dev/random\fR or equivalent device, the default source of randomness is keyboard input. \fIrandomdev\fR specifies the name of a character device or file containing random data to be used instead of the default \fB/dev/random\fR. The special value \fBkeyboard\fR indicates that keyboard input should be used.
       
   281 .RE
       
   282 
       
   283 .sp
       
   284 .ne 2
       
   285 .mk
       
   286 .na
       
   287 \fB\fB-s\fR \fIstart-time\fR\fR
       
   288 .ad
       
   289 .sp .6
       
   290 .RS 4n
       
   291 Specify the date and time when the generated \fBRRSIG\fR records become valid. This can be either an absolute or relative time. An absolute start time is indicated by a number in \fIYYYYMMDDHHMMSS\fR notation; 20000530144500 denotes 14:45:00 UTC on May 30th, 2000. A relative start time is indicated by +\fIN\fR, which is \fIN\fR seconds from the current time. If no \fIstart-time\fR is specified, the current time minus one hour (to allow for clock skew) is used.
       
   292 .RE
       
   293 
       
   294 .sp
       
   295 .ne 2
       
   296 .mk
       
   297 .na
       
   298 \fB\fB-t\fR\fR
       
   299 .ad
       
   300 .sp .6
       
   301 .RS 4n
       
   302 Print statistics at completion.
       
   303 .RE
       
   304 
       
   305 .sp
       
   306 .ne 2
       
   307 .mk
       
   308 .na
       
   309 \fB\fB-v\fR \fIlevel\fR\fR
       
   310 .ad
       
   311 .sp .6
       
   312 .RS 4n
       
   313 Set the debugging level.
       
   314 .RE
       
   315 
       
   316 .sp
       
   317 .ne 2
       
   318 .mk
       
   319 .na
       
   320 \fB\fB-z\fR\fR
       
   321 .ad
       
   322 .sp .6
       
   323 .RS 4n
       
   324 Ignore KSK flag on key when determining what to sign.
       
   325 .RE
       
   326 
       
   327 .sp
       
   328 .ne 2
       
   329 .mk
       
   330 .na
       
   331 \fB\fB-3\fR \fIsalt\fR\fR
       
   332 .ad
       
   333 .sp .6
       
   334 .RS 4n
       
   335 Generate a NSEC3 chain with the specified hex-encoded \fIsalt\fR. A dash (\fB-\fR) can be used to indicate that no salt is to be used when generating the NSEC3 chain.
       
   336 .RE
       
   337 
       
   338 .SH OPERANDS
       
   339 .sp
       
   340 .LP
       
   341 The following operands are supported:
       
   342 .sp
       
   343 .ne 2
       
   344 .mk
       
   345 .na
       
   346 \fB\fIzonefile\fR\fR
       
   347 .ad
       
   348 .sp .6
       
   349 .RS 4n
       
   350 The file containing the zone to be signed.
       
   351 .RE
       
   352 
       
   353 .sp
       
   354 .ne 2
       
   355 .mk
       
   356 .na
       
   357 \fB\fIkey\fR\fR
       
   358 .ad
       
   359 .sp .6
       
   360 .RS 4n
       
   361 Specify which keys should be used to sign the zone. If no keys are specified, then the zone will be examined for \fBDNSKEY\fR records at the zone apex. If these are found and there are matching private keys in the current directory, these will be used for signing.
       
   362 .RE
       
   363 
       
   364 .SH EXAMPLES
       
   365 .LP
       
   366 \fBExample 1 \fRSigning a Zone with a DSA Key
       
   367 .sp
       
   368 .LP
       
   369 The following command signs the \fBexample.com\fR zone with the DSA key generated in the example in the \fBdnssec-keygen\fR(8) manual page (\fBKexample.com.+003+17247\fR). The zone's keys must be in the master file (\fBdb.example.com\fR). This invocation looks for keyset files in the current directory, so that DS records can be generated from them (\fB-g\fR).
       
   370 
       
   371 .sp
       
   372 .in +2
       
   373 .nf
       
   374 % \fBdnssec-signzone -g -o example.com db.example.com \e\fR
       
   375 \fBKexample.com.+003+17247\fR
       
   376 \fBdb.example.com.signed\fR
       
   377 %
       
   378 .fi
       
   379 .in -2
       
   380 .sp
       
   381 
       
   382 .sp
       
   383 .LP
       
   384 In the above example, \fBdnssec-signzone\fR creates the file \fBdb.example.com.signed\fR. This file should be referenced in a zone statement in a \fBnamed.conf\fR file.
       
   385 
       
   386 .LP
       
   387 \fBExample 2 \fRRe-signing a Previously Signed Zone
       
   388 .sp
       
   389 .LP
       
   390 The following commands re-sign a previously signed zone with default parameters. The private keys are assumed to be in the current directory.
       
   391 
       
   392 .sp
       
   393 .in +2
       
   394 .nf
       
   395 % \fBcp db.example.com.signed db.example.com\fR
       
   396 % \fBdnssec-signzone -o example.com db.example.com \e\fR
       
   397 \fBdb.example.com.signed\fR
       
   398 %
       
   399 .fi
       
   400 .in -2
       
   401 .sp
       
   402 
       
   403 .SH ATTRIBUTES
       
   404 .sp
       
   405 .LP
       
   406 See \fBattributes\fR(7) for descriptions of the following attributes:
       
   407 .sp
       
   408 
       
   409 .sp
       
   410 .TS
       
   411 tab() box;
       
   412 cw(2.75i) |cw(2.75i) 
       
   413 lw(2.75i) |lw(2.75i) 
       
   414 .
       
   415 ATTRIBUTE TYPEATTRIBUTE VALUE
       
   416 _
       
   417 Availabilityservice/network/dns/bind
       
   418 _
       
   419 Interface StabilityVolatile
       
   420 .TE
       
   421 
       
   422 .SH SEE ALSO
       
   423 .sp
       
   424 .LP
       
   425 \fBdnssec-keygen\fR(8), \fBattributes\fR(7)
       
   426 .sp
       
   427 .LP
       
   428 \fIRFC 4033\fR
       
   429 .sp
       
   430 .LP
       
   431 See the BIND 9 \fIAdministrator's Reference Manual\fR. As of the date of publication of this man page, this document is available at https://www.isc.org/software/bind/documentation\&.