man.rndc.conf.html revision 36da16fa31fa2a582afe67010ba449a57177fd2f
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<!--
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - Copyright (C) 2004-2011 Internet Systems Consortium, Inc. ("ISC")
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - Copyright (C) 2000-2003 Internet Software Consortium.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk -
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - Permission to use, copy, modify, and/or distribute this software for any
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - purpose with or without fee is hereby granted, provided that the above
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - copyright notice and this permission notice appear in all copies.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk -
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - PERFORMANCE OF THIS SOFTWARE.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk-->
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<!-- $Id: man.rndc.conf.html,v 1.218 2011/11/07 01:15:05 tbox Exp $ -->
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<html>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<head>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<title>rndc.conf</title>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<link rel="prev" href="man.rndc.html" title="rndc">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<link rel="next" href="man.rndc-confgen.html" title="rndc-confgen">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk</head>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<div class="navheader">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<table width="100%" summary="Navigation header">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<tr><th colspan="3" align="center"><code class="filename">rndc.conf</code></th></tr>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<tr>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<td width="20%" align="left">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<th width="60%" align="center">Manual pages</th>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<td width="20%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk</td>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk</tr>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk</table>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<hr>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk</div>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<div class="refentry" lang="en">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<a name="man.rndc.conf"></a><div class="titlepage"></div>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<div class="refnamediv">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<h2>Name</h2>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<p><code class="filename">rndc.conf</code> &#8212; rndc configuration file</p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk</div>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<div class="refsynopsisdiv">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<h2>Synopsis</h2>
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk<div class="cmdsynopsis"><p><code class="command">rndc.conf</code> </p></div>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk</div>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<div class="refsect1" lang="en">
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<a name="id2641437"></a><h2>DESCRIPTION</h2>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<p><code class="filename">rndc.conf</code> is the configuration file
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk for <span><strong class="command">rndc</strong></span>, the BIND 9 name server control
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk utility. This file has a similar structure and syntax to
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <code class="filename">named.conf</code>. Statements are enclosed
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk in braces and terminated with a semi-colon. Clauses in
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk the statements are also semi-colon terminated. The usual
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk comment styles are supported:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk </p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk C style: /* */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk </p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk C++ style: // to end of line
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk </p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk Unix style: # to end of line
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk </p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<p><code class="filename">rndc.conf</code> is much simpler than
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <code class="filename">named.conf</code>. The file uses three
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk statements: an options statement, a server statement
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk and a key statement.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk </p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk The <code class="option">options</code> statement contains five clauses.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk The <code class="option">default-server</code> clause is followed by the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk name or address of a name server. This host will be used when
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk no name server is given as an argument to
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <span><strong class="command">rndc</strong></span>. The <code class="option">default-key</code>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk clause is followed by the name of a key which is identified by
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk a <code class="option">key</code> statement. If no
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <code class="option">keyid</code> is provided on the rndc command line,
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk and no <code class="option">key</code> clause is found in a matching
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <code class="option">server</code> statement, this default key will be
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk used to authenticate the server's commands and responses. The
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <code class="option">default-port</code> clause is followed by the port
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk to connect to on the remote name server. If no
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <code class="option">port</code> option is provided on the rndc command
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk line, and no <code class="option">port</code> clause is found in a
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk matching <code class="option">server</code> statement, this default port
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk will be used to connect.
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk The <code class="option">default-source-address</code> and
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <code class="option">default-source-address-v6</code> clauses which
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk can be used to set the IPv4 and IPv6 source addresses
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk respectively.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk </p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk After the <code class="option">server</code> keyword, the server
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk statement includes a string which is the hostname or address
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk for a name server. The statement has three possible clauses:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <code class="option">key</code>, <code class="option">port</code> and
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <code class="option">addresses</code>. The key name must match the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk name of a key statement in the file. The port number
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk specifies the port to connect to. If an <code class="option">addresses</code>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk clause is supplied these addresses will be used instead of
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk the server name. Each address can take an optional port.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk If an <code class="option">source-address</code> or <code class="option">source-address-v6</code>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk of supplied then these will be used to specify the IPv4 and IPv6
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk source addresses respectively.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk </p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk The <code class="option">key</code> statement begins with an identifying
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk string, the name of the key. The statement has two clauses.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <code class="option">algorithm</code> identifies the encryption algorithm
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk for <span><strong class="command">rndc</strong></span> to use; currently only HMAC-MD5
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk is
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk supported. This is followed by a secret clause which contains
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk the base-64 encoding of the algorithm's encryption key. The
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk base-64 string is enclosed in double quotes.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk </p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk There are two common ways to generate the base-64 string for the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk secret. The BIND 9 program <span><strong class="command">rndc-confgen</strong></span>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk can
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk be used to generate a random key, or the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <span><strong class="command">mmencode</strong></span> program, also known as
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk <span><strong class="command">mimencode</strong></span>, can be used to generate a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk base-64
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk string from known input. <span><strong class="command">mmencode</strong></span> does
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk not
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk ship with BIND 9 but is available on many systems. See the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk EXAMPLE section for sample command lines for each.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk </p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk</div>
<div class="refsect1" lang="en">
<a name="id2641609"></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="id2642004"></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="id2642029"></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="id2642273"></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>