|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
- Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
Packit |
5ce601 |
-
|
|
Packit |
5ce601 |
- This Source Code Form is subject to the terms of the Mozilla Public
|
|
Packit |
5ce601 |
- License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
Packit Service |
704ed8 |
- file, you can obtain one at https://mozilla.org/MPL/2.0/.
|
|
Packit |
5ce601 |
-
|
|
Packit |
5ce601 |
- See the COPYRIGHT file distributed with this work for additional
|
|
Packit |
5ce601 |
- information regarding copyright ownership.
|
|
Packit |
5ce601 |
-->
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
|
|
Packit Service |
d3afd5 |
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dnssec-coverage">
|
|
Packit |
5ce601 |
<info>
|
|
Packit |
5ce601 |
<date>2014-01-11</date>
|
|
Packit |
5ce601 |
</info>
|
|
Packit |
5ce601 |
<refentryinfo>
|
|
Packit |
5ce601 |
<corpname>ISC</corpname>
|
|
Packit |
5ce601 |
<corpauthor>Internet Systems Consortium, Inc.</corpauthor>
|
|
Packit |
5ce601 |
</refentryinfo>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<refmeta>
|
|
Packit |
5ce601 |
<refentrytitle><application>dnssec-coverage</application></refentrytitle>
|
|
Packit |
5ce601 |
<manvolnum>8</manvolnum>
|
|
Packit Service |
d3afd5 |
<refmiscinfo>BIND9</refmiscinfo>
|
|
Packit |
5ce601 |
</refmeta>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<refnamediv>
|
|
Packit |
5ce601 |
<refname><application>dnssec-coverage</application></refname>
|
|
Packit |
5ce601 |
<refpurpose>checks future DNSKEY coverage for a zone</refpurpose>
|
|
Packit |
5ce601 |
</refnamediv>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<docinfo>
|
|
Packit |
5ce601 |
<copyright>
|
|
Packit |
5ce601 |
<year>2013</year>
|
|
Packit |
5ce601 |
<year>2014</year>
|
|
Packit |
5ce601 |
<year>2015</year>
|
|
Packit |
5ce601 |
<year>2016</year>
|
|
Packit |
5ce601 |
<year>2018</year>
|
|
Packit |
5ce601 |
<year>2019</year>
|
|
Packit |
5ce601 |
<year>2020</year>
|
|
Packit |
5ce601 |
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
|
|
Packit |
5ce601 |
</copyright>
|
|
Packit |
5ce601 |
</docinfo>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<refsynopsisdiv>
|
|
Packit |
5ce601 |
<cmdsynopsis sepchar=" ">
|
|
Packit |
5ce601 |
<command>dnssec-coverage</command>
|
|
Packit |
5ce601 |
<arg choice="opt" rep="norepeat"><option>-K <replaceable class="parameter">directory</replaceable></option></arg>
|
|
Packit |
5ce601 |
<arg choice="opt" rep="norepeat"><option>-l <replaceable class="parameter">length</replaceable></option></arg>
|
|
Packit |
5ce601 |
<arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">file</replaceable></option></arg>
|
|
Packit |
5ce601 |
<arg choice="opt" rep="norepeat"><option>-d <replaceable class="parameter">DNSKEY TTL</replaceable></option></arg>
|
|
Packit |
5ce601 |
<arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">max TTL</replaceable></option></arg>
|
|
Packit |
5ce601 |
<arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">interval</replaceable></option></arg>
|
|
Packit |
5ce601 |
<arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">compilezone path</replaceable></option></arg>
|
|
Packit |
5ce601 |
<arg choice="opt" rep="norepeat"><option>-k</option></arg>
|
|
Packit |
5ce601 |
<arg choice="opt" rep="norepeat"><option>-z</option></arg>
|
|
Packit |
5ce601 |
<arg choice="opt" rep="repeat">zone</arg>
|
|
Packit |
5ce601 |
</cmdsynopsis>
|
|
Packit |
5ce601 |
</refsynopsisdiv>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<refsection><info><title>DESCRIPTION</title></info>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<para><command>dnssec-coverage</command>
|
|
Packit |
5ce601 |
verifies that the DNSSEC keys for a given zone or a set of zones
|
|
Packit |
5ce601 |
have timing metadata set properly to ensure no future lapses in DNSSEC
|
|
Packit |
5ce601 |
coverage.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
If <option>zone</option> is specified, then keys found in
|
|
Packit |
5ce601 |
the key repository matching that zone are scanned, and an ordered
|
|
Packit |
5ce601 |
list is generated of the events scheduled for that key (i.e.,
|
|
Packit |
5ce601 |
publication, activation, inactivation, deletion). The list of
|
|
Packit |
5ce601 |
events is walked in order of occurrence. Warnings are generated
|
|
Packit |
5ce601 |
if any event is scheduled which could cause the zone to enter a
|
|
Packit |
5ce601 |
state in which validation failures might occur: for example, if
|
|
Packit |
5ce601 |
the number of published or active keys for a given algorithm drops
|
|
Packit |
5ce601 |
to zero, or if a key is deleted from the zone too soon after a new
|
|
Packit |
5ce601 |
key is rolled, and cached data signed by the prior key has not had
|
|
Packit |
5ce601 |
time to expire from resolver caches.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
If <option>zone</option> is not specified, then all keys in the
|
|
Packit |
5ce601 |
key repository will be scanned, and all zones for which there are
|
|
Packit |
5ce601 |
keys will be analyzed. (Note: This method of reporting is only
|
|
Packit |
5ce601 |
accurate if all the zones that have keys in a given repository
|
|
Packit |
5ce601 |
share the same TTL parameters.)
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</refsection>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<refsection><info><title>OPTIONS</title></info>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<variablelist>
|
|
Packit |
5ce601 |
<varlistentry>
|
|
Packit |
5ce601 |
<term>-K <replaceable class="parameter">directory</replaceable></term>
|
|
Packit |
5ce601 |
<listitem>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
Sets the directory in which keys can be found. Defaults to the
|
|
Packit |
5ce601 |
current working directory.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</listitem>
|
|
Packit |
5ce601 |
</varlistentry>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<varlistentry>
|
|
Packit |
5ce601 |
<term>-f <replaceable class="parameter">file</replaceable></term>
|
|
Packit |
5ce601 |
<listitem>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
If a <option>file</option> is specified, then the zone is
|
|
Packit |
5ce601 |
read from that file; the largest TTL and the DNSKEY TTL are
|
|
Packit |
5ce601 |
determined directly from the zone data, and the
|
|
Packit |
5ce601 |
<option>-m</option> and <option>-d</option> options do
|
|
Packit |
5ce601 |
not need to be specified on the command line.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</listitem>
|
|
Packit |
5ce601 |
</varlistentry>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<varlistentry>
|
|
Packit |
5ce601 |
<term>-l <replaceable class="parameter">duration</replaceable></term>
|
|
Packit |
5ce601 |
<listitem>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
The length of time to check for DNSSEC coverage. Key events
|
|
Packit |
5ce601 |
scheduled further into the future than <option>duration</option>
|
|
Packit |
5ce601 |
will be ignored, and assumed to be correct.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
The value of <option>duration</option> can be set in seconds,
|
|
Packit |
5ce601 |
or in larger units of time by adding a suffix: 'mi' for minutes,
|
|
Packit |
5ce601 |
'h' for hours, 'd' for days, 'w' for weeks, 'mo' for months,
|
|
Packit |
5ce601 |
'y' for years.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</listitem>
|
|
Packit |
5ce601 |
</varlistentry>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<varlistentry>
|
|
Packit |
5ce601 |
<term>-m <replaceable class="parameter">maximum TTL</replaceable></term>
|
|
Packit |
5ce601 |
<listitem>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
Sets the value to be used as the maximum TTL for the zone or
|
|
Packit |
5ce601 |
zones being analyzed when determining whether there is a
|
|
Packit |
5ce601 |
possibility of validation failure. When a zone-signing key is
|
|
Packit |
5ce601 |
deactivated, there must be enough time for the record in the
|
|
Packit |
5ce601 |
zone with the longest TTL to have expired from resolver caches
|
|
Packit |
5ce601 |
before that key can be purged from the DNSKEY RRset. If that
|
|
Packit |
5ce601 |
condition does not apply, a warning will be generated.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
The length of the TTL can be set in seconds, or in larger units
|
|
Packit |
5ce601 |
of time by adding a suffix: 'mi' for minutes, 'h' for hours,
|
|
Packit |
5ce601 |
'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
This option is not necessary if the <option>-f</option> has
|
|
Packit |
5ce601 |
been used to specify a zone file. If <option>-f</option> has
|
|
Packit |
5ce601 |
been specified, this option may still be used; it will override
|
|
Packit |
5ce601 |
the value found in the file.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
If this option is not used and the maximum TTL cannot be retrieved
|
|
Packit |
5ce601 |
from a zone file, a warning is generated and a default value of
|
|
Packit |
5ce601 |
1 week is used.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</listitem>
|
|
Packit |
5ce601 |
</varlistentry>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<varlistentry>
|
|
Packit |
5ce601 |
<term>-d <replaceable class="parameter">DNSKEY TTL</replaceable></term>
|
|
Packit |
5ce601 |
<listitem>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
Sets the value to be used as the DNSKEY TTL for the zone or
|
|
Packit |
5ce601 |
zones being analyzed when determining whether there is a
|
|
Packit |
5ce601 |
possibility of validation failure. When a key is rolled (that
|
|
Packit |
5ce601 |
is, replaced with a new key), there must be enough time for the
|
|
Packit |
5ce601 |
old DNSKEY RRset to have expired from resolver caches before
|
|
Packit |
5ce601 |
the new key is activated and begins generating signatures. If
|
|
Packit |
5ce601 |
that condition does not apply, a warning will be generated.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
The length of the TTL can be set in seconds, or in larger units
|
|
Packit |
5ce601 |
of time by adding a suffix: 'mi' for minutes, 'h' for hours,
|
|
Packit |
5ce601 |
'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
This option is not necessary if <option>-f</option> has
|
|
Packit |
5ce601 |
been used to specify a zone file from which the TTL
|
|
Packit |
5ce601 |
of the DNSKEY RRset can be read, or if a default key TTL was
|
|
Packit |
5ce601 |
set using ith the <option>-L</option> to
|
|
Packit |
5ce601 |
<command>dnssec-keygen</command>. If either of those is true,
|
|
Packit |
5ce601 |
this option may still be used; it will override the values
|
|
Packit |
5ce601 |
found in the zone file or the key file.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
If this option is not used and the key TTL cannot be retrieved
|
|
Packit |
5ce601 |
from the zone file or the key file, then a warning is generated
|
|
Packit |
5ce601 |
and a default value of 1 day is used.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</listitem>
|
|
Packit |
5ce601 |
</varlistentry>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<varlistentry>
|
|
Packit |
5ce601 |
<term>-r <replaceable class="parameter">resign interval</replaceable></term>
|
|
Packit |
5ce601 |
<listitem>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
Sets the value to be used as the resign interval for the zone
|
|
Packit |
5ce601 |
or zones being analyzed when determining whether there is a
|
|
Packit |
5ce601 |
possibility of validation failure. This value defaults to
|
|
Packit |
5ce601 |
22.5 days, which is also the default in
|
|
Packit |
5ce601 |
<command>named</command>. However, if it has been changed
|
|
Packit |
5ce601 |
by the <option>sig-validity-interval</option> option in
|
|
Packit |
5ce601 |
<filename>named.conf</filename>, then it should also be
|
|
Packit |
5ce601 |
changed here.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
The length of the interval can be set in seconds, or in larger
|
|
Packit |
5ce601 |
units of time by adding a suffix: 'mi' for minutes, 'h' for hours,
|
|
Packit |
5ce601 |
'd' for days, 'w' for weeks, 'mo' for months, 'y' for years.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</listitem>
|
|
Packit |
5ce601 |
</varlistentry>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<varlistentry>
|
|
Packit |
5ce601 |
<term>-k</term>
|
|
Packit |
5ce601 |
<listitem>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
Only check KSK coverage; ignore ZSK events. Cannot be
|
|
Packit |
5ce601 |
used with <option>-z</option>.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</listitem>
|
|
Packit |
5ce601 |
</varlistentry>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<varlistentry>
|
|
Packit |
5ce601 |
<term>-z</term>
|
|
Packit |
5ce601 |
<listitem>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
Only check ZSK coverage; ignore KSK events. Cannot be
|
|
Packit |
5ce601 |
used with <option>-k</option>.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</listitem>
|
|
Packit |
5ce601 |
</varlistentry>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<varlistentry>
|
|
Packit |
5ce601 |
<term>-c <replaceable class="parameter">compilezone path</replaceable></term>
|
|
Packit |
5ce601 |
<listitem>
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
Specifies a path to a <command>named-compilezone</command> binary.
|
|
Packit |
5ce601 |
Used for testing.
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</listitem>
|
|
Packit |
5ce601 |
</varlistentry>
|
|
Packit |
5ce601 |
</variablelist>
|
|
Packit |
5ce601 |
</refsection>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<refsection><info><title>SEE ALSO</title></info>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
<para>
|
|
Packit |
5ce601 |
<citerefentry>
|
|
Packit |
5ce601 |
<refentrytitle>dnssec-checkds</refentrytitle><manvolnum>8</manvolnum>
|
|
Packit |
5ce601 |
</citerefentry>,
|
|
Packit |
5ce601 |
<citerefentry>
|
|
Packit |
5ce601 |
<refentrytitle>dnssec-dsfromkey</refentrytitle><manvolnum>8</manvolnum>
|
|
Packit |
5ce601 |
</citerefentry>,
|
|
Packit |
5ce601 |
<citerefentry>
|
|
Packit |
5ce601 |
<refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
|
|
Packit |
5ce601 |
</citerefentry>,
|
|
Packit |
5ce601 |
<citerefentry>
|
|
Packit |
5ce601 |
<refentrytitle>dnssec-signzone</refentrytitle><manvolnum>8</manvolnum>
|
|
Packit |
5ce601 |
</citerefentry>
|
|
Packit |
5ce601 |
</para>
|
|
Packit |
5ce601 |
</refsection>
|
|
Packit |
5ce601 |
|
|
Packit |
5ce601 |
</refentry>
|