README 21.1 KB
Newer Older
Evan Hunt's avatar
Evan Hunt committed
1
	      Internet Systems Consortium DHCP Distribution
2 3
			     Version 4.4.2b1
			    12 December 2019
4

5
			      README FILE
6 7 8 9 10 11 12 13 14

You should read this file carefully before trying to install or use
the ISC DHCP Distribution.

			  TABLE OF CONTENTS

	1	WHERE TO FIND DOCUMENTATION
	2	RELEASE STATUS
	3	BUILDING THE DHCP DISTRIBUTION
15 16 17
	 3.1	 UNPACKING IT
	 3.2	 CONFIGURING IT
	  3.2.1	  DYNAMIC DNS UPDATES
18
	  3.2.2   LOCALLY DEFINED OPTIONS
19
	 3.3	 BUILDING IT
20 21
	4	INSTALLING THE DHCP DISTRIBUTION
	5	USING THE DHCP DISTRIBUTION
22 23 24 25 26 27 28 29
	 5.1	  FIREWALL RULES
	 5.2	 LINUX
	  5.2.1	  IF_TR.H NOT FOUND
	  5.2.2	  SO_ATTACH_FILTER UNDECLARED
	  5.2.3	  PROTOCOL NOT CONFIGURED
	  5.2.4	  BROADCAST
	  5.2.6	  IP BOOTP AGENT
	  5.2.7	  MULTIPLE INTERFACES
30
     5.3    ATF
31
	6	SUPPORT
32
	 6.1	 HOW TO REPORT BUGS
33
	7	HISTORY
34 35

		      WHERE TO FIND DOCUMENTATION
Ted Lemon's avatar
Ted Lemon committed
36 37 38

Documentation for this software includes this README file, the
RELNOTES file, and the manual pages, which are in the server, common,
39 40 41 42
client and relay subdirectories.  The README file (this file) includes
late-breaking operational and system-specific information that you
should read even if you don't want to read the manual pages, and that
you should *certainly* read if you run into trouble.  Internet
Tomek Mrugalski's avatar
Tomek Mrugalski committed
43 44
standards relating to the DHCP protocol are listed in the References
document that is available in html, txt and xml formats in doc/
45 46 47
subdirectory.  You will have the best luck reading the manual pages if
you build this software and then install it, although you can read
them directly out of the distribution if you need to.
Ted Lemon's avatar
Ted Lemon committed
48 49 50 51 52

DHCP server documentation is in the dhcpd man page.  Information about
the DHCP server lease database is in the dhcpd.leases man page.
Server configuration documentation is in the dhcpd.conf man page as
well as the dhcp-options man page.   A sample DHCP server
Shawn Routhier's avatar
Shawn Routhier committed
53 54
configuration is in the file server/dhcpd.conf.example.   The source for
the dhcpd, dhcpd.leases and dhcpd.conf man pages is in the server/ sub-
55 56
directory in the distribution.   The source for the dhcp-options.5
man page is in the common/ subdirectory.
Ted Lemon's avatar
Ted Lemon committed
57 58 59 60 61 62

DHCP Client documentation is in the dhclient man page.  DHCP client
configuration documentation is in the dhclient.conf man page and the
dhcp-options man page.  The DHCP client configuration script is
documented in the dhclient-script man page.   The format of the DHCP
client lease database is documented in the dhclient.leases man page.
63 64 65
The source for all these man pages is in the client/ subdirectory in
the distribution.   In addition, the dhcp-options man page should be
referred to for information about DHCP options.
Ted Lemon's avatar
Ted Lemon committed
66

67 68
DHCP relay agent documentation is in the dhcrelay man page, the source
for which is distributed in the relay/ subdirectory.
Ted Lemon's avatar
Ted Lemon committed
69

70 71 72
KEA Migration Assistant documentation, including how to build, install
and use it, is including in the keama directory.

Ted Lemon's avatar
Ted Lemon committed
73
To read installed manual pages, use the man command.  Type "man page"
74 75 76
where page is the name of the manual page.   This will only work if
you have installed the ISC DHCP distribution using the ``make install''
command (described later).
Ted Lemon's avatar
Ted Lemon committed
77 78 79 80 81 82

