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 __unused static const char rcsid[] = "$Sudo: env.c,v 1.106 2009/06/23 18:24:42 millert Exp $";
57 * Flags used in rebuild_env()
60 #define DID_TERM 0x0001
62 #define DID_PATH 0x0002
64 #define DID_HOME 0x0004
66 #define DID_SHELL 0x0008
68 #define DID_LOGNAME 0x0010
70 #define DID_USER 0x0020
72 #define DID_USERNAME 0x0040
74 #define DID_MAX 0x00ff
77 #define KEPT_TERM 0x0100
79 #define KEPT_PATH 0x0200
81 #define KEPT_HOME 0x0400
83 #define KEPT_SHELL 0x0800
85 #define KEPT_LOGNAME 0x1000
87 #define KEPT_USER 0x2000
89 #define KEPT_USERNAME 0x4000
91 #define KEPT_MAX 0xff00
94 #define VNULL (void *)NULL
97 char **envp; /* pointer to the new environment */
98 size_t env_size; /* size of new_environ in char **'s */
99 size_t env_len; /* number of slots used, not counting NULL */
105 void rebuild_env __P((int, int));
106 static void sudo_setenv __P((const char *, const char *, int));
107 static void sudo_putenv __P((char *, int, int));
109 extern char **environ; /* global environment */
112 * Copy of the sudo-managed environment.
114 static struct environment env;
117 * Default table of "bad" variables to remove from the environment.
118 * XXX - how to omit TERMCAP if it starts with '/'?
120 static const char *initial_badenv_table[] = {
147 #endif /* HAVE_KERB4 */
151 #endif /* HAVE_KERB5 */
156 #endif /* HAVE_SECURID */
157 "TERMINFO", /* terminfo, exclusive path to terminfo files */
158 "TERMINFO_DIRS", /* terminfo, path(s) to terminfo files */
159 "TERMPATH", /* termcap, path(s) to termcap files */
160 "TERMCAP", /* XXX - only if it starts with '/' */
161 "ENV", /* ksh, file to source before script runs */
162 "BASH_ENV", /* bash, file to source before script runs */
163 "PS4", /* bash, prefix for lines in xtrace mode */
164 "GLOBIGNORE", /* bash, globbing patterns to ignore */
165 "SHELLOPTS", /* bash, extra command line options */
166 "JAVA_TOOL_OPTIONS", /* java, extra command line options */
167 "PERLIO_DEBUG ", /* perl, debugging output file */
168 "PERLLIB", /* perl, search path for modules/includes */
169 "PERL5LIB", /* perl 5, search path for modules/includes */
170 "PERL5OPT", /* perl 5, extra command line options */
171 "PERL5DB", /* perl 5, command used to load debugger */
172 "FPATH", /* ksh, search path for functions */
173 "NULLCMD", /* zsh, command for null file redirection */
174 "READNULLCMD", /* zsh, command for null file redirection */
175 "ZDOTDIR", /* zsh, search path for dot files */
176 "TMPPREFIX", /* zsh, prefix for temporary files */
177 "PYTHONHOME", /* python, module search path */
178 "PYTHONPATH", /* python, search path */
179 "PYTHONINSPECT", /* python, allow inspection */
180 "RUBYLIB", /* ruby, library load path */
181 "RUBYOPT", /* ruby, extra command line options */
186 * Default table of variables to check for '%' and '/' characters.
188 static const char *initial_checkenv_table[] = {
199 * Default table of variables to preserve in the environment.
201 static const char *initial_keepenv_table[] = {
219 * Similar to setenv(3) but operates on sudo's private copy of the environment
220 * (not environ) and it always overwrites. The dupcheck param determines
221 * whether we need to verify that the variable is not already set.
224 sudo_setenv(var, val, dupcheck)
232 esize = strlen(var) + 1 + strlen(val) + 1;
233 estring = emalloc(esize);
235 /* Build environment string and insert it. */
236 if (strlcpy(estring, var, esize) >= esize ||
237 strlcat(estring, "=", esize) >= esize ||
238 strlcat(estring, val, esize) >= esize) {
240 errorx(1, "internal error, sudo_setenv() overflow");
242 sudo_putenv(estring, dupcheck, TRUE);
246 * Version of setenv(3) that uses our own environ pointer.
247 * Will sync with environ as needed.
250 setenv(var, val, overwrite)
259 if (!var || *var == '\0')
263 * POSIX says a var name with '=' is an error but BSD
264 * just ignores the '=' and anything after it.
266 for (cp = var; *cp && *cp != '='; cp++)
268 esize = (size_t)(cp - var) + 2;
270 esize += strlen(val); /* glibc treats a NULL val as "" */
273 /* Allocate and fill in estring. */
274 estring = ep = emalloc(esize);
275 for (cp = var; *cp && *cp != '='; cp++)
279 for (cp = val; *cp; cp++)
284 /* Sync env.envp with environ as needed. */
285 if (env.envp != environ) {
289 for (ep = environ; *ep != NULL; ep++)
292 if (len + 2 > env.env_size) {
294 env.env_size = len + 2 + 128;
295 env.envp = emalloc2(env.env_size, sizeof(char *));
297 memset(env.envp, 0, env.env_size * sizeof(char *));
300 memcpy(env.envp, environ, len * sizeof(char *));
301 env.envp[len] = NULL;
306 if (env.envp[env.env_len] != NULL)
307 errorx(1, "setenv: corrupted envp, len mismatch");
310 sudo_putenv(estring, TRUE, overwrite);
315 * Version of unsetenv(3) that uses our own environ pointer.
316 * Will sync with environ as needed.
329 if (strchr(var, '=') != NULL) {
338 /* Make sure we are operating on the current environment. */
339 /* XXX - this could be optimized to include the search */
340 if (env.envp != environ) {
341 for (ep = environ; *ep != NULL; ep++)
344 if (len + 1 > env.env_size) {
346 env.env_size = len + 1 + 128;
347 env.envp = emalloc2(env.env_size, sizeof(char *));
349 memset(env.envp, 0, env.env_size * sizeof(char *));
352 memcpy(env.envp, environ, len * sizeof(char *));
353 env.envp[len] = NULL;
358 if (env.envp[env.env_len] != NULL)
359 errorx(1, "unsetenv: corrupted envp, len mismatch");
364 for (ep = env.envp; *ep; ep++) {
365 if (strncmp(var, *ep, len) == 0 && (*ep)[len] == '=') {
366 /* Found it; shift remainder + NULL over by one and update len. */
368 (env.env_len - (ep - env.envp)) * sizeof(char *));
373 #ifndef UNSETENV_VOID
379 * Version of putenv(3) that uses our own environ pointer.
380 * Will sync with environ as needed.
384 putenv(const char *string)
390 if (strchr(string, '=') == NULL) {
394 /* Sync env.envp with environ as needed. */
395 if (env.envp != environ) {
399 for (ep = environ; *ep != NULL; ep++)
402 if (len + 2 > env.env_size) {
404 env.env_size = len + 2 + 128;
405 env.envp = emalloc2(env.env_size, sizeof(char *));
407 memset(env.envp, 0, env.env_size * sizeof(char *));
410 memcpy(env.envp, environ, len * sizeof(char *));
411 env.envp[len] = NULL;
416 if (env.envp[env.env_len] != NULL)
417 errorx(1, "putenv: corrupted envp, len mismatch");
420 sudo_putenv((char *)string, TRUE, TRUE);
425 * Similar to putenv(3) but operates on sudo's private copy of the
426 * environment (not environ) and it always overwrites. The dupcheck param
427 * determines whether we need to verify that the variable is not already set.
428 * Will only overwrite an existing variable if overwrite is set.
431 sudo_putenv(str, dupcheck, overwrite)
439 /* Make sure there is room for the new entry plus a NULL. */
440 if (env.env_len + 2 > env.env_size) {
442 env.envp = erealloc3(env.envp, env.env_size, sizeof(char *));
444 memset(env.envp + env.env_len, 0,
445 (env.env_size - env.env_len) * sizeof(char *));
451 if (env.envp[env.env_len] != NULL)
452 errorx(1, "sudo_putenv: corrupted envp, len mismatch");
456 len = (strchr(str, '=') - str) + 1;
457 for (ep = env.envp; *ep; ep++) {
458 if (strncmp(str, *ep, len) == 0) {
465 ep = env.envp + env.env_len;
473 * Check the env_delete blacklist.
474 * Returns TRUE if the variable was found, else false.
477 matches_env_delete(var)
480 struct list_member *cur;
482 int iswild, match = FALSE;
484 /* Skip anything listed in env_delete. */
485 for (cur = def_env_delete; cur; cur = cur->next) {
486 len = strlen(cur->value);
487 /* Deal with '*' wildcard */
488 if (cur->value[len - 1] == '*') {
493 if (strncmp(cur->value, var, len) == 0 &&
494 (iswild || var[len] == '=')) {
503 * Apply the env_check list.
504 * Returns TRUE if the variable is allowed, FALSE if denied
508 matches_env_check(var)
511 struct list_member *cur;
513 int iswild, keepit = -1;
515 for (cur = def_env_check; cur; cur = cur->next) {
516 len = strlen(cur->value);
517 /* Deal with '*' wildcard */
518 if (cur->value[len - 1] == '*') {
523 if (strncmp(cur->value, var, len) == 0 &&
524 (iswild || var[len] == '=')) {
525 keepit = !strpbrk(var, "/%");
533 * Check the env_keep list.
534 * Returns TRUE if the variable is allowed else FALSE.
537 matches_env_keep(var)
540 struct list_member *cur;
542 int iswild, keepit = FALSE;
544 for (cur = def_env_keep; cur; cur = cur->next) {
545 len = strlen(cur->value);
546 /* Deal with '*' wildcard */
547 if (cur->value[len - 1] == '*') {
552 if (strncmp(cur->value, var, len) == 0 &&
553 (iswild || var[len] == '=')) {
562 * Build a new environment and ether clear potentially dangerous
563 * variables from the old one or start with a clean slate.
564 * Also adds sudo-specific variables (SUDO_*).
567 rebuild_env(sudo_mode, noexec)
571 char **old_envp, **ep, *cp, *ps1;
572 char idbuf[MAX_UID_T_LEN];
576 * Either clean out the environment or reset to a safe default.
583 env.envp = emalloc2(env.env_size, sizeof(char *));
585 memset(env.envp, 0, env.env_size * sizeof(char *));
587 if (def_env_reset || ISSET(sudo_mode, MODE_LOGIN_SHELL)) {
588 /* Pull in vars we want to keep from the old environment. */
589 for (ep = environ; *ep; ep++) {
592 /* Skip variables with values beginning with () (bash functions) */
593 if ((cp = strchr(*ep, '=')) != NULL) {
594 if (strncmp(cp, "=() ", 3) == 0)
599 * First check certain variables for '%' and '/' characters.
600 * If no match there, check the keep list.
601 * If nothing matched, we remove it from the environment.
603 keepit = matches_env_check(*ep);
605 keepit = matches_env_keep(*ep);
607 if (!strncmp (*ep, "DISPLAY=",8)
608 || !strncmp (*ep, "XAUTHORITY=", 11)
609 || !strncmp (*ep, "XAUTHORIZATION=", 15)
610 || !strncmp (*ep, "XAPPLRESDIR=", 12)
611 || !strncmp (*ep, "XFILESEARCHPATH=", 16)
612 || !strncmp (*ep, "XUSERFILESEARCHPATH=", 20)
613 || !strncmp (*ep, "LANG=", 5)
614 || !strncmp (*ep, "LANGUAGE=", 9)
615 || !strncmp (*ep, "LC_", 3))
618 /* For SUDO_PS1 -> PS1 conversion. */
619 if (strncmp(*ep, "SUDO_PS1=", 8) == 0)
623 /* Preserve variable. */
626 if (strncmp(*ep, "HOME=", 5) == 0)
627 SET(didvar, DID_HOME);
630 if (strncmp(*ep, "LOGNAME=", 8) == 0)
631 SET(didvar, DID_LOGNAME);
634 if (strncmp(*ep, "PATH=", 5) == 0)
635 SET(didvar, DID_PATH);
638 if (strncmp(*ep, "SHELL=", 6) == 0)
639 SET(didvar, DID_SHELL);
642 if (strncmp(*ep, "TERM=", 5) == 0)
643 SET(didvar, DID_TERM);
646 if (strncmp(*ep, "USER=", 5) == 0)
647 SET(didvar, DID_USER);
648 if (strncmp(*ep, "USERNAME=", 5) == 0)
649 SET(didvar, DID_USERNAME);
652 sudo_putenv(*ep, FALSE, FALSE);
655 didvar |= didvar << 8; /* convert DID_* to KEPT_* */
658 * Add in defaults. In -i mode these come from the runas user,
659 * otherwise they may be from the user's environment (depends
660 * on sudoers options).
662 if (ISSET(sudo_mode, MODE_LOGIN_SHELL)) {
663 sudo_setenv("HOME", runas_pw->pw_dir, ISSET(didvar, DID_HOME));
664 sudo_setenv("SHELL", runas_pw->pw_shell, ISSET(didvar, DID_SHELL));
665 sudo_setenv("LOGNAME", runas_pw->pw_name,
666 ISSET(didvar, DID_LOGNAME));
667 sudo_setenv("USER", runas_pw->pw_name, ISSET(didvar, DID_USER));
668 sudo_setenv("USERNAME", runas_pw->pw_name,
669 ISSET(didvar, DID_USERNAME));
671 if (!ISSET(didvar, DID_HOME))
672 sudo_setenv("HOME", user_dir, FALSE);
673 if (!ISSET(didvar, DID_SHELL))
674 sudo_setenv("SHELL", sudo_user.pw->pw_shell, FALSE);
675 if (!ISSET(didvar, DID_LOGNAME))
676 sudo_setenv("LOGNAME", user_name, FALSE);
677 if (!ISSET(didvar, DID_USER))
678 sudo_setenv("USER", user_name, FALSE);
679 if (!ISSET(didvar, DID_USERNAME))
680 sudo_setenv("USERNAME", user_name, FALSE);
684 * Copy environ entries as long as they don't match env_delete or
687 for (ep = environ; *ep; ep++) {
690 /* Skip variables with values beginning with () (bash functions) */
691 if ((cp = strchr(*ep, '=')) != NULL) {
692 if (strncmp(cp, "=() ", 3) == 0)
697 * First check variables against the blacklist in env_delete.
698 * If no match there check for '%' and '/' characters.
700 okvar = matches_env_delete(*ep) != TRUE;
702 okvar = matches_env_check(*ep) != FALSE;
705 if (strncmp(*ep, "SUDO_PS1=", 9) == 0)
707 else if (strncmp(*ep, "PATH=", 5) == 0)
708 SET(didvar, DID_PATH);
709 else if (strncmp(*ep, "TERM=", 5) == 0)
710 SET(didvar, DID_TERM);
711 sudo_putenv(*ep, FALSE, FALSE);
715 /* Replace the PATH envariable with a secure one? */
716 if (def_secure_path && !user_is_exempt()) {
717 sudo_setenv("PATH", def_secure_path, TRUE);
718 SET(didvar, DID_PATH);
721 /* Set $USER, $LOGNAME and $USERNAME to target if "set_logname" is true. */
722 /* XXX - not needed for MODE_LOGIN_SHELL */
723 if (def_set_logname && runas_pw->pw_name) {
724 if (!ISSET(didvar, KEPT_LOGNAME))
725 sudo_setenv("LOGNAME", runas_pw->pw_name, TRUE);
726 if (!ISSET(didvar, KEPT_USER))
727 sudo_setenv("USER", runas_pw->pw_name, TRUE);
728 if (!ISSET(didvar, KEPT_USERNAME))
729 sudo_setenv("USERNAME", runas_pw->pw_name, TRUE);
732 /* Set $HOME for `sudo -H'. Only valid at PERM_FULL_RUNAS. */
733 /* XXX - not needed for MODE_LOGIN_SHELL */
734 if (runas_pw->pw_dir) {
735 if (ISSET(sudo_mode, MODE_RESET_HOME) ||
736 (ISSET(sudo_mode, MODE_RUN) && (def_always_set_home ||
737 (ISSET(sudo_mode, MODE_SHELL) && def_set_home))))
738 sudo_setenv("HOME", runas_pw->pw_dir, TRUE);
741 /* Provide default values for $TERM and $PATH if they are not set. */
742 if (!ISSET(didvar, DID_TERM))
743 sudo_putenv("TERM=unknown", FALSE, FALSE);
744 if (!ISSET(didvar, DID_PATH))
745 sudo_setenv("PATH", _PATH_DEFPATH, FALSE);
748 * Preload a noexec file? For a list of LD_PRELOAD-alikes, see
749 * http://www.fortran-2000.com/ArnaudRecipes/sharedlib.html
750 * XXX - should prepend to original value, if any
752 if (noexec && def_noexec_file != NULL) {
753 #if defined(__darwin__) || defined(__APPLE__)
754 sudo_setenv("DYLD_INSERT_LIBRARIES", def_noexec_file, TRUE);
755 sudo_setenv("DYLD_FORCE_FLAT_NAMESPACE", "", TRUE);
757 # if defined(__osf__) || defined(__sgi)
758 easprintf(&cp, "%s:DEFAULT", def_noexec_file);
759 sudo_setenv("_RLD_LIST", cp, TRUE);
763 sudo_setenv("LDR_PRELOAD", def_noexec_file, TRUE);
765 sudo_setenv("LD_PRELOAD", def_noexec_file, TRUE);
767 # endif /* __osf__ || __sgi */
768 #endif /* __darwin__ || __APPLE__ */
771 /* Set PS1 if SUDO_PS1 is set. */
773 sudo_putenv(ps1, TRUE, TRUE);
775 /* Add the SUDO_COMMAND envariable (cmnd + args). */
777 easprintf(&cp, "%s %s", user_cmnd, user_args);
778 sudo_setenv("SUDO_COMMAND", cp, TRUE);
781 sudo_setenv("SUDO_COMMAND", user_cmnd, TRUE);
783 /* Add the SUDO_USER, SUDO_UID, SUDO_GID environment variables. */
784 sudo_setenv("SUDO_USER", user_name, TRUE);
785 snprintf(idbuf, sizeof(idbuf), "%lu", (unsigned long) user_uid);
786 sudo_setenv("SUDO_UID", idbuf, TRUE);
787 snprintf(idbuf, sizeof(idbuf), "%lu", (unsigned long) user_gid);
788 sudo_setenv("SUDO_GID", idbuf, TRUE);
790 /* Install new environment. */
796 insert_env_vars(env_vars)
797 struct list_member *env_vars;
799 struct list_member *cur;
801 if (env_vars == NULL)
804 /* Add user-specified environment variables. */
805 for (cur = env_vars; cur != NULL; cur = cur->next)
810 * Validate the list of environment variables passed in on the command
811 * line against env_delete, env_check, and env_keep.
812 * Calls log_error() if any specified variables are not allowed.
815 validate_env_vars(env_vars)
816 struct list_member *env_vars;
818 struct list_member *var;
819 char *eq, *bad = NULL;
820 size_t len, blen = 0, bsize = 0;
823 for (var = env_vars; var != NULL; var = var->next) {
824 if (def_secure_path && !user_is_exempt() &&
825 strncmp(var->value, "PATH=", 5) == 0) {
827 } else if (def_env_reset) {
828 okvar = matches_env_check(var->value);
830 okvar = matches_env_keep(var->value);
832 okvar = matches_env_delete(var->value) == FALSE;
834 okvar = matches_env_check(var->value) != FALSE;
836 if (okvar == FALSE) {
837 /* Not allowed, add to error string, allocating as needed. */
838 if ((eq = strchr(var->value, '=')) != NULL)
840 len = strlen(var->value) + 2;
841 if (blen + len >= bsize) {
844 } while (blen + len >= bsize);
845 bad = erealloc(bad, bsize);
848 strlcat(bad, var->value, bsize);
849 strlcat(bad, ", ", bsize);
856 bad[blen - 2] = '\0'; /* remove trailing ", " */
858 "sorry, you are not allowed to set the following environment variables: %s", bad);
865 * Read in /etc/environment ala AIX and Linux.
866 * Lines may be in either of three formats:
870 * with an optional "export" prefix so the shell can source the file.
871 * Invalid lines, blank lines, or lines consisting solely of a comment
872 * character are skipped.
875 read_env_file(path, overwrite)
880 char *cp, *var, *val;
881 size_t var_len, val_len;
883 if ((fp = fopen(path, "r")) == NULL)
886 while ((var = sudo_parseln(fp)) != NULL) {
887 /* Skip blank or comment lines */
891 /* Skip optional "export " */
892 if (strncmp(var, "export", 6) == 0 && isspace((unsigned char) var[6])) {
894 while (isspace((unsigned char) *var)) {
899 /* Must be of the form name=["']value['"] */
900 for (val = var; *val != '\0' && *val != '='; val++)
902 if (var == val || *val != '=')
904 var_len = (size_t)(val - var);
905 val_len = strlen(++val);
907 /* Strip leading and trailing single/double quotes */
908 if ((val[0] == '\'' || val[0] == '\"') && val[0] == val[val_len - 1]) {
909 val[val_len - 1] = '\0';
914 cp = emalloc(var_len + 1 + val_len + 1);
915 memcpy(cp, var, var_len + 1); /* includes '=' */
916 memcpy(cp + var_len + 1, val, val_len + 1); /* includes NUL */
918 sudo_putenv(cp, TRUE, overwrite);
926 struct list_member *cur;
929 /* Fill in the "env_delete" list. */
930 for (p = initial_badenv_table; *p; p++) {
931 cur = emalloc(sizeof(struct list_member));
932 cur->value = estrdup(*p);
933 cur->next = def_env_delete;
934 def_env_delete = cur;
937 /* Fill in the "env_check" list. */
938 for (p = initial_checkenv_table; *p; p++) {
939 cur = emalloc(sizeof(struct list_member));
940 cur->value = estrdup(*p);
941 cur->next = def_env_check;
945 /* Fill in the "env_keep" list. */
946 for (p = initial_keepenv_table; *p; p++) {
947 cur = emalloc(sizeof(struct list_member));
948 cur->value = estrdup(*p);
949 cur->next = def_env_keep;