Update READMEs etc. for the forthcoming ppp-2.4.5 release

Signed-off-by: Paul Mackerras <[email protected]>

Author: paulusmack

README

@@ -8,11 +8,10 @@ Introduction.
 
 The Point-to-Point Protocol (PPP) provides a standard way to establish
 a network connection over a serial link.  At present, this package
-supports IP and the protocols layered above IP, such as TCP and UDP.
-The Linux and Solaris ports of this package have optional support for
-IPV6; the Linux port of this package also has support for IPX.
+supports IP and IPV6 and the protocols layered above them, such as TCP
+and UDP.  The Linux port of this package also has support for IPX.
 
-This software consists of two parts:
+This PPP implementation consists of two parts:
 
 - Kernel code, which establishes a network interface and passes
 packets between the serial port, the kernel networking code and the
@@ -29,6 +28,13 @@ code for NeXTStep, FreeBSD, SunOS 4.x, SVR4, Tru64 (Digital Unix), AIX
 and Ultrix but no active maintainers for these platforms.  Code for
 all of these except AIX is included in the ppp-2.3.11 release.
 
+The kernel code for Linux is no longer distributed with this package,
+since the relevant kernel code is in the official Linux kernel source
+(and has been for many years) and is included in all reasonably modern
+Linux distributions.  The Linux kernel code supports using PPP over
+things other than serial ports, such as PPP over Ethernet and PPP over
+ATM.
+
 
 Installation.
 *************
@@ -55,9 +61,25 @@ use any IP address.  (This only applies where the peer is
 authenticating itself to you, of course.)
 
 
-What's new in ppp-2.4.4.
+What's new in ppp-2.4.5.
 ************************
 
+* Under Linux, pppd can now operate in a mode where it doesn't request
+  the peer's IP address, as some peers refuse to supply an IP address.
+  Since Linux supports device routes as well as gateway routes, it's
+  possible to have no remote IP address assigned to the ppp interface
+  and still route traffic over it.
+
+* The PPP over L2TP plugin is included, which works with the pppol2tp
+  PPP channel code in the Linux kernel.  This allows pppd to be used
+  to set up tunnels using the Layer 2 Tunneling Protocol.
+
+* Several bugs have been fixed.
+
+
+What was new in ppp-2.4.4.
+**************************
+
 * Pppd will now run /etc/ppp/ip-pre-up, if it exists, after creating
   the ppp interface and configuring its IP addresses but before
   bringing it up.  This can be used, for example, for adding firewall
@@ -226,23 +248,6 @@ BSD-Compress and Deflate (which uses the same algorithm as gzip) don't
 ever expand packets.
 
 
-Patents.
-********
-
-The BSD-Compress algorithm used for packet compression is the same as
-that used in the Unix "compress" command.  It was apparently covered
-by U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by
-Unisys), and corresponding patents in various other countries (but not
-Australia).  Apparently the Unisys patent expired in the US on 20 June
-2003, but the IBM patent is still pending.
-
-If these patents are of concern in your situation, you can build the
-package without including BSD-Compress.  To do this, edit
-net/ppp-comp.h to change the definition of DO_BSD_COMPRESS to 0.  The
-bsd-comp.c files are then no longer needed, so the references to
-bsd-comp.o may optionally be removed from the Makefiles.
-
-
 Contacts.
 *********
 
@@ -276,4 +281,3 @@ The primary site for releases of this software is:
 	ftp://ftp.samba.org/pub/ppp/
 
 
-($Id: README,v 1.37 2006/05/29 23:51:29 paulus Exp $)

README.MPPE

@@ -4,6 +4,8 @@ PPP Support for MPPE (Microsoft Point to Point Encryption)
 Frank Cusack		[email protected]
 Mar 19, 2002
 
+Updated by Paul Mackerras, Sep 2008
+
 
 DISCUSSION
 
@@ -59,17 +61,9 @@ RADIUS support for MPPE is from Ralf Hofmann, <[email protected]>.
 BUILDING THE PPPD
 
 The userland component of PPPD has no additional requirements above
-those for MS-CHAP and MS-CHAPv2.  The kernel, however, requires SHA-1
-and ARCFOUR.  Public domain implementations of these are provided.
+those for MS-CHAP and MS-CHAPv2.
 
-Until such time as MPPE support ships with kernels, you can use
-the Linux 2.2 or 2.4 implementation that comes with PPPD.  Run the
-ppp/linux/mppe/mppeinstall.sh script, giving it the location to your
-kernel source.  Then add the CONFIG_PPP_MPPE option to your config and
-rebuild the kernel.  The ppp_mppe.o module is added, and the ppp.o module
-(2.2) or ppp_generic.o (2.4) is modified (unfortunately).  You'll need
-the new ppp.o/ppp_generic.o since it does the right thing for the 4
-extra bytes problem discussed above.
+MPPE support is now included in the mainline Linux kernel releases.
 
 
 CONFIGURATION
