2 * Copyright (c) 1993-1996, 1998-2012 Todd C. Miller <Todd.Miller@courtesan.com>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 * Sponsored in part by the Defense Advanced Research Projects
17 * Agency (DARPA) and Air Force Research Laboratory, Air Force
18 * Materiel Command, USAF, under agreement number F39502-99-1-0512.
23 #include <sys/types.h>
24 #include <sys/param.h>
34 #endif /* STDC_HEADERS */
37 #endif /* HAVE_STRING_H */
40 #endif /* HAVE_STRINGS_H */
43 #endif /* HAVE_UNISTD_H */
48 #include <sudo_usage.h>
61 static void help(void) __attribute__((__noreturn__));
62 static void usage_excl(int);
65 * Mapping of command line flags to name/value settings.
67 static struct sudo_settings {
71 #define ARG_BSDAUTH_TYPE 0
73 #define ARG_LOGIN_CLASS 1
75 #define ARG_DEBUG_FLAGS 2
77 #define ARG_PRESERVE_ENVIRONMENT 3
78 { "preserve_environment" },
79 #define ARG_RUNAS_GROUP 4
81 #define ARG_SET_HOME 5
83 #define ARG_USER_SHELL 6
85 #define ARG_LOGIN_SHELL 7
87 #define ARG_IGNORE_TICKET 8
91 #define ARG_SELINUX_ROLE 10
93 #define ARG_SELINUX_TYPE 11
95 #define ARG_RUNAS_USER 12
97 #define ARG_PROGNAME 13
99 #define ARG_IMPLIED_SHELL 14
101 #define ARG_PRESERVE_GROUPS 15
102 { "preserve_groups" },
103 #define ARG_NONINTERACTIVE 16
104 { "noninteractive" },
105 #define ARG_SUDOEDIT 17
107 #define ARG_CLOSEFROM 18
109 #define ARG_NET_ADDRS 19
111 #define NUM_SETTINGS 20
116 * Command line argument parsing.
117 * Sets nargc and nargv which corresponds to the argc/argv we'll use
118 * for the command to be run (if we are running one).
121 parse_args(int argc, char **argv, int *nargc, char ***nargv, char ***settingsp,
124 int mode = 0; /* what mode is sudo to be run in? */
125 int flags = 0; /* mode flags */
128 char *cp, **env_add, **settings;
129 const char *debug_flags;
132 debug_decl(parse_args, SUDO_DEBUG_ARGS)
134 env_add = emalloc2(env_size, sizeof(char *));
136 /* Pass progname to plugin so it can call setprogname() */
137 sudo_settings[ARG_PROGNAME].value = getprogname();
139 /* First, check to see if we were invoked as "sudoedit". */
140 if (strcmp(getprogname(), "sudoedit") == 0) {
142 sudo_settings[ARG_SUDOEDIT].value = "true";
145 /* Load local IP addresses and masks. */
146 if (get_net_ifs(&cp) > 0)
147 sudo_settings[ARG_NET_ADDRS].value = cp;
149 /* Set debug file and flags from sudo.conf. */
150 debug_flags = sudo_conf_debug_flags();
151 if (debug_flags != NULL)
152 sudo_settings[ARG_DEBUG_FLAGS].value = debug_flags;
154 /* Returns true if the last option string was "--" */
155 #define got_end_of_args (optind > 1 && argv[optind - 1][0] == '-' && \
156 argv[optind - 1][1] == '-' && argv[optind - 1][2] == '\0')
158 /* Returns true if next option is an environment variable */
159 #define is_envar (optind < argc && argv[optind][0] != '/' && \
160 strchr(argv[optind], '=') != NULL)
162 /* Flags allowed when running a command */
163 valid_flags = MODE_BACKGROUND|MODE_PRESERVE_ENV|MODE_RESET_HOME|
164 MODE_LOGIN_SHELL|MODE_NONINTERACTIVE|MODE_SHELL;
165 /* XXX - should fill in settings at the end to avoid dupes */
168 * We disable arg permutation for GNU getopt().
169 * Some trickiness is required to allow environment variables
170 * to be interspersed with command line options.
172 if ((ch = getopt(argc, argv, "+Aa:bC:c:D:Eeg:HhiKklnPp:r:Sst:U:u:Vv")) != -1) {
175 SET(tgetpass_flags, TGP_ASKPASS);
177 #ifdef HAVE_BSD_AUTH_H
179 sudo_settings[ARG_BSDAUTH_TYPE].value = optarg;
183 SET(flags, MODE_BACKGROUND);
186 if (atoi(optarg) < 3) {
187 warningx(_("the argument to -C must be a number greater than or equal to 3"));
190 sudo_settings[ARG_CLOSEFROM].value = optarg;
192 #ifdef HAVE_LOGIN_CAP_H
194 sudo_settings[ARG_LOGIN_CLASS].value = optarg;
198 /* Ignored for backwards compatibility. */
201 sudo_settings[ARG_PRESERVE_ENVIRONMENT].value = "true";
204 if (mode && mode != MODE_EDIT)
207 sudo_settings[ARG_SUDOEDIT].value = "true";
208 valid_flags = MODE_NONINTERACTIVE;
211 runas_group = optarg;
212 sudo_settings[ARG_RUNAS_GROUP].value = optarg;
215 sudo_settings[ARG_SET_HOME].value = "true";
218 if (mode && mode != MODE_HELP) {
219 if (strcmp(getprogname(), "sudoedit") != 0)
226 sudo_settings[ARG_LOGIN_SHELL].value = "true";
227 SET(flags, MODE_LOGIN_SHELL);
230 sudo_settings[ARG_IGNORE_TICKET].value = "true";
233 sudo_settings[ARG_IGNORE_TICKET].value = "true";
234 if (mode && mode != MODE_KILL)
241 if (mode == MODE_LIST)
242 SET(flags, MODE_LONG_LIST);
247 valid_flags = MODE_NONINTERACTIVE|MODE_LONG_LIST;
250 SET(flags, MODE_NONINTERACTIVE);
251 sudo_settings[ARG_NONINTERACTIVE].value = "true";
254 sudo_settings[ARG_PRESERVE_GROUPS].value = "true";
257 sudo_settings[ARG_PROMPT].value = optarg;
261 sudo_settings[ARG_SELINUX_ROLE].value = optarg;
264 sudo_settings[ARG_SELINUX_TYPE].value = optarg;
268 SET(tgetpass_flags, TGP_STDIN);
271 sudo_settings[ARG_USER_SHELL].value = "true";
272 SET(flags, MODE_SHELL);
275 if ((getpwnam(optarg)) == NULL)
276 errorx(1, _("unknown user: %s"), optarg);
281 sudo_settings[ARG_RUNAS_USER].value = optarg;
284 if (mode && mode != MODE_VALIDATE)
286 mode = MODE_VALIDATE;
287 valid_flags = MODE_NONINTERACTIVE;
290 if (mode && mode != MODE_VERSION)
298 } else if (!got_end_of_args && is_envar) {
299 if (nenv == env_size - 2) {
301 env_add = erealloc3(env_add, env_size, sizeof(char *));
303 env_add[nenv++] = argv[optind];
305 /* Crank optind and resume getopt. */
308 /* Not an option or an environment variable -- we're done. */
312 env_add[nenv] = NULL;
318 /* Defer -k mode setting until we know whether it is a flag or not */
319 if (sudo_settings[ARG_IGNORE_TICKET].value != NULL) {
320 if (argc == 0 && !(flags & (MODE_SHELL|MODE_LOGIN_SHELL))) {
321 mode = MODE_INVALIDATE; /* -k by itself */
322 sudo_settings[ARG_IGNORE_TICKET].value = NULL;
327 mode = MODE_RUN; /* running a command */
330 if (argc > 0 && mode == MODE_LIST)
333 if (ISSET(flags, MODE_LOGIN_SHELL)) {
334 if (ISSET(flags, MODE_SHELL)) {
335 warningx(_("you may not specify both the `-i' and `-s' options"));
338 if (ISSET(flags, MODE_PRESERVE_ENV)) {
339 warningx(_("you may not specify both the `-i' and `-E' options"));
342 SET(flags, MODE_SHELL);
344 if ((flags & valid_flags) != flags)
346 if (mode == MODE_EDIT &&
347 (ISSET(flags, MODE_PRESERVE_ENV) || env_add[0] != NULL)) {
348 if (ISSET(mode, MODE_PRESERVE_ENV))
349 warningx(_("the `-E' option is not valid in edit mode"));
350 if (env_add[0] != NULL)
351 warningx(_("you may not specify environment variables in edit mode"));
354 if ((runas_user != NULL || runas_group != NULL) &&
355 !ISSET(mode, MODE_EDIT | MODE_RUN | MODE_CHECK | MODE_VALIDATE)) {
358 if (list_user != NULL && mode != MODE_LIST && mode != MODE_CHECK) {
359 warningx(_("the `-U' option may only be used with the `-l' option"));
362 if (ISSET(tgetpass_flags, TGP_STDIN) && ISSET(tgetpass_flags, TGP_ASKPASS)) {
363 warningx(_("the `-A' and `-S' options may not be used together"));
366 if ((argc == 0 && mode == MODE_EDIT) ||
367 (argc > 0 && !ISSET(mode, MODE_RUN | MODE_EDIT | MODE_CHECK)))
369 if (argc == 0 && mode == MODE_RUN && !ISSET(flags, MODE_SHELL)) {
370 SET(flags, (MODE_IMPLIED_SHELL | MODE_SHELL));
371 sudo_settings[ARG_IMPLIED_SHELL].value = "true";
374 if (mode == MODE_HELP)
378 * For shell mode we need to rewrite argv
380 if (ISSET(mode, MODE_RUN) && ISSET(flags, MODE_SHELL)) {
381 char **av, *cmnd = NULL;
385 /* shell -c "command" */
387 size_t cmnd_size = (size_t) (argv[argc - 1] - argv[0]) +
388 strlen(argv[argc - 1]) + 1;
390 cmnd = dst = emalloc2(cmnd_size, 2);
391 for (av = argv; *av != NULL; av++) {
392 for (src = *av; *src != '\0'; src++) {
393 /* quote potential meta characters */
394 if (!isalnum((unsigned char)*src) && *src != '_' && *src != '-')
401 dst--; /* replace last space with a NUL */
404 ac += 2; /* -c cmnd */
407 av = emalloc2(ac + 1, sizeof(char *));
408 av[0] = (char *)user_details.shell; /* plugin may override shell */
420 * Format setting_pairs into settings array.
422 settings = emalloc2(NUM_SETTINGS + 1, sizeof(char *));
423 for (i = 0, j = 0; i < NUM_SETTINGS; i++) {
424 if (sudo_settings[i].value) {
425 sudo_debug_printf(SUDO_DEBUG_INFO, "settings: %s=%s",
426 sudo_settings[i].name, sudo_settings[i].value);
427 settings[j] = fmt_string(sudo_settings[i].name,
428 sudo_settings[i].value);
429 if (settings[j] == NULL)
430 errorx(1, _("unable to allocate memory"));
436 if (mode == MODE_EDIT) {
437 #if defined(HAVE_SETRESUID) || defined(HAVE_SETREUID) || defined(HAVE_SETEUID)
438 /* Must have the command in argv[0]. */
441 argv[0] = "sudoedit";
443 errorx(1, _("sudoedit is not supported on this platform"));
447 *settingsp = settings;
451 debug_return_int(mode | flags);
455 usage_err(const char *buf)
457 return fputs(buf, stderr);
461 usage_out(const char *buf)
463 return fputs(buf, stdout);
467 * Give usage message and exit.
468 * The actual usage strings are in sudo_usage.h for configure substitution.
478 * Use usage vectors appropriate to the progname.
480 if (strcmp(getprogname(), "sudoedit") == 0) {
481 uvec[0] = SUDO_USAGE5 + 3;
484 uvec[0] = SUDO_USAGE1;
485 uvec[1] = SUDO_USAGE2;
486 uvec[2] = SUDO_USAGE3;
487 uvec[3] = SUDO_USAGE4;
488 uvec[4] = SUDO_USAGE5;
493 * Print usage and wrap lines as needed, depending on the
496 ulen = (int)strlen(getprogname()) + 8;
497 lbuf_init(&lbuf, fatal ? usage_err : usage_out, ulen, NULL,
498 user_details.ts_cols);
499 for (i = 0; uvec[i] != NULL; i++) {
500 lbuf_append(&lbuf, "usage: %s%s", getprogname(), uvec[i]);
509 * Tell which options are mutually exclusive and exit.
512 usage_excl(int fatal)
514 debug_decl(usage_excl, SUDO_DEBUG_ARGS)
516 warningx(_("Only one of the -e, -h, -i, -K, -l, -s, -v or -V options may be specified"));
525 const char *pname = getprogname();
526 debug_decl(help, SUDO_DEBUG_ARGS)
528 lbuf_init(&lbuf, usage_out, indent, NULL, user_details.ts_cols);
529 if (strcmp(pname, "sudoedit") == 0)
530 lbuf_append(&lbuf, _("%s - edit files as another user\n\n"), pname);
532 lbuf_append(&lbuf, _("%s - execute a command as another user\n\n"), pname);
537 lbuf_append(&lbuf, _("\nOptions:\n"));
538 lbuf_append(&lbuf, " -A %s",
539 _("use helper program for password prompting\n"));
540 #ifdef HAVE_BSD_AUTH_H
541 lbuf_append(&lbuf, " -a type %s",
542 _("use specified BSD authentication type\n"));
544 lbuf_append(&lbuf, " -b %s",
545 _("run command in the background\n"));
546 lbuf_append(&lbuf, " -C fd %s",
547 _("close all file descriptors >= fd\n"));
548 #ifdef HAVE_LOGIN_CAP_H
549 lbuf_append(&lbuf, " -c class %s",
550 _("run command with specified login class\n"));
552 lbuf_append(&lbuf, " -E %s",
553 _("preserve user environment when executing command\n"));
554 lbuf_append(&lbuf, " -e %s",
555 _("edit files instead of running a command\n"));
556 lbuf_append(&lbuf, " -g group %s",
557 _("execute command as the specified group\n"));
558 lbuf_append(&lbuf, " -H %s",
559 _("set HOME variable to target user's home dir.\n"));
560 lbuf_append(&lbuf, " -h %s",
561 _("display help message and exit\n"));
562 lbuf_append(&lbuf, " -i [command] %s",
563 _("run a login shell as target user\n"));
564 lbuf_append(&lbuf, " -K %s",
565 _("remove timestamp file completely\n"));
566 lbuf_append(&lbuf, " -k %s",
567 _("invalidate timestamp file\n"));
568 lbuf_append(&lbuf, " -l[l] command %s",
569 _("list user's available commands\n"));
570 lbuf_append(&lbuf, " -n %s",
571 _("non-interactive mode, will not prompt user\n"));
572 lbuf_append(&lbuf, " -P %s",
573 _("preserve group vector instead of setting to target's\n"));
574 lbuf_append(&lbuf, " -p prompt %s",
575 _("use specified password prompt\n"));
577 lbuf_append(&lbuf, " -r role %s",
578 _("create SELinux security context with specified role\n"));
580 lbuf_append(&lbuf, " -S %s",
581 _("read password from standard input\n"));
583 " -s [command] %s", _("run a shell as target user\n"));
585 lbuf_append(&lbuf, " -t type %s",
586 _("create SELinux security context with specified role\n"));
588 lbuf_append(&lbuf, " -U user %s",
589 _("when listing, list specified user's privileges\n"));
590 lbuf_append(&lbuf, " -u user %s",
591 _("run command (or edit file) as specified user\n"));
592 lbuf_append(&lbuf, " -V %s",
593 _("display version information and exit\n"));
594 lbuf_append(&lbuf, " -v %s",
595 _("update user's timestamp without running a command\n"));
596 lbuf_append(&lbuf, " -- %s",
597 _("stop processing command line arguments\n"));
600 sudo_debug_exit_int(__func__, __FILE__, __LINE__, sudo_debug_subsys, 0);