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