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