Bv9ARM.ch06.html 657 KB
Newer Older
Rob Austein's avatar
regen  
Rob Austein committed
1
<!--
Tinderbox User's avatar
Tinderbox User committed
2
 - Copyright (C) 2000-2015 Internet Systems Consortium, Inc. ("ISC")
Rob Austein's avatar
regen  
Rob Austein committed
3
 - 
Tinderbox User's avatar
Tinderbox User committed
4 5 6
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
Rob Austein's avatar
regen  
Rob Austein committed
7 8 9 10 11
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Chapter 6. BIND 9 Configuration Reference</title>
Tinderbox User's avatar
Tinderbox User committed
12
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
Evan Hunt's avatar
Evan Hunt committed
13
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
Rob Austein's avatar
regen  
Rob Austein committed
14 15 16 17 18 19 20
<link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="prev" href="Bv9ARM.ch05.html" title="Chapter 5. The BIND 9 Lightweight Resolver">
<link rel="next" href="Bv9ARM.ch07.html" title="Chapter 7. BIND 9 Security Considerations">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
Mark Andrews's avatar
regen  
Mark Andrews committed
21
<tr><th colspan="3" align="center">Chapter 6. <acronym class="acronym">BIND</acronym> 9 Configuration Reference</th></tr>
Rob Austein's avatar
regen  
Rob Austein committed
22 23 24 25 26 27 28 29 30 31
<tr>
<td width="20%" align="left">
<a accesskey="p" href="Bv9ARM.ch05.html">Prev</a> </td>
<th width="60%" align="center"> </th>
<td width="20%" align="right"> <a accesskey="n" href="Bv9ARM.ch07.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
Tinderbox User's avatar
Tinderbox User committed
32 33 34
<div class="chapter">
<div class="titlepage"><div><div><h1 class="title">
<a name="Bv9ARM.ch06"></a>Chapter 6. <acronym class="acronym">BIND</acronym> 9 Configuration Reference</h1></div></div></div>
Rob Austein's avatar
regen  
Rob Austein committed
35 36
<div class="toc">
<p><b>Table of Contents</b></p>
Tinderbox User's avatar
Tinderbox User committed
37
<dl class="toc">
Evan Hunt's avatar
Evan Hunt committed
38
<dt><span class="section"><a href="Bv9ARM.ch06.html#configuration_file_elements">Configuration File Elements</a></span></dt>
Rob Austein's avatar
regen  
Rob Austein committed
39
<dd><dl>
Evan Hunt's avatar
Evan Hunt committed
40
<dt><span class="section"><a href="Bv9ARM.ch06.html#address_match_lists">Address Match Lists</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
41
<dt><span class="section"><a href="Bv9ARM.ch06.html#comment_syntax">Comment Syntax</a></span></dt>
Rob Austein's avatar
regen  
Rob Austein committed
42
</dl></dd>
Evan Hunt's avatar
Evan Hunt committed
43
<dt><span class="section"><a href="Bv9ARM.ch06.html#Configuration_File_Grammar">Configuration File Grammar</a></span></dt>
Rob Austein's avatar
regen  
Rob Austein committed
44
<dd><dl>
Tinderbox User's avatar
Tinderbox User committed
45
<dt><span class="section"><a href="Bv9ARM.ch06.html#acl_grammar"><span class="command"><strong>acl</strong></span> Statement Grammar</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
46
<dt><span class="section"><a href="Bv9ARM.ch06.html#acl"><span class="command"><strong>acl</strong></span> Statement Definition and
Rob Austein's avatar
regen  
Rob Austein committed
47
          Usage</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
48
<dt><span class="section"><a href="Bv9ARM.ch06.html#controls_grammar"><span class="command"><strong>controls</strong></span> Statement Grammar</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
49
<dt><span class="section"><a href="Bv9ARM.ch06.html#controls_statement_definition_and_usage"><span class="command"><strong>controls</strong></span> Statement Definition and
Rob Austein's avatar
regen  
Rob Austein committed
50
          Usage</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
51 52 53 54 55 56 57 58 59 60
<dt><span class="section"><a href="Bv9ARM.ch06.html#include_grammar"><span class="command"><strong>include</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#include_statement"><span class="command"><strong>include</strong></span> Statement Definition and Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#key_grammar"><span class="command"><strong>key</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#key_statement"><span class="command"><strong>key</strong></span> Statement Definition and Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#logging_grammar"><span class="command"><strong>logging</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#logging_statement"><span class="command"><strong>logging</strong></span> Statement Definition and Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#lwres_grammar"><span class="command"><strong>lwres</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#lwres_statement"><span class="command"><strong>lwres</strong></span> Statement Definition and Usage</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#masters_grammar"><span class="command"><strong>masters</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#masters_statement"><span class="command"><strong>masters</strong></span> Statement Definition and
Rob Austein's avatar
regen  
Rob Austein committed
61
          Usage</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
62
<dt><span class="section"><a href="Bv9ARM.ch06.html#options_grammar"><span class="command"><strong>options</strong></span> Statement Grammar</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
63
<dt><span class="section"><a href="Bv9ARM.ch06.html#options"><span class="command"><strong>options</strong></span> Statement Definition and
Rob Austein's avatar
regen  
Rob Austein committed
64
          Usage</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
65 66
<dt><span class="section"><a href="Bv9ARM.ch06.html#server_statement_grammar"><span class="command"><strong>server</strong></span> Statement Grammar</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#server_statement_definition_and_usage"><span class="command"><strong>server</strong></span> Statement Definition and
Rob Austein's avatar
regen  
Rob Austein committed
67
            Usage</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
68
<dt><span class="section"><a href="Bv9ARM.ch06.html#statschannels"><span class="command"><strong>statistics-channels</strong></span> Statement Grammar</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
69
<dt><span class="section"><a href="Bv9ARM.ch06.html#statistics_channels"><span class="command"><strong>statistics-channels</strong></span> Statement Definition and
Automatic Updater's avatar
regen  
Automatic Updater committed
70
            Usage</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
71
<dt><span class="section"><a href="Bv9ARM.ch06.html#trusted-keys"><span class="command"><strong>trusted-keys</strong></span> Statement Grammar</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
72
<dt><span class="section"><a href="Bv9ARM.ch06.html#trusted_keys"><span class="command"><strong>trusted-keys</strong></span> Statement Definition
Automatic Updater's avatar
regen  
Automatic Updater committed
73
            and Usage</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
74
<dt><span class="section"><a href="Bv9ARM.ch06.html#managed_keys"><span class="command"><strong>managed-keys</strong></span> Statement Grammar</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
75
<dt><span class="section"><a href="Bv9ARM.ch06.html#managed-keys"><span class="command"><strong>managed-keys</strong></span> Statement Definition
Rob Austein's avatar
regen  
Rob Austein committed
76
            and Usage</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
77
<dt><span class="section"><a href="Bv9ARM.ch06.html#view_statement_grammar"><span class="command"><strong>view</strong></span> Statement Grammar</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
78
<dt><span class="section"><a href="Bv9ARM.ch06.html#view_statement"><span class="command"><strong>view</strong></span> Statement Definition and Usage</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
79
<dt><span class="section"><a href="Bv9ARM.ch06.html#zone_statement_grammar"><span class="command"><strong>zone</strong></span>
Rob Austein's avatar
regen  
Rob Austein committed
80
            Statement Grammar</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
