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;
560 body_brigade = apr_brigade_create(p, bucket_alloc);
562 limit = ap_get_limit_req_body(r);
564 while (!APR_BUCKET_IS_EOS(APR_BRIGADE_FIRST(input_brigade)))
566 /* If this brigade contains EOS, either stop or remove it. */
567 if (APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(input_brigade))) {
570 /* We can't pass this EOS to the output_filters. */
571 e = APR_BRIGADE_LAST(input_brigade);
572 apr_bucket_delete(e);
575 apr_brigade_length(input_brigade, 1, &bytes);
577 if (bytes_spooled + bytes > MAX_MEM_SPOOL) {
579 * LimitRequestBody does not affect Proxy requests (Should it?).
580 * Let it take effect if we decide to store the body in a
581 * temporary file on disk.
583 if (bytes_spooled + bytes > limit) {
584 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
585 "proxy: Request body is larger than the"
586 " configured limit of %" APR_OFF_T_FMT ".",
588 return HTTP_REQUEST_ENTITY_TOO_LARGE;
590 /* can't spool any more in memory; write latest brigade to disk */
591 if (tmpfile == NULL) {
592 const char *temp_dir;
595 status = apr_temp_dir_get(&temp_dir, p);
596 if (status != APR_SUCCESS) {
597 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
598 "proxy: search for temporary directory failed");
599 return HTTP_INTERNAL_SERVER_ERROR;
601 apr_filepath_merge(&template, temp_dir,
602 "modproxy.tmp.XXXXXX",
603 APR_FILEPATH_NATIVE, p);
604 status = apr_file_mktemp(&tmpfile, template, 0, p);
605 if (status != APR_SUCCESS) {
606 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
607 "proxy: creation of temporary file in directory %s failed",
609 return HTTP_INTERNAL_SERVER_ERROR;
612 for (e = APR_BRIGADE_FIRST(input_brigade);
613 e != APR_BRIGADE_SENTINEL(input_brigade);
614 e = APR_BUCKET_NEXT(e)) {
616 apr_size_t bytes_read, bytes_written;
618 apr_bucket_read(e, &data, &bytes_read, APR_BLOCK_READ);
619 status = apr_file_write_full(tmpfile, data, bytes_read, &bytes_written);
620 if (status != APR_SUCCESS) {
621 const char *tmpfile_name;
623 if (apr_file_name_get(&tmpfile_name, tmpfile) != APR_SUCCESS) {
624 tmpfile_name = "(unknown)";
626 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
627 "proxy: write to temporary file %s failed",
629 return HTTP_INTERNAL_SERVER_ERROR;
631 AP_DEBUG_ASSERT(bytes_read == bytes_written);
632 fsize += bytes_written;
634 apr_brigade_cleanup(input_brigade);
639 * Save input_brigade in body_brigade. (At least) in the SSL case
640 * input_brigade contains transient buckets whose data would get
641 * overwritten during the next call of ap_get_brigade in the loop.
642 * ap_save_brigade ensures these buckets to be set aside.
643 * Calling ap_save_brigade with NULL as filter is OK, because
644 * body_brigade already has been created and does not need to get
645 * created by ap_save_brigade.
647 status = ap_save_brigade(NULL, &body_brigade, &input_brigade, p);
648 if (status != APR_SUCCESS) {
649 return HTTP_INTERNAL_SERVER_ERROR;
654 bytes_spooled += bytes;
660 status = ap_get_brigade(r->input_filters, input_brigade,
661 AP_MODE_READBYTES, APR_BLOCK_READ,
664 if (status != APR_SUCCESS) {
665 return HTTP_BAD_REQUEST;
669 if (bytes_spooled || force_cl) {
670 add_cl(p, bucket_alloc, header_brigade, apr_off_t_toa(p, bytes_spooled));
672 terminate_headers(bucket_alloc, header_brigade);
673 APR_BRIGADE_CONCAT(header_brigade, body_brigade);
675 apr_brigade_insert_file(header_brigade, tmpfile, 0, fsize, p);
677 if (apr_table_get(r->subprocess_env, "proxy-sendextracrlf")) {
678 e = apr_bucket_immortal_create(ASCII_CRLF, 2, bucket_alloc);
679 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
681 /* This is all a single brigade, pass with flush flagged */
682 return(pass_brigade(bucket_alloc, r, p_conn, origin, header_brigade, 1));
686 int ap_proxy_http_request(apr_pool_t *p, request_rec *r,
687 proxy_conn_rec *p_conn, proxy_worker *worker,
688 proxy_server_conf *conf,
690 char *url, char *server_portstr)
692 conn_rec *c = r->connection;
693 apr_bucket_alloc_t *bucket_alloc = c->bucket_alloc;
694 apr_bucket_brigade *header_brigade;
695 apr_bucket_brigade *input_brigade;
696 apr_bucket_brigade *temp_brigade;
699 const apr_array_header_t *headers_in_array;
700 const apr_table_entry_t *headers_in;
703 enum rb_methods {RB_INIT, RB_STREAM_CL, RB_STREAM_CHUNKED, RB_SPOOL_CL};
704 enum rb_methods rb_method = RB_INIT;
705 const char *old_cl_val = NULL;
706 const char *old_te_val = NULL;
707 apr_off_t bytes_read = 0;
710 apr_table_t *headers_in_copy;
711 proxy_dir_conf *dconf;
712 conn_rec *origin = p_conn->connection;
715 dconf = ap_get_module_config(r->per_dir_config, &proxy_module);
716 header_brigade = apr_brigade_create(p, origin->bucket_alloc);
719 * Send the HTTP/1.1 request to the remote server
723 * To be compliant, we only use 100-Continue for requests with bodies.
724 * We also make sure we won't be talking HTTP/1.0 as well.
726 do_100_continue = (worker->ping_timeout_set
727 && ap_request_has_body(r)
728 && (PROXYREQ_REVERSE == r->proxyreq)
729 && !(apr_table_get(r->subprocess_env, "force-proxy-request-1.0")));
731 if (apr_table_get(r->subprocess_env, "force-proxy-request-1.0")) {
733 * According to RFC 2616 8.2.3 we are not allowed to forward an
734 * Expect: 100-continue to an HTTP/1.0 server. Instead we MUST return
735 * a HTTP_EXPECTATION_FAILED
737 if (r->expecting_100) {
738 return HTTP_EXPECTATION_FAILED;
740 buf = apr_pstrcat(p, r->method, " ", url, " HTTP/1.0" CRLF, NULL);
744 buf = apr_pstrcat(p, r->method, " ", url, " HTTP/1.1" CRLF, NULL);
747 if (apr_table_get(r->subprocess_env, "proxy-nokeepalive")) {
748 origin->keepalive = AP_CONN_CLOSE;
751 ap_xlate_proto_to_ascii(buf, strlen(buf));
752 e = apr_bucket_pool_create(buf, strlen(buf), p, c->bucket_alloc);
753 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
754 if (dconf->preserve_host == 0) {
755 if (ap_strchr_c(uri->hostname, ':')) { /* if literal IPv6 address */
756 if (uri->port_str && uri->port != DEFAULT_HTTP_PORT) {
757 buf = apr_pstrcat(p, "Host: [", uri->hostname, "]:",
758 uri->port_str, CRLF, NULL);
760 buf = apr_pstrcat(p, "Host: [", uri->hostname, "]", CRLF, NULL);
763 if (uri->port_str && uri->port != DEFAULT_HTTP_PORT) {
764 buf = apr_pstrcat(p, "Host: ", uri->hostname, ":",
765 uri->port_str, CRLF, NULL);
767 buf = apr_pstrcat(p, "Host: ", uri->hostname, CRLF, NULL);
772 /* don't want to use r->hostname, as the incoming header might have a
775 const char* hostname = apr_table_get(r->headers_in,"Host");
777 hostname = r->server->server_hostname;
778 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
779 "proxy: no HTTP 0.9 request (with no host line) "
780 "on incoming request and preserve host set "
781 "forcing hostname to be %s for uri %s",
785 buf = apr_pstrcat(p, "Host: ", hostname, CRLF, NULL);
787 ap_xlate_proto_to_ascii(buf, strlen(buf));
788 e = apr_bucket_pool_create(buf, strlen(buf), p, c->bucket_alloc);
789 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
792 if (conf->viaopt == via_block) {
793 /* Block all outgoing Via: headers */
794 apr_table_unset(r->headers_in, "Via");
795 } else if (conf->viaopt != via_off) {
796 const char *server_name = ap_get_server_name(r);
797 /* If USE_CANONICAL_NAME_OFF was configured for the proxy virtual host,
798 * then the server name returned by ap_get_server_name() is the
799 * origin server name (which does make too much sense with Via: headers)
800 * so we use the proxy vhost's name instead.
802 if (server_name == r->hostname)
803 server_name = r->server->server_hostname;
804 /* Create a "Via:" request header entry and merge it */
805 /* Generate outgoing Via: header with/without server comment: */
806 apr_table_mergen(r->headers_in, "Via",
807 (conf->viaopt == via_full)
808 ? apr_psprintf(p, "%d.%d %s%s (%s)",
809 HTTP_VERSION_MAJOR(r->proto_num),
810 HTTP_VERSION_MINOR(r->proto_num),
811 server_name, server_portstr,
812 AP_SERVER_BASEVERSION)
813 : apr_psprintf(p, "%d.%d %s%s",
814 HTTP_VERSION_MAJOR(r->proto_num),
815 HTTP_VERSION_MINOR(r->proto_num),
816 server_name, server_portstr)
820 /* Use HTTP/1.1 100-Continue as quick "HTTP ping" test
823 if (do_100_continue) {
824 apr_table_mergen(r->headers_in, "Expect", "100-Continue");
825 r->expecting_100 = 1;
828 /* X-Forwarded-*: handling
833 * These request headers are only really useful when the mod_proxy
834 * is used in a reverse proxy configuration, so that useful info
835 * about the client can be passed through the reverse proxy and on
836 * to the backend server, which may require the information to
839 * In a forward proxy situation, these options are a potential
840 * privacy violation, as information about clients behind the proxy
841 * are revealed to arbitrary servers out there on the internet.
843 * The HTTP/1.1 Via: header is designed for passing client
844 * information through proxies to a server, and should be used in
845 * a forward proxy configuation instead of X-Forwarded-*. See the
846 * ProxyVia option for details.
849 if (PROXYREQ_REVERSE == r->proxyreq) {
852 /* Add X-Forwarded-For: so that the upstream has a chance to
853 * determine, where the original request came from.
855 apr_table_mergen(r->headers_in, "X-Forwarded-For",
858 /* Add X-Forwarded-Host: so that upstream knows what the
859 * original request hostname was.
861 if ((buf = apr_table_get(r->headers_in, "Host"))) {
862 apr_table_mergen(r->headers_in, "X-Forwarded-Host", buf);
865 /* Add X-Forwarded-Server: so that upstream knows what the
866 * name of this proxy server is (if there are more than one)
867 * XXX: This duplicates Via: - do we strictly need it?
869 apr_table_mergen(r->headers_in, "X-Forwarded-Server",
870 r->server->server_hostname);
875 * Make a copy of the headers_in table before clearing the connection
876 * headers as we need the connection headers later in the http output
877 * filter to prepare the correct response headers.
879 * Note: We need to take r->pool for apr_table_copy as the key / value
880 * pairs in r->headers_in have been created out of r->pool and
881 * p might be (and actually is) a longer living pool.
882 * This would trigger the bad pool ancestry abort in apr_table_copy if
883 * apr is compiled with APR_POOL_DEBUG.
885 headers_in_copy = apr_table_copy(r->pool, r->headers_in);
886 ap_proxy_clear_connection(p, headers_in_copy);
887 /* send request headers */
888 headers_in_array = apr_table_elts(headers_in_copy);
889 headers_in = (const apr_table_entry_t *) headers_in_array->elts;
890 for (counter = 0; counter < headers_in_array->nelts; counter++) {
891 if (headers_in[counter].key == NULL
892 || headers_in[counter].val == NULL
895 || !strcasecmp(headers_in[counter].key, "Host")
897 /* Clear out hop-by-hop request headers not to send
898 * RFC2616 13.5.1 says we should strip these headers
900 || !strcasecmp(headers_in[counter].key, "Keep-Alive")
901 || !strcasecmp(headers_in[counter].key, "TE")
902 || !strcasecmp(headers_in[counter].key, "Trailer")
903 || !strcasecmp(headers_in[counter].key, "Upgrade")
908 /* Do we want to strip Proxy-Authorization ?
909 * If we haven't used it, then NO
910 * If we have used it then MAYBE: RFC2616 says we MAY propagate it.
911 * So let's make it configurable by env.
913 if (!strcasecmp(headers_in[counter].key,"Proxy-Authorization")) {
914 if (r->user != NULL) { /* we've authenticated */
915 if (!apr_table_get(r->subprocess_env, "Proxy-Chain-Auth")) {
922 /* Skip Transfer-Encoding and Content-Length for now.
924 if (!strcasecmp(headers_in[counter].key, "Transfer-Encoding")) {
925 old_te_val = headers_in[counter].val;
928 if (!strcasecmp(headers_in[counter].key, "Content-Length")) {
929 old_cl_val = headers_in[counter].val;
933 /* for sub-requests, ignore freshness/expiry headers */
935 if ( !strcasecmp(headers_in[counter].key, "If-Match")
936 || !strcasecmp(headers_in[counter].key, "If-Modified-Since")
937 || !strcasecmp(headers_in[counter].key, "If-Range")
938 || !strcasecmp(headers_in[counter].key, "If-Unmodified-Since")
939 || !strcasecmp(headers_in[counter].key, "If-None-Match")) {
944 buf = apr_pstrcat(p, headers_in[counter].key, ": ",
945 headers_in[counter].val, CRLF,
947 ap_xlate_proto_to_ascii(buf, strlen(buf));
948 e = apr_bucket_pool_create(buf, strlen(buf), p, c->bucket_alloc);
949 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
952 /* We have headers, let's figure out our request body... */
953 input_brigade = apr_brigade_create(p, bucket_alloc);
955 /* sub-requests never use keepalives, and mustn't pass request bodies.
956 * Because the new logic looks at input_brigade, we will self-terminate
957 * input_brigade and jump past all of the request body logic...
958 * Reading anything with ap_get_brigade is likely to consume the
959 * main request's body or read beyond EOS - which would be unplesant.
961 * An exception: when a kept_body is present, then subrequest CAN use
962 * pass request bodies, and we DONT skip the body.
964 if (!r->kept_body && r->main) {
965 /* XXX: Why DON'T sub-requests use keepalives? */
969 apr_table_unset(r->headers_in, "Content-Length");
973 apr_table_unset(r->headers_in, "Transfer-Encoding");
975 rb_method = RB_STREAM_CL;
976 e = apr_bucket_eos_create(input_brigade->bucket_alloc);
977 APR_BRIGADE_INSERT_TAIL(input_brigade, e);
981 /* WE only understand chunked. Other modules might inject
982 * (and therefore, decode) other flavors but we don't know
983 * that the can and have done so unless they they remove
984 * their decoding from the headers_in T-E list.
985 * XXX: Make this extensible, but in doing so, presume the
986 * encoding has been done by the extensions' handler, and
987 * do not modify add_te_chunked's logic
989 if (old_te_val && strcasecmp(old_te_val, "chunked") != 0) {
990 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
991 "proxy: %s Transfer-Encoding is not supported",
993 return HTTP_INTERNAL_SERVER_ERROR;
996 if (old_cl_val && old_te_val) {
997 ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_ENOTIMPL, r->server,
998 "proxy: client %s (%s) requested Transfer-Encoding "
999 "chunked body with Content-Length (C-L ignored)",
1000 c->remote_ip, c->remote_host ? c->remote_host: "");
1001 apr_table_unset(r->headers_in, "Content-Length");
1003 origin->keepalive = AP_CONN_CLOSE;
1007 /* Prefetch MAX_MEM_SPOOL bytes
1009 * This helps us avoid any election of C-L v.s. T-E
1010 * request bodies, since we are willing to keep in
1011 * memory this much data, in any case. This gives
1012 * us an instant C-L election if the body is of some
1015 temp_brigade = apr_brigade_create(p, bucket_alloc);
1017 status = ap_get_brigade(r->input_filters, temp_brigade,
1018 AP_MODE_READBYTES, APR_BLOCK_READ,
1019 MAX_MEM_SPOOL - bytes_read);
1020 if (status != APR_SUCCESS) {
1021 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
1022 "proxy: prefetch request body failed to %pI (%s)"
1024 p_conn->addr, p_conn->hostname ? p_conn->hostname: "",
1025 c->remote_ip, c->remote_host ? c->remote_host: "");
1026 return HTTP_BAD_REQUEST;
1029 apr_brigade_length(temp_brigade, 1, &bytes);
1030 bytes_read += bytes;
1033 * Save temp_brigade in input_brigade. (At least) in the SSL case
1034 * temp_brigade contains transient buckets whose data would get
1035 * overwritten during the next call of ap_get_brigade in the loop.
1036 * ap_save_brigade ensures these buckets to be set aside.
1037 * Calling ap_save_brigade with NULL as filter is OK, because
1038 * input_brigade already has been created and does not need to get
1039 * created by ap_save_brigade.
1041 status = ap_save_brigade(NULL, &input_brigade, &temp_brigade, p);
1042 if (status != APR_SUCCESS) {
1043 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
1044 "proxy: processing prefetched request body failed"
1045 " to %pI (%s) from %s (%s)",
1046 p_conn->addr, p_conn->hostname ? p_conn->hostname: "",
1047 c->remote_ip, c->remote_host ? c->remote_host: "");
1048 return HTTP_INTERNAL_SERVER_ERROR;
1051 /* Ensure we don't hit a wall where we have a buffer too small
1052 * for ap_get_brigade's filters to fetch us another bucket,
1053 * surrender once we hit 80 bytes less than MAX_MEM_SPOOL
1054 * (an arbitrary value.)
1056 } while ((bytes_read < MAX_MEM_SPOOL - 80)
1057 && !APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(input_brigade)));
1059 /* Use chunked request body encoding or send a content-length body?
1063 * We have no request body (handled by RB_STREAM_CL)
1065 * We have a request body length <= MAX_MEM_SPOOL
1067 * The administrator has setenv force-proxy-request-1.0
1069 * The client sent a C-L body, and the administrator has
1070 * not setenv proxy-sendchunked or has set setenv proxy-sendcl
1072 * The client sent a T-E body, and the administrator has
1073 * setenv proxy-sendcl, and not setenv proxy-sendchunked
1075 * If both proxy-sendcl and proxy-sendchunked are set, the
1076 * behavior is the same as if neither were set, large bodies
1077 * that can't be read will be forwarded in their original
1078 * form of C-L, or T-E.
1080 * To ensure maximum compatibility, setenv proxy-sendcl
1081 * To reduce server resource use, setenv proxy-sendchunked
1083 * Then address specific servers with conditional setenv
1084 * options to restore the default behavior where desireable.
1086 * We have to compute content length by reading the entire request
1087 * body; if request body is not small, we'll spool the remaining
1088 * input to a temporary file. Chunked is always preferable.
1090 * We can only trust the client-provided C-L if the T-E header
1091 * is absent, and the filters are unchanged (the body won't
1092 * be resized by another content filter).
1094 if (APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(input_brigade))) {
1095 /* The whole thing fit, so our decision is trivial, use
1096 * the filtered bytes read from the client for the request
1097 * body Content-Length.
1099 * If we expected no body, and read no body, do not set
1100 * the Content-Length.
1102 if (old_cl_val || old_te_val || bytes_read) {
1103 old_cl_val = apr_off_t_toa(r->pool, bytes_read);
1105 rb_method = RB_STREAM_CL;
1107 else if (old_te_val) {
1109 || (apr_table_get(r->subprocess_env, "proxy-sendcl")
1110 && !apr_table_get(r->subprocess_env, "proxy-sendchunks")
1111 && !apr_table_get(r->subprocess_env, "proxy-sendchunked"))) {
1112 rb_method = RB_SPOOL_CL;
1115 rb_method = RB_STREAM_CHUNKED;
1118 else if (old_cl_val) {
1119 if (r->input_filters == r->proto_input_filters) {
1120 rb_method = RB_STREAM_CL;
1123 && (apr_table_get(r->subprocess_env, "proxy-sendchunks")
1124 || apr_table_get(r->subprocess_env, "proxy-sendchunked"))
1125 && !apr_table_get(r->subprocess_env, "proxy-sendcl")) {
1126 rb_method = RB_STREAM_CHUNKED;
1129 rb_method = RB_SPOOL_CL;
1133 /* This is an appropriate default; very efficient for no-body
1134 * requests, and has the behavior that it will not add any C-L
1135 * when the old_cl_val is NULL.
1137 rb_method = RB_SPOOL_CL;
1140 /* Yes I hate gotos. This is the subrequest shortcut */
1143 * Handle Connection: header if we do HTTP/1.1 request:
1144 * If we plan to close the backend connection sent Connection: close
1145 * otherwise sent Connection: Keep-Alive.
1148 if (p_conn->close) {
1149 buf = apr_pstrdup(p, "Connection: close" CRLF);
1152 buf = apr_pstrdup(p, "Connection: Keep-Alive" CRLF);
1154 ap_xlate_proto_to_ascii(buf, strlen(buf));
1155 e = apr_bucket_pool_create(buf, strlen(buf), p, c->bucket_alloc);
1156 APR_BRIGADE_INSERT_TAIL(header_brigade, e);
1159 /* send the request body, if any. */
1161 case RB_STREAM_CHUNKED:
1162 rv = stream_reqbody_chunked(p, r, p_conn, origin, header_brigade,
1166 rv = stream_reqbody_cl(p, r, p_conn, origin, header_brigade,
1167 input_brigade, old_cl_val);
1170 rv = spool_reqbody_cl(p, r, p_conn, origin, header_brigade,
1171 input_brigade, (old_cl_val != NULL)
1172 || (old_te_val != NULL)
1173 || (bytes_read > 0));
1176 /* shouldn't be possible */
1177 rv = HTTP_INTERNAL_SERVER_ERROR ;
1182 /* apr_status_t value has been logged in lower level method */
1183 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
1184 "proxy: pass request body failed to %pI (%s)"
1187 p_conn->hostname ? p_conn->hostname: "",
1189 c->remote_host ? c->remote_host: "");
1196 static void process_proxy_header(request_rec *r, proxy_dir_conf *c,
1197 const char *key, const char *value)
1199 static const char *date_hdrs[]
1200 = { "Date", "Expires", "Last-Modified", NULL };
1201 static const struct {
1203 ap_proxy_header_reverse_map_fn func;
1204 } transform_hdrs[] = {
1205 { "Location", ap_proxy_location_reverse_map },
1206 { "Content-Location", ap_proxy_location_reverse_map },
1207 { "URI", ap_proxy_location_reverse_map },
1208 { "Destination", ap_proxy_location_reverse_map },
1209 { "Set-Cookie", ap_proxy_cookie_reverse_map },
1213 for (i = 0; date_hdrs[i]; ++i) {
1214 if (!strcasecmp(date_hdrs[i], key)) {
1215 apr_table_add(r->headers_out, key,
1216 ap_proxy_date_canon(r->pool, value));
1220 for (i = 0; transform_hdrs[i].name; ++i) {
1221 if (!strcasecmp(transform_hdrs[i].name, key)) {
1222 apr_table_add(r->headers_out, key,
1223 (*transform_hdrs[i].func)(r, c, value));
1227 apr_table_add(r->headers_out, key, value);
1232 * Note: pread_len is the length of the response that we've mistakenly
1233 * read (assuming that we don't consider that an error via
1234 * ProxyBadHeader StartBody). This depends on buffer actually being
1235 * local storage to the calling code in order for pread_len to make
1236 * any sense at all, since we depend on buffer still containing
1237 * what was read by ap_getline() upon return.
1239 static void ap_proxy_read_headers(request_rec *r, request_rec *rr,
1240 char *buffer, int size,
1241 conn_rec *c, int *pread_len)
1245 char field[MAX_STRING_LEN];
1246 int saw_headers = 0;
1247 void *sconf = r->server->module_config;
1248 proxy_server_conf *psc;
1249 proxy_dir_conf *dconf;
1251 dconf = ap_get_module_config(r->per_dir_config, &proxy_module);
1252 psc = (proxy_server_conf *) ap_get_module_config(sconf, &proxy_module);
1254 r->headers_out = apr_table_make(r->pool, 20);
1258 * Read header lines until we get the empty separator line, a read error,
1259 * the connection closes (EOF), or we timeout.
1261 ap_log_rerror(APLOG_MARK, APLOG_TRACE4, 0, r,
1262 "Headers received from backend:");
1263 while ((len = ap_getline(buffer, size, rr, 1)) > 0) {
1264 ap_log_rerror(APLOG_MARK, APLOG_TRACE4, 0, r, "%s", buffer);
1266 if (!(value = strchr(buffer, ':'))) { /* Find the colon separator */
1268 /* We may encounter invalid headers, usually from buggy
1269 * MS IIS servers, so we need to determine just how to handle
1270 * them. We can either ignore them, assume that they mark the
1271 * start-of-body (eg: a missing CRLF) or (the default) mark
1272 * the headers as totally bogus and return a 500. The sole
1273 * exception is an extra "HTTP/1.0 200, OK" line sprinkled
1274 * in between the usual MIME headers, which is a favorite
1277 /* XXX: The mask check is buggy if we ever see an HTTP/1.10 */
1279 if (!apr_date_checkmask(buffer, "HTTP/#.# ###*")) {
1280 if (psc->badopt == bad_error) {
1281 /* Nope, it wasn't even an extra HTTP header. Give up. */
1282 r->headers_out = NULL;
1285 else if (psc->badopt == bad_body) {
1286 /* if we've already started loading headers_out, then
1287 * return what we've accumulated so far, in the hopes
1288 * that they are useful; also note that we likely pre-read
1289 * the first line of the response.
1292 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, r->server,
1293 "proxy: Starting body due to bogus non-header in headers "
1294 "returned by %s (%s)", r->uri, r->method);
1298 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, r->server,
1299 "proxy: No HTTP headers "
1300 "returned by %s (%s)", r->uri, r->method);
1305 /* this is the psc->badopt == bad_ignore case */
1306 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, r->server,
1307 "proxy: Ignoring bogus HTTP header "
1308 "returned by %s (%s)", r->uri, r->method);
1314 /* XXX: RFC2068 defines only SP and HT as whitespace, this test is
1315 * wrong... and so are many others probably.
1317 while (apr_isspace(*value))
1318 ++value; /* Skip to start of value */
1320 /* should strip trailing whitespace as well */
1321 for (end = &value[strlen(value)-1]; end > value && apr_isspace(*end); --
1325 /* make sure we add so as not to destroy duplicated headers
1326 * Modify headers requiring canonicalisation and/or affected
1327 * by ProxyPassReverse and family with process_proxy_header
1329 process_proxy_header(r, dconf, buffer, value) ;
1332 /* the header was too long; at the least we should skip extra data */
1333 if (len >= size - 1) {
1334 while ((len = ap_getline(field, MAX_STRING_LEN, rr, 1))
1335 >= MAX_STRING_LEN - 1) {
1336 /* soak up the extra data */
1338 if (len == 0) /* time to exit the larger loop as well */
1346 static int addit_dammit(void *v, const char *key, const char *val)
1348 apr_table_addn(v, key, val);
1353 apr_status_t ap_proxygetline(apr_bucket_brigade *bb, char *s, int n, request_rec *r,
1354 int fold, int *writen)
1360 rv = ap_rgetline(&tmp_s, n, &len, r, fold, bb);
1361 apr_brigade_cleanup(bb);
1363 if (rv == APR_SUCCESS) {
1364 *writen = (int) len;
1365 } else if (rv == APR_ENOSPC) {
1375 * Limit the number of interim respones we sent back to the client. Otherwise
1376 * we suffer from a memory build up. Besides there is NO sense in sending back
1377 * an unlimited number of interim responses to the client. Thus if we cross
1378 * this limit send back a 502 (Bad Gateway).
1380 #ifndef AP_MAX_INTERIM_RESPONSES
1381 #define AP_MAX_INTERIM_RESPONSES 10
1385 apr_status_t ap_proxy_http_process_response(apr_pool_t * p, request_rec *r,
1386 proxy_conn_rec *backend,
1387 proxy_worker *worker,
1388 proxy_server_conf *conf,
1389 char *server_portstr) {
1390 conn_rec *c = r->connection;
1391 char buffer[HUGE_STRING_LEN];
1396 apr_bucket_brigade *bb, *tmp_bb;
1397 apr_bucket_brigade *pass_bb;
1398 int len, backasswards;
1399 int interim_response = 0; /* non-zero whilst interim 1xx responses
1400 * are being read. */
1402 apr_table_t *save_table;
1403 int backend_broke = 0;
1404 static const char *hop_by_hop_hdrs[] =
1405 {"Keep-Alive", "Proxy-Authenticate", "TE", "Trailer", "Upgrade", NULL};
1407 const char *te = NULL;
1408 int original_status = r->status;
1409 int proxy_status = OK;
1410 const char *original_status_line = r->status_line;
1411 const char *proxy_status_line = NULL;
1412 conn_rec *origin = backend->connection;
1413 apr_interval_time_t old_timeout = 0;
1414 proxy_dir_conf *dconf;
1415 int do_100_continue;
1417 dconf = ap_get_module_config(r->per_dir_config, &proxy_module);
1419 do_100_continue = (worker->ping_timeout_set
1420 && ap_request_has_body(r)
1421 && (PROXYREQ_REVERSE == r->proxyreq)
1422 && !(apr_table_get(r->subprocess_env, "force-proxy-request-1.0")));
1424 bb = apr_brigade_create(p, c->bucket_alloc);
1425 pass_bb = apr_brigade_create(p, c->bucket_alloc);
1427 /* Setup for 100-Continue timeout if appropriate */
1428 if (do_100_continue) {
1429 apr_socket_timeout_get(backend->sock, &old_timeout);
1430 if (worker->ping_timeout != old_timeout) {
1432 rc = apr_socket_timeout_set(backend->sock, worker->ping_timeout);
1433 if (rc != APR_SUCCESS) {
1434 ap_log_error(APLOG_MARK, APLOG_ERR, rc, r->server,
1435 "proxy: could not set 100-Continue timeout");
1440 /* Get response from the remote server, and pass it up the
1444 rp = ap_proxy_make_fake_req(origin, r);
1445 /* In case anyone needs to know, this is a fake request that is really a
1448 rp->proxyreq = PROXYREQ_RESPONSE;
1449 tmp_bb = apr_brigade_create(p, c->bucket_alloc);
1453 apr_brigade_cleanup(bb);
1455 rc = ap_proxygetline(tmp_bb, buffer, sizeof(buffer), rp, 0, &len);
1457 /* handle one potential stray CRLF */
1458 rc = ap_proxygetline(tmp_bb, buffer, sizeof(buffer), rp, 0, &len);
1461 ap_log_rerror(APLOG_MARK, APLOG_ERR, rc, r,
1462 "proxy: error reading status line from remote "
1463 "server %s:%d", backend->hostname, backend->port);
1464 if (APR_STATUS_IS_TIMEUP(rc)) {
1465 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1466 "proxy: read timeout");
1467 if (do_100_continue) {
1468 return ap_proxyerror(r, HTTP_SERVICE_UNAVAILABLE, "Timeout on 100-Continue");
1472 * If we are a reverse proxy request shutdown the connection
1473 * WITHOUT ANY response to trigger a retry by the client
1474 * if allowed (as for idempotent requests).
1475 * BUT currently we should not do this if the request is the
1476 * first request on a keepalive connection as browsers like
1477 * seamonkey only display an empty page in this case and do
1478 * not do a retry. We should also not do this on a
1479 * connection which times out; instead handle as
1480 * we normally would handle timeouts
1482 if (r->proxyreq == PROXYREQ_REVERSE && c->keepalives &&
1483 !APR_STATUS_IS_TIMEUP(rc)) {
1486 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1487 "proxy: Closing connection to client because"
1488 " reading from backend server %s:%d failed."
1489 " Number of keepalives %i", backend->hostname,
1490 backend->port, c->keepalives);
1491 ap_proxy_backend_broke(r, bb);
1493 * Add an EOC bucket to signal the ap_http_header_filter
1494 * that it should get out of our way, BUT ensure that the
1495 * EOC bucket is inserted BEFORE an EOS bucket in bb as
1496 * some resource filters like mod_deflate pass everything
1497 * up to the EOS down the chain immediately and sent the
1498 * remainder of the brigade later (or even never). But in
1499 * this case the ap_http_header_filter does not get out of
1500 * our way soon enough.
1502 e = ap_bucket_eoc_create(c->bucket_alloc);
1503 eos = APR_BRIGADE_LAST(bb);
1504 while ((APR_BRIGADE_SENTINEL(bb) != eos)
1505 && !APR_BUCKET_IS_EOS(eos)) {
1506 eos = APR_BUCKET_PREV(eos);
1508 if (eos == APR_BRIGADE_SENTINEL(bb)) {
1509 APR_BRIGADE_INSERT_TAIL(bb, e);
1512 APR_BUCKET_INSERT_BEFORE(eos, e);
1514 ap_pass_brigade(r->output_filters, bb);
1515 /* Mark the backend connection for closing */
1517 /* Need to return OK to avoid sending an error message */
1520 else if (!c->keepalives) {
1521 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1522 "proxy: NOT Closing connection to client"
1523 " although reading from backend server %s:%d"
1524 " failed.", backend->hostname,
1527 return ap_proxyerror(r, HTTP_BAD_GATEWAY,
1528 "Error reading from remote server");
1530 /* XXX: Is this a real headers length send from remote? */
1531 backend->worker->s->read += len;
1533 /* Is it an HTTP/1 response?
1534 * This is buggy if we ever see an HTTP/1.10
1536 if (apr_date_checkmask(buffer, "HTTP/#.# ###*")) {
1539 major = buffer[5] - '0';
1540 minor = buffer[7] - '0';
1542 /* If not an HTTP/1 message or
1543 * if the status line was > 8192 bytes
1545 if ((major != 1) || (len >= sizeof(buffer)-1)) {
1546 return ap_proxyerror(r, HTTP_BAD_GATEWAY,
1547 apr_pstrcat(p, "Corrupt status line returned by remote "
1548 "server: ", buffer, NULL));
1552 keepchar = buffer[12];
1554 proxy_status = atoi(&buffer[9]);
1556 if (keepchar != '\0') {
1557 buffer[12] = keepchar;
1559 /* 2616 requires the space in Status-Line; the origin
1560 * server may have sent one but ap_rgetline_core will
1561 * have stripped it. */
1565 proxy_status_line = apr_pstrdup(p, &buffer[9]);
1567 /* The status out of the front is the same as the status coming in
1568 * from the back, until further notice.
1570 r->status = proxy_status;
1571 r->status_line = proxy_status_line;
1573 ap_log_rerror(APLOG_MARK, APLOG_TRACE3, 0, r,
1574 "Status from backend: %d", proxy_status);
1576 /* read the headers. */
1577 /* N.B. for HTTP/1.0 clients, we have to fold line-wrapped headers*/
1578 /* Also, take care with headers with multiple occurences. */
1580 /* First, tuck away all already existing cookies */
1581 save_table = apr_table_make(r->pool, 2);
1582 apr_table_do(addit_dammit, save_table, r->headers_out,
1583 "Set-Cookie", NULL);
1585 /* shove the headers direct into r->headers_out */
1586 ap_proxy_read_headers(r, rp, buffer, sizeof(buffer), origin,
1589 if (r->headers_out == NULL) {
1590 ap_log_error(APLOG_MARK, APLOG_WARNING, 0,
1591 r->server, "proxy: bad HTTP/%d.%d header "
1592 "returned by %s (%s)", major, minor, r->uri,
1594 backend->close += 1;
1596 * ap_send_error relies on a headers_out to be present. we
1597 * are in a bad position here.. so force everything we send out
1598 * to have nothing to do with the incoming packet
1600 r->headers_out = apr_table_make(r->pool,1);
1601 r->status = HTTP_BAD_GATEWAY;
1602 r->status_line = "bad gateway";
1606 /* Now, add in the just read cookies */
1607 apr_table_do(addit_dammit, save_table, r->headers_out,
1608 "Set-Cookie", NULL);
1610 /* and now load 'em all in */
1611 if (!apr_is_empty_table(save_table)) {
1612 apr_table_unset(r->headers_out, "Set-Cookie");
1613 r->headers_out = apr_table_overlay(r->pool,
1618 /* can't have both Content-Length and Transfer-Encoding */
1619 if (apr_table_get(r->headers_out, "Transfer-Encoding")
1620 && apr_table_get(r->headers_out, "Content-Length")) {
1622 * 2616 section 4.4, point 3: "if both Transfer-Encoding
1623 * and Content-Length are received, the latter MUST be
1626 * To help mitigate HTTP Splitting, unset Content-Length
1627 * and shut down the backend server connection
1628 * XXX: We aught to treat such a response as uncachable
1630 apr_table_unset(r->headers_out, "Content-Length");
1631 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
1632 "proxy: server %s:%d returned Transfer-Encoding"
1633 " and Content-Length", backend->hostname,
1635 backend->close += 1;
1639 * Save a possible Transfer-Encoding header as we need it later for
1640 * ap_http_filter to know where to end.
1642 te = apr_table_get(r->headers_out, "Transfer-Encoding");
1643 /* strip connection listed hop-by-hop headers from response */
1644 backend->close += ap_proxy_liststr(apr_table_get(r->headers_out,
1647 ap_proxy_clear_connection(p, r->headers_out);
1648 if ((buf = apr_table_get(r->headers_out, "Content-Type"))) {
1649 ap_set_content_type(r, apr_pstrdup(p, buf));
1651 if (!ap_is_HTTP_INFO(proxy_status)) {
1652 ap_proxy_pre_http_request(origin, rp);
1655 /* Clear hop-by-hop headers */
1656 for (i=0; hop_by_hop_hdrs[i]; ++i) {
1657 apr_table_unset(r->headers_out, hop_by_hop_hdrs[i]);
1659 /* Delete warnings with wrong date */
1660 r->headers_out = ap_proxy_clean_warnings(p, r->headers_out);
1662 /* handle Via header in response */
1663 if (conf->viaopt != via_off && conf->viaopt != via_block) {
1664 const char *server_name = ap_get_server_name(r);
1665 /* If USE_CANONICAL_NAME_OFF was configured for the proxy virtual host,
1666 * then the server name returned by ap_get_server_name() is the
1667 * origin server name (which does make too much sense with Via: headers)
1668 * so we use the proxy vhost's name instead.
1670 if (server_name == r->hostname)
1671 server_name = r->server->server_hostname;
1672 /* create a "Via:" response header entry and merge it */
1673 apr_table_addn(r->headers_out, "Via",
1674 (conf->viaopt == via_full)
1675 ? apr_psprintf(p, "%d.%d %s%s (%s)",
1676 HTTP_VERSION_MAJOR(r->proto_num),
1677 HTTP_VERSION_MINOR(r->proto_num),
1680 AP_SERVER_BASEVERSION)
1681 : apr_psprintf(p, "%d.%d %s%s",
1682 HTTP_VERSION_MAJOR(r->proto_num),
1683 HTTP_VERSION_MINOR(r->proto_num),
1689 /* cancel keepalive if HTTP/1.0 or less */
1690 if ((major < 1) || (minor < 1)) {
1691 backend->close += 1;
1692 origin->keepalive = AP_CONN_CLOSE;
1695 /* an http/0.9 response */
1698 r->status_line = "200 OK";
1699 backend->close += 1;
1702 if (ap_is_HTTP_INFO(proxy_status)) {
1704 /* Reset to old timeout iff we've adjusted it */
1706 && (r->status == HTTP_CONTINUE)
1707 && (worker->ping_timeout != old_timeout)) {
1708 apr_socket_timeout_set(backend->sock, old_timeout);
1712 interim_response = 0;
1714 if (interim_response) {
1715 /* RFC2616 tells us to forward this.
1717 * OTOH, an interim response here may mean the backend
1718 * is playing sillybuggers. The Client didn't ask for
1719 * it within the defined HTTP/1.1 mechanisms, and if
1720 * it's an extension, it may also be unsupported by us.
1722 * There's also the possibility that changing existing
1723 * behaviour here might break something.
1725 * So let's make it configurable.
1727 const char *policy = apr_table_get(r->subprocess_env,
1728 "proxy-interim-response");
1729 ap_log_rerror(APLOG_MARK, APLOG_TRACE2, 0, r,
1730 "proxy: HTTP: received interim %d response",
1732 if (!policy || !strcasecmp(policy, "RFC")) {
1733 ap_send_interim_response(r, 1);
1735 /* FIXME: refine this to be able to specify per-response-status
1736 * policies and maybe also add option to bail out with 502
1738 else if (strcasecmp(policy, "Suppress")) {
1739 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1740 "undefined proxy interim response policy");
1743 /* Moved the fixups of Date headers and those affected by
1744 * ProxyPassReverse/etc from here to ap_proxy_read_headers
1747 if ((proxy_status == 401) && (dconf->error_override)) {
1749 const char *wa = "WWW-Authenticate";
1750 if ((buf = apr_table_get(r->headers_out, wa))) {
1751 apr_table_set(r->err_headers_out, wa, buf);
1753 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
1754 "proxy: origin server sent 401 without WWW-Authenticate header");
1760 * Is it an HTTP/0.9 response or did we maybe preread the 1st line of
1761 * the response? If so, load the extra data. These are 2 mutually
1762 * exclusive possibilities, that just happen to require very
1765 if (backasswards || pread_len) {
1766 apr_ssize_t cntr = (apr_ssize_t)pread_len;
1769 * At this point in response processing of a 0.9 response,
1770 * we don't know yet whether data is binary or not.
1771 * mod_charset_lite will get control later on, so it cannot
1772 * decide on the conversion of this buffer full of data.
1773 * However, chances are that we are not really talking to an
1774 * HTTP/0.9 server, but to some different protocol, therefore
1775 * the best guess IMHO is to always treat the buffer as "text/x":
1777 ap_xlate_proto_to_ascii(buffer, len);
1778 cntr = (apr_ssize_t)len;
1780 e = apr_bucket_heap_create(buffer, cntr, NULL, c->bucket_alloc);
1781 APR_BRIGADE_INSERT_TAIL(bb, e);
1783 /* PR 41646: get HEAD right with ProxyErrorOverride */
1784 if (ap_is_HTTP_ERROR(r->status) && dconf->error_override) {
1785 /* clear r->status for override error, otherwise ErrorDocument
1786 * thinks that this is a recursive error, and doesn't find the
1789 r->status = HTTP_OK;
1790 /* Discard body, if one is expected */
1791 if (!r->header_only && /* not HEAD request */
1792 (proxy_status != HTTP_NO_CONTENT) && /* not 204 */
1793 (proxy_status != HTTP_NOT_MODIFIED)) { /* not 304 */
1794 ap_discard_request_body(rp);
1796 return proxy_status;
1799 /* send body - but only if a body is expected */
1800 if ((!r->header_only) && /* not HEAD request */
1801 !interim_response && /* not any 1xx response */
1802 (proxy_status != HTTP_NO_CONTENT) && /* not 204 */
1803 (proxy_status != HTTP_NOT_MODIFIED)) { /* not 304 */
1805 /* We need to copy the output headers and treat them as input
1806 * headers as well. BUT, we need to do this before we remove
1807 * TE, so that they are preserved accordingly for
1808 * ap_http_filter to know where to end.
1810 rp->headers_in = apr_table_copy(r->pool, r->headers_out);
1812 * Restore Transfer-Encoding header from response if we saved
1813 * one before and there is none left. We need it for the
1814 * ap_http_filter. See above.
1816 if (te && !apr_table_get(rp->headers_in, "Transfer-Encoding")) {
1817 apr_table_add(rp->headers_in, "Transfer-Encoding", te);
1820 apr_table_unset(r->headers_out,"Transfer-Encoding");
1822 ap_log_error(APLOG_MARK, APLOG_TRACE3, 0, r->server,
1823 "proxy: start body send");
1826 * if we are overriding the errors, we can't put the content
1827 * of the page into the brigade
1829 if (!dconf->error_override || !ap_is_HTTP_ERROR(proxy_status)) {
1830 /* read the body, pass it to the output filters */
1831 apr_read_type_e mode = APR_NONBLOCK_READ;
1834 /* Handle the case where the error document is itself reverse
1835 * proxied and was successful. We must maintain any previous
1836 * error status so that an underlying error (eg HTTP_NOT_FOUND)
1837 * doesn't become an HTTP_OK.
1839 if (dconf->error_override && !ap_is_HTTP_ERROR(proxy_status)
1840 && ap_is_HTTP_ERROR(original_status)) {
1841 r->status = original_status;
1842 r->status_line = original_status_line;
1846 apr_off_t readbytes;
1849 rv = ap_get_brigade(rp->input_filters, bb,
1850 AP_MODE_READBYTES, mode,
1851 conf->io_buffer_size);
1853 /* ap_get_brigade will return success with an empty brigade
1854 * for a non-blocking read which would block: */
1855 if (APR_STATUS_IS_EAGAIN(rv)
1856 || (rv == APR_SUCCESS && APR_BRIGADE_EMPTY(bb))) {
1857 /* flush to the client and switch to blocking mode */
1858 e = apr_bucket_flush_create(c->bucket_alloc);
1859 APR_BRIGADE_INSERT_TAIL(bb, e);
1860 if (ap_pass_brigade(r->output_filters, bb)
1865 apr_brigade_cleanup(bb);
1866 mode = APR_BLOCK_READ;
1869 else if (rv == APR_EOF) {
1872 else if (rv != APR_SUCCESS) {
1873 /* In this case, we are in real trouble because
1874 * our backend bailed on us. Pass along a 502 error
1877 ap_log_cerror(APLOG_MARK, APLOG_ERR, rv, c,
1878 "proxy: error reading response");
1879 ap_proxy_backend_broke(r, bb);
1880 ap_pass_brigade(r->output_filters, bb);
1885 /* next time try a non-blocking read */
1886 mode = APR_NONBLOCK_READ;
1888 apr_brigade_length(bb, 0, &readbytes);
1889 backend->worker->s->read += readbytes;
1892 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
1893 r->server, "proxy (PID %d): readbytes: %#x",
1894 getpid(), readbytes);
1898 if (APR_BRIGADE_EMPTY(bb)) {
1899 apr_brigade_cleanup(bb);
1903 /* Switch the allocator lifetime of the buckets */
1904 ap_proxy_buckets_lifetime_transform(r, bb, pass_bb);
1905 apr_brigade_cleanup(bb);
1907 /* found the last brigade? */
1908 if (APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(pass_bb))) {
1910 /* signal that we must leave */
1913 /* make sure we release the backend connection as soon
1914 * as we know we are done, so that the backend isn't
1915 * left waiting for a slow client to eventually
1916 * acknowledge the data.
1918 ap_proxy_release_connection(backend->worker->scheme,
1919 backend, r->server);
1923 /* try send what we read */
1924 if (ap_pass_brigade(r->output_filters, pass_bb) != APR_SUCCESS
1926 /* Ack! Phbtt! Die! User aborted! */
1927 backend->close = 1; /* this causes socket close below */
1931 /* make sure we always clean up after ourselves */
1932 apr_brigade_cleanup(pass_bb);
1936 ap_log_error(APLOG_MARK, APLOG_TRACE2, 0, r->server,
1937 "proxy: end body send");
1939 else if (!interim_response) {
1940 ap_log_error(APLOG_MARK, APLOG_TRACE2, 0, r->server,
1941 "proxy: header only");
1943 /* make sure we release the backend connection as soon
1944 * as we know we are done, so that the backend isn't
1945 * left waiting for a slow client to eventually
1946 * acknowledge the data.
1948 ap_proxy_release_connection(backend->worker->scheme,
1949 backend, r->server);
1951 /* Pass EOS bucket down the filter chain. */
1952 e = apr_bucket_eos_create(c->bucket_alloc);
1953 APR_BRIGADE_INSERT_TAIL(bb, e);
1954 if (ap_pass_brigade(r->output_filters, bb) != APR_SUCCESS
1956 /* Ack! Phbtt! Die! User aborted! */
1957 backend->close = 1; /* this causes socket close below */
1960 apr_brigade_cleanup(bb);
1962 } while (interim_response && (interim_response < AP_MAX_INTERIM_RESPONSES));
1964 /* See define of AP_MAX_INTERIM_RESPONSES for why */
1965 if (interim_response >= AP_MAX_INTERIM_RESPONSES) {
1966 return ap_proxyerror(r, HTTP_BAD_GATEWAY,
1968 "Too many (%d) interim responses from origin server",
1972 /* If our connection with the client is to be aborted, return DONE. */
1973 if (c->aborted || backend_broke) {
1981 apr_status_t ap_proxy_http_cleanup(const char *scheme, request_rec *r,
1982 proxy_conn_rec *backend)
1984 ap_proxy_release_connection(scheme, backend, r->server);
1989 * This handles http:// URLs, and other URLs using a remote proxy over http
1990 * If proxyhost is NULL, then contact the server directly, otherwise
1992 * Note that if a proxy is used, then URLs other than http: can be accessed,
1993 * also, if we have trouble which is clearly specific to the proxy, then
1994 * we return DECLINED so that we can try another proxy. (Or the direct
1997 static int proxy_http_handler(request_rec *r, proxy_worker *worker,
1998 proxy_server_conf *conf,
1999 char *url, const char *proxyname,
2000 apr_port_t proxyport)
2003 char server_portstr[32];
2005 const char *proxy_function;
2007 proxy_conn_rec *backend = NULL;
2009 conn_rec *c = r->connection;
2012 * Use a shorter-lived pool to reduce memory usage
2013 * and avoid a memory leak
2015 apr_pool_t *p = r->pool;
2016 apr_uri_t *uri = apr_palloc(p, sizeof(*uri));
2018 /* find the scheme */
2019 u = strchr(url, ':');
2020 if (u == NULL || u[1] != '/' || u[2] != '/' || u[3] == '\0')
2023 return HTTP_BAD_REQUEST;
2024 scheme = apr_pstrndup(p, url, u - url);
2025 /* scheme is lowercase */
2026 ap_str_tolower(scheme);
2028 if (strcmp(scheme, "https") == 0) {
2029 if (!ap_proxy_ssl_enable(NULL)) {
2030 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
2031 "proxy: HTTPS: declining URL %s"
2032 " (mod_ssl not configured?)", url);
2036 proxy_function = "HTTPS";
2038 else if (!(strcmp(scheme, "http") == 0 || (strcmp(scheme, "ftp") == 0 && proxyname))) {
2039 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
2040 "proxy: HTTP: declining URL %s", url);
2041 return DECLINED; /* only interested in HTTP, or FTP via proxy */
2045 proxy_function = "HTTP";
2047 proxy_function = "FTP";
2049 ap_log_error(APLOG_MARK, APLOG_TRACE1, 0, r->server,
2050 "proxy: HTTP: serving URL %s", url);
2053 /* create space for state information */
2054 if ((status = ap_proxy_acquire_connection(proxy_function, &backend,
2055 worker, r->server)) != OK)
2059 backend->is_ssl = is_ssl;
2062 ap_proxy_ssl_connection_cleanup(backend, r);
2066 * In the case that we are handling a reverse proxy connection and this
2067 * is not a request that is coming over an already kept alive connection
2068 * with the client, do NOT reuse the connection to the backend, because
2069 * we cannot forward a failure to the client in this case as the client
2070 * does NOT expect this in this situation.
2071 * Yes, this creates a performance penalty.
2073 if ((r->proxyreq == PROXYREQ_REVERSE) && (!c->keepalives)
2074 && (apr_table_get(r->subprocess_env, "proxy-initial-not-pooled"))) {
2081 /* Step One: Determine Who To Connect To */
2082 if ((status = ap_proxy_determine_connection(p, r, conf, worker, backend,
2083 uri, &locurl, proxyname,
2084 proxyport, server_portstr,
2085 sizeof(server_portstr))) != OK)
2088 /* Step Two: Make the Connection */
2089 if (ap_proxy_connect_backend(proxy_function, backend, worker, r->server)) {
2090 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
2091 "proxy: HTTP: failed to make connection to backend: %s",
2093 status = HTTP_SERVICE_UNAVAILABLE;
2097 /* Step Three: Create conn_rec */
2098 if (!backend->connection) {
2099 if ((status = ap_proxy_connection_create(proxy_function, backend,
2100 c, r->server)) != OK)
2103 * On SSL connections set a note on the connection what CN is
2104 * requested, such that mod_ssl can check if it is requested to do
2108 apr_table_set(backend->connection->notes, "proxy-request-hostname",
2113 /* Step Four: Send the Request
2114 * On the off-chance that we forced a 100-Continue as a
2115 * kinda HTTP ping test, allow for retries
2117 if ((status = ap_proxy_http_request(p, r, backend, worker,
2118 conf, uri, locurl, server_portstr)) != OK) {
2119 if ((status == HTTP_SERVICE_UNAVAILABLE) && worker->ping_timeout_set) {
2121 ap_log_error(APLOG_MARK, APLOG_INFO, status, r->server,
2122 "proxy: HTTP: 100-Continue failed to %pI (%s)",
2123 worker->cp->addr, worker->hostname);
2132 /* Step Five: Receive the Response... Fall thru to cleanup */
2133 status = ap_proxy_http_process_response(p, r, backend, worker,
2134 conf, server_portstr);
2139 /* Step Six: Clean Up */
2144 ap_proxy_http_cleanup(proxy_function, r, backend);
2148 static void ap_proxy_http_register_hook(apr_pool_t *p)
2150 proxy_hook_scheme_handler(proxy_http_handler, NULL, NULL, APR_HOOK_FIRST);
2151 proxy_hook_canon_handler(proxy_http_canon, NULL, NULL, APR_HOOK_FIRST);
2152 warn_rx = ap_pregcomp(p, "[0-9]{3}[ \t]+[^ \t]+[ \t]+\"[^\"]*\"([ \t]+\"([^\"]+)\")?", 0);
2155 AP_DECLARE_MODULE(proxy_http) = {
2156 STANDARD20_MODULE_STUFF,
2157 NULL, /* create per-directory config structure */
2158 NULL, /* merge per-directory config structures */
2159 NULL, /* create per-server config structure */
2160 NULL, /* merge per-server config structures */
2161 NULL, /* command apr_table_t */
2162 ap_proxy_http_register_hook/* register hooks */