d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
71cef386fae61275b03e203825680b39fedaa8c6Tinderbox User - Copyright (C) 2000-2018 Internet Systems Consortium, Inc. ("ISC")
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - This Source Code Form is subject to the terms of the Mozilla Public
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - License, v. 2.0. If a copy of the MPL was not distributed with this
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - file, You can obtain one at http://mozilla.org/MPL/2.0/.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<table width="100%" summary="Navigation header">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<th width="60%" align="center">Manual pages</th>
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a name="man.rndc-confgen"></a><div class="titlepage"></div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span class="application">rndc-confgen</span>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User — rndc key generation tool
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-A <em class="replaceable"><code>algorithm</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-p <em class="replaceable"><code>port</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-s <em class="replaceable"><code>address</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>]
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]
7e71f05d8643aca84914437c900cb716444507e4Tinderbox User<a name="id-1.14.29.7"></a><h2>DESCRIPTION</h2>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <p><span class="command"><strong>rndc-confgen</strong></span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews generates configuration files
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt for <span class="command"><strong>rndc</strong></span>. It can be used as a
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews convenient alternative to writing the
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt and the corresponding <span class="command"><strong>controls</strong></span>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt and <span class="command"><strong>key</strong></span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews statements in <code class="filename">named.conf</code> by hand.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Alternatively, it can be run with the <span class="command"><strong>-a</strong></span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews option to set up a <code class="filename">rndc.key</code> file and
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews avoid the need for a <code class="filename">rndc.conf</code> file
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt and a <span class="command"><strong>controls</strong></span> statement altogether.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <div class="variablelist"><dl class="variablelist">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Do automatic <span class="command"><strong>rndc</strong></span> configuration.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews This creates a file <code class="filename">rndc.key</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews in <code class="filename">/etc</code> (or whatever
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews was specified as when <acronym class="acronym">BIND</acronym> was
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt that is read by both <span class="command"><strong>rndc</strong></span>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt and <span class="command"><strong>named</strong></span> on startup. The
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="filename">rndc.key</code> file defines a default
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews command channel and authentication key allowing
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span class="command"><strong>rndc</strong></span> to communicate with
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span class="command"><strong>named</strong></span> on the local host
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews with no further configuration.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Running <span class="command"><strong>rndc-confgen -a</strong></span> allows
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt BIND 9 and <span class="command"><strong>rndc</strong></span> to be used as
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt replacements for BIND 8 and <span class="command"><strong>ndc</strong></span>,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews with no changes to the existing BIND 8
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews If a more elaborate configuration than that
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt generated by <span class="command"><strong>rndc-confgen -a</strong></span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews is required, for example if rndc is to be used remotely,
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt you should run <span class="command"><strong>rndc-confgen</strong></span> without
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span class="command"><strong>-a</strong></span> option and set up a
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews as directed.
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User Specifies the algorithm to use for the TSIG key. Available
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
281ed127e3ed6c7e07792c19c3bc4562f71cfa90Tinderbox User hmac-sha384 and hmac-sha512. The default is hmac-md5 or
281ed127e3ed6c7e07792c19c3bc4562f71cfa90Tinderbox User if MD5 was disabled hmac-sha256.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specifies the size of the authentication key in bits.
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User Must be between 1 and 512 bits; the default is the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Used with the <span class="command"><strong>-a</strong></span> option to specify
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews an alternate location for <code class="filename">rndc.key</code>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Prints a short summary of the options and arguments to
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span class="command"><strong>rndc-confgen</strong></span>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specifies the key name of the rndc authentication key.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews This must be a valid domain name.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The default is <code class="constant">rndc-key</code>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Specifies the command channel port where <span class="command"><strong>named</strong></span>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt listens for connections from <span class="command"><strong>rndc</strong></span>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The default is 953.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specifies a source of random data for generating the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews authorization. If the operating
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews system does not provide a <code class="filename">/dev/random</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews or equivalent device, the default source of randomness
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews is keyboard input. <code class="filename">randomdev</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews the name of a character device or file containing random
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews data to be used instead of the default. The special value
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="filename">keyboard</code> indicates that keyboard
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews input should be used.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Specifies the IP address where <span class="command"><strong>named</strong></span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews listens for command channel connections from
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span class="command"><strong>rndc</strong></span>. The default is the loopback
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews address 127.0.0.1.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Used with the <span class="command"><strong>-a</strong></span> option to specify
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt a directory where <span class="command"><strong>named</strong></span> will run
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews chrooted. An additional copy of the <code class="filename">rndc.key</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews will be written relative to this directory so that
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt it will be found by the chrooted <span class="command"><strong>named</strong></span>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Used with the <span class="command"><strong>-a</strong></span> option to set the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews of the <code class="filename">rndc.key</code> file generated.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span class="command"><strong>-t</strong></span> is also specified only the file
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews the chroot area has its owner changed.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt To allow <span class="command"><strong>rndc</strong></span> to be used with
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews no manual configuration, run
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <p><strong class="userinput"><code>rndc-confgen -a</code></strong>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews To print a sample <code class="filename">rndc.conf</code> file and
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt corresponding <span class="command"><strong>controls</strong></span> and <span class="command"><strong>key</strong></span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews statements to be manually inserted into <code class="filename">named.conf</code>,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <p><strong class="userinput"><code>rndc-confgen</code></strong>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span class="refentrytitle">rndc.conf</span>(5)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<table width="100%" summary="Navigation footer">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span>
c313914d0e66b20969215e519bbf2ab4ecf39512Tinderbox User<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.3 (Extended Support Version)</p>