2 * options.c - handles option processing for PPP.
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.
60 * There have been 3 or 4 different names for this in libpcap CVS, but
61 * this seems to be what they have settled on...
62 * For older versions of libpcap, use DLT_PPP - but that means
63 * we lose the inbound and outbound qualifiers.
66 #ifdef DLT_PPP_WITHDIRECTION
67 #define DLT_PPP_PPPD DLT_PPP_WITHDIRECTION
69 #define DLT_PPP_PPPD DLT_PPP
72 #endif /* PPP_FILTER */
75 #include "pathnames.h"
77 #if defined(ultrix) || defined(NeXT)
83 struct option_value *next;
89 * Option variables and default values.
91 int debug = 0; /* Debug flag */
92 int kdebugflag = 0; /* Tell kernel to print debug messages */
93 int default_device = 1; /* Using /dev/tty or equivalent */
94 char devnam[MAXPATHLEN]; /* Device name */
95 bool nodetach = 0; /* Don't detach from controlling tty */
96 bool updetach = 0; /* Detach once link is up */
97 bool master_detach; /* Detach when we're (only) multilink master */
99 bool up_sdnotify = 0; /* Notify systemd once link is up */
101 int maxconnect = 0; /* Maximum connect time */
102 char user[MAXNAMELEN]; /* Username for PAP */
103 char passwd[MAXSECRETLEN]; /* Password for PAP */
104 bool persist = 0; /* Reopen link after it goes down */
105 char our_name[MAXNAMELEN]; /* Our name for authentication purposes */
106 bool demand = 0; /* do dial-on-demand */
107 char *ipparam = NULL; /* Extra parameter for ip up/down scripts */
108 int idle_time_limit = 0; /* Disconnect if idle for this many seconds */
109 int holdoff = 30; /* # seconds to pause before reconnecting */
110 bool holdoff_specified; /* true if a holdoff value has been given */
111 int log_to_fd = 1; /* send log messages to this fd too */
112 bool log_default = 1; /* log_to_fd is default (stdout) */
113 int maxfail = 10; /* max # of unsuccessful connection attempts */
114 char linkname[MAXPATHLEN]; /* logical name for link */
115 bool tune_kernel; /* may alter kernel settings */
116 int connect_delay = 1000; /* wait this many ms after connect script */
117 int req_unit = -1; /* requested interface unit */
118 char req_ifname[MAXIFNAMELEN]; /* requested interface name */
119 bool multilink = 0; /* Enable multilink operation */
120 char *bundle_name = NULL; /* bundle name for multilink */
121 bool dump_options; /* print out option values */
122 bool dryrun; /* print out option values and exit */
123 char *domain; /* domain name set by domain option */
124 int child_wait = 5; /* # seconds to wait for children at exit */
125 struct userenv *userenv_list; /* user environment variables */
126 int dfl_route_metric = -1; /* metric of the default route to set over the PPP link */
129 unsigned int maxoctets = 0; /* default - no limit */
130 int maxoctets_dir = 0; /* default - sum of traffic */
131 int maxoctets_timeout = 1; /* default 1 second */
135 extern option_t auth_options[];
136 extern struct stat devstat;
139 struct bpf_program pass_filter;/* Filter program for packets to pass */
140 struct bpf_program active_filter; /* Filter program for link-active pkts */
143 static option_t *curopt; /* pointer to option being processed */
144 char *current_option; /* the name of the option being parsed */
145 int privileged_option; /* set iff the current option came from root */
146 char *option_source; /* string saying where the option came from */
147 int option_priority = OPRIO_CFGFILE; /* priority of the current options */
148 bool devnam_fixed; /* can no longer change device name */
150 static int logfile_fd = -1; /* fd opened for log file */
151 static char logfile_name[MAXPATHLEN]; /* name of log file */
156 static int setdomain(char **);
157 static int readfile(char **);
158 static int callfile(char **);
159 static int showversion(char **);
160 static int showhelp(char **);
161 static void usage(void);
162 static int setlogfile(char **);
164 static int loadplugin(char **);
168 static int setpassfilter(char **);
169 static int setactivefilter(char **);
173 static int setmodir(char **);
176 static int user_setenv(char **);
177 static void user_setprint(option_t *, printer_func, void *);
178 static int user_unsetenv(char **);
179 static void user_unsetprint(option_t *, printer_func, void *);
181 static option_t *find_option(char *name);
182 static int process_option(option_t *, char *, char **);
183 static int n_arguments(option_t *);
184 static int number_option(char *, u_int32_t *, int);
187 * Structure to store extra lists of options.
191 struct option_list *next;
194 static struct option_list *extra_options = NULL;
199 option_t general_options[] = {
200 { "debug", o_int, &debug,
201 "Increase debugging level", OPT_INC | OPT_NOARG | 1 },
202 { "-d", o_int, &debug,
203 "Increase debugging level",
204 OPT_ALIAS | OPT_INC | OPT_NOARG | 1 },
206 { "kdebug", o_int, &kdebugflag,
207 "Set kernel driver debug level", OPT_PRIO },
209 { "nodetach", o_bool, &nodetach,
210 "Don't detach from controlling tty", OPT_PRIO | 1 },
211 { "-detach", o_bool, &nodetach,
212 "Don't detach from controlling tty", OPT_ALIAS | OPT_PRIOSUB | 1 },
214 { "up_sdnotify", o_bool, &up_sdnotify,
215 "Notify systemd once link is up (implies nodetach)",
216 OPT_PRIOSUB | OPT_A2COPY | 1, &nodetach },
218 { "updetach", o_bool, &updetach,
219 "Detach from controlling tty once link is up",
220 OPT_PRIOSUB | OPT_A2CLR | 1, &nodetach },
222 { "master_detach", o_bool, &master_detach,
223 "Detach when we're multilink master but have no link", 1 },
225 { "holdoff", o_int, &holdoff,
226 "Set time in seconds before retrying connection",
227 OPT_PRIO, &holdoff_specified },
229 { "idle", o_int, &idle_time_limit,
230 "Set time in seconds before disconnecting idle link", OPT_PRIO },
232 { "maxconnect", o_int, &maxconnect,
233 "Set connection time limit",
234 OPT_PRIO | OPT_LLIMIT | OPT_NOINCR | OPT_ZEROINF },
236 { "domain", o_special, (void *)setdomain,
237 "Add given domain name to hostname",
238 OPT_PRIO | OPT_PRIV | OPT_A2STRVAL, &domain },
240 { "file", o_special, (void *)readfile,
241 "Take options from a file", OPT_NOPRINT },
242 { "call", o_special, (void *)callfile,
243 "Take options from a privileged file", OPT_NOPRINT },
245 { "persist", o_bool, &persist,
246 "Keep on reopening connection after close", OPT_PRIO | 1 },
247 { "nopersist", o_bool, &persist,
248 "Turn off persist option", OPT_PRIOSUB },
250 { "demand", o_bool, &demand,
251 "Dial on demand", OPT_INITONLY | 1, &persist },
253 { "--version", o_special_noarg, (void *)showversion,
254 "Show version number" },
255 { "--help", o_special_noarg, (void *)showhelp,
256 "Show brief listing of options" },
257 { "-h", o_special_noarg, (void *)showhelp,
258 "Show brief listing of options", OPT_ALIAS },
260 { "logfile", o_special, (void *)setlogfile,
261 "Append log messages to this file",
262 OPT_PRIO | OPT_A2STRVAL | OPT_STATIC, &logfile_name },
263 { "logfd", o_int, &log_to_fd,
264 "Send log messages to this file descriptor",
265 OPT_PRIOSUB | OPT_A2CLR, &log_default },
266 { "nolog", o_int, &log_to_fd,
267 "Don't send log messages to any file",
268 OPT_PRIOSUB | OPT_NOARG | OPT_VAL(-1) },
269 { "nologfd", o_int, &log_to_fd,
270 "Don't send log messages to any file descriptor",
271 OPT_PRIOSUB | OPT_ALIAS | OPT_NOARG | OPT_VAL(-1) },
273 { "linkname", o_string, linkname,
274 "Set logical name for link",
275 OPT_PRIO | OPT_PRIV | OPT_STATIC, NULL, MAXPATHLEN },
277 { "maxfail", o_int, &maxfail,
278 "Maximum number of unsuccessful connection attempts to allow",
281 { "ktune", o_bool, &tune_kernel,
282 "Alter kernel settings as necessary", OPT_PRIO | 1 },
283 { "noktune", o_bool, &tune_kernel,
284 "Don't alter kernel settings", OPT_PRIOSUB },
286 { "connect-delay", o_int, &connect_delay,
287 "Maximum time (in ms) to wait after connect script finishes",
290 { "unit", o_int, &req_unit,
291 "PPP interface unit number to use if possible",
292 OPT_PRIO | OPT_LLIMIT, 0, 0 },
294 { "ifname", o_string, req_ifname,
295 "Set PPP interface name",
296 OPT_PRIO | OPT_PRIV | OPT_STATIC, NULL, MAXIFNAMELEN },
298 { "dump", o_bool, &dump_options,
299 "Print out option values after parsing all options", 1 },
300 { "dryrun", o_bool, &dryrun,
301 "Stop after parsing, printing, and checking options", 1 },
303 { "child-timeout", o_int, &child_wait,
304 "Number of seconds to wait for child processes at exit",
307 { "set", o_special, (void *)user_setenv,
308 "Set user environment variable",
309 OPT_A2PRINTER | OPT_NOPRINT, (void *)user_setprint },
310 { "unset", o_special, (void *)user_unsetenv,
311 "Unset user environment variable",
312 OPT_A2PRINTER | OPT_NOPRINT, (void *)user_unsetprint },
314 { "defaultroute-metric", o_int, &dfl_route_metric,
315 "Metric to use for the default route (Linux only; -1 for default behavior)",
316 OPT_PRIV|OPT_LLIMIT|OPT_INITONLY, NULL, 0, -1 },
318 #ifdef HAVE_MULTILINK
319 { "multilink", o_bool, &multilink,
320 "Enable multilink operation", OPT_PRIO | 1 },
321 { "mp", o_bool, &multilink,
322 "Enable multilink operation", OPT_PRIOSUB | OPT_ALIAS | 1 },
323 { "nomultilink", o_bool, &multilink,
324 "Disable multilink operation", OPT_PRIOSUB | 0 },
325 { "nomp", o_bool, &multilink,
326 "Disable multilink operation", OPT_PRIOSUB | OPT_ALIAS | 0 },
328 { "bundle", o_string, &bundle_name,
329 "Bundle name for multilink", OPT_PRIO },
330 #endif /* HAVE_MULTILINK */
333 { "plugin", o_special, (void *)loadplugin,
334 "Load a plug-in module into pppd", OPT_PRIV | OPT_A2LIST },
338 { "pass-filter", o_special, setpassfilter,
339 "set filter for packets to pass", OPT_PRIO },
341 { "active-filter", o_special, setactivefilter,
342 "set filter for active pkts", OPT_PRIO },
346 { "maxoctets", o_int, &maxoctets,
347 "Set connection traffic limit",
348 OPT_PRIO | OPT_LLIMIT | OPT_NOINCR | OPT_ZEROINF },
349 { "mo", o_int, &maxoctets,
350 "Set connection traffic limit",
351 OPT_ALIAS | OPT_PRIO | OPT_LLIMIT | OPT_NOINCR | OPT_ZEROINF },
352 { "mo-direction", o_special, setmodir,
353 "Set direction for limit traffic (sum,in,out,max)" },
354 { "mo-timeout", o_int, &maxoctets_timeout,
355 "Check for traffic limit every N seconds", OPT_PRIO | OPT_LLIMIT | 1 },
361 #ifndef IMPLEMENTATION
362 #define IMPLEMENTATION ""
365 static char *usage_string = "\
367 Usage: %s [ options ], where options are:\n\
368 <device> Communicate over the named device\n\
369 <speed> Set the baud rate to <speed>\n\
370 <loc>:<rem> Set the local and/or remote interface IP\n\
371 addresses. Either one may be omitted.\n\
372 asyncmap <n> Set the desired async map to hex <n>\n\
373 auth Require authentication from peer\n\
374 connect <p> Invoke shell command <p> to set up the serial line\n\
375 crtscts Use hardware RTS/CTS flow control\n\
376 defaultroute Add default route through interface\n\
377 file <f> Take options from file <f>\n\
378 modem Use modem control lines\n\
379 mru <n> Set MRU value to <n> for negotiation\n\
380 See pppd(8) for more options.\n\
384 * parse_args - parse a string of arguments from the command line.
387 parse_args(int argc, char **argv)
393 privileged_option = privileged;
394 option_source = "command line";
395 option_priority = OPRIO_CMDLINE;
399 opt = find_option(arg);
401 option_error("unrecognized option '%s'", arg);
405 n = n_arguments(opt);
407 option_error("too few parameters for option %s", arg);
410 if (!process_option(opt, arg, argv))
419 * options_from_file - Read a string of options from a file,
420 * and interpret them.
423 options_from_file(char *filename, int must_exist, int check_prot, int priv)
426 int i, newline, ret, err;
432 char args[MAXARGS][MAXWORDLEN];
433 char cmd[MAXWORDLEN];
436 if (check_prot && seteuid(getuid()) == -1) {
437 option_error("unable to drop privileges to open %s: %m", filename);
440 f = fopen(filename, "r");
442 if (check_prot && seteuid(euid) == -1)
443 fatal("unable to regain privileges");
447 if (err != ENOENT && err != ENOTDIR)
448 warn("Warning: can't open options file %s: %m", filename);
451 option_error("Can't open options file %s: %m", filename);
455 oldpriv = privileged_option;
456 privileged_option = priv;
457 oldsource = option_source;
458 option_source = strdup(filename);
459 if (option_source == NULL)
460 option_source = "file";
462 while (getword(f, cmd, &newline, filename)) {
463 opt = find_option(cmd);
465 option_error("In file %s: unrecognized option '%s'",
469 n = n_arguments(opt);
470 for (i = 0; i < n; ++i) {
471 if (!getword(f, args[i], &newline, filename)) {
473 "In file %s: too few parameters for option '%s'",
479 if (!process_option(opt, cmd, argv))
486 privileged_option = oldpriv;
487 option_source = oldsource;
492 * options_from_user - See if the use has a ~/.ppprc file,
493 * and if so, interpret options from it.
496 options_from_user(void)
498 char *user, *path, *file;
503 pw = getpwuid(getuid());
504 if (pw == NULL || (user = pw->pw_dir) == NULL || user[0] == 0)
506 file = _PATH_USEROPT;
507 pl = strlen(user) + strlen(file) + 2;
510 novm("init file name");
511 slprintf(path, pl, "%s/%s", user, file);
512 option_priority = OPRIO_CFGFILE;
513 ret = options_from_file(path, 0, 1, privileged);
519 * options_for_tty - See if an options file exists for the serial
520 * device, and if so, interpret options from it.
521 * We only allow the per-tty options file to override anything from
522 * the command line if it is something that the user can't override
523 * once it has been set by root; this is done by giving configuration
524 * files a lower priority than the command line.
527 options_for_tty(void)
529 char *dev, *path, *p;
534 if ((p = strstr(dev, "/dev/")) != NULL)
536 if (dev[0] == 0 || strcmp(dev, "tty") == 0)
537 return 1; /* don't look for /etc/ppp/options.tty */
538 pl = strlen(_PATH_TTYOPT) + strlen(dev) + 1;
541 novm("tty init file name");
542 slprintf(path, pl, "%s%s", _PATH_TTYOPT, dev);
543 /* Turn slashes into dots, for Solaris case (e.g. /dev/term/a) */
544 for (p = path + strlen(_PATH_TTYOPT); *p != 0; ++p)
547 option_priority = OPRIO_CFGFILE;
548 ret = options_from_file(path, 0, 0, 1);
554 * options_from_list - process a string of options in a wordlist.
557 options_from_list(struct wordlist *w, int priv)
564 privileged_option = priv;
565 option_source = "secrets file";
566 option_priority = OPRIO_SECFILE;
569 opt = find_option(w->word);
571 option_error("In secrets file: unrecognized option '%s'",
575 n = n_arguments(opt);
577 for (i = 0; i < n; ++i) {
581 "In secrets file: too few parameters for option '%s'",
587 if (!process_option(opt, w0->word, argv))
598 * match_option - see if this option matches an option_t structure.
601 match_option(char *name, option_t *opt, int dowild)
603 int (*match)(char *, char **, int);
605 if (dowild != (opt->type == o_wild))
608 return strcmp(name, opt->name) == 0;
609 match = (int (*)(char *, char **, int)) opt->addr;
610 return (*match)(name, NULL, 0);
614 * find_option - scan the option lists for the various protocols
615 * looking for an entry with the given name.
616 * This could be optimized by using a hash table.
619 find_option(char *name)
622 struct option_list *list;
625 for (dowild = 0; dowild <= 1; ++dowild) {
626 for (opt = general_options; opt->name != NULL; ++opt)
627 if (match_option(name, opt, dowild))
629 for (opt = auth_options; opt->name != NULL; ++opt)
630 if (match_option(name, opt, dowild))
632 for (list = extra_options; list != NULL; list = list->next)
633 for (opt = list->options; opt->name != NULL; ++opt)
634 if (match_option(name, opt, dowild))
636 for (opt = the_channel->options; opt->name != NULL; ++opt)
637 if (match_option(name, opt, dowild))
639 for (i = 0; protocols[i] != NULL; ++i)
640 if ((opt = protocols[i]->options) != NULL)
641 for (; opt->name != NULL; ++opt)
642 if (match_option(name, opt, dowild))
649 * process_option - process one new-style option.
652 process_option(option_t *opt, char *cmd, char **argv)
657 int (*parser)(char **);
658 int (*wildp)(char *, char **, int);
659 char *optopt = (opt->type == o_wild)? "": " option";
660 int prio = option_priority;
661 option_t *mainopt = opt;
663 current_option = opt->name;
664 if ((opt->flags & OPT_PRIVFIX) && privileged_option)
666 while (mainopt->flags & OPT_PRIOSUB)
668 if (mainopt->flags & OPT_PRIO) {
669 if (prio < mainopt->priority) {
670 /* new value doesn't override old */
671 if (prio == OPRIO_CMDLINE && mainopt->priority > OPRIO_ROOT) {
672 option_error("%s%s set in %s cannot be overridden\n",
673 opt->name, optopt, mainopt->source);
678 if (prio > OPRIO_ROOT && mainopt->priority == OPRIO_CMDLINE)
679 warn("%s%s from %s overrides command line",
680 opt->name, optopt, option_source);
683 if ((opt->flags & OPT_INITONLY) && phase != PHASE_INITIALIZE) {
684 option_error("%s%s cannot be changed after initialization",
688 if ((opt->flags & OPT_PRIV) && !privileged_option) {
689 option_error("using the %s%s requires root privilege",
693 if ((opt->flags & OPT_ENABLE) && *(bool *)(opt->addr2) == 0) {
694 option_error("%s%s is disabled", opt->name, optopt);
697 if ((opt->flags & OPT_DEVEQUIV) && devnam_fixed) {
698 option_error("the %s%s may not be changed in %s",
699 opt->name, optopt, option_source);
705 v = opt->flags & OPT_VALUE;
706 *(bool *)(opt->addr) = v;
707 if (opt->addr2 && (opt->flags & OPT_A2COPY))
708 *(bool *)(opt->addr2) = v;
709 else if (opt->addr2 && (opt->flags & OPT_A2CLR))
710 *(bool *)(opt->addr2) = 0;
711 else if (opt->addr2 && (opt->flags & OPT_A2CLRB))
712 *(u_char *)(opt->addr2) &= ~v;
713 else if (opt->addr2 && (opt->flags & OPT_A2OR))
714 *(u_char *)(opt->addr2) |= v;
719 if ((opt->flags & OPT_NOARG) == 0) {
720 if (!int_option(*argv, &iv))
722 if ((((opt->flags & OPT_LLIMIT) && iv < opt->lower_limit)
723 || ((opt->flags & OPT_ULIMIT) && iv > opt->upper_limit))
724 && !((opt->flags & OPT_ZEROOK && iv == 0))) {
725 char *zok = (opt->flags & OPT_ZEROOK)? " zero or": "";
726 switch (opt->flags & OPT_LIMITS) {
728 option_error("%s value must be%s >= %d",
729 opt->name, zok, opt->lower_limit);
732 option_error("%s value must be%s <= %d",
733 opt->name, zok, opt->upper_limit);
736 option_error("%s value must be%s between %d and %d",
737 opt->name, zok, opt->lower_limit, opt->upper_limit);
743 a = opt->flags & OPT_VALUE;
745 a -= 256; /* sign extend */
747 if (opt->flags & OPT_INC)
748 iv += *(int *)(opt->addr);
749 if ((opt->flags & OPT_NOINCR) && !privileged_option) {
750 int oldv = *(int *)(opt->addr);
751 if ((opt->flags & OPT_ZEROINF) ?
752 (oldv != 0 && (iv == 0 || iv > oldv)) : (iv > oldv)) {
753 option_error("%s value cannot be increased", opt->name);
757 *(int *)(opt->addr) = iv;
758 if (opt->addr2 && (opt->flags & OPT_A2COPY))
759 *(int *)(opt->addr2) = iv;
763 if (opt->flags & OPT_NOARG) {
764 v = opt->flags & OPT_VALUE;
767 } else if (!number_option(*argv, &v, 16))
769 if (opt->flags & OPT_OR)
770 v |= *(u_int32_t *)(opt->addr);
771 *(u_int32_t *)(opt->addr) = v;
772 if (opt->addr2 && (opt->flags & OPT_A2COPY))
773 *(u_int32_t *)(opt->addr2) = v;
777 if (opt->flags & OPT_STATIC) {
778 strlcpy((char *)(opt->addr), *argv, opt->upper_limit);
780 char **optptr = (char **)(opt->addr);
783 novm("option argument");
788 /* obfuscate original argument for things like password */
789 if (opt->flags & OPT_HIDE) {
790 memset(*argv, '?', strlen(*argv));
795 case o_special_noarg:
797 parser = (int (*)(char **)) opt->addr;
799 if (!(*parser)(argv))
801 if (opt->flags & OPT_A2LIST) {
802 struct option_value *ovp, *pp;
804 ovp = malloc(sizeof(*ovp) + strlen(*argv));
806 strcpy(ovp->value, *argv);
807 ovp->source = option_source;
809 if (opt->addr2 == NULL) {
812 for (pp = opt->addr2; pp->next != NULL; pp = pp->next)
821 wildp = (int (*)(char *, char **, int)) opt->addr;
822 if (!(*wildp)(cmd, argv, 1))
828 * If addr2 wasn't used by any flag (OPT_A2COPY, etc.) but is set,
829 * treat it as a bool and set/clear it based on the OPT_A2CLR bit.
831 if (opt->addr2 && (opt->flags & (OPT_A2COPY|OPT_ENABLE
832 |OPT_A2PRINTER|OPT_A2STRVAL|OPT_A2LIST|OPT_A2OR)) == 0)
833 *(bool *)(opt->addr2) = !(opt->flags & OPT_A2CLR);
835 mainopt->source = option_source;
836 mainopt->priority = prio;
837 mainopt->winner = opt - mainopt;
843 * override_value - if the option priorities would permit us to
844 * override the value of option, return 1 and update the priority
845 * and source of the option value. Otherwise returns 0.
848 override_value(char *option, int priority, const char *source)
852 opt = find_option(option);
855 while (opt->flags & OPT_PRIOSUB)
857 if ((opt->flags & OPT_PRIO) && priority < opt->priority)
859 opt->priority = priority;
860 opt->source = source;
866 * n_arguments - tell how many arguments an option takes
869 n_arguments(option_t *opt)
871 return (opt->type == o_bool || opt->type == o_special_noarg
872 || (opt->flags & OPT_NOARG))? 0: 1;
876 * add_options - add a list of options to the set we grok.
879 add_options(option_t *opt)
881 struct option_list *list;
883 list = malloc(sizeof(*list));
885 novm("option list entry");
887 list->next = extra_options;
888 extra_options = list;
892 * check_options - check that options are valid and consistent.
897 if (logfile_fd >= 0 && logfile_fd != log_to_fd)
902 * print_option - print out an option and its value
905 print_option(option_t *opt, option_t *mainopt, printer_func printer, void *arg)
910 if (opt->flags & OPT_NOPRINT)
914 v = opt->flags & OPT_VALUE;
915 if (*(bool *)opt->addr != v)
916 /* this can happen legitimately, e.g. lock
917 option turned off for default device */
919 printer(arg, "%s", opt->name);
922 v = opt->flags & OPT_VALUE;
925 i = *(int *)opt->addr;
926 if (opt->flags & OPT_NOARG) {
927 printer(arg, "%s", opt->name);
929 if (opt->flags & OPT_INC) {
930 for (; i > v; i -= v)
931 printer(arg, " %s", opt->name);
933 printer(arg, " # oops: %d not %d\n",
937 printer(arg, "%s %d", opt->name, i);
941 printer(arg, "%s", opt->name);
942 if ((opt->flags & OPT_NOARG) == 0)
943 printer(arg, " %x", *(u_int32_t *)opt->addr);
947 if (opt->flags & OPT_HIDE) {
950 p = (char *) opt->addr;
951 if ((opt->flags & OPT_STATIC) == 0)
954 printer(arg, "%s %q", opt->name, p);
958 case o_special_noarg:
960 if (opt->type != o_wild) {
961 printer(arg, "%s", opt->name);
962 if (n_arguments(opt) == 0)
966 if (opt->flags & OPT_A2PRINTER) {
967 void (*oprt)(option_t *, printer_func, void *);
968 oprt = (void (*)(option_t *, printer_func, void *))
970 (*oprt)(opt, printer, arg);
971 } else if (opt->flags & OPT_A2STRVAL) {
972 p = (char *) opt->addr2;
973 if ((opt->flags & OPT_STATIC) == 0)
975 printer(arg, "%q", p);
976 } else if (opt->flags & OPT_A2LIST) {
977 struct option_value *ovp;
979 ovp = (struct option_value *) opt->addr2;
981 printer(arg, "%q", ovp->value);
982 if ((ovp = ovp->next) == NULL)
984 printer(arg, "\t\t# (from %s)\n%s ",
985 ovp->source, opt->name);
988 printer(arg, "xxx # [don't know how to print value]");
993 printer(arg, "# %s value (type %d\?\?)", opt->name, opt->type);
996 printer(arg, "\t\t# (from %s)\n", mainopt->source);
1000 * print_option_list - print out options in effect from an
1004 print_option_list(option_t *opt, printer_func printer, void *arg)
1006 while (opt->name != NULL) {
1007 if (opt->priority != OPRIO_DEFAULT
1008 && opt->winner != (short int) -1)
1009 print_option(opt + opt->winner, opt, printer, arg);
1012 } while (opt->flags & OPT_PRIOSUB);
1017 * print_options - print out what options are in effect.
1020 print_options(printer_func printer, void *arg)
1022 struct option_list *list;
1025 printer(arg, "pppd options in effect:\n");
1026 print_option_list(general_options, printer, arg);
1027 print_option_list(auth_options, printer, arg);
1028 for (list = extra_options; list != NULL; list = list->next)
1029 print_option_list(list->options, printer, arg);
1030 print_option_list(the_channel->options, printer, arg);
1031 for (i = 0; protocols[i] != NULL; ++i)
1032 print_option_list(protocols[i]->options, printer, arg);
1036 * usage - print out a message telling how to use the program.
1041 if (phase == PHASE_INITIALIZE)
1042 fprintf(stderr, usage_string, VERSION, progname);
1046 * showhelp - print out usage message and exit.
1049 showhelp(char **argv)
1051 if (phase == PHASE_INITIALIZE) {
1059 * showversion - print out the version number and exit.
1062 showversion(char **argv)
1064 if (phase == PHASE_INITIALIZE) {
1065 fprintf(stdout, "pppd version %s\n", VERSION);
1072 * option_error - print a message about an error in an option.
1073 * The message is logged, and also sent to
1074 * stderr if phase == PHASE_INITIALIZE.
1077 option_error(char *fmt, ...)
1082 va_start(args, fmt);
1083 vslprintf(buf, sizeof(buf), fmt, args);
1085 if (phase == PHASE_INITIALIZE)
1086 fprintf(stderr, "%s: %s\n", progname, buf);
1087 syslog(LOG_ERR, "%s", buf);
1092 * readable - check if a file is readable by the real user.
1104 if (fstat(fd, &sbuf) != 0)
1106 if (sbuf.st_uid == uid)
1107 return sbuf.st_mode & S_IRUSR;
1108 if (sbuf.st_gid == getgid())
1109 return sbuf.st_mode & S_IRGRP;
1110 for (i = 0; i < ngroups; ++i)
1111 if (sbuf.st_gid == groups[i])
1112 return sbuf.st_mode & S_IRGRP;
1113 return sbuf.st_mode & S_IROTH;
1118 * Read a word from a file.
1119 * Words are delimited by white-space or by quotes (" or ').
1120 * Quotes, white-space and \ may be escaped with \.
1121 * \<newline> is ignored.
1124 getword(FILE *f, char *word, int *newlinep, char *filename)
1127 int quoted, comment;
1128 int value, digit, got, n;
1130 #define isoctal(c) ((c) >= '0' && (c) < '8')
1139 * First skip white-space and comments.
1147 * A newline means the end of a comment; backslash-newline
1148 * is ignored. Note that we cannot have escape && comment.
1160 * Ignore characters other than newline in a comment.
1166 * If this character is escaped, we have a word start.
1172 * If this is the escape character, look at the next character.
1180 * If this is the start of a comment, ignore the rest of the line.
1188 * A non-whitespace character is the start of a word.
1195 * Process characters until the end of the word.
1200 * This character is escaped: backslash-newline is ignored,
1201 * various other characters indicate particular values
1202 * as for C backslash-escapes.
1237 * \ddd octal sequence
1240 for (n = 0; n < 3 && isoctal(c); ++n) {
1241 value = (value << 3) + (c & 07);
1250 * \x<hex_string> sequence
1254 for (n = 0; n < 2 && isxdigit(c); ++n) {
1255 digit = toupper(c) - '0';
1257 digit += '0' + 10 - 'A';
1258 value = (value << 4) + digit;
1266 * Otherwise the character stands for itself.
1273 * Store the resulting character for the escape sequence.
1275 if (len < MAXWORDLEN) {
1286 * Backslash starts a new escape sequence.
1295 * Not escaped: check for the start or end of a quoted
1296 * section and see if we've reached the end of the word.
1304 } else if (c == '"' || c == '\'') {
1308 } else if (isspace(c) || c == '#') {
1314 * An ordinary character: store it in the word and get another.
1316 if (len < MAXWORDLEN) {
1323 word[MAXWORDLEN-1] = 0; /* make sure word is null-terminated */
1326 * End of the word: check for errors.
1332 option_error("Error reading %s: %m", filename);
1336 * If len is zero, then we didn't find a word before the
1342 option_error("warning: quoted word runs to end of file (%.20s...)",
1347 * Warn if the word was too long, and append a terminating null.
1349 if (len >= MAXWORDLEN) {
1350 option_error("warning: word in file %s too long (%.20s...)",
1352 len = MAXWORDLEN - 1;
1363 * number_option - parse an unsigned numeric parameter for an option.
1366 number_option(char *str, u_int32_t *valp, int base)
1370 *valp = strtoul(str, &ptr, base);
1372 option_error("invalid numeric parameter '%s' for %s option",
1373 str, current_option);
1381 * int_option - like number_option, but valp is int *,
1382 * the base is assumed to be 0, and *valp is not changed
1383 * if there is an error.
1386 int_option(char *str, int *valp)
1390 if (!number_option(str, &v, 0))
1398 * The following procedures parse options.
1402 * readfile - take commands from a file.
1405 readfile(char **argv)
1407 return options_from_file(*argv, 1, 1, privileged_option);
1411 * callfile - take commands from /etc/ppp/peers/<name>.
1412 * Name may not contain /../, start with / or ../, or end in /..
1415 callfile(char **argv)
1417 char *fname, *arg, *p;
1422 if (arg[0] == '/' || arg[0] == 0)
1425 for (p = arg; *p != 0; ) {
1426 if (p[0] == '.' && p[1] == '.' && (p[2] == '/' || p[2] == 0)) {
1430 while (*p != '/' && *p != 0)
1437 option_error("call option value may not contain .. or start with /");
1441 l = strlen(arg) + strlen(_PATH_PEERFILES) + 1;
1442 if ((fname = (char *) malloc(l)) == NULL)
1443 novm("call file name");
1444 slprintf(fname, l, "%s%s", _PATH_PEERFILES, arg);
1446 ok = options_from_file(fname, 1, 1, 1);
1454 * setpassfilter - Set the pass filter for packets
1457 setpassfilter(char **argv)
1462 pc = pcap_open_dead(DLT_PPP_PPPD, 65535);
1463 if (pcap_compile(pc, &pass_filter, *argv, 1, netmask) == -1) {
1464 option_error("error in pass-filter expression: %s\n",
1474 * setactivefilter - Set the active filter for packets
1477 setactivefilter(char **argv)
1482 pc = pcap_open_dead(DLT_PPP_PPPD, 65535);
1483 if (pcap_compile(pc, &active_filter, *argv, 1, netmask) == -1) {
1484 option_error("error in active-filter expression: %s\n",
1495 * setdomain - Set domain name to append to hostname
1498 setdomain(char **argv)
1500 gethostname(hostname, MAXNAMELEN);
1503 strncat(hostname, ".", MAXNAMELEN - strlen(hostname));
1504 domain = hostname + strlen(hostname);
1505 strncat(hostname, *argv, MAXNAMELEN - strlen(hostname));
1507 hostname[MAXNAMELEN-1] = 0;
1512 setlogfile(char **argv)
1518 if (!privileged_option && seteuid(getuid()) == -1) {
1519 option_error("unable to drop permissions to open %s: %m", *argv);
1522 fd = open(*argv, O_WRONLY | O_APPEND | O_CREAT | O_EXCL, 0644);
1523 if (fd < 0 && errno == EEXIST)
1524 fd = open(*argv, O_WRONLY | O_APPEND);
1526 if (!privileged_option && seteuid(euid) == -1)
1527 fatal("unable to regain privileges: %m");
1530 option_error("Can't open log file %s: %m", *argv);
1533 strlcpy(logfile_name, *argv, sizeof(logfile_name));
1534 if (logfile_fd >= 0)
1544 setmodir(char **argv)
1548 if(!strcmp(*argv,"in")) {
1549 maxoctets_dir = PPP_OCTETS_DIRECTION_IN;
1550 } else if (!strcmp(*argv,"out")) {
1551 maxoctets_dir = PPP_OCTETS_DIRECTION_OUT;
1552 } else if (!strcmp(*argv,"max")) {
1553 maxoctets_dir = PPP_OCTETS_DIRECTION_MAXOVERAL;
1555 maxoctets_dir = PPP_OCTETS_DIRECTION_SUM;
1563 loadplugin(char **argv)
1572 if (strchr(arg, '/') == 0) {
1573 const char *base = _PATH_PLUGIN;
1574 int l = strlen(base) + strlen(arg) + 2;
1577 novm("plugin file path");
1578 strlcpy(path, base, l);
1579 strlcat(path, "/", l);
1580 strlcat(path, arg, l);
1582 handle = dlopen(path, RTLD_GLOBAL | RTLD_NOW);
1586 option_error("%s", err);
1587 option_error("Couldn't load plugin %s", arg);
1590 init = (void (*)(void))dlsym(handle, "plugin_init");
1592 option_error("%s has no initialization entry point", arg);
1595 vers = (const char *) dlsym(handle, "pppd_version");
1597 warn("Warning: plugin %s has no version information", arg);
1598 } else if (strcmp(vers, VERSION) != 0) {
1599 option_error("Plugin %s is for pppd version %s, this is %s",
1600 arg, vers, VERSION);
1603 info("Plugin %s loaded.", arg);
1617 * Set an environment variable specified by the user.
1620 user_setenv(char **argv)
1622 char *arg = argv[0];
1624 struct userenv *uep, **insp;
1626 if ((eqp = strchr(arg, '=')) == NULL) {
1627 option_error("missing = in name=value: %s", arg);
1631 option_error("missing variable name: %s", arg);
1634 for (uep = userenv_list; uep != NULL; uep = uep->ue_next) {
1635 int nlen = strlen(uep->ue_name);
1636 if (nlen == (eqp - arg) &&
1637 strncmp(arg, uep->ue_name, nlen) == 0)
1640 /* Ignore attempts by unprivileged users to override privileged sources */
1641 if (uep != NULL && !privileged_option && uep->ue_priv)
1643 /* The name never changes, so allocate it with the structure */
1645 uep = malloc(sizeof (*uep) + (eqp-arg));
1646 strncpy(uep->ue_name, arg, eqp-arg);
1647 uep->ue_name[eqp-arg] = '\0';
1648 uep->ue_next = NULL;
1649 insp = &userenv_list;
1650 while (*insp != NULL)
1651 insp = &(*insp)->ue_next;
1654 struct userenv *uep2;
1655 for (uep2 = userenv_list; uep2 != NULL; uep2 = uep2->ue_next) {
1656 if (uep2 != uep && !uep2->ue_isset)
1659 if (uep2 == NULL && !uep->ue_isset)
1660 find_option("unset")->flags |= OPT_NOPRINT;
1661 free(uep->ue_value);
1664 uep->ue_priv = privileged_option;
1665 uep->ue_source = option_source;
1666 uep->ue_value = strdup(eqp + 1);
1667 curopt->flags &= ~OPT_NOPRINT;
1672 user_setprint(option_t *opt, printer_func printer, void *arg)
1674 struct userenv *uep, *uepnext;
1676 uepnext = userenv_list;
1677 while (uepnext != NULL && !uepnext->ue_isset)
1678 uepnext = uepnext->ue_next;
1679 while ((uep = uepnext) != NULL) {
1680 uepnext = uep->ue_next;
1681 while (uepnext != NULL && !uepnext->ue_isset)
1682 uepnext = uepnext->ue_next;
1683 (*printer)(arg, "%s=%s", uep->ue_name, uep->ue_value);
1684 if (uepnext != NULL)
1685 (*printer)(arg, "\t\t# (from %s)\n%s ", uep->ue_source, opt->name);
1687 opt->source = uep->ue_source;
1692 user_unsetenv(char **argv)
1694 struct userenv *uep, **insp;
1695 char *arg = argv[0];
1697 if (strchr(arg, '=') != NULL) {
1698 option_error("unexpected = in name: %s", arg);
1702 option_error("missing variable name for unset");
1705 for (uep = userenv_list; uep != NULL; uep = uep->ue_next) {
1706 if (strcmp(arg, uep->ue_name) == 0)
1709 /* Ignore attempts by unprivileged users to override privileged sources */
1710 if (uep != NULL && !privileged_option && uep->ue_priv)
1712 /* The name never changes, so allocate it with the structure */
1714 uep = malloc(sizeof (*uep) + strlen(arg));
1715 strcpy(uep->ue_name, arg);
1716 uep->ue_next = NULL;
1717 insp = &userenv_list;
1718 while (*insp != NULL)
1719 insp = &(*insp)->ue_next;
1722 struct userenv *uep2;
1723 for (uep2 = userenv_list; uep2 != NULL; uep2 = uep2->ue_next) {
1724 if (uep2 != uep && uep2->ue_isset)
1727 if (uep2 == NULL && uep->ue_isset)
1728 find_option("set")->flags |= OPT_NOPRINT;
1729 free(uep->ue_value);
1732 uep->ue_priv = privileged_option;
1733 uep->ue_source = option_source;
1734 uep->ue_value = NULL;
1735 curopt->flags &= ~OPT_NOPRINT;
1740 user_unsetprint(option_t *opt, printer_func printer, void *arg)
1742 struct userenv *uep, *uepnext;
1744 uepnext = userenv_list;
1745 while (uepnext != NULL && uepnext->ue_isset)
1746 uepnext = uepnext->ue_next;
1747 while ((uep = uepnext) != NULL) {
1748 uepnext = uep->ue_next;
1749 while (uepnext != NULL && uepnext->ue_isset)
1750 uepnext = uepnext->ue_next;
1751 (*printer)(arg, "%s", uep->ue_name);
1752 if (uepnext != NULL)
1753 (*printer)(arg, "\t\t# (from %s)\n%s ", uep->ue_source, opt->name);
1755 opt->source = uep->ue_source;