1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
<!--
- Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
- Copyright (C) 2001 Internet Software Consortium.
-
- Permission to use, copy, modify, and distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
- REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
<!-- $ISC: rndc.conf.html,v 1.5.2.1.4.3 2004/08/22 23:39:00 marka Exp $ -->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>rndc.conf</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="AEN1"
></A
><TT
CLASS="FILENAME"
>rndc.conf</TT
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN9"
></A
><H2
>Name</H2
><TT
CLASS="FILENAME"
>rndc.conf</TT
> -- rndc configuration file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN13"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>rndc.conf</B
> </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN16"
></A
><H2
>DESCRIPTION</H2
><P
> <TT
CLASS="FILENAME"
>rndc.conf</TT
> is the configuration file
for <B
CLASS="COMMAND"
>rndc</B
>, the BIND 9 name server control
utility. This file has a similar structure and syntax to
<TT
CLASS="FILENAME"
>named.conf</TT
>. 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:
</P
><P
> C style: /* */
</P
><P
> C++ style: // to end of line
</P
><P
> Unix style: # to end of line
</P
><P
> <TT
CLASS="FILENAME"
>rndc.conf</TT
> is much simpler than
<TT
CLASS="FILENAME"
>named.conf</TT
>. The file uses three
statements: an options statement, a server statement
and a key statement.
</P
><P
> The <VAR
CLASS="OPTION"
>options</VAR
> statement contains three clauses.
The <VAR
CLASS="OPTION"
>default-server</VAR
> 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
<B
CLASS="COMMAND"
>rndc</B
>. The <VAR
CLASS="OPTION"
>default-key</VAR
>
clause is followed by the name of a key which is identified by
a <VAR
CLASS="OPTION"
>key</VAR
> statement. If no
<VAR
CLASS="OPTION"
>keyid</VAR
> is provided on the rndc command line,
and no <VAR
CLASS="OPTION"
>key</VAR
> clause is found in a matching
<VAR
CLASS="OPTION"
>server</VAR
> statement, this default key will be
used to authenticate the server's commands and responses. The
<VAR
CLASS="OPTION"
>default-port</VAR
> clause is followed by the port
to connect to on the remote name server. If no
<VAR
CLASS="OPTION"
>port</VAR
> option is provided on the rndc command
line, and no <VAR
CLASS="OPTION"
>port</VAR
> clause is found in a
matching <VAR
CLASS="OPTION"
>server</VAR
> statement, this default port
will be used to connect.
</P
><P
> After the <VAR
CLASS="OPTION"
>server</VAR
> keyword, the server statement
includes a string which is the hostname or address for a name
server. The statement has two possible clauses:
<VAR
CLASS="OPTION"
>key</VAR
> and <VAR
CLASS="OPTION"
>port</VAR
>. The key name must
match the name of a key statement in the file. The port number
specifies the port to connect to.
</P
><P
> The <VAR
CLASS="OPTION"
>key</VAR
> statement begins with an identifying
string, the name of the key. The statement has two clauses.
<VAR
CLASS="OPTION"
>algorithm</VAR
> 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="AEN54"
></A
><H2
>EXAMPLE</H2
><PRE
CLASS="PROGRAMLISTING"
> options {
default-server localhost;
default-key samplekey;
};
server localhost {
key samplekey;
};
key samplekey {
algorithm hmac-md5;
secret "c3Ryb25nIGVub3VnaCBmb3IgYSBtYW4gYnV0IG1hZGUgZm9yIGEgd29tYW4K";
};
</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
> To generate a random secret with <B
CLASS="COMMAND"
>rndc-confgen</B
>:
</P
><P
> <KBD
CLASS="USERINPUT"
>rndc-confgen</KBD
>
</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 <VAR
CLASS="OPTION"
>key</VAR
> and
<VAR
CLASS="OPTION"
>controls</VAR
> 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
> <KBD
CLASS="USERINPUT"
>echo "known plaintext for a secret" | mmencode</KBD
>
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN72"
></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 <VAR
CLASS="OPTION"
>controls</VAR
> statement in the
BIND 9 Administrator Reference Manual for details.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN78"
></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="AEN91"
></A
><H2
>AUTHOR</H2
><P
> Internet Systems Consortium
</P
></DIV
></BODY
></HTML
>
|
