contrib/bind9/doc/arm/man.dnssec-coverage.html

   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$ -->
  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">-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>] [zone]</p></div>
  51 </div>
  52 <div class="refsect1" lang="en">
  53 <a name="id2614656"></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="id2614750"></a><h2>OPTIONS</h2>
  82 <div class="variablelist"><dl>
  83 <dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
  84 <dd><p>
  85             If a <code class="option">file</code> is specified, then the zone is
  86             read from that file; the largest TTL and the DNSKEY TTL are
  87             determined directly from the zone data, and the
  88             <code class="option">-m</code> and <code class="option">-d</code> options do
  89             not need to be specified on the command line.
  90           </p></dd>
  91 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
  92 <dd><p>
  93             Sets the directory in which keys can be found.  Defaults to the
  94             current working directory.
  95           </p></dd>
  96 <dt><span class="term">-m <em class="replaceable"><code>maximum TTL</code></em></span></dt>
  97 <dd>
  98 <p>
  99             Sets the value to be used as the maximum TTL for the zone or
 100             zones being analyzed when determining whether there is a
 101             possibility of validation failure.  When a zone-signing key is
 102             deactivated, there must be enough time for the record in the
 103             zone with the longest TTL to have expired from resolver caches
 104             before that key can be purged from the DNSKEY RRset.  If that
 105             condition does not apply, a warning will be generated.
 106           </p>
 107 <p>
 108             The length of the TTL can be set in seconds, or in larger units
 109             of time by adding a suffix: 'mi' for minutes, 'h' for hours,
 110             'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
 111           </p>
 112 <p>
 113             This option is mandatory unless the <code class="option">-f</code> has
 114             been used to specify a zone file.  (If <code class="option">-f</code> has
 115             been specified, this option may still be used; it will override
 116             the value found in the file.)
 117           </p>
 118 </dd>
 119 <dt><span class="term">-d <em class="replaceable"><code>DNSKEY TTL</code></em></span></dt>
 120 <dd>
 121 <p>
 122             Sets the value to be used as the DNSKEY TTL for the zone or
 123             zones being analyzed when determining whether there is a
 124             possibility of validation failure.  When a key is rolled (that
 125             is, replaced with a new key), there must be enough time
 126             for the old DNSKEY RRset to have expired from resolver caches
 127             before the new key is activated and begins generating
 128             signatures.  If that condition does not apply, a warning
 129             will be generated.
 130           </p>
 131 <p>
 132             The length of the TTL can be set in seconds, or in larger units
 133             of time by adding a suffix: 'mi' for minutes, 'h' for hours,
 134             'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
 135           </p>
 136 <p>
 137             This option is mandatory unless the <code class="option">-f</code> has
 138             been used to specify a zone file, or a default key TTL was
 139             set with the <code class="option">-L</code> to
 140             <span><strong class="command">dnssec-keygen</strong></span>.  (If either of those is true,
 141             this option may still be used; it will override the value found
 142             in the zone or key file.)
 143           </p>
 144 </dd>
 145 <dt><span class="term">-r <em class="replaceable"><code>resign interval</code></em></span></dt>
 146 <dd>
 147 <p>
 148             Sets the value to be used as the resign interval for the zone
 149             or zones being analyzed when determining whether there is a
 150             possibility of validation failure.  This value defaults to
 151             22.5 days, which is also the default in
 152             <span><strong class="command">named</strong></span>.  However, if it has been changed
 153             by the <code class="option">sig-validity-interval</code> option in
 154             <code class="filename">named.conf</code>, then it should also be
 155             changed here.
 156           </p>
 157 <p>
 158             The length of the interval can be set in seconds, or in larger
 159             units of time by adding a suffix: 'mi' for minutes, 'h' for hours,
 160             'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
 161           </p>
 162 </dd>
 163 <dt><span class="term">-c <em class="replaceable"><code>compilezone path</code></em></span></dt>
 164 <dd><p>
 165             Specifies a path to a <span><strong class="command">named-compilezone</strong></span> binary.
 166             Used for testing.
 167           </p></dd>
 168 </dl></div>
 169 </div>
 170 <div class="refsect1" lang="en">
 171 <a name="id2615479"></a><h2>SEE ALSO</h2>
 172 <p>
 173       <span class="citerefentry"><span class="refentrytitle">dnssec-checkds</span>(8)</span>,
 174       <span class="citerefentry"><span class="refentrytitle">dnssec-dsfromkey</span>(8)</span>,
 175       <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 176       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>
 177     </p>
 178 </div>
 179 <div class="refsect1" lang="en">
 180 <a name="id2615523"></a><h2>AUTHOR</h2>
 181 <p><span class="corpauthor">Internet Systems Consortium</span>
 182     </p>
 183 </div>
 184 </div>
 185 <div class="navfooter">
 186 <hr>
 187 <table width="100%" summary="Navigation footer">
 188 <tr>
 189 <td width="40%" align="left">
 190 <a accesskey="p" href="man.dnssec-checkds.html">Prev</a> </td>
 191 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
 192 <td width="40%" align="right"> <a accesskey="n" href="man.dnssec-dsfromkey.html">Next</a>
 193 </td>
 194 </tr>
 195 <tr>
 196 <td width="40%" align="left" valign="top">
 197 <span class="application">dnssec-checkds</span> </td>
 198 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 199 <td width="40%" align="right" valign="top"> <span class="application">dnssec-dsfromkey</span>
 200 </td>
 201 </tr>
 202 </table>
 203 </div>
 204 <p style="text-align: center;">BIND 9.9.8-P3 (Extended Support Version)</p>
 205 </body>
 206 </html>