4 .\" Copyright (c) 2001 Brian Somers <brian@Awfulhak.org>
5 .\" All rights reserved.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nd Point to Point Protocol (a.k.a. user-ppp)
44 This is a user process
49 is implemented as a part of the kernel (e.g., as managed by
51 and it is thus somewhat hard to debug and/or modify its behaviour.
52 However, in this implementation
54 is done as a user process with the help of the
55 tunnel device driver (tun).
59 flag does the equivalent of a
63 network address translation features.
66 to act as a NAT or masquerading engine for all machines on an internal
68 ifdef({LOCALNAT},{},{Refer to
70 for details on the technical side of the NAT engine.
73 .Sx NETWORK ADDRESS TRANSLATION (PACKET ALIASING)
74 section of this manual page for details on how to configure NAT in
81 to be silent at startup rather than displaying the mode and interface
88 to only attempt to open
89 .Pa /dev/tun Ns Ar N .
92 will start with a value of 0 for
94 and keep trying to open a tunnel device by incrementing the value of
96 by one each time until it succeeds.
97 If it fails three times in a row
98 because the device file is missing, it gives up.
104 .Bl -tag -width XXX -offset XXX
107 opens the tun interface, configures it then goes into the background.
108 The link is not brought up until outgoing data is detected on the tun
109 interface at which point
111 attempts to bring up the link.
112 Packets received (including the first one) while
114 is trying to bring the link up will remain queued for a default of
124 must be given on the command line (see below) and a
126 must be done in the system profile that specifies a peer IP address to
127 use when configuring the interface.
130 is usually appropriate.
134 .Pa /usr/share/examples/ppp/ppp.conf.sample
139 attempts to establish a connection with the peer immediately.
142 goes into the background and the parent process returns an exit code
146 exits with a non-zero result.
150 attempts to establish a connection with the peer immediately, but never
152 The link is created in background mode.
153 This is useful if you wish to control
155 invocation from another process.
157 This is used for communicating over an already established connection,
158 usually when receiving incoming connections accepted by
163 line and uses descriptor 0 as the link.
165 will also ignore any configured chat scripts unless the
167 option has been enabled.
169 If callback is configured,
173 information when dialing back.
179 will behave slightly differently if descriptor 0 was created by
181 As pipes are not bi-directional, ppp will redirect all writes to descriptor
182 1 (standard output), leaving only reads acting on descriptor 0.
183 No special action is taken if descriptor 0 was created by
186 This option is designed for machines connected with a dedicated
189 will always keep the device open and will ignore any configured
190 chat scripts unless the
192 option has been enabled.
194 This mode is equivalent to
198 will bring the link back up any time it is dropped for any reason.
200 This is a no-op, and gives the same behaviour as if none of the above
201 modes have been specified.
203 loads any sections specified on the command line then provides an
207 One or more configuration entries or systems
209 .Pa /etc/ppp/ppp.conf )
210 may also be specified on the command line.
215 .Pa /etc/ppp/ppp.conf
216 at startup, followed by each of the systems specified on the command line.
219 .It Provides an interactive user interface.
220 Using its command mode, the user can
221 easily enter commands to establish the connection with the remote end, check
222 the status of connection and close the connection.
223 All functions can also be optionally password protected for security.
224 .It Supports both manual and automatic dialing.
225 Interactive mode has a
227 command which enables you to talk to the device directly.
228 When you are connected to the remote peer and it starts to talk
231 detects it and switches to packet mode automatically.
233 determined the proper sequence for connecting with the remote host, you
234 can write a chat script to {define} the necessary dialing and login
235 procedure for later convenience.
236 .It Supports on-demand dialup capability.
241 will act as a daemon and wait for a packet to be sent over the
244 When this happens, the daemon automatically dials and establishes the
246 In almost the same manner
248 mode (direct-dial mode) also automatically dials and establishes the
250 However, it differs in that it will dial the remote site
251 any time it detects the link is down, even if there are no packets to be
253 This mode is useful for full-time connections where we worry less
254 about line charges and more about being connected full time.
257 mode is also available.
258 This mode is targeted at a dedicated link between two machines.
260 will never voluntarily quit from dedicated mode - you must send it the
262 command via its diagnostic socket.
265 will force an LCP renegotiation, and a
267 will force it to exit.
268 .It Supports client callback.
270 can use either the standard LCP callback protocol or the Microsoft
271 CallBack Control Protocol (ftp://ftp.microsoft.com/developr/rfc/cbcp.txt).
272 .It Supports NAT or packet aliasing.
273 Packet aliasing (a.k.a.\& IP masquerading) allows computers on a
274 private, unregistered network to access the Internet.
277 host acts as a masquerading gateway.
278 IP addresses as well as TCP and
279 UDP port numbers are NAT'd for outgoing packets and de-NAT'd for
281 .It Supports background PPP connections.
282 In background mode, if
284 successfully establishes the connection, it will become a daemon.
285 Otherwise, it will exit with an error.
286 This allows the setup of
287 scripts that wish to execute certain commands only if the connection
288 is successfully established.
289 .It Supports server-side PPP connections.
292 acts as server which accepts incoming
294 connections on stdin/stdout.
295 .It Supports PAP and CHAP (rfc 1994, 2433 and 2759) authentication.
296 With PAP or CHAP, it is possible to skip the Unix style
298 procedure, and use the
300 protocol for authentication instead.
301 If the peer requests Microsoft CHAP authentication and
303 is compiled with DES support, an appropriate MD4/DES response will be
305 .It Supports RADIUS (rfc 2138 & 2548) authentication.
306 An extension to PAP and CHAP,
313 allows authentication information to be stored in a central or
314 distributed database along with various per-user framed connection
316 ifdef({LOCALRAD},{},{If
318 is available at compile time,
322 requests when configured to do so.
324 .It Supports Proxy Arp.
326 can be configured to make one or more proxy arp entries on behalf of
328 This allows routing from the peer to the LAN without
329 configuring each machine on that LAN.
330 .It Supports packet filtering.
331 User can {define} four kinds of filters: the
333 filter for incoming packets, the
335 filter for outgoing packets, the
337 filter to {define} a dialing trigger packet and the
339 filter for keeping a connection alive with the trigger packet.
340 .It Tunnel driver supports bpf.
343 to check the packet flow over the
346 .It Supports PPP over TCP and PPP over UDP.
347 If a device name is specified as
348 .Em host Ns No : Ns Em port Ns
353 will open a TCP or UDP connection for transporting data rather than using a
354 conventional serial device.
355 UDP connections force
357 into synchronous mode.
358 .It Supports PPP over Ethernet (rfc 2516).
361 is given a device specification of the format
362 .No PPPoE: Ns Ar iface Ns Xo
363 .Op \&: Ns Ar provider Ns
377 On systems that do not support
379 an external program such as
382 .It "Supports IETF draft Predictor-1 (rfc 1978) and DEFLATE (rfc 1979) compression."
384 supports not only VJ-compression but also Predictor-1 and DEFLATE compression.
385 Normally, a modem has built-in compression (e.g., v42.bis) and the system
386 may receive higher data rates from it as a result of such compression.
387 While this is generally a good thing in most other situations, this
388 higher speed data imposes a penalty on the system by increasing the
389 number of serial interrupts the system has to process in talking to the
390 modem and also increases latency.
391 Unlike VJ-compression, Predictor-1 and DEFLATE compression pre-compresses
393 network traffic flowing through the link, thus reducing overheads to a
395 .It Supports Microsoft's IPCP extensions (rfc 1877).
396 Name Server Addresses and NetBIOS Name Server Addresses can be negotiated
397 with clients using the Microsoft
399 stack (i.e., Win95, WinNT)
400 .It Supports Multi-link PPP (rfc 1990)
401 It is possible to configure
403 to open more than one physical connection to the peer, combining the
404 bandwidth of all links for better throughput.
405 .It Supports MPPE (draft-ietf-pppext-mppe)
406 MPPE is Microsoft Point to Point Encryption scheme.
407 It is possible to configure
409 to participate in Microsoft's Windows VPN.
412 can only get encryption keys from CHAP 81 authentication.
414 must be compiled with DES for MPPE to operate.
415 .It Supports IPV6CP (rfc 2023).
416 An IPv6 connection can be made in addition to or instead of the normal
429 will not run if the invoking user id is not zero.
430 This may be overridden by using the
433 .Pa /etc/ppp/ppp.conf .
434 When running as a normal user,
436 switches to user id 0 in order to alter the system routing table, set up
437 system lock files and read the ppp configuration files.
438 All external commands (executed via the "shell" or "!bg" commands) are executed
439 as the user id that invoked
443 logging facility if you are interested in what exactly is done as user id
448 you may need to deal with some initial configuration details.
451 Make sure that your system has a group named
455 file and that the group contains the names of all users expected to use
459 manual page for details.
460 Each of these users must also be given access using the
463 .Pa /etc/ppp/ppp.conf .
470 A common log file name is
471 .Pa /var/log/ppp.log .
472 To make output go to this file, put the following lines in the
475 .Bd -literal -offset indent
477 *.*<TAB>/var/log/ppp.log
480 It is possible to have more than one
482 log file by creating a link to the
490 .Bd -literal -offset indent
492 *.*<TAB>/var/log/ppp0.log
496 .Pa /etc/syslog.conf .
497 Do not forget to send a
502 .Pa /etc/syslog.conf .
504 Although not strictly relevant to
506 operation, you should configure your resolver so that it works correctly.
507 This can be done by configuring a local DNS
510 or by adding the correct
513 .Pa /etc/resolv.conf .
516 manual page for details.
518 Alternatively, if the peer supports it,
520 can be configured to ask the peer for the nameserver address(es) and to
528 commands below for details.
531 In the following examples, we assume that your machine name is
537 above) with no arguments, you are presented with a prompt:
538 .Bd -literal -offset indent
544 part of your prompt should always be in upper case.
545 If it is in lower case, it means that you must supply a password using the
548 This only ever happens if you connect to a running version of
550 and have not authenticated yourself using the correct password.
552 You can start by specifying the device name and speed:
553 .Bd -literal -offset indent
554 ppp ON awfulhak> set device /dev/cuau0
555 ppp ON awfulhak> set speed 38400
558 Normally, hardware flow control (CTS/RTS) is used.
560 certain circumstances (as may happen when you are connected directly
561 to certain PPP-capable terminal servers), this may result in
563 hanging as soon as it tries to write data to your communications link
564 as it is waiting for the CTS (clear to send) signal - which will never
566 Thus, if you have a direct line and cannot seem to make a
567 connection, try turning CTS/RTS off with
569 If you need to do this, check the
571 description below too - you will probably need to
572 .Dq set accmap 000a0000 .
574 Usually, parity is set to
579 Parity is a rather archaic error checking mechanism that is no
580 longer used because modern modems do their own error checking, and most
581 link-layer protocols (that is what
583 is) use much more reliable checking mechanisms.
584 Parity has a relatively
585 huge overhead (a 12.5% increase in traffic) and as a result, it is always
592 However, some ISPs (Internet Service Providers) may use
593 specific parity settings at connection time (before
596 Notably, Compuserve insist on even parity when logging in:
597 .Bd -literal -offset indent
598 ppp ON awfulhak> set parity even
601 You can now see what your current device settings look like:
602 .Bd -literal -offset indent
603 ppp ON awfulhak> show physical
607 Link Type: interactive
613 Device List: /dev/cuau0
614 Characteristics: 38400bps, cs8, even parity, CTS/RTS on
617 0 octets in, 0 octets out
622 The term command can now be used to talk directly to the device:
623 .Bd -literal -offset indent
624 ppp ON awfulhak> term
630 Password: myisppassword
634 When the peer starts to talk in
637 detects this automatically and returns to command mode.
638 .Bd -literal -offset indent
639 ppp ON awfulhak> # No link has been established
640 Ppp ON awfulhak> # We've connected & finished LCP
641 PPp ON awfulhak> # We've authenticated
642 PPP ON awfulhak> # We've agreed IP numbers
645 If it does not, it is probable that the peer is waiting for your end to
651 configuration packets to the peer, use the
653 command to drop out of terminal mode and enter packet mode.
655 If you never even receive a login prompt, it is quite likely that the
656 peer wants to use PAP or CHAP authentication instead of using Unix-style
657 login/password authentication.
658 To set things up properly, drop back to
659 the prompt and set your authentication name and key, then reconnect:
660 .Bd -literal -offset indent
662 ppp ON awfulhak> set authname myispusername
663 ppp ON awfulhak> set authkey myisppassword
664 ppp ON awfulhak> term
671 You may need to tell ppp to initiate negotiations with the peer here too:
672 .Bd -literal -offset indent
674 ppp ON awfulhak> # No link has been established
675 Ppp ON awfulhak> # We've connected & finished LCP
676 PPp ON awfulhak> # We've authenticated
677 PPP ON awfulhak> # We've agreed IP numbers
680 You are now connected!
683 in the prompt has changed to capital letters to indicate that you have
685 If only some of the three Ps go uppercase, wait until
686 either everything is uppercase or lowercase.
687 If they revert to lowercase, it means that
689 could not successfully negotiate with the peer.
690 A good first step for troubleshooting at this point would be to
691 .Bd -literal -offset indent
692 ppp ON awfulhak> set log local phase lcp ipcp
698 command description below for further details.
699 If things fail at this point,
700 it is quite important that you turn logging on and try again.
702 important that you note any prompt changes and report them to anyone trying
705 When the link is established, the show command can be used to see how
707 .Bd -literal -offset indent
708 PPP ON awfulhak> show physical
709 * Modem related information is shown here *
710 PPP ON awfulhak> show ccp
711 * CCP (compression) related information is shown here *
712 PPP ON awfulhak> show lcp
713 * LCP (line control) related information is shown here *
714 PPP ON awfulhak> show ipcp
715 * IPCP (IP) related information is shown here *
716 PPP ON awfulhak> show ipv6cp
717 * IPV6CP (IPv6) related information is shown here *
718 PPP ON awfulhak> show link
719 * Link (high level) related information is shown here *
720 PPP ON awfulhak> show bundle
721 * Logical (high level) connection related information is shown here *
724 At this point, your machine has a host route to the peer.
726 that you can only make a connection with the host on the other side
728 If you want to add a default route entry (telling your
729 machine to send all packets without another routing entry to the other
732 link), enter the following command:
733 .Bd -literal -offset indent
734 PPP ON awfulhak> add default HISADDR
739 represents the IP address of the connected peer.
742 command fails due to an existing route, you can overwrite the existing
744 .Bd -literal -offset indent
745 PPP ON awfulhak> add! default HISADDR
748 This command can also be executed before actually making the connection.
749 If a new IP address is negotiated at connection time,
751 will update your default route accordingly.
753 You can now use your network applications (ping, telnet, ftp, etc.)
754 in other windows or terminals on your machine.
755 If you wish to reuse the current terminal, you can put
757 into the background using your standard shell suspend and background
765 section for details on all available commands.
766 .Sh AUTOMATIC DIALING
767 To use automatic dialing, you must prepare some Dial and Login chat scripts.
768 See the example definitions in
769 .Pa /usr/share/examples/ppp/ppp.conf.sample
771 .Pa /etc/ppp/ppp.conf
773 Each line contains one comment, inclusion, label or command:
776 A line starting with a
778 character is treated as a comment line.
779 Leading whitespace are ignored when identifying comment lines.
781 An inclusion is a line beginning with the word
783 It must have one argument - the file to {include}.
785 .Dq {!include} ~/.ppp.conf
786 for compatibility with older versions of
789 A label name starts in the first column and is followed by
793 A command line must contain a space or tab in the first column.
795 A string starting with the
797 character is substituted with the value of the environment variable by
799 Likewise, a string starting with the
801 character is substituted with the full path to the home directory of
802 the user account by the same name, and the
804 character by itself is substituted with the full path to the home directory
806 If you want to include a literal
810 character in a command or argument, enclose them in double quotes, e.g.,
811 .Bd -literal -offset indent
812 set password "pa$ss~word"
817 .Pa /etc/ppp/ppp.conf
818 file should consist of at least a
821 This section is always executed.
822 It should also contain
823 one or more sections, named according to their purpose, for example,
825 would represent your ISP, and
827 would represent an incoming
830 You can now specify the destination label name when you invoke
832 Commands associated with the
834 label are executed, followed by those associated with the destination
838 is started with no arguments, the
840 section is still executed.
841 The load command can be used to manually load a section from the
842 .Pa /etc/ppp/ppp.conf
844 .Bd -literal -offset indent
845 ppp ON awfulhak> load MyISP
848 Note, no action is taken by
850 after a section is loaded, whether it is the result of passing a label on
851 the command line or using the
854 Only the commands specified for that label in the configuration
856 However, when invoking
863 switches, the link mode tells
865 to establish a connection.
868 command below for further details.
870 Once the connection is made, the
872 portion of the prompt will change to
874 .Bd -literal -offset indent
877 ppp ON awfulhak> dial
883 The Ppp prompt indicates that
885 has entered the authentication phase.
886 The PPp prompt indicates that
888 has entered the network phase.
889 The PPP prompt indicates that
891 has successfully negotiated a network layer protocol and is in
895 .Pa /etc/ppp/ppp.linkup
896 file is available, its contents are executed
899 connection is established.
903 .Pa /usr/share/examples/ppp/ppp.conf.sample
904 which runs a script in the background after the connection is established
909 commands below for a description of possible substitution strings).
910 Similarly, when a connection is closed, the contents of the
911 .Pa /etc/ppp/ppp.linkdown
913 Both of these files have the same format as
914 .Pa /etc/ppp/ppp.conf .
916 In previous versions of
918 it was necessary to re-add routes such as the default route in the
924 where all routes that contain the
930 literals will automatically be updated when the values of these variables
932 .Sh BACKGROUND DIALING
933 If you want to establish a connection using
935 non-interactively (such as from a
939 job) you should use the
946 attempts to establish the connection immediately.
948 numbers are specified, each phone number will be tried once.
949 If the attempt fails,
951 exits immediately with a non-zero exit code.
954 becomes a daemon, and returns an exit status of zero to its caller.
955 The daemon exits automatically if the connection is dropped by the
956 remote system, or it receives a
960 Demand dialing is enabled with the
965 You must also specify the destination label in
966 .Pa /etc/ppp/ppp.conf
970 command to {define} the remote peers IP address.
972 .Pa /usr/share/examples/ppp/ppp.conf.sample )
973 .Bd -literal -offset indent
983 runs as a daemon but you can still configure or examine its
984 configuration by using the
987 .Pa /etc/ppp/ppp.conf ,
989 .Dq Li "set server +3000 mypasswd" )
990 and connecting to the diagnostic port as follows:
991 .Bd -literal -offset indent
992 # pppctl 3000 (assuming tun0)
994 PPP ON awfulhak> show who
995 tcp (127.0.0.1:1028) *
1000 command lists users that are currently connected to
1003 If the diagnostic socket is closed or changed to a different
1004 socket, all connections are immediately dropped.
1008 mode, when an outgoing packet is detected,
1010 will perform the dialing action (chat script) and try to connect
1014 mode, the dialing action is performed any time the line is found
1016 If the connect fails, the default behaviour is to wait 30 seconds
1017 and then attempt to connect when another outgoing packet is detected.
1018 This behaviour can be changed using the
1022 .No set redial Ar secs Ns
1024 .Oo - Ns Ar max Ns Oc Oc Ns
1028 .Bl -tag -width attempts -compact
1030 is the number of seconds to wait before attempting
1032 If the argument is the literal string
1034 the delay period is a random value between 1 and 30 seconds inclusive.
1036 is the number of seconds that
1038 should be incremented each time a new dial attempt is made.
1039 The timeout reverts to
1041 only after a successful connection is established.
1042 The default value for
1046 is the maximum number of times
1050 The default value for
1054 is the number of seconds to wait before attempting
1055 to dial the next number in a list of numbers (see the
1058 The default is 3 seconds.
1059 Again, if the argument is the literal string
1061 the delay period is a random value between 1 and 30 seconds.
1063 is the maximum number of times to try to connect for each outgoing packet
1064 that triggers a dial.
1065 The previous value is unchanged if this parameter is omitted.
1066 If a value of zero is specified for
1069 will keep trying until a connection is made.
1073 .Bd -literal -offset indent
1077 will attempt to connect 4 times for each outgoing packet that causes
1078 a dial attempt with a 3 second delay between each number and a 10 second
1079 delay after all numbers have been tried.
1080 If multiple phone numbers
1081 are specified, the total number of attempts is still 4 (it does not
1082 attempt each number 4 times).
1085 .Bd -literal -offset indent
1086 set redial 10+10-5.3 20
1091 to attempt to connect 20 times.
1092 After the first attempt,
1094 pauses for 10 seconds.
1095 After the next attempt it pauses for 20 seconds
1096 and so on until after the sixth attempt it pauses for 1 minute.
1097 The next 14 pauses will also have a duration of one minute.
1100 connects, disconnects and fails to connect again, the timeout starts again
1103 Modifying the dial delay is very useful when running
1107 mode on both ends of the link.
1108 If each end has the same timeout,
1109 both ends wind up calling each other at the same time if the link
1110 drops and both ends have packets queued.
1111 At some locations, the serial link may not be reliable, and carrier
1112 may be lost at inappropriate times.
1113 It is possible to have
1115 redial should carrier be unexpectedly lost during a session.
1116 .Bd -literal -offset indent
1117 set reconnect timeout ntries
1122 to re-establish the connection
1124 times on loss of carrier with a pause of
1126 seconds before each try.
1128 .Bd -literal -offset indent
1134 that on an unexpected loss of carrier, it should wait
1136 seconds before attempting to reconnect.
1137 This may happen up to
1142 The default value of ntries is zero (no reconnect).
1143 Care should be taken with this option.
1144 If the local timeout is slightly
1145 longer than the remote timeout, the reconnect feature will always be
1146 triggered (up to the given number of times) after the remote side
1147 times out and hangs up.
1148 NOTE: In this context, losing too many LQRs constitutes a loss of
1149 carrier and will trigger a reconnect.
1152 flag is specified, all phone numbers are dialed at most once until
1153 a connection is made.
1154 The next number redial period specified with the
1156 command is honoured, as is the reconnect tries value.
1158 value is less than the number of phone numbers specified, not all
1159 the specified numbers will be tried.
1160 To terminate the program, type
1161 .Bd -literal -offset indent
1162 PPP ON awfulhak> close
1163 ppp ON awfulhak> quit all
1168 command will terminate the
1172 connection but not the
1180 .Sh RECEIVING INCOMING PPP CONNECTIONS (Method 1)
1181 To handle an incoming
1183 connection request, follow these steps:
1186 Make sure the modem and (optionally)
1188 is configured correctly.
1189 .Bl -bullet -compact
1191 Use Hardware Handshake (CTS/RTS) for flow control.
1193 Modem should be set to NO echo back (ATE0) and NO results string (ATQ1).
1201 on the port where the modem is attached.
1204 .Dl ttyd1 Qo /usr/libexec/getty std.38400 Qc dialup on secure
1206 Do not forget to send a
1210 process to start the
1215 It is usually also necessary to train your modem to the same DTR speed
1217 .Bd -literal -offset indent
1219 ppp ON awfulhak> set device /dev/cuau1
1220 ppp ON awfulhak> set speed 38400
1221 ppp ON awfulhak> term
1222 deflink: Entering terminal mode on /dev/cuau1
1233 ppp ON awfulhak> quit
1237 .Pa /usr/local/bin/ppplogin
1238 file with the following contents:
1239 .Bd -literal -offset indent
1241 exec /usr/sbin/ppp -direct incoming
1248 work with stdin and stdout.
1251 to connect to a configured diagnostic port, in the same manner as with
1257 section must be set up in
1258 .Pa /etc/ppp/ppp.conf .
1262 section contains the
1264 command as appropriate.
1266 Prepare an account for the incoming user.
1268 ppp:xxxx:66:66:PPP Login User:/home/ppp:/usr/local/bin/ppplogin
1271 Refer to the manual entries for
1277 Support for IPCP Domain Name Server and NetBIOS Name Server negotiation
1278 can be enabled using the
1283 Refer to their descriptions below.
1285 .Sh RECEIVING INCOMING PPP CONNECTIONS (Method 2)
1286 This method differs in that we use
1288 to authenticate the connection rather than
1292 Configure your default section in
1294 with automatic ppp recognition by specifying the
1299 :pp=/usr/local/bin/ppplogin:\\
1303 Configure your serial device(s), enable a
1306 .Pa /usr/local/bin/ppplogin
1307 as in the first three steps for method 1 above.
1315 .Pa /etc/ppp/ppp.conf
1318 label (or whatever label
1323 .Pa /etc/ppp/ppp.secret
1324 for each incoming user:
1333 detects a ppp connection (by recognising the HDLC frame headers), it runs
1334 .Dq /usr/local/bin/ppplogin .
1338 that either PAP or CHAP are enabled as above.
1339 If they are not, you are
1340 allowing anybody to establish a ppp session with your machine
1342 a password, opening yourself up to all sorts of potential attacks.
1343 .Sh AUTHENTICATING INCOMING CONNECTIONS
1344 Normally, the receiver of a connection requires that the peer
1345 authenticates itself.
1346 This may be done using
1348 but alternatively, you can use PAP or CHAP.
1349 CHAP is the more secure of the two, but some clients may not support it.
1350 Once you decide which you wish to use, add the command
1354 to the relevant section of
1357 You must then configure the
1358 .Pa /etc/ppp/ppp.secret
1360 This file contains one line per possible client, each line
1361 containing up to five fields:
1364 .Ar hisaddr Op Ar label Op Ar callback-number
1371 specify the client username and password.
1376 and PAP is being used,
1378 will look up the password database
1380 when authenticating.
1381 If the client does not offer a suitable response based on any
1382 .Ar name Ns No / Ns Ar key
1385 authentication fails.
1387 If authentication is successful,
1390 is used when negotiating IP numbers.
1393 command for details.
1395 If authentication is successful and
1397 is specified, the current system label is changed to match the given
1399 This will change the subsequent parsing of the
1405 If authentication is successful and
1411 the client will be called back on the given number.
1412 If CBCP is being used,
1414 may also contain a list of numbers or a
1419 The value will be used in
1421 subsequent CBCP phase.
1422 .Sh PPP OVER TCP and UDP (a.k.a Tunnelling)
1425 over a serial link, it is possible to
1426 use a TCP connection instead by specifying the host, port and protocol as the
1429 .Dl set device ui-gate:6669/tcp
1431 Instead of opening a serial device,
1433 will open a TCP connection to the given machine on the given
1435 It should be noted however that
1437 does not use the telnet protocol and will be unable to negotiate
1438 with a telnet server.
1439 You should set up a port for receiving this
1441 connection on the receiving machine (ui-gate).
1442 This is done by first updating
1444 to name the service:
1446 .Dl ppp-in 6669/tcp # Incoming PPP connections over TCP
1452 how to deal with incoming connections on that port:
1454 .Dl ppp-in stream tcp nowait root /usr/sbin/ppp ppp -direct ppp-in
1456 Do not forget to send a
1460 after you have updated
1461 .Pa /etc/inetd.conf .
1462 Here, we use a label named
1465 .Pa /etc/ppp/ppp.conf
1466 on ui-gate (the receiver) should contain the following:
1467 .Bd -literal -offset indent
1470 set ifaddr 10.0.4.1 10.0.4.2
1474 .Pa /etc/ppp/ppp.linkup
1476 .Bd -literal -offset indent
1478 add 10.0.1.0/24 HISADDR
1481 It is necessary to put the
1485 to ensure that the route is only added after
1487 has negotiated and assigned addresses to its interface.
1489 You may also want to enable PAP or CHAP for security.
1490 To enable PAP, add the following line:
1491 .Bd -literal -offset indent
1495 You will also need to create the following entry in
1496 .Pa /etc/ppp/ppp.secret :
1497 .Bd -literal -offset indent
1498 MyAuthName MyAuthPasswd
1505 the password is looked up in the
1510 .Pa /etc/ppp/ppp.conf
1511 on awfulhak (the initiator) should contain the following:
1512 .Bd -literal -offset indent
1515 set device ui-gate:ppp-in/tcp
1518 set log Phase Chat Connect hdlc LCP IPCP IPV6CP CCP tun
1519 set ifaddr 10.0.4.2 10.0.4.1
1522 with the route setup in
1523 .Pa /etc/ppp/ppp.linkup :
1524 .Bd -literal -offset indent
1526 add 10.0.2.0/24 HISADDR
1529 Again, if you are enabling PAP, you will also need this in the
1530 .Pa /etc/ppp/ppp.conf
1532 .Bd -literal -offset indent
1533 set authname MyAuthName
1534 set authkey MyAuthKey
1537 We are assigning the address of 10.0.4.1 to ui-gate, and the address
1538 10.0.4.2 to awfulhak.
1539 To open the connection, just type
1541 .Dl awfulhak # ppp -background ui-gate
1543 The result will be an additional "route" on awfulhak to the
1544 10.0.2.0/24 network via the TCP connection, and an additional
1545 "route" on ui-gate to the 10.0.1.0/24 network.
1546 The networks are effectively bridged - the underlying TCP
1547 connection may be across a public network (such as the
1550 traffic is conceptually encapsulated
1551 (although not packet by packet) inside the TCP stream between
1554 The major disadvantage of this mechanism is that there are two
1555 "guaranteed delivery" mechanisms in place - the underlying TCP
1556 stream and whatever protocol is used over the
1558 link - probably TCP again.
1559 If packets are lost, both levels will
1560 get in each others way trying to negotiate sending of the missing
1563 To avoid this overhead, it is also possible to do all this using
1564 UDP instead of TCP as the transport by simply changing the protocol
1565 from "tcp" to "udp".
1566 When using UDP as a transport,
1568 will operate in synchronous mode.
1569 This is another gain as the incoming
1570 data does not have to be rearranged into packets.
1572 Care should be taken when adding a default route through a tunneled
1574 It is quite common for the default route
1576 .Pa /etc/ppp/ppp.linkup )
1577 to end up routing the link's TCP connection through the tunnel,
1578 effectively garrotting the connection.
1579 To avoid this, make sure you add a static route for the benefit of
1581 .Bd -literal -offset indent
1584 set device ui-gate:ppp-in/tcp
1591 is the IP number that your route to
1595 When routing your connection across a public network such as the Internet,
1596 it is preferable to encrypt the data.
1597 This can be done with the help of the MPPE protocol, although currently this
1598 means that you will not be able to also compress the traffic as MPPE is
1599 implemented as a compression layer (thank Microsoft for this).
1600 To enable MPPE encryption, add the following lines to
1601 .Pa /etc/ppp/ppp.conf
1603 .Bd -literal -offset indent
1605 disable deflate pred1
1609 ensuring that you have put the requisite entry in
1610 .Pa /etc/ppp/ppp.secret
1611 (MSCHAPv2 is challenge based, so
1615 MSCHAPv2 and MPPE are accepted by default, so the client end should work
1616 without any additional changes (although ensure you have
1621 .Sh NETWORK ADDRESS TRANSLATION (PACKET ALIASING)
1624 command line option enables network address translation (a.k.a.\& packet
1628 host to act as a masquerading gateway for other computers over
1629 a local area network.
1630 Outgoing IP packets are NAT'd so that they appear to come from the
1632 host, and incoming packets are de-NAT'd so that they are routed
1633 to the correct machine on the local area network.
1634 NAT allows computers on private, unregistered subnets to have Internet
1635 access, although they are invisible from the outside world.
1638 operation should first be verified with network address translation disabled.
1641 option should be switched on, and network applications (web browser,
1646 should be checked on the
1649 Finally, the same or similar applications should be checked on other
1650 computers in the LAN.
1651 If network applications work correctly on the
1653 host, but not on other machines in the LAN, then the masquerading
1654 software is working properly, but the host is either not forwarding
1655 or possibly receiving IP packets.
1656 Check that IP forwarding is enabled in
1658 and that other machines have designated the
1660 host as the gateway for the LAN.
1661 .Sh PACKET FILTERING
1662 This implementation supports packet filtering.
1663 There are four kinds of
1673 Here are the basics:
1676 A filter definition has the following syntax:
1685 .Ar src_addr Ns Op / Ns Ar width
1686 .Op Ar dst_addr Ns Op / Ns Ar width
1688 .Ar [ proto Op src Ar cmp port
1693 .Op timeout Ar secs ]
1705 is a numeric value between
1709 specifying the rule number.
1710 Rules are specified in numeric order according to
1721 in which case, if a given packet matches the rule, the associated action
1722 is taken immediately.
1724 can also be specified as
1726 to clear the action associated with that particular rule, or as a new
1727 rule number greater than the current rule.
1728 In this case, if a given
1729 packet matches the current rule, the packet will next be matched against
1730 the new rule number (rather than the next rule number).
1734 may optionally be followed with an exclamation mark
1738 to reverse the sense of the following match.
1740 .Op Ar src_addr Ns Op / Ns Ar width
1742 .Op Ar dst_addr Ns Op / Ns Ar width
1743 are the source and destination IP number specifications.
1746 is specified, it gives the number of relevant netmask bits,
1747 allowing the specification of an address range.
1753 may be given the values
1759 (refer to the description of the
1761 command for a description of these values).
1762 When these values are used,
1763 the filters will be updated any time the values change.
1764 This is similar to the behaviour of the
1769 may be any protocol from
1778 meaning less-than, equal and greater-than respectively.
1780 can be specified as a numeric port or by service name from
1788 flags are only allowed when
1792 and represent the TH_ACK, TH_SYN and TH_FIN or TH_RST TCP flags respectively.
1794 The timeout value adjusts the current idle timeout to at least
1797 If a timeout is given in the alive filter as well as in the in/out
1798 filter, the in/out value is used.
1799 If no timeout is given, the default timeout (set using
1801 and defaulting to 180 seconds) is used.
1805 Each filter can hold up to 40 rules, starting from rule 0.
1806 The entire rule set is not effective until rule 0 is defined,
1807 i.e., the default is to allow everything through.
1809 If no rule in a defined set of rules matches a packet, that packet will
1810 be discarded (blocked).
1811 If there are no rules in a given filter, the packet will be permitted.
1813 It is possible to filter based on the payload of UDP frames where those
1819 .Ar filter-decapsulation
1820 option below for further details.
1823 .Dq set filter Ar name No -1
1828 .Pa /usr/share/examples/ppp/ppp.conf.sample .
1829 .Sh SETTING THE IDLE TIMER
1830 To check/set the idle timer, use the
1835 .Bd -literal -offset indent
1836 ppp ON awfulhak> set timeout 600
1839 The timeout period is measured in seconds, the default value for which
1842 To disable the idle timer function, use the command
1843 .Bd -literal -offset indent
1844 ppp ON awfulhak> set timeout 0
1851 modes, the idle timeout is ignored.
1854 mode, when the idle timeout causes the
1859 program itself remains running.
1860 Another trigger packet will cause it to attempt to re-establish the link.
1861 .Sh PREDICTOR-1 and DEFLATE COMPRESSION
1863 supports both Predictor type 1 and deflate compression.
1866 will attempt to use (or be willing to accept) both compression protocols
1867 when the peer agrees
1869 The deflate protocol is preferred by
1875 commands if you wish to disable this functionality.
1877 It is possible to use a different compression algorithm in each direction
1878 by using only one of
1882 (assuming that the peer supports both algorithms).
1884 By default, when negotiating DEFLATE,
1886 will use a window size of 15.
1889 command if you wish to change this behaviour.
1891 A special algorithm called DEFLATE24 is also available, and is disabled
1892 and denied by default.
1893 This is exactly the same as DEFLATE except that
1894 it uses CCP ID 24 to negotiate.
1897 to successfully negotiate DEFLATE with
1900 .Sh CONTROLLING IP ADDRESS
1903 uses IPCP to negotiate IP addresses.
1904 Each side of the connection
1905 specifies the IP address that it is willing to use, and if the requested
1906 IP address is acceptable then
1908 returns an ACK to the requester.
1911 returns NAK to suggest that the peer use a different IP address.
1913 both sides of the connection agree to accept the received request (and
1914 send an ACK), IPCP is set to the open state and a network level connection
1916 To control this IPCP behaviour, this implementation has the
1918 command for defining the local and remote IP address:
1919 .Bd -ragged -offset indent
1920 .No set ifaddr Oo Ar src_addr Ns
1922 .Oo Ar dst_addr Ns Op / Ns Ar \&nn
1932 is the IP address that the local side is willing to use,
1934 is the IP address which the remote side should use and
1936 is the netmask that should be used.
1938 defaults to the current
1941 defaults to 0.0.0.0, and
1943 defaults to whatever mask is appropriate for
1945 It is only possible to make
1947 smaller than the default.
1948 The usual value is 255.255.255.255, as
1949 most kernels ignore the netmask of a POINTOPOINT interface.
1953 implementations require that the peer negotiates a specific IP
1956 If this is the case,
1958 may be used to specify this IP number.
1959 This will not affect the
1960 routing table unless the other side agrees with this proposed number.
1961 .Bd -literal -offset indent
1962 set ifaddr 192.244.177.38 192.244.177.2 255.255.255.255 0.0.0.0
1965 The above specification means:
1967 .Bl -bullet -compact
1969 I will first suggest that my IP address should be 0.0.0.0, but I
1970 will only accept an address of 192.244.177.38.
1972 I strongly insist that the peer uses 192.244.177.2 as his own
1973 address and will not permit the use of any IP address but 192.244.177.2.
1974 When the peer requests another IP address, I will always suggest that
1975 it uses 192.244.177.2.
1977 The routing table entry will have a netmask of 0xffffffff.
1980 This is all fine when each side has a pre-determined IP address, however
1981 it is often the case that one side is acting as a server which controls
1982 all IP addresses and the other side should go along with it.
1983 In order to allow more flexible behaviour, the
1985 command allows the user to specify IP addresses more loosely:
1987 .Dl set ifaddr 192.244.177.38/24 192.244.177.2/20
1989 A number followed by a slash
1991 represents the number of bits significant in the IP address.
1992 The above example means:
1994 .Bl -bullet -compact
1996 I would like to use 192.244.177.38 as my address if it is possible, but I will
1997 also accept any IP address between 192.244.177.0 and 192.244.177.255.
1999 I would like to make him use 192.244.177.2 as his own address, but I will also
2000 permit him to use any IP address between 192.244.176.0 and
2003 As you may have already noticed, 192.244.177.2 is equivalent to saying
2006 As an exception, 0 is equivalent to 0.0.0.0/0, meaning that I have no
2007 preferred IP address and will obey the remote peers selection.
2008 When using zero, no routing table entries will be made until a connection
2011 192.244.177.2/0 means that I will accept/permit any IP address but I will
2012 suggest that 192.244.177.2 be used first.
2015 When negotiating IPv6 addresses, no control is given to the user.
2016 IPV6CP negotiation is fully automatic.
2017 .Sh CONNECTING WITH YOUR INTERNET SERVICE PROVIDER
2018 The following steps should be taken when connecting to your ISP:
2021 Describe your providers phone number(s) in the dial script using the
2024 This command allows you to set multiple phone numbers for
2025 dialing and redialing separated by either a pipe
2029 .Bd -ragged -offset indent
2030 .No set phone Ar telno Ns
2031 .Oo \&| Ns Ar backupnumber Oc Ns ... Ns Oo : Ns Ar nextnumber Oc Ns ...
2034 Numbers after the first in a pipe-separated list are only used if the
2035 previous number was used in a failed dial or login script.
2037 separated by a colon are used sequentially, irrespective of what happened
2038 as a result of using the previous number.
2040 .Bd -literal -offset indent
2041 set phone "1234567|2345678:3456789|4567890"
2044 Here, the 1234567 number is attempted.
2045 If the dial or login script fails,
2046 the 2345678 number is used next time, but *only* if the dial or login script
2048 On the dial after this, the 3456789 number is used.
2050 number is only used if the dial or login script using the 3456789 fails.
2051 If the login script of the 2345678 number fails, the next number is still the
2053 As many pipes and colons can be used as are necessary
2054 (although a given site would usually prefer to use either the pipe or the
2055 colon, but not both).
2056 The next number redial timeout is used between all numbers.
2057 When the end of the list is reached, the normal redial period is
2058 used before starting at the beginning again.
2059 The selected phone number is substituted for the \\\\T string in the
2061 command (see below).
2063 Set up your redial requirements using
2065 For example, if you have a bad telephone line or your provider is
2066 usually engaged (not so common these days), you may want to specify
2068 .Bd -literal -offset indent
2072 This says that up to 4 phone calls should be attempted with a pause of 10
2073 seconds before dialing the first number again.
2075 Describe your login procedure using the
2082 command is used to talk to your modem and establish a link with your
2084 .Bd -literal -offset indent
2085 set dial "ABORT BUSY ABORT NO\\\\sCARRIER TIMEOUT 4 \\"\\" \e
2086 ATZ OK-ATZ-OK ATDT\\\\T TIMEOUT 60 CONNECT"
2089 This modem "chat" string means:
2092 Abort if the string "BUSY" or "NO CARRIER" are received.
2094 Set the timeout to 4 seconds.
2101 If that is not received within the 4 second timeout, send ATZ
2104 Send ATDTxxxxxxx where xxxxxxx is the next number in the phone list from
2107 Set the timeout to 60.
2109 Wait for the CONNECT string.
2112 Once the connection is established, the login script is executed.
2113 This script is written in the same style as the dial script, but care should
2114 be taken to avoid having your password logged:
2115 .Bd -literal -offset indent
2116 set authkey MySecret
2117 set login "TIMEOUT 15 login:-\\\\r-login: awfulhak \e
2118 word: \\\\P ocol: PPP HELLO"
2121 This login "chat" string means:
2124 Set the timeout to 15 seconds.
2127 If it is not received, send a carriage return and expect
2132 Expect "word:" (the tail end of a "Password:" prompt).
2134 Send whatever our current
2138 Expect "ocol:" (the tail end of a "Protocol:" prompt).
2147 command is logged specially.
2152 logging is enabled, the actual password is not logged;
2156 Login scripts vary greatly between ISPs.
2157 If you are setting one up for the first time,
2158 .Em ENABLE CHAT LOGGING
2159 so that you can see if your script is behaving as you expect.
2165 to specify your serial line and speed, for example:
2166 .Bd -literal -offset indent
2167 set device /dev/cuau0
2171 Cuad0 is the first serial port on
2178 A speed of 115200 should be specified
2179 if you have a modem capable of bit rates of 28800 or more.
2180 In general, the serial speed should be about four times the modem speed.
2184 command to {define} the IP address.
2187 If you know what IP address your provider uses, then use it as the remote
2188 address (dst_addr), otherwise choose something like 10.0.0.2/0 (see below).
2190 If your provider has assigned a particular IP address to you, then use
2191 it as your address (src_addr).
2193 If your provider assigns your address dynamically, choose a suitably
2194 unobtrusive and unspecific IP number as your address.
2195 10.0.0.1/0 would be appropriate.
2196 The bit after the / specifies how many bits of the
2197 address you consider to be important, so if you wanted to insist on
2198 something in the class C network 1.2.3.0, you could specify 1.2.3.1/24.
2200 If you find that your ISP accepts the first IP number that you suggest,
2201 specify third and forth arguments of
2203 This will force your ISP to assign a number.
2204 (The third argument will
2205 be ignored as it is less restrictive than the default mask for your
2209 An example for a connection where you do not know your IP number or your
2210 ISPs IP number would be:
2211 .Bd -literal -offset indent
2212 set ifaddr 10.0.0.1/0 10.0.0.2/0 0.0.0.0 0.0.0.0
2216 In most cases, your ISP will also be your default router.
2217 If this is the case, add the line
2218 .Bd -literal -offset indent
2223 .Pa /etc/ppp/ppp.conf
2225 .Pa /etc/ppp/ppp.linkup
2226 for setups that do not use
2232 to add a default route to whatever the peer address is
2233 (10.0.0.2 in this example).
2236 meaning that should the value of
2238 change, the route will be updated accordingly.
2240 If your provider requests that you use PAP/CHAP authentication methods, add
2241 the next lines to your
2242 .Pa /etc/ppp/ppp.conf
2244 .Bd -literal -offset indent
2246 set authkey MyPassword
2249 Both are accepted by default, so
2251 will provide whatever your ISP requires.
2253 It should be noted that a login script is rarely (if ever) required
2254 when PAP or CHAP are in use.
2256 Ask your ISP to authenticate your nameserver address(es) with the line
2257 .Bd -literal -offset indent
2263 do this if you are running a local DNS unless you also either use
2268 .Pa /etc/ppp/ppp.linkdown ,
2271 will simply circumvent its use by entering some nameserver lines in
2272 .Pa /etc/resolv.conf .
2276 .Pa /usr/share/examples/ppp/ppp.conf.sample
2278 .Pa /usr/share/examples/ppp/ppp.linkup.sample
2279 for some real examples.
2280 The pmdemand label should be appropriate for most ISPs.
2281 .Sh LOGGING FACILITY
2283 is able to generate the following log info either via
2285 or directly to the screen:
2287 .Bl -tag -width XXXXXXXXX -offset XXX -compact
2289 Enable all logging facilities.
2290 This generates a lot of log.
2291 The most common use of 'all' is as a basis, where you remove some facilities
2292 after enabling 'all' ('debug' and 'timer' are usually best disabled.)
2294 Dump async level packet in hex.
2296 Generate CBCP (CallBack Control Protocol) logs.
2298 Generate a CCP packet trace.
2306 chat script trace logs.
2308 Log commands executed either from the command line or any of the configuration
2311 Log Chat lines containing the string "CONNECT".
2313 Log debug information.
2315 Log DNS QUERY packets.
2317 Log packets permitted by the dial filter and denied by any filter.
2319 Dump HDLC packet in hex.
2321 Log all function calls specifically made as user id 0.
2323 Generate an IPCP packet trace.
2325 Generate an LCP packet trace.
2327 Generate LQR reports.
2329 Phase transition log output.
2331 Dump physical level packet in hex.
2333 Dump RADIUS information.
2334 RADIUS information resulting from the link coming up or down is logged at
2339 This log level is most useful for monitoring RADIUS alive information.
2341 Dump sync level packet in hex.
2343 Dump all TCP/IP packets.
2345 Log timer manipulation.
2347 Include the tun device on each log line.
2349 Output to the terminal device.
2350 If there is currently no terminal,
2351 output is sent to the log file using syslogs
2354 Output to both the terminal device
2355 and the log file using syslogs
2358 Output to the log file using
2364 command allows you to set the logging output level.
2365 Multiple levels can be specified on a single command line.
2366 The default is equivalent to
2369 It is also possible to log directly to the screen.
2370 The syntax is the same except that the word
2372 should immediately follow
2376 (i.e., only the un-maskable warning, error and alert output).
2378 If The first argument to
2379 .Dq set log Op local
2384 character, the current log levels are
2385 not cleared, for example:
2386 .Bd -literal -offset indent
2387 PPP ON awfulhak> set log phase
2388 PPP ON awfulhak> show log
2389 Log: Phase Warning Error Alert
2390 Local: Warning Error Alert
2391 PPP ON awfulhak> set log +tcp/ip -warning
2392 PPP ON awfulhak> set log local +command
2393 PPP ON awfulhak> show log
2394 Log: Phase TCP/IP Warning Error Alert
2395 Local: Command Warning Error Alert
2398 Log messages of level Warning, Error and Alert are not controllable
2400 .Dq set log Op local .
2404 level is special in that it will not be logged if it can be displayed
2408 deals with the following signals:
2409 .Bl -tag -width "USR2"
2411 Receipt of this signal causes the termination of the current connection
2415 to exit unless it is in
2420 .It HUP, TERM & QUIT
2427 to re-open any existing server socket, dropping all existing diagnostic
2429 Sockets that could not previously be opened will be retried.
2433 to close any existing server socket, dropping all existing diagnostic
2436 can still be used to re-open the socket.
2439 If you wish to use more than one physical link to connect to a
2441 peer, that peer must also understand the
2444 Refer to RFC 1990 for specification details.
2446 The peer is identified using a combination of his
2447 .Dq endpoint discriminator
2449 .Dq authentication id .
2450 Either or both of these may be specified.
2451 It is recommended that
2452 at least one is specified, otherwise there is no way of ensuring that
2453 all links are actually connected to the same peer program, and some
2454 confusing lock-ups may result.
2455 Locally, these identification variables are specified using the
2464 must be agreed in advance with the peer.
2466 Multi-link capabilities are enabled using the
2468 command (set maximum reconstructed receive unit).
2469 Once multi-link is enabled,
2471 will attempt to negotiate a multi-link connection with the peer.
2473 By default, only one
2478 To create more links, the
2481 This command will clone existing links, where all
2482 characteristics are the same except:
2485 The new link has its own name as specified on the
2492 Its mode may subsequently be changed using the
2496 The new link is in a
2501 A summary of all available links can be seen using the
2505 Once a new link has been created, command usage varies.
2506 All link specific commands must be prefixed with the
2508 command, specifying on which link the command is to be applied.
2509 When only a single link is available,
2511 is smart enough not to require the
2515 Some commands can still be used without specifying a link - resulting
2516 in an operation at the
2519 For example, once two or more links are available, the command
2521 will show CCP configuration and statistics at the multi-link level, and
2522 .Dq link deflink show ccp
2523 will show the same information at the
2527 Armed with this information, the following configuration might be used:
2528 .Bd -literal -offset indent
2532 set device /dev/cuau0 /dev/cuau1 /dev/cuau2
2533 set phone "123456789"
2534 set dial "ABORT BUSY ABORT NO\\sCARRIER TIMEOUT 5 \\"\\" ATZ \e
2535 OK-AT-OK \\\\dATDT\\\\T TIMEOUT 45 CONNECT"
2537 set ifaddr 10.0.0.1/0 10.0.0.2/0 0.0.0.0 0.0.0.0
2539 set authkey ppppassword
2542 clone 1,2,3 # Create 3 new links - duplicates of the default
2543 link deflink remove # Delete the default link (called ``deflink'')
2546 Note how all cloning is done at the end of the configuration.
2547 Usually, the link will be configured first, then cloned.
2548 If you wish all links
2549 to be up all the time, you can add the following line to the end of your
2551 .Bd -literal -offset indent
2552 link 1,2,3 set mode ddial
2555 If you want the links to dial on demand, this command could be used:
2556 .Bd -literal -offset indent
2557 link * set mode auto
2560 Links may be tied to specific names by removing the
2562 line above, and specifying the following after the
2565 .Bd -literal -offset indent
2566 link 1 set device /dev/cuau0
2567 link 2 set device /dev/cuau1
2568 link 3 set device /dev/cuau2
2573 command to see which commands require context (using the
2575 command), which have optional
2576 context and which should not have any context.
2582 mode with the peer, it creates a local domain socket in the
2585 This socket is used to pass link information (including
2586 the actual link file descriptor) between different
2591 ability to be run from a
2597 capability), without needing to have initial control of the serial
2601 negotiates multi-link mode, it will pass its open link to any
2602 already running process.
2603 If there is no already running process,
2605 will act as the master, creating the socket and listening for new
2607 .Sh PPP COMMAND LIST
2608 This section lists the available commands and their effect.
2609 They are usable either from an interactive
2611 session, from a configuration file or from a
2617 .It accept|deny|enable|disable Ar option....
2618 These directives tell
2620 how to negotiate the initial connection with the peer.
2623 has a default of either accept or deny and enable or disable.
2625 means that the option will be ACK'd if the peer asks for it.
2627 means that the option will be NAK'd if the peer asks for it.
2629 means that the option will be requested by us.
2631 means that the option will not be requested by us.
2634 may be one of the following:
2637 Default: Enabled and Accepted.
2638 ACFComp stands for Address and Control Field Compression.
2639 Non LCP packets will usually have an address
2640 field of 0xff (the All-Stations address) and a control field of
2641 0x03 (the Unnumbered Information command).
2643 negotiated, these two bytes are simply not sent, thus minimising
2650 Default: Disabled and Accepted.
2651 CHAP stands for Challenge Handshake Authentication Protocol.
2652 Only one of CHAP and PAP (below) may be negotiated.
2653 With CHAP, the authenticator sends a "challenge" message to its peer.
2654 The peer uses a one-way hash function to encrypt the
2655 challenge and sends the result back.
2656 The authenticator does the same, and compares the results.
2657 The advantage of this mechanism is that no
2658 passwords are sent across the connection.
2659 A challenge is made when the connection is first made.
2660 Subsequent challenges may occur.
2661 If you want to have your peer authenticate itself, you must
2664 .Pa /etc/ppp/ppp.conf ,
2665 and have an entry in
2666 .Pa /etc/ppp/ppp.secret
2669 When using CHAP as the client, you need only specify
2674 .Pa /etc/ppp/ppp.conf .
2675 CHAP is accepted by default.
2678 implementations use "MS-CHAP" rather than MD5 when encrypting the
2680 MS-CHAP is a combination of MD4 and DES.
2683 was built on a machine with DES libraries available, it will respond
2684 to MS-CHAP authentication requests, but will never request them.
2686 Default: Enabled and Accepted.
2687 This option decides if deflate
2688 compression will be used by the Compression Control Protocol (CCP).
2689 This is the same algorithm as used by the
2692 Note: There is a problem negotiating
2698 implementation available under many operating systems.
2700 (version 2.3.1) incorrectly attempts to negotiate
2702 compression using type
2704 as the CCP configuration type rather than type
2710 is actually specified as
2711 .Dq PPP Magna-link Variable Resource Compression
2715 is capable of negotiating with
2722 .Ar accept Ns No ed .
2724 Default: Disabled and Denied.
2725 This is a variance of the
2727 option, allowing negotiation with the
2732 section above for details.
2733 It is disabled by default as it violates
2736 Default: Disabled and Denied.
2737 This option allows DNS negotiation.
2742 will request that the peer confirms the entries in
2743 .Pa /etc/resolv.conf .
2744 If the peer NAKs our request (suggesting new IP numbers),
2745 .Pa /etc/resolv.conf
2746 is updated and another request is sent to confirm the new entries.
2749 .Dq accept Ns No ed,
2751 will answer any DNS queries requested by the peer rather than rejecting
2753 The answer is taken from
2754 .Pa /etc/resolv.conf
2757 command is used as an override.
2759 Default: Enabled and Accepted.
2760 This option allows control over whether we
2761 negotiate an endpoint discriminator.
2762 We only send our discriminator if
2767 We reject the peers discriminator if
2771 Default: Disabled and Accepted.
2772 The use of this authentication protocol
2773 is discouraged as it partially violates the authentication protocol by
2774 implementing two different mechanisms (LANMan & NT) under the guise of
2775 a single CHAP type (0x80).
2777 uses a simple DES encryption mechanism and is the least secure of the
2778 CHAP alternatives (although is still more secure than PAP).
2782 description below for more details.
2784 Default: Disabled and Accepted.
2785 This option decides if Link Quality Requests will be sent or accepted.
2786 LQR is a protocol that allows
2788 to determine that the link is down without relying on the modems
2790 When LQR is enabled,
2796 below) as part of the LCP request.
2797 If the peer agrees, both sides will
2798 exchange LQR packets at the agreed frequency, allowing detailed link
2799 quality monitoring by enabling LQM logging.
2800 If the peer does not agree, and if the
2807 These packets pass no information of interest, but they
2809 be replied to by the peer.
2816 will abruptly drop the connection if 5 unacknowledged packets have been
2817 sent rather than sending a 6th.
2818 A message is logged at the
2820 level, and any appropriate
2822 values are honoured as if the peer were responsible for dropping the
2827 command description for differences in behaviour prior to
2831 Default: Enabled and Accepted.
2832 This is Microsoft Point to Point Encryption scheme.
2833 MPPE key size can be
2834 40-, 56- and 128-bits.
2839 Default: Disabled and Accepted.
2840 It is very similar to standard CHAP (type 0x05)
2841 except that it issues challenges of a fixed 16 bytes in length and uses a
2842 combination of MD4, SHA-1 and DES to encrypt the challenge rather than using the
2843 standard MD5 mechanism.
2845 Default: Disabled and Accepted.
2846 The use of this authentication protocol
2847 is discouraged as it partially violates the authentication protocol by
2848 implementing two different mechanisms (LANMan & NT) under the guise of
2849 a single CHAP type (0x80).
2850 It is very similar to standard CHAP (type 0x05)
2851 except that it issues challenges of a fixed 8 bytes in length and uses a
2852 combination of MD4 and DES to encrypt the challenge rather than using the
2853 standard MD5 mechanism.
2854 CHAP type 0x80 for LANMan is also supported - see
2862 use CHAP type 0x80, when acting as authenticator with both
2863 .Dq enable Ns No d ,
2865 will rechallenge the peer up to three times if it responds using the wrong
2866 one of the two protocols.
2867 This gives the peer a chance to attempt using both protocols.
2871 acts as the authenticatee with both protocols
2872 .Dq accept Ns No ed ,
2873 the protocols are used alternately in response to challenges.
2875 Note: If only LANMan is enabled,
2877 (version 2.3.5) misbehaves when acting as authenticatee.
2879 the NT and the LANMan answers, but also suggests that only the NT answer
2882 Default: Disabled and Accepted.
2883 PAP stands for Password Authentication Protocol.
2884 Only one of PAP and CHAP (above) may be negotiated.
2885 With PAP, the ID and Password are sent repeatedly to the peer until
2886 authentication is acknowledged or the connection is terminated.
2887 This is a rather poor security mechanism.
2888 It is only performed when the connection is first established.
2889 If you want to have your peer authenticate itself, you must
2892 .Pa /etc/ppp/ppp.conf ,
2893 and have an entry in
2894 .Pa /etc/ppp/ppp.secret
2895 for the peer (although see the
2901 When using PAP as the client, you need only specify
2906 .Pa /etc/ppp/ppp.conf .
2907 PAP is accepted by default.
2909 Default: Enabled and Accepted.
2910 This option decides if Predictor 1
2911 compression will be used by the Compression Control Protocol (CCP).
2913 Default: Enabled and Accepted.
2914 This option is used to negotiate
2915 PFC (Protocol Field Compression), a mechanism where the protocol
2916 field number is reduced to one octet rather than two.
2918 Default: Enabled and Accepted.
2919 This option determines if
2921 will request and accept requests for short
2923 sequence numbers when negotiating multi-link mode.
2924 This is only applicable if our MRRU is set (thus enabling multi-link).
2926 Default: Enabled and Accepted.
2927 This option determines if Van Jacobson header compression will be used.
2930 The following options are not actually negotiated with the peer.
2931 Therefore, accepting or denying them makes no sense.
2935 When this option is enabled,
2939 requests to the peer at the frequency defined by
2943 requests will supersede
2945 requests if enabled and negotiated.
2954 was considered enabled if lqr was enabled and negotiated, otherwise it was
2955 considered disabled.
2956 For the same behaviour, it is now necessary to
2960 .It filter-decapsulation
2962 When this option is enabled,
2964 will examine UDP frames to see if they actually contain a
2966 frame as their payload.
2967 If this is the case, all filters will operate on the payload rather
2968 than the actual packet.
2970 This is useful if you want to send PPPoUDP traffic over a
2972 link, but want that link to do smart things with the real data rather than
2975 The UDP frame payload must not be compressed in any way, otherwise
2977 will not be able to interpret it.
2978 It is therefore recommended that you
2979 .Ic disable vj pred1 deflate
2981 .Ic deny vj pred1 deflate
2982 in the configuration for the
2984 invocation with the udp link.
2987 Forces execution of the configured chat scripts in
2996 exchanges low-level LCP, CCP and IPCP configuration traffic, the
2998 field of any replies is expected to be the same as that of the request.
3001 drops any reply packets that do not contain the expected identifier
3002 field, reporting the fact at the respective log level.
3007 will ignore the identifier field.
3012 This option simply tells
3014 to add new interface addresses to the interface rather than replacing them.
3015 The option can only be enabled if network address translation is enabled
3016 .Pq Dq nat enable yes .
3018 With this option enabled,
3020 will pass traffic for old interface addresses through the NAT
3021 ifdef({LOCALNAT},{engine,},{engine
3023 .Xr libalias 3 ) ,})
3024 resulting in the ability (in
3026 mode) to properly connect the process that caused the PPP link to
3027 come up in the first place.
3037 to attempt to negotiate IP control protocol capabilities and if
3038 successful to exchange IP datagrams with the peer.
3043 to attempt to negotiate IPv6 control protocol capabilities and if
3044 successful to exchange IPv6 datagrams with the peer.
3049 runs as a Multi-link server, a different
3051 instance initially receives each connection.
3052 After determining that
3053 the link belongs to an already existing bundle (controlled by another
3057 will transfer the link to that process.
3059 If the link is a tty device or if this option is enabled,
3061 will not exit, but will change its process name to
3063 and wait for the controlling
3065 to finish with the link and deliver a signal back to the idle process.
3066 This prevents the confusion that results from
3068 parent considering the link resource available again.
3070 For tty devices that have entries in
3072 this is necessary to prevent another
3074 from being started, and for program links such as
3078 from exiting due to the death of its child.
3081 cannot determine its parents requirements (except for the tty case), this
3082 option must be enabled manually depending on the circumstances.
3089 will automatically loop back packets being sent
3090 out with a destination address equal to that of the
3095 will send the packet, probably resulting in an ICMP redirect from
3097 It is convenient to have this option enabled when
3098 the interface is also the default route as it avoids the necessity
3099 of a loopback route.
3102 This option controls whether
3106 attribute to the RADIUS server when RADIUS is in use
3107 .Pq see Dq set radius .
3109 Note, at least one of
3117 prior to version 3.4.1 did not send the
3119 attribute as it was reported to break the Radiator RADIUS server.
3120 As the latest rfc (2865) no longer hints that only one of
3124 should be sent (as rfc 2138 did),
3126 now sends both and leaves it up to the administrator that chooses to use
3127 bad RADIUS implementations to
3128 .Dq disable NAS-IP-Address .
3131 This option controls whether
3135 attribute to the RADIUS server when RADIUS is in use
3136 .Pq see Dq set radius .
3138 Note, at least one of
3145 Enabling this option will tell the PAP authentication
3146 code to use the password database (see
3148 to authenticate the caller if they cannot be found in the
3149 .Pa /etc/ppp/ppp.secret
3151 .Pa /etc/ppp/ppp.secret
3152 is always checked first.
3153 If you wish to use passwords from
3155 but also to specify an IP number or label for a given client, use
3157 as the client password in
3158 .Pa /etc/ppp/ppp.secret .
3161 Enabling this option will tell
3163 to proxy ARP for the peer.
3166 will make an entry in the ARP table using
3170 address of the local network in which
3173 This allows other machines connecteed to the LAN to talk to
3174 the peer as if the peer itself was connected to the LAN.
3175 The proxy entry cannot be made unless
3177 is an address from a LAN.
3180 Enabling this will tell
3182 to add proxy arp entries for every IP address in all class C or
3183 smaller subnets routed via the tun interface.
3185 Proxy arp entries are only made for sticky routes that are added
3189 No proxy arp entries are made for the interface address itself
3197 command is used with the
3203 values, entries are stored in the
3206 Each time these variables change, this list is re-applied to the routing table.
3208 Disabling this option will prevent the re-application of sticky routes,
3211 list will still be maintained.
3212 .It Oo tcp Oc Ns No mssfixup
3216 to adjust TCP SYN packets so that the maximum receive segment
3217 size is not greater than the amount allowed by the interface MTU.
3222 to gather throughput statistics.
3223 Input and output is sampled over
3224 a rolling 5 second window, and current, best and total figures are retained.
3225 This data is output when the relevant
3227 layer shuts down, and is also available using the
3230 Throughput statistics are available at the
3237 Normally, when a user is authenticated using PAP or CHAP, and when
3241 mode, an entry is made in the utmp and wtmp files for that user.
3242 Disabling this option will tell
3244 not to make any utmp or wtmp entries.
3245 This is usually only necessary if
3246 you require the user to both login and authenticate themselves.
3251 .Ar dest Ns Op / Ns Ar nn
3256 is the destination IP address.
3257 The netmask is specified either as a number of bits with
3259 or as an IP number using
3264 with no mask refers to the default route.
3265 It is also possible to use the literal name
3270 is the next hop gateway to get to the given
3275 command for further details.
3277 It is possible to use the symbolic names
3283 as the destination, and
3290 is replaced with the interface IP address,
3292 is replaced with the interface IP destination (peer) address,
3294 is replaced with the interface IPv6 address, and
3296 is replaced with the interface IPv6 destination address,
3303 then if the route already exists, it will be updated as with the
3307 for further details).
3309 Routes that contain the
3317 constants are considered
3319 They are stored in a list (use
3321 to see the list), and each time the value of one of these variables
3322 changes, the appropriate routing table entries are updated.
3323 This facility may be disabled using
3324 .Dq disable sroutes .
3325 .It allow Ar command Op Ar args
3326 This command controls access to
3328 and its configuration files.
3329 It is possible to allow user-level access,
3330 depending on the configuration file label and on the mode that
3333 For example, you may wish to configure
3343 User id 0 is immune to these commands.
3345 .It allow user Ns Xo
3347 .Ar logname Ns No ...
3349 By default, only user id 0 is allowed access to
3351 If this command is used, all of the listed users are allowed access to
3352 the section in which the
3357 section is always checked first (even though it is only ever automatically
3360 commands are cumulative in a given section, but users allowed in any given
3361 section override users allowed in the default section, so it is possible to
3362 allow users access to everything except a given label by specifying default
3365 section, and then specifying a new user list for that label.
3369 is specified, access is allowed to all users.
3370 .It allow mode Ns Xo
3374 By default, access using any
3377 If this command is used, it restricts the access
3379 allowed to load the label under which this command is specified.
3384 command overrides any previous settings, and the
3386 section is always checked first.
3398 When running in multi-link mode, a section can be loaded if it allows
3400 of the currently existing line modes.
3403 .It nat Ar command Op Ar args
3404 This command allows the control of the network address translation (also
3405 known as masquerading or IP aliasing) facilities that are built into
3407 NAT is done on the external interface only, and is unlikely to make sense
3412 If nat is enabled on your system (it may be omitted at compile time),
3413 the following commands are possible:
3415 .It nat enable yes|no
3416 This command either switches network address translation on or turns it off.
3419 command line flag is synonymous with
3420 .Dq nat enable yes .
3421 .It nat addr Op Ar addr_local addr_alias
3422 This command allows data for
3426 It is useful if you own a small number of real IP numbers that
3427 you wish to map to specific machines behind your gateway.
3428 .It nat deny_incoming yes|no
3429 If set to yes, this command will refuse all incoming packets where an
3430 aliasing link does not already exist.
3431 ifdef({LOCALNAT},{},{Refer to the
3432 .Sx CONCEPTUAL BACKGROUND
3435 for a description of what an
3440 It should be noted under what circumstances an aliasing link is
3441 ifdef({LOCALNAT},{created.},{created by
3443 It may be necessary to further protect your network from outside
3444 connections using the
3450 This command gives a summary of available nat commands.
3452 This option causes various NAT statistics and information to
3453 be logged to the file
3454 .Pa /var/log/alias.log .
3455 .It nat port Ar proto Ar targetIP Ns Xo
3456 .No : Ns Ar targetPort Ns
3458 .No - Ns Ar targetPort
3461 .No - Ns Ar aliasPort
3462 .Oc Oo Ar remoteIP : Ns
3465 .No - Ns Ar remotePort
3469 This command causes incoming
3483 A range of port numbers may be specified as shown above.
3484 The ranges must be of the same size.
3488 is specified, only data coming from that IP number is redirected.
3492 (indicating any source port)
3493 or a range of ports the same size as the other ranges.
3495 This option is useful if you wish to run things like Internet phone on
3496 machines behind your gateway, but is limited in that connections to only
3497 one interior machine per source machine and target port are possible.
3498 .It nat proto Ar proto localIP Oo
3499 .Ar publicIP Op Ar remoteIP
3503 to redirect packets of protocol type
3507 to the internal address
3512 is specified, only packets destined for that address are matched,
3513 otherwise the default alias address is used.
3517 is specified, only packets matching that source address are matched,
3519 This command is useful for redirecting tunnel endpoints to an internal machine,
3522 .Dl nat proto ipencap 10.0.0.1
3523 .It "nat proxy cmd" Ar arg Ns No ...
3526 to proxy certain connections, redirecting them to a given server.
3527 ifdef({LOCALNAT},{},{Refer to the description of
3528 .Fn PacketAliasProxyRule
3531 for details of the available commands.
3533 .It nat punch_fw Op Ar base count
3536 to punch holes in the firewall for FTP or IRC DCC connections.
3537 This is done dynamically by installing termporary firewall rules which
3538 allow a particular connection (and only that connection) to go through
3540 The rules are removed once the corresponding connection terminates.
3544 rules starting from rule number
3546 will be used for punching firewall holes.
3547 The range will be cleared when the
3551 If no arguments are given, firewall punching is disabled.
3552 .It nat skinny_port Op Ar port
3555 which TCP port is used by the Skinny Station protocol.
3557 Cisco IP phones to communicate with Cisco Call Managers to setup voice
3559 The typical port used by Skinny is 2000.
3561 If no argument is given, skinny aliasing is disabled.
3562 .It nat same_ports yes|no
3563 When enabled, this command will tell the network address translation engine to
3564 attempt to avoid changing the port number on outgoing packets.
3566 if you want to support protocols such as RPC and LPD which require
3567 connections to come from a well known port.
3568 .It nat target Op Ar address
3569 Set the given target address or clear it if no address is given.
3570 The target address is used
3571 ifdef({LOCALNAT},{},{by libalias })dnl
3572 to specify how to NAT incoming packets by default.
3573 If a target address is not set or if
3575 is given, packets are not altered and are allowed to route to the internal
3578 The target address may be set to
3581 ifdef({LOCALNAT},{all packets will be redirected},
3582 {libalias will redirect all packets})
3583 to the interface address.
3584 .It nat use_sockets yes|no
3585 When enabled, this option tells the network address translation engine to
3586 create a socket so that it can guarantee a correct incoming ftp data or
3588 .It nat unregistered_only yes|no
3589 Only alter outgoing packets with an unregistered source address.
3590 According to RFC 1918, unregistered source addresses
3591 are 10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16.
3594 These commands are also discussed in the file
3596 which comes with the source distribution.
3603 is executed in the background with the following words replaced:
3604 .Bl -tag -width COMPILATIONDATE
3606 This is replaced with the local
3612 .It Li COMPILATIONDATE
3613 In previous software revisions, this was replaced with the date on which
3616 This is no longer supported as it breaks the ability to recompile the same
3617 code to produce an exact duplicate of a previous compilation.
3619 These are replaced with the primary and secondary nameserver IP numbers.
3620 If nameservers are negotiated by IPCP, the values of these macros will change.
3622 This is replaced with the local endpoint discriminator value.
3627 This is replaced with the peers IP number.
3629 This is replaced with the peers IPv6 number.
3631 This is replaced with the name of the interface that is in use.
3633 This is replaced with the number of IP bytes received since the connection
3636 This is replaced with the number of IP bytes sent since the connection
3639 This is replaced with the number of IP packets received since the connection
3642 This is replaced with the number of IP packets sent since the connection
3645 This is replaced with the number of IPv6 bytes received since the connection
3647 .It Li IPV6OCTETSOUT
3648 This is replaced with the number of IPv6 bytes sent since the connection
3650 .It Li IPV6PACKETSIN
3651 This is replaced with the number of IPv6 packets received since the connection
3653 .It Li IPV6PACKETSOUT
3654 This is replaced with the number of IPv6 packets sent since the connection
3657 This is replaced with the last label name used.
3658 A label may be specified on the
3660 command line, via the
3668 This is replaced with the IP number assigned to the local interface.
3670 This is replaced with the IPv6 number assigned to the local interface.
3672 This is replaced with the number of bytes received since the connection
3675 This is replaced with the number of bytes sent since the connection
3678 This is replaced with the number of packets received since the connection
3681 This is replaced with the number of packets sent since the connection
3684 This is replaced with the value of the peers endpoint discriminator.
3686 This is replaced with the current process id.
3688 This is replaced with the name of the diagnostic socket.
3690 This is replaced with the bundle uptime in HH:MM:SS format.
3692 This is replaced with the username that has been authenticated with PAP or
3694 Normally, this variable is assigned only in -direct mode.
3695 This value is available irrespective of whether utmp logging is enabled.
3697 This is replaced with the current version number of
3701 These substitutions are also done by the
3708 If you wish to pause
3710 while the command executes, use the
3713 .It clear physical|ipcp|ipv6 Op current|overall|peak...
3714 Clear the specified throughput values at either the
3722 is specified, context must be given (see the
3725 If no second argument is given, all values are cleared.
3726 .It clone Ar name Ns Xo
3727 .Op \&, Ns Ar name Ns
3730 Clone the specified link, creating one or more new links according to the
3733 This command must be used from the
3735 command below unless you have only got a single link (in which case that
3736 link becomes the default).
3737 Links may be removed using the
3741 The default link name is
3743 .It close Op lcp|ccp Ns Op !\&
3744 If no arguments are given, the relevant protocol layers will be brought
3745 down and the link will be closed.
3748 is specified, the LCP layer is brought down, but
3750 will not bring the link offline.
3751 It is subsequently possible to use
3754 to talk to the peer machine if, for example, something like
3759 is specified, only the relevant compression layer is closed.
3762 is used, the compression layer will remain in the closed state, otherwise
3763 it will re-enter the STOPPED state, waiting for the peer to initiate
3764 further CCP negotiation.
3765 In any event, this command does not disconnect the user from
3776 This command deletes the route with the given
3783 all non-direct entries in the routing table for the current interface,
3786 entries are deleted.
3791 the default route is deleted.
3799 will not complain if the route does not already exist.
3800 .It dial|call Oo Ar label Oc Ns Xo
3803 This command is the equivalent of
3807 and is provided for backwards compatibility.
3808 .It down Op Ar lcp|ccp
3809 Bring the relevant layer down ungracefully, as if the underlying layer
3810 had become unavailable.
3811 It is not considered polite to use this command on
3812 a Finite State Machine that is in the OPEN state.
3814 supplied, the entire link is closed (or if no context is given, all links
3820 layer is terminated but the device is not brought offline and the link
3824 is specified, only the relevant compression layer(s) are terminated.
3825 .It help|? Op Ar command
3826 Show a list of available commands.
3829 is specified, show the usage string for that command.
3830 .It ident Op Ar text Ns No ...
3831 Identify the link to the peer using
3835 is empty, link identification is disabled.
3836 It is possible to use any of the words described for the
3841 command for details of when
3843 identifies itself to the peer.
3844 .It iface Ar command Op args
3845 This command is used to control the interface used by
3848 may be one of the following:
3852 .Ar addr Ns Op / Ns Ar bits
3863 combination to the interface.
3864 Instead of specifying
3868 (with no space between it and
3870 If the given address already exists, the command fails unless the
3872 is used - in which case the previous interface address entry is overwritten
3873 with the new one, allowing a change of netmask or peer address.
3884 .Dq 255.255.255.255 .
3885 This address (the broadcast address) is the only duplicate peer address that
3888 .It iface clear Op INET | INET6
3889 If this command is used while
3891 is in the OPENED state or while in
3893 mode, all addresses except for the NCP negotiated address are deleted
3897 is not in the OPENED state and is not in
3899 mode, all interface addresses are deleted.
3901 If the INET or INET6 arguments are used, only addresses for that address
3904 .It iface delete Ns Xo
3909 This command deletes the given
3914 is used, no error is given if the address is not currently assigned to
3915 the interface (and no deletion takes place).
3916 .It iface name Ar name
3917 Renames the interface to
3919 .It iface description Ar description
3920 Sets the interface description to
3922 Useful if you have many interfaces on your system.
3924 Shows the current state and current addresses for the interface.
3925 It is much the same as running
3926 .Dq ifconfig INTERFACE .
3927 .It iface help Op Ar sub-command
3928 This command, when invoked without
3930 will show a list of possible
3932 sub-commands and a brief synopsis for each.
3935 only the synopsis for the given sub-command is shown.
3937 .It Oo data Oc Ns Xo
3939 .Ar name Ns Oo , Ns Ar name Oc Ns ... Ar command Op Ar args
3941 This command may prefix any other command if the user wishes to
3942 specify which link the command should affect.
3943 This is only applicable after multiple links have been created in Multi-link
3949 specifies the name of an existing link.
3952 is a comma separated list,
3954 is executed on each link.
3960 is executed on all links.
3961 .It load Oo Ar label Oc Ns Xo
3984 will not attempt to make an immediate connection.
3985 .It log Ar word Ns No ...
3986 Send the given word(s) to the log file with the prefix
3988 Word substitutions are done as explained under the
3991 .It open Op lcp|ccp|ipcp
3992 This is the opposite of the
3995 All closed links are immediately brought up apart from second and subsequent
3997 links - these will come up based on the
3999 command that has been used.
4003 argument is used while the LCP layer is already open, LCP will be
4005 This allows various LCP options to be changed, after which
4007 can be used to put them into effect.
4008 After renegotiating LCP,
4009 any agreed authentication will also take place.
4013 argument is used, the relevant compression layer is opened.
4014 Again, if it is already open, it will be renegotiated.
4018 argument is used, the link will be brought up as normal, but if
4019 IPCP is already open, it will be renegotiated and the network
4020 interface will be reconfigured.
4022 It is probably not good practice to re-open the PPP state machines
4023 like this as it is possible that the peer will not behave correctly.
4026 however useful as a way of forcing the CCP or VJ dictionaries to be reset.
4028 Specify the password required for access to the full
4031 This password is required when connecting to the diagnostic port (see the
4042 logging is active, instead, the literal string
4048 is executed from the controlling connection or from a command file,
4049 ppp will exit after closing all connections.
4050 Otherwise, if the user
4051 is connected to a diagnostic socket, the connection is simply dropped.
4057 will exit despite the source of the command after closing all existing
4060 This command removes the given link.
4061 It is only really useful in multi-link mode.
4062 A link must be in the
4064 state before it is removed.
4065 .It rename|mv Ar name
4066 This command renames the given link to
4070 is already used by another link.
4072 The default link name is
4079 may make the log file more readable.
4080 .It resolv Ar command
4081 This command controls
4088 starts up, it loads the contents of this file into memory and retains this
4089 image for future use.
4091 is one of the following:
4092 .Bl -tag -width readonly
4095 .Pa /etc/resolv.conf
4101 will still attempt to negotiate nameservers with the peer, making the results
4107 This is the opposite of the
4112 .Pa /etc/resolv.conf
4114 This may be necessary if for example a DHCP client overwrote
4115 .Pa /etc/resolv.conf .
4118 .Pa /etc/resolv.conf
4119 with the version originally read at startup or with the last
4122 This is sometimes a useful command to put in the
4123 .Pa /etc/ppp/ppp.linkdown
4127 .Pa /etc/resolv.conf
4129 This command will work even if the
4131 command has been used.
4132 It may be useful as a command in the
4133 .Pa /etc/ppp/ppp.linkup
4134 file if you wish to defer updating
4135 .Pa /etc/resolv.conf
4136 until after other commands have finished.
4141 .Pa /etc/resolv.conf
4146 successfully negotiates a DNS.
4147 This is the opposite of the
4152 This option is not (yet) implemented.
4156 to identify itself to the peer.
4157 The link must be in LCP state or higher.
4158 If no identity has been set (via the
4164 When an identity has been set,
4166 will automatically identify itself when it sends or receives a configure
4167 reject, when negotiation fails or when LCP reaches the opened state.
4169 Received identification packets are logged to the LCP log (see
4171 for details) and are never responded to.
4176 This option allows the setting of any of the following variables:
4178 .It set accmap Ar hex-value
4179 ACCMap stands for Asynchronous Control Character Map.
4181 negotiated with the peer, and defaults to a value of 00000000 in hex.
4182 This protocol is required to defeat hardware that depends on passing
4183 certain characters from end to end (such as XON/XOFF etc).
4185 For the XON/XOFF scenario, use
4186 .Dq set accmap 000a0000 .
4187 .It set Oo auth Oc Ns Xo
4190 This sets the authentication key (or password) used in client mode
4191 PAP or CHAP negotiation to the given value.
4192 It also specifies the
4193 password to be used in the dial or login scripts in place of the
4195 sequence, preventing the actual password from being logged.
4200 logging is in effect,
4204 for security reasons.
4206 If the first character of
4208 is an exclamation mark
4211 treats the remainder of the string as a program that must be executed
4223 it is treated as a single literal
4225 otherwise, ignoring the
4228 is parsed as a program to execute in the same was as the
4230 command above, substituting special names in the same manner.
4233 will feed the program three lines of input, each terminated by a newline
4237 The host name as sent in the CHAP challenge.
4239 The challenge string as sent in the CHAP challenge.
4245 Two lines of output are expected:
4250 to be sent with the CHAP response.
4254 which is encrypted with the challenge and request id, the answer being sent
4255 in the CHAP response packet.
4260 in this manner, it is expected that the host challenge is a series of ASCII
4261 digits or characters.
4262 An encryption device or Secure ID card is usually
4263 required to calculate the secret appropriate for the given challenge.
4264 .It set authname Ar id
4265 This sets the authentication id used in client mode PAP or CHAP negotiation.
4269 mode with CHAP enabled,
4271 is used in the initial authentication challenge and should normally be set to
4272 the local machine name.
4274 .Ar min-percent max-percent period
4276 These settings apply only in multi-link mode and default to zero, zero and
4282 mode link is available, only the first link is made active when
4284 first reads data from the tun device.
4287 link will be opened only when the current bundle throughput is at least
4289 percent of the total bundle bandwidth for
4292 When the current bundle throughput decreases to
4294 percent or less of the total bundle bandwidth for
4298 link will be brought down as long as it is not the last active link.
4300 Bundle throughput is measured as the maximum of inbound and outbound
4303 The default values cause
4305 links to simply come up one at a time.
4307 Certain devices cannot determine their physical bandwidth, so it
4308 is sometimes necessary to use the
4310 command (described below) to make
4313 .It set bandwidth Ar value
4314 This command sets the connection bandwidth in bits per second.
4316 must be greater than zero.
4317 It is currently only used by the
4320 .It set callback Ar option Ns No ...
4321 If no arguments are given, callback is disabled, otherwise,
4325 mode, will accept) one of the given
4326 .Ar option Ns No s .
4327 In client mode, if an
4331 will request a different
4333 until no options remain at which point
4335 will terminate negotiations (unless
4337 is one of the specified
4341 will accept any of the given protocols - but the client
4343 request one of them.
4344 If you wish callback to be optional, you must {include}
4350 are as follows (in this order of preference):
4353 The callee is expected to decide the callback number based on
4357 is the callee, the number should be specified as the fifth field of
4359 .Pa /etc/ppp/ppp.secret .
4361 Microsoft's callback control protocol is used.
4366 If you wish to negotiate
4368 in client mode but also wish to allow the server to request no callback at
4369 CBCP negotiation time, you must specify both
4373 as callback options.
4375 .Ar number Ns Op , Ns Ar number Ns
4378 The caller specifies the
4384 should be either a comma separated list of allowable numbers or a
4386 meaning any number is permitted.
4389 is the caller, only a single number should be specified.
4391 Note, this option is very unsafe when used with a
4393 as a malicious caller can tell
4395 to call any (possibly international) number without first authenticating
4398 If the peer does not wish to do callback at all,
4400 will accept the fact and continue without callback rather than terminating
4402 This is required (in addition to one or more other callback
4403 options) if you wish callback to be optional.
4407 .No *| Ns Ar number Ns Oo
4408 .No , Ns Ar number Ns ...\& Oc
4409 .Op Ar delay Op Ar retry
4411 If no arguments are given, CBCP (Microsoft's CallBack Control Protocol)
4412 is disabled - ie, configuring CBCP in the
4414 command will result in
4416 requesting no callback in the CBCP phase.
4419 attempts to use the given phone
4420 .Ar number Ns No (s).
4425 will insist that the client uses one of these numbers, unless
4427 is used in which case the client is expected to specify the number.
4431 will attempt to use one of the given numbers (whichever it finds to
4432 be agreeable with the peer), or if
4436 will expect the peer to specify the number.
4438 .No off| Ns Ar seconds Ns Op !\&
4442 checks for the existence of carrier depending on the type of device
4443 that has been opened:
4444 .Bl -tag -width XXX -offset XXX
4445 .It Terminal Devices
4446 Carrier is checked one second after the login script is complete.
4449 assumes that this is because the device does not support carrier (which
4452 NULL-modem cables), logs the fact and stops checking
4455 As ptys do not support the TIOCMGET ioctl, the tty device will switch all
4456 carrier detection off when it detects that the device is a pty.
4457 .It PPPoE (netgraph) Devices
4458 Carrier is checked once per second for 5 seconds.
4459 If it is not set after
4460 the fifth second, the connection attempt is considered to have failed and
4461 the device is closed.
4462 Carrier is always required for PPPoE devices.
4465 All other device types do not support carrier.
4466 Setting a carrier value will
4467 result in a warning when the device is opened.
4469 Some modems take more than one second after connecting to assert the carrier
4471 If this delay is not increased, this will result in
4473 inability to detect when the link is dropped, as
4475 assumes that the device is not asserting carrier.
4479 command overrides the default carrier behaviour.
4481 specifies the maximum number of seconds that
4483 should wait after the dial script has finished before deciding if
4484 carrier is available or not.
4490 will not check for carrier on the device, otherwise
4492 will not proceed to the login script until either carrier is detected
4495 has elapsed, at which point
4497 assumes that the device will not set carrier.
4499 If no arguments are given, carrier settings will go back to their default
4504 is followed immediately by an exclamation mark
4510 If carrier is not detected after
4512 seconds, the link will be disconnected.
4513 .It set choked Op Ar timeout
4514 This sets the number of seconds that
4516 will keep a choked output queue before dropping all pending output packets.
4519 is less than or equal to zero or if
4521 is not specified, it is set to the default value of
4524 A choked output queue occurs when
4526 has read a certain number of packets from the local network for transmission,
4527 but cannot send the data due to link failure (the peer is busy etc.).
4529 will not read packets indefinitely.
4530 Instead, it reads up to
4536 packets in multi-link mode), then stops reading the network interface
4539 seconds have passed or at least one packet has been sent.
4543 seconds pass, all pending output packets are dropped.
4544 .It set ctsrts|crtscts on|off
4545 This sets hardware flow control.
4546 Hardware flow control is
4549 .It set deflate Ar out-winsize Op Ar in-winsize
4550 This sets the DEFLATE algorithms default outgoing and incoming window
4556 must be values between
4564 will insist that this window size is used and will not accept any other
4565 values from the peer.
4566 .It set dns Op Ar primary Op Ar secondary
4567 This command specifies DNS overrides for the
4572 command description above for details.
4573 This command does not affect the IP numbers requested using
4575 .It set device|line Xo
4578 This sets the device(s) to which
4580 will talk to the given
4583 All serial device names are expected to begin with
4585 Serial devices are usually called
4592 it must either begin with an exclamation mark
4595 .No PPPoE: Ns Ar iface Ns Xo
4596 .Op \&: Ns Ar provider Ns
4600 enabled systems), or be of the format
4602 .Ar host : port Op /tcp|udp .
4605 If it begins with an exclamation mark, the rest of the device name is
4606 treated as a program name, and that program is executed when the device
4608 Standard input, output and error are fed back to
4610 and are read and written as if they were a regular device.
4613 .No PPPoE: Ns Ar iface Ns Xo
4614 .Op \&: Ns Ar provider Ns
4616 specification is given,
4618 will attempt to create a
4620 over Ethernet connection using the given
4628 will attempt to load it using
4630 If this fails, an external program must be used such as the
4632 program available under
4636 is passed as the service name in the PPPoE Discovery Initiation (PADI)
4638 If no provider is given, an empty value will be used.
4640 When a PPPoE connection is established,
4642 will place the name of the Access Concentrator in the environment variable
4649 for further details.
4652 .Ar host Ns No : Ns Ar port Ns Oo
4655 specification is given,
4657 will attempt to connect to the given
4665 suffix is not provided, the default is
4667 Refer to the section on
4668 .Em PPP OVER TCP and UDP
4669 above for further details.
4675 will attempt to open each one in turn until it succeeds or runs out of
4677 .It set dial Ar chat-script
4678 This specifies the chat script that will be used to dial the other
4685 and to the example configuration files for details of the chat script
4687 It is possible to specify some special
4689 in your chat script as follows:
4692 When used as the last character in a
4694 string, this indicates that a newline should not be appended.
4696 When the chat script encounters this sequence, it delays two seconds.
4698 When the chat script encounters this sequence, it delays for one quarter of
4701 This is replaced with a newline character.
4703 This is replaced with a carriage return character.
4705 This is replaced with a space character.
4707 This is replaced with a tab character.
4709 This is replaced by the current phone number (see
4713 This is replaced by the current
4719 This is replaced by the current
4726 Note that two parsers will examine these escape sequences, so in order to
4729 see the escape character, it is necessary to escape it from the
4730 .Sq command parser .
4731 This means that in practice you should use two escapes, for example:
4732 .Bd -literal -offset indent
4733 set dial "... ATDT\\\\T CONNECT"
4736 It is also possible to execute external commands from the chat script.
4737 To do this, the first character of the expect or send string is an
4740 If a literal exclamation mark is required, double it up to
4742 and it will be treated as a single literal
4744 When the command is executed, standard input and standard output are
4745 directed to the open device (see the
4747 command), and standard error is read by
4749 and substituted as the expect or send string.
4752 is running in interactive mode, file descriptor 3 is attached to
4755 For example (wrapped for readability):
4756 .Bd -literal -offset indent
4757 set login "TIMEOUT 5 \\"\\" \\"\\" login:--login: ppp \e
4758 word: ppp \\"!sh \\\\-c \\\\\\"echo \\\\-n label: >&2\\\\\\"\\" \e
4759 \\"!/bin/echo in\\" HELLO"
4762 would result in the following chat sequence (output using the
4763 .Sq set log local chat
4764 command before dialing):
4765 .Bd -literal -offset indent
4770 Chat: Expecting: login:--login:
4771 Chat: Wait for (5): login:
4773 Chat: Expecting: word:
4774 Chat: Wait for (5): word:
4776 Chat: Expecting: !sh \\-c "echo \\-n label: >&2"
4777 Chat: Exec: sh -c "echo -n label: >&2"
4778 Chat: Wait for (5): !sh \\-c "echo \\-n label: >&2" --> label:
4779 Chat: Exec: /bin/echo in
4781 Chat: Expecting: HELLO
4782 Chat: Wait for (5): HELLO
4786 Note (again) the use of the escape character, allowing many levels of
4788 Here, there are four parsers at work.
4789 The first parses the original line, reading it as three arguments.
4790 The second parses the third argument, reading it as 11 arguments.
4791 At this point, it is
4794 signs are escaped, otherwise this parser will see them as constituting
4795 an expect-send-expect sequence.
4798 character is seen, the execution parser reads the first command as three
4801 itself expands the argument after the
4803 As we wish to send the output back to the modem, in the first example
4804 we redirect our output to file descriptor 2 (stderr) so that
4806 itself sends and logs it, and in the second example, we just output to stdout,
4807 which is attached directly to the modem.
4809 This, of course means that it is possible to execute an entirely external
4811 command rather than using the internal one.
4814 for a good alternative.
4816 The external command that is executed is subjected to the same special
4817 word expansions as the
4820 .It set enddisc Op label|IP|MAC|magic|psn value
4821 This command sets our local endpoint discriminator.
4822 If set prior to LCP negotiation, and if no
4824 command has been used,
4826 will send the information to the peer using the LCP endpoint discriminator
4828 The following discriminators may be set:
4829 .Bl -tag -width indent
4831 The current label is used.
4833 Our local IP number is used.
4834 As LCP is negotiated prior to IPCP, it is
4835 possible that the IPCP layer will subsequently change this value.
4837 it does, the endpoint discriminator stays at the old value unless manually
4840 This is similar to the
4842 option above, except that the MAC address associated with the local IP
4844 If the local IP number is not resident on any Ethernet
4845 interface, the command will fail.
4847 As the local IP number defaults to whatever the machine host name is,
4849 is usually done prior to any
4853 A 20 digit random number is used.
4854 Care should be taken when using magic numbers as restarting
4856 or creating a link using a different
4858 invocation will also use a different magic number and will therefore not
4859 be recognised by the peer as belonging to the same bundle.
4860 This makes it unsuitable for
4868 should be set to an absolute public switched network number with the
4872 If no arguments are given, the endpoint discriminator is reset.
4873 .It set escape Ar value...
4874 This option is similar to the
4877 It allows the user to specify a set of characters that will be
4879 as they travel across the link.
4880 .It set filter dial|alive|in|out Ar rule-no Xo
4881 .No permit|deny|clear| Ns Ar rule-no
4884 .Ar src_addr Ns Op / Ns Ar width
4885 .Op Ar dst_addr Ns Op / Ns Ar width
4887 .Op src lt|eq|gt Ar port
4888 .Op dst lt|eq|gt Ar port
4892 .Op timeout Ar secs ]
4895 supports four filter sets.
4898 filter specifies packets that keep the connection alive - resetting the
4902 filter specifies packets that cause
4909 filter specifies packets that are allowed to travel
4910 into the machine and the
4912 filter specifies packets that are allowed out of the machine.
4914 Filtering is done prior to any IP alterations that might be done by the
4915 NAT engine on outgoing packets and after any IP alterations that might
4916 be done by the NAT engine on incoming packets.
4917 By default all empty filter sets allow all packets to pass.
4918 Rules are processed in order according to
4920 (unless skipped by specifying a rule number as the
4922 Up to 40 rules may be given for each set.
4923 If a packet does not match
4924 any of the rules in a given set, it is discarded.
4929 filters, this means that the packet is dropped.
4932 filters it means that the packet will not reset the idle timer (even if
4934 .Ar in Ns No / Ns Ar out
4937 value) and in the case of
4939 filters it means that the packet will not trigger a dial.
4940 A packet failing to trigger a dial will be dropped rather than queued.
4943 .Sx PACKET FILTERING
4944 above for further details.
4945 .It set hangup Ar chat-script
4946 This specifies the chat script that will be used to reset the device
4947 before it is closed.
4948 It should not normally be necessary, but can
4949 be used for devices that fail to reset themselves properly on close.
4950 .It set help|? Op Ar command
4951 This command gives a summary of available set commands, or if
4953 is specified, the command usage is shown.
4954 .It set ifaddr Oo Ar myaddr Ns
4956 .Oo Ar hisaddr Ns Op / Ns Ar \&nn
4961 This command specifies the IP addresses that will be used during
4963 Addresses are specified using the format
4969 is the preferred IP, but
4971 specifies how many bits of the address we will insist on.
4974 is omitted, it defaults to
4976 unless the IP address is 0.0.0.0 in which case it defaults to
4979 If you wish to assign a dynamic IP number to the peer,
4981 may also be specified as a range of IP numbers in the format
4982 .Bd -ragged -offset indent
4983 .Ar \&IP Ns Oo \&- Ns Ar \&IP Ns Oc Ns Oo , Ns Ar \&IP Ns
4984 .Oo \&- Ns Ar \&IP Ns Oc Oc Ns ...
4989 .Dl set ifaddr 10.0.0.1 10.0.1.2-10.0.1.10,10.0.1.20
4993 as the local IP number, but may assign any of the given 10 IP
4994 numbers to the peer.
4995 If the peer requests one of these numbers,
4996 and that number is not already in use,
4998 will grant the peers request.
4999 This is useful if the peer wants
5000 to re-establish a link using the same IP number as was previously
5001 allocated (thus maintaining any existing tcp or udp connections).
5003 If the peer requests an IP number that is either outside
5004 of this range or is already in use,
5006 will suggest a random unused IP number from the range.
5010 is specified, it is used in place of
5012 in the initial IPCP negotiation.
5013 However, only an address in the
5015 range will be accepted.
5016 This is useful when negotiating with some
5018 implementations that will not assign an IP number unless their peer
5022 It should be noted that in
5026 will configure the interface immediately upon reading the
5028 line in the config file.
5029 In any other mode, these values are just
5030 used for IPCP negotiations, and the interface is not configured
5031 until the IPCP layer is up.
5035 argument may be overridden by the third field in the
5037 file once the client has authenticated itself
5041 .Sx AUTHENTICATING INCOMING CONNECTIONS
5042 section for details.
5044 In all cases, if the interface is already configured,
5046 will try to maintain the interface IP numbers so that any existing
5047 bound sockets will remain valid.
5048 .It set ifqueue Ar packets
5049 Set the maximum number of packets that
5051 will read from the tunnel interface while data cannot be sent to any of
5052 the available links.
5053 This queue limit is necessary to flow control outgoing data as the tunnel
5054 interface is likely to be far faster than the combined links available to
5059 is set to a value less than the number of links,
5061 will read up to that value regardless.
5062 This prevents any possible latency problems.
5064 The default value for
5068 .It set ccpretry|ccpretries Oo Ar timeout
5069 .Op Ar reqtries Op Ar trmtries
5071 .It set chapretry|chapretries Oo Ar timeout
5074 .It set ipcpretry|ipcpretries Oo Ar timeout
5075 .Op Ar reqtries Op Ar trmtries
5077 .It set ipv6cpretry|ipv6cpretries Oo Ar timeout
5078 .Op Ar reqtries Op Ar trmtries
5080 .It set lcpretry|lcpretries Oo Ar timeout
5081 .Op Ar reqtries Op Ar trmtries
5083 .It set papretry|papretries Oo Ar timeout
5086 These commands set the number of seconds that
5088 will wait before resending Finite State Machine (FSM) Request packets.
5091 for all FSMs is 3 seconds (which should suffice in most cases).
5095 is specified, it tells
5097 how many configuration request attempts it should make while receiving
5098 no reply from the peer before giving up.
5099 The default is 5 attempts for
5100 CCP, LCP and IPCP and 3 attempts for PAP and CHAP.
5104 is specified, it tells
5106 how many terminate requests should be sent before giving up waiting for the
5108 The default is 3 attempts.
5109 Authentication protocols are
5110 not terminated and it is therefore invalid to specify
5114 In order to avoid negotiations with the peer that will never converge,
5116 will only send at most 3 times the configured number of
5118 in any given negotiation session before giving up and closing that layer.
5124 This command allows the adjustment of the current log level.
5125 Refer to the Logging Facility section for further details.
5126 .It set login Ar chat-script
5129 compliments the dial-script.
5130 If both are specified, the login
5131 script will be executed after the dial script.
5132 Escape sequences available in the dial script are also available here.
5133 .It set logout Ar chat-script
5134 This specifies the chat script that will be used to logout
5135 before the hangup script is called.
5136 It should not normally be necessary.
5137 .It set lqrperiod|echoperiod Ar frequency
5138 This command sets the
5145 The default is 30 seconds.
5146 You must also use the
5150 commands if you wish to send
5154 requests to the peer.
5155 .It set mode Ar interactive|auto|ddial|background
5156 This command allows you to change the
5158 of the specified link.
5159 This is normally only useful in multi-link mode,
5160 but may also be used in uni-link mode.
5162 It is not possible to change a link that is
5167 Note: If you issue the command
5169 and have network address translation enabled, it may be useful to
5170 .Dq enable iface-alias
5174 to do the necessary address translations to enable the process that
5175 triggers the connection to connect once the link is up despite the
5176 peer assigning us a new (dynamic) IP address.
5177 .It set mppe Op 40|56|128|* Op stateless|stateful|*
5178 This option selects the encryption parameters used when negotiation
5180 MPPE can be disabled entirely with the
5183 If no arguments are given,
5185 will attempt to negotiate a stateful link with a 128 bit key, but
5186 will agree to whatever the peer requests (including no encryption
5189 If any arguments are given,
5193 on using MPPE and will close the link if it is rejected by the peer (Note;
5194 this behaviour can be overridden by a configured RADIUS server).
5196 The first argument specifies the number of bits that
5198 should insist on during negotiations and the second specifies whether
5200 should insist on stateful or stateless mode.
5201 In stateless mode, the
5202 encryption dictionary is re-initialised with every packet according to
5203 an encryption key that is changed with every packet.
5205 the encryption dictionary is re-initialised every 256 packets or after
5206 the loss of any data and the key is changed every 256 packets.
5207 Stateless mode is less efficient but is better for unreliable transport
5209 .It set mrru Op Ar value
5210 Setting this option enables Multi-link PPP negotiations, also known as
5211 Multi-link Protocol or MP.
5212 There is no default MRRU (Maximum Reconstructed Receive Unit) value.
5213 If no argument is given, multi-link mode is disabled.
5218 The default MRU (Maximum Receive Unit) is 1500.
5219 If it is increased, the other side *may* increase its MTU.
5220 In theory there is no point in decreasing the MRU to below the default as the
5222 protocol says implementations *must* be able to accept packets of at
5229 will refuse to negotiate a higher value.
5230 The maximum MRU can be set to 2048 at most.
5231 Setting a maximum of less than 1500 violates the
5233 rfc, but may sometimes be necessary.
5236 imposes a maximum of 1492 due to hardware limitations.
5238 If no argument is given, 1500 is assumed.
5239 A value must be given when
5246 The default MTU is 1500.
5247 At negotiation time,
5249 will accept whatever MRU the peer requests (assuming it is
5250 not less than 296 bytes or greater than the assigned maximum).
5253 will not accept MRU values less than
5255 When negotiations are complete, the MTU is used when writing to the
5256 interface, even if the peer requested a higher value MRU.
5257 This can be useful for
5258 limiting your packet size (giving better bandwidth sharing at the expense
5259 of more header data).
5265 will refuse to negotiate a higher value.
5266 The maximum MTU can be set to 2048 at most.
5267 Note, it is necessary to use the
5269 keyword to limit the MTU when using PPPoE.
5273 is given, 1500, or whatever the peer asks for is used.
5274 A value must be given when
5277 .It set nbns Op Ar x.x.x.x Op Ar y.y.y.y
5278 This option allows the setting of the Microsoft NetBIOS name server
5279 values to be returned at the peers request.
5280 If no values are given,
5282 will reject any such requests.
5283 .It set openmode active|passive Op Ar delay
5292 will always initiate LCP/IPCP/CCP negotiation one second after the line
5294 If you want to wait for the peer to initiate negotiations, you
5297 If you want to initiate negotiations immediately or after more than one
5298 second, the appropriate
5300 may be specified here in seconds.
5301 .It set parity odd|even|none|mark
5302 This allows the line parity to be set.
5303 The default value is
5305 .It set phone Ar telno Ns Xo
5306 .Oo \&| Ns Ar backupnumber Oc Ns ... Ns Oo : Ns Ar nextnumber Oc Ns ... Xc
5307 This allows the specification of the phone number to be used in
5308 place of the \\\\T string in the dial and login chat scripts.
5309 Multiple phone numbers may be given separated either by a pipe
5314 Numbers after the pipe are only dialed if the dial or login
5315 script for the previous number failed.
5317 Numbers after the colon are tried sequentially, irrespective of
5318 the reason the line was dropped.
5320 If multiple numbers are given,
5322 will dial them according to these rules until a connection is made, retrying
5323 the maximum number of times specified by
5328 mode, each number is attempted at most once.
5329 .It set pppoe Op standard|3Com
5330 This option configures the underlying
5332 node to either standard RFC2516 PPPoE or proprietary 3Com mode.
5333 If not set the system default will be used.
5334 .It set Oo proc Oc Ns Xo
5335 .No title Op Ar value
5337 The current process title as displayed by
5339 is changed according to
5343 is not specified, the original process title is restored.
5345 word replacements done by the shell commands (see the
5347 command above) are done here too.
5349 Note, if USER is required in the process title, the
5351 command must appear in
5353 as it is not known when the commands in
5356 .It set radius Op Ar config-file
5357 This command enables RADIUS support (if it is compiled in).
5359 refers to the radius client configuration file as described in
5361 If PAP, CHAP, MSCHAP or MSCHAPv2 are
5362 .Dq enable Ns No d ,
5365 .Em \&N Ns No etwork
5368 and uses the configured RADIUS server to authenticate rather than
5369 authenticating from the
5371 file or from the passwd database.
5373 If none of PAP, CHAP, MSCHAP or MSCHAPv2 are enabled,
5378 uses the following attributes from the RADIUS reply:
5379 .Bl -tag -width XXX -offset XXX
5380 .It RAD_FRAMED_IP_ADDRESS
5381 The peer IP address is set to the given value.
5382 .It RAD_FRAMED_IP_NETMASK
5383 The tun interface netmask is set to the given value.
5385 If the given MTU is less than the peers MRU as agreed during LCP
5386 negotiation, *and* it is less that any configured MTU (see the
5388 command), the tun interface MTU is set to the given value.
5389 .It RAD_FRAMED_COMPRESSION
5390 If the received compression type is
5393 will request VJ compression during IPCP negotiations despite any
5395 configuration command.
5397 If this attribute is supplied,
5399 will attempt to use it as an additional label to load from the
5404 The load will be attempted before (and in addition to) the normal
5406 If the label does not exist, no action is taken and
5408 proceeds to the normal load using the current label.
5409 .It RAD_FRAMED_ROUTE
5410 The received string is expected to be in the format
5411 .Ar dest Ns Op / Ns Ar bits
5414 Any specified metrics are ignored.
5418 are understood as valid values for
5425 to sepcify the default route, and
5427 is understood to be the same as
5436 For example, a returned value of
5437 .Dq 1.2.3.4/24 0.0.0.0 1 2 -1 3 400
5438 would result in a routing table entry to the 1.2.3.0/24 network via
5440 and a returned value of
5444 would result in a default route to
5447 All RADIUS routes are applied after any sticky routes are applied, making
5448 RADIUS routes override configured routes.
5449 This also applies for RADIUS routes that do not {include} the
5455 .It RAD_FRAMED_IPV6_PREFIX
5456 If this attribute is supplied, the value is substituted for IPV6PREFIX
5458 You may pass it to an upper layer protocol such as DHCPv6 for delegating an
5459 IPv6 prefix to a peer.
5460 .It RAD_FRAMED_IPV6_ROUTE
5461 The received string is expected to be in the format
5462 .Ar dest Ns Op / Ns Ar bits
5465 Any specified metrics are ignored.
5469 are understood as valid values for
5476 to sepcify the default route, and
5478 is understood to be the same as
5487 For example, a returned value of
5488 .Dq 3ffe:505:abcd::/48 ::
5489 would result in a routing table entry to the 3ffe:505:abcd::/48 network via
5491 and a returned value of
5494 .Dq default HISADDR6
5495 would result in a default route to
5498 All RADIUS IPv6 routes are applied after any sticky routes are
5499 applied, making RADIUS IPv6 routes override configured routes.
5501 also applies for RADIUS IPv6 routes that do not {include} the
5507 .It RAD_SESSION_TIMEOUT
5508 If supplied, the client connection is closed after the given number of
5510 .It RAD_REPLY_MESSAGE
5511 If supplied, this message is passed back to the peer as the authentication
5513 .It RAD_MICROSOFT_MS_CHAP_ERROR
5515 .Dv RAD_VENDOR_MICROSOFT
5516 vendor specific attribute is supplied, it is passed back to the peer as the
5517 authentication FAILURE text.
5518 .It RAD_MICROSOFT_MS_CHAP2_SUCCESS
5520 .Dv RAD_VENDOR_MICROSOFT
5521 vendor specific attribute is supplied and if MS-CHAPv2 authentication is
5522 being used, it is passed back to the peer as the authentication SUCCESS text.
5523 .It RAD_MICROSOFT_MS_MPPE_ENCRYPTION_POLICY
5525 .Dv RAD_VENDOR_MICROSOFT
5526 vendor specific attribute is supplied and has a value of 2 (Required),
5528 will insist that MPPE encryption is used (even if no
5530 configuration command has been given with arguments).
5531 If it is supplied with a value of 1 (Allowed), encryption is made optional
5534 configuration commands with arguments).
5535 .It RAD_MICROSOFT_MS_MPPE_ENCRYPTION_TYPES
5537 .Dv RAD_VENDOR_MICROSOFT
5538 vendor specific attribute is supplied, bits 1 and 2 are examined.
5539 If either or both are set, 40 bit and/or 128 bit (respectively) encryption
5540 options are set, overriding any given first argument to the
5543 Note, it is not currently possible for the RADIUS server to specify 56 bit
5545 .It RAD_MICROSOFT_MS_MPPE_RECV_KEY
5547 .Dv RAD_VENDOR_MICROSOFT
5548 vendor specific attribute is supplied, it is value is used as the master
5549 key for decryption of incoming data.
5550 When clients are authenticated using
5551 MSCHAPv2, the RADIUS server MUST provide this attribute if inbound MPPE is
5553 .It RAD_MICROSOFT_MS_MPPE_SEND_KEY
5555 .Dv RAD_VENDOR_MICROSOFT
5556 vendor specific attribute is supplied, it is value is used as the master
5557 key for encryption of outgoing data.
5558 When clients are authenticated using
5559 MSCHAPv2, the RADIUS server MUST provide this attribute if outbound MPPE is
5563 Values received from the RADIUS server may be viewed using
5565 .It set rad_alive Ar timeout
5566 When RADIUS is configured, setting
5572 to sent RADIUS accounting information to the RADIUS server every
5575 .It set rad_port_id Ar option
5576 When RADIUS is configured, setting the
5578 value allows to specify what should be sent to the RADIUS server as
5585 PID of the corresponding tunnel.
5590 index of the interface as returned by
5591 .Xr if_nametoindex 3 .
5593 keeps the default behavior.
5595 .It set reconnect Ar timeout ntries
5596 Should the line drop unexpectedly (due to loss of CD or LQR
5597 failure), a connection will be re-established after the given
5599 The line will be re-connected at most
5608 will result in a variable pause, somewhere between 1 and 30 seconds.
5609 .It set recvpipe Op Ar value
5610 This sets the routing table RECVPIPE value.
5611 The optimum value is just over twice the MTU value.
5614 is unspecified or zero, the default kernel controlled value is used.
5615 .It set redial Ar secs Ns Xo
5617 .Oo - Ns Ar max Ns Oc Oc Ns
5622 can be instructed to attempt to redial
5625 If more than one phone number is specified (see
5629 is taken before dialing each number.
5632 is taken before starting at the first number again.
5635 may be used here in place of
5639 causing a random delay of between 1 and 30 seconds.
5643 is specified, its value is added onto
5649 will only be incremented at most
5657 delay will be effective, even after
5659 has been exceeded, so an immediate manual dial may appear to have
5661 If an immediate dial is required, a
5663 should immediately follow the
5668 description above for further details.
5669 .It set sendpipe Op Ar value
5670 This sets the routing table SENDPIPE value.
5671 The optimum value is just over twice the MTU value.
5674 is unspecified or zero, the default kernel controlled value is used.
5675 .It "set server|socket" Ar TcpPort Ns No \&| Ns Xo
5676 .Ar LocalName Ns No |none|open|closed
5677 .Op password Op Ar mask
5681 to listen on the given socket or
5683 for incoming command connections.
5689 to close any existing socket and clear the socket configuration.
5694 to attempt to re-open the port.
5699 to close the open port.
5701 If you wish to specify a local domain socket,
5703 must be specified as an absolute file name, otherwise it is assumed
5704 to be the name or number of a TCP port.
5705 You may specify the octal umask to be used with a local domain socket.
5711 for details of how to translate TCP port names.
5713 You must also specify the password that must be entered by the client
5716 variable above) when connecting to this socket.
5718 specified as an empty string, no password is required for connecting clients.
5720 When specifying a local domain socket, the first
5722 sequence found in the socket name will be replaced with the current
5723 interface unit number.
5724 This is useful when you wish to use the same
5725 profile for more than one connection.
5727 In a similar manner TCP sockets may be prefixed with the
5729 character, in which case the current interface unit number is added to
5734 with a server socket, the
5736 command is the preferred mechanism of communications.
5739 can also be used, but link encryption may be implemented in the future, so
5747 interact with the diagnostic socket.
5748 .It set speed Ar value
5749 This sets the speed of the serial device.
5750 If speed is specified as
5753 treats the device as a synchronous device.
5755 Certain device types will know whether they should be specified as
5756 synchronous or asynchronous.
5757 These devices will override incorrect
5758 settings and log a warning to this effect.
5759 .It set stopped Op Ar LCPseconds Op Ar CCPseconds
5760 If this option is set,
5762 will time out after the given FSM (Finite State Machine) has been in
5763 the stopped state for the given number of
5765 This option may be useful if the peer sends a terminate request,
5766 but never actually closes the connection despite our sending a terminate
5768 This is also useful if you wish to
5769 .Dq set openmode passive
5770 and time out if the peer does not send a Configure Request within the
5773 .Dq set log +lcp +ccp
5776 log the appropriate state transitions.
5778 The default value is zero, where
5780 does not time out in the stopped state.
5782 This value should not be set to less than the openmode delay (see
5785 .It set timeout Ar idleseconds Op Ar mintimeout
5786 This command allows the setting of the idle timer.
5787 Refer to the section titled
5788 .Sx SETTING THE IDLE TIMER
5789 for further details.
5795 will never idle out before the link has been up for at least that number
5803 This command controls the ports that
5805 prioritizes when transmitting data.
5806 The default priority TCP ports
5807 are ports 21 (ftp control), 22 (ssh), 23 (telnet), 513 (login), 514 (shell),
5808 543 (klogin) and 544 (kshell).
5809 There are no priority UDP ports by default.
5824 are given, the priority port lists are cleared (although if
5828 is specified, only that list is cleared).
5831 argument is prefixed with a plus
5835 the current list is adjusted, otherwise the list is reassigned.
5837 prefixed with a plus or not prefixed at all are added to the list and
5839 prefixed with a minus are removed from the list.
5843 is specified, all priority port lists are disabled and even
5845 packets are not prioritised.
5846 .It set vj slotcomp on|off
5849 whether it should attempt to negotiate VJ slot compression.
5850 By default, slot compression is turned
5852 .It set vj slots Ar nslots
5853 This command sets the initial number of slots that
5855 will try to negotiate with the peer when VJ compression is enabled (see the
5858 It defaults to a value of 16.
5867 .It shell|! Op Ar command
5870 is not specified a shell is invoked according to the
5872 environment variable.
5873 Otherwise, the given
5876 Word replacement is done in the same way as for the
5878 command as described above.
5880 Use of the !\& character
5881 requires a following space as with any of the other commands.
5882 You should note that this command is executed in the foreground;
5884 will not continue running until this process has exited.
5887 command if you wish processing to happen in the background.
5889 This command allows the user to examine the following:
5892 Show the current bundle settings.
5894 Show the current CCP compression statistics.
5896 Show the current VJ compression statistics.
5898 Show the current escape characters.
5899 .It show filter Op Ar name
5900 List the current rules for the given filter.
5903 is not specified, all filters are shown.
5905 Show the current HDLC statistics.
5907 Give a summary of available show commands.
5909 Show the current interface information
5913 Show the current IPCP statistics.
5915 Show the protocol layers currently in use.
5917 Show the current LCP statistics.
5918 .It show Oo data Oc Ns Xo
5921 Show high level link information.
5923 Show a list of available logical links.
5925 Show the current log values.
5927 Show current memory statistics.
5929 Show the current NCP statistics.
5931 Show low level link information.
5933 Show Multi-link information.
5935 Show current protocol totals.
5937 Show the current routing tables.
5939 Show the current stopped timeouts.
5941 Show the active alarm timers.
5943 Show the current version number of
5948 Go into terminal mode.
5949 Characters typed at the keyboard are sent to the device.
5950 Characters read from the device are displayed on the screen.
5955 automatically enables Packet Mode and goes back into command mode.
5960 Read the example configuration files.
5961 They are a good source of information.
5970 to get online information about what is available.
5972 The following URLs contain useful information:
5973 .Bl -bullet -compact
5975 http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/faq/ppp.html
5977 http://www.FreeBSD.org/doc/handbook/userppp.html
5983 refers to four files:
5989 These files are placed in the
5993 .It Pa /etc/ppp/ppp.conf
5994 System default configuration file.
5995 .It Pa /etc/ppp/ppp.secret
5996 An authorisation file for each system.
5997 .It Pa /etc/ppp/ppp.linkup
5998 A file to check when
6000 establishes a network level connection.
6001 .It Pa /etc/ppp/ppp.linkdown
6002 A file to check when
6004 closes a network level connection.
6005 .It Pa /var/log/ppp.log
6006 Logging and debugging information file.
6007 Note, this name is specified in
6008 .Pa /etc/syslog.conf .
6011 for further details.
6012 .It Pa /var/spool/lock/LCK..*
6013 tty port locking file.
6016 for further details.
6017 .It Pa /var/run/tunN.pid
6018 The process id (pid) of the
6020 program connected to the tunN device, where
6022 is the number of the device.
6023 .It Pa /var/run/ttyXX.if
6024 The tun interface used by this port.
6025 Again, this file is only created in
6031 .It Pa /etc/services
6032 Get port number if port number is using service name.
6033 .It Pa /var/run/ppp-authname-class-value
6034 In multi-link mode, local domain sockets are created using the peer
6037 the peer endpoint discriminator class
6039 and the peer endpoint discriminator value
6041 As the endpoint discriminator value may be a binary value, it is turned
6042 to HEX to determine the actual file name.
6044 This socket is used to pass links between different instances of
6058 ifdef({LOCALNAT},{},{.Xr libalias 3 ,
6060 ifdef({LOCALRAD},{},{.Xr libradius 3 ,
6088 This program was originally written by
6089 .An Toshiharu OHNO Aq tony-o@iij.ad.jp ,
6090 and was submitted to
6093 .An Atsushi Murai Aq amurai@spec.co.jp .
6095 It was substantially modified during 1997 by
6096 .An Brian Somers Aq brian@Awfulhak.org ,
6099 in November that year
6100 (just after the 2.2 release).
6102 Most of the code was rewritten by
6104 in early 1998 when multi-link ppp support was added.
projects / FreeBSD / FreeBSD.git / blob