@@ -79,7 +73,6 @@ than 2.4.15, you will need to add
 
     alias ppp-compress-18 ppp_mppe
 
-to /etc/modules.conf.  (A patch for earlier versions of modutils is included
-with the kernel patches.)
+to /etc/modules.conf.
 
 

README.MSCHAP80

@@ -25,65 +25,11 @@ a value of 5.  If you enable PPP debugging with the "debug" option and
 see something like the following in your logs, the remote server is
 requesting MS-CHAP:
 
-  rcvd [LCP ConfReq id=0x2 <asyncmap 0x0> <auth chap 80> <magic 0x46a3>]
-                                           ^^^^^^^^^^^^
+  rcvd [LCP ConfReq id=0x2 <asyncmap 0x0> <auth MS> <magic 0x46a3>]
+                                           ^^^^^^^
 
-The standard pppd implementation will indicate its lack of support for
-MS-CHAP by NAKing it:
-
-  sent [LCP ConfNak id=0x2 <auth chap 05>]
-
-Windows NT Server systems are often configured to "Accept only
-Microsoft Authentication" (this is intended to enhance security).  Up
-until now, that meant that you couldn't use this version of PPPD to
-connect to such a system.
-
-
-BUILDING THE PPPD
-
-MS-CHAP uses a combination of MD4 hashing and DES encryption for
-authentication.  You may need to get Eric Young's libdes library in
-order to use my MS-CHAP extensions.  A lot of UNIX systems already
-have DES encryption available via the crypt(3), encrypt(3) and
-setkey(3) interfaces.  Some may (such as that on Digital UNIX)
-provide only the encryption mechanism and will not perform
-decryption.  This is okay.  We only need to encrypt to perform
-MS-CHAP authentication.
-
-If you have encrypt/setkey available, then hopefully you need only
-define these two things in your Makefile: -DUSE_CRYPT and -DCHAPMS.
-Skip the paragraphs below about obtaining and building libdes.  Do
-the "make clean" and "make" as described below.  Linux users
-should not need to modify their Makefiles.  Instead,
-just do "make CHAPMS=1 USE_CRYPT=1".
-
-If you don't have encrypt and setkey, you will need Eric Young's
-libdes library.  You can find it in:
-
-ftp://ftp.funet.fi/pub/crypt/mirrors/ftp.psy.uq.oz.au/DES/libdes-3.06.tar.gz
-
-Australian residents can get libdes from Eric Young's site:
-
-ftp://ftp.psy.uq.oz.au/pub/Crypto/DES/libdes-3.06.tar.gz
-
-It is also available on many other sites (ask Archie).
-
-I used libdes-3.06, but hopefully anything newer than that will work
-also.  Get the library, build and test it on your system, and install
-it somewhere (typically /usr/local/lib and /usr/local/include).
-
-
-
-You should now be ready to (re)compile the PPPD.  Go to the pppd
-subdirectory and make sure the Makefile contains "-DCHAPMS" in the
-CFLAGS or COMPILE_FLAGS macro, and that the LIBS macro (or LDADD for
-BSD systems) contains "-ldes".  Depending on your system and where the
-DES library was installed, you may also need to alter the include and
-library paths used by your compiler.
-
-Do a "make clean" and then a "make" to rebuild pppd.  Assuming all
-goes well, install the new pppd and move on to the CONFIGURATION
-section.
+MS-CHAP is enabled by default under Linux in pppd/Makefile.linux by
+the line "CHAPMS=y".
 
 
 CONFIGURATION

README.linux

@@ -5,6 +5,7 @@
 		8 March 2001
 
 		for ppp-2.4.2
+		Updated for ppp-2.4.5, Sep 08
 
 1. Introduction
 ---------------
@@ -13,8 +14,8 @@ The Linux PPP implementation includes both kernel and user-level
 parts.  This package contains the user-level part, which consists of
 the PPP daemon (pppd) and associated utilities.  In the past this
 package has contained updated kernel drivers.  This is no longer
