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