dnssec-keymgr — Ensures correct DNSKEY coverage for a zone based on a defined policy
dnssec-keymgr
[-K ]
[directory-c ]
[file-f]
[-k]
[-q]
[-v]
[-z]
[-g ]
[path-r ]
[path-s ]
[zone...]
path
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.
It is expected that this tool will be run automatically and unattended (for example, by cron).
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.)
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.
keygen-path
Specifies a path to a dnssec-keygen binary.
Used for testing.
See also the -s option.
Print the dnssec-keymgr help summary and exit.
directorySets the directory in which keys can be found. Defaults to the current working directory.
Only apply policies to KSK keys.
See also the -z option.
Quiet: suppress printing of dnssec-keygen and dnssec-settime.
randomdev
Specifies a path to a file containing random data.
This is passed to the dnssec-keygen binary
using its -r option.
settime-path
Specifies a path to a dnssec-settime binary.
Used for testing.
See also the -g option.
Print the dnssec-keymgr version and exit.
Only apply policies to ZSK keys.
See also the -k option.