update for 2.4.4
[ppp.git] / README
1 This is the README file for ppp-2.4, a package which implements the
2 Point-to-Point Protocol (PPP) to provide Internet connections over
3 serial lines.
4
5
6 Introduction.
7 *************
8
9 The Point-to-Point Protocol (PPP) provides a standard way to establish
10 a network connection over a serial link.  At present, this package
11 supports IP and the protocols layered above IP, such as TCP and UDP.
12 The Linux and Solaris ports of this package have optional support for
13 IPV6; the Linux port of this package also has support for IPX.
14
15 This software consists of two parts:
16
17 - Kernel code, which establishes a network interface and passes
18 packets between the serial port, the kernel networking code and the
19 PPP daemon (pppd).  This code is implemented using STREAMS modules on
20 Solaris, and as a line discipline under Linux.
21
22 - The PPP daemon (pppd), which negotiates with the peer to establish
23 the link and sets up the ppp network interface.  Pppd includes support
24 for authentication, so you can control which other systems may make a
25 PPP connection and what IP addresses they may use.
26
27 The platforms supported by this package are Linux and Solaris.  I have
28 code for NeXTStep, FreeBSD, SunOS 4.x, SVR4, Tru64 (Digital Unix), AIX
29 and Ultrix but no active maintainers for these platforms.  Code for
30 all of these except AIX is included in the ppp-2.3.11 release.
31
32
33 Installation.
34 *************
35
36 The file SETUP contains general information about setting up your
37 system for using PPP.  There is also a README file for each supported
38 system, which contains more specific details for installing PPP on
39 that system.  The supported systems, and the corresponding README
40 files, are:
41
42         Linux                           README.linux
43         Solaris                         README.sol2
44
45 In each case you start by running the ./configure script.  This works
46 out which operating system you are using and creates the appropriate
47 makefiles.  You then run `make' to compile the user-level code, and
48 (as root) `make install' to install the user-level programs pppd, chat
49 and pppstats.
50
51 N.B. Since 2.3.0, leaving the permitted IP addresses column of the
52 pap-secrets or chap-secrets file empty means that no addresses are
53 permitted.  You need to put a "*" in that column to allow the peer to
54 use any IP address.  (This only applies where the peer is
55 authenticating itself to you, of course.)
56
57
58 What's new in ppp-2.4.4.
59 ************************
60
61 * Pppd will now run /etc/ppp/ip-pre-up, if it exists, after creating
62   the ppp interface and configuring its IP addresses but before
63   bringing it up.  This can be used, for example, for adding firewall
64   rules for the interface.
65
66 * Lots of bugs fixed, particularly in the area of demand-dialled and
67   persistent connections.
68
69
70 What was new in ppp-2.4.3.
71 **************************
72
73 * The configure script now accepts --prefix and --sysconfdir options.
74   These default to /usr/local and /etc.  If you want pppd put in
75   /usr/sbin as before, use ./configure --prefix=/usr.
76
77 * Doing `make install' no longer puts example configuration files in
78   /etc/ppp.  Use `make install-etcppp' if you want that.
79
80 * The code has been updated to work with version 0.8.3 of libpcap.
81   Unfortunately the libpcap maintainers removed support for the
82   "inbound" and "outbound" keywords on PPP links, meaning that if you
83   link pppd with libpcap-0.8.3, you can't use those keywords in the
84   active-filter and pass-filter expressions.  The support has been
85   reinstated in the CVS version and should be in future libpcap
86   releases.  If you need the in/outbound keywords, use a later release
87   than 0.8.3, or get the CVS version from http://www.tcpdump.org.
88
89 * There is a new option, child-timeout, which sets the length of time
90   that pppd will wait for child processes (such as the command
91   specified with the pty option) to exit before exiting itself.  It
92   defaults to 5 seconds.  After the timeout, pppd will send a SIGTERM
93   to any remaining child processes and exit.  A value of 0 means no
94   timeout.
95
96 * Various bugs have been fixed, including some CBCP packet parsing
97   bugs that could lead to the peer being able to crash pppd if CBCP
98   support is enabled.
99
100 * Various fixes and enhancements to the radius and rp-pppoe plugins
101   have been added.
102
103 * There is a new winbind plugin, from Andrew Bartlet of the Samba
104   team, which provides the ability to authenticate the peer against an
105   NT domain controller using MS-CHAP or MS-CHAPV2.
106
107 * There is a new pppoatm plugin, by various authors, sent in by David
108   Woodhouse.
109
110 * The multilink code has been substantially reworked.  The first pppd
111   for a bundle still controls the ppp interface, but it doesn't exit
112   until all the links in the bundle have terminated.  If the first
113   pppd is signalled to exit, it signals all the other pppds
114   controlling links in the bundle.
115
116 * The TDB code has been updated to the latest version.  This should
117   eliminate the problem that some people have seen where the database
118   file (/var/run/pppd.tdb) keeps on growing.  Unfortunately, however,
119   the new code uses an incompatible database format.  For this reason,
120   pppd now uses /var/run/pppd2.tdb as the database filename.
121
122
123 What was new in ppp-2.4.2.
124 **************************
125
126 * The CHAP code has been rewritten.  Pppd now has support for MS-CHAP
127   V1 and V2 authentication, both as server and client.  The new CHAP
128   code is cleaner than the old code and avoids some copyright problems
129   that existed in the old code.
130
131 * MPPE (Microsoft Point-to-Point Encryption) support has been added,
132   although the current implementation shouldn't be considered
133   completely secure.  (There is no assurance that the current code
134   won't ever transmit an unencrypted packet.)
135
136 * James Carlson's implementation of the Extensible Authentication
137   Protocol (EAP) has been added.
138
139 * Support for the Encryption Control Protocol (ECP) has been added.
140
141 * Some new plug-ins have been included:
142   - A plug-in for kernel-mode PPPoE (PPP over Ethernet)
143   - A plug-in for supplying the PAP password over a pipe from another
144     process
145   - A plug-in for authenticating using a Radius server.
146
147 * Updates and bug-fixes for the Solaris port.
148
149 * The CBCP (Call Back Control Protocol) code has been updated.  There
150   are new options `remotenumber' and `allow-number'.
151
152 * Extra hooks for plugins to use have been added.
153
154 * There is now a `maxoctets' option, which causes pppd to terminate
155   the link once the number of bytes passed on the link exceeds a given
156   value.
157
158 * There are now options to control whether pppd can use the IPCP
159   IP-Address and IP-Addresses options: `ipcp-no-address' and
160   `ipcp-no-addresses'.
161
162 * Fixed several bugs, including potential buffer overflows in chat.
163
164
165 What was new in ppp-2.4.1.
166 **************************
167
168 * Pppd can now print out the set of options that are in effect.  The
169   new `dump' option causes pppd to print out the option values after
170   option parsing is complete.  The `dryrun' option causes pppd to
171   print the options and then exit.
172
173 * The option parsing code has been fixed so that options in the
174   per-tty options file are parsed correctly, and don't override values
175   from the command line in most cases.
176
177 * The plugin option now looks in /usr/lib/pppd/<pppd-version> (for
178   example, /usr/lib/pppd/2.4.1b1) for shared objects for plugins if
179   there is no slash in the plugin name.
180
181 * When loading a plugin, pppd will now check the version of pppd for
182   which the plugin was compiled, and refuse to load it if it is
183   different to pppd's version string.  To enable this, the plugin
184   source needs to #include "pppd.h" and have a line saying:
185         char pppd_version[] = VERSION;
186
187 * There is a bug in zlib, discovered by James Carlson, which can cause
188   kernel memory corruption if Deflate is used with the lowest setting,
189   8.  As a workaround pppd will now insist on using at least 9.
190
191 * Pppd should compile on Solaris and SunOS again.
192
193 * Pppd should now set the MTU correctly on demand-dialled interfaces.
194
195
196 What was new in ppp-2.4.0.
197 **************************
198
199 * Multilink: this package now allows you to combine multiple serial
200   links into one logical link or `bundle', for increased bandwidth and
201   reduced latency.  This is currently only supported under the
202   2.4.x and later Linux kernels.
203
204 * All the pppd processes running on a system now write information
205   into a common database.  I used the `tdb' code from samba for this.
206
207 * New hooks have been added.
208
209 For a list of the changes made during the 2.3 series releases of this
210 package, see the Changes-2.3 file.
211
212
213 Compression methods.
214 ********************
215
216 This package supports two packet compression methods: Deflate and
217 BSD-Compress.  Other compression methods which are in common use
218 include Predictor, LZS, and MPPC.  These methods are not supported for
219 two reasons - they are patent-encumbered, and they cause some packets
220 to expand slightly, which pppd doesn't currently allow for.
221 BSD-Compress and Deflate (which uses the same algorithm as gzip) don't
222 ever expand packets.
223
224
225 Patents.
226 ********
227
228 The BSD-Compress algorithm used for packet compression is the same as
229 that used in the Unix "compress" command.  It was apparently covered
230 by U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by
231 Unisys), and corresponding patents in various other countries (but not
232 Australia).  Apparently the Unisys patent expired in the US on 20 June
233 2003, but the IBM patent is still pending.
234
235 If these patents are of concern in your situation, you can build the
236 package without including BSD-Compress.  To do this, edit
237 net/ppp-comp.h to change the definition of DO_BSD_COMPRESS to 0.  The
238 bsd-comp.c files are then no longer needed, so the references to
239 bsd-comp.o may optionally be removed from the Makefiles.
240
241
242 Contacts.
243 *********
244
245 The comp.protocols.ppp newsgroup is a useful place to get help if you
246 have trouble getting your ppp connections to work.  Please do not send
247 me questions of the form "please help me get connected to my ISP" -
248 I'm sorry, but I simply do not have the time to answer all the
249 questions like this that I get.
250
251 If you find bugs in this package, please report them to the maintainer
252 for the port for the operating system you are using:
253
254 Linux                   Paul Mackerras <paulus@samba.org>
255 Solaris                 James Carlson <carlson@workingcode.com>
256
257
258 Copyrights:
259 ***********
260
261 All of the code can be freely used and redistributed.  The individual
262 source files each have their own copyright and permission notice.
263 Pppd, pppstats and pppdump are under BSD-style notices.  Some of the
264 pppd plugins are GPL'd.  Chat is public domain.
265
266
267 Distribution:
268 *************
269
270 The primary site for releases of this software is:
271
272         ftp://ftp.samba.org/pub/ppp/
273
274
275 ($Id: README,v 1.36 2005/08/26 12:56:53 paulus Exp $)