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.
320 char **ep = env.envp;
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 while (*ep != NULL) {
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 *));
364 /* Keep going, could be multiple instances of the var. */
369 #ifndef UNSETENV_VOID
375 * Version of putenv(3) that uses our own environ pointer.
376 * Will sync with environ as needed.
380 putenv(const char *string)
386 if (strchr(string, '=') == NULL) {
390 /* Sync env.envp with environ as needed. */
391 if (env.envp != environ) {
395 for (ep = environ; *ep != NULL; ep++)
398 if (len + 2 > env.env_size) {
400 env.env_size = len + 2 + 128;
401 env.envp = emalloc2(env.env_size, sizeof(char *));
403 memset(env.envp, 0, env.env_size * sizeof(char *));
406 memcpy(env.envp, environ, len * sizeof(char *));
407 env.envp[len] = NULL;
412 if (env.envp[env.env_len] != NULL)
413 errorx(1, "putenv: corrupted envp, len mismatch");
416 sudo_putenv((char *)string, TRUE, TRUE);
421 * Similar to putenv(3) but operates on sudo's private copy of the
422 * environment (not environ) and it always overwrites. The dupcheck param
423 * determines whether we need to verify that the variable is not already set.
424 * Will only overwrite an existing variable if overwrite is set.
427 sudo_putenv(str, dupcheck, overwrite)
436 /* Make sure there is room for the new entry plus a NULL. */
437 if (env.env_len + 2 > env.env_size) {
439 env.envp = erealloc3(env.envp, env.env_size, sizeof(char *));
441 memset(env.envp + env.env_len, 0,
442 (env.env_size - env.env_len) * sizeof(char *));
448 if (env.envp[env.env_len] != NULL)
449 errorx(1, "sudo_putenv: corrupted envp, len mismatch");
453 len = (strchr(str, '=') - str) + 1;
454 for (ep = env.envp; !found && *ep != NULL; ep++) {
455 if (strncmp(str, *ep, len) == 0) {
461 /* Prune out duplicate variables. */
462 if (found && overwrite) {
463 while (*ep != NULL) {
464 if (strncmp(str, *ep, len) == 0) {
466 (env.env_len - (ep - env.envp)) * sizeof(char *));
476 ep = env.envp + env.env_len;
484 * Check the env_delete blacklist.
485 * Returns TRUE if the variable was found, else false.
488 matches_env_delete(var)
491 struct list_member *cur;
493 int iswild, match = FALSE;
495 /* Skip anything listed in env_delete. */
496 for (cur = def_env_delete; cur; cur = cur->next) {
497 len = strlen(cur->value);
498 /* Deal with '*' wildcard */
499 if (cur->value[len - 1] == '*') {
504 if (strncmp(cur->value, var, len) == 0 &&
505 (iswild || var[len] == '=')) {
514 * Apply the env_check list.
515 * Returns TRUE if the variable is allowed, FALSE if denied
519 matches_env_check(var)
522 struct list_member *cur;
524 int iswild, keepit = -1;
526 for (cur = def_env_check; cur; cur = cur->next) {
527 len = strlen(cur->value);
528 /* Deal with '*' wildcard */
529 if (cur->value[len - 1] == '*') {
534 if (strncmp(cur->value, var, len) == 0 &&
535 (iswild || var[len] == '=')) {
536 keepit = !strpbrk(var, "/%");
544 * Check the env_keep list.
545 * Returns TRUE if the variable is allowed else FALSE.
548 matches_env_keep(var)
551 struct list_member *cur;
553 int iswild, keepit = FALSE;
555 for (cur = def_env_keep; cur; cur = cur->next) {
556 len = strlen(cur->value);
557 /* Deal with '*' wildcard */
558 if (cur->value[len - 1] == '*') {
563 if (strncmp(cur->value, var, len) == 0 &&
564 (iswild || var[len] == '=')) {
573 * Build a new environment and ether clear potentially dangerous
574 * variables from the old one or start with a clean slate.
575 * Also adds sudo-specific variables (SUDO_*).
578 rebuild_env(sudo_mode, noexec)
582 char **old_envp, **ep, *cp, *ps1;
583 char idbuf[MAX_UID_T_LEN];
587 * Either clean out the environment or reset to a safe default.
594 env.envp = emalloc2(env.env_size, sizeof(char *));
596 memset(env.envp, 0, env.env_size * sizeof(char *));
598 if (def_env_reset || ISSET(sudo_mode, MODE_LOGIN_SHELL)) {
599 /* Pull in vars we want to keep from the old environment. */
600 for (ep = environ; *ep; ep++) {
603 /* Skip variables with values beginning with () (bash functions) */
604 if ((cp = strchr(*ep, '=')) != NULL) {
605 if (strncmp(cp, "=() ", 3) == 0)
610 * First check certain variables for '%' and '/' characters.
611 * If no match there, check the keep list.
612 * If nothing matched, we remove it from the environment.
614 keepit = matches_env_check(*ep);
616 keepit = matches_env_keep(*ep);
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;