man.rndc-confgen.html revision b2f07642fd712c8fda81a116bcdde229ab291f33
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt - Copyright (C) 2004-2013 Internet Systems Consortium, Inc. ("ISC")
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein - Copyright (C) 2000-2003 Internet Software Consortium.
938440694b33cd752e9e4b71a526368b4811c177Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews - purpose with or without fee is hereby granted, provided that the above
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson - copyright notice and this permission notice appear in all copies.
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews<!-- $Id$ -->
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
1f73b46904d266abe57814ea512dc7069e7a1e73Evan Hunt<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
072440df4f65033eb058c06f2cc72be450606720Jeremy Reed<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
072440df4f65033eb058c06f2cc72be450606720Jeremy Reed<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
1b892cf691dd0907e0e75774df102dd4d92dd877Automatic Updater<a name="man.rndc-confgen"></a><div class="titlepage"></div>
938440694b33cd752e9e4b71a526368b4811c177Tinderbox User<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<div class="cmdsynopsis"><p><code class="command">rndc-confgen</code> [<code class="option">-a</code>] [<code class="option">-A <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [<code class="option">-s <em class="replaceable"><code>address</code></em></code>] [<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]</p></div>
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews<p><span><strong class="command">rndc-confgen</strong></span>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein generates configuration files
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein for <span><strong class="command">rndc</strong></span>. It can be used as a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein convenient alternative to writing the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and the corresponding <span><strong class="command">controls</strong></span>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and <span><strong class="command">key</strong></span>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein statements in <code class="filename">named.conf</code> by hand.
6098d364b690cb9dabf96e9664c4689c8559bd2eMark Andrews Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt option to set up a <code class="filename">rndc.key</code> file and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein avoid the need for a <code class="filename">rndc.conf</code> file
b98225ff8a5721a998ccb440df4d261488fef163Mark Andrews and a <span><strong class="command">controls</strong></span> statement altogether.
9a41f786b167a2a6df498d5e9c699f9835e1e9dcMark Andrews Do automatic <span><strong class="command">rndc</strong></span> configuration.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This creates a file <code class="filename">rndc.key</code>
f5b7359c5730d39ff6eff24ae87c9c74a04c2e5cMark Andrews in <code class="filename">/etc</code> (or whatever
67d01dcacb2051a03377c8ec5c0e36604c17aea5Evan Hunt was specified as when <acronym class="acronym">BIND</acronym> was
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein that is read by both <span><strong class="command">rndc</strong></span>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and <span><strong class="command">named</strong></span> on startup. The
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <code class="filename">rndc.key</code> file defines a default
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein command channel and authentication key allowing
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span><strong class="command">rndc</strong></span> to communicate with
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span><strong class="command">named</strong></span> on the local host
8f7de3db7ec299ddeded142905f5eb1f22076353Evan Hunt with no further configuration.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Running <span><strong class="command">rndc-confgen -a</strong></span> allows
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein with no changes to the existing BIND 8
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If a more elaborate configuration than that
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein generated by <span><strong class="command">rndc-confgen -a</strong></span>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is required, for example if rndc is to be used remotely,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein you should run <span><strong class="command">rndc-confgen</strong></span> without
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span><strong class="command">-a</strong></span> option and set up a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein as directed.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
b98225ff8a5721a998ccb440df4d261488fef163Mark Andrews Specifies the algorithm to use for the TSIG key. Available
8f7de3db7ec299ddeded142905f5eb1f22076353Evan Hunt choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt hmac-sha384 and hmac-sha512. The default is hmac-md5.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
b98225ff8a5721a998ccb440df4d261488fef163Mark Andrews Specifies the size of the authentication key in bits.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt Must be between 1 and 512 bits; the default is the
b98225ff8a5721a998ccb440df4d261488fef163Mark Andrews<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
b98225ff8a5721a998ccb440df4d261488fef163Mark Andrews Used with the <span><strong class="command">-a</strong></span> option to specify
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt an alternate location for <code class="filename">rndc.key</code>.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt Prints a short summary of the options and arguments to
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt <span><strong class="command">rndc-confgen</strong></span>.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
b98225ff8a5721a998ccb440df4d261488fef163Mark Andrews Specifies the key name of the rndc authentication key.
8f7de3db7ec299ddeded142905f5eb1f22076353Evan Hunt This must be a valid domain name.
8f7de3db7ec299ddeded142905f5eb1f22076353Evan Hunt The default is <code class="constant">rndc-key</code>.
8f7de3db7ec299ddeded142905f5eb1f22076353Evan Hunt<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
8f7de3db7ec299ddeded142905f5eb1f22076353Evan Hunt Specifies the command channel port where <span><strong class="command">named</strong></span>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein listens for connections from <span><strong class="command">rndc</strong></span>.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt The default is 953.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt Specifies a source of random data for generating the
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt authorization. If the operating
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt system does not provide a <code class="filename">/dev/random</code>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt or equivalent device, the default source of randomness
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt is keyboard input. <code class="filename">randomdev</code>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt the name of a character device or file containing random
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt data to be used instead of the default. The special value
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt <code class="filename">keyboard</code> indicates that keyboard
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt input should be used.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt Specifies the IP address where <span><strong class="command">named</strong></span>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt listens for command channel connections from
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt <span><strong class="command">rndc</strong></span>. The default is the loopback
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt address 127.0.0.1.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt Used with the <span><strong class="command">-a</strong></span> option to specify
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt a directory where <span><strong class="command">named</strong></span> will run
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt chrooted. An additional copy of the <code class="filename">rndc.key</code>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt will be written relative to this directory so that
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt it will be found by the chrooted <span><strong class="command">named</strong></span>.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt Used with the <span><strong class="command">-a</strong></span> option to set the
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt of the <code class="filename">rndc.key</code> file generated.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt <span><strong class="command">-t</strong></span> is also specified only the file
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt the chroot area has its owner changed.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt To allow <span><strong class="command">rndc</strong></span> to be used with
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt no manual configuration, run
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt To print a sample <code class="filename">rndc.conf</code> file and
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt statements to be manually inserted into <code class="filename">named.conf</code>,
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<p><strong class="userinput"><code>rndc-confgen</code></strong>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<p><span class="corpauthor">Internet Systems Consortium</span>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
ca6e60cb704c4c8eea1385a9fbef3eaa476eca28Evan Hunt<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span>