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