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