2 * main.c - Point-to-Point Protocol main module
4 * Copyright (c) 1984-2000 Carnegie Mellon University. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * 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.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
18 * 3. The name "Carnegie Mellon University" must not be used to
19 * endorse or promote products derived from this software without
20 * prior written permission. For permission or any legal
21 * details, please contact
22 * Office of Technology Transfer
23 * Carnegie Mellon University
25 * Pittsburgh, PA 15213-3890
26 * (412) 268-4387, fax: (412) 268-7395
27 * tech-transfer@andrew.cmu.edu
29 * 4. Redistributions of any form whatsoever must retain the following
31 * "This product includes software developed by Computing Services
32 * at Carnegie Mellon University (http://www.cmu.edu/computing/)."
34 * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
35 * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
36 * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
37 * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
38 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
39 * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
40 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
42 * Copyright (c) 1999-2004 Paul Mackerras. All rights reserved.
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
48 * 1. Redistributions of source code must retain the above copyright
49 * notice, this list of conditions and the following disclaimer.
51 * 2. The name(s) of the authors of this software must not be used to
52 * endorse or promote products derived from this software without
53 * prior written permission.
55 * 3. Redistributions of any form whatsoever must retain the following
57 * "This product includes software developed by Paul Mackerras
58 * <paulus@samba.org>".
60 * THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
61 * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
62 * AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
63 * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
64 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
65 * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
66 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
69 #define RCSID "$Id: main.c,v 1.141 2004/11/04 10:02:26 paulus Exp $"
84 #include <sys/param.h>
85 #include <sys/types.h>
88 #include <sys/resource.h>
90 #include <sys/socket.h>
91 #include <netinet/in.h>
92 #include <arpa/inet.h>
103 #include "chap-new.h"
107 #include "pathnames.h"
119 #endif /* IPX_CHANGE */
124 static const char rcsid[] = RCSID;
127 char ifname[32]; /* Interface name */
128 int ifunit; /* Interface unit number */
130 struct channel *the_channel;
132 char *progname; /* Name of this program */
133 char hostname[MAXNAMELEN]; /* Our hostname */
134 static char pidfilename[MAXPATHLEN]; /* name of pid file */
135 static char linkpidfile[MAXPATHLEN]; /* name of linkname pid file */
136 char ppp_devnam[MAXPATHLEN]; /* name of PPP tty (maybe ttypx) */
137 uid_t uid; /* Our real user-id */
138 struct notifier *pidchange = NULL;
139 struct notifier *phasechange = NULL;
140 struct notifier *exitnotify = NULL;
141 struct notifier *sigreceived = NULL;
142 struct notifier *fork_notifier = NULL;
144 int hungup; /* terminal has been hung up */
145 int privileged; /* we're running as real uid root */
146 int need_holdoff; /* need holdoff period before restarting */
147 int detached; /* have detached from terminal */
148 volatile int status; /* exit status for pppd */
149 int unsuccess; /* # unsuccessful connection attempts */
150 int do_callback; /* != 0 if we should do callback next */
151 int doing_callback; /* != 0 if we are doing callback */
152 int ppp_session_number; /* Session number, for channels with such a
153 concept (eg PPPoE) */
154 int childwait_done; /* have timed out waiting for children */
157 TDB_CONTEXT *pppdb; /* database for storing status etc. */
162 int (*holdoff_hook) __P((void)) = NULL;
163 int (*new_phase_hook) __P((int)) = NULL;
164 void (*snoop_recv_hook) __P((unsigned char *p, int len)) = NULL;
165 void (*snoop_send_hook) __P((unsigned char *p, int len)) = NULL;
167 static int conn_running; /* we have a [dis]connector running */
168 static int devfd; /* fd of underlying device */
169 static int fd_ppp = -1; /* fd for talking PPP */
170 static int fd_loop; /* fd for getting demand-dial packets */
171 static int fd_devnull; /* fd for /dev/null */
173 int phase; /* where the link is at */
181 static sigset_t signals_handled;
183 static sigjmp_buf sigjmp;
185 char **script_env; /* Env. variable values for scripts */
186 int s_env_nalloc; /* # words avail at script_env */
188 u_char outpacket_buf[PPP_MRU+PPP_HDRLEN]; /* buffer for outgoing packet */
189 u_char inpacket_buf[PPP_MRU+PPP_HDRLEN]; /* buffer for incoming packet */
191 static int n_children; /* # child processes still running */
192 static int got_sigchld; /* set if we have received a SIGCHLD */
194 int privopen; /* don't lock, open device as root */
196 char *no_ppp_msg = "Sorry - this system lacks PPP kernel support\n";
198 GIDSET_TYPE groups[NGROUPS_MAX];/* groups the user is in */
199 int ngroups; /* How many groups valid in groups */
201 static struct timeval start_time; /* Time when link was started. */
203 static struct pppd_stats old_link_stats;
204 struct pppd_stats link_stats;
205 unsigned link_connect_time;
206 int link_stats_valid;
211 * We maintain a list of child process pids and
212 * functions to call when they exit.
217 void (*done) __P((void *));
219 struct subprocess *next;
222 static struct subprocess *children;
224 /* Prototypes for procedures local to this file. */
226 static void setup_signals __P((void));
227 static void create_pidfile __P((int pid));
228 static void create_linkpidfile __P((int pid));
229 static void cleanup __P((void));
230 static void get_input __P((void));
231 static void calltimeout __P((void));
232 static struct timeval *timeleft __P((struct timeval *));
233 static void kill_my_pg __P((int));
234 static void hup __P((int));
235 static void term __P((int));
236 static void chld __P((int));
237 static void toggle_debug __P((int));
238 static void open_ccp __P((int));
239 static void bad_signal __P((int));
240 static void holdoff_end __P((void *));
241 static int reap_kids __P((void));
242 static void childwait_end __P((void *));
245 static void update_db_entry __P((void));
246 static void add_db_key __P((const char *));
247 static void delete_db_key __P((const char *));
248 static void cleanup_db __P((void));
251 static void handle_events __P((void));
252 void print_link_stats __P((void));
254 extern char *ttyname __P((int));
255 extern char *getlogin __P((void));
256 int main __P((int, char *[]));
260 #define O_NONBLOCK O_NDELAY
264 #define setlogmask(x)
268 * PPP Data Link Layer "protocol" table.
269 * One entry per supported protocol.
270 * The last entry must be NULL.
272 struct protent *protocols[] = {
296 * If PPP_DRV_NAME is not defined, use the default "ppp" as the device name.
298 #if !defined(PPP_DRV_NAME)
299 #define PPP_DRV_NAME "ppp"
300 #endif /* !defined(PPP_DRV_NAME) */
310 struct protent *protp;
313 link_stats_valid = 0;
314 new_phase(PHASE_INITIALIZE);
318 /* Initialize syslog facilities */
321 if (gethostname(hostname, MAXNAMELEN) < 0 ) {
322 option_error("Couldn't get hostname: %m");
325 hostname[MAXNAMELEN-1] = 0;
327 /* make sure we don't create world or group writable files. */
328 umask(umask(0777) | 022);
331 privileged = uid == 0;
332 slprintf(numbuf, sizeof(numbuf), "%d", uid);
333 script_setenv("ORIG_UID", numbuf, 0);
335 ngroups = getgroups(NGROUPS_MAX, groups);
338 * Initialize magic number generator now so that protocols may
339 * use magic numbers in initialization.
344 * Initialize each protocol.
346 for (i = 0; (protp = protocols[i]) != NULL; ++i)
350 * Initialize the default channel.
357 * Parse, in order, the system options file, the user's options file,
358 * and the command line arguments.
360 if (!options_from_file(_PATH_SYSOPTIONS, !privileged, 0, 1)
361 || !options_from_user()
362 || !parse_args(argc-1, argv+1))
363 exit(EXIT_OPTION_ERROR);
364 devnam_fixed = 1; /* can no longer change device name */
367 * Work out the device name, if it hasn't already been specified,
368 * and parse the tty's options file.
370 if (the_channel->process_extra_options)
371 (*the_channel->process_extra_options)();
374 setlogmask(LOG_UPTO(LOG_DEBUG));
377 * Check that we are running as root.
379 if (geteuid() != 0) {
380 option_error("must be root to run %s, since it is not setuid-root",
385 if (!ppp_available()) {
386 option_error("%s", no_ppp_msg);
387 exit(EXIT_NO_KERNEL_SUPPORT);
391 * Check that the options given are valid and consistent.
394 if (!sys_check_options())
395 exit(EXIT_OPTION_ERROR);
396 auth_check_options();
397 #ifdef HAVE_MULTILINK
400 for (i = 0; (protp = protocols[i]) != NULL; ++i)
401 if (protp->check_options != NULL)
402 (*protp->check_options)();
403 if (the_channel->check_options)
404 (*the_channel->check_options)();
407 if (dump_options || dryrun) {
408 init_pr_log(NULL, LOG_INFO);
409 print_options(pr_log, NULL);
417 * Initialize system-dependent stuff.
421 /* Make sure fds 0, 1, 2 are open to somewhere. */
422 fd_devnull = open(_PATH_DEVNULL, O_RDWR);
424 fatal("Couldn't open %s: %m", _PATH_DEVNULL);
425 while (fd_devnull <= 2) {
428 fatal("Critical shortage of file descriptors: dup failed: %m");
433 pppdb = tdb_open(_PATH_PPPDB, 0, 0, O_RDWR|O_CREAT, 0644);
435 slprintf(db_key, sizeof(db_key), "pppd%d", getpid());
438 warn("Warning: couldn't open ppp database %s", _PATH_PPPDB);
440 warn("Warning: disabling multilink");
447 * Detach ourselves from the terminal, if required,
448 * and identify who is running us.
450 if (!nodetach && !updetach)
455 if (pw != NULL && pw->pw_name != NULL)
460 syslog(LOG_NOTICE, "pppd %s started by %s, uid %d", VERSION, p, uid);
461 script_setenv("PPPLOGNAME", p, 0);
464 script_setenv("DEVICE", devnam, 1);
465 slprintf(numbuf, sizeof(numbuf), "%d", getpid());
466 script_setenv("PPPD_PID", numbuf, 1);
473 * If we're doing dial-on-demand, set up the interface now.
477 * Open the loopback channel and set it up to be the ppp interface.
480 tdb_writelock(pppdb);
482 fd_loop = open_ppp_loopback();
485 tdb_writeunlock(pppdb);
488 * Configure the interface and mark it up, etc.
491 create_linkpidfile(getpid());
502 doing_callback = do_callback;
505 if (demand && !doing_callback) {
507 * Don't do anything until we see some activity.
509 new_phase(PHASE_DORMANT);
514 if (kill_link && !persist)
516 if (get_loop_output())
520 if (kill_link && !persist)
524 * Now we want to bring up the link.
527 info("Starting link");
530 new_phase(PHASE_SERIALCONN);
532 devfd = the_channel->connect();
536 /* set up the serial device as a ppp interface */
538 tdb_writelock(pppdb);
540 fd_ppp = the_channel->establish_ppp(devfd);
543 tdb_writeunlock(pppdb);
545 status = EXIT_FATAL_ERROR;
548 /* create the pid file, now that we've obtained a ppp interface */
550 create_linkpidfile(getpid());
552 if (!demand && ifunit >= 0)
555 tdb_writeunlock(pppdb);
559 * Start opening the connection and wait for
560 * incoming events (reply, timeout, etc.).
563 notice("Connect: %s <--> %s", ifname, ppp_devnam);
565 notice("Starting negotiation on %s", ppp_devnam);
566 gettimeofday(&start_time, NULL);
567 script_unsetenv("CONNECT_TIME");
568 script_unsetenv("BYTES_SENT");
569 script_unsetenv("BYTES_RCVD");
573 lcp_open(0); /* Start protocol */
574 status = EXIT_NEGOTIATION_FAILED;
575 new_phase(PHASE_ESTABLISH);
576 while (phase != PHASE_DEAD) {
580 lcp_close(0, "User request");
582 if (phase == PHASE_NETWORK || phase == PHASE_RUNNING) {
583 ccp_fsm[0].flags = OPT_RESTART; /* clears OPT_SILENT */
584 (*ccp_protent.open)(0);
592 * Delete pid file before disestablishing ppp. Otherwise it
593 * can happen that another pppd gets the same unit and then
594 * we delete its pid file.
597 if (pidfilename[0] != 0
598 && unlink(pidfilename) < 0 && errno != ENOENT)
599 warn("unable to delete pid file %s: %m", pidfilename);
604 * If we may want to bring the link up again, transfer
605 * the ppp unit back to the loopback. Set the
606 * real serial device back to its normal mode of operation.
610 the_channel->disestablish_ppp(devfd);
615 script_unsetenv("IFNAME");
618 * Run disconnector script, if requested.
619 * XXX we may not be able to do this if the line has hung up!
622 new_phase(PHASE_DISCONNECT);
623 if (the_channel->disconnect)
624 the_channel->disconnect();
627 if (the_channel->cleanup)
628 (*the_channel->cleanup)();
631 if (pidfilename[0] != 0
632 && unlink(pidfilename) < 0 && errno != ENOENT)
633 warn("unable to delete pid file %s: %m", pidfilename);
637 if (!persist || (maxfail > 0 && unsuccess >= maxfail))
642 t = need_holdoff? holdoff: 0;
644 t = (*holdoff_hook)();
646 new_phase(PHASE_HOLDOFF);
647 TIMEOUT(holdoff_end, NULL, t);
651 new_phase(PHASE_DORMANT); /* allow signal to end holdoff */
652 } while (phase == PHASE_HOLDOFF);
658 /* Wait for scripts to finish */
660 if (n_children > 0) {
662 TIMEOUT(childwait_end, NULL, child_wait);
664 struct subprocess *chp;
665 dbglog("Waiting for %d child processes...", n_children);
666 for (chp = children; chp != NULL; chp = chp->next)
667 dbglog(" script %s, pid %d", chp->prog, chp->pid);
669 while (n_children > 0 && !childwait_done) {
671 if (kill_link && !childwait_done)
681 * handle_events - wait for something to happen and respond to it.
688 kill_link = open_ccp_flag = 0;
689 if (sigsetjmp(sigjmp, 1) == 0) {
690 sigprocmask(SIG_BLOCK, &signals_handled, NULL);
691 if (got_sighup || got_sigterm || got_sigusr2 || got_sigchld) {
692 sigprocmask(SIG_UNBLOCK, &signals_handled, NULL);
695 sigprocmask(SIG_UNBLOCK, &signals_handled, NULL);
696 wait_input(timeleft(&timo));
702 info("Hangup (SIGHUP)");
705 if (status != EXIT_HANGUP)
706 status = EXIT_USER_REQUEST;
709 info("Terminating on signal %d", got_sigterm);
712 status = EXIT_USER_REQUEST;
717 reap_kids(); /* Don't leave dead kids lying around */
726 * setup_signals - initialize signal handling.
734 * Compute mask of all interesting signals and install signal handlers
735 * for each. Only one signal handler may be active at a time. Therefore,
736 * all other signals should be masked when any handler is executing.
738 sigemptyset(&signals_handled);
739 sigaddset(&signals_handled, SIGHUP);
740 sigaddset(&signals_handled, SIGINT);
741 sigaddset(&signals_handled, SIGTERM);
742 sigaddset(&signals_handled, SIGCHLD);
743 sigaddset(&signals_handled, SIGUSR2);
745 #define SIGNAL(s, handler) do { \
746 sa.sa_handler = handler; \
747 if (sigaction(s, &sa, NULL) < 0) \
748 fatal("Couldn't establish signal handler (%d): %m", s); \
751 sa.sa_mask = signals_handled;
753 SIGNAL(SIGHUP, hup); /* Hangup */
754 SIGNAL(SIGINT, term); /* Interrupt */
755 SIGNAL(SIGTERM, term); /* Terminate */
756 SIGNAL(SIGCHLD, chld);
758 SIGNAL(SIGUSR1, toggle_debug); /* Toggle debug flag */
759 SIGNAL(SIGUSR2, open_ccp); /* Reopen CCP */
762 * Install a handler for other signals which would otherwise
763 * cause pppd to exit without cleaning up.
765 SIGNAL(SIGABRT, bad_signal);
766 SIGNAL(SIGALRM, bad_signal);
767 SIGNAL(SIGFPE, bad_signal);
768 SIGNAL(SIGILL, bad_signal);
769 SIGNAL(SIGPIPE, bad_signal);
770 SIGNAL(SIGQUIT, bad_signal);
771 SIGNAL(SIGSEGV, bad_signal);
773 SIGNAL(SIGBUS, bad_signal);
776 SIGNAL(SIGEMT, bad_signal);
779 SIGNAL(SIGPOLL, bad_signal);
782 SIGNAL(SIGPROF, bad_signal);
785 SIGNAL(SIGSYS, bad_signal);
788 SIGNAL(SIGTRAP, bad_signal);
791 SIGNAL(SIGVTALRM, bad_signal);
794 SIGNAL(SIGXCPU, bad_signal);
797 SIGNAL(SIGXFSZ, bad_signal);
801 * Apparently we can get a SIGPIPE when we call syslog, if
802 * syslogd has died and been restarted. Ignoring it seems
805 signal(SIGPIPE, SIG_IGN);
809 * set_ifunit - do things we need to do once we know which ppp
816 info("Using interface %s%d", PPP_DRV_NAME, ifunit);
817 slprintf(ifname, sizeof(ifname), "%s%d", PPP_DRV_NAME, ifunit);
818 script_setenv("IFNAME", ifname, iskey);
820 create_pidfile(getpid()); /* write pid to file */
821 create_linkpidfile(getpid());
826 * detach - detach us from the controlling terminal.
837 if (pipe(pipefd) == -1)
838 pipefd[0] = pipefd[1] = -1;
839 if ((pid = fork()) < 0) {
840 error("Couldn't detach (fork failed: %m)");
841 die(1); /* or just return? */
845 notify(pidchange, pid);
846 /* update pid files if they have been written already */
850 create_linkpidfile(pid);
851 exit(0); /* parent dies */
861 slprintf(numbuf, sizeof(numbuf), "%d", getpid());
862 script_setenv("PPPD_PID", numbuf, 1);
864 /* wait for parent to finish updating pid & lock files and die */
866 complete_read(pipefd[0], numbuf, 1);
871 * reopen_log - (re)open our connection to syslog.
877 openlog("pppd", LOG_PID);
879 openlog("pppd", LOG_PID | LOG_NDELAY, LOG_PPP);
880 setlogmask(LOG_UPTO(LOG_INFO));
885 * Create a file containing our process ID.
893 slprintf(pidfilename, sizeof(pidfilename), "%s%s.pid",
894 _PATH_VARRUN, ifname);
895 if ((pidfile = fopen(pidfilename, "w")) != NULL) {
896 fprintf(pidfile, "%d\n", pid);
897 (void) fclose(pidfile);
899 error("Failed to create pid file %s: %m", pidfilename);
905 create_linkpidfile(pid)
910 if (linkname[0] == 0)
912 script_setenv("LINKNAME", linkname, 1);
913 slprintf(linkpidfile, sizeof(linkpidfile), "%sppp-%s.pid",
914 _PATH_VARRUN, linkname);
915 if ((pidfile = fopen(linkpidfile, "w")) != NULL) {
916 fprintf(pidfile, "%d\n", pid);
918 fprintf(pidfile, "%s\n", ifname);
919 (void) fclose(pidfile);
921 error("Failed to create pid file %s: %m", linkpidfile);
927 * holdoff_end - called via a timeout when the holdoff period ends.
933 new_phase(PHASE_DORMANT);
936 /* List of protocol names, to make our messages a little more informative. */
937 struct protocol_list {
940 } protocol_list[] = {
942 { 0x23, "OSI Network Layer" },
943 { 0x25, "Xerox NS IDP" },
944 { 0x27, "DECnet Phase IV" },
945 { 0x29, "Appletalk" },
946 { 0x2b, "Novell IPX" },
947 { 0x2d, "VJ compressed TCP/IP" },
948 { 0x2f, "VJ uncompressed TCP/IP" },
949 { 0x31, "Bridging PDU" },
950 { 0x33, "Stream Protocol ST-II" },
951 { 0x35, "Banyan Vines" },
952 { 0x39, "AppleTalk EDDP" },
953 { 0x3b, "AppleTalk SmartBuffered" },
954 { 0x3d, "Multi-Link" },
955 { 0x3f, "NETBIOS Framing" },
956 { 0x41, "Cisco Systems" },
957 { 0x43, "Ascom Timeplex" },
958 { 0x45, "Fujitsu Link Backup and Load Balancing (LBLB)" },
959 { 0x47, "DCA Remote Lan" },
960 { 0x49, "Serial Data Transport Protocol (PPP-SDTP)" },
961 { 0x4b, "SNA over 802.2" },
963 { 0x4f, "IP6 Header Compression" },
964 { 0x6f, "Stampede Bridging" },
965 { 0xfb, "single-link compression" },
966 { 0xfd, "1st choice compression" },
967 { 0x0201, "802.1d Hello Packets" },
968 { 0x0203, "IBM Source Routing BPDU" },
969 { 0x0205, "DEC LANBridge100 Spanning Tree" },
970 { 0x0231, "Luxcom" },
971 { 0x0233, "Sigma Network Systems" },
972 { 0x8021, "Internet Protocol Control Protocol" },
973 { 0x8023, "OSI Network Layer Control Protocol" },
974 { 0x8025, "Xerox NS IDP Control Protocol" },
975 { 0x8027, "DECnet Phase IV Control Protocol" },
976 { 0x8029, "Appletalk Control Protocol" },
977 { 0x802b, "Novell IPX Control Protocol" },
978 { 0x8031, "Bridging NCP" },
979 { 0x8033, "Stream Protocol Control Protocol" },
980 { 0x8035, "Banyan Vines Control Protocol" },
981 { 0x803d, "Multi-Link Control Protocol" },
982 { 0x803f, "NETBIOS Framing Control Protocol" },
983 { 0x8041, "Cisco Systems Control Protocol" },
984 { 0x8043, "Ascom Timeplex" },
985 { 0x8045, "Fujitsu LBLB Control Protocol" },
986 { 0x8047, "DCA Remote Lan Network Control Protocol (RLNCP)" },
987 { 0x8049, "Serial Data Control Protocol (PPP-SDCP)" },
988 { 0x804b, "SNA over 802.2 Control Protocol" },
989 { 0x804d, "SNA Control Protocol" },
990 { 0x804f, "IP6 Header Compression Control Protocol" },
991 { 0x006f, "Stampede Bridging Control Protocol" },
992 { 0x80fb, "Single Link Compression Control Protocol" },
993 { 0x80fd, "Compression Control Protocol" },
994 { 0xc021, "Link Control Protocol" },
995 { 0xc023, "Password Authentication Protocol" },
996 { 0xc025, "Link Quality Report" },
997 { 0xc027, "Shiva Password Authentication Protocol" },
998 { 0xc029, "CallBack Control Protocol (CBCP)" },
999 { 0xc081, "Container Control Protocol" },
1000 { 0xc223, "Challenge Handshake Authentication Protocol" },
1001 { 0xc281, "Proprietary Authentication Protocol" },
1006 * protocol_name - find a name for a PPP protocol.
1009 protocol_name(proto)
1012 struct protocol_list *lp;
1014 for (lp = protocol_list; lp->proto != 0; ++lp)
1015 if (proto == lp->proto)
1021 * get_input - called when incoming data is available.
1029 struct protent *protp;
1031 p = inpacket_buf; /* point to beginning of packet buffer */
1033 len = read_packet(inpacket_buf);
1038 notice("Modem hangup");
1040 status = EXIT_HANGUP;
1041 lcp_lowerdown(0); /* serial link is no longer available */
1046 if (len < PPP_HDRLEN) {
1047 dbglog("received short packet:%.*B", len, p);
1051 dump_packet("rcvd", p, len);
1052 if (snoop_recv_hook) snoop_recv_hook(p, len);
1054 p += 2; /* Skip address and control */
1055 GETSHORT(protocol, p);
1059 * Toss all non-LCP packets unless LCP is OPEN.
1061 if (protocol != PPP_LCP && lcp_fsm[0].state != OPENED) {
1062 dbglog("Discarded non-LCP packet when LCP not open");
1067 * Until we get past the authentication phase, toss all packets
1068 * except LCP, LQR and authentication packets.
1070 if (phase <= PHASE_AUTHENTICATE
1071 && !(protocol == PPP_LCP || protocol == PPP_LQR
1072 || protocol == PPP_PAP || protocol == PPP_CHAP ||
1073 protocol == PPP_EAP)) {
1074 dbglog("discarding proto 0x%x in phase %d",
1080 * Upcall the proper protocol input routine.
1082 for (i = 0; (protp = protocols[i]) != NULL; ++i) {
1083 if (protp->protocol == protocol && protp->enabled_flag) {
1084 (*protp->input)(0, p, len);
1087 if (protocol == (protp->protocol & ~0x8000) && protp->enabled_flag
1088 && protp->datainput != NULL) {
1089 (*protp->datainput)(0, p, len);
1095 const char *pname = protocol_name(protocol);
1097 warn("Unsupported protocol '%s' (0x%x) received", pname, protocol);
1099 warn("Unsupported protocol 0x%x received", protocol);
1101 lcp_sprotrej(0, p - PPP_HDRLEN, len + PPP_HDRLEN);
1105 * ppp_send_config - configure the transmit-side characteristics of
1106 * the ppp interface. Returns -1, indicating an error, if the channel
1107 * send_config procedure called error() (or incremented error_count
1108 * itself), otherwise 0.
1111 ppp_send_config(unit, mtu, accm, pcomp, accomp)
1118 if (the_channel->send_config == NULL)
1121 (*the_channel->send_config)(mtu, accm, pcomp, accomp);
1122 return (error_count != errs)? -1: 0;
1126 * ppp_recv_config - configure the receive-side characteristics of
1127 * the ppp interface. Returns -1, indicating an error, if the channel
1128 * recv_config procedure called error() (or incremented error_count
1129 * itself), otherwise 0.
1132 ppp_recv_config(unit, mru, accm, pcomp, accomp)
1139 if (the_channel->recv_config == NULL)
1142 (*the_channel->recv_config)(mru, accm, pcomp, accomp);
1143 return (error_count != errs)? -1: 0;
1147 * new_phase - signal the start of a new phase of pppd's operation.
1155 (*new_phase_hook)(p);
1156 notify(phasechange, p);
1160 * die - clean up state and exit with the specified status.
1168 notify(exitnotify, status);
1169 syslog(LOG_INFO, "Exit.");
1174 * cleanup - restore anything which needs to be restored before we exit
1183 the_channel->disestablish_ppp(devfd);
1184 if (the_channel->cleanup)
1185 (*the_channel->cleanup)();
1187 if (pidfilename[0] != 0 && unlink(pidfilename) < 0 && errno != ENOENT)
1188 warn("unable to delete pid file %s: %m", pidfilename);
1190 if (linkpidfile[0] != 0 && unlink(linkpidfile) < 0 && errno != ENOENT)
1191 warn("unable to delete pid file %s: %m", linkpidfile);
1205 * Print connect time and statistics.
1207 if (link_stats_valid) {
1208 int t = (link_connect_time + 5) / 6; /* 1/10ths of minutes */
1209 info("Connect time %d.%d minutes.", t/10, t%10);
1210 info("Sent %u bytes, received %u bytes.",
1211 link_stats.bytes_out, link_stats.bytes_in);
1212 link_stats_valid = 0;
1217 * reset_link_stats - "reset" stats when link goes up.
1223 if (!get_ppp_stats(u, &old_link_stats))
1225 gettimeofday(&start_time, NULL);
1229 * update_link_stats - get stats at link termination.
1232 update_link_stats(u)
1238 if (!get_ppp_stats(u, &link_stats)
1239 || gettimeofday(&now, NULL) < 0)
1241 link_connect_time = now.tv_sec - start_time.tv_sec;
1242 link_stats_valid = 1;
1244 link_stats.bytes_in -= old_link_stats.bytes_in;
1245 link_stats.bytes_out -= old_link_stats.bytes_out;
1246 link_stats.pkts_in -= old_link_stats.pkts_in;
1247 link_stats.pkts_out -= old_link_stats.pkts_out;
1249 slprintf(numbuf, sizeof(numbuf), "%u", link_connect_time);
1250 script_setenv("CONNECT_TIME", numbuf, 0);
1251 slprintf(numbuf, sizeof(numbuf), "%u", link_stats.bytes_out);
1252 script_setenv("BYTES_SENT", numbuf, 0);
1253 slprintf(numbuf, sizeof(numbuf), "%u", link_stats.bytes_in);
1254 script_setenv("BYTES_RCVD", numbuf, 0);
1259 struct timeval c_time; /* time at which to call routine */
1260 void *c_arg; /* argument to routine */
1261 void (*c_func) __P((void *)); /* routine */
1262 struct callout *c_next;
1265 static struct callout *callout = NULL; /* Callout list */
1266 static struct timeval timenow; /* Current time */
1269 * timeout - Schedule a timeout.
1272 timeout(func, arg, secs, usecs)
1273 void (*func) __P((void *));
1277 struct callout *newp, *p, **pp;
1279 MAINDEBUG(("Timeout %p:%p in %d.%03d seconds.", func, arg,
1285 if ((newp = (struct callout *) malloc(sizeof(struct callout))) == NULL)
1286 fatal("Out of memory in timeout()!");
1288 newp->c_func = func;
1289 gettimeofday(&timenow, NULL);
1290 newp->c_time.tv_sec = timenow.tv_sec + secs;
1291 newp->c_time.tv_usec = timenow.tv_usec + usecs;
1292 if (newp->c_time.tv_usec >= 1000000) {
1293 newp->c_time.tv_sec += newp->c_time.tv_usec / 1000000;
1294 newp->c_time.tv_usec %= 1000000;
1298 * Find correct place and link it in.
1300 for (pp = &callout; (p = *pp); pp = &p->c_next)
1301 if (newp->c_time.tv_sec < p->c_time.tv_sec
1302 || (newp->c_time.tv_sec == p->c_time.tv_sec
1303 && newp->c_time.tv_usec < p->c_time.tv_usec))
1311 * untimeout - Unschedule a timeout.
1314 untimeout(func, arg)
1315 void (*func) __P((void *));
1318 struct callout **copp, *freep;
1320 MAINDEBUG(("Untimeout %p:%p.", func, arg));
1323 * Find first matching timeout and remove it from the list.
1325 for (copp = &callout; (freep = *copp); copp = &freep->c_next)
1326 if (freep->c_func == func && freep->c_arg == arg) {
1327 *copp = freep->c_next;
1328 free((char *) freep);
1335 * calltimeout - Call any timeout routines which are now due.
1342 while (callout != NULL) {
1345 if (gettimeofday(&timenow, NULL) < 0)
1346 fatal("Failed to get time of day: %m");
1347 if (!(p->c_time.tv_sec < timenow.tv_sec
1348 || (p->c_time.tv_sec == timenow.tv_sec
1349 && p->c_time.tv_usec <= timenow.tv_usec)))
1350 break; /* no, it's not time yet */
1352 callout = p->c_next;
1353 (*p->c_func)(p->c_arg);
1361 * timeleft - return the length of time until the next timeout is due.
1363 static struct timeval *
1365 struct timeval *tvp;
1367 if (callout == NULL)
1370 gettimeofday(&timenow, NULL);
1371 tvp->tv_sec = callout->c_time.tv_sec - timenow.tv_sec;
1372 tvp->tv_usec = callout->c_time.tv_usec - timenow.tv_usec;
1373 if (tvp->tv_usec < 0) {
1374 tvp->tv_usec += 1000000;
1377 if (tvp->tv_sec < 0)
1378 tvp->tv_sec = tvp->tv_usec = 0;
1385 * kill_my_pg - send a signal to our process group, and ignore it ourselves.
1386 * We assume that sig is currently blocked.
1392 struct sigaction act, oldact;
1394 sigemptyset(&act.sa_mask); /* unnecessary in fact */
1395 act.sa_handler = SIG_IGN;
1399 * The kill() above made the signal pending for us, as well as
1400 * the rest of our process group, but we don't want it delivered
1401 * to us. It is blocked at the moment. Setting it to be ignored
1402 * will cause the pending signal to be discarded. If we did the
1403 * kill() after setting the signal to be ignored, it is unspecified
1404 * (by POSIX) whether the signal is immediately discarded or left
1405 * pending, and in fact Linux would leave it pending, and so it
1406 * would be delivered after the current signal handler exits,
1407 * leading to an infinite loop.
1409 sigaction(sig, &act, &oldact);
1410 sigaction(sig, &oldact, NULL);
1415 * hup - Catch SIGHUP signal.
1417 * Indicates that the physical layer has been disconnected.
1418 * We don't rely on this indication; if the user has sent this
1419 * signal, we just take the link down.
1425 /* can't log a message here, it can deadlock */
1428 /* Send the signal to the [dis]connector process(es) also */
1430 notify(sigreceived, sig);
1432 siglongjmp(sigjmp, 1);
1437 * term - Catch SIGTERM signal and SIGINT signal (^C/del).
1439 * Indicates that we should initiate a graceful disconnect and exit.
1446 /* can't log a message here, it can deadlock */
1449 /* Send the signal to the [dis]connector process(es) also */
1451 notify(sigreceived, sig);
1453 siglongjmp(sigjmp, 1);
1458 * chld - Catch SIGCHLD signal.
1459 * Sets a flag so we will call reap_kids in the mainline.
1467 siglongjmp(sigjmp, 1);
1472 * toggle_debug - Catch SIGUSR1 signal.
1474 * Toggle debug flag.
1483 setlogmask(LOG_UPTO(LOG_DEBUG));
1485 setlogmask(LOG_UPTO(LOG_WARNING));
1491 * open_ccp - Catch SIGUSR2 signal.
1493 * Try to (re)negotiate compression.
1502 siglongjmp(sigjmp, 1);
1507 * bad_signal - We've caught a fatal signal. Clean up state and exit.
1513 static int crashed = 0;
1518 error("Fatal signal %d", sig);
1520 kill_my_pg(SIGTERM);
1521 notify(sigreceived, sig);
1526 * safe_fork - Create a child process. The child closes all the
1527 * file descriptors that we don't want to leak to a script.
1528 * The parent waits for the child to do this before returning.
1537 if (pipe(pipefd) == -1)
1538 pipefd[0] = pipefd[1] = -1;
1544 /* this read() blocks until the close(pipefd[1]) below */
1545 complete_read(pipefd[0], buf, 1);
1553 notify(fork_notifier, 0);
1555 /* this close unblocks the read() call above in the parent */
1561 * device_script - run a program to talk to the specified fds
1562 * (e.g. to run the connector or disconnector script).
1563 * stderr gets connected to the log fd or to the _PATH_CONNERRS file.
1566 device_script(program, in, out, dont_wait)
1581 error("Failed to create child process: %m");
1587 record_child(pid, program, NULL, NULL);
1590 while (waitpid(pid, &status, 0) < 0) {
1593 fatal("error waiting for (dis)connection process: %m");
1597 return (status == 0 ? 0 : -1);
1600 /* here we are executing in the child */
1602 /* make sure fds 0, 1, 2 are occupied */
1603 while ((fd = dup(in)) >= 0) {
1610 /* dup in and out to fds > 2 */
1612 int fd1 = in, fd2 = out, fd3 = log_to_fd;
1616 if (log_to_fd >= 0) {
1617 errfd = dup(log_to_fd);
1619 errfd = open(_PATH_CONNERRS, O_WRONLY | O_APPEND | O_CREAT, 0600);
1626 /* close fds 0 - 2 and any others we can think of */
1630 if (the_channel->close)
1631 (*the_channel->close)();
1633 close(devfd); /* some plugins don't have a close function */
1637 /* dup the in, out, err fds to 0, 1, 2 */
1648 if (getuid() != uid) {
1649 error("setuid failed");
1653 execl("/bin/sh", "sh", "-c", program, (char *)0);
1654 error("could not exec /bin/sh: %m");
1661 * run-program - execute a program with given arguments,
1662 * but don't wait for it.
1663 * If the program can't be executed, logs an error unless
1664 * must_exist is 0 and the program file doesn't exist.
1665 * Returns -1 if it couldn't fork, 0 if the file doesn't exist
1666 * or isn't an executable plain file, or the process ID of the child.
1667 * If done != NULL, (*done)(arg) will be called later (within
1668 * reap_kids) iff the return value is > 0.
1671 run_program(prog, args, must_exist, done, arg)
1675 void (*done) __P((void *));
1682 * First check if the file exists and is executable.
1683 * We don't use access() because that would use the
1684 * real user-id, which might not be root, and the script
1685 * might be accessible only to root.
1688 if (stat(prog, &sbuf) < 0 || !S_ISREG(sbuf.st_mode)
1689 || (sbuf.st_mode & (S_IXUSR|S_IXGRP|S_IXOTH)) == 0) {
1690 if (must_exist || errno != ENOENT)
1691 warn("Can't execute %s: %m", prog);
1697 error("Failed to create child process for %s: %m", prog);
1702 dbglog("Script %s started (pid %d)", prog, pid);
1703 record_child(pid, prog, done, arg);
1707 /* Leave the current location */
1708 (void) setsid(); /* No controlling tty. */
1709 (void) umask (S_IRWXG|S_IRWXO);
1710 (void) chdir ("/"); /* no current directory. */
1711 setuid(0); /* set real UID = root */
1714 /* Ensure that nothing of our device environment is inherited. */
1716 if (the_channel->close)
1717 (*the_channel->close)();
1719 /* Don't pass handles to the PPP device, even by accident. */
1720 dup2(fd_devnull, 0);
1721 dup2(fd_devnull, 1);
1722 dup2(fd_devnull, 2);
1726 /* Force the priority back to zero if pppd is running higher. */
1727 if (setpriority (PRIO_PROCESS, 0, 0) < 0)
1728 warn("can't reset priority to 0: %m");
1731 /* SysV recommends a second fork at this point. */
1733 /* run the program */
1734 execve(prog, args, script_env);
1735 if (must_exist || errno != ENOENT) {
1736 /* have to reopen the log, there's nowhere else
1737 for the message to go. */
1739 syslog(LOG_ERR, "Can't execute %s: %m", prog);
1747 * record_child - add a child process to the list for reap_kids
1751 record_child(pid, prog, done, arg)
1754 void (*done) __P((void *));
1757 struct subprocess *chp;
1761 chp = (struct subprocess *) malloc(sizeof(struct subprocess));
1763 warn("losing track of %s process", prog);
1769 chp->next = children;
1775 * childwait_end - we got fed up waiting for the child processes to
1776 * exit, send them all a SIGTERM.
1782 struct subprocess *chp;
1784 for (chp = children; chp != NULL; chp = chp->next) {
1786 dbglog("sending SIGTERM to process %d", chp->pid);
1787 kill(chp->pid, SIGTERM);
1793 * reap_kids - get status from any dead child processes,
1794 * and log a message for abnormal terminations.
1800 struct subprocess *chp, **prevp;
1802 if (n_children == 0)
1804 while ((pid = waitpid(-1, &status, WNOHANG)) != -1 && pid != 0) {
1805 for (prevp = &children; (chp = *prevp) != NULL; prevp = &chp->next) {
1806 if (chp->pid == pid) {
1812 if (WIFSIGNALED(status)) {
1813 warn("Child process %s (pid %d) terminated with signal %d",
1814 (chp? chp->prog: "??"), pid, WTERMSIG(status));
1816 dbglog("Script %s finished (pid %d), status = 0x%x",
1817 (chp? chp->prog: "??"), pid,
1818 WIFEXITED(status) ? WEXITSTATUS(status) : status);
1819 if (chp && chp->done)
1820 (*chp->done)(chp->arg);
1825 if (errno == ECHILD)
1828 error("Error waiting for child process: %m");
1834 * add_notifier - add a new function to be called when something happens.
1837 add_notifier(notif, func, arg)
1838 struct notifier **notif;
1842 struct notifier *np;
1844 np = malloc(sizeof(struct notifier));
1846 novm("notifier struct");
1854 * remove_notifier - remove a function from the list of things to
1855 * be called when something happens.
1858 remove_notifier(notif, func, arg)
1859 struct notifier **notif;
1863 struct notifier *np;
1865 for (; (np = *notif) != 0; notif = &np->next) {
1866 if (np->func == func && np->arg == arg) {
1875 * notify - call a set of functions registered with add_notifier.
1879 struct notifier *notif;
1882 struct notifier *np;
1884 while ((np = notif) != 0) {
1886 (*np->func)(np->arg, val);
1891 * novm - log an error message saying we ran out of memory, and die.
1897 fatal("Virtual memory exhausted allocating %s\n", msg);
1901 * script_setenv - set an environment variable value to be used
1902 * for scripts that we run (e.g. ip-up, auth-up, etc.)
1905 script_setenv(var, value, iskey)
1909 size_t varl = strlen(var);
1910 size_t vl = varl + strlen(value) + 2;
1912 char *p, *newstring;
1914 newstring = (char *) malloc(vl+1);
1917 *newstring++ = iskey;
1918 slprintf(newstring, vl, "%s=%s", var, value);
1920 /* check if this variable is already set */
1921 if (script_env != 0) {
1922 for (i = 0; (p = script_env[i]) != 0; ++i) {
1923 if (strncmp(p, var, varl) == 0 && p[varl] == '=') {
1925 if (p[-1] && pppdb != NULL)
1929 script_env[i] = newstring;
1931 if (iskey && pppdb != NULL)
1932 add_db_key(newstring);
1939 /* no space allocated for script env. ptrs. yet */
1941 script_env = (char **) malloc(16 * sizeof(char *));
1942 if (script_env == 0)
1947 /* reallocate script_env with more space if needed */
1948 if (i + 1 >= s_env_nalloc) {
1950 char **newenv = (char **) realloc((void *)script_env,
1951 new_n * sizeof(char *));
1954 script_env = newenv;
1955 s_env_nalloc = new_n;
1958 script_env[i] = newstring;
1959 script_env[i+1] = 0;
1962 if (pppdb != NULL) {
1964 add_db_key(newstring);
1971 * script_unsetenv - remove a variable from the environment
1975 script_unsetenv(var)
1978 int vl = strlen(var);
1982 if (script_env == 0)
1984 for (i = 0; (p = script_env[i]) != 0; ++i) {
1985 if (strncmp(p, var, vl) == 0 && p[vl] == '=') {
1987 if (p[-1] && pppdb != NULL)
1991 while ((script_env[i] = script_env[i+1]) != 0)
2004 * update_db_entry - update our entry in the database.
2013 if (script_env == NULL)
2016 for (i = 0; (p = script_env[i]) != 0; ++i)
2017 vlen += strlen(p) + 1;
2018 vbuf = malloc(vlen);
2020 novm("database entry");
2022 for (i = 0; (p = script_env[i]) != 0; ++i)
2023 q += slprintf(q, vbuf + vlen - q, "%s;", p);
2026 key.dsize = strlen(db_key);
2029 if (tdb_store(pppdb, key, dbuf, TDB_REPLACE))
2030 error("tdb_store failed: %s", tdb_error(pppdb));
2038 * add_db_key - add a key that we can use to look up our database entry.
2046 key.dptr = (char *) str;
2047 key.dsize = strlen(str);
2049 dbuf.dsize = strlen(db_key);
2050 if (tdb_store(pppdb, key, dbuf, TDB_REPLACE))
2051 error("tdb_store key failed: %s", tdb_error(pppdb));
2055 * delete_db_key - delete a key for looking up our database entry.
2063 key.dptr = (char *) str;
2064 key.dsize = strlen(str);
2065 tdb_delete(pppdb, key);
2069 * cleanup_db - delete all the entries we put in the database.
2079 key.dsize = strlen(db_key);
2080 tdb_delete(pppdb, key);
2081 for (i = 0; (p = script_env[i]) != 0; ++i)
2085 #endif /* USE_TDB */