d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User - Copyright (C) 2013-2016 Internet Systems Consortium, Inc. ("ISC")
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - This Source Code Form is subject to the terms of the Mozilla Public
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - License, v. 2.0. If a copy of the MPL was not distributed with this
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - file, You can obtain one at http://mozilla.org/MPL/2.0/.
49f29a1d550c15d691b5a9162bc089d0fba12adfTinderbox User<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
49f29a1d550c15d691b5a9162bc089d0fba12adfTinderbox User<a name="man.dnssec-coverage"></a><div class="titlepage"></div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span class="application">dnssec-coverage</span>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User — checks future DNSKEY coverage for a zone
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-l <em class="replaceable"><code>length</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-f <em class="replaceable"><code>file</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-d <em class="replaceable"><code>DNSKEY TTL</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-m <em class="replaceable"><code>max TTL</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-r <em class="replaceable"><code>interval</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-c <em class="replaceable"><code>compilezone path</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox 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.)
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <div class="variablelist"><dl class="variablelist">
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>
79f0eedd657d75889009226aa7ce23eeac28df5cMark Andrews 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.
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User This option is not necessary if the <code class="option">-f</code> has
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox 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
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User the value found in the file.
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User If this option is not used and the maximum TTL cannot be retrieved
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User from a zone file, a warning is generated and a default value of
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User 1 week is used.
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
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User is, replaced with a new key), there must be enough time for the
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User old DNSKEY RRset to have expired from resolver caches before
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User the new key is activated and begins generating signatures. If
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User that 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.
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User This option is not necessary if <code class="option">-f</code> has
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User been used to specify a zone file from which the TTL
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User of the DNSKEY RRset can be read, or if a default key TTL was
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User set using ith the <code class="option">-L</code> to
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User <span class="command"><strong>dnssec-keygen</strong></span>. If either of those is true,
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User this option may still be used; it will override the values
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User found in the zone file or the key file.
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User If this option is not used and the key TTL cannot be retrieved
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User from the zone file or the key file, then a warning is generated
17e9d6023e9fec06511e93303836ec0f106379d2Tinderbox User and a default value of 1 day is used.
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.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span class="refentrytitle">dnssec-checkds</span>(8)
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span class="refentrytitle">dnssec-dsfromkey</span>(8)
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span class="refentrytitle">dnssec-keygen</span>(8)
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span class="refentrytitle">dnssec-signzone</span>(8)