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