man.rndc-confgen.html revision 5a4557e8de2951a2796676b5ec4b6a90caa5be14
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence - Copyright (C) 2000-2003 Internet Software Consortium.
1633838b8255282d10af15c5c84cee5a51466712Bob Halley - Permission to use, copy, modify, and distribute this software for any
1633838b8255282d10af15c5c84cee5a51466712Bob Halley - purpose with or without fee is hereby granted, provided that the above
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence - copyright notice and this permission notice appear in all copies.
15a44745412679c30a6d022733925af70a38b715David Lawrence - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
15a44745412679c30a6d022733925af70a38b715David Lawrence - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
15a44745412679c30a6d022733925af70a38b715David Lawrence - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
15a44745412679c30a6d022733925af70a38b715David Lawrence - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15a44745412679c30a6d022733925af70a38b715David Lawrence - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
15a44745412679c30a6d022733925af70a38b715David Lawrence - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15a44745412679c30a6d022733925af70a38b715David Lawrence - PERFORMANCE OF THIS SOFTWARE.
c50fd34a4e0e6978f8ca5f6f3ad8545549c3cfeeBob Halley<!-- $Id: man.rndc-confgen.html,v 1.2 2005/07/19 06:12:22 marka Exp $ -->
c50fd34a4e0e6978f8ca5f6f3ad8545549c3cfeeBob Halley<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c50fd34a4e0e6978f8ca5f6f3ad8545549c3cfeeBob Halley<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
e4e071ae12aee942fefc2c0a3280e402938669deBob Halley<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
09f22ac5b09e70bc526015f37168ba33e21ea91fDavid Lawrence<table width="100%" summary="Navigation header">
09f22ac5b09e70bc526015f37168ba33e21ea91fDavid Lawrence<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
09f22ac5b09e70bc526015f37168ba33e21ea91fDavid Lawrence<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence<th width="60%" align="center">Manual pages</th>
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington<a name="man.rndc-confgen"></a><div class="titlepage"></div>
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington<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>
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington<a name="id2574887"></a><h2>DESCRIPTION</h2>
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington<p><span><strong class="command">rndc-confgen</strong></span>
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley generates configuration files
84cb41f729e2a8526300dd7a6cffaa66da5cf6cdMark Andrews for <span><strong class="command">rndc</strong></span>. It can be used as a
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington convenient alternative to writing the
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington <code class="filename">rndc.conf</code> file
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington and the corresponding <span><strong class="command">controls</strong></span>
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington and <span><strong class="command">key</strong></span>
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington statements in <code class="filename">named.conf</code> by hand.
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
618e871c2eb80021673bedf083496ccd1bf65cd0Brian Wellington option to set up a <code class="filename">rndc.key</code> file and
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington avoid the need for a <code class="filename">rndc.conf</code> file
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington and a <span><strong class="command">controls</strong></span> statement altogether.
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley Do automatic <span><strong class="command">rndc</strong></span> configuration.
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley This creates a file <code class="filename">rndc.key</code>
b55c30f2de6e1baaa3a9ba69b92f428f2c255ac3Mark Andrews in <code class="filename">/etc</code> (or whatever
308c7ad5f68301d19f023af616f62f3e7cbce632Andreas Gustafsson was specified as when <span class="acronym">BIND</span> was
04b8111f2137a9cf9b0b71228f76b3e40ffa1173Brian Wellington that is read by both <span><strong class="command">rndc</strong></span>
ccad3c9ecbe8a1060ff7b407a318ccd592de536eBrian Wellington and <span><strong class="command">named</strong></span> on startup. The
ccad3c9ecbe8a1060ff7b407a318ccd592de536eBrian Wellington <code class="filename">rndc.key</code> file defines a default
ccad3c9ecbe8a1060ff7b407a318ccd592de536eBrian Wellington command channel and authentication key allowing
ccad3c9ecbe8a1060ff7b407a318ccd592de536eBrian Wellington <span><strong class="command">rndc</strong></span> to communicate with
ccad3c9ecbe8a1060ff7b407a318ccd592de536eBrian Wellington <span><strong class="command">named</strong></span> on the local host
8224be5129daebea8f0f5e8be5f925679ec893f1Brian Wellington with no further configuration.
d14b749789121d9d502fa1348e9e73270e9b039fBob Halley Running <span><strong class="command">rndc-confgen -a</strong></span> allows
63d1ef9e771b748ca9bf241dfc1f07d3730203faBob Halley BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
cd02757774252fe5b92dbd59a24b34721fb49ff4Bob Halley replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
cd02757774252fe5b92dbd59a24b34721fb49ff4Bob Halley with no changes to the existing BIND 8
3864eb0e9a73148ac744893b5367169761184db5Mark Andrews If a more elaborate configuration than that
f53e43c37f2c978ccec0b49ed829426b213f9933Bob Halley generated by <span><strong class="command">rndc-confgen -a</strong></span>
afbc02482008c58af2c98000209165f6880835f7Mark Andrews is required, for example if rndc is to be used remotely,
e1f16346db02486f751c6db683fffe53c866c186Andreas Gustafsson you should run <span><strong class="command">rndc-confgen</strong></span> without
2ee24549b3dddd4046ee14257e1207cf2e34f29cBrian Wellington <span><strong class="command">-a</strong></span> option and set up a
20a313a4581e7f85fb2ce37430a146b3538da841Mark Andrews as directed.
b55c30f2de6e1baaa3a9ba69b92f428f2c255ac3Mark Andrews<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
6a56be50dd11702cb65347a57894ffd96a7e3501Andreas Gustafsson Specifies the size of the authentication key in bits.
1275a72e8db349ce249c84804b2b4861d33d4db7Brian Wellington Must be between 1 and 512 bits; the default is 128.
15af30dfc1c54a02d252dcf4c6f3b8759eaf0327Bob Halley<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
a93cf7e83be621d3d68f51e37121a47a70a6757bMark Andrews Used with the <span><strong class="command">-a</strong></span> option to specify
9ac7076ebad044afb15e9e2687e3696868778538Mark Andrews an alternate location for <code class="filename">rndc.key</code>.
01446841be2b73f9a2ead74056df2d5342414041Andreas Gustafsson Prints a short summary of the options and arguments to
ff1b064f5e2bf19c8e25f8927d23df5714e666edMark Andrews <span><strong class="command">rndc-confgen</strong></span>.
231ffa6c85cd04d5d83f80643e26fdc3ff510138Brian Wellington<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
0b09763c354ec91fb352b6b4cea383bd0195b2d8Mark Andrews Specifies the key name of the rndc authentication key.
4d9f3f00d93fcb8743b1105e8cf82e862be220d1Mark Andrews This must be a valid domain name.
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley The default is <code class="constant">rndc-key</code>.
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
894a2f61c9e3e51463bf21957c003d7c5636bdc5David Lawrence Specifies the command channel port where <span><strong class="command">named</strong></span>
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley listens for connections from <span><strong class="command">rndc</strong></span>.
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley The default is 953.
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley Specifies a source of random data for generating the
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley authorization. If the operating
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley system does not provide a <code class="filename">/dev/random</code>
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley or equivalent device, the default source of randomness
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley is keyboard input. <code class="filename">randomdev</code>
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley the name of a character device or file containing random
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley data to be used instead of the default. The special value
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley <code class="filename">keyboard</code> indicates that keyboard
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley input should be used.
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
125d72976ab6b8fa6629a5ace276a86e9fef91acBrian Wellington Specifies the IP address where <span><strong class="command">named</strong></span>
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley listens for command channel connections from
25e43e68b7431d5e4ff8b5427108cd7f5f9bcf3eBob Halley <span><strong class="command">rndc</strong></span>. The default is the loopback
c50fd34a4e0e6978f8ca5f6f3ad8545549c3cfeeBob Halley address 127.0.0.1.
09f22ac5b09e70bc526015f37168ba33e21ea91fDavid Lawrence<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
09f22ac5b09e70bc526015f37168ba33e21ea91fDavid Lawrence Used with the <span><strong class="command">-a</strong></span> option to specify
09f22ac5b09e70bc526015f37168ba33e21ea91fDavid Lawrence a directory where <span><strong class="command">named</strong></span> will run
09f22ac5b09e70bc526015f37168ba33e21ea91fDavid Lawrence chrooted. An additional copy of the <code class="filename">rndc.key</code>
09f22ac5b09e70bc526015f37168ba33e21ea91fDavid Lawrence will be written relative to this directory so that
09f22ac5b09e70bc526015f37168ba33e21ea91fDavid Lawrence it will be found by the chrooted <span><strong class="command">named</strong></span>.
09f22ac5b09e70bc526015f37168ba33e21ea91fDavid Lawrence<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley Used with the <span><strong class="command">-a</strong></span> option to set the
c50fd34a4e0e6978f8ca5f6f3ad8545549c3cfeeBob Halley of the <code class="filename">rndc.key</code> file generated.