81
<dt><span class="section"><a href="Bv9ARM.ch06.html#zone_statement"><span class="command"><strong>zone</strong></span> Statement Definition and Usage</a></span></dt>
Rob Austein's avatar
regen  
Rob Austein committed
82
</dl></dd>
Tinderbox User's avatar
Tinderbox User committed
83
<dt><span class="section"><a href="Bv9ARM.ch06.html#zone_file">Zone File</a></span></dt>
Rob Austein's avatar
regen  
Rob Austein committed
84
<dd><dl>
Evan Hunt's avatar
Evan Hunt committed
85
<dt><span class="section"><a href="Bv9ARM.ch06.html#types_of_resource_records_and_when_to_use_them">Types of Resource Records and When to Use Them</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
86
<dt><span class="section"><a href="Bv9ARM.ch06.html#mx_records">Discussion of MX Records</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
87
<dt><span class="section"><a href="Bv9ARM.ch06.html#Setting_TTLs">Setting TTLs</a></span></dt>
Tinderbox User's avatar
Tinderbox User committed
88 89 90
<dt><span class="section"><a href="Bv9ARM.ch06.html#ipv4_reverse">Inverse Mapping in IPv4</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#zone_directives">Other Zone File Directives</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#generate_directive"><acronym class="acronym">BIND</acronym> Master File Extension: the  <span class="command"><strong>$GENERATE</strong></span> Directive</a></span></dt>
Evan Hunt's avatar
Evan Hunt committed
91 92 93 94 95 96
<dt><span class="section"><a href="Bv9ARM.ch06.html#zonefile_format">Additional File Formats</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="Bv9ARM.ch06.html#statistics">BIND9 Statistics</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="Bv9ARM.ch06.html#statsfile">The Statistics File</a></span></dt>
<dt><span class="section"><a href="Bv9ARM.ch06.html#statistics_counters">Statistics Counters</a></span></dt>
Rob Austein's avatar
regen  
Rob Austein committed
97 98 99
</dl></dd>
</dl>
</div>
Tinderbox User's avatar
Tinderbox User committed
100
<p>
Mark Andrews's avatar
regen  
Mark Andrews committed
101 102
      <acronym class="acronym">BIND</acronym> 9 configuration is broadly similar
      to <acronym class="acronym">BIND</acronym> 8; however, there are a few new
Rob Austein's avatar
regen  
Rob Austein committed
103
      areas
Mark Andrews's avatar
regen  
Mark Andrews committed
104 105
      of configuration, such as views. <acronym class="acronym">BIND</acronym>
      8 configuration files should work with few alterations in <acronym class="acronym">BIND</acronym>
Rob Austein's avatar
regen  
Rob Austein committed
106 107
      9, although more complex configurations should be reviewed to check
      if they can be more efficiently implemented using the new features
Mark Andrews's avatar
regen  
Mark Andrews committed
108
      found in <acronym class="acronym">BIND</acronym> 9.
Rob Austein's avatar
regen  
Rob Austein committed
109
    </p>
Tinderbox User's avatar
Tinderbox User committed
110
<p>
Mark Andrews's avatar
regen  
Mark Andrews committed
111
      <acronym class="acronym">BIND</acronym> 4 configuration files can be
Rob Austein's avatar
regen  
Rob Austein committed
112 113 114 115
      converted to the new format
      using the shell script
      <code class="filename">contrib/named-bootconf/named-bootconf.sh</code>.
    </p>
Tinderbox User's avatar
Tinderbox User committed
116
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
117 118
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="configuration_file_elements"></a>Configuration File Elements</h2></div></div></div>
Tinderbox User's avatar
Tinderbox User committed
119
<p>
Mark Andrews's avatar
regen  
Mark Andrews committed
120
        Following is a list of elements used throughout the <acronym class="acronym">BIND</acronym> configuration
Rob Austein's avatar
regen  
Rob Austein committed
121 122
        file documentation:
      </p>
Tinderbox User's avatar
Tinderbox User committed
123
<div class="informaltable"><table border="1">
Rob Austein's avatar
regen  
Rob Austein committed
124
<colgroup>
Evan Hunt's avatar
Evan Hunt committed
125 126
<col width="1.855in" class="1">
<col width="3.770in" class="2">
Rob Austein's avatar
regen  
Rob Austein committed
127 128 129 130 131 132 133 134 135 136 137
</colgroup>
<tbody>
<tr>
<td>
                <p>
                  <code class="varname">acl_name</code>
                </p>
              </td>
<td>
                <p>
                  The name of an <code class="varname">address_match_list</code> as
Evan Hunt's avatar
Evan Hunt committed
138
                  defined by the <span class="command"><strong>acl</strong></span> statement.
Rob Austein's avatar
regen  
Rob Austein committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="varname">address_match_list</code>
                </p>
              </td>
<td>
                <p>
                  A list of one or more
                  <code class="varname">ip_addr</code>,
                  <code class="varname">ip_prefix</code>, <code class="varname">key_id</code>,
                  or <code class="varname">acl_name</code> elements, see
Evan Hunt's avatar
Evan Hunt committed
154
                  <a class="xref" href="Bv9ARM.ch06.html#address_match_lists" title="Address Match Lists">the section called &#8220;Address Match Lists&#8221;</a>.
Rob Austein's avatar
regen  
Rob Austein committed
155 156 157 158
                </p>
              </td>
</tr>
<tr>
Mark Andrews's avatar
gregen  
Mark Andrews committed
159 160 161 162 163 164 165 166
<td>
                <p>
                  <code class="varname">masters_list</code>
                </p>
              </td>
<td>
                <p>
                  A named list of one or more <code class="varname">ip_addr</code>
Mark Andrews's avatar
regen  
Mark Andrews committed
167
                  with optional <code class="varname">key_id</code> and/or
Mark Andrews's avatar
gregen  
Mark Andrews committed
168 169 170 171 172 173 174
                  <code class="varname">ip_port</code>.
                  A <code class="varname">masters_list</code> may include other
                  <code class="varname">masters_lists</code>.
                </p>
              </td>
</tr>
<tr>
Rob Austein's avatar
regen  
Rob Austein committed
175 176 177 178 179 180 181 182 183 184 185 186 187
<td>
                <p>
                  <code class="varname">domain_name</code>
                </p>
              </td>
<td>
                <p>
                  A quoted string which will be used as
                  a DNS name, for example "<code class="literal">my.test.domain</code>".
                </p>
              </td>
</tr>
<tr>
Automatic Updater's avatar
regen  
Automatic Updater committed
188 189 190 191 192 193 194 195 196 197 198 199 200
<td>
                <p>
                  <code class="varname">namelist</code>
                </p>
              </td>
<td>
                <p>
                  A list of one or more <code class="varname">domain_name</code>
                  elements.
                </p>
              </td>
</tr>
<tr>
Rob Austein's avatar
regen  
Rob Austein committed
201 202 203 204 205 206 207 208
<td>
                <p>
                  <code class="varname">dotted_decimal</code>
                </p>
              </td>
<td>
                <p>
                  One to four integers valued 0 through
