man.rndc-confgen.html revision a17033f2c453688fde9719bced70b44553431759
98N/A<!--
98N/A - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
98N/A - Copyright (C) 2000-2003 Internet Software Consortium.
98N/A -
935N/A - Permission to use, copy, modify, and/or distribute this software for any
98N/A - purpose with or without fee is hereby granted, provided that the above
98N/A - copyright notice and this permission notice appear in all copies.
919N/A -
919N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
919N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
919N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
919N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
919N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
919N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
919N/A - PERFORMANCE OF THIS SOFTWARE.
919N/A-->
919N/A<!-- $Id$ -->
919N/A<html>
919N/A<head>
919N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
919N/A<title>rndc-confgen</title>
919N/A<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
919N/A<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
919N/A<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
98N/A<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
98N/A<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
98N/A</head>
235N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
156N/A<div class="navheader">
156N/A<table width="100%" summary="Navigation header">
156N/A<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
156N/A<tr>
98N/A<td width="20%" align="left">
98N/A<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
98N/A<th width="60%" align="center">Manual pages</th>
98N/A<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
493N/A</td>
493N/A</tr>
98N/A</table>
911N/A<hr>
952N/A</div>
952N/A<div class="refentry" lang="en">
911N/A<a name="man.rndc-confgen"></a><div class="titlepage"></div>
98N/A<div class="refnamediv">
235N/A<h2>Name</h2>
493N/A<p><span class="application">rndc-confgen</span> &#8212; rndc key generation tool</p>
98N/A</div>
916N/A<div class="refsynopsisdiv">
916N/A<h2>Synopsis</h2>
916N/A<div class="cmdsynopsis"><p><code class="command">rndc-confgen</code> [<code class="option">-a</code>] [<code class="option">-A <em class="replaceable"><code>algorithm</code></em></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>
916N/A</div>
98N/A<div class="refsect1" lang="en">
98N/A<a name="id2663594"></a><h2>DESCRIPTION</h2>
98N/A<p><span><strong class="command">rndc-confgen</strong></span>
606N/A generates configuration files
98N/A for <span><strong class="command">rndc</strong></span>. It can be used as a
98N/A convenient alternative to writing the
98N/A <code class="filename">rndc.conf</code> file
606N/A and the corresponding <span><strong class="command">controls</strong></span>
606N/A and <span><strong class="command">key</strong></span>
98N/A statements in <code class="filename">named.conf</code> by hand.
493N/A Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
493N/A option to set up a <code class="filename">rndc.key</code> file and
98N/A avoid the need for a <code class="filename">rndc.conf</code> file
98N/A and a <span><strong class="command">controls</strong></span> statement altogether.
98N/A </p>
98N/A</div>
908N/A<div class="refsect1" lang="en">
591N/A<a name="id2663660"></a><h2>OPTIONS</h2>
493N/A<div class="variablelist"><dl>
493N/A<dt><span class="term">-a</span></dt>
493N/A<dd>
493N/A<p>
493N/A Do automatic <span><strong class="command">rndc</strong></span> configuration.
493N/A This creates a file <code class="filename">rndc.key</code>
493N/A in <code class="filename">/etc</code> (or whatever
493N/A <code class="varname">sysconfdir</code>
493N/A was specified as when <acronym class="acronym">BIND</acronym> was
705N/A built)
493N/A that is read by both <span><strong class="command">rndc</strong></span>
557N/A and <span><strong class="command">named</strong></span> on startup. The
557N/A <code class="filename">rndc.key</code> file defines a default
493N/A command channel and authentication key allowing
493N/A <span><strong class="command">rndc</strong></span> to communicate with
965N/A <span><strong class="command">named</strong></span> on the local host
965N/A with no further configuration.
965N/A </p>
606N/A<p>
606N/A Running <span><strong class="command">rndc-confgen -a</strong></span> allows
851N/A BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
851N/A drop-in
851N/A replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
851N/A with no changes to the existing BIND 8
851N/A <code class="filename">named.conf</code> file.
851N/A </p>
851N/A<p>
98N/A If a more elaborate configuration than that
591N/A generated by <span><strong class="command">rndc-confgen -a</strong></span>
963N/A is required, for example if rndc is to be used remotely,
963N/A you should run <span><strong class="command">rndc-confgen</strong></span> without
851N/A the
591N/A <span><strong class="command">-a</strong></span> option and set up a
910N/A <code class="filename">rndc.conf</code> and
910N/A <code class="filename">named.conf</code>
910N/A as directed.
910N/A </p>
910N/A</dd>
910N/A<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
98N/A<dd><p>
98N/A Specifies the algorithm to use for the TSIG key. Available
910N/A choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
910N/A hmac-sha384 and hmac-sha512. The default is hmac-md5.
910N/A </p></dd>
98N/A<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
606N/A<dd><p>
98N/A Specifies the size of the authentication key in bits.
606N/A Must be between 1 and 512 bits; the default is the
98N/A hash size.
591N/A </p></dd>
851N/A<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
111N/A<dd><p>
111N/A Used with the <span><strong class="command">-a</strong></span> option to specify
111N/A an alternate location for <code class="filename">rndc.key</code>.
111N/A </p></dd>
111N/A<dt><span class="term">-h</span></dt>
606N/A<dd><p>
851N/A Prints a short summary of the options and arguments to
851N/A <span><strong class="command">rndc-confgen</strong></span>.
851N/A </p></dd>
606N/A<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
733N/A<dd><p>
733N/A Specifies the key name of the rndc authentication key.
733N/A This must be a valid domain name.
733N/A The default is <code class="constant">rndc-key</code>.
733N/A </p></dd>
963N/A<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
851N/A<dd><p>
963N/A Specifies the command channel port where <span><strong class="command">named</strong></span>
98N/A listens for connections from <span><strong class="command">rndc</strong></span>.
851N/A The default is 953.
851N/A </p></dd>
851N/A<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
851N/A<dd><p>
935N/A Specifies a source of random data for generating the
851N/A authorization. If the operating
851N/A system does not provide a <code class="filename">/dev/random</code>
851N/A or equivalent device, the default source of randomness
212N/A is keyboard input. <code class="filename">randomdev</code>
851N/A specifies
935N/A the name of a character device or file containing random
606N/A data to be used instead of the default. The special value
935N/A <code class="filename">keyboard</code> indicates that keyboard
935N/A input should be used.
935N/A </p></dd>
935N/A<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
212N/A<dd><p>
98N/A Specifies the IP address where <span><strong class="command">named</strong></span>
98N/A listens for command channel connections from
98N/A <span><strong class="command">rndc</strong></span>. The default is the loopback
98N/A address 127.0.0.1.
182N/A </p></dd>
98N/A<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
908N/A<dd><p>
963N/A Used with the <span><strong class="command">-a</strong></span> option to specify
963N/A a directory where <span><strong class="command">named</strong></span> will run
963N/A chrooted. An additional copy of the <code class="filename">rndc.key</code>
908N/A will be written relative to this directory so that
963N/A it will be found by the chrooted <span><strong class="command">named</strong></span>.
963N/A </p></dd>
963N/A<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
963N/A<dd><p>
963N/A Used with the <span><strong class="command">-a</strong></span> option to set the
963N/A owner
963N/A of the <code class="filename">rndc.key</code> file generated.
963N/A If
963N/A <span><strong class="command">-t</strong></span> is also specified only the file
963N/A in
963N/A the chroot area has its owner changed.
963N/A </p></dd>
963N/A</dl></div>
963N/A</div>
963N/A<div class="refsect1" lang="en">
963N/A<a name="id2664951"></a><h2>EXAMPLES</h2>
963N/A<p>
963N/A To allow <span><strong class="command">rndc</strong></span> to be used with
963N/A no manual configuration, run
963N/A </p>
963N/A<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
963N/A </p>
963N/A<p>
963N/A To print a sample <code class="filename">rndc.conf</code> file and
963N/A corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
963N/A statements to be manually inserted into <code class="filename">named.conf</code>,
963N/A run
963N/A </p>
963N/A<p><strong class="userinput"><code>rndc-confgen</code></strong>
963N/A </p>
963N/A</div>
963N/A<div class="refsect1" lang="en">
963N/A<a name="id2668967"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
<span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2669005"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<code class="filename">rndc.conf</code>�</td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span>
</td>
</tr>
</table>
</div>
<p style="text-align: center;">BIND 9.11.0pre-alpha</p>
</body>
</html>