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