dnssec-coverage.html revision 5347c0fcb04eaea19d9f39795646239f487c6207
2N/A<!--
2N/A - Copyright (C) 2013-2016 Internet Systems Consortium, Inc. ("ISC")
2N/A -
2N/A - This Source Code Form is subject to the terms of the Mozilla Public
2N/A - License, v. 2.0. If a copy of the MPL was not distributed with this
2N/A - file, You can obtain one at http://mozilla.org/MPL/2.0/.
2N/A-->
2N/A<html>
2N/A<head>
2N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
2N/A<title>dnssec-coverage</title>
2N/A<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
2N/A</head>
2N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
2N/A<a name="man.dnssec-coverage"></a><div class="titlepage"></div>
2N/A<div class="refnamediv">
2N/A<h2>Name</h2>
2N/A<p><span class="application">dnssec-coverage</span> &#8212; checks future DNSKEY coverage for a zone</p>
2N/A</div>
2N/A<div class="refsynopsisdiv">
2N/A<h2>Synopsis</h2>
2N/A<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>
2N/A</div>
2N/A<div class="refsection">
2N/A<a name="id-1.7"></a><h2>DESCRIPTION</h2>
2N/A<p><span class="command"><strong>dnssec-coverage</strong></span>
2N/A verifies that the DNSSEC keys for a given zone or a set of zones
2N/A have timing metadata set properly to ensure no future lapses in DNSSEC
2N/A coverage.
2N/A </p>
2N/A<p>
2N/A If <code class="option">zone</code> is specified, then keys found in
2N/A the key repository matching that zone are scanned, and an ordered
2N/A list is generated of the events scheduled for that key (i.e.,
2N/A publication, activation, inactivation, deletion). The list of
2N/A events is walked in order of occurrence. Warnings are generated
2N/A if any event is scheduled which could cause the zone to enter a
2N/A state in which validation failures might occur: for example, if
2N/A the number of published or active keys for a given algorithm drops
2N/A to zero, or if a key is deleted from the zone too soon after a new
2N/A key is rolled, and cached data signed by the prior key has not had
2N/A time to expire from resolver caches.
2N/A </p>
2N/A<p>
2N/A If <code class="option">zone</code> is not specified, then all keys in the
2N/A key repository will be scanned, and all zones for which there are
2N/A keys will be analyzed. (Note: This method of reporting is only
2N/A accurate if all the zones that have keys in a given repository
2N/A share the same TTL parameters.)
2N/A </p>
2N/A</div>
2N/A<div class="refsection">
2N/A<a name="id-1.8"></a><h2>OPTIONS</h2>
2N/A<div class="variablelist"><dl class="variablelist">
2N/A<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
2N/A<dd><p>
2N/A Sets the directory in which keys can be found. Defaults to the
2N/A current working directory.
2N/A </p></dd>
2N/A<dt><span class="term">-f <em class="replaceable"><code>file</code></em></span></dt>
2N/A<dd><p>
2N/A If a <code class="option">file</code> is specified, then the zone is
2N/A read from that file; the largest TTL and the DNSKEY TTL are
2N/A determined directly from the zone data, and the
2N/A <code class="option">-m</code> and <code class="option">-d</code> options do
2N/A not need to be specified on the command line.
2N/A </p></dd>
2N/A<dt><span class="term">-l <em class="replaceable"><code>duration</code></em></span></dt>
2N/A<dd>
2N/A<p>
2N/A The length of time to check for DNSSEC coverage. Key events
2N/A scheduled further into the future than <code class="option">duration</code>
2N/A will be ignored, and assumed to be correct.
2N/A </p>
2N/A<p>
2N/A The value of <code class="option">duration</code> can be set in seconds,
2N/A or in larger units of time by adding a suffix: 'mi' for minutes,
2N/A 'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months,
2N/A 'y' for years.
2N/A </p>
2N/A</dd>
2N/A<dt><span class="term">-m <em class="replaceable"><code>maximum TTL</code></em></span></dt>
2N/A<dd>
2N/A<p>
2N/A Sets the value to be used as the maximum TTL for the zone or
2N/A zones being analyzed when determining whether there is a
2N/A possibility of validation failure. When a zone-signing key is
2N/A deactivated, there must be enough time for the record in the
2N/A zone with the longest TTL to have expired from resolver caches
2N/A before that key can be purged from the DNSKEY RRset. If that
2N/A condition does not apply, a warning will be generated.
2N/A </p>
2N/A<p>
2N/A The length of the TTL can be set in seconds, or in larger units
2N/A of time by adding a suffix: 'mi' for minutes, 'h' for hours,
2N/A 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
2N/A </p>
2N/A<p>
2N/A This option is not necessary if the <code class="option">-f</code> has
2N/A been used to specify a zone file. If <code class="option">-f</code> has
2N/A been specified, this option may still be used; it will override
2N/A the value found in the file.
2N/A </p>
2N/A<p>
2N/A If this option is not used and the maximum TTL cannot be retrieved
2N/A from a zone file, a warning is generated and a default value of
2N/A 1 week is used.
2N/A </p>
2N/A</dd>
2N/A<dt><span class="term">-d <em class="replaceable"><code>DNSKEY TTL</code></em></span></dt>
2N/A<dd>
2N/A<p>
2N/A Sets the value to be used as the DNSKEY TTL for the zone or
2N/A zones being analyzed when determining whether there is a
2N/A possibility of validation failure. When a key is rolled (that
2N/A is, replaced with a new key), there must be enough time for the
2N/A old DNSKEY RRset to have expired from resolver caches before
2N/A the new key is activated and begins generating signatures. If
2N/A that condition does not apply, a warning will be generated.
2N/A </p>
2N/A<p>
2N/A The length of the TTL can be set in seconds, or in larger units
2N/A of time by adding a suffix: 'mi' for minutes, 'h' for hours,
2N/A 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
2N/A </p>
2N/A<p>
2N/A This option is not necessary if <code class="option">-f</code> has
2N/A been used to specify a zone file from which the TTL
2N/A of the DNSKEY RRset can be read, or if a default key TTL was
2N/A set using ith the <code class="option">-L</code> to
2N/A <span class="command"><strong>dnssec-keygen</strong></span>. If either of those is true,
2N/A this option may still be used; it will override the values
2N/A found in the zone file or the key file.
2N/A </p>
2N/A<p>
2N/A If this option is not used and the key TTL cannot be retrieved
2N/A from the zone file or the key file, then a warning is generated
2N/A and a default value of 1 day is used.
2N/A </p>
2N/A</dd>
2N/A<dt><span class="term">-r <em class="replaceable"><code>resign interval</code></em></span></dt>
2N/A<dd>
2N/A<p>
2N/A Sets the value to be used as the resign interval for the zone
2N/A or zones being analyzed when determining whether there is a
2N/A possibility of validation failure. This value defaults to
2N/A 22.5 days, which is also the default in
2N/A <span class="command"><strong>named</strong></span>. However, if it has been changed
2N/A by the <code class="option">sig-validity-interval</code> option in
2N/A <code class="filename">named.conf</code>, then it should also be
2N/A changed here.
2N/A </p>
2N/A<p>
2N/A The length of the interval can be set in seconds, or in larger
2N/A units of time by adding a suffix: 'mi' for minutes, 'h' for hours,
2N/A 'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
2N/A </p>
2N/A</dd>
2N/A<dt><span class="term">-k</span></dt>
2N/A<dd><p>
2N/A Only check KSK coverage; ignore ZSK events. Cannot be
2N/A used with <code class="option">-z</code>.
2N/A </p></dd>
2N/A<dt><span class="term">-z</span></dt>
2N/A<dd><p>
2N/A Only check ZSK coverage; ignore KSK events. Cannot be
2N/A used with <code class="option">-k</code>.
2N/A </p></dd>
2N/A<dt><span class="term">-c <em class="replaceable"><code>compilezone path</code></em></span></dt>
2N/A<dd><p>
2N/A Specifies a path to a <span class="command"><strong>named-compilezone</strong></span> binary.
2N/A Used for testing.
2N/A </p></dd>
2N/A</dl></div>
2N/A</div>
2N/A<div class="refsection">
2N/A<a name="id-1.9"></a><h2>SEE ALSO</h2>
2N/A<p>
2N/A <span class="citerefentry"><span class="refentrytitle">dnssec-checkds</span>(8)</span>,
2N/A <span class="citerefentry"><span class="refentrytitle">dnssec-dsfromkey</span>(8)</span>,
2N/A <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
2N/A <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>
2N/A </p>
2N/A</div>
2N/A</div></body>
2N/A</html>
2N/A