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.
57 #include <sys/param.h>
59 #ifdef PPP_WITH_PLUGINS
63 #ifdef PPP_WITH_FILTER
66 * There have been 3 or 4 different names for this in libpcap CVS, but
67 * this seems to be what they have settled on...
68 * For older versions of libpcap, use DLT_PPP - but that means
69 * we lose the inbound and outbound qualifiers.
72 #ifdef DLT_PPP_WITHDIRECTION
73 #define DLT_PPP_PPPD DLT_PPP_WITHDIRECTION
75 #define DLT_PPP_PPPD DLT_PPP
78 #endif /* PPP_WITH_FILTER */
80 #include "pppd-private.h"
83 #include "pathnames.h"
85 #if defined(ultrix) || defined(NeXT)
91 struct option_value *next;
97 * Option variables and default values.
99 int debug = 0; /* Debug flag */
100 int kdebugflag = 0; /* Tell kernel to print debug messages */
101 int default_device = 1; /* Using /dev/tty or equivalent */
102 bool nodetach = 0; /* Don't detach from controlling tty */
103 bool updetach = 0; /* Detach once link is up */
104 bool master_detach; /* Detach when we're (only) multilink master */
106 bool up_sdnotify = 0; /* Notify systemd once link is up */
108 int maxconnect = 0; /* Maximum connect time */
109 char user[MAXNAMELEN]; /* Username for PAP */
110 char passwd[MAXSECRETLEN]; /* Password for PAP */
111 bool persist = 0; /* Reopen link after it goes down */
112 char our_name[MAXNAMELEN]; /* Our name for authentication purposes */
113 bool demand = 0; /* do dial-on-demand */
114 int idle_time_limit = 0; /* Disconnect if idle for this many seconds */
115 int holdoff = 30; /* # seconds to pause before reconnecting */
116 bool holdoff_specified; /* true if a holdoff value has been given */
117 int log_to_fd = 1; /* send log messages to this fd too */
118 bool log_default = 1; /* log_to_fd is default (stdout) */
119 int maxfail = 10; /* max # of unsuccessful connection attempts */
120 char linkname[MAXPATHLEN]; /* logical name for link */
121 bool tune_kernel; /* may alter kernel settings */
122 int connect_delay = 1000; /* wait this many ms after connect script */
123 int req_unit = -1; /* requested interface unit */
124 char path_ipup[MAXPATHLEN]; /* pathname of ip-up script */
125 char path_ipdown[MAXPATHLEN];/* pathname of ip-down script */
126 char req_ifname[IFNAMSIZ]; /* requested interface name */
127 bool multilink = 0; /* Enable multilink operation */
128 char *bundle_name = NULL; /* bundle name for multilink */
129 bool dump_options; /* print out option values */
130 bool show_options; /* print all supported options and exit */
131 bool dryrun; /* print out option values and exit */
132 char *domain; /* domain name set by domain option */
133 int child_wait = 5; /* # seconds to wait for children at exit */
134 struct userenv *userenv_list; /* user environment variables */
135 int dfl_route_metric = -1; /* metric of the default route to set over the PPP link */
137 #ifdef PPP_WITH_IPV6CP
138 char path_ipv6up[MAXPATHLEN]; /* pathname of ipv6-up script */
139 char path_ipv6down[MAXPATHLEN]; /* pathname of ipv6-down script */
142 unsigned int maxoctets = 0; /* default - no limit */
143 session_limit_dir_t maxoctets_dir = PPP_OCTETS_DIRECTION_SUM; /* default - sum of traffic */
144 int maxoctets_timeout = 1; /* default 1 second */
147 extern struct option auth_options[];
148 extern struct stat devstat;
150 #ifdef PPP_WITH_FILTER
151 struct bpf_program pass_filter;/* Filter program for packets to pass */
152 struct bpf_program active_filter; /* Filter program for link-active pkts */
155 static struct option *curopt; /* pointer to option being processed */
156 char *current_option; /* the name of the option being parsed */
157 int privileged_option; /* set iff the current option came from root */
158 char *option_source; /* string saying where the option came from */
159 int option_priority = OPRIO_CFGFILE; /* priority of the current options */
160 bool devnam_fixed; /* can no longer change device name */
162 static int logfile_fd = -1; /* fd opened for log file */
163 static char logfile_name[MAXPATHLEN]; /* name of log file */
165 static bool noipx_opt; /* dummy for noipx option */
170 static int setdomain(char **);
171 static int readfile(char **);
172 static int callfile(char **);
173 static int showversion(char **);
174 static int showhelp(char **);
175 static void usage(void);
176 static int setlogfile(char **);
177 #ifdef PPP_WITH_PLUGINS
178 static int loadplugin(char **);
181 #ifdef PPP_WITH_FILTER
182 static int setpassfilter(char **);
183 static int setactivefilter(char **);
186 static int setmodir(char **);
188 static int user_setenv(char **);
189 static void user_setprint(struct option *, printer_func, void *);
190 static int user_unsetenv(char **);
191 static void user_unsetprint(struct option *, printer_func, void *);
193 static struct option *find_option(char *name);
194 static int process_option(struct option *, char *, char **);
195 static int n_arguments(struct option *);
196 static int number_option(char *, u_int32_t *, int);
199 * Structure to store extra lists of options.
202 struct option *options;
203 struct option_list *next;
206 static struct option_list *extra_options = NULL;
211 struct option general_options[] = {
212 { "debug", o_int, &debug,
213 "Increase debugging level", OPT_INC | OPT_NOARG | 1 },
214 { "-d", o_int, &debug,
215 "Increase debugging level",
216 OPT_ALIAS | OPT_INC | OPT_NOARG | 1 },
218 { "kdebug", o_int, &kdebugflag,
219 "Set kernel driver debug level", OPT_PRIO },
221 { "nodetach", o_bool, &nodetach,
222 "Don't detach from controlling tty", OPT_PRIO | 1 },
223 { "-detach", o_bool, &nodetach,
224 "Don't detach from controlling tty", OPT_ALIAS | OPT_PRIOSUB | 1 },
226 { "up_sdnotify", o_bool, &up_sdnotify,
227 "Notify systemd once link is up (implies nodetach)",
228 OPT_PRIOSUB | OPT_A2COPY | 1, &nodetach },
230 { "updetach", o_bool, &updetach,
231 "Detach from controlling tty once link is up",
232 OPT_PRIOSUB | OPT_A2CLR | 1, &nodetach },
234 { "master_detach", o_bool, &master_detach,
235 "Detach when we're multilink master but have no link", 1 },
237 { "holdoff", o_int, &holdoff,
238 "Set time in seconds before retrying connection",
239 OPT_PRIO, &holdoff_specified },
241 { "idle", o_int, &idle_time_limit,
242 "Set time in seconds before disconnecting idle link", OPT_PRIO },
244 { "maxconnect", o_int, &maxconnect,
245 "Set connection time limit",
246 OPT_PRIO | OPT_LLIMIT | OPT_NOINCR | OPT_ZEROINF },
248 { "domain", o_special, (void *)setdomain,
249 "Add given domain name to hostname",
250 OPT_PRIO | OPT_PRIV | OPT_A2STRVAL, &domain },
252 { "file", o_special, (void *)readfile,
253 "Take options from a file", OPT_NOPRINT },
254 { "call", o_special, (void *)callfile,
255 "Take options from a privileged file", OPT_NOPRINT },
257 { "persist", o_bool, &persist,
258 "Keep on reopening connection after close", OPT_PRIO | 1 },
259 { "nopersist", o_bool, &persist,
260 "Turn off persist option", OPT_PRIOSUB },
262 { "demand", o_bool, &demand,
263 "Dial on demand", OPT_INITONLY | 1, &persist },
265 { "--version", o_special_noarg, (void *)showversion,
266 "Show version number" },
267 { "-v", o_special_noarg, (void *)showversion,
268 "Show version number" },
269 { "show-options", o_bool, &show_options,
270 "Show all options and exit", 1 },
271 { "--help", o_special_noarg, (void *)showhelp,
272 "Show brief listing of options" },
273 { "-h", o_special_noarg, (void *)showhelp,
274 "Show brief listing of options", OPT_ALIAS },
276 { "logfile", o_special, (void *)setlogfile,
277 "Append log messages to this file",
278 OPT_PRIO | OPT_A2STRVAL | OPT_STATIC, &logfile_name },
279 { "logfd", o_int, &log_to_fd,
280 "Send log messages to this file descriptor",
281 OPT_PRIOSUB | OPT_A2CLR, &log_default },
282 { "nolog", o_int, &log_to_fd,
283 "Don't send log messages to any file",
284 OPT_PRIOSUB | OPT_NOARG | OPT_VAL(-1) },
285 { "nologfd", o_int, &log_to_fd,
286 "Don't send log messages to any file descriptor",
287 OPT_PRIOSUB | OPT_ALIAS | OPT_NOARG | OPT_VAL(-1) },
289 { "linkname", o_string, linkname,
290 "Set logical name for link",
291 OPT_PRIO | OPT_PRIV | OPT_STATIC, NULL, MAXPATHLEN },
293 { "maxfail", o_int, &maxfail,
294 "Maximum number of unsuccessful connection attempts to allow",
297 { "ktune", o_bool, &tune_kernel,
298 "Alter kernel settings as necessary", OPT_PRIO | 1 },
299 { "noktune", o_bool, &tune_kernel,
300 "Don't alter kernel settings", OPT_PRIOSUB },
302 { "connect-delay", o_int, &connect_delay,
303 "Maximum time (in ms) to wait after connect script finishes",
306 { "unit", o_int, &req_unit,
307 "PPP interface unit number to use if possible",
308 OPT_PRIO | OPT_LLIMIT, 0, 0 },
310 { "ifname", o_string, req_ifname,
311 "Set PPP interface name",
312 OPT_PRIO | OPT_PRIV | OPT_STATIC, NULL, IFNAMSIZ },
314 { "dump", o_bool, &dump_options,
315 "Print out option values after parsing all options", 1 },
316 { "dryrun", o_bool, &dryrun,
317 "Stop after parsing, printing, and checking options", 1 },
319 { "child-timeout", o_int, &child_wait,
320 "Number of seconds to wait for child processes at exit",
323 { "set", o_special, (void *)user_setenv,
324 "Set user environment variable",
325 OPT_A2PRINTER | OPT_NOPRINT, (void *)user_setprint },
326 { "unset", o_special, (void *)user_unsetenv,
327 "Unset user environment variable",
328 OPT_A2PRINTER | OPT_NOPRINT, (void *)user_unsetprint },
330 { "defaultroute-metric", o_int, &dfl_route_metric,
331 "Metric to use for the default route (Linux only; -1 for default behavior)",
332 OPT_PRIV|OPT_LLIMIT|OPT_INITONLY, NULL, 0, -1 },
334 { "ip-up-script", o_string, path_ipup,
335 "Set pathname of ip-up script",
336 OPT_PRIV|OPT_STATIC, NULL, MAXPATHLEN },
337 { "ip-down-script", o_string, path_ipdown,
338 "Set pathname of ip-down script",
339 OPT_PRIV|OPT_STATIC, NULL, MAXPATHLEN },
341 #ifdef PPP_WITH_IPV6CP
342 { "ipv6-up-script", o_string, path_ipv6up,
343 "Set pathname of ipv6-up script",
344 OPT_PRIV|OPT_STATIC, NULL, MAXPATHLEN },
345 { "ipv6-down-script", o_string, path_ipv6down,
346 "Set pathname of ipv6-down script",
347 OPT_PRIV|OPT_STATIC, NULL, MAXPATHLEN },
350 #ifdef PPP_WITH_MULTILINK
351 { "multilink", o_bool, &multilink,
352 "Enable multilink operation", OPT_PRIO | 1 },
353 { "mp", o_bool, &multilink,
354 "Enable multilink operation", OPT_PRIOSUB | OPT_ALIAS | 1 },
355 { "nomultilink", o_bool, &multilink,
356 "Disable multilink operation", OPT_PRIOSUB | 0 },
357 { "nomp", o_bool, &multilink,
358 "Disable multilink operation", OPT_PRIOSUB | OPT_ALIAS | 0 },
360 { "bundle", o_string, &bundle_name,
361 "Bundle name for multilink", OPT_PRIO },
362 #endif /* PPP_WITH_MULTILINK */
364 #ifdef PPP_WITH_PLUGINS
365 { "plugin", o_special, (void *)loadplugin,
366 "Load a plug-in module into pppd", OPT_PRIV | OPT_A2LIST },
369 #ifdef PPP_WITH_FILTER
370 { "pass-filter", o_special, setpassfilter,
371 "set filter for packets to pass", OPT_PRIO },
373 { "active-filter", o_special, setactivefilter,
374 "set filter for active pkts", OPT_PRIO },
377 { "maxoctets", o_int, &maxoctets,
378 "Set connection traffic limit",
379 OPT_PRIO | OPT_LLIMIT | OPT_NOINCR | OPT_ZEROINF },
380 { "mo", o_int, &maxoctets,
381 "Set connection traffic limit",
382 OPT_ALIAS | OPT_PRIO | OPT_LLIMIT | OPT_NOINCR | OPT_ZEROINF },
383 { "mo-direction", o_special, setmodir,
384 "Set direction for limit traffic (sum,in,out,max)" },
385 { "mo-timeout", o_int, &maxoctets_timeout,
386 "Check for traffic limit every N seconds", OPT_PRIO | OPT_LLIMIT | 1 },
388 /* Dummy option, does nothing */
389 { "noipx", o_bool, &noipx_opt, NULL, OPT_NOPRINT | 1 },
394 #ifndef IMPLEMENTATION
395 #define IMPLEMENTATION ""
399 ppp_get_max_idle_time()
401 return idle_time_limit;
405 ppp_set_max_idle_time(unsigned int max)
407 idle_time_limit = max;
411 ppp_get_max_connect_time()
417 ppp_set_max_connect_time(unsigned int max)
423 ppp_set_session_limit(unsigned int octets)
429 ppp_set_session_limit_dir(unsigned int dir)
432 dir = PPP_OCTETS_DIRECTION_SUM;
433 maxoctets_dir = (session_limit_dir_t) dir;
443 ppp_get_path(ppp_path_t type, char *buf, size_t bufsz)
447 if (buf && bufsz > 0) {
450 path = PPP_PATH_VARLOG;
452 case PPP_DIR_RUNTIME:
453 path = PPP_PATH_VARRUN;
456 path = PPP_PATH_PLUGIN;
459 path = PPP_PATH_CONFDIR;
462 return strlcpy(buf, path, bufsz);
468 ppp_get_filepath(ppp_path_t type, const char *name, char *buf, size_t bufsz)
472 if (buf && bufsz > 0) {
475 path = PPP_PATH_VARLOG;
477 case PPP_DIR_RUNTIME:
478 path = PPP_PATH_VARRUN;
481 path = PPP_PATH_PLUGIN;
484 path = PPP_PATH_CONFDIR;
487 return slprintf(buf, bufsz, "%s/%s", path, name);
498 * parse_args - parse a string of arguments from the command line.
501 parse_args(int argc, char **argv)
507 privileged_option = privileged;
508 option_source = "command line";
509 option_priority = OPRIO_CMDLINE;
513 opt = find_option(arg);
515 ppp_option_error("unrecognized option '%s'", arg);
519 n = n_arguments(opt);
521 ppp_option_error("too few parameters for option %s", arg);
524 if (!process_option(opt, arg, argv))
533 * options_from_file - Read a string of options from a file,
534 * and interpret them.
537 ppp_options_from_file(char *filename, int must_exist, int check_prot, int priv)
540 int i, newline, ret, err;
546 char args[MAXARGS][MAXWORDLEN];
547 char cmd[MAXWORDLEN];
550 if (check_prot && seteuid(getuid()) == -1) {
551 ppp_option_error("unable to drop privileges to open %s: %m", filename);
554 f = fopen(filename, "r");
556 if (check_prot && seteuid(euid) == -1)
557 fatal("unable to regain privileges");
561 if (err != ENOENT && err != ENOTDIR)
562 warn("Warning: can't open options file %s: %m", filename);
565 ppp_option_error("Can't open options file %s: %m", filename);
569 oldpriv = privileged_option;
570 privileged_option = priv;
571 oldsource = option_source;
572 option_source = strdup(filename);
573 if (option_source == NULL)
574 option_source = "file";
576 while (getword(f, cmd, &newline, filename)) {
577 opt = find_option(cmd);
579 ppp_option_error("In file %s: unrecognized option '%s'",
583 n = n_arguments(opt);
584 for (i = 0; i < n; ++i) {
585 if (!getword(f, args[i], &newline, filename)) {
587 "In file %s: too few parameters for option '%s'",
593 if (!process_option(opt, cmd, argv))
600 privileged_option = oldpriv;
601 option_source = oldsource;
606 * options_from_user - See if the use has a ~/.ppprc file,
607 * and if so, interpret options from it.
610 options_from_user(void)
612 char *user, *path, *file;
617 pw = getpwuid(getuid());
618 if (pw == NULL || (user = pw->pw_dir) == NULL || user[0] == 0)
620 file = PPP_PATH_USEROPT;
621 pl = strlen(user) + strlen(file) + 2;
624 novm("init file name");
625 slprintf(path, pl, "%s/%s", user, file);
626 option_priority = OPRIO_CFGFILE;
627 ret = ppp_options_from_file(path, 0, 1, privileged);
633 * options_for_tty - See if an options file exists for the serial
634 * device, and if so, interpret options from it.
635 * We only allow the per-tty options file to override anything from
636 * the command line if it is something that the user can't override
637 * once it has been set by root; this is done by giving configuration
638 * files a lower priority than the command line.
641 options_for_tty(void)
643 char *dev, *path, *p;
648 if ((p = strstr(dev, "/dev/")) != NULL)
650 if (dev[0] == 0 || strcmp(dev, "tty") == 0)
651 return 1; /* don't look for /etc/ppp/options.tty */
652 pl = strlen(PPP_PATH_TTYOPT) + strlen(dev) + 1;
655 novm("tty init file name");
656 slprintf(path, pl, "%s%s", PPP_PATH_TTYOPT, dev);
657 /* Turn slashes into dots, for Solaris case (e.g. /dev/term/a) */
658 for (p = path + strlen(PPP_PATH_TTYOPT); *p != 0; ++p)
661 option_priority = OPRIO_CFGFILE;
662 ret = ppp_options_from_file(path, 0, 0, 1);
668 * options_from_list - process a string of options in a wordlist.
671 options_from_list(struct wordlist *w, int priv)
678 privileged_option = priv;
679 option_source = "secrets file";
680 option_priority = OPRIO_SECFILE;
683 opt = find_option(w->word);
685 ppp_option_error("In secrets file: unrecognized option '%s'",
689 n = n_arguments(opt);
691 for (i = 0; i < n; ++i) {
695 "In secrets file: too few parameters for option '%s'",
701 if (!process_option(opt, w0->word, argv))
712 * match_option - see if this option matches an option structure.
715 match_option(char *name, struct option *opt, int dowild)
717 int (*match)(char *, char **, int);
719 if (dowild != (opt->type == o_wild))
722 return strcmp(name, opt->name) == 0;
723 match = (int (*)(char *, char **, int)) opt->addr;
724 return (*match)(name, NULL, 0);
728 * find_option - scan the option lists for the various protocols
729 * looking for an entry with the given name.
730 * This could be optimized by using a hash table.
732 static struct option *
733 find_option(char *name)
736 struct option_list *list;
739 for (dowild = 0; dowild <= 1; ++dowild) {
740 for (opt = general_options; opt->name != NULL; ++opt)
741 if (match_option(name, opt, dowild))
743 for (opt = auth_options; opt->name != NULL; ++opt)
744 if (match_option(name, opt, dowild))
746 for (list = extra_options; list != NULL; list = list->next)
747 for (opt = list->options; opt->name != NULL; ++opt)
748 if (match_option(name, opt, dowild))
750 for (opt = the_channel->options; opt->name != NULL; ++opt)
751 if (match_option(name, opt, dowild))
753 for (i = 0; protocols[i] != NULL; ++i)
754 if ((opt = protocols[i]->options) != NULL)
755 for (; opt->name != NULL; ++opt)
756 if (match_option(name, opt, dowild))
763 * process_option - process one new-style option.
766 process_option(struct option *opt, char *cmd, char **argv)
771 int (*parser)(char **);
772 int (*wildp)(char *, char **, int);
773 char *optopt = (opt->type == o_wild)? "": " option";
774 int prio = option_priority;
775 struct option *mainopt = opt;
777 current_option = opt->name;
778 if ((opt->flags & OPT_PRIVFIX) && privileged_option)
780 while (mainopt->flags & OPT_PRIOSUB)
782 if (mainopt->flags & OPT_PRIO) {
783 if (prio < mainopt->priority) {
784 /* new value doesn't override old */
785 if (prio == OPRIO_CMDLINE && mainopt->priority > OPRIO_ROOT) {
786 ppp_option_error("%s%s set in %s cannot be overridden\n",
787 opt->name, optopt, mainopt->source);
792 if (prio > OPRIO_ROOT && mainopt->priority == OPRIO_CMDLINE)
793 warn("%s%s from %s overrides command line",
794 opt->name, optopt, option_source);
797 if ((opt->flags & OPT_INITONLY) && !in_phase(PHASE_INITIALIZE)) {
798 ppp_option_error("%s%s cannot be changed after initialization",
802 if ((opt->flags & OPT_PRIV) && !privileged_option) {
803 ppp_option_error("using the %s%s requires root privilege",
807 if ((opt->flags & OPT_ENABLE) && *(bool *)(opt->addr2) == 0) {
808 ppp_option_error("%s%s is disabled", opt->name, optopt);
811 if ((opt->flags & OPT_DEVEQUIV) && devnam_fixed) {
812 ppp_option_error("the %s%s may not be changed in %s",
813 opt->name, optopt, option_source);
819 v = opt->flags & OPT_VALUE;
820 *(bool *)(opt->addr) = v;
821 if (opt->addr2 && (opt->flags & OPT_A2COPY))
822 *(bool *)(opt->addr2) = v;
823 else if (opt->addr2 && (opt->flags & OPT_A2CLR))
824 *(bool *)(opt->addr2) = 0;
825 else if (opt->addr2 && (opt->flags & OPT_A2CLRB))
826 *(u_char *)(opt->addr2) &= ~v;
827 else if (opt->addr2 && (opt->flags & OPT_A2OR))
828 *(u_char *)(opt->addr2) |= v;
833 if ((opt->flags & OPT_NOARG) == 0) {
834 if (!ppp_int_option(*argv, &iv))
836 if ((((opt->flags & OPT_LLIMIT) && iv < opt->lower_limit)
837 || ((opt->flags & OPT_ULIMIT) && iv > opt->upper_limit))
838 && !((opt->flags & OPT_ZEROOK && iv == 0))) {
839 char *zok = (opt->flags & OPT_ZEROOK)? " zero or": "";
840 switch (opt->flags & OPT_LIMITS) {
842 ppp_option_error("%s value must be%s >= %d",
843 opt->name, zok, opt->lower_limit);
846 ppp_option_error("%s value must be%s <= %d",
847 opt->name, zok, opt->upper_limit);
850 ppp_option_error("%s value must be%s between %d and %d",
851 opt->name, zok, opt->lower_limit, opt->upper_limit);
857 a = opt->flags & OPT_VALUE;
859 a -= 256; /* sign extend */
861 if (opt->flags & OPT_INC)
862 iv += *(int *)(opt->addr);
863 if ((opt->flags & OPT_NOINCR) && !privileged_option) {
864 int oldv = *(int *)(opt->addr);
865 if ((opt->flags & OPT_ZEROINF) ?
866 (oldv != 0 && (iv == 0 || iv > oldv)) : (iv > oldv)) {
867 ppp_option_error("%s value cannot be increased", opt->name);
871 *(int *)(opt->addr) = iv;
872 if (opt->addr2 && (opt->flags & OPT_A2COPY))
873 *(int *)(opt->addr2) = iv;
877 if (opt->flags & OPT_NOARG) {
878 v = opt->flags & OPT_VALUE;
881 } else if (!number_option(*argv, &v, 16))
883 if (opt->flags & OPT_OR)
884 v |= *(u_int32_t *)(opt->addr);
885 *(u_int32_t *)(opt->addr) = v;
886 if (opt->addr2 && (opt->flags & OPT_A2COPY))
887 *(u_int32_t *)(opt->addr2) = v;
891 if (opt->flags & OPT_STATIC) {
892 strlcpy((char *)(opt->addr), *argv, opt->upper_limit);
894 char **optptr = (char **)(opt->addr);
897 novm("option argument");
902 /* obfuscate original argument for things like password */
903 if (opt->flags & OPT_HIDE) {
904 memset(*argv, '?', strlen(*argv));
909 case o_special_noarg:
911 parser = (int (*)(char **)) opt->addr;
913 if (!(*parser)(argv))
915 if (opt->flags & OPT_A2LIST) {
916 struct option_value *ovp, *pp;
918 ovp = malloc(sizeof(*ovp) + strlen(*argv));
920 strcpy(ovp->value, *argv);
921 ovp->source = option_source;
923 if (opt->addr2 == NULL) {
926 for (pp = opt->addr2; pp->next != NULL; pp = pp->next)
935 wildp = (int (*)(char *, char **, int)) opt->addr;
936 if (!(*wildp)(cmd, argv, 1))
942 * If addr2 wasn't used by any flag (OPT_A2COPY, etc.) but is set,
943 * treat it as a bool and set/clear it based on the OPT_A2CLR bit.
945 if (opt->addr2 && (opt->flags & (OPT_A2COPY|OPT_ENABLE
946 |OPT_A2PRINTER|OPT_A2STRVAL|OPT_A2LIST|OPT_A2OR)) == 0)
947 *(bool *)(opt->addr2) = !(opt->flags & OPT_A2CLR);
949 mainopt->source = option_source;
950 mainopt->priority = prio;
951 mainopt->winner = opt - mainopt;
957 * override_value - if the option priorities would permit us to
958 * override the value of option, return 1 and update the priority
959 * and source of the option value. Otherwise returns 0.
962 override_value(char *option, int priority, const char *source)
966 opt = find_option(option);
969 while (opt->flags & OPT_PRIOSUB)
971 if ((opt->flags & OPT_PRIO) && priority < opt->priority)
973 opt->priority = priority;
974 opt->source = source;
980 * n_arguments - tell how many arguments an option takes
983 n_arguments(struct option *opt)
985 return (opt->type == o_bool || opt->type == o_special_noarg
986 || (opt->flags & OPT_NOARG))? 0: 1;
990 * add_options - add a list of options to the set we grok.
993 ppp_add_options(struct option *opt)
995 struct option_list *list;
997 list = malloc(sizeof(*list));
999 novm("option list entry");
1000 list->options = opt;
1001 list->next = extra_options;
1002 extra_options = list;
1006 * check_options - check that options are valid and consistent.
1011 if (logfile_fd >= 0 && logfile_fd != log_to_fd)
1016 * print_option - print out an option and its value
1019 print_option(struct option *opt, struct option *mainopt, printer_func printer, void *arg)
1024 if (opt->flags & OPT_NOPRINT)
1026 switch (opt->type) {
1028 v = opt->flags & OPT_VALUE;
1029 if (*(bool *)opt->addr != v)
1030 /* this can happen legitimately, e.g. lock
1031 option turned off for default device */
1033 printer(arg, "%s", opt->name);
1036 v = opt->flags & OPT_VALUE;
1039 i = *(int *)opt->addr;
1040 if (opt->flags & OPT_NOARG) {
1041 printer(arg, "%s", opt->name);
1043 if (opt->flags & OPT_INC) {
1044 for (; i > v; i -= v)
1045 printer(arg, " %s", opt->name);
1047 printer(arg, " # oops: %d not %d\n",
1051 printer(arg, "%s %d", opt->name, i);
1055 printer(arg, "%s", opt->name);
1056 if ((opt->flags & OPT_NOARG) == 0)
1057 printer(arg, " %x", *(u_int32_t *)opt->addr);
1061 if (opt->flags & OPT_HIDE) {
1064 p = (char *) opt->addr;
1065 if ((opt->flags & OPT_STATIC) == 0)
1068 printer(arg, "%s %q", opt->name, p);
1072 case o_special_noarg:
1074 if (opt->type != o_wild) {
1075 printer(arg, "%s", opt->name);
1076 if (n_arguments(opt) == 0)
1080 if (opt->flags & OPT_A2PRINTER) {
1081 void (*oprt)(struct option *, printer_func, void *);
1082 oprt = (void (*)(struct option *, printer_func, void *))
1084 (*oprt)(opt, printer, arg);
1085 } else if (opt->flags & OPT_A2STRVAL) {
1086 p = (char *) opt->addr2;
1087 if ((opt->flags & OPT_STATIC) == 0)
1089 printer(arg, "%q", p);
1090 } else if (opt->flags & OPT_A2LIST) {
1091 struct option_value *ovp;
1093 ovp = (struct option_value *) opt->addr2;
1095 printer(arg, "%q", ovp->value);
1096 if ((ovp = ovp->next) == NULL)
1098 printer(arg, "\t\t# (from %s)\n%s ",
1099 ovp->source, opt->name);
1102 printer(arg, "xxx # [don't know how to print value]");
1107 printer(arg, "# %s value (type %d\?\?)", opt->name, opt->type);
1110 printer(arg, "\t\t# (from %s)\n", mainopt->source);
1114 * print_option_list - print out options in effect from an
1118 print_option_list(struct option *opt, printer_func printer, void *arg)
1120 while (opt->name != NULL) {
1121 if (opt->priority != OPRIO_DEFAULT
1122 && opt->winner != (short int) -1)
1123 print_option(opt + opt->winner, opt, printer, arg);
1126 } while (opt->flags & OPT_PRIOSUB);
1131 * print_options - print out what options are in effect.
1134 print_options(printer_func printer, void *arg)
1136 struct option_list *list;
1139 printer(arg, "pppd options in effect:\n");
1140 print_option_list(general_options, printer, arg);
1141 print_option_list(auth_options, printer, arg);
1142 for (list = extra_options; list != NULL; list = list->next)
1143 print_option_list(list->options, printer, arg);
1144 print_option_list(the_channel->options, printer, arg);
1145 for (i = 0; protocols[i] != NULL; ++i)
1146 print_option_list(protocols[i]->options, printer, arg);
1150 * usage - print out a message telling how to use the program.
1156 if (in_phase(PHASE_INITIALIZE)) {
1157 fprintf(fp, "%s v%s\n", PACKAGE_NAME, PACKAGE_VERSION);
1158 fprintf(fp, "Copyright (C) 1999-2022 Paul Mackerras, and others. All rights reserved.\n\n");
1161 fprintf(fp, "License BSD: The 3 clause BSD license <https://opensource.org/licenses/BSD-3-Clause>\n");
1162 fprintf(fp, "This is free software: you are free to change and redistribute it.\n");
1163 fprintf(fp, "There is NO WARRANTY, to the extent permitted by law.\n\n");
1165 fprintf(fp, "Report Bugs:\n %s\n\n", PACKAGE_BUGREPORT);
1166 fprintf(fp, "Usage: %s [ options ], where options are:\n", progname);
1167 fprintf(fp, " <device> Communicate over the named device\n");
1168 fprintf(fp, " <speed> Set the baud rate to <speed>\n");
1169 fprintf(fp, " <loc>:<rem> Set the local and/or remote interface IP\n");
1170 fprintf(fp, " addresses. Either one may be omitted.\n");
1171 fprintf(fp, " asyncmap <n> Set the desired async map to hex <n>\n");
1172 fprintf(fp, " auth Require authentication from peer\n");
1173 fprintf(fp, " connect <p> Invoke shell command <p> to set up the serial line\n");
1174 fprintf(fp, " crtscts Use hardware RTS/CTS flow control\n");
1175 fprintf(fp, " defaultroute Add default route through interface\n");
1176 fprintf(fp, " file <f> Take options from file <f>\n");
1177 fprintf(fp, " modem Use modem control lines\n");
1178 fprintf(fp, " mru <n> Set MRU value to <n> for negotiation\n");
1179 fprintf(fp, " show-options Display an extended list of options\n");
1180 fprintf(fp, "See pppd(8) for more options.\n");
1185 * showhelp - print out usage message and exit.
1188 showhelp(char **argv)
1190 if (in_phase(PHASE_INITIALIZE)) {
1198 * showversion - print out the version number and exit.
1201 showversion(char **argv)
1203 if (in_phase(PHASE_INITIALIZE)) {
1204 fprintf(stdout, "pppd version %s\n", VERSION);
1211 * Print a set of options including the name of the group of options
1214 showopts_list(FILE *fp, const char *title, struct option *list, ...)
1216 struct option *opt = list;
1219 if (opt && opt->name) {
1220 va_start(varg, list);
1221 vfprintf(fp, title, varg);
1226 fprintf(fp, " %-22s %s\n", opt->name, opt->description?:"");
1228 } while (opt && opt->name);
1235 * Dumps the list of available options
1240 struct option_list *list;
1244 showopts_list(fp, "General Options",
1247 showopts_list(fp, "Authentication Options",
1250 for (list = extra_options; list != NULL; list = list->next)
1251 showopts_list(fp, "Extra Options", list->options);
1253 showopts_list(fp, "Channel Options",
1254 the_channel->options);
1256 for (i = 0; protocols[i] != NULL; ++i) {
1257 if (protocols[i]->options != NULL) {
1258 showopts_list(fp, "%s Options",
1259 protocols[i]->options,
1260 protocols[i]->name);
1266 * ppp_option_error - print a message about an error in an option.
1267 * The message is logged, and also sent to
1268 * stderr if in_phase(PHASE_INITIALIZE).
1271 ppp_option_error(char *fmt, ...)
1276 va_start(args, fmt);
1277 vslprintf(buf, sizeof(buf), fmt, args);
1279 if (in_phase(PHASE_INITIALIZE))
1280 fprintf(stderr, "%s: %s\n", progname, buf);
1281 syslog(LOG_ERR, "%s", buf);
1286 * readable - check if a file is readable by the real user.
1298 if (fstat(fd, &sbuf) != 0)
1300 if (sbuf.st_uid == uid)
1301 return sbuf.st_mode & S_IRUSR;
1302 if (sbuf.st_gid == getgid())
1303 return sbuf.st_mode & S_IRGRP;
1304 for (i = 0; i < ngroups; ++i)
1305 if (sbuf.st_gid == groups[i])
1306 return sbuf.st_mode & S_IRGRP;
1307 return sbuf.st_mode & S_IROTH;
1312 * Read a word from a file.
1313 * Words are delimited by white-space or by quotes (" or ').
1314 * Quotes, white-space and \ may be escaped with \.
1315 * \<newline> is ignored.
1318 getword(FILE *f, char *word, int *newlinep, char *filename)
1321 int quoted, comment;
1322 int value, digit, got, n;
1324 #define isoctal(c) ((c) >= '0' && (c) < '8')
1333 * First skip white-space and comments.
1341 * A newline means the end of a comment; backslash-newline
1342 * is ignored. Note that we cannot have escape && comment.
1354 * Ignore characters other than newline in a comment.
1360 * If this character is escaped, we have a word start.
1366 * If this is the escape character, look at the next character.
1374 * If this is the start of a comment, ignore the rest of the line.
1382 * A non-whitespace character is the start of a word.
1389 * Process characters until the end of the word.
1394 * This character is escaped: backslash-newline is ignored,
1395 * various other characters indicate particular values
1396 * as for C backslash-escapes.
1431 * \ddd octal sequence
1434 for (n = 0; n < 3 && isoctal(c); ++n) {
1435 value = (value << 3) + (c & 07);
1444 * \x<hex_string> sequence
1448 for (n = 0; n < 2 && isxdigit(c); ++n) {
1449 digit = toupper(c) - '0';
1451 digit += '0' + 10 - 'A';
1452 value = (value << 4) + digit;
1460 * Otherwise the character stands for itself.
1467 * Store the resulting character for the escape sequence.
1469 if (len < MAXWORDLEN) {
1480 * Backslash starts a new escape sequence.
1489 * Not escaped: check for the start or end of a quoted
1490 * section and see if we've reached the end of the word.
1498 } else if (c == '"' || c == '\'') {
1502 } else if (isspace(c) || c == '#') {
1508 * An ordinary character: store it in the word and get another.
1510 if (len < MAXWORDLEN) {
1517 word[MAXWORDLEN-1] = 0; /* make sure word is null-terminated */
1520 * End of the word: check for errors.
1526 ppp_option_error("Error reading %s: %m", filename);
1530 * If len is zero, then we didn't find a word before the
1536 ppp_option_error("warning: quoted word runs to end of file (%.20s...)",
1541 * Warn if the word was too long, and append a terminating null.
1543 if (len >= MAXWORDLEN) {
1544 ppp_option_error("warning: word in file %s too long (%.20s...)",
1546 len = MAXWORDLEN - 1;
1557 * number_option - parse an unsigned numeric parameter for an option.
1560 number_option(char *str, u_int32_t *valp, int base)
1564 *valp = strtoul(str, &ptr, base);
1566 ppp_option_error("invalid numeric parameter '%s' for %s option",
1567 str, current_option);
1575 * int_option - like number_option, but valp is int *,
1576 * the base is assumed to be 0, and *valp is not changed
1577 * if there is an error.
1580 ppp_int_option(char *str, int *valp)
1584 if (!number_option(str, &v, 0))
1592 * The following procedures parse options.
1596 * readfile - take commands from a file.
1599 readfile(char **argv)
1601 return ppp_options_from_file(*argv, 1, 1, privileged_option);
1605 * callfile - take commands from /etc/ppp/peers/<name>.
1606 * Name may not contain /../, start with / or ../, or end in /..
1609 callfile(char **argv)
1611 char *fname, *arg, *p;
1616 if (arg[0] == '/' || arg[0] == 0)
1619 for (p = arg; *p != 0; ) {
1620 if (p[0] == '.' && p[1] == '.' && (p[2] == '/' || p[2] == 0)) {
1624 while (*p != '/' && *p != 0)
1631 ppp_option_error("call option value may not contain .. or start with /");
1635 l = strlen(arg) + strlen(PPP_PATH_PEERFILES) + 1;
1636 if ((fname = (char *) malloc(l)) == NULL)
1637 novm("call file name");
1638 slprintf(fname, l, "%s%s", PPP_PATH_PEERFILES, arg);
1639 ppp_script_setenv("CALL_FILE", arg, 0);
1641 ok = ppp_options_from_file(fname, 1, 1, 1);
1647 #ifdef PPP_WITH_FILTER
1649 * setpassfilter - Set the pass filter for packets
1652 setpassfilter(char **argv)
1657 pc = pcap_open_dead(DLT_PPP_PPPD, 65535);
1658 if (pcap_compile(pc, &pass_filter, *argv, 1, netmask) == -1) {
1659 ppp_option_error("error in pass-filter expression: %s\n",
1669 * setactivefilter - Set the active filter for packets
1672 setactivefilter(char **argv)
1677 pc = pcap_open_dead(DLT_PPP_PPPD, 65535);
1678 if (pcap_compile(pc, &active_filter, *argv, 1, netmask) == -1) {
1679 ppp_option_error("error in active-filter expression: %s\n",
1690 * setdomain - Set domain name to append to hostname
1693 setdomain(char **argv)
1695 gethostname(hostname, MAXNAMELEN);
1698 strncat(hostname, ".", MAXNAMELEN - strlen(hostname));
1699 domain = hostname + strlen(hostname);
1700 strncat(hostname, *argv, MAXNAMELEN - strlen(hostname));
1702 hostname[MAXNAMELEN-1] = 0;
1707 setlogfile(char **argv)
1713 if (!privileged_option && seteuid(getuid()) == -1) {
1714 ppp_option_error("unable to drop permissions to open %s: %m", *argv);
1717 fd = open(*argv, O_WRONLY | O_APPEND | O_CREAT | O_EXCL, 0644);
1718 if (fd < 0 && errno == EEXIST)
1719 fd = open(*argv, O_WRONLY | O_APPEND);
1721 if (!privileged_option && seteuid(euid) == -1)
1722 fatal("unable to regain privileges: %m");
1725 ppp_option_error("Can't open log file %s: %m", *argv);
1728 strlcpy(logfile_name, *argv, sizeof(logfile_name));
1729 if (logfile_fd >= 0)
1738 setmodir(char **argv)
1742 if(!strcmp(*argv,"in")) {
1743 maxoctets_dir = PPP_OCTETS_DIRECTION_IN;
1744 } else if (!strcmp(*argv,"out")) {
1745 maxoctets_dir = PPP_OCTETS_DIRECTION_OUT;
1746 } else if (!strcmp(*argv,"max")) {
1747 maxoctets_dir = PPP_OCTETS_DIRECTION_MAXOVERAL;
1749 maxoctets_dir = PPP_OCTETS_DIRECTION_SUM;
1754 #ifdef PPP_WITH_PLUGINS
1756 loadplugin(char **argv)
1765 if (strchr(arg, '/') == 0) {
1766 const char *base = PPP_PATH_PLUGIN;
1767 int l = strlen(base) + strlen(arg) + 2;
1770 novm("plugin file path");
1771 strlcpy(path, base, l);
1772 strlcat(path, "/", l);
1773 strlcat(path, arg, l);
1775 handle = dlopen(path, RTLD_GLOBAL | RTLD_NOW);
1779 ppp_option_error("%s", err);
1780 ppp_option_error("Couldn't load plugin %s", arg);
1783 init = (void (*)(void))dlsym(handle, "plugin_init");
1785 ppp_option_error("%s has no initialization entry point", arg);
1788 vers = (const char *) dlsym(handle, "pppd_version");
1790 warn("Warning: plugin %s has no version information", arg);
1791 } else if (strcmp(vers, VERSION) != 0) {
1792 ppp_option_error("Plugin %s is for pppd version %s, this is %s",
1793 arg, vers, VERSION);
1796 info("Plugin %s loaded.", arg);
1809 #endif /* PPP_WITH_PLUGINS */
1812 * Set an environment variable specified by the user.
1815 user_setenv(char **argv)
1817 char *arg = argv[0];
1819 struct userenv *uep, **insp;
1821 if ((eqp = strchr(arg, '=')) == NULL) {
1822 ppp_option_error("missing = in name=value: %s", arg);
1826 ppp_option_error("missing variable name: %s", arg);
1829 for (uep = userenv_list; uep != NULL; uep = uep->ue_next) {
1830 int nlen = strlen(uep->ue_name);
1831 if (nlen == (eqp - arg) &&
1832 strncmp(arg, uep->ue_name, nlen) == 0)
1835 /* Ignore attempts by unprivileged users to override privileged sources */
1836 if (uep != NULL && !privileged_option && uep->ue_priv)
1838 /* The name never changes, so allocate it with the structure */
1840 uep = malloc(sizeof (*uep) + (eqp-arg));
1841 strncpy(uep->ue_name, arg, eqp-arg);
1842 uep->ue_name[eqp-arg] = '\0';
1843 uep->ue_next = NULL;
1844 insp = &userenv_list;
1845 while (*insp != NULL)
1846 insp = &(*insp)->ue_next;
1849 struct userenv *uep2;
1850 for (uep2 = userenv_list; uep2 != NULL; uep2 = uep2->ue_next) {
1851 if (uep2 != uep && !uep2->ue_isset)
1854 if (uep2 == NULL && !uep->ue_isset)
1855 find_option("unset")->flags |= OPT_NOPRINT;
1856 free(uep->ue_value);
1859 uep->ue_priv = privileged_option;
1860 uep->ue_source = option_source;
1861 uep->ue_value = strdup(eqp + 1);
1862 curopt->flags &= ~OPT_NOPRINT;
1867 user_setprint(struct option *opt, printer_func printer, void *arg)
1869 struct userenv *uep, *uepnext;
1871 uepnext = userenv_list;
1872 while (uepnext != NULL && !uepnext->ue_isset)
1873 uepnext = uepnext->ue_next;
1874 while ((uep = uepnext) != NULL) {
1875 uepnext = uep->ue_next;
1876 while (uepnext != NULL && !uepnext->ue_isset)
1877 uepnext = uepnext->ue_next;
1878 (*printer)(arg, "%s=%s", uep->ue_name, uep->ue_value);
1879 if (uepnext != NULL)
1880 (*printer)(arg, "\t\t# (from %s)\n%s ", uep->ue_source, opt->name);
1882 opt->source = uep->ue_source;
1887 user_unsetenv(char **argv)
1889 struct userenv *uep, **insp;
1890 char *arg = argv[0];
1892 if (strchr(arg, '=') != NULL) {
1893 ppp_option_error("unexpected = in name: %s", arg);
1897 ppp_option_error("missing variable name for unset");
1900 for (uep = userenv_list; uep != NULL; uep = uep->ue_next) {
1901 if (strcmp(arg, uep->ue_name) == 0)
1904 /* Ignore attempts by unprivileged users to override privileged sources */
1905 if (uep != NULL && !privileged_option && uep->ue_priv)
1907 /* The name never changes, so allocate it with the structure */
1909 uep = malloc(sizeof (*uep) + strlen(arg));
1910 strcpy(uep->ue_name, arg);
1911 uep->ue_next = NULL;
1912 insp = &userenv_list;
1913 while (*insp != NULL)
1914 insp = &(*insp)->ue_next;
1917 struct userenv *uep2;
1918 for (uep2 = userenv_list; uep2 != NULL; uep2 = uep2->ue_next) {
1919 if (uep2 != uep && uep2->ue_isset)
1922 if (uep2 == NULL && uep->ue_isset)
1923 find_option("set")->flags |= OPT_NOPRINT;
1924 free(uep->ue_value);
1927 uep->ue_priv = privileged_option;
1928 uep->ue_source = option_source;
1929 uep->ue_value = NULL;
1930 curopt->flags &= ~OPT_NOPRINT;
1935 user_unsetprint(struct option *opt, printer_func printer, void *arg)
1937 struct userenv *uep, *uepnext;
1939 uepnext = userenv_list;
1940 while (uepnext != NULL && uepnext->ue_isset)
1941 uepnext = uepnext->ue_next;
1942 while ((uep = uepnext) != NULL) {
1943 uepnext = uep->ue_next;
1944 while (uepnext != NULL && uepnext->ue_isset)
1945 uepnext = uepnext->ue_next;
1946 (*printer)(arg, "%s", uep->ue_name);
1947 if (uepnext != NULL)
1948 (*printer)(arg, "\t\t# (from %s)\n%s ", uep->ue_source, opt->name);
1950 opt->source = uep->ue_source;