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