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