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