mod_env.c revision d4f351074a8f7af5e41aa0a70410816436608e3d
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd/* ====================================================================
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * The Apache Software License, Version 1.1
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd *
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd * reserved.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd *
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * Redistribution and use in source and binary forms, with or without
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * modification, are permitted provided that the following conditions
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * are met:
96ad5d81ee4a2cc66a4ae19893efc8aa6d06fae7jailletc *
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * 1. Redistributions of source code must retain the above copyright
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * notice, this list of conditions and the following disclaimer.
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen *
2e545ce2450a9953665f701bb05350f0d3f26275nd * 2. Redistributions in binary form must reproduce the above copyright
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen * notice, this list of conditions and the following disclaimer in
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen * the documentation and/or other materials provided with the
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * distribution.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd *
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * 3. The end-user documentation included with the redistribution,
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen * if any, must include the following acknowledgment:
3f08db06526d6901aa08c110b5bc7dde6bc39905nd * "This product includes software developed by the
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * Apache Software Foundation (http://www.apache.org/)."
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * Alternately, this acknowledgment may appear in the software itself,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * if and wherever such third-party acknowledgments normally appear.
3f08db06526d6901aa08c110b5bc7dde6bc39905nd *
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * 4. The names "Apache" and "Apache Software Foundation" must
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * not be used to endorse or promote products derived from this
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd * software without prior written permission. For written
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd * permission, please contact apache@apache.org.
ecc5150d35c0dc5ee5119c2717e6660fa331abbftakashi *
c04f76acce77126cf88b09350e56ea8c6b4a064enilgun * 5. Products derived from this software may not be called "Apache",
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd * nor may "Apache" appear in their name, without prior written
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end * permission of the Apache Software Foundation.
d474d8ef01ec5c2a09341cd148851ed383c3287crbowen *
d474d8ef01ec5c2a09341cd148851ed383c3287crbowen * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
3f08db06526d6901aa08c110b5bc7dde6bc39905nd * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * SUCH DAMAGE.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * ====================================================================
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd *
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * This software consists of voluntary contributions made by many
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * individuals on behalf of the Apache Software Foundation. For more
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * information on the Apache Software Foundation, please see
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * <http://www.apache.org/>.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd *
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * Portions of this software are based upon public domain software
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * originally written at the National Center for Supercomputing Applications,
71fccc298df6a1540d408151a26aa22beed55d0bnd * University of Illinois, Urbana-Champaign.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd */
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd#include "apr.h"
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd#include "apr_strings.h"
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd#if APR_HAVE_STDLIB_H
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd#include <stdlib.h>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd#endif
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd#include "ap_config.h"
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd#include "httpd.h"
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd#include "http_config.h"
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd#include "http_request.h"
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd#include "http_log.h"
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5ndtypedef struct {
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd apr_table_t *vars;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd apr_table_t *unsetenv;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd} env_dir_config_rec;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5ndmodule AP_MODULE_DECLARE_DATA env_module;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5ndstatic void *create_env_dir_config(apr_pool_t *p, char *dummy)
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd{
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd env_dir_config_rec *conf = apr_palloc(p, sizeof(*conf));
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd conf->vars = apr_table_make(p, 10);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd conf->unsetenv = apr_table_make(p, 10);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd return conf;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd}
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5ndstatic void *merge_env_dir_configs(apr_pool_t *p, void *basev, void *addv)
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd{
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd env_dir_config_rec *base = basev;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd env_dir_config_rec *add = addv;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd env_dir_config_rec *res = apr_palloc(p, sizeof(*res));
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd const apr_table_entry_t *elts;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd const apr_array_header_t *arr;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd int i;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd /*
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * res->vars = copy_table( p, base->vars );
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * foreach $unsetenv ( @add->unsetenv )
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * table_unset( res->vars, $unsetenv );
71fccc298df6a1540d408151a26aa22beed55d0bnd * foreach $element ( @add->vars )
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * table_set( res->vars, $element.key, $element.val );
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd *
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * add->unsetenv already removed the vars from add->vars,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * if they preceeded the UnsetEnv directive.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd */
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd res->vars = apr_table_copy(p, base->vars);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd res->unsetenv = NULL;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd arr = apr_table_elts(add->unsetenv);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd elts = (const apr_table_entry_t *)arr->elts;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd for (i = 0; i < arr->nelts; ++i) {
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd apr_table_unset(res->vars, elts[i].key);
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak }
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd arr = apr_table_elts(add->vars);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd elts = (const apr_table_entry_t *)arr->elts;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd for (i = 0; i < arr->nelts; ++i) {
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd apr_table_setn(res->vars, elts[i].key, elts[i].val);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd }
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd return res;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd}
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5ndstatic const char *add_env_module_vars_passed(cmd_parms *cmd, void *sconf_,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd const char *arg)
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd{
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd env_dir_config_rec *sconf = sconf_;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd apr_table_t *vars = sconf->vars;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd const char *env_var;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd env_var = getenv(arg);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd if (env_var != NULL) {
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd apr_table_setn(vars, arg, apr_pstrdup(cmd->pool, env_var));
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd }
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd else {
71fccc298df6a1540d408151a26aa22beed55d0bnd ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, cmd->server,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd "PassEnv variable %s was undefined", arg);
a8703cfb67133446eef7af1043640e71486e9ecand }
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd return NULL;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd}
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5ndstatic const char *add_env_module_vars_set(cmd_parms *cmd, void *sconf_,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd const char *name, const char *value)
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd{
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd env_dir_config_rec *sconf = sconf_;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd /* name is mandatory, value is optional. no value means
71fccc298df6a1540d408151a26aa22beed55d0bnd * set the variable to an empty string
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd */
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd apr_table_setn(sconf->vars, name, value);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
71fccc298df6a1540d408151a26aa22beed55d0bnd return NULL;
71fccc298df6a1540d408151a26aa22beed55d0bnd}
71fccc298df6a1540d408151a26aa22beed55d0bnd
71fccc298df6a1540d408151a26aa22beed55d0bndstatic const char *add_env_module_vars_unset(cmd_parms *cmd, void *sconf_,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd const char *arg)
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd{
b3c7a2279fa7a45f5807d9a404760b9b3760df50nd env_dir_config_rec *sconf = sconf_;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
316f02e3836836c82e19019ff23f90a7ebc65289nilgun /* Always UnsetEnv FOO in the same context as {Set,Pass}Env FOO
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * only if this UnsetEnv follows the {Set,Pass}Env. The merge
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd * will only apply unsetenv to the parent env (main server).
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd */
22d5d84393d960a2027f472036f3fee15d7dbce9nd apr_table_set(sconf->unsetenv, arg, NULL);
22d5d84393d960a2027f472036f3fee15d7dbce9nd apr_table_unset(sconf->vars, arg);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
4b311579b2c8aebac85fb7cb8ac89e6c37b4bc1asf return NULL;
50c04f297d76a57ead2fa6b73845f7563b1fc788sf}
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5ndstatic const command_rec env_module_cmds[] =
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd{
623eebe956d9c2d6d073ed3eae855b56030b40e9noodlAP_INIT_ITERATE("PassEnv", add_env_module_vars_passed, NULL,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd OR_FILEINFO, "a list of environment variables to pass to CGI."),
ffb88a4885747797937e30a5ac8b1606da3cb4adndAP_INIT_TAKE12("SetEnv", add_env_module_vars_set, NULL,
909ce17e2bd0faef7b1c294f2307f009793fd493nd OR_FILEINFO, "an environment variable name and optional value to pass to CGI."),
6116c12fdd3ed06d388fe6572e50a22e9320dfa5ndAP_INIT_ITERATE("UnsetEnv", add_env_module_vars_unset, NULL,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd OR_FILEINFO, "a list of variables to remove from the CGI environment."),
cd34a6fbf0a2619544a72eadb73f309370bf6682wrowe {NULL},
65a611af7093423efb91e5794b8887a527d4cf63trawick};
42af92a661a06b3cebc88d585aad75064a309d51nd
ffb88a4885747797937e30a5ac8b1606da3cb4adndstatic int fixup_env_module(request_rec *r)
6fe26506780e73be2a412d758af77fafdf03291and{
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd apr_table_t *e = r->subprocess_env;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd env_dir_config_rec *sconf = ap_get_module_config(r->per_dir_config,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd &env_module);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd apr_table_t *vars = sconf->vars;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd if (!apr_table_elts(sconf->vars)->nelts)
08cf4a15275e4cb65a424b3a1db5410bfb51085cjim return DECLINED;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
78f97ce162b66a0dbfd7af4dcd9984f162569b04minfrin r->subprocess_env = apr_table_overlay(r->pool, e, vars);
f5a398cc8880978754903f9ece8e4beb63a81cedrbowen
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd return OK;
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd}
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5ndstatic void register_hooks(apr_pool_t *p)
7906201913b68fe78b9d6a22ab33bf21d82c490eminfrin{
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd ap_hook_fixups(fixup_env_module, NULL, NULL, APR_HOOK_MIDDLE);
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd}
05ede5110427cb9dc071cc671d5aaba5d3b88c79nd
e8b603fa9ccf7b17b11b42df6d8916fd97c2331dndmodule AP_MODULE_DECLARE_DATA env_module =
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd{
4ed26c413f67a5aae20b95909828f30bb5dc2286poirier STANDARD20_MODULE_STUFF,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd create_env_dir_config, /* dir config creater */
611049e38bfbaeb173d2d7fab2e44a48753436a1nd merge_env_dir_configs, /* dir merger --- default is to override */
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd NULL, /* server config */
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd NULL, /* merge server configs */
2eb7a8afc318286c210a1fbb2ff2ba904471956frjung env_module_cmds, /* command apr_table_t */
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd register_hooks /* register hooks */
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd};
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd