From: Tomek Mrugalski Date: Wed, 28 Dec 2011 11:04:41 +0000 (+0100) Subject: [1367] Initial documentation for DHCPv4 is ready. X-Git-Tag: trac2351_base~310^2~10^2~4 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=126ab0b66824ee084ee1e03cdcf3a2e73d4bca04;p=thirdparty%2Fkea.git [1367] Initial documentation for DHCPv4 is ready. --- diff --git a/doc/guide/bind10-guide.html b/doc/guide/bind10-guide.html index 2972cdfa96..bae83c93e2 100644 --- a/doc/guide/bind10-guide.html +++ b/doc/guide/bind10-guide.html @@ -1,26 +1,26 @@ -BIND 10 Guide

BIND 10 Guide

Administrator Reference for BIND 10

This is the reference guide for BIND 10 version - 20111021.

Copyright © 2010-2011 Internet Systems Consortium, Inc.

Abstract

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. +BIND 10 Guide

BIND 10 Guide

Administrator Reference for BIND 10

This is the reference guide for BIND 10 version + 20111129.

Copyright © 2010-2011 Internet Systems Consortium, Inc.

Abstract

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 http://bind10.isc.org/docs. -

Table of Contents

1. Introduction
Supported Platforms
Required Software
Starting and Stopping the Server
Managing BIND 10
2. Installation
Building Requirements
Quick start
Installation from source
Download Tar File
Retrieve from Git
Configure before the build
Build
Install
Install Hierarchy
3. Starting BIND10 with bind10
Starting BIND 10
Configuration of started processes
4. Command channel
5. Configuration manager
6. Remote control daemon
Configuration specification for b10-cmdctl
7. Control and configure user interface
8. Authoritative Server
Server Configurations
Data Source Backends
Loading Master Zones Files
9. Incoming Zone Transfers
Configuration for Incoming Zone Transfers
Enabling IXFR
Trigger an Incoming Zone Transfer Manually
10. Outbound Zone Transfers
11. Secondary Manager
12. Recursive Name Server
Access Control
Forwarding
13. Statistics
14. Logging
Logging configuration
Loggers
Output Options
Example session
Logging Message Format

List of Tables

3.1.

Chapter 1. Introduction

Table of Contents

Supported Platforms
Required Software
Starting and Stopping the Server
Managing BIND 10

+ 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 http://bind10.isc.org/docs. +

Table of Contents

1. Introduction
Supported Platforms
Required Software
Starting and Stopping the Server
Managing BIND 10
2. Installation
Building Requirements
Quick start
Installation from source
Download Tar File
Retrieve from Git
Configure before the build
Build
Install
Install Hierarchy
3. Starting BIND10 with bind10
Starting BIND 10
Configuration of started processes
4. Command channel
5. Configuration manager
6. Remote control daemon
Configuration specification for b10-cmdctl
7. Control and configure user interface
8. Authoritative Server
Server Configurations
Data Source Backends
Loading Master Zones Files
9. Incoming Zone Transfers
Configuration for Incoming Zone Transfers
Enabling IXFR
Secondary Manager
Trigger an Incoming Zone Transfer Manually
10. Outbound Zone Transfers
11. Recursive Name Server
Access Control
Forwarding
12. DHCPv4 Server
Server Usage
Server Configuration
DHCPv4 Server Limitations
13. DHCPv6 Server
DHCPv6 Server Limitations
14. libdhcp++ library
Interface detection
15. Statistics
16. Logging
Logging configuration
Loggers
Output Options
Example session
Logging Message Format

List of Tables

3.1.

Chapter 1. Introduction

Table of Contents

Supported Platforms
Required Software
Starting and Stopping the Server
Managing BIND 10

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.

Note

This guide covers the experimental prototype of - BIND 10 version 20111021. + BIND 10 version 20111129.

Note

BIND 10 provides a EDNS0- and DNSSEC-capable authoritative DNS server and a caching recursive name server which also provides forwarding. -

Supported Platforms

+

Supported Platforms

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,20 +30,20 @@ It is planned for BIND 10 to build, install and run on Windows and standard Unix-type platforms. -

Required Software

+

Required Software

BIND 10 requires Python 3.1. Later versions may work, but Python 3.1 is the minimum version which will work.

- 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.

- 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.

