dnssec-coverage.docbook revision f70a10508f030b097a9b8afe907a06f9a1e2c4d4
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync [<!ENTITY mdash "&#8212;">]>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<!--
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync -
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - Permission to use, copy, modify, and/or distribute this software for any
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - purpose with or without fee is hereby granted, provided that the above
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - copyright notice and this permission notice appear in all copies.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync -
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync - PERFORMANCE OF THIS SOFTWARE.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync-->
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<refentry id="man.dnssec-coverage">
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <refentryinfo>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <date>April 16, 2012</date>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </refentryinfo>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <refmeta>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <refentrytitle><application>dnssec-coverage</application></refentrytitle>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <manvolnum>8</manvolnum>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <refmiscinfo>BIND9</refmiscinfo>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </refmeta>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <refnamediv>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <refname><application>dnssec-coverage</application></refname>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <refpurpose>checks future DNSKEY coverage for a zone</refpurpose>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </refnamediv>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <docinfo>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <copyright>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <year>2013</year>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <year>2014</year>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </copyright>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </docinfo>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <refsynopsisdiv>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <cmdsynopsis>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <command>dnssec-coverage</command>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <arg><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <arg><option>-l <replaceable class="parameter">length</replaceable></option></arg>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <arg><option>-f <replaceable class="parameter">file</replaceable></option></arg>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <arg><option>-d <replaceable class="parameter">DNSKEY TTL</replaceable></option></arg>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <arg><option>-m <replaceable class="parameter">max TTL</replaceable></option></arg>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <arg><option>-r <replaceable class="parameter">interval</replaceable></option></arg>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <arg><option>-c <replaceable class="parameter">compilezone path</replaceable></option></arg>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <arg><option>-k</option></arg>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <arg><option>-z</option></arg>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <arg choice="opt">zone</arg>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </cmdsynopsis>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </refsynopsisdiv>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <refsect1>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <title>DESCRIPTION</title>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <para><command>dnssec-coverage</command>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync verifies that the DNSSEC keys for a given zone or a set of zones
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync have timing metadata set properly to ensure no future lapses in DNSSEC
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync coverage.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </para>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <para>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync If <option>zone</option> is specified, then keys found in
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync the key repository matching that zone are scanned, and an ordered
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync list is generated of the events scheduled for that key (i.e.,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync publication, activation, inactivation, deletion). The list of
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync events is walked in order of occurrence. Warnings are generated
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync if any event is scheduled which could cause the zone to enter a
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync state in which validation failures might occur: for example, if
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync the number of published or active keys for a given algorithm drops
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync to zero, or if a key is deleted from the zone too soon after a new
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync key is rolled, and cached data signed by the prior key has not had
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync time to expire from resolver caches.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </para>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <para>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync If <option>zone</option> is not specified, then all keys in the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync key repository will be scanned, and all zones for which there are
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync keys will be analyzed. (Note: This method of reporting is only
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync accurate if all the zones that have keys in a given repository
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync share the same TTL parameters.)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </para>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync </refsect1>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <refsect1>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <title>OPTIONS</title>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <variablelist>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <varlistentry>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <term>-K <replaceable class="parameter">directory</replaceable></term>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <listitem>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync <para>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync Sets the directory in which keys can be found. Defaults to the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync current working directory.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-f <replaceable class="parameter">file</replaceable></term>
<listitem>
<para>
If a <option>file</option> is specified, then the zone is
read from that file; the largest TTL and the DNSKEY TTL are
determined directly from the zone data, and the
<option>-m</option> and <option>-d</option> options do
not need to be specified on the command line.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-l <replaceable class="parameter">duration</replaceable></term>
<listitem>
<para>
The length of time to check for DNSSEC coverage. Key events
scheduled further into the future than <option>duration</option>
will be ignored, and assumed to be correct.
</para>
<para>
The value of <option>duration</option> can be set in seconds,
or in larger units of time by adding a suffix: 'mi' for minutes,
'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months,
'y' for years.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-m <replaceable class="parameter">maximum TTL</replaceable></term>
<listitem>
<para>
Sets the value to be used as the maximum TTL for the zone or
zones being analyzed when determining whether there is a
possibility of validation failure. When a zone-signing key is
deactivated, there must be enough time for the record in the
zone with the longest TTL to have expired from resolver caches
before that key can be purged from the DNSKEY RRset. If that
condition does not apply, a warning will be generated.
</para>
<para>
The length of the TTL can be set in seconds, or in larger units
of time by adding a suffix: 'mi' for minutes, 'h' for hours,
'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
</para>
<para>
This option is mandatory unless the <option>-f</option> has
been used to specify a zone file. (If <option>-f</option> has
been specified, this option may still be used; it will overrde
the value found in the file.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-d <replaceable class="parameter">DNSKEY TTL</replaceable></term>
<listitem>
<para>
Sets the value to be used as the DNSKEY TTL for the zone or
zones being analyzed when determining whether there is a
possibility of validation failure. When a key is rolled (that
is, replaced with a new key), there must be enough time
for the old DNSKEY RRset to have expired from resolver caches
before the new key is activated and begins generating
signatures. If that condition does not apply, a warning
will be generated.
</para>
<para>
The length of the TTL can be set in seconds, or in larger units
of time by adding a suffix: 'mi' for minutes, 'h' for hours,
'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
</para>
<para>
This option is mandatory unless the <option>-f</option> has
been used to specify a zone file, or a default key TTL was
set with the <option>-L</option> to
<command>dnssec-keygen</command>. (If either of those is true,
this option may still be used; it will overrde the value found
in the zone or key file.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-r <replaceable class="parameter">resign interval</replaceable></term>
<listitem>
<para>
Sets the value to be used as the resign interval for the zone
or zones being analyzed when determining whether there is a
possibility of validation failure. This value defaults to
22.5 days, which is also the default in
<command>named</command>. However, if it has been changed
by the <option>sig-validity-interval</option> option in
<filename>named.conf</filename>, then it should also be
changed here.
</para>
<para>
The length of the interval can be set in seconds, or in larger
units of time by adding a suffix: 'mi' for minutes, 'h' for hours,
'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-k</term>
<listitem>
<para>
Only check KSK coverage; ignore ZSK events. Cannot be
used with <option>-z</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-z</term>
<listitem>
<para>
Only check ZSK coverage; ignore KSK events. Cannot be
used with <option>-k</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-c <replaceable class="parameter">compilezone path</replaceable></term>
<listitem>
<para>
Specifies a path to a <command>named-compilezone</command> binary.
Used for testing.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>dnssec-checkds</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>dnssec-dsfromkey</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para><corpauthor>Internet Systems Consortium</corpauthor>
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->