cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-coverage">

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <info>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <date>2014-01-11</date>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </info>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <refentryinfo>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <corpname>ISC</corpname>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <corpauthor>Internet Systems Consortium, Inc.</corpauthor>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </refentryinfo>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <refmeta>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <refentrytitle><application>dnssec-coverage</application></refentrytitle>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <manvolnum>8</manvolnum>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <refmiscinfo>BIND9</refmiscinfo>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </refmeta>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <refnamediv>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <refname><application>dnssec-coverage</application></refname>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <refpurpose>checks future DNSKEY coverage for a zone</refpurpose>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed </refnamediv>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <docinfo>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <copyright>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <year>2013</year>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <year>2014</year>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <holder>Internet Systems Consortium, Inc. ("ISC")</holder>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed </copyright>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed </docinfo>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <refsynopsisdiv>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <cmdsynopsis sepchar=" ">

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <command>dnssec-coverage</command>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <arg choice="opt" rep="norepeat"><option>-l <replaceable class="parameter">length</replaceable></option></arg>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">file</replaceable></option></arg>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <arg choice="opt" rep="norepeat"><option>-d <replaceable class="parameter">DNSKEY TTL</replaceable></option></arg>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">max TTL</replaceable></option></arg>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">interval</replaceable></option></arg>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">compilezone path</replaceable></option></arg>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat"><option>-k</option></arg>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <arg choice="opt" rep="norepeat"><option>-z</option></arg>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <arg choice="opt" rep="norepeat">zone</arg>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed </cmdsynopsis>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed </refsynopsisdiv>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <refsection><info><title>DESCRIPTION</title></info>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <para><command>dnssec-coverage</command>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User verifies that the DNSSEC keys for a given zone or a set of zones

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed have timing metadata set properly to ensure no future lapses in DNSSEC

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed coverage.

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </para>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <para>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User If <option>zone</option> is specified, then keys found in

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed the key repository matching that zone are scanned, and an ordered

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed list is generated of the events scheduled for that key (i.e.,

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed publication, activation, inactivation, deletion). The list of

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed events is walked in order of occurrence. Warnings are generated

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User if any event is scheduled which could cause the zone to enter a

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed state in which validation failures might occur: for example, if

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User the number of published or active keys for a given algorithm drops

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed to zero, or if a key is deleted from the zone too soon after a new

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed key is rolled, and cached data signed by the prior key has not had

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User time to expire from resolver caches.

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed </para>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <para>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed If <option>zone</option> is not specified, then all keys in the

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User key repository will be scanned, and all zones for which there are

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed keys will be analyzed. (Note: This method of reporting is only

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User accurate if all the zones that have keys in a given repository

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User share the same TTL parameters.)

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </para>

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User </refsection>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <refsection><info><title>OPTIONS</title></info>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed

fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <variablelist>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <varlistentry>

cdcd52e680bd80f0da612c0fcf949b50ef86500bJeremy Reed <term>-K <replaceable class="parameter">directory</replaceable></term>

<listitem>

<para>

Sets the directory in which keys can be found. Defaults to the

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 override

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 override 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>

</refsection>

<refsection><info><title>SEE ALSO</title></info>

<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>

</refsection>

</refentry>