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.
43 #define RCSID "$Id: options.c,v 1.102 2008/06/15 06:53:06 paulus Exp $"
61 * There have been 3 or 4 different names for this in libpcap CVS, but
62 * this seems to be what they have settled on...
63 * For older versions of libpcap, use DLT_PPP - but that means
64 * we lose the inbound and outbound qualifiers.
67 #ifdef DLT_PPP_WITHDIRECTION
68 #define DLT_PPP_PPPD DLT_PPP_WITHDIRECTION
70 #define DLT_PPP_PPPD DLT_PPP
73 #endif /* PPP_FILTER */
76 #include "pathnames.h"
78 #if defined(ultrix) || defined(NeXT)
79 char *strdup __P((char *));
82 static const char rcsid[] = RCSID;
85 struct option_value *next;
91 * Option variables and default values.
93 int debug = 0; /* Debug flag */
94 int kdebugflag = 0; /* Tell kernel to print debug messages */
95 int default_device = 1; /* Using /dev/tty or equivalent */
96 char devnam[MAXPATHLEN]; /* Device name */
97 bool nodetach = 0; /* Don't detach from controlling tty */
98 bool updetach = 0; /* Detach once link is up */
99 bool master_detach; /* Detach when we're (only) multilink master */
100 int maxconnect = 0; /* Maximum connect time */
101 char user[MAXNAMELEN]; /* Username for PAP */
102 char passwd[MAXSECRETLEN]; /* Password for PAP */
103 bool persist = 0; /* Reopen link after it goes down */
104 char our_name[MAXNAMELEN]; /* Our name for authentication purposes */
105 bool demand = 0; /* do dial-on-demand */
106 char *ipparam = NULL; /* Extra parameter for ip up/down scripts */
107 int idle_time_limit = 0; /* Disconnect if idle for this many seconds */
108 int holdoff = 30; /* # seconds to pause before reconnecting */
109 bool holdoff_specified; /* true if a holdoff value has been given */
110 int log_to_fd = 1; /* send log messages to this fd too */
111 bool log_default = 1; /* log_to_fd is default (stdout) */
112 int maxfail = 10; /* max # of unsuccessful connection attempts */
113 char linkname[MAXPATHLEN]; /* logical name for link */
114 bool tune_kernel; /* may alter kernel settings */
115 int connect_delay = 1000; /* wait this many ms after connect script */
116 int req_unit = -1; /* requested interface unit */
117 bool multilink = 0; /* Enable multilink operation */
118 char *bundle_name = NULL; /* bundle name for multilink */
119 bool dump_options; /* print out option values */
120 bool dryrun; /* print out option values and exit */
121 char *domain; /* domain name set by domain option */
122 int child_wait = 5; /* # seconds to wait for children at exit */
123 struct userenv *userenv_list; /* user environment variables */
124 int dfl_route_metric = -1; /* metric of the default route to set over the PPP link */
127 unsigned int maxoctets = 0; /* default - no limit */
128 int maxoctets_dir = 0; /* default - sum of traffic */
129 int maxoctets_timeout = 1; /* default 1 second */
133 extern option_t auth_options[];
134 extern struct stat devstat;
137 struct bpf_program pass_filter;/* Filter program for packets to pass */
138 struct bpf_program active_filter; /* Filter program for link-active pkts */
141 static option_t *curopt; /* pointer to option being processed */
142 char *current_option; /* the name of the option being parsed */
143 int privileged_option; /* set iff the current option came from root */
144 char *option_source; /* string saying where the option came from */
145 int option_priority = OPRIO_CFGFILE; /* priority of the current options */
146 bool devnam_fixed; /* can no longer change device name */
148 static int logfile_fd = -1; /* fd opened for log file */
149 static char logfile_name[MAXPATHLEN]; /* name of log file */
154 static int setdomain __P((char **));
155 static int readfile __P((char **));
156 static int callfile __P((char **));
157 static int showversion __P((char **));
158 static int showhelp __P((char **));
159 static void usage __P((void));
160 static int setlogfile __P((char **));
162 static int loadplugin __P((char **));
166 static int setpassfilter __P((char **));
167 static int setactivefilter __P((char **));
171 static int setmodir __P((char **));
174 static int user_setenv __P((char **));
175 static void user_setprint __P((option_t *, printer_func, void *));
176 static int user_unsetenv __P((char **));
177 static void user_unsetprint __P((option_t *, printer_func, void *));
179 static option_t *find_option __P((const char *name));
180 static int process_option __P((option_t *, char *, char **));
181 static int n_arguments __P((option_t *));
182 static int number_option __P((char *, u_int32_t *, int));
185 * Structure to store extra lists of options.
189 struct option_list *next;
192 static struct option_list *extra_options = NULL;
197 option_t general_options[] = {
198 { "debug", o_int, &debug,
199 "Increase debugging level", OPT_INC | OPT_NOARG | 1 },
200 { "-d", o_int, &debug,
201 "Increase debugging level",
202 OPT_ALIAS | OPT_INC | OPT_NOARG | 1 },
204 { "kdebug", o_int, &kdebugflag,
205 "Set kernel driver debug level", OPT_PRIO },
207 { "nodetach", o_bool, &nodetach,
208 "Don't detach from controlling tty", OPT_PRIO | 1 },
209 { "-detach", o_bool, &nodetach,
210 "Don't detach from controlling tty", OPT_ALIAS | OPT_PRIOSUB | 1 },
211 { "updetach", o_bool, &updetach,
212 "Detach from controlling tty once link is up",
213 OPT_PRIOSUB | OPT_A2CLR | 1, &nodetach },
215 { "master_detach", o_bool, &master_detach,
216 "Detach when we're multilink master but have no link", 1 },
218 { "holdoff", o_int, &holdoff,
219 "Set time in seconds before retrying connection",
220 OPT_PRIO, &holdoff_specified },
222 { "idle", o_int, &idle_time_limit,
223 "Set time in seconds before disconnecting idle link", OPT_PRIO },
225 { "maxconnect", o_int, &maxconnect,
226 "Set connection time limit",
227 OPT_PRIO | OPT_LLIMIT | OPT_NOINCR | OPT_ZEROINF },
229 { "domain", o_special, (void *)setdomain,
230 "Add given domain name to hostname",
231 OPT_PRIO | OPT_PRIV | OPT_A2STRVAL, &domain },
233 { "file", o_special, (void *)readfile,
234 "Take options from a file", OPT_NOPRINT },
235 { "call", o_special, (void *)callfile,
236 "Take options from a privileged file", OPT_NOPRINT },
238 { "persist", o_bool, &persist,
239 "Keep on reopening connection after close", OPT_PRIO | 1 },
240 { "nopersist", o_bool, &persist,
241 "Turn off persist option", OPT_PRIOSUB },
243 { "demand", o_bool, &demand,
244 "Dial on demand", OPT_INITONLY | 1, &persist },
246 { "--version", o_special_noarg, (void *)showversion,
247 "Show version number" },
248 { "--help", o_special_noarg, (void *)showhelp,
249 "Show brief listing of options" },
250 { "-h", o_special_noarg, (void *)showhelp,
251 "Show brief listing of options", OPT_ALIAS },
253 { "logfile", o_special, (void *)setlogfile,
254 "Append log messages to this file",
255 OPT_PRIO | OPT_A2STRVAL | OPT_STATIC, &logfile_name },
256 { "logfd", o_int, &log_to_fd,
257 "Send log messages to this file descriptor",
258 OPT_PRIOSUB | OPT_A2CLR, &log_default },
259 { "nolog", o_int, &log_to_fd,
260 "Don't send log messages to any file",
261 OPT_PRIOSUB | OPT_NOARG | OPT_VAL(-1) },
262 { "nologfd", o_int, &log_to_fd,
263 "Don't send log messages to any file descriptor",
264 OPT_PRIOSUB | OPT_ALIAS | OPT_NOARG | OPT_VAL(-1) },
266 { "linkname", o_string, linkname,
267 "Set logical name for link",
268 OPT_PRIO | OPT_PRIV | OPT_STATIC, NULL, MAXPATHLEN },
270 { "maxfail", o_int, &maxfail,
271 "Maximum number of unsuccessful connection attempts to allow",
274 { "ktune", o_bool, &tune_kernel,
275 "Alter kernel settings as necessary", OPT_PRIO | 1 },
276 { "noktune", o_bool, &tune_kernel,
277 "Don't alter kernel settings", OPT_PRIOSUB },
279 { "connect-delay", o_int, &connect_delay,
280 "Maximum time (in ms) to wait after connect script finishes",
283 { "unit", o_int, &req_unit,
284 "PPP interface unit number to use if possible",
285 OPT_PRIO | OPT_LLIMIT, 0, 0 },
287 { "dump", o_bool, &dump_options,
288 "Print out option values after parsing all options", 1 },
289 { "dryrun", o_bool, &dryrun,
290 "Stop after parsing, printing, and checking options", 1 },
292 { "child-timeout", o_int, &child_wait,
293 "Number of seconds to wait for child processes at exit",
296 { "set", o_special, (void *)user_setenv,
297 "Set user environment variable",
298 OPT_A2PRINTER | OPT_NOPRINT, (void *)user_setprint },
299 { "unset", o_special, (void *)user_unsetenv,
300 "Unset user environment variable",
301 OPT_A2PRINTER | OPT_NOPRINT, (void *)user_unsetprint },
303 { "defaultroute-metric", o_int, &dfl_route_metric,
304 "Metric to use for the default route (Linux only; -1 for default behavior)",
305 OPT_PRIV|OPT_LLIMIT|OPT_INITONLY, NULL, 0, -1 },
307 #ifdef HAVE_MULTILINK
308 { "multilink", o_bool, &multilink,
309 "Enable multilink operation", OPT_PRIO | 1 },
310 { "mp", o_bool, &multilink,
311 "Enable multilink operation", OPT_PRIOSUB | OPT_ALIAS | 1 },
312 { "nomultilink", o_bool, &multilink,
313 "Disable multilink operation", OPT_PRIOSUB | 0 },
314 { "nomp", o_bool, &multilink,
315 "Disable multilink operation", OPT_PRIOSUB | OPT_ALIAS | 0 },
317 { "bundle", o_string, &bundle_name,
318 "Bundle name for multilink", OPT_PRIO },
319 #endif /* HAVE_MULTILINK */
322 { "plugin", o_special, (void *)loadplugin,
323 "Load a plug-in module into pppd", OPT_PRIV | OPT_A2LIST },
327 { "pass-filter", o_special, setpassfilter,
328 "set filter for packets to pass", OPT_PRIO },
330 { "active-filter", o_special, setactivefilter,
331 "set filter for active pkts", OPT_PRIO },
335 { "maxoctets", o_int, &maxoctets,
336 "Set connection traffic limit",
337 OPT_PRIO | OPT_LLIMIT | OPT_NOINCR | OPT_ZEROINF },
338 { "mo", o_int, &maxoctets,
339 "Set connection traffic limit",
340 OPT_ALIAS | OPT_PRIO | OPT_LLIMIT | OPT_NOINCR | OPT_ZEROINF },
341 { "mo-direction", o_special, setmodir,
342 "Set direction for limit traffic (sum,in,out,max)" },
343 { "mo-timeout", o_int, &maxoctets_timeout,
344 "Check for traffic limit every N seconds", OPT_PRIO | OPT_LLIMIT | 1 },
350 #ifndef IMPLEMENTATION
351 #define IMPLEMENTATION ""
354 static char *usage_string = "\
356 Usage: %s [ options ], where options are:\n\
357 <device> Communicate over the named device\n\
358 <speed> Set the baud rate to <speed>\n\
359 <loc>:<rem> Set the local and/or remote interface IP\n\
360 addresses. Either one may be omitted.\n\
361 asyncmap <n> Set the desired async map to hex <n>\n\
362 auth Require authentication from peer\n\
363 connect <p> Invoke shell command <p> to set up the serial line\n\
364 crtscts Use hardware RTS/CTS flow control\n\
365 defaultroute Add default route through interface\n\
366 file <f> Take options from file <f>\n\
367 modem Use modem control lines\n\
368 mru <n> Set MRU value to <n> for negotiation\n\
369 See pppd(8) for more options.\n\
373 * parse_args - parse a string of arguments from the command line.
376 parse_args(argc, argv)
384 privileged_option = privileged;
385 option_source = "command line";
386 option_priority = OPRIO_CMDLINE;
390 opt = find_option(arg);
392 option_error("unrecognized option '%s'", arg);
396 n = n_arguments(opt);
398 option_error("too few parameters for option %s", arg);
401 if (!process_option(opt, arg, argv))
410 * options_from_file - Read a string of options from a file,
411 * and interpret them.
414 options_from_file(filename, must_exist, check_prot, priv)
421 int i, newline, ret, err;
427 char args[MAXARGS][MAXWORDLEN];
428 char cmd[MAXWORDLEN];
431 if (check_prot && seteuid(getuid()) == -1) {
432 option_error("unable to drop privileges to open %s: %m", filename);
435 f = fopen(filename, "r");
437 if (check_prot && seteuid(euid) == -1)
438 fatal("unable to regain privileges");
442 if (err != ENOENT && err != ENOTDIR)
443 warn("Warning: can't open options file %s: %m", filename);
446 option_error("Can't open options file %s: %m", filename);
450 oldpriv = privileged_option;
451 privileged_option = priv;
452 oldsource = option_source;
453 option_source = strdup(filename);
454 if (option_source == NULL)
455 option_source = "file";
457 while (getword(f, cmd, &newline, filename)) {
458 opt = find_option(cmd);
460 option_error("In file %s: unrecognized option '%s'",
464 n = n_arguments(opt);
465 for (i = 0; i < n; ++i) {
466 if (!getword(f, args[i], &newline, filename)) {
468 "In file %s: too few parameters for option '%s'",
474 if (!process_option(opt, cmd, argv))
481 privileged_option = oldpriv;
482 option_source = oldsource;
487 * options_from_user - See if the use has a ~/.ppprc file,
488 * and if so, interpret options from it.
493 char *user, *path, *file;
498 pw = getpwuid(getuid());
499 if (pw == NULL || (user = pw->pw_dir) == NULL || user[0] == 0)
501 file = _PATH_USEROPT;
502 pl = strlen(user) + strlen(file) + 2;
505 novm("init file name");
506 slprintf(path, pl, "%s/%s", user, file);
507 option_priority = OPRIO_CFGFILE;
508 ret = options_from_file(path, 0, 1, privileged);
514 * options_for_tty - See if an options file exists for the serial
515 * device, and if so, interpret options from it.
516 * We only allow the per-tty options file to override anything from
517 * the command line if it is something that the user can't override
518 * once it has been set by root; this is done by giving configuration
519 * files a lower priority than the command line.
524 char *dev, *path, *p;
529 if ((p = strstr(dev, "/dev/")) != NULL)
531 if (dev[0] == 0 || strcmp(dev, "tty") == 0)
532 return 1; /* don't look for /etc/ppp/options.tty */
533 pl = strlen(_PATH_TTYOPT) + strlen(dev) + 1;
536 novm("tty init file name");
537 slprintf(path, pl, "%s%s", _PATH_TTYOPT, dev);
538 /* Turn slashes into dots, for Solaris case (e.g. /dev/term/a) */
539 for (p = path + strlen(_PATH_TTYOPT); *p != 0; ++p)
542 option_priority = OPRIO_CFGFILE;
543 ret = options_from_file(path, 0, 0, 1);
549 * options_from_list - process a string of options in a wordlist.
552 options_from_list(w, priv)
561 privileged_option = priv;
562 option_source = "secrets file";
563 option_priority = OPRIO_SECFILE;
566 opt = find_option(w->word);
568 option_error("In secrets file: unrecognized option '%s'",
572 n = n_arguments(opt);
574 for (i = 0; i < n; ++i) {
578 "In secrets file: too few parameters for option '%s'",
584 if (!process_option(opt, w0->word, argv))
595 * match_option - see if this option matches an option_t structure.
598 match_option(name, opt, dowild)
603 int (*match) __P((char *, char **, int));
605 if (dowild != (opt->type == o_wild))
608 return strcmp(name, opt->name) == 0;
609 match = (int (*) __P((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.
623 struct option_list *list;
626 for (dowild = 0; dowild <= 1; ++dowild) {
627 for (opt = general_options; opt->name != NULL; ++opt)
628 if (match_option(name, opt, dowild))
630 for (opt = auth_options; opt->name != NULL; ++opt)
631 if (match_option(name, opt, dowild))
633 for (list = extra_options; list != NULL; list = list->next)
634 for (opt = list->options; opt->name != NULL; ++opt)
635 if (match_option(name, opt, dowild))
637 for (opt = the_channel->options; opt->name != NULL; ++opt)
638 if (match_option(name, opt, dowild))
640 for (i = 0; protocols[i] != NULL; ++i)
641 if ((opt = protocols[i]->options) != NULL)
642 for (; opt->name != NULL; ++opt)
643 if (match_option(name, opt, dowild))
650 * process_option - process one new-style option.
653 process_option(opt, cmd, argv)
661 int (*parser) __P((char **));
662 int (*wildp) __P((char *, char **, int));
663 char *optopt = (opt->type == o_wild)? "": " option";
664 int prio = option_priority;
665 option_t *mainopt = opt;
667 current_option = opt->name;
668 if ((opt->flags & OPT_PRIVFIX) && privileged_option)
670 while (mainopt->flags & OPT_PRIOSUB)
672 if (mainopt->flags & OPT_PRIO) {
673 if (prio < mainopt->priority) {
674 /* new value doesn't override old */
675 if (prio == OPRIO_CMDLINE && mainopt->priority > OPRIO_ROOT) {
676 option_error("%s%s set in %s cannot be overridden\n",
677 opt->name, optopt, mainopt->source);
682 if (prio > OPRIO_ROOT && mainopt->priority == OPRIO_CMDLINE)
683 warn("%s%s from %s overrides command line",
684 opt->name, optopt, option_source);
687 if ((opt->flags & OPT_INITONLY) && phase != PHASE_INITIALIZE) {
688 option_error("%s%s cannot be changed after initialization",
692 if ((opt->flags & OPT_PRIV) && !privileged_option) {
693 option_error("using the %s%s requires root privilege",
697 if ((opt->flags & OPT_ENABLE) && *(bool *)(opt->addr2) == 0) {
698 option_error("%s%s is disabled", opt->name, optopt);
701 if ((opt->flags & OPT_DEVEQUIV) && devnam_fixed) {
702 option_error("the %s%s may not be changed in %s",
703 opt->name, optopt, option_source);
709 v = opt->flags & OPT_VALUE;
710 *(bool *)(opt->addr) = v;
711 if (opt->addr2 && (opt->flags & OPT_A2COPY))
712 *(bool *)(opt->addr2) = v;
713 else if (opt->addr2 && (opt->flags & OPT_A2CLR))
714 *(bool *)(opt->addr2) = 0;
715 else if (opt->addr2 && (opt->flags & OPT_A2CLRB))
716 *(u_char *)(opt->addr2) &= ~v;
717 else if (opt->addr2 && (opt->flags & OPT_A2OR))
718 *(u_char *)(opt->addr2) |= v;
723 if ((opt->flags & OPT_NOARG) == 0) {
724 if (!int_option(*argv, &iv))
726 if ((((opt->flags & OPT_LLIMIT) && iv < opt->lower_limit)
727 || ((opt->flags & OPT_ULIMIT) && iv > opt->upper_limit))
728 && !((opt->flags & OPT_ZEROOK && iv == 0))) {
729 char *zok = (opt->flags & OPT_ZEROOK)? " zero or": "";
730 switch (opt->flags & OPT_LIMITS) {
732 option_error("%s value must be%s >= %d",
733 opt->name, zok, opt->lower_limit);
736 option_error("%s value must be%s <= %d",
737 opt->name, zok, opt->upper_limit);
740 option_error("%s value must be%s between %d and %d",
741 opt->name, zok, opt->lower_limit, opt->upper_limit);
747 a = opt->flags & OPT_VALUE;
749 a -= 256; /* sign extend */
751 if (opt->flags & OPT_INC)
752 iv += *(int *)(opt->addr);
753 if ((opt->flags & OPT_NOINCR) && !privileged_option) {
754 int oldv = *(int *)(opt->addr);
755 if ((opt->flags & OPT_ZEROINF) ?
756 (oldv != 0 && (iv == 0 || iv > oldv)) : (iv > oldv)) {
757 option_error("%s value cannot be increased", opt->name);
761 *(int *)(opt->addr) = iv;
762 if (opt->addr2 && (opt->flags & OPT_A2COPY))
763 *(int *)(opt->addr2) = iv;
767 if (opt->flags & OPT_NOARG) {
768 v = opt->flags & OPT_VALUE;
771 } else if (!number_option(*argv, &v, 16))
773 if (opt->flags & OPT_OR)
774 v |= *(u_int32_t *)(opt->addr);
775 *(u_int32_t *)(opt->addr) = v;
776 if (opt->addr2 && (opt->flags & OPT_A2COPY))
777 *(u_int32_t *)(opt->addr2) = v;
781 if (opt->flags & OPT_STATIC) {
782 strlcpy((char *)(opt->addr), *argv, opt->upper_limit);
784 char **optptr = (char **)(opt->addr);
787 novm("option argument");
794 case o_special_noarg:
796 parser = (int (*) __P((char **))) opt->addr;
798 if (!(*parser)(argv))
800 if (opt->flags & OPT_A2LIST) {
801 struct option_value *ovp, *pp;
803 ovp = malloc(sizeof(*ovp) + strlen(*argv));
805 strcpy(ovp->value, *argv);
806 ovp->source = option_source;
808 if (opt->addr2 == NULL) {
811 for (pp = opt->addr2; pp->next != NULL; pp = pp->next)
820 wildp = (int (*) __P((char *, char **, int))) opt->addr;
821 if (!(*wildp)(cmd, argv, 1))
827 * If addr2 wasn't used by any flag (OPT_A2COPY, etc.) but is set,
828 * treat it as a bool and set/clear it based on the OPT_A2CLR bit.
830 if (opt->addr2 && (opt->flags & (OPT_A2COPY|OPT_ENABLE
831 |OPT_A2PRINTER|OPT_A2STRVAL|OPT_A2LIST|OPT_A2OR)) == 0)
832 *(bool *)(opt->addr2) = !(opt->flags & OPT_A2CLR);
834 mainopt->source = option_source;
835 mainopt->priority = prio;
836 mainopt->winner = opt - mainopt;
842 * override_value - if the option priorities would permit us to
843 * override the value of option, return 1 and update the priority
844 * and source of the option value. Otherwise returns 0.
847 override_value(option, priority, source)
854 opt = find_option(option);
857 while (opt->flags & OPT_PRIOSUB)
859 if ((opt->flags & OPT_PRIO) && priority < opt->priority)
861 opt->priority = priority;
862 opt->source = source;
868 * n_arguments - tell how many arguments an option takes
874 return (opt->type == o_bool || opt->type == o_special_noarg
875 || (opt->flags & OPT_NOARG))? 0: 1;
879 * add_options - add a list of options to the set we grok.
885 struct option_list *list;
887 list = malloc(sizeof(*list));
889 novm("option list entry");
891 list->next = extra_options;
892 extra_options = list;
896 * check_options - check that options are valid and consistent.
901 if (logfile_fd >= 0 && logfile_fd != log_to_fd)
906 * print_option - print out an option and its value
909 print_option(opt, mainopt, printer, arg)
910 option_t *opt, *mainopt;
911 printer_func printer;
917 if (opt->flags & OPT_NOPRINT)
921 v = opt->flags & OPT_VALUE;
922 if (*(bool *)opt->addr != v)
923 /* this can happen legitimately, e.g. lock
924 option turned off for default device */
926 printer(arg, "%s", opt->name);
929 v = opt->flags & OPT_VALUE;
932 i = *(int *)opt->addr;
933 if (opt->flags & OPT_NOARG) {
934 printer(arg, "%s", opt->name);
936 if (opt->flags & OPT_INC) {
937 for (; i > v; i -= v)
938 printer(arg, " %s", opt->name);
940 printer(arg, " # oops: %d not %d\n",
944 printer(arg, "%s %d", opt->name, i);
948 printer(arg, "%s", opt->name);
949 if ((opt->flags & OPT_NOARG) == 0)
950 printer(arg, " %x", *(u_int32_t *)opt->addr);
954 if (opt->flags & OPT_HIDE) {
957 p = (char *) opt->addr;
958 if ((opt->flags & OPT_STATIC) == 0)
961 printer(arg, "%s %q", opt->name, p);
965 case o_special_noarg:
967 if (opt->type != o_wild) {
968 printer(arg, "%s", opt->name);
969 if (n_arguments(opt) == 0)
973 if (opt->flags & OPT_A2PRINTER) {
974 void (*oprt) __P((option_t *, printer_func, void *));
975 oprt = (void (*) __P((option_t *, printer_func,
977 (*oprt)(opt, printer, arg);
978 } else if (opt->flags & OPT_A2STRVAL) {
979 p = (char *) opt->addr2;
980 if ((opt->flags & OPT_STATIC) == 0)
983 } else if (opt->flags & OPT_A2LIST) {
984 struct option_value *ovp;
986 ovp = (struct option_value *) opt->addr2;
988 printer(arg, "%q", ovp->value);
989 if ((ovp = ovp->next) == NULL)
991 printer(arg, "\t\t# (from %s)\n%s ",
992 ovp->source, opt->name);
995 printer(arg, "xxx # [don't know how to print value]");
1000 printer(arg, "# %s value (type %d\?\?)", opt->name, opt->type);
1003 printer(arg, "\t\t# (from %s)\n", mainopt->source);
1007 * print_option_list - print out options in effect from an
1011 print_option_list(opt, printer, arg)
1013 printer_func printer;
1016 while (opt->name != NULL) {
1017 if (opt->priority != OPRIO_DEFAULT
1018 && opt->winner != (short int) -1)
1019 print_option(opt + opt->winner, opt, printer, arg);
1022 } while (opt->flags & OPT_PRIOSUB);
1027 * print_options - print out what options are in effect.
1030 print_options(printer, arg)
1031 printer_func printer;
1034 struct option_list *list;
1037 printer(arg, "pppd options in effect:\n");
1038 print_option_list(general_options, printer, arg);
1039 print_option_list(auth_options, printer, arg);
1040 for (list = extra_options; list != NULL; list = list->next)
1041 print_option_list(list->options, printer, arg);
1042 print_option_list(the_channel->options, printer, arg);
1043 for (i = 0; protocols[i] != NULL; ++i)
1044 print_option_list(protocols[i]->options, printer, arg);
1048 * usage - print out a message telling how to use the program.
1053 if (phase == PHASE_INITIALIZE)
1054 fprintf(stderr, usage_string, VERSION, progname);
1058 * showhelp - print out usage message and exit.
1064 if (phase == PHASE_INITIALIZE) {
1072 * showversion - print out the version number and exit.
1078 if (phase == PHASE_INITIALIZE) {
1079 fprintf(stderr, "pppd version %s\n", VERSION);
1086 * option_error - print a message about an error in an option.
1087 * The message is logged, and also sent to
1088 * stderr if phase == PHASE_INITIALIZE.
1091 option_error __V((char *fmt, ...))
1096 #if defined(__STDC__)
1097 va_start(args, fmt);
1101 fmt = va_arg(args, char *);
1103 vslprintf(buf, sizeof(buf), fmt, args);
1105 if (phase == PHASE_INITIALIZE)
1106 fprintf(stderr, "%s: %s\n", progname, buf);
1107 syslog(LOG_ERR, "%s", buf);
1112 * readable - check if a file is readable by the real user.
1125 if (fstat(fd, &sbuf) != 0)
1127 if (sbuf.st_uid == uid)
1128 return sbuf.st_mode & S_IRUSR;
1129 if (sbuf.st_gid == getgid())
1130 return sbuf.st_mode & S_IRGRP;
1131 for (i = 0; i < ngroups; ++i)
1132 if (sbuf.st_gid == groups[i])
1133 return sbuf.st_mode & S_IRGRP;
1134 return sbuf.st_mode & S_IROTH;
1139 * Read a word from a file.
1140 * Words are delimited by white-space or by quotes (" or ').
1141 * Quotes, white-space and \ may be escaped with \.
1142 * \<newline> is ignored.
1145 getword(f, word, newlinep, filename)
1152 int quoted, comment;
1153 int value, digit, got, n;
1155 #define isoctal(c) ((c) >= '0' && (c) < '8')
1164 * First skip white-space and comments.
1172 * A newline means the end of a comment; backslash-newline
1173 * is ignored. Note that we cannot have escape && comment.
1185 * Ignore characters other than newline in a comment.
1191 * If this character is escaped, we have a word start.
1197 * If this is the escape character, look at the next character.
1205 * If this is the start of a comment, ignore the rest of the line.
1213 * A non-whitespace character is the start of a word.
1220 * Process characters until the end of the word.
1225 * This character is escaped: backslash-newline is ignored,
1226 * various other characters indicate particular values
1227 * as for C backslash-escapes.
1262 * \ddd octal sequence
1265 for (n = 0; n < 3 && isoctal(c); ++n) {
1266 value = (value << 3) + (c & 07);
1275 * \x<hex_string> sequence
1279 for (n = 0; n < 2 && isxdigit(c); ++n) {
1280 digit = toupper(c) - '0';
1282 digit += '0' + 10 - 'A';
1283 value = (value << 4) + digit;
1291 * Otherwise the character stands for itself.
1298 * Store the resulting character for the escape sequence.
1300 if (len < MAXWORDLEN) {
1311 * Backslash starts a new escape sequence.
1320 * Not escaped: check for the start or end of a quoted
1321 * section and see if we've reached the end of the word.
1329 } else if (c == '"' || c == '\'') {
1333 } else if (isspace(c) || c == '#') {
1339 * An ordinary character: store it in the word and get another.
1341 if (len < MAXWORDLEN) {
1350 * End of the word: check for errors.
1356 option_error("Error reading %s: %m", filename);
1360 * If len is zero, then we didn't find a word before the
1366 option_error("warning: quoted word runs to end of file (%.20s...)",
1371 * Warn if the word was too long, and append a terminating null.
1373 if (len >= MAXWORDLEN) {
1374 option_error("warning: word in file %s too long (%.20s...)",
1376 len = MAXWORDLEN - 1;
1387 * number_option - parse an unsigned numeric parameter for an option.
1390 number_option(str, valp, base)
1397 *valp = strtoul(str, &ptr, base);
1399 option_error("invalid numeric parameter '%s' for %s option",
1400 str, current_option);
1408 * int_option - like number_option, but valp is int *,
1409 * the base is assumed to be 0, and *valp is not changed
1410 * if there is an error.
1413 int_option(str, valp)
1419 if (!number_option(str, &v, 0))
1427 * The following procedures parse options.
1431 * readfile - take commands from a file.
1437 return options_from_file(*argv, 1, 1, privileged_option);
1441 * callfile - take commands from /etc/ppp/peers/<name>.
1442 * Name may not contain /../, start with / or ../, or end in /..
1448 char *fname, *arg, *p;
1453 if (arg[0] == '/' || arg[0] == 0)
1456 for (p = arg; *p != 0; ) {
1457 if (p[0] == '.' && p[1] == '.' && (p[2] == '/' || p[2] == 0)) {
1461 while (*p != '/' && *p != 0)
1468 option_error("call option value may not contain .. or start with /");
1472 l = strlen(arg) + strlen(_PATH_PEERFILES) + 1;
1473 if ((fname = (char *) malloc(l)) == NULL)
1474 novm("call file name");
1475 slprintf(fname, l, "%s%s", _PATH_PEERFILES, arg);
1477 ok = options_from_file(fname, 1, 1, 1);
1485 * setpassfilter - Set the pass filter for packets
1494 pc = pcap_open_dead(DLT_PPP_PPPD, 65535);
1495 if (pcap_compile(pc, &pass_filter, *argv, 1, netmask) == -1) {
1496 option_error("error in pass-filter expression: %s\n",
1506 * setactivefilter - Set the active filter for packets
1509 setactivefilter(argv)
1515 pc = pcap_open_dead(DLT_PPP_PPPD, 65535);
1516 if (pcap_compile(pc, &active_filter, *argv, 1, netmask) == -1) {
1517 option_error("error in active-filter expression: %s\n",
1528 * setdomain - Set domain name to append to hostname
1534 gethostname(hostname, MAXNAMELEN);
1537 strncat(hostname, ".", MAXNAMELEN - strlen(hostname));
1538 domain = hostname + strlen(hostname);
1539 strncat(hostname, *argv, MAXNAMELEN - strlen(hostname));
1541 hostname[MAXNAMELEN-1] = 0;
1553 if (!privileged_option && seteuid(getuid()) == -1) {
1554 option_error("unable to drop permissions to open %s: %m", *argv);
1557 fd = open(*argv, O_WRONLY | O_APPEND | O_CREAT | O_EXCL, 0644);
1558 if (fd < 0 && errno == EEXIST)
1559 fd = open(*argv, O_WRONLY | O_APPEND);
1561 if (!privileged_option && seteuid(euid) == -1)
1562 fatal("unable to regain privileges: %m");
1565 option_error("Can't open log file %s: %m", *argv);
1568 strlcpy(logfile_name, *argv, sizeof(logfile_name));
1569 if (logfile_fd >= 0)
1584 if(!strcmp(*argv,"in")) {
1585 maxoctets_dir = PPP_OCTETS_DIRECTION_IN;
1586 } else if (!strcmp(*argv,"out")) {
1587 maxoctets_dir = PPP_OCTETS_DIRECTION_OUT;
1588 } else if (!strcmp(*argv,"max")) {
1589 maxoctets_dir = PPP_OCTETS_DIRECTION_MAXOVERAL;
1591 maxoctets_dir = PPP_OCTETS_DIRECTION_SUM;
1605 void (*init) __P((void));
1609 if (strchr(arg, '/') == 0) {
1610 const char *base = _PATH_PLUGIN;
1611 int l = strlen(base) + strlen(arg) + 2;
1614 novm("plugin file path");
1615 strlcpy(path, base, l);
1616 strlcat(path, "/", l);
1617 strlcat(path, arg, l);
1619 handle = dlopen(path, RTLD_GLOBAL | RTLD_NOW);
1623 option_error("%s", err);
1624 option_error("Couldn't load plugin %s", arg);
1627 init = (void (*)(void))dlsym(handle, "plugin_init");
1629 option_error("%s has no initialization entry point", arg);
1632 vers = (const char *) dlsym(handle, "pppd_version");
1634 warn("Warning: plugin %s has no version information", arg);
1635 } else if (strcmp(vers, VERSION) != 0) {
1636 option_error("Plugin %s is for pppd version %s, this is %s",
1637 arg, vers, VERSION);
1640 info("Plugin %s loaded.", arg);
1654 * Set an environment variable specified by the user.
1660 char *arg = argv[0];
1662 struct userenv *uep, **insp;
1664 if ((eqp = strchr(arg, '=')) == NULL) {
1665 option_error("missing = in name=value: %s", arg);
1669 option_error("missing variable name: %s", arg);
1672 for (uep = userenv_list; uep != NULL; uep = uep->ue_next) {
1673 int nlen = strlen(uep->ue_name);
1674 if (nlen == (eqp - arg) &&
1675 strncmp(arg, uep->ue_name, nlen) == 0)
1678 /* Ignore attempts by unprivileged users to override privileged sources */
1679 if (uep != NULL && !privileged_option && uep->ue_priv)
1681 /* The name never changes, so allocate it with the structure */
1683 uep = malloc(sizeof (*uep) + (eqp-arg));
1684 strncpy(uep->ue_name, arg, eqp-arg);
1685 uep->ue_name[eqp-arg] = '\0';
1686 uep->ue_next = NULL;
1687 insp = &userenv_list;
1688 while (*insp != NULL)
1689 insp = &(*insp)->ue_next;
1692 struct userenv *uep2;
1693 for (uep2 = userenv_list; uep2 != NULL; uep2 = uep2->ue_next) {
1694 if (uep2 != uep && !uep2->ue_isset)
1697 if (uep2 == NULL && !uep->ue_isset)
1698 find_option("unset")->flags |= OPT_NOPRINT;
1699 free(uep->ue_value);
1702 uep->ue_priv = privileged_option;
1703 uep->ue_source = option_source;
1704 uep->ue_value = strdup(eqp + 1);
1705 curopt->flags &= ~OPT_NOPRINT;
1710 user_setprint(opt, printer, arg)
1712 printer_func printer;
1715 struct userenv *uep, *uepnext;
1717 uepnext = userenv_list;
1718 while (uepnext != NULL && !uepnext->ue_isset)
1719 uepnext = uepnext->ue_next;
1720 while ((uep = uepnext) != NULL) {
1721 uepnext = uep->ue_next;
1722 while (uepnext != NULL && !uepnext->ue_isset)
1723 uepnext = uepnext->ue_next;
1724 (*printer)(arg, "%s=%s", uep->ue_name, uep->ue_value);
1725 if (uepnext != NULL)
1726 (*printer)(arg, "\t\t# (from %s)\n%s ", uep->ue_source, opt->name);
1728 opt->source = uep->ue_source;
1736 struct userenv *uep, **insp;
1737 char *arg = argv[0];
1739 if (strchr(arg, '=') != NULL) {
1740 option_error("unexpected = in name: %s", arg);
1744 option_error("missing variable name for unset");
1747 for (uep = userenv_list; uep != NULL; uep = uep->ue_next) {
1748 if (strcmp(arg, uep->ue_name) == 0)
1751 /* Ignore attempts by unprivileged users to override privileged sources */
1752 if (uep != NULL && !privileged_option && uep->ue_priv)
1754 /* The name never changes, so allocate it with the structure */
1756 uep = malloc(sizeof (*uep) + strlen(arg));
1757 strcpy(uep->ue_name, arg);
1758 uep->ue_next = NULL;
1759 insp = &userenv_list;
1760 while (*insp != NULL)
1761 insp = &(*insp)->ue_next;
1764 struct userenv *uep2;
1765 for (uep2 = userenv_list; uep2 != NULL; uep2 = uep2->ue_next) {
1766 if (uep2 != uep && uep2->ue_isset)
1769 if (uep2 == NULL && uep->ue_isset)
1770 find_option("set")->flags |= OPT_NOPRINT;
1771 free(uep->ue_value);
1774 uep->ue_priv = privileged_option;
1775 uep->ue_source = option_source;
1776 uep->ue_value = NULL;
1777 curopt->flags &= ~OPT_NOPRINT;
1782 user_unsetprint(opt, printer, arg)
1784 printer_func printer;
1787 struct userenv *uep, *uepnext;
1789 uepnext = userenv_list;
1790 while (uepnext != NULL && uepnext->ue_isset)
1791 uepnext = uepnext->ue_next;
1792 while ((uep = uepnext) != NULL) {
1793 uepnext = uep->ue_next;
1794 while (uepnext != NULL && uepnext->ue_isset)
1795 uepnext = uepnext->ue_next;
1796 (*printer)(arg, "%s", uep->ue_name);
1797 if (uepnext != NULL)
1798 (*printer)(arg, "\t\t# (from %s)\n%s ", uep->ue_source, opt->name);
1800 opt->source = uep->ue_source;