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.8.
  65 ************************
  66
  67 * New pppd options have been added:
  68   - ifname, to set the name for the PPP interface device
  69   - defaultroute-metric, to set the metric for the default route
  70   - defaultroute6, to add an IPv6 default route (with nodefaultroute6
  71     to prevent adding an IPv6 default route)
  72   - up_sdnotify, to have pppd notify systemd when the link is up.
  73
  74 * The rp-pppoe plugin has new options:
  75   - host-uniq, to set the Host-Uniq value to send
  76   - pppoe-padi-timeout, to set the timeout for discovery packets
  77   - pppoe-padi-attempts, to set the number of discovery attempts.
  78
  79 * Added the CLASS attribute in radius packets.
  80
  81 * Sundry bug fixes.
  82
  83 * Fixed warnings and issues found by static analysis.
  84
  85 * Added Submitting-patches.md.
  86
  87
  88 What was new in ppp-2.4.7.
  89 **************************
  90
  91 * Fixed a potential security issue in parsing option files (CVE-2014-3158).
  92
  93 * There is a new "stop-bits" option, which takes an argument of 1 or 2,
  94   indicating the number of stop bits to use for async serial ports.
  95
  96 * Various bug fixes.
  97
  98
  99 What was new in ppp-2.4.6.
 100 **************************
 101
 102 * Man page updates.
 103
 104 * Several bug fixes.
 105
 106 * Options files can now set and unset environment variables for
 107   scripts.
 108
 109 * The timeout for chat scripts can now be taken from an environment
 110   variable.
 111
 112 * There is a new option, master_detach, which allows pppd to detach
 113   from the controlling terminal when it is the multilink bundle master
 114   but its own link has terminated, even if the nodetach option has
 115   been given.
 116
 117
 118 What was new in ppp-2.4.5.
 119 **************************
 120
 121 * Under Linux, pppd can now operate in a mode where it doesn't request
 122   the peer's IP address, as some peers refuse to supply an IP address.
 123   Since Linux supports device routes as well as gateway routes, it's
 124   possible to have no remote IP address assigned to the ppp interface
 125   and still route traffic over it.
 126
 127 * Pppd now works better with 3G modems that do strange things such as
 128   sending IPCP Configure-Naks with the same values over and over again.
 129
 130 * The PPP over L2TP plugin is included, which works with the pppol2tp
 131   PPP channel code in the Linux kernel.  This allows pppd to be used
 132   to set up tunnels using the Layer 2 Tunneling Protocol.
 133
 134 * A new 'enable-session' option has been added, which enables session
 135   accounting via PAM or wtwp/wtmpx, as appropriate.  See the pppd man
 136   page for details.
 137
 138 * Several bugs have been fixed.
 139
 140
 141 What was new in ppp-2.4.4.
 142 **************************
 143
 144 * Pppd will now run /etc/ppp/ip-pre-up, if it exists, after creating
 145   the ppp interface and configuring its IP addresses but before
 146   bringing it up.  This can be used, for example, for adding firewall
 147   rules for the interface.
 148
 149 * Lots of bugs fixed, particularly in the area of demand-dialled and
 150   persistent connections.
 151
 152 * The rp-pppoe plugin now accepts any interface name (that isn't an
 153   existing pppd option name) without putting "nic-" on the front of
 154   it, not just eth*, nas*, tap* and br*.
 155
 156
 157 What was new in ppp-2.4.3.
 158 **************************
 159
 160 * The configure script now accepts --prefix and --sysconfdir options.
 161   These default to /usr/local and /etc.  If you want pppd put in
 162   /usr/sbin as before, use ./configure --prefix=/usr.
 163
 164 * Doing `make install' no longer puts example configuration files in
 165   /etc/ppp.  Use `make install-etcppp' if you want that.
 166
 167 * The code has been updated to work with version 0.8.3 of libpcap.
 168   Unfortunately the libpcap maintainers removed support for the
 169   "inbound" and "outbound" keywords on PPP links, meaning that if you
 170   link pppd with libpcap-0.8.3, you can't use those keywords in the
 171   active-filter and pass-filter expressions.  The support has been
 172   reinstated in the CVS version and should be in future libpcap
 173   releases.  If you need the in/outbound keywords, use a later release
 174   than 0.8.3, or get the CVS version from http://www.tcpdump.org.
 175
 176 * There is a new option, child-timeout, which sets the length of time
 177   that pppd will wait for child processes (such as the command
 178   specified with the pty option) to exit before exiting itself.  It
 179   defaults to 5 seconds.  After the timeout, pppd will send a SIGTERM
 180   to any remaining child processes and exit.  A value of 0 means no
 181   timeout.
 182
 183 * Various bugs have been fixed, including some CBCP packet parsing
 184   bugs that could lead to the peer being able to crash pppd if CBCP
 185   support is enabled.
 186
 187 * Various fixes and enhancements to the radius and rp-pppoe plugins
 188   have been added.
 189
 190 * There is a new winbind plugin, from Andrew Bartlet of the Samba
 191   team, which provides the ability to authenticate the peer against an
 192   NT domain controller using MS-CHAP or MS-CHAPV2.
 193
 194 * There is a new pppoatm plugin, by various authors, sent in by David
 195   Woodhouse.
 196
 197 * The multilink code has been substantially reworked.  The first pppd
 198   for a bundle still controls the ppp interface, but it doesn't exit
 199   until all the links in the bundle have terminated.  If the first
 200   pppd is signalled to exit, it signals all the other pppds
 201   controlling links in the bundle.
 202
 203 * The TDB code has been updated to the latest version.  This should
 204   eliminate the problem that some people have seen where the database
 205   file (/var/run/pppd.tdb) keeps on growing.  Unfortunately, however,
 206   the new code uses an incompatible database format.  For this reason,
 207   pppd now uses /var/run/pppd2.tdb as the database filename.
 208
 209
 210 What was new in ppp-2.4.2.
 211 **************************
 212
 213 * The CHAP code has been rewritten.  Pppd now has support for MS-CHAP
 214   V1 and V2 authentication, both as server and client.  The new CHAP
 215   code is cleaner than the old code and avoids some copyright problems
 216   that existed in the old code.
 217
 218 * MPPE (Microsoft Point-to-Point Encryption) support has been added,
 219   although the current implementation shouldn't be considered
 220   completely secure.  (There is no assurance that the current code
 221   won't ever transmit an unencrypted packet.)
 222
 223 * James Carlson's implementation of the Extensible Authentication
 224   Protocol (EAP) has been added.
 225
 226 * Support for the Encryption Control Protocol (ECP) has been added.
 227
 228 * Some new plug-ins have been included:
 229   - A plug-in for kernel-mode PPPoE (PPP over Ethernet)
 230   - A plug-in for supplying the PAP password over a pipe from another
 231     process
 232   - A plug-in for authenticating using a Radius server.
 233
 234 * Updates and bug-fixes for the Solaris port.
 235
 236 * The CBCP (Call Back Control Protocol) code has been updated.  There
 237   are new options `remotenumber' and `allow-number'.
 238
 239 * Extra hooks for plugins to use have been added.
 240
 241 * There is now a `maxoctets' option, which causes pppd to terminate
 242   the link once the number of bytes passed on the link exceeds a given
 243   value.
 244
 245 * There are now options to control whether pppd can use the IPCP
 246   IP-Address and IP-Addresses options: `ipcp-no-address' and
 247   `ipcp-no-addresses'.
 248
 249 * Fixed several bugs, including potential buffer overflows in chat.
 250
 251
 252 What was new in ppp-2.4.1.
 253 **************************
 254
 255 * Pppd can now print out the set of options that are in effect.  The
 256   new `dump' option causes pppd to print out the option values after
 257   option parsing is complete.  The `dryrun' option causes pppd to
 258   print the options and then exit.
 259
 260 * The option parsing code has been fixed so that options in the
 261   per-tty options file are parsed correctly, and don't override values
 262   from the command line in most cases.
 263
 264 * The plugin option now looks in /usr/lib/pppd/<pppd-version> (for
 265   example, /usr/lib/pppd/2.4.1b1) for shared objects for plugins if
 266   there is no slash in the plugin name.
 267
 268 * When loading a plugin, pppd will now check the version of pppd for
 269   which the plugin was compiled, and refuse to load it if it is
 270   different to pppd's version string.  To enable this, the plugin
 271   source needs to #include "pppd.h" and have a line saying:
 272         char pppd_version[] = VERSION;
 273
 274 * There is a bug in zlib, discovered by James Carlson, which can cause
 275   kernel memory corruption if Deflate is used with the lowest setting,
 276   8.  As a workaround pppd will now insist on using at least 9.
 277
 278 * Pppd should compile on Solaris and SunOS again.
 279
 280 * Pppd should now set the MTU correctly on demand-dialled interfaces.
 281
 282
 283 What was new in ppp-2.4.0.
 284 **************************
 285
 286 * Multilink: this package now allows you to combine multiple serial
 287   links into one logical link or `bundle', for increased bandwidth and
 288   reduced latency.  This is currently only supported under the
 289   2.4.x and later Linux kernels.
 290
 291 * All the pppd processes running on a system now write information
 292   into a common database.  I used the `tdb' code from samba for this.
 293
 294 * New hooks have been added.
 295
 296 For a list of the changes made during the 2.3 series releases of this
 297 package, see the Changes-2.3 file.
 298
 299
 300 Compression methods.
 301 ********************
 302
 303 This package supports two packet compression methods: Deflate and
 304 BSD-Compress.  Other compression methods which are in common use
 305 include Predictor, LZS, and MPPC.  These methods are not supported for
 306 two reasons - they are patent-encumbered, and they cause some packets
 307 to expand slightly, which pppd doesn't currently allow for.
 308 BSD-Compress and Deflate (which uses the same algorithm as gzip) don't
 309 ever expand packets.
 310
 311
 312 Contacts.
 313 *********
 314
 315 The comp.protocols.ppp newsgroup is a useful place to get help if you
 316 have trouble getting your ppp connections to work.  Please do not send
 317 me questions of the form "please help me get connected to my ISP" -
 318 I'm sorry, but I simply do not have the time to answer all the
 319 questions like this that I get.
 320
 321 If you find bugs in this package, please report them to the maintainer
 322 for the port for the operating system you are using:
 323
 324 Linux                   Paul Mackerras <paulus@samba.org>
 325 Solaris                 James Carlson <carlson@workingcode.com>
 326
 327
 328 Copyrights:
 329 ***********
 330
 331 All of the code can be freely used and redistributed.  The individual
 332 source files each have their own copyright and permission notice.
 333 Pppd, pppstats and pppdump are under BSD-style notices.  Some of the
 334 pppd plugins are GPL'd.  Chat is public domain.
 335
 336
 337 Distribution:
 338 *************
 339
 340 The primary site for releases of this software is:
 341
 342         ftp://ftp.samba.org/pub/ppp/
 343
 344