client_side_request.cc
Go to the documentation of this file.
1/*
2 * Copyright (C) 1996-2022 The Squid Software Foundation and contributors
3 *
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
7 */
8
9/* DEBUG: section 85 Client-side Request Routines */
10
11/*
12 * General logic of request processing:
13 *
14 * We run a series of tests to determine if access will be permitted, and to do
15 * any redirection. Then we call into the result clientStream to retrieve data.
16 * From that point on it's up to reply management.
17 */
18
19#include "squid.h"
20#include "acl/FilledChecklist.h"
21#include "acl/Gadgets.h"
22#include "anyp/PortCfg.h"
23#include "base/AsyncJobCalls.h"
24#include "client_side.h"
25#include "client_side_reply.h"
26#include "client_side_request.h"
28#include "clientStream.h"
29#include "comm/Connection.h"
30#include "comm/Write.h"
31#include "error/Detail.h"
32#include "errorpage.h"
33#include "fd.h"
34#include "fde.h"
35#include "format/Token.h"
36#include "FwdState.h"
37#include "helper.h"
38#include "helper/Reply.h"
39#include "http.h"
40#include "http/Stream.h"
41#include "HttpHdrCc.h"
42#include "HttpReply.h"
43#include "HttpRequest.h"
44#include "ip/NfMarkConfig.h"
45#include "ip/QosConfig.h"
46#include "ipcache.h"
47#include "log/access_log.h"
48#include "MemObject.h"
49#include "Parsing.h"
50#include "proxyp/Header.h"
51#include "redirect.h"
52#include "rfc1738.h"
53#include "sbuf/StringConvert.h"
54#include "SquidConfig.h"
55#include "Store.h"
56#include "StrList.h"
57#include "tools.h"
58#include "wordlist.h"
59#if USE_AUTH
60#include "auth/UserRequest.h"
61#endif
62#if USE_ADAPTATION
64#include "adaptation/Answer.h"
65#include "adaptation/Iterator.h"
66#include "adaptation/Service.h"
67#if ICAP_CLIENT
69#endif
70#endif
71#if USE_OPENSSL
72#include "ssl/ServerBump.h"
73#include "ssl/support.h"
74#endif
75
76#if FOLLOW_X_FORWARDED_FOR
77static void clientFollowXForwardedForCheck(Acl::Answer answer, void *data);
78#endif /* FOLLOW_X_FORWARDED_FOR */
79
81
83
84/* Local functions */
85/* other */
86static void clientAccessCheckDoneWrapper(Acl::Answer, void *);
87#if USE_OPENSSL
89#endif
90static int clientHierarchical(ClientHttpRequest * http);
94static void checkNoCacheDoneWrapper(Acl::Answer, void *);
99
101{
102 /*
103 * Release our "lock" on our parent, ClientHttpRequest, if we
104 * still have one
105 */
106
107 if (http)
109
110 delete error;
111 debugs(85,3, "ClientRequestContext destructed, this=" << this);
112}
113
115 http(cbdataReference(anHttp))
116{
117 debugs(85, 3, "ClientRequestContext constructed, this=" << this);
118}
119
121
123#if USE_ADAPTATION
124 AsyncJob("ClientHttpRequest"),
125#endif
126 al(new AccessLogEntry()),
127 conn_(cbdataReference(aConn))
128{
131 if (aConn) {
132 al->tcpClient = aConn->clientConnection;
133 al->cache.port = aConn->port;
134 al->cache.caddr = aConn->log_addr;
136 al->updateError(aConn->bareError);
137
138#if USE_OPENSSL
139 if (aConn->clientConnection != nullptr && aConn->clientConnection->isOpen()) {
140 if (auto ssl = fd_table[aConn->clientConnection->fd].ssl.get())
141 al->cache.sslClientCert.resetWithoutLocking(SSL_get_peer_certificate(ssl));
142 }
143#endif
144 }
146}
147
148/*
149 * returns true if client specified that the object must come from the cache
150 * without contacting origin server
151 */
152bool
154{
156 return request->cache_control &&
158}
159
172static void
174{
175 // Can be set at compile time with -D compiler flag
176#ifndef FAILURE_MODE_TIME
177#define FAILURE_MODE_TIME 300
178#endif
179
180 if (hcode == HIER_NONE)
181 return;
182
183 // don't bother when ICP is disabled.
184 if (Config.Port.icp <= 0)
185 return;
186
187 static double magic_factor = 100.0;
188 double n_good;
189 double n_bad;
190
191 n_good = magic_factor / (1.0 + request_failure_ratio);
192
193 n_bad = magic_factor - n_good;
194
195 switch (etype) {
196
197 case ERR_DNS_FAIL:
198
199 case ERR_CONNECT_FAIL:
201
202 case ERR_READ_ERROR:
203 ++n_bad;
204 break;
205
206 default:
207 ++n_good;
208 }
209
210 request_failure_ratio = n_bad / n_good;
211
213 return;
214
215 if (request_failure_ratio < 1.0)
216 return;
217
218 debugs(33, DBG_CRITICAL, "WARNING: Failure Ratio at "<< std::setw(4)<<
219 std::setprecision(3) << request_failure_ratio);
220
221 debugs(33, DBG_CRITICAL, "WARNING: ICP going into HIT-only mode for " <<
222 FAILURE_MODE_TIME / 60 << " minutes...");
223
225
226 request_failure_ratio = 0.8; /* reset to something less than 1.0 */
227}
228
230{
231 debugs(33, 3, "httpRequestFree: " << uri);
232
233 // Even though freeResources() below may destroy the request,
234 // we no longer set request->body_pipe to NULL here
235 // because we did not initiate that pipe (ConnStateData did)
236
237 /* the ICP check here was erroneous
238 * - StoreEntry::releaseRequest was always called if entry was valid
239 */
240
241 logRequest();
242
243 loggingEntry(nullptr);
244
245 if (request)
247
249
250#if USE_ADAPTATION
252
253 if (adaptedBodySource != nullptr)
255#endif
256
257 delete calloutContext;
258
259 if (conn_)
261
262 /* moving to the next connection is handled by the context free */
264}
265
275int
276clientBeginRequest(const HttpRequestMethod& method, char const *url, CSCB * streamcallback,
277 CSD * streamdetach, ClientStreamData streamdata, HttpHeader const *header,
278 char *tailbuf, size_t taillen, const MasterXaction::Pointer &mx)
279{
280 size_t url_sz;
281 ClientHttpRequest *http = new ClientHttpRequest(nullptr);
283 StoreIOBuffer tempBuffer;
284 if (http->al != nullptr)
286 /* this is only used to adjust the connection offset in client_side.c */
287 http->req_sz = 0;
288 tempBuffer.length = taillen;
289 tempBuffer.data = tailbuf;
290 /* client stream setup */
292 clientReplyStatus, new clientReplyContext(http), streamcallback,
293 streamdetach, streamdata, tempBuffer);
294 /* make it visible in the 'current acctive requests list' */
295 /* Set flags */
296 /* internal requests only makes sense in an
297 * accelerator today. TODO: accept flags ? */
298 http->flags.accel = true;
299 /* allow size for url rewriting */
300 url_sz = strlen(url) + Config.appendDomainLen + 5;
301 http->uri = (char *)xcalloc(url_sz, 1);
302 strcpy(http->uri, url); // XXX: polluting http->uri before parser validation
303
304 request = HttpRequest::FromUrlXXX(http->uri, mx, method);
305 if (!request) {
306 debugs(85, 5, "Invalid URL: " << http->uri);
307 return -1;
308 }
309
310 /*
311 * now update the headers in request with our supplied headers.
312 * HttpRequest::FromUrl() should return a blank header set, but
313 * we use Update to be sure of correctness.
314 */
315 if (header)
316 request->header.update(header);
317
318 /* http struct now ready */
319
320 /*
321 * build new header list *? TODO
322 */
323 request->flags.accelerated = http->flags.accel;
324
325 /* this is an internally created
326 * request, not subject to acceleration
327 * target overrides */
328 // TODO: detect and handle internal requests of internal objects?
329
330 /* Internally created requests cannot have bodies today */
332
333 request->client_addr.setNoAddr();
334
335#if FOLLOW_X_FORWARDED_FOR
336 request->indirect_client_addr.setNoAddr();
337#endif /* FOLLOW_X_FORWARDED_FOR */
338
339 request->my_addr.setNoAddr(); /* undefined for internal requests */
340
341 request->my_addr.port(0);
342
343 request->http_ver = Http::ProtocolVersion();
344
345 http->initRequest(request);
346
347 /* optional - skip the access check ? */
348 http->calloutContext = new ClientRequestContext(http);
349
350 http->calloutContext->http_access_done = false;
351
352 http->calloutContext->redirect_done = true;
353
354 http->calloutContext->no_cache_done = true;
355
356 http->doCallouts();
357
358 return 0;
359}
360
361bool
363{
364 ClientHttpRequest *http_ = http;
365
366 if (cbdataReferenceValid(http_))
367 return true;
368
369 http = nullptr;
370
371 cbdataReferenceDone(http_);
372
373 return false;
374}
375
376#if FOLLOW_X_FORWARDED_FOR
391static void
393{
394 ClientRequestContext *calloutContext = (ClientRequestContext *) data;
395
396 if (!calloutContext->httpStateIsValid())
397 return;
398
399 ClientHttpRequest *http = calloutContext->http;
400 HttpRequest *request = http->request;
401
402 if (answer.allowed() && request->x_forwarded_for_iterator.size() != 0) {
403
404 /*
405 * Remove the last comma-delimited element from the
406 * x_forwarded_for_iterator and use it to repeat the cycle.
407 */
408 const char *p;
409 const char *asciiaddr;
410 int l;
411 Ip::Address addr;
412 p = request->x_forwarded_for_iterator.termedBuf();
413 l = request->x_forwarded_for_iterator.size();
414
415 /*
416 * XXX x_forwarded_for_iterator should really be a list of
417 * IP addresses, but it's a String instead. We have to
418 * walk backwards through the String, biting off the last
419 * comma-delimited part each time. As long as the data is in
420 * a String, we should probably implement and use a variant of
421 * strListGetItem() that walks backwards instead of forwards
422 * through a comma-separated list. But we don't even do that;
423 * we just do the work in-line here.
424 */
425 /* skip trailing space and commas */
426 while (l > 0 && (p[l-1] == ',' || xisspace(p[l-1])))
427 --l;
428 request->x_forwarded_for_iterator.cut(l);
429 /* look for start of last item in list */
430 while (l > 0 && ! (p[l-1] == ',' || xisspace(p[l-1])))
431 --l;
432 asciiaddr = p+l;
433 if ((addr = asciiaddr)) {
434 request->indirect_client_addr = addr;
435 request->x_forwarded_for_iterator.cut(l);
438 /* override the default src_addr tested if we have to go deeper than one level into XFF */
439 Filled(calloutContext->acl_checklist)->src_addr = request->indirect_client_addr;
440 }
442 return;
443 }
444 }
445
446 /* clean up, and pass control to clientAccessCheck */
448 /*
449 * Ensure that the access log shows the indirect client
450 * instead of the direct client.
451 */
452 http->al->cache.caddr = request->indirect_client_addr;
453 if (ConnStateData *conn = http->getConn())
454 conn->log_addr = request->indirect_client_addr;
455 }
456 request->x_forwarded_for_iterator.clean();
457 request->flags.done_follow_x_forwarded_for = true;
458
459 if (answer.conflicted()) {
460 debugs(28, DBG_CRITICAL, "ERROR: Processing X-Forwarded-For. Stopping at IP address: " << request->indirect_client_addr );
461 }
462
463 /* process actual access ACL as normal. */
464 calloutContext->clientAccessCheck();
465}
466#endif /* FOLLOW_X_FORWARDED_FOR */
467
468static void
470{
471 ClientRequestContext *c = static_cast<ClientRequestContext*>(data);
472 c->hostHeaderIpVerify(ia, dns);
473}
474
475void
477{
479
480 // note the DNS details for the transaction stats.
482
483 // Is the NAT destination IP in DNS?
484 if (ia && ia->have(clientConn->local)) {
485 debugs(85, 3, "validate IP " << clientConn->local << " possible from Host:");
487 http->doCallouts();
488 return;
489 }
490 debugs(85, 3, "FAIL: validate IP " << clientConn->local << " possible from Host:");
491 hostHeaderVerifyFailed("local IP", "any domain IP");
492}
493
494void
496{
497 // IP address validation for Host: failed. Admin wants to ignore them.
498 // NP: we do not yet handle CONNECT tunnels well, so ignore for them
500 debugs(85, 3, "SECURITY ALERT: Host header forgery detected on " << http->getConn()->clientConnection <<
501 " (" << A << " does not match " << B << ") on URL: " << http->request->effectiveRequestUri());
502
503 // NP: it is tempting to use 'flags.noCache' but that is all about READing cache data.
504 // The problems here are about WRITE for new cache content, which means flags.cachable
505 http->request->flags.cachable = false; // MUST NOT cache (for now)
506 // XXX: when we have updated the cache key to base on raw-IP + URI this cacheable limit can go.
507 http->request->flags.hierarchical = false; // MUST NOT pass to peers (for now)
508 // XXX: when we have sorted out the best way to relay requests properly to peers this hierarchical limit can go.
509 http->doCallouts();
510 return;
511 }
512
513 debugs(85, DBG_IMPORTANT, "SECURITY ALERT: Host header forgery detected on " <<
514 http->getConn()->clientConnection << " (" << A << " does not match " << B << ")");
515 if (const char *ua = http->request->header.getStr(Http::HdrType::USER_AGENT))
516 debugs(85, DBG_IMPORTANT, "SECURITY ALERT: By user agent: " << ua);
517 debugs(85, DBG_IMPORTANT, "SECURITY ALERT: on URL: " << http->request->effectiveRequestUri());
518
519 // IP address validation for Host: failed. reject the connection.
521 clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
522 assert (repContext);
523 repContext->setReplyToError(ERR_CONFLICT_HOST, Http::scConflict,
524 nullptr,
525 http->getConn(),
526 http->request,
527 nullptr,
528#if USE_AUTH
529 http->getConn() != nullptr && http->getConn()->getAuth() != nullptr ?
531#else
532 NULL);
533#endif
535 clientStreamRead(node, http, node->readBuffer);
536}
537
538void
540{
541 // Require a Host: header.
542 const char *host = http->request->header.getStr(Http::HdrType::HOST);
543
544 if (!host) {
545 // TODO: dump out the HTTP/1.1 error about missing host header.
546 // otherwise this is fine, can't forge a header value when its not even set.
547 debugs(85, 3, "validate skipped with no Host: header present.");
548 http->doCallouts();
549 return;
550 }
551
552 if (http->request->flags.internal) {
553 // TODO: kill this when URL handling allows partial URLs out of accel mode
554 // and we no longer screw with the URL just to add our internal host there
555 debugs(85, 6, "validate skipped due to internal composite URL.");
556 http->doCallouts();
557 return;
558 }
559
560 // Locate if there is a port attached, strip ready for IP lookup
561 char *portStr = nullptr;
562 char *hostB = xstrdup(host);
563 host = hostB;
564 if (host[0] == '[') {
565 // IPv6 literal.
566 portStr = strchr(hostB, ']');
567 if (portStr && *(++portStr) != ':') {
568 portStr = nullptr;
569 }
570 } else {
571 // Domain or IPv4 literal with port
572 portStr = strrchr(hostB, ':');
573 }
574
575 uint16_t port = 0;
576 if (portStr) {
577 *portStr = '\0'; // strip the ':'
578 if (*(++portStr) != '\0') {
579 char *end = nullptr;
580 int64_t ret = strtoll(portStr, &end, 10);
581 if (end == portStr || *end != '\0' || ret < 1 || ret > 0xFFFF) {
582 // invalid port details. Replace the ':'
583 *(--portStr) = ':';
584 portStr = nullptr;
585 } else
586 port = (ret & 0xFFFF);
587 }
588 }
589
590 debugs(85, 3, "validate host=" << host << ", port=" << port << ", portStr=" << (portStr?portStr:"NULL"));
592 // verify the Host: port (if any) matches the apparent destination
593 if (portStr && port != http->getConn()->clientConnection->local.port()) {
594 debugs(85, 3, "FAIL on validate port " << http->getConn()->clientConnection->local.port() <<
595 " matches Host: port " << port << " (" << portStr << ")");
596 hostHeaderVerifyFailed("intercepted port", portStr);
597 } else {
598 // XXX: match the scheme default port against the apparent destination
599
600 // verify the destination DNS is one of the Host: headers IPs
602 }
603 } else if (!Config.onoff.hostStrictVerify) {
604 debugs(85, 3, "validate skipped.");
605 http->doCallouts();
606 } else if (strlen(host) != strlen(http->request->url.host())) {
607 // Verify forward-proxy requested URL domain matches the Host: header
608 debugs(85, 3, "FAIL on validate URL domain length " << http->request->url.host() << " matches Host: " << host);
610 } else if (matchDomainName(host, http->request->url.host()) != 0) {
611 // Verify forward-proxy requested URL domain matches the Host: header
612 debugs(85, 3, "FAIL on validate URL domain " << http->request->url.host() << " matches Host: " << host);
614 } else if (portStr && port != http->request->url.port()) {
615 // Verify forward-proxy requested URL domain matches the Host: header
616 debugs(85, 3, "FAIL on validate URL port " << http->request->url.port() << " matches Host: port " << portStr);
617 hostHeaderVerifyFailed("URL port", portStr);
618 } else if (!portStr && http->request->method != Http::METHOD_CONNECT && http->request->url.port() != http->request->url.getScheme().defaultPort()) {
619 // Verify forward-proxy requested URL domain matches the Host: header
620 // Special case: we don't have a default-port to check for CONNECT. Assume URL is correct.
621 debugs(85, 3, "FAIL on validate URL port " << http->request->url.port() << " matches Host: default port " << http->request->url.getScheme().defaultPort());
622 hostHeaderVerifyFailed("URL port", "default port");
623 } else {
624 // Okay no problem.
625 debugs(85, 3, "validate passed.");
627 http->doCallouts();
628 }
629 safe_free(hostB);
630}
631
632/* This is the entry point for external users of the client_side routines */
633void
635{
636#if FOLLOW_X_FORWARDED_FOR
637 if (!http->request->flags.doneFollowXff() &&
640
641 /* we always trust the direct client address for actual use */
644
645 /* setup the XFF iterator for processing */
647
648 /* begin by checking to see if we trust direct client enough to walk XFF */
651 return;
652 }
653#endif
654
655 if (Config.accessList.http) {
658 } else {
659 debugs(0, DBG_CRITICAL, "No http_access configuration found. This will block ALL traffic");
661 }
662}
663
669void
671{
675 } else {
676 debugs(85, 2, "No adapted_http_access configuration. default: ALLOW");
678 }
679}
680
681void
683{
684 ClientRequestContext *calloutContext = (ClientRequestContext *) data;
685
686 if (!calloutContext->httpStateIsValid())
687 return;
688
689 calloutContext->clientAccessCheckDone(answer);
690}
691
692void
694{
695 acl_checklist = nullptr;
696 err_type page_id;
697 Http::StatusCode status;
698 debugs(85, 2, "The request " << http->request->method << ' ' <<
699 http->uri << " is " << answer <<
700 "; last ACL checked: " << (AclMatchedName ? AclMatchedName : "[none]"));
701
702#if USE_AUTH
703 char const *proxy_auth_msg = "<null>";
704 if (http->getConn() != nullptr && http->getConn()->getAuth() != nullptr)
705 proxy_auth_msg = http->getConn()->getAuth()->denyMessage("<null>");
706 else if (http->request->auth_user_request != nullptr)
707 proxy_auth_msg = http->request->auth_user_request->denyMessage("<null>");
708#endif
709
710 if (!answer.allowed()) {
711 // auth has a grace period where credentials can be expired but okay not to challenge.
712
713 /* Send an auth challenge or error */
714 // XXX: do we still need aclIsProxyAuth() ?
715 bool auth_challenge = (answer == ACCESS_AUTH_REQUIRED || aclIsProxyAuth(AclMatchedName));
716 debugs(85, 5, "Access Denied: " << http->uri);
717 debugs(85, 5, "AclMatchedName = " << (AclMatchedName ? AclMatchedName : "<null>"));
718#if USE_AUTH
719 if (auth_challenge)
720 debugs(33, 5, "Proxy Auth Message = " << (proxy_auth_msg ? proxy_auth_msg : "<null>"));
721#endif
722
723 /*
724 * NOTE: get page_id here, based on AclMatchedName because if
725 * USE_DELAY_POOLS is enabled, then AclMatchedName gets clobbered in
726 * the clientCreateStoreEntry() call just below. Pedro Ribeiro
727 * <pribeiro@isel.pt>
728 */
730
732
733 if (auth_challenge) {
734#if USE_AUTH
735 if (http->request->flags.sslBumped) {
736 /*SSL Bumped request, authentication is not possible*/
737 status = Http::scForbidden;
738 } else if (!http->flags.accel) {
739 /* Proxy authorisation needed */
741 } else {
742 /* WWW authorisation needed */
743 status = Http::scUnauthorized;
744 }
745#else
746 // need auth, but not possible to do.
747 status = Http::scForbidden;
748#endif
749 if (page_id == ERR_NONE)
750 page_id = ERR_CACHE_ACCESS_DENIED;
751 } else {
752 status = Http::scForbidden;
753
754 if (page_id == ERR_NONE)
755 page_id = ERR_ACCESS_DENIED;
756 }
757
758 error = clientBuildError(page_id, status, nullptr, http->getConn(), http->request, http->al);
759
760#if USE_AUTH
762 http->getConn() != nullptr && http->getConn()->getAuth() != nullptr ?
764#endif
765
766 readNextRequest = true;
767 }
768
769 /* ACCESS_ALLOWED continues here ... */
770 xfree(http->uri);
772 http->doCallouts();
773}
774
775#if USE_ADAPTATION
776void
778{
779 debugs(93,3, this << " adaptationAclCheckDone called");
780
781#if ICAP_CLIENT
783 if (ih != nullptr) {
784 if (getConn() != nullptr && getConn()->clientConnection != nullptr) {
785 ih->rfc931 = getConn()->clientConnection->rfc931;
786#if USE_OPENSSL
787 if (getConn()->clientConnection->isOpen()) {
788 ih->ssluser = sslGetUserEmail(fd_table[getConn()->clientConnection->fd].ssl.get());
789 }
790#endif
791 }
792 ih->log_uri = log_uri;
793 ih->req_sz = req_sz;
794 }
795#endif
796
797 if (!g) {
798 debugs(85,3, "no adaptation needed");
799 doCallouts();
800 return;
801 }
802
804}
805
806#endif
807
808static void
810{
812 ClientHttpRequest *http = context->http;
813 context->acl_checklist = nullptr;
814
815 if (answer.allowed())
817 else {
818 Helper::Reply const nilReply(Helper::Error);
819 context->clientRedirectDone(nilReply);
820 }
821}
822
823void
825{
826 debugs(33, 5, "'" << http->uri << "'");
831 } else
833}
834
839static void
841{
842 ClientRequestContext *context = static_cast<ClientRequestContext *>(data);
843 ClientHttpRequest *http = context->http;
844 context->acl_checklist = nullptr;
845
846 if (answer.allowed())
848 else {
849 debugs(85, 3, "access denied expected ERR reply handling: " << answer);
850 Helper::Reply const nilReply(Helper::Error);
851 context->clientStoreIdDone(nilReply);
852 }
853}
854
860void
862{
863 debugs(33, 5,"'" << http->uri << "'");
864
868 } else
870}
871
872static int
874{
875 HttpRequest *request = http->request;
877
878 // intercepted requests MUST NOT (yet) be sent to peers unless verified
879 if (!request->flags.hostVerified && (request->flags.intercepted || request->flags.interceptTproxy))
880 return 0;
881
882 /*
883 * IMS needs a private key, so we can use the hierarchy for IMS only if our
884 * neighbors support private keys
885 */
886
887 if (request->flags.ims && !neighbors_do_private_keys)
888 return 0;
889
890 /*
891 * This is incorrect: authenticating requests can be sent via a hierarchy
892 * (they can even be cached if the correct headers are set on the reply)
893 */
894 if (request->flags.auth)
895 return 0;
896
897 if (method == Http::METHOD_TRACE)
898 return 1;
899
900 if (method != Http::METHOD_GET)
901 return 0;
902
903 if (request->flags.loopDetected)
904 return 0;
905
906 if (request->url.getScheme() == AnyP::PROTO_HTTP)
907 return method.respMaybeCacheable();
908
909 if (request->url.getScheme() == AnyP::PROTO_CACHE_OBJECT)
910 return 0;
911
912 return 1;
913}
914
915static void
917{
918 HttpRequest *request = http->request;
919 HttpHeader *req_hdr = &request->header;
920 ConnStateData *http_conn = http->getConn();
921
922 /* Internal requests such as those from ESI includes may be without
923 * a client connection
924 */
925 if (!http_conn)
926 return;
927
928 request->flags.connectionAuthDisabled = http_conn->port->connection_auth_disabled;
929 if (!request->flags.connectionAuthDisabled) {
930 if (Comm::IsConnOpen(http_conn->pinning.serverConnection)) {
931 if (http_conn->pinning.auth) {
932 request->flags.connectionAuth = true;
933 request->flags.auth = true;
934 } else {
935 request->flags.connectionProxyAuth = true;
936 }
937 // These should already be linked correctly.
938 assert(request->clientConnectionManager == http_conn);
939 }
940 }
941
942 /* check if connection auth is used, and flag as candidate for pinning
943 * in such case.
944 * Note: we may need to set flags.connectionAuth even if the connection
945 * is already pinned if it was pinned earlier due to proxy auth
946 */
947 if (!request->flags.connectionAuth) {
951 int may_pin = 0;
952 while ((e = req_hdr->getEntry(&pos))) {
954 const char *value = e->value.rawBuf();
955 if (strncasecmp(value, "NTLM ", 5) == 0
956 ||
957 strncasecmp(value, "Negotiate ", 10) == 0
958 ||
959 strncasecmp(value, "Kerberos ", 9) == 0) {
961 request->flags.connectionAuth = true;
962 may_pin = 1;
963 } else {
964 request->flags.connectionProxyAuth = true;
965 may_pin = 1;
966 }
967 }
968 }
969 }
970 if (may_pin && !request->pinnedConnection()) {
971 // These should already be linked correctly. Just need the ServerConnection to pinn.
972 assert(request->clientConnectionManager == http_conn);
973 }
974 }
975 }
976}
977
978static void
980{
981 HttpRequest *request = http->request;
982 HttpHeader *req_hdr = &request->header;
983 bool no_cache = false;
984
985 request->imslen = -1;
987
988 if (request->ims > 0)
989 request->flags.ims = true;
990
991 if (!request->flags.ignoreCc) {
992 if (request->cache_control) {
993 if (request->cache_control->hasNoCache())
994 no_cache=true;
995
996 // RFC 2616: treat Pragma:no-cache as if it was Cache-Control:no-cache when Cache-Control is missing
997 } else if (req_hdr->has(Http::HdrType::PRAGMA))
998 no_cache = req_hdr->hasListMember(Http::HdrType::PRAGMA,"no-cache",',');
999 }
1000
1002 no_cache=true;
1003 }
1004
1005 if (no_cache) {
1006#if USE_HTTP_VIOLATIONS
1007
1009 request->flags.nocacheHack = true;
1010 else if (refresh_nocache_hack)
1011 request->flags.nocacheHack = true;
1012 else
1013#endif
1014
1015 request->flags.noCache = true;
1016 }
1017
1018 /* ignore range header in non-GETs or non-HEADs */
1020 // XXX: initialize if we got here without HttpRequest::parseHeader()
1021 if (!request->range)
1022 request->range = req_hdr->getRange();
1023
1024 if (request->range) {
1025 request->flags.isRanged = true;
1027 /* XXX: This is suboptimal. We should give the stream the range set,
1028 * and thereby let the top of the stream set the offset when the
1029 * size becomes known. As it is, we will end up requesting from 0
1030 * for evey -X range specification.
1031 * RBC - this may be somewhat wrong. We should probably set the range
1032 * iter up at this point.
1033 */
1034 node->readBuffer.offset = request->range->lowestOffset(0);
1035 }
1036 }
1037
1038 /* Only HEAD and GET requests permit a Range or Request-Range header.
1039 * If these headers appear on any other type of request, delete them now.
1040 */
1041 else {
1042 req_hdr->delById(Http::HdrType::RANGE);
1044 request->ignoreRange("neither HEAD nor GET");
1045 }
1046
1047 if (req_hdr->has(Http::HdrType::AUTHORIZATION))
1048 request->flags.auth = true;
1049
1050 clientCheckPinning(http);
1051
1052 if (!request->url.userInfo().isEmpty())
1053 request->flags.auth = true;
1054
1055 if (req_hdr->has(Http::HdrType::VIA)) {
1056 String s = req_hdr->getList(Http::HdrType::VIA);
1057 /*
1058 * ThisCache cannot be a member of Via header, "1.1 ThisCache" can.
1059 * Note ThisCache2 has a space prepended to the hostname so we don't
1060 * accidentally match super-domains.
1061 */
1062
1063 if (strListIsSubstr(&s, ThisCache2, ',')) {
1064 request->flags.loopDetected = true;
1065 }
1066
1067#if USE_FORW_VIA_DB
1069
1070#endif
1071
1072 s.clean();
1073 }
1074
1075 // headers only relevant to reverse-proxy
1076 if (request->flags.accelerated) {
1077 // check for a cdn-info member with a cdn-id matching surrogate_id
1078 // XXX: HttpHeader::hasListMember() does not handle OWS around ";" yet
1080 request->flags.loopDetected = true;
1081 }
1082
1083 if (request->flags.loopDetected) {
1084 debugObj(33, DBG_IMPORTANT, "WARNING: Forwarding loop detected for:\n",
1086 }
1087
1088#if USE_FORW_VIA_DB
1089
1090 if (req_hdr->has(Http::HdrType::X_FORWARDED_FOR)) {
1093 s.clean();
1094 }
1095
1096#endif
1097
1098 request->flags.cachable = http->request->maybeCacheable();
1099
1100 if (clientHierarchical(http))
1101 request->flags.hierarchical = true;
1102
1103 debugs(85, 5, "clientInterpretRequestHeaders: REQ_NOCACHE = " <<
1104 (request->flags.noCache ? "SET" : "NOT SET"));
1105 debugs(85, 5, "clientInterpretRequestHeaders: REQ_CACHABLE = " <<
1106 (request->flags.cachable ? "SET" : "NOT SET"));
1107 debugs(85, 5, "clientInterpretRequestHeaders: REQ_HIERARCHICAL = " <<
1108 (request->flags.hierarchical ? "SET" : "NOT SET"));
1109
1110}
1111
1112void
1114{
1115 ClientRequestContext *calloutContext = (ClientRequestContext *)data;
1116
1117 if (!calloutContext->httpStateIsValid())
1118 return;
1119
1120 calloutContext->clientRedirectDone(result);
1121}
1122
1123void
1124clientStoreIdDoneWrapper(void *data, const Helper::Reply &result)
1125{
1126 ClientRequestContext *calloutContext = (ClientRequestContext *)data;
1127
1128 if (!calloutContext->httpStateIsValid())
1129 return;
1130
1131 calloutContext->clientStoreIdDone(result);
1132}
1133
1134void
1136{
1137 HttpRequest *old_request = http->request;
1138 debugs(85, 5, "'" << http->uri << "' result=" << reply);
1141
1142 // Put helper response Notes into the transaction state record (ALE) eventually
1143 // do it early to ensure that no matter what the outcome the notes are present.
1144 if (http->al)
1145 http->al->syncNotes(old_request);
1146
1147 UpdateRequestNotes(http->getConn(), *old_request, reply.notes);
1148
1149 switch (reply.result) {
1150 case Helper::TimedOut:
1152 static const auto d = MakeNamedErrorDetail("REDIRECTOR_TIMEDOUT");
1154 debugs(85, DBG_IMPORTANT, "ERROR: URL rewrite helper: Timedout");
1155 }
1156 break;
1157
1158 case Helper::Unknown:
1159 case Helper::TT:
1160 // Handler in redirect.cc should have already mapped Unknown
1161 // IF it contained valid entry for the old URL-rewrite helper protocol
1162 debugs(85, DBG_IMPORTANT, "ERROR: URL rewrite helper returned invalid result code. Wrong helper? " << reply);
1163 break;
1164
1166 debugs(85, DBG_IMPORTANT, "ERROR: URL rewrite helper: " << reply);
1167 break;
1168
1169 case Helper::Error:
1170 // no change to be done.
1171 break;
1172
1173 case Helper::Okay: {
1174 // #1: redirect with a specific status code OK status=NNN url="..."
1175 // #2: redirect with a default status code OK url="..."
1176 // #3: re-write the URL OK rewrite-url="..."
1177
1178 const char *statusNote = reply.notes.findFirst("status");
1179 const char *urlNote = reply.notes.findFirst("url");
1180
1181 if (urlNote != nullptr) {
1182 // HTTP protocol redirect to be done.
1183
1184 // TODO: change default redirect status for appropriate requests
1185 // Squid defaults to 302 status for now for better compatibility with old clients.
1186 // HTTP/1.0 client should get 302 (Http::scFound)
1187 // HTTP/1.1 client contacting reverse-proxy should get 307 (Http::scTemporaryRedirect)
1188 // HTTP/1.1 client being diverted by forward-proxy should get 303 (Http::scSeeOther)
1190 if (statusNote != nullptr) {
1191 const char * result = statusNote;
1192 status = static_cast<Http::StatusCode>(atoi(result));
1193 }
1194
1195 if (status == Http::scMovedPermanently
1196 || status == Http::scFound
1197 || status == Http::scSeeOther
1198 || status == Http::scPermanentRedirect
1199 || status == Http::scTemporaryRedirect) {
1200 http->redirect.status = status;
1201 http->redirect.location = xstrdup(urlNote);
1202 // TODO: validate the URL produced here is RFC 2616 compliant absolute URI
1203 } else {
1204 debugs(85, DBG_CRITICAL, "ERROR: URL-rewrite produces invalid " << status << " redirect Location: " << urlNote);
1205 }
1206 } else {
1207 // URL-rewrite wanted. Ew.
1208 urlNote = reply.notes.findFirst("rewrite-url");
1209
1210 // prevent broken helpers causing too much damage. If old URL == new URL skip the re-write.
1211 if (urlNote != nullptr && strcmp(urlNote, http->uri)) {
1212 AnyP::Uri tmpUrl;
1213 if (tmpUrl.parse(old_request->method, SBuf(urlNote))) {
1214 HttpRequest *new_request = old_request->clone();
1215 new_request->url = tmpUrl;
1216 debugs(61, 2, "URL-rewriter diverts URL from " << old_request->effectiveRequestUri() << " to " << new_request->effectiveRequestUri());
1217
1218 // update the new request to flag the re-writing was done on it
1219 new_request->flags.redirected = true;
1220
1221 // unlink bodypipe from the old request. Not needed there any longer.
1222 if (old_request->body_pipe != nullptr) {
1223 old_request->body_pipe = nullptr;
1224 debugs(61,2, "URL-rewriter diverts body_pipe " << new_request->body_pipe <<
1225 " from request " << old_request << " to " << new_request);
1226 }
1227
1228 http->resetRequest(new_request);
1229 old_request = nullptr;
1230 } else {
1231 debugs(85, DBG_CRITICAL, "ERROR: URL-rewrite produces invalid request: " <<
1232 old_request->method << " " << urlNote << " " << old_request->http_ver);
1233 }
1234 }
1235 }
1236 }
1237 break;
1238 }
1239
1240 /* XXX PIPELINE: This is inaccurate during pipelining */
1241
1242 if (http->getConn() != nullptr && Comm::IsConnOpen(http->getConn()->clientConnection))
1244
1245 assert(http->uri);
1246
1247 http->doCallouts();
1248}
1249
1253void
1255{
1256 HttpRequest *old_request = http->request;
1257 debugs(85, 5, "'" << http->uri << "' result=" << reply);
1260
1261 // Put helper response Notes into the transaction state record (ALE) eventually
1262 // do it early to ensure that no matter what the outcome the notes are present.
1263 if (http->al)
1264 http->al->syncNotes(old_request);
1265
1266 UpdateRequestNotes(http->getConn(), *old_request, reply.notes);
1267
1268 switch (reply.result) {
1269 case Helper::Unknown:
1270 case Helper::TT:
1271 // Handler in redirect.cc should have already mapped Unknown
1272 // IF it contained valid entry for the old helper protocol
1273 debugs(85, DBG_IMPORTANT, "ERROR: storeID helper returned invalid result code. Wrong helper? " << reply);
1274 break;
1275
1276 case Helper::TimedOut:
1277 // Timeouts for storeID are not implemented
1279 debugs(85, DBG_IMPORTANT, "ERROR: storeID helper: " << reply);
1280 break;
1281
1282 case Helper::Error:
1283 // no change to be done.
1284 break;
1285
1286 case Helper::Okay: {
1287 const char *urlNote = reply.notes.findFirst("store-id");
1288
1289 // prevent broken helpers causing too much damage. If old URL == new URL skip the re-write.
1290 if (urlNote != nullptr && strcmp(urlNote, http->uri) ) {
1291 // Debug section required for some very specific cases.
1292 debugs(85, 9, "Setting storeID with: " << urlNote );
1293 http->request->store_id = urlNote;
1294 http->store_id = urlNote;
1295 }
1296 }
1297 break;
1298 }
1299
1300 http->doCallouts();
1301}
1302
1306void
1308{
1312 } else {
1313 /* unless otherwise specified, we try to cache. */
1315 }
1316}
1317
1318static void
1320{
1321 ClientRequestContext *calloutContext = (ClientRequestContext *) data;
1322
1323 if (!calloutContext->httpStateIsValid())
1324 return;
1325
1326 calloutContext->checkNoCacheDone(answer);
1327}
1328
1329void
1331{
1332 acl_checklist = nullptr;
1333 if (answer.denied()) {
1334 http->request->flags.noCache = true; // do not read reply from cache
1335 http->request->flags.cachable = false; // do not store reply into cache
1336 }
1337 http->doCallouts();
1338}
1339
1340#if USE_OPENSSL
1341bool
1343{
1344 if (!http->getConn()) {
1345 http->al->ssl.bumpMode = Ssl::bumpEnd; // SslBump does not apply; log -
1346 return false;
1347 }
1348
1350 if (http->request->flags.forceTunnel) {
1351 debugs(85, 5, "not needed; already decided to tunnel " << http->getConn());
1352 if (bumpMode != Ssl::bumpEnd)
1353 http->al->ssl.bumpMode = bumpMode; // inherited from bumped connection
1354 return false;
1355 }
1356
1357 // If SSL connection tunneling or bumping decision has been made, obey it.
1358 if (bumpMode != Ssl::bumpEnd) {
1359 debugs(85, 5, "SslBump already decided (" << bumpMode <<
1360 "), " << "ignoring ssl_bump for " << http->getConn());
1361
1362 // We need the following "if" for transparently bumped TLS connection,
1363 // because in this case we are running ssl_bump access list before
1364 // the doCallouts runs. It can be removed after the bug #4340 fixed.
1365 // We do not want to proceed to bumping steps:
1366 // - if the TLS connection with the client is already established
1367 // because we are accepting normal HTTP requests on TLS port,
1368 // or because of the client-first bumping mode
1369 // - When the bumping is already started
1370 if (!http->getConn()->switchedToHttps() &&
1371 !http->getConn()->serverBump())
1372 http->sslBumpNeed(bumpMode); // for processRequest() to bump if needed and not already bumped
1373 http->al->ssl.bumpMode = bumpMode; // inherited from bumped connection
1374 return false;
1375 }
1376
1377 // If we have not decided yet, decide whether to bump now.
1378
1379 // Bumping here can only start with a CONNECT request on a bumping port
1380 // (bumping of intercepted SSL conns is decided before we get 1st request).
1381 // We also do not bump redirected CONNECT requests.
1384 !http->getConn()->port->flags.tunnelSslBumping) {
1385 http->al->ssl.bumpMode = Ssl::bumpEnd; // SslBump does not apply; log -
1386 debugs(85, 5, "cannot SslBump this request");
1387 return false;
1388 }
1389
1390 // Do not bump during authentication: clients would not proxy-authenticate
1391 // if we delay a 407 response and respond with 200 OK to CONNECT.
1393 http->al->ssl.bumpMode = Ssl::bumpEnd; // SslBump does not apply; log -
1394 debugs(85, 5, "no SslBump during proxy authentication");
1395 return false;
1396 }
1397
1398 if (error) {
1399 debugs(85, 5, "SslBump applies. Force bump action on error " << errorTypeName(error->type));
1402 return false;
1403 }
1404
1405 debugs(85, 5, "SslBump possible, checking ACL");
1406
1409 return true;
1410}
1411
1416static void
1418{
1419 ClientRequestContext *calloutContext = static_cast<ClientRequestContext *>(data);
1420
1421 if (!calloutContext->httpStateIsValid())
1422 return;
1423 calloutContext->sslBumpAccessCheckDone(answer);
1424}
1425
1426void
1428{
1429 if (!httpStateIsValid())
1430 return;
1431
1432 const Ssl::BumpMode bumpMode = answer.allowed() ?
1433 static_cast<Ssl::BumpMode>(answer.kind) : Ssl::bumpSplice;
1434 http->sslBumpNeed(bumpMode); // for processRequest() to bump if needed
1435 http->al->ssl.bumpMode = bumpMode; // for logging
1436
1438 const Comm::ConnectionPointer clientConn = http->getConn() ? http->getConn()->clientConnection : nullptr;
1439 if (Comm::IsConnOpen(clientConn)) {
1440 debugs(85, 3, "closing after Ssl::bumpTerminate ");
1441 clientConn->close();
1442 }
1443 return;
1444 }
1445
1446 http->doCallouts();
1447}
1448#endif
1449
1450/*
1451 * Identify requests that do not go through the store and client side stream
1452 * and forward them to the appropriate location. All other requests, request
1453 * them.
1454 */
1455void
1457{
1458 debugs(85, 4, request->method << ' ' << uri);
1459
1460 const bool untouchedConnect = request->method == Http::METHOD_CONNECT && !redirect.status;
1461
1462#if USE_OPENSSL
1463 if (untouchedConnect && sslBumpNeeded()) {
1465 sslBumpStart();
1466 return;
1467 }
1468#endif
1469
1470 if (untouchedConnect || request->flags.forceTunnel) {
1471 getConn()->stopReading(); // tunnels read for themselves
1472 tunnelStart(this);
1473 return;
1474 }
1475
1476 httpStart();
1477}
1478
1479void
1481{
1482 // XXX: Re-initializes rather than updates. Should not be needed at all.
1484 debugs(85, 4, loggingTags().c_str() << " for '" << uri << "'");
1485
1486 /* no one should have touched this */
1487 assert(out.offset == 0);
1488 /* Use the Stream Luke */
1490 clientStreamRead(node, this, node->readBuffer);
1491}
1492
1493#if USE_OPENSSL
1494
1495void
1497{
1498 debugs(83, 3, "sslBump required: "<< Ssl::bumpMode(mode));
1499 sslBumpNeed_ = mode;
1500}
1501
1502// called when comm_write has completed
1503static void
1504SslBumpEstablish(const Comm::ConnectionPointer &, char *, size_t, Comm::Flag errflag, int, void *data)
1505{
1506 ClientHttpRequest *r = static_cast<ClientHttpRequest*>(data);
1507 debugs(85, 5, "responded to CONNECT: " << r << " ? " << errflag);
1508
1510 r->sslBumpEstablish(errflag);
1511}
1512
1513void
1515{
1516 // Bail out quickly on Comm::ERR_CLOSING - close handlers will tidy up
1517 if (errflag == Comm::ERR_CLOSING)
1518 return;
1519
1520 if (errflag) {
1521 debugs(85, 3, "CONNECT response failure in SslBump: " << errflag);
1523 return;
1524 }
1525
1526#if USE_AUTH
1527 // Preserve authentication info for the ssl-bumped request
1528 if (request->auth_user_request != nullptr)
1529 getConn()->setAuth(request->auth_user_request, "SSL-bumped CONNECT");
1530#endif
1531
1534}
1535
1536void
1538{
1539 debugs(85, 5, "Confirming " << Ssl::bumpMode(sslBumpNeed_) <<
1540 "-bumped CONNECT tunnel on FD " << getConn()->clientConnection);
1542
1543 AsyncCall::Pointer bumpCall = commCbCall(85, 5, "ClientSocketContext::sslBumpEstablish",
1545
1547 CommIoCbParams &params = GetCommParams<CommIoCbParams>(bumpCall);
1548 params.flag = Comm::OK;
1549 params.conn = getConn()->clientConnection;
1550 ScheduleCallHere(bumpCall);
1551 return;
1552 }
1553
1555
1556 const auto mb = al->reply->pack();
1557 // send an HTTP 200 response to kick client SSL negotiation
1558 // TODO: Unify with tunnel.cc and add a Server(?) header
1559 Comm::Write(getConn()->clientConnection, mb, bumpCall);
1560 delete mb;
1561}
1562
1563#endif
1564
1565void
1567{
1568 if (request)
1570 else
1572}
1573
1574bool
1576{
1577 // TODO: See also (and unify with) clientReplyContext::storeNotOKTransferDone()
1578 int64_t contentLength =
1580 assert(contentLength >= 0);
1581
1582 if (out.offset < contentLength)
1583 return false;
1584
1585 return true;
1586}
1587
1588void
1590{
1591 entry_ = newEntry;
1592}
1593
1594void
1596{
1597 if (loggingEntry_)
1598 loggingEntry_->unlock("ClientHttpRequest::loggingEntry");
1599
1600 loggingEntry_ = newEntry;
1601
1602 if (loggingEntry_)
1603 loggingEntry_->lock("ClientHttpRequest::loggingEntry");
1604}
1605
1606void
1608{
1609 assignRequest(aRequest);
1610 if (const auto csd = getConn()) {
1611 if (!csd->notes()->empty())
1612 request->notes()->appendNewOnly(csd->notes().getRaw());
1613 }
1614 // al is created in the constructor
1615 assert(al);
1616 if (!al->request) {
1617 al->request = request;
1620 }
1621}
1622
1623void
1625{
1626 assert(request != newRequest);
1627 clearRequest();
1628 assignRequest(newRequest);
1629 xfree(uri);
1631}
1632
1633void
1635{
1636 assert(newRequest);
1637 assert(!request);
1638 const_cast<HttpRequest *&>(request) = newRequest;
1641}
1642
1643void
1645{
1646 HttpRequest *oldRequest = request;
1647 HTTPMSGUNLOCK(oldRequest);
1648 const_cast<HttpRequest *&>(request) = nullptr;
1649 absorbLogUri(nullptr);
1650}
1651
1652/*
1653 * doCallouts() - This function controls the order of "callout"
1654 * executions, including non-blocking access control checks, the
1655 * redirector, and ICAP. Previously, these callouts were chained
1656 * together such that "clientAccessCheckDone()" would call
1657 * "clientRedirectStart()" and so on.
1658 *
1659 * The ClientRequestContext (aka calloutContext) class holds certain
1660 * state data for the callout/callback operations. Previously
1661 * ClientHttpRequest would sort of hand off control to ClientRequestContext
1662 * for a short time. ClientRequestContext would then delete itself
1663 * and pass control back to ClientHttpRequest when all callouts
1664 * were finished.
1665 *
1666 * This caused some problems for ICAP because we want to make the
1667 * ICAP callout after checking ACLs, but before checking the no_cache
1668 * list. We can't stuff the ICAP state into the ClientRequestContext
1669 * class because we still need the ICAP state after ClientRequestContext
1670 * goes away.
1671 *
1672 * Note that ClientRequestContext is created before the first call
1673 * to doCallouts().
1674 *
1675 * If one of the callouts notices that ClientHttpRequest is no
1676 * longer valid, it should call cbdataReferenceDone() so that
1677 * ClientHttpRequest's reference count goes to zero and it will get
1678 * deleted. ClientHttpRequest will then delete ClientRequestContext.
1679 *
1680 * Note that we set the _done flags here before actually starting
1681 * the callout. This is strictly for convenience.
1682 */
1683
1684void
1686{
1688
1689 if (!calloutContext->error) {
1690 // CVE-2009-0801: verify the Host: header is consistent with other known details.
1692 debugs(83, 3, "Doing calloutContext->hostHeaderVerify()");
1695 return;
1696 }
1697
1699 debugs(83, 3, "Doing calloutContext->clientAccessCheck()");
1702 return;
1703 }
1704
1705#if USE_ADAPTATION
1710 request, nullptr, calloutContext->http->al, this))
1711 return; // will call callback
1712 }
1713#endif
1714
1717
1718 if (Config.Program.redirect) {
1719 debugs(83, 3, "Doing calloutContext->clientRedirectStart()");
1722 return;
1723 }
1724 }
1725
1727 debugs(83, 3, "Doing calloutContext->clientAccessCheck2()");
1730 return;
1731 }
1732
1735
1736 if (Config.Program.store_id) {
1737 debugs(83, 3,"Doing calloutContext->clientStoreIdStart()");
1740 return;
1741 }
1742 }
1743
1745 debugs(83, 3, "Doing clientInterpretRequestHeaders()");
1748 }
1749
1752
1754 debugs(83, 3, "Doing calloutContext->checkNoCache()");
1756 return;
1757 }
1758 }
1759 } // if !calloutContext->error
1760
1761 // Set appropriate MARKs and CONNMARKs if needed.
1762 if (getConn() && Comm::IsConnOpen(getConn()->clientConnection)) {
1763 ACLFilledChecklist ch(nullptr, request, nullptr);
1764 ch.al = calloutContext->http->al;
1766 ch.my_addr = request->my_addr;
1767 ch.syncAle(request, log_uri);
1768
1771 tos_t tos = aclMapTOS(Ip::Qos::TheConfig.tosToClient, &ch);
1772 if (tos)
1773 Ip::Qos::setSockTos(getConn()->clientConnection, tos);
1774
1775 const auto packetMark = aclFindNfMarkConfig(Ip::Qos::TheConfig.nfmarkToClient, &ch);
1776 if (!packetMark.isEmpty())
1777 Ip::Qos::setSockNfmark(getConn()->clientConnection, packetMark.mark);
1778
1779 const auto connmark = aclFindNfMarkConfig(Ip::Qos::TheConfig.nfConnmarkToClient, &ch);
1780 if (!connmark.isEmpty())
1781 Ip::Qos::setNfConnmark(getConn()->clientConnection, Ip::Qos::dirAccepted, connmark);
1782 }
1783 }
1784
1785#if USE_OPENSSL
1786 // Even with calloutContext->error, we call sslBumpAccessCheck() to decide
1787 // whether SslBump applies to this transaction. If it applies, we will
1788 // attempt to bump the client to serve the error.
1792 return;
1793 /* else no ssl bump required*/
1794 }
1795#endif
1796
1797 if (calloutContext->error) {
1798 // XXX: prformance regression. c_str() reallocates
1799 SBuf storeUriBuf(request->storeId());
1800 const char *storeUri = storeUriBuf.c_str();
1801 StoreEntry *e = storeCreateEntry(storeUri, storeUri, request->flags, request->method);
1802#if USE_OPENSSL
1803 if (sslBumpNeeded()) {
1804 // We have to serve an error, so bump the client first.
1806 // set final error but delay sending until we bump
1807 Ssl::ServerBump *srvBump = new Ssl::ServerBump(this, e, Ssl::bumpClientFirst);
1809 calloutContext->error = nullptr;
1810 getConn()->setServerBump(srvBump);
1811 e->unlock("ClientHttpRequest::doCallouts+sslBumpNeeded");
1812 } else
1813#endif
1814 {
1815 // send the error to the client now
1817 clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
1818 assert (repContext);
1819 repContext->setReplyToStoreEntry(e, "immediate SslBump error");
1821 calloutContext->error = nullptr;
1823 getConn()->flags.readMore = true; // resume any pipeline reads.
1825 clientStreamRead(node, this, node->readBuffer);
1826 e->unlock("ClientHttpRequest::doCallouts-sslBumpNeeded");
1827 return;
1828 }
1829 }
1830
1832 delete calloutContext;
1833 calloutContext = nullptr;
1834#if HEADERS_LOG
1835
1836 headersLog(0, 1, request->method, request);
1837#endif
1838
1839 debugs(83, 3, "calling processRequest()");
1841
1842#if ICAP_CLIENT
1844 if (ih != nullptr)
1845 ih->logType = loggingTags();
1846#endif
1847}
1848
1849void
1851{
1852 assert(request);
1853 const auto canonicalUri = request->canonicalCleanUrl();
1854 absorbLogUri(xstrndup(canonicalUri, MAX_URL));
1855}
1856
1857void
1859{
1860 assert(rawUri);
1861 // Should(!request);
1862
1863 // TODO: SBuf() performance regression, fix by converting rawUri to SBuf
1864 char *canonicalUri = urlCanonicalCleanWithoutRequest(SBuf(rawUri), method, AnyP::UriScheme());
1865
1866 absorbLogUri(AnyP::Uri::cleanup(canonicalUri));
1867
1868 char *cleanedRawUri = AnyP::Uri::cleanup(rawUri);
1869 al->setVirginUrlForMissingRequest(SBuf(cleanedRawUri));
1870 xfree(cleanedRawUri);
1871}
1872
1873void
1875{
1876 xfree(log_uri);
1877 const_cast<char *&>(log_uri) = aUri;
1878}
1879
1880void
1882{
1883 assert(!uri);
1884 assert(aUri);
1885 // Should(!request);
1886
1887 uri = xstrdup(aUri);
1888 // TODO: SBuf() performance regression, fix by converting setErrorUri() parameter to SBuf
1889 const SBuf errorUri(aUri);
1890 const auto canonicalUri = urlCanonicalCleanWithoutRequest(errorUri, HttpRequestMethod(), AnyP::UriScheme());
1891 absorbLogUri(xstrndup(canonicalUri, MAX_URL));
1892
1894}
1895
1896// XXX: This should not be a _request_ method. Move range_iter elsewhere.
1897int64_t
1899{
1900 assert(request);
1902
1906 const auto multipart = request->range->specs.size() > 1;
1907 if (multipart)
1909 range_iter.valid = true; // TODO: Remove.
1910 range_iter.updateSpec(); // TODO: Refactor to initialize rather than update.
1911
1913 const auto &firstRange = *range_iter.pos;
1914 assert(firstRange);
1915 out.offset = firstRange->offset;
1916
1917 return multipart ? mRangeCLen() : firstRange->length;
1918}
1919
1920#if USE_ADAPTATION
1922void
1924{
1925 debugs(85, 3, "adaptation needed for " << this);
1929 new Adaptation::Iterator(request, nullptr, al, g));
1930
1931 // we could try to guess whether we can bypass this adaptation
1932 // initiation failure, but it should not really happen
1934}
1935
1936void
1938{
1939 assert(cbdataReferenceValid(this)); // indicates bug
1942
1943 switch (answer.kind) {
1945 handleAdaptedHeader(const_cast<Http::Message*>(answer.message.getRaw()));
1946 break;
1947
1949 handleAdaptationBlock(answer);
1950 break;
1951
1953 static const auto d = MakeNamedErrorDetail("CLT_REQMOD_ABORT");
1954 handleAdaptationFailure(d, !answer.final);
1955 break;
1956 }
1957 }
1958}
1959
1960void
1962{
1963 assert(msg);
1964
1965 if (HttpRequest *new_req = dynamic_cast<HttpRequest*>(msg)) {
1966 // update the new message to flag whether URL re-writing was done on it
1967 if (request->effectiveRequestUri() != new_req->effectiveRequestUri())
1968 new_req->flags.redirected = true;
1969 resetRequest(new_req);
1970 assert(request->method.id());
1971 } else if (HttpReply *new_rep = dynamic_cast<HttpReply*>(msg)) {
1972 debugs(85,3, "REQMOD reply is HTTP reply");
1973
1974 // subscribe to receive reply body
1975 if (new_rep->body_pipe != nullptr) {
1976 adaptedBodySource = new_rep->body_pipe;
1977 int consumer_ok = adaptedBodySource->setConsumerIfNotLate(this);
1978 assert(consumer_ok);
1979 }
1980
1982 clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
1983 assert(repContext);
1984 repContext->createStoreEntry(request->method, request->flags);
1985
1988 storeEntry()->replaceHttpReply(new_rep);
1990
1991 al->reply = new_rep;
1992
1993 if (!adaptedBodySource) // no body
1994 storeEntry()->complete();
1995 clientGetMoreData(node, this);
1996 }
1997
1998 // we are done with getting headers (but may be receiving body)
2000
2002 doCallouts();
2003}
2004
2005void
2007{
2008 static const auto d = MakeNamedErrorDetail("REQMOD_BLOCK");
2010 AclMatchedName = answer.ruleId.termedBuf();
2013 AclMatchedName = nullptr;
2014}
2015
2016void
2018{
2019 if (!adaptedBodySource)
2020 return;
2021
2023}
2024
2025void
2027{
2029 assert(adaptedBodySource != nullptr);
2030
2031 if (size_t contentSize = adaptedBodySource->buf().contentSize()) {
2032 const size_t spaceAvailable = storeEntry()->bytesWanted(Range<size_t>(0,contentSize));
2033
2034 if (spaceAvailable < contentSize ) {
2035 // No or partial body data consuming
2036 typedef NullaryMemFunT<ClientHttpRequest> Dialer;
2037 AsyncCall::Pointer call = asyncCall(93, 5, "ClientHttpRequest::resumeBodyStorage",
2039 storeEntry()->deferProducer(call);
2040 }
2041
2042 if (!spaceAvailable)
2043 return;
2044
2045 if (spaceAvailable < contentSize )
2046 contentSize = spaceAvailable;
2047
2049 const StoreIOBuffer ioBuf(&bpc.buf, request_satisfaction_offset, contentSize);
2050 storeEntry()->write(ioBuf);
2051 // assume StoreEntry::write() writes the entire ioBuf
2053 bpc.buf.consume(contentSize);
2054 bpc.checkIn();
2055 }
2056
2059 // else wait for more body data
2060}
2061
2062void
2064{
2066
2067 // distinguish this code path from future noteBodyProducerAborted() that
2068 // would continue storing/delivering (truncated) reply if necessary (TODO)
2070
2071 // should we end request satisfaction now?
2072 if (adaptedBodySource != nullptr && adaptedBodySource->exhausted())
2074}
2075
2076void
2078{
2079 debugs(85,4, this << " ends request satisfaction");
2082
2083 // TODO: anything else needed to end store entry formation correctly?
2085 // We received the entire reply per receivedWholeAdaptedReply.
2086 // We are called when we consumed everything received (per our callers).
2087 // We consume only what we store per noteMoreBodyDataAvailable().
2088 storeEntry()->completeSuccessfully("received, consumed, and, hence, stored the entire REQMOD reply");
2089 } else {
2090 storeEntry()->completeTruncated("REQMOD request satisfaction default");
2091 }
2092}
2093
2094void
2096{
2099
2100 debugs(85,3, "REQMOD body production failed");
2101 if (request_satisfaction_mode) { // too late to recover or serve an error
2102 static const auto d = MakeNamedErrorDetail("CLT_REQMOD_RESP_BODY");
2106 c->close(); // drastic, but we may be writing a response already
2107 } else {
2108 static const auto d = MakeNamedErrorDetail("CLT_REQMOD_REQ_BODY");
2110 }
2111}
2112
2113void
2115{
2116 debugs(85,3, "handleAdaptationFailure(" << bypassable << ")");
2117
2118 const bool usedStore = storeEntry() && !storeEntry()->isEmpty();
2119 const bool usedPipe = request->body_pipe != nullptr &&
2121
2122 if (bypassable && !usedStore && !usedPipe) {
2123 debugs(85,3, "ICAP REQMOD callout failed, bypassing: " << calloutContext);
2124 if (calloutContext)
2125 doCallouts();
2126 return;
2127 }
2128
2129 debugs(85,3, "ICAP REQMOD callout failed, responding with error");
2130
2132 clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
2133 assert(repContext);
2134
2135 calloutsError(ERR_ICAP_FAILURE, errDetail);
2136
2137 if (calloutContext)
2138 doCallouts();
2139}
2140
2141void
2142ClientHttpRequest::callException(const std::exception &ex)
2143{
2144 if (const auto clientConn = getConn() ? getConn()->clientConnection : nullptr) {
2145 if (Comm::IsConnOpen(clientConn)) {
2146 debugs(85, 3, "closing after exception: " << ex.what());
2147 clientConn->close(); // initiate orderly top-to-bottom cleanup
2148 return;
2149 }
2150 }
2151 debugs(85, DBG_IMPORTANT, "ClientHttpRequest exception without connection. Ignoring " << ex.what());
2152 // XXX: Normally, we mustStop() but we cannot do that here because it is
2153 // likely to leave Http::Stream and ConnStateData with a dangling http
2154 // pointer. See r13480 or XXX in Http::Stream class description.
2155}
2156#endif
2157
2158// XXX: modify and use with ClientRequestContext::clientAccessCheckDone too.
2159void
2161{
2162 // The original author of the code also wanted to pass an errno to
2163 // setReplyToError, but it seems unlikely that the errno reflects the
2164 // true cause of the error at this point, so I did not pass it.
2165 if (calloutContext) {
2166 ConnStateData * c = getConn();
2168 nullptr, c, request, al);
2169#if USE_AUTH
2171 c != nullptr && c->getAuth() != nullptr ? c->getAuth() : request->auth_user_request;
2172#endif
2173 calloutContext->error->detailError(errDetail);
2175 if (c != nullptr)
2176 c->expectNoForwarding();
2177 }
2178 //else if(calloutContext == NULL) is it possible?
2179}
2180
#define ScheduleCallHere(call)
Definition: AsyncCall.h:164
AsyncCall * asyncCall(int aDebugSection, int aDebugLevel, const char *aName, const Dialer &aDialer)
Definition: AsyncCall.h:154
CommCbFunPtrCallT< Dialer > * commCbCall(int debugSection, int debugLevel, const char *callName, const Dialer &dialer)
Definition: CommCalls.h:342
ErrorDetail::Pointer MakeNamedErrorDetail(const char *name)
Definition: Detail.cc:54
const char * errorTypeName(err_type err)
Definition: Error.h:53
ACLFilledChecklist * Filled(ACLChecklist *checklist)
convenience and safety wrapper for dynamic_cast<ACLFilledChecklist*>
Ip::NfMarkConfig aclFindNfMarkConfig(acl_nfmark *head, ACLChecklist *ch)
Checks for a netfilter mark value to apply depending on the ACL.
Definition: FwdState.cc:1508
tos_t aclMapTOS(acl_tos *head, ACLChecklist *ch)
Checks for a TOS value to apply depending on the ACL.
Definition: FwdState.cc:1496
ssize_t HttpHeaderPos
Definition: HttpHeader.h:45
#define HttpHeaderInitPos
Definition: HttpHeader.h:48
void UpdateRequestNotes(ConnStateData *csd, HttpRequest &request, NotePairs const &helperNotes)
Definition: HttpRequest.cc:763
void httpRequestPack(void *obj, Packable *p)
Definition: HttpRequest.cc:361
@ LOG_TCP_DENIED
Definition: LogTags.h:52
@ LOG_TAG_NONE
Definition: LogTags.h:38
time_t squid_curtime
Definition: stub_libtime.cc:20
void SBufToCstring(char *d, const SBuf &s)
Definition: SBuf.h:752
class SquidConfig Config
Definition: SquidConfig.cc:12
int strListIsSubstr(const String *list, const char *s, char del)
Definition: StrList.cc:63
SBuf StringToSBuf(const String &s)
create a new SBuf from a String by copying contents
Definition: StringConvert.h:17
#define Must(condition)
Definition: TextException.h:71
int conn
the current server connection FD
Definition: Transport.cc:26
int matchDomainName(const char *h, const char *d, MatchDomainNameFlags flags)
Definition: Uri.cc:736
char * urlCanonicalCleanWithoutRequest(const SBuf &url, const HttpRequestMethod &method, const AnyP::UriScheme &scheme)
Definition: Uri.cc:620
void fvdbCountVia(const SBuf &)
void fvdbCountForwarded(const SBuf &)
count occurrences of the given X-Forwarded-For header value
void error(char *format,...)
#define assert(EX)
Definition: assert.h:19
int cbdataReferenceValid(const void *p)
Definition: cbdata.cc:398
#define cbdataReferenceDone(var)
Definition: cbdata.h:350
#define cbdataReference(var)
Definition: cbdata.h:341
#define CBDATA_CLASS_INIT(type)
Definition: cbdata.h:318
void nonBlockingCheck(ACLCB *callback, void *callback_data)
Definition: Checklist.cc:237
virtual void syncAle(HttpRequest *adaptedRequest, const char *logUri) const
assigns uninitialized adapted_request and url ALE components
Ip::Address src_addr
AccessLogEntry::Pointer al
info for the future access.log, and external ACL
AnyP::PortCfgPointer port
Security::CertPointer sslClientCert
cert received from the client
struct timeval start_time
The time the master transaction started.
int bumpMode
whether and how the request was SslBumped
HttpReplyPointer reply
class AccessLogEntry::CacheDetails cache
HierarchyLogEntry hier
void syncNotes(HttpRequest *request)
Comm::ConnectionPointer tcpClient
TCP/IP level details about the client connection.
HttpRequest * request
void setVirginUrlForMissingRequest(const SBuf &vu)
Remember Client URI (or equivalent) when there is no HttpRequest.
ProxyProtocol::HeaderPointer proxyProtocolHeader
see ConnStateData::proxyProtocolHeader_
class AccessLogEntry::SslDetails ssl
void updateError(const Error &)
sets (or updates the already stored) transaction error as needed
int kind
the matched custom access list verb (or zero)
Definition: Acl.h:164
bool denied() const
Definition: Acl.h:156
bool conflicted() const
whether Squid is uncertain about the allowed() or denied() answer
Definition: Acl.h:159
bool allowed() const
Definition: Acl.h:150
static bool Start(Method method, VectPoint vp, HttpRequest *req, HttpReply *, const AccessLogEntryPointer &, Adaptation::Initiator *)
Definition: AccessCheck.cc:30
summarizes adaptation service answer for the noteAdaptationAnswer() API
Definition: Answer.h:23
String ruleId
ACL (or similar rule) name that blocked forwarding.
Definition: Answer.h:40
Kind kind
the type of the answer
Definition: Answer.h:42
Http::MessagePointer message
HTTP request or response to forward.
Definition: Answer.h:39
bool final
whether the error, if any, cannot be bypassed
Definition: Answer.h:41
@ akForward
forward the supplied adapted HTTP message
Definition: Answer.h:27
@ akBlock
block or deny the master xaction; see authority
Definition: Answer.h:28
@ akError
no adapted message will come; see bypassable
Definition: Answer.h:29
CbcPointer< Initiate > initiateAdaptation(Initiate *x)
< starts freshly created initiate and returns a safe pointer to it
Definition: Initiator.cc:23
void clearAdaptation(CbcPointer< Initiate > &x)
clears the pointer (does not call announceInitiatorAbort)
Definition: Initiator.cc:32
void announceInitiatorAbort(CbcPointer< Initiate > &x)
inform the transaction about abnormal termination and clear the pointer
Definition: Initiator.cc:38
bool initiated(const CbcPointer< AsyncJob > &job) const
Must(initiated(initiate)) instead of Must(initiate.set()), for clarity.
Definition: Initiator.h:52
iterates services in ServiceGroup, starting adaptation launchers
Definition: Iterator.h:32
unsigned short defaultPort() const
Definition: UriScheme.cc:71
Definition: Uri.h:31
AnyP::UriScheme const & getScheme() const
Definition: Uri.h:67
void port(unsigned short p)
Definition: Uri.h:94
static char * cleanup(const char *uri)
Definition: Uri.cc:909
void host(const char *src)
Definition: Uri.cc:99
bool parse(const HttpRequestMethod &, const SBuf &url)
Definition: Uri.cc:254
char const * denyMessage(char const *const default_message=nullptr) const
Definition: UserRequest.cc:127
void stopConsumingFrom(RefCount< BodyPipe > &)
Definition: BodyPipe.cc:118
MemBuf & buf
Definition: BodyPipe.h:74
const MemBuf & buf() const
Definition: BodyPipe.h:137
bool exhausted() const
Definition: BodyPipe.cc:174
uint64_t consumedSize() const
Definition: BodyPipe.h:111
bool setConsumerIfNotLate(const Consumer::Pointer &aConsumer)
Definition: BodyPipe.cc:228
int64_t prepPartialResponseGeneration()
ClientHttpRequest(ConnStateData *)
virtual void callException(const std::exception &)
called when the job throws during an async call
struct ClientHttpRequest::Out out
void clearRequest()
resets the current request and log_uri to nil
HttpRequest *const request
virtual void noteAdaptationAclCheckDone(Adaptation::ServiceGroupPointer)
void resumeBodyStorage()
called by StoreEntry when it has more buffer space available
virtual void noteBodyProductionEnded(BodyPipe::Pointer)
bool receivedWholeAdaptedReply
noteBodyProductionEnded() was called
StoreEntry * loggingEntry_
int64_t mRangeCLen() const
Definition: client_side.cc:753
void calloutsError(const err_type, const ErrorDetail::Pointer &)
Build an error reply. For use with the callouts.
void absorbLogUri(char *)
assigns log_uri with aUri without copying the entire C-string
ConnStateData * getConn() const
String rangeBoundaryStr() const
Definition: client_side.cc:793
void initRequest(HttpRequest *)
void setLogUriToRequestUri()
sets log_uri when we know the current request
void updateError(const Error &)
if necessary, stores new error information (if any)
virtual void noteMoreBodyDataAvailable(BodyPipe::Pointer)
CbcPointer< Adaptation::Initiate > virginHeadSource
void updateLoggingTags(const LogTags_ot code)
update the code in the transaction processing tags
MemObject * memObject() const
void setLogUriToRawUri(const char *, const HttpRequestMethod &)
size_t req_sz
raw request size on input, not current request size
ConnStateData * conn_
virtual void noteAdaptationAnswer(const Adaptation::Answer &)
void setErrorUri(const char *)
BodyPipe::Pointer adaptedBodySource
Ssl::BumpMode sslBumpNeed_
whether (and how) the request needs to be bumped
HttpHdrRangeIter range_iter
void handleAdaptedHeader(Http::Message *)
struct ClientHttpRequest::Flags flags
void resetRequest(HttpRequest *)
void assignRequest(HttpRequest *)
StoreEntry * storeEntry() const
void handleAdaptationBlock(const Adaptation::Answer &)
virtual void noteBodyProducerAborted(BodyPipe::Pointer)
void sslBumpEstablish(Comm::Flag)
bool sslBumpNeeded() const
returns true if and only if the request needs to be bumped
ClientRequestContext * calloutContext
Ssl::BumpMode sslBumpNeed() const
returns raw sslBump mode value
const LogTags & loggingTags() const
the processing tags associated with this request transaction.
void handleAdaptationFailure(const ErrorDetail::Pointer &, bool bypassable=false)
const AccessLogEntry::Pointer al
access.log entry
StoreEntry * loggingEntry() const
void startAdaptation(const Adaptation::ServiceGroupPointer &)
Initiate an asynchronous adaptation transaction which will call us back.
struct ClientHttpRequest::Redirect redirect
void clientAccessCheckDone(const Acl::Answer &)
void clientStoreIdDone(const Helper::Reply &)
void clientRedirectDone(const Helper::Reply &)
void sslBumpAccessCheckDone(const Acl::Answer &answer)
The callback function for ssl-bump access check list.
ClientRequestContext(ClientHttpRequest *)
bool readNextRequest
whether Squid should read after error handling
ClientHttpRequest * http
ACLChecklist * acl_checklist
need ptr back so we can unregister if needed
ErrorState * error
saved error page for centralized/delayed processing
void hostHeaderVerifyFailed(const char *A, const char *B)
void hostHeaderIpVerify(const ipcache_addrs *, const Dns::LookupDetails &)
void checkNoCacheDone(const Acl::Answer &)
static void Reset()
forgets the current context, setting it to nil/unknown
Definition: CodeContext.cc:75
Comm::Flag flag
comm layer result status.
Definition: CommCalls.h:87
Comm::ConnectionPointer conn
Definition: CommCalls.h:85
bool isOpen() const
Definition: Connection.h:101
char rfc931[USER_IDENT_SZ]
Definition: Connection.h:176
Ip::Address local
Definition: Connection.h:146
Ssl::ServerBump * serverBump()
Definition: client_side.h:286
struct ConnStateData::@42 pinning
bool auth
pinned for www authentication
Definition: client_side.h:148
bool switchedToHttps() const
Definition: client_side.h:285
int port
port of pinned connection
Definition: client_side.h:146
const ProxyProtocol::HeaderPointer & proxyProtocolHeader() const
Definition: client_side.h:361
Comm::ConnectionPointer serverConnection
Definition: client_side.h:144
void switchToHttps(ClientHttpRequest *, Ssl::BumpMode bumpServerMode)
void setAuth(const Auth::UserRequest::Pointer &aur, const char *cause)
Definition: client_side.cc:507
const Auth::UserRequest::Pointer & getAuth() const
Definition: client_side.h:124
Error bareError
a problem that occurred without a request (e.g., while parsing headers)
Definition: client_side.h:382
void expectNoForwarding()
cleans up virgin request [body] forwarding state
bool isOpen() const
Definition: client_side.cc:653
struct ConnStateData::@41 flags
Ip::Address log_addr
Definition: client_side.h:137
Ssl::BumpMode sslBumpMode
ssl_bump decision (Ssl::bumpEnd if n/a).
Definition: client_side.h:305
bool readMore
needs comm_read (for this request or new requests)
Definition: client_side.h:140
void setServerBump(Ssl::ServerBump *srvBump)
Definition: client_side.h:287
bool have(const Ip::Address &ip, size_t *position=nullptr) const
Definition: ipcache.cc:973
encapsulates DNS lookup results
Definition: LookupDetails.h:21
err_type type
Definition: errorpage.h:168
void detailError(const ErrorDetail::Pointer &dCode)
set error type-specific detail code
Definition: errorpage.h:109
Auth::UserRequest::Pointer auth_user_request
Definition: errorpage.h:173
Http::StatusCode httpStatus
Definition: errorpage.h:171
a transaction problem
Definition: Error.h:18
err_type category
primary error classification (or ERR_NONE)
Definition: Error.h:35
void update(const Error &)
if necessary, stores the given error information (if any)
Definition: Error.cc:16
NotePairs notes
Definition: Reply.h:62
Helper::ResultCode result
The helper response 'result' field.
Definition: Reply.h:59
bool hasOnlyIfCached() const
Definition: HttpHdrCc.h:145
HttpHdrRange::iterator pos
HttpHdrRange::iterator end
iterator begin()
iterator end()
std::vector< HttpHdrRangeSpec * > specs
Http::HdrType id
Definition: HttpHeader.h:63
int delById(Http::HdrType id)
Definition: HttpHeader.cc:671
String getList(Http::HdrType id) const
Definition: HttpHeader.cc:818
HttpHeaderEntry * getEntry(HttpHeaderPos *pos) const
Definition: HttpHeader.cc:588
const char * getStr(Http::HdrType id) const
Definition: HttpHeader.cc:1160
time_t getTime(Http::HdrType id) const
Definition: HttpHeader.cc:1143
HttpHdrRange * getRange() const
Definition: HttpHeader.cc:1217
int has(Http::HdrType id) const
Definition: HttpHeader.cc:967
int hasListMember(Http::HdrType id, const char *member, const char separator) const
Definition: HttpHeader.cc:1659
MemBuf * pack() const
Definition: HttpReply.cc:110
int64_t bodySize(const HttpRequestMethod &) const
Definition: HttpReply.cc:374
static HttpReplyPointer MakeConnectionEstablished()
construct and return an HTTP/200 (Connection Established) response
Definition: HttpReply.cc:119
bool respMaybeCacheable() const
Http::MethodType id() const
Definition: RequestMethod.h:70
void recordLookup(const Dns::LookupDetails &detail)
Definition: HttpRequest.cc:583
HttpHdrRange * range
Definition: HttpRequest.h:143
HttpRequestMethod method
Definition: HttpRequest.h:114
Ip::Address indirect_client_addr
Definition: HttpRequest.h:152
static HttpRequest * FromUrlXXX(const char *url, const MasterXaction::Pointer &, const HttpRequestMethod &method=Http::METHOD_GET)
Definition: HttpRequest.cc:528
String store_id
Definition: HttpRequest.h:139
RequestFlags flags
Definition: HttpRequest.h:141
String x_forwarded_for_iterator
Definition: HttpRequest.h:187
void detailError(const err_type c, const ErrorDetail::Pointer &d)
sets error detail if no earlier detail was available
Definition: HttpRequest.h:101
NotePairs::Pointer notes()
Definition: HttpRequest.cc:755
virtual HttpRequest * clone() const
Definition: HttpRequest.cc:175
const SBuf storeId()
Definition: HttpRequest.cc:736
bool maybeCacheable()
Definition: HttpRequest.cc:538
char * canonicalCleanUrl() const
Definition: HttpRequest.cc:817
Ip::Address my_addr
Definition: HttpRequest.h:155
Auth::UserRequest::Pointer auth_user_request
Definition: HttpRequest.h:127
Error error
the first transaction problem encountered (or falsy)
Definition: HttpRequest.h:161
Adaptation::Icap::History::Pointer icapHistory() const
Returns possibly nil history, creating it if icap logging is enabled.
Definition: HttpRequest.cc:389
AnyP::Uri url
the request URI
Definition: HttpRequest.h:115
Ip::Address client_addr
Definition: HttpRequest.h:149
const SBuf & effectiveRequestUri() const
RFC 7230 section 5.5 - Effective Request URI.
Definition: HttpRequest.cc:747
common parts of HttpRequest and HttpReply
Definition: Message.h:26
HttpHeader header
Definition: Message.h:74
BodyPipe::Pointer body_pipe
optional pipeline to receive message body
Definition: Message.h:97
HttpHdrCc * cache_control
Definition: Message.h:76
AnyP::ProtocolVersion http_ver
Definition: Message.h:72
unsigned short port() const
Definition: Address.cc:778
mb_size_t contentSize() const
available data size
Definition: MemBuf.h:47
void consume(mb_size_t sz)
removes sz bytes and "packs" by moving content left
Definition: MemBuf.cc:168
const HttpReply & baseReply() const
Definition: MemObject.h:59
void appendNewOnly(const NotePairs *src)
Definition: Notes.cc:381
const char * findFirst(const char *noteKey) const
Definition: Notes.cc:297
Definition: Range.h:19
C * getRaw() const
Definition: RefCount.h:80
bool doneFollowXff() const
Definition: RequestFlags.h:119
bool interceptTproxy
Set for requests handled by a "tproxy" port.
Definition: RequestFlags.h:66
bool forceTunnel
whether to forward via TunnelStateData (instead of FwdState)
Definition: RequestFlags.h:111
bool hostVerified
Definition: RequestFlags.h:64
bool intercepted
Definition: RequestFlags.h:62
bool hierarchical
Definition: RequestFlags.h:34
Definition: SBuf.h:94
const char * c_str()
Definition: SBuf.cc:516
void resetWithoutLocking(T *t)
Reset raw pointer - unlock any previous one and save new one without locking.
Comm::ConnectionPointer clientConnection
Definition: Server.h:98
void stopReading()
cancels Comm::Read() if it is scheduled
Definition: Server.cc:60
struct SquidConfig::@104 Program
size_t appendDomainLen
Definition: SquidConfig.h:221
acl_access * adapted_http
Definition: SquidConfig.h:358
int log_uses_indirect_client
Definition: SquidConfig.h:326
int acl_uses_indirect_client
Definition: SquidConfig.h:324
wordlist * store_id
Definition: SquidConfig.h:200
acl_access * followXFF
Definition: SquidConfig.h:389
acl_access * redirector
Definition: SquidConfig.h:375
struct SquidConfig::@111 onoff
struct SquidConfig::@105 Accel
int hostStrictVerify
Definition: SquidConfig.h:335
int reload_into_ims
Definition: SquidConfig.h:291
struct SquidConfig::@112 accessList
acl_access * http
Definition: SquidConfig.h:357
wordlist * redirect
Definition: SquidConfig.h:199
char * surrogate_id
Definition: SquidConfig.h:218
AclDenyInfoList * denyInfoList
Definition: SquidConfig.h:406
unsigned short icp
Definition: SquidConfig.h:139
struct SquidConfig::UrlHelperTimeout onUrlRewriteTimeout
acl_access * ssl_bump
Definition: SquidConfig.h:386
struct SquidConfig::@99 Port
acl_access * noCache
Definition: SquidConfig.h:364
void completeSuccessfully(const char *whyWeAreSureWeStoredTheWholeReply)
Definition: store.cc:990
size_t bytesWanted(Range< size_t > const aRange, bool ignoreDelayPool=false) const
Definition: store.cc:210
void completeTruncated(const char *whyWeConsiderTheReplyTruncated)
Definition: store.cc:997
int unlock(const char *context)
Definition: store.cc:442
void complete()
Definition: store.cc:1004
void write(StoreIOBuffer)
Definition: store.cc:753
void lock(const char *context)
Definition: store.cc:418
bool timestampsSet()
Definition: store.cc:1360
void replaceHttpReply(const HttpReplyPointer &, const bool andStartWriting=true)
Definition: store.cc:1672
bool isEmpty() const
Definition: Store.h:66
void deferProducer(const AsyncCall::Pointer &producer)
call back producer when more buffer space is available
Definition: store.cc:339
void clean()
Definition: String.cc:118
char const * rawBuf() const
Definition: SquidString.h:86
char const * termedBuf() const
Definition: SquidString.h:92
void CSD(clientStreamNode *, ClientHttpRequest *)
client stream detach
void CSR(clientStreamNode *, ClientHttpRequest *)
client stream read
void CSCB(clientStreamNode *, ClientHttpRequest *, HttpReply *, StoreIOBuffer)
client stream read callback
clientStream_status_t CSS(clientStreamNode *, ClientHttpRequest *)
ACLFilledChecklist * clientAclChecklistCreate(const acl_access *acl, ClientHttpRequest *http)
static void clientInterpretRequestHeaders(ClientHttpRequest *http)
static void clientRedirectAccessCheckDone(Acl::Answer answer, void *data)
static void clientFollowXForwardedForCheck(Acl::Answer answer, void *data)
#define FAILURE_MODE_TIME
static void checkNoCacheDoneWrapper(Acl::Answer, void *)
static void sslBumpAccessCheckDoneWrapper(Acl::Answer, void *)
ErrorState * clientBuildError(err_type, Http::StatusCode, char const *url, const ConnStateData *, HttpRequest *, const AccessLogEntry::Pointer &)
static void hostHeaderIpVerifyWrapper(const ipcache_addrs *ia, const Dns::LookupDetails &dns, void *data)
static void clientCheckPinning(ClientHttpRequest *http)
static int clientHierarchical(ClientHttpRequest *http)
static HLPCB clientStoreIdDoneWrapper
static void clientStoreIdAccessCheckDone(Acl::Answer answer, void *data)
int clientBeginRequest(const HttpRequestMethod &method, char const *url, CSCB *streamcallback, CSD *streamdetach, ClientStreamData streamdata, HttpHeader const *header, char *tailbuf, size_t taillen, const MasterXaction::Pointer &mx)
static void checkFailureRatio(err_type, hier_code)
static HLPCB clientRedirectDoneWrapper
SQUIDCEXTERN CSR clientGetMoreData
static void clientAccessCheckDoneWrapper(Acl::Answer, void *)
SQUIDCEXTERN CSS clientReplyStatus
SQUIDCEXTERN CSD clientReplyDetach
static void SslBumpEstablish(const Comm::ConnectionPointer &, char *, size_t, Comm::Flag errflag, int, void *data)
void tunnelStart(ClientHttpRequest *)
Definition: tunnel.cc:1118
#define DBG_IMPORTANT
Definition: Stream.h:41
#define debugs(SECTION, LEVEL, CONTENT)
Definition: Stream.h:196
#define DBG_CRITICAL
Definition: Stream.h:40
#define REDIRECT_DONE
Definition: defines.h:57
#define REDIRECT_PENDING
Definition: defines.h:56
#define MAX_URL
Definition: defines.h:78
static int port
Definition: ldap_backend.cc:70
err_type
Definition: forward.h:14
@ ERR_ACCESS_DENIED
Definition: forward.h:18
@ ERR_CONNECT_FAIL
Definition: forward.h:30
@ ERR_SECURE_CONNECT_FAIL
Definition: forward.h:31
@ ERR_DNS_FAIL
Definition: forward.h:35
@ ERR_GATEWAY_FAILURE
Definition: forward.h:67
@ ERR_NONE
Definition: forward.h:15
@ ERR_ICAP_FAILURE
Definition: forward.h:64
@ ERR_CONFLICT_HOST
Definition: forward.h:48
@ ERR_READ_ERROR
Definition: forward.h:28
@ ERR_CACHE_ACCESS_DENIED
Definition: forward.h:19
void fd_note(int fd, const char *s)
Definition: fd.cc:217
#define fd_table
Definition: fde.h:189
int refresh_nocache_hack
char ThisCache2[RFC2181_MAXHOSTNAMELEN<< 1]
int neighbors_do_private_keys
double request_failure_ratio
time_t hit_only_mode_until
err_type aclGetDenyInfoPage(AclDenyInfoList **head, const char *name, int redirect_allowed)
Definition: Gadgets.cc:42
int aclIsProxyAuth(const char *name)
Definition: Gadgets.cc:73
const char * AclMatchedName
Definition: Acl.cc:29
@ ACCESS_AUTH_REQUIRED
Definition: Acl.h:114
@ ACCESS_DENIED
Definition: Acl.h:109
@ ACCESS_ALLOWED
Definition: Acl.h:110
void clientStreamRead(clientStreamNode *thisObject, ClientHttpRequest *http, StoreIOBuffer readBuffer)
void clientStreamInit(dlink_list *list, CSR *func, CSD *rdetach, CSS *readstatus, ClientStreamData readdata, CSCB *callback, CSD *cdetach, ClientStreamData callbackdata, StoreIOBuffer tailBuffer)
void errorAppendEntry(StoreEntry *entry, ErrorState *err)
Definition: errorpage.cc:719
void ipcache_nbgethostbyname(const char *name, IPH *handler, void *handlerData)
Definition: ipcache.cc:599
const char * bumpMode(int bm)
Definition: support.h:138
const char * sslGetUserEmail(SSL *ssl)
Definition: support.cc:885
BumpMode
Definition: support.h:126
@ bumpTerminate
Definition: support.h:126
@ bumpEnd
Definition: support.h:126
@ bumpClientFirst
Definition: support.h:126
@ bumpSplice
Definition: support.h:126
@ bumpBump
Definition: support.h:126
void HLPCB(void *, const Helper::Reply &)
Definition: forward.h:27
hier_code
Definition: hier_code.h:12
@ HIER_NONE
Definition: hier_code.h:13
void HTTPMSGUNLOCK(M *&a)
Definition: Message.h:149
void HTTPMSGLOCK(Http::Message *a)
Definition: Message.h:160
unsigned char tos_t
Definition: forward.h:27
static uint32 A
Definition: md4.c:43
static uint32 B
Definition: md4.c:43
@ methodReqmod
Definition: Elements.h:17
@ pointPreCache
Definition: Elements.h:18
@ PROTO_HTTP
Definition: ProtocolType.h:25
@ PROTO_CACHE_OBJECT
Definition: ProtocolType.h:31
bool IsConnOpen(const Comm::ConnectionPointer &conn)
Definition: Connection.cc:27
void Write(const Comm::ConnectionPointer &conn, const char *buf, int size, AsyncCall::Pointer &callback, FREE *free_func)
Definition: Write.cc:33
Flag
Definition: Flag.h:15
@ OK
Definition: Flag.h:16
@ ERR_CLOSING
Definition: Flag.h:25
@ Unknown
Definition: ResultCode.h:17
@ BrokenHelper
Definition: ResultCode.h:20
@ Error
Definition: ResultCode.h:19
@ TimedOut
Definition: ResultCode.h:21
@ Okay
Definition: ResultCode.h:18
StatusCode
Definition: StatusCode.h:20
@ scForbidden
Definition: StatusCode.h:47
@ scUnauthorized
Definition: StatusCode.h:45
@ scFound
Definition: StatusCode.h:38
@ scInternalServerError
Definition: StatusCode.h:71
@ scConflict
Definition: StatusCode.h:53
@ scPermanentRedirect
Definition: StatusCode.h:43
@ scSeeOther
Definition: StatusCode.h:39
@ scProxyAuthenticationRequired
Definition: StatusCode.h:51
@ scTemporaryRedirect
Definition: StatusCode.h:42
@ scMovedPermanently
Definition: StatusCode.h:37
@ METHOD_TRACE
Definition: MethodType.h:30
@ METHOD_OTHER
Definition: MethodType.h:93
@ METHOD_CONNECT
Definition: MethodType.h:29
@ METHOD_GET
Definition: MethodType.h:25
@ METHOD_HEAD
Definition: MethodType.h:28
@ PROXY_AUTHORIZATION
@ IF_MODIFIED_SINCE
AnyP::ProtocolVersion ProtocolVersion(unsigned int aMajor, unsigned int aMinor)
HTTP version label information.
bool setNfConnmark(Comm::ConnectionPointer &conn, const ConnectionDirection connDir, const NfMarkConfig &cm)
Definition: QosConfig.cc:181
@ dirAccepted
accepted (from a client by Squid)
Definition: QosConfig.h:67
Config TheConfig
Globally available instance of Qos::Config.
Definition: QosConfig.cc:283
int setSockTos(const Comm::ConnectionPointer &conn, tos_t tos)
Definition: QosConfig.cc:570
int setSockNfmark(const Comm::ConnectionPointer &conn, nfmark_t mark)
Definition: QosConfig.cc:602
#define xfree
#define xstrdup
void storeIdStart(ClientHttpRequest *http, HLPCB *handler, void *data)
Definition: redirect.cc:311
void redirectStart(ClientHttpRequest *http, HLPCB *handler, void *data)
Definition: redirect.cc:285
@ toutActBypass
Definition: redirect.h:16
#define SQUIDCEXTERN
Definition: squid.h:21
StoreEntry * storeCreateEntry(const char *url, const char *logUrl, const RequestFlags &flags, const HttpRequestMethod &method)
Definition: store.cc:732
int64_t strtoll(const char *nptr, char **endptr, int base)
Definition: strtoll.c:61
char * url
Definition: tcp-banger2.c:114
char method[16]
Definition: tcp-banger2.c:115
int content_length
Definition: tcp-banger2.c:121
Definition: parse.c:104
struct _request * request(char *urlin)
Definition: tcp-banger2.c:291
struct timeval current_time
the current UNIX time in timeval {seconds, microseconds} format
Definition: gadgets.cc:17
void debugObj(int section, int level, const char *label, void *obj, ObjPackMethod pm)
Definition: tools.cc:935
void(* ObjPackMethod)(void *obj, Packable *p)
Definition: tools.h:33
#define NULL
Definition: types.h:166
void * xcalloc(size_t n, size_t sz)
Definition: xalloc.cc:71
#define safe_free(x)
Definition: xalloc.h:73
#define xisspace(x)
Definition: xis.h:17
char * xstrndup(const char *s, size_t n)
Definition: xstring.cc:56

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors