usr.sbin/pppd/RELNOTES

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