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.3.
  59 ************************
  60
  61 * The configure script now accepts --prefix and --sysconfdir options.
  62   These default to /usr/local and /etc.  If you want pppd put in
  63   /usr/sbin as before, use ./configure --prefix=/usr.
  64
  65 * Doing `make install' no longer puts example configuration files in
  66   /etc/ppp.  Use `make install-etcppp' if you want that.
  67
  68 * The code has been updated to work with version 0.8.3 of libpcap.
  69   Unfortunately the libpcap maintainers removed support for the
  70   "inbound" and "outbound" keywords on PPP links, meaning that if you
  71   link pppd with libpcap-0.8.3, you can't use those keywords in the
  72   active-filter and pass-filter expressions.  The support has been
  73   reinstated in the CVS version and should be in future libpcap
  74   releases.  If you need the in/outbound keywords, use a later release
  75   than 0.8.3, or get the CVS version from http://www.tcpdump.org.
  76
  77 * There is a new option, child-timeout, which sets the length of time
  78   that pppd will wait for child processes (such as the command
  79   specified with the pty option) to exit before exiting itself.  It
  80   defaults to 5 seconds.  After the timeout, pppd will send a SIGTERM
  81   to any remaining child processes and exit.  A value of 0 means no
  82   timeout.
  83
  84 * Various bugs have been fixed, including some CBCP packet parsing
  85   bugs that could lead to the peer being able to crash pppd if CBCP
  86   support is enabled.
  87
  88 * Various fixes and enhancements to the radius and rp-pppoe plugins
  89   have been added.
  90
  91 * There is a new winbind plugin, from Andrew Bartlet of the Samba
  92   team, which provides the ability to authenticate the peer against an
  93   NT domain controller using MS-CHAP or MS-CHAPV2.
  94
  95 * There is a new pppoatm plugin, by various authors, sent in by David
  96   Woodhouse.
  97
  98
  99 What was new in ppp-2.4.2.
 100 **************************
 101
 102 * The CHAP code has been rewritten.  Pppd now has support for MS-CHAP
 103   V1 and V2 authentication, both as server and client.  The new CHAP
 104   code is cleaner than the old code and avoids some copyright problems
 105   that existed in the old code.
 106
 107 * MPPE (Microsoft Point-to-Point Encryption) support has been added,
 108   although the current implementation shouldn't be considered
 109   completely secure.  (There is no assurance that the current code
 110   won't ever transmit an unencrypted packet.)
 111
 112 * James Carlson's implementation of the Extensible Authentication
 113   Protocol (EAP) has been added.
 114
 115 * Support for the Encryption Control Protocol (ECP) has been added.
 116
 117 * Some new plug-ins have been included:
 118   - A plug-in for kernel-mode PPPoE (PPP over Ethernet)
 119   - A plug-in for supplying the PAP password over a pipe from another
 120     process
 121   - A plug-in for authenticating using a Radius server.
 122
 123 * Updates and bug-fixes for the Solaris port.
 124
 125 * The CBCP (Call Back Control Protocol) code has been updated.  There
 126   are new options `remotenumber' and `allow-number'.
 127
 128 * Extra hooks for plugins to use have been added.
 129
 130 * There is now a `maxoctets' option, which causes pppd to terminate
 131   the link once the number of bytes passed on the link exceeds a given
 132   value.
 133
 134 * There are now options to control whether pppd can use the IPCP
 135   IP-Address and IP-Addresses options: `ipcp-no-address' and
 136   `ipcp-no-addresses'.
 137
 138 * Fixed several bugs, including potential buffer overflows in chat.
 139
 140
 141 What was new in ppp-2.4.1.
 142 **************************
 143
 144 * Pppd can now print out the set of options that are in effect.  The
 145   new `dump' option causes pppd to print out the option values after
 146   option parsing is complete.  The `dryrun' option causes pppd to
 147   print the options and then exit.
 148
 149 * The option parsing code has been fixed so that options in the
 150   per-tty options file are parsed correctly, and don't override values
 151   from the command line in most cases.
 152
 153 * The plugin option now looks in /usr/lib/pppd/<pppd-version> (for
 154   example, /usr/lib/pppd/2.4.1b1) for shared objects for plugins if
 155   there is no slash in the plugin name.
 156
 157 * When loading a plugin, pppd will now check the version of pppd for
 158   which the plugin was compiled, and refuse to load it if it is
 159   different to pppd's version string.  To enable this, the plugin
 160   source needs to #include "pppd.h" and have a line saying:
 161         char pppd_version[] = VERSION;
 162
 163 * There is a bug in zlib, discovered by James Carlson, which can cause
 164   kernel memory corruption if Deflate is used with the lowest setting,
 165   8.  As a workaround pppd will now insist on using at least 9.
 166
 167 * Pppd should compile on Solaris and SunOS again.
 168
 169 * Pppd should now set the MTU correctly on demand-dialled interfaces.
 170
 171
 172 What was new in ppp-2.4.0.
 173 **************************
 174
 175 * Multilink: this package now allows you to combine multiple serial
 176   links into one logical link or `bundle', for increased bandwidth and
 177   reduced latency.  This is currently only supported under the
 178   2.4.x and later Linux kernels.
 179
 180 * All the pppd processes running on a system now write information
 181   into a common database.  I used the `tdb' code from samba for this.
 182
 183 * New hooks have been added.
 184
 185 For a list of the changes made during the 2.3 series releases of this
 186 package, see the Changes-2.3 file.
 187
 188
 189 Compression methods.
 190 ********************
 191
 192 This package supports two packet compression methods: Deflate and
 193 BSD-Compress.  Other compression methods which are in common use
 194 include Predictor, LZS, and MPPC.  These methods are not supported for
 195 two reasons - they are patent-encumbered, and they cause some packets
 196 to expand slightly, which pppd doesn't currently allow for.
 197 BSD-Compress and Deflate (which uses the same algorithm as gzip) don't
 198 ever expand packets.
 199
 200
 201 Patents.
 202 ********
 203
 204 The BSD-Compress algorithm used for packet compression is the same as
 205 that used in the Unix "compress" command.  It was apparently covered
 206 by U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by
 207 Unisys), and corresponding patents in various other countries (but not
 208 Australia).  I believe the Unisys patent expired in the US on 20 June
 209 2003, and that the IBM patent was older.
 210
 211 If these patents are of concern in your situation, you can build the
 212 package without including BSD-Compress.  To do this, edit
 213 net/ppp-comp.h to change the definition of DO_BSD_COMPRESS to 0.  The
 214 bsd-comp.c files are then no longer needed, so the references to
 215 bsd-comp.o may optionally be removed from the Makefiles.
 216
 217
 218 Contacts.
 219 *********
 220
 221 The comp.protocols.ppp newsgroup is a useful place to get help if you
 222 have trouble getting your ppp connections to work.  Please do not send
 223 me questions of the form "please help me get connected to my ISP" -
 224 I'm sorry, but I simply do not have the time to answer all the
 225 questions like this that I get.
 226
 227 If you find bugs in this package, please report them to the maintainer
 228 for the port for the operating system you are using:
 229
 230 Linux                   Paul Mackerras <paulus@samba.org>
 231 Solaris                 James Carlson <carlson@workingcode.com>
 232
 233
 234 Copyrights:
 235 ***********
 236
 237 All of the code can be freely used and redistributed.  The individual
 238 source files each have their own copyright and permission notice.
 239 Pppd, pppstats and pppdump are under BSD-style notices.  Some of the
 240 pppd plugins are GPL'd.  Chat is public domain.
 241
 242
 243 Distribution:
 244 *************
 245
 246 The primary site for releases of this software is:
 247
 248         ftp://ftp.samba.org/pub/ppp/
 249
 250
 251 ($Id: README,v 1.33 2004/11/06 11:36:54 paulus Exp $)