2
* Copyright (c) 2000-2005, 2007-2011
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 */
38
#endif /* HAVE_STRING_H */
41
#endif /* HAVE_STRINGS_H */
44
#endif /* HAVE_UNISTD_H */
52
* Flags used in rebuild_env()
55
#define DID_TERM 0x0001
57
#define DID_PATH 0x0002
59
#define DID_HOME 0x0004
61
#define DID_SHELL 0x0008
63
#define DID_LOGNAME 0x0010
65
#define DID_USER 0x0020
67
#define DID_USERNAME 0x0040
69
#define DID_MAIL 0x0080
71
#define DID_MAX 0x00ff
74
#define KEPT_TERM 0x0100
76
#define KEPT_PATH 0x0200
78
#define KEPT_HOME 0x0400
80
#define KEPT_SHELL 0x0800
82
#define KEPT_LOGNAME 0x1000
84
#define KEPT_USER 0x2000
86
#define KEPT_USERNAME 0x4000
88
#define KEPT_MAIL 0x8000
90
#define KEPT_MAX 0xff00
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
static void sudo_setenv(const char *, const char *, int);
102
static void sudo_putenv(char *, int, int);
105
* Copy of the sudo-managed environment.
107
static struct environment env;
110
* Default table of "bad" variables to remove from the environment.
111
* XXX - how to omit TERMCAP if it starts with '/'?
113
static const char *initial_badenv_table[] = {
138
#endif /* HAVE_KERB4 */
142
#endif /* HAVE_KERB5 */
147
#endif /* HAVE_SECURID */
148
"TERMINFO", /* terminfo, exclusive path to terminfo files */
149
"TERMINFO_DIRS", /* terminfo, path(s) to terminfo files */
150
"TERMPATH", /* termcap, path(s) to termcap files */
151
"TERMCAP", /* XXX - only if it starts with '/' */
152
"ENV", /* ksh, file to source before script runs */
153
"BASH_ENV", /* bash, file to source before script runs */
154
"PS4", /* bash, prefix for lines in xtrace mode */
155
"GLOBIGNORE", /* bash, globbing patterns to ignore */
156
"SHELLOPTS", /* bash, extra command line options */
157
"JAVA_TOOL_OPTIONS", /* java, extra command line options */
158
"PERLIO_DEBUG ", /* perl, debugging output file */
159
"PERLLIB", /* perl, search path for modules/includes */
160
"PERL5LIB", /* perl 5, search path for modules/includes */
161
"PERL5OPT", /* perl 5, extra command line options */
162
"PERL5DB", /* perl 5, command used to load debugger */
163
"FPATH", /* ksh, search path for functions */
164
"NULLCMD", /* zsh, command for null file redirection */
165
"READNULLCMD", /* zsh, command for null file redirection */
166
"ZDOTDIR", /* zsh, search path for dot files */
167
"TMPPREFIX", /* zsh, prefix for temporary files */
168
"PYTHONHOME", /* python, module search path */
169
"PYTHONPATH", /* python, search path */
170
"PYTHONINSPECT", /* python, allow inspection */
171
"PYTHONUSERBASE", /* python, per user site-packages directory */
172
"RUBYLIB", /* ruby, library load path */
173
"RUBYOPT", /* ruby, extra command line options */
178
* Default table of variables to check for '%' and '/' characters.
180
static const char *initial_checkenv_table[] = {
191
* Default table of variables to preserve in the environment.
193
static const char *initial_keepenv_table[] = {
213
* Initialize env based on envp.
216
env_init(char * const envp[])
221
for (ep = envp; *ep != NULL; ep++)
223
len = (size_t)(ep - envp);
226
env.env_size = len + 1 + 128;
227
env.envp = emalloc2(env.env_size, sizeof(char *));
229
memset(env.envp, 0, env.env_size * sizeof(char *));
231
memcpy(env.envp, envp, len * sizeof(char *));
232
env.envp[len] = '\0';
242
* Similar to setenv(3) but operates on sudo's private copy of the environment
243
* (not environ) and it always overwrites. The dupcheck param determines
244
* whether we need to verify that the variable is not already set.
247
sudo_setenv(const char *var, const char *val, int dupcheck)
252
esize = strlen(var) + 1 + strlen(val) + 1;
253
estring = emalloc(esize);
255
/* Build environment string and insert it. */
256
if (strlcpy(estring, var, esize) >= esize ||
257
strlcat(estring, "=", esize) >= esize ||
258
strlcat(estring, val, esize) >= esize) {
260
errorx(1, _("internal error, sudo_setenv() overflow"));
262
sudo_putenv(estring, dupcheck, TRUE);
266
* Similar to putenv(3) but operates on sudo's private copy of the
267
* environment (not environ) and it always overwrites. The dupcheck param
268
* determines whether we need to verify that the variable is not already set.
269
* Will only overwrite an existing variable if overwrite is set.
272
sudo_putenv(char *str, int dupcheck, int overwrite)
278
/* Make sure there is room for the new entry plus a NULL. */
279
if (env.env_len + 2 > env.env_size) {
281
env.envp = erealloc3(env.envp, env.env_size, sizeof(char *));
283
memset(env.envp + env.env_len, 0,
284
(env.env_size - env.env_len) * sizeof(char *));
289
if (env.envp[env.env_len] != NULL)
290
errorx(1, _("sudo_putenv: corrupted envp, length mismatch"));
294
len = (strchr(str, '=') - str) + 1;
295
for (ep = env.envp; !found && *ep != NULL; ep++) {
296
if (strncmp(str, *ep, len) == 0) {
302
/* Prune out duplicate variables. */
303
if (found && overwrite) {
304
while (*ep != NULL) {
305
if (strncmp(str, *ep, len) == 0) {
307
while ((*cur = *(cur + 1)) != NULL)
313
env.env_len = ep - env.envp;
318
ep = env.envp + env.env_len;
326
* Check the env_delete blacklist.
327
* Returns TRUE if the variable was found, else false.
330
matches_env_delete(const char *var)
332
struct list_member *cur;
334
int iswild, match = FALSE;
336
/* Skip anything listed in env_delete. */
337
for (cur = def_env_delete; cur; cur = cur->next) {
338
len = strlen(cur->value);
339
/* Deal with '*' wildcard */
340
if (cur->value[len - 1] == '*') {
345
if (strncmp(cur->value, var, len) == 0 &&
346
(iswild || var[len] == '=')) {
355
* Apply the env_check list.
356
* Returns TRUE if the variable is allowed, FALSE if denied
360
matches_env_check(const char *var)
362
struct list_member *cur;
364
int iswild, keepit = -1;
366
for (cur = def_env_check; cur; cur = cur->next) {
367
len = strlen(cur->value);
368
/* Deal with '*' wildcard */
369
if (cur->value[len - 1] == '*') {
374
if (strncmp(cur->value, var, len) == 0 &&
375
(iswild || var[len] == '=')) {
376
keepit = !strpbrk(var, "/%");
384
* Check the env_keep list.
385
* Returns TRUE if the variable is allowed else FALSE.
388
matches_env_keep(const char *var)
390
struct list_member *cur;
392
int iswild, keepit = FALSE;
394
/* Preserve SHELL variable for "sudo -s". */
395
if (ISSET(sudo_mode, MODE_SHELL) && strncmp(var, "SHELL=", 6) == 0)
398
for (cur = def_env_keep; cur; cur = cur->next) {
399
len = strlen(cur->value);
400
/* Deal with '*' wildcard */
401
if (cur->value[len - 1] == '*') {
406
if (strncmp(cur->value, var, len) == 0 &&
407
(iswild || var[len] == '=')) {
416
* Build a new environment and ether clear potentially dangerous
417
* variables from the old one or start with a clean slate.
418
* Also adds sudo-specific variables (SUDO_*).
423
char **old_envp, **ep, *cp, *ps1;
424
char idbuf[MAX_UID_T_LEN];
426
int reset_home = FALSE;
429
* Either clean out the environment or reset to a safe default.
436
env.envp = emalloc2(env.env_size, sizeof(char *));
438
memset(env.envp, 0, env.env_size * sizeof(char *));
441
/* Reset HOME based on target user if configured to. */
442
if (ISSET(sudo_mode, MODE_RUN)) {
443
if (def_always_set_home ||
444
ISSET(sudo_mode, MODE_RESET_HOME | MODE_LOGIN_SHELL) ||
445
(ISSET(sudo_mode, MODE_SHELL) && def_set_home))
449
if (def_env_reset || ISSET(sudo_mode, MODE_LOGIN_SHELL)) {
450
/* Pull in vars we want to keep from the old environment. */
451
for (ep = old_envp; *ep; ep++) {
454
/* Skip variables with values beginning with () (bash functions) */
455
if ((cp = strchr(*ep, '=')) != NULL) {
456
if (strncmp(cp, "=() ", 3) == 0)
461
* First check certain variables for '%' and '/' characters.
462
* If no match there, check the keep list.
463
* If nothing matched, we remove it from the environment.
465
keepit = matches_env_check(*ep);
467
keepit = matches_env_keep(*ep);
469
/* For SUDO_PS1 -> PS1 conversion. */
470
if (strncmp(*ep, "SUDO_PS1=", 8) == 0)
474
/* Preserve variable. */
477
if (strncmp(*ep, "HOME=", 5) == 0)
478
SET(didvar, DID_HOME);
481
if (strncmp(*ep, "LOGNAME=", 8) == 0)
482
SET(didvar, DID_LOGNAME);
485
if (strncmp(*ep, "MAIL=", 5) == 0)
486
SET(didvar, DID_MAIL);
489
if (strncmp(*ep, "PATH=", 5) == 0)
490
SET(didvar, DID_PATH);
493
if (strncmp(*ep, "SHELL=", 6) == 0)
494
SET(didvar, DID_SHELL);
497
if (strncmp(*ep, "TERM=", 5) == 0)
498
SET(didvar, DID_TERM);
501
if (strncmp(*ep, "USER=", 5) == 0)
502
SET(didvar, DID_USER);
503
if (strncmp(*ep, "USERNAME=", 5) == 0)
504
SET(didvar, DID_USERNAME);
507
sudo_putenv(*ep, FALSE, FALSE);
510
didvar |= didvar << 8; /* convert DID_* to KEPT_* */
513
* Add in defaults. In -i mode these come from the runas user,
514
* otherwise they may be from the user's environment (depends
515
* on sudoers options).
517
if (ISSET(sudo_mode, MODE_LOGIN_SHELL)) {
518
sudo_setenv("SHELL", runas_pw->pw_shell, ISSET(didvar, DID_SHELL));
519
sudo_setenv("LOGNAME", runas_pw->pw_name,
520
ISSET(didvar, DID_LOGNAME));
521
sudo_setenv("USER", runas_pw->pw_name, ISSET(didvar, DID_USER));
522
sudo_setenv("USERNAME", runas_pw->pw_name,
523
ISSET(didvar, DID_USERNAME));
525
if (!ISSET(didvar, DID_SHELL))
526
sudo_setenv("SHELL", sudo_user.pw->pw_shell, FALSE);
527
if (!ISSET(didvar, DID_LOGNAME))
528
sudo_setenv("LOGNAME", user_name, FALSE);
529
if (!ISSET(didvar, DID_USER))
530
sudo_setenv("USER", user_name, FALSE);
531
if (!ISSET(didvar, DID_USERNAME))
532
sudo_setenv("USERNAME", user_name, FALSE);
535
/* If we didn't keep HOME, reset it based on target user. */
536
if (!ISSET(didvar, KEPT_HOME))
540
* Set MAIL to target user in -i mode or if MAIL is not preserved
541
* from user's environment.
543
if (ISSET(sudo_mode, MODE_LOGIN_SHELL) || !ISSET(didvar, KEPT_MAIL)) {
545
if (cp[sizeof(_PATH_MAILDIR) - 2] == '/')
546
easprintf(&cp, "MAIL=%s%s", _PATH_MAILDIR, runas_pw->pw_name);
548
easprintf(&cp, "MAIL=%s/%s", _PATH_MAILDIR, runas_pw->pw_name);
549
sudo_putenv(cp, ISSET(didvar, DID_MAIL), TRUE);
553
* Copy environ entries as long as they don't match env_delete or
556
for (ep = old_envp; *ep; ep++) {
559
/* Skip variables with values beginning with () (bash functions) */
560
if ((cp = strchr(*ep, '=')) != NULL) {
561
if (strncmp(cp, "=() ", 3) == 0)
566
* First check variables against the blacklist in env_delete.
567
* If no match there check for '%' and '/' characters.
569
okvar = matches_env_delete(*ep) != TRUE;
571
okvar = matches_env_check(*ep) != FALSE;
574
if (strncmp(*ep, "SUDO_PS1=", 9) == 0)
576
else if (strncmp(*ep, "PATH=", 5) == 0)
577
SET(didvar, DID_PATH);
578
else if (strncmp(*ep, "TERM=", 5) == 0)
579
SET(didvar, DID_TERM);
580
sudo_putenv(*ep, FALSE, FALSE);
584
/* Replace the PATH envariable with a secure one? */
585
if (def_secure_path && !user_is_exempt()) {
586
sudo_setenv("PATH", def_secure_path, TRUE);
587
SET(didvar, DID_PATH);
591
* Set $USER, $LOGNAME and $USERNAME to target if "set_logname" is not
592
* disabled. We skip this if we are running a login shell (because
593
* they have already been set them) or sudoedit (because we want the
594
* editor to find the user's startup files).
596
if (def_set_logname && !ISSET(sudo_mode, MODE_LOGIN_SHELL|MODE_EDIT)) {
597
if (!ISSET(didvar, KEPT_LOGNAME))
598
sudo_setenv("LOGNAME", runas_pw->pw_name, TRUE);
599
if (!ISSET(didvar, KEPT_USER))
600
sudo_setenv("USER", runas_pw->pw_name, TRUE);
601
if (!ISSET(didvar, KEPT_USERNAME))
602
sudo_setenv("USERNAME", runas_pw->pw_name, TRUE);
605
/* Set $HOME to target user if not preserving user's value. */
607
sudo_setenv("HOME", runas_pw->pw_dir, TRUE);
609
/* Provide default values for $TERM and $PATH if they are not set. */
610
if (!ISSET(didvar, DID_TERM))
611
sudo_putenv("TERM=unknown", FALSE, FALSE);
612
if (!ISSET(didvar, DID_PATH))
613
sudo_setenv("PATH", _PATH_STDPATH, FALSE);
615
/* Set PS1 if SUDO_PS1 is set. */
617
sudo_putenv(ps1, TRUE, TRUE);
619
/* Add the SUDO_COMMAND envariable (cmnd + args). */
621
easprintf(&cp, "%s %s", user_cmnd, user_args);
622
sudo_setenv("SUDO_COMMAND", cp, TRUE);
625
sudo_setenv("SUDO_COMMAND", user_cmnd, TRUE);
628
/* Add the SUDO_USER, SUDO_UID, SUDO_GID environment variables. */
629
sudo_setenv("SUDO_USER", user_name, TRUE);
630
snprintf(idbuf, sizeof(idbuf), "%u", (unsigned int) user_uid);
631
sudo_setenv("SUDO_UID", idbuf, TRUE);
632
snprintf(idbuf, sizeof(idbuf), "%u", (unsigned int) user_gid);
633
sudo_setenv("SUDO_GID", idbuf, TRUE);
635
/* Free old environment. */
640
insert_env_vars(char * const envp[])
647
/* Add user-specified environment variables. */
648
for (ep = envp; *ep != NULL; ep++)
649
sudo_putenv(*ep, TRUE, TRUE);
653
* Validate the list of environment variables passed in on the command
654
* line against env_delete, env_check, and env_keep.
655
* Calls log_error() if any specified variables are not allowed.
658
validate_env_vars(char * const env_vars[])
661
char *eq, *bad = NULL;
662
size_t len, blen = 0, bsize = 0;
665
if (env_vars == NULL)
668
/* Add user-specified environment variables. */
669
for (ep = env_vars; *ep != NULL; ep++) {
670
if (def_secure_path && !user_is_exempt() &&
671
strncmp(*ep, "PATH=", 5) == 0) {
673
} else if (def_env_reset) {
674
okvar = matches_env_check(*ep);
676
okvar = matches_env_keep(*ep);
678
okvar = matches_env_delete(*ep) == FALSE;
680
okvar = matches_env_check(*ep) != FALSE;
682
if (okvar == FALSE) {
683
/* Not allowed, add to error string, allocating as needed. */
684
if ((eq = strchr(*ep, '=')) != NULL)
686
len = strlen(*ep) + 2;
687
if (blen + len >= bsize) {
690
} while (blen + len >= bsize);
691
bad = erealloc(bad, bsize);
694
strlcat(bad, *ep, bsize);
695
strlcat(bad, ", ", bsize);
702
bad[blen - 2] = '\0'; /* remove trailing ", " */
704
_("sorry, you are not allowed to set the following environment variables: %s"), bad);
711
* Read in /etc/environment ala AIX and Linux.
712
* Lines may be in either of three formats:
716
* with an optional "export" prefix so the shell can source the file.
717
* Invalid lines, blank lines, or lines consisting solely of a comment
718
* character are skipped.
721
read_env_file(const char *path, int overwrite)
724
char *cp, *var, *val;
725
size_t var_len, val_len;
727
if ((fp = fopen(path, "r")) == NULL)
730
while ((var = sudo_parseln(fp)) != NULL) {
731
/* Skip blank or comment lines */
735
/* Skip optional "export " */
736
if (strncmp(var, "export", 6) == 0 && isspace((unsigned char) var[6])) {
738
while (isspace((unsigned char) *var)) {
743
/* Must be of the form name=["']value['"] */
744
for (val = var; *val != '\0' && *val != '='; val++)
746
if (var == val || *val != '=')
748
var_len = (size_t)(val - var);
749
val_len = strlen(++val);
751
/* Strip leading and trailing single/double quotes */
752
if ((val[0] == '\'' || val[0] == '\"') && val[0] == val[val_len - 1]) {
753
val[val_len - 1] = '\0';
758
cp = emalloc(var_len + 1 + val_len + 1);
759
memcpy(cp, var, var_len + 1); /* includes '=' */
760
memcpy(cp + var_len + 1, val, val_len + 1); /* includes NUL */
762
sudo_putenv(cp, TRUE, overwrite);
770
struct list_member *cur;
773
/* Fill in the "env_delete" list. */
774
for (p = initial_badenv_table; *p; p++) {
775
cur = emalloc(sizeof(struct list_member));
776
cur->value = estrdup(*p);
777
cur->next = def_env_delete;
778
def_env_delete = cur;
781
/* Fill in the "env_check" list. */
782
for (p = initial_checkenv_table; *p; p++) {
783
cur = emalloc(sizeof(struct list_member));
784
cur->value = estrdup(*p);
785
cur->next = def_env_check;
789
/* Fill in the "env_keep" list. */
790
for (p = initial_keepenv_table; *p; p++) {
791
cur = emalloc(sizeof(struct list_member));
792
cur->value = estrdup(*p);
793
cur->next = def_env_keep;
added
removed
plugins/sudoers/env.c
