2 * Copyright (C) 1996-2017 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 "http/Stream.h"
36 #include "HttpControlMsg.h"
37 #include "HttpHdrCc.h"
38 #include "HttpHdrContRange.h"
39 #include "HttpHdrSc.h"
40 #include "HttpHdrScTarget.h"
41 #include "HttpHeaderTools.h"
42 #include "HttpReply.h"
43 #include "HttpRequest.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 Http::StateFlags
&);
86 HttpStateData::HttpStateData(FwdState
*theFwdState
) :
87 AsyncJob("HttpStateData"),
90 httpChunkDecoder(NULL
),
95 debugs(11,5,HERE
<< "HttpStateData " << this << " created");
96 ignoreCacheControl
= false;
97 surrogateNoStore
= false;
98 serverConnection
= fwd
->serverConnection();
100 // reset peer response time stats for %<pt
101 request
->hier
.peer_http_request_sent
.tv_sec
= 0;
102 request
->hier
.peer_http_request_sent
.tv_usec
= 0;
104 if (fwd
->serverConnection() != NULL
)
105 _peer
= cbdataReference(fwd
->serverConnection()->getPeer()); /* might be NULL */
108 request
->flags
.proxying
= true;
110 * This NEIGHBOR_PROXY_ONLY check probably shouldn't be here.
111 * We might end up getting the object from somewhere else if,
112 * for example, the request to this neighbor fails.
114 if (_peer
->options
.proxy_only
)
115 entry
->releaseRequest();
118 entry
->setNoDelay(_peer
->options
.no_delay
);
123 * register the handler to free HTTP state data when the FD closes
125 typedef CommCbMemFunT
<HttpStateData
, CommCloseCbParams
> Dialer
;
126 closeHandler
= JobCallback(9, 5, Dialer
, this, HttpStateData::httpStateConnClosed
);
127 comm_add_close_handler(serverConnection
->fd
, closeHandler
);
130 HttpStateData::~HttpStateData()
133 * don't forget that ~Client() gets called automatically
136 if (httpChunkDecoder
)
137 delete httpChunkDecoder
;
139 cbdataReferenceDone(_peer
);
141 debugs(11,5, HERE
<< "HttpStateData " << this << " destroyed; " << serverConnection
);
144 const Comm::ConnectionPointer
&
145 HttpStateData::dataConnection() const
147 return serverConnection
;
151 HttpStateData::httpStateConnClosed(const CommCloseCbParams
¶ms
)
153 debugs(11, 5, "httpStateFree: FD " << params
.fd
<< ", httpState=" << params
.data
);
154 doneWithFwd
= "httpStateConnClosed()"; // assume FwdState is monitoring too
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
));
168 mustStop("HttpStateData::httpTimeout");
172 findPreviouslyCachedEntry(StoreEntry
*newEntry
) {
173 assert(newEntry
->mem_obj
);
174 return newEntry
->mem_obj
->request
?
175 storeGetPublicByRequest(newEntry
->mem_obj
->request
.getRaw()) :
176 storeGetPublic(newEntry
->mem_obj
->storeId(), newEntry
->mem_obj
->method
);
179 /// Remove an existing public store entry if the incoming response (to be
180 /// stored in a currently private entry) is going to invalidate it.
182 httpMaybeRemovePublic(StoreEntry
* e
, Http::StatusCode status
)
187 // If the incoming response already goes into a public entry, then there is
188 // nothing to remove. This protects ready-for-collapsing entries as well.
189 if (!EBIT_TEST(e
->flags
, KEY_PRIVATE
))
192 // If the new/incoming response cannot be stored, then it does not
193 // compete with the old stored response for the public key, and the
194 // old stored response should be left as is.
195 if (e
->mem_obj
->request
&& !e
->mem_obj
->request
->flags
.cachable
)
202 case Http::scNonAuthoritativeInformation
:
204 case Http::scMultipleChoices
:
206 case Http::scMovedPermanently
:
210 case Http::scSeeOther
:
214 case Http::scNotFound
:
219 case Http::scForbidden
:
221 case Http::scMethodNotAllowed
:
228 case Http::scUnauthorized
:
238 * Any 2xx response should eject previously cached entities...
241 if (status
>= 200 && status
< 300)
249 if (!remove
&& !forbidden
)
252 StoreEntry
*pe
= findPreviouslyCachedEntry(e
);
257 neighborsHtcpClear(e
, nullptr, e
->mem_obj
->request
.getRaw(), e
->mem_obj
->method
, HTCP_CLR_INVALIDATION
);
263 * Also remove any cached HEAD response in case the object has
266 if (e
->mem_obj
->request
)
267 pe
= storeGetPublicByRequestMethod(e
->mem_obj
->request
.getRaw(), Http::METHOD_HEAD
);
269 pe
= storeGetPublic(e
->mem_obj
->storeId(), Http::METHOD_HEAD
);
274 neighborsHtcpClear(e
, nullptr, e
->mem_obj
->request
.getRaw(), HttpRequestMethod(Http::METHOD_HEAD
), HTCP_CLR_INVALIDATION
);
281 HttpStateData::processSurrogateControl(HttpReply
*reply
)
283 if (request
->flags
.accelerated
&& reply
->surrogate_control
) {
284 HttpHdrScTarget
*sctusable
= reply
->surrogate_control
->getMergedTarget(Config
.Accel
.surrogate_id
);
287 if (sctusable
->hasNoStore() ||
288 (Config
.onoff
.surrogate_is_remote
289 && sctusable
->noStoreRemote())) {
290 surrogateNoStore
= true;
291 entry
->makePrivate();
294 /* The HttpHeader logic cannot tell if the header it's parsing is a reply to an
295 * accelerated request or not...
296 * Still, this is an abstraction breach. - RC
298 if (sctusable
->hasMaxAge()) {
299 if (sctusable
->maxAge() < sctusable
->maxStale())
300 reply
->expires
= reply
->date
+ sctusable
->maxAge();
302 reply
->expires
= reply
->date
+ sctusable
->maxStale();
304 /* And update the timestamps */
305 entry
->timestampsSet();
308 /* We ignore cache-control directives as per the Surrogate specification */
309 ignoreCacheControl
= true;
317 HttpStateData::cacheableReply()
319 HttpReply
const *rep
= finalReply();
320 HttpHeader
const *hdr
= &rep
->header
;
322 #if USE_HTTP_VIOLATIONS
324 const RefreshPattern
*R
= NULL
;
326 /* This strange looking define first looks up the refresh pattern
327 * and then checks if the specified flag is set. The main purpose
328 * of this is to simplify the refresh pattern lookup and USE_HTTP_VIOLATIONS
331 #define REFRESH_OVERRIDE(flag) \
332 ((R = (R ? R : refreshLimits(entry->mem_obj->storeId()))) , \
333 (R && R->flags.flag))
335 #define REFRESH_OVERRIDE(flag) 0
338 if (EBIT_TEST(entry
->flags
, RELEASE_REQUEST
)) {
339 debugs(22, 3, "NO because " << *entry
<< " has been released.");
343 // RFC 7234 section 4: a cache MUST use the most recent response
344 // (as determined by the Date header field)
346 debugs(22, 3, "NO because " << *entry
<< " has an older date header.");
350 // Check for Surrogate/1.0 protocol conditions
351 // NP: reverse-proxy traffic our parent server has instructed us never to cache
352 if (surrogateNoStore
) {
353 debugs(22, 3, HERE
<< "NO because Surrogate-Control:no-store");
357 // RFC 2616: HTTP/1.1 Cache-Control conditions
358 if (!ignoreCacheControl
) {
359 // XXX: check to see if the request headers alone were enough to prevent caching earlier
360 // (ie no-store request header) no need to check those all again here if so.
361 // for now we are not reliably doing that so we waste CPU re-checking request CC
363 // RFC 2616 section 14.9.2 - MUST NOT cache any response with request CC:no-store
364 if (request
&& request
->cache_control
&& request
->cache_control
->hasNoStore() &&
365 !REFRESH_OVERRIDE(ignore_no_store
)) {
366 debugs(22, 3, HERE
<< "NO because client request Cache-Control:no-store");
370 // NP: request CC:no-cache only means cache READ is forbidden. STORE is permitted.
371 if (rep
->cache_control
&& rep
->cache_control
->hasNoCacheWithParameters()) {
372 /* TODO: we are allowed to cache when no-cache= has parameters.
373 * Provided we strip away any of the listed headers unless they are revalidated
374 * successfully (ie, must revalidate AND these headers are prohibited on stale replies).
375 * That is a bit tricky for squid right now so we avoid caching entirely.
377 debugs(22, 3, HERE
<< "NO because server reply Cache-Control:no-cache has parameters");
381 // NP: request CC:private is undefined. We ignore.
382 // NP: other request CC flags are limiters on HIT/MISS. We don't care about here.
384 // RFC 2616 section 14.9.2 - MUST NOT cache any response with CC:no-store
385 if (rep
->cache_control
&& rep
->cache_control
->hasNoStore() &&
386 !REFRESH_OVERRIDE(ignore_no_store
)) {
387 debugs(22, 3, HERE
<< "NO because server reply Cache-Control:no-store");
391 // RFC 2616 section 14.9.1 - MUST NOT cache any response with CC:private in a shared cache like Squid.
392 // CC:private overrides CC:public when both are present in a response.
393 // TODO: add a shared/private cache configuration possibility.
394 if (rep
->cache_control
&&
395 rep
->cache_control
->hasPrivate() &&
396 !REFRESH_OVERRIDE(ignore_private
)) {
397 /* TODO: we are allowed to cache when private= has parameters.
398 * Provided we strip away any of the listed headers unless they are revalidated
399 * successfully (ie, must revalidate AND these headers are prohibited on stale replies).
400 * That is a bit tricky for squid right now so we avoid caching entirely.
402 debugs(22, 3, HERE
<< "NO because server reply Cache-Control:private");
407 // RFC 2068, sec 14.9.4 - MUST NOT cache any response with Authentication UNLESS certain CC controls are present
408 // allow HTTP violations to IGNORE those controls (ie re-block caching Auth)
409 if (request
&& (request
->flags
.auth
|| request
->flags
.authSent
)) {
410 if (!rep
->cache_control
) {
411 debugs(22, 3, HERE
<< "NO because Authenticated and server reply missing Cache-Control");
415 if (ignoreCacheControl
) {
416 debugs(22, 3, HERE
<< "NO because Authenticated and ignoring Cache-Control");
420 bool mayStore
= false;
421 // HTTPbis pt6 section 3.2: a response CC:public is present
422 if (rep
->cache_control
->hasPublic()) {
423 debugs(22, 3, HERE
<< "Authenticated but server reply Cache-Control:public");
426 // HTTPbis pt6 section 3.2: a response CC:must-revalidate is present
427 } else if (rep
->cache_control
->hasMustRevalidate()) {
428 debugs(22, 3, HERE
<< "Authenticated but server reply Cache-Control:must-revalidate");
431 #if USE_HTTP_VIOLATIONS
432 // NP: given the must-revalidate exception we should also be able to exempt no-cache.
433 // HTTPbis WG verdict on this is that it is omitted from the spec due to being 'unexpected' by
434 // some. The caching+revalidate is not exactly unsafe though with Squids interpretation of no-cache
435 // (without parameters) as equivalent to must-revalidate in the reply.
436 } else if (rep
->cache_control
->hasNoCacheWithoutParameters()) {
437 debugs(22, 3, HERE
<< "Authenticated but server reply Cache-Control:no-cache (equivalent to must-revalidate)");
441 // HTTPbis pt6 section 3.2: a response CC:s-maxage is present
442 } else if (rep
->cache_control
->hasSMaxAge()) {
443 debugs(22, 3, HERE
<< "Authenticated but server reply Cache-Control:s-maxage");
448 debugs(22, 3, HERE
<< "NO because Authenticated transaction");
452 // NP: response CC:no-cache is equivalent to CC:must-revalidate,max-age=0. We MAY cache, and do so.
453 // NP: other request CC flags are limiters on HIT/MISS/REFRESH. We don't care about here.
456 /* HACK: The "multipart/x-mixed-replace" content type is used for
457 * continuous push replies. These are generally dynamic and
458 * probably should not be cachable
460 if ((v
= hdr
->getStr(Http::HdrType::CONTENT_TYPE
)))
461 if (!strncasecmp(v
, "multipart/x-mixed-replace", 25)) {
462 debugs(22, 3, HERE
<< "NO because Content-Type:multipart/x-mixed-replace");
466 switch (rep
->sline
.status()) {
467 /* Responses that are cacheable */
471 case Http::scNonAuthoritativeInformation
:
473 case Http::scMultipleChoices
:
475 case Http::scMovedPermanently
:
476 case Http::scPermanentRedirect
:
480 * Don't cache objects that need to be refreshed on next request,
481 * unless we know how to refresh it.
484 if (!refreshIsCachable(entry
) && !REFRESH_OVERRIDE(store_stale
)) {
485 debugs(22, 3, "NO because refreshIsCachable() returned non-cacheable..");
488 debugs(22, 3, HERE
<< "YES because HTTP status " << rep
->sline
.status());
494 /* Responses that only are cacheable if the server says so */
497 case Http::scTemporaryRedirect
:
498 if (rep
->date
<= 0) {
499 debugs(22, 3, HERE
<< "NO because HTTP status " << rep
->sline
.status() << " and Date missing/invalid");
502 if (rep
->expires
> rep
->date
) {
503 debugs(22, 3, HERE
<< "YES because HTTP status " << rep
->sline
.status() << " and Expires > Date");
506 debugs(22, 3, HERE
<< "NO because HTTP status " << rep
->sline
.status() << " and Expires <= Date");
512 /* Errors can be negatively cached */
514 case Http::scNoContent
:
516 case Http::scUseProxy
:
518 case Http::scBadRequest
:
520 case Http::scForbidden
:
522 case Http::scNotFound
:
524 case Http::scMethodNotAllowed
:
526 case Http::scUriTooLong
:
528 case Http::scInternalServerError
:
530 case Http::scNotImplemented
:
532 case Http::scBadGateway
:
534 case Http::scServiceUnavailable
:
536 case Http::scGatewayTimeout
:
537 case Http::scMisdirectedRequest
:
539 debugs(22, 3, "MAYBE because HTTP status " << rep
->sline
.status());
545 /* Some responses can never be cached */
547 case Http::scPartialContent
: /* Not yet supported */
549 case Http::scSeeOther
:
551 case Http::scNotModified
:
553 case Http::scUnauthorized
:
555 case Http::scProxyAuthenticationRequired
:
557 case Http::scInvalidHeader
: /* Squid header parsing error */
559 case Http::scHeaderTooLarge
:
561 case Http::scPaymentRequired
:
562 case Http::scNotAcceptable
:
563 case Http::scRequestTimeout
:
564 case Http::scConflict
:
565 case Http::scLengthRequired
:
566 case Http::scPreconditionFailed
:
567 case Http::scPayloadTooLarge
:
568 case Http::scUnsupportedMediaType
:
569 case Http::scUnprocessableEntity
:
571 case Http::scFailedDependency
:
572 case Http::scInsufficientStorage
:
573 case Http::scRequestedRangeNotSatisfied
:
574 case Http::scExpectationFailed
:
576 debugs(22, 3, HERE
<< "NO because HTTP status " << rep
->sline
.status());
580 /* RFC 2616 section 6.1.1: an unrecognized response MUST NOT be cached. */
581 debugs (11, 3, HERE
<< "NO because unknown HTTP status code " << rep
->sline
.status());
591 /// assemble a variant key (vary-mark) from the given Vary header and HTTP request
593 assembleVaryKey(String
&vary
, SBuf
&vstr
, const HttpRequest
&request
)
595 static const SBuf
asterisk("*");
596 const char *pos
= nullptr;
597 const char *item
= nullptr;
600 while (strListGetItem(&vary
, ',', &item
, &ilen
, &pos
)) {
601 SBuf
name(item
, ilen
);
602 if (name
== asterisk
) {
608 vstr
.append(", ", 2);
610 String
hdr(request
.header
.getByName(name
));
611 const char *value
= hdr
.termedBuf();
613 value
= rfc1738_escape_part(value
);
614 vstr
.append("=\"", 2);
616 vstr
.append("\"", 1);
624 * For Vary, store the relevant request headers as
625 * virtual headers in the reply
626 * Returns an empty SBuf if the variance cannot be stored
629 httpMakeVaryMark(HttpRequest
* request
, HttpReply
const * reply
)
634 vary
= reply
->header
.getList(Http::HdrType::VARY
);
635 assembleVaryKey(vary
, vstr
, *request
);
637 #if X_ACCELERATOR_VARY
639 vary
= reply
->header
.getList(Http::HdrType::HDR_X_ACCELERATOR_VARY
);
640 assembleVaryKey(vary
, vstr
, *request
);
648 HttpStateData::keepaliveAccounting(HttpReply
*reply
)
652 ++ _peer
->stats
.n_keepalives_sent
;
654 if (reply
->keep_alive
) {
656 ++ _peer
->stats
.n_keepalives_recv
;
658 if (Config
.onoff
.detect_broken_server_pconns
659 && reply
->bodySize(request
->method
) == -1 && !flags
.chunked
) {
660 debugs(11, DBG_IMPORTANT
, "keepaliveAccounting: Impossible keep-alive header from '" << entry
->url() << "'" );
661 // debugs(11, 2, "GOT HTTP REPLY HDR:\n---------\n" << readBuf->content() << "\n----------" );
662 flags
.keepalive_broken
= true;
668 HttpStateData::checkDateSkew(HttpReply
*reply
)
670 if (reply
->date
> -1 && !_peer
) {
671 int skew
= abs((int)(reply
->date
- squid_curtime
));
674 debugs(11, 3, "" << request
->url
.host() << "'s clock is skewed by " << skew
<< " seconds!");
679 * This creates the error page itself.. its likely
680 * that the forward ported reply header max size patch
681 * generates non http conformant error pages - in which
682 * case the errors where should be 'BAD_GATEWAY' etc
685 HttpStateData::processReplyHeader()
687 /** Creates a blank header. If this routine is made incremental, this will not do */
689 /* NP: all exit points to this function MUST call ctx_exit(ctx) */
690 Ctx ctx
= ctx_enter(entry
->mem_obj
->urlXXX());
692 debugs(11, 3, "processReplyHeader: key '" << entry
->getMD5Text() << "'");
694 assert(!flags
.headers_parsed
);
696 if (!inBuf
.length()) {
701 /* Attempt to parse the first line; this will define where the protocol, status, reason-phrase and header begin */
704 hp
= new Http1::ResponseParser
;
706 bool parsedOk
= hp
->parse(inBuf
);
708 // sync the buffers after parsing.
709 inBuf
= hp
->remaining();
711 if (hp
->needsMoreData()) {
712 if (eof
) { // no more data coming
713 /* Bug 2879: Replies may terminate with \r\n then EOF instead of \r\n\r\n.
714 * We also may receive truncated responses.
715 * Ensure here that we have at minimum two \r\n when EOF is seen.
717 inBuf
.append("\r\n\r\n", 4);
719 parsedOk
= hp
->parse(inBuf
);
720 // sync the buffers after parsing.
721 inBuf
= hp
->remaining();
723 debugs(33, 5, "Incomplete response, waiting for end of response headers");
730 // unrecoverable parsing error
731 // TODO: Use Raw! XXX: inBuf no longer has the [beginning of the] malformed header.
732 debugs(11, 3, "Non-HTTP-compliant header:\n---------\n" << inBuf
<< "\n----------");
733 flags
.headers_parsed
= true;
734 HttpReply
*newrep
= new HttpReply
;
735 newrep
->sline
.set(Http::ProtocolVersion(), hp
->parseStatusCode
);
736 setVirginReply(newrep
);
742 /* We know the whole response is in parser now */
743 debugs(11, 2, "HTTP Server " << serverConnection
);
744 debugs(11, 2, "HTTP Server RESPONSE:\n---------\n" <<
745 hp
->messageProtocol() << " " << hp
->messageStatus() << " " << hp
->reasonPhrase() << "\n" <<
749 // reset payload tracking to begin after message headers
750 payloadSeen
= inBuf
.length();
752 HttpReply
*newrep
= new HttpReply
;
753 // XXX: RFC 7230 indicates we MAY ignore the reason phrase,
754 // and use an empty string on unknown status.
755 // We do that now to avoid performance regression from using SBuf::c_str()
756 newrep
->sline
.set(Http::ProtocolVersion(1,1), hp
->messageStatus() /* , hp->reasonPhrase() */);
757 newrep
->sline
.protocol
= newrep
->sline
.version
.protocol
= hp
->messageProtocol().protocol
;
758 newrep
->sline
.version
.major
= hp
->messageProtocol().major
;
759 newrep
->sline
.version
.minor
= hp
->messageProtocol().minor
;
762 if (!newrep
->parseHeader(*hp
)) {
763 // XXX: when Http::ProtocolVersion is a function, remove this hack. just set with messageProtocol()
764 newrep
->sline
.set(Http::ProtocolVersion(), Http::scInvalidHeader
);
765 newrep
->sline
.version
.protocol
= hp
->messageProtocol().protocol
;
766 newrep
->sline
.version
.major
= hp
->messageProtocol().major
;
767 newrep
->sline
.version
.minor
= hp
->messageProtocol().minor
;
768 debugs(11, 2, "error parsing response headers mime block");
771 // done with Parser, now process using the HttpReply
774 newrep
->sources
|= request
->url
.getScheme() == AnyP::PROTO_HTTPS
? Http::Message::srcHttps
: Http::Message::srcHttp
;
776 newrep
->removeStaleWarnings();
778 if (newrep
->sline
.protocol
== AnyP::PROTO_HTTP
&& newrep
->sline
.status() >= 100 && newrep
->sline
.status() < 200) {
784 flags
.chunked
= false;
785 if (newrep
->sline
.protocol
== AnyP::PROTO_HTTP
&& newrep
->header
.chunked()) {
786 flags
.chunked
= true;
787 httpChunkDecoder
= new Http1::TeChunkedParser
;
790 if (!peerSupportsConnectionPinning())
791 request
->flags
.connectionAuthDisabled
= true;
793 HttpReply
*vrep
= setVirginReply(newrep
);
794 flags
.headers_parsed
= true;
796 keepaliveAccounting(vrep
);
800 processSurrogateControl (vrep
);
802 request
->hier
.peer_reply_status
= newrep
->sline
.status();
807 /// ignore or start forwarding the 1xx response (a.k.a., control message)
809 HttpStateData::handle1xx(HttpReply
*reply
)
811 HttpReply::Pointer
msg(reply
); // will destroy reply if unused
813 // one 1xx at a time: we must not be called while waiting for previous 1xx
814 Must(!flags
.handling1xx
);
815 flags
.handling1xx
= true;
817 if (!request
->canHandle1xx() || request
->forcedBodyContinuation
) {
818 debugs(11, 2, "ignoring 1xx because it is " << (request
->forcedBodyContinuation
? "already sent" : "not supported by client"));
823 #if USE_HTTP_VIOLATIONS
824 // check whether the 1xx response forwarding is allowed by squid.conf
825 if (Config
.accessList
.reply
) {
826 ACLFilledChecklist
ch(Config
.accessList
.reply
, originalRequest().getRaw());
828 HTTPMSGLOCK(ch
.reply
);
829 if (ch
.fastCheck() != ACCESS_ALLOWED
) { // TODO: support slow lookups?
830 debugs(11, 3, HERE
<< "ignoring denied 1xx");
835 #endif // USE_HTTP_VIOLATIONS
837 debugs(11, 2, HERE
<< "forwarding 1xx to client");
839 // the Sink will use this to call us back after writing 1xx to the client
840 typedef NullaryMemFunT
<HttpStateData
> CbDialer
;
841 const AsyncCall::Pointer cb
= JobCallback(11, 3, CbDialer
, this,
842 HttpStateData::proceedAfter1xx
);
843 CallJobHere1(11, 4, request
->clientConnectionManager
, ConnStateData
,
844 ConnStateData::sendControlMsg
, HttpControlMsg(msg
, cb
));
845 // If the call is not fired, then the Sink is gone, and HttpStateData
846 // will terminate due to an aborted store entry or another similar error.
847 // If we get stuck, it is not handle1xx fault if we could get stuck
848 // for similar reasons without a 1xx response.
851 /// restores state and resumes processing after 1xx is ignored or forwarded
853 HttpStateData::proceedAfter1xx()
855 Must(flags
.handling1xx
);
856 debugs(11, 2, "continuing with " << payloadSeen
<< " bytes in buffer after 1xx");
857 CallJobHere(11, 3, this, HttpStateData
, HttpStateData::processReply
);
861 * returns true if the peer can support connection pinning
864 HttpStateData::peerSupportsConnectionPinning() const
869 /*If this peer does not support connection pinning (authenticated
870 connections) return false
872 if (!_peer
->connection_auth
)
875 const HttpReplyPointer
rep(entry
->mem_obj
->getReply());
877 /*The peer supports connection pinning and the http reply status
878 is not unauthorized, so the related connection can be pinned
880 if (rep
->sline
.status() != Http::scUnauthorized
)
883 /*The server respond with Http::scUnauthorized and the peer configured
884 with "connection-auth=on" we know that the peer supports pinned
887 if (_peer
->connection_auth
== 1)
890 /*At this point peer has configured with "connection-auth=auto"
891 parameter so we need some extra checks to decide if we are going
892 to allow pinned connections or not
895 /*if the peer configured with originserver just allow connection
896 pinning (squid 2.6 behaviour)
898 if (_peer
->options
.originserver
)
901 /*if the connections it is already pinned it is OK*/
902 if (request
->flags
.pinned
)
905 /*Allow pinned connections only if the Proxy-support header exists in
906 reply and has in its list the "Session-Based-Authentication"
907 which means that the peer supports connection pinning.
909 if (rep
->header
.hasListMember(Http::HdrType::PROXY_SUPPORT
, "Session-Based-Authentication", ','))
915 // Called when we parsed (and possibly adapted) the headers but
916 // had not starting storing (a.k.a., sending) the body yet.
918 HttpStateData::haveParsedReplyHeaders()
920 Client::haveParsedReplyHeaders();
922 Ctx ctx
= ctx_enter(entry
->mem_obj
->urlXXX());
923 HttpReply
*rep
= finalReply();
925 entry
->timestampsSet();
927 /* Check if object is cacheable or not based on reply code */
928 debugs(11, 3, "HTTP CODE: " << rep
->sline
.status());
930 if (const StoreEntry
*oldEntry
= findPreviouslyCachedEntry(entry
))
931 sawDateGoBack
= rep
->olderThan(oldEntry
->getReply());
933 if (neighbors_do_private_keys
&& !sawDateGoBack
)
934 httpMaybeRemovePublic(entry
, rep
->sline
.status());
936 bool varyFailure
= false;
937 if (rep
->header
.has(Http::HdrType::VARY
)
938 #if X_ACCELERATOR_VARY
939 || rep
->header
.has(Http::HdrType::HDR_X_ACCELERATOR_VARY
)
942 const SBuf
vary(httpMakeVaryMark(request
.getRaw(), rep
));
944 if (vary
.isEmpty()) {
945 entry
->makePrivate();
946 if (!fwd
->reforwardableStatus(rep
->sline
.status()))
947 EBIT_CLR(entry
->flags
, ENTRY_FWD_HDR_WAIT
);
950 entry
->mem_obj
->vary_headers
= vary
;
952 // RFC 7231 section 7.1.4
953 // Vary:* can be cached, but has mandatory revalidation
954 static const SBuf
asterisk("*");
955 if (vary
== asterisk
)
956 EBIT_SET(entry
->flags
, ENTRY_REVALIDATE_ALWAYS
);
962 * If its not a reply that we will re-forward, then
963 * allow the client to get it.
965 if (!fwd
->reforwardableStatus(rep
->sline
.status()))
966 EBIT_CLR(entry
->flags
, ENTRY_FWD_HDR_WAIT
);
968 switch (cacheableReply()) {
975 entry
->makePrivate();
980 #if USE_HTTP_VIOLATIONS
981 if (Config
.negativeTtl
> 0)
982 entry
->cacheNegatively();
985 entry
->makePrivate();
994 if (!ignoreCacheControl
) {
995 if (rep
->cache_control
) {
996 // We are required to revalidate on many conditions.
997 // For security reasons we do so even if storage was caused by refresh_pattern ignore-* option
999 // CC:must-revalidate or CC:proxy-revalidate
1000 const bool ccMustRevalidate
= (rep
->cache_control
->hasProxyRevalidate() || rep
->cache_control
->hasMustRevalidate());
1002 // CC:no-cache (only if there are no parameters)
1003 const bool ccNoCacheNoParams
= rep
->cache_control
->hasNoCacheWithoutParameters();
1006 const bool ccSMaxAge
= rep
->cache_control
->hasSMaxAge();
1008 // CC:private (yes, these can sometimes be stored)
1009 const bool ccPrivate
= rep
->cache_control
->hasPrivate();
1011 if (ccNoCacheNoParams
|| ccPrivate
)
1012 EBIT_SET(entry
->flags
, ENTRY_REVALIDATE_ALWAYS
);
1013 else if (ccMustRevalidate
|| ccSMaxAge
)
1014 EBIT_SET(entry
->flags
, ENTRY_REVALIDATE_STALE
);
1016 #if USE_HTTP_VIOLATIONS // response header Pragma::no-cache is undefined in HTTP
1018 // Expensive calculation. So only do it IF the CC: header is not present.
1020 /* HACK: Pragma: no-cache in _replies_ is not documented in HTTP,
1021 * but servers like "Active Imaging Webcast/2.0" sure do use it */
1022 if (rep
->header
.has(Http::HdrType::PRAGMA
) &&
1023 rep
->header
.hasListMember(Http::HdrType::PRAGMA
,"no-cache",','))
1024 EBIT_SET(entry
->flags
, ENTRY_REVALIDATE_ALWAYS
);
1030 headersLog(1, 0, request
->method
, rep
);
1037 HttpStateData::ConnectionStatus
1038 HttpStateData::statusIfComplete() const
1040 const HttpReply
*rep
= virginReply();
1042 * If the reply wants to close the connection, it takes precedence */
1044 if (httpHeaderHasConnDir(&rep
->header
, "close"))
1045 return COMPLETE_NONPERSISTENT_MSG
;
1048 * If we didn't send a keep-alive request header, then this
1049 * can not be a persistent connection.
1051 if (!flags
.keepalive
)
1052 return COMPLETE_NONPERSISTENT_MSG
;
1055 * If we haven't sent the whole request then this can not be a persistent
1058 if (!flags
.request_sent
) {
1059 debugs(11, 2, "Request not yet fully sent " << request
->method
<< ' ' << entry
->url());
1060 return COMPLETE_NONPERSISTENT_MSG
;
1064 * What does the reply have to say about keep-alive?
1068 * If the origin server (HTTP/1.0) does not send a keep-alive
1069 * header, but keeps the connection open anyway, what happens?
1070 * We'll return here and http.c waits for an EOF before changing
1071 * store_status to STORE_OK. Combine this with ENTRY_FWD_HDR_WAIT
1072 * and an error status code, and we might have to wait until
1073 * the server times out the socket.
1075 if (!rep
->keep_alive
)
1076 return COMPLETE_NONPERSISTENT_MSG
;
1078 return COMPLETE_PERSISTENT_MSG
;
1081 HttpStateData::ConnectionStatus
1082 HttpStateData::persistentConnStatus() const
1084 debugs(11, 3, HERE
<< serverConnection
<< " eof=" << eof
);
1085 if (eof
) // already reached EOF
1086 return COMPLETE_NONPERSISTENT_MSG
;
1088 /* If server fd is closing (but we have not been notified yet), stop Comm
1089 I/O to avoid assertions. TODO: Change Comm API to handle callers that
1090 want more I/O after async closing (usually initiated by others). */
1091 // XXX: add canReceive or s/canSend/canTalkToServer/
1092 if (!Comm::IsConnOpen(serverConnection
))
1093 return COMPLETE_NONPERSISTENT_MSG
;
1096 * In chunked response we do not know the content length but we are absolutely
1097 * sure about the end of response, so we are calling the statusIfComplete to
1098 * decide if we can be persistant
1100 if (lastChunk
&& flags
.chunked
)
1101 return statusIfComplete();
1103 const HttpReply
*vrep
= virginReply();
1104 debugs(11, 5, "persistentConnStatus: content_length=" << vrep
->content_length
);
1106 const int64_t clen
= vrep
->bodySize(request
->method
);
1108 debugs(11, 5, "persistentConnStatus: clen=" << clen
);
1110 /* If the body size is unknown we must wait for EOF */
1112 return INCOMPLETE_MSG
;
1115 * If the body size is known, we must wait until we've gotten all of it. */
1117 debugs(11,5, "payloadSeen=" << payloadSeen
<< " content_length=" << vrep
->content_length
);
1119 if (payloadSeen
< vrep
->content_length
)
1120 return INCOMPLETE_MSG
;
1122 if (payloadTruncated
> 0) // already read more than needed
1123 return COMPLETE_NONPERSISTENT_MSG
; // disable pconns
1127 * If there is no message body or we got it all, we can be persistent */
1128 return statusIfComplete();
1132 readDelayed(void *context
, CommRead
const &)
1134 HttpStateData
*state
= static_cast<HttpStateData
*>(context
);
1135 state
->flags
.do_next_read
= true;
1136 state
->maybeReadVirginBody();
1140 HttpStateData::readReply(const CommIoCbParams
&io
)
1142 Must(!flags
.do_next_read
); // XXX: should have been set false by mayReadVirginBody()
1143 flags
.do_next_read
= false;
1145 debugs(11, 5, io
.conn
);
1147 // Bail out early on Comm::ERR_CLOSING - close handlers will tidy up for us
1148 if (io
.flag
== Comm::ERR_CLOSING
) {
1149 debugs(11, 3, "http socket closing");
1153 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
)) {
1154 abortTransaction("store entry aborted while reading reply");
1158 Must(Comm::IsConnOpen(serverConnection
));
1159 Must(io
.conn
->fd
== serverConnection
->fd
);
1162 * Don't reset the timeout value here. The value should be
1163 * counting Config.Timeout.request and applies to the request
1164 * as a whole, not individual read() calls.
1165 * Plus, it breaks our lame *HalfClosed() detection
1168 Must(maybeMakeSpaceAvailable(true));
1169 CommIoCbParams
rd(this); // will be expanded with ReadNow results
1171 rd
.size
= entry
->bytesWanted(Range
<size_t>(0, inBuf
.spaceSize()));
1174 assert(entry
->mem_obj
);
1175 AsyncCall::Pointer nilCall
;
1176 entry
->mem_obj
->delayRead(DeferredRead(readDelayed
, this, CommRead(io
.conn
, NULL
, 0, nilCall
)));
1180 switch (Comm::ReadNow(rd
, inBuf
)) {
1181 case Comm::INPROGRESS
:
1182 if (inBuf
.isEmpty())
1183 debugs(33, 2, io
.conn
<< ": no data to process, " << xstrerr(rd
.xerrno
));
1184 flags
.do_next_read
= true;
1185 maybeReadVirginBody();
1190 payloadSeen
+= rd
.size
;
1192 DelayId delayId
= entry
->mem_obj
->mostBytesAllowed();
1193 delayId
.bytesIn(rd
.size
);
1196 statCounter
.server
.all
.kbytes_in
+= rd
.size
;
1197 statCounter
.server
.http
.kbytes_in
+= rd
.size
;
1198 ++ IOStats
.Http
.reads
;
1201 for (int clen
= rd
.size
- 1; clen
; ++bin
)
1204 ++ IOStats
.Http
.read_hist
[bin
];
1206 // update peer response time stats (%<pt)
1207 const timeval
&sent
= request
->hier
.peer_http_request_sent
;
1209 tvSub(request
->hier
.peer_response_time
, sent
, current_time
);
1211 request
->hier
.peer_response_time
.tv_sec
= -1;
1214 /* Continue to process previously read data */
1217 case Comm::ENDFILE
: // close detected by 0-byte read
1219 flags
.do_next_read
= false;
1221 /* Continue to process previously read data */
1224 // case Comm::COMM_ERROR:
1225 default: // no other flags should ever occur
1226 debugs(11, 2, io
.conn
<< ": read failure: " << xstrerr(rd
.xerrno
));
1227 ErrorState
*err
= new ErrorState(ERR_READ_ERROR
, Http::scBadGateway
, fwd
->request
);
1228 err
->xerrno
= rd
.xerrno
;
1230 flags
.do_next_read
= false;
1232 mustStop("HttpStateData::readReply");
1236 /* Process next response from buffer */
1240 /// processes the already read and buffered response data, possibly after
1241 /// waiting for asynchronous 1xx control message processing
1243 HttpStateData::processReply()
1246 if (flags
.handling1xx
) { // we came back after handling a 1xx response
1247 debugs(11, 5, HERE
<< "done with 1xx handling");
1248 flags
.handling1xx
= false;
1249 Must(!flags
.headers_parsed
);
1252 if (!flags
.headers_parsed
) { // have not parsed headers yet?
1253 PROF_start(HttpStateData_processReplyHeader
);
1254 processReplyHeader();
1255 PROF_stop(HttpStateData_processReplyHeader
);
1257 if (!continueAfterParsingHeader()) // parsing error or need more data
1258 return; // TODO: send errors to ICAP
1260 adaptOrFinalizeReply(); // may write to, abort, or "close" the entry
1263 // kick more reads if needed and/or process the response body, if any
1264 PROF_start(HttpStateData_processReplyBody
);
1265 processReplyBody(); // may call serverComplete()
1266 PROF_stop(HttpStateData_processReplyBody
);
1270 \retval true if we can continue with processing the body or doing ICAP.
1273 HttpStateData::continueAfterParsingHeader()
1275 if (flags
.handling1xx
) {
1276 debugs(11, 5, HERE
<< "wait for 1xx handling");
1277 Must(!flags
.headers_parsed
);
1281 if (!flags
.headers_parsed
&& !eof
) {
1282 debugs(11, 9, "needs more at " << inBuf
.length());
1283 flags
.do_next_read
= true;
1284 /** \retval false If we have not finished parsing the headers and may get more data.
1285 * Schedules more reads to retrieve the missing data.
1287 maybeReadVirginBody(); // schedules all kinds of reads; TODO: rename
1291 /** If we are done with parsing, check for errors */
1293 err_type error
= ERR_NONE
;
1295 if (flags
.headers_parsed
) { // parsed headers, possibly with errors
1296 // check for header parsing errors
1297 if (HttpReply
*vrep
= virginReply()) {
1298 const Http::StatusCode s
= vrep
->sline
.status();
1299 const AnyP::ProtocolVersion
&v
= vrep
->sline
.version
;
1300 if (s
== Http::scInvalidHeader
&& v
!= Http::ProtocolVersion(0,9)) {
1301 debugs(11, DBG_IMPORTANT
, "WARNING: HTTP: Invalid Response: Bad header encountered from " << entry
->url() << " AKA " << request
->url
);
1302 error
= ERR_INVALID_RESP
;
1303 } else if (s
== Http::scHeaderTooLarge
) {
1304 fwd
->dontRetry(true);
1305 error
= ERR_TOO_BIG
;
1306 } else if (vrep
->header
.conflictingContentLength()) {
1307 fwd
->dontRetry(true);
1308 error
= ERR_INVALID_RESP
;
1310 return true; // done parsing, got reply, and no error
1313 // parsed headers but got no reply
1314 debugs(11, DBG_IMPORTANT
, "WARNING: HTTP: Invalid Response: No reply at all for " << entry
->url() << " AKA " << request
->url
);
1315 error
= ERR_INVALID_RESP
;
1319 if (inBuf
.length()) {
1320 error
= ERR_INVALID_RESP
;
1321 debugs(11, DBG_IMPORTANT
, "WARNING: HTTP: Invalid Response: Headers did not parse at all for " << entry
->url() << " AKA " << request
->url
);
1323 error
= ERR_ZERO_SIZE_OBJECT
;
1324 debugs(11, (request
->flags
.accelerated
?DBG_IMPORTANT
:2), "WARNING: HTTP: Invalid Response: No object data received for " << entry
->url() << " AKA " << request
->url
);
1328 assert(error
!= ERR_NONE
);
1330 fwd
->fail(new ErrorState(error
, Http::scBadGateway
, fwd
->request
));
1331 flags
.do_next_read
= false;
1333 mustStop("HttpStateData::continueAfterParsingHeader");
1334 return false; // quit on error
1337 /** truncate what we read if we read too much so that writeReplyBody()
1338 writes no more than what we should have read */
1340 HttpStateData::truncateVirginBody()
1342 assert(flags
.headers_parsed
);
1344 HttpReply
*vrep
= virginReply();
1346 if (!vrep
->expectingBody(request
->method
, clen
) || clen
< 0)
1347 return; // no body or a body of unknown size, including chunked
1349 if (payloadSeen
- payloadTruncated
<= clen
)
1350 return; // we did not read too much or already took care of the extras
1352 if (const int64_t extras
= payloadSeen
- payloadTruncated
- clen
) {
1353 // server sent more that the advertised content length
1354 debugs(11, 5, "payloadSeen=" << payloadSeen
<<
1355 " clen=" << clen
<< '/' << vrep
->content_length
<<
1356 " trucated=" << payloadTruncated
<< '+' << extras
);
1358 inBuf
.chop(0, inBuf
.length() - extras
);
1359 payloadTruncated
+= extras
;
1364 * Call this when there is data from the origin server
1365 * which should be sent to either StoreEntry, or to ICAP...
1368 HttpStateData::writeReplyBody()
1370 truncateVirginBody(); // if needed
1371 const char *data
= inBuf
.rawContent();
1372 int len
= inBuf
.length();
1373 addVirginReplyBody(data
, len
);
1378 HttpStateData::decodeAndWriteReplyBody()
1380 const char *data
= NULL
;
1382 bool wasThereAnException
= false;
1383 assert(flags
.chunked
);
1384 assert(httpChunkDecoder
);
1385 SQUID_ENTER_THROWING_CODE();
1388 httpChunkDecoder
->setPayloadBuffer(&decodedData
);
1389 const bool doneParsing
= httpChunkDecoder
->parse(inBuf
);
1390 inBuf
= httpChunkDecoder
->remaining(); // sync buffers after parse
1391 len
= decodedData
.contentSize();
1392 data
=decodedData
.content();
1393 addVirginReplyBody(data
, len
);
1396 flags
.do_next_read
= false;
1398 SQUID_EXIT_THROWING_CODE(wasThereAnException
);
1399 return wasThereAnException
;
1403 * processReplyBody has two purposes:
1404 * 1 - take the reply body data, if any, and put it into either
1405 * the StoreEntry, or give it over to ICAP.
1406 * 2 - see if we made it to the end of the response (persistent
1407 * connections and such)
1410 HttpStateData::processReplyBody()
1412 Ip::Address client_addr
;
1413 bool ispinned
= false;
1415 if (!flags
.headers_parsed
) {
1416 flags
.do_next_read
= true;
1417 maybeReadVirginBody();
1422 debugs(11,5, HERE
<< "adaptationAccessCheckPending=" << adaptationAccessCheckPending
);
1423 if (adaptationAccessCheckPending
)
1429 * At this point the reply headers have been parsed and consumed.
1430 * That means header content has been removed from readBuf and
1431 * it contains only body data.
1433 if (entry
->isAccepting()) {
1434 if (flags
.chunked
) {
1435 if (!decodeAndWriteReplyBody()) {
1436 flags
.do_next_read
= false;
1444 // storing/sending methods like earlier adaptOrFinalizeReply() or
1445 // above writeReplyBody() may release/abort the store entry.
1446 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
)) {
1447 // TODO: In some cases (e.g., 304), we should keep persistent conn open.
1448 // Detect end-of-reply (and, hence, pool our idle pconn) earlier (ASAP).
1449 abortTransaction("store entry aborted while storing reply");
1452 switch (persistentConnStatus()) {
1453 case INCOMPLETE_MSG
: {
1454 debugs(11, 5, "processReplyBody: INCOMPLETE_MSG from " << serverConnection
);
1455 /* Wait for more data or EOF condition */
1456 AsyncCall::Pointer nil
;
1457 if (flags
.keepalive_broken
) {
1458 commSetConnTimeout(serverConnection
, 10, nil
);
1460 commSetConnTimeout(serverConnection
, Config
.Timeout
.read
, nil
);
1463 flags
.do_next_read
= true;
1467 case COMPLETE_PERSISTENT_MSG
:
1468 debugs(11, 5, "processReplyBody: COMPLETE_PERSISTENT_MSG from " << serverConnection
);
1469 /* yes we have to clear all these! */
1470 commUnsetConnTimeout(serverConnection
);
1471 flags
.do_next_read
= false;
1473 comm_remove_close_handler(serverConnection
->fd
, closeHandler
);
1474 closeHandler
= NULL
;
1475 fwd
->unregister(serverConnection
);
1477 if (request
->flags
.spoofClientIp
)
1478 client_addr
= request
->client_addr
;
1480 if (request
->flags
.pinned
) {
1482 } else if (request
->flags
.connectionAuth
&& request
->flags
.authSent
) {
1486 if (ispinned
&& request
->clientConnectionManager
.valid()) {
1487 request
->clientConnectionManager
->pinConnection(serverConnection
, request
.getRaw(), _peer
,
1488 (request
->flags
.connectionAuth
));
1490 fwd
->pconnPush(serverConnection
, request
->url
.host());
1493 serverConnection
= NULL
;
1497 case COMPLETE_NONPERSISTENT_MSG
:
1498 debugs(11, 5, "processReplyBody: COMPLETE_NONPERSISTENT_MSG from " << serverConnection
);
1503 maybeReadVirginBody();
1507 HttpStateData::mayReadVirginReplyBody() const
1509 // TODO: Be more precise here. For example, if/when reading trailer, we may
1510 // not be doneWithServer() yet, but we should return false. Similarly, we
1511 // could still be writing the request body after receiving the whole reply.
1512 return !doneWithServer();
1516 HttpStateData::maybeReadVirginBody()
1519 if (!Comm::IsConnOpen(serverConnection
) || fd_table
[serverConnection
->fd
].closing())
1522 if (!maybeMakeSpaceAvailable(false))
1525 // XXX: get rid of the do_next_read flag
1526 // check for the proper reasons preventing read(2)
1527 if (!flags
.do_next_read
)
1530 flags
.do_next_read
= false;
1532 // must not already be waiting for read(2) ...
1533 assert(!Comm::MonitorsRead(serverConnection
->fd
));
1535 // wait for read(2) to be possible.
1536 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
1537 AsyncCall::Pointer call
= JobCallback(11, 5, Dialer
, this, HttpStateData::readReply
);
1538 Comm::Read(serverConnection
, call
);
1542 HttpStateData::maybeMakeSpaceAvailable(bool doGrow
)
1544 // how much we are allowed to buffer
1545 const int limitBuffer
= (flags
.headers_parsed
? Config
.readAheadGap
: Config
.maxReplyHeaderSize
);
1547 if (limitBuffer
< 0 || inBuf
.length() >= (SBuf::size_type
)limitBuffer
) {
1548 // when buffer is at or over limit already
1549 debugs(11, 7, "wont read up to " << limitBuffer
<< ". buffer has (" << inBuf
.length() << "/" << inBuf
.spaceSize() << ") from " << serverConnection
);
1550 debugs(11, DBG_DATA
, "buffer has {" << inBuf
<< "}");
1551 // Process next response from buffer
1556 // how much we want to read
1557 const size_t read_size
= calcBufferSpaceToReserve(inBuf
.spaceSize(), (limitBuffer
- inBuf
.length()));
1560 debugs(11, 7, "wont read up to " << read_size
<< " into buffer (" << inBuf
.length() << "/" << inBuf
.spaceSize() << ") from " << serverConnection
);
1564 // just report whether we could grow or not, dont actually do it
1566 return (read_size
>= 2);
1568 // we may need to grow the buffer
1569 inBuf
.reserveSpace(read_size
);
1570 debugs(11, 8, (!flags
.do_next_read
? "wont" : "may") <<
1571 " read up to " << read_size
<< " bytes info buf(" << inBuf
.length() << "/" << inBuf
.spaceSize() <<
1572 ") from " << serverConnection
);
1574 return (inBuf
.spaceSize() >= 2); // only read if there is 1+ bytes of space available
1577 /// called after writing the very last request byte (body, last-chunk, etc)
1579 HttpStateData::wroteLast(const CommIoCbParams
&io
)
1581 debugs(11, 5, HERE
<< serverConnection
<< ": size " << io
.size
<< ": errflag " << io
.flag
<< ".");
1582 #if URL_CHECKSUM_DEBUG
1584 entry
->mem_obj
->checkUrlChecksum();
1588 fd_bytes(io
.fd
, io
.size
, FD_WRITE
);
1589 statCounter
.server
.all
.kbytes_out
+= io
.size
;
1590 statCounter
.server
.http
.kbytes_out
+= io
.size
;
1593 if (io
.flag
== Comm::ERR_CLOSING
)
1597 ErrorState
*err
= new ErrorState(ERR_WRITE_ERROR
, Http::scBadGateway
, fwd
->request
);
1598 err
->xerrno
= io
.xerrno
;
1601 mustStop("HttpStateData::wroteLast");
1608 /// successfully wrote the entire request (including body, last-chunk, etc.)
1610 HttpStateData::sendComplete()
1613 * Set the read timeout here because it hasn't been set yet.
1614 * We only set the read timeout after the request has been
1615 * fully written to the peer. If we start the timeout
1616 * after connection establishment, then we are likely to hit
1617 * the timeout for POST/PUT requests that have very large
1620 typedef CommCbMemFunT
<HttpStateData
, CommTimeoutCbParams
> TimeoutDialer
;
1621 AsyncCall::Pointer timeoutCall
= JobCallback(11, 5,
1622 TimeoutDialer
, this, HttpStateData::httpTimeout
);
1624 commSetConnTimeout(serverConnection
, Config
.Timeout
.read
, timeoutCall
);
1625 flags
.request_sent
= true;
1626 request
->hier
.peer_http_request_sent
= current_time
;
1630 HttpStateData::closeServer()
1632 debugs(11,5, HERE
<< "closing HTTP server " << serverConnection
<< " this " << this);
1634 if (Comm::IsConnOpen(serverConnection
)) {
1635 fwd
->unregister(serverConnection
);
1636 comm_remove_close_handler(serverConnection
->fd
, closeHandler
);
1637 closeHandler
= NULL
;
1638 serverConnection
->close();
1643 HttpStateData::doneWithServer() const
1645 return !Comm::IsConnOpen(serverConnection
);
1649 * Fixup authentication request headers for special cases
1652 httpFixupAuthentication(HttpRequest
* request
, const HttpHeader
* hdr_in
, HttpHeader
* hdr_out
, const Http::StateFlags
&flags
)
1654 Http::HdrType header
= flags
.originpeer
? Http::HdrType::AUTHORIZATION
: Http::HdrType::PROXY_AUTHORIZATION
;
1656 /* Nothing to do unless we are forwarding to a peer */
1657 if (!request
->flags
.proxying
)
1660 /* Needs to be explicitly enabled */
1661 if (!request
->peer_login
)
1664 /* Maybe already dealt with? */
1665 if (hdr_out
->has(header
))
1668 /* Nothing to do here for PASSTHRU */
1669 if (strcmp(request
->peer_login
, "PASSTHRU") == 0)
1672 /* PROXYPASS is a special case, single-signon to servers with the proxy password (basic only) */
1673 if (flags
.originpeer
&& strcmp(request
->peer_login
, "PROXYPASS") == 0 && hdr_in
->has(Http::HdrType::PROXY_AUTHORIZATION
)) {
1674 const char *auth
= hdr_in
->getStr(Http::HdrType::PROXY_AUTHORIZATION
);
1676 if (auth
&& strncasecmp(auth
, "basic ", 6) == 0) {
1677 hdr_out
->putStr(header
, auth
);
1682 uint8_t loginbuf
[base64_encode_len(MAX_LOGIN_SZ
)];
1684 struct base64_encode_ctx ctx
;
1685 base64_encode_init(&ctx
);
1687 /* Special mode to pass the username to the upstream cache */
1688 if (*request
->peer_login
== '*') {
1689 const char *username
= "-";
1691 if (request
->extacl_user
.size())
1692 username
= request
->extacl_user
.termedBuf();
1694 else if (request
->auth_user_request
!= NULL
)
1695 username
= request
->auth_user_request
->username();
1698 blen
= base64_encode_update(&ctx
, loginbuf
, strlen(username
), reinterpret_cast<const uint8_t*>(username
));
1699 blen
+= base64_encode_update(&ctx
, loginbuf
+blen
, strlen(request
->peer_login
+1), reinterpret_cast<const uint8_t*>(request
->peer_login
+1));
1700 blen
+= base64_encode_final(&ctx
, loginbuf
+blen
);
1701 httpHeaderPutStrf(hdr_out
, header
, "Basic %.*s", (int)blen
, loginbuf
);
1705 /* external_acl provided credentials */
1706 if (request
->extacl_user
.size() && request
->extacl_passwd
.size() &&
1707 (strcmp(request
->peer_login
, "PASS") == 0 ||
1708 strcmp(request
->peer_login
, "PROXYPASS") == 0)) {
1710 blen
= base64_encode_update(&ctx
, loginbuf
, request
->extacl_user
.size(), reinterpret_cast<const uint8_t*>(request
->extacl_user
.rawBuf()));
1711 blen
+= base64_encode_update(&ctx
, loginbuf
+blen
, 1, reinterpret_cast<const uint8_t*>(":"));
1712 blen
+= base64_encode_update(&ctx
, loginbuf
+blen
, request
->extacl_passwd
.size(), reinterpret_cast<const uint8_t*>(request
->extacl_passwd
.rawBuf()));
1713 blen
+= base64_encode_final(&ctx
, loginbuf
+blen
);
1714 httpHeaderPutStrf(hdr_out
, header
, "Basic %.*s", (int)blen
, loginbuf
);
1717 // if no external user credentials are available to fake authentication with PASS acts like PASSTHRU
1718 if (strcmp(request
->peer_login
, "PASS") == 0)
1721 /* Kerberos login to peer */
1722 #if HAVE_AUTH_MODULE_NEGOTIATE && HAVE_KRB5 && HAVE_GSSAPI
1723 if (strncmp(request
->peer_login
, "NEGOTIATE",strlen("NEGOTIATE")) == 0) {
1725 char *PrincipalName
=NULL
,*p
;
1726 int negotiate_flags
= 0;
1728 if ((p
=strchr(request
->peer_login
,':')) != NULL
) {
1731 if (request
->flags
.auth_no_keytab
) {
1732 negotiate_flags
|= PEER_PROXY_NEGOTIATE_NOKEYTAB
;
1734 Token
= peer_proxy_negotiate_auth(PrincipalName
, request
->peer_host
, negotiate_flags
);
1736 httpHeaderPutStrf(hdr_out
, header
, "Negotiate %s",Token
);
1740 #endif /* HAVE_KRB5 && HAVE_GSSAPI */
1742 blen
= base64_encode_update(&ctx
, loginbuf
, strlen(request
->peer_login
), reinterpret_cast<const uint8_t*>(request
->peer_login
));
1743 blen
+= base64_encode_final(&ctx
, loginbuf
+blen
);
1744 httpHeaderPutStrf(hdr_out
, header
, "Basic %.*s", (int)blen
, loginbuf
);
1749 * build request headers and append them to a given MemBuf
1750 * used by buildRequestPrefix()
1751 * note: initialised the HttpHeader, the caller is responsible for Clean()-ing
1754 HttpStateData::httpBuildRequestHeader(HttpRequest
* request
,
1756 const AccessLogEntryPointer
&al
,
1757 HttpHeader
* hdr_out
,
1758 const Http::StateFlags
&flags
)
1760 /* building buffer for complex strings */
1761 #define BBUF_SZ (MAX_URL+32)
1762 LOCAL_ARRAY(char, bbuf
, BBUF_SZ
);
1763 LOCAL_ARRAY(char, ntoabuf
, MAX_IPSTRLEN
);
1764 const HttpHeader
*hdr_in
= &request
->header
;
1765 const HttpHeaderEntry
*e
= NULL
;
1766 HttpHeaderPos pos
= HttpHeaderInitPos
;
1767 assert (hdr_out
->owner
== hoRequest
);
1769 /* use our IMS header if the cached entry has Last-Modified time */
1770 if (request
->lastmod
> -1)
1771 hdr_out
->putTime(Http::HdrType::IF_MODIFIED_SINCE
, request
->lastmod
);
1773 // Add our own If-None-Match field if the cached entry has a strong ETag.
1774 // copyOneHeaderFromClientsideRequestToUpstreamRequest() adds client ones.
1775 if (request
->etag
.size() > 0) {
1776 hdr_out
->addEntry(new HttpHeaderEntry(Http::HdrType::IF_NONE_MATCH
, NULL
,
1777 request
->etag
.termedBuf()));
1780 bool we_do_ranges
= decideIfWeDoRanges (request
);
1782 String
strConnection (hdr_in
->getList(Http::HdrType::CONNECTION
));
1784 while ((e
= hdr_in
->getEntry(&pos
)))
1785 copyOneHeaderFromClientsideRequestToUpstreamRequest(e
, strConnection
, request
, hdr_out
, we_do_ranges
, flags
);
1787 /* Abstraction break: We should interpret multipart/byterange responses
1788 * into offset-length data, and this works around our inability to do so.
1790 if (!we_do_ranges
&& request
->multipartRangeRequest()) {
1791 /* don't cache the result */
1792 request
->flags
.cachable
= false;
1793 /* pretend it's not a range request */
1794 request
->ignoreRange("want to request the whole object");
1795 request
->flags
.isRanged
= false;
1798 hdr_out
->addVia(request
->http_ver
, hdr_in
);
1800 if (request
->flags
.accelerated
) {
1801 /* Append Surrogate-Capabilities */
1802 String
strSurrogate(hdr_in
->getList(Http::HdrType::SURROGATE_CAPABILITY
));
1804 snprintf(bbuf
, BBUF_SZ
, "%s=\"Surrogate/1.0 ESI/1.0\"", Config
.Accel
.surrogate_id
);
1806 snprintf(bbuf
, BBUF_SZ
, "%s=\"Surrogate/1.0\"", Config
.Accel
.surrogate_id
);
1808 strListAdd(&strSurrogate
, bbuf
, ',');
1809 hdr_out
->putStr(Http::HdrType::SURROGATE_CAPABILITY
, strSurrogate
.termedBuf());
1812 /** \pre Handle X-Forwarded-For */
1813 if (strcmp(opt_forwarded_for
, "delete") != 0) {
1815 String strFwd
= hdr_in
->getList(Http::HdrType::X_FORWARDED_FOR
);
1817 // if we cannot double strFwd size, then it grew past 50% of the limit
1818 if (!strFwd
.canGrowBy(strFwd
.size())) {
1819 // There is probably a forwarding loop with Via detection disabled.
1820 // If we do nothing, String will assert on overflow soon.
1821 // TODO: Terminate all transactions with huge XFF?
1824 static int warnedCount
= 0;
1825 if (warnedCount
++ < 100) {
1826 const SBuf
url(entry
? SBuf(entry
->url()) : request
->effectiveRequestUri());
1827 debugs(11, DBG_IMPORTANT
, "Warning: likely forwarding loop with " << url
);
1831 if (strcmp(opt_forwarded_for
, "on") == 0) {
1832 /** If set to ON - append client IP or 'unknown'. */
1833 if ( request
->client_addr
.isNoAddr() )
1834 strListAdd(&strFwd
, "unknown", ',');
1836 strListAdd(&strFwd
, request
->client_addr
.toStr(ntoabuf
, MAX_IPSTRLEN
), ',');
1837 } else if (strcmp(opt_forwarded_for
, "off") == 0) {
1838 /** If set to OFF - append 'unknown'. */
1839 strListAdd(&strFwd
, "unknown", ',');
1840 } else if (strcmp(opt_forwarded_for
, "transparent") == 0) {
1841 /** If set to TRANSPARENT - pass through unchanged. */
1842 } else if (strcmp(opt_forwarded_for
, "truncate") == 0) {
1843 /** If set to TRUNCATE - drop existing list and replace with client IP or 'unknown'. */
1844 if ( request
->client_addr
.isNoAddr() )
1847 strFwd
= request
->client_addr
.toStr(ntoabuf
, MAX_IPSTRLEN
);
1849 if (strFwd
.size() > 0)
1850 hdr_out
->putStr(Http::HdrType::X_FORWARDED_FOR
, strFwd
.termedBuf());
1852 /** If set to DELETE - do not copy through. */
1854 /* append Host if not there already */
1855 if (!hdr_out
->has(Http::HdrType::HOST
)) {
1856 if (request
->peer_domain
) {
1857 hdr_out
->putStr(Http::HdrType::HOST
, request
->peer_domain
);
1859 SBuf authority
= request
->url
.authority();
1860 hdr_out
->putStr(Http::HdrType::HOST
, authority
.c_str());
1864 /* append Authorization if known in URL, not in header and going direct */
1865 if (!hdr_out
->has(Http::HdrType::AUTHORIZATION
)) {
1866 if (!request
->flags
.proxying
&& !request
->url
.userInfo().isEmpty()) {
1867 static uint8_t result
[base64_encode_len(MAX_URL
*2)]; // should be big enough for a single URI segment
1868 struct base64_encode_ctx ctx
;
1869 base64_encode_init(&ctx
);
1870 size_t blen
= base64_encode_update(&ctx
, result
, request
->url
.userInfo().length(), reinterpret_cast<const uint8_t*>(request
->url
.userInfo().rawContent()));
1871 blen
+= base64_encode_final(&ctx
, result
+blen
);
1872 result
[blen
] = '\0';
1874 httpHeaderPutStrf(hdr_out
, Http::HdrType::AUTHORIZATION
, "Basic %.*s", (int)blen
, result
);
1878 /* Fixup (Proxy-)Authorization special cases. Plain relaying dealt with above */
1879 httpFixupAuthentication(request
, hdr_in
, hdr_out
, flags
);
1881 /* append Cache-Control, add max-age if not there already */
1883 HttpHdrCc
*cc
= hdr_in
->getCc();
1886 cc
= new HttpHdrCc();
1888 #if 0 /* see bug 2330 */
1889 /* Set no-cache if determined needed but not found */
1890 if (request
->flags
.nocache
)
1891 EBIT_SET(cc
->mask
, HttpHdrCcType::CC_NO_CACHE
);
1894 /* Add max-age only without no-cache */
1895 if (!cc
->hasMaxAge() && !cc
->hasNoCache()) {
1896 // XXX: performance regression. c_str() reallocates
1897 SBuf
tmp(request
->effectiveRequestUri());
1898 cc
->maxAge(getMaxAge(entry
? entry
->url() : tmp
.c_str()));
1901 /* Enforce sibling relations */
1902 if (flags
.only_if_cached
)
1903 cc
->onlyIfCached(true);
1910 /* maybe append Connection: keep-alive */
1911 if (flags
.keepalive
) {
1912 hdr_out
->putStr(Http::HdrType::CONNECTION
, "keep-alive");
1915 /* append Front-End-Https */
1916 if (flags
.front_end_https
) {
1917 if (flags
.front_end_https
== 1 || request
->url
.getScheme() == AnyP::PROTO_HTTPS
)
1918 hdr_out
->putStr(Http::HdrType::FRONT_END_HTTPS
, "On");
1921 if (flags
.chunked_request
) {
1922 // Do not just copy the original value so that if the client-side
1923 // starts decode other encodings, this code may remain valid.
1924 hdr_out
->putStr(Http::HdrType::TRANSFER_ENCODING
, "chunked");
1927 /* Now mangle the headers. */
1928 httpHdrMangleList(hdr_out
, request
, al
, ROR_REQUEST
);
1930 strConnection
.clean();
1934 * Decides whether a particular header may be cloned from the received Clients request
1935 * to our outgoing fetch request.
1938 copyOneHeaderFromClientsideRequestToUpstreamRequest(const HttpHeaderEntry
*e
, const String strConnection
, const HttpRequest
* request
, HttpHeader
* hdr_out
, const int we_do_ranges
, const Http::StateFlags
&flags
)
1940 debugs(11, 5, "httpBuildRequestHeader: " << e
->name
<< ": " << e
->value
);
1944 /** \par RFC 2616 sect 13.5.1 - Hop-by-Hop headers which Squid should not pass on. */
1946 case Http::HdrType::PROXY_AUTHORIZATION
:
1947 /** \par Proxy-Authorization:
1948 * Only pass on proxy authentication to peers for which
1949 * authentication forwarding is explicitly enabled
1951 if (!flags
.originpeer
&& flags
.proxying
&& request
->peer_login
&&
1952 (strcmp(request
->peer_login
, "PASS") == 0 ||
1953 strcmp(request
->peer_login
, "PROXYPASS") == 0 ||
1954 strcmp(request
->peer_login
, "PASSTHRU") == 0)) {
1955 hdr_out
->addEntry(e
->clone());
1959 /** \par RFC 2616 sect 13.5.1 - Hop-by-Hop headers which Squid does not pass on. */
1961 case Http::HdrType::CONNECTION
: /** \par Connection: */
1962 case Http::HdrType::TE
: /** \par TE: */
1963 case Http::HdrType::KEEP_ALIVE
: /** \par Keep-Alive: */
1964 case Http::HdrType::PROXY_AUTHENTICATE
: /** \par Proxy-Authenticate: */
1965 case Http::HdrType::TRAILER
: /** \par Trailer: */
1966 case Http::HdrType::UPGRADE
: /** \par Upgrade: */
1967 case Http::HdrType::TRANSFER_ENCODING
: /** \par Transfer-Encoding: */
1970 /** \par OTHER headers I haven't bothered to track down yet. */
1972 case Http::HdrType::AUTHORIZATION
:
1973 /** \par WWW-Authorization:
1974 * Pass on WWW authentication */
1976 if (!flags
.originpeer
) {
1977 hdr_out
->addEntry(e
->clone());
1979 /** \note In accelerators, only forward authentication if enabled
1980 * (see also httpFixupAuthentication for special cases)
1982 if (request
->peer_login
&&
1983 (strcmp(request
->peer_login
, "PASS") == 0 ||
1984 strcmp(request
->peer_login
, "PASSTHRU") == 0 ||
1985 strcmp(request
->peer_login
, "PROXYPASS") == 0)) {
1986 hdr_out
->addEntry(e
->clone());
1992 case Http::HdrType::HOST
:
1994 * Normally Squid rewrites the Host: header.
1995 * However, there is one case when we don't: If the URL
1996 * went through our redirector and the admin configured
1997 * 'redir_rewrites_host' to be off.
1999 if (request
->peer_domain
)
2000 hdr_out
->putStr(Http::HdrType::HOST
, request
->peer_domain
);
2001 else if (request
->flags
.redirected
&& !Config
.onoff
.redir_rewrites_host
)
2002 hdr_out
->addEntry(e
->clone());
2004 SBuf authority
= request
->url
.authority();
2005 hdr_out
->putStr(Http::HdrType::HOST
, authority
.c_str());
2010 case Http::HdrType::IF_MODIFIED_SINCE
:
2011 /** \par If-Modified-Since:
2012 * append unless we added our own,
2013 * but only if cache_miss_revalidate is enabled, or
2014 * the request is not cacheable, or
2015 * the request contains authentication credentials.
2016 * \note at most one client's If-Modified-Since header can pass through
2018 // XXX: need to check and cleanup the auth case so cacheable auth requests get cached.
2019 if (hdr_out
->has(Http::HdrType::IF_MODIFIED_SINCE
))
2021 else if (Config
.onoff
.cache_miss_revalidate
|| !request
->flags
.cachable
|| request
->flags
.auth
)
2022 hdr_out
->addEntry(e
->clone());
2025 case Http::HdrType::IF_NONE_MATCH
:
2026 /** \par If-None-Match:
2027 * append if the wildcard '*' special case value is present, or
2028 * cache_miss_revalidate is disabled, or
2029 * the request is not cacheable in this proxy, or
2030 * the request contains authentication credentials.
2031 * \note this header lists a set of responses for the server to elide sending. Squid added values are extending that set.
2033 // XXX: need to check and cleanup the auth case so cacheable auth requests get cached.
2034 if (hdr_out
->hasListMember(Http::HdrType::IF_MATCH
, "*", ',') || Config
.onoff
.cache_miss_revalidate
|| !request
->flags
.cachable
|| request
->flags
.auth
)
2035 hdr_out
->addEntry(e
->clone());
2038 case Http::HdrType::MAX_FORWARDS
:
2039 /** \par Max-Forwards:
2040 * pass only on TRACE or OPTIONS requests */
2041 if (request
->method
== Http::METHOD_TRACE
|| request
->method
== Http::METHOD_OPTIONS
) {
2042 const int64_t hops
= e
->getInt64();
2045 hdr_out
->putInt64(Http::HdrType::MAX_FORWARDS
, hops
- 1);
2050 case Http::HdrType::VIA
:
2052 * If Via is disabled then forward any received header as-is.
2053 * Otherwise leave for explicit updated addition later. */
2055 if (!Config
.onoff
.via
)
2056 hdr_out
->addEntry(e
->clone());
2060 case Http::HdrType::RANGE
:
2062 case Http::HdrType::IF_RANGE
:
2064 case Http::HdrType::REQUEST_RANGE
:
2065 /** \par Range:, If-Range:, Request-Range:
2066 * Only pass if we accept ranges */
2068 hdr_out
->addEntry(e
->clone());
2072 case Http::HdrType::PROXY_CONNECTION
: // SHOULD ignore. But doing so breaks things.
2075 case Http::HdrType::CONTENT_LENGTH
:
2076 // pass through unless we chunk; also, keeping this away from default
2077 // prevents request smuggling via Connection: Content-Length tricks
2078 if (!flags
.chunked_request
)
2079 hdr_out
->addEntry(e
->clone());
2082 case Http::HdrType::X_FORWARDED_FOR
:
2084 case Http::HdrType::CACHE_CONTROL
:
2085 /** \par X-Forwarded-For:, Cache-Control:
2086 * handled specially by Squid, so leave off for now.
2087 * append these after the loop if needed */
2090 case Http::HdrType::FRONT_END_HTTPS
:
2091 /** \par Front-End-Https:
2092 * Pass thru only if peer is configured with front-end-https */
2093 if (!flags
.front_end_https
)
2094 hdr_out
->addEntry(e
->clone());
2100 * pass on all other header fields
2101 * which are NOT listed by the special Connection: header. */
2103 if (strConnection
.size()>0 && strListIsMember(&strConnection
, e
->name
.termedBuf(), ',')) {
2104 debugs(11, 2, "'" << e
->name
<< "' header cropped by Connection: definition");
2108 hdr_out
->addEntry(e
->clone());
2113 HttpStateData::decideIfWeDoRanges (HttpRequest
* request
)
2116 /* decide if we want to do Ranges ourselves
2117 * and fetch the whole object now)
2118 * We want to handle Ranges ourselves iff
2119 * - we can actually parse client Range specs
2120 * - the specs are expected to be simple enough (e.g. no out-of-order ranges)
2121 * - reply will be cachable
2122 * (If the reply will be uncachable we have to throw it away after
2123 * serving this request, so it is better to forward ranges to
2124 * the server and fetch only the requested content)
2127 int64_t roffLimit
= request
->getRangeOffsetLimit();
2129 if (NULL
== request
->range
|| !request
->flags
.cachable
2130 || request
->range
->offsetLimitExceeded(roffLimit
) || request
->flags
.connectionAuth
)
2133 debugs(11, 8, "decideIfWeDoRanges: range specs: " <<
2134 request
->range
<< ", cachable: " <<
2135 request
->flags
.cachable
<< "; we_do_ranges: " << result
);
2140 /* build request prefix and append it to a given MemBuf;
2141 * return the length of the prefix */
2143 HttpStateData::buildRequestPrefix(MemBuf
* mb
)
2145 const int offset
= mb
->size
;
2146 /* Uses a local httpver variable to print the HTTP label
2147 * since the HttpRequest may have an older version label.
2148 * XXX: This could create protocol bugs as the headers sent and
2149 * flow control should all be based on the HttpRequest version
2150 * not the one we are sending. Needs checking.
2152 const AnyP::ProtocolVersion httpver
= Http::ProtocolVersion();
2153 const SBuf
url(_peer
&& !_peer
->options
.originserver
? request
->effectiveRequestUri() : request
->url
.path());
2154 mb
->appendf(SQUIDSBUFPH
" " SQUIDSBUFPH
" %s/%d.%d\r\n",
2155 SQUIDSBUFPRINT(request
->method
.image()),
2156 SQUIDSBUFPRINT(url
),
2157 AnyP::ProtocolType_str
[httpver
.protocol
],
2158 httpver
.major
,httpver
.minor
);
2159 /* build and pack headers */
2161 HttpHeader
hdr(hoRequest
);
2162 httpBuildRequestHeader(request
.getRaw(), entry
, fwd
->al
, &hdr
, flags
);
2164 if (request
->flags
.pinned
&& request
->flags
.connectionAuth
)
2165 request
->flags
.authSent
= true;
2166 else if (hdr
.has(Http::HdrType::AUTHORIZATION
))
2167 request
->flags
.authSent
= true;
2172 /* append header terminator */
2173 mb
->append(crlf
, 2);
2174 return mb
->size
- offset
;
2177 /* This will be called when connect completes. Write request. */
2179 HttpStateData::sendRequest()
2183 debugs(11, 5, HERE
<< serverConnection
<< ", request " << request
<< ", this " << this << ".");
2185 if (!Comm::IsConnOpen(serverConnection
)) {
2186 debugs(11,3, HERE
<< "cannot send request to closing " << serverConnection
);
2187 assert(closeHandler
!= NULL
);
2191 typedef CommCbMemFunT
<HttpStateData
, CommTimeoutCbParams
> TimeoutDialer
;
2192 AsyncCall::Pointer timeoutCall
= JobCallback(11, 5,
2193 TimeoutDialer
, this, HttpStateData::httpTimeout
);
2194 commSetConnTimeout(serverConnection
, Config
.Timeout
.lifetime
, timeoutCall
);
2195 flags
.do_next_read
= true;
2196 maybeReadVirginBody();
2198 if (request
->body_pipe
!= NULL
) {
2199 if (!startRequestBodyFlow()) // register to receive body data
2201 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2202 requestSender
= JobCallback(11,5,
2203 Dialer
, this, HttpStateData::sentRequestBody
);
2205 Must(!flags
.chunked_request
);
2206 // use chunked encoding if we do not know the length
2207 if (request
->content_length
< 0)
2208 flags
.chunked_request
= true;
2210 assert(!requestBodySource
);
2211 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2212 requestSender
= JobCallback(11,5,
2213 Dialer
, this, HttpStateData::wroteLast
);
2216 flags
.originpeer
= (_peer
!= NULL
&& _peer
->options
.originserver
);
2217 flags
.proxying
= (_peer
!= NULL
&& !flags
.originpeer
);
2220 * Is keep-alive okay for all request methods?
2222 if (request
->flags
.mustKeepalive
)
2223 flags
.keepalive
= true;
2224 else if (request
->flags
.pinned
)
2225 flags
.keepalive
= request
->persistent();
2226 else if (!Config
.onoff
.server_pconns
)
2227 flags
.keepalive
= false;
2228 else if (_peer
== NULL
)
2229 flags
.keepalive
= true;
2230 else if (_peer
->stats
.n_keepalives_sent
< 10)
2231 flags
.keepalive
= true;
2232 else if ((double) _peer
->stats
.n_keepalives_recv
/
2233 (double) _peer
->stats
.n_keepalives_sent
> 0.50)
2234 flags
.keepalive
= true;
2237 /*The old code here was
2238 if (neighborType(_peer, request->url) == PEER_SIBLING && ...
2239 which is equivalent to:
2240 if (neighborType(_peer, URL()) == PEER_SIBLING && ...
2242 if (((_peer->type == PEER_MULTICAST && p->options.mcast_siblings) ||
2243 _peer->type == PEER_SIBLINGS ) && _peer->options.allow_miss)
2244 flags.only_if_cached = 1;
2246 But I suppose it was a bug
2248 if (neighborType(_peer
, request
->url
) == PEER_SIBLING
&& !_peer
->options
.allow_miss
)
2249 flags
.only_if_cached
= true;
2251 flags
.front_end_https
= _peer
->front_end_https
;
2255 request
->peer_host
=_peer
?_peer
->host
:NULL
;
2256 buildRequestPrefix(&mb
);
2258 debugs(11, 2, "HTTP Server " << serverConnection
);
2259 debugs(11, 2, "HTTP Server REQUEST:\n---------\n" << mb
.buf
<< "\n----------");
2261 Comm::Write(serverConnection
, &mb
, requestSender
);
2266 HttpStateData::getMoreRequestBody(MemBuf
&buf
)
2268 // parent's implementation can handle the no-encoding case
2269 if (!flags
.chunked_request
)
2270 return Client::getMoreRequestBody(buf
);
2274 Must(requestBodySource
!= NULL
);
2275 if (!requestBodySource
->getMoreData(raw
))
2276 return false; // no request body bytes to chunk yet
2278 // optimization: pre-allocate buffer size that should be enough
2279 const mb_size_t rawDataSize
= raw
.contentSize();
2280 // we may need to send: hex-chunk-size CRLF raw-data CRLF last-chunk
2281 buf
.init(16 + 2 + rawDataSize
+ 2 + 5, raw
.max_capacity
);
2283 buf
.appendf("%x\r\n", static_cast<unsigned int>(rawDataSize
));
2284 buf
.append(raw
.content(), rawDataSize
);
2285 buf
.append("\r\n", 2);
2287 Must(rawDataSize
> 0); // we did not accidently created last-chunk above
2289 // Do not send last-chunk unless we successfully received everything
2290 if (receivedWholeRequestBody
) {
2291 Must(!flags
.sentLastChunk
);
2292 flags
.sentLastChunk
= true;
2293 buf
.append("0\r\n\r\n", 5);
2300 httpStart(FwdState
*fwd
)
2302 debugs(11, 3, fwd
->request
->method
<< ' ' << fwd
->entry
->url());
2303 AsyncJob::Start(new HttpStateData(fwd
));
2307 HttpStateData::start()
2309 if (!sendRequest()) {
2310 debugs(11, 3, "httpStart: aborted");
2311 mustStop("HttpStateData::start failed");
2315 ++ statCounter
.server
.all
.requests
;
2316 ++ statCounter
.server
.http
.requests
;
2319 * We used to set the read timeout here, but not any more.
2320 * Now its set in httpSendComplete() after the full request,
2321 * including request body, has been written to the server.
2325 /// if broken posts are enabled for the request, try to fix and return true
2327 HttpStateData::finishingBrokenPost()
2329 #if USE_HTTP_VIOLATIONS
2330 if (!Config
.accessList
.brokenPosts
) {
2331 debugs(11, 5, HERE
<< "No brokenPosts list");
2335 ACLFilledChecklist
ch(Config
.accessList
.brokenPosts
, originalRequest().getRaw());
2336 if (ch
.fastCheck() != ACCESS_ALLOWED
) {
2337 debugs(11, 5, HERE
<< "didn't match brokenPosts");
2341 if (!Comm::IsConnOpen(serverConnection
)) {
2342 debugs(11, 3, HERE
<< "ignoring broken POST for closed " << serverConnection
);
2343 assert(closeHandler
!= NULL
);
2344 return true; // prevent caller from proceeding as if nothing happened
2347 debugs(11, 3, "finishingBrokenPost: fixing broken POST");
2348 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2349 requestSender
= JobCallback(11,5,
2350 Dialer
, this, HttpStateData::wroteLast
);
2351 Comm::Write(serverConnection
, "\r\n", 2, requestSender
, NULL
);
2355 #endif /* USE_HTTP_VIOLATIONS */
2358 /// if needed, write last-chunk to end the request body and return true
2360 HttpStateData::finishingChunkedRequest()
2362 if (flags
.sentLastChunk
) {
2363 debugs(11, 5, HERE
<< "already sent last-chunk");
2367 Must(receivedWholeRequestBody
); // or we should not be sending last-chunk
2368 flags
.sentLastChunk
= true;
2370 typedef CommCbMemFunT
<HttpStateData
, CommIoCbParams
> Dialer
;
2371 requestSender
= JobCallback(11,5, Dialer
, this, HttpStateData::wroteLast
);
2372 Comm::Write(serverConnection
, "0\r\n\r\n", 5, requestSender
, NULL
);
2377 HttpStateData::doneSendingRequestBody()
2379 Client::doneSendingRequestBody();
2380 debugs(11,5, HERE
<< serverConnection
);
2382 // do we need to write something after the last body byte?
2383 if (flags
.chunked_request
&& finishingChunkedRequest())
2385 if (!flags
.chunked_request
&& finishingBrokenPost())
2391 // more origin request body data is available
2393 HttpStateData::handleMoreRequestBodyAvailable()
2395 if (eof
|| !Comm::IsConnOpen(serverConnection
)) {
2396 // XXX: we should check this condition in other callbacks then!
2397 // TODO: Check whether this can actually happen: We should unsubscribe
2398 // as a body consumer when the above condition(s) are detected.
2399 debugs(11, DBG_IMPORTANT
, HERE
<< "Transaction aborted while reading HTTP body");
2403 assert(requestBodySource
!= NULL
);
2405 if (requestBodySource
->buf().hasContent()) {
2406 // XXX: why does not this trigger a debug message on every request?
2408 if (flags
.headers_parsed
&& !flags
.abuse_detected
) {
2409 flags
.abuse_detected
= true;
2410 debugs(11, DBG_IMPORTANT
, "http handleMoreRequestBodyAvailable: Likely proxy abuse detected '" << request
->client_addr
<< "' -> '" << entry
->url() << "'" );
2412 if (virginReply()->sline
.status() == Http::scInvalidHeader
) {
2414 mustStop("HttpStateData::handleMoreRequestBodyAvailable");
2420 HttpStateData::handleMoreRequestBodyAvailable();
2423 // premature end of the request body
2425 HttpStateData::handleRequestBodyProducerAborted()
2427 Client::handleRequestBodyProducerAborted();
2428 if (entry
->isEmpty()) {
2429 debugs(11, 3, "request body aborted: " << serverConnection
);
2430 // We usually get here when ICAP REQMOD aborts during body processing.
2431 // We might also get here if client-side aborts, but then our response
2432 // should not matter because either client-side will provide its own or
2433 // there will be no response at all (e.g., if the the client has left).
2434 ErrorState
*err
= new ErrorState(ERR_ICAP_FAILURE
, Http::scInternalServerError
, fwd
->request
);
2435 err
->detailError(ERR_DETAIL_SRV_REQMOD_REQ_BODY
);
2439 abortTransaction("request body producer aborted");
2442 // called when we wrote request headers(!) or a part of the body
2444 HttpStateData::sentRequestBody(const CommIoCbParams
&io
)
2447 statCounter
.server
.http
.kbytes_out
+= io
.size
;
2449 Client::sentRequestBody(io
);
2453 HttpStateData::abortAll(const char *reason
)
2455 debugs(11,5, HERE
<< "aborting transaction for " << reason
<<
2456 "; " << serverConnection
<< ", this " << this);