man.dnssec-coverage.html revision a1ff871f78b7d907d6fc3a382beea2a640fe8423
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<!--
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - Copyright (C) 2000-2003 Internet Software Consortium.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync -
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - Permission to use, copy, modify, and/or distribute this software for any
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - purpose with or without fee is hereby granted, provided that the above
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - copyright notice and this permission notice appear in all copies.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync -
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f78b12e570284aa8291f4ca1add24937fd107403vboxsync - PERFORMANCE OF THIS SOFTWARE.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync-->
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<html>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<head>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<title>dnssec-coverage</title>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<link rel="prev" href="man.dnssec-checkds.html" title="dnssec-checkds">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<link rel="next" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync</head>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<div class="navheader">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<table width="100%" summary="Navigation header">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<tr><th colspan="3" align="center"><span class="application">dnssec-coverage</span></th></tr>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<tr>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<td width="20%" align="left">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<a accesskey="p" href="man.dnssec-checkds.html">Prev</a>�</td>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<th width="60%" align="center">Manual pages</th>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-dsfromkey.html">Next</a>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync</td>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync</tr>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync</table>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<hr>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync</div>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<div class="refentry">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<a name="man.dnssec-coverage"></a><div class="titlepage"></div>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<div class="refnamediv">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<h2>Name</h2>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<p><span class="application">dnssec-coverage</span> &#8212; checks future DNSKEY coverage for a zone</p>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync</div>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<div class="refsynopsisdiv">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<h2>Synopsis</h2>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<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>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync</div>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<div class="refsection">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<a name="id-1.14.6.7"></a><h2>DESCRIPTION</h2>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<p><span class="command"><strong>dnssec-coverage</strong></span>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync verifies that the DNSSEC keys for a given zone or a set of zones
f78b12e570284aa8291f4ca1add24937fd107403vboxsync have timing metadata set properly to ensure no future lapses in DNSSEC
f78b12e570284aa8291f4ca1add24937fd107403vboxsync coverage.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync </p>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<p>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync If <code class="option">zone</code> is specified, then keys found in
f78b12e570284aa8291f4ca1add24937fd107403vboxsync the key repository matching that zone are scanned, and an ordered
f78b12e570284aa8291f4ca1add24937fd107403vboxsync list is generated of the events scheduled for that key (i.e.,
f78b12e570284aa8291f4ca1add24937fd107403vboxsync publication, activation, inactivation, deletion). The list of
f78b12e570284aa8291f4ca1add24937fd107403vboxsync events is walked in order of occurrence. Warnings are generated
f78b12e570284aa8291f4ca1add24937fd107403vboxsync if any event is scheduled which could cause the zone to enter a
f78b12e570284aa8291f4ca1add24937fd107403vboxsync state in which validation failures might occur: for example, if
f78b12e570284aa8291f4ca1add24937fd107403vboxsync the number of published or active keys for a given algorithm drops
f78b12e570284aa8291f4ca1add24937fd107403vboxsync to zero, or if a key is deleted from the zone too soon after a new
f78b12e570284aa8291f4ca1add24937fd107403vboxsync key is rolled, and cached data signed by the prior key has not had
f78b12e570284aa8291f4ca1add24937fd107403vboxsync time to expire from resolver caches.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync </p>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<p>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync If <code class="option">zone</code> is not specified, then all keys in the
f78b12e570284aa8291f4ca1add24937fd107403vboxsync key repository will be scanned, and all zones for which there are
f78b12e570284aa8291f4ca1add24937fd107403vboxsync keys will be analyzed. (Note: This method of reporting is only
f78b12e570284aa8291f4ca1add24937fd107403vboxsync accurate if all the zones that have keys in a given repository
f78b12e570284aa8291f4ca1add24937fd107403vboxsync share the same TTL parameters.)
f78b12e570284aa8291f4ca1add24937fd107403vboxsync </p>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync</div>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<div class="refsection">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<a name="id-1.14.6.8"></a><h2>OPTIONS</h2>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<div class="variablelist"><dl class="variablelist">
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
f78b12e570284aa8291f4ca1add24937fd107403vboxsync<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 not necessary if 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>
<p>
If this option is not used and the maximum TTL cannot be retrieved
from a zone file, a warning is generated and a default value of
1 week is used.
</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 not necessary if <code class="option">-f</code> has
been used to specify a zone file from which the TTL
of the DNSKEY RRset can be read, or if a default key TTL was
set using ith 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 values
found in the zone file or the key file.
</p>
<p>
If this option is not used and the key TTL cannot be retrieved
from the zone file or the key file, then a warning is generated
and a default value of 1 day is used.
</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.14.6.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>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.dnssec-checkds.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-dsfromkey.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span class="application">dnssec-checkds</span>�</td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top">�<span class="application">dnssec-dsfromkey</span>
</td>
</tr>
</table>
</div>
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.0b1</p>
</body>
</html>