]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * Copyright (C) 1996-2016 The Squid Software Foundation and contributors | |
3 | * | |
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. | |
7 | */ | |
8 | ||
9 | /* DEBUG: section 11 Hypertext Transfer Protocol (HTTP) */ | |
10 | ||
11 | /* | |
12 | * Anonymizing patch by lutz@as-node.jena.thur.de | |
13 | * have a look into http-anon.c to get more informations. | |
14 | */ | |
15 | ||
16 | #include "squid.h" | |
17 | #include "acl/FilledChecklist.h" | |
18 | #include "base/AsyncJobCalls.h" | |
19 | #include "base/TextException.h" | |
20 | #include "base64.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" | |
26 | #include "CommRead.h" | |
27 | #include "err_detail_type.h" | |
28 | #include "errorpage.h" | |
29 | #include "fd.h" | |
30 | #include "fde.h" | |
31 | #include "globals.h" | |
32 | #include "http.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" | |
45 | #include "MemBuf.h" | |
46 | #include "MemObject.h" | |
47 | #include "neighbors.h" | |
48 | #include "peer_proxy_negotiate_auth.h" | |
49 | #include "profiler/Profiler.h" | |
50 | #include "refresh.h" | |
51 | #include "RefreshPattern.h" | |
52 | #include "rfc1738.h" | |
53 | #include "SquidConfig.h" | |
54 | #include "SquidTime.h" | |
55 | #include "StatCounters.h" | |
56 | #include "Store.h" | |
57 | #include "StrList.h" | |
58 | #include "tools.h" | |
59 | #include "URL.h" | |
60 | #include "util.h" | |
61 | ||
62 | #if USE_AUTH | |
63 | #include "auth/UserRequest.h" | |
64 | #endif | |
65 | #if USE_DELAY_POOLS | |
66 | #include "DelayPools.h" | |
67 | #endif | |
68 | ||
69 | #define SQUID_ENTER_THROWING_CODE() try { | |
70 | #define SQUID_EXIT_THROWING_CODE(status) \ | |
71 | status = true; \ | |
72 | } \ | |
73 | catch (const std::exception &e) { \ | |
74 | debugs (11, 1, "Exception error:" << e.what()); \ | |
75 | status = false; \ | |
76 | } | |
77 | ||
78 | CBDATA_CLASS_INIT(HttpStateData); | |
79 | ||
80 | static const char *const crlf = "\r\n"; | |
81 | ||
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 &); | |
85 | ||
86 | HttpStateData::HttpStateData(FwdState *theFwdState) : | |
87 | AsyncJob("HttpStateData"), | |
88 | Client(theFwdState), | |
89 | lastChunk(0), | |
90 | httpChunkDecoder(NULL), | |
91 | payloadSeen(0), | |
92 | payloadTruncated(0), | |
93 | sawDateGoBack(false) | |
94 | { | |
95 | debugs(11,5,HERE << "HttpStateData " << this << " created"); | |
96 | ignoreCacheControl = false; | |
97 | surrogateNoStore = false; | |
98 | serverConnection = fwd->serverConnection(); | |
99 | ||
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; | |
103 | ||
104 | if (fwd->serverConnection() != NULL) | |
105 | _peer = cbdataReference(fwd->serverConnection()->getPeer()); /* might be NULL */ | |
106 | ||
107 | if (_peer) { | |
108 | request->flags.proxying = true; | |
109 | /* | |
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. | |
113 | */ | |
114 | if (_peer->options.proxy_only) | |
115 | entry->releaseRequest(); | |
116 | ||
117 | #if USE_DELAY_POOLS | |
118 | entry->setNoDelay(_peer->options.no_delay); | |
119 | #endif | |
120 | } | |
121 | ||
122 | /* | |
123 | * register the handler to free HTTP state data when the FD closes | |
124 | */ | |
125 | typedef CommCbMemFunT<HttpStateData, CommCloseCbParams> Dialer; | |
126 | closeHandler = JobCallback(9, 5, Dialer, this, HttpStateData::httpStateConnClosed); | |
127 | comm_add_close_handler(serverConnection->fd, closeHandler); | |
128 | } | |
129 | ||
130 | HttpStateData::~HttpStateData() | |
131 | { | |
132 | /* | |
133 | * don't forget that ~Client() gets called automatically | |
134 | */ | |
135 | ||
136 | if (httpChunkDecoder) | |
137 | delete httpChunkDecoder; | |
138 | ||
139 | cbdataReferenceDone(_peer); | |
140 | ||
141 | debugs(11,5, HERE << "HttpStateData " << this << " destroyed; " << serverConnection); | |
142 | } | |
143 | ||
144 | const Comm::ConnectionPointer & | |
145 | HttpStateData::dataConnection() const | |
146 | { | |
147 | return serverConnection; | |
148 | } | |
149 | ||
150 | void | |
151 | HttpStateData::httpStateConnClosed(const CommCloseCbParams ¶ms) | |
152 | { | |
153 | debugs(11, 5, "httpStateFree: FD " << params.fd << ", httpState=" << params.data); | |
154 | doneWithFwd = "httpStateConnClosed()"; // assume FwdState is monitoring too | |
155 | mustStop("HttpStateData::httpStateConnClosed"); | |
156 | } | |
157 | ||
158 | void | |
159 | HttpStateData::httpTimeout(const CommTimeoutCbParams &) | |
160 | { | |
161 | debugs(11, 4, serverConnection << ": '" << entry->url() << "'"); | |
162 | ||
163 | if (entry->store_status == STORE_PENDING) { | |
164 | fwd->fail(new ErrorState(ERR_READ_TIMEOUT, Http::scGatewayTimeout, fwd->request)); | |
165 | } | |
166 | ||
167 | closeServer(); | |
168 | mustStop("HttpStateData::httpTimeout"); | |
169 | } | |
170 | ||
171 | static StoreEntry * | |
172 | findPreviouslyCachedEntry(StoreEntry *newEntry) { | |
173 | assert(newEntry->mem_obj); | |
174 | return newEntry->mem_obj->request ? | |
175 | storeGetPublicByRequest(newEntry->mem_obj->request) : | |
176 | storeGetPublic(newEntry->mem_obj->storeId(), newEntry->mem_obj->method); | |
177 | } | |
178 | ||
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. | |
181 | static void | |
182 | httpMaybeRemovePublic(StoreEntry * e, Http::StatusCode status) | |
183 | { | |
184 | int remove = 0; | |
185 | int forbidden = 0; | |
186 | ||
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)) | |
190 | return; | |
191 | ||
192 | switch (status) { | |
193 | ||
194 | case Http::scOkay: | |
195 | ||
196 | case Http::scNonAuthoritativeInformation: | |
197 | ||
198 | case Http::scMultipleChoices: | |
199 | ||
200 | case Http::scMovedPermanently: | |
201 | ||
202 | case Http::scFound: | |
203 | ||
204 | case Http::scSeeOther: | |
205 | ||
206 | case Http::scGone: | |
207 | ||
208 | case Http::scNotFound: | |
209 | remove = 1; | |
210 | ||
211 | break; | |
212 | ||
213 | case Http::scForbidden: | |
214 | ||
215 | case Http::scMethodNotAllowed: | |
216 | forbidden = 1; | |
217 | ||
218 | break; | |
219 | ||
220 | #if WORK_IN_PROGRESS | |
221 | ||
222 | case Http::scUnauthorized: | |
223 | forbidden = 1; | |
224 | ||
225 | break; | |
226 | ||
227 | #endif | |
228 | ||
229 | default: | |
230 | #if QUESTIONABLE | |
231 | /* | |
232 | * Any 2xx response should eject previously cached entities... | |
233 | */ | |
234 | ||
235 | if (status >= 200 && status < 300) | |
236 | remove = 1; | |
237 | ||
238 | #endif | |
239 | ||
240 | break; | |
241 | } | |
242 | ||
243 | if (!remove && !forbidden) | |
244 | return; | |
245 | ||
246 | StoreEntry *pe = findPreviouslyCachedEntry(e); | |
247 | ||
248 | if (pe != NULL) { | |
249 | assert(e != pe); | |
250 | #if USE_HTCP | |
251 | neighborsHtcpClear(e, NULL, e->mem_obj->request, e->mem_obj->method, HTCP_CLR_INVALIDATION); | |
252 | #endif | |
253 | pe->release(); | |
254 | } | |
255 | ||
256 | /** \par | |
257 | * Also remove any cached HEAD response in case the object has | |
258 | * changed. | |
259 | */ | |
260 | if (e->mem_obj->request) | |
261 | pe = storeGetPublicByRequestMethod(e->mem_obj->request, Http::METHOD_HEAD); | |
262 | else | |
263 | pe = storeGetPublic(e->mem_obj->storeId(), Http::METHOD_HEAD); | |
264 | ||
265 | if (pe != NULL) { | |
266 | assert(e != pe); | |
267 | #if USE_HTCP | |
268 | neighborsHtcpClear(e, NULL, e->mem_obj->request, HttpRequestMethod(Http::METHOD_HEAD), HTCP_CLR_INVALIDATION); | |
269 | #endif | |
270 | pe->release(); | |
271 | } | |
272 | } | |
273 | ||
274 | void | |
275 | HttpStateData::processSurrogateControl(HttpReply *reply) | |
276 | { | |
277 | if (request->flags.accelerated && reply->surrogate_control) { | |
278 | HttpHdrScTarget *sctusable = reply->surrogate_control->getMergedTarget(Config.Accel.surrogate_id); | |
279 | ||
280 | if (sctusable) { | |
281 | if (sctusable->noStore() || | |
282 | (Config.onoff.surrogate_is_remote | |
283 | && sctusable->noStoreRemote())) { | |
284 | surrogateNoStore = true; | |
285 | entry->makePrivate(); | |
286 | } | |
287 | ||
288 | /* The HttpHeader logic cannot tell if the header it's parsing is a reply to an | |
289 | * accelerated request or not... | |
290 | * Still, this is an abstraction breach. - RC | |
291 | */ | |
292 | if (sctusable->hasMaxAge()) { | |
293 | if (sctusable->maxAge() < sctusable->maxStale()) | |
294 | reply->expires = reply->date + sctusable->maxAge(); | |
295 | else | |
296 | reply->expires = reply->date + sctusable->maxStale(); | |
297 | ||
298 | /* And update the timestamps */ | |
299 | entry->timestampsSet(); | |
300 | } | |
301 | ||
302 | /* We ignore cache-control directives as per the Surrogate specification */ | |
303 | ignoreCacheControl = true; | |
304 | ||
305 | delete sctusable; | |
306 | } | |
307 | } | |
308 | } | |
309 | ||
310 | int | |
311 | HttpStateData::cacheableReply() | |
312 | { | |
313 | HttpReply const *rep = finalReply(); | |
314 | HttpHeader const *hdr = &rep->header; | |
315 | const char *v; | |
316 | #if USE_HTTP_VIOLATIONS | |
317 | ||
318 | const RefreshPattern *R = NULL; | |
319 | ||
320 | /* This strange looking define first looks up the refresh pattern | |
321 | * and then checks if the specified flag is set. The main purpose | |
322 | * of this is to simplify the refresh pattern lookup and USE_HTTP_VIOLATIONS | |
323 | * condition | |
324 | */ | |
325 | #define REFRESH_OVERRIDE(flag) \ | |
326 | ((R = (R ? R : refreshLimits(entry->mem_obj->storeId()))) , \ | |
327 | (R && R->flags.flag)) | |
328 | #else | |
329 | #define REFRESH_OVERRIDE(flag) 0 | |
330 | #endif | |
331 | ||
332 | if (EBIT_TEST(entry->flags, RELEASE_REQUEST)) { | |
333 | debugs(22, 3, "NO because " << *entry << " has been released."); | |
334 | return 0; | |
335 | } | |
336 | ||
337 | // RFC 7234 section 4: a cache MUST use the most recent response | |
338 | // (as determined by the Date header field) | |
339 | if (sawDateGoBack) { | |
340 | debugs(22, 3, "NO because " << *entry << " has an older date header."); | |
341 | return 0; | |
342 | } | |
343 | ||
344 | // Check for Surrogate/1.0 protocol conditions | |
345 | // NP: reverse-proxy traffic our parent server has instructed us never to cache | |
346 | if (surrogateNoStore) { | |
347 | debugs(22, 3, HERE << "NO because Surrogate-Control:no-store"); | |
348 | return 0; | |
349 | } | |
350 | ||
351 | // RFC 2616: HTTP/1.1 Cache-Control conditions | |
352 | if (!ignoreCacheControl) { | |
353 | // XXX: check to see if the request headers alone were enough to prevent caching earlier | |
354 | // (ie no-store request header) no need to check those all again here if so. | |
355 | // for now we are not reliably doing that so we waste CPU re-checking request CC | |
356 | ||
357 | // RFC 2616 section 14.9.2 - MUST NOT cache any response with request CC:no-store | |
358 | if (request && request->cache_control && request->cache_control->noStore() && | |
359 | !REFRESH_OVERRIDE(ignore_no_store)) { | |
360 | debugs(22, 3, HERE << "NO because client request Cache-Control:no-store"); | |
361 | return 0; | |
362 | } | |
363 | ||
364 | // NP: request CC:no-cache only means cache READ is forbidden. STORE is permitted. | |
365 | if (rep->cache_control && rep->cache_control->hasNoCache() && rep->cache_control->noCache().size() > 0) { | |
366 | /* TODO: we are allowed to cache when no-cache= has parameters. | |
367 | * Provided we strip away any of the listed headers unless they are revalidated | |
368 | * successfully (ie, must revalidate AND these headers are prohibited on stale replies). | |
369 | * That is a bit tricky for squid right now so we avoid caching entirely. | |
370 | */ | |
371 | debugs(22, 3, HERE << "NO because server reply Cache-Control:no-cache has parameters"); | |
372 | return 0; | |
373 | } | |
374 | ||
375 | // NP: request CC:private is undefined. We ignore. | |
376 | // NP: other request CC flags are limiters on HIT/MISS. We don't care about here. | |
377 | ||
378 | // RFC 2616 section 14.9.2 - MUST NOT cache any response with CC:no-store | |
379 | if (rep->cache_control && rep->cache_control->noStore() && | |
380 | !REFRESH_OVERRIDE(ignore_no_store)) { | |
381 | debugs(22, 3, HERE << "NO because server reply Cache-Control:no-store"); | |
382 | return 0; | |
383 | } | |
384 | ||
385 | // RFC 2616 section 14.9.1 - MUST NOT cache any response with CC:private in a shared cache like Squid. | |
386 | // CC:private overrides CC:public when both are present in a response. | |
387 | // TODO: add a shared/private cache configuration possibility. | |
388 | if (rep->cache_control && | |
389 | rep->cache_control->hasPrivate() && | |
390 | !REFRESH_OVERRIDE(ignore_private)) { | |
391 | /* TODO: we are allowed to cache when private= has parameters. | |
392 | * Provided we strip away any of the listed headers unless they are revalidated | |
393 | * successfully (ie, must revalidate AND these headers are prohibited on stale replies). | |
394 | * That is a bit tricky for squid right now so we avoid caching entirely. | |
395 | */ | |
396 | debugs(22, 3, HERE << "NO because server reply Cache-Control:private"); | |
397 | return 0; | |
398 | } | |
399 | } | |
400 | ||
401 | // RFC 2068, sec 14.9.4 - MUST NOT cache any response with Authentication UNLESS certain CC controls are present | |
402 | // allow HTTP violations to IGNORE those controls (ie re-block caching Auth) | |
403 | if (request && (request->flags.auth || request->flags.authSent)) { | |
404 | if (!rep->cache_control) { | |
405 | debugs(22, 3, HERE << "NO because Authenticated and server reply missing Cache-Control"); | |
406 | return 0; | |
407 | } | |
408 | ||
409 | if (ignoreCacheControl) { | |
410 | debugs(22, 3, HERE << "NO because Authenticated and ignoring Cache-Control"); | |
411 | return 0; | |
412 | } | |
413 | ||
414 | bool mayStore = false; | |
415 | // HTTPbis pt6 section 3.2: a response CC:public is present | |
416 | if (rep->cache_control->Public()) { | |
417 | debugs(22, 3, HERE << "Authenticated but server reply Cache-Control:public"); | |
418 | mayStore = true; | |
419 | ||
420 | // HTTPbis pt6 section 3.2: a response CC:must-revalidate is present | |
421 | } else if (rep->cache_control->mustRevalidate()) { | |
422 | debugs(22, 3, HERE << "Authenticated but server reply Cache-Control:must-revalidate"); | |
423 | mayStore = true; | |
424 | ||
425 | #if USE_HTTP_VIOLATIONS | |
426 | // NP: given the must-revalidate exception we should also be able to exempt no-cache. | |
427 | // HTTPbis WG verdict on this is that it is omitted from the spec due to being 'unexpected' by | |
428 | // some. The caching+revalidate is not exactly unsafe though with Squids interpretation of no-cache | |
429 | // (without parameters) as equivalent to must-revalidate in the reply. | |
430 | } else if (rep->cache_control->hasNoCache() && rep->cache_control->noCache().size() == 0) { | |
431 | debugs(22, 3, HERE << "Authenticated but server reply Cache-Control:no-cache (equivalent to must-revalidate)"); | |
432 | mayStore = true; | |
433 | #endif | |
434 | ||
435 | // HTTPbis pt6 section 3.2: a response CC:s-maxage is present | |
436 | } else if (rep->cache_control->sMaxAge()) { | |
437 | debugs(22, 3, HERE << "Authenticated but server reply Cache-Control:s-maxage"); | |
438 | mayStore = true; | |
439 | } | |
440 | ||
441 | if (!mayStore) { | |
442 | debugs(22, 3, HERE << "NO because Authenticated transaction"); | |
443 | return 0; | |
444 | } | |
445 | ||
446 | // NP: response CC:no-cache is equivalent to CC:must-revalidate,max-age=0. We MAY cache, and do so. | |
447 | // NP: other request CC flags are limiters on HIT/MISS/REFRESH. We don't care about here. | |
448 | } | |
449 | ||
450 | /* HACK: The "multipart/x-mixed-replace" content type is used for | |
451 | * continuous push replies. These are generally dynamic and | |
452 | * probably should not be cachable | |
453 | */ | |
454 | if ((v = hdr->getStr(Http::HdrType::CONTENT_TYPE))) | |
455 | if (!strncasecmp(v, "multipart/x-mixed-replace", 25)) { | |
456 | debugs(22, 3, HERE << "NO because Content-Type:multipart/x-mixed-replace"); | |
457 | return 0; | |
458 | } | |
459 | ||
460 | switch (rep->sline.status()) { | |
461 | /* Responses that are cacheable */ | |
462 | ||
463 | case Http::scOkay: | |
464 | ||
465 | case Http::scNonAuthoritativeInformation: | |
466 | ||
467 | case Http::scMultipleChoices: | |
468 | ||
469 | case Http::scMovedPermanently: | |
470 | case Http::scPermanentRedirect: | |
471 | ||
472 | case Http::scGone: | |
473 | /* | |
474 | * Don't cache objects that need to be refreshed on next request, | |
475 | * unless we know how to refresh it. | |
476 | */ | |
477 | ||
478 | if (!refreshIsCachable(entry) && !REFRESH_OVERRIDE(store_stale)) { | |
479 | debugs(22, 3, "NO because refreshIsCachable() returned non-cacheable.."); | |
480 | return 0; | |
481 | } else { | |
482 | debugs(22, 3, HERE << "YES because HTTP status " << rep->sline.status()); | |
483 | return 1; | |
484 | } | |
485 | /* NOTREACHED */ | |
486 | break; | |
487 | ||
488 | /* Responses that only are cacheable if the server says so */ | |
489 | ||
490 | case Http::scFound: | |
491 | case Http::scTemporaryRedirect: | |
492 | if (rep->date <= 0) { | |
493 | debugs(22, 3, HERE << "NO because HTTP status " << rep->sline.status() << " and Date missing/invalid"); | |
494 | return 0; | |
495 | } | |
496 | if (rep->expires > rep->date) { | |
497 | debugs(22, 3, HERE << "YES because HTTP status " << rep->sline.status() << " and Expires > Date"); | |
498 | return 1; | |
499 | } else { | |
500 | debugs(22, 3, HERE << "NO because HTTP status " << rep->sline.status() << " and Expires <= Date"); | |
501 | return 0; | |
502 | } | |
503 | /* NOTREACHED */ | |
504 | break; | |
505 | ||
506 | /* Errors can be negatively cached */ | |
507 | ||
508 | case Http::scNoContent: | |
509 | ||
510 | case Http::scUseProxy: | |
511 | ||
512 | case Http::scBadRequest: | |
513 | ||
514 | case Http::scForbidden: | |
515 | ||
516 | case Http::scNotFound: | |
517 | ||
518 | case Http::scMethodNotAllowed: | |
519 | ||
520 | case Http::scUriTooLong: | |
521 | ||
522 | case Http::scInternalServerError: | |
523 | ||
524 | case Http::scNotImplemented: | |
525 | ||
526 | case Http::scBadGateway: | |
527 | ||
528 | case Http::scServiceUnavailable: | |
529 | ||
530 | case Http::scGatewayTimeout: | |
531 | case Http::scMisdirectedRequest: | |
532 | ||
533 | debugs(22, 3, "MAYBE because HTTP status " << rep->sline.status()); | |
534 | return -1; | |
535 | ||
536 | /* NOTREACHED */ | |
537 | break; | |
538 | ||
539 | /* Some responses can never be cached */ | |
540 | ||
541 | case Http::scPartialContent: /* Not yet supported */ | |
542 | ||
543 | case Http::scSeeOther: | |
544 | ||
545 | case Http::scNotModified: | |
546 | ||
547 | case Http::scUnauthorized: | |
548 | ||
549 | case Http::scProxyAuthenticationRequired: | |
550 | ||
551 | case Http::scInvalidHeader: /* Squid header parsing error */ | |
552 | ||
553 | case Http::scHeaderTooLarge: | |
554 | ||
555 | case Http::scPaymentRequired: | |
556 | case Http::scNotAcceptable: | |
557 | case Http::scRequestTimeout: | |
558 | case Http::scConflict: | |
559 | case Http::scLengthRequired: | |
560 | case Http::scPreconditionFailed: | |
561 | case Http::scPayloadTooLarge: | |
562 | case Http::scUnsupportedMediaType: | |
563 | case Http::scUnprocessableEntity: | |
564 | case Http::scLocked: | |
565 | case Http::scFailedDependency: | |
566 | case Http::scInsufficientStorage: | |
567 | case Http::scRequestedRangeNotSatisfied: | |
568 | case Http::scExpectationFailed: | |
569 | ||
570 | debugs(22, 3, HERE << "NO because HTTP status " << rep->sline.status()); | |
571 | return 0; | |
572 | ||
573 | default: | |
574 | /* RFC 2616 section 6.1.1: an unrecognized response MUST NOT be cached. */ | |
575 | debugs (11, 3, HERE << "NO because unknown HTTP status code " << rep->sline.status()); | |
576 | return 0; | |
577 | ||
578 | /* NOTREACHED */ | |
579 | break; | |
580 | } | |
581 | ||
582 | /* NOTREACHED */ | |
583 | } | |
584 | ||
585 | /// assemble a variant key (vary-mark) from the given Vary header and HTTP request | |
586 | static void | |
587 | assembleVaryKey(String &vary, SBuf &vstr, const HttpRequest &request) | |
588 | { | |
589 | static const SBuf asterisk("*"); | |
590 | const char *pos = nullptr; | |
591 | const char *item = nullptr; | |
592 | int ilen = 0; | |
593 | ||
594 | while (strListGetItem(&vary, ',', &item, &ilen, &pos)) { | |
595 | SBuf name(item, ilen); | |
596 | if (name == asterisk) { | |
597 | vstr = asterisk; | |
598 | break; | |
599 | } | |
600 | name.toLower(); | |
601 | if (!vstr.isEmpty()) | |
602 | vstr.append(", ", 2); | |
603 | vstr.append(name); | |
604 | String hdr(request.header.getByName(name)); | |
605 | const char *value = hdr.termedBuf(); | |
606 | if (value) { | |
607 | value = rfc1738_escape_part(value); | |
608 | vstr.append("=\"", 2); | |
609 | vstr.append(value); | |
610 | vstr.append("\"", 1); | |
611 | } | |
612 | ||
613 | hdr.clean(); | |
614 | } | |
615 | } | |
616 | ||
617 | /* | |
618 | * For Vary, store the relevant request headers as | |
619 | * virtual headers in the reply | |
620 | * Returns an empty SBuf if the variance cannot be stored | |
621 | */ | |
622 | SBuf | |
623 | httpMakeVaryMark(HttpRequest * request, HttpReply const * reply) | |
624 | { | |
625 | SBuf vstr; | |
626 | String vary; | |
627 | ||
628 | vary = reply->header.getList(Http::HdrType::VARY); | |
629 | assembleVaryKey(vary, vstr, *request); | |
630 | ||
631 | #if X_ACCELERATOR_VARY | |
632 | vary.clean(); | |
633 | vary = reply->header.getList(Http::HdrType::HDR_X_ACCELERATOR_VARY); | |
634 | assembleVaryKey(vary, vstr, *request); | |
635 | #endif | |
636 | ||
637 | debugs(11, 3, vstr); | |
638 | return vstr; | |
639 | } | |
640 | ||
641 | void | |
642 | HttpStateData::keepaliveAccounting(HttpReply *reply) | |
643 | { | |
644 | if (flags.keepalive) | |
645 | if (_peer) | |
646 | ++ _peer->stats.n_keepalives_sent; | |
647 | ||
648 | if (reply->keep_alive) { | |
649 | if (_peer) | |
650 | ++ _peer->stats.n_keepalives_recv; | |
651 | ||
652 | if (Config.onoff.detect_broken_server_pconns | |
653 | && reply->bodySize(request->method) == -1 && !flags.chunked) { | |
654 | debugs(11, DBG_IMPORTANT, "keepaliveAccounting: Impossible keep-alive header from '" << entry->url() << "'" ); | |
655 | // debugs(11, 2, "GOT HTTP REPLY HDR:\n---------\n" << readBuf->content() << "\n----------" ); | |
656 | flags.keepalive_broken = true; | |
657 | } | |
658 | } | |
659 | } | |
660 | ||
661 | void | |
662 | HttpStateData::checkDateSkew(HttpReply *reply) | |
663 | { | |
664 | if (reply->date > -1 && !_peer) { | |
665 | int skew = abs((int)(reply->date - squid_curtime)); | |
666 | ||
667 | if (skew > 86400) | |
668 | debugs(11, 3, "" << request->url.host() << "'s clock is skewed by " << skew << " seconds!"); | |
669 | } | |
670 | } | |
671 | ||
672 | /** | |
673 | * This creates the error page itself.. its likely | |
674 | * that the forward ported reply header max size patch | |
675 | * generates non http conformant error pages - in which | |
676 | * case the errors where should be 'BAD_GATEWAY' etc | |
677 | */ | |
678 | void | |
679 | HttpStateData::processReplyHeader() | |
680 | { | |
681 | /** Creates a blank header. If this routine is made incremental, this will not do */ | |
682 | ||
683 | /* NP: all exit points to this function MUST call ctx_exit(ctx) */ | |
684 | Ctx ctx = ctx_enter(entry->mem_obj->urlXXX()); | |
685 | ||
686 | debugs(11, 3, "processReplyHeader: key '" << entry->getMD5Text() << "'"); | |
687 | ||
688 | assert(!flags.headers_parsed); | |
689 | ||
690 | if (!inBuf.length()) { | |
691 | ctx_exit(ctx); | |
692 | return; | |
693 | } | |
694 | ||
695 | /* Attempt to parse the first line; this will define where the protocol, status, reason-phrase and header begin */ | |
696 | { | |
697 | if (hp == NULL) | |
698 | hp = new Http1::ResponseParser; | |
699 | ||
700 | bool parsedOk = hp->parse(inBuf); | |
701 | ||
702 | // sync the buffers after parsing. | |
703 | inBuf = hp->remaining(); | |
704 | ||
705 | if (hp->needsMoreData()) { | |
706 | if (eof) { // no more data coming | |
707 | /* Bug 2879: Replies may terminate with \r\n then EOF instead of \r\n\r\n. | |
708 | * We also may receive truncated responses. | |
709 | * Ensure here that we have at minimum two \r\n when EOF is seen. | |
710 | */ | |
711 | inBuf.append("\r\n\r\n", 4); | |
712 | // retry the parse | |
713 | parsedOk = hp->parse(inBuf); | |
714 | // sync the buffers after parsing. | |
715 | inBuf = hp->remaining(); | |
716 | } else { | |
717 | debugs(33, 5, "Incomplete response, waiting for end of response headers"); | |
718 | ctx_exit(ctx); | |
719 | return; | |
720 | } | |
721 | } | |
722 | ||
723 | if (!parsedOk) { | |
724 | // unrecoverable parsing error | |
725 | // TODO: Use Raw! XXX: inBuf no longer has the [beginning of the] malformed header. | |
726 | debugs(11, 3, "Non-HTTP-compliant header:\n---------\n" << inBuf << "\n----------"); | |
727 | flags.headers_parsed = true; | |
728 | HttpReply *newrep = new HttpReply; | |
729 | newrep->sline.set(Http::ProtocolVersion(), hp->parseStatusCode); | |
730 | setVirginReply(newrep); | |
731 | ctx_exit(ctx); | |
732 | return; | |
733 | } | |
734 | } | |
735 | ||
736 | /* We know the whole response is in parser now */ | |
737 | debugs(11, 2, "HTTP Server " << serverConnection); | |
738 | debugs(11, 2, "HTTP Server RESPONSE:\n---------\n" << | |
739 | hp->messageProtocol() << " " << hp->messageStatus() << " " << hp->reasonPhrase() << "\n" << | |
740 | hp->mimeHeader() << | |
741 | "----------"); | |
742 | ||
743 | // reset payload tracking to begin after message headers | |
744 | payloadSeen = inBuf.length(); | |
745 | ||
746 | HttpReply *newrep = new HttpReply; | |
747 | // XXX: RFC 7230 indicates we MAY ignore the reason phrase, | |
748 | // and use an empty string on unknown status. | |
749 | // We do that now to avoid performance regression from using SBuf::c_str() | |
750 | newrep->sline.set(Http::ProtocolVersion(1,1), hp->messageStatus() /* , hp->reasonPhrase() */); | |
751 | newrep->sline.protocol = newrep->sline.version.protocol = hp->messageProtocol().protocol; | |
752 | newrep->sline.version.major = hp->messageProtocol().major; | |
753 | newrep->sline.version.minor = hp->messageProtocol().minor; | |
754 | ||
755 | // parse headers | |
756 | if (!newrep->parseHeader(*hp)) { | |
757 | // XXX: when Http::ProtocolVersion is a function, remove this hack. just set with messageProtocol() | |
758 | newrep->sline.set(Http::ProtocolVersion(), Http::scInvalidHeader); | |
759 | newrep->sline.version.protocol = hp->messageProtocol().protocol; | |
760 | newrep->sline.version.major = hp->messageProtocol().major; | |
761 | newrep->sline.version.minor = hp->messageProtocol().minor; | |
762 | debugs(11, 2, "error parsing response headers mime block"); | |
763 | } | |
764 | ||
765 | // done with Parser, now process using the HttpReply | |
766 | hp = NULL; | |
767 | ||
768 | newrep->sources |= request->url.getScheme() == AnyP::PROTO_HTTPS ? HttpMsg::srcHttps : HttpMsg::srcHttp; | |
769 | ||
770 | newrep->removeStaleWarnings(); | |
771 | ||
772 | if (newrep->sline.protocol == AnyP::PROTO_HTTP && newrep->sline.status() >= 100 && newrep->sline.status() < 200) { | |
773 | handle1xx(newrep); | |
774 | ctx_exit(ctx); | |
775 | return; | |
776 | } | |
777 | ||
778 | flags.chunked = false; | |
779 | if (newrep->sline.protocol == AnyP::PROTO_HTTP && newrep->header.chunked()) { | |
780 | flags.chunked = true; | |
781 | httpChunkDecoder = new Http1::TeChunkedParser; | |
782 | } | |
783 | ||
784 | if (!peerSupportsConnectionPinning()) | |
785 | request->flags.connectionAuthDisabled = true; | |
786 | ||
787 | HttpReply *vrep = setVirginReply(newrep); | |
788 | flags.headers_parsed = true; | |
789 | ||
790 | keepaliveAccounting(vrep); | |
791 | ||
792 | checkDateSkew(vrep); | |
793 | ||
794 | processSurrogateControl (vrep); | |
795 | ||
796 | request->hier.peer_reply_status = newrep->sline.status(); | |
797 | ||
798 | ctx_exit(ctx); | |
799 | } | |
800 | ||
801 | /// ignore or start forwarding the 1xx response (a.k.a., control message) | |
802 | void | |
803 | HttpStateData::handle1xx(HttpReply *reply) | |
804 | { | |
805 | HttpReply::Pointer msg(reply); // will destroy reply if unused | |
806 | ||
807 | // one 1xx at a time: we must not be called while waiting for previous 1xx | |
808 | Must(!flags.handling1xx); | |
809 | flags.handling1xx = true; | |
810 | ||
811 | if (!request->canHandle1xx() || request->forcedBodyContinuation) { | |
812 | debugs(11, 2, "ignoring 1xx because it is " << (request->forcedBodyContinuation ? "already sent" : "not supported by client")); | |
813 | proceedAfter1xx(); | |
814 | return; | |
815 | } | |
816 | ||
817 | #if USE_HTTP_VIOLATIONS | |
818 | // check whether the 1xx response forwarding is allowed by squid.conf | |
819 | if (Config.accessList.reply) { | |
820 | ACLFilledChecklist ch(Config.accessList.reply, originalRequest(), NULL); | |
821 | ch.reply = reply; | |
822 | HTTPMSGLOCK(ch.reply); | |
823 | if (ch.fastCheck() != ACCESS_ALLOWED) { // TODO: support slow lookups? | |
824 | debugs(11, 3, HERE << "ignoring denied 1xx"); | |
825 | proceedAfter1xx(); | |
826 | return; | |
827 | } | |
828 | } | |
829 | #endif // USE_HTTP_VIOLATIONS | |
830 | ||
831 | debugs(11, 2, HERE << "forwarding 1xx to client"); | |
832 | ||
833 | // the Sink will use this to call us back after writing 1xx to the client | |
834 | typedef NullaryMemFunT<HttpStateData> CbDialer; | |
835 | const AsyncCall::Pointer cb = JobCallback(11, 3, CbDialer, this, | |
836 | HttpStateData::proceedAfter1xx); | |
837 | CallJobHere1(11, 4, request->clientConnectionManager, ConnStateData, | |
838 | ConnStateData::sendControlMsg, HttpControlMsg(msg, cb)); | |
839 | // If the call is not fired, then the Sink is gone, and HttpStateData | |
840 | // will terminate due to an aborted store entry or another similar error. | |
841 | // If we get stuck, it is not handle1xx fault if we could get stuck | |
842 | // for similar reasons without a 1xx response. | |
843 | } | |
844 | ||
845 | /// restores state and resumes processing after 1xx is ignored or forwarded | |
846 | void | |
847 | HttpStateData::proceedAfter1xx() | |
848 | { | |
849 | Must(flags.handling1xx); | |
850 | debugs(11, 2, "continuing with " << payloadSeen << " bytes in buffer after 1xx"); | |
851 | CallJobHere(11, 3, this, HttpStateData, HttpStateData::processReply); | |
852 | } | |
853 | ||
854 | /** | |
855 | * returns true if the peer can support connection pinning | |
856 | */ | |
857 | bool HttpStateData::peerSupportsConnectionPinning() const | |
858 | { | |
859 | const HttpReply *rep = entry->mem_obj->getReply(); | |
860 | const HttpHeader *hdr = &rep->header; | |
861 | bool rc; | |
862 | String header; | |
863 | ||
864 | if (!_peer) | |
865 | return true; | |
866 | ||
867 | /*If this peer does not support connection pinning (authenticated | |
868 | connections) return false | |
869 | */ | |
870 | if (!_peer->connection_auth) | |
871 | return false; | |
872 | ||
873 | /*The peer supports connection pinning and the http reply status | |
874 | is not unauthorized, so the related connection can be pinned | |
875 | */ | |
876 | if (rep->sline.status() != Http::scUnauthorized) | |
877 | return true; | |
878 | ||
879 | /*The server respond with Http::scUnauthorized and the peer configured | |
880 | with "connection-auth=on" we know that the peer supports pinned | |
881 | connections | |
882 | */ | |
883 | if (_peer->connection_auth == 1) | |
884 | return true; | |
885 | ||
886 | /*At this point peer has configured with "connection-auth=auto" | |
887 | parameter so we need some extra checks to decide if we are going | |
888 | to allow pinned connections or not | |
889 | */ | |
890 | ||
891 | /*if the peer configured with originserver just allow connection | |
892 | pinning (squid 2.6 behaviour) | |
893 | */ | |
894 | if (_peer->options.originserver) | |
895 | return true; | |
896 | ||
897 | /*if the connections it is already pinned it is OK*/ | |
898 | if (request->flags.pinned) | |
899 | return true; | |
900 | ||
901 | /*Allow pinned connections only if the Proxy-support header exists in | |
902 | reply and has in its list the "Session-Based-Authentication" | |
903 | which means that the peer supports connection pinning. | |
904 | */ | |
905 | if (!hdr->has(Http::HdrType::PROXY_SUPPORT)) | |
906 | return false; | |
907 | ||
908 | header = hdr->getStrOrList(Http::HdrType::PROXY_SUPPORT); | |
909 | /* XXX This ought to be done in a case-insensitive manner */ | |
910 | rc = (strstr(header.termedBuf(), "Session-Based-Authentication") != NULL); | |
911 | ||
912 | return rc; | |
913 | } | |
914 | ||
915 | // Called when we parsed (and possibly adapted) the headers but | |
916 | // had not starting storing (a.k.a., sending) the body yet. | |
917 | void | |
918 | HttpStateData::haveParsedReplyHeaders() | |
919 | { | |
920 | Client::haveParsedReplyHeaders(); | |
921 | ||
922 | Ctx ctx = ctx_enter(entry->mem_obj->urlXXX()); | |
923 | HttpReply *rep = finalReply(); | |
924 | ||
925 | entry->timestampsSet(); | |
926 | ||
927 | /* Check if object is cacheable or not based on reply code */ | |
928 | debugs(11, 3, "HTTP CODE: " << rep->sline.status()); | |
929 | ||
930 | if (const StoreEntry *oldEntry = findPreviouslyCachedEntry(entry)) | |
931 | sawDateGoBack = rep->olderThan(oldEntry->getReply()); | |
932 | ||
933 | if (neighbors_do_private_keys && !sawDateGoBack) | |
934 | httpMaybeRemovePublic(entry, rep->sline.status()); | |
935 | ||
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) | |
940 | #endif | |
941 | ) { | |
942 | const SBuf vary(httpMakeVaryMark(request, rep)); | |
943 | ||
944 | if (vary.isEmpty()) { | |
945 | entry->makePrivate(); | |
946 | if (!fwd->reforwardableStatus(rep->sline.status())) | |
947 | EBIT_CLR(entry->flags, ENTRY_FWD_HDR_WAIT); | |
948 | varyFailure = true; | |
949 | } else { | |
950 | entry->mem_obj->vary_headers = vary; | |
951 | ||
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); | |
957 | } | |
958 | } | |
959 | ||
960 | if (!varyFailure) { | |
961 | /* | |
962 | * If its not a reply that we will re-forward, then | |
963 | * allow the client to get it. | |
964 | */ | |
965 | if (!fwd->reforwardableStatus(rep->sline.status())) | |
966 | EBIT_CLR(entry->flags, ENTRY_FWD_HDR_WAIT); | |
967 | ||
968 | switch (cacheableReply()) { | |
969 | ||
970 | case 1: | |
971 | entry->makePublic(); | |
972 | break; | |
973 | ||
974 | case 0: | |
975 | entry->makePrivate(); | |
976 | break; | |
977 | ||
978 | case -1: | |
979 | ||
980 | #if USE_HTTP_VIOLATIONS | |
981 | if (Config.negativeTtl > 0) | |
982 | entry->cacheNegatively(); | |
983 | else | |
984 | #endif | |
985 | entry->makePrivate(); | |
986 | break; | |
987 | ||
988 | default: | |
989 | assert(0); | |
990 | break; | |
991 | } | |
992 | } | |
993 | ||
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 | |
998 | ||
999 | // CC:must-revalidate or CC:proxy-revalidate | |
1000 | const bool ccMustRevalidate = (rep->cache_control->proxyRevalidate() || rep->cache_control->mustRevalidate()); | |
1001 | ||
1002 | // CC:no-cache (only if there are no parameters) | |
1003 | const bool ccNoCacheNoParams = (rep->cache_control->hasNoCache() && rep->cache_control->noCache().size()==0); | |
1004 | ||
1005 | // CC:s-maxage=N | |
1006 | const bool ccSMaxAge = rep->cache_control->hasSMaxAge(); | |
1007 | ||
1008 | // CC:private (yes, these can sometimes be stored) | |
1009 | const bool ccPrivate = rep->cache_control->hasPrivate(); | |
1010 | ||
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); | |
1015 | } | |
1016 | #if USE_HTTP_VIOLATIONS // response header Pragma::no-cache is undefined in HTTP | |
1017 | else { | |
1018 | // Expensive calculation. So only do it IF the CC: header is not present. | |
1019 | ||
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); | |
1025 | } | |
1026 | #endif | |
1027 | } | |
1028 | ||
1029 | #if HEADERS_LOG | |
1030 | headersLog(1, 0, request->method, rep); | |
1031 | ||
1032 | #endif | |
1033 | ||
1034 | ctx_exit(ctx); | |
1035 | } | |
1036 | ||
1037 | HttpStateData::ConnectionStatus | |
1038 | HttpStateData::statusIfComplete() const | |
1039 | { | |
1040 | const HttpReply *rep = virginReply(); | |
1041 | /** \par | |
1042 | * If the reply wants to close the connection, it takes precedence */ | |
1043 | ||
1044 | if (httpHeaderHasConnDir(&rep->header, "close")) | |
1045 | return COMPLETE_NONPERSISTENT_MSG; | |
1046 | ||
1047 | /** \par | |
1048 | * If we didn't send a keep-alive request header, then this | |
1049 | * can not be a persistent connection. | |
1050 | */ | |
1051 | if (!flags.keepalive) | |
1052 | return COMPLETE_NONPERSISTENT_MSG; | |
1053 | ||
1054 | /** \par | |
1055 | * If we haven't sent the whole request then this can not be a persistent | |
1056 | * connection. | |
1057 | */ | |
1058 | if (!flags.request_sent) { | |
1059 | debugs(11, 2, "Request not yet fully sent " << request->method << ' ' << entry->url()); | |
1060 | return COMPLETE_NONPERSISTENT_MSG; | |
1061 | } | |
1062 | ||
1063 | /** \par | |
1064 | * What does the reply have to say about keep-alive? | |
1065 | */ | |
1066 | /** | |
1067 | \bug XXX BUG? | |
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. | |
1074 | */ | |
1075 | if (!rep->keep_alive) | |
1076 | return COMPLETE_NONPERSISTENT_MSG; | |
1077 | ||
1078 | return COMPLETE_PERSISTENT_MSG; | |
1079 | } | |
1080 | ||
1081 | HttpStateData::ConnectionStatus | |
1082 | HttpStateData::persistentConnStatus() const | |
1083 | { | |
1084 | debugs(11, 3, HERE << serverConnection << " eof=" << eof); | |
1085 | if (eof) // already reached EOF | |
1086 | return COMPLETE_NONPERSISTENT_MSG; | |
1087 | ||
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; | |
1094 | ||
1095 | /** \par | |
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 | |
1099 | */ | |
1100 | if (lastChunk && flags.chunked) | |
1101 | return statusIfComplete(); | |
1102 | ||
1103 | const HttpReply *vrep = virginReply(); | |
1104 | debugs(11, 5, "persistentConnStatus: content_length=" << vrep->content_length); | |
1105 | ||
1106 | const int64_t clen = vrep->bodySize(request->method); | |
1107 | ||
1108 | debugs(11, 5, "persistentConnStatus: clen=" << clen); | |
1109 | ||
1110 | /* If the body size is unknown we must wait for EOF */ | |
1111 | if (clen < 0) | |
1112 | return INCOMPLETE_MSG; | |
1113 | ||
1114 | /** \par | |
1115 | * If the body size is known, we must wait until we've gotten all of it. */ | |
1116 | if (clen > 0) { | |
1117 | debugs(11,5, "payloadSeen=" << payloadSeen << " content_length=" << vrep->content_length); | |
1118 | ||
1119 | if (payloadSeen < vrep->content_length) | |
1120 | return INCOMPLETE_MSG; | |
1121 | ||
1122 | if (payloadTruncated > 0) // already read more than needed | |
1123 | return COMPLETE_NONPERSISTENT_MSG; // disable pconns | |
1124 | } | |
1125 | ||
1126 | /** \par | |
1127 | * If there is no message body or we got it all, we can be persistent */ | |
1128 | return statusIfComplete(); | |
1129 | } | |
1130 | ||
1131 | #if USE_DELAY_POOLS | |
1132 | static void | |
1133 | readDelayed(void *context, CommRead const &) | |
1134 | { | |
1135 | HttpStateData *state = static_cast<HttpStateData*>(context); | |
1136 | state->flags.do_next_read = true; | |
1137 | state->maybeReadVirginBody(); | |
1138 | } | |
1139 | #endif | |
1140 | ||
1141 | void | |
1142 | HttpStateData::readReply(const CommIoCbParams &io) | |
1143 | { | |
1144 | Must(!flags.do_next_read); // XXX: should have been set false by mayReadVirginBody() | |
1145 | flags.do_next_read = false; | |
1146 | ||
1147 | debugs(11, 5, io.conn); | |
1148 | ||
1149 | // Bail out early on Comm::ERR_CLOSING - close handlers will tidy up for us | |
1150 | if (io.flag == Comm::ERR_CLOSING) { | |
1151 | debugs(11, 3, "http socket closing"); | |
1152 | return; | |
1153 | } | |
1154 | ||
1155 | if (EBIT_TEST(entry->flags, ENTRY_ABORTED)) { | |
1156 | abortTransaction("store entry aborted while reading reply"); | |
1157 | return; | |
1158 | } | |
1159 | ||
1160 | Must(Comm::IsConnOpen(serverConnection)); | |
1161 | Must(io.conn->fd == serverConnection->fd); | |
1162 | ||
1163 | /* | |
1164 | * Don't reset the timeout value here. The value should be | |
1165 | * counting Config.Timeout.request and applies to the request | |
1166 | * as a whole, not individual read() calls. | |
1167 | * Plus, it breaks our lame *HalfClosed() detection | |
1168 | */ | |
1169 | ||
1170 | Must(maybeMakeSpaceAvailable(true)); | |
1171 | CommIoCbParams rd(this); // will be expanded with ReadNow results | |
1172 | rd.conn = io.conn; | |
1173 | rd.size = entry->bytesWanted(Range<size_t>(0, inBuf.spaceSize())); | |
1174 | #if USE_DELAY_POOLS | |
1175 | if (rd.size < 1) { | |
1176 | assert(entry->mem_obj); | |
1177 | ||
1178 | /* read ahead limit */ | |
1179 | /* Perhaps these two calls should both live in MemObject */ | |
1180 | AsyncCall::Pointer nilCall; | |
1181 | if (!entry->mem_obj->readAheadPolicyCanRead()) { | |
1182 | entry->mem_obj->delayRead(DeferredRead(readDelayed, this, CommRead(io.conn, NULL, 0, nilCall))); | |
1183 | return; | |
1184 | } | |
1185 | ||
1186 | /* delay id limit */ | |
1187 | entry->mem_obj->mostBytesAllowed().delayRead(DeferredRead(readDelayed, this, CommRead(io.conn, NULL, 0, nilCall))); | |
1188 | return; | |
1189 | } | |
1190 | #endif | |
1191 | ||
1192 | switch (Comm::ReadNow(rd, inBuf)) { | |
1193 | case Comm::INPROGRESS: | |
1194 | if (inBuf.isEmpty()) | |
1195 | debugs(33, 2, io.conn << ": no data to process, " << xstrerr(rd.xerrno)); | |
1196 | flags.do_next_read = true; | |
1197 | maybeReadVirginBody(); | |
1198 | return; | |
1199 | ||
1200 | case Comm::OK: | |
1201 | { | |
1202 | payloadSeen += rd.size; | |
1203 | #if USE_DELAY_POOLS | |
1204 | DelayId delayId = entry->mem_obj->mostBytesAllowed(); | |
1205 | delayId.bytesIn(rd.size); | |
1206 | #endif | |
1207 | ||
1208 | statCounter.server.all.kbytes_in += rd.size; | |
1209 | statCounter.server.http.kbytes_in += rd.size; | |
1210 | ++ IOStats.Http.reads; | |
1211 | ||
1212 | int bin = 0; | |
1213 | for (int clen = rd.size - 1; clen; ++bin) | |
1214 | clen >>= 1; | |
1215 | ||
1216 | ++ IOStats.Http.read_hist[bin]; | |
1217 | ||
1218 | // update peer response time stats (%<pt) | |
1219 | const timeval &sent = request->hier.peer_http_request_sent; | |
1220 | if (sent.tv_sec) | |
1221 | tvSub(request->hier.peer_response_time, sent, current_time); | |
1222 | else | |
1223 | request->hier.peer_response_time.tv_sec = -1; | |
1224 | } | |
1225 | ||
1226 | /* Continue to process previously read data */ | |
1227 | break; | |
1228 | ||
1229 | case Comm::ENDFILE: // close detected by 0-byte read | |
1230 | eof = 1; | |
1231 | flags.do_next_read = false; | |
1232 | ||
1233 | /* Continue to process previously read data */ | |
1234 | break; | |
1235 | ||
1236 | // case Comm::COMM_ERROR: | |
1237 | default: // no other flags should ever occur | |
1238 | debugs(11, 2, io.conn << ": read failure: " << xstrerr(rd.xerrno)); | |
1239 | ErrorState *err = new ErrorState(ERR_READ_ERROR, Http::scBadGateway, fwd->request); | |
1240 | err->xerrno = rd.xerrno; | |
1241 | fwd->fail(err); | |
1242 | flags.do_next_read = false; | |
1243 | closeServer(); | |
1244 | mustStop("HttpStateData::readReply"); | |
1245 | return; | |
1246 | } | |
1247 | ||
1248 | /* Process next response from buffer */ | |
1249 | processReply(); | |
1250 | } | |
1251 | ||
1252 | /// processes the already read and buffered response data, possibly after | |
1253 | /// waiting for asynchronous 1xx control message processing | |
1254 | void | |
1255 | HttpStateData::processReply() | |
1256 | { | |
1257 | ||
1258 | if (flags.handling1xx) { // we came back after handling a 1xx response | |
1259 | debugs(11, 5, HERE << "done with 1xx handling"); | |
1260 | flags.handling1xx = false; | |
1261 | Must(!flags.headers_parsed); | |
1262 | } | |
1263 | ||
1264 | if (!flags.headers_parsed) { // have not parsed headers yet? | |
1265 | PROF_start(HttpStateData_processReplyHeader); | |
1266 | processReplyHeader(); | |
1267 | PROF_stop(HttpStateData_processReplyHeader); | |
1268 | ||
1269 | if (!continueAfterParsingHeader()) // parsing error or need more data | |
1270 | return; // TODO: send errors to ICAP | |
1271 | ||
1272 | adaptOrFinalizeReply(); // may write to, abort, or "close" the entry | |
1273 | } | |
1274 | ||
1275 | // kick more reads if needed and/or process the response body, if any | |
1276 | PROF_start(HttpStateData_processReplyBody); | |
1277 | processReplyBody(); // may call serverComplete() | |
1278 | PROF_stop(HttpStateData_processReplyBody); | |
1279 | } | |
1280 | ||
1281 | /** | |
1282 | \retval true if we can continue with processing the body or doing ICAP. | |
1283 | */ | |
1284 | bool | |
1285 | HttpStateData::continueAfterParsingHeader() | |
1286 | { | |
1287 | if (flags.handling1xx) { | |
1288 | debugs(11, 5, HERE << "wait for 1xx handling"); | |
1289 | Must(!flags.headers_parsed); | |
1290 | return false; | |
1291 | } | |
1292 | ||
1293 | if (!flags.headers_parsed && !eof) { | |
1294 | debugs(11, 9, "needs more at " << inBuf.length()); | |
1295 | flags.do_next_read = true; | |
1296 | /** \retval false If we have not finished parsing the headers and may get more data. | |
1297 | * Schedules more reads to retrieve the missing data. | |
1298 | */ | |
1299 | maybeReadVirginBody(); // schedules all kinds of reads; TODO: rename | |
1300 | return false; | |
1301 | } | |
1302 | ||
1303 | /** If we are done with parsing, check for errors */ | |
1304 | ||
1305 | err_type error = ERR_NONE; | |
1306 | ||
1307 | if (flags.headers_parsed) { // parsed headers, possibly with errors | |
1308 | // check for header parsing errors | |
1309 | if (HttpReply *vrep = virginReply()) { | |
1310 | const Http::StatusCode s = vrep->sline.status(); | |
1311 | const AnyP::ProtocolVersion &v = vrep->sline.version; | |
1312 | if (s == Http::scInvalidHeader && v != Http::ProtocolVersion(0,9)) { | |
1313 | debugs(11, DBG_IMPORTANT, "WARNING: HTTP: Invalid Response: Bad header encountered from " << entry->url() << " AKA " << request->url); | |
1314 | error = ERR_INVALID_RESP; | |
1315 | } else if (s == Http::scHeaderTooLarge) { | |
1316 | fwd->dontRetry(true); | |
1317 | error = ERR_TOO_BIG; | |
1318 | } else if (vrep->header.conflictingContentLength()) { | |
1319 | fwd->dontRetry(true); | |
1320 | error = ERR_INVALID_RESP; | |
1321 | } else { | |
1322 | return true; // done parsing, got reply, and no error | |
1323 | } | |
1324 | } else { | |
1325 | // parsed headers but got no reply | |
1326 | debugs(11, DBG_IMPORTANT, "WARNING: HTTP: Invalid Response: No reply at all for " << entry->url() << " AKA " << request->url); | |
1327 | error = ERR_INVALID_RESP; | |
1328 | } | |
1329 | } else { | |
1330 | assert(eof); | |
1331 | if (inBuf.length()) { | |
1332 | error = ERR_INVALID_RESP; | |
1333 | debugs(11, DBG_IMPORTANT, "WARNING: HTTP: Invalid Response: Headers did not parse at all for " << entry->url() << " AKA " << request->url); | |
1334 | } else { | |
1335 | error = ERR_ZERO_SIZE_OBJECT; | |
1336 | debugs(11, (request->flags.accelerated?DBG_IMPORTANT:2), "WARNING: HTTP: Invalid Response: No object data received for " << entry->url() << " AKA " << request->url); | |
1337 | } | |
1338 | } | |
1339 | ||
1340 | assert(error != ERR_NONE); | |
1341 | entry->reset(); | |
1342 | fwd->fail(new ErrorState(error, Http::scBadGateway, fwd->request)); | |
1343 | flags.do_next_read = false; | |
1344 | closeServer(); | |
1345 | mustStop("HttpStateData::continueAfterParsingHeader"); | |
1346 | return false; // quit on error | |
1347 | } | |
1348 | ||
1349 | /** truncate what we read if we read too much so that writeReplyBody() | |
1350 | writes no more than what we should have read */ | |
1351 | void | |
1352 | HttpStateData::truncateVirginBody() | |
1353 | { | |
1354 | assert(flags.headers_parsed); | |
1355 | ||
1356 | HttpReply *vrep = virginReply(); | |
1357 | int64_t clen = -1; | |
1358 | if (!vrep->expectingBody(request->method, clen) || clen < 0) | |
1359 | return; // no body or a body of unknown size, including chunked | |
1360 | ||
1361 | if (payloadSeen - payloadTruncated <= clen) | |
1362 | return; // we did not read too much or already took care of the extras | |
1363 | ||
1364 | if (const int64_t extras = payloadSeen - payloadTruncated - clen) { | |
1365 | // server sent more that the advertised content length | |
1366 | debugs(11, 5, "payloadSeen=" << payloadSeen << | |
1367 | " clen=" << clen << '/' << vrep->content_length << | |
1368 | " trucated=" << payloadTruncated << '+' << extras); | |
1369 | ||
1370 | inBuf.chop(0, inBuf.length() - extras); | |
1371 | payloadTruncated += extras; | |
1372 | } | |
1373 | } | |
1374 | ||
1375 | /** | |
1376 | * Call this when there is data from the origin server | |
1377 | * which should be sent to either StoreEntry, or to ICAP... | |
1378 | */ | |
1379 | void | |
1380 | HttpStateData::writeReplyBody() | |
1381 | { | |
1382 | truncateVirginBody(); // if needed | |
1383 | const char *data = inBuf.rawContent(); | |
1384 | int len = inBuf.length(); | |
1385 | addVirginReplyBody(data, len); | |
1386 | inBuf.consume(len); | |
1387 | } | |
1388 | ||
1389 | bool | |
1390 | HttpStateData::decodeAndWriteReplyBody() | |
1391 | { | |
1392 | const char *data = NULL; | |
1393 | int len; | |
1394 | bool wasThereAnException = false; | |
1395 | assert(flags.chunked); | |
1396 | assert(httpChunkDecoder); | |
1397 | SQUID_ENTER_THROWING_CODE(); | |
1398 | MemBuf decodedData; | |
1399 | decodedData.init(); | |
1400 | httpChunkDecoder->setPayloadBuffer(&decodedData); | |
1401 | const bool doneParsing = httpChunkDecoder->parse(inBuf); | |
1402 | inBuf = httpChunkDecoder->remaining(); // sync buffers after parse | |
1403 | len = decodedData.contentSize(); | |
1404 | data=decodedData.content(); | |
1405 | addVirginReplyBody(data, len); | |
1406 | if (doneParsing) { | |
1407 | lastChunk = 1; | |
1408 | flags.do_next_read = false; | |
1409 | } | |
1410 | SQUID_EXIT_THROWING_CODE(wasThereAnException); | |
1411 | return wasThereAnException; | |
1412 | } | |
1413 | ||
1414 | /** | |
1415 | * processReplyBody has two purposes: | |
1416 | * 1 - take the reply body data, if any, and put it into either | |
1417 | * the StoreEntry, or give it over to ICAP. | |
1418 | * 2 - see if we made it to the end of the response (persistent | |
1419 | * connections and such) | |
1420 | */ | |
1421 | void | |
1422 | HttpStateData::processReplyBody() | |
1423 | { | |
1424 | Ip::Address client_addr; | |
1425 | bool ispinned = false; | |
1426 | ||
1427 | if (!flags.headers_parsed) { | |
1428 | flags.do_next_read = true; | |
1429 | maybeReadVirginBody(); | |
1430 | return; | |
1431 | } | |
1432 | ||
1433 | #if USE_ADAPTATION | |
1434 | debugs(11,5, HERE << "adaptationAccessCheckPending=" << adaptationAccessCheckPending); | |
1435 | if (adaptationAccessCheckPending) | |
1436 | return; | |
1437 | ||
1438 | #endif | |
1439 | ||
1440 | /* | |
1441 | * At this point the reply headers have been parsed and consumed. | |
1442 | * That means header content has been removed from readBuf and | |
1443 | * it contains only body data. | |
1444 | */ | |
1445 | if (entry->isAccepting()) { | |
1446 | if (flags.chunked) { | |
1447 | if (!decodeAndWriteReplyBody()) { | |
1448 | flags.do_next_read = false; | |
1449 | serverComplete(); | |
1450 | return; | |
1451 | } | |
1452 | } else | |
1453 | writeReplyBody(); | |
1454 | } | |
1455 | ||
1456 | // storing/sending methods like earlier adaptOrFinalizeReply() or | |
1457 | // above writeReplyBody() may release/abort the store entry. | |
1458 | if (EBIT_TEST(entry->flags, ENTRY_ABORTED)) { | |
1459 | // TODO: In some cases (e.g., 304), we should keep persistent conn open. | |
1460 | // Detect end-of-reply (and, hence, pool our idle pconn) earlier (ASAP). | |
1461 | abortTransaction("store entry aborted while storing reply"); | |
1462 | return; | |
1463 | } else | |
1464 | switch (persistentConnStatus()) { | |
1465 | case INCOMPLETE_MSG: { | |
1466 | debugs(11, 5, "processReplyBody: INCOMPLETE_MSG from " << serverConnection); | |
1467 | /* Wait for more data or EOF condition */ | |
1468 | AsyncCall::Pointer nil; | |
1469 | if (flags.keepalive_broken) { | |
1470 | commSetConnTimeout(serverConnection, 10, nil); | |
1471 | } else { | |
1472 | commSetConnTimeout(serverConnection, Config.Timeout.read, nil); | |
1473 | } | |
1474 | ||
1475 | flags.do_next_read = true; | |
1476 | } | |
1477 | break; | |
1478 | ||
1479 | case COMPLETE_PERSISTENT_MSG: | |
1480 | debugs(11, 5, "processReplyBody: COMPLETE_PERSISTENT_MSG from " << serverConnection); | |
1481 | /* yes we have to clear all these! */ | |
1482 | commUnsetConnTimeout(serverConnection); | |
1483 | flags.do_next_read = false; | |
1484 | ||
1485 | comm_remove_close_handler(serverConnection->fd, closeHandler); | |
1486 | closeHandler = NULL; | |
1487 | fwd->unregister(serverConnection); | |
1488 | ||
1489 | if (request->flags.spoofClientIp) | |
1490 | client_addr = request->client_addr; | |
1491 | ||
1492 | if (request->flags.pinned) { | |
1493 | ispinned = true; | |
1494 | } else if (request->flags.connectionAuth && request->flags.authSent) { | |
1495 | ispinned = true; | |
1496 | } | |
1497 | ||
1498 | if (ispinned && request->clientConnectionManager.valid()) { | |
1499 | request->clientConnectionManager->pinConnection(serverConnection, request, _peer, | |
1500 | (request->flags.connectionAuth)); | |
1501 | } else { | |
1502 | fwd->pconnPush(serverConnection, request->url.host()); | |
1503 | } | |
1504 | ||
1505 | serverConnection = NULL; | |
1506 | serverComplete(); | |
1507 | return; | |
1508 | ||
1509 | case COMPLETE_NONPERSISTENT_MSG: | |
1510 | debugs(11, 5, "processReplyBody: COMPLETE_NONPERSISTENT_MSG from " << serverConnection); | |
1511 | serverComplete(); | |
1512 | return; | |
1513 | } | |
1514 | ||
1515 | maybeReadVirginBody(); | |
1516 | } | |
1517 | ||
1518 | bool | |
1519 | HttpStateData::mayReadVirginReplyBody() const | |
1520 | { | |
1521 | // TODO: Be more precise here. For example, if/when reading trailer, we may | |
1522 | // not be doneWithServer() yet, but we should return false. Similarly, we | |
1523 | // could still be writing the request body after receiving the whole reply. | |
1524 | return !doneWithServer(); | |
1525 | } | |
1526 | ||
1527 | void | |
1528 | HttpStateData::maybeReadVirginBody() | |
1529 | { | |
1530 | // too late to read | |
1531 | if (!Comm::IsConnOpen(serverConnection) || fd_table[serverConnection->fd].closing()) | |
1532 | return; | |
1533 | ||
1534 | if (!maybeMakeSpaceAvailable(false)) | |
1535 | return; | |
1536 | ||
1537 | // XXX: get rid of the do_next_read flag | |
1538 | // check for the proper reasons preventing read(2) | |
1539 | if (!flags.do_next_read) | |
1540 | return; | |
1541 | ||
1542 | flags.do_next_read = false; | |
1543 | ||
1544 | // must not already be waiting for read(2) ... | |
1545 | assert(!Comm::MonitorsRead(serverConnection->fd)); | |
1546 | ||
1547 | // wait for read(2) to be possible. | |
1548 | typedef CommCbMemFunT<HttpStateData, CommIoCbParams> Dialer; | |
1549 | AsyncCall::Pointer call = JobCallback(11, 5, Dialer, this, HttpStateData::readReply); | |
1550 | Comm::Read(serverConnection, call); | |
1551 | } | |
1552 | ||
1553 | bool | |
1554 | HttpStateData::maybeMakeSpaceAvailable(bool doGrow) | |
1555 | { | |
1556 | // how much we are allowed to buffer | |
1557 | const int limitBuffer = (flags.headers_parsed ? Config.readAheadGap : Config.maxReplyHeaderSize); | |
1558 | ||
1559 | if (limitBuffer < 0 || inBuf.length() >= (SBuf::size_type)limitBuffer) { | |
1560 | // when buffer is at or over limit already | |
1561 | debugs(11, 7, "wont read up to " << limitBuffer << ". buffer has (" << inBuf.length() << "/" << inBuf.spaceSize() << ") from " << serverConnection); | |
1562 | debugs(11, DBG_DATA, "buffer has {" << inBuf << "}"); | |
1563 | // Process next response from buffer | |
1564 | processReply(); | |
1565 | return false; | |
1566 | } | |
1567 | ||
1568 | // how much we want to read | |
1569 | const size_t read_size = calcBufferSpaceToReserve(inBuf.spaceSize(), (limitBuffer - inBuf.length())); | |
1570 | ||
1571 | if (!read_size) { | |
1572 | debugs(11, 7, "wont read up to " << read_size << " into buffer (" << inBuf.length() << "/" << inBuf.spaceSize() << ") from " << serverConnection); | |
1573 | return false; | |
1574 | } | |
1575 | ||
1576 | // just report whether we could grow or not, dont actually do it | |
1577 | if (doGrow) | |
1578 | return (read_size >= 2); | |
1579 | ||
1580 | // we may need to grow the buffer | |
1581 | inBuf.reserveSpace(read_size); | |
1582 | debugs(11, 8, (!flags.do_next_read ? "wont" : "may") << | |
1583 | " read up to " << read_size << " bytes info buf(" << inBuf.length() << "/" << inBuf.spaceSize() << | |
1584 | ") from " << serverConnection); | |
1585 | ||
1586 | return (inBuf.spaceSize() >= 2); // only read if there is 1+ bytes of space available | |
1587 | } | |
1588 | ||
1589 | /// called after writing the very last request byte (body, last-chunk, etc) | |
1590 | void | |
1591 | HttpStateData::wroteLast(const CommIoCbParams &io) | |
1592 | { | |
1593 | debugs(11, 5, HERE << serverConnection << ": size " << io.size << ": errflag " << io.flag << "."); | |
1594 | #if URL_CHECKSUM_DEBUG | |
1595 | ||
1596 | entry->mem_obj->checkUrlChecksum(); | |
1597 | #endif | |
1598 | ||
1599 | if (io.size > 0) { | |
1600 | fd_bytes(io.fd, io.size, FD_WRITE); | |
1601 | statCounter.server.all.kbytes_out += io.size; | |
1602 | statCounter.server.http.kbytes_out += io.size; | |
1603 | } | |
1604 | ||
1605 | if (io.flag == Comm::ERR_CLOSING) | |
1606 | return; | |
1607 | ||
1608 | if (io.flag) { | |
1609 | ErrorState *err = new ErrorState(ERR_WRITE_ERROR, Http::scBadGateway, fwd->request); | |
1610 | err->xerrno = io.xerrno; | |
1611 | fwd->fail(err); | |
1612 | closeServer(); | |
1613 | mustStop("HttpStateData::wroteLast"); | |
1614 | return; | |
1615 | } | |
1616 | ||
1617 | sendComplete(); | |
1618 | } | |
1619 | ||
1620 | /// successfully wrote the entire request (including body, last-chunk, etc.) | |
1621 | void | |
1622 | HttpStateData::sendComplete() | |
1623 | { | |
1624 | /* | |
1625 | * Set the read timeout here because it hasn't been set yet. | |
1626 | * We only set the read timeout after the request has been | |
1627 | * fully written to the peer. If we start the timeout | |
1628 | * after connection establishment, then we are likely to hit | |
1629 | * the timeout for POST/PUT requests that have very large | |
1630 | * request bodies. | |
1631 | */ | |
1632 | typedef CommCbMemFunT<HttpStateData, CommTimeoutCbParams> TimeoutDialer; | |
1633 | AsyncCall::Pointer timeoutCall = JobCallback(11, 5, | |
1634 | TimeoutDialer, this, HttpStateData::httpTimeout); | |
1635 | ||
1636 | commSetConnTimeout(serverConnection, Config.Timeout.read, timeoutCall); | |
1637 | flags.request_sent = true; | |
1638 | request->hier.peer_http_request_sent = current_time; | |
1639 | } | |
1640 | ||
1641 | void | |
1642 | HttpStateData::closeServer() | |
1643 | { | |
1644 | debugs(11,5, HERE << "closing HTTP server " << serverConnection << " this " << this); | |
1645 | ||
1646 | if (Comm::IsConnOpen(serverConnection)) { | |
1647 | fwd->unregister(serverConnection); | |
1648 | comm_remove_close_handler(serverConnection->fd, closeHandler); | |
1649 | closeHandler = NULL; | |
1650 | serverConnection->close(); | |
1651 | } | |
1652 | } | |
1653 | ||
1654 | bool | |
1655 | HttpStateData::doneWithServer() const | |
1656 | { | |
1657 | return !Comm::IsConnOpen(serverConnection); | |
1658 | } | |
1659 | ||
1660 | /* | |
1661 | * Fixup authentication request headers for special cases | |
1662 | */ | |
1663 | static void | |
1664 | httpFixupAuthentication(HttpRequest * request, const HttpHeader * hdr_in, HttpHeader * hdr_out, const Http::StateFlags &flags) | |
1665 | { | |
1666 | Http::HdrType header = flags.originpeer ? Http::HdrType::AUTHORIZATION : Http::HdrType::PROXY_AUTHORIZATION; | |
1667 | ||
1668 | /* Nothing to do unless we are forwarding to a peer */ | |
1669 | if (!request->flags.proxying) | |
1670 | return; | |
1671 | ||
1672 | /* Needs to be explicitly enabled */ | |
1673 | if (!request->peer_login) | |
1674 | return; | |
1675 | ||
1676 | /* Maybe already dealt with? */ | |
1677 | if (hdr_out->has(header)) | |
1678 | return; | |
1679 | ||
1680 | /* Nothing to do here for PASSTHRU */ | |
1681 | if (strcmp(request->peer_login, "PASSTHRU") == 0) | |
1682 | return; | |
1683 | ||
1684 | /* PROXYPASS is a special case, single-signon to servers with the proxy password (basic only) */ | |
1685 | if (flags.originpeer && strcmp(request->peer_login, "PROXYPASS") == 0 && hdr_in->has(Http::HdrType::PROXY_AUTHORIZATION)) { | |
1686 | const char *auth = hdr_in->getStr(Http::HdrType::PROXY_AUTHORIZATION); | |
1687 | ||
1688 | if (auth && strncasecmp(auth, "basic ", 6) == 0) { | |
1689 | hdr_out->putStr(header, auth); | |
1690 | return; | |
1691 | } | |
1692 | } | |
1693 | ||
1694 | uint8_t loginbuf[base64_encode_len(MAX_LOGIN_SZ)]; | |
1695 | size_t blen; | |
1696 | struct base64_encode_ctx ctx; | |
1697 | base64_encode_init(&ctx); | |
1698 | ||
1699 | /* Special mode to pass the username to the upstream cache */ | |
1700 | if (*request->peer_login == '*') { | |
1701 | const char *username = "-"; | |
1702 | ||
1703 | if (request->extacl_user.size()) | |
1704 | username = request->extacl_user.termedBuf(); | |
1705 | #if USE_AUTH | |
1706 | else if (request->auth_user_request != NULL) | |
1707 | username = request->auth_user_request->username(); | |
1708 | #endif | |
1709 | ||
1710 | blen = base64_encode_update(&ctx, loginbuf, strlen(username), reinterpret_cast<const uint8_t*>(username)); | |
1711 | blen += base64_encode_update(&ctx, loginbuf+blen, strlen(request->peer_login +1), reinterpret_cast<const uint8_t*>(request->peer_login +1)); | |
1712 | blen += base64_encode_final(&ctx, loginbuf+blen); | |
1713 | httpHeaderPutStrf(hdr_out, header, "Basic %.*s", (int)blen, loginbuf); | |
1714 | return; | |
1715 | } | |
1716 | ||
1717 | /* external_acl provided credentials */ | |
1718 | if (request->extacl_user.size() && request->extacl_passwd.size() && | |
1719 | (strcmp(request->peer_login, "PASS") == 0 || | |
1720 | strcmp(request->peer_login, "PROXYPASS") == 0)) { | |
1721 | ||
1722 | blen = base64_encode_update(&ctx, loginbuf, request->extacl_user.size(), reinterpret_cast<const uint8_t*>(request->extacl_user.rawBuf())); | |
1723 | blen += base64_encode_update(&ctx, loginbuf+blen, 1, reinterpret_cast<const uint8_t*>(":")); | |
1724 | blen += base64_encode_update(&ctx, loginbuf+blen, request->extacl_passwd.size(), reinterpret_cast<const uint8_t*>(request->extacl_passwd.rawBuf())); | |
1725 | blen += base64_encode_final(&ctx, loginbuf+blen); | |
1726 | httpHeaderPutStrf(hdr_out, header, "Basic %.*s", (int)blen, loginbuf); | |
1727 | return; | |
1728 | } | |
1729 | // if no external user credentials are available to fake authentication with PASS acts like PASSTHRU | |
1730 | if (strcmp(request->peer_login, "PASS") == 0) | |
1731 | return; | |
1732 | ||
1733 | /* Kerberos login to peer */ | |
1734 | #if HAVE_AUTH_MODULE_NEGOTIATE && HAVE_KRB5 && HAVE_GSSAPI | |
1735 | if (strncmp(request->peer_login, "NEGOTIATE",strlen("NEGOTIATE")) == 0) { | |
1736 | char *Token=NULL; | |
1737 | char *PrincipalName=NULL,*p; | |
1738 | int negotiate_flags = 0; | |
1739 | ||
1740 | if ((p=strchr(request->peer_login,':')) != NULL ) { | |
1741 | PrincipalName=++p; | |
1742 | } | |
1743 | if (request->flags.auth_no_keytab) { | |
1744 | negotiate_flags |= PEER_PROXY_NEGOTIATE_NOKEYTAB; | |
1745 | } | |
1746 | Token = peer_proxy_negotiate_auth(PrincipalName, request->peer_host, negotiate_flags); | |
1747 | if (Token) { | |
1748 | httpHeaderPutStrf(hdr_out, header, "Negotiate %s",Token); | |
1749 | } | |
1750 | return; | |
1751 | } | |
1752 | #endif /* HAVE_KRB5 && HAVE_GSSAPI */ | |
1753 | ||
1754 | blen = base64_encode_update(&ctx, loginbuf, strlen(request->peer_login), reinterpret_cast<const uint8_t*>(request->peer_login)); | |
1755 | blen += base64_encode_final(&ctx, loginbuf+blen); | |
1756 | httpHeaderPutStrf(hdr_out, header, "Basic %.*s", (int)blen, loginbuf); | |
1757 | return; | |
1758 | } | |
1759 | ||
1760 | /* | |
1761 | * build request headers and append them to a given MemBuf | |
1762 | * used by buildRequestPrefix() | |
1763 | * note: initialised the HttpHeader, the caller is responsible for Clean()-ing | |
1764 | */ | |
1765 | void | |
1766 | HttpStateData::httpBuildRequestHeader(HttpRequest * request, | |
1767 | StoreEntry * entry, | |
1768 | const AccessLogEntryPointer &al, | |
1769 | HttpHeader * hdr_out, | |
1770 | const Http::StateFlags &flags) | |
1771 | { | |
1772 | /* building buffer for complex strings */ | |
1773 | #define BBUF_SZ (MAX_URL+32) | |
1774 | LOCAL_ARRAY(char, bbuf, BBUF_SZ); | |
1775 | LOCAL_ARRAY(char, ntoabuf, MAX_IPSTRLEN); | |
1776 | const HttpHeader *hdr_in = &request->header; | |
1777 | const HttpHeaderEntry *e = NULL; | |
1778 | HttpHeaderPos pos = HttpHeaderInitPos; | |
1779 | assert (hdr_out->owner == hoRequest); | |
1780 | ||
1781 | /* use our IMS header if the cached entry has Last-Modified time */ | |
1782 | if (request->lastmod > -1) | |
1783 | hdr_out->putTime(Http::HdrType::IF_MODIFIED_SINCE, request->lastmod); | |
1784 | ||
1785 | // Add our own If-None-Match field if the cached entry has a strong ETag. | |
1786 | // copyOneHeaderFromClientsideRequestToUpstreamRequest() adds client ones. | |
1787 | if (request->etag.size() > 0) { | |
1788 | hdr_out->addEntry(new HttpHeaderEntry(Http::HdrType::IF_NONE_MATCH, NULL, | |
1789 | request->etag.termedBuf())); | |
1790 | } | |
1791 | ||
1792 | bool we_do_ranges = decideIfWeDoRanges (request); | |
1793 | ||
1794 | String strConnection (hdr_in->getList(Http::HdrType::CONNECTION)); | |
1795 | ||
1796 | while ((e = hdr_in->getEntry(&pos))) | |
1797 | copyOneHeaderFromClientsideRequestToUpstreamRequest(e, strConnection, request, hdr_out, we_do_ranges, flags); | |
1798 | ||
1799 | /* Abstraction break: We should interpret multipart/byterange responses | |
1800 | * into offset-length data, and this works around our inability to do so. | |
1801 | */ | |
1802 | if (!we_do_ranges && request->multipartRangeRequest()) { | |
1803 | /* don't cache the result */ | |
1804 | request->flags.cachable = false; | |
1805 | /* pretend it's not a range request */ | |
1806 | request->ignoreRange("want to request the whole object"); | |
1807 | request->flags.isRanged = false; | |
1808 | } | |
1809 | ||
1810 | /* append Via */ | |
1811 | if (Config.onoff.via) { | |
1812 | String strVia; | |
1813 | strVia = hdr_in->getList(Http::HdrType::VIA); | |
1814 | snprintf(bbuf, BBUF_SZ, "%d.%d %s", | |
1815 | request->http_ver.major, | |
1816 | request->http_ver.minor, ThisCache); | |
1817 | strListAdd(&strVia, bbuf, ','); | |
1818 | hdr_out->putStr(Http::HdrType::VIA, strVia.termedBuf()); | |
1819 | strVia.clean(); | |
1820 | } | |
1821 | ||
1822 | if (request->flags.accelerated) { | |
1823 | /* Append Surrogate-Capabilities */ | |
1824 | String strSurrogate(hdr_in->getList(Http::HdrType::SURROGATE_CAPABILITY)); | |
1825 | #if USE_SQUID_ESI | |
1826 | snprintf(bbuf, BBUF_SZ, "%s=\"Surrogate/1.0 ESI/1.0\"", Config.Accel.surrogate_id); | |
1827 | #else | |
1828 | snprintf(bbuf, BBUF_SZ, "%s=\"Surrogate/1.0\"", Config.Accel.surrogate_id); | |
1829 | #endif | |
1830 | strListAdd(&strSurrogate, bbuf, ','); | |
1831 | hdr_out->putStr(Http::HdrType::SURROGATE_CAPABILITY, strSurrogate.termedBuf()); | |
1832 | } | |
1833 | ||
1834 | /** \pre Handle X-Forwarded-For */ | |
1835 | if (strcmp(opt_forwarded_for, "delete") != 0) { | |
1836 | ||
1837 | String strFwd = hdr_in->getList(Http::HdrType::X_FORWARDED_FOR); | |
1838 | ||
1839 | // if we cannot double strFwd size, then it grew past 50% of the limit | |
1840 | if (!strFwd.canGrowBy(strFwd.size())) { | |
1841 | // There is probably a forwarding loop with Via detection disabled. | |
1842 | // If we do nothing, String will assert on overflow soon. | |
1843 | // TODO: Terminate all transactions with huge XFF? | |
1844 | strFwd = "error"; | |
1845 | ||
1846 | static int warnedCount = 0; | |
1847 | if (warnedCount++ < 100) { | |
1848 | const SBuf url(entry ? SBuf(entry->url()) : request->effectiveRequestUri()); | |
1849 | debugs(11, DBG_IMPORTANT, "Warning: likely forwarding loop with " << url); | |
1850 | } | |
1851 | } | |
1852 | ||
1853 | if (strcmp(opt_forwarded_for, "on") == 0) { | |
1854 | /** If set to ON - append client IP or 'unknown'. */ | |
1855 | if ( request->client_addr.isNoAddr() ) | |
1856 | strListAdd(&strFwd, "unknown", ','); | |
1857 | else | |
1858 | strListAdd(&strFwd, request->client_addr.toStr(ntoabuf, MAX_IPSTRLEN), ','); | |
1859 | } else if (strcmp(opt_forwarded_for, "off") == 0) { | |
1860 | /** If set to OFF - append 'unknown'. */ | |
1861 | strListAdd(&strFwd, "unknown", ','); | |
1862 | } else if (strcmp(opt_forwarded_for, "transparent") == 0) { | |
1863 | /** If set to TRANSPARENT - pass through unchanged. */ | |
1864 | } else if (strcmp(opt_forwarded_for, "truncate") == 0) { | |
1865 | /** If set to TRUNCATE - drop existing list and replace with client IP or 'unknown'. */ | |
1866 | if ( request->client_addr.isNoAddr() ) | |
1867 | strFwd = "unknown"; | |
1868 | else | |
1869 | strFwd = request->client_addr.toStr(ntoabuf, MAX_IPSTRLEN); | |
1870 | } | |
1871 | if (strFwd.size() > 0) | |
1872 | hdr_out->putStr(Http::HdrType::X_FORWARDED_FOR, strFwd.termedBuf()); | |
1873 | } | |
1874 | /** If set to DELETE - do not copy through. */ | |
1875 | ||
1876 | /* append Host if not there already */ | |
1877 | if (!hdr_out->has(Http::HdrType::HOST)) { | |
1878 | if (request->peer_domain) { | |
1879 | hdr_out->putStr(Http::HdrType::HOST, request->peer_domain); | |
1880 | } else { | |
1881 | SBuf authority = request->url.authority(); | |
1882 | hdr_out->putStr(Http::HdrType::HOST, authority.c_str()); | |
1883 | } | |
1884 | } | |
1885 | ||
1886 | /* append Authorization if known in URL, not in header and going direct */ | |
1887 | if (!hdr_out->has(Http::HdrType::AUTHORIZATION)) { | |
1888 | if (!request->flags.proxying && !request->url.userInfo().isEmpty()) { | |
1889 | static uint8_t result[base64_encode_len(MAX_URL*2)]; // should be big enough for a single URI segment | |
1890 | struct base64_encode_ctx ctx; | |
1891 | base64_encode_init(&ctx); | |
1892 | size_t blen = base64_encode_update(&ctx, result, request->url.userInfo().length(), reinterpret_cast<const uint8_t*>(request->url.userInfo().rawContent())); | |
1893 | blen += base64_encode_final(&ctx, result+blen); | |
1894 | result[blen] = '\0'; | |
1895 | if (blen) | |
1896 | httpHeaderPutStrf(hdr_out, Http::HdrType::AUTHORIZATION, "Basic %.*s", (int)blen, result); | |
1897 | } | |
1898 | } | |
1899 | ||
1900 | /* Fixup (Proxy-)Authorization special cases. Plain relaying dealt with above */ | |
1901 | httpFixupAuthentication(request, hdr_in, hdr_out, flags); | |
1902 | ||
1903 | /* append Cache-Control, add max-age if not there already */ | |
1904 | { | |
1905 | HttpHdrCc *cc = hdr_in->getCc(); | |
1906 | ||
1907 | if (!cc) | |
1908 | cc = new HttpHdrCc(); | |
1909 | ||
1910 | #if 0 /* see bug 2330 */ | |
1911 | /* Set no-cache if determined needed but not found */ | |
1912 | if (request->flags.nocache) | |
1913 | EBIT_SET(cc->mask, HttpHdrCcType::CC_NO_CACHE); | |
1914 | #endif | |
1915 | ||
1916 | /* Add max-age only without no-cache */ | |
1917 | if (!cc->hasMaxAge() && !cc->hasNoCache()) { | |
1918 | // XXX: performance regression. c_str() reallocates | |
1919 | SBuf tmp(request->effectiveRequestUri()); | |
1920 | cc->maxAge(getMaxAge(entry ? entry->url() : tmp.c_str())); | |
1921 | } | |
1922 | ||
1923 | /* Enforce sibling relations */ | |
1924 | if (flags.only_if_cached) | |
1925 | cc->onlyIfCached(true); | |
1926 | ||
1927 | hdr_out->putCc(cc); | |
1928 | ||
1929 | delete cc; | |
1930 | } | |
1931 | ||
1932 | /* maybe append Connection: keep-alive */ | |
1933 | if (flags.keepalive) { | |
1934 | hdr_out->putStr(Http::HdrType::CONNECTION, "keep-alive"); | |
1935 | } | |
1936 | ||
1937 | /* append Front-End-Https */ | |
1938 | if (flags.front_end_https) { | |
1939 | if (flags.front_end_https == 1 || request->url.getScheme() == AnyP::PROTO_HTTPS) | |
1940 | hdr_out->putStr(Http::HdrType::FRONT_END_HTTPS, "On"); | |
1941 | } | |
1942 | ||
1943 | if (flags.chunked_request) { | |
1944 | // Do not just copy the original value so that if the client-side | |
1945 | // starts decode other encodings, this code may remain valid. | |
1946 | hdr_out->putStr(Http::HdrType::TRANSFER_ENCODING, "chunked"); | |
1947 | } | |
1948 | ||
1949 | /* Now mangle the headers. */ | |
1950 | httpHdrMangleList(hdr_out, request, al, ROR_REQUEST); | |
1951 | ||
1952 | strConnection.clean(); | |
1953 | } | |
1954 | ||
1955 | /** | |
1956 | * Decides whether a particular header may be cloned from the received Clients request | |
1957 | * to our outgoing fetch request. | |
1958 | */ | |
1959 | void | |
1960 | copyOneHeaderFromClientsideRequestToUpstreamRequest(const HttpHeaderEntry *e, const String strConnection, const HttpRequest * request, HttpHeader * hdr_out, const int we_do_ranges, const Http::StateFlags &flags) | |
1961 | { | |
1962 | debugs(11, 5, "httpBuildRequestHeader: " << e->name << ": " << e->value ); | |
1963 | ||
1964 | switch (e->id) { | |
1965 | ||
1966 | /** \par RFC 2616 sect 13.5.1 - Hop-by-Hop headers which Squid should not pass on. */ | |
1967 | ||
1968 | case Http::HdrType::PROXY_AUTHORIZATION: | |
1969 | /** \par Proxy-Authorization: | |
1970 | * Only pass on proxy authentication to peers for which | |
1971 | * authentication forwarding is explicitly enabled | |
1972 | */ | |
1973 | if (!flags.originpeer && flags.proxying && request->peer_login && | |
1974 | (strcmp(request->peer_login, "PASS") == 0 || | |
1975 | strcmp(request->peer_login, "PROXYPASS") == 0 || | |
1976 | strcmp(request->peer_login, "PASSTHRU") == 0)) { | |
1977 | hdr_out->addEntry(e->clone()); | |
1978 | } | |
1979 | break; | |
1980 | ||
1981 | /** \par RFC 2616 sect 13.5.1 - Hop-by-Hop headers which Squid does not pass on. */ | |
1982 | ||
1983 | case Http::HdrType::CONNECTION: /** \par Connection: */ | |
1984 | case Http::HdrType::TE: /** \par TE: */ | |
1985 | case Http::HdrType::KEEP_ALIVE: /** \par Keep-Alive: */ | |
1986 | case Http::HdrType::PROXY_AUTHENTICATE: /** \par Proxy-Authenticate: */ | |
1987 | case Http::HdrType::TRAILER: /** \par Trailer: */ | |
1988 | case Http::HdrType::UPGRADE: /** \par Upgrade: */ | |
1989 | case Http::HdrType::TRANSFER_ENCODING: /** \par Transfer-Encoding: */ | |
1990 | break; | |
1991 | ||
1992 | /** \par OTHER headers I haven't bothered to track down yet. */ | |
1993 | ||
1994 | case Http::HdrType::AUTHORIZATION: | |
1995 | /** \par WWW-Authorization: | |
1996 | * Pass on WWW authentication */ | |
1997 | ||
1998 | if (!flags.originpeer) { | |
1999 | hdr_out->addEntry(e->clone()); | |
2000 | } else { | |
2001 | /** \note In accelerators, only forward authentication if enabled | |
2002 | * (see also httpFixupAuthentication for special cases) | |
2003 | */ | |
2004 | if (request->peer_login && | |
2005 | (strcmp(request->peer_login, "PASS") == 0 || | |
2006 | strcmp(request->peer_login, "PASSTHRU") == 0 || | |
2007 | strcmp(request->peer_login, "PROXYPASS") == 0)) { | |
2008 | hdr_out->addEntry(e->clone()); | |
2009 | } | |
2010 | } | |
2011 | ||
2012 | break; | |
2013 | ||
2014 | case Http::HdrType::HOST: | |
2015 | /** \par Host: | |
2016 | * Normally Squid rewrites the Host: header. | |
2017 | * However, there is one case when we don't: If the URL | |
2018 | * went through our redirector and the admin configured | |
2019 | * 'redir_rewrites_host' to be off. | |
2020 | */ | |
2021 | if (request->peer_domain) | |
2022 | hdr_out->putStr(Http::HdrType::HOST, request->peer_domain); | |
2023 | else if (request->flags.redirected && !Config.onoff.redir_rewrites_host) | |
2024 | hdr_out->addEntry(e->clone()); | |
2025 | else { | |
2026 | SBuf authority = request->url.authority(); | |
2027 | hdr_out->putStr(Http::HdrType::HOST, authority.c_str()); | |
2028 | } | |
2029 | ||
2030 | break; | |
2031 | ||
2032 | case Http::HdrType::IF_MODIFIED_SINCE: | |
2033 | /** \par If-Modified-Since: | |
2034 | * append unless we added our own, | |
2035 | * but only if cache_miss_revalidate is enabled, or | |
2036 | * the request is not cacheable, or | |
2037 | * the request contains authentication credentials. | |
2038 | * \note at most one client's If-Modified-Since header can pass through | |
2039 | */ | |
2040 | // XXX: need to check and cleanup the auth case so cacheable auth requests get cached. | |
2041 | if (hdr_out->has(Http::HdrType::IF_MODIFIED_SINCE)) | |
2042 | break; | |
2043 | else if (Config.onoff.cache_miss_revalidate || !request->flags.cachable || request->flags.auth) | |
2044 | hdr_out->addEntry(e->clone()); | |
2045 | break; | |
2046 | ||
2047 | case Http::HdrType::IF_NONE_MATCH: | |
2048 | /** \par If-None-Match: | |
2049 | * append if the wildcard '*' special case value is present, or | |
2050 | * cache_miss_revalidate is disabled, or | |
2051 | * the request is not cacheable in this proxy, or | |
2052 | * the request contains authentication credentials. | |
2053 | * \note this header lists a set of responses for the server to elide sending. Squid added values are extending that set. | |
2054 | */ | |
2055 | // XXX: need to check and cleanup the auth case so cacheable auth requests get cached. | |
2056 | if (hdr_out->hasListMember(Http::HdrType::IF_MATCH, "*", ',') || Config.onoff.cache_miss_revalidate || !request->flags.cachable || request->flags.auth) | |
2057 | hdr_out->addEntry(e->clone()); | |
2058 | break; | |
2059 | ||
2060 | case Http::HdrType::MAX_FORWARDS: | |
2061 | /** \par Max-Forwards: | |
2062 | * pass only on TRACE or OPTIONS requests */ | |
2063 | if (request->method == Http::METHOD_TRACE || request->method == Http::METHOD_OPTIONS) { | |
2064 | const int64_t hops = e->getInt64(); | |
2065 | ||
2066 | if (hops > 0) | |
2067 | hdr_out->putInt64(Http::HdrType::MAX_FORWARDS, hops - 1); | |
2068 | } | |
2069 | ||
2070 | break; | |
2071 | ||
2072 | case Http::HdrType::VIA: | |
2073 | /** \par Via: | |
2074 | * If Via is disabled then forward any received header as-is. | |
2075 | * Otherwise leave for explicit updated addition later. */ | |
2076 | ||
2077 | if (!Config.onoff.via) | |
2078 | hdr_out->addEntry(e->clone()); | |
2079 | ||
2080 | break; | |
2081 | ||
2082 | case Http::HdrType::RANGE: | |
2083 | ||
2084 | case Http::HdrType::IF_RANGE: | |
2085 | ||
2086 | case Http::HdrType::REQUEST_RANGE: | |
2087 | /** \par Range:, If-Range:, Request-Range: | |
2088 | * Only pass if we accept ranges */ | |
2089 | if (!we_do_ranges) | |
2090 | hdr_out->addEntry(e->clone()); | |
2091 | ||
2092 | break; | |
2093 | ||
2094 | case Http::HdrType::PROXY_CONNECTION: // SHOULD ignore. But doing so breaks things. | |
2095 | break; | |
2096 | ||
2097 | case Http::HdrType::CONTENT_LENGTH: | |
2098 | // pass through unless we chunk; also, keeping this away from default | |
2099 | // prevents request smuggling via Connection: Content-Length tricks | |
2100 | if (!flags.chunked_request) | |
2101 | hdr_out->addEntry(e->clone()); | |
2102 | break; | |
2103 | ||
2104 | case Http::HdrType::X_FORWARDED_FOR: | |
2105 | ||
2106 | case Http::HdrType::CACHE_CONTROL: | |
2107 | /** \par X-Forwarded-For:, Cache-Control: | |
2108 | * handled specially by Squid, so leave off for now. | |
2109 | * append these after the loop if needed */ | |
2110 | break; | |
2111 | ||
2112 | case Http::HdrType::FRONT_END_HTTPS: | |
2113 | /** \par Front-End-Https: | |
2114 | * Pass thru only if peer is configured with front-end-https */ | |
2115 | if (!flags.front_end_https) | |
2116 | hdr_out->addEntry(e->clone()); | |
2117 | ||
2118 | break; | |
2119 | ||
2120 | default: | |
2121 | /** \par default. | |
2122 | * pass on all other header fields | |
2123 | * which are NOT listed by the special Connection: header. */ | |
2124 | ||
2125 | if (strConnection.size()>0 && strListIsMember(&strConnection, e->name.termedBuf(), ',')) { | |
2126 | debugs(11, 2, "'" << e->name << "' header cropped by Connection: definition"); | |
2127 | return; | |
2128 | } | |
2129 | ||
2130 | hdr_out->addEntry(e->clone()); | |
2131 | } | |
2132 | } | |
2133 | ||
2134 | bool | |
2135 | HttpStateData::decideIfWeDoRanges (HttpRequest * request) | |
2136 | { | |
2137 | bool result = true; | |
2138 | /* decide if we want to do Ranges ourselves | |
2139 | * and fetch the whole object now) | |
2140 | * We want to handle Ranges ourselves iff | |
2141 | * - we can actually parse client Range specs | |
2142 | * - the specs are expected to be simple enough (e.g. no out-of-order ranges) | |
2143 | * - reply will be cachable | |
2144 | * (If the reply will be uncachable we have to throw it away after | |
2145 | * serving this request, so it is better to forward ranges to | |
2146 | * the server and fetch only the requested content) | |
2147 | */ | |
2148 | ||
2149 | int64_t roffLimit = request->getRangeOffsetLimit(); | |
2150 | ||
2151 | if (NULL == request->range || !request->flags.cachable | |
2152 | || request->range->offsetLimitExceeded(roffLimit) || request->flags.connectionAuth) | |
2153 | result = false; | |
2154 | ||
2155 | debugs(11, 8, "decideIfWeDoRanges: range specs: " << | |
2156 | request->range << ", cachable: " << | |
2157 | request->flags.cachable << "; we_do_ranges: " << result); | |
2158 | ||
2159 | return result; | |
2160 | } | |
2161 | ||
2162 | /* build request prefix and append it to a given MemBuf; | |
2163 | * return the length of the prefix */ | |
2164 | mb_size_t | |
2165 | HttpStateData::buildRequestPrefix(MemBuf * mb) | |
2166 | { | |
2167 | const int offset = mb->size; | |
2168 | /* Uses a local httpver variable to print the HTTP label | |
2169 | * since the HttpRequest may have an older version label. | |
2170 | * XXX: This could create protocol bugs as the headers sent and | |
2171 | * flow control should all be based on the HttpRequest version | |
2172 | * not the one we are sending. Needs checking. | |
2173 | */ | |
2174 | const AnyP::ProtocolVersion httpver = Http::ProtocolVersion(); | |
2175 | const SBuf url(_peer && !_peer->options.originserver ? request->effectiveRequestUri() : request->url.path()); | |
2176 | mb->appendf(SQUIDSBUFPH " " SQUIDSBUFPH " %s/%d.%d\r\n", | |
2177 | SQUIDSBUFPRINT(request->method.image()), | |
2178 | SQUIDSBUFPRINT(url), | |
2179 | AnyP::ProtocolType_str[httpver.protocol], | |
2180 | httpver.major,httpver.minor); | |
2181 | /* build and pack headers */ | |
2182 | { | |
2183 | HttpHeader hdr(hoRequest); | |
2184 | httpBuildRequestHeader(request, entry, fwd->al, &hdr, flags); | |
2185 | ||
2186 | if (request->flags.pinned && request->flags.connectionAuth) | |
2187 | request->flags.authSent = true; | |
2188 | else if (hdr.has(Http::HdrType::AUTHORIZATION)) | |
2189 | request->flags.authSent = true; | |
2190 | ||
2191 | hdr.packInto(mb); | |
2192 | hdr.clean(); | |
2193 | } | |
2194 | /* append header terminator */ | |
2195 | mb->append(crlf, 2); | |
2196 | return mb->size - offset; | |
2197 | } | |
2198 | ||
2199 | /* This will be called when connect completes. Write request. */ | |
2200 | bool | |
2201 | HttpStateData::sendRequest() | |
2202 | { | |
2203 | MemBuf mb; | |
2204 | ||
2205 | debugs(11, 5, HERE << serverConnection << ", request " << request << ", this " << this << "."); | |
2206 | ||
2207 | if (!Comm::IsConnOpen(serverConnection)) { | |
2208 | debugs(11,3, HERE << "cannot send request to closing " << serverConnection); | |
2209 | assert(closeHandler != NULL); | |
2210 | return false; | |
2211 | } | |
2212 | ||
2213 | typedef CommCbMemFunT<HttpStateData, CommTimeoutCbParams> TimeoutDialer; | |
2214 | AsyncCall::Pointer timeoutCall = JobCallback(11, 5, | |
2215 | TimeoutDialer, this, HttpStateData::httpTimeout); | |
2216 | commSetConnTimeout(serverConnection, Config.Timeout.lifetime, timeoutCall); | |
2217 | flags.do_next_read = true; | |
2218 | maybeReadVirginBody(); | |
2219 | ||
2220 | if (request->body_pipe != NULL) { | |
2221 | if (!startRequestBodyFlow()) // register to receive body data | |
2222 | return false; | |
2223 | typedef CommCbMemFunT<HttpStateData, CommIoCbParams> Dialer; | |
2224 | requestSender = JobCallback(11,5, | |
2225 | Dialer, this, HttpStateData::sentRequestBody); | |
2226 | ||
2227 | Must(!flags.chunked_request); | |
2228 | // use chunked encoding if we do not know the length | |
2229 | if (request->content_length < 0) | |
2230 | flags.chunked_request = true; | |
2231 | } else { | |
2232 | assert(!requestBodySource); | |
2233 | typedef CommCbMemFunT<HttpStateData, CommIoCbParams> Dialer; | |
2234 | requestSender = JobCallback(11,5, | |
2235 | Dialer, this, HttpStateData::wroteLast); | |
2236 | } | |
2237 | ||
2238 | flags.originpeer = (_peer != NULL && _peer->options.originserver); | |
2239 | flags.proxying = (_peer != NULL && !flags.originpeer); | |
2240 | ||
2241 | /* | |
2242 | * Is keep-alive okay for all request methods? | |
2243 | */ | |
2244 | if (request->flags.mustKeepalive) | |
2245 | flags.keepalive = true; | |
2246 | else if (request->flags.pinned) | |
2247 | flags.keepalive = request->persistent(); | |
2248 | else if (!Config.onoff.server_pconns) | |
2249 | flags.keepalive = false; | |
2250 | else if (_peer == NULL) | |
2251 | flags.keepalive = true; | |
2252 | else if (_peer->stats.n_keepalives_sent < 10) | |
2253 | flags.keepalive = true; | |
2254 | else if ((double) _peer->stats.n_keepalives_recv / | |
2255 | (double) _peer->stats.n_keepalives_sent > 0.50) | |
2256 | flags.keepalive = true; | |
2257 | ||
2258 | if (_peer) { | |
2259 | /*The old code here was | |
2260 | if (neighborType(_peer, request->url) == PEER_SIBLING && ... | |
2261 | which is equivalent to: | |
2262 | if (neighborType(_peer, URL()) == PEER_SIBLING && ... | |
2263 | or better: | |
2264 | if (((_peer->type == PEER_MULTICAST && p->options.mcast_siblings) || | |
2265 | _peer->type == PEER_SIBLINGS ) && _peer->options.allow_miss) | |
2266 | flags.only_if_cached = 1; | |
2267 | ||
2268 | But I suppose it was a bug | |
2269 | */ | |
2270 | if (neighborType(_peer, request->url) == PEER_SIBLING && !_peer->options.allow_miss) | |
2271 | flags.only_if_cached = true; | |
2272 | ||
2273 | flags.front_end_https = _peer->front_end_https; | |
2274 | } | |
2275 | ||
2276 | mb.init(); | |
2277 | request->peer_host=_peer?_peer->host:NULL; | |
2278 | buildRequestPrefix(&mb); | |
2279 | ||
2280 | debugs(11, 2, "HTTP Server " << serverConnection); | |
2281 | debugs(11, 2, "HTTP Server REQUEST:\n---------\n" << mb.buf << "\n----------"); | |
2282 | ||
2283 | Comm::Write(serverConnection, &mb, requestSender); | |
2284 | return true; | |
2285 | } | |
2286 | ||
2287 | bool | |
2288 | HttpStateData::getMoreRequestBody(MemBuf &buf) | |
2289 | { | |
2290 | // parent's implementation can handle the no-encoding case | |
2291 | if (!flags.chunked_request) | |
2292 | return Client::getMoreRequestBody(buf); | |
2293 | ||
2294 | MemBuf raw; | |
2295 | ||
2296 | Must(requestBodySource != NULL); | |
2297 | if (!requestBodySource->getMoreData(raw)) | |
2298 | return false; // no request body bytes to chunk yet | |
2299 | ||
2300 | // optimization: pre-allocate buffer size that should be enough | |
2301 | const mb_size_t rawDataSize = raw.contentSize(); | |
2302 | // we may need to send: hex-chunk-size CRLF raw-data CRLF last-chunk | |
2303 | buf.init(16 + 2 + rawDataSize + 2 + 5, raw.max_capacity); | |
2304 | ||
2305 | buf.appendf("%x\r\n", static_cast<unsigned int>(rawDataSize)); | |
2306 | buf.append(raw.content(), rawDataSize); | |
2307 | buf.append("\r\n", 2); | |
2308 | ||
2309 | Must(rawDataSize > 0); // we did not accidently created last-chunk above | |
2310 | ||
2311 | // Do not send last-chunk unless we successfully received everything | |
2312 | if (receivedWholeRequestBody) { | |
2313 | Must(!flags.sentLastChunk); | |
2314 | flags.sentLastChunk = true; | |
2315 | buf.append("0\r\n\r\n", 5); | |
2316 | } | |
2317 | ||
2318 | return true; | |
2319 | } | |
2320 | ||
2321 | void | |
2322 | httpStart(FwdState *fwd) | |
2323 | { | |
2324 | debugs(11, 3, fwd->request->method << ' ' << fwd->entry->url()); | |
2325 | AsyncJob::Start(new HttpStateData(fwd)); | |
2326 | } | |
2327 | ||
2328 | void | |
2329 | HttpStateData::start() | |
2330 | { | |
2331 | if (!sendRequest()) { | |
2332 | debugs(11, 3, "httpStart: aborted"); | |
2333 | mustStop("HttpStateData::start failed"); | |
2334 | return; | |
2335 | } | |
2336 | ||
2337 | ++ statCounter.server.all.requests; | |
2338 | ++ statCounter.server.http.requests; | |
2339 | ||
2340 | /* | |
2341 | * We used to set the read timeout here, but not any more. | |
2342 | * Now its set in httpSendComplete() after the full request, | |
2343 | * including request body, has been written to the server. | |
2344 | */ | |
2345 | } | |
2346 | ||
2347 | /// if broken posts are enabled for the request, try to fix and return true | |
2348 | bool | |
2349 | HttpStateData::finishingBrokenPost() | |
2350 | { | |
2351 | #if USE_HTTP_VIOLATIONS | |
2352 | if (!Config.accessList.brokenPosts) { | |
2353 | debugs(11, 5, HERE << "No brokenPosts list"); | |
2354 | return false; | |
2355 | } | |
2356 | ||
2357 | ACLFilledChecklist ch(Config.accessList.brokenPosts, originalRequest(), NULL); | |
2358 | if (ch.fastCheck() != ACCESS_ALLOWED) { | |
2359 | debugs(11, 5, HERE << "didn't match brokenPosts"); | |
2360 | return false; | |
2361 | } | |
2362 | ||
2363 | if (!Comm::IsConnOpen(serverConnection)) { | |
2364 | debugs(11, 3, HERE << "ignoring broken POST for closed " << serverConnection); | |
2365 | assert(closeHandler != NULL); | |
2366 | return true; // prevent caller from proceeding as if nothing happened | |
2367 | } | |
2368 | ||
2369 | debugs(11, 3, "finishingBrokenPost: fixing broken POST"); | |
2370 | typedef CommCbMemFunT<HttpStateData, CommIoCbParams> Dialer; | |
2371 | requestSender = JobCallback(11,5, | |
2372 | Dialer, this, HttpStateData::wroteLast); | |
2373 | Comm::Write(serverConnection, "\r\n", 2, requestSender, NULL); | |
2374 | return true; | |
2375 | #else | |
2376 | return false; | |
2377 | #endif /* USE_HTTP_VIOLATIONS */ | |
2378 | } | |
2379 | ||
2380 | /// if needed, write last-chunk to end the request body and return true | |
2381 | bool | |
2382 | HttpStateData::finishingChunkedRequest() | |
2383 | { | |
2384 | if (flags.sentLastChunk) { | |
2385 | debugs(11, 5, HERE << "already sent last-chunk"); | |
2386 | return false; | |
2387 | } | |
2388 | ||
2389 | Must(receivedWholeRequestBody); // or we should not be sending last-chunk | |
2390 | flags.sentLastChunk = true; | |
2391 | ||
2392 | typedef CommCbMemFunT<HttpStateData, CommIoCbParams> Dialer; | |
2393 | requestSender = JobCallback(11,5, Dialer, this, HttpStateData::wroteLast); | |
2394 | Comm::Write(serverConnection, "0\r\n\r\n", 5, requestSender, NULL); | |
2395 | return true; | |
2396 | } | |
2397 | ||
2398 | void | |
2399 | HttpStateData::doneSendingRequestBody() | |
2400 | { | |
2401 | Client::doneSendingRequestBody(); | |
2402 | debugs(11,5, HERE << serverConnection); | |
2403 | ||
2404 | // do we need to write something after the last body byte? | |
2405 | if (flags.chunked_request && finishingChunkedRequest()) | |
2406 | return; | |
2407 | if (!flags.chunked_request && finishingBrokenPost()) | |
2408 | return; | |
2409 | ||
2410 | sendComplete(); | |
2411 | } | |
2412 | ||
2413 | // more origin request body data is available | |
2414 | void | |
2415 | HttpStateData::handleMoreRequestBodyAvailable() | |
2416 | { | |
2417 | if (eof || !Comm::IsConnOpen(serverConnection)) { | |
2418 | // XXX: we should check this condition in other callbacks then! | |
2419 | // TODO: Check whether this can actually happen: We should unsubscribe | |
2420 | // as a body consumer when the above condition(s) are detected. | |
2421 | debugs(11, DBG_IMPORTANT, HERE << "Transaction aborted while reading HTTP body"); | |
2422 | return; | |
2423 | } | |
2424 | ||
2425 | assert(requestBodySource != NULL); | |
2426 | ||
2427 | if (requestBodySource->buf().hasContent()) { | |
2428 | // XXX: why does not this trigger a debug message on every request? | |
2429 | ||
2430 | if (flags.headers_parsed && !flags.abuse_detected) { | |
2431 | flags.abuse_detected = true; | |
2432 | debugs(11, DBG_IMPORTANT, "http handleMoreRequestBodyAvailable: Likely proxy abuse detected '" << request->client_addr << "' -> '" << entry->url() << "'" ); | |
2433 | ||
2434 | if (virginReply()->sline.status() == Http::scInvalidHeader) { | |
2435 | closeServer(); | |
2436 | mustStop("HttpStateData::handleMoreRequestBodyAvailable"); | |
2437 | return; | |
2438 | } | |
2439 | } | |
2440 | } | |
2441 | ||
2442 | HttpStateData::handleMoreRequestBodyAvailable(); | |
2443 | } | |
2444 | ||
2445 | // premature end of the request body | |
2446 | void | |
2447 | HttpStateData::handleRequestBodyProducerAborted() | |
2448 | { | |
2449 | Client::handleRequestBodyProducerAborted(); | |
2450 | if (entry->isEmpty()) { | |
2451 | debugs(11, 3, "request body aborted: " << serverConnection); | |
2452 | // We usually get here when ICAP REQMOD aborts during body processing. | |
2453 | // We might also get here if client-side aborts, but then our response | |
2454 | // should not matter because either client-side will provide its own or | |
2455 | // there will be no response at all (e.g., if the the client has left). | |
2456 | ErrorState *err = new ErrorState(ERR_ICAP_FAILURE, Http::scInternalServerError, fwd->request); | |
2457 | err->detailError(ERR_DETAIL_SRV_REQMOD_REQ_BODY); | |
2458 | fwd->fail(err); | |
2459 | } | |
2460 | ||
2461 | abortTransaction("request body producer aborted"); | |
2462 | } | |
2463 | ||
2464 | // called when we wrote request headers(!) or a part of the body | |
2465 | void | |
2466 | HttpStateData::sentRequestBody(const CommIoCbParams &io) | |
2467 | { | |
2468 | if (io.size > 0) | |
2469 | statCounter.server.http.kbytes_out += io.size; | |
2470 | ||
2471 | Client::sentRequestBody(io); | |
2472 | } | |
2473 | ||
2474 | void | |
2475 | HttpStateData::abortAll(const char *reason) | |
2476 | { | |
2477 | debugs(11,5, HERE << "aborting transaction for " << reason << | |
2478 | "; " << serverConnection << ", this " << this); | |
2479 | mustStop(reason); | |
2480 | } | |
2481 |