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