From 330c9b32ba6d4c34bad8a625bec6df5bb13d0a7c Mon Sep 17 00:00:00 2001 From: Evan Hunt Date: Wed, 13 May 2020 14:19:50 -0700 Subject: [PATCH] convert python tools' man pages to RST --- bin/python/dnssec-checkds.8 | 95 ------- bin/python/dnssec-checkds.docbook | 148 ---------- bin/python/dnssec-checkds.html | 122 --------- bin/python/dnssec-checkds.rst | 67 +++++ bin/python/dnssec-coverage.8 | 156 ----------- bin/python/dnssec-coverage.docbook | 272 ------------------- bin/python/dnssec-coverage.html | 236 ---------------- bin/python/dnssec-coverage.rst | 151 +++++++++++ bin/python/dnssec-keymgr.8 | 298 -------------------- bin/python/dnssec-keymgr.docbook | 422 ----------------------------- bin/python/dnssec-keymgr.html | 371 ------------------------- bin/python/dnssec-keymgr.rst | 224 +++++++++++++++ doc/arm/manpages.rst | 3 + doc/man/dnssec-checkds.rst | 13 + doc/man/dnssec-coverage.rst | 13 + doc/man/dnssec-keymgr.rst | 13 + 16 files changed, 484 insertions(+), 2120 deletions(-) delete mode 100644 bin/python/dnssec-checkds.8 delete mode 100644 bin/python/dnssec-checkds.docbook delete mode 100644 bin/python/dnssec-checkds.html create mode 100644 bin/python/dnssec-checkds.rst delete mode 100644 bin/python/dnssec-coverage.8 delete mode 100644 bin/python/dnssec-coverage.docbook delete mode 100644 bin/python/dnssec-coverage.html create mode 100644 bin/python/dnssec-coverage.rst delete mode 100644 bin/python/dnssec-keymgr.8 delete mode 100644 bin/python/dnssec-keymgr.docbook delete mode 100644 bin/python/dnssec-keymgr.html create mode 100644 bin/python/dnssec-keymgr.rst create mode 100644 doc/man/dnssec-checkds.rst create mode 100644 doc/man/dnssec-coverage.rst create mode 100644 doc/man/dnssec-keymgr.rst diff --git a/bin/python/dnssec-checkds.8 b/bin/python/dnssec-checkds.8 deleted file mode 100644 index c85cbfc6917..00000000000 --- a/bin/python/dnssec-checkds.8 +++ /dev/null @@ -1,95 +0,0 @@ -.\" Copyright (C) 2012-2020 Internet Systems Consortium, Inc. ("ISC") -.\" -.\" This Source Code Form is subject to the terms of the Mozilla Public -.\" License, v. 2.0. If a copy of the MPL was not distributed with this -.\" file, You can obtain one at http://mozilla.org/MPL/2.0/. -.\" -.hy 0 -.ad l -'\" t -.\" Title: dnssec-checkds -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 2013-01-01 -.\" Manual: BIND9 -.\" Source: ISC -.\" Language: English -.\" -.TH "DNSSEC\-CHECKDS" "8" "2013\-01\-01" "ISC" "BIND9" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -dnssec-checkds \- DNSSEC delegation consistency checking tool -.SH "SYNOPSIS" -.HP \w'\fBdnssec\-checkds\fR\ 'u -\fBdnssec\-checkds\fR [\fB\-d\ \fR\fB\fIdig\ path\fR\fR] [\fB\-D\ \fR\fB\fIdsfromkey\ path\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-s\ \fR\fB\fIfile\fR\fR] {zone} -.SH "DESCRIPTION" -.PP -\fBdnssec\-checkds\fR -verifies the correctness of Delegation Signer (DS) resource records for keys in a specified zone\&. -.SH "OPTIONS" -.PP -\-a \fIalgorithm\fR -.RS 4 -Specify a digest algorithm to use when converting the zone\*(Aqs DNSKEY records to expected DS records\&. This option can be repeated, so that multiple records are checked for each DNSKEY record\&. -.sp -The -\fIalgorithm\fR -must be one of SHA\-1, SHA\-256, or SHA\-384\&. These values are case insensitive, and the hyphen may be omitted\&. If no algorithm is specified, the default is SHA\-256\&. -.RE -.PP -\-f \fIfile\fR -.RS 4 -If a -\fBfile\fR -is specified, then the zone is read from that file to find the DNSKEY records\&. If not, then the DNSKEY records for the zone are looked up in the DNS\&. -.RE -.PP -\-s \fIfile\fR -.RS 4 -Specifies a prepared dsset file, such as would be generated by -\fBdnssec\-signzone\fR, to use as a source for the DS RRset instead of querying the parent\&. -.RE -.PP -\-d \fIdig path\fR -.RS 4 -Specifies a path to a -\fBdig\fR -binary\&. Used for testing\&. -.RE -.PP -\-D \fIdsfromkey path\fR -.RS 4 -Specifies a path to a -\fBdnssec\-dsfromkey\fR -binary\&. Used for testing\&. -.RE -.SH "SEE ALSO" -.PP -\fBdnssec-dsfromkey\fR(8), -\fBdnssec-keygen\fR(8), -\fBdnssec-signzone\fR(8), -.SH "AUTHOR" -.PP -\fBInternet Systems Consortium, Inc\&.\fR -.SH "COPYRIGHT" -.br -Copyright \(co 2012-2020 Internet Systems Consortium, Inc. ("ISC") -.br diff --git a/bin/python/dnssec-checkds.docbook b/bin/python/dnssec-checkds.docbook deleted file mode 100644 index 3a86682b00e..00000000000 --- a/bin/python/dnssec-checkds.docbook +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - 2013-01-01 - - - ISC - Internet Systems Consortium, Inc. - - - - dnssec-checkds - 8 - BIND9 - - - - dnssec-checkds - DNSSEC delegation consistency checking tool - - - - - 2012 - 2013 - 2014 - 2015 - 2016 - 2017 - 2018 - 2019 - 2020 - Internet Systems Consortium, Inc. ("ISC") - - - - - - dnssec-checkds - - - - - - zone - - - - DESCRIPTION - - dnssec-checkds - verifies the correctness of Delegation Signer (DS) - resource records for keys in a specified zone. - - - - OPTIONS - - - - - -a algorithm - - - Specify a digest algorithm to use when converting the - zone's DNSKEY records to expected DS records. This - option can be repeated, so that multiple records are - checked for each DNSKEY record. - - - The algorithm must be one of - SHA-1, SHA-256, or SHA-384. These values are case insensitive, - and the hyphen may be omitted. If no algorithm is specified, - the default is SHA-256. - - - - - - -f file - - - If a is specified, then the zone is - read from that file to find the DNSKEY records. If not, - then the DNSKEY records for the zone are looked up in the DNS. - - - - - - -s file - - - Specifies a prepared dsset file, such as would be generated - by dnssec-signzone, to use as a source for - the DS RRset instead of querying the parent. - - - - - - -d dig path - - - Specifies a path to a dig binary. Used - for testing. - - - - - - -D dsfromkey path - - - Specifies a path to a dnssec-dsfromkey binary. - Used for testing. - - - - - - - SEE ALSO - - - dnssec-dsfromkey8 - , - - dnssec-keygen8 - , - - dnssec-signzone8 - , - - - - diff --git a/bin/python/dnssec-checkds.html b/bin/python/dnssec-checkds.html deleted file mode 100644 index 9e23bdcdc69..00000000000 --- a/bin/python/dnssec-checkds.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - -dnssec-checkds - - -
-
- - - - - -
-

Name

-

- dnssec-checkds - — DNSSEC delegation consistency checking tool -

-
- - - -
-

Synopsis

-

