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