2 * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
9 /* DEBUG: section 11 Hypertext Transfer Protocol (HTTP) */
12 * Anonymizing patch by lutz@as-node.jena.thur.de
13 * have a look into http-anon.c to get more informations.
17 #include "acl/FilledChecklist.h"
18 #include "base/AsyncJobCalls.h"
19 #include "base/TextException.h"
21 #include "CachePeer.h"
22 #include "client_side.h"
23 #include "comm/Connection.h"
24 #include "comm/Read.h"
25 #include "comm/Write.h"
27 #include "err_detail_type.h"
28 #include "errorpage.h"
33 #include "http/one/ResponseParser.h"
34 #include "http/one/TeChunkedParser.h"
35 #include "HttpControlMsg.h"
36 #include "HttpHdrCc.h"
37 #include "HttpHdrContRange.h"
38 #include "HttpHdrSc.h"
39 #include "HttpHdrScTarget.h"
40 #include "HttpHeaderTools.h"
41 #include "HttpReply.h"
42 #include "HttpRequest.h"
43 #include "HttpStateFlags.h"
44 #include "log/access_log.h"
46 #include "MemObject.h"
47 #include "neighbors.h"
48 #include "peer_proxy_negotiate_auth.h"
49 #include "profiler/Profiler.h"
51 #include "RefreshPattern.h"
53 #include "SquidConfig.h"
54 #include "SquidTime.h"
55 #include "StatCounters.h"
63 #include "auth/UserRequest.h"
66 #include "DelayPools.h"
69 #define SQUID_ENTER_THROWING_CODE() try {
70 #define SQUID_EXIT_THROWING_CODE(status) \
73 catch (const std::exception &e) { \
74 debugs (11, 1, "Exception error:" << e.what()); \
78 CBDATA_CLASS_INIT(HttpStateData
);
80 static const char *const crlf
= "\r\n";
82 static void httpMaybeRemovePublic(StoreEntry
*, Http::StatusCode
);
83 static void copyOneHeaderFromClientsideRequestToUpstreamRequest(const HttpHeaderEntry
*e
, const String strConnection
, const HttpRequest
* request
,
84 HttpHeader
* hdr_out
, const int we_do_ranges
, const HttpStateFlags
&);
85 //Declared in HttpHeaderTools.cc
86 void httpHdrAdd(HttpHeader
*heads
, HttpRequest
*request
, const AccessLogEntryPointer
&al
, HeaderWithAclList
&headers_add
);
88 HttpStateData::HttpStateData(FwdState
*theFwdState
) :
89 AsyncJob("HttpStateData"),
92 httpChunkDecoder(NULL
),
96 debugs(11,5,HERE
<< "HttpStateData " << this << " created");
97 ignoreCacheControl
= false;
98 surrogateNoStore
= false;
99 serverConnection
= fwd
->serverConnection();
101 // reset peer response time stats for %<pt
102 request
->hier
.peer_http_request_sent
.tv_sec
= 0;
103 request
->hier
.peer_http_request_sent
.tv_usec
= 0;
105 if (fwd
->serverConnection() != NULL
)
106 _peer
= cbdataReference(fwd
->serverConnection()->getPeer()); /* might be NULL */
109 request
->flags
.proxying
= true;
111 * This NEIGHBOR_PROXY_ONLY check probably shouldn't be here.
112 * We might end up getting the object from somewhere else if,
113 * for example, the request to this neighbor fails.
115 if (_peer
->options
.proxy_only
)
116 entry
->releaseRequest();
119 entry
->setNoDelay(_peer
->options
.no_delay
);
124 * register the handler to free HTTP state data when the FD closes
126 typedef CommCbMemFunT
<HttpStateData
, CommCloseCbParams
> Dialer
;
127 closeHandler
= JobCallback(9, 5, Dialer
, this, HttpStateData::httpStateConnClosed
);
128 comm_add_close_handler(serverConnection
->fd
, closeHandler
);
131 HttpStateData::~HttpStateData()
134 * don't forget that ~Client() gets called automatically
137 if (httpChunkDecoder
)
138 delete httpChunkDecoder
;
140 cbdataReferenceDone(_peer
);
142 debugs(11,5, HERE
<< "HttpStateData " << this << " destroyed; " << serverConnection
);
145 const Comm::ConnectionPointer
&
146 HttpStateData::dataConnection() const
148 return serverConnection
;
152 HttpStateData::httpStateConnClosed(const CommCloseCbParams
¶ms
)
154 debugs(11, 5, "httpStateFree: FD " << params
.fd
<< ", httpState=" << params
.data
);
155 mustStop("HttpStateData::httpStateConnClosed");
159 HttpStateData::httpTimeout(const CommTimeoutCbParams
&)
161 debugs(11, 4, serverConnection
<< ": '" << entry
->url() << "'");
163 if (entry
->store_status
== STORE_PENDING
) {
164 fwd
->fail(new ErrorState(ERR_READ_TIMEOUT
, Http::scGatewayTimeout
, fwd
->request
));
167 serverConnection
->close();
170 /// Remove an existing public store entry if the incoming response (to be
171 /// stored in a currently private entry) is going to invalidate it.
173 httpMaybeRemovePublic(StoreEntry
* e
, Http::StatusCode status
)
179 // If the incoming response already goes into a public entry, then there is
180 // nothing to remove. This protects ready-for-collapsing entries as well.
181 if (!EBIT_TEST(e
->flags
, KEY_PRIVATE
))
188 case Http::scNonAuthoritativeInformation
:
190 case Http::scMultipleChoices
:
192 case Http::scMovedPermanently
:
198 case Http::scNotFound
:
203 case Http::scForbidden
:
205 case Http::scMethodNotAllowed
:
212 case Http::scUnauthorized
:
222 * Any 2xx response should eject previously cached entities...
225 if (status
>= 200 && status
< 300)
233 if (!remove
&& !forbidden
)
238 if (e
->mem_obj
->request
)
239 pe
= storeGetPublicByRequest(e
->mem_obj
->request
);
241 pe
= storeGetPublic(e
->mem_obj
->storeId(), e
->mem_obj
->method
);
246 neighborsHtcpClear(e
, NULL
, e
->mem_obj
->request
, e
->mem_obj
->method
, HTCP_CLR_INVALIDATION
);
252 * Also remove any cached HEAD response in case the object has
255 if (e
->mem_obj
->request
)
256 pe
= storeGetPublicByRequestMethod(e
->mem_obj
->request
, Http::METHOD_HEAD
);
258 pe
= storeGetPublic(e
->mem_obj
->storeId(), Http::METHOD_HEAD
);
263 neighborsHtcpClear(e
, NULL
, e
->mem_obj
->request
, HttpRequestMethod(Http::METHOD_HEAD
), HTCP_CLR_INVALIDATION
);
270 HttpStateData::processSurrogateControl(HttpReply
*reply
)
272 if (request
->flags
.accelerated
&& reply
->surrogate_control
) {
273 HttpHdrScTarget
*sctusable
= reply
->surrogate_control
->getMergedTarget(Config
.Accel
.surrogate_id
);
276 if (sctusable
->noStore() ||
277 (Config
.onoff
.surrogate_is_remote
278 && sctusable
->noStoreRemote())) {
279 surrogateNoStore
= true;
280 entry
->makePrivate();
283 /* The HttpHeader logic cannot tell if the header it's parsing is a reply to an
284 * accelerated request or not...
285 * Still, this is an abstraction breach. - RC
287 if (sctusable
->hasMaxAge()) {
288 if (sctusable
->maxAge() < sctusable
->maxStale())
289 reply
->expires
= reply
->date
+ sctusable
->maxAge();
291 reply
->expires
= reply
->date
+ sctusable
->maxStale();
293 /* And update the timestamps */
294 entry
->timestampsSet();
297 /* We ignore cache-control directives as per the Surrogate specification */
298 ignoreCacheControl
= true;
306 HttpStateData::cacheableReply()
308 HttpReply
const *rep
= finalReply();
309 HttpHeader
const *hdr
= &rep
->header
;
311 #if USE_HTTP_VIOLATIONS
313 const RefreshPattern
*R
= NULL
;
315 /* This strange looking define first looks up the refresh pattern
316 * and then checks if the specified flag is set. The main purpose
317 * of this is to simplify the refresh pattern lookup and USE_HTTP_VIOLATIONS
320 #define REFRESH_OVERRIDE(flag) \
321 ((R = (R ? R : refreshLimits(entry->mem_obj->storeId()))) , \
322 (R && R->flags.flag))
324 #define REFRESH_OVERRIDE(flag) 0
327 if (EBIT_TEST(entry
->flags
, RELEASE_REQUEST
)) {
328 debugs(22, 3, "NO because " << *entry
<< " has been released.");
332 // Check for Surrogate/1.0 protocol conditions
333 // NP: reverse-proxy traffic our parent server has instructed us never to cache
334 if (surrogateNoStore
) {
335 debugs(22, 3, HERE
<< "NO because Surrogate-Control:no-store");
339 // RFC 2616: HTTP/1.1 Cache-Control conditions
340 if (!ignoreCacheControl
) {
341 // XXX: check to see if the request headers alone were enough to prevent caching earlier
342 // (ie no-store request header) no need to check those all again here if so.
343 // for now we are not reliably doing that so we waste CPU re-checking request CC
345 // RFC 2616 section 14.9.2 - MUST NOT cache any response with request CC:no-store
346 if (request
&& request
->cache_control
&& request
->cache_control
->noStore() &&
347 !REFRESH_OVERRIDE(ignore_no_store
)) {
348 debugs(22, 3, HERE
<< "NO because client request Cache-Control:no-store");
352 // NP: request CC:no-cache only means cache READ is forbidden. STORE is permitted.
353 if (rep
->cache_control
&& rep
->cache_control
->hasNoCache() && rep
->cache_control
->noCache().size() > 0) {
354 /* TODO: we are allowed to cache when no-cache= has parameters.
355 * Provided we strip away any of the listed headers unless they are revalidated
356 * successfully (ie, must revalidate AND these headers are prohibited on stale replies).
357 * That is a bit tricky for squid right now so we avoid caching entirely.
359 debugs(22, 3, HERE
<< "NO because server reply Cache-Control:no-cache has parameters");
363 // NP: request CC:private is undefined. We ignore.
364 // NP: other request CC flags are limiters on HIT/MISS. We don't care about here.
366 // RFC 2616 section 14.9.2 - MUST NOT cache any response with CC:no-store
367 if (rep
->cache_control
&& rep
->cache_control
->noStore() &&
368 !REFRESH_OVERRIDE(ignore_no_store
)) {
369 debugs(22, 3, HERE
<< "NO because server reply Cache-Control:no-store");
373 // RFC 2616 section 14.9.1 - MUST NOT cache any response with CC:private in a shared cache like Squid.
374 // CC:private overrides CC:public when both are present in a response.
375 // TODO: add a shared/private cache configuration possibility.
376 if (rep
->cache_control
&&
377 rep
->cache_control
->hasPrivate() &&
378 !REFRESH_OVERRIDE(ignore_private
)) {
379 /* TODO: we are allowed to cache when private= has parameters.
380 * Provided we strip away any of the listed headers unless they are revalidated
381 * successfully (ie, must revalidate AND these headers are prohibited on stale replies).
382 * That is a bit tricky for squid right now so we avoid caching entirely.
384 debugs(22, 3, HERE
<< "NO because server reply Cache-Control:private");
389 // RFC 2068, sec 14.9.4 - MUST NOT cache any response with Authentication UNLESS certain CC controls are present
390 // allow HTTP violations to IGNORE those controls (ie re-block caching Auth)
391 if (request
&& (request
->flags
.auth
|| request
->flags
.authSent
)) {
392 if (!rep
->cache_control
) {
393 debugs(22, 3, HERE
<< "NO because Authenticated and server reply missing Cache-Control");
397 if (ignoreCacheControl
) {
398 debugs(22, 3, HERE
<< "NO because Authenticated and ignoring Cache-Control");
402 bool mayStore
= false;
403 // HTTPbis pt6 section 3.2: a response CC:public is present
404 if (rep
->cache_control
->Public()) {
405 debugs(22, 3, HERE
<< "Authenticated but server reply Cache-Control:public");
408 // HTTPbis pt6 section 3.2: a response CC:must-revalidate is present
409 } else if (rep
->cache_control
->mustRevalidate()) {
410 debugs(22, 3, HERE
<< "Authenticated but server reply Cache-Control:must-revalidate");
413 #if USE_HTTP_VIOLATIONS
414 // NP: given the must-revalidate exception we should also be able to exempt no-cache.
415 // HTTPbis WG verdict on this is that it is omitted from the spec due to being 'unexpected' by
416 // some. The caching+revalidate is not exactly unsafe though with Squids interpretation of no-cache
417 // (without parameters) as equivalent to must-revalidate in the reply.
418 } else if (rep
->cache_control
->hasNoCache() && rep
->cache_control
->noCache().size() == 0) {
419 debugs(22, 3, HERE
<< "Authenticated but server reply Cache-Control:no-cache (equivalent to must-revalidate)");
423 // HTTPbis pt6 section 3.2: a response CC:s-maxage is present
424 } else if (rep
->cache_control
->sMaxAge()) {
425 debugs(22, 3, HERE
<< "Authenticated but server reply Cache-Control:s-maxage");
430 debugs(22, 3, HERE
<< "NO because Authenticated transaction");
434 // NP: response CC:no-cache is equivalent to CC:must-revalidate,max-age=0. We MAY cache, and do so.
435 // NP: other request CC flags are limiters on HIT/MISS/REFRESH. We don't care about here.
438 /* HACK: The "multipart/x-mixed-replace" content type is used for
439 * continuous push replies. These are generally dynamic and
440 * probably should not be cachable
442 if ((v
= hdr
->getStr(Http::HdrType::CONTENT_TYPE
)))
443 if (!strncasecmp(v
, "multipart/x-mixed-replace", 25)) {
444 debugs(22, 3, HERE
<< "NO because Content-Type:multipart/x-mixed-replace");
448 switch (rep
->sline
.status()) {
449 /* Responses that are cacheable */
453 case Http::scNonAuthoritativeInformation
:
455 case Http::scMultipleChoices
:
457 case Http::scMovedPermanently
:
458 case Http::scPermanentRedirect
:
462 * Don't cache objects that need to be refreshed on next request,
463 * unless we know how to refresh it.
466 if (!refreshIsCachable(entry
) && !REFRESH_OVERRIDE(store_stale
)) {
467 debugs(22, 3, "NO because refreshIsCachable() returned non-cacheable..");
470 debugs(22, 3, HERE
<< "YES because HTTP status " << rep
->sline
.status());
476 /* Responses that only are cacheable if the server says so */
479 case Http::scTemporaryRedirect
:
480 if (rep
->date
<= 0) {
481 debugs(22, 3, HERE
<< "NO because HTTP status " << rep
->sline
.status() << " and Date missing/invalid");
484 if (rep
->expires
> rep
->date
) {
485 debugs(22, 3, HERE
<< "YES because HTTP status " << rep
->sline
.status() << " and Expires > Date");
488 debugs(22, 3, HERE
<< "NO because HTTP status " << rep
->sline
.status() << " and Expires <= Date");
494 /* Errors can be negatively cached */
496 case Http::scNoContent
:
498 case Http::scUseProxy
:
500 case Http::scBadRequest
:
502 case Http::scForbidden
:
504 case Http::scNotFound
:
506 case Http::scMethodNotAllowed
:
508 case Http::scUriTooLong
:
510 case Http::scInternalServerError
:
512 case Http::scNotImplemented
:
514 case Http::scBadGateway
:
516 case Http::scServiceUnavailable
:
518 case Http::scGatewayTimeout
:
519 case Http::scMisdirectedRequest
:
521 debugs(22, 3, "MAYBE because HTTP status " << rep
->sline
.status());
527 /* Some responses can never be cached */
529 case Http::scPartialContent
: /* Not yet supported */
531 case Http::scSeeOther
:
533 case Http::scNotModified
:
535 case Http::scUnauthorized
:
537 case Http::scProxyAuthenticationRequired
:
539 case Http::scInvalidHeader
: /* Squid header parsing error */
541 case Http::scHeaderTooLarge
:
543 case Http::scPaymentRequired
:
544 case Http::scNotAcceptable
:
545 case Http::scRequestTimeout
:
546 case Http::scConflict
:
547 case Http::scLengthRequired
:
548 case Http::scPreconditionFailed
:
549 case Http::scPayloadTooLarge
:
550 case Http::scUnsupportedMediaType
:
551 case Http::scUnprocessableEntity
:
553 case Http::scFailedDependency
:
554 case Http::scInsufficientStorage
:
555 case Http::scRequestedRangeNotSatisfied
:
556 case Http::scExpectationFailed
:
558 debugs(22, 3, HERE
<< "NO because HTTP status " << rep
->sline
.status());
562 /* RFC 2616 section 6.1.1: an unrecognized response MUST NOT be cached. */
563 debugs (11, 3, HERE
<< "NO because unknown HTTP status code " << rep
->sline
.status());
574 * For Vary, store the relevant request headers as
575 * virtual headers in the reply
576 * Returns false if the variance cannot be stored
579 httpMakeVaryMark(HttpRequest
* request
, HttpReply
const * reply
)
582 const char *pos
= NULL
;
589 vary
= reply
->header
.getList(Http::HdrType::VARY
);
591 while (strListGetItem(&vary
, ',', &item
, &ilen
, &pos
)) {
592 static const SBuf
asterisk("*");
593 SBuf
name(item
, ilen
);
594 if (name
== asterisk
) {
599 strListAdd(&vstr
, name
.c_str(), ',');
600 hdr
= request
->header
.getByName(name
);
601 value
= hdr
.termedBuf();
603 value
= rfc1738_escape_part(value
);
604 vstr
.append("=\"", 2);
606 vstr
.append("\"", 1);
613 #if X_ACCELERATOR_VARY
616 vary
= reply
->header
.getList(Http::HdrType::HDR_X_ACCELERATOR_VARY
);
618 while (strListGetItem(&vary
, ',', &item
, &ilen
, &pos
)) {
619 char *name
= (char *)xmalloc(ilen
+ 1);
620 xstrncpy(name
, item
, ilen
+ 1);
622 strListAdd(&vstr
, name
, ',');
623 hdr
= request
->header
.getByName(name
);
625 value
= hdr
.termedBuf();
628 value
= rfc1738_escape_part(value
);
629 vstr
.append("=\"", 2);
631 vstr
.append("\"", 1);
640 debugs(11, 3, "httpMakeVaryMark: " << vstr
);
641 return vstr
.termedBuf();
645 HttpStateData::keepaliveAccounting(HttpReply
*reply
)
649 ++ _peer
->stats
.n_keepalives_sent
;
651 if (reply
->keep_alive
) {
653 ++ _peer
->stats
.n_keepalives_recv
;
655 if (Config
.onoff
.detect_broken_server_pconns
656 && reply
->bodySize(request
->method
) == -1 && !flags
.chunked
) {
657 debugs(11, DBG_IMPORTANT
, "keepaliveAccounting: Impossible keep-alive header from '" << entry
->url() << "'" );
658 // debugs(11, 2, "GOT HTTP REPLY HDR:\n---------\n" << readBuf->content() << "\n----------" );
659 flags
.keepalive_broken
= true;
665 HttpStateData::checkDateSkew(HttpReply
*reply
)
667 if (reply
->date
> -1 && !_peer
) {
668 int skew
= abs((int)(reply
->date
- squid_curtime
));
671 debugs(11, 3, "" << request
->url
.host() << "'s clock is skewed by " << skew
<< " seconds!");
676 * This creates the error page itself.. its likely
677 * that the forward ported reply header max size patch
678 * generates non http conformant error pages - in which
679 * case the errors where should be 'BAD_GATEWAY' etc
682 HttpStateData::processReplyHeader()
684 /** Creates a blank header. If this routine is made incremental, this will not do */
686 /* NP: all exit points to this function MUST call ctx_exit(ctx) */
687 Ctx ctx
= ctx_enter(entry
->mem_obj
->urlXXX());
689 debugs(11, 3, "processReplyHeader: key '" << entry
->getMD5Text() << "'");
691 assert(!flags
.headers_parsed
);
693 if (!inBuf
.length()) {
698 /* Attempt to parse the first line; this will define where the protocol, status, reason-phrase and header begin */
701 hp
= new Http1::ResponseParser
;
703 bool parsedOk
= hp
->parse(inBuf
);
705 // sync the buffers after parsing.
706 inBuf
= hp
->remaining();
708 if (hp
->needsMoreData()) {
709 if (eof
) { // no more data coming
710 /* Bug 2879: Replies may terminate with \r\n then EOF instead of \r\n\r\n.
711 * We also may receive truncated responses.
712 * Ensure here that we have at minimum two \r\n when EOF is seen.
714 inBuf
.append("\r\n\r\n", 4);
716 parsedOk
= hp
->parse(inBuf
);
717 // sync the buffers after parsing.
718 inBuf
= hp
->remaining();
720 debugs(33, 5, "Incomplete response, waiting for end of response headers");
727 // unrecoverable parsing error
728 debugs(11, 3, "Non-HTTP-compliant header:\n---------\n" << inBuf
<< "\n----------");
729 flags
.headers_parsed
= true;
730 HttpReply
*newrep
= new HttpReply
;
731 newrep
->sline
.set(Http::ProtocolVersion(), hp
->messageStatus());
732 HttpReply
*vrep
= setVirginReply(newrep
);
733 entry
->replaceHttpReply(vrep
);
734 // XXX: close the server connection ?
740 /* We know the whole response is in parser now */
741 debugs(11, 2, "HTTP Server " << serverConnection
);
742 debugs(11, 2, "HTTP Server RESPONSE:\n---------\n" <<
743 hp
->messageProtocol() << " " << hp
->messageStatus() << " " << hp
->reasonPhrase() << "\n" <<
747 // reset payload tracking to begin after message headers
748 payloadSeen
= inBuf
.length();
750 HttpReply
*newrep
= new HttpReply
;
751 // XXX: RFC 7230 indicates we MAY ignore the reason phrase,
752 // and use an empty string on unknown status.
753 // We do that now to avoid performance regression from using SBuf::c_str()
754 newrep
->sline
.set(Http::ProtocolVersion(1,1), hp
->messageStatus() /* , hp->reasonPhrase() */);
755 newrep
->sline
.protocol
= newrep
->sline
.version
.protocol
= hp
->messageProtocol().protocol
;
756 newrep
->sline
.version
.major
= hp
->messageProtocol().major
;
757 newrep
->sline
.version
.minor
= hp
->messageProtocol().minor
;
760 if (!newrep
->parseHeader(*hp
)) {
761 // XXX: when Http::ProtocolVersion is a function, remove this hack. just set with messageProtocol()
762 newrep
->sline
.set(Http::ProtocolVersion(), Http::scInvalidHeader
);
763 newrep
->sline
.version
.protocol
= hp
->messageProtocol().protocol
;
764 newrep
->sline
.version
.major
= hp
->messageProtocol().major
;
765 newrep
->sline
.version
.minor
= hp
->messageProtocol().minor
;
766 debugs(11, 2, "error parsing response headers mime block");
769 // done with Parser, now process using the HttpReply
772 newrep
->removeStaleWarnings();
774 if (newrep
->sline
.protocol
== AnyP::PROTO_HTTP
&& newrep
->sline
.status() >= 100 && newrep
->sline
.status() < 200) {
780 flags
.chunked
= false;
781 if (newrep
->sline
.protocol
== AnyP::PROTO_HTTP
&& newrep
->header
.chunked()) {
782 flags
.chunked
= true;
783 httpChunkDecoder
= new Http1::TeChunkedParser
;
786 if (!peerSupportsConnectionPinning())
787 request
->flags
.connectionAuthDisabled
= true;
789 HttpReply
*vrep
= setVirginReply(newrep
);
790 flags
.headers_parsed
= true;
792 keepaliveAccounting(vrep
);
796 processSurrogateControl (vrep
);
798 request
->hier
.peer_reply_status
= newrep
->sline
.status();
803 /// ignore or start forwarding the 1xx response (a.k.a., control message)
805 HttpStateData::handle1xx(HttpReply
*reply
)
807 HttpReply::Pointer
msg(reply
); // will destroy reply if unused
809 // one 1xx at a time: we must not be called while waiting for previous 1xx
810 Must(!flags
.handling1xx
);
811 flags
.handling1xx
= true;
813 if (!request
->canHandle1xx() || request
->forcedBodyContinuation
) {
814 debugs(11, 2, "ignoring 1xx because it is " << (request
->forcedBodyContinuation
? "already sent" : "not supported by client"));
819 #if USE_HTTP_VIOLATIONS
820 // check whether the 1xx response forwarding is allowed by squid.conf
821 if (Config
.accessList
.reply
) {
822 ACLFilledChecklist
ch(Config
.accessList
.reply
, originalRequest(), NULL
);
824 HTTPMSGLOCK(ch
.reply
);
825 if (ch
.fastCheck() != ACCESS_ALLOWED
) { // TODO: support slow lookups?
826 debugs(11, 3, HERE
<< "ignoring denied 1xx");
831 #endif // USE_HTTP_VIOLATIONS
833 debugs(11, 2, HERE
<< "forwarding 1xx to client");
835 // the Sink will use this to call us back after writing 1xx to the client
836 typedef NullaryMemFunT
<HttpStateData
> CbDialer
;
837 const AsyncCall::Pointer cb
= JobCallback(11, 3, CbDialer
, this,
838 HttpStateData::proceedAfter1xx
);
839 CallJobHere1(11, 4, request
->clientConnectionManager
, ConnStateData
,
840 ConnStateData::sendControlMsg
, HttpControlMsg(msg
, cb
));
841 // If the call is not fired, then the Sink is gone, and HttpStateData
842 // will terminate due to an aborted store entry or another similar error.
843 // If we get stuck, it is not handle1xx fault if we could get stuck
844 // for similar reasons without a 1xx response.
847 /// restores state and resumes processing after 1xx is ignored or forwarded
849 HttpStateData::proceedAfter1xx()
851 Must(flags
.handling1xx
);
852 debugs(11, 2, "continuing with " << payloadSeen
<< " bytes in buffer after 1xx");
853 CallJobHere(11, 3, this, HttpStateData
, HttpStateData::processReply
);
857 * returns true if the peer can support connection pinning
859 bool HttpStateData::peerSupportsConnectionPinning() const
861 const HttpReply
*rep
= entry
->mem_obj
->getReply();
862 const HttpHeader
*hdr
= &rep
->header
;
869 /*If this peer does not support connection pinning (authenticated
870 connections) return false
872 if (!_peer
->connection_auth
)
875 /*The peer supports connection pinning and the http reply status
876 is not unauthorized, so the related connection can be pinned
878 if (rep
->sline
.status() != Http::scUnauthorized
)
881 /*The server respond with Http::scUnauthorized and the peer configured
882 with "connection-auth=on" we know that the peer supports pinned
885 if (_peer
->connection_auth
== 1)
888 /*At this point peer has configured with "connection-auth=auto"
889 parameter so we need some extra checks to decide if we are going
890 to allow pinned connections or not
893 /*if the peer configured with originserver just allow connection
894 pinning (squid 2.6 behaviour)
896 if (_peer
->options
.originserver
)
899 /*if the connections it is already pinned it is OK*/
900 if (request
->flags
.pinned
)
903 /*Allow pinned connections only if the Proxy-support header exists in
904 reply and has in its list the "Session-Based-Authentication"
905 which means that the peer supports connection pinning.
907 if (!hdr
->has(Http::HdrType::PROXY_SUPPORT
))
910 header
= hdr
->getStrOrList(Http::HdrType::PROXY_SUPPORT
);
911 /* XXX This ought to be done in a case-insensitive manner */
912 rc
= (strstr(header
.termedBuf(), "Session-Based-Authentication") != NULL
);
917 // Called when we parsed (and possibly adapted) the headers but
918 // had not starting storing (a.k.a., sending) the body yet.
920 HttpStateData::haveParsedReplyHeaders()
922 Client::haveParsedReplyHeaders();
924 Ctx ctx
= ctx_enter(entry
->mem_obj
->urlXXX());
925 HttpReply
*rep
= finalReply();
927 entry
->timestampsSet();
929 /* Check if object is cacheable or not based on reply code */
930 debugs(11, 3, "HTTP CODE: " << rep
->sline
.status());
932 if (neighbors_do_private_keys
)
933 httpMaybeRemovePublic(entry
, rep
->sline
.status());
935 bool varyFailure
= false;
936 if (rep
->header
.has(Http::HdrType::VARY
)
937 #if X_ACCELERATOR_VARY
938 || rep
->header
.has(Http::HdrType::HDR_X_ACCELERATOR_VARY
)
941 const char *vary
= httpMakeVaryMark(request
, rep
);
944 entry
->makePrivate();
945 if (!fwd
->reforwardableStatus(rep
->sline
.status()))
946 EBIT_CLR(entry
->flags
, ENTRY_FWD_HDR_WAIT
);
949 entry
->mem_obj
->vary_headers
= xstrdup(vary
);
955 * If its not a reply that we will re-forward, then
956 * allow the client to get it.
958 if (!fwd
->reforwardableStatus(rep
->sline
.status()))
959 EBIT_CLR(entry
->flags
, ENTRY_FWD_HDR_WAIT
);
961 switch (cacheableReply()) {
968 entry
->makePrivate();
973 #if USE_HTTP_VIOLATIONS
974 if (Config
.negativeTtl
> 0)
975 entry
->cacheNegatively();
978 entry
->makePrivate();
987 if (!ignoreCacheControl
) {
988 if (rep
->cache_control
) {
989 // We are required to revalidate on many conditions.
990 // For security reasons we do so even if storage was caused by refresh_pattern ignore-* option
992 // CC:must-revalidate or CC:proxy-revalidate
993 const bool ccMustRevalidate
= (rep
->cache_control
->proxyRevalidate() || rep
->cache_control
->mustRevalidate());
995 // CC:no-cache (only if there are no parameters)
996 const bool ccNoCacheNoParams
= (rep
->cache_control
->hasNoCache() && rep
->cache_control
->noCache().size()==0);
999 const bool ccSMaxAge
= rep
->cache_control
->hasSMaxAge();
1001 // CC:private (yes, these can sometimes be stored)
1002 const bool ccPrivate
= rep
->cache_control
->hasPrivate();
1004 if (ccMustRevalidate
|| ccNoCacheNoParams
|| ccSMaxAge
|| ccPrivate
)
1005 EBIT_SET(entry
->flags
, ENTRY_REVALIDATE
);
1007 #if USE_HTTP_VIOLATIONS // response header Pragma::no-cache is undefined in HTTP
1009 // Expensive calculation. So only do it IF the CC: header is not present.
1011 /* HACK: Pragma: no-cache in _replies_ is not documented in HTTP,
1012 * but servers like "Active Imaging Webcast/2.0" sure do use it */
1013 if (rep
->header
.has(Http::HdrType::PRAGMA
) &&
1014 rep
->header
.hasListMember(Http::HdrType::PRAGMA
,"no-cache",','))
1015 EBIT_SET(entry
->flags
, ENTRY_REVALIDATE
);
1021 headersLog(1, 0, request
->method
, rep
);
1028 HttpStateData::ConnectionStatus
1029 HttpStateData::statusIfComplete() const
1031 const HttpReply
*rep
= virginReply();
1033 * If the reply wants to close the connection, it takes precedence */
1035 if (httpHeaderHasConnDir(&rep
->header
, "close"))
1036 return COMPLETE_NONPERSISTENT_MSG
;
1039 * If we didn't send a keep-alive request header, then this
1040 * can not be a persistent connection.
1042 if (!flags
.keepalive
)
1043 return COMPLETE_NONPERSISTENT_MSG
;
1046 * If we haven't sent the whole request then this can not be a persistent
1049 if (!flags
.request_sent
) {
1050 debugs(11, 2, "Request not yet fully sent " << request
->method
<< ' ' << entry
->url());
1051 return COMPLETE_NONPERSISTENT_MSG
;
1055 * What does the reply have to say about keep-alive?
1059 * If the origin server (HTTP/1.0) does not send a keep-alive
1060 * header, but keeps the connection open anyway, what happens?
1061 * We'll return here and http.c waits for an EOF before changing
1062 * store_status to STORE_OK. Combine this with ENTRY_FWD_HDR_WAIT
1063 * and an error status code, and we might have to wait until
1064 * the server times out the socket.
1066 if (!rep
->keep_alive
)
1067 return COMPLETE_NONPERSISTENT_MSG
;
1069 return COMPLETE_PERSISTENT_MSG
;
1072 HttpStateData::ConnectionStatus
1073 HttpStateData::persistentConnStatus() const
1075 debugs(11, 3, HERE
<< serverConnection
<< " eof=" << eof
);
1076 if (eof
) // already reached EOF
1077 return COMPLETE_NONPERSISTENT_MSG
;
1079 /* If server fd is closing (but we have not been notified yet), stop Comm
1080 I/O to avoid assertions. TODO: Change Comm API to handle callers that
1081 want more I/O after async closing (usually initiated by others). */
1082 // XXX: add canReceive or s/canSend/canTalkToServer/
1083 if (!Comm::IsConnOpen(serverConnection
))
1084 return COMPLETE_NONPERSISTENT_MSG
;
1087 * In chunked response we do not know the content length but we are absolutely
1088 * sure about the end of response, so we are calling the statusIfComplete to
1089 * decide if we can be persistant
1091 if (lastChunk
&& flags
.chunked
)
1092 return statusIfComplete();
1094 const HttpReply
*vrep
= virginReply();
1095 debugs(11, 5, "persistentConnStatus: content_length=" << vrep
->content_length
);
1097 const int64_t clen
= vrep
->bodySize(request
->method
);
1099 debugs(11, 5, "persistentConnStatus: clen=" << clen
);
1101 /* If the body size is unknown we must wait for EOF */
1103 return INCOMPLETE_MSG
;
1106 * If the body size is known, we must wait until we've gotten all of it. */
1108 debugs(11,5, "payloadSeen=" << payloadSeen
<< " content_length=" << vrep
->content_length
);
1110 if (payloadSeen
< vrep
->content_length
)
1111 return INCOMPLETE_MSG
;
1113 if (payloadTruncated
> 0) // already read more than needed
1114 return COMPLETE_NONPERSISTENT_MSG
; // disable pconns
1118 * If there is no message body or we got it all, we can be persistent */
1119 return statusIfComplete();
1124 readDelayed(void *context
, CommRead
const &)
1126 HttpStateData
*state
= static_cast<HttpStateData
*>(context
);
1127 state
->flags
.do_next_read
= true;
1128 state
->maybeReadVirginBody();
1133 HttpStateData::readReply(const CommIoCbParams
&io
)
1135 Must(!flags
.do_next_read
); // XXX: should have been set false by mayReadVirginBody()
1136 flags
.do_next_read
= false;
1138 debugs(11, 5, io
.conn
);
1140 // Bail out early on Comm::ERR_CLOSING - close handlers will tidy up for us
1141 if (io
.flag
== Comm::ERR_CLOSING
) {
1142 debugs(11, 3, "http socket closing");
1146 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
)) {
1147 abortTransaction("store entry aborted while reading reply");
1151 Must(Comm::IsConnOpen(serverConnection
));
1152 Must(io
.conn
->fd
== serverConnection
->fd
);
1155 * Don't reset the timeout value here. The value should be
1156 * counting Config.Timeout.request and applies to the request
1157 * as a whole, not individual read() calls.
1158 * Plus, it breaks our lame *HalfClosed() detection
1161 Must(maybeMakeSpaceAvailable(true));
1162 CommIoCbParams
rd(this); // will be expanded with ReadNow results
1164 rd
.size
= entry
->bytesWanted(Range
<size_t>(0, inBuf
.spaceSize()));
1167 assert(entry
->mem_obj
);
1169 /* read ahead limit */
1170 /* Perhaps these two calls should both live in MemObject */
1171 AsyncCall::Pointer nilCall
;
1172 if (!entry
->mem_obj
->readAheadPolicyCanRead()) {
1173 entry
->mem_obj
->delayRead(DeferredRead(readDelayed
, this, CommRead(io
.conn
, NULL
, 0, nilCall
)));
1177 /* delay id limit */
1178 entry
->mem_obj
->mostBytesAllowed().delayRead(DeferredRead(readDelayed
, this, CommRead(io
.conn
, NULL
, 0, nilCall
)));
1183 switch (Comm::ReadNow(rd
, inBuf
)) {
1184 case Comm::INPROGRESS
:
1185 if (inBuf
.isEmpty())
1186 debugs(33, 2, io
.conn
<< ": no data to process, " << xstrerr(rd
.xerrno
));
1187 flags
.do_next_read
= true;
1188 maybeReadVirginBody();
1193 payloadSeen
+= rd
.size
;
1195 DelayId delayId
= entry
->mem_obj
->mostBytesAllowed();
1196 delayId
.bytesIn(rd
.size
);
1199 statCounter
.server
.all
.kbytes_in
+= rd
.size
;
1200 statCounter
.server
.http
.kbytes_in
+= rd
.size
;
1201 ++ IOStats
.Http
.reads
;
1204 for (int clen
= rd
.size
- 1; clen
; ++bin
)
1207 ++ IOStats
.Http
.read_hist
[bin
];
1209 // update peer response time stats (%<pt)
1210 const timeval
&sent
= request
->hier
.peer_http_request_sent
;
1212 tvSub(request
->hier
.peer_response_time
, sent
, current_time
);
1214 request
->hier
.peer_response_time
.tv_sec
= -1;
1217 /* Continue to process previously read data */
1220 case Comm::ENDFILE
: // close detected by 0-byte read
1222 flags
.do_next_read
= false;
1224 /* Continue to process previously read data */
1227 // case Comm::COMM_ERROR:
1228 default: // no other flags should ever occur
1229 debugs(11, 2, io
.conn
<< ": read failure: " << xstrerr(rd
.xerrno
));
1230 ErrorState
*err
= new ErrorState(ERR_READ_ERROR
, Http::scBadGateway
, fwd
->request
);
1231 err
->xerrno
= rd
.xerrno
;
1233 flags
.do_next_read
= false;
1239 /* Process next response from buffer */
1243 /// processes the already read and buffered response data, possibly after
1244 /// waiting for asynchronous 1xx control message processing
1246 HttpStateData::processReply()
1249 if (flags
.handling1xx
) { // we came back after handling a 1xx response
1250 debugs(11, 5, HERE
<< "done with 1xx handling");
1251 flags
.handling1xx
= false;
1252 Must(!flags
.headers_parsed
);
1255 if (!flags
.headers_parsed
) { // have not parsed headers yet?
1256 PROF_start(HttpStateData_processReplyHeader
);
1257 processReplyHeader();
1258 PROF_stop(HttpStateData_processReplyHeader
);
1260 if (!continueAfterParsingHeader()) // parsing error or need more data
1261 return; // TODO: send errors to ICAP
1263 adaptOrFinalizeReply(); // may write to, abort, or "close" the entry
1266 // kick more reads if needed and/or process the response body, if any
1267 PROF_start(HttpStateData_processReplyBody
);
1268 processReplyBody(); // may call serverComplete()
1269 PROF_stop(HttpStateData_processReplyBody
);
1273 \retval true if we can continue with processing the body or doing ICAP.
1276 HttpStateData::continueAfterParsingHeader()
1278 if (flags
.handling1xx
) {
1279 debugs(11, 5, HERE
<< "wait for 1xx handling");
1280 Must(!flags
.headers_parsed
);
1284 if (!flags
.headers_parsed
&& !eof
) {
1285 debugs(11, 9, "needs more at " << inBuf
.length());
1286 flags
.do_next_read
= true;
1287 /** \retval false If we have not finished parsing the headers and may get more data.
1288 * Schedules more reads to retrieve the missing data.
1290 maybeReadVirginBody(); // schedules all kinds of reads; TODO: rename
1294 /** If we are done with parsing, check for errors */
1296 err_type error
= ERR_NONE
;
1298 if (flags
.headers_parsed
) { // parsed headers, possibly with errors
1299 // check for header parsing errors
1300 if (HttpReply
*vrep
= virginReply()) {
1301 const Http::StatusCode s
= vrep
->sline
.status();
1302 const AnyP::ProtocolVersion
&v
= vrep
->sline
.version
;
1303 if (s
== Http::scInvalidHeader
&& v
!= Http::ProtocolVersion(0,9)) {
1304 debugs(11, DBG_IMPORTANT
, "WARNING: HTTP: Invalid Response: Bad header encountered from " << entry
->url() << " AKA " << request
->url
);
1305 error
= ERR_INVALID_RESP
;
1306 } else if (s
== Http::scHeaderTooLarge
) {
1307 fwd
->dontRetry(true);
1308 error
= ERR_TOO_BIG
;
1309 } else if (vrep
->header
.conflictingContentLength()) {
1310 fwd
->dontRetry(true);
1311 error
= ERR_INVALID_RESP
;
1313 return true; // done parsing, got reply, and no error
1316 // parsed headers but got no reply
1317 debugs(11, DBG_IMPORTANT
, "WARNING: HTTP: Invalid Response: No reply at all for " << entry
->url() << " AKA " << request
->url
);
1318 error
= ERR_INVALID_RESP
;
1322 if (inBuf
.length()) {
1323 error
= ERR_INVALID_RESP
;
1324 debugs(11, DBG_IMPORTANT
, "WARNING: HTTP: Invalid Response: Headers did not parse at all for " << entry
->url() << " AKA " << request
->url
);
1326 error
= ERR_ZERO_SIZE_OBJECT
;
1327 debugs(11, (request
->flags
.accelerated
?DBG_IMPORTANT
:2), "WARNING: HTTP: Invalid Response: No object data received for " << entry
->url() << " AKA " << request
->url
);
1331 assert(error
!= ERR_NONE
);
1333 fwd
->fail(new ErrorState(error
, Http::scBadGateway
, fwd
->request
));
1334 flags
.do_next_read
= false;
1335 serverConnection
->close();
1336 return false; // quit on error
1339 /** truncate what we read if we read too much so that writeReplyBody()
1340 writes no more than what we should have read */
1342 HttpStateData::truncateVirginBody()
1344 assert(flags
.headers_parsed
);
1346 HttpReply
*vrep
= virginReply();
1348 if (!vrep
->expectingBody(request
->method
, clen
) || clen
< 0)
1349 return; // no body or a body of unknown size, including chunked
1351 if (payloadSeen
- payloadTruncated
<= clen
)
1352 return; // we did not read too much or already took care of the extras
1354 if (const int64_t extras
= payloadSeen
- payloadTruncated
- clen
) {
1355 // server sent more that the advertised content length
1356 debugs(11, 5, "payloadSeen=" << payloadSeen
<<
1357 " clen=" << clen
<< '/' << vrep
->content_length
<<
1358 " trucated=" << payloadTruncated
<< '+' << extras
);
1360 inBuf
.chop(0, inBuf
.length() - extras
);
1361 payloadTruncated
+= extras
;
1366 * Call this when there is data from the origin server
1367 * which should be sent to either StoreEntry, or to ICAP...
1370 HttpStateData::writeReplyBody()
1372 truncateVirginBody(); // if needed
1373 const char *data
= inBuf
.rawContent();
1374 int len
= inBuf
.length();
1375 addVirginReplyBody(data
, len
);
1380 HttpStateData::decodeAndWriteReplyBody()
1382 const char *data
= NULL
;
1384 bool wasThereAnException
= false;
1385 assert(flags
.chunked
);
1386 assert(httpChunkDecoder
);
1387 SQUID_ENTER_THROWING_CODE();
1390 httpChunkDecoder
->setPayloadBuffer(&decodedData
);
1391 const bool doneParsing
= httpChunkDecoder
->parse(inBuf
);
1392 inBuf
= httpChunkDecoder
->remaining(); // sync buffers after parse
1393 len
= decodedData
.contentSize();
1394 data
=decodedData
.content();
1395 addVirginReplyBody(data
, len
);
1398 flags
.do_next_read
= false;
1400 SQUID_EXIT_THROWING_CODE(wasThereAnException
);
1401 return wasThereAnException
;
1405 * processReplyBody has two purposes:
1406 * 1 - take the reply body data, if any, and put it into either
1407 * the StoreEntry, or give it over to ICAP.
1408 * 2 - see if we made it to the end of the response (persistent
1409 * connections and such)
1412 HttpStateData::processReplyBody()
1414 Ip::Address client_addr
;
1415 bool ispinned
= false;
1417 if (!flags
.headers_parsed
) {
1418 flags
.do_next_read
= true;
1419 maybeReadVirginBody();
1424 debugs(11,5, HERE
<< "adaptationAccessCheckPending=" << adaptationAccessCheckPending
);
1425 if (adaptationAccessCheckPending
)
1431 * At this point the reply headers have been parsed and consumed.
1432 * That means header content has been removed from readBuf and
1433 * it contains only body data.
1435 if (entry
->isAccepting()) {
1436 if (flags
.chunked
) {
1437 if (!decodeAndWriteReplyBody()) {
1438 flags
.do_next_read
= false;
1446 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
)) {
1447 // The above writeReplyBody() call may have aborted the store entry.
1448 abortTransaction("store entry aborted while storing reply");
1451 switch (persistentConnStatus()) {
1452 case INCOMPLETE_MSG
: {
1453 debugs(11, 5, "processReplyBody: INCOMPLETE_MSG from " << serverConnection
);
1454 /* Wait for more data or EOF condition */
1455 AsyncCall::Pointer nil
;
1456 if (flags
.keepalive_broken
) {
1457 commSetConnTimeout(serverConnection
, 10, nil
);
1459 commSetConnTimeout(serverConnection
, Config
.Timeout
.read
, nil
);
1462 flags
.do_next_read
= true;
1466 case COMPLETE_PERSISTENT_MSG
:
1467 debugs(11, 5, "processReplyBody: COMPLETE_PERSISTENT_MSG from " << serverConnection
);
1468 /* yes we have to clear all these! */
1469 commUnsetConnTimeout(serverConnection
);
1470 flags
.do_next_read
= false;
1472 comm_remove_close_handler(serverConnection
->fd
, closeHandler
);
1473 closeHandler
= NULL
;
1474 fwd
->unregister(serverConnection
);
1476 if (request
->flags
.spoofClientIp
)
1477 client_addr
= request
->client_addr
;
1479 if (request
->flags
.pinned
) {
1481 } else if (request
->flags
.connectionAuth
&& request
->flags
.authSent
) {
1485 if (ispinned
&& request
->clientConnectionManager
.valid()) {
1486 request
->clientConnectionManager
->pinConnection(serverConnection
, request
, _peer
,
1487 (request
->flags
.connectionAuth
));
1489 fwd
->pconnPush(serverConnection
, request
->url
.host());
1492 serverConnection
= NULL
;
1496 case COMPLETE_NONPERSISTENT_MSG
:
1497 debugs(11, 5, "processReplyBody: COMPLETE_NONPERSISTENT_MSG from " << serverConnection
);
1502 maybeReadVirginBody();
1506 HttpStateData::mayReadVirginReplyBody() const
1508 // TODO: Be more precise here. For example, if/when reading trailer, we may
1509 // not be doneWithServer() yet, but we should return false. Similarly, we
1510 // could still be writing the request body after receiving the whole reply.
1511 return !doneWithServer();
1515 HttpStateData::maybeReadVirginBody()
1518 if (!Comm::IsConnOpen(serverConnection
) || fd_table
[serverConnection
->fd
].closing())
1521 if (!maybeMakeSpaceAvailable(false))
1524 // XXX: get rid of the do_next_read flag
1525 // check for the proper reasons preventing read(2)
1526 if (!flags
.do_next_read
)
1529 flags
.do_next_read
= false;
1531 // must not already be waiting for read(2) ...
1532 assert(!Comm::MonitorsRead(serverConnection
->fd
));
1534 // wait for read(2) to be possible.
1535 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
1536 AsyncCall::Pointer call
= JobCallback(11, 5, Dialer
, this, HttpStateData::readReply
);
1537 Comm::Read(serverConnection
, call
);
1541 HttpStateData::maybeMakeSpaceAvailable(bool doGrow
)
1543 // how much we are allowed to buffer
1544 const int limitBuffer
= (flags
.headers_parsed
? Config
.readAheadGap
: Config
.maxReplyHeaderSize
);
1546 if (limitBuffer
< 0 || inBuf
.length() >= (SBuf::size_type
)limitBuffer
) {
1547 // when buffer is at or over limit already
1548 debugs(11, 7, "wont read up to " << limitBuffer
<< ". buffer has (" << inBuf
.length() << "/" << inBuf
.spaceSize() << ") from " << serverConnection
);
1549 debugs(11, DBG_DATA
, "buffer has {" << inBuf
<< "}");
1550 // Process next response from buffer
1555 // how much we want to read
1556 const size_t read_size
= calcBufferSpaceToReserve(inBuf
.spaceSize(), (limitBuffer
- inBuf
.length()));
1559 debugs(11, 7, "wont read up to " << read_size
<< " into buffer (" << inBuf
.length() << "/" << inBuf
.spaceSize() << ") from " << serverConnection
);
1563 // just report whether we could grow or not, dont actually do it
1565 return (read_size
>= 2);
1567 // we may need to grow the buffer
1568 inBuf
.reserveSpace(read_size
);
1569 debugs(11, 8, (!flags
.do_next_read
? "wont" : "may") <<
1570 " read up to " << read_size
<< " bytes info buf(" << inBuf
.length() << "/" << inBuf
.spaceSize() <<
1571 ") from " << serverConnection
);
1573 return (inBuf
.spaceSize() >= 2); // only read if there is 1+ bytes of space available
1576 /// called after writing the very last request byte (body, last-chunk, etc)
1578 HttpStateData::wroteLast(const CommIoCbParams
&io
)
1580 debugs(11, 5, HERE
<< serverConnection
<< ": size " << io
.size
<< ": errflag " << io
.flag
<< ".");
1581 #if URL_CHECKSUM_DEBUG
1583 entry
->mem_obj
->checkUrlChecksum();
1587 fd_bytes(io
.fd
, io
.size
, FD_WRITE
);
1588 statCounter
.server
.all
.kbytes_out
+= io
.size
;
1589 statCounter
.server
.http
.kbytes_out
+= io
.size
;
1592 if (io
.flag
== Comm::ERR_CLOSING
)
1596 ErrorState
*err
= new ErrorState(ERR_WRITE_ERROR
, Http::scBadGateway
, fwd
->request
);
1597 err
->xerrno
= io
.xerrno
;
1599 serverConnection
->close();
1606 /// successfully wrote the entire request (including body, last-chunk, etc.)
1608 HttpStateData::sendComplete()
1611 * Set the read timeout here because it hasn't been set yet.
1612 * We only set the read timeout after the request has been
1613 * fully written to the peer. If we start the timeout
1614 * after connection establishment, then we are likely to hit
1615 * the timeout for POST/PUT requests that have very large
1618 typedef CommCbMemFunT
<HttpStateData
, CommTimeoutCbParams
> TimeoutDialer
;
1619 AsyncCall::Pointer timeoutCall
= JobCallback(11, 5,
1620 TimeoutDialer
, this, HttpStateData::httpTimeout
);
1622 commSetConnTimeout(serverConnection
, Config
.Timeout
.read
, timeoutCall
);
1623 flags
.request_sent
= true;
1624 request
->hier
.peer_http_request_sent
= current_time
;
1627 // Close the HTTP server connection. Used by serverComplete().
1629 HttpStateData::closeServer()
1631 debugs(11,5, HERE
<< "closing HTTP server " << serverConnection
<< " this " << this);
1633 if (Comm::IsConnOpen(serverConnection
)) {
1634 fwd
->unregister(serverConnection
);
1635 comm_remove_close_handler(serverConnection
->fd
, closeHandler
);
1636 closeHandler
= NULL
;
1637 serverConnection
->close();
1642 HttpStateData::doneWithServer() const
1644 return !Comm::IsConnOpen(serverConnection
);
1648 * Fixup authentication request headers for special cases
1651 httpFixupAuthentication(HttpRequest
* request
, const HttpHeader
* hdr_in
, HttpHeader
* hdr_out
, const HttpStateFlags
&flags
)
1653 Http::HdrType header
= flags
.originpeer
? Http::HdrType::AUTHORIZATION
: Http::HdrType::PROXY_AUTHORIZATION
;
1655 /* Nothing to do unless we are forwarding to a peer */
1656 if (!request
->flags
.proxying
)
1659 /* Needs to be explicitly enabled */
1660 if (!request
->peer_login
)
1663 /* Maybe already dealt with? */
1664 if (hdr_out
->has(header
))
1667 /* Nothing to do here for PASSTHRU */
1668 if (strcmp(request
->peer_login
, "PASSTHRU") == 0)
1671 /* PROXYPASS is a special case, single-signon to servers with the proxy password (basic only) */
1672 if (flags
.originpeer
&& strcmp(request
->peer_login
, "PROXYPASS") == 0 && hdr_in
->has(Http::HdrType::PROXY_AUTHORIZATION
)) {
1673 const char *auth
= hdr_in
->getStr(Http::HdrType::PROXY_AUTHORIZATION
);
1675 if (auth
&& strncasecmp(auth
, "basic ", 6) == 0) {
1676 hdr_out
->putStr(header
, auth
);
1681 uint8_t loginbuf
[base64_encode_len(MAX_LOGIN_SZ
)];
1683 struct base64_encode_ctx ctx
;
1684 base64_encode_init(&ctx
);
1686 /* Special mode to pass the username to the upstream cache */
1687 if (*request
->peer_login
== '*') {
1688 const char *username
= "-";
1690 if (request
->extacl_user
.size())
1691 username
= request
->extacl_user
.termedBuf();
1693 else if (request
->auth_user_request
!= NULL
)
1694 username
= request
->auth_user_request
->username();
1697 blen
= base64_encode_update(&ctx
, loginbuf
, strlen(username
), reinterpret_cast<const uint8_t*>(username
));
1698 blen
+= base64_encode_update(&ctx
, loginbuf
+blen
, strlen(request
->peer_login
+1), reinterpret_cast<const uint8_t*>(request
->peer_login
+1));
1699 blen
+= base64_encode_final(&ctx
, loginbuf
+blen
);
1700 httpHeaderPutStrf(hdr_out
, header
, "Basic %.*s", (int)blen
, loginbuf
);
1704 /* external_acl provided credentials */
1705 if (request
->extacl_user
.size() && request
->extacl_passwd
.size() &&
1706 (strcmp(request
->peer_login
, "PASS") == 0 ||
1707 strcmp(request
->peer_login
, "PROXYPASS") == 0)) {
1709 blen
= base64_encode_update(&ctx
, loginbuf
, request
->extacl_user
.size(), reinterpret_cast<const uint8_t*>(request
->extacl_user
.rawBuf()));
1710 blen
+= base64_encode_update(&ctx
, loginbuf
+blen
, 1, reinterpret_cast<const uint8_t*>(":"));
1711 blen
+= base64_encode_update(&ctx
, loginbuf
+blen
, request
->extacl_passwd
.size(), reinterpret_cast<const uint8_t*>(request
->extacl_passwd
.rawBuf()));
1712 blen
+= base64_encode_final(&ctx
, loginbuf
+blen
);
1713 httpHeaderPutStrf(hdr_out
, header
, "Basic %.*s", (int)blen
, loginbuf
);
1716 // if no external user credentials are available to fake authentication with PASS acts like PASSTHRU
1717 if (strcmp(request
->peer_login
, "PASS") == 0)
1720 /* Kerberos login to peer */
1721 #if HAVE_AUTH_MODULE_NEGOTIATE && HAVE_KRB5 && HAVE_GSSAPI
1722 if (strncmp(request
->peer_login
, "NEGOTIATE",strlen("NEGOTIATE")) == 0) {
1724 char *PrincipalName
=NULL
,*p
;
1725 int negotiate_flags
= 0;
1727 if ((p
=strchr(request
->peer_login
,':')) != NULL
) {
1730 if (request
->flags
.auth_no_keytab
) {
1731 negotiate_flags
|= PEER_PROXY_NEGOTIATE_NOKEYTAB
;
1733 Token
= peer_proxy_negotiate_auth(PrincipalName
, request
->peer_host
, negotiate_flags
);
1735 httpHeaderPutStrf(hdr_out
, header
, "Negotiate %s",Token
);
1739 #endif /* HAVE_KRB5 && HAVE_GSSAPI */
1741 blen
= base64_encode_update(&ctx
, loginbuf
, strlen(request
->peer_login
), reinterpret_cast<const uint8_t*>(request
->peer_login
));
1742 blen
+= base64_encode_final(&ctx
, loginbuf
+blen
);
1743 httpHeaderPutStrf(hdr_out
, header
, "Basic %.*s", (int)blen
, loginbuf
);
1748 * build request headers and append them to a given MemBuf
1749 * used by buildRequestPrefix()
1750 * note: initialised the HttpHeader, the caller is responsible for Clean()-ing
1753 HttpStateData::httpBuildRequestHeader(HttpRequest
* request
,
1755 const AccessLogEntryPointer
&al
,
1756 HttpHeader
* hdr_out
,
1757 const HttpStateFlags
&flags
)
1759 /* building buffer for complex strings */
1760 #define BBUF_SZ (MAX_URL+32)
1761 LOCAL_ARRAY(char, bbuf
, BBUF_SZ
);
1762 LOCAL_ARRAY(char, ntoabuf
, MAX_IPSTRLEN
);
1763 const HttpHeader
*hdr_in
= &request
->header
;
1764 const HttpHeaderEntry
*e
= NULL
;
1765 HttpHeaderPos pos
= HttpHeaderInitPos
;
1766 assert (hdr_out
->owner
== hoRequest
);
1768 /* use our IMS header if the cached entry has Last-Modified time */
1769 if (request
->lastmod
> -1)
1770 hdr_out
->putTime(Http::HdrType::IF_MODIFIED_SINCE
, request
->lastmod
);
1772 // Add our own If-None-Match field if the cached entry has a strong ETag.
1773 // copyOneHeaderFromClientsideRequestToUpstreamRequest() adds client ones.
1774 if (request
->etag
.size() > 0) {
1775 hdr_out
->addEntry(new HttpHeaderEntry(Http::HdrType::IF_NONE_MATCH
, NULL
,
1776 request
->etag
.termedBuf()));
1779 bool we_do_ranges
= decideIfWeDoRanges (request
);
1781 String
strConnection (hdr_in
->getList(Http::HdrType::CONNECTION
));
1783 while ((e
= hdr_in
->getEntry(&pos
)))
1784 copyOneHeaderFromClientsideRequestToUpstreamRequest(e
, strConnection
, request
, hdr_out
, we_do_ranges
, flags
);
1786 /* Abstraction break: We should interpret multipart/byterange responses
1787 * into offset-length data, and this works around our inability to do so.
1789 if (!we_do_ranges
&& request
->multipartRangeRequest()) {
1790 /* don't cache the result */
1791 request
->flags
.cachable
= false;
1792 /* pretend it's not a range request */
1793 request
->ignoreRange("want to request the whole object");
1794 request
->flags
.isRanged
= false;
1798 if (Config
.onoff
.via
) {
1800 strVia
= hdr_in
->getList(Http::HdrType::VIA
);
1801 snprintf(bbuf
, BBUF_SZ
, "%d.%d %s",
1802 request
->http_ver
.major
,
1803 request
->http_ver
.minor
, ThisCache
);
1804 strListAdd(&strVia
, bbuf
, ',');
1805 hdr_out
->putStr(Http::HdrType::VIA
, strVia
.termedBuf());
1809 if (request
->flags
.accelerated
) {
1810 /* Append Surrogate-Capabilities */
1811 String
strSurrogate(hdr_in
->getList(Http::HdrType::SURROGATE_CAPABILITY
));
1813 snprintf(bbuf
, BBUF_SZ
, "%s=\"Surrogate/1.0 ESI/1.0\"", Config
.Accel
.surrogate_id
);
1815 snprintf(bbuf
, BBUF_SZ
, "%s=\"Surrogate/1.0\"", Config
.Accel
.surrogate_id
);
1817 strListAdd(&strSurrogate
, bbuf
, ',');
1818 hdr_out
->putStr(Http::HdrType::SURROGATE_CAPABILITY
, strSurrogate
.termedBuf());
1821 /** \pre Handle X-Forwarded-For */
1822 if (strcmp(opt_forwarded_for
, "delete") != 0) {
1824 String strFwd
= hdr_in
->getList(Http::HdrType::X_FORWARDED_FOR
);
1826 if (strFwd
.size() > 65536/2) {
1827 // There is probably a forwarding loop with Via detection disabled.
1828 // If we do nothing, String will assert on overflow soon.
1829 // TODO: Terminate all transactions with huge XFF?
1832 static int warnedCount
= 0;
1833 if (warnedCount
++ < 100) {
1834 const SBuf
url(entry
? SBuf(entry
->url()) : request
->effectiveRequestUri());
1835 debugs(11, DBG_IMPORTANT
, "Warning: likely forwarding loop with " << url
);
1839 if (strcmp(opt_forwarded_for
, "on") == 0) {
1840 /** If set to ON - append client IP or 'unknown'. */
1841 if ( request
->client_addr
.isNoAddr() )
1842 strListAdd(&strFwd
, "unknown", ',');
1844 strListAdd(&strFwd
, request
->client_addr
.toStr(ntoabuf
, MAX_IPSTRLEN
), ',');
1845 } else if (strcmp(opt_forwarded_for
, "off") == 0) {
1846 /** If set to OFF - append 'unknown'. */
1847 strListAdd(&strFwd
, "unknown", ',');
1848 } else if (strcmp(opt_forwarded_for
, "transparent") == 0) {
1849 /** If set to TRANSPARENT - pass through unchanged. */
1850 } else if (strcmp(opt_forwarded_for
, "truncate") == 0) {
1851 /** If set to TRUNCATE - drop existing list and replace with client IP or 'unknown'. */
1852 if ( request
->client_addr
.isNoAddr() )
1855 strFwd
= request
->client_addr
.toStr(ntoabuf
, MAX_IPSTRLEN
);
1857 if (strFwd
.size() > 0)
1858 hdr_out
->putStr(Http::HdrType::X_FORWARDED_FOR
, strFwd
.termedBuf());
1860 /** If set to DELETE - do not copy through. */
1862 /* append Host if not there already */
1863 if (!hdr_out
->has(Http::HdrType::HOST
)) {
1864 if (request
->peer_domain
) {
1865 hdr_out
->putStr(Http::HdrType::HOST
, request
->peer_domain
);
1867 SBuf authority
= request
->url
.authority();
1868 hdr_out
->putStr(Http::HdrType::HOST
, authority
.c_str());
1872 /* append Authorization if known in URL, not in header and going direct */
1873 if (!hdr_out
->has(Http::HdrType::AUTHORIZATION
)) {
1874 if (!request
->flags
.proxying
&& !request
->url
.userInfo().isEmpty()) {
1875 static uint8_t result
[base64_encode_len(MAX_URL
*2)]; // should be big enough for a single URI segment
1876 struct base64_encode_ctx ctx
;
1877 base64_encode_init(&ctx
);
1878 size_t blen
= base64_encode_update(&ctx
, result
, request
->url
.userInfo().length(), reinterpret_cast<const uint8_t*>(request
->url
.userInfo().rawContent()));
1879 blen
+= base64_encode_final(&ctx
, result
+blen
);
1880 result
[blen
] = '\0';
1882 httpHeaderPutStrf(hdr_out
, Http::HdrType::AUTHORIZATION
, "Basic %.*s", (int)blen
, result
);
1886 /* Fixup (Proxy-)Authorization special cases. Plain relaying dealt with above */
1887 httpFixupAuthentication(request
, hdr_in
, hdr_out
, flags
);
1889 /* append Cache-Control, add max-age if not there already */
1891 HttpHdrCc
*cc
= hdr_in
->getCc();
1894 cc
= new HttpHdrCc();
1896 #if 0 /* see bug 2330 */
1897 /* Set no-cache if determined needed but not found */
1898 if (request
->flags
.nocache
)
1899 EBIT_SET(cc
->mask
, HttpHdrCcType::CC_NO_CACHE
);
1902 /* Add max-age only without no-cache */
1903 if (!cc
->hasMaxAge() && !cc
->hasNoCache()) {
1904 // XXX: performance regression. c_str() reallocates
1905 SBuf
tmp(request
->effectiveRequestUri());
1906 cc
->maxAge(getMaxAge(entry
? entry
->url() : tmp
.c_str()));
1909 /* Enforce sibling relations */
1910 if (flags
.only_if_cached
)
1911 cc
->onlyIfCached(true);
1918 /* maybe append Connection: keep-alive */
1919 if (flags
.keepalive
) {
1920 hdr_out
->putStr(Http::HdrType::CONNECTION
, "keep-alive");
1923 /* append Front-End-Https */
1924 if (flags
.front_end_https
) {
1925 if (flags
.front_end_https
== 1 || request
->url
.getScheme() == AnyP::PROTO_HTTPS
)
1926 hdr_out
->putStr(Http::HdrType::FRONT_END_HTTPS
, "On");
1929 if (flags
.chunked_request
) {
1930 // Do not just copy the original value so that if the client-side
1931 // starts decode other encodings, this code may remain valid.
1932 hdr_out
->putStr(Http::HdrType::TRANSFER_ENCODING
, "chunked");
1935 /* Now mangle the headers. */
1936 if (Config2
.onoff
.mangle_request_headers
)
1937 httpHdrMangleList(hdr_out
, request
, ROR_REQUEST
);
1939 if (Config
.request_header_add
&& !Config
.request_header_add
->empty())
1940 httpHdrAdd(hdr_out
, request
, al
, *Config
.request_header_add
);
1942 strConnection
.clean();
1946 * Decides whether a particular header may be cloned from the received Clients request
1947 * to our outgoing fetch request.
1950 copyOneHeaderFromClientsideRequestToUpstreamRequest(const HttpHeaderEntry
*e
, const String strConnection
, const HttpRequest
* request
, HttpHeader
* hdr_out
, const int we_do_ranges
, const HttpStateFlags
&flags
)
1952 debugs(11, 5, "httpBuildRequestHeader: " << e
->name
<< ": " << e
->value
);
1956 /** \par RFC 2616 sect 13.5.1 - Hop-by-Hop headers which Squid should not pass on. */
1958 case Http::HdrType::PROXY_AUTHORIZATION
:
1959 /** \par Proxy-Authorization:
1960 * Only pass on proxy authentication to peers for which
1961 * authentication forwarding is explicitly enabled
1963 if (!flags
.originpeer
&& flags
.proxying
&& request
->peer_login
&&
1964 (strcmp(request
->peer_login
, "PASS") == 0 ||
1965 strcmp(request
->peer_login
, "PROXYPASS") == 0 ||
1966 strcmp(request
->peer_login
, "PASSTHRU") == 0)) {
1967 hdr_out
->addEntry(e
->clone());
1971 /** \par RFC 2616 sect 13.5.1 - Hop-by-Hop headers which Squid does not pass on. */
1973 case Http::HdrType::CONNECTION
: /** \par Connection: */
1974 case Http::HdrType::TE
: /** \par TE: */
1975 case Http::HdrType::KEEP_ALIVE
: /** \par Keep-Alive: */
1976 case Http::HdrType::PROXY_AUTHENTICATE
: /** \par Proxy-Authenticate: */
1977 case Http::HdrType::TRAILER
: /** \par Trailer: */
1978 case Http::HdrType::UPGRADE
: /** \par Upgrade: */
1979 case Http::HdrType::TRANSFER_ENCODING
: /** \par Transfer-Encoding: */
1982 /** \par OTHER headers I haven't bothered to track down yet. */
1984 case Http::HdrType::AUTHORIZATION
:
1985 /** \par WWW-Authorization:
1986 * Pass on WWW authentication */
1988 if (!flags
.originpeer
) {
1989 hdr_out
->addEntry(e
->clone());
1991 /** \note In accelerators, only forward authentication if enabled
1992 * (see also httpFixupAuthentication for special cases)
1994 if (request
->peer_login
&&
1995 (strcmp(request
->peer_login
, "PASS") == 0 ||
1996 strcmp(request
->peer_login
, "PASSTHRU") == 0 ||
1997 strcmp(request
->peer_login
, "PROXYPASS") == 0)) {
1998 hdr_out
->addEntry(e
->clone());
2004 case Http::HdrType::HOST
:
2006 * Normally Squid rewrites the Host: header.
2007 * However, there is one case when we don't: If the URL
2008 * went through our redirector and the admin configured
2009 * 'redir_rewrites_host' to be off.
2011 if (request
->peer_domain
)
2012 hdr_out
->putStr(Http::HdrType::HOST
, request
->peer_domain
);
2013 else if (request
->flags
.redirected
&& !Config
.onoff
.redir_rewrites_host
)
2014 hdr_out
->addEntry(e
->clone());
2016 SBuf authority
= request
->url
.authority();
2017 hdr_out
->putStr(Http::HdrType::HOST
, authority
.c_str());
2022 case Http::HdrType::IF_MODIFIED_SINCE
:
2023 /** \par If-Modified-Since:
2024 * append unless we added our own,
2025 * but only if cache_miss_revalidate is enabled, or
2026 * the request is not cacheable, or
2027 * the request contains authentication credentials.
2028 * \note at most one client's If-Modified-Since header can pass through
2030 // XXX: need to check and cleanup the auth case so cacheable auth requests get cached.
2031 if (hdr_out
->has(Http::HdrType::IF_MODIFIED_SINCE
))
2033 else if (Config
.onoff
.cache_miss_revalidate
|| !request
->flags
.cachable
|| request
->flags
.auth
)
2034 hdr_out
->addEntry(e
->clone());
2037 case Http::HdrType::IF_NONE_MATCH
:
2038 /** \par If-None-Match:
2039 * append if the wildcard '*' special case value is present, or
2040 * cache_miss_revalidate is disabled, or
2041 * the request is not cacheable in this proxy, or
2042 * the request contains authentication credentials.
2043 * \note this header lists a set of responses for the server to elide sending. Squid added values are extending that set.
2045 // XXX: need to check and cleanup the auth case so cacheable auth requests get cached.
2046 if (hdr_out
->hasListMember(Http::HdrType::IF_MATCH
, "*", ',') || Config
.onoff
.cache_miss_revalidate
|| !request
->flags
.cachable
|| request
->flags
.auth
)
2047 hdr_out
->addEntry(e
->clone());
2050 case Http::HdrType::MAX_FORWARDS
:
2051 /** \par Max-Forwards:
2052 * pass only on TRACE or OPTIONS requests */
2053 if (request
->method
== Http::METHOD_TRACE
|| request
->method
== Http::METHOD_OPTIONS
) {
2054 const int64_t hops
= e
->getInt64();
2057 hdr_out
->putInt64(Http::HdrType::MAX_FORWARDS
, hops
- 1);
2062 case Http::HdrType::VIA
:
2064 * If Via is disabled then forward any received header as-is.
2065 * Otherwise leave for explicit updated addition later. */
2067 if (!Config
.onoff
.via
)
2068 hdr_out
->addEntry(e
->clone());
2072 case Http::HdrType::RANGE
:
2074 case Http::HdrType::IF_RANGE
:
2076 case Http::HdrType::REQUEST_RANGE
:
2077 /** \par Range:, If-Range:, Request-Range:
2078 * Only pass if we accept ranges */
2080 hdr_out
->addEntry(e
->clone());
2084 case Http::HdrType::PROXY_CONNECTION
: // SHOULD ignore. But doing so breaks things.
2087 case Http::HdrType::CONTENT_LENGTH
:
2088 // pass through unless we chunk; also, keeping this away from default
2089 // prevents request smuggling via Connection: Content-Length tricks
2090 if (!flags
.chunked_request
)
2091 hdr_out
->addEntry(e
->clone());
2094 case Http::HdrType::X_FORWARDED_FOR
:
2096 case Http::HdrType::CACHE_CONTROL
:
2097 /** \par X-Forwarded-For:, Cache-Control:
2098 * handled specially by Squid, so leave off for now.
2099 * append these after the loop if needed */
2102 case Http::HdrType::FRONT_END_HTTPS
:
2103 /** \par Front-End-Https:
2104 * Pass thru only if peer is configured with front-end-https */
2105 if (!flags
.front_end_https
)
2106 hdr_out
->addEntry(e
->clone());
2112 * pass on all other header fields
2113 * which are NOT listed by the special Connection: header. */
2115 if (strConnection
.size()>0 && strListIsMember(&strConnection
, e
->name
.termedBuf(), ',')) {
2116 debugs(11, 2, "'" << e
->name
<< "' header cropped by Connection: definition");
2120 hdr_out
->addEntry(e
->clone());
2125 HttpStateData::decideIfWeDoRanges (HttpRequest
* request
)
2128 /* decide if we want to do Ranges ourselves
2129 * and fetch the whole object now)
2130 * We want to handle Ranges ourselves iff
2131 * - we can actually parse client Range specs
2132 * - the specs are expected to be simple enough (e.g. no out-of-order ranges)
2133 * - reply will be cachable
2134 * (If the reply will be uncachable we have to throw it away after
2135 * serving this request, so it is better to forward ranges to
2136 * the server and fetch only the requested content)
2139 int64_t roffLimit
= request
->getRangeOffsetLimit();
2141 if (NULL
== request
->range
|| !request
->flags
.cachable
2142 || request
->range
->offsetLimitExceeded(roffLimit
) || request
->flags
.connectionAuth
)
2145 debugs(11, 8, "decideIfWeDoRanges: range specs: " <<
2146 request
->range
<< ", cachable: " <<
2147 request
->flags
.cachable
<< "; we_do_ranges: " << result
);
2152 /* build request prefix and append it to a given MemBuf;
2153 * return the length of the prefix */
2155 HttpStateData::buildRequestPrefix(MemBuf
* mb
)
2157 const int offset
= mb
->size
;
2158 /* Uses a local httpver variable to print the HTTP label
2159 * since the HttpRequest may have an older version label.
2160 * XXX: This could create protocol bugs as the headers sent and
2161 * flow control should all be based on the HttpRequest version
2162 * not the one we are sending. Needs checking.
2164 const AnyP::ProtocolVersion httpver
= Http::ProtocolVersion();
2165 const SBuf
url(_peer
&& !_peer
->options
.originserver
? request
->effectiveRequestUri() : request
->url
.path());
2166 mb
->appendf(SQUIDSBUFPH
" " SQUIDSBUFPH
" %s/%d.%d\r\n",
2167 SQUIDSBUFPRINT(request
->method
.image()),
2168 SQUIDSBUFPRINT(url
),
2169 AnyP::ProtocolType_str
[httpver
.protocol
],
2170 httpver
.major
,httpver
.minor
);
2171 /* build and pack headers */
2173 HttpHeader
hdr(hoRequest
);
2174 httpBuildRequestHeader(request
, entry
, fwd
->al
, &hdr
, flags
);
2176 if (request
->flags
.pinned
&& request
->flags
.connectionAuth
)
2177 request
->flags
.authSent
= true;
2178 else if (hdr
.has(Http::HdrType::AUTHORIZATION
))
2179 request
->flags
.authSent
= true;
2184 /* append header terminator */
2185 mb
->append(crlf
, 2);
2186 return mb
->size
- offset
;
2189 /* This will be called when connect completes. Write request. */
2191 HttpStateData::sendRequest()
2195 debugs(11, 5, HERE
<< serverConnection
<< ", request " << request
<< ", this " << this << ".");
2197 if (!Comm::IsConnOpen(serverConnection
)) {
2198 debugs(11,3, HERE
<< "cannot send request to closing " << serverConnection
);
2199 assert(closeHandler
!= NULL
);
2203 typedef CommCbMemFunT
<HttpStateData
, CommTimeoutCbParams
> TimeoutDialer
;
2204 AsyncCall::Pointer timeoutCall
= JobCallback(11, 5,
2205 TimeoutDialer
, this, HttpStateData::httpTimeout
);
2206 commSetConnTimeout(serverConnection
, Config
.Timeout
.lifetime
, timeoutCall
);
2207 flags
.do_next_read
= true;
2208 maybeReadVirginBody();
2210 if (request
->body_pipe
!= NULL
) {
2211 if (!startRequestBodyFlow()) // register to receive body data
2213 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2214 requestSender
= JobCallback(11,5,
2215 Dialer
, this, HttpStateData::sentRequestBody
);
2217 Must(!flags
.chunked_request
);
2218 // use chunked encoding if we do not know the length
2219 if (request
->content_length
< 0)
2220 flags
.chunked_request
= true;
2222 assert(!requestBodySource
);
2223 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2224 requestSender
= JobCallback(11,5,
2225 Dialer
, this, HttpStateData::wroteLast
);
2228 flags
.originpeer
= (_peer
!= NULL
&& _peer
->options
.originserver
);
2229 flags
.proxying
= (_peer
!= NULL
&& !flags
.originpeer
);
2232 * Is keep-alive okay for all request methods?
2234 if (request
->flags
.mustKeepalive
)
2235 flags
.keepalive
= true;
2236 else if (request
->flags
.pinned
)
2237 flags
.keepalive
= request
->persistent();
2238 else if (!Config
.onoff
.server_pconns
)
2239 flags
.keepalive
= false;
2240 else if (_peer
== NULL
)
2241 flags
.keepalive
= true;
2242 else if (_peer
->stats
.n_keepalives_sent
< 10)
2243 flags
.keepalive
= true;
2244 else if ((double) _peer
->stats
.n_keepalives_recv
/
2245 (double) _peer
->stats
.n_keepalives_sent
> 0.50)
2246 flags
.keepalive
= true;
2249 /*The old code here was
2250 if (neighborType(_peer, request->url) == PEER_SIBLING && ...
2251 which is equivalent to:
2252 if (neighborType(_peer, URL()) == PEER_SIBLING && ...
2254 if (((_peer->type == PEER_MULTICAST && p->options.mcast_siblings) ||
2255 _peer->type == PEER_SIBLINGS ) && _peer->options.allow_miss)
2256 flags.only_if_cached = 1;
2258 But I suppose it was a bug
2260 if (neighborType(_peer
, request
->url
) == PEER_SIBLING
&& !_peer
->options
.allow_miss
)
2261 flags
.only_if_cached
= true;
2263 flags
.front_end_https
= _peer
->front_end_https
;
2267 request
->peer_host
=_peer
?_peer
->host
:NULL
;
2268 buildRequestPrefix(&mb
);
2270 debugs(11, 2, "HTTP Server " << serverConnection
);
2271 debugs(11, 2, "HTTP Server REQUEST:\n---------\n" << mb
.buf
<< "\n----------");
2273 Comm::Write(serverConnection
, &mb
, requestSender
);
2278 HttpStateData::getMoreRequestBody(MemBuf
&buf
)
2280 // parent's implementation can handle the no-encoding case
2281 if (!flags
.chunked_request
)
2282 return Client::getMoreRequestBody(buf
);
2286 Must(requestBodySource
!= NULL
);
2287 if (!requestBodySource
->getMoreData(raw
))
2288 return false; // no request body bytes to chunk yet
2290 // optimization: pre-allocate buffer size that should be enough
2291 const mb_size_t rawDataSize
= raw
.contentSize();
2292 // we may need to send: hex-chunk-size CRLF raw-data CRLF last-chunk
2293 buf
.init(16 + 2 + rawDataSize
+ 2 + 5, raw
.max_capacity
);
2295 buf
.appendf("%x\r\n", static_cast<unsigned int>(rawDataSize
));
2296 buf
.append(raw
.content(), rawDataSize
);
2297 buf
.append("\r\n", 2);
2299 Must(rawDataSize
> 0); // we did not accidently created last-chunk above
2301 // Do not send last-chunk unless we successfully received everything
2302 if (receivedWholeRequestBody
) {
2303 Must(!flags
.sentLastChunk
);
2304 flags
.sentLastChunk
= true;
2305 buf
.append("0\r\n\r\n", 5);
2312 httpStart(FwdState
*fwd
)
2314 debugs(11, 3, fwd
->request
->method
<< ' ' << fwd
->entry
->url());
2315 AsyncJob::Start(new HttpStateData(fwd
));
2319 HttpStateData::start()
2321 if (!sendRequest()) {
2322 debugs(11, 3, "httpStart: aborted");
2323 mustStop("HttpStateData::start failed");
2327 ++ statCounter
.server
.all
.requests
;
2328 ++ statCounter
.server
.http
.requests
;
2331 * We used to set the read timeout here, but not any more.
2332 * Now its set in httpSendComplete() after the full request,
2333 * including request body, has been written to the server.
2337 /// if broken posts are enabled for the request, try to fix and return true
2339 HttpStateData::finishingBrokenPost()
2341 #if USE_HTTP_VIOLATIONS
2342 if (!Config
.accessList
.brokenPosts
) {
2343 debugs(11, 5, HERE
<< "No brokenPosts list");
2347 ACLFilledChecklist
ch(Config
.accessList
.brokenPosts
, originalRequest(), NULL
);
2348 if (ch
.fastCheck() != ACCESS_ALLOWED
) {
2349 debugs(11, 5, HERE
<< "didn't match brokenPosts");
2353 if (!Comm::IsConnOpen(serverConnection
)) {
2354 debugs(11, 3, HERE
<< "ignoring broken POST for closed " << serverConnection
);
2355 assert(closeHandler
!= NULL
);
2356 return true; // prevent caller from proceeding as if nothing happened
2359 debugs(11, 3, "finishingBrokenPost: fixing broken POST");
2360 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2361 requestSender
= JobCallback(11,5,
2362 Dialer
, this, HttpStateData::wroteLast
);
2363 Comm::Write(serverConnection
, "\r\n", 2, requestSender
, NULL
);
2367 #endif /* USE_HTTP_VIOLATIONS */
2370 /// if needed, write last-chunk to end the request body and return true
2372 HttpStateData::finishingChunkedRequest()
2374 if (flags
.sentLastChunk
) {
2375 debugs(11, 5, HERE
<< "already sent last-chunk");
2379 Must(receivedWholeRequestBody
); // or we should not be sending last-chunk
2380 flags
.sentLastChunk
= true;
2382 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2383 requestSender
= JobCallback(11,5, Dialer
, this, HttpStateData::wroteLast
);
2384 Comm::Write(serverConnection
, "0\r\n\r\n", 5, requestSender
, NULL
);
2389 HttpStateData::doneSendingRequestBody()
2391 Client::doneSendingRequestBody();
2392 debugs(11,5, HERE
<< serverConnection
);
2394 // do we need to write something after the last body byte?
2395 if (flags
.chunked_request
&& finishingChunkedRequest())
2397 if (!flags
.chunked_request
&& finishingBrokenPost())
2403 // more origin request body data is available
2405 HttpStateData::handleMoreRequestBodyAvailable()
2407 if (eof
|| !Comm::IsConnOpen(serverConnection
)) {
2408 // XXX: we should check this condition in other callbacks then!
2409 // TODO: Check whether this can actually happen: We should unsubscribe
2410 // as a body consumer when the above condition(s) are detected.
2411 debugs(11, DBG_IMPORTANT
, HERE
<< "Transaction aborted while reading HTTP body");
2415 assert(requestBodySource
!= NULL
);
2417 if (requestBodySource
->buf().hasContent()) {
2418 // XXX: why does not this trigger a debug message on every request?
2420 if (flags
.headers_parsed
&& !flags
.abuse_detected
) {
2421 flags
.abuse_detected
= true;
2422 debugs(11, DBG_IMPORTANT
, "http handleMoreRequestBodyAvailable: Likely proxy abuse detected '" << request
->client_addr
<< "' -> '" << entry
->url() << "'" );
2424 if (virginReply()->sline
.status() == Http::scInvalidHeader
) {
2425 serverConnection
->close();
2431 HttpStateData::handleMoreRequestBodyAvailable();
2434 // premature end of the request body
2436 HttpStateData::handleRequestBodyProducerAborted()
2438 Client::handleRequestBodyProducerAborted();
2439 if (entry
->isEmpty()) {
2440 debugs(11, 3, "request body aborted: " << serverConnection
);
2441 // We usually get here when ICAP REQMOD aborts during body processing.
2442 // We might also get here if client-side aborts, but then our response
2443 // should not matter because either client-side will provide its own or
2444 // there will be no response at all (e.g., if the the client has left).
2445 ErrorState
*err
= new ErrorState(ERR_ICAP_FAILURE
, Http::scInternalServerError
, fwd
->request
);
2446 err
->detailError(ERR_DETAIL_SRV_REQMOD_REQ_BODY
);
2450 abortTransaction("request body producer aborted");
2453 // called when we wrote request headers(!) or a part of the body
2455 HttpStateData::sentRequestBody(const CommIoCbParams
&io
)
2458 statCounter
.server
.http
.kbytes_out
+= io
.size
;
2460 Client::sentRequestBody(io
);
2463 // Quickly abort the transaction
2464 // TODO: destruction should be sufficient as the destructor should cleanup,
2465 // including canceling close handlers
2467 HttpStateData::abortTransaction(const char *reason
)
2469 debugs(11,5, HERE
<< "aborting transaction for " << reason
<<
2470 "; " << serverConnection
<< ", this " << this);
2472 if (Comm::IsConnOpen(serverConnection
)) {
2473 serverConnection
->close();
2477 fwd
->handleUnregisteredServerEnd();
2478 mustStop("HttpStateData::abortTransaction");