| /* ==================================================================== |
| * Copyright (c) 1996-1999 The Apache Group. 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. |
| * |
| * 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. |
| * |
| * 3. All advertising materials mentioning features or use of this |
| * software must display the following acknowledgment: |
| * "This product includes software developed by the Apache Group |
| * for use in the Apache HTTP server project (http://www.apache.org/)." |
| * |
| * 4. The names "Apache Server" and "Apache Group" must not be used to |
| * endorse or promote products derived from this software without |
| * prior written permission. For written permission, please contact |
| * apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache" |
| * nor may "Apache" appear in their names without prior written |
| * permission of the Apache Group. |
| * |
| * 6. Redistributions of any form whatsoever must retain the following |
| * acknowledgment: |
| * "This product includes software developed by the Apache Group |
| * for use in the Apache HTTP server project (http://www.apache.org/)." |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY |
| * EXPRESSED 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 APACHE GROUP OR |
| * IT'S CONTRIBUTORS 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. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Group and was originally based |
| * on public domain software written at the National Center for |
| * Supercomputing Applications, University of Illinois, Urbana-Champaign. |
| * For more information on the Apache Group and the Apache HTTP server |
| * project, please see <http://www.apache.org/>. |
| * |
| */ |
| |
| /* |
| * mod_setenvif.c |
| * Set environment variables based on matching request headers or |
| * attributes against regex strings |
| * |
| * Paul Sutton <paul@ukweb.com> 27 Oct 1996 |
| * Based on mod_browser by Alexei Kosut <akosut@organic.com> |
| */ |
| |
| /* |
| * Used to set environment variables based on the incoming request headers, |
| * or some selected other attributes of the request (e.g., the remote host |
| * name). |
| * |
| * Usage: |
| * |
| * SetEnvIf name regex var ... |
| * |
| * where name is either a HTTP request header name, or one of the |
| * special values (see below). The 'value' of the header (or the |
| * value of the special value from below) are compared against the |
| * regex argument. If this is a simple string, a simple sub-string |
| * match is performed. Otherwise, a request expression match is |
| * done. If the value matches the string or regular expression, the |
| * environment variables listed as var ... are set. Each var can |
| * be in one of three formats: var, which sets the named variable |
| * (the value value "1"); var=value, which sets the variable to |
| * the given value; or !var, which unsets the variable is it has |
| * been previously set. |
| * |
| * Normally the strings are compared with regard to case. To ignore |
| * case, use the directive SetEnvIfNoCase instead. |
| * |
| * Special values for 'name' are: |
| * |
| * remote_host Remote host name (if available) |
| * remote_addr Remote IP address |
| * remote_user Remote authenticated user (if any) |
| * request_method Request method (GET, POST, etc) |
| * request_uri Requested URI |
| * |
| * Examples: |
| * |
| * To set the enviroment variable LOCALHOST if the client is the local |
| * machine: |
| * |
| * SetEnvIf remote_addr 127.0.0.1 LOCALHOST |
| * |
| * To set LOCAL if the client is the local host, or within our company's |
| * domain (192.168.10): |
| * |
| * SetEnvIf remote_addr 192.168.10. LOCAL |
| * SetEnvIf remote_addr 127.0.0.1 LOCALHOST |
| * |
| * This could be written as: |
| * |
| * SetEnvIf remote_addr (127.0.0.1|192.168.10.) LOCAL |
| */ |
| |
| #include "httpd.h" |
| #include "http_config.h" |
| #include "http_core.h" |
| #include "http_log.h" |
| |
| enum special { |
| SPECIAL_NOT, |
| SPECIAL_REMOTE_ADDR, |
| SPECIAL_REMOTE_HOST, |
| SPECIAL_REMOTE_USER, |
| SPECIAL_REQUEST_URI, |
| SPECIAL_REQUEST_METHOD, |
| SPECIAL_REQUEST_PROTOCOL |
| }; |
| typedef struct { |
| char *name; /* header name */ |
| char *regex; /* regex to match against */ |
| regex_t *preg; /* compiled regex */ |
| table *features; /* env vars to set (or unset) */ |
| ENUM_BITFIELD( /* is it a "special" header ? */ |
| enum special, |
| special_type,4); |
| unsigned icase : 1; /* ignoring case? */ |
| } sei_entry; |
| |
| typedef struct { |
| array_header *conditionals; |
| } sei_cfg_rec; |
| |
| module MODULE_VAR_EXPORT setenvif_module; |
| |
| static void *create_setenvif_config(pool *p, server_rec *dummy) |
| { |
| sei_cfg_rec *new = (sei_cfg_rec *) ap_palloc(p, sizeof(sei_cfg_rec)); |
| |
| new->conditionals = ap_make_array(p, 20, sizeof(sei_entry)); |
| return (void *) new; |
| } |
| |
| static void *merge_setenvif_config(pool *p, void *basev, void *overridesv) |
| { |
| sei_cfg_rec *a = ap_pcalloc(p, sizeof(sei_cfg_rec)); |
| sei_cfg_rec *base = basev, *overrides = overridesv; |
| |
| a->conditionals = ap_append_arrays(p, base->conditionals, |
| overrides->conditionals); |
| return a; |
| } |
| |
| /* any non-NULL magic constant will do... used to indicate if REG_ICASE should |
| * be used |
| */ |
| #define ICASE_MAGIC ((void *)(&setenvif_module)) |
| |
| static const char *add_setenvif_core(cmd_parms *cmd, void *mconfig, |
| char *fname, const char *args) |
| { |
| char *regex; |
| const char *feature; |
| sei_cfg_rec *sconf = ap_get_module_config(cmd->server->module_config, |
| &setenvif_module); |
| sei_entry *new, *entries = (sei_entry *) sconf->conditionals->elts; |
| char *var; |
| int i; |
| int beenhere = 0; |
| unsigned icase; |
| |
| /* get regex */ |
| regex = ap_getword_conf(cmd->pool, &args); |
| if (!*regex) { |
| return ap_pstrcat(cmd->pool, "Missing regular expression for ", |
| cmd->cmd->name, NULL); |
| } |
| |
| /* |
| * If we've already got a sei_entry with the same name we want to |
| * just copy the name pointer... so that later on we can compare |
| * two header names just by comparing the pointers. |
| */ |
| |
| for (i = 0; i < sconf->conditionals->nelts; ++i) { |
| new = &entries[i]; |
| if (!strcasecmp(new->name, fname)) { |
| fname = new->name; |
| break; |
| } |
| } |
| |
| /* if the last entry has an idential headername and regex then |
| * merge with it |
| */ |
| i = sconf->conditionals->nelts - 1; |
| icase = cmd->info == ICASE_MAGIC; |
| if (i < 0 |
| || entries[i].name != fname |
| || entries[i].icase != icase |
| || strcmp(entries[i].regex, regex)) { |
| |
| /* no match, create a new entry */ |
| |
| new = ap_push_array(sconf->conditionals); |
| new->name = fname; |
| new->regex = regex; |
| new->icase = icase; |
| new->preg = ap_pregcomp(cmd->pool, regex, |
| (REG_EXTENDED | REG_NOSUB |
| | (icase ? REG_ICASE : 0))); |
| if (new->preg == NULL) { |
| return ap_pstrcat(cmd->pool, cmd->cmd->name, |
| " regex could not be compiled.", NULL); |
| } |
| new->features = ap_make_table(cmd->pool, 2); |
| |
| if (!strcasecmp(fname, "remote_addr")) { |
| new->special_type = SPECIAL_REMOTE_ADDR; |
| } |
| else if (!strcasecmp(fname, "remote_host")) { |
| new->special_type = SPECIAL_REMOTE_HOST; |
| } |
| else if (!strcasecmp(fname, "remote_user")) { |
| new->special_type = SPECIAL_REMOTE_USER; |
| } |
| else if (!strcasecmp(fname, "request_uri")) { |
| new->special_type = SPECIAL_REQUEST_URI; |
| } |
| else if (!strcasecmp(fname, "request_method")) { |
| new->special_type = SPECIAL_REQUEST_METHOD; |
| } |
| else if (!strcasecmp(fname, "request_protocol")) { |
| new->special_type = SPECIAL_REQUEST_PROTOCOL; |
| } |
| else { |
| new->special_type = SPECIAL_NOT; |
| } |
| } |
| else { |
| new = &entries[i]; |
| } |
| |
| for ( ; ; ) { |
| feature = ap_getword_conf(cmd->pool, &args); |
| if (!*feature) { |
| break; |
| } |
| beenhere++; |
| |
| var = ap_getword(cmd->pool, &feature, '='); |
| if (*feature) { |
| ap_table_setn(new->features, var, feature); |
| } |
| else if (*var == '!') { |
| ap_table_setn(new->features, var + 1, "!"); |
| } |
| else { |
| ap_table_setn(new->features, var, "1"); |
| } |
| } |
| |
| if (!beenhere) { |
| return ap_pstrcat(cmd->pool, "Missing envariable expression for ", |
| cmd->cmd->name, NULL); |
| } |
| |
| return NULL; |
| } |
| |
| static const char *add_setenvif(cmd_parms *cmd, void *mconfig, |
| const char *args) |
| { |
| char *fname; |
| |
| /* get header name */ |
| fname = ap_getword_conf(cmd->pool, &args); |
| if (!*fname) { |
| return ap_pstrcat(cmd->pool, "Missing header-field name for ", |
| cmd->cmd->name, NULL); |
| } |
| return add_setenvif_core(cmd, mconfig, fname, args); |
| } |
| |
| /* |
| * This routine handles the BrowserMatch* directives. It simply turns around |
| * and feeds them, with the appropriate embellishments, to the general-purpose |
| * command handler. |
| */ |
| static const char *add_browser(cmd_parms *cmd, void *mconfig, const char *args) |
| { |
| return add_setenvif_core(cmd, mconfig, "User-Agent", args); |
| } |
| |
| static const command_rec setenvif_module_cmds[] = |
| { |
| { "SetEnvIf", add_setenvif, NULL, |
| RSRC_CONF, RAW_ARGS, "A header-name, regex and a list of variables." }, |
| { "SetEnvIfNoCase", add_setenvif, ICASE_MAGIC, |
| RSRC_CONF, RAW_ARGS, "a header-name, regex and a list of variables." }, |
| { "BrowserMatch", add_browser, NULL, |
| RSRC_CONF, RAW_ARGS, "A browser regex and a list of variables." }, |
| { "BrowserMatchNoCase", add_browser, ICASE_MAGIC, |
| RSRC_CONF, RAW_ARGS, "A browser regex and a list of variables." }, |
| { NULL }, |
| }; |
| |
| static int match_headers(request_rec *r) |
| { |
| server_rec *s = r->server; |
| sei_cfg_rec *sconf; |
| sei_entry *entries; |
| table_entry *elts; |
| const char *val; |
| int i, j; |
| char *last_name; |
| |
| sconf = (sei_cfg_rec *) ap_get_module_config(s->module_config, |
| &setenvif_module); |
| entries = (sei_entry *) sconf->conditionals->elts; |
| last_name = NULL; |
| val = NULL; |
| for (i = 0; i < sconf->conditionals->nelts; ++i) { |
| sei_entry *b = &entries[i]; |
| |
| /* Optimize the case where a bunch of directives in a row use the |
| * same header. Remember we don't need to strcmp the two header |
| * names because we made sure the pointers were equal during |
| * configuration. |
| */ |
| if (b->name != last_name) { |
| last_name = b->name; |
| switch (b->special_type) { |
| case SPECIAL_REMOTE_ADDR: |
| val = r->connection->remote_ip; |
| break; |
| case SPECIAL_REMOTE_HOST: |
| val = ap_get_remote_host(r->connection, r->per_dir_config, |
| REMOTE_NAME); |
| break; |
| case SPECIAL_REMOTE_USER: |
| val = r->connection->user; |
| break; |
| case SPECIAL_REQUEST_URI: |
| val = r->uri; |
| break; |
| case SPECIAL_REQUEST_METHOD: |
| val = r->method; |
| break; |
| case SPECIAL_REQUEST_PROTOCOL: |
| val = r->protocol; |
| break; |
| case SPECIAL_NOT: |
| val = ap_table_get(r->headers_in, b->name); |
| if (val == NULL) { |
| val = ap_table_get(r->subprocess_env, b->name); |
| } |
| break; |
| } |
| } |
| |
| /* |
| * A NULL value indicates that the header field or special entity |
| * wasn't present or is undefined. Represent that as an empty string |
| * so that REs like "^$" will work and allow envariable setting |
| * based on missing or empty field. |
| */ |
| if (val == NULL) { |
| val = ""; |
| } |
| |
| if (!ap_regexec(b->preg, val, 0, NULL, 0)) { |
| array_header *arr = ap_table_elts(b->features); |
| elts = (table_entry *) arr->elts; |
| |
| for (j = 0; j < arr->nelts; ++j) { |
| if (!strcmp(elts[j].val, "!")) { |
| ap_table_unset(r->subprocess_env, elts[j].key); |
| } |
| else { |
| ap_table_setn(r->subprocess_env, elts[j].key, elts[j].val); |
| } |
| } |
| } |
| } |
| |
| return DECLINED; |
| } |
| |
| module MODULE_VAR_EXPORT setenvif_module = |
| { |
| STANDARD_MODULE_STUFF, |
| NULL, /* initializer */ |
| NULL, /* dir config creater */ |
| NULL, /* dir merger --- default is to override */ |
| create_setenvif_config, /* server config */ |
| merge_setenvif_config, /* merge server configs */ |
| setenvif_module_cmds, /* command table */ |
| NULL, /* handlers */ |
| NULL, /* filename translation */ |
| NULL, /* check_user_id */ |
| NULL, /* check auth */ |
| NULL, /* check access */ |
| NULL, /* type_checker */ |
| NULL, /* fixups */ |
| NULL, /* logger */ |
| NULL, /* input header parse */ |
| NULL, /* child (process) initialization */ |
| NULL, /* child (process) rundown */ |
| match_headers /* post_read_request */ |
| }; |
