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