man.rndc-confgen.html revision 3e240d6559605696cadf630668683708b18de871
80833bb9a1bf25dcf19e814438a4b311d2e1f4cffuankg - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
a34684a59b60a4173c25035d0c627ef17e6dc215rpluem - Copyright (C) 2000-2003 Internet Software Consortium.
1337c7673efc1f80f634139fbad7cbb98a0dc657ylavic - Permission to use, copy, modify, and/or distribute this software for any
1337c7673efc1f80f634139fbad7cbb98a0dc657ylavic - purpose with or without fee is hereby granted, provided that the above
1337c7673efc1f80f634139fbad7cbb98a0dc657ylavic - copyright notice and this permission notice appear in all copies.
4da61833a1cbbca94094f9653fd970582b97a72etrawick - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
4da61833a1cbbca94094f9653fd970582b97a72etrawick - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
4da61833a1cbbca94094f9653fd970582b97a72etrawick - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
4da61833a1cbbca94094f9653fd970582b97a72etrawick - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
4789804be088bcd86ae637a29cdb7fda25169521jailletc - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
4789804be088bcd86ae637a29cdb7fda25169521jailletc - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4789804be088bcd86ae637a29cdb7fda25169521jailletc - PERFORMANCE OF THIS SOFTWARE.
e50c3026198fd496f183cda4c32a202925476778covener<!-- $Id$ -->
5b88c8507d5ef6d0c4cfbc78230294968175b638minfrin<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6c3b9cebb551140fbb25d58bae08b539b3802133ylavic<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
6c3b9cebb551140fbb25d58bae08b539b3802133ylavic<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
6c3b9cebb551140fbb25d58bae08b539b3802133ylavic<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
4f29b65ab4b547ad5dbe506e2d0ff5d12ead9247ylavic<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
4f29b65ab4b547ad5dbe506e2d0ff5d12ead9247ylavic<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
0a0df13b7f1f4f1a74fe295253d89ca3911b301aylavic<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
69301145375a889e7e37caf7cc7321ac0f91801erpluem<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
506bfe33206b2fece40ef25f695af39dd4130facjkaluza<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
506bfe33206b2fece40ef25f695af39dd4130facjkaluza<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
2e6f4d654c96c98b761fb012fd25c5d5b1558c44sf<a name="man.rndc-confgen"></a><div class="titlepage"></div>
17e6c95f3b22d18acdf8380fb26a8d0e10c80767ylavic<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
e8bd80a4bb88199d2f9a24a50345688e52d9c116ylavic<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>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic<p><span><strong class="command">rndc-confgen</strong></span>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic generates configuration files
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic for <span><strong class="command">rndc</strong></span>. It can be used as a
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic convenient alternative to writing the
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener and the corresponding <span><strong class="command">controls</strong></span>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener and <span><strong class="command">key</strong></span>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener statements in <code class="filename">named.conf</code> by hand.
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener option to set up a <code class="filename">rndc.key</code> file and
44ff304057225e944e220e981d434a046d14cf06covener avoid the need for a <code class="filename">rndc.conf</code> file
44ff304057225e944e220e981d434a046d14cf06covener and a <span><strong class="command">controls</strong></span> statement altogether.
032982212dbcc7c3cce95bf89c503bb56e185ac7kbrand Do automatic <span><strong class="command">rndc</strong></span> configuration.
caad2986f81ab263f7af41467dd622dc9add17f3ylavic This creates a file <code class="filename">rndc.key</code>
caad2986f81ab263f7af41467dd622dc9add17f3ylavic was specified as when <acronym class="acronym">BIND</acronym> was
f7317ff316c2b141feea31bddb74d5d3fa1584edjorton that is read by both <span><strong class="command">rndc</strong></span>
f7317ff316c2b141feea31bddb74d5d3fa1584edjorton and <span><strong class="command">named</strong></span> on startup. The
2165214331e4afafca4048f66f303d0253d7b001covener <code class="filename">rndc.key</code> file defines a default
a34684a59b60a4173c25035d0c627ef17e6dc215rpluem command channel and authentication key allowing
a34684a59b60a4173c25035d0c627ef17e6dc215rpluem <span><strong class="command">rndc</strong></span> to communicate with
1e2d421a36999d292042a5539971070d54aa6c63ylavic <span><strong class="command">named</strong></span> on the local host
1e2d421a36999d292042a5539971070d54aa6c63ylavic with no further configuration.
fa7ed98b9dc94c5845cf845aea0a44ecacd290c9humbedooh Running <span><strong class="command">rndc-confgen -a</strong></span> allows
fa7ed98b9dc94c5845cf845aea0a44ecacd290c9humbedooh BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
0b67eb8568cd58bb77082703951679b42cf098actrawick replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
0b67eb8568cd58bb77082703951679b42cf098actrawick with no changes to the existing BIND 8
09c87c777bed1655621bb20e1c46cb6b1a63279dcovener If a more elaborate configuration than that
6502b7b32f980cc2093bb3ebce37e5e4dc68fba4ylavic generated by <span><strong class="command">rndc-confgen -a</strong></span>
6502b7b32f980cc2093bb3ebce37e5e4dc68fba4ylavic is required, for example if rndc is to be used remotely,
3060ce7f798fbda7999cd4ddf89b525d2b294185covener you should run <span><strong class="command">rndc-confgen</strong></span> without
c1a63b8fad09c419c1a64f75993feb8a343a6801ylavic <span><strong class="command">-a</strong></span> option and set up a
e6b4bd1113567627ab6bb6c6a7105e1e01a7d889jailletc as directed.
457468b82e59d01eba00dd9d0817309c8f5e414ejim<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
457468b82e59d01eba00dd9d0817309c8f5e414ejim Specifies the algorithm to use for the TSIG key. Available
04983e3bd1754764eec7d6bb772fe3b0bf391771jorton choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
04983e3bd1754764eec7d6bb772fe3b0bf391771jorton hmac-sha384 and hmac-sha512. The default is hmac-md5.
15660979a30d251681463de2e0584853890082accovener<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
49dacedb6c387b786b7911082ff35121a45f414bcovener Specifies the size of the authentication key in bits.
49dacedb6c387b786b7911082ff35121a45f414bcovener Must be between 1 and 512 bits; the default is the
cfd9415521847b2f9394fad04fb701cfb955f503rjung<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
28c31fb73c1264bd1d0ff932573677030b024c7dwrowe Used with the <span><strong class="command">-a</strong></span> option to specify
28c31fb73c1264bd1d0ff932573677030b024c7dwrowe an alternate location for <code class="filename">rndc.key</code>.
63b9f1f5880391261705f696d7d65507bbe9ace3covener Prints a short summary of the options and arguments to
63b9f1f5880391261705f696d7d65507bbe9ace3covener <span><strong class="command">rndc-confgen</strong></span>.
49dacedb6c387b786b7911082ff35121a45f414bcovener<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
49dacedb6c387b786b7911082ff35121a45f414bcovener Specifies the key name of the rndc authentication key.
49dacedb6c387b786b7911082ff35121a45f414bcovener This must be a valid domain name.
3c990331fc6702119e4f5b8ba9eae3021aea5265jim<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
fc42512879dd0504532f52fe5d0d0383dda96a1eniq Specifies the command channel port where <span><strong class="command">named</strong></span>
fc42512879dd0504532f52fe5d0d0383dda96a1eniq listens for connections from <span><strong class="command">rndc</strong></span>.
fc42512879dd0504532f52fe5d0d0383dda96a1eniq The default is 953.
0451df5dc50fa5d8b3e07d92ee6a92e36a1181a5niq<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
da0442c0440caef34706e2c2f3af05cb65921cc0jailletc Specifies a source of random data for generating the
983528026996668ea295be95aedb9c7a346af470ylavic authorization. If the operating
da0442c0440caef34706e2c2f3af05cb65921cc0jailletc system does not provide a <code class="filename">/dev/random</code>
da0442c0440caef34706e2c2f3af05cb65921cc0jailletc or equivalent device, the default source of randomness
06b8f183140c8e02e0974e938a05078b511d1603covener is keyboard input. <code class="filename">randomdev</code>
06b8f183140c8e02e0974e938a05078b511d1603covener the name of a character device or file containing random
15890c9306ba98f6fc243e15a3c4778ddc7d773erpluem data to be used instead of the default. The special value
259878293a997ff49f5ddfc53d3739cbdc25444ecovener <code class="filename">keyboard</code> indicates that keyboard
259878293a997ff49f5ddfc53d3739cbdc25444ecovener input should be used.
259878293a997ff49f5ddfc53d3739cbdc25444ecovener<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
b54b024c06a19926832d77d40ba35ad8c41e4d3dminfrin Specifies the IP address where <span><strong class="command">named</strong></span>
b54b024c06a19926832d77d40ba35ad8c41e4d3dminfrin listens for command channel connections from
b54b024c06a19926832d77d40ba35ad8c41e4d3dminfrin <span><strong class="command">rndc</strong></span>. The default is the loopback
65967d05f839dbf27cf91d91fa79585eeae19660minfrin address 127.0.0.1.
65967d05f839dbf27cf91d91fa79585eeae19660minfrin<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
8152945ae46857b170cb227e79bb799f4fc7710dminfrin Used with the <span><strong class="command">-a</strong></span> option to specify
8152945ae46857b170cb227e79bb799f4fc7710dminfrin a directory where <span><strong class="command">named</strong></span> will run
8152945ae46857b170cb227e79bb799f4fc7710dminfrin chrooted. An additional copy of the <code class="filename">rndc.key</code>
8152945ae46857b170cb227e79bb799f4fc7710dminfrin will be written relative to this directory so that
75f5c2db254c0167a0e396254460de09b775d203trawick it will be found by the chrooted <span><strong class="command">named</strong></span>.
75f5c2db254c0167a0e396254460de09b775d203trawick<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
4f0358189bfa57b8e75bd6b94db264302a8f336amrumph Used with the <span><strong class="command">-a</strong></span> option to set the
5716f9c6daa92dde5f2f9d11ed63f7c9549c223atrawick of the <code class="filename">rndc.key</code> file generated.
5716f9c6daa92dde5f2f9d11ed63f7c9549c223atrawick <span><strong class="command">-t</strong></span> is also specified only the file
54d750a84a175d8e338880514d440773eb986b50covener the chroot area has its owner changed.
54d750a84a175d8e338880514d440773eb986b50covener To allow <span><strong class="command">rndc</strong></span> to be used with
7a3aa12f0eda24793ee26d6a179bd53132e9dae8covener no manual configuration, run
54d750a84a175d8e338880514d440773eb986b50covener<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
83b50288fa7d306324bba68832011ea08f5c7832covener To print a sample <code class="filename">rndc.conf</code> file and
5f066f496cd9f20a2a701255bc67d44e7cb46daetrawick corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
5f066f496cd9f20a2a701255bc67d44e7cb46daetrawick statements to be manually inserted into <code class="filename">named.conf</code>,
2e15620d724fb8e3a5be183b917359a2fd6e9468covener<p><strong class="userinput"><code>rndc-confgen</code></strong>
1b988c41ee505962781d110a3e4c2c90f1ea0aa4covener<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
1b988c41ee505962781d110a3e4c2c90f1ea0aa4covener <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
b8efdc95bec9cf089aa1be0bfd07d46aa1137a7acovener <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
b8efdc95bec9cf089aa1be0bfd07d46aa1137a7acovener <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
179565be4043d7e5f9161aa75271fa0a001866d9covener<p><span class="corpauthor">Internet Systems Consortium</span>
7b7430e701e9a31ce809da7c220bb8dfcf68c86etrawick<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
7b7430e701e9a31ce809da7c220bb8dfcf68c86etrawick<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
ccc20788c1e5fc973f36df634399c89acb70deaejerenkrantz<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
efe780dcf13b2b95effabf897d694d8f23feac74trawick<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
fe83f60b41477b14a37edcfcd1f7f5c5a1ebfe44minfrin<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span>
993d1261a278d7322bccef219101220b7b4fb8c5jkaluza<p style="text-align: center;">BIND 9.11.0pre-alpha</p>