From 17e9d6023e9fec06511e93303836ec0f106379d2 Mon Sep 17 00:00:00 2001 From: Tinderbox User Date: Fri, 29 Apr 2016 16:42:23 +0000 Subject: [PATCH] Add .8 and .html files for dnssec-keymgr --- bin/python/dnssec-coverage.8 | 22 ++- bin/python/dnssec-coverage.html | 42 +++-- bin/python/dnssec-keymgr.8 | 310 ++++++++++++++++++++++++++++++++ bin/python/dnssec-keymgr.html | 267 +++++++++++++++++++++++++++ 4 files changed, 616 insertions(+), 25 deletions(-) create mode 100644 bin/python/dnssec-keymgr.8 create mode 100644 bin/python/dnssec-keymgr.html diff --git a/bin/python/dnssec-coverage.8 b/bin/python/dnssec-coverage.8 index 981ef41f7a..cb1186d91f 100644 --- a/bin/python/dnssec-coverage.8 +++ b/bin/python/dnssec-coverage.8 @@ -1,4 +1,4 @@ -.\" Copyright (C) 2013-2015 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2013-2016 Internet Systems Consortium, Inc. ("ISC") .\" .\" Permission to use, copy, modify, and/or distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -47,7 +47,7 @@ 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] +\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 @@ -95,11 +95,13 @@ Sets the value to be used as the maximum TTL for the zone or zones being analyze .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 mandatory unless the +This option is not necessary if the \fB\-f\fR -has been used to specify a zone file\&. (If +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\&.) +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 @@ -108,12 +110,14 @@ Sets the value to be used as the DNSKEY TTL for the zone or zones being analyzed .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 mandatory unless the +This option is not necessary if \fB\-f\fR -has been used to specify a zone file, or a default key TTL was set with the +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 value found in the zone or key file\&.) +\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 @@ -156,5 +160,5 @@ binary\&. Used for testing\&. \fBInternet Systems Consortium, Inc\&.\fR .SH "COPYRIGHT" .br -Copyright \(co 2013-2015 Internet Systems Consortium, Inc. ("ISC") +Copyright \(co 2013-2016 Internet Systems Consortium, Inc. ("ISC") .br diff --git a/bin/python/dnssec-coverage.html b/bin/python/dnssec-coverage.html index e5bcfe15a8..22ed026596 100644 --- a/bin/python/dnssec-coverage.html +++ b/bin/python/dnssec-coverage.html @@ -1,5 +1,5 @@ + + + +dnssec-keymgr + + +
+
+
+

Name

+

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

+
+
+

Synopsis

+

dnssec-keymgr [-K directory] [-c file] [-d time] [-k] [-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), 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. +

+

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

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

+
-z
+

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

+
+
+
+

POLICY CONFIGURATION

+

+ The 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. +
    • +
+

+ Options that can be specified in policies: +

+
+
algorithm
+
+ The key algorithm. If no policy is defined, the default is + RSASHA256. +
+
coverage
+
+ 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
+
+ Specifies the directory in which keys should be stored. +
+
key-size
+
+ Specifies the number of bits to use in creating keys. + Takes two arguments: keytype (eihter "zsk" or "ksk") and size. + 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 1024 bits for DSA keys and 2048 for + RSA. +
+
keyttl
+
+ The key TTL. If no policy is defined, the default is one hour. +
+
post-publish
+
+ How long after inactivation a key should be deleted from the zone. + Note: If roll-period is not set, this value is + ignored. Takes two arguments: keytype (eihter "zsk" or "ksk") and a + duration. A default value 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
+
+ How long before activation a key should be published. Note: If + roll-period is not set, this value is ignored. + Takes two arguments: keytype (either "zsk" or "ksk") and a duration. + A default value 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
+
+ How frequently keys should be rolled over. + Takes two arguments: keytype (eihter "zsk" or "ksk") and a duration. + 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 one year for ZSK's. KSK's do not + roll over by default. +
+
standby
+
+ 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) +

+
+
+