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 primary platforms supported by this package are Linux and Solaris.
  28 Code for SunOS 4.x is included here but is largely untested.  I have
  29 code for NeXTStep, FreeBSD, SVR4, Tru64 (Digital Unix), AIX and Ultrix
  30 but no active maintainers for these platforms.  Code for all of these
  31 except AIX is included in the ppp-2.3.11 release.
  32
  33
  34 Installation.
  35 *************
  36
  37 The file SETUP contains general information about setting up your
  38 system for using PPP.  There is also a README file for each supported
  39 system, which contains more specific details for installing PPP on
  40 that system.  The supported systems, and the corresponding README
  41 files, are:
  42
  43         Linux                           README.linux
  44         Solaris                         README.sol2
  45
  46 In each case you start by running the ./configure script.  This works
  47 out which operating system you are using and creates symbolic links to
  48 the appropriate makefiles.  You then run `make' to compile the
  49 user-level code, and (as root) `make install' to install the
  50 user-level programs pppd, chat and pppstats.
  51
  52 N.B. Since 2.3.0, leaving the permitted IP addresses column of the
  53 pap-secrets or chap-secrets file empty means that no addresses are
  54 permitted.  You need to put a "*" in that column to allow the peer to
  55 use any IP address.  (This only applies where the peer is
  56 authenticating itself to you, of course.)
  57
  58
  59 What's new in ppp-2.4.2.
  60 ************************
  61
  62 * The CHAP code has been rewritten.  Pppd now has support for MS-CHAP
  63   V1 and V2 authentication, both as server and client.  The new CHAP
  64   code is cleaner than the old code and avoids some copyright problems
  65   that existed in the old code.
  66
  67 * MPPE (Microsoft Point-to-Point Encryption) support has been added,
  68   although the current implementation shouldn't be considered
  69   completely secure.  (There is no assurance that the current code
  70   won't ever transmit an unencrypted packet.)
  71
  72 * James Carlson's implementation of the Extensible Authentication
  73   Protocol (EAP) has been added.
  74
  75 * Support for the Encryption Control Protocol (ECP) has been added.
  76
  77 * Some new plug-ins have been included:
  78   - A plug-in for kernel-mode PPPoE (PPP over Ethernet)
  79   - A plug-in for supplying the PAP password over a pipe from another
  80     process
  81   - A plug-in for authenticating using a Radius server.
  82
  83 * Updates and bug-fixes for the Solaris port.
  84
  85 * The CBCP (Call Back Control Protocol) code has been updated.  There
  86   are new options `remotenumber' and `allow-number'.
  87
  88 * Extra hooks for plugins to use have been added.
  89
  90 * There is now a `maxoctets' option, which causes pppd to terminate
  91   the link once the number of bytes passed on the link exceeds a given
  92   value.
  93
  94 * There are now options to control whether pppd can use the IPCP
  95   IP-Address and IP-Addresses options: `ipcp-no-address' and
  96   `ipcp-no-addresses'.
  97
  98 * Fixed several bugs, including potential buffer overflows in chat.
  99
 100
 101 What was new in ppp-2.4.1.
 102 **************************
 103
 104 * Pppd can now print out the set of options that are in effect.  The
 105   new `dump' option causes pppd to print out the option values after
 106   option parsing is complete.  The `dryrun' option causes pppd to
 107   print the options and then exit.
 108
 109 * The option parsing code has been fixed so that options in the
 110   per-tty options file are parsed correctly, and don't override values
 111   from the command line in most cases.
 112
 113 * The plugin option now looks in /usr/lib/pppd/<pppd-version> (for
 114   example, /usr/lib/pppd/2.4.1b1) for shared objects for plugins if
 115   there is no slash in the plugin name.
 116
 117 * When loading a plugin, pppd will now check the version of pppd for
 118   which the plugin was compiled, and refuse to load it if it is
 119   different to pppd's version string.  To enable this, the plugin
 120   source needs to #include "pppd.h" and have a line saying:
 121         char pppd_version[] = VERSION;
 122
 123 * There is a bug in zlib, discovered by James Carlson, which can cause
 124   kernel memory corruption if Deflate is used with the lowest setting,
 125   8.  As a workaround pppd will now insist on using at least 9.
 126
 127 * Pppd should compile on Solaris and SunOS again.
 128
 129 * Pppd should now set the MTU correctly on demand-dialled interfaces.
 130
 131
 132 What was new in ppp-2.4.0.
 133 **************************
 134
 135 * Multilink: this package now allows you to combine multiple serial
 136   links into one logical link or `bundle', for increased bandwidth and
 137   reduced latency.  This is currently only supported under the
 138   2.4.x and later Linux kernels.
 139
 140 * All the pppd processes running on a system now write information
 141   into a common database.  I used the `tdb' code from samba for this.
 142
 143 * New hooks have been added.
 144
 145 For a list of the changes made during the 2.3 series releases of this
 146 package, see the Changes-2.3 file.
 147
 148
 149 Compression methods.
 150 ********************
 151
 152 This package supports two packet compression methods: Deflate and
 153 BSD-Compress.  Other compression methods which are in common use
 154 include Predictor, LZS, and MPPC.  These methods are not supported for
 155 two reasons - they are patent-encumbered, and they cause some packets
 156 to expand slightly, which pppd doesn't currently allow for.
 157 BSD-Compress is also patent-encumbered (its inclusion in this package
 158 can be considered a historical anomaly :-) but it doesn't ever expand
 159 packets.  Neither does Deflate, which uses the same algorithm as gzip.
 160
 161
 162 Patents.
 163 ********
 164
 165 The BSD-Compress algorithm used for packet compression is the same as
 166 that used in the Unix "compress" command.  It is apparently covered by
 167 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
 168 and corresponding patents in various other countries (but not
 169 Australia).  If this is of concern, you can build the package without
 170 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
 171 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
 172 longer needed, so the references to bsd-comp.o may optionally be
 173 removed from the Makefiles.
 174
 175
 176 Contacts.
 177 *********
 178
 179 The comp.protocols.ppp newsgroup is a useful place to get help if you
 180 have trouble getting your ppp connections to work.  Please do not send
 181 me questions of the form "please help me get connected to my ISP" -
 182 I'm sorry, but I simply do not have the time to answer all the
 183 questions like this that I get.
 184
 185 If you find bugs in this package, please report them to the maintainer
 186 for the port for the operating system you are using:
 187
 188 Linux                   Paul Mackerras <paulus@samba.org>
 189 Solaris                 James Carlson <carlson@workingcode.com>
 190
 191
 192 Copyrights:
 193 ***********
 194
 195 All of the code can be freely used and redistributed.  The individual
 196 source files each have their own copyright and permission notice; some
 197 have a BSD-style notice and some are under the GPL.
 198
 199
 200 Distribution:
 201 *************
 202
 203 The primary site for releases of this software is:
 204
 205         ftp://ftp.samba.org/pub/ppp/
 206
 207
 208 ($Id: README,v 1.30 2003/11/27 21:32:03 paulus Exp $)