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