Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
t
Title: dnssec-keymgr
Author:
Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
Date: 2016-04-03
Manual: BIND9
Source: ISC
Language: English
* Define some portability stuff
-----------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
http://bugs.debian.org/507673
http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------------------------------------------
* set default formatting
-----------------------------------------------------------------
disable hyphenation
disable justification (adjust text to left margin only)
-----------------------------------------------------------------
* MAIN CONTENT STARTS HERE *
-----------------------------------------------------------------
\w'dnssec-keymgr 'u dnssec-keymgr [-K directory] [-c file] [-d time] [-k] [-z] [-g path] [-s path] [zone...]
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).
-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\*(Aqt 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.
The policy.conf file can specify three kinds of policies:
\h'-04'\(bu\h'+03'\c .\}
\h'-04'\(bu\h'+03'\c .\}
\h'-04'\(bu\h'+03'\c .\}
Options that can be specified in policies:
algorithm
The key algorithm. If no policy is defined, the default is RSASHA256. .RE
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. .RE
directory
Specifies the directory in which keys should be stored. .RE
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. .RE
keyttl
The key TTL. If no policy is defined, the default is one hour. .RE
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. .RE
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. .RE
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\*(Aqs. KSK\*(Aqs do not roll over by default. .RE
standby
Not yet implemented. .RE
\h'-04'\(bu\h'+03'\c .\}
\h'-04'\(bu\h'+03'\c .\}
dnssec-coverage(8), dnssec-keygen(8), dnssec-settime(8), dnssec-checkds(8)
Internet Systems Consortium, Inc.
Copyright \(co 2016 Internet Systems Consortium, Inc. ("ISC")