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