Evan Hunt's avatar
Evan Hunt committed
209 210
                  255 separated by dots (`.'), such as <span class="command"><strong>123</strong></span>,
                  <span class="command"><strong>45.67</strong></span> or <span class="command"><strong>89.123.45.67</strong></span>.
Rob Austein's avatar
regen  
Rob Austein committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="varname">ip4_addr</code>
                </p>
              </td>
<td>
                <p>
                  An IPv4 address with exactly four elements
                  in <code class="varname">dotted_decimal</code> notation.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="varname">ip6_addr</code>
                </p>
              </td>
<td>
                <p>
Evan Hunt's avatar
Evan Hunt committed
235
                  An IPv6 address, such as <span class="command"><strong>2001:db8::1234</strong></span>.
Mark Andrews's avatar
regen  
Mark Andrews committed
236 237 238 239 240 241 242 243 244
                  IPv6 scoped addresses that have ambiguity on their
                  scope zones must be disambiguated by an appropriate
                  zone ID with the percent character (`%') as
                  delimiter.  It is strongly recommended to use
                  string zone names rather than numeric identifiers,
                  in order to be robust against system configuration
                  changes.  However, since there is no standard
                  mapping for such names and identifier values,
                  currently only interface names as link identifiers
Rob Austein's avatar
regen  
Rob Austein committed
245
                  are supported, assuming one-to-one mapping between
Mark Andrews's avatar
regen  
Mark Andrews committed
246
                  interfaces and links.  For example, a link-local
Evan Hunt's avatar
Evan Hunt committed
247 248 249
                  address <span class="command"><strong>fe80::1</strong></span> on the link
                  attached to the interface <span class="command"><strong>ne0</strong></span>
                  can be specified as <span class="command"><strong>fe80::1%ne0</strong></span>.
Mark Andrews's avatar
regen  
Mark Andrews committed
250 251 252
                  Note that on most systems link-local addresses
                  always have the ambiguity, and need to be
                  disambiguated.
Rob Austein's avatar
regen  
Rob Austein committed
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="varname">ip_addr</code>
                </p>
              </td>
<td>
                <p>
                  An <code class="varname">ip4_addr</code> or <code class="varname">ip6_addr</code>.
                </p>
              </td>
</tr>
<tr>
Tinderbox User's avatar
Tinderbox User committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
<td>
                <p>
                  <code class="varname">ip_dscp</code>
                </p>
              </td>
<td>
                <p>
                  A <code class="varname">number</code> between 0 and 63, used
                  to select a differentiated services code point (DSCP)
                  value for use with outgoing traffic on operating systems
                  that support DSCP.
                </p>
              </td>
</tr>
<tr>
Rob Austein's avatar
regen  
Rob Austein committed
284 285 286 287 288 289 290 291
<td>
                <p>
                  <code class="varname">ip_port</code>
                </p>
              </td>
<td>
                <p>
                  An IP port <code class="varname">number</code>.
Mark Andrews's avatar
regen  
Mark Andrews committed
292
                  The <code class="varname">number</code> is limited to 0
Rob Austein's avatar
regen  
Rob Austein committed
293 294 295
                  through 65535, with values
                  below 1024 typically restricted to use by processes running
                  as root.
Mark Andrews's avatar
regen  
Mark Andrews committed
296
                  In some cases, an asterisk (`*') character can be used as a
Rob Austein's avatar
regen  
Rob Austein committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
                  placeholder to
                  select a random high-numbered port.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="varname">ip_prefix</code>
                </p>
              </td>
<td>
                <p>
                  An IP network specified as an <code class="varname">ip_addr</code>,
                  followed by a slash (`/') and then the number of bits in the
                  netmask.
                  Trailing zeros in a <code class="varname">ip_addr</code>
                  may omitted.
Evan Hunt's avatar
Evan Hunt committed
315 316 317 318
                  For example, <span class="command"><strong>127/8</strong></span> is the
                  network <span class="command"><strong>127.0.0.0</strong></span> with
                  netmask <span class="command"><strong>255.0.0.0</strong></span> and <span class="command"><strong>1.2.3.0/28</strong></span> is
                  network <span class="command"><strong>1.2.3.0</strong></span> with netmask <span class="command"><strong>255.255.255.240</strong></span>.
Rob Austein's avatar
regen  
Rob Austein committed
319
                </p>
Mark Andrews's avatar
regen  
Mark Andrews committed
320 321 322 323 324
                <p>
                  When specifying a prefix involving a IPv6 scoped address
                  the scope may be omitted.  In that case the prefix will
                  match packets from any scope.
                </p>
Rob Austein's avatar
regen  
Rob Austein committed
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
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="varname">key_id</code>
                </p>
              </td>
<td>
                <p>
                  A <code class="varname">domain_name</code> representing
                  the name of a shared key, to be used for transaction
                  security.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="varname">key_list</code>
                </p>
              </td>
<td>
                <p>
                  A list of one or more
                  <code class="varname">key_id</code>s,
                  separated by semicolons and ending with a semicolon.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="varname">number</code>
                </p>
              </td>
<td>
                <p>
Mark Andrews's avatar
regen  
Mark Andrews committed
363
                  A non-negative 32-bit integer
Rob Austein's avatar
regen  
Rob Austein committed
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
                  (i.e., a number between 0 and 4294967295, inclusive).
                  Its acceptable value might further
                  be limited by the context in which it is used.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="varname">path_name</code>
                </p>
              </td>
<td>
                <p>
                  A quoted string which will be used as
                  a pathname, such as <code class="filename">zones/master/my.test.domain</code>.
                </p>
              </td>
</tr>
<tr>
Automatic Updater's avatar
regen  
Automatic Updater committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
<td>
                <p>
                  <code class="varname">port_list</code>
                </p>
              </td>
<td>
                <p>
                  A list of an <code class="varname">ip_port</code> or a port
                  range.
                  A port range is specified in the form of
                  <strong class="userinput"><code>range</code></strong> followed by
                  two <code class="varname">ip_port</code>s,
                  <code class="varname">port_low</code> and
                  <code class="varname">port_high</code>, which represents
                  port numbers from <code class="varname">port_low</code> through
                  <code class="varname">port_high</code>, inclusive.
                  <code class="varname">port_low</code> must not be larger than
                  <code class="varname">port_high</code>.
                  For example,
                  <strong class="userinput"><code>range 1024 65535</code></strong> represents
                  ports from 1024 through 65535.
                  In either case an asterisk (`*') character is not
                  allowed as a valid <code class="varname">ip_port</code>.
                </p>
              </td>
</tr>
<tr>
Rob Austein's avatar
regen  
Rob Austein committed
411 412 413 414 415 416 417
<td>
                <p>
                  <code class="varname">size_spec</code>
                </p>
              </td>
<td>
                <p>
Tinderbox User's avatar
Tinderbox User committed
418 419 420
                  A 64-bit unsigned integer, or the keywords
                  <strong class="userinput"><code>unlimited</code></strong> or
                  <strong class="userinput"><code>default</code></strong>.
Rob Austein's avatar
regen  
Rob Austein committed
421
                </p>
Mark Andrews's avatar
gregen  
Mark Andrews committed
422
                <p>
Tinderbox User's avatar
Tinderbox User committed
423 424
                  Integers may take values
                  0 &lt;= value &lt;= 18446744073709551615, though
Tinderbox User's avatar
Tinderbox User committed
425
                  certain parameters
Evan Hunt's avatar
Evan Hunt committed
426
                  (such as <span class="command"><strong>max-journal-size</strong></span>) may
Tinderbox User's avatar
Tinderbox User committed
427 428 429 430
                  use a more limited range within these extremes.
                  In most cases, setting a value to 0 does not
                  literally mean zero; it means "undefined" or
                  "as big as possible", depending on the context.
Tinderbox User's avatar
Tinderbox User committed
431
                  See the explanations of particular parameters
Tinderbox User's avatar
Tinderbox User committed
432
                  that use <code class="varname">size_spec</code>
Tinderbox User's avatar
Tinderbox User committed
433
                  for details on how they interpret its use.
Rob Austein's avatar
regen  
Rob Austein committed
434 435
                </p>
                <p>
Tinderbox User's avatar
Tinderbox User committed
436 437
                  Numeric values can optionally be followed by a
                  scaling factor:
Mark Andrews's avatar
gregen  
Mark Andrews committed
438 439 440 441
                  <strong class="userinput"><code>K</code></strong> or <strong class="userinput"><code>k</code></strong>
                  for kilobytes,
                  <strong class="userinput"><code>M</code></strong> or <strong class="userinput"><code>m</code></strong>
                  for megabytes, and
Tinderbox User's avatar
Tinderbox User committed
442 443 444
                  <strong class="userinput"><code>G</code></strong> or <strong class="userinput"><code>g</code></strong>
                  for gigabytes, which scale by 1024, 1024*1024, and
                  1024*1024*1024 respectively.
Rob Austein's avatar
regen  
Rob Austein committed
445 446
                </p>
                <p>
Tinderbox User's avatar
Tinderbox User committed
447
                  <code class="varname">unlimited</code> generally means
Tinderbox User's avatar
Tinderbox User committed
448 449
                  "as big as possible", and is usually the best
                  way to safely set a very large number.
Tinderbox User's avatar
Tinderbox User committed
450 451
                </p>
                <p>
Tinderbox User's avatar
Tinderbox User committed
452
                  <code class="varname">default</code>
Tinderbox User's avatar
Tinderbox User committed
453
                  uses the limit that was in force when the server was started.
Rob Austein's avatar
regen  
Rob Austein committed
454 455 456 457
                </p>
              </td>
</tr>
<tr>
Tinderbox User's avatar
Tinderbox User committed
458 459 460 461 462 463 464 465 466 467 468
<td>
                <p>
                  <code class="varname">size_or_percent</code>
                </p>
              </td>
<td>
                <p>
                  <code class="varname">size_spec</code> or integer value
                  followed by '%' to represent percents.
                </p>
                <p>
Tinderbox User's avatar
Tinderbox User committed
469
                  The behavior is exactly the same as
Tinderbox User's avatar
Tinderbox User committed
470 471 472 473 474 475 476 477
                  <code class="varname">size_spec</code>, but
                  <code class="varname">size_or_percent</code> allows also
                  to specify a positive integer value followed by
                  '%' sign to represent percents.
                </p>
              </td>
</tr>
<tr>
Rob Austein's avatar
regen  
Rob Austein committed
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
<td>
                <p>
                  <code class="varname">yes_or_no</code>
                </p>
              </td>
<td>
                <p>
                  Either <strong class="userinput"><code>yes</code></strong> or <strong class="userinput"><code>no</code></strong>.
                  The words <strong class="userinput"><code>true</code></strong> and <strong class="userinput"><code>false</code></strong> are
                  also accepted, as are the numbers <strong class="userinput"><code>1</code></strong>
                  and <strong class="userinput"><code>0</code></strong>.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="varname">dialup_option</code>
                </p>
              </td>
<td>
                <p>
                  One of <strong class="userinput"><code>yes</code></strong>,
                  <strong class="userinput"><code>no</code></strong>, <strong class="userinput"><code>notify</code></strong>,
                  <strong class="userinput"><code>notify-passive</code></strong>, <strong class="userinput"><code>refresh</code></strong> or
                  <strong class="userinput"><code>passive</code></strong>.
                  When used in a zone, <strong class="userinput"><code>notify-passive</code></strong>,
                  <strong class="userinput"><code>refresh</code></strong>, and <strong class="userinput"><code>passive</code></strong>
                  are restricted to slave and stub zones.
                </p>
              </td>
</tr>
</tbody>
Tinderbox User's avatar
Tinderbox User committed
511 512
</table></div>
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
513 514
<div class="titlepage"><div><div><h3 class="title">
<a name="address_match_lists"></a>Address Match Lists</h3></div></div></div>
Tinderbox User's avatar
Tinderbox User committed
515
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
516
<div class="titlepage"><div><div><h4 class="title">
Tinderbox User's avatar
Tinderbox User committed
517
<a name="id-1.7.4.4.2"></a>Syntax</h4></div></div></div>
Rob Austein's avatar
regen  
Rob Austein committed
518 519 520
<pre class="programlisting"><code class="varname">address_match_list</code> = address_match_list_element ;
  [<span class="optional"> address_match_list_element; ... </span>]
<code class="varname">address_match_list_element</code> = [<span class="optional"> ! </span>] (ip_address [<span class="optional">/length</span>] |
521
   key key_id | acl_name | { address_match_list } )
Rob Austein's avatar
regen  
Rob Austein committed
522
</pre>
Tinderbox User's avatar
Tinderbox User committed
523 524
</div>
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
525
<div class="titlepage"><div><div><h4 class="title">
Tinderbox User's avatar
Tinderbox User committed
526 527
<a name="id-1.7.4.4.3"></a>Definition and Usage</h4></div></div></div>
<p>
Rob Austein's avatar
regen  
Rob Austein committed
528 529
            Address match lists are primarily used to determine access
            control for various server operations. They are also used in
Evan Hunt's avatar
Evan Hunt committed
530
            the <span class="command"><strong>listen-on</strong></span> and <span class="command"><strong>sortlist</strong></span>
Mark Andrews's avatar
regen  
Mark Andrews committed
531 532
            statements. The elements which constitute an address match
            list can be any of the following:
Rob Austein's avatar
regen  
Rob Austein committed
533
          </p>
Tinderbox User's avatar
Tinderbox User committed
534 535 536
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">an IP address (IPv4 or IPv6)</li>
<li class="listitem">an IP prefix (in `/' notation)</li>
Evan Hunt's avatar
Evan Hunt committed
537 538
<li class="listitem">
                a key ID, as defined by the <span class="command"><strong>key</strong></span>
Rob Austein's avatar
regen  
Rob Austein committed
539
                statement
Tinderbox User's avatar
Tinderbox User committed
540 541
              </li>
<li class="listitem">the name of an address match list defined with
Evan Hunt's avatar
Evan Hunt committed
542
                the <span class="command"><strong>acl</strong></span> statement
Tinderbox User's avatar
Tinderbox User committed
543 544
              </li>
<li class="listitem">a nested address match list enclosed in braces</li>
Rob Austein's avatar
regen  
Rob Austein committed
545
</ul></div>
Tinderbox User's avatar
Tinderbox User committed
546
<p>
Rob Austein's avatar
regen  
Rob Austein committed
547 548
            Elements can be negated with a leading exclamation mark (`!'),
            and the match list names "any", "none", "localhost", and
Mark Andrews's avatar
regen  
Mark Andrews committed
549 550
            "localnets" are predefined. More information on those names
            can be found in the description of the acl statement.
Rob Austein's avatar
regen  
Rob Austein committed
551
          </p>
Tinderbox User's avatar
Tinderbox User committed
552
<p>
Rob Austein's avatar
regen  
Rob Austein committed
553 554 555
            The addition of the key clause made the name of this syntactic
            element something of a misnomer, since security keys can be used
            to validate access without regard to a host or network address.
Mark Andrews's avatar
regen  
Mark Andrews committed
556 557
            Nonetheless, the term "address match list" is still used
            throughout the documentation.
Rob Austein's avatar
regen  
Rob Austein committed
558
          </p>
Tinderbox User's avatar
Tinderbox User committed
559
<p>
Rob Austein's avatar
regen  
Rob Austein committed
560
            When a given IP address or prefix is compared to an address
Mark Andrews's avatar
regen  
Mark Andrews committed
561 562 563 564 565
            match list, the comparison takes place in approximately O(1)
            time.  However, key comparisons require that the list of keys
            be traversed until a matching key is found, and therefore may
            be somewhat slower.
          </p>
Tinderbox User's avatar
Tinderbox User committed
566
<p>
Rob Austein's avatar
regen  
Rob Austein committed
567
            The interpretation of a match depends on whether the list is being
Evan Hunt's avatar
Evan Hunt committed
568 569
            used for access control, defining <span class="command"><strong>listen-on</strong></span> ports, or in a
            <span class="command"><strong>sortlist</strong></span>, and whether the element was negated.
Rob Austein's avatar
regen  
Rob Austein committed
570
          </p>
Tinderbox User's avatar
Tinderbox User committed
571
<p>
Mark Andrews's avatar
regen  
Mark Andrews committed
572 573 574
            When used as an access control list, a non-negated match
            allows access and a negated match denies access. If
            there is no match, access is denied. The clauses
Evan Hunt's avatar
Evan Hunt committed
575 576 577 578 579 580 581 582 583 584 585 586 587
            <span class="command"><strong>allow-notify</strong></span>,
            <span class="command"><strong>allow-recursion</strong></span>,
            <span class="command"><strong>allow-recursion-on</strong></span>,
            <span class="command"><strong>allow-query</strong></span>,
            <span class="command"><strong>allow-query-on</strong></span>,
            <span class="command"><strong>allow-query-cache</strong></span>,
            <span class="command"><strong>allow-query-cache-on</strong></span>,
            <span class="command"><strong>allow-transfer</strong></span>,
            <span class="command"><strong>allow-update</strong></span>,
            <span class="command"><strong>allow-update-forwarding</strong></span>,
            <span class="command"><strong>blackhole</strong></span>, and
            <span class="command"><strong>keep-response-order</strong></span> all use address match
            lists.  Similarly, the <span class="command"><strong>listen-on</strong></span> option will cause the
Mark Andrews's avatar
regen  
Mark Andrews committed
588
            server to refuse queries on any of the machine's
Mark Andrews's avatar
regen  
Mark Andrews committed
589
            addresses which do not match the list.
Rob Austein's avatar
regen  
Rob Austein committed
590
          </p>
Tinderbox User's avatar
Tinderbox User committed
591
<p>
Automatic Updater's avatar
regen  
Automatic Updater committed
592
            Order of insertion is significant.  If more than one element
Mark Andrews's avatar
regen  
Mark Andrews committed
593 594 595 596 597 598 599
            in an ACL is found to match a given IP address or prefix,
            preference will be given to the one that came
            <span class="emphasis"><em>first</em></span> in the ACL definition.
            Because of this first-match behavior, an element that
            defines a subset of another element in the list should
            come before the broader element, regardless of whether
            either is negated. For example, in
Evan Hunt's avatar
Evan Hunt committed
600
            <span class="command"><strong>1.2.3/24; ! 1.2.3.13;</strong></span>
Mark Andrews's avatar
regen  
Mark Andrews committed
601 602
            the 1.2.3.13 element is completely useless because the
            algorithm will match any lookup for 1.2.3.13 to the 1.2.3/24
Evan Hunt's avatar
Evan Hunt committed
603
            element.  Using <span class="command"><strong>! 1.2.3.13; 1.2.3/24</strong></span> fixes
Mark Andrews's avatar
regen  
Mark Andrews committed
604 605
            that problem by having 1.2.3.13 blocked by the negation, but
            all other 1.2.3.* hosts fall through.
Rob Austein's avatar
regen  
Rob Austein committed
606
          </p>
Tinderbox User's avatar
Tinderbox User committed
607 608 609
</div>
</div>
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
610
<div class="titlepage"><div><div><h3 class="title">
Tinderbox User's avatar
Tinderbox User committed
611
<a name="comment_syntax"></a>Comment Syntax</h3></div></div></div>
Tinderbox User's avatar
Tinderbox User committed
612
<p>
Mark Andrews's avatar
regen  
Mark Andrews committed
613
          The <acronym class="acronym">BIND</acronym> 9 comment syntax allows for
Rob Austein's avatar
regen  
Rob Austein committed
614
          comments to appear
Mark Andrews's avatar
regen  
Mark Andrews committed
615
          anywhere that whitespace may appear in a <acronym class="acronym">BIND</acronym> configuration
Rob Austein's avatar
regen  
Rob Austein committed
616 617 618
          file. To appeal to programmers of all kinds, they can be written
          in the C, C++, or shell/perl style.
        </p>
Tinderbox User's avatar
Tinderbox User committed
619
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
620
<div class="titlepage"><div><div><h4 class="title">
Tinderbox User's avatar
Tinderbox User committed
621 622
<a name="id-1.7.4.5.3"></a>Syntax</h4></div></div></div>
<p>
Rob Austein's avatar
regen  
Rob Austein committed
623
            </p>
Mark Andrews's avatar
regen  
Mark Andrews committed
624
<pre class="programlisting">/* This is a <acronym class="acronym">BIND</acronym> comment as in C */</pre>
Rob Austein's avatar
regen  
Rob Austein committed
625 626
<p>
            </p>
Mark Andrews's avatar
regen  
Mark Andrews committed
627
<pre class="programlisting">// This is a <acronym class="acronym">BIND</acronym> comment as in C++</pre>
Rob Austein's avatar
regen  
Rob Austein committed
628 629
<p>
            </p>
Automatic Updater's avatar
regen  
Automatic Updater committed
630 631
<pre class="programlisting"># This is a <acronym class="acronym">BIND</acronym> comment as in common UNIX shells
# and perl</pre>
Rob Austein's avatar
regen  
Rob Austein committed
632 633
<p>
          </p>
Tinderbox User's avatar
Tinderbox User committed
634 635
</div>
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
636
<div class="titlepage"><div><div><h4 class="title">
Tinderbox User's avatar
Tinderbox User committed
637 638
<a name="id-1.7.4.5.4"></a>Definition and Usage</h4></div></div></div>
<p>
Mark Andrews's avatar
regen  
Mark Andrews committed
639
            Comments may appear anywhere that whitespace may appear in
Mark Andrews's avatar
regen  
Mark Andrews committed
640
            a <acronym class="acronym">BIND</acronym> configuration file.
Rob Austein's avatar
regen  
Rob Austein committed
641
          </p>
Tinderbox User's avatar
Tinderbox User committed
642
<p>
Rob Austein's avatar
regen  
Rob Austein committed
643 644 645 646 647
            C-style comments start with the two characters /* (slash,
            star) and end with */ (star, slash). Because they are completely
            delimited with these characters, they can be used to comment only
            a portion of a line or to span multiple lines.
          </p>
Tinderbox User's avatar
Tinderbox User committed
648
<p>
Rob Austein's avatar
regen  
Rob Austein committed
649 650 651
            C-style comments cannot be nested. For example, the following
            is not valid because the entire comment ends with the first */:
          </p>
Tinderbox User's avatar
Tinderbox User committed
652
<p>
Rob Austein's avatar
regen  
Rob Austein committed
653 654 655

</p>
<pre class="programlisting">/* This is the start of a comment.
656 657 658
   This is still part of the comment.
/* This is an incorrect attempt at nesting a comment. */
   This is no longer in any comment. */
Rob Austein's avatar
regen  
Rob Austein committed
659 660 661 662
</pre>
<p>

          </p>
Tinderbox User's avatar
Tinderbox User committed
663
<p>
Rob Austein's avatar
regen  
Rob Austein committed
664 665 666 667 668 669
            C++-style comments start with the two characters // (slash,
            slash) and continue to the end of the physical line. They cannot
            be continued across multiple physical lines; to have one logical
            comment span multiple lines, each line must use the // pair.
            For example:
          </p>
Tinderbox User's avatar
Tinderbox User committed
670
<p>
Rob Austein's avatar
regen  
Rob Austein committed
671 672 673

</p>
<pre class="programlisting">// This is the start of a comment.  The next line
674 675
// is a new comment, even though it is logically
// part of the previous comment.
Rob Austein's avatar
regen  
Rob Austein committed
676 677 678 679
</pre>
<p>

          </p>
Tinderbox User's avatar
Tinderbox User committed
680
<p>
Rob Austein's avatar
regen  
Rob Austein committed
681 682 683 684 685 686
            Shell-style (or perl-style, if you prefer) comments start
            with the character <code class="literal">#</code> (number sign)
            and continue to the end of the
            physical line, as in C++ comments.
            For example:
          </p>
Tinderbox User's avatar
Tinderbox User committed
687
<p>
Rob Austein's avatar
regen  
Rob Austein committed
688 689 690

</p>
<pre class="programlisting"># This is the start of a comment.  The next line
691 692
# is a new comment, even though it is logically
# part of the previous comment.
Rob Austein's avatar
regen  
Rob Austein committed
693 694 695 696
</pre>
<p>

          </p>
Tinderbox User's avatar
Tinderbox User committed
697
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
Rob Austein's avatar
regen  
Rob Austein committed
698
<h3 class="title">Warning</h3>
Tinderbox User's avatar
Tinderbox User committed
699
<p>
Rob Austein's avatar
regen  
Rob Austein committed
700 701 702 703 704
              You cannot use the semicolon (`;') character
              to start a comment such as you would in a zone file. The
              semicolon indicates the end of a configuration
              statement.
            </p>
Tinderbox User's avatar
Tinderbox User committed
705 706 707 708 709
</div>
</div>
</div>
</div>
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
710 711
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="Configuration_File_Grammar"></a>Configuration File Grammar</h2></div></div></div>
Tinderbox User's avatar
Tinderbox User committed
712
<p>
Mark Andrews's avatar
regen  
Mark Andrews committed
713
        A <acronym class="acronym">BIND</acronym> 9 configuration consists of
Rob Austein's avatar
regen  
Rob Austein committed
714 715 716 717 718 719
        statements and comments.
        Statements end with a semicolon. Statements and comments are the
        only elements that can appear without enclosing braces. Many
        statements contain a block of sub-statements, which are also
        terminated with a semicolon.
      </p>
Tinderbox User's avatar
Tinderbox User committed
720
<p>
Rob Austein's avatar
regen  
Rob Austein committed
721 722
        The following statements are supported:
      </p>
Tinderbox User's avatar
Tinderbox User committed
723
<div class="informaltable"><table border="1">
Rob Austein's avatar
regen  
Rob Austein committed
724
<colgroup>
Evan Hunt's avatar
Evan Hunt committed
725 726
<col width="1.336in" class="1">
<col width="3.778in" class="2">
Rob Austein's avatar
regen  
Rob Austein committed
727 728 729 730
</colgroup>
<tbody>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
731
                <p><span class="command"><strong>acl</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
732 733 734 735 736 737 738 739 740 741
              </td>
<td>
                <p>
                  defines a named IP address
                  matching list, for access control and other uses.
                </p>
              </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
742
                <p><span class="command"><strong>controls</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
743 744 745 746
              </td>
<td>
                <p>
                  declares control channels to be used
Evan Hunt's avatar
Evan Hunt committed
747
                  by the <span class="command"><strong>rndc</strong></span> utility.
Rob Austein's avatar
regen  
Rob Austein committed
748 749 750 751 752
                </p>
              </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
753
                <p><span class="command"><strong>include</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
754 755 756 757 758 759 760 761 762
              </td>
<td>
                <p>
                  includes a file.
                </p>
              </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
763
                <p><span class="command"><strong>key</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
764 765 766 767 768 769 770 771 772 773
              </td>
<td>
                <p>
                  specifies key information for use in
                  authentication and authorization using TSIG.
                </p>
              </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
774
                <p><span class="command"><strong>logging</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
775 776 777 778 779 780 781 782 783 784
              </td>
<td>
                <p>
                  specifies what the server logs, and where
                  the log messages are sent.
                </p>
              </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
785
                <p><span class="command"><strong>lwres</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
786 787 788
              </td>
<td>
                <p>
Evan Hunt's avatar
Evan Hunt committed
789 790
                  configures <span class="command"><strong>named</strong></span> to
                  also act as a light-weight resolver daemon (<span class="command"><strong>lwresd</strong></span>).
Rob Austein's avatar
regen  
Rob Austein committed
791 792 793 794 795
                </p>
              </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
796
                <p><span class="command"><strong>masters</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
797 798 799 800
              </td>
<td>
                <p>
                  defines a named masters list for
Automatic Updater's avatar
Automatic Updater committed
801
                  inclusion in stub and slave zones'
Evan Hunt's avatar
Evan Hunt committed
802 803
                  <span class="command"><strong>masters</strong></span> or
                  <span class="command"><strong>also-notify</strong></span> lists.
Rob Austein's avatar
regen  
Rob Austein committed
804 805 806 807 808
                </p>
              </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
809
                <p><span class="command"><strong>options</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
810 811 812 813 814 815 816 817 818
              </td>
<td>
                <p>
                  controls global server configuration
                  options and sets defaults for other statements.
                </p>
              </td>
</tr>
<tr>
Mark Andrews's avatar
regen  
Mark Andrews committed
819
<td>
Evan Hunt's avatar
Evan Hunt committed
820
                <p><span class="command"><strong>server</strong></span></p>
Mark Andrews's avatar
regen  
Mark Andrews committed
821 822 823
              </td>
<td>
                <p>
Automatic Updater's avatar
regen  
Automatic Updater committed
824 825
                  sets certain configuration options on
                  a per-server basis.
Mark Andrews's avatar
regen  
Mark Andrews committed
826 827 828 829
                </p>
              </td>
</tr>
<tr>
Rob Austein's avatar
regen  
Rob Austein committed
830
<td>
Evan Hunt's avatar
Evan Hunt committed
831
                <p><span class="command"><strong>statistics-channels</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
832 833 834
              </td>
<td>
                <p>
Automatic Updater's avatar
regen  
Automatic Updater committed
835
                  declares communication channels to get access to
Evan Hunt's avatar
Evan Hunt committed
836
                  <span class="command"><strong>named</strong></span> statistics.
Rob Austein's avatar
regen  
Rob Austein committed
837 838 839 840 841
                </p>
              </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
842
                <p><span class="command"><strong>trusted-keys</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
843 844 845 846 847 848 849 850
              </td>
<td>
                <p>
                  defines trusted DNSSEC keys.
                </p>
              </td>
</tr>
<tr>
Automatic Updater's avatar
regen  
Automatic Updater committed
851
<td>
Evan Hunt's avatar
Evan Hunt committed
852
                <p><span class="command"><strong>managed-keys</strong></span></p>
Automatic Updater's avatar
regen  
Automatic Updater committed
853 854 855 856 857 858 859 860 861
              </td>
<td>
                <p>
                  lists DNSSEC keys to be kept up to date
                  using RFC 5011 trust anchor maintenance.
                </p>
              </td>
</tr>
<tr>
Rob Austein's avatar
regen  
Rob Austein committed
862
<td>
Evan Hunt's avatar
Evan Hunt committed
863
                <p><span class="command"><strong>view</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
864 865 866 867 868 869 870 871 872
              </td>
<td>
                <p>
                  defines a view.
                </p>
              </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
873
                <p><span class="command"><strong>zone</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
874 875 876 877 878 879 880 881
              </td>
<td>
                <p>
                  defines a zone.
                </p>
              </td>
</tr>
</tbody>
Tinderbox User's avatar
Tinderbox User committed
882 883
</table></div>
<p>
Evan Hunt's avatar
Evan Hunt committed
884 885
        The <span class="command"><strong>logging</strong></span> and
        <span class="command"><strong>options</strong></span> statements may only occur once
Rob Austein's avatar
regen  
Rob Austein committed
886 887 888
        per
        configuration.
      </p>
Tinderbox User's avatar
Tinderbox User committed
889
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
890
<div class="titlepage"><div><div><h3 class="title">
Tinderbox User's avatar
Tinderbox User committed
891
<a name="acl_grammar"></a><span class="command"><strong>acl</strong></span> Statement Grammar</h3></div></div></div>
Evan Hunt's avatar
Evan Hunt committed
892
<pre class="programlisting"><span class="command"><strong>acl</strong></span> acl-name {
Mark Andrews's avatar
gregen  
Mark Andrews committed
893
    address_match_list
894
};
Rob Austein's avatar
regen  
Rob Austein committed
895
</pre>
Tinderbox User's avatar
Tinderbox User committed
896 897
</div>
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
898
<div class="titlepage"><div><div><h3 class="title">
Evan Hunt's avatar
Evan Hunt committed
899
<a name="acl"></a><span class="command"><strong>acl</strong></span> Statement Definition and
Rob Austein's avatar
regen  
Rob Austein committed
900
          Usage</h3></div></div></div>
Tinderbox User's avatar
Tinderbox User committed
901
<p>
Evan Hunt's avatar
Evan Hunt committed
902
          The <span class="command"><strong>acl</strong></span> statement assigns a symbolic
Rob Austein's avatar
regen  
Rob Austein committed
903 904 905
          name to an address match list. It gets its name from a primary
          use of address match lists: Access Control Lists (ACLs).
        </p>
Tinderbox User's avatar
Tinderbox User committed
906
<p>
Rob Austein's avatar
regen  
Rob Austein committed
907 908
          The following ACLs are built-in:
        </p>
Tinderbox User's avatar
Tinderbox User committed
909
<div class="informaltable"><table border="1">
Rob Austein's avatar
regen  
Rob Austein committed
910
<colgroup>
Evan Hunt's avatar
Evan Hunt committed
911 912
<col width="1.130in" class="1">
<col width="4.000in" class="2">
Rob Austein's avatar
regen  
Rob Austein committed
913 914 915 916
</colgroup>
<tbody>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
917
                  <p><span class="command"><strong>any</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
918 919 920 921 922 923 924 925 926
                </td>
<td>
                  <p>
                    Matches all hosts.
                  </p>
                </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
927
                  <p><span class="command"><strong>none</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
928 929 930 931 932 933 934 935 936
                </td>
<td>
                  <p>
                    Matches no hosts.
                  </p>
                </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
937
                  <p><span class="command"><strong>localhost</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
938 939 940 941
                </td>
<td>
                  <p>
                    Matches the IPv4 and IPv6 addresses of all network
Tinderbox User's avatar
Tinderbox User committed
942
                    interfaces on the system.  When addresses are
Evan Hunt's avatar
Evan Hunt committed
943
                    added or removed, the <span class="command"><strong>localhost</strong></span>
Tinderbox User's avatar
Tinderbox User committed
944
                    ACL element is updated to reflect the changes.
Rob Austein's avatar
regen  
Rob Austein committed
945 946 947 948 949
                  </p>
                </td>
</tr>
<tr>
<td>
Evan Hunt's avatar
Evan Hunt committed
950
                  <p><span class="command"><strong>localnets</strong></span></p>
Rob Austein's avatar
regen  
Rob Austein committed
951 952 953 954 955
                </td>
<td>
                  <p>
                    Matches any host on an IPv4 or IPv6 network
                    for which the system has an interface.
Tinderbox User's avatar
Tinderbox User committed
956
                    When addresses are added or removed,
Evan Hunt's avatar
Evan Hunt committed
957
                    the <span class="command"><strong>localnets</strong></span>
Tinderbox User's avatar
Tinderbox User committed
958
                    ACL element is updated to reflect the changes.
Rob Austein's avatar
regen  
Rob Austein committed
959 960 961
                    Some systems do not provide a way to determine the prefix
                    lengths of
                    local IPv6 addresses.
Evan Hunt's avatar
Evan Hunt committed
962
                    In such a case, <span class="command"><strong>localnets</strong></span>
Rob Austein's avatar
regen  
Rob Austein committed
963
                    only matches the local
Evan Hunt's avatar
Evan Hunt committed
964
                    IPv6 addresses, just like <span class="command"><strong>localhost</strong></span>.
Rob Austein's avatar
regen  
Rob Austein committed
965 966 967 968
                  </p>
                </td>
</tr>
</tbody>
Tinderbox User's avatar
Tinderbox User committed
969 970 971
</table></div>
</div>
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
972
<div class="titlepage"><div><div><h3 class="title">
Tinderbox User's avatar
Tinderbox User committed
973
<a name="controls_grammar"></a><span class="command"><strong>controls</strong></span> Statement Grammar</h3></div></div></div>
Evan Hunt's avatar
Evan Hunt committed
974
<pre class="programlisting"><span class="command"><strong>controls</strong></span> {
Automatic Updater's avatar
regen  
Automatic Updater committed
975 976
   [ inet ( ip_addr | * ) [ port ip_port ]
                allow { <em class="replaceable"><code> address_match_list </code></em> }
Tinderbox User's avatar
Tinderbox User committed
977 978
                [ keys { <em class="replaceable"><code>key_list</code></em> } ]
                [ read-only <em class="replaceable"><code>yes_or_no</code></em> ] ; ]
Mark Andrews's avatar
gregen  
Mark Andrews committed
979
   [ inet ...; ]
Automatic Updater's avatar
regen  
Automatic Updater committed
980
   [ unix <em class="replaceable"><code>path</code></em> perm <em class="replaceable"><code>number</code></em> owner <em class="replaceable"><code>number</code></em> group <em class="replaceable"><code>number</code></em>
Tinderbox User's avatar
Tinderbox User committed
981 982
                [ keys { <em class="replaceable"><code>key_list</code></em> } ]
                [ read-only <em class="replaceable"><code>yes_or_no</code></em> ] ; ]
Mark Andrews's avatar
gregen  
Mark Andrews committed
983
   [ unix ...; ]
984
};
Rob Austein's avatar
regen  
Rob Austein committed
985
</pre>
Tinderbox User's avatar
Tinderbox User committed
986 987
</div>
<div class="section">
Rob Austein's avatar
regen  
Rob Austein committed
988
<div class="titlepage"><div><div><h3 class="title">
Evan Hunt's avatar
Evan Hunt committed
989
<a name="controls_statement_definition_and_usage"></a><span class="command"><strong>controls</strong></span> Statement Definition and
Rob Austein's avatar
regen  
Rob Austein committed
990
          Usage</h3></div></div></div>
Tinderbox User's avatar
Tinderbox User committed
991
<p>
Evan Hunt's avatar
Evan Hunt committed
992
          The <span class="command"><strong>controls</strong></span> statement declares control
Rob Austein's avatar
regen  
Rob Austein committed
993 994
          channels to be used by system administrators to control the
          operation of the name server. These control channels are
Evan Hunt's avatar
Evan Hunt committed
995
          used by the <span class="command"><strong>rndc</strong></span> utility to send
Mark Andrews's avatar
gregen  
Mark Andrews committed
996
          commands to and retrieve non-DNS results from a name server.
Rob Austein's avatar
regen  
Rob Austein committed
997
        </p>
Tinderbox User's avatar
Tinderbox User committed
998
<p>
Evan Hunt's avatar
Evan Hunt committed
999 1000 1001 1002
          An <span class="command"><strong>inet</strong></span> control channel is a TCP socket
          listening at the specified <span class="command"><strong>ip_port</strong></span> on the
          specified <span class="command"><strong>ip_addr</strong></span>, which can be an IPv4 or IPv6
          address.  An <span class="command"><strong>ip_addr</strong></span> of <code class="literal">*</code> (asterisk) is
Mark Andrews's avatar
gregen  
Mark Andrews committed
1003 1004 1005
          interpreted as the IPv4 wildcard address; connections will be
          accepted on any of the system's IPv4 addresses.
          To listen on the IPv6 wildcard address,
Evan Hunt's avatar
Evan Hunt committed
1006 1007
          use an <span class="command"><strong>ip_addr</strong></span> of <code class="literal">::</code>.
          If you will only use <span class="command"><strong>rndc</strong></span> on the local host,
Rob Austein's avatar
regen  
Rob Austein committed
1008
          using the loopback address (<code class="literal">127.0.0.1</code>
Mark Andrews's avatar
gregen  
Mark Andrews committed
1009
          or <code class="literal">::1</code>) is recommended for maximum security.
Rob Austein's avatar
regen  
Rob Austein committed
1010
        </p>
Tinderbox User's avatar
Tinderbox User committed
1011
<p>
Mark Andrews's avatar
regen  
Mark Andrews committed
1012
          If no port is specified, port 953 is used. The asterisk
Evan Hunt's avatar
Evan Hunt committed
1013
          "<code class="literal">*</code>" cannot be used for <span class="command"><strong>ip_port</strong></span>.
Rob Austein's avatar
regen  
Rob Austein committed
1014
        </p>
Tinderbox User's avatar
Tinderbox User committed
1015
<p>
Rob Austein's avatar
regen  
Rob Austein committed
1016
          The ability to issue commands over the control channel is
Evan Hunt's avatar
Evan Hunt committed
1017 1018
          restricted by the <span class="command"><strong>allow</strong></span> and
          <span class="command"><strong>keys</strong></span> clauses.
Mark Andrews's avatar
gregen  
Mark Andrews committed
1019
          Connections to the control channel are permitted based on the
Evan Hunt's avatar
Evan Hunt committed
1020 1021 1022
          <span class="command"><strong>address_match_list</strong></span>.  This is for simple
          IP address based filtering only; any <span class="command"><strong>key_id</strong></span>
          elements of the <span class="command"><strong>address_match_list</strong></span>
Mark Andrews's avatar
gregen  
Mark Andrews committed
1023 1024
          are ignored.
        </p>
Tinderbox User's avatar
Tinderbox User committed
1025
<p>
Evan Hunt's avatar
Evan Hunt committed
1026
          A <span class="command"><strong>unix</strong></span> control channel is a UNIX domain
Mark Andrews's avatar
gregen  
Mark Andrews committed
1027
          socket listening at the specified path in the file system.
Evan Hunt's avatar
Evan Hunt committed
1028 1029
          Access to the socket is specified by the <span class="command"><strong>perm</strong></span>,
          <span class="command"><strong>owner</strong></span> and <span class="command"><strong>group</strong></span> clauses.
Mark Andrews's avatar
gregen  
Mark Andrews committed
1030
          Note on some platforms (SunOS and Solaris) the permissions
Evan Hunt's avatar
Evan Hunt committed
1031
          (<span class="command"><strong>perm</strong></span>) are applied to the parent directory
Mark Andrews's avatar
gregen  
Mark Andrews committed
1032
          as the permissions on the socket itself are ignored.
Rob Austein's avatar
regen  
Rob Austein committed
1033
        </p>
Tinderbox User's avatar
Tinderbox User committed
1034
<p>
Rob Austein's avatar
regen  
Rob Austein committed
1035
          The primary authorization mechanism of the command
Evan Hunt's avatar
Evan Hunt committed
1036 1037 1038
          channel is the <span class="command"><strong>key_list</strong></span>, which
          contains a list of <span class="command"><strong>key_id</strong></span>s.
          Each <span class="command"><strong>key_id</strong></span> in the <span class="command"><strong>key_list</strong></span>
Mark Andrews's avatar
gregen  
Mark Andrews committed
1039
          is authorized to execute commands over the control channel.
Evan Hunt's avatar
Evan Hunt committed
1040 1041
          See <a class="xref" href="Bv9ARM.ch03.html#rndc">Remote Name Daemon Control application</a> in <a class="xref" href="Bv9ARM.ch03.html#admin_tools" title="Administrative Tools">the section called &#8220;Administrative Tools&#8221;</a>)
          for information about configuring keys in <span class="command"><strong>rndc</strong></span>.
Rob Austein's avatar
regen  
Rob Austein committed
1042
        </p>
Tinderbox User's avatar
Tinderbox User committed
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
<p>
          If the <span class="command"><strong>read-only</strong></span> clause is enabled, the
          control channel is limited to the following set of read-only
          commands: <span class="command"><strong>nta -dump</strong></span>,
          <span class="command"><strong>null</strong></span>, <span class="command"><strong>status</strong></span>,
          <span class="command"><strong>showzone</strong></span>, <span class="command"><strong>testgen</strong></span>, and
          <span class="command"><strong>zonestatus</strong></span>. By default,
          <span class="command"><strong>read-only</strong></span> is not enabled and the control
          channel allows read-write access.
        </p>
Tinderbox User's avatar
Tinderbox User committed
1053
<p>
Evan Hunt's avatar
Evan Hunt committed
1054 1055
          If no <span class="command"><strong>controls</strong></span> statement is present,
          <span class="command"><strong>named</strong></span> will set up a default
Rob Austein's avatar
regen  
Rob Austein committed
1056 1057
          control channel listening on the loopback address 127.0.0.1
          and its IPv6 counterpart ::1.
Evan Hunt's avatar
Evan Hunt committed
1058 1059 1060
          In this case, and also when the <span class="command"><strong>controls</strong></span> statement
          is present but does not have a <span class="command"><strong>keys</strong></span> clause,
          <span class="command"><strong>named</strong></span> will attempt to load the command channel key
Rob Austein's avatar
regen  
Rob Austein committed
1061 1062
          from the file <code class="filename">rndc.key</code> in
          <code class="filename">/etc</code> (or whatever <code class="varname">sysconfdir</code>
Mark Andrews's avatar
regen  
Mark Andrews committed
1063
          was specified as when <acronym class="acronym">BIND</acronym> was built).
Rob Austein's avatar
regen  
Rob Austein committed
1064 1065 1066
          To create a <code class="filename">rndc.key</code> file, run
          <strong class="userinput"><code>rndc-confgen -a</code></strong>.
        </p>
Tinderbox User's avatar
Tinderbox User committed
1067
<p>
Rob Austein's avatar
regen  
Rob Austein committed
1068
          The <code class="filename">rndc.key</code> feature was created to
Mark Andrews's avatar
regen  
Mark Andrews committed
1069
          ease the transition of systems from <acronym class="acronym">BIND</acronym> 8,
Rob Austein's avatar
regen  
Rob Austein committed
1070
          which did not have digital signatures on its command channel
Evan Hunt's avatar
Evan Hunt committed
1071
          messages and thus did not have a <span class="command"><strong>keys</strong></span> clause.
Andreas Gustafsson's avatar
Andreas Gustafsson committed
1072

Mark Andrews's avatar
regen  
Mark Andrews committed
1073 1074
          It makes it possible to use an existing <acronym class="acronym">BIND</acronym> 8
          configuration file in <acronym class="acronym">BIND</acronym> 9 unchanged,
Evan Hunt's avatar
Evan Hunt committed
1075 1076
          and still have <span class="command"><strong>rndc</strong></span> work the same way
          <span class="command"><strong>ndc</strong></span> worked in BIND 8, simply by executing the
Rob Austein's avatar
regen  
Rob Austein committed
1077 1078 1079
          command <strong class="userinput"><code>rndc-confgen -a</code></strong> after BIND 9 is
          installed.
        </p>