62f31af65a781cf3a0174cd3c89aa037e5ae071c
[ppp.git] / README
1 This is the README file for ppp-2.2, 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 transmit
10 datagrams over a serial link, as well as a standard way for the
11 machines at either end of the link (the `peers') to negotiate various
12 optional characteristics of the link.  Using PPP, a serial link can be
13 used to transmit Internet Protocol (IP) datagrams, allowing TCP/IP
14 connections between the peers.  PPP is defined in several RFC (Request
15 For Comments) documents, in particular RFCs 1661, 1662, 1332 and 1334.
16 Other RFCs describe standard ways to transmit datagrams from other
17 network protocols (e.g., DECnet, OSI, Appletalk), but this package
18 only supports IP.
19
20 This software consists of two parts:
21
22 - Kernel code, which establishes a network interface and passes
23 packets between the serial port, the kernel networking code and the
24 PPP daemon (pppd).  This code is implemented using STREAMS modules on
25 SunOS 4.x, AIX 4.1 and OSF/1, and as a line discipline under Ultrix,
26 NextStep, NetBSD, FreeBSD, and Linux.
27
28 - The PPP daemon (pppd), which negotiates with the peer to establish
29 the link and sets up the ppp network interface.  Pppd includes support
30 for authentication, so you can control which other systems may make a
31 PPP connection and what IP addresses they may use.
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         SunOS 4.x                       README.sun
44         NetBSD, FreeBSD                 README.bsd
45         Ultrix 4.x                      README.ultrix
46         Linux                           README.linux
47         OSF/1                           README.osf
48         AIX 4.x                         README.aix4
49         NeXTStep                        README.next
50         Solaris 2                       README.svr4
51
52 In each case you start by running the ./configure script.  This works
53 out which operating system you are using and creates symbolic links to
54 the appropriate makefiles.  You then run `make' to compile the
55 user-level code, and (as root) `make install' to install the
56 user-level programs pppd, chat and pppstats.
57
58 The procedures for installing the kernel code vary from system to
59 system.  On some systems, the kernel code can be loaded into a running
60 kernel using a `modload' facility.  On others, the kernel image has to
61 be recompiled and the system rebooted.  See the README.* files for
62 details.
63
64
65 What is new in ppp-2.2.
66 ***********************
67
68 * More systems are now supported:
69
70   AIX 4, thanks to Charlie Wick (cwick@quaver.urbana.mcd.mot.com)
71   OSF/1 on DEC Alpha, thanks to Steve Tate (srt@zaphod.csci.unt.edu)
72   NextStep 3.2 and 3.3, thanks to Philip-Andrew Prindeville
73         (philipp@res.enst.fr) and Steve Perkins (perkins@cps.msu.edu)
74   Solaris 2
75
76 in addition to NetBSD 1.0, SunOS 4.x, Ultrix 4.x, FreeBSD 2.0, and
77 Linux.
78
79 * Packet compression has been implemented.  This version implements
80 CCP (Compression Control Protocol) and the BSD-Compress compression
81 scheme according to the current draft RFCs.  This means that incoming
82 and outgoing packets can be compressed with the LZW scheme (same as
83 the `compress' command) using a code size of up to 15 bits.
84
85 * Some bug fixes to the LCP protocol code.  In particular, pppd now
86 correctly replies with a Configure-NAK (instead of a Configure-Reject)
87 if the peer asks for CHAP and pppd is willing to do PAP but not CHAP.
88
89 * The ip-up and ip-down scripts are now run with the real user ID set
90 to root, and with an empty environment.  Clearing the environment
91 fixes a security hole.
92
93 * The kernel code on NetBSD, FreeBSD, NextStep and Ultrix has been
94 restructured to make it easier to implement PPP over devices other
95 than asynchronous tty ports (for example, synchronous serial ports).
96
97 * pppd now looks at the list of interfaces in the system to determine
98 what the netmask should be.  In most cases, this should eliminate the
99 need to use the `netmask' option.
100
101 * There is a new `papcrypt' option to pppd, which specifies that
102 secrets in /etc/ppp/pap-secrets used for authenticating the peer are
103 encrypted, so pppd always encrypts the peer's password before
104 comparing it with the secret from /etc/ppp/pap-secrets.  This gives
105 better security.
106
107
108 Patents.
109 ********
110
111 The BSD-Compress algorithm used for packet compression is the same as
112 that used in the Unix "compress" command.  It is apparently covered by
113 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
114 and corresponding patents in various other countries (but not
115 Australia).  If this is of concern, you can build the package without
116 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
117 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
118 longer needed, so the references to bsd-comp.o may optionally be
119 removed from the Makefiles.
120
121
122 Contacts.
123 *********
124
125 Bugs in the the SunOS, NetBSD and Ultrix ports and bugs in pppd, chat
126 or pppstats should be reported to:
127
128         paulus@cs.anu.edu.au
129         Paul Mackerras
130         Dept. of Computer Science
131         Australian National University
132         Canberra  ACT  0200
133         AUSTRALIA
134
135 Bugs in other ports should be reported to the maintainer for that port
136 (see the appropriate README.* file) or to the above.
137
138 Thanks to:
139
140         Brad Parker  (brad@fcr.com)
141         Greg Christy (gmc@quotron.com)
142         Drew D. Perkins (ddp@andrew.cmu.edu)
143         Rick Adams (rick@seismo.ARPA)
144         Chris Torek (chris@mimsy.umd.edu, umcp-cs!chris).
145
146
147 Copyrights:
148
149 Most of the code can be freely used and redistributed.  The STREAMS
150 code for SunOS 4.x, OSF/1 and AIX 4 is under a more restrictive
151 copyright:
152
153         This code is Copyright (C) 1989, 1990 By Brad K. Clements, 
154         All Rights Reserved.
155
156         You may use this code for your personal use, to provide a non-profit
157         service to others, or to use as a test platform for a commercial
158         implementation.
159
160         You may NOT use this code in a commercial product, nor to provide a 
161         commercial service, nor may you sell this code without express
162         written permission of the author.
163
164         Otherwise, Enjoy!
165
166 This copyright applies to (parts of) the following files:
167
168         sunos/ppp_async.c
169         sunos/ppp_if.c
170         aix4/ppp_async.c
171         aix4/ppp_if.c
172         net/ppp_str.h
173         pppd/sys-str.c
174         pppd/sys-osf.c
175         pppd/sys-aix4.c