5 * DEBUG: section 11 Hypertext Transfer Protocol (HTTP)
6 * AUTHOR: Harvest Derived
8 * SQUID Web Proxy Cache http://www.squid-cache.org/
9 * ----------------------------------------------------------
11 * Squid is the result of efforts by numerous individuals from
12 * the Internet community; see the CONTRIBUTORS file for full
13 * details. Many organizations have provided support for Squid's
14 * development; see the SPONSORS file for full details. Squid is
15 * Copyrighted (C) 2001 by the Regents of the University of
16 * California; see the COPYRIGHT file for full details. Squid
17 * incorporates software developed and/or copyrighted by other
18 * sources; see the CREDITS file for full details.
20 * This program is free software; you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation; either version 2 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program; if not, write to the Free Software
32 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
37 * Anonymizing patch by lutz@as-node.jena.thur.de
38 * have a look into http-anon.c to get more informations.
43 #include "acl/FilledChecklist.h"
44 #include "auth/UserRequest.h"
45 #include "base/TextException.h"
47 #include "DelayPools.h"
49 #include "errorpage.h"
52 #include "HttpHdrContRange.h"
53 #include "HttpHdrSc.h"
54 #include "HttpHdrScTarget.h"
55 #include "HttpReply.h"
56 #include "HttpRequest.h"
58 #include "MemObject.h"
61 #include "SquidTime.h"
65 #define SQUID_ENTER_THROWING_CODE() try {
66 #define SQUID_EXIT_THROWING_CODE(status) \
69 catch (const std::exception &e) { \
70 debugs (11, 1, "Exception error:" << e.what()); \
74 CBDATA_CLASS_INIT(HttpStateData
);
76 static const char *const crlf
= "\r\n";
78 static void httpMaybeRemovePublic(StoreEntry
*, http_status
);
79 static void copyOneHeaderFromClientsideRequestToUpstreamRequest(const HttpHeaderEntry
*e
, const String strConnection
, HttpRequest
* request
, const HttpRequest
* orig_request
,
80 HttpHeader
* hdr_out
, const int we_do_ranges
, const http_state_flags
);
82 HttpStateData::HttpStateData(FwdState
*theFwdState
) : AsyncJob("HttpStateData"), ServerStateData(theFwdState
),
83 lastChunk(0), header_bytes_read(0), reply_bytes_read(0),
84 body_bytes_truncated(0), httpChunkDecoder(NULL
)
86 debugs(11,5,HERE
<< "HttpStateData " << this << " created");
87 ignoreCacheControl
= false;
88 surrogateNoStore
= false;
92 orig_request
= HTTPMSGLOCK(fwd
->request
);
94 // reset peer response time stats for %<pt
95 orig_request
->hier
.peer_http_request_sent
.tv_sec
= 0;
96 orig_request
->hier
.peer_http_request_sent
.tv_usec
= 0;
99 _peer
= fwd
->servers
->_peer
; /* might be NULL */
104 if (_peer
->options
.originserver
)
105 url
= orig_request
->urlpath
.termedBuf();
109 HttpRequest
* proxy_req
= new HttpRequest(orig_request
->method
,
110 orig_request
->protocol
, url
);
112 proxy_req
->SetHost(_peer
->host
);
114 proxy_req
->port
= _peer
->http_port
;
116 proxy_req
->flags
= orig_request
->flags
;
118 proxy_req
->lastmod
= orig_request
->lastmod
;
120 proxy_req
->flags
.proxying
= 1;
122 HTTPMSGUNLOCK(request
);
124 request
= HTTPMSGLOCK(proxy_req
);
127 * This NEIGHBOR_PROXY_ONLY check probably shouldn't be here.
128 * We might end up getting the object from somewhere else if,
129 * for example, the request to this neighbor fails.
131 if (_peer
->options
.proxy_only
)
132 entry
->releaseRequest();
136 entry
->setNoDelay(_peer
->options
.no_delay
);
142 * register the handler to free HTTP state data when the FD closes
144 typedef CommCbMemFunT
<HttpStateData
, CommCloseCbParams
> Dialer
;
145 closeHandler
= JobCallback(9, 5,
146 Dialer
, this, HttpStateData::httpStateConnClosed
);
147 comm_add_close_handler(fd
, closeHandler
);
150 HttpStateData::~HttpStateData()
153 * don't forget that ~ServerStateData() gets called automatically
156 if (!readBuf
->isNull())
161 if (httpChunkDecoder
)
162 delete httpChunkDecoder
;
164 HTTPMSGUNLOCK(orig_request
);
166 debugs(11,5, HERE
<< "HttpStateData " << this << " destroyed; FD " << fd
);
170 HttpStateData::dataDescriptor() const
176 httpStateFree(int fd, void *data)
178 HttpStateData *httpState = static_cast<HttpStateData *>(data);
179 debugs(11, 5, "httpStateFree: FD " << fd << ", httpState=" << data);
184 HttpStateData::httpStateConnClosed(const CommCloseCbParams
¶ms
)
186 debugs(11, 5, "httpStateFree: FD " << params
.fd
<< ", httpState=" << params
.data
);
187 deleteThis("HttpStateData::httpStateConnClosed");
191 httpCachable(const HttpRequestMethod
& method
)
193 /* GET and HEAD are cachable. Others are not. */
195 // TODO: replase to HttpRequestMethod::isCachable() ?
196 if (method
!= METHOD_GET
&& method
!= METHOD_HEAD
)
204 HttpStateData::httpTimeout(const CommTimeoutCbParams
¶ms
)
206 debugs(11, 4, "httpTimeout: FD " << fd
<< ": '" << entry
->url() << "'" );
208 if (entry
->store_status
== STORE_PENDING
) {
209 fwd
->fail(errorCon(ERR_READ_TIMEOUT
, HTTP_GATEWAY_TIMEOUT
, fwd
->request
));
216 httpMaybeRemovePublic(StoreEntry
* e
, http_status status
)
222 if (!EBIT_TEST(e
->flags
, KEY_PRIVATE
))
229 case HTTP_NON_AUTHORITATIVE_INFORMATION
:
231 case HTTP_MULTIPLE_CHOICES
:
233 case HTTP_MOVED_PERMANENTLY
:
235 case HTTP_MOVED_TEMPORARILY
:
246 case HTTP_METHOD_NOT_ALLOWED
:
253 case HTTP_UNAUTHORIZED
:
263 * Any 2xx response should eject previously cached entities...
266 if (status
>= 200 && status
< 300)
274 if (!remove
&& !forbidden
)
279 if (e
->mem_obj
->request
)
280 pe
= storeGetPublicByRequest(e
->mem_obj
->request
);
282 pe
= storeGetPublic(e
->mem_obj
->url
, e
->mem_obj
->method
);
287 neighborsHtcpClear(e
, NULL
, e
->mem_obj
->request
, e
->mem_obj
->method
, HTCP_CLR_INVALIDATION
);
293 * Also remove any cached HEAD response in case the object has
296 if (e
->mem_obj
->request
)
297 pe
= storeGetPublicByRequestMethod(e
->mem_obj
->request
, METHOD_HEAD
);
299 pe
= storeGetPublic(e
->mem_obj
->url
, METHOD_HEAD
);
304 neighborsHtcpClear(e
, NULL
, e
->mem_obj
->request
, HttpRequestMethod(METHOD_HEAD
), HTCP_CLR_INVALIDATION
);
311 HttpStateData::processSurrogateControl(HttpReply
*reply
)
313 if (request
->flags
.accelerated
&& reply
->surrogate_control
) {
314 HttpHdrScTarget
*sctusable
= httpHdrScGetMergedTarget(reply
->surrogate_control
, Config
.Accel
.surrogate_id
);
317 if (EBIT_TEST(sctusable
->mask
, SC_NO_STORE
) ||
318 (Config
.onoff
.surrogate_is_remote
319 && EBIT_TEST(sctusable
->mask
, SC_NO_STORE_REMOTE
))) {
320 surrogateNoStore
= true;
321 entry
->makePrivate();
324 /* The HttpHeader logic cannot tell if the header it's parsing is a reply to an
325 * accelerated request or not...
326 * Still, this is an abstraction breach. - RC
328 if (sctusable
->max_age
!= -1) {
329 if (sctusable
->max_age
< sctusable
->max_stale
)
330 reply
->expires
= reply
->date
+ sctusable
->max_age
;
332 reply
->expires
= reply
->date
+ sctusable
->max_stale
;
334 /* And update the timestamps */
335 entry
->timestampsSet();
338 /* We ignore cache-control directives as per the Surrogate specification */
339 ignoreCacheControl
= true;
341 httpHdrScTargetDestroy(sctusable
);
347 HttpStateData::cacheableReply()
349 HttpReply
const *rep
= finalReply();
350 HttpHeader
const *hdr
= &rep
->header
;
351 const int cc_mask
= (rep
->cache_control
) ? rep
->cache_control
->mask
: 0;
353 #if USE_HTTP_VIOLATIONS
355 const refresh_t
*R
= NULL
;
357 /* This strange looking define first looks up the refresh pattern
358 * and then checks if the specified flag is set. The main purpose
359 * of this is to simplify the refresh pattern lookup and USE_HTTP_VIOLATIONS
362 #define REFRESH_OVERRIDE(flag) \
363 ((R = (R ? R : refreshLimits(entry->mem_obj->url))) , \
364 (R && R->flags.flag))
366 #define REFRESH_OVERRIDE(flag) 0
369 if (surrogateNoStore
)
372 if (!ignoreCacheControl
) {
373 if (EBIT_TEST(cc_mask
, CC_PRIVATE
)) {
374 if (!REFRESH_OVERRIDE(ignore_private
))
378 if (EBIT_TEST(cc_mask
, CC_NO_CACHE
)) {
379 if (!REFRESH_OVERRIDE(ignore_no_cache
))
383 if (EBIT_TEST(cc_mask
, CC_NO_STORE
)) {
384 if (!REFRESH_OVERRIDE(ignore_no_store
))
389 if (request
->flags
.auth
|| request
->flags
.auth_sent
) {
391 * Responses to requests with authorization may be cached
392 * only if a Cache-Control: public reply header is present.
393 * RFC 2068, sec 14.9.4
396 if (!EBIT_TEST(cc_mask
, CC_PUBLIC
)) {
397 if (!REFRESH_OVERRIDE(ignore_auth
))
402 /* Pragma: no-cache in _replies_ is not documented in HTTP,
403 * but servers like "Active Imaging Webcast/2.0" sure do use it */
404 if (hdr
->has(HDR_PRAGMA
)) {
405 String s
= hdr
->getList(HDR_PRAGMA
);
406 const int no_cache
= strListIsMember(&s
, "no-cache", ',');
410 if (!REFRESH_OVERRIDE(ignore_no_cache
))
416 * The "multipart/x-mixed-replace" content type is used for
417 * continuous push replies. These are generally dynamic and
418 * probably should not be cachable
420 if ((v
= hdr
->getStr(HDR_CONTENT_TYPE
)))
421 if (!strncasecmp(v
, "multipart/x-mixed-replace", 25))
424 switch (rep
->sline
.status
) {
425 /* Responses that are cacheable */
429 case HTTP_NON_AUTHORITATIVE_INFORMATION
:
431 case HTTP_MULTIPLE_CHOICES
:
433 case HTTP_MOVED_PERMANENTLY
:
437 * Don't cache objects that need to be refreshed on next request,
438 * unless we know how to refresh it.
441 if (!refreshIsCachable(entry
) && !REFRESH_OVERRIDE(store_stale
)) {
442 debugs(22, 3, "refreshIsCachable() returned non-cacheable..");
450 /* Responses that only are cacheable if the server says so */
452 case HTTP_MOVED_TEMPORARILY
:
453 case HTTP_TEMPORARY_REDIRECT
:
454 if (rep
->expires
> rep
->date
&& rep
->date
> 0)
462 /* Errors can be negatively cached */
464 case HTTP_NO_CONTENT
:
468 case HTTP_BAD_REQUEST
:
474 case HTTP_METHOD_NOT_ALLOWED
:
476 case HTTP_REQUEST_URI_TOO_LARGE
:
478 case HTTP_INTERNAL_SERVER_ERROR
:
480 case HTTP_NOT_IMPLEMENTED
:
482 case HTTP_BAD_GATEWAY
:
484 case HTTP_SERVICE_UNAVAILABLE
:
486 case HTTP_GATEWAY_TIMEOUT
:
492 /* Some responses can never be cached */
494 case HTTP_PARTIAL_CONTENT
: /* Not yet supported */
498 case HTTP_NOT_MODIFIED
:
500 case HTTP_UNAUTHORIZED
:
502 case HTTP_PROXY_AUTHENTICATION_REQUIRED
:
504 case HTTP_INVALID_HEADER
: /* Squid header parsing error */
506 case HTTP_HEADER_TOO_LARGE
:
508 case HTTP_PAYMENT_REQUIRED
:
509 case HTTP_NOT_ACCEPTABLE
:
510 case HTTP_REQUEST_TIMEOUT
:
512 case HTTP_LENGTH_REQUIRED
:
513 case HTTP_PRECONDITION_FAILED
:
514 case HTTP_REQUEST_ENTITY_TOO_LARGE
:
515 case HTTP_UNSUPPORTED_MEDIA_TYPE
:
516 case HTTP_UNPROCESSABLE_ENTITY
:
518 case HTTP_FAILED_DEPENDENCY
:
519 case HTTP_INSUFFICIENT_STORAGE
:
520 case HTTP_REQUESTED_RANGE_NOT_SATISFIABLE
:
521 case HTTP_EXPECTATION_FAILED
:
526 /* RFC 2616 section 6.1.1: an unrecognized response MUST NOT be cached. */
527 debugs (11, 3, HERE
<< "Unknown HTTP status code " << rep
->sline
.status
<< ". Not cacheable.");
539 * For Vary, store the relevant request headers as
540 * virtual headers in the reply
541 * Returns false if the variance cannot be stored
544 httpMakeVaryMark(HttpRequest
* request
, HttpReply
const * reply
)
547 const char *pos
= NULL
;
554 vary
= reply
->header
.getList(HDR_VARY
);
556 while (strListGetItem(&vary
, ',', &item
, &ilen
, &pos
)) {
557 char *name
= (char *)xmalloc(ilen
+ 1);
558 xstrncpy(name
, item
, ilen
+ 1);
561 if (strcmp(name
, "*") == 0) {
562 /* Can not handle "Vary: *" withtout ETag support */
568 strListAdd(&vstr
, name
, ',');
569 hdr
= request
->header
.getByName(name
);
571 value
= hdr
.termedBuf();
574 value
= rfc1738_escape_part(value
);
575 vstr
.append("=\"", 2);
577 vstr
.append("\"", 1);
584 #if X_ACCELERATOR_VARY
587 vary
= reply
->header
.getList(HDR_X_ACCELERATOR_VARY
);
589 while (strListGetItem(&vary
, ',', &item
, &ilen
, &pos
)) {
590 char *name
= (char *)xmalloc(ilen
+ 1);
591 xstrncpy(name
, item
, ilen
+ 1);
593 strListAdd(&vstr
, name
, ',');
594 hdr
= request
->header
.getByName(name
);
596 value
= hdr
.termedBuf();
599 value
= rfc1738_escape_part(value
);
600 vstr
.append("=\"", 2);
602 vstr
.append("\"", 1);
611 debugs(11, 3, "httpMakeVaryMark: " << vstr
);
612 return vstr
.termedBuf();
616 HttpStateData::keepaliveAccounting(HttpReply
*reply
)
620 _peer
->stats
.n_keepalives_sent
++;
622 if (reply
->keep_alive
) {
624 _peer
->stats
.n_keepalives_recv
++;
626 if (Config
.onoff
.detect_broken_server_pconns
627 && reply
->bodySize(request
->method
) == -1 && !flags
.chunked
) {
628 debugs(11, 1, "keepaliveAccounting: Impossible keep-alive header from '" << entry
->url() << "'" );
629 // debugs(11, 2, "GOT HTTP REPLY HDR:\n---------\n" << readBuf->content() << "\n----------" );
630 flags
.keepalive_broken
= 1;
636 HttpStateData::checkDateSkew(HttpReply
*reply
)
638 if (reply
->date
> -1 && !_peer
) {
639 int skew
= abs((int)(reply
->date
- squid_curtime
));
642 debugs(11, 3, "" << request
->GetHost() << "'s clock is skewed by " << skew
<< " seconds!");
647 * This creates the error page itself.. its likely
648 * that the forward ported reply header max size patch
649 * generates non http conformant error pages - in which
650 * case the errors where should be 'BAD_GATEWAY' etc
653 HttpStateData::processReplyHeader()
655 /** Creates a blank header. If this routine is made incremental, this will not do */
657 /* NP: all exit points to this function MUST call ctx_exit(ctx) */
658 Ctx ctx
= ctx_enter(entry
->mem_obj
->url
);
660 debugs(11, 3, "processReplyHeader: key '" << entry
->getMD5Text() << "'");
662 assert(!flags
.headers_parsed
);
664 if (!readBuf
->hasContent()) {
669 http_status error
= HTTP_STATUS_NONE
;
671 HttpReply
*newrep
= new HttpReply
;
672 const bool parsed
= newrep
->parse(readBuf
, eof
, &error
);
674 if (!parsed
&& readBuf
->contentSize() > 5 && strncmp(readBuf
->content(), "HTTP/", 5) != 0 && strncmp(readBuf
->content(), "ICY", 3) != 0) {
676 HttpReply
*tmprep
= new HttpReply
;
677 tmprep
->setHeaders(HTTP_OK
, "Gatewaying", NULL
, -1, -1, -1);
678 tmprep
->header
.putExt("X-Transformed-From", "HTTP/0.9");
680 newrep
->parse(mb
, eof
, &error
);
683 if (!parsed
&& error
> 0) { // unrecoverable parsing error
684 debugs(11, 3, "processReplyHeader: Non-HTTP-compliant header: '" << readBuf
->content() << "'");
685 flags
.headers_parsed
= 1;
686 newrep
->sline
.version
= HttpVersion(1,1);
687 newrep
->sline
.status
= error
;
688 HttpReply
*vrep
= setVirginReply(newrep
);
689 entry
->replaceHttpReply(vrep
);
694 if (!parsed
) { // need more data
702 debugs(11, 9, "GOT HTTP REPLY HDR:\n---------\n" << readBuf
->content() << "\n----------");
704 header_bytes_read
= headersEnd(readBuf
->content(), readBuf
->contentSize());
705 readBuf
->consume(header_bytes_read
);
708 /* Skip 1xx messages for now. Advertised in Via as an internal 1.0 hop */
709 if (newrep
->sline
.protocol
== PROTO_HTTP
&& newrep
->sline
.status
>= 100 && newrep
->sline
.status
< 200) {
711 #if WHEN_HTTP11_EXPECT_HANDLED
712 /* When HTTP/1.1 check if the client is expecting a 1xx reply and maybe pass it on */
713 if (orig_request
->header
.has(HDR_EXPECT
)) {
714 // TODO: pass to the client anyway?
718 debugs(11, 2, HERE
<< "1xx headers consume " << header_bytes_read
<< " bytes header.");
719 header_bytes_read
= 0;
720 if (reply_bytes_read
> 0)
721 debugs(11, 2, HERE
<< "1xx headers consume " << reply_bytes_read
<< " bytes reply.");
722 reply_bytes_read
= 0;
724 processReplyHeader();
729 if (newrep
->sline
.protocol
== PROTO_HTTP
&& newrep
->header
.hasListMember(HDR_TRANSFER_ENCODING
, "chunked", ',')) {
731 httpChunkDecoder
= new ChunkedCodingParser
;
734 if (!peerSupportsConnectionPinning())
735 orig_request
->flags
.connection_auth_disabled
= 1;
737 HttpReply
*vrep
= setVirginReply(newrep
);
738 flags
.headers_parsed
= 1;
740 keepaliveAccounting(vrep
);
744 processSurrogateControl (vrep
);
746 /** \todo IF the reply is a 1.0 reply, AND it has a Connection: Header
747 * Parse the header and remove all referenced headers
750 orig_request
->hier
.peer_reply_status
= newrep
->sline
.status
;
756 * returns true if the peer can support connection pinning
758 bool HttpStateData::peerSupportsConnectionPinning() const
760 const HttpReply
*rep
= entry
->mem_obj
->getReply();
761 const HttpHeader
*hdr
= &rep
->header
;
768 /*If this peer does not support connection pinning (authenticated
769 connections) return false
771 if (!_peer
->connection_auth
)
774 /*The peer supports connection pinning and the http reply status
775 is not unauthorized, so the related connection can be pinned
777 if (rep
->sline
.status
!= HTTP_UNAUTHORIZED
)
780 /*The server respond with HTTP_UNAUTHORIZED and the peer configured
781 with "connection-auth=on" we know that the peer supports pinned
784 if (_peer
->connection_auth
== 1)
787 /*At this point peer has configured with "connection-auth=auto"
788 parameter so we need some extra checks to decide if we are going
789 to allow pinned connections or not
792 /*if the peer configured with originserver just allow connection
793 pinning (squid 2.6 behaviour)
795 if (_peer
->options
.originserver
)
798 /*if the connections it is already pinned it is OK*/
799 if (request
->flags
.pinned
)
802 /*Allow pinned connections only if the Proxy-support header exists in
803 reply and has in its list the "Session-Based-Authentication"
804 which means that the peer supports connection pinning.
806 if (!hdr
->has(HDR_PROXY_SUPPORT
))
809 header
= hdr
->getStrOrList(HDR_PROXY_SUPPORT
);
810 /* XXX This ought to be done in a case-insensitive manner */
811 rc
= (strstr(header
.termedBuf(), "Session-Based-Authentication") != NULL
);
816 // Called when we parsed (and possibly adapted) the headers but
817 // had not starting storing (a.k.a., sending) the body yet.
819 HttpStateData::haveParsedReplyHeaders()
821 ServerStateData::haveParsedReplyHeaders();
823 Ctx ctx
= ctx_enter(entry
->mem_obj
->url
);
824 HttpReply
*rep
= finalReply();
826 if (rep
->sline
.status
== HTTP_PARTIAL_CONTENT
&&
828 currentOffset
= rep
->content_range
->spec
.offset
;
830 entry
->timestampsSet();
832 /* Check if object is cacheable or not based on reply code */
833 debugs(11, 3, "haveParsedReplyHeaders: HTTP CODE: " << rep
->sline
.status
);
835 if (neighbors_do_private_keys
)
836 httpMaybeRemovePublic(entry
, rep
->sline
.status
);
838 if (rep
->header
.has(HDR_VARY
)
839 #if X_ACCELERATOR_VARY
840 || rep
->header
.has(HDR_X_ACCELERATOR_VARY
)
843 const char *vary
= httpMakeVaryMark(orig_request
, rep
);
846 entry
->makePrivate();
847 if (!fwd
->reforwardableStatus(rep
->sline
.status
))
848 EBIT_CLR(entry
->flags
, ENTRY_FWD_HDR_WAIT
);
852 entry
->mem_obj
->vary_headers
= xstrdup(vary
);
860 * If its not a reply that we will re-forward, then
861 * allow the client to get it.
863 if (!fwd
->reforwardableStatus(rep
->sline
.status
))
864 EBIT_CLR(entry
->flags
, ENTRY_FWD_HDR_WAIT
);
866 switch (cacheableReply()) {
873 entry
->makePrivate();
878 #if USE_HTTP_VIOLATIONS
879 if (Config
.negativeTtl
> 0)
880 entry
->cacheNegatively();
883 entry
->makePrivate();
895 if (!ignoreCacheControl
&& rep
->cache_control
) {
896 if (EBIT_TEST(rep
->cache_control
->mask
, CC_PROXY_REVALIDATE
))
897 EBIT_SET(entry
->flags
, ENTRY_REVALIDATE
);
898 else if (EBIT_TEST(rep
->cache_control
->mask
, CC_MUST_REVALIDATE
))
899 EBIT_SET(entry
->flags
, ENTRY_REVALIDATE
);
903 headersLog(1, 0, request
->method
, rep
);
910 HttpStateData::ConnectionStatus
911 HttpStateData::statusIfComplete() const
913 const HttpReply
*rep
= virginReply();
915 * If the reply wants to close the connection, it takes precedence */
917 if (httpHeaderHasConnDir(&rep
->header
, "close"))
918 return COMPLETE_NONPERSISTENT_MSG
;
921 * If we didn't send a keep-alive request header, then this
922 * can not be a persistent connection.
924 if (!flags
.keepalive
)
925 return COMPLETE_NONPERSISTENT_MSG
;
928 * If we haven't sent the whole request then this can not be a persistent
931 if (!flags
.request_sent
) {
932 debugs(11, 1, "statusIfComplete: Request not yet fully sent \"" << RequestMethodStr(orig_request
->method
) << " " << entry
->url() << "\"" );
933 return COMPLETE_NONPERSISTENT_MSG
;
937 * What does the reply have to say about keep-alive?
941 * If the origin server (HTTP/1.0) does not send a keep-alive
942 * header, but keeps the connection open anyway, what happens?
943 * We'll return here and http.c waits for an EOF before changing
944 * store_status to STORE_OK. Combine this with ENTRY_FWD_HDR_WAIT
945 * and an error status code, and we might have to wait until
946 * the server times out the socket.
948 if (!rep
->keep_alive
)
949 return COMPLETE_NONPERSISTENT_MSG
;
951 return COMPLETE_PERSISTENT_MSG
;
954 HttpStateData::ConnectionStatus
955 HttpStateData::persistentConnStatus() const
957 debugs(11, 3, "persistentConnStatus: FD " << fd
<< " eof=" << eof
);
958 const HttpReply
*vrep
= virginReply();
959 debugs(11, 5, "persistentConnStatus: content_length=" << vrep
->content_length
);
961 /* If we haven't seen the end of reply headers, we are not done */
962 debugs(11, 5, "persistentConnStatus: flags.headers_parsed=" << flags
.headers_parsed
);
964 if (!flags
.headers_parsed
)
965 return INCOMPLETE_MSG
;
967 if (eof
) // already reached EOF
968 return COMPLETE_NONPERSISTENT_MSG
;
971 * In chunked response we do not know the content length but we are absolutely
972 * sure about the end of response, so we are calling the statusIfComplete to
973 * decide if we can be persistant
975 if (lastChunk
&& flags
.chunked
)
976 return statusIfComplete();
978 const int64_t clen
= vrep
->bodySize(request
->method
);
980 debugs(11, 5, "persistentConnStatus: clen=" << clen
);
982 /* If the body size is unknown we must wait for EOF */
984 return INCOMPLETE_MSG
;
987 * If the body size is known, we must wait until we've gotten all of it. */
990 // if (entry->mem_obj->endOffset() < vrep->content_length + vrep->hdr_sz)
991 const int64_t body_bytes_read
= reply_bytes_read
- header_bytes_read
;
992 debugs(11,5, "persistentConnStatus: body_bytes_read=" <<
993 body_bytes_read
<< " content_length=" << vrep
->content_length
);
995 if (body_bytes_read
< vrep
->content_length
)
996 return INCOMPLETE_MSG
;
998 if (body_bytes_truncated
> 0) // already read more than needed
999 return COMPLETE_NONPERSISTENT_MSG
; // disable pconns
1003 * If there is no message body or we got it all, we can be persistent */
1004 return statusIfComplete();
1008 * This is the callback after some data has been read from the network
1012 HttpStateData::ReadReplyWrapper(int fd, char *buf, size_t len, comm_err_t flag, int xerrno, void *data)
1014 HttpStateData *httpState = static_cast<HttpStateData *>(data);
1015 assert (fd == httpState->fd);
1016 // assert(buf == readBuf->content());
1017 PROF_start(HttpStateData_readReply);
1018 httpState->readReply(len, flag, xerrno);
1019 PROF_stop(HttpStateData_readReply);
1023 /* XXX this function is too long! */
1025 HttpStateData::readReply(const CommIoCbParams
&io
)
1031 assert(fd
== io
.fd
);
1033 flags
.do_next_read
= 0;
1035 debugs(11, 5, "httpReadReply: FD " << fd
<< ": len " << len
<< ".");
1037 // Bail out early on COMM_ERR_CLOSING - close handlers will tidy up for us
1038 if (io
.flag
== COMM_ERR_CLOSING
) {
1039 debugs(11, 3, "http socket closing");
1043 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
)) {
1044 maybeReadVirginBody();
1048 // handle I/O errors
1049 if (io
.flag
!= COMM_OK
|| len
< 0) {
1050 debugs(11, 2, "httpReadReply: FD " << fd
<< ": read failure: " << xstrerror() << ".");
1052 if (ignoreErrno(io
.xerrno
)) {
1053 flags
.do_next_read
= 1;
1056 err
= errorCon(ERR_READ_ERROR
, HTTP_BAD_GATEWAY
, fwd
->request
);
1057 err
->xerrno
= io
.xerrno
;
1059 flags
.do_next_read
= 0;
1068 readBuf
->appended(len
);
1069 reply_bytes_read
+= len
;
1072 DelayId delayId
= entry
->mem_obj
->mostBytesAllowed();
1073 delayId
.bytesIn(len
);
1076 kb_incr(&statCounter
.server
.all
.kbytes_in
, len
);
1077 kb_incr(&statCounter
.server
.http
.kbytes_in
, len
);
1078 IOStats
.Http
.reads
++;
1080 for (clen
= len
- 1, bin
= 0; clen
; bin
++)
1083 IOStats
.Http
.read_hist
[bin
]++;
1085 // update peer response time stats (%<pt)
1086 const timeval
&sent
= orig_request
->hier
.peer_http_request_sent
;
1087 orig_request
->hier
.peer_response_time
=
1088 sent
.tv_sec
? tvSubMsec(sent
, current_time
) : -1;
1092 * Here the RFC says we should ignore whitespace between replies, but we can't as
1093 * doing so breaks HTTP/0.9 replies beginning with witespace, and in addition
1094 * the response splitting countermeasures is extremely likely to trigger on this,
1095 * not allowing connection reuse in the first place.
1098 if (!flags
.headers_parsed
&& len
> 0 && fd_table
[fd
].uses
> 1) {
1099 /* Skip whitespace between replies */
1101 while (len
> 0 && xisspace(*buf
))
1102 xmemmove(buf
, buf
+ 1, len
--);
1105 /* Continue to read... */
1106 /* Timeout NOT increased. This whitespace was from previous reply */
1107 flags
.do_next_read
= 1;
1108 maybeReadVirginBody();
1115 if (len
== 0) { // reached EOF?
1117 flags
.do_next_read
= 0;
1119 /* Bug 2879: Replies may terminate with \r\n then EOF instead of \r\n\r\n
1120 * Ensure here that we have at minimum two \r\n when EOF is seen.
1121 * TODO: Add eof parameter to headersEnd() and move this hack there.
1123 if (readBuf
->contentSize() && !flags
.headers_parsed
) {
1125 * Yes Henrik, there is a point to doing this. When we
1126 * called httpProcessReplyHeader() before, we didn't find
1127 * the end of headers, but now we are definately at EOF, so
1128 * we want to process the reply headers.
1130 /* Fake an "end-of-headers" to work around such broken servers */
1131 readBuf
->append("\r\n", 2);
1135 if (!flags
.headers_parsed
) { // have not parsed headers yet?
1136 PROF_start(HttpStateData_processReplyHeader
);
1137 processReplyHeader();
1138 PROF_stop(HttpStateData_processReplyHeader
);
1140 if (!continueAfterParsingHeader()) // parsing error or need more data
1141 return; // TODO: send errors to ICAP
1143 adaptOrFinalizeReply();
1146 // kick more reads if needed and/or process the response body, if any
1147 PROF_start(HttpStateData_processReplyBody
);
1148 processReplyBody(); // may call serverComplete()
1149 PROF_stop(HttpStateData_processReplyBody
);
1153 \retval true if we can continue with processing the body or doing ICAP.
1156 HttpStateData::continueAfterParsingHeader()
1158 if (!flags
.headers_parsed
&& !eof
) {
1159 debugs(11, 9, HERE
<< "needs more at " << readBuf
->contentSize());
1160 flags
.do_next_read
= 1;
1161 /** \retval false If we have not finished parsing the headers and may get more data.
1162 * Schedules more reads to retrieve the missing data.
1164 maybeReadVirginBody(); // schedules all kinds of reads; TODO: rename
1168 /** If we are done with parsing, check for errors */
1170 err_type error
= ERR_NONE
;
1172 if (flags
.headers_parsed
) { // parsed headers, possibly with errors
1173 // check for header parsing errors
1174 if (HttpReply
*vrep
= virginReply()) {
1175 const http_status s
= vrep
->sline
.status
;
1176 const HttpVersion
&v
= vrep
->sline
.version
;
1177 if (s
== HTTP_INVALID_HEADER
&& v
!= HttpVersion(0,9)) {
1178 debugs(11, DBG_IMPORTANT
, "WARNING: HTTP: Invalid Response: Bad header encountered from " << entry
->url() << " AKA " << orig_request
->GetHost() << orig_request
->urlpath
.termedBuf() );
1179 error
= ERR_INVALID_RESP
;
1180 } else if (s
== HTTP_HEADER_TOO_LARGE
) {
1181 fwd
->dontRetry(true);
1182 error
= ERR_TOO_BIG
;
1184 return true; // done parsing, got reply, and no error
1187 // parsed headers but got no reply
1188 debugs(11, DBG_IMPORTANT
, "WARNING: HTTP: Invalid Response: No reply at all for " << entry
->url() << " AKA " << orig_request
->GetHost() << orig_request
->urlpath
.termedBuf() );
1189 error
= ERR_INVALID_RESP
;
1193 if (readBuf
->hasContent()) {
1194 error
= ERR_INVALID_RESP
;
1195 debugs(11, DBG_IMPORTANT
, "WARNING: HTTP: Invalid Response: Headers did not parse at all for " << entry
->url() << " AKA " << orig_request
->GetHost() << orig_request
->urlpath
.termedBuf() );
1197 error
= ERR_ZERO_SIZE_OBJECT
;
1198 debugs(11, (orig_request
->flags
.accelerated
?DBG_IMPORTANT
:2), "WARNING: HTTP: Invalid Response: No object data received for " <<
1199 entry
->url() << " AKA " << orig_request
->GetHost() << orig_request
->urlpath
.termedBuf() );
1203 assert(error
!= ERR_NONE
);
1205 fwd
->fail(errorCon(error
, HTTP_BAD_GATEWAY
, fwd
->request
));
1206 flags
.do_next_read
= 0;
1208 return false; // quit on error
1211 /** truncate what we read if we read too much so that writeReplyBody()
1212 writes no more than what we should have read */
1214 HttpStateData::truncateVirginBody()
1216 assert(flags
.headers_parsed
);
1218 HttpReply
*vrep
= virginReply();
1220 if (!vrep
->expectingBody(request
->method
, clen
) || clen
< 0)
1221 return; // no body or a body of unknown size, including chunked
1223 const int64_t body_bytes_read
= reply_bytes_read
- header_bytes_read
;
1224 if (body_bytes_read
- body_bytes_truncated
<= clen
)
1225 return; // we did not read too much or already took care of the extras
1227 if (const int64_t extras
= body_bytes_read
- body_bytes_truncated
- clen
) {
1228 // server sent more that the advertised content length
1229 debugs(11,5, HERE
<< "body_bytes_read=" << body_bytes_read
<<
1230 " clen=" << clen
<< '/' << vrep
->content_length
<<
1231 " body_bytes_truncated=" << body_bytes_truncated
<< '+' << extras
);
1233 readBuf
->truncate(extras
);
1234 body_bytes_truncated
+= extras
;
1239 * Call this when there is data from the origin server
1240 * which should be sent to either StoreEntry, or to ICAP...
1243 HttpStateData::writeReplyBody()
1245 truncateVirginBody(); // if needed
1246 const char *data
= readBuf
->content();
1247 int len
= readBuf
->contentSize();
1248 addVirginReplyBody(data
, len
);
1249 readBuf
->consume(len
);
1253 HttpStateData::decodeAndWriteReplyBody()
1255 const char *data
= NULL
;
1257 bool wasThereAnException
= false;
1258 assert(flags
.chunked
);
1259 assert(httpChunkDecoder
);
1260 SQUID_ENTER_THROWING_CODE();
1263 const bool doneParsing
= httpChunkDecoder
->parse(readBuf
,&decodedData
);
1264 len
= decodedData
.contentSize();
1265 data
=decodedData
.content();
1266 addVirginReplyBody(data
, len
);
1269 flags
.do_next_read
= 0;
1271 SQUID_EXIT_THROWING_CODE(wasThereAnException
);
1272 return wasThereAnException
;
1276 * processReplyBody has two purposes:
1277 * 1 - take the reply body data, if any, and put it into either
1278 * the StoreEntry, or give it over to ICAP.
1279 * 2 - see if we made it to the end of the response (persistent
1280 * connections and such)
1283 HttpStateData::processReplyBody()
1285 AsyncCall::Pointer call
;
1286 Ip::Address client_addr
;
1287 bool ispinned
= false;
1289 if (!flags
.headers_parsed
) {
1290 flags
.do_next_read
= 1;
1291 maybeReadVirginBody();
1296 debugs(11,5, HERE
<< "adaptationAccessCheckPending=" << adaptationAccessCheckPending
);
1297 if (adaptationAccessCheckPending
)
1303 * At this point the reply headers have been parsed and consumed.
1304 * That means header content has been removed from readBuf and
1305 * it contains only body data.
1307 if (flags
.chunked
) {
1308 if (!decodeAndWriteReplyBody()) {
1309 flags
.do_next_read
= 0;
1316 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
)) {
1318 * The above writeReplyBody() call could ABORT this entry,
1319 * in that case, the server FD should already be closed.
1320 * there's nothing for us to do.
1324 switch (persistentConnStatus()) {
1325 case INCOMPLETE_MSG
:
1326 debugs(11, 5, "processReplyBody: INCOMPLETE_MSG");
1327 /* Wait for more data or EOF condition */
1328 if (flags
.keepalive_broken
) {
1330 commSetTimeout(fd
, 10, call
);
1333 commSetTimeout(fd
, Config
.Timeout
.read
, call
);
1336 flags
.do_next_read
= 1;
1339 case COMPLETE_PERSISTENT_MSG
:
1340 debugs(11, 5, "processReplyBody: COMPLETE_PERSISTENT_MSG");
1341 /* yes we have to clear all these! */
1343 commSetTimeout(fd
, -1, call
);
1344 flags
.do_next_read
= 0;
1346 comm_remove_close_handler(fd
, closeHandler
);
1347 closeHandler
= NULL
;
1348 fwd
->unregister(fd
);
1350 if (orig_request
->flags
.spoof_client_ip
)
1351 client_addr
= orig_request
->client_addr
;
1354 if (request
->flags
.pinned
) {
1356 } else if (request
->flags
.connection_auth
&& request
->flags
.auth_sent
) {
1360 if (orig_request
->pinnedConnection() && ispinned
) {
1361 orig_request
->pinnedConnection()->pinConnection(fd
, orig_request
, _peer
,
1362 (request
->flags
.connection_auth
!= 0));
1364 fwd
->pconnPush(fd
, _peer
, request
, orig_request
->GetHost(), client_addr
);
1372 case COMPLETE_NONPERSISTENT_MSG
:
1373 debugs(11, 5, "processReplyBody: COMPLETE_NONPERSISTENT_MSG");
1378 maybeReadVirginBody();
1382 HttpStateData::maybeReadVirginBody()
1384 // we may need to grow the buffer if headers do not fit
1385 const int minRead
= flags
.headers_parsed
? 0 :1024;
1386 const int read_size
= replyBodySpace(*readBuf
, minRead
);
1388 debugs(11,9, HERE
<< (flags
.do_next_read
? "may" : "wont") <<
1389 " read up to " << read_size
<< " bytes from FD " << fd
);
1392 * why <2? Because delayAwareRead() won't actually read if
1393 * you ask it to read 1 byte. The delayed read request
1394 * just gets re-queued until the client side drains, then
1395 * the I/O thread hangs. Better to not register any read
1396 * handler until we get a notification from someone that
1397 * its okay to read again.
1402 if (flags
.do_next_read
) {
1403 flags
.do_next_read
= 0;
1404 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
1405 entry
->delayAwareRead(fd
, readBuf
->space(read_size
), read_size
,
1406 JobCallback(11, 5, Dialer
, this, HttpStateData::readReply
));
1411 * This will be called when request write is complete.
1414 HttpStateData::sendComplete(const CommIoCbParams
&io
)
1416 debugs(11, 5, "httpSendComplete: FD " << fd
<< ": size " << io
.size
<< ": errflag " << io
.flag
<< ".");
1417 #if URL_CHECKSUM_DEBUG
1419 entry
->mem_obj
->checkUrlChecksum();
1423 fd_bytes(fd
, io
.size
, FD_WRITE
);
1424 kb_incr(&statCounter
.server
.all
.kbytes_out
, io
.size
);
1425 kb_incr(&statCounter
.server
.http
.kbytes_out
, io
.size
);
1428 if (io
.flag
== COMM_ERR_CLOSING
)
1433 err
= errorCon(ERR_WRITE_ERROR
, HTTP_BAD_GATEWAY
, fwd
->request
);
1434 err
->xerrno
= io
.xerrno
;
1441 * Set the read timeout here because it hasn't been set yet.
1442 * We only set the read timeout after the request has been
1443 * fully written to the server-side. If we start the timeout
1444 * after connection establishment, then we are likely to hit
1445 * the timeout for POST/PUT requests that have very large
1448 typedef CommCbMemFunT
<HttpStateData
, CommTimeoutCbParams
> TimeoutDialer
;
1449 AsyncCall::Pointer timeoutCall
= JobCallback(11, 5,
1450 TimeoutDialer
, this, HttpStateData::httpTimeout
);
1452 commSetTimeout(fd
, Config
.Timeout
.read
, timeoutCall
);
1454 flags
.request_sent
= 1;
1456 orig_request
->hier
.peer_http_request_sent
= current_time
;
1459 // Close the HTTP server connection. Used by serverComplete().
1461 HttpStateData::closeServer()
1463 debugs(11,5, HERE
<< "closing HTTP server FD " << fd
<< " this " << this);
1466 fwd
->unregister(fd
);
1467 comm_remove_close_handler(fd
, closeHandler
);
1468 closeHandler
= NULL
;
1475 HttpStateData::doneWithServer() const
1482 * Fixup authentication request headers for special cases
1485 httpFixupAuthentication(HttpRequest
* request
, HttpRequest
* orig_request
, const HttpHeader
* hdr_in
, HttpHeader
* hdr_out
, http_state_flags flags
)
1487 http_hdr_type header
= flags
.originpeer
? HDR_AUTHORIZATION
: HDR_PROXY_AUTHORIZATION
;
1489 /* Nothing to do unless we are forwarding to a peer */
1490 if (!request
->flags
.proxying
)
1493 /* Needs to be explicitly enabled */
1494 if (!orig_request
->peer_login
)
1497 /* Maybe already dealt with? */
1498 if (hdr_out
->has(header
))
1501 /* Nothing to do here for PASSTHRU */
1502 if (strcmp(orig_request
->peer_login
, "PASSTHRU") == 0)
1505 /* PROXYPASS is a special case, single-signon to servers with the proxy password (basic only) */
1506 if (flags
.originpeer
&& strcmp(orig_request
->peer_login
, "PROXYPASS") == 0 && hdr_in
->has(HDR_PROXY_AUTHORIZATION
)) {
1507 const char *auth
= hdr_in
->getStr(HDR_PROXY_AUTHORIZATION
);
1509 if (auth
&& strncasecmp(auth
, "basic ", 6) == 0) {
1510 hdr_out
->putStr(header
, auth
);
1515 /* Special mode to pass the username to the upstream cache */
1516 if (*orig_request
->peer_login
== '*') {
1518 const char *username
= "-";
1520 if (orig_request
->extacl_user
.size())
1521 username
= orig_request
->extacl_user
.termedBuf();
1522 else if (orig_request
->auth_user_request
!= NULL
)
1523 username
= orig_request
->auth_user_request
->username();
1525 snprintf(loginbuf
, sizeof(loginbuf
), "%s%s", username
, orig_request
->peer_login
+ 1);
1527 httpHeaderPutStrf(hdr_out
, header
, "Basic %s",
1528 base64_encode(loginbuf
));
1532 /* external_acl provided credentials */
1533 if (orig_request
->extacl_user
.size() && orig_request
->extacl_passwd
.size() &&
1534 (strcmp(orig_request
->peer_login
, "PASS") == 0 ||
1535 strcmp(orig_request
->peer_login
, "PROXYPASS") == 0)) {
1537 snprintf(loginbuf
, sizeof(loginbuf
), SQUIDSTRINGPH
":" SQUIDSTRINGPH
,
1538 SQUIDSTRINGPRINT(orig_request
->extacl_user
),
1539 SQUIDSTRINGPRINT(orig_request
->extacl_passwd
));
1540 httpHeaderPutStrf(hdr_out
, header
, "Basic %s",
1541 base64_encode(loginbuf
));
1545 /* Kerberos login to peer */
1546 #if HAVE_KRB5 && HAVE_GSSAPI
1547 if (strncmp(orig_request
->peer_login
, "NEGOTIATE",strlen("NEGOTIATE")) == 0) {
1549 char *PrincipalName
=NULL
,*p
;
1550 if ((p
=strchr(orig_request
->peer_login
,':')) != NULL
) {
1553 Token
= peer_proxy_negotiate_auth(PrincipalName
,request
->peer_host
);
1555 httpHeaderPutStrf(hdr_out
, HDR_PROXY_AUTHORIZATION
, "Negotiate %s",Token
);
1559 #endif /* HAVE_KRB5 && HAVE_GSSAPI */
1561 httpHeaderPutStrf(hdr_out
, header
, "Basic %s",
1562 base64_encode(orig_request
->peer_login
));
1567 * build request headers and append them to a given MemBuf
1568 * used by buildRequestPrefix()
1569 * note: initialised the HttpHeader, the caller is responsible for Clean()-ing
1572 HttpStateData::httpBuildRequestHeader(HttpRequest
* request
,
1573 HttpRequest
* orig_request
,
1575 HttpHeader
* hdr_out
,
1576 http_state_flags flags
)
1578 /* building buffer for complex strings */
1579 #define BBUF_SZ (MAX_URL+32)
1580 LOCAL_ARRAY(char, bbuf
, BBUF_SZ
);
1581 LOCAL_ARRAY(char, ntoabuf
, MAX_IPSTRLEN
);
1582 const HttpHeader
*hdr_in
= &orig_request
->header
;
1583 const HttpHeaderEntry
*e
= NULL
;
1584 HttpHeaderPos pos
= HttpHeaderInitPos
;
1585 assert (hdr_out
->owner
== hoRequest
);
1587 /* append our IMS header */
1588 if (request
->lastmod
> -1)
1589 hdr_out
->putTime(HDR_IF_MODIFIED_SINCE
, request
->lastmod
);
1591 bool we_do_ranges
= decideIfWeDoRanges (orig_request
);
1593 String
strConnection (hdr_in
->getList(HDR_CONNECTION
));
1595 while ((e
= hdr_in
->getEntry(&pos
)))
1596 copyOneHeaderFromClientsideRequestToUpstreamRequest(e
, strConnection
, request
, orig_request
, hdr_out
, we_do_ranges
, flags
);
1598 /* Abstraction break: We should interpret multipart/byterange responses
1599 * into offset-length data, and this works around our inability to do so.
1601 if (!we_do_ranges
&& orig_request
->multipartRangeRequest()) {
1602 /* don't cache the result */
1603 orig_request
->flags
.cachable
= 0;
1604 /* pretend it's not a range request */
1605 delete orig_request
->range
;
1606 orig_request
->range
= NULL
;
1607 orig_request
->flags
.range
= 0;
1611 if (Config
.onoff
.via
) {
1613 strVia
= hdr_in
->getList(HDR_VIA
);
1614 snprintf(bbuf
, BBUF_SZ
, "%d.%d %s",
1615 orig_request
->http_ver
.major
,
1616 orig_request
->http_ver
.minor
, ThisCache
);
1617 strListAdd(&strVia
, bbuf
, ',');
1618 hdr_out
->putStr(HDR_VIA
, strVia
.termedBuf());
1622 if (orig_request
->flags
.accelerated
) {
1623 /* Append Surrogate-Capabilities */
1624 String
strSurrogate(hdr_in
->getList(HDR_SURROGATE_CAPABILITY
));
1626 snprintf(bbuf
, BBUF_SZ
, "%s=\"Surrogate/1.0 ESI/1.0\"", Config
.Accel
.surrogate_id
);
1628 snprintf(bbuf
, BBUF_SZ
, "%s=\"Surrogate/1.0\"", Config
.Accel
.surrogate_id
);
1630 strListAdd(&strSurrogate
, bbuf
, ',');
1631 hdr_out
->putStr(HDR_SURROGATE_CAPABILITY
, strSurrogate
.termedBuf());
1634 /** \pre Handle X-Forwarded-For */
1635 if (strcmp(opt_forwarded_for
, "delete") != 0) {
1637 String strFwd
= hdr_in
->getList(HDR_X_FORWARDED_FOR
);
1639 if (strFwd
.size() > 65536/2) {
1640 // There is probably a forwarding loop with Via detection disabled.
1641 // If we do nothing, String will assert on overflow soon.
1642 // TODO: Terminate all transactions with huge XFF?
1645 static int warnedCount
= 0;
1646 if (warnedCount
++ < 100) {
1647 const char *url
= entry
? entry
->url() : urlCanonical(orig_request
);
1648 debugs(11, 1, "Warning: likely forwarding loop with " << url
);
1652 if (strcmp(opt_forwarded_for
, "on") == 0) {
1653 /** If set to ON - append client IP or 'unknown'. */
1654 if ( orig_request
->client_addr
.IsNoAddr() )
1655 strListAdd(&strFwd
, "unknown", ',');
1657 strListAdd(&strFwd
, orig_request
->client_addr
.NtoA(ntoabuf
, MAX_IPSTRLEN
), ',');
1658 } else if (strcmp(opt_forwarded_for
, "off") == 0) {
1659 /** If set to OFF - append 'unknown'. */
1660 strListAdd(&strFwd
, "unknown", ',');
1661 } else if (strcmp(opt_forwarded_for
, "transparent") == 0) {
1662 /** If set to TRANSPARENT - pass through unchanged. */
1663 } else if (strcmp(opt_forwarded_for
, "truncate") == 0) {
1664 /** If set to TRUNCATE - drop existing list and replace with client IP or 'unknown'. */
1665 if ( orig_request
->client_addr
.IsNoAddr() )
1668 strFwd
= orig_request
->client_addr
.NtoA(ntoabuf
, MAX_IPSTRLEN
);
1670 if (strFwd
.size() > 0)
1671 hdr_out
->putStr(HDR_X_FORWARDED_FOR
, strFwd
.termedBuf());
1673 /** If set to DELETE - do not copy through. */
1675 /* append Host if not there already */
1676 if (!hdr_out
->has(HDR_HOST
)) {
1677 if (orig_request
->peer_domain
) {
1678 hdr_out
->putStr(HDR_HOST
, orig_request
->peer_domain
);
1679 } else if (orig_request
->port
== urlDefaultPort(orig_request
->protocol
)) {
1680 /* use port# only if not default */
1681 hdr_out
->putStr(HDR_HOST
, orig_request
->GetHost());
1683 httpHeaderPutStrf(hdr_out
, HDR_HOST
, "%s:%d",
1684 orig_request
->GetHost(),
1685 (int) orig_request
->port
);
1689 /* append Authorization if known in URL, not in header and going direct */
1690 if (!hdr_out
->has(HDR_AUTHORIZATION
)) {
1691 if (!request
->flags
.proxying
&& *request
->login
) {
1692 httpHeaderPutStrf(hdr_out
, HDR_AUTHORIZATION
, "Basic %s",
1693 base64_encode(request
->login
));
1697 /* Fixup (Proxy-)Authorization special cases. Plain relaying dealt with above */
1698 httpFixupAuthentication(request
, orig_request
, hdr_in
, hdr_out
, flags
);
1700 /* append Cache-Control, add max-age if not there already */
1702 HttpHdrCc
*cc
= hdr_in
->getCc();
1705 cc
= httpHdrCcCreate();
1707 #if 0 /* see bug 2330 */
1708 /* Set no-cache if determined needed but not found */
1709 if (orig_request
->flags
.nocache
)
1710 EBIT_SET(cc
->mask
, CC_NO_CACHE
);
1713 /* Add max-age only without no-cache */
1714 if (!EBIT_TEST(cc
->mask
, CC_MAX_AGE
) && !EBIT_TEST(cc
->mask
, CC_NO_CACHE
)) {
1716 entry
? entry
->url() : urlCanonical(orig_request
);
1717 httpHdrCcSetMaxAge(cc
, getMaxAge(url
));
1719 if (request
->urlpath
.size())
1720 assert(strstr(url
, request
->urlpath
.termedBuf()));
1723 /* Enforce sibling relations */
1724 if (flags
.only_if_cached
)
1725 EBIT_SET(cc
->mask
, CC_ONLY_IF_CACHED
);
1729 httpHdrCcDestroy(cc
);
1732 /* maybe append Connection: keep-alive */
1733 if (flags
.keepalive
) {
1734 hdr_out
->putStr(HDR_CONNECTION
, "keep-alive");
1737 /* append Front-End-Https */
1738 if (flags
.front_end_https
) {
1739 if (flags
.front_end_https
== 1 || request
->protocol
== PROTO_HTTPS
)
1740 hdr_out
->putStr(HDR_FRONT_END_HTTPS
, "On");
1743 /* Now mangle the headers. */
1744 if (Config2
.onoff
.mangle_request_headers
)
1745 httpHdrMangleList(hdr_out
, request
, ROR_REQUEST
);
1747 strConnection
.clean();
1751 * Decides whether a particular header may be cloned from the received Clients request
1752 * to our outgoing fetch request.
1755 copyOneHeaderFromClientsideRequestToUpstreamRequest(const HttpHeaderEntry
*e
, const String strConnection
, HttpRequest
* request
, const HttpRequest
* orig_request
, HttpHeader
* hdr_out
, const int we_do_ranges
, const http_state_flags flags
)
1757 debugs(11, 5, "httpBuildRequestHeader: " << e
->name
<< ": " << e
->value
);
1761 /** \par RFC 2616 sect 13.5.1 - Hop-by-Hop headers which Squid should not pass on. */
1763 case HDR_PROXY_AUTHORIZATION
:
1764 /** \par Proxy-Authorization:
1765 * Only pass on proxy authentication to peers for which
1766 * authentication forwarding is explicitly enabled
1768 if (!flags
.originpeer
&& flags
.proxying
&& orig_request
->peer_login
&&
1769 (strcmp(orig_request
->peer_login
, "PASS") == 0 ||
1770 strcmp(orig_request
->peer_login
, "PROXYPASS") == 0 ||
1771 strcmp(orig_request
->peer_login
, "PASSTHRU") == 0)) {
1772 hdr_out
->addEntry(e
->clone());
1776 /** \par RFC 2616 sect 13.5.1 - Hop-by-Hop headers which Squid does not pass on. */
1778 case HDR_CONNECTION
: /** \par Connection: */
1779 case HDR_TE
: /** \par TE: */
1780 case HDR_KEEP_ALIVE
: /** \par Keep-Alive: */
1781 case HDR_PROXY_AUTHENTICATE
: /** \par Proxy-Authenticate: */
1782 case HDR_TRAILERS
: /** \par Trailers: */
1783 case HDR_UPGRADE
: /** \par Upgrade: */
1784 case HDR_TRANSFER_ENCODING
: /** \par Transfer-Encoding: */
1788 /** \par OTHER headers I haven't bothered to track down yet. */
1790 case HDR_AUTHORIZATION
:
1791 /** \par WWW-Authorization:
1792 * Pass on WWW authentication */
1794 if (!flags
.originpeer
) {
1795 hdr_out
->addEntry(e
->clone());
1797 /** \note In accelerators, only forward authentication if enabled
1798 * (see also httpFixupAuthentication for special cases)
1800 if (orig_request
->peer_login
&&
1801 (strcmp(orig_request
->peer_login
, "PASS") == 0 ||
1802 strcmp(orig_request
->peer_login
, "PASSTHRU") == 0 ||
1803 strcmp(orig_request
->peer_login
, "PROXYPASS") == 0)) {
1804 hdr_out
->addEntry(e
->clone());
1812 * Normally Squid rewrites the Host: header.
1813 * However, there is one case when we don't: If the URL
1814 * went through our redirector and the admin configured
1815 * 'redir_rewrites_host' to be off.
1817 if (orig_request
->peer_domain
)
1818 hdr_out
->putStr(HDR_HOST
, orig_request
->peer_domain
);
1819 else if (request
->flags
.redirected
&& !Config
.onoff
.redir_rewrites_host
)
1820 hdr_out
->addEntry(e
->clone());
1822 /* use port# only if not default */
1824 if (orig_request
->port
== urlDefaultPort(orig_request
->protocol
)) {
1825 hdr_out
->putStr(HDR_HOST
, orig_request
->GetHost());
1827 httpHeaderPutStrf(hdr_out
, HDR_HOST
, "%s:%d",
1828 orig_request
->GetHost(),
1829 (int) orig_request
->port
);
1835 case HDR_IF_MODIFIED_SINCE
:
1836 /** \par If-Modified-Since:
1837 * append unless we added our own;
1838 * \note at most one client's ims header can pass through */
1840 if (!hdr_out
->has(HDR_IF_MODIFIED_SINCE
))
1841 hdr_out
->addEntry(e
->clone());
1845 case HDR_MAX_FORWARDS
:
1846 /** \par Max-Forwards:
1847 * pass only on TRACE or OPTIONS requests */
1848 if (orig_request
->method
== METHOD_TRACE
|| orig_request
->method
== METHOD_OPTIONS
) {
1849 const int64_t hops
= e
->getInt64();
1852 hdr_out
->putInt64(HDR_MAX_FORWARDS
, hops
- 1);
1859 * If Via is disabled then forward any received header as-is.
1860 * Otherwise leave for explicit updated addition later. */
1862 if (!Config
.onoff
.via
)
1863 hdr_out
->addEntry(e
->clone());
1871 case HDR_REQUEST_RANGE
:
1872 /** \par Range:, If-Range:, Request-Range:
1873 * Only pass if we accept ranges */
1875 hdr_out
->addEntry(e
->clone());
1879 case HDR_PROXY_CONNECTION
: // SHOULD ignore. But doing so breaks things.
1882 case HDR_X_FORWARDED_FOR
:
1884 case HDR_CACHE_CONTROL
:
1885 /** \par X-Forwarded-For:, Cache-Control:
1886 * handled specially by Squid, so leave off for now.
1887 * append these after the loop if needed */
1890 case HDR_FRONT_END_HTTPS
:
1891 /** \par Front-End-Https:
1892 * Pass thru only if peer is configured with front-end-https */
1893 if (!flags
.front_end_https
)
1894 hdr_out
->addEntry(e
->clone());
1900 * pass on all other header fields
1901 * which are NOT listed by the special Connection: header. */
1903 if (strConnection
.size()>0 && strListIsMember(&strConnection
, e
->name
.termedBuf(), ',')) {
1904 debugs(11, 2, "'" << e
->name
<< "' header cropped by Connection: definition");
1908 hdr_out
->addEntry(e
->clone());
1913 HttpStateData::decideIfWeDoRanges (HttpRequest
* orig_request
)
1916 /* decide if we want to do Ranges ourselves
1917 * and fetch the whole object now)
1918 * We want to handle Ranges ourselves iff
1919 * - we can actually parse client Range specs
1920 * - the specs are expected to be simple enough (e.g. no out-of-order ranges)
1921 * - reply will be cachable
1922 * (If the reply will be uncachable we have to throw it away after
1923 * serving this request, so it is better to forward ranges to
1924 * the server and fetch only the requested content)
1927 int64_t roffLimit
= orig_request
->getRangeOffsetLimit();
1929 if (NULL
== orig_request
->range
|| !orig_request
->flags
.cachable
1930 || orig_request
->range
->offsetLimitExceeded(roffLimit
) || orig_request
->flags
.connection_auth
)
1933 debugs(11, 8, "decideIfWeDoRanges: range specs: " <<
1934 orig_request
->range
<< ", cachable: " <<
1935 orig_request
->flags
.cachable
<< "; we_do_ranges: " << result
);
1940 /* build request prefix and append it to a given MemBuf;
1941 * return the length of the prefix */
1943 HttpStateData::buildRequestPrefix(HttpRequest
* aRequest
,
1944 HttpRequest
* original_request
,
1945 StoreEntry
* sentry
,
1947 http_state_flags stateFlags
)
1949 const int offset
= mb
->size
;
1950 HttpVersion
httpver(1,1);
1951 mb
->Printf("%s %s HTTP/%d.%d\r\n",
1952 RequestMethodStr(aRequest
->method
),
1953 aRequest
->urlpath
.size() ? aRequest
->urlpath
.termedBuf() : "/",
1954 httpver
.major
,httpver
.minor
);
1955 /* build and pack headers */
1957 HttpHeader
hdr(hoRequest
);
1959 httpBuildRequestHeader(aRequest
, original_request
, sentry
, &hdr
, stateFlags
);
1961 if (aRequest
->flags
.pinned
&& aRequest
->flags
.connection_auth
)
1962 aRequest
->flags
.auth_sent
= 1;
1963 else if (hdr
.has(HDR_AUTHORIZATION
))
1964 aRequest
->flags
.auth_sent
= 1;
1966 packerToMemInit(&p
, mb
);
1971 /* append header terminator */
1972 mb
->append(crlf
, 2);
1973 return mb
->size
- offset
;
1976 /* This will be called when connect completes. Write request. */
1978 HttpStateData::sendRequest()
1982 debugs(11, 5, "httpSendRequest: FD " << fd
<< ", request " << request
<< ", this " << this << ".");
1985 debugs(11,3, HERE
<< "cannot send request to closing FD " << fd
);
1986 assert(closeHandler
!= NULL
);
1990 typedef CommCbMemFunT
<HttpStateData
, CommTimeoutCbParams
> TimeoutDialer
;
1991 AsyncCall::Pointer timeoutCall
= JobCallback(11, 5,
1992 TimeoutDialer
, this, HttpStateData::httpTimeout
);
1993 commSetTimeout(fd
, Config
.Timeout
.lifetime
, timeoutCall
);
1994 flags
.do_next_read
= 1;
1995 maybeReadVirginBody();
1997 if (orig_request
->body_pipe
!= NULL
) {
1998 if (!startRequestBodyFlow()) // register to receive body data
2000 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2001 requestSender
= JobCallback(11,5,
2002 Dialer
, this, HttpStateData::sentRequestBody
);
2004 assert(!requestBodySource
);
2005 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2006 requestSender
= JobCallback(11,5,
2007 Dialer
, this, HttpStateData::sendComplete
);
2010 if (_peer
!= NULL
) {
2011 if (_peer
->options
.originserver
) {
2013 flags
.originpeer
= 1;
2016 flags
.originpeer
= 0;
2020 flags
.originpeer
= 0;
2024 * Is keep-alive okay for all request methods?
2026 if (orig_request
->flags
.must_keepalive
)
2027 flags
.keepalive
= 1;
2028 else if (!Config
.onoff
.server_pconns
)
2029 flags
.keepalive
= 0;
2030 else if (_peer
== NULL
)
2031 flags
.keepalive
= 1;
2032 else if (_peer
->stats
.n_keepalives_sent
< 10)
2033 flags
.keepalive
= 1;
2034 else if ((double) _peer
->stats
.n_keepalives_recv
/
2035 (double) _peer
->stats
.n_keepalives_sent
> 0.50)
2036 flags
.keepalive
= 1;
2039 if (neighborType(_peer
, request
) == PEER_SIBLING
&&
2040 !_peer
->options
.allow_miss
)
2041 flags
.only_if_cached
= 1;
2043 flags
.front_end_https
= _peer
->front_end_https
;
2047 request
->peer_host
=_peer
?_peer
->host
:NULL
;
2048 buildRequestPrefix(request
, orig_request
, entry
, &mb
, flags
);
2049 debugs(11, 6, "httpSendRequest: FD " << fd
<< ":\n" << mb
.buf
);
2050 comm_write_mbuf(fd
, &mb
, requestSender
);
2056 httpStart(FwdState
*fwd
)
2058 debugs(11, 3, "httpStart: \"" << RequestMethodStr(fwd
->request
->method
) << " " << fwd
->entry
->url() << "\"" );
2059 HttpStateData
*httpState
= new HttpStateData(fwd
);
2061 if (!httpState
->sendRequest()) {
2062 debugs(11, 3, "httpStart: aborted");
2067 statCounter
.server
.all
.requests
++;
2068 statCounter
.server
.http
.requests
++;
2071 * We used to set the read timeout here, but not any more.
2072 * Now its set in httpSendComplete() after the full request,
2073 * including request body, has been written to the server.
2078 HttpStateData::doneSendingRequestBody()
2080 debugs(11,5, HERE
<< "doneSendingRequestBody: FD " << fd
);
2082 #if USE_HTTP_VIOLATIONS
2083 if (Config
.accessList
.brokenPosts
) {
2084 ACLFilledChecklist
ch(Config
.accessList
.brokenPosts
, request
, NULL
);
2085 if (!ch
.fastCheck()) {
2086 debugs(11, 5, "doneSendingRequestBody: didn't match brokenPosts");
2087 CommIoCbParams
io(NULL
);
2092 debugs(11, 2, "doneSendingRequestBody: matched brokenPosts");
2095 debugs(11,2, HERE
<< "cannot send CRLF to closing FD " << fd
);
2096 assert(closeHandler
!= NULL
);
2100 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2101 AsyncCall::Pointer call
= JobCallback(11,5,
2102 Dialer
, this, HttpStateData::sendComplete
);
2103 comm_write(fd
, "\r\n", 2, call
);
2107 debugs(11, 5, "doneSendingRequestBody: No brokenPosts list");
2108 #endif /* USE_HTTP_VIOLATIONS */
2110 CommIoCbParams
io(NULL
);
2116 // more origin request body data is available
2118 HttpStateData::handleMoreRequestBodyAvailable()
2120 if (eof
|| fd
< 0) {
2121 // XXX: we should check this condition in other callbacks then!
2122 // TODO: Check whether this can actually happen: We should unsubscribe
2123 // as a body consumer when the above condition(s) are detected.
2124 debugs(11, 1, HERE
<< "Transaction aborted while reading HTTP body");
2128 assert(requestBodySource
!= NULL
);
2130 if (requestBodySource
->buf().hasContent()) {
2131 // XXX: why does not this trigger a debug message on every request?
2133 if (flags
.headers_parsed
&& !flags
.abuse_detected
) {
2134 flags
.abuse_detected
= 1;
2135 debugs(11, 1, "http handleMoreRequestBodyAvailable: Likely proxy abuse detected '" << orig_request
->client_addr
<< "' -> '" << entry
->url() << "'" );
2137 if (virginReply()->sline
.status
== HTTP_INVALID_HEADER
) {
2144 HttpStateData::handleMoreRequestBodyAvailable();
2147 // premature end of the request body
2149 HttpStateData::handleRequestBodyProducerAborted()
2151 ServerStateData::handleRequestBodyProducerAborted();
2152 // XXX: SendComplete(COMM_ERR_CLOSING) does little. Is it enough?
2153 CommIoCbParams
io(NULL
);
2155 io
.flag
=COMM_ERR_CLOSING
;
2159 // called when we wrote request headers(!) or a part of the body
2161 HttpStateData::sentRequestBody(const CommIoCbParams
&io
)
2164 kb_incr(&statCounter
.server
.http
.kbytes_out
, io
.size
);
2166 ServerStateData::sentRequestBody(io
);
2169 // Quickly abort the transaction
2170 // TODO: destruction should be sufficient as the destructor should cleanup,
2171 // including canceling close handlers
2173 HttpStateData::abortTransaction(const char *reason
)
2175 debugs(11,5, HERE
<< "aborting transaction for " << reason
<<
2176 "; FD " << fd
<< ", this " << this);
2183 fwd
->handleUnregisteredServerEnd();
2184 deleteThis("HttpStateData::abortTransaction");
2188 HttpStateData::originalRequest()
2190 return orig_request
;