1<!-- 2 - Copyright (C) 2004-2015 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: man.rndc-confgen.html,v 1.5 2015/09/03 07:33:34 christos Exp $ --> 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.ch13.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">-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> 51</div> 52<div class="refsect1" lang="en"> 53<a name="id2662315"></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="id2662381"></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">-A <em class="replaceable"><code>algorithm</code></em></span></dt> 109<dd><p> 110 Specifies the algorithm to use for the TSIG key. Available 111 choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, 112 hmac-sha384 and hmac-sha512. The default is hmac-md5. 113 </p></dd> 114<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt> 115<dd><p> 116 Specifies the size of the authentication key in bits. 117 Must be between 1 and 512 bits; the default is the 118 hash size. 119 </p></dd> 120<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt> 121<dd><p> 122 Used with the <span><strong class="command">-a</strong></span> option to specify 123 an alternate location for <code class="filename">rndc.key</code>. 124 </p></dd> 125<dt><span class="term">-h</span></dt> 126<dd><p> 127 Prints a short summary of the options and arguments to 128 <span><strong class="command">rndc-confgen</strong></span>. 129 </p></dd> 130<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt> 131<dd><p> 132 Specifies the key name of the rndc authentication key. 133 This must be a valid domain name. 134 The default is <code class="constant">rndc-key</code>. 135 </p></dd> 136<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt> 137<dd><p> 138 Specifies the command channel port where <span><strong class="command">named</strong></span> 139 listens for connections from <span><strong class="command">rndc</strong></span>. 140 The default is 953. 141 </p></dd> 142<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt> 143<dd><p> 144 Specifies a source of random data for generating the 145 authorization. If the operating 146 system does not provide a <code class="filename">/dev/random</code> 147 or equivalent device, the default source of randomness 148 is keyboard input. <code class="filename">randomdev</code> 149 specifies 150 the name of a character device or file containing random 151 data to be used instead of the default. The special value 152 <code class="filename">keyboard</code> indicates that keyboard 153 input should be used. 154 </p></dd> 155<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt> 156<dd><p> 157 Specifies the IP address where <span><strong class="command">named</strong></span> 158 listens for command channel connections from 159 <span><strong class="command">rndc</strong></span>. The default is the loopback 160 address 127.0.0.1. 161 </p></dd> 162<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt> 163<dd><p> 164 Used with the <span><strong class="command">-a</strong></span> option to specify 165 a directory where <span><strong class="command">named</strong></span> will run 166 chrooted. An additional copy of the <code class="filename">rndc.key</code> 167 will be written relative to this directory so that 168 it will be found by the chrooted <span><strong class="command">named</strong></span>. 169 </p></dd> 170<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt> 171<dd><p> 172 Used with the <span><strong class="command">-a</strong></span> option to set the 173 owner 174 of the <code class="filename">rndc.key</code> file generated. 175 If 176 <span><strong class="command">-t</strong></span> is also specified only the file 177 in 178 the chroot area has its owner changed. 179 </p></dd> 180</dl></div> 181</div> 182<div class="refsect1" lang="en"> 183<a name="id2663194"></a><h2>EXAMPLES</h2> 184<p> 185 To allow <span><strong class="command">rndc</strong></span> to be used with 186 no manual configuration, run 187 </p> 188<p><strong class="userinput"><code>rndc-confgen -a</code></strong> 189 </p> 190<p> 191 To print a sample <code class="filename">rndc.conf</code> file and 192 corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span> 193 statements to be manually inserted into <code class="filename">named.conf</code>, 194 run 195 </p> 196<p><strong class="userinput"><code>rndc-confgen</code></strong> 197 </p> 198</div> 199<div class="refsect1" lang="en"> 200<a name="id2665640"></a><h2>SEE ALSO</h2> 201<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>, 202 <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>, 203 <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, 204 <em class="citetitle">BIND 9 Administrator Reference Manual</em>. 205 </p> 206</div> 207<div class="refsect1" lang="en"> 208<a name="id2665678"></a><h2>AUTHOR</h2> 209<p><span class="corpauthor">Internet Systems Consortium</span> 210 </p> 211</div> 212</div> 213<div class="navfooter"> 214<hr> 215<table width="100%" summary="Navigation footer"> 216<tr> 217<td width="40%" align="left"> 218<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td> 219<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td> 220<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a> 221</td> 222</tr> 223<tr> 224<td width="40%" align="left" valign="top"> 225<code class="filename">rndc.conf</code>�</td> 226<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td> 227<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span> 228</td> 229</tr> 230</table> 231</div> 232<p style="text-align: center;">BIND 9.10.2-P4</p> 233</body> 234</html> 235