man.rndc-confgen.html revision 5f0c46ca5f68c2148c735aa52d7541baac249c34
885f47576842cf3c569315b9a48bd9f0ca03f203Automatic Updater - Copyright (C) 2000-2015 Internet Systems Consortium, Inc. ("ISC")
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater - This Source Code Form is subject to the terms of the Mozilla Public
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater - License, v. 2.0. If a copy of the MPL was not distributed with this
2bb3422dc683c013db7042f5736240de6b86f182Automatic Updater - file, You can obtain one at http://mozilla.org/MPL/2.0/.
bb93c8542756719b53096b9939e4041d0966026fAutomatic Updater<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
90ff38a0d8deaf5f9c2aa5916d99b2e572d28738Automatic Updater<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
ac4e70ff8955669341f435bc0a734a17c01af124Mark Andrews<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
6c6a121295b30772cbf3dd75a51fb9d883051a0eAutomatic Updater<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
bc0a53583d92309bebcf93c408e2f3247ebd3d3cAutomatic Updater<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<table width="100%" summary="Navigation header">
96713299d08c0735c18ebe8772dd2cc1ecd4356aAutomatic Updater<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
96713299d08c0735c18ebe8772dd2cc1ecd4356aAutomatic Updater<th width="60%" align="center">Manual pages</th>
80faf1588895fd26490f82f95a7a1b771df1c324Automatic Updater<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews<a name="man.rndc-confgen"></a><div class="titlepage"></div>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<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="id-1.14.25.7"></a><h2>DESCRIPTION</h2>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<p><span class="command"><strong>rndc-confgen</strong></span>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt generates configuration files
2d2dc37599979c83495510f8af8d1756753aa2c5Automatic Updater for <span class="command"><strong>rndc</strong></span>. It can be used as a
2d2dc37599979c83495510f8af8d1756753aa2c5Automatic Updater convenient alternative to writing the
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater and the corresponding <span class="command"><strong>controls</strong></span>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater and <span class="command"><strong>key</strong></span>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater statements in <code class="filename">named.conf</code> by hand.
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater Alternatively, it can be run with the <span class="command"><strong>-a</strong></span>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater option to set up a <code class="filename">rndc.key</code> file and
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater avoid the need for a <code class="filename">rndc.conf</code> file
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater and a <span class="command"><strong>controls</strong></span> statement altogether.
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<a name="id-1.14.25.8"></a><h2>OPTIONS</h2>
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews<div class="variablelist"><dl class="variablelist">
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Do automatic <span class="command"><strong>rndc</strong></span> configuration.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews This creates a file <code class="filename">rndc.key</code>
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater in <code class="filename">/etc</code> (or whatever
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews was specified as when <acronym class="acronym">BIND</acronym> was
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews that is read by both <span class="command"><strong>rndc</strong></span>
db5b7e2cdf150c46e8242d3e2e3ad3f5c7300258Automatic Updater and <span class="command"><strong>named</strong></span> on startup. The
80faf1588895fd26490f82f95a7a1b771df1c324Automatic Updater <code class="filename">rndc.key</code> file defines a default
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews command channel and authentication key allowing
ca904804e43f663f08eb1ac9d6d617930b9a3cd3Automatic Updater <span class="command"><strong>rndc</strong></span> to communicate with
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <span class="command"><strong>named</strong></span> on the local host
db5b7e2cdf150c46e8242d3e2e3ad3f5c7300258Automatic Updater with no further configuration.
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews Running <span class="command"><strong>rndc-confgen -a</strong></span> allows
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson BIND 9 and <span class="command"><strong>rndc</strong></span> to be used as
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews replacements for BIND 8 and <span class="command"><strong>ndc</strong></span>,
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews with no changes to the existing BIND 8
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews If a more elaborate configuration than that
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson generated by <span class="command"><strong>rndc-confgen -a</strong></span>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews is required, for example if rndc is to be used remotely,
d145b64cacc8d9cda51f9924ec70cd4661c3e2cfAutomatic Updater you should run <span class="command"><strong>rndc-confgen</strong></span> without
9174e44c14b1cb91a651fa1dc29470438c246ab9Automatic Updater <span class="command"><strong>-a</strong></span> option and set up a
55e03fc54708d97917bf26639b987f759bdc1f44Automatic Updater <code class="filename">rndc.conf</code> and
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Specifies the algorithm to use for the TSIG key. Available
52367885450d8f61d4f2d63292beb15ba8f39ac7Automatic Updater choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
9174e44c14b1cb91a651fa1dc29470438c246ab9Automatic Updater hmac-sha384 and hmac-sha512. The default is hmac-md5.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater Specifies the size of the authentication key in bits.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Must be between 1 and 512 bits; the default is the
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater Used with the <span class="command"><strong>-a</strong></span> option to specify
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater an alternate location for <code class="filename">rndc.key</code>.
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater Prints a short summary of the options and arguments to
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews <span class="command"><strong>rndc-confgen</strong></span>.
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson Specifies the key name of the rndc authentication key.
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews This must be a valid domain name.
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson The default is <code class="constant">rndc-key</code>.
d145b64cacc8d9cda51f9924ec70cd4661c3e2cfAutomatic Updater<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
e8c7dc2a5ce48f11c07a67c9923eeb8f419ff19fEvan Hunt Specifies the command channel port where <span class="command"><strong>named</strong></span>
0ce87e5749aabb8eef1e0a37e4bd6e6ffa1d7196Automatic Updater listens for connections from <span class="command"><strong>rndc</strong></span>.
0ce87e5749aabb8eef1e0a37e4bd6e6ffa1d7196Automatic Updater The default is 953.
2bb3422dc683c013db7042f5736240de6b86f182Automatic Updater<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
0df8ead472f207020f8da22a185fe4b945248ab8Automatic Updater Specifies a source of random data for generating the
3098364bcdd7a719fbafa5fc8d2cc9e90e5a5989Automatic Updater authorization. If the operating
19b3dc94bce93fa76bd7e066f9298630dbc9dcb4Automatic Updater system does not provide a <code class="filename">/dev/random</code>
d145b64cacc8d9cda51f9924ec70cd4661c3e2cfAutomatic Updater or equivalent device, the default source of randomness
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater is keyboard input. <code class="filename">randomdev</code>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater the name of a character device or file containing random
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater data to be used instead of the default. The special value
0df8ead472f207020f8da22a185fe4b945248ab8Automatic Updater <code class="filename">keyboard</code> indicates that keyboard
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater input should be used.
bc0a53583d92309bebcf93c408e2f3247ebd3d3cAutomatic Updater<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Specifies the IP address where <span class="command"><strong>named</strong></span>
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater listens for command channel connections from
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <span class="command"><strong>rndc</strong></span>. The default is the loopback
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater address 127.0.0.1.
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Used with the <span class="command"><strong>-a</strong></span> option to specify
7f94d9a8162c9a96b56e66176702b66e79d8e1a2Automatic Updater a directory where <span class="command"><strong>named</strong></span> will run
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater chrooted. An additional copy of the <code class="filename">rndc.key</code>
19b3dc94bce93fa76bd7e066f9298630dbc9dcb4Automatic Updater will be written relative to this directory so that
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater it will be found by the chrooted <span class="command"><strong>named</strong></span>.
7f94d9a8162c9a96b56e66176702b66e79d8e1a2Automatic Updater<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Used with the <span class="command"><strong>-a</strong></span> option to set the
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater of the <code class="filename">rndc.key</code> file generated.
71bd43eebd9d6e42dbcae62b730f5b6508d5acd8Automatic Updater <span class="command"><strong>-t</strong></span> is also specified only the file
7262eb86f2b465822206122921e2f357218f0cfdAutomatic Updater the chroot area has its owner changed.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater<a name="id-1.14.25.9"></a><h2>EXAMPLES</h2>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews To allow <span class="command"><strong>rndc</strong></span> to be used with
b0d566a2ce0f5a67f537ee7f8233f82f2584cc61Automatic Updater no manual configuration, run
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews To print a sample <code class="filename">rndc.conf</code> file and
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews corresponding <span class="command"><strong>controls</strong></span> and <span class="command"><strong>key</strong></span>
5ae0e2c8b72fa44237edeb37d1945b1c3535ca39Automatic Updater statements to be manually inserted into <code class="filename">named.conf</code>,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<p><strong class="userinput"><code>rndc-confgen</code></strong>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater<a name="id-1.14.25.10"></a><h2>SEE ALSO</h2>
7f94d9a8162c9a96b56e66176702b66e79d8e1a2Automatic Updater<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
7eda3642eea03f1181e41540c7c8791a57759383Automatic Updater<table width="100%" summary="Navigation footer">
00be0f9f61d4c6bf197d000bfa1a6b7e70ea0866Automatic 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>
59528addd704f8d5757b54e540520f74e588a7c7Automatic 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>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.0b3</p>