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