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