man.dnssec-keymgr.html revision 7911e6f9de303bca5a3d8b34f4330c8f7cecffae
8001ba81cb851b38d86650a2fef5817facffb763johanengelen<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen - Copyright (C) 2000-2016 Internet Systems Consortium, Inc. ("ISC")
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen - This Source Code Form is subject to the terms of the Mozilla Public
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen - License, v. 2.0. If a copy of the MPL was not distributed with this
c3a8ad9235ff81909bd472707550aef5b91daf7bjohanengelen - file, You can obtain one at http://mozilla.org/MPL/2.0/.
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<link rel="prev" href="man.dnssec-keygen.html" title="dnssec-keygen">
c3a8ad9235ff81909bd472707550aef5b91daf7bjohanengelen<link rel="next" href="man.dnssec-revoke.html" title="dnssec-revoke">
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<table width="100%" summary="Navigation header">
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<tr><th colspan="3" align="center"><span class="application">dnssec-keymgr</span></th></tr>
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<a accesskey="p" href="man.dnssec-keygen.html">Prev</a>�</td>
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<th width="60%" align="center">Manual pages</th>
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-revoke.html">Next</a>
c3a8ad9235ff81909bd472707550aef5b91daf7bjohanengelen<a name="man.dnssec-keymgr"></a><div class="titlepage"></div>
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen — Ensures correct DNSKEY coverage for a zone based on a defined policy
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>]
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen [<code class="option">-c <em class="replaceable"><code>file</code></em></code>]
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen [<code class="option">-g <em class="replaceable"><code>path</code></em></code>]
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen [<code class="option">-r <em class="replaceable"><code>path</code></em></code>]
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen [<code class="option">-s <em class="replaceable"><code>path</code></em></code>]
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen <span class="command"><strong>dnssec-keymgr</strong></span> is a high level Python wrapper
981b809bc6ed10a21e89444d9447e5475801874fjohanengelen to facilitate the key rollover process for zones handled by
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould BIND. It uses the BIND commands for manipulating DNSSEC key
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould metadata: <span class="command"><strong>dnssec-keygen</strong></span> and
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould <span class="command"><strong>dnssec-settime</strong></span>.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould DNSSEC policy can be read from a configuration file (default
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould <code class="filename">/etc/dnssec-policy.conf</code>), from which the key
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould parameters, publication and rollover schedule, and desired
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould coverage duration for any given zone can be determined. This
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould file may be used to define individual DNSSEC policies on a
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould per-zone basis, or to set a default policy used for all zones.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould When <span class="command"><strong>dnssec-keymgr</strong></span> runs, it examines the DNSSEC
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould keys for one or more zones, comparing their timing metadata against
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould the policies for those zones. If key settings do not conform to the
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould DNSSEC policy (for example, because the policy has been changed),
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould they are automatically corrected.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould A zone policy can specify a duration for which we want to
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould ensure the key correctness (<code class="option">coverage</code>). It can
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould also specify a rollover period (<code class="option">roll-period</code>).
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould If policy indicates that a key should roll over before the
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould coverage period ends, then a successor key will automatically be
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould created and added to the end of the key series.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould If zones are specified on the command line,
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould <span class="command"><strong>dnssec-keymgr</strong></span> will examine only those zones.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould If a specified zone does not already have keys in place, then
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould keys will be generated for it according to policy.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould If zones are <span class="emphasis"><em>not</em></span> specified on the command
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould line, then <span class="command"><strong>dnssec-keymgr</strong></span> will search the
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould key directory (either the current working directory or the directory
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould set by the <code class="option">-K</code> option), and check the keys for
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould all the zones represented in the directory.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould It is expected that this tool will be run automatically and
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould unattended (for example, by <span class="command"><strong>cron</strong></span>).
c3a8ad9235ff81909bd472707550aef5b91daf7bjohanengelen <div class="variablelist"><dl class="variablelist">
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould<dt><span class="term">-c <em class="replaceable"><code>file</code></em></span></dt>
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould If <code class="option">-c</code> is specified, then the DNSSEC
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould policy is read from <code class="option">file</code>. (If not
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould specified, then the policy is read from
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould <code class="filename">/etc/dnssec-policy.conf</code>; if that file
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould doesn't exist, a built-in global default policy is used.)
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould Force: allow updating of key events even if they are
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould already in the past. This is not recommended for use with
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould zones in which keys have already been published. However,
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould if a set of keys has been generated all of which have
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould publication and activation dates in the past, but the
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould keys have not been published in a zone as yet, then this
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould option can be used to clean them up and turn them into a
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould proper series of keys with appropriate rollover intervals.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould<dt><span class="term">-g <em class="replaceable"><code>keygen-path</code></em></span></dt>
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould Specifies a path to a <span class="command"><strong>dnssec-keygen</strong></span> binary.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould Used for testing.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould See also the <code class="option">-s</code> option.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould Print the <span class="command"><strong>dnssec-keymgr</strong></span> help summary
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould Sets the directory in which keys can be found. Defaults to the
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould current working directory.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould Only apply policies to KSK keys.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould Quiet: suppress printing of <span class="command"><strong>dnssec-keygen</strong></span>
6c3e745a94ef6b25a4ef9f018d350a7535aa45afTed Gould and <span class="command"><strong>dnssec-settime</strong></span>.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould Specifies a path to a file containing random data.
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould This is passed to the <span class="command"><strong>dnssec-keygen</strong></span> binary
01d27eab5fca2dcb8e883011f8be77ae6b78a11cTed Gould<dt><span class="term">-s <em class="replaceable"><code>settime-path</code></em></span></dt>
63267518b4ce196caab66ef8cbdcfc0921206b3djohanengelen Specifies a path to a <span class="command"><strong>dnssec-settime</strong></span> binary.
63267518b4ce196caab66ef8cbdcfc0921206b3djohanengelen Used for testing.
63267518b4ce196caab66ef8cbdcfc0921206b3djohanengelen See also the <code class="option">-g</code> option.
63267518b4ce196caab66ef8cbdcfc0921206b3djohanengelen Print the <span class="command"><strong>dnssec-keymgr</strong></span> version and exit.