man.rndc-confgen.html revision c92c50783e4e93699f2a42643b8f200b9b719c87
178f6ad061e54bc5babfca3577f72058fa0797c1Bob Halley - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC")
24a4fabc0b0508a2d2b4651454dba1dfa93968f2Tinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - Permission to use, copy, modify, and/or distribute this software for any
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - purpose with or without fee is hereby granted, provided that the above
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - copyright notice and this permission notice appear in all copies.
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
b897c52f865b2fc4e220e2110b874e59c716456bBob Halley<!-- $Id: man.rndc-confgen.html,v 1.224 2012/01/07 01:14:56 tbox Exp $ -->
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<a name="man.rndc-confgen"></a><div class="titlepage"></div>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<div class="cmdsynopsis"><p><code class="command">rndc-confgen</code> [<code class="option">-a</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>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<p><span><strong class="command">rndc-confgen</strong></span>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt generates configuration files
fcb54ce0a4f7377486df5bec83b3aa4711bf4131Mark Andrews for <span><strong class="command">rndc</strong></span>. It can be used as a
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence convenient alternative to writing the
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence and the corresponding <span><strong class="command">controls</strong></span>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence and <span><strong class="command">key</strong></span>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence statements in <code class="filename">named.conf</code> by hand.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence option to set up a <code class="filename">rndc.key</code> file and
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence avoid the need for a <code class="filename">rndc.conf</code> file
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt and a <span><strong class="command">controls</strong></span> statement altogether.
2d46d268ccff30bb50e661b47c6496d23d9156c7Mark Andrews Do automatic <span><strong class="command">rndc</strong></span> configuration.
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews This creates a file <code class="filename">rndc.key</code>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley in <code class="filename">/etc</code> (or whatever
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence was specified as when <acronym class="acronym">BIND</acronym> was
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence that is read by both <span><strong class="command">rndc</strong></span>
2d9bd38ec3fbbfe920757b8972d94f664a9b354bMark Andrews and <span><strong class="command">named</strong></span> on startup. The
2d9bd38ec3fbbfe920757b8972d94f664a9b354bMark Andrews <code class="filename">rndc.key</code> file defines a default
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence command channel and authentication key allowing
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence <span><strong class="command">rndc</strong></span> to communicate with
596912ee9ca8eb14d30707ec286ab5d28bd39b3eMark Andrews <span><strong class="command">named</strong></span> on the local host
8319af16557b81eba3277ee67215285f0823b587Mark Andrews with no further configuration.
9e5854255178c04170bc98839282d4cf3fae7443Mark Andrews Running <span><strong class="command">rndc-confgen -a</strong></span> allows
9e5854255178c04170bc98839282d4cf3fae7443Mark Andrews BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence with no changes to the existing BIND 8
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence <code class="filename">named.conf</code> file.
7f9f8c13c5e5e26e0ba2b82c0900d11ecf6269ceMark Andrews If a more elaborate configuration than that
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence generated by <span><strong class="command">rndc-confgen -a</strong></span>
c3e6fbe4b7471d843d015e3f1737b7edb9d0c547Mark Andrews is required, for example if rndc is to be used remotely,
c3e6fbe4b7471d843d015e3f1737b7edb9d0c547Mark Andrews you should run <span><strong class="command">rndc-confgen</strong></span> without
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence <span><strong class="command">-a</strong></span> option and set up a
a04588e781b513ae3b30e061ac98035802b5e8e8Mark Andrews as directed.
5e47b4200ed81b8e18e165fe3a626d9992003db4Mark Andrews<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Specifies the size of the authentication key in bits.
2320f230995995595438a9d9301d84931fd266ceMark Andrews Must be between 1 and 512 bits; the default is 128.
620a452ebe92fff63e85c5930a6e6dc8d9455918Mark Andrews<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
6dcb47e37f9f0cdb94bdabc3fa157ff07983c590Mark Andrews Used with the <span><strong class="command">-a</strong></span> option to specify
6dcb47e37f9f0cdb94bdabc3fa157ff07983c590Mark Andrews an alternate location for <code class="filename">rndc.key</code>.
f10370fd44f05fecc808d89c01b2d50df2b232f3Mark Andrews Prints a short summary of the options and arguments to
d3347bd01baee56e476982a7443ba18cdbaeebe1Mark Andrews <span><strong class="command">rndc-confgen</strong></span>.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Specifies the key name of the rndc authentication key.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt This must be a valid domain name.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt The default is <code class="constant">rndc-key</code>.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Specifies the command channel port where <span><strong class="command">named</strong></span>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley listens for connections from <span><strong class="command">rndc</strong></span>.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley The default is 953.
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence Specifies a source of random data for generating the
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence authorization. If the operating
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence system does not provide a <code class="filename">/dev/random</code>
a9558a6c63d9c6dbb2f3800b39ccb008652fcde3Mark Andrews or equivalent device, the default source of randomness
a9558a6c63d9c6dbb2f3800b39ccb008652fcde3Mark Andrews is keyboard input. <code class="filename">randomdev</code>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews the name of a character device or file containing random
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews data to be used instead of the default. The special value
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence <code class="filename">keyboard</code> indicates that keyboard
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt input should be used.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Specifies the IP address where <span><strong class="command">named</strong></span>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley listens for command channel connections from
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <span><strong class="command">rndc</strong></span>. The default is the loopback
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley address 127.0.0.1.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Used with the <span><strong class="command">-a</strong></span> option to specify
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt a directory where <span><strong class="command">named</strong></span> will run
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley chrooted. An additional copy of the <code class="filename">rndc.key</code>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley will be written relative to this directory so that
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley it will be found by the chrooted <span><strong class="command">named</strong></span>.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt Used with the <span><strong class="command">-a</strong></span> option to set the
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley of the <code class="filename">rndc.key</code> file generated.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt <span><strong class="command">-t</strong></span> is also specified only the file
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley the chroot area has its owner changed.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley To allow <span><strong class="command">rndc</strong></span> to be used with
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt no manual configuration, run
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley To print a sample <code class="filename">rndc.conf</code> file and