usr.sbin/pppd/RELNOTES

   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         Digital Unix (OSF/1)            README.osf
  38         Linux                           README.linux
  39         NetBSD, FreeBSD                 README.bsd
  40         NeXTStep                        README.next
  41         Solaris 2                       README.sol2
  42         SunOS 4.x                       README.sunos4
  43         System V Release 4              README.svr4
  44         Ultrix 4.x                      README.ultrix
  45
  46 Unfortunately, AIX 4 is no longer supported, since I don't have a
  47 maintainer for the AIX 4 port.  If you want to volunteer, contact me.
  48 The Ultrix port is untested, as I no longer have access to an Ultrix
  49 box.
  50
  51 In each case you start by running the ./configure script.  This works
  52 out which operating system you are using and creates symbolic links to
  53 the appropriate makefiles.  You then run `make' to compile the
  54 user-level code, and (as root) `make install' to install the
  55 user-level programs pppd, chat and pppstats.
  56
  57 The procedures for installing the kernel code vary from system to
  58 system.  On some systems, the kernel code can be loaded into a running
  59 kernel using a `modload' facility.  On others, the kernel image has to
  60 be recompiled and the system rebooted.  See the README.* files for
  61 details.
  62
  63 N.B. Since 2.3.0, leaving the permitted IP addresses column of the
  64 pap-secrets or chap-secrets file empty means that no addresses are
  65 permitted.  You need to put a "*" in that column to allow the peer to
  66 use any IP address.  (This only applies where the peer is
  67 authenticating itself to you, of course.)
  68
  69
  70 What's new in ppp-2.3.5.
  71 ************************
  72
  73 * Minor corrections to the Digital UNIX and NetBSD ports.
  74
  75 * A workaround to avoid tickling a bug in the `se' serial port driver
  76 on Sun PCI Ultra machines running Solaris.
  77
  78 * Fixed a bug in the negotiation of the Microsoft WINS server address
  79 option.
  80
  81 * Fixed a bug in the Linux port where it would fail for kernel
  82 versions above 2.1.99.
  83
  84
  85 What was new in ppp-2.3.4.
  86 **************************
  87
  88 * The NeXT port has been updated, thanks to Steve Perkins.
  89
  90 * ppp-2.3.4 compiles and works under Solaris 2.6, using either gcc or
  91 cc.
  92
  93 * With the Solaris, SVR4 and SunOS ports, you can control the choice
  94 of C compiler, C compiler options, and installation directories by
  95 editing the svr4/Makedefs or sunos4/Makedefs file.
  96
  97 * Until now, we have been using the number 24 to identify Deflate
  98 compression in the CCP negotiations, which was the number in the draft
  99 RFC describing Deflate.  The number actually assigned to Deflate is
 100 26.  The code has been changed to use 26, but to allow the use of 24
 101 for now for backwards compatibility.  (This can be disabled with the
 102 `nodeflatedraft' option to pppd.)
 103
 104 * Fixed some bugs in the linux driver and deflate compressor which
 105 were causing compression problems, including corrupting long
 106 incompressible packets sometimes.
 107
 108 * Fixes to the PAM and shadow password support in pppd, from Al
 109 Longyear and others.
 110
 111 * Pppd now sets some environment variables for scripts it invokes
 112 (ip-up/down, auth-ip/down), giving information about the connection.
 113 The variables it sets are PEERNAME, IPLOCAL, IPREMOTE, UID, DEVICE,
 114 SPEED, and IFNAME.
 115
 116 * Pppd now has an `updetach' option, which will cause it to detach
 117 from its controlling terminal once the link has come up (i.e. once it
 118 is available for IP traffic).
 119
 120
 121 What was new in ppp-2.3.3.
 122 **************************
 123
 124 * Fixed compilation problems under SunOS.
 125
 126 * Fixed a bug introduced into chat in 2.3.2, and compilation problems
 127 introduced into the MS-CHAP implementation in 2.3.2.
 128
 129 * The linux kernel driver has been updated for recent 2.1-series
 130 kernel changes, and it now will ask kerneld to load compression
 131 modules when required, if the kernel is configured to support kerneld.
 132
 133 * Pppd should now compile correctly under linux on systems with glibc.
 134
 135
 136 What was new in ppp-2.3.2.
 137 **************************
 138
 139 * In 2.3.1, I made a change which was intended to make pppd able to
 140 detect loss of CD during or immediately after the connection script
 141 runs.  Unfortunately, this had the side-effect that the connection
 142 script wouldn't work at all on some systems.  This change has been
 143 reversed.
 144
 145 * Fix compilation problems in the Linux kernel driver.
 146
 147
 148 What was new in ppp-2.3.1.
 149 **************************
 150
 151 * Enhancements to chat, thanks to Francis Demierre.  Chat can now
 152 accept comments in the chat script file, and has new SAY, HANGUP,
 153 CLR_ABORT and CLR_REPORT keywords.
 154
 155 * Fixed a bug which causes 2.3.0 to crash Solaris systems.
 156
 157 * Bug-fixes and restructuring of the Linux kernel driver.
 158
 159 * The holdoff behaviour of pppd has been changed slightly: now, if
 160 the link comes up for IP (or other network protocol) traffic, we
 161 consider that the link has been successfully established, and don't
 162 enforce the holdoff period after the link goes down.
 163
 164 * Pppd should now correctly wait for CD (carrier detect) from the
 165 modem, even when the serial port initially had CLOCAL set, and it
 166 should also detect loss of CD during or immediately after the
 167 connection script runs.
 168
 169 * Under linux, pppd will work with older 2.2.0* version kernel
 170 drivers, although demand-dialling is not supported with them.
 171
 172 * Minor bugfixes for pppd.
 173
 174
 175 What was new in ppp-2.3.
 176 ************************
 177
 178 * Demand-dialling.  Pppd now has a mode where it will establish the
 179 network interface immediately when it starts, but not actually bring
 180 the link up until it sees some data to be sent.  Look for the demand
 181 option description in the pppd man page.  Demand-dialling is not
 182 supported under Ultrix or NeXTStep.
 183
 184 * Idle timeout.  Pppd will optionally terminate the link if no data
 185 packets are sent or received within a certain time interval.
 186
 187 * Pppd now runs the /etc/ppp/auth-up script, if it exists, when the
 188 peer successfully authenticates itself, and /etc/ppp/auth-down when
 189 the connection is subsequently terminated.  This can be useful for
 190 accounting purposes.
 191
 192 * A new packet compression scheme, Deflate, has been implemented.
 193 This uses the same compression method as `gzip'.  This method is free
 194 of patent or copyright restrictions, and it achieves better
 195 compression than BSD-Compress.  It does consume more CPU cycles for
 196 compression than BSD-Compress, but this shouldn't be a problem for
 197 links running at 100kbit/s or less.
 198
 199 * There is no code in this distribution which is covered by Brad
 200 Clements' restrictive copyright notice.  The STREAMS modules for SunOS
 201 and OSF/1 have been rewritten, based on the Solaris 2 modules, which
 202 were written from scratch without any Clements code.
 203
 204 * Pppstats has been reworked to clean up the output format somewhat.
 205 It also has a new -d option which displays data rate in kbyte/s for
 206 those columns which would normally display bytes.
 207
 208 * Pppd options beginning with - or + have been renamed, e.g. -ip
 209 became noip, +chap became require-chap, etc.  The old options are
 210 still accepted for compatibility but may be removed in future.
 211
 212 * Pppd now has some options (such as the new `noauth' option) which
 213 can only be specified if it is being run by root, or in an
 214 "privileged" options file: /etc/ppp/options or an options file in the
 215 /etc/ppp/peers directory.  There is a new "call" option to read
 216 options from a file in /etc/ppp/peers, making it possible for non-root
 217 users to make unauthenticated connections, but only to certain trusted
 218 peers.  My intention is to make the `auth' option the default in a
 219 future release.
 220
 221 * Several minor new features have been added to pppd, including the
 222 maxconnect and welcome options.  Pppd will now terminate the
 223 connection when there are no network control protocols running.  The
 224 allowed IP address(es) field in the secrets files can now specify
 225 subnets (with a notation like 123.45.67.89/24) and addresses which are
 226 not acceptable (put a ! on the front).
 227
 228 * Numerous bugs have been fixed (no doubt some have been introduced :-)
 229 Thanks to those who reported bugs in ppp-2.2.
 230
 231
 232 Patents.
 233 ********
 234
 235 The BSD-Compress algorithm used for packet compression is the same as
 236 that used in the Unix "compress" command.  It is apparently covered by
 237 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
 238 and corresponding patents in various other countries (but not
 239 Australia).  If this is of concern, you can build the package without
 240 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
 241 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
 242 longer needed, so the references to bsd-comp.o may optionally be
 243 removed from the Makefiles.
 244
 245
 246 Contacts.
 247 *********
 248
 249 The comp.protocols.ppp newsgroup is a useful place to get help if you
 250 have trouble getting your ppp connections to work.  Please do not send
 251 me questions of the form "please help me get connected to my ISP" -
 252 I'm sorry, but I simply do not have the time to answer all the
 253 questions like this that I get.
 254
 255 If you find bugs in this package, please report them to the maintainer
 256 for the port for the operating system you are using:
 257
 258 Digital Unix (OSF/1)    Farrell Woods <ftw@zk3.dec.com>
 259 Linux                   Al Longyear <longyear@pobox.com>
 260 NetBSD                  Matthew Green <mrg@eterna.com.au
 261 FreeBSD                 Peter Wemm <peter@haywire.DIALix.COM>
 262 NeXTStep                Steve Perkins <perkins@cps.msu.edu>
 263 Solaris 2               Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
 264 SunOS 4.x               Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
 265 System V Release 4      Matthias Apitz <Matthias.Apitz@SOFTCON.de>
 266 Ultrix 4.x              Paul Mackerras (for want of anybody better :-)
 267
 268
 269 Copyrights:
 270 ***********
 271
 272 All of the code can be freely used and redistributed.
 273
 274
 275 Distribution:
 276 *************
 277
 278 The primary site for releases of this software is:
 279
 280         ftp://cs.anu.edu.au/pub/software/ppp/
 281
 282 -------------------------
 283 This is the README file for ppp-2.2, a package which implements the
 284 Point-to-Point Protocol (PPP) to provide Internet connections over
 285 serial lines.
 286
 287
 288 Introduction.
 289 *************
 290
 291 The Point-to-Point Protocol (PPP) provides a standard way to transmit
 292 datagrams over a serial link, as well as a standard way for the
 293 machines at either end of the link (the `peers') to negotiate various
 294 optional characteristics of the link.  Using PPP, a serial link can be
 295 used to transmit Internet Protocol (IP) datagrams, allowing TCP/IP
 296 connections between the peers.  PPP is defined in several RFC (Request
 297 For Comments) documents, in particular RFCs 1661, 1662, 1332 and 1334.
 298 Other RFCs describe standard ways to transmit datagrams from other
 299 network protocols (e.g., DECnet, OSI, Appletalk), but this package
 300 only supports IP.
 301
 302 This software consists of two parts:
 303
 304 - Kernel code, which establishes a network interface and passes
 305 packets between the serial port, the kernel networking code and the
 306 PPP daemon (pppd).  This code is implemented using STREAMS modules on
 307 SunOS 4.x, AIX 4.1 and OSF/1, and as a line discipline under Ultrix,
 308 NextStep, NetBSD, FreeBSD, and Linux.
 309
 310 - The PPP daemon (pppd), which negotiates with the peer to establish
 311 the link and sets up the ppp network interface.  Pppd includes support
 312 for authentication, so you can control which other systems may make a
 313 PPP connection and what IP addresses they may use.
 314
 315
 316 What is new in ppp-2.2.
 317 ***********************
 318
 319 * More systems are now supported:
 320
 321   AIX 4, thanks to Charlie Wick,
 322   OSF/1 on DEC Alpha, thanks to Steve Tate (srt@zaphod.csci.unt.edu),
 323   NextStep 3.2 and 3.3, thanks to Philip-Andrew Prindeville
 324         (philipp@res.enst.fr) and Steve Perkins (perkins@cps.msu.edu),
 325   Solaris 2,
 326
 327 in addition to NetBSD 1.0, SunOS 4.x, Ultrix 4.x, FreeBSD 2.0, and
 328 Linux.
 329
 330 * Packet compression has been implemented.  This version implements
 331 CCP (Compression Control Protocol) and the BSD-Compress compression
 332 scheme according to the current draft RFCs.  This means that incoming
 333 and outgoing packets can be compressed with the LZW scheme (same as
 334 the `compress' command) using a code size of up to 15 bits.
 335
 336 * Some bug fixes to the LCP protocol code.  In particular, pppd now
 337 correctly replies with a Configure-NAK (instead of a Configure-Reject)
 338 if the peer asks for CHAP and pppd is willing to do PAP but not CHAP.
 339
 340 * The ip-up and ip-down scripts are now run with the real user ID set
 341 to root, and with an empty environment.  Clearing the environment
 342 fixes a security hole.
 343
 344 * The kernel code on NetBSD, FreeBSD, NextStep and Ultrix has been
 345 restructured to make it easier to implement PPP over devices other
 346 than asynchronous tty ports (for example, synchronous serial ports).
 347
 348 * pppd now looks at the list of interfaces in the system to determine
 349 what the netmask should be.  In most cases, this should eliminate the
 350 need to use the `netmask' option.
 351
 352 * There is a new `papcrypt' option to pppd, which specifies that
 353 secrets in /etc/ppp/pap-secrets used for authenticating the peer are
 354 encrypted, so pppd always encrypts the peer's password before
 355 comparing it with the secret from /etc/ppp/pap-secrets.  This gives
 356 better security.
 357
 358
 359 Patents.
 360 ********
 361
 362 The BSD-Compress algorithm used for packet compression is the same as
 363 that used in the Unix "compress" command.  It is apparently covered by
 364 U.S. patents 4,814,746 (owned by IBM) and 4,558,302 (owned by Unisys),
 365 and corresponding patents in various other countries (but not
 366 Australia).  If this is of concern, you can build the package without
 367 including BSD-Compress.  To do this, edit net/ppp-comp.h to change the
 368 definition of DO_BSD_COMPRESS to 0.  The bsd-comp.c files are then no
 369 longer needed, so the references to bsd-comp.o may optionally be
 370 removed from the Makefiles.
 371
 372
 373 Contacts.
 374 *********
 375
 376 Bugs in the the SunOS, NetBSD and Ultrix ports and bugs in pppd, chat
 377 or pppstats should be reported to:
 378
 379         paulus@cs.anu.edu.au
 380         Paul Mackerras
 381         Dept. of Computer Science
 382         Australian National University
 383         Canberra  ACT  0200
 384         AUSTRALIA
 385
 386 Bugs in other ports should be reported to the maintainer for that port
 387 (see the appropriate README.* file) or to the above.  Unfortunately,
 388 Charlie Wick is not in a position to provide support for the AIX 4
 389 port, so if you find bugs in it, send them to me.
 390
 391 Thanks to:
 392
 393         Brad Parker  (brad@fcr.com)
 394         Greg Christy (gmc@quotron.com)
 395         Drew D. Perkins (ddp@andrew.cmu.edu)
 396         Rick Adams (rick@seismo.ARPA)
 397         Chris Torek (chris@mimsy.umd.edu, umcp-cs!chris).
 398
 399
 400 Copyrights:
 401
 402 Most of the code can be freely used and redistributed.  The STREAMS
 403 code for SunOS 4.x, OSF/1 and AIX 4 is under a more restrictive
 404 copyright:
 405
 406         This code is Copyright (C) 1989, 1990 By Brad K. Clements,
 407         All Rights Reserved.
 408
 409         You may use this code for your personal use, to provide a non-profit
 410         service to others, or to use as a test platform for a commercial
 411         implementation.
 412
 413         You may NOT use this code in a commercial product, nor to provide a
 414         commercial service, nor may you sell this code without express
 415         written permission of the author.
 416
 417         Otherwise, Enjoy!
 418
 419 This copyright applies to (parts of) the following files:
 420
 421         sunos/ppp_async.c
 422         sunos/ppp_if.c
 423         aix4/ppp_async.c
 424         aix4/ppp_if.c
 425         net/ppp_str.h
 426         pppd/sys-str.c
 427         pppd/sys-osf.c
 428         pppd/sys-aix4.c
 429 -------------------------
 430                 pppd-2.1.1 release notes
 431                 Paul Mackerras   27 May 1994
 432
 433 This file details the new and changed features in pppd since version 1.3.
 434 Briefly:
 435         - the protocol code has been updated to conform with
 436           RFCs 1548, 1549, 1332 and 1334
 437         - security has been improved
 438         - functionality has been improved in various ways.
 439
 440
 441 NEW FEATURES
 442
 443 * The option negotiation automaton has been updated to RFC1548.  LCP
 444 now rejects the Quality Protocol option, since LQR is not implemented
 445 yet.  IPCP now uses the IP-Address option, and falls back to the old
 446 IP-Addresses option if the IP-Address option is rejected.  IPCP also
 447 uses the new form of the VJ-Compression option.
 448
 449 RFC1548 defines the "passive" option to mean that the automaton
 450 outputs configure-request packets initially, but does not close down
 451 if no answer is received.  A valid configure-request received will
 452 restart the negotiation.  The "silent" option has been added with the
 453 old meaning of "passive", i.e. the automaton will not output
 454 configure-requests until it receives a valid one from the peer.
 455
 456 * More systems are supported: in addition to SunOS 4.x and BSD/Net-2
 457 derived systems, Ultrix and Linux are supported, thanks to Robert
 458 Olsson, Per Sundstrom, Michael Callahan and Al Longyear.
 459
 460 * Options can be taken from files as well as the command line.  pppd
 461 reads options from the files /etc/ppp/options and ~/.ppprc before
 462 looking at the command line, and /etc/ppp/options.<ttyname> after
 463 interpreting the options on the command line.  An options file is
 464 parsed into a series of words, delimited by whitespace.  Whitespace
 465 can be included in a word by enclosing the word in quotes (").
 466 Backslash (\) quotes the following character.  A hash (#) starts a
 467 comment, which continues until the end of the line.  In addition, the
 468 `file' option causes pppd to read options from a file.  pppd will
 469 report and error and exit if ~/.ppprc or the file given as the
 470 argument to the `file' option cannot be read by the user who invoked
 471 pppd.
 472
 473 * On those systems, such as NetBSD, where the serial line speed is
 474 stored in the termios structure in bits per second (i.e. B9600 ==
 475 9600), it is possible to set any speed.
 476
 477 * If desired, pppd will output LCP echo-request frames periodically
 478 while the link is up, and take the link down if no replies are
 479 received to a user-configurable number of echo-requests.  This can be
 480 used to detect that the serial connection has been broken on those
 481 systems which don't have hardware modem control lines.
 482
 483 AUTHENTICATION
 484
 485 Previous versions of pppd have provided no control over which IP
 486 addresses the peer can use.  Thus it is possible for the peer to
 487 impersonate another host on the local network, leading to various
 488 security holes.  In addition, the authentication mechanisms were quite
 489 weak: if the peer refused to agree to authenticate, pppd would print a
 490 warning message but still allow the link to come up.  The CHAP
 491 implementation also appeared to be quite broken (has anybody actually
 492 used it?).
 493
 494 This new version of pppd addresses these problems.  My aim has been to
 495 provide system administrators with sufficient access control that PPP
 496 access to a server machine can be provided to legitimate users without
 497 fear of compromising the security of the server or the network it's
 498 on.  In part this is provided by the /etc/ppp/options file, where the
 499 administrator can place options to require authentication which cannot
 500 be disabled by users.  Thus the new pppd can made setuid-root and run
 501 by users.
 502
 503 The behaviour where pppd refuses to run unless the /etc/ppp/options
 504 file is present and readable by pppd is now the default behaviour.  If
 505 you really want pppd to run without the presence of the
 506 /etc/ppp/options file, you will have to include -DREQ_SYSOPTIONS=0 on
 507 the compilation command line.
 508
 509 The options related to authentication are:
 510
 511     auth        Require authentication from the peer.  If neither
 512                 +chap or +pap is also given, either CHAP or PAP
 513                 authentication will be accepted.
 514     +chap       Require CHAP authentication from the peer.
 515     +pap        Require PAP authentication from the peer.
 516     -chap       Don't agree to authenticate ourselves with the peer
 517                 using CHAP.
 518     -pap        Don't agree to authenticate ourselves using PAP.
 519     +ua <f>     Get username and password for authenticating ourselves
 520                 with the peer using PAP from file <f>.
 521     name <n>    Use <n> as the local name for authentication.
 522     usehostname Use this machine's hostname as the local name for
 523                 authentication.
 524     remotename <n>  Use <n> as the name of the peer for authentication.
 525     login       If the peer authenticates using PAP, check the
 526                 supplied username and password against the system
 527                 password database, and make a wtmp entry.
 528     user <n>    Use <n> as the username for authenticating ourselves
 529                 using PAP.
 530
 531 The defaults are to agree to authenticate if requested, and to not
 532 require authentication from the peer.  However, pppd will not agree to
 533 authenticate itself with a particular protocol if it has no secrets
 534 which could be used to do so.
 535
 536 Authentication is based on secrets, which are selected from secrets
 537 files (/etc/ppp/pap-secrets for PAP, /etc/ppp/chap-secrets for CHAP).
 538 Both secrets files have the same format, and both can store secrets
 539 for several combinations of server (authenticating peer) and client
 540 (peer being authenticated).  Note that each end can be both a server
 541 and client, and that different protocols can be used in the two
 542 directions if desired.
 543
 544 A secrets file is parsed into words as for a options file.  A secret
 545 is specified by a line containing at least 3 words, in the order
 546 client, server, secret.  Any following words on the same line are
 547 taken to be a list of acceptable IP addresses for that client.  If
 548 there are only 3 words on the line, it is assumed that any IP address
 549 is OK; to disallow all IP addresses, use "-".  If the secret starts
 550 with an `@', what follows is assumed to be the name of a file from
 551 which to read the secret.  A "*" as the client or server name matches
 552 any name.  When selecting a secret, pppd takes the best match, i.e.
 553 the match with the fewest wildcards.
 554
 555 Thus a secrets file contains both secrets for use in authenticating
 556 other hosts, plus secrets which we use for authenticating ourselves to
 557 others.  Which secret to use is chosen based on the names of the host
 558 (the `local name') and its peer (the `remote name').  The local name
 559 is set as follows:
 560
 561         if the `usehostname' option is given,
 562         then the local name is the hostname of this machine
 563                 (with the domain appended, if given)
 564
 565         else if the `name' option is given,
 566         then use the argument of the first `name' option seen
 567
 568         else if the local IP address is specified with a
 569                 host name (e.g. `sirius:')
 570         then use that host name
 571
 572         else use the hostname of this machine
 573                 (with the domain appended, if given)
 574
 575 When authenticating ourselves using PAP, there is also a `username'
 576 which is the local name by default, but can be set with the `user'
 577 option or the `+ua' option.
 578
 579 The remote name is set as follows:
 580
 581         if the `remotename' option is given,
 582         then use the argument of the last `remotename' option seen
 583
 584         else if the remote IP address is specified with a
 585                 host name (e.g. `avago:')
 586         then use that host name
 587
 588         else the remote name is the null string "".
 589
 590 Secrets are selected from the PAP secrets file as follows:
 591
 592 - For authenticating the peer, look for a secret with client ==
 593 username specified in the PAP authenticate-request, and server ==
 594 local name.
 595
 596 - For authenticating ourselves to the peer, look for a secret with
 597 client == our username, server == remote name.
 598
 599 When authenticating the peer with PAP, a secret of "" matches any
 600 password supplied by the peer.  If the password doesn't match the
 601 secret, the password is encrypted using crypt() and checked against
 602 the secret again; thus secrets for authenticating the peer can be
 603 stored in encrypted form.  If the `login' option was specified, the
 604 username and password are also checked against the system password
 605 database.  Thus, the system administrator can set up the pap-secrets
 606 file to allow PPP access only to certain users, and to restrict the
 607 set of IP addresses that each user can use.
 608
 609 Secrets are selected from the CHAP secrets file as follows:
 610
 611 - For authenticating the peer, look for a secret with client == name
 612 specified in the CHAP-Response message, and server == local name.
 613
 614 - For authenticating ourselves to the peer, look for a secret with
 615 client == local name, and server == name specified in the
 616 CHAP-Challenge message.
 617
 618 Authentication must be satisfactorily completed before IPCP (or any
 619 other Network Control Protocol) can be started.  If authentication
 620 fails, pppd will terminated the link (by closing LCP).  If IPCP
 621 negotiates an unacceptable IP address for the remote host, IPCP will
 622 be closed.  IP packets cannot be sent or received until IPCP is
 623 successfully opened.
 624
 625 (some examples needed here perhaps)
 626
 627
 628 ROUTING
 629
 630 Setting the addresses on a ppp interface is sufficient to create a
 631 host route to the remote end of the link.  Sometimes it is desirable
 632 to add a default route through the remote host, as in the case of a
 633 machine whose only connection to the Internet is through the ppp
 634 interface.  The `defaultroute' option causes pppd to create such a
 635 default route when IPCP comes up, and delete it when the link is
 636 terminated.
 637
 638 In some cases it is desirable to use proxy ARP, for example on a
 639 server machine connected to a LAN, in order to allow other hosts to
 640 communicate with the remote host.  The `proxyarp' option causes pppd
 641 to look for a network interface (an interface supporting broadcast and
 642 ARP, which is up and not a point-to-point or loopback interface) on
 643 the same subnet as the remote host.  If found, pppd creates a
 644 permanent, published ARP entry with the IP address of the remote host
 645 and the hardware address of the network interface found.
 646
 647
 648 OTHER NEW AND CHANGED OPTIONS
 649
 650     modem               Use modem control lines (not fully implemented
 651                         yet)
 652     local               Don't use modem control lines
 653     persist             Keep reopening connection (not fully
 654                         implemented yet)
 655
 656     lcp-restart <n>     Set timeout for LCP retransmissions to <n>
 657                         seconds (default 3 seconds)
 658     lcp-max-terminate <n> Set maximum number of LCP terminate-request
 659                         transmissions (default 2)
 660     lcp-max-configure <n> Set maximum number of LCP configure-request
 661                         transmissions (default 10)
 662     lcp-max-failure <n> Set maximum number of LCP configure-Naks sent
 663                         before converting to configure-rejects
 664                         (default 10)
 665
 666     ipcp-restart <n>    Set timeout for IPCP retransmissions to <n>
 667                         seconds (default 3 seconds)
 668     ipcp-max-terminate <n> Set maximum number of IPCP
 669                         terminate-request transmissions (default 2)
 670     ipcp-max-configure <n> Set maximum number of IPCP
 671                         configure-request transmissions (default 10)
 672     ipcp-max-failure <n> Set maximum number of IPCP configure-Naks
 673                         sent before converting to configure-rejects
 674                         (default 10)
 675
 676     upap-restart <n>    Set timeout for PAP retransmissions to
 677                         <n> seconds (default 3 seconds)
 678     upap-max-authreq <n> Set maximum number of Authenticate-request
 679                         retransmissions (default 10)
 680
 681     chap-restart <n>    Set timeout for CHAP retransmissions to
 682                         <n> seconds (default 3 seconds)
 683     chap-max-challenge <n> Set maximum number of CHAP Challenge
 684                         retransmissions (default 10)
 685     chap-interval <n>   Set the interval between CHAP rechallenges
 686                         (default 0, meaning infinity)
 687
 688 The -ua option no longer exists.
 689
 690
 691 SOFTWARE RESTRUCTURING
 692
 693 Many of the source files for pppd have changed significantly from
 694 ppp-1.3, upon which it is based.  In particular:
 695
 696 - the macros for system-dependent operations in pppd.h have mostly
 697 been removed.  Instead these operations are performed by procedures in
 698 sys-bsd.c (for BSD-4.4ish systems like NetBSD, 386BSD, etc.) or
 699 sys-str.c (for SunOS-based systems using STREAMS).  (I got sick of
 700 having to recompile everything every time I wanted to change one of
 701 those horrible macros.)
 702
 703 - most of the system-dependent code in main.c has also been removed to
 704 sys-bsd.c and sys-str.c.
 705
 706 - the option processing code in main.c has been removed to options.c.
 707
 708 - the authentication code in main.c has been removed to auth.c, which
 709 also contains substantial amounts of new code.
 710
 711 - fsm.c has changed significantly, and lcp.c, ipcp.c, and upap.c have
 712 changed somewhat.  chap.c has also changed significantly.
 713
 714
 715 STILL TO DO
 716
 717 * sort out appropriate modem control and implement the persist option
 718 properly; add an `answer' option for auto-answering a modem.
 719
 720 * add an inactivity timeout and demand dialing.
 721
 722 * implement link quality monitoring.
 723
 724 * implement other network control protocols.