PageRenderTime 105ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 1ms

/contrib/bind9/doc/arm/Bv9ARM.ch06.html

https://bitbucket.org/freebsd/freebsd-head/
HTML | 10075 lines | 10019 code | 39 blank | 17 comment | 0 complexity | 23bebf82675bbeb8b00207a8416d590f MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception, BSD-3-Clause, LGPL-2.0, LGPL-2.1, BSD-2-Clause, 0BSD, JSON, AGPL-1.0, GPL-2.0
  1. <!--
  2. - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC")
  3. - Copyright (C) 2000-2003 Internet Software Consortium.
  4. -
  5. - Permission to use, copy, modify, and/or distribute this software for any
  6. - purpose with or without fee is hereby granted, provided that the above
  7. - copyright notice and this permission notice appear in all copies.
  8. -
  9. - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10. - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11. - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12. - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13. - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14. - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15. - PERFORMANCE OF THIS SOFTWARE.
  16. -->
  17. <!-- $Id$ -->
  18. <html>
  19. <head>
  20. <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21. <title>Chapter 6. BIND 9 Configuration Reference</title>
  22. <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  23. <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
  24. <link rel="up" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
  25. <link rel="prev" href="Bv9ARM.ch05.html" title="Chapter 5. The BIND 9 Lightweight Resolver">
  26. <link rel="next" href="Bv9ARM.ch07.html" title="Chapter 7. BIND 9 Security Considerations">
  27. </head>
  28. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  29. <div class="navheader">
  30. <table width="100%" summary="Navigation header">
  31. <tr><th colspan="3" align="center">Chapter 6. <acronym class="acronym">BIND</acronym> 9 Configuration Reference</th></tr>
  32. <tr>
  33. <td width="20%" align="left">
  34. <a accesskey="p" href="Bv9ARM.ch05.html">Prev</a> </td>
  35. <th width="60%" align="center"> </th>
  36. <td width="20%" align="right"> <a accesskey="n" href="Bv9ARM.ch07.html">Next</a>
  37. </td>
  38. </tr>
  39. </table>
  40. <hr>
  41. </div>
  42. <div class="chapter" lang="en">
  43. <div class="titlepage"><div><div><h2 class="title">
  44. <a name="Bv9ARM.ch06"></a>Chapter 6. <acronym class="acronym">BIND</acronym> 9 Configuration Reference</h2></div></div></div>
  45. <div class="toc">
  46. <p><b>Table of Contents</b></p>
  47. <dl>
  48. <dt><span class="sect1"><a href="Bv9ARM.ch06.html#configuration_file_elements">Configuration File Elements</a></span></dt>
  49. <dd><dl>
  50. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#address_match_lists">Address Match Lists</a></span></dt>
  51. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2574332">Comment Syntax</a></span></dt>
  52. </dl></dd>
  53. <dt><span class="sect1"><a href="Bv9ARM.ch06.html#Configuration_File_Grammar">Configuration File Grammar</a></span></dt>
  54. <dd><dl>
  55. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2574986"><span><strong class="command">acl</strong></span> Statement Grammar</a></span></dt>
  56. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#acl"><span><strong class="command">acl</strong></span> Statement Definition and
  57. Usage</a></span></dt>
  58. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2575176"><span><strong class="command">controls</strong></span> Statement Grammar</a></span></dt>
  59. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#controls_statement_definition_and_usage"><span><strong class="command">controls</strong></span> Statement Definition and
  60. Usage</a></span></dt>
  61. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2575467"><span><strong class="command">include</strong></span> Statement Grammar</a></span></dt>
  62. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2575484"><span><strong class="command">include</strong></span> Statement Definition and
  63. Usage</a></span></dt>
  64. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2575576"><span><strong class="command">key</strong></span> Statement Grammar</a></span></dt>
  65. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2575600"><span><strong class="command">key</strong></span> Statement Definition and Usage</a></span></dt>
  66. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2575758"><span><strong class="command">logging</strong></span> Statement Grammar</a></span></dt>
  67. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2575884"><span><strong class="command">logging</strong></span> Statement Definition and
  68. Usage</a></span></dt>
  69. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2577910"><span><strong class="command">lwres</strong></span> Statement Grammar</a></span></dt>
  70. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2577984"><span><strong class="command">lwres</strong></span> Statement Definition and Usage</a></span></dt>
  71. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2578116"><span><strong class="command">masters</strong></span> Statement Grammar</a></span></dt>
  72. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2578160"><span><strong class="command">masters</strong></span> Statement Definition and
  73. Usage</a></span></dt>
  74. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2578174"><span><strong class="command">options</strong></span> Statement Grammar</a></span></dt>
  75. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#options"><span><strong class="command">options</strong></span> Statement Definition and
  76. Usage</a></span></dt>
  77. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#server_statement_grammar"><span><strong class="command">server</strong></span> Statement Grammar</a></span></dt>
  78. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#server_statement_definition_and_usage"><span><strong class="command">server</strong></span> Statement Definition and
  79. Usage</a></span></dt>
  80. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#statschannels"><span><strong class="command">statistics-channels</strong></span> Statement Grammar</a></span></dt>
  81. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2589481"><span><strong class="command">statistics-channels</strong></span> Statement Definition and
  82. Usage</a></span></dt>
  83. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#trusted-keys"><span><strong class="command">trusted-keys</strong></span> Statement Grammar</a></span></dt>
  84. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2589689"><span><strong class="command">trusted-keys</strong></span> Statement Definition
  85. and Usage</a></span></dt>
  86. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2589736"><span><strong class="command">managed-keys</strong></span> Statement Grammar</a></span></dt>
  87. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#managed-keys"><span><strong class="command">managed-keys</strong></span> Statement Definition
  88. and Usage</a></span></dt>
  89. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#view_statement_grammar"><span><strong class="command">view</strong></span> Statement Grammar</a></span></dt>
  90. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2590162"><span><strong class="command">view</strong></span> Statement Definition and Usage</a></span></dt>
  91. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#zone_statement_grammar"><span><strong class="command">zone</strong></span>
  92. Statement Grammar</a></span></dt>
  93. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2591713"><span><strong class="command">zone</strong></span> Statement Definition and Usage</a></span></dt>
  94. </dl></dd>
  95. <dt><span class="sect1"><a href="Bv9ARM.ch06.html#id2595116">Zone File</a></span></dt>
  96. <dd><dl>
  97. <dt><span class="sect2"><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>
  98. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2597415">Discussion of MX Records</a></span></dt>
  99. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#Setting_TTLs">Setting TTLs</a></span></dt>
  100. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2597962">Inverse Mapping in IPv4</a></span></dt>
  101. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2598157">Other Zone File Directives</a></span></dt>
  102. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#id2598430"><acronym class="acronym">BIND</acronym> Master File Extension: the <span><strong class="command">$GENERATE</strong></span> Directive</a></span></dt>
  103. <dt><span class="sect2"><a href="Bv9ARM.ch06.html#zonefile_format">Additional File Formats</a></span></dt>
  104. </dl></dd>
  105. <dt><span class="sect1"><a href="Bv9ARM.ch06.html#statistics">BIND9 Statistics</a></span></dt>
  106. <dd><dl><dt><span class="sect2"><a href="Bv9ARM.ch06.html#statistics_counters">Statistics Counters</a></span></dt></dl></dd>
  107. </dl>
  108. </div>
  109. <p>
  110. <acronym class="acronym">BIND</acronym> 9 configuration is broadly similar
  111. to <acronym class="acronym">BIND</acronym> 8; however, there are a few new
  112. areas
  113. of configuration, such as views. <acronym class="acronym">BIND</acronym>
  114. 8 configuration files should work with few alterations in <acronym class="acronym">BIND</acronym>
  115. 9, although more complex configurations should be reviewed to check
  116. if they can be more efficiently implemented using the new features
  117. found in <acronym class="acronym">BIND</acronym> 9.
  118. </p>
  119. <p>
  120. <acronym class="acronym">BIND</acronym> 4 configuration files can be
  121. converted to the new format
  122. using the shell script
  123. <code class="filename">contrib/named-bootconf/named-bootconf.sh</code>.
  124. </p>
  125. <div class="sect1" lang="en">
  126. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  127. <a name="configuration_file_elements"></a>Configuration File Elements</h2></div></div></div>
  128. <p>
  129. Following is a list of elements used throughout the <acronym class="acronym">BIND</acronym> configuration
  130. file documentation:
  131. </p>
  132. <div class="informaltable"><table border="1">
  133. <colgroup>
  134. <col>
  135. <col>
  136. </colgroup>
  137. <tbody>
  138. <tr>
  139. <td>
  140. <p>
  141. <code class="varname">acl_name</code>
  142. </p>
  143. </td>
  144. <td>
  145. <p>
  146. The name of an <code class="varname">address_match_list</code> as
  147. defined by the <span><strong class="command">acl</strong></span> statement.
  148. </p>
  149. </td>
  150. </tr>
  151. <tr>
  152. <td>
  153. <p>
  154. <code class="varname">address_match_list</code>
  155. </p>
  156. </td>
  157. <td>
  158. <p>
  159. A list of one or more
  160. <code class="varname">ip_addr</code>,
  161. <code class="varname">ip_prefix</code>, <code class="varname">key_id</code>,
  162. or <code class="varname">acl_name</code> elements, see
  163. <a href="Bv9ARM.ch06.html#address_match_lists" title="Address Match Lists">the section called &#8220;Address Match Lists&#8221;</a>.
  164. </p>
  165. </td>
  166. </tr>
  167. <tr>
  168. <td>
  169. <p>
  170. <code class="varname">masters_list</code>
  171. </p>
  172. </td>
  173. <td>
  174. <p>
  175. A named list of one or more <code class="varname">ip_addr</code>
  176. with optional <code class="varname">key_id</code> and/or
  177. <code class="varname">ip_port</code>.
  178. A <code class="varname">masters_list</code> may include other
  179. <code class="varname">masters_lists</code>.
  180. </p>
  181. </td>
  182. </tr>
  183. <tr>
  184. <td>
  185. <p>
  186. <code class="varname">domain_name</code>
  187. </p>
  188. </td>
  189. <td>
  190. <p>
  191. A quoted string which will be used as
  192. a DNS name, for example "<code class="literal">my.test.domain</code>".
  193. </p>
  194. </td>
  195. </tr>
  196. <tr>
  197. <td>
  198. <p>
  199. <code class="varname">namelist</code>
  200. </p>
  201. </td>
  202. <td>
  203. <p>
  204. A list of one or more <code class="varname">domain_name</code>
  205. elements.
  206. </p>
  207. </td>
  208. </tr>
  209. <tr>
  210. <td>
  211. <p>
  212. <code class="varname">dotted_decimal</code>
  213. </p>
  214. </td>
  215. <td>
  216. <p>
  217. One to four integers valued 0 through
  218. 255 separated by dots (`.'), such as <span><strong class="command">123</strong></span>,
  219. <span><strong class="command">45.67</strong></span> or <span><strong class="command">89.123.45.67</strong></span>.
  220. </p>
  221. </td>
  222. </tr>
  223. <tr>
  224. <td>
  225. <p>
  226. <code class="varname">ip4_addr</code>
  227. </p>
  228. </td>
  229. <td>
  230. <p>
  231. An IPv4 address with exactly four elements
  232. in <code class="varname">dotted_decimal</code> notation.
  233. </p>
  234. </td>
  235. </tr>
  236. <tr>
  237. <td>
  238. <p>
  239. <code class="varname">ip6_addr</code>
  240. </p>
  241. </td>
  242. <td>
  243. <p>
  244. An IPv6 address, such as <span><strong class="command">2001:db8::1234</strong></span>.
  245. IPv6 scoped addresses that have ambiguity on their
  246. scope zones must be disambiguated by an appropriate
  247. zone ID with the percent character (`%') as
  248. delimiter. It is strongly recommended to use
  249. string zone names rather than numeric identifiers,
  250. in order to be robust against system configuration
  251. changes. However, since there is no standard
  252. mapping for such names and identifier values,
  253. currently only interface names as link identifiers
  254. are supported, assuming one-to-one mapping between
  255. interfaces and links. For example, a link-local
  256. address <span><strong class="command">fe80::1</strong></span> on the link
  257. attached to the interface <span><strong class="command">ne0</strong></span>
  258. can be specified as <span><strong class="command">fe80::1%ne0</strong></span>.
  259. Note that on most systems link-local addresses
  260. always have the ambiguity, and need to be
  261. disambiguated.
  262. </p>
  263. </td>
  264. </tr>
  265. <tr>
  266. <td>
  267. <p>
  268. <code class="varname">ip_addr</code>
  269. </p>
  270. </td>
  271. <td>
  272. <p>
  273. An <code class="varname">ip4_addr</code> or <code class="varname">ip6_addr</code>.
  274. </p>
  275. </td>
  276. </tr>
  277. <tr>
  278. <td>
  279. <p>
  280. <code class="varname">ip_port</code>
  281. </p>
  282. </td>
  283. <td>
  284. <p>
  285. An IP port <code class="varname">number</code>.
  286. The <code class="varname">number</code> is limited to 0
  287. through 65535, with values
  288. below 1024 typically restricted to use by processes running
  289. as root.
  290. In some cases, an asterisk (`*') character can be used as a
  291. placeholder to
  292. select a random high-numbered port.
  293. </p>
  294. </td>
  295. </tr>
  296. <tr>
  297. <td>
  298. <p>
  299. <code class="varname">ip_prefix</code>
  300. </p>
  301. </td>
  302. <td>
  303. <p>
  304. An IP network specified as an <code class="varname">ip_addr</code>,
  305. followed by a slash (`/') and then the number of bits in the
  306. netmask.
  307. Trailing zeros in a <code class="varname">ip_addr</code>
  308. may omitted.
  309. For example, <span><strong class="command">127/8</strong></span> is the
  310. network <span><strong class="command">127.0.0.0</strong></span> with
  311. netmask <span><strong class="command">255.0.0.0</strong></span> and <span><strong class="command">1.2.3.0/28</strong></span> is
  312. network <span><strong class="command">1.2.3.0</strong></span> with netmask <span><strong class="command">255.255.255.240</strong></span>.
  313. </p>
  314. <p>
  315. When specifying a prefix involving a IPv6 scoped address
  316. the scope may be omitted. In that case the prefix will
  317. match packets from any scope.
  318. </p>
  319. </td>
  320. </tr>
  321. <tr>
  322. <td>
  323. <p>
  324. <code class="varname">key_id</code>
  325. </p>
  326. </td>
  327. <td>
  328. <p>
  329. A <code class="varname">domain_name</code> representing
  330. the name of a shared key, to be used for transaction
  331. security.
  332. </p>
  333. </td>
  334. </tr>
  335. <tr>
  336. <td>
  337. <p>
  338. <code class="varname">key_list</code>
  339. </p>
  340. </td>
  341. <td>
  342. <p>
  343. A list of one or more
  344. <code class="varname">key_id</code>s,
  345. separated by semicolons and ending with a semicolon.
  346. </p>
  347. </td>
  348. </tr>
  349. <tr>
  350. <td>
  351. <p>
  352. <code class="varname">number</code>
  353. </p>
  354. </td>
  355. <td>
  356. <p>
  357. A non-negative 32-bit integer
  358. (i.e., a number between 0 and 4294967295, inclusive).
  359. Its acceptable value might further
  360. be limited by the context in which it is used.
  361. </p>
  362. </td>
  363. </tr>
  364. <tr>
  365. <td>
  366. <p>
  367. <code class="varname">path_name</code>
  368. </p>
  369. </td>
  370. <td>
  371. <p>
  372. A quoted string which will be used as
  373. a pathname, such as <code class="filename">zones/master/my.test.domain</code>.
  374. </p>
  375. </td>
  376. </tr>
  377. <tr>
  378. <td>
  379. <p>
  380. <code class="varname">port_list</code>
  381. </p>
  382. </td>
  383. <td>
  384. <p>
  385. A list of an <code class="varname">ip_port</code> or a port
  386. range.
  387. A port range is specified in the form of
  388. <strong class="userinput"><code>range</code></strong> followed by
  389. two <code class="varname">ip_port</code>s,
  390. <code class="varname">port_low</code> and
  391. <code class="varname">port_high</code>, which represents
  392. port numbers from <code class="varname">port_low</code> through
  393. <code class="varname">port_high</code>, inclusive.
  394. <code class="varname">port_low</code> must not be larger than
  395. <code class="varname">port_high</code>.
  396. For example,
  397. <strong class="userinput"><code>range 1024 65535</code></strong> represents
  398. ports from 1024 through 65535.
  399. In either case an asterisk (`*') character is not
  400. allowed as a valid <code class="varname">ip_port</code>.
  401. </p>
  402. </td>
  403. </tr>
  404. <tr>
  405. <td>
  406. <p>
  407. <code class="varname">size_spec</code>
  408. </p>
  409. </td>
  410. <td>
  411. <p>
  412. A number, the word <strong class="userinput"><code>unlimited</code></strong>,
  413. or the word <strong class="userinput"><code>default</code></strong>.
  414. </p>
  415. <p>
  416. An <code class="varname">unlimited</code> <code class="varname">size_spec</code> requests unlimited
  417. use, or the maximum available amount. A <code class="varname">default size_spec</code> uses
  418. the limit that was in force when the server was started.
  419. </p>
  420. <p>
  421. A <code class="varname">number</code> can optionally be
  422. followed by a scaling factor:
  423. <strong class="userinput"><code>K</code></strong> or <strong class="userinput"><code>k</code></strong>
  424. for kilobytes,
  425. <strong class="userinput"><code>M</code></strong> or <strong class="userinput"><code>m</code></strong>
  426. for megabytes, and
  427. <strong class="userinput"><code>G</code></strong> or <strong class="userinput"><code>g</code></strong> for gigabytes,
  428. which scale by 1024, 1024*1024, and 1024*1024*1024
  429. respectively.
  430. </p>
  431. <p>
  432. The value must be representable as a 64-bit unsigned integer
  433. (0 to 18446744073709551615, inclusive).
  434. Using <code class="varname">unlimited</code> is the best
  435. way
  436. to safely set a really large number.
  437. </p>
  438. </td>
  439. </tr>
  440. <tr>
  441. <td>
  442. <p>
  443. <code class="varname">yes_or_no</code>
  444. </p>
  445. </td>
  446. <td>
  447. <p>
  448. Either <strong class="userinput"><code>yes</code></strong> or <strong class="userinput"><code>no</code></strong>.
  449. The words <strong class="userinput"><code>true</code></strong> and <strong class="userinput"><code>false</code></strong> are
  450. also accepted, as are the numbers <strong class="userinput"><code>1</code></strong>
  451. and <strong class="userinput"><code>0</code></strong>.
  452. </p>
  453. </td>
  454. </tr>
  455. <tr>
  456. <td>
  457. <p>
  458. <code class="varname">dialup_option</code>
  459. </p>
  460. </td>
  461. <td>
  462. <p>
  463. One of <strong class="userinput"><code>yes</code></strong>,
  464. <strong class="userinput"><code>no</code></strong>, <strong class="userinput"><code>notify</code></strong>,
  465. <strong class="userinput"><code>notify-passive</code></strong>, <strong class="userinput"><code>refresh</code></strong> or
  466. <strong class="userinput"><code>passive</code></strong>.
  467. When used in a zone, <strong class="userinput"><code>notify-passive</code></strong>,
  468. <strong class="userinput"><code>refresh</code></strong>, and <strong class="userinput"><code>passive</code></strong>
  469. are restricted to slave and stub zones.
  470. </p>
  471. </td>
  472. </tr>
  473. </tbody>
  474. </table></div>
  475. <div class="sect2" lang="en">
  476. <div class="titlepage"><div><div><h3 class="title">
  477. <a name="address_match_lists"></a>Address Match Lists</h3></div></div></div>
  478. <div class="sect3" lang="en">
  479. <div class="titlepage"><div><div><h4 class="title">
  480. <a name="id2574099"></a>Syntax</h4></div></div></div>
  481. <pre class="programlisting"><code class="varname">address_match_list</code> = address_match_list_element ;
  482. [<span class="optional"> address_match_list_element; ... </span>]
  483. <code class="varname">address_match_list_element</code> = [<span class="optional"> ! </span>] (ip_address [<span class="optional">/length</span>] |
  484. key key_id | acl_name | { address_match_list } )
  485. </pre>
  486. </div>
  487. <div class="sect3" lang="en">
  488. <div class="titlepage"><div><div><h4 class="title">
  489. <a name="id2574126"></a>Definition and Usage</h4></div></div></div>
  490. <p>
  491. Address match lists are primarily used to determine access
  492. control for various server operations. They are also used in
  493. the <span><strong class="command">listen-on</strong></span> and <span><strong class="command">sortlist</strong></span>
  494. statements. The elements which constitute an address match
  495. list can be any of the following:
  496. </p>
  497. <div class="itemizedlist"><ul type="disc">
  498. <li>an IP address (IPv4 or IPv6)</li>
  499. <li>an IP prefix (in `/' notation)</li>
  500. <li>
  501. a key ID, as defined by the <span><strong class="command">key</strong></span>
  502. statement
  503. </li>
  504. <li>the name of an address match list defined with
  505. the <span><strong class="command">acl</strong></span> statement
  506. </li>
  507. <li>a nested address match list enclosed in braces</li>
  508. </ul></div>
  509. <p>
  510. Elements can be negated with a leading exclamation mark (`!'),
  511. and the match list names "any", "none", "localhost", and
  512. "localnets" are predefined. More information on those names
  513. can be found in the description of the acl statement.
  514. </p>
  515. <p>
  516. The addition of the key clause made the name of this syntactic
  517. element something of a misnomer, since security keys can be used
  518. to validate access without regard to a host or network address.
  519. Nonetheless, the term "address match list" is still used
  520. throughout the documentation.
  521. </p>
  522. <p>
  523. When a given IP address or prefix is compared to an address
  524. match list, the comparison takes place in approximately O(1)
  525. time. However, key comparisons require that the list of keys
  526. be traversed until a matching key is found, and therefore may
  527. be somewhat slower.
  528. </p>
  529. <p>
  530. The interpretation of a match depends on whether the list is being
  531. used for access control, defining <span><strong class="command">listen-on</strong></span> ports, or in a
  532. <span><strong class="command">sortlist</strong></span>, and whether the element was negated.
  533. </p>
  534. <p>
  535. When used as an access control list, a non-negated match
  536. allows access and a negated match denies access. If
  537. there is no match, access is denied. The clauses
  538. <span><strong class="command">allow-notify</strong></span>,
  539. <span><strong class="command">allow-recursion</strong></span>,
  540. <span><strong class="command">allow-recursion-on</strong></span>,
  541. <span><strong class="command">allow-query</strong></span>,
  542. <span><strong class="command">allow-query-on</strong></span>,
  543. <span><strong class="command">allow-query-cache</strong></span>,
  544. <span><strong class="command">allow-query-cache-on</strong></span>,
  545. <span><strong class="command">allow-transfer</strong></span>,
  546. <span><strong class="command">allow-update</strong></span>,
  547. <span><strong class="command">allow-update-forwarding</strong></span>, and
  548. <span><strong class="command">blackhole</strong></span> all use address match
  549. lists. Similarly, the <span><strong class="command">listen-on</strong></span> option will cause the
  550. server to refuse queries on any of the machine's
  551. addresses which do not match the list.
  552. </p>
  553. <p>
  554. Order of insertion is significant. If more than one element
  555. in an ACL is found to match a given IP address or prefix,
  556. preference will be given to the one that came
  557. <span class="emphasis"><em>first</em></span> in the ACL definition.
  558. Because of this first-match behavior, an element that
  559. defines a subset of another element in the list should
  560. come before the broader element, regardless of whether
  561. either is negated. For example, in
  562. <span><strong class="command">1.2.3/24; ! 1.2.3.13;</strong></span>
  563. the 1.2.3.13 element is completely useless because the
  564. algorithm will match any lookup for 1.2.3.13 to the 1.2.3/24
  565. element. Using <span><strong class="command">! 1.2.3.13; 1.2.3/24</strong></span> fixes
  566. that problem by having 1.2.3.13 blocked by the negation, but
  567. all other 1.2.3.* hosts fall through.
  568. </p>
  569. </div>
  570. </div>
  571. <div class="sect2" lang="en">
  572. <div class="titlepage"><div><div><h3 class="title">
  573. <a name="id2574332"></a>Comment Syntax</h3></div></div></div>
  574. <p>
  575. The <acronym class="acronym">BIND</acronym> 9 comment syntax allows for
  576. comments to appear
  577. anywhere that whitespace may appear in a <acronym class="acronym">BIND</acronym> configuration
  578. file. To appeal to programmers of all kinds, they can be written
  579. in the C, C++, or shell/perl style.
  580. </p>
  581. <div class="sect3" lang="en">
  582. <div class="titlepage"><div><div><h4 class="title">
  583. <a name="id2574347"></a>Syntax</h4></div></div></div>
  584. <p>
  585. </p>
  586. <pre class="programlisting">/* This is a <acronym class="acronym">BIND</acronym> comment as in C */</pre>
  587. <p>
  588. </p>
  589. <pre class="programlisting">// This is a <acronym class="acronym">BIND</acronym> comment as in C++</pre>
  590. <p>
  591. </p>
  592. <pre class="programlisting"># This is a <acronym class="acronym">BIND</acronym> comment as in common UNIX shells
  593. # and perl</pre>
  594. <p>
  595. </p>
  596. </div>
  597. <div class="sect3" lang="en">
  598. <div class="titlepage"><div><div><h4 class="title">
  599. <a name="id2574377"></a>Definition and Usage</h4></div></div></div>
  600. <p>
  601. Comments may appear anywhere that whitespace may appear in
  602. a <acronym class="acronym">BIND</acronym> configuration file.
  603. </p>
  604. <p>
  605. C-style comments start with the two characters /* (slash,
  606. star) and end with */ (star, slash). Because they are completely
  607. delimited with these characters, they can be used to comment only
  608. a portion of a line or to span multiple lines.
  609. </p>
  610. <p>
  611. C-style comments cannot be nested. For example, the following
  612. is not valid because the entire comment ends with the first */:
  613. </p>
  614. <p>
  615. </p>
  616. <pre class="programlisting">/* This is the start of a comment.
  617. This is still part of the comment.
  618. /* This is an incorrect attempt at nesting a comment. */
  619. This is no longer in any comment. */
  620. </pre>
  621. <p>
  622. </p>
  623. <p>
  624. C++-style comments start with the two characters // (slash,
  625. slash) and continue to the end of the physical line. They cannot
  626. be continued across multiple physical lines; to have one logical
  627. comment span multiple lines, each line must use the // pair.
  628. For example:
  629. </p>
  630. <p>
  631. </p>
  632. <pre class="programlisting">// This is the start of a comment. The next line
  633. // is a new comment, even though it is logically
  634. // part of the previous comment.
  635. </pre>
  636. <p>
  637. </p>
  638. <p>
  639. Shell-style (or perl-style, if you prefer) comments start
  640. with the character <code class="literal">#</code> (number sign)
  641. and continue to the end of the
  642. physical line, as in C++ comments.
  643. For example:
  644. </p>
  645. <p>
  646. </p>
  647. <pre class="programlisting"># This is the start of a comment. The next line
  648. # is a new comment, even though it is logically
  649. # part of the previous comment.
  650. </pre>
  651. <p>
  652. </p>
  653. <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
  654. <h3 class="title">Warning</h3>
  655. <p>
  656. You cannot use the semicolon (`;') character
  657. to start a comment such as you would in a zone file. The
  658. semicolon indicates the end of a configuration
  659. statement.
  660. </p>
  661. </div>
  662. </div>
  663. </div>
  664. </div>
  665. <div class="sect1" lang="en">
  666. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  667. <a name="Configuration_File_Grammar"></a>Configuration File Grammar</h2></div></div></div>
  668. <p>
  669. A <acronym class="acronym">BIND</acronym> 9 configuration consists of
  670. statements and comments.
  671. Statements end with a semicolon. Statements and comments are the
  672. only elements that can appear without enclosing braces. Many
  673. statements contain a block of sub-statements, which are also
  674. terminated with a semicolon.
  675. </p>
  676. <p>
  677. The following statements are supported:
  678. </p>
  679. <div class="informaltable"><table border="1">
  680. <colgroup>
  681. <col>
  682. <col>
  683. </colgroup>
  684. <tbody>
  685. <tr>
  686. <td>
  687. <p><span><strong class="command">acl</strong></span></p>
  688. </td>
  689. <td>
  690. <p>
  691. defines a named IP address
  692. matching list, for access control and other uses.
  693. </p>
  694. </td>
  695. </tr>
  696. <tr>
  697. <td>
  698. <p><span><strong class="command">controls</strong></span></p>
  699. </td>
  700. <td>
  701. <p>
  702. declares control channels to be used
  703. by the <span><strong class="command">rndc</strong></span> utility.
  704. </p>
  705. </td>
  706. </tr>
  707. <tr>
  708. <td>
  709. <p><span><strong class="command">include</strong></span></p>
  710. </td>
  711. <td>
  712. <p>
  713. includes a file.
  714. </p>
  715. </td>
  716. </tr>
  717. <tr>
  718. <td>
  719. <p><span><strong class="command">key</strong></span></p>
  720. </td>
  721. <td>
  722. <p>
  723. specifies key information for use in
  724. authentication and authorization using TSIG.
  725. </p>
  726. </td>
  727. </tr>
  728. <tr>
  729. <td>
  730. <p><span><strong class="command">logging</strong></span></p>
  731. </td>
  732. <td>
  733. <p>
  734. specifies what the server logs, and where
  735. the log messages are sent.
  736. </p>
  737. </td>
  738. </tr>
  739. <tr>
  740. <td>
  741. <p><span><strong class="command">lwres</strong></span></p>
  742. </td>
  743. <td>
  744. <p>
  745. configures <span><strong class="command">named</strong></span> to
  746. also act as a light-weight resolver daemon (<span><strong class="command">lwresd</strong></span>).
  747. </p>
  748. </td>
  749. </tr>
  750. <tr>
  751. <td>
  752. <p><span><strong class="command">masters</strong></span></p>
  753. </td>
  754. <td>
  755. <p>
  756. defines a named masters list for
  757. inclusion in stub and slave zone masters clauses.
  758. </p>
  759. </td>
  760. </tr>
  761. <tr>
  762. <td>
  763. <p><span><strong class="command">options</strong></span></p>
  764. </td>
  765. <td>
  766. <p>
  767. controls global server configuration
  768. options and sets defaults for other statements.
  769. </p>
  770. </td>
  771. </tr>
  772. <tr>
  773. <td>
  774. <p><span><strong class="command">server</strong></span></p>
  775. </td>
  776. <td>
  777. <p>
  778. sets certain configuration options on
  779. a per-server basis.
  780. </p>
  781. </td>
  782. </tr>
  783. <tr>
  784. <td>
  785. <p><span><strong class="command">statistics-channels</strong></span></p>
  786. </td>
  787. <td>
  788. <p>
  789. declares communication channels to get access to
  790. <span><strong class="command">named</strong></span> statistics.
  791. </p>
  792. </td>
  793. </tr>
  794. <tr>
  795. <td>
  796. <p><span><strong class="command">trusted-keys</strong></span></p>
  797. </td>
  798. <td>
  799. <p>
  800. defines trusted DNSSEC keys.
  801. </p>
  802. </td>
  803. </tr>
  804. <tr>
  805. <td>
  806. <p><span><strong class="command">managed-keys</strong></span></p>
  807. </td>
  808. <td>
  809. <p>
  810. lists DNSSEC keys to be kept up to date
  811. using RFC 5011 trust anchor maintenance.
  812. </p>
  813. </td>
  814. </tr>
  815. <tr>
  816. <td>
  817. <p><span><strong class="command">view</strong></span></p>
  818. </td>
  819. <td>
  820. <p>
  821. defines a view.
  822. </p>
  823. </td>
  824. </tr>
  825. <tr>
  826. <td>
  827. <p><span><strong class="command">zone</strong></span></p>
  828. </td>
  829. <td>
  830. <p>
  831. defines a zone.
  832. </p>
  833. </td>
  834. </tr>
  835. </tbody>
  836. </table></div>
  837. <p>
  838. The <span><strong class="command">logging</strong></span> and
  839. <span><strong class="command">options</strong></span> statements may only occur once
  840. per
  841. configuration.
  842. </p>
  843. <div class="sect2" lang="en">
  844. <div class="titlepage"><div><div><h3 class="title">
  845. <a name="id2574986"></a><span><strong class="command">acl</strong></span> Statement Grammar</h3></div></div></div>
  846. <pre class="programlisting"><span><strong class="command">acl</strong></span> acl-name {
  847. address_match_list
  848. };
  849. </pre>
  850. </div>
  851. <div class="sect2" lang="en">
  852. <div class="titlepage"><div><div><h3 class="title">
  853. <a name="acl"></a><span><strong class="command">acl</strong></span> Statement Definition and
  854. Usage</h3></div></div></div>
  855. <p>
  856. The <span><strong class="command">acl</strong></span> statement assigns a symbolic
  857. name to an address match list. It gets its name from a primary
  858. use of address match lists: Access Control Lists (ACLs).
  859. </p>
  860. <p>
  861. Note that an address match list's name must be defined
  862. with <span><strong class="command">acl</strong></span> before it can be used
  863. elsewhere; no forward references are allowed.
  864. </p>
  865. <p>
  866. The following ACLs are built-in:
  867. </p>
  868. <div class="informaltable"><table border="1">
  869. <colgroup>
  870. <col>
  871. <col>
  872. </colgroup>
  873. <tbody>
  874. <tr>
  875. <td>
  876. <p><span><strong class="command">any</strong></span></p>
  877. </td>
  878. <td>
  879. <p>
  880. Matches all hosts.
  881. </p>
  882. </td>
  883. </tr>
  884. <tr>
  885. <td>
  886. <p><span><strong class="command">none</strong></span></p>
  887. </td>
  888. <td>
  889. <p>
  890. Matches no hosts.
  891. </p>
  892. </td>
  893. </tr>
  894. <tr>
  895. <td>
  896. <p><span><strong class="command">localhost</strong></span></p>
  897. </td>
  898. <td>
  899. <p>
  900. Matches the IPv4 and IPv6 addresses of all network
  901. interfaces on the system.
  902. </p>
  903. </td>
  904. </tr>
  905. <tr>
  906. <td>
  907. <p><span><strong class="command">localnets</strong></span></p>
  908. </td>
  909. <td>
  910. <p>
  911. Matches any host on an IPv4 or IPv6 network
  912. for which the system has an interface.
  913. Some systems do not provide a way to determine the prefix
  914. lengths of
  915. local IPv6 addresses.
  916. In such a case, <span><strong class="command">localnets</strong></span>
  917. only matches the local
  918. IPv6 addresses, just like <span><strong class="command">localhost</strong></span>.
  919. </p>
  920. </td>
  921. </tr>
  922. </tbody>
  923. </table></div>
  924. </div>
  925. <div class="sect2" lang="en">
  926. <div class="titlepage"><div><div><h3 class="title">
  927. <a name="id2575176"></a><span><strong class="command">controls</strong></span> Statement Grammar</h3></div></div></div>
  928. <pre class="programlisting"><span><strong class="command">controls</strong></span> {
  929. [ inet ( ip_addr | * ) [ port ip_port ]
  930. allow { <em class="replaceable"><code> address_match_list </code></em> }
  931. keys { <em class="replaceable"><code>key_list</code></em> }; ]
  932. [ inet ...; ]
  933. [ 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>
  934. keys { <em class="replaceable"><code>key_list</code></em> }; ]
  935. [ unix ...; ]
  936. };
  937. </pre>
  938. </div>
  939. <div class="sect2" lang="en">
  940. <div class="titlepage"><div><div><h3 class="title">
  941. <a name="controls_statement_definition_and_usage"></a><span><strong class="command">controls</strong></span> Statement Definition and
  942. Usage</h3></div></div></div>
  943. <p>
  944. The <span><strong class="command">controls</strong></span> statement declares control
  945. channels to be used by system administrators to control the
  946. operation of the name server. These control channels are
  947. used by the <span><strong class="command">rndc</strong></span> utility to send
  948. commands to and retrieve non-DNS results from a name server.
  949. </p>
  950. <p>
  951. An <span><strong class="command">inet</strong></span> control channel is a TCP socket
  952. listening at the specified <span><strong class="command">ip_port</strong></span> on the
  953. specified <span><strong class="command">ip_addr</strong></span>, which can be an IPv4 or IPv6
  954. address. An <span><strong class="command">ip_addr</strong></span> of <code class="literal">*</code> (asterisk) is
  955. interpreted as the IPv4 wildcard address; connections will be
  956. accepted on any of the system's IPv4 addresses.
  957. To listen on the IPv6 wildcard address,
  958. use an <span><strong class="command">ip_addr</strong></span> of <code class="literal">::</code>.
  959. If you will only use <span><strong class="command">rndc</strong></span> on the local host,
  960. using the loopback address (<code class="literal">127.0.0.1</code>
  961. or <code class="literal">::1</code>) is recommended for maximum security.
  962. </p>
  963. <p>
  964. If no port is specified, port 953 is used. The asterisk
  965. "<code class="literal">*</code>" cannot be used for <span><strong class="command">ip_port</strong></span>.
  966. </p>
  967. <p>
  968. The ability to issue commands over the control channel is
  969. restricted by the <span><strong class="command">allow</strong></span> and
  970. <span><strong class="command">keys</strong></span> clauses.
  971. Connections to the control channel are permitted based on the
  972. <span><strong class="command">address_match_list</strong></span>. This is for simple
  973. IP address based filtering only; any <span><strong class="command">key_id</strong></span>
  974. elements of the <span><strong class="command">address_match_list</strong></span>
  975. are ignored.
  976. </p>
  977. <p>
  978. A <span><strong class="command">unix</strong></span> control channel is a UNIX domain
  979. socket listening at the specified path in the file system.
  980. Access to the socket is specified by the <span><strong class="command">perm</strong></span>,
  981. <span><strong class="command">owner</strong></span> and <span><strong class="command">group</strong></span> clauses.
  982. Note on some platforms (SunOS and Solaris) the permissions
  983. (<span><strong class="command">perm</strong></span>) are applied to the parent directory
  984. as the permissions on the socket itself are ignored.
  985. </p>
  986. <p>
  987. The primary authorization mechanism of the command
  988. channel is the <span><strong class="command">key_list</strong></span>, which
  989. contains a list of <span><strong class="command">key_id</strong></span>s.
  990. Each <span><strong class="command">key_id</strong></span> in the <span><strong class="command">key_list</strong></span>
  991. is authorized to execute commands over the control channel.
  992. See <a href="Bv9ARM.ch03.html#rndc">Remote Name Daemon Control application</a> in <a href="Bv9ARM.ch03.html#admin_tools" title="Administrative Tools">the section called &#8220;Administrative Tools&#8221;</a>)
  993. for information about configuring keys in <span><strong class="command">rndc</strong></span>.
  994. </p>
  995. <p>
  996. If no <span><strong class="command">controls</strong></span> statement is present,
  997. <span><strong class="command">named</strong></span> will set up a default
  998. control channel listening on the loopback address 127.0.0.1
  999. and its IPv6 counterpart ::1.
  1000. In this case, and also when the <span><strong class="command">controls</strong></span> statement
  1001. is present but does not have a <span><strong class="command">keys</strong></span> clause,
  1002. <span><strong class="command">named</strong></span> will attempt to load the command channel key
  1003. from the file <code class="filename">rndc.key</code> in
  1004. <code class="filename">/etc</code> (or whatever <code class="varname">sysconfdir</code>
  1005. was specified as when <acronym class="acronym">BIND</acronym> was built).
  1006. To create a <code class="filename">rndc.key</code> file, run
  1007. <strong class="userinput"><code>rndc-confgen -a</code></strong>.
  1008. </p>
  1009. <p>
  1010. The <code class="filename">rndc.key</code> feature was created to
  1011. ease the transition of systems from <acronym class="acronym">BIND</acronym> 8,
  1012. which did not have digital signatures on its command channel
  1013. messages and thus did not have a <span><strong class="command">keys</strong></span> clause.
  1014. It makes it possible to use an existing <acronym class="acronym">BIND</acronym> 8
  1015. configuration file in <acronym class="acronym">BIND</acronym> 9 unchanged,
  1016. and still have <span><strong class="command">rndc</strong></span> work the same way
  1017. <span><strong class="command">ndc</strong></span> worked in BIND 8, simply by executing the
  1018. command <strong class="userinput"><code>rndc-confgen -a</code></strong> after BIND 9 is
  1019. installed.
  1020. </p>
  1021. <p>
  1022. Since the <code class="filename">rndc.key</code> feature
  1023. is only intended to allow the backward-compatible usage of
  1024. <acronym class="acronym">BIND</acronym> 8 configuration files, this
  1025. feature does not
  1026. have a high degree of configurability. You cannot easily change
  1027. the key name or the size of the secret, so you should make a
  1028. <code class="filename">rndc.conf</code> with your own key if you
  1029. wish to change
  1030. those things. The <code class="filename">rndc.key</code> file
  1031. also has its
  1032. permissions set such that only the owner of the file (the user that
  1033. <span><strong class="command">named</strong></span> is running as) can access it.
  1034. If you
  1035. desire greater flexibility in allowing other users to access
  1036. <span><strong class="command">rndc</strong></span> commands, then you need to create
  1037. a
  1038. <code class="filename">rndc.conf</code> file and make it group
  1039. readable by a group
  1040. that contains the users who should have access.
  1041. </p>
  1042. <p>
  1043. To disable the command channel, use an empty
  1044. <span><strong class="command">controls</strong></span> statement:
  1045. <span><strong class="command">controls { };</strong></span>.
  1046. </p>
  1047. </div>
  1048. <div class="sect2" lang="en">
  1049. <div class="titlepage"><div><div><h3 class="title">
  1050. <a name="id2575467"></a><span><strong class="command">include</strong></span> Statement Grammar</h3></div></div></div>
  1051. <pre class="programlisting"><span><strong class="command">include</strong></span> <em class="replaceable"><code>filename</code></em>;</pre>
  1052. </div>
  1053. <div class="sect2" lang="en">
  1054. <div class="titlepage"><div><div><h3 class="title">
  1055. <a name="id2575484"></a><span><strong class="command">include</strong></span> Statement Definition and
  1056. Usage</h3></div></div></div>
  1057. <p>
  1058. The <span><strong class="command">include</strong></span> statement inserts the
  1059. specified file at the point where the <span><strong class="command">include</strong></span>
  1060. statement is encountered. The <span><strong class="command">include</strong></span>
  1061. statement facilitates the administration of configuration
  1062. files
  1063. by permitting the reading or writing of some things but not
  1064. others. For example, the statement could include private keys
  1065. that are readable only by the name server.
  1066. </p>
  1067. </div>
  1068. <div class="sect2" lang="en">
  1069. <div class="titlepage"><div><div><h3 class="title">
  1070. <a name="id2575576"></a><span><strong class="command">key</strong></span> Statement Grammar</h3></div></div></div>
  1071. <pre class="programlisting"><span><strong class="command">key</strong></span> <em class="replaceable"><code>key_id</code></em> {
  1072. algorithm <em class="replaceable"><code>string</code></em>;
  1073. secret <em class="replaceable"><code>string</code></em>;
  1074. };
  1075. </pre>
  1076. </div>
  1077. <div class="sect2" lang="en">
  1078. <div class="titlepage"><div><div><h3 class="title">
  1079. <a name="id2575600"></a><span><strong class="command">key</strong></span> Statement Definition and Usage</h3></div></div></div>
  1080. <p>
  1081. The <span><strong class="command">key</strong></span> statement defines a shared
  1082. secret key for use with TSIG (see <a href="Bv9ARM.ch04.html#tsig" title="TSIG">the section called &#8220;TSIG&#8221;</a>)
  1083. or the command channel
  1084. (see <a href="Bv9ARM.ch06.html#controls_statement_definition_and_usage" title="controls Statement Definition and
  1085. Usage">the section called &#8220;<span><strong class="command">controls</strong></span> Statement Definition and
  1086. Usage&#8221;</a>).
  1087. </p>
  1088. <p>
  1089. The <span><strong class="command">key</strong></span> statement can occur at the
  1090. top level
  1091. of the configuration file or inside a <span><strong class="command">view</strong></span>
  1092. statement. Keys defined in top-level <span><strong class="command">key</strong></span>
  1093. statements can be used in all views. Keys intended for use in
  1094. a <span><strong class="command">controls</strong></span> statement
  1095. (see <a href="Bv9ARM.ch06.html#controls_statement_definition_and_usage" title="controls Statement Definition and
  1096. Usage">the section called &#8220;<span><strong class="command">controls</strong></span> Statement Definition and
  1097. Usage&#8221;</a>)
  1098. must be defined at the top level.
  1099. </p>
  1100. <p>
  1101. The <em class="replaceable"><code>key_id</code></em>, also known as the
  1102. key name, is a domain name uniquely identifying the key. It can
  1103. be used in a <span><strong class="command">server</strong></span>
  1104. statement to cause requests sent to that
  1105. server to be signed with this key, or in address match lists to
  1106. verify that incoming requests have been signed with a key
  1107. matching this name, algorithm, and secret.
  1108. </p>
  1109. <p>
  1110. The <em class="replaceable"><code>algorithm_id</code></em> is a string
  1111. that specifies a security/authentication algorithm. Named
  1112. supports <code class="literal">hmac-md5</code>,
  1113. <code class="literal">hmac-sha1</code>, <code class="literal">hmac-sha224</code>,
  1114. <code class="literal">hmac-sha256</code>, <code class="literal">hmac-sha384</code>
  1115. and <code class="literal">hmac-sha512</code> TSIG authentication.
  1116. Truncated hashes are supported by appending the minimum
  1117. number of required bits preceded by a dash, e.g.
  1118. <code class="literal">hmac-sha1-80</code>. The
  1119. <em class="replaceable"><code>secret_string</code></em> is the secret
  1120. to be used by the algorithm, and is treated as a base-64
  1121. encoded string.
  1122. </p>
  1123. </div>
  1124. <div class="sect2" lang="en">
  1125. <div class="titlepage"><div><div><h3 class="title">
  1126. <a name="id2575758"></a><span><strong class="command">logging</strong></span> Statement Grammar</h3></div></div></div>
  1127. <pre class="programlisting"><span><strong class="command">logging</strong></span> {
  1128. [ <span><strong class="command">channel</strong></span> <em class="replaceable"><code>channel_name</code></em> {
  1129. ( <span><strong class="command">file</strong></span> <em class="replaceable"><code>path_name</code></em>
  1130. [ <span><strong class="command">versions</strong></span> ( <em class="replaceable"><code>number</code></em> | <span><strong class="command">unlimited</strong></span> ) ]
  1131. [ <span><strong class="command">size</strong></span> <em class="replaceable"><code>size spec</code></em> ]
  1132. | <span><strong class="command">syslog</strong></span> <em class="replaceable"><code>syslog_facility</code></em>
  1133. | <span><strong class="command">stderr</strong></span>
  1134. | <span><strong class="command">null</strong></span> );
  1135. [ <span><strong class="command">severity</strong></span> (<code class="option">critical</code> | <code class="option">error</code> | <code class="option">warning</code> | <code class="option">notice</code> |
  1136. <code class="option">info</code> | <code class="option">debug</code> [ <em class="replaceable"><code>level</code></em> ] | <code class="option">dynamic</code> ); ]
  1137. [ <span><strong class="command">print-category</strong></span> <code class="option">yes</code> or <code class="option">no</code>; ]
  1138. [ <span><strong class="command">print-severity</strong></span> <code class="option">yes</code> or <code class="option">no</code>; ]
  1139. [ <span><strong class="command">print-time</strong></span> <code class="option">yes</code> or <code class="option">no</code>; ]
  1140. }; ]
  1141. [ <span><strong class="command">category</strong></span> <em class="replaceable"><code>category_name</code></em> {
  1142. <em class="replaceable"><code>channel_name</code></em> ; [ <em class="replaceable"><code>channel_name</code></em> ; ... ]
  1143. }; ]
  1144. ...
  1145. };
  1146. </pre>
  1147. </div>
  1148. <div class="sect2" lang="en">
  1149. <div class="titlepage"><div><div><h3 class="title">
  1150. <a name="id2575884"></a><span><strong class="command">logging</strong></span> Statement Definition and
  1151. Usage</h3></div></div></div>
  1152. <p>
  1153. The <span><strong class="command">logging</strong></span> statement configures a
  1154. wide
  1155. variety of logging options for the name server. Its <span><strong class="command">channel</strong></span> phrase
  1156. associates output methods, format options and severity levels with
  1157. a name that can then be used with the <span><strong class="command">category</strong></span> phrase
  1158. to select how various classes of messages are logged.
  1159. </p>
  1160. <p>
  1161. Only one <span><strong class="command">logging</strong></span> statement is used to
  1162. define
  1163. as many channels and categories as are wanted. If there is no <span><strong class="command">logging</strong></span> statement,
  1164. the logging configuration will be:
  1165. </p>
  1166. <pre class="programlisting">logging {
  1167. category default { default_syslog; default_debug; };
  1168. category unmatched { null; };
  1169. };
  1170. </pre>
  1171. <p>
  1172. In <acronym class="acronym">BIND</acronym> 9, the logging configuration
  1173. is only established when
  1174. the entire configuration file has been parsed. In <acronym class="acronym">BIND</acronym> 8, it was
  1175. established as soon as the <span><strong class="command">logging</strong></span>
  1176. statement
  1177. was parsed. When the server is starting up, all logging messages
  1178. regarding syntax errors in the configuration file go to the default
  1179. channels, or to standard error if the "<code class="option">-g</code>" option
  1180. was specified.
  1181. </p>
  1182. <div class="sect3" lang="en">
  1183. <div class="titlepage"><div><div><h4 class="title">
  1184. <a name="id2576005"></a>The <span><strong class="command">channel</strong></span> Phrase</h4></div></div></div>
  1185. <p>
  1186. All log output goes to one or more <span class="emphasis"><em>channels</em></span>;
  1187. you can make as many of them as you want.
  1188. </p>
  1189. <p>
  1190. Every channel definition must include a destination clause that
  1191. says whether messages selected for the channel go to a file, to a
  1192. particular syslog facility, to the standard error stream, or are
  1193. discarded. It can optionally also limit the message severity level
  1194. that will be accepted by the channel (the default is
  1195. <span><strong class="command">info</strong></span>), and whether to include a
  1196. <span><strong class="command">named</strong></span>-generated time stamp, the
  1197. category name
  1198. and/or severity level (the default is not to include any).
  1199. </p>
  1200. <p>
  1201. The <span><strong class="command">null</strong></span> destination clause
  1202. causes all messages sent to the channel to be discarded;
  1203. in that case, other options for the channel are meaningless.
  1204. </p>
  1205. <p>
  1206. The <span><strong class="command">file</strong></span> destination clause directs
  1207. the channel
  1208. to a disk file. It can include limitations
  1209. both on how large the file is allowed to become, and how many
  1210. versions
  1211. of the file will be saved each time the file is opened.
  1212. </p>
  1213. <p>
  1214. If you use the <span><strong class="command">versions</strong></span> log file
  1215. option, then
  1216. <span><strong class="command">named</strong></span> will retain that many backup
  1217. versions of the file by
  1218. renaming them when opening. For example, if you choose to keep
  1219. three old versions
  1220. of the file <code class="filename">lamers.log</code>, then just
  1221. before it is opened
  1222. <code class="filename">lamers.log.1</code> is renamed to
  1223. <code class="filename">lamers.log.2</code>, <code class="filename">lamers.log.0</code> is renamed
  1224. to <code class="filename">lamers.log.1</code>, and <code class="filename">lamers.log</code> is
  1225. renamed to <code class="filename">lamers.log.0</code>.
  1226. You can say <span><strong class="command">versions unlimited</strong></span> to
  1227. not limit
  1228. the number of versions.
  1229. If a <span><strong class="command">size</strong></span> option is associated with
  1230. the log file,
  1231. then renaming is only done when the file being opened exceeds the
  1232. indicated size. No backup versions are kept by default; any
  1233. existing
  1234. log file is simply appended.
  1235. </p>
  1236. <p>
  1237. The <span><strong class="command">size</strong></span> option for files is used
  1238. to limit log
  1239. growth. If the file ever exceeds the size, then <span><strong class="command">named</strong></span> will
  1240. stop writing to the file unless it has a <span><strong class="command">versions</strong></span> option
  1241. associated with it. If backup versions are kept, the files are
  1242. rolled as
  1243. described above and a new one begun. If there is no
  1244. <span><strong class="command">versions</strong></span> option, no more data will
  1245. be written to the log
  1246. until some out-of-band mechanism removes or truncates the log to
  1247. less than the
  1248. maximum size. The default behavior is not to limit the size of
  1249. the
  1250. file.
  1251. </p>
  1252. <p>
  1253. Example usage of the <span><strong class="command">size</strong></span> and
  1254. <span><strong class="command">versions</strong></span> options:
  1255. </p>
  1256. <pre class="programlisting">channel an_example_channel {
  1257. file "example.log" versions 3 size 20m;
  1258. print-time yes;
  1259. print-category yes;
  1260. };
  1261. </pre>
  1262. <p>
  1263. The <span><strong class="command">syslog</strong></span> destination clause
  1264. directs the
  1265. channel to the system log. Its argument is a
  1266. syslog facility as described in the <span><strong class="command">syslog</strong></span> man
  1267. page. Known facilities are <span><strong class="command">kern</strong></span>, <span><strong class="command">user</strong></span>,
  1268. <span><strong class="command">mail</strong></span>, <span><strong class="command">daemon</strong></span>, <span><strong class="command">auth</strong></span>,
  1269. <span><strong class="command">syslog</strong></span>, <span><strong class="command">lpr</strong></span>, <span><strong class="command">news</strong></span>,
  1270. <span><strong class="command">uucp</strong></span>, <span><strong class="command">cron</strong></span>, <span><strong class="command">authpriv</strong></span>,
  1271. <span><strong class="command">ftp</strong></span>, <span><strong class="command">local0</strong></span>, <span><strong class="command">local1</strong></span>,
  1272. <span><strong class="command">local2</strong></span>, <span><strong class="command">local3</strong></span>, <span><strong class="command">local4</strong></span>,
  1273. <span><strong class="command">local5</strong></span>, <span><strong class="command">local6</strong></span> and
  1274. <span><strong class="command">local7</strong></span>, however not all facilities
  1275. are supported on
  1276. all operating systems.
  1277. How <span><strong class="command">syslog</strong></span> will handle messages
  1278. sent to
  1279. this facility is described in the <span><strong class="command">syslog.conf</strong></span> man
  1280. page. If you have a system which uses a very old version of <span><strong class="command">syslog</strong></span> that
  1281. only uses two arguments to the <span><strong class="command">openlog()</strong></span> function,
  1282. then this clause is silently ignored.
  1283. </p>
  1284. <p>
  1285. The <span><strong class="command">severity</strong></span> clause works like <span><strong class="command">syslog</strong></span>'s
  1286. "priorities", except that they can also be used if you are writing
  1287. straight to a file rather than using <span><strong class="command">syslog</strong></span>.
  1288. Messages which are not at least of the severity level given will
  1289. not be selected for the channel; messages of higher severity
  1290. levels
  1291. will be accepted.
  1292. </p>
  1293. <p>
  1294. If you are using <span><strong class="command">syslog</strong></span>, then the <span><strong class="command">syslog.conf</strong></span> priorities
  1295. will also determine what eventually passes through. For example,
  1296. defining a channel facility and severity as <span><strong class="command">daemon</strong></span> and <span><strong class="command">debug</strong></span> but
  1297. only logging <span><strong class="command">daemon.warning</strong></span> via <span><strong class="command">syslog.conf</strong></span> will
  1298. cause messages of severity <span><strong class="command">info</strong></span> and
  1299. <span><strong class="command">notice</strong></span> to
  1300. be dropped. If the situation were reversed, with <span><strong class="command">named</strong></span> writing
  1301. messages of only <span><strong class="command">warning</strong></span> or higher,
  1302. then <span><strong class="command">syslogd</strong></span> would
  1303. print all messages it received from the channel.
  1304. </p>
  1305. <p>
  1306. The <span><strong class="command">stderr</strong></span> destination clause
  1307. directs the
  1308. channel to the server's standard error stream. This is intended
  1309. for
  1310. use when the server is running as a foreground process, for
  1311. example
  1312. when debugging a configuration.
  1313. </p>
  1314. <p>
  1315. The server can supply extensive debugging information when
  1316. it is in debugging mode. If the server's global debug level is
  1317. greater
  1318. than zero, then debugging mode will be active. The global debug
  1319. level is set either by starting the <span><strong class="command">named</strong></span> server
  1320. with the <code class="option">-d</code> flag followed by a positive integer,
  1321. or by running <span><strong class="command">rndc trace</strong></span>.
  1322. The global debug level
  1323. can be set to zero, and debugging mode turned off, by running <span><strong class="command">rndc
  1324. notrace</strong></span>. All debugging messages in the server have a debug
  1325. level, and higher debug levels give more detailed output. Channels
  1326. that specify a specific debug severity, for example:
  1327. </p>
  1328. <pre class="programlisting">channel specific_debug_level {
  1329. file "foo";
  1330. severity debug 3;
  1331. };
  1332. </pre>
  1333. <p>
  1334. will get debugging output of level 3 or less any time the
  1335. server is in debugging mode, regardless of the global debugging
  1336. level. Channels with <span><strong class="command">dynamic</strong></span>
  1337. severity use the
  1338. server's global debug level to determine what messages to print.
  1339. </p>
  1340. <p>
  1341. If <span><strong class="command">print-time</strong></span> has been turned on,
  1342. then
  1343. the date and time will be logged. <span><strong class="command">print-time</strong></span> may
  1344. be specified for a <span><strong class="command">syslog</strong></span> channel,
  1345. but is usually
  1346. pointless since <span><strong class="command">syslog</strong></span> also logs
  1347. the date and
  1348. time. If <span><strong class="command">print-category</strong></span> is
  1349. requested, then the
  1350. category of the message will be logged as well. Finally, if <span><strong class="command">print-severity</strong></span> is
  1351. on, then the severity level of the message will be logged. The <span><strong class="command">print-</strong></span> options may
  1352. be used in any combination, and will always be printed in the
  1353. following
  1354. order: time, category, severity. Here is an example where all
  1355. three <span><strong class="command">print-</strong></span> options
  1356. are on:
  1357. </p>
  1358. <p>
  1359. <code class="computeroutput">28-Feb-2000 15:05:32.863 general: notice: running</code>
  1360. </p>
  1361. <p>
  1362. There are four predefined channels that are used for
  1363. <span><strong class="command">named</strong></span>'s default logging as follows.
  1364. How they are
  1365. used is described in <a href="Bv9ARM.ch06.html#the_category_phrase" title="The category Phrase">the section called &#8220;The <span><strong class="command">category</strong></span> Phrase&#8221;</a>.
  1366. </p>
  1367. <pre class="programlisting">channel default_syslog {
  1368. // send to syslog's daemon facility
  1369. syslog daemon;
  1370. // only send priority info and higher
  1371. severity info;
  1372. channel default_debug {
  1373. // write to named.run in the working directory
  1374. // Note: stderr is used instead of "named.run" if
  1375. // the server is started with the '-f' option.
  1376. file "named.run";
  1377. // log at the server's current debug level
  1378. severity dynamic;
  1379. };
  1380. channel default_stderr {
  1381. // writes to stderr
  1382. stderr;
  1383. // only send priority info and higher
  1384. severity info;
  1385. };
  1386. channel null {
  1387. // toss anything sent to this channel
  1388. null;
  1389. };
  1390. </pre>
  1391. <p>
  1392. The <span><strong class="command">default_debug</strong></span> channel has the
  1393. special
  1394. property that it only produces output when the server's debug
  1395. level is
  1396. nonzero. It normally writes to a file called <code class="filename">named.run</code>
  1397. in the server's working directory.
  1398. </p>
  1399. <p>
  1400. For security reasons, when the "<code class="option">-u</code>"
  1401. command line option is used, the <code class="filename">named.run</code> file
  1402. is created only after <span><strong class="command">named</strong></span> has
  1403. changed to the
  1404. new UID, and any debug output generated while <span><strong class="command">named</strong></span> is
  1405. starting up and still running as root is discarded. If you need
  1406. to capture this output, you must run the server with the "<code class="option">-g</code>"
  1407. option and redirect standard error to a file.
  1408. </p>
  1409. <p>
  1410. Once a channel is defined, it cannot be redefined. Thus you
  1411. cannot alter the built-in channels directly, but you can modify
  1412. the default logging by pointing categories at channels you have
  1413. defined.
  1414. </p>
  1415. </div>
  1416. <div class="sect3" lang="en">
  1417. <div class="titlepage"><div><div><h4 class="title">
  1418. <a name="the_category_phrase"></a>The <span><strong class="command">category</strong></span> Phrase</h4></div></div></div>
  1419. <p>
  1420. There are many categories, so you can send the logs you want
  1421. to see wherever you want, without seeing logs you don't want. If
  1422. you don't specify a list of channels for a category, then log
  1423. messages
  1424. in that category will be sent to the <span><strong class="command">default</strong></span> category
  1425. instead. If you don't specify a default category, the following
  1426. "default default" is used:
  1427. </p>
  1428. <pre class="programlisting">category default { default_syslog; default_debug; };
  1429. </pre>
  1430. <p>
  1431. As an example, let's say you want to log security events to
  1432. a file, but you also want keep the default logging behavior. You'd
  1433. specify the following:
  1434. </p>
  1435. <pre class="programlisting">channel my_security_channel {
  1436. file "my_security_file";
  1437. severity info;
  1438. };
  1439. category security {
  1440. my_security_channel;
  1441. default_syslog;
  1442. default_debug;
  1443. };</pre>
  1444. <p>
  1445. To discard all messages in a category, specify the <span><strong class="command">null</strong></span> channel:
  1446. </p>
  1447. <pre class="programlisting">category xfer-out { null; };
  1448. category notify { null; };
  1449. </pre>
  1450. <p>
  1451. Following are the available categories and brief descriptions
  1452. of the types of log information they contain. More
  1453. categories may be added in future <acronym class="acronym">BIND</acronym> releases.
  1454. </p>
  1455. <div class="informaltable"><table border="1">
  1456. <colgroup>
  1457. <col>
  1458. <col>
  1459. </colgroup>
  1460. <tbody>
  1461. <tr>
  1462. <td>
  1463. <p><span><strong class="command">default</strong></span></p>
  1464. </td>
  1465. <td>
  1466. <p>
  1467. The default category defines the logging
  1468. options for those categories where no specific
  1469. configuration has been
  1470. defined.
  1471. </p>
  1472. </td>
  1473. </tr>
  1474. <tr>
  1475. <td>
  1476. <p><span><strong class="command">general</strong></span></p>
  1477. </td>
  1478. <td>
  1479. <p>
  1480. The catch-all. Many things still aren't
  1481. classified into categories, and they all end up here.
  1482. </p>
  1483. </td>
  1484. </tr>
  1485. <tr>
  1486. <td>
  1487. <p><span><strong class="command">database</strong></span></p>
  1488. </td>
  1489. <td>
  1490. <p>
  1491. Messages relating to the databases used
  1492. internally by the name server to store zone and cache
  1493. data.
  1494. </p>
  1495. </td>
  1496. </tr>
  1497. <tr>
  1498. <td>
  1499. <p><span><strong class="command">security</strong></span></p>
  1500. </td>
  1501. <td>
  1502. <p>
  1503. Approval and denial of requests.
  1504. </p>
  1505. </td>
  1506. </tr>
  1507. <tr>
  1508. <td>
  1509. <p><span><strong class="command">config</strong></span></p>
  1510. </td>
  1511. <td>
  1512. <p>
  1513. Configuration file parsing and processing.
  1514. </p>
  1515. </td>
  1516. </tr>
  1517. <tr>
  1518. <td>
  1519. <p><span><strong class="command">resolver</strong></span></p>
  1520. </td>
  1521. <td>
  1522. <p>
  1523. DNS resolution, such as the recursive
  1524. lookups performed on behalf of clients by a caching name
  1525. server.
  1526. </p>
  1527. </td>
  1528. </tr>
  1529. <tr>
  1530. <td>
  1531. <p><span><strong class="command">xfer-in</strong></span></p>
  1532. </td>
  1533. <td>
  1534. <p>
  1535. Zone transfers the server is receiving.
  1536. </p>
  1537. </td>
  1538. </tr>
  1539. <tr>
  1540. <td>
  1541. <p><span><strong class="command">xfer-out</strong></span></p>
  1542. </td>
  1543. <td>
  1544. <p>
  1545. Zone transfers the server is sending.
  1546. </p>
  1547. </td>
  1548. </tr>
  1549. <tr>
  1550. <td>
  1551. <p><span><strong class="command">notify</strong></span></p>
  1552. </td>
  1553. <td>
  1554. <p>
  1555. The NOTIFY protocol.
  1556. </p>
  1557. </td>
  1558. </tr>
  1559. <tr>
  1560. <td>
  1561. <p><span><strong class="command">client</strong></span></p>
  1562. </td>
  1563. <td>
  1564. <p>
  1565. Processing of client requests.
  1566. </p>
  1567. </td>
  1568. </tr>
  1569. <tr>
  1570. <td>
  1571. <p><span><strong class="command">unmatched</strong></span></p>
  1572. </td>
  1573. <td>
  1574. <p>
  1575. Messages that <span><strong class="command">named</strong></span> was unable to determine the
  1576. class of or for which there was no matching <span><strong class="command">view</strong></span>.
  1577. A one line summary is also logged to the <span><strong class="command">client</strong></span> category.
  1578. This category is best sent to a file or stderr, by
  1579. default it is sent to
  1580. the <span><strong class="command">null</strong></span> channel.
  1581. </p>
  1582. </td>
  1583. </tr>
  1584. <tr>
  1585. <td>
  1586. <p><span><strong class="command">network</strong></span></p>
  1587. </td>
  1588. <td>
  1589. <p>
  1590. Network operations.
  1591. </p>
  1592. </td>
  1593. </tr>
  1594. <tr>
  1595. <td>
  1596. <p><span><strong class="command">update</strong></span></p>
  1597. </td>
  1598. <td>
  1599. <p>
  1600. Dynamic updates.
  1601. </p>
  1602. </td>
  1603. </tr>
  1604. <tr>
  1605. <td>
  1606. <p><span><strong class="command">update-security</strong></span></p>
  1607. </td>
  1608. <td>
  1609. <p>
  1610. Approval and denial of update requests.
  1611. </p>
  1612. </td>
  1613. </tr>
  1614. <tr>
  1615. <td>
  1616. <p><span><strong class="command">queries</strong></span></p>
  1617. </td>
  1618. <td>
  1619. <p>
  1620. Specify where queries should be logged to.
  1621. </p>
  1622. <p>
  1623. At startup, specifying the category <span><strong class="command">queries</strong></span> will also
  1624. enable query logging unless <span><strong class="command">querylog</strong></span> option has been
  1625. specified.
  1626. </p>
  1627. <p>
  1628. The query log entry reports the client's IP
  1629. address and port number, and the query name,
  1630. class and type. Next it reports whether the
  1631. Recursion Desired flag was set (+ if set, -
  1632. if not set), if the query was signed (S),
  1633. EDNS was in use (E), if TCP was used (T), if
  1634. DO (DNSSEC Ok) was set (D), or if CD (Checking
  1635. Disabled) was set (C). After this the
  1636. destination address the query was sent to is
  1637. reported.
  1638. </p>
  1639. <p>
  1640. <code class="computeroutput">client 127.0.0.1#62536: query: www.example.com IN AAAA +SE</code>
  1641. </p>
  1642. <p>
  1643. <code class="computeroutput">client ::1#62537: query: www.example.net IN AAAA -SE</code>
  1644. </p>
  1645. </td>
  1646. </tr>
  1647. <tr>
  1648. <td>
  1649. <p><span><strong class="command">query-errors</strong></span></p>
  1650. </td>
  1651. <td>
  1652. <p>
  1653. Information about queries that resulted in some
  1654. failure.
  1655. </p>
  1656. </td>
  1657. </tr>
  1658. <tr>
  1659. <td>
  1660. <p><span><strong class="command">dispatch</strong></span></p>
  1661. </td>
  1662. <td>
  1663. <p>
  1664. Dispatching of incoming packets to the
  1665. server modules where they are to be processed.
  1666. </p>
  1667. </td>
  1668. </tr>
  1669. <tr>
  1670. <td>
  1671. <p><span><strong class="command">dnssec</strong></span></p>
  1672. </td>
  1673. <td>
  1674. <p>
  1675. DNSSEC and TSIG protocol processing.
  1676. </p>
  1677. </td>
  1678. </tr>
  1679. <tr>
  1680. <td>
  1681. <p><span><strong class="command">lame-servers</strong></span></p>
  1682. </td>
  1683. <td>
  1684. <p>
  1685. Lame servers. These are misconfigurations
  1686. in remote servers, discovered by BIND 9 when trying to
  1687. query those servers during resolution.
  1688. </p>
  1689. </td>
  1690. </tr>
  1691. <tr>
  1692. <td>
  1693. <p><span><strong class="command">delegation-only</strong></span></p>
  1694. </td>
  1695. <td>
  1696. <p>
  1697. Delegation only. Logs queries that have been
  1698. forced to NXDOMAIN as the result of a
  1699. delegation-only zone or a
  1700. <span><strong class="command">delegation-only</strong></span> in a hint
  1701. or stub zone declaration.
  1702. </p>
  1703. </td>
  1704. </tr>
  1705. <tr>
  1706. <td>
  1707. <p><span><strong class="command">edns-disabled</strong></span></p>
  1708. </td>
  1709. <td>
  1710. <p>
  1711. Log queries that have been forced to use plain
  1712. DNS due to timeouts. This is often due to
  1713. the remote servers not being RFC 1034 compliant
  1714. (not always returning FORMERR or similar to
  1715. EDNS queries and other extensions to the DNS
  1716. when they are not understood). In other words, this is
  1717. targeted at servers that fail to respond to
  1718. DNS queries that they don't understand.
  1719. </p>
  1720. <p>
  1721. Note: the log message can also be due to
  1722. packet loss. Before reporting servers for
  1723. non-RFC 1034 compliance they should be re-tested
  1724. to determine the nature of the non-compliance.
  1725. This testing should prevent or reduce the
  1726. number of false-positive reports.
  1727. </p>
  1728. <p>
  1729. Note: eventually <span><strong class="command">named</strong></span> will have to stop
  1730. treating such timeouts as due to RFC 1034 non
  1731. compliance and start treating it as plain
  1732. packet loss. Falsely classifying packet
  1733. loss as due to RFC 1034 non compliance impacts
  1734. on DNSSEC validation which requires EDNS for
  1735. the DNSSEC records to be returned.
  1736. </p>
  1737. </td>
  1738. </tr>
  1739. <tr>
  1740. <td>
  1741. <p><span><strong class="command">RPZ</strong></span></p>
  1742. </td>
  1743. <td>
  1744. <p>
  1745. Information about errors in response policy zone files,
  1746. rewritten responses, and at the highest
  1747. <span><strong class="command">debug</strong></span> levels, mere rewriting
  1748. attempts.
  1749. </p>
  1750. </td>
  1751. </tr>
  1752. </tbody>
  1753. </table></div>
  1754. </div>
  1755. <div class="sect3" lang="en">
  1756. <div class="titlepage"><div><div><h4 class="title">
  1757. <a name="id2577322"></a>The <span><strong class="command">query-errors</strong></span> Category</h4></div></div></div>
  1758. <p>
  1759. The <span><strong class="command">query-errors</strong></span> category is
  1760. specifically intended for debugging purposes: To identify
  1761. why and how specific queries result in responses which
  1762. indicate an error.
  1763. Messages of this category are therefore only logged
  1764. with <span><strong class="command">debug</strong></span> levels.
  1765. </p>
  1766. <p>
  1767. At the debug levels of 1 or higher, each response with the
  1768. rcode of SERVFAIL is logged as follows:
  1769. </p>
  1770. <p>
  1771. <code class="computeroutput">client 127.0.0.1#61502: query failed (SERVFAIL) for www.example.com/IN/AAAA at query.c:3880</code>
  1772. </p>
  1773. <p>
  1774. This means an error resulting in SERVFAIL was
  1775. detected at line 3880 of source file
  1776. <code class="filename">query.c</code>.
  1777. Log messages of this level will particularly
  1778. help identify the cause of SERVFAIL for an
  1779. authoritative server.
  1780. </p>
  1781. <p>
  1782. At the debug levels of 2 or higher, detailed context
  1783. information of recursive resolutions that resulted in
  1784. SERVFAIL is logged.
  1785. The log message will look like as follows:
  1786. </p>
  1787. <p>
  1788. </p>
  1789. <pre class="programlisting">
  1790. fetch completed at resolver.c:2970 for www.example.com/A
  1791. in 30.000183: timed out/success [domain:example.com,
  1792. referral:2,restart:7,qrysent:8,timeout:5,lame:0,neterr:0,
  1793. badresp:1,adberr:0,findfail:0,valfail:0]
  1794. </pre>
  1795. <p>
  1796. </p>
  1797. <p>
  1798. The first part before the colon shows that a recursive
  1799. resolution for AAAA records of www.example.com completed
  1800. in 30.000183 seconds and the final result that led to the
  1801. SERVFAIL was determined at line 2970 of source file
  1802. <code class="filename">resolver.c</code>.
  1803. </p>
  1804. <p>
  1805. The following part shows the detected final result and the
  1806. latest result of DNSSEC validation.
  1807. The latter is always success when no validation attempt
  1808. is made.
  1809. In this example, this query resulted in SERVFAIL probably
  1810. because all name servers are down or unreachable, leading
  1811. to a timeout in 30 seconds.
  1812. DNSSEC validation was probably not attempted.
  1813. </p>
  1814. <p>
  1815. The last part enclosed in square brackets shows statistics
  1816. information collected for this particular resolution
  1817. attempt.
  1818. The <code class="varname">domain</code> field shows the deepest zone
  1819. that the resolver reached;
  1820. it is the zone where the error was finally detected.
  1821. The meaning of the other fields is summarized in the
  1822. following table.
  1823. </p>
  1824. <div class="informaltable"><table border="1">
  1825. <colgroup>
  1826. <col>
  1827. <col>
  1828. </colgroup>
  1829. <tbody>
  1830. <tr>
  1831. <td>
  1832. <p><code class="varname">referral</code></p>
  1833. </td>
  1834. <td>
  1835. <p>
  1836. The number of referrals the resolver received
  1837. throughout the resolution process.
  1838. In the above example this is 2, which are most
  1839. likely com and example.com.
  1840. </p>
  1841. </td>
  1842. </tr>
  1843. <tr>
  1844. <td>
  1845. <p><code class="varname">restart</code></p>
  1846. </td>
  1847. <td>
  1848. <p>
  1849. The number of cycles that the resolver tried
  1850. remote servers at the <code class="varname">domain</code>
  1851. zone.
  1852. In each cycle the resolver sends one query
  1853. (possibly resending it, depending on the response)
  1854. to each known name server of
  1855. the <code class="varname">domain</code> zone.
  1856. </p>
  1857. </td>
  1858. </tr>
  1859. <tr>
  1860. <td>
  1861. <p><code class="varname">qrysent</code></p>
  1862. </td>
  1863. <td>
  1864. <p>
  1865. The number of queries the resolver sent at the
  1866. <code class="varname">domain</code> zone.
  1867. </p>
  1868. </td>
  1869. </tr>
  1870. <tr>
  1871. <td>
  1872. <p><code class="varname">timeout</code></p>
  1873. </td>
  1874. <td>
  1875. <p>
  1876. The number of timeouts since the resolver
  1877. received the last response.
  1878. </p>
  1879. </td>
  1880. </tr>
  1881. <tr>
  1882. <td>
  1883. <p><code class="varname">lame</code></p>
  1884. </td>
  1885. <td>
  1886. <p>
  1887. The number of lame servers the resolver detected
  1888. at the <code class="varname">domain</code> zone.
  1889. A server is detected to be lame either by an
  1890. invalid response or as a result of lookup in
  1891. BIND9's address database (ADB), where lame
  1892. servers are cached.
  1893. </p>
  1894. </td>
  1895. </tr>
  1896. <tr>
  1897. <td>
  1898. <p><code class="varname">neterr</code></p>
  1899. </td>
  1900. <td>
  1901. <p>
  1902. The number of erroneous results that the
  1903. resolver encountered in sending queries
  1904. at the <code class="varname">domain</code> zone.
  1905. One common case is the remote server is
  1906. unreachable and the resolver receives an ICMP
  1907. unreachable error message.
  1908. </p>
  1909. </td>
  1910. </tr>
  1911. <tr>
  1912. <td>
  1913. <p><code class="varname">badresp</code></p>
  1914. </td>
  1915. <td>
  1916. <p>
  1917. The number of unexpected responses (other than
  1918. <code class="varname">lame</code>) to queries sent by the
  1919. resolver at the <code class="varname">domain</code> zone.
  1920. </p>
  1921. </td>
  1922. </tr>
  1923. <tr>
  1924. <td>
  1925. <p><code class="varname">adberr</code></p>
  1926. </td>
  1927. <td>
  1928. <p>
  1929. Failures in finding remote server addresses
  1930. of the <code class="varname">domain</code> zone in the ADB.
  1931. One common case of this is that the remote
  1932. server's name does not have any address records.
  1933. </p>
  1934. </td>
  1935. </tr>
  1936. <tr>
  1937. <td>
  1938. <p><code class="varname">findfail</code></p>
  1939. </td>
  1940. <td>
  1941. <p>
  1942. Failures of resolving remote server addresses.
  1943. This is a total number of failures throughout
  1944. the resolution process.
  1945. </p>
  1946. </td>
  1947. </tr>
  1948. <tr>
  1949. <td>
  1950. <p><code class="varname">valfail</code></p>
  1951. </td>
  1952. <td>
  1953. <p>
  1954. Failures of DNSSEC validation.
  1955. Validation failures are counted throughout
  1956. the resolution process (not limited to
  1957. the <code class="varname">domain</code> zone), but should
  1958. only happen in <code class="varname">domain</code>.
  1959. </p>
  1960. </td>
  1961. </tr>
  1962. </tbody>
  1963. </table></div>
  1964. <p>
  1965. At the debug levels of 3 or higher, the same messages
  1966. as those at the debug 1 level are logged for other errors
  1967. than SERVFAIL.
  1968. Note that negative responses such as NXDOMAIN are not
  1969. regarded as errors here.
  1970. </p>
  1971. <p>
  1972. At the debug levels of 4 or higher, the same messages
  1973. as those at the debug 2 level are logged for other errors
  1974. than SERVFAIL.
  1975. Unlike the above case of level 3, messages are logged for
  1976. negative responses.
  1977. This is because any unexpected results can be difficult to
  1978. debug in the recursion case.
  1979. </p>
  1980. </div>
  1981. </div>
  1982. <div class="sect2" lang="en">
  1983. <div class="titlepage"><div><div><h3 class="title">
  1984. <a name="id2577910"></a><span><strong class="command">lwres</strong></span> Statement Grammar</h3></div></div></div>
  1985. <p>
  1986. This is the grammar of the <span><strong class="command">lwres</strong></span>
  1987. statement in the <code class="filename">named.conf</code> file:
  1988. </p>
  1989. <pre class="programlisting"><span><strong class="command">lwres</strong></span> {
  1990. [<span class="optional"> listen-on { <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ;
  1991. [<span class="optional"> <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; ... </span>] }; </span>]
  1992. [<span class="optional"> view <em class="replaceable"><code>view_name</code></em>; </span>]
  1993. [<span class="optional"> search { <em class="replaceable"><code>domain_name</code></em> ; [<span class="optional"> <em class="replaceable"><code>domain_name</code></em> ; ... </span>] }; </span>]
  1994. [<span class="optional"> ndots <em class="replaceable"><code>number</code></em>; </span>]
  1995. };
  1996. </pre>
  1997. </div>
  1998. <div class="sect2" lang="en">
  1999. <div class="titlepage"><div><div><h3 class="title">
  2000. <a name="id2577984"></a><span><strong class="command">lwres</strong></span> Statement Definition and Usage</h3></div></div></div>
  2001. <p>
  2002. The <span><strong class="command">lwres</strong></span> statement configures the
  2003. name
  2004. server to also act as a lightweight resolver server. (See
  2005. <a href="Bv9ARM.ch05.html#lwresd" title="Running a Resolver Daemon">the section called &#8220;Running a Resolver Daemon&#8221;</a>.) There may be multiple
  2006. <span><strong class="command">lwres</strong></span> statements configuring
  2007. lightweight resolver servers with different properties.
  2008. </p>
  2009. <p>
  2010. The <span><strong class="command">listen-on</strong></span> statement specifies a
  2011. list of
  2012. addresses (and ports) that this instance of a lightweight resolver
  2013. daemon
  2014. should accept requests on. If no port is specified, port 921 is
  2015. used.
  2016. If this statement is omitted, requests will be accepted on
  2017. 127.0.0.1,
  2018. port 921.
  2019. </p>
  2020. <p>
  2021. The <span><strong class="command">view</strong></span> statement binds this
  2022. instance of a
  2023. lightweight resolver daemon to a view in the DNS namespace, so that
  2024. the
  2025. response will be constructed in the same manner as a normal DNS
  2026. query
  2027. matching this view. If this statement is omitted, the default view
  2028. is
  2029. used, and if there is no default view, an error is triggered.
  2030. </p>
  2031. <p>
  2032. The <span><strong class="command">search</strong></span> statement is equivalent to
  2033. the
  2034. <span><strong class="command">search</strong></span> statement in
  2035. <code class="filename">/etc/resolv.conf</code>. It provides a
  2036. list of domains
  2037. which are appended to relative names in queries.
  2038. </p>
  2039. <p>
  2040. The <span><strong class="command">ndots</strong></span> statement is equivalent to
  2041. the
  2042. <span><strong class="command">ndots</strong></span> statement in
  2043. <code class="filename">/etc/resolv.conf</code>. It indicates the
  2044. minimum
  2045. number of dots in a relative domain name that should result in an
  2046. exact match lookup before search path elements are appended.
  2047. </p>
  2048. </div>
  2049. <div class="sect2" lang="en">
  2050. <div class="titlepage"><div><div><h3 class="title">
  2051. <a name="id2578116"></a><span><strong class="command">masters</strong></span> Statement Grammar</h3></div></div></div>
  2052. <pre class="programlisting">
  2053. <span><strong class="command">masters</strong></span> <em class="replaceable"><code>name</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] { ( <em class="replaceable"><code>masters_list</code></em> |
  2054. <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] [<span class="optional">key <em class="replaceable"><code>key</code></em></span>] ) ; [<span class="optional">...</span>] };
  2055. </pre>
  2056. </div>
  2057. <div class="sect2" lang="en">
  2058. <div class="titlepage"><div><div><h3 class="title">
  2059. <a name="id2578160"></a><span><strong class="command">masters</strong></span> Statement Definition and
  2060. Usage</h3></div></div></div>
  2061. <p><span><strong class="command">masters</strong></span>
  2062. lists allow for a common set of masters to be easily used by
  2063. multiple stub and slave zones.
  2064. </p>
  2065. </div>
  2066. <div class="sect2" lang="en">
  2067. <div class="titlepage"><div><div><h3 class="title">
  2068. <a name="id2578174"></a><span><strong class="command">options</strong></span> Statement Grammar</h3></div></div></div>
  2069. <p>
  2070. This is the grammar of the <span><strong class="command">options</strong></span>
  2071. statement in the <code class="filename">named.conf</code> file:
  2072. </p>
  2073. <pre class="programlisting"><span><strong class="command">options</strong></span> {
  2074. [<span class="optional"> attach-cache <em class="replaceable"><code>cache_name</code></em>; </span>]
  2075. [<span class="optional"> version <em class="replaceable"><code>version_string</code></em>; </span>]
  2076. [<span class="optional"> hostname <em class="replaceable"><code>hostname_string</code></em>; </span>]
  2077. [<span class="optional"> server-id <em class="replaceable"><code>server_id_string</code></em>; </span>]
  2078. [<span class="optional"> directory <em class="replaceable"><code>path_name</code></em>; </span>]
  2079. [<span class="optional"> key-directory <em class="replaceable"><code>path_name</code></em>; </span>]
  2080. [<span class="optional"> managed-keys-directory <em class="replaceable"><code>path_name</code></em>; </span>]
  2081. [<span class="optional"> named-xfer <em class="replaceable"><code>path_name</code></em>; </span>]
  2082. [<span class="optional"> tkey-gssapi-keytab <em class="replaceable"><code>path_name</code></em>; </span>]
  2083. [<span class="optional"> tkey-gssapi-credential <em class="replaceable"><code>principal</code></em>; </span>]
  2084. [<span class="optional"> tkey-domain <em class="replaceable"><code>domainname</code></em>; </span>]
  2085. [<span class="optional"> tkey-dhkey <em class="replaceable"><code>key_name</code></em> <em class="replaceable"><code>key_tag</code></em>; </span>]
  2086. [<span class="optional"> cache-file <em class="replaceable"><code>path_name</code></em>; </span>]
  2087. [<span class="optional"> dump-file <em class="replaceable"><code>path_name</code></em>; </span>]
  2088. [<span class="optional"> bindkeys-file <em class="replaceable"><code>path_name</code></em>; </span>]
  2089. [<span class="optional"> secroots-file <em class="replaceable"><code>path_name</code></em>; </span>]
  2090. [<span class="optional"> session-keyfile <em class="replaceable"><code>path_name</code></em>; </span>]
  2091. [<span class="optional"> session-keyname <em class="replaceable"><code>key_name</code></em>; </span>]
  2092. [<span class="optional"> session-keyalg <em class="replaceable"><code>algorithm_id</code></em>; </span>]
  2093. [<span class="optional"> memstatistics <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2094. [<span class="optional"> memstatistics-file <em class="replaceable"><code>path_name</code></em>; </span>]
  2095. [<span class="optional"> pid-file <em class="replaceable"><code>path_name</code></em>; </span>]
  2096. [<span class="optional"> recursing-file <em class="replaceable"><code>path_name</code></em>; </span>]
  2097. [<span class="optional"> statistics-file <em class="replaceable"><code>path_name</code></em>; </span>]
  2098. [<span class="optional"> zone-statistics <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2099. [<span class="optional"> auth-nxdomain <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2100. [<span class="optional"> deallocate-on-exit <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2101. [<span class="optional"> dialup <em class="replaceable"><code>dialup_option</code></em>; </span>]
  2102. [<span class="optional"> fake-iquery <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2103. [<span class="optional"> fetch-glue <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2104. [<span class="optional"> flush-zones-on-shutdown <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2105. [<span class="optional"> has-old-clients <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2106. [<span class="optional"> host-statistics <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2107. [<span class="optional"> host-statistics-max <em class="replaceable"><code>number</code></em>; </span>]
  2108. [<span class="optional"> minimal-responses <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2109. [<span class="optional"> multiple-cnames <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2110. [<span class="optional"> notify <em class="replaceable"><code>yes_or_no</code></em> | <em class="replaceable"><code>explicit</code></em> | <em class="replaceable"><code>master-only</code></em>; </span>]
  2111. [<span class="optional"> recursion <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2112. [<span class="optional"> rfc2308-type1 <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2113. [<span class="optional"> use-id-pool <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2114. [<span class="optional"> maintain-ixfr-base <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2115. [<span class="optional"> ixfr-from-differences (<em class="replaceable"><code>yes_or_no</code></em> | <code class="constant">master</code> | <code class="constant">slave</code>); </span>]
  2116. [<span class="optional"> dnssec-enable <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2117. [<span class="optional"> dnssec-validation (<em class="replaceable"><code>yes_or_no</code></em> | <code class="constant">auto</code>); </span>]
  2118. [<span class="optional"> dnssec-lookaside ( <em class="replaceable"><code>auto</code></em> |
  2119. <em class="replaceable"><code>no</code></em> |
  2120. <em class="replaceable"><code>domain</code></em> trust-anchor <em class="replaceable"><code>domain</code></em> ); </span>]
  2121. [<span class="optional"> dnssec-must-be-secure <em class="replaceable"><code>domain yes_or_no</code></em>; </span>]
  2122. [<span class="optional"> dnssec-accept-expired <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2123. [<span class="optional"> forward ( <em class="replaceable"><code>only</code></em> | <em class="replaceable"><code>first</code></em> ); </span>]
  2124. [<span class="optional"> forwarders { [<span class="optional"> <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; ... </span>] }; </span>]
  2125. [<span class="optional"> dual-stack-servers [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] {
  2126. ( <em class="replaceable"><code>domain_name</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] |
  2127. <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ) ;
  2128. ... }; </span>]
  2129. [<span class="optional"> check-names ( <em class="replaceable"><code>master</code></em> | <em class="replaceable"><code>slave</code></em> | <em class="replaceable"><code>response</code></em> )
  2130. ( <em class="replaceable"><code>warn</code></em> | <em class="replaceable"><code>fail</code></em> | <em class="replaceable"><code>ignore</code></em> ); </span>]
  2131. [<span class="optional"> check-dup-records ( <em class="replaceable"><code>warn</code></em> | <em class="replaceable"><code>fail</code></em> | <em class="replaceable"><code>ignore</code></em> ); </span>]
  2132. [<span class="optional"> check-mx ( <em class="replaceable"><code>warn</code></em> | <em class="replaceable"><code>fail</code></em> | <em class="replaceable"><code>ignore</code></em> ); </span>]
  2133. [<span class="optional"> check-wildcard <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2134. [<span class="optional"> check-integrity <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2135. [<span class="optional"> check-mx-cname ( <em class="replaceable"><code>warn</code></em> | <em class="replaceable"><code>fail</code></em> | <em class="replaceable"><code>ignore</code></em> ); </span>]
  2136. [<span class="optional"> check-srv-cname ( <em class="replaceable"><code>warn</code></em> | <em class="replaceable"><code>fail</code></em> | <em class="replaceable"><code>ignore</code></em> ); </span>]
  2137. [<span class="optional"> check-sibling <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2138. [<span class="optional"> allow-new-zones { <em class="replaceable"><code>yes_or_no</code></em> }; </span>]
  2139. [<span class="optional"> allow-notify { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2140. [<span class="optional"> allow-query { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2141. [<span class="optional"> allow-query-on { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2142. [<span class="optional"> allow-query-cache { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2143. [<span class="optional"> allow-query-cache-on { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2144. [<span class="optional"> allow-transfer { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2145. [<span class="optional"> allow-recursion { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2146. [<span class="optional"> allow-recursion-on { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2147. [<span class="optional"> allow-update { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2148. [<span class="optional"> allow-update-forwarding { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2149. [<span class="optional"> update-check-ksk <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2150. [<span class="optional"> dnssec-dnskey-kskonly <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2151. [<span class="optional"> dnssec-secure-to-insecure <em class="replaceable"><code>yes_or_no</code></em> ;</span>]
  2152. [<span class="optional"> try-tcp-refresh <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2153. [<span class="optional"> allow-v6-synthesis { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2154. [<span class="optional"> blackhole { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2155. [<span class="optional"> use-v4-udp-ports { <em class="replaceable"><code>port_list</code></em> }; </span>]
  2156. [<span class="optional"> avoid-v4-udp-ports { <em class="replaceable"><code>port_list</code></em> }; </span>]
  2157. [<span class="optional"> use-v6-udp-ports { <em class="replaceable"><code>port_list</code></em> }; </span>]
  2158. [<span class="optional"> avoid-v6-udp-ports { <em class="replaceable"><code>port_list</code></em> }; </span>]
  2159. [<span class="optional"> listen-on [<span class="optional"> port <em class="replaceable"><code>ip_port</code></em> </span>] { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2160. [<span class="optional"> listen-on-v6 [<span class="optional"> port <em class="replaceable"><code>ip_port</code></em> </span>] { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2161. [<span class="optional"> query-source ( ( <em class="replaceable"><code>ip4_addr</code></em> | <em class="replaceable"><code>*</code></em> )
  2162. [<span class="optional"> port ( <em class="replaceable"><code>ip_port</code></em> | <em class="replaceable"><code>*</code></em> ) </span>] |
  2163. [<span class="optional"> address ( <em class="replaceable"><code>ip4_addr</code></em> | <em class="replaceable"><code>*</code></em> ) </span>]
  2164. [<span class="optional"> port ( <em class="replaceable"><code>ip_port</code></em> | <em class="replaceable"><code>*</code></em> ) </span>] ) ; </span>]
  2165. [<span class="optional"> query-source-v6 ( ( <em class="replaceable"><code>ip6_addr</code></em> | <em class="replaceable"><code>*</code></em> )
  2166. [<span class="optional"> port ( <em class="replaceable"><code>ip_port</code></em> | <em class="replaceable"><code>*</code></em> ) </span>] |
  2167. [<span class="optional"> address ( <em class="replaceable"><code>ip6_addr</code></em> | <em class="replaceable"><code>*</code></em> ) </span>]
  2168. [<span class="optional"> port ( <em class="replaceable"><code>ip_port</code></em> | <em class="replaceable"><code>*</code></em> ) </span>] ) ; </span>]
  2169. [<span class="optional"> use-queryport-pool <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2170. [<span class="optional"> queryport-pool-ports <em class="replaceable"><code>number</code></em>; </span>]
  2171. [<span class="optional"> queryport-pool-updateinterval <em class="replaceable"><code>number</code></em>; </span>]
  2172. [<span class="optional"> max-transfer-time-in <em class="replaceable"><code>number</code></em>; </span>]
  2173. [<span class="optional"> max-transfer-time-out <em class="replaceable"><code>number</code></em>; </span>]
  2174. [<span class="optional"> max-transfer-idle-in <em class="replaceable"><code>number</code></em>; </span>]
  2175. [<span class="optional"> max-transfer-idle-out <em class="replaceable"><code>number</code></em>; </span>]
  2176. [<span class="optional"> tcp-clients <em class="replaceable"><code>number</code></em>; </span>]
  2177. [<span class="optional"> reserved-sockets <em class="replaceable"><code>number</code></em>; </span>]
  2178. [<span class="optional"> recursive-clients <em class="replaceable"><code>number</code></em>; </span>]
  2179. [<span class="optional"> serial-query-rate <em class="replaceable"><code>number</code></em>; </span>]
  2180. [<span class="optional"> serial-queries <em class="replaceable"><code>number</code></em>; </span>]
  2181. [<span class="optional"> tcp-listen-queue <em class="replaceable"><code>number</code></em>; </span>]
  2182. [<span class="optional"> transfer-format <em class="replaceable"><code>( one-answer | many-answers )</code></em>; </span>]
  2183. [<span class="optional"> transfers-in <em class="replaceable"><code>number</code></em>; </span>]
  2184. [<span class="optional"> transfers-out <em class="replaceable"><code>number</code></em>; </span>]
  2185. [<span class="optional"> transfers-per-ns <em class="replaceable"><code>number</code></em>; </span>]
  2186. [<span class="optional"> transfer-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  2187. [<span class="optional"> transfer-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  2188. [<span class="optional"> alt-transfer-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  2189. [<span class="optional"> alt-transfer-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>)
  2190. [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  2191. [<span class="optional"> use-alt-transfer-source <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2192. [<span class="optional"> notify-delay <em class="replaceable"><code>seconds</code></em> ; </span>]
  2193. [<span class="optional"> notify-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  2194. [<span class="optional"> notify-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  2195. [<span class="optional"> notify-to-soa <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  2196. [<span class="optional"> also-notify { <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ;
  2197. [<span class="optional"> <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; ... </span>] }; </span>]
  2198. [<span class="optional"> max-ixfr-log-size <em class="replaceable"><code>number</code></em>; </span>]
  2199. [<span class="optional"> max-journal-size <em class="replaceable"><code>size_spec</code></em>; </span>]
  2200. [<span class="optional"> coresize <em class="replaceable"><code>size_spec</code></em> ; </span>]
  2201. [<span class="optional"> datasize <em class="replaceable"><code>size_spec</code></em> ; </span>]
  2202. [<span class="optional"> files <em class="replaceable"><code>size_spec</code></em> ; </span>]
  2203. [<span class="optional"> stacksize <em class="replaceable"><code>size_spec</code></em> ; </span>]
  2204. [<span class="optional"> cleaning-interval <em class="replaceable"><code>number</code></em>; </span>]
  2205. [<span class="optional"> heartbeat-interval <em class="replaceable"><code>number</code></em>; </span>]
  2206. [<span class="optional"> interface-interval <em class="replaceable"><code>number</code></em>; </span>]
  2207. [<span class="optional"> statistics-interval <em class="replaceable"><code>number</code></em>; </span>]
  2208. [<span class="optional"> topology { <em class="replaceable"><code>address_match_list</code></em> }</span>];
  2209. [<span class="optional"> sortlist { <em class="replaceable"><code>address_match_list</code></em> }</span>];
  2210. [<span class="optional"> rrset-order { <em class="replaceable"><code>order_spec</code></em> ; [<span class="optional"> <em class="replaceable"><code>order_spec</code></em> ; ... </span>] </span>] };
  2211. [<span class="optional"> lame-ttl <em class="replaceable"><code>number</code></em>; </span>]
  2212. [<span class="optional"> max-ncache-ttl <em class="replaceable"><code>number</code></em>; </span>]
  2213. [<span class="optional"> max-cache-ttl <em class="replaceable"><code>number</code></em>; </span>]
  2214. [<span class="optional"> sig-validity-interval <em class="replaceable"><code>number</code></em> [<span class="optional"><em class="replaceable"><code>number</code></em></span>] ; </span>]
  2215. [<span class="optional"> sig-signing-nodes <em class="replaceable"><code>number</code></em> ; </span>]
  2216. [<span class="optional"> sig-signing-signatures <em class="replaceable"><code>number</code></em> ; </span>]
  2217. [<span class="optional"> sig-signing-type <em class="replaceable"><code>number</code></em> ; </span>]
  2218. [<span class="optional"> min-roots <em class="replaceable"><code>number</code></em>; </span>]
  2219. [<span class="optional"> use-ixfr <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  2220. [<span class="optional"> provide-ixfr <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2221. [<span class="optional"> request-ixfr <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2222. [<span class="optional"> treat-cr-as-space <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  2223. [<span class="optional"> min-refresh-time <em class="replaceable"><code>number</code></em> ; </span>]
  2224. [<span class="optional"> max-refresh-time <em class="replaceable"><code>number</code></em> ; </span>]
  2225. [<span class="optional"> min-retry-time <em class="replaceable"><code>number</code></em> ; </span>]
  2226. [<span class="optional"> max-retry-time <em class="replaceable"><code>number</code></em> ; </span>]
  2227. [<span class="optional"> port <em class="replaceable"><code>ip_port</code></em>; </span>]
  2228. [<span class="optional"> additional-from-auth <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  2229. [<span class="optional"> additional-from-cache <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  2230. [<span class="optional"> random-device <em class="replaceable"><code>path_name</code></em> ; </span>]
  2231. [<span class="optional"> max-cache-size <em class="replaceable"><code>size_spec</code></em> ; </span>]
  2232. [<span class="optional"> match-mapped-addresses <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2233. [<span class="optional"> filter-aaaa-on-v4 ( <em class="replaceable"><code>yes_or_no</code></em> | <em class="replaceable"><code>break-dnssec</code></em> ); </span>]
  2234. [<span class="optional"> filter-aaaa { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2235. [<span class="optional"> dns64 <em class="replaceable"><code>IPv6-prefix</code></em> {
  2236. [<span class="optional"> clients { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2237. [<span class="optional"> mapped { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2238. [<span class="optional"> exclude { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  2239. [<span class="optional"> suffix IPv6-address; </span>]
  2240. [<span class="optional"> recursive-only <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2241. [<span class="optional"> break-dnssec <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  2242. }; </span>];
  2243. [<span class="optional"> dns64-server <em class="replaceable"><code>name</code></em> </span>]
  2244. [<span class="optional"> dns64-contact <em class="replaceable"><code>name</code></em> </span>]
  2245. [<span class="optional"> preferred-glue ( <em class="replaceable"><code>A</code></em> | <em class="replaceable"><code>AAAA</code></em> | <em class="replaceable"><code>NONE</code></em> ); </span>]
  2246. [<span class="optional"> edns-udp-size <em class="replaceable"><code>number</code></em>; </span>]
  2247. [<span class="optional"> max-udp-size <em class="replaceable"><code>number</code></em>; </span>]
  2248. [<span class="optional"> root-delegation-only [<span class="optional"> exclude { <em class="replaceable"><code>namelist</code></em> } </span>] ; </span>]
  2249. [<span class="optional"> querylog <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  2250. [<span class="optional"> disable-algorithms <em class="replaceable"><code>domain</code></em> { <em class="replaceable"><code>algorithm</code></em>;
  2251. [<span class="optional"> <em class="replaceable"><code>algorithm</code></em>; </span>] }; </span>]
  2252. [<span class="optional"> acache-enable <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  2253. [<span class="optional"> acache-cleaning-interval <em class="replaceable"><code>number</code></em>; </span>]
  2254. [<span class="optional"> max-acache-size <em class="replaceable"><code>size_spec</code></em> ; </span>]
  2255. [<span class="optional"> clients-per-query <em class="replaceable"><code>number</code></em> ; </span>]
  2256. [<span class="optional"> max-clients-per-query <em class="replaceable"><code>number</code></em> ; </span>]
  2257. [<span class="optional"> masterfile-format (<code class="constant">text</code>|<code class="constant">raw</code>) ; </span>]
  2258. [<span class="optional"> empty-server <em class="replaceable"><code>name</code></em> ; </span>]
  2259. [<span class="optional"> empty-contact <em class="replaceable"><code>name</code></em> ; </span>]
  2260. [<span class="optional"> empty-zones-enable <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  2261. [<span class="optional"> disable-empty-zone <em class="replaceable"><code>zone_name</code></em> ; </span>]
  2262. [<span class="optional"> zero-no-soa-ttl <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  2263. [<span class="optional"> zero-no-soa-ttl-cache <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  2264. [<span class="optional"> resolver-query-timeout <em class="replaceable"><code>number</code></em> ; </span>]
  2265. [<span class="optional"> deny-answer-addresses { <em class="replaceable"><code>address_match_list</code></em> } [<span class="optional"> except-from { <em class="replaceable"><code>namelist</code></em> } </span>];</span>]
  2266. [<span class="optional"> deny-answer-aliases { <em class="replaceable"><code>namelist</code></em> } [<span class="optional"> except-from { <em class="replaceable"><code>namelist</code></em> } </span>];</span>]
  2267. [<span class="optional"> response-policy { <em class="replaceable"><code>zone_name</code></em> [<span class="optional"> policy given | disabled | passthru | nxdomain | nodata | cname <em class="replaceable"><code>domain</code></em> </span>] ; } ; </span>]
  2268. };
  2269. </pre>
  2270. </div>
  2271. <div class="sect2" lang="en">
  2272. <div class="titlepage"><div><div><h3 class="title">
  2273. <a name="options"></a><span><strong class="command">options</strong></span> Statement Definition and
  2274. Usage</h3></div></div></div>
  2275. <p>
  2276. The <span><strong class="command">options</strong></span> statement sets up global
  2277. options
  2278. to be used by <acronym class="acronym">BIND</acronym>. This statement
  2279. may appear only
  2280. once in a configuration file. If there is no <span><strong class="command">options</strong></span>
  2281. statement, an options block with each option set to its default will
  2282. be used.
  2283. </p>
  2284. <div class="variablelist"><dl>
  2285. <dt><span class="term"><span><strong class="command">attach-cache</strong></span></span></dt>
  2286. <dd>
  2287. <p>
  2288. Allows multiple views to share a single cache
  2289. database.
  2290. Each view has its own cache database by default, but
  2291. if multiple views have the same operational policy
  2292. for name resolution and caching, those views can
  2293. share a single cache to save memory and possibly
  2294. improve resolution efficiency by using this option.
  2295. </p>
  2296. <p>
  2297. The <span><strong class="command">attach-cache</strong></span> option
  2298. may also be specified in <span><strong class="command">view</strong></span>
  2299. statements, in which case it overrides the
  2300. global <span><strong class="command">attach-cache</strong></span> option.
  2301. </p>
  2302. <p>
  2303. The <em class="replaceable"><code>cache_name</code></em> specifies
  2304. the cache to be shared.
  2305. When the <span><strong class="command">named</strong></span> server configures
  2306. views which are supposed to share a cache, it
  2307. creates a cache with the specified name for the
  2308. first view of these sharing views.
  2309. The rest of the views will simply refer to the
  2310. already created cache.
  2311. </p>
  2312. <p>
  2313. One common configuration to share a cache would be to
  2314. allow all views to share a single cache.
  2315. This can be done by specifying
  2316. the <span><strong class="command">attach-cache</strong></span> as a global
  2317. option with an arbitrary name.
  2318. </p>
  2319. <p>
  2320. Another possible operation is to allow a subset of
  2321. all views to share a cache while the others to
  2322. retain their own caches.
  2323. For example, if there are three views A, B, and C,
  2324. and only A and B should share a cache, specify the
  2325. <span><strong class="command">attach-cache</strong></span> option as a view A (or
  2326. B)'s option, referring to the other view name:
  2327. </p>
  2328. <pre class="programlisting">
  2329. view "A" {
  2330. // this view has its own cache
  2331. ...
  2332. };
  2333. view "B" {
  2334. // this view refers to A's cache
  2335. attach-cache "A";
  2336. };
  2337. view "C" {
  2338. // this view has its own cache
  2339. ...
  2340. };
  2341. </pre>
  2342. <p>
  2343. Views that share a cache must have the same policy
  2344. on configurable parameters that may affect caching.
  2345. The current implementation requires the following
  2346. configurable options be consistent among these
  2347. views:
  2348. <span><strong class="command">check-names</strong></span>,
  2349. <span><strong class="command">cleaning-interval</strong></span>,
  2350. <span><strong class="command">dnssec-accept-expired</strong></span>,
  2351. <span><strong class="command">dnssec-validation</strong></span>,
  2352. <span><strong class="command">max-cache-ttl</strong></span>,
  2353. <span><strong class="command">max-ncache-ttl</strong></span>,
  2354. <span><strong class="command">max-cache-size</strong></span>, and
  2355. <span><strong class="command">zero-no-soa-ttl</strong></span>.
  2356. </p>
  2357. <p>
  2358. Note that there may be other parameters that may
  2359. cause confusion if they are inconsistent for
  2360. different views that share a single cache.
  2361. For example, if these views define different sets of
  2362. forwarders that can return different answers for the
  2363. same question, sharing the answer does not make
  2364. sense or could even be harmful.
  2365. It is administrator's responsibility to ensure
  2366. configuration differences in different views do
  2367. not cause disruption with a shared cache.
  2368. </p>
  2369. </dd>
  2370. <dt><span class="term"><span><strong class="command">directory</strong></span></span></dt>
  2371. <dd><p>
  2372. The working directory of the server.
  2373. Any non-absolute pathnames in the configuration file will be
  2374. taken
  2375. as relative to this directory. The default location for most
  2376. server
  2377. output files (e.g. <code class="filename">named.run</code>)
  2378. is this directory.
  2379. If a directory is not specified, the working directory
  2380. defaults to `<code class="filename">.</code>', the directory from
  2381. which the server
  2382. was started. The directory specified should be an absolute
  2383. path.
  2384. </p></dd>
  2385. <dt><span class="term"><span><strong class="command">key-directory</strong></span></span></dt>
  2386. <dd><p>
  2387. When performing dynamic update of secure zones, the
  2388. directory where the public and private DNSSEC key files
  2389. should be found, if different than the current working
  2390. directory. (Note that this option has no effect on the
  2391. paths for files containing non-DNSSEC keys such as
  2392. <code class="filename">bind.keys</code>,
  2393. <code class="filename">rndc.key</code> or
  2394. <code class="filename">session.key</code>.)
  2395. </p></dd>
  2396. <dt><span class="term"><span><strong class="command">managed-keys-directory</strong></span></span></dt>
  2397. <dd><p>
  2398. The directory used to hold the files used to track managed keys.
  2399. By default it is the working directory. It there are no
  2400. views then the file <code class="filename">managed-keys.bind</code>
  2401. otherwise a SHA256 hash of the view name is used with
  2402. <code class="filename">.mkeys</code> extension added.
  2403. </p></dd>
  2404. <dt><span class="term"><span><strong class="command">named-xfer</strong></span></span></dt>
  2405. <dd><p>
  2406. <span class="emphasis"><em>This option is obsolete.</em></span> It
  2407. was used in <acronym class="acronym">BIND</acronym> 8 to specify
  2408. the pathname to the <span><strong class="command">named-xfer</strong></span>
  2409. program. In <acronym class="acronym">BIND</acronym> 9, no separate
  2410. <span><strong class="command">named-xfer</strong></span> program is needed;
  2411. its functionality is built into the name server.
  2412. </p></dd>
  2413. <dt><span class="term"><span><strong class="command">tkey-gssapi-keytab</strong></span></span></dt>
  2414. <dd><p>
  2415. The KRB5 keytab file to use for GSS-TSIG updates. If
  2416. this option is set and tkey-gssapi-credential is not
  2417. set, then updates will be allowed with any key
  2418. matching a principal in the specified keytab.
  2419. </p></dd>
  2420. <dt><span class="term"><span><strong class="command">tkey-gssapi-credential</strong></span></span></dt>
  2421. <dd><p>
  2422. The security credential with which the server should
  2423. authenticate keys requested by the GSS-TSIG protocol.
  2424. Currently only Kerberos 5 authentication is available
  2425. and the credential is a Kerberos principal which the
  2426. server can acquire through the default system key
  2427. file, normally <code class="filename">/etc/krb5.keytab</code>.
  2428. The location keytab file can be overridden using the
  2429. tkey-gssapi-keytab option. Normally this principal is
  2430. of the form "<strong class="userinput"><code>DNS/</code></strong><code class="varname">server.domain</code>".
  2431. To use GSS-TSIG, <span><strong class="command">tkey-domain</strong></span> must
  2432. also be set if a specific keytab is not set with
  2433. tkey-gssapi-keytab.
  2434. </p></dd>
  2435. <dt><span class="term"><span><strong class="command">tkey-domain</strong></span></span></dt>
  2436. <dd><p>
  2437. The domain appended to the names of all shared keys
  2438. generated with <span><strong class="command">TKEY</strong></span>. When a
  2439. client requests a <span><strong class="command">TKEY</strong></span> exchange,
  2440. it may or may not specify the desired name for the
  2441. key. If present, the name of the shared key will
  2442. be <code class="varname">client specified part</code> +
  2443. <code class="varname">tkey-domain</code>. Otherwise, the
  2444. name of the shared key will be <code class="varname">random hex
  2445. digits</code> + <code class="varname">tkey-domain</code>.
  2446. In most cases, the <span><strong class="command">domainname</strong></span>
  2447. should be the server's domain name, or an otherwise
  2448. non-existent subdomain like
  2449. "_tkey.<code class="varname">domainname</code>". If you are
  2450. using GSS-TSIG, this variable must be defined, unless
  2451. you specify a specific keytab using tkey-gssapi-keytab.
  2452. </p></dd>
  2453. <dt><span class="term"><span><strong class="command">tkey-dhkey</strong></span></span></dt>
  2454. <dd><p>
  2455. The Diffie-Hellman key used by the server
  2456. to generate shared keys with clients using the Diffie-Hellman
  2457. mode
  2458. of <span><strong class="command">TKEY</strong></span>. The server must be
  2459. able to load the
  2460. public and private keys from files in the working directory.
  2461. In
  2462. most cases, the keyname should be the server's host name.
  2463. </p></dd>
  2464. <dt><span class="term"><span><strong class="command">cache-file</strong></span></span></dt>
  2465. <dd><p>
  2466. This is for testing only. Do not use.
  2467. </p></dd>
  2468. <dt><span class="term"><span><strong class="command">dump-file</strong></span></span></dt>
  2469. <dd><p>
  2470. The pathname of the file the server dumps
  2471. the database to when instructed to do so with
  2472. <span><strong class="command">rndc dumpdb</strong></span>.
  2473. If not specified, the default is <code class="filename">named_dump.db</code>.
  2474. </p></dd>
  2475. <dt><span class="term"><span><strong class="command">memstatistics-file</strong></span></span></dt>
  2476. <dd><p>
  2477. The pathname of the file the server writes memory
  2478. usage statistics to on exit. If not specified,
  2479. the default is <code class="filename">named.memstats</code>.
  2480. </p></dd>
  2481. <dt><span class="term"><span><strong class="command">pid-file</strong></span></span></dt>
  2482. <dd><p>
  2483. The pathname of the file the server writes its process ID
  2484. in. If not specified, the default is
  2485. <code class="filename">/var/run/named/named.pid</code>.
  2486. The PID file is used by programs that want to send signals to
  2487. the running
  2488. name server. Specifying <span><strong class="command">pid-file none</strong></span> disables the
  2489. use of a PID file &#8212; no file will be written and any
  2490. existing one will be removed. Note that <span><strong class="command">none</strong></span>
  2491. is a keyword, not a filename, and therefore is not enclosed
  2492. in
  2493. double quotes.
  2494. </p></dd>
  2495. <dt><span class="term"><span><strong class="command">recursing-file</strong></span></span></dt>
  2496. <dd><p>
  2497. The pathname of the file the server dumps
  2498. the queries that are currently recursing when instructed
  2499. to do so with <span><strong class="command">rndc recursing</strong></span>.
  2500. If not specified, the default is <code class="filename">named.recursing</code>.
  2501. </p></dd>
  2502. <dt><span class="term"><span><strong class="command">statistics-file</strong></span></span></dt>
  2503. <dd><p>
  2504. The pathname of the file the server appends statistics
  2505. to when instructed to do so using <span><strong class="command">rndc stats</strong></span>.
  2506. If not specified, the default is <code class="filename">named.stats</code> in the
  2507. server's current directory. The format of the file is
  2508. described
  2509. in <a href="Bv9ARM.ch06.html#statsfile" title="The Statistics File">the section called &#8220;The Statistics File&#8221;</a>.
  2510. </p></dd>
  2511. <dt><span class="term"><span><strong class="command">bindkeys-file</strong></span></span></dt>
  2512. <dd><p>
  2513. The pathname of a file to override the built-in trusted
  2514. keys provided by <span><strong class="command">named</strong></span>.
  2515. See the discussion of <span><strong class="command">dnssec-lookaside</strong></span>
  2516. and <span><strong class="command">dnssec-validation</strong></span> for details.
  2517. If not specified, the default is
  2518. <code class="filename">/etc/bind.keys</code>.
  2519. </p></dd>
  2520. <dt><span class="term"><span><strong class="command">secroots-file</strong></span></span></dt>
  2521. <dd><p>
  2522. The pathname of the file the server dumps
  2523. security roots to when instructed to do so with
  2524. <span><strong class="command">rndc secroots</strong></span>.
  2525. If not specified, the default is
  2526. <code class="filename">named.secroots</code>.
  2527. </p></dd>
  2528. <dt><span class="term"><span><strong class="command">session-keyfile</strong></span></span></dt>
  2529. <dd><p>
  2530. The pathname of the file into which to write a TSIG
  2531. session key generated by <span><strong class="command">named</strong></span> for use by
  2532. <span><strong class="command">nsupdate -l</strong></span>. If not specified, the
  2533. default is <code class="filename">/var/run/named/session.key</code>.
  2534. (See <a href="Bv9ARM.ch06.html#dynamic_update_policies" title="Dynamic Update Policies">the section called &#8220;Dynamic Update Policies&#8221;</a>, and in
  2535. particular the discussion of the
  2536. <span><strong class="command">update-policy</strong></span> statement's
  2537. <strong class="userinput"><code>local</code></strong> option for more
  2538. information about this feature.)
  2539. </p></dd>
  2540. <dt><span class="term"><span><strong class="command">session-keyname</strong></span></span></dt>
  2541. <dd><p>
  2542. The key name to use for the TSIG session key.
  2543. If not specified, the default is "local-ddns".
  2544. </p></dd>
  2545. <dt><span class="term"><span><strong class="command">session-keyalg</strong></span></span></dt>
  2546. <dd><p>
  2547. The algorithm to use for the TSIG session key.
  2548. Valid values are hmac-sha1, hmac-sha224, hmac-sha256,
  2549. hmac-sha384, hmac-sha512 and hmac-md5. If not
  2550. specified, the default is hmac-sha256.
  2551. </p></dd>
  2552. <dt><span class="term"><span><strong class="command">port</strong></span></span></dt>
  2553. <dd><p>
  2554. The UDP/TCP port number the server uses for
  2555. receiving and sending DNS protocol traffic.
  2556. The default is 53. This option is mainly intended for server
  2557. testing;
  2558. a server using a port other than 53 will not be able to
  2559. communicate with
  2560. the global DNS.
  2561. </p></dd>
  2562. <dt><span class="term"><span><strong class="command">random-device</strong></span></span></dt>
  2563. <dd><p>
  2564. The source of entropy to be used by the server. Entropy is
  2565. primarily needed
  2566. for DNSSEC operations, such as TKEY transactions and dynamic
  2567. update of signed
  2568. zones. This options specifies the device (or file) from which
  2569. to read
  2570. entropy. If this is a file, operations requiring entropy will
  2571. fail when the
  2572. file has been exhausted. If not specified, the default value
  2573. is
  2574. <code class="filename">/dev/random</code>
  2575. (or equivalent) when present, and none otherwise. The
  2576. <span><strong class="command">random-device</strong></span> option takes
  2577. effect during
  2578. the initial configuration load at server startup time and
  2579. is ignored on subsequent reloads.
  2580. </p></dd>
  2581. <dt><span class="term"><span><strong class="command">preferred-glue</strong></span></span></dt>
  2582. <dd><p>
  2583. If specified, the listed type (A or AAAA) will be emitted
  2584. before other glue
  2585. in the additional section of a query response.
  2586. The default is not to prefer any type (NONE).
  2587. </p></dd>
  2588. <dt>
  2589. <a name="root_delegation_only"></a><span class="term"><span><strong class="command">root-delegation-only</strong></span></span>
  2590. </dt>
  2591. <dd>
  2592. <p>
  2593. Turn on enforcement of delegation-only in TLDs
  2594. (top level domains) and root zones with an optional
  2595. exclude list.
  2596. </p>
  2597. <p>
  2598. DS queries are expected to be made to and be answered by
  2599. delegation only zones. Such queries and responses are
  2600. treated as an exception to delegation-only processing
  2601. and are not converted to NXDOMAIN responses provided
  2602. a CNAME is not discovered at the query name.
  2603. </p>
  2604. <p>
  2605. If a delegation only zone server also serves a child
  2606. zone it is not always possible to determine whether
  2607. an answer comes from the delegation only zone or the
  2608. child zone. SOA NS and DNSKEY records are apex
  2609. only records and a matching response that contains
  2610. these records or DS is treated as coming from a
  2611. child zone. RRSIG records are also examined to see
  2612. if they are signed by a child zone or not. The
  2613. authority section is also examined to see if there
  2614. is evidence that the answer is from the child zone.
  2615. Answers that are determined to be from a child zone
  2616. are not converted to NXDOMAIN responses. Despite
  2617. all these checks there is still a possibility of
  2618. false negatives when a child zone is being served.
  2619. </p>
  2620. <p>
  2621. Similarly false positives can arise from empty nodes
  2622. (no records at the name) in the delegation only zone
  2623. when the query type is not ANY.
  2624. </p>
  2625. <p>
  2626. Note some TLDs are not delegation only (e.g. "DE", "LV",
  2627. "US" and "MUSEUM"). This list is not exhaustive.
  2628. </p>
  2629. <pre class="programlisting">
  2630. options {
  2631. root-delegation-only exclude { "de"; "lv"; "us"; "museum"; };
  2632. };
  2633. </pre>
  2634. </dd>
  2635. <dt><span class="term"><span><strong class="command">disable-algorithms</strong></span></span></dt>
  2636. <dd><p>
  2637. Disable the specified DNSSEC algorithms at and below the
  2638. specified name.
  2639. Multiple <span><strong class="command">disable-algorithms</strong></span>
  2640. statements are allowed.
  2641. Only the most specific will be applied.
  2642. </p></dd>
  2643. <dt><span class="term"><span><strong class="command">dnssec-lookaside</strong></span></span></dt>
  2644. <dd>
  2645. <p>
  2646. When set, <span><strong class="command">dnssec-lookaside</strong></span> provides the
  2647. validator with an alternate method to validate DNSKEY
  2648. records at the top of a zone. When a DNSKEY is at or
  2649. below a domain specified by the deepest
  2650. <span><strong class="command">dnssec-lookaside</strong></span>, and the normal DNSSEC
  2651. validation has left the key untrusted, the trust-anchor
  2652. will be appended to the key name and a DLV record will be
  2653. looked up to see if it can validate the key. If the DLV
  2654. record validates a DNSKEY (similarly to the way a DS
  2655. record does) the DNSKEY RRset is deemed to be trusted.
  2656. </p>
  2657. <p>
  2658. If <span><strong class="command">dnssec-lookaside</strong></span> is set to
  2659. <strong class="userinput"><code>auto</code></strong>, then built-in default
  2660. values for the DLV domain and trust anchor will be
  2661. used, along with a built-in key for validation.
  2662. </p>
  2663. <p>
  2664. If <span><strong class="command">dnssec-lookaside</strong></span> is set to
  2665. <strong class="userinput"><code>no</code></strong>, then dnssec-lookaside
  2666. is not used.
  2667. </p>
  2668. <p>
  2669. The default DLV key is stored in the file
  2670. <code class="filename">bind.keys</code>;
  2671. <span><strong class="command">named</strong></span> will load that key at
  2672. startup if <span><strong class="command">dnssec-lookaside</strong></span> is set to
  2673. <code class="constant">auto</code>. A copy of the file is
  2674. installed along with <acronym class="acronym">BIND</acronym> 9, and is
  2675. current as of the release date. If the DLV key expires, a
  2676. new copy of <code class="filename">bind.keys</code> can be downloaded
  2677. from <a href="" target="_top">https://www.isc.org/solutions/dlv</a>.
  2678. </p>
  2679. <p>
  2680. (To prevent problems if <code class="filename">bind.keys</code> is
  2681. not found, the current key is also compiled in to
  2682. <span><strong class="command">named</strong></span>. Relying on this is not
  2683. recommended, however, as it requires <span><strong class="command">named</strong></span>
  2684. to be recompiled with a new key when the DLV key expires.)
  2685. </p>
  2686. <p>
  2687. NOTE: <span><strong class="command">named</strong></span> only loads certain specific
  2688. keys from <code class="filename">bind.keys</code>: those for the
  2689. DLV zone and for the DNS root zone. The file cannot be
  2690. used to store keys for other zones.
  2691. </p>
  2692. </dd>
  2693. <dt><span class="term"><span><strong class="command">dnssec-must-be-secure</strong></span></span></dt>
  2694. <dd><p>
  2695. Specify hierarchies which must be or may not be secure
  2696. (signed and validated). If <strong class="userinput"><code>yes</code></strong>,
  2697. then <span><strong class="command">named</strong></span> will only accept answers if
  2698. they are secure. If <strong class="userinput"><code>no</code></strong>, then normal
  2699. DNSSEC validation applies allowing for insecure answers to
  2700. be accepted. The specified domain must be under a
  2701. <span><strong class="command">trusted-keys</strong></span> or
  2702. <span><strong class="command">managed-keys</strong></span> statement, or
  2703. <span><strong class="command">dnssec-lookaside</strong></span> must be active.
  2704. </p></dd>
  2705. <dt><span class="term"><span><strong class="command">dns64</strong></span></span></dt>
  2706. <dd>
  2707. <p>
  2708. This directive instructs <span><strong class="command">named</strong></span> to
  2709. return mapped IPv4 addresses to AAAA queries when
  2710. there are no AAAA records. It is intended to be
  2711. used in conjunction with a NAT64. Each
  2712. <span><strong class="command">dns64</strong></span> defines one DNS64 prefix.
  2713. Multiple DNS64 prefixes can be defined.
  2714. </p>
  2715. <p>
  2716. Compatible IPv6 prefixes have lengths of 32, 40, 48, 56,
  2717. 64 and 96 as per RFC 6052.
  2718. </p>
  2719. <p>
  2720. Additionally a reverse IP6.ARPA zone will be created for
  2721. the prefix to provide a mapping from the IP6.ARPA names
  2722. to the corresponding IN-ADDR.ARPA names using synthesized
  2723. CNAMEs. <span><strong class="command">dns64-server</strong></span> and
  2724. <span><strong class="command">dns64-contact</strong></span> can be used to specify
  2725. the name of the server and contact for the zones. These
  2726. are settable at the view / options level. These are
  2727. not settable on a per-prefix basis.
  2728. </p>
  2729. <p>
  2730. Each <span><strong class="command">dns64</strong></span> supports an optional
  2731. <span><strong class="command">clients</strong></span> ACL that determines which
  2732. clients are affected by this directive. If not defined,
  2733. it defaults to <strong class="userinput"><code>any;</code></strong>.
  2734. </p>
  2735. <p>
  2736. Each <span><strong class="command">dns64</strong></span> supports an optional
  2737. <span><strong class="command">mapped</strong></span> ACL that selects which
  2738. IPv4 addresses are to be mapped in the corresponding
  2739. A RRset. If not defined it defaults to
  2740. <strong class="userinput"><code>any;</code></strong>.
  2741. </p>
  2742. <p>
  2743. Normally, DNS64 won't apply to a domain name that
  2744. owns one or more AAAA records; these records will
  2745. simply be returned. The optional
  2746. <span><strong class="command">exclude</strong></span> ACL allows specification
  2747. of a list of IPv6 addresses that will be ignored
  2748. if they appear in a domain name's AAAA records, and
  2749. DNS64 will be applied to any A records the domain
  2750. name owns. If not defined, <span><strong class="command">exclude</strong></span>
  2751. defaults to none.
  2752. </p>
  2753. <p>
  2754. A optional <span><strong class="command">suffix</strong></span> can also
  2755. be defined to set the bits trailing the mapped
  2756. IPv4 address bits. By default these bits are
  2757. set to <strong class="userinput"><code>::</code></strong>. The bits
  2758. matching the prefix and mapped IPv4 address
  2759. must be zero.
  2760. </p>
  2761. <p>
  2762. If <span><strong class="command">recursive-only</strong></span> is set to
  2763. <span><strong class="command">yes</strong></span> the DNS64 synthesis will
  2764. only happen for recursive queries. The default
  2765. is <span><strong class="command">no</strong></span>.
  2766. </p>
  2767. <p>
  2768. If <span><strong class="command">break-dnssec</strong></span> is set to
  2769. <span><strong class="command">yes</strong></span> the DNS64 synthesis will
  2770. happen even if the result, if validated, would
  2771. cause a DNSSEC validation failure. If this option
  2772. is set to <span><strong class="command">no</strong></span> (the default), the DO
  2773. is set on the incoming query, and there are RRSIGs on
  2774. the applicable records, then synthesis will not happen.
  2775. </p>
  2776. <pre class="programlisting">
  2777. acl rfc1918 { 10/8; 192.168/16; 172.16/12; };
  2778. dns64 64:FF9B::/96 {
  2779. clients { any; };
  2780. mapped { !rfc1918; any; };
  2781. exclude { 64:FF9B::/96; ::ffff:0000:0000/96; };
  2782. suffix ::;
  2783. };
  2784. </pre>
  2785. </dd>
  2786. </dl></div>
  2787. <div class="sect3" lang="en">
  2788. <div class="titlepage"><div><div><h4 class="title">
  2789. <a name="boolean_options"></a>Boolean Options</h4></div></div></div>
  2790. <div class="variablelist"><dl>
  2791. <dt><span class="term"><span><strong class="command">allow-new-zones</strong></span></span></dt>
  2792. <dd><p>
  2793. If <strong class="userinput"><code>yes</code></strong>, then zones can be
  2794. added at runtime via <span><strong class="command">rndc addzone</strong></span>
  2795. or deleted via <span><strong class="command">rndc delzone</strong></span>.
  2796. The default is <strong class="userinput"><code>no</code></strong>.
  2797. </p></dd>
  2798. <dt><span class="term"><span><strong class="command">auth-nxdomain</strong></span></span></dt>
  2799. <dd><p>
  2800. If <strong class="userinput"><code>yes</code></strong>, then the <span><strong class="command">AA</strong></span> bit
  2801. is always set on NXDOMAIN responses, even if the server is
  2802. not actually
  2803. authoritative. The default is <strong class="userinput"><code>no</code></strong>;
  2804. this is
  2805. a change from <acronym class="acronym">BIND</acronym> 8. If you
  2806. are using very old DNS software, you
  2807. may need to set it to <strong class="userinput"><code>yes</code></strong>.
  2808. </p></dd>
  2809. <dt><span class="term"><span><strong class="command">deallocate-on-exit</strong></span></span></dt>
  2810. <dd><p>
  2811. This option was used in <acronym class="acronym">BIND</acronym>
  2812. 8 to enable checking
  2813. for memory leaks on exit. <acronym class="acronym">BIND</acronym> 9 ignores the option and always performs
  2814. the checks.
  2815. </p></dd>
  2816. <dt><span class="term"><span><strong class="command">memstatistics</strong></span></span></dt>
  2817. <dd><p>
  2818. Write memory statistics to the file specified by
  2819. <span><strong class="command">memstatistics-file</strong></span> at exit.
  2820. The default is <strong class="userinput"><code>no</code></strong> unless
  2821. '-m record' is specified on the command line in
  2822. which case it is <strong class="userinput"><code>yes</code></strong>.
  2823. </p></dd>
  2824. <dt><span class="term"><span><strong class="command">dialup</strong></span></span></dt>
  2825. <dd>
  2826. <p>
  2827. If <strong class="userinput"><code>yes</code></strong>, then the
  2828. server treats all zones as if they are doing zone transfers
  2829. across
  2830. a dial-on-demand dialup link, which can be brought up by
  2831. traffic
  2832. originating from this server. This has different effects
  2833. according
  2834. to zone type and concentrates the zone maintenance so that
  2835. it all
  2836. happens in a short interval, once every <span><strong class="command">heartbeat-interval</strong></span> and
  2837. hopefully during the one call. It also suppresses some of
  2838. the normal
  2839. zone maintenance traffic. The default is <strong class="userinput"><code>no</code></strong>.
  2840. </p>
  2841. <p>
  2842. The <span><strong class="command">dialup</strong></span> option
  2843. may also be specified in the <span><strong class="command">view</strong></span> and
  2844. <span><strong class="command">zone</strong></span> statements,
  2845. in which case it overrides the global <span><strong class="command">dialup</strong></span>
  2846. option.
  2847. </p>
  2848. <p>
  2849. If the zone is a master zone, then the server will send out a
  2850. NOTIFY
  2851. request to all the slaves (default). This should trigger the
  2852. zone serial
  2853. number check in the slave (providing it supports NOTIFY)
  2854. allowing the slave
  2855. to verify the zone while the connection is active.
  2856. The set of servers to which NOTIFY is sent can be controlled
  2857. by
  2858. <span><strong class="command">notify</strong></span> and <span><strong class="command">also-notify</strong></span>.
  2859. </p>
  2860. <p>
  2861. If the
  2862. zone is a slave or stub zone, then the server will suppress
  2863. the regular
  2864. "zone up to date" (refresh) queries and only perform them
  2865. when the
  2866. <span><strong class="command">heartbeat-interval</strong></span> expires in
  2867. addition to sending
  2868. NOTIFY requests.
  2869. </p>
  2870. <p>
  2871. Finer control can be achieved by using
  2872. <strong class="userinput"><code>notify</code></strong> which only sends NOTIFY
  2873. messages,
  2874. <strong class="userinput"><code>notify-passive</code></strong> which sends NOTIFY
  2875. messages and
  2876. suppresses the normal refresh queries, <strong class="userinput"><code>refresh</code></strong>
  2877. which suppresses normal refresh processing and sends refresh
  2878. queries
  2879. when the <span><strong class="command">heartbeat-interval</strong></span>
  2880. expires, and
  2881. <strong class="userinput"><code>passive</code></strong> which just disables normal
  2882. refresh
  2883. processing.
  2884. </p>
  2885. <div class="informaltable"><table border="1">
  2886. <colgroup>
  2887. <col>
  2888. <col>
  2889. <col>
  2890. <col>
  2891. </colgroup>
  2892. <tbody>
  2893. <tr>
  2894. <td>
  2895. <p>
  2896. dialup mode
  2897. </p>
  2898. </td>
  2899. <td>
  2900. <p>
  2901. normal refresh
  2902. </p>
  2903. </td>
  2904. <td>
  2905. <p>
  2906. heart-beat refresh
  2907. </p>
  2908. </td>
  2909. <td>
  2910. <p>
  2911. heart-beat notify
  2912. </p>
  2913. </td>
  2914. </tr>
  2915. <tr>
  2916. <td>
  2917. <p><span><strong class="command">no</strong></span> (default)</p>
  2918. </td>
  2919. <td>
  2920. <p>
  2921. yes
  2922. </p>
  2923. </td>
  2924. <td>
  2925. <p>
  2926. no
  2927. </p>
  2928. </td>
  2929. <td>
  2930. <p>
  2931. no
  2932. </p>
  2933. </td>
  2934. </tr>
  2935. <tr>
  2936. <td>
  2937. <p><span><strong class="command">yes</strong></span></p>
  2938. </td>
  2939. <td>
  2940. <p>
  2941. no
  2942. </p>
  2943. </td>
  2944. <td>
  2945. <p>
  2946. yes
  2947. </p>
  2948. </td>
  2949. <td>
  2950. <p>
  2951. yes
  2952. </p>
  2953. </td>
  2954. </tr>
  2955. <tr>
  2956. <td>
  2957. <p><span><strong class="command">notify</strong></span></p>
  2958. </td>
  2959. <td>
  2960. <p>
  2961. yes
  2962. </p>
  2963. </td>
  2964. <td>
  2965. <p>
  2966. no
  2967. </p>
  2968. </td>
  2969. <td>
  2970. <p>
  2971. yes
  2972. </p>
  2973. </td>
  2974. </tr>
  2975. <tr>
  2976. <td>
  2977. <p><span><strong class="command">refresh</strong></span></p>
  2978. </td>
  2979. <td>
  2980. <p>
  2981. no
  2982. </p>
  2983. </td>
  2984. <td>
  2985. <p>
  2986. yes
  2987. </p>
  2988. </td>
  2989. <td>
  2990. <p>
  2991. no
  2992. </p>
  2993. </td>
  2994. </tr>
  2995. <tr>
  2996. <td>
  2997. <p><span><strong class="command">passive</strong></span></p>
  2998. </td>
  2999. <td>
  3000. <p>
  3001. no
  3002. </p>
  3003. </td>
  3004. <td>
  3005. <p>
  3006. no
  3007. </p>
  3008. </td>
  3009. <td>
  3010. <p>
  3011. no
  3012. </p>
  3013. </td>
  3014. </tr>
  3015. <tr>
  3016. <td>
  3017. <p><span><strong class="command">notify-passive</strong></span></p>
  3018. </td>
  3019. <td>
  3020. <p>
  3021. no
  3022. </p>
  3023. </td>
  3024. <td>
  3025. <p>
  3026. no
  3027. </p>
  3028. </td>
  3029. <td>
  3030. <p>
  3031. yes
  3032. </p>
  3033. </td>
  3034. </tr>
  3035. </tbody>
  3036. </table></div>
  3037. <p>
  3038. Note that normal NOTIFY processing is not affected by
  3039. <span><strong class="command">dialup</strong></span>.
  3040. </p>
  3041. </dd>
  3042. <dt><span class="term"><span><strong class="command">fake-iquery</strong></span></span></dt>
  3043. <dd><p>
  3044. In <acronym class="acronym">BIND</acronym> 8, this option
  3045. enabled simulating the obsolete DNS query type
  3046. IQUERY. <acronym class="acronym">BIND</acronym> 9 never does
  3047. IQUERY simulation.
  3048. </p></dd>
  3049. <dt><span class="term"><span><strong class="command">fetch-glue</strong></span></span></dt>
  3050. <dd><p>
  3051. This option is obsolete.
  3052. In BIND 8, <strong class="userinput"><code>fetch-glue yes</code></strong>
  3053. caused the server to attempt to fetch glue resource records
  3054. it
  3055. didn't have when constructing the additional
  3056. data section of a response. This is now considered a bad
  3057. idea
  3058. and BIND 9 never does it.
  3059. </p></dd>
  3060. <dt><span class="term"><span><strong class="command">flush-zones-on-shutdown</strong></span></span></dt>
  3061. <dd><p>
  3062. When the nameserver exits due receiving SIGTERM,
  3063. flush or do not flush any pending zone writes. The default
  3064. is
  3065. <span><strong class="command">flush-zones-on-shutdown</strong></span> <strong class="userinput"><code>no</code></strong>.
  3066. </p></dd>
  3067. <dt><span class="term"><span><strong class="command">has-old-clients</strong></span></span></dt>
  3068. <dd><p>
  3069. This option was incorrectly implemented
  3070. in <acronym class="acronym">BIND</acronym> 8, and is ignored by <acronym class="acronym">BIND</acronym> 9.
  3071. To achieve the intended effect
  3072. of
  3073. <span><strong class="command">has-old-clients</strong></span> <strong class="userinput"><code>yes</code></strong>, specify
  3074. the two separate options <span><strong class="command">auth-nxdomain</strong></span> <strong class="userinput"><code>yes</code></strong>
  3075. and <span><strong class="command">rfc2308-type1</strong></span> <strong class="userinput"><code>no</code></strong> instead.
  3076. </p></dd>
  3077. <dt><span class="term"><span><strong class="command">host-statistics</strong></span></span></dt>
  3078. <dd><p>
  3079. In BIND 8, this enables keeping of
  3080. statistics for every host that the name server interacts
  3081. with.
  3082. Not implemented in BIND 9.
  3083. </p></dd>
  3084. <dt><span class="term"><span><strong class="command">maintain-ixfr-base</strong></span></span></dt>
  3085. <dd><p>
  3086. <span class="emphasis"><em>This option is obsolete</em></span>.
  3087. It was used in <acronym class="acronym">BIND</acronym> 8 to
  3088. determine whether a transaction log was
  3089. kept for Incremental Zone Transfer. <acronym class="acronym">BIND</acronym> 9 maintains a transaction
  3090. log whenever possible. If you need to disable outgoing
  3091. incremental zone
  3092. transfers, use <span><strong class="command">provide-ixfr</strong></span> <strong class="userinput"><code>no</code></strong>.
  3093. </p></dd>
  3094. <dt><span class="term"><span><strong class="command">minimal-responses</strong></span></span></dt>
  3095. <dd><p>
  3096. If <strong class="userinput"><code>yes</code></strong>, then when generating
  3097. responses the server will only add records to the authority
  3098. and additional data sections when they are required (e.g.
  3099. delegations, negative responses). This may improve the
  3100. performance of the server.
  3101. The default is <strong class="userinput"><code>no</code></strong>.
  3102. </p></dd>
  3103. <dt><span class="term"><span><strong class="command">multiple-cnames</strong></span></span></dt>
  3104. <dd><p>
  3105. This option was used in <acronym class="acronym">BIND</acronym> 8 to allow
  3106. a domain name to have multiple CNAME records in violation of
  3107. the DNS standards. <acronym class="acronym">BIND</acronym> 9.2 onwards
  3108. always strictly enforces the CNAME rules both in master
  3109. files and dynamic updates.
  3110. </p></dd>
  3111. <dt><span class="term"><span><strong class="command">notify</strong></span></span></dt>
  3112. <dd>
  3113. <p>
  3114. If <strong class="userinput"><code>yes</code></strong> (the default),
  3115. DNS NOTIFY messages are sent when a zone the server is
  3116. authoritative for
  3117. changes, see <a href="Bv9ARM.ch04.html#notify" title="Notify">the section called &#8220;Notify&#8221;</a>. The messages are
  3118. sent to the
  3119. servers listed in the zone's NS records (except the master
  3120. server identified
  3121. in the SOA MNAME field), and to any servers listed in the
  3122. <span><strong class="command">also-notify</strong></span> option.
  3123. </p>
  3124. <p>
  3125. If <strong class="userinput"><code>master-only</code></strong>, notifies are only
  3126. sent
  3127. for master zones.
  3128. If <strong class="userinput"><code>explicit</code></strong>, notifies are sent only
  3129. to
  3130. servers explicitly listed using <span><strong class="command">also-notify</strong></span>.
  3131. If <strong class="userinput"><code>no</code></strong>, no notifies are sent.
  3132. </p>
  3133. <p>
  3134. The <span><strong class="command">notify</strong></span> option may also be
  3135. specified in the <span><strong class="command">zone</strong></span>
  3136. statement,
  3137. in which case it overrides the <span><strong class="command">options notify</strong></span> statement.
  3138. It would only be necessary to turn off this option if it
  3139. caused slaves
  3140. to crash.
  3141. </p>
  3142. </dd>
  3143. <dt><span class="term"><span><strong class="command">notify-to-soa</strong></span></span></dt>
  3144. <dd><p>
  3145. If <strong class="userinput"><code>yes</code></strong> do not check the nameservers
  3146. in the NS RRset against the SOA MNAME. Normally a NOTIFY
  3147. message is not sent to the SOA MNAME (SOA ORIGIN) as it is
  3148. supposed to contain the name of the ultimate master.
  3149. Sometimes, however, a slave is listed as the SOA MNAME in
  3150. hidden master configurations and in that case you would
  3151. want the ultimate master to still send NOTIFY messages to
  3152. all the nameservers listed in the NS RRset.
  3153. </p></dd>
  3154. <dt><span class="term"><span><strong class="command">recursion</strong></span></span></dt>
  3155. <dd><p>
  3156. If <strong class="userinput"><code>yes</code></strong>, and a
  3157. DNS query requests recursion, then the server will attempt
  3158. to do
  3159. all the work required to answer the query. If recursion is
  3160. off
  3161. and the server does not already know the answer, it will
  3162. return a
  3163. referral response. The default is
  3164. <strong class="userinput"><code>yes</code></strong>.
  3165. Note that setting <span><strong class="command">recursion no</strong></span> does not prevent
  3166. clients from getting data from the server's cache; it only
  3167. prevents new data from being cached as an effect of client
  3168. queries.
  3169. Caching may still occur as an effect the server's internal
  3170. operation, such as NOTIFY address lookups.
  3171. See also <span><strong class="command">fetch-glue</strong></span> above.
  3172. </p></dd>
  3173. <dt><span class="term"><span><strong class="command">rfc2308-type1</strong></span></span></dt>
  3174. <dd>
  3175. <p>
  3176. Setting this to <strong class="userinput"><code>yes</code></strong> will
  3177. cause the server to send NS records along with the SOA
  3178. record for negative
  3179. answers. The default is <strong class="userinput"><code>no</code></strong>.
  3180. </p>
  3181. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  3182. <h3 class="title">Note</h3>
  3183. <p>
  3184. Not yet implemented in <acronym class="acronym">BIND</acronym>
  3185. 9.
  3186. </p>
  3187. </div>
  3188. </dd>
  3189. <dt><span class="term"><span><strong class="command">use-id-pool</strong></span></span></dt>
  3190. <dd><p>
  3191. <span class="emphasis"><em>This option is obsolete</em></span>.
  3192. <acronym class="acronym">BIND</acronym> 9 always allocates query
  3193. IDs from a pool.
  3194. </p></dd>
  3195. <dt><span class="term"><span><strong class="command">zone-statistics</strong></span></span></dt>
  3196. <dd><p>
  3197. If <strong class="userinput"><code>yes</code></strong>, the server will collect
  3198. statistical data on all zones (unless specifically turned
  3199. off
  3200. on a per-zone basis by specifying <span><strong class="command">zone-statistics no</strong></span>
  3201. in the <span><strong class="command">zone</strong></span> statement).
  3202. The default is <strong class="userinput"><code>no</code></strong>.
  3203. These statistics may be accessed
  3204. using <span><strong class="command">rndc stats</strong></span>, which will
  3205. dump them to the file listed
  3206. in the <span><strong class="command">statistics-file</strong></span>. See
  3207. also <a href="Bv9ARM.ch06.html#statsfile" title="The Statistics File">the section called &#8220;The Statistics File&#8221;</a>.
  3208. </p></dd>
  3209. <dt><span class="term"><span><strong class="command">use-ixfr</strong></span></span></dt>
  3210. <dd><p>
  3211. <span class="emphasis"><em>This option is obsolete</em></span>.
  3212. If you need to disable IXFR to a particular server or
  3213. servers, see
  3214. the information on the <span><strong class="command">provide-ixfr</strong></span> option
  3215. in <a href="Bv9ARM.ch06.html#server_statement_definition_and_usage" title="server Statement Definition and
  3216. Usage">the section called &#8220;<span><strong class="command">server</strong></span> Statement Definition and
  3217. Usage&#8221;</a>.
  3218. See also
  3219. <a href="Bv9ARM.ch04.html#incremental_zone_transfers" title="Incremental Zone Transfers (IXFR)">the section called &#8220;Incremental Zone Transfers (IXFR)&#8221;</a>.
  3220. </p></dd>
  3221. <dt><span class="term"><span><strong class="command">provide-ixfr</strong></span></span></dt>
  3222. <dd><p>
  3223. See the description of
  3224. <span><strong class="command">provide-ixfr</strong></span> in
  3225. <a href="Bv9ARM.ch06.html#server_statement_definition_and_usage" title="server Statement Definition and
  3226. Usage">the section called &#8220;<span><strong class="command">server</strong></span> Statement Definition and
  3227. Usage&#8221;</a>.
  3228. </p></dd>
  3229. <dt><span class="term"><span><strong class="command">request-ixfr</strong></span></span></dt>
  3230. <dd><p>
  3231. See the description of
  3232. <span><strong class="command">request-ixfr</strong></span> in
  3233. <a href="Bv9ARM.ch06.html#server_statement_definition_and_usage" title="server Statement Definition and
  3234. Usage">the section called &#8220;<span><strong class="command">server</strong></span> Statement Definition and
  3235. Usage&#8221;</a>.
  3236. </p></dd>
  3237. <dt><span class="term"><span><strong class="command">treat-cr-as-space</strong></span></span></dt>
  3238. <dd><p>
  3239. This option was used in <acronym class="acronym">BIND</acronym>
  3240. 8 to make
  3241. the server treat carriage return ("<span><strong class="command">\r</strong></span>") characters the same way
  3242. as a space or tab character,
  3243. to facilitate loading of zone files on a UNIX system that
  3244. were generated
  3245. on an NT or DOS machine. In <acronym class="acronym">BIND</acronym> 9, both UNIX "<span><strong class="command">\n</strong></span>"
  3246. and NT/DOS "<span><strong class="command">\r\n</strong></span>" newlines
  3247. are always accepted,
  3248. and the option is ignored.
  3249. </p></dd>
  3250. <dt>
  3251. <span class="term"><span><strong class="command">additional-from-auth</strong></span>, </span><span class="term"><span><strong class="command">additional-from-cache</strong></span></span>
  3252. </dt>
  3253. <dd>
  3254. <p>
  3255. These options control the behavior of an authoritative
  3256. server when
  3257. answering queries which have additional data, or when
  3258. following CNAME
  3259. and DNAME chains.
  3260. </p>
  3261. <p>
  3262. When both of these options are set to <strong class="userinput"><code>yes</code></strong>
  3263. (the default) and a
  3264. query is being answered from authoritative data (a zone
  3265. configured into the server), the additional data section of
  3266. the
  3267. reply will be filled in using data from other authoritative
  3268. zones
  3269. and from the cache. In some situations this is undesirable,
  3270. such
  3271. as when there is concern over the correctness of the cache,
  3272. or
  3273. in servers where slave zones may be added and modified by
  3274. untrusted third parties. Also, avoiding
  3275. the search for this additional data will speed up server
  3276. operations
  3277. at the possible expense of additional queries to resolve
  3278. what would
  3279. otherwise be provided in the additional section.
  3280. </p>
  3281. <p>
  3282. For example, if a query asks for an MX record for host <code class="literal">foo.example.com</code>,
  3283. and the record found is "<code class="literal">MX 10 mail.example.net</code>", normally the address
  3284. records (A and AAAA) for <code class="literal">mail.example.net</code> will be provided as well,
  3285. if known, even though they are not in the example.com zone.
  3286. Setting these options to <span><strong class="command">no</strong></span>
  3287. disables this behavior and makes
  3288. the server only search for additional data in the zone it
  3289. answers from.
  3290. </p>
  3291. <p>
  3292. These options are intended for use in authoritative-only
  3293. servers, or in authoritative-only views. Attempts to set
  3294. them to <span><strong class="command">no</strong></span> without also
  3295. specifying
  3296. <span><strong class="command">recursion no</strong></span> will cause the
  3297. server to
  3298. ignore the options and log a warning message.
  3299. </p>
  3300. <p>
  3301. Specifying <span><strong class="command">additional-from-cache no</strong></span> actually
  3302. disables the use of the cache not only for additional data
  3303. lookups
  3304. but also when looking up the answer. This is usually the
  3305. desired
  3306. behavior in an authoritative-only server where the
  3307. correctness of
  3308. the cached data is an issue.
  3309. </p>
  3310. <p>
  3311. When a name server is non-recursively queried for a name
  3312. that is not
  3313. below the apex of any served zone, it normally answers with
  3314. an
  3315. "upwards referral" to the root servers or the servers of
  3316. some other
  3317. known parent of the query name. Since the data in an
  3318. upwards referral
  3319. comes from the cache, the server will not be able to provide
  3320. upwards
  3321. referrals when <span><strong class="command">additional-from-cache no</strong></span>
  3322. has been specified. Instead, it will respond to such
  3323. queries
  3324. with REFUSED. This should not cause any problems since
  3325. upwards referrals are not required for the resolution
  3326. process.
  3327. </p>
  3328. </dd>
  3329. <dt><span class="term"><span><strong class="command">match-mapped-addresses</strong></span></span></dt>
  3330. <dd>
  3331. <p>
  3332. If <strong class="userinput"><code>yes</code></strong>, then an
  3333. IPv4-mapped IPv6 address will match any address match
  3334. list entries that match the corresponding IPv4 address.
  3335. </p>
  3336. <p>
  3337. This option was introduced to work around a kernel quirk
  3338. in some operating systems that causes IPv4 TCP
  3339. connections, such as zone transfers, to be accepted on an
  3340. IPv6 socket using mapped addresses. This caused address
  3341. match lists designed for IPv4 to fail to match. However,
  3342. <span><strong class="command">named</strong></span> now solves this problem
  3343. internally. The use of this option is discouraged.
  3344. </p>
  3345. </dd>
  3346. <dt><span class="term"><span><strong class="command">filter-aaaa-on-v4</strong></span></span></dt>
  3347. <dd>
  3348. <p>
  3349. This option is only available when
  3350. <acronym class="acronym">BIND</acronym> 9 is compiled with the
  3351. <strong class="userinput"><code>--enable-filter-aaaa</code></strong> option on the
  3352. "configure" command line. It is intended to help the
  3353. transition from IPv4 to IPv6 by not giving IPv6 addresses
  3354. to DNS clients unless they have connections to the IPv6
  3355. Internet. This is not recommended unless absolutely
  3356. necessary. The default is <strong class="userinput"><code>no</code></strong>.
  3357. The <span><strong class="command">filter-aaaa-on-v4</strong></span> option
  3358. may also be specified in <span><strong class="command">view</strong></span> statements
  3359. to override the global <span><strong class="command">filter-aaaa-on-v4</strong></span>
  3360. option.
  3361. </p>
  3362. <p>
  3363. If <strong class="userinput"><code>yes</code></strong>,
  3364. the DNS client is at an IPv4 address, in <span><strong class="command">filter-aaaa</strong></span>,
  3365. and if the response does not include DNSSEC signatures,
  3366. then all AAAA records are deleted from the response.
  3367. This filtering applies to all responses and not only
  3368. authoritative responses.
  3369. </p>
  3370. <p>
  3371. If <strong class="userinput"><code>break-dnssec</code></strong>,
  3372. then AAAA records are deleted even when dnssec is enabled.
  3373. As suggested by the name, this makes the response not verify,
  3374. because the DNSSEC protocol is designed detect deletions.
  3375. </p>
  3376. <p>
  3377. This mechanism can erroneously cause other servers to
  3378. not give AAAA records to their clients.
  3379. A recursing server with both IPv6 and IPv4 network connections
  3380. that queries an authoritative server using this mechanism
  3381. via IPv4 will be denied AAAA records even if its client is
  3382. using IPv6.
  3383. </p>
  3384. <p>
  3385. This mechanism is applied to authoritative as well as
  3386. non-authoritative records.
  3387. A client using IPv4 that is not allowed recursion can
  3388. erroneously be given AAAA records because the server is not
  3389. allowed to check for A records.
  3390. </p>
  3391. <p>
  3392. Some AAAA records are given to IPv4 clients in glue records.
  3393. IPv4 clients that are servers can then erroneously
  3394. answer requests for AAAA records received via IPv4.
  3395. </p>
  3396. </dd>
  3397. <dt><span class="term"><span><strong class="command">ixfr-from-differences</strong></span></span></dt>
  3398. <dd>
  3399. <p>
  3400. When <strong class="userinput"><code>yes</code></strong> and the server loads a new version of a master
  3401. zone from its zone file or receives a new version of a slave
  3402. file by a non-incremental zone transfer, it will compare
  3403. the new version to the previous one and calculate a set
  3404. of differences. The differences are then logged in the
  3405. zone's journal file such that the changes can be transmitted
  3406. to downstream slaves as an incremental zone transfer.
  3407. </p>
  3408. <p>
  3409. By allowing incremental zone transfers to be used for
  3410. non-dynamic zones, this option saves bandwidth at the
  3411. expense of increased CPU and memory consumption at the
  3412. master.
  3413. In particular, if the new version of a zone is completely
  3414. different from the previous one, the set of differences
  3415. will be of a size comparable to the combined size of the
  3416. old and new zone version, and the server will need to
  3417. temporarily allocate memory to hold this complete
  3418. difference set.
  3419. </p>
  3420. <p><span><strong class="command">ixfr-from-differences</strong></span>
  3421. also accepts <span><strong class="command">master</strong></span> and
  3422. <span><strong class="command">slave</strong></span> at the view and options
  3423. levels which causes
  3424. <span><strong class="command">ixfr-from-differences</strong></span> to be enabled for
  3425. all <span><strong class="command">master</strong></span> or
  3426. <span><strong class="command">slave</strong></span> zones respectively.
  3427. It is off by default.
  3428. </p>
  3429. </dd>
  3430. <dt><span class="term"><span><strong class="command">multi-master</strong></span></span></dt>
  3431. <dd><p>
  3432. This should be set when you have multiple masters for a zone
  3433. and the
  3434. addresses refer to different machines. If <strong class="userinput"><code>yes</code></strong>, <span><strong class="command">named</strong></span> will
  3435. not log
  3436. when the serial number on the master is less than what <span><strong class="command">named</strong></span>
  3437. currently
  3438. has. The default is <strong class="userinput"><code>no</code></strong>.
  3439. </p></dd>
  3440. <dt><span class="term"><span><strong class="command">dnssec-enable</strong></span></span></dt>
  3441. <dd><p>
  3442. Enable DNSSEC support in <span><strong class="command">named</strong></span>. Unless set to <strong class="userinput"><code>yes</code></strong>,
  3443. <span><strong class="command">named</strong></span> behaves as if it does not support DNSSEC.
  3444. The default is <strong class="userinput"><code>yes</code></strong>.
  3445. </p></dd>
  3446. <dt><span class="term"><span><strong class="command">dnssec-validation</strong></span></span></dt>
  3447. <dd><p>
  3448. Enable DNSSEC validation in <span><strong class="command">named</strong></span>.
  3449. Note <span><strong class="command">dnssec-enable</strong></span> also needs to be
  3450. set to <strong class="userinput"><code>yes</code></strong> to be effective.
  3451. If set to <strong class="userinput"><code>no</code></strong>, DNSSEC validation
  3452. is disabled. If set to <strong class="userinput"><code>auto</code></strong>,
  3453. DNSSEC validation is enabled, and a default
  3454. trust-anchor for the DNS root zone is used. If set to
  3455. <strong class="userinput"><code>yes</code></strong>, DNSSEC validation is enabled,
  3456. but a trust anchor must be manually configured using
  3457. a <span><strong class="command">trusted-keys</strong></span> or
  3458. <span><strong class="command">managed-keys</strong></span> statement. The default
  3459. is <strong class="userinput"><code>yes</code></strong>.
  3460. </p></dd>
  3461. <dt><span class="term"><span><strong class="command">dnssec-accept-expired</strong></span></span></dt>
  3462. <dd><p>
  3463. Accept expired signatures when verifying DNSSEC signatures.
  3464. The default is <strong class="userinput"><code>no</code></strong>.
  3465. Setting this option to <strong class="userinput"><code>yes</code></strong>
  3466. leaves <span><strong class="command">named</strong></span> vulnerable to
  3467. replay attacks.
  3468. </p></dd>
  3469. <dt><span class="term"><span><strong class="command">querylog</strong></span></span></dt>
  3470. <dd><p>
  3471. Specify whether query logging should be started when <span><strong class="command">named</strong></span>
  3472. starts.
  3473. If <span><strong class="command">querylog</strong></span> is not specified,
  3474. then the query logging
  3475. is determined by the presence of the logging category <span><strong class="command">queries</strong></span>.
  3476. </p></dd>
  3477. <dt><span class="term"><span><strong class="command">check-names</strong></span></span></dt>
  3478. <dd>
  3479. <p>
  3480. This option is used to restrict the character set and syntax
  3481. of
  3482. certain domain names in master files and/or DNS responses
  3483. received
  3484. from the network. The default varies according to usage
  3485. area. For
  3486. <span><strong class="command">master</strong></span> zones the default is <span><strong class="command">fail</strong></span>.
  3487. For <span><strong class="command">slave</strong></span> zones the default
  3488. is <span><strong class="command">warn</strong></span>.
  3489. For answers received from the network (<span><strong class="command">response</strong></span>)
  3490. the default is <span><strong class="command">ignore</strong></span>.
  3491. </p>
  3492. <p>
  3493. The rules for legal hostnames and mail domains are derived
  3494. from RFC 952 and RFC 821 as modified by RFC 1123.
  3495. </p>
  3496. <p><span><strong class="command">check-names</strong></span>
  3497. applies to the owner names of A, AAAA and MX records.
  3498. It also applies to the domain names in the RDATA of NS, SOA,
  3499. MX, and SRV records.
  3500. It also applies to the RDATA of PTR records where the owner
  3501. name indicated that it is a reverse lookup of a hostname
  3502. (the owner name ends in IN-ADDR.ARPA, IP6.ARPA, or IP6.INT).
  3503. </p>
  3504. </dd>
  3505. <dt><span class="term"><span><strong class="command">check-dup-records</strong></span></span></dt>
  3506. <dd><p>
  3507. Check master zones for records that are treated as different
  3508. by DNSSEC but are semantically equal in plain DNS. The
  3509. default is to <span><strong class="command">warn</strong></span>. Other possible
  3510. values are <span><strong class="command">fail</strong></span> and
  3511. <span><strong class="command">ignore</strong></span>.
  3512. </p></dd>
  3513. <dt><span class="term"><span><strong class="command">check-mx</strong></span></span></dt>
  3514. <dd><p>
  3515. Check whether the MX record appears to refer to a IP address.
  3516. The default is to <span><strong class="command">warn</strong></span>. Other possible
  3517. values are <span><strong class="command">fail</strong></span> and
  3518. <span><strong class="command">ignore</strong></span>.
  3519. </p></dd>
  3520. <dt><span class="term"><span><strong class="command">check-wildcard</strong></span></span></dt>
  3521. <dd><p>
  3522. This option is used to check for non-terminal wildcards.
  3523. The use of non-terminal wildcards is almost always as a
  3524. result of a failure
  3525. to understand the wildcard matching algorithm (RFC 1034).
  3526. This option
  3527. affects master zones. The default (<span><strong class="command">yes</strong></span>) is to check
  3528. for non-terminal wildcards and issue a warning.
  3529. </p></dd>
  3530. <dt><span class="term"><span><strong class="command">check-integrity</strong></span></span></dt>
  3531. <dd><p>
  3532. Perform post load zone integrity checks on master
  3533. zones. This checks that MX and SRV records refer
  3534. to address (A or AAAA) records and that glue
  3535. address records exist for delegated zones. For
  3536. MX and SRV records only in-zone hostnames are
  3537. checked (for out-of-zone hostnames use
  3538. <span><strong class="command">named-checkzone</strong></span>).
  3539. For NS records only names below top of zone are
  3540. checked (for out-of-zone names and glue consistency
  3541. checks use <span><strong class="command">named-checkzone</strong></span>).
  3542. The default is <span><strong class="command">yes</strong></span>.
  3543. </p></dd>
  3544. <dt><span class="term"><span><strong class="command">check-mx-cname</strong></span></span></dt>
  3545. <dd><p>
  3546. If <span><strong class="command">check-integrity</strong></span> is set then
  3547. fail, warn or ignore MX records that refer
  3548. to CNAMES. The default is to <span><strong class="command">warn</strong></span>.
  3549. </p></dd>
  3550. <dt><span class="term"><span><strong class="command">check-srv-cname</strong></span></span></dt>
  3551. <dd><p>
  3552. If <span><strong class="command">check-integrity</strong></span> is set then
  3553. fail, warn or ignore SRV records that refer
  3554. to CNAMES. The default is to <span><strong class="command">warn</strong></span>.
  3555. </p></dd>
  3556. <dt><span class="term"><span><strong class="command">check-sibling</strong></span></span></dt>
  3557. <dd><p>
  3558. When performing integrity checks, also check that
  3559. sibling glue exists. The default is <span><strong class="command">yes</strong></span>.
  3560. </p></dd>
  3561. <dt><span class="term"><span><strong class="command">zero-no-soa-ttl</strong></span></span></dt>
  3562. <dd><p>
  3563. When returning authoritative negative responses to
  3564. SOA queries set the TTL of the SOA record returned in
  3565. the authority section to zero.
  3566. The default is <span><strong class="command">yes</strong></span>.
  3567. </p></dd>
  3568. <dt><span class="term"><span><strong class="command">zero-no-soa-ttl-cache</strong></span></span></dt>
  3569. <dd><p>
  3570. When caching a negative response to a SOA query
  3571. set the TTL to zero.
  3572. The default is <span><strong class="command">no</strong></span>.
  3573. </p></dd>
  3574. <dt><span class="term"><span><strong class="command">update-check-ksk</strong></span></span></dt>
  3575. <dd>
  3576. <p>
  3577. When set to the default value of <code class="literal">yes</code>,
  3578. check the KSK bit in each key to determine how the key
  3579. should be used when generating RRSIGs for a secure zone.
  3580. </p>
  3581. <p>
  3582. Ordinarily, zone-signing keys (that is, keys without the
  3583. KSK bit set) are used to sign the entire zone, while
  3584. key-signing keys (keys with the KSK bit set) are only
  3585. used to sign the DNSKEY RRset at the zone apex.
  3586. However, if this option is set to <code class="literal">no</code>,
  3587. then the KSK bit is ignored; KSKs are treated as if they
  3588. were ZSKs and are used to sign the entire zone. This is
  3589. similar to the <span><strong class="command">dnssec-signzone -z</strong></span>
  3590. command line option.
  3591. </p>
  3592. <p>
  3593. When this option is set to <code class="literal">yes</code>, there
  3594. must be at least two active keys for every algorithm
  3595. represented in the DNSKEY RRset: at least one KSK and one
  3596. ZSK per algorithm. If there is any algorithm for which
  3597. this requirement is not met, this option will be ignored
  3598. for that algorithm.
  3599. </p>
  3600. </dd>
  3601. <dt><span class="term"><span><strong class="command">dnssec-dnskey-kskonly</strong></span></span></dt>
  3602. <dd>
  3603. <p>
  3604. When this option and <span><strong class="command">update-check-ksk</strong></span>
  3605. are both set to <code class="literal">yes</code>, only key-signing
  3606. keys (that is, keys with the KSK bit set) will be used
  3607. to sign the DNSKEY RRset at the zone apex. Zone-signing
  3608. keys (keys without the KSK bit set) will be used to sign
  3609. the remainder of the zone, but not the DNSKEY RRset.
  3610. This is similar to the
  3611. <span><strong class="command">dnssec-signzone -x</strong></span> command line option.
  3612. </p>
  3613. <p>
  3614. The default is <span><strong class="command">no</strong></span>. If
  3615. <span><strong class="command">update-check-ksk</strong></span> is set to
  3616. <code class="literal">no</code>, this option is ignored.
  3617. </p>
  3618. </dd>
  3619. <dt><span class="term"><span><strong class="command">try-tcp-refresh</strong></span></span></dt>
  3620. <dd><p>
  3621. Try to refresh the zone using TCP if UDP queries fail.
  3622. For BIND 8 compatibility, the default is
  3623. <span><strong class="command">yes</strong></span>.
  3624. </p></dd>
  3625. <dt><span class="term"><span><strong class="command">dnssec-secure-to-insecure</strong></span></span></dt>
  3626. <dd>
  3627. <p>
  3628. Allow a dynamic zone to transition from secure to
  3629. insecure (i.e., signed to unsigned) by deleting all
  3630. of the DNSKEY records. The default is <span><strong class="command">no</strong></span>.
  3631. If set to <span><strong class="command">yes</strong></span>, and if the DNSKEY RRset
  3632. at the zone apex is deleted, all RRSIG and NSEC records
  3633. will be removed from the zone as well.
  3634. </p>
  3635. <p>
  3636. If the zone uses NSEC3, then it is also necessary to
  3637. delete the NSEC3PARAM RRset from the zone apex; this will
  3638. cause the removal of all corresponding NSEC3 records.
  3639. (It is expected that this requirement will be eliminated
  3640. in a future release.)
  3641. </p>
  3642. <p>
  3643. Note that if a zone has been configured with
  3644. <span><strong class="command">auto-dnssec maintain</strong></span> and the
  3645. private keys remain accessible in the key repository,
  3646. then the zone will be automatically signed again the
  3647. next time <span><strong class="command">named</strong></span> is started.
  3648. </p>
  3649. </dd>
  3650. </dl></div>
  3651. </div>
  3652. <div class="sect3" lang="en">
  3653. <div class="titlepage"><div><div><h4 class="title">
  3654. <a name="id2583643"></a>Forwarding</h4></div></div></div>
  3655. <p>
  3656. The forwarding facility can be used to create a large site-wide
  3657. cache on a few servers, reducing traffic over links to external
  3658. name servers. It can also be used to allow queries by servers that
  3659. do not have direct access to the Internet, but wish to look up
  3660. exterior
  3661. names anyway. Forwarding occurs only on those queries for which
  3662. the server is not authoritative and does not have the answer in
  3663. its cache.
  3664. </p>
  3665. <div class="variablelist"><dl>
  3666. <dt><span class="term"><span><strong class="command">forward</strong></span></span></dt>
  3667. <dd><p>
  3668. This option is only meaningful if the
  3669. forwarders list is not empty. A value of <code class="varname">first</code>,
  3670. the default, causes the server to query the forwarders
  3671. first &#8212; and
  3672. if that doesn't answer the question, the server will then
  3673. look for
  3674. the answer itself. If <code class="varname">only</code> is
  3675. specified, the
  3676. server will only query the forwarders.
  3677. </p></dd>
  3678. <dt><span class="term"><span><strong class="command">forwarders</strong></span></span></dt>
  3679. <dd><p>
  3680. Specifies the IP addresses to be used
  3681. for forwarding. The default is the empty list (no
  3682. forwarding).
  3683. </p></dd>
  3684. </dl></div>
  3685. <p>
  3686. Forwarding can also be configured on a per-domain basis, allowing
  3687. for the global forwarding options to be overridden in a variety
  3688. of ways. You can set particular domains to use different
  3689. forwarders,
  3690. or have a different <span><strong class="command">forward only/first</strong></span> behavior,
  3691. or not forward at all, see <a href="Bv9ARM.ch06.html#zone_statement_grammar" title="zone
  3692. Statement Grammar">the section called &#8220;<span><strong class="command">zone</strong></span>
  3693. Statement Grammar&#8221;</a>.
  3694. </p>
  3695. </div>
  3696. <div class="sect3" lang="en">
  3697. <div class="titlepage"><div><div><h4 class="title">
  3698. <a name="id2583702"></a>Dual-stack Servers</h4></div></div></div>
  3699. <p>
  3700. Dual-stack servers are used as servers of last resort to work
  3701. around
  3702. problems in reachability due the lack of support for either IPv4
  3703. or IPv6
  3704. on the host machine.
  3705. </p>
  3706. <div class="variablelist"><dl>
  3707. <dt><span class="term"><span><strong class="command">dual-stack-servers</strong></span></span></dt>
  3708. <dd><p>
  3709. Specifies host names or addresses of machines with access to
  3710. both IPv4 and IPv6 transports. If a hostname is used, the
  3711. server must be able
  3712. to resolve the name using only the transport it has. If the
  3713. machine is dual
  3714. stacked, then the <span><strong class="command">dual-stack-servers</strong></span> have no effect unless
  3715. access to a transport has been disabled on the command line
  3716. (e.g. <span><strong class="command">named -4</strong></span>).
  3717. </p></dd>
  3718. </dl></div>
  3719. </div>
  3720. <div class="sect3" lang="en">
  3721. <div class="titlepage"><div><div><h4 class="title">
  3722. <a name="access_control"></a>Access Control</h4></div></div></div>
  3723. <p>
  3724. Access to the server can be restricted based on the IP address
  3725. of the requesting system. See <a href="Bv9ARM.ch06.html#address_match_lists" title="Address Match Lists">the section called &#8220;Address Match Lists&#8221;</a> for
  3726. details on how to specify IP address lists.
  3727. </p>
  3728. <div class="variablelist"><dl>
  3729. <dt><span class="term"><span><strong class="command">allow-notify</strong></span></span></dt>
  3730. <dd><p>
  3731. Specifies which hosts are allowed to
  3732. notify this server, a slave, of zone changes in addition
  3733. to the zone masters.
  3734. <span><strong class="command">allow-notify</strong></span> may also be
  3735. specified in the
  3736. <span><strong class="command">zone</strong></span> statement, in which case
  3737. it overrides the
  3738. <span><strong class="command">options allow-notify</strong></span>
  3739. statement. It is only meaningful
  3740. for a slave zone. If not specified, the default is to
  3741. process notify messages
  3742. only from a zone's master.
  3743. </p></dd>
  3744. <dt><span class="term"><span><strong class="command">allow-query</strong></span></span></dt>
  3745. <dd>
  3746. <p>
  3747. Specifies which hosts are allowed to ask ordinary
  3748. DNS questions. <span><strong class="command">allow-query</strong></span> may
  3749. also be specified in the <span><strong class="command">zone</strong></span>
  3750. statement, in which case it overrides the
  3751. <span><strong class="command">options allow-query</strong></span> statement.
  3752. If not specified, the default is to allow queries
  3753. from all hosts.
  3754. </p>
  3755. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  3756. <h3 class="title">Note</h3>
  3757. <p>
  3758. <span><strong class="command">allow-query-cache</strong></span> is now
  3759. used to specify access to the cache.
  3760. </p>
  3761. </div>
  3762. </dd>
  3763. <dt><span class="term"><span><strong class="command">allow-query-on</strong></span></span></dt>
  3764. <dd>
  3765. <p>
  3766. Specifies which local addresses can accept ordinary
  3767. DNS questions. This makes it possible, for instance,
  3768. to allow queries on internal-facing interfaces but
  3769. disallow them on external-facing ones, without
  3770. necessarily knowing the internal network's addresses.
  3771. </p>
  3772. <p>
  3773. <span><strong class="command">allow-query-on</strong></span> may
  3774. also be specified in the <span><strong class="command">zone</strong></span>
  3775. statement, in which case it overrides the
  3776. <span><strong class="command">options allow-query-on</strong></span> statement.
  3777. </p>
  3778. <p>
  3779. If not specified, the default is to allow queries
  3780. on all addresses.
  3781. </p>
  3782. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  3783. <h3 class="title">Note</h3>
  3784. <p>
  3785. <span><strong class="command">allow-query-cache</strong></span> is
  3786. used to specify access to the cache.
  3787. </p>
  3788. </div>
  3789. </dd>
  3790. <dt><span class="term"><span><strong class="command">allow-query-cache</strong></span></span></dt>
  3791. <dd><p>
  3792. Specifies which hosts are allowed to get answers
  3793. from the cache. If <span><strong class="command">allow-query-cache</strong></span>
  3794. is not set then <span><strong class="command">allow-recursion</strong></span>
  3795. is used if set, otherwise <span><strong class="command">allow-query</strong></span>
  3796. is used if set unless <span><strong class="command">recursion no;</strong></span> is
  3797. set in which case <span><strong class="command">none;</strong></span> is used,
  3798. otherwise the default (<span><strong class="command">localnets;</strong></span>
  3799. <span><strong class="command">localhost;</strong></span>) is used.
  3800. </p></dd>
  3801. <dt><span class="term"><span><strong class="command">allow-query-cache-on</strong></span></span></dt>
  3802. <dd><p>
  3803. Specifies which local addresses can give answers
  3804. from the cache. If not specified, the default is
  3805. to allow cache queries on any address,
  3806. <span><strong class="command">localnets</strong></span> and
  3807. <span><strong class="command">localhost</strong></span>.
  3808. </p></dd>
  3809. <dt><span class="term"><span><strong class="command">allow-recursion</strong></span></span></dt>
  3810. <dd><p>
  3811. Specifies which hosts are allowed to make recursive
  3812. queries through this server. If
  3813. <span><strong class="command">allow-recursion</strong></span> is not set
  3814. then <span><strong class="command">allow-query-cache</strong></span> is
  3815. used if set, otherwise <span><strong class="command">allow-query</strong></span>
  3816. is used if set, otherwise the default
  3817. (<span><strong class="command">localnets;</strong></span>
  3818. <span><strong class="command">localhost;</strong></span>) is used.
  3819. </p></dd>
  3820. <dt><span class="term"><span><strong class="command">allow-recursion-on</strong></span></span></dt>
  3821. <dd><p>
  3822. Specifies which local addresses can accept recursive
  3823. queries. If not specified, the default is to allow
  3824. recursive queries on all addresses.
  3825. </p></dd>
  3826. <dt><span class="term"><span><strong class="command">allow-update</strong></span></span></dt>
  3827. <dd><p>
  3828. Specifies which hosts are allowed to
  3829. submit Dynamic DNS updates for master zones. The default is
  3830. to deny
  3831. updates from all hosts. Note that allowing updates based
  3832. on the requestor's IP address is insecure; see
  3833. <a href="Bv9ARM.ch07.html#dynamic_update_security" title="Dynamic Update Security">the section called &#8220;Dynamic Update Security&#8221;</a> for details.
  3834. </p></dd>
  3835. <dt><span class="term"><span><strong class="command">allow-update-forwarding</strong></span></span></dt>
  3836. <dd>
  3837. <p>
  3838. Specifies which hosts are allowed to
  3839. submit Dynamic DNS updates to slave zones to be forwarded to
  3840. the
  3841. master. The default is <strong class="userinput"><code>{ none; }</code></strong>,
  3842. which
  3843. means that no update forwarding will be performed. To
  3844. enable
  3845. update forwarding, specify
  3846. <strong class="userinput"><code>allow-update-forwarding { any; };</code></strong>.
  3847. Specifying values other than <strong class="userinput"><code>{ none; }</code></strong> or
  3848. <strong class="userinput"><code>{ any; }</code></strong> is usually
  3849. counterproductive, since
  3850. the responsibility for update access control should rest
  3851. with the
  3852. master server, not the slaves.
  3853. </p>
  3854. <p>
  3855. Note that enabling the update forwarding feature on a slave
  3856. server
  3857. may expose master servers relying on insecure IP address
  3858. based
  3859. access control to attacks; see <a href="Bv9ARM.ch07.html#dynamic_update_security" title="Dynamic Update Security">the section called &#8220;Dynamic Update Security&#8221;</a>
  3860. for more details.
  3861. </p>
  3862. </dd>
  3863. <dt><span class="term"><span><strong class="command">allow-v6-synthesis</strong></span></span></dt>
  3864. <dd><p>
  3865. This option was introduced for the smooth transition from
  3866. AAAA
  3867. to A6 and from "nibble labels" to binary labels.
  3868. However, since both A6 and binary labels were then
  3869. deprecated,
  3870. this option was also deprecated.
  3871. It is now ignored with some warning messages.
  3872. </p></dd>
  3873. <dt><span class="term"><span><strong class="command">allow-transfer</strong></span></span></dt>
  3874. <dd><p>
  3875. Specifies which hosts are allowed to
  3876. receive zone transfers from the server. <span><strong class="command">allow-transfer</strong></span> may
  3877. also be specified in the <span><strong class="command">zone</strong></span>
  3878. statement, in which
  3879. case it overrides the <span><strong class="command">options allow-transfer</strong></span> statement.
  3880. If not specified, the default is to allow transfers to all
  3881. hosts.
  3882. </p></dd>
  3883. <dt><span class="term"><span><strong class="command">blackhole</strong></span></span></dt>
  3884. <dd><p>
  3885. Specifies a list of addresses that the
  3886. server will not accept queries from or use to resolve a
  3887. query. Queries
  3888. from these addresses will not be responded to. The default
  3889. is <strong class="userinput"><code>none</code></strong>.
  3890. </p></dd>
  3891. <dt><span class="term"><span><strong class="command">filter-aaaa</strong></span></span></dt>
  3892. <dd><p>
  3893. Specifies a list of addresses to which
  3894. <span><strong class="command">filter-aaaa-on-v4</strong></span>
  3895. is applies. The default is <strong class="userinput"><code>any</code></strong>.
  3896. </p></dd>
  3897. <dt><span class="term"><span><strong class="command">resolver-query-timeout</strong></span></span></dt>
  3898. <dd><p>
  3899. The amount of time the resolver will spend attempting
  3900. to resolve a recursive query before failing. The
  3901. default is <code class="literal">10</code> and the maximum is
  3902. <code class="literal">30</code>. Setting it to <code class="literal">0</code>
  3903. will result in the default being used.
  3904. </p></dd>
  3905. </dl></div>
  3906. </div>
  3907. <div class="sect3" lang="en">
  3908. <div class="titlepage"><div><div><h4 class="title">
  3909. <a name="id2584322"></a>Interfaces</h4></div></div></div>
  3910. <p>
  3911. The interfaces and ports that the server will answer queries
  3912. from may be specified using the <span><strong class="command">listen-on</strong></span> option. <span><strong class="command">listen-on</strong></span> takes
  3913. an optional port and an <code class="varname">address_match_list</code>.
  3914. The server will listen on all interfaces allowed by the address
  3915. match list. If a port is not specified, port 53 will be used.
  3916. </p>
  3917. <p>
  3918. Multiple <span><strong class="command">listen-on</strong></span> statements are
  3919. allowed.
  3920. For example,
  3921. </p>
  3922. <pre class="programlisting">listen-on { 5.6.7.8; };
  3923. listen-on port 1234 { !1.2.3.4; 1.2/16; };
  3924. </pre>
  3925. <p>
  3926. will enable the name server on port 53 for the IP address
  3927. 5.6.7.8, and on port 1234 of an address on the machine in net
  3928. 1.2 that is not 1.2.3.4.
  3929. </p>
  3930. <p>
  3931. If no <span><strong class="command">listen-on</strong></span> is specified, the
  3932. server will listen on port 53 on all IPv4 interfaces.
  3933. </p>
  3934. <p>
  3935. The <span><strong class="command">listen-on-v6</strong></span> option is used to
  3936. specify the interfaces and the ports on which the server will
  3937. listen
  3938. for incoming queries sent using IPv6.
  3939. </p>
  3940. <p>
  3941. When </p>
  3942. <pre class="programlisting">{ any; }</pre>
  3943. <p> is
  3944. specified
  3945. as the <code class="varname">address_match_list</code> for the
  3946. <span><strong class="command">listen-on-v6</strong></span> option,
  3947. the server does not bind a separate socket to each IPv6 interface
  3948. address as it does for IPv4 if the operating system has enough API
  3949. support for IPv6 (specifically if it conforms to RFC 3493 and RFC
  3950. 3542).
  3951. Instead, it listens on the IPv6 wildcard address.
  3952. If the system only has incomplete API support for IPv6, however,
  3953. the behavior is the same as that for IPv4.
  3954. </p>
  3955. <p>
  3956. A list of particular IPv6 addresses can also be specified, in
  3957. which case
  3958. the server listens on a separate socket for each specified
  3959. address,
  3960. regardless of whether the desired API is supported by the system.
  3961. </p>
  3962. <p>
  3963. Multiple <span><strong class="command">listen-on-v6</strong></span> options can
  3964. be used.
  3965. For example,
  3966. </p>
  3967. <pre class="programlisting">listen-on-v6 { any; };
  3968. listen-on-v6 port 1234 { !2001:db8::/32; any; };
  3969. </pre>
  3970. <p>
  3971. will enable the name server on port 53 for any IPv6 addresses
  3972. (with a single wildcard socket),
  3973. and on port 1234 of IPv6 addresses that is not in the prefix
  3974. 2001:db8::/32 (with separate sockets for each matched address.)
  3975. </p>
  3976. <p>
  3977. To make the server not listen on any IPv6 address, use
  3978. </p>
  3979. <pre class="programlisting">listen-on-v6 { none; };
  3980. </pre>
  3981. <p>
  3982. If no <span><strong class="command">listen-on-v6</strong></span> option is
  3983. specified, the server will not listen on any IPv6 address
  3984. unless <span><strong class="command">-6</strong></span> is specified when <span><strong class="command">named</strong></span> is
  3985. invoked. If <span><strong class="command">-6</strong></span> is specified then
  3986. <span><strong class="command">named</strong></span> will listen on port 53 on all IPv6 interfaces by default.
  3987. </p>
  3988. </div>
  3989. <div class="sect3" lang="en">
  3990. <div class="titlepage"><div><div><h4 class="title">
  3991. <a name="query_address"></a>Query Address</h4></div></div></div>
  3992. <p>
  3993. If the server doesn't know the answer to a question, it will
  3994. query other name servers. <span><strong class="command">query-source</strong></span> specifies
  3995. the address and port used for such queries. For queries sent over
  3996. IPv6, there is a separate <span><strong class="command">query-source-v6</strong></span> option.
  3997. If <span><strong class="command">address</strong></span> is <span><strong class="command">*</strong></span> (asterisk) or is omitted,
  3998. a wildcard IP address (<span><strong class="command">INADDR_ANY</strong></span>)
  3999. will be used.
  4000. </p>
  4001. <p>
  4002. If <span><strong class="command">port</strong></span> is <span><strong class="command">*</strong></span> or is omitted,
  4003. a random port number from a pre-configured
  4004. range is picked up and will be used for each query.
  4005. The port range(s) is that specified in
  4006. the <span><strong class="command">use-v4-udp-ports</strong></span> (for IPv4)
  4007. and <span><strong class="command">use-v6-udp-ports</strong></span> (for IPv6)
  4008. options, excluding the ranges specified in
  4009. the <span><strong class="command">avoid-v4-udp-ports</strong></span>
  4010. and <span><strong class="command">avoid-v6-udp-ports</strong></span> options, respectively.
  4011. </p>
  4012. <p>
  4013. The defaults of the <span><strong class="command">query-source</strong></span> and
  4014. <span><strong class="command">query-source-v6</strong></span> options
  4015. are:
  4016. </p>
  4017. <pre class="programlisting">query-source address * port *;
  4018. query-source-v6 address * port *;
  4019. </pre>
  4020. <p>
  4021. If <span><strong class="command">use-v4-udp-ports</strong></span> or
  4022. <span><strong class="command">use-v6-udp-ports</strong></span> is unspecified,
  4023. <span><strong class="command">named</strong></span> will check if the operating
  4024. system provides a programming interface to retrieve the
  4025. system's default range for ephemeral ports.
  4026. If such an interface is available,
  4027. <span><strong class="command">named</strong></span> will use the corresponding system
  4028. default range; otherwise, it will use its own defaults:
  4029. </p>
  4030. <pre class="programlisting">use-v4-udp-ports { range 1024 65535; };
  4031. use-v6-udp-ports { range 1024 65535; };
  4032. </pre>
  4033. <p>
  4034. Note: make sure the ranges be sufficiently large for
  4035. security. A desirable size depends on various parameters,
  4036. but we generally recommend it contain at least 16384 ports
  4037. (14 bits of entropy).
  4038. Note also that the system's default range when used may be
  4039. too small for this purpose, and that the range may even be
  4040. changed while <span><strong class="command">named</strong></span> is running; the new
  4041. range will automatically be applied when <span><strong class="command">named</strong></span>
  4042. is reloaded.
  4043. It is encouraged to
  4044. configure <span><strong class="command">use-v4-udp-ports</strong></span> and
  4045. <span><strong class="command">use-v6-udp-ports</strong></span> explicitly so that the
  4046. ranges are sufficiently large and are reasonably
  4047. independent from the ranges used by other applications.
  4048. </p>
  4049. <p>
  4050. Note: the operational configuration
  4051. where <span><strong class="command">named</strong></span> runs may prohibit the use
  4052. of some ports. For example, UNIX systems will not allow
  4053. <span><strong class="command">named</strong></span> running without a root privilege
  4054. to use ports less than 1024.
  4055. If such ports are included in the specified (or detected)
  4056. set of query ports, the corresponding query attempts will
  4057. fail, resulting in resolution failures or delay.
  4058. It is therefore important to configure the set of ports
  4059. that can be safely used in the expected operational environment.
  4060. </p>
  4061. <p>
  4062. The defaults of the <span><strong class="command">avoid-v4-udp-ports</strong></span> and
  4063. <span><strong class="command">avoid-v6-udp-ports</strong></span> options
  4064. are:
  4065. </p>
  4066. <pre class="programlisting">avoid-v4-udp-ports {};
  4067. avoid-v6-udp-ports {};
  4068. </pre>
  4069. <p>
  4070. Note: BIND 9.5.0 introduced
  4071. the <span><strong class="command">use-queryport-pool</strong></span>
  4072. option to support a pool of such random ports, but this
  4073. option is now obsolete because reusing the same ports in
  4074. the pool may not be sufficiently secure.
  4075. For the same reason, it is generally strongly discouraged to
  4076. specify a particular port for the
  4077. <span><strong class="command">query-source</strong></span> or
  4078. <span><strong class="command">query-source-v6</strong></span> options;
  4079. it implicitly disables the use of randomized port numbers.
  4080. </p>
  4081. <div class="variablelist"><dl>
  4082. <dt><span class="term"><span><strong class="command">use-queryport-pool</strong></span></span></dt>
  4083. <dd><p>
  4084. This option is obsolete.
  4085. </p></dd>
  4086. <dt><span class="term"><span><strong class="command">queryport-pool-ports</strong></span></span></dt>
  4087. <dd><p>
  4088. This option is obsolete.
  4089. </p></dd>
  4090. <dt><span class="term"><span><strong class="command">queryport-pool-updateinterval</strong></span></span></dt>
  4091. <dd><p>
  4092. This option is obsolete.
  4093. </p></dd>
  4094. </dl></div>
  4095. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  4096. <h3 class="title">Note</h3>
  4097. <p>
  4098. The address specified in the <span><strong class="command">query-source</strong></span> option
  4099. is used for both UDP and TCP queries, but the port applies only
  4100. to UDP queries. TCP queries always use a random
  4101. unprivileged port.
  4102. </p>
  4103. </div>
  4104. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  4105. <h3 class="title">Note</h3>
  4106. <p>
  4107. Solaris 2.5.1 and earlier does not support setting the source
  4108. address for TCP sockets.
  4109. </p>
  4110. </div>
  4111. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  4112. <h3 class="title">Note</h3>
  4113. <p>
  4114. See also <span><strong class="command">transfer-source</strong></span> and
  4115. <span><strong class="command">notify-source</strong></span>.
  4116. </p>
  4117. </div>
  4118. </div>
  4119. <div class="sect3" lang="en">
  4120. <div class="titlepage"><div><div><h4 class="title">
  4121. <a name="zone_transfers"></a>Zone Transfers</h4></div></div></div>
  4122. <p>
  4123. <acronym class="acronym">BIND</acronym> has mechanisms in place to
  4124. facilitate zone transfers
  4125. and set limits on the amount of load that transfers place on the
  4126. system. The following options apply to zone transfers.
  4127. </p>
  4128. <div class="variablelist"><dl>
  4129. <dt><span class="term"><span><strong class="command">also-notify</strong></span></span></dt>
  4130. <dd><p>
  4131. Defines a global list of IP addresses of name servers
  4132. that are also sent NOTIFY messages whenever a fresh copy of
  4133. the
  4134. zone is loaded, in addition to the servers listed in the
  4135. zone's NS records.
  4136. This helps to ensure that copies of the zones will
  4137. quickly converge on stealth servers.
  4138. Optionally, a port may be specified with each
  4139. <span><strong class="command">also-notify</strong></span> address to send
  4140. the notify messages to a port other than the
  4141. default of 53.
  4142. If an <span><strong class="command">also-notify</strong></span> list
  4143. is given in a <span><strong class="command">zone</strong></span> statement,
  4144. it will override
  4145. the <span><strong class="command">options also-notify</strong></span>
  4146. statement. When a <span><strong class="command">zone notify</strong></span>
  4147. statement
  4148. is set to <span><strong class="command">no</strong></span>, the IP
  4149. addresses in the global <span><strong class="command">also-notify</strong></span> list will
  4150. not be sent NOTIFY messages for that zone. The default is
  4151. the empty
  4152. list (no global notification list).
  4153. </p></dd>
  4154. <dt><span class="term"><span><strong class="command">max-transfer-time-in</strong></span></span></dt>
  4155. <dd><p>
  4156. Inbound zone transfers running longer than
  4157. this many minutes will be terminated. The default is 120
  4158. minutes
  4159. (2 hours). The maximum value is 28 days (40320 minutes).
  4160. </p></dd>
  4161. <dt><span class="term"><span><strong class="command">max-transfer-idle-in</strong></span></span></dt>
  4162. <dd><p>
  4163. Inbound zone transfers making no progress
  4164. in this many minutes will be terminated. The default is 60
  4165. minutes
  4166. (1 hour). The maximum value is 28 days (40320 minutes).
  4167. </p></dd>
  4168. <dt><span class="term"><span><strong class="command">max-transfer-time-out</strong></span></span></dt>
  4169. <dd><p>
  4170. Outbound zone transfers running longer than
  4171. this many minutes will be terminated. The default is 120
  4172. minutes
  4173. (2 hours). The maximum value is 28 days (40320 minutes).
  4174. </p></dd>
  4175. <dt><span class="term"><span><strong class="command">max-transfer-idle-out</strong></span></span></dt>
  4176. <dd><p>
  4177. Outbound zone transfers making no progress
  4178. in this many minutes will be terminated. The default is 60
  4179. minutes (1
  4180. hour). The maximum value is 28 days (40320 minutes).
  4181. </p></dd>
  4182. <dt><span class="term"><span><strong class="command">serial-query-rate</strong></span></span></dt>
  4183. <dd>
  4184. <p>
  4185. Slave servers will periodically query master
  4186. servers to find out if zone serial numbers have
  4187. changed. Each such query uses a minute amount of
  4188. the slave server's network bandwidth. To limit
  4189. the amount of bandwidth used, BIND 9 limits the
  4190. rate at which queries are sent. The value of the
  4191. <span><strong class="command">serial-query-rate</strong></span> option, an
  4192. integer, is the maximum number of queries sent
  4193. per second. The default is 20.
  4194. </p>
  4195. <p>
  4196. In addition to controlling the rate SOA refresh
  4197. queries are issued at
  4198. <span><strong class="command">serial-query-rate</strong></span> also controls
  4199. the rate at which NOTIFY messages are sent from
  4200. both master and slave zones.
  4201. </p>
  4202. </dd>
  4203. <dt><span class="term"><span><strong class="command">serial-queries</strong></span></span></dt>
  4204. <dd><p>
  4205. In BIND 8, the <span><strong class="command">serial-queries</strong></span>
  4206. option
  4207. set the maximum number of concurrent serial number queries
  4208. allowed to be outstanding at any given time.
  4209. BIND 9 does not limit the number of outstanding
  4210. serial queries and ignores the <span><strong class="command">serial-queries</strong></span> option.
  4211. Instead, it limits the rate at which the queries are sent
  4212. as defined using the <span><strong class="command">serial-query-rate</strong></span> option.
  4213. </p></dd>
  4214. <dt><span class="term"><span><strong class="command">transfer-format</strong></span></span></dt>
  4215. <dd><p>
  4216. Zone transfers can be sent using two different formats,
  4217. <span><strong class="command">one-answer</strong></span> and
  4218. <span><strong class="command">many-answers</strong></span>.
  4219. The <span><strong class="command">transfer-format</strong></span> option is used
  4220. on the master server to determine which format it sends.
  4221. <span><strong class="command">one-answer</strong></span> uses one DNS message per
  4222. resource record transferred.
  4223. <span><strong class="command">many-answers</strong></span> packs as many resource
  4224. records as possible into a message.
  4225. <span><strong class="command">many-answers</strong></span> is more efficient, but is
  4226. only supported by relatively new slave servers,
  4227. such as <acronym class="acronym">BIND</acronym> 9, <acronym class="acronym">BIND</acronym>
  4228. 8.x and <acronym class="acronym">BIND</acronym> 4.9.5 onwards.
  4229. The <span><strong class="command">many-answers</strong></span> format is also supported by
  4230. recent Microsoft Windows nameservers.
  4231. The default is <span><strong class="command">many-answers</strong></span>.
  4232. <span><strong class="command">transfer-format</strong></span> may be overridden on a
  4233. per-server basis by using the <span><strong class="command">server</strong></span>
  4234. statement.
  4235. </p></dd>
  4236. <dt><span class="term"><span><strong class="command">transfers-in</strong></span></span></dt>
  4237. <dd><p>
  4238. The maximum number of inbound zone transfers
  4239. that can be running concurrently. The default value is <code class="literal">10</code>.
  4240. Increasing <span><strong class="command">transfers-in</strong></span> may
  4241. speed up the convergence
  4242. of slave zones, but it also may increase the load on the
  4243. local system.
  4244. </p></dd>
  4245. <dt><span class="term"><span><strong class="command">transfers-out</strong></span></span></dt>
  4246. <dd><p>
  4247. The maximum number of outbound zone transfers
  4248. that can be running concurrently. Zone transfer requests in
  4249. excess
  4250. of the limit will be refused. The default value is <code class="literal">10</code>.
  4251. </p></dd>
  4252. <dt><span class="term"><span><strong class="command">transfers-per-ns</strong></span></span></dt>
  4253. <dd><p>
  4254. The maximum number of inbound zone transfers
  4255. that can be concurrently transferring from a given remote
  4256. name server.
  4257. The default value is <code class="literal">2</code>.
  4258. Increasing <span><strong class="command">transfers-per-ns</strong></span>
  4259. may
  4260. speed up the convergence of slave zones, but it also may
  4261. increase
  4262. the load on the remote name server. <span><strong class="command">transfers-per-ns</strong></span> may
  4263. be overridden on a per-server basis by using the <span><strong class="command">transfers</strong></span> phrase
  4264. of the <span><strong class="command">server</strong></span> statement.
  4265. </p></dd>
  4266. <dt><span class="term"><span><strong class="command">transfer-source</strong></span></span></dt>
  4267. <dd>
  4268. <p><span><strong class="command">transfer-source</strong></span>
  4269. determines which local address will be bound to IPv4
  4270. TCP connections used to fetch zones transferred
  4271. inbound by the server. It also determines the
  4272. source IPv4 address, and optionally the UDP port,
  4273. used for the refresh queries and forwarded dynamic
  4274. updates. If not set, it defaults to a system
  4275. controlled value which will usually be the address
  4276. of the interface "closest to" the remote end. This
  4277. address must appear in the remote end's
  4278. <span><strong class="command">allow-transfer</strong></span> option for the
  4279. zone being transferred, if one is specified. This
  4280. statement sets the
  4281. <span><strong class="command">transfer-source</strong></span> for all zones,
  4282. but can be overridden on a per-view or per-zone
  4283. basis by including a
  4284. <span><strong class="command">transfer-source</strong></span> statement within
  4285. the <span><strong class="command">view</strong></span> or
  4286. <span><strong class="command">zone</strong></span> block in the configuration
  4287. file.
  4288. </p>
  4289. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  4290. <h3 class="title">Note</h3>
  4291. <p>
  4292. Solaris 2.5.1 and earlier does not support setting the
  4293. source address for TCP sockets.
  4294. </p>
  4295. </div>
  4296. </dd>
  4297. <dt><span class="term"><span><strong class="command">transfer-source-v6</strong></span></span></dt>
  4298. <dd><p>
  4299. The same as <span><strong class="command">transfer-source</strong></span>,
  4300. except zone transfers are performed using IPv6.
  4301. </p></dd>
  4302. <dt><span class="term"><span><strong class="command">alt-transfer-source</strong></span></span></dt>
  4303. <dd>
  4304. <p>
  4305. An alternate transfer source if the one listed in
  4306. <span><strong class="command">transfer-source</strong></span> fails and
  4307. <span><strong class="command">use-alt-transfer-source</strong></span> is
  4308. set.
  4309. </p>
  4310. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  4311. <h3 class="title">Note</h3>
  4312. If you do not wish the alternate transfer source
  4313. to be used, you should set
  4314. <span><strong class="command">use-alt-transfer-source</strong></span>
  4315. appropriately and you should not depend upon
  4316. getting an answer back to the first refresh
  4317. query.
  4318. </div>
  4319. </dd>
  4320. <dt><span class="term"><span><strong class="command">alt-transfer-source-v6</strong></span></span></dt>
  4321. <dd><p>
  4322. An alternate transfer source if the one listed in
  4323. <span><strong class="command">transfer-source-v6</strong></span> fails and
  4324. <span><strong class="command">use-alt-transfer-source</strong></span> is
  4325. set.
  4326. </p></dd>
  4327. <dt><span class="term"><span><strong class="command">use-alt-transfer-source</strong></span></span></dt>
  4328. <dd><p>
  4329. Use the alternate transfer sources or not. If views are
  4330. specified this defaults to <span><strong class="command">no</strong></span>
  4331. otherwise it defaults to
  4332. <span><strong class="command">yes</strong></span> (for BIND 8
  4333. compatibility).
  4334. </p></dd>
  4335. <dt><span class="term"><span><strong class="command">notify-source</strong></span></span></dt>
  4336. <dd>
  4337. <p><span><strong class="command">notify-source</strong></span>
  4338. determines which local source address, and
  4339. optionally UDP port, will be used to send NOTIFY
  4340. messages. This address must appear in the slave
  4341. server's <span><strong class="command">masters</strong></span> zone clause or
  4342. in an <span><strong class="command">allow-notify</strong></span> clause. This
  4343. statement sets the <span><strong class="command">notify-source</strong></span>
  4344. for all zones, but can be overridden on a per-zone or
  4345. per-view basis by including a
  4346. <span><strong class="command">notify-source</strong></span> statement within
  4347. the <span><strong class="command">zone</strong></span> or
  4348. <span><strong class="command">view</strong></span> block in the configuration
  4349. file.
  4350. </p>
  4351. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  4352. <h3 class="title">Note</h3>
  4353. <p>
  4354. Solaris 2.5.1 and earlier does not support setting the
  4355. source address for TCP sockets.
  4356. </p>
  4357. </div>
  4358. </dd>
  4359. <dt><span class="term"><span><strong class="command">notify-source-v6</strong></span></span></dt>
  4360. <dd><p>
  4361. Like <span><strong class="command">notify-source</strong></span>,
  4362. but applies to notify messages sent to IPv6 addresses.
  4363. </p></dd>
  4364. </dl></div>
  4365. </div>
  4366. <div class="sect3" lang="en">
  4367. <div class="titlepage"><div><div><h4 class="title">
  4368. <a name="id2585531"></a>UDP Port Lists</h4></div></div></div>
  4369. <p>
  4370. <span><strong class="command">use-v4-udp-ports</strong></span>,
  4371. <span><strong class="command">avoid-v4-udp-ports</strong></span>,
  4372. <span><strong class="command">use-v6-udp-ports</strong></span>, and
  4373. <span><strong class="command">avoid-v6-udp-ports</strong></span>
  4374. specify a list of IPv4 and IPv6 UDP ports that will be
  4375. used or not used as source ports for UDP messages.
  4376. See <a href="Bv9ARM.ch06.html#query_address" title="Query Address">the section called &#8220;Query Address&#8221;</a> about how the
  4377. available ports are determined.
  4378. For example, with the following configuration
  4379. </p>
  4380. <pre class="programlisting">
  4381. use-v6-udp-ports { range 32768 65535; };
  4382. avoid-v6-udp-ports { 40000; range 50000 60000; };
  4383. </pre>
  4384. <p>
  4385. UDP ports of IPv6 messages sent
  4386. from <span><strong class="command">named</strong></span> will be in one
  4387. of the following ranges: 32768 to 39999, 40001 to 49999,
  4388. and 60001 to 65535.
  4389. </p>
  4390. <p>
  4391. <span><strong class="command">avoid-v4-udp-ports</strong></span> and
  4392. <span><strong class="command">avoid-v6-udp-ports</strong></span> can be used
  4393. to prevent <span><strong class="command">named</strong></span> from choosing as its random source port a
  4394. port that is blocked by your firewall or a port that is
  4395. used by other applications;
  4396. if a query went out with a source port blocked by a
  4397. firewall, the
  4398. answer would not get by the firewall and the name server would
  4399. have to query again.
  4400. Note: the desired range can also be represented only with
  4401. <span><strong class="command">use-v4-udp-ports</strong></span> and
  4402. <span><strong class="command">use-v6-udp-ports</strong></span>, and the
  4403. <span><strong class="command">avoid-</strong></span> options are redundant in that
  4404. sense; they are provided for backward compatibility and
  4405. to possibly simplify the port specification.
  4406. </p>
  4407. </div>
  4408. <div class="sect3" lang="en">
  4409. <div class="titlepage"><div><div><h4 class="title">
  4410. <a name="id2585591"></a>Operating System Resource Limits</h4></div></div></div>
  4411. <p>
  4412. The server's usage of many system resources can be limited.
  4413. Scaled values are allowed when specifying resource limits. For
  4414. example, <span><strong class="command">1G</strong></span> can be used instead of
  4415. <span><strong class="command">1073741824</strong></span> to specify a limit of
  4416. one
  4417. gigabyte. <span><strong class="command">unlimited</strong></span> requests
  4418. unlimited use, or the
  4419. maximum available amount. <span><strong class="command">default</strong></span>
  4420. uses the limit
  4421. that was in force when the server was started. See the description
  4422. of <span><strong class="command">size_spec</strong></span> in <a href="Bv9ARM.ch06.html#configuration_file_elements" title="Configuration File Elements">the section called &#8220;Configuration File Elements&#8221;</a>.
  4423. </p>
  4424. <p>
  4425. The following options set operating system resource limits for
  4426. the name server process. Some operating systems don't support
  4427. some or
  4428. any of the limits. On such systems, a warning will be issued if
  4429. the
  4430. unsupported limit is used.
  4431. </p>
  4432. <div class="variablelist"><dl>
  4433. <dt><span class="term"><span><strong class="command">coresize</strong></span></span></dt>
  4434. <dd><p>
  4435. The maximum size of a core dump. The default
  4436. is <code class="literal">default</code>.
  4437. </p></dd>
  4438. <dt><span class="term"><span><strong class="command">datasize</strong></span></span></dt>
  4439. <dd><p>
  4440. The maximum amount of data memory the server
  4441. may use. The default is <code class="literal">default</code>.
  4442. This is a hard limit on server memory usage.
  4443. If the server attempts to allocate memory in excess of this
  4444. limit, the allocation will fail, which may in turn leave
  4445. the server unable to perform DNS service. Therefore,
  4446. this option is rarely useful as a way of limiting the
  4447. amount of memory used by the server, but it can be used
  4448. to raise an operating system data size limit that is
  4449. too small by default. If you wish to limit the amount
  4450. of memory used by the server, use the
  4451. <span><strong class="command">max-cache-size</strong></span> and
  4452. <span><strong class="command">recursive-clients</strong></span>
  4453. options instead.
  4454. </p></dd>
  4455. <dt><span class="term"><span><strong class="command">files</strong></span></span></dt>
  4456. <dd><p>
  4457. The maximum number of files the server
  4458. may have open concurrently. The default is <code class="literal">unlimited</code>.
  4459. </p></dd>
  4460. <dt><span class="term"><span><strong class="command">stacksize</strong></span></span></dt>
  4461. <dd><p>
  4462. The maximum amount of stack memory the server
  4463. may use. The default is <code class="literal">default</code>.
  4464. </p></dd>
  4465. </dl></div>
  4466. </div>
  4467. <div class="sect3" lang="en">
  4468. <div class="titlepage"><div><div><h4 class="title">
  4469. <a name="server_resource_limits"></a>Server Resource Limits</h4></div></div></div>
  4470. <p>
  4471. The following options set limits on the server's
  4472. resource consumption that are enforced internally by the
  4473. server rather than the operating system.
  4474. </p>
  4475. <div class="variablelist"><dl>
  4476. <dt><span class="term"><span><strong class="command">max-ixfr-log-size</strong></span></span></dt>
  4477. <dd><p>
  4478. This option is obsolete; it is accepted
  4479. and ignored for BIND 8 compatibility. The option
  4480. <span><strong class="command">max-journal-size</strong></span> performs a
  4481. similar function in BIND 9.
  4482. </p></dd>
  4483. <dt><span class="term"><span><strong class="command">max-journal-size</strong></span></span></dt>
  4484. <dd><p>
  4485. Sets a maximum size for each journal file
  4486. (see <a href="Bv9ARM.ch04.html#journal" title="The journal file">the section called &#8220;The journal file&#8221;</a>). When the journal file
  4487. approaches
  4488. the specified size, some of the oldest transactions in the
  4489. journal
  4490. will be automatically removed. The default is
  4491. <code class="literal">unlimited</code>.
  4492. This may also be set on a per-zone basis.
  4493. </p></dd>
  4494. <dt><span class="term"><span><strong class="command">host-statistics-max</strong></span></span></dt>
  4495. <dd><p>
  4496. In BIND 8, specifies the maximum number of host statistics
  4497. entries to be kept.
  4498. Not implemented in BIND 9.
  4499. </p></dd>
  4500. <dt><span class="term"><span><strong class="command">recursive-clients</strong></span></span></dt>
  4501. <dd><p>
  4502. The maximum number of simultaneous recursive lookups
  4503. the server will perform on behalf of clients. The default
  4504. is
  4505. <code class="literal">1000</code>. Because each recursing
  4506. client uses a fair
  4507. bit of memory, on the order of 20 kilobytes, the value of
  4508. the
  4509. <span><strong class="command">recursive-clients</strong></span> option may
  4510. have to be decreased
  4511. on hosts with limited memory.
  4512. </p></dd>
  4513. <dt><span class="term"><span><strong class="command">tcp-clients</strong></span></span></dt>
  4514. <dd><p>
  4515. The maximum number of simultaneous client TCP
  4516. connections that the server will accept.
  4517. The default is <code class="literal">100</code>.
  4518. </p></dd>
  4519. <dt><span class="term"><span><strong class="command">reserved-sockets</strong></span></span></dt>
  4520. <dd>
  4521. <p>
  4522. The number of file descriptors reserved for TCP, stdio,
  4523. etc. This needs to be big enough to cover the number of
  4524. interfaces <span><strong class="command">named</strong></span> listens on, <span><strong class="command">tcp-clients</strong></span> as well as
  4525. to provide room for outgoing TCP queries and incoming zone
  4526. transfers. The default is <code class="literal">512</code>.
  4527. The minimum value is <code class="literal">128</code> and the
  4528. maximum value is <code class="literal">128</code> less than
  4529. maxsockets (-S). This option may be removed in the future.
  4530. </p>
  4531. <p>
  4532. This option has little effect on Windows.
  4533. </p>
  4534. </dd>
  4535. <dt><span class="term"><span><strong class="command">max-cache-size</strong></span></span></dt>
  4536. <dd><p>
  4537. The maximum amount of memory to use for the
  4538. server's cache, in bytes.
  4539. When the amount of data in the cache
  4540. reaches this limit, the server will cause records to expire
  4541. prematurely based on an LRU based strategy so that
  4542. the limit is not exceeded.
  4543. A value of 0 is special, meaning that
  4544. records are purged from the cache only when their
  4545. TTLs expire.
  4546. Another special keyword <strong class="userinput"><code>unlimited</code></strong>
  4547. means the maximum value of 32-bit unsigned integers
  4548. (0xffffffff), which may not have the same effect as
  4549. 0 on machines that support more than 32 bits of
  4550. memory space.
  4551. Any positive values less than 2MB will be ignored reset
  4552. to 2MB.
  4553. In a server with multiple views, the limit applies
  4554. separately to the cache of each view.
  4555. The default is 0.
  4556. </p></dd>
  4557. <dt><span class="term"><span><strong class="command">tcp-listen-queue</strong></span></span></dt>
  4558. <dd><p>
  4559. The listen queue depth. The default and minimum is 3.
  4560. If the kernel supports the accept filter "dataready" this
  4561. also controls how
  4562. many TCP connections that will be queued in kernel space
  4563. waiting for
  4564. some data before being passed to accept. Values less than 3
  4565. will be
  4566. silently raised.
  4567. </p></dd>
  4568. </dl></div>
  4569. </div>
  4570. <div class="sect3" lang="en">
  4571. <div class="titlepage"><div><div><h4 class="title">
  4572. <a name="id2586082"></a>Periodic Task Intervals</h4></div></div></div>
  4573. <div class="variablelist"><dl>
  4574. <dt><span class="term"><span><strong class="command">cleaning-interval</strong></span></span></dt>
  4575. <dd><p>
  4576. This interval is effectively obsolete. Previously,
  4577. the server would remove expired resource records
  4578. from the cache every <span><strong class="command">cleaning-interval</strong></span> minutes.
  4579. <acronym class="acronym">BIND</acronym> 9 now manages cache
  4580. memory in a more sophisticated manner and does not
  4581. rely on the periodic cleaning any more.
  4582. Specifying this option therefore has no effect on
  4583. the server's behavior.
  4584. </p></dd>
  4585. <dt><span class="term"><span><strong class="command">heartbeat-interval</strong></span></span></dt>
  4586. <dd><p>
  4587. The server will perform zone maintenance tasks
  4588. for all zones marked as <span><strong class="command">dialup</strong></span> whenever this
  4589. interval expires. The default is 60 minutes. Reasonable
  4590. values are up
  4591. to 1 day (1440 minutes). The maximum value is 28 days
  4592. (40320 minutes).
  4593. If set to 0, no zone maintenance for these zones will occur.
  4594. </p></dd>
  4595. <dt><span class="term"><span><strong class="command">interface-interval</strong></span></span></dt>
  4596. <dd><p>
  4597. The server will scan the network interface list
  4598. every <span><strong class="command">interface-interval</strong></span>
  4599. minutes. The default
  4600. is 60 minutes. The maximum value is 28 days (40320 minutes).
  4601. If set to 0, interface scanning will only occur when
  4602. the configuration file is loaded. After the scan, the
  4603. server will
  4604. begin listening for queries on any newly discovered
  4605. interfaces (provided they are allowed by the
  4606. <span><strong class="command">listen-on</strong></span> configuration), and
  4607. will
  4608. stop listening on interfaces that have gone away.
  4609. </p></dd>
  4610. <dt><span class="term"><span><strong class="command">statistics-interval</strong></span></span></dt>
  4611. <dd>
  4612. <p>
  4613. Name server statistics will be logged
  4614. every <span><strong class="command">statistics-interval</strong></span>
  4615. minutes. The default is
  4616. 60. The maximum value is 28 days (40320 minutes).
  4617. If set to 0, no statistics will be logged.
  4618. </p>
  4619. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  4620. <h3 class="title">Note</h3>
  4621. <p>
  4622. Not yet implemented in
  4623. <acronym class="acronym">BIND</acronym> 9.
  4624. </p>
  4625. </div>
  4626. </dd>
  4627. </dl></div>
  4628. </div>
  4629. <div class="sect3" lang="en">
  4630. <div class="titlepage"><div><div><h4 class="title">
  4631. <a name="topology"></a>Topology</h4></div></div></div>
  4632. <p>
  4633. All other things being equal, when the server chooses a name
  4634. server
  4635. to query from a list of name servers, it prefers the one that is
  4636. topologically closest to itself. The <span><strong class="command">topology</strong></span> statement
  4637. takes an <span><strong class="command">address_match_list</strong></span> and
  4638. interprets it
  4639. in a special way. Each top-level list element is assigned a
  4640. distance.
  4641. Non-negated elements get a distance based on their position in the
  4642. list, where the closer the match is to the start of the list, the
  4643. shorter the distance is between it and the server. A negated match
  4644. will be assigned the maximum distance from the server. If there
  4645. is no match, the address will get a distance which is further than
  4646. any non-negated list element, and closer than any negated element.
  4647. For example,
  4648. </p>
  4649. <pre class="programlisting">topology {
  4650. 10/8;
  4651. !1.2.3/24;
  4652. { 1.2/16; 3/8; };
  4653. };</pre>
  4654. <p>
  4655. will prefer servers on network 10 the most, followed by hosts
  4656. on network 1.2.0.0 (netmask 255.255.0.0) and network 3, with the
  4657. exception of hosts on network 1.2.3 (netmask 255.255.255.0), which
  4658. is preferred least of all.
  4659. </p>
  4660. <p>
  4661. The default topology is
  4662. </p>
  4663. <pre class="programlisting"> topology { localhost; localnets; };
  4664. </pre>
  4665. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  4666. <h3 class="title">Note</h3>
  4667. <p>
  4668. The <span><strong class="command">topology</strong></span> option
  4669. is not implemented in <acronym class="acronym">BIND</acronym> 9.
  4670. </p>
  4671. </div>
  4672. </div>
  4673. <div class="sect3" lang="en">
  4674. <div class="titlepage"><div><div><h4 class="title">
  4675. <a name="the_sortlist_statement"></a>The <span><strong class="command">sortlist</strong></span> Statement</h4></div></div></div>
  4676. <p>
  4677. The response to a DNS query may consist of multiple resource
  4678. records (RRs) forming a resource records set (RRset).
  4679. The name server will normally return the
  4680. RRs within the RRset in an indeterminate order
  4681. (but see the <span><strong class="command">rrset-order</strong></span>
  4682. statement in <a href="Bv9ARM.ch06.html#rrset_ordering" title="RRset Ordering">the section called &#8220;RRset Ordering&#8221;</a>).
  4683. The client resolver code should rearrange the RRs as appropriate,
  4684. that is, using any addresses on the local net in preference to
  4685. other addresses.
  4686. However, not all resolvers can do this or are correctly
  4687. configured.
  4688. When a client is using a local server, the sorting can be performed
  4689. in the server, based on the client's address. This only requires
  4690. configuring the name servers, not all the clients.
  4691. </p>
  4692. <p>
  4693. The <span><strong class="command">sortlist</strong></span> statement (see below)
  4694. takes
  4695. an <span><strong class="command">address_match_list</strong></span> and
  4696. interprets it even
  4697. more specifically than the <span><strong class="command">topology</strong></span>
  4698. statement
  4699. does (<a href="Bv9ARM.ch06.html#topology" title="Topology">the section called &#8220;Topology&#8221;</a>).
  4700. Each top level statement in the <span><strong class="command">sortlist</strong></span> must
  4701. itself be an explicit <span><strong class="command">address_match_list</strong></span> with
  4702. one or two elements. The first element (which may be an IP
  4703. address,
  4704. an IP prefix, an ACL name or a nested <span><strong class="command">address_match_list</strong></span>)
  4705. of each top level list is checked against the source address of
  4706. the query until a match is found.
  4707. </p>
  4708. <p>
  4709. Once the source address of the query has been matched, if
  4710. the top level statement contains only one element, the actual
  4711. primitive
  4712. element that matched the source address is used to select the
  4713. address
  4714. in the response to move to the beginning of the response. If the
  4715. statement is a list of two elements, then the second element is
  4716. treated the same as the <span><strong class="command">address_match_list</strong></span> in
  4717. a <span><strong class="command">topology</strong></span> statement. Each top
  4718. level element
  4719. is assigned a distance and the address in the response with the
  4720. minimum
  4721. distance is moved to the beginning of the response.
  4722. </p>
  4723. <p>
  4724. In the following example, any queries received from any of
  4725. the addresses of the host itself will get responses preferring
  4726. addresses
  4727. on any of the locally connected networks. Next most preferred are
  4728. addresses
  4729. on the 192.168.1/24 network, and after that either the
  4730. 192.168.2/24
  4731. or
  4732. 192.168.3/24 network with no preference shown between these two
  4733. networks. Queries received from a host on the 192.168.1/24 network
  4734. will prefer other addresses on that network to the 192.168.2/24
  4735. and
  4736. 192.168.3/24 networks. Queries received from a host on the
  4737. 192.168.4/24
  4738. or the 192.168.5/24 network will only prefer other addresses on
  4739. their directly connected networks.
  4740. </p>
  4741. <pre class="programlisting">sortlist {
  4742. // IF the local host
  4743. // THEN first fit on the following nets
  4744. { localhost;
  4745. { localnets;
  4746. 192.168.1/24;
  4747. { 192.168.2/24; 192.168.3/24; }; }; };
  4748. // IF on class C 192.168.1 THEN use .1, or .2 or .3
  4749. { 192.168.1/24;
  4750. { 192.168.1/24;
  4751. { 192.168.2/24; 192.168.3/24; }; }; };
  4752. // IF on class C 192.168.2 THEN use .2, or .1 or .3
  4753. { 192.168.2/24;
  4754. { 192.168.2/24;
  4755. { 192.168.1/24; 192.168.3/24; }; }; };
  4756. // IF on class C 192.168.3 THEN use .3, or .1 or .2
  4757. { 192.168.3/24;
  4758. { 192.168.3/24;
  4759. { 192.168.1/24; 192.168.2/24; }; }; };
  4760. // IF .4 or .5 THEN prefer that net
  4761. { { 192.168.4/24; 192.168.5/24; };
  4762. };
  4763. };</pre>
  4764. <p>
  4765. The following example will give reasonable behavior for the
  4766. local host and hosts on directly connected networks. It is similar
  4767. to the behavior of the address sort in <acronym class="acronym">BIND</acronym> 4.9.x. Responses sent
  4768. to queries from the local host will favor any of the directly
  4769. connected
  4770. networks. Responses sent to queries from any other hosts on a
  4771. directly
  4772. connected network will prefer addresses on that same network.
  4773. Responses
  4774. to other queries will not be sorted.
  4775. </p>
  4776. <pre class="programlisting">sortlist {
  4777. { localhost; localnets; };
  4778. { localnets; };
  4779. };
  4780. </pre>
  4781. </div>
  4782. <div class="sect3" lang="en">
  4783. <div class="titlepage"><div><div><h4 class="title">
  4784. <a name="rrset_ordering"></a>RRset Ordering</h4></div></div></div>
  4785. <p>
  4786. When multiple records are returned in an answer it may be
  4787. useful to configure the order of the records placed into the
  4788. response.
  4789. The <span><strong class="command">rrset-order</strong></span> statement permits
  4790. configuration
  4791. of the ordering of the records in a multiple record response.
  4792. See also the <span><strong class="command">sortlist</strong></span> statement,
  4793. <a href="Bv9ARM.ch06.html#the_sortlist_statement" title="The sortlist Statement">the section called &#8220;The <span><strong class="command">sortlist</strong></span> Statement&#8221;</a>.
  4794. </p>
  4795. <p>
  4796. An <span><strong class="command">order_spec</strong></span> is defined as
  4797. follows:
  4798. </p>
  4799. <p>
  4800. [<span class="optional">class <em class="replaceable"><code>class_name</code></em></span>]
  4801. [<span class="optional">type <em class="replaceable"><code>type_name</code></em></span>]
  4802. [<span class="optional">name <em class="replaceable"><code>"domain_name"</code></em></span>]
  4803. order <em class="replaceable"><code>ordering</code></em>
  4804. </p>
  4805. <p>
  4806. If no class is specified, the default is <span><strong class="command">ANY</strong></span>.
  4807. If no type is specified, the default is <span><strong class="command">ANY</strong></span>.
  4808. If no name is specified, the default is "<span><strong class="command">*</strong></span>" (asterisk).
  4809. </p>
  4810. <p>
  4811. The legal values for <span><strong class="command">ordering</strong></span> are:
  4812. </p>
  4813. <div class="informaltable"><table border="1">
  4814. <colgroup>
  4815. <col>
  4816. <col>
  4817. </colgroup>
  4818. <tbody>
  4819. <tr>
  4820. <td>
  4821. <p><span><strong class="command">fixed</strong></span></p>
  4822. </td>
  4823. <td>
  4824. <p>
  4825. Records are returned in the order they
  4826. are defined in the zone file.
  4827. </p>
  4828. </td>
  4829. </tr>
  4830. <tr>
  4831. <td>
  4832. <p><span><strong class="command">random</strong></span></p>
  4833. </td>
  4834. <td>
  4835. <p>
  4836. Records are returned in some random order.
  4837. </p>
  4838. </td>
  4839. </tr>
  4840. <tr>
  4841. <td>
  4842. <p><span><strong class="command">cyclic</strong></span></p>
  4843. </td>
  4844. <td>
  4845. <p>
  4846. Records are returned in a cyclic round-robin order.
  4847. </p>
  4848. <p>
  4849. If <acronym class="acronym">BIND</acronym> is configured with the
  4850. "--enable-fixed-rrset" option at compile time, then
  4851. the initial ordering of the RRset will match the
  4852. one specified in the zone file.
  4853. </p>
  4854. </td>
  4855. </tr>
  4856. </tbody>
  4857. </table></div>
  4858. <p>
  4859. For example:
  4860. </p>
  4861. <pre class="programlisting">rrset-order {
  4862. class IN type A name "host.example.com" order random;
  4863. order cyclic;
  4864. };
  4865. </pre>
  4866. <p>
  4867. will cause any responses for type A records in class IN that
  4868. have "<code class="literal">host.example.com</code>" as a
  4869. suffix, to always be returned
  4870. in random order. All other records are returned in cyclic order.
  4871. </p>
  4872. <p>
  4873. If multiple <span><strong class="command">rrset-order</strong></span> statements
  4874. appear,
  4875. they are not combined &#8212; the last one applies.
  4876. </p>
  4877. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  4878. <h3 class="title">Note</h3>
  4879. <p>
  4880. In this release of <acronym class="acronym">BIND</acronym> 9, the
  4881. <span><strong class="command">rrset-order</strong></span> statement does not support
  4882. "fixed" ordering by default. Fixed ordering can be enabled
  4883. at compile time by specifying "--enable-fixed-rrset" on
  4884. the "configure" command line.
  4885. </p>
  4886. </div>
  4887. </div>
  4888. <div class="sect3" lang="en">
  4889. <div class="titlepage"><div><div><h4 class="title">
  4890. <a name="tuning"></a>Tuning</h4></div></div></div>
  4891. <div class="variablelist"><dl>
  4892. <dt><span class="term"><span><strong class="command">lame-ttl</strong></span></span></dt>
  4893. <dd>
  4894. <p>
  4895. Sets the number of seconds to cache a
  4896. lame server indication. 0 disables caching. (This is
  4897. <span class="bold"><strong>NOT</strong></span> recommended.)
  4898. The default is <code class="literal">600</code> (10 minutes) and the
  4899. maximum value is
  4900. <code class="literal">1800</code> (30 minutes).
  4901. </p>
  4902. <p>
  4903. Lame-ttl also controls the amount of time DNSSEC
  4904. validation failures are cached. There is a minimum
  4905. of 30 seconds applied to bad cache entries if the
  4906. lame-ttl is set to less than 30 seconds.
  4907. </p>
  4908. </dd>
  4909. <dt><span class="term"><span><strong class="command">max-ncache-ttl</strong></span></span></dt>
  4910. <dd><p>
  4911. To reduce network traffic and increase performance,
  4912. the server stores negative answers. <span><strong class="command">max-ncache-ttl</strong></span> is
  4913. used to set a maximum retention time for these answers in
  4914. the server
  4915. in seconds. The default
  4916. <span><strong class="command">max-ncache-ttl</strong></span> is <code class="literal">10800</code> seconds (3 hours).
  4917. <span><strong class="command">max-ncache-ttl</strong></span> cannot exceed
  4918. 7 days and will
  4919. be silently truncated to 7 days if set to a greater value.
  4920. </p></dd>
  4921. <dt><span class="term"><span><strong class="command">max-cache-ttl</strong></span></span></dt>
  4922. <dd><p>
  4923. Sets the maximum time for which the server will
  4924. cache ordinary (positive) answers. The default is
  4925. one week (7 days).
  4926. A value of zero may cause all queries to return
  4927. SERVFAIL, because of lost caches of intermediate
  4928. RRsets (such as NS and glue AAAA/A records) in the
  4929. resolution process.
  4930. </p></dd>
  4931. <dt><span class="term"><span><strong class="command">min-roots</strong></span></span></dt>
  4932. <dd>
  4933. <p>
  4934. The minimum number of root servers that
  4935. is required for a request for the root servers to be
  4936. accepted. The default
  4937. is <strong class="userinput"><code>2</code></strong>.
  4938. </p>
  4939. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  4940. <h3 class="title">Note</h3>
  4941. <p>
  4942. Not implemented in <acronym class="acronym">BIND</acronym> 9.
  4943. </p>
  4944. </div>
  4945. </dd>
  4946. <dt><span class="term"><span><strong class="command">sig-validity-interval</strong></span></span></dt>
  4947. <dd>
  4948. <p>
  4949. Specifies the number of days into the future when
  4950. DNSSEC signatures automatically generated as a
  4951. result of dynamic updates (<a href="Bv9ARM.ch04.html#dynamic_update" title="Dynamic Update">the section called &#8220;Dynamic Update&#8221;</a>) will expire. There
  4952. is an optional second field which specifies how
  4953. long before expiry that the signatures will be
  4954. regenerated. If not specified, the signatures will
  4955. be regenerated at 1/4 of base interval. The second
  4956. field is specified in days if the base interval is
  4957. greater than 7 days otherwise it is specified in hours.
  4958. The default base interval is <code class="literal">30</code> days
  4959. giving a re-signing interval of 7 1/2 days. The maximum
  4960. values are 10 years (3660 days).
  4961. </p>
  4962. <p>
  4963. The signature inception time is unconditionally
  4964. set to one hour before the current time to allow
  4965. for a limited amount of clock skew.
  4966. </p>
  4967. <p>
  4968. The <span><strong class="command">sig-validity-interval</strong></span>
  4969. should be, at least, several multiples of the SOA
  4970. expire interval to allow for reasonable interaction
  4971. between the various timer and expiry dates.
  4972. </p>
  4973. </dd>
  4974. <dt><span class="term"><span><strong class="command">sig-signing-nodes</strong></span></span></dt>
  4975. <dd><p>
  4976. Specify the maximum number of nodes to be
  4977. examined in each quantum when signing a zone with
  4978. a new DNSKEY. The default is
  4979. <code class="literal">100</code>.
  4980. </p></dd>
  4981. <dt><span class="term"><span><strong class="command">sig-signing-signatures</strong></span></span></dt>
  4982. <dd><p>
  4983. Specify a threshold number of signatures that
  4984. will terminate processing a quantum when signing
  4985. a zone with a new DNSKEY. The default is
  4986. <code class="literal">10</code>.
  4987. </p></dd>
  4988. <dt><span class="term"><span><strong class="command">sig-signing-type</strong></span></span></dt>
  4989. <dd>
  4990. <p>
  4991. Specify a private RDATA type to be used when generating
  4992. key signing records. The default is
  4993. <code class="literal">65534</code>.
  4994. </p>
  4995. <p>
  4996. It is expected that this parameter may be removed
  4997. in a future version once there is a standard type.
  4998. </p>
  4999. </dd>
  5000. <dt>
  5001. <span class="term"><span><strong class="command">min-refresh-time</strong></span>, </span><span class="term"><span><strong class="command">max-refresh-time</strong></span>, </span><span class="term"><span><strong class="command">min-retry-time</strong></span>, </span><span class="term"><span><strong class="command">max-retry-time</strong></span></span>
  5002. </dt>
  5003. <dd>
  5004. <p>
  5005. These options control the server's behavior on refreshing a
  5006. zone
  5007. (querying for SOA changes) or retrying failed transfers.
  5008. Usually the SOA values for the zone are used, but these
  5009. values
  5010. are set by the master, giving slave server administrators
  5011. little
  5012. control over their contents.
  5013. </p>
  5014. <p>
  5015. These options allow the administrator to set a minimum and
  5016. maximum
  5017. refresh and retry time either per-zone, per-view, or
  5018. globally.
  5019. These options are valid for slave and stub zones,
  5020. and clamp the SOA refresh and retry times to the specified
  5021. values.
  5022. </p>
  5023. <p>
  5024. The following defaults apply.
  5025. <span><strong class="command">min-refresh-time</strong></span> 300 seconds,
  5026. <span><strong class="command">max-refresh-time</strong></span> 2419200 seconds
  5027. (4 weeks), <span><strong class="command">min-retry-time</strong></span> 500 seconds,
  5028. and <span><strong class="command">max-retry-time</strong></span> 1209600 seconds
  5029. (2 weeks).
  5030. </p>
  5031. </dd>
  5032. <dt><span class="term"><span><strong class="command">edns-udp-size</strong></span></span></dt>
  5033. <dd>
  5034. <p>
  5035. Sets the advertised EDNS UDP buffer size in bytes
  5036. to control the size of packets received.
  5037. Valid values are 512 to 4096 (values outside this range
  5038. will be silently adjusted). The default value
  5039. is 4096. The usual reason for setting
  5040. <span><strong class="command">edns-udp-size</strong></span> to a non-default
  5041. value is to get UDP answers to pass through broken
  5042. firewalls that block fragmented packets and/or
  5043. block UDP packets that are greater than 512 bytes.
  5044. </p>
  5045. <p>
  5046. <span><strong class="command">named</strong></span> will fallback to using 512 bytes
  5047. if it get a series of timeout at the initial value. 512
  5048. bytes is not being offered to encourage sites to fix their
  5049. firewalls. Small EDNS UDP sizes will result in the
  5050. excessive use of TCP.
  5051. </p>
  5052. </dd>
  5053. <dt><span class="term"><span><strong class="command">max-udp-size</strong></span></span></dt>
  5054. <dd>
  5055. <p>
  5056. Sets the maximum EDNS UDP message size
  5057. <span><strong class="command">named</strong></span> will send in bytes.
  5058. Valid values are 512 to 4096 (values outside this
  5059. range will be silently adjusted). The default
  5060. value is 4096. The usual reason for setting
  5061. <span><strong class="command">max-udp-size</strong></span> to a non-default
  5062. value is to get UDP answers to pass through broken
  5063. firewalls that block fragmented packets and/or
  5064. block UDP packets that are greater than 512 bytes.
  5065. This is independent of the advertised receive
  5066. buffer (<span><strong class="command">edns-udp-size</strong></span>).
  5067. </p>
  5068. <p>
  5069. Setting this to a low value will encourage additional
  5070. TCP traffic to the nameserver.
  5071. </p>
  5072. </dd>
  5073. <dt><span class="term"><span><strong class="command">masterfile-format</strong></span></span></dt>
  5074. <dd><p>Specifies
  5075. the file format of zone files (see
  5076. <a href="Bv9ARM.ch06.html#zonefile_format" title="Additional File Formats">the section called &#8220;Additional File Formats&#8221;</a>).
  5077. The default value is <code class="constant">text</code>, which is the
  5078. standard textual representation. Files in other formats
  5079. than <code class="constant">text</code> are typically expected
  5080. to be generated by the <span><strong class="command">named-compilezone</strong></span> tool.
  5081. Note that when a zone file in a different format than
  5082. <code class="constant">text</code> is loaded, <span><strong class="command">named</strong></span>
  5083. may omit some of the checks which would be performed for a
  5084. file in the <code class="constant">text</code> format. In particular,
  5085. <span><strong class="command">check-names</strong></span> checks do not apply
  5086. for the <code class="constant">raw</code> format. This means
  5087. a zone file in the <code class="constant">raw</code> format
  5088. must be generated with the same check level as that
  5089. specified in the <span><strong class="command">named</strong></span> configuration
  5090. file. This statement sets the
  5091. <span><strong class="command">masterfile-format</strong></span> for all zones,
  5092. but can be overridden on a per-zone or per-view basis
  5093. by including a <span><strong class="command">masterfile-format</strong></span>
  5094. statement within the <span><strong class="command">zone</strong></span> or
  5095. <span><strong class="command">view</strong></span> block in the configuration
  5096. file.
  5097. </p></dd>
  5098. <dt>
  5099. <a name="clients-per-query"></a><span class="term"><span><strong class="command">clients-per-query</strong></span>, </span><span class="term"><span><strong class="command">max-clients-per-query</strong></span></span>
  5100. </dt>
  5101. <dd>
  5102. <p>These set the
  5103. initial value (minimum) and maximum number of recursive
  5104. simultaneous clients for any given query
  5105. (&lt;qname,qtype,qclass&gt;) that the server will accept
  5106. before dropping additional clients. <span><strong class="command">named</strong></span> will attempt to
  5107. self tune this value and changes will be logged. The
  5108. default values are 10 and 100.
  5109. </p>
  5110. <p>
  5111. This value should reflect how many queries come in for
  5112. a given name in the time it takes to resolve that name.
  5113. If the number of queries exceed this value, <span><strong class="command">named</strong></span> will
  5114. assume that it is dealing with a non-responsive zone
  5115. and will drop additional queries. If it gets a response
  5116. after dropping queries, it will raise the estimate. The
  5117. estimate will then be lowered in 20 minutes if it has
  5118. remained unchanged.
  5119. </p>
  5120. <p>
  5121. If <span><strong class="command">clients-per-query</strong></span> is set to zero,
  5122. then there is no limit on the number of clients per query
  5123. and no queries will be dropped.
  5124. </p>
  5125. <p>
  5126. If <span><strong class="command">max-clients-per-query</strong></span> is set to zero,
  5127. then there is no upper bound other than imposed by
  5128. <span><strong class="command">recursive-clients</strong></span>.
  5129. </p>
  5130. </dd>
  5131. <dt><span class="term"><span><strong class="command">notify-delay</strong></span></span></dt>
  5132. <dd>
  5133. <p>
  5134. The delay, in seconds, between sending sets of notify
  5135. messages for a zone. The default is five (5) seconds.
  5136. </p>
  5137. <p>
  5138. The overall rate that NOTIFY messages are sent for all
  5139. zones is controlled by <span><strong class="command">serial-query-rate</strong></span>.
  5140. </p>
  5141. </dd>
  5142. </dl></div>
  5143. </div>
  5144. <div class="sect3" lang="en">
  5145. <div class="titlepage"><div><div><h4 class="title">
  5146. <a name="builtin"></a>Built-in server information zones</h4></div></div></div>
  5147. <p>
  5148. The server provides some helpful diagnostic information
  5149. through a number of built-in zones under the
  5150. pseudo-top-level-domain <code class="literal">bind</code> in the
  5151. <span><strong class="command">CHAOS</strong></span> class. These zones are part
  5152. of a
  5153. built-in view (see <a href="Bv9ARM.ch06.html#view_statement_grammar" title="view Statement Grammar">the section called &#8220;<span><strong class="command">view</strong></span> Statement Grammar&#8221;</a>) of
  5154. class
  5155. <span><strong class="command">CHAOS</strong></span> which is separate from the
  5156. default view of
  5157. class <span><strong class="command">IN</strong></span>; therefore, any global
  5158. server options
  5159. such as <span><strong class="command">allow-query</strong></span> do not apply
  5160. the these zones.
  5161. If you feel the need to disable these zones, use the options
  5162. below, or hide the built-in <span><strong class="command">CHAOS</strong></span>
  5163. view by
  5164. defining an explicit view of class <span><strong class="command">CHAOS</strong></span>
  5165. that matches all clients.
  5166. </p>
  5167. <div class="variablelist"><dl>
  5168. <dt><span class="term"><span><strong class="command">version</strong></span></span></dt>
  5169. <dd><p>
  5170. The version the server should report
  5171. via a query of the name <code class="literal">version.bind</code>
  5172. with type <span><strong class="command">TXT</strong></span>, class <span><strong class="command">CHAOS</strong></span>.
  5173. The default is the real version number of this server.
  5174. Specifying <span><strong class="command">version none</strong></span>
  5175. disables processing of the queries.
  5176. </p></dd>
  5177. <dt><span class="term"><span><strong class="command">hostname</strong></span></span></dt>
  5178. <dd><p>
  5179. The hostname the server should report via a query of
  5180. the name <code class="filename">hostname.bind</code>
  5181. with type <span><strong class="command">TXT</strong></span>, class <span><strong class="command">CHAOS</strong></span>.
  5182. This defaults to the hostname of the machine hosting the
  5183. name server as
  5184. found by the gethostname() function. The primary purpose of such queries
  5185. is to
  5186. identify which of a group of anycast servers is actually
  5187. answering your queries. Specifying <span><strong class="command">hostname none;</strong></span>
  5188. disables processing of the queries.
  5189. </p></dd>
  5190. <dt><span class="term"><span><strong class="command">server-id</strong></span></span></dt>
  5191. <dd><p>
  5192. The ID the server should report when receiving a Name
  5193. Server Identifier (NSID) query, or a query of the name
  5194. <code class="filename">ID.SERVER</code> with type
  5195. <span><strong class="command">TXT</strong></span>, class <span><strong class="command">CHAOS</strong></span>.
  5196. The primary purpose of such queries is to
  5197. identify which of a group of anycast servers is actually
  5198. answering your queries. Specifying <span><strong class="command">server-id none;</strong></span>
  5199. disables processing of the queries.
  5200. Specifying <span><strong class="command">server-id hostname;</strong></span> will cause <span><strong class="command">named</strong></span> to
  5201. use the hostname as found by the gethostname() function.
  5202. The default <span><strong class="command">server-id</strong></span> is <span><strong class="command">none</strong></span>.
  5203. </p></dd>
  5204. </dl></div>
  5205. </div>
  5206. <div class="sect3" lang="en">
  5207. <div class="titlepage"><div><div><h4 class="title">
  5208. <a name="empty"></a>Built-in Empty Zones</h4></div></div></div>
  5209. <p>
  5210. Named has some built-in empty zones (SOA and NS records only).
  5211. These are for zones that should normally be answered locally
  5212. and which queries should not be sent to the Internet's root
  5213. servers. The official servers which cover these namespaces
  5214. return NXDOMAIN responses to these queries. In particular,
  5215. these cover the reverse namespaces for addresses from
  5216. RFC 1918, RFC 4193, and RFC 5737. They also include the
  5217. reverse namespace for IPv6 local address (locally assigned),
  5218. IPv6 link local addresses, the IPv6 loopback address and the
  5219. IPv6 unknown address.
  5220. </p>
  5221. <p>
  5222. Named will attempt to determine if a built-in zone already exists
  5223. or is active (covered by a forward-only forwarding declaration)
  5224. and will not create an empty zone in that case.
  5225. </p>
  5226. <p>
  5227. The current list of empty zones is:
  5228. </p>
  5229. <div class="itemizedlist"><ul type="disc">
  5230. <li>10.IN-ADDR.ARPA</li>
  5231. <li>16.172.IN-ADDR.ARPA</li>
  5232. <li>17.172.IN-ADDR.ARPA</li>
  5233. <li>18.172.IN-ADDR.ARPA</li>
  5234. <li>19.172.IN-ADDR.ARPA</li>
  5235. <li>20.172.IN-ADDR.ARPA</li>
  5236. <li>21.172.IN-ADDR.ARPA</li>
  5237. <li>22.172.IN-ADDR.ARPA</li>
  5238. <li>23.172.IN-ADDR.ARPA</li>
  5239. <li>24.172.IN-ADDR.ARPA</li>
  5240. <li>25.172.IN-ADDR.ARPA</li>
  5241. <li>26.172.IN-ADDR.ARPA</li>
  5242. <li>27.172.IN-ADDR.ARPA</li>
  5243. <li>28.172.IN-ADDR.ARPA</li>
  5244. <li>29.172.IN-ADDR.ARPA</li>
  5245. <li>30.172.IN-ADDR.ARPA</li>
  5246. <li>31.172.IN-ADDR.ARPA</li>
  5247. <li>168.192.IN-ADDR.ARPA</li>
  5248. <li>0.IN-ADDR.ARPA</li>
  5249. <li>127.IN-ADDR.ARPA</li>
  5250. <li>254.169.IN-ADDR.ARPA</li>
  5251. <li>2.0.192.IN-ADDR.ARPA</li>
  5252. <li>100.51.198.IN-ADDR.ARPA</li>
  5253. <li>113.0.203.IN-ADDR.ARPA</li>
  5254. <li>255.255.255.255.IN-ADDR.ARPA</li>
  5255. <li>0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.IP6.ARPA</li>
  5256. <li>1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.IP6.ARPA</li>
  5257. <li>8.B.D.0.1.0.0.2.IP6.ARPA</li>
  5258. <li>D.F.IP6.ARPA</li>
  5259. <li>8.E.F.IP6.ARPA</li>
  5260. <li>9.E.F.IP6.ARPA</li>
  5261. <li>A.E.F.IP6.ARPA</li>
  5262. <li>B.E.F.IP6.ARPA</li>
  5263. </ul></div>
  5264. <p>
  5265. </p>
  5266. <p>
  5267. Empty zones are settable at the view level and only apply to
  5268. views of class IN. Disabled empty zones are only inherited
  5269. from options if there are no disabled empty zones specified
  5270. at the view level. To override the options list of disabled
  5271. zones, you can disable the root zone at the view level, for example:
  5272. </p>
  5273. <pre class="programlisting">
  5274. disable-empty-zone ".";
  5275. </pre>
  5276. <p>
  5277. </p>
  5278. <p>
  5279. If you are using the address ranges covered here, you should
  5280. already have reverse zones covering the addresses you use.
  5281. In practice this appears to not be the case with many queries
  5282. being made to the infrastructure servers for names in these
  5283. spaces. So many in fact that sacrificial servers were needed
  5284. to be deployed to channel the query load away from the
  5285. infrastructure servers.
  5286. </p>
  5287. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  5288. <h3 class="title">Note</h3>
  5289. The real parent servers for these zones should disable all
  5290. empty zone under the parent zone they serve. For the real
  5291. root servers, this is all built-in empty zones. This will
  5292. enable them to return referrals to deeper in the tree.
  5293. </div>
  5294. <div class="variablelist"><dl>
  5295. <dt><span class="term"><span><strong class="command">empty-server</strong></span></span></dt>
  5296. <dd><p>
  5297. Specify what server name will appear in the returned
  5298. SOA record for empty zones. If none is specified, then
  5299. the zone's name will be used.
  5300. </p></dd>
  5301. <dt><span class="term"><span><strong class="command">empty-contact</strong></span></span></dt>
  5302. <dd><p>
  5303. Specify what contact name will appear in the returned
  5304. SOA record for empty zones. If none is specified, then
  5305. "." will be used.
  5306. </p></dd>
  5307. <dt><span class="term"><span><strong class="command">empty-zones-enable</strong></span></span></dt>
  5308. <dd><p>
  5309. Enable or disable all empty zones. By default, they
  5310. are enabled.
  5311. </p></dd>
  5312. <dt><span class="term"><span><strong class="command">disable-empty-zone</strong></span></span></dt>
  5313. <dd><p>
  5314. Disable individual empty zones. By default, none are
  5315. disabled. This option can be specified multiple times.
  5316. </p></dd>
  5317. </dl></div>
  5318. </div>
  5319. <div class="sect3" lang="en">
  5320. <div class="titlepage"><div><div><h4 class="title">
  5321. <a name="acache"></a>Additional Section Caching</h4></div></div></div>
  5322. <p>
  5323. The additional section cache, also called <span><strong class="command">acache</strong></span>,
  5324. is an internal cache to improve the response performance of BIND 9.
  5325. When additional section caching is enabled, BIND 9 will
  5326. cache an internal short-cut to the additional section content for
  5327. each answer RR.
  5328. Note that <span><strong class="command">acache</strong></span> is an internal caching
  5329. mechanism of BIND 9, and is not related to the DNS caching
  5330. server function.
  5331. </p>
  5332. <p>
  5333. Additional section caching does not change the
  5334. response content (except the RRsets ordering of the additional
  5335. section, see below), but can improve the response performance
  5336. significantly.
  5337. It is particularly effective when BIND 9 acts as an authoritative
  5338. server for a zone that has many delegations with many glue RRs.
  5339. </p>
  5340. <p>
  5341. In order to obtain the maximum performance improvement
  5342. from additional section caching, setting
  5343. <span><strong class="command">additional-from-cache</strong></span>
  5344. to <span><strong class="command">no</strong></span> is recommended, since the current
  5345. implementation of <span><strong class="command">acache</strong></span>
  5346. does not short-cut of additional section information from the
  5347. DNS cache data.
  5348. </p>
  5349. <p>
  5350. One obvious disadvantage of <span><strong class="command">acache</strong></span> is
  5351. that it requires much more
  5352. memory for the internal cached data.
  5353. Thus, if the response performance does not matter and memory
  5354. consumption is much more critical, the
  5355. <span><strong class="command">acache</strong></span> mechanism can be
  5356. disabled by setting <span><strong class="command">acache-enable</strong></span> to
  5357. <span><strong class="command">no</strong></span>.
  5358. It is also possible to specify the upper limit of memory
  5359. consumption
  5360. for acache by using <span><strong class="command">max-acache-size</strong></span>.
  5361. </p>
  5362. <p>
  5363. Additional section caching also has a minor effect on the
  5364. RRset ordering in the additional section.
  5365. Without <span><strong class="command">acache</strong></span>,
  5366. <span><strong class="command">cyclic</strong></span> order is effective for the additional
  5367. section as well as the answer and authority sections.
  5368. However, additional section caching fixes the ordering when it
  5369. first caches an RRset for the additional section, and the same
  5370. ordering will be kept in succeeding responses, regardless of the
  5371. setting of <span><strong class="command">rrset-order</strong></span>.
  5372. The effect of this should be minor, however, since an
  5373. RRset in the additional section
  5374. typically only contains a small number of RRs (and in many cases
  5375. it only contains a single RR), in which case the
  5376. ordering does not matter much.
  5377. </p>
  5378. <p>
  5379. The following is a summary of options related to
  5380. <span><strong class="command">acache</strong></span>.
  5381. </p>
  5382. <div class="variablelist"><dl>
  5383. <dt><span class="term"><span><strong class="command">acache-enable</strong></span></span></dt>
  5384. <dd><p>
  5385. If <span><strong class="command">yes</strong></span>, additional section caching is
  5386. enabled. The default value is <span><strong class="command">no</strong></span>.
  5387. </p></dd>
  5388. <dt><span class="term"><span><strong class="command">acache-cleaning-interval</strong></span></span></dt>
  5389. <dd><p>
  5390. The server will remove stale cache entries, based on an LRU
  5391. based
  5392. algorithm, every <span><strong class="command">acache-cleaning-interval</strong></span> minutes.
  5393. The default is 60 minutes.
  5394. If set to 0, no periodic cleaning will occur.
  5395. </p></dd>
  5396. <dt><span class="term"><span><strong class="command">max-acache-size</strong></span></span></dt>
  5397. <dd><p>
  5398. The maximum amount of memory in bytes to use for the server's acache.
  5399. When the amount of data in the acache reaches this limit,
  5400. the server
  5401. will clean more aggressively so that the limit is not
  5402. exceeded.
  5403. In a server with multiple views, the limit applies
  5404. separately to the
  5405. acache of each view.
  5406. The default is <code class="literal">16M</code>.
  5407. </p></dd>
  5408. </dl></div>
  5409. </div>
  5410. <div class="sect3" lang="en">
  5411. <div class="titlepage"><div><div><h4 class="title">
  5412. <a name="id2588188"></a>Content Filtering</h4></div></div></div>
  5413. <p>
  5414. <acronym class="acronym">BIND</acronym> 9 provides the ability to filter
  5415. out DNS responses from external DNS servers containing
  5416. certain types of data in the answer section.
  5417. Specifically, it can reject address (A or AAAA) records if
  5418. the corresponding IPv4 or IPv6 addresses match the given
  5419. <code class="varname">address_match_list</code> of the
  5420. <span><strong class="command">deny-answer-addresses</strong></span> option.
  5421. It can also reject CNAME or DNAME records if the "alias"
  5422. name (i.e., the CNAME alias or the substituted query name
  5423. due to DNAME) matches the
  5424. given <code class="varname">namelist</code> of the
  5425. <span><strong class="command">deny-answer-aliases</strong></span> option, where
  5426. "match" means the alias name is a subdomain of one of
  5427. the <code class="varname">name_list</code> elements.
  5428. If the optional <code class="varname">namelist</code> is specified
  5429. with <span><strong class="command">except-from</strong></span>, records whose query name
  5430. matches the list will be accepted regardless of the filter
  5431. setting.
  5432. Likewise, if the alias name is a subdomain of the
  5433. corresponding zone, the <span><strong class="command">deny-answer-aliases</strong></span>
  5434. filter will not apply;
  5435. for example, even if "example.com" is specified for
  5436. <span><strong class="command">deny-answer-aliases</strong></span>,
  5437. </p>
  5438. <pre class="programlisting">www.example.com. CNAME xxx.example.com.</pre>
  5439. <p>
  5440. returned by an "example.com" server will be accepted.
  5441. </p>
  5442. <p>
  5443. In the <code class="varname">address_match_list</code> of the
  5444. <span><strong class="command">deny-answer-addresses</strong></span> option, only
  5445. <code class="varname">ip_addr</code>
  5446. and <code class="varname">ip_prefix</code>
  5447. are meaningful;
  5448. any <code class="varname">key_id</code> will be silently ignored.
  5449. </p>
  5450. <p>
  5451. If a response message is rejected due to the filtering,
  5452. the entire message is discarded without being cached, and
  5453. a SERVFAIL error will be returned to the client.
  5454. </p>
  5455. <p>
  5456. This filtering is intended to prevent "DNS rebinding attacks," in
  5457. which an attacker, in response to a query for a domain name the
  5458. attacker controls, returns an IP address within your own network or
  5459. an alias name within your own domain.
  5460. A naive web browser or script could then serve as an
  5461. unintended proxy, allowing the attacker
  5462. to get access to an internal node of your local network
  5463. that couldn't be externally accessed otherwise.
  5464. See the paper available at
  5465. <a href="" target="_top">
  5466. http://portal.acm.org/citation.cfm?id=1315245.1315298
  5467. </a>
  5468. for more details about the attacks.
  5469. </p>
  5470. <p>
  5471. For example, if you own a domain named "example.net" and
  5472. your internal network uses an IPv4 prefix 192.0.2.0/24,
  5473. you might specify the following rules:
  5474. </p>
  5475. <pre class="programlisting">deny-answer-addresses { 192.0.2.0/24; } except-from { "example.net"; };
  5476. deny-answer-aliases { "example.net"; };
  5477. </pre>
  5478. <p>
  5479. If an external attacker lets a web browser in your local
  5480. network look up an IPv4 address of "attacker.example.com",
  5481. the attacker's DNS server would return a response like this:
  5482. </p>
  5483. <pre class="programlisting">attacker.example.com. A 192.0.2.1</pre>
  5484. <p>
  5485. in the answer section.
  5486. Since the rdata of this record (the IPv4 address) matches
  5487. the specified prefix 192.0.2.0/24, this response will be
  5488. ignored.
  5489. </p>
  5490. <p>
  5491. On the other hand, if the browser looks up a legitimate
  5492. internal web server "www.example.net" and the
  5493. following response is returned to
  5494. the <acronym class="acronym">BIND</acronym> 9 server
  5495. </p>
  5496. <pre class="programlisting">www.example.net. A 192.0.2.2</pre>
  5497. <p>
  5498. it will be accepted since the owner name "www.example.net"
  5499. matches the <span><strong class="command">except-from</strong></span> element,
  5500. "example.net".
  5501. </p>
  5502. <p>
  5503. Note that this is not really an attack on the DNS per se.
  5504. In fact, there is nothing wrong for an "external" name to
  5505. be mapped to your "internal" IP address or domain name
  5506. from the DNS point of view.
  5507. It might actually be provided for a legitimate purpose,
  5508. such as for debugging.
  5509. As long as the mapping is provided by the correct owner,
  5510. it is not possible or does not make sense to detect
  5511. whether the intent of the mapping is legitimate or not
  5512. within the DNS.
  5513. The "rebinding" attack must primarily be protected at the
  5514. application that uses the DNS.
  5515. For a large site, however, it may be difficult to protect
  5516. all possible applications at once.
  5517. This filtering feature is provided only to help such an
  5518. operational environment;
  5519. it is generally discouraged to turn it on unless you are
  5520. very sure you have no other choice and the attack is a
  5521. real threat for your applications.
  5522. </p>
  5523. <p>
  5524. Care should be particularly taken if you want to use this
  5525. option for addresses within 127.0.0.0/8.
  5526. These addresses are obviously "internal", but many
  5527. applications conventionally rely on a DNS mapping from
  5528. some name to such an address.
  5529. Filtering out DNS records containing this address
  5530. spuriously can break such applications.
  5531. </p>
  5532. </div>
  5533. <div class="sect3" lang="en">
  5534. <div class="titlepage"><div><div><h4 class="title">
  5535. <a name="id2588379"></a>Response Policy Zone (RPZ) Rewriting</h4></div></div></div>
  5536. <p>
  5537. <acronym class="acronym">BIND</acronym> 9 includes an intentionally limited
  5538. mechanism to modify DNS responses for recursive requests
  5539. somewhat similar to email anti-spam DNS blacklists.
  5540. Responses can be changed to deny the existence of domains(NXDOMAIN),
  5541. deny the existence of IP addresses for domains (NODATA),
  5542. or contain other IP addresses or data.
  5543. </p>
  5544. <p>
  5545. The actions encoded in a response policy zone (RPZ) are applied
  5546. only to queries that ask for recursion (RD=1).
  5547. Response policy zones are named in the
  5548. <span><strong class="command">response-policy</strong></span> option for the view or among the
  5549. global options if there is no response-policy option for the view.
  5550. RPZs are ordinary DNS zones containing RRsets
  5551. that can be queried normally if allowed.
  5552. It is usually best to restrict those queries with something like
  5553. <span><strong class="command">allow-query { localhost; };</strong></span>.
  5554. </p>
  5555. <p>
  5556. There are four kinds of RPZ records, QNAME, IP, NSIP,
  5557. and NSDNAME.
  5558. QNAME records are applied to query names of requests and targets
  5559. of CNAME records resolved to generate the response.
  5560. The owner name of a QNAME RPZ record is the query name relativized
  5561. to the RPZ.
  5562. </p>
  5563. <p>
  5564. The second kind of RPZ record, an IP policy record,
  5565. is triggered by addresses in A and AAAA records
  5566. for the ANSWER sections of responses.
  5567. IP policy records have owner names that are
  5568. subdomains of <strong class="userinput"><code>rpz-ip</code></strong> relativized to the
  5569. RPZ origin name and encode an IP address or address block.
  5570. IPv4 addresses are encoded as
  5571. <strong class="userinput"><code>prefixlength.B4.B3.B2.B1.rpz-ip</code></strong>.
  5572. The prefix length must be between 1 and 32.
  5573. All four bytes, B4, B3, B2, and B1, must be present.
  5574. B4 is the decimal value of the least significant byte of the
  5575. IPv4 address as in IN-ADDR.ARPA.
  5576. IPv6 addresses are encoded in a format similar to the standard
  5577. IPv6 text representation,
  5578. <strong class="userinput"><code>prefixlength.W8.W7.W6.W5.W4.W3.W2.W1.rpz-ip</code></strong>.
  5579. Each of W8,...,W1 is a one to four digit hexadecimal number
  5580. representing 16 bits of the IPv6 address as in the standard text
  5581. representation of IPv6 addresses, but reversed as in IN-ADDR.ARPA.
  5582. All 8 words must be present except when consecutive
  5583. zero words are replaced with <strong class="userinput"><code>.zz.</code></strong>
  5584. analogous to double colons (::) in standard IPv6 text encodings.
  5585. The prefix length must be between 1 and 128.
  5586. </p>
  5587. <p>
  5588. NSDNAME policy records match names of authoritative servers
  5589. for the query name, a parent of the query name, a CNAME,
  5590. or a parent of a CNAME.
  5591. They are encoded as subdomains of
  5592. <strong class="userinput"><code>rpz-nsdomain</code></strong> relativized
  5593. to the RPZ origin name.
  5594. </p>
  5595. <p>
  5596. NSIP policy records match IP addresses in A and AAAA RRsets
  5597. for domains that can be checked against NSDNAME policy records.
  5598. The are encoded like IP policies except as subdomains of
  5599. <strong class="userinput"><code>rpz-nsip</code></strong>.
  5600. </p>
  5601. <p>
  5602. The query response is checked against all RPZs, so
  5603. two or more policy records can apply to a single response.
  5604. Because DNS responses can be rewritten according by at most a
  5605. single policy record, a single policy (other than
  5606. <span><strong class="command">DISABLED</strong></span> policies) must be chosen.
  5607. Policies are chosen in the following order:
  5608. </p>
  5609. <div class="itemizedlist"><ul type="disc">
  5610. <li>Among applicable zones, use the RPZ that appears first
  5611. in the response-policy option.
  5612. </li>
  5613. <li>Prefer QNAME to IP to NSDNAME to NSIP policy records
  5614. in a single RPZ
  5615. </li>
  5616. <li>Among applicable NSDNAME policy records, prefer the
  5617. policy record that matches the lexically smallest name
  5618. </li>
  5619. <li>Among IP or NSIP policy records, prefer the record
  5620. with the longest prefix.
  5621. </li>
  5622. <li>Among records with the same prefex length,
  5623. prefer the IP or NSIP policy record that matches
  5624. the smallest IP address.
  5625. </li>
  5626. </ul></div>
  5627. <p>
  5628. </p>
  5629. <p>
  5630. When the processing of a response is restarted to resolve
  5631. DNAME or CNAME records and an applicable policy record set has
  5632. not been found,
  5633. all RPZs are again consulted for the DNAME or CNAME names
  5634. and addresses.
  5635. </p>
  5636. <p>
  5637. Authority verification issues and variations in authority data
  5638. can cause inconsistent results for NSIP and NSDNAME policy records.
  5639. Glue NS records often differ from authoritative NS records.
  5640. So they are available
  5641. only when <acronym class="acronym">BIND</acronym> is built with the
  5642. <strong class="userinput"><code>--enable-rpz-nsip</code></strong> or
  5643. <strong class="userinput"><code>--enable-rpz-nsdname</code></strong> options
  5644. on the "configure" command line.
  5645. </p>
  5646. <p>
  5647. RPZ record sets are special CNAME records or one or more
  5648. of any types of DNS record except DNAME or DNSSEC.
  5649. Except when a policy record is a CNAME, there can be more
  5650. more than one record and more than one type
  5651. in a set of policy records.
  5652. Except for three kinds of CNAME records that are illegal except
  5653. in policy zones, the records in a set are used in the response as if
  5654. their owner name were the query name. They are copied to the
  5655. response as dictated by their types.
  5656. </p>
  5657. <div class="itemizedlist"><ul type="disc">
  5658. <li>A CNAME whose target is the root domain (.)
  5659. specifies the <span><strong class="command">NXDOMAIN</strong></span> policy,
  5660. which generates an NXDOMAIN response.
  5661. </li>
  5662. <li>A CNAME whose target is the wildcard top-level
  5663. domain (*.) specifies the <span><strong class="command">NODATA</strong></span> policy,
  5664. which rewrites the response to NODATA or ANCOUNT=1.
  5665. </li>
  5666. <li>A CNAME whose target is a wildcard hostname such
  5667. as *.example.com is used normally after the astrisk (*)
  5668. has been replaced with the query name.
  5669. These records are usually resolved with ordinary CNAMEs
  5670. outside the policy zones. They can be useful for logging.
  5671. </li>
  5672. <li>The <span><strong class="command">PASSTHRU</strong></span> policy is specified
  5673. by a CNAME whose target is the variable part of its own
  5674. owner name. It causes the response to not be rewritten
  5675. and is most often used to "poke holes" in policies for
  5676. CIDR blocks.
  5677. </li>
  5678. </ul></div>
  5679. <p>
  5680. </p>
  5681. <p>
  5682. The policies specified in individual records
  5683. in an RPZ can be overridden with a <span><strong class="command">policy</strong></span> clause
  5684. in the <span><strong class="command">response-policy</strong></span> option.
  5685. An organization using an RPZ provided by another organization might
  5686. use this mechanism to redirect domains to its own walled garden.
  5687. </p>
  5688. <div class="itemizedlist"><ul type="disc">
  5689. <li>
  5690. <span><strong class="command">GIVEN</strong></span> says "do not override."
  5691. </li>
  5692. <li>
  5693. <span><strong class="command">DISABLED</strong></span> causes policy records to do
  5694. nothing but log what they might have done.
  5695. The response to the DNS query will be written according to
  5696. any matching policy records that are not disabled.
  5697. Policy zones overridden with <span><strong class="command">DISABLED</strong></span> should
  5698. appear first, because they will often not be logged
  5699. if a higher precedence policy is found first.
  5700. </li>
  5701. <li>
  5702. <span><strong class="command">PASSTHRU</strong></span> causes all policy records
  5703. to act as if they were CNAME records with targets the variable
  5704. part of their owner name. They protect the response from
  5705. being changed.
  5706. </li>
  5707. <li>
  5708. <span><strong class="command">NXDOMAIN</strong></span> causes all RPZ records
  5709. to specify NXDOMAIN policies.
  5710. </li>
  5711. <li>
  5712. <span><strong class="command">NODATA</strong></span> overrides with the
  5713. NODATA policy
  5714. </li>
  5715. <li>
  5716. <span><strong class="command">CNAME domain</strong></span> causes all RPZ
  5717. policy records to act as if they were "cname domain" records.
  5718. </li>
  5719. </ul></div>
  5720. <p>
  5721. </p>
  5722. <p>
  5723. For example, you might use this option statement
  5724. </p>
  5725. <pre class="programlisting"> response-policy { zone "badlist"; };</pre>
  5726. <p>
  5727. and this zone statement
  5728. </p>
  5729. <pre class="programlisting"> zone "badlist" {type master; file "master/badlist"; allow-query {none;}; };</pre>
  5730. <p>
  5731. with this zone file
  5732. </p>
  5733. <pre class="programlisting">$TTL 1H
  5734. @ SOA LOCALHOST. named-mgr.example.com (1 1h 15m 30d 2h)
  5735. NS LOCALHOST.
  5736. ; QNAME policy records. There are no periods (.) after the owner names.
  5737. nxdomain.domain.com CNAME . ; NXDOMAIN policy
  5738. nodata.domain.com CNAME *. ; NODATA policy
  5739. bad.domain.com A 10.0.0.1 ; redirect to a walled garden
  5740. AAAA 2001:2::1
  5741. ; do not rewrite (PASSTHRU) OK.DOMAIN.COM
  5742. ok.domain.com CNAME ok.domain.com.
  5743. bzone.domain.com CNAME garden.example.com.
  5744. ; redirect x.bzone.domain.com to x.bzone.domain.com.garden.example.com
  5745. *.bzone.domain.com CNAME *.garden.example.com.
  5746. ; IP policy records that rewrite all answers for 127/8 except 127.0.0.1
  5747. 8.0.0.0.127.rpz-ip CNAME .
  5748. 32.1.0.0.127.rpz-ip CNAME 32.1.0.0.127. ; PASSTHRU for 127.0.0.1
  5749. ; NSDNAME and NSIP policy records
  5750. ns.domain.com.rpz-nsdname CNAME .
  5751. 48.zz.2.2001.rpz-nsip CNAME .
  5752. </pre>
  5753. </div>
  5754. </div>
  5755. <div class="sect2" lang="en">
  5756. <div class="titlepage"><div><div><h3 class="title">
  5757. <a name="server_statement_grammar"></a><span><strong class="command">server</strong></span> Statement Grammar</h3></div></div></div>
  5758. <pre class="programlisting"><span><strong class="command">server</strong></span> <em class="replaceable"><code>ip_addr[/prefixlen]</code></em> {
  5759. [<span class="optional"> bogus <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  5760. [<span class="optional"> provide-ixfr <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  5761. [<span class="optional"> request-ixfr <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  5762. [<span class="optional"> edns <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  5763. [<span class="optional"> edns-udp-size <em class="replaceable"><code>number</code></em> ; </span>]
  5764. [<span class="optional"> max-udp-size <em class="replaceable"><code>number</code></em> ; </span>]
  5765. [<span class="optional"> transfers <em class="replaceable"><code>number</code></em> ; </span>]
  5766. [<span class="optional"> transfer-format <em class="replaceable"><code>( one-answer | many-answers )</code></em> ; ]</span>]
  5767. [<span class="optional"> keys <em class="replaceable"><code>{ string ; [<span class="optional"> string ; [<span class="optional">...</span>]</span>] }</code></em> ; </span>]
  5768. [<span class="optional"> transfer-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  5769. [<span class="optional"> transfer-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  5770. [<span class="optional"> notify-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  5771. [<span class="optional"> notify-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  5772. [<span class="optional"> query-source [<span class="optional"> address ( <em class="replaceable"><code>ip_addr</code></em> | <em class="replaceable"><code>*</code></em> ) </span>]
  5773. [<span class="optional"> port ( <em class="replaceable"><code>ip_port</code></em> | <em class="replaceable"><code>*</code></em> ) </span>]; </span>]
  5774. [<span class="optional"> query-source-v6 [<span class="optional"> address ( <em class="replaceable"><code>ip_addr</code></em> | <em class="replaceable"><code>*</code></em> ) </span>]
  5775. [<span class="optional"> port ( <em class="replaceable"><code>ip_port</code></em> | <em class="replaceable"><code>*</code></em> ) </span>]; </span>]
  5776. [<span class="optional"> use-queryport-pool <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  5777. [<span class="optional"> queryport-pool-ports <em class="replaceable"><code>number</code></em>; </span>]
  5778. [<span class="optional"> queryport-pool-updateinterval <em class="replaceable"><code>number</code></em>; </span>]
  5779. };
  5780. </pre>
  5781. </div>
  5782. <div class="sect2" lang="en">
  5783. <div class="titlepage"><div><div><h3 class="title">
  5784. <a name="server_statement_definition_and_usage"></a><span><strong class="command">server</strong></span> Statement Definition and
  5785. Usage</h3></div></div></div>
  5786. <p>
  5787. The <span><strong class="command">server</strong></span> statement defines
  5788. characteristics
  5789. to be associated with a remote name server. If a prefix length is
  5790. specified, then a range of servers is covered. Only the most
  5791. specific
  5792. server clause applies regardless of the order in
  5793. <code class="filename">named.conf</code>.
  5794. </p>
  5795. <p>
  5796. The <span><strong class="command">server</strong></span> statement can occur at
  5797. the top level of the
  5798. configuration file or inside a <span><strong class="command">view</strong></span>
  5799. statement.
  5800. If a <span><strong class="command">view</strong></span> statement contains
  5801. one or more <span><strong class="command">server</strong></span> statements, only
  5802. those
  5803. apply to the view and any top-level ones are ignored.
  5804. If a view contains no <span><strong class="command">server</strong></span>
  5805. statements,
  5806. any top-level <span><strong class="command">server</strong></span> statements are
  5807. used as
  5808. defaults.
  5809. </p>
  5810. <p>
  5811. If you discover that a remote server is giving out bad data,
  5812. marking it as bogus will prevent further queries to it. The
  5813. default
  5814. value of <span><strong class="command">bogus</strong></span> is <span><strong class="command">no</strong></span>.
  5815. </p>
  5816. <p>
  5817. The <span><strong class="command">provide-ixfr</strong></span> clause determines
  5818. whether
  5819. the local server, acting as master, will respond with an
  5820. incremental
  5821. zone transfer when the given remote server, a slave, requests it.
  5822. If set to <span><strong class="command">yes</strong></span>, incremental transfer
  5823. will be provided
  5824. whenever possible. If set to <span><strong class="command">no</strong></span>,
  5825. all transfers
  5826. to the remote server will be non-incremental. If not set, the
  5827. value
  5828. of the <span><strong class="command">provide-ixfr</strong></span> option in the
  5829. view or
  5830. global options block is used as a default.
  5831. </p>
  5832. <p>
  5833. The <span><strong class="command">request-ixfr</strong></span> clause determines
  5834. whether
  5835. the local server, acting as a slave, will request incremental zone
  5836. transfers from the given remote server, a master. If not set, the
  5837. value of the <span><strong class="command">request-ixfr</strong></span> option in
  5838. the view or
  5839. global options block is used as a default.
  5840. </p>
  5841. <p>
  5842. IXFR requests to servers that do not support IXFR will
  5843. automatically
  5844. fall back to AXFR. Therefore, there is no need to manually list
  5845. which servers support IXFR and which ones do not; the global
  5846. default
  5847. of <span><strong class="command">yes</strong></span> should always work.
  5848. The purpose of the <span><strong class="command">provide-ixfr</strong></span> and
  5849. <span><strong class="command">request-ixfr</strong></span> clauses is
  5850. to make it possible to disable the use of IXFR even when both
  5851. master
  5852. and slave claim to support it, for example if one of the servers
  5853. is buggy and crashes or corrupts data when IXFR is used.
  5854. </p>
  5855. <p>
  5856. The <span><strong class="command">edns</strong></span> clause determines whether
  5857. the local server will attempt to use EDNS when communicating
  5858. with the remote server. The default is <span><strong class="command">yes</strong></span>.
  5859. </p>
  5860. <p>
  5861. The <span><strong class="command">edns-udp-size</strong></span> option sets the EDNS UDP size
  5862. that is advertised by <span><strong class="command">named</strong></span> when querying the remote server.
  5863. Valid values are 512 to 4096 bytes (values outside this range will be
  5864. silently adjusted). This option is useful when you wish to
  5865. advertises a different value to this server than the value you
  5866. advertise globally, for example, when there is a firewall at the
  5867. remote site that is blocking large replies.
  5868. </p>
  5869. <p>
  5870. The <span><strong class="command">max-udp-size</strong></span> option sets the
  5871. maximum EDNS UDP message size <span><strong class="command">named</strong></span> will send. Valid
  5872. values are 512 to 4096 bytes (values outside this range will
  5873. be silently adjusted). This option is useful when you
  5874. know that there is a firewall that is blocking large
  5875. replies from <span><strong class="command">named</strong></span>.
  5876. </p>
  5877. <p>
  5878. The server supports two zone transfer methods. The first, <span><strong class="command">one-answer</strong></span>,
  5879. uses one DNS message per resource record transferred. <span><strong class="command">many-answers</strong></span> packs
  5880. as many resource records as possible into a message. <span><strong class="command">many-answers</strong></span> is
  5881. more efficient, but is only known to be understood by <acronym class="acronym">BIND</acronym> 9, <acronym class="acronym">BIND</acronym>
  5882. 8.x, and patched versions of <acronym class="acronym">BIND</acronym>
  5883. 4.9.5. You can specify which method
  5884. to use for a server with the <span><strong class="command">transfer-format</strong></span> option.
  5885. If <span><strong class="command">transfer-format</strong></span> is not
  5886. specified, the <span><strong class="command">transfer-format</strong></span>
  5887. specified
  5888. by the <span><strong class="command">options</strong></span> statement will be
  5889. used.
  5890. </p>
  5891. <p><span><strong class="command">transfers</strong></span>
  5892. is used to limit the number of concurrent inbound zone
  5893. transfers from the specified server. If no
  5894. <span><strong class="command">transfers</strong></span> clause is specified, the
  5895. limit is set according to the
  5896. <span><strong class="command">transfers-per-ns</strong></span> option.
  5897. </p>
  5898. <p>
  5899. The <span><strong class="command">keys</strong></span> clause identifies a
  5900. <span><strong class="command">key_id</strong></span> defined by the <span><strong class="command">key</strong></span> statement,
  5901. to be used for transaction security (TSIG, <a href="Bv9ARM.ch04.html#tsig" title="TSIG">the section called &#8220;TSIG&#8221;</a>)
  5902. when talking to the remote server.
  5903. When a request is sent to the remote server, a request signature
  5904. will be generated using the key specified here and appended to the
  5905. message. A request originating from the remote server is not
  5906. required
  5907. to be signed by this key.
  5908. </p>
  5909. <p>
  5910. Although the grammar of the <span><strong class="command">keys</strong></span>
  5911. clause
  5912. allows for multiple keys, only a single key per server is
  5913. currently
  5914. supported.
  5915. </p>
  5916. <p>
  5917. The <span><strong class="command">transfer-source</strong></span> and
  5918. <span><strong class="command">transfer-source-v6</strong></span> clauses specify
  5919. the IPv4 and IPv6 source
  5920. address to be used for zone transfer with the remote server,
  5921. respectively.
  5922. For an IPv4 remote server, only <span><strong class="command">transfer-source</strong></span> can
  5923. be specified.
  5924. Similarly, for an IPv6 remote server, only
  5925. <span><strong class="command">transfer-source-v6</strong></span> can be
  5926. specified.
  5927. For more details, see the description of
  5928. <span><strong class="command">transfer-source</strong></span> and
  5929. <span><strong class="command">transfer-source-v6</strong></span> in
  5930. <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  5931. </p>
  5932. <p>
  5933. The <span><strong class="command">notify-source</strong></span> and
  5934. <span><strong class="command">notify-source-v6</strong></span> clauses specify the
  5935. IPv4 and IPv6 source address to be used for notify
  5936. messages sent to remote servers, respectively. For an
  5937. IPv4 remote server, only <span><strong class="command">notify-source</strong></span>
  5938. can be specified. Similarly, for an IPv6 remote server,
  5939. only <span><strong class="command">notify-source-v6</strong></span> can be specified.
  5940. </p>
  5941. <p>
  5942. The <span><strong class="command">query-source</strong></span> and
  5943. <span><strong class="command">query-source-v6</strong></span> clauses specify the
  5944. IPv4 and IPv6 source address to be used for queries
  5945. sent to remote servers, respectively. For an IPv4
  5946. remote server, only <span><strong class="command">query-source</strong></span> can
  5947. be specified. Similarly, for an IPv6 remote server,
  5948. only <span><strong class="command">query-source-v6</strong></span> can be specified.
  5949. </p>
  5950. </div>
  5951. <div class="sect2" lang="en">
  5952. <div class="titlepage"><div><div><h3 class="title">
  5953. <a name="statschannels"></a><span><strong class="command">statistics-channels</strong></span> Statement Grammar</h3></div></div></div>
  5954. <pre class="programlisting"><span><strong class="command">statistics-channels</strong></span> {
  5955. [ inet ( ip_addr | * ) [ port ip_port ]
  5956. [ allow { <em class="replaceable"><code> address_match_list </code></em> } ]; ]
  5957. [ inet ...; ]
  5958. };
  5959. </pre>
  5960. </div>
  5961. <div class="sect2" lang="en">
  5962. <div class="titlepage"><div><div><h3 class="title">
  5963. <a name="id2589481"></a><span><strong class="command">statistics-channels</strong></span> Statement Definition and
  5964. Usage</h3></div></div></div>
  5965. <p>
  5966. The <span><strong class="command">statistics-channels</strong></span> statement
  5967. declares communication channels to be used by system
  5968. administrators to get access to statistics information of
  5969. the name server.
  5970. </p>
  5971. <p>
  5972. This statement intends to be flexible to support multiple
  5973. communication protocols in the future, but currently only
  5974. HTTP access is supported.
  5975. It requires that BIND 9 be compiled with libxml2;
  5976. the <span><strong class="command">statistics-channels</strong></span> statement is
  5977. still accepted even if it is built without the library,
  5978. but any HTTP access will fail with an error.
  5979. </p>
  5980. <p>
  5981. An <span><strong class="command">inet</strong></span> control channel is a TCP socket
  5982. listening at the specified <span><strong class="command">ip_port</strong></span> on the
  5983. specified <span><strong class="command">ip_addr</strong></span>, which can be an IPv4 or IPv6
  5984. address. An <span><strong class="command">ip_addr</strong></span> of <code class="literal">*</code> (asterisk) is
  5985. interpreted as the IPv4 wildcard address; connections will be
  5986. accepted on any of the system's IPv4 addresses.
  5987. To listen on the IPv6 wildcard address,
  5988. use an <span><strong class="command">ip_addr</strong></span> of <code class="literal">::</code>.
  5989. </p>
  5990. <p>
  5991. If no port is specified, port 80 is used for HTTP channels.
  5992. The asterisk "<code class="literal">*</code>" cannot be used for
  5993. <span><strong class="command">ip_port</strong></span>.
  5994. </p>
  5995. <p>
  5996. The attempt of opening a statistics channel is
  5997. restricted by the optional <span><strong class="command">allow</strong></span> clause.
  5998. Connections to the statistics channel are permitted based on the
  5999. <span><strong class="command">address_match_list</strong></span>.
  6000. If no <span><strong class="command">allow</strong></span> clause is present,
  6001. <span><strong class="command">named</strong></span> accepts connection
  6002. attempts from any address; since the statistics may
  6003. contain sensitive internal information, it is highly
  6004. recommended to restrict the source of connection requests
  6005. appropriately.
  6006. </p>
  6007. <p>
  6008. If no <span><strong class="command">statistics-channels</strong></span> statement is present,
  6009. <span><strong class="command">named</strong></span> will not open any communication channels.
  6010. </p>
  6011. </div>
  6012. <div class="sect2" lang="en">
  6013. <div class="titlepage"><div><div><h3 class="title">
  6014. <a name="trusted-keys"></a><span><strong class="command">trusted-keys</strong></span> Statement Grammar</h3></div></div></div>
  6015. <pre class="programlisting"><span><strong class="command">trusted-keys</strong></span> {
  6016. <em class="replaceable"><code>string</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>string</code></em> ;
  6017. [<span class="optional"> <em class="replaceable"><code>string</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>string</code></em> ; [<span class="optional">...</span>]</span>]
  6018. };
  6019. </pre>
  6020. </div>
  6021. <div class="sect2" lang="en">
  6022. <div class="titlepage"><div><div><h3 class="title">
  6023. <a name="id2589689"></a><span><strong class="command">trusted-keys</strong></span> Statement Definition
  6024. and Usage</h3></div></div></div>
  6025. <p>
  6026. The <span><strong class="command">trusted-keys</strong></span> statement defines
  6027. DNSSEC security roots. DNSSEC is described in <a href="Bv9ARM.ch04.html#DNSSEC" title="DNSSEC">the section called &#8220;DNSSEC&#8221;</a>. A security root is defined when the
  6028. public key for a non-authoritative zone is known, but
  6029. cannot be securely obtained through DNS, either because
  6030. it is the DNS root zone or because its parent zone is
  6031. unsigned. Once a key has been configured as a trusted
  6032. key, it is treated as if it had been validated and
  6033. proven secure. The resolver attempts DNSSEC validation
  6034. on all DNS data in subdomains of a security root.
  6035. </p>
  6036. <p>
  6037. All keys (and corresponding zones) listed in
  6038. <span><strong class="command">trusted-keys</strong></span> are deemed to exist regardless
  6039. of what parent zones say. Similarly for all keys listed in
  6040. <span><strong class="command">trusted-keys</strong></span> only those keys are
  6041. used to validate the DNSKEY RRset. The parent's DS RRset
  6042. will not be used.
  6043. </p>
  6044. <p>
  6045. The <span><strong class="command">trusted-keys</strong></span> statement can contain
  6046. multiple key entries, each consisting of the key's
  6047. domain name, flags, protocol, algorithm, and the Base-64
  6048. representation of the key data.
  6049. Spaces, tabs, newlines and carriage returns are ignored
  6050. in the key data, so the configuration may be split up into
  6051. multiple lines.
  6052. </p>
  6053. <p>
  6054. <span><strong class="command">trusted-keys</strong></span> may be set at the top level
  6055. of <code class="filename">named.conf</code> or within a view. If it is
  6056. set in both places, they are additive: keys defined at the top
  6057. level are inherited by all views, but keys defined in a view
  6058. are only used within that view.
  6059. </p>
  6060. </div>
  6061. <div class="sect2" lang="en">
  6062. <div class="titlepage"><div><div><h3 class="title">
  6063. <a name="id2589736"></a><span><strong class="command">managed-keys</strong></span> Statement Grammar</h3></div></div></div>
  6064. <pre class="programlisting"><span><strong class="command">managed-keys</strong></span> {
  6065. <em class="replaceable"><code>string</code></em> initial-key <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>string</code></em> ;
  6066. [<span class="optional"> <em class="replaceable"><code>string</code></em> initial-key <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>string</code></em> ; [<span class="optional">...</span>]</span>]
  6067. };
  6068. </pre>
  6069. </div>
  6070. <div class="sect2" lang="en">
  6071. <div class="titlepage"><div><div><h3 class="title">
  6072. <a name="managed-keys"></a><span><strong class="command">managed-keys</strong></span> Statement Definition
  6073. and Usage</h3></div></div></div>
  6074. <p>
  6075. The <span><strong class="command">managed-keys</strong></span> statement, like
  6076. <span><strong class="command">trusted-keys</strong></span>, defines DNSSEC
  6077. security roots. The difference is that
  6078. <span><strong class="command">managed-keys</strong></span> can be kept up to date
  6079. automatically, without intervention from the resolver
  6080. operator.
  6081. </p>
  6082. <p>
  6083. Suppose, for example, that a zone's key-signing
  6084. key was compromised, and the zone owner had to revoke and
  6085. replace the key. A resolver which had the old key in a
  6086. <span><strong class="command">trusted-keys</strong></span> statement would be
  6087. unable to validate this zone any longer; it would
  6088. reply with a SERVFAIL response code. This would
  6089. continue until the resolver operator had updated the
  6090. <span><strong class="command">trusted-keys</strong></span> statement with the new key.
  6091. </p>
  6092. <p>
  6093. If, however, the zone were listed in a
  6094. <span><strong class="command">managed-keys</strong></span> statement instead, then the
  6095. zone owner could add a "stand-by" key to the zone in advance.
  6096. <span><strong class="command">named</strong></span> would store the stand-by key, and
  6097. when the original key was revoked, <span><strong class="command">named</strong></span>
  6098. would be able to transition smoothly to the new key. It would
  6099. also recognize that the old key had been revoked, and cease
  6100. using that key to validate answers, minimizing the damage that
  6101. the compromised key could do.
  6102. </p>
  6103. <p>
  6104. A <span><strong class="command">managed-keys</strong></span> statement contains a list of
  6105. the keys to be managed, along with information about how the
  6106. keys are to be initialized for the first time. The only
  6107. initialization method currently supported (as of
  6108. <acronym class="acronym">BIND</acronym> 9.7.0) is <code class="literal">initial-key</code>.
  6109. This means the <span><strong class="command">managed-keys</strong></span> statement must
  6110. contain a copy of the initializing key. (Future releases may
  6111. allow keys to be initialized by other methods, eliminating this
  6112. requirement.)
  6113. </p>
  6114. <p>
  6115. Consequently, a <span><strong class="command">managed-keys</strong></span> statement
  6116. appears similar to a <span><strong class="command">trusted-keys</strong></span>, differing
  6117. in the presence of the second field, containing the keyword
  6118. <code class="literal">initial-key</code>. The difference is, whereas the
  6119. keys listed in a <span><strong class="command">trusted-keys</strong></span> continue to be
  6120. trusted until they are removed from
  6121. <code class="filename">named.conf</code>, an initializing key listed
  6122. in a <span><strong class="command">managed-keys</strong></span> statement is only trusted
  6123. <span class="emphasis"><em>once</em></span>: for as long as it takes to load the
  6124. managed key database and start the RFC 5011 key maintenance
  6125. process.
  6126. </p>
  6127. <p>
  6128. The first time <span><strong class="command">named</strong></span> runs with a managed key
  6129. configured in <code class="filename">named.conf</code>, it fetches the
  6130. DNSKEY RRset directly from the zone apex, and validates it
  6131. using the key specified in the <span><strong class="command">managed-keys</strong></span>
  6132. statement. If the DNSKEY RRset is validly signed, then it is
  6133. used as the basis for a new managed keys database.
  6134. </p>
  6135. <p>
  6136. From that point on, whenever <span><strong class="command">named</strong></span> runs, it
  6137. sees the <span><strong class="command">managed-keys</strong></span> statement, checks to
  6138. make sure RFC 5011 key maintenance has already been initialized
  6139. for the specified domain, and if so, it simply moves on. The
  6140. key specified in the <span><strong class="command">managed-keys</strong></span> is not
  6141. used to validate answers; it has been superseded by the key or
  6142. keys stored in the managed keys database.
  6143. </p>
  6144. <p>
  6145. The next time <span><strong class="command">named</strong></span> runs after a name
  6146. has been <span class="emphasis"><em>removed</em></span> from the
  6147. <span><strong class="command">managed-keys</strong></span> statement, the corresponding
  6148. zone will be removed from the managed keys database,
  6149. and RFC 5011 key maintenance will no longer be used for that
  6150. domain.
  6151. </p>
  6152. <p>
  6153. <span><strong class="command">named</strong></span> only maintains a single managed keys
  6154. database; consequently, unlike <span><strong class="command">trusted-keys</strong></span>,
  6155. <span><strong class="command">managed-keys</strong></span> may only be set at the top
  6156. level of <code class="filename">named.conf</code>, not within a view.
  6157. </p>
  6158. <p>
  6159. In the current implementation, the managed keys database is
  6160. stored as a master-format zone file called
  6161. <code class="filename">managed-keys.bind</code>. When the key database
  6162. is changed, the zone is updated. As with any other dynamic
  6163. zone, changes will be written into a journal file,
  6164. <code class="filename">managed-keys.bind.jnl</code>. They are committed
  6165. to the master file as soon as possible afterward; in the case
  6166. of the managed key database, this will usually occur within 30
  6167. seconds. So, whenever <span><strong class="command">named</strong></span> is using
  6168. automatic key maintenance, those two files can be expected to
  6169. exist in the working directory. (For this reason among others,
  6170. the working directory should be always be writable by
  6171. <span><strong class="command">named</strong></span>.)
  6172. </p>
  6173. <p>
  6174. If the <span><strong class="command">dnssec-lookaside</strong></span> option is
  6175. set to <strong class="userinput"><code>auto</code></strong>, <span><strong class="command">named</strong></span>
  6176. will automatically initialize a managed key for the
  6177. zone <code class="literal">dlv.isc.org</code>. The key that is
  6178. used to initialize the key maintenance process is built
  6179. into <span><strong class="command">named</strong></span>, and can be overridden
  6180. from <span><strong class="command">bindkeys-file</strong></span>.
  6181. </p>
  6182. </div>
  6183. <div class="sect2" lang="en">
  6184. <div class="titlepage"><div><div><h3 class="title">
  6185. <a name="view_statement_grammar"></a><span><strong class="command">view</strong></span> Statement Grammar</h3></div></div></div>
  6186. <pre class="programlisting"><span><strong class="command">view</strong></span> <em class="replaceable"><code>view_name</code></em>
  6187. [<span class="optional"><em class="replaceable"><code>class</code></em></span>] {
  6188. match-clients { <em class="replaceable"><code>address_match_list</code></em> };
  6189. match-destinations { <em class="replaceable"><code>address_match_list</code></em> };
  6190. match-recursive-only <em class="replaceable"><code>yes_or_no</code></em> ;
  6191. [<span class="optional"> <em class="replaceable"><code>view_option</code></em>; ...</span>]
  6192. [<span class="optional"> <em class="replaceable"><code>zone_statement</code></em>; ...</span>]
  6193. };
  6194. </pre>
  6195. </div>
  6196. <div class="sect2" lang="en">
  6197. <div class="titlepage"><div><div><h3 class="title">
  6198. <a name="id2590162"></a><span><strong class="command">view</strong></span> Statement Definition and Usage</h3></div></div></div>
  6199. <p>
  6200. The <span><strong class="command">view</strong></span> statement is a powerful
  6201. feature
  6202. of <acronym class="acronym">BIND</acronym> 9 that lets a name server
  6203. answer a DNS query differently
  6204. depending on who is asking. It is particularly useful for
  6205. implementing
  6206. split DNS setups without having to run multiple servers.
  6207. </p>
  6208. <p>
  6209. Each <span><strong class="command">view</strong></span> statement defines a view
  6210. of the
  6211. DNS namespace that will be seen by a subset of clients. A client
  6212. matches
  6213. a view if its source IP address matches the
  6214. <code class="varname">address_match_list</code> of the view's
  6215. <span><strong class="command">match-clients</strong></span> clause and its
  6216. destination IP address matches
  6217. the <code class="varname">address_match_list</code> of the
  6218. view's
  6219. <span><strong class="command">match-destinations</strong></span> clause. If not
  6220. specified, both
  6221. <span><strong class="command">match-clients</strong></span> and <span><strong class="command">match-destinations</strong></span>
  6222. default to matching all addresses. In addition to checking IP
  6223. addresses
  6224. <span><strong class="command">match-clients</strong></span> and <span><strong class="command">match-destinations</strong></span>
  6225. can also take <span><strong class="command">keys</strong></span> which provide an
  6226. mechanism for the
  6227. client to select the view. A view can also be specified
  6228. as <span><strong class="command">match-recursive-only</strong></span>, which
  6229. means that only recursive
  6230. requests from matching clients will match that view.
  6231. The order of the <span><strong class="command">view</strong></span> statements is
  6232. significant &#8212;
  6233. a client request will be resolved in the context of the first
  6234. <span><strong class="command">view</strong></span> that it matches.
  6235. </p>
  6236. <p>
  6237. Zones defined within a <span><strong class="command">view</strong></span>
  6238. statement will
  6239. only be accessible to clients that match the <span><strong class="command">view</strong></span>.
  6240. By defining a zone of the same name in multiple views, different
  6241. zone data can be given to different clients, for example,
  6242. "internal"
  6243. and "external" clients in a split DNS setup.
  6244. </p>
  6245. <p>
  6246. Many of the options given in the <span><strong class="command">options</strong></span> statement
  6247. can also be used within a <span><strong class="command">view</strong></span>
  6248. statement, and then
  6249. apply only when resolving queries with that view. When no
  6250. view-specific
  6251. value is given, the value in the <span><strong class="command">options</strong></span> statement
  6252. is used as a default. Also, zone options can have default values
  6253. specified
  6254. in the <span><strong class="command">view</strong></span> statement; these
  6255. view-specific defaults
  6256. take precedence over those in the <span><strong class="command">options</strong></span> statement.
  6257. </p>
  6258. <p>
  6259. Views are class specific. If no class is given, class IN
  6260. is assumed. Note that all non-IN views must contain a hint zone,
  6261. since only the IN class has compiled-in default hints.
  6262. </p>
  6263. <p>
  6264. If there are no <span><strong class="command">view</strong></span> statements in
  6265. the config
  6266. file, a default view that matches any client is automatically
  6267. created
  6268. in class IN. Any <span><strong class="command">zone</strong></span> statements
  6269. specified on
  6270. the top level of the configuration file are considered to be part
  6271. of
  6272. this default view, and the <span><strong class="command">options</strong></span>
  6273. statement will
  6274. apply to the default view. If any explicit <span><strong class="command">view</strong></span>
  6275. statements are present, all <span><strong class="command">zone</strong></span>
  6276. statements must
  6277. occur inside <span><strong class="command">view</strong></span> statements.
  6278. </p>
  6279. <p>
  6280. Here is an example of a typical split DNS setup implemented
  6281. using <span><strong class="command">view</strong></span> statements:
  6282. </p>
  6283. <pre class="programlisting">view "internal" {
  6284. // This should match our internal networks.
  6285. match-clients { 10.0.0.0/8; };
  6286. // Provide recursive service to internal
  6287. // clients only.
  6288. recursion yes;
  6289. // Provide a complete view of the example.com
  6290. // zone including addresses of internal hosts.
  6291. zone "example.com" {
  6292. type master;
  6293. file "example-internal.db";
  6294. };
  6295. };
  6296. view "external" {
  6297. // Match all clients not matched by the
  6298. // previous view.
  6299. match-clients { any; };
  6300. // Refuse recursive service to external clients.
  6301. recursion no;
  6302. // Provide a restricted view of the example.com
  6303. // zone containing only publicly accessible hosts.
  6304. zone "example.com" {
  6305. type master;
  6306. file "example-external.db";
  6307. };
  6308. };
  6309. </pre>
  6310. </div>
  6311. <div class="sect2" lang="en">
  6312. <div class="titlepage"><div><div><h3 class="title">
  6313. <a name="zone_statement_grammar"></a><span><strong class="command">zone</strong></span>
  6314. Statement Grammar</h3></div></div></div>
  6315. <pre class="programlisting"><span><strong class="command">zone</strong></span> <em class="replaceable"><code>zone_name</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em></span>] {
  6316. type master;
  6317. [<span class="optional"> allow-query { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6318. [<span class="optional"> allow-query-on { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6319. [<span class="optional"> allow-transfer { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6320. [<span class="optional"> allow-update { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6321. [<span class="optional"> update-policy <em class="replaceable"><code>local</code></em> | { <em class="replaceable"><code>update_policy_rule</code></em> [<span class="optional">...</span>] }; </span>]
  6322. [<span class="optional"> also-notify { <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ;
  6323. [<span class="optional"> <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; ... </span>] }; </span>]
  6324. [<span class="optional"> check-names (<code class="constant">warn</code>|<code class="constant">fail</code>|<code class="constant">ignore</code>) ; </span>]
  6325. [<span class="optional"> check-mx (<code class="constant">warn</code>|<code class="constant">fail</code>|<code class="constant">ignore</code>) ; </span>]
  6326. [<span class="optional"> check-wildcard <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  6327. [<span class="optional"> check-integrity <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6328. [<span class="optional"> dialup <em class="replaceable"><code>dialup_option</code></em> ; </span>]
  6329. [<span class="optional"> file <em class="replaceable"><code>string</code></em> ; </span>]
  6330. [<span class="optional"> masterfile-format (<code class="constant">text</code>|<code class="constant">raw</code>) ; </span>]
  6331. [<span class="optional"> journal <em class="replaceable"><code>string</code></em> ; </span>]
  6332. [<span class="optional"> max-journal-size <em class="replaceable"><code>size_spec</code></em>; </span>]
  6333. [<span class="optional"> forward (<code class="constant">only</code>|<code class="constant">first</code>) ; </span>]
  6334. [<span class="optional"> forwarders { [<span class="optional"> <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; ... </span>] }; </span>]
  6335. [<span class="optional"> ixfr-base <em class="replaceable"><code>string</code></em> ; </span>]
  6336. [<span class="optional"> ixfr-from-differences <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  6337. [<span class="optional"> ixfr-tmp-file <em class="replaceable"><code>string</code></em> ; </span>]
  6338. [<span class="optional"> maintain-ixfr-base <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6339. [<span class="optional"> max-ixfr-log-size <em class="replaceable"><code>number</code></em> ; </span>]
  6340. [<span class="optional"> max-transfer-idle-out <em class="replaceable"><code>number</code></em> ; </span>]
  6341. [<span class="optional"> max-transfer-time-out <em class="replaceable"><code>number</code></em> ; </span>]
  6342. [<span class="optional"> notify <em class="replaceable"><code>yes_or_no</code></em> | <em class="replaceable"><code>explicit</code></em> | <em class="replaceable"><code>master-only</code></em> ; </span>]
  6343. [<span class="optional"> notify-delay <em class="replaceable"><code>seconds</code></em> ; </span>]
  6344. [<span class="optional"> notify-to-soa <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  6345. [<span class="optional"> pubkey <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>string</code></em> ; </span>]
  6346. [<span class="optional"> notify-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6347. [<span class="optional"> notify-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6348. [<span class="optional"> zone-statistics <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6349. [<span class="optional"> sig-validity-interval <em class="replaceable"><code>number</code></em> [<span class="optional"><em class="replaceable"><code>number</code></em></span>] ; </span>]
  6350. [<span class="optional"> sig-signing-nodes <em class="replaceable"><code>number</code></em> ; </span>]
  6351. [<span class="optional"> sig-signing-signatures <em class="replaceable"><code>number</code></em> ; </span>]
  6352. [<span class="optional"> sig-signing-type <em class="replaceable"><code>number</code></em> ; </span>]
  6353. [<span class="optional"> database <em class="replaceable"><code>string</code></em> ; </span>]
  6354. [<span class="optional"> min-refresh-time <em class="replaceable"><code>number</code></em> ; </span>]
  6355. [<span class="optional"> max-refresh-time <em class="replaceable"><code>number</code></em> ; </span>]
  6356. [<span class="optional"> min-retry-time <em class="replaceable"><code>number</code></em> ; </span>]
  6357. [<span class="optional"> max-retry-time <em class="replaceable"><code>number</code></em> ; </span>]
  6358. [<span class="optional"> key-directory <em class="replaceable"><code>path_name</code></em>; </span>]
  6359. [<span class="optional"> auto-dnssec <code class="constant">allow</code>|<code class="constant">maintain</code>|<code class="constant">off</code>; </span>]
  6360. [<span class="optional"> zero-no-soa-ttl <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6361. };
  6362. zone <em class="replaceable"><code>zone_name</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em></span>] {
  6363. type slave;
  6364. [<span class="optional"> allow-notify { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6365. [<span class="optional"> allow-query { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6366. [<span class="optional"> allow-query-on { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6367. [<span class="optional"> allow-transfer { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6368. [<span class="optional"> allow-update-forwarding { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6369. [<span class="optional"> update-check-ksk <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  6370. [<span class="optional"> dnssec-update-mode ( <em class="replaceable"><code>maintain</code></em> | <em class="replaceable"><code>no-resign</code></em> ); </span>]
  6371. [<span class="optional"> dnssec-dnskey-kskonly <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  6372. [<span class="optional"> dnssec-secure-to-insecure <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6373. [<span class="optional"> try-tcp-refresh <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  6374. [<span class="optional"> also-notify { <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ;
  6375. [<span class="optional"> <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; ... </span>] }; </span>]
  6376. [<span class="optional"> check-names (<code class="constant">warn</code>|<code class="constant">fail</code>|<code class="constant">ignore</code>) ; </span>]
  6377. [<span class="optional"> dialup <em class="replaceable"><code>dialup_option</code></em> ; </span>]
  6378. [<span class="optional"> file <em class="replaceable"><code>string</code></em> ; </span>]
  6379. [<span class="optional"> masterfile-format (<code class="constant">text</code>|<code class="constant">raw</code>) ; </span>]
  6380. [<span class="optional"> journal <em class="replaceable"><code>string</code></em> ; </span>]
  6381. [<span class="optional"> max-journal-size <em class="replaceable"><code>size_spec</code></em>; </span>]
  6382. [<span class="optional"> forward (<code class="constant">only</code>|<code class="constant">first</code>) ; </span>]
  6383. [<span class="optional"> forwarders { [<span class="optional"> <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; ... </span>] }; </span>]
  6384. [<span class="optional"> ixfr-base <em class="replaceable"><code>string</code></em> ; </span>]
  6385. [<span class="optional"> ixfr-from-differences <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  6386. [<span class="optional"> ixfr-tmp-file <em class="replaceable"><code>string</code></em> ; </span>]
  6387. [<span class="optional"> maintain-ixfr-base <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6388. [<span class="optional"> masters [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] { ( <em class="replaceable"><code>masters_list</code></em> | <em class="replaceable"><code>ip_addr</code></em>
  6389. [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>]
  6390. [<span class="optional">key <em class="replaceable"><code>key</code></em></span>] ) ; [<span class="optional">...</span>] }; </span>]
  6391. [<span class="optional"> max-ixfr-log-size <em class="replaceable"><code>number</code></em> ; </span>]
  6392. [<span class="optional"> max-transfer-idle-in <em class="replaceable"><code>number</code></em> ; </span>]
  6393. [<span class="optional"> max-transfer-idle-out <em class="replaceable"><code>number</code></em> ; </span>]
  6394. [<span class="optional"> max-transfer-time-in <em class="replaceable"><code>number</code></em> ; </span>]
  6395. [<span class="optional"> max-transfer-time-out <em class="replaceable"><code>number</code></em> ; </span>]
  6396. [<span class="optional"> notify <em class="replaceable"><code>yes_or_no</code></em> | <em class="replaceable"><code>explicit</code></em> | <em class="replaceable"><code>master-only</code></em> ; </span>]
  6397. [<span class="optional"> notify-delay <em class="replaceable"><code>seconds</code></em> ; </span>]
  6398. [<span class="optional"> notify-to-soa <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  6399. [<span class="optional"> pubkey <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>string</code></em> ; </span>]
  6400. [<span class="optional"> transfer-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6401. [<span class="optional"> transfer-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6402. [<span class="optional"> alt-transfer-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6403. [<span class="optional"> alt-transfer-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>)
  6404. [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6405. [<span class="optional"> use-alt-transfer-source <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  6406. [<span class="optional"> notify-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6407. [<span class="optional"> notify-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6408. [<span class="optional"> zone-statistics <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6409. [<span class="optional"> database <em class="replaceable"><code>string</code></em> ; </span>]
  6410. [<span class="optional"> min-refresh-time <em class="replaceable"><code>number</code></em> ; </span>]
  6411. [<span class="optional"> max-refresh-time <em class="replaceable"><code>number</code></em> ; </span>]
  6412. [<span class="optional"> min-retry-time <em class="replaceable"><code>number</code></em> ; </span>]
  6413. [<span class="optional"> max-retry-time <em class="replaceable"><code>number</code></em> ; </span>]
  6414. [<span class="optional"> multi-master <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6415. [<span class="optional"> zero-no-soa-ttl <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6416. };
  6417. zone <em class="replaceable"><code>zone_name</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em></span>] {
  6418. type hint;
  6419. file <em class="replaceable"><code>string</code></em> ;
  6420. [<span class="optional"> delegation-only <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6421. [<span class="optional"> check-names (<code class="constant">warn</code>|<code class="constant">fail</code>|<code class="constant">ignore</code>) ; </span>] // Not Implemented.
  6422. };
  6423. zone <em class="replaceable"><code>zone_name</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em></span>] {
  6424. type stub;
  6425. [<span class="optional"> allow-query { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6426. [<span class="optional"> allow-query-on { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6427. [<span class="optional"> check-names (<code class="constant">warn</code>|<code class="constant">fail</code>|<code class="constant">ignore</code>) ; </span>]
  6428. [<span class="optional"> dialup <em class="replaceable"><code>dialup_option</code></em> ; </span>]
  6429. [<span class="optional"> delegation-only <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6430. [<span class="optional"> file <em class="replaceable"><code>string</code></em> ; </span>]
  6431. [<span class="optional"> masterfile-format (<code class="constant">text</code>|<code class="constant">raw</code>) ; </span>]
  6432. [<span class="optional"> forward (<code class="constant">only</code>|<code class="constant">first</code>) ; </span>]
  6433. [<span class="optional"> forwarders { [<span class="optional"> <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; ... </span>] }; </span>]
  6434. [<span class="optional"> masters [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] { ( <em class="replaceable"><code>masters_list</code></em> | <em class="replaceable"><code>ip_addr</code></em>
  6435. [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>]
  6436. [<span class="optional">key <em class="replaceable"><code>key</code></em></span>] ) ; [<span class="optional">...</span>] }; </span>]
  6437. [<span class="optional"> max-transfer-idle-in <em class="replaceable"><code>number</code></em> ; </span>]
  6438. [<span class="optional"> max-transfer-time-in <em class="replaceable"><code>number</code></em> ; </span>]
  6439. [<span class="optional"> pubkey <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>number</code></em> <em class="replaceable"><code>string</code></em> ; </span>]
  6440. [<span class="optional"> transfer-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6441. [<span class="optional"> transfer-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>)
  6442. [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6443. [<span class="optional"> alt-transfer-source (<em class="replaceable"><code>ip4_addr</code></em> | <code class="constant">*</code>) [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6444. [<span class="optional"> alt-transfer-source-v6 (<em class="replaceable"><code>ip6_addr</code></em> | <code class="constant">*</code>)
  6445. [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; </span>]
  6446. [<span class="optional"> use-alt-transfer-source <em class="replaceable"><code>yes_or_no</code></em>; </span>]
  6447. [<span class="optional"> zone-statistics <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6448. [<span class="optional"> database <em class="replaceable"><code>string</code></em> ; </span>]
  6449. [<span class="optional"> min-refresh-time <em class="replaceable"><code>number</code></em> ; </span>]
  6450. [<span class="optional"> max-refresh-time <em class="replaceable"><code>number</code></em> ; </span>]
  6451. [<span class="optional"> min-retry-time <em class="replaceable"><code>number</code></em> ; </span>]
  6452. [<span class="optional"> max-retry-time <em class="replaceable"><code>number</code></em> ; </span>]
  6453. [<span class="optional"> multi-master <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6454. };
  6455. zone <em class="replaceable"><code>zone_name</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em></span>] {
  6456. type static-stub;
  6457. [<span class="optional"> allow-query { <em class="replaceable"><code>address_match_list</code></em> }; </span>]
  6458. [<span class="optional"> server-addresses { [<span class="optional"> <em class="replaceable"><code>ip_addr</code></em> ; ... </span>] }; </span>]
  6459. [<span class="optional"> server-names { [<span class="optional"> <em class="replaceable"><code>namelist</code></em> </span>] }; </span>]
  6460. [<span class="optional"> zone-statistics <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6461. };
  6462. zone <em class="replaceable"><code>zone_name</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em></span>] {
  6463. type forward;
  6464. [<span class="optional"> forward (<code class="constant">only</code>|<code class="constant">first</code>) ; </span>]
  6465. [<span class="optional"> forwarders { [<span class="optional"> <em class="replaceable"><code>ip_addr</code></em> [<span class="optional">port <em class="replaceable"><code>ip_port</code></em></span>] ; ... </span>] }; </span>]
  6466. [<span class="optional"> delegation-only <em class="replaceable"><code>yes_or_no</code></em> ; </span>]
  6467. };
  6468. zone <em class="replaceable"><code>zone_name</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em></span>] {
  6469. type delegation-only;
  6470. };
  6471. </pre>
  6472. </div>
  6473. <div class="sect2" lang="en">
  6474. <div class="titlepage"><div><div><h3 class="title">
  6475. <a name="id2591713"></a><span><strong class="command">zone</strong></span> Statement Definition and Usage</h3></div></div></div>
  6476. <div class="sect3" lang="en">
  6477. <div class="titlepage"><div><div><h4 class="title">
  6478. <a name="id2591720"></a>Zone Types</h4></div></div></div>
  6479. <div class="informaltable"><table border="1">
  6480. <colgroup>
  6481. <col>
  6482. <col>
  6483. </colgroup>
  6484. <tbody>
  6485. <tr>
  6486. <td>
  6487. <p>
  6488. <code class="varname">master</code>
  6489. </p>
  6490. </td>
  6491. <td>
  6492. <p>
  6493. The server has a master copy of the data
  6494. for the zone and will be able to provide authoritative
  6495. answers for
  6496. it.
  6497. </p>
  6498. </td>
  6499. </tr>
  6500. <tr>
  6501. <td>
  6502. <p>
  6503. <code class="varname">slave</code>
  6504. </p>
  6505. </td>
  6506. <td>
  6507. <p>
  6508. A slave zone is a replica of a master
  6509. zone. The <span><strong class="command">masters</strong></span> list
  6510. specifies one or more IP addresses
  6511. of master servers that the slave contacts to update
  6512. its copy of the zone.
  6513. Masters list elements can also be names of other
  6514. masters lists.
  6515. By default, transfers are made from port 53 on the
  6516. servers; this can
  6517. be changed for all servers by specifying a port number
  6518. before the
  6519. list of IP addresses, or on a per-server basis after
  6520. the IP address.
  6521. Authentication to the master can also be done with
  6522. per-server TSIG keys.
  6523. If a file is specified, then the
  6524. replica will be written to this file whenever the zone
  6525. is changed,
  6526. and reloaded from this file on a server restart. Use
  6527. of a file is
  6528. recommended, since it often speeds server startup and
  6529. eliminates
  6530. a needless waste of bandwidth. Note that for large
  6531. numbers (in the
  6532. tens or hundreds of thousands) of zones per server, it
  6533. is best to
  6534. use a two-level naming scheme for zone filenames. For
  6535. example,
  6536. a slave server for the zone <code class="literal">example.com</code> might place
  6537. the zone contents into a file called
  6538. <code class="filename">ex/example.com</code> where <code class="filename">ex/</code> is
  6539. just the first two letters of the zone name. (Most
  6540. operating systems
  6541. behave very slowly if you put 100000 files into
  6542. a single directory.)
  6543. </p>
  6544. </td>
  6545. </tr>
  6546. <tr>
  6547. <td>
  6548. <p>
  6549. <code class="varname">stub</code>
  6550. </p>
  6551. </td>
  6552. <td>
  6553. <p>
  6554. A stub zone is similar to a slave zone,
  6555. except that it replicates only the NS records of a
  6556. master zone instead
  6557. of the entire zone. Stub zones are not a standard part
  6558. of the DNS;
  6559. they are a feature specific to the <acronym class="acronym">BIND</acronym> implementation.
  6560. </p>
  6561. <p>
  6562. Stub zones can be used to eliminate the need for glue
  6563. NS record
  6564. in a parent zone at the expense of maintaining a stub
  6565. zone entry and
  6566. a set of name server addresses in <code class="filename">named.conf</code>.
  6567. This usage is not recommended for new configurations,
  6568. and BIND 9
  6569. supports it only in a limited way.
  6570. In <acronym class="acronym">BIND</acronym> 4/8, zone
  6571. transfers of a parent zone
  6572. included the NS records from stub children of that
  6573. zone. This meant
  6574. that, in some cases, users could get away with
  6575. configuring child stubs
  6576. only in the master server for the parent zone. <acronym class="acronym">BIND</acronym>
  6577. 9 never mixes together zone data from different zones
  6578. in this
  6579. way. Therefore, if a <acronym class="acronym">BIND</acronym> 9 master serving a parent
  6580. zone has child stub zones configured, all the slave
  6581. servers for the
  6582. parent zone also need to have the same child stub
  6583. zones
  6584. configured.
  6585. </p>
  6586. <p>
  6587. Stub zones can also be used as a way of forcing the
  6588. resolution
  6589. of a given domain to use a particular set of
  6590. authoritative servers.
  6591. For example, the caching name servers on a private
  6592. network using
  6593. RFC1918 addressing may be configured with stub zones
  6594. for
  6595. <code class="literal">10.in-addr.arpa</code>
  6596. to use a set of internal name servers as the
  6597. authoritative
  6598. servers for that domain.
  6599. </p>
  6600. </td>
  6601. </tr>
  6602. <tr>
  6603. <td>
  6604. <p>
  6605. <code class="varname">static-stub</code>
  6606. </p>
  6607. </td>
  6608. <td>
  6609. <p>
  6610. A static-stub zone is similar to a stub zone
  6611. with the following exceptions:
  6612. the zone data is statically configured, rather
  6613. than transferred from a master server;
  6614. when recursion is necessary for a query that
  6615. matches a static-stub zone, the locally
  6616. configured data (nameserver names and glue addresses)
  6617. is always used even if different authoritative
  6618. information is cached.
  6619. </p>
  6620. <p>
  6621. Zone data is configured via the
  6622. <span><strong class="command">server-addresses</strong></span> and
  6623. <span><strong class="command">server-names</strong></span> zone options.
  6624. </p>
  6625. <p>
  6626. The zone data is maintained in the form of NS
  6627. and (if necessary) glue A or AAAA RRs
  6628. internally, which can be seen by dumping zone
  6629. databases by <span><strong class="command">rndc dumpdb -all</strong></span>.
  6630. The configured RRs are considered local configuration
  6631. parameters rather than public data.
  6632. Non recursive queries (i.e., those with the RD
  6633. bit off) to a static-stub zone are therefore
  6634. prohibited and will be responded with REFUSED.
  6635. </p>
  6636. <p>
  6637. Since the data is statically configured, no
  6638. zone maintenance action takes place for a static-stub
  6639. zone.
  6640. For example, there is no periodic refresh
  6641. attempt, and an incoming notify message
  6642. will be rejected with an rcode of NOTAUTH.
  6643. </p>
  6644. <p>
  6645. Each static-stub zone is configured with
  6646. internally generated NS and (if necessary)
  6647. glue A or AAAA RRs
  6648. </p>
  6649. </td>
  6650. </tr>
  6651. <tr>
  6652. <td>
  6653. <p>
  6654. <code class="varname">forward</code>
  6655. </p>
  6656. </td>
  6657. <td>
  6658. <p>
  6659. A "forward zone" is a way to configure
  6660. forwarding on a per-domain basis. A <span><strong class="command">zone</strong></span> statement
  6661. of type <span><strong class="command">forward</strong></span> can
  6662. contain a <span><strong class="command">forward</strong></span>
  6663. and/or <span><strong class="command">forwarders</strong></span>
  6664. statement,
  6665. which will apply to queries within the domain given by
  6666. the zone
  6667. name. If no <span><strong class="command">forwarders</strong></span>
  6668. statement is present or
  6669. an empty list for <span><strong class="command">forwarders</strong></span> is given, then no
  6670. forwarding will be done for the domain, canceling the
  6671. effects of
  6672. any forwarders in the <span><strong class="command">options</strong></span> statement. Thus
  6673. if you want to use this type of zone to change the
  6674. behavior of the
  6675. global <span><strong class="command">forward</strong></span> option
  6676. (that is, "forward first"
  6677. to, then "forward only", or vice versa, but want to
  6678. use the same
  6679. servers as set globally) you need to re-specify the
  6680. global forwarders.
  6681. </p>
  6682. </td>
  6683. </tr>
  6684. <tr>
  6685. <td>
  6686. <p>
  6687. <code class="varname">hint</code>
  6688. </p>
  6689. </td>
  6690. <td>
  6691. <p>
  6692. The initial set of root name servers is
  6693. specified using a "hint zone". When the server starts
  6694. up, it uses
  6695. the root hints to find a root name server and get the
  6696. most recent
  6697. list of root name servers. If no hint zone is
  6698. specified for class
  6699. IN, the server uses a compiled-in default set of root
  6700. servers hints.
  6701. Classes other than IN have no built-in defaults hints.
  6702. </p>
  6703. </td>
  6704. </tr>
  6705. <tr>
  6706. <td>
  6707. <p>
  6708. <code class="varname">delegation-only</code>
  6709. </p>
  6710. </td>
  6711. <td>
  6712. <p>
  6713. This is used to enforce the delegation-only
  6714. status of infrastructure zones (e.g. COM,
  6715. NET, ORG). Any answer that is received
  6716. without an explicit or implicit delegation
  6717. in the authority section will be treated
  6718. as NXDOMAIN. This does not apply to the
  6719. zone apex. This should not be applied to
  6720. leaf zones.
  6721. </p>
  6722. <p>
  6723. <code class="varname">delegation-only</code> has no
  6724. effect on answers received from forwarders.
  6725. </p>
  6726. <p>
  6727. See caveats in <a href="Bv9ARM.ch06.html#root_delegation_only"><span><strong class="command">root-delegation-only</strong></span></a>.
  6728. </p>
  6729. </td>
  6730. </tr>
  6731. </tbody>
  6732. </table></div>
  6733. </div>
  6734. <div class="sect3" lang="en">
  6735. <div class="titlepage"><div><div><h4 class="title">
  6736. <a name="id2592402"></a>Class</h4></div></div></div>
  6737. <p>
  6738. The zone's name may optionally be followed by a class. If
  6739. a class is not specified, class <code class="literal">IN</code> (for <code class="varname">Internet</code>),
  6740. is assumed. This is correct for the vast majority of cases.
  6741. </p>
  6742. <p>
  6743. The <code class="literal">hesiod</code> class is
  6744. named for an information service from MIT's Project Athena. It
  6745. is
  6746. used to share information about various systems databases, such
  6747. as users, groups, printers and so on. The keyword
  6748. <code class="literal">HS</code> is
  6749. a synonym for hesiod.
  6750. </p>
  6751. <p>
  6752. Another MIT development is Chaosnet, a LAN protocol created
  6753. in the mid-1970s. Zone data for it can be specified with the <code class="literal">CHAOS</code> class.
  6754. </p>
  6755. </div>
  6756. <div class="sect3" lang="en">
  6757. <div class="titlepage"><div><div><h4 class="title">
  6758. <a name="id2592503"></a>Zone Options</h4></div></div></div>
  6759. <div class="variablelist"><dl>
  6760. <dt><span class="term"><span><strong class="command">allow-notify</strong></span></span></dt>
  6761. <dd><p>
  6762. See the description of
  6763. <span><strong class="command">allow-notify</strong></span> in <a href="Bv9ARM.ch06.html#access_control" title="Access Control">the section called &#8220;Access Control&#8221;</a>.
  6764. </p></dd>
  6765. <dt><span class="term"><span><strong class="command">allow-query</strong></span></span></dt>
  6766. <dd><p>
  6767. See the description of
  6768. <span><strong class="command">allow-query</strong></span> in <a href="Bv9ARM.ch06.html#access_control" title="Access Control">the section called &#8220;Access Control&#8221;</a>.
  6769. </p></dd>
  6770. <dt><span class="term"><span><strong class="command">allow-query-on</strong></span></span></dt>
  6771. <dd><p>
  6772. See the description of
  6773. <span><strong class="command">allow-query-on</strong></span> in <a href="Bv9ARM.ch06.html#access_control" title="Access Control">the section called &#8220;Access Control&#8221;</a>.
  6774. </p></dd>
  6775. <dt><span class="term"><span><strong class="command">allow-transfer</strong></span></span></dt>
  6776. <dd><p>
  6777. See the description of <span><strong class="command">allow-transfer</strong></span>
  6778. in <a href="Bv9ARM.ch06.html#access_control" title="Access Control">the section called &#8220;Access Control&#8221;</a>.
  6779. </p></dd>
  6780. <dt><span class="term"><span><strong class="command">allow-update</strong></span></span></dt>
  6781. <dd><p>
  6782. See the description of <span><strong class="command">allow-update</strong></span>
  6783. in <a href="Bv9ARM.ch06.html#access_control" title="Access Control">the section called &#8220;Access Control&#8221;</a>.
  6784. </p></dd>
  6785. <dt><span class="term"><span><strong class="command">update-policy</strong></span></span></dt>
  6786. <dd><p>
  6787. Specifies a "Simple Secure Update" policy. See
  6788. <a href="Bv9ARM.ch06.html#dynamic_update_policies" title="Dynamic Update Policies">the section called &#8220;Dynamic Update Policies&#8221;</a>.
  6789. </p></dd>
  6790. <dt><span class="term"><span><strong class="command">allow-update-forwarding</strong></span></span></dt>
  6791. <dd><p>
  6792. See the description of <span><strong class="command">allow-update-forwarding</strong></span>
  6793. in <a href="Bv9ARM.ch06.html#access_control" title="Access Control">the section called &#8220;Access Control&#8221;</a>.
  6794. </p></dd>
  6795. <dt><span class="term"><span><strong class="command">also-notify</strong></span></span></dt>
  6796. <dd><p>
  6797. Only meaningful if <span><strong class="command">notify</strong></span>
  6798. is
  6799. active for this zone. The set of machines that will
  6800. receive a
  6801. <code class="literal">DNS NOTIFY</code> message
  6802. for this zone is made up of all the listed name servers
  6803. (other than
  6804. the primary master) for the zone plus any IP addresses
  6805. specified
  6806. with <span><strong class="command">also-notify</strong></span>. A port
  6807. may be specified
  6808. with each <span><strong class="command">also-notify</strong></span>
  6809. address to send the notify
  6810. messages to a port other than the default of 53.
  6811. <span><strong class="command">also-notify</strong></span> is not
  6812. meaningful for stub zones.
  6813. The default is the empty list.
  6814. </p></dd>
  6815. <dt><span class="term"><span><strong class="command">check-names</strong></span></span></dt>
  6816. <dd><p>
  6817. This option is used to restrict the character set and
  6818. syntax of
  6819. certain domain names in master files and/or DNS responses
  6820. received from the
  6821. network. The default varies according to zone type. For <span><strong class="command">master</strong></span> zones the default is <span><strong class="command">fail</strong></span>. For <span><strong class="command">slave</strong></span>
  6822. zones the default is <span><strong class="command">warn</strong></span>.
  6823. It is not implemented for <span><strong class="command">hint</strong></span> zones.
  6824. </p></dd>
  6825. <dt><span class="term"><span><strong class="command">check-mx</strong></span></span></dt>
  6826. <dd><p>
  6827. See the description of
  6828. <span><strong class="command">check-mx</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6829. </p></dd>
  6830. <dt><span class="term"><span><strong class="command">check-wildcard</strong></span></span></dt>
  6831. <dd><p>
  6832. See the description of
  6833. <span><strong class="command">check-wildcard</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6834. </p></dd>
  6835. <dt><span class="term"><span><strong class="command">check-integrity</strong></span></span></dt>
  6836. <dd><p>
  6837. See the description of
  6838. <span><strong class="command">check-integrity</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6839. </p></dd>
  6840. <dt><span class="term"><span><strong class="command">check-sibling</strong></span></span></dt>
  6841. <dd><p>
  6842. See the description of
  6843. <span><strong class="command">check-sibling</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6844. </p></dd>
  6845. <dt><span class="term"><span><strong class="command">zero-no-soa-ttl</strong></span></span></dt>
  6846. <dd><p>
  6847. See the description of
  6848. <span><strong class="command">zero-no-soa-ttl</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6849. </p></dd>
  6850. <dt><span class="term"><span><strong class="command">update-check-ksk</strong></span></span></dt>
  6851. <dd><p>
  6852. See the description of
  6853. <span><strong class="command">update-check-ksk</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6854. </p></dd>
  6855. <dt><span class="term"><span><strong class="command">dnssec-dnskey-kskonly</strong></span></span></dt>
  6856. <dd><p>
  6857. See the description of
  6858. <span><strong class="command">dnssec-dnskey-kskonly</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6859. </p></dd>
  6860. <dt><span class="term"><span><strong class="command">try-tcp-refresh</strong></span></span></dt>
  6861. <dd><p>
  6862. See the description of
  6863. <span><strong class="command">try-tcp-refresh</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6864. </p></dd>
  6865. <dt><span class="term"><span><strong class="command">database</strong></span></span></dt>
  6866. <dd>
  6867. <p>
  6868. Specify the type of database to be used for storing the
  6869. zone data. The string following the <span><strong class="command">database</strong></span> keyword
  6870. is interpreted as a list of whitespace-delimited words.
  6871. The first word
  6872. identifies the database type, and any subsequent words are
  6873. passed
  6874. as arguments to the database to be interpreted in a way
  6875. specific
  6876. to the database type.
  6877. </p>
  6878. <p>
  6879. The default is <strong class="userinput"><code>"rbt"</code></strong>, BIND 9's
  6880. native in-memory
  6881. red-black-tree database. This database does not take
  6882. arguments.
  6883. </p>
  6884. <p>
  6885. Other values are possible if additional database drivers
  6886. have been linked into the server. Some sample drivers are
  6887. included
  6888. with the distribution but none are linked in by default.
  6889. </p>
  6890. </dd>
  6891. <dt><span class="term"><span><strong class="command">dialup</strong></span></span></dt>
  6892. <dd><p>
  6893. See the description of
  6894. <span><strong class="command">dialup</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6895. </p></dd>
  6896. <dt><span class="term"><span><strong class="command">delegation-only</strong></span></span></dt>
  6897. <dd>
  6898. <p>
  6899. The flag only applies to hint and stub zones. If set
  6900. to <strong class="userinput"><code>yes</code></strong>, then the zone will also be
  6901. treated as if it is also a delegation-only type zone.
  6902. </p>
  6903. <p>
  6904. See caveats in <a href="Bv9ARM.ch06.html#root_delegation_only"><span><strong class="command">root-delegation-only</strong></span></a>.
  6905. </p>
  6906. </dd>
  6907. <dt><span class="term"><span><strong class="command">forward</strong></span></span></dt>
  6908. <dd><p>
  6909. Only meaningful if the zone has a forwarders
  6910. list. The <span><strong class="command">only</strong></span> value causes
  6911. the lookup to fail
  6912. after trying the forwarders and getting no answer, while <span><strong class="command">first</strong></span> would
  6913. allow a normal lookup to be tried.
  6914. </p></dd>
  6915. <dt><span class="term"><span><strong class="command">forwarders</strong></span></span></dt>
  6916. <dd><p>
  6917. Used to override the list of global forwarders.
  6918. If it is not specified in a zone of type <span><strong class="command">forward</strong></span>,
  6919. no forwarding is done for the zone and the global options are
  6920. not used.
  6921. </p></dd>
  6922. <dt><span class="term"><span><strong class="command">ixfr-base</strong></span></span></dt>
  6923. <dd><p>
  6924. Was used in <acronym class="acronym">BIND</acronym> 8 to
  6925. specify the name
  6926. of the transaction log (journal) file for dynamic update
  6927. and IXFR.
  6928. <acronym class="acronym">BIND</acronym> 9 ignores the option
  6929. and constructs the name of the journal
  6930. file by appending "<code class="filename">.jnl</code>"
  6931. to the name of the
  6932. zone file.
  6933. </p></dd>
  6934. <dt><span class="term"><span><strong class="command">ixfr-tmp-file</strong></span></span></dt>
  6935. <dd><p>
  6936. Was an undocumented option in <acronym class="acronym">BIND</acronym> 8.
  6937. Ignored in <acronym class="acronym">BIND</acronym> 9.
  6938. </p></dd>
  6939. <dt><span class="term"><span><strong class="command">journal</strong></span></span></dt>
  6940. <dd><p>
  6941. Allow the default journal's filename to be overridden.
  6942. The default is the zone's filename with "<code class="filename">.jnl</code>" appended.
  6943. This is applicable to <span><strong class="command">master</strong></span> and <span><strong class="command">slave</strong></span> zones.
  6944. </p></dd>
  6945. <dt><span class="term"><span><strong class="command">max-journal-size</strong></span></span></dt>
  6946. <dd><p>
  6947. See the description of
  6948. <span><strong class="command">max-journal-size</strong></span> in <a href="Bv9ARM.ch06.html#server_resource_limits" title="Server Resource Limits">the section called &#8220;Server Resource Limits&#8221;</a>.
  6949. </p></dd>
  6950. <dt><span class="term"><span><strong class="command">max-transfer-time-in</strong></span></span></dt>
  6951. <dd><p>
  6952. See the description of
  6953. <span><strong class="command">max-transfer-time-in</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  6954. </p></dd>
  6955. <dt><span class="term"><span><strong class="command">max-transfer-idle-in</strong></span></span></dt>
  6956. <dd><p>
  6957. See the description of
  6958. <span><strong class="command">max-transfer-idle-in</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  6959. </p></dd>
  6960. <dt><span class="term"><span><strong class="command">max-transfer-time-out</strong></span></span></dt>
  6961. <dd><p>
  6962. See the description of
  6963. <span><strong class="command">max-transfer-time-out</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  6964. </p></dd>
  6965. <dt><span class="term"><span><strong class="command">max-transfer-idle-out</strong></span></span></dt>
  6966. <dd><p>
  6967. See the description of
  6968. <span><strong class="command">max-transfer-idle-out</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  6969. </p></dd>
  6970. <dt><span class="term"><span><strong class="command">notify</strong></span></span></dt>
  6971. <dd><p>
  6972. See the description of
  6973. <span><strong class="command">notify</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6974. </p></dd>
  6975. <dt><span class="term"><span><strong class="command">notify-delay</strong></span></span></dt>
  6976. <dd><p>
  6977. See the description of
  6978. <span><strong class="command">notify-delay</strong></span> in <a href="Bv9ARM.ch06.html#tuning" title="Tuning">the section called &#8220;Tuning&#8221;</a>.
  6979. </p></dd>
  6980. <dt><span class="term"><span><strong class="command">notify-to-soa</strong></span></span></dt>
  6981. <dd><p>
  6982. See the description of
  6983. <span><strong class="command">notify-to-soa</strong></span> in
  6984. <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  6985. </p></dd>
  6986. <dt><span class="term"><span><strong class="command">pubkey</strong></span></span></dt>
  6987. <dd><p>
  6988. In <acronym class="acronym">BIND</acronym> 8, this option was
  6989. intended for specifying
  6990. a public zone key for verification of signatures in DNSSEC
  6991. signed
  6992. zones when they are loaded from disk. <acronym class="acronym">BIND</acronym> 9 does not verify signatures
  6993. on load and ignores the option.
  6994. </p></dd>
  6995. <dt><span class="term"><span><strong class="command">zone-statistics</strong></span></span></dt>
  6996. <dd><p>
  6997. If <strong class="userinput"><code>yes</code></strong>, the server will keep
  6998. statistical
  6999. information for this zone, which can be dumped to the
  7000. <span><strong class="command">statistics-file</strong></span> defined in
  7001. the server options.
  7002. </p></dd>
  7003. <dt><span class="term"><span><strong class="command">server-addresses</strong></span></span></dt>
  7004. <dd>
  7005. <p>
  7006. Only meaningful for static-stub zones.
  7007. This is a list of IP addresses to which queries
  7008. should be sent in recursive resolution for the
  7009. zone.
  7010. A non empty list for this option will internally
  7011. configure the apex NS RR with associated glue A or
  7012. AAAA RRs.
  7013. </p>
  7014. <p>
  7015. For example, if "example.com" is configured as a
  7016. static-stub zone with 192.0.2.1 and 2001:db8::1234
  7017. in a <span><strong class="command">server-addresses</strong></span> option,
  7018. the following RRs will be internally configured.
  7019. </p>
  7020. <pre class="programlisting">example.com. NS example.com.
  7021. example.com. A 192.0.2.1
  7022. example.com. AAAA 2001:db8::1234</pre>
  7023. <p>
  7024. These records are internally used to resolve
  7025. names under the static-stub zone.
  7026. For instance, if the server receives a query for
  7027. "www.example.com" with the RD bit on, the server
  7028. will initiate recursive resolution and send
  7029. queries to 192.0.2.1 and/or 2001:db8::1234.
  7030. </p>
  7031. </dd>
  7032. <dt><span class="term"><span><strong class="command">server-names</strong></span></span></dt>
  7033. <dd>
  7034. <p>
  7035. Only meaningful for static-stub zones.
  7036. This is a list of domain names of nameservers that
  7037. act as authoritative servers of the static-stub
  7038. zone.
  7039. These names will be resolved to IP addresses when
  7040. <span><strong class="command">named</strong></span> needs to send queries to
  7041. these servers.
  7042. To make this supplemental resolution successful,
  7043. these names must not be a subdomain of the origin
  7044. name of static-stub zone.
  7045. That is, when "example.net" is the origin of a
  7046. static-stub zone, "ns.example" and
  7047. "master.example.com" can be specified in the
  7048. <span><strong class="command">server-names</strong></span> option, but
  7049. "ns.example.net" cannot, and will be rejected by
  7050. the configuration parser.
  7051. </p>
  7052. <p>
  7053. A non empty list for this option will internally
  7054. configure the apex NS RR with the specified names.
  7055. For example, if "example.com" is configured as a
  7056. static-stub zone with "ns1.example.net" and
  7057. "ns2.example.net"
  7058. in a <span><strong class="command">server-names</strong></span> option,
  7059. the following RRs will be internally configured.
  7060. </p>
  7061. <pre class="programlisting">example.com. NS ns1.example.net.
  7062. example.com. NS ns2.example.net.
  7063. </pre>
  7064. <p>
  7065. These records are internally used to resolve
  7066. names under the static-stub zone.
  7067. For instance, if the server receives a query for
  7068. "www.example.com" with the RD bit on, the server
  7069. initiate recursive resolution,
  7070. resolve "ns1.example.net" and/or
  7071. "ns2.example.net" to IP addresses, and then send
  7072. queries to (one or more of) these addresses.
  7073. </p>
  7074. </dd>
  7075. <dt><span class="term"><span><strong class="command">sig-validity-interval</strong></span></span></dt>
  7076. <dd><p>
  7077. See the description of
  7078. <span><strong class="command">sig-validity-interval</strong></span> in <a href="Bv9ARM.ch06.html#tuning" title="Tuning">the section called &#8220;Tuning&#8221;</a>.
  7079. </p></dd>
  7080. <dt><span class="term"><span><strong class="command">sig-signing-nodes</strong></span></span></dt>
  7081. <dd><p>
  7082. See the description of
  7083. <span><strong class="command">sig-signing-nodes</strong></span> in <a href="Bv9ARM.ch06.html#tuning" title="Tuning">the section called &#8220;Tuning&#8221;</a>.
  7084. </p></dd>
  7085. <dt><span class="term"><span><strong class="command">sig-signing-signatures</strong></span></span></dt>
  7086. <dd><p>
  7087. See the description of
  7088. <span><strong class="command">sig-signing-signatures</strong></span> in <a href="Bv9ARM.ch06.html#tuning" title="Tuning">the section called &#8220;Tuning&#8221;</a>.
  7089. </p></dd>
  7090. <dt><span class="term"><span><strong class="command">sig-signing-type</strong></span></span></dt>
  7091. <dd><p>
  7092. See the description of
  7093. <span><strong class="command">sig-signing-type</strong></span> in <a href="Bv9ARM.ch06.html#tuning" title="Tuning">the section called &#8220;Tuning&#8221;</a>.
  7094. </p></dd>
  7095. <dt><span class="term"><span><strong class="command">transfer-source</strong></span></span></dt>
  7096. <dd><p>
  7097. See the description of
  7098. <span><strong class="command">transfer-source</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  7099. </p></dd>
  7100. <dt><span class="term"><span><strong class="command">transfer-source-v6</strong></span></span></dt>
  7101. <dd><p>
  7102. See the description of
  7103. <span><strong class="command">transfer-source-v6</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  7104. </p></dd>
  7105. <dt><span class="term"><span><strong class="command">alt-transfer-source</strong></span></span></dt>
  7106. <dd><p>
  7107. See the description of
  7108. <span><strong class="command">alt-transfer-source</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  7109. </p></dd>
  7110. <dt><span class="term"><span><strong class="command">alt-transfer-source-v6</strong></span></span></dt>
  7111. <dd><p>
  7112. See the description of
  7113. <span><strong class="command">alt-transfer-source-v6</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  7114. </p></dd>
  7115. <dt><span class="term"><span><strong class="command">use-alt-transfer-source</strong></span></span></dt>
  7116. <dd><p>
  7117. See the description of
  7118. <span><strong class="command">use-alt-transfer-source</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  7119. </p></dd>
  7120. <dt><span class="term"><span><strong class="command">notify-source</strong></span></span></dt>
  7121. <dd><p>
  7122. See the description of
  7123. <span><strong class="command">notify-source</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  7124. </p></dd>
  7125. <dt><span class="term"><span><strong class="command">notify-source-v6</strong></span></span></dt>
  7126. <dd><p>
  7127. See the description of
  7128. <span><strong class="command">notify-source-v6</strong></span> in <a href="Bv9ARM.ch06.html#zone_transfers" title="Zone Transfers">the section called &#8220;Zone Transfers&#8221;</a>.
  7129. </p></dd>
  7130. <dt>
  7131. <span class="term"><span><strong class="command">min-refresh-time</strong></span>, </span><span class="term"><span><strong class="command">max-refresh-time</strong></span>, </span><span class="term"><span><strong class="command">min-retry-time</strong></span>, </span><span class="term"><span><strong class="command">max-retry-time</strong></span></span>
  7132. </dt>
  7133. <dd><p>
  7134. See the description in <a href="Bv9ARM.ch06.html#tuning" title="Tuning">the section called &#8220;Tuning&#8221;</a>.
  7135. </p></dd>
  7136. <dt><span class="term"><span><strong class="command">ixfr-from-differences</strong></span></span></dt>
  7137. <dd><p>
  7138. See the description of
  7139. <span><strong class="command">ixfr-from-differences</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  7140. (Note that the <span><strong class="command">ixfr-from-differences</strong></span>
  7141. <strong class="userinput"><code>master</code></strong> and
  7142. <strong class="userinput"><code>slave</code></strong> choices are not
  7143. available at the zone level.)
  7144. </p></dd>
  7145. <dt><span class="term"><span><strong class="command">key-directory</strong></span></span></dt>
  7146. <dd><p>
  7147. See the description of
  7148. <span><strong class="command">key-directory</strong></span> in <a href="Bv9ARM.ch06.html#options" title="options Statement Definition and
  7149. Usage">the section called &#8220;<span><strong class="command">options</strong></span> Statement Definition and
  7150. Usage&#8221;</a>.
  7151. </p></dd>
  7152. <dt><span class="term"><span><strong class="command">auto-dnssec</strong></span></span></dt>
  7153. <dd>
  7154. <p>
  7155. Zones configured for dynamic DNS may also use this
  7156. option to allow varying levels of automatic DNSSEC key
  7157. management. There are three possible settings:
  7158. </p>
  7159. <p>
  7160. <span><strong class="command">auto-dnssec allow;</strong></span> permits
  7161. keys to be updated and the zone fully re-signed
  7162. whenever the user issues the command <span><strong class="command">rndc sign
  7163. <em class="replaceable"><code>zonename</code></em></strong></span>.
  7164. </p>
  7165. <p>
  7166. <span><strong class="command">auto-dnssec maintain;</strong></span> includes the
  7167. above, but also automatically adjusts the zone's DNSSEC
  7168. keys on schedule, according to the keys' timing metadata
  7169. (see <a href="man.dnssec-keygen.html" title="dnssec-keygen"><span class="refentrytitle"><span class="application">dnssec-keygen</span></span>(8)</a> and
  7170. <a href="man.dnssec-settime.html" title="dnssec-settime"><span class="refentrytitle"><span class="application">dnssec-settime</span></span>(8)</a>). The command
  7171. <span><strong class="command">rndc sign
  7172. <em class="replaceable"><code>zonename</code></em></strong></span> causes
  7173. <span><strong class="command">named</strong></span> to load keys from the key
  7174. repository and sign the zone with all keys that are
  7175. active.
  7176. <span><strong class="command">rndc loadkeys
  7177. <em class="replaceable"><code>zonename</code></em></strong></span> causes
  7178. <span><strong class="command">named</strong></span> to load keys from the key
  7179. repository and schedule key maintenance events to occur
  7180. in the future, but it does not sign the full zone
  7181. immediately. Note: once keys have been loaded for a
  7182. zone the first time, the repository will be searched
  7183. for changes periodically, regardless of whether
  7184. <span><strong class="command">rndc loadkeys</strong></span> is used. The recheck
  7185. interval is hard-coded to
  7186. one hour.
  7187. </p>
  7188. <p>
  7189. <span><strong class="command">auto-dnssec create;</strong></span> includes the
  7190. above, but also allows <span><strong class="command">named</strong></span>
  7191. to create new keys in the key repository when needed.
  7192. (NOTE: This option is not yet implemented; the syntax is
  7193. being reserved for future use.)
  7194. </p>
  7195. <p>
  7196. The default setting is <span><strong class="command">auto-dnssec off</strong></span>.
  7197. </p>
  7198. </dd>
  7199. <dt><span class="term"><span><strong class="command">multi-master</strong></span></span></dt>
  7200. <dd><p>
  7201. See the description of <span><strong class="command">multi-master</strong></span> in
  7202. <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  7203. </p></dd>
  7204. <dt><span class="term"><span><strong class="command">masterfile-format</strong></span></span></dt>
  7205. <dd><p>
  7206. See the description of <span><strong class="command">masterfile-format</strong></span>
  7207. in <a href="Bv9ARM.ch06.html#tuning" title="Tuning">the section called &#8220;Tuning&#8221;</a>.
  7208. </p></dd>
  7209. <dt><span class="term"><span><strong class="command">dnssec-secure-to-insecure</strong></span></span></dt>
  7210. <dd><p>
  7211. See the description of
  7212. <span><strong class="command">dnssec-secure-to-insecure</strong></span> in <a href="Bv9ARM.ch06.html#boolean_options" title="Boolean Options">the section called &#8220;Boolean Options&#8221;</a>.
  7213. </p></dd>
  7214. </dl></div>
  7215. </div>
  7216. <div class="sect3" lang="en">
  7217. <div class="titlepage"><div><div><h4 class="title">
  7218. <a name="dynamic_update_policies"></a>Dynamic Update Policies</h4></div></div></div>
  7219. <p><acronym class="acronym">BIND</acronym> 9 supports two alternative
  7220. methods of granting clients the right to perform
  7221. dynamic updates to a zone, configured by the
  7222. <span><strong class="command">allow-update</strong></span> and
  7223. <span><strong class="command">update-policy</strong></span> option, respectively.
  7224. </p>
  7225. <p>
  7226. The <span><strong class="command">allow-update</strong></span> clause works the
  7227. same way as in previous versions of <acronym class="acronym">BIND</acronym>.
  7228. It grants given clients the permission to update any
  7229. record of any name in the zone.
  7230. </p>
  7231. <p>
  7232. The <span><strong class="command">update-policy</strong></span> clause
  7233. allows more fine-grained control over what updates are
  7234. allowed. A set of rules is specified, where each rule
  7235. either grants or denies permissions for one or more
  7236. names to be updated by one or more identities. If
  7237. the dynamic update request message is signed (that is,
  7238. it includes either a TSIG or SIG(0) record), the
  7239. identity of the signer can be determined.
  7240. </p>
  7241. <p>
  7242. Rules are specified in the <span><strong class="command">update-policy</strong></span>
  7243. zone option, and are only meaningful for master zones.
  7244. When the <span><strong class="command">update-policy</strong></span> statement
  7245. is present, it is a configuration error for the
  7246. <span><strong class="command">allow-update</strong></span> statement to be
  7247. present. The <span><strong class="command">update-policy</strong></span> statement
  7248. only examines the signer of a message; the source
  7249. address is not relevant.
  7250. </p>
  7251. <p>
  7252. There is a pre-defined <span><strong class="command">update-policy</strong></span>
  7253. rule which can be switched on with the command
  7254. <span><strong class="command">update-policy local;</strong></span>.
  7255. Switching on this rule in a zone causes
  7256. <span><strong class="command">named</strong></span> to generate a TSIG session
  7257. key and place it in a file, and to allow that key
  7258. to update the zone. (By default, the file is
  7259. <code class="filename">/var/run/named/session.key</code>, the key
  7260. name is "local-ddns" and the key algorithm is HMAC-SHA256,
  7261. but these values are configurable with the
  7262. <span><strong class="command">session-keyfile</strong></span>,
  7263. <span><strong class="command">session-keyname</strong></span> and
  7264. <span><strong class="command">session-keyalg</strong></span> options, respectively).
  7265. </p>
  7266. <p>
  7267. A client running on the local system, and with appropriate
  7268. permissions, may read that file and use the key to sign update
  7269. requests. The zone's update policy will be set to allow that
  7270. key to change any record within the zone. Assuming the
  7271. key name is "local-ddns", this policy is equivalent to:
  7272. </p>
  7273. <pre class="programlisting">update-policy { grant local-ddns zonesub any; };
  7274. </pre>
  7275. <p>
  7276. The command <span><strong class="command">nsupdate -l</strong></span> sends update
  7277. requests to localhost, and signs them using the session key.
  7278. </p>
  7279. <p>
  7280. Other rule definitions look like this:
  7281. </p>
  7282. <pre class="programlisting">
  7283. ( <span><strong class="command">grant</strong></span> | <span><strong class="command">deny</strong></span> ) <em class="replaceable"><code>identity</code></em> <em class="replaceable"><code>nametype</code></em> [<span class="optional"> <em class="replaceable"><code>name</code></em> </span>] [<span class="optional"> <em class="replaceable"><code>types</code></em> </span>]
  7284. </pre>
  7285. <p>
  7286. Each rule grants or denies privileges. Once a message has
  7287. successfully matched a rule, the operation is immediately
  7288. granted or denied and no further rules are examined. A rule
  7289. is matched when the signer matches the identity field, the
  7290. name matches the name field in accordance with the nametype
  7291. field, and the type matches the types specified in the type
  7292. field.
  7293. </p>
  7294. <p>
  7295. No signer is required for <em class="replaceable"><code>tcp-self</code></em>
  7296. or <em class="replaceable"><code>6to4-self</code></em> however the standard
  7297. reverse mapping / prefix conversion must match the identity
  7298. field.
  7299. </p>
  7300. <p>
  7301. The identity field specifies a name or a wildcard
  7302. name. Normally, this is the name of the TSIG or
  7303. SIG(0) key used to sign the update request. When a
  7304. TKEY exchange has been used to create a shared secret,
  7305. the identity of the shared secret is the same as the
  7306. identity of the key used to authenticate the TKEY
  7307. exchange. TKEY is also the negotiation method used
  7308. by GSS-TSIG, which establishes an identity that is
  7309. the Kerberos principal of the client, such as
  7310. <strong class="userinput"><code>"user@host.domain"</code></strong>. When the
  7311. <em class="replaceable"><code>identity</code></em> field specifies
  7312. a wildcard name, it is subject to DNS wildcard
  7313. expansion, so the rule will apply to multiple identities.
  7314. The <em class="replaceable"><code>identity</code></em> field must
  7315. contain a fully-qualified domain name.
  7316. </p>
  7317. <p>
  7318. For nametypes <code class="varname">krb5-self</code>,
  7319. <code class="varname">ms-self</code>, <code class="varname">krb5-subdomain</code>,
  7320. and <code class="varname">ms-subdomain</code> the
  7321. <em class="replaceable"><code>identity</code></em> field specifies
  7322. the Windows or Kerberos realm of the machine belongs to.
  7323. </p>
  7324. <p>
  7325. The <em class="replaceable"><code>nametype</code></em> field has 13
  7326. values:
  7327. <code class="varname">name</code>, <code class="varname">subdomain</code>,
  7328. <code class="varname">wildcard</code>, <code class="varname">self</code>,
  7329. <code class="varname">selfsub</code>, <code class="varname">selfwild</code>,
  7330. <code class="varname">krb5-self</code>, <code class="varname">ms-self</code>,
  7331. <code class="varname">krb5-subdomain</code>,
  7332. <code class="varname">ms-subdomain</code>,
  7333. <code class="varname">tcp-self</code>, <code class="varname">6to4-self</code>,
  7334. <code class="varname">zonesub</code>, and <code class="varname">external</code>.
  7335. </p>
  7336. <div class="informaltable"><table border="1">
  7337. <colgroup>
  7338. <col>
  7339. <col>
  7340. </colgroup>
  7341. <tbody>
  7342. <tr>
  7343. <td>
  7344. <p>
  7345. <code class="varname">name</code>
  7346. </p>
  7347. </td>
  7348. <td>
  7349. <p>
  7350. Exact-match semantics. This rule matches
  7351. when the name being updated is identical
  7352. to the contents of the
  7353. <em class="replaceable"><code>name</code></em> field.
  7354. </p>
  7355. </td>
  7356. </tr>
  7357. <tr>
  7358. <td>
  7359. <p>
  7360. <code class="varname">subdomain</code>
  7361. </p>
  7362. </td>
  7363. <td>
  7364. <p>
  7365. This rule matches when the name being updated
  7366. is a subdomain of, or identical to, the
  7367. contents of the <em class="replaceable"><code>name</code></em>
  7368. field.
  7369. </p>
  7370. </td>
  7371. </tr>
  7372. <tr>
  7373. <td>
  7374. <p>
  7375. <code class="varname">zonesub</code>
  7376. </p>
  7377. </td>
  7378. <td>
  7379. <p>
  7380. This rule is similar to subdomain, except that
  7381. it matches when the name being updated is a
  7382. subdomain of the zone in which the
  7383. <span><strong class="command">update-policy</strong></span> statement
  7384. appears. This obviates the need to type the zone
  7385. name twice, and enables the use of a standard
  7386. <span><strong class="command">update-policy</strong></span> statement in
  7387. multiple zones without modification.
  7388. </p>
  7389. <p>
  7390. When this rule is used, the
  7391. <em class="replaceable"><code>name</code></em> field is omitted.
  7392. </p>
  7393. </td>
  7394. </tr>
  7395. <tr>
  7396. <td>
  7397. <p>
  7398. <code class="varname">wildcard</code>
  7399. </p>
  7400. </td>
  7401. <td>
  7402. <p>
  7403. The <em class="replaceable"><code>name</code></em> field
  7404. is subject to DNS wildcard expansion, and
  7405. this rule matches when the name being updated
  7406. name is a valid expansion of the wildcard.
  7407. </p>
  7408. </td>
  7409. </tr>
  7410. <tr>
  7411. <td>
  7412. <p>
  7413. <code class="varname">self</code>
  7414. </p>
  7415. </td>
  7416. <td>
  7417. <p>
  7418. This rule matches when the name being updated
  7419. matches the contents of the
  7420. <em class="replaceable"><code>identity</code></em> field.
  7421. The <em class="replaceable"><code>name</code></em> field
  7422. is ignored, but should be the same as the
  7423. <em class="replaceable"><code>identity</code></em> field.
  7424. The <code class="varname">self</code> nametype is
  7425. most useful when allowing using one key per
  7426. name to update, where the key has the same
  7427. name as the name to be updated. The
  7428. <em class="replaceable"><code>identity</code></em> would
  7429. be specified as <code class="constant">*</code> (an asterisk) in
  7430. this case.
  7431. </p>
  7432. </td>
  7433. </tr>
  7434. <tr>
  7435. <td>
  7436. <p>
  7437. <code class="varname">selfsub</code>
  7438. </p>
  7439. </td>
  7440. <td>
  7441. <p>
  7442. This rule is similar to <code class="varname">self</code>
  7443. except that subdomains of <code class="varname">self</code>
  7444. can also be updated.
  7445. </p>
  7446. </td>
  7447. </tr>
  7448. <tr>
  7449. <td>
  7450. <p>
  7451. <code class="varname">selfwild</code>
  7452. </p>
  7453. </td>
  7454. <td>
  7455. <p>
  7456. This rule is similar to <code class="varname">self</code>
  7457. except that only subdomains of
  7458. <code class="varname">self</code> can be updated.
  7459. </p>
  7460. </td>
  7461. </tr>
  7462. <tr>
  7463. <td>
  7464. <p>
  7465. <code class="varname">ms-self</code>
  7466. </p>
  7467. </td>
  7468. <td>
  7469. <p>
  7470. This rule takes a Windows machine principal
  7471. (machine$@REALM) for machine in REALM and
  7472. and converts it machine.realm allowing the machine
  7473. to update machine.realm. The REALM to be matched
  7474. is specified in the <font color="red">&lt;replacable&gt;identity&lt;/replacable&gt;</font>
  7475. field.
  7476. </p>
  7477. </td>
  7478. </tr>
  7479. <tr>
  7480. <td>
  7481. <p>
  7482. <code class="varname">ms-subdomain</code>
  7483. </p>
  7484. </td>
  7485. <td>
  7486. <p>
  7487. This rule takes a Windows machine principal
  7488. (machine$@REALM) for machine in REALM and
  7489. converts it to machine.realm allowing the machine
  7490. to update subdomains of machine.realm. The REALM
  7491. to be matched is specified in the
  7492. <font color="red">&lt;replacable&gt;identity&lt;/replacable&gt;</font> field.
  7493. </p>
  7494. </td>
  7495. </tr>
  7496. <tr>
  7497. <td>
  7498. <p>
  7499. <code class="varname">krb5-self</code>
  7500. </p>
  7501. </td>
  7502. <td>
  7503. <p>
  7504. This rule takes a Kerberos machine principal
  7505. (host/machine@REALM) for machine in REALM and
  7506. and converts it machine.realm allowing the machine
  7507. to update machine.realm. The REALM to be matched
  7508. is specified in the <font color="red">&lt;replacable&gt;identity&lt;/replacable&gt;</font>
  7509. field.
  7510. </p>
  7511. </td>
  7512. </tr>
  7513. <tr>
  7514. <td>
  7515. <p>
  7516. <code class="varname">krb5-subdomain</code>
  7517. </p>
  7518. </td>
  7519. <td>
  7520. <p>
  7521. This rule takes a Kerberos machine principal
  7522. (host/machine@REALM) for machine in REALM and
  7523. converts it to machine.realm allowing the machine
  7524. to update subdomains of machine.realm. The REALM
  7525. to be matched is specified in the
  7526. <font color="red">&lt;replacable&gt;identity&lt;/replacable&gt;</font> field.
  7527. </p>
  7528. </td>
  7529. </tr>
  7530. <tr>
  7531. <td>
  7532. <p>
  7533. <code class="varname">tcp-self</code>
  7534. </p>
  7535. </td>
  7536. <td>
  7537. <p>
  7538. Allow updates that have been sent via TCP and
  7539. for which the standard mapping from the initiating
  7540. IP address into the IN-ADDR.ARPA and IP6.ARPA
  7541. namespaces match the name to be updated.
  7542. </p>
  7543. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  7544. <h3 class="title">Note</h3>
  7545. It is theoretically possible to spoof these TCP
  7546. sessions.
  7547. </div>
  7548. </td>
  7549. </tr>
  7550. <tr>
  7551. <td>
  7552. <p>
  7553. <code class="varname">6to4-self</code>
  7554. </p>
  7555. </td>
  7556. <td>
  7557. <p>
  7558. Allow the 6to4 prefix to be update by any TCP
  7559. connection from the 6to4 network or from the
  7560. corresponding IPv4 address. This is intended
  7561. to allow NS or DNAME RRsets to be added to the
  7562. reverse tree.
  7563. </p>
  7564. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  7565. <h3 class="title">Note</h3>
  7566. It is theoretically possible to spoof these TCP
  7567. sessions.
  7568. </div>
  7569. </td>
  7570. </tr>
  7571. <tr>
  7572. <td>
  7573. <p>
  7574. <code class="varname">external</code>
  7575. </p>
  7576. </td>
  7577. <td>
  7578. <p>
  7579. This rule allows <span><strong class="command">named</strong></span>
  7580. to defer the decision of whether to allow a
  7581. given update to an external daemon.
  7582. </p>
  7583. <p>
  7584. The method of communicating with the daemon is
  7585. specified in the <em class="replaceable"><code>identity</code></em>
  7586. field, the format of which is
  7587. "<code class="constant">local:</code><em class="replaceable"><code>path</code></em>",
  7588. where <em class="replaceable"><code>path</code></em> is the location
  7589. of a UNIX-domain socket. (Currently, "local" is the
  7590. only supported mechanism.)
  7591. </p>
  7592. <p>
  7593. Requests to the external daemon are sent over the
  7594. UNIX-domain socket as datagrams with the following
  7595. format:
  7596. </p>
  7597. <pre class="programlisting">
  7598. Protocol version number (4 bytes, network byte order, currently 1)
  7599. Request length (4 bytes, network byte order)
  7600. Signer (null-terminated string)
  7601. Name (null-terminated string)
  7602. TCP source address (null-terminated string)
  7603. Rdata type (null-terminated string)
  7604. Key (null-terminated string)
  7605. TKEY token length (4 bytes, network byte order)
  7606. TKEY token (remainder of packet)</pre>
  7607. <p>
  7608. The daemon replies with a four-byte value in
  7609. network byte order, containing either 0 or 1; 0
  7610. indicates that the specified update is not
  7611. permitted, and 1 indicates that it is.
  7612. </p>
  7613. </td>
  7614. </tr>
  7615. </tbody>
  7616. </table></div>
  7617. <p>
  7618. In all cases, the <em class="replaceable"><code>name</code></em>
  7619. field must specify a fully-qualified domain name.
  7620. </p>
  7621. <p>
  7622. If no types are explicitly specified, this rule matches
  7623. all types except RRSIG, NS, SOA, NSEC and NSEC3. Types
  7624. may be specified by name, including "ANY" (ANY matches
  7625. all types except NSEC and NSEC3, which can never be
  7626. updated). Note that when an attempt is made to delete
  7627. all records associated with a name, the rules are
  7628. checked for each existing record type.
  7629. </p>
  7630. </div>
  7631. </div>
  7632. </div>
  7633. <div class="sect1" lang="en">
  7634. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  7635. <a name="id2595116"></a>Zone File</h2></div></div></div>
  7636. <div class="sect2" lang="en">
  7637. <div class="titlepage"><div><div><h3 class="title">
  7638. <a name="types_of_resource_records_and_when_to_use_them"></a>Types of Resource Records and When to Use Them</h3></div></div></div>
  7639. <p>
  7640. This section, largely borrowed from RFC 1034, describes the
  7641. concept of a Resource Record (RR) and explains when each is used.
  7642. Since the publication of RFC 1034, several new RRs have been
  7643. identified
  7644. and implemented in the DNS. These are also included.
  7645. </p>
  7646. <div class="sect3" lang="en">
  7647. <div class="titlepage"><div><div><h4 class="title">
  7648. <a name="id2595134"></a>Resource Records</h4></div></div></div>
  7649. <p>
  7650. A domain name identifies a node. Each node has a set of
  7651. resource information, which may be empty. The set of resource
  7652. information associated with a particular name is composed of
  7653. separate RRs. The order of RRs in a set is not significant and
  7654. need not be preserved by name servers, resolvers, or other
  7655. parts of the DNS. However, sorting of multiple RRs is
  7656. permitted for optimization purposes, for example, to specify
  7657. that a particular nearby server be tried first. See <a href="Bv9ARM.ch06.html#the_sortlist_statement" title="The sortlist Statement">the section called &#8220;The <span><strong class="command">sortlist</strong></span> Statement&#8221;</a> and <a href="Bv9ARM.ch06.html#rrset_ordering" title="RRset Ordering">the section called &#8220;RRset Ordering&#8221;</a>.
  7658. </p>
  7659. <p>
  7660. The components of a Resource Record are:
  7661. </p>
  7662. <div class="informaltable"><table border="1">
  7663. <colgroup>
  7664. <col>
  7665. <col>
  7666. </colgroup>
  7667. <tbody>
  7668. <tr>
  7669. <td>
  7670. <p>
  7671. owner name
  7672. </p>
  7673. </td>
  7674. <td>
  7675. <p>
  7676. The domain name where the RR is found.
  7677. </p>
  7678. </td>
  7679. </tr>
  7680. <tr>
  7681. <td>
  7682. <p>
  7683. type
  7684. </p>
  7685. </td>
  7686. <td>
  7687. <p>
  7688. An encoded 16-bit value that specifies
  7689. the type of the resource record.
  7690. </p>
  7691. </td>
  7692. </tr>
  7693. <tr>
  7694. <td>
  7695. <p>
  7696. TTL
  7697. </p>
  7698. </td>
  7699. <td>
  7700. <p>
  7701. The time-to-live of the RR. This field
  7702. is a 32-bit integer in units of seconds, and is
  7703. primarily used by
  7704. resolvers when they cache RRs. The TTL describes how
  7705. long a RR can
  7706. be cached before it should be discarded.
  7707. </p>
  7708. </td>
  7709. </tr>
  7710. <tr>
  7711. <td>
  7712. <p>
  7713. class
  7714. </p>
  7715. </td>
  7716. <td>
  7717. <p>
  7718. An encoded 16-bit value that identifies
  7719. a protocol family or instance of a protocol.
  7720. </p>
  7721. </td>
  7722. </tr>
  7723. <tr>
  7724. <td>
  7725. <p>
  7726. RDATA
  7727. </p>
  7728. </td>
  7729. <td>
  7730. <p>
  7731. The resource data. The format of the
  7732. data is type (and sometimes class) specific.
  7733. </p>
  7734. </td>
  7735. </tr>
  7736. </tbody>
  7737. </table></div>
  7738. <p>
  7739. The following are <span class="emphasis"><em>types</em></span> of valid RRs:
  7740. </p>
  7741. <div class="informaltable"><table border="1">
  7742. <colgroup>
  7743. <col>
  7744. <col>
  7745. </colgroup>
  7746. <tbody>
  7747. <tr>
  7748. <td>
  7749. <p>
  7750. A
  7751. </p>
  7752. </td>
  7753. <td>
  7754. <p>
  7755. A host address. In the IN class, this is a
  7756. 32-bit IP address. Described in RFC 1035.
  7757. </p>
  7758. </td>
  7759. </tr>
  7760. <tr>
  7761. <td>
  7762. <p>
  7763. AAAA
  7764. </p>
  7765. </td>
  7766. <td>
  7767. <p>
  7768. IPv6 address. Described in RFC 1886.
  7769. </p>
  7770. </td>
  7771. </tr>
  7772. <tr>
  7773. <td>
  7774. <p>
  7775. A6
  7776. </p>
  7777. </td>
  7778. <td>
  7779. <p>
  7780. IPv6 address. This can be a partial
  7781. address (a suffix) and an indirection to the name
  7782. where the rest of the
  7783. address (the prefix) can be found. Experimental.
  7784. Described in RFC 2874.
  7785. </p>
  7786. </td>
  7787. </tr>
  7788. <tr>
  7789. <td>
  7790. <p>
  7791. AFSDB
  7792. </p>
  7793. </td>
  7794. <td>
  7795. <p>
  7796. Location of AFS database servers.
  7797. Experimental. Described in RFC 1183.
  7798. </p>
  7799. </td>
  7800. </tr>
  7801. <tr>
  7802. <td>
  7803. <p>
  7804. APL
  7805. </p>
  7806. </td>
  7807. <td>
  7808. <p>
  7809. Address prefix list. Experimental.
  7810. Described in RFC 3123.
  7811. </p>
  7812. </td>
  7813. </tr>
  7814. <tr>
  7815. <td>
  7816. <p>
  7817. CERT
  7818. </p>
  7819. </td>
  7820. <td>
  7821. <p>
  7822. Holds a digital certificate.
  7823. Described in RFC 2538.
  7824. </p>
  7825. </td>
  7826. </tr>
  7827. <tr>
  7828. <td>
  7829. <p>
  7830. CNAME
  7831. </p>
  7832. </td>
  7833. <td>
  7834. <p>
  7835. Identifies the canonical name of an alias.
  7836. Described in RFC 1035.
  7837. </p>
  7838. </td>
  7839. </tr>
  7840. <tr>
  7841. <td>
  7842. <p>
  7843. DHCID
  7844. </p>
  7845. </td>
  7846. <td>
  7847. <p>
  7848. Is used for identifying which DHCP client is
  7849. associated with this name. Described in RFC 4701.
  7850. </p>
  7851. </td>
  7852. </tr>
  7853. <tr>
  7854. <td>
  7855. <p>
  7856. DNAME
  7857. </p>
  7858. </td>
  7859. <td>
  7860. <p>
  7861. Replaces the domain name specified with
  7862. another name to be looked up, effectively aliasing an
  7863. entire
  7864. subtree of the domain name space rather than a single
  7865. record
  7866. as in the case of the CNAME RR.
  7867. Described in RFC 2672.
  7868. </p>
  7869. </td>
  7870. </tr>
  7871. <tr>
  7872. <td>
  7873. <p>
  7874. DNSKEY
  7875. </p>
  7876. </td>
  7877. <td>
  7878. <p>
  7879. Stores a public key associated with a signed
  7880. DNS zone. Described in RFC 4034.
  7881. </p>
  7882. </td>
  7883. </tr>
  7884. <tr>
  7885. <td>
  7886. <p>
  7887. DS
  7888. </p>
  7889. </td>
  7890. <td>
  7891. <p>
  7892. Stores the hash of a public key associated with a
  7893. signed DNS zone. Described in RFC 4034.
  7894. </p>
  7895. </td>
  7896. </tr>
  7897. <tr>
  7898. <td>
  7899. <p>
  7900. GPOS
  7901. </p>
  7902. </td>
  7903. <td>
  7904. <p>
  7905. Specifies the global position. Superseded by LOC.
  7906. </p>
  7907. </td>
  7908. </tr>
  7909. <tr>
  7910. <td>
  7911. <p>
  7912. HINFO
  7913. </p>
  7914. </td>
  7915. <td>
  7916. <p>
  7917. Identifies the CPU and OS used by a host.
  7918. Described in RFC 1035.
  7919. </p>
  7920. </td>
  7921. </tr>
  7922. <tr>
  7923. <td>
  7924. <p>
  7925. IPSECKEY
  7926. </p>
  7927. </td>
  7928. <td>
  7929. <p>
  7930. Provides a method for storing IPsec keying material in
  7931. DNS. Described in RFC 4025.
  7932. </p>
  7933. </td>
  7934. </tr>
  7935. <tr>
  7936. <td>
  7937. <p>
  7938. ISDN
  7939. </p>
  7940. </td>
  7941. <td>
  7942. <p>
  7943. Representation of ISDN addresses.
  7944. Experimental. Described in RFC 1183.
  7945. </p>
  7946. </td>
  7947. </tr>
  7948. <tr>
  7949. <td>
  7950. <p>
  7951. KEY
  7952. </p>
  7953. </td>
  7954. <td>
  7955. <p>
  7956. Stores a public key associated with a
  7957. DNS name. Used in original DNSSEC; replaced
  7958. by DNSKEY in DNSSECbis, but still used with
  7959. SIG(0). Described in RFCs 2535 and 2931.
  7960. </p>
  7961. </td>
  7962. </tr>
  7963. <tr>
  7964. <td>
  7965. <p>
  7966. KX
  7967. </p>
  7968. </td>
  7969. <td>
  7970. <p>
  7971. Identifies a key exchanger for this
  7972. DNS name. Described in RFC 2230.
  7973. </p>
  7974. </td>
  7975. </tr>
  7976. <tr>
  7977. <td>
  7978. <p>
  7979. LOC
  7980. </p>
  7981. </td>
  7982. <td>
  7983. <p>
  7984. For storing GPS info. Described in RFC 1876.
  7985. Experimental.
  7986. </p>
  7987. </td>
  7988. </tr>
  7989. <tr>
  7990. <td>
  7991. <p>
  7992. MX
  7993. </p>
  7994. </td>
  7995. <td>
  7996. <p>
  7997. Identifies a mail exchange for the domain with
  7998. a 16-bit preference value (lower is better)
  7999. followed by the host name of the mail exchange.
  8000. Described in RFC 974, RFC 1035.
  8001. </p>
  8002. </td>
  8003. </tr>
  8004. <tr>
  8005. <td>
  8006. <p>
  8007. NAPTR
  8008. </p>
  8009. </td>
  8010. <td>
  8011. <p>
  8012. Name authority pointer. Described in RFC 2915.
  8013. </p>
  8014. </td>
  8015. </tr>
  8016. <tr>
  8017. <td>
  8018. <p>
  8019. NSAP
  8020. </p>
  8021. </td>
  8022. <td>
  8023. <p>
  8024. A network service access point.
  8025. Described in RFC 1706.
  8026. </p>
  8027. </td>
  8028. </tr>
  8029. <tr>
  8030. <td>
  8031. <p>
  8032. NS
  8033. </p>
  8034. </td>
  8035. <td>
  8036. <p>
  8037. The authoritative name server for the
  8038. domain. Described in RFC 1035.
  8039. </p>
  8040. </td>
  8041. </tr>
  8042. <tr>
  8043. <td>
  8044. <p>
  8045. NSEC
  8046. </p>
  8047. </td>
  8048. <td>
  8049. <p>
  8050. Used in DNSSECbis to securely indicate that
  8051. RRs with an owner name in a certain name interval do
  8052. not exist in
  8053. a zone and indicate what RR types are present for an
  8054. existing name.
  8055. Described in RFC 4034.
  8056. </p>
  8057. </td>
  8058. </tr>
  8059. <tr>
  8060. <td>
  8061. <p>
  8062. NSEC3
  8063. </p>
  8064. </td>
  8065. <td>
  8066. <p>
  8067. Used in DNSSECbis to securely indicate that
  8068. RRs with an owner name in a certain name
  8069. interval do not exist in a zone and indicate
  8070. what RR types are present for an existing
  8071. name. NSEC3 differs from NSEC in that it
  8072. prevents zone enumeration but is more
  8073. computationally expensive on both the server
  8074. and the client than NSEC. Described in RFC
  8075. 5155.
  8076. </p>
  8077. </td>
  8078. </tr>
  8079. <tr>
  8080. <td>
  8081. <p>
  8082. NSEC3PARAM
  8083. </p>
  8084. </td>
  8085. <td>
  8086. <p>
  8087. Used in DNSSECbis to tell the authoritative
  8088. server which NSEC3 chains are available to use.
  8089. Described in RFC 5155.
  8090. </p>
  8091. </td>
  8092. </tr>
  8093. <tr>
  8094. <td>
  8095. <p>
  8096. NXT
  8097. </p>
  8098. </td>
  8099. <td>
  8100. <p>
  8101. Used in DNSSEC to securely indicate that
  8102. RRs with an owner name in a certain name interval do
  8103. not exist in
  8104. a zone and indicate what RR types are present for an
  8105. existing name.
  8106. Used in original DNSSEC; replaced by NSEC in
  8107. DNSSECbis.
  8108. Described in RFC 2535.
  8109. </p>
  8110. </td>
  8111. </tr>
  8112. <tr>
  8113. <td>
  8114. <p>
  8115. PTR
  8116. </p>
  8117. </td>
  8118. <td>
  8119. <p>
  8120. A pointer to another part of the domain
  8121. name space. Described in RFC 1035.
  8122. </p>
  8123. </td>
  8124. </tr>
  8125. <tr>
  8126. <td>
  8127. <p>
  8128. PX
  8129. </p>
  8130. </td>
  8131. <td>
  8132. <p>
  8133. Provides mappings between RFC 822 and X.400
  8134. addresses. Described in RFC 2163.
  8135. </p>
  8136. </td>
  8137. </tr>
  8138. <tr>
  8139. <td>
  8140. <p>
  8141. RP
  8142. </p>
  8143. </td>
  8144. <td>
  8145. <p>
  8146. Information on persons responsible
  8147. for the domain. Experimental. Described in RFC 1183.
  8148. </p>
  8149. </td>
  8150. </tr>
  8151. <tr>
  8152. <td>
  8153. <p>
  8154. RRSIG
  8155. </p>
  8156. </td>
  8157. <td>
  8158. <p>
  8159. Contains DNSSECbis signature data. Described
  8160. in RFC 4034.
  8161. </p>
  8162. </td>
  8163. </tr>
  8164. <tr>
  8165. <td>
  8166. <p>
  8167. RT
  8168. </p>
  8169. </td>
  8170. <td>
  8171. <p>
  8172. Route-through binding for hosts that
  8173. do not have their own direct wide area network
  8174. addresses.
  8175. Experimental. Described in RFC 1183.
  8176. </p>
  8177. </td>
  8178. </tr>
  8179. <tr>
  8180. <td>
  8181. <p>
  8182. SIG
  8183. </p>
  8184. </td>
  8185. <td>
  8186. <p>
  8187. Contains DNSSEC signature data. Used in
  8188. original DNSSEC; replaced by RRSIG in
  8189. DNSSECbis, but still used for SIG(0).
  8190. Described in RFCs 2535 and 2931.
  8191. </p>
  8192. </td>
  8193. </tr>
  8194. <tr>
  8195. <td>
  8196. <p>
  8197. SOA
  8198. </p>
  8199. </td>
  8200. <td>
  8201. <p>
  8202. Identifies the start of a zone of authority.
  8203. Described in RFC 1035.
  8204. </p>
  8205. </td>
  8206. </tr>
  8207. <tr>
  8208. <td>
  8209. <p>
  8210. SPF
  8211. </p>
  8212. </td>
  8213. <td>
  8214. <p>
  8215. Contains the Sender Policy Framework information
  8216. for a given email domain. Described in RFC 4408.
  8217. </p>
  8218. </td>
  8219. </tr>
  8220. <tr>
  8221. <td>
  8222. <p>
  8223. SRV
  8224. </p>
  8225. </td>
  8226. <td>
  8227. <p>
  8228. Information about well known network
  8229. services (replaces WKS). Described in RFC 2782.
  8230. </p>
  8231. </td>
  8232. </tr>
  8233. <tr>
  8234. <td>
  8235. <p>
  8236. SSHFP
  8237. </p>
  8238. </td>
  8239. <td>
  8240. <p>
  8241. Provides a way to securely publish a secure shell key's
  8242. fingerprint. Described in RFC 4255.
  8243. </p>
  8244. </td>
  8245. </tr>
  8246. <tr>
  8247. <td>
  8248. <p>
  8249. TXT
  8250. </p>
  8251. </td>
  8252. <td>
  8253. <p>
  8254. Text records. Described in RFC 1035.
  8255. </p>
  8256. </td>
  8257. </tr>
  8258. <tr>
  8259. <td>
  8260. <p>
  8261. WKS
  8262. </p>
  8263. </td>
  8264. <td>
  8265. <p>
  8266. Information about which well known
  8267. network services, such as SMTP, that a domain
  8268. supports. Historical.
  8269. </p>
  8270. </td>
  8271. </tr>
  8272. <tr>
  8273. <td>
  8274. <p>
  8275. X25
  8276. </p>
  8277. </td>
  8278. <td>
  8279. <p>
  8280. Representation of X.25 network addresses.
  8281. Experimental. Described in RFC 1183.
  8282. </p>
  8283. </td>
  8284. </tr>
  8285. </tbody>
  8286. </table></div>
  8287. <p>
  8288. The following <span class="emphasis"><em>classes</em></span> of resource records
  8289. are currently valid in the DNS:
  8290. </p>
  8291. <div class="informaltable"><table border="1">
  8292. <colgroup>
  8293. <col>
  8294. <col>
  8295. </colgroup>
  8296. <tbody>
  8297. <tr>
  8298. <td>
  8299. <p>
  8300. IN
  8301. </p>
  8302. </td>
  8303. <td>
  8304. <p>
  8305. The Internet.
  8306. </p>
  8307. </td>
  8308. </tr>
  8309. <tr>
  8310. <td>
  8311. <p>
  8312. CH
  8313. </p>
  8314. </td>
  8315. <td>
  8316. <p>
  8317. Chaosnet, a LAN protocol created at MIT in the
  8318. mid-1970s.
  8319. Rarely used for its historical purpose, but reused for
  8320. BIND's
  8321. built-in server information zones, e.g.,
  8322. <code class="literal">version.bind</code>.
  8323. </p>
  8324. </td>
  8325. </tr>
  8326. <tr>
  8327. <td>
  8328. <p>
  8329. HS
  8330. </p>
  8331. </td>
  8332. <td>
  8333. <p>
  8334. Hesiod, an information service
  8335. developed by MIT's Project Athena. It is used to share
  8336. information
  8337. about various systems databases, such as users,
  8338. groups, printers
  8339. and so on.
  8340. </p>
  8341. </td>
  8342. </tr>
  8343. </tbody>
  8344. </table></div>
  8345. <p>
  8346. The owner name is often implicit, rather than forming an
  8347. integral
  8348. part of the RR. For example, many name servers internally form
  8349. tree
  8350. or hash structures for the name space, and chain RRs off nodes.
  8351. The remaining RR parts are the fixed header (type, class, TTL)
  8352. which is consistent for all RRs, and a variable part (RDATA)
  8353. that
  8354. fits the needs of the resource being described.
  8355. </p>
  8356. <p>
  8357. The meaning of the TTL field is a time limit on how long an
  8358. RR can be kept in a cache. This limit does not apply to
  8359. authoritative
  8360. data in zones; it is also timed out, but by the refreshing
  8361. policies
  8362. for the zone. The TTL is assigned by the administrator for the
  8363. zone where the data originates. While short TTLs can be used to
  8364. minimize caching, and a zero TTL prohibits caching, the
  8365. realities
  8366. of Internet performance suggest that these times should be on
  8367. the
  8368. order of days for the typical host. If a change can be
  8369. anticipated,
  8370. the TTL can be reduced prior to the change to minimize
  8371. inconsistency
  8372. during the change, and then increased back to its former value
  8373. following
  8374. the change.
  8375. </p>
  8376. <p>
  8377. The data in the RDATA section of RRs is carried as a combination
  8378. of binary strings and domain names. The domain names are
  8379. frequently
  8380. used as "pointers" to other data in the DNS.
  8381. </p>
  8382. </div>
  8383. <div class="sect3" lang="en">
  8384. <div class="titlepage"><div><div><h4 class="title">
  8385. <a name="id2596826"></a>Textual expression of RRs</h4></div></div></div>
  8386. <p>
  8387. RRs are represented in binary form in the packets of the DNS
  8388. protocol, and are usually represented in highly encoded form
  8389. when
  8390. stored in a name server or resolver. In the examples provided
  8391. in
  8392. RFC 1034, a style similar to that used in master files was
  8393. employed
  8394. in order to show the contents of RRs. In this format, most RRs
  8395. are shown on a single line, although continuation lines are
  8396. possible
  8397. using parentheses.
  8398. </p>
  8399. <p>
  8400. The start of the line gives the owner of the RR. If a line
  8401. begins with a blank, then the owner is assumed to be the same as
  8402. that of the previous RR. Blank lines are often included for
  8403. readability.
  8404. </p>
  8405. <p>
  8406. Following the owner, we list the TTL, type, and class of the
  8407. RR. Class and type use the mnemonics defined above, and TTL is
  8408. an integer before the type field. In order to avoid ambiguity
  8409. in
  8410. parsing, type and class mnemonics are disjoint, TTLs are
  8411. integers,
  8412. and the type mnemonic is always last. The IN class and TTL
  8413. values
  8414. are often omitted from examples in the interests of clarity.
  8415. </p>
  8416. <p>
  8417. The resource data or RDATA section of the RR are given using
  8418. knowledge of the typical representation for the data.
  8419. </p>
  8420. <p>
  8421. For example, we might show the RRs carried in a message as:
  8422. </p>
  8423. <div class="informaltable"><table border="1">
  8424. <colgroup>
  8425. <col>
  8426. <col>
  8427. <col>
  8428. </colgroup>
  8429. <tbody>
  8430. <tr>
  8431. <td>
  8432. <p>
  8433. <code class="literal">ISI.EDU.</code>
  8434. </p>
  8435. </td>
  8436. <td>
  8437. <p>
  8438. <code class="literal">MX</code>
  8439. </p>
  8440. </td>
  8441. <td>
  8442. <p>
  8443. <code class="literal">10 VENERA.ISI.EDU.</code>
  8444. </p>
  8445. </td>
  8446. </tr>
  8447. <tr>
  8448. <td>
  8449. <p></p>
  8450. </td>
  8451. <td>
  8452. <p>
  8453. <code class="literal">MX</code>
  8454. </p>
  8455. </td>
  8456. <td>
  8457. <p>
  8458. <code class="literal">10 VAXA.ISI.EDU</code>
  8459. </p>
  8460. </td>
  8461. </tr>
  8462. <tr>
  8463. <td>
  8464. <p>
  8465. <code class="literal">VENERA.ISI.EDU</code>
  8466. </p>
  8467. </td>
  8468. <td>
  8469. <p>
  8470. <code class="literal">A</code>
  8471. </p>
  8472. </td>
  8473. <td>
  8474. <p>
  8475. <code class="literal">128.9.0.32</code>
  8476. </p>
  8477. </td>
  8478. </tr>
  8479. <tr>
  8480. <td>
  8481. <p></p>
  8482. </td>
  8483. <td>
  8484. <p>
  8485. <code class="literal">A</code>
  8486. </p>
  8487. </td>
  8488. <td>
  8489. <p>
  8490. <code class="literal">10.1.0.52</code>
  8491. </p>
  8492. </td>
  8493. </tr>
  8494. <tr>
  8495. <td>
  8496. <p>
  8497. <code class="literal">VAXA.ISI.EDU</code>
  8498. </p>
  8499. </td>
  8500. <td>
  8501. <p>
  8502. <code class="literal">A</code>
  8503. </p>
  8504. </td>
  8505. <td>
  8506. <p>
  8507. <code class="literal">10.2.0.27</code>
  8508. </p>
  8509. </td>
  8510. </tr>
  8511. <tr>
  8512. <td>
  8513. <p></p>
  8514. </td>
  8515. <td>
  8516. <p>
  8517. <code class="literal">A</code>
  8518. </p>
  8519. </td>
  8520. <td>
  8521. <p>
  8522. <code class="literal">128.9.0.33</code>
  8523. </p>
  8524. </td>
  8525. </tr>
  8526. </tbody>
  8527. </table></div>
  8528. <p>
  8529. The MX RRs have an RDATA section which consists of a 16-bit
  8530. number followed by a domain name. The address RRs use a
  8531. standard
  8532. IP address format to contain a 32-bit internet address.
  8533. </p>
  8534. <p>
  8535. The above example shows six RRs, with two RRs at each of three
  8536. domain names.
  8537. </p>
  8538. <p>
  8539. Similarly we might see:
  8540. </p>
  8541. <div class="informaltable"><table border="1">
  8542. <colgroup>
  8543. <col>
  8544. <col>
  8545. <col>
  8546. </colgroup>
  8547. <tbody>
  8548. <tr>
  8549. <td>
  8550. <p>
  8551. <code class="literal">XX.LCS.MIT.EDU.</code>
  8552. </p>
  8553. </td>
  8554. <td>
  8555. <p>
  8556. <code class="literal">IN A</code>
  8557. </p>
  8558. </td>
  8559. <td>
  8560. <p>
  8561. <code class="literal">10.0.0.44</code>
  8562. </p>
  8563. </td>
  8564. </tr>
  8565. <tr>
  8566. <td> </td>
  8567. <td>
  8568. <p>
  8569. <code class="literal">CH A</code>
  8570. </p>
  8571. </td>
  8572. <td>
  8573. <p>
  8574. <code class="literal">MIT.EDU. 2420</code>
  8575. </p>
  8576. </td>
  8577. </tr>
  8578. </tbody>
  8579. </table></div>
  8580. <p>
  8581. This example shows two addresses for
  8582. <code class="literal">XX.LCS.MIT.EDU</code>, each of a different class.
  8583. </p>
  8584. </div>
  8585. </div>
  8586. <div class="sect2" lang="en">
  8587. <div class="titlepage"><div><div><h3 class="title">
  8588. <a name="id2597415"></a>Discussion of MX Records</h3></div></div></div>
  8589. <p>
  8590. As described above, domain servers store information as a
  8591. series of resource records, each of which contains a particular
  8592. piece of information about a given domain name (which is usually,
  8593. but not always, a host). The simplest way to think of a RR is as
  8594. a typed pair of data, a domain name matched with a relevant datum,
  8595. and stored with some additional type information to help systems
  8596. determine when the RR is relevant.
  8597. </p>
  8598. <p>
  8599. MX records are used to control delivery of email. The data
  8600. specified in the record is a priority and a domain name. The
  8601. priority
  8602. controls the order in which email delivery is attempted, with the
  8603. lowest number first. If two priorities are the same, a server is
  8604. chosen randomly. If no servers at a given priority are responding,
  8605. the mail transport agent will fall back to the next largest
  8606. priority.
  8607. Priority numbers do not have any absolute meaning &#8212; they are
  8608. relevant
  8609. only respective to other MX records for that domain name. The
  8610. domain
  8611. name given is the machine to which the mail will be delivered.
  8612. It <span class="emphasis"><em>must</em></span> have an associated address record
  8613. (A or AAAA) &#8212; CNAME is not sufficient.
  8614. </p>
  8615. <p>
  8616. For a given domain, if there is both a CNAME record and an
  8617. MX record, the MX record is in error, and will be ignored.
  8618. Instead,
  8619. the mail will be delivered to the server specified in the MX
  8620. record
  8621. pointed to by the CNAME.
  8622. For example:
  8623. </p>
  8624. <div class="informaltable"><table border="1">
  8625. <colgroup>
  8626. <col>
  8627. <col>
  8628. <col>
  8629. <col>
  8630. <col>
  8631. </colgroup>
  8632. <tbody>
  8633. <tr>
  8634. <td>
  8635. <p>
  8636. <code class="literal">example.com.</code>
  8637. </p>
  8638. </td>
  8639. <td>
  8640. <p>
  8641. <code class="literal">IN</code>
  8642. </p>
  8643. </td>
  8644. <td>
  8645. <p>
  8646. <code class="literal">MX</code>
  8647. </p>
  8648. </td>
  8649. <td>
  8650. <p>
  8651. <code class="literal">10</code>
  8652. </p>
  8653. </td>
  8654. <td>
  8655. <p>
  8656. <code class="literal">mail.example.com.</code>
  8657. </p>
  8658. </td>
  8659. </tr>
  8660. <tr>
  8661. <td>
  8662. <p></p>
  8663. </td>
  8664. <td>
  8665. <p>
  8666. <code class="literal">IN</code>
  8667. </p>
  8668. </td>
  8669. <td>
  8670. <p>
  8671. <code class="literal">MX</code>
  8672. </p>
  8673. </td>
  8674. <td>
  8675. <p>
  8676. <code class="literal">10</code>
  8677. </p>
  8678. </td>
  8679. <td>
  8680. <p>
  8681. <code class="literal">mail2.example.com.</code>
  8682. </p>
  8683. </td>
  8684. </tr>
  8685. <tr>
  8686. <td>
  8687. <p></p>
  8688. </td>
  8689. <td>
  8690. <p>
  8691. <code class="literal">IN</code>
  8692. </p>
  8693. </td>
  8694. <td>
  8695. <p>
  8696. <code class="literal">MX</code>
  8697. </p>
  8698. </td>
  8699. <td>
  8700. <p>
  8701. <code class="literal">20</code>
  8702. </p>
  8703. </td>
  8704. <td>
  8705. <p>
  8706. <code class="literal">mail.backup.org.</code>
  8707. </p>
  8708. </td>
  8709. </tr>
  8710. <tr>
  8711. <td>
  8712. <p>
  8713. <code class="literal">mail.example.com.</code>
  8714. </p>
  8715. </td>
  8716. <td>
  8717. <p>
  8718. <code class="literal">IN</code>
  8719. </p>
  8720. </td>
  8721. <td>
  8722. <p>
  8723. <code class="literal">A</code>
  8724. </p>
  8725. </td>
  8726. <td>
  8727. <p>
  8728. <code class="literal">10.0.0.1</code>
  8729. </p>
  8730. </td>
  8731. <td>
  8732. <p></p>
  8733. </td>
  8734. </tr>
  8735. <tr>
  8736. <td>
  8737. <p>
  8738. <code class="literal">mail2.example.com.</code>
  8739. </p>
  8740. </td>
  8741. <td>
  8742. <p>
  8743. <code class="literal">IN</code>
  8744. </p>
  8745. </td>
  8746. <td>
  8747. <p>
  8748. <code class="literal">A</code>
  8749. </p>
  8750. </td>
  8751. <td>
  8752. <p>
  8753. <code class="literal">10.0.0.2</code>
  8754. </p>
  8755. </td>
  8756. <td>
  8757. <p></p>
  8758. </td>
  8759. </tr>
  8760. </tbody>
  8761. </table></div>
  8762. <p>
  8763. Mail delivery will be attempted to <code class="literal">mail.example.com</code> and
  8764. <code class="literal">mail2.example.com</code> (in
  8765. any order), and if neither of those succeed, delivery to <code class="literal">mail.backup.org</code> will
  8766. be attempted.
  8767. </p>
  8768. </div>
  8769. <div class="sect2" lang="en">
  8770. <div class="titlepage"><div><div><h3 class="title">
  8771. <a name="Setting_TTLs"></a>Setting TTLs</h3></div></div></div>
  8772. <p>
  8773. The time-to-live of the RR field is a 32-bit integer represented
  8774. in units of seconds, and is primarily used by resolvers when they
  8775. cache RRs. The TTL describes how long a RR can be cached before it
  8776. should be discarded. The following three types of TTL are
  8777. currently
  8778. used in a zone file.
  8779. </p>
  8780. <div class="informaltable"><table border="1">
  8781. <colgroup>
  8782. <col>
  8783. <col>
  8784. </colgroup>
  8785. <tbody>
  8786. <tr>
  8787. <td>
  8788. <p>
  8789. SOA
  8790. </p>
  8791. </td>
  8792. <td>
  8793. <p>
  8794. The last field in the SOA is the negative
  8795. caching TTL. This controls how long other servers will
  8796. cache no-such-domain
  8797. (NXDOMAIN) responses from you.
  8798. </p>
  8799. <p>
  8800. The maximum time for
  8801. negative caching is 3 hours (3h).
  8802. </p>
  8803. </td>
  8804. </tr>
  8805. <tr>
  8806. <td>
  8807. <p>
  8808. $TTL
  8809. </p>
  8810. </td>
  8811. <td>
  8812. <p>
  8813. The $TTL directive at the top of the
  8814. zone file (before the SOA) gives a default TTL for every
  8815. RR without
  8816. a specific TTL set.
  8817. </p>
  8818. </td>
  8819. </tr>
  8820. <tr>
  8821. <td>
  8822. <p>
  8823. RR TTLs
  8824. </p>
  8825. </td>
  8826. <td>
  8827. <p>
  8828. Each RR can have a TTL as the second
  8829. field in the RR, which will control how long other
  8830. servers can cache
  8831. the it.
  8832. </p>
  8833. </td>
  8834. </tr>
  8835. </tbody>
  8836. </table></div>
  8837. <p>
  8838. All of these TTLs default to units of seconds, though units
  8839. can be explicitly specified, for example, <code class="literal">1h30m</code>.
  8840. </p>
  8841. </div>
  8842. <div class="sect2" lang="en">
  8843. <div class="titlepage"><div><div><h3 class="title">
  8844. <a name="id2597962"></a>Inverse Mapping in IPv4</h3></div></div></div>
  8845. <p>
  8846. Reverse name resolution (that is, translation from IP address
  8847. to name) is achieved by means of the <span class="emphasis"><em>in-addr.arpa</em></span> domain
  8848. and PTR records. Entries in the in-addr.arpa domain are made in
  8849. least-to-most significant order, read left to right. This is the
  8850. opposite order to the way IP addresses are usually written. Thus,
  8851. a machine with an IP address of 10.1.2.3 would have a
  8852. corresponding
  8853. in-addr.arpa name of
  8854. 3.2.1.10.in-addr.arpa. This name should have a PTR resource record
  8855. whose data field is the name of the machine or, optionally,
  8856. multiple
  8857. PTR records if the machine has more than one name. For example,
  8858. in the [<span class="optional">example.com</span>] domain:
  8859. </p>
  8860. <div class="informaltable"><table border="1">
  8861. <colgroup>
  8862. <col>
  8863. <col>
  8864. </colgroup>
  8865. <tbody>
  8866. <tr>
  8867. <td>
  8868. <p>
  8869. <code class="literal">$ORIGIN</code>
  8870. </p>
  8871. </td>
  8872. <td>
  8873. <p>
  8874. <code class="literal">2.1.10.in-addr.arpa</code>
  8875. </p>
  8876. </td>
  8877. </tr>
  8878. <tr>
  8879. <td>
  8880. <p>
  8881. <code class="literal">3</code>
  8882. </p>
  8883. </td>
  8884. <td>
  8885. <p>
  8886. <code class="literal">IN PTR foo.example.com.</code>
  8887. </p>
  8888. </td>
  8889. </tr>
  8890. </tbody>
  8891. </table></div>
  8892. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  8893. <h3 class="title">Note</h3>
  8894. <p>
  8895. The <span><strong class="command">$ORIGIN</strong></span> lines in the examples
  8896. are for providing context to the examples only &#8212; they do not
  8897. necessarily
  8898. appear in the actual usage. They are only used here to indicate
  8899. that the example is relative to the listed origin.
  8900. </p>
  8901. </div>
  8902. </div>
  8903. <div class="sect2" lang="en">
  8904. <div class="titlepage"><div><div><h3 class="title">
  8905. <a name="id2598157"></a>Other Zone File Directives</h3></div></div></div>
  8906. <p>
  8907. The Master File Format was initially defined in RFC 1035 and
  8908. has subsequently been extended. While the Master File Format
  8909. itself
  8910. is class independent all records in a Master File must be of the
  8911. same
  8912. class.
  8913. </p>
  8914. <p>
  8915. Master File Directives include <span><strong class="command">$ORIGIN</strong></span>, <span><strong class="command">$INCLUDE</strong></span>,
  8916. and <span><strong class="command">$TTL.</strong></span>
  8917. </p>
  8918. <div class="sect3" lang="en">
  8919. <div class="titlepage"><div><div><h4 class="title">
  8920. <a name="id2598180"></a>The <span><strong class="command">@</strong></span> (at-sign)</h4></div></div></div>
  8921. <p>
  8922. When used in the label (or name) field, the asperand or
  8923. at-sign (@) symbol represents the current origin.
  8924. At the start of the zone file, it is the
  8925. &lt;<code class="varname">zone_name</code>&gt; (followed by
  8926. trailing dot).
  8927. </p>
  8928. </div>
  8929. <div class="sect3" lang="en">
  8930. <div class="titlepage"><div><div><h4 class="title">
  8931. <a name="id2598196"></a>The <span><strong class="command">$ORIGIN</strong></span> Directive</h4></div></div></div>
  8932. <p>
  8933. Syntax: <span><strong class="command">$ORIGIN</strong></span>
  8934. <em class="replaceable"><code>domain-name</code></em>
  8935. [<span class="optional"><em class="replaceable"><code>comment</code></em></span>]
  8936. </p>
  8937. <p><span><strong class="command">$ORIGIN</strong></span>
  8938. sets the domain name that will be appended to any
  8939. unqualified records. When a zone is first read in there
  8940. is an implicit <span><strong class="command">$ORIGIN</strong></span>
  8941. &lt;<code class="varname">zone_name</code>&gt;<span><strong class="command">.</strong></span>
  8942. (followed by trailing dot).
  8943. The current <span><strong class="command">$ORIGIN</strong></span> is appended to
  8944. the domain specified in the <span><strong class="command">$ORIGIN</strong></span>
  8945. argument if it is not absolute.
  8946. </p>
  8947. <pre class="programlisting">
  8948. $ORIGIN example.com.
  8949. WWW CNAME MAIN-SERVER
  8950. </pre>
  8951. <p>
  8952. is equivalent to
  8953. </p>
  8954. <pre class="programlisting">
  8955. WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM.
  8956. </pre>
  8957. </div>
  8958. <div class="sect3" lang="en">
  8959. <div class="titlepage"><div><div><h4 class="title">
  8960. <a name="id2598325"></a>The <span><strong class="command">$INCLUDE</strong></span> Directive</h4></div></div></div>
  8961. <p>
  8962. Syntax: <span><strong class="command">$INCLUDE</strong></span>
  8963. <em class="replaceable"><code>filename</code></em>
  8964. [<span class="optional">
  8965. <em class="replaceable"><code>origin</code></em> </span>]
  8966. [<span class="optional"> <em class="replaceable"><code>comment</code></em> </span>]
  8967. </p>
  8968. <p>
  8969. Read and process the file <code class="filename">filename</code> as
  8970. if it were included into the file at this point. If <span><strong class="command">origin</strong></span> is
  8971. specified the file is processed with <span><strong class="command">$ORIGIN</strong></span> set
  8972. to that value, otherwise the current <span><strong class="command">$ORIGIN</strong></span> is
  8973. used.
  8974. </p>
  8975. <p>
  8976. The origin and the current domain name
  8977. revert to the values they had prior to the <span><strong class="command">$INCLUDE</strong></span> once
  8978. the file has been read.
  8979. </p>
  8980. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  8981. <h3 class="title">Note</h3>
  8982. <p>
  8983. RFC 1035 specifies that the current origin should be restored
  8984. after
  8985. an <span><strong class="command">$INCLUDE</strong></span>, but it is silent
  8986. on whether the current
  8987. domain name should also be restored. BIND 9 restores both of
  8988. them.
  8989. This could be construed as a deviation from RFC 1035, a
  8990. feature, or both.
  8991. </p>
  8992. </div>
  8993. </div>
  8994. <div class="sect3" lang="en">
  8995. <div class="titlepage"><div><div><h4 class="title">
  8996. <a name="id2598394"></a>The <span><strong class="command">$TTL</strong></span> Directive</h4></div></div></div>
  8997. <p>
  8998. Syntax: <span><strong class="command">$TTL</strong></span>
  8999. <em class="replaceable"><code>default-ttl</code></em>
  9000. [<span class="optional">
  9001. <em class="replaceable"><code>comment</code></em> </span>]
  9002. </p>
  9003. <p>
  9004. Set the default Time To Live (TTL) for subsequent records
  9005. with undefined TTLs. Valid TTLs are of the range 0-2147483647
  9006. seconds.
  9007. </p>
  9008. <p><span><strong class="command">$TTL</strong></span>
  9009. is defined in RFC 2308.
  9010. </p>
  9011. </div>
  9012. </div>
  9013. <div class="sect2" lang="en">
  9014. <div class="titlepage"><div><div><h3 class="title">
  9015. <a name="id2598430"></a><acronym class="acronym">BIND</acronym> Master File Extension: the <span><strong class="command">$GENERATE</strong></span> Directive</h3></div></div></div>
  9016. <p>
  9017. Syntax: <span><strong class="command">$GENERATE</strong></span>
  9018. <em class="replaceable"><code>range</code></em>
  9019. <em class="replaceable"><code>lhs</code></em>
  9020. [<span class="optional"><em class="replaceable"><code>ttl</code></em></span>]
  9021. [<span class="optional"><em class="replaceable"><code>class</code></em></span>]
  9022. <em class="replaceable"><code>type</code></em>
  9023. <em class="replaceable"><code>rhs</code></em>
  9024. [<span class="optional"><em class="replaceable"><code>comment</code></em></span>]
  9025. </p>
  9026. <p><span><strong class="command">$GENERATE</strong></span>
  9027. is used to create a series of resource records that only
  9028. differ from each other by an
  9029. iterator. <span><strong class="command">$GENERATE</strong></span> can be used to
  9030. easily generate the sets of records required to support
  9031. sub /24 reverse delegations described in RFC 2317:
  9032. Classless IN-ADDR.ARPA delegation.
  9033. </p>
  9034. <pre class="programlisting">$ORIGIN 0.0.192.IN-ADDR.ARPA.
  9035. $GENERATE 1-2 @ NS SERVER$.EXAMPLE.
  9036. $GENERATE 1-127 $ CNAME $.0</pre>
  9037. <p>
  9038. is equivalent to
  9039. </p>
  9040. <pre class="programlisting">0.0.0.192.IN-ADDR.ARPA. NS SERVER1.EXAMPLE.
  9041. 0.0.0.192.IN-ADDR.ARPA. NS SERVER2.EXAMPLE.
  9042. 1.0.0.192.IN-ADDR.ARPA. CNAME 1.0.0.0.192.IN-ADDR.ARPA.
  9043. 2.0.0.192.IN-ADDR.ARPA. CNAME 2.0.0.0.192.IN-ADDR.ARPA.
  9044. ...
  9045. 127.0.0.192.IN-ADDR.ARPA. CNAME 127.0.0.0.192.IN-ADDR.ARPA.
  9046. </pre>
  9047. <p>
  9048. Generate a set of A and MX records. Note the MX's right hand
  9049. side is a quoted string. The quotes will be stripped when the
  9050. right hand side is processed.
  9051. </p>
  9052. <pre class="programlisting">
  9053. $ORIGIN EXAMPLE.
  9054. $GENERATE 1-127 HOST-$ A 1.2.3.$
  9055. $GENERATE 1-127 HOST-$ MX "0 ."</pre>
  9056. <p>
  9057. is equivalent to
  9058. </p>
  9059. <pre class="programlisting">HOST-1.EXAMPLE. A 1.2.3.1
  9060. HOST-1.EXAMPLE. MX 0 .
  9061. HOST-2.EXAMPLE. A 1.2.3.2
  9062. HOST-2.EXAMPLE. MX 0 .
  9063. HOST-3.EXAMPLE. A 1.2.3.3
  9064. HOST-3.EXAMPLE. MX 0 .
  9065. ...
  9066. HOST-127.EXAMPLE. A 1.2.3.127
  9067. HOST-127.EXAMPLE. MX 0 .
  9068. </pre>
  9069. <div class="informaltable"><table border="1">
  9070. <colgroup>
  9071. <col>
  9072. <col>
  9073. </colgroup>
  9074. <tbody>
  9075. <tr>
  9076. <td>
  9077. <p><span><strong class="command">range</strong></span></p>
  9078. </td>
  9079. <td>
  9080. <p>
  9081. This can be one of two forms: start-stop
  9082. or start-stop/step. If the first form is used, then step
  9083. is set to
  9084. 1. All of start, stop and step must be positive.
  9085. </p>
  9086. </td>
  9087. </tr>
  9088. <tr>
  9089. <td>
  9090. <p><span><strong class="command">lhs</strong></span></p>
  9091. </td>
  9092. <td>
  9093. <p>This
  9094. describes the owner name of the resource records
  9095. to be created. Any single <span><strong class="command">$</strong></span>
  9096. (dollar sign)
  9097. symbols within the <span><strong class="command">lhs</strong></span> string
  9098. are replaced by the iterator value.
  9099. To get a $ in the output, you need to escape the
  9100. <span><strong class="command">$</strong></span> using a backslash
  9101. <span><strong class="command">\</strong></span>,
  9102. e.g. <span><strong class="command">\$</strong></span>. The
  9103. <span><strong class="command">$</strong></span> may optionally be followed
  9104. by modifiers which change the offset from the
  9105. iterator, field width and base.
  9106. Modifiers are introduced by a
  9107. <span><strong class="command">{</strong></span> (left brace) immediately following the
  9108. <span><strong class="command">$</strong></span> as
  9109. <span><strong class="command">${offset[,width[,base]]}</strong></span>.
  9110. For example, <span><strong class="command">${-20,3,d}</strong></span>
  9111. subtracts 20 from the current value, prints the
  9112. result as a decimal in a zero-padded field of
  9113. width 3.
  9114. Available output forms are decimal
  9115. (<span><strong class="command">d</strong></span>), octal
  9116. (<span><strong class="command">o</strong></span>), hexadecimal
  9117. (<span><strong class="command">x</strong></span> or <span><strong class="command">X</strong></span>
  9118. for uppercase) and nibble
  9119. (<span><strong class="command">n</strong></span> or <span><strong class="command">N</strong></span>\
  9120. for uppercase). The default modifier is
  9121. <span><strong class="command">${0,0,d}</strong></span>. If the
  9122. <span><strong class="command">lhs</strong></span> is not absolute, the
  9123. current <span><strong class="command">$ORIGIN</strong></span> is appended
  9124. to the name.
  9125. </p>
  9126. <p>
  9127. In nibble mode the value will be treated as
  9128. if it was a reversed hexadecimal string
  9129. with each hexadecimal digit as a separate
  9130. label. The width field includes the label
  9131. separator.
  9132. </p>
  9133. <p>
  9134. For compatibility with earlier versions,
  9135. <span><strong class="command">$$</strong></span> is still recognized as
  9136. indicating a literal $ in the output.
  9137. </p>
  9138. </td>
  9139. </tr>
  9140. <tr>
  9141. <td>
  9142. <p><span><strong class="command">ttl</strong></span></p>
  9143. </td>
  9144. <td>
  9145. <p>
  9146. Specifies the time-to-live of the generated records. If
  9147. not specified this will be inherited using the
  9148. normal TTL inheritance rules.
  9149. </p>
  9150. <p><span><strong class="command">class</strong></span>
  9151. and <span><strong class="command">ttl</strong></span> can be
  9152. entered in either order.
  9153. </p>
  9154. </td>
  9155. </tr>
  9156. <tr>
  9157. <td>
  9158. <p><span><strong class="command">class</strong></span></p>
  9159. </td>
  9160. <td>
  9161. <p>
  9162. Specifies the class of the generated records.
  9163. This must match the zone class if it is
  9164. specified.
  9165. </p>
  9166. <p><span><strong class="command">class</strong></span>
  9167. and <span><strong class="command">ttl</strong></span> can be
  9168. entered in either order.
  9169. </p>
  9170. </td>
  9171. </tr>
  9172. <tr>
  9173. <td>
  9174. <p><span><strong class="command">type</strong></span></p>
  9175. </td>
  9176. <td>
  9177. <p>
  9178. Any valid type.
  9179. </p>
  9180. </td>
  9181. </tr>
  9182. <tr>
  9183. <td>
  9184. <p><span><strong class="command">rhs</strong></span></p>
  9185. </td>
  9186. <td>
  9187. <p>
  9188. <span><strong class="command">rhs</strong></span>, optionally, quoted string.
  9189. </p>
  9190. </td>
  9191. </tr>
  9192. </tbody>
  9193. </table></div>
  9194. <p>
  9195. The <span><strong class="command">$GENERATE</strong></span> directive is a <acronym class="acronym">BIND</acronym> extension
  9196. and not part of the standard zone file format.
  9197. </p>
  9198. <p>
  9199. BIND 8 does not support the optional TTL and CLASS fields.
  9200. </p>
  9201. </div>
  9202. <div class="sect2" lang="en">
  9203. <div class="titlepage"><div><div><h3 class="title">
  9204. <a name="zonefile_format"></a>Additional File Formats</h3></div></div></div>
  9205. <p>
  9206. In addition to the standard textual format, BIND 9
  9207. supports the ability to read or dump to zone files in
  9208. other formats. The <code class="constant">raw</code> format is
  9209. currently available as an additional format. It is a
  9210. binary format representing BIND 9's internal data
  9211. structure directly, thereby remarkably improving the
  9212. loading time.
  9213. </p>
  9214. <p>
  9215. For a primary server, a zone file in the
  9216. <code class="constant">raw</code> format is expected to be
  9217. generated from a textual zone file by the
  9218. <span><strong class="command">named-compilezone</strong></span> command. For a
  9219. secondary server or for a dynamic zone, it is automatically
  9220. generated (if this format is specified by the
  9221. <span><strong class="command">masterfile-format</strong></span> option) when
  9222. <span><strong class="command">named</strong></span> dumps the zone contents after
  9223. zone transfer or when applying prior updates.
  9224. </p>
  9225. <p>
  9226. If a zone file in a binary format needs manual modification,
  9227. it first must be converted to a textual form by the
  9228. <span><strong class="command">named-compilezone</strong></span> command. All
  9229. necessary modification should go to the text file, which
  9230. should then be converted to the binary form by the
  9231. <span><strong class="command">named-compilezone</strong></span> command again.
  9232. </p>
  9233. <p>
  9234. Although the <code class="constant">raw</code> format uses the
  9235. network byte order and avoids architecture-dependent
  9236. data alignment so that it is as much portable as
  9237. possible, it is primarily expected to be used inside
  9238. the same single system. In order to export a zone
  9239. file in the <code class="constant">raw</code> format or make a
  9240. portable backup of the file, it is recommended to
  9241. convert the file to the standard textual representation.
  9242. </p>
  9243. </div>
  9244. </div>
  9245. <div class="sect1" lang="en">
  9246. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  9247. <a name="statistics"></a>BIND9 Statistics</h2></div></div></div>
  9248. <p>
  9249. <acronym class="acronym">BIND</acronym> 9 maintains lots of statistics
  9250. information and provides several interfaces for users to
  9251. get access to the statistics.
  9252. The available statistics include all statistics counters
  9253. that were available in <acronym class="acronym">BIND</acronym> 8 and
  9254. are meaningful in <acronym class="acronym">BIND</acronym> 9,
  9255. and other information that is considered useful.
  9256. </p>
  9257. <p>
  9258. The statistics information is categorized into the following
  9259. sections.
  9260. </p>
  9261. <div class="informaltable"><table border="1">
  9262. <colgroup>
  9263. <col>
  9264. <col>
  9265. </colgroup>
  9266. <tbody>
  9267. <tr>
  9268. <td>
  9269. <p>Incoming Requests</p>
  9270. </td>
  9271. <td>
  9272. <p>
  9273. The number of incoming DNS requests for each OPCODE.
  9274. </p>
  9275. </td>
  9276. </tr>
  9277. <tr>
  9278. <td>
  9279. <p>Incoming Queries</p>
  9280. </td>
  9281. <td>
  9282. <p>
  9283. The number of incoming queries for each RR type.
  9284. </p>
  9285. </td>
  9286. </tr>
  9287. <tr>
  9288. <td>
  9289. <p>Outgoing Queries</p>
  9290. </td>
  9291. <td>
  9292. <p>
  9293. The number of outgoing queries for each RR
  9294. type sent from the internal resolver.
  9295. Maintained per view.
  9296. </p>
  9297. </td>
  9298. </tr>
  9299. <tr>
  9300. <td>
  9301. <p>Name Server Statistics</p>
  9302. </td>
  9303. <td>
  9304. <p>
  9305. Statistics counters about incoming request processing.
  9306. </p>
  9307. </td>
  9308. </tr>
  9309. <tr>
  9310. <td>
  9311. <p>Zone Maintenance Statistics</p>
  9312. </td>
  9313. <td>
  9314. <p>
  9315. Statistics counters regarding zone maintenance
  9316. operations such as zone transfers.
  9317. </p>
  9318. </td>
  9319. </tr>
  9320. <tr>
  9321. <td>
  9322. <p>Resolver Statistics</p>
  9323. </td>
  9324. <td>
  9325. <p>
  9326. Statistics counters about name resolution
  9327. performed in the internal resolver.
  9328. Maintained per view.
  9329. </p>
  9330. </td>
  9331. </tr>
  9332. <tr>
  9333. <td>
  9334. <p>Cache DB RRsets</p>
  9335. </td>
  9336. <td>
  9337. <p>
  9338. The number of RRsets per RR type and nonexistent
  9339. names stored in the cache database.
  9340. If the exclamation mark (!) is printed for a RR
  9341. type, it means that particular type of RRset is
  9342. known to be nonexistent (this is also known as
  9343. "NXRRSET").
  9344. Maintained per view.
  9345. </p>
  9346. </td>
  9347. </tr>
  9348. <tr>
  9349. <td>
  9350. <p>Socket I/O Statistics</p>
  9351. </td>
  9352. <td>
  9353. <p>
  9354. Statistics counters about network related events.
  9355. </p>
  9356. </td>
  9357. </tr>
  9358. </tbody>
  9359. </table></div>
  9360. <p>
  9361. A subset of Name Server Statistics is collected and shown
  9362. per zone for which the server has the authority when
  9363. <span><strong class="command">zone-statistics</strong></span> is set to
  9364. <strong class="userinput"><code>yes</code></strong>.
  9365. These statistics counters are shown with their zone and view
  9366. names.
  9367. In some cases the view names are omitted for the default view.
  9368. </p>
  9369. <p>
  9370. There are currently two user interfaces to get access to the
  9371. statistics.
  9372. One is in the plain text format dumped to the file specified
  9373. by the <span><strong class="command">statistics-file</strong></span> configuration option.
  9374. The other is remotely accessible via a statistics channel
  9375. when the <span><strong class="command">statistics-channels</strong></span> statement
  9376. is specified in the configuration file
  9377. (see <a href="Bv9ARM.ch06.html#statschannels" title="statistics-channels Statement Grammar">the section called &#8220;<span><strong class="command">statistics-channels</strong></span> Statement Grammar&#8221;</a>.)
  9378. </p>
  9379. <div class="sect3" lang="en">
  9380. <div class="titlepage"><div><div><h4 class="title">
  9381. <a name="statsfile"></a>The Statistics File</h4></div></div></div>
  9382. <p>
  9383. The text format statistics dump begins with a line, like:
  9384. </p>
  9385. <p>
  9386. <span><strong class="command">+++ Statistics Dump +++ (973798949)</strong></span>
  9387. </p>
  9388. <p>
  9389. The number in parentheses is a standard
  9390. Unix-style timestamp, measured as seconds since January 1, 1970.
  9391. Following
  9392. that line is a set of statistics information, which is categorized
  9393. as described above.
  9394. Each section begins with a line, like:
  9395. </p>
  9396. <p>
  9397. <span><strong class="command">++ Name Server Statistics ++</strong></span>
  9398. </p>
  9399. <p>
  9400. Each section consists of lines, each containing the statistics
  9401. counter value followed by its textual description.
  9402. See below for available counters.
  9403. For brevity, counters that have a value of 0 are not shown
  9404. in the statistics file.
  9405. </p>
  9406. <p>
  9407. The statistics dump ends with the line where the
  9408. number is identical to the number in the beginning line; for example:
  9409. </p>
  9410. <p>
  9411. <span><strong class="command">--- Statistics Dump --- (973798949)</strong></span>
  9412. </p>
  9413. </div>
  9414. <div class="sect2" lang="en">
  9415. <div class="titlepage"><div><div><h3 class="title">
  9416. <a name="statistics_counters"></a>Statistics Counters</h3></div></div></div>
  9417. <p>
  9418. The following tables summarize statistics counters that
  9419. <acronym class="acronym">BIND</acronym> 9 provides.
  9420. For each row of the tables, the leftmost column is the
  9421. abbreviated symbol name of that counter.
  9422. These symbols are shown in the statistics information
  9423. accessed via an HTTP statistics channel.
  9424. The rightmost column gives the description of the counter,
  9425. which is also shown in the statistics file
  9426. (but, in this document, possibly with slight modification
  9427. for better readability).
  9428. Additional notes may also be provided in this column.
  9429. When a middle column exists between these two columns,
  9430. it gives the corresponding counter name of the
  9431. <acronym class="acronym">BIND</acronym> 8 statistics, if applicable.
  9432. </p>
  9433. <div class="sect3" lang="en">
  9434. <div class="titlepage"><div><div><h4 class="title">
  9435. <a name="id2599384"></a>Name Server Statistics Counters</h4></div></div></div>
  9436. <div class="informaltable"><table border="1">
  9437. <colgroup>
  9438. <col>
  9439. <col>
  9440. <col>
  9441. </colgroup>
  9442. <tbody>
  9443. <tr>
  9444. <td>
  9445. <p>
  9446. <span class="emphasis"><em>Symbol</em></span>
  9447. </p>
  9448. </td>
  9449. <td>
  9450. <p>
  9451. <span class="emphasis"><em>BIND8 Symbol</em></span>
  9452. </p>
  9453. </td>
  9454. <td>
  9455. <p>
  9456. <span class="emphasis"><em>Description</em></span>
  9457. </p>
  9458. </td>
  9459. </tr>
  9460. <tr>
  9461. <td>
  9462. <p><span><strong class="command">Requestv4</strong></span></p>
  9463. </td>
  9464. <td>
  9465. <p><span><strong class="command">RQ</strong></span></p>
  9466. </td>
  9467. <td>
  9468. <p>
  9469. IPv4 requests received.
  9470. Note: this also counts non query requests.
  9471. </p>
  9472. </td>
  9473. </tr>
  9474. <tr>
  9475. <td>
  9476. <p><span><strong class="command">Requestv6</strong></span></p>
  9477. </td>
  9478. <td>
  9479. <p><span><strong class="command">RQ</strong></span></p>
  9480. </td>
  9481. <td>
  9482. <p>
  9483. IPv6 requests received.
  9484. Note: this also counts non query requests.
  9485. </p>
  9486. </td>
  9487. </tr>
  9488. <tr>
  9489. <td>
  9490. <p><span><strong class="command">ReqEdns0</strong></span></p>
  9491. </td>
  9492. <td>
  9493. <p><span><strong class="command"></strong></span></p>
  9494. </td>
  9495. <td>
  9496. <p>
  9497. Requests with EDNS(0) received.
  9498. </p>
  9499. </td>
  9500. </tr>
  9501. <tr>
  9502. <td>
  9503. <p><span><strong class="command">ReqBadEDNSVer</strong></span></p>
  9504. </td>
  9505. <td>
  9506. <p><span><strong class="command"></strong></span></p>
  9507. </td>
  9508. <td>
  9509. <p>
  9510. Requests with unsupported EDNS version received.
  9511. </p>
  9512. </td>
  9513. </tr>
  9514. <tr>
  9515. <td>
  9516. <p><span><strong class="command">ReqTSIG</strong></span></p>
  9517. </td>
  9518. <td>
  9519. <p><span><strong class="command"></strong></span></p>
  9520. </td>
  9521. <td>
  9522. <p>
  9523. Requests with TSIG received.
  9524. </p>
  9525. </td>
  9526. </tr>
  9527. <tr>
  9528. <td>
  9529. <p><span><strong class="command">ReqSIG0</strong></span></p>
  9530. </td>
  9531. <td>
  9532. <p><span><strong class="command"></strong></span></p>
  9533. </td>
  9534. <td>
  9535. <p>
  9536. Requests with SIG(0) received.
  9537. </p>
  9538. </td>
  9539. </tr>
  9540. <tr>
  9541. <td>
  9542. <p><span><strong class="command">ReqBadSIG</strong></span></p>
  9543. </td>
  9544. <td>
  9545. <p><span><strong class="command"></strong></span></p>
  9546. </td>
  9547. <td>
  9548. <p>
  9549. Requests with invalid (TSIG or SIG(0)) signature.
  9550. </p>
  9551. </td>
  9552. </tr>
  9553. <tr>
  9554. <td>
  9555. <p><span><strong class="command">ReqTCP</strong></span></p>
  9556. </td>
  9557. <td>
  9558. <p><span><strong class="command">RTCP</strong></span></p>
  9559. </td>
  9560. <td>
  9561. <p>
  9562. TCP requests received.
  9563. </p>
  9564. </td>
  9565. </tr>
  9566. <tr>
  9567. <td>
  9568. <p><span><strong class="command">AuthQryRej</strong></span></p>
  9569. </td>
  9570. <td>
  9571. <p><span><strong class="command">RUQ</strong></span></p>
  9572. </td>
  9573. <td>
  9574. <p>
  9575. Authoritative (non recursive) queries rejected.
  9576. </p>
  9577. </td>
  9578. </tr>
  9579. <tr>
  9580. <td>
  9581. <p><span><strong class="command">RecQryRej</strong></span></p>
  9582. </td>
  9583. <td>
  9584. <p><span><strong class="command">RURQ</strong></span></p>
  9585. </td>
  9586. <td>
  9587. <p>
  9588. Recursive queries rejected.
  9589. </p>
  9590. </td>
  9591. </tr>
  9592. <tr>
  9593. <td>
  9594. <p><span><strong class="command">XfrRej</strong></span></p>
  9595. </td>
  9596. <td>
  9597. <p><span><strong class="command">RUXFR</strong></span></p>
  9598. </td>
  9599. <td>
  9600. <p>
  9601. Zone transfer requests rejected.
  9602. </p>
  9603. </td>
  9604. </tr>
  9605. <tr>
  9606. <td>
  9607. <p><span><strong class="command">UpdateRej</strong></span></p>
  9608. </td>
  9609. <td>
  9610. <p><span><strong class="command">RUUpd</strong></span></p>
  9611. </td>
  9612. <td>
  9613. <p>
  9614. Dynamic update requests rejected.
  9615. </p>
  9616. </td>
  9617. </tr>
  9618. <tr>
  9619. <td>
  9620. <p><span><strong class="command">Response</strong></span></p>
  9621. </td>
  9622. <td>
  9623. <p><span><strong class="command">SAns</strong></span></p>
  9624. </td>
  9625. <td>
  9626. <p>
  9627. Responses sent.
  9628. </p>
  9629. </td>
  9630. </tr>
  9631. <tr>
  9632. <td>
  9633. <p><span><strong class="command">RespTruncated</strong></span></p>
  9634. </td>
  9635. <td>
  9636. <p><span><strong class="command"></strong></span></p>
  9637. </td>
  9638. <td>
  9639. <p>
  9640. Truncated responses sent.
  9641. </p>
  9642. </td>
  9643. </tr>
  9644. <tr>
  9645. <td>
  9646. <p><span><strong class="command">RespEDNS0</strong></span></p>
  9647. </td>
  9648. <td>
  9649. <p><span><strong class="command"></strong></span></p>
  9650. </td>
  9651. <td>
  9652. <p>
  9653. Responses with EDNS(0) sent.
  9654. </p>
  9655. </td>
  9656. </tr>
  9657. <tr>
  9658. <td>
  9659. <p><span><strong class="command">RespTSIG</strong></span></p>
  9660. </td>
  9661. <td>
  9662. <p><span><strong class="command"></strong></span></p>
  9663. </td>
  9664. <td>
  9665. <p>
  9666. Responses with TSIG sent.
  9667. </p>
  9668. </td>
  9669. </tr>
  9670. <tr>
  9671. <td>
  9672. <p><span><strong class="command">RespSIG0</strong></span></p>
  9673. </td>
  9674. <td>
  9675. <p><span><strong class="command"></strong></span></p>
  9676. </td>
  9677. <td>
  9678. <p>
  9679. Responses with SIG(0) sent.
  9680. </p>
  9681. </td>
  9682. </tr>
  9683. <tr>
  9684. <td>
  9685. <p><span><strong class="command">QrySuccess</strong></span></p>
  9686. </td>
  9687. <td>
  9688. <p><span><strong class="command"></strong></span></p>
  9689. </td>
  9690. <td>
  9691. <p>
  9692. Queries resulted in a successful answer.
  9693. This means the query which returns a NOERROR response
  9694. with at least one answer RR.
  9695. This corresponds to the
  9696. <span><strong class="command">success</strong></span> counter
  9697. of previous versions of
  9698. <acronym class="acronym">BIND</acronym> 9.
  9699. </p>
  9700. </td>
  9701. </tr>
  9702. <tr>
  9703. <td>
  9704. <p><span><strong class="command">QryAuthAns</strong></span></p>
  9705. </td>
  9706. <td>
  9707. <p><span><strong class="command"></strong></span></p>
  9708. </td>
  9709. <td>
  9710. <p>
  9711. Queries resulted in authoritative answer.
  9712. </p>
  9713. </td>
  9714. </tr>
  9715. <tr>
  9716. <td>
  9717. <p><span><strong class="command">QryNoauthAns</strong></span></p>
  9718. </td>
  9719. <td>
  9720. <p><span><strong class="command">SNaAns</strong></span></p>
  9721. </td>
  9722. <td>
  9723. <p>
  9724. Queries resulted in non authoritative answer.
  9725. </p>
  9726. </td>
  9727. </tr>
  9728. <tr>
  9729. <td>
  9730. <p><span><strong class="command">QryReferral</strong></span></p>
  9731. </td>
  9732. <td>
  9733. <p><span><strong class="command"></strong></span></p>
  9734. </td>
  9735. <td>
  9736. <p>
  9737. Queries resulted in referral answer.
  9738. This corresponds to the
  9739. <span><strong class="command">referral</strong></span> counter
  9740. of previous versions of
  9741. <acronym class="acronym">BIND</acronym> 9.
  9742. </p>
  9743. </td>
  9744. </tr>
  9745. <tr>
  9746. <td>
  9747. <p><span><strong class="command">QryNxrrset</strong></span></p>
  9748. </td>
  9749. <td>
  9750. <p><span><strong class="command"></strong></span></p>
  9751. </td>
  9752. <td>
  9753. <p>
  9754. Queries resulted in NOERROR responses with no data.
  9755. This corresponds to the
  9756. <span><strong class="command">nxrrset</strong></span> counter
  9757. of previous versions of
  9758. <acronym class="acronym">BIND</acronym> 9.
  9759. </p>
  9760. </td>
  9761. </tr>
  9762. <tr>
  9763. <td>
  9764. <p><span><strong class="command">QrySERVFAIL</strong></span></p>
  9765. </td>
  9766. <td>
  9767. <p><span><strong class="command">SFail</strong></span></p>
  9768. </td>
  9769. <td>
  9770. <p>
  9771. Queries resulted in SERVFAIL.
  9772. </p>
  9773. </td>
  9774. </tr>
  9775. <tr>
  9776. <td>
  9777. <p><span><strong class="command">QryFORMERR</strong></span></p>
  9778. </td>
  9779. <td>
  9780. <p><span><strong class="command">SFErr</strong></span></p>
  9781. </td>
  9782. <td>
  9783. <p>
  9784. Queries resulted in FORMERR.
  9785. </p>
  9786. </td>
  9787. </tr>
  9788. <tr>
  9789. <td>
  9790. <p><span><strong class="command">QryNXDOMAIN</strong></span></p>
  9791. </td>
  9792. <td>
  9793. <p><span><strong class="command">SNXD</strong></span></p>
  9794. </td>
  9795. <td>
  9796. <p>
  9797. Queries resulted in NXDOMAIN.
  9798. This corresponds to the
  9799. <span><strong class="command">nxdomain</strong></span> counter
  9800. of previous versions of
  9801. <acronym class="acronym">BIND</acronym> 9.
  9802. </p>
  9803. </td>
  9804. </tr>
  9805. <tr>
  9806. <td>
  9807. <p><span><strong class="command">QryRecursion</strong></span></p>
  9808. </td>
  9809. <td>
  9810. <p><span><strong class="command">RFwdQ</strong></span></p>
  9811. </td>
  9812. <td>
  9813. <p>
  9814. Queries which caused the server
  9815. to perform recursion in order to find the final answer.
  9816. This corresponds to the
  9817. <span><strong class="command">recursion</strong></span> counter
  9818. of previous versions of
  9819. <acronym class="acronym">BIND</acronym> 9.
  9820. </p>
  9821. </td>
  9822. </tr>
  9823. <tr>
  9824. <td>
  9825. <p><span><strong class="command">QryDuplicate</strong></span></p>
  9826. </td>
  9827. <td>
  9828. <p><span><strong class="command">RDupQ</strong></span></p>
  9829. </td>
  9830. <td>
  9831. <p>
  9832. Queries which the server attempted to
  9833. recurse but discovered an existing query with the same
  9834. IP address, port, query ID, name, type and class
  9835. already being processed.
  9836. This corresponds to the
  9837. <span><strong class="command">duplicate</strong></span> counter
  9838. of previous versions of
  9839. <acronym class="acronym">BIND</acronym> 9.
  9840. </p>
  9841. </td>
  9842. </tr>
  9843. <tr>
  9844. <td>
  9845. <p><span><strong class="command">QryDropped</strong></span></p>
  9846. </td>
  9847. <td>
  9848. <p><span><strong class="command"></strong></span></p>
  9849. </td>
  9850. <td>
  9851. <p>
  9852. Recursive queries for which the server
  9853. discovered an excessive number of existing
  9854. recursive queries for the same name, type and
  9855. class and were subsequently dropped.
  9856. This is the number of dropped queries due to
  9857. the reason explained with the
  9858. <span><strong class="command">clients-per-query</strong></span>
  9859. and
  9860. <span><strong class="command">max-clients-per-query</strong></span>
  9861. options
  9862. (see the description about
  9863. <a href="Bv9ARM.ch06.html#clients-per-query"><span><strong class="command">clients-per-query</strong></span></a>.)
  9864. This corresponds to the
  9865. <span><strong class="command">dropped</strong></span> counter
  9866. of previous versions of
  9867. <acronym class="acronym">BIND</acronym> 9.
  9868. </p>
  9869. </td>
  9870. </tr>
  9871. <tr>
  9872. <td>
  9873. <p><span><strong class="command">QryFailure</strong></span></p>
  9874. </td>
  9875. <td>
  9876. <p><span><strong class="command"></strong></span></p>
  9877. </td>
  9878. <td>
  9879. <p>
  9880. Other query failures.
  9881. This corresponds to the
  9882. <span><strong class="command">failure</strong></span> counter
  9883. of previous versions of
  9884. <acronym class="acronym">BIND</acronym> 9.
  9885. Note: this counter is provided mainly for
  9886. backward compatibility with the previous versions.
  9887. Normally a more fine-grained counters such as
  9888. <span><strong class="command">AuthQryRej</strong></span> and
  9889. <span><strong class="command">RecQryRej</strong></span>
  9890. that would also fall into this counter are provided,
  9891. and so this counter would not be of much
  9892. interest in practice.
  9893. </p>
  9894. </td>
  9895. </tr>
  9896. <tr>
  9897. <td>
  9898. <p><span><strong class="command">XfrReqDone</strong></span></p>
  9899. </td>
  9900. <td>
  9901. <p><span><strong class="command"></strong></span></p>
  9902. </td>
  9903. <td>
  9904. <p>
  9905. Requested zone transfers completed.
  9906. </p>
  9907. </td>
  9908. </tr>
  9909. <tr>
  9910. <td>
  9911. <p><span><strong class="command">UpdateReqFwd</strong></span></p>
  9912. </td>
  9913. <td>
  9914. <p><span><strong class="command"></strong></span></p>
  9915. </td>
  9916. <td>
  9917. <p>
  9918. Update requests forwarded.
  9919. </p>
  9920. </td>
  9921. </tr>
  9922. <tr>
  9923. <td>
  9924. <p><span><strong class="command">UpdateRespFwd</strong></span></p>
  9925. </td>
  9926. <td>
  9927. <p><span><strong class="command"></strong></span></p>
  9928. </td>
  9929. <td>
  9930. <p>
  9931. Update responses forwarded.
  9932. </p>
  9933. </td>
  9934. </tr>
  9935. <tr>
  9936. <td>
  9937. <p><span><strong class="command">UpdateFwdFail</strong></span></p>
  9938. </td>
  9939. <td>
  9940. <p><span><strong class="command"></strong></span></p>
  9941. </td>
  9942. <td>
  9943. <p>
  9944. Dynamic update forward failed.
  9945. </p>
  9946. </td>
  9947. </tr>
  9948. <tr>
  9949. <td>
  9950. <p><span><strong class="command">UpdateDone</strong></span></p>
  9951. </td>
  9952. <td>
  9953. <p><span><strong class="command"></strong></span></p>
  9954. </td>
  9955. <td>
  9956. <p>
  9957. Dynamic updates completed.
  9958. </p>
  9959. </td>
  9960. </tr>
  9961. <tr>
  9962. <td>
  9963. <p><span><strong class="command">UpdateFail</strong></span></p>
  9964. </td>
  9965. <td>
  9966. <p><span><strong class="command"></strong></span></p>
  9967. </td>
  9968. <td>
  9969. <p>
  9970. Dynamic updates failed.
  9971. </p>
  9972. </td>
  9973. </tr>
  9974. <tr>
  9975. <td>
  9976. <p><span><strong class="command">UpdateBadPrereq</strong></span></p>
  9977. </td>
  9978. <td>
  9979. <p><span><strong class="command"></strong></span></p>
  9980. </td>
  9981. <td>
  9982. <p>
  9983. Dynamic updates rejected due to prerequisite failure.
  9984. </p>
  9985. </td>
  9986. </tr>
  9987. </tbody>
  9988. </table></div>
  9989. </div>
  9990. <div class="sect3" lang="en">
  9991. <div class="titlepage"><div><div><h4 class="title">
  9992. <a name="id2600857"></a>Zone Maintenance Statistics Counters</h4></div></div></div>
  9993. <div class="informaltable"><table border="1">
  9994. <colgroup>
  9995. <col>
  9996. <col>
  9997. </colgroup>
  9998. <tbody>
  9999. <tr>
  10000. <td>
  10001. <p>
  10002. <span class="emphasis"><em>Symbol</em></span>
  10003. </p>
  10004. </td>
  10005. <td>
  10006. <p>
  10007. <span class="emphasis"><em>Description</em></span>
  10008. </p>
  10009. </td>
  10010. </tr>
  10011. <tr>
  10012. <td>
  10013. <p><span><strong class="command">NotifyOutv4</strong></span></p>
  10014. </td>
  10015. <td>
  10016. <p>
  10017. IPv4 notifies sent.
  10018. </p>
  10019. </td>
  10020. </tr>
  10021. <tr>
  10022. <td>
  10023. <p><span><strong class="command">NotifyOutv6</strong></span></p>
  10024. </td>
  10025. <td>
  10026. <p>
  10027. IPv6 notifies sent.
  10028. </p>
  10029. </td>
  10030. </tr>
  10031. <tr>
  10032. <td>
  10033. <p><span><strong class="command">NotifyInv4</strong></span></p>
  10034. </td>
  10035. <td>
  10036. <p