- The authoritative server requires SQLite 3.3.9 or newer. - The b10-xfrin, b10-xfrout, - and b10-zonemgr modules require the - libpython3 library and the Python _sqlite3.so module. + The authoritative server requires SQLite 3.3.9 or newer. + The b10-xfrin, b10-xfrout, + and b10-zonemgr modules require the + libpython3 library and the Python _sqlite3.so module.

Note

Some operating systems do not provide these dependencies in their default installation nor standard packages @@ -52,17 +52,17 @@

Starting and Stopping the Server

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.

- At first, running many different processes may seem confusing. - However, these processes are started, stopped, and maintained - by a single command, bind10. - This command starts a master process which will start other - processes as needed. - The processes started by the bind10 - 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, bind10. + This command starts a master process which will start other + processes as needed. + The processes started by the bind10 + command have names starting with "b10-", including:

  • @@ -99,21 +99,21 @@
  • b10-xfrout — 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.
  • b10-zonemgr — 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.

- These are ran automatically by bind10 - and do not need to be run manually. + These are ran automatically by bind10 + and do not need to be run manually.

Managing BIND 10

- 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:

  • bindctl — interactive administration interface. @@ -140,7 +140,7 @@ and, of course, DNS. These include detailed developer documentation and code examples. -

Chapter 2. Installation

Table of Contents

Building Requirements
Quick start
Installation from source
Download Tar File
Retrieve from Git
Configure before the build
Build
Install
Install Hierarchy

Building Requirements

+

Chapter 2. Installation

Table of Contents

Building Requirements
Quick start
Installation from source
Download Tar File
Retrieve from Git
Configure before the build
Build
Install
Install Hierarchy

Building Requirements

In addition to the run-time requirements, building BIND 10 from source code requires various development include headers.

Note

@@ -154,12 +154,12 @@

- 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.

- 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.

Note

The Python related libraries and modules need to be built @@ -204,14 +204,14 @@ 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. -

Download Tar File

+

Download Tar File

Downloading a release tar file is the recommended method to obtain the source code.

The BIND 10 releases are available as tar file downloads from ftp://ftp.isc.org/isc/bind10/. Periodic development snapshots may also be available. -

Retrieve from Git

+

Retrieve from Git

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 +245,7 @@ autoheader, automake, and related commands. -

Configure before the build

+

Configure before the build

BIND 10 uses the GNU Build System to discover build environment details. To generate the makefiles using the defaults, simply run: @@ -276,16 +276,16 @@

If the configure fails, it may be due to missing or old dependencies. -

Build

+

Build

After the configure step is complete, to build the executables from the C++ code and prepare the Python scripts, run: 

$ make

-

Install

+

Install

To install the BIND 10 executables, support files, and documentation, run: 

$ make install

-

Note

The install step may require superuser privileges.

Install Hierarchy

+

Note

The install step may require superuser privileges.

Install Hierarchy

The following is the layout of the complete BIND 10 installation:

  • bin/ — @@ -385,35 +385,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: -

    Table 3.1. 

    ComponentSpecialDescription
    b10-authauthAuthoritative server
    b10-resolverresolverThe resolver
    b10-cmdctlcmdctlThe command control (remote control interface)
    setuidsetuidVirtual component, see below


    +

    Table 3.1. 

    ComponentSpecialDescription
    b10-authauthAuthoritative server
    b10-resolverresolverThe resolver
    b10-cmdctlcmdctlThe command control (remote control interface)
    setuidsetuidVirtual component, see below


    - The kind specifies how a failure of the component should - be handled. If it is set to “dispensable” - (the default unless you set something else), it will get - started again if it fails. If it is set to “needed” - and it fails at startup, the whole bind10 - 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 “core”, 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 “dispensable” + (the default unless you set something else), it will get + started again if it fails. If it is set to “needed” + and it fails at startup, the whole bind10 + 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 “core”, 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 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.

    There are other parameters we didn't use in our example. - One of them is “address”. It is the address - used by the component on the b10-msgq - message bus. The special components already know their - address, but the usual ones don't. The address is by - convention the thing after b10-, with - the first letter capital (eg. b10-stats - would have “Stats” as its address). + One of them is “address”. It is the address + used by the component on the b10-msgq + message bus. The special components already know their + address, but the usual ones don't. The address is by + convention the thing after b10-, with + the first letter capital (eg. b10-stats + would have “Stats” as its address).

    The last one is process. It is the name of the process to be started. @@ -426,34 +426,34 @@ such situation, so it would probably not do what you want. Such support is yet to be implemented.

