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
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.
14 This PPP implementation consists of two parts:
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.
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.
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.
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
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
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
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.)
64 What's new in ppp-2.5.0.
65 ************************
67 The 2.5.0 release is a major release of pppd which contains breaking
68 changes for third-party plugins, a complete revamp of the build-system
69 and that allows for flexibility of configuring features as needed.
72 * Support for PEAP authentication by Eivind Næss and Rustam Kovhaev
73 * Support for loading PKCS12 certificate envelopes
74 * Adoption of GNU Autoconf / Automake build environment, by Eivind Næss
76 * Support for pkgconfig tool has been added by Eivind Næss.
77 * Bunch of fixes and cleanup to PPPoE and IPv6 support by Pali Rohár.
78 * Major revision to PPPD's Plugin API by Eivind Næss.
79 - Defines in which describes what features was included in pppd
80 - Function now prefixed with explicit ppp_* to indicate it's a
81 pppd functions being called.
82 - Header files was renamed to better align with their features
83 and use of proper include guards
84 - A pppdconf.h files is supplied to allow third-party use the same
85 feature defines pppd was compiled with.
86 - No extern declarations of internal variable names of pppd,
87 continued use of these extern variables are considered
89 * Lots of internal fixes and cleanups for Radius and PPPoE by Jaco Kroon
90 * Dropped IPX support, as Linux 5.15 already have dropped support
92 * Many more fixes and cleanups.
95 What's new in ppp-2.4.9.
96 ************************
98 * Support for new EAP (Extensible Authentication Protocol) methods:
99 - Support for EAP-TLS, from Jan Just Keijser and others
100 - Support for EAP-MSCHAPv2, from Eivind Næss, Thomas Omerzu, Tijs
101 Van Buggenhout and others
105 - chapms-strip-domain
106 - replacedefaultroute
107 - noreplacedefaultroute
108 - ipv6cp-accept-remote
121 * Fixes for CVE-2020-8597 and CVE-2015-3310.
123 * libpcap is now required when compiling on Linux (previously, if
124 libpcap was not present, pppd would be compiled without packet
127 * The rp-pppoe plugin has been renamed to pppoe, to distinguish it
128 from the upstream rp-pppoe code. Its options have changed names,
129 but the old names are kept as aliases.
131 * The configure script now supports cross-compilation.
133 * Many bug fixes and cleanups.
136 What was new in ppp-2.4.8.
137 **************************
139 * New pppd options have been added:
140 - ifname, to set the name for the PPP interface device
141 - defaultroute-metric, to set the metric for the default route
142 - defaultroute6, to add an IPv6 default route (with nodefaultroute6
143 to prevent adding an IPv6 default route)
144 - up_sdnotify, to have pppd notify systemd when the link is up.
146 * The rp-pppoe plugin has new options:
147 - host-uniq, to set the Host-Uniq value to send
148 - pppoe-padi-timeout, to set the timeout for discovery packets
149 - pppoe-padi-attempts, to set the number of discovery attempts.
151 * Added the CLASS attribute in radius packets.
155 * Fixed warnings and issues found by static analysis.
157 * Added Submitting-patches.md.
160 What was new in ppp-2.4.7.
161 **************************
163 * Fixed a potential security issue in parsing option files (CVE-2014-3158).
165 * There is a new "stop-bits" option, which takes an argument of 1 or 2,
166 indicating the number of stop bits to use for async serial ports.
171 What was new in ppp-2.4.6.
172 **************************
178 * Options files can now set and unset environment variables for
181 * The timeout for chat scripts can now be taken from an environment
184 * There is a new option, master_detach, which allows pppd to detach
185 from the controlling terminal when it is the multilink bundle master
186 but its own link has terminated, even if the nodetach option has
190 What was new in ppp-2.4.5.
191 **************************
193 * Under Linux, pppd can now operate in a mode where it doesn't request
194 the peer's IP address, as some peers refuse to supply an IP address.
195 Since Linux supports device routes as well as gateway routes, it's
196 possible to have no remote IP address assigned to the ppp interface
197 and still route traffic over it.
199 * Pppd now works better with 3G modems that do strange things such as
200 sending IPCP Configure-Naks with the same values over and over again.
202 * The PPP over L2TP plugin is included, which works with the pppol2tp
203 PPP channel code in the Linux kernel. This allows pppd to be used
204 to set up tunnels using the Layer 2 Tunneling Protocol.
206 * A new 'enable-session' option has been added, which enables session
207 accounting via PAM or wtwp/wtmpx, as appropriate. See the pppd man
210 * Several bugs have been fixed.
213 What was new in ppp-2.4.4.
214 **************************
216 * Pppd will now run /etc/ppp/ip-pre-up, if it exists, after creating
217 the ppp interface and configuring its IP addresses but before
218 bringing it up. This can be used, for example, for adding firewall
219 rules for the interface.
221 * Lots of bugs fixed, particularly in the area of demand-dialled and
222 persistent connections.
224 * The rp-pppoe plugin now accepts any interface name (that isn't an
225 existing pppd option name) without putting "nic-" on the front of
226 it, not just eth*, nas*, tap* and br*.
229 What was new in ppp-2.4.3.
230 **************************
232 * The configure script now accepts --prefix and --sysconfdir options.
233 These default to /usr/local and /etc. If you want pppd put in
234 /usr/sbin as before, use ./configure --prefix=/usr.
236 * Doing `make install' no longer puts example configuration files in
237 /etc/ppp. Use `make install-etcppp' if you want that.
239 * The code has been updated to work with version 0.8.3 of libpcap.
240 Unfortunately the libpcap maintainers removed support for the
241 "inbound" and "outbound" keywords on PPP links, meaning that if you
242 link pppd with libpcap-0.8.3, you can't use those keywords in the
243 active-filter and pass-filter expressions. The support has been
244 reinstated in the CVS version and should be in future libpcap
245 releases. If you need the in/outbound keywords, use a later release
246 than 0.8.3, or get the CVS version from http://www.tcpdump.org.
248 * There is a new option, child-timeout, which sets the length of time
249 that pppd will wait for child processes (such as the command
250 specified with the pty option) to exit before exiting itself. It
251 defaults to 5 seconds. After the timeout, pppd will send a SIGTERM
252 to any remaining child processes and exit. A value of 0 means no
255 * Various bugs have been fixed, including some CBCP packet parsing
256 bugs that could lead to the peer being able to crash pppd if CBCP
259 * Various fixes and enhancements to the radius and rp-pppoe plugins
262 * There is a new winbind plugin, from Andrew Bartlet of the Samba
263 team, which provides the ability to authenticate the peer against an
264 NT domain controller using MS-CHAP or MS-CHAPV2.
266 * There is a new pppoatm plugin, by various authors, sent in by David
269 * The multilink code has been substantially reworked. The first pppd
270 for a bundle still controls the ppp interface, but it doesn't exit
271 until all the links in the bundle have terminated. If the first
272 pppd is signalled to exit, it signals all the other pppds
273 controlling links in the bundle.
275 * The TDB code has been updated to the latest version. This should
276 eliminate the problem that some people have seen where the database
277 file (/var/run/pppd.tdb) keeps on growing. Unfortunately, however,
278 the new code uses an incompatible database format. For this reason,
279 pppd now uses /var/run/pppd2.tdb as the database filename.
282 What was new in ppp-2.4.2.
283 **************************
285 * The CHAP code has been rewritten. Pppd now has support for MS-CHAP
286 V1 and V2 authentication, both as server and client. The new CHAP
287 code is cleaner than the old code and avoids some copyright problems
288 that existed in the old code.
290 * MPPE (Microsoft Point-to-Point Encryption) support has been added,
291 although the current implementation shouldn't be considered
292 completely secure. (There is no assurance that the current code
293 won't ever transmit an unencrypted packet.)
295 * James Carlson's implementation of the Extensible Authentication
296 Protocol (EAP) has been added.
298 * Support for the Encryption Control Protocol (ECP) has been added.
300 * Some new plug-ins have been included:
301 - A plug-in for kernel-mode PPPoE (PPP over Ethernet)
302 - A plug-in for supplying the PAP password over a pipe from another
304 - A plug-in for authenticating using a Radius server.
306 * Updates and bug-fixes for the Solaris port.
308 * The CBCP (Call Back Control Protocol) code has been updated. There
309 are new options `remotenumber' and `allow-number'.
311 * Extra hooks for plugins to use have been added.
313 * There is now a `maxoctets' option, which causes pppd to terminate
314 the link once the number of bytes passed on the link exceeds a given
317 * There are now options to control whether pppd can use the IPCP
318 IP-Address and IP-Addresses options: `ipcp-no-address' and
321 * Fixed several bugs, including potential buffer overflows in chat.
324 What was new in ppp-2.4.1.
325 **************************
327 * Pppd can now print out the set of options that are in effect. The
328 new `dump' option causes pppd to print out the option values after
329 option parsing is complete. The `dryrun' option causes pppd to
330 print the options and then exit.
332 * The option parsing code has been fixed so that options in the
333 per-tty options file are parsed correctly, and don't override values
334 from the command line in most cases.
336 * The plugin option now looks in /usr/lib/pppd/<pppd-version> (for
337 example, /usr/lib/pppd/2.4.1b1) for shared objects for plugins if
338 there is no slash in the plugin name.
340 * When loading a plugin, pppd will now check the version of pppd for
341 which the plugin was compiled, and refuse to load it if it is
342 different to pppd's version string. To enable this, the plugin
343 source needs to #include "pppd.h" and have a line saying:
344 char pppd_version[] = VERSION;
346 * There is a bug in zlib, discovered by James Carlson, which can cause
347 kernel memory corruption if Deflate is used with the lowest setting,
348 8. As a workaround pppd will now insist on using at least 9.
350 * Pppd should compile on Solaris and SunOS again.
352 * Pppd should now set the MTU correctly on demand-dialled interfaces.
355 What was new in ppp-2.4.0.
356 **************************
358 * Multilink: this package now allows you to combine multiple serial
359 links into one logical link or `bundle', for increased bandwidth and
360 reduced latency. This is currently only supported under the
361 2.4.x and later Linux kernels.
363 * All the pppd processes running on a system now write information
364 into a common database. I used the `tdb' code from samba for this.
366 * New hooks have been added.
368 For a list of the changes made during the 2.3 series releases of this
369 package, see the Changes-2.3 file.
375 This package supports two packet compression methods: Deflate and
376 BSD-Compress. Other compression methods which are in common use
377 include Predictor, LZS, and MPPC. These methods are not supported for
378 two reasons - they are patent-encumbered, and they cause some packets
379 to expand slightly, which pppd doesn't currently allow for.
380 BSD-Compress and Deflate (which uses the same algorithm as gzip) don't
387 The comp.protocols.ppp newsgroup is a useful place to get help if you
388 have trouble getting your ppp connections to work. Please do not send
389 me questions of the form "please help me get connected to my ISP" -
390 I'm sorry, but I simply do not have the time to answer all the
391 questions like this that I get.
393 If you find bugs in this package, please report them to the maintainer
394 for the port for the operating system you are using:
396 Linux Paul Mackerras <paulus@samba.org>
397 Solaris James Carlson <carlson@workingcode.com>
403 All of the code can be freely used and redistributed. The individual
404 source files each have their own copyright and permission notice.
405 Pppd, pppstats and pppdump are under BSD-style notices. Some of the
406 pppd plugins are GPL'd. Chat is public domain.
412 The primary site for releases of this software is:
414 ftp://ftp.samba.org/pub/ppp/