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