Note

- The configuration is quite powerful, but that includes - a lot of space for mistakes. You could turn off the - b10-cmdctl, 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 - -- b10-stats-httpd need - b10-stats, b10-xfrout - needs the b10-auth to be running, etc. + The configuration is quite powerful, but that includes + a lot of space for mistakes. You could turn off the + b10-cmdctl, 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 + -- b10-stats-httpd need + b10-stats, b10-xfrout + needs the b10-auth to be running, etc.

In short, you should think twice before disabling something here.

- Now, to the mysterious setuid virtual component. If you - use the -u option to start the - bind10 as root, but change the user - later, we need to start the b10-auth or - b10-resolver 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, b10-auth - 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 -u option to start the + bind10 as root, but change the user + later, we need to start the b10-auth or + b10-resolver 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, b10-auth + has 10 to be started before the switch and everything else + is without priority, so it is started after the switch.

Chapter 4. Command channel

The BIND 10 components use the b10-msgq message routing daemon to communicate with other BIND 10 components. @@ -610,12 +610,12 @@ shutdown the details and relays (over a b10-msgq command channel) the configuration on to the specified module.

-

Chapter 8. Authoritative Server

Table of Contents

Server Configurations
Data Source Backends
Loading Master Zones Files

+

Chapter 8. Authoritative Server

Table of Contents

Server Configurations
Data Source Backends
Loading Master Zones Files

The b10-auth is the authoritative DNS server. It supports EDNS0 and DNSSEC. It supports IPv6. Normally it is started by the bind10 master process. -

Server Configurations

+

Server Configurations

b10-auth is configured via the b10-cfgmgr configuration manager. The module name is “Auth”. @@ -635,7 +635,7 @@ This may be a temporary setting until then.

shutdown
Stop the authoritative DNS server.

-

Data Source Backends

Note

+

Data Source Backends

Note

For the development prototype release, b10-auth supports a SQLite3 data source backend and in-memory data source backend. @@ -649,7 +649,7 @@ This may be a temporary setting until then. The default is /usr/local/var/.) This data file location may be changed by defining the “database_file” configuration. -

Loading Master Zones Files

+

Loading Master Zones Files

RFC 1035 style DNS master zone files may imported into a BIND 10 data source by using the b10-loadzone utility. @@ -678,7 +678,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. -

Chapter 9. Incoming Zone Transfers

Table of Contents

Configuration for Incoming Zone Transfers
Enabling IXFR
Trigger an Incoming Zone Transfer Manually

+

Chapter 9. Incoming Zone Transfers

Table of Contents

Configuration for Incoming Zone Transfers
Enabling IXFR
Secondary Manager
Trigger an Incoming Zone Transfer Manually

Incoming zones are transferred using the b10-xfrin process which is started by bind10. When received, the zone is stored in the corresponding BIND 10 @@ -696,15 +696,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. -

Configuration for Incoming Zone Transfers

- 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)). +

Configuration for Incoming Zone Transfers

+ 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)).

- 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 bindctl 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 bindctl prompt: 

> config add Xfrin/zones
 > config set Xfrin/zones[0]/name "example.com"
@@ -712,7 +712,7 @@ This may be a temporary setting until then.
 > config commit

(We assume there has been no zone configuration before). -

Enabling IXFR

+

Enabling IXFR

As noted above, b10-xfrin uses AXFR for zone transfers by default. To enable IXFR for zone transfers for a particular zone, set the use_ixfr @@ -734,12 +734,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. -

Trigger an Incoming Zone Transfer Manually

- To manually trigger a zone transfer to retrieve a remote zone, - you may use the bindctl utility. - For example, at the bindctl prompt run: +

Secondary Manager

+ The b10-zonemgr process is started by + bind10. + It keeps track of SOA refresh, retry, and expire timers + and other details for BIND 10 to perform as a slave. + When the b10-auth authoritative DNS server + receives a NOTIFY message, b10-zonemgr + may tell b10-xfrin to do a refresh + to start an inbound zone transfer. + The secondary manager resets its counters when a new zone is + transferred in. +

Note

+ Access control (such as allowing notifies) is not yet provided. + The primary/secondary service is not yet complete. +

+ The following example shows using bindctl + to configure the server to be a secondary for the example zone: + + 

