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