dnssec-keymgr.html revision 5347c0fcb04eaea19d9f39795646239f487c6207
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<!--
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly - Copyright (C) 2016 Internet Systems Consortium, Inc. ("ISC")
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly -
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly - This Source Code Form is subject to the terms of the Mozilla Public
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly - License, v. 2.0. If a copy of the MPL was not distributed with this
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly - file, You can obtain one at http://mozilla.org/MPL/2.0/.
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly-->
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<html>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<head>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<title>dnssec-keymgr</title>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly</head>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<a name="man.dnssec-keymgr"></a><div class="titlepage"></div>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<div class="refnamediv">
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<h2>Name</h2>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p><span class="application">dnssec-keymgr</span> &#8212; Ensures correct DNSKEY coverage for a zone based on a defined policy</p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly</div>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<div class="refsynopsisdiv">
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<h2>Synopsis</h2>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<div class="cmdsynopsis"><p><code class="command">dnssec-keymgr</code> [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-c <em class="replaceable"><code>file</code></em></code>] [<code class="option">-f</code>] [<code class="option">-k</code>] [<code class="option">-q</code>] [<code class="option">-v</code>] [<code class="option">-z</code>] [<code class="option">-g <em class="replaceable"><code>path</code></em></code>] [<code class="option">-r <em class="replaceable"><code>path</code></em></code>] [<code class="option">-s <em class="replaceable"><code>path</code></em></code>] [zone...]</p></div>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly</div>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<div class="refsection">
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<a name="id-1.7"></a><h2>DESCRIPTION</h2>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly <span class="command"><strong>dnssec-keymgr</strong></span> is a high level Python wrapper
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly to facilitate the key rollover process for zones handled by
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly BIND. It uses the BIND commands for manipulating DNSSEC key
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly metadata: <span class="command"><strong>dnssec-keygen</strong></span> and
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly <span class="command"><strong>dnssec-settime</strong></span>.
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly </p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly DNSSEC policy can be read from a configuration file (default
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly <code class="filename">/etc/dnssec.policy</code>), from which the key
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly parameters, publication and rollover schedule, and desired
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly coverage duration for any given zone can be determined. This
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly file may be used to define individual DNSSEC policies on a
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly per-zone basis, or to set a default policy used for all zones.
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly </p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly When <span class="command"><strong>dnssec-keymgr</strong></span> runs, it examines the DNSSEC
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly keys for one or more zones, comparing their timing metadata against
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly the policies for those zones. If key settings do not conform to the
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly DNSSEC policy (for example, because the policy has been changed),
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly they are automatically corrected.
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly </p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly A zone policy can specify a duration for which we want to
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly ensure the key correctness (<code class="option">coverage</code>). It can
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly also specify a rollover period (<code class="option">roll-period</code>).
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly If policy indicates that a key should roll over before the
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly coverage period ends, then a successor key will automatically be
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly created and added to the end of the key series.
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly </p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly If zones are specified on the command line,
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly <span class="command"><strong>dnssec-keymgr</strong></span> will examine only those zones.
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly If a specified zone does not already have keys in place, then
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly keys will be generated for it according to policy.
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly </p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly If zones are <span class="emphasis"><em>not</em></span> specified on the command
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly line, then <span class="command"><strong>dnssec-keymgr</strong></span> will search the
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly key directory (either the current working directory or the directory
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly set by the <code class="option">-K</code> option), and check the keys for
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly all the zones represented in the directory.
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly </p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly It is expected that this tool will be run automatically and
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly unattended (for example, by <span class="command"><strong>cron</strong></span>).
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly </p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly</div>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<div class="refsection">
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<a name="id-1.8"></a><h2>OPTIONS</h2>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<div class="variablelist"><dl class="variablelist">
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<dt><span class="term">-c <em class="replaceable"><code>file</code></em></span></dt>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<dd><p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly If <code class="option">-c</code> is specified, then the DNSSEC
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly policy is read from <code class="option">file</code>. (If not
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly specified, then the policy is read from
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly <code class="filename">/etc/policy.conf</code>; if that file
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly doesn't exist, a built-in global default policy is used.)
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly </p></dd>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<dt><span class="term">-f</span></dt>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<dd><p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly Force: allow updating of key events even if they are
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly already in the past. This is not recommended for use with
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly zones in which keys have already been published. However,
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly if a set of keys has been generated all of which have
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly publication and activation dates in the past, but the
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly 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.
</p></dd>
<dt><span class="term">-g <em class="replaceable"><code>keygen-path</code></em></span></dt>
<dd><p>
Specifies a path to a <span class="command"><strong>dnssec-keygen</strong></span> binary.
Used for testing.
See also the <code class="option">-s</code> option.
</p></dd>
<dt><span class="term">-h</span></dt>
<dd><p>
Print the <span class="command"><strong>dnssec-keymgr</strong></span> help summary
and exit.
</p></dd>
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
<dd><p>
Sets the directory in which keys can be found. Defaults to the
current working directory.
</p></dd>
<dt><span class="term">-k</span></dt>
<dd><p>
Only apply policies to KSK keys.
See also the <code class="option">-z</code> option.
</p></dd>
<dt><span class="term">-q</span></dt>
<dd><p>
Quiet: suppress printing of <span class="command"><strong>dnssec-keygen</strong></span>
and <span class="command"><strong>dnssec-settime</strong></span>.
</p></dd>
<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
<dd><p>
Specifies a path to a file containing random data.
This is passed to the <span class="command"><strong>dnssec-keygen</strong></span> binary
using its <code class="option">-r</code> option.
</p></dd>
<dt><span class="term">-s <em class="replaceable"><code>settime-path</code></em></span></dt>
<dd><p>
Specifies a path to a <span class="command"><strong>dnssec-settime</strong></span> binary.
Used for testing.
See also the <code class="option">-g</code> option.
</p></dd>
<dt><span class="term">-v</span></dt>
<dd><p>
Print the <span class="command"><strong>dnssec-keymgr</strong></span> version and exit.
</p></dd>
<dt><span class="term">-z</span></dt>
<dd><p>
Only apply policies to ZSK keys.
See also the <code class="option">-k</code> option.
</p></dd>
</dl></div>
</div>
<div class="refsection">
<a name="id-1.9"></a><h2>POLICY CONFIGURATION</h2>
<p>
The <code class="filename">policy.conf</code> file can specify three kinds
of policies:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>
<span class="emphasis"><em>Policy classes</em></span>
(<code class="option">policy <em class="replaceable"><code>name</code></em> { ... };</code>)
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 <strong class="userinput"><code>normal</code></strong> might specify
1024-bit key sizes, but a class <strong class="userinput"><code>extra</code></strong> might
specify 2048 bits instead; <strong class="userinput"><code>extra</code></strong> would be
used for zones that had unusually high security needs.
</p></li>
<li class="listitem"><p>
Algorithm policies:
(<code class="option">algorithm-policy <em class="replaceable"><code>algorithm</code></em> { ... };</code> )
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 <span class="command"><strong>algorithm-policy</strong></span>, and the
new key sizes would then be used for any key of type RSASHA256.
</p></li>
<li class="listitem"><p>
Zone policies:
(<code class="option">zone <em class="replaceable"><code>name</code></em> { ... };</code> )
set policy for a single zone by name. A zone policy can inherit
a policy class by including a <code class="option">policy</code> option.
</p></li>
</ul></div>
<p>
Options that can be specified in policies:
</p>
<div class="variablelist"><dl class="variablelist">
<dt><span class="term"><span class="command"><strong>algorithm</strong></span></span></dt>
<dd><p>
The key algorithm. If no policy is defined, the default is
RSASHA256.
</p></dd>
<dt><span class="term"><span class="command"><strong>coverage</strong></span></span></dt>
<dd><p>
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.
</p></dd>
<dt><span class="term"><span class="command"><strong>directory</strong></span></span></dt>
<dd><p>
Specifies the directory in which keys should be stored.
</p></dd>
<dt><span class="term"><span class="command"><strong>key-size</strong></span></span></dt>
<dd><p>
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.
</p></dd>
<dt><span class="term"><span class="command"><strong>keyttl</strong></span></span></dt>
<dd><p>
The key TTL. If no policy is defined, the default is one hour.
</p></dd>
<dt><span class="term"><span class="command"><strong>post-publish</strong></span></span></dt>
<dd><p>
How long after inactivation a key should be deleted from the zone.
Note: If <code class="option">roll-period</code> 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.
</p></dd>
<dt><span class="term"><span class="command"><strong>pre-publish</strong></span></span></dt>
<dd><p>
How long before activation a key should be published. Note: If
<code class="option">roll-period</code> 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.
</p></dd>
<dt><span class="term"><span class="command"><strong>roll-period</strong></span></span></dt>
<dd><p>
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.
</p></dd>
<dt><span class="term"><span class="command"><strong>standby</strong></span></span></dt>
<dd><p>
Not yet implemented.
</p></dd>
</dl></div>
</div>
<div class="refsection">
<a name="id-1.10"></a><h2>REMAINING WORK</h2>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>
Enable scheduling of KSK rollovers using the <code class="option">-P sync</code>
and <code class="option">-D sync</code> options to
<span class="command"><strong>dnssec-keygen</strong></span> and
<span class="command"><strong>dnssec-settime</strong></span>. Check the parent zone
(as in <span class="command"><strong>dnssec-checkds</strong></span>) to determine when it's
safe for the key to roll.
</p></li>
<li class="listitem"><p>
Allow configuration of standby keys and use of the REVOKE bit,
for keys that use RFC 5011 semantics.
</p></li>
</ul></div>
</div>
<div class="refsection">
<a name="id-1.11"></a><h2>SEE ALSO</h2>
<p>
<span class="citerefentry"><span class="refentrytitle">dnssec-coverage</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">dnssec-settime</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">dnssec-checkds</span>(8)</span>
</p>
</div>
</div></body>
</html>