rndc-confgen.html revision 75c0816e8295e180f4bc7f10db3d0d880383bc1c
2N/A<!--
2N/A - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
2N/A - Copyright (C) 2001, 2003 Internet Software Consortium.
2N/A -
2N/A - Permission to use, copy, modify, and distribute this software for any
2N/A - purpose with or without fee is hereby granted, provided that the above
2N/A - copyright notice and this permission notice appear in all copies.
2N/A -
2N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2N/A - PERFORMANCE OF THIS SOFTWARE.
2N/A-->
2N/A<!-- $Id: rndc-confgen.html,v 1.17 2005/05/13 03:14:07 marka Exp $ -->
2N/A<html>
2N/A<head>
2N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
1392N/A<title>rndc-confgen</title>
2N/A<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
2N/A</head>
2N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
2N/A<a name="id2456836"></a><div class="titlepage"></div>
2N/A<div class="refnamediv">
2N/A<h2>Name</h2>
2N/A<p><span class="application">rndc-confgen</span> &#8212; rndc key generation tool</p>
2N/A</div>
2N/A<div class="refsynopsisdiv">
2N/A<h2>Synopsis</h2>
59N/A<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>
59N/A</div>
2N/A<div class="refsect1" lang="en">
2N/A<a name="id2514252"></a><h2>DESCRIPTION</h2>
2N/A<p><span><strong class="command">rndc-confgen</strong></span>
2N/A generates configuration files
26N/A for <span><strong class="command">rndc</strong></span>. It can be used as a
26N/A convenient alternative to writing the
2N/A <code class="filename">rndc.conf</code> file
26N/A and the corresponding <span><strong class="command">controls</strong></span>
1470N/A and <span><strong class="command">key</strong></span>
38N/A statements in <code class="filename">named.conf</code> by hand.
1470N/A Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
1470N/A option to set up a <code class="filename">rndc.key</code> file and
1470N/A avoid the need for a <code class="filename">rndc.conf</code> file
181N/A and a <span><strong class="command">controls</strong></span> statement altogether.
26N/A </p>
26N/A</div>
26N/A<div class="refsect1" lang="en">
26N/A<a name="id2514297"></a><h2>OPTIONS</h2>
26N/A<div class="variablelist"><dl>
26N/A<dt><span class="term">-a</span></dt>
26N/A<dd>
26N/A<p>
700N/A Do automatic <span><strong class="command">rndc</strong></span> configuration.
700N/A This creates a file <code class="filename">rndc.key</code>
26N/A in <code class="filename">/etc</code> (or whatever
26N/A <code class="varname">sysconfdir</code>
26N/A was specified as when <span class="acronym">BIND</span> was
1498N/A built)
1498N/A that is read by both <span><strong class="command">rndc</strong></span>
26N/A and <span><strong class="command">named</strong></span> on startup. The
1498N/A <code class="filename">rndc.key</code> file defines a default
151N/A command channel and authentication key allowing
206N/A <span><strong class="command">rndc</strong></span> to communicate with
26N/A <span><strong class="command">named</strong></span> on the local host
26N/A with no further configuration.
26N/A </p>
26N/A<p>
26N/A Running <span><strong class="command">rndc-confgen -a</strong></span> allows
26N/A BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
26N/A drop-in
2N/A replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
26N/A with no changes to the existing BIND 8
26N/A <code class="filename">named.conf</code> file.
26N/A </p>
26N/A<p>
883N/A If a more elaborate configuration than that
26N/A generated by <span><strong class="command">rndc-confgen -a</strong></span>
26N/A is required, for example if rndc is to be used remotely,
26N/A you should run <span><strong class="command">rndc-confgen</strong></span> without
26N/A the
1043N/A <span><strong class="command">-a</strong></span> option and set up a
586N/A <code class="filename">rndc.conf</code> and
26N/A <code class="filename">named.conf</code>
93N/A as directed.
166N/A </p>
26N/A</dd>
379N/A<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
379N/A<dd><p>
1498N/A Specifies the size of the authentication key in bits.
1498N/A Must be between 1 and 512 bits; the default is 128.
2N/A </p></dd>
26N/A<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
26N/A<dd><p>
181N/A Used with the <span><strong class="command">-a</strong></span> option to specify
181N/A an alternate location for <code class="filename">rndc.key</code>.
181N/A </p></dd>
99N/A<dt><span class="term">-h</span></dt>
59N/A<dd><p>
12N/A Prints a short summary of the options and arguments to
30N/A <span><strong class="command">rndc-confgen</strong></span>.
1256N/A </p></dd>
1256N/A<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
1256N/A<dd><p>
1256N/A Specifies the key name of the rndc authentication key.
1256N/A This must be a valid domain name.
1256N/A The default is <code class="constant">rndc-key</code>.
1256N/A </p></dd>
1256N/A<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
1256N/A<dd><p>
1256N/A Specifies the command channel port where <span><strong class="command">named</strong></span>
1256N/A listens for connections from <span><strong class="command">rndc</strong></span>.
1256N/A The default is 953.
1256N/A </p></dd>
1256N/A<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
1256N/A<dd><p>
1256N/A Specifies a source of random data for generating the
1256N/A authorization. If the operating
1256N/A system does not provide a <code class="filename">/dev/random</code>
1256N/A or equivalent device, the default source of randomness
1256N/A is keyboard input. <code class="filename">randomdev</code>
1256N/A specifies
1256N/A the name of a character device or file containing random
1256N/A data to be used instead of the default. The special value
1256N/A <code class="filename">keyboard</code> indicates that keyboard
1413N/A input should be used.
1256N/A </p></dd>
26N/A<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
26N/A<dd><p>
1256N/A Specifies the IP address where <span><strong class="command">named</strong></span>
2N/A listens for command channel connections from
26N/A <span><strong class="command">rndc</strong></span>. The default is the loopback
1256N/A address 127.0.0.1.
1256N/A </p></dd>
185N/A<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
2N/A<dd><p>
255N/A Used with the <span><strong class="command">-a</strong></span> option to specify
145N/A a directory where <span><strong class="command">named</strong></span> will run
7N/A chrooted. An additional copy of the <code class="filename">rndc.key</code>
26N/A will be written relative to this directory so that
26N/A it will be found by the chrooted <span><strong class="command">named</strong></span>.
38N/A </p></dd>
26N/A<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
197N/A<dd><p>
197N/A Used with the <span><strong class="command">-a</strong></span> option to set the
197N/A owner
197N/A of the <code class="filename">rndc.key</code> file generated.
197N/A If
26N/A <span><strong class="command">-t</strong></span> is also specified only the file
30N/A in
26N/A the chroot area has its owner changed.
46N/A </p></dd>
46N/A</dl></div>
46N/A</div>
64N/A<div class="refsect1" lang="en">
64N/A<a name="id2514679"></a><h2>EXAMPLES</h2>
26N/A<p>
46N/A To allow <span><strong class="command">rndc</strong></span> to be used with
46N/A no manual configuration, run
46N/A </p>
2N/A<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
1256N/A </p>
1256N/A<p>
1256N/A To print a sample <code class="filename">rndc.conf</code> file and
1256N/A corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
1256N/A statements to be manually inserted into <code class="filename">named.conf</code>,
1256N/A run
1256N/A </p>
1256N/A<p><strong class="userinput"><code>rndc-confgen</code></strong>
1256N/A </p>
1256N/A</div>
1256N/A<div class="refsect1" lang="en">
1256N/A<a name="id2514721"></a><h2>SEE ALSO</h2>
1256N/A<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
1256N/A <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
1256N/A <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
1256N/A <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
1256N/A </p>
1256N/A</div>
1256N/A<div class="refsect1" lang="en">
1256N/A<a name="id2514759"></a><h2>AUTHOR</h2>
1256N/A<p><span class="corpauthor">Internet Systems Consortium</span>
1256N/A </p>
1256N/A</div>
1256N/A</div></body>
1256N/A</html>
1256N/A