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