d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
71cef386fae61275b03e203825680b39fedaa8c6Tinderbox User - Copyright (C) 2000-2018 Internet Systems Consortium, Inc. ("ISC")
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - This Source Code Form is subject to the terms of the Mozilla Public
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - License, v. 2.0. If a copy of the MPL was not distributed with this
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - file, You can obtain one at http://mozilla.org/MPL/2.0/.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<link rel="prev" href="man.rndc.html" title="rndc">
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater<link rel="next" href="man.rndc-confgen.html" title="rndc-confgen">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<table width="100%" summary="Navigation header">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<tr><th colspan="3" align="center"><code class="filename">rndc.conf</code></th></tr>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<th width="60%" align="center">Manual pages</th>
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater<td width="20%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a name="man.rndc.conf"></a><div class="titlepage"></div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User — rndc configuration file
7e71f05d8643aca84914437c900cb716444507e4Tinderbox User<a name="id-1.14.28.7"></a><h2>DESCRIPTION</h2>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <p><code class="filename">rndc.conf</code> is the configuration file
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt for <span class="command"><strong>rndc</strong></span>, the BIND 9 name server control
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews utility. This file has a similar structure and syntax to
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="filename">named.conf</code>. Statements are enclosed
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews in braces and terminated with a semi-colon. Clauses in
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews the statements are also semi-colon terminated. The usual
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews comment styles are supported:
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews C style: /* */
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews C++ style: // to end of line
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Unix style: # to end of line
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <p><code class="filename">rndc.conf</code> is much simpler than
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="filename">named.conf</code>. The file uses three
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews statements: an options statement, a server statement
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews and a key statement.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The <code class="option">options</code> statement contains five clauses.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The <code class="option">default-server</code> clause is followed by the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews name or address of a name server. This host will be used when
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews no name server is given as an argument to
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span class="command"><strong>rndc</strong></span>. The <code class="option">default-key</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews clause is followed by the name of a key which is identified by
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews a <code class="option">key</code> statement. If no
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">keyid</code> is provided on the rndc command line,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews and no <code class="option">key</code> clause is found in a matching
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">server</code> statement, this default key will be
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews used to authenticate the server's commands and responses. The
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">default-port</code> clause is followed by the port
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews to connect to on the remote name server. If no
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">port</code> option is provided on the rndc command
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews line, and no <code class="option">port</code> clause is found in a
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews matching <code class="option">server</code> statement, this default port
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews will be used to connect.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews 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
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark 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:
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">key</code>, <code class="option">port</code> and
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">addresses</code>. The key name must match the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews name of a key statement in the file. The port number
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews specifies the port to connect to. If an <code class="option">addresses</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews clause is supplied these addresses will be used instead of
f6da30bb5447c23d880b09f601441e70c5313557Mark Andrews the server name. Each address can take an optional port.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews If an <code class="option">source-address</code> or <code class="option">source-address-v6</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews of supplied then these will be used to specify the IPv4 and IPv6
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews source addresses respectively.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The <code class="option">key</code> statement begins with an identifying
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews string, the name of the key. The statement has two clauses.
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User <code class="option">algorithm</code> identifies the authentication algorithm
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt for <span class="command"><strong>rndc</strong></span> to use; currently only HMAC-MD5
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User (default), HMAC-SHA384 and HMAC-SHA512 are
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews supported. This is followed by a secret clause which contains
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User the base-64 encoding of the algorithm's authentication key. The
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews base-64 string is enclosed in double quotes.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews There are two common ways to generate the base-64 string for the
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt secret. The BIND 9 program <span class="command"><strong>rndc-confgen</strong></span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews be used to generate a random key, or the
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span class="command"><strong>mmencode</strong></span> program, also known as
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span class="command"><strong>mimencode</strong></span>, can be used to generate a
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt string from known input. <span class="command"><strong>mmencode</strong></span> does
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews ship with BIND 9 but is available on many systems. See the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews EXAMPLE section for sample command lines for each.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews default-server localhost;
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews default-key samplekey;
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews server localhost {
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews key samplekey;
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews server testserver {
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews key testkey;
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews addresses { localhost port 5353; };
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews key samplekey {
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User algorithm hmac-sha256;
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews key testkey {
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User algorithm hmac-sha256;
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews secret "R3HI8P6BKw9ZwXwN3VZKuQ==";
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt In the above example, <span class="command"><strong>rndc</strong></span> will by
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews the server at localhost (127.0.0.1) and the key called samplekey.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Commands to the localhost server will use the samplekey key, which
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews must also be defined in the server's configuration file with the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews same name and secret. The key statement indicates that samplekey
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User uses the HMAC-SHA256 algorithm and its secret clause contains the
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User base-64 encoding of the HMAC-SHA256 secret enclosed in double quotes.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt If <span class="command"><strong>rndc -s testserver</strong></span> is used then <span class="command"><strong>rndc</strong></span> will
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews connect to server on localhost port 5353 using the key testkey.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt To generate a random secret with <span class="command"><strong>rndc-confgen</strong></span>:
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <p><strong class="userinput"><code>rndc-confgen</code></strong>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews A complete <code class="filename">rndc.conf</code> file, including
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews randomly generated key, will be written to the standard
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews output. Commented-out <code class="option">key</code> and
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">controls</code> statements for
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="filename">named.conf</code> are also printed.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt To generate a base-64 secret with <span class="command"><strong>mmencode</strong></span>:
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <p><strong class="userinput"><code>echo "known plaintext for a secret" | mmencode</code></strong>
7e71f05d8643aca84914437c900cb716444507e4Tinderbox User<a name="id-1.14.28.9"></a><h2>NAME SERVER CONFIGURATION</h2>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The name server must be configured to accept rndc connections and
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews to recognize the key specified in the <code class="filename">rndc.conf</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews file, using the controls statement in <code class="filename">named.conf</code>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews See the sections on the <code class="option">controls</code> statement in the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews BIND 9 Administrator Reference Manual for details.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span class="refentrytitle">rndc-confgen</span>(8)
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span class="refentrytitle">mmencode</span>(1)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<table width="100%" summary="Navigation footer">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater<td width="40%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater<td width="40%" align="right" valign="top">�<span class="application">rndc-confgen</span>
c313914d0e66b20969215e519bbf2ab4ecf39512Tinderbox User<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.3 (Extended Support Version)</p>