freebsd-nq/tools/regression/environ/envctl.c
Sean Farley 3522c38bbe Detect if the application has cleared the environ variable by setting
the first value (environ[0]) to NULL.  This is in addition to the
current detection of environ being replaced, which includes being set to
NULL.  Without this fix, the environment is not truly wiped, but appears
to be by getenv() until an *env() call is made to alter the enviroment.

This change is necessary to support those applications that use this
method for clearing environ such as Dovecot and Postfix.  Applications
such as Sendmail and the base system's env replace environ (already
detected).  While neither of these methods are defined by SUSv3, it is
best to support them due to historic reasons and in lieu of a clean,
defined method.

Add extra units tests for clearing environ using four different methods:
1. Set environ to NULL pointer.
2. Set environ[0] to NULL pointer.
3. Set environ to calloc()'d NULL-terminated array.
4. Set environ to static NULL-terminated array.

Noticed by:	Timo Sirainen

MFC after:	3 days
2008-08-02 02:34:35 +00:00

192 lines
4.6 KiB
C

/*-
* Copyright (c) 2007-2008 Sean C. Farley <scf@FreeBSD.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer,
* without modification, immediately at the beginning of the file.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include <errno.h>
#include <libgen.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
extern char **environ;
/*
* Print entire environ array.
*/
static void
dump_environ(void)
{
char **environPtr;
for (environPtr = environ; *environPtr != NULL; environPtr++)
printf("%s\n", *environPtr);
return;
}
/*
* Print usage.
*/
static void
usage(const char *program)
{
fprintf(stderr, "Usage: %s [-DGUchrt] [-c 1|2|3|4] [-gu name] "
"[-p name=value]\n"
"\t[(-S|-s name) value overwrite]\n\n"
"Options:\n"
" -D\t\t\t\tDump environ\n"
" -G name\t\t\tgetenv(NULL)\n"
" -S value overwrite\t\tsetenv(NULL, value, overwrite)\n"
" -U\t\t\t\tunsetenv(NULL)\n"
" -c 1|2|3|4\t\t\tClear environ variable using method:\n"
"\t\t\t\t1 - set environ to NULL pointer\n"
"\t\t\t\t2 - set environ[0] to NULL pointer\n"
"\t\t\t\t3 - set environ to calloc()'d NULL-terminated array\n"
"\t\t\t\t4 - set environ to static NULL-terminated array\n"
" -g name\t\t\tgetenv(name)\n"
" -h\t\t\t\tHelp\n"
" -p name=value\t\t\tputenv(name=value)\n"
" -r\t\t\t\treplace environ with { \"FOO=bar\", NULL }\n"
" -s name value overwrite\tsetenv(name, value, overwrite)\n"
" -t\t\t\t\tOutput is suitable for testing (no newlines)\n"
" -u name\t\t\tunsetenv(name)\n",
basename(program));
return;
}
/*
* Print the return value of a call along with errno upon error else zero.
* Also, use the eol string based upon whether running in test mode or not.
*/
static void
print_rtrn_errno(int rtrnVal, const char *eol)
{
printf("%d %d%s", rtrnVal, rtrnVal != 0 ? errno : 0, eol);
return;
}
int
main(int argc, char **argv)
{
char arg;
const char *eol = "\n";
const char *value;
static char *emptyEnv[] = { NULL };
static char *staticEnv[] = { "FOO=bar", NULL };
if (argc == 1) {
usage(argv[0]);
exit(EXIT_FAILURE);
}
/* The entire program is basically executed from this loop. */
while ((arg = getopt(argc, argv, "DGS:Uc:g:hp:rs:tu:")) != -1) {
switch (arg) {
case 'c':
switch (atoi(optarg)) {
case 1:
environ = NULL;
break;
case 2:
environ[0] = NULL;
break;
case 3:
environ = calloc(1, sizeof(*environ));
break;
case 4:
environ = emptyEnv;
break;
}
break;
case 'D':
dump_environ();
break;
case 'G':
case 'g':
value = getenv(arg == 'g' ? optarg : NULL);
printf("%s%s", value == NULL ? "*NULL*" : value, eol);
break;
case 'p':
print_rtrn_errno(putenv(optarg), eol);
break;
case 'r':
environ = staticEnv;
break;
case 'S':
print_rtrn_errno(setenv(NULL, optarg,
atoi(argv[optind])), eol);
optind += 1;
break;
case 's':
print_rtrn_errno(setenv(optarg, argv[optind],
atoi(argv[optind + 1])), eol);
optind += 2;
break;
case 't':
eol = " ";
break;
case 'U':
case 'u':
print_rtrn_errno(unsetenv(arg == 'u' ? optarg : NULL),
eol);
break;
case 'h':
default:
usage(argv[0]);
exit(EXIT_FAILURE);
}
}
/* Output a closing newline in test mode. */
if (eol[0] == ' ')
printf("\n");
return (EXIT_SUCCESS);
}