2 * Copyright (c) 2000-2005, 2007-2009
3 * Todd C. Miller <Todd.Miller@courtesan.com>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 * Sponsored in part by the Defense Advanced Research Projects
18 * Agency (DARPA) and Air Force Research Laboratory, Air Force
19 * Materiel Command, USAF, under agreement number F39502-99-1-0512.
24 #include <sys/types.h>
25 #include <sys/param.h>
35 #endif /* STDC_HEADERS */
39 # ifdef HAVE_STRINGS_H
42 #endif /* HAVE_STRING_H */
45 #endif /* HAVE_UNISTD_H */
53 * Flags used in rebuild_env()
56 #define DID_TERM 0x0001
58 #define DID_PATH 0x0002
60 #define DID_HOME 0x0004
62 #define DID_SHELL 0x0008
64 #define DID_LOGNAME 0x0010
66 #define DID_USER 0x0020
68 #define DID_USERNAME 0x0040
70 #define DID_MAX 0x00ff
73 #define KEPT_TERM 0x0100
75 #define KEPT_PATH 0x0200
77 #define KEPT_HOME 0x0400
79 #define KEPT_SHELL 0x0800
81 #define KEPT_LOGNAME 0x1000
83 #define KEPT_USER 0x2000
85 #define KEPT_USERNAME 0x4000
87 #define KEPT_MAX 0xff00
90 #define VNULL (void *)NULL
93 char **envp; /* pointer to the new environment */
94 size_t env_size; /* size of new_environ in char **'s */
95 size_t env_len; /* number of slots used, not counting NULL */
101 void rebuild_env __P((int, int));
102 static void sudo_setenv __P((const char *, const char *, int));
103 static void sudo_putenv __P((char *, int, int));
105 extern char **environ; /* global environment */
108 * Copy of the sudo-managed environment.
110 static struct environment env;
113 * Default table of "bad" variables to remove from the environment.
114 * XXX - how to omit TERMCAP if it starts with '/'?
116 static const char *initial_badenv_table[] = {
141 #endif /* HAVE_KERB4 */
145 #endif /* HAVE_KERB5 */
150 #endif /* HAVE_SECURID */
151 "TERMINFO", /* terminfo, exclusive path to terminfo files */
152 "TERMINFO_DIRS", /* terminfo, path(s) to terminfo files */
153 "TERMPATH", /* termcap, path(s) to termcap files */
154 "TERMCAP", /* XXX - only if it starts with '/' */
155 "ENV", /* ksh, file to source before script runs */
156 "BASH_ENV", /* bash, file to source before script runs */
157 "PS4", /* bash, prefix for lines in xtrace mode */
158 "GLOBIGNORE", /* bash, globbing patterns to ignore */
159 "SHELLOPTS", /* bash, extra command line options */
160 "JAVA_TOOL_OPTIONS", /* java, extra command line options */
161 "PERLIO_DEBUG ", /* perl, debugging output file */
162 "PERLLIB", /* perl, search path for modules/includes */
163 "PERL5LIB", /* perl 5, search path for modules/includes */
164 "PERL5OPT", /* perl 5, extra command line options */
165 "PERL5DB", /* perl 5, command used to load debugger */
166 "FPATH", /* ksh, search path for functions */
167 "NULLCMD", /* zsh, command for null file redirection */
168 "READNULLCMD", /* zsh, command for null file redirection */
169 "ZDOTDIR", /* zsh, search path for dot files */
170 "TMPPREFIX", /* zsh, prefix for temporary files */
171 "PYTHONHOME", /* python, module search path */
172 "PYTHONPATH", /* python, search path */
173 "PYTHONINSPECT", /* python, allow inspection */
174 "RUBYLIB", /* ruby, library load path */
175 "RUBYOPT", /* ruby, extra command line options */
180 * Default table of variables to check for '%' and '/' characters.
182 static const char *initial_checkenv_table[] = {
193 * Default table of variables to preserve in the environment.
195 static const char *initial_keepenv_table[] = {
213 * Similar to setenv(3) but operates on sudo's private copy of the environment
214 * (not environ) and it always overwrites. The dupcheck param determines
215 * whether we need to verify that the variable is not already set.
218 sudo_setenv(var, val, dupcheck)
226 esize = strlen(var) + 1 + strlen(val) + 1;
227 estring = emalloc(esize);
229 /* Build environment string and insert it. */
230 if (strlcpy(estring, var, esize) >= esize ||
231 strlcat(estring, "=", esize) >= esize ||
232 strlcat(estring, val, esize) >= esize) {
234 errorx(1, "internal error, sudo_setenv() overflow");
236 sudo_putenv(estring, dupcheck, TRUE);
240 * Version of setenv(3) that uses our own environ pointer.
241 * Will sync with environ as needed.
244 setenv(var, val, overwrite)
253 if (!var || *var == '\0')
257 * POSIX says a var name with '=' is an error but BSD
258 * just ignores the '=' and anything after it.
260 for (cp = var; *cp && *cp != '='; cp++)
262 esize = (size_t)(cp - var) + 2;
264 esize += strlen(val); /* glibc treats a NULL val as "" */
267 /* Allocate and fill in estring. */
268 estring = ep = emalloc(esize);
269 for (cp = var; *cp && *cp != '='; cp++)
273 for (cp = val; *cp; cp++)
278 /* Sync env.envp with environ as needed. */
279 if (env.envp != environ) {
283 for (ep = environ; *ep != NULL; ep++)
286 if (len + 2 > env.env_size) {
288 env.env_size = len + 2 + 128;
289 env.envp = emalloc2(env.env_size, sizeof(char *));
291 memset(env.envp, 0, env.env_size * sizeof(char *));
294 memcpy(env.envp, environ, len * sizeof(char *));
295 env.envp[len] = NULL;
300 if (env.envp[env.env_len] != NULL)
301 errorx(1, "setenv: corrupted envp, len mismatch");
304 sudo_putenv(estring, TRUE, overwrite);
309 * Version of unsetenv(3) that uses our own environ pointer.
310 * Will sync with environ as needed.
323 if (strchr(var, '=') != NULL) {
332 /* Make sure we are operating on the current environment. */
333 /* XXX - this could be optimized to include the search */
334 if (env.envp != environ) {
335 for (ep = environ; *ep != NULL; ep++)
338 if (len + 1 > env.env_size) {
340 env.env_size = len + 1 + 128;
341 env.envp = emalloc2(env.env_size, sizeof(char *));
343 memset(env.envp, 0, env.env_size * sizeof(char *));
346 memcpy(env.envp, environ, len * sizeof(char *));
347 env.envp[len] = NULL;
352 if (env.envp[env.env_len] != NULL)
353 errorx(1, "unsetenv: corrupted envp, len mismatch");
358 for (ep = env.envp; *ep; ep++) {
359 if (strncmp(var, *ep, len) == 0 && (*ep)[len] == '=') {
360 /* Found it; shift remainder + NULL over by one and update len. */
362 (env.env_len - (ep - env.envp)) * sizeof(char *));
367 #ifndef UNSETENV_VOID
373 * Version of putenv(3) that uses our own environ pointer.
374 * Will sync with environ as needed.
378 putenv(const char *string)
384 if (strchr(string, '=') == NULL) {
388 /* Sync env.envp with environ as needed. */
389 if (env.envp != environ) {
393 for (ep = environ; *ep != NULL; ep++)
396 if (len + 2 > env.env_size) {
398 env.env_size = len + 2 + 128;
399 env.envp = emalloc2(env.env_size, sizeof(char *));
401 memset(env.envp, 0, env.env_size * sizeof(char *));
404 memcpy(env.envp, environ, len * sizeof(char *));
405 env.envp[len] = NULL;
410 if (env.envp[env.env_len] != NULL)
411 errorx(1, "putenv: corrupted envp, len mismatch");
414 sudo_putenv((char *)string, TRUE, TRUE);
419 * Similar to putenv(3) but operates on sudo's private copy of the
420 * environment (not environ) and it always overwrites. The dupcheck param
421 * determines whether we need to verify that the variable is not already set.
422 * Will only overwrite an existing variable if overwrite is set.
425 sudo_putenv(str, dupcheck, overwrite)
433 /* Make sure there is room for the new entry plus a NULL. */
434 if (env.env_len + 2 > env.env_size) {
436 env.envp = erealloc3(env.envp, env.env_size, sizeof(char *));
438 memset(env.envp + env.env_len, 0,
439 (env.env_size - env.env_len) * sizeof(char *));
445 if (env.envp[env.env_len] != NULL)
446 errorx(1, "sudo_putenv: corrupted envp, len mismatch");
450 len = (strchr(str, '=') - str) + 1;
451 for (ep = env.envp; *ep; ep++) {
452 if (strncmp(str, *ep, len) == 0) {
459 ep = env.envp + env.env_len;
467 * Check the env_delete blacklist.
468 * Returns TRUE if the variable was found, else false.
471 matches_env_delete(var)
474 struct list_member *cur;
476 int iswild, match = FALSE;
478 /* Skip anything listed in env_delete. */
479 for (cur = def_env_delete; cur; cur = cur->next) {
480 len = strlen(cur->value);
481 /* Deal with '*' wildcard */
482 if (cur->value[len - 1] == '*') {
487 if (strncmp(cur->value, var, len) == 0 &&
488 (iswild || var[len] == '=')) {
497 * Apply the env_check list.
498 * Returns TRUE if the variable is allowed, FALSE if denied
502 matches_env_check(var)
505 struct list_member *cur;
507 int iswild, keepit = -1;
509 for (cur = def_env_check; cur; cur = cur->next) {
510 len = strlen(cur->value);
511 /* Deal with '*' wildcard */
512 if (cur->value[len - 1] == '*') {
517 if (strncmp(cur->value, var, len) == 0 &&
518 (iswild || var[len] == '=')) {
519 keepit = !strpbrk(var, "/%");
527 * Check the env_keep list.
528 * Returns TRUE if the variable is allowed else FALSE.
531 matches_env_keep(var)
534 struct list_member *cur;
536 int iswild, keepit = FALSE;
538 for (cur = def_env_keep; cur; cur = cur->next) {
539 len = strlen(cur->value);
540 /* Deal with '*' wildcard */
541 if (cur->value[len - 1] == '*') {
546 if (strncmp(cur->value, var, len) == 0 &&
547 (iswild || var[len] == '=')) {
556 * Build a new environment and ether clear potentially dangerous
557 * variables from the old one or start with a clean slate.
558 * Also adds sudo-specific variables (SUDO_*).
561 rebuild_env(sudo_mode, noexec)
565 char **old_envp, **ep, *cp, *ps1;
566 char idbuf[MAX_UID_T_LEN];
570 * Either clean out the environment or reset to a safe default.
577 env.envp = emalloc2(env.env_size, sizeof(char *));
579 memset(env.envp, 0, env.env_size * sizeof(char *));
581 if (def_env_reset || ISSET(sudo_mode, MODE_LOGIN_SHELL)) {
582 /* Pull in vars we want to keep from the old environment. */
583 for (ep = environ; *ep; ep++) {
586 /* Skip variables with values beginning with () (bash functions) */
587 if ((cp = strchr(*ep, '=')) != NULL) {
588 if (strncmp(cp, "=() ", 3) == 0)
593 * First check certain variables for '%' and '/' characters.
594 * If no match there, check the keep list.
595 * If nothing matched, we remove it from the environment.
597 keepit = matches_env_check(*ep);
599 keepit = matches_env_keep(*ep);
601 /* For SUDO_PS1 -> PS1 conversion. */
602 if (strncmp(*ep, "SUDO_PS1=", 8) == 0)
606 /* Preserve variable. */
609 if (strncmp(*ep, "HOME=", 5) == 0)
610 SET(didvar, DID_HOME);
613 if (strncmp(*ep, "LOGNAME=", 8) == 0)
614 SET(didvar, DID_LOGNAME);
617 if (strncmp(*ep, "PATH=", 5) == 0)
618 SET(didvar, DID_PATH);
621 if (strncmp(*ep, "SHELL=", 6) == 0)
622 SET(didvar, DID_SHELL);
625 if (strncmp(*ep, "TERM=", 5) == 0)
626 SET(didvar, DID_TERM);
629 if (strncmp(*ep, "USER=", 5) == 0)
630 SET(didvar, DID_USER);
631 if (strncmp(*ep, "USERNAME=", 5) == 0)
632 SET(didvar, DID_USERNAME);
635 sudo_putenv(*ep, FALSE, FALSE);
638 didvar |= didvar << 8; /* convert DID_* to KEPT_* */
641 * Add in defaults. In -i mode these come from the runas user,
642 * otherwise they may be from the user's environment (depends
643 * on sudoers options).
645 if (ISSET(sudo_mode, MODE_LOGIN_SHELL)) {
646 sudo_setenv("HOME", runas_pw->pw_dir, ISSET(didvar, DID_HOME));
647 sudo_setenv("SHELL", runas_pw->pw_shell, ISSET(didvar, DID_SHELL));
648 sudo_setenv("LOGNAME", runas_pw->pw_name,
649 ISSET(didvar, DID_LOGNAME));
650 sudo_setenv("USER", runas_pw->pw_name, ISSET(didvar, DID_USER));
651 sudo_setenv("USERNAME", runas_pw->pw_name,
652 ISSET(didvar, DID_USERNAME));
654 if (!ISSET(didvar, DID_HOME))
655 sudo_setenv("HOME", user_dir, FALSE);
656 if (!ISSET(didvar, DID_SHELL))
657 sudo_setenv("SHELL", sudo_user.pw->pw_shell, FALSE);
658 if (!ISSET(didvar, DID_LOGNAME))
659 sudo_setenv("LOGNAME", user_name, FALSE);
660 if (!ISSET(didvar, DID_USER))
661 sudo_setenv("USER", user_name, FALSE);
662 if (!ISSET(didvar, DID_USERNAME))
663 sudo_setenv("USERNAME", user_name, FALSE);
667 * Copy environ entries as long as they don't match env_delete or
670 for (ep = environ; *ep; ep++) {
673 /* Skip variables with values beginning with () (bash functions) */
674 if ((cp = strchr(*ep, '=')) != NULL) {
675 if (strncmp(cp, "=() ", 3) == 0)
680 * First check variables against the blacklist in env_delete.
681 * If no match there check for '%' and '/' characters.
683 okvar = matches_env_delete(*ep) != TRUE;
685 okvar = matches_env_check(*ep) != FALSE;
688 if (strncmp(*ep, "SUDO_PS1=", 9) == 0)
690 else if (strncmp(*ep, "PATH=", 5) == 0)
691 SET(didvar, DID_PATH);
692 else if (strncmp(*ep, "TERM=", 5) == 0)
693 SET(didvar, DID_TERM);
694 sudo_putenv(*ep, FALSE, FALSE);
698 /* Replace the PATH envariable with a secure one? */
699 if (def_secure_path && !user_is_exempt()) {
700 sudo_setenv("PATH", def_secure_path, TRUE);
701 SET(didvar, DID_PATH);
704 /* Set $USER, $LOGNAME and $USERNAME to target if "set_logname" is true. */
705 /* XXX - not needed for MODE_LOGIN_SHELL */
706 if (def_set_logname && runas_pw->pw_name) {
707 if (!ISSET(didvar, KEPT_LOGNAME))
708 sudo_setenv("LOGNAME", runas_pw->pw_name, TRUE);
709 if (!ISSET(didvar, KEPT_USER))
710 sudo_setenv("USER", runas_pw->pw_name, TRUE);
711 if (!ISSET(didvar, KEPT_USERNAME))
712 sudo_setenv("USERNAME", runas_pw->pw_name, TRUE);
715 /* Set $HOME for `sudo -H'. Only valid at PERM_FULL_RUNAS. */
716 /* XXX - not needed for MODE_LOGIN_SHELL */
717 if (runas_pw->pw_dir) {
718 if (ISSET(sudo_mode, MODE_RESET_HOME) ||
719 (ISSET(sudo_mode, MODE_RUN) && (def_always_set_home ||
720 (ISSET(sudo_mode, MODE_SHELL) && def_set_home))))
721 sudo_setenv("HOME", runas_pw->pw_dir, TRUE);
724 /* Provide default values for $TERM and $PATH if they are not set. */
725 if (!ISSET(didvar, DID_TERM))
726 sudo_putenv("TERM=unknown", FALSE, FALSE);
727 if (!ISSET(didvar, DID_PATH))
728 sudo_setenv("PATH", _PATH_DEFPATH, FALSE);
731 * Preload a noexec file? For a list of LD_PRELOAD-alikes, see
732 * http://www.fortran-2000.com/ArnaudRecipes/sharedlib.html
733 * XXX - should prepend to original value, if any
735 if (noexec && def_noexec_file != NULL) {
736 #if defined(__darwin__) || defined(__APPLE__)
737 sudo_setenv("DYLD_INSERT_LIBRARIES", def_noexec_file, TRUE);
738 sudo_setenv("DYLD_FORCE_FLAT_NAMESPACE", "", TRUE);
740 # if defined(__osf__) || defined(__sgi)
741 easprintf(&cp, "%s:DEFAULT", def_noexec_file);
742 sudo_setenv("_RLD_LIST", cp, TRUE);
746 sudo_setenv("LDR_PRELOAD", def_noexec_file, TRUE);
748 sudo_setenv("LD_PRELOAD", def_noexec_file, TRUE);
750 # endif /* __osf__ || __sgi */
751 #endif /* __darwin__ || __APPLE__ */
754 /* Set PS1 if SUDO_PS1 is set. */
756 sudo_putenv(ps1, TRUE, TRUE);
758 /* Add the SUDO_COMMAND envariable (cmnd + args). */
760 easprintf(&cp, "%s %s", user_cmnd, user_args);
761 sudo_setenv("SUDO_COMMAND", cp, TRUE);
764 sudo_setenv("SUDO_COMMAND", user_cmnd, TRUE);
766 /* Add the SUDO_USER, SUDO_UID, SUDO_GID environment variables. */
767 sudo_setenv("SUDO_USER", user_name, TRUE);
768 snprintf(idbuf, sizeof(idbuf), "%lu", (unsigned long) user_uid);
769 sudo_setenv("SUDO_UID", idbuf, TRUE);
770 snprintf(idbuf, sizeof(idbuf), "%lu", (unsigned long) user_gid);
771 sudo_setenv("SUDO_GID", idbuf, TRUE);
773 /* Install new environment. */
779 insert_env_vars(env_vars)
780 struct list_member *env_vars;
782 struct list_member *cur;
784 if (env_vars == NULL)
787 /* Add user-specified environment variables. */
788 for (cur = env_vars; cur != NULL; cur = cur->next)
793 * Validate the list of environment variables passed in on the command
794 * line against env_delete, env_check, and env_keep.
795 * Calls log_error() if any specified variables are not allowed.
798 validate_env_vars(env_vars)
799 struct list_member *env_vars;
801 struct list_member *var;
802 char *eq, *bad = NULL;
803 size_t len, blen = 0, bsize = 0;
806 for (var = env_vars; var != NULL; var = var->next) {
807 if (def_secure_path && !user_is_exempt() &&
808 strncmp(var->value, "PATH=", 5) == 0) {
810 } else if (def_env_reset) {
811 okvar = matches_env_check(var->value);
813 okvar = matches_env_keep(var->value);
815 okvar = matches_env_delete(var->value) == FALSE;
817 okvar = matches_env_check(var->value) != FALSE;
819 if (okvar == FALSE) {
820 /* Not allowed, add to error string, allocating as needed. */
821 if ((eq = strchr(var->value, '=')) != NULL)
823 len = strlen(var->value) + 2;
824 if (blen + len >= bsize) {
827 } while (blen + len >= bsize);
828 bad = erealloc(bad, bsize);
831 strlcat(bad, var->value, bsize);
832 strlcat(bad, ", ", bsize);
839 bad[blen - 2] = '\0'; /* remove trailing ", " */
841 "sorry, you are not allowed to set the following environment variables: %s", bad);
848 * Read in /etc/environment ala AIX and Linux.
849 * Lines may be in either of three formats:
853 * with an optional "export" prefix so the shell can source the file.
854 * Invalid lines, blank lines, or lines consisting solely of a comment
855 * character are skipped.
858 read_env_file(path, overwrite)
863 char *cp, *var, *val;
864 size_t var_len, val_len;
866 if ((fp = fopen(path, "r")) == NULL)
869 while ((var = sudo_parseln(fp)) != NULL) {
870 /* Skip blank or comment lines */
874 /* Skip optional "export " */
875 if (strncmp(var, "export", 6) == 0 && isspace((unsigned char) var[6])) {
877 while (isspace((unsigned char) *var)) {
882 /* Must be of the form name=["']value['"] */
883 for (val = var; *val != '\0' && *val != '='; val++)
885 if (var == val || *val != '=')
887 var_len = (size_t)(val - var);
888 val_len = strlen(++val);
890 /* Strip leading and trailing single/double quotes */
891 if ((val[0] == '\'' || val[0] == '\"') && val[0] == val[val_len - 1]) {
892 val[val_len - 1] = '\0';
897 cp = emalloc(var_len + 1 + val_len + 1);
898 memcpy(cp, var, var_len + 1); /* includes '=' */
899 memcpy(cp + var_len + 1, val, val_len + 1); /* includes NUL */
901 sudo_putenv(cp, TRUE, overwrite);
909 struct list_member *cur;
912 /* Fill in the "env_delete" list. */
913 for (p = initial_badenv_table; *p; p++) {
914 cur = emalloc(sizeof(struct list_member));
915 cur->value = estrdup(*p);
916 cur->next = def_env_delete;
917 def_env_delete = cur;
920 /* Fill in the "env_check" list. */
921 for (p = initial_checkenv_table; *p; p++) {
922 cur = emalloc(sizeof(struct list_member));
923 cur->value = estrdup(*p);
924 cur->next = def_env_check;
928 /* Fill in the "env_keep" list. */
929 for (p = initial_keepenv_table; *p; p++) {
930 cur = emalloc(sizeof(struct list_member));
931 cur->value = estrdup(*p);
932 cur->next = def_env_keep;