mod_proxy.c revision 779f4feeb8179ddc6160712c5f4407af05bbee24
2d2eda71267231c2526be701fe655db125852c1ffielding/* Licensed to the Apache Software Foundation (ASF) under one or more
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * contributor license agreements. See the NOTICE file distributed with
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * this work for additional information regarding copyright ownership.
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * The ASF licenses this file to You under the Apache License, Version 2.0
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * (the "License"); you may not use this file except in compliance with
2d2eda71267231c2526be701fe655db125852c1ffielding * the License. You may obtain a copy of the License at
2d2eda71267231c2526be701fe655db125852c1ffielding * Unless required by applicable law or agreed to in writing, software
2d2eda71267231c2526be701fe655db125852c1ffielding * distributed under the License is distributed on an "AS IS" BASIS,
2d2eda71267231c2526be701fe655db125852c1ffielding * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2d2eda71267231c2526be701fe655db125852c1ffielding * See the License for the specific language governing permissions and
2d2eda71267231c2526be701fe655db125852c1ffielding * limitations under the License.
f062ed7bd262a37a909dd77ce5fc23b446818823fieldingAPR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
f062ed7bd262a37a909dd77ce5fc23b446818823fieldingAPR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
f062ed7bd262a37a909dd77ce5fc23b446818823fieldingAPR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
f062ed7bd262a37a909dd77ce5fc23b446818823fielding#define MAX(x,y) ((x) >= (y) ? (x) : (y))
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * A Web proxy module. Stages:
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * translate_name: set filename to proxy:<URL>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * map_to_storage: run proxy_walk (rather than directory_walk/file_walk)
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * can't trust directory_walk/file_walk since these are
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * not in our filesystem. Prevents mod_http from serving
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * the TRACE request we will set aside to handle later.
2d2eda71267231c2526be701fe655db125852c1ffielding * fix_ups: convert the URL stored in the filename to the
2d2eda71267231c2526be701fe655db125852c1ffielding * canonical form.
2d2eda71267231c2526be701fe655db125852c1ffielding * handler: handle proxy requests
f062ed7bd262a37a909dd77ce5fc23b446818823fielding/* -------------------------------------------------------------- */
2d2eda71267231c2526be701fe655db125852c1ffielding/* Translate the URL into a 'filename' */
2d2eda71267231c2526be701fe655db125852c1ffielding const char *key,
2d2eda71267231c2526be701fe655db125852c1ffielding const char *val)
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding /* Normalized load factor. Used with BalancerMamber,
2d2eda71267231c2526be701fe655db125852c1ffielding * it is a number between 1 and 100.
2d2eda71267231c2526be701fe655db125852c1ffielding if (worker->s->lbfactor < 1 || worker->s->lbfactor > 100)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "LoadFactor must be a number between 1..100";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* If set it will give the retry timeout for the worker
2d2eda71267231c2526be701fe655db125852c1ffielding * The default value is 60 seconds, meaning that if
2d2eda71267231c2526be701fe655db125852c1ffielding * in error state, it will be retried after that timeout.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "Retry must be a positive value";
2d2eda71267231c2526be701fe655db125852c1ffielding /* Time in seconds that will destroy all the connections
2d2eda71267231c2526be701fe655db125852c1ffielding * that exceed the smax
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "TTL must be at least one second";
2d2eda71267231c2526be701fe655db125852c1ffielding /* Initial number of connections to remote
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "Min must be a positive number";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Maximum number of connections to remote
2d2eda71267231c2526be701fe655db125852c1ffielding return "Max must be a positive number";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* XXX: More inteligent naming needed */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Maximum number of connections to remote that
2d2eda71267231c2526be701fe655db125852c1ffielding * will not be destroyed
2d2eda71267231c2526be701fe655db125852c1ffielding return "Smax must be a positive number";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Acquire timeout in given unit (default is milliseconds).
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * If set this will be the maximum time to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * wait for a free connection.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb if (ap_timeout_parameter_parse(val, &timeout, "ms") != APR_SUCCESS)
2d2eda71267231c2526be701fe655db125852c1ffielding return "Acquire timeout has wrong format";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "Acquire must be at least one millisecond";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Connection timeout in seconds.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Defaults to server timeout.
4c3d3eaf42bd7757edb3721cb586f2ef2bcbf671stoddard return "Timeout must be at least one second";
2d2eda71267231c2526be701fe655db125852c1ffielding if (s < 512 && s) {
2d2eda71267231c2526be701fe655db125852c1ffielding return "IOBufferSize must be >= 512 bytes, or 0 for system default.";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "ReceiveBufferSize must be >= 512 bytes, or 0 for system default.";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "KeepAlive must be On|Off";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "DisableReuse must be On|Off";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Worker route.
2d2eda71267231c2526be701fe655db125852c1ffielding return "Route length must be < 64 characters";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Worker redirection route.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "Redirect length must be < 64 characters";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *v;
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Worker status.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb for (v = val; *v; v++) {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb if (*v == '+') {
2d2eda71267231c2526be701fe655db125852c1ffielding else if (*v == '-') {
2d2eda71267231c2526be701fe655db125852c1ffielding return "Unknown status parameter option";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "flushpackets must be on|off|auto";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "flushwait must be <= 1000, or 0 for system default of 10 millseconds.";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb worker->s->flush_wait = ival * 1000; /* change to microseconds */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Ping/Pong timeout in given unit (default is second).
2d2eda71267231c2526be701fe655db125852c1ffielding if (ap_timeout_parameter_parse(val, &timeout, "s") != APR_SUCCESS)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "Ping/Pong timeout has wrong format";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "Ping/Pong timeout must be at least one millisecond";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "lbset must be between 0 and 99";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Request timeout in given unit (default is second).
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Defaults to connection timeout
61fd0cab072a05b855cbef9c585702401ac5ae29rbb if (ap_timeout_parameter_parse(val, &timeout, "s") != APR_SUCCESS)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "Connectiontimeout has wrong format";
2d2eda71267231c2526be701fe655db125852c1ffielding return "Connectiontimeout must be at least one millisecond.";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "flusher name length must be < 16 characters";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "unknown Worker parameter";
61fd0cab072a05b855cbef9c585702401ac5ae29rbbstatic const char *set_balancer_param(proxy_server_conf *conf,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *key,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *val)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Balancer sticky session name.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Set to something like JSESSIONID or
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * PHPSESSIONID, etc..,
2d2eda71267231c2526be701fe655db125852c1ffielding return "stickysession length must be < 64 characters";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb if ((path = strchr((char *)balancer->s->sticky, '|'))) {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* If set to 'on' the session will break
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * if the worker is in error state or
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * disabled.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "failover must be On|Off";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Balancer timeout in seconds.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * If set this will be the maximum time to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * wait for a free worker.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Default is not to wait.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "timeout must be at least one second";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Maximum number of failover attempts before
2d2eda71267231c2526be701fe655db125852c1ffielding * giving up.
2d2eda71267231c2526be701fe655db125852c1ffielding return "maximum number of attempts must be a positive number";
2d2eda71267231c2526be701fe655db125852c1ffielding if (strlen(val) > (sizeof(balancer->s->lbpname)-1))
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "unknown lbmethod";
d839a9822ee53ce00da24c15f2d9fe054233d342gstein provider = ap_lookup_provider(PROXY_LBMETHOD, val, "0");
61fd0cab072a05b855cbef9c585702401ac5ae29rbb if (PROXY_STRNCPY(balancer->s->lbpname, val) == APR_SUCCESS) {
d839a9822ee53ce00da24c15f2d9fe054233d342gstein return "lbmethod name too large";
2d2eda71267231c2526be701fe655db125852c1ffielding return "unknown lbmethod";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* If set to 'on' then ';' will also be
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * used as a session path separator/delim (ala
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "scolonpathdelim must be On|Off";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb balancer->errstatuses = apr_array_make(p, 1, sizeof(int));
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "failonstatus must be one or more HTTP response codes";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb if (PROXY_STRNCPY(balancer->s->nonce, val) != APR_SUCCESS) {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "Provided nonce is too large";
2d2eda71267231c2526be701fe655db125852c1ffielding if (ival < 1 || ival > 100) /* arbitrary limit here */
2d2eda71267231c2526be701fe655db125852c1ffielding return "growth must be between 1 and 100";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "forcerecovery must be On|Off";
61fd0cab072a05b855cbef9c585702401ac5ae29rbb return "unknown Balancer parameter";
1ccd992d37d62c8cb2056126f2234f64ec189bfddougmstatic int alias_match(const char *uri, const char *alias_fakename)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *end_fakename = alias_fakename + strlen(alias_fakename);
2d2eda71267231c2526be701fe655db125852c1ffielding /* any number of '/' in the alias matches any number in
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * the supplied URI, but there must be at least one...
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* Other characters are compared literally */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* fixup badly encoded stuff (e.g. % as last character) */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* We reach the end of the uri before the end of "alias_fakename"
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * for example uri is "/" and alias_fakename "/examples"
2d2eda71267231c2526be701fe655db125852c1ffielding /* Check last alias path component matched all the way */
2d2eda71267231c2526be701fe655db125852c1ffielding if (aliasp[-1] != '/' && *urip != '\0' && *urip != '/')
2d2eda71267231c2526be701fe655db125852c1ffielding /* Return number of characters from URI which matched (may be
2d2eda71267231c2526be701fe655db125852c1ffielding * greater than length of alias, since we may have matched
2d2eda71267231c2526be701fe655db125852c1ffielding * doubled slashes)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb/* Detect if an absoluteURI should be proxied or not. Note that we
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * have to do this during this phase because later phases are
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * "short-circuiting"... i.e. translate_names will end when the first
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * module returns OK. So for example, if the request is something like:
2d2eda71267231c2526be701fe655db125852c1ffielding * mod_alias will notice the /cgi-bin part and ScriptAlias it and
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * short-circuit the proxy... just because of the ordering in the
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * configuration file.
2d2eda71267231c2526be701fe655db125852c1ffielding (proxy_server_conf *) ap_get_module_config(sconf, &proxy_module);
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding /* Ick... msvc (perhaps others) promotes ternary short results to int */
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding /* but it might be something vhosted */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb (apr_port_t)(r->parsed_uri.port_str ? r->parsed_uri.port
61fd0cab072a05b855cbef9c585702401ac5ae29rbb r->filename = apr_pstrcat(r->pool, "proxy:", r->uri, NULL);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb /* We need special treatment for CONNECT proxying: it has no scheme part */
36bb027ff0af9d285d15e9fac4fc956db6c33e94wrowe r->filename = apr_pstrcat(r->pool, "proxy:", r->uri, NULL);
61fd0cab072a05b855cbef9c585702401ac5ae29rbbstatic const char *proxy_interpolate(request_rec *r, const char *str)
36bb027ff0af9d285d15e9fac4fc956db6c33e94wrowe /* Interpolate an env str in a configuration string
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Syntax ${var} --> value_of(var)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Method: replace one var, and recurse on remainder of string
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Nothing clever here, and crap like nested vars may do silly things
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * but we'll at least avoid sending the unwary into a loop
61fd0cab072a05b855cbef9c585702401ac5ae29rbb const char *start;
36bb027ff0af9d285d15e9fac4fc956db6c33e94wrowe const char *end;
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding const char *var;
2d2eda71267231c2526be701fe655db125852c1ffielding const char *val;
return str;
return str;
sizeof (struct proxy_alias));
return ret;
int len;
const char *fake;
const char *real;
int mismatch = 0;
return DECLINED;
if (!found) {
return HTTP_INTERNAL_SERVER_ERROR;
if (len != 0) {
return DECLINED;
if (mismatch) {
if (found) {
return OK;
return DONE;
if (r->proxyreq) {
return OK;
return DECLINED;
return rv;
&proxy_module);
return rv;
return DECLINED;
&proxy_module);
for (j = 0; j < num_sec; ++j)
if (entry_proxy->r
return OK;
int access_status;
return DECLINED;
return access_status;
return OK;
char *url, *p;
int access_status;
&proxy_module);
return DECLINED;
return access_status;
return HTTP_BAD_REQUEST;
char *nuri;
const char *ref;
return DECLINED;
&r->parsed_uri,
return HTTP_MOVED_PERMANENTLY;
const char *p2;
int direct_connect = 0;
const char *str;
long maxfwd;
return DECLINED;
switch (r->method_number) {
case M_TRACE: {
int access_status;
return OK;
case M_OPTIONS: {
int access_status;
return OK;
if (maxfwd >= 0) {
return HTTP_METHOD_NOT_ALLOWED;
return HTTP_REQUEST_ENTITY_TOO_LARGE;
if (p == NULL) {
return HTTP_BAD_REQUEST;
return HTTP_MOVED_PERMANENTLY;
!direct_connect; i++) {
#if DEBUGGING
r->uri);
return access_status;
if (!worker)
goto cleanup;
if (balancer) {
if (!direct_connect) {
const char *cl_a;
char *end;
goto cleanup;
if (cl_a) {
if (cl > 0) {
goto cleanup;
goto cleanup;
if (balancer) {
if (balancer) {
goto cleanup;
return access_status;
return ps;
ps->recv_buffer_size = (overrides->recv_buffer_size_set == 0) ? base->recv_buffer_size : overrides->recv_buffer_size;
ps->io_buffer_size = (overrides->io_buffer_size_set == 0) ? base->io_buffer_size : overrides->io_buffer_size;
ps->proxy_status = (overrides->proxy_status_set == 0) ? base->proxy_status : overrides->proxy_status;
ps->source_address = (overrides->source_address_set == 0) ? base->source_address : overrides->source_address;
return ps;
const char *arg)
return NULL;
return (void *) new;
return new;
char *r, *f, *scheme;
int port;
if (regex)
scheme[p-r] = 0;
if (q != NULL) {
if (regex)
if (regex) {
if (!reg)
return NULL;
char *r = NULL;
char *word;
unsigned int flags = 0;
const char *err;
if (err) {
return err;
while (*arg) {
if (is_regex) {
f = word;
r = word;
if (!val) {
if (r == NULL) {
if (apr_fnmatch_test(f)) {
if (use_regex) {
return NULL;
if (!balancer) {
if (err)
if (err)
int reuse = 0;
if (!worker) {
if (err)
if (reuse) {
if (err)
return NULL;
const char *fake;
const char *real;
const char *interp;
const char *err;
if (err) {
return err;
fake = f;
real = r;
interp = i;
real = f;
interp = r;
return NULL;
const char *r, const char *interp)
return NULL;
const char *r, const char *interp)
return NULL;
int found = 0;
if (!found) {
return NULL;
int found = 0;
if (!found) {
#if DEBUGGING
#if DEBUGGING
#if DEBUGGING
#if DEBUGGING
return NULL;
return NULL;
return NULL;
return NULL;
return NULL;
return NULL;
return NULL;
return NULL;
return NULL;
int timeout;
return NULL;
return NULL;
return NULL;
return NULL;
return NULL;
return NULL;
return NULL;
char *word;
int reuse = 0;
if (err)
return err;
while (*arg) {
char *val;
if (!val) {
if (!path)
else if (!name)
if (!path)
if (!name)
if (!balancer) {
if (err)
if (!worker) {
if (reuse) {
if (err)
return NULL;
int in_proxy_section = 0;
if (err)
return err;
if (!balancer) {
if (in_proxy_section) {
if (err)
if (!worker) {
if (in_proxy_section) {
if (err)
while (*arg) {
if (!val) {
if (worker)
if (err)
return NULL;
&proxy_module);
const char *errmsg;
return err;
if (!arg) {
return errmsg;
conf->r = r;
NULL);
NULL);
if (!balancer) {
if (err)
conf->p);
if (!worker) {
if (err)
NULL);
while (*arg) {
if (!val) {
if (worker)
if (err)
return NULL;
{NULL}
if (proxy_ssl_enable) {
if (proxy_ssl_disable) {
return proxy_ssl_disable(c);
if (proxy_is_https) {
return proxy_is_https(c);
const char *var)
if (proxy_ssl_val) {
return NULL;
return OK;
return OK;
++worker;
++balancer;
return OK;
if (!reverse) {
s = s->next;
proxy_lb_workers = 0;
return OK;
/* register optional functions within proxy_util.c */
request_rec *r,
request_rec *r,
(request_rec *r), (r),
(status, r),