man.rndc-confgen.html revision 885c1096e0c296b0188f01ca7511df1f70a6cdda
0e1dfb8ff5ac2cf1215691ffc32d7a0b76709721Mark Andrews - Copyright (C) 2004-2006 Internet Systems Consortium, Inc. ("ISC")
0e1dfb8ff5ac2cf1215691ffc32d7a0b76709721Mark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
8e091f3d3ee0079f35dfccdc4479105e8f087ab2Mark Andrews - Permission to use, copy, modify, and distribute this software for any
8e091f3d3ee0079f35dfccdc4479105e8f087ab2Mark Andrews - purpose with or without fee is hereby granted, provided that the above
7ace3277956c49f7554b7130ef761bde3b35db30Mark Andrews - copyright notice and this permission notice appear in all copies.
7ace3277956c49f7554b7130ef761bde3b35db30Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
06ace051e7522b153b487581c9439fc8c162fb18Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
06ace051e7522b153b487581c9439fc8c162fb18Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
06ace051e7522b153b487581c9439fc8c162fb18Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
5d4343a9988cd5bd057aa385bb8c5e72d41202d1Evan Hunt - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5d4343a9988cd5bd057aa385bb8c5e72d41202d1Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
75ae74f8fd0847817bce2db7c868b179db67f019Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
75ae74f8fd0847817bce2db7c868b179db67f019Mark Andrews<!-- $Id: man.rndc-confgen.html,v 1.18 2006/01/30 02:27:04 marka Exp $ -->
16bd30ae6987cd4ba4fe3b873e72abf5b7178c26Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
df0892aea6bfd20a01c3abf2b756625d23830390Mark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
df0892aea6bfd20a01c3abf2b756625d23830390Mark Andrews<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
a499dddb4b4d4db2bb6ced82b5ee7a459e23603eEvan Hunt<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
a499dddb4b4d4db2bb6ced82b5ee7a459e23603eEvan Hunt<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
f45f6541857a5dbb93ac24f321b9cf350ce242baMark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
673a2bb07b9e54a32699a9d7ca916dc5114d8d45Mark Andrews<table width="100%" summary="Navigation header">
673a2bb07b9e54a32699a9d7ca916dc5114d8d45Mark Andrews<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
e3c273a865bede10bfb1e0f29d300706cae3e00dMark Andrews<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
421d4a06479e61fbdc35087f3c4abc9fe65ad72aEvan Hunt<a name="man.rndc-confgen"></a><div class="titlepage"></div>
421d4a06479e61fbdc35087f3c4abc9fe65ad72aEvan Hunt<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
421d4a06479e61fbdc35087f3c4abc9fe65ad72aEvan Hunt<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>
0949306cb96f9ccbb7d0205584ed2db293a5aad2Evan Hunt<p><span><strong class="command">rndc-confgen</strong></span>
0949306cb96f9ccbb7d0205584ed2db293a5aad2Evan Hunt generates configuration files
964bdcd7add44e5bc87e1d44f2f4ece351b28eedEvan Hunt for <span><strong class="command">rndc</strong></span>. It can be used as a
964bdcd7add44e5bc87e1d44f2f4ece351b28eedEvan Hunt convenient alternative to writing the
cf0a69e999430722e3c3942929eeb304b658dfb0Evan Hunt and the corresponding <span><strong class="command">controls</strong></span>
cf0a69e999430722e3c3942929eeb304b658dfb0Evan Hunt and <span><strong class="command">key</strong></span>
71697fd082b1c76562dc80fa91787af3860146bfEvan Hunt statements in <code class="filename">named.conf</code> by hand.
71697fd082b1c76562dc80fa91787af3860146bfEvan Hunt Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
71697fd082b1c76562dc80fa91787af3860146bfEvan Hunt option to set up a <code class="filename">rndc.key</code> file and
71697fd082b1c76562dc80fa91787af3860146bfEvan Hunt avoid the need for a <code class="filename">rndc.conf</code> file
71697fd082b1c76562dc80fa91787af3860146bfEvan Hunt and a <span><strong class="command">controls</strong></span> statement altogether.
5b7abbef511cea0b568be0bc8d5b3120a0b9034dEvan Hunt Do automatic <span><strong class="command">rndc</strong></span> configuration.
5b7abbef511cea0b568be0bc8d5b3120a0b9034dEvan Hunt This creates a file <code class="filename">rndc.key</code>
26bda028ad3854d2e695feb9333ef3dbe6b2fa1aEvan Hunt in <code class="filename">/etc</code> (or whatever
26bda028ad3854d2e695feb9333ef3dbe6b2fa1aEvan Hunt was specified as when <span class="acronym">BIND</span> was
eb4458b4784a2206d939f9c4cfed4b37b076b5bcEvan Hunt that is read by both <span><strong class="command">rndc</strong></span>
eb4458b4784a2206d939f9c4cfed4b37b076b5bcEvan Hunt and <span><strong class="command">named</strong></span> on startup. The
1da46be57223340c07ea8505d485ec4397a4e484Evan Hunt <code class="filename">rndc.key</code> file defines a default
1da46be57223340c07ea8505d485ec4397a4e484Evan Hunt command channel and authentication key allowing
1da46be57223340c07ea8505d485ec4397a4e484Evan Hunt <span><strong class="command">rndc</strong></span> to communicate with
1da46be57223340c07ea8505d485ec4397a4e484Evan Hunt <span><strong class="command">named</strong></span> on the local host
9d69017bc635f7be5c8df2b18ae6d4491fc5bb63Mark Andrews with no further configuration.
9d4ec6d2c59bd5845ac8bca5a5d790be9a772862Evan Hunt Running <span><strong class="command">rndc-confgen -a</strong></span> allows
9d4ec6d2c59bd5845ac8bca5a5d790be9a772862Evan Hunt BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
caa0a135d49dfbe3de9711eacf94d6e112a77688Mark Andrews replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
9fa5a723e188ddb5e6165af4957ba789e17cfdf5Evan Hunt with no changes to the existing BIND 8
7aba1a9660630ab7d16792b7388d9b8f56d7bf0fEvan Hunt If a more elaborate configuration than that
7aba1a9660630ab7d16792b7388d9b8f56d7bf0fEvan Hunt generated by <span><strong class="command">rndc-confgen -a</strong></span>
7aba1a9660630ab7d16792b7388d9b8f56d7bf0fEvan Hunt is required, for example if rndc is to be used remotely,
682a574e6716cea30386c38e68f4fc6c3d4b20e7Mark Andrews you should run <span><strong class="command">rndc-confgen</strong></span> without
3b9ba6bd74e2cbbc0f821e5483ebf46fa8c4d8deEvan Hunt <span><strong class="command">-a</strong></span> option and set up a
3b9ba6bd74e2cbbc0f821e5483ebf46fa8c4d8deEvan Hunt as directed.
1761ecb90ff770b87d0f021e13ad94d3e8c6f2afFrancis Dupont<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
f48358cffb35bb4b24731c136b07816bdcdce651Evan Hunt Specifies the size of the authentication key in bits.
f48358cffb35bb4b24731c136b07816bdcdce651Evan Hunt Must be between 1 and 512 bits; the default is 128.
c3b554214416b434c6db7881907c962110aecba9Evan Hunt<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt Used with the <span><strong class="command">-a</strong></span> option to specify
31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt an alternate location for <code class="filename">rndc.key</code>.
8f1e278931689460a49f0e9be610f2b2cc32c42dEvan Hunt Prints a short summary of the options and arguments to
caa0a135d49dfbe3de9711eacf94d6e112a77688Mark Andrews <span><strong class="command">rndc-confgen</strong></span>.
166c4c6c5bafd25283b797979f77d780856fef30Evan Hunt<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
166c4c6c5bafd25283b797979f77d780856fef30Evan Hunt Specifies the key name of the rndc authentication key.
beb12aad6bebb0d6891613e65a4e19a42e6e3f8eMark Andrews This must be a valid domain name.
beb12aad6bebb0d6891613e65a4e19a42e6e3f8eMark Andrews The default is <code class="constant">rndc-key</code>.
8e15d5eb3a000f1341e6bea0ddbc28d6dd2a0591Mark Andrews<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
1b2a4ce2b112ec91b0f13c411144e721c7952914Evan Hunt Specifies the command channel port where <span><strong class="command">named</strong></span>
1b2a4ce2b112ec91b0f13c411144e721c7952914Evan Hunt listens for connections from <span><strong class="command">rndc</strong></span>.
1b2a4ce2b112ec91b0f13c411144e721c7952914Evan Hunt The default is 953.
e59937c7283216ca22ce6e7937b06eab6d97f4acEvan Hunt<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
89be55dc9040b119fd85bb33e7dc97d2ad454c6fEvan Hunt Specifies a source of random data for generating the
89be55dc9040b119fd85bb33e7dc97d2ad454c6fEvan Hunt authorization. If the operating
89be55dc9040b119fd85bb33e7dc97d2ad454c6fEvan Hunt system does not provide a <code class="filename">/dev/random</code>
89be55dc9040b119fd85bb33e7dc97d2ad454c6fEvan Hunt or equivalent device, the default source of randomness
89be55dc9040b119fd85bb33e7dc97d2ad454c6fEvan Hunt is keyboard input. <code class="filename">randomdev</code>
c6eb92beb1951b0634c349b24891522c273e9f69Mark Andrews the name of a character device or file containing random
c6eb92beb1951b0634c349b24891522c273e9f69Mark Andrews data to be used instead of the default. The special value
c6eb92beb1951b0634c349b24891522c273e9f69Mark Andrews <code class="filename">keyboard</code> indicates that keyboard
bf0441a339755618efcbe0b427afa5cb8e62dc68Evan Hunt input should be used.
bf0441a339755618efcbe0b427afa5cb8e62dc68Evan Hunt<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
8144dc702beec803d7b847e6f28ce845c57ae468Mark Andrews Specifies the IP address where <span><strong class="command">named</strong></span>
8144dc702beec803d7b847e6f28ce845c57ae468Mark Andrews listens for command channel connections from
1ac1cc12fc993b060e868a94ec1c292c9ffbccc4Jeremy C. Reed <span><strong class="command">rndc</strong></span>. The default is the loopback
7ee225cf90fd06de61682b442600af88b68b99dbMark Andrews address 127.0.0.1.
5f1dc0d505d7f53f1e89a1a41e4c2415af4934feEvan Hunt<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
276457f7a38f56a5f762238ab89bb45e27948af6Evan Hunt Used with the <span><strong class="command">-a</strong></span> option to specify
b0bd5a3f730410e0bc7ac4e05f061616daf818b2Mark Andrews a directory where <span><strong class="command">named</strong></span> will run
b0bd5a3f730410e0bc7ac4e05f061616daf818b2Mark Andrews chrooted. An additional copy of the <code class="filename">rndc.key</code>
276457f7a38f56a5f762238ab89bb45e27948af6Evan Hunt will be written relative to this directory so that
2347c72129ce9393578966225f915284f0730214Mark Andrews it will be found by the chrooted <span><strong class="command">named</strong></span>.
1e34fe9044874422104e84373988d07876f716b6Mark Andrews<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
1e34fe9044874422104e84373988d07876f716b6Mark Andrews Used with the <span><strong class="command">-a</strong></span> option to set the
30d6dc14e918f9f72ff090c34d6e328ae8e7d68bCurtis Blackburn of the <code class="filename">rndc.key</code> file generated.
5183f9d9daa139cbf000c12709877f62e79dfb14Evan Hunt <span><strong class="command">-t</strong></span> is also specified only the file
0193e63da91a4da27809b9a528eb043fa6b4da26Mark Andrews the chroot area has its owner changed.
2cd3c8856c97b770cc4843bfad63922e23a6f661Mark Andrews To allow <span><strong class="command">rndc</strong></span> to be used with
2cd3c8856c97b770cc4843bfad63922e23a6f661Mark Andrews no manual configuration, run
f3c8e48b95996c3020d138b87ee8941da29cc124Evan Hunt<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
744589ff64e8d98b30b746cd7a1833f77830e185Mark Andrews To print a sample <code class="filename">rndc.conf</code> file and
744589ff64e8d98b30b746cd7a1833f77830e185Mark Andrews corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
dc775799d9a5a61f485bff5b883a60cc748afaf3Evan Hunt statements to be manually inserted into <code class="filename">named.conf</code>,
428dd5c588cfe0dc1519af728e6e75c10aeb4439Curtis Blackburn<p><strong class="userinput"><code>rndc-confgen</code></strong>
62f016d5d301713c72a59e83d3ab41170a77f674Mark Andrews<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
62f016d5d301713c72a59e83d3ab41170a77f674Mark Andrews <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
d9f0c713fe1d50f1848ca827c5f31db79d904f04Evan Hunt <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
7ee225cf90fd06de61682b442600af88b68b99dbMark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
af9f195c9e128fc9cc5912498b8f7f26f07887c3Evan Hunt<p><span class="corpauthor">Internet Systems Consortium</span>
1a076410c260ff1d3124ce8b7e22ac111e9cf92aEvan Hunt<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
1a076410c260ff1d3124ce8b7e22ac111e9cf92aEvan Hunt<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
03b5d2689df73fa9a50ff684511fa9d81f317e6cEvan Hunt<td width="40%" align="left" valign="top"><code class="filename">rndc.conf</code>�</td>
03b5d2689df73fa9a50ff684511fa9d81f317e6cEvan Hunt<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>