> config add Zonemgr/secondary_zones
+> config set Zonemgr/secondary_zones[0]/name "example.com"
+> config set Zonemgr/secondary_zones[0]/class "IN"
+> config commit

+ - 

> Xfrin retransfer zone_name="foo.example.org" master=192.0.2.99

+ +

+ If the zone does not exist in the data source already + (i.e. no SOA record for it), b10-zonemgr + will automatically tell b10-xfrin + to transfer the zone in. +

Trigger an Incoming Zone Transfer Manually

+ To manually trigger a zone transfer to retrieve a remote zone, + you may use the bindctl utility. + For example, at the bindctl prompt run: + + 

> Xfrin retransfer zone_name="foo.example.org" master=192.0.2.99

Chapter 10. Outbound Zone Transfers

The b10-xfrout process is started by bind10. @@ -768,9 +798,9 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)

> config set Xfrout/zone_config[0]/transfer_acl [{"action": "ACCEPT", "from": "192.0.2.1"}, {"action": "ACCEPT", "from": "2001:db8::1"}] > config commit

Note

- In the above example the lines - for transfer_acl were divided for - readability. In the actual input it must be in a single line. + In the above example the lines + for transfer_acl were divided for + readability. In the actual input it must be in a single line.

If you want to require TSIG in access control, a separate TSIG "key ring" must be configured specifically @@ -787,25 +817,11 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)

This is necessary because the b10-auth server also checks TSIGs and it uses the system wide configuration.

Note

- In a future version, b10-xfrout will also - use the system wide TSIG configuration. - The way to specify zone specific configuration (ACLs, etc) is - likely to be changed, too. -

Chapter 11. Secondary Manager

- The b10-zonemgr process is started by - bind10. - It keeps track of SOA refresh, retry, and expire timers - and other details for BIND 10 to perform as a slave. - When the b10-auth authoritative DNS server - receives a NOTIFY message, b10-zonemgr - may tell b10-xfrin to do a refresh - to start an inbound zone transfer. - The secondary manager resets its counters when a new zone is - transferred in. -

Note

- Access control (such as allowing notifies) is not yet provided. - The primary/secondary service is not yet complete. -

Chapter 12. Recursive Name Server

Table of Contents

Access Control
Forwarding

+ In a future version, b10-xfrout will also + use the system wide TSIG configuration. + The way to specify zone specific configuration (ACLs, etc) is + likely to be changed, too. +

Chapter 11. Recursive Name Server

Table of Contents

Access Control
Forwarding

The b10-resolver process is started by bind10. @@ -844,31 +860,31 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)

(Replace the “2” as needed; run “config show - Resolver/listen_on” if needed.)

Access Control

+ Resolver/listen_on” if needed.)

Access Control

By default, the b10-resolver daemon only accepts DNS queries from the localhost (127.0.0.1 and ::1). The Resolver/query_acl 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.

- The configuration's action item may be - set to “ACCEPT” to allow the incoming query, - “REJECT” to respond with a DNS REFUSED return - code, or “DROP” to ignore the query without - any response (such as a blackhole). For more information, - see the respective debugging messages: RESOLVER_QUERY_ACCEPTED, - RESOLVER_QUERY_REJECTED, - and RESOLVER_QUERY_DROPPED. + The configuration's action item may be + set to “ACCEPT” to allow the incoming query, + “REJECT” to respond with a DNS REFUSED return + code, or “DROP” to ignore the query without + any response (such as a blackhole). For more information, + see the respective debugging messages: RESOLVER_QUERY_ACCEPTED, + RESOLVER_QUERY_REJECTED, + and RESOLVER_QUERY_DROPPED.

- The required configuration's from item is set + The required configuration's from item is set to an IPv4 or IPv6 address, addresses with an network mask, or to - the special lowercase keywords “any6” (for - any IPv6 address) or “any4” (for any IPv4 - address). + the special lowercase keywords “any6” (for + any IPv6 address) or “any4” (for any IPv4 + address).

- For example to allow the 192.168.1.0/24 - network to use your recursive name server, at the - bindctl prompt run: + For example to allow the 192.168.1.0/24 + network to use your recursive name server, at the + bindctl prompt run: 

 > config add Resolver/query_acl
 > config set Resolver/query_acl[2]/action "ACCEPT"
@@ -877,7 +893,7 @@ Xfrout/transfer_acl[0]	{"action": "ACCEPT"}	any	(default)

