external/bsd/bind/dist/bin/python/dnssec-coverage.8

   1 .\"     $NetBSD: dnssec-coverage.8,v 1.1.1.6 2014/12/10 03:34:27 christos Exp $
   2 .\"
   3 .\" Copyright (C) 2013, 2014  Internet Systems Consortium, Inc. ("ISC")
   4 .\"
   5 .\" Permission to use, copy, modify, and/or distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11 .\" AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15 .\" PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .\" Id
  18 .\"
  19 .hy 0
  20 .ad l
  21 .\"     Title: dnssec\-coverage
  22 .\"    Author:
  23 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  24 .\"      Date: January 11, 2014
  25 .\"    Manual: BIND9
  26 .\"    Source: BIND9
  27 .\"
  28 .TH "DNSSEC\-COVERAGE" "8" "January 11, 2014" "BIND9" "BIND9"
  29 .\" disable hyphenation
  30 .nh
  31 .\" disable justification (adjust text to left margin only)
  32 .ad l
  33 .SH "NAME"
  34 dnssec\-coverage \- checks future DNSKEY coverage for a zone
  35 .SH "SYNOPSIS"
  36 .HP 16
  37 \fBdnssec\-coverage\fR [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-l\ \fR\fB\fIlength\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-d\ \fR\fB\fIDNSKEY\ TTL\fR\fR] [\fB\-m\ \fR\fB\fImax\ TTL\fR\fR] [\fB\-r\ \fR\fB\fIinterval\fR\fR] [\fB\-c\ \fR\fB\fIcompilezone\ path\fR\fR] [\fB\-k\fR] [\fB\-z\fR] [zone]
  38 .SH "DESCRIPTION"
  39 .PP
  40 \fBdnssec\-coverage\fR
  41 verifies that the DNSSEC keys for a given zone or a set of zones have timing metadata set properly to ensure no future lapses in DNSSEC coverage.
  42 .PP
  43 If
  44 \fBzone\fR
  45 is specified, then keys found in the key repository matching that zone are scanned, and an ordered list is generated of the events scheduled for that key (i.e., publication, activation, inactivation, deletion). The list of events is walked in order of occurrence. Warnings are generated if any event is scheduled which could cause the zone to enter a state in which validation failures might occur: for example, if the number of published or active keys for a given algorithm drops to zero, or if a key is deleted from the zone too soon after a new key is rolled, and cached data signed by the prior key has not had time to expire from resolver caches.
  46 .PP
  47 If
  48 \fBzone\fR
  49 is not specified, then all keys in the key repository will be scanned, and all zones for which there are keys will be analyzed. (Note: This method of reporting is only accurate if all the zones that have keys in a given repository share the same TTL parameters.)
  50 .SH "OPTIONS"
  51 .PP
  52 \-K \fIdirectory\fR
  53 .RS 4
  54 Sets the directory in which keys can be found. Defaults to the current working directory.
  55 .RE
  56 .PP
  57 \-f \fIfile\fR
  58 .RS 4
  59 If a
  60 \fBfile\fR
  61 is specified, then the zone is read from that file; the largest TTL and the DNSKEY TTL are determined directly from the zone data, and the
  62 \fB\-m\fR
  63 and
  64 \fB\-d\fR
  65 options do not need to be specified on the command line.
  66 .RE
  67 .PP
  68 \-l \fIduration\fR
  69 .RS 4
  70 The length of time to check for DNSSEC coverage. Key events scheduled further into the future than
  71 \fBduration\fR
  72 will be ignored, and assumed to be correct.
  73 .sp
  74 The value of
  75 \fBduration\fR
  76 can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
  77 .RE
  78 .PP
  79 \-m \fImaximum TTL\fR
  80 .RS 4
  81 Sets the value to be used as the maximum TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure. When a zone\-signing key is deactivated, there must be enough time for the record in the zone with the longest TTL to have expired from resolver caches before that key can be purged from the DNSKEY RRset. If that condition does not apply, a warning will be generated.
  82 .sp
  83 The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
  84 .sp
  85 This option is mandatory unless the
  86 \fB\-f\fR
  87 has been used to specify a zone file. (If
  88 \fB\-f\fR
  89 has been specified, this option may still be used; it will override the value found in the file.)
  90 .RE
  91 .PP
  92 \-d \fIDNSKEY TTL\fR
  93 .RS 4
  94 Sets the value to be used as the DNSKEY TTL for the zone or zones being analyzed when determining whether there is a possibility of validation failure. When a key is rolled (that is, replaced with a new key), there must be enough time for the old DNSKEY RRset to have expired from resolver caches before the new key is activated and begins generating signatures. If that condition does not apply, a warning will be generated.
  95 .sp
  96 The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
  97 .sp
  98 This option is mandatory unless the
  99 \fB\-f\fR
 100 has been used to specify a zone file, or a default key TTL was set with the
 101 \fB\-L\fR
 102 to
 103 \fBdnssec\-keygen\fR. (If either of those is true, this option may still be used; it will override the value found in the zone or key file.)
 104 .RE
 105 .PP
 106 \-r \fIresign interval\fR
 107 .RS 4
 108 Sets the value to be used as the resign interval for the zone or zones being analyzed when determining whether there is a possibility of validation failure. This value defaults to 22.5 days, which is also the default in
 109 \fBnamed\fR. However, if it has been changed by the
 110 \fBsig\-validity\-interval\fR
 111 option in
 112 \fInamed.conf\fR, then it should also be changed here.
 113 .sp
 114 The length of the interval can be set in seconds, or in larger units of time by adding a suffix: 'mi' for minutes, 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
 115 .RE
 116 .PP
 117 \-k
 118 .RS 4
 119 Only check KSK coverage; ignore ZSK events. Cannot be used with
 120 \fB\-z\fR.
 121 .RE
 122 .PP
 123 \-z
 124 .RS 4
 125 Only check ZSK coverage; ignore KSK events. Cannot be used with
 126 \fB\-k\fR.
 127 .RE
 128 .PP
 129 \-c \fIcompilezone path\fR
 130 .RS 4
 131 Specifies a path to a
 132 \fBnamed\-compilezone\fR
 133 binary. Used for testing.
 134 .RE
 135 .SH "SEE ALSO"
 136 .PP
 137 \fBdnssec\-checkds\fR(8),
 138 \fBdnssec\-dsfromkey\fR(8),
 139 \fBdnssec\-keygen\fR(8),
 140 \fBdnssec\-signzone\fR(8)
 141 .SH "AUTHOR"
 142 .PP
 143 Internet Systems Consortium
 144 .SH "COPYRIGHT"
 145 Copyright \(co 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
 146 .br