dnssec-coverage.html revision 2cf1d5b0986d38e60db88a7b2360798e539d7636
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - Permission to use, copy, modify, and/or distribute this software for any
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - purpose with or without fee is hereby granted, provided that the above
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - copyright notice and this permission notice appear in all copies.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end - PERFORMANCE OF THIS SOFTWARE.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<!-- $Id$ -->
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<a name="man.dnssec-coverage"></a><div class="titlepage"></div>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<p><span class="application">dnssec-coverage</span> — checks future DNSKEY coverage for a zone</p>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<div class="cmdsynopsis"><p><code class="command">dnssec-coverage</code> [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-l <em class="replaceable"><code>length</code></em></code>] [<code class="option">-f <em class="replaceable"><code>file</code></em></code>] [<code class="option">-d <em class="replaceable"><code>DNSKEY TTL</code></em></code>] [<code class="option">-m <em class="replaceable"><code>max TTL</code></em></code>] [<code class="option">-r <em class="replaceable"><code>interval</code></em></code>] [<code class="option">-c <em class="replaceable"><code>compilezone path</code></em></code>] [<code class="option">-k</code>] [<code class="option">-z</code>] [zone]</p></div>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<p><span><strong class="command">dnssec-coverage</strong></span>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end verifies that the DNSSEC keys for a given zone or a set of zones
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end have timing metadata set properly to ensure no future lapses in DNSSEC
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end If <code class="option">zone</code> is specified, then keys found in
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end the key repository matching that zone are scanned, and an ordered
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end list is generated of the events scheduled for that key (i.e.,
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end publication, activation, inactivation, deletion). The list of
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end events is walked in order of occurrence. Warnings are generated
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end if any event is scheduled which could cause the zone to enter a
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end state in which validation failures might occur: for example, if
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end the number of published or active keys for a given algorithm drops
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end to zero, or if a key is deleted from the zone too soon after a new
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end key is rolled, and cached data signed by the prior key has not had
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end time to expire from resolver caches.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end If <code class="option">zone</code> is not specified, then all keys in the
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end key repository will be scanned, and all zones for which there are
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end keys will be analyzed. (Note: This method of reporting is only
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end accurate if all the zones that have keys in a given repository
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end share the same TTL parameters.)
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end Sets the directory in which keys can be found. Defaults to the
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end current working directory.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end If a <code class="option">file</code> is specified, then the zone is
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end read from that file; the largest TTL and the DNSKEY TTL are
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end determined directly from the zone data, and the
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end <code class="option">-m</code> and <code class="option">-d</code> options do
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end not need to be specified on the command line.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<dt><span class="term">-l <em class="replaceable"><code>duration</code></em></span></dt>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end The length of time to check for DNSSEC coverage. Key events
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end scheduled further into the future than <code class="option">duration</code>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end will be ignored, and assumed to be correct.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end The value of <code class="option">duration</code> can be set in seconds,
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end or in larger units of time by adding a suffix: 'mi' for minutes,
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months,
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end 'y' for years.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<dt><span class="term">-m <em class="replaceable"><code>maximum TTL</code></em></span></dt>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end Sets the value to be used as the maximum TTL for the zone or
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end zones being analyzed when determining whether there is a
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end possibility of validation failure. When a zone-signing key is
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end deactivated, there must be enough time for the record in the
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end zone with the longest TTL to have expired from resolver caches
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end before that key can be purged from the DNSKEY RRset. If that
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end condition does not apply, a warning will be generated.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end The length of the TTL can be set in seconds, or in larger units
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end of time by adding a suffix: 'mi' for minutes, 'h' for hours,
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end This option is mandatory unless the <code class="option">-f</code> has
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end been used to specify a zone file. (If <code class="option">-f</code> has
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end been specified, this option may still be used; it will overrde
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end the value found in the file.)
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<dt><span class="term">-d <em class="replaceable"><code>DNSKEY TTL</code></em></span></dt>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end Sets the value to be used as the DNSKEY TTL for the zone or
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end zones being analyzed when determining whether there is a
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end possibility of validation failure. When a key is rolled (that
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end is, replaced with a new key), there must be enough time
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end for the old DNSKEY RRset to have expired from resolver caches
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end before the new key is activated and begins generating
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end signatures. If that condition does not apply, a warning
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end will be generated.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end The length of the TTL can be set in seconds, or in larger units
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end of time by adding a suffix: 'mi' for minutes, 'h' for hours,
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end This option is mandatory unless the <code class="option">-f</code> has
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end been used to specify a zone file, or a default key TTL was
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end <span><strong class="command">dnssec-keygen</strong></span>. (If either of those is true,
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end this option may still be used; it will overrde the value found
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end in the zone or key file.)
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<dt><span class="term">-r <em class="replaceable"><code>resign interval</code></em></span></dt>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end Sets the value to be used as the resign interval for the zone
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end or zones being analyzed when determining whether there is a
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end possibility of validation failure. This value defaults to
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end 22.5 days, which is also the default in
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end <span><strong class="command">named</strong></span>. However, if it has been changed
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end by the <code class="option">sig-validity-interval</code> option in
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end <code class="filename">named.conf</code>, then it should also be
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end changed here.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end The length of the interval can be set in seconds, or in larger
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end units of time by adding a suffix: 'mi' for minutes, 'h' for hours,
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end Only check KSK coverage; ignore ZSK events. Cannot be
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end Only check ZSK coverage; ignore KSK events. Cannot be
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end<dt><span class="term">-c <em class="replaceable"><code>compilezone path</code></em></span></dt>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end Specifies a path to a <span><strong class="command">named-compilezone</strong></span> binary.
9c1260efa52c82c2a58e5b5f20cd6902563d95f5rbowen Used for testing.