Debian Codegraph @

upstream/fedora-44/man8/pppd.8

raw
1 .\" manual page [] for pppd 2.5.x
2 .\" SH section heading
3 .\" SS subsection heading
4 .\" LP paragraph
5 .\" IP indented paragraph
6 .\" TP hanging label
7 .\"
8 .\" Copyright (c) 1993-2003 Paul Mackerras <[email protected]>
9 .\"
10 .\" Permission to use, copy, modify, and distribute this software for any
11 .\" purpose with or without fee is hereby granted, provided that the above
12 .\" copyright notice and this permission notice appear in all copies.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
15 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
16 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
17 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
18 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
19 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
20 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 .\"
22 .TH PPPD 8
23 .SH NAME
24 pppd \- Point-to-Point Protocol Daemon
25 .SH SYNOPSIS
26 .B pppd
27 [
28 .I options
29 ]
30 .SH DESCRIPTION
31 .LP
32 PPP is the protocol used for establishing internet links over dial-up
33 modems, DSL connections, and many other types of point-to-point
34 links. The \fIpppd\fR daemon works together with the kernel PPP
35 driver to establish and maintain a PPP link with another system
36 (called the \fIpeer\fR) and to negotiate Internet Protocol (IP)
37 addresses for each end of the link. Pppd can also authenticate the
38 peer and/or supply authentication information to the peer. PPP can be
39 used with other network protocols besides IP, but such use is becoming
40 increasingly rare.
41 .SH FREQUENTLY USED OPTIONS
42 .TP
43 .I ttyname
44 Use the serial port called \fIttyname\fR to communicate with the
45 peer. If \fIttyname\fR does not begin with a slash (/),
46 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 Linux, 4.4BSD and NetBSD, any speed can be specified. Other systems
58 (e.g. 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 additional options from the file /etc/ppp/peers/\fIname\fR. This
85 file may 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 defaultroute-metric
124 Define the metric of the \fIdefaultroute\fR and only add it if there
125 is no other default route with the same metric. With the default
126 value of -1, the route is only added if there is no default route at
127 all.
128 .TP
129 .B replacedefaultroute
130 This option is a flag to the defaultroute option. If defaultroute is
131 set and this flag is also set, pppd replaces an existing default route
132 with the new default route. This option is privileged.
133 .TP
134 .B disconnect \fIscript
135 Execute the command specified by \fIscript\fR, by passing it to a
136 shell, after
137 pppd has terminated the link. This command could, for example, issue
138 commands to the modem to cause it to hang up if hardware modem control
139 signals were not available. The disconnect script is not run if the
140 modem has already hung up. A value for this option from a privileged
141 source cannot be overridden by a non-privileged user.
142 .TP
143 .B escape \fIxx,yy,...
144 Specifies that certain characters should be escaped on transmission
145 (regardless of whether the peer requests them to be escaped with its
146 async control character map). The characters to be escaped are
147 specified as a list of hex numbers separated by commas. Note that
148 almost any character can be specified for the \fIescape\fR option,
149 unlike the \fIasyncmap\fR option which only allows control characters
150 to be specified. The characters which may not be escaped are those
151 with hex values 0x20 - 0x3f or 0x5e.
152 .TP
153 .B file \fIname
154 Read options from file \fIname\fR (the format is described below).
155 The file must be readable by the user who has invoked pppd.
156 .TP
157 .B init \fIscript
158 Execute the command specified by \fIscript\fR, by passing it to a shell, to
159 initialize the serial line. This script would typically use the
160 chat(8) program to configure the modem to enable auto answer. A value
161 for this option from a privileged source cannot be overridden by a
162 non-privileged user.
163 .TP
164 .B lock
165 Specifies that pppd should create a UUCP-style lock file for the
166 serial device to ensure exclusive access to the device. By default,
167 pppd will not create a lock file.
168 .TP
169 .B mru \fIn
170 Set the MRU [Maximum Receive Unit] value to \fIn\fR. Pppd
171 will ask the peer to send packets of no more than \fIn\fR bytes.
172 The value of \fIn\fR must be between 128 and 16384; the default is 1500.
173 A value of
174 296 works well on very slow links (40 bytes for TCP/IP header + 256
175 bytes of data).
176 Note that for the IPv6 protocol, the MRU must be at least 1280.
177 .TP
178 .B mtu \fIn
179 Set the MTU [Maximum Transmit Unit] value to \fIn\fR. Unless the
180 peer requests a smaller value via MRU negotiation, pppd will
181 request that the kernel networking code send data packets of no more
182 than \fIn\fR bytes through the PPP network interface. Note that for
183 the IPv6 protocol, the MTU must be at least 1280.
184 .TP
185 .B passive
186 Enables the "passive" option in the LCP. With this option, pppd will
187 attempt to initiate a connection; if no reply is received from the
188 peer, pppd will then just wait passively for a valid LCP packet from
189 the peer, instead of exiting, as it would without this option.
190 .SH OPTIONS
191 .TP
192 .I <local_IP_address>\fB:\fI<remote_IP_address>
193 Set the local and/or remote interface IP addresses. Either one may be
194 omitted. The IP addresses can be specified with a host name or in
195 decimal dot notation (e.g. 150.234.56.78). The default local
196 address is the (first) IP address of the system (unless the
197 \fInoipdefault\fR
198 option is given). The remote address will be obtained from the peer
199 if not specified in any option. Thus, in simple cases, this option is
200 not required. If a local and/or remote IP address is specified with
201 this option, pppd
202 will not accept a different value from the peer in the IPCP
203 negotiation, unless the \fIipcp\-accept\-local\fR and/or
204 \fIipcp\-accept\-remote\fR options are given, respectively.
205 .TP
206 .B +ipv6
207 Enable the IPv6CP and IPv6 protocols.
208 .TP
209 .B ipv6 \fI<local_interface_identifier>\fR,\fI<remote_interface_identifier>
210 Set the local and/or remote 64-bit interface identifier. Either one may be
211 omitted. The identifier must be specified in standard ASCII notation of
212 IPv6 addresses (e.g. ::dead:beef). If the
213 \fIipv6cp\-use\-ipaddr\fR
214 option is given, the local identifier is the local IPv4 address and the
215 remote identifier is the remote IPv4 address (see above).
216 If the \fIipv6cp-use-remotenumber\fR option is given, the remote identifier
217 is set to the value from \fIremotenumber\fR option.
218 On systems which supports a unique persistent id, such as EUI\-48 derived
219 from the Ethernet MAC address, \fIipv6cp\-use\-persistent\fR option can be
220 used to set local identifier. Otherwise both local and remote identifiers
221 are randomized.
222 .TP
223 .B active\-filter \fIfilter\-expression
224 Specifies a packet filter to be applied to data packets to determine
225 which packets are to be regarded as link activity, and therefore reset
226 the idle timer, or cause the link to be brought up in demand-dialling
227 mode. This option is useful in conjunction with the
228 \fBidle\fR option if there are packets being sent or received
229 regularly over the link (for example, routing information packets)
230 which would otherwise prevent the link from ever appearing to be idle.
231 The \fIfilter\-expression\fR syntax is as described for tcpdump(1),
232 except that qualifiers which are inappropriate for a PPP link, such as
233 \fBether\fR and \fBarp\fR, are not permitted. Generally the filter
234 expression should be enclosed in single-quotes to prevent whitespace
235 in the expression from being interpreted by the shell. This option
236 is currently only available under Linux, and requires that the kernel
237 was configured to include PPP filtering support (CONFIG_PPP_FILTER).
238 Note that it
239 is possible to apply different constraints to incoming and outgoing
240 packets using the \fBinbound\fR and \fBoutbound\fR qualifiers.
241 .TP
242 .B allow\-ip \fIaddress(es)
243 Allow peers to use the given IP address or subnet without
244 authenticating themselves. The parameter is parsed as for each
245 element of the list of allowed IP addresses in the secrets files (see
246 the AUTHENTICATION section below).
247 .TP
248 .B allow\-number \fInumber
249 Allow peers to connect from the given telephone number. A trailing
250 `*' character will match all numbers beginning with the leading part.
251 .TP
252 .B bsdcomp \fInr,nt
253 Request that the peer compress packets that it sends, using the
254 BSD-Compress scheme, with a maximum code size of \fInr\fR bits, and
255 agree to compress packets sent to the peer with a maximum code size of
256 \fInt\fR bits. If \fInt\fR is not specified, it defaults to the value
257 given for \fInr\fR. Values in the range 9 to 15 may be used for
258 \fInr\fR and \fInt\fR; larger values give better compression but
259 consume more kernel memory for compression dictionaries.
260 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
261 compression in the corresponding direction. Use \fInobsdcomp\fR or
262 \fIbsdcomp 0\fR to disable BSD-Compress compression entirely.
263 .TP
264 .B ca \fIca-file
265 (EAP-TLS, or PEAP) Use the file \fIca-file\fR as the X.509 Certificate Authority
266 (CA) file (in PEM format), needed for setting up an EAP-TLS connection.
267 This option is used on the client-side in conjunction with the \fBcert\fR
268 and \fBkey\fR options. Either \fIca\fR, or \fIcapath\fR options are required
269 for PEAP. EAP-TLS may also use the entry in eaptls-client or eaptls-server
270 for a CA certificate associated with a particular peer.
271 .TP
272 .B capath \fIpath
273 (EAP-TLS, or PEAP) Specify a location that contains public CA certificates.
274 Either \fIca\fR, or \fIcapath\fR options are required for PEAP.
275 .TP
276 .B cdtrcts
277 Use a non-standard hardware flow control (i.e. DTR/CTS) to control
278 the flow of data on the serial port. If neither the \fIcrtscts\fR,
279 the \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR
280 option is given, the hardware flow control setting for the serial
281 port is left unchanged.
282 Some serial ports (such as Macintosh serial ports) lack a true
283 RTS output. Such serial ports use this mode to implement true
284 bi-directional flow control. The sacrifice is that this flow
285 control mode does not permit using DTR as a modem control line.
286 .TP
287 .B cert \fIcertfile
288 (EAP-TLS) Use the file \fIcertfile\fR as the X.509 certificate (in PEM
289 format), needed for setting up an EAP-TLS connection. This option is
290 used on the client-side in conjunction with the \fBca\fR and
291 \fBkey\fR options.
292 .TP
293 .B chap\-interval \fIn
294 If this option is given, pppd will rechallenge the peer every \fIn\fR
295 seconds.
296 .TP
297 .B chap\-max\-challenge \fIn
298 Set the maximum number of CHAP challenge transmissions to \fIn\fR
299 (default 10).
300 .TP
301 .B chap\-restart \fIn
302 Set the CHAP restart interval (retransmission timeout for challenges)
303 to \fIn\fR seconds (default 3).
304 .TP
305 .B chap-timeout \fIn
306 Set timeout for CHAP authentication by peer to \fIn\fR seconds (default 60).
307 .TP
308 .B chapms\-strip\-domain
309 Some Windows 9x/ME clients might be transmitting the MS domain before the
310 username in the provided client name. This option enables stripping the domain
311 from the client name on the server side before matching it against the secret
312 file.
313 .TP
314 .B child\-timeout \fIn
315 When exiting, wait for up to \fIn\fR seconds for any child processes
316 (such as the command specified with the \fBpty\fR command) to exit
317 before exiting. At the end of the timeout, pppd will send a SIGTERM
318 signal to any remaining child processes and exit. A value of 0 means
319 no timeout, that is, pppd will wait until all child processes have
320 exited.
321 .TP
322 .B connect\-delay \fIn
323 Wait for up to \fIn\fR milliseconds after the connect script finishes for
324 a valid PPP packet from the peer. At the end of this time, or when a
325 valid PPP packet is received from the peer, pppd will commence
326 negotiation by sending its first LCP packet. The default value is
327 1000 (1 second). This wait period only applies if the \fBconnect\fR
328 or \fBpty\fR option is used.
329 .TP
330 .B crl \fIfilename
331 (EAP-TLS, or PEAP) Use the file \fIfilename\fR as the Certificate Revocation List
332 to check for the validity of the peer's certificate. This option is not
333 mandatory for setting up a TLS connection. Also see the \fBcrl-dir\fR
334 option.
335 .TP
336 .B crl-dir \fIdirectory
337 (EAP-TLS, or PEAP) Use the directory \fIdirectory\fR to scan for CRL files in
338 has format ($hash.r0) to check for the validity of the peer's certificate.
339 This option is not mandatory for setting up a TLS connection.
340 Also see the \fBcrl\fR option.
341 .TP
342 .B debug
343 Enables connection debugging facilities.
344 If this option is given, pppd will log the contents of all
345 control packets sent or received in a readable form. The packets are
346 logged through syslog with facility \fIdaemon\fR and level
347 \fIdebug\fR. This information can be directed to a file by setting up
348 /etc/syslog.conf appropriately (see syslog.conf(5)).
349 .TP
350 .B default\-asyncmap
351 Disable asyncmap negotiation, forcing all control characters to be
352 escaped for both the transmit and the receive direction.
353 .TP
354 .B default\-mru
355 Disable MRU [Maximum Receive Unit] negotiation. With this option,
356 pppd will use the default MRU value of 1500 bytes for both the
357 transmit and receive direction.
358 .TP
359 .B defaultroute6
360 Add a default IPv6 route to the system routing tables, using the peer as
361 the gateway, when IPv6CP negotiation is successfully completed.
362 This entry is removed when the PPP connection is broken. This option
363 is privileged if the \fInodefaultroute6\fR option has been specified.
364 \fBWARNING: Do not enable this option by default\fR. IPv6 routing tables
365 are managed by kernel (as apposite to IPv4) and IPv6 default route is
366 configured by kernel automatically too based on ICMPv6 Router Advertisement
367 packets. This option may conflict with kernel IPv6 route setup and should
368 be used only for broken IPv6 networks.
369 .TP
370 .B deflate \fInr,nt
371 Request that the peer compress packets that it sends, using the
372 Deflate scheme, with a maximum window size of \fI2**nr\fR bytes, and
373 agree to compress packets sent to the peer with a maximum window size
374 of \fI2**nt\fR bytes. If \fInt\fR is not specified, it defaults to
375 the value given for \fInr\fR. Values in the range 9 to 15 may be used
376 for \fInr\fR and \fInt\fR; larger values give better compression but
377 consume more kernel memory for compression dictionaries.
378 Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables
379 compression in the corresponding direction. Use \fInodeflate\fR or
380 \fIdeflate 0\fR to disable Deflate compression entirely. (Note: pppd
381 requests Deflate compression in preference to BSD-Compress if the peer
382 can do either.)
383 .TP
384 .B demand
385 Initiate the link only on demand, i.e. when data traffic is present.
386 With this option, the remote IP address may be specified by the user
387 on the command line or in an options file, or if not, pppd will use
388 an arbitrary address in the 10.x.x.x range. Pppd will initially
389 configure the interface and enable it for IP traffic without
390 connecting to the peer. When traffic is available, pppd will
391 connect to the peer and perform negotiation, authentication, etc.
392 When this is completed, pppd will commence passing data packets
393 (i.e., IP packets) across the link.
394
395 The \fIdemand\fR option implies the \fIpersist\fR option. If this
396 behaviour is not desired, use the \fInopersist\fR option after the
397 \fIdemand\fR option. The \fIidle\fR and \fIholdoff\fR
398 options are also useful in conjunction with the \fIdemand\fR option.
399 .TP
400 .B domain \fId
401 Append the domain name \fId\fR to the local host name for authentication
402 purposes. For example, if gethostname() returns the name porsche, but
403 the fully qualified domain name is porsche.Quotron.COM, you could
404 specify \fIdomain Quotron.COM\fR. Pppd would then use the name
405 \fIporsche.Quotron.COM\fR for looking up secrets in the secrets file,
406 and as the default name to send to the peer when authenticating itself
407 to the peer. This option is privileged.
408 .TP
409 .B dryrun
410 With the \fBdryrun\fR option, pppd will print out all the option
411 values which have been set and then exit, after parsing the command
412 line and options files and checking the option values, but before
413 initiating the link. The option values are logged at level info, and
414 also printed to standard output unless the device on standard output
415 is the device that pppd would be using to communicate with the peer.
416 .TP
417 .B dump
418 With the \fBdump\fR option, pppd will print out all the option values
419 which have been set. This option is like the \fBdryrun\fR option
420 except that pppd proceeds as normal rather than exiting.
421 .TP
422 .B enable-session
423 Enables session accounting via PAM or wtwp/wtmpx, as appropriate.
424 When PAM is enabled, the PAM "account" and "session" module stacks
425 determine behavior, and are enabled for all PPP authentication
426 protocols. When PAM is disabled, wtmp/wtmpx entries are recorded
427 regardless of whether the peer name identifies a valid user on the
428 local system, making peers visible in the last(1) log. This feature
429 is automatically enabled when the pppd \fBlogin\fR option is used.
430 Session accounting is disabled by default.
431 .TP
432 .B endpoint \fI<epdisc>
433 Sets the endpoint discriminator sent by the local machine to the peer
434 during multilink negotiation to \fI<epdisc>\fR. The default is to use
435 the MAC address of the first ethernet interface on the system, if any,
436 otherwise the IPv4 address corresponding to the hostname, if any,
437 provided it is not in the multicast or locally-assigned IP address
438 ranges, or the localhost address. The endpoint discriminator can be
439 the string \fBnull\fR or of the form \fItype\fR:\fIvalue\fR, where
440 type is a decimal number or one of the strings \fBlocal\fR, \fBIP\fR,
441 \fBMAC\fR, \fBmagic\fR, or \fBphone\fR. The value is an IP address in
442 dotted-decimal notation for the \fBIP\fR type, or a string of bytes in
443 hexadecimal, separated by periods or colons for the other types. For
444 the MAC type, the value may also be the name of an ethernet or similar
445 network interface. This option is currently only available under
446 Linux.
447 .TP
448 .B eap\-interval \fIn
449 If this option is given and pppd authenticates the peer with EAP
450 (i.e., is the server), pppd will restart EAP authentication every
451 \fIn\fR seconds. For EAP SRP\-SHA1, see also the \fBsrp\-interval\fR
452 option, which enables lightweight rechallenge.
453 .TP
454 .B eap\-max\-rreq \fIn
455 Set the maximum number of EAP Requests to which pppd will respond (as
456 a client) without hearing EAP Success or Failure. (Default is 20.)
457 .TP
458 .B eap\-max\-sreq \fIn
459 Set the maximum number of EAP Requests that pppd will issue (as a
460 server) while attempting authentication. (Default is 10.)
461 .TP
462 .B eap\-restart \fIn
463 Set the retransmit timeout for EAP Requests when acting as a server
464 (authenticator). (Default is 3 seconds.)
465 .TP
466 .B eap\-timeout \fIn
467 Set the maximum time to wait for the peer to send an EAP Request when
468 acting as a client (authenticatee). (Default is 20 seconds.)
469 .TP
470 .B hide\-password
471 When logging the contents of PAP packets, this option causes pppd to
472 exclude the password string from the log. This is the default.
473 .TP
474 .B holdoff \fIn
475 Specifies how many seconds to wait before re-initiating the link after
476 it terminates. This option only has any effect if the \fIpersist\fR
477 or \fIdemand\fR option is used. The holdoff period is not applied if
478 the link was terminated because it was idle.
479 .TP
480 .B idle \fIn
481 Specifies that pppd should disconnect if the link is idle for \fIn\fR
482 seconds. The link is idle when no data packets (i.e. IP packets) are
483 being sent or received. Note: it is not advisable to use this option
484 with the \fIpersist\fR option without the \fIdemand\fR option.
485 If the \fBactive\-filter\fR
486 option is given, data packets which are rejected by the specified
487 activity filter also count as the link being idle.
488 .TP
489 .B ipcp\-accept\-local
490 With this option, pppd will accept the peer's idea of our local IP
491 address, even if the local IP address was specified in an option.
492 .TP
493 .B ipcp\-accept\-remote
494 With this option, pppd will accept the peer's idea of its (remote) IP
495 address, even if the remote IP address was specified in an option.
496 .TP
497 .B ipcp\-max\-configure \fIn
498 Set the maximum number of IPCP configure-request transmissions to
499 \fIn\fR (default 10).
500 .TP
501 .B ipcp\-max\-failure \fIn
502 Set the maximum number of IPCP configure-NAKs returned before starting
503 to send configure-Rejects instead to \fIn\fR (default 10).
504 .TP
505 .B ipcp\-max\-terminate \fIn
506 Set the maximum number of IPCP terminate-request transmissions to
507 \fIn\fR (default 3).
508 .TP
509 .B ipcp\-no\-address
510 Disable negotiation of addresses via IP-Address IPCP option.
511 .TP
512 .B ipcp\-no\-addresses
513 Disable negotiation of addresses via old-style deprecated IP-Addresses
514 IPCP option. pppd by default try to use new-style IP-Address IPCP option.
515 If new-style is not supported by peer or is disabled by \fBipcp\-no\-address\fR
516 option then pppd fallbacks to old-style deprecated IP-Addresses IPCP option.
517 When both new-style and old-style are disabled by both \fBipcp\-no\-address\fR
518 and \fBipcp\-no\-addresses\fR options then negotiation of IP addresses
519 is completely disabled.
520 .TP
521 .B ipcp\-restart \fIn
522 Set the IPCP restart interval (retransmission timeout) to \fIn\fR
523 seconds (default 3).
524 .TP
525 .B ipparam \fIstring
526 Provides an extra parameter most of the notification scripts, most notably
527 ip\-up, ip\-pre\-up, ip\-down, ipv6\-up, ipv6\-down, auth\-up and auth\-down
528 scripts. If this
529 option is given, the \fIstring\fR supplied is given as the 6th
530 parameter to those scripts.
531 .TP
532 .B ipv6cp\-accept\-local
533 With this option, pppd will accept the peer's idea of our local IPv6
534 interface identifier, even if the local IPv6 interface identifier
535 was specified in an option.
536 .TP
537 .B ipv6cp\-accept\-remote
538 With this option, pppd will accept the peer's idea of its (remote)
539 IPv6 interface identifier, even if the remote IPv6 interface
540 identifier was specified in an option.
541 .TP
542 .B ipv6cp\-noremote
543 Allow pppd to operate without having an IPv6 link local address for the peer.
544 This option is only available under Linux. Normally, pppd will request the
545 peer's IPv6 interface identifier (used for composing IPv6 link local address),
546 and if the peer does not supply it, pppd will generate one for the peer.
547 With this option, if the peer does not supply its IPv6 interface identifier,
548 pppd will not ask the peer for it, and will not set the destination IPv6
549 link local address of the ppp interface. In this situation, the ppp interface
550 can be used for routing by creating device routes, but the peer itself cannot
551 be addressed directly for IPv6 traffic until the peer starts announcing ICMPv6
552 Router Advertisement or ICMPv6 Neighbor Advertisement packets. Note that IPv6
553 router must announce ICMPv6 Router Advertisement packets.
554 .TP
555 .B ipv6cp\-nosendip
556 Don't send our local IPv6 interface identifier to peer during IPv6 interface
557 identifier negotiation.
558 .TP
559 .B ipv6cp\-max\-configure \fIn
560 Set the maximum number of IPv6CP configure-request transmissions to
561 \fIn\fR (default 10).
562 .TP
563 .B ipv6cp\-max\-failure \fIn
564 Set the maximum number of IPv6CP configure-NAKs returned before starting
565 to send configure-Rejects instead to \fIn\fR (default 10).
566 .TP
567 .B ipv6cp\-max\-terminate \fIn
568 Set the maximum number of IPv6CP terminate-request transmissions to
569 \fIn\fR (default 3).
570 .TP
571 .B ipv6cp\-restart \fIn
572 Set the IPv6CP restart interval (retransmission timeout) to \fIn\fR
573 seconds (default 3).
574 .TP
575 .B kdebug \fIn
576 Enable debugging code in the kernel-level PPP driver. The argument
577 values depend on the specific kernel driver, but in general a value of
578 1 will enable general kernel debug messages. (Note that these
579 messages are usually only useful for debugging the kernel driver
580 itself.) For the Linux 2.2.x kernel driver, the value is a sum of
581 bits: 1 to
582 enable general debug messages, 2 to request that the contents of
583 received packets be printed, and 4 to request that the contents of
584 transmitted packets be printed. On most systems, messages printed by
585 the kernel are logged by syslog(1) to a file as directed in the
586 /etc/syslog.conf configuration file.
587 .TP
588 .B key \fIkeyfile
589 (EAP-TLS) Use the file \fIkeyfile\fR as the private key file (in PEM
590 format), needed for setting up an EAP-TLS connection. This option is
591 used on the client-side in conjunction with the \fBca\fR and
592 \fBcert\fR options.
593 .TP
594 .B ktune
595 Enables pppd to alter kernel settings as appropriate. Under Linux,
596 pppd will enable IP forwarding (i.e. set /proc/sys/net/ipv4/ip_forward
597 to 1) if the \fIproxyarp\fR option is used, and will enable the
598 dynamic IP address option (i.e. set /proc/sys/net/ipv4/ip_dynaddr to
599 1) in demand mode if the local address changes.
600 .TP
601 .B lcp\-echo\-adaptive
602 If this option is used with the \fIlcp\-echo\-failure\fR option then
603 pppd will send LCP echo\-request frames only if no traffic was received
604 from the peer since the last echo\-request was sent.
605 .TP
606 .B lcp\-echo\-failure \fIn
607 If this option is given, pppd will presume the peer to be dead
608 if \fIn\fR LCP echo\-requests are sent without receiving a valid LCP
609 echo\-reply. If this happens, pppd will terminate the
610 connection. Use of this option requires a non-zero value for the
611 \fIlcp\-echo\-interval\fR parameter. This option can be used to enable
612 pppd to terminate after the physical connection has been broken
613 (e.g., the modem has hung up) in situations where no hardware modem
614 control lines are available.
615 .TP
616 .B lcp\-echo\-interval \fIn
617 If this option is given, pppd will send an LCP echo\-request frame to
618 the peer every \fIn\fR seconds. Normally the peer should respond to
619 the echo\-request by sending an echo\-reply. This option can be used
620 with the \fIlcp\-echo\-failure\fR option to detect that the peer is no
621 longer connected.
622 .TP
623 .B lcp\-max\-configure \fIn
624 Set the maximum number of LCP configure-request transmissions to
625 \fIn\fR (default 10).
626 .TP
627 .B lcp\-max\-failure \fIn
628 Set the maximum number of LCP configure-NAKs returned before starting
629 to send configure-Rejects instead to \fIn\fR (default 10).
630 .TP
631 .B lcp\-max\-terminate \fIn
632 Set the maximum number of LCP terminate-request transmissions to
633 \fIn\fR (default 3).
634 .TP
635 .B lcp\-restart \fIn
636 Set the LCP restart interval (retransmission timeout) to \fIn\fR
637 seconds (default 3).
638 .TP
639 .B lcp\-rtt\-file \fIfilename
640 Sets the file where the round-trip time (RTT) of LCP echo-request frames
641 will be logged.
642 .TP
643 .B linkname \fIname\fR
644 Sets the logical name of the link to \fIname\fR. Pppd will create a
645 file named \fBppp\-\fIname\fB.pid\fR in /var/run (or /etc/ppp on some
646 systems) containing its process ID. This can be useful in determining
647 which instance of pppd is responsible for the link to a given peer
648 system. This is a privileged option.
649 .TP
650 .B local
651 Don't use the modem control lines. With this option, pppd will ignore
652 the state of the CD (Carrier Detect) signal from the modem and will
653 not change the state of the DTR (Data Terminal Ready) signal. This is
654 the opposite of the \fBmodem\fR option.
655 .TP
656 .B logfd \fIn
657 Send log messages to file descriptor \fIn\fR. Pppd will send log
658 messages to at most one file or file descriptor (as well as sending
659 the log messages to syslog), so this option and the \fBlogfile\fR
660 option are mutually exclusive. The default is for pppd to send log
661 messages to stdout (file descriptor 1), unless the serial port is
662 already open on stdout.
663 .TP
664 .B logfile \fIfilename
665 Append log messages to the file \fIfilename\fR (as well as sending the
666 log messages to syslog). The file is opened with the privileges of
667 the user who invoked pppd, in append mode.
668 .TP
669 .B login
670 Use the system password database for authenticating the peer using
671 PAP, and record the user in the system wtmp file. Note that the peer
672 must have an entry in the /etc/ppp/pap\-secrets file as well as the
673 system password database to be allowed access. See also the
674 \fBenable\-session\fR option.
675 .TP
676 .B master_detach
677 If multilink is enabled and this pppd process is the multilink bundle
678 master, and the link controlled by this pppd process terminates, this
679 pppd process continues to run in order to maintain the bundle. If the
680 \fBmaster_detach\fR option has been given, pppd will detach from its
681 controlling terminal in this situation, even if the \fBnodetach\fR
682 option has been given.
683 .TP
684 .B maxconnect \fIn
685 Terminate the connection when it has been available for network
686 traffic for \fIn\fR seconds (i.e. \fIn\fR seconds after the first
687 network control protocol comes up).
688 .TP
689 .B maxfail \fIn
690 Terminate after \fIn\fR consecutive failed connection attempts. A
691 value of 0 means no limit. The default value is 10.
692 .TP
693 .B max\-tls-\version \fIstring
694 (EAP-TLS, or PEAP) Configures the max allowed TLS version used during
695 negotiation with a peer. The default value for this is \fI1.2\fR. Values
696 allowed for this option is \fI1.0.\fR, \fI1.1\fR, \fI1.2\fR, \fI1.3\fR.
697 .TP
698 .B modem
699 Use the modem control lines. This option is the default. With this
700 option, pppd will wait for the CD (Carrier Detect) signal from the
701 modem to be asserted when opening the serial device (unless a connect
702 script is specified), and it will drop the DTR (Data Terminal Ready)
703 signal briefly when the connection is terminated and before executing
704 the connect script. On Ultrix, this option implies hardware flow
705 control, as for the \fIcrtscts\fR option. This is the opposite of the
706 \fBlocal\fR option.
707 .TP
708 .B mp
709 Enables the use of PPP multilink; this is an alias for the `multilink'
710 option. This option is currently only available under Linux.
711 .TP
712 .B mppe\-stateful
713 Allow MPPE to use stateful mode. Stateless mode is still attempted first.
714 The default is to disallow stateful mode.
715 .TP
716 .B mpshortseq
717 Enables the use of short (12-bit) sequence numbers in multilink
718 headers, as opposed to 24-bit sequence numbers. This option is only
719 available under Linux, and only has any effect if multilink is
720 enabled (see the multilink option).
721 .TP
722 .B mrru \fIn
723 Sets the Maximum Reconstructed Receive Unit to \fIn\fR. The MRRU is
724 the maximum size for a received packet on a multilink bundle, and is
725 analogous to the MRU for the individual links. This option is
726 currently only available under Linux, and only has any effect if
727 multilink is enabled (see the multilink option).
728 .TP
729 .B ms\-dns \fI<addr>
730 If pppd is acting as a server for Microsoft Windows clients, this
731 option allows pppd to supply one or two DNS (Domain Name Server)
732 addresses to the clients. The first instance of this option specifies
733 the primary DNS address; the second instance (if given) specifies the
734 secondary DNS address. (This option was present in some older
735 versions of pppd under the name \fBdns\-addr\fR.)
736 .TP
737 .B ms\-wins \fI<addr>
738 If pppd is acting as a server for Microsoft Windows or "Samba"
739 clients, this option allows pppd to supply one or two WINS (Windows
740 Internet Name Services) server addresses to the clients. The first
741 instance of this option specifies the primary WINS address; the second
742 instance (if given) specifies the secondary WINS address.
743 .TP
744 .B multilink
745 Enables the use of the PPP multilink protocol. If the peer also
746 supports multilink, then this link can become part of a bundle between
747 the local system and the peer. If there is an existing bundle to the
748 peer, pppd will join this link to that bundle, otherwise pppd will
749 create a new bundle. See the MULTILINK section below. This option is
750 currently only available under Linux.
751 .TP
752 .B name \fIname
753 Set the name of the local system for authentication purposes to
754 \fIname\fR. This is a privileged option. With this option, pppd will
755 use lines in the secrets files which have \fIname\fR as the second
756 field when looking for a secret to use in authenticating the peer. In
757 addition, unless overridden with the \fIuser\fR option, \fIname\fR
758 will be used as the name to send to the peer when authenticating the
759 local system to the peer. (Note that pppd does not append the domain
760 name to \fIname\fR.)
761 .TP
762 .B netmask \fImask
763 Set the IPV4 network mask on the PPP interface to the given
764 \fImask\fR, which can be given in dotted-quad notation or as a single
765 hexadecimal number preceded by 0x. This option is not normally
766 needed because the PPP interface is a point-to-point connection, but
767 in some specialized circumstances it can be useful.
768 .TP
769 .B noaccomp
770 Disable Address/Control compression in both directions (send and
771 receive).
772 .TP
773 .B need\-peer\-eap
774 (EAP-TLS) Require the peer to verify our authentication credentials.
775 .TP
776 .B noauth
777 Do not require the peer to authenticate itself. This option is
778 privileged.
779 .TP
780 .B nobsdcomp
781 Disables BSD-Compress compression; \fBpppd\fR will not request or
782 agree to compress packets using the BSD-Compress scheme.
783 .TP
784 .B noccp
785 Disable CCP (Compression Control Protocol) negotiation. This option
786 should only be required if the peer is buggy and gets confused by
787 requests from pppd for CCP negotiation.
788 .TP
789 .B nocrtscts
790 Disable hardware flow control (i.e. RTS/CTS) on the serial port.
791 If neither the \fIcrtscts\fR nor the \fInocrtscts\fR nor the
792 \fIcdtrcts\fR nor the \fInocdtrcts\fR option is given, the hardware
793 flow control setting for the serial port is left unchanged.
794 .TP
795 .B nocdtrcts
796 This option is a synonym for \fInocrtscts\fR. Either of these options will
797 disable both forms of hardware flow control.
798 .TP
799 .B nodefaultroute
800 Disable the \fIdefaultroute\fR option. The system administrator who
801 wishes to prevent users from adding a default route with pppd
802 can do so by placing this option in the /etc/ppp/options file.
803 .TP
804 .B noreplacedefaultroute
805 Disable the \fIreplacedefaultroute\fR option. This allows to disable a
806 \fIreplacedefaultroute\fR option set previously in the configuration.
807 .TP
808 .B nodefaultroute6
809 Disable the \fIdefaultroute6\fR option. The system administrator who
810 wishes to prevent users from adding a default route with pppd
811 can do so by placing this option in the /etc/ppp/options file.
812 .TP
813 .B nodeflate
814 Disables Deflate compression; pppd will not request or agree to
815 compress packets using the Deflate scheme.
816 .TP
817 .B nodetach
818 Don't detach from the controlling terminal. Without this option, if a
819 serial device other than the terminal on the standard input is
820 specified, pppd will fork to become a background process.
821 .TP
822 .B noendpoint
823 Disables pppd from sending an endpoint discriminator to the peer or
824 accepting one from the peer (see the MULTILINK section below). This
825 option should only be required if the peer is buggy.
826 .TP
827 .B noip
828 Disable IPCP negotiation and IP communication. This option should
829 only be required if the peer is buggy and gets confused by requests
830 from pppd for IPCP negotiation.
831 .TP
832 .B noipv6
833 Disable IPv6CP negotiation and IPv6 communication. This option should
834 only be required if the peer is buggy and gets confused by requests
835 from pppd for IPv6CP negotiation.
836 .TP
837 .B noipdefault
838 Disables the default behaviour when no local IP address is specified,
839 which is to determine (if possible) the local IP address from the
840 hostname. With this option, the peer will have to supply the local IP
841 address during IPCP negotiation (unless it specified explicitly on the
842 command line or in an options file).
843 .TP
844 .B noktune
845 Opposite of the \fIktune\fR option; disables pppd from changing system
846 settings.
847 .TP
848 .B nolock
849 Opposite of the \fIlock\fR option; specifies that pppd should not
850 create a UUCP-style lock file for the serial device. This option is
851 privileged.
852 .TP
853 .B nolog
854 Do not send log messages to a file or file descriptor. This option
855 cancels the \fBlogfd\fR and \fBlogfile\fR options.
856 .TP
857 .B nomagic
858 Disable magic number negotiation. With this option, pppd cannot
859 detect a looped-back line. This option should only be needed if the
860 peer is buggy.
861 .TP
862 .B nomp
863 Disables the use of PPP multilink. This option is currently only
864 available under Linux.
865 .TP
866 .B nomppe
867 Disables MPPE (Microsoft Point to Point Encryption). This is the default.
868 .TP
869 .B nomppe\-40
870 Disable 40-bit encryption with MPPE.
871 .TP
872 .B nomppe\-128
873 Disable 128-bit encryption with MPPE.
874 .TP
875 .B nomppe\-stateful
876 Disable MPPE stateful mode. This is the default.
877 .TP
878 .B nompshortseq
879 Disables the use of short (12-bit) sequence numbers in the PPP
880 multilink protocol, forcing the use of 24-bit sequence numbers. This
881 option is currently only available under Linux, and only has any
882 effect if multilink is enabled.
883 .TP
884 .B nomultilink
885 Disables the use of PPP multilink. This option is currently only
886 available under Linux.
887 .TP
888 .B nopcomp
889 Disable protocol field compression negotiation in both the receive and
890 the transmit direction.
891 .TP
892 .B nopersist
893 Exit once a connection has been made and terminated. This is the
894 default unless the \fIpersist\fR or \fIdemand\fR option has been
895 specified.
896 .TP
897 .B nopredictor1
898 Do not accept or agree to Predictor\-1 compression.
899 .TP
900 .B noproxyarp
901 Disable the \fIproxyarp\fR option. The system administrator who
902 wishes to prevent users from creating proxy ARP entries with pppd can
903 do so by placing this option in the /etc/ppp/options file.
904 .TP
905 .B noremoteip
906 Allow pppd to operate without having an IP address for the peer. This
907 option is only available under Linux. Normally, pppd will request the
908 peer's IP address, and if the peer does not supply it, pppd will use
909 an arbitrary address in the 10.x.x.x subnet.
910 With this option, if the peer does
911 not supply its IP address, pppd will not ask the peer for it, and will
912 not set the destination address of the ppp interface. In this
913 situation, the ppp interface can be used for routing by creating
914 device routes, but the peer itself cannot be addressed directly for IP
915 traffic.
916 .TP
917 .B nosendip
918 Don't send our local IP address to peer during IP address negotiation.
919 .TP
920 .B notty
921 Normally, pppd requires a terminal device. With this option, pppd
922 will allocate itself a pseudo-tty master/slave pair and use the slave
923 as its terminal device. Pppd will create a child process to act as a
924 `character shunt' to transfer characters between the pseudo-tty master
925 and its standard input and output. Thus pppd will transmit characters
926 on its standard output and receive characters on its standard input
927 even if they are not terminal devices. This option increases the
928 latency and CPU overhead of transferring data over the ppp interface
929 as all of the characters sent and received must flow through the
930 character shunt process. An explicit device name may not be given if
931 this option is used.
932 .TP
933 .B novj
934 Disable Van Jacobson style TCP/IP header compression in both the
935 transmit and the receive direction.
936 .TP
937 .B novjccomp
938 Disable the connection-ID compression option in Van Jacobson style
939 TCP/IP header compression. With this option, pppd will not omit the
940 connection-ID byte from Van Jacobson compressed TCP/IP headers, nor
941 ask the peer to do so.
942 .TP
943 .B papcrypt
944 Indicates that all secrets in the /etc/ppp/pap\-secrets file which are
945 used for checking the identity of the peer are encrypted, and thus
946 pppd should not accept a password which, before encryption, is
947 identical to the secret from the /etc/ppp/pap\-secrets file.
948 .TP
949 .B pap\-max\-authreq \fIn
950 Set the maximum number of PAP authenticate-request transmissions to
951 \fIn\fR (default 10).
952 .TP
953 .B pap\-restart \fIn
954 Set the PAP restart interval (retransmission timeout) to \fIn\fR
955 seconds (default 3).
956 .TP
957 .B pap\-timeout \fIn
958 Set the maximum time that pppd will wait for the peer to authenticate
959 itself with PAP to \fIn\fR seconds (0 means no limit).
960 .TP
961 .B pass\-filter \fIfilter\-expression
962 Specifies a packet filter to applied to data packets being sent or
963 received to determine which packets should be allowed to pass.
964 Packets which are rejected by the filter are silently discarded. This
965 option can be used to prevent specific network daemons (such as
966 routed) using up link bandwidth, or to provide a very basic firewall
967 capability.
968 The \fIfilter\-expression\fR syntax is as described for tcpdump(1),
969 except that qualifiers which are inappropriate for a PPP link, such as
970 \fBether\fR and \fBarp\fR, are not permitted. Generally the filter
971 expression should be enclosed in single-quotes to prevent whitespace
972 in the expression from being interpreted by the shell. Note that it
973 is possible to apply different constraints to incoming and outgoing
974 packets using the \fBinbound\fR and \fBoutbound\fR qualifiers. This
975 option is currently only available under Linux, and requires that the
976 kernel was configured to include PPP filtering support (CONFIG_PPP_FILTER).
977 .TP
978 .B password \fIpassword\-string
979 Specifies the password to use for authenticating to the peer. Use
980 of this option is discouraged, as the password is likely to be visible
981 to other users on the system (for example, by using ps(1)).
982 .TP
983 .B persist
984 Do not exit after a connection is terminated; instead try to reopen
985 the connection. The \fBmaxfail\fR option still has an effect on
986 persistent connections.
987 .TP
988 .B plugin \fIfilename
989 Load the shared library object file \fIfilename\fR as a plugin. This
990 is a privileged option. If \fIfilename\fR does not contain a slash
991 (/), pppd will look in the \fB/usr/lib/pppd/\fIversion\fR directory
992 for the plugin, where
993 \fIversion\fR is the version number of pppd (for example, 2.4.2).
994 .TP
995 .B predictor1
996 Request that the peer compress frames that it sends using Predictor-1
997 compression, and agree to compress transmitted frames with Predictor-1
998 if requested. This option has no effect unless the kernel driver
999 supports Predictor-1 compression.
1000 .TP
1001 .B privgroup \fIgroup\-name
1002 Allows members of group \fIgroup\-name\fR to use privileged options.
1003 This is a privileged option. Use of this option requires care as
1004 there is no guarantee that members of \fIgroup\-name\fR cannot use pppd
1005 to become root themselves. Consider it equivalent to putting the
1006 members of \fIgroup\-name\fR in the kmem or disk group.
1007 .TP
1008 .B proxyarp
1009 Add an entry to this system's ARP [Address Resolution Protocol] table
1010 with the IP address of the peer and the Ethernet address of this
1011 system. This will have the effect of making the peer appear to other
1012 systems to be on the local ethernet.
1013 .TP
1014 .B pty \fIscript
1015 Specifies that the command \fIscript\fR is to be used to communicate
1016 rather than a specific terminal device. Pppd will allocate itself a
1017 pseudo-tty master/slave pair and use the slave as its terminal
1018 device. The \fIscript\fR will be run in a child process with the
1019 pseudo-tty master as its standard input and output. An explicit
1020 device name may not be given if this option is used. (Note: if the
1021 \fIrecord\fR option is used in conjunction with the \fIpty\fR option,
1022 the child process will have pipes on its standard input and output.)
1023 .TP
1024 .B receive\-all
1025 With this option, pppd will accept all control characters from the
1026 peer, including those marked in the receive asyncmap. Without this
1027 option, pppd will discard those characters as specified in RFC1662.
1028 This option should only be needed if the peer is buggy.
1029 .TP
1030 .B record \fIfilename
1031 Specifies that pppd should record all characters sent and received to
1032 a file named \fIfilename\fR. This file is opened in append mode,
1033 using the user's user-ID and permissions. This option is implemented
1034 using a pseudo-tty and a process to transfer characters between the
1035 pseudo-tty and the real serial device, so it will increase the latency
1036 and CPU overhead of transferring data over the ppp interface. The
1037 characters are stored in a tagged format with timestamps, which can be
1038 displayed in readable form using the pppdump(8) program.
1039 .TP
1040 .B remotename \fIname
1041 Set the assumed name of the remote system for authentication purposes
1042 to \fIname\fR.
1043 .TP
1044 .B remotenumber \fInumber
1045 Set the assumed telephone number of the remote system for authentication
1046 purposes to \fInumber\fR.
1047 .TP
1048 .B refuse\-chap
1049 With this option, pppd will not agree to authenticate itself to the
1050 peer using CHAP.
1051 .TP
1052 .B refuse\-mschap
1053 With this option, pppd will not agree to authenticate itself to the
1054 peer using MS\-CHAP.
1055 .TP
1056 .B refuse\-mschap\-v2
1057 With this option, pppd will not agree to authenticate itself to the
1058 peer using MS\-CHAPv2.
1059 .TP
1060 .B refuse\-eap
1061 With this option, pppd will not agree to authenticate itself to the
1062 peer using EAP.
1063 .TP
1064 .B refuse\-pap
1065 With this option, pppd will not agree to authenticate itself to the
1066 peer using PAP.
1067 .TP
1068 .B require\-chap
1069 Require the peer to authenticate itself using CHAP [Challenge
1070 Handshake Authentication Protocol] authentication.
1071 .TP
1072 .B require\-mppe
1073 Require the use of MPPE (Microsoft Point to Point Encryption). This
1074 option disables all other compression types. This option enables
1075 both 40-bit and 128-bit encryption. In order for MPPE to successfully
1076 come up, you must have authenticated with either MS\-CHAP or MS\-CHAPv2.
1077 This option is presently only supported under Linux, and only if your
1078 kernel has been configured to include MPPE support.
1079 .TP
1080 .B require\-mppe\-40
1081 Require the use of MPPE, with 40-bit encryption.
1082 .TP
1083 .B require\-mppe\-128
1084 Require the use of MPPE, with 128-bit encryption.
1085 .TP
1086 .B require\-mschap
1087 Require the peer to authenticate itself using MS\-CHAP [Microsoft Challenge
1088 Handshake Authentication Protocol] authentication.
1089 .TP
1090 .B require\-mschap\-v2
1091 Require the peer to authenticate itself using MS\-CHAPv2 [Microsoft Challenge
1092 Handshake Authentication Protocol, Version 2] authentication.
1093 .TP
1094 .B require\-eap
1095 Require the peer to authenticate itself using EAP [Extensible
1096 Authentication Protocol] authentication.
1097 .TP
1098 .B require\-pap
1099 Require the peer to authenticate itself using PAP [Password
1100 Authentication Protocol] authentication.
1101 .TP
1102 .B set \fIname\fR=\fIvalue
1103 Set an environment variable for scripts that are invoked by pppd.
1104 When set by a privileged source, the variable specified by \fIname\fR
1105 cannot be changed by options contained in an unprivileged source. See
1106 also the \fIunset\fR option and the environment described in
1107 \fISCRIPTS\fR.
1108 .TP
1109 .B show\-password
1110 When logging the contents of PAP packets, this option causes pppd to
1111 show the password string in the log message.
1112 .TP
1113 .B silent
1114 With this option, pppd will not transmit LCP packets to initiate a
1115 connection until a valid LCP packet is received from the peer (as for
1116 the `passive' option with ancient versions of pppd).
1117 .TP
1118 .B srp\-interval \fIn
1119 If this parameter is given and pppd uses EAP SRP\-SHA1 to authenticate
1120 the peer (i.e., is the server), then pppd will use the optional
1121 lightweight SRP rechallenge mechanism at intervals of \fIn\fR
1122 seconds. This option is faster than \fBeap\-interval\fR
1123 reauthentication because it uses a hash\-based mechanism and does not
1124 derive a new session key.
1125 .TP
1126 .B srp\-pn\-secret \fIstring
1127 Set the long-term pseudonym-generating secret for the server. This
1128 value is optional and if set, needs to be known at the server
1129 (authenticator) side only, and should be different for each server (or
1130 poll of identical servers). It is used along with the current date to
1131 generate a key to encrypt and decrypt the client's identity contained
1132 in the pseudonym.
1133 .TP
1134 .B srp\-use\-pseudonym
1135 When operating as an EAP SRP\-SHA1 client, attempt to use the pseudonym
1136 stored in ~/.ppp_pseudonym first as the identity, and save in this
1137 file any pseudonym offered by the peer during authentication.
1138 .TP
1139 .B stop\-bits \fIn
1140 Set the number of stop bits for the serial port. Valid values are 1 or 2.
1141 The default value is 1.
1142 .TP
1143 .B sync
1144 Use synchronous HDLC serial encoding instead of asynchronous.
1145 The device used by pppd with this option must have sync support.
1146 Currently supports Microgate SyncLink adapters
1147 under Linux and FreeBSD 2.2.8 and later.
1148 .TP
1149 .B tls\-verify\-method \fIstring
1150 (EAP-TLS, or PEAP) Match the value specified for \fIremotename\fR to that that
1151 of the X509 certificates subject name, common name, or suffix of the common
1152 name. Respective values allowed for this option is: \fInone\fR, \fIsubject\fR,
1153 \fIname\fR, or \fIsuffix\fR. The default value for this option is \fIname\fR.
1154 .TP
1155 .B tls\-verify\-key\-usage
1156 (EAP-TLS, or PEAP) Enables examination of peer certificate's purpose, and
1157 extended key usage attributes.
1158 .TP
1159 .B unit \fInum
1160 Sets the ppp unit number (for a ppp0 or ppp1 etc interface name) for outbound
1161 connections. If the unit is already in use a dynamically allocated number will
1162 be used.
1163 .TP
1164 .B ifname \fIstring
1165 Set the ppp interface name for outbound connections. If the interface name is
1166 already in use, or if the name cannot be used for any other reason, pppd will
1167 terminate.
1168 .TP
1169 .B unset \fIname
1170 Remove a variable from the environment variable for scripts that are
1171 invoked by pppd. When specified by a privileged source, the variable
1172 \fIname\fR cannot be set by options contained in an unprivileged
1173 source. See also the \fIset\fR option and the environment described
1174 in \fISCRIPTS\fR.
1175 .TP
1176 .B updetach
1177 With this option, pppd will detach from its controlling terminal once
1178 it has successfully established the ppp connection (to the point where
1179 the first network control protocol, usually the IP control protocol,
1180 has come up).
1181 .TP
1182 .B up_sdnotify
1183 Use this option to run pppd in systemd service units of Type=notify
1184 (\fBup_sdnotify\fR implies \fBnodetach\fR).
1185 When \fBup_sdnotify\fR is enabled, pppd will notify systemd once
1186 it has successfully established the ppp connection (to the point where
1187 the first network control protocl, usually the IP control protocol,
1188 has come up). This option is only availble when pppd is compiled with
1189 systemd support.
1190 .TP
1191 .B usehostname
1192 Enforce the use of the hostname (with domain name appended, if given)
1193 as the name of the local system for authentication purposes (overrides
1194 the \fIname\fR option). This option is not normally needed since the
1195 \fIname\fR option is privileged.
1196 .TP
1197 .B usepeerdns
1198 Ask the peer for up to 2 DNS server addresses. The addresses supplied
1199 by the peer (if any) are passed to the /etc/ppp/ip\-up script in the
1200 environment variables DNS1 and DNS2, and the environment variable
1201 USEPEERDNS will be set to 1. In addition, pppd will create an
1202 /etc/ppp/resolv.conf file containing one or two nameserver lines with
1203 the address(es) supplied by the peer (unless the \fInoresolvconf\fR
1204 option is given).
1205 .TP
1206 .B usepeerwins
1207 Ask the peer for up to 2 WINS server addresses. The addresses supplied
1208 by the peer (if any) are passed to the /etc/ppp/ip\-up script in the
1209 environment variables WINS1 and WINS2, and the environment variable
1210 USEPEERWINS will be set to 1.
1211 .LP
1212 Please note that some modems (like the Huawei E220) requires this option in
1213 order to avoid a race condition that results in the incorrect DNS servers
1214 being assigned.
1215 .TP
1216 .B noresolvconf
1217 Do not create the /etc/ppp/resolv.conf file.
1218 .TP
1219 .B user \fIname
1220 Sets the name used for authenticating the local system to the peer to
1221 \fIname\fR.
1222 .TP
1223 .B vj\-max\-slots \fIn
1224 Sets the number of connection slots to be used by the Van Jacobson
1225 TCP/IP header compression and decompression code to \fIn\fR, which
1226 must be between 2 and 16 (inclusive).
1227 .TP
1228 .B welcome \fIscript
1229 Run the executable or shell command specified by \fIscript\fR before
1230 initiating PPP negotiation, after the connect script (if any) has
1231 completed. A value for this option from a privileged source cannot be
1232 overridden by a non-privileged user.
1233 .TP
1234 .B xonxoff
1235 Use software flow control (i.e. XON/XOFF) to control the flow of data on
1236 the serial port.
1237 .SH PPPOE OPTIONS
1238 To establish PPP link over Ethernet (PPPoE) it is needed to load pppd's
1239 \fBplugin pppoe.so\fR and then specify option \fBnic-\fIinterface\fR
1240 instead of modem options \fIttyname\fR and \fIspeed\fR.
1241 Recognized pppd's PPPoE options are:
1242 .TP
1243 .B nic-\fIinterface
1244 Use the ethernet device \fIinterface\fR to communicate with the peer.
1245 For example, establishing PPPoE link on \fIeth0\fR interface is done
1246 by specifying ppp'd option \fBnic-eth0\fR. Prefix \fBnic-\fR for this
1247 option may be avoided if interface name is unambiguous and does not
1248 look like any other pppd's option.
1249 .TP
1250 .B pppoe\-service \fIname
1251 Connect to specified PPPoE service name. For backward compatibility also
1252 \fBrp_pppoe_service\fP option name is supported.
1253 .TP
1254 .B pppoe\-ac \fIname
1255 Connect to specified PPPoE access concentrator name. For backward
1256 compatibility also \fBrp_pppoe_ac\fP option name is supported.
1257 .TP
1258 .B pppoe\-sess \fIsessid\fP:\fImacaddr
1259 Attach to existing PPPoE session. For backward compatibility also
1260 \fBrp_pppoe_sess\fP option name is supported.
1261 .TP
1262 .B pppoe\-verbose \fIn
1263 Be verbose about discovered access concentrators. When set to 2 or bigger
1264 value then dump also discovery packets. For backward compatibility also
1265 \fBrp_pppoe_verbose\fP option name is supported.
1266 .TP
1267 .B pppoe\-mac \fImacaddr
1268 Connect to specified MAC address.
1269 .TP
1270 .B pppoe\-host\-uniq \fIstring
1271 Set the PPPoE Host-Uniq tag to the supplied hex string.
1272 By default PPPoE Host-Uniq tag is set to the pppd's process PID.
1273 For backward compatibility this option may be specified without
1274 \fBpppoe-\fP prefix.
1275 .TP
1276 .B pppoe\-padi\-timeout \fIn
1277 Initial timeout for discovery packets in seconds (default 5).
1278 .TP
1279 .B pppoe\-padi\-attempts \fIn
1280 Number of discovery attempts (default 3).
1281 .SH OPTIONS FILES
1282 Options can be taken from files as well as the command line. Pppd
1283 reads options from the files /etc/ppp/options, ~/.ppprc and
1284 /etc/ppp/options.\fIttyname\fR (in that order) before processing the
1285 options on the command line. (In fact, the command-line options are
1286 scanned to find the terminal name before the options.\fIttyname\fR
1287 file is read.) In forming the name of the options.\fIttyname\fR file,
1288 the initial /dev/ is removed from the terminal name, and any remaining
1289 / characters are replaced with dots.
1290 .PP
1291 An options file is parsed into a series of words, delimited by
1292 whitespace. Whitespace can be included in a word by enclosing the
1293 word in double-quotes ("). A backslash (\e) quotes the following character.
1294 A hash (#) starts a comment, which continues until the end of the
1295 line. There is no restriction on using the \fIfile\fR or \fIcall\fR
1296 options within an options file.
1297 .SH SECURITY
1298 .I pppd
1299 provides system administrators with sufficient access control that PPP
1300 access to a server machine can be provided to legitimate users without
1301 fear of compromising the security of the server or the network it's
1302 on. This control is provided through restrictions on which IP
1303 addresses the peer may use, based on its authenticated identity (if
1304 any), and through restrictions on which options a non-privileged user
1305 may use. Several of pppd's options are privileged, in particular
1306 those which permit potentially insecure configurations; these options
1307 are only accepted in files which are under the control of the system
1308 administrator, or if pppd is being run by root.
1309 .PP
1310 The default behaviour of pppd is to allow an unauthenticated peer to
1311 use a given IP address only if the system does not already have a
1312 route to that IP address. For example, a system with a
1313 permanent connection to the wider internet will normally have a
1314 default route, and thus all peers will have to authenticate themselves
1315 in order to set up a connection. On such a system, the \fIauth\fR
1316 option is the default. On the other hand, a system where the
1317 PPP link is the only connection to the internet will not normally have
1318 a default route, so the peer will be able to use almost any IP address
1319 without authenticating itself.
1320 .PP
1321 As indicated above, some security-sensitive options are privileged,
1322 which means that they may not be used by an ordinary non-privileged
1323 user running a setuid-root pppd, either on the command line, in the
1324 user's ~/.ppprc file, or in an options file read using the \fIfile\fR
1325 option. Privileged options may be used in /etc/ppp/options file or in
1326 an options file read using the \fIcall\fR option. If pppd is being
1327 run by the root user, privileged options can be used without
1328 restriction.
1329 .PP
1330 When opening the device, pppd uses either the invoking user's user ID
1331 or the root UID (that is, 0), depending on whether the device name was
1332 specified by the user or the system administrator. If the device name
1333 comes from a privileged source, that is, /etc/ppp/options or an
1334 options file read using the \fIcall\fR option, pppd uses full root
1335 privileges when opening the device. Thus, by creating an appropriate
1336 file under /etc/ppp/peers, the system administrator can allow users to
1337 establish a ppp connection via a device which they would not normally
1338 have permission to access. Otherwise pppd uses the invoking user's
1339 real UID when opening the device.
1340 .SH AUTHENTICATION
1341 Authentication is the process whereby one peer convinces the other of
1342 its identity. This involves the first peer sending its name to the
1343 other, together with some kind of secret information which could only
1344 come from the genuine authorized user of that name. In such an
1345 exchange, we will call the first peer the "client" and the other the
1346 "server". The client has a name by which it identifies itself to the
1347 server, and the server also has a name by which it identifies itself
1348 to the client. Generally the genuine client shares some secret (or
1349 password) with the server, and authenticates itself by proving that it
1350 knows that secret. Very often, the names used for authentication
1351 correspond to the internet hostnames of the peers, but this is not
1352 essential.
1353 .LP
1354 At present, pppd supports three authentication protocols: the Password
1355 Authentication Protocol (PAP), Challenge Handshake Authentication
1356 Protocol (CHAP), and Extensible Authentication Protocol (EAP). PAP
1357 involves the client sending its name and a cleartext password to the
1358 server to authenticate itself. In contrast, the server initiates the
1359 CHAP authentication exchange by sending a challenge to the client (the
1360 challenge packet includes the server's name). The client must respond
1361 with a response which includes its name plus a hash value derived from
1362 the shared secret and the challenge, in order to prove that it knows
1363 the secret. EAP supports CHAP-style authentication, and also includes
1364 the SRP\-SHA1 mechanism, which is resistant to dictionary-based attacks
1365 and does not require a cleartext password on the server side.
1366 .LP
1367 The PPP protocol, being symmetrical, allows both peers to require the
1368 other to authenticate itself. In that case, two separate and
1369 independent authentication exchanges will occur. The two exchanges
1370 could use different authentication protocols, and in principle,
1371 different names could be used in the two exchanges.
1372 .LP
1373 The default behaviour of pppd is to agree to authenticate if
1374 requested, and to not require authentication from the peer. However,
1375 pppd will not agree to authenticate itself with a particular protocol
1376 if it has no secrets which could be used to do so.
1377 .LP
1378 Pppd stores secrets for use in authentication in secrets
1379 files (/etc/ppp/pap\-secrets for PAP, /etc/ppp/chap\-secrets for CHAP,
1380 MS\-CHAP, MS\-CHAPv2, and EAP MD5-Challenge, and /etc/ppp/srp\-secrets
1381 for EAP SRP\-SHA1).
1382 All secrets files have the same format. The secrets files can
1383 contain secrets for pppd to use in authenticating itself to other
1384 systems, as well as secrets for pppd to use when authenticating other
1385 systems to itself.
1386 .LP
1387 Each line in a secrets file contains one secret. A given secret is
1388 specific to a particular combination of client and server - it can
1389 only be used by that client to authenticate itself to that server.
1390 Thus each line in a secrets file has at least 3 fields: the name of
1391 the client, the name of the server, and the secret. These fields may
1392 be followed by a list of the IP addresses that the specified client
1393 may use when connecting to the specified server.
1394 .LP
1395 A secrets file is parsed into words as for a options file, so the
1396 client name, server name and secrets fields must each be one word,
1397 with any embedded spaces or other special characters quoted or
1398 escaped. Note that case is significant in the client and server names
1399 and in the secret.
1400 .LP
1401 If the secret starts with an `@', what follows is assumed to be the
1402 name of a file from which to read the secret. A "*" as the client or
1403 server name matches any name. When selecting a secret, pppd takes the
1404 best match, i.e. the match with the fewest wildcards.
1405 .LP
1406 Any following words on the same line are taken to be a list of
1407 acceptable IP addresses for that client. If there are only 3 words on
1408 the line, or if the first word is "\-", then all IP addresses are
1409 disallowed. To allow any address, use "*". A word starting with "!"
1410 indicates that the specified address is \fInot\fR acceptable. An
1411 address may be followed by "/" and a number \fIn\fR, to indicate a
1412 whole subnet, i.e. all addresses which have the same value in the most
1413 significant \fIn\fR bits. In this form, the address may be followed
1414 by a plus sign ("+") to indicate that one address from the subnet is
1415 authorized, based on the ppp network interface unit number in use.
1416 In this case, the host part of the address will be set to the unit
1417 number plus one.
1418 .LP
1419 Thus a secrets file contains both secrets for use in authenticating
1420 other hosts, plus secrets which we use for authenticating ourselves to
1421 others. When pppd is authenticating the peer (checking the peer's
1422 identity), it chooses a secret with the peer's name in the first
1423 field and the name of the local system in the second field. The
1424 name of the local system defaults to the hostname, with the domain
1425 name appended if the \fIdomain\fR option is used. This default can be
1426 overridden with the \fIname\fR option, except when the
1427 \fIusehostname\fR option is used. (For EAP SRP\-SHA1, see the
1428 srp\-entry(8) utility for generating proper validator entries to be
1429 used in the "secret" field.)
1430 .LP
1431 When pppd is choosing a secret to use in authenticating itself to the
1432 peer, it first determines what name it is going to use to identify
1433 itself to the peer. This name can be specified by the user with the
1434 \fIuser\fR option. If this option is not used, the name defaults to
1435 the name of the local system, determined as described in the previous
1436 paragraph. Then pppd looks for a secret with this name in the first
1437 field and the peer's name in the second field. Pppd will know the
1438 name of the peer if CHAP or EAP authentication is being used, because
1439 the peer will have sent it in the challenge packet. However, if PAP
1440 is being used, pppd will have to determine the peer's name from the
1441 options specified by the user. The user can specify the peer's name
1442 directly with the \fIremotename\fR option. Otherwise, if the remote
1443 IP address was specified by a name (rather than in numeric form), that
1444 name will be used as the peer's name. Failing that, pppd will use the
1445 null string as the peer's name.
1446 .LP
1447 When authenticating the peer with PAP, the supplied password is first
1448 compared with the secret from the secrets file. If the password
1449 doesn't match the secret, the password is encrypted using crypt() and
1450 checked against the secret again. Thus secrets for authenticating the
1451 peer can be stored in encrypted form if desired. If the
1452 \fIpapcrypt\fR option is given, the first (unencrypted) comparison is
1453 omitted, for better security.
1454 .LP
1455 Furthermore, if the \fIlogin\fR option was specified, the username and
1456 password are also checked against the system password database. Thus,
1457 the system administrator can set up the pap\-secrets file to allow PPP
1458 access only to certain users, and to restrict the set of IP addresses
1459 that each user can use. Typically, when using the \fIlogin\fR option,
1460 the secret in /etc/ppp/pap\-secrets would be "", which will match any
1461 password supplied by the peer. This avoids the need to have the same
1462 secret in two places.
1463 .LP
1464 Authentication must be satisfactorily completed before IPCP (or any
1465 other Network Control Protocol) can be started. If the peer is
1466 required to authenticate itself, and fails to do so, pppd will
1467 terminated the link (by closing LCP). If IPCP negotiates an
1468 unacceptable IP address for the remote host, IPCP will be closed. IP
1469 packets can only be sent or received when IPCP is open.
1470 .LP
1471 In some cases it is desirable to allow some hosts which can't
1472 authenticate themselves to connect and use one of a restricted set of
1473 IP addresses, even when the local host generally requires
1474 authentication. If the peer refuses to authenticate itself when
1475 requested, pppd takes that as equivalent to authenticating with PAP
1476 using the empty string for the username and password. Thus, by adding
1477 a line to the pap\-secrets file which specifies the empty string for
1478 the client and password, it is possible to allow restricted access to
1479 hosts which refuse to authenticate themselves.
1480 .SH ROUTING
1481 .LP
1482 When IPCP negotiation is completed successfully, pppd will inform the
1483 kernel of the local and remote IP addresses for the ppp interface.
1484 This is sufficient to create a host route to the remote end of the
1485 link, which will enable the peers to exchange IP packets.
1486 Communication with other machines generally requires further
1487 modification to routing tables and/or ARP (Address Resolution
1488 Protocol) tables. In most cases the \fIdefaultroute\fR and/or
1489 \fIproxyarp\fR options are sufficient for this, but in some cases
1490 further intervention is required. The /etc/ppp/ip\-up script can be
1491 used for this.
1492 .LP
1493 Sometimes it is desirable to add a default route through the remote
1494 host, as in the case of a machine whose only connection to the
1495 Internet is through the ppp interface. The \fIdefaultroute\fR option
1496 causes pppd to create such a default route when IPCP comes up, and
1497 delete it when the link is terminated.
1498 .LP
1499 In some cases it is desirable to use proxy ARP, for example on a
1500 server machine connected to a LAN, in order to allow other hosts to
1501 communicate with the remote host. The \fIproxyarp\fR option causes
1502 pppd to look for a network interface on the same subnet as the remote
1503 host (an interface supporting broadcast and ARP, which is up and not a
1504 point-to-point or loopback interface). If found, pppd creates a
1505 permanent, published ARP entry with the IP address of the remote host
1506 and the hardware address of the network interface found.
1507 .LP
1508 When the \fIdemand\fR option is used, the interface IP addresses have
1509 already been set at the point when IPCP comes up. If pppd has not
1510 been able to negotiate the same addresses that it used to configure
1511 the interface (for example when the peer is an ISP that uses dynamic
1512 IP address assignment), pppd has to change the interface IP addresses
1513 to the negotiated addresses. This may disrupt existing connections,
1514 and the use of demand dialling with peers that do dynamic IP address
1515 assignment is not recommended.
1516 .SH MULTILINK
1517 Multilink PPP provides the capability to combine two or more PPP links
1518 between a pair of machines into a single `bundle', which appears as a
1519 single virtual PPP link which has the combined bandwidth of the
1520 individual links. Currently, multilink PPP is only supported under
1521 Linux.
1522 .LP
1523 Pppd detects that the link it is controlling is connected to the same
1524 peer as another link using the peer's endpoint discriminator and the
1525 authenticated identity of the peer (if it authenticates itself). The
1526 endpoint discriminator is a block of data which is hopefully unique
1527 for each peer. Several types of data can be used, including
1528 locally-assigned strings of bytes, IP addresses, MAC addresses,
1529 randomly strings of bytes, or E\-164 phone numbers. The endpoint
1530 discriminator sent to the peer by pppd can be set using the endpoint
1531 option.
1532 .LP
1533 In some circumstances the peer may send no endpoint discriminator or a
1534 non-unique value. The bundle option adds an extra string which is
1535 added to the peer's endpoint discriminator and authenticated identity
1536 when matching up links to be joined together in a bundle. The bundle
1537 option can also be used to allow the establishment of multiple bundles
1538 between the local system and the peer. Pppd uses a TDB database in
1539 /var/run/pppd2.tdb to match up links.
1540 .LP
1541 Assuming that multilink is enabled and the peer is willing to
1542 negotiate multilink, then when pppd is invoked to bring up the first
1543 link to the peer, it will detect that no other link is connected to
1544 the peer and create a new bundle, that is, another ppp network
1545 interface unit. When another pppd is invoked to bring up another link
1546 to the peer, it will detect the existing bundle and join its link to
1547 it.
1548 .LP
1549 If the first link terminates (for example, because of a hangup or a
1550 received LCP terminate-request) the bundle is not destroyed unless
1551 there are no other links remaining in the bundle. Rather than
1552 exiting, the first pppd keeps running after its link terminates, until
1553 all the links in the bundle have terminated. If the first pppd
1554 receives a SIGTERM or SIGINT signal, it will destroy the bundle and
1555 send a SIGHUP to the pppd processes for each of the links in the
1556 bundle. If the first pppd receives a SIGHUP signal, it will terminate
1557 its link but not the bundle.
1558 .LP
1559 Note: demand mode is not currently supported with multilink.
1560 .SH EXAMPLES
1561 .LP
1562 The following examples assume that the /etc/ppp/options file contains
1563 the \fIauth\fR option (as in the default /etc/ppp/options file in the
1564 ppp distribution).
1565 .LP
1566 Probably the most common use of pppd is to dial out to an ISP. This
1567 can be done with a command such as
1568 .IP
1569 pppd call isp
1570 .LP
1571 where the /etc/ppp/peers/isp file is set up by the system
1572 administrator to contain something like this:
1573 .IP
1574 ttyS0 19200 crtscts
1575 .br
1576 connect '/usr/sbin/chat \-v \-f /etc/ppp/chat\-isp'
1577 .br
1578 noauth
1579 .LP
1580 In this example, we are using chat to dial the ISP's modem and go
1581 through any logon sequence required. The /etc/ppp/chat\-isp file
1582 contains the script used by chat; it could for example contain
1583 something like this:
1584 .IP
1585 ABORT "NO CARRIER"
1586 .br
1587 ABORT "NO DIALTONE"
1588 .br
1589 ABORT "ERROR"
1590 .br
1591 ABORT "NO ANSWER"
1592 .br
1593 ABORT "BUSY"
1594 .br
1595 ABORT "Username/Password Incorrect"
1596 .br
1597 "" "at"
1598 .br
1599 OK "at&d0&c1"
1600 .br
1601 OK "atdt2468135"
1602 .br
1603 "name:" "^Umyuserid"
1604 .br
1605 "word:" "\eqmypassword"
1606 .br
1607 "ispts" "\eq^Uppp"
1608 .br
1609 "~\-^Uppp\-~"
1610 .LP
1611 See the chat(8) man page for details of chat scripts.
1612 .LP
1613 Pppd can also be used to provide a dial-in ppp service for users. If
1614 the users already have login accounts, the simplest way to set up the
1615 ppp service is to let the users log in to their accounts and run pppd
1616 (installed setuid-root) with a command such as
1617 .IP
1618 pppd proxyarp
1619 .LP
1620 To allow a user to use the PPP facilities, you need to allocate an IP
1621 address for that user's machine and create an entry in
1622 /etc/ppp/pap\-secrets, /etc/ppp/chap\-secrets, or /etc/ppp/srp\-secrets
1623 (depending on which authentication method the PPP implementation on
1624 the user's machine supports), so that the user's machine can
1625 authenticate itself. For example, if Joe has a machine called
1626 "joespc" that is to be allowed to dial in to the machine called
1627 "server" and use the IP address joespc.my.net, you would add an entry
1628 like this to /etc/ppp/pap\-secrets or /etc/ppp/chap\-secrets:
1629 .IP
1630 joespc server "joe's secret" joespc.my.net
1631 .LP
1632 (See srp\-entry(8) for a means to generate the server's entry when
1633 SRP\-SHA1 is in use.)
1634 Alternatively, you can create a username called (for example) "ppp",
1635 whose login shell is pppd and whose home directory is /etc/ppp.
1636 Options to be used when pppd is run this way can be put in
1637 /etc/ppp/.ppprc.
1638 .LP
1639 If your serial connection is any more complicated than a piece of
1640 wire, you may need to arrange for some control characters to be
1641 escaped. In particular, it is often useful to escape XON (^Q) and
1642 XOFF (^S), using \fIasyncmap a0000\fR. If the path includes a telnet,
1643 you probably should escape ^] as well (\fIasyncmap 200a0000\fR). If
1644 the path includes an rlogin, you will need to use the \fIescape ff\fR
1645 option on the end which is running the rlogin client, since many
1646 rlogin implementations are not transparent; they will remove the
1647 sequence [0xff, 0xff, 0x73, 0x73, followed by any 8 bytes] from the
1648 stream.
1649 .SH DIAGNOSTICS
1650 .LP
1651 Messages are sent to the syslog daemon using facility LOG_DAEMON.
1652 (This can be overridden by recompiling pppd with the macro
1653 LOG_PPP defined as the desired facility.) See the syslog(8)
1654 documentation for details of where the syslog daemon will write the
1655 messages. On most systems, the syslog daemon uses the
1656 /etc/syslog.conf file to specify the destination(s) for syslog
1657 messages. You may need to edit that file to suit.
1658 .LP
1659 The \fIdebug\fR option causes the contents of all control packets sent
1660 or received to be logged, that is, all LCP, PAP, CHAP, EAP, or IPCP packets.
1661 This can be useful if the PPP negotiation does not succeed or if
1662 authentication fails.
1663 If debugging is enabled at compile time, the \fIdebug\fR option also
1664 causes other debugging messages to be logged.
1665 .LP
1666 Debugging can also be enabled or disabled by sending a SIGUSR1 signal
1667 to the pppd process. This signal acts as a toggle.
1668 .SH EXIT STATUS
1669 The exit status of pppd is set to indicate whether any error was
1670 detected, or the reason for the link being terminated. The values
1671 used are:
1672 .TP
1673 .B 0
1674 Pppd has detached, or otherwise the connection was successfully
1675 established and terminated at the peer's request.
1676 .TP
1677 .B 1
1678 An immediately fatal error of some kind occurred, such as an essential
1679 system call failing, or running out of virtual memory.
1680 .TP
1681 .B 2
1682 An error was detected in processing the options given, such as two
1683 mutually exclusive options being used.
1684 .TP
1685 .B 3
1686 Pppd is not setuid-root and the invoking user is not root.
1687 .TP
1688 .B 4
1689 The kernel does not support PPP, for example, the PPP kernel driver is
1690 not included or cannot be loaded.
1691 .TP
1692 .B 5
1693 Pppd terminated because it was sent a SIGINT, SIGTERM or SIGHUP
1694 signal.
1695 .TP
1696 .B 6
1697 The serial port could not be locked.
1698 .TP
1699 .B 7
1700 The serial port could not be opened.
1701 .TP
1702 .B 8
1703 The connect script failed (returned a non-zero exit status).
1704 .TP
1705 .B 9
1706 The command specified as the argument to the \fIpty\fR option could
1707 not be run.
1708 .TP
1709 .B 10
1710 The PPP negotiation failed, that is, it didn't reach the point where
1711 at least one network protocol (e.g. IP) was running.
1712 .TP
1713 .B 11
1714 The peer system failed (or refused) to authenticate itself.
1715 .TP
1716 .B 12
1717 The link was established successfully and terminated because it was
1718 idle.
1719 .TP
1720 .B 13
1721 The link was established successfully and terminated because the
1722 connect time limit was reached.
1723 .TP
1724 .B 14
1725 Callback was negotiated and an incoming call should arrive shortly.
1726 .TP
1727 .B 15
1728 The link was terminated because the peer is not responding to echo
1729 requests.
1730 .TP
1731 .B 16
1732 The link was terminated by the modem hanging up.
1733 .TP
1734 .B 17
1735 The PPP negotiation failed because serial loopback was detected.
1736 .TP
1737 .B 18
1738 The init script failed (returned a non-zero exit status).
1739 .TP
1740 .B 19
1741 We failed to authenticate ourselves to the peer.
1742 .SH SCRIPTS
1743 Pppd invokes scripts at various stages in its processing which can be
1744 used to perform site-specific ancillary processing. These scripts are
1745 usually shell scripts, but could be executable code files instead.
1746 Pppd does not wait for the scripts to finish (except for the net\-init,
1747 net\-pre\-up and ip\-pre\-up scripts). The scripts are
1748 executed as root (with the real and effective user-id set to 0), so
1749 that they can do things such as update routing tables or run
1750 privileged daemons. Be careful that the contents of these scripts do
1751 not compromise your system's security. Pppd runs the scripts with
1752 standard input, output and error redirected to /dev/null, and with an
1753 environment that is empty except for some environment variables that
1754 give information about the link. The environment variables that pppd
1755 sets are:
1756 .TP
1757 .B DEVICE
1758 The name of the serial tty device being used.
1759 .TP
1760 .B IFNAME
1761 The name of the network interface being used.
1762 .TP
1763 .B IPLOCAL
1764 The IP address for the local end of the link. This is only set when
1765 IPCP has come up.
1766 .TP
1767 .B IPREMOTE
1768 The IP address for the remote end of the link. This is only set when
1769 IPCP has come up.
1770 .TP
1771 .B LLLOCAL
1772 The Link-Local IPv6 address for the local end of the link. This is only
1773 set when IPV6CP has come up.
1774 .TP
1775 .B LLREMOTE
1776 The Link-Local IPv6 address for the remote end of the link. This is only
1777 set when IPV6CP has come up.
1778 .TP
1779 .B PEERNAME
1780 The authenticated name of the peer. This is only set if the peer
1781 authenticates itself.
1782 .TP
1783 .B SPEED
1784 The baud rate of the tty device.
1785 .TP
1786 .B ORIG_UID
1787 The real user-id of the user who invoked pppd.
1788 .TP
1789 .B PPPLOGNAME
1790 The username of the real user-id that invoked pppd. This is always set.
1791 .P
1792 For the ip-down and auth-down scripts, pppd also sets the following
1793 variables giving statistics for the connection:
1794 .TP
1795 .B CONNECT_TIME
1796 The number of seconds from when the PPP negotiation started until the
1797 connection was terminated.
1798 .TP
1799 .B BYTES_SENT
1800 The number of bytes sent (at the level of the serial port) during the
1801 connection.
1802 .TP
1803 .B BYTES_RCVD
1804 The number of bytes received (at the level of the serial port) during
1805 the connection.
1806 .TP
1807 .B LINKNAME
1808 The logical name of the link, set with the \fIlinkname\fR option.
1809 .TP
1810 .B CALL_FILE
1811 The value of the \fIcall\fR option.
1812 .TP
1813 .B DNS1
1814 If the peer supplies DNS server addresses, this variable is set to the
1815 first DNS server address supplied (whether or not the usepeerdns
1816 option was given).
1817 .TP
1818 .B DNS2
1819 If the peer supplies DNS server addresses, this variable is set to the
1820 second DNS server address supplied (whether or not the usepeerdns
1821 option was given).
1822 .TP
1823 .B WINS1
1824 If the peer supplies WINS server addresses, this variable is set to the
1825 first WINS server address supplied.
1826 .TP
1827 .B WINS2
1828 If the peer supplies WINS server addresses, this variable is set to the
1829 second WINS server address supplied.
1830 .TP
1831 .B ACNAME
1832 If the pppoe plugin is used to establish a connection to an access
1833 concentrator (AC), this variable is set to the name of the AC, as
1834 supplied by the AC.
1835 .P
1836 .P
1837 Pppd invokes the following scripts, if they exist. It is not an error
1838 if they don't exist.
1839 .TP
1840 .B /etc/ppp/auth\-up
1841 A program or script which is executed after the remote system
1842 successfully authenticates itself. It is executed with the parameters
1843 .IP
1844 \fIinterface\-name peer\-name user\-name tty\-device speed ipparam\fR
1845 .IP
1846 Note that this script is not executed if the peer doesn't authenticate
1847 itself, for example when the \fInoauth\fR option is used.
1848 .TP
1849 .B /etc/ppp/auth\-down
1850 A program or script which is executed when the link goes down, if
1851 /etc/ppp/auth\-up was previously executed. It is executed in the same
1852 manner with the same parameters as /etc/ppp/auth\-up.
1853 .TP
1854 .B /etc/ppp/ip\-pre\-up
1855 A program or script which is executed just before the ppp network
1856 interface is brought up. It is executed with the same parameters as
1857 the ip\-up script (below). At this point the interface exists and has
1858 IP addresses assigned but is still down. This can be used to
1859 add firewall rules before any IP traffic can pass through the
1860 interface. Pppd will wait for this script to finish before bringing
1861 the interface up, so this script should run quickly.
1862 .PP
1863 WARNING: Please note that on systems where a single interface carries multiple
1864 protocols (Linux) ip-pre-up is NOT actually guaranteed to execute prior to the
1865 interface moving into an up state, although IP information won't be known you
1866 should consider using net-pre-up instead, alternatively, disable other NCPs
1867 such that IPv4 is the only negotiated protocol - which will also result in a
1868 guarantee that ip-pre-up is called prior to the interface going into an UP
1869 state.
1870 .TP
1871 .B /etc/ppp/ip\-up
1872 A program or script which is executed when the link is available for
1873 sending and receiving IP packets (that is, IPCP has come up). It is
1874 executed with the parameters
1875 .IP
1876 \fIinterface\-name tty\-device speed local\-IP\-address
1877 remote\-IP\-address ipparam\fR
1878 .TP
1879 .B /etc/ppp/ip\-down
1880 A program or script which is executed when the link is no longer
1881 available for sending and receiving IP packets. This script can be
1882 used for undoing the effects of the /etc/ppp/ip\-up and
1883 /etc/ppp/ip\-pre\-up scripts. It is
1884 invoked in the same manner and with the same parameters as the ip\-up
1885 script.
1886 .TP
1887 .B /etc/ppp/ipv6\-up
1888 Like /etc/ppp/ip\-up, except that it is executed when the link is available
1889 for sending and receiving IPv6 packets. It is executed with the parameters
1890 .IP
1891 \fIinterface\-name tty\-device speed local\-link\-local\-address
1892 remote\-link\-local\-address ipparam\fR
1893 .TP
1894 .B /etc/ppp/ipv6\-down
1895 Similar to /etc/ppp/ip\-down, but it is executed when IPv6 packets can no
1896 longer be transmitted on the link. It is executed with the same parameters
1897 as the ipv6\-up script.
1898 .TP
1899 .B /etc/ppp/net\-init
1900 This script will be executed the moment the ppp unit number is known. This
1901 script will be waited for and should not cause significant delays. This can be
1902 used to update book-keeping type systems external to ppp and provides the only
1903 guaranteed point where a script can be executed knowing the ppp unit number
1904 prior to LCP being initiated. It is executed with the parameters
1905 .IP
1906 \fIinterface\-name tty\-device speed ipparam
1907 .TP
1908 .B /etc/ppp/net\-pre\-up
1909 This script will be executed just prior to NCP negotiations initiating, and is
1910 guaranteed to be executed whilst the interface (Linux) and/or sub-interfaces
1911 (Solaris) as the case may be is/are still down. ppp will block waiting for
1912 this script to complete, and the interface may be safely renamed in this script
1913 (using for example "ip li set dev $1 name ppp-foobar". The parameters are the
1914 same as for net\-init.
1915 .TP
1916 .B /etc/ppp/net\-down
1917 This script will be executed just prior to ppp terminating and will not be
1918 waited for. The parameters are the same as for net\-init.
1919 .TP
1920 .B /var/run/ppp\fIn\fB.pid \fR(BSD or Linux), \fB/etc/ppp/ppp\fIn\fB.pid \fR(others)
1921 Process-ID for pppd process on ppp interface unit \fIn\fR.
1922 .TP
1923 .B /var/run/ppp\-\fIname\fB.pid \fR(BSD or Linux),
1924 \fB/etc/ppp/ppp\-\fIname\fB.pid \fR(others)
1925 Process-ID for pppd process for logical link \fIname\fR (see the
1926 \fIlinkname\fR option).
1927 .TP
1928 .B /var/run/pppd2.tdb
1929 Database containing information about pppd processes, interfaces and
1930 links, used for matching links to bundles in multilink operation. May
1931 be examined by external programs to obtain information about running
1932 pppd instances, the interfaces and devices they are using, IP address
1933 assignments, etc.
1934 .B /etc/ppp/pap\-secrets
1935 Usernames, passwords and IP addresses for PAP authentication. This
1936 file should be owned by root and not readable or writable by any other
1937 user. Pppd will log a warning if this is not the case.
1938 .TP
1939 .B /etc/ppp/chap\-secrets
1940 Names, secrets and IP addresses for CHAP/MS\-CHAP/MS\-CHAPv2 authentication.
1941 As for /etc/ppp/pap\-secrets, this file should be owned by root and not
1942 readable or writable by any other user. Pppd will log a warning if
1943 this is not the case.
1944 .TP
1945 .B /etc/ppp/srp\-secrets
1946 Names, secrets, and IP addresses for EAP authentication. As for
1947 /etc/ppp/pap\-secrets, this file should be owned by root and not
1948 readable or writable by any other user. Pppd will log a warning if
1949 this is not the case.
1950 .TP
1951 .B ~/.ppp_pseudonym
1952 Saved client-side SRP\-SHA1 pseudonym. See the \fIsrp\-use\-pseudonym\fR
1953 option for details.
1954 .TP
1955 .B /etc/ppp/options
1956 System default options for pppd, read before user default options or
1957 command-line options.
1958 .TP
1959 .B ~/.ppprc
1960 User default options, read before /etc/ppp/options.\fIttyname\fR.
1961 .TP
1962 .B /etc/ppp/options.\fIttyname
1963 System default options for the serial port being used, read after
1964 ~/.ppprc. In forming the \fIttyname\fR part of this
1965 filename, an initial /dev/ is stripped from the port name (if
1966 present), and any slashes in the remaining part are converted to
1967 dots.
1968 .TP
1969 .B /etc/ppp/peers
1970 A directory containing options files which may contain privileged
1971 options, even if pppd was invoked by a user other than root. The
1972 system administrator can create options files in this directory to
1973 permit non-privileged users to dial out without requiring the peer to
1974 authenticate, but only to certain trusted peers.
1975 .SH SEE ALSO
1976 .BR chat (8),
1977 .BR pppstats (8)
1978 .TP
1979 .B RFC1144
1980 Jacobson, V.
1981 \fICompressing TCP/IP headers for low-speed serial links.\fR
1982 February 1990.
1983 .TP
1984 .B RFC1321
1985 Rivest, R.
1986 .I The MD5 Message-Digest Algorithm.
1987 April 1992.
1988 .TP
1989 .B RFC1332
1990 McGregor, G.
1991 .I PPP Internet Protocol Control Protocol (IPCP).
1992 May 1992.
1993 .TP
1994 .B RFC1334
1995 Lloyd, B.; Simpson, W.A.
1996 .I PPP authentication protocols.
1997 October 1992.
1998 .TP
1999 .B RFC1661
2000 Simpson, W.A.
2001 .I The Point-to-Point Protocol (PPP).
2002 July 1994.
2003 .TP
2004 .B RFC1662
2005 Simpson, W.A.
2006 .I PPP in HDLC-like Framing.
2007 July 1994.
2008 .TP
2009 .B RFC1990
2010 Sklower, K.; et al.,
2011 .I The PPP Multilink Protocol (MP).
2012 August 1996.
2013 .TP
2014 .B RFC2284
2015 Blunk, L.; Vollbrecht, J.,
2016 .I PPP Extensible Authentication Protocol (EAP).
2017 March 1998.
2018 .TP
2019 .B RFC2472
2020 Haskin, D.
2021 .I IP Version 6 over PPP
2022 December 1998.
2023 .TP
2024 .B RFC2945
2025 Wu, T.,
2026 .I The SRP Authentication and Key Exchange System
2027 September 2000.
2028 .TP
2029 .B draft\-ietf\-pppext\-eap\-srp\-03.txt
2030 Carlson, J.; et al.,
2031 .I EAP SRP\-SHA1 Authentication Protocol.
2032 July 2001.
2033 .SH NOTES
2034 Some limited degree of control can be exercised over a running pppd
2035 process by sending it a signal from the list below.
2036 .TP
2037 .B SIGINT, SIGTERM
2038 These signals cause pppd to terminate the link (by closing LCP),
2039 restore the serial device settings, and exit. If a connector or
2040 disconnector process is currently running, pppd will send the same
2041 signal to its process group, so as to terminate the connector or
2042 disconnector process.
2043 .TP
2044 .B SIGHUP
2045 This signal causes pppd to terminate the link, restore the serial
2046 device settings, and close the serial device. If the \fIpersist\fR or
2047 \fIdemand\fR option has been specified, pppd will try to reopen the
2048 serial device and start another connection (after the holdoff period).
2049 Otherwise pppd will exit. If this signal is received during the
2050 holdoff period, it causes pppd to end the holdoff period immediately.
2051 If a connector or disconnector process is running, pppd will send the
2052 same signal to its process group.
2053 .TP
2054 .B SIGUSR1
2055 This signal toggles the state of the \fIdebug\fR option.
2056 .TP
2057 .B SIGUSR2
2058 This signal causes pppd to renegotiate compression. This can be
2059 useful to re-enable compression after it has been disabled as a result
2060 of a fatal decompression error. (Fatal decompression errors generally
2061 indicate a bug in one or other implementation.)
2062
2063 .SH AUTHORS
2064 Paul Mackerras ([email protected]), based on earlier work by
2065 Drew Perkins,
2066 Brad Clements,
2067 Karl Fox,
2068 Greg Christy,
2069 and
2070 Brad Parker.
2071
2072 .SH COPYRIGHT
2073 Pppd is copyrighted and made available under conditions which provide
2074 that it may be copied and used in source or binary forms provided that
2075 the conditions listed below are met. Portions of pppd are covered by
2076 the following copyright notices:
2077 .LP
2078 Copyright (c) 1984-2000 Carnegie Mellon University. All rights
2079 reserved.
2080 .br
2081 Copyright (c) 1993-2004 Paul Mackerras. All rights reserved.
2082 .br
2083 Copyright (c) 1995 Pedro Roque Marques. All rights reserved.
2084 .br
2085 Copyright (c) 1995 Eric Rosenquist. All rights reserved.
2086 .br
2087 Copyright (c) 1999 Tommi Komulainen. All rights reserved.
2088 .br
2089 Copyright (C) Andrew Tridgell 1999
2090 .br
2091 Copyright (c) 2000 by Sun Microsystems, Inc. All rights reserved.
2092 .br
2093 Copyright (c) 2001 by Sun Microsystems, Inc. All rights reserved.
2094 .br
2095 Copyright (c) 2002 Google, Inc. All rights reserved.
2096 .LP
2097 The copyright notices contain the following statements.
2098 .LP
2099 Redistribution and use in source and binary forms, with or without
2100 modification, are permitted provided that the following conditions
2101 are met:
2102 .LP
2103 1. Redistributions of source code must retain the above copyright
2104 notice, this list of conditions and the following disclaimer.
2105 .LP
2106 2. Redistributions in binary form must reproduce the above copyright
2107 notice, this list of conditions and the following disclaimer in
2108 the documentation and/or other materials provided with the
2109 distribution.
2110 .LP
2111 3. The name "Carnegie Mellon University" must not be used to
2112 endorse or promote products derived from this software without
2113 prior written permission. For permission or any legal
2114 details, please contact
2115 .br
2116 Office of Technology Transfer
2117 .br
2118 Carnegie Mellon University
2119 .br
2120 5000 Forbes Avenue
2121 .br
2122 Pittsburgh, PA 15213-3890
2123 .br
2124 (412) 268-4387, fax: (412) 268-7395
2125 .br
2126 tech\[email protected]
2127 .LP
2128 3b. The name(s) of the authors of this software must not be used to
2129 endorse or promote products derived from this software without
2130 prior written permission.
2131 .LP
2132 4. Redistributions of any form whatsoever must retain the following
2133 acknowledgements:
2134 .br
2135 "This product includes software developed by Computing Services
2136 at Carnegie Mellon University (http://www.cmu.edu/computing/)."
2137 .br
2138 "This product includes software developed by Paul Mackerras
2139 <[email protected]>".
2140 .br
2141 "This product includes software developed by Pedro Roque Marques
2142 <[email protected]>".
2143 .br
2144 "This product includes software developed by Tommi Komulainen
2145 <[email protected]>".
2146 .LP
2147 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
2148 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2149 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
2150 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
2151 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
2152 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
2153 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
2154 .LP
2155 THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
2156 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2157 AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
2158 SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
2159 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
2160 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
2161 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.