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