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