man.rndc-confgen.html revision 395c95214142142854509945adf3293c0270e1c5
205c10066a0acfeac52d1a135671f41d207b8557Automatic Updater - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
205c10066a0acfeac52d1a135671f41d207b8557Automatic Updater - Copyright (C) 2000-2003 Internet Software Consortium.
0c39b3ed9409ecb277d5e32fa763a4e4d6598df8Automatic Updater - Permission to use, copy, modify, and/or distribute this software for any
46da3117812814a29432a8d9a9ccf8acdbfdadceAutomatic Updater - purpose with or without fee is hereby granted, provided that the above
2bb3422dc683c013db7042f5736240de6b86f182Automatic Updater - copyright notice and this permission notice appear in all copies.
2ec4ab21838e218863d052ebfa3e106e04f50820Evan Hunt - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
ea854b585041ad19f70f7af15e08144ef2c2bd1bMark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
78cb74fab4665da2e2641ba909c6f59f74cc4193Automatic Updater - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
cd0aa2d941d1438fabb5337f1f38c49478edf71dAutomatic Updater - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
90ff38a0d8deaf5f9c2aa5916d99b2e572d28738Automatic Updater - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
ac4e70ff8955669341f435bc0a734a17c01af124Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
56874aef380a64a2c183b7c282c3e7a361d67fa1Automatic Updater<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
58be84825d7f5de30e50eb7206b37227ecd8055bAutomatic Updater<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
3cc98b8ecedcbc8465f1cf2740b966b315662430Automatic Updater<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
96713299d08c0735c18ebe8772dd2cc1ecd4356aAutomatic Updater<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews<table width="100%" summary="Navigation header">
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<th width="60%" align="center">Manual pages</th>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<a name="man.rndc-confgen"></a><div class="titlepage"></div>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<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>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<a name="id2663376"></a><h2>DESCRIPTION</h2>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<p><span><strong class="command">rndc-confgen</strong></span>
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater generates configuration files
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater for <span><strong class="command">rndc</strong></span>. It can be used as a
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater convenient alternative to writing the
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <code class="filename">rndc.conf</code> file
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater and the corresponding <span><strong class="command">controls</strong></span>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater and <span><strong class="command">key</strong></span>
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews statements in <code class="filename">named.conf</code> by hand.
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews option to set up a <code class="filename">rndc.key</code> file and
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington avoid the need for a <code class="filename">rndc.conf</code> file
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater and a <span><strong class="command">controls</strong></span> statement altogether.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Do automatic <span><strong class="command">rndc</strong></span> configuration.
1a06700908f5a1d9f4a8d51285a0fd971e2f9117Automatic Updater This creates a file <code class="filename">rndc.key</code>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews in <code class="filename">/etc</code> (or whatever
693c4232dfdffaff672197d4b9fea944c64cf80aAutomatic Updater was specified as when <acronym class="acronym">BIND</acronym> was
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater that is read by both <span><strong class="command">rndc</strong></span>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson and <span><strong class="command">named</strong></span> on startup. The
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <code class="filename">rndc.key</code> file defines a default
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater command channel and authentication key allowing
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews <span><strong class="command">rndc</strong></span> to communicate with
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <span><strong class="command">named</strong></span> on the local host
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson with no further configuration.
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson Running <span><strong class="command">rndc-confgen -a</strong></span> allows
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews with no changes to the existing BIND 8
b1265b5a06df36d490d4bdf54284fb133a1f5a84Automatic Updater <code class="filename">named.conf</code> file.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont If a more elaborate configuration than that
0c39b3ed9409ecb277d5e32fa763a4e4d6598df8Automatic Updater generated by <span><strong class="command">rndc-confgen -a</strong></span>
0c39b3ed9409ecb277d5e32fa763a4e4d6598df8Automatic Updater is required, for example if rndc is to be used remotely,
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont you should run <span><strong class="command">rndc-confgen</strong></span> without
f9119ad8f6114b2255e7545bf5cd187f4db0a89bAutomatic Updater <span><strong class="command">-a</strong></span> option and set up a
9174e44c14b1cb91a651fa1dc29470438c246ab9Automatic Updater <code class="filename">rndc.conf</code> and
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews as directed.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
b29e5c56eb74a6de1a84c29879afc90ffc6b1436Automatic Updater Specifies the algorithm to use for the TSIG key. Available
418cc932318b1d67f88a36904d88d8a5a0a2ba09Automatic Updater choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews hmac-sha384 and hmac-sha512. The default is hmac-md5.
0977f3f39ef6728516be7976452b9122c8f5607aAutomatic Updater<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Specifies the size of the authentication key in bits.
0c39b3ed9409ecb277d5e32fa763a4e4d6598df8Automatic Updater Must be between 1 and 512 bits; the default is the
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater Used with the <span><strong class="command">-a</strong></span> option to specify
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater an alternate location for <code class="filename">rndc.key</code>.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater Prints a short summary of the options and arguments to
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <span><strong class="command">rndc-confgen</strong></span>.
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater Specifies the key name of the rndc authentication key.
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater This must be a valid domain name.
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater The default is <code class="constant">rndc-key</code>.
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater Specifies the command channel port where <span><strong class="command">named</strong></span>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson listens for connections from <span><strong class="command">rndc</strong></span>.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater The default is 953.
27794bebe2634b5ac374e78972649c79300b876aAutomatic Updater<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
0ce87e5749aabb8eef1e0a37e4bd6e6ffa1d7196Automatic Updater Specifies a source of random data for generating the
0ce87e5749aabb8eef1e0a37e4bd6e6ffa1d7196Automatic Updater authorization. If the operating
27794bebe2634b5ac374e78972649c79300b876aAutomatic Updater system does not provide a <code class="filename">/dev/random</code>
2bb3422dc683c013db7042f5736240de6b86f182Automatic Updater or equivalent device, the default source of randomness
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater is keyboard input. <code class="filename">randomdev</code>
f4029eb7463e99df00618de89f0bee5ac062a237Automatic Updater the name of a character device or file containing random
19b3dc94bce93fa76bd7e066f9298630dbc9dcb4Automatic Updater data to be used instead of the default. The special value
d145b64cacc8d9cda51f9924ec70cd4661c3e2cfAutomatic Updater <code class="filename">keyboard</code> indicates that keyboard
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater input should be used.
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
0df8ead472f207020f8da22a185fe4b945248ab8Automatic Updater Specifies the IP address where <span><strong class="command">named</strong></span>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater listens for command channel connections from
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <span><strong class="command">rndc</strong></span>. The default is the loopback
bc0a53583d92309bebcf93c408e2f3247ebd3d3cAutomatic Updater address 127.0.0.1.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Used with the <span><strong class="command">-a</strong></span> option to specify
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater a directory where <span><strong class="command">named</strong></span> will run
7f79131f9a8e804b93c57f3c679065cce878b726Automatic Updater chrooted. An additional copy of the <code class="filename">rndc.key</code>
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater will be written relative to this directory so that
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater it will be found by the chrooted <span><strong class="command">named</strong></span>.
c453a50776145e9c1c3fc9c846cfa11f42505081Automatic Updater<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
19b3dc94bce93fa76bd7e066f9298630dbc9dcb4Automatic Updater Used with the <span><strong class="command">-a</strong></span> option to set the
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater of the <code class="filename">rndc.key</code> file generated.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <span><strong class="command">-t</strong></span> is also specified only the file
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater the chroot area has its owner changed.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater To allow <span><strong class="command">rndc</strong></span> to be used with
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater no manual configuration, run
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater To print a sample <code class="filename">rndc.conf</code> file and
80faf1588895fd26490f82f95a7a1b771df1c324Automatic Updater corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews statements to be manually inserted into <code class="filename">named.conf</code>,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<p><strong class="userinput"><code>rndc-confgen</code></strong>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
957a8884fb712885cdd8ef0474f5ff95ddc46b20Automatic Updater <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
b109432c3a939bff66a463be86c371bd88efe3aaAutomatic Updater <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<p><span class="corpauthor">Internet Systems Consortium</span>
cf7e98f59148b559946a7f1ca728471374f1eef3Automatic Updater<table width="100%" summary="Navigation footer">
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
361bec4bdec45042897fb479b7071cd05bbd56b9Automatic Updater<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
129090f0f6f91753b4a085ab635e28549fd018adAutomatic Updater<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
80faf1588895fd26490f82f95a7a1b771df1c324Automatic Updater<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span>
56e7dc0c24b04210dcbffb180a9e35644fb820daAutomatic Updater<p style="text-align: center;">BIND 9.11.0pre-alpha</p>