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