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