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