man.rndc-confgen.html revision fd2597f75693a2279fdf588bd40dfe2407c42028
2N/A<!--
2N/A - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
2N/A - Copyright (C) 2000-2003 Internet Software Consortium.
2N/A -
2N/A - Permission to use, copy, modify, and/or 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<html>
2N/A<head>
2N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
2N/A<title>rndc-confgen</title>
1900N/A<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
2N/A<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
2N/A<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
2N/A<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
2N/A<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
23N/A</head>
23N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23N/A<div class="navheader">
23N/A<table width="100%" summary="Navigation header">
23N/A<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
32N/A<tr>
32N/A<td width="20%" align="left">
32N/A<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
34N/A<th width="60%" align="center">Manual pages</th>
32N/A<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
34N/A</td>
32N/A</tr>
32N/A</table>
58N/A<hr>
32N/A</div>
225N/A<div class="refentry">
225N/A<a name="man.rndc-confgen"></a><div class="titlepage"></div>
225N/A<div class="refnamediv">
225N/A<h2>Name</h2>
225N/A<p><span class="application">rndc-confgen</span> &#8212; rndc key generation tool</p>
225N/A</div>
225N/A<div class="refsynopsisdiv">
225N/A<h2>Synopsis</h2>
225N/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>
225N/A</div>
2N/A<div class="refsection">
38N/A<a name="id-1.14.25.7"></a><h2>DESCRIPTION</h2>
38N/A<p><span class="command"><strong>rndc-confgen</strong></span>
38N/A generates configuration files
38N/A for <span class="command"><strong>rndc</strong></span>. It can be used as a
38N/A convenient alternative to writing the
38N/A <code class="filename">rndc.conf</code> file
38N/A and the corresponding <span class="command"><strong>controls</strong></span>
83N/A and <span class="command"><strong>key</strong></span>
1273N/A statements in <code class="filename">named.conf</code> by hand.
83N/A Alternatively, it can be run with the <span class="command"><strong>-a</strong></span>
99N/A option to set up a <code class="filename">rndc.key</code> file and
2N/A avoid the need for a <code class="filename">rndc.conf</code> file
92N/A and a <span class="command"><strong>controls</strong></span> statement altogether.
634N/A </p>
92N/A</div>
634N/A<div class="refsection">
92N/A<a name="id-1.14.25.8"></a><h2>OPTIONS</h2>
1900N/A<div class="variablelist"><dl class="variablelist">
1900N/A<dt><span class="term">-a</span></dt>
1900N/A<dd>
1900N/A<p>
1900N/A Do automatic <span class="command"><strong>rndc</strong></span> configuration.
1900N/A This creates a file <code class="filename">rndc.key</code>
1900N/A in <code class="filename">/etc</code> (or whatever
2N/A <code class="varname">sysconfdir</code>
2N/A was specified as when <acronym class="acronym">BIND</acronym> was
313N/A built)
2N/A that is read by both <span class="command"><strong>rndc</strong></span>
34N/A and <span class="command"><strong>named</strong></span> on startup. The
2N/A <code class="filename">rndc.key</code> file defines a default
313N/A command channel and authentication key allowing
313N/A <span class="command"><strong>rndc</strong></span> to communicate with
1273N/A <span class="command"><strong>named</strong></span> on the local host
1273N/A with no further configuration.
313N/A </p>
34N/A<p>
2N/A Running <span class="command"><strong>rndc-confgen -a</strong></span> allows
313N/A BIND 9 and <span class="command"><strong>rndc</strong></span> to be used as
814N/A drop-in
53N/A replacements for BIND 8 and <span class="command"><strong>ndc</strong></span>,
34N/A with no changes to the existing BIND 8
814N/A <code class="filename">named.conf</code> file.
70N/A </p>
2N/A<p>
2N/A If a more elaborate configuration than that
2N/A generated by <span class="command"><strong>rndc-confgen -a</strong></span>
2N/A is required, for example if rndc is to be used remotely,
70N/A you should run <span class="command"><strong>rndc-confgen</strong></span> without
105N/A the
105N/A <span class="command"><strong>-a</strong></span> option and set up a
883N/A <code class="filename">rndc.conf</code> and
2N/A <code class="filename">named.conf</code>
634N/A as directed.
634N/A </p>
634N/A</dd>
634N/A<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
634N/A<dd><p>
2238N/A Specifies the algorithm to use for the TSIG key. Available
70N/A choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
70N/A hmac-sha384 and hmac-sha512. The default is hmac-md5.
634N/A </p></dd>
70N/A<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
70N/A<dd><p>
70N/A Specifies the size of the authentication key in bits.
70N/A Must be between 1 and 512 bits; the default is the
70N/A hash size.
70N/A </p></dd>
6N/A<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
814N/A<dd><p>
6N/A Used with the <span class="command"><strong>-a</strong></span> option to specify
34N/A an alternate location for <code class="filename">rndc.key</code>.
34N/A </p></dd>
34N/A<dt><span class="term">-h</span></dt>
34N/A<dd><p>
34N/A Prints a short summary of the options and arguments to
34N/A <span class="command"><strong>rndc-confgen</strong></span>.
34N/A </p></dd>
313N/A<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
38N/A<dd><p>
34N/A Specifies the key name of the rndc authentication key.
38N/A This must be a valid domain name.
34N/A The default is <code class="constant">rndc-key</code>.
2238N/A </p></dd>
1900N/A<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
500N/A<dd><p>
500N/A Specifies the command channel port where <span class="command"><strong>named</strong></span>
500N/A listens for connections from <span class="command"><strong>rndc</strong></span>.
500N/A The default is 953.
500N/A </p></dd>
500N/A<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
500N/A<dd><p>
2238N/A Specifies a source of random data for generating the
2238N/A authorization. If the operating
2238N/A system does not provide a <code class="filename">/dev/random</code>
92N/A or equivalent device, the default source of randomness
92N/A is keyboard input. <code class="filename">randomdev</code>
92N/A specifies
92N/A the name of a character device or file containing random
92N/A data to be used instead of the default. The special value
92N/A <code class="filename">keyboard</code> indicates that keyboard
92N/A input should be used.
92N/A </p></dd>
313N/A<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
38N/A<dd><p>
34N/A Specifies the IP address where <span class="command"><strong>named</strong></span>
38N/A listens for command channel connections from
32N/A <span class="command"><strong>rndc</strong></span>. The default is the loopback
2N/A address 127.0.0.1.
</p></dd>
<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
<dd><p>
Used with the <span class="command"><strong>-a</strong></span> option to specify
a directory where <span class="command"><strong>named</strong></span> will run
chrooted. An additional copy of the <code class="filename">rndc.key</code>
will be written relative to this directory so that
it will be found by the chrooted <span class="command"><strong>named</strong></span>.
</p></dd>
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
<dd><p>
Used with the <span class="command"><strong>-a</strong></span> option to set the
owner
of the <code class="filename">rndc.key</code> file generated.
If
<span class="command"><strong>-t</strong></span> is also specified only the file
in
the chroot area has its owner changed.
</p></dd>
</dl></div>
</div>
<div class="refsection">
<a name="id-1.14.25.9"></a><h2>EXAMPLES</h2>
<p>
To allow <span class="command"><strong>rndc</strong></span> to be used with
no manual configuration, run
</p>
<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
</p>
<p>
To print a sample <code class="filename">rndc.conf</code> file and
corresponding <span class="command"><strong>controls</strong></span> and <span class="command"><strong>key</strong></span>
statements to be manually inserted into <code class="filename">named.conf</code>,
run
</p>
<p><strong class="userinput"><code>rndc-confgen</code></strong>
</p>
</div>
<div class="refsection">
<a name="id-1.14.25.10"></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>
<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.ch13.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 xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.0pre-alpha</p>
</body>
</html>