1 .\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
2 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14 .\" PERFORMANCE OF THIS SOFTWARE.
16 .\" $Id: rndc.conf.5,v 1.21.206.5 2005/10/13 02:33:50 marka Exp $
20 .\" ** You probably do not want to edit this file directly **
21 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
22 .\" Instead of manually editing it, you probably should edit the DocBook XML
23 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
24 .TH "\\FIRNDC.CONF\\FR" "5" "June 30, 2000" "BIND9" "BIND9"
25 .\" disable hyphenation
27 .\" disable justification (adjust text to left margin only)
30 rndc.conf \- rndc configuration file
37 is the configuration file for
38 \fBrndc\fR, the BIND 9 name server control utility. This file has a similar structure and syntax to
39 \fInamed.conf\fR. Statements are enclosed in braces and terminated with a semi\-colon. Clauses in the statements are also semi\-colon terminated. The usual comment styles are supported:
43 C++ style: // to end of line
45 Unix style: # to end of line
49 \fInamed.conf\fR. The file uses three statements: an options statement, a server statement and a key statement.
53 statement contains three clauses. The
55 clause is followed by the name or address of a name server. This host will be used when no name server is given as an argument to
58 clause is followed by the name of a key which is identified by a
62 is provided on the rndc command line, and no
64 clause is found in a matching
66 statement, this default key will be used to authenticate the server's commands and responses. The
68 clause is followed by the port to connect to on the remote name server. If no
70 option is provided on the rndc command line, and no
72 clause is found in a matching
74 statement, this default port will be used to connect.
78 keyword, the server statement includes a string which is the hostname or address for a name server. The statement has two possible clauses:
81 \fBport\fR. The key name must match the name of a key statement in the file. The port number specifies the port to connect to.
85 statement begins with an identifying string, the name of the key. The statement has two clauses.
87 identifies the encryption algorithm for
89 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.
91 There are two common ways to generate the base\-64 string for the secret. The BIND 9 program
93 can be used to generate a random key, or the
95 program, also known as
96 \fBmimencode\fR, can be used to generate a base\-64 string from known input.
98 does not ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each.
103 default\-server localhost;
104 default\-key samplekey;
111 secret "c3Ryb25nIGVub3VnaCBmb3IgYSBtYW4gYnV0IG1hZGUgZm9yIGEgd29tYW4K";
115 In the above example,
117 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.
119 To generate a random secret with
126 file, including the randomly generated key, will be written to the standard output. Commented out
134 To generate a base\-64 secret with
137 \fBecho "known plaintext for a secret" | mmencode\fR
138 .SH "NAME SERVER CONFIGURATION"
140 The name server must be configured to accept rndc connections and to recognize the key specified in the
142 file, using the controls statement in
143 \fInamed.conf\fR. See the sections on the
145 statement in the BIND 9 Administrator Reference Manual for details.
149 \fBrndc\-confgen\fR(8),
151 BIND 9 Administrator Reference Manual.
154 Internet Systems Consortium