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