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