update version to 2.3.7
[ppp.git] / README
1 This is the README file for ppp-2.3, 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 port of this package also has support for IPX.
13
14 This software 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 SunOS 4.x, Solaris 2.x, System V Release 4, and OSF/1, and as a
20 line discipline under Ultrix, NextStep, NetBSD, FreeBSD, and 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
28 Installation.
29 *************
30
31 The file SETUP contains general information about setting up your
32 system for using PPP.  There is also a README file for each supported
33 system, which contains more specific details for installing PPP on
34 that system.  The supported systems, and the corresponding README
35 files, are:
36
37         Linux                           README.linux
38         Solaris 2                       README.sol2
39         Digital Unix (OSF/1)            README.osf
40         NetBSD, FreeBSD                 README.bsd
41         NeXTStep                        README.next
42         SunOS 4.x                       README.sunos4
43         System V Release 4              README.svr4
44         Ultrix 4.x                      README.ultrix
45
46 In fact, only the Linux and Solaris 2 ports have been tested in this
47 release.  Code for the other systems is still included; if you use it,
48 let me know how it works.  If I don't hear from anyone it will
49 probably get dropped in a subsequent release.  AIX 4 is no longer
50 supported, since I don't have a maintainer for the AIX 4 port.  If you
51 want to volunteer, contact me.
52
53 In each case you start by running the ./configure script.  This works
54 out which operating system you are using and creates symbolic links to
55 the appropriate makefiles.  You then run `make' to compile the
56 user-level code, and (as root) `make install' to install the
57 user-level programs pppd, chat and pppstats.
58
59 The procedures for installing the kernel code vary from system to
60 system.  On some systems, the kernel code can be loaded into a running
61 kernel using a `modload' facility.  On others, the kernel image has to
62 be recompiled and the system rebooted.  See the README.* files for
63 details.
64
65 N.B. Since 2.3.0, leaving the permitted IP addresses column of the
66 pap-secrets or chap-secrets file empty means that no addresses are
67 permitted.  You need to put a "*" in that column to allow the peer to
68 use any IP address.  (This only applies where the peer is
69 authenticating itself to you, of course.)
70
71
72 What's new in ppp-2.3.7.
73 ************************
74
75 * Pppd can now automatically allocate itself a pseudo-tty to use as
76   the serial device.  This has made three new options possible:
77
78   - `pty script' will run `script' with its standard input and output
79     connected to the master side of the pty.  For example:
80         pppd pty 'ssh -t server.my.net pppd'
81     is a basic command for setting up a PPP link (tunnel) over ssh.
82     (In practice you may need to specify other options such as IP
83     addresses, etc.)
84
85   - `notty' tells pppd to communicate over its standard input and
86     output, which do not have to be a terminal device.
87
88   - `record filename' tells pppd to record all of the characters sent
89     and received over the serial device to a file called `filename'.
90     The data is recorded in a tagged format with timestamps, which can
91     be printed in a readable form with the pppdump program, which is
92     included in this distribution.
93
94 * Pppd now logs the connect time and number of bytes sent and received
95   (at the level of the serial device) when the connection is
96   terminated.
97
98 * If you use the updetach or nodetach option, pppd will print its
99   messages to standard output as well as logging them with syslog
100   (provided of course pppd isn't using its standard input or output as
101   its serial device).
102
103 * There is a new `privgroup groupname' option (a privileged option).
104   If the user running pppd is in group `groupname', s/he can use
105   privileged options without restriction.
106
107 * There is a new `receive-all' option, which causes pppd to accept all
108   control characters, even the ones that the peer should be escaping
109   (i.e. the receive asyncmap is 0).  This is useful with some buggy
110   peers.
111
112 * The default asyncmap is now 0.
113
114 * There is a new `sync' option, currently only implemented under
115   Linux, which allows pppd to run on synchronous HDLC devices.
116
117 * If a value for the device name or for the connect, disconnect,
118   welcome or pty option is given in a privileged option file
119   (i.e. /etc/ppp/options or a file loaded with the `call' option), it
120   cannot be overridden by a non-privileged user.
121
122 * Many bugs have been fixed, notably:
123   - signals are not blocked unnecessarily, as they were in 2.3.6.
124   - the usepeerdns option should work now.
125   - the SPEED environment variable for scripts is set correctly.
126   - the /etc/ppp/auth-down script is not run until auth-up completes.
127   - the device is opened as root if it is the device on standard
128     input.
129   - pppd doesn't die with the ioctl(PPPIOCSASYNCMAP) error under linux
130     if a hangup occurs at the wrong time.
131
132 * Some error messages have been changed to be clearer (I hope :-)
133
134
135 What was new in ppp-2.3.6.
136 **************************
137
138 * Pppd now opens the tty device as the user (rather than as root) if
139   the device name was given by the user, i.e. on the command line or
140   in the ~/.ppprc file.  If the device name was given in
141   /etc/ppp/options or in a file loaded with the `call' option, the
142   device is opened as root.
143
144 * The default behaviour of pppd is now to let a peer which has not
145   authenticated itself (e.g. your ISP) use any IP address to which the
146   system does not already have a route.  (This is currently only
147   supported under Linux, Solaris and Digital Unix; on the other
148   systems, the peer must now authenticate itself unless the noauth
149   option is used.)
150
151 * Added new option `usepeerdns', thanks to Nick Walker
152   <nickwalker@email.com>.  If the peer supplies DNS addresses, these
153   will be written to /etc/ppp/resolv.conf.  The ip-up script can then
154   be used to add these addresses to /etc/resolv.conf if desired (see
155   the ip-up.local.add and ip-down.local.add files in the scripts
156   directory).
157
158 * The Solaris ppp driver should now work correctly on SMP systems.
159
160 * Minor corrections so that the code can compile under Solaris 7,
161   and under Linux with glibc-2.1.
162
163 * The Linux kernel driver has been restructured for improved
164   performance.
165
166 * Pppd now won't start the ip-down script until the ip-up script has
167   finished.
168
169
170 What was new in ppp-2.3.5.
171 **************************
172
173 * Minor corrections to the Digital UNIX and NetBSD ports.
174
175 * A workaround to avoid tickling a bug in the `se' serial port driver
176 on Sun PCI Ultra machines running Solaris.
177
178 * Fixed a bug in the negotiation of the Microsoft WINS server address
179 option.
180
181 * Fixed a bug in the Linux port where it would fail for kernel
182 versions above 2.1.99.
183
184
185 What was new in ppp-2.3.4.
186 **************************
187
188 * The NeXT port has been updated, thanks to Steve Perkins.
189
190 * ppp-2.3.4 compiles and works under Solaris 2.6, using either gcc or
191 cc.
192
193 * With the Solaris, SVR4 and SunOS ports, you can control the choice
194 of C compiler, C compiler options, and installation directories by
195 editing the svr4/Makedefs or sunos4/Makedefs file.
196
197 * Until now, we have been using the number 24 to identify Deflate
198 compression in the CCP negotiations, which was the number in the draft
199 RFC describing Deflate.  The number actually assigned to Deflate is
200 26.  The code has been changed to use 26, but to allow the use of 24
201 for now for backwards compatibility.  (This can be disabled with the
202 `nodeflatedraft' option to pppd.)
203
204 * Fixed some bugs in the linux driver and deflate compressor which
205 were causing compression problems, including corrupting long
206 incompressible packets sometimes.
207
208 * Fixes to the PAM and shadow password support in pppd, from Al
209 Longyear and others.
210
211 * Pppd now sets some environment variables for scripts it invokes
212 (ip-up/down, auth-ip/down), giving information about the connection.
213 The variables it sets are PEERNAME, IPLOCAL, IPREMOTE, UID, DEVICE,
214 SPEED, and IFNAME.
215
216 * Pppd now has an `updetach' option, which will cause it to detach
217 from its controlling terminal once the link has come up (i.e. once it
218 is available for IP traffic).
219
220
221 What was new in ppp-2.3.3.
222 **************************
223
224 * Fixed compilation problems under SunOS.
225
226 * Fixed a bug introduced into chat in 2.3.2, and compilation problems
227 introduced into the MS-CHAP implementation in 2.3.2.
228
229 * The linux kernel driver has been updated for recent 2.1-series
230 kernel changes, and it now will ask kerneld to load compression
231 modules when required, if the kernel is configured to support kerneld.
232
233 * Pppd should now compile correctly under linux on systems with glibc.
234
235
236 What was new in ppp-2.3.2.
237 **************************
238
239 * In 2.3.1, I made a change which was intended to make pppd able to
240 detect loss of CD during or immediately after the connection script
241 runs.  Unfortunately, this had the side-effect that the connection
242 script wouldn't work at all on some systems.  This change has been
243 reversed.
244
245 * Fix compilation problems in the Linux kernel driver.
246
247
248 What was new in ppp-2.3.1.
249 **************************
250
251 * Enhancements to chat, thanks to Francis Demierre.  Chat can now
252 accept comments in the chat script file, and has new SAY, HANGUP,
253 CLR_ABORT and CLR_REPORT keywords.
254
255 * Fixed a bug which causes 2.3.0 to crash Solaris systems.
256
257 * Bug-fixes and restructuring of the Linux kernel driver.
258
259 * The holdoff behaviour of pppd has been changed slightly: now, if
260 the link comes up for IP (or other network protocol) traffic, we
261 consider that the link has been successfully established, and don't
262 enforce the holdoff period after the link goes down.
263
264 * Pppd should now correctly wait for CD (carrier detect) from the
265 modem, even when the serial port initially had CLOCAL set, and it
266 should also detect loss of CD during or immediately after the
267 connection script runs.
268
269 * Under linux, pppd will work with older 2.2.0* version kernel
270 drivers, although demand-dialling is not supported with them.
271
272 * Minor bugfixes for pppd.
273
274
275 What was new in ppp-2.3.
276 ************************
277
278 * Demand-dialling.  Pppd now has a mode where it will establish the
279 network interface immediately when it starts, but not actually bring
280 the link up until it sees some data to be sent.  Look for the demand
281 option description in the pppd man page.  Demand-dialling is not
282 supported under Ultrix or NeXTStep.
283
284 * Idle timeout.  Pppd will optionally terminate the link if no data
285 packets are sent or received within a certain time interval.
286
287 * Pppd now runs the /etc/ppp/auth-up script, if it exists, when the
288 peer successfully authenticates itself, and /etc/ppp/auth-down when
289 the connection is subsequently terminated.  This can be useful for
290 accounting purposes.
291
292 * A new packet compression scheme, Deflate, has been implemented.
293 This uses the same compression method as `gzip'.  This method is free
294 of patent or copyright restrictions, and it achieves better
295 compression than BSD-Compress.  It does consume more CPU cycles for
296 compression than BSD-Compress, but this shouldn't be a problem for
297 links running at 100kbit/s or less.
298
299 * There is no code in this distribution which is covered by Brad
300 Clements' restrictive copyright notice.  The STREAMS modules for SunOS
301 and OSF/1 have been rewritten, based on the Solaris 2 modules, which
302 were written from scratch without any Clements code.
303
304 * Pppstats has been reworked to clean up the output format somewhat.
305 It also has a new -d option which displays data rate in kbyte/s for
306 those columns which would normally display bytes.
307
308 * Pppd options beginning with - or + have been renamed, e.g. -ip
309 became noip, +chap became require-chap, etc.  The old options are
310 still accepted for compatibility but may be removed in future.
311
312 * Pppd now has some options (such as the new `noauth' option) which
313 can only be specified if it is being run by root, or in an
314 "privileged" options file: /etc/ppp/options or an options file in the
315 /etc/ppp/peers directory.  There is a new "call" option to read
316 options from a file in /etc/ppp/peers, making it possible for non-root
317 users to make unauthenticated connections, but only to certain trusted
318 peers.  My intention is to make the `auth' option the default in a
319 future release.
320
321 * Several minor new features have been added to pppd, including the
322 maxconnect and welcome options.  Pppd will now terminate the
323 connection when there are no network control protocols running.  The
324 allowed IP address(es) field in the secrets files can now specify
325 subnets (with a notation like 123.45.67.89/24) and addresses which are
326 not acceptable (put a ! on the front).
327
328 * Numerous bugs have been fixed (no doubt some have been introduced :-)
329 Thanks to those who reported bugs in ppp-2.2.
330
331
332 Patents.
333 ********
334
335 The BSD-Compress algorithm used for packet compression is the same as
336 that used in the Unix "compress" command.  It is apparently covered by
337 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
338 and corresponding patents in various other countries (but not
339 Australia).  If this is of concern, you can build the package without
340 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
341 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
342 longer needed, so the references to bsd-comp.o may optionally be
343 removed from the Makefiles.
344
345
346 Contacts.
347 *********
348
349 The comp.protocols.ppp newsgroup is a useful place to get help if you
350 have trouble getting your ppp connections to work.  Please do not send
351 me questions of the form "please help me get connected to my ISP" -
352 I'm sorry, but I simply do not have the time to answer all the
353 questions like this that I get.
354
355 If you find bugs in this package, please report them to the maintainer
356 for the port for the operating system you are using:
357
358 Linux                   Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
359 Solaris 2               Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
360 SunOS 4.x               Paul Mackerras (for want of anybody better :-)
361 Digital Unix (OSF/1)    Sowmini Varadhan <varadhan@zk3.dec.com>
362 NetBSD                  Matthew Green <mrg@eterna.com.au>
363 FreeBSD                 Peter Wemm <peter@haywire.DIALix.COM>
364 NeXTStep                Steve Perkins <perkins@cps.msu.edu>
365 System V Release 4      Matthias Apitz <Matthias.Apitz@SOFTCON.de>
366 Ultrix 4.x              Paul Mackerras (for want of anybody better :-)
367
368
369 Copyrights:
370 ***********
371
372 All of the code can be freely used and redistributed.
373
374
375 Distribution:
376 *************
377
378 The primary site for releases of this software is:
379
380         ftp://cs.anu.edu.au/pub/software/ppp/
381
382
383 ($Id: README,v 1.16 1999/03/31 06:07:55 paulus Exp $)