Enable PPP filtering by default on Linux.
[ppp.git] / pppd / pppd.8
1 .\" manual page [] for pppd 2.4
2 .\" $Id: pppd.8,v 1.74 2003/11/27 21:55:19 paulus Exp $
3 .\" SH section heading
4 .\" SS subsection heading
5 .\" LP paragraph
6 .\" IP indented paragraph
7 .\" TP hanging label
8 .\" 
9 .\" Copyright (c) 1993-2003 Paul Mackerras <paulus@samba.org>
10 .\"
11 .\" Permission to use, copy, modify, and distribute this software for any
12 .\" purpose with or without fee is hereby granted, provided that the above
13 .\" copyright notice and this permission notice appear in all copies.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
16 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
17 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
18 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
19 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
20 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
21 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 .\"
23 .TH PPPD 8
24 .SH NAME
25 pppd \- Point-to-Point Protocol Daemon
26 .SH SYNOPSIS
27 .B pppd
28 [
29 .I options
30 ]
31 .SH DESCRIPTION
32 .LP
33 PPP is the protocol used for establishing internet links over dial-up
34 modems, DSL connections, and many other types of point-to-point
35 links.  The \fIpppd\fR daemon works together with the kernel PPP
36 driver to establish and maintain a PPP link with another system
37 (called the \fIpeer\fR) and to negotiate Internet Protocol (IP)
38 addresses for each end of the link.  Pppd can also authenticate the
39 peer and/or supply authentication information to the peer.  PPP can be
40 used with other network protocols besides IP, but such use is becoming
41 increasingly rare.
42 .SH FREQUENTLY USED OPTIONS
43 .TP
44 .I ttyname
45 Use the serial port called \fIttyname\fR to communicate with the
46 peer.  The string "/dev/" is prepended to \fIttyname\fR to form the
47 name of the device to open.  If no device name is given, or if the
48 name of the terminal
49 connected to the standard input is given, pppd will use that terminal,
50 and will not fork to put itself in the background.  A value for this
51 option from a privileged source cannot be overridden by a
52 non-privileged user.
53 .TP
54 .I speed
55 An option that is a decimal number is taken as the desired baud rate
56 for the serial device.  On systems such as
57 4.4BSD and NetBSD, any speed can be specified.  Other systems
58 (e.g. Linux, SunOS) only support the commonly-used baud rates.
59 .TP
60 .B asyncmap \fImap
61 This option sets the Async-Control-Character-Map (ACCM) for this end
62 of the link.  The ACCM is a set of 32 bits, one for each of the
63 ASCII control characters with values from 0 to 31, where a 1 bit
64 indicates that the corresponding control character should not be used
65 in PPP packets sent to this system.  The map is encoded as a
66 hexadecimal number (without a leading 0x) where the least significant
67 bit (00000001) represents character 0 and the most significant bit
68 (80000000) represents character 31.
69 Pppd will ask the peer to send these characters as a 2-byte
70 escape sequence.
71 If multiple \fIasyncmap\fR options are given, the values are ORed
72 together.  If no \fIasyncmap\fR option is given, the default is zero,
73 so pppd will ask the peer not to escape any control characters.
74 To escape transmitted characters, use the \fIescape\fR option.
75 .TP
76 .B auth
77 Require the peer to authenticate itself before allowing network
78 packets to be sent or received.  This option is the default if the
79 system has a default route.  If neither this option nor the
80 \fInoauth\fR option is specified, pppd will only allow the peer to use
81 IP addresses to which the system does not already have a route.
82 .TP
83 .B call \fIname
84 Read options from the file /etc/ppp/peers/\fIname\fR.  This file may
85 contain privileged options, such as \fInoauth\fR, even if pppd
86 is not being run by root.  The \fIname\fR string may not begin with /
87 or include .. as a pathname component.  The format of the options file
88 is described below.
89 .TP
90 .B connect \fIscript
91 Usually there is something which needs to be done to prepare the link
92 before the PPP protocol can be started; for instance, with a dial-up
93 modem, commands need to be sent to the modem to dial the appropriate
94 phone number.  This option specifies an command for pppd to execute
95 (by passing it to a shell) before attempting to start PPP negotiation.
96 The chat (8) program is often useful here, as it provides a way to
97 send arbitrary strings to a modem and respond to received characters.
98 A value
99 for this option from a privileged source cannot be overridden by a
100 non-privileged user.
101 .TP
102 .B crtscts
103 Specifies that pppd should set the serial port to use hardware flow
104 control using the RTS and CTS signals in the RS-232 interface.
105 If neither the \fIcrtscts\fR, the
106 \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR option
107 is given, the hardware flow control setting for the serial port is
108 left unchanged.
109 Some serial ports (such as Macintosh serial ports) lack a true
110 RTS output. Such serial ports use this mode to implement
111 unidirectional flow control. The serial port will
112 suspend transmission when requested by the modem (via CTS)
113 but will be unable to request the modem to stop sending to the
114 computer. This mode retains the ability to use DTR as
115 a modem control line.
116 .TP
117 .B defaultroute
118 Add a default route to the system routing tables, using the peer as
119 the gateway, when IPCP negotiation is successfully completed.
120 This entry is removed when the PPP connection is broken.  This option
121 is privileged if the \fInodefaultroute\fR option has been specified.
122 .TP
123 .B disconnect \fIscript
124 Execute the command specified by \fIscript\fR, by passing it to a
125 shell, after
126 pppd has terminated the link.  This command could, for example, issue
127 commands to the modem to cause it to hang up if hardware modem control
128 signals were not available.  The disconnect script is not run if the
129 modem has already hung up.  A value for this option from a privileged
130 source cannot be overridden by a non-privileged user.
131 .TP
132 .B escape \fIxx,yy,...
133 Specifies that certain characters should be escaped on transmission
134 (regardless of whether the peer requests them to be escaped with its
135 async control character map).  The characters to be escaped are
136 specified as a list of hex numbers separated by commas.  Note that
137 almost any character can be specified for the \fIescape\fR option,
138 unlike the \fIasyncmap\fR option which only allows control characters
139 to be specified.  The characters which may not be escaped are those
140 with hex values 0x20 \- 0x3f or 0x5e.
141 .TP
142 .B file \fIname
143 Read options from file \fIname\fR (the format is described below).
144 The file must be readable by the user who has invoked pppd.
145 .TP
146 .B init \fIscript
147 Execute the command specified by \fIscript\fR, by passing it to a shell, to
148 initialize the serial line.  This script would typically use the
149 chat(8) program to configure the modem to enable auto answer.  A value
150 for this option from a privileged source cannot be overridden by a
151 non-privileged user.
152 .TP
153 .B lock
154 Specifies that pppd should create a UUCP-style lock file for the
155 serial device to ensure exclusive access to the device.
156 .TP
157 .B mru \fIn
158 Set the MRU [Maximum Receive Unit] value to \fIn\fR. Pppd
159 will ask the peer to send packets of no more than \fIn\fR bytes.
160 The value of \fIn\fR must be between 128 and 16384; the default is 1500.
161 A value of
162 296 works well on very slow links (40 bytes for TCP/IP header + 256
163 bytes of data).
164 Note that for the IPv6 protocol, the MRU must be at least 1280.
165 .TP
166 .B mtu \fIn
167 Set the MTU [Maximum Transmit Unit] value to \fIn\fR.  Unless the
168 peer requests a smaller value via MRU negotiation, pppd will
169 request that the kernel networking code send data packets of no more
170 than \fIn\fR bytes through the PPP network interface.  Note that for 
171 the IPv6 protocol, the MTU must be at least 1280.
172 .TP
173 .B passive
174 Enables the "passive" option in the LCP.  With this option, pppd will
175 attempt to initiate a connection; if no reply is received from the
176 peer, pppd will then just wait passively for a valid LCP packet from
177 the peer, instead of exiting, as it would without this option.
178 .SH OPTIONS
179 .TP
180 .I <local_IP_address>\fB:\fI<remote_IP_address>
181 Set the local and/or remote interface IP addresses.  Either one may be
182 omitted.  The IP addresses can be specified with a host name or in
183 decimal dot notation (e.g. 150.234.56.78).  The default local
184 address is the (first) IP address of the system (unless the
185 \fInoipdefault\fR
186 option is given).  The remote address will be obtained from the peer
187 if not specified in any option.  Thus, in simple cases, this option is
188 not required.  If a local and/or remote IP address is specified with
189 this option, pppd
190 will not accept a different value from the peer in the IPCP
191 negotiation, unless the \fIipcp-accept-local\fR and/or
192 \fIipcp-accept-remote\fR options are given, respectively.
193 .TP
194 .B ipv6 \fI<local_interface_identifier>\fR,\fI<remote_interface_identifier>
195 Set the local and/or remote 64-bit interface identifier. Either one may be
196 omitted. The identifier must be specified in standard ascii notation of
197 IPv6 addresses (e.g. ::dead:beef). If the
198 \fIipv6cp-use-ipaddr\fR
199 option is given, the local identifier is the local IPv4 address (see above).
200 On systems which supports a unique persistent id, such as EUI-48 derived
201 from the Ethernet MAC address, \fIipv6cp-use-persistent\fR option can be
202 used to replace the \fIipv6 <local>,<remote>\fR option. Otherwise the 
203 identifier is randomized.
204 .TP
205 .B active-filter \fIfilter-expression
206 Specifies a packet filter to be applied to data packets to determine
207 which packets are to be regarded as link activity, and therefore reset
208 the idle timer, or cause the link to be brought up in demand-dialling
209 mode.  This option is useful in conjunction with the
210 \fBidle\fR option if there are packets being sent or received
211 regularly over the link (for example, routing information packets)
212 which would otherwise prevent the link from ever appearing to be idle.
213 The \fIfilter-expression\fR syntax is as described for tcpdump(1),
214 except that qualifiers which are inappropriate for a PPP link, such as
215 \fBether\fR and \fBarp\fR, are not permitted.  Generally the filter
216 expression should be enclosed in single-quotes to prevent whitespace
217 in the expression from being interpreted by the shell. This option
218 is currently only available under Linux, and requires that the kernel
219 was configured to include PPP filtering support (CONFIG_PPP_FILTER).
220 .TP
221 .B allow-ip \fIaddress(es)
222 Allow peers to use the given IP address or subnet without
223 authenticating themselves.  The parameter is parsed as for each
224 element of the list of allowed IP addresses in the secrets files (see
225 the AUTHENTICATION section below).
226 .TP
227 .B allow-number \fInumber
228 Allow peers to connect from the given telephone number.  A trailing
229 `*' character will match all numbers beginning with the leading part.
230 .TP
231 .B bsdcomp \fInr,nt
232 Request that the peer compress packets that it sends, using the
233 BSD-Compress scheme, with a maximum code size of \fInr\fR bits, and
234 agree to compress packets sent to the peer with a maximum code size of
235 \fInt\fR bits.  If \fInt\fR is not specified, it defaults to the value
236 given for \fInr\fR.  Values in the range 9 to 15 may be used for
237 \fInr\fR and \fInt\fR; larger values give better compression but
238 consume more kernel memory for compression dictionaries.
239 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
240 compression in the corresponding direction.  Use \fInobsdcomp\fR or
241 \fIbsdcomp 0\fR to disable BSD-Compress compression entirely.
242 .TP
243 .B cdtrcts
244 Use a non-standard hardware flow control (i.e. DTR/CTS) to control
245 the flow of data on the serial port.  If neither the \fIcrtscts\fR,
246 the \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR
247 option is given, the hardware flow control setting for the serial
248 port is left unchanged.
249 Some serial ports (such as Macintosh serial ports) lack a true
250 RTS output. Such serial ports use this mode to implement true
251 bi-directional flow control. The sacrifice is that this flow
252 control mode does not permit using DTR as a modem control line.
253 .TP
254 .B chap-interval \fIn
255 If this option is given, pppd will rechallenge the peer every \fIn\fR
256 seconds.
257 .TP
258 .B chap-max-challenge \fIn
259 Set the maximum number of CHAP challenge transmissions to \fIn\fR
260 (default 10).
261 .TP
262 .B chap-restart \fIn
263 Set the CHAP restart interval (retransmission timeout for challenges)
264 to \fIn\fR seconds (default 3).
265 .TP
266 .B connect-delay \fIn
267 Wait for up \fIn\fR milliseconds after the connect script finishes for
268 a valid PPP packet from the peer.  At the end of this time, or when a
269 valid PPP packet is received from the peer, pppd will commence
270 negotiation by sending its first LCP packet.  The default value is
271 1000 (1 second).  This wait period only applies if the \fBconnect\fR
272 or \fBpty\fR option is used.
273 .TP
274 .B debug
275 Enables connection debugging facilities.
276 If this option is given, pppd will log the contents of all
277 control packets sent or received in a readable form.  The packets are
278 logged through syslog with facility \fIdaemon\fR and level
279 \fIdebug\fR.  This information can be directed to a file by setting up
280 /etc/syslog.conf appropriately (see syslog.conf(5)).
281 .TP
282 .B default-asyncmap
283 Disable asyncmap negotiation, forcing all control characters to be
284 escaped for both the transmit and the receive direction.
285 .TP
286 .B default-mru
287 Disable MRU [Maximum Receive Unit] negotiation.  With this option,
288 pppd will use the default MRU value of 1500 bytes for both the
289 transmit and receive direction.
290 .TP
291 .B deflate \fInr,nt
292 Request that the peer compress packets that it sends, using the
293 Deflate scheme, with a maximum window size of \fI2**nr\fR bytes, and
294 agree to compress packets sent to the peer with a maximum window size
295 of \fI2**nt\fR bytes.  If \fInt\fR is not specified, it defaults to
296 the value given for \fInr\fR.  Values in the range 9 to 15 may be used
297 for \fInr\fR and \fInt\fR; larger values give better compression but
298 consume more kernel memory for compression dictionaries.
299 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
300 compression in the corresponding direction.  Use \fInodeflate\fR or
301 \fIdeflate 0\fR to disable Deflate compression entirely.  (Note: pppd
302 requests Deflate compression in preference to BSD-Compress if the peer
303 can do either.)
304 .TP
305 .B demand
306 Initiate the link only on demand, i.e. when data traffic is present.
307 With this option, the remote IP address must be specified by the user
308 on the command line or in an options file.  Pppd will initially
309 configure the interface and enable it for IP traffic without
310 connecting to the peer.  When traffic is available, pppd will
311 connect to the peer and perform negotiation, authentication, etc.
312 When this is completed, pppd will commence passing data packets
313 (i.e., IP packets) across the link.
314
315 The \fIdemand\fR option implies the \fIpersist\fR option.  If this
316 behaviour is not desired, use the \fInopersist\fR option after the
317 \fIdemand\fR option.  The \fIidle\fR and \fIholdoff\fR
318 options are also useful in conjuction with the \fIdemand\fR option.
319 .TP
320 .B domain \fId
321 Append the domain name \fId\fR to the local host name for authentication
322 purposes.  For example, if gethostname() returns the name porsche, but
323 the fully qualified domain name is porsche.Quotron.COM, you could
324 specify \fIdomain Quotron.COM\fR.  Pppd would then use the name
325 \fIporsche.Quotron.COM\fR for looking up secrets in the secrets file,
326 and as the default name to send to the peer when authenticating itself
327 to the peer.  This option is privileged.
328 .TP
329 .B dryrun
330 With the \fBdryrun\fR option, pppd will print out all the option
331 values which have been set and then exit, after parsing the command
332 line and options files and checking the option values, but before
333 initiating the link.  The option values are logged at level info, and
334 also printed to standard output unless the device on standard output
335 is the device that pppd would be using to communicate with the peer.
336 .TP
337 .B dump
338 With the \fBdump\fR option, pppd will print out all the option values
339 which have been set.  This option is like the \fBdryrun\fR option
340 except that pppd proceeds as normal rather than exiting.
341 .TP
342 .B endpoint \fI<epdisc>
343 Sets the endpoint discriminator sent by the local machine to the peer
344 during multilink negotiation to \fI<epdisc>\fR.  The default is to use
345 the MAC address of the first ethernet interface on the system, if any,
346 otherwise the IPv4 address corresponding to the hostname, if any,
347 provided it is not in the multicast or locally-assigned IP address
348 ranges, or the localhost address.  The endpoint discriminator can be
349 the string \fBnull\fR or of the form \fItype\fR:\fIvalue\fR, where
350 type is a decimal number or one of the strings \fBlocal\fR, \fBIP\fR,
351 \fBMAC\fR, \fBmagic\fR, or \fBphone\fR.  The value is an IP address in
352 dotted-decimal notation for the \fBIP\fR type, or a string of bytes in
353 hexadecimal, separated by periods or colons for the other types.  For
354 the MAC type, the value may also be the name of an ethernet or similar
355 network interface.  This option is currently only available under
356 Linux.
357 .TP
358 .B eap-interval \fIn
359 If this option is given and pppd authenticates the peer with EAP
360 (i.e., is the server), pppd will restart EAP authentication every
361 \fIn\fR seconds.  For EAP SRP-SHA1, see also the \fBsrp-interval\fR
362 option, which enables lightweight rechallenge.
363 .TP
364 .B eap-max-rreq \fIn
365 Set the maximum number of EAP Requests to which pppd will respond (as
366 a client) without hearing EAP Success or Failure.  (Default is 20.)
367 .TP
368 .B eap-max-sreq \fIn
369 Set the maximum number of EAP Requests that pppd will issue (as a
370 server) while attempting authentication.  (Default is 10.)
371 .TP
372 .B eap-restart \fIn
373 Set the retransmit timeout for EAP Requests when acting as a server
374 (authenticator).  (Default is 3 seconds.)
375 .TP
376 .B eap-timeout \fIn
377 Set the maximum time to wait for the peer to send an EAP Request when
378 acting as a client (authenticatee).  (Default is 20 seconds.)
379 .TP
380 .B hide-password
381 When logging the contents of PAP packets, this option causes pppd to
382 exclude the password string from the log.  This is the default.
383 .TP
384 .B holdoff \fIn
385 Specifies how many seconds to wait before re-initiating the link after
386 it terminates.  This option only has any effect if the \fIpersist\fR
387 or \fIdemand\fR option is used.  The holdoff period is not applied if
388 the link was terminated because it was idle.
389 .TP
390 .B idle \fIn
391 Specifies that pppd should disconnect if the link is idle for \fIn\fR
392 seconds.  The link is idle when no data packets (i.e. IP packets) are
393 being sent or received.  Note: it is not advisable to use this option
394 with the \fIpersist\fR option without the \fIdemand\fR option.
395 If the \fBactive-filter\fR
396 option is given, data packets which are rejected by the specified
397 activity filter also count as the link being idle.
398 .TP
399 .B ipcp-accept-local
400 With this option, pppd will accept the peer's idea of our local IP
401 address, even if the local IP address was specified in an option.
402 .TP
403 .B ipcp-accept-remote
404 With this option, pppd will accept the peer's idea of its (remote) IP
405 address, even if the remote IP address was specified in an option.
406 .TP
407 .B ipcp-max-configure \fIn
408 Set the maximum number of IPCP configure-request transmissions to
409 \fIn\fR (default 10).
410 .TP
411 .B ipcp-max-failure \fIn
412 Set the maximum number of IPCP configure-NAKs returned before starting
413 to send configure-Rejects instead to \fIn\fR (default 10).
414 .TP
415 .B ipcp-max-terminate \fIn
416 Set the maximum number of IPCP terminate-request transmissions to
417 \fIn\fR (default 3).
418 .TP
419 .B ipcp-restart \fIn
420 Set the IPCP restart interval (retransmission timeout) to \fIn\fR
421 seconds (default 3).
422 .TP
423 .B ipparam \fIstring
424 Provides an extra parameter to the ip-up and ip-down scripts.  If this
425 option is given, the \fIstring\fR supplied is given as the 6th
426 parameter to those scripts.
427 .TP
428 .B ipv6cp-max-configure \fIn
429 Set the maximum number of IPv6CP configure-request transmissions to
430 \fIn\fR (default 10).
431 .TP
432 .B ipv6cp-max-failure \fIn
433 Set the maximum number of IPv6CP configure-NAKs returned before starting
434 to send configure-Rejects instead to \fIn\fR (default 10).
435 .TP
436 .B ipv6cp-max-terminate \fIn
437 Set the maximum number of IPv6CP terminate-request transmissions to
438 \fIn\fR (default 3).
439 .TP
440 .B ipv6cp-restart \fIn
441 Set the IPv6CP restart interval (retransmission timeout) to \fIn\fR
442 seconds (default 3).
443 .TP
444 .B ipx
445 Enable the IPXCP and IPX protocols.  This option is presently only
446 supported under Linux, and only if your kernel has been configured to
447 include IPX support.
448 .TP
449 .B ipx-network \fIn
450 Set the IPX network number in the IPXCP configure request frame to
451 \fIn\fR, a hexadecimal number (without a leading 0x).  There is no
452 valid default.  If this option is not specified, the network number is
453 obtained from the peer.  If the peer does not have the network number,
454 the IPX protocol will not be started.
455 .TP
456 .B ipx-node \fIn\fB:\fIm
457 Set the IPX node numbers. The two node numbers are separated from each
458 other with a colon character. The first number \fIn\fR is the local
459 node number. The second number \fIm\fR is the peer's node number. Each
460 node number is a hexadecimal number, at most 10 digits long. The node
461 numbers on the ipx-network must be unique. There is no valid
462 default. If this option is not specified then the node numbers are
463 obtained from the peer.
464 .TP
465 .B ipx-router-name \fI<string>
466 Set the name of the router. This is a string and is sent to the peer
467 as information data.
468 .TP
469 .B ipx-routing \fIn
470 Set the routing protocol to be received by this option. More than one
471 instance of \fIipx-routing\fR may be specified. The '\fInone\fR'
472 option (0) may be specified as the only instance of ipx-routing. The
473 values may be \fI0\fR for \fINONE\fR, \fI2\fR for \fIRIP/SAP\fR, and
474 \fI4\fR for \fINLSP\fR.
475 .TP
476 .B ipxcp-accept-local
477 Accept the peer's NAK for the node number specified in the ipx-node
478 option. If a node number was specified, and non-zero, the default is
479 to insist that the value be used. If you include this option then you
480 will permit the peer to override the entry of the node number.
481 .TP
482 .B ipxcp-accept-network
483 Accept the peer's NAK for the network number specified in the
484 ipx-network option. If a network number was specified, and non-zero, the
485 default is to insist that the value be used. If you include this
486 option then you will permit the peer to override the entry of the node
487 number.
488 .TP
489 .B ipxcp-accept-remote
490 Use the peer's network number specified in the configure request
491 frame. If a node number was specified for the peer and this option was
492 not specified, the peer will be forced to use the value which you have
493 specified.
494 .TP
495 .B ipxcp-max-configure \fIn
496 Set the maximum number of IPXCP configure request frames which the
497 system will send to \fIn\fR. The default is 10.
498 .TP
499 .B ipxcp-max-failure \fIn
500 Set the maximum number of IPXCP NAK frames which the local system will
501 send before it rejects the options. The default value is 3.
502 .TP
503 .B ipxcp-max-terminate \fIn
504 Set the maximum nuber of IPXCP terminate request frames before the
505 local system considers that the peer is not listening to them. The
506 default value is 3.
507 .TP
508 .B kdebug \fIn
509 Enable debugging code in the kernel-level PPP driver.  The argument
510 values depend on the specific kernel driver, but in general a value of
511 1 will enable general kernel debug messages.  (Note that these
512 messages are usually only useful for debugging the kernel driver
513 itself.)  For the Linux 2.2.x kernel driver, the value is a sum of
514 bits: 1 to
515 enable general debug messages, 2 to request that the contents of
516 received packets be printed, and 4 to request that the contents of
517 transmitted packets be printed.  On most systems, messages printed by
518 the kernel are logged by syslog(1) to a file as directed in the
519 /etc/syslog.conf configuration file.
520 .TP
521 .B ktune
522 Enables pppd to alter kernel settings as appropriate.  Under Linux,
523 pppd will enable IP forwarding (i.e. set /proc/sys/net/ipv4/ip_forward
524 to 1) if the \fIproxyarp\fR option is used, and will enable the
525 dynamic IP address option (i.e. set /proc/sys/net/ipv4/ip_dynaddr to
526 1) in demand mode if the local address changes.
527 .TP
528 .B lcp-echo-failure \fIn
529 If this option is given, pppd will presume the peer to be dead
530 if \fIn\fR LCP echo-requests are sent without receiving a valid LCP
531 echo-reply.  If this happens, pppd will terminate the
532 connection.  Use of this option requires a non-zero value for the
533 \fIlcp-echo-interval\fR parameter.  This option can be used to enable
534 pppd to terminate after the physical connection has been broken
535 (e.g., the modem has hung up) in situations where no hardware modem
536 control lines are available.
537 .TP
538 .B lcp-echo-interval \fIn
539 If this option is given, pppd will send an LCP echo-request frame to
540 the peer every \fIn\fR seconds.  Normally the peer should respond to
541 the echo-request by sending an echo-reply.  This option can be used
542 with the \fIlcp-echo-failure\fR option to detect that the peer is no
543 longer connected.
544 .TP
545 .B lcp-max-configure \fIn
546 Set the maximum number of LCP configure-request transmissions to
547 \fIn\fR (default 10).
548 .TP
549 .B lcp-max-failure \fIn
550 Set the maximum number of LCP configure-NAKs returned before starting
551 to send configure-Rejects instead to \fIn\fR (default 10).
552 .TP
553 .B lcp-max-terminate \fIn
554 Set the maximum number of LCP terminate-request transmissions to
555 \fIn\fR (default 3).
556 .TP
557 .B lcp-restart \fIn
558 Set the LCP restart interval (retransmission timeout) to \fIn\fR
559 seconds (default 3).
560 .TP
561 .B linkname \fIname\fR
562 Sets the logical name of the link to \fIname\fR.  Pppd will create a
563 file named \fBppp-\fIname\fB.pid\fR in /var/run (or /etc/ppp on some
564 systems) containing its process ID.  This can be useful in determining
565 which instance of pppd is responsible for the link to a given peer
566 system.  This is a privileged option.
567 .TP
568 .B local
569 Don't use the modem control lines.  With this option, pppd will ignore
570 the state of the CD (Carrier Detect) signal from the modem and will
571 not change the state of the DTR (Data Terminal Ready) signal.
572 .TP
573 .B logfd \fIn
574 Send log messages to file descriptor \fIn\fR.  Pppd will send log
575 messages to at most one file or file descriptor (as well as sending
576 the log messages to syslog), so this option and the \fBlogfile\fR
577 option are mutually exclusive.  The default is for pppd to send log
578 messages to stdout (file descriptor 1), unless the serial port is
579 already open on stdout.
580 .TP
581 .B logfile \fIfilename
582 Append log messages to the file \fIfilename\fR (as well as sending the
583 log messages to syslog).  The file is opened with the privileges of
584 the user who invoked pppd, in append mode.
585 .TP
586 .B login
587 Use the system password database for authenticating the peer using
588 PAP, and record the user in the system wtmp file.  Note that the peer
589 must have an entry in the /etc/ppp/pap-secrets file as well as the
590 system password database to be allowed access.
591 .TP
592 .B maxconnect \fIn
593 Terminate the connection when it has been available for network
594 traffic for \fIn\fR seconds (i.e. \fIn\fR seconds after the first
595 network control protocol comes up).
596 .TP
597 .B maxfail \fIn
598 Terminate after \fIn\fR consecutive failed connection attempts.  A
599 value of 0 means no limit.  The default value is 10.
600 .TP
601 .B modem
602 Use the modem control lines.  This option is the default.  With this
603 option, pppd will wait for the CD (Carrier Detect) signal from the
604 modem to be asserted when opening the serial device (unless a connect
605 script is specified), and it will drop the DTR (Data Terminal Ready)
606 signal briefly when the connection is terminated and before executing
607 the connect script.  On Ultrix, this option implies hardware flow
608 control, as for the \fIcrtscts\fR option.
609 .TP
610 .B mp
611 Enables the use of PPP multilink; this is an alias for the `multilink'
612 option.  This option is currently only available under Linux.
613 .TP
614 .B mppe-stateful
615 Allow MPPE to use stateful mode.  Stateless mode is still attempted first.
616 The default is to disallow stateful mode.  
617 .TP
618 .B mpshortseq
619 Enables the use of short (12-bit) sequence numbers in multilink
620 headers, as opposed to 24-bit sequence numbers.  This option is only
621 available under Linux, and only has any effect if multilink is
622 enabled (see the multilink option).
623 .TP
624 .B mrru \fIn
625 Sets the Maximum Reconstructed Receive Unit to \fIn\fR.  The MRRU is
626 the maximum size for a received packet on a multilink bundle, and is
627 analogous to the MRU for the individual links.  This option is
628 currently only available under Linux, and only has any effect if
629 multilink is enabled (see the multilink option).
630 .TP
631 .B ms-dns \fI<addr>
632 If pppd is acting as a server for Microsoft Windows clients, this
633 option allows pppd to supply one or two DNS (Domain Name Server)
634 addresses to the clients.  The first instance of this option specifies
635 the primary DNS address; the second instance (if given) specifies the
636 secondary DNS address.  (This option was present in some older
637 versions of pppd under the name \fBdns-addr\fR.)
638 .TP
639 .B ms-wins \fI<addr>
640 If pppd is acting as a server for Microsoft Windows or "Samba"
641 clients, this option allows pppd to supply one or two WINS (Windows
642 Internet Name Services) server addresses to the clients.  The first
643 instance of this option specifies the primary WINS address; the second
644 instance (if given) specifies the secondary WINS address.
645 .TP
646 .B multilink
647 Enables the use of the PPP multilink protocol.  If the peer also
648 supports multilink, then this link can become part of a bundle between
649 the local system and the peer.  If there is an existing bundle to the
650 peer, pppd will join this link to that bundle, otherwise pppd will
651 create a new bundle.  See the MULTILINK section below.  This option is
652 currently only available under Linux.
653 .TP
654 .B name \fIname
655 Set the name of the local system for authentication purposes to
656 \fIname\fR.  This is a privileged option.  With this option, pppd will
657 use lines in the secrets files which have \fIname\fR as the second
658 field when looking for a secret to use in authenticating the peer.  In
659 addition, unless overridden with the \fIuser\fR option, \fIname\fR
660 will be used as the name to send to the peer when authenticating the
661 local system to the peer.  (Note that pppd does not append the domain
662 name to \fIname\fR.)
663 .TP
664 .B noaccomp
665 Disable Address/Control compression in both directions (send and
666 receive).
667 .TP
668 .B noauth
669 Do not require the peer to authenticate itself.  This option is
670 privileged.
671 .TP
672 .B nobsdcomp
673 Disables BSD-Compress compression; \fBpppd\fR will not request or
674 agree to compress packets using the BSD-Compress scheme.
675 .TP
676 .B noccp
677 Disable CCP (Compression Control Protocol) negotiation.  This option
678 should only be required if the peer is buggy and gets confused by
679 requests from pppd for CCP negotiation.
680 .TP
681 .B nocrtscts
682 Disable hardware flow control (i.e. RTS/CTS) on the serial port.
683 If neither the \fIcrtscts\fR nor the \fInocrtscts\fR nor the
684 \fIcdtrcts\fR nor the \fInocdtrcts\fR option is given, the hardware
685 flow control setting for the serial port is left unchanged.
686 .TP
687 .B nocdtrcts
688 This option is a synonym for \fInocrtscts\fR. Either of these options will
689 disable both forms of hardware flow control.
690 .TP
691 .B nodefaultroute
692 Disable the \fIdefaultroute\fR option.  The system administrator who
693 wishes to prevent users from creating default routes with pppd
694 can do so by placing this option in the /etc/ppp/options file.
695 .TP
696 .B nodeflate
697 Disables Deflate compression; pppd will not request or agree to
698 compress packets using the Deflate scheme.
699 .TP
700 .B nodetach
701 Don't detach from the controlling terminal.  Without this option, if a
702 serial device other than the terminal on the standard input is
703 specified, pppd will fork to become a background process.
704 .TP
705 .B noendpoint
706 Disables pppd from sending an endpoint discriminator to the peer or
707 accepting one from the peer (see the MULTILINK section below).  This
708 option should only be required if the peer is buggy.
709 .TP
710 .B noip
711 Disable IPCP negotiation and IP communication.  This option should
712 only be required if the peer is buggy and gets confused by requests
713 from pppd for IPCP negotiation.
714 .TP
715 .B noipv6
716 Disable IPv6CP negotiation and IPv6 communication. This option should
717 only be required if the peer is buggy and gets confused by requests
718 from pppd for IPv6CP negotiation.
719 .TP
720 .B noipdefault
721 Disables the default behaviour when no local IP address is specified,
722 which is to determine (if possible) the local IP address from the
723 hostname.  With this option, the peer will have to supply the local IP
724 address during IPCP negotiation (unless it specified explicitly on the
725 command line or in an options file).
726 .TP
727 .B noipx
728 Disable the IPXCP and IPX protocols.  This option should only be
729 required if the peer is buggy and gets confused by requests from pppd
730 for IPXCP negotiation.
731 .TP
732 .B noktune
733 Opposite of the \fIktune\fR option; disables pppd from changing system
734 settings.
735 .TP
736 .B nolog
737 Do not send log messages to a file or file descriptor.  This option
738 cancels the \fBlogfd\fR and \fBlogfile\fR options.
739 .TP
740 .B nomagic
741 Disable magic number negotiation.  With this option, pppd cannot
742 detect a looped-back line.  This option should only be needed if the
743 peer is buggy.
744 .TP
745 .B nomp
746 Disables the use of PPP multilink.  This option is currently only
747 available under Linux.
748 .TP
749 .B nomppe
750 Disables MPPE (Microsoft Point to Point Encryption).  This is the default.
751 .TP
752 .B nomppe-40
753 Disable 40\-bit encryption with MPPE.
754 .TP
755 .B nomppe-128
756 Disable 128\-bit encryption with MPPE.
757 .TP
758 .B nomppe-stateful
759 Disable MPPE stateful mode.  This is the default.
760 .TP
761 .B nompshortseq
762 Disables the use of short (12-bit) sequence numbers in the PPP
763 multilink protocol, forcing the use of 24-bit sequence numbers.  This
764 option is currently only available under Linux, and only has any
765 effect if multilink is enabled.
766 .TP
767 .B nomultilink
768 Disables the use of PPP multilink.  This option is currently only
769 available under Linux.
770 .TP
771 .B nopcomp
772 Disable protocol field compression negotiation in both the receive and
773 the transmit direction.
774 .TP
775 .B nopersist
776 Exit once a connection has been made and terminated.  This is the
777 default unless the \fIpersist\fR or \fIdemand\fR option has been
778 specified.
779 .TP
780 .B nopredictor1
781 Do not accept or agree to Predictor-1 compression.
782 .TP
783 .B noproxyarp
784 Disable the \fIproxyarp\fR option.  The system administrator who
785 wishes to prevent users from creating proxy ARP entries with pppd can
786 do so by placing this option in the /etc/ppp/options file.
787 .TP
788 .B notty
789 Normally, pppd requires a terminal device.  With this option, pppd
790 will allocate itself a pseudo-tty master/slave pair and use the slave
791 as its terminal device.  Pppd will create a child process to act as a
792 `character shunt' to transfer characters between the pseudo-tty master
793 and its standard input and output.  Thus pppd will transmit characters
794 on its standard output and receive characters on its standard input
795 even if they are not terminal devices.  This option increases the
796 latency and CPU overhead of transferring data over the ppp interface
797 as all of the characters sent and received must flow through the
798 character shunt process.  An explicit device name may not be given if
799 this option is used.
800 .TP
801 .B novj
802 Disable Van Jacobson style TCP/IP header compression in both the
803 transmit and the receive direction.
804 .TP
805 .B novjccomp
806 Disable the connection-ID compression option in Van Jacobson style
807 TCP/IP header compression.  With this option, pppd will not omit the
808 connection-ID byte from Van Jacobson compressed TCP/IP headers, nor
809 ask the peer to do so.
810 .TP
811 .B papcrypt
812 Indicates that all secrets in the /etc/ppp/pap-secrets file which are
813 used for checking the identity of the peer are encrypted, and thus
814 pppd should not accept a password which, before encryption, is
815 identical to the secret from the /etc/ppp/pap-secrets file.
816 .TP
817 .B pap-max-authreq \fIn
818 Set the maximum number of PAP authenticate-request transmissions to
819 \fIn\fR (default 10).
820 .TP
821 .B pap-restart \fIn
822 Set the PAP restart interval (retransmission timeout) to \fIn\fR
823 seconds (default 3).
824 .TP
825 .B pap-timeout \fIn
826 Set the maximum time that pppd will wait for the peer to authenticate
827 itself with PAP to \fIn\fR seconds (0 means no limit).
828 .TP
829 .B pass-filter \fIfilter-expression
830 Specifies a packet filter to applied to data packets being sent or
831 received to determine which packets should be allowed to pass.
832 Packets which are rejected by the filter are silently discarded.  This
833 option can be used to prevent specific network daemons (such as
834 routed) using up link bandwidth, or to provide a very basic firewall
835 capability.
836 The \fIfilter-expression\fR syntax is as described for tcpdump(1),
837 except that qualifiers which are inappropriate for a PPP link, such as
838 \fBether\fR and \fBarp\fR, are not permitted.  Generally the filter
839 expression should be enclosed in single-quotes to prevent whitespace
840 in the expression from being interpreted by the shell.  Note that it
841 is possible to apply different constraints to incoming and outgoing
842 packets using the \fBinbound\fR and \fBoutbound\fR qualifiers. This
843 option is currently only available under Linux, and requires that the
844 kernel was configured to include PPP filtering support (CONFIG_PPP_FILTER).
845 .TP
846 .B password \fIpassword-string
847 Specifies the password to use for authenticating to the peer.  Use
848 of this option is discouraged, as the password is likely to be visible
849 to other users on the system (for example, by using ps(1)).
850 .TP
851 .B persist
852 Do not exit after a connection is terminated; instead try to reopen
853 the connection. The \fBmaxfail\fR option still has an effect on
854 persistent connections.
855 .TP
856 .B plugin \fIfilename
857 Load the shared library object file \fIfilename\fR as a plugin.  This
858 is a privileged option.  If \fIfilename\fR does not contain a slash
859 (/), pppd will look in the \fB/usr/lib/pppd/\fIversion\fR directory
860 for the plugin, where
861 \fIversion\fR is the version number of pppd (for example, 2.4.2).
862 .TP
863 .B predictor1
864 Request that the peer compress frames that it sends using Predictor-1
865 compression, and agree to compress transmitted frames with Predictor-1
866 if requested.  This option has no effect unless the kernel driver
867 supports Predictor-1 compression.
868 .TP
869 .B privgroup \fIgroup-name
870 Allows members of group \fIgroup-name\fR to use privileged options.
871 This is a privileged option.  Use of this option requires care as
872 there is no guarantee that members of \fIgroup-name\fR cannot use pppd
873 to become root themselves.  Consider it equivalent to putting the
874 members of \fIgroup-name\fR in the kmem or disk group.
875 .TP
876 .B proxyarp
877 Add an entry to this system's ARP [Address Resolution Protocol] table
878 with the IP address of the peer and the Ethernet address of this
879 system.  This will have the effect of making the peer appear to other
880 systems to be on the local ethernet.
881 .TP
882 .B pty \fIscript
883 Specifies that the command \fIscript\fR is to be used to communicate
884 rather than a specific terminal device.  Pppd will allocate itself a
885 pseudo-tty master/slave pair and use the slave as its terminal
886 device.  The \fIscript\fR will be run in a child process with the
887 pseudo-tty master as its standard input and output.  An explicit
888 device name may not be given if this option is used.  (Note: if the
889 \fIrecord\fR option is used in conjuction with the \fIpty\fR option,
890 the child process will have pipes on its standard input and output.)
891 .TP
892 .B receive-all
893 With this option, pppd will accept all control characters from the
894 peer, including those marked in the receive asyncmap.  Without this
895 option, pppd will discard those characters as specified in RFC1662.
896 This option should only be needed if the peer is buggy.
897 .TP
898 .B record \fIfilename
899 Specifies that pppd should record all characters sent and received to
900 a file named \fIfilename\fR.  This file is opened in append mode,
901 using the user's user-ID and permissions.  This option is implemented
902 using a pseudo-tty and a process to transfer characters between the
903 pseudo-tty and the real serial device, so it will increase the latency
904 and CPU overhead of transferring data over the ppp interface.  The
905 characters are stored in a tagged format with timestamps, which can be
906 displayed in readable form using the pppdump(8) program.
907 .TP
908 .B remotename \fIname
909 Set the assumed name of the remote system for authentication purposes
910 to \fIname\fR.
911 .TP
912 .B remotenumber \fInumber
913 Set the assumed telephone number of the remote system for authentication
914 purposes to \fInumber\fR.
915 .TP
916 .B refuse-chap
917 With this option, pppd will not agree to authenticate itself to the
918 peer using CHAP.
919 .TP
920 .B refuse-mschap
921 With this option, pppd will not agree to authenticate itself to the
922 peer using MS-CHAP.
923 .TP
924 .B refuse-mschap-v2
925 With this option, pppd will not agree to authenticate itself to the
926 peer using MS-CHAPv2.
927 .TP
928 .B refuse-eap
929 With this option, pppd will not agree to authenticate itself to the
930 peer using EAP.
931 .TP
932 .B refuse-pap
933 With this option, pppd will not agree to authenticate itself to the
934 peer using PAP.
935 .TP
936 .B require-chap
937 Require the peer to authenticate itself using CHAP [Challenge
938 Handshake Authentication Protocol] authentication.
939 .TP
940 .B require-mppe
941 Require the use of MPPE (Microsoft Point to Point Encryption).  This
942 option disables all other compression types.  This option enables
943 both 40\-bit and 128\-bit encryption.  In order for MPPE to successfully
944 come up, you must have authenticated with either MS-CHAP or MS-CHAPv2.
945 This option is presently only supported under Linux, and only if your
946 kernel has been configured to include MPPE support.
947 .TP
948 .B require-mppe-40
949 Require the use of MPPE, with 40\-bit encryption.
950 .TP
951 .B require-mppe-128
952 Require the use of MPPE, with 128\-bit encryption.
953 .TP
954 .B require-mschap
955 Require the peer to authenticate itself using MS-CHAP [Microsft Challenge
956 Handshake Authentication Protocol] authentication.
957 .TP
958 .B require-mschap-v2
959 Require the peer to authenticate itself using MS-CHAPv2 [Microsft Challenge
960 Handshake Authentication Protocol, Version 2] authentication.
961 .TP
962 .B require-eap
963 Require the peer to authenticate itself using EAP [Extensible
964 Authentication Protocol] authentication.
965 .TP
966 .B require-pap
967 Require the peer to authenticate itself using PAP [Password
968 Authentication Protocol] authentication.
969 .TP
970 .B show-password
971 When logging the contents of PAP packets, this option causes pppd to
972 show the password string in the log message.
973 .TP
974 .B silent
975 With this option, pppd will not transmit LCP packets to initiate a
976 connection until a valid LCP packet is received from the peer (as for
977 the `passive' option with ancient versions of pppd).
978 .TP
979 .B srp-interval \fIn
980 If this parameter is given and pppd uses EAP SRP-SHA1 to authenticate
981 the peer (i.e., is the server), then pppd will use the optional
982 lightweight SRP rechallenge mechanism at intervals of \fIn\fR
983 seconds.  This option is faster than \fBeap-interval\fR
984 reauthentication because it uses a hash-based mechanism and does not
985 derive a new session key.
986 .TP
987 .B srp-pn-secret \fIstring
988 Set the long-term pseudonym-generating secret for the server.  This
989 value is optional and if set, needs to be known at the server
990 (authenticator) side only, and should be different for each server (or
991 poll of identical servers).  It is used along with the current date to
992 generate a key to encrypt and decrypt the client's identity contained
993 in the pseudonym.
994 .TP
995 .B srp-use-pseudonym
996 When operating as an EAP SRP-SHA1 client, attempt to use the pseudonym
997 stored in ~/.ppp_psuedonym first as the identity, and save in this
998 file any pseudonym offered by the peer during authentication.
999 .TP
1000 .B sync
1001 Use synchronous HDLC serial encoding instead of asynchronous.
1002 The device used by pppd with this option must have sync support.
1003 Currently supports Microgate SyncLink adapters
1004 under Linux and FreeBSD 2.2.8 and later.
1005 .TP
1006 .B unit \fInum
1007 Sets the ppp unit number (for a ppp0 or ppp1 etc interface name) for outbound
1008 connections.
1009 .TP
1010 .B updetach
1011 With this option, pppd will detach from its controlling terminal once
1012 it has successfully established the ppp connection (to the point where
1013 the first network control protocol, usually the IP control protocol,
1014 has come up).
1015 .TP
1016 .B usehostname
1017 Enforce the use of the hostname (with domain name appended, if given)
1018 as the name of the local system for authentication purposes (overrides
1019 the \fIname\fR option).  This option is not normally needed since the
1020 \fIname\fR option is privileged.
1021 .TP
1022 .B usepeerdns
1023 Ask the peer for up to 2 DNS server addresses.  The addresses supplied
1024 by the peer (if any) are passed to the /etc/ppp/ip-up script in the
1025 environment variables DNS1 and DNS2, and the environment variable
1026 USEPEERDNS will be set to 1.  In addition, pppd will create an
1027 /etc/ppp/resolv.conf file containing one or two nameserver lines with
1028 the address(es) supplied by the peer.
1029 .TP
1030 .B user \fIname
1031 Sets the name used for authenticating the local system to the peer to
1032 \fIname\fR.
1033 .TP
1034 .B vj-max-slots \fIn
1035 Sets the number of connection slots to be used by the Van Jacobson
1036 TCP/IP header compression and decompression code to \fIn\fR, which
1037 must be between 2 and 16 (inclusive).
1038 .TP
1039 .B welcome \fIscript
1040 Run the executable or shell command specified by \fIscript\fR before
1041 initiating PPP negotiation, after the connect script (if any) has
1042 completed.  A value for this option from a privileged source cannot be
1043 overridden by a non-privileged user.
1044 .TP
1045 .B xonxoff
1046 Use software flow control (i.e. XON/XOFF) to control the flow of data on
1047 the serial port.
1048 .SH OPTIONS FILES
1049 Options can be taken from files as well as the command line.  Pppd
1050 reads options from the files /etc/ppp/options, ~/.ppprc and
1051 /etc/ppp/options.\fIttyname\fR (in that order) before processing the
1052 options on the command line.  (In fact, the command-line options are
1053 scanned to find the terminal name before the options.\fIttyname\fR
1054 file is read.)  In forming the name of the options.\fIttyname\fR file,
1055 the initial /dev/ is removed from the terminal name, and any remaining
1056 / characters are replaced with dots.
1057 .PP
1058 An options file is parsed into a series of words, delimited by
1059 whitespace.  Whitespace can be included in a word by enclosing the
1060 word in double-quotes (").  A backslash (\\) quotes the following character.
1061 A hash (#) starts a comment, which continues until the end of the
1062 line.  There is no restriction on using the \fIfile\fR or \fIcall\fR
1063 options within an options file.
1064 .SH SECURITY
1065 .I pppd
1066 provides system administrators with sufficient access control that PPP
1067 access to a server machine can be provided to legitimate users without
1068 fear of compromising the security of the server or the network it's
1069 on.  This control is provided through restrictions on which IP
1070 addresses the peer may use, based on its authenticated identity (if
1071 any), and through restrictions on which options a non-privileged user
1072 may use.  Several of pppd's options are privileged, in particular
1073 those which permit potentially insecure configurations; these options
1074 are only accepted in files which are under the control of the system
1075 administrator, or if pppd is being run by root.
1076 .PP
1077 The default behaviour of pppd is to allow an unauthenticated peer to
1078 use a given IP address only if the system does not already have a
1079 route to that IP address.  For example, a system with a
1080 permanent connection to the wider internet will normally have a
1081 default route, and thus all peers will have to authenticate themselves
1082 in order to set up a connection.  On such a system, the \fIauth\fR
1083 option is the default.  On the other hand, a system where the
1084 PPP link is the only connection to the internet will not normally have
1085 a default route, so the peer will be able to use almost any IP address
1086 without authenticating itself.
1087 .PP
1088 As indicated above, some security-sensitive options are privileged,
1089 which means that they may not be used by an ordinary non-privileged
1090 user running a setuid-root pppd, either on the command line, in the
1091 user's ~/.ppprc file, or in an options file read using the \fIfile\fR
1092 option.  Privileged options may be used in /etc/ppp/options file or in
1093 an options file read using the \fIcall\fR option.  If pppd is being
1094 run by the root user, privileged options can be used without
1095 restriction.
1096 .PP
1097 When opening the device, pppd uses either the invoking user's user ID
1098 or the root UID (that is, 0), depending on whether the device name was
1099 specified by the user or the system administrator.  If the device name
1100 comes from a privileged source, that is, /etc/ppp/options or an
1101 options file read using the \fIcall\fR option, pppd uses full root
1102 privileges when opening the device.  Thus, by creating an appropriate
1103 file under /etc/ppp/peers, the system administrator can allow users to
1104 establish a ppp connection via a device which they would not normally
1105 have permission to access.  Otherwise pppd uses the invoking user's
1106 real UID when opening the device.
1107 .SH AUTHENTICATION
1108 Authentication is the process whereby one peer convinces the other of
1109 its identity.  This involves the first peer sending its name to the
1110 other, together with some kind of secret information which could only
1111 come from the genuine authorized user of that name.  In such an
1112 exchange, we will call the first peer the "client" and the other the
1113 "server".  The client has a name by which it identifies itself to the
1114 server, and the server also has a name by which it identifies itself
1115 to the client.  Generally the genuine client shares some secret (or
1116 password) with the server, and authenticates itself by proving that it
1117 knows that secret.  Very often, the names used for authentication
1118 correspond to the internet hostnames of the peers, but this is not
1119 essential.
1120 .LP
1121 At present, pppd supports three authentication protocols: the Password
1122 Authentication Protocol (PAP), Challenge Handshake Authentication
1123 Protocol (CHAP), and Extensible Authentication Protocol (EAP).  PAP
1124 involves the client sending its name and a cleartext password to the
1125 server to authenticate itself.  In contrast, the server initiates the
1126 CHAP authentication exchange by sending a challenge to the client (the
1127 challenge packet includes the server's name).  The client must respond
1128 with a response which includes its name plus a hash value derived from
1129 the shared secret and the challenge, in order to prove that it knows
1130 the secret.  EAP supports CHAP-style authentication, and also includes
1131 the SRP-SHA1 mechanism, which is resistant to dictionary-based attacks
1132 and does not require a cleartext password on the server side.
1133 .LP
1134 The PPP protocol, being symmetrical, allows both peers to require the
1135 other to authenticate itself.  In that case, two separate and
1136 independent authentication exchanges will occur.  The two exchanges
1137 could use different authentication protocols, and in principle,
1138 different names could be used in the two exchanges.
1139 .LP
1140 The default behaviour of pppd is to agree to authenticate if
1141 requested, and to not require authentication from the peer.  However,
1142 pppd will not agree to authenticate itself with a particular protocol
1143 if it has no secrets which could be used to do so.
1144 .LP
1145 Pppd stores secrets for use in authentication in secrets
1146 files (/etc/ppp/pap-secrets for PAP, /etc/ppp/chap-secrets for CHAP,
1147 MS-CHAP, MS-CHAPv2, and EAP MD5-Challenge, and /etc/ppp/srp-secrets
1148 for EAP SRP-SHA1).
1149 All secrets files have the same format.  The secrets files can
1150 contain secrets for pppd to use in authenticating itself to other
1151 systems, as well as secrets for pppd to use when authenticating other
1152 systems to itself.
1153 .LP
1154 Each line in a secrets file contains one secret.  A given secret is
1155 specific to a particular combination of client and server \- it can
1156 only be used by that client to authenticate itself to that server.
1157 Thus each line in a secrets file has at least 3 fields: the name of
1158 the client, the name of the server, and the secret.  These fields may
1159 be followed by a list of the IP addresses that the specified client
1160 may use when connecting to the specified server.
1161 .LP
1162 A secrets file is parsed into words as for a options file, so the
1163 client name, server name and secrets fields must each be one word,
1164 with any embedded spaces or other special characters quoted or
1165 escaped.  Note that case is significant in the client and server names
1166 and in the secret.
1167 .LP
1168 If the secret starts with an `@', what follows is assumed to be the
1169 name of a file from which to read the secret.  A "*" as the client or
1170 server name matches any name.  When selecting a secret, pppd takes the
1171 best match, i.e.  the match with the fewest wildcards.
1172 .LP
1173 Any following words on the same line are taken to be a list of
1174 acceptable IP addresses for that client.  If there are only 3 words on
1175 the line, or if the first word is "-", then all IP addresses are
1176 disallowed.  To allow any address, use "*".  A word starting with "!"
1177 indicates that the specified address is \fInot\fR acceptable.  An
1178 address may be followed by "/" and a number \fIn\fR, to indicate a
1179 whole subnet, i.e. all addresses which have the same value in the most
1180 significant \fIn\fR bits.  In this form, the address may be followed
1181 by a plus sign ("+") to indicate that one address from the subnet is
1182 authorized, based on the ppp network interface unit number in use.
1183 In this case, the host part of the address will be set to the unit
1184 number plus one.
1185 .LP
1186 Thus a secrets file contains both secrets for use in authenticating
1187 other hosts, plus secrets which we use for authenticating ourselves to
1188 others.  When pppd is authenticating the peer (checking the peer's
1189 identity), it chooses a secret with the peer's name in the first
1190 field and the name of the local system in the second field.  The
1191 name of the local system defaults to the hostname, with the domain
1192 name appended if the \fIdomain\fR option is used.  This default can be
1193 overridden with the \fIname\fR option, except when the
1194 \fIusehostname\fR option is used.  (For EAP SRP-SHA1, see the
1195 srp-entry(8) utility for generating proper validator entries to be
1196 used in the "secret" field.)
1197 .LP
1198 When pppd is choosing a secret to use in authenticating itself to the
1199 peer, it first determines what name it is going to use to identify
1200 itself to the peer.  This name can be specified by the user with the
1201 \fIuser\fR option.  If this option is not used, the name defaults to
1202 the name of the local system, determined as described in the previous
1203 paragraph.  Then pppd looks for a secret with this name in the first
1204 field and the peer's name in the second field.  Pppd will know the
1205 name of the peer if CHAP or EAP authentication is being used, because
1206 the peer will have sent it in the challenge packet.  However, if PAP
1207 is being used, pppd will have to determine the peer's name from the
1208 options specified by the user.  The user can specify the peer's name
1209 directly with the \fIremotename\fR option.  Otherwise, if the remote
1210 IP address was specified by a name (rather than in numeric form), that
1211 name will be used as the peer's name.  Failing that, pppd will use the
1212 null string as the peer's name.
1213 .LP
1214 When authenticating the peer with PAP, the supplied password is first
1215 compared with the secret from the secrets file.  If the password
1216 doesn't match the secret, the password is encrypted using crypt() and
1217 checked against the secret again.  Thus secrets for authenticating the
1218 peer can be stored in encrypted form if desired.  If the
1219 \fIpapcrypt\fR option is given, the first (unencrypted) comparison is
1220 omitted, for better security.
1221 .LP
1222 Furthermore, if the \fIlogin\fR option was specified, the username and
1223 password are also checked against the system password database.  Thus,
1224 the system administrator can set up the pap-secrets file to allow PPP
1225 access only to certain users, and to restrict the set of IP addresses
1226 that each user can use.  Typically, when using the \fIlogin\fR option,
1227 the secret in /etc/ppp/pap-secrets would be "", which will match any
1228 password supplied by the peer.  This avoids the need to have the same
1229 secret in two places.
1230 .LP
1231 Authentication must be satisfactorily completed before IPCP (or any
1232 other Network Control Protocol) can be started.  If the peer is
1233 required to authenticate itself, and fails to do so, pppd will
1234 terminated the link (by closing LCP).  If IPCP negotiates an
1235 unacceptable IP address for the remote host, IPCP will be closed.  IP
1236 packets can only be sent or received when IPCP is open.
1237 .LP
1238 In some cases it is desirable to allow some hosts which can't
1239 authenticate themselves to connect and use one of a restricted set of
1240 IP addresses, even when the local host generally requires
1241 authentication.  If the peer refuses to authenticate itself when
1242 requested, pppd takes that as equivalent to authenticating with PAP
1243 using the empty string for the username and password.  Thus, by adding
1244 a line to the pap-secrets file which specifies the empty string for
1245 the client and password, it is possible to allow restricted access to
1246 hosts which refuse to authenticate themselves.
1247 .SH ROUTING
1248 .LP
1249 When IPCP negotiation is completed successfully, pppd will inform the
1250 kernel of the local and remote IP addresses for the ppp interface.
1251 This is sufficient to create a host route to the remote end of the
1252 link, which will enable the peers to exchange IP packets.
1253 Communication with other machines generally requires further
1254 modification to routing tables and/or ARP (Address Resolution
1255 Protocol) tables.  In most cases the \fIdefaultroute\fR and/or
1256 \fIproxyarp\fR options are sufficient for this, but in some cases
1257 further intervention is required.  The /etc/ppp/ip-up script can be
1258 used for this.
1259 .LP
1260 Sometimes it is desirable to add a default route through the remote
1261 host, as in the case of a machine whose only connection to the
1262 Internet is through the ppp interface.  The \fIdefaultroute\fR option
1263 causes pppd to create such a default route when IPCP comes up, and
1264 delete it when the link is terminated.
1265 .LP
1266 In some cases it is desirable to use proxy ARP, for example on a
1267 server machine connected to a LAN, in order to allow other hosts to
1268 communicate with the remote host.  The \fIproxyarp\fR option causes
1269 pppd to look for a network interface on the same subnet as the remote
1270 host (an interface supporting broadcast and ARP, which is up and not a
1271 point-to-point or loopback interface).  If found, pppd creates a
1272 permanent, published ARP entry with the IP address of the remote host
1273 and the hardware address of the network interface found.
1274 .LP
1275 When the \fIdemand\fR option is used, the interface IP addresses have
1276 already been set at the point when IPCP comes up.  If pppd has not
1277 been able to negotiate the same addresses that it used to configure
1278 the interface (for example when the peer is an ISP that uses dynamic
1279 IP address assignment), pppd has to change the interface IP addresses
1280 to the negotiated addresses.  This may disrupt existing connections,
1281 and the use of demand dialling with peers that do dynamic IP address
1282 assignment is not recommended.
1283 .SH MULTILINK
1284 Multilink PPP provides the capability to combine two or more PPP links
1285 between a pair of machines into a single `bundle', which appears as a
1286 single virtual PPP link which has the combined bandwidth of the
1287 individual links.  Currently, multilink PPP is only supported under
1288 Linux.
1289 .LP
1290 Pppd detects that the link it is controlling is connected to the same
1291 peer as another link using the peer's endpoint discriminator and the
1292 authenticated identity of the peer (if it authenticates itself).  The
1293 endpoint discriminator is a block of data which is hopefully unique
1294 for each peer.  Several types of data can be used, including
1295 locally-assigned strings of bytes, IP addresses, MAC addresses,
1296 randomly strings of bytes, or E-164 phone numbers.  The endpoint
1297 discriminator sent to the peer by pppd can be set using the endpoint
1298 option.
1299 .LP
1300 In circumstances the peer may send no endpoint discriminator or a
1301 non-unique value.  The optional bundle option adds an extra string
1302 which is added to the peer's endpoint discriminator and authenticated
1303 identity when matching up links to be joined together in a bundle.
1304 The bundle option can also be used to allow the establishment of
1305 multiple bundles between the local system and the peer.  Pppd uses a
1306 TDB database in /var/run/pppd.tdb to match up links.
1307 .LP
1308 Assuming that multilink is enabled and the peer is willing to
1309 negotiate multilink, then when pppd is invoked to bring up the first
1310 link to the peer, it will detect that no other link is connected to
1311 the peer and create a new bundle, that is, another ppp network
1312 interface unit.  When another pppd is invoked to bring up another link
1313 to the peer, it will detect the existing bundle and join its link to
1314 it.  Currently, if the first pppd terminates (for example, because of
1315 a hangup or a received signal) the bundle is destroyed.
1316 .SH EXAMPLES
1317 .LP
1318 The following examples assume that the /etc/ppp/options file contains
1319 the \fIauth\fR option (as in the default /etc/ppp/options file in the
1320 ppp distribution).
1321 .LP
1322 Probably the most common use of pppd is to dial out to an ISP.  This
1323 can be done with a command such as
1324 .IP
1325 pppd call isp
1326 .LP
1327 where the /etc/ppp/peers/isp file is set up by the system
1328 administrator to contain something like this:
1329 .IP
1330 ttyS0 19200 crtscts
1331 .br
1332 connect '/usr/sbin/chat -v -f /etc/ppp/chat-isp'
1333 .br
1334 noauth
1335 .LP
1336 In this example, we are using chat to dial the ISP's modem and go
1337 through any logon sequence required.  The /etc/ppp/chat-isp file
1338 contains the script used by chat; it could for example contain
1339 something like this:
1340 .IP
1341 ABORT "NO CARRIER"
1342 .br
1343 ABORT "NO DIALTONE"
1344 .br
1345 ABORT "ERROR"
1346 .br
1347 ABORT "NO ANSWER"
1348 .br
1349 ABORT "BUSY"
1350 .br
1351 ABORT "Username/Password Incorrect"
1352 .br
1353 "" "at"
1354 .br
1355 OK "at&d0&c1"
1356 .br
1357 OK "atdt2468135"
1358 .br
1359 "name:" "^Umyuserid"
1360 .br
1361 "word:" "\\qmypassword"
1362 .br
1363 "ispts" "\\q^Uppp"
1364 .br
1365 "~-^Uppp-~"
1366 .LP
1367 See the chat(8) man page for details of chat scripts.
1368 .LP
1369 Pppd can also be used to provide a dial-in ppp service for users.  If
1370 the users already have login accounts, the simplest way to set up the
1371 ppp service is to let the users log in to their accounts and run pppd
1372 (installed setuid-root) with a command such as
1373 .IP
1374 pppd proxyarp
1375 .LP
1376 To allow a user to use the PPP facilities, you need to allocate an IP
1377 address for that user's machine and create an entry in
1378 /etc/ppp/pap-secrets, /etc/ppp/chap-secrets, or /etc/ppp/srp-secrets
1379 (depending on which authentication method the PPP implementation on
1380 the user's machine supports), so that the user's machine can
1381 authenticate itself.  For example, if Joe has a machine called
1382 "joespc" that is to be allowed to dial in to the machine called
1383 "server" and use the IP address joespc.my.net, you would add an entry
1384 like this to /etc/ppp/pap-secrets or /etc/ppp/chap-secrets:
1385 .IP
1386 joespc  server  "joe's secret"  joespc.my.net
1387 .LP
1388 (See srp-entry(8) for a means to generate the server's entry when
1389 SRP-SHA1 is in use.)
1390 Alternatively, you can create a username called (for example) "ppp",
1391 whose login shell is pppd and whose home directory is /etc/ppp.
1392 Options to be used when pppd is run this way can be put in
1393 /etc/ppp/.ppprc.
1394 .LP
1395 If your serial connection is any more complicated than a piece of
1396 wire, you may need to arrange for some control characters to be
1397 escaped.  In particular, it is often useful to escape XON (^Q) and
1398 XOFF (^S), using \fIasyncmap a0000\fR.  If the path includes a telnet,
1399 you probably should escape ^] as well (\fIasyncmap 200a0000\fR).  If
1400 the path includes an rlogin, you will need to use the \fIescape ff\fR
1401 option on the end which is running the rlogin client, since many
1402 rlogin implementations are not transparent; they will remove the
1403 sequence [0xff, 0xff, 0x73, 0x73, followed by any 8 bytes] from the
1404 stream.
1405 .SH DIAGNOSTICS
1406 .LP
1407 Messages are sent to the syslog daemon using facility LOG_DAEMON.
1408 (This can be overridden by recompiling pppd with the macro
1409 LOG_PPP defined as the desired facility.)  See the syslog(8)
1410 documentation for details of where the syslog daemon will write the
1411 messages.  On most systems, the syslog daemon uses the
1412 /etc/syslog.conf file to specify the destination(s) for syslog
1413 messages.  You may need to edit that file to suit.
1414 .LP
1415 The \fIdebug\fR option causes the contents of all control packets sent
1416 or received to be logged, that is, all LCP, PAP, CHAP, EAP, or IPCP packets.
1417 This can be useful if the PPP negotiation does not succeed or if
1418 authentication fails.
1419 If debugging is enabled at compile time, the \fIdebug\fR option also
1420 causes other debugging messages to be logged.
1421 .LP
1422 Debugging can also be enabled or disabled by sending a SIGUSR1 signal
1423 to the pppd process.  This signal acts as a toggle.
1424 .SH EXIT STATUS
1425 The exit status of pppd is set to indicate whether any error was
1426 detected, or the reason for the link being terminated.  The values
1427 used are:
1428 .TP
1429 .B 0
1430 Pppd has detached, or otherwise the connection was successfully
1431 established and terminated at the peer's request.
1432 .TP
1433 .B 1
1434 An immediately fatal error of some kind occurred, such as an essential
1435 system call failing, or running out of virtual memory.
1436 .TP
1437 .B 2
1438 An error was detected in processing the options given, such as two
1439 mutually exclusive options being used.
1440 .TP
1441 .B 3
1442 Pppd is not setuid-root and the invoking user is not root.
1443 .TP
1444 .B 4
1445 The kernel does not support PPP, for example, the PPP kernel driver is
1446 not included or cannot be loaded.
1447 .TP
1448 .B 5
1449 Pppd terminated because it was sent a SIGINT, SIGTERM or SIGHUP
1450 signal.
1451 .TP
1452 .B 6
1453 The serial port could not be locked.
1454 .TP
1455 .B 7
1456 The serial port could not be opened.
1457 .TP
1458 .B 8
1459 The connect script failed (returned a non-zero exit status).
1460 .TP
1461 .B 9
1462 The command specified as the argument to the \fIpty\fR option could
1463 not be run.
1464 .TP
1465 .B 10
1466 The PPP negotiation failed, that is, it didn't reach the point where
1467 at least one network protocol (e.g. IP) was running.
1468 .TP
1469 .B 11
1470 The peer system failed (or refused) to authenticate itself.
1471 .TP
1472 .B 12
1473 The link was established successfully and terminated because it was
1474 idle.
1475 .TP
1476 .B 13
1477 The link was established successfully and terminated because the
1478 connect time limit was reached.
1479 .TP
1480 .B 14
1481 Callback was negotiated and an incoming call should arrive shortly.
1482 .TP
1483 .B 15
1484 The link was terminated because the peer is not responding to echo
1485 requests.
1486 .TP
1487 .B 16
1488 The link was terminated by the modem hanging up.
1489 .TP
1490 .B 17
1491 The PPP negotiation failed because serial loopback was detected.
1492 .TP
1493 .B 18
1494 The init script failed (returned a non-zero exit status).
1495 .TP
1496 .B 19
1497 We failed to authenticate ourselves to the peer.
1498 .SH SCRIPTS
1499 Pppd invokes scripts at various stages in its processing which can be
1500 used to perform site-specific ancillary processing.  These scripts are
1501 usually shell scripts, but could be executable code files instead.
1502 Pppd does not wait for the scripts to finish.  The scripts are
1503 executed as root (with the real and effective user-id set to 0), so
1504 that they can do things such as update routing tables or run
1505 privileged daemons.  Be careful that the contents of these scripts do
1506 not compromise your system's security.  Pppd runs the scripts with
1507 standard input, output and error redirected to /dev/null, and with an
1508 environment that is empty except for some environment variables that
1509 give information about the link.  The environment variables that pppd
1510 sets are:
1511 .TP
1512 .B DEVICE
1513 The name of the serial tty device being used.
1514 .TP
1515 .B IFNAME
1516 The name of the network interface being used.
1517 .TP
1518 .B IPLOCAL
1519 The IP address for the local end of the link.  This is only set when
1520 IPCP has come up.
1521 .TP
1522 .B IPREMOTE
1523 The IP address for the remote end of the link.  This is only set when
1524 IPCP has come up.
1525 .TP
1526 .B PEERNAME
1527 The authenticated name of the peer.  This is only set if the peer
1528 authenticates itself.
1529 .TP
1530 .B SPEED
1531 The baud rate of the tty device.
1532 .TP
1533 .B ORIG_UID
1534 The real user-id of the user who invoked pppd.
1535 .TP
1536 .B PPPLOGNAME
1537 The username of the real user-id that invoked pppd. This is always set.
1538 .P
1539 For the ip-down and auth-down scripts, pppd also sets the following
1540 variables giving statistics for the connection:
1541 .TP
1542 .B CONNECT_TIME
1543 The number of seconds from when the PPP negotiation started until the
1544 connection was terminated.
1545 .TP
1546 .B BYTES_SENT
1547 The number of bytes sent (at the level of the serial port) during the
1548 connection.
1549 .TP
1550 .B BYTES_RCVD
1551 The number of bytes received (at the level of the serial port) during
1552 the connection.
1553 .TP
1554 .B LINKNAME
1555 The logical name of the link, set with the \fIlinkname\fR option.
1556 .P
1557 Pppd invokes the following scripts, if they exist.  It is not an error
1558 if they don't exist.
1559 .TP
1560 .B /etc/ppp/auth-up
1561 A program or script which is executed after the remote system
1562 successfully authenticates itself.  It is executed with the parameters
1563 .IP
1564 \fIinterface-name peer-name user-name tty-device speed\fR
1565 .IP
1566 Note that this script is not executed if the peer doesn't authenticate
1567 itself, for example when the \fInoauth\fR option is used.
1568 .TP
1569 .B /etc/ppp/auth-down
1570 A program or script which is executed when the link goes down, if
1571 /etc/ppp/auth-up was previously executed.  It is executed in the same
1572 manner with the same parameters as /etc/ppp/auth-up.
1573 .TP
1574 .B /etc/ppp/ip-up
1575 A program or script which is executed when the link is available for
1576 sending and receiving IP packets (that is, IPCP has come up).  It is
1577 executed with the parameters
1578 .IP
1579 \fIinterface-name tty-device speed local-IP-address
1580 remote-IP-address ipparam\fR
1581 .TP
1582 .B /etc/ppp/ip-down
1583 A program or script which is executed when the link is no longer
1584 available for sending and receiving IP packets.  This script can be
1585 used for undoing the effects of the /etc/ppp/ip-up script.  It is
1586 invoked in the same manner and with the same parameters as the ip-up
1587 script.
1588 .TP
1589 .B /etc/ppp/ipv6-up
1590 Like /etc/ppp/ip-up, except that it is executed when the link is available 
1591 for sending and receiving IPv6 packets. It is executed with the parameters
1592 .IP
1593 \fIinterface-name tty-device speed local-link-local-address
1594 remote-link-local-address ipparam\fR
1595 .TP
1596 .B /etc/ppp/ipv6-down
1597 Similar to /etc/ppp/ip-down, but it is executed when IPv6 packets can no
1598 longer be transmitted on the link. It is executed with the same parameters 
1599 as the ipv6-up script.
1600 .TP
1601 .B /etc/ppp/ipx-up
1602 A program or script which is executed when the link is available for
1603 sending and receiving IPX packets (that is, IPXCP has come up).  It is
1604 executed with the parameters
1605 .IP
1606 \fIinterface-name tty-device speed network-number local-IPX-node-address
1607 remote-IPX-node-address local-IPX-routing-protocol remote-IPX-routing-protocol
1608 local-IPX-router-name remote-IPX-router-name ipparam pppd-pid\fR 
1609 .IP
1610 The local-IPX-routing-protocol and remote-IPX-routing-protocol field
1611 may be one of the following:
1612 .IP
1613 NONE      to indicate that there is no routing protocol
1614 .br
1615 RIP       to indicate that RIP/SAP should be used
1616 .br
1617 NLSP      to indicate that Novell NLSP should be used
1618 .br
1619 RIP NLSP  to indicate that both RIP/SAP and NLSP should be used
1620 .TP
1621 .B /etc/ppp/ipx-down
1622 A program or script which is executed when the link is no longer
1623 available for sending and receiving IPX packets.  This script can be
1624 used for undoing the effects of the /etc/ppp/ipx-up script.  It is
1625 invoked in the same manner and with the same parameters as the ipx-up
1626 script.
1627 .SH FILES
1628 .TP
1629 .B /var/run/ppp\fIn\fB.pid \fR(BSD or Linux), \fB/etc/ppp/ppp\fIn\fB.pid \fR(others)
1630 Process-ID for pppd process on ppp interface unit \fIn\fR.
1631 .TP
1632 .B /var/run/ppp-\fIname\fB.pid \fR(BSD or Linux),
1633 \fB/etc/ppp/ppp-\fIname\fB.pid \fR(others)
1634 Process-ID for pppd process for logical link \fIname\fR (see the
1635 \fIlinkname\fR option).
1636 .TP
1637 .B /etc/ppp/pap-secrets
1638 Usernames, passwords and IP addresses for PAP authentication.  This
1639 file should be owned by root and not readable or writable by any other
1640 user.  Pppd will log a warning if this is not the case.
1641 .TP
1642 .B /etc/ppp/chap-secrets
1643 Names, secrets and IP addresses for CHAP/MS-CHAP/MS-CHAPv2 authentication.
1644 As for /etc/ppp/pap-secrets, this file should be owned by root and not
1645 readable or writable by any other user.  Pppd will log a warning if
1646 this is not the case.
1647 .TP
1648 .B /etc/ppp/srp-secrets
1649 Names, secrets, and IP addresses for EAP authentication.  As for
1650 /etc/ppp/pap-secrets, this file should be owned by root and not
1651 readable or writable by any other user.  Pppd will log a warning if
1652 this is not the case.
1653 .TP
1654 .B ~/.ppp_pseudonym
1655 Saved client-side SRP-SHA1 pseudonym.  See the \fIsrp-use-pseudonym\fR
1656 option for details.
1657 .TP
1658 .B /etc/ppp/options
1659 System default options for pppd, read before user default options or
1660 command-line options.
1661 .TP
1662 .B ~/.ppprc
1663 User default options, read before /etc/ppp/options.\fIttyname\fR.
1664 .TP
1665 .B /etc/ppp/options.\fIttyname
1666 System default options for the serial port being used, read after
1667 ~/.ppprc.  In forming the \fIttyname\fR part of this
1668 filename, an initial /dev/ is stripped from the port name (if
1669 present), and any slashes in the remaining part are converted to
1670 dots.
1671 .TP
1672 .B /etc/ppp/peers
1673 A directory containing options files which may contain privileged
1674 options, even if pppd was invoked by a user other than root.  The
1675 system administrator can create options files in this directory to
1676 permit non-privileged users to dial out without requiring the peer to
1677 authenticate, but only to certain trusted peers.
1678 .SH SEE ALSO
1679 .TP
1680 .B RFC1144
1681 Jacobson, V.
1682 \fICompressing TCP/IP headers for low-speed serial links.\fR
1683 February 1990.
1684 .TP
1685 .B RFC1321
1686 Rivest, R.
1687 .I The MD5 Message-Digest Algorithm.
1688 April 1992.
1689 .TP
1690 .B RFC1332
1691 McGregor, G.
1692 .I PPP Internet Protocol Control Protocol (IPCP).
1693 May 1992.
1694 .TP
1695 .B RFC1334
1696 Lloyd, B.; Simpson, W.A.
1697 .I PPP authentication protocols.
1698 October 1992.
1699 .TP
1700 .B RFC1661
1701 Simpson, W.A.
1702 .I The Point\-to\-Point Protocol (PPP).
1703 July 1994.
1704 .TP
1705 .B RFC1662
1706 Simpson, W.A.
1707 .I PPP in HDLC-like Framing.
1708 July 1994.
1709 .TP
1710 .B RFC2284
1711 Blunk, L.; Vollbrecht, J.,
1712 .I PPP Extensible Authentication Protocol (EAP).
1713 March 1998.
1714 .TP
1715 .B RFC2472
1716 Haskin, D.
1717 .I IP Version 6 over PPP
1718 December 1998.
1719 .TP
1720 .B RFC2945
1721 Wu, T.,
1722 .I The SRP Authentication and Key Exchange System
1723 September 2000.
1724 .TP
1725 .B draft-ietf-pppext-eap-srp-03.txt
1726 Carlson, J.; et al.,
1727 .I EAP SRP-SHA1 Authentication Protocol.
1728 July 2001.
1729 .SH NOTES
1730 Some limited degree of control can be exercised over a running pppd
1731 process by sending it a signal from the list below.
1732 .TP
1733 .B SIGINT, SIGTERM
1734 These signals cause pppd to terminate the link (by closing LCP),
1735 restore the serial device settings, and exit.
1736 .TP
1737 .B SIGHUP
1738 This signal causes pppd to terminate the link, restore the serial
1739 device settings, and close the serial device.  If the \fIpersist\fR or
1740 \fIdemand\fR option has been specified, pppd will try to reopen the
1741 serial device and start another connection (after the holdoff period).
1742 Otherwise pppd will exit.  If this signal is received during the
1743 holdoff period, it causes pppd to end the holdoff period immediately.
1744 .TP
1745 .B SIGUSR1
1746 This signal toggles the state of the \fIdebug\fR option.
1747 .TP
1748 .B SIGUSR2
1749 This signal causes pppd to renegotiate compression.  This can be
1750 useful to re-enable compression after it has been disabled as a result
1751 of a fatal decompression error.  (Fatal decompression errors generally
1752 indicate a bug in one or other implementation.)
1753
1754 .SH AUTHORS
1755 Paul Mackerras (Paul.Mackerras@samba.org), based on earlier work by
1756 Drew Perkins,
1757 Brad Clements,
1758 Karl Fox,
1759 Greg Christy,
1760 and
1761 Brad Parker.