man.rndc.conf.html revision 6101b9f0d904a708e900a74abc16d1e0eda67264
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Permission to use, copy, modify, and distribute this software for any
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - purpose with or without fee is hereby granted, provided that the above
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - PERFORMANCE OF THIS SOFTWARE.
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews<!-- $Id: man.rndc.conf.html,v 1.12 2005/12/05 02:08:05 marka Exp $ -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="prev" href="man.rndc.html" title="rndc">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="next" href="man.rndc-confgen.html" title="rndc-confgen">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr><th colspan="3" align="center"><code class="filename">rndc.conf</code></th></tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="man.rndc.conf"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><code class="filename">rndc.conf</code> — rndc configuration file</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="cmdsynopsis"><p><code class="command">rndc.conf</code> </p></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><code class="filename">rndc.conf</code> is the configuration file
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews for <span><strong class="command">rndc</strong></span>, the BIND 9 name server control
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews utility. This file has a similar structure and syntax to
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <code class="filename">named.conf</code>. Statements are enclosed
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews in braces and terminated with a semi-colon. Clauses in
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews the statements are also semi-colon terminated. The usual
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews comment styles are supported:
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews C style: /* */
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews C++ style: // to end of line
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Unix style: # to end of line
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><code class="filename">rndc.conf</code> is much simpler than
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <code class="filename">named.conf</code>. The file uses three
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews statements: an options statement, a server statement
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and a key statement.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <code class="option">options</code> statement contains five clauses.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <code class="option">default-server</code> clause is followed by the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein name or address of a name server. This host will be used when
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein no name server is given as an argument to
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <span><strong class="command">rndc</strong></span>. The <code class="option">default-key</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein clause is followed by the name of a key which is identified by
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews a <code class="option">key</code> statement. If no
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">keyid</code> is provided on the rndc command line,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and no <code class="option">key</code> clause is found in a matching
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">server</code> statement, this default key will be
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein used to authenticate the server's commands and responses. The
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <code class="option">default-port</code> clause is followed by the port
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to connect to on the remote name server. If no
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">port</code> option is provided on the rndc command
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein line, and no <code class="option">port</code> clause is found in a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein matching <code class="option">server</code> statement, this default port
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will be used to connect.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <code class="option">default-source-address</code> and
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">default-source-address-v6</code> clauses which
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews can be used to set the IPv4 and IPv6 source addresses
47012ae6dbf18a2503d7b33c1c9583dc38625cb7Mark Andrews respectively.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews After the <code class="option">server</code> keyword, the server
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews statement includes a string which is the hostname or address
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews for a name server. The statement has three possible clauses:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">key</code>, <code class="option">port</code> and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">addresses</code>. The key name must match the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein name of a key statement in the file. The port number
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein specifies the port to connect to. If an <code class="option">addresses</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein clause is supplied these addresses will be used instead of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the server name. Each address can take a optional port.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If an <code class="option">source-address</code> or <code class="option">source-address-v6</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein of supplied then these will be used to specify the IPv4 and IPv6
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein source addresses respectively.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <code class="option">key</code> statement begins with an identifying
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein string, the name of the key. The statement has two clauses.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">algorithm</code> identifies the encryption algorithm
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for <span><strong class="command">rndc</strong></span> to use; currently only HMAC-MD5
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein supported. This is followed by a secret clause which contains
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the base-64 encoding of the algorithm's encryption key. The
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein base-64 string is enclosed in double quotes.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein There are two common ways to generate the base-64 string for the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein secret. The BIND 9 program <span><strong class="command">rndc-confgen</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein be used to generate a random key, or the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">mmencode</strong></span> program, also known as
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">mimencode</strong></span>, can be used to generate a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein string from known input. <span><strong class="command">mmencode</strong></span> does
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ship with BIND 9 but is available on many systems. See the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein EXAMPLE section for sample command lines for each.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default-server localhost;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default-key samplekey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein server localhost {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key samplekey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein server testserver {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key testkey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein addresses { localhost port 5353; };
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key samplekey {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm hmac-md5;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key testkey {
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews algorithm hmac-md5;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein secret "R3HI8P6BKw9ZwXwN3VZKuQ==";
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein In the above example, <span><strong class="command">rndc</strong></span> will by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the server at localhost (127.0.0.1) and the key called samplekey.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Commands to the localhost server will use the samplekey key, which
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein must also be defined in the server's configuration file with the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein same name and secret. The key statement indicates that samplekey
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein uses the HMAC-MD5 algorithm and its secret clause contains the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein base-64 encoding of the HMAC-MD5 secret enclosed in double quotes.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If <span><strong class="command">rndc -s testserver</strong></span> is used then <span><strong class="command">rndc</strong></span> will
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein connect to server on localhost port 5353 using the key testkey.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein To generate a random secret with <span><strong class="command">rndc-confgen</strong></span>:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><strong class="userinput"><code>rndc-confgen</code></strong>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews A complete <code class="filename">rndc.conf</code> file, including
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein randomly generated key, will be written to the standard
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein output. Commented out <code class="option">key</code> and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">controls</code> statements for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="filename">named.conf</code> are also printed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein To generate a base-64 secret with <span><strong class="command">mmencode</strong></span>:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><strong class="userinput"><code>echo "known plaintext for a secret" | mmencode</code></strong>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a name="id2587185"></a><h2>NAME SERVER CONFIGURATION</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The name server must be configured to accept rndc connections and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to recognize the key specified in the <code class="filename">rndc.conf</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein file, using the controls statement in <code class="filename">named.conf</code>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein See the sections on the <code class="option">controls</code> statement in the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein BIND 9 Administrator Reference Manual for details.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <span class="citerefentry"><span class="refentrytitle">mmencode</span>(1)</span>,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="corpauthor">Internet Systems Consortium</span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="left" valign="top"><span class="application">rndc</span>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="right" valign="top">�<span class="application">rndc-confgen</span></td>