- dnssec-checkds - [-d dig path] - [-D dsfromkey path] - [-f file] - [-l domain] - [-s file] - {zone} -

-
- -
-

DESCRIPTION

- -

dnssec-checkds - verifies the correctness of Delegation Signer (DS) - resource records for keys in a specified zone. -

-
- -
-

OPTIONS

- -
-
-a algorithm
-
-

- Specify a digest algorithm to use when converting the - zone's DNSKEY records to expected DS records. This - option can be repeated, so that multiple records are - checked for each DNSKEY record. -

-

- The algorithm must be one of - SHA-1, SHA-256, or SHA-384. These values are case insensitive, - and the hyphen may be omitted. If no algorithm is specified, - the default is SHA-256. -

-
-
-f file
-
-

- If a file is specified, then the zone is - read from that file to find the DNSKEY records. If not, - then the DNSKEY records for the zone are looked up in the DNS. -

-
-
-s file
-
-

- Specifies a prepared dsset file, such as would be generated - by dnssec-signzone, to use as a source for - the DS RRset instead of querying the parent. -

-
-
-d dig path
-
-

- Specifies a path to a dig binary. Used - for testing. -

-
-
-D dsfromkey path
-
-

- Specifies a path to a dnssec-dsfromkey binary. - Used for testing. -

-
-
-
- -
-

SEE ALSO

- -

- dnssec-dsfromkey(8) - , - - dnssec-keygen(8) - , - - dnssec-signzone(8) - , -

-
- -
- diff --git a/bin/python/dnssec-checkds.rst b/bin/python/dnssec-checkds.rst new file mode 100644 index 00000000000..10a462eb16a --- /dev/null +++ b/bin/python/dnssec-checkds.rst @@ -0,0 +1,67 @@ +.. + Copyright (C) Internet Systems Consortium, Inc. ("ISC") + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + + See the COPYRIGHT file distributed with this work for additional + information regarding copyright ownership. + +.. highlight: console + +.. _man_dnssec-checkds: + +dnssec-checkds - DNSSEC delegation consistency checking tool +------------------------------------------------------------ + +Synopsis +~~~~~~~~ + +``dnssec-checkds`` [**-d**\ *dig path*] [**-D**\ *dsfromkey path*] +[**-f**\ *file*] [**-l**\ *domain*] [**-s**\ *file*] {zone} + +Description +~~~~~~~~~~~ + +``dnssec-checkds`` verifies the correctness of Delegation Signer (DS) +resource records for keys in a specified zone. + +Options +~~~~~~~ + +**-a** *algorithm* + + Specify a digest algorithm to use when converting the zones DNSKEY + records to expected DS records. This option can be repeated, so that + multiple records are checked for each DNSKEY record. + + The *algorithm* must be one of SHA-1, SHA-256, or SHA-384. These + values are case insensitive, and the hyphen may be omitted. If no + algorithm is specified, the default is SHA-256. + +**-f** *file* + + If a ``file`` is specified, then the zone is read from that file to + find the DNSKEY records. If not, then the DNSKEY records for the zone + are looked up in the DNS. + +**-s** *file* + + Specifies a prepared dsset file, such as would be generated by + ``dnssec-signzone``, to use as a source for the DS RRset instead of + querying the parent. + +**-d** *dig path* + + Specifies a path to a ``dig`` binary. Used for testing. + +**-D** *dsfromkey path* + + Specifies a path to a ``dnssec-dsfromkey`` binary. Used for testing. + +See Also +~~~~~~~~ + +``dnssec-dsfromkey``\ (8), ``dnssec-keygen``\ (8), +``dnssec-signzone``\ (8), diff --git a/bin/python/dnssec-coverage.8 b/bin/python/dnssec-coverage.8 deleted file mode 100644 index 295a1e5edf4..00000000000 --- a/bin/python/dnssec-coverage.8 +++ /dev/null @@ -1,156 +0,0 @@ -.\" Copyright (C) 2013-2016, 2018-2020 Internet Systems Consortium, Inc. ("ISC") -.\" -.\" This Source Code Form is subject to the terms of the Mozilla Public -.\" License, v. 2.0. If a copy of the MPL was not distributed with this -.\" file, You can obtain one at http://mozilla.org/MPL/2.0/. -.\" -.hy 0 -.ad l -'\" t -.\" Title: dnssec-coverage -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 2014-01-11 -.\" Manual: BIND9 -.\" Source: ISC -.\" Language: English -.\" -.TH "DNSSEC\-COVERAGE" "8" "2014\-01\-11" "ISC" "BIND9" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -dnssec-coverage \- checks future DNSKEY coverage for a zone -.SH "SYNOPSIS" -.HP \w'\fBdnssec\-coverage\fR\ 'u -\fBdnssec\-coverage\fR [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-l\ \fR\fB\fIlength\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-d\ \fR\fB\fIDNSKEY\ TTL\fR\fR] [\fB\-m\ \fR\fB\fImax\ TTL\fR\fR] [\fB\-r\ \fR\fB\fIinterval\fR\fR] [\fB\-c\ \fR\fB\fIcompilezone\ path\fR\fR] [\fB\-k\fR] [\fB\-z\fR] [zone...] -.SH "DESCRIPTION" -.PP -\fBdnssec\-coverage\fR -verifies that the DNSSEC keys for a given zone or a set of zones have timing metadata set properly to ensure no future lapses in DNSSEC coverage\&. -.PP -If -\fBzone\fR -is specified, then keys found in the key repository matching that zone are scanned, and an ordered list is generated of the events scheduled for that key (i\&.e\&., publication, activation, inactivation, deletion)\&. The list of events is walked in order of occurrence\&. Warnings are generated if any event is scheduled which could cause the zone to enter a state in which validation failures might occur: for example, if the number of published or active keys for a given algorithm drops to zero, or if a key is deleted from the zone too soon after a new key is rolled, and cached data signed by the prior key has not had time to expire from resolver caches\&. -.PP -If -\fBzone\fR -is not specified, then all keys in the key repository will be scanned, and all zones for which there are keys will be analyzed\&. (Note: This method of reporting is only accurate if all the zones that have keys in a given repository share the same TTL parameters\&.) -.SH "OPTIONS" -.PP -\-K \fIdirectory\fR -.RS 4 -Sets the directory in which keys can be found\&. Defaults to the current working directory\&. -.RE -.PP -\-f \fIfile\fR -.RS 4 -If a -\fBfile\fR -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 -\fB\-m\fR -and -\fB\-d\fR -options do not need to be specified on the command line\&. -.RE -.PP -\-l \fIduration\fR -.RS 4 -The length of time to check for DNSSEC coverage\&. Key events scheduled further into the future than -\fBduration\fR -will be ignored, and assumed to be correct\&. -.sp -The value of -\fBduration\fR -can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. -.RE -.PP -\-m \fImaximum TTL\fR -.RS 4 -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\&. -.sp -The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. -.sp -This option is not necessary if the -\fB\-f\fR -has been used to specify a zone file\&. If -\fB\-f\fR -has been specified, this option may still be used; it will override the value found in the file\&. -.sp -If this option is not used and the maximum TTL cannot be retrieved from a zone file, a warning is generated and a default value of 1 week is used\&. -.RE -.PP -\-d \fIDNSKEY TTL\fR -.RS 4 -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\&. -.sp -The length of the TTL can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. -.sp -This option is not necessary if -\fB\-f\fR -has been used to specify a zone file from which the TTL of the DNSKEY RRset can be read, or if a default key TTL was set using ith the -\fB\-L\fR -to -\fBdnssec\-keygen\fR\&. If either of those is true, this option may still be used; it will override the values found in the zone file or the key file\&. -.sp -If this option is not used and the key TTL cannot be retrieved from the zone file or the key file, then a warning is generated and a default value of 1 day is used\&. -.RE -.PP -\-r \fIresign interval\fR -.RS 4 -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 -\fBnamed\fR\&. However, if it has been changed by the -\fBsig\-validity\-interval\fR -option in -named\&.conf, then it should also be changed here\&. -.sp -The length of the interval can be set in seconds, or in larger units of time by adding a suffix: \*(Aqmi\*(Aq for minutes, \*(Aqh\*(Aq for hours, \*(Aqd\*(Aq for days, \*(Aqw\*(Aq for weeks, \*(Aqmo\*(Aq for months, \*(Aqy\*(Aq for years\&. -.RE -.PP -\-k -.RS 4 -Only check KSK coverage; ignore ZSK events\&. Cannot be used with -\fB\-z\fR\&. -.RE -.PP -\-z -.RS 4 -Only check ZSK coverage; ignore KSK events\&. Cannot be used with -\fB\-k\fR\&. -.RE -.PP -\-c \fIcompilezone path\fR -.RS 4 -Specifies a path to a -\fBnamed\-compilezone\fR -binary\&. Used for testing\&. -.RE -.SH "SEE ALSO" -.PP -\fBdnssec-checkds\fR(8), -\fBdnssec-dsfromkey\fR(8), -\fBdnssec-keygen\fR(8), -\fBdnssec-signzone\fR(8) -.SH "AUTHOR" -.PP -\fBInternet Systems Consortium, Inc\&.\fR -.SH "COPYRIGHT" -.br -Copyright \(co 2013-2016, 2018-2020 Internet Systems Consortium, Inc. ("ISC") -.br diff --git a/bin/python/dnssec-coverage.docbook b/bin/python/dnssec-coverage.docbook deleted file mode 100644 index cbbf773ff65..00000000000 --- a/bin/python/dnssec-coverage.docbook +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - 2014-01-11 - - - ISC - Internet Systems Consortium, Inc. - - - - dnssec-coverage - 8 - BIND9 - - - - dnssec-coverage - checks future DNSKEY coverage for a zone - - - - - 2013 - 2014 - 2015 - 2016 - 2018 - 2019 - 2020 - Internet Systems Consortium, Inc. ("ISC") - - - - - - dnssec-coverage - - - - - - - - - - zone - - - - DESCRIPTION - - dnssec-coverage - verifies that the DNSSEC keys for a given zone or a set of zones - have timing metadata set properly to ensure no future lapses in DNSSEC - coverage. - - - If is specified, then keys found in - the key repository matching that zone are scanned, and an ordered - list is generated of the events scheduled for that key (i.e., - publication, activation, inactivation, deletion). The list of - events is walked in order of occurrence. Warnings are generated - if any event is scheduled which could cause the zone to enter a - state in which validation failures might occur: for example, if - the number of published or active keys for a given algorithm drops - to zero, or if a key is deleted from the zone too soon after a new - key is rolled, and cached data signed by the prior key has not had - time to expire from resolver caches. - - - If is not specified, then all keys in the - key repository will be scanned, and all zones for which there are - keys will be analyzed. (Note: This method of reporting is only - accurate if all the zones that have keys in a given repository - share the same TTL parameters.) - - - - OPTIONS - - - - - -K directory - - - Sets the directory in which keys can be found. Defaults to the - current working directory. - - - - - - -f file - - - If a 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 - and options do - not need to be specified on the command line. - - - - - - -l duration - - - The length of time to check for DNSSEC coverage. Key events - scheduled further into the future than - will be ignored, and assumed to be correct. - - - The value of 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. - - - - - - -m maximum TTL - - - 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. - - - 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. - - - This option is not necessary if the has - been used to specify a zone file. If has - been specified, this option may still be used; it will override - the value found in the file. - - - If this option is not used and the maximum TTL cannot be retrieved - from a zone file, a warning is generated and a default value of - 1 week is used. - - - - - - -d DNSKEY TTL - - - 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. - - - 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. - - - This option is not necessary if has - been used to specify a zone file from which the TTL - of the DNSKEY RRset can be read, or if a default key TTL was - set using ith the to - dnssec-keygen. If either of those is true, - this option may still be used; it will override the values - found in the zone file or the key file. - - - If this option is not used and the key TTL cannot be retrieved - from the zone file or the key file, then a warning is generated - and a default value of 1 day is used. - - - - - - -r resign interval - - - 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 - named. However, if it has been changed - by the option in - named.conf, then it should also be - changed here. - - - 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. - - - - - - -k - - - Only check KSK coverage; ignore ZSK events. Cannot be - used with . - - - - - - -z - - - Only check ZSK coverage; ignore KSK events. Cannot be - used with . - - - - - - - -c compilezone path - - - Specifies a path to a named-compilezone binary. - Used for testing. - - - - - - - SEE ALSO - - - - dnssec-checkds8 - , - - dnssec-dsfromkey8 - , - - dnssec-keygen8 - , - - dnssec-signzone8 - - - - - diff --git a/bin/python/dnssec-coverage.html b/bin/python/dnssec-coverage.html deleted file mode 100644 index 83b881a2482..00000000000 --- a/bin/python/dnssec-coverage.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - -dnssec-coverage - - -
-
- - - - - -
-

