man.rndc-confgen.html revision ccc383f3a74bdf3559650c630bbca24b11d8f8ae
98N/A<!--
1402N/A - Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
98N/A - Copyright (C) 2000-2003 Internet Software Consortium.
98N/A -
919N/A - Permission to use, copy, modify, and distribute this software for any
919N/A - purpose with or without fee is hereby granted, provided that the above
919N/A - copyright notice and this permission notice appear in all copies.
919N/A -
919N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
919N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
919N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
919N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
919N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
919N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
919N/A - PERFORMANCE OF THIS SOFTWARE.
919N/A-->
919N/A<!-- $Id: man.rndc-confgen.html,v 1.99 2008/10/28 01:11:26 tbox Exp $ -->
919N/A<html>
919N/A<head>
919N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
919N/A<title>rndc-confgen</title>
98N/A<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
98N/A<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
98N/A<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
98N/A<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
493N/A</head>
98N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
970N/A<div class="navheader">
970N/A<table width="100%" summary="Navigation header">
970N/A<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
970N/A<tr>
1339N/A<td width="20%" align="left">
970N/A<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
98N/A<th width="60%" align="center">Manual pages</th>
1351N/A<td width="20%" align="right">�</td>
98N/A</tr>
911N/A</table>
1351N/A<hr>
1351N/A</div>
1351N/A<div class="refentry" lang="en">
911N/A<a name="man.rndc-confgen"></a><div class="titlepage"></div>
98N/A<div class="refnamediv">
98N/A<h2>Name</h2>
98N/A<p><span class="application">rndc-confgen</span> &#8212; rndc key generation tool</p>
98N/A</div>
98N/A<div class="refsynopsisdiv">
156N/A<h2>Synopsis</h2>
493N/A<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>
493N/A</div>
98N/A<div class="refsect1" lang="en">
98N/A<a name="id2611492"></a><h2>DESCRIPTION</h2>
1296N/A<p><span><strong class="command">rndc-confgen</strong></span>
1296N/A generates configuration files
1351N/A for <span><strong class="command">rndc</strong></span>. It can be used as a
1296N/A convenient alternative to writing the
1296N/A <code class="filename">rndc.conf</code> file
1296N/A and the corresponding <span><strong class="command">controls</strong></span>
1296N/A and <span><strong class="command">key</strong></span>
1296N/A statements in <code class="filename">named.conf</code> by hand.
1296N/A Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
98N/A option to set up a <code class="filename">rndc.key</code> file and
1124N/A avoid the need for a <code class="filename">rndc.conf</code> file
1124N/A and a <span><strong class="command">controls</strong></span> statement altogether.
1124N/A </p>
1124N/A</div>
1351N/A<div class="refsect1" lang="en">
1351N/A<a name="id2620296"></a><h2>OPTIONS</h2>
1351N/A<div class="variablelist"><dl>
1351N/A<dt><span class="term">-a</span></dt>
1351N/A<dd>
1351N/A<p>
1351N/A Do automatic <span><strong class="command">rndc</strong></span> configuration.
1351N/A This creates a file <code class="filename">rndc.key</code>
1351N/A in <code class="filename">/etc</code> (or whatever
1124N/A <code class="varname">sysconfdir</code>
606N/A was specified as when <acronym class="acronym">BIND</acronym> was
1089N/A built)
1351N/A that is read by both <span><strong class="command">rndc</strong></span>
1089N/A and <span><strong class="command">named</strong></span> on startup. The
493N/A <code class="filename">rndc.key</code> file defines a default
493N/A command channel and authentication key allowing
1402N/A <span><strong class="command">rndc</strong></span> to communicate with
1402N/A <span><strong class="command">named</strong></span> on the local host
1402N/A with no further configuration.
1402N/A </p>
1402N/A<p>
1402N/A Running <span><strong class="command">rndc-confgen -a</strong></span> allows
98N/A BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
493N/A drop-in
1351N/A replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
98N/A with no changes to the existing BIND 8
98N/A <code class="filename">named.conf</code> file.
1124N/A </p>
1124N/A<p>
1124N/A If a more elaborate configuration than that
98N/A generated by <span><strong class="command">rndc-confgen -a</strong></span>
493N/A is required, for example if rndc is to be used remotely,
1089N/A you should run <span><strong class="command">rndc-confgen</strong></span> without
1089N/A the
1089N/A <span><strong class="command">-a</strong></span> option and set up a
1089N/A <code class="filename">rndc.conf</code> and
1089N/A <code class="filename">named.conf</code>
1089N/A as directed.
1124N/A </p>
1124N/A</dd>
1124N/A<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
1351N/A<dd><p>
1265N/A Specifies the size of the authentication key in bits.
1124N/A Must be between 1 and 512 bits; the default is 128.
1124N/A </p></dd>
1124N/A<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
1402N/A<dd><p>
1124N/A Used with the <span><strong class="command">-a</strong></span> option to specify
1124N/A an alternate location for <code class="filename">rndc.key</code>.
1124N/A </p></dd>
1124N/A<dt><span class="term">-h</span></dt>
1124N/A<dd><p>
1124N/A Prints a short summary of the options and arguments to
1402N/A <span><strong class="command">rndc-confgen</strong></span>.
1402N/A </p></dd>
1402N/A<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
1402N/A<dd><p>
1402N/A Specifies the key name of the rndc authentication key.
1402N/A This must be a valid domain name.
1402N/A The default is <code class="constant">rndc-key</code>.
1402N/A </p></dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
<dd><p>
Specifies the command channel port where <span><strong class="command">named</strong></span>
listens for connections from <span><strong class="command">rndc</strong></span>.
The default is 953.
</p></dd>
<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
<dd><p>
Specifies a source of random data for generating the
authorization. If the operating
system does not provide a <code class="filename">/dev/random</code>
or equivalent device, the default source of randomness
is keyboard input. <code class="filename">randomdev</code>
specifies
the name of a character device or file containing random
data to be used instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard
input should be used.
</p></dd>
<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
<dd><p>
Specifies the IP address where <span><strong class="command">named</strong></span>
listens for command channel connections from
<span><strong class="command">rndc</strong></span>. The default is the loopback
address 127.0.0.1.
</p></dd>
<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
<dd><p>
Used with the <span><strong class="command">-a</strong></span> option to specify
a directory where <span><strong class="command">named</strong></span> will run
chrooted. An additional copy of the <code class="filename">rndc.key</code>
will be written relative to this directory so that
it will be found by the chrooted <span><strong class="command">named</strong></span>.
</p></dd>
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
<dd><p>
Used with the <span><strong class="command">-a</strong></span> option to set the
owner
of the <code class="filename">rndc.key</code> file generated.
If
<span><strong class="command">-t</strong></span> is also specified only the file
in
the chroot area has its owner changed.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2626007"></a><h2>EXAMPLES</h2>
<p>
To allow <span><strong class="command">rndc</strong></span> to be used with
no manual configuration, run
</p>
<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
</p>
<p>
To print a sample <code class="filename">rndc.conf</code> file and
corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
statements to be manually inserted into <code class="filename">named.conf</code>,
run
</p>
<p><strong class="userinput"><code>rndc-confgen</code></strong>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2632685"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
<span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2632792"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
<td width="40%" align="right">�</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<code class="filename">rndc.conf</code>�</td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top">�</td>
</tr>
</table>
</div>
</body>
</html>