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