man.rndc-confgen.html revision 47012ae6dbf18a2503d7b33c1c9583dc38625cb7
990d0e893f5b70e735cdf990af66e9ec6e91fa78Tinderbox User - Copyright (C) 2004-2006 Internet Systems Consortium, Inc. ("ISC")
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater - Copyright (C) 2000-2003 Internet Software Consortium.
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - Permission to use, copy, modify, and distribute this software for any
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - purpose with or without fee is hereby granted, provided that the above
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - copyright notice and this permission notice appear in all copies.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - PERFORMANCE OF THIS SOFTWARE.
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User<!-- $Id: man.rndc-confgen.html,v 1.30 2006/05/17 02:39:16 marka Exp $ -->
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<a name="man.rndc-confgen"></a><div class="titlepage"></div>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<div class="cmdsynopsis"><p><code class="command">rndc-confgen</code> [<code class="option">-a</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>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<p><span><strong class="command">rndc-confgen</strong></span>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt generates configuration files
fc74b733bf679e1b3fb1599e32d445dffe325208Tinderbox User for <span><strong class="command">rndc</strong></span>. It can be used as a
ec899c963c91c16c393e067996400ae244921110Tinderbox User convenient alternative to writing the
f5ae3cca1d2832239cc821bdef77e90c1739e66dTinderbox User and the corresponding <span><strong class="command">controls</strong></span>
ec899c963c91c16c393e067996400ae244921110Tinderbox User and <span><strong class="command">key</strong></span>
ec899c963c91c16c393e067996400ae244921110Tinderbox User statements in <code class="filename">named.conf</code> by hand.
ec899c963c91c16c393e067996400ae244921110Tinderbox User Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
ec899c963c91c16c393e067996400ae244921110Tinderbox User option to set up a <code class="filename">rndc.key</code> file and
ec899c963c91c16c393e067996400ae244921110Tinderbox User avoid the need for a <code class="filename">rndc.conf</code> file
ec899c963c91c16c393e067996400ae244921110Tinderbox User and a <span><strong class="command">controls</strong></span> statement altogether.
ec899c963c91c16c393e067996400ae244921110Tinderbox User Do automatic <span><strong class="command">rndc</strong></span> configuration.
ec899c963c91c16c393e067996400ae244921110Tinderbox User This creates a file <code class="filename">rndc.key</code>
ec899c963c91c16c393e067996400ae244921110Tinderbox User in <code class="filename">/etc</code> (or whatever
ec899c963c91c16c393e067996400ae244921110Tinderbox User was specified as when <span class="acronym">BIND</span> was
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt that is read by both <span><strong class="command">rndc</strong></span>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt and <span><strong class="command">named</strong></span> on startup. The
ec899c963c91c16c393e067996400ae244921110Tinderbox User <code class="filename">rndc.key</code> file defines a default
ec899c963c91c16c393e067996400ae244921110Tinderbox User command channel and authentication key allowing
ec899c963c91c16c393e067996400ae244921110Tinderbox User <span><strong class="command">rndc</strong></span> to communicate with
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">named</strong></span> on the local host
ec899c963c91c16c393e067996400ae244921110Tinderbox User with no further configuration.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Running <span><strong class="command">rndc-confgen -a</strong></span> allows
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
fc74b733bf679e1b3fb1599e32d445dffe325208Tinderbox User replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt with no changes to the existing BIND 8
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt If a more elaborate configuration than that
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt generated by <span><strong class="command">rndc-confgen -a</strong></span>
ec899c963c91c16c393e067996400ae244921110Tinderbox User is required, for example if rndc is to be used remotely,
ec899c963c91c16c393e067996400ae244921110Tinderbox User you should run <span><strong class="command">rndc-confgen</strong></span> without
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">-a</strong></span> option and set up a
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt as directed.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
2cbb4ab75757fbb656997a82c14ca07db37d481aAutomatic Updater Specifies the size of the authentication key in bits.
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater Must be between 1 and 512 bits; the default is 128.
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Used with the <span><strong class="command">-a</strong></span> option to specify
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt an alternate location for <code class="filename">rndc.key</code>.
ec899c963c91c16c393e067996400ae244921110Tinderbox User Prints a short summary of the options and arguments to
ec899c963c91c16c393e067996400ae244921110Tinderbox User <span><strong class="command">rndc-confgen</strong></span>.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Specifies the key name of the rndc authentication key.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt This must be a valid domain name.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt The default is <code class="constant">rndc-key</code>.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Specifies the command channel port where <span><strong class="command">named</strong></span>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt listens for connections from <span><strong class="command">rndc</strong></span>.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt The default is 953.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Specifies a source of random data for generating the
ec899c963c91c16c393e067996400ae244921110Tinderbox User authorization. If the operating
ec899c963c91c16c393e067996400ae244921110Tinderbox User system does not provide a <code class="filename">/dev/random</code>
ec899c963c91c16c393e067996400ae244921110Tinderbox User or equivalent device, the default source of randomness
ec899c963c91c16c393e067996400ae244921110Tinderbox User is keyboard input. <code class="filename">randomdev</code>
ec899c963c91c16c393e067996400ae244921110Tinderbox User the name of a character device or file containing random
2cbb4ab75757fbb656997a82c14ca07db37d481aAutomatic Updater data to be used instead of the default. The special value
2cbb4ab75757fbb656997a82c14ca07db37d481aAutomatic Updater <code class="filename">keyboard</code> indicates that keyboard
2cbb4ab75757fbb656997a82c14ca07db37d481aAutomatic Updater input should be used.
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater Specifies the IP address where <span><strong class="command">named</strong></span>
ec899c963c91c16c393e067996400ae244921110Tinderbox User listens for command channel connections from
ec899c963c91c16c393e067996400ae244921110Tinderbox User <span><strong class="command">rndc</strong></span>. The default is the loopback
ec899c963c91c16c393e067996400ae244921110Tinderbox User address 127.0.0.1.
7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65eAutomatic Updater<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
ec899c963c91c16c393e067996400ae244921110Tinderbox User Used with the <span><strong class="command">-a</strong></span> option to specify
ec899c963c91c16c393e067996400ae244921110Tinderbox User a directory where <span><strong class="command">named</strong></span> will run
2cbb4ab75757fbb656997a82c14ca07db37d481aAutomatic Updater chrooted. An additional copy of the <code class="filename">rndc.key</code>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt will be written relative to this directory so that
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt it will be found by the chrooted <span><strong class="command">named</strong></span>.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Used with the <span><strong class="command">-a</strong></span> option to set the
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt of the <code class="filename">rndc.key</code> file generated.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span><strong class="command">-t</strong></span> is also specified only the file
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt the chroot area has its owner changed.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt To allow <span><strong class="command">rndc</strong></span> to be used with
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt no manual configuration, run
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
e2e4d321999340802f77adaacd19c797d04b4b95Automatic Updater To print a sample <code class="filename">rndc.conf</code> file and
e2e4d321999340802f77adaacd19c797d04b4b95Automatic Updater corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt statements to be manually inserted into <code class="filename">named.conf</code>,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<p><strong class="userinput"><code>rndc-confgen</code></strong>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <em class="citetitle">BIND 9 Administrator Reference Manual</em>.