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