man.rndc-confgen.html revision 070c022f10320d27954b0b50226ca0fc556439ff
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<!--
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - Copyright (C) 2000-2003 Internet Software Consortium.
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi -
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - Permission to use, copy, modify, and distribute this software for any
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - purpose with or without fee is hereby granted, provided that the above
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - copyright notice and this permission notice appear in all copies.
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi -
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi - PERFORMANCE OF THIS SOFTWARE.
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi-->
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<!-- $Id: man.rndc-confgen.html,v 1.76 2008/04/05 01:09:34 tbox Exp $ -->
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<html>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<head>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<title>rndc-confgen</title>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi</head>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<div class="navheader">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<table width="100%" summary="Navigation header">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<tr>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<td width="20%" align="left">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<th width="60%" align="center">Manual pages</th>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<td width="20%" align="right">�</td>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi</tr>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi</table>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<hr>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi</div>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<div class="refentry" lang="en">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<a name="man.rndc-confgen"></a><div class="titlepage"></div>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<div class="refnamediv">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<h2>Name</h2>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<p><span class="application">rndc-confgen</span> &#8212; rndc key generation tool</p>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi</div>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<div class="refsynopsisdiv">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<h2>Synopsis</h2>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<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>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi</div>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<div class="refsect1" lang="en">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<a name="id2607104"></a><h2>DESCRIPTION</h2>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<p><span><strong class="command">rndc-confgen</strong></span>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi generates configuration files
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi for <span><strong class="command">rndc</strong></span>. It can be used as a
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi convenient alternative to writing the
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi <code class="filename">rndc.conf</code> file
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi and the corresponding <span><strong class="command">controls</strong></span>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi and <span><strong class="command">key</strong></span>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi statements in <code class="filename">named.conf</code> by hand.
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi option to set up a <code class="filename">rndc.key</code> file and
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi avoid the need for a <code class="filename">rndc.conf</code> file
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi and a <span><strong class="command">controls</strong></span> statement altogether.
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi </p>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi</div>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<div class="refsect1" lang="en">
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<a name="id2607170"></a><h2>OPTIONS</h2>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<div class="variablelist"><dl>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<dt><span class="term">-a</span></dt>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<dd>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<p>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi Do automatic <span><strong class="command">rndc</strong></span> configuration.
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi This creates a file <code class="filename">rndc.key</code>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi in <code class="filename">/etc</code> (or whatever
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi <code class="varname">sysconfdir</code>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi was specified as when <acronym class="acronym">BIND</acronym> was
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi built)
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi that is read by both <span><strong class="command">rndc</strong></span>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi and <span><strong class="command">named</strong></span> on startup. The
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi <code class="filename">rndc.key</code> file defines a default
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi command channel and authentication key allowing
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi <span><strong class="command">rndc</strong></span> to communicate with
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi <span><strong class="command">named</strong></span> on the local host
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi with no further configuration.
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi </p>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<p>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi Running <span><strong class="command">rndc-confgen -a</strong></span> allows
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi drop-in
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi with no changes to the existing BIND 8
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi <code class="filename">named.conf</code> file.
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi </p>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi<p>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi If a more elaborate configuration than that
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi generated by <span><strong class="command">rndc-confgen -a</strong></span>
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi is required, for example if rndc is to be used remotely,
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi you should run <span><strong class="command">rndc-confgen</strong></span> without
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi the
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi <span><strong class="command">-a</strong></span> option and set up a
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi <code class="filename">rndc.conf</code> and
f2d34afa1058d195513e7ab9a6c1f0ce38b4d05bRobert Mustacchi <code class="filename">named.conf</code>
as directed.
</p>
</dd>
<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
<dd><p>
Specifies the size of the authentication key in bits.
Must be between 1 and 512 bits; the default is 128.
</p></dd>
<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
<dd><p>
Used with the <span><strong class="command">-a</strong></span> option to specify
an alternate location for <code class="filename">rndc.key</code>.
</p></dd>
<dt><span class="term">-h</span></dt>
<dd><p>
Prints a short summary of the options and arguments to
<span><strong class="command">rndc-confgen</strong></span>.
</p></dd>
<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
<dd><p>
Specifies the key name of the rndc authentication key.
This must be a valid domain name.
The default is <code class="constant">rndc-key</code>.
</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="id2607761"></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="id2628024"></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="id2628062"></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>