PageRenderTime 69ms CodeModel.GetById 55ms app.highlight 10ms RepoModel.GetById 2ms app.codeStats 0ms

/contrib/bind9/bin/confgen/rndc-confgen.html

https://bitbucket.org/freebsd/freebsd-head/
HTML | 188 lines | 171 code | 0 blank | 17 comment | 0 complexity | 2394f37b01d5f5eb62e2eee98e8be163 MD5 | raw file
  1<!--
  2 - Copyright (C) 2004, 2005, 2007, 2009 Internet Systems Consortium, Inc. ("ISC")
  3 - Copyright (C) 2001, 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</head>
 24<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
 25<a name="man.rndc-confgen"></a><div class="titlepage"></div>
 26<div class="refnamediv">
 27<h2>Name</h2>
 28<p><span class="application">rndc-confgen</span> &#8212; rndc key generation tool</p>
 29</div>
 30<div class="refsynopsisdiv">
 31<h2>Synopsis</h2>
 32<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>
 33</div>
 34<div class="refsect1" lang="en">
 35<a name="id2543433"></a><h2>DESCRIPTION</h2>
 36<p><span><strong class="command">rndc-confgen</strong></span>
 37      generates configuration files
 38      for <span><strong class="command">rndc</strong></span>.  It can be used as a
 39      convenient alternative to writing the
 40      <code class="filename">rndc.conf</code> file
 41      and the corresponding <span><strong class="command">controls</strong></span>
 42      and <span><strong class="command">key</strong></span>
 43      statements in <code class="filename">named.conf</code> by hand.
 44      Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
 45      option to set up a <code class="filename">rndc.key</code> file and
 46      avoid the need for a <code class="filename">rndc.conf</code> file
 47      and a <span><strong class="command">controls</strong></span> statement altogether.
 48    </p>
 49</div>
 50<div class="refsect1" lang="en">
 51<a name="id2543478"></a><h2>OPTIONS</h2>
 52<div class="variablelist"><dl>
 53<dt><span class="term">-a</span></dt>
 54<dd>
 55<p>
 56            Do automatic <span><strong class="command">rndc</strong></span> configuration.
 57            This creates a file <code class="filename">rndc.key</code>
 58            in <code class="filename">/etc</code> (or whatever
 59            <code class="varname">sysconfdir</code>
 60            was specified as when <acronym class="acronym">BIND</acronym> was
 61            built)
 62            that is read by both <span><strong class="command">rndc</strong></span>
 63            and <span><strong class="command">named</strong></span> on startup.  The
 64            <code class="filename">rndc.key</code> file defines a default
 65            command channel and authentication key allowing
 66            <span><strong class="command">rndc</strong></span> to communicate with
 67            <span><strong class="command">named</strong></span> on the local host
 68            with no further configuration.
 69          </p>
 70<p>
 71            Running <span><strong class="command">rndc-confgen -a</strong></span> allows
 72            BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
 73            drop-in
 74            replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
 75            with no changes to the existing BIND 8
 76            <code class="filename">named.conf</code> file.
 77          </p>
 78<p>
 79            If a more elaborate configuration than that
 80            generated by <span><strong class="command">rndc-confgen -a</strong></span>
 81            is required, for example if rndc is to be used remotely,
 82            you should run <span><strong class="command">rndc-confgen</strong></span> without
 83            the
 84            <span><strong class="command">-a</strong></span> option and set up a
 85            <code class="filename">rndc.conf</code> and
 86            <code class="filename">named.conf</code>
 87            as directed.
 88          </p>
 89</dd>
 90<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
 91<dd><p>
 92            Specifies the size of the authentication key in bits.
 93            Must be between 1 and 512 bits; the default is 128.
 94          </p></dd>
 95<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
 96<dd><p>
 97            Used with the <span><strong class="command">-a</strong></span> option to specify
 98            an alternate location for <code class="filename">rndc.key</code>.
 99          </p></dd>
100<dt><span class="term">-h</span></dt>
101<dd><p>
102            Prints a short summary of the options and arguments to
103            <span><strong class="command">rndc-confgen</strong></span>.
104          </p></dd>
105<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
106<dd><p>
107            Specifies the key name of the rndc authentication key.
108            This must be a valid domain name.
109            The default is <code class="constant">rndc-key</code>.
110          </p></dd>
111<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
112<dd><p>
113            Specifies the command channel port where <span><strong class="command">named</strong></span>
114            listens for connections from <span><strong class="command">rndc</strong></span>.
115            The default is 953.
116          </p></dd>
117<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
118<dd><p>
119            Specifies a source of random data for generating the
120            authorization.  If the operating
121            system does not provide a <code class="filename">/dev/random</code>
122            or equivalent device, the default source of randomness
123            is keyboard input.  <code class="filename">randomdev</code>
124            specifies
125            the name of a character device or file containing random
126            data to be used instead of the default.  The special value
127            <code class="filename">keyboard</code> indicates that keyboard
128            input should be used.
129          </p></dd>
130<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
131<dd><p>
132            Specifies the IP address where <span><strong class="command">named</strong></span>
133            listens for command channel connections from
134            <span><strong class="command">rndc</strong></span>.  The default is the loopback
135            address 127.0.0.1.
136          </p></dd>
137<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
138<dd><p>
139            Used with the <span><strong class="command">-a</strong></span> option to specify
140            a directory where <span><strong class="command">named</strong></span> will run
141            chrooted.  An additional copy of the <code class="filename">rndc.key</code>
142            will be written relative to this directory so that
143            it will be found by the chrooted <span><strong class="command">named</strong></span>.
144          </p></dd>
145<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
146<dd><p>
147            Used with the <span><strong class="command">-a</strong></span> option to set the
148            owner
149            of the <code class="filename">rndc.key</code> file generated.
150            If
151            <span><strong class="command">-t</strong></span> is also specified only the file
152            in
153            the chroot area has its owner changed.
154          </p></dd>
155</dl></div>
156</div>
157<div class="refsect1" lang="en">
158<a name="id2543792"></a><h2>EXAMPLES</h2>
159<p>
160      To allow <span><strong class="command">rndc</strong></span> to be used with
161      no manual configuration, run
162    </p>
163<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
164    </p>
165<p>
166      To print a sample <code class="filename">rndc.conf</code> file and
167      corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
168      statements to be manually inserted into <code class="filename">named.conf</code>,
169      run
170    </p>
171<p><strong class="userinput"><code>rndc-confgen</code></strong>
172    </p>
173</div>
174<div class="refsect1" lang="en">
175<a name="id2543833"></a><h2>SEE ALSO</h2>
176<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
177      <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
178      <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
179      <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
180    </p>
181</div>
182<div class="refsect1" lang="en">
183<a name="id2543872"></a><h2>AUTHOR</h2>
184<p><span class="corpauthor">Internet Systems Consortium</span>
185    </p>
186</div>
187</div></body>
188</html>