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"
46 #include "DelayPools.h"
48 #include "errorpage.h"
51 #include "HttpHdrContRange.h"
52 #include "HttpHdrSc.h"
53 #include "HttpHdrScTarget.h"
54 #include "HttpReply.h"
55 #include "HttpRequest.h"
57 #include "MemObject.h"
60 #include "SquidTime.h"
62 #include "TextException.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
= asyncCall(9, 5, "httpStateData::httpStateConnClosed",
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
)
315 if (request
->flags
.accelerated
&& reply
->surrogate_control
) {
316 HttpHdrScTarget
*sctusable
=
317 httpHdrScGetMergedTarget(reply
->surrogate_control
,
318 Config
.Accel
.surrogate_id
);
321 if (EBIT_TEST(sctusable
->mask
, SC_NO_STORE
) ||
322 (Config
.onoff
.surrogate_is_remote
323 && EBIT_TEST(sctusable
->mask
, SC_NO_STORE_REMOTE
))) {
324 surrogateNoStore
= true;
325 entry
->makePrivate();
328 /* The HttpHeader logic cannot tell if the header it's parsing is a reply to an
329 * accelerated request or not...
330 * Still, this is an abtraction breach. - RC
332 if (sctusable
->max_age
!= -1) {
333 if (sctusable
->max_age
< sctusable
->max_stale
)
334 reply
->expires
= reply
->date
+ sctusable
->max_age
;
336 reply
->expires
= reply
->date
+ sctusable
->max_stale
;
338 /* And update the timestamps */
339 entry
->timestampsSet();
342 /* We ignore cache-control directives as per the Surrogate specification */
343 ignoreCacheControl
= true;
345 httpHdrScTargetDestroy(sctusable
);
353 HttpStateData::cacheableReply()
355 HttpReply
const *rep
= finalReply();
356 HttpHeader
const *hdr
= &rep
->header
;
357 const int cc_mask
= (rep
->cache_control
) ? rep
->cache_control
->mask
: 0;
361 const refresh_t
*R
= NULL
;
363 /* This strange looking define first looks up the refresh pattern
364 * and then checks if the specified flag is set. The main purpose
365 * of this is to simplify the refresh pattern lookup and HTTP_VIOLATIONS
368 #define REFRESH_OVERRIDE(flag) \
369 ((R = (R ? R : refreshLimits(entry->mem_obj->url))) , \
370 (R && R->flags.flag))
372 #define REFRESH_OVERRIDE(flag) 0
375 if (surrogateNoStore
)
378 if (!ignoreCacheControl
) {
379 if (EBIT_TEST(cc_mask
, CC_PRIVATE
)) {
380 if (!REFRESH_OVERRIDE(ignore_private
))
384 if (EBIT_TEST(cc_mask
, CC_NO_CACHE
)) {
385 if (!REFRESH_OVERRIDE(ignore_no_cache
))
389 if (EBIT_TEST(cc_mask
, CC_NO_STORE
)) {
390 if (!REFRESH_OVERRIDE(ignore_no_store
))
395 if (request
->flags
.auth
|| request
->flags
.auth_sent
) {
397 * Responses to requests with authorization may be cached
398 * only if a Cache-Control: public reply header is present.
399 * RFC 2068, sec 14.9.4
402 if (!EBIT_TEST(cc_mask
, CC_PUBLIC
)) {
403 if (!REFRESH_OVERRIDE(ignore_auth
))
408 /* Pragma: no-cache in _replies_ is not documented in HTTP,
409 * but servers like "Active Imaging Webcast/2.0" sure do use it */
410 if (hdr
->has(HDR_PRAGMA
)) {
411 String s
= hdr
->getList(HDR_PRAGMA
);
412 const int no_cache
= strListIsMember(&s
, "no-cache", ',');
416 if (!REFRESH_OVERRIDE(ignore_no_cache
))
422 * The "multipart/x-mixed-replace" content type is used for
423 * continuous push replies. These are generally dynamic and
424 * probably should not be cachable
426 if ((v
= hdr
->getStr(HDR_CONTENT_TYPE
)))
427 if (!strncasecmp(v
, "multipart/x-mixed-replace", 25))
430 switch (rep
->sline
.status
) {
431 /* Responses that are cacheable */
435 case HTTP_NON_AUTHORITATIVE_INFORMATION
:
437 case HTTP_MULTIPLE_CHOICES
:
439 case HTTP_MOVED_PERMANENTLY
:
443 * Don't cache objects that need to be refreshed on next request,
444 * unless we know how to refresh it.
447 if (!refreshIsCachable(entry
)) {
448 debugs(22, 3, "refreshIsCachable() returned non-cacheable..");
452 /* don't cache objects from peers w/o LMT, Date, or Expires */
453 /* check that is it enough to check headers @?@ */
456 else if (rep
->last_modified
> -1)
461 /* @?@ (here and 302): invalid expires header compiles to squid_curtime */
462 else if (rep
->expires
> -1)
470 /* Responses that only are cacheable if the server says so */
472 case HTTP_MOVED_TEMPORARILY
:
473 case HTTP_TEMPORARY_REDIRECT
:
474 if (rep
->expires
> rep
->date
&& rep
->date
> 0)
482 /* Errors can be negatively cached */
484 case HTTP_NO_CONTENT
:
488 case HTTP_BAD_REQUEST
:
494 case HTTP_METHOD_NOT_ALLOWED
:
496 case HTTP_REQUEST_URI_TOO_LARGE
:
498 case HTTP_INTERNAL_SERVER_ERROR
:
500 case HTTP_NOT_IMPLEMENTED
:
502 case HTTP_BAD_GATEWAY
:
504 case HTTP_SERVICE_UNAVAILABLE
:
506 case HTTP_GATEWAY_TIMEOUT
:
512 /* Some responses can never be cached */
514 case HTTP_PARTIAL_CONTENT
: /* Not yet supported */
518 case HTTP_NOT_MODIFIED
:
520 case HTTP_UNAUTHORIZED
:
522 case HTTP_PROXY_AUTHENTICATION_REQUIRED
:
524 case HTTP_INVALID_HEADER
: /* Squid header parsing error */
526 case HTTP_HEADER_TOO_LARGE
:
528 case HTTP_PAYMENT_REQUIRED
:
529 case HTTP_NOT_ACCEPTABLE
:
530 case HTTP_REQUEST_TIMEOUT
:
532 case HTTP_LENGTH_REQUIRED
:
533 case HTTP_PRECONDITION_FAILED
:
534 case HTTP_REQUEST_ENTITY_TOO_LARGE
:
535 case HTTP_UNSUPPORTED_MEDIA_TYPE
:
536 case HTTP_UNPROCESSABLE_ENTITY
:
538 case HTTP_FAILED_DEPENDENCY
:
539 case HTTP_INSUFFICIENT_STORAGE
:
540 case HTTP_REQUESTED_RANGE_NOT_SATISFIABLE
:
541 case HTTP_EXPECTATION_FAILED
:
545 default: /* Unknown status code */
546 debugs (11, 0, HERE
<< "HttpStateData::cacheableReply: unexpected http status code " << rep
->sline
.status
);
558 * For Vary, store the relevant request headers as
559 * virtual headers in the reply
560 * Returns false if the variance cannot be stored
563 httpMakeVaryMark(HttpRequest
* request
, HttpReply
const * reply
)
566 const char *pos
= NULL
;
573 vary
= reply
->header
.getList(HDR_VARY
);
575 while (strListGetItem(&vary
, ',', &item
, &ilen
, &pos
)) {
576 char *name
= (char *)xmalloc(ilen
+ 1);
577 xstrncpy(name
, item
, ilen
+ 1);
580 if (strcmp(name
, "*") == 0) {
581 /* Can not handle "Vary: *" withtout ETag support */
587 strListAdd(&vstr
, name
, ',');
588 hdr
= request
->header
.getByName(name
);
590 value
= hdr
.termedBuf();
593 value
= rfc1738_escape_part(value
);
594 vstr
.append("=\"", 2);
596 vstr
.append("\"", 1);
603 #if X_ACCELERATOR_VARY
606 vary
= reply
->header
.getList(HDR_X_ACCELERATOR_VARY
);
608 while (strListGetItem(&vary
, ',', &item
, &ilen
, &pos
)) {
609 char *name
= (char *)xmalloc(ilen
+ 1);
610 xstrncpy(name
, item
, ilen
+ 1);
612 strListAdd(&vstr
, name
, ',');
613 hdr
= request
->header
.getByName(name
);
615 value
= hdr
.termedBuf();
618 value
= rfc1738_escape_part(value
);
619 vstr
.append("=\"", 2);
621 vstr
.append("\"", 1);
630 debugs(11, 3, "httpMakeVaryMark: " << vstr
);
631 return vstr
.termedBuf();
635 HttpStateData::keepaliveAccounting(HttpReply
*reply
)
639 _peer
->stats
.n_keepalives_sent
++;
641 if (reply
->keep_alive
) {
643 _peer
->stats
.n_keepalives_recv
++;
645 if (Config
.onoff
.detect_broken_server_pconns
646 && reply
->bodySize(request
->method
) == -1 && !flags
.chunked
) {
647 debugs(11, 1, "keepaliveAccounting: Impossible keep-alive header from '" << entry
->url() << "'" );
648 // debugs(11, 2, "GOT HTTP REPLY HDR:\n---------\n" << readBuf->content() << "\n----------" );
649 flags
.keepalive_broken
= 1;
655 HttpStateData::checkDateSkew(HttpReply
*reply
)
657 if (reply
->date
> -1 && !_peer
) {
658 int skew
= abs((int)(reply
->date
- squid_curtime
));
661 debugs(11, 3, "" << request
->GetHost() << "'s clock is skewed by " << skew
<< " seconds!");
666 * This creates the error page itself.. its likely
667 * that the forward ported reply header max size patch
668 * generates non http conformant error pages - in which
669 * case the errors where should be 'BAD_GATEWAY' etc
672 HttpStateData::processReplyHeader()
674 /** Creates a blank header. If this routine is made incremental, this will not do */
675 Ctx ctx
= ctx_enter(entry
->mem_obj
->url
);
676 debugs(11, 3, "processReplyHeader: key '" << entry
->getMD5Text() << "'");
678 assert(!flags
.headers_parsed
);
680 http_status error
= HTTP_STATUS_NONE
;
682 HttpReply
*newrep
= new HttpReply
;
683 const bool parsed
= newrep
->parse(readBuf
, eof
, &error
);
685 if (!parsed
&& readBuf
->contentSize() > 5 && strncmp(readBuf
->content(), "HTTP/", 5) != 0 && strncmp(readBuf
->content(), "ICY", 3) != 0) {
687 HttpReply
*tmprep
= new HttpReply
;
688 tmprep
->sline
.version
= HttpVersion(1, 0);
689 tmprep
->sline
.status
= HTTP_OK
;
690 tmprep
->header
.putTime(HDR_DATE
, squid_curtime
);
691 tmprep
->header
.putExt("X-Transformed-From", "HTTP/0.9");
693 newrep
->parse(mb
, eof
, &error
);
696 if (!parsed
&& error
> 0) { // unrecoverable parsing error
697 debugs(11, 3, "processReplyHeader: Non-HTTP-compliant header: '" << readBuf
->content() << "'");
698 flags
.headers_parsed
= 1;
699 newrep
->sline
.version
= HttpVersion(1, 0);
700 newrep
->sline
.status
= error
;
701 HttpReply
*vrep
= setVirginReply(newrep
);
702 entry
->replaceHttpReply(vrep
);
707 if (!parsed
) { // need more data
715 debugs(11, 9, "GOT HTTP REPLY HDR:\n---------\n" << readBuf
->content() << "\n----------");
717 header_bytes_read
= headersEnd(readBuf
->content(), readBuf
->contentSize());
718 readBuf
->consume(header_bytes_read
);
722 if (newrep
->sline
.protocol
== PROTO_HTTP
&& newrep
->header
.hasListMember(HDR_TRANSFER_ENCODING
, "chunked", ',')) {
724 httpChunkDecoder
= new ChunkedCodingParser
;
727 if (!peerSupportsConnectionPinning())
728 orig_request
->flags
.connection_auth_disabled
= 1;
730 HttpReply
*vrep
= setVirginReply(newrep
);
731 flags
.headers_parsed
= 1;
733 keepaliveAccounting(vrep
);
737 processSurrogateControl (vrep
);
739 /** \todo IF the reply is a 1.0 reply, AND it has a Connection: Header
740 * Parse the header and remove all referenced headers
743 orig_request
->hier
.peer_reply_status
= newrep
->sline
.status
;
750 * returns true if the peer can support connection pinning
752 bool HttpStateData::peerSupportsConnectionPinning() const
754 const HttpReply
*rep
= entry
->mem_obj
->getReply();
755 const HttpHeader
*hdr
= &rep
->header
;
762 /*If this peer does not support connection pinning (authenticated
763 connections) return false
765 if (!_peer
->connection_auth
)
768 /*The peer supports connection pinning and the http reply status
769 is not unauthorized, so the related connection can be pinned
771 if (rep
->sline
.status
!= HTTP_UNAUTHORIZED
)
774 /*The server respond with HTTP_UNAUTHORIZED and the peer configured
775 with "connection-auth=on" we know that the peer supports pinned
778 if (_peer
->connection_auth
== 1)
781 /*At this point peer has configured with "connection-auth=auto"
782 parameter so we need some extra checks to decide if we are going
783 to allow pinned connections or not
786 /*if the peer configured with originserver just allow connection
787 pinning (squid 2.6 behaviour)
789 if (_peer
->options
.originserver
)
792 /*if the connections it is already pinned it is OK*/
793 if (request
->flags
.pinned
)
796 /*Allow pinned connections only if the Proxy-support header exists in
797 reply and has in its list the "Session-Based-Authentication"
798 which means that the peer supports connection pinning.
800 if (!hdr
->has(HDR_PROXY_SUPPORT
))
803 header
= hdr
->getStrOrList(HDR_PROXY_SUPPORT
);
804 /* XXX This ought to be done in a case-insensitive manner */
805 rc
= (strstr(header
.termedBuf(), "Session-Based-Authentication") != NULL
);
810 // Called when we parsed (and possibly adapted) the headers but
811 // had not starting storing (a.k.a., sending) the body yet.
813 HttpStateData::haveParsedReplyHeaders()
815 ServerStateData::haveParsedReplyHeaders();
817 Ctx ctx
= ctx_enter(entry
->mem_obj
->url
);
818 HttpReply
*rep
= finalReply();
820 if (rep
->sline
.status
== HTTP_PARTIAL_CONTENT
&&
822 currentOffset
= rep
->content_range
->spec
.offset
;
824 entry
->timestampsSet();
826 /* Check if object is cacheable or not based on reply code */
827 debugs(11, 3, "haveParsedReplyHeaders: HTTP CODE: " << rep
->sline
.status
);
829 if (neighbors_do_private_keys
)
830 httpMaybeRemovePublic(entry
, rep
->sline
.status
);
832 if (rep
->header
.has(HDR_VARY
)
833 #if X_ACCELERATOR_VARY
834 || rep
->header
.has(HDR_X_ACCELERATOR_VARY
)
837 const char *vary
= httpMakeVaryMark(orig_request
, rep
);
840 entry
->makePrivate();
845 entry
->mem_obj
->vary_headers
= xstrdup(vary
);
853 * If its not a reply that we will re-forward, then
854 * allow the client to get it.
856 if (!fwd
->reforwardableStatus(rep
->sline
.status
))
857 EBIT_CLR(entry
->flags
, ENTRY_FWD_HDR_WAIT
);
859 switch (cacheableReply()) {
866 entry
->makePrivate();
872 if (Config
.negativeTtl
> 0)
873 entry
->cacheNegatively();
876 entry
->makePrivate();
888 if (!ignoreCacheControl
&& rep
->cache_control
) {
889 if (EBIT_TEST(rep
->cache_control
->mask
, CC_PROXY_REVALIDATE
))
890 EBIT_SET(entry
->flags
, ENTRY_REVALIDATE
);
891 else if (EBIT_TEST(rep
->cache_control
->mask
, CC_MUST_REVALIDATE
))
892 EBIT_SET(entry
->flags
, ENTRY_REVALIDATE
);
896 headersLog(1, 0, request
->method
, rep
);
903 HttpStateData::ConnectionStatus
904 HttpStateData::statusIfComplete() const
906 const HttpReply
*rep
= virginReply();
908 * If the reply wants to close the connection, it takes precedence */
910 if (httpHeaderHasConnDir(&rep
->header
, "close"))
911 return COMPLETE_NONPERSISTENT_MSG
;
914 * If we didn't send a keep-alive request header, then this
915 * can not be a persistent connection.
917 if (!flags
.keepalive
)
918 return COMPLETE_NONPERSISTENT_MSG
;
921 * If we haven't sent the whole request then this can not be a persistent
924 if (!flags
.request_sent
) {
925 debugs(11, 1, "statusIfComplete: Request not yet fully sent \"" << RequestMethodStr(orig_request
->method
) << " " << entry
->url() << "\"" );
926 return COMPLETE_NONPERSISTENT_MSG
;
930 * What does the reply have to say about keep-alive?
934 * If the origin server (HTTP/1.0) does not send a keep-alive
935 * header, but keeps the connection open anyway, what happens?
936 * We'll return here and http.c waits for an EOF before changing
937 * store_status to STORE_OK. Combine this with ENTRY_FWD_HDR_WAIT
938 * and an error status code, and we might have to wait until
939 * the server times out the socket.
941 if (!rep
->keep_alive
)
942 return COMPLETE_NONPERSISTENT_MSG
;
944 return COMPLETE_PERSISTENT_MSG
;
947 HttpStateData::ConnectionStatus
948 HttpStateData::persistentConnStatus() const
950 debugs(11, 3, "persistentConnStatus: FD " << fd
<< " eof=" << eof
);
951 const HttpReply
*vrep
= virginReply();
952 debugs(11, 5, "persistentConnStatus: content_length=" << vrep
->content_length
);
954 /* If we haven't seen the end of reply headers, we are not done */
955 debugs(11, 5, "persistentConnStatus: flags.headers_parsed=" << flags
.headers_parsed
);
957 if (!flags
.headers_parsed
)
958 return INCOMPLETE_MSG
;
960 if (eof
) // already reached EOF
961 return COMPLETE_NONPERSISTENT_MSG
;
964 * In chunked response we do not know the content length but we are absolutely
965 * sure about the end of response, so we are calling the statusIfComplete to
966 * decide if we can be persistant
968 if (lastChunk
&& flags
.chunked
)
969 return statusIfComplete();
971 const int64_t clen
= vrep
->bodySize(request
->method
);
973 debugs(11, 5, "persistentConnStatus: clen=" << clen
);
975 /* If the body size is unknown we must wait for EOF */
977 return INCOMPLETE_MSG
;
980 * If the body size is known, we must wait until we've gotten all of it. */
983 // if (entry->mem_obj->endOffset() < vrep->content_length + vrep->hdr_sz)
984 const int64_t body_bytes_read
= reply_bytes_read
- header_bytes_read
;
985 debugs(11,5, "persistentConnStatus: body_bytes_read=" <<
986 body_bytes_read
<< " content_length=" << vrep
->content_length
);
988 if (body_bytes_read
< vrep
->content_length
)
989 return INCOMPLETE_MSG
;
991 if (body_bytes_truncated
> 0) // already read more than needed
992 return COMPLETE_NONPERSISTENT_MSG
; // disable pconns
996 * If there is no message body or we got it all, we can be persistent */
997 return statusIfComplete();
1001 * This is the callback after some data has been read from the network
1005 HttpStateData::ReadReplyWrapper(int fd, char *buf, size_t len, comm_err_t flag, int xerrno, void *data)
1007 HttpStateData *httpState = static_cast<HttpStateData *>(data);
1008 assert (fd == httpState->fd);
1009 // assert(buf == readBuf->content());
1010 PROF_start(HttpStateData_readReply);
1011 httpState->readReply(len, flag, xerrno);
1012 PROF_stop(HttpStateData_readReply);
1016 /* XXX this function is too long! */
1018 HttpStateData::readReply(const CommIoCbParams
&io
)
1024 assert(fd
== io
.fd
);
1026 flags
.do_next_read
= 0;
1028 debugs(11, 5, "httpReadReply: FD " << fd
<< ": len " << len
<< ".");
1030 // Bail out early on COMM_ERR_CLOSING - close handlers will tidy up for us
1031 if (io
.flag
== COMM_ERR_CLOSING
) {
1032 debugs(11, 3, "http socket closing");
1036 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
)) {
1037 maybeReadVirginBody();
1041 // handle I/O errors
1042 if (io
.flag
!= COMM_OK
|| len
< 0) {
1043 debugs(11, 2, "httpReadReply: FD " << fd
<< ": read failure: " << xstrerror() << ".");
1045 if (ignoreErrno(io
.xerrno
)) {
1046 flags
.do_next_read
= 1;
1049 err
= errorCon(ERR_READ_ERROR
, HTTP_BAD_GATEWAY
, fwd
->request
);
1050 err
->xerrno
= io
.xerrno
;
1052 flags
.do_next_read
= 0;
1061 readBuf
->appended(len
);
1062 reply_bytes_read
+= len
;
1065 DelayId delayId
= entry
->mem_obj
->mostBytesAllowed();
1066 delayId
.bytesIn(len
);
1069 kb_incr(&statCounter
.server
.all
.kbytes_in
, len
);
1070 kb_incr(&statCounter
.server
.http
.kbytes_in
, len
);
1071 IOStats
.Http
.reads
++;
1073 for (clen
= len
- 1, bin
= 0; clen
; bin
++)
1076 IOStats
.Http
.read_hist
[bin
]++;
1078 // update peer response time stats (%<pt)
1079 const timeval
&sent
= orig_request
->hier
.peer_http_request_sent
;
1080 orig_request
->hier
.peer_response_time
=
1081 sent
.tv_sec
? tvSubMsec(sent
, current_time
) : -1;
1085 * Here the RFC says we should ignore whitespace between replies, but we can't as
1086 * doing so breaks HTTP/0.9 replies beginning with witespace, and in addition
1087 * the response splitting countermeasures is extremely likely to trigger on this,
1088 * not allowing connection reuse in the first place.
1091 if (!flags
.headers_parsed
&& len
> 0 && fd_table
[fd
].uses
> 1) {
1092 /* Skip whitespace between replies */
1094 while (len
> 0 && xisspace(*buf
))
1095 xmemmove(buf
, buf
+ 1, len
--);
1098 /* Continue to read... */
1099 /* Timeout NOT increased. This whitespace was from previous reply */
1100 flags
.do_next_read
= 1;
1101 maybeReadVirginBody();
1108 if (len
== 0) { // reached EOF?
1110 flags
.do_next_read
= 0;
1113 if (!flags
.headers_parsed
) { // have not parsed headers yet?
1114 PROF_start(HttpStateData_processReplyHeader
);
1115 processReplyHeader();
1116 PROF_stop(HttpStateData_processReplyHeader
);
1118 if (!continueAfterParsingHeader()) // parsing error or need more data
1119 return; // TODO: send errors to ICAP
1121 adaptOrFinalizeReply();
1124 // kick more reads if needed and/or process the response body, if any
1125 PROF_start(HttpStateData_processReplyBody
);
1126 processReplyBody(); // may call serverComplete()
1127 PROF_stop(HttpStateData_processReplyBody
);
1131 \retval true if we can continue with processing the body or doing ICAP.
1134 HttpStateData::continueAfterParsingHeader()
1136 if (!flags
.headers_parsed
&& !eof
) {
1137 debugs(11, 9, HERE
<< "needs more at " << readBuf
->contentSize());
1138 flags
.do_next_read
= 1;
1139 /** \retval false If we have not finished parsing the headers and may get more data.
1140 * Schedules more reads to retrieve the missing data.
1142 maybeReadVirginBody(); // schedules all kinds of reads; TODO: rename
1146 /** If we are done with parsing, check for errors */
1148 err_type error
= ERR_NONE
;
1150 if (flags
.headers_parsed
) { // parsed headers, possibly with errors
1151 // check for header parsing errors
1152 if (HttpReply
*vrep
= virginReply()) {
1153 const http_status s
= vrep
->sline
.status
;
1154 const HttpVersion
&v
= vrep
->sline
.version
;
1155 if (s
== HTTP_INVALID_HEADER
&& v
!= HttpVersion(0,9)) {
1156 error
= ERR_INVALID_RESP
;
1157 } else if (s
== HTTP_HEADER_TOO_LARGE
) {
1158 fwd
->dontRetry(true);
1159 error
= ERR_TOO_BIG
;
1161 return true; // done parsing, got reply, and no error
1164 // parsed headers but got no reply
1165 error
= ERR_INVALID_RESP
;
1169 error
= readBuf
->hasContent() ?
1170 ERR_INVALID_RESP
: ERR_ZERO_SIZE_OBJECT
;
1173 assert(error
!= ERR_NONE
);
1175 fwd
->fail(errorCon(error
, HTTP_BAD_GATEWAY
, fwd
->request
));
1176 flags
.do_next_read
= 0;
1178 return false; // quit on error
1181 /** truncate what we read if we read too much so that writeReplyBody()
1182 writes no more than what we should have read */
1184 HttpStateData::truncateVirginBody()
1186 assert(flags
.headers_parsed
);
1188 HttpReply
*vrep
= virginReply();
1190 if (!vrep
->expectingBody(request
->method
, clen
) || clen
< 0)
1191 return; // no body or a body of unknown size, including chunked
1193 const int64_t body_bytes_read
= reply_bytes_read
- header_bytes_read
;
1194 if (body_bytes_read
- body_bytes_truncated
<= clen
)
1195 return; // we did not read too much or already took care of the extras
1197 if (const int64_t extras
= body_bytes_read
- body_bytes_truncated
- clen
) {
1198 // server sent more that the advertised content length
1199 debugs(11,5, HERE
<< "body_bytes_read=" << body_bytes_read
<<
1200 " clen=" << clen
<< '/' << vrep
->content_length
<<
1201 " body_bytes_truncated=" << body_bytes_truncated
<< '+' << extras
);
1203 readBuf
->truncate(extras
);
1204 body_bytes_truncated
+= extras
;
1209 * Call this when there is data from the origin server
1210 * which should be sent to either StoreEntry, or to ICAP...
1213 HttpStateData::writeReplyBody()
1215 truncateVirginBody(); // if needed
1216 const char *data
= readBuf
->content();
1217 int len
= readBuf
->contentSize();
1218 addVirginReplyBody(data
, len
);
1219 readBuf
->consume(len
);
1223 HttpStateData::decodeAndWriteReplyBody()
1225 const char *data
= NULL
;
1227 bool wasThereAnException
= false;
1228 assert(flags
.chunked
);
1229 assert(httpChunkDecoder
);
1230 SQUID_ENTER_THROWING_CODE();
1233 const bool doneParsing
= httpChunkDecoder
->parse(readBuf
,&decodedData
);
1234 len
= decodedData
.contentSize();
1235 data
=decodedData
.content();
1236 addVirginReplyBody(data
, len
);
1239 flags
.do_next_read
= 0;
1241 SQUID_EXIT_THROWING_CODE(wasThereAnException
);
1242 return wasThereAnException
;
1246 * processReplyBody has two purposes:
1247 * 1 - take the reply body data, if any, and put it into either
1248 * the StoreEntry, or give it over to ICAP.
1249 * 2 - see if we made it to the end of the response (persistent
1250 * connections and such)
1253 HttpStateData::processReplyBody()
1255 AsyncCall::Pointer call
;
1256 IpAddress client_addr
;
1257 bool ispinned
= false;
1259 if (!flags
.headers_parsed
) {
1260 flags
.do_next_read
= 1;
1261 maybeReadVirginBody();
1266 debugs(11,5, HERE
<< "adaptationAccessCheckPending=" << adaptationAccessCheckPending
);
1267 if (adaptationAccessCheckPending
)
1273 * At this point the reply headers have been parsed and consumed.
1274 * That means header content has been removed from readBuf and
1275 * it contains only body data.
1277 if (flags
.chunked
) {
1278 if (!decodeAndWriteReplyBody()) {
1279 flags
.do_next_read
= 0;
1286 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
)) {
1288 * The above writeReplyBody() call could ABORT this entry,
1289 * in that case, the server FD should already be closed.
1290 * there's nothing for us to do.
1294 switch (persistentConnStatus()) {
1295 case INCOMPLETE_MSG
:
1296 debugs(11, 5, "processReplyBody: INCOMPLETE_MSG");
1297 /* Wait for more data or EOF condition */
1298 if (flags
.keepalive_broken
) {
1300 commSetTimeout(fd
, 10, call
);
1303 commSetTimeout(fd
, Config
.Timeout
.read
, call
);
1306 flags
.do_next_read
= 1;
1309 case COMPLETE_PERSISTENT_MSG
:
1310 debugs(11, 5, "processReplyBody: COMPLETE_PERSISTENT_MSG");
1311 /* yes we have to clear all these! */
1313 commSetTimeout(fd
, -1, call
);
1314 flags
.do_next_read
= 0;
1316 comm_remove_close_handler(fd
, closeHandler
);
1317 closeHandler
= NULL
;
1318 fwd
->unregister(fd
);
1320 if (orig_request
->flags
.spoof_client_ip
)
1321 client_addr
= orig_request
->client_addr
;
1324 if (request
->flags
.pinned
) {
1326 } else if (request
->flags
.connection_auth
&& request
->flags
.auth_sent
) {
1330 if (orig_request
->pinnedConnection() && ispinned
) {
1331 orig_request
->pinnedConnection()->pinConnection(fd
, orig_request
, _peer
,
1332 (request
->flags
.connection_auth
!= 0));
1334 fwd
->pconnPush(fd
, _peer
, request
, orig_request
->GetHost(), client_addr
);
1342 case COMPLETE_NONPERSISTENT_MSG
:
1343 debugs(11, 5, "processReplyBody: COMPLETE_NONPERSISTENT_MSG");
1348 maybeReadVirginBody();
1352 HttpStateData::maybeReadVirginBody()
1354 // we may need to grow the buffer if headers do not fit
1355 const int minRead
= flags
.headers_parsed
? 0 :1024;
1356 const int read_size
= replyBodySpace(*readBuf
, minRead
);
1358 debugs(11,9, HERE
<< (flags
.do_next_read
? "may" : "wont") <<
1359 " read up to " << read_size
<< " bytes from FD " << fd
);
1362 * why <2? Because delayAwareRead() won't actually read if
1363 * you ask it to read 1 byte. The delayed read request
1364 * just gets re-queued until the client side drains, then
1365 * the I/O thread hangs. Better to not register any read
1366 * handler until we get a notification from someone that
1367 * its okay to read again.
1372 if (flags
.do_next_read
) {
1373 flags
.do_next_read
= 0;
1374 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
1375 entry
->delayAwareRead(fd
, readBuf
->space(read_size
), read_size
,
1376 asyncCall(11, 5, "HttpStateData::readReply",
1377 Dialer(this, &HttpStateData::readReply
)));
1382 * This will be called when request write is complete.
1385 HttpStateData::sendComplete(const CommIoCbParams
&io
)
1387 debugs(11, 5, "httpSendComplete: FD " << fd
<< ": size " << io
.size
<< ": errflag " << io
.flag
<< ".");
1388 #if URL_CHECKSUM_DEBUG
1390 entry
->mem_obj
->checkUrlChecksum();
1394 fd_bytes(fd
, io
.size
, FD_WRITE
);
1395 kb_incr(&statCounter
.server
.all
.kbytes_out
, io
.size
);
1396 kb_incr(&statCounter
.server
.http
.kbytes_out
, io
.size
);
1399 if (io
.flag
== COMM_ERR_CLOSING
)
1404 err
= errorCon(ERR_WRITE_ERROR
, HTTP_BAD_GATEWAY
, fwd
->request
);
1405 err
->xerrno
= io
.xerrno
;
1412 * Set the read timeout here because it hasn't been set yet.
1413 * We only set the read timeout after the request has been
1414 * fully written to the server-side. If we start the timeout
1415 * after connection establishment, then we are likely to hit
1416 * the timeout for POST/PUT requests that have very large
1419 typedef CommCbMemFunT
<HttpStateData
, CommTimeoutCbParams
> TimeoutDialer
;
1420 AsyncCall::Pointer timeoutCall
= asyncCall(11, 5, "HttpStateData::httpTimeout",
1421 TimeoutDialer(this,&HttpStateData::httpTimeout
));
1423 commSetTimeout(fd
, Config
.Timeout
.read
, timeoutCall
);
1425 flags
.request_sent
= 1;
1427 orig_request
->hier
.peer_http_request_sent
= current_time
;
1430 // Close the HTTP server connection. Used by serverComplete().
1432 HttpStateData::closeServer()
1434 debugs(11,5, HERE
<< "closing HTTP server FD " << fd
<< " this " << this);
1437 fwd
->unregister(fd
);
1438 comm_remove_close_handler(fd
, closeHandler
);
1439 closeHandler
= NULL
;
1446 HttpStateData::doneWithServer() const
1453 * Fixup authentication request headers for special cases
1456 httpFixupAuthentication(HttpRequest
* request
, HttpRequest
* orig_request
, const HttpHeader
* hdr_in
, HttpHeader
* hdr_out
, http_state_flags flags
)
1458 http_hdr_type header
= flags
.originpeer
? HDR_AUTHORIZATION
: HDR_PROXY_AUTHORIZATION
;
1460 /* Nothing to do unless we are forwarding to a peer */
1461 if (!request
->flags
.proxying
)
1464 /* Needs to be explicitly enabled */
1465 if (!orig_request
->peer_login
)
1468 /* Maybe already dealt with? */
1469 if (hdr_out
->has(header
))
1472 /* Nothing to do here for PASSTHRU */
1473 if (strcmp(orig_request
->peer_login
, "PASSTHRU") == 0)
1476 /* PROXYPASS is a special case, single-signon to servers with the proxy password (basic only) */
1477 if (flags
.originpeer
&& strcmp(orig_request
->peer_login
, "PROXYPASS") == 0 && hdr_in
->has(HDR_PROXY_AUTHORIZATION
)) {
1478 const char *auth
= hdr_in
->getStr(HDR_PROXY_AUTHORIZATION
);
1480 if (auth
&& strncasecmp(auth
, "basic ", 6) == 0) {
1481 hdr_out
->putStr(header
, auth
);
1486 /* Special mode to pass the username to the upstream cache */
1487 if (*orig_request
->peer_login
== '*') {
1489 const char *username
= "-";
1491 if (orig_request
->extacl_user
.size())
1492 username
= orig_request
->extacl_user
.termedBuf();
1493 else if (orig_request
->auth_user_request
)
1494 username
= orig_request
->auth_user_request
->username();
1496 snprintf(loginbuf
, sizeof(loginbuf
), "%s%s", username
, orig_request
->peer_login
+ 1);
1498 httpHeaderPutStrf(hdr_out
, header
, "Basic %s",
1499 base64_encode(loginbuf
));
1503 /* external_acl provided credentials */
1504 if (orig_request
->extacl_user
.size() && orig_request
->extacl_passwd
.size() &&
1505 (strcmp(orig_request
->peer_login
, "PASS") == 0 ||
1506 strcmp(orig_request
->peer_login
, "PROXYPASS") == 0)) {
1508 snprintf(loginbuf
, sizeof(loginbuf
), SQUIDSTRINGPH
":" SQUIDSTRINGPH
,
1509 SQUIDSTRINGPRINT(orig_request
->extacl_user
),
1510 SQUIDSTRINGPRINT(orig_request
->extacl_passwd
));
1511 httpHeaderPutStrf(hdr_out
, header
, "Basic %s",
1512 base64_encode(loginbuf
));
1516 /* Kerberos login to peer */
1517 #if HAVE_KRB5 && HAVE_GSSAPI
1518 if (strncmp(orig_request
->peer_login
, "NEGOTIATE",strlen("NEGOTIATE")) == 0) {
1520 char *PrincipalName
=NULL
,*p
;
1521 if ((p
=strchr(orig_request
->peer_login
,':')) != NULL
) {
1524 Token
= peer_proxy_negotiate_auth(PrincipalName
,request
->peer_host
);
1526 httpHeaderPutStrf(hdr_out
, HDR_PROXY_AUTHORIZATION
, "Negotiate %s",Token
);
1530 #endif /* HAVE_KRB5 && HAVE_GSSAPI */
1532 httpHeaderPutStrf(hdr_out
, header
, "Basic %s",
1533 base64_encode(orig_request
->peer_login
));
1538 * build request headers and append them to a given MemBuf
1539 * used by buildRequestPrefix()
1540 * note: initialised the HttpHeader, the caller is responsible for Clean()-ing
1543 HttpStateData::httpBuildRequestHeader(HttpRequest
* request
,
1544 HttpRequest
* orig_request
,
1546 HttpHeader
* hdr_out
,
1547 http_state_flags flags
)
1549 /* building buffer for complex strings */
1550 #define BBUF_SZ (MAX_URL+32)
1551 LOCAL_ARRAY(char, bbuf
, BBUF_SZ
);
1552 LOCAL_ARRAY(char, ntoabuf
, MAX_IPSTRLEN
);
1553 const HttpHeader
*hdr_in
= &orig_request
->header
;
1554 const HttpHeaderEntry
*e
= NULL
;
1555 HttpHeaderPos pos
= HttpHeaderInitPos
;
1556 assert (hdr_out
->owner
== hoRequest
);
1558 /* append our IMS header */
1559 if (request
->lastmod
> -1)
1560 hdr_out
->putTime(HDR_IF_MODIFIED_SINCE
, request
->lastmod
);
1562 bool we_do_ranges
= decideIfWeDoRanges (orig_request
);
1564 String
strConnection (hdr_in
->getList(HDR_CONNECTION
));
1566 while ((e
= hdr_in
->getEntry(&pos
)))
1567 copyOneHeaderFromClientsideRequestToUpstreamRequest(e
, strConnection
, request
, orig_request
, hdr_out
, we_do_ranges
, flags
);
1569 /* Abstraction break: We should interpret multipart/byterange responses
1570 * into offset-length data, and this works around our inability to do so.
1572 if (!we_do_ranges
&& orig_request
->multipartRangeRequest()) {
1573 /* don't cache the result */
1574 orig_request
->flags
.cachable
= 0;
1575 /* pretend it's not a range request */
1576 delete orig_request
->range
;
1577 orig_request
->range
= NULL
;
1578 orig_request
->flags
.range
= 0;
1582 if (Config
.onoff
.via
) {
1584 strVia
= hdr_in
->getList(HDR_VIA
);
1585 snprintf(bbuf
, BBUF_SZ
, "%d.%d %s",
1586 orig_request
->http_ver
.major
,
1587 orig_request
->http_ver
.minor
, ThisCache
);
1588 strListAdd(&strVia
, bbuf
, ',');
1589 hdr_out
->putStr(HDR_VIA
, strVia
.termedBuf());
1594 if (orig_request
->flags
.accelerated
) {
1595 /* Append Surrogate-Capabilities */
1596 String
strSurrogate (hdr_in
->getList(HDR_SURROGATE_CAPABILITY
));
1597 snprintf(bbuf
, BBUF_SZ
, "%s=\"Surrogate/1.0 ESI/1.0\"",
1598 Config
.Accel
.surrogate_id
);
1599 strListAdd(&strSurrogate
, bbuf
, ',');
1600 hdr_out
->putStr(HDR_SURROGATE_CAPABILITY
, strSurrogate
.termedBuf());
1604 /** \pre Handle X-Forwarded-For */
1605 if (strcmp(opt_forwarded_for
, "delete") != 0) {
1607 String strFwd
= hdr_in
->getList(HDR_X_FORWARDED_FOR
);
1609 if (strFwd
.size() > 65536/2) {
1610 // There is probably a forwarding loop with Via detection disabled.
1611 // If we do nothing, String will assert on overflow soon.
1612 // TODO: Terminate all transactions with huge XFF?
1615 static int warnedCount
= 0;
1616 if (warnedCount
++ < 100) {
1617 const char *url
= entry
? entry
->url() : urlCanonical(orig_request
);
1618 debugs(11, 1, "Warning: likely forwarding loop with " << url
);
1622 if (strcmp(opt_forwarded_for
, "on") == 0) {
1623 /** If set to ON - append client IP or 'unknown'. */
1624 if ( orig_request
->client_addr
.IsNoAddr() )
1625 strListAdd(&strFwd
, "unknown", ',');
1627 strListAdd(&strFwd
, orig_request
->client_addr
.NtoA(ntoabuf
, MAX_IPSTRLEN
), ',');
1628 } else if (strcmp(opt_forwarded_for
, "off") == 0) {
1629 /** If set to OFF - append 'unknown'. */
1630 strListAdd(&strFwd
, "unknown", ',');
1631 } else if (strcmp(opt_forwarded_for
, "transparent") == 0) {
1632 /** If set to TRANSPARENT - pass through unchanged. */
1633 } else if (strcmp(opt_forwarded_for
, "truncate") == 0) {
1634 /** If set to TRUNCATE - drop existing list and replace with client IP or 'unknown'. */
1635 if ( orig_request
->client_addr
.IsNoAddr() )
1638 strFwd
= orig_request
->client_addr
.NtoA(ntoabuf
, MAX_IPSTRLEN
);
1640 if (strFwd
.size() > 0)
1641 hdr_out
->putStr(HDR_X_FORWARDED_FOR
, strFwd
.termedBuf());
1643 /** If set to DELETE - do not copy through. */
1645 /* append Host if not there already */
1646 if (!hdr_out
->has(HDR_HOST
)) {
1647 if (orig_request
->peer_domain
) {
1648 hdr_out
->putStr(HDR_HOST
, orig_request
->peer_domain
);
1649 } else if (orig_request
->port
== urlDefaultPort(orig_request
->protocol
)) {
1650 /* use port# only if not default */
1651 hdr_out
->putStr(HDR_HOST
, orig_request
->GetHost());
1653 httpHeaderPutStrf(hdr_out
, HDR_HOST
, "%s:%d",
1654 orig_request
->GetHost(),
1655 (int) orig_request
->port
);
1659 /* append Authorization if known in URL, not in header and going direct */
1660 if (!hdr_out
->has(HDR_AUTHORIZATION
)) {
1661 if (!request
->flags
.proxying
&& *request
->login
) {
1662 httpHeaderPutStrf(hdr_out
, HDR_AUTHORIZATION
, "Basic %s",
1663 base64_encode(request
->login
));
1667 /* Fixup (Proxy-)Authorization special cases. Plain relaying dealt with above */
1668 httpFixupAuthentication(request
, orig_request
, hdr_in
, hdr_out
, flags
);
1670 /* append Cache-Control, add max-age if not there already */
1672 HttpHdrCc
*cc
= hdr_in
->getCc();
1675 cc
= httpHdrCcCreate();
1677 #if 0 /* see bug 2330 */
1678 /* Set no-cache if determined needed but not found */
1679 if (orig_request
->flags
.nocache
)
1680 EBIT_SET(cc
->mask
, CC_NO_CACHE
);
1683 /* Add max-age only without no-cache */
1684 if (!EBIT_TEST(cc
->mask
, CC_MAX_AGE
) && !EBIT_TEST(cc
->mask
, CC_NO_CACHE
)) {
1686 entry
? entry
->url() : urlCanonical(orig_request
);
1687 httpHdrCcSetMaxAge(cc
, getMaxAge(url
));
1689 if (request
->urlpath
.size())
1690 assert(strstr(url
, request
->urlpath
.termedBuf()));
1693 /* Enforce sibling relations */
1694 if (flags
.only_if_cached
)
1695 EBIT_SET(cc
->mask
, CC_ONLY_IF_CACHED
);
1699 httpHdrCcDestroy(cc
);
1702 /* maybe append Connection: keep-alive */
1703 if (flags
.keepalive
) {
1704 if (flags
.proxying
) {
1705 hdr_out
->putStr(HDR_PROXY_CONNECTION
, "keep-alive");
1707 hdr_out
->putStr(HDR_CONNECTION
, "keep-alive");
1711 /* append Front-End-Https */
1712 if (flags
.front_end_https
) {
1713 if (flags
.front_end_https
== 1 || request
->protocol
== PROTO_HTTPS
)
1714 hdr_out
->putStr(HDR_FRONT_END_HTTPS
, "On");
1717 /* Now mangle the headers. */
1718 if (Config2
.onoff
.mangle_request_headers
)
1719 httpHdrMangleList(hdr_out
, request
, ROR_REQUEST
);
1721 strConnection
.clean();
1725 * Decides whether a particular header may be cloned from the received Clients request
1726 * to our outgoing fetch request.
1729 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
)
1731 debugs(11, 5, "httpBuildRequestHeader: " << e
->name
<< ": " << e
->value
);
1735 /** \par RFC 2616 sect 13.5.1 - Hop-by-Hop headers which Squid should not pass on. */
1737 case HDR_PROXY_AUTHORIZATION
:
1738 /** \par Proxy-Authorization:
1739 * Only pass on proxy authentication to peers for which
1740 * authentication forwarding is explicitly enabled
1742 if (!flags
.originpeer
&& flags
.proxying
&& orig_request
->peer_login
&&
1743 (strcmp(orig_request
->peer_login
, "PASS") == 0 ||
1744 strcmp(orig_request
->peer_login
, "PROXYPASS") == 0 ||
1745 strcmp(orig_request
->peer_login
, "PASSTHRU") == 0)) {
1746 hdr_out
->addEntry(e
->clone());
1750 /** \par RFC 2616 sect 13.5.1 - Hop-by-Hop headers which Squid does not pass on. */
1752 case HDR_CONNECTION
: /** \par Connection: */
1753 case HDR_TE
: /** \par TE: */
1754 case HDR_KEEP_ALIVE
: /** \par Keep-Alive: */
1755 case HDR_PROXY_AUTHENTICATE
: /** \par Proxy-Authenticate: */
1756 case HDR_TRAILERS
: /** \par Trailers: */
1757 case HDR_UPGRADE
: /** \par Upgrade: */
1758 case HDR_TRANSFER_ENCODING
: /** \par Transfer-Encoding: */
1762 /** \par OTHER headers I haven't bothered to track down yet. */
1764 case HDR_AUTHORIZATION
:
1765 /** \par WWW-Authorization:
1766 * Pass on WWW authentication */
1768 if (!flags
.originpeer
) {
1769 hdr_out
->addEntry(e
->clone());
1771 /** \note In accelerators, only forward authentication if enabled
1772 * (see also httpFixupAuthentication for special cases)
1774 if (orig_request
->peer_login
&&
1775 (strcmp(orig_request
->peer_login
, "PASS") == 0 ||
1776 strcmp(orig_request
->peer_login
, "PASSTHRU") == 0 ||
1777 strcmp(orig_request
->peer_login
, "PROXYPASS") == 0)) {
1778 hdr_out
->addEntry(e
->clone());
1786 * Normally Squid rewrites the Host: header.
1787 * However, there is one case when we don't: If the URL
1788 * went through our redirector and the admin configured
1789 * 'redir_rewrites_host' to be off.
1791 if (orig_request
->peer_domain
)
1792 hdr_out
->putStr(HDR_HOST
, orig_request
->peer_domain
);
1793 else if (request
->flags
.redirected
&& !Config
.onoff
.redir_rewrites_host
)
1794 hdr_out
->addEntry(e
->clone());
1796 /* use port# only if not default */
1798 if (orig_request
->port
== urlDefaultPort(orig_request
->protocol
)) {
1799 hdr_out
->putStr(HDR_HOST
, orig_request
->GetHost());
1801 httpHeaderPutStrf(hdr_out
, HDR_HOST
, "%s:%d",
1802 orig_request
->GetHost(),
1803 (int) orig_request
->port
);
1809 case HDR_IF_MODIFIED_SINCE
:
1810 /** \par If-Modified-Since:
1811 * append unless we added our own;
1812 * \note at most one client's ims header can pass through */
1814 if (!hdr_out
->has(HDR_IF_MODIFIED_SINCE
))
1815 hdr_out
->addEntry(e
->clone());
1819 case HDR_MAX_FORWARDS
:
1820 /** \par Max-Forwards:
1821 * pass only on TRACE or OPTIONS requests */
1822 if (orig_request
->method
== METHOD_TRACE
|| orig_request
->method
== METHOD_OPTIONS
) {
1823 const int64_t hops
= e
->getInt64();
1826 hdr_out
->putInt64(HDR_MAX_FORWARDS
, hops
- 1);
1833 * If Via is disabled then forward any received header as-is.
1834 * Otherwise leave for explicit updated addition later. */
1836 if (!Config
.onoff
.via
)
1837 hdr_out
->addEntry(e
->clone());
1845 case HDR_REQUEST_RANGE
:
1846 /** \par Range:, If-Range:, Request-Range:
1847 * Only pass if we accept ranges */
1849 hdr_out
->addEntry(e
->clone());
1853 case HDR_PROXY_CONNECTION
:
1855 case HDR_X_FORWARDED_FOR
:
1857 case HDR_CACHE_CONTROL
:
1858 /** \par Proxy-Connaction:, X-Forwarded-For:, Cache-Control:
1859 * handled specially by Squid, so leave off for now.
1860 * append these after the loop if needed */
1863 case HDR_FRONT_END_HTTPS
:
1864 /** \par Front-End-Https:
1865 * Pass thru only if peer is configured with front-end-https */
1866 if (!flags
.front_end_https
)
1867 hdr_out
->addEntry(e
->clone());
1873 * pass on all other header fields
1874 * which are NOT listed by the special Connection: header. */
1876 if (strConnection
.size()>0 && strListIsMember(&strConnection
, e
->name
.termedBuf(), ',')) {
1877 debugs(11, 2, "'" << e
->name
<< "' header cropped by Connection: definition");
1881 hdr_out
->addEntry(e
->clone());
1886 HttpStateData::decideIfWeDoRanges (HttpRequest
* orig_request
)
1889 /* decide if we want to do Ranges ourselves
1890 * and fetch the whole object now)
1891 * We want to handle Ranges ourselves iff
1892 * - we can actually parse client Range specs
1893 * - the specs are expected to be simple enough (e.g. no out-of-order ranges)
1894 * - reply will be cachable
1895 * (If the reply will be uncachable we have to throw it away after
1896 * serving this request, so it is better to forward ranges to
1897 * the server and fetch only the requested content)
1900 if (NULL
== orig_request
->range
|| !orig_request
->flags
.cachable
1901 || orig_request
->range
->offsetLimitExceeded() || orig_request
->flags
.connection_auth
)
1904 debugs(11, 8, "decideIfWeDoRanges: range specs: " <<
1905 orig_request
->range
<< ", cachable: " <<
1906 orig_request
->flags
.cachable
<< "; we_do_ranges: " << result
);
1911 /* build request prefix and append it to a given MemBuf;
1912 * return the length of the prefix */
1914 HttpStateData::buildRequestPrefix(HttpRequest
* aRequest
,
1915 HttpRequest
* original_request
,
1916 StoreEntry
* sentry
,
1918 http_state_flags stateFlags
)
1920 const int offset
= mb
->size
;
1921 HttpVersion
httpver(1, 0);
1922 mb
->Printf("%s %s HTTP/%d.%d\r\n",
1923 RequestMethodStr(aRequest
->method
),
1924 aRequest
->urlpath
.size() ? aRequest
->urlpath
.termedBuf() : "/",
1925 httpver
.major
,httpver
.minor
);
1926 /* build and pack headers */
1928 HttpHeader
hdr(hoRequest
);
1930 httpBuildRequestHeader(aRequest
, original_request
, sentry
, &hdr
, stateFlags
);
1932 if (aRequest
->flags
.pinned
&& aRequest
->flags
.connection_auth
)
1933 aRequest
->flags
.auth_sent
= 1;
1934 else if (hdr
.has(HDR_AUTHORIZATION
))
1935 aRequest
->flags
.auth_sent
= 1;
1937 packerToMemInit(&p
, mb
);
1942 /* append header terminator */
1943 mb
->append(crlf
, 2);
1944 return mb
->size
- offset
;
1947 /* This will be called when connect completes. Write request. */
1949 HttpStateData::sendRequest()
1953 debugs(11, 5, "httpSendRequest: FD " << fd
<< ", request " << request
<< ", this " << this << ".");
1954 typedef CommCbMemFunT
<HttpStateData
, CommTimeoutCbParams
> TimeoutDialer
;
1955 AsyncCall::Pointer timeoutCall
= asyncCall(11, 5, "HttpStateData::httpTimeout",
1956 TimeoutDialer(this,&HttpStateData::httpTimeout
));
1957 commSetTimeout(fd
, Config
.Timeout
.lifetime
, timeoutCall
);
1958 flags
.do_next_read
= 1;
1959 maybeReadVirginBody();
1961 if (orig_request
->body_pipe
!= NULL
) {
1962 if (!startRequestBodyFlow()) // register to receive body data
1964 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
1965 Dialer
dialer(this, &HttpStateData::sentRequestBody
);
1966 requestSender
= asyncCall(11,5, "HttpStateData::sentRequestBody", dialer
);
1968 assert(!requestBodySource
);
1969 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
1970 Dialer
dialer(this, &HttpStateData::sendComplete
);
1971 requestSender
= asyncCall(11,5, "HttpStateData::SendComplete", dialer
);
1974 if (_peer
!= NULL
) {
1975 if (_peer
->options
.originserver
) {
1977 flags
.originpeer
= 1;
1980 flags
.originpeer
= 0;
1984 flags
.originpeer
= 0;
1988 * Is keep-alive okay for all request methods?
1990 if (orig_request
->flags
.must_keepalive
)
1991 flags
.keepalive
= 1;
1992 else if (!Config
.onoff
.server_pconns
)
1993 flags
.keepalive
= 0;
1994 else if (_peer
== NULL
)
1995 flags
.keepalive
= 1;
1996 else if (_peer
->stats
.n_keepalives_sent
< 10)
1997 flags
.keepalive
= 1;
1998 else if ((double) _peer
->stats
.n_keepalives_recv
/
1999 (double) _peer
->stats
.n_keepalives_sent
> 0.50)
2000 flags
.keepalive
= 1;
2003 if (neighborType(_peer
, request
) == PEER_SIBLING
&&
2004 !_peer
->options
.allow_miss
)
2005 flags
.only_if_cached
= 1;
2007 flags
.front_end_https
= _peer
->front_end_https
;
2011 request
->peer_host
=_peer
?_peer
->host
:NULL
;
2012 buildRequestPrefix(request
, orig_request
, entry
, &mb
, flags
);
2013 debugs(11, 6, "httpSendRequest: FD " << fd
<< ":\n" << mb
.buf
);
2014 comm_write_mbuf(fd
, &mb
, requestSender
);
2020 httpStart(FwdState
*fwd
)
2022 debugs(11, 3, "httpStart: \"" << RequestMethodStr(fwd
->request
->method
) << " " << fwd
->entry
->url() << "\"" );
2023 HttpStateData
*httpState
= new HttpStateData(fwd
);
2025 if (!httpState
->sendRequest()) {
2026 debugs(11, 3, "httpStart: aborted");
2031 statCounter
.server
.all
.requests
++;
2032 statCounter
.server
.http
.requests
++;
2035 * We used to set the read timeout here, but not any more.
2036 * Now its set in httpSendComplete() after the full request,
2037 * including request body, has been written to the server.
2042 HttpStateData::doneSendingRequestBody()
2044 debugs(11,5, HERE
<< "doneSendingRequestBody: FD " << fd
);
2047 if (Config
.accessList
.brokenPosts
) {
2048 ACLFilledChecklist
ch(Config
.accessList
.brokenPosts
, request
, NULL
);
2049 if (!ch
.fastCheck()) {
2050 debugs(11, 5, "doneSendingRequestBody: didn't match brokenPosts");
2051 CommIoCbParams
io(NULL
);
2056 debugs(11, 2, "doneSendingRequestBody: matched brokenPosts");
2057 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2058 Dialer
dialer(this, &HttpStateData::sendComplete
);
2059 AsyncCall::Pointer call
= asyncCall(11,5, "HttpStateData::SendComplete", dialer
);
2060 comm_write(fd
, "\r\n", 2, call
);
2064 debugs(11, 5, "doneSendingRequestBody: No brokenPosts list");
2065 #endif /* HTTP_VIOLATIONS */
2067 CommIoCbParams
io(NULL
);
2073 // more origin request body data is available
2075 HttpStateData::handleMoreRequestBodyAvailable()
2077 if (eof
|| fd
< 0) {
2078 // XXX: we should check this condition in other callbacks then!
2079 // TODO: Check whether this can actually happen: We should unsubscribe
2080 // as a body consumer when the above condition(s) are detected.
2081 debugs(11, 1, HERE
<< "Transaction aborted while reading HTTP body");
2085 assert(requestBodySource
!= NULL
);
2087 if (requestBodySource
->buf().hasContent()) {
2088 // XXX: why does not this trigger a debug message on every request?
2090 if (flags
.headers_parsed
&& !flags
.abuse_detected
) {
2091 flags
.abuse_detected
= 1;
2092 debugs(11, 1, "http handleMoreRequestBodyAvailable: Likely proxy abuse detected '" << orig_request
->client_addr
<< "' -> '" << entry
->url() << "'" );
2094 if (virginReply()->sline
.status
== HTTP_INVALID_HEADER
) {
2101 HttpStateData::handleMoreRequestBodyAvailable();
2104 // premature end of the request body
2106 HttpStateData::handleRequestBodyProducerAborted()
2108 ServerStateData::handleRequestBodyProducerAborted();
2109 // XXX: SendComplete(COMM_ERR_CLOSING) does little. Is it enough?
2110 CommIoCbParams
io(NULL
);
2112 io
.flag
=COMM_ERR_CLOSING
;
2116 // called when we wrote request headers(!) or a part of the body
2118 HttpStateData::sentRequestBody(const CommIoCbParams
&io
)
2121 kb_incr(&statCounter
.server
.http
.kbytes_out
, io
.size
);
2123 ServerStateData::sentRequestBody(io
);
2126 // Quickly abort the transaction
2127 // TODO: destruction should be sufficient as the destructor should cleanup,
2128 // including canceling close handlers
2130 HttpStateData::abortTransaction(const char *reason
)
2132 debugs(11,5, HERE
<< "aborting transaction for " << reason
<<
2133 "; FD " << fd
<< ", this " << this);
2140 fwd
->handleUnregisteredServerEnd();
2141 deleteThis("HttpStateData::abortTransaction");
2146 httpBuildVersion(HttpVersion
* version
, unsigned int major
, unsigned int minor
)
2148 version
->major
= major
;
2149 version
->minor
= minor
;
2154 HttpStateData::originalRequest()
2156 return orig_request
;