Name

-

- dnssec-coverage - — checks future DNSKEY coverage for a zone -

-
- - - -
-

Synopsis

-

- dnssec-coverage - [-K directory] - [-l length] - [-f file] - [-d DNSKEY TTL] - [-m max TTL] - [-r interval] - [-c compilezone path] - [-k] - [-z] - [zone...] -

-
- -
-

DESCRIPTION

- -

dnssec-coverage - verifies that the DNSSEC keys for a given zone or a set of zones - have timing metadata set properly to ensure no future lapses in DNSSEC - coverage. -

-

- If zone is specified, then keys found in - the key repository matching that zone are scanned, and an ordered - list is generated of the events scheduled for that key (i.e., - publication, activation, inactivation, deletion). The list of - events is walked in order of occurrence. Warnings are generated - if any event is scheduled which could cause the zone to enter a - state in which validation failures might occur: for example, if - the number of published or active keys for a given algorithm drops - to zero, or if a key is deleted from the zone too soon after a new - key is rolled, and cached data signed by the prior key has not had - time to expire from resolver caches. -

-

- If zone is not specified, then all keys in the - key repository will be scanned, and all zones for which there are - keys will be analyzed. (Note: This method of reporting is only - accurate if all the zones that have keys in a given repository - share the same TTL parameters.) -

-
- -
-

OPTIONS

- - -
-
-K directory
-
-

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

-
-
-f file
-
-

- If a file 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 - -m and -d options do - not need to be specified on the command line. -

-
-
-l duration
-
-

- The length of time to check for DNSSEC coverage. Key events - scheduled further into the future than duration - will be ignored, and assumed to be correct. -

-

- The value of duration 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. -

-
-
-m maximum TTL
-
-

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

-

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

-

- This option is not necessary if the -f has - been used to specify a zone file. If -f has - been specified, this option may still be used; it will override - the value found in the file. -

-

- If this option is not used and the maximum TTL cannot be retrieved - from a zone file, a warning is generated and a default value of - 1 week is used. -

-
-
-d DNSKEY TTL
-
-

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

-

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

-

- This option is not necessary if -f has - been used to specify a zone file from which the TTL - of the DNSKEY RRset can be read, or if a default key TTL was - set using ith the -L to - dnssec-keygen. If either of those is true, - this option may still be used; it will override the values - found in the zone file or the key file. -

-

- If this option is not used and the key TTL cannot be retrieved - from the zone file or the key file, then a warning is generated - and a default value of 1 day is used. -

-
-
-r resign interval
-
-