(Replace the “2” as needed; run “config show Resolver/query_acl” if needed.)

Note

This prototype access control configuration - syntax may be changed.

Forwarding

+ syntax may be changed.

Forwarding

To enable forwarding, the upstream address and port must be configured to forward queries to, such as: @@ -897,7 +913,132 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)

> config set Resolver/forward_addresses [] > config commit

-

Chapter 13. Statistics

+

Chapter 12. DHCPv4 Server

Table of Contents

Server Usage
Server Configuration
DHCPv4 Server Limitations

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.

Note

+ 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 the section called “DHCPv4 Server Limitations” and the section called “DHCPv6 Server Limitations” for + detailed description. +

Server Usage

BIND10 provides experimental DHCPv4 server component since + December 2011. It is currently described as skeleton server and + can be described as an early prototype that is not yet fully + functional. It is mature enough to conduct first tests in lab + environment, but it has significant limitations. See the section called “DHCPv4 Server Limitations” for details. +

+ DHCPv4 server is implemented as b10-dhcp4 + daemon. As it is configurable yet, it is fully autonomous, + i.e. it does not interact with b10-cfgmgr. + To start DHCPv4 server, simply input: + + 

+#cd src/bin/dhcp4
+#./b10-dhcp4
+

+ + Depending on your installation, b10-dhcp4 + 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. + + Afre 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. +

Server Configuration

+ 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. +

+ 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: + 

+const std::string HARDCODED_LEASE = "10.3.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 = "10.3.2.2";
+const std::string HARDCODED_DNS_SERVER = "8.8.8.8";
+const std::string HARDCODED_DOMAIN_NAME = "isc.example.org";
+const std::string HARDCODED_SERVER_ID = "10.3.1.1";

+ + Lease database and configuration support is planned for 2012. +

DHCPv4 Server Limitations

+ This are the current limitations of DHCPv4 server + software. Most of them are reflection of the early stage of + development. +

  • During initial IPv4 node configuration, where server has to + send packet 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.
  • It 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.
  • Server 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 the section called “Server Configuration” for details.
  • 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 + b10-dhcp4 happens to listen on wrong + interface, the easiest way to is to down other + interfaces. This limitation will be fixed shortly.
  • PRL (Parameter Request List) is currently ignored + and server assigns DNS SERVER and DOMAIN NAME + options.
  • b10-dhcp4 does not support + BOOTP. That is a design choice. This limitation is + permanent. If have legacy nodes that can't use DHCP and + require BOOTP support, please use latest version of ISC DHCP + http://www.isc.org/software/dhcp.
  • Interface detection is currently working on Linux + only. See the section called “Interface detection” for details.

Chapter 13. DHCPv6 Server

Table of Contents

DHCPv6 Server Limitations

DHCPv6 Server Limitations

+ Relayed traffic is not supported. +

Chapter 14. libdhcp++ library

Table of Contents

Interface detection

libdhcp++ is a common library written in C++ that is + 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. +

+ While this library is currently used by + b10-dhcp6 and b10-dhcp4 + only, it is designed to be portable, universal library useful + for any kind of DHCP-related software. +

Interface detection

Both DHCPv4 and DHCPv6 components share network + interface detection routines. Interface detection is + currently only supported on Linux systems.

For non-linux systems, there is currently stub + implementation provided. As DHCP servers need to know + available addresses, there was 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: + 

+# 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

+

Chapter 15. Statistics

The b10-stats process is started by bind10. It periodically collects statistics data from various modules @@ -931,52 +1072,52 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)

} }

-

Chapter 14. Logging

Table of Contents

Logging configuration
Loggers
Output Options
Example session
Logging Message Format

Logging configuration

+

Chapter 16. Logging

Table of Contents

Logging configuration
Loggers
Output Options
Example session
Logging Message Format

Logging configuration

- 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. -

Loggers

+

Loggers

- 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.

- 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..

- The three most important elements of a logger configuration - are the name (the component that is - generating the messages), the severity - (what to log), and the output_options - (where to log). - -

name (string)

- 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 “Resolver”. 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 name (the component that is + generating the messages), the severity + (what to log), and the output_options + (where to log). + +

name (string)

+ 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 “Resolver”. This + configuration will then be used by the loggers in the + Resolver module, and all the libraries used by it.

