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