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