isa/sudo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Mark main sudo usage() function __noreturn__.

Browse Source 
This splits the usage printing out into display_usage().
This commit is contained in:
Todd C. Miller
2020-02-08 12:17:33 -07:00
parent c92f39ed3d
commit c5afbf00fc
3 changed files with 50 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
src/parse_args.c
View File

@@ -59,7 +59,7 @@ int tgetpass_flags;
* Local functions. * Local functions.
*/ */
static void help(void) __attribute__((__noreturn__)); static void help(void) __attribute__((__noreturn__));
static void usage_excl(int); static void usage_excl(void) __attribute__((__noreturn__));
/* /*
* Mapping of command line flags to name/value settings. * Mapping of command line flags to name/value settings.
@@ -226,7 +226,7 @@ parse_env_list(struct environment *e, char *list)
(cp = strtok_r(NULL, ",", &last))) { (cp = strtok_r(NULL, ",", &last))) {
if (strchr(cp, '=') != NULL) { if (strchr(cp, '=') != NULL) {
sudo_warnx(U_("invalid environment variable name: %s"), cp); sudo_warnx(U_("invalid environment variable name: %s"), cp);
usage(1); usage();
} }
if ((val = getenv(cp)) != NULL) if ((val = getenv(cp)) != NULL)
env_set(e, cp, val); env_set(e, cp, val);
@@ -257,7 +257,7 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
/* Is someone trying something funny? */ /* Is someone trying something funny? */
if (argc <= 0) if (argc <= 0)
usage(1); usage();
/* Pass progname to plugin so it can call initprogname() */ /* Pass progname to plugin so it can call initprogname() */
progname = getprogname(); progname = getprogname();
@@ -313,7 +313,7 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
case 'a': case 'a':
assert(optarg != NULL); assert(optarg != NULL);
if (*optarg == '\0') if (*optarg == '\0')
usage(1); usage();
sudo_settings[ARG_BSDAUTH_TYPE].value = optarg; sudo_settings[ARG_BSDAUTH_TYPE].value = optarg;
break; break;
#endif #endif
@@ -327,7 +327,7 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
assert(optarg != NULL); assert(optarg != NULL);
if (sudo_strtonum(optarg, 3, INT_MAX, NULL) == 0) { if (sudo_strtonum(optarg, 3, INT_MAX, NULL) == 0) {
sudo_warnx(U_("the argument to -C must be a number greater than or equal to 3")); sudo_warnx(U_("the argument to -C must be a number greater than or equal to 3"));
usage(1); usage();
} }
sudo_settings[ARG_CLOSEFROM].value = optarg; sudo_settings[ARG_CLOSEFROM].value = optarg;
break; break;
@@ -335,7 +335,7 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
case 'c': case 'c':
assert(optarg != NULL); assert(optarg != NULL);
if (*optarg == '\0') if (*optarg == '\0')
usage(1); usage();
sudo_settings[ARG_LOGIN_CLASS].value = optarg; sudo_settings[ARG_LOGIN_CLASS].value = optarg;
break; break;
#endif #endif
@@ -357,7 +357,7 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
break; break;
case 'e': case 'e':
if (mode && mode != MODE_EDIT) if (mode && mode != MODE_EDIT)
usage_excl(1); usage_excl();
mode = MODE_EDIT; mode = MODE_EDIT;
sudo_settings[ARG_SUDOEDIT].value = "true"; sudo_settings[ARG_SUDOEDIT].value = "true";
valid_flags = MODE_NONINTERACTIVE; valid_flags = MODE_NONINTERACTIVE;
@@ -365,7 +365,7 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
case 'g': case 'g':
assert(optarg != NULL); assert(optarg != NULL);
if (*optarg == '\0') if (*optarg == '\0')
usage(1); usage();
runas_group = optarg; runas_group = optarg;
sudo_settings[ARG_RUNAS_GROUP].value = optarg; sudo_settings[ARG_RUNAS_GROUP].value = optarg;
break; break;
@@ -386,7 +386,7 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
} }
if (mode && mode != MODE_HELP) { if (mode && mode != MODE_HELP) {
if (strcmp(progname, "sudoedit") != 0) if (strcmp(progname, "sudoedit") != 0)
usage_excl(1); usage_excl();
} }
mode = MODE_HELP; mode = MODE_HELP;
valid_flags = 0; valid_flags = 0;
@@ -396,7 +396,7 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
case OPT_HOSTNAME: case OPT_HOSTNAME:
assert(optarg != NULL); assert(optarg != NULL);
if (*optarg == '\0') if (*optarg == '\0')
usage(1); usage();
sudo_settings[ARG_REMOTE_HOST].value = optarg; sudo_settings[ARG_REMOTE_HOST].value = optarg;
break; break;
case 'i': case 'i':
@@ -409,7 +409,7 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
case 'K': case 'K':
sudo_settings[ARG_IGNORE_TICKET].value = "true"; sudo_settings[ARG_IGNORE_TICKET].value = "true";
if (mode && mode != MODE_KILL) if (mode && mode != MODE_KILL)
usage_excl(1); usage_excl();
mode = MODE_KILL; mode = MODE_KILL;
valid_flags = 0; valid_flags = 0;
break; break;
@@ -418,7 +418,7 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
if (mode == MODE_LIST) if (mode == MODE_LIST)
SET(flags, MODE_LONG_LIST); SET(flags, MODE_LONG_LIST);
else else
usage_excl(1); usage_excl();
} }
mode = MODE_LIST; mode = MODE_LIST;
valid_flags = MODE_NONINTERACTIVE|MODE_LONG_LIST; valid_flags = MODE_NONINTERACTIVE|MODE_LONG_LIST;
@@ -439,13 +439,13 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
case 'r': case 'r':
assert(optarg != NULL); assert(optarg != NULL);
if (*optarg == '\0') if (*optarg == '\0')
usage(1); usage();
sudo_settings[ARG_SELINUX_ROLE].value = optarg; sudo_settings[ARG_SELINUX_ROLE].value = optarg;
break; break;
case 't': case 't':
assert(optarg != NULL); assert(optarg != NULL);
if (*optarg == '\0') if (*optarg == '\0')
usage(1); usage();
sudo_settings[ARG_SELINUX_TYPE].value = optarg; sudo_settings[ARG_SELINUX_TYPE].value = optarg;
break; break;
#endif #endif
@@ -464,30 +464,30 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
case 'U': case 'U':
assert(optarg != NULL); assert(optarg != NULL);
if (*optarg == '\0') if (*optarg == '\0')
usage(1); usage();
list_user = optarg; list_user = optarg;
break; break;
case 'u': case 'u':
assert(optarg != NULL); assert(optarg != NULL);
if (*optarg == '\0') if (*optarg == '\0')
usage(1); usage();
runas_user = optarg; runas_user = optarg;
sudo_settings[ARG_RUNAS_USER].value = optarg; sudo_settings[ARG_RUNAS_USER].value = optarg;
break; break;
case 'v': case 'v':
if (mode && mode != MODE_VALIDATE) if (mode && mode != MODE_VALIDATE)
usage_excl(1); usage_excl();
mode = MODE_VALIDATE; mode = MODE_VALIDATE;
valid_flags = MODE_NONINTERACTIVE; valid_flags = MODE_NONINTERACTIVE;
break; break;
case 'V': case 'V':
if (mode && mode != MODE_VERSION) if (mode && mode != MODE_VERSION)
usage_excl(1); usage_excl();
mode = MODE_VERSION; mode = MODE_VERSION;
valid_flags = 0; valid_flags = 0;
break; break;
default: default:
usage(1); usage();
} }
} else if (!got_end_of_args && is_envar) { } else if (!got_end_of_args && is_envar) {
/* Insert key=value pair, crank optind and resume getopt. */ /* Insert key=value pair, crank optind and resume getopt. */
@@ -522,39 +522,39 @@ parse_args(int argc, char **argv, int *old_optind, int *nargc, char ***nargv,
if (ISSET(flags, MODE_LOGIN_SHELL)) { if (ISSET(flags, MODE_LOGIN_SHELL)) {
if (ISSET(flags, MODE_SHELL)) { if (ISSET(flags, MODE_SHELL)) {
sudo_warnx(U_("you may not specify both the `-i' and `-s' options")); sudo_warnx(U_("you may not specify both the `-i' and `-s' options"));
usage(1); usage();
} }
if (ISSET(flags, MODE_PRESERVE_ENV)) { if (ISSET(flags, MODE_PRESERVE_ENV)) {
sudo_warnx(U_("you may not specify both the `-i' and `-E' options")); sudo_warnx(U_("you may not specify both the `-i' and `-E' options"));
usage(1); usage();
} }
SET(flags, MODE_SHELL); SET(flags, MODE_SHELL);
} }
if ((flags & valid_flags) != flags) if ((flags & valid_flags) != flags)
usage(1); usage();
if (mode == MODE_EDIT && if (mode == MODE_EDIT &&
(ISSET(flags, MODE_PRESERVE_ENV) || extra_env.env_len != 0)) { (ISSET(flags, MODE_PRESERVE_ENV) || extra_env.env_len != 0)) {
if (ISSET(mode, MODE_PRESERVE_ENV)) if (ISSET(mode, MODE_PRESERVE_ENV))
sudo_warnx(U_("the `-E' option is not valid in edit mode")); sudo_warnx(U_("the `-E' option is not valid in edit mode"));
if (extra_env.env_len != 0) if (extra_env.env_len != 0)
sudo_warnx(U_("you may not specify environment variables in edit mode")); sudo_warnx(U_("you may not specify environment variables in edit mode"));
usage(1); usage();
} }
if ((runas_user != NULL || runas_group != NULL) && if ((runas_user != NULL || runas_group != NULL) &&
!ISSET(mode, MODE_EDIT | MODE_RUN | MODE_CHECK | MODE_VALIDATE)) { !ISSET(mode, MODE_EDIT | MODE_RUN | MODE_CHECK | MODE_VALIDATE)) {
usage(1); usage();
} }
if (list_user != NULL && mode != MODE_LIST && mode != MODE_CHECK) { if (list_user != NULL && mode != MODE_LIST && mode != MODE_CHECK) {
sudo_warnx(U_("the `-U' option may only be used with the `-l' option")); sudo_warnx(U_("the `-U' option may only be used with the `-l' option"));
usage(1); usage();
} }
if (ISSET(tgetpass_flags, TGP_STDIN) && ISSET(tgetpass_flags, TGP_ASKPASS)) { if (ISSET(tgetpass_flags, TGP_STDIN) && ISSET(tgetpass_flags, TGP_ASKPASS)) {
sudo_warnx(U_("the `-A' and `-S' options may not be used together")); sudo_warnx(U_("the `-A' and `-S' options may not be used together"));
usage(1); usage();
} }
if ((argc == 0 && mode == MODE_EDIT) || if ((argc == 0 && mode == MODE_EDIT) ||
(argc > 0 && !ISSET(mode, MODE_RUN | MODE_EDIT | MODE_CHECK))) (argc > 0 && !ISSET(mode, MODE_RUN | MODE_EDIT | MODE_CHECK)))
usage(1); usage();
if (argc == 0 && mode == MODE_RUN && !ISSET(flags, MODE_SHELL)) { if (argc == 0 && mode == MODE_RUN && !ISSET(flags, MODE_SHELL)) {
SET(flags, (MODE_IMPLIED_SHELL | MODE_SHELL)); SET(flags, (MODE_IMPLIED_SHELL | MODE_SHELL));
sudo_settings[ARG_IMPLIED_SHELL].value = "true"; sudo_settings[ARG_IMPLIED_SHELL].value = "true";
@@ -666,11 +666,11 @@ usage_out(const char *buf)
} }
/* /*
* Give usage message and exit. * Display usage message.
* The actual usage strings are in sudo_usage.h for configure substitution. * The actual usage strings are in sudo_usage.h for configure substitution.
*/ */
void static void
usage(int fatal) display_usage(int (*output)(const char *))
{ {
struct sudo_lbuf lbuf; struct sudo_lbuf lbuf;
char *uvec[6]; char *uvec[6];
@@ -696,27 +696,35 @@ usage(int fatal)
* tty width. * tty width.
*/ */
ulen = (int)strlen(getprogname()) + 8; ulen = (int)strlen(getprogname()) + 8;
sudo_lbuf_init(&lbuf, fatal ? usage_err : usage_out, ulen, NULL, sudo_lbuf_init(&lbuf, output, ulen, NULL,
user_details.ts_cols); user_details.ts_cols);
for (i = 0; uvec[i] != NULL; i++) { for (i = 0; uvec[i] != NULL; i++) {
sudo_lbuf_append(&lbuf, "usage: %s%s", getprogname(), uvec[i]); sudo_lbuf_append(&lbuf, "usage: %s%s", getprogname(), uvec[i]);
sudo_lbuf_print(&lbuf); sudo_lbuf_print(&lbuf);
} }
sudo_lbuf_destroy(&lbuf); sudo_lbuf_destroy(&lbuf);
if (fatal) }
exit(1);
/*
* Display usage message and exit.
*/
void
usage(void)
{
display_usage(usage_err);
exit(1);
} }
/* /*
* Tell which options are mutually exclusive and exit. * Tell which options are mutually exclusive and exit.
*/ */
static void static void
usage_excl(int fatal) usage_excl(void)
{ {
debug_decl(usage_excl, SUDO_DEBUG_ARGS); debug_decl(usage_excl, SUDO_DEBUG_ARGS);
sudo_warnx(U_("Only one of the -e, -h, -i, -K, -l, -s, -v or -V options may be specified")); sudo_warnx(U_("Only one of the -e, -h, -i, -K, -l, -s, -v or -V options may be specified"));
usage(fatal); usage();
} }
static void static void
@@ -734,7 +742,7 @@ help(void)
sudo_lbuf_append(&lbuf, _("%s - execute a command as another user\n\n"), pname); sudo_lbuf_append(&lbuf, _("%s - execute a command as another user\n\n"), pname);
sudo_lbuf_print(&lbuf); sudo_lbuf_print(&lbuf);
usage(0); display_usage(usage_out);
sudo_lbuf_append(&lbuf, _("\nOptions:\n")); sudo_lbuf_append(&lbuf, _("\nOptions:\n"));
sudo_lbuf_append(&lbuf, " -A, --askpass %s\n", sudo_lbuf_append(&lbuf, " -A, --askpass %s\n",

10
src/sudo.c
View File

@@ -1077,7 +1077,7 @@ policy_open(struct sudo_settings *settings, char * const user_info[],
if (ok != 1) { if (ok != 1) {
if (ok == -2) if (ok == -2)
usage(1); usage();
else { else {
/* XXX - audit */ /* XXX - audit */
sudo_fatalx(U_("unable to initialize policy plugin")); sudo_fatalx(U_("unable to initialize policy plugin"));
@@ -1165,7 +1165,7 @@ policy_check(int argc, char * const argv[],
*command_info); *command_info);
break; break;
case -2: case -2:
usage(1); usage();
break; break;
} }
@@ -1402,7 +1402,7 @@ iolog_open(struct sudo_settings *settings, char * const user_info[],
unlink_plugin(&io_plugins, plugin); unlink_plugin(&io_plugins, plugin);
break; break;
case -2: case -2:
usage(1); usage();
break; break;
default: default:
/* XXX - audit error */ /* XXX - audit error */
@@ -1556,7 +1556,7 @@ audit_open(struct sudo_settings *settings, char * const user_info[],
unlink_plugin(&audit_plugins, plugin); unlink_plugin(&audit_plugins, plugin);
break; break;
case -2: case -2:
usage(1); usage();
break; break;
default: default:
/* TODO: pass error message to other audit plugins */ /* TODO: pass error message to other audit plugins */
@@ -1769,7 +1769,7 @@ approval_check(struct sudo_settings *settings, char * const user_info[],
command_info); command_info);
break; break;
case -2: case -2:
usage(1); usage();
break; break;
} }

2
src/sudo.h
View File

@@ -233,7 +233,7 @@ extern int sudo_debug_instance;
int sudo_edit(struct command_details *details); int sudo_edit(struct command_details *details);
/* parse_args.c */ /* parse_args.c */
void usage(int); void usage(void) __attribute__((__noreturn__));
/* openbsd.c */ /* openbsd.c */
int os_init_openbsd(int argc, char *argv[], char *envp[]); int os_init_openbsd(int argc, char *argv[], char *envp[]);