- If you want to specify logging for one specific library - within the module, you set the name to - module.library. For example, the - logger used by the nameserver address store component - has the full name of “Resolver.nsas”. 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 + module.library. For example, the + logger used by the nameserver address store component + has the full name of “Resolver.nsas”. If + there is no entry in Logging for a particular library, + it will use the configuration given for the module. @@ -984,163 +1125,163 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)

- 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 - “Resolver” and severity INFO, and one with - the name “Resolver.cache” with severity - DEBUG. As there are no entries for other libraries (e.g. - the nsas), they will use the configuration for the module - (“Resolver”), 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 + “Resolver” and severity INFO, and one with + the name “Resolver.cache” with severity + DEBUG. As there are no entries for other libraries (e.g. + the nsas), they will use the configuration for the module + (“Resolver”), so giving the desired behavior.

- One special case is that of a module name of “*” - (asterisks), which is interpreted as any - 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. “*.config” - specifies the configuration library code in whatever - module is using it). + One special case is that of a module name of “*” + (asterisks), which is interpreted as any + 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. “*.config” + specifies the configuration library code in whatever + module is using it).

- 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 “*” and “Resolver”, the - resolver module — and all libraries it uses — - will log messages according to the configuration in the - second entry (“Resolver”). All other modules - will use the configuration of the first entry - (“*”). If there was also a configuration - entry for “Resolver.cache”, the cache library - within the resolver would use that in preference to the - entry for “Resolver”. + 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 “*” and “Resolver”, the + resolver module — and all libraries it uses — + will log messages according to the configuration in the + second entry (“Resolver”). All other modules + will use the configuration of the first entry + (“*”). If there was also a configuration + entry for “Resolver.cache”, the cache library + within the resolver would use that in preference to the + entry for “Resolver”.

- One final note about the naming. When specifying the - module name within a logger, use the name of the module - as specified in bindctl, e.g. - “Resolver” for the resolver module, - “Xfrout” 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 - “Auth.cache” logger will appear in the output - with a logger name of “b10-auth.cache”). + One final note about the naming. When specifying the + module name within a logger, use the name of the module + as specified in bindctl, e.g. + “Resolver” for the resolver module, + “Xfrout” 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 + “Auth.cache” logger will appear in the output + with a logger name of “b10-auth.cache”). -

severity (string)

+

severity (string)

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):

  • FATAL
  • ERROR
  • WARN
  • INFO
  • DEBUG

- 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. -

output_options (list)

+

output_options (list)

- Each logger can have zero or more - output_options. These specify where log - messages are sent to. These are explained in detail below. + Each logger can have zero or more + output_options. These specify where log + messages are sent to. These are explained in detail below.

The other options for a logger are: -

debuglevel (integer)

+

debuglevel (integer)

- 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).

If severity for the logger is not DEBUG, this value is ignored. -

additive (true or false)

+

additive (true or false)

- If this is true, the output_options from - the parent will be used. For example, if there are two - loggers configured; “Resolver” and - “Resolver.cache”, and additive - is true in the second, it will write the log messages - not only to the destinations specified for - “Resolver.cache”, but also to the destinations - as specified in the output_options in - the logger named “Resolver”. + If this is true, the output_options from + the parent will be used. For example, if there are two + loggers configured; “Resolver” and + “Resolver.cache”, and additive + is true in the second, it will write the log messages + not only to the destinations specified for + “Resolver.cache”, but also to the destinations + as specified in the output_options in + the logger named “Resolver”. -

Output Options

+

Output Options

- The main settings for an output option are the - destination and a value called - output, the meaning of which depends on - the destination that is set. + The main settings for an output option are the + destination and a value called + output, the meaning of which depends on + the destination that is set. -

destination (string)

+

destination (string)

The destination is the type of output. It can be one of: -

  • console
  • file
  • syslog

output (string)

+

  • console
  • file
  • syslog

output (string)

- 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:

destination is “console”
- The value of output must be one of “stdout” - (messages printed to standard output) or - “stderr” (messages printed to standard - error). + The value of output must be one of “stdout” + (messages printed to standard output) or + “stderr” (messages printed to standard + error).
destination is “file”
- 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.
destination is “syslog”
- The value of output is interpreted as the - syslog facility (e.g. - local0) that should be used - for log messages. + The value of output is interpreted as the + syslog facility (e.g. + local0) that should be used + for log messages.

The other options for output_options are: -

flush (true of false)

