BIND 10 master, updated. c4c5bf470a4c13282c684efcec6ddea2cf2fde1f Merge branch 'trac1367'
BIND 10 source code commits
bind10-changes at lists.isc.org
Fri Dec 30 15:30:18 UTC 2011
The branch, master has been updated
via c4c5bf470a4c13282c684efcec6ddea2cf2fde1f (commit)
via 3758ab360efe1cdf616636b76f2e0fb41f2a62a0 (commit)
via f08d444ae2f66c1465705bd06fa1bad7beea047c (commit)
via eee7e884390d87b3416747f093a2b6431e6bae91 (commit)
via 77c469b9c3e483f495072fbec06bd4b9db055d56 (commit)
via 81f5f15727cde4a4c98971fa09bf5d82fce1b3e2 (commit)
via bc24ccba8ce6cca78548a2ff6a0db7cf26831f3a (commit)
via 315edfd3b032c8d2b5683212635b81c2bc5f7dbf (commit)
via 126ab0b66824ee084ee1e03cdcf3a2e73d4bca04 (commit)
via 5280be98d09b95b5edb25ab85753070ba4b400fc (commit)
from cef5f3257a2b45d09134e750a76e99313f4fca28 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit c4c5bf470a4c13282c684efcec6ddea2cf2fde1f
Merge: cef5f3257a2b45d09134e750a76e99313f4fca28 3758ab360efe1cdf616636b76f2e0fb41f2a62a0
Author: Tomek Mrugalski <tomasz at isc.org>
Date: Fri Dec 30 16:29:05 2011 +0100
Merge branch 'trac1367'
Conflicts:
ChangeLog
-----------------------------------------------------------------------
Summary of changes:
ChangeLog | 6 +
doc/guide/Makefile.am | 2 +
doc/guide/bind10-guide.html | 964 +++++++++++++++++++++++++--------------
doc/guide/bind10-guide.xml | 1039 +++++++++++++++++++++++++++++++------------
4 files changed, 1379 insertions(+), 632 deletions(-)
-----------------------------------------------------------------------
diff --git a/ChangeLog b/ChangeLog
index 267dfd2..c9fa5c3 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+356. [doc] tomek
+ BIND10 Guide updated. It now describes DHCPv4 and DHCPv6
+ components, including their overview, usage, supported standard
+ and limitations. libdhcp++ is also described.
+ (Trac #1367, git 3758ab360efe1cdf616636b76f2e0fb41f2a62a0)
+
355. [bug] jinmei
Python xfrin.diff module incorrectly combined RRSIGs of different
type covered, possibly merging different TTLs. As a result a
diff --git a/doc/guide/Makefile.am b/doc/guide/Makefile.am
index 239f235..ffe89c9 100644
--- a/doc/guide/Makefile.am
+++ b/doc/guide/Makefile.am
@@ -11,6 +11,8 @@ bind10-guide.html: bind10-guide.xml
xsltproc --novalid --xinclude --nonet \
--path $(top_builddir)/doc \
-o $@ \
+ --stringparam section.autolabel 1 \
+ --stringparam section.label.includes.component.label 1 \
--stringparam html.stylesheet $(srcdir)/bind10-guide.css \
http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl \
$(srcdir)/bind10-guide.xml
diff --git a/doc/guide/bind10-guide.html b/doc/guide/bind10-guide.html
index 2972cdf..f6206a5 100644
--- a/doc/guide/bind10-guide.html
+++ b/doc/guide/bind10-guide.html
@@ -1,26 +1,28 @@
-<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 c
lass="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.
+<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 framework that features Domain Name System (DNS) suite and Dynamic Host Configuration Protocol (DHCP) servers managed by Internet Systems Consortium (ISC). It includes DNS libraries, modular components for controlling authoritative and recursive DNS servers, and experimental DHCPv4 and DHCPv6 servers. This is the reference guide for BIND 10 version 20111129. 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="id2479
03"></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
+ 20111129.</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 framework that features Domain Name System
+ (DNS) suite and Dynamic Host Configuration Protocol (DHCP)
+ servers managed by Internet Systems Consortium (ISC). It
+ includes DNS libraries, modular components for controlling
+ authoritative and recursive DNS servers, and experimental DHCPv4
+ and DHCPv6 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 c
lass="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 Ma
nually</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><s
pan 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>
+ This is the reference guide for BIND 10 version 20111129.
+ 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="#id457902">1.1. Supported Platforms</a></span></dt><dt><span class="section"><a href="#id457914">1.2. Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">1.3. Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">1.4. 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="#id458364">2.1. Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">2.2. Quick start</a></span></dt><dt><span class="section"><a href="#install">2.3. Installation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id458582">2.3.1. Download Tar File</a></
span></dt><dt><span class="section"><a href="#id458605">2.3.2. Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id458679">2.3.3. Configure before the build</a></span></dt><dt><span class="section"><a href="#id458789">2.3.4. Build</a></span></dt><dt><span class="section"><a href="#id458806">2.3.5. Install</a></span></dt><dt><span class="section"><a href="#id458832">2.3.6. 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">3.1. Starting BIND 10</a></span></dt><dt><span class="section"><a href="#bind10.config">3.2. 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">6.1. 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="#id459869">8.1. Server Configurations</a></span></dt><dt><span class="section"><a href="#id459942">8.2. Data Source Backends</a></span></dt><dt><span class="section"><a href="#id459978">8.3. 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="#id460133">9.1. Configuration for Incoming Zone Transfers</a></span></dt><dt><span class="section"><a href="#id460177">9.2. Enabling IXFR</a></span></dt><dt><span class="section"><a href="#zonemgr">9.3. Secondary Man
ager</a></span></dt><dt><span class="section"><a href="#id460320">9.4. 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="#resolverserver">11. Recursive Name Server</a></span></dt><dd><dl><dt><span class="section"><a href="#id460633">11.1. Access Control</a></span></dt><dt><span class="section"><a href="#id460772">11.2. Forwarding</a></span></dt></dl></dd><dt><span class="chapter"><a href="#dhcp4">12. DHCPv4 Server</a></span></dt><dd><dl><dt><span class="section"><a href="#dhcp4-usage">12.1. DHCPv4 Server Usage</a></span></dt><dt><span class="section"><a href="#dhcp4-config">12.2. DHCPv4 Server Configuration</a></span></dt><dt><span class="section"><a href="#dhcp4-std">12.3. Supported standards</a></span></dt><dt><span class="section"><a href="#dhcp4-limit">12.4. DHCPv4 Server Limitations</a></span></dt></dl></dd><dt><span class="chapter"
><a href="#dhcp6">13. DHCPv6 Server</a></span></dt><dd><dl><dt><span class="section"><a href="#dhcp6-usage">13.1. DHCPv6 Server Usage</a></span></dt><dt><span class="section"><a href="#dhcp6-config">13.2. DHCPv6 Server Configuration</a></span></dt><dt><span class="section"><a href="#dhcp6-std">13.3. Supported DHCPv6 Standards</a></span></dt><dt><span class="section"><a href="#dhcp6-limit">13.4. DHCPv6 Server Limitations</a></span></dt></dl></dd><dt><span class="chapter"><a href="#libdhcp">14. libdhcp++ library</a></span></dt><dd><dl><dt><span class="section"><a href="#iface-detect">14.1. Interface detection</a></span></dt><dt><span class="section"><a href="#packet-handling">14.2. DHCPv4/DHCPv6 packet handling</a></span></dt></dl></dd><dt><span class="chapter"><a href="#statistics">15. Statistics</a></span></dt><dt><span class="chapter"><a href="#logging">16. Logging</a></span></dt><dd><dl><dt><span class="section"><a href="#id461660">16.1. Logging configuration</a></span></d
t><dd><dl><dt><span class="section"><a href="#id461675">16.1.1. Loggers</a></span></dt><dt><span class="section"><a href="#id461978">16.1.2. Output Options</a></span></dt><dt><span class="section"><a href="#id462172">16.1.3. Example session</a></span></dt></dl></dd><dt><span class="section"><a href="#id462428">16.2. Logging Message Format</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id462551">17. Acknowledgements</a></span></dt></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>3.1. <a href="#id459146"></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="#id457902">1.1. Supported Platforms</a></span></dt><dt><span class="section"><a href="#id457914">1.2. Required Software</a></span></dt><dt><span class="section"><a
href="#starting_stopping">1.3. Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">1.4. 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.
+ BIND 10 version 20111129.
</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>
+ </p></div><div class="section" title="1.1. Supported Platforms"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id457902"></a>1.1. 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.
@@ -30,39 +32,39 @@
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>
+ </p></div><div class="section" title="1.2. Required Software"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id457914"></a>1.2. 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.
+ 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.
+ 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.
+ 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>
+ </p></div></div><div class="section" title="1.3. Starting and Stopping the Server"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="starting_stopping"></a>1.3. 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.
+ 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:
+ 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">
@@ -99,21 +101,21 @@
</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.
+ 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
+ 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:
+ 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="1.4. Managing BIND 10"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="managing_once_running"></a>1.4. 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.
@@ -140,7 +142,7 @@
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>
+ </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="#id458364">2.1. Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">2.2. Quick start</a></span></dt><dt><span class="section"><a href="#install">2.3. Installation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id458582">2.3.1. Download Tar File</a></span></dt><dt><span class="section"><a href="#id458605">2.3.2. Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id458679">2.3.3. Configure before the build</a></span></dt><dt><span class="section"><a href="#id458789">2.3.4. Build</a></span></dt><dt><span class="section"><a href="#id458806">2.3.5. Install</a></span></dt><dt><span class="section"><a href="#id458832">2.3.6. Install Hi
erarchy</a></span></dt></dl></dd></dl></div><div class="section" title="2.1. Building Requirements"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id458364"></a>2.1. 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>
@@ -154,12 +156,12 @@
</p><p>
- To build BIND 10, also install the Botan (at least version
- 1.8) and the log4cplus (at least version 1.0.3)
+ 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
+ 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
@@ -169,7 +171,7 @@
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>
+ </p></div><div class="section" title="2.2. Quick start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="quickstart"></a>2.2. 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
@@ -198,20 +200,20 @@
</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>
+ </li></ol></div></div><div class="section" title="2.3. Installation from source"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="install"></a>2.3. 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>
+ </p><div class="section" title="2.3.1. Download Tar File"><div class="titlepage"><div><div><h3 class="title"><a name="id458582"></a>2.3.1. 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>
+ </p></div><div class="section" title="2.3.2. Retrieve from Git"><div class="titlepage"><div><div><h3 class="title"><a name="id458605"></a>2.3.2. 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.
@@ -245,7 +247,7 @@
<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>
+ </p></div><div class="section" title="2.3.3. Configure before the build"><div class="titlepage"><div><div><h3 class="title"><a name="id458679"></a>2.3.3. 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:
@@ -276,16 +278,16 @@
</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>
+ </p></div><div class="section" title="2.3.4. Build"><div class="titlepage"><div><div><h3 class="title"><a name="id458789"></a>2.3.4. 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>
+ </p></div><div class="section" title="2.3.5. Install"><div class="titlepage"><div><div><h3 class="title"><a name="id458806"></a>2.3.5. 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>
+ </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="2.3.6. Install Hierarchy"><div class="titlepage"><div><div><h3 class="title"><a name="id458832"></a>2.3.6. 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> —
@@ -315,7 +317,7 @@
<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>
+ </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">3.1. Starting BIND 10</a></span></dt><dt><span class="section"><a href="#bind10.config">3.2. 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>
@@ -345,7 +347,7 @@
<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>
+ </p><div class="section" title="3.1. Starting BIND 10"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="start"></a>3.1. 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.
@@ -354,7 +356,7 @@
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>
+ </p></div></div><div class="section" title="3.2. Configuration of started processes"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="bind10.config"></a>3.2. 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>.
@@ -385,35 +387,35 @@
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><div class="table"><a name="id459146"></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).
+ 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).
+ 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.
@@ -426,34 +428,34 @@
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.
+ 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.
+ 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.
@@ -514,7 +516,7 @@
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>
+ </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">6.1. 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
@@ -576,7 +578,7 @@
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>
+ </p><div class="section" title="6.1. Configuration specification for b10-cmdctl"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="cmdctl.spec"></a>6.1. 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
@@ -610,12 +612,12 @@ shutdown
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>
+ </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="#id459869">8.1. Server Configurations</a></span></dt><dt><span class="section"><a href="#id459942">8.2. Data Source Backends</a></span></dt><dt><span class="section"><a href="#id459978">8.3. 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>
+ </p><div class="section" title="8.1. Server Configurations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id459869"></a>8.1. 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>.
@@ -635,7 +637,7 @@ This may be a temporary setting until then.
</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>
+ </p></div><div class="section" title="8.2. Data Source Backends"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id459942"></a>8.2. 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.
@@ -649,7 +651,7 @@ This may be a temporary setting until then.
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>
+ </p></div><div class="section" title="8.3. Loading Master Zones Files"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id459978"></a>8.3. 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.
@@ -678,7 +680,7 @@ This may be a temporary setting until then.
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>
+ </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="#id460133">9.1. Configuration for Incoming Zone Transfers</a></span></dt><dt><span class="section"><a href="#id460177">9.2. Enabling IXFR</a></span></dt><dt><span class="section"><a href="#zonemgr">9.3. Secondary Manager</a></span></dt><dt><span class="section"><a href="#id460320">9.4. 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
@@ -696,15 +698,15 @@ This may be a temporary setting until then.
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></div><div class="section" title="9.1. Configuration for Incoming Zone Transfers"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id460133"></a>9.1. 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:
+ 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>
@@ -712,7 +714,7 @@ This may be a temporary setting until then.
> <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>
+ </p></div><div class="section" title="9.2. Enabling IXFR"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id460177"></a>9.2. 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>
@@ -734,12 +736,42 @@ This may be a temporary setting until then.
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></div></div><div class="section" title="9.3. Secondary Manager"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="zonemgr"></a>9.3. 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><p>
+ The following example shows using <span class="command"><strong>bindctl</strong></span>
+ to configure the server to be a secondary for the example zone:
+
+ </p><pre class="screen">> <strong class="userinput"><code>config add Zonemgr/secondary_zones</code></strong>
+> <strong class="userinput"><code>config set Zonemgr/secondary_zones[0]/name "<code class="option">example.com</code>"</code></strong>
+> <strong class="userinput"><code>config set Zonemgr/secondary_zones[0]/class "<code class="option">IN</code>"</code></strong>
+> <strong class="userinput"><code>config commit</code></strong></pre><p>
- </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><p>
+ If the zone does not exist in the data source already
+ (i.e. no SOA record for it), <span class="command"><strong>b10-zonemgr</strong></span>
+ will automatically tell <span class="command"><strong>b10-xfrin</strong></span>
+ to transfer the zone in.
+ </p></div><div class="section" title="9.4. Trigger an Incoming Zone Transfer Manually"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id460320"></a>9.4. 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>.
@@ -768,9 +800,9 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)</pre><p>
> <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.
+ 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
@@ -787,25 +819,11 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)</pre><p>
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>
+ 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. Recursive Name Server"><div class="titlepage"><div><div><h2 class="title"><a name="resolverserver"></a>Chapter 11. Recursive Name Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id460633">11.1. Access Control</a></span></dt><dt><span class="section"><a href="#id460772">11.2. 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>.
@@ -844,31 +862,31 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)</pre><p>
</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>
+ Resolver/listen_on</code></strong></span>”</span> if needed.)</p><div class="section" title="11.1. Access Control"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id460633"></a>11.1. 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.
+ 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>.
+ 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
+ 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).
+ 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:
+ 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>
@@ -877,7 +895,7 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)</pre><p>
</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>
+ syntax may be changed.</p></div></div><div class="section" title="11.2. Forwarding"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id460772"></a>11.2. Forwarding</h2></div></div></div><p>
To enable forwarding, the upstream address and port must be
configured to forward queries to, such as:
@@ -897,7 +915,260 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)</pre><p>
> <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>
+ </p></div></div><div class="chapter" title="Chapter 12. DHCPv4 Server"><div class="titlepage"><div><div><h2 class="title"><a name="dhcp4"></a>Chapter 12. DHCPv4 Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#dhcp4-usage">12.1. DHCPv4 Server Usage</a></span></dt><dt><span class="section"><a href="#dhcp4-config">12.2. DHCPv4 Server Configuration</a></span></dt><dt><span class="section"><a href="#dhcp4-std">12.3. Supported standards</a></span></dt><dt><span class="section"><a href="#dhcp4-limit">12.4. DHCPv4 Server Limitations</a></span></dt></dl></div><p>Dynamic Host Configuration Protocol for IPv4 (DHCP or
+ DHCPv4) and Dynamic Host Configuration Protocol for IPv6 (DHCPv6)
+ are protocols that allow one node (server) to provision
+ configuration parameters to many hosts and devices (clients). To
+ ease deployment in larger networks, additional nodes (relays) may
+ be deployed that facilitate communication between servers and
+ clients. Even though principles of both DHCPv4 and DHCPv6 are
+ somewhat similar, these are two radically different
+ protocols. BIND10 offers server implementations for both DHCPv4
+ and DHCPv6. This chapter is about DHCP for IPv4. For description of
+ DHCPv6 server, see <a class="xref" href="#dhcp6" title="Chapter 13. DHCPv6 Server">Chapter 13, <i>DHCPv6 Server</i></a>.</p><p>DHCPv6 server component is currently under intense
+ development. You may want to check out <a class="ulink" href="http://bind10.isc.org/wiki/Kea" target="_top">BIND10 DHCP (Kea) wiki</a>
+ and recent posts on <a class="ulink" href="https://lists.isc.org/mailman/listinfo/bind10-dev" target="_top">BIND10
+ developers mailing list</a>.</p><p>DHCPv4 and DHCPv6 components in BIND10 architecture are
+ internally code named <span class="quote">“<span class="quote">Kea</span>”</span>.</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+ As of December 2011, both DHCPv4 and DHCPv6 components are
+ skeleton servers. That means that while they are capable of
+ performing DHCP configuration, they are not fully functional
+ yet. In particular, both do not have functional lease
+ databases. This means that they will assign the same, fixed,
+ hardcoded addresses to any client that will ask. See <a class="xref" href="#dhcp4-limit" title="12.4. DHCPv4 Server Limitations">Section 12.4, “DHCPv4 Server Limitations”</a> and <a class="xref" href="#dhcp6-limit" title="13.4. DHCPv6 Server Limitations">Section 13.4, “DHCPv6 Server Limitations”</a> for
+ detailed description.
+ </p></div><div class="section" title="12.1. DHCPv4 Server Usage"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="dhcp4-usage"></a>12.1. DHCPv4 Server Usage</h2></div></div></div><p>BIND10 provides DHCPv4 server component since December
+ 2011. It is a skeleton server and can be described as an early
+ prototype that is not fully functional yet. It is mature enough
+ to conduct first tests in lab environment, but it has
+ significant limitations. See <a class="xref" href="#dhcp4-limit" title="12.4. DHCPv4 Server Limitations">Section 12.4, “DHCPv4 Server Limitations”</a> for
+ details.
+ </p><p>
+ DHCPv4 server is implemented as <span class="command"><strong>b10-dhcp4</strong></span>
+ daemon. As it is not configurable yet, it is fully autonomous,
+ i.e. it does not interact with <span class="command"><strong>b10-cfgmgr</strong></span>.
+ To start DHCPv4 server, simply input:
+
+ </p><pre class="screen">
+#<strong class="userinput"><code>cd src/bin/dhcp4</code></strong>
+#<strong class="userinput"><code>./b10-dhcp4</code></strong>
+</pre><p>
+
+ Depending on your installation, <span class="command"><strong>b10-dhcp4</strong></span>
+ binary may reside in src/bin/dhcp4 in your source code
+ directory, in /usr/local/bin/b10-dhcp4 or other directory
+ you specified during compilation.
+
+ After start, server will detect available network interfaces
+ and will attempt to open UDP sockets on all interfaces that
+ are up, running, are not loopback and have IPv4 address
+ assigned.
+
+ Server will then listen to incoming traffic. Currently
+ supported client messages are DISCOVER and REQUEST. Server
+ will respond to them with OFFER and ACK, respectively.
+
+ As DHCPv4 server opens privileged ports, it requires root
+ access. Make sure you run this daemon as root.</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+ Integration with <span class="command"><strong>bind10</strong></span> is
+ planned. Ultimately, <span class="command"><strong>b10-dhcp4</strong></span> will not
+ be started directly, but rather via
+ <span class="command"><strong>bind10</strong></span>. Please be aware of this planned
+ change.
+ </p></div></div><div class="section" title="12.2. DHCPv4 Server Configuration"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="dhcp4-config"></a>12.2. DHCPv4 Server Configuration</h2></div></div></div><p>
+ DHCPv4 server does not have lease database implemented yet
+ or any support for configuration, so every time the same set
+ of configuration options (including the same fixed address)
+ will be assigned every time.
+ </p><p>
+ At this stage of development, the only way to alter server
+ configuration is to tweak its source code. To do so, please
+ edit src/bin/dhcp4/dhcp4_srv.cc file and modify following
+ parameters and recompile:
+ </p><pre class="screen">
+const std::string HARDCODED_LEASE = "192.0.2.222"; // assigned lease
+const std::string HARDCODED_NETMASK = "255.255.255.0";
+const uint32_t HARDCODED_LEASE_TIME = 60; // in seconds
+const std::string HARDCODED_GATEWAY = "192.0.2.1";
+const std::string HARDCODED_DNS_SERVER = "192.0.2.2";
+const std::string HARDCODED_DOMAIN_NAME = "isc.example.com";
+const std::string HARDCODED_SERVER_ID = "192.0.2.1";</pre><p>
+
+ Lease database and configuration support is planned for 2012.
+ </p></div><div class="section" title="12.3. Supported standards"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="dhcp4-std"></a>12.3. Supported standards</h2></div></div></div><p>The following standards and draft standards are currently
+ supported:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">RFC2131: Supported messages are DISCOVER, OFFER,
+ REQUEST, and ACK.</li><li class="listitem">RFC2132: Supported options are: PAD (0),
+ END(255), Message Type(53), DHCP Server Identifier (54),
+ Domain Name (15), DNS Servers (6), IP Address Lease Time
+ (51), Subnet mask (1), and Routers (3).</li></ul></div></div><div class="section" title="12.4. DHCPv4 Server Limitations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="dhcp4-limit"></a>12.4. DHCPv4 Server Limitations</h2></div></div></div><p> These are the current limitations of DHCPv4 server
+ software. Most of them are reflections of the early stage of
+ development and should be treated as <span class="quote">“<span class="quote">not implemented
+ yet</span>”</span>, rather than actual limitations.</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">During initial IPv4 node configuration, server is
+ expected to send packets to a node that does not have IPv4
+ address assigned yet. Server requires certain tricks (or
+ hacks) to transmit such packets. This is not implemented
+ yet, therefore DHCPv4 server supports relayed traffic only
+ (that is normal point to point communication).</li><li class="listitem"><span class="command"><strong>b10-dhcp4</strong></span> provides a single,
+ fixed, hardcoded lease to any client that asks. There is
+ no lease manager implemented. If two clients request
+ addresses, they will both get the same fixed
+ address.</li><li class="listitem"><span class="command"><strong>b10-dhcp4</strong></span> does not support any
+ configuration mechanisms yet. The whole configuration is
+ currently hardcoded. The only way to tweak configuration
+ is to directly modify source code. See see <a class="xref" href="#dhcp4-config" title="12.2. DHCPv4 Server Configuration">Section 12.2, “DHCPv4 Server Configuration”</a> for details.</li><li class="listitem">Upon start, server will open sockets on all
+ interfaces that are not loopback, are up and running and
+ have IPv4 address. Support for multiple interfaces is not
+ coded in reception routines yet, so if you are running
+ this code on a machine that has many interfaces and
+ <span class="command"><strong>b10-dhcp4</strong></span> happens to listen on wrong
+ interface, the easiest way to work around this problem is
+ to turn down other interfaces. This limitation will be
+ fixed shortly.</li><li class="listitem">PRL (Parameter Request List, a list of options
+ requested by a client) is currently ignored and server
+ assigns DNS SERVER and DOMAIN NAME options.</li><li class="listitem"><span class="command"><strong>b10-dhcp4</strong></span> does not support
+ BOOTP. That is a design choice. This limitation is
+ permanent. If you have legacy nodes that can't use DHCP and
+ require BOOTP support, please use latest version of ISC DHCP
+ <a class="ulink" href="http://www.isc.org/software/dhcp" target="_top">http://www.isc.org/software/dhcp</a>.</li><li class="listitem">Interface detection is currently working on Linux
+ only. See <a class="xref" href="#iface-detect" title="14.1. Interface detection">Section 14.1, “Interface detection”</a> for details.</li><li class="listitem"><span class="command"><strong>b10-dhcp4</strong></span> does not verify that
+ assigned address is unused. According to RFC2131, the
+ allocating server should verify that address is no used by
+ sending ICMP echo request.</li><li class="listitem">Address renewal (RENEW), rebinding (REBIND),
+ confirmation (CONFIRM), duplication report (DECLINE) and
+ release (RELEASE) are not supported yet.</li><li class="listitem">DNS Update is not supported yet.</li><li class="listitem">-v (verbose) command line option is currently
+ permanently enabled.</li></ul></div></div></div><div class="chapter" title="Chapter 13. DHCPv6 Server"><div class="titlepage"><div><div><h2 class="title"><a name="dhcp6"></a>Chapter 13. DHCPv6 Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#dhcp6-usage">13.1. DHCPv6 Server Usage</a></span></dt><dt><span class="section"><a href="#dhcp6-config">13.2. DHCPv6 Server Configuration</a></span></dt><dt><span class="section"><a href="#dhcp6-std">13.3. Supported DHCPv6 Standards</a></span></dt><dt><span class="section"><a href="#dhcp6-limit">13.4. DHCPv6 Server Limitations</a></span></dt></dl></div><p>Dynamic Host Configuration Protocol for IPv6 (DHCPv6) is
+ specified in RFC3315. BIND10 provides DHCPv6 server implementation
+ that is described in this chapter. For DHCPv4 server
+ implementation, see <a class="xref" href="#dhcp4" title="Chapter 12. DHCPv4 Server">Chapter 12, <i>DHCPv4 Server</i></a>.
+ </p><p>DHCPv6 server component is currently under intense
+ development. You may want to check out <a class="ulink" href="http://bind10.isc.org/wiki/Kea" target="_top">BIND10 DHCP (Kea) wiki</a>
+ and recent posts on <a class="ulink" href="https://lists.isc.org/mailman/listinfo/bind10-dev" target="_top">BIND10
+ developers mailing list</a>.</p><p>DHCPv4 and DHCPv6 components in BIND10 architecture are
+ internally code named <span class="quote">“<span class="quote">Kea</span>”</span>.</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+ As of December 2011, both DHCPv4 and DHCPv6 components are
+ skeleton servers. That means that while they are capable of
+ performing DHCP configuration, they are not fully functional
+ yet. In particular, both do not have functional lease
+ databases. This means that they will assign the same, fixed,
+ hardcoded addresses to any client that will ask. See <a class="xref" href="#dhcp4-limit" title="12.4. DHCPv4 Server Limitations">Section 12.4, “DHCPv4 Server Limitations”</a> and <a class="xref" href="#dhcp6-limit" title="13.4. DHCPv6 Server Limitations">Section 13.4, “DHCPv6 Server Limitations”</a> for
+ detailed description.
+ </p></div><div class="section" title="13.1. DHCPv6 Server Usage"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="dhcp6-usage"></a>13.1. DHCPv6 Server Usage</h2></div></div></div><p>
+ BIND10 provides DHCPv6 server component since September
+ 2011. It is a skeleton server and can be described as an early
+ prototype that is not fully functional yet. It is mature
+ enough to conduct first tests in lab environment, but it has
+ significant limitations. See <a class="xref" href="#dhcp6-limit" title="13.4. DHCPv6 Server Limitations">Section 13.4, “DHCPv6 Server Limitations”</a> for
+ details.
+ </p><p>
+ DHCPv6 server is implemented as <span class="command"><strong>b10-dhcp6</strong></span>
+ daemon. As it is not configurable yet, it is fully autonomous,
+ i.e. it does not interact with <span class="command"><strong>b10-cfgmgr</strong></span>.
+ To start DHCPv6 server, simply input:
+
+ </p><pre class="screen">
+#<strong class="userinput"><code>cd src/bin/dhcp6</code></strong>
+#<strong class="userinput"><code>./b10-dhcp6</code></strong>
+</pre><p>
+
+ Depending on your installation, <span class="command"><strong>b10-dhcp6</strong></span>
+ binary may reside in src/bin/dhcp6 in your source code
+ directory, in /usr/local/bin/b10-dhcp6 or other directory
+ you specified during compilation.
+
+ After start, server will detect available network interfaces
+ and will attempt to open UDP sockets on all interfaces that
+ are up, running, are not loopback, are multicast-capable and
+ have IPv6 address assigned.
+
+ Server will then listen to incoming traffic. Currently
+ supported client messages are SOLICIT and REQUEST. Server
+ will respond to them with ADVERTISE and REPLY, respectively.
+
+ As DHCPv6 server opens privileged ports, it requires root
+ access. Make sure you run this daemon as root.
+ </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+ Integration with <span class="command"><strong>bind10</strong></span> is
+ planned. Ultimately, <span class="command"><strong>b10-dhcp6</strong></span> will not
+ be started directly, but rather via
+ <span class="command"><strong>bind10</strong></span>. Please be aware of this planned
+ change.
+ </p></div></div><div class="section" title="13.2. DHCPv6 Server Configuration"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="dhcp6-config"></a>13.2. DHCPv6 Server Configuration</h2></div></div></div><p>
+ DHCPv4 server does not have lease database implemented yet
+ or any support for configuration, so every time the same set
+ of configuration options (including the same fixed address)
+ will be assigned every time.
+ </p><p>
+ At this stage of development, the only way to alter server
+ configuration is to tweak its source code. To do so, please
+ edit src/bin/dhcp6/dhcp6_srv.cc file and modify following
+ parameters and recompile:
+ </p><pre class="screen">
+const std::string HARDCODED_LEASE = "2001:db8:1::1234:abcd";
+const uint32_t HARDCODED_T1 = 1500; // in seconds
+const uint32_t HARDCODED_T2 = 2600; // in seconds
+const uint32_t HARDCODED_PREFERRED_LIFETIME = 3600; // in seconds
+const uint32_t HARDCODED_VALID_LIFETIME = 7200; // in seconds
+const std::string HARDCODED_DNS_SERVER = "2001:db8:1::1";</pre><p>
+
+ Lease database and configuration support is planned for 2012.
+ </p></div><div class="section" title="13.3. Supported DHCPv6 Standards"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="dhcp6-std"></a>13.3. Supported DHCPv6 Standards</h2></div></div></div><p>The following standards and draft standards are currently
+ supported:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">RFC3315: Supported messages are SOLICIT,
+ ADVERTISE, REQUEST, and REPLY. Supported options are
+ SERVER_ID, CLIENT_ID, IA_NA, and IAADDRESS.</li><li class="listitem">RFC3646: Supported option is DNS_SERVERS.</li></ul></div></div><div class="section" title="13.4. DHCPv6 Server Limitations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="dhcp6-limit"></a>13.4. DHCPv6 Server Limitations</h2></div></div></div><p> These are the current limitations of DHCPv6 server
+ software. Most of them are reflections of the early stage of
+ development and should be treated as <span class="quote">“<span class="quote">not implemented
+ yet</span>”</span>, rather than actual limitations.</p><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">Relayed traffic is not supported.</li><li class="listitem"><span class="command"><strong>b10-dhcp6</strong></span> provides a single,
+ fixed, hardcoded lease to any client that asks. There is no
+ lease manager implemented. If two clients request addresses,
+ they will both get the same fixed address.</li><li class="listitem"><span class="command"><strong>b10-dhcp6</strong></span> does not support any
+ configuration mechanisms yet. The whole configuration is
+ currently hardcoded. The only way to tweak configuration
+ is to directly modify source code. See see <a class="xref" href="#dhcp6-config" title="13.2. DHCPv6 Server Configuration">Section 13.2, “DHCPv6 Server Configuration”</a> for details.</li><li class="listitem">Upon start, server will open sockets on all
+ interfaces that are not loopback, are up, running and are
+ multicast capable and have IPv6 address. Support for
+ multiple interfaces is not coded in reception routines yet,
+ so if you are running this code on a machine that has many
+ interfaces and <span class="command"><strong>b10-dhcp6</strong></span> happens to
+ listen on wrong interface, the easiest way to work around
+ this problem is to turn down other interfaces. This
+ limitation will be fixed shortly.</li><li class="listitem">ORO (Option Request Option, a list of options
+ requested by a client) is currently ignored and server
+ assigns DNS SERVER option.</li><li class="listitem">Temporary addresses are not supported yet.</li><li class="listitem">Prefix delegation is not supported yet.</li><li class="listitem">Address renewal (RENEW), rebinding (REBIND),
+ confirmation (CONFIRM), duplication report (DECLINE) and
+ release (RELEASE) are not supported yet.</li><li class="listitem">DNS Update is not supported yet.</li><li class="listitem">Interface detection is currently working on Linux
+ only. See <a class="xref" href="#iface-detect" title="14.1. Interface detection">Section 14.1, “Interface detection”</a> for details.</li><li class="listitem">-v (verbose) command line option is currently permanently
+ enabled.</li></ul></div><p>
+ </p></div></div><div class="chapter" title="Chapter 14. libdhcp++ library"><div class="titlepage"><div><div><h2 class="title"><a name="libdhcp"></a>Chapter 14. libdhcp++ library</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#iface-detect">14.1. Interface detection</a></span></dt><dt><span class="section"><a href="#packet-handling">14.2. DHCPv4/DHCPv6 packet handling</a></span></dt></dl></div><p>libdhcp++ is a common library written in C++ that handles
+ many DHCP-related tasks, like DHCPv4 and DHCPv6 packets parsing,
+ manipulation and assembly, option parsing, manipulation and
+ assembly, network interface detection and socket operations, like
+ socket creations, data transmission and reception and socket
+ closing.
+ </p><p>
+ While this library is currently used by
+ <span class="command"><strong>b10-dhcp4</strong></span> and <span class="command"><strong>b10-dhcp6</strong></span>
+ only, it is designed to be portable, universal library useful for
+ any kind of DHCP-related software.
+ </p><div class="section" title="14.1. Interface detection"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="iface-detect"></a>14.1. Interface detection</h2></div></div></div><p>Both DHCPv4 and DHCPv6 components share network
+ interface detection routines. Interface detection is
+ currently only supported on Linux systems.</p><p>For non-linux systems, there is currently stub
+ implementation provided. As DHCP servers need to know available
+ addresses, there is a simple mechanism implemented to provide
+ that information. User is expected to create interfaces.txt
+ file. Format of this file is simple. It contains list of
+ interfaces along with available address on each interface. This
+ mechanism is temporary and is going to be removed as soon as
+ interface detection becomes available on non-linux
+ systems. Example of interfaces.txt file looks as follows:
+ </p><pre class="screen">
+# For DHCPv6, please specify link-local address (starts with fe80::)
+# If in doubt, check output of 'ifconfig -a' command.
+eth0 fe80::21e:8cff:fe9b:7349
+
+# For DHCPv4, please use following format:
+#eth0 192.0.2.5</pre><p>
+ </p></div><div class="section" title="14.2. DHCPv4/DHCPv6 packet handling"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="packet-handling"></a>14.2. DHCPv4/DHCPv6 packet handling</h2></div></div></div><p>TODO: Describe packet handling here, with pointers to wiki</p></div></div><div class="chapter" title="Chapter 15. Statistics"><div class="titlepage"><div><div><h2 class="title"><a name="statistics"></a>Chapter 15. 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
@@ -931,52 +1202,52 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)</pre><p>
}
}
</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>
+ </p></div><div class="chapter" title="Chapter 16. Logging"><div class="titlepage"><div><div><h2 class="title"><a name="logging"></a>Chapter 16. Logging</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id461660">16.1. Logging configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#id461675">16.1.1. Loggers</a></span></dt><dt><span class="section"><a href="#id461978">16.1.2. Output Options</a></span></dt><dt><span class="section"><a href="#id462172">16.1.3. Example session</a></span></dt></dl></dd><dt><span class="section"><a href="#id462428">16.2. Logging Message Format</a></span></dt></dl></div><div class="section" title="16.1. Logging configuration"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id461660"></a>16.1. 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.
+ 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>
+ </p><div class="section" title="16.1.1. Loggers"><div class="titlepage"><div><div><h3 class="title"><a name="id461675"></a>16.1.1. 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.
+ 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..
+ 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.
+ 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="16.1.1.1. name (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id461706"></a>16.1.1.1. 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.
+ 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.
@@ -984,163 +1255,163 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)</pre><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.
+ 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).
+ 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>.
+ 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>).
+ 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>
+ </p></div><div class="section" title="16.1.1.2. severity (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id461840"></a>16.1.1.2. 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):
+ 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.
+ 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>
+ </p></div><div class="section" title="16.1.1.3. output_options (list)"><div class="titlepage"><div><div><h4 class="title"><a name="id461898"></a>16.1.1.3. 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.
+ 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>
+ </p></div><div class="section" title="16.1.1.4. debuglevel (integer)"><div class="titlepage"><div><div><h4 class="title"><a name="id461917"></a>16.1.1.4. 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).
+ 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>
+ </p></div><div class="section" title="16.1.1.5. additive (true or false)"><div class="titlepage"><div><div><h4 class="title"><a name="id461937"></a>16.1.1.5. 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>.
+ 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>
+ </p></div></div><div class="section" title="16.1.2. Output Options"><div class="titlepage"><div><div><h3 class="title"><a name="id461978"></a>16.1.2. 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.
+ 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>
+ </p><div class="section" title="16.1.2.1. destination (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id461995"></a>16.1.2.1. 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>
+ </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="16.1.2.2. output (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id462029"></a>16.1.2.2. output (string)</h4></div></div></div><p>
- Depending on what is set as the output destination, this
- value is interpreted as follows:
+ 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).
+ 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.
+ 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.
+ 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",
+ </p><div class="section" title="16.1.2.2.1. flush (true of false)"><div class="titlepage"><div><div><h5 class="title"><a name="id462122"></a>16.1.2.2.1. 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="16.1.2.2.2. maxsize (integer)"><div class="titlepage"><div><div><h5 class="title"><a name="id462134"></a>16.1.2.2.2. 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></div><div class="section" title="16.1.2.2.3. maxver (integer)"><div class="titlepage"><div><div><h5 class="title"><a name="id462151"></a>16.1.2.2.3. 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="16.1.3. Example session"><div class="titlepage"><div><div><h3 class="title"><a name="id462172"></a>16.1.3. 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>
@@ -1155,9 +1426,9 @@ Logging/loggers [] list
</p><p>
- By default, no specific loggers are configured, in which
- case the severity defaults to INFO and the output is
- written to stderr.
+ By default, no specific loggers are configured, in which
+ case the severity defaults to INFO and the output is
+ written to stderr.
</p><p>
@@ -1172,8 +1443,8 @@ Logging/loggers/ list (modified)
</p><p>
- The loggers value line changed to indicate that it is no
- longer an empty list:
+ The loggers value line changed to indicate that it is no
+ longer an empty list:
</p><p>
@@ -1187,9 +1458,9 @@ Logging/loggers[0]/output_options [] list (default)
</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.
+ 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>
@@ -1205,8 +1476,8 @@ Logging/loggers[0]/output_options [] list (default)
</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.
+ 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>
@@ -1234,8 +1505,8 @@ Logging/loggers[0]/output_options[0]/maxver 0 integer (default)
</p><p>
- Which would make the entire configuration for this logger
- look like:
+ Which would make the entire configuration for this logger
+ look like:
</p><p>
@@ -1253,8 +1524,8 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
</p><p>
- That looks OK, so let's commit it before we add the
- configuration for the authoritative server's logger.
+ That looks OK, so let's commit it before we add the
+ configuration for the authoritative server's logger.
</p><p>
@@ -1262,8 +1533,8 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
</p><p>
- Now that we have set it, and checked each value along
- the way, adding a second entry is quite similar.
+ Now that we have set it, and checked each value along
+ the way, adding a second entry is quite similar.
</p><p>
@@ -1279,10 +1550,10 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
</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.
+ 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>
@@ -1292,15 +1563,15 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
</p><p>
- And every module will now be using the values from the
- logger named <span class="quote">“<span class="quote">*</span>”</span>.
+ 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></div></div><div class="section" title="16.2. Logging Message Format"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id462428"></a>16.2. 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]
@@ -1325,20 +1596,21 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
(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.
+ 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.
+ 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>
+ </p></div></div><div class="chapter" title="Chapter 17. Acknowledgements"><div class="titlepage"><div><div><h2 class="title"><a name="id462551"></a>Chapter 17. Acknowledgements</h2></div></div></div><p>ISC would like to acknowledge generous support for
+ development of DHCPv4 and DHCPv6 components provided by <a class="ulink" href="http://www.comcast.com" target="_top">Comcast</a>.</p></div></div></body></html>
diff --git a/doc/guide/bind10-guide.xml b/doc/guide/bind10-guide.xml
index b186111..c58a97f 100644
--- a/doc/guide/bind10-guide.xml
+++ b/doc/guide/bind10-guide.xml
@@ -34,17 +34,19 @@
</copyright>
<abstract>
- <para>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.
+ <para>BIND 10 is a framework that features Domain Name System
+ (DNS) suite and Dynamic Host Configuration Protocol (DHCP)
+ servers managed by Internet Systems Consortium (ISC). It
+ includes DNS libraries, modular components for controlling
+ authoritative and recursive DNS servers, and experimental DHCPv4
+ and DHCPv6 servers.
</para>
<para>
This is the reference guide for BIND 10 version &__VERSION__;.
- 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 <ulink url="http://bind10.isc.org/docs"/>.
- </para> </abstract>
+ 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 <ulink url="http://bind10.isc.org/docs"/>.
+ </para> </abstract>
<releaseinfo>This is the reference guide for BIND 10 version
&__VERSION__;.</releaseinfo>
@@ -98,20 +100,20 @@
</para>
<para>
- BIND 10 uses the Botan crypto library for C++. It requires
- at least Botan version 1.8.
+ BIND 10 uses the Botan crypto library for C++. It requires
+ at least Botan version 1.8.
</para>
<para>
- BIND 10 uses the log4cplus C++ logging library. It requires
- at least log4cplus version 1.0.3.
+ BIND 10 uses the log4cplus C++ logging library. It requires
+ at least log4cplus version 1.0.3.
</para>
<para>
- The authoritative server requires SQLite 3.3.9 or newer.
- The <command>b10-xfrin</command>, <command>b10-xfrout</command>,
- and <command>b10-zonemgr</command> modules require the
- libpython3 library and the Python _sqlite3.so module.
+ The authoritative server requires SQLite 3.3.9 or newer.
+ The <command>b10-xfrin</command>, <command>b10-xfrout</command>,
+ and <command>b10-zonemgr</command> modules require the
+ libpython3 library and the Python _sqlite3.so module.
</para>
<!-- TODO: this will change ... -->
@@ -133,19 +135,19 @@
<para>
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.
+ provide the server functionality. This is a change from
+ the previous generation of BIND software, which used a
+ single process.
</para>
<para>
- At first, running many different processes may seem confusing.
- However, these processes are started, stopped, and maintained
- by a single command, <command>bind10</command>.
- This command starts a master process which will start other
- processes as needed.
- The processes started by the <command>bind10</command>
- command have names starting with "b10-", including:
+ At first, running many different processes may seem confusing.
+ However, these processes are started, stopped, and maintained
+ by a single command, <command>bind10</command>.
+ This command starts a master process which will start other
+ processes as needed.
+ The processes started by the <command>bind10</command>
+ command have names starting with "b10-", including:
</para>
<para>
@@ -215,9 +217,9 @@
<simpara>
<command>b10-xfrout</command> —
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.
+ This process is used to handle transfer requests to
+ send a local zone to a remote secondary server,
+ when acting as a master server.
</simpara>
</listitem>
@@ -225,7 +227,7 @@
<simpara>
<command>b10-zonemgr</command> —
Secondary manager.
- This process keeps track of timers and other
+ This process keeps track of timers and other
necessary information for BIND 10 to act as a slave server.
</simpara>
</listitem>
@@ -234,8 +236,8 @@
</para>
<para>
- These are ran automatically by <command>bind10</command>
- and do not need to be run manually.
+ These are ran automatically by <command>bind10</command>
+ and do not need to be run manually.
</para>
</section>
@@ -244,8 +246,8 @@
<title>Managing BIND 10</title>
<para>
- Once BIND 10 is running, a few commands are used to interact
- directly with the system:
+ Once BIND 10 is running, a few commands are used to interact
+ directly with the system:
<itemizedlist>
<listitem>
<simpara>
@@ -342,8 +344,8 @@ var/
</para>
<para>
- To build BIND 10, also install the Botan (at least version
- 1.8) and the log4cplus (at least version 1.0.3)
+ 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.
</para>
@@ -355,7 +357,7 @@ Debian and Ubuntu:
<para>
<!-- TODO: is this needed at build time? test time? -->
- The Python Library and Python _sqlite3 module are required to
+ The Python Library and Python _sqlite3 module are required to
enable the Xfrout and Xfrin support.
</para>
@@ -818,20 +820,20 @@ Debian and Ubuntu:
</para>
<para>
- The kind specifies how a failure of the component should
- be handled. If it is set to <quote>dispensable</quote>
- (the default unless you set something else), it will get
- started again if it fails. If it is set to <quote>needed</quote>
- and it fails at startup, the whole <command>bind10</command>
- 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 <quote>core</quote>, 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).
+ The kind specifies how a failure of the component should
+ be handled. If it is set to <quote>dispensable</quote>
+ (the default unless you set something else), it will get
+ started again if it fails. If it is set to <quote>needed</quote>
+ and it fails at startup, the whole <command>bind10</command>
+ 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 <quote>core</quote>, 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).
</para>
<para>
@@ -842,13 +844,13 @@ Debian and Ubuntu:
<para>
There are other parameters we didn't use in our example.
- One of them is <quote>address</quote>. It is the address
- used by the component on the <command>b10-msgq</command>
- message bus. The special components already know their
- address, but the usual ones don't. The address is by
- convention the thing after <emphasis>b10-</emphasis>, with
- the first letter capital (eg. <command>b10-stats</command>
- would have <quote>Stats</quote> as its address).
+ One of them is <quote>address</quote>. It is the address
+ used by the component on the <command>b10-msgq</command>
+ message bus. The special components already know their
+ address, but the usual ones don't. The address is by
+ convention the thing after <emphasis>b10-</emphasis>, with
+ the first letter capital (eg. <command>b10-stats</command>
+ would have <quote>Stats</quote> as its address).
<!-- TODO: this should be simplified so we don't even have to document it -->
</para>
@@ -877,15 +879,15 @@ address, but the usual ones don't." mean? -->
<note>
<para>
- The configuration is quite powerful, but that includes
- a lot of space for mistakes. You could turn off the
- <command>b10-cmdctl</command>, 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
- -- <command>b10-stats-httpd</command> need
- <command>b10-stats</command>, <command>b10-xfrout</command>
- needs the <command>b10-auth</command> to be running, etc.
+ The configuration is quite powerful, but that includes
+ a lot of space for mistakes. You could turn off the
+ <command>b10-cmdctl</command>, 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
+ -- <command>b10-stats-httpd</command> need
+ <command>b10-stats</command>, <command>b10-xfrout</command>
+ needs the <command>b10-auth</command> to be running, etc.
<!-- TODO: should we define dependencies? -->
@@ -896,19 +898,19 @@ address, but the usual ones don't." mean? -->
</note>
<para>
- Now, to the mysterious setuid virtual component. If you
- use the <command>-u</command> option to start the
- <command>bind10</command> as root, but change the user
- later, we need to start the <command>b10-auth</command> or
- <command>b10-resolver</command> as root (until the socket
- creator is finished).<!-- TODO --> 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, <command>b10-auth</command>
- has 10 to be started before the switch and everything else
- is without priority, so it is started after the switch.
+ Now, to the mysterious setuid virtual component. If you
+ use the <command>-u</command> option to start the
+ <command>bind10</command> as root, but change the user
+ later, we need to start the <command>b10-auth</command> or
+ <command>b10-resolver</command> as root (until the socket
+ creator is finished).<!-- TODO --> 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, <command>b10-auth</command>
+ has 10 to be started before the switch and everything else
+ is without priority, so it is started after the switch.
</para>
</section>
@@ -1441,16 +1443,16 @@ TODO
<section>
<title>Configuration for Incoming Zone Transfers</title>
<para>
- 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)).
+ 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)).
</para>
<para>
- 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 <command>bindctl</command> prompt:
+ 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 <command>bindctl</command> prompt:
<screen>> <userinput>config add Xfrin/zones</userinput>
> <userinput>config set Xfrin/zones[0]/name "<option>example.com</option>"</userinput>
@@ -1549,11 +1551,11 @@ what if a NOTIFY is sent?
<title>Trigger an Incoming Zone Transfer Manually</title>
<para>
- To manually trigger a zone transfer to retrieve a remote zone,
- you may use the <command>bindctl</command> utility.
- For example, at the <command>bindctl</command> prompt run:
+ To manually trigger a zone transfer to retrieve a remote zone,
+ you may use the <command>bindctl</command> utility.
+ For example, at the <command>bindctl</command> prompt run:
- <screen>> <userinput>Xfrin retransfer zone_name="<option>foo.example.org</option>" master=<option>192.0.2.99</option></userinput></screen>
+ <screen>> <userinput>Xfrin retransfer zone_name="<option>foo.example.org</option>" master=<option>192.0.2.99</option></userinput></screen>
</para>
</section>
@@ -1603,9 +1605,9 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)</screen>
> <userinput>config commit</userinput></screen>
<note><simpara>
- In the above example the lines
- for <option>transfer_acl</option> were divided for
- readability. In the actual input it must be in a single line.
+ In the above example the lines
+ for <option>transfer_acl</option> were divided for
+ readability. In the actual input it must be in a single line.
</simpara></note>
<para>
@@ -1630,10 +1632,10 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)</screen>
</para>
<note><simpara>
- In a future version, <command>b10-xfrout</command> will also
- use the system wide TSIG configuration.
- The way to specify zone specific configuration (ACLs, etc) is
- likely to be changed, too.
+ In a future version, <command>b10-xfrout</command> will also
+ use the system wide TSIG configuration.
+ The way to specify zone specific configuration (ACLs, etc) is
+ likely to be changed, too.
</simpara></note>
<!--
@@ -1711,30 +1713,30 @@ what is XfroutClient xfr_client??
By default, the <command>b10-resolver</command> daemon only accepts
DNS queries from the localhost (127.0.0.1 and ::1).
The <option>Resolver/query_acl</option> configuration may
- be used to reject, drop, or allow specific IPs or networks.
+ be used to reject, drop, or allow specific IPs or networks.
This configuration list is first match.
</para>
<para>
- The configuration's <option>action</option> item may be
- set to <quote>ACCEPT</quote> to allow the incoming query,
- <quote>REJECT</quote> to respond with a DNS REFUSED return
- code, or <quote>DROP</quote> to ignore the query without
- any response (such as a blackhole). For more information,
- see the respective debugging messages: <ulink
- url="bind10-messages.html#RESOLVER_QUERY_ACCEPTED">RESOLVER_QUERY_ACCEPTED</ulink>,
- <ulink
- url="bind10-messages.html#RESOLVER_QUERY_REJECTED">RESOLVER_QUERY_REJECTED</ulink>,
- and <ulink
+ The configuration's <option>action</option> item may be
+ set to <quote>ACCEPT</quote> to allow the incoming query,
+ <quote>REJECT</quote> to respond with a DNS REFUSED return
+ code, or <quote>DROP</quote> to ignore the query without
+ any response (such as a blackhole). For more information,
+ see the respective debugging messages: <ulink
+ url="bind10-messages.html#RESOLVER_QUERY_ACCEPTED">RESOLVER_QUERY_ACCEPTED</ulink>,
+ <ulink
+ url="bind10-messages.html#RESOLVER_QUERY_REJECTED">RESOLVER_QUERY_REJECTED</ulink>,
+ and <ulink
url="bind10-messages.html#RESOLVER_QUERY_DROPPED">RESOLVER_QUERY_DROPPED</ulink>.
</para>
<para>
- The required configuration's <option>from</option> item is set
+ The required configuration's <option>from</option> item is set
to an IPv4 or IPv6 address, addresses with an network mask, or to
- the special lowercase keywords <quote>any6</quote> (for
- any IPv6 address) or <quote>any4</quote> (for any IPv4
- address).
+ the special lowercase keywords <quote>any6</quote> (for
+ any IPv6 address) or <quote>any4</quote> (for any IPv4
+ address).
</para>
<!-- TODO:
@@ -1745,9 +1747,9 @@ TODO: tsig
-->
<para>
- For example to allow the <replaceable>192.168.1.0/24</replaceable>
- network to use your recursive name server, at the
- <command>bindctl</command> prompt run:
+ For example to allow the <replaceable>192.168.1.0/24</replaceable>
+ network to use your recursive name server, at the
+ <command>bindctl</command> prompt run:
</para>
<screen>
@@ -1806,6 +1808,459 @@ then change those defaults with config set Resolver/forward_addresses[0]/address
</chapter>
+ <chapter id="dhcp4">
+ <title>DHCPv4 Server</title>
+ <para>Dynamic Host Configuration Protocol for IPv4 (DHCP or
+ DHCPv4) and Dynamic Host Configuration Protocol for IPv6 (DHCPv6)
+ are protocols that allow one node (server) to provision
+ configuration parameters to many hosts and devices (clients). To
+ ease deployment in larger networks, additional nodes (relays) may
+ be deployed that facilitate communication between servers and
+ clients. Even though principles of both DHCPv4 and DHCPv6 are
+ somewhat similar, these are two radically different
+ protocols. BIND10 offers server implementations for both DHCPv4
+ and DHCPv6. This chapter is about DHCP for IPv4. For a description
+ of the DHCPv6 server, see <xref linkend="dhcp6"/>.</para>
+
+ <para>The DHCPv4 server component is currently under intense
+ development. You may want to check out <ulink
+ url="http://bind10.isc.org/wiki/Kea">BIND10 DHCP (Kea) wiki</ulink>
+ and recent posts on <ulink
+ url="https://lists.isc.org/mailman/listinfo/bind10-dev">BIND10
+ developers mailing list</ulink>.</para>
+
+ <para>The DHCPv4 and DHCPv6 components in BIND10 architecture are
+ internally code named <quote>Kea</quote>.</para>
+
+ <note>
+ <para>
+ As of December 2011, both DHCPv4 and DHCPv6 components are
+ skeleton servers. That means that while they are capable of
+ performing DHCP configuration, they are not fully functional
+ yet. In particular, neither has functional lease
+ databases. This means that they will assign the same, fixed,
+ hardcoded addresses to any client that will ask. See <xref
+ linkend="dhcp4-limit"/> and <xref linkend="dhcp6-limit"/> for
+ detailed description.
+ </para>
+ </note>
+
+ <section id="dhcp4-usage">
+ <title>DHCPv4 Server Usage</title>
+ <para>BIND10 provides the DHCPv4 server component since December
+ 2011. It is a skeleton server and can be described as an early
+ prototype that is not fully functional yet. It is mature enough
+ to conduct first tests in lab environment, but it has
+ significant limitations. See <xref linkend="dhcp4-limit"/> for
+ details.
+ </para>
+
+ <para>
+ The DHCPv4 server is implemented as <command>b10-dhcp4</command>
+ daemon. As it is not configurable yet, it is fully autonomous,
+ that is it does not interact with <command>b10-cfgmgr</command>.
+ To start DHCPv4 server, simply input:
+
+ <screen>
+#<userinput>cd src/bin/dhcp4</userinput>
+#<userinput>./b10-dhcp4</userinput>
+</screen>
+
+ Depending on your installation, <command>b10-dhcp4</command>
+ binary may reside in src/bin/dhcp4 in your source code
+ directory, in /usr/local/bin/b10-dhcp4 or other directory
+ you specified during compilation.
+
+ At start, the server will detect available network interfaces
+ and will attempt to open UDP sockets on all interfaces that
+ are up, running, are not loopback, and have IPv4 address
+ assigned.
+
+ The server will then listen to incoming traffic. Currently
+ supported client messages are DISCOVER and REQUEST. The server
+ will respond to them with OFFER and ACK, respectively.
+
+ Since the DHCPv4 server opens privileged ports, it requires root
+ access. Make sure you run this daemon as root.</para>
+
+ <note>
+ <para>
+ Integration with <command>bind10</command> is
+ planned. Ultimately, <command>b10-dhcp4</command> will not
+ be started directly, but rather via
+ <command>bind10</command>. Please be aware of this planned
+ change.
+ </para>
+ </note>
+
+ </section>
+
+ <section id="dhcp4-config">
+ <title>DHCPv4 Server Configuration</title>
+ <para>
+ The DHCPv4 server does not have a lease database implemented yet
+ nor any support for configuration, so every time the same set
+ of configuration options (including the same fixed address)
+ will be assigned every time.
+ </para>
+ <para>
+ At this stage of development, the only way to alter the server
+ configuration is to tweak its source code. To do so, please
+ edit src/bin/dhcp4/dhcp4_srv.cc file and modify following
+ parameters and recompile:
+ <screen>
+const std::string HARDCODED_LEASE = "192.0.2.222"; // assigned lease
+const std::string HARDCODED_NETMASK = "255.255.255.0";
+const uint32_t HARDCODED_LEASE_TIME = 60; // in seconds
+const std::string HARDCODED_GATEWAY = "192.0.2.1";
+const std::string HARDCODED_DNS_SERVER = "192.0.2.2";
+const std::string HARDCODED_DOMAIN_NAME = "isc.example.com";
+const std::string HARDCODED_SERVER_ID = "192.0.2.1";</screen>
+
+ Lease database and configuration support is planned for 2012.
+ </para>
+ </section>
+
+ <section id="dhcp4-std">
+ <title>Supported standards</title>
+ <para>The following standards and draft standards are currently
+ supported:</para>
+ <itemizedlist>
+ <listitem>
+ <simpara>RFC2131: Supported messages are DISCOVER, OFFER,
+ REQUEST, and ACK.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>RFC2132: Supported options are: PAD (0),
+ END(255), Message Type(53), DHCP Server Identifier (54),
+ Domain Name (15), DNS Servers (6), IP Address Lease Time
+ (51), Subnet mask (1), and Routers (3).</simpara>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="dhcp4-limit">
+ <title>DHCPv4 Server Limitations</title>
+ <para>These are the current limitations of the DHCPv4 server
+ software. Most of them are reflections of the early stage of
+ development and should be treated as <quote>not implemented
+ yet</quote>, rather than actual limitations.</para>
+ <itemizedlist>
+ <listitem>
+ <simpara>During initial IPv4 node configuration, the
+ server is expected to send packets to a node that does not
+ have IPv4 address assigned yet. The server requires
+ certain tricks (or hacks) to transmit such packets. This
+ is not implemented yet, therefore DHCPv4 server supports
+ relayed traffic only (that is, normal point to point
+ communication).</simpara>
+ </listitem>
+ <listitem>
+ <simpara><command>b10-dhcp4</command> provides a single,
+ fixed, hardcoded lease to any client that asks. There is
+ no lease manager implemented. If two clients request
+ addresses, they will both get the same fixed
+ address.</simpara>
+ </listitem>
+ <listitem>
+ <simpara><command>b10-dhcp4</command> does not support any
+ configuration mechanisms yet. The whole configuration is
+ currently hardcoded. The only way to tweak configuration
+ is to directly modify source code. See see <xref
+ linkend="dhcp4-config"/> for details.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Upon start, the server will open sockets on all
+ interfaces that are not loopback, are up and running and
+ have IPv4 address. Support for multiple interfaces is not
+ coded in reception routines yet, so if you are running
+ this code on a machine that has many interfaces and
+ <command>b10-dhcp4</command> happens to listen on wrong
+ interface, the easiest way to work around this problem is
+ to turn down other interfaces. This limitation will be
+ fixed shortly.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>PRL (Parameter Request List, a list of options
+ requested by a client) is currently ignored and server
+ assigns DNS SERVER and DOMAIN NAME options.</simpara>
+ </listitem>
+ <listitem>
+ <simpara><command>b10-dhcp4</command> does not support
+ BOOTP. That is a design choice. This limitation is
+ permanent. If you have legacy nodes that can't use DHCP and
+ require BOOTP support, please use latest version of ISC DHCP
+ <ulink url="http://www.isc.org/software/dhcp"/>.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Interface detection is currently working on Linux
+ only. See <xref linkend="iface-detect"/> for details.</simpara>
+ </listitem>
+ <listitem>
+ <simpara><command>b10-dhcp4</command> does not verify that
+ assigned address is unused. According to RFC2131, the
+ allocating server should verify that address is no used by
+ sending ICMP echo request.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Address renewal (RENEW), rebinding (REBIND),
+ confirmation (CONFIRM), duplication report (DECLINE) and
+ release (RELEASE) are not supported yet.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>DNS Update is not supported yet.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>-v (verbose) command line option is currently
+ the default, and cannot be disabled.</simpara>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ </chapter>
+
+ <chapter id="dhcp6">
+ <title>DHCPv6 Server</title>
+ <para>Dynamic Host Configuration Protocol for IPv6 (DHCPv6) is
+ specified in RFC3315. BIND10 provides DHCPv6 server implementation
+ that is described in this chapter. For a description of the DHCPv4
+ server implementation, see <xref linkend="dhcp4"/>.
+ </para>
+
+ <para>The DHCPv6 server component is currently under intense
+ development. You may want to check out <ulink
+ url="http://bind10.isc.org/wiki/Kea">BIND10 DHCP (Kea) wiki</ulink>
+ and recent posts on <ulink
+ url="https://lists.isc.org/mailman/listinfo/bind10-dev">BIND10
+ developers mailing list</ulink>.</para>
+
+ <para>The DHCPv4 and DHCPv6 components in BIND10 architecture are
+ internally code named <quote>Kea</quote>.</para>
+
+ <note>
+ <para>
+ As of December 2011, both DHCPv4 and DHCPv6 components are
+ skeleton servers. That means that while they are capable of
+ performing DHCP configuration, they are not fully functional
+ yet. In particular, neither has functional lease
+ databases. This means that they will assign the same, fixed,
+ hardcoded addresses to any client that will ask. See <xref
+ linkend="dhcp4-limit"/> and <xref linkend="dhcp6-limit"/> for
+ detailed description.
+ </para>
+ </note>
+
+ <section id="dhcp6-usage">
+ <title>DHCPv6 Server Usage</title>
+ <para>
+ BIND10 provides the DHCPv6 server component since September
+ 2011. It is a skeleton server and can be described as an early
+ prototype that is not fully functional yet. It is mature
+ enough to conduct first tests in lab environment, but it has
+ significant limitations. See <xref linkend="dhcp6-limit"/> for
+ details.
+ </para>
+
+ <para>
+ The DHCPv6 server is implemented as <command>b10-dhcp6</command>
+ daemon. As it is not configurable yet, it is fully autonomous,
+ that is it does not interact with <command>b10-cfgmgr</command>.
+ To start DHCPv6 server, simply input:
+
+ <screen>
+#<userinput>cd src/bin/dhcp6</userinput>
+#<userinput>./b10-dhcp6</userinput>
+</screen>
+
+ Depending on your installation, <command>b10-dhcp6</command>
+ binary may reside in src/bin/dhcp6 in your source code
+ directory, in /usr/local/bin/b10-dhcp6 or other directory
+ you specified during compilation.
+
+ At start, server will detect available network interfaces
+ and will attempt to open UDP sockets on all interfaces that
+ are up, running, are not loopback, are multicast-capable, and
+ have IPv6 address assigned.
+
+ The server will then listen to incoming traffic. Currently
+ supported client messages are SOLICIT and REQUEST. The server
+ will respond to them with ADVERTISE and REPLY, respectively.
+
+ Since the DHCPv6 server opens privileged ports, it requires root
+ access. Make sure you run this daemon as root.
+ </para>
+
+ <note>
+ <para>
+ Integration with <command>bind10</command> is
+ planned. Ultimately, <command>b10-dhcp6</command> will not
+ be started directly, but rather via
+ <command>bind10</command>. Please be aware of this planned
+ change.
+ </para>
+ </note>
+
+ </section>
+
+ <section id="dhcp6-config">
+ <title>DHCPv6 Server Configuration</title>
+ <para>
+ The DHCPv6 server does not have lease database implemented yet
+ or any support for configuration, so every time the same set
+ of configuration options (including the same fixed address)
+ will be assigned every time.
+ </para>
+ <para>
+ At this stage of development, the only way to alter server
+ configuration is to tweak its source code. To do so, please
+ edit src/bin/dhcp6/dhcp6_srv.cc file and modify following
+ parameters and recompile:
+ <screen>
+const std::string HARDCODED_LEASE = "2001:db8:1::1234:abcd";
+const uint32_t HARDCODED_T1 = 1500; // in seconds
+const uint32_t HARDCODED_T2 = 2600; // in seconds
+const uint32_t HARDCODED_PREFERRED_LIFETIME = 3600; // in seconds
+const uint32_t HARDCODED_VALID_LIFETIME = 7200; // in seconds
+const std::string HARDCODED_DNS_SERVER = "2001:db8:1::1";</screen>
+
+ Lease database and configuration support is planned for 2012.
+ </para>
+
+ </section>
+
+ <section id="dhcp6-std">
+ <title>Supported DHCPv6 Standards</title>
+ <para>The following standards and draft standards are currently
+ supported:</para>
+ <itemizedlist>
+ <listitem>
+ <simpara>RFC3315: Supported messages are SOLICIT,
+ ADVERTISE, REQUEST, and REPLY. Supported options are
+ SERVER_ID, CLIENT_ID, IA_NA, and IAADDRESS.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>RFC3646: Supported option is DNS_SERVERS.</simpara>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="dhcp6-limit">
+ <title>DHCPv6 Server Limitations</title>
+ <para> These are the current limitations of the DHCPv6 server
+ software. Most of them are reflections of the early stage of
+ development and should be treated as <quote>not implemented
+ yet</quote>, rather than actual limitations.</para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <simpara>Relayed traffic is not supported.</simpara>
+ </listitem>
+ <listitem>
+ <simpara><command>b10-dhcp6</command> provides a single,
+ fixed, hardcoded lease to any client that asks. There is no
+ lease manager implemented. If two clients request addresses,
+ they will both get the same fixed address.</simpara>
+ </listitem>
+ <listitem>
+ <simpara><command>b10-dhcp6</command> does not support any
+ configuration mechanisms yet. The whole configuration is
+ currently hardcoded. The only way to tweak configuration
+ is to directly modify source code. See see <xref
+ linkend="dhcp6-config"/> for details.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Upon start, the server will open sockets on all
+ interfaces that are not loopback, are up, running and are
+ multicast capable and have IPv6 address. Support for
+ multiple interfaces is not coded in reception routines yet,
+ so if you are running this code on a machine that has many
+ interfaces and <command>b10-dhcp6</command> happens to
+ listen on wrong interface, the easiest way to work around
+ this problem is to turn down other interfaces. This
+ limitation will be fixed shortly.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>ORO (Option Request Option, a list of options
+ requested by a client) is currently ignored and server
+ assigns DNS SERVER option.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Temporary addresses are not supported yet.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Prefix delegation is not supported yet.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Address renewal (RENEW), rebinding (REBIND),
+ confirmation (CONFIRM), duplication report (DECLINE) and
+ release (RELEASE) are not supported yet.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>DNS Update is not supported yet.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Interface detection is currently working on Linux
+ only. See <xref linkend="iface-detect"/> for details.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>-v (verbose) command line option is currently the
+ default, and cannot be disabled.</simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ </chapter>
+
+ <chapter id="libdhcp">
+ <title>libdhcp++ library</title>
+ <para>libdhcp++ is a common library written in C++ that handles
+ many DHCP-related tasks, like DHCPv4 and DHCPv6 packets parsing,
+ manipulation and assembly, option parsing, manipulation and
+ assembly, network interface detection and socket operations, like
+ socket creations, data transmission and reception and socket
+ closing.
+ </para>
+
+ <para>
+ While this library is currently used by
+ <command>b10-dhcp4</command> and <command>b10-dhcp6</command>
+ only, it is designed to be portable, universal library useful for
+ any kind of DHCP-related software.
+ </para>
+
+ <section id="iface-detect">
+ <title>Interface detection</title>
+ <para>Both DHCPv4 and DHCPv6 components share network
+ interface detection routines. Interface detection is
+ currently only supported on Linux systems.</para>
+
+ <para>For non-Linux systems, there is currently stub
+ implementation provided. As DHCP servers need to know available
+ addresses, there is a simple mechanism implemented to provide
+ that information. User is expected to create interfaces.txt
+ file. Format of this file is simple. It contains list of
+ interfaces along with available address on each interface. This
+ mechanism is temporary and is going to be removed as soon as
+ interface detection becomes available on non-Linux
+ systems. Here is an example of the interfaces.txt file:
+ <screen>
+# For DHCPv6, please specify link-local address (starts with fe80::)
+# If in doubt, check output of 'ifconfig -a' command.
+eth0 fe80::21e:8cff:fe9b:7349
+
+# For DHCPv4, please use following format:
+#eth0 192.0.2.5</screen>
+ </para>
+ </section>
+
+ <section id="packet-handling">
+ <title>DHCPv4/DHCPv6 packet handling</title>
+ <para>TODO: Describe packet handling here, with pointers to wiki</para>
+ </section>
+
+ </chapter>
+
<chapter id="statistics">
<title>Statistics</title>
@@ -1857,10 +2312,10 @@ then change those defaults with config set Resolver/forward_addresses[0]/address
<para>
- 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.
+ 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.
<!-- TODO: what is context of Logging module for readers of this guide? -->
@@ -1871,28 +2326,28 @@ then change those defaults with config set Resolver/forward_addresses[0]/address
<para>
- 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.
+ 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.
</para>
<para>
- In the Logging module, you can specify the configuration
- for zero or more loggers; any that are not specified will
- take appropriate default values..
+ In the Logging module, you can specify the configuration
+ for zero or more loggers; any that are not specified will
+ take appropriate default values..
</para>
<para>
- The three most important elements of a logger configuration
- are the <option>name</option> (the component that is
- generating the messages), the <option>severity</option>
- (what to log), and the <option>output_options</option>
- (where to log).
+ The three most important elements of a logger configuration
+ are the <option>name</option> (the component that is
+ generating the messages), the <option>severity</option>
+ (what to log), and the <option>output_options</option>
+ (where to log).
</para>
@@ -1900,12 +2355,12 @@ then change those defaults with config set Resolver/forward_addresses[0]/address
<title>name (string)</title>
<para>
- 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 <quote>Resolver</quote>. This
- configuration will then be used by the loggers in the
- Resolver module, and all the libraries used by it.
+ 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 <quote>Resolver</quote>. This
+ configuration will then be used by the loggers in the
+ Resolver module, and all the libraries used by it.
</para>
<!-- TODO: later we will have a way to know names of all modules
@@ -1917,13 +2372,13 @@ Right now you can only see what their names are if they are running
<para>
- If you want to specify logging for one specific library
- within the module, you set the name to
- <replaceable>module.library</replaceable>. For example, the
- logger used by the nameserver address store component
- has the full name of <quote>Resolver.nsas</quote>. If
- there is no entry in Logging for a particular library,
- it will use the configuration given for the module.
+ If you want to specify logging for one specific library
+ within the module, you set the name to
+ <replaceable>module.library</replaceable>. For example, the
+ logger used by the nameserver address store component
+ has the full name of <quote>Resolver.nsas</quote>. If
+ there is no entry in Logging for a particular library,
+ it will use the configuration given for the module.
<!-- TODO: how to know these specific names?
@@ -1938,61 +2393,61 @@ specify module-wide logging and see what appears...
<!-- TODO: severity has not been covered yet -->
- 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
- <quote>Resolver</quote> and severity INFO, and one with
- the name <quote>Resolver.cache</quote> with severity
- DEBUG. As there are no entries for other libraries (e.g.
- the nsas), they will use the configuration for the module
- (<quote>Resolver</quote>), so giving the desired behavior.
+ 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
+ <quote>Resolver</quote> and severity INFO, and one with
+ the name <quote>Resolver.cache</quote> with severity
+ DEBUG. As there are no entries for other libraries (e.g.
+ the nsas), they will use the configuration for the module
+ (<quote>Resolver</quote>), so giving the desired behavior.
</para>
<para>
- One special case is that of a module name of <quote>*</quote>
- (asterisks), which is interpreted as <emphasis>any</emphasis>
- 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. <quote>*.config</quote>
- specifies the configuration library code in whatever
- module is using it).
+ One special case is that of a module name of <quote>*</quote>
+ (asterisks), which is interpreted as <emphasis>any</emphasis>
+ 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. <quote>*.config</quote>
+ specifies the configuration library code in whatever
+ module is using it).
</para>
<para>
- 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 <quote>*</quote> and <quote>Resolver</quote>, the
- resolver module — and all libraries it uses —
- will log messages according to the configuration in the
- second entry (<quote>Resolver</quote>). All other modules
- will use the configuration of the first entry
- (<quote>*</quote>). If there was also a configuration
- entry for <quote>Resolver.cache</quote>, the cache library
- within the resolver would use that in preference to the
- entry for <quote>Resolver</quote>.
+ 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 <quote>*</quote> and <quote>Resolver</quote>, the
+ resolver module — and all libraries it uses —
+ will log messages according to the configuration in the
+ second entry (<quote>Resolver</quote>). All other modules
+ will use the configuration of the first entry
+ (<quote>*</quote>). If there was also a configuration
+ entry for <quote>Resolver.cache</quote>, the cache library
+ within the resolver would use that in preference to the
+ entry for <quote>Resolver</quote>.
</para>
<para>
- One final note about the naming. When specifying the
- module name within a logger, use the name of the module
- as specified in <command>bindctl</command>, e.g.
- <quote>Resolver</quote> for the resolver module,
- <quote>Xfrout</quote> 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
- <quote>Auth.cache</quote> logger will appear in the output
- with a logger name of <quote>b10-auth.cache</quote>).
+ One final note about the naming. When specifying the
+ module name within a logger, use the name of the module
+ as specified in <command>bindctl</command>, e.g.
+ <quote>Resolver</quote> for the resolver module,
+ <quote>Xfrout</quote> 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
+ <quote>Auth.cache</quote> logger will appear in the output
+ with a logger name of <quote>b10-auth.cache</quote>).
</para>
@@ -2004,9 +2459,9 @@ specify module-wide logging and see what appears...
<para>
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):
+ Each message is logged with an associated severity which
+ may be one of the following (in descending order of
+ severity):
</para>
<itemizedlist>
@@ -2033,11 +2488,11 @@ specify module-wide logging and see what appears...
<para>
- 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.
+ 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.
<!-- TODO: worded wrong? If I set to INFO, why would it show DEBUG which is literally below in that list? -->
@@ -2050,9 +2505,9 @@ specify module-wide logging and see what appears...
<para>
- Each logger can have zero or more
- <option>output_options</option>. These specify where log
- messages are sent to. These are explained in detail below.
+ Each logger can have zero or more
+ <option>output_options</option>. These specify where log
+ messages are sent to. These are explained in detail below.
</para>
@@ -2069,15 +2524,15 @@ specify module-wide logging and see what appears...
<para>
- 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).
+ 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).
</para>
<!-- TODO: complete this sentence:
- The general classification of debug message types is
+ The general classification of debug message types is
TODO; there's a ticket to determine these levels, see #1074
@@ -2096,15 +2551,15 @@ TODO; there's a ticket to determine these levels, see #1074
<para>
- If this is true, the <option>output_options</option> from
- the parent will be used. For example, if there are two
- loggers configured; <quote>Resolver</quote> and
- <quote>Resolver.cache</quote>, and <option>additive</option>
- is true in the second, it will write the log messages
- not only to the destinations specified for
- <quote>Resolver.cache</quote>, but also to the destinations
- as specified in the <option>output_options</option> in
- the logger named <quote>Resolver</quote>.
+ If this is true, the <option>output_options</option> from
+ the parent will be used. For example, if there are two
+ loggers configured; <quote>Resolver</quote> and
+ <quote>Resolver.cache</quote>, and <option>additive</option>
+ is true in the second, it will write the log messages
+ not only to the destinations specified for
+ <quote>Resolver.cache</quote>, but also to the destinations
+ as specified in the <option>output_options</option> in
+ the logger named <quote>Resolver</quote>.
<!-- TODO: check this -->
@@ -2119,10 +2574,10 @@ TODO; there's a ticket to determine these levels, see #1074
<para>
- The main settings for an output option are the
- <option>destination</option> and a value called
- <option>output</option>, the meaning of which depends on
- the destination that is set.
+ The main settings for an output option are the
+ <option>destination</option> and a value called
+ <option>output</option>, the meaning of which depends on
+ the destination that is set.
</para>
@@ -2158,8 +2613,8 @@ TODO; there's a ticket to determine these levels, see #1074
<para>
- Depending on what is set as the output destination, this
- value is interpreted as follows:
+ Depending on what is set as the output destination, this
+ value is interpreted as follows:
</para>
@@ -2169,10 +2624,10 @@ TODO; there's a ticket to determine these levels, see #1074
<term><option>destination</option> is <quote>console</quote></term>
<listitem>
<simpara>
- The value of output must be one of <quote>stdout</quote>
- (messages printed to standard output) or
- <quote>stderr</quote> (messages printed to standard
- error).
+ The value of output must be one of <quote>stdout</quote>
+ (messages printed to standard output) or
+ <quote>stderr</quote> (messages printed to standard
+ error).
</simpara>
</listitem>
</varlistentry>
@@ -2181,8 +2636,8 @@ TODO; there's a ticket to determine these levels, see #1074
<term><option>destination</option> is <quote>file</quote></term>
<listitem>
<simpara>
- The value of output is interpreted as a file name;
- log messages will be appended to this file.
+ The value of output is interpreted as a file name;
+ log messages will be appended to this file.
</simpara>
</listitem>
</varlistentry>
@@ -2191,10 +2646,10 @@ TODO; there's a ticket to determine these levels, see #1074
<term><option>destination</option> is <quote>syslog</quote></term>
<listitem>
<simpara>
- The value of output is interpreted as the
- <command>syslog</command> facility (e.g.
- <emphasis>local0</emphasis>) that should be used
- for log messages.
+ The value of output is interpreted as the
+ <command>syslog</command> facility (e.g.
+ <emphasis>local0</emphasis>) that should be used
+ for log messages.
</simpara>
</listitem>
</varlistentry>
@@ -2211,10 +2666,10 @@ TODO; there's a ticket to determine these levels, see #1074
<title>flush (true of false)</title>
<para>
- 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.
+ 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.
</para>
</section>
@@ -2223,11 +2678,11 @@ TODO; there's a ticket to determine these levels, see #1074
<title>maxsize (integer)</title>
<para>
- 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",
+ 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.)
</para>
@@ -2241,9 +2696,9 @@ TODO; there's a ticket to determine these levels, see #1074
<title>maxver (integer)</title>
<para>
- Maximum number of old log files to keep around when
- rolling the output file. Only relevant when
- <option>destination</option> is <quote>file</quote>.
+ Maximum number of old log files to keep around when
+ rolling the output file. Only relevant when
+ <option>destination</option> is <quote>file</quote>.
</para>
</section>
@@ -2257,11 +2712,11 @@ TODO; there's a ticket to determine these levels, see #1074
<para>
- In this example we want to set the global logging to
- write to the file <filename>/var/log/my_bind10.log</filename>,
- at severity WARN. We want the authoritative server to
- log at DEBUG with debuglevel 40, to a different file
- (<filename>/tmp/debug_messages</filename>).
+ In this example we want to set the global logging to
+ write to the file <filename>/var/log/my_bind10.log</filename>,
+ at severity WARN. We want the authoritative server to
+ log at DEBUG with debuglevel 40, to a different file
+ (<filename>/tmp/debug_messages</filename>).
</para>
@@ -2282,9 +2737,9 @@ Logging/loggers [] list
<para>
- By default, no specific loggers are configured, in which
- case the severity defaults to INFO and the output is
- written to stderr.
+ By default, no specific loggers are configured, in which
+ case the severity defaults to INFO and the output is
+ written to stderr.
</para>
@@ -2306,8 +2761,8 @@ Logging/loggers/ list (modified)
<para>
- The loggers value line changed to indicate that it is no
- longer an empty list:
+ The loggers value line changed to indicate that it is no
+ longer an empty list:
</para>
@@ -2325,9 +2780,9 @@ Logging/loggers[0]/output_options [] list (default)
<para>
- The name is mandatory, so we must set it. We will also
- change the severity as well. Let's start with the global
- logger.
+ The name is mandatory, so we must set it. We will also
+ change the severity as well. Let's start with the global
+ logger.
</para>
@@ -2347,8 +2802,8 @@ Logging/loggers[0]/output_options [] list (default)
<para>
- Of course, we need to specify where we want the log
- messages to go, so we add an entry for an output option.
+ Of course, we need to specify where we want the log
+ messages to go, so we add an entry for an output option.
</para>
@@ -2384,8 +2839,8 @@ Logging/loggers[0]/output_options[0]/maxver 0 integer (default)
<para>
- Which would make the entire configuration for this logger
- look like:
+ Which would make the entire configuration for this logger
+ look like:
</para>
@@ -2407,8 +2862,8 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
<para>
- That looks OK, so let's commit it before we add the
- configuration for the authoritative server's logger.
+ That looks OK, so let's commit it before we add the
+ configuration for the authoritative server's logger.
</para>
@@ -2420,8 +2875,8 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
<para>
- Now that we have set it, and checked each value along
- the way, adding a second entry is quite similar.
+ Now that we have set it, and checked each value along
+ the way, adding a second entry is quite similar.
</para>
@@ -2441,10 +2896,10 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
<para>
- 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.
+ 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.
</para>
@@ -2458,8 +2913,8 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
<para>
- And every module will now be using the values from the
- logger named <quote>*</quote>.
+ And every module will now be using the values from the
+ logger named <quote>*</quote>.
</para>
@@ -2471,11 +2926,11 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
<title>Logging Message Format</title>
<para>
- 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.
+ 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.
</para>
<para>
@@ -2525,29 +2980,29 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
<varlistentry>
<term>ASIODNS_OPENSOCK</term>
<listitem><para>
- The message identification. Every message in BIND 10
- has a unique identification, which can be used as an
- index into the <ulink
- url="bind10-messages.html"><citetitle>BIND 10 Messages
- Manual</citetitle></ulink> (<ulink
- url="http://bind10.isc.org/docs/bind10-messages.html"
- />) from which more information can be obtained.
+ The message identification. Every message in BIND 10
+ has a unique identification, which can be used as an
+ index into the <ulink
+ url="bind10-messages.html"><citetitle>BIND 10 Messages
+ Manual</citetitle></ulink> (<ulink
+ url="http://bind10.isc.org/docs/bind10-messages.html"
+ />) from which more information can be obtained.
</para></listitem>
</varlistentry>
<varlistentry>
<term>error 111 opening TCP socket to 127.0.0.1(53)</term>
<listitem><para>
- 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.
+ 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.
</para></listitem>
</varlistentry>
</variablelist>
@@ -2557,6 +3012,18 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
</chapter>
+<!-- TODO: acknolwedgements must be unnumbered -->
+
+ <chapter>
+ <title>Acknowledgements</title>
+ <para>ISC would like to acknowledge generous support for
+ development of DHCPv4 and DHCPv6 components provided by <ulink
+ url="http://www.comcast.com">Comcast</ulink>.</para>
+ </chapter>
+
+<!-- TODO: Add bibliography section (mostly RFCs, probably) -->
+
+
<!-- TODO: how to help: run unit tests, join lists, review trac tickets -->
<!-- <index> <title>Index</title> </index> -->
More information about the bind10-changes
mailing list