| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344 |
- <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>BIND 10 Guide</title><link rel="stylesheet" href="./bind10-guide.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><meta name="description" content="BIND 10 is a Domain Name System (DNS) suite managed by Internet Systems Consortium (ISC). It includes DNS libraries and modular components for controlling authoritative and recursive DNS servers. This is the reference guide for BIND 10 version 20111021. The most up-to-date version of this document (in PDF, HTML, and plain text formats), along with other documents for BIND 10, can be found at ."></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="BIND 10 Guide"><div class="titlepage"><div><div><h1 class="title"><a name="id1168229451102"></a>BIND 10 Guide</h1></div><div><h2 class="subtitle">Administrator Reference for BIND 10</h2></div><div><p class="releaseinfo">This is the reference guide for BIND 10 version
- 20111021.</p></div><div><p class="copyright">Copyright © 2010-2011 Internet Systems Consortium, Inc.</p></div><div><div class="abstract" title="Abstract"><p class="title"><b>Abstract</b></p><p>BIND 10 is a Domain Name System (DNS) suite managed by
- Internet Systems Consortium (ISC). It includes DNS libraries
- and modular components for controlling authoritative and
- recursive DNS servers.
- </p><p>
- This is the reference guide for BIND 10 version 20111021.
- The most up-to-date version of this document (in PDF, HTML,
- and plain text formats), along with other documents for
- BIND 10, can be found at <a class="ulink" href="http://bind10.isc.org/docs" target="_top">http://bind10.isc.org/docs</a>.
- </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#intro">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229451238">Supported Platforms</a></span></dt><dt><span class="section"><a href="#id1168229451265">Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">Managing BIND 10</a></span></dt></dl></dd><dt><span class="chapter"><a href="#installation">2. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229436567">Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">Quick start</a></span></dt><dt><span class="section"><a href="#install">Installation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229436859">Download Tar File</a></span></dt><dt><span class="section"><a href="#id1168229436878">Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id1168229436939">Configure before the build</a></span></dt><dt><span class="section"><a href="#id1168229437037">Build</a></span></dt><dt><span class="section"><a href="#id1168229437052">Install</a></span></dt><dt><span class="section"><a href="#id1168229437076">Install Hierarchy</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#bind10">3. Starting BIND10 with <span class="command"><strong>bind10</strong></span></a></span></dt><dd><dl><dt><span class="section"><a href="#start">Starting BIND 10</a></span></dt><dt><span class="section"><a href="#bind10.config">Configuration of started processes</a></span></dt></dl></dd><dt><span class="chapter"><a href="#msgq">4. Command channel</a></span></dt><dt><span class="chapter"><a href="#cfgmgr">5. Configuration manager</a></span></dt><dt><span class="chapter"><a href="#cmdctl">6. Remote control daemon</a></span></dt><dd><dl><dt><span class="section"><a href="#cmdctl.spec">Configuration specification for b10-cmdctl</a></span></dt></dl></dd><dt><span class="chapter"><a href="#bindctl">7. Control and configure user interface</a></span></dt><dt><span class="chapter"><a href="#authserver">8. Authoritative Server</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229438007">Server Configurations</a></span></dt><dt><span class="section"><a href="#id1168229438072">Data Source Backends</a></span></dt><dt><span class="section"><a href="#id1168229438171">Loading Master Zones Files</a></span></dt></dl></dd><dt><span class="chapter"><a href="#xfrin">9. Incoming Zone Transfers</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229438302">Configuration for Incoming Zone Transfers</a></span></dt><dt><span class="section"><a href="#id1168229438340">Enabling IXFR</a></span></dt><dt><span class="section"><a href="#id1168229438382">Trigger an Incoming Zone Transfer Manually</a></span></dt></dl></dd><dt><span class="chapter"><a href="#xfrout">10. Outbound Zone Transfers</a></span></dt><dt><span class="chapter"><a href="#zonemgr">11. Secondary Manager</a></span></dt><dt><span class="chapter"><a href="#resolverserver">12. Recursive Name Server</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229438673">Access Control</a></span></dt><dt><span class="section"><a href="#id1168229438891">Forwarding</a></span></dt></dl></dd><dt><span class="chapter"><a href="#statistics">13. Statistics</a></span></dt><dt><span class="chapter"><a href="#logging">14. Logging</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229439042">Logging configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229439052">Loggers</a></span></dt><dt><span class="section"><a href="#id1168229439294">Output Options</a></span></dt><dt><span class="section"><a href="#id1168229439468">Example session</a></span></dt></dl></dd><dt><span class="section"><a href="#id1168229440023">Logging Message Format</a></span></dt></dl></dd></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>3.1. <a href="#id1168229437338"></a></dt></dl></div><div class="chapter" title="Chapter 1. Introduction"><div class="titlepage"><div><div><h2 class="title"><a name="intro"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229451238">Supported Platforms</a></span></dt><dt><span class="section"><a href="#id1168229451265">Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">Managing BIND 10</a></span></dt></dl></div><p>
- BIND is the popular implementation of a DNS server, developer
- interfaces, and DNS tools.
- BIND 10 is a rewrite of BIND 9. BIND 10 is written in C++ and Python
- and provides a modular environment for serving and maintaining DNS.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- This guide covers the experimental prototype of
- BIND 10 version 20111021.
- </p></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- BIND 10 provides a EDNS0- and DNSSEC-capable
- authoritative DNS server and a caching recursive name server
- which also provides forwarding.
- </p></div><div class="section" title="Supported Platforms"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229451238"></a>Supported Platforms</h2></div></div></div><p>
- BIND 10 builds have been tested on Debian GNU/Linux 5,
- Ubuntu 9.10, NetBSD 5, Solaris 10, FreeBSD 7 and 8, and CentOS
- Linux 5.3.
- It has been tested on Sparc, i386, and amd64 hardware
- platforms.
- It is planned for BIND 10 to build, install and run on
- Windows and standard Unix-type platforms.
- </p></div><div class="section" title="Required Software"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229451265"></a>Required Software</h2></div></div></div><p>
- BIND 10 requires Python 3.1. Later versions may work, but Python
- 3.1 is the minimum version which will work.
- </p><p>
- BIND 10 uses the Botan crypto library for C++. It requires
- at least Botan version 1.8.
- </p><p>
- BIND 10 uses the log4cplus C++ logging library. It requires
- at least log4cplus version 1.0.3.
- </p><p>
- The authoritative server requires SQLite 3.3.9 or newer.
- The <span class="command"><strong>b10-xfrin</strong></span>, <span class="command"><strong>b10-xfrout</strong></span>,
- and <span class="command"><strong>b10-zonemgr</strong></span> modules require the
- libpython3 library and the Python _sqlite3.so module.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- Some operating systems do not provide these dependencies
- in their default installation nor standard packages
- collections.
- You may need to install them separately.
- </p></div></div><div class="section" title="Starting and Stopping the Server"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="starting_stopping"></a>Starting and Stopping the Server</h2></div></div></div><p>
- BIND 10 is modular. Part of this modularity is
- accomplished using multiple cooperating processes which, together,
- provide the server functionality. This is a change from
- the previous generation of BIND software, which used a
- single process.
- </p><p>
- At first, running many different processes may seem confusing.
- However, these processes are started, stopped, and maintained
- by a single command, <span class="command"><strong>bind10</strong></span>.
- This command starts a master process which will start other
- processes as needed.
- The processes started by the <span class="command"><strong>bind10</strong></span>
- command have names starting with "b10-", including:
- </p><p>
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
- <span class="command"><strong>b10-msgq</strong></span> —
- Message bus daemon.
- This process coordinates communication between all of the other
- BIND 10 processes.
- </li><li class="listitem">
- <span class="command"><strong>b10-auth</strong></span> —
- Authoritative DNS server.
- This process serves DNS requests.
- </li><li class="listitem">
- <span class="command"><strong>b10-cfgmgr</strong></span> —
- Configuration manager.
- This process maintains all of the configuration for BIND 10.
- </li><li class="listitem">
- <span class="command"><strong>b10-cmdctl</strong></span> —
- Command and control service.
- This process allows external control of the BIND 10 system.
- </li><li class="listitem">
- <span class="command"><strong>b10-resolver</strong></span> —
- Recursive name server.
- This process handles incoming queries.
- </li><li class="listitem">
- <span class="command"><strong>b10-stats</strong></span> —
- Statistics collection daemon.
- This process collects and reports statistics data.
- </li><li class="listitem">
- <span class="command"><strong>b10-xfrin</strong></span> —
- Incoming zone transfer service.
- This process is used to transfer a new copy
- of a zone into BIND 10, when acting as a secondary server.
- </li><li class="listitem">
- <span class="command"><strong>b10-xfrout</strong></span> —
- Outgoing zone transfer service.
- This process is used to handle transfer requests to
- send a local zone to a remote secondary server,
- when acting as a master server.
- </li><li class="listitem">
- <span class="command"><strong>b10-zonemgr</strong></span> —
- Secondary manager.
- This process keeps track of timers and other
- necessary information for BIND 10 to act as a slave server.
- </li></ul></div><p>
- </p><p>
- These are ran automatically by <span class="command"><strong>bind10</strong></span>
- and do not need to be run manually.
- </p></div><div class="section" title="Managing BIND 10"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="managing_once_running"></a>Managing BIND 10</h2></div></div></div><p>
- Once BIND 10 is running, a few commands are used to interact
- directly with the system:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
- <span class="command"><strong>bindctl</strong></span> —
- interactive administration interface.
- This is a command-line tool which allows an administrator
- to control BIND 10.
- </li><li class="listitem">
- <span class="command"><strong>b10-loadzone</strong></span> —
- zone file loader.
- This tool will load standard masterfile-format zone files into
- BIND 10.
- </li><li class="listitem">
- <span class="command"><strong>b10-cmdctl-usermgr</strong></span> —
- user access control.
- This tool allows an administrator to authorize additional users
- to manage BIND 10.
- </li></ul></div><p>
- </p></div><p>
- The tools and modules are covered in full detail in this guide.
- In addition, manual pages are also provided in the default installation.
- </p><p>
- BIND 10 also provides libraries and programmer interfaces
- for C++ and Python for the message bus, configuration backend,
- and, of course, DNS. These include detailed developer
- documentation and code examples.
- </p></div><div class="chapter" title="Chapter 2. Installation"><div class="titlepage"><div><div><h2 class="title"><a name="installation"></a>Chapter 2. Installation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229436567">Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">Quick start</a></span></dt><dt><span class="section"><a href="#install">Installation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229436859">Download Tar File</a></span></dt><dt><span class="section"><a href="#id1168229436878">Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id1168229436939">Configure before the build</a></span></dt><dt><span class="section"><a href="#id1168229437037">Build</a></span></dt><dt><span class="section"><a href="#id1168229437052">Install</a></span></dt><dt><span class="section"><a href="#id1168229437076">Install Hierarchy</a></span></dt></dl></dd></dl></div><div class="section" title="Building Requirements"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229436567"></a>Building Requirements</h2></div></div></div><p>
- In addition to the run-time requirements, building BIND 10
- from source code requires various development include headers.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- Some operating systems have split their distribution packages into
- a run-time and a development package. You will need to install
- the development package versions, which include header files and
- libraries, to build BIND 10 from source code.
- </p></div><p>
- Building from source code requires the Boost
- build-time headers. At least Boost version 1.35 is required.
-
-
- </p><p>
- To build BIND 10, also install the Botan (at least version
- 1.8) and the log4cplus (at least version 1.0.3)
- development include headers.
- </p><p>
- The Python Library and Python _sqlite3 module are required to
- enable the Xfrout and Xfrin support.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- The Python related libraries and modules need to be built
- for Python 3.1.
- </p></div><p>
- Building BIND 10 also requires a C++ compiler and
- standard development headers, make, and pkg-config.
- BIND 10 builds have been tested with GCC g++ 3.4.3, 4.1.2,
- 4.1.3, 4.2.1, 4.3.2, and 4.4.1; Clang++ 2.8; and Sun C++ 5.10.
- </p></div><div class="section" title="Quick start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="quickstart"></a>Quick start</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- This quickly covers the standard steps for installing
- and deploying BIND 10 as an authoritative name server using
- its defaults. For troubleshooting, full customizations and further
- details, see the respective chapters in the BIND 10 guide.
- </p></div><p>
- To quickly get started with BIND 10, follow these steps.
- </p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
- Install required build dependencies.
- </li><li class="listitem">
- Download the BIND 10 source tar file from
- <a class="ulink" href="ftp://ftp.isc.org/isc/bind10/" target="_top">ftp://ftp.isc.org/isc/bind10/</a>.
- </li><li class="listitem"><p>Extract the tar file:
- </p><pre class="screen">$ <strong class="userinput"><code>gzcat bind10-<em class="replaceable"><code>VERSION</code></em>.tar.gz | tar -xvf -</code></strong></pre><p>
- </p></li><li class="listitem"><p>Go into the source and run configure:
- </p><pre class="screen">$ <strong class="userinput"><code>cd bind10-<em class="replaceable"><code>VERSION</code></em></code></strong>
- $ <strong class="userinput"><code>./configure</code></strong></pre><p>
- </p></li><li class="listitem"><p>Build it:
- </p><pre class="screen">$ <strong class="userinput"><code>make</code></strong></pre><p>
- </p></li><li class="listitem"><p>Install it (to default /usr/local):
- </p><pre class="screen">$ <strong class="userinput"><code>make install</code></strong></pre><p>
- </p></li><li class="listitem"><p>Start the server:
- </p><pre class="screen">$ <strong class="userinput"><code>/usr/local/sbin/bind10</code></strong></pre><p>
- </p></li><li class="listitem"><p>Test it; for example:
- </p><pre class="screen">$ <strong class="userinput"><code>dig @127.0.0.1 -c CH -t TXT authors.bind</code></strong></pre><p>
- </p></li><li class="listitem"><p>Load desired zone file(s), for example:
- </p><pre class="screen">$ <strong class="userinput"><code>b10-loadzone <em class="replaceable"><code>your.zone.example.org</code></em></code></strong></pre><p>
- </p></li><li class="listitem">
- Test the new zone.
- </li></ol></div></div><div class="section" title="Installation from source"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="install"></a>Installation from source</h2></div></div></div><p>
- BIND 10 is open source software written in C++ and Python.
- It is freely available in source code form from ISC via
- the Git code revision control system or as a downloadable
- tar file. It may also be available in pre-compiled ready-to-use
- packages from operating system vendors.
- </p><div class="section" title="Download Tar File"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229436859"></a>Download Tar File</h3></div></div></div><p>
- Downloading a release tar file is the recommended method to
- obtain the source code.
- </p><p>
- The BIND 10 releases are available as tar file downloads from
- <a class="ulink" href="ftp://ftp.isc.org/isc/bind10/" target="_top">ftp://ftp.isc.org/isc/bind10/</a>.
- Periodic development snapshots may also be available.
- </p></div><div class="section" title="Retrieve from Git"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229436878"></a>Retrieve from Git</h3></div></div></div><p>
- Downloading this "bleeding edge" code is recommended only for
- developers or advanced users. Using development code in a production
- environment is not recommended.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- When using source code retrieved via Git additional
- software will be required: automake (v1.11 or newer),
- libtoolize, and autoconf (2.59 or newer).
- These may need to be installed.
- </p></div><p>
- The latest development code, including temporary experiments
- and un-reviewed code, is available via the BIND 10 code revision
- control system. This is powered by Git and all the BIND 10
- development is public.
- The leading development is done in the <span class="quote">“<span class="quote">master</span>”</span>.
- </p><p>
- The code can be checked out from
- <code class="filename">git://bind10.isc.org/bind10</code>;
- for example:
- </p><pre class="screen">$ <strong class="userinput"><code>git clone git://bind10.isc.org/bind10</code></strong></pre><p>
- </p><p>
- When checking out the code from
- the code version control system, it doesn't include the
- generated configure script, Makefile.in files, nor the
- related configure files.
- They can be created by running <span class="command"><strong>autoreconf</strong></span>
- with the <code class="option">--install</code> switch.
- This will run <span class="command"><strong>autoconf</strong></span>,
- <span class="command"><strong>aclocal</strong></span>,
- <span class="command"><strong>libtoolize</strong></span>,
- <span class="command"><strong>autoheader</strong></span>,
- <span class="command"><strong>automake</strong></span>,
- and related commands.
- </p></div><div class="section" title="Configure before the build"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229436939"></a>Configure before the build</h3></div></div></div><p>
- BIND 10 uses the GNU Build System to discover build environment
- details.
- To generate the makefiles using the defaults, simply run:
- </p><pre class="screen">$ <strong class="userinput"><code>./configure</code></strong></pre><p>
- </p><p>
- Run <span class="command"><strong>./configure</strong></span> with the <code class="option">--help</code>
- switch to view the different options. The commonly-used options are:
- </p><div class="variablelist"><dl><dt><span class="term">--prefix</span></dt><dd>Define the installation location (the
- default is <code class="filename">/usr/local/</code>).
- </dd><dt><span class="term">--with-boost-include</span></dt><dd>Define the path to find the Boost headers.
- </dd><dt><span class="term">--with-pythonpath</span></dt><dd>Define the path to Python 3.1 if it is not in the
- standard execution path.
- </dd><dt><span class="term">--with-gtest</span></dt><dd>Enable building the C++ Unit Tests using the
- Google Tests framework. Optionally this can define the
- path to the gtest header files and library.
- </dd></dl></div><p>
- </p><p>
- For example, the following configures it to
- find the Boost headers, find the
- Python interpreter, and sets the installation location:
- </p><pre class="screen">$ <strong class="userinput"><code>./configure \
- --with-boost-include=/usr/pkg/include \
- --with-pythonpath=/usr/pkg/bin/python3.1 \
- --prefix=/opt/bind10</code></strong></pre><p>
- </p><p>
- If the configure fails, it may be due to missing or old
- dependencies.
- </p></div><div class="section" title="Build"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229437037"></a>Build</h3></div></div></div><p>
- After the configure step is complete, to build the executables
- from the C++ code and prepare the Python scripts, run:
- </p><pre class="screen">$ <strong class="userinput"><code>make</code></strong></pre><p>
- </p></div><div class="section" title="Install"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229437052"></a>Install</h3></div></div></div><p>
- To install the BIND 10 executables, support files,
- and documentation, run:
- </p><pre class="screen">$ <strong class="userinput"><code>make install</code></strong></pre><p>
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The install step may require superuser privileges.</p></div></div><div class="section" title="Install Hierarchy"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229437076"></a>Install Hierarchy</h3></div></div></div><p>
- The following is the layout of the complete BIND 10 installation:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
- <code class="filename">bin/</code> —
- general tools and diagnostic clients.
- </li><li class="listitem">
- <code class="filename">etc/bind10-devel/</code> —
- configuration files.
- </li><li class="listitem">
- <code class="filename">lib/</code> —
- libraries and python modules.
- </li><li class="listitem">
- <code class="filename">libexec/bind10-devel/</code> —
- executables that a user wouldn't normally run directly and
- are not run independently.
- These are the BIND 10 modules which are daemons started by
- the <span class="command"><strong>bind10</strong></span> tool.
- </li><li class="listitem">
- <code class="filename">sbin/</code> —
- commands used by the system administrator.
- </li><li class="listitem">
- <code class="filename">share/bind10-devel/</code> —
- configuration specifications.
- </li><li class="listitem">
- <code class="filename">share/man/</code> —
- manual pages (online documentation).
- </li><li class="listitem">
- <code class="filename">var/bind10-devel/</code> —
- data source and configuration databases.
- </li></ul></div><p>
- </p></div></div></div><div class="chapter" title="Chapter 3. Starting BIND10 with bind10"><div class="titlepage"><div><div><h2 class="title"><a name="bind10"></a>Chapter 3. Starting BIND10 with <span class="command"><strong>bind10</strong></span></h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#start">Starting BIND 10</a></span></dt><dt><span class="section"><a href="#bind10.config">Configuration of started processes</a></span></dt></dl></div><p>
- BIND 10 provides the <span class="command"><strong>bind10</strong></span> command which
- starts up the required processes.
- <span class="command"><strong>bind10</strong></span>
- will also restart some processes that exit unexpectedly.
- This is the only command needed to start the BIND 10 system.
- </p><p>
- After starting the <span class="command"><strong>b10-msgq</strong></span> communications channel,
- <span class="command"><strong>bind10</strong></span> connects to it,
- runs the configuration manager, and reads its own configuration.
- Then it starts the other modules.
- </p><p>
- The <span class="command"><strong>b10-sockcreator</strong></span>, <span class="command"><strong>b10-msgq</strong></span> and
- <span class="command"><strong>b10-cfgmgr</strong></span>
- services make up the core. The <span class="command"><strong>b10-msgq</strong></span> daemon
- provides the communication channel between every part of the system.
- The <span class="command"><strong>b10-cfgmgr</strong></span> daemon is always needed by every
- module, if only to send information about themselves somewhere,
- but more importantly to ask about their own settings, and
- about other modules. The <span class="command"><strong>b10-sockcreator</strong></span> will
- allocate sockets for the rest of the system.
- </p><p>
- In its default configuration, the <span class="command"><strong>bind10</strong></span>
- master process will also start up
- <span class="command"><strong>b10-cmdctl</strong></span> for admins to communicate with the
- system, <span class="command"><strong>b10-auth</strong></span> for authoritative DNS service,
- <span class="command"><strong>b10-stats</strong></span> for statistics collection,
- <span class="command"><strong>b10-xfrin</strong></span> for inbound DNS zone transfers,
- <span class="command"><strong>b10-xfrout</strong></span> for outbound DNS zone transfers,
- and <span class="command"><strong>b10-zonemgr</strong></span> for secondary service.
- </p><div class="section" title="Starting BIND 10"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="start"></a>Starting BIND 10</h2></div></div></div><p>
- To start the BIND 10 service, simply run <span class="command"><strong>bind10</strong></span>.
- Run it with the <code class="option">--verbose</code> switch to
- get additional debugging or diagnostic output.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- If the setproctitle Python module is detected at start up,
- the process names for the Python-based daemons will be renamed
- to better identify them instead of just <span class="quote">“<span class="quote">python</span>”</span>.
- This is not needed on some operating systems.
- </p></div></div><div class="section" title="Configuration of started processes"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="bind10.config"></a>Configuration of started processes</h2></div></div></div><p>
- The processes to be started can be configured, with the exception
- of the <span class="command"><strong>b10-sockcreator</strong></span>, <span class="command"><strong>b10-msgq</strong></span>
- and <span class="command"><strong>b10-cfgmgr</strong></span>.
- </p><p>
- The configuration is in the Boss/components section. Each element
- represents one component, which is an abstraction of a process
- (currently there's also one component which doesn't represent
- a process). If you didn't want to transfer out at all (your server
- is a slave only), you would just remove the corresponding component
- from the set, like this and the process would be stopped immediately
- (and not started on the next startup):
- </p><pre class="screen">> <strong class="userinput"><code>config remove Boss/components b10-xfrout</code></strong>
- > <strong class="userinput"><code>config commit</code></strong></pre><p>
- </p><p>
- To add a process to the set, let's say the resolver (which not started
- by default), you would do this:
- </p><pre class="screen">> <strong class="userinput"><code>config add Boss/components b10-resolver</code></strong>
- > <strong class="userinput"><code>config set Boss/components/b10-resolver/special resolver</code></strong>
- > <strong class="userinput"><code>config set Boss/components/b10-resolver/kind needed</code></strong>
- > <strong class="userinput"><code>config set Boss/components/b10-resolver/priority 10</code></strong>
- > <strong class="userinput"><code>config commit</code></strong></pre><p>
- Now, what it means. We add an entry called b10-resolver. It is both a
- name used to reference this component in the configuration and the
- name of the process to start. Then we set some parameters on how to
- start it.
- </p><p>
- The special one is for components that need some kind of special care
- during startup or shutdown. Unless specified, the component is started
- in usual way. This is the list of components that need to be started
- in a special way, with the value of special used for them:
- </p><div class="table"><a name="id1168229437338"></a><p class="title"><b>Table 3.1. </b></p><div class="table-contents"><table border="1"><colgroup><col align="left"><col align="left"><col align="left"></colgroup><thead><tr><th align="left">Component</th><th align="left">Special</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">b10-auth</td><td align="left">auth</td><td align="left">Authoritative server</td></tr><tr><td align="left">b10-resolver</td><td align="left">resolver</td><td align="left">The resolver</td></tr><tr><td align="left">b10-cmdctl</td><td align="left">cmdctl</td><td align="left">The command control (remote control interface)</td></tr><tr><td align="left">setuid</td><td align="left">setuid</td><td align="left">Virtual component, see below</td></tr></tbody></table></div></div><p><br class="table-break">
- </p><p>
- The kind specifies how a failure of the component should
- be handled. If it is set to <span class="quote">“<span class="quote">dispensable</span>”</span>
- (the default unless you set something else), it will get
- started again if it fails. If it is set to <span class="quote">“<span class="quote">needed</span>”</span>
- and it fails at startup, the whole <span class="command"><strong>bind10</strong></span>
- shuts down and exits with error exit code. But if it fails
- some time later, it is just started again. If you set it
- to <span class="quote">“<span class="quote">core</span>”</span>, you indicate that the system is
- not usable without the component and if such component
- fails, the system shuts down no matter when the failure
- happened. This is the behaviour of the core components
- (the ones you can't turn off), but you can declare any
- other components as core as well if you wish (but you can
- turn these off, they just can't fail).
- </p><p>
- The priority defines order in which the components should start.
- The ones with higher number are started sooner than the ones with
- lower ones. If you don't set it, 0 (zero) is used as the priority.
- </p><p>
- There are other parameters we didn't use in our example.
- One of them is <span class="quote">“<span class="quote">address</span>”</span>. It is the address
- used by the component on the <span class="command"><strong>b10-msgq</strong></span>
- message bus. The special components already know their
- address, but the usual ones don't. The address is by
- convention the thing after <span class="emphasis"><em>b10-</em></span>, with
- the first letter capital (eg. <span class="command"><strong>b10-stats</strong></span>
- would have <span class="quote">“<span class="quote">Stats</span>”</span> as its address).
- </p><p>
- The last one is process. It is the name of the process to be started.
- It defaults to the name of the component if not set, but you can use
- this to override it.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- This system allows you to start the same component multiple times
- (by including it in the configuration with different names, but the
- same process setting). However, the rest of the system doesn't expect
- such situation, so it would probably not do what you want. Such
- support is yet to be implemented.
- </p></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- The configuration is quite powerful, but that includes
- a lot of space for mistakes. You could turn off the
- <span class="command"><strong>b10-cmdctl</strong></span>, but then you couldn't
- change it back the usual way, as it would require it to
- be running (you would have to find and edit the configuration
- directly). Also, some modules might have dependencies
- -- <span class="command"><strong>b10-stats-httpd</strong></span> need
- <span class="command"><strong>b10-stats</strong></span>, <span class="command"><strong>b10-xfrout</strong></span>
- needs the <span class="command"><strong>b10-auth</strong></span> to be running, etc.
- </p><p>
- In short, you should think twice before disabling something here.
- </p></div><p>
- Now, to the mysterious setuid virtual component. If you
- use the <span class="command"><strong>-u</strong></span> option to start the
- <span class="command"><strong>bind10</strong></span> as root, but change the user
- later, we need to start the <span class="command"><strong>b10-auth</strong></span> or
- <span class="command"><strong>b10-resolver</strong></span> as root (until the socket
- creator is finished). So we need to specify
- the time when the switch from root do the given user happens
- and that's what the setuid component is for. The switch is
- done at the time the setuid component would be started, if
- it was a process. The default configuration contains the
- setuid component with priority 5, <span class="command"><strong>b10-auth</strong></span>
- has 10 to be started before the switch and everything else
- is without priority, so it is started after the switch.
- </p></div></div><div class="chapter" title="Chapter 4. Command channel"><div class="titlepage"><div><div><h2 class="title"><a name="msgq"></a>Chapter 4. Command channel</h2></div></div></div><p>
- The BIND 10 components use the <span class="command"><strong>b10-msgq</strong></span>
- message routing daemon to communicate with other BIND 10 components.
- The <span class="command"><strong>b10-msgq</strong></span> implements what is called the
- <span class="quote">“<span class="quote">Command Channel</span>”</span>.
- Processes intercommunicate by sending messages on the command
- channel.
- Example messages include shutdown, get configurations, and set
- configurations.
- This Command Channel is not used for DNS message passing.
- It is used only to control and monitor the BIND 10 system.
- </p><p>
- Administrators do not communicate directly with the
- <span class="command"><strong>b10-msgq</strong></span> daemon.
- By default, BIND 10 uses port 9912 for the
- <span class="command"><strong>b10-msgq</strong></span> service.
- It listens on 127.0.0.1.
- </p></div><div class="chapter" title="Chapter 5. Configuration manager"><div class="titlepage"><div><div><h2 class="title"><a name="cfgmgr"></a>Chapter 5. Configuration manager</h2></div></div></div><p>
- The configuration manager, <span class="command"><strong>b10-cfgmgr</strong></span>,
- handles all BIND 10 system configuration. It provides
- persistent storage for configuration, and notifies running
- modules of configuration changes.
- </p><p>
- The <span class="command"><strong>b10-auth</strong></span> and <span class="command"><strong>b10-xfrin</strong></span>
- daemons and other components receive their configurations
- from the configuration manager over the <span class="command"><strong>b10-msgq</strong></span>
- command channel.
- </p><p>The administrator doesn't connect to it directly, but
- uses a user interface to communicate with the configuration
- manager via <span class="command"><strong>b10-cmdctl</strong></span>'s REST-ful interface.
- <span class="command"><strong>b10-cmdctl</strong></span> is covered in <a class="xref" href="#cmdctl" title="Chapter 6. Remote control daemon">Chapter 6, <i>Remote control daemon</i></a>.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- The development prototype release only provides the
- <span class="command"><strong>bindctl</strong></span> as a user interface to
- <span class="command"><strong>b10-cmdctl</strong></span>.
- Upcoming releases will provide another interactive command-line
- interface and a web-based interface.
- </p></div><p>
- The <span class="command"><strong>b10-cfgmgr</strong></span> daemon can send all
- specifications and all current settings to the
- <span class="command"><strong>bindctl</strong></span> client (via
- <span class="command"><strong>b10-cmdctl</strong></span>).
- </p><p>
- <span class="command"><strong>b10-cfgmgr</strong></span> relays configurations received
- from <span class="command"><strong>b10-cmdctl</strong></span> to the appropriate modules.
- </p><p>
- The stored configuration file is at
- <code class="filename">/usr/local/var/bind10-devel/b10-config.db</code>.
- (The full path is what was defined at build configure time for
- <code class="option">--localstatedir</code>.
- The default is <code class="filename">/usr/local/var/</code>.)
- The format is loosely based on JSON and is directly parseable
- python, but this may change in a future version.
- This configuration data file is not manually edited by the
- administrator.
- </p><p>
- The configuration manager does not have any command line arguments.
- Normally it is not started manually, but is automatically
- started using the <span class="command"><strong>bind10</strong></span> master process
- (as covered in <a class="xref" href="#bind10" title="Chapter 3. Starting BIND10 with bind10">Chapter 3, <i>Starting BIND10 with <span class="command"><strong>bind10</strong></span></i></a>).
- </p></div><div class="chapter" title="Chapter 6. Remote control daemon"><div class="titlepage"><div><div><h2 class="title"><a name="cmdctl"></a>Chapter 6. Remote control daemon</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#cmdctl.spec">Configuration specification for b10-cmdctl</a></span></dt></dl></div><p>
- <span class="command"><strong>b10-cmdctl</strong></span> is the gateway between
- administrators and the BIND 10 system.
- It is a HTTPS server that uses standard HTTP Digest
- Authentication for username and password validation.
- It provides a REST-ful interface for accessing and controlling
- BIND 10.
- </p><p>
- When <span class="command"><strong>b10-cmdctl</strong></span> starts, it firsts
- asks <span class="command"><strong>b10-cfgmgr</strong></span> about what modules are
- running and what their configuration is (over the
- <span class="command"><strong>b10-msgq</strong></span> channel). Then it will start listening
- on HTTPS for clients — the user interface — such
- as <span class="command"><strong>bindctl</strong></span>.
- </p><p>
- <span class="command"><strong>b10-cmdctl</strong></span> directly sends commands
- (received from the user interface) to the specified component.
- Configuration changes are actually commands to
- <span class="command"><strong>b10-cfgmgr</strong></span> so are sent there.
- </p><p>The HTTPS server requires a private key,
- such as a RSA PRIVATE KEY.
- The default location is at
- <code class="filename">/usr/local/etc/bind10-devel/cmdctl-keyfile.pem</code>.
- (A sample key is at
- <code class="filename">/usr/local/share/bind10-devel/cmdctl-keyfile.pem</code>.)
- It also uses a certificate located at
- <code class="filename">/usr/local/etc/bind10-devel/cmdctl-certfile.pem</code>.
- (A sample certificate is at
- <code class="filename">/usr/local/share/bind10-devel/cmdctl-certfile.pem</code>.)
- This may be a self-signed certificate or purchased from a
- certification authority.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- The HTTPS server doesn't support a certificate request from a
- client (at this time).
- The <span class="command"><strong>b10-cmdctl</strong></span> daemon does not provide a
- public service. If any client wants to control BIND 10, then
- a certificate needs to be first received from the BIND 10
- administrator.
- The BIND 10 installation provides a sample PEM bundle that matches
- the sample key and certificate.
- </p></div><p>
- The <span class="command"><strong>b10-cmdctl</strong></span> daemon also requires
- the user account file located at
- <code class="filename">/usr/local/etc/bind10-devel/cmdctl-accounts.csv</code>.
- This comma-delimited file lists the accounts with a user name,
- hashed password, and salt.
- (A sample file is at
- <code class="filename">/usr/local/share/bind10-devel/cmdctl-accounts.csv</code>.
- It contains the user named <span class="quote">“<span class="quote">root</span>”</span> with the password
- <span class="quote">“<span class="quote">bind10</span>”</span>.)
- </p><p>
- The administrator may create a user account with the
- <span class="command"><strong>b10-cmdctl-usermgr</strong></span> tool.
- </p><p>
- By default the HTTPS server listens on the localhost port 8080.
- The port can be set by using the <code class="option">--port</code> command line option.
- The address to listen on can be set using the <code class="option">--address</code> command
- line argument.
- Each HTTPS connection is stateless and timesout in 1200 seconds
- by default. This can be
- redefined by using the <code class="option">--idle-timeout</code> command line argument.
- </p><div class="section" title="Configuration specification for b10-cmdctl"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="cmdctl.spec"></a>Configuration specification for b10-cmdctl</h2></div></div></div><p>
- The configuration items for <span class="command"><strong>b10-cmdctl</strong></span> are:
- key_file
- cert_file
- accounts_file
- </p><p>
- The control commands are:
- print_settings
- shutdown
- </p></div></div><div class="chapter" title="Chapter 7. Control and configure user interface"><div class="titlepage"><div><div><h2 class="title"><a name="bindctl"></a>Chapter 7. Control and configure user interface</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- For this development prototype release, <span class="command"><strong>bindctl</strong></span>
- is the only user interface. It is expected that upcoming
- releases will provide another interactive command-line
- interface and a web-based interface for controlling and
- configuring BIND 10.
- </p></div><p>
- The <span class="command"><strong>bindctl</strong></span> tool provides an interactive
- prompt for configuring, controlling, and querying the BIND 10
- components.
- It communicates directly with a REST-ful interface over HTTPS
- provided by <span class="command"><strong>b10-cmdctl</strong></span>. It doesn't
- communicate to any other components directly.
- </p><p>
- Configuration changes are actually commands to
- <span class="command"><strong>b10-cfgmgr</strong></span>. So when <span class="command"><strong>bindctl</strong></span>
- sends a configuration, it is sent to <span class="command"><strong>b10-cmdctl</strong></span>
- (over a HTTPS connection); then <span class="command"><strong>b10-cmdctl</strong></span>
- sends the command (over a <span class="command"><strong>b10-msgq</strong></span> command
- channel) to <span class="command"><strong>b10-cfgmgr</strong></span> which then stores
- the details and relays (over a <span class="command"><strong>b10-msgq</strong></span> command
- channel) the configuration on to the specified module.
- </p><p>
- </p></div><div class="chapter" title="Chapter 8. Authoritative Server"><div class="titlepage"><div><div><h2 class="title"><a name="authserver"></a>Chapter 8. Authoritative Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229438007">Server Configurations</a></span></dt><dt><span class="section"><a href="#id1168229438072">Data Source Backends</a></span></dt><dt><span class="section"><a href="#id1168229438171">Loading Master Zones Files</a></span></dt></dl></div><p>
- The <span class="command"><strong>b10-auth</strong></span> is the authoritative DNS server.
- It supports EDNS0 and DNSSEC. It supports IPv6.
- Normally it is started by the <span class="command"><strong>bind10</strong></span> master
- process.
- </p><div class="section" title="Server Configurations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438007"></a>Server Configurations</h2></div></div></div><p>
- <span class="command"><strong>b10-auth</strong></span> is configured via the
- <span class="command"><strong>b10-cfgmgr</strong></span> configuration manager.
- The module name is <span class="quote">“<span class="quote">Auth</span>”</span>.
- The configuration data item is:
- </p><div class="variablelist"><dl><dt><span class="term">database_file</span></dt><dd>This is an optional string to define the path to find
- the SQLite3 database file.
- Note: Later the DNS server will use various data source backends.
- This may be a temporary setting until then.
- </dd></dl></div><p>
- </p><p>
- The configuration command is:
- </p><div class="variablelist"><dl><dt><span class="term">shutdown</span></dt><dd>Stop the authoritative DNS server.
- </dd></dl></div><p>
- </p></div><div class="section" title="Data Source Backends"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438072"></a>Data Source Backends</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- For the development prototype release, <span class="command"><strong>b10-auth</strong></span>
- supports a SQLite3 data source backend and in-memory data source
- backend.
- Upcoming versions will be able to use multiple different
- data sources, such as MySQL and Berkeley DB.
- </p></div><p>
- By default, the SQLite3 backend uses the data file located at
- <code class="filename">/usr/local/var/bind10-devel/zone.sqlite3</code>.
- (The full path is what was defined at build configure time for
- <code class="option">--localstatedir</code>.
- The default is <code class="filename">/usr/local/var/</code>.)
- This data file location may be changed by defining the
- <span class="quote">“<span class="quote">database_file</span>”</span> configuration.
- </p></div><div class="section" title="Loading Master Zones Files"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438171"></a>Loading Master Zones Files</h2></div></div></div><p>
- RFC 1035 style DNS master zone files may imported
- into a BIND 10 data source by using the
- <span class="command"><strong>b10-loadzone</strong></span> utility.
- </p><p>
- <span class="command"><strong>b10-loadzone</strong></span> supports the following
- special directives (control entries):
- </p><div class="variablelist"><dl><dt><span class="term">$INCLUDE</span></dt><dd>Loads an additional zone file. This may be recursive.
- </dd><dt><span class="term">$ORIGIN</span></dt><dd>Defines the relative domain name.
- </dd><dt><span class="term">$TTL</span></dt><dd>Defines the time-to-live value used for following
- records that don't include a TTL.
- </dd></dl></div><p>
- </p><p>
- The <code class="option">-o</code> argument may be used to define the
- default origin for loaded zone file records.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- In the development prototype release, only the SQLite3 back
- end is used.
- By default, it stores the zone data in
- <code class="filename">/usr/local/var/bind10-devel/zone.sqlite3</code>
- unless the <code class="option">-d</code> switch is used to set the
- database filename.
- Multiple zones are stored in a single SQLite3 zone database.
- </p></div><p>
- If you reload a zone already existing in the database,
- all records from that prior zone disappear and a whole new set
- appears.
- </p></div></div><div class="chapter" title="Chapter 9. Incoming Zone Transfers"><div class="titlepage"><div><div><h2 class="title"><a name="xfrin"></a>Chapter 9. Incoming Zone Transfers</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229438302">Configuration for Incoming Zone Transfers</a></span></dt><dt><span class="section"><a href="#id1168229438340">Enabling IXFR</a></span></dt><dt><span class="section"><a href="#id1168229438382">Trigger an Incoming Zone Transfer Manually</a></span></dt></dl></div><p>
- Incoming zones are transferred using the <span class="command"><strong>b10-xfrin</strong></span>
- process which is started by <span class="command"><strong>bind10</strong></span>.
- When received, the zone is stored in the corresponding BIND 10
- data source, and its records can be served by
- <span class="command"><strong>b10-auth</strong></span>.
- In combination with <span class="command"><strong>b10-zonemgr</strong></span> (for
- automated SOA checks), this allows the BIND 10 server to
- provide <span class="quote">“<span class="quote">secondary</span>”</span> service.
- </p><p>
- The <span class="command"><strong>b10-xfrin</strong></span> process supports both AXFR and
- IXFR. Due to some implementation limitations of the current
- development release, however, it only tries AXFR by default,
- and care should be taken to enable IXFR.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- In the current development release of BIND 10, incoming zone
- transfers are only available for SQLite3-based data sources,
- that is, they don't work for an in-memory data source.
- </p></div><div class="section" title="Configuration for Incoming Zone Transfers"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438302"></a>Configuration for Incoming Zone Transfers</h2></div></div></div><p>
- In practice, you need to specify a list of secondary zones to
- enable incoming zone transfers for these zones (you can still
- trigger a zone transfer manually, without a prior configuration
- (see below)).
- </p><p>
- For example, to enable zone transfers for a zone named "example.com"
- (whose master address is assumed to be 2001:db8::53 here),
- run the following at the <span class="command"><strong>bindctl</strong></span> prompt:
- </p><pre class="screen">> <strong class="userinput"><code>config add Xfrin/zones</code></strong>
- > <strong class="userinput"><code>config set Xfrin/zones[0]/name "<code class="option">example.com</code>"</code></strong>
- > <strong class="userinput"><code>config set Xfrin/zones[0]/master_addr "<code class="option">2001:db8::53</code>"</code></strong>
- > <strong class="userinput"><code>config commit</code></strong></pre><p>
- (We assume there has been no zone configuration before).
- </p></div><div class="section" title="Enabling IXFR"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438340"></a>Enabling IXFR</h2></div></div></div><p>
- As noted above, <span class="command"><strong>b10-xfrin</strong></span> uses AXFR for
- zone transfers by default. To enable IXFR for zone transfers
- for a particular zone, set the <strong class="userinput"><code>use_ixfr</code></strong>
- configuration parameter to <strong class="userinput"><code>true</code></strong>.
- In the above example of configuration sequence, you'll need
- to add the following before performing <strong class="userinput"><code>commit</code></strong>:
- </p><pre class="screen">> <strong class="userinput"><code>config set Xfrin/zones[0]/use_ixfr true</code></strong></pre><p>
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- One reason why IXFR is disabled by default in the current
- release is because it does not support automatic fallback from IXFR to
- AXFR when it encounters a primary server that doesn't support
- outbound IXFR (and, not many existing implementations support
- it). Another, related reason is that it does not use AXFR even
- if it has no knowledge about the zone (like at the very first
- time the secondary server is set up). IXFR requires the
- "current version" of the zone, so obviously it doesn't work
- in this situation and AXFR is the only workable choice.
- The current release of <span class="command"><strong>b10-xfrin</strong></span> does not
- make this selection automatically.
- These features will be implemented in a near future
- version, at which point we will enable IXFR by default.
- </p></div></div><div class="section" title="Trigger an Incoming Zone Transfer Manually"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438382"></a>Trigger an Incoming Zone Transfer Manually</h2></div></div></div><p>
- To manually trigger a zone transfer to retrieve a remote zone,
- you may use the <span class="command"><strong>bindctl</strong></span> utility.
- For example, at the <span class="command"><strong>bindctl</strong></span> prompt run:
- </p><pre class="screen">> <strong class="userinput"><code>Xfrin retransfer zone_name="<code class="option">foo.example.org</code>" master=<code class="option">192.0.2.99</code></code></strong></pre><p>
- </p></div></div><div class="chapter" title="Chapter 10. Outbound Zone Transfers"><div class="titlepage"><div><div><h2 class="title"><a name="xfrout"></a>Chapter 10. Outbound Zone Transfers</h2></div></div></div><p>
- The <span class="command"><strong>b10-xfrout</strong></span> process is started by
- <span class="command"><strong>bind10</strong></span>.
- When the <span class="command"><strong>b10-auth</strong></span> authoritative DNS server
- receives an AXFR or IXFR request, <span class="command"><strong>b10-auth</strong></span>
- internally forwards the request to <span class="command"><strong>b10-xfrout</strong></span>,
- which handles the rest of request processing.
- This is used to provide primary DNS service to share zones
- to secondary name servers.
- The <span class="command"><strong>b10-xfrout</strong></span> is also used to send
- NOTIFY messages to secondary servers.
- </p><p>
- A global or per zone <code class="option">transfer_acl</code> configuration
- can be used to control accessibility of the outbound zone
- transfer service.
- By default, <span class="command"><strong>b10-xfrout</strong></span> allows any clients to
- perform zone transfers for any zones:
- </p><pre class="screen">> <strong class="userinput"><code>config show Xfrout/transfer_acl</code></strong>
- Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)</pre><p>
- You can change this to, for example, rejecting all transfer
- requests by default while allowing requests for the transfer
- of zone "example.com" from 192.0.2.1 and 2001:db8::1 as follows:
- </p><pre class="screen">> <strong class="userinput"><code>config set Xfrout/transfer_acl[0] {"action": "REJECT"}</code></strong>
- > <strong class="userinput"><code>config add Xfrout/zone_config</code></strong>
- > <strong class="userinput"><code>config set Xfrout/zone_config[0]/origin "example.com"</code></strong>
- > <strong class="userinput"><code>config set Xfrout/zone_config[0]/transfer_acl [{"action": "ACCEPT", "from": "192.0.2.1"},</code></strong>
- <strong class="userinput"><code> {"action": "ACCEPT", "from": "2001:db8::1"}]</code></strong>
- > <strong class="userinput"><code>config commit</code></strong></pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- In the above example the lines
- for <code class="option">transfer_acl</code> were divided for
- readability. In the actual input it must be in a single line.
- </p></div><p>
- If you want to require TSIG in access control, a separate TSIG
- "key ring" must be configured specifically
- for <span class="command"><strong>b10-xfrout</strong></span> as well as a system wide
- key ring, both containing a consistent set of keys.
- For example, to change the previous example to allowing requests
- from 192.0.2.1 signed by a TSIG with a key name of
- "key.example", you'll need to do this:
- </p><pre class="screen">> <strong class="userinput"><code>config set tsig_keys/keys ["key.example:<base64-key>"]</code></strong>
- > <strong class="userinput"><code>config set Xfrout/tsig_keys/keys ["key.example:<base64-key>"]</code></strong>
- > <strong class="userinput"><code>config set Xfrout/zone_config[0]/transfer_acl [{"action": "ACCEPT", "from": "192.0.2.1", "key": "key.example"}]</code></strong>
- > <strong class="userinput"><code>config commit</code></strong></pre><p>
- The first line of configuration defines a system wide key ring.
- This is necessary because the <span class="command"><strong>b10-auth</strong></span> server
- also checks TSIGs and it uses the system wide configuration.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- In a future version, <span class="command"><strong>b10-xfrout</strong></span> will also
- use the system wide TSIG configuration.
- The way to specify zone specific configuration (ACLs, etc) is
- likely to be changed, too.
- </p></div></div><div class="chapter" title="Chapter 11. Secondary Manager"><div class="titlepage"><div><div><h2 class="title"><a name="zonemgr"></a>Chapter 11. Secondary Manager</h2></div></div></div><p>
- The <span class="command"><strong>b10-zonemgr</strong></span> process is started by
- <span class="command"><strong>bind10</strong></span>.
- It keeps track of SOA refresh, retry, and expire timers
- and other details for BIND 10 to perform as a slave.
- When the <span class="command"><strong>b10-auth</strong></span> authoritative DNS server
- receives a NOTIFY message, <span class="command"><strong>b10-zonemgr</strong></span>
- may tell <span class="command"><strong>b10-xfrin</strong></span> to do a refresh
- to start an inbound zone transfer.
- The secondary manager resets its counters when a new zone is
- transferred in.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- Access control (such as allowing notifies) is not yet provided.
- The primary/secondary service is not yet complete.
- </p></div></div><div class="chapter" title="Chapter 12. Recursive Name Server"><div class="titlepage"><div><div><h2 class="title"><a name="resolverserver"></a>Chapter 12. Recursive Name Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229438673">Access Control</a></span></dt><dt><span class="section"><a href="#id1168229438891">Forwarding</a></span></dt></dl></div><p>
- The <span class="command"><strong>b10-resolver</strong></span> process is started by
- <span class="command"><strong>bind10</strong></span>.
- </p><p>
- The main <span class="command"><strong>bind10</strong></span> process can be configured
- to select to run either the authoritative or resolver or both.
- By default, it starts the authoritative service.
- You may change this using <span class="command"><strong>bindctl</strong></span>, for example:
- </p><pre class="screen">
- > <strong class="userinput"><code>config remove Boss/components b10-xfrout</code></strong>
- > <strong class="userinput"><code>config remove Boss/components b10-xfrin</code></strong>
- > <strong class="userinput"><code>config remove Boss/components b10-auth</code></strong>
- > <strong class="userinput"><code>config add Boss/components b10-resolver</code></strong>
- > <strong class="userinput"><code>config set Boss/components/b10-resolver/special resolver</code></strong>
- > <strong class="userinput"><code>config set Boss/components/b10-resolver/kind needed</code></strong>
- > <strong class="userinput"><code>config set Boss/components/b10-resolver/priority 10</code></strong>
- > <strong class="userinput"><code>config commit</code></strong>
- </pre><p>
- </p><p>
- The master <span class="command"><strong>bind10</strong></span> will stop and start
- the desired services.
- </p><p>
- By default, the resolver listens on port 53 for 127.0.0.1 and ::1.
- The following example shows how it can be configured to
- listen on an additional address (and port):
- </p><pre class="screen">
- > <strong class="userinput"><code>config add Resolver/listen_on</code></strong>
- > <strong class="userinput"><code>config set Resolver/listen_on[<em class="replaceable"><code>2</code></em>]/address "192.168.1.1"</code></strong>
- > <strong class="userinput"><code>config set Resolver/listen_on[<em class="replaceable"><code>2</code></em>]/port 53</code></strong>
- > <strong class="userinput"><code>config commit</code></strong>
- </pre><p>
- </p><p>(Replace the <span class="quote">“<span class="quote"><em class="replaceable"><code>2</code></em></span>”</span>
- as needed; run <span class="quote">“<span class="quote"><strong class="userinput"><code>config show
- Resolver/listen_on</code></strong></span>”</span> if needed.)</p><div class="section" title="Access Control"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438673"></a>Access Control</h2></div></div></div><p>
- By default, the <span class="command"><strong>b10-resolver</strong></span> daemon only accepts
- DNS queries from the localhost (127.0.0.1 and ::1).
- The <code class="option">Resolver/query_acl</code> configuration may
- be used to reject, drop, or allow specific IPs or networks.
- This configuration list is first match.
- </p><p>
- The configuration's <code class="option">action</code> item may be
- set to <span class="quote">“<span class="quote">ACCEPT</span>”</span> to allow the incoming query,
- <span class="quote">“<span class="quote">REJECT</span>”</span> to respond with a DNS REFUSED return
- code, or <span class="quote">“<span class="quote">DROP</span>”</span> to ignore the query without
- any response (such as a blackhole). For more information,
- see the respective debugging messages: <a class="ulink" href="bind10-messages.html#RESOLVER_QUERY_ACCEPTED" target="_top">RESOLVER_QUERY_ACCEPTED</a>,
- <a class="ulink" href="bind10-messages.html#RESOLVER_QUERY_REJECTED" target="_top">RESOLVER_QUERY_REJECTED</a>,
- and <a class="ulink" href="bind10-messages.html#RESOLVER_QUERY_DROPPED" target="_top">RESOLVER_QUERY_DROPPED</a>.
- </p><p>
- The required configuration's <code class="option">from</code> item is set
- to an IPv4 or IPv6 address, addresses with an network mask, or to
- the special lowercase keywords <span class="quote">“<span class="quote">any6</span>”</span> (for
- any IPv6 address) or <span class="quote">“<span class="quote">any4</span>”</span> (for any IPv4
- address).
- </p><p>
- For example to allow the <em class="replaceable"><code>192.168.1.0/24</code></em>
- network to use your recursive name server, at the
- <span class="command"><strong>bindctl</strong></span> prompt run:
- </p><pre class="screen">
- > <strong class="userinput"><code>config add Resolver/query_acl</code></strong>
- > <strong class="userinput"><code>config set Resolver/query_acl[<em class="replaceable"><code>2</code></em>]/action "ACCEPT"</code></strong>
- > <strong class="userinput"><code>config set Resolver/query_acl[<em class="replaceable"><code>2</code></em>]/from "<em class="replaceable"><code>192.168.1.0/24</code></em>"</code></strong>
- > <strong class="userinput"><code>config commit</code></strong>
- </pre><p>(Replace the <span class="quote">“<span class="quote"><em class="replaceable"><code>2</code></em></span>”</span>
- as needed; run <span class="quote">“<span class="quote"><strong class="userinput"><code>config show
- Resolver/query_acl</code></strong></span>”</span> if needed.)</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This prototype access control configuration
- syntax may be changed.</p></div></div><div class="section" title="Forwarding"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438891"></a>Forwarding</h2></div></div></div><p>
- To enable forwarding, the upstream address and port must be
- configured to forward queries to, such as:
- </p><pre class="screen">
- > <strong class="userinput"><code>config set Resolver/forward_addresses [{ "address": "<em class="replaceable"><code>192.168.1.1</code></em>", "port": 53 }]</code></strong>
- > <strong class="userinput"><code>config commit</code></strong>
- </pre><p>
- (Replace <em class="replaceable"><code>192.168.1.1</code></em> to point to your
- full resolver.)
- </p><p>
- Normal iterative name service can be re-enabled by clearing the
- forwarding address(es); for example:
- </p><pre class="screen">
- > <strong class="userinput"><code>config set Resolver/forward_addresses []</code></strong>
- > <strong class="userinput"><code>config commit</code></strong>
- </pre><p>
- </p></div></div><div class="chapter" title="Chapter 13. Statistics"><div class="titlepage"><div><div><h2 class="title"><a name="statistics"></a>Chapter 13. Statistics</h2></div></div></div><p>
- The <span class="command"><strong>b10-stats</strong></span> process is started by
- <span class="command"><strong>bind10</strong></span>.
- It periodically collects statistics data from various modules
- and aggregates it.
- </p><p>
- This stats daemon provides commands to identify if it is
- running, show specified or all statistics data, show specified
- or all statistics data schema, and set specified statistics
- data.
- For example, using <span class="command"><strong>bindctl</strong></span>:
- </p><pre class="screen">
- > <strong class="userinput"><code>Stats show</code></strong>
- {
- "Auth": {
- "queries.tcp": 1749,
- "queries.udp": 867868
- },
- "Boss": {
- "boot_time": "2011-01-20T16:59:03Z"
- },
- "Stats": {
- "boot_time": "2011-01-20T16:59:05Z",
- "last_update_time": "2011-01-20T17:04:05Z",
- "lname": "4d3869d9_a@jreed.example.net",
- "report_time": "2011-01-20T17:04:06Z",
- "timestamp": 1295543046.823504
- }
- }
- </pre><p>
- </p></div><div class="chapter" title="Chapter 14. Logging"><div class="titlepage"><div><div><h2 class="title"><a name="logging"></a>Chapter 14. Logging</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229439042">Logging configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229439052">Loggers</a></span></dt><dt><span class="section"><a href="#id1168229439294">Output Options</a></span></dt><dt><span class="section"><a href="#id1168229439468">Example session</a></span></dt></dl></dd><dt><span class="section"><a href="#id1168229440023">Logging Message Format</a></span></dt></dl></div><div class="section" title="Logging configuration"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229439042"></a>Logging configuration</h2></div></div></div><p>
- The logging system in BIND 10 is configured through the
- Logging module. All BIND 10 modules will look at the
- configuration in Logging to see what should be logged and
- to where.
- </p><div class="section" title="Loggers"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229439052"></a>Loggers</h3></div></div></div><p>
- Within BIND 10, a message is logged through a component
- called a "logger". Different parts of BIND 10 log messages
- through different loggers, and each logger can be configured
- independently of one another.
- </p><p>
- In the Logging module, you can specify the configuration
- for zero or more loggers; any that are not specified will
- take appropriate default values..
- </p><p>
- The three most important elements of a logger configuration
- are the <code class="option">name</code> (the component that is
- generating the messages), the <code class="option">severity</code>
- (what to log), and the <code class="option">output_options</code>
- (where to log).
- </p><div class="section" title="name (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439077"></a>name (string)</h4></div></div></div><p>
- Each logger in the system has a name, the name being that
- of the component using it to log messages. For instance,
- if you want to configure logging for the resolver module,
- you add an entry for a logger named <span class="quote">“<span class="quote">Resolver</span>”</span>. This
- configuration will then be used by the loggers in the
- Resolver module, and all the libraries used by it.
- </p><p>
- If you want to specify logging for one specific library
- within the module, you set the name to
- <em class="replaceable"><code>module.library</code></em>. For example, the
- logger used by the nameserver address store component
- has the full name of <span class="quote">“<span class="quote">Resolver.nsas</span>”</span>. If
- there is no entry in Logging for a particular library,
- it will use the configuration given for the module.
- </p><p>
- To illustrate this, suppose you want the cache library
- to log messages of severity DEBUG, and the rest of the
- resolver code to log messages of severity INFO. To achieve
- this you specify two loggers, one with the name
- <span class="quote">“<span class="quote">Resolver</span>”</span> and severity INFO, and one with
- the name <span class="quote">“<span class="quote">Resolver.cache</span>”</span> with severity
- DEBUG. As there are no entries for other libraries (e.g.
- the nsas), they will use the configuration for the module
- (<span class="quote">“<span class="quote">Resolver</span>”</span>), so giving the desired behavior.
- </p><p>
- One special case is that of a module name of <span class="quote">“<span class="quote">*</span>”</span>
- (asterisks), which is interpreted as <span class="emphasis"><em>any</em></span>
- module. You can set global logging options by using this,
- including setting the logging configuration for a library
- that is used by multiple modules (e.g. <span class="quote">“<span class="quote">*.config</span>”</span>
- specifies the configuration library code in whatever
- module is using it).
- </p><p>
- If there are multiple logger specifications in the
- configuration that might match a particular logger, the
- specification with the more specific logger name takes
- precedence. For example, if there are entries for for
- both <span class="quote">“<span class="quote">*</span>”</span> and <span class="quote">“<span class="quote">Resolver</span>”</span>, the
- resolver module — and all libraries it uses —
- will log messages according to the configuration in the
- second entry (<span class="quote">“<span class="quote">Resolver</span>”</span>). All other modules
- will use the configuration of the first entry
- (<span class="quote">“<span class="quote">*</span>”</span>). If there was also a configuration
- entry for <span class="quote">“<span class="quote">Resolver.cache</span>”</span>, the cache library
- within the resolver would use that in preference to the
- entry for <span class="quote">“<span class="quote">Resolver</span>”</span>.
- </p><p>
- One final note about the naming. When specifying the
- module name within a logger, use the name of the module
- as specified in <span class="command"><strong>bindctl</strong></span>, e.g.
- <span class="quote">“<span class="quote">Resolver</span>”</span> for the resolver module,
- <span class="quote">“<span class="quote">Xfrout</span>”</span> for the xfrout module, etc. When
- the message is logged, the message will include the name
- of the logger generating the message, but with the module
- name replaced by the name of the process implementing
- the module (so for example, a message generated by the
- <span class="quote">“<span class="quote">Auth.cache</span>”</span> logger will appear in the output
- with a logger name of <span class="quote">“<span class="quote">b10-auth.cache</span>”</span>).
- </p></div><div class="section" title="severity (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439176"></a>severity (string)</h4></div></div></div><p>
- This specifies the category of messages logged.
- Each message is logged with an associated severity which
- may be one of the following (in descending order of
- severity):
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> FATAL </li><li class="listitem"> ERROR </li><li class="listitem"> WARN </li><li class="listitem"> INFO </li><li class="listitem"> DEBUG </li></ul></div><p>
- When the severity of a logger is set to one of these
- values, it will only log messages of that severity, and
- the severities above it. The severity may also be set to
- NONE, in which case all messages from that logger are
- inhibited.
- </p></div><div class="section" title="output_options (list)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439227"></a>output_options (list)</h4></div></div></div><p>
- Each logger can have zero or more
- <code class="option">output_options</code>. These specify where log
- messages are sent to. These are explained in detail below.
- </p><p>
- The other options for a logger are:
- </p></div><div class="section" title="debuglevel (integer)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439243"></a>debuglevel (integer)</h4></div></div></div><p>
- When a logger's severity is set to DEBUG, this value
- specifies what debug messages should be printed. It ranges
- from 0 (least verbose) to 99 (most verbose).
- </p><p>
- If severity for the logger is not DEBUG, this value is ignored.
- </p></div><div class="section" title="additive (true or false)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439258"></a>additive (true or false)</h4></div></div></div><p>
- If this is true, the <code class="option">output_options</code> from
- the parent will be used. For example, if there are two
- loggers configured; <span class="quote">“<span class="quote">Resolver</span>”</span> and
- <span class="quote">“<span class="quote">Resolver.cache</span>”</span>, and <code class="option">additive</code>
- is true in the second, it will write the log messages
- not only to the destinations specified for
- <span class="quote">“<span class="quote">Resolver.cache</span>”</span>, but also to the destinations
- as specified in the <code class="option">output_options</code> in
- the logger named <span class="quote">“<span class="quote">Resolver</span>”</span>.
- </p></div></div><div class="section" title="Output Options"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229439294"></a>Output Options</h3></div></div></div><p>
- The main settings for an output option are the
- <code class="option">destination</code> and a value called
- <code class="option">output</code>, the meaning of which depends on
- the destination that is set.
- </p><div class="section" title="destination (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439309"></a>destination (string)</h4></div></div></div><p>
- The destination is the type of output. It can be one of:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> console </li><li class="listitem"> file </li><li class="listitem"> syslog </li></ul></div></div><div class="section" title="output (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439341"></a>output (string)</h4></div></div></div><p>
- Depending on what is set as the output destination, this
- value is interpreted as follows:
- </p><div class="variablelist"><dl><dt><span class="term"><code class="option">destination</code> is <span class="quote">“<span class="quote">console</span>”</span></span></dt><dd>
- The value of output must be one of <span class="quote">“<span class="quote">stdout</span>”</span>
- (messages printed to standard output) or
- <span class="quote">“<span class="quote">stderr</span>”</span> (messages printed to standard
- error).
- </dd><dt><span class="term"><code class="option">destination</code> is <span class="quote">“<span class="quote">file</span>”</span></span></dt><dd>
- The value of output is interpreted as a file name;
- log messages will be appended to this file.
- </dd><dt><span class="term"><code class="option">destination</code> is <span class="quote">“<span class="quote">syslog</span>”</span></span></dt><dd>
- The value of output is interpreted as the
- <span class="command"><strong>syslog</strong></span> facility (e.g.
- <span class="emphasis"><em>local0</em></span>) that should be used
- for log messages.
- </dd></dl></div><p>
- The other options for <code class="option">output_options</code> are:
- </p><div class="section" title="flush (true of false)"><div class="titlepage"><div><div><h5 class="title"><a name="id1168229439427"></a>flush (true of false)</h5></div></div></div><p>
- Flush buffers after each log message. Doing this will
- reduce performance but will ensure that if the program
- terminates abnormally, all messages up to the point of
- termination are output.
- </p></div><div class="section" title="maxsize (integer)"><div class="titlepage"><div><div><h5 class="title"><a name="id1168229439436"></a>maxsize (integer)</h5></div></div></div><p>
- Only relevant when destination is file, this is maximum
- file size of output files in bytes. When the maximum
- size is reached, the file is renamed and a new file opened.
- (For example, a ".1" is appended to the name —
- if a ".1" file exists, it is renamed ".2",
- etc.)
- </p><p>
- If this is 0, no maximum file size is used.
- </p></div><div class="section" title="maxver (integer)"><div class="titlepage"><div><div><h5 class="title"><a name="id1168229439449"></a>maxver (integer)</h5></div></div></div><p>
- Maximum number of old log files to keep around when
- rolling the output file. Only relevant when
- <code class="option">destination</code> is <span class="quote">“<span class="quote">file</span>”</span>.
- </p></div></div></div><div class="section" title="Example session"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229439468"></a>Example session</h3></div></div></div><p>
- In this example we want to set the global logging to
- write to the file <code class="filename">/var/log/my_bind10.log</code>,
- at severity WARN. We want the authoritative server to
- log at DEBUG with debuglevel 40, to a different file
- (<code class="filename">/tmp/debug_messages</code>).
- </p><p>
- Start <span class="command"><strong>bindctl</strong></span>.
- </p><p>
- </p><pre class="screen">["login success "]
- > <strong class="userinput"><code>config show Logging</code></strong>
- Logging/loggers [] list
- </pre><p>
- </p><p>
- By default, no specific loggers are configured, in which
- case the severity defaults to INFO and the output is
- written to stderr.
- </p><p>
- Let's first add a default logger:
- </p><p>
- </p><pre class="screen"><strong class="userinput"><code>> config add Logging/loggers</code></strong>
- > <strong class="userinput"><code>config show Logging</code></strong>
- Logging/loggers/ list (modified)
- </pre><p>
- </p><p>
- The loggers value line changed to indicate that it is no
- longer an empty list:
- </p><p>
- </p><pre class="screen">> <strong class="userinput"><code>config show Logging/loggers</code></strong>
- Logging/loggers[0]/name "" string (default)
- Logging/loggers[0]/severity "INFO" string (default)
- Logging/loggers[0]/debuglevel 0 integer (default)
- Logging/loggers[0]/additive false boolean (default)
- Logging/loggers[0]/output_options [] list (default)
- </pre><p>
- </p><p>
- The name is mandatory, so we must set it. We will also
- change the severity as well. Let's start with the global
- logger.
- </p><p>
- </p><pre class="screen">> <strong class="userinput"><code>config set Logging/loggers[0]/name *</code></strong>
- > <strong class="userinput"><code>config set Logging/loggers[0]/severity WARN</code></strong>
- > <strong class="userinput"><code>config show Logging/loggers</code></strong>
- Logging/loggers[0]/name "*" string (modified)
- Logging/loggers[0]/severity "WARN" string (modified)
- Logging/loggers[0]/debuglevel 0 integer (default)
- Logging/loggers[0]/additive false boolean (default)
- Logging/loggers[0]/output_options [] list (default)
- </pre><p>
- </p><p>
- Of course, we need to specify where we want the log
- messages to go, so we add an entry for an output option.
- </p><p>
- </p><pre class="screen">> <strong class="userinput"><code> config add Logging/loggers[0]/output_options</code></strong>
- > <strong class="userinput"><code> config show Logging/loggers[0]/output_options</code></strong>
- Logging/loggers[0]/output_options[0]/destination "console" string (default)
- Logging/loggers[0]/output_options[0]/output "stdout" string (default)
- Logging/loggers[0]/output_options[0]/flush false boolean (default)
- Logging/loggers[0]/output_options[0]/maxsize 0 integer (default)
- Logging/loggers[0]/output_options[0]/maxver 0 integer (default)
- </pre><p>
- </p><p>
- These aren't the values we are looking for.
- </p><p>
- </p><pre class="screen">> <strong class="userinput"><code> config set Logging/loggers[0]/output_options[0]/destination file</code></strong>
- > <strong class="userinput"><code> config set Logging/loggers[0]/output_options[0]/output /var/log/bind10.log</code></strong>
- > <strong class="userinput"><code> config set Logging/loggers[0]/output_options[0]/maxsize 30000</code></strong>
- > <strong class="userinput"><code> config set Logging/loggers[0]/output_options[0]/maxver 8</code></strong>
- </pre><p>
- </p><p>
- Which would make the entire configuration for this logger
- look like:
- </p><p>
- </p><pre class="screen">> <strong class="userinput"><code> config show all Logging/loggers</code></strong>
- Logging/loggers[0]/name "*" string (modified)
- Logging/loggers[0]/severity "WARN" string (modified)
- Logging/loggers[0]/debuglevel 0 integer (default)
- Logging/loggers[0]/additive false boolean (default)
- Logging/loggers[0]/output_options[0]/destination "file" string (modified)
- Logging/loggers[0]/output_options[0]/output "/var/log/bind10.log" string (modified)
- Logging/loggers[0]/output_options[0]/flush false boolean (default)
- Logging/loggers[0]/output_options[0]/maxsize 30000 integer (modified)
- Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
- </pre><p>
- </p><p>
- That looks OK, so let's commit it before we add the
- configuration for the authoritative server's logger.
- </p><p>
- </p><pre class="screen">> <strong class="userinput"><code> config commit</code></strong></pre><p>
- </p><p>
- Now that we have set it, and checked each value along
- the way, adding a second entry is quite similar.
- </p><p>
- </p><pre class="screen">> <strong class="userinput"><code> config add Logging/loggers</code></strong>
- > <strong class="userinput"><code> config set Logging/loggers[1]/name Auth</code></strong>
- > <strong class="userinput"><code> config set Logging/loggers[1]/severity DEBUG</code></strong>
- > <strong class="userinput"><code> config set Logging/loggers[1]/debuglevel 40</code></strong>
- > <strong class="userinput"><code> config add Logging/loggers[1]/output_options</code></strong>
- > <strong class="userinput"><code> config set Logging/loggers[1]/output_options[0]/destination file</code></strong>
- > <strong class="userinput"><code> config set Logging/loggers[1]/output_options[0]/output /tmp/auth_debug.log</code></strong>
- > <strong class="userinput"><code> config commit</code></strong>
- </pre><p>
- </p><p>
- And that's it. Once we have found whatever it was we
- needed the debug messages for, we can simply remove the
- second logger to let the authoritative server use the
- same settings as the rest.
- </p><p>
- </p><pre class="screen">> <strong class="userinput"><code> config remove Logging/loggers[1]</code></strong>
- > <strong class="userinput"><code> config commit</code></strong>
- </pre><p>
- </p><p>
- And every module will now be using the values from the
- logger named <span class="quote">“<span class="quote">*</span>”</span>.
- </p></div></div><div class="section" title="Logging Message Format"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229440023"></a>Logging Message Format</h2></div></div></div><p>
- Each message written by BIND 10 to the configured logging
- destinations comprises a number of components that identify
- the origin of the message and, if the message indicates
- a problem, information about the problem that may be
- useful in fixing it.
- </p><p>
- Consider the message below logged to a file:
- </p><pre class="screen">2011-06-15 13:48:22.034 ERROR [b10-resolver.asiolink]
- ASIODNS_OPENSOCK error 111 opening TCP socket to 127.0.0.1(53)</pre><p>
- </p><p>
- Note: the layout of messages written to the system logging
- file (syslog) may be slightly different. This message has
- been split across two lines here for display reasons; in the
- logging file, it will appear on one line.)
- </p><p>
- The log message comprises a number of components:
- </p><div class="variablelist"><dl><dt><span class="term">2011-06-15 13:48:22.034</span></dt><dd><p>
- The date and time at which the message was generated.
- </p></dd><dt><span class="term">ERROR</span></dt><dd><p>
- The severity of the message.
- </p></dd><dt><span class="term">[b10-resolver.asiolink]</span></dt><dd><p>
- The source of the message. This comprises two components:
- the BIND 10 process generating the message (in this
- case, <span class="command"><strong>b10-resolver</strong></span>) and the module
- within the program from which the message originated
- (which in the example is the asynchronous I/O link
- module, asiolink).
- </p></dd><dt><span class="term">ASIODNS_OPENSOCK</span></dt><dd><p>
- The message identification. Every message in BIND 10
- has a unique identification, which can be used as an
- index into the <a class="ulink" href="bind10-messages.html" target="_top"><em class="citetitle">BIND 10 Messages
- Manual</em></a> (<a class="ulink" href="http://bind10.isc.org/docs/bind10-messages.html" target="_top">http://bind10.isc.org/docs/bind10-messages.html</a>) from which more information can be obtained.
- </p></dd><dt><span class="term">error 111 opening TCP socket to 127.0.0.1(53)</span></dt><dd><p>
- A brief description of the cause of the problem.
- Within this text, information relating to the condition
- that caused the message to be logged will be included.
- In this example, error number 111 (an operating
- system-specific error number) was encountered when
- trying to open a TCP connection to port 53 on the
- local system (address 127.0.0.1). The next step
- would be to find out the reason for the failure by
- consulting your system's documentation to identify
- what error number 111 means.
- </p></dd></dl></div><p>
- </p></div></div></div></body></html>
|
