2 /* Copyright 1999-2004 The Apache Software Foundation
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "mod_proxy.h"
21 #include "apr_optional.h"
22 #include "mod_status.h"
24 #if (MODULE_MAGIC_NUMBER_MAJOR > 20020903)
27 APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
28 APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
32 #define MAX(x,y) ((x) >= (y) ? (x) : (y))
36 * A Web proxy module. Stages:
38 * translate_name: set filename to proxy:<URL>
39 * map_to_storage: run proxy_walk (rather than directory_walk/file_walk)
40 * can't trust directory_walk/file_walk since these are
41 * not in our filesystem. Prevents mod_http from serving
42 * the TRACE request we will set aside to handle later.
43 * type_checker: set type to PROXY_MAGIC_TYPE if filename begins proxy:
44 * fix_ups: convert the URL stored in the filename to the
46 * handler: handle proxy requests
49 /* -------------------------------------------------------------- */
50 /* Translate the URL into a 'filename' */
53 /* XXX: EBCDIC safe? --nd */
54 #define x2c(x) (((x >= '0') && (x <= '9')) \
56 : (((x >= 'a') && (x <= 'f')) \
58 : ((x >= 'A') && (x <='F')) \
64 static unsigned char hex2c(const char* p) {
66 const char c2 = p[1] ? p[2]: '\0';
67 int i1 = c1 ? x2c(c1) : 0;
68 int i2 = c2 ? x2c(c2) : 0;
69 unsigned char ret = (i1 << 4) | i2;
75 #define PROXY_COPY_CONF_PARAMS(w, c) \
77 (w)->timeout = (c)->timeout; \
78 (w)->timeout_set = (c)->timeout_set; \
79 (w)->recv_buffer_size = (c)->recv_buffer_size; \
80 (w)->recv_buffer_size_set = (c)->recv_buffer_size_set; \
81 (w)->io_buffer_size = (c)->io_buffer_size; \
82 (w)->io_buffer_size_set = (c)->io_buffer_size_set; \
85 static const char *set_worker_param(apr_pool_t *p,
92 if (!strcasecmp(key, "loadfactor")) {
93 worker->lbfactor = atoi(val);
94 if (worker->lbfactor < 1 || worker->lbfactor > 100)
95 return "LoadFactor must be number between 1..100";
97 else if (!strcasecmp(key, "retry")) {
100 return "Retry must be at least one second";
101 worker->retry = apr_time_from_sec(ival);
103 else if (!strcasecmp(key, "ttl")) {
106 return "TTL must be at least one second";
107 worker->ttl = apr_time_from_sec(ival);
109 else if (!strcasecmp(key, "min")) {
112 return "Min must be a positive number";
115 else if (!strcasecmp(key, "max")) {
118 return "Max must be a positive number";
121 /* XXX: More inteligent naming needed */
122 else if (!strcasecmp(key, "smax")) {
125 return "Smax must be a positive number";
128 else if (!strcasecmp(key, "acquire")) {
131 return "Acquire must be at least one mili second";
132 worker->acquire = apr_time_make(0, ival * 1000);
133 worker->acquire_set = 1;
135 else if (!strcasecmp(key, "timeout")) {
138 return "Timeout must be at least one second";
139 worker->timeout = apr_time_from_sec(ival);
140 worker->timeout_set = 1;
142 else if (!strcasecmp(key, "iobuffersize")) {
144 worker->io_buffer_size = ((s > AP_IOBUFSIZE) ? s : AP_IOBUFSIZE);
145 worker->io_buffer_size_set = 1;
147 else if (!strcasecmp(key, "receivebuffersize")) {
149 if (ival < 512 && ival != 0) {
150 return "ReceiveBufferSize must be >= 512 bytes, or 0 for system default.";
152 worker->recv_buffer_size = ival;
153 worker->recv_buffer_size_set = 1;
155 else if (!strcasecmp(key, "keepalive")) {
156 if (!strcasecmp(val, "on"))
157 worker->keepalive = 1;
158 else if (!strcasecmp(val, "off"))
159 worker->keepalive = 0;
161 return "KeepAlive must be On|Off";
162 worker->keepalive_set = 1;
164 else if (!strcasecmp(key, "route")) {
165 worker->route = apr_pstrdup(p, val);
167 else if (!strcasecmp(key, "redirect")) {
168 worker->redirect = apr_pstrdup(p, val);
171 return "unknown parameter";
176 static const char *set_balancer_param(apr_pool_t *p,
177 proxy_balancer *balancer,
183 if (!strcasecmp(key, "stickysession")) {
184 balancer->sticky = apr_pstrdup(p, val);
186 else if (!strcasecmp(key, "nofailover")) {
187 if (!strcasecmp(val, "on"))
188 balancer->sticky_force = 1;
189 else if (!strcasecmp(val, "off"))
190 balancer->sticky_force = 0;
192 return "failover must be On|Off";
194 else if (!strcasecmp(key, "timeout")) {
197 return "timeout must be at least one second";
198 balancer->timeout = apr_time_from_sec(ival);
201 return "unknown parameter";
206 static int alias_match(const char *uri, const char *alias_fakename)
208 const char *end_fakename = alias_fakename + strlen(alias_fakename);
209 const char *aliasp = alias_fakename, *urip = uri;
210 const char *end_uri = uri + strlen(uri);
211 unsigned char uric, aliasc;
213 while (aliasp < end_fakename && urip < end_uri) {
214 if (*aliasp == '/') {
215 /* any number of '/' in the alias matches any number in
216 * the supplied URI, but there must be at least one...
221 while (*aliasp == '/')
228 /* Other characters are compared literally */
229 if (*urip++ != *aliasp++)
232 /* Other characters are canonicalised and compared literally */
237 uric = (unsigned char)*urip++;
239 if (*aliasp == '%') {
240 aliasc = hex2c(aliasp);
243 aliasc = (unsigned char)*aliasp++;
245 if (uric != aliasc) {
252 /* fixup badly encoded stuff (e.g. % as last character) */
253 if (aliasp > end_fakename) {
254 aliasp = end_fakename;
256 if (urip > end_uri) {
260 /* Check last alias path component matched all the way */
261 if (aliasp[-1] != '/' && *urip != '\0' && *urip != '/')
264 /* Return number of characters from URI which matched (may be
265 * greater than length of alias, since we may have matched
272 /* Detect if an absoluteURI should be proxied or not. Note that we
273 * have to do this during this phase because later phases are
274 * "short-circuiting"... i.e. translate_names will end when the first
275 * module returns OK. So for example, if the request is something like:
277 * GET http://othervhost/cgi-bin/printenv HTTP/1.0
279 * mod_alias will notice the /cgi-bin part and ScriptAlias it and
280 * short-circuit the proxy... just because of the ordering in the
281 * configuration file.
283 static int proxy_detect(request_rec *r)
285 void *sconf = r->server->module_config;
286 proxy_server_conf *conf =
287 (proxy_server_conf *) ap_get_module_config(sconf, &proxy_module);
290 struct proxy_alias *ent = (struct proxy_alias *)conf->aliases->elts;
293 /* Ick... msvc (perhaps others) promotes ternary short results to int */
295 if (conf->req && r->parsed_uri.scheme) {
296 /* but it might be something vhosted */
297 if (!(r->parsed_uri.hostname
298 && !strcasecmp(r->parsed_uri.scheme, ap_http_method(r))
299 && ap_matches_request_vhost(r, r->parsed_uri.hostname,
300 (apr_port_t)(r->parsed_uri.port_str ? r->parsed_uri.port
301 : ap_default_port(r))))) {
302 r->proxyreq = PROXYREQ_PROXY;
303 r->uri = r->unparsed_uri;
304 r->filename = apr_pstrcat(r->pool, "proxy:", r->uri, NULL);
305 r->handler = "proxy-server";
308 /* We need special treatment for CONNECT proxying: it has no scheme part */
309 else if (conf->req && r->method_number == M_CONNECT
310 && r->parsed_uri.hostname
311 && r->parsed_uri.port_str) {
312 r->proxyreq = PROXYREQ_PROXY;
313 r->uri = r->unparsed_uri;
314 r->filename = apr_pstrcat(r->pool, "proxy:", r->uri, NULL);
315 r->handler = "proxy-server";
318 /* test for a ProxyPass */
319 for (i = 0; i < conf->aliases->nelts; i++) {
320 len = alias_match(r->unparsed_uri, ent[i].fake);
322 r->filename = apr_pstrcat(r->pool, "proxy:", ent[i].real,
323 r->unparsed_uri + len, NULL);
324 r->handler = "proxy-server";
325 r->proxyreq = PROXYREQ_REVERSE;
326 r->uri = r->unparsed_uri;
335 static int proxy_trans(request_rec *r)
338 void *sconf = r->server->module_config;
339 proxy_server_conf *conf =
340 (proxy_server_conf *) ap_get_module_config(sconf, &proxy_module);
342 struct proxy_alias *ent = (struct proxy_alias *) conf->aliases->elts;
346 /* someone has already set up the proxy, it was possibly ourselves
353 /* XXX: since r->uri has been manipulated already we're not really
354 * compliant with RFC1945 at this point. But this probably isn't
355 * an issue because this is a hybrid proxy/origin server.
358 for (i = 0; i < conf->aliases->nelts; i++) {
359 len = alias_match(r->uri, ent[i].fake);
362 if ((ent[i].real[0] == '!') && (ent[i].real[1] == 0)) {
366 r->filename = apr_pstrcat(r->pool, "proxy:", ent[i].real,
368 r->handler = "proxy-server";
369 r->proxyreq = PROXYREQ_REVERSE;
377 static int proxy_walk(request_rec *r)
379 proxy_server_conf *sconf = ap_get_module_config(r->server->module_config,
381 ap_conf_vector_t *per_dir_defaults = r->server->lookup_defaults;
382 ap_conf_vector_t **sec_proxy = (ap_conf_vector_t **) sconf->sec_proxy->elts;
383 ap_conf_vector_t *entry_config;
384 proxy_dir_conf *entry_proxy;
385 int num_sec = sconf->sec_proxy->nelts;
386 /* XXX: shouldn't we use URI here? Canonicalize it first?
387 * Pass over "proxy:" prefix
389 const char *proxyname = r->filename + 6;
392 for (j = 0; j < num_sec; ++j)
394 entry_config = sec_proxy[j];
395 entry_proxy = ap_get_module_config(entry_config, &proxy_module);
397 /* XXX: What about case insensitive matching ???
398 * Compare regex, fnmatch or string as appropriate
399 * If the entry doesn't relate, then continue
402 ? ap_regexec(entry_proxy->r, proxyname, 0, NULL, 0)
403 : (entry_proxy->p_is_fnmatch
404 ? apr_fnmatch(entry_proxy->p, proxyname, 0)
405 : strncmp(proxyname, entry_proxy->p,
406 strlen(entry_proxy->p)))) {
409 per_dir_defaults = ap_merge_per_dir_configs(r->pool, per_dir_defaults,
413 r->per_dir_config = per_dir_defaults;
418 static int proxy_map_location(request_rec *r)
422 if (!r->proxyreq || !r->filename || strncmp(r->filename, "proxy:", 6) != 0)
425 /* Don't let the core or mod_http map_to_storage hooks handle this,
426 * We don't need directory/file_walk, and we want to TRACE on our own.
428 if ((access_status = proxy_walk(r))) {
429 ap_die(access_status, r);
430 return access_status;
436 /* -------------------------------------------------------------- */
437 /* Fixup the filename */
440 * Canonicalise the URL
442 static int proxy_fixup(request_rec *r)
447 if (!r->proxyreq || !r->filename || strncmp(r->filename, "proxy:", 6) != 0)
451 /* We definitely shouldn't canonicalize a proxy_pass.
452 * But should we really canonicalize a STD_PROXY??? -- Fahree
454 if (r->proxyreq == PROXYREQ_REVERSE) {
459 /* XXX: Shouldn't we try this before we run the proxy_walk? */
460 url = &r->filename[6];
462 /* canonicalise each specific scheme */
463 if ((access_status = proxy_run_canon_handler(r, url))) {
464 return access_status;
467 p = strchr(url, ':');
468 if (p == NULL || p == url)
469 return HTTP_BAD_REQUEST;
471 return OK; /* otherwise; we've done the best we can */
474 /* Send a redirection if the request contains a hostname which is not */
475 /* fully qualified, i.e. doesn't have a domain name appended. Some proxy */
476 /* servers like Netscape's allow this and access hosts from the local */
477 /* domain in this case. I think it is better to redirect to a FQDN, since */
478 /* these will later be found in the bookmarks files. */
479 /* The "ProxyDomain" directive determines what domain will be appended */
480 static int proxy_needsdomain(request_rec *r, const char *url, const char *domain)
485 /* We only want to worry about GETs */
486 if (!r->proxyreq || r->method_number != M_GET || !r->parsed_uri.hostname)
489 /* If host does contain a dot already, or it is "localhost", decline */
490 if (strchr(r->parsed_uri.hostname, '.') != NULL
491 || strcasecmp(r->parsed_uri.hostname, "localhost") == 0)
492 return DECLINED; /* host name has a dot already */
494 ref = apr_table_get(r->headers_in, "Referer");
496 /* Reassemble the request, but insert the domain after the host name */
497 /* Note that the domain name always starts with a dot */
498 r->parsed_uri.hostname = apr_pstrcat(r->pool, r->parsed_uri.hostname,
500 nuri = apr_uri_unparse(r->pool,
502 APR_URI_UNP_REVEALPASSWORD);
504 apr_table_set(r->headers_out, "Location", nuri);
505 ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
506 "Domain missing: %s sent to %s%s%s", r->uri,
507 apr_uri_unparse(r->pool, &r->parsed_uri,
508 APR_URI_UNP_OMITUSERINFO),
509 ref ? " from " : "", ref ? ref : "");
511 return HTTP_MOVED_PERMANENTLY;
514 /* -------------------------------------------------------------- */
517 static int proxy_handler(request_rec *r)
519 char *url, *scheme, *p;
521 void *sconf = r->server->module_config;
522 proxy_server_conf *conf = (proxy_server_conf *)
523 ap_get_module_config(sconf, &proxy_module);
524 apr_array_header_t *proxies = conf->proxies;
525 struct proxy_remote *ents = (struct proxy_remote *) proxies->elts;
526 int i, rc, access_status;
527 int direct_connect = 0;
530 proxy_balancer *balancer = NULL;
531 proxy_worker *worker = NULL;
533 /* is this for us? */
534 if (!r->proxyreq || !r->filename || strncmp(r->filename, "proxy:", 6) != 0)
537 /* handle max-forwards / OPTIONS / TRACE */
538 if ((str = apr_table_get(r->headers_in, "Max-Forwards"))) {
539 maxfwd = strtol(str, NULL, 10);
541 switch (r->method_number) {
544 r->proxyreq = PROXYREQ_NONE;
545 if ((access_status = ap_send_http_trace(r)))
546 ap_die(access_status, r);
548 ap_finalize_request_protocol(r);
553 r->proxyreq = PROXYREQ_NONE;
554 if ((access_status = ap_send_http_options(r)))
555 ap_die(access_status, r);
557 ap_finalize_request_protocol(r);
561 return ap_proxyerror(r, HTTP_BAD_GATEWAY,
562 "Max-Forwards has reached zero - proxy loop?");
566 maxfwd = (maxfwd > 0) ? maxfwd - 1 : 0;
569 /* set configured max-forwards */
570 maxfwd = conf->maxfwd;
572 apr_table_set(r->headers_in, "Max-Forwards",
573 apr_psprintf(r->pool, "%ld", (maxfwd > 0) ? maxfwd : 0));
575 url = r->filename + 6;
576 p = strchr(url, ':');
578 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
579 "proxy_handler no URL in %s", r->filename);
580 return HTTP_BAD_REQUEST;
583 /* If the host doesn't have a domain name, add one and redirect. */
584 if (conf->domain != NULL) {
585 rc = proxy_needsdomain(r, url, conf->domain);
586 if (ap_is_HTTP_REDIRECT(rc))
587 return HTTP_MOVED_PERMANENTLY;
591 scheme = apr_pstrdup(r->pool, url);
594 /* Check URI's destination host against NoProxy hosts */
595 /* Bypass ProxyRemote server lookup if configured as NoProxy */
596 /* we only know how to handle communication to a proxy via http */
597 /*if (strcasecmp(scheme, "http") == 0) */
600 struct dirconn_entry *list = (struct dirconn_entry *) conf->dirconn->elts;
602 for (direct_connect = ii = 0; ii < conf->dirconn->nelts && !direct_connect; ii++) {
603 direct_connect = list[ii].matcher(&list[ii], r);
606 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
607 (direct_connect) ? "NoProxy for %s" : "UseProxy for %s",
612 /* Try to obtain the most suitable worker */
613 access_status = ap_proxy_pre_request(&worker, &balancer, r, conf, &url);
614 if (access_status != OK)
615 return access_status;
617 /* firstly, try a proxy, unless a NoProxy directive is active */
618 if (!direct_connect) {
619 for (i = 0; i < proxies->nelts; i++) {
620 p2 = ap_strchr_c(ents[i].scheme, ':'); /* is it a partial URL? */
621 if (strcmp(ents[i].scheme, "*") == 0 ||
622 (ents[i].use_regex && ap_regexec(ents[i].regexp, url, 0,NULL, 0)) ||
623 (p2 == NULL && strcasecmp(scheme, ents[i].scheme) == 0) ||
625 strncasecmp(url, ents[i].scheme, strlen(ents[i].scheme)) == 0)) {
627 /* handle the scheme */
628 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
629 "Trying to run scheme_handler against proxy");
630 access_status = proxy_run_scheme_handler(r, worker, conf, url, ents[i].hostname, ents[i].port);
632 /* an error or success */
633 if (access_status != DECLINED && access_status != HTTP_BAD_GATEWAY) {
636 /* we failed to talk to the upstream proxy */
641 /* otherwise, try it direct */
642 /* N.B. what if we're behind a firewall, where we must use a proxy or
646 /* handle the scheme */
647 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
648 "Trying to run scheme_handler");
649 access_status = proxy_run_scheme_handler(r, worker, conf, url, NULL, 0);
650 if (DECLINED == access_status) {
651 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, r->server,
652 "proxy: No protocol handler was valid for the URL %s. "
653 "If you are using a DSO version of mod_proxy, make sure "
654 "the proxy submodules are included in the configuration "
655 "using LoadModule.", r->uri);
656 access_status = HTTP_FORBIDDEN;
662 int post_status = proxy_run_post_request(worker, balancer, r, conf);
663 if (post_status == DECLINED) {
664 post_status = OK; /* no post_request handler available */
665 /* TODO: reclycle direct worker */
668 return access_status;
671 /* -------------------------------------------------------------- */
672 /* Setup configurable data */
674 static void * create_proxy_config(apr_pool_t *p, server_rec *s)
676 proxy_server_conf *ps = apr_pcalloc(p, sizeof(proxy_server_conf));
678 ps->sec_proxy = apr_array_make(p, 10, sizeof(ap_conf_vector_t *));
679 ps->proxies = apr_array_make(p, 10, sizeof(struct proxy_remote));
680 ps->aliases = apr_array_make(p, 10, sizeof(struct proxy_alias));
681 ps->raliases = apr_array_make(p, 10, sizeof(struct proxy_alias));
682 ps->cookie_paths = apr_array_make(p, 10, sizeof(struct proxy_alias));
683 ps->cookie_domains = apr_array_make(p, 10, sizeof(struct proxy_alias));
684 ps->cookie_path_str = apr_strmatch_precompile(p, "path=", 0);
685 ps->cookie_domain_str = apr_strmatch_precompile(p, "domain=", 0);
686 ps->noproxies = apr_array_make(p, 10, sizeof(struct noproxy_entry));
687 ps->dirconn = apr_array_make(p, 10, sizeof(struct dirconn_entry));
688 ps->allowed_connect_ports = apr_array_make(p, 10, sizeof(int));
689 ps->workers = apr_array_make(p, 10, sizeof(proxy_worker));
690 ps->balancers = apr_array_make(p, 10, sizeof(proxy_balancer));
692 ps->viaopt = via_off; /* initially backward compatible with 1.3.1 */
693 ps->viaopt_set = 0; /* 0 means default */
696 ps->recv_buffer_size = 0; /* this default was left unset for some reason */
697 ps->recv_buffer_size_set = 0;
698 ps->io_buffer_size = AP_IOBUFSIZE;
699 ps->io_buffer_size_set = 0;
700 ps->maxfwd = DEFAULT_MAX_FORWARDS;
702 ps->error_override = 0;
703 ps->error_override_set = 0;
704 ps->preserve_host_set = 0;
705 ps->preserve_host = 0;
708 ps->badopt = bad_error;
713 static void * merge_proxy_config(apr_pool_t *p, void *basev, void *overridesv)
715 proxy_server_conf *ps = apr_pcalloc(p, sizeof(proxy_server_conf));
716 proxy_server_conf *base = (proxy_server_conf *) basev;
717 proxy_server_conf *overrides = (proxy_server_conf *) overridesv;
719 ps->proxies = apr_array_append(p, base->proxies, overrides->proxies);
720 ps->sec_proxy = apr_array_append(p, base->sec_proxy, overrides->sec_proxy);
721 ps->aliases = apr_array_append(p, base->aliases, overrides->aliases);
722 ps->raliases = apr_array_append(p, base->raliases, overrides->raliases);
724 = apr_array_append(p, base->cookie_paths, overrides->cookie_paths);
726 = apr_array_append(p, base->cookie_domains, overrides->cookie_domains);
727 ps->cookie_path_str = base->cookie_path_str;
728 ps->cookie_domain_str = base->cookie_domain_str;
729 ps->noproxies = apr_array_append(p, base->noproxies, overrides->noproxies);
730 ps->dirconn = apr_array_append(p, base->dirconn, overrides->dirconn);
731 ps->allowed_connect_ports = apr_array_append(p, base->allowed_connect_ports, overrides->allowed_connect_ports);
732 ps->workers = apr_array_append(p, base->workers, overrides->workers);
733 ps->balancers = apr_array_append(p, base->balancers, overrides->balancers);
735 ps->domain = (overrides->domain == NULL) ? base->domain : overrides->domain;
736 ps->viaopt = (overrides->viaopt_set == 0) ? base->viaopt : overrides->viaopt;
737 ps->req = (overrides->req_set == 0) ? base->req : overrides->req;
738 ps->recv_buffer_size = (overrides->recv_buffer_size_set == 0) ? base->recv_buffer_size : overrides->recv_buffer_size;
739 ps->io_buffer_size = (overrides->io_buffer_size_set == 0) ? base->io_buffer_size : overrides->io_buffer_size;
740 ps->maxfwd = (overrides->maxfwd_set == 0) ? base->maxfwd : overrides->maxfwd;
741 ps->error_override = (overrides->error_override_set == 0) ? base->error_override : overrides->error_override;
742 ps->preserve_host = (overrides->preserve_host_set == 0) ? base->preserve_host : overrides->preserve_host;
743 ps->timeout= (overrides->timeout_set == 0) ? base->timeout : overrides->timeout;
744 ps->badopt = (overrides->badopt_set == 0) ? base->badopt : overrides->badopt;
749 static void *create_proxy_dir_config(apr_pool_t *p, char *dummy)
751 proxy_dir_conf *new =
752 (proxy_dir_conf *) apr_pcalloc(p, sizeof(proxy_dir_conf));
754 /* Filled in by proxysection, when applicable */
759 static void *merge_proxy_dir_config(apr_pool_t *p, void *basev, void *addv)
761 proxy_dir_conf *new = (proxy_dir_conf *) apr_pcalloc(p, sizeof(proxy_dir_conf));
762 proxy_dir_conf *add = (proxy_dir_conf *) addv;
765 new->p_is_fnmatch = add->p_is_fnmatch;
772 add_proxy(cmd_parms *cmd, void *dummy, const char *f1, const char *r1, int regex)
774 server_rec *s = cmd->server;
775 proxy_server_conf *conf =
776 (proxy_server_conf *) ap_get_module_config(s->module_config, &proxy_module);
777 struct proxy_remote *new;
779 char *r, *f, *scheme;
783 r = apr_pstrdup(cmd->pool, r1);
784 scheme = apr_pstrdup(cmd->pool, r1);
785 f = apr_pstrdup(cmd->pool, f1);
787 if (p == NULL || p[1] != '/' || p[2] != '/' || p[3] == '\0') {
789 return "ProxyRemoteMatch: Bad syntax for a remote proxy server";
791 return "ProxyRemote: Bad syntax for a remote proxy server";
796 q = strchr(p + 3, ':');
798 if (sscanf(q + 1, "%u", &port) != 1 || port > 65535) {
800 return "ProxyRemoteMatch: Bad syntax for a remote proxy server (bad port number)";
802 return "ProxyRemote: Bad syntax for a remote proxy server (bad port number)";
810 reg = ap_pregcomp(cmd->pool, f, REG_EXTENDED);
812 return "Regular expression for ProxyRemoteMatch could not be compiled.";
815 if (strchr(f, ':') == NULL)
816 ap_str_tolower(f); /* lowercase scheme */
817 ap_str_tolower(p + 3); /* lowercase hostname */
820 port = apr_uri_port_of_scheme(scheme);
823 new = apr_array_push(conf->proxies);
826 new->hostname = p + 3;
829 new->use_regex = regex;
834 add_proxy_noregex(cmd_parms *cmd, void *dummy, const char *f1, const char *r1)
836 return add_proxy(cmd, dummy, f1, r1, 0);
840 add_proxy_regex(cmd_parms *cmd, void *dummy, const char *f1, const char *r1)
842 return add_proxy(cmd, dummy, f1, r1, 1);
846 add_pass(cmd_parms *cmd, void *dummy, const char *arg)
848 server_rec *s = cmd->server;
849 proxy_server_conf *conf =
850 (proxy_server_conf *) ap_get_module_config(s->module_config, &proxy_module);
851 struct proxy_alias *new;
855 apr_table_t *params = apr_table_make(cmd->pool, 5);
856 const apr_array_header_t *arr;
857 const apr_table_entry_t *elts;
861 word = ap_getword_conf(cmd->pool, &arg);
867 char *val = strchr(word, '=');
870 return "Invalid ProxyPass parameter. Paramet must be in the form 'key=value'";
872 return "ProxyPass can not have a path when defined in a location";
876 apr_table_setn(params, word, val);
881 return "ProxyPass needs a path when not defined in a location";
883 new = apr_array_push(conf->aliases);
884 new->fake = apr_pstrdup(cmd->pool, f);
885 new->real = apr_pstrdup(cmd->pool, r);
887 arr = apr_table_elts(params);
888 elts = (const apr_table_entry_t *)arr->elts;
889 /* Distinguish the balancer from woker */
890 if (strncasecmp(r, "balancer:", 9) == 0) {
891 proxy_balancer *balancer = ap_proxy_get_balancer(cmd->pool, conf, r);
893 const char *err = ap_proxy_add_balancer(&balancer,
897 return apr_pstrcat(cmd->temp_pool, "ProxyPass ", err, NULL);
899 for (i = 0; i < arr->nelts; i++) {
900 const char *err = set_balancer_param(cmd->pool, balancer, elts[i].key,
903 return apr_pstrcat(cmd->temp_pool, "ProxyPass ", err, NULL);
907 proxy_worker *worker = ap_proxy_get_worker(cmd->temp_pool, conf, r);
909 const char *err = ap_proxy_add_worker(&worker, cmd->pool, conf, r);
911 return apr_pstrcat(cmd->temp_pool, "ProxyPass ", err, NULL);
913 PROXY_COPY_CONF_PARAMS(worker, conf);
915 for (i = 0; i < arr->nelts; i++) {
916 const char *err = set_worker_param(cmd->pool, worker, elts[i].key,
919 return apr_pstrcat(cmd->temp_pool, "ProxyPass ", err, NULL);
926 add_pass_reverse(cmd_parms *cmd, void *dummy, const char *f, const char *r)
928 server_rec *s = cmd->server;
929 proxy_server_conf *conf;
930 struct proxy_alias *new;
932 conf = (proxy_server_conf *)ap_get_module_config(s->module_config,
934 if (r!=NULL && cmd->path == NULL ) {
935 new = apr_array_push(conf->raliases);
938 } else if (r==NULL && cmd->path != NULL) {
939 new = apr_array_push(conf->raliases);
940 new->fake = cmd->path;
944 return "ProxyPassReverse needs a path when not defined in a location";
946 return "ProxyPassReverse can not have a path when defined in a location";
952 cookie_path(cmd_parms *cmd, void *dummy, const char *f, const char *r)
954 server_rec *s = cmd->server;
955 proxy_server_conf *conf;
956 struct proxy_alias *new;
958 conf = (proxy_server_conf *)ap_get_module_config(s->module_config,
960 new = apr_array_push(conf->cookie_paths);
967 cookie_domain(cmd_parms *cmd, void *dummy, const char *f, const char *r)
969 server_rec *s = cmd->server;
970 proxy_server_conf *conf;
971 struct proxy_alias *new;
973 conf = (proxy_server_conf *)ap_get_module_config(s->module_config,
975 new = apr_array_push(conf->cookie_domains);
983 set_proxy_exclude(cmd_parms *parms, void *dummy, const char *arg)
985 server_rec *s = parms->server;
986 proxy_server_conf *conf =
987 ap_get_module_config(s->module_config, &proxy_module);
988 struct noproxy_entry *new;
989 struct noproxy_entry *list = (struct noproxy_entry *) conf->noproxies->elts;
990 struct apr_sockaddr_t *addr;
994 /* Don't duplicate entries */
995 for (i = 0; i < conf->noproxies->nelts; i++) {
996 if (apr_strnatcasecmp(arg, list[i].name) == 0) { /* ignore case for host names */
1002 new = apr_array_push(conf->noproxies);
1004 if (APR_SUCCESS == apr_sockaddr_info_get(&addr, new->name, APR_UNSPEC, 0, 0, parms->pool)) {
1015 * Set the ports CONNECT can use
1018 set_allowed_ports(cmd_parms *parms, void *dummy, const char *arg)
1020 server_rec *s = parms->server;
1021 proxy_server_conf *conf =
1022 ap_get_module_config(s->module_config, &proxy_module);
1025 if (!apr_isdigit(arg[0]))
1026 return "AllowCONNECT: port number must be numeric";
1028 New = apr_array_push(conf->allowed_connect_ports);
1033 /* Similar to set_proxy_exclude(), but defining directly connected hosts,
1034 * which should never be accessed via the configured ProxyRemote servers
1037 set_proxy_dirconn(cmd_parms *parms, void *dummy, const char *arg)
1039 server_rec *s = parms->server;
1040 proxy_server_conf *conf =
1041 ap_get_module_config(s->module_config, &proxy_module);
1042 struct dirconn_entry *New;
1043 struct dirconn_entry *list = (struct dirconn_entry *) conf->dirconn->elts;
1047 /* Don't duplicate entries */
1048 for (i = 0; i < conf->dirconn->nelts; i++) {
1049 if (strcasecmp(arg, list[i].name) == 0)
1054 New = apr_array_push(conf->dirconn);
1055 New->name = apr_pstrdup(parms->pool, arg);
1056 New->hostaddr = NULL;
1058 if (ap_proxy_is_ipaddr(New, parms->pool)) {
1060 ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
1061 "Parsed addr %s", inet_ntoa(New->addr));
1062 ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
1063 "Parsed mask %s", inet_ntoa(New->mask));
1066 else if (ap_proxy_is_domainname(New, parms->pool)) {
1067 ap_str_tolower(New->name);
1069 ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
1070 "Parsed domain %s", New->name);
1073 else if (ap_proxy_is_hostname(New, parms->pool)) {
1074 ap_str_tolower(New->name);
1076 ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
1077 "Parsed host %s", New->name);
1081 ap_proxy_is_word(New, parms->pool);
1083 fprintf(stderr, "Parsed word %s\n", New->name);
1091 set_proxy_domain(cmd_parms *parms, void *dummy, const char *arg)
1093 proxy_server_conf *psf =
1094 ap_get_module_config(parms->server->module_config, &proxy_module);
1097 return "ProxyDomain: domain name must start with a dot.";
1104 set_proxy_req(cmd_parms *parms, void *dummy, int flag)
1106 proxy_server_conf *psf =
1107 ap_get_module_config(parms->server->module_config, &proxy_module);
1114 set_proxy_error_override(cmd_parms *parms, void *dummy, int flag)
1116 proxy_server_conf *psf =
1117 ap_get_module_config(parms->server->module_config, &proxy_module);
1119 psf->error_override = flag;
1120 psf->error_override_set = 1;
1124 set_preserve_host(cmd_parms *parms, void *dummy, int flag)
1126 proxy_server_conf *psf =
1127 ap_get_module_config(parms->server->module_config, &proxy_module);
1129 psf->preserve_host = flag;
1130 psf->preserve_host_set = 1;
1135 set_recv_buffer_size(cmd_parms *parms, void *dummy, const char *arg)
1137 proxy_server_conf *psf =
1138 ap_get_module_config(parms->server->module_config, &proxy_module);
1140 if (s < 512 && s != 0) {
1141 return "ProxyReceiveBufferSize must be >= 512 bytes, or 0 for system default.";
1144 psf->recv_buffer_size = s;
1145 psf->recv_buffer_size_set = 1;
1150 set_io_buffer_size(cmd_parms *parms, void *dummy, const char *arg)
1152 proxy_server_conf *psf =
1153 ap_get_module_config(parms->server->module_config, &proxy_module);
1156 psf->io_buffer_size = ((s > AP_IOBUFSIZE) ? s : AP_IOBUFSIZE);
1157 psf->io_buffer_size_set = 1;
1162 set_max_forwards(cmd_parms *parms, void *dummy, const char *arg)
1164 proxy_server_conf *psf =
1165 ap_get_module_config(parms->server->module_config, &proxy_module);
1168 return "ProxyMaxForwards must be greater or equal to zero..";
1172 psf->maxfwd_set = 1;
1176 set_proxy_timeout(cmd_parms *parms, void *dummy, const char *arg)
1178 proxy_server_conf *psf =
1179 ap_get_module_config(parms->server->module_config, &proxy_module);
1184 return "Proxy Timeout must be at least 1 second.";
1187 psf->timeout=apr_time_from_sec(timeout);
1193 set_via_opt(cmd_parms *parms, void *dummy, const char *arg)
1195 proxy_server_conf *psf =
1196 ap_get_module_config(parms->server->module_config, &proxy_module);
1198 if (strcasecmp(arg, "Off") == 0)
1199 psf->viaopt = via_off;
1200 else if (strcasecmp(arg, "On") == 0)
1201 psf->viaopt = via_on;
1202 else if (strcasecmp(arg, "Block") == 0)
1203 psf->viaopt = via_block;
1204 else if (strcasecmp(arg, "Full") == 0)
1205 psf->viaopt = via_full;
1207 return "ProxyVia must be one of: "
1208 "off | on | full | block";
1211 psf->viaopt_set = 1;
1216 set_bad_opt(cmd_parms *parms, void *dummy, const char *arg)
1218 proxy_server_conf *psf =
1219 ap_get_module_config(parms->server->module_config, &proxy_module);
1221 if (strcasecmp(arg, "IsError") == 0)
1222 psf->badopt = bad_error;
1223 else if (strcasecmp(arg, "Ignore") == 0)
1224 psf->badopt = bad_ignore;
1225 else if (strcasecmp(arg, "StartBody") == 0)
1226 psf->badopt = bad_body;
1228 return "ProxyBadHeader must be one of: "
1229 "IsError | Ignore | StartBody";
1232 psf->badopt_set = 1;
1237 set_status_opt(cmd_parms *parms, void *dummy, const char *arg)
1239 proxy_server_conf *psf =
1240 ap_get_module_config(parms->server->module_config, &proxy_module);
1242 if (strcasecmp(arg, "Off") == 0)
1243 psf->proxy_status = status_off;
1244 else if (strcasecmp(arg, "On") == 0)
1245 psf->proxy_status = status_on;
1246 else if (strcasecmp(arg, "Full") == 0)
1247 psf->proxy_status = status_full;
1249 return "ProxyStatus must be one of: "
1253 psf->proxy_status_set = 1;
1257 static const char *add_member(cmd_parms *cmd, void *dummy, const char *arg)
1259 server_rec *s = cmd->server;
1260 proxy_server_conf *conf =
1261 ap_get_module_config(s->module_config, &proxy_module);
1262 proxy_balancer *balancer;
1263 proxy_worker *worker;
1264 char *path = cmd->path;
1267 apr_table_t *params = apr_table_make(cmd->pool, 5);
1268 const apr_array_header_t *arr;
1269 const apr_table_entry_t *elts;
1273 path = apr_pstrdup(cmd->pool, cmd->path);
1275 word = ap_getword_conf(cmd->pool, &arg);
1281 char *val = strchr(word, '=');
1284 return "BalancerMember can not have a balancer name when defined in a location";
1286 return "Invalid BalancerMember parameter. Paramet must be in the form 'key=value'";
1289 apr_table_setn(params, word, val);
1293 return "BalancerMember must define balancer name when outside <Proxy > section";
1295 return "BalancerMember must define remote proxy server";
1297 ap_str_tolower(path); /* lowercase scheme://hostname */
1298 ap_str_tolower(name); /* lowercase scheme://hostname */
1300 /* Try to find existing worker */
1301 worker = ap_proxy_get_worker(cmd->temp_pool, conf, name);
1304 if ((err = ap_proxy_add_worker(&worker, cmd->pool, conf, name)) != NULL)
1305 return apr_pstrcat(cmd->temp_pool, "BalancerMember ", err, NULL);
1307 PROXY_COPY_CONF_PARAMS(worker, conf);
1309 arr = apr_table_elts(params);
1310 elts = (const apr_table_entry_t *)arr->elts;
1311 for (i = 0; i < arr->nelts; i++) {
1312 const char *err = set_worker_param(cmd->pool, worker, elts[i].key,
1315 return apr_pstrcat(cmd->temp_pool, "BalancerMember ", err, NULL);
1317 /* Try to find the balancer */
1318 balancer = ap_proxy_get_balancer(cmd->temp_pool, conf, path);
1320 const char *err = ap_proxy_add_balancer(&balancer,
1324 return apr_pstrcat(cmd->temp_pool, "BalancerMember ", err, NULL);
1326 /* Add the worker to the load balancer */
1327 ap_proxy_add_worker_to_balancer(cmd->pool, balancer, worker);
1333 set_sticky_session(cmd_parms *cmd, void *dummy, const char *f, const char *r)
1335 server_rec *s = cmd->server;
1336 proxy_server_conf *conf =
1337 ap_get_module_config(s->module_config, &proxy_module);
1338 proxy_balancer *balancer;
1339 const char *name, *sticky;
1341 if (r != NULL && cmd->path == NULL ) {
1344 } else if (r == NULL && cmd->path != NULL) {
1349 return "BalancerStickySession needs a path when not defined in a location";
1351 return "BalancerStickySession can not have a path when defined in a location";
1353 /* Try to find the balancer */
1354 balancer = ap_proxy_get_balancer(cmd->temp_pool, conf, name);
1356 return apr_pstrcat(cmd->temp_pool, "BalancerStickySession: can not find a load balancer '",
1358 if (!strcasecmp(sticky, "nofailover"))
1359 balancer->sticky_force = 1;
1361 balancer->sticky = sticky;
1365 static void ap_add_per_proxy_conf(server_rec *s, ap_conf_vector_t *dir_config)
1367 proxy_server_conf *sconf = ap_get_module_config(s->module_config,
1369 void **new_space = (void **)apr_array_push(sconf->sec_proxy);
1371 *new_space = dir_config;
1374 static const char *proxysection(cmd_parms *cmd, void *mconfig, const char *arg)
1377 const char *endp = ap_strrchr_c(arg, '>');
1378 int old_overrides = cmd->override;
1379 char *old_path = cmd->path;
1380 proxy_dir_conf *conf;
1381 ap_conf_vector_t *new_dir_conf = ap_create_per_dir_config(cmd->pool);
1383 const command_rec *thiscmd = cmd->cmd;
1385 const char *err = ap_check_cmd_context(cmd,
1386 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1392 return apr_pstrcat(cmd->pool, cmd->cmd->name,
1393 "> directive missing closing '>'", NULL);
1396 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1399 if (thiscmd->cmd_data)
1400 return "<ProxyMatch > block must specify a path";
1402 return "<Proxy > block must specify a path";
1405 cmd->path = ap_getword_conf(cmd->pool, &arg);
1406 cmd->override = OR_ALL|ACCESS_CONF;
1408 if (!strncasecmp(cmd->path, "proxy:", 6))
1411 /* XXX Ignore case? What if we proxy a case-insensitive server?!?
1412 * While we are at it, shouldn't we also canonicalize the entire
1413 * scheme? See proxy_fixup()
1415 if (thiscmd->cmd_data) { /* <ProxyMatch> */
1416 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED);
1418 return "Regex could not be compiled";
1421 else if (!strcmp(cmd->path, "~")) {
1422 cmd->path = ap_getword_conf(cmd->pool, &arg);
1424 return "<Proxy ~ > block must specify a path";
1425 if (strncasecmp(cmd->path, "proxy:", 6))
1427 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED);
1429 return "Regex could not be compiled";
1433 /* initialize our config and fetch it */
1434 conf = ap_set_config_vectors(cmd->server, new_dir_conf, cmd->path,
1435 &proxy_module, cmd->pool);
1437 errmsg = ap_walk_config(cmd->directive->first_child, cmd, new_dir_conf);
1442 conf->p = cmd->path;
1443 conf->p_is_fnmatch = apr_fnmatch_test(conf->p);
1445 ap_add_per_proxy_conf(cmd->server, new_dir_conf);
1448 return apr_pstrcat(cmd->pool, "Multiple ", thiscmd->name,
1449 "> arguments not (yet) supported.", NULL);
1452 cmd->path = old_path;
1453 cmd->override = old_overrides;
1458 static const command_rec proxy_cmds[] =
1460 AP_INIT_RAW_ARGS("<Proxy", proxysection, NULL, RSRC_CONF,
1461 "Container for directives affecting resources located in the proxied "
1463 AP_INIT_RAW_ARGS("<ProxyMatch", proxysection, (void*)1, RSRC_CONF,
1464 "Container for directives affecting resources located in the proxied "
1465 "location, in regular expression syntax"),
1466 AP_INIT_FLAG("ProxyRequests", set_proxy_req, NULL, RSRC_CONF,
1467 "on if the true proxy requests should be accepted"),
1468 AP_INIT_TAKE2("ProxyRemote", add_proxy_noregex, NULL, RSRC_CONF,
1469 "a scheme, partial URL or '*' and a proxy server"),
1470 AP_INIT_TAKE2("ProxyRemoteMatch", add_proxy_regex, NULL, RSRC_CONF,
1471 "a regex pattern and a proxy server"),
1472 AP_INIT_RAW_ARGS("ProxyPass", add_pass, NULL, RSRC_CONF|ACCESS_CONF,
1473 "a virtual path and a URL"),
1474 AP_INIT_TAKE12("ProxyPassReverse", add_pass_reverse, NULL, RSRC_CONF|ACCESS_CONF,
1475 "a virtual path and a URL for reverse proxy behaviour"),
1476 AP_INIT_TAKE2("ProxyPassReverseCookiePath", cookie_path, NULL,
1477 RSRC_CONF|ACCESS_CONF, "Path rewrite rule for proxying cookies"),
1478 AP_INIT_TAKE2("ProxyPassReverseCookieDomain", cookie_domain, NULL,
1479 RSRC_CONF|ACCESS_CONF, "Domain rewrite rule for proxying cookies"),
1480 AP_INIT_ITERATE("ProxyBlock", set_proxy_exclude, NULL, RSRC_CONF,
1481 "A list of names, hosts or domains to which the proxy will not connect"),
1482 AP_INIT_TAKE1("ProxyReceiveBufferSize", set_recv_buffer_size, NULL, RSRC_CONF,
1483 "Receive buffer size for outgoing HTTP and FTP connections in bytes"),
1484 AP_INIT_TAKE1("ProxyIOBufferSize", set_io_buffer_size, NULL, RSRC_CONF,
1485 "IO buffer size for outgoing HTTP and FTP connections in bytes"),
1486 AP_INIT_TAKE1("ProxyMaxForwards", set_max_forwards, NULL, RSRC_CONF,
1487 "The maximum number of proxies a request may be forwarded through."),
1488 AP_INIT_ITERATE("NoProxy", set_proxy_dirconn, NULL, RSRC_CONF,
1489 "A list of domains, hosts, or subnets to which the proxy will connect directly"),
1490 AP_INIT_TAKE1("ProxyDomain", set_proxy_domain, NULL, RSRC_CONF,
1491 "The default intranet domain name (in absence of a domain in the URL)"),
1492 AP_INIT_ITERATE("AllowCONNECT", set_allowed_ports, NULL, RSRC_CONF,
1493 "A list of ports which CONNECT may connect to"),
1494 AP_INIT_TAKE1("ProxyVia", set_via_opt, NULL, RSRC_CONF,
1495 "Configure Via: proxy header header to one of: on | off | block | full"),
1496 AP_INIT_FLAG("ProxyErrorOverride", set_proxy_error_override, NULL, RSRC_CONF,
1497 "use our error handling pages instead of the servers' we are proxying"),
1498 AP_INIT_FLAG("ProxyPreserveHost", set_preserve_host, NULL, RSRC_CONF,
1499 "on if we should preserve host header while proxying"),
1500 AP_INIT_TAKE1("ProxyTimeout", set_proxy_timeout, NULL, RSRC_CONF,
1501 "Set the timeout (in seconds) for a proxied connection. "
1502 "This overrides the server timeout"),
1503 AP_INIT_TAKE1("ProxyBadHeader", set_bad_opt, NULL, RSRC_CONF,
1504 "How to handle bad header line in response: IsError | Ignore | StartBody"),
1505 AP_INIT_RAW_ARGS("BalancerMember", add_member, NULL, RSRC_CONF|ACCESS_CONF,
1506 "A balancer name and scheme with list of params"),
1507 AP_INIT_TAKE12("BalancerStickySession", set_sticky_session, NULL, RSRC_CONF|ACCESS_CONF,
1508 "A balancer and sticky session name"),
1509 AP_INIT_TAKE1("ProxyStatus", set_status_opt, NULL, RSRC_CONF,
1510 "Configure Status: proxy status to one of: on | off | full"),
1514 static APR_OPTIONAL_FN_TYPE(ssl_proxy_enable) *proxy_ssl_enable = NULL;
1515 static APR_OPTIONAL_FN_TYPE(ssl_engine_disable) *proxy_ssl_disable = NULL;
1517 PROXY_DECLARE(int) ap_proxy_ssl_enable(conn_rec *c)
1520 * if c == NULL just check if the optional function was imported
1521 * else run the optional function so ssl filters are inserted
1523 if (proxy_ssl_enable) {
1524 return c ? proxy_ssl_enable(c) : 1;
1530 PROXY_DECLARE(int) ap_proxy_ssl_disable(conn_rec *c)
1532 if (proxy_ssl_disable) {
1533 return proxy_ssl_disable(c);
1539 static int proxy_post_config(apr_pool_t *pconf, apr_pool_t *plog,
1540 apr_pool_t *ptemp, server_rec *s)
1542 proxy_ssl_enable = APR_RETRIEVE_OPTIONAL_FN(ssl_proxy_enable);
1543 proxy_ssl_disable = APR_RETRIEVE_OPTIONAL_FN(ssl_engine_disable);
1550 #define MBYTE 1048576L
1551 #define GBYTE 1073741824L
1553 /* Format the number of bytes nicely */
1554 static void format_byte_out(request_rec *r, apr_off_t bytes)
1557 if (bytes < (5 * KBYTE))
1558 ap_rprintf(r, "%d B", (int) bytes);
1559 else if (bytes < (MBYTE / 2))
1560 ap_rprintf(r, "%.1f kB", (float) bytes / KBYTE);
1561 else if (bytes < (GBYTE / 2))
1562 ap_rprintf(r, "%.1f MB", (float) bytes / MBYTE);
1564 ap_rprintf(r, "%.1f GB", (float) bytes / GBYTE);
1568 * proxy Extension to mod_status
1570 static int proxy_status_hook(request_rec *r, int flags)
1573 void *sconf = r->server->module_config;
1574 proxy_server_conf *conf = (proxy_server_conf *)
1575 ap_get_module_config(sconf, &proxy_module);
1576 proxy_balancer *balancer = NULL;
1577 proxy_runtime_worker *worker = NULL;
1579 if (flags & AP_STATUS_SHORT || conf->balancers->nelts == 0 ||
1580 conf->proxy_status == status_off)
1583 balancer = (proxy_balancer *)conf->balancers->elts;
1584 for (i = 0; i < conf->balancers->nelts; i++) {
1585 ap_rputs("<hr />\n<h1>Proxy LoadBalancer Status for ", r);
1586 ap_rvputs(r, balancer->name, "</h1>\n\n", NULL);
1587 ap_rputs("\n\n<table border=\"0\"><tr>"
1588 "<th>SSes</th><th>Timeout</th>"
1590 ap_rvputs(r, "<td>", balancer->sticky, NULL);
1591 ap_rprintf(r, "</td><td>%d %d sec</td>\n", i,
1592 apr_time_sec(balancer->timeout));
1593 ap_rputs("</table>\n", r);
1594 ap_rputs("\n\n<table border=\"0\"><tr>"
1595 "<th>Sch</th><th>Host</th>"
1596 "<th>Route</th><th>Redir</th>"
1597 "<th>F</th><th>Acc</th><th>Wr</th><th>Rd</th>"
1600 worker = (proxy_runtime_worker *)balancer->workers->elts;
1601 for (n = 0; n < balancer->workers->nelts; n++) {
1603 ap_rvputs(r, "<tr>\n<td>", worker->w->scheme, "</td>", NULL);
1604 ap_rvputs(r, "<td>", worker->w->hostname, "</td>", NULL);
1605 ap_rvputs(r, "<td>", worker->w->route, NULL);
1606 ap_rvputs(r, "</td><td>", worker->w->redirect, NULL);
1607 ap_rprintf(r, "</td><td>%.2f</td>", worker->s->lbfactor);
1608 ap_rprintf(r, "<td>%d</td><td>", (int)(worker->s->elected));
1609 format_byte_out(r, worker->s->transfered);
1610 ap_rputs("</td><td>", r);
1611 format_byte_out(r, worker->s->transfered);
1612 ap_rputs("</td>\n", r);
1614 /* TODO: Add the rest of dynamic worker data */
1615 ap_rputs("</tr>\n", r);
1619 ap_rputs("</table>\n", r);
1622 ap_rputs("<hr /><table>\n"
1623 "<tr><th>SSes</th><td>Sticky session name</td></tr>\n"
1624 "<tr><th>Timeout</th><td>Balancer Timeout</td></tr>\n"
1625 "<tr><th>Sch</th><td>Connection scheme</td></tr>\n"
1626 "<tr><th>Host</th><td>Backend Hostname</td></tr>\n"
1627 "<tr><th>Route</th><td>Session Route</td></tr>\n"
1628 "<tr><th>Redir</th><td>Session Route Redirection</td></tr>\n"
1629 "<tr><th>F</th><td>Load Balancer Factor in %</td></tr>\n"
1630 "<tr><th>Acc</th><td>Number of requests</td></tr>\n"
1631 "<tr><th>Wr</th><td>Number of bytes transfered</td></tr>\n"
1632 "<tr><th>Rd</th><td>Number of bytes readed</td></tr>\n"
1639 * This routine is called before the server processes the configuration
1640 * files. There is no return value.
1642 static int proxy_pre_config(apr_pool_t *pconf, apr_pool_t *plog,
1645 APR_OPTIONAL_HOOK(ap, status_hook, proxy_status_hook, NULL, NULL,
1650 static void register_hooks(apr_pool_t *p)
1652 /* fixup before mod_rewrite, so that the proxied url will not
1653 * escaped accidentally by our fixup.
1656 static const char * const aszSucc[]={ "mod_rewrite.c", NULL };
1660 ap_hook_handler(proxy_handler, NULL, NULL, APR_HOOK_FIRST);
1661 /* filename-to-URI translation */
1662 ap_hook_translate_name(proxy_trans, NULL, NULL, APR_HOOK_FIRST);
1663 /* walk <Proxy > entries and suppress default TRACE behavior */
1664 ap_hook_map_to_storage(proxy_map_location, NULL,NULL, APR_HOOK_FIRST);
1667 ap_hook_fixups(proxy_fixup, NULL, aszSucc, APR_HOOK_FIRST);
1669 /* post read_request handling */
1670 ap_hook_post_read_request(proxy_detect, NULL, NULL, APR_HOOK_FIRST);
1671 /* pre config handling */
1672 ap_hook_pre_config(proxy_pre_config, NULL, NULL, APR_HOOK_MIDDLE);
1673 /* post config handling */
1674 ap_hook_post_config(proxy_post_config, NULL, NULL, APR_HOOK_MIDDLE);
1677 module AP_MODULE_DECLARE_DATA proxy_module =
1679 STANDARD20_MODULE_STUFF,
1680 create_proxy_dir_config, /* create per-directory config structure */
1681 merge_proxy_dir_config, /* merge per-directory config structures */
1682 create_proxy_config, /* create per-server config structure */
1683 merge_proxy_config, /* merge per-server config structures */
1684 proxy_cmds, /* command table */
1689 APR_HOOK_LINK(scheme_handler)
1690 APR_HOOK_LINK(canon_handler)
1691 APR_HOOK_LINK(pre_request)
1692 APR_HOOK_LINK(post_request)
1695 APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST(proxy, PROXY, int, scheme_handler,
1696 (request_rec *r, proxy_worker *worker,
1697 proxy_server_conf *conf,
1698 char *url, const char *proxyhost,
1699 apr_port_t proxyport),(r,worker,conf,
1700 url,proxyhost,proxyport),DECLINED)
1701 APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST(proxy, PROXY, int, canon_handler,
1702 (request_rec *r, char *url),(r,
1704 APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST(proxy, PROXY, int, pre_request, (
1705 proxy_worker **worker,
1706 proxy_balancer **balancer,
1708 proxy_server_conf *conf,
1709 char **url),(worker,balancer,
1710 r,conf,url),DECLINED)
1711 APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST(proxy, PROXY, int, post_request,
1712 (proxy_worker *worker,
1713 proxy_balancer *balancer,
1715 proxy_server_conf *conf),(worker,
1716 balancer,r,conf),DECLINED)
1717 APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(proxy, PROXY, int, fixups,
1718 (request_rec *r), (r),