1DNSSEC-KEYMGR(8) BIND9 DNSSEC-KEYMGR(8)
2
6 dnssec-keymgr - Ensures correct DNSKEY coverage for a zone based on a
7 defined policy
8
10 dnssec-keymgr [-K directory] [-c file] [-f] [-k] [-q] [-v] [-z]
11 [-g path] [-r path] [-s path] [zone...]
12
14 dnssec-keymgr is a high level Python wrapper to facilitate the key
15 rollover process for zones handled by BIND. It uses the BIND commands
16 for manipulating DNSSEC key metadata: dnssec-keygen and dnssec-settime.
17 DNSSEC policy can be read from a configuration file (default
19 /etc/dnssec-policy.conf), from which the key parameters, publication
20 and rollover schedule, and desired coverage duration for any given zone
21 can be determined. This file may be used to define individual DNSSEC
22 policies on a per-zone basis, or to set a "default" policy used for all
23 zones.
24 When dnssec-keymgr runs, it examines the DNSSEC keys for one or more
26 zones, comparing their timing metadata against the policies for those
27 zones. If key settings do not conform to the DNSSEC policy (for
28 example, because the policy has been changed), they are automatically
29 corrected.
30 A zone policy can specify a duration for which we want to ensure the
32 key correctness (coverage). It can also specify a rollover period
33 (roll-period). If policy indicates that a key should roll over before
34 the coverage period ends, then a successor key will automatically be
35 created and added to the end of the key series.
36 If zones are specified on the command line, dnssec-keymgr will examine
38 only those zones. If a specified zone does not already have keys in
39 place, then keys will be generated for it according to policy.
40 If zones are not specified on the command line, then dnssec-keymgr will
42 search the key directory (either the current working directory or the
43 directory set by the -K option), and check the keys for all the zones
44 represented in the directory.
45 Key times that are in the past will not be updated unless the -f is
47 used (see below). Key inactivation and deletion times that are less
48 than five minutes in the future will be delayed by five minutes.
49 It is expected that this tool will be run automatically and unattended
51 (for example, by cron).
52
54 -c file
55 If -c is specified, then the DNSSEC policy is read from file. (If
56 not specified, then the policy is read from
57 /etc/dnssec-policy.conf; if that file doesn't exist, a built-in
58 global default policy is used.)
59 -f
61 Force: allow updating of key events even if they are already in the
62 past. This is not recommended for use with zones in which keys have
63 already been published. However, if a set of keys has been
64 generated all of which have publication and activation dates in the
65 past, but the keys have not been published in a zone as yet, then
66 this option can be used to clean them up and turn them into a
67 proper series of keys with appropriate rollover intervals.
68 -g keygen-path
70 Specifies a path to a dnssec-keygen binary. Used for testing. See
71 also the -s option.
72 -h
74 Print the dnssec-keymgr help summary and exit.
75 -K directory
77 Sets the directory in which keys can be found. Defaults to the
78 current working directory.
79 -k
81 Only apply policies to KSK keys. See also the -z option.
82 -q
84 Quiet: suppress printing of dnssec-keygen and dnssec-settime.
85 -r randomdev
87 Specifies a path to a file containing random data. This is passed
88 to the dnssec-keygen binary using its -r option.
89 -s settime-path
91 Specifies a path to a dnssec-settime binary. Used for testing. See
92 also the -g option.
93 -v
95 Print the dnssec-keymgr version and exit.
96 -z
98 Only apply policies to ZSK keys. See also the -k option.
99
101 The dnssec-policy.conf file can specify three kinds of policies:
102 · Policy classes (policy name { ... };) can be inherited by zone
104 policies or other policy classes; these can be used to create sets
105 of different security profiles. For example, a policy class normal
106 might specify 1024-bit key sizes, but a class extra might specify
107 2048 bits instead; extra would be used for zones that had unusually
108 high security needs.
109 · Algorithm policies: (algorithm-policy algorithm { ... }; ) override
111 default per-algorithm settings. For example, by default, RSASHA256
112 keys use 2048-bit key sizes for both KSK and ZSK. This can be
113 modified using algorithm-policy, and the new key sizes would then
114 be used for any key of type RSASHA256.
115 · Zone policies: (zone name { ... }; ) set policy for a single zone
117 by name. A zone policy can inherit a policy class by including a
118 policy option. Zone names beginning with digits (i.e., 0-9) must be
119 quoted. If a zone does not have its own policy then the "default"
120 policy applies.
121 Options that can be specified in policies:
123 algorithm name;
125 The key algorithm. If no policy is defined, the default is
126 RSASHA256.
127 coverage duration;
129 The length of time to ensure that keys will be correct; no action
130 will be taken to create new keys to be activated after this time.
131 This can be represented as a number of seconds, or as a duration
132 using human-readable units (examples: "1y" or "6 months"). A
133 default value for this option can be set in algorithm policies as
134 well as in policy classes or zone policies. If no policy is
135 configured, the default is six months.
136 directory path;
138 Specifies the directory in which keys should be stored.
139 key-size keytype size;
141 Specifies the number of bits to use in creating keys. The keytype
142 is either "zsk" or "ksk". A default value for this option can be
143 set in algorithm policies as well as in policy classes or zone
144 policies. If no policy is configured, the default is 1024 bits for
145 DSA keys and 2048 for RSA.
146 keyttl duration;
148 The key TTL. If no policy is defined, the default is one hour.
149 post-publish keytype duration;
151 How long after inactivation a key should be deleted from the zone.
152 Note: If roll-period is not set, this value is ignored. The keytype
153 is either "zsk" or "ksk". A default duration for this option can be
154 set in algorithm policies as well as in policy classes or zone
155 policies. The default is one month.
156 pre-publish keytype duration;
158 How long before activation a key should be published. Note: If
159 roll-period is not set, this value is ignored. The keytype is
160 either "zsk" or "ksk". A default duration for this option can be
161 set in algorithm policies as well as in policy classes or zone
162 policies. The default is one month.
163 roll-period keytype duration;
165 How frequently keys should be rolled over. The keytype is either
166 "zsk" or "ksk". A default duration for this option can be set in
167 algorithm policies as well as in policy classes or zone policies.
168 If no policy is configured, the default is one year for ZSKs. KSKs
169 do not roll over by default.
170 standby keytype number;
172 Not yet implemented.
173
175 · Enable scheduling of KSK rollovers using the -P sync and -D sync
176 options to dnssec-keygen and dnssec-settime. Check the parent zone
177 (as in dnssec-checkds) to determine when it's safe for the key to
178 roll.
179 · Allow configuration of standby keys and use of the REVOKE bit, for
181 keys that use RFC 5011 semantics.
182
184 dnssec-coverage(8), dnssec-keygen(8), dnssec-settime(8), dnssec-
185 checkds(8)
186
188 Internet Systems Consortium, Inc.
189
191 Copyright © 2016-2021 Internet Systems Consortium, Inc. ("ISC")
192ISC 2016-06-03 DNSSEC-KEYMGR(8)