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