If you want to read manual pages that aren't installed, you can type
``nroff -man page |more'' where page is the filename of the
unformatted manual page.  The filename of an unformatted manual page
is the name of the manual page, followed by '.', followed by some
number - 5 for documentation about files, and 8 for documentation
83 84 85 86
about programs.   For example, to read the dhcp-options man page,
you would type ``nroff -man common/dhcp-options.5 |more'', assuming
your current working directory is the top level directory of the ISC
DHCP Distribution.
Ted Lemon's avatar
Ted Lemon committed
87

88 89 90 91
Please note that the pathnames of files to which our manpages refer
will not be correct for your operating system until after you iterate
'make install' (so if you're reading a manpage out of the source
directory, it may not have up-to-date information).
Ted Lemon's avatar
Ted Lemon committed
92

93 94
		    BUILDING THE DHCP DISTRIBUTION

95 96
			     UNPACKING IT

97 98 99
To build the DHCP Distribution, unpack the compressed tar file using
the tar utility and the gzip command - type something like:

100 101
	gunzip dhcp-4.4.2b1.tar.gz
	tar xvf dhcp-4.4.2b1.tar
102

103 104
			    CONFIGURING IT

105
Now, cd to the dhcp-4.4.2b1 subdirectory that you've just created and
David Hankins's avatar
David Hankins committed
106
configure the source tree by typing:
107

108
	./configure
109 110 111 112 113 114 115

If the configure utility can figure out what sort of system you're
running on, it will create a custom Makefile for you for that
system; otherwise, it will complain.  If it can't figure out what
system you are using, that system is not supported - you are on
your own.

Shawn Routhier's avatar
Shawn Routhier committed
116 117 118 119 120
Several options may be enabled or disabled via the configure command.
You can get a list of these by typing:

	./configure --help

Francis Dupont's avatar
Francis Dupont committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
If you want to use dynamic shared libraries automake, autoconf
(aka GNU autotools) and libtool must be available. The DHCP
distribution provides 3 configure.ac* files: the -lt version
has no libtool support and was copied to the configure.ac
standard file in the distribution. To enable libtool support
you should perform these steps:

	cp configure.ac+lt configure.ac
	autoreconf -i

after you can use the regenerated configure as usual
(with libtool support (--enable-libtool) on by default):

	./configure

