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