1<!-- 2 - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC") 3 - Copyright (C) 2000-2003 Internet Software Consortium. 4 - 5 - Permission to use, copy, modify, and/or distribute this software for any 6 - purpose with or without fee is hereby granted, provided that the above 7 - copyright notice and this permission notice appear in all copies. 8 - 9 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 10 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 11 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 12 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 13 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 14 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 15 - PERFORMANCE OF THIS SOFTWARE. 16--> 17<!-- $Id$ --> 18<html> 19<head> 20<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 21<title>rndc-confgen</title> 22<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> 23<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual"> 24<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages"> 25<link rel="prev" href="man.rndc.conf.html" title="rndc.conf"> 26<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen"> 27</head> 28<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 29<div class="navheader"> 30<table width="100%" summary="Navigation header"> 31<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr> 32<tr> 33<td width="20%" align="left"> 34<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td> 35<th width="60%" align="center">Manual pages</th> 36<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a> 37</td> 38</tr> 39</table> 40<hr> 41</div> 42<div class="refentry" lang="en"> 43<a name="man.rndc-confgen"></a><div class="titlepage"></div> 44<div class="refnamediv"> 45<h2>Name</h2> 46<p><span class="application">rndc-confgen</span> — rndc key generation tool</p> 47</div> 48<div class="refsynopsisdiv"> 49<h2>Synopsis</h2> 50<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> 51</div> 52<div class="refsect1" lang="en"> 53<a name="id2642617"></a><h2>DESCRIPTION</h2> 54<p><span><strong class="command">rndc-confgen</strong></span> 55 generates configuration files 56 for <span><strong class="command">rndc</strong></span>. It can be used as a 57 convenient alternative to writing the 58 <code class="filename">rndc.conf</code> file 59 and the corresponding <span><strong class="command">controls</strong></span> 60 and <span><strong class="command">key</strong></span> 61 statements in <code class="filename">named.conf</code> by hand. 62 Alternatively, it can be run with the <span><strong class="command">-a</strong></span> 63 option to set up a <code class="filename">rndc.key</code> file and 64 avoid the need for a <code class="filename">rndc.conf</code> file 65 and a <span><strong class="command">controls</strong></span> statement altogether. 66 </p> 67</div> 68<div class="refsect1" lang="en"> 69<a name="id2642683"></a><h2>OPTIONS</h2> 70<div class="variablelist"><dl> 71<dt><span class="term">-a</span></dt> 72<dd> 73<p> 74 Do automatic <span><strong class="command">rndc</strong></span> configuration. 75 This creates a file <code class="filename">rndc.key</code> 76 in <code class="filename">/etc</code> (or whatever 77 <code class="varname">sysconfdir</code> 78 was specified as when <acronym class="acronym">BIND</acronym> was 79 built) 80 that is read by both <span><strong class="command">rndc</strong></span> 81 and <span><strong class="command">named</strong></span> on startup. The 82 <code class="filename">rndc.key</code> file defines a default 83 command channel and authentication key allowing 84 <span><strong class="command">rndc</strong></span> to communicate with 85 <span><strong class="command">named</strong></span> on the local host 86 with no further configuration. 87 </p> 88<p> 89 Running <span><strong class="command">rndc-confgen -a</strong></span> allows 90 BIND 9 and <span><strong class="command">rndc</strong></span> to be used as 91 drop-in 92 replacements for BIND 8 and <span><strong class="command">ndc</strong></span>, 93 with no changes to the existing BIND 8 94 <code class="filename">named.conf</code> file. 95 </p> 96<p> 97 If a more elaborate configuration than that 98 generated by <span><strong class="command">rndc-confgen -a</strong></span> 99 is required, for example if rndc is to be used remotely, 100 you should run <span><strong class="command">rndc-confgen</strong></span> without 101 the 102 <span><strong class="command">-a</strong></span> option and set up a 103 <code class="filename">rndc.conf</code> and 104 <code class="filename">named.conf</code> 105 as directed. 106 </p> 107</dd> 108<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt> 109<dd><p> 110 Specifies the size of the authentication key in bits. 111 Must be between 1 and 512 bits; the default is 128. 112 </p></dd> 113<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt> 114<dd><p> 115 Used with the <span><strong class="command">-a</strong></span> option to specify 116 an alternate location for <code class="filename">rndc.key</code>. 117 </p></dd> 118<dt><span class="term">-h</span></dt> 119<dd><p> 120 Prints a short summary of the options and arguments to 121 <span><strong class="command">rndc-confgen</strong></span>. 122 </p></dd> 123<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt> 124<dd><p> 125 Specifies the key name of the rndc authentication key. 126 This must be a valid domain name. 127 The default is <code class="constant">rndc-key</code>. 128 </p></dd> 129<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt> 130<dd><p> 131 Specifies the command channel port where <span><strong class="command">named</strong></span> 132 listens for connections from <span><strong class="command">rndc</strong></span>. 133 The default is 953. 134 </p></dd> 135<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt> 136<dd><p> 137 Specifies a source of random data for generating the 138 authorization. If the operating 139 system does not provide a <code class="filename">/dev/random</code> 140 or equivalent device, the default source of randomness 141 is keyboard input. <code class="filename">randomdev</code> 142 specifies 143 the name of a character device or file containing random 144 data to be used instead of the default. The special value 145 <code class="filename">keyboard</code> indicates that keyboard 146 input should be used. 147 </p></dd> 148<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt> 149<dd><p> 150 Specifies the IP address where <span><strong class="command">named</strong></span> 151 listens for command channel connections from 152 <span><strong class="command">rndc</strong></span>. The default is the loopback 153 address 127.0.0.1. 154 </p></dd> 155<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt> 156<dd><p> 157 Used with the <span><strong class="command">-a</strong></span> option to specify 158 a directory where <span><strong class="command">named</strong></span> will run 159 chrooted. An additional copy of the <code class="filename">rndc.key</code> 160 will be written relative to this directory so that 161 it will be found by the chrooted <span><strong class="command">named</strong></span>. 162 </p></dd> 163<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt> 164<dd><p> 165 Used with the <span><strong class="command">-a</strong></span> option to set the 166 owner 167 of the <code class="filename">rndc.key</code> file generated. 168 If 169 <span><strong class="command">-t</strong></span> is also specified only the file 170 in 171 the chroot area has its owner changed. 172 </p></dd> 173</dl></div> 174</div> 175<div class="refsect1" lang="en"> 176<a name="id2650101"></a><h2>EXAMPLES</h2> 177<p> 178 To allow <span><strong class="command">rndc</strong></span> to be used with 179 no manual configuration, run 180 </p> 181<p><strong class="userinput"><code>rndc-confgen -a</code></strong> 182 </p> 183<p> 184 To print a sample <code class="filename">rndc.conf</code> file and 185 corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span> 186 statements to be manually inserted into <code class="filename">named.conf</code>, 187 run 188 </p> 189<p><strong class="userinput"><code>rndc-confgen</code></strong> 190 </p> 191</div> 192<div class="refsect1" lang="en"> 193<a name="id2652410"></a><h2>SEE ALSO</h2> 194<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>, 195 <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>, 196 <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, 197 <em class="citetitle">BIND 9 Administrator Reference Manual</em>. 198 </p> 199</div> 200<div class="refsect1" lang="en"> 201<a name="id2652449"></a><h2>AUTHOR</h2> 202<p><span class="corpauthor">Internet Systems Consortium</span> 203 </p> 204</div> 205</div> 206<div class="navfooter"> 207<hr> 208<table width="100%" summary="Navigation footer"> 209<tr> 210<td width="40%" align="left"> 211<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td> 212<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td> 213<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a> 214</td> 215</tr> 216<tr> 217<td width="40%" align="left" valign="top"> 218<code class="filename">rndc.conf</code>�</td> 219<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td> 220<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span> 221</td> 222</tr> 223</table> 224</div> 225</body> 226</html> 227