For compatibility (and people who don't read this documentation)
the --enable-libtool configuration file is supported even by
the distributed configure (and off by default). The previous
steps are performed and the regenerated configure called with
almost the same parameters (this "almost" makes the use of
this feature not recommended).

143 144 145 146 147
Note you can't go back from with libtool support to without libtool
support by restoring configure.ac and rerun autoreconf. If you
want or need to restore the without libtool support state the
required way is to simply restore the whole distribution.

148 149
			 DYNAMIC DNS UPDATES

150
A fully-featured implementation of dynamic DNS updates is included in
151
this release.  It uses libraries from BIND and, to avoid issues with
Shawn Routhier's avatar
Shawn Routhier committed
152 153 154 155 156
different versions, includes the necessary BIND version.  The appropriate
BIND libraries will be compiled and installed in the bind subdirectory
as part of the make step.  In order to build the necessary libraries you
will need to have "gmake" available on your build system.

157

Ted Lemon's avatar
Ted Lemon committed
158 159 160
There is documentation for the DDNS support in the dhcpd.conf manual
page - see the beginning of this document for information on finding
manual pages.
161

162 163 164 165 166 167 168 169 170 171
		       LOCALLY DEFINED OPTIONS

In previous versions of the DHCP server there was a mechanism whereby
options that were not known by the server could be configured using
a name made up of the option code number and an identifier:
"option-nnn"   This is no longer supported, because it is not future-
proof.   Instead, if you want to use an option that the server doesn't
know about, you must explicitly define it using the method described
in the dhcp-options man page under the DEFINING NEW OPTIONS heading.

172 173
			     BUILDING IT

174 175 176 177 178 179 180 181 182
Once you've run configure, just type ``make'', and after a while
you should have a dhcp server.  If you get compile errors on one
of the supported systems mentioned earlier, please let us know.
If you get warnings, it's not likely to be a problem - the DHCP
server compiles completely warning-free on as many architectures
as we can manage, but there are a few for which this is difficult.
If you get errors on a system not mentioned above, you will need
to do some programming or debugging on your own to get the DHCP
Distribution working.
183

184 185 186 187
If you cross compile you have to follow the instructions from
the BIND README, in particular you must set the BUILD_CC
environment variable.

188 189
		   INSTALLING THE DHCP DISTRIBUTION

190 191 192 193
Once you have successfully gotten the DHCP Distribution to build, you
can install it by typing ``make install''.   If you already have an old
version of the DHCP Distribution installed, you may want to save it
before typing ``make install''.
Ted Lemon's avatar
Ted Lemon committed
194

195 196
		     USING THE DHCP DISTRIBUTION

197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
			    FIREWALL RULES

If you are running the DHCP server or client on a computer that's also
acting as a firewall, you must be sure to allow DHCP packets through
the firewall.  In particular, your firewall rules _must_ allow packets
from IP address 0.0.0.0 to IP address 255.255.255.255 from UDP port 68
to UDP port 67 through.  They must also allow packets from your local
firewall's IP address and UDP port 67 through to any address your DHCP
server might serve on UDP port 68.  Finally, packets from relay agents
on port 67 to the DHCP server on port 67, and vice versa, must be
permitted.

We have noticed that on some systems where we are using a packet
filter, if you set up a firewall that blocks UDP port 67 and 68
entirely, packets sent through the packet filter will not be blocked.
However, unicast packets will be blocked.   This can result in strange
behaviour, particularly on DHCP clients, where the initial packet
exchange is broadcast, but renewals are unicast - the client will
appear to be unable to renew until it starts broadcasting its
renewals, and then suddenly it'll work.   The fix is to fix the
firewall rules as described above.

			   PARTIAL SERVERS

If you have a server that is connected to two networks, and you only
want to provide DHCP service on one of those networks (e.g., you are
using a cable modem and have set up a NAT router), if you don't write
any subnet declaration for the network you aren't supporting, the DHCP
server will ignore input on that network interface if it can.  If it
can't, it will refuse to run - some operating systems do not have the
capability of supporting DHCP on machines with more than one
interface, and ironically this is the case even if you don't want to
provide DHCP service on one of those interfaces.

231 232
				LINUX

233 234
There are three big LINUX issues: the all-ones broadcast address,
Linux 2.1 ip_bootp_agent enabling, and operations with more than one
Ted Lemon's avatar
Ted Lemon committed
235 236 237 238 239 240
network interface.   There are also two potential compilation/runtime
problems for Linux 2.1/2.2: the "SO_ATTACH_FILTER undeclared" problem
and the "protocol not configured" problem.

		    LINUX: PROTOCOL NOT CONFIGURED

241
If you get the following message, it's because your kernel doesn't
242
have the Linux packetfilter or raw packet socket configured:
Ted Lemon's avatar
Ted Lemon committed
243

244 245 246 247
 Make sure CONFIG_PACKET (Packet socket) and CONFIG_FILTER (Socket
 Filtering) are enabled in your kernel configuration

If this happens, you need to configure your Linux kernel to support
248 249 250
Socket Filtering and the Packet socket, or to select a kernel provided
by your Linux distribution that has these enabled (virtually all modern
ones do by default).
Ted Lemon's avatar
Ted Lemon committed
251

Ted Lemon's avatar
Ted Lemon committed
252
			   LINUX: BROADCAST
Ted Lemon's avatar
Ted Lemon committed
253

254 255 256 257 258
If you are running a recent version of Linux, this won't be a problem,
but on older versions of Linux (kernel versions prior to 2.2), there
is a potential problem with the broadcast address being sent
incorrectly.

259 260
In order for dhcpd to work correctly with picky DHCP clients (e.g.,
Windows 95), it must be able to send packets with an IP destination
261 262
address of 255.255.255.255.  Unfortunately, Linux changes an IP
destination of 255.255.255.255 into the local subnet broadcast address
263 264 265 266 267 268 269 270
(here, that's 192.5.5.223).

This isn't generally a problem on Linux 2.2 and later kernels, since
we completely bypass the Linux IP stack, but on old versions of Linux
2.1 and all versions of Linux prior to 2.1, it is a problem - pickier
DHCP clients connected to the same network as the ISC DHCP server or
ISC relay agent will not see messages from the DHCP server.   It *is*
possible to run into trouble with this on Linux 2.2 and later if you
Shawn Routhier's avatar
Shawn Routhier committed
271
are running a version of the DHCP server that was compiled on a Linux
272
2.0 system, though.
Ted Lemon's avatar
Ted Lemon committed
273

274 275 276 277
It is possible to work around this problem on some versions of Linux
by creating a host route from your network interface address to
255.255.255.255.   The command you need to use to do this on Linux
varies from version to version.   The easiest version is:
Ted Lemon's avatar
Ted Lemon committed
278

279
	route add -host 255.255.255.255 dev eth0
Ted Lemon's avatar
Ted Lemon committed
280

281 282 283
On some older Linux systems, you will get an error if you try to do
this.   On those systems, try adding the following entry to your
/etc/hosts file:
Ted Lemon's avatar
Ted Lemon committed
284

285
255.255.255.255	all-ones
Ted Lemon's avatar
Ted Lemon committed
286

287
Then, try:
Ted Lemon's avatar
Ted Lemon committed
288

289
	route add -host all-ones dev eth0
Ted Lemon's avatar
Ted Lemon committed
290

291
Another route that has worked for some users is:
Ted Lemon's avatar
Ted Lemon committed
292

293
	route add -net 255.255.255.0 dev eth0
Ted Lemon's avatar
Ted Lemon committed
294

295 296
If you are not using eth0 as your network interface, you should
specify the network interface you *are* using in your route command.
Ted Lemon's avatar
Ted Lemon committed
297

Ted Lemon's avatar
Ted Lemon committed
298
			LINUX: IP BOOTP AGENT
299 300 301 302 303 304 305

Some versions of the Linux 2.1 kernel apparently prevent dhcpd from
working unless you enable it by doing the following:

	      echo 1 >/proc/sys/net/ipv4/ip_bootp_agent


Ted Lemon's avatar
Ted Lemon committed
306
		      LINUX: MULTIPLE INTERFACES
Ted Lemon's avatar
Ted Lemon committed
307

308 309 310 311 312 313
Very old versions of the Linux kernel do not provide a networking API
that allows dhcpd to operate correctly if the system has more than one
broadcast network interface.  However, Linux 2.0 kernels with version
numbers greater than or equal to 2.0.31 add an API feature: the
SO_BINDTODEVICE socket option.  If SO_BINDTODEVICE is present, it is
possible for dhcpd to operate on Linux with more than one network
Ted Lemon's avatar
Ted Lemon committed
314
interface.  In order to take advantage of this, you must be running a
Ted Lemon's avatar
Ted Lemon committed
315 316
2.0.31 or greater kernel, and you must have 2.0.31 or later system
headers installed *before* you build the DHCP Distribution.
Ted Lemon's avatar
Ted Lemon committed
317

Ted Lemon's avatar
Ted Lemon committed
318 319 320 321 322
We have heard reports that you must still add routes to 255.255.255.255
in order for the all-ones broadcast to work, even on 2.0.31 kernels.
In fact, you now need to add a route for each interface.   Hopefully
the Linux kernel gurus will get this straight eventually.

323 324 325 326
Linux 2.1 and later kernels do not use SO_BINDTODEVICE or require the
broadcast address hack, but do support multiple interfaces, using the
Linux Packet Filter.

Paul Selkirk's avatar
Paul Selkirk committed
327 328
			     LINUX: OpenWrt

Paul Selkirk's avatar
Paul Selkirk committed
329 330 331 332 333
DHCP 4.1 has been tested on OpenWrt 7.09 and 8.09.  In keeping with
standard practice, client/scripts now includes a dhclient-script file
for OpenWrt.  However, this is not sufficient by itself to run dhcp on
OpenWrt; a full OpenWrt package for DHCP is available at
ftp://ftp.isc.org/isc/dhcp/dhcp-4.1.0-openwrt.tar.gz
Paul Selkirk's avatar
Paul Selkirk committed
334

335 336 337 338 339 340 341 342 343 344 345 346
		    LINUX: 802.1q VLAN INTERFACES

If you're using 802.1q vlan interfaces on Linux, it is necessary to
vconfig the subinterface(s) to rewrite the 802.1q information out of
packets received by the dhcpd daemon via LPF:

	vconfig set_flag eth1.523 1 1

Note that this may affect the performance of your system, since the
Linux kernel must rewrite packets received via this interface.  For
more information, consult the vconfig man pages.

347 348 349 350 351 352 353 354 355 356 357 358

			       ATF

Please see the file DHCP/doc/devel/atf.dox for a description of building
and using these tools.  

The optional unit tests use ATF (Automated Testing Framework) including
the atf-run and atf-report tools. ATF deprecated these tools in
version 0.19 and removed these tools from its sources in version 0.20,
requiring you to get an older version, use Kyua with an ATF compatibility
package or use the version included in the Bind sources.

Ted Lemon's avatar
Ted Lemon committed
359 360
			       SUPPORT

361 362
The Internet Systems Consortium DHCP server is developed and distributed
by ISC in the public trust, thanks to the generous donations of its
363
sponsors.  ISC now also offers commercial quality support contracts for
364 365 366
ISC DHCP, more information about ISC Support Contracts can be found at
the following URL:

367
	https://www.isc.org/support/
368

369 370 371 372 373
Please understand that we may not respond to support inquiries unless
you have a support contract.  ISC will continue its practice of always
responding to critical items that effect the entire community, and
responding to all other requests for support upon ISC's mailing lists
on a best-effort basis.
374 375

However, ISC DHCP has attracted a fairly sizable following on the
Shane Kerr's avatar
Shane Kerr committed
376
Internet, which means that there are a lot of knowledgeable users who
377 378 379
may be able to help you if you get stuck.  These people generally
read the dhcp-users@isc.org mailing list.  Be sure to provide as much
detail in your query as possible.
380

381 382
If you are going to use ISC DHCP, you should probably subscribe to
the dhcp-users or dhcp-announce mailing lists.
383

384 385 386
WHERE TO SEND FEATURE REQUESTS: We like to hear your feedback.  We may
not respond to it all the time, but we do read it.  If ISC DHCP doesn't
work well for you, or you have an idea that would improve it for your
387 388
use, please create an issue at https://gitlab.isc.org/isc-projects/dhcp/issues.  
This is also an excellent place to send patches that add new features.
389

390 391 392 393
WHERE TO REPORT BUGS: If you want the act of sending in a bug report
to result in you getting help in the form of a fixed piece of
software, you are asking for help.  Your bug report is helpful to us,
but fundamentally you are making a support request, so please use the
Ted Lemon's avatar
Ted Lemon committed
394 395
addresses described in the previous paragraphs.  If you are _sure_ that
your problem is a bug, and not user error, or if your bug report
396 397 398
includes a patch, you can submit it to our ticketing system at 
https://gitlab.isc.org/isc-projects/dhcp/issues.  If you have not received 
a notice that the ticket has been resolved, then we're still working on it.
399

400 401
PLEASE DO NOT REPORT BUGS IN OLD SOFTWARE RELEASES!  Fetch the latest
release and see if the bug is still in that version of the software,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
402 403 404 405
and if it is still present, _then_ report it.  ISC release versions 
always have three numbers, for example: 1.2.3.  The 'major release' is 
1 here, the 'minor release' is 2, and the 'maintenance release' is 3.  
ISC will accept bug reports against the most recent two major.minor
406 407 408 409 410 411 412 413 414 415
releases: for example, 1.0.0 and 0.9.0, but not 0.8.* or prior.

PLEASE take a moment to determine where the ISC DHCP distribution
that you're using came from.  ISC DHCP is sometimes heavily modified
by integrators in various operating systems - it's not that we
feel that our software is perfect and incapable of having bugs, but
rather that it is very frustrating to find out after many days trying
to help someone that the sources you're looking at aren't what they're
running.  When in doubt, please retrieve the source distribution from
ISC's web page and install it.
416

417
		HOW TO REPORT BUGS OR REQUEST HELP
418

419 420 421
When you report bugs or ask for help, please provide us complete
information.  A list of information we need follows.  Please read it
carefully, and put all the information you can into your initial bug
422 423
report.  This will save us a great deal of time and more informative
bug reports are more likely to get handled more quickly overall.
424

Ted Lemon's avatar
Ted Lemon committed
425
      1.  The specific operating system name and version of the
426
	  machine on which the DHCP server or client is running.
Ted Lemon's avatar
Ted Lemon committed
427
      2.  The specific operating system name and version of the
428 429
	  machine on which the client is running, if you are having
	  trouble getting a client working with the server.
Ted Lemon's avatar
Ted Lemon committed
430
      3.  If you're running Linux, the version number we care about is
431 432 433 434 435 436 437 438
	  the kernel version and maybe the library version, not the
	  distribution version - e.g., while we don't mind knowing
	  that you're running Redhat version mumble.foo, we must know
	  what kernel version you're running, and it helps if you can
	  tell us what version of the C library you're running,
	  although if you don't know that off the top of your head it
	  may be hard for you to figure it out, so don't go crazy
	  trying.
Ted Lemon's avatar
Ted Lemon committed
439
      4.  The specific version of the DHCP distribution you're
440
	  running, as reported by dhcpd -t.
Ted Lemon's avatar
Ted Lemon committed
441
      5.  Please explain the problem carefully, thinking through what
442 443
	  you're saying to ensure that you don't assume we know
	  something about your situation that we don't know.
444 445
      6.  Include your dhcpd.conf and dhcpd.leases file as MIME attachments
	  if they're not over 100 kilobytes in size each.  If they are
446
	  this large, please make them available to us, e.g., via a hidden
447 448 449
	  http:// URL or FTP site.  If you're not comfortable releasing
	  this information due to sensitive contents, you may encrypt
	  the file to our release signing key, available on our website.
Ted Lemon's avatar
Ted Lemon committed
450
      7.  Include a log of your server or client running until it
451 452 453 454 455 456 457
	  encounters the problem - for example, if you are having
	  trouble getting some client to get an address, restart the
	  server with the -d flag and then restart the client, and
	  send us what the server prints.   Likewise, with the client,
	  include the output of the client as it fails to get an
	  address or otherwise does the wrong thing.   Do not leave
	  out parts of the output that you think aren't interesting.
Ted Lemon's avatar
Ted Lemon committed
458
      8.  If the client or server is dumping core, please run the
459 460 461
	  debugger and get a stack trace, and include that in your
	  bug report.   For example, if your debugger is gdb, do the
	  following:
462 463 464 465 466 467 468 469

		gdb dhcpd dhcpd.core
		(gdb) where
		      [...]
		(gdb) quit

	  This assumes that it's the dhcp server you're debugging, and
	  that the core file is in dhcpd.core.
Ted Lemon's avatar
Ted Lemon committed
470

471
Please see https://www.isc.org/dhcp/ for details on how to subscribe
472
to the ISC DHCP mailing lists.
473

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
			       HISTORY

ISC DHCP was originally written by Ted Lemon under a contract with
Vixie Labs with the goal of being a complete reference implementation
of the DHCP protocol.  Funding for this project was provided by
Internet Systems Consortium. The first release of the ISC DHCP
distribution in December 1997 included just the DHCP server.
Release 2 in June 1999 added a DHCP client and a BOOTP/DHCP relay
agent. DHCP 3 was released in October 2001 and included DHCP failover
support, OMAPI, Dynamic DNS, conditional behaviour, client classing,
and more. Version 3 of the DHCP server was funded by Nominum, Inc.
The 4.0 release in December 2007 introduced DHCPv6 protocol support
for the server and client.

This product includes cryptographic software written
by Eric Young (eay@cryptsoft.com).