external/bsd/bind/dist/bin/python/dnssec-coverage.html

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