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