update for 2.3.9 final
[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.9.
73 ************************
74
75 * Support for the new generic PPP layer under development for the
76   Linux kernel.
77
78 * You can now place extra options to apply to specific users at the
79   end of the line with their password in the pap-secrets or
80   chap-secrets file, separated from the IP address(es) with a "--"
81   separator.  These options are parsed after the peer is authenticated
82   but before network protocol (IPCP, IPXCP) or CCP negotiation
83   commences.
84
85 * Pppd will apply the holdoff period if the link was terminated by the
86   peer.  It doesn't apply it if the link was terminated because the
87   local pppd thought it was idle.
88
89 * Synchronous support for Solaris has been added, thanks to John
90   Morrison, and for FreeBSD, thanks to Paul Fulghum.
91
92 * IPV6 support has been merged in, from Tommi Komulainen.  At the
93   moment it only supports Linux and it is not tested by me.
94
95 * The `nodefaultip' option can be used in demand mode to say that pppd
96   should not suggest its local IP address to the peer.
97
98 * The `init' option has been added; this causes pppd to run a script
99   to initialize the serial device (e.g. by sending an init string to
100   the modem).  Unlike the connect option, this can be used in a
101   dial-in situation.  (Thanks to Tobias Ringstrom.)
102
103 * There is a new `logfile' option to send log messages to a file as
104   well as syslog.
105
106 * There is a new, privileged `linkname' option which sets a logical
107   name for the link.  Pppd will create a /var/run/ppp-<linkname>.pid
108   file containing its process ID.
109
110 * There is a new `maxfail' option which specifies how many consecutive
111   failed connection attempts are permitted before pppd will exit.  The
112   default value is 10, and 0 means infinity. :-)
113
114 * Sundry bugs fixed.
115
116
117 What was new in ppp-2.3.8.
118 **************************
119
120 * The exit status of pppd will now indicate whether the link was
121   successfully established, or if not, what error was encountered.
122
123 * Pppd has two new options: fdlog <n> will send log messages to file
124   descriptor <n> instead of standard output, and nofdlog will stop log
125   messages from being sent to any file descriptor (they will still be
126   sent to syslog).  Pppd now will not send log messages to a file
127   descriptor if the serial port is open on that file descriptor.
128
129 * Pppd sets an environment variable called PPPLOGNAME for scripts that
130   it runs, indicating the login name of the user who invoked pppd.
131
132 * Pppd sets environment variables CONNECT_TIME, BYTES_SENT and
133   BYTES_RCVD for the ip-down and auth-down scripts indicating the
134   statistics for the connection just terminated.  (CONNECT_TIME is in
135   seconds.)
136
137 * If the user has the serial device open on standard input and
138   specifies a symbolic link to the serial device on the command line,
139   pppd will detect this and behave correctly (i.e. not detach from its
140   controlling terminal).  Furthermore, if the serial port is open for
141   reading and writing on standard input, pppd will assume that it is
142   locked by its invoker and not lock it itself.
143
144 * Chat now has a feature where if a string to be sent begins with an
145   at sign (@), the rest of the string is taken as the name of a file
146   (regular file or named pipe), and the actual string to send is taken
147   from that file.
148
149 * Support for FreeBSD-2.2.8 and 3.0 has been added, thanks to Paul
150   Fulghum.
151
152 * The Tru64 (aka Digital Unix aka OSF/1) port has been updated.
153
154 * The system panics on Solaris SMP systems related to PPP connections
155   being established and terminated should no longer occur.
156
157 * Fixed quite a few bugs.
158
159
160 What was new in ppp-2.3.7.
161 **************************
162
163 * Pppd can now automatically allocate itself a pseudo-tty to use as
164   the serial device.  This has made three new options possible:
165
166   - `pty script' will run `script' with its standard input and output
167     connected to the master side of the pty.  For example:
168         pppd pty 'ssh -t server.my.net pppd'
169     is a basic command for setting up a PPP link (tunnel) over ssh.
170     (In practice you may need to specify other options such as IP
171     addresses, etc.)
172
173   - `notty' tells pppd to communicate over its standard input and
174     output, which do not have to be a terminal device.
175
176   - `record filename' tells pppd to record all of the characters sent
177     and received over the serial device to a file called `filename'.
178     The data is recorded in a tagged format with timestamps, which can
179     be printed in a readable form with the pppdump program, which is
180     included in this distribution.
181
182 * Pppd now logs the connect time and number of bytes sent and received
183   (at the level of the serial device) when the connection is
184   terminated.
185
186 * If you use the updetach or nodetach option, pppd will print its
187   messages to standard output as well as logging them with syslog
188   (provided of course pppd isn't using its standard input or output as
189   its serial device).
190
191 * There is a new `privgroup groupname' option (a privileged option).
192   If the user running pppd is in group `groupname', s/he can use
193   privileged options without restriction.
194
195 * There is a new `receive-all' option, which causes pppd to accept all
196   control characters, even the ones that the peer should be escaping
197   (i.e. the receive asyncmap is 0).  This is useful with some buggy
198   peers.
199
200 * The default asyncmap is now 0.
201
202 * There is a new `sync' option, currently only implemented under
203   Linux, which allows pppd to run on synchronous HDLC devices.
204
205 * If a value for the device name or for the connect, disconnect,
206   welcome or pty option is given in a privileged option file
207   (i.e. /etc/ppp/options or a file loaded with the `call' option), it
208   cannot be overridden by a non-privileged user.
209
210 * Many bugs have been fixed, notably:
211   - signals are not blocked unnecessarily, as they were in 2.3.6.
212   - the usepeerdns option should work now.
213   - the SPEED environment variable for scripts is set correctly.
214   - the /etc/ppp/auth-down script is not run until auth-up completes.
215   - the device is opened as root if it is the device on standard
216     input.
217   - pppd doesn't die with the ioctl(PPPIOCSASYNCMAP) error under linux
218     if a hangup occurs at the wrong time.
219
220 * Some error messages have been changed to be clearer (I hope :-)
221
222
223 What was new in ppp-2.3.6.
224 **************************
225
226 * Pppd now opens the tty device as the user (rather than as root) if
227   the device name was given by the user, i.e. on the command line or
228   in the ~/.ppprc file.  If the device name was given in
229   /etc/ppp/options or in a file loaded with the `call' option, the
230   device is opened as root.
231
232 * The default behaviour of pppd is now to let a peer which has not
233   authenticated itself (e.g. your ISP) use any IP address to which the
234   system does not already have a route.  (This is currently only
235   supported under Linux, Solaris and Digital Unix; on the other
236   systems, the peer must now authenticate itself unless the noauth
237   option is used.)
238
239 * Added new option `usepeerdns', thanks to Nick Walker
240   <nickwalker@email.com>.  If the peer supplies DNS addresses, these
241   will be written to /etc/ppp/resolv.conf.  The ip-up script can then
242   be used to add these addresses to /etc/resolv.conf if desired (see
243   the ip-up.local.add and ip-down.local.add files in the scripts
244   directory).
245
246 * The Solaris ppp driver should now work correctly on SMP systems.
247
248 * Minor corrections so that the code can compile under Solaris 7,
249   and under Linux with glibc-2.1.
250
251 * The Linux kernel driver has been restructured for improved
252   performance.
253
254 * Pppd now won't start the ip-down script until the ip-up script has
255   finished.
256
257
258 What was new in ppp-2.3.5.
259 **************************
260
261 * Minor corrections to the Digital UNIX and NetBSD ports.
262
263 * A workaround to avoid tickling a bug in the `se' serial port driver
264 on Sun PCI Ultra machines running Solaris.
265
266 * Fixed a bug in the negotiation of the Microsoft WINS server address
267 option.
268
269 * Fixed a bug in the Linux port where it would fail for kernel
270 versions above 2.1.99.
271
272
273 What was new in ppp-2.3.4.
274 **************************
275
276 * The NeXT port has been updated, thanks to Steve Perkins.
277
278 * ppp-2.3.4 compiles and works under Solaris 2.6, using either gcc or
279 cc.
280
281 * With the Solaris, SVR4 and SunOS ports, you can control the choice
282 of C compiler, C compiler options, and installation directories by
283 editing the svr4/Makedefs or sunos4/Makedefs file.
284
285 * Until now, we have been using the number 24 to identify Deflate
286 compression in the CCP negotiations, which was the number in the draft
287 RFC describing Deflate.  The number actually assigned to Deflate is
288 26.  The code has been changed to use 26, but to allow the use of 24
289 for now for backwards compatibility.  (This can be disabled with the
290 `nodeflatedraft' option to pppd.)
291
292 * Fixed some bugs in the linux driver and deflate compressor which
293 were causing compression problems, including corrupting long
294 incompressible packets sometimes.
295
296 * Fixes to the PAM and shadow password support in pppd, from Al
297 Longyear and others.
298
299 * Pppd now sets some environment variables for scripts it invokes
300 (ip-up/down, auth-ip/down), giving information about the connection.
301 The variables it sets are PEERNAME, IPLOCAL, IPREMOTE, UID, DEVICE,
302 SPEED, and IFNAME.
303
304 * Pppd now has an `updetach' option, which will cause it to detach
305 from its controlling terminal once the link has come up (i.e. once it
306 is available for IP traffic).
307
308
309 What was new in ppp-2.3.3.
310 **************************
311
312 * Fixed compilation problems under SunOS.
313
314 * Fixed a bug introduced into chat in 2.3.2, and compilation problems
315 introduced into the MS-CHAP implementation in 2.3.2.
316
317 * The linux kernel driver has been updated for recent 2.1-series
318 kernel changes, and it now will ask kerneld to load compression
319 modules when required, if the kernel is configured to support kerneld.
320
321 * Pppd should now compile correctly under linux on systems with glibc.
322
323
324 What was new in ppp-2.3.2.
325 **************************
326
327 * In 2.3.1, I made a change which was intended to make pppd able to
328 detect loss of CD during or immediately after the connection script
329 runs.  Unfortunately, this had the side-effect that the connection
330 script wouldn't work at all on some systems.  This change has been
331 reversed.
332
333 * Fix compilation problems in the Linux kernel driver.
334
335
336 What was new in ppp-2.3.1.
337 **************************
338
339 * Enhancements to chat, thanks to Francis Demierre.  Chat can now
340 accept comments in the chat script file, and has new SAY, HANGUP,
341 CLR_ABORT and CLR_REPORT keywords.
342
343 * Fixed a bug which causes 2.3.0 to crash Solaris systems.
344
345 * Bug-fixes and restructuring of the Linux kernel driver.
346
347 * The holdoff behaviour of pppd has been changed slightly: now, if
348 the link comes up for IP (or other network protocol) traffic, we
349 consider that the link has been successfully established, and don't
350 enforce the holdoff period after the link goes down.
351
352 * Pppd should now correctly wait for CD (carrier detect) from the
353 modem, even when the serial port initially had CLOCAL set, and it
354 should also detect loss of CD during or immediately after the
355 connection script runs.
356
357 * Under linux, pppd will work with older 2.2.0* version kernel
358 drivers, although demand-dialling is not supported with them.
359
360 * Minor bugfixes for pppd.
361
362
363 What was new in ppp-2.3.
364 ************************
365
366 * Demand-dialling.  Pppd now has a mode where it will establish the
367 network interface immediately when it starts, but not actually bring
368 the link up until it sees some data to be sent.  Look for the demand
369 option description in the pppd man page.  Demand-dialling is not
370 supported under Ultrix or NeXTStep.
371
372 * Idle timeout.  Pppd will optionally terminate the link if no data
373 packets are sent or received within a certain time interval.
374
375 * Pppd now runs the /etc/ppp/auth-up script, if it exists, when the
376 peer successfully authenticates itself, and /etc/ppp/auth-down when
377 the connection is subsequently terminated.  This can be useful for
378 accounting purposes.
379
380 * A new packet compression scheme, Deflate, has been implemented.
381 This uses the same compression method as `gzip'.  This method is free
382 of patent or copyright restrictions, and it achieves better
383 compression than BSD-Compress.  It does consume more CPU cycles for
384 compression than BSD-Compress, but this shouldn't be a problem for
385 links running at 100kbit/s or less.
386
387 * There is no code in this distribution which is covered by Brad
388 Clements' restrictive copyright notice.  The STREAMS modules for SunOS
389 and OSF/1 have been rewritten, based on the Solaris 2 modules, which
390 were written from scratch without any Clements code.
391
392 * Pppstats has been reworked to clean up the output format somewhat.
393 It also has a new -d option which displays data rate in kbyte/s for
394 those columns which would normally display bytes.
395
396 * Pppd options beginning with - or + have been renamed, e.g. -ip
397 became noip, +chap became require-chap, etc.  The old options are
398 still accepted for compatibility but may be removed in future.
399
400 * Pppd now has some options (such as the new `noauth' option) which
401 can only be specified if it is being run by root, or in an
402 "privileged" options file: /etc/ppp/options or an options file in the
403 /etc/ppp/peers directory.  There is a new "call" option to read
404 options from a file in /etc/ppp/peers, making it possible for non-root
405 users to make unauthenticated connections, but only to certain trusted
406 peers.  My intention is to make the `auth' option the default in a
407 future release.
408
409 * Several minor new features have been added to pppd, including the
410 maxconnect and welcome options.  Pppd will now terminate the
411 connection when there are no network control protocols running.  The
412 allowed IP address(es) field in the secrets files can now specify
413 subnets (with a notation like 123.45.67.89/24) and addresses which are
414 not acceptable (put a ! on the front).
415
416 * Numerous bugs have been fixed (no doubt some have been introduced :-)
417 Thanks to those who reported bugs in ppp-2.2.
418
419
420 Compression methods.
421 ********************
422
423 This package supports two packet compression methods: Deflate and
424 BSD-Compress.  Other compression methods which are in common use
425 include Predictor, LZS, and MPPC.  These methods are not supported for
426 two reasons - they are patent-encumbered, and they cause some packets
427 to expand slightly, which pppd doesn't currently allow for.
428 BSD-Compress is also patent-encumbered (its inclusion in this package
429 can be considered a historical anomaly :-) but it doesn't ever expand
430 packets.  Neither does Deflate, which uses the same algorithm as gzip.
431
432
433 Patents.
434 ********
435
436 The BSD-Compress algorithm used for packet compression is the same as
437 that used in the Unix "compress" command.  It is apparently covered by
438 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
439 and corresponding patents in various other countries (but not
440 Australia).  If this is of concern, you can build the package without
441 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
442 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
443 longer needed, so the references to bsd-comp.o may optionally be
444 removed from the Makefiles.
445
446
447 Contacts.
448 *********
449
450 The comp.protocols.ppp newsgroup is a useful place to get help if you
451 have trouble getting your ppp connections to work.  Please do not send
452 me questions of the form "please help me get connected to my ISP" -
453 I'm sorry, but I simply do not have the time to answer all the
454 questions like this that I get.
455
456 If you find bugs in this package, please report them to the maintainer
457 for the port for the operating system you are using:
458
459 Linux                   Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
460 Solaris 2               Paul Mackerras (for want of anybody better :-)
461 SunOS 4.x               Paul Mackerras (for want of anybody better :-)
462 Digital Unix (OSF/1)    Sowmini Varadhan <varadhan@zk3.dec.com>
463 NetBSD                  Matthew Green <mrg@eterna.com.au>
464 FreeBSD                 Peter Wemm <peter@haywire.DIALix.COM>
465 NeXTStep                Steve Perkins <perkins@cps.msu.edu>
466 System V Release 4      Matthias Apitz <Matthias.Apitz@SOFTCON.de>
467 Ultrix 4.x              Paul Mackerras (for want of anybody better :-)
468
469
470 Copyrights:
471 ***********
472
473 All of the code can be freely used and redistributed.  The individual
474 source files each have their own copyright and permission notice; some
475 have a BSD-style notice and some are under the GPL.
476
477
478 Distribution:
479 *************
480
481 The primary site for releases of this software is:
482
483         ftp://cs.anu.edu.au/pub/software/ppp/
484
485
486 ($Id: README,v 1.19 1999/08/13 01:54:02 paulus Exp $)