10139N/A - Copyright (C) 2016 Internet Systems Consortium, Inc. ("ISC") 12219N/A - This Source Code Form is subject to the terms of the Mozilla Public 10139N/A - License, v. 2.0. If a copy of the MPL was not distributed with this 10139N/A <
corpauthor>Internet Systems Consortium, Inc.</
corpauthor>
10139N/A <
refentrytitle><
application>dnssec-keymgr</
application></
refentrytitle>
10139N/A <
refmiscinfo>BIND9</
refmiscinfo>
12773N/A <
refname><
application>dnssec-keymgr</
application></
refname>
12773N/A <
refpurpose>Ensures correct DNSKEY coverage for a zone based on a defined policy</
refpurpose>
10139N/A <
holder>Internet Systems Consortium, Inc. ("ISC")</
holder>
10139N/A <
command>dnssec-keymgr</
command>
10139N/A <
arg choice="opt" rep="norepeat"><
option>-K <
replaceable class="parameter">directory</
replaceable></
option></
arg>
10139N/A <
arg choice="opt" rep="norepeat"><
option>-c <
replaceable class="parameter">file</
replaceable></
option></
arg>
10139N/A <
arg choice="opt" rep="norepeat"><
option>-f</
option></
arg>
10139N/A <
arg choice="opt" rep="norepeat"><
option>-k</
option></
arg>
10139N/A <
arg choice="opt" rep="norepeat"><
option>-q</
option></
arg>
10139N/A <
arg choice="opt" rep="norepeat"><
option>-v</
option></
arg>
10139N/A <
arg choice="opt" rep="norepeat"><
option>-z</
option></
arg>
10139N/A <
arg choice="opt" rep="norepeat"><
option>-g <
replaceable class="parameter">path</
replaceable></
option></
arg>
10139N/A <
arg choice="opt" rep="norepeat"><
option>-r <
replaceable class="parameter">path</
replaceable></
option></
arg>
10139N/A <
arg choice="opt" rep="norepeat"><
option>-s <
replaceable class="parameter">path</
replaceable></
option></
arg>
10139N/A <
arg choice="opt" rep="repeat">zone</
arg>
10139N/A <
refsection><
info><
title>DESCRIPTION</
title></
info>
10139N/A <
command>dnssec-keymgr</
command> is a high level Python wrapper
10139N/A to facilitate the key rollover process for zones handled by
10139N/A BIND. It uses the BIND commands for manipulating DNSSEC key
10139N/A metadata: <
command>dnssec-keygen</
command> and
10139N/A <
command>dnssec-settime</
command>.
10139N/A DNSSEC policy can be read from a configuration file (default
10139N/A parameters, publication and rollover schedule, and desired
10139N/A coverage duration for any given zone can be determined. This
10139N/A file may be used to define individual DNSSEC policies on a
10139N/A per-zone basis, or to set a default policy used for all zones.
12773N/A When <
command>dnssec-keymgr</
command> runs, it examines the DNSSEC
12773N/A keys for one or more zones, comparing their timing metadata against
12773N/A the policies for those zones. If key settings do not conform to the
12773N/A DNSSEC policy (for example, because the policy has been changed),
10139N/A they are automatically corrected.
10139N/A A zone policy can specify a duration for which we want to
10139N/A ensure the key correctness (<
option>coverage</
option>). It can
10139N/A also specify a rollover period (<
option>roll-period</
option>).
10139N/A If policy indicates that a key should roll over before the
10139N/A coverage period ends, then a successor key will automatically be
10139N/A created and added to the end of the key series.
10139N/A If zones are specified on the command line,
10139N/A <
command>dnssec-keymgr</
command> will examine only those zones.
10139N/A If a specified zone does not already have keys in place, then
10139N/A keys will be generated for it according to policy.
10139N/A If zones are <
emphasis>not</
emphasis> specified on the command
10139N/A line, then <
command>dnssec-keymgr</
command> will search the
10139N/A key directory (either the current working directory or the directory
10139N/A set by the <
option>-K</
option> option), and check the keys for
10139N/A all the zones represented in the directory.
10139N/A It is expected that this tool will be run automatically and
10139N/A unattended (for example, by <
command>cron</
command>).
10139N/A <
refsection><
info><
title>OPTIONS</
title></
info>
17101N/A <
term>-c <
replaceable class="parameter">file</
replaceable></
term>
16990N/A If <
option>-c</
option> is specified, then the DNSSEC
16783N/A policy is read from <
option>file</
option>. (If not
16783N/A specified, then the policy is read from
16671N/A doesn't exist, a built-in global default policy is used.)
16137N/A Force: allow updating of key events even if they are
16630N/A already in the past. This is not recommended for use with
15870N/A zones in which keys have already been published. However,
15870N/A if a set of keys has been generated all of which have
15870N/A publication and activation dates in the past, but the
15448N/A keys have not been published in a zone as yet, then this
16630N/A option can be used to clean them up and turn them into a
14525N/A proper series of keys with appropriate rollover intervals.
13930N/A <
term>-g <
replaceable class="parameter">keygen-path</
replaceable></
term>
13772N/A Specifies a path to a <
command>dnssec-keygen</
command> binary.
13624N/A See also the <
option>-s</
option> option.
12575N/A Print the <
command>dnssec-keymgr</
command> help summary
12219N/A <
term>-K <
replaceable class="parameter">directory</
replaceable></
term>
11819N/A Sets the directory in which keys can be found. Defaults to the
11067N/A Only apply policies to KSK keys.
11067N/A See also the <
option>-z</
option> option.
10592N/A Quiet: suppress printing of <
command>dnssec-keygen</
command>
10592N/A and <
command>dnssec-settime</
command>.
10285N/A <
term>-r <
replaceable class="parameter">randomdev</
replaceable></
term>
10179N/A Specifies a path to a file containing random data.
10139N/A This is passed to the <
command>dnssec-keygen</
command> binary
10139N/A using its <
option>-r</
option> option.
10139N/A<!-- TODO: what to do about "-r keyboard"? --> 10139N/A <
term>-s <
replaceable class="parameter">settime-path</
replaceable></
term>
10139N/A Specifies a path to a <
command>dnssec-settime</
command> binary.
10139N/A See also the <
option>-g</
option> option.
10139N/A Print the <
command>dnssec-keymgr</
command> version and exit.
10139N/A Only apply policies to ZSK keys.
10139N/A See also the <
option>-k</
option> option.
10139N/A <
refsection><
info><
title>POLICY CONFIGURATION</
title></
info>
16630N/A <
emphasis>Policy classes</
emphasis>
10139N/A (<
option>policy <
replaceable>name</
replaceable> { ... };</
option>)
16630N/A can be inherited by zone policies or other policy classes; these
10139N/A can be used to create sets of different security profiles. For
10139N/A example, a policy class <
userinput>normal</
userinput> might specify
10139N/A 1024-bit key sizes, but a class <
userinput>extra</
userinput> might
10139N/A specify 2048 bits instead; <
userinput>extra</
userinput> would be
10139N/A used for zones that had unusually high security needs.
10139N/A (<
option>algorithm-policy <
replaceable>algorithm</
replaceable> { ... };</
option> )
10139N/A override default per-algorithm settings. For example, by default,
10139N/A RSASHA256 keys use 2048-bit key sizes for both KSK and ZSK. This
10139N/A can be modified using <
command>algorithm-policy</
command>, and the
10139N/A new key sizes would then be used for any key of type RSASHA256.
10139N/A (<
option>zone <
replaceable>name</
replaceable> { ... };</
option> )
10139N/A set policy for a single zone by name. A zone policy can inherit
10139N/A a policy class by including a <
option>policy</
option> option.
10139N/A Options that can be specified in policies:
10139N/A <
term><
command>algorithm</
command></
term>
10139N/A The key algorithm. If no policy is defined, the default is
16630N/A <
term><
command>coverage</
command></
term>
10139N/A The length of time to ensure that keys will be correct; no action
16630N/A will be taken to create new keys to be activated after this time.
10139N/A This can be represented as a number of seconds, or as a duration using
16630N/A human-readable units (examples: "1y" or "6 months").
10139N/A A default value for this option can be set in algorithm policies
16630N/A as well as in policy classes or zone policies.
10139N/A If no policy is configured, the default is six months.
16630N/A <
term><
command>directory</
command></
term>
10139N/A Specifies the directory in which keys should be stored.
16630N/A <
term><
command>key-size</
command></
term>
10139N/A Specifies the number of bits to use in creating keys.
16630N/A Takes two arguments: keytype (eihter "zsk" or "ksk") and size.
10139N/A A default value for this option can be set in algorithm policies
16630N/A as well as in policy classes or zone policies. If no policy is
10139N/A configured, the default is 1024 bits for DSA keys and 2048 for
<
term><
command>keyttl</
command></
term>
The key TTL. If no policy is defined, the default is one hour.
<
term><
command>post-publish</
command></
term>
How long after inactivation a key should be deleted from the zone.
Note: If <
option>roll-period</
option> 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
<
term><
command>pre-publish</
command></
term>
How long before activation a key should be published. Note: If
<
option>roll-period</
option> 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
<
term><
command>roll-period</
command></
term>
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
<
term><
command>standby</
command></
term>
<
refsection><
info><
title>REMAINING WORK</
title></
info>
Enable scheduling of KSK rollovers using the <
option>-P sync</
option>
and <
option>-D sync</
option> options to
<
command>dnssec-keygen</
command> and
<
command>dnssec-settime</
command>. Check the parent zone
(as in <
command>dnssec-checkds</
command>) 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.
<
refsection><
info><
title>SEE ALSO</
title></
info>
<
refentrytitle>dnssec-coverage</
refentrytitle><
manvolnum>8</
manvolnum>
<
refentrytitle>dnssec-keygen</
refentrytitle><
manvolnum>8</
manvolnum>
<
refentrytitle>dnssec-settime</
refentrytitle><
manvolnum>8</
manvolnum>
<
refentrytitle>dnssec-checkds</
refentrytitle><
manvolnum>8</
manvolnum>