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