"Fossies" - the Fresh Open Source Software Archive

Member "bind-9.16.7/doc/man/dnssec-coverage.8in" (4 Sep 2020, 6635 Bytes) of package /linux/misc/dns/bind9/9.16.7/bind-9.16.7.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 .\" Man page generated from reStructuredText.
    2 .
    3 .TH "DNSSEC-COVERAGE" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
    4 .SH NAME
    5 dnssec-coverage \- checks future DNSKEY coverage for a zone
    6 .
    7 .nr rst2man-indent-level 0
    8 .
    9 .de1 rstReportMargin
   10 \\$1 \\n[an-margin]
   11 level \\n[rst2man-indent-level]
   12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
   13 -
   14 \\n[rst2man-indent0]
   15 \\n[rst2man-indent1]
   16 \\n[rst2man-indent2]
   17 ..
   18 .de1 INDENT
   19 .\" .rstReportMargin pre:
   20 . RS \\$1
   21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
   22 . nr rst2man-indent-level +1
   23 .\" .rstReportMargin post:
   24 ..
   25 .de UNINDENT
   26 . RE
   27 .\" indent \\n[an-margin]
   28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
   29 .nr rst2man-indent-level -1
   30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
   31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
   32 ..
   33 .SH SYNOPSIS
   34 .sp
   35 \fBdnssec\-coverage\fP [\fB\-K\fP\fIdirectory\fP] [\fB\-l\fP\fIlength\fP]
   36 [\fB\-f\fP\fIfile\fP] [\fB\-d\fP\fIDNSKEY TTL\fP] [\fB\-m\fP\fImax TTL\fP]
   37 [\fB\-r\fP\fIinterval\fP] [\fB\-c\fP\fIcompilezone path\fP] [\fB\-k\fP] [\fB\-z\fP]
   38 [zone...]
   39 .SH DESCRIPTION
   40 .sp
   41 \fBdnssec\-coverage\fP verifies that the DNSSEC keys for a given zone or a
   42 set of zones have timing metadata set properly to ensure no future
   43 lapses in DNSSEC coverage.
   44 .sp
   45 If \fBzone\fP is specified, then keys found in the key repository matching
   46 that zone are scanned, and an ordered list is generated of the events
   47 scheduled for that key (i.e., publication, activation, inactivation,
   48 deletion). The list of events is walked in order of occurrence. Warnings
   49 are generated if any event is scheduled which could cause the zone to
   50 enter a state in which validation failures might occur: for example, if
   51 the number of published or active keys for a given algorithm drops to
   52 zero, or if a key is deleted from the zone too soon after a new key is
   53 rolled, and cached data signed by the prior key has not had time to
   54 expire from resolver caches.
   55 .sp
   56 If \fBzone\fP is not specified, then all keys in the key repository will
   57 be scanned, and all zones for which there are keys will be analyzed.
   58 (Note: This method of reporting is only accurate if all the zones that
   59 have keys in a given repository share the same TTL parameters.)
   60 .SH OPTIONS
   61 .sp
   62 \fB\-K\fP \fIdirectory\fP
   63 .INDENT 0.0
   64 .INDENT 3.5
   65 Sets the directory in which keys can be found. Defaults to the
   66 current working directory.
   67 .UNINDENT
   68 .UNINDENT
   69 .sp
   70 \fB\-f\fP \fIfile\fP
   71 .INDENT 0.0
   72 .INDENT 3.5
   73 If a \fBfile\fP is specified, then the zone is read from that file; the
   74 largest TTL and the DNSKEY TTL are determined directly from the zone
   75 data, and the \fB\-m\fP and \fB\-d\fP options do not need to be specified
   76 on the command line.
   77 .UNINDENT
   78 .UNINDENT
   79 .sp
   80 \fB\-l\fP \fIduration\fP
   81 .INDENT 0.0
   82 .INDENT 3.5
   83 The length of time to check for DNSSEC coverage. Key events scheduled
   84 further into the future than \fBduration\fP will be ignored, and
   85 assumed to be correct.
   86 .sp
   87 The value of \fBduration\fP can be set in seconds, or in larger units
   88 of time by adding a suffix: mi for minutes, h for hours, d for days,
   89 w for weeks, mo for months, y for years.
   90 .UNINDENT
   91 .UNINDENT
   92 .sp
   93 \fB\-m\fP \fImaximum TTL\fP
   94 .INDENT 0.0
   95 .INDENT 3.5
   96 Sets the value to be used as the maximum TTL for the zone or zones
   97 being analyzed when determining whether there is a possibility of
   98 validation failure. When a zone\-signing key is deactivated, there
   99 must be enough time for the record in the zone with the longest TTL
  100 to have expired from resolver caches before that key can be purged
  101 from the DNSKEY RRset. If that condition does not apply, a warning
  102 will be generated.
  103 .sp
  104 The length of the TTL can be set in seconds, or in larger units of
  105 time by adding a suffix: mi for minutes, h for hours, d for days, w
  106 for weeks, mo for months, y for years.
  107 .sp
  108 This option is not necessary if the \fB\-f\fP has been used to specify a
  109 zone file. If \fB\-f\fP has been specified, this option may still be
  110 used; it will override the value found in the file.
  111 .sp
  112 If this option is not used and the maximum TTL cannot be retrieved
  113 from a zone file, a warning is generated and a default value of 1
  114 week is used.
  115 .UNINDENT
  116 .UNINDENT
  117 .sp
  118 \fB\-d\fP \fIDNSKEY TTL\fP
  119 .INDENT 0.0
  120 .INDENT 3.5
  121 Sets the value to be used as the DNSKEY TTL for the zone or zones
  122 being analyzed when determining whether there is a possibility of
  123 validation failure. When a key is rolled (that is, replaced with a
  124 new key), there must be enough time for the old DNSKEY RRset to have
  125 expired from resolver caches before the new key is activated and
  126 begins generating signatures. If that condition does not apply, a
  127 warning will be generated.
  128 .sp
  129 The length of the TTL can be set in seconds, or in larger units of
  130 time by adding a suffix: mi for minutes, h for hours, d for days, w
  131 for weeks, mo for months, y for years.
  132 .sp
  133 This option is not necessary if \fB\-f\fP has been used to specify a
  134 zone file from which the TTL of the DNSKEY RRset can be read, or if a
  135 default key TTL was set using ith the \fB\-L\fP to \fBdnssec\-keygen\fP\&. If
  136 either of those is true, this option may still be used; it will
  137 override the values found in the zone file or the key file.
  138 .sp
  139 If this option is not used and the key TTL cannot be retrieved from
  140 the zone file or the key file, then a warning is generated and a
  141 default value of 1 day is used.
  142 .UNINDENT
  143 .UNINDENT
  144 .sp
  145 \fB\-r\fP \fIresign interval\fP
  146 .INDENT 0.0
  147 .INDENT 3.5
  148 Sets the value to be used as the resign interval for the zone or
  149 zones being analyzed when determining whether there is a possibility
  150 of validation failure. This value defaults to 22.5 days, which is
  151 also the default in \fBnamed\fP\&. However, if it has been changed by the
  152 \fBsig\-validity\-interval\fP option in named.conf, then it should also
  153 be changed here.
  154 .sp
  155 The length of the interval can be set in seconds, or in larger units
  156 of time by adding a suffix: mi for minutes, h for hours, d for days,
  157 w for weeks, mo for months, y for years.
  158 .UNINDENT
  159 .UNINDENT
  160 .sp
  161 \fB\-k\fP
  162 .INDENT 0.0
  163 .INDENT 3.5
  164 Only check KSK coverage; ignore ZSK events. Cannot be used with
  165 \fB\-z\fP\&.
  166 .UNINDENT
  167 .UNINDENT
  168 .sp
  169 \fB\-z\fP
  170 .INDENT 0.0
  171 .INDENT 3.5
  172 Only check ZSK coverage; ignore KSK events. Cannot be used with
  173 \fB\-k\fP\&.
  174 .UNINDENT
  175 .UNINDENT
  176 .sp
  177 \fB\-c\fP \fIcompilezone path\fP
  178 .INDENT 0.0
  179 .INDENT 3.5
  180 Specifies a path to a \fBnamed\-compilezone\fP binary. Used for testing.
  181 .UNINDENT
  182 .UNINDENT
  183 .SH SEE ALSO
  184 .sp
  185 \fBdnssec\-checkds\fP(8), \fBdnssec\-dsfromkey\fP(8),
  186 \fBdnssec\-keygen\fP(8), \fBdnssec\-signzone\fP(8)
  187 .SH AUTHOR
  188 Internet Systems Consortium
  189 .SH COPYRIGHT
  190 2020, Internet Systems Consortium
  191 .\" Generated by docutils manpage writer.
  192 .