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