1<!--
2 - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
3 - Copyright (C) 2000-2003 Internet Software Consortium.
4 -
5 - Permission to use, copy, modify, and/or distribute this software for any
6 - purpose with or without fee is hereby granted, provided that the above
7 - copyright notice and this permission notice appear in all copies.
8 -
9 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 - PERFORMANCE OF THIS SOFTWARE.
16-->
17<!-- $Id: man.dnssec-coverage.html,v 1.5 2015/09/03 07:33:34 christos Exp $ -->
18<html>
19<head>
20<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
21<title>dnssec-coverage</title>
22<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
23<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
24<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
25<link rel="prev" href="man.dnssec-checkds.html" title="dnssec-checkds">
26<link rel="next" href="man.dnssec-dsfromkey.html" title="dnssec-dsfromkey">
27</head>
28<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
29<div class="navheader">
30<table width="100%" summary="Navigation header">
31<tr><th colspan="3" align="center"><span class="application">dnssec-coverage</span></th></tr>
32<tr>
33<td width="20%" align="left">
34<a accesskey="p" href="man.dnssec-checkds.html">Prev</a>�</td>
35<th width="60%" align="center">Manual pages</th>
36<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-dsfromkey.html">Next</a>
37</td>
38</tr>
39</table>
40<hr>
41</div>
42<div class="refentry" lang="en">
43<a name="man.dnssec-coverage"></a><div class="titlepage"></div>
44<div class="refnamediv">
45<h2>Name</h2>
46<p><span class="application">dnssec-coverage</span> &#8212; checks future DNSKEY coverage for a zone</p>
47</div>
48<div class="refsynopsisdiv">
49<h2>Synopsis</h2>
50<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>
51</div>
52<div class="refsect1" lang="en">
53<a name="id2617533"></a><h2>DESCRIPTION</h2>
54<p><span><strong class="command">dnssec-coverage</strong></span>
55      verifies that the DNSSEC keys for a given zone or a set of zones
56      have timing metadata set properly to ensure no future lapses in DNSSEC
57      coverage.
58    </p>
59<p>
60      If <code class="option">zone</code> is specified, then keys found in
61      the key repository matching that zone are scanned, and an ordered
62      list is generated of the events scheduled for that key (i.e.,
63      publication, activation, inactivation, deletion).  The list of
64      events is walked in order of occurrence.  Warnings are generated
65      if any event is scheduled which could cause the zone to enter a
66      state in which validation failures might occur: for example, if
67      the number of published or active keys for a given algorithm drops
68      to zero, or if a key is deleted from the zone too soon after a new
69      key is rolled, and cached data signed by the prior key has not had
70      time to expire from resolver caches.
71    </p>
72<p>
73      If <code class="option">zone</code> is not specified, then all keys in the
74      key repository will be scanned, and all zones for which there are
75      keys will be analyzed.  (Note: This method of reporting is only
76      accurate if all the zones that have keys in a given repository
77      share the same TTL parameters.)
78    </p>
79</div>
80<div class="refsect1" lang="en">
81<a name="id2617628"></a><h2>OPTIONS</h2>
82<div class="variablelist"><dl>
83<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
84<dd><p>
85            Sets the directory in which keys can be found.  Defaults to the
86            current working directory.
87          </p></dd>
88<dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
89<dd><p>
90            If a <code class="option">file</code> is specified, then the zone is
91            read from that file; the largest TTL and the DNSKEY TTL are
92            determined directly from the zone data, and the
93            <code class="option">-m</code> and <code class="option">-d</code> options do
94            not need to be specified on the command line.
95          </p></dd>
96<dt><span class="term">-l <em class="replaceable"><code>duration</code></em></span></dt>
97<dd>
98<p>
99            The length of time to check for DNSSEC coverage.  Key events
100            scheduled further into the future than <code class="option">duration</code>
101            will be ignored, and assumed to be correct.
102          </p>
103<p>
104            The value of <code class="option">duration</code> can be set in seconds,
105            or in larger units of time by adding a suffix: 'mi' for minutes,
106            'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months,
107            'y' for years.
108          </p>
109</dd>
110<dt><span class="term">-m <em class="replaceable"><code>maximum TTL</code></em></span></dt>
111<dd>
112<p>
113            Sets the value to be used as the maximum TTL for the zone or
114            zones being analyzed when determining whether there is a
115            possibility of validation failure.  When a zone-signing key is
116            deactivated, there must be enough time for the record in the
117            zone with the longest TTL to have expired from resolver caches
118            before that key can be purged from the DNSKEY RRset.  If that
119            condition does not apply, a warning will be generated.
120          </p>
121<p>
122            The length of the TTL can be set in seconds, or in larger units
123            of time by adding a suffix: 'mi' for minutes, 'h' for hours,
124            'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
125          </p>
126<p>
127            This option is mandatory unless the <code class="option">-f</code> has
128            been used to specify a zone file.  (If <code class="option">-f</code> has
129            been specified, this option may still be used; it will override
130            the value found in the file.)
131          </p>
132</dd>
133<dt><span class="term">-d <em class="replaceable"><code>DNSKEY TTL</code></em></span></dt>
134<dd>
135<p>
136            Sets the value to be used as the DNSKEY TTL for the zone or
137            zones being analyzed when determining whether there is a
138            possibility of validation failure.  When a key is rolled (that
139            is, replaced with a new key), there must be enough time
140            for the old DNSKEY RRset to have expired from resolver caches
141            before the new key is activated and begins generating
142            signatures.  If that condition does not apply, a warning
143            will be generated.
144          </p>
145<p>
146            The length of the TTL can be set in seconds, or in larger units
147            of time by adding a suffix: 'mi' for minutes, 'h' for hours,
148            'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
149          </p>
150<p>
151            This option is mandatory unless the <code class="option">-f</code> has
152            been used to specify a zone file, or a default key TTL was
153            set with the <code class="option">-L</code> to
154            <span><strong class="command">dnssec-keygen</strong></span>.  (If either of those is true,
155            this option may still be used; it will override the value found
156            in the zone or key file.)
157          </p>
158</dd>
159<dt><span class="term">-r <em class="replaceable"><code>resign interval</code></em></span></dt>
160<dd>
161<p>
162            Sets the value to be used as the resign interval for the zone
163            or zones being analyzed when determining whether there is a
164            possibility of validation failure.  This value defaults to
165            22.5 days, which is also the default in
166            <span><strong class="command">named</strong></span>.  However, if it has been changed
167            by the <code class="option">sig-validity-interval</code> option in
168            <code class="filename">named.conf</code>, then it should also be
169            changed here.
170          </p>
171<p>
172            The length of the interval can be set in seconds, or in larger
173            units of time by adding a suffix: 'mi' for minutes, 'h' for hours,
174            'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
175          </p>
176</dd>
177<dt><span class="term">-k</span></dt>
178<dd><p>
179	    Only check KSK coverage; ignore ZSK events. Cannot be
180            used with <code class="option">-z</code>.
181          </p></dd>
182<dt><span class="term">-z</span></dt>
183<dd><p>
184	    Only check ZSK coverage; ignore KSK events. Cannot be
185            used with <code class="option">-k</code>.
186          </p></dd>
187<dt><span class="term">-c <em class="replaceable"><code>compilezone path</code></em></span></dt>
188<dd><p>
189            Specifies a path to a <span><strong class="command">named-compilezone</strong></span> binary.
190            Used for testing.
191          </p></dd>
192</dl></div>
193</div>
194<div class="refsect1" lang="en">
195<a name="id2617938"></a><h2>SEE ALSO</h2>
196<p>
197      <span class="citerefentry"><span class="refentrytitle">dnssec-checkds</span>(8)</span>,
198      <span class="citerefentry"><span class="refentrytitle">dnssec-dsfromkey</span>(8)</span>,
199      <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
200      <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>
201    </p>
202</div>
203<div class="refsect1" lang="en">
204<a name="id2617981"></a><h2>AUTHOR</h2>
205<p><span class="corpauthor">Internet Systems Consortium</span>
206    </p>
207</div>
208</div>
209<div class="navfooter">
210<hr>
211<table width="100%" summary="Navigation footer">
212<tr>
213<td width="40%" align="left">
214<a accesskey="p" href="man.dnssec-checkds.html">Prev</a>�</td>
215<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
216<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-dsfromkey.html">Next</a>
217</td>
218</tr>
219<tr>
220<td width="40%" align="left" valign="top">
221<span class="application">dnssec-checkds</span>�</td>
222<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
223<td width="40%" align="right" valign="top">�<span class="application">dnssec-dsfromkey</span>
224</td>
225</tr>
226</table>
227</div>
228<p style="text-align: center;">BIND 9.10.2-P4</p>
229</body>
230</html>
231