- 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 - named. However, if it has been changed - by the sig-validity-interval option in - named.conf, then it should also be - changed here. -

-

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

-
-
-k
-
-

- Only check KSK coverage; ignore ZSK events. Cannot be - used with -z. -

-
-
-z
-
-

- Only check ZSK coverage; ignore KSK events. Cannot be - used with -k. -

-
-
-c compilezone path
-
-

- Specifies a path to a named-compilezone binary. - Used for testing. -

-
-
-
- -
-

SEE ALSO

- -

- - dnssec-checkds(8) - , - - dnssec-dsfromkey(8) - , - - dnssec-keygen(8) - , - - dnssec-signzone(8) - -

-
- -
- diff --git a/bin/python/dnssec-coverage.rst b/bin/python/dnssec-coverage.rst new file mode 100644 index 00000000000..2030957627b --- /dev/null +++ b/bin/python/dnssec-coverage.rst @@ -0,0 +1,151 @@ +.. + Copyright (C) Internet Systems Consortium, Inc. ("ISC") + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + + See the COPYRIGHT file distributed with this work for additional + information regarding copyright ownership. + +.. highlight: console + +.. _man_dnssec-coverage: + +dnssec-coverage - checks future DNSKEY coverage for a zone +---------------------------------------------------------- + +Synopsis +~~~~~~~~ + +``dnssec-coverage`` [**-K**\ *directory*] [**-l**\ *length*] +[**-f**\ *file*] [**-d**\ *DNSKEY TTL*] [**-m**\ *max TTL*] +[**-r**\ *interval*] [**-c**\ *compilezone path*] [**-k**] [**-z**] +[zone...] + +Description +~~~~~~~~~~~ + +``dnssec-coverage`` verifies that the DNSSEC keys for a given zone or a +set of zones have timing metadata set properly to ensure no future +lapses in DNSSEC coverage. + +If ``zone`` is specified, then keys found in the key repository matching +that zone are scanned, and an ordered list is generated of the events +scheduled for that key (i.e., publication, activation, inactivation, +deletion). The list of events is walked in order of occurrence. Warnings +are generated if any event is scheduled which could cause the zone to +enter a state in which validation failures might occur: for example, if +the number of published or active keys for a given algorithm drops to +zero, or if a key is deleted from the zone too soon after a new key is +rolled, and cached data signed by the prior key has not had time to +expire from resolver caches. + +If ``zone`` is not specified, then all keys in the key repository will +be scanned, and all zones for which there are keys will be analyzed. +(Note: This method of reporting is only accurate if all the zones that +have keys in a given repository share the same TTL parameters.) + +Options +~~~~~~~ + +**-K** *directory* + + Sets the directory in which keys can be found. Defaults to the + current working directory. + +**-f** *file* + + If a ``file`` 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 ``-m`` and ``-d`` options do not need to be specified + on the command line. + +**-l** *duration* + + The length of time to check for DNSSEC coverage. Key events scheduled + further into the future than ``duration`` will be ignored, and + assumed to be correct. + + The value of ``duration`` 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. + +**-m** *maximum TTL* + + 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. + + 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. + + This option is not necessary if the ``-f`` has been used to specify a + zone file. If ``-f`` has been specified, this option may still be + used; it will override the value found in the file. + + If this option is not used and the maximum TTL cannot be retrieved + from a zone file, a warning is generated and a default value of 1 + week is used. + +**-d** *DNSKEY TTL* + + 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. + + 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. + + This option is not necessary if ``-f`` has been used to specify a + zone file from which the TTL of the DNSKEY RRset can be read, or if a + default key TTL was set using ith the ``-L`` to ``dnssec-keygen``. If + either of those is true, this option may still be used; it will + override the values found in the zone file or the key file. + + If this option is not used and the key TTL cannot be retrieved from + the zone file or the key file, then a warning is generated and a + default value of 1 day is used. + +**-r** *resign interval* + + 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 ``named``. However, if it has been changed by the + ``sig-validity-interval`` option in named.conf, then it should also + be changed here. + + 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. + +**-k** + + Only check KSK coverage; ignore ZSK events. Cannot be used with + ``-z``. + +**-z** + + Only check ZSK coverage; ignore KSK events. Cannot be used with + ``-k``. + +**-c** *compilezone path* + + Specifies a path to a ``named-compilezone`` binary. Used for testing. + +See Also +~~~~~~~~ + +``dnssec-checkds``\ (8), ``dnssec-dsfromkey``\ (8), +``dnssec-keygen``\ (8), ``dnssec-signzone``\ (8) diff --git a/bin/python/dnssec-keymgr.8 b/bin/python/dnssec-keymgr.8 deleted file mode 100644 index e51b7d8b315..00000000000 --- a/bin/python/dnssec-keymgr.8 +++ /dev/null @@ -1,298 +0,0 @@ -.\" Copyright (C) 2016-2020 Internet Systems Consortium, Inc. ("ISC") -.\" -.\" This Source Code Form is subject to the terms of the Mozilla Public -.\" License, v. 2.0. If a copy of the MPL was not distributed with this -.\" file, You can obtain one at http://mozilla.org/MPL/2.0/. -.\" -.hy 0 -.ad l -'\" t -.\" Title: dnssec-keymgr -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 2016-06-03 -.\" Manual: BIND9 -.\" Source: ISC -.\" Language: English -.\" -.TH "DNSSEC\-KEYMGR" "8" "2016\-06\-03" "ISC" "BIND9" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -dnssec-keymgr \- Ensures correct DNSKEY coverage for a zone based on a defined policy -.SH "SYNOPSIS" -.HP \w'\fBdnssec\-keymgr\fR\ 'u -\fBdnssec\-keymgr\fR [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-c\ \fR\fB\fIfile\fR\fR] [\fB\-f\fR] [\fB\-k\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-z\fR] [\fB\-g\ \fR\fB\fIpath\fR\fR] [\fB\-s\ \fR\fB\fIpath\fR\fR] [zone...] -.SH "DESCRIPTION" -.PP -\fBdnssec\-keymgr\fR -is a high level Python wrapper to facilitate the key rollover process for zones handled by BIND\&. It uses the BIND commands for manipulating DNSSEC key metadata: -\fBdnssec\-keygen\fR -and -\fBdnssec\-settime\fR\&. -.PP -DNSSEC policy can be read from a configuration file (default -/etc/dnssec\-policy\&.conf), from which the key parameters, publication and rollover schedule, and desired coverage duration for any given zone can be determined\&. This file may be used to define individual DNSSEC policies on a per\-zone basis, or to set a "default" policy used for all zones\&. -.PP -When -\fBdnssec\-keymgr\fR -runs, it examines the DNSSEC keys for one or more zones, comparing their timing metadata against the policies for those zones\&. If key settings do not conform to the DNSSEC policy (for example, because the policy has been changed), they are automatically corrected\&. -.PP -A zone policy can specify a duration for which we want to ensure the key correctness (\fBcoverage\fR)\&. It can also specify a rollover period (\fBroll\-period\fR)\&. If policy indicates that a key should roll over before the coverage period ends, then a successor key will automatically be created and added to the end of the key series\&. -.PP -If zones are specified on the command line, -\fBdnssec\-keymgr\fR -will examine only those zones\&. If a specified zone does not already have keys in place, then keys will be generated for it according to policy\&. -.PP -If zones are -\fInot\fR -specified on the command line, then -\fBdnssec\-keymgr\fR -will search the key directory (either the current working directory or the directory set by the -\fB\-K\fR -option), and check the keys for all the zones represented in the directory\&. -.PP -Key times that are in the past will not be updated unless the -\fB\-f\fR -is used (see below)\&. Key inactivation and deletion times that are less than five minutes in the future will be delayed by five minutes\&. -.PP -It is expected that this tool will be run automatically and unattended (for example, by -\fBcron\fR)\&. -.SH "OPTIONS" -.PP -\-c \fIfile\fR -.RS 4 -If -\fB\-c\fR -is specified, then the DNSSEC policy is read from -\fBfile\fR\&. (If not specified, then the policy is read from -/etc/dnssec\-policy\&.conf; if that file doesn\*(Aqt exist, a built\-in global default policy is used\&.) -.RE -.PP -\-f -.RS 4 -Force: allow updating of key events even if they are already in the past\&. This is not recommended for use with zones in which keys have already been published\&. However, if a set of keys has been generated all of which have publication and activation dates in the past, but the keys have not been published in a zone as yet, then this option can be used to clean them up and turn them into a proper series of keys with appropriate rollover intervals\&. -.RE -.PP -\-g \fIkeygen\-path\fR -.RS 4 -Specifies a path to a -\fBdnssec\-keygen\fR -binary\&. Used for testing\&. See also the -\fB\-s\fR -option\&. -.RE -.PP -\-h -.RS 4 -Print the -\fBdnssec\-keymgr\fR -help summary and exit\&. -.RE -.PP -\-K \fIdirectory\fR -.RS 4 -Sets the directory in which keys can be found\&. Defaults to the current working directory\&. -.RE -.PP -\-k -.RS 4 -Only apply policies to KSK keys\&. See also the -\fB\-z\fR -option\&. -.RE -.PP -\-q -.RS 4 -Quiet: suppress printing of -\fBdnssec\-keygen\fR -and -\fBdnssec\-settime\fR\&. -.RE -.PP -\-s \fIsettime\-path\fR -.RS 4 -Specifies a path to a -\fBdnssec\-settime\fR -binary\&. Used for testing\&. See also the -\fB\-g\fR -option\&. -.RE -.PP -\-v -.RS 4 -Print the -\fBdnssec\-keymgr\fR -version and exit\&. -.RE -.PP -\-z -.RS 4 -Only apply policies to ZSK keys\&. See also the -\fB\-k\fR -option\&. -.RE -.SH "POLICY CONFIGURATION" -.PP -The -dnssec\-policy\&.conf -file can specify three kinds of policies: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -\fIPolicy classes\fR -(\fBpolicy \fR\fB\fIname\fR\fR\fB { \&.\&.\&. };\fR) can be inherited by zone policies or other policy classes; these can be used to create sets of different security profiles\&. For example, a policy class -\fBnormal\fR -might specify 1024\-bit key sizes, but a class -\fBextra\fR -might specify 2048 bits instead; -\fBextra\fR -would be used for zones that had unusually high security needs\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -\fIAlgorithm policies:\fR -(\fBalgorithm\-policy \fR\fB\fIalgorithm\fR\fR\fB { \&.\&.\&. };\fR -) override default per\-algorithm settings\&. For example, by default, RSASHA256 keys use 2048\-bit key sizes for both KSK and ZSK\&. This can be modified using -\fBalgorithm\-policy\fR, and the new key sizes would then be used for any key of type RSASHA256\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -\fIZone policies:\fR -(\fBzone \fR\fB\fIname\fR\fR\fB { \&.\&.\&. };\fR -) set policy for a single zone by name\&. A zone policy can inherit a policy class by including a -\fBpolicy\fR -option\&. Zone names beginning with digits (i\&.e\&., 0\-9) must be quoted\&. If a zone does not have its own policy then the "default" policy applies\&. -.RE -.PP -Options that can be specified in policies: -.PP -\fBalgorithm\fR \fIname\fR; -.RS 4 -The key algorithm\&. If no policy is defined, the default is RSASHA256\&. -.RE -.PP -\fBcoverage\fR \fIduration\fR; -.RS 4 -The length of time to ensure that keys will be correct; no action will be taken to create new keys to be activated after this time\&. This can be represented as a number of seconds, or as a duration using human\-readable units (examples: "1y" or "6 months")\&. A default value for this option can be set in algorithm policies as well as in policy classes or zone policies\&. If no policy is configured, the default is six months\&. -.RE -.PP -\fBdirectory\fR \fIpath\fR; -.RS 4 -Specifies the directory in which keys should be stored\&. -.RE -.PP -\fBkey\-size\fR \fIkeytype\fR \fIsize\fR; -.RS 4 -Specifies the number of bits to use in creating keys\&. The keytype is either "zsk" or "ksk"\&. A default value for this option can be set in algorithm policies as well as in policy classes or zone policies\&. If no policy is configured, the default is 2048 bits for RSA keys\&. -.RE -.PP -\fBkeyttl\fR \fIduration\fR; -.RS 4 -The key TTL\&. If no policy is defined, the default is one hour\&. -.RE -.PP -\fBpost\-publish\fR \fIkeytype\fR \fIduration\fR; -.RS 4 -How long after inactivation a key should be deleted from the zone\&. Note: If -\fBroll\-period\fR -is not set, this value is ignored\&. The keytype is either "zsk" or "ksk"\&. A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies\&. The default is one month\&. -.RE -.PP -\fBpre\-publish\fR \fIkeytype\fR \fIduration\fR; -.RS 4 -How long before activation a key should be published\&. Note: If -\fBroll\-period\fR -is not set, this value is ignored\&. The keytype is either "zsk" or "ksk"\&. A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies\&. The default is one month\&. -.RE -.PP -\fBroll\-period\fR \fIkeytype\fR \fIduration\fR; -.RS 4 -How frequently keys should be rolled over\&. The keytype is either "zsk" or "ksk"\&. A default duration for this option can be set in algorithm policies as well as in policy classes or zone policies\&. If no policy is configured, the default is one year for ZSKs\&. KSKs do not roll over by default\&. -.RE -.PP -\fBstandby\fR \fIkeytype\fR \fInumber\fR; -.RS 4 -Not yet implemented\&. -.RE -.SH "REMAINING WORK" -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Enable scheduling of KSK rollovers using the -\fB\-P sync\fR -and -\fB\-D sync\fR -options to -\fBdnssec\-keygen\fR -and -\fBdnssec\-settime\fR\&. Check the parent zone (as in -\fBdnssec\-checkds\fR) to determine when it\*(Aqs safe for the key to roll\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Allow configuration of standby keys and use of the REVOKE bit, for keys that use RFC 5011 semantics\&. -.RE -.SH "SEE ALSO" -.PP -\fBdnssec-coverage\fR(8), -\fBdnssec-keygen\fR(8), -\fBdnssec-settime\fR(8), -\fBdnssec-checkds\fR(8) -.SH "AUTHOR" -.PP -\fBInternet Systems Consortium, Inc\&.\fR -.SH "COPYRIGHT" -.br -Copyright \(co 2016-2020 Internet Systems Consortium, Inc. ("ISC") -.br diff --git a/bin/python/dnssec-keymgr.docbook b/bin/python/dnssec-keymgr.docbook deleted file mode 100644 index dd29a9a046b..00000000000 --- a/bin/python/dnssec-keymgr.docbook +++ /dev/null @@ -1,422 +0,0 @@ - - - - - 2016-06-03 - - - ISC - Internet Systems Consortium, Inc. - - - - dnssec-keymgr - 8 - BIND9 - - - - dnssec-keymgr - Ensures correct DNSKEY coverage for a zone based on a defined policy - - - - - 2016 - 2017 - 2018 - 2019 - 2020 - Internet Systems Consortium, Inc. ("ISC") - - - - - - dnssec-keymgr - - - - - - - - - - zone - - - - DESCRIPTION - - dnssec-keymgr is a high level Python wrapper - to facilitate the key rollover process for zones handled by - BIND. It uses the BIND commands for manipulating DNSSEC key - metadata: dnssec-keygen and - dnssec-settime. - - - DNSSEC policy can be read from a configuration file (default - /etc/dnssec-policy.conf), from which the - key parameters, publication and rollover schedule, and desired - coverage duration for any given zone can be determined. This - file may be used to define individual DNSSEC policies on a - per-zone basis, or to set a "default" policy - used for all zones. - - - When dnssec-keymgr runs, it examines the DNSSEC - keys for one or more zones, comparing their timing metadata against - the policies for those zones. If key settings do not conform to the - DNSSEC policy (for example, because the policy has been changed), - they are automatically corrected. - - - A zone policy can specify a duration for which we want to - ensure the key correctness (). It can - also specify a rollover period (). - If policy indicates that a key should roll over before the - coverage period ends, then a successor key will automatically be - created and added to the end of the key series. - - - If zones are specified on the command line, - dnssec-keymgr will examine only those zones. - If a specified zone does not already have keys in place, then - keys will be generated for it according to policy. - - - If zones are not specified on the command - line, then dnssec-keymgr will search the - key directory (either the current working directory or the directory - set by the option), and check the keys for - all the zones represented in the directory. - - - Key times that are in the past will not be updated unless - the is used (see below). Key inactivation - and deletion times that are less than five minutes in the future - will be delayed by five minutes. - - - It is expected that this tool will be run automatically and - unattended (for example, by cron). - - - - OPTIONS - - - -c file - - - If is specified, then the DNSSEC - policy is read from . (If not - specified, then the policy is read from - /etc/dnssec-policy.conf; if that file - doesn't exist, a built-in global default policy is used.) - - - - - - -f - - - Force: allow updating of key events even if they are - already in the past. This is not recommended for use with - zones in which keys have already been published. However, - if a set of keys has been generated all of which have - publication and activation dates in the past, but the - keys have not been published in a zone as yet, then this - option can be used to clean them up and turn them into a - proper series of keys with appropriate rollover intervals. - - - - - - -g keygen-path - - - Specifies a path to a dnssec-keygen binary. - Used for testing. - See also the option. - - - - - - -h - - - Print the dnssec-keymgr help summary - and exit. - - - - - - -K directory - - - Sets the directory in which keys can be found. Defaults to the - current working directory. - - - - - - -k - - - Only apply policies to KSK keys. - See also the option. - - - - - - -q - - - Quiet: suppress printing of dnssec-keygen - and dnssec-settime. - - - - - - -s settime-path - - - Specifies a path to a dnssec-settime binary. - Used for testing. - See also the option. - - - - - - -v - - - Print the dnssec-keymgr version and exit. - - - - - - -z - - - Only apply policies to ZSK keys. - See also the option. - - - - - - - POLICY CONFIGURATION - - The dnssec-policy.conf file can specify three kinds - of policies: - - - - - Policy classes - () - can be inherited by zone policies or other policy classes; these - can be used to create sets of different security profiles. For - example, a policy class normal might specify - 1024-bit key sizes, but a class extra might - specify 2048 bits instead; extra would be - used for zones that had unusually high security needs. - - - - - Algorithm policies: - ( ) - override default per-algorithm settings. For example, by default, - RSASHA256 keys use 2048-bit key sizes for both KSK and ZSK. This - can be modified using algorithm-policy, and the - new key sizes would then be used for any key of type RSASHA256. - - - - - Zone policies: - ( ) - set policy for a single zone by name. A zone policy can inherit - a policy class by including a option. - Zone names beginning with digits (i.e., 0-9) must be quoted. - If a zone does not have its own policy then the - "default" policy applies. - - - - - Options that can be specified in policies: - - - - algorithm - name; - - - The key algorithm. If no policy is defined, the default is - RSASHA256. - - - - - coverage - duration; - - - The length of time to ensure that keys will be correct; no action - will be taken to create new keys to be activated after this time. - This can be represented as a number of seconds, or as a duration - using human-readable units (examples: "1y" or "6 months"). - A default value for this option can be set in algorithm policies - as well as in policy classes or zone policies. - If no policy is configured, the default is six months. - - - - - directory - path; - - - Specifies the directory in which keys should be stored. - - - - - key-size keytype - size; - - - Specifies the number of bits to use in creating keys. - The keytype is either "zsk" or "ksk". - A default value for this option can be set in algorithm policies - as well as in policy classes or zone policies. If no policy is - configured, the default is 2048 bits for RSA keys. - - - - - keyttl - duration; - - - The key TTL. If no policy is defined, the default is one hour. - - - - - post-publish keytype - duration; - - - How long after inactivation a key should be deleted from the zone. - Note: If is not set, this value is - ignored. The keytype is either "zsk" or "ksk". - A default duration for this option can be set in algorithm - policies as well as in policy classes or zone policies. The default - is one month. - - - - - pre-publish keytype - duration; - - - How long before activation a key should be published. Note: If - is not set, this value is ignored. - The keytype is either "zsk" or "ksk". - A default duration for this option can be set in algorithm policies - as well as in policy classes or zone policies. The default is - one month. - - - - - roll-period keytype - duration; - - - How frequently keys should be rolled over. - The keytype is either "zsk" or "ksk". - A default duration for this option can be set in algorithm policies - as well as in policy classes or zone policies. If no policy is - configured, the default is one year for ZSKs. KSKs do not - roll over by default. - - - - - standby keytype - number; - - - Not yet implemented. - - - - - - - REMAINING WORK - - - - Enable scheduling of KSK rollovers using the - and options to - dnssec-keygen and - dnssec-settime. Check the parent zone - (as in dnssec-checkds) to determine when it's - safe for the key to roll. - - - - - Allow configuration of standby keys and use of the REVOKE bit, - for keys that use RFC 5011 semantics. - - - - - - SEE ALSO - - - dnssec-coverage8 - , - - dnssec-keygen8 - , - - dnssec-settime8 - , - - dnssec-checkds8 - - - - - diff --git a/bin/python/dnssec-keymgr.html b/bin/python/dnssec-keymgr.html deleted file mode 100644 index 6fe08765017..00000000000 --- a/bin/python/dnssec-keymgr.html +++ /dev/null @@ -1,371 +0,0 @@ - - - - - -dnssec-keymgr - - -
-
- - - - - -
-

