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