1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. 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.
17 /* HTTP routines for Apache proxy */
19 #include "mod_proxy.h"
22 module AP_MODULE_DECLARE_DATA proxy_http_module;
24 static apr_status_t ap_proxy_http_cleanup(const char *scheme,
26 proxy_conn_rec *backend);
29 * Canonicalise http-like URLs.
30 * scheme is the scheme for the URL
31 * url is the URL starting with the first '/'
32 * def_port is the default port for this scheme.
34 static int proxy_http_canon(request_rec *r, char *url)
36 char *host, *path, sport[7];
40 apr_port_t port, def_port;
42 /* ap_port_of_scheme() */
43 if (strncasecmp(url, "http:", 5) == 0) {
47 else if (strncasecmp(url, "https:", 6) == 0) {
54 def_port = apr_uri_port_of_scheme(scheme);
56 ap_log_error(APLOG_MARK, APLOG_TRACE1, 0, r->server,
57 "proxy: HTTP: canonicalising URL %s", url);
60 * We break the URL into host, port, path, search
63 err = ap_proxy_canon_netloc(r->pool, &url, NULL, NULL, &host, &port);
65 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
66 "error parsing URL %s: %s",
68 return HTTP_BAD_REQUEST;
72 * now parse path/search args, according to rfc1738:
75 * In a reverse proxy, our URL has been processed, so canonicalise
76 * unless proxy-nocanon is set to say it's raw
77 * In a forward proxy, we have and MUST NOT MANGLE the original.
79 switch (r->proxyreq) {
80 default: /* wtf are we doing here? */
81 case PROXYREQ_REVERSE:
82 if (apr_table_get(r->notes, "proxy-nocanon")) {
83 path = url; /* this is the raw path */
86 path = ap_proxy_canonenc(r->pool, url, strlen(url),
87 enc_path, 0, r->proxyreq);
97 return HTTP_BAD_REQUEST;
100 apr_snprintf(sport, sizeof(sport), ":%d", port);
104 if (ap_strchr_c(host, ':')) { /* if literal IPv6 address */
105 host = apr_pstrcat(r->pool, "[", host, "]", NULL);
107 r->filename = apr_pstrcat(r->pool, "proxy:", scheme, "://", host, sport,
108 "/", path, (search) ? "?" : "", (search) ? search : "", NULL);
112 /* Clear all connection-based headers from the incoming headers table */
113 typedef struct header_dptr {
118 static ap_regex_t *warn_rx;
119 static int clean_warning_headers(void *data, const char *key, const char *val)
121 apr_table_t *headers = ((header_dptr*)data)->table;
122 apr_pool_t *pool = ((header_dptr*)data)->pool;
125 apr_time_t warn_time;
126 const int nmatch = 3;
127 ap_regmatch_t pmatch[3];
129 if (headers == NULL) {
130 ((header_dptr*)data)->table = headers = apr_table_make(pool, 2);
133 * Parse this, suckers!
135 * Warning = "Warning" ":" 1#warning-value
137 * warning-value = warn-code SP warn-agent SP warn-text
141 * warn-agent = ( host [ ":" port ] ) | pseudonym
142 * ; the name or pseudonym of the server adding
143 * ; the Warning header, for use in debugging
144 * warn-text = quoted-string
145 * warn-date = <"> HTTP-date <">
147 * Buggrit, use a bloomin' regexp!
148 * (\d{3}\s+\S+\s+\".*?\"(\s+\"(.*?)\")?) --> whole in $1, date in $3
150 while (!ap_regexec(warn_rx, val, nmatch, pmatch, 0)) {
151 warning = apr_pstrndup(pool, val+pmatch[0].rm_so,
152 pmatch[0].rm_eo - pmatch[0].rm_so);
154 if (pmatch[2].rm_eo > pmatch[2].rm_so) {
155 /* OK, we have a date here */
156 date = apr_pstrndup(pool, val+pmatch[2].rm_so,
157 pmatch[2].rm_eo - pmatch[2].rm_so);
158 warn_time = apr_date_parse_http(date);
160 if (!warn_time || (warn_time == ((header_dptr*)data)->time)) {
161 apr_table_addn(headers, key, warning);
163 val += pmatch[0].rm_eo;
167 static apr_table_t *ap_proxy_clean_warnings(apr_pool_t *p, apr_table_t *headers)
172 x.time = apr_date_parse_http(apr_table_get(headers, "Date"));
173 apr_table_do(clean_warning_headers, &x, headers, "Warning", NULL);
174 if (x.table != NULL) {
175 apr_table_unset(headers, "Warning");
176 return apr_table_overlay(p, headers, x.table);
182 static int clear_conn_headers(void *data, const char *key, const char *val)
184 apr_table_t *headers = ((header_dptr*)data)->table;
185 apr_pool_t *pool = ((header_dptr*)data)->pool;
187 char *next = apr_pstrdup(pool, val);
190 while (*next && !apr_isspace(*next) && (*next != ',')) {
193 while (*next && (apr_isspace(*next) || (*next == ','))) {
196 apr_table_unset(headers, name);
200 static void ap_proxy_clear_connection(apr_pool_t *p, apr_table_t *headers)
205 apr_table_unset(headers, "Proxy-Connection");
206 apr_table_do(clear_conn_headers, &x, headers, "Connection", NULL);
207 apr_table_unset(headers, "Connection");
209 static void add_te_chunked(apr_pool_t *p,
210 apr_bucket_alloc_t *bucket_alloc,
211 apr_bucket_brigade *header_brigade)
215 const char te_hdr[] = "Transfer-Encoding: chunked" CRLF;
217 buf = apr_pmemdup(p, te_hdr, sizeof(te_hdr)-1);
218 ap_xlate_proto_to_ascii(buf, sizeof(te_hdr)-1);
220 e = apr_bucket_pool_create(buf, sizeof(te_hdr)-1, p, bucket_alloc);
221 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
224 static void add_cl(apr_pool_t *p,
225 apr_bucket_alloc_t *bucket_alloc,
226 apr_bucket_brigade *header_brigade,
232 buf = apr_pstrcat(p, "Content-Length: ",
236 ap_xlate_proto_to_ascii(buf, strlen(buf));
237 e = apr_bucket_pool_create(buf, strlen(buf), p, bucket_alloc);
238 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
241 #define ASCII_CRLF "\015\012"
242 #define ASCII_ZERO "\060"
244 static void terminate_headers(apr_bucket_alloc_t *bucket_alloc,
245 apr_bucket_brigade *header_brigade)
249 /* add empty line at the end of the headers */
250 e = apr_bucket_immortal_create(ASCII_CRLF, 2, bucket_alloc);
251 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
254 static int pass_brigade(apr_bucket_alloc_t *bucket_alloc,
255 request_rec *r, proxy_conn_rec *conn,
256 conn_rec *origin, apr_bucket_brigade *bb,
260 apr_off_t transferred;
263 apr_bucket *e = apr_bucket_flush_create(bucket_alloc);
264 APR_BRIGADE_INSERT_TAIL(bb, e);
266 apr_brigade_length(bb, 0, &transferred);
267 if (transferred != -1)
268 conn->worker->s->transferred += transferred;
269 status = ap_pass_brigade(origin->output_filters, bb);
270 if (status != APR_SUCCESS) {
271 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
272 "proxy: pass request body failed to %pI (%s)",
273 conn->addr, conn->hostname);
274 if (origin->aborted) {
275 return APR_STATUS_IS_TIMEUP(status) ? HTTP_GATEWAY_TIME_OUT : HTTP_BAD_GATEWAY;
278 return HTTP_BAD_REQUEST;
281 apr_brigade_cleanup(bb);
285 #define MAX_MEM_SPOOL 16384
287 static int stream_reqbody_chunked(apr_pool_t *p,
289 proxy_conn_rec *p_conn,
291 apr_bucket_brigade *header_brigade,
292 apr_bucket_brigade *input_brigade)
294 int seen_eos = 0, rv = OK;
298 apr_bucket_alloc_t *bucket_alloc = r->connection->bucket_alloc;
299 apr_bucket_brigade *bb;
302 add_te_chunked(p, bucket_alloc, header_brigade);
303 terminate_headers(bucket_alloc, header_brigade);
305 while (!APR_BUCKET_IS_EOS(APR_BRIGADE_FIRST(input_brigade)))
307 char chunk_hdr[20]; /* must be here due to transient bucket. */
309 /* If this brigade contains EOS, either stop or remove it. */
310 if (APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(input_brigade))) {
313 /* We can't pass this EOS to the output_filters. */
314 e = APR_BRIGADE_LAST(input_brigade);
315 apr_bucket_delete(e);
318 apr_brigade_length(input_brigade, 1, &bytes);
320 hdr_len = apr_snprintf(chunk_hdr, sizeof(chunk_hdr),
321 "%" APR_UINT64_T_HEX_FMT CRLF,
322 (apr_uint64_t)bytes);
324 ap_xlate_proto_to_ascii(chunk_hdr, hdr_len);
325 e = apr_bucket_transient_create(chunk_hdr, hdr_len,
327 APR_BRIGADE_INSERT_HEAD(input_brigade, e);
330 * Append the end-of-chunk CRLF
332 e = apr_bucket_immortal_create(ASCII_CRLF, 2, bucket_alloc);
333 APR_BRIGADE_INSERT_TAIL(input_brigade, e);
335 if (header_brigade) {
336 /* we never sent the header brigade, so go ahead and
337 * take care of that now
342 * Save input_brigade in bb brigade. (At least) in the SSL case
343 * input_brigade contains transient buckets whose data would get
344 * overwritten during the next call of ap_get_brigade in the loop.
345 * ap_save_brigade ensures these buckets to be set aside.
346 * Calling ap_save_brigade with NULL as filter is OK, because
347 * bb brigade already has been created and does not need to get
348 * created by ap_save_brigade.
350 status = ap_save_brigade(NULL, &bb, &input_brigade, p);
351 if (status != APR_SUCCESS) {
352 return HTTP_INTERNAL_SERVER_ERROR;
355 header_brigade = NULL;
361 /* The request is flushed below this loop with chunk EOS header */
362 rv = pass_brigade(bucket_alloc, r, p_conn, origin, bb, 0);
371 status = ap_get_brigade(r->input_filters, input_brigade,
372 AP_MODE_READBYTES, APR_BLOCK_READ,
375 if (status != APR_SUCCESS) {
376 return HTTP_BAD_REQUEST;
380 if (header_brigade) {
381 /* we never sent the header brigade because there was no request body;
387 if (!APR_BRIGADE_EMPTY(input_brigade)) {
388 /* input brigade still has an EOS which we can't pass to the output_filters. */
389 e = APR_BRIGADE_LAST(input_brigade);
390 AP_DEBUG_ASSERT(APR_BUCKET_IS_EOS(e));
391 apr_bucket_delete(e);
396 e = apr_bucket_immortal_create(ASCII_ZERO ASCII_CRLF
400 APR_BRIGADE_INSERT_TAIL(bb, e);
402 if (apr_table_get(r->subprocess_env, "proxy-sendextracrlf")) {
403 e = apr_bucket_immortal_create(ASCII_CRLF, 2, bucket_alloc);
404 APR_BRIGADE_INSERT_TAIL(bb, e);
407 /* Now we have headers-only, or the chunk EOS mark; flush it */
408 rv = pass_brigade(bucket_alloc, r, p_conn, origin, bb, 1);
412 static int stream_reqbody_cl(apr_pool_t *p,
414 proxy_conn_rec *p_conn,
416 apr_bucket_brigade *header_brigade,
417 apr_bucket_brigade *input_brigade,
418 const char *old_cl_val)
420 int seen_eos = 0, rv = 0;
421 apr_status_t status = APR_SUCCESS;
422 apr_bucket_alloc_t *bucket_alloc = r->connection->bucket_alloc;
423 apr_bucket_brigade *bb;
425 apr_off_t cl_val = 0;
427 apr_off_t bytes_streamed = 0;
432 add_cl(p, bucket_alloc, header_brigade, old_cl_val);
433 status = apr_strtoff(&cl_val, old_cl_val, &endstr, 10);
435 if (status || *endstr || endstr == old_cl_val || cl_val < 0) {
436 ap_log_rerror(APLOG_MARK, APLOG_ERR, status, r,
437 "proxy: could not parse request Content-Length (%s)",
439 return HTTP_BAD_REQUEST;
442 terminate_headers(bucket_alloc, header_brigade);
444 while (!APR_BUCKET_IS_EOS(APR_BRIGADE_FIRST(input_brigade)))
446 apr_brigade_length(input_brigade, 1, &bytes);
447 bytes_streamed += bytes;
449 /* If this brigade contains EOS, either stop or remove it. */
450 if (APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(input_brigade))) {
453 /* We can't pass this EOS to the output_filters. */
454 e = APR_BRIGADE_LAST(input_brigade);
455 apr_bucket_delete(e);
457 if (apr_table_get(r->subprocess_env, "proxy-sendextracrlf")) {
458 e = apr_bucket_immortal_create(ASCII_CRLF, 2, bucket_alloc);
459 APR_BRIGADE_INSERT_TAIL(input_brigade, e);
463 /* C-L < bytes streamed?!?
464 * We will error out after the body is completely
465 * consumed, but we can't stream more bytes at the
466 * back end since they would in part be interpreted
467 * as another request! If nothing is sent, then
470 * Prevents HTTP Response Splitting.
472 if (bytes_streamed > cl_val) {
473 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
474 "proxy: read more bytes of request body than expected "
475 "(got %" APR_OFF_T_FMT ", expected %" APR_OFF_T_FMT ")",
476 bytes_streamed, cl_val);
477 return HTTP_INTERNAL_SERVER_ERROR;
480 if (header_brigade) {
481 /* we never sent the header brigade, so go ahead and
482 * take care of that now
487 * Save input_brigade in bb brigade. (At least) in the SSL case
488 * input_brigade contains transient buckets whose data would get
489 * overwritten during the next call of ap_get_brigade in the loop.
490 * ap_save_brigade ensures these buckets to be set aside.
491 * Calling ap_save_brigade with NULL as filter is OK, because
492 * bb brigade already has been created and does not need to get
493 * created by ap_save_brigade.
495 status = ap_save_brigade(NULL, &bb, &input_brigade, p);
496 if (status != APR_SUCCESS) {
497 return HTTP_INTERNAL_SERVER_ERROR;
500 header_brigade = NULL;
506 /* Once we hit EOS, we are ready to flush. */
507 rv = pass_brigade(bucket_alloc, r, p_conn, origin, bb, seen_eos);
516 status = ap_get_brigade(r->input_filters, input_brigade,
517 AP_MODE_READBYTES, APR_BLOCK_READ,
520 if (status != APR_SUCCESS) {
521 return HTTP_BAD_REQUEST;
525 if (bytes_streamed != cl_val) {
526 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
527 "proxy: client %s given Content-Length did not match"
528 " number of body bytes read", r->connection->remote_ip);
529 return HTTP_BAD_REQUEST;
532 if (header_brigade) {
533 /* we never sent the header brigade since there was no request
534 * body; send it now with the flush flag
537 return(pass_brigade(bucket_alloc, r, p_conn, origin, bb, 1));
543 static int spool_reqbody_cl(apr_pool_t *p,
545 proxy_conn_rec *p_conn,
547 apr_bucket_brigade *header_brigade,
548 apr_bucket_brigade *input_brigade,
553 apr_bucket_alloc_t *bucket_alloc = r->connection->bucket_alloc;
554 apr_bucket_brigade *body_brigade;
556 apr_off_t bytes, bytes_spooled = 0, fsize = 0;
557 apr_file_t *tmpfile = NULL;
559 body_brigade = apr_brigade_create(p, bucket_alloc);
561 while (!APR_BUCKET_IS_EOS(APR_BRIGADE_FIRST(input_brigade)))
563 /* If this brigade contains EOS, either stop or remove it. */
564 if (APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(input_brigade))) {
567 /* We can't pass this EOS to the output_filters. */
568 e = APR_BRIGADE_LAST(input_brigade);
569 apr_bucket_delete(e);
572 apr_brigade_length(input_brigade, 1, &bytes);
574 if (bytes_spooled + bytes > MAX_MEM_SPOOL) {
575 /* can't spool any more in memory; write latest brigade to disk */
576 if (tmpfile == NULL) {
577 const char *temp_dir;
580 status = apr_temp_dir_get(&temp_dir, p);
581 if (status != APR_SUCCESS) {
582 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
583 "proxy: search for temporary directory failed");
584 return HTTP_INTERNAL_SERVER_ERROR;
586 apr_filepath_merge(&template, temp_dir,
587 "modproxy.tmp.XXXXXX",
588 APR_FILEPATH_NATIVE, p);
589 status = apr_file_mktemp(&tmpfile, template, 0, p);
590 if (status != APR_SUCCESS) {
591 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
592 "proxy: creation of temporary file in directory %s failed",
594 return HTTP_INTERNAL_SERVER_ERROR;
597 for (e = APR_BRIGADE_FIRST(input_brigade);
598 e != APR_BRIGADE_SENTINEL(input_brigade);
599 e = APR_BUCKET_NEXT(e)) {
601 apr_size_t bytes_read, bytes_written;
603 apr_bucket_read(e, &data, &bytes_read, APR_BLOCK_READ);
604 status = apr_file_write_full(tmpfile, data, bytes_read, &bytes_written);
605 if (status != APR_SUCCESS) {
606 const char *tmpfile_name;
608 if (apr_file_name_get(&tmpfile_name, tmpfile) != APR_SUCCESS) {
609 tmpfile_name = "(unknown)";
611 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
612 "proxy: write to temporary file %s failed",
614 return HTTP_INTERNAL_SERVER_ERROR;
616 AP_DEBUG_ASSERT(bytes_read == bytes_written);
617 fsize += bytes_written;
619 apr_brigade_cleanup(input_brigade);
624 * Save input_brigade in body_brigade. (At least) in the SSL case
625 * input_brigade contains transient buckets whose data would get
626 * overwritten during the next call of ap_get_brigade in the loop.
627 * ap_save_brigade ensures these buckets to be set aside.
628 * Calling ap_save_brigade with NULL as filter is OK, because
629 * body_brigade already has been created and does not need to get
630 * created by ap_save_brigade.
632 status = ap_save_brigade(NULL, &body_brigade, &input_brigade, p);
633 if (status != APR_SUCCESS) {
634 return HTTP_INTERNAL_SERVER_ERROR;
639 bytes_spooled += bytes;
645 status = ap_get_brigade(r->input_filters, input_brigade,
646 AP_MODE_READBYTES, APR_BLOCK_READ,
649 if (status != APR_SUCCESS) {
650 return HTTP_BAD_REQUEST;
654 if (bytes_spooled || force_cl) {
655 add_cl(p, bucket_alloc, header_brigade, apr_off_t_toa(p, bytes_spooled));
657 terminate_headers(bucket_alloc, header_brigade);
658 APR_BRIGADE_CONCAT(header_brigade, body_brigade);
660 apr_brigade_insert_file(header_brigade, tmpfile, 0, fsize, p);
662 if (apr_table_get(r->subprocess_env, "proxy-sendextracrlf")) {
663 e = apr_bucket_immortal_create(ASCII_CRLF, 2, bucket_alloc);
664 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
666 /* This is all a single brigade, pass with flush flagged */
667 return(pass_brigade(bucket_alloc, r, p_conn, origin, header_brigade, 1));
671 int ap_proxy_http_request(apr_pool_t *p, request_rec *r,
672 proxy_conn_rec *p_conn, conn_rec *origin,
673 proxy_server_conf *conf,
675 char *url, char *server_portstr)
677 conn_rec *c = r->connection;
678 apr_bucket_alloc_t *bucket_alloc = c->bucket_alloc;
679 apr_bucket_brigade *header_brigade;
680 apr_bucket_brigade *input_brigade;
681 apr_bucket_brigade *temp_brigade;
684 const apr_array_header_t *headers_in_array;
685 const apr_table_entry_t *headers_in;
688 enum rb_methods {RB_INIT, RB_STREAM_CL, RB_STREAM_CHUNKED, RB_SPOOL_CL};
689 enum rb_methods rb_method = RB_INIT;
690 const char *old_cl_val = NULL;
691 const char *old_te_val = NULL;
692 apr_off_t bytes_read = 0;
695 apr_table_t *headers_in_copy;
696 proxy_dir_conf *dconf;
698 dconf = ap_get_module_config(r->per_dir_config, &proxy_module);
699 header_brigade = apr_brigade_create(p, origin->bucket_alloc);
702 * Send the HTTP/1.1 request to the remote server
705 if (apr_table_get(r->subprocess_env, "force-proxy-request-1.0")) {
707 * According to RFC 2616 8.2.3 we are not allowed to forward an
708 * Expect: 100-continue to an HTTP/1.0 server. Instead we MUST return
709 * a HTTP_EXPECTATION_FAILED
711 if (r->expecting_100) {
712 return HTTP_EXPECTATION_FAILED;
714 buf = apr_pstrcat(p, r->method, " ", url, " HTTP/1.0" CRLF, NULL);
718 buf = apr_pstrcat(p, r->method, " ", url, " HTTP/1.1" CRLF, NULL);
721 if (apr_table_get(r->subprocess_env, "proxy-nokeepalive")) {
722 origin->keepalive = AP_CONN_CLOSE;
725 ap_xlate_proto_to_ascii(buf, strlen(buf));
726 e = apr_bucket_pool_create(buf, strlen(buf), p, c->bucket_alloc);
727 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
728 if (dconf->preserve_host == 0) {
729 if (ap_strchr_c(uri->hostname, ':')) { /* if literal IPv6 address */
730 if (uri->port_str && uri->port != DEFAULT_HTTP_PORT) {
731 buf = apr_pstrcat(p, "Host: [", uri->hostname, "]:",
732 uri->port_str, CRLF, NULL);
734 buf = apr_pstrcat(p, "Host: [", uri->hostname, "]", CRLF, NULL);
737 if (uri->port_str && uri->port != DEFAULT_HTTP_PORT) {
738 buf = apr_pstrcat(p, "Host: ", uri->hostname, ":",
739 uri->port_str, CRLF, NULL);
741 buf = apr_pstrcat(p, "Host: ", uri->hostname, CRLF, NULL);
746 /* don't want to use r->hostname, as the incoming header might have a
749 const char* hostname = apr_table_get(r->headers_in,"Host");
751 hostname = r->server->server_hostname;
752 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
753 "proxy: no HTTP 0.9 request (with no host line) "
754 "on incoming request and preserve host set "
755 "forcing hostname to be %s for uri %s",
759 buf = apr_pstrcat(p, "Host: ", hostname, CRLF, NULL);
761 ap_xlate_proto_to_ascii(buf, strlen(buf));
762 e = apr_bucket_pool_create(buf, strlen(buf), p, c->bucket_alloc);
763 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
766 if (conf->viaopt == via_block) {
767 /* Block all outgoing Via: headers */
768 apr_table_unset(r->headers_in, "Via");
769 } else if (conf->viaopt != via_off) {
770 const char *server_name = ap_get_server_name(r);
771 /* If USE_CANONICAL_NAME_OFF was configured for the proxy virtual host,
772 * then the server name returned by ap_get_server_name() is the
773 * origin server name (which does make too much sense with Via: headers)
774 * so we use the proxy vhost's name instead.
776 if (server_name == r->hostname)
777 server_name = r->server->server_hostname;
778 /* Create a "Via:" request header entry and merge it */
779 /* Generate outgoing Via: header with/without server comment: */
780 apr_table_mergen(r->headers_in, "Via",
781 (conf->viaopt == via_full)
782 ? apr_psprintf(p, "%d.%d %s%s (%s)",
783 HTTP_VERSION_MAJOR(r->proto_num),
784 HTTP_VERSION_MINOR(r->proto_num),
785 server_name, server_portstr,
786 AP_SERVER_BASEVERSION)
787 : apr_psprintf(p, "%d.%d %s%s",
788 HTTP_VERSION_MAJOR(r->proto_num),
789 HTTP_VERSION_MINOR(r->proto_num),
790 server_name, server_portstr)
794 /* X-Forwarded-*: handling
799 * These request headers are only really useful when the mod_proxy
800 * is used in a reverse proxy configuration, so that useful info
801 * about the client can be passed through the reverse proxy and on
802 * to the backend server, which may require the information to
805 * In a forward proxy situation, these options are a potential
806 * privacy violation, as information about clients behind the proxy
807 * are revealed to arbitrary servers out there on the internet.
809 * The HTTP/1.1 Via: header is designed for passing client
810 * information through proxies to a server, and should be used in
811 * a forward proxy configuation instead of X-Forwarded-*. See the
812 * ProxyVia option for details.
815 if (PROXYREQ_REVERSE == r->proxyreq) {
818 /* Add X-Forwarded-For: so that the upstream has a chance to
819 * determine, where the original request came from.
821 apr_table_mergen(r->headers_in, "X-Forwarded-For",
824 /* Add X-Forwarded-Host: so that upstream knows what the
825 * original request hostname was.
827 if ((buf = apr_table_get(r->headers_in, "Host"))) {
828 apr_table_mergen(r->headers_in, "X-Forwarded-Host", buf);
831 /* Add X-Forwarded-Server: so that upstream knows what the
832 * name of this proxy server is (if there are more than one)
833 * XXX: This duplicates Via: - do we strictly need it?
835 apr_table_mergen(r->headers_in, "X-Forwarded-Server",
836 r->server->server_hostname);
841 * Make a copy of the headers_in table before clearing the connection
842 * headers as we need the connection headers later in the http output
843 * filter to prepare the correct response headers.
845 * Note: We need to take r->pool for apr_table_copy as the key / value
846 * pairs in r->headers_in have been created out of r->pool and
847 * p might be (and actually is) a longer living pool.
848 * This would trigger the bad pool ancestry abort in apr_table_copy if
849 * apr is compiled with APR_POOL_DEBUG.
851 headers_in_copy = apr_table_copy(r->pool, r->headers_in);
852 ap_proxy_clear_connection(p, headers_in_copy);
853 /* send request headers */
854 headers_in_array = apr_table_elts(headers_in_copy);
855 headers_in = (const apr_table_entry_t *) headers_in_array->elts;
856 for (counter = 0; counter < headers_in_array->nelts; counter++) {
857 if (headers_in[counter].key == NULL
858 || headers_in[counter].val == NULL
861 || !strcasecmp(headers_in[counter].key, "Host")
863 /* Clear out hop-by-hop request headers not to send
864 * RFC2616 13.5.1 says we should strip these headers
866 || !strcasecmp(headers_in[counter].key, "Keep-Alive")
867 || !strcasecmp(headers_in[counter].key, "TE")
868 || !strcasecmp(headers_in[counter].key, "Trailer")
869 || !strcasecmp(headers_in[counter].key, "Upgrade")
874 /* Do we want to strip Proxy-Authorization ?
875 * If we haven't used it, then NO
876 * If we have used it then MAYBE: RFC2616 says we MAY propagate it.
877 * So let's make it configurable by env.
879 if (!strcasecmp(headers_in[counter].key,"Proxy-Authorization")) {
880 if (r->user != NULL) { /* we've authenticated */
881 if (!apr_table_get(r->subprocess_env, "Proxy-Chain-Auth")) {
888 /* Skip Transfer-Encoding and Content-Length for now.
890 if (!strcasecmp(headers_in[counter].key, "Transfer-Encoding")) {
891 old_te_val = headers_in[counter].val;
894 if (!strcasecmp(headers_in[counter].key, "Content-Length")) {
895 old_cl_val = headers_in[counter].val;
899 /* for sub-requests, ignore freshness/expiry headers */
901 if ( !strcasecmp(headers_in[counter].key, "If-Match")
902 || !strcasecmp(headers_in[counter].key, "If-Modified-Since")
903 || !strcasecmp(headers_in[counter].key, "If-Range")
904 || !strcasecmp(headers_in[counter].key, "If-Unmodified-Since")
905 || !strcasecmp(headers_in[counter].key, "If-None-Match")) {
910 buf = apr_pstrcat(p, headers_in[counter].key, ": ",
911 headers_in[counter].val, CRLF,
913 ap_xlate_proto_to_ascii(buf, strlen(buf));
914 e = apr_bucket_pool_create(buf, strlen(buf), p, c->bucket_alloc);
915 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
918 /* We have headers, let's figure out our request body... */
919 input_brigade = apr_brigade_create(p, bucket_alloc);
921 /* sub-requests never use keepalives, and mustn't pass request bodies.
922 * Because the new logic looks at input_brigade, we will self-terminate
923 * input_brigade and jump past all of the request body logic...
924 * Reading anything with ap_get_brigade is likely to consume the
925 * main request's body or read beyond EOS - which would be unplesant.
927 * An exception: when a kept_body is present, then subrequest CAN use
928 * pass request bodies, and we DONT skip the body.
930 if (!r->kept_body && r->main) {
931 /* XXX: Why DON'T sub-requests use keepalives? */
935 apr_table_unset(r->headers_in, "Content-Length");
939 apr_table_unset(r->headers_in, "Transfer-Encoding");
941 rb_method = RB_STREAM_CL;
942 e = apr_bucket_eos_create(input_brigade->bucket_alloc);
943 APR_BRIGADE_INSERT_TAIL(input_brigade, e);
947 /* WE only understand chunked. Other modules might inject
948 * (and therefore, decode) other flavors but we don't know
949 * that the can and have done so unless they they remove
950 * their decoding from the headers_in T-E list.
951 * XXX: Make this extensible, but in doing so, presume the
952 * encoding has been done by the extensions' handler, and
953 * do not modify add_te_chunked's logic
955 if (old_te_val && strcasecmp(old_te_val, "chunked") != 0) {
956 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
957 "proxy: %s Transfer-Encoding is not supported",
959 return HTTP_INTERNAL_SERVER_ERROR;
962 if (old_cl_val && old_te_val) {
963 ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_ENOTIMPL, r->server,
964 "proxy: client %s (%s) requested Transfer-Encoding "
965 "chunked body with Content-Length (C-L ignored)",
966 c->remote_ip, c->remote_host ? c->remote_host: "");
967 apr_table_unset(r->headers_in, "Content-Length");
969 origin->keepalive = AP_CONN_CLOSE;
973 /* Prefetch MAX_MEM_SPOOL bytes
975 * This helps us avoid any election of C-L v.s. T-E
976 * request bodies, since we are willing to keep in
977 * memory this much data, in any case. This gives
978 * us an instant C-L election if the body is of some
981 temp_brigade = apr_brigade_create(p, bucket_alloc);
983 status = ap_get_brigade(r->input_filters, temp_brigade,
984 AP_MODE_READBYTES, APR_BLOCK_READ,
985 MAX_MEM_SPOOL - bytes_read);
986 if (status != APR_SUCCESS) {
987 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
988 "proxy: prefetch request body failed to %pI (%s)"
990 p_conn->addr, p_conn->hostname ? p_conn->hostname: "",
991 c->remote_ip, c->remote_host ? c->remote_host: "");
992 return HTTP_BAD_REQUEST;
995 apr_brigade_length(temp_brigade, 1, &bytes);
999 * Save temp_brigade in input_brigade. (At least) in the SSL case
1000 * temp_brigade contains transient buckets whose data would get
1001 * overwritten during the next call of ap_get_brigade in the loop.
1002 * ap_save_brigade ensures these buckets to be set aside.
1003 * Calling ap_save_brigade with NULL as filter is OK, because
1004 * input_brigade already has been created and does not need to get
1005 * created by ap_save_brigade.
1007 status = ap_save_brigade(NULL, &input_brigade, &temp_brigade, p);
1008 if (status != APR_SUCCESS) {
1009 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
1010 "proxy: processing prefetched request body failed"
1011 " to %pI (%s) from %s (%s)",
1012 p_conn->addr, p_conn->hostname ? p_conn->hostname: "",
1013 c->remote_ip, c->remote_host ? c->remote_host: "");
1014 return HTTP_INTERNAL_SERVER_ERROR;
1017 /* Ensure we don't hit a wall where we have a buffer too small
1018 * for ap_get_brigade's filters to fetch us another bucket,
1019 * surrender once we hit 80 bytes less than MAX_MEM_SPOOL
1020 * (an arbitrary value.)
1022 } while ((bytes_read < MAX_MEM_SPOOL - 80)
1023 && !APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(input_brigade)));
1025 /* Use chunked request body encoding or send a content-length body?
1029 * We have no request body (handled by RB_STREAM_CL)
1031 * We have a request body length <= MAX_MEM_SPOOL
1033 * The administrator has setenv force-proxy-request-1.0
1035 * The client sent a C-L body, and the administrator has
1036 * not setenv proxy-sendchunked or has set setenv proxy-sendcl
1038 * The client sent a T-E body, and the administrator has
1039 * setenv proxy-sendcl, and not setenv proxy-sendchunked
1041 * If both proxy-sendcl and proxy-sendchunked are set, the
1042 * behavior is the same as if neither were set, large bodies
1043 * that can't be read will be forwarded in their original
1044 * form of C-L, or T-E.
1046 * To ensure maximum compatibility, setenv proxy-sendcl
1047 * To reduce server resource use, setenv proxy-sendchunked
1049 * Then address specific servers with conditional setenv
1050 * options to restore the default behavior where desireable.
1052 * We have to compute content length by reading the entire request
1053 * body; if request body is not small, we'll spool the remaining
1054 * input to a temporary file. Chunked is always preferable.
1056 * We can only trust the client-provided C-L if the T-E header
1057 * is absent, and the filters are unchanged (the body won't
1058 * be resized by another content filter).
1060 if (APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(input_brigade))) {
1061 /* The whole thing fit, so our decision is trivial, use
1062 * the filtered bytes read from the client for the request
1063 * body Content-Length.
1065 * If we expected no body, and read no body, do not set
1066 * the Content-Length.
1068 if (old_cl_val || old_te_val || bytes_read) {
1069 old_cl_val = apr_off_t_toa(r->pool, bytes_read);
1071 rb_method = RB_STREAM_CL;
1073 else if (old_te_val) {
1075 || (apr_table_get(r->subprocess_env, "proxy-sendcl")
1076 && !apr_table_get(r->subprocess_env, "proxy-sendchunks")
1077 && !apr_table_get(r->subprocess_env, "proxy-sendchunked"))) {
1078 rb_method = RB_SPOOL_CL;
1081 rb_method = RB_STREAM_CHUNKED;
1084 else if (old_cl_val) {
1085 if (r->input_filters == r->proto_input_filters) {
1086 rb_method = RB_STREAM_CL;
1089 && (apr_table_get(r->subprocess_env, "proxy-sendchunks")
1090 || apr_table_get(r->subprocess_env, "proxy-sendchunked"))
1091 && !apr_table_get(r->subprocess_env, "proxy-sendcl")) {
1092 rb_method = RB_STREAM_CHUNKED;
1095 rb_method = RB_SPOOL_CL;
1099 /* This is an appropriate default; very efficient for no-body
1100 * requests, and has the behavior that it will not add any C-L
1101 * when the old_cl_val is NULL.
1103 rb_method = RB_SPOOL_CL;
1106 /* Yes I hate gotos. This is the subrequest shortcut */
1109 * Handle Connection: header if we do HTTP/1.1 request:
1110 * If we plan to close the backend connection sent Connection: close
1111 * otherwise sent Connection: Keep-Alive.
1114 if (p_conn->close) {
1115 buf = apr_pstrdup(p, "Connection: close" CRLF);
1118 buf = apr_pstrdup(p, "Connection: Keep-Alive" CRLF);
1120 ap_xlate_proto_to_ascii(buf, strlen(buf));
1121 e = apr_bucket_pool_create(buf, strlen(buf), p, c->bucket_alloc);
1122 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
1125 /* send the request body, if any. */
1127 case RB_STREAM_CHUNKED:
1128 rv = stream_reqbody_chunked(p, r, p_conn, origin, header_brigade,
1132 rv = stream_reqbody_cl(p, r, p_conn, origin, header_brigade,
1133 input_brigade, old_cl_val);
1136 rv = spool_reqbody_cl(p, r, p_conn, origin, header_brigade,
1137 input_brigade, (old_cl_val != NULL)
1138 || (old_te_val != NULL)
1139 || (bytes_read > 0));
1142 /* shouldn't be possible */
1143 rv = HTTP_INTERNAL_SERVER_ERROR ;
1148 /* apr_status_t value has been logged in lower level method */
1149 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
1150 "proxy: pass request body failed to %pI (%s)"
1153 p_conn->hostname ? p_conn->hostname: "",
1155 c->remote_host ? c->remote_host: "");
1162 static void process_proxy_header(request_rec *r, proxy_dir_conf *c,
1163 const char *key, const char *value)
1165 static const char *date_hdrs[]
1166 = { "Date", "Expires", "Last-Modified", NULL };
1167 static const struct {
1169 ap_proxy_header_reverse_map_fn func;
1170 } transform_hdrs[] = {
1171 { "Location", ap_proxy_location_reverse_map },
1172 { "Content-Location", ap_proxy_location_reverse_map },
1173 { "URI", ap_proxy_location_reverse_map },
1174 { "Destination", ap_proxy_location_reverse_map },
1175 { "Set-Cookie", ap_proxy_cookie_reverse_map },
1179 for (i = 0; date_hdrs[i]; ++i) {
1180 if (!strcasecmp(date_hdrs[i], key)) {
1181 apr_table_add(r->headers_out, key,
1182 ap_proxy_date_canon(r->pool, value));
1186 for (i = 0; transform_hdrs[i].name; ++i) {
1187 if (!strcasecmp(transform_hdrs[i].name, key)) {
1188 apr_table_add(r->headers_out, key,
1189 (*transform_hdrs[i].func)(r, c, value));
1193 apr_table_add(r->headers_out, key, value);
1198 * Note: pread_len is the length of the response that we've mistakenly
1199 * read (assuming that we don't consider that an error via
1200 * ProxyBadHeader StartBody). This depends on buffer actually being
1201 * local storage to the calling code in order for pread_len to make
1202 * any sense at all, since we depend on buffer still containing
1203 * what was read by ap_getline() upon return.
1205 static void ap_proxy_read_headers(request_rec *r, request_rec *rr,
1206 char *buffer, int size,
1207 conn_rec *c, int *pread_len)
1211 char field[MAX_STRING_LEN];
1212 int saw_headers = 0;
1213 void *sconf = r->server->module_config;
1214 proxy_server_conf *psc;
1215 proxy_dir_conf *dconf;
1217 dconf = ap_get_module_config(r->per_dir_config, &proxy_module);
1218 psc = (proxy_server_conf *) ap_get_module_config(sconf, &proxy_module);
1220 r->headers_out = apr_table_make(r->pool, 20);
1224 * Read header lines until we get the empty separator line, a read error,
1225 * the connection closes (EOF), or we timeout.
1227 ap_log_rerror(APLOG_MARK, APLOG_TRACE4, 0, r,
1228 "Headers received from backend:");
1229 while ((len = ap_getline(buffer, size, rr, 1)) > 0) {
1230 ap_log_rerror(APLOG_MARK, APLOG_TRACE4, 0, r, "%s", buffer);
1232 if (!(value = strchr(buffer, ':'))) { /* Find the colon separator */
1234 /* We may encounter invalid headers, usually from buggy
1235 * MS IIS servers, so we need to determine just how to handle
1236 * them. We can either ignore them, assume that they mark the
1237 * start-of-body (eg: a missing CRLF) or (the default) mark
1238 * the headers as totally bogus and return a 500. The sole
1239 * exception is an extra "HTTP/1.0 200, OK" line sprinkled
1240 * in between the usual MIME headers, which is a favorite
1243 /* XXX: The mask check is buggy if we ever see an HTTP/1.10 */
1245 if (!apr_date_checkmask(buffer, "HTTP/#.# ###*")) {
1246 if (psc->badopt == bad_error) {
1247 /* Nope, it wasn't even an extra HTTP header. Give up. */
1248 r->headers_out = NULL;
1251 else if (psc->badopt == bad_body) {
1252 /* if we've already started loading headers_out, then
1253 * return what we've accumulated so far, in the hopes
1254 * that they are useful; also note that we likely pre-read
1255 * the first line of the response.
1258 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, r->server,
1259 "proxy: Starting body due to bogus non-header in headers "
1260 "returned by %s (%s)", r->uri, r->method);
1264 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, r->server,
1265 "proxy: No HTTP headers "
1266 "returned by %s (%s)", r->uri, r->method);
1271 /* this is the psc->badopt == bad_ignore case */
1272 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, r->server,
1273 "proxy: Ignoring bogus HTTP header "
1274 "returned by %s (%s)", r->uri, r->method);
1280 /* XXX: RFC2068 defines only SP and HT as whitespace, this test is
1281 * wrong... and so are many others probably.
1283 while (apr_isspace(*value))
1284 ++value; /* Skip to start of value */
1286 /* should strip trailing whitespace as well */
1287 for (end = &value[strlen(value)-1]; end > value && apr_isspace(*end); --
1291 /* make sure we add so as not to destroy duplicated headers
1292 * Modify headers requiring canonicalisation and/or affected
1293 * by ProxyPassReverse and family with process_proxy_header
1295 process_proxy_header(r, dconf, buffer, value) ;
1298 /* the header was too long; at the least we should skip extra data */
1299 if (len >= size - 1) {
1300 while ((len = ap_getline(field, MAX_STRING_LEN, rr, 1))
1301 >= MAX_STRING_LEN - 1) {
1302 /* soak up the extra data */
1304 if (len == 0) /* time to exit the larger loop as well */
1312 static int addit_dammit(void *v, const char *key, const char *val)
1314 apr_table_addn(v, key, val);
1319 apr_status_t ap_proxygetline(apr_bucket_brigade *bb, char *s, int n, request_rec *r,
1320 int fold, int *writen)
1326 rv = ap_rgetline(&tmp_s, n, &len, r, fold, bb);
1327 apr_brigade_cleanup(bb);
1329 if (rv == APR_SUCCESS) {
1330 *writen = (int) len;
1331 } else if (rv == APR_ENOSPC) {
1341 * Limit the number of interim respones we sent back to the client. Otherwise
1342 * we suffer from a memory build up. Besides there is NO sense in sending back
1343 * an unlimited number of interim responses to the client. Thus if we cross
1344 * this limit send back a 502 (Bad Gateway).
1346 #ifndef AP_MAX_INTERIM_RESPONSES
1347 #define AP_MAX_INTERIM_RESPONSES 10
1351 apr_status_t ap_proxy_http_process_response(apr_pool_t * p, request_rec *r,
1352 proxy_conn_rec *backend,
1354 proxy_server_conf *conf,
1355 char *server_portstr) {
1356 conn_rec *c = r->connection;
1357 char buffer[HUGE_STRING_LEN];
1362 apr_bucket_brigade *bb, *tmp_bb;
1363 apr_bucket_brigade *pass_bb;
1364 int len, backasswards;
1365 int interim_response = 0; /* non-zero whilst interim 1xx responses
1366 * are being read. */
1368 apr_table_t *save_table;
1369 int backend_broke = 0;
1370 static const char *hop_by_hop_hdrs[] =
1371 {"Keep-Alive", "Proxy-Authenticate", "TE", "Trailer", "Upgrade", NULL};
1373 const char *te = NULL;
1374 int original_status = r->status;
1375 int proxy_status = OK;
1376 const char *original_status_line = r->status_line;
1377 const char *proxy_status_line = NULL;
1379 bb = apr_brigade_create(p, c->bucket_alloc);
1380 pass_bb = apr_brigade_create(p, c->bucket_alloc);
1382 /* Get response from the remote server, and pass it up the
1386 rp = ap_proxy_make_fake_req(origin, r);
1387 /* In case anyone needs to know, this is a fake request that is really a
1390 rp->proxyreq = PROXYREQ_RESPONSE;
1391 tmp_bb = apr_brigade_create(p, c->bucket_alloc);
1395 apr_brigade_cleanup(bb);
1397 rc = ap_proxygetline(tmp_bb, buffer, sizeof(buffer), rp, 0, &len);
1399 /* handle one potential stray CRLF */
1400 rc = ap_proxygetline(tmp_bb, buffer, sizeof(buffer), rp, 0, &len);
1403 ap_log_rerror(APLOG_MARK, APLOG_ERR, rc, r,
1404 "proxy: error reading status line from remote "
1405 "server %s:%d", backend->hostname, backend->port);
1406 if (APR_STATUS_IS_TIMEUP(rc)) {
1407 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1408 "proxy: read timeout");
1411 * If we are a reverse proxy request shutdown the connection
1412 * WITHOUT ANY response to trigger a retry by the client
1413 * if allowed (as for idempotent requests).
1414 * BUT currently we should not do this if the request is the
1415 * first request on a keepalive connection as browsers like
1416 * seamonkey only display an empty page in this case and do
1417 * not do a retry. We should also not do this on a
1418 * connection which times out; instead handle as
1419 * we normally would handle timeouts
1421 if (r->proxyreq == PROXYREQ_REVERSE && c->keepalives &&
1422 !APR_STATUS_IS_TIMEUP(rc)) {
1425 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1426 "proxy: Closing connection to client because"
1427 " reading from backend server %s:%d failed."
1428 " Number of keepalives %i", backend->hostname,
1429 backend->port, c->keepalives);
1430 ap_proxy_backend_broke(r, bb);
1432 * Add an EOC bucket to signal the ap_http_header_filter
1433 * that it should get out of our way, BUT ensure that the
1434 * EOC bucket is inserted BEFORE an EOS bucket in bb as
1435 * some resource filters like mod_deflate pass everything
1436 * up to the EOS down the chain immediately and sent the
1437 * remainder of the brigade later (or even never). But in
1438 * this case the ap_http_header_filter does not get out of
1439 * our way soon enough.
1441 e = ap_bucket_eoc_create(c->bucket_alloc);
1442 eos = APR_BRIGADE_LAST(bb);
1443 while ((APR_BRIGADE_SENTINEL(bb) != eos)
1444 && !APR_BUCKET_IS_EOS(eos)) {
1445 eos = APR_BUCKET_PREV(eos);
1447 if (eos == APR_BRIGADE_SENTINEL(bb)) {
1448 APR_BRIGADE_INSERT_TAIL(bb, e);
1451 APR_BUCKET_INSERT_BEFORE(eos, e);
1453 ap_pass_brigade(r->output_filters, bb);
1454 /* Mark the backend connection for closing */
1456 /* Need to return OK to avoid sending an error message */
1459 else if (!c->keepalives) {
1460 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1461 "proxy: NOT Closing connection to client"
1462 " although reading from backend server %s:%d"
1463 " failed.", backend->hostname,
1466 return ap_proxyerror(r, HTTP_BAD_GATEWAY,
1467 "Error reading from remote server");
1469 /* XXX: Is this a real headers length send from remote? */
1470 backend->worker->s->read += len;
1472 /* Is it an HTTP/1 response?
1473 * This is buggy if we ever see an HTTP/1.10
1475 if (apr_date_checkmask(buffer, "HTTP/#.# ###*")) {
1478 if (2 != sscanf(buffer, "HTTP/%u.%u", &major, &minor)) {
1482 /* If not an HTTP/1 message or
1483 * if the status line was > 8192 bytes
1485 else if ((buffer[5] != '1') || (len >= sizeof(buffer)-1)) {
1486 return ap_proxyerror(r, HTTP_BAD_GATEWAY,
1487 apr_pstrcat(p, "Corrupt status line returned by remote "
1488 "server: ", buffer, NULL));
1492 keepchar = buffer[12];
1494 proxy_status = atoi(&buffer[9]);
1496 if (keepchar != '\0') {
1497 buffer[12] = keepchar;
1499 /* 2616 requires the space in Status-Line; the origin
1500 * server may have sent one but ap_rgetline_core will
1501 * have stripped it. */
1505 proxy_status_line = apr_pstrdup(p, &buffer[9]);
1507 /* The status out of the front is the same as the status coming in
1508 * from the back, until further notice.
1510 r->status = proxy_status;
1511 r->status_line = proxy_status_line;
1513 ap_log_rerror(APLOG_MARK, APLOG_TRACE3, 0, r,
1514 "Status from backend: %d", proxy_status);
1516 /* read the headers. */
1517 /* N.B. for HTTP/1.0 clients, we have to fold line-wrapped headers*/
1518 /* Also, take care with headers with multiple occurences. */
1520 /* First, tuck away all already existing cookies */
1521 save_table = apr_table_make(r->pool, 2);
1522 apr_table_do(addit_dammit, save_table, r->headers_out,
1523 "Set-Cookie", NULL);
1525 /* shove the headers direct into r->headers_out */
1526 ap_proxy_read_headers(r, rp, buffer, sizeof(buffer), origin,
1529 if (r->headers_out == NULL) {
1530 ap_log_error(APLOG_MARK, APLOG_WARNING, 0,
1531 r->server, "proxy: bad HTTP/%d.%d header "
1532 "returned by %s (%s)", major, minor, r->uri,
1534 backend->close += 1;
1536 * ap_send_error relies on a headers_out to be present. we
1537 * are in a bad position here.. so force everything we send out
1538 * to have nothing to do with the incoming packet
1540 r->headers_out = apr_table_make(r->pool,1);
1541 r->status = HTTP_BAD_GATEWAY;
1542 r->status_line = "bad gateway";
1546 /* Now, add in the just read cookies */
1547 apr_table_do(addit_dammit, save_table, r->headers_out,
1548 "Set-Cookie", NULL);
1550 /* and now load 'em all in */
1551 if (!apr_is_empty_table(save_table)) {
1552 apr_table_unset(r->headers_out, "Set-Cookie");
1553 r->headers_out = apr_table_overlay(r->pool,
1558 /* can't have both Content-Length and Transfer-Encoding */
1559 if (apr_table_get(r->headers_out, "Transfer-Encoding")
1560 && apr_table_get(r->headers_out, "Content-Length")) {
1562 * 2616 section 4.4, point 3: "if both Transfer-Encoding
1563 * and Content-Length are received, the latter MUST be
1566 * To help mitigate HTTP Splitting, unset Content-Length
1567 * and shut down the backend server connection
1568 * XXX: We aught to treat such a response as uncachable
1570 apr_table_unset(r->headers_out, "Content-Length");
1571 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
1572 "proxy: server %s:%d returned Transfer-Encoding"
1573 " and Content-Length", backend->hostname,
1575 backend->close += 1;
1579 * Save a possible Transfer-Encoding header as we need it later for
1580 * ap_http_filter to know where to end.
1582 te = apr_table_get(r->headers_out, "Transfer-Encoding");
1583 /* strip connection listed hop-by-hop headers from response */
1584 backend->close += ap_proxy_liststr(apr_table_get(r->headers_out,
1587 ap_proxy_clear_connection(p, r->headers_out);
1588 if ((buf = apr_table_get(r->headers_out, "Content-Type"))) {
1589 ap_set_content_type(r, apr_pstrdup(p, buf));
1591 if (!ap_is_HTTP_INFO(proxy_status)) {
1592 ap_proxy_pre_http_request(origin, rp);
1595 /* Clear hop-by-hop headers */
1596 for (i=0; hop_by_hop_hdrs[i]; ++i) {
1597 apr_table_unset(r->headers_out, hop_by_hop_hdrs[i]);
1599 /* Delete warnings with wrong date */
1600 r->headers_out = ap_proxy_clean_warnings(p, r->headers_out);
1602 /* handle Via header in response */
1603 if (conf->viaopt != via_off && conf->viaopt != via_block) {
1604 const char *server_name = ap_get_server_name(r);
1605 /* If USE_CANONICAL_NAME_OFF was configured for the proxy virtual host,
1606 * then the server name returned by ap_get_server_name() is the
1607 * origin server name (which does make too much sense with Via: headers)
1608 * so we use the proxy vhost's name instead.
1610 if (server_name == r->hostname)
1611 server_name = r->server->server_hostname;
1612 /* create a "Via:" response header entry and merge it */
1613 apr_table_addn(r->headers_out, "Via",
1614 (conf->viaopt == via_full)
1615 ? apr_psprintf(p, "%d.%d %s%s (%s)",
1616 HTTP_VERSION_MAJOR(r->proto_num),
1617 HTTP_VERSION_MINOR(r->proto_num),
1620 AP_SERVER_BASEVERSION)
1621 : apr_psprintf(p, "%d.%d %s%s",
1622 HTTP_VERSION_MAJOR(r->proto_num),
1623 HTTP_VERSION_MINOR(r->proto_num),
1629 /* cancel keepalive if HTTP/1.0 or less */
1630 if ((major < 1) || (minor < 1)) {
1631 backend->close += 1;
1632 origin->keepalive = AP_CONN_CLOSE;
1635 /* an http/0.9 response */
1638 r->status_line = "200 OK";
1639 backend->close += 1;
1642 if (ap_is_HTTP_INFO(proxy_status)) {
1646 interim_response = 0;
1648 if (interim_response) {
1649 /* RFC2616 tells us to forward this.
1651 * OTOH, an interim response here may mean the backend
1652 * is playing sillybuggers. The Client didn't ask for
1653 * it within the defined HTTP/1.1 mechanisms, and if
1654 * it's an extension, it may also be unsupported by us.
1656 * There's also the possibility that changing existing
1657 * behaviour here might break something.
1659 * So let's make it configurable.
1661 const char *policy = apr_table_get(r->subprocess_env,
1662 "proxy-interim-response");
1663 ap_log_rerror(APLOG_MARK, APLOG_TRACE2, 0, r,
1664 "proxy: HTTP: received interim %d response",
1666 if (!policy || !strcasecmp(policy, "RFC")) {
1667 ap_send_interim_response(r, 1);
1669 /* FIXME: refine this to be able to specify per-response-status
1670 * policies and maybe also add option to bail out with 502
1672 else if (strcasecmp(policy, "Suppress")) {
1673 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1674 "undefined proxy interim response policy");
1677 /* Moved the fixups of Date headers and those affected by
1678 * ProxyPassReverse/etc from here to ap_proxy_read_headers
1681 if ((proxy_status == 401) && (conf->error_override)) {
1683 const char *wa = "WWW-Authenticate";
1684 if ((buf = apr_table_get(r->headers_out, wa))) {
1685 apr_table_set(r->err_headers_out, wa, buf);
1687 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
1688 "proxy: origin server sent 401 without WWW-Authenticate header");
1694 * Is it an HTTP/0.9 response or did we maybe preread the 1st line of
1695 * the response? If so, load the extra data. These are 2 mutually
1696 * exclusive possibilities, that just happen to require very
1699 if (backasswards || pread_len) {
1700 apr_ssize_t cntr = (apr_ssize_t)pread_len;
1703 * At this point in response processing of a 0.9 response,
1704 * we don't know yet whether data is binary or not.
1705 * mod_charset_lite will get control later on, so it cannot
1706 * decide on the conversion of this buffer full of data.
1707 * However, chances are that we are not really talking to an
1708 * HTTP/0.9 server, but to some different protocol, therefore
1709 * the best guess IMHO is to always treat the buffer as "text/x":
1711 ap_xlate_proto_to_ascii(buffer, len);
1712 cntr = (apr_ssize_t)len;
1714 e = apr_bucket_heap_create(buffer, cntr, NULL, c->bucket_alloc);
1715 APR_BRIGADE_INSERT_TAIL(bb, e);
1717 /* PR 41646: get HEAD right with ProxyErrorOverride */
1718 if (ap_is_HTTP_ERROR(r->status) && conf->error_override) {
1719 /* clear r->status for override error, otherwise ErrorDocument
1720 * thinks that this is a recursive error, and doesn't find the
1723 r->status = HTTP_OK;
1724 /* Discard body, if one is expected */
1725 if (!r->header_only && /* not HEAD request */
1726 (proxy_status != HTTP_NO_CONTENT) && /* not 204 */
1727 (proxy_status != HTTP_NOT_MODIFIED)) { /* not 304 */
1728 ap_discard_request_body(rp);
1730 return proxy_status;
1733 /* send body - but only if a body is expected */
1734 if ((!r->header_only) && /* not HEAD request */
1735 !interim_response && /* not any 1xx response */
1736 (proxy_status != HTTP_NO_CONTENT) && /* not 204 */
1737 (proxy_status != HTTP_NOT_MODIFIED)) { /* not 304 */
1739 /* We need to copy the output headers and treat them as input
1740 * headers as well. BUT, we need to do this before we remove
1741 * TE, so that they are preserved accordingly for
1742 * ap_http_filter to know where to end.
1744 rp->headers_in = apr_table_copy(r->pool, r->headers_out);
1746 * Restore Transfer-Encoding header from response if we saved
1747 * one before and there is none left. We need it for the
1748 * ap_http_filter. See above.
1750 if (te && !apr_table_get(rp->headers_in, "Transfer-Encoding")) {
1751 apr_table_add(rp->headers_in, "Transfer-Encoding", te);
1754 apr_table_unset(r->headers_out,"Transfer-Encoding");
1756 ap_log_error(APLOG_MARK, APLOG_TRACE3, 0, r->server,
1757 "proxy: start body send");
1760 * if we are overriding the errors, we can't put the content
1761 * of the page into the brigade
1763 if (!conf->error_override || !ap_is_HTTP_ERROR(proxy_status)) {
1764 /* read the body, pass it to the output filters */
1765 apr_read_type_e mode = APR_NONBLOCK_READ;
1768 /* Handle the case where the error document is itself reverse
1769 * proxied and was successful. We must maintain any previous
1770 * error status so that an underlying error (eg HTTP_NOT_FOUND)
1771 * doesn't become an HTTP_OK.
1773 if (conf->error_override && !ap_is_HTTP_ERROR(proxy_status)
1774 && ap_is_HTTP_ERROR(original_status)) {
1775 r->status = original_status;
1776 r->status_line = original_status_line;
1780 apr_off_t readbytes;
1783 rv = ap_get_brigade(rp->input_filters, bb,
1784 AP_MODE_READBYTES, mode,
1785 conf->io_buffer_size);
1787 /* ap_get_brigade will return success with an empty brigade
1788 * for a non-blocking read which would block: */
1789 if (APR_STATUS_IS_EAGAIN(rv)
1790 || (rv == APR_SUCCESS && APR_BRIGADE_EMPTY(bb))) {
1791 /* flush to the client and switch to blocking mode */
1792 e = apr_bucket_flush_create(c->bucket_alloc);
1793 APR_BRIGADE_INSERT_TAIL(bb, e);
1794 if (ap_pass_brigade(r->output_filters, bb)
1799 apr_brigade_cleanup(bb);
1800 mode = APR_BLOCK_READ;
1803 else if (rv == APR_EOF) {
1806 else if (rv != APR_SUCCESS) {
1807 /* In this case, we are in real trouble because
1808 * our backend bailed on us. Pass along a 502 error
1811 ap_log_cerror(APLOG_MARK, APLOG_ERR, rv, c,
1812 "proxy: error reading response");
1813 ap_proxy_backend_broke(r, bb);
1814 ap_pass_brigade(r->output_filters, bb);
1819 /* next time try a non-blocking read */
1820 mode = APR_NONBLOCK_READ;
1822 apr_brigade_length(bb, 0, &readbytes);
1823 backend->worker->s->read += readbytes;
1826 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
1827 r->server, "proxy (PID %d): readbytes: %#x",
1828 getpid(), readbytes);
1832 if (APR_BRIGADE_EMPTY(bb)) {
1833 apr_brigade_cleanup(bb);
1837 /* Switch the allocator lifetime of the buckets */
1838 ap_proxy_buckets_lifetime_transform(r, bb, pass_bb);
1840 /* found the last brigade? */
1841 if (APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(bb))) {
1842 /* signal that we must leave */
1846 /* try send what we read */
1847 if (ap_pass_brigade(r->output_filters, pass_bb) != APR_SUCCESS
1849 /* Ack! Phbtt! Die! User aborted! */
1850 backend->close = 1; /* this causes socket close below */
1854 /* make sure we always clean up after ourselves */
1855 apr_brigade_cleanup(bb);
1856 apr_brigade_cleanup(pass_bb);
1860 ap_log_error(APLOG_MARK, APLOG_TRACE2, 0, r->server,
1861 "proxy: end body send");
1863 else if (!interim_response) {
1864 ap_log_error(APLOG_MARK, APLOG_TRACE2, 0, r->server,
1865 "proxy: header only");
1867 /* Pass EOS bucket down the filter chain. */
1868 e = apr_bucket_eos_create(c->bucket_alloc);
1869 APR_BRIGADE_INSERT_TAIL(bb, e);
1870 if (ap_pass_brigade(r->output_filters, bb) != APR_SUCCESS
1872 /* Ack! Phbtt! Die! User aborted! */
1873 backend->close = 1; /* this causes socket close below */
1876 apr_brigade_cleanup(bb);
1878 } while (interim_response && (interim_response < AP_MAX_INTERIM_RESPONSES));
1880 /* See define of AP_MAX_INTERIM_RESPONSES for why */
1881 if (interim_response >= AP_MAX_INTERIM_RESPONSES) {
1882 return ap_proxyerror(r, HTTP_BAD_GATEWAY,
1884 "Too many (%d) interim responses from origin server",
1888 /* If our connection with the client is to be aborted, return DONE. */
1889 if (c->aborted || backend_broke) {
1897 apr_status_t ap_proxy_http_cleanup(const char *scheme, request_rec *r,
1898 proxy_conn_rec *backend)
1900 ap_proxy_release_connection(scheme, backend, r->server);
1905 * This handles http:// URLs, and other URLs using a remote proxy over http
1906 * If proxyhost is NULL, then contact the server directly, otherwise
1908 * Note that if a proxy is used, then URLs other than http: can be accessed,
1909 * also, if we have trouble which is clearly specific to the proxy, then
1910 * we return DECLINED so that we can try another proxy. (Or the direct
1913 static int proxy_http_handler(request_rec *r, proxy_worker *worker,
1914 proxy_server_conf *conf,
1915 char *url, const char *proxyname,
1916 apr_port_t proxyport)
1919 char server_portstr[32];
1921 const char *proxy_function;
1923 proxy_conn_rec *backend = NULL;
1925 conn_rec *c = r->connection;
1927 * Use a shorter-lived pool to reduce memory usage
1928 * and avoid a memory leak
1930 apr_pool_t *p = r->pool;
1931 apr_uri_t *uri = apr_palloc(p, sizeof(*uri));
1933 /* find the scheme */
1934 u = strchr(url, ':');
1935 if (u == NULL || u[1] != '/' || u[2] != '/' || u[3] == '\0')
1938 return HTTP_BAD_REQUEST;
1939 scheme = apr_pstrndup(p, url, u - url);
1940 /* scheme is lowercase */
1941 ap_str_tolower(scheme);
1943 if (strcmp(scheme, "https") == 0) {
1944 if (!ap_proxy_ssl_enable(NULL)) {
1945 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
1946 "proxy: HTTPS: declining URL %s"
1947 " (mod_ssl not configured?)", url);
1951 proxy_function = "HTTPS";
1953 else if (!(strcmp(scheme, "http") == 0 || (strcmp(scheme, "ftp") == 0 && proxyname))) {
1954 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
1955 "proxy: HTTP: declining URL %s", url);
1956 return DECLINED; /* only interested in HTTP, or FTP via proxy */
1960 proxy_function = "HTTP";
1962 proxy_function = "FTP";
1964 ap_log_error(APLOG_MARK, APLOG_TRACE1, 0, r->server,
1965 "proxy: HTTP: serving URL %s", url);
1968 /* create space for state information */
1969 if ((status = ap_proxy_acquire_connection(proxy_function, &backend,
1970 worker, r->server)) != OK)
1974 backend->is_ssl = is_ssl;
1977 ap_proxy_ssl_connection_cleanup(backend, r);
1981 * In the case that we are handling a reverse proxy connection and this
1982 * is not a request that is coming over an already kept alive connection
1983 * with the client, do NOT reuse the connection to the backend, because
1984 * we cannot forward a failure to the client in this case as the client
1985 * does NOT expect this in this situation.
1986 * Yes, this creates a performance penalty.
1988 if ((r->proxyreq == PROXYREQ_REVERSE) && (!c->keepalives)
1989 && (apr_table_get(r->subprocess_env, "proxy-initial-not-pooled"))) {
1993 /* Step One: Determine Who To Connect To */
1994 if ((status = ap_proxy_determine_connection(p, r, conf, worker, backend,
1995 uri, &url, proxyname,
1996 proxyport, server_portstr,
1997 sizeof(server_portstr))) != OK)
2000 /* Step Two: Make the Connection */
2001 if (ap_proxy_connect_backend(proxy_function, backend, worker, r->server)) {
2002 status = HTTP_SERVICE_UNAVAILABLE;
2006 /* Step Three: Create conn_rec */
2007 if (!backend->connection) {
2008 if ((status = ap_proxy_connection_create(proxy_function, backend,
2009 c, r->server)) != OK)
2012 * On SSL connections set a note on the connection what CN is
2013 * requested, such that mod_ssl can check if it is requested to do
2017 apr_table_set(backend->connection->notes, "proxy-request-hostname",
2022 /* Step Four: Send the Request */
2023 if ((status = ap_proxy_http_request(p, r, backend, backend->connection,
2024 conf, uri, url, server_portstr)) != OK)
2027 /* Step Five: Receive the Response */
2028 if ((status = ap_proxy_http_process_response(p, r, backend,
2029 backend->connection,
2030 conf, server_portstr)) != OK)
2033 /* Step Six: Clean Up */
2039 ap_proxy_http_cleanup(proxy_function, r, backend);
2043 static apr_status_t warn_rx_free(void *p)
2045 ap_pregfree((apr_pool_t*)p, warn_rx);
2048 static void ap_proxy_http_register_hook(apr_pool_t *p)
2050 proxy_hook_scheme_handler(proxy_http_handler, NULL, NULL, APR_HOOK_FIRST);
2051 proxy_hook_canon_handler(proxy_http_canon, NULL, NULL, APR_HOOK_FIRST);
2052 warn_rx = ap_pregcomp(p, "[0-9]{3}[ \t]+[^ \t]+[ \t]+\"[^\"]*\"([ \t]+\"([^\"]+)\")?", 0);
2053 apr_pool_cleanup_register(p, p, warn_rx_free, apr_pool_cleanup_null);
2056 AP_DECLARE_MODULE(proxy_http) = {
2057 STANDARD20_MODULE_STUFF,
2058 NULL, /* create per-directory config structure */
2059 NULL, /* merge per-directory config structures */
2060 NULL, /* create per-server config structure */
2061 NULL, /* merge per-server config structures */
2062 NULL, /* command apr_table_t */
2063 ap_proxy_http_register_hook/* register hooks */