- 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. -

maxsize (integer)

- 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", +

flush (true of false)

+ 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. +

maxsize (integer)

+ 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.)

If this is 0, no maximum file size is used. -

maxver (integer)

- Maximum number of old log files to keep around when - rolling the output file. Only relevant when - destination is “file”. -

Example session

- - In this example we want to set the global logging to - write to the file /var/log/my_bind10.log, - at severity WARN. We want the authoritative server to - log at DEBUG with debuglevel 40, to a different file - (/tmp/debug_messages). +

maxver (integer)

+ Maximum number of old log files to keep around when + rolling the output file. Only relevant when + destination is “file”. +

Example session

+ + In this example we want to set the global logging to + write to the file /var/log/my_bind10.log, + at severity WARN. We want the authoritative server to + log at DEBUG with debuglevel 40, to a different file + (/tmp/debug_messages).

@@ -1155,9 +1296,9 @@ Logging/loggers [] list

- 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.

@@ -1172,8 +1313,8 @@ Logging/loggers/ list (modified)

- 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:

@@ -1187,9 +1328,9 @@ Logging/loggers[0]/output_options [] list (default)

- 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.

@@ -1205,8 +1346,8 @@ Logging/loggers[0]/output_options [] list (default)

- 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.

@@ -1234,8 +1375,8 @@ Logging/loggers[0]/output_options[0]/maxver 0 integer (default)

- Which would make the entire configuration for this logger - look like: + Which would make the entire configuration for this logger + look like:

@@ -1253,8 +1394,8 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)

- 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.

@@ -1262,8 +1403,8 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)

- 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.

@@ -1279,10 +1420,10 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)

- 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.

@@ -1292,15 +1433,15 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)

- And every module will now be using the values from the - logger named “*”. + And every module will now be using the values from the + logger named “*”. -

Logging Message Format

- 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. +

Logging Message Format

+ 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.

Consider the message below logged to a file: 

2011-06-15 13:48:22.034 ERROR [b10-resolver.asiolink]
@@ -1325,20 +1466,20 @@ Logging/loggers[0]/output_options[0]/maxver	8	integer	(modified)
             (which in the example is the asynchronous I/O link
             module, asiolink).
           
ASIODNS_OPENSOCK

-	    The message identification.  Every message in BIND 10
-	    has a unique identification, which can be used as an
-	    index into the BIND 10 Messages
-	    Manual (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 BIND 10 Messages
+            Manual (http://bind10.isc.org/docs/bind10-messages.html) from which more information can be obtained.
           
error 111 opening TCP socket to 127.0.0.1(53)

-	      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.

diff --git a/doc/guide/bind10-guide.xml b/doc/guide/bind10-guide.xml index 6cea253024..c4f02680b9 100644 --- a/doc/guide/bind10-guide.xml +++ b/doc/guide/bind10-guide.xml @@ -1872,7 +1872,7 @@ then change those defaults with config set Resolver/forward_addresses[0]/address -
+
Server Configuration DHCPv4 server does not have lease database implemented yet @@ -1900,12 +1900,59 @@ const std::string HARDCODED_SERVER_ID = "10.3.1.1";
DHCPv4 Server Limitations - During initial IPv4 node configuration, where server has to + This are the current limitations of DHCPv4 server + software. Most of them are reflection of the early stage of + development. + + + + During initial IPv4 node configuration, where server has to send packet 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. - + DHCPv4 server supports relayed traffic only. + + + It 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. + + + Server 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 for details. + + + 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 + b10-dhcp4 happens to listen on wrong + interface, the easiest way to is to down other + interfaces. This limitation will be fixed shortly. + + + PRL (Parameter Request List) is currently ignored + and server assigns DNS SERVER and DOMAIN NAME + options. + + + b10-dhcp4 does not support + BOOTP. That is a design choice. This limitation is + permanent. If have legacy nodes that can't use DHCP and + require BOOTP support, please use latest version of ISC DHCP + . + + + Interface detection is currently working on Linux + only. See for details. + + +
@@ -1936,11 +1983,10 @@ const std::string HARDCODED_SERVER_ID = "10.3.1.1"; for any kind of DHCP-related software. -
+
Interface detection Both DHCPv4 and DHCPv6 components share network - interface detection routines (see for details). Interface detection is + interface detection routines. Interface detection is currently only supported on Linux systems. For non-linux systems, there is currently stub