-necessary, as the current 2.2 and 2.4 kernel sources contain
-up-to-date drivers.
+necessary, as the current kernel sources contain up-to-date drivers
+(and have done since the 2.4.x kernel series).
 
 The Linux PPP implementation is capable of being used both for
 initiating PPP connections (as a `client') or for handling incoming
@@ -47,7 +48,7 @@ the link down, when it negotiates a graceful disconnect.
 
 2.1 Kernel driver
 
-Assuming you are running a recent 2.2 or 2.4 (or later) series kernel,
+Assuming you are running a recent 2.4 or 2.6 (or later) series kernel,
 the kernel source code will contain an up-to-date kernel PPP driver.
 If the PPP driver was included in your kernel configuration when your
 kernel was built, then you only need to install the user-level
@@ -64,7 +65,7 @@ under /lib/modules and is loaded into the kernel when needed.
 
 The 2.2 series kernels contain an older version of the kernel PPP
 driver, one which doesn't support multilink.  If you want multilink,
-you need to run the latest 2.4 series kernel.  The kernel PPP driver
+you need to run a 2.4 or 2.6 series kernel.  The kernel PPP driver
 was completely rewritten for the 2.4 series kernels to support
 multilink and to allow it to operate over diverse kinds of
 communication medium (the 2.2 driver only operates over serial ports
@@ -94,7 +95,7 @@ If you obtained this package in .rpm or .deb format, you simply follow
 the usual procedure for installing the package.
 
 If you are using the .tar.gz form of this package, then cd into the
-ppp-2.4.1b1 directory you obtained by unpacking the archive and issue
+ppp-2.4.5 directory you obtained by unpacking the archive and issue
 the following commands:
 
 $ ./configure
@@ -111,34 +112,15 @@ files.
 2.3 System setup for 2.4 kernels
 
 Under the 2.4 series kernels, pppd needs to be able to open /dev/ppp,
-character device (108,0).  If you are using devfs (the device
-filesystem), the /dev/ppp node will automagically appear when the
-ppp_generic module is loaded, or at startup if ppp_generic is compiled
-in.
+character device (108,0).  If you are using udev (as most distributions
+do), the /dev/ppp node should be created by udevd.
 
-If you have ppp_generic as a module, and you are using devfsd (the
-devfs daemon), you will need to add a line like this to your
-/etc/devfsd.conf:
-
-LOOKUP		ppp		MODLOAD
-
-Otherwise you will need to create a /dev/ppp device node with the
+Otherwise you may need to create a /dev/ppp device node with the
 commands:
 
 # mknod /dev/ppp c 108 0
 # chmod 600 /dev/ppp
 
-If you use module autoloading and have PPP as a module, you will need
-to add the following to your /etc/modules.conf or /etc/conf.modules:
-
-alias /dev/ppp		ppp_generic
-alias char-major-108	ppp_generic
-alias tty-ldisc-3	ppp_async
-alias tty-ldisc-14	ppp_synctty
-alias ppp-compress-21	bsd_comp
-alias ppp-compress-24	ppp_deflate
-alias ppp-compress-26	ppp_deflate
-
 
 2.4 System setup under 2.2 series kernels
 

README.pppoe

@@ -5,12 +5,13 @@
 		8 August 2001
 
 		for ppp-2.4.2
+		Updated for ppp-2.4.5 by Paul Mackerras, Sep 08
 
 1. Introduction
 ---------------
 
 This document describes the support for PPP over Ethernet (PPPoE)
-included with this packages.  It is assumed that the reader is
+included with this package.  It is assumed that the reader is
 familiar with Linux PPP (as it pertains to tty/modem-based
 connections).  In particular, users of PPP in the Linux 2.2 series
 kernels should ensure they are familiar with the changes to the PPP
@@ -19,7 +20,7 @@ PPPoE features.
 
 If you are not familiar with PPP, I recommend looking at other
 packages which include end-user configuration tools, such as Roaring
-Penguin (http://www.roaringpenguin.com/pppoe)
+Penguin (http://www.roaringpenguin.com/pppoe).
 
 PPPoE is a protocol typically used by *DSL providers to manage IP
 addresses and authenticate users.  Essentially, PPPoE provides for a
@@ -42,10 +43,8 @@ This section is a quick guide for getting PPPoE working, to allow one
 to connect to their ISP who is providing PPPoE based services.
 
 1.  Enable "Prompt for development and/or incomplete code/drivers" and
-    "PPP over Ethernet" in your kernel configuration.  If you choose to
-    use the PPP over Ethernet driver as a module adding "alias
-    net-pf-24 pppoe" to /etc/modules.conf will enable auto-loading
-    of the modules.
+    "PPP over Ethernet" in your kernel configuration.  Most distributions
+    will include the kernel PPPoE module by default.
 
 2.  Compile and install your kernel.
 

README.pwfd

@@ -17,7 +17,7 @@ The passwordfd feature offers a simpler and more secure solution. The program
 that starts the pppd opens a pipe and writes the password into it. The pppd
 simply reads the password from that pipe.
 
-This methods is used for quiet a while on SuSE Linux by the programs wvdial,
+This methods is used for quite a while on SuSE Linux by the programs wvdial,
 kppp and smpppd.