fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater [<!ENTITY mdash "&#8212;">]>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<refentry id="man.rndc.conf">

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refentryinfo>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <date>June 30, 2000</date>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </refentryinfo>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refmeta>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refentrytitle><filename>rndc.conf</filename></refentrytitle>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <manvolnum>5</manvolnum>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refmiscinfo>BIND9</refmiscinfo>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </refmeta>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refnamediv>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refname><filename>rndc.conf</filename></refname>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refpurpose>rndc configuration file</refpurpose>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </refnamediv>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <docinfo>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <copyright>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <year>2004</year>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <year>2005</year>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <holder>Internet Systems Consortium, Inc. ("ISC")</holder>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </copyright>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <copyright>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <year>2000</year>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <year>2001</year>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <holder>Internet Software Consortium.</holder>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </copyright>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </docinfo>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refsynopsisdiv>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <cmdsynopsis>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <command>rndc.conf</command>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </cmdsynopsis>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </refsynopsisdiv>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <refsect1>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <title>DESCRIPTION</title>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <para><filename>rndc.conf</filename> is the configuration file

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater for <command>rndc</command>, the BIND 9 name server control

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater utility. This file has a similar structure and syntax to

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <filename>named.conf</filename>. Statements are enclosed

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater in braces and terminated with a semi-colon. Clauses in

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater the statements are also semi-colon terminated. The usual

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater comment styles are supported:

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater C style: /* */

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater C++ style: // to end of line

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater Unix style: # to end of line

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <para><filename>rndc.conf</filename> is much simpler than

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <filename>named.conf</filename>. The file uses three

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater statements: an options statement, a server statement

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater and a key statement.

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater The <option>options</option> statement contains five clauses.

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater The <option>default-server</option> clause is followed by the

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater name or address of a name server. This host will be used when

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater no name server is given as an argument to

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <command>rndc</command>. The <option>default-key</option>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater clause is followed by the name of a key which is identified by

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater a <option>key</option> statement. If no

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <option>keyid</option> is provided on the rndc command line,

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater and no <option>key</option> clause is found in a matching

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <option>server</option> statement, this default key will be

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater used to authenticate the server's commands and responses. The

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <option>default-port</option> clause is followed by the port

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater to connect to on the remote name server. If no

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <option>port</option> option is provided on the rndc command

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater line, and no <option>port</option> clause is found in a

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater matching <option>server</option> statement, this default port

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater will be used to connect.

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater The <option>default-source-address</option> and

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <option>default-source-address-v6</option> clauses which

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater can be used to set the IPv4 and IPv6 source addresses

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater respectively.

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <para>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater After the <option>server</option> keyword, the server

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater statement includes a string which is the hostname or address

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater for a name server. The statement has three possible clauses:

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <option>key</option>, <option>port</option> and

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <option>addresses</option>. The key name must match the

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater name of a key statement in the file. The port number

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater specifies the port to connect to. If an <option>addresses</option>

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater clause is supplied these addresses will be used instead of

fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater the server name. Each address can take a optional port.

If an <option>source-address</option> or <option>source-address-v6</option>

of supplied then these will be used to specify the IPv4 and IPv6

source addresses respectively.

</para>

<para>

The <option>key</option> statement begins with an identifying

string, the name of the key. The statement has two clauses.

<option>algorithm</option> identifies the encryption algorithm

for <command>rndc</command> 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.

</para>

<para>

There are two common ways to generate the base-64 string for the

secret. The BIND 9 program <command>rndc-confgen</command>

can

be used to generate a random key, or the

<command>mmencode</command> program, also known as

<command>mimencode</command>, can be used to generate a

base-64

string from known input. <command>mmencode</command> does

not

ship with BIND 9 but is available on many systems. See the

EXAMPLE section for sample command lines for each.

</para>

</refsect1>

<refsect1>

<title>EXAMPLE</title>

<para><programlisting>

options {

default-server localhost;

default-key samplekey;

};

</programlisting>

</para>

<para><programlisting>

server localhost {

key samplekey;

};

</programlisting>

</para>

<para><programlisting>

server testserver {

key testkey;

addresses { localhost port 5353; };

};

</programlisting>

</para>

<para><programlisting>

key samplekey {

algorithm hmac-md5;

secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";

};

</programlisting>

</para>

<para><programlisting>

key testkey {

algorithm hmac-md5;

secret "R3HI8P6BKw9ZwXwN3VZKuQ==";

}

</programlisting>

</para>

<para>

In the above example, <command>rndc</command> 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.

</para>

<para>

If <command>rndc -s testserver</command> is used then <command>rndc</command> will

connect to server on localhost port 5353 using the key testkey.

</para>

<para>

To generate a random secret with <command>rndc-confgen</command>:

</para>

<para><userinput>rndc-confgen</userinput>

</para>

<para>

A complete <filename>rndc.conf</filename> file, including

the

randomly generated key, will be written to the standard

output. Commented out <option>key</option> and

<option>controls</option> statements for

<filename>named.conf</filename> are also printed.

</para>

<para>

To generate a base-64 secret with <command>mmencode</command>:

</para>

<para><userinput>echo "known plaintext for a secret" | mmencode</userinput>

</para>

</refsect1>

<refsect1>

<title>NAME SERVER CONFIGURATION</title>

<para>

The name server must be configured to accept rndc connections and

to recognize the key specified in the <filename>rndc.conf</filename>

file, using the controls statement in <filename>named.conf</filename>.

See the sections on the <option>controls</option> statement in the

BIND 9 Administrator Reference Manual for details.

</para>

</refsect1>

<refsect1>

<title>SEE ALSO</title>

<para><citerefentry>

<refentrytitle>rndc</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>rndc-confgen</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>mmencode</refentrytitle><manvolnum>1</manvolnum>

</citerefentry>,

<citetitle>BIND 9 Administrator Reference Manual</citetitle>.

</para>

</refsect1>

<refsect1>

<title>AUTHOR</title>

<para><corpauthor>Internet Systems Consortium</corpauthor>

</para>

</refsect1>

</refentry><!--