Name

-

- dnssec-keymgr - — Ensures correct DNSKEY coverage for a zone based on a defined policy -

-
- - - -
-

Synopsis

-

- dnssec-keymgr - [-K directory] - [-c file] - [-f] - [-k] - [-q] - [-v] - [-z] - [-g path] - [-s path] - [zone...] -

-
- -
-

DESCRIPTION

-

- dnssec-keymgr is a high level Python wrapper - to facilitate the key rollover process for zones handled by - BIND. It uses the BIND commands for manipulating DNSSEC key - metadata: dnssec-keygen and - dnssec-settime. -

-

- DNSSEC policy can be read from a configuration file (default - /etc/dnssec-policy.conf), from which the - key parameters, publication and rollover schedule, and desired - coverage duration for any given zone can be determined. This - file may be used to define individual DNSSEC policies on a - per-zone basis, or to set a "default" policy - used for all zones. -

-

- When dnssec-keymgr runs, it examines the DNSSEC - keys for one or more zones, comparing their timing metadata against - the policies for those zones. If key settings do not conform to the - DNSSEC policy (for example, because the policy has been changed), - they are automatically corrected. -

-

- A zone policy can specify a duration for which we want to - ensure the key correctness (coverage). It can - also specify a rollover period (roll-period). - If policy indicates that a key should roll over before the - coverage period ends, then a successor key will automatically be - created and added to the end of the key series. -

