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