man.dnssec-coverage.html revision c60ee6edf129596fa04db86c6865d75b5a412598
fa9e4066f08beec538e775443c5be79dd423fcabahrens<!--
fa9e4066f08beec538e775443c5be79dd423fcabahrens - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
fa9e4066f08beec538e775443c5be79dd423fcabahrens - Copyright (C) 2000-2003 Internet Software Consortium.
fa9e4066f08beec538e775443c5be79dd423fcabahrens -
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock - Permission to use, copy, modify, and/or distribute this software for any
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock - purpose with or without fee is hereby granted, provided that the above
fa9e4066f08beec538e775443c5be79dd423fcabahrens - copyright notice and this permission notice appear in all copies.
fa9e4066f08beec538e775443c5be79dd423fcabahrens -
fa9e4066f08beec538e775443c5be79dd423fcabahrens - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
fa9e4066f08beec538e775443c5be79dd423fcabahrens - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
fa9e4066f08beec538e775443c5be79dd423fcabahrens - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
fa9e4066f08beec538e775443c5be79dd423fcabahrens - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
fa9e4066f08beec538e775443c5be79dd423fcabahrens - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
fa9e4066f08beec538e775443c5be79dd423fcabahrens - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
fa9e4066f08beec538e775443c5be79dd423fcabahrens - PERFORMANCE OF THIS SOFTWARE.
fa9e4066f08beec538e775443c5be79dd423fcabahrens-->
fa9e4066f08beec538e775443c5be79dd423fcabahrens<!-- $Id$ -->
fa9e4066f08beec538e775443c5be79dd423fcabahrens<html>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<head>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<title>dnssec-coverage</title>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
0f7643c7376dd69a08acbfc9d1d7d548b10c846aGeorge Wilson<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<link rel="prev" href="man.dnssec-checkds.html" title="dnssec-checkds">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<link rel="next" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
fa9e4066f08beec538e775443c5be79dd423fcabahrens</head>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<div class="navheader">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<table width="100%" summary="Navigation header">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<tr><th colspan="3" align="center"><span class="application">dnssec-coverage</span></th></tr>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<tr>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<td width="20%" align="left">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<a accesskey="p" href="man.dnssec-checkds.html">Prev</a>�</td>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<th width="60%" align="center">Manual pages</th>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-dsfromkey.html">Next</a>
fa9e4066f08beec538e775443c5be79dd423fcabahrens</td>
fa9e4066f08beec538e775443c5be79dd423fcabahrens</tr>
fa9e4066f08beec538e775443c5be79dd423fcabahrens</table>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<hr>
fa9e4066f08beec538e775443c5be79dd423fcabahrens</div>
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock<div class="refentry" lang="en">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<a name="man.dnssec-coverage"></a><div class="titlepage"></div>
744947dc83c634d985ed3ad79ac9c5e28d1865fdTom Erickson<div class="refnamediv">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<h2>Name</h2>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<p><span class="application">dnssec-coverage</span> &#8212; checks future DNSKEY coverage for a zone</p>
fa9e4066f08beec538e775443c5be79dd423fcabahrens</div>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<div class="refsynopsisdiv">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<h2>Synopsis</h2>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<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>
fa9e4066f08beec538e775443c5be79dd423fcabahrens</div>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<div class="refsect1" lang="en">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<a name="id2619036"></a><h2>DESCRIPTION</h2>
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrens<p><span><strong class="command">dnssec-coverage</strong></span>
fa9e4066f08beec538e775443c5be79dd423fcabahrens verifies that the DNSSEC keys for a given zone or a set of zones
fa9e4066f08beec538e775443c5be79dd423fcabahrens have timing metadata set properly to ensure no future lapses in DNSSEC
28e4da25922bdfc5cba7ab29f47de911bbd78009Matthew Ahrens coverage.
28e4da25922bdfc5cba7ab29f47de911bbd78009Matthew Ahrens </p>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<p>
fa9e4066f08beec538e775443c5be79dd423fcabahrens If <code class="option">zone</code> is specified, then keys found in
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrens the key repository matching that zone are scanned, and an ordered
fa9e4066f08beec538e775443c5be79dd423fcabahrens list is generated of the events scheduled for that key (i.e.,
fa9e4066f08beec538e775443c5be79dd423fcabahrens publication, activation, inactivation, deletion). The list of
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrens events is walked in order of occurrence. Warnings are generated
0f7643c7376dd69a08acbfc9d1d7d548b10c846aGeorge Wilson if any event is scheduled which could cause the zone to enter a
fa9e4066f08beec538e775443c5be79dd423fcabahrens state in which validation failures might occur: for example, if
fa9e4066f08beec538e775443c5be79dd423fcabahrens the number of published or active keys for a given algorithm drops
fa9e4066f08beec538e775443c5be79dd423fcabahrens to zero, or if a key is deleted from the zone too soon after a new
fa9e4066f08beec538e775443c5be79dd423fcabahrens key is rolled, and cached data signed by the prior key has not had
fa9e4066f08beec538e775443c5be79dd423fcabahrens time to expire from resolver caches.
fa9e4066f08beec538e775443c5be79dd423fcabahrens </p>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<p>
fa9e4066f08beec538e775443c5be79dd423fcabahrens If <code class="option">zone</code> is not specified, then all keys in the
744947dc83c634d985ed3ad79ac9c5e28d1865fdTom Erickson key repository will be scanned, and all zones for which there are
dcbf3bd6a1f1360fc1afcee9e22c6dcff7844bf2George Wilson keys will be analyzed. (Note: This method of reporting is only
0f7643c7376dd69a08acbfc9d1d7d548b10c846aGeorge Wilson accurate if all the zones that have keys in a given repository
0f7643c7376dd69a08acbfc9d1d7d548b10c846aGeorge Wilson share the same TTL parameters.)
fa9e4066f08beec538e775443c5be79dd423fcabahrens </p>
fa9e4066f08beec538e775443c5be79dd423fcabahrens</div>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<div class="refsect1" lang="en">
fa9e4066f08beec538e775443c5be79dd423fcabahrens<a name="id2619063"></a><h2>OPTIONS</h2>
744947dc83c634d985ed3ad79ac9c5e28d1865fdTom Erickson<div class="variablelist"><dl>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<dd><p>
fa9e4066f08beec538e775443c5be79dd423fcabahrens Sets the directory in which keys can be found. Defaults to the
fa9e4066f08beec538e775443c5be79dd423fcabahrens current working directory.
fa9e4066f08beec538e775443c5be79dd423fcabahrens </p></dd>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrens<dd><p>
0f7643c7376dd69a08acbfc9d1d7d548b10c846aGeorge Wilson If a <code class="option">file</code> is specified, then the zone is
fa9e4066f08beec538e775443c5be79dd423fcabahrens read from that file; the largest TTL and the DNSKEY TTL are
fa9e4066f08beec538e775443c5be79dd423fcabahrens determined directly from the zone data, and the
fa9e4066f08beec538e775443c5be79dd423fcabahrens <code class="option">-m</code> and <code class="option">-d</code> options do
fa9e4066f08beec538e775443c5be79dd423fcabahrens not need to be specified on the command line.
1a5e258f5471356ca102c7176637cdce45bac147Josef 'Jeff' Sipek </p></dd>
1a5e258f5471356ca102c7176637cdce45bac147Josef 'Jeff' Sipek<dt><span class="term">-l <em class="replaceable"><code>duration</code></em></span></dt>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<dd>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<p>
fa9e4066f08beec538e775443c5be79dd423fcabahrens The length of time to check for DNSSEC coverage. Key events
fa9e4066f08beec538e775443c5be79dd423fcabahrens scheduled further into the future than <code class="option">duration</code>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling will be ignored, and assumed to be correct.
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling </p>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling<p>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling The value of <code class="option">duration</code> can be set in seconds,
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling or in larger units of time by adding a suffix: 'mi' for minutes,
dcbf3bd6a1f1360fc1afcee9e22c6dcff7844bf2George Wilson 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months,
0f7643c7376dd69a08acbfc9d1d7d548b10c846aGeorge Wilson 'y' for years.
0f7643c7376dd69a08acbfc9d1d7d548b10c846aGeorge Wilson </p>
fa9e4066f08beec538e775443c5be79dd423fcabahrens</dd>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<dt><span class="term">-m <em class="replaceable"><code>maximum TTL</code></em></span></dt>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<dd>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<p>
744947dc83c634d985ed3ad79ac9c5e28d1865fdTom Erickson Sets the value to be used as the maximum TTL for the zone or
fa9e4066f08beec538e775443c5be79dd423fcabahrens zones being analyzed when determining whether there is a
fa9e4066f08beec538e775443c5be79dd423fcabahrens possibility of validation failure. When a zone-signing key is
fa9e4066f08beec538e775443c5be79dd423fcabahrens deactivated, there must be enough time for the record in the
fa9e4066f08beec538e775443c5be79dd423fcabahrens zone with the longest TTL to have expired from resolver caches
fa9e4066f08beec538e775443c5be79dd423fcabahrens before that key can be purged from the DNSKEY RRset. If that
fa9e4066f08beec538e775443c5be79dd423fcabahrens 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><strong class="command">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><strong class="command">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><strong class="command">named-compilezone</strong></span> binary.
Used for testing.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2619372"></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 class="refsect1" lang="en">
<a name="id2619416"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</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.ch10.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 style="text-align: center;">BIND 9.11.0pre-alpha</p>
</body>
</html>