-

- If zones are specified on the command line, - dnssec-keymgr will examine only those zones. - If a specified zone does not already have keys in place, then - keys will be generated for it according to policy. -

-

- If zones are not specified on the command - line, then dnssec-keymgr will search the - key directory (either the current working directory or the directory - set by the -K option), and check the keys for - all the zones represented in the directory. -

-

- Key times that are in the past will not be updated unless - the -f is used (see below). Key inactivation - and deletion times that are less than five minutes in the future - will be delayed by five minutes. -

-

- It is expected that this tool will be run automatically and - unattended (for example, by cron). -

-
- -
-

OPTIONS

-
-
-c file
-
-

- If -c is specified, then the DNSSEC - policy is read from file. (If not - specified, then the policy is read from - /etc/dnssec-policy.conf; if that file - doesn't exist, a built-in global default policy is used.) -

-
-
-f
-
-

- Force: allow updating of key events even if they are - already in the past. This is not recommended for use with - zones in which keys have already been published. However, - if a set of keys has been generated all of which have - publication and activation dates in the past, but the - keys have not been published in a zone as yet, then this - option can be used to clean them up and turn them into a - proper series of keys with appropriate rollover intervals. -

-
-
-g keygen-path
-
-

- Specifies a path to a dnssec-keygen binary. - Used for testing. - See also the -s option. -

-
-
-h
-
-

- Print the dnssec-keymgr help summary - and exit. -

-
-
-K directory
-
-

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

-
-
-k
-
-

- Only apply policies to KSK keys. - See also the -z option. -

-
-
-q
-
-

- Quiet: suppress printing of dnssec-keygen - and dnssec-settime. -

-
-
-s settime-path
-
-

- Specifies a path to a dnssec-settime binary. - Used for testing. - See also the -g option. -

-
-
-v
-
-

- Print the dnssec-keymgr version and exit. -

-
-
-z
-
-

- Only apply policies to ZSK keys. - See also the -k option. -

-
-
-
- -
-

POLICY CONFIGURATION

-

- The dnssec-policy.conf file can specify three kinds - of policies: -

-
    -
  • -

    - Policy classes - (policy name { ... };) - can be inherited by zone policies or other policy classes; these - can be used to create sets of different security profiles. For - example, a policy class normal might specify - 1024-bit key sizes, but a class extra might - specify 2048 bits instead; extra would be - used for zones that had unusually high security needs. -

    -
    • -
  • -

    - Algorithm policies: - (algorithm-policy algorithm { ... }; ) - override default per-algorithm settings. For example, by default, - RSASHA256 keys use 2048-bit key sizes for both KSK and ZSK. This - can be modified using algorithm-policy, and the - new key sizes would then be used for any key of type RSASHA256. -

    -
    • -
  • -

    - Zone policies: - (zone name { ... }; ) - set policy for a single zone by name. A zone policy can inherit - a policy class by including a policy option. - Zone names beginning with digits (i.e., 0-9) must be quoted. - If a zone does not have its own policy then the - "default" policy applies. -

    -
    • -
-

- Options that can be specified in policies: -

-
-
algorithm - name;
-
-

- The key algorithm. If no policy is defined, the default is - RSASHA256. -

-
-
coverage - duration;
-
-

- The length of time to ensure that keys will be correct; no action - will be taken to create new keys to be activated after this time. - This can be represented as a number of seconds, or as a duration - using human-readable units (examples: "1y" or "6 months"). - A default value for this option can be set in algorithm policies - as well as in policy classes or zone policies. - If no policy is configured, the default is six months. -

-
-
directory - path;
-
-

- Specifies the directory in which keys should be stored. -

-
-
key-size keytype - size;
-
-

- Specifies the number of bits to use in creating keys. - The keytype is either "zsk" or "ksk". - A default value for this option can be set in algorithm policies - as well as in policy classes or zone policies. If no policy is - configured, the default is 2048 bits for RSA keys. -

-
-
keyttl - duration;
-
-

- The key TTL. If no policy is defined, the default is one hour. -

-
-
post-publish keytype - duration;
-
-

- How long after inactivation a key should be deleted from the zone. - Note: If roll-period is not set, this value is - ignored. The keytype is either "zsk" or "ksk". - A default duration for this option can be set in algorithm - policies as well as in policy classes or zone policies. The default - is one month. -

-
-
pre-publish keytype - duration;
-
-

- How long before activation a key should be published. Note: If - roll-period is not set, this value is ignored. - The keytype is either "zsk" or "ksk". - A default duration for this option can be set in algorithm policies - as well as in policy classes or zone policies. The default is - one month. -

-
-
roll-period keytype - duration;
-
-

- How frequently keys should be rolled over. - The keytype is either "zsk" or "ksk". - A default duration for this option can be set in algorithm policies - as well as in policy classes or zone policies. If no policy is - configured, the default is one year for ZSKs. KSKs do not - roll over by default. -

-
-
standby keytype - number;
-
-

- Not yet implemented. -

-
-
-
- -
-

REMAINING WORK

-
    -
  • -

    - Enable scheduling of KSK rollovers using the -P sync - and -D sync options to - dnssec-keygen and - dnssec-settime. Check the parent zone - (as in dnssec-checkds) to determine when it's - safe for the key to roll. -

    -
    • -
  • -

    - Allow configuration of standby keys and use of the REVOKE bit, - for keys that use RFC 5011 semantics. -

    -
    • -
-
- -
-

SEE ALSO

-

- - dnssec-coverage(8) - , - - dnssec-keygen(8) - , - - dnssec-settime(8) - , - - dnssec-checkds(8) - -

-
- -
- diff --git a/bin/python/dnssec-keymgr.rst b/bin/python/dnssec-keymgr.rst new file mode 100644 index 00000000000..0f8e4020ab7 --- /dev/null +++ b/bin/python/dnssec-keymgr.rst @@ -0,0 +1,224 @@ +.. + Copyright (C) Internet Systems Consortium, Inc. ("ISC") + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + + See the COPYRIGHT file distributed with this work for additional + information regarding copyright ownership. + +.. highlight: console + +.. _man_dnssec-keymgr: + +dnssec-keymgr - Ensures correct DNSKEY coverage based on a defined policy +------------------------------------------------------------------------- + +Synopsis +~~~~~~~~ + +:program:``dnssec-keymgr`` [**-K**\ *directory*] [**-c**\ *file*] [**-f**] +[**-k**] [**-q**] [**-v**] [**-z**] [**-g**\ *path*] [**-s**\ *path*] +[zone...] + +Description +~~~~~~~~~~~ + +``dnssec-keymgr`` is a high level Python wrapper to facilitate the key +rollover process for zones handled by BIND. It uses the BIND commands +for manipulating DNSSEC key metadata: ``dnssec-keygen`` and +``dnssec-settime``. + +DNSSEC policy can be read from a configuration file (default +/etc/dnssec-policy.conf), from which the key parameters, publication and +rollover schedule, and desired coverage duration for any given zone can +be determined. This file may be used to define individual DNSSEC +policies on a per-zone basis, or to set a "default" policy used for all +zones. + +When ``dnssec-keymgr`` runs, it examines the DNSSEC keys for one or more +zones, comparing their timing metadata against the policies for those +zones. If key settings do not conform to the DNSSEC policy (for example, +because the policy has been changed), they are automatically corrected. + +A zone policy can specify a duration for which we want to ensure the key +correctness (``coverage``). It can also specify a rollover period +(``roll-period``). If policy indicates that a key should roll over +before the coverage period ends, then a successor key will automatically +be created and added to the end of the key series. + +If zones are specified on the command line, ``dnssec-keymgr`` will +examine only those zones. If a specified zone does not already have keys +in place, then keys will be generated for it according to policy. + +If zones are *not* specified on the command line, then ``dnssec-keymgr`` +will search the key directory (either the current working directory or +the directory set by the ``-K`` option), and check the keys for all the +zones represented in the directory. + +Key times that are in the past will not be updated unless the ``-f`` is +used (see below). Key inactivation and deletion times that are less than +five minutes in the future will be delayed by five minutes. + +It is expected that this tool will be run automatically and unattended +(for example, by ``cron``). + +Options +~~~~~~~ + +**-c** *file* + + If ``-c`` is specified, then the DNSSEC policy is read from ``file``. + (If not specified, then the policy is read from + /etc/dnssec-policy.conf; if that file doesnt exist, a built-in global + default policy is used.) + +**-f** + + Force: allow updating of key events even if they are already in the + past. This is not recommended for use with zones in which keys have + already been published. However, if a set of keys has been generated + all of which have publication and activation dates in the past, but + the keys have not been published in a zone as yet, then this option + can be used to clean them up and turn them into a proper series of + keys with appropriate rollover intervals. + +**-g** *keygen-path* + + Specifies a path to a ``dnssec-keygen`` binary. Used for testing. See + also the ``-s`` option. + +**-h** + + Print the ``dnssec-keymgr`` help summary and exit. + +**-K** *directory* + + Sets the directory in which keys can be found. Defaults to the + current working directory. + +**-k** + + Only apply policies to KSK keys. See also the ``-z`` option. + +**-q** + + Quiet: suppress printing of ``dnssec-keygen`` and ``dnssec-settime``. + +**-s** *settime-path* + + Specifies a path to a ``dnssec-settime`` binary. Used for testing. + See also the ``-g`` option. + +**-v** + + Print the ``dnssec-keymgr`` version and exit. + +**-z** + + Only apply policies to ZSK keys. See also the ``-k`` option. + +Policy Configuration +~~~~~~~~~~~~~~~~~~~~ + +The dnssec-policy.conf file can specify three kinds of policies: + + · *Policy classes* (``policy``\ *name*\ ``{ ... };``) can be + inherited by zone policies or other policy classes; these can be used + to create sets of different security profiles. For example, a policy + class ``normal`` might specify 1024-bit key sizes, but a class + ``extra`` might specify 2048 bits instead; ``extra`` would be used + for zones that had unusually high security needs. + +.. + + · *Algorithm policies:* (``algorithm-policy``\ *algorithm*\ ``{ ... + };`` ) override default per-algorithm settings. For example, by + default, RSASHA256 keys use 2048-bit key sizes for both KSK and ZSK. + This can be modified using ``algorithm-policy``, and the new key + sizes would then be used for any key of type RSASHA256. + + · *Zone policies:* (``zone``\ *name*\ ``{ ... };`` ) set policy for a + single zone by name. A zone policy can inherit a policy class by + including a ``policy`` option. Zone names beginning with digits + (i.e., 0-9) must be quoted. If a zone does not have its own policy + then the "default" policy applies. + +Options that can be specified in policies: + +``algorithm`` *name*; + + The key algorithm. If no policy is defined, the default is RSASHA256. + +``coverage`` *duration*; + + The length of time to ensure that keys will be correct; no action + will be taken to create new keys to be activated after this time. + This can be represented as a number of seconds, or as a duration + using human-readable units (examples: "1y" or "6 months"). A default + value for this option can be set in algorithm policies as well as in + policy classes or zone policies. If no policy is configured, the + default is six months. + +``directory`` *path*; + + Specifies the directory in which keys should be stored. + +``key-size`` *keytype* *size*; + + Specifies the number of bits to use in creating keys. The keytype is + either "zsk" or "ksk". A default value for this option can be set in + algorithm policies as well as in policy classes or zone policies. If + no policy is configured, the default is 2048 bits for RSA keys. + +``keyttl`` *duration*; + + The key TTL. If no policy is defined, the default is one hour. + +``post-publish`` *keytype* *duration*; + + How long after inactivation a key should be deleted from the zone. + Note: If ``roll-period`` is not set, this value is ignored. The + keytype is either "zsk" or "ksk". A default duration for this option + can be set in algorithm policies as well as in policy classes or zone + policies. The default is one month. + +``pre-publish`` *keytype* *duration*; + + How long before activation a key should be published. Note: If + ``roll-period`` is not set, this value is ignored. The keytype is + either "zsk" or "ksk". A default duration for this option can be set + in algorithm policies as well as in policy classes or zone policies. + The default is one month. + +``roll-period`` *keytype* *duration*; + + How frequently keys should be rolled over. The keytype is either + "zsk" or "ksk". A default duration for this option can be set in + algorithm policies as well as in policy classes or zone policies. If + no policy is configured, the default is one year for ZSKs. KSKs do + not roll over by default. + +``standby`` *keytype* *number*; + + Not yet implemented. + +Remaining Work +~~~~~~~~~~~~~~ + + · Enable scheduling of KSK rollovers using the ``-P sync`` and ``-D + sync`` options to ``dnssec-keygen`` and ``dnssec-settime``. Check the + parent zone (as in ``dnssec-checkds``) to determine when its safe for + the key to roll. + +.. + + · Allow configuration of standby keys and use of the REVOKE bit, for + keys that use RFC 5011 semantics. + +See Also +~~~~~~~~ + +``dnssec-coverage``\ (8), ``dnssec-keygen``\ (8), +``dnssec-settime``\ (8), ``dnssec-checkds``\ (8) diff --git a/doc/arm/manpages.rst b/doc/arm/manpages.rst index 62bb3cf957f..9f1617df2b6 100644 --- a/doc/arm/manpages.rst +++ b/doc/arm/manpages.rst @@ -31,6 +31,9 @@ Manual Pages .. include:: ../../bin//dnssec/dnssec-importkey.rst .. include:: ../../bin//dnssec/dnssec-signzone.rst .. include:: ../../bin//dnssec/dnssec-dsfromkey.rst +.. include:: ../../bin//python/dnssec-checkds.rst +.. include:: ../../bin//python/dnssec-coverage.rst +.. include:: ../../bin//python/dnssec-keymgr.rst .. include:: ../../bin//plugins/filter-aaaa.rst .. include:: ../../bin//confgen/ddns-confgen.rst .. include:: ../../bin//confgen/rndc-confgen.rst diff --git a/doc/man/dnssec-checkds.rst b/doc/man/dnssec-checkds.rst new file mode 100644 index 00000000000..666b4fb76c6 --- /dev/null +++ b/doc/man/dnssec-checkds.rst @@ -0,0 +1,13 @@ +.. + Copyright (C) Internet Systems Consortium, Inc. ("ISC") + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + + See the COPYRIGHT file distributed with this work for additional + information regarding copyright ownership. + +:orphan: + +.. include:: ../../bin/python/dnssec-checkds.rst diff --git a/doc/man/dnssec-coverage.rst b/doc/man/dnssec-coverage.rst new file mode 100644 index 00000000000..0885d3a9d6f --- /dev/null +++ b/doc/man/dnssec-coverage.rst @@ -0,0 +1,13 @@ +.. + Copyright (C) Internet Systems Consortium, Inc. ("ISC") + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + + See the COPYRIGHT file distributed with this work for additional + information regarding copyright ownership. + +:orphan: + +.. include:: ../../bin/python/dnssec-coverage.rst diff --git a/doc/man/dnssec-keymgr.rst b/doc/man/dnssec-keymgr.rst new file mode 100644 index 00000000000..597b70c0cd1 --- /dev/null +++ b/doc/man/dnssec-keymgr.rst @@ -0,0 +1,13 @@ +.. + Copyright (C) Internet Systems Consortium, Inc. ("ISC") + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + + See the COPYRIGHT file distributed with this work for additional + information regarding copyright ownership. + +:orphan: + +.. include:: ../../bin/python/dnssec-keymgr.rst -- 2.47.3