rndc.conf.html revision 41a789ed9abd6bd759254a125857d36cdff93042
ef6648a7917a74b386ded70f1d799becd7b74386ugaston<!--
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - Copyright (C) 2001 Internet Software Consortium.
ef6648a7917a74b386ded70f1d799becd7b74386ugaston -
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - Permission to use, copy, modify, and distribute this software for any
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - purpose with or without fee is hereby granted, provided that the above
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - copyright notice and this permission notice appear in all copies.
ef6648a7917a74b386ded70f1d799becd7b74386ugaston -
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
ef6648a7917a74b386ded70f1d799becd7b74386ugaston - PERFORMANCE OF THIS SOFTWARE.
ef6648a7917a74b386ded70f1d799becd7b74386ugaston-->
ef6648a7917a74b386ded70f1d799becd7b74386ugaston
ef6648a7917a74b386ded70f1d799becd7b74386ugaston<!-- $Id: rndc.conf.html,v 1.11 2004/07/23 06:09:33 marka Exp $ -->
ef6648a7917a74b386ded70f1d799becd7b74386ugaston
ef6648a7917a74b386ded70f1d799becd7b74386ugaston<HTML
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><HEAD
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><TITLE
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>rndc.conf</TITLE
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><META
ef6648a7917a74b386ded70f1d799becd7b74386ugastonNAME="GENERATOR"
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCONTENT="Modular DocBook HTML Stylesheet Version 1.73
ef6648a7917a74b386ded70f1d799becd7b74386ugaston"></HEAD
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><BODY
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="REFENTRY"
ef6648a7917a74b386ded70f1d799becd7b74386ugastonBGCOLOR="#FFFFFF"
ef6648a7917a74b386ded70f1d799becd7b74386ugastonTEXT="#000000"
ef6648a7917a74b386ded70f1d799becd7b74386ugastonLINK="#0000FF"
ef6648a7917a74b386ded70f1d799becd7b74386ugastonVLINK="#840084"
ef6648a7917a74b386ded70f1d799becd7b74386ugastonALINK="#0000FF"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><H1
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><A
ef6648a7917a74b386ded70f1d799becd7b74386ugastonNAME="AEN1"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="FILENAME"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>rndc.conf</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston></A
ef6648a7917a74b386ded70f1d799becd7b74386ugaston></H1
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><DIV
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="REFNAMEDIV"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><A
ef6648a7917a74b386ded70f1d799becd7b74386ugastonNAME="AEN9"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston></A
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><H2
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>Name</H2
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="FILENAME"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>rndc.conf</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>&nbsp;--&nbsp;rndc configuration file</DIV
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><DIV
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="REFSYNOPSISDIV"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><A
ef6648a7917a74b386ded70f1d799becd7b74386ugastonNAME="AEN13"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston></A
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><H2
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>Synopsis</H2
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><B
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="COMMAND"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>rndc.conf</B
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> </P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston></DIV
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><DIV
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="REFSECT1"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><A
ef6648a7917a74b386ded70f1d799becd7b74386ugastonNAME="AEN16"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston></A
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><H2
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>DESCRIPTION</H2
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="FILENAME"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>rndc.conf</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> is the configuration file
ef6648a7917a74b386ded70f1d799becd7b74386ugaston for <B
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="COMMAND"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>rndc</B
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>, the BIND 9 name server control
ef6648a7917a74b386ded70f1d799becd7b74386ugaston utility. This file has a similar structure and syntax to
ef6648a7917a74b386ded70f1d799becd7b74386ugaston <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="FILENAME"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>named.conf</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>. Statements are enclosed
ef6648a7917a74b386ded70f1d799becd7b74386ugaston in braces and terminated with a semi-colon. Clauses in
ef6648a7917a74b386ded70f1d799becd7b74386ugaston the statements are also semi-colon terminated. The usual
ef6648a7917a74b386ded70f1d799becd7b74386ugaston comment styles are supported:
ef6648a7917a74b386ded70f1d799becd7b74386ugaston </P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> C style: /* */
ef6648a7917a74b386ded70f1d799becd7b74386ugaston </P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> C++ style: // to end of line
ef6648a7917a74b386ded70f1d799becd7b74386ugaston </P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> Unix style: # to end of line
ef6648a7917a74b386ded70f1d799becd7b74386ugaston </P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="FILENAME"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>rndc.conf</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> is much simpler than
ef6648a7917a74b386ded70f1d799becd7b74386ugaston <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="FILENAME"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>named.conf</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>. The file uses three
ef6648a7917a74b386ded70f1d799becd7b74386ugaston statements: an options statement, a server statement
ef6648a7917a74b386ded70f1d799becd7b74386ugaston and a key statement.
ef6648a7917a74b386ded70f1d799becd7b74386ugaston </P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston><P
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> The <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>options</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> statement contains five clauses.
ef6648a7917a74b386ded70f1d799becd7b74386ugaston The <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>default-server</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> clause is followed by the
ef6648a7917a74b386ded70f1d799becd7b74386ugaston name or address of a name server. This host will be used when
ef6648a7917a74b386ded70f1d799becd7b74386ugaston no name server is given as an argument to
ef6648a7917a74b386ded70f1d799becd7b74386ugaston <B
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="COMMAND"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>rndc</B
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>. The <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>default-key</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>
ef6648a7917a74b386ded70f1d799becd7b74386ugaston clause is followed by the name of a key which is identified by
ef6648a7917a74b386ded70f1d799becd7b74386ugaston a <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>key</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> statement. If no
ef6648a7917a74b386ded70f1d799becd7b74386ugaston <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>keyid</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> is provided on the rndc command line,
ef6648a7917a74b386ded70f1d799becd7b74386ugaston and no <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>key</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> clause is found in a matching
ef6648a7917a74b386ded70f1d799becd7b74386ugaston <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>server</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> statement, this default key will be
ef6648a7917a74b386ded70f1d799becd7b74386ugaston used to authenticate the server's commands and responses. The
ef6648a7917a74b386ded70f1d799becd7b74386ugaston <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>default-port</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> clause is followed by the port
ef6648a7917a74b386ded70f1d799becd7b74386ugaston to connect to on the remote name server. If no
ef6648a7917a74b386ded70f1d799becd7b74386ugaston <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>port</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> option is provided on the rndc command
ef6648a7917a74b386ded70f1d799becd7b74386ugaston line, and no <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
ef6648a7917a74b386ded70f1d799becd7b74386ugaston>port</TT
ef6648a7917a74b386ded70f1d799becd7b74386ugaston> clause is found in a
ef6648a7917a74b386ded70f1d799becd7b74386ugaston matching <TT
ef6648a7917a74b386ded70f1d799becd7b74386ugastonCLASS="OPTION"
>server</TT
> statement, this default port
will be used to connect.
The <TT
CLASS="OPTION"
>default-source-address</TT
> and
<TT
CLASS="OPTION"
>default-source-address-v6</TT
> clauses which
can be used to set the IPv4 and IPv6 source addresses
respectively.
</P
><P
> After the <TT
CLASS="OPTION"
>server</TT
> keyword, the server
statement includes a string which is the hostname or address
for a name server. The statement has three possible clauses:
<TT
CLASS="OPTION"
>key</TT
>, <TT
CLASS="OPTION"
>port</TT
> and
<TT
CLASS="OPTION"
>addresses</TT
>. The key name must match the
name of a key statement in the file. The port number
specifies the port to connect to. If an <TT
CLASS="OPTION"
>addresses</TT
>
clause is supplied these addresses will be used instead of
the server name. Each address can take a optional port.
If an <TT
CLASS="OPTION"
>source-address</TT
> or <TT
CLASS="OPTION"
>source-address-v6</TT
>
of supplied then these will be used to specify the IPv4 and IPv6
source addresses respectively.
</P
><P
> The <TT
CLASS="OPTION"
>key</TT
> statement begins with an identifying
string, the name of the key. The statement has two clauses.
<TT
CLASS="OPTION"
>algorithm</TT
> identifies the encryption algorithm
for <B
CLASS="COMMAND"
>rndc</B
> 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.
</P
><P
> There are two common ways to generate the base-64 string for the
secret. The BIND 9 program <B
CLASS="COMMAND"
>rndc-confgen</B
> can
be used to generate a random key, or the
<B
CLASS="COMMAND"
>mmencode</B
> program, also known as
<B
CLASS="COMMAND"
>mimencode</B
>, can be used to generate a base-64
string from known input. <B
CLASS="COMMAND"
>mmencode</B
> does not
ship with BIND 9 but is available on many systems. See the
EXAMPLE section for sample command lines for each.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN60"
></A
><H2
>EXAMPLE</H2
><PRE
CLASS="PROGRAMLISTING"
> options {
default-server localhost;
default-key samplekey;
};
server localhost {
key samplekey;
};
server testserver {
key testkey;
addresses { localhost port 5353; };
};
key samplekey {
algorithm hmac-md5;
secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
};
key testkey {
algorithm hmac-md5;
secret "R3HI8P6BKw9ZwXwN3VZKuQ==";
}
</PRE
><P
> In the above example, <B
CLASS="COMMAND"
>rndc</B
> 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 <B
CLASS="COMMAND"
>rndc -s testserver</B
> is used then <B
CLASS="COMMAND"
>rndc</B
> will
connect to server on localhost port 5353 using the key testkey.
</P
><P
> To generate a random secret with <B
CLASS="COMMAND"
>rndc-confgen</B
>:
</P
><P
> <TT
CLASS="USERINPUT"
><B
>rndc-confgen</B
></TT
>
</P
><P
> A complete <TT
CLASS="FILENAME"
>rndc.conf</TT
> file, including the
randomly generated key, will be written to the standard
output. Commented out <TT
CLASS="OPTION"
>key</TT
> and
<TT
CLASS="OPTION"
>controls</TT
> statements for
<TT
CLASS="FILENAME"
>named.conf</TT
> are also printed.
</P
><P
> To generate a base-64 secret with <B
CLASS="COMMAND"
>mmencode</B
>:
</P
><P
> <TT
CLASS="USERINPUT"
><B
>echo "known plaintext for a secret" | mmencode</B
></TT
>
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN81"
></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 <TT
CLASS="FILENAME"
>rndc.conf</TT
>
file, using the controls statement in <TT
CLASS="FILENAME"
>named.conf</TT
>.
See the sections on the <TT
CLASS="OPTION"
>controls</TT
> statement in the
BIND 9 Administrator Reference Manual for details.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN87"
></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
>,
<I
CLASS="CITETITLE"
>BIND 9 Administrator Reference Manual</I
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN100"
></A
><H2
>AUTHOR</H2
><P
> Internet Systems Consortium
</P
></DIV
></BODY
></HTML
>