src/client_side_request.cc

   1 /*
   2  * Copyright (C) 1996-2015 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"
  27 #include "ClientRequestContext.h"
  28 #include "clientStream.h"
  29 #include "comm/Connection.h"
  30 #include "comm/Write.h"
  31 #include "err_detail_type.h"
  32 #include "errorpage.h"
  33 #include "fd.h"
  34 #include "fde.h"
  35 #include "format/Token.h"
  36 #include "gopher.h"
  37 #include "helper.h"
  38 #include "helper/Reply.h"
  39 #include "http.h"
  40 #include "HttpHdrCc.h"
  41 #include "HttpReply.h"
  42 #include "HttpRequest.h"
  43 #include "ip/QosConfig.h"
  44 #include "ipcache.h"
  45 #include "log/access_log.h"
  46 #include "MemObject.h"
  47 #include "Parsing.h"
  48 #include "profiler/Profiler.h"
  49 #include "redirect.h"
  50 #include "SquidConfig.h"
  51 #include "SquidTime.h"
  52 #include "Store.h"
  53 #include "StrList.h"
  54 #include "tools.h"
  55 #include "URL.h"
  56 #include "wordlist.h"
  57 #if USE_AUTH
  58 #include "auth/UserRequest.h"
  59 #endif
  60 #if USE_ADAPTATION
  61 #include "adaptation/AccessCheck.h"
  62 #include "adaptation/Answer.h"
  63 #include "adaptation/Iterator.h"
  64 #include "adaptation/Service.h"
  65 #if ICAP_CLIENT
  66 #include "adaptation/icap/History.h"
  67 #endif
  68 #endif
  69 #if USE_OPENSSL
  70 #include "ssl/ServerBump.h"
  71 #include "ssl/support.h"
  72 #endif
  73
  74 #if LINGERING_CLOSE
  75 #define comm_close comm_lingering_close
  76 #endif
  77
  78 static const char *const crlf = "\r\n";
  79
  80 #if FOLLOW_X_FORWARDED_FOR
  81 static void clientFollowXForwardedForCheck(allow_t answer, void *data);
  82 #endif /* FOLLOW_X_FORWARDED_FOR */
  83
  84 ErrorState *clientBuildError(err_type, Http::StatusCode, char const *url, Ip::Address &, HttpRequest *);
  85
  86 CBDATA_CLASS_INIT(ClientRequestContext);
  87
  88 /* Local functions */
  89 /* other */
  90 static void clientAccessCheckDoneWrapper(allow_t, void *);
  91 #if USE_OPENSSL
  92 static void sslBumpAccessCheckDoneWrapper(allow_t, void *);
  93 #endif
  94 static int clientHierarchical(ClientHttpRequest * http);
  95 static void clientInterpretRequestHeaders(ClientHttpRequest * http);
  96 static HLPCB clientRedirectDoneWrapper;
  97 static HLPCB clientStoreIdDoneWrapper;
  98 static void checkNoCacheDoneWrapper(allow_t, void *);
  99 SQUIDCEXTERN CSR clientGetMoreData;
 100 SQUIDCEXTERN CSS clientReplyStatus;
 101 SQUIDCEXTERN CSD clientReplyDetach;
 102 static void checkFailureRatio(err_type, hier_code);
 103
 104 ClientRequestContext::~ClientRequestContext()
 105 {
 106     /*
 107      * Release our "lock" on our parent, ClientHttpRequest, if we
 108      * still have one
 109      */
 110
 111     if (http)
 112         cbdataReferenceDone(http);
 113
 114     delete error;
 115     debugs(85,3, "ClientRequestContext destructed, this=" << this);
 116 }
 117
 118 ClientRequestContext::ClientRequestContext(ClientHttpRequest *anHttp) :
 119     http(cbdataReference(anHttp)),
 120     acl_checklist(NULL),
 121     redirect_state(REDIRECT_NONE),
 122     store_id_state(REDIRECT_NONE),
 123     host_header_verify_done(false),
 124     http_access_done(false),
 125     adapted_http_access_done(false),
 126 #if USE_ADAPTATION
 127     adaptation_acl_check_done(false),
 128 #endif
 129     redirect_done(false),
 130     store_id_done(false),
 131     no_cache_done(false),
 132     interpreted_req_hdrs(false),
 133     tosToClientDone(false),
 134     nfmarkToClientDone(false),
 135 #if USE_OPENSSL
 136     sslBumpCheckDone(false),
 137 #endif
 138     error(NULL),
 139     readNextRequest(false)
 140 {
 141     debugs(85, 3, "ClientRequestContext constructed, this=" << this);
 142 }
 143
 144 CBDATA_CLASS_INIT(ClientHttpRequest);
 145
 146 ClientHttpRequest::ClientHttpRequest(ConnStateData * aConn) :
 147 #if USE_ADAPTATION
 148     AsyncJob("ClientHttpRequest"),
 149 #endif
 150     request(NULL),
 151     uri(NULL),
 152     log_uri(NULL),
 153     req_sz(0),
 154     logType(LOG_TAG_NONE),
 155     calloutContext(NULL),
 156     maxReplyBodySize_(0),
 157     entry_(NULL),
 158     loggingEntry_(NULL),
 159     conn_(NULL)
 160 #if USE_OPENSSL
 161     , sslBumpNeed_(Ssl::bumpEnd)
 162 #endif
 163 #if USE_ADAPTATION
 164     , request_satisfaction_mode(false)
 165     , request_satisfaction_offset(0)
 166 #endif
 167 {
 168     setConn(aConn);
 169     al = new AccessLogEntry;
 170     al->cache.start_time = current_time;
 171     al->tcpClient = clientConnection = aConn->clientConnection;
 172     al->cache.port = aConn->port;
 173     al->cache.caddr = aConn->log_addr;
 174
 175 #if USE_OPENSSL
 176     if (aConn->clientConnection != NULL && aConn->clientConnection->isOpen()) {
 177         if (SSL *ssl = fd_table[aConn->clientConnection->fd].ssl)
 178             al->cache.sslClientCert.reset(SSL_get_peer_certificate(ssl));
 179     }
 180 #endif
 181     dlinkAdd(this, &active, &ClientActiveRequests);
 182 }
 183
 184 /*
 185  * returns true if client specified that the object must come from the cache
 186  * without contacting origin server
 187  */
 188 bool
 189 ClientHttpRequest::onlyIfCached()const
 190 {
 191     assert(request);
 192     return request->cache_control &&
 193            request->cache_control->onlyIfCached();
 194 }
 195
 196 /**
 197  * This function is designed to serve a fairly specific purpose.
 198  * Occasionally our vBNS-connected caches can talk to each other, but not
 199  * the rest of the world.  Here we try to detect frequent failures which
 200  * make the cache unusable (e.g. DNS lookup and connect() failures).  If
 201  * the failure:success ratio goes above 1.0 then we go into "hit only"
 202  * mode where we only return UDP_HIT or UDP_MISS_NOFETCH.  Neighbors
 203  * will only fetch HITs from us if they are using the ICP protocol.  We
 204  * stay in this mode for 5 minutes.
 205  *
 206  * Duane W., Sept 16, 1996
 207  */
 208 static void
 209 checkFailureRatio(err_type etype, hier_code hcode)
 210 {
 211     // Can be set at compile time with -D compiler flag
 212 #ifndef FAILURE_MODE_TIME
 213 #define FAILURE_MODE_TIME 300
 214 #endif
 215
 216     if (hcode == HIER_NONE)
 217         return;
 218
 219     // don't bother when ICP is disabled.
 220     if (Config.Port.icp <= 0)
 221         return;
 222
 223     static double magic_factor = 100.0;
 224     double n_good;
 225     double n_bad;
 226
 227     n_good = magic_factor / (1.0 + request_failure_ratio);
 228
 229     n_bad = magic_factor - n_good;
 230
 231     switch (etype) {
 232
 233     case ERR_DNS_FAIL:
 234
 235     case ERR_CONNECT_FAIL:
 236     case ERR_SECURE_CONNECT_FAIL:
 237
 238     case ERR_READ_ERROR:
 239         ++n_bad;
 240         break;
 241
 242     default:
 243         ++n_good;
 244     }
 245
 246     request_failure_ratio = n_bad / n_good;
 247
 248     if (hit_only_mode_until > squid_curtime)
 249         return;
 250
 251     if (request_failure_ratio < 1.0)
 252         return;
 253
 254     debugs(33, DBG_CRITICAL, "WARNING: Failure Ratio at "<< std::setw(4)<<
 255            std::setprecision(3) << request_failure_ratio);
 256
 257     debugs(33, DBG_CRITICAL, "WARNING: ICP going into HIT-only mode for " <<
 258            FAILURE_MODE_TIME / 60 << " minutes...");
 259
 260     hit_only_mode_until = squid_curtime + FAILURE_MODE_TIME;
 261
 262     request_failure_ratio = 0.8;    /* reset to something less than 1.0 */
 263 }
 264
 265 ClientHttpRequest::~ClientHttpRequest()
 266 {
 267     debugs(33, 3, "httpRequestFree: " << uri);
 268     PROF_start(httpRequestFree);
 269
 270     // Even though freeResources() below may destroy the request,
 271     // we no longer set request->body_pipe to NULL here
 272     // because we did not initiate that pipe (ConnStateData did)
 273
 274     /* the ICP check here was erroneous
 275      * - StoreEntry::releaseRequest was always called if entry was valid
 276      */
 277     assert(logType < LOG_TYPE_MAX);
 278
 279     logRequest();
 280
 281     loggingEntry(NULL);
 282
 283     if (request)
 284         checkFailureRatio(request->errType, al->hier.code);
 285
 286     freeResources();
 287
 288 #if USE_ADAPTATION
 289     announceInitiatorAbort(virginHeadSource);
 290
 291     if (adaptedBodySource != NULL)
 292         stopConsumingFrom(adaptedBodySource);
 293 #endif
 294
 295     if (calloutContext)
 296         delete calloutContext;
 297
 298     clientConnection = NULL;
 299
 300     if (conn_)
 301         cbdataReferenceDone(conn_);
 302
 303     /* moving to the next connection is handled by the context free */
 304     dlinkDelete(&active, &ClientActiveRequests);
 305
 306     PROF_stop(httpRequestFree);
 307 }
 308
 309 /**
 310  * Create a request and kick it off
 311  *
 312  * \retval 0     success
 313  * \retval -1    failure
 314  *
 315  * TODO: Pass in the buffers to be used in the inital Read request, as they are
 316  * determined by the user
 317  */
 318 int
 319 clientBeginRequest(const HttpRequestMethod& method, char const *url, CSCB * streamcallback,
 320                    CSD * streamdetach, ClientStreamData streamdata, HttpHeader const *header,
 321                    char *tailbuf, size_t taillen)
 322 {
 323     size_t url_sz;
 324     ClientHttpRequest *http = new ClientHttpRequest(NULL);
 325     HttpRequest *request;
 326     StoreIOBuffer tempBuffer;
 327     if (http->al != NULL)
 328         http->al->cache.start_time = current_time;
 329     /* this is only used to adjust the connection offset in client_side.c */
 330     http->req_sz = 0;
 331     tempBuffer.length = taillen;
 332     tempBuffer.data = tailbuf;
 333     /* client stream setup */
 334     clientStreamInit(&http->client_stream, clientGetMoreData, clientReplyDetach,
 335                      clientReplyStatus, new clientReplyContext(http), streamcallback,
 336                      streamdetach, streamdata, tempBuffer);
 337     /* make it visible in the 'current acctive requests list' */
 338     /* Set flags */
 339     /* internal requests only makes sense in an
 340      * accelerator today. TODO: accept flags ? */
 341     http->flags.accel = true;
 342     /* allow size for url rewriting */
 343     url_sz = strlen(url) + Config.appendDomainLen + 5;
 344     http->uri = (char *)xcalloc(url_sz, 1);
 345     strcpy(http->uri, url);
 346
 347     if ((request = HttpRequest::CreateFromUrlAndMethod(http->uri, method)) == NULL) {
 348         debugs(85, 5, "Invalid URL: " << http->uri);
 349         return -1;
 350     }
 351
 352     /*
 353      * now update the headers in request with our supplied headers. urlParse
 354      * should return a blank header set, but we use Update to be sure of
 355      * correctness.
 356      */
 357     if (header)
 358         request->header.update(header, NULL);
 359
 360     http->log_uri = xstrdup(urlCanonicalClean(request));
 361
 362     /* http struct now ready */
 363
 364     /*
 365      * build new header list *? TODO
 366      */
 367     request->flags.accelerated = http->flags.accel;
 368
 369     request->flags.internalClient = true;
 370
 371     /* this is an internally created
 372      * request, not subject to acceleration
 373      * target overrides */
 374     /*
 375      * FIXME? Do we want to detect and handle internal requests of internal
 376      * objects ?
 377      */
 378
 379     /* Internally created requests cannot have bodies today */
 380     request->content_length = 0;
 381
 382     request->client_addr.setNoAddr();
 383
 384 #if FOLLOW_X_FORWARDED_FOR
 385     request->indirect_client_addr.setNoAddr();
 386 #endif /* FOLLOW_X_FORWARDED_FOR */
 387
 388     request->my_addr.setNoAddr();   /* undefined for internal requests */
 389
 390     request->my_addr.port(0);
 391
 392     request->http_ver = Http::ProtocolVersion();
 393
 394     http->request = request;
 395     HTTPMSGLOCK(http->request);
 396
 397     /* optional - skip the access check ? */
 398     http->calloutContext = new ClientRequestContext(http);
 399
 400     http->calloutContext->http_access_done = false;
 401
 402     http->calloutContext->redirect_done = true;
 403
 404     http->calloutContext->no_cache_done = true;
 405
 406     http->doCallouts();
 407
 408     return 0;
 409 }
 410
 411 bool
 412 ClientRequestContext::httpStateIsValid()
 413 {
 414     ClientHttpRequest *http_ = http;
 415
 416     if (cbdataReferenceValid(http_))
 417         return true;
 418
 419     http = NULL;
 420
 421     cbdataReferenceDone(http_);
 422
 423     return false;
 424 }
 425
 426 #if FOLLOW_X_FORWARDED_FOR
 427 /**
 428  * clientFollowXForwardedForCheck() checks the content of X-Forwarded-For:
 429  * against the followXFF ACL, or cleans up and passes control to
 430  * clientAccessCheck().
 431  *
 432  * The trust model here is a little ambiguous. So to clarify the logic:
 433  * - we may always use the direct client address as the client IP.
 434  * - these trust tests merey tell whether we trust given IP enough to believe the
 435  *   IP string which it appended to the X-Forwarded-For: header.
 436  * - if at any point we don't trust what an IP adds we stop looking.
 437  * - at that point the current contents of indirect_client_addr are the value set
 438  *   by the last previously trusted IP.
 439  * ++ indirect_client_addr contains the remote direct client from the trusted peers viewpoint.
 440  */
 441 static void
 442 clientFollowXForwardedForCheck(allow_t answer, void *data)
 443 {
 444     ClientRequestContext *calloutContext = (ClientRequestContext *) data;
 445
 446     if (!calloutContext->httpStateIsValid())
 447         return;
 448
 449     ClientHttpRequest *http = calloutContext->http;
 450     HttpRequest *request = http->request;
 451
 452     /*
 453      * answer should be be ACCESS_ALLOWED or ACCESS_DENIED if we are
 454      * called as a result of ACL checks, or -1 if we are called when
 455      * there's nothing left to do.
 456      */
 457     if (answer == ACCESS_ALLOWED &&
 458             request->x_forwarded_for_iterator.size () != 0) {
 459
 460         /*
 461          * Remove the last comma-delimited element from the
 462          * x_forwarded_for_iterator and use it to repeat the cycle.
 463          */
 464         const char *p;
 465         const char *asciiaddr;
 466         int l;
 467         Ip::Address addr;
 468         p = request->x_forwarded_for_iterator.termedBuf();
 469         l = request->x_forwarded_for_iterator.size();
 470
 471         /*
 472         * XXX x_forwarded_for_iterator should really be a list of
 473         * IP addresses, but it's a String instead.  We have to
 474         * walk backwards through the String, biting off the last
 475         * comma-delimited part each time.  As long as the data is in
 476         * a String, we should probably implement and use a variant of
 477         * strListGetItem() that walks backwards instead of forwards
 478         * through a comma-separated list.  But we don't even do that;
 479         * we just do the work in-line here.
 480         */
 481         /* skip trailing space and commas */
 482         while (l > 0 && (p[l-1] == ',' || xisspace(p[l-1])))
 483             --l;
 484         request->x_forwarded_for_iterator.cut(l);
 485         /* look for start of last item in list */
 486         while (l > 0 && ! (p[l-1] == ',' || xisspace(p[l-1])))
 487             --l;
 488         asciiaddr = p+l;
 489         if ((addr = asciiaddr)) {
 490             request->indirect_client_addr = addr;
 491             request->x_forwarded_for_iterator.cut(l);
 492             calloutContext->acl_checklist = clientAclChecklistCreate(Config.accessList.followXFF, http);
 493             if (!Config.onoff.acl_uses_indirect_client) {
 494                 /* override the default src_addr tested if we have to go deeper than one level into XFF */
 495                 Filled(calloutContext->acl_checklist)->src_addr = request->indirect_client_addr;
 496             }
 497             calloutContext->acl_checklist->nonBlockingCheck(clientFollowXForwardedForCheck, data);
 498             return;
 499         }
 500     } /*if (answer == ACCESS_ALLOWED &&
 501         request->x_forwarded_for_iterator.size () != 0)*/
 502
 503     /* clean up, and pass control to clientAccessCheck */
 504     if (Config.onoff.log_uses_indirect_client) {
 505         /*
 506         * Ensure that the access log shows the indirect client
 507         * instead of the direct client.
 508         */
 509         ConnStateData *conn = http->getConn();
 510         conn->log_addr = request->indirect_client_addr;
 511         http->al->cache.caddr = conn->log_addr;
 512     }
 513     request->x_forwarded_for_iterator.clean();
 514     request->flags.done_follow_x_forwarded_for = true;
 515
 516     if (answer != ACCESS_ALLOWED && answer != ACCESS_DENIED) {
 517         debugs(28, DBG_CRITICAL, "ERROR: Processing X-Forwarded-For. Stopping at IP address: " << request->indirect_client_addr );
 518     }
 519
 520     /* process actual access ACL as normal. */
 521     calloutContext->clientAccessCheck();
 522 }
 523 #endif /* FOLLOW_X_FORWARDED_FOR */
 524
 525 static void
 526 hostHeaderIpVerifyWrapper(const ipcache_addrs* ia, const Dns::LookupDetails &dns, void *data)
 527 {
 528     ClientRequestContext *c = static_cast<ClientRequestContext*>(data);
 529     c->hostHeaderIpVerify(ia, dns);
 530 }
 531
 532 void
 533 ClientRequestContext::hostHeaderIpVerify(const ipcache_addrs* ia, const Dns::LookupDetails &dns)
 534 {
 535     Comm::ConnectionPointer clientConn = http->getConn()->clientConnection;
 536
 537     // note the DNS details for the transaction stats.
 538     http->request->recordLookup(dns);
 539
 540     if (ia != NULL && ia->count > 0) {
 541         // Is the NAT destination IP in DNS?
 542         for (int i = 0; i < ia->count; ++i) {
 543             if (clientConn->local.matchIPAddr(ia->in_addrs[i]) == 0) {
 544                 debugs(85, 3, HERE << "validate IP " << clientConn->local << " possible from Host:");
 545                 http->request->flags.hostVerified = true;
 546                 http->doCallouts();
 547                 return;
 548             }
 549             debugs(85, 3, HERE << "validate IP " << clientConn->local << " non-match from Host: IP " << ia->in_addrs[i]);
 550         }
 551     }
 552     debugs(85, 3, HERE << "FAIL: validate IP " << clientConn->local << " possible from Host:");
 553     hostHeaderVerifyFailed("local IP", "any domain IP");
 554 }
 555
 556 void
 557 ClientRequestContext::hostHeaderVerifyFailed(const char *A, const char *B)
 558 {
 559     // IP address validation for Host: failed. Admin wants to ignore them.
 560     // NP: we do not yet handle CONNECT tunnels well, so ignore for them
 561     if (!Config.onoff.hostStrictVerify && http->request->method != Http::METHOD_CONNECT) {
 562         debugs(85, 3, "SECURITY ALERT: Host header forgery detected on " << http->getConn()->clientConnection <<
 563                " (" << A << " does not match " << B << ") on URL: " << urlCanonical(http->request));
 564
 565         // NP: it is tempting to use 'flags.noCache' but that is all about READing cache data.
 566         // The problems here are about WRITE for new cache content, which means flags.cachable
 567         http->request->flags.cachable = false; // MUST NOT cache (for now)
 568         // XXX: when we have updated the cache key to base on raw-IP + URI this cacheable limit can go.
 569         http->request->flags.hierarchical = false; // MUST NOT pass to peers (for now)
 570         // XXX: when we have sorted out the best way to relay requests properly to peers this hierarchical limit can go.
 571         http->doCallouts();
 572         return;
 573     }
 574
 575     debugs(85, DBG_IMPORTANT, "SECURITY ALERT: Host header forgery detected on " <<
 576            http->getConn()->clientConnection << " (" << A << " does not match " << B << ")");
 577     debugs(85, DBG_IMPORTANT, "SECURITY ALERT: By user agent: " << http->request->header.getStr(HDR_USER_AGENT));
 578     debugs(85, DBG_IMPORTANT, "SECURITY ALERT: on URL: " << urlCanonical(http->request));
 579
 580     // IP address validation for Host: failed. reject the connection.
 581     clientStreamNode *node = (clientStreamNode *)http->client_stream.tail->prev->data;
 582     clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
 583     assert (repContext);
 584     repContext->setReplyToError(ERR_CONFLICT_HOST, Http::scConflict,
 585                                 http->request->method, NULL,
 586                                 http->getConn()->clientConnection->remote,
 587                                 http->request,
 588                                 NULL,
 589 #if USE_AUTH
 590                                 http->getConn() != NULL && http->getConn()->getAuth() != NULL ?
 591                                 http->getConn()->getAuth() : http->request->auth_user_request);
 592 #else
 593                                 NULL);
 594 #endif
 595     node = (clientStreamNode *)http->client_stream.tail->data;
 596     clientStreamRead(node, http, node->readBuffer);
 597 }
 598
 599 void
 600 ClientRequestContext::hostHeaderVerify()
 601 {
 602     // Require a Host: header.
 603     const char *host = http->request->header.getStr(HDR_HOST);
 604
 605     if (!host) {
 606         // TODO: dump out the HTTP/1.1 error about missing host header.
 607         // otherwise this is fine, can't forge a header value when its not even set.
 608         debugs(85, 3, HERE << "validate skipped with no Host: header present.");
 609         http->doCallouts();
 610         return;
 611     }
 612
 613     if (http->request->flags.internal) {
 614         // TODO: kill this when URL handling allows partial URLs out of accel mode
 615         //       and we no longer screw with the URL just to add our internal host there
 616         debugs(85, 6, HERE << "validate skipped due to internal composite URL.");
 617         http->doCallouts();
 618         return;
 619     }
 620
 621     // Locate if there is a port attached, strip ready for IP lookup
 622     char *portStr = NULL;
 623     char *hostB = xstrdup(host);
 624     host = hostB;
 625     if (host[0] == '[') {
 626         // IPv6 literal.
 627         portStr = strchr(hostB, ']');
 628         if (portStr && *(++portStr) != ':') {
 629             portStr = NULL;
 630         }
 631     } else {
 632         // Domain or IPv4 literal with port
 633         portStr = strrchr(hostB, ':');
 634     }
 635
 636     uint16_t port = 0;
 637     if (portStr) {
 638         *portStr = '\0'; // strip the ':'
 639         if (*(++portStr) != '\0') {
 640             char *end = NULL;
 641             int64_t ret = strtoll(portStr, &end, 10);
 642             if (end == portStr || *end != '\0' || ret < 1 || ret > 0xFFFF) {
 643                 // invalid port details. Replace the ':'
 644                 *(--portStr) = ':';
 645                 portStr = NULL;
 646             } else
 647                 port = (ret & 0xFFFF);
 648         }
 649     }
 650
 651     debugs(85, 3, HERE << "validate host=" << host << ", port=" << port << ", portStr=" << (portStr?portStr:"NULL"));
 652     if (http->request->flags.intercepted || http->request->flags.interceptTproxy) {
 653         // verify the Host: port (if any) matches the apparent destination
 654         if (portStr && port != http->getConn()->clientConnection->local.port()) {
 655             debugs(85, 3, HERE << "FAIL on validate port " << http->getConn()->clientConnection->local.port() <<
 656                    " matches Host: port " << port << " (" << portStr << ")");
 657             hostHeaderVerifyFailed("intercepted port", portStr);
 658         } else {
 659             // XXX: match the scheme default port against the apparent destination
 660
 661             // verify the destination DNS is one of the Host: headers IPs
 662             ipcache_nbgethostbyname(host, hostHeaderIpVerifyWrapper, this);
 663         }
 664     } else if (!Config.onoff.hostStrictVerify) {
 665         debugs(85, 3, HERE << "validate skipped.");
 666         http->doCallouts();
 667     } else if (strlen(host) != strlen(http->request->GetHost())) {
 668         // Verify forward-proxy requested URL domain matches the Host: header
 669         debugs(85, 3, HERE << "FAIL on validate URL domain length " << http->request->GetHost() << " matches Host: " << host);
 670         hostHeaderVerifyFailed(host, http->request->GetHost());
 671     } else if (matchDomainName(host, http->request->GetHost()) != 0) {
 672         // Verify forward-proxy requested URL domain matches the Host: header
 673         debugs(85, 3, HERE << "FAIL on validate URL domain " << http->request->GetHost() << " matches Host: " << host);
 674         hostHeaderVerifyFailed(host, http->request->GetHost());
 675     } else if (portStr && port != http->request->port) {
 676         // Verify forward-proxy requested URL domain matches the Host: header
 677         debugs(85, 3, HERE << "FAIL on validate URL port " << http->request->port << " matches Host: port " << portStr);
 678         hostHeaderVerifyFailed("URL port", portStr);
 679     } else if (!portStr && http->request->method != Http::METHOD_CONNECT && http->request->port != urlDefaultPort(http->request->url.getScheme())) {
 680         // Verify forward-proxy requested URL domain matches the Host: header
 681         // Special case: we don't have a default-port to check for CONNECT. Assume URL is correct.
 682         debugs(85, 3, "FAIL on validate URL port " << http->request->port << " matches Host: default port " << urlDefaultPort(http->request->url.getScheme()));
 683         hostHeaderVerifyFailed("URL port", "default port");
 684     } else {
 685         // Okay no problem.
 686         debugs(85, 3, HERE << "validate passed.");
 687         http->request->flags.hostVerified = true;
 688         http->doCallouts();
 689     }
 690     safe_free(hostB);
 691 }
 692
 693 /* This is the entry point for external users of the client_side routines */
 694 void
 695 ClientRequestContext::clientAccessCheck()
 696 {
 697 #if FOLLOW_X_FORWARDED_FOR
 698     if (!http->request->flags.doneFollowXff() &&
 699             Config.accessList.followXFF &&
 700             http->request->header.has(HDR_X_FORWARDED_FOR)) {
 701
 702         /* we always trust the direct client address for actual use */
 703         http->request->indirect_client_addr = http->request->client_addr;
 704         http->request->indirect_client_addr.port(0);
 705
 706         /* setup the XFF iterator for processing */
 707         http->request->x_forwarded_for_iterator = http->request->header.getList(HDR_X_FORWARDED_FOR);
 708
 709         /* begin by checking to see if we trust direct client enough to walk XFF */
 710         acl_checklist = clientAclChecklistCreate(Config.accessList.followXFF, http);
 711         acl_checklist->nonBlockingCheck(clientFollowXForwardedForCheck, this);
 712         return;
 713     }
 714 #endif
 715
 716     if (Config.accessList.http) {
 717         acl_checklist = clientAclChecklistCreate(Config.accessList.http, http);
 718         acl_checklist->nonBlockingCheck(clientAccessCheckDoneWrapper, this);
 719     } else {
 720         debugs(0, DBG_CRITICAL, "No http_access configuration found. This will block ALL traffic");
 721         clientAccessCheckDone(ACCESS_DENIED);
 722     }
 723 }
 724
 725 /**
 726  * Identical in operation to clientAccessCheck() but performed later using different configured ACL list.
 727  * The default here is to allow all. Since the earlier http_access should do a default deny all.
 728  * This check is just for a last-minute denial based on adapted request headers.
 729  */
 730 void
 731 ClientRequestContext::clientAccessCheck2()
 732 {
 733     if (Config.accessList.adapted_http) {
 734         acl_checklist = clientAclChecklistCreate(Config.accessList.adapted_http, http);
 735         acl_checklist->nonBlockingCheck(clientAccessCheckDoneWrapper, this);
 736     } else {
 737         debugs(85, 2, HERE << "No adapted_http_access configuration. default: ALLOW");
 738         clientAccessCheckDone(ACCESS_ALLOWED);
 739     }
 740 }
 741
 742 void
 743 clientAccessCheckDoneWrapper(allow_t answer, void *data)
 744 {
 745     ClientRequestContext *calloutContext = (ClientRequestContext *) data;
 746
 747     if (!calloutContext->httpStateIsValid())
 748         return;
 749
 750     calloutContext->clientAccessCheckDone(answer);
 751 }
 752
 753 void
 754 ClientRequestContext::clientAccessCheckDone(const allow_t &answer)
 755 {
 756     acl_checklist = NULL;
 757     err_type page_id;
 758     Http::StatusCode status;
 759     debugs(85, 2, "The request " << http->request->method << ' ' <<
 760            http->uri << " is " << answer <<
 761            "; last ACL checked: " << (AclMatchedName ? AclMatchedName : "[none]"));
 762
 763 #if USE_AUTH
 764     char const *proxy_auth_msg = "<null>";
 765     if (http->getConn() != NULL && http->getConn()->getAuth() != NULL)
 766         proxy_auth_msg = http->getConn()->getAuth()->denyMessage("<null>");
 767     else if (http->request->auth_user_request != NULL)
 768         proxy_auth_msg = http->request->auth_user_request->denyMessage("<null>");
 769 #endif
 770
 771     if (answer != ACCESS_ALLOWED) {
 772         // auth has a grace period where credentials can be expired but okay not to challenge.
 773
 774         /* Send an auth challenge or error */
 775         // XXX: do we still need aclIsProxyAuth() ?
 776         bool auth_challenge = (answer == ACCESS_AUTH_REQUIRED || aclIsProxyAuth(AclMatchedName));
 777         debugs(85, 5, "Access Denied: " << http->uri);
 778         debugs(85, 5, "AclMatchedName = " << (AclMatchedName ? AclMatchedName : "<null>"));
 779 #if USE_AUTH
 780         if (auth_challenge)
 781             debugs(33, 5, "Proxy Auth Message = " << (proxy_auth_msg ? proxy_auth_msg : "<null>"));
 782 #endif
 783
 784         /*
 785          * NOTE: get page_id here, based on AclMatchedName because if
 786          * USE_DELAY_POOLS is enabled, then AclMatchedName gets clobbered in
 787          * the clientCreateStoreEntry() call just below.  Pedro Ribeiro
 788          * <pribeiro@isel.pt>
 789          */
 790         page_id = aclGetDenyInfoPage(&Config.denyInfoList, AclMatchedName, answer != ACCESS_AUTH_REQUIRED);
 791
 792         http->logType = LOG_TCP_DENIED;
 793
 794         if (auth_challenge) {
 795 #if USE_AUTH
 796             if (http->request->flags.sslBumped) {
 797                 /*SSL Bumped request, authentication is not possible*/
 798                 status = Http::scForbidden;
 799             } else if (!http->flags.accel) {
 800                 /* Proxy authorisation needed */
 801                 status = Http::scProxyAuthenticationRequired;
 802             } else {
 803                 /* WWW authorisation needed */
 804                 status = Http::scUnauthorized;
 805             }
 806 #else
 807             // need auth, but not possible to do.
 808             status = Http::scForbidden;
 809 #endif
 810             if (page_id == ERR_NONE)
 811                 page_id = ERR_CACHE_ACCESS_DENIED;
 812         } else {
 813             status = Http::scForbidden;
 814
 815             if (page_id == ERR_NONE)
 816                 page_id = ERR_ACCESS_DENIED;
 817         }
 818
 819         Ip::Address tmpnoaddr;
 820         tmpnoaddr.setNoAddr();
 821         error = clientBuildError(page_id, status,
 822                                  NULL,
 823                                  http->getConn() != NULL ? http->getConn()->clientConnection->remote : tmpnoaddr,
 824                                  http->request
 825                                 );
 826
 827 #if USE_AUTH
 828         error->auth_user_request =
 829             http->getConn() != NULL && http->getConn()->getAuth() != NULL ?
 830             http->getConn()->getAuth() : http->request->auth_user_request;
 831 #endif
 832
 833         readNextRequest = true;
 834     }
 835
 836     /* ACCESS_ALLOWED continues here ... */
 837     safe_free(http->uri);
 838
 839     http->uri = xstrdup(urlCanonical(http->request));
 840
 841     http->doCallouts();
 842 }
 843
 844 #if USE_ADAPTATION
 845 void
 846 ClientHttpRequest::noteAdaptationAclCheckDone(Adaptation::ServiceGroupPointer g)
 847 {
 848     debugs(93,3,HERE << this << " adaptationAclCheckDone called");
 849
 850 #if ICAP_CLIENT
 851     Adaptation::Icap::History::Pointer ih = request->icapHistory();
 852     if (ih != NULL) {
 853         if (getConn() != NULL && getConn()->clientConnection != NULL) {
 854             ih->rfc931 = getConn()->clientConnection->rfc931;
 855 #if USE_OPENSSL
 856             if (getConn()->clientConnection->isOpen()) {
 857                 ih->ssluser = sslGetUserEmail(fd_table[getConn()->clientConnection->fd].ssl);
 858             }
 859 #endif
 860         }
 861         ih->log_uri = log_uri;
 862         ih->req_sz = req_sz;
 863     }
 864 #endif
 865
 866     if (!g) {
 867         debugs(85,3, HERE << "no adaptation needed");
 868         doCallouts();
 869         return;
 870     }
 871
 872     startAdaptation(g);
 873 }
 874
 875 #endif
 876
 877 static void
 878 clientRedirectAccessCheckDone(allow_t answer, void *data)
 879 {
 880     ClientRequestContext *context = (ClientRequestContext *)data;
 881     ClientHttpRequest *http = context->http;
 882     context->acl_checklist = NULL;
 883
 884     if (answer == ACCESS_ALLOWED)
 885         redirectStart(http, clientRedirectDoneWrapper, context);
 886     else {
 887         Helper::Reply nilReply;
 888         nilReply.result = Helper::Error;
 889         context->clientRedirectDone(nilReply);
 890     }
 891 }
 892
 893 void
 894 ClientRequestContext::clientRedirectStart()
 895 {
 896     debugs(33, 5, HERE << "'" << http->uri << "'");
 897     (void)SyncNotes(*http->al, *http->request);
 898     if (Config.accessList.redirector) {
 899         acl_checklist = clientAclChecklistCreate(Config.accessList.redirector, http);
 900         acl_checklist->nonBlockingCheck(clientRedirectAccessCheckDone, this);
 901     } else
 902         redirectStart(http, clientRedirectDoneWrapper, this);
 903 }
 904
 905 /**
 906  * This methods handles Access checks result of StoreId access list.
 907  * Will handle as "ERR" (no change) in a case Access is not allowed.
 908  */
 909 static void
 910 clientStoreIdAccessCheckDone(allow_t answer, void *data)
 911 {
 912     ClientRequestContext *context = static_cast<ClientRequestContext *>(data);
 913     ClientHttpRequest *http = context->http;
 914     context->acl_checklist = NULL;
 915
 916     if (answer == ACCESS_ALLOWED)
 917         storeIdStart(http, clientStoreIdDoneWrapper, context);
 918     else {
 919         debugs(85, 3, "access denied expected ERR reply handling: " << answer);
 920         Helper::Reply nilReply;
 921         nilReply.result = Helper::Error;
 922         context->clientStoreIdDone(nilReply);
 923     }
 924 }
 925
 926 /**
 927  * Start locating an alternative storeage ID string (if any) from admin
 928  * configured helper program. This is an asynchronous operation terminating in
 929  * ClientRequestContext::clientStoreIdDone() when completed.
 930  */
 931 void
 932 ClientRequestContext::clientStoreIdStart()
 933 {
 934     debugs(33, 5,"'" << http->uri << "'");
 935
 936     if (Config.accessList.store_id) {
 937         acl_checklist = clientAclChecklistCreate(Config.accessList.store_id, http);
 938         acl_checklist->nonBlockingCheck(clientStoreIdAccessCheckDone, this);
 939     } else
 940         storeIdStart(http, clientStoreIdDoneWrapper, this);
 941 }
 942
 943 static int
 944 clientHierarchical(ClientHttpRequest * http)
 945 {
 946     HttpRequest *request = http->request;
 947     HttpRequestMethod method = request->method;
 948
 949     // intercepted requests MUST NOT (yet) be sent to peers unless verified
 950     if (!request->flags.hostVerified && (request->flags.intercepted || request->flags.interceptTproxy))
 951         return 0;
 952
 953     /*
 954      * IMS needs a private key, so we can use the hierarchy for IMS only if our
 955      * neighbors support private keys
 956      */
 957
 958     if (request->flags.ims && !neighbors_do_private_keys)
 959         return 0;
 960
 961     /*
 962      * This is incorrect: authenticating requests can be sent via a hierarchy
 963      * (they can even be cached if the correct headers are set on the reply)
 964      */
 965     if (request->flags.auth)
 966         return 0;
 967
 968     if (method == Http::METHOD_TRACE)
 969         return 1;
 970
 971     if (method != Http::METHOD_GET)
 972         return 0;
 973
 974     if (request->flags.loopDetected)
 975         return 0;
 976
 977     if (request->url.getScheme() == AnyP::PROTO_HTTP)
 978         return method.respMaybeCacheable();
 979
 980     if (request->url.getScheme() == AnyP::PROTO_GOPHER)
 981         return gopherCachable(request);
 982
 983     if (request->url.getScheme() == AnyP::PROTO_CACHE_OBJECT)
 984         return 0;
 985
 986     return 1;
 987 }
 988
 989 static void
 990 clientCheckPinning(ClientHttpRequest * http)
 991 {
 992     HttpRequest *request = http->request;
 993     HttpHeader *req_hdr = &request->header;
 994     ConnStateData *http_conn = http->getConn();
 995
 996     /* Internal requests such as those from ESI includes may be without
 997      * a client connection
 998      */
 999     if (!http_conn)
1000         return;
1001
1002     request->flags.connectionAuthDisabled = http_conn->port->connection_auth_disabled;
1003     if (!request->flags.connectionAuthDisabled) {
1004         if (Comm::IsConnOpen(http_conn->pinning.serverConnection)) {
1005             if (http_conn->pinning.auth) {
1006                 request->flags.connectionAuth = true;
1007                 request->flags.auth = true;
1008             } else {
1009                 request->flags.connectionProxyAuth = true;
1010             }
1011             // These should already be linked correctly.
1012             assert(request->clientConnectionManager == http_conn);
1013         }
1014     }
1015
1016     /* check if connection auth is used, and flag as candidate for pinning
1017      * in such case.
1018      * Note: we may need to set flags.connectionAuth even if the connection
1019      * is already pinned if it was pinned earlier due to proxy auth
1020      */
1021     if (!request->flags.connectionAuth) {
1022         if (req_hdr->has(HDR_AUTHORIZATION) || req_hdr->has(HDR_PROXY_AUTHORIZATION)) {
1023             HttpHeaderPos pos = HttpHeaderInitPos;
1024             HttpHeaderEntry *e;
1025             int may_pin = 0;
1026             while ((e = req_hdr->getEntry(&pos))) {
1027                 if (e->id == HDR_AUTHORIZATION || e->id == HDR_PROXY_AUTHORIZATION) {
1028                     const char *value = e->value.rawBuf();
1029                     if (strncasecmp(value, "NTLM ", 5) == 0
1030                             ||
1031                             strncasecmp(value, "Negotiate ", 10) == 0
1032                             ||
1033                             strncasecmp(value, "Kerberos ", 9) == 0) {
1034                         if (e->id == HDR_AUTHORIZATION) {
1035                             request->flags.connectionAuth = true;
1036                             may_pin = 1;
1037                         } else {
1038                             request->flags.connectionProxyAuth = true;
1039                             may_pin = 1;
1040                         }
1041                     }
1042                 }
1043             }
1044             if (may_pin && !request->pinnedConnection()) {
1045                 // These should already be linked correctly. Just need the ServerConnection to pinn.
1046                 assert(request->clientConnectionManager == http_conn);
1047             }
1048         }
1049     }
1050 }
1051
1052 static void
1053 clientInterpretRequestHeaders(ClientHttpRequest * http)
1054 {
1055     HttpRequest *request = http->request;
1056     HttpHeader *req_hdr = &request->header;
1057     bool no_cache = false;
1058     const char *str;
1059
1060     request->imslen = -1;
1061     request->ims = req_hdr->getTime(HDR_IF_MODIFIED_SINCE);
1062
1063     if (request->ims > 0)
1064         request->flags.ims = true;
1065
1066     if (!request->flags.ignoreCc) {
1067         if (request->cache_control) {
1068             if (request->cache_control->hasNoCache())
1069                 no_cache=true;
1070
1071             // RFC 2616: treat Pragma:no-cache as if it was Cache-Control:no-cache when Cache-Control is missing
1072         } else if (req_hdr->has(HDR_PRAGMA))
1073             no_cache = req_hdr->hasListMember(HDR_PRAGMA,"no-cache",',');
1074
1075         /*
1076         * Work around for supporting the Reload button in IE browsers when Squid
1077         * is used as an accelerator or transparent proxy, by turning accelerated
1078         * IMS request to no-cache requests. Now knows about IE 5.5 fix (is
1079         * actually only fixed in SP1, but we can't tell whether we are talking to
1080         * SP1 or not so all 5.5 versions are treated 'normally').
1081         */
1082         if (Config.onoff.ie_refresh) {
1083             if (http->flags.accel && request->flags.ims) {
1084                 if ((str = req_hdr->getStr(HDR_USER_AGENT))) {
1085                     if (strstr(str, "MSIE 5.01") != NULL)
1086                         no_cache=true;
1087                     else if (strstr(str, "MSIE 5.0") != NULL)
1088                         no_cache=true;
1089                     else if (strstr(str, "MSIE 4.") != NULL)
1090                         no_cache=true;
1091                     else if (strstr(str, "MSIE 3.") != NULL)
1092                         no_cache=true;
1093                 }
1094             }
1095         }
1096     }
1097
1098     if (request->method == Http::METHOD_OTHER) {
1099         no_cache=true;
1100     }
1101
1102     if (no_cache) {
1103 #if USE_HTTP_VIOLATIONS
1104
1105         if (Config.onoff.reload_into_ims)
1106             request->flags.nocacheHack = true;
1107         else if (refresh_nocache_hack)
1108             request->flags.nocacheHack = true;
1109         else
1110 #endif
1111
1112             request->flags.noCache = true;
1113     }
1114
1115     /* ignore range header in non-GETs or non-HEADs */
1116     if (request->method == Http::METHOD_GET || request->method == Http::METHOD_HEAD) {
1117         // XXX: initialize if we got here without HttpRequest::parseHeader()
1118         if (!request->range)
1119             request->range = req_hdr->getRange();
1120
1121         if (request->range) {
1122             request->flags.isRanged = true;
1123             clientStreamNode *node = (clientStreamNode *)http->client_stream.tail->data;
1124             /* XXX: This is suboptimal. We should give the stream the range set,
1125              * and thereby let the top of the stream set the offset when the
1126              * size becomes known. As it is, we will end up requesting from 0
1127              * for evey -X range specification.
1128              * RBC - this may be somewhat wrong. We should probably set the range
1129              * iter up at this point.
1130              */
1131             node->readBuffer.offset = request->range->lowestOffset(0);
1132             http->range_iter.pos = request->range->begin();
1133             http->range_iter.end = request->range->end();
1134             http->range_iter.valid = true;
1135         }
1136     }
1137
1138     /* Only HEAD and GET requests permit a Range or Request-Range header.
1139      * If these headers appear on any other type of request, delete them now.
1140      */
1141     else {
1142         req_hdr->delById(HDR_RANGE);
1143         req_hdr->delById(HDR_REQUEST_RANGE);
1144         request->ignoreRange("neither HEAD nor GET");
1145     }
1146
1147     if (req_hdr->has(HDR_AUTHORIZATION))
1148         request->flags.auth = true;
1149
1150     clientCheckPinning(http);
1151
1152     if (!request->url.userInfo().isEmpty())
1153         request->flags.auth = true;
1154
1155     if (req_hdr->has(HDR_VIA)) {
1156         String s = req_hdr->getList(HDR_VIA);
1157         /*
1158          * ThisCache cannot be a member of Via header, "1.1 ThisCache" can.
1159          * Note ThisCache2 has a space prepended to the hostname so we don't
1160          * accidentally match super-domains.
1161          */
1162
1163         if (strListIsSubstr(&s, ThisCache2, ',')) {
1164             debugObj(33, 1, "WARNING: Forwarding loop detected for:\n",
1165                      request, (ObjPackMethod) & httpRequestPack);
1166             request->flags.loopDetected = true;
1167         }
1168
1169 #if USE_FORW_VIA_DB
1170         fvdbCountVia(s.termedBuf());
1171
1172 #endif
1173
1174         s.clean();
1175     }
1176
1177 #if USE_FORW_VIA_DB
1178
1179     if (req_hdr->has(HDR_X_FORWARDED_FOR)) {
1180         String s = req_hdr->getList(HDR_X_FORWARDED_FOR);
1181         fvdbCountForw(s.termedBuf());
1182         s.clean();
1183     }
1184
1185 #endif
1186
1187     request->flags.cachable = http->request->maybeCacheable();
1188
1189     if (clientHierarchical(http))
1190         request->flags.hierarchical = true;
1191
1192     debugs(85, 5, "clientInterpretRequestHeaders: REQ_NOCACHE = " <<
1193            (request->flags.noCache ? "SET" : "NOT SET"));
1194     debugs(85, 5, "clientInterpretRequestHeaders: REQ_CACHABLE = " <<
1195            (request->flags.cachable ? "SET" : "NOT SET"));
1196     debugs(85, 5, "clientInterpretRequestHeaders: REQ_HIERARCHICAL = " <<
1197            (request->flags.hierarchical ? "SET" : "NOT SET"));
1198
1199 }
1200
1201 void
1202 clientRedirectDoneWrapper(void *data, const Helper::Reply &result)
1203 {
1204     ClientRequestContext *calloutContext = (ClientRequestContext *)data;
1205
1206     if (!calloutContext->httpStateIsValid())
1207         return;
1208
1209     calloutContext->clientRedirectDone(result);
1210 }
1211
1212 void
1213 clientStoreIdDoneWrapper(void *data, const Helper::Reply &result)
1214 {
1215     ClientRequestContext *calloutContext = (ClientRequestContext *)data;
1216
1217     if (!calloutContext->httpStateIsValid())
1218         return;
1219
1220     calloutContext->clientStoreIdDone(result);
1221 }
1222
1223 void
1224 ClientRequestContext::clientRedirectDone(const Helper::Reply &reply)
1225 {
1226     HttpRequest *old_request = http->request;
1227     debugs(85, 5, HERE << "'" << http->uri << "' result=" << reply);
1228     assert(redirect_state == REDIRECT_PENDING);
1229     redirect_state = REDIRECT_DONE;
1230
1231     // Put helper response Notes into the transaction state record (ALE) eventually
1232     // do it early to ensure that no matter what the outcome the notes are present.
1233     if (http->al != NULL)
1234         (void)SyncNotes(*http->al, *old_request);
1235
1236     UpdateRequestNotes(http->getConn(), *old_request, reply.notes);
1237
1238     switch (reply.result) {
1239     case Helper::TimedOut:
1240         if (Config.onUrlRewriteTimeout.action != toutActBypass) {
1241             http->calloutsError(ERR_GATEWAY_FAILURE, ERR_DETAIL_REDIRECTOR_TIMEDOUT);
1242             debugs(85, DBG_IMPORTANT, "ERROR: URL rewrite helper: Timedout");
1243         }
1244         break;
1245
1246     case Helper::Unknown:
1247     case Helper::TT:
1248         // Handler in redirect.cc should have already mapped Unknown
1249         // IF it contained valid entry for the old URL-rewrite helper protocol
1250         debugs(85, DBG_IMPORTANT, "ERROR: URL rewrite helper returned invalid result code. Wrong helper? " << reply);
1251         break;
1252
1253     case Helper::BrokenHelper:
1254         debugs(85, DBG_IMPORTANT, "ERROR: URL rewrite helper: " << reply);
1255         break;
1256
1257     case Helper::Error:
1258         // no change to be done.
1259         break;
1260
1261     case Helper::Okay: {
1262         // #1: redirect with a specific status code    OK status=NNN url="..."
1263         // #2: redirect with a default status code     OK url="..."
1264         // #3: re-write the URL                        OK rewrite-url="..."
1265
1266         const char *statusNote = reply.notes.findFirst("status");
1267         const char *urlNote = reply.notes.findFirst("url");
1268
1269         if (urlNote != NULL) {
1270             // HTTP protocol redirect to be done.
1271
1272             // TODO: change default redirect status for appropriate requests
1273             // Squid defaults to 302 status for now for better compatibility with old clients.
1274             // HTTP/1.0 client should get 302 (Http::scFound)
1275             // HTTP/1.1 client contacting reverse-proxy should get 307 (Http::scTemporaryRedirect)
1276             // HTTP/1.1 client being diverted by forward-proxy should get 303 (Http::scSeeOther)
1277             Http::StatusCode status = Http::scFound;
1278             if (statusNote != NULL) {
1279                 const char * result = statusNote;
1280                 status = static_cast<Http::StatusCode>(atoi(result));
1281             }
1282
1283             if (status == Http::scMovedPermanently
1284                     || status == Http::scFound
1285                     || status == Http::scSeeOther
1286                     || status == Http::scPermanentRedirect
1287                     || status == Http::scTemporaryRedirect) {
1288                 http->redirect.status = status;
1289                 http->redirect.location = xstrdup(urlNote);
1290                 // TODO: validate the URL produced here is RFC 2616 compliant absolute URI
1291             } else {
1292                 debugs(85, DBG_CRITICAL, "ERROR: URL-rewrite produces invalid " << status << " redirect Location: " << urlNote);
1293             }
1294         } else {
1295             // URL-rewrite wanted. Ew.
1296             urlNote = reply.notes.findFirst("rewrite-url");
1297
1298             // prevent broken helpers causing too much damage. If old URL == new URL skip the re-write.
1299             if (urlNote != NULL && strcmp(urlNote, http->uri)) {
1300                 // XXX: validate the URL properly *without* generating a whole new request object right here.
1301                 // XXX: the clone() should be done only AFTER we know the new URL is valid.
1302                 HttpRequest *new_request = old_request->clone();
1303                 if (urlParse(old_request->method, const_cast<char*>(urlNote), new_request)) {
1304                     debugs(61,2, HERE << "URL-rewriter diverts URL from " << urlCanonical(old_request) << " to " << urlCanonical(new_request));
1305
1306                     // update the new request to flag the re-writing was done on it
1307                     new_request->flags.redirected = true;
1308
1309                     // unlink bodypipe from the old request. Not needed there any longer.
1310                     if (old_request->body_pipe != NULL) {
1311                         old_request->body_pipe = NULL;
1312                         debugs(61,2, HERE << "URL-rewriter diverts body_pipe " << new_request->body_pipe <<
1313                                " from request " << old_request << " to " << new_request);
1314                     }
1315
1316                     // update the current working ClientHttpRequest fields
1317                     safe_free(http->uri);
1318                     http->uri = xstrdup(urlCanonical(new_request));
1319                     HTTPMSGUNLOCK(old_request);
1320                     http->request = new_request;
1321                     HTTPMSGLOCK(http->request);
1322                 } else {
1323                     debugs(85, DBG_CRITICAL, "ERROR: URL-rewrite produces invalid request: " <<
1324                            old_request->method << " " << urlNote << " " << old_request->http_ver);
1325                     delete new_request;
1326                 }
1327             }
1328         }
1329     }
1330     break;
1331     }
1332
1333     /* FIXME PIPELINE: This is innacurate during pipelining */
1334
1335     if (http->getConn() != NULL && Comm::IsConnOpen(http->getConn()->clientConnection))
1336         fd_note(http->getConn()->clientConnection->fd, http->uri);
1337
1338     assert(http->uri);
1339
1340     http->doCallouts();
1341 }
1342
1343 /**
1344  * This method handles the different replies from StoreID helper.
1345  */
1346 void
1347 ClientRequestContext::clientStoreIdDone(const Helper::Reply &reply)
1348 {
1349     HttpRequest *old_request = http->request;
1350     debugs(85, 5, "'" << http->uri << "' result=" << reply);
1351     assert(store_id_state == REDIRECT_PENDING);
1352     store_id_state = REDIRECT_DONE;
1353
1354     // Put helper response Notes into the transaction state record (ALE) eventually
1355     // do it early to ensure that no matter what the outcome the notes are present.
1356     if (http->al != NULL)
1357         (void)SyncNotes(*http->al, *old_request);
1358
1359     UpdateRequestNotes(http->getConn(), *old_request, reply.notes);
1360
1361     switch (reply.result) {
1362     case Helper::Unknown:
1363     case Helper::TT:
1364         // Handler in redirect.cc should have already mapped Unknown
1365         // IF it contained valid entry for the old helper protocol
1366         debugs(85, DBG_IMPORTANT, "ERROR: storeID helper returned invalid result code. Wrong helper? " << reply);
1367         break;
1368
1369     case Helper::TimedOut:
1370     // Timeouts for storeID are not implemented
1371     case Helper::BrokenHelper:
1372         debugs(85, DBG_IMPORTANT, "ERROR: storeID helper: " << reply);
1373         break;
1374
1375     case Helper::Error:
1376         // no change to be done.
1377         break;
1378
1379     case Helper::Okay: {
1380         const char *urlNote = reply.notes.findFirst("store-id");
1381
1382         // prevent broken helpers causing too much damage. If old URL == new URL skip the re-write.
1383         if (urlNote != NULL && strcmp(urlNote, http->uri) ) {
1384             // Debug section required for some very specific cases.
1385             debugs(85, 9, "Setting storeID with: " << urlNote );
1386             http->request->store_id = urlNote;
1387             http->store_id = urlNote;
1388         }
1389     }
1390     break;
1391     }
1392
1393     http->doCallouts();
1394 }
1395
1396 /** Test cache allow/deny configuration
1397  *  Sets flags.cachable=1 if caching is not denied.
1398  */
1399 void
1400 ClientRequestContext::checkNoCache()
1401 {
1402     if (Config.accessList.noCache) {
1403         acl_checklist = clientAclChecklistCreate(Config.accessList.noCache, http);
1404         acl_checklist->nonBlockingCheck(checkNoCacheDoneWrapper, this);
1405     } else {
1406         /* unless otherwise specified, we try to cache. */
1407         checkNoCacheDone(ACCESS_ALLOWED);
1408     }
1409 }
1410
1411 static void
1412 checkNoCacheDoneWrapper(allow_t answer, void *data)
1413 {
1414     ClientRequestContext *calloutContext = (ClientRequestContext *) data;
1415
1416     if (!calloutContext->httpStateIsValid())
1417         return;
1418
1419     calloutContext->checkNoCacheDone(answer);
1420 }
1421
1422 void
1423 ClientRequestContext::checkNoCacheDone(const allow_t &answer)
1424 {
1425     acl_checklist = NULL;
1426     http->request->flags.cachable = (answer == ACCESS_ALLOWED);
1427     http->doCallouts();
1428 }
1429
1430 #if USE_OPENSSL
1431 bool
1432 ClientRequestContext::sslBumpAccessCheck()
1433 {
1434     // If SSL connection tunneling or bumping decision has been made, obey it.
1435     const Ssl::BumpMode bumpMode = http->getConn()->sslBumpMode;
1436     if (bumpMode != Ssl::bumpEnd) {
1437         debugs(85, 5, HERE << "SslBump already decided (" << bumpMode <<
1438                "), " << "ignoring ssl_bump for " << http->getConn());
1439         if (!http->getConn()->serverBump())
1440             http->sslBumpNeed(bumpMode); // for processRequest() to bump if needed and not already bumped
1441         http->al->ssl.bumpMode = bumpMode; // inherited from bumped connection
1442         return false;
1443     }
1444
1445     // If we have not decided yet, decide whether to bump now.
1446
1447     // Bumping here can only start with a CONNECT request on a bumping port
1448     // (bumping of intercepted SSL conns is decided before we get 1st request).
1449     // We also do not bump redirected CONNECT requests.
1450     if (http->request->method != Http::METHOD_CONNECT || http->redirect.status ||
1451             !Config.accessList.ssl_bump ||
1452             !http->getConn()->port->flags.tunnelSslBumping) {
1453         http->al->ssl.bumpMode = Ssl::bumpEnd; // SslBump does not apply; log -
1454         debugs(85, 5, HERE << "cannot SslBump this request");
1455         return false;
1456     }
1457
1458     // Do not bump during authentication: clients would not proxy-authenticate
1459     // if we delay a 407 response and respond with 200 OK to CONNECT.
1460     if (error && error->httpStatus == Http::scProxyAuthenticationRequired) {
1461         http->al->ssl.bumpMode = Ssl::bumpEnd; // SslBump does not apply; log -
1462         debugs(85, 5, HERE << "no SslBump during proxy authentication");
1463         return false;
1464     }
1465
1466     debugs(85, 5, HERE << "SslBump possible, checking ACL");
1467
1468     ACLFilledChecklist *aclChecklist = clientAclChecklistCreate(Config.accessList.ssl_bump, http);
1469     aclChecklist->nonBlockingCheck(sslBumpAccessCheckDoneWrapper, this);
1470     return true;
1471 }
1472
1473 /**
1474  * A wrapper function to use the ClientRequestContext::sslBumpAccessCheckDone method
1475  * as ACLFilledChecklist callback
1476  */
1477 static void
1478 sslBumpAccessCheckDoneWrapper(allow_t answer, void *data)
1479 {
1480     ClientRequestContext *calloutContext = static_cast<ClientRequestContext *>(data);
1481
1482     if (!calloutContext->httpStateIsValid())
1483         return;
1484     calloutContext->sslBumpAccessCheckDone(answer);
1485 }
1486
1487 void
1488 ClientRequestContext::sslBumpAccessCheckDone(const allow_t &answer)
1489 {
1490     if (!httpStateIsValid())
1491         return;
1492
1493     const Ssl::BumpMode bumpMode = answer == ACCESS_ALLOWED ?
1494                                    static_cast<Ssl::BumpMode>(answer.kind) : Ssl::bumpNone;
1495     http->sslBumpNeed(bumpMode); // for processRequest() to bump if needed
1496     http->al->ssl.bumpMode = bumpMode; // for logging
1497
1498     http->doCallouts();
1499 }
1500 #endif
1501
1502 /*
1503  * Identify requests that do not go through the store and client side stream
1504  * and forward them to the appropriate location. All other requests, request
1505  * them.
1506  */
1507 void
1508 ClientHttpRequest::processRequest()
1509 {
1510     debugs(85, 4, request->method << ' ' << uri);
1511
1512     if (request->method == Http::METHOD_CONNECT && !redirect.status) {
1513 #if USE_OPENSSL
1514         if (sslBumpNeeded()) {
1515             sslBumpStart();
1516             return;
1517         }
1518 #endif
1519         getConn()->stopReading(); // tunnels read for themselves
1520         tunnelStart(this, &out.size, &al->http.code, al);
1521         return;
1522     }
1523
1524     httpStart();
1525 }
1526
1527 void
1528 ClientHttpRequest::httpStart()
1529 {
1530     PROF_start(httpStart);
1531     logType = LOG_TAG_NONE;
1532     debugs(85, 4, LogTags_str[logType] << " for '" << uri << "'");
1533
1534     /* no one should have touched this */
1535     assert(out.offset == 0);
1536     /* Use the Stream Luke */
1537     clientStreamNode *node = (clientStreamNode *)client_stream.tail->data;
1538     clientStreamRead(node, this, node->readBuffer);
1539     PROF_stop(httpStart);
1540 }
1541
1542 #if USE_OPENSSL
1543
1544 void
1545 ClientHttpRequest::sslBumpNeed(Ssl::BumpMode mode)
1546 {
1547     debugs(83, 3, HERE << "sslBump required: "<< Ssl::bumpMode(mode));
1548     sslBumpNeed_ = mode;
1549 }
1550
1551 // called when comm_write has completed
1552 static void
1553 SslBumpEstablish(const Comm::ConnectionPointer &, char *, size_t, Comm::Flag errflag, int, void *data)
1554 {
1555     ClientHttpRequest *r = static_cast<ClientHttpRequest*>(data);
1556     debugs(85, 5, HERE << "responded to CONNECT: " << r << " ? " << errflag);
1557
1558     assert(r && cbdataReferenceValid(r));
1559     r->sslBumpEstablish(errflag);
1560 }
1561
1562 void
1563 ClientHttpRequest::sslBumpEstablish(Comm::Flag errflag)
1564 {
1565     // Bail out quickly on Comm::ERR_CLOSING - close handlers will tidy up
1566     if (errflag == Comm::ERR_CLOSING)
1567         return;
1568
1569     if (errflag) {
1570         debugs(85, 3, HERE << "CONNECT response failure in SslBump: " << errflag);
1571         getConn()->clientConnection->close();
1572         return;
1573     }
1574
1575     // We lack HttpReply which logRequest() uses to log the status code.
1576     // TODO: Use HttpReply instead of the "200 Connection established" string.
1577     al->http.code = 200;
1578
1579 #if USE_AUTH
1580     // Preserve authentication info for the ssl-bumped request
1581     if (request->auth_user_request != NULL)
1582         getConn()->setAuth(request->auth_user_request, "SSL-bumped CONNECT");
1583 #endif
1584
1585     assert(sslBumpNeeded());
1586     getConn()->switchToHttps(request, sslBumpNeed_);
1587 }
1588
1589 void
1590 ClientHttpRequest::sslBumpStart()
1591 {
1592     debugs(85, 5, HERE << "Confirming " << Ssl::bumpMode(sslBumpNeed_) <<
1593            "-bumped CONNECT tunnel on FD " << getConn()->clientConnection);
1594     getConn()->sslBumpMode = sslBumpNeed_;
1595
1596     AsyncCall::Pointer bumpCall = commCbCall(85, 5, "ClientSocketContext::sslBumpEstablish",
1597                                   CommIoCbPtrFun(&SslBumpEstablish, this));
1598
1599     if (request->flags.interceptTproxy || request->flags.intercepted) {
1600         CommIoCbParams &params = GetCommParams<CommIoCbParams>(bumpCall);
1601         params.flag = Comm::OK;
1602         params.conn = getConn()->clientConnection;
1603         ScheduleCallHere(bumpCall);
1604         return;
1605     }
1606
1607     // send an HTTP 200 response to kick client SSL negotiation
1608     // TODO: Unify with tunnel.cc and add a Server(?) header
1609     static const char *const conn_established = "HTTP/1.1 200 Connection established\r\n\r\n";
1610     Comm::Write(getConn()->clientConnection, conn_established, strlen(conn_established), bumpCall, NULL);
1611 }
1612
1613 #endif
1614
1615 bool
1616 ClientHttpRequest::gotEnough() const
1617 {
1618     /** TODO: should be querying the stream. */
1619     int64_t contentLength =
1620         memObject()->getReply()->bodySize(request->method);
1621     assert(contentLength >= 0);
1622
1623     if (out.offset < contentLength)
1624         return false;
1625
1626     return true;
1627 }
1628
1629 void
1630 ClientHttpRequest::storeEntry(StoreEntry *newEntry)
1631 {
1632     entry_ = newEntry;
1633 }
1634
1635 void
1636 ClientHttpRequest::loggingEntry(StoreEntry *newEntry)
1637 {
1638     if (loggingEntry_)
1639         loggingEntry_->unlock("ClientHttpRequest::loggingEntry");
1640
1641     loggingEntry_ = newEntry;
1642
1643     if (loggingEntry_)
1644         loggingEntry_->lock("ClientHttpRequest::loggingEntry");
1645 }
1646
1647 /*
1648  * doCallouts() - This function controls the order of "callout"
1649  * executions, including non-blocking access control checks, the
1650  * redirector, and ICAP.  Previously, these callouts were chained
1651  * together such that "clientAccessCheckDone()" would call
1652  * "clientRedirectStart()" and so on.
1653  *
1654  * The ClientRequestContext (aka calloutContext) class holds certain
1655  * state data for the callout/callback operations.  Previously
1656  * ClientHttpRequest would sort of hand off control to ClientRequestContext
1657  * for a short time.  ClientRequestContext would then delete itself
1658  * and pass control back to ClientHttpRequest when all callouts
1659  * were finished.
1660  *
1661  * This caused some problems for ICAP because we want to make the
1662  * ICAP callout after checking ACLs, but before checking the no_cache
1663  * list.  We can't stuff the ICAP state into the ClientRequestContext
1664  * class because we still need the ICAP state after ClientRequestContext
1665  * goes away.
1666  *
1667  * Note that ClientRequestContext is created before the first call
1668  * to doCallouts().
1669  *
1670  * If one of the callouts notices that ClientHttpRequest is no
1671  * longer valid, it should call cbdataReferenceDone() so that
1672  * ClientHttpRequest's reference count goes to zero and it will get
1673  * deleted.  ClientHttpRequest will then delete ClientRequestContext.
1674  *
1675  * Note that we set the _done flags here before actually starting
1676  * the callout.  This is strictly for convenience.
1677  */
1678
1679 tos_t aclMapTOS (acl_tos * head, ACLChecklist * ch);
1680 nfmark_t aclMapNfmark (acl_nfmark * head, ACLChecklist * ch);
1681
1682 void
1683 ClientHttpRequest::doCallouts()
1684 {
1685     assert(calloutContext);
1686
1687     /*Save the original request for logging purposes*/
1688     if (!calloutContext->http->al->request) {
1689         calloutContext->http->al->request = request;
1690         HTTPMSGLOCK(calloutContext->http->al->request);
1691
1692         NotePairs &notes = SyncNotes(*calloutContext->http->al, *calloutContext->http->request);
1693         // Make the previously set client connection ID available as annotation.
1694         if (ConnStateData *csd = calloutContext->http->getConn()) {
1695             if (!csd->connectionTag().isEmpty())
1696                 notes.add("clt_conn_tag", SBuf(csd->connectionTag()).c_str());
1697         }
1698     }
1699
1700     if (!calloutContext->error) {
1701         // CVE-2009-0801: verify the Host: header is consistent with other known details.
1702         if (!calloutContext->host_header_verify_done) {
1703             debugs(83, 3, HERE << "Doing calloutContext->hostHeaderVerify()");
1704             calloutContext->host_header_verify_done = true;
1705             calloutContext->hostHeaderVerify();
1706             return;
1707         }
1708
1709         if (!calloutContext->http_access_done) {
1710             debugs(83, 3, HERE << "Doing calloutContext->clientAccessCheck()");
1711             calloutContext->http_access_done = true;
1712             calloutContext->clientAccessCheck();
1713             return;
1714         }
1715
1716 #if USE_ADAPTATION
1717         if (!calloutContext->adaptation_acl_check_done) {
1718             calloutContext->adaptation_acl_check_done = true;
1719             if (Adaptation::AccessCheck::Start(
1720                         Adaptation::methodReqmod, Adaptation::pointPreCache,
1721                         request, NULL, calloutContext->http->al, this))
1722                 return; // will call callback
1723         }
1724 #endif
1725
1726         if (!calloutContext->redirect_done) {
1727             calloutContext->redirect_done = true;
1728             assert(calloutContext->redirect_state == REDIRECT_NONE);
1729
1730             if (Config.Program.redirect) {
1731                 debugs(83, 3, HERE << "Doing calloutContext->clientRedirectStart()");
1732                 calloutContext->redirect_state = REDIRECT_PENDING;
1733                 calloutContext->clientRedirectStart();
1734                 return;
1735             }
1736         }
1737
1738         if (!calloutContext->adapted_http_access_done) {
1739             debugs(83, 3, HERE << "Doing calloutContext->clientAccessCheck2()");
1740             calloutContext->adapted_http_access_done = true;
1741             calloutContext->clientAccessCheck2();
1742             return;
1743         }
1744
1745         if (!calloutContext->store_id_done) {
1746             calloutContext->store_id_done = true;
1747             assert(calloutContext->store_id_state == REDIRECT_NONE);
1748
1749             if (Config.Program.store_id) {
1750                 debugs(83, 3,"Doing calloutContext->clientStoreIdStart()");
1751                 calloutContext->store_id_state = REDIRECT_PENDING;
1752                 calloutContext->clientStoreIdStart();
1753                 return;
1754             }
1755         }
1756
1757         if (!calloutContext->interpreted_req_hdrs) {
1758             debugs(83, 3, HERE << "Doing clientInterpretRequestHeaders()");
1759             calloutContext->interpreted_req_hdrs = 1;
1760             clientInterpretRequestHeaders(this);
1761         }
1762
1763         if (!calloutContext->no_cache_done) {
1764             calloutContext->no_cache_done = true;
1765
1766             if (Config.accessList.noCache && request->flags.cachable) {
1767                 debugs(83, 3, HERE << "Doing calloutContext->checkNoCache()");
1768                 calloutContext->checkNoCache();
1769                 return;
1770             }
1771         }
1772     } //  if !calloutContext->error
1773
1774     if (!calloutContext->tosToClientDone) {
1775         calloutContext->tosToClientDone = true;
1776         if (getConn() != NULL && Comm::IsConnOpen(getConn()->clientConnection)) {
1777             ACLFilledChecklist ch(NULL, request, NULL);
1778             ch.src_addr = request->client_addr;
1779             ch.my_addr = request->my_addr;
1780             tos_t tos = aclMapTOS(Ip::Qos::TheConfig.tosToClient, &ch);
1781             if (tos)
1782                 Ip::Qos::setSockTos(getConn()->clientConnection, tos);
1783         }
1784     }
1785
1786     if (!calloutContext->nfmarkToClientDone) {
1787         calloutContext->nfmarkToClientDone = true;
1788         if (getConn() != NULL && Comm::IsConnOpen(getConn()->clientConnection)) {
1789             ACLFilledChecklist ch(NULL, request, NULL);
1790             ch.src_addr = request->client_addr;
1791             ch.my_addr = request->my_addr;
1792             nfmark_t mark = aclMapNfmark(Ip::Qos::TheConfig.nfmarkToClient, &ch);
1793             if (mark)
1794                 Ip::Qos::setSockNfmark(getConn()->clientConnection, mark);
1795         }
1796     }
1797
1798 #if USE_OPENSSL
1799     // We need to check for SslBump even if the calloutContext->error is set
1800     // because bumping may require delaying the error until after CONNECT.
1801     if (!calloutContext->sslBumpCheckDone) {
1802         calloutContext->sslBumpCheckDone = true;
1803         if (calloutContext->sslBumpAccessCheck())
1804             return;
1805         /* else no ssl bump required*/
1806     }
1807 #endif
1808
1809     if (calloutContext->error) {
1810         const char *storeUri = request->storeId();
1811         StoreEntry *e= storeCreateEntry(storeUri, storeUri, request->flags, request->method);
1812 #if USE_OPENSSL
1813         if (sslBumpNeeded()) {
1814             // We have to serve an error, so bump the client first.
1815             sslBumpNeed(Ssl::bumpClientFirst);
1816             // set final error but delay sending until we bump
1817             Ssl::ServerBump *srvBump = new Ssl::ServerBump(request, e);
1818             errorAppendEntry(e, calloutContext->error);
1819             calloutContext->error = NULL;
1820             getConn()->setServerBump(srvBump);
1821             e->unlock("ClientHttpRequest::doCallouts+sslBumpNeeded");
1822         } else
1823 #endif
1824         {
1825             // send the error to the client now
1826             clientStreamNode *node = (clientStreamNode *)client_stream.tail->prev->data;
1827             clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
1828             assert (repContext);
1829             repContext->setReplyToStoreEntry(e, "immediate SslBump error");
1830             errorAppendEntry(e, calloutContext->error);
1831             calloutContext->error = NULL;
1832             if (calloutContext->readNextRequest)
1833                 getConn()->flags.readMore = true; // resume any pipeline reads.
1834             node = (clientStreamNode *)client_stream.tail->data;
1835             clientStreamRead(node, this, node->readBuffer);
1836             e->unlock("ClientHttpRequest::doCallouts-sslBumpNeeded");
1837             return;
1838         }
1839     }
1840
1841     cbdataReferenceDone(calloutContext->http);
1842     delete calloutContext;
1843     calloutContext = NULL;
1844 #if HEADERS_LOG
1845
1846     headersLog(0, 1, request->method, request);
1847 #endif
1848
1849     debugs(83, 3, HERE << "calling processRequest()");
1850     processRequest();
1851
1852 #if ICAP_CLIENT
1853     Adaptation::Icap::History::Pointer ih = request->icapHistory();
1854     if (ih != NULL)
1855         ih->logType = logType;
1856 #endif
1857 }
1858
1859 #if !_USE_INLINE_
1860 #include "client_side_request.cci"
1861 #endif
1862
1863 #if USE_ADAPTATION
1864 /// Initiate an asynchronous adaptation transaction which will call us back.
1865 void
1866 ClientHttpRequest::startAdaptation(const Adaptation::ServiceGroupPointer &g)
1867 {
1868     debugs(85, 3, HERE << "adaptation needed for " << this);
1869     assert(!virginHeadSource);
1870     assert(!adaptedBodySource);
1871     virginHeadSource = initiateAdaptation(
1872                            new Adaptation::Iterator(request, NULL, al, g));
1873
1874     // we could try to guess whether we can bypass this adaptation
1875     // initiation failure, but it should not really happen
1876     Must(initiated(virginHeadSource));
1877 }
1878
1879 void
1880 ClientHttpRequest::noteAdaptationAnswer(const Adaptation::Answer &answer)
1881 {
1882     assert(cbdataReferenceValid(this));     // indicates bug
1883     clearAdaptation(virginHeadSource);
1884     assert(!adaptedBodySource);
1885
1886     switch (answer.kind) {
1887     case Adaptation::Answer::akForward:
1888         handleAdaptedHeader(const_cast<HttpMsg*>(answer.message.getRaw()));
1889         break;
1890
1891     case Adaptation::Answer::akBlock:
1892         handleAdaptationBlock(answer);
1893         break;
1894
1895     case Adaptation::Answer::akError:
1896         handleAdaptationFailure(ERR_DETAIL_CLT_REQMOD_ABORT, !answer.final);
1897         break;
1898     }
1899 }
1900
1901 void
1902 ClientHttpRequest::handleAdaptedHeader(HttpMsg *msg)
1903 {
1904     assert(msg);
1905
1906     if (HttpRequest *new_req = dynamic_cast<HttpRequest*>(msg)) {
1907         /*
1908          * Replace the old request with the new request.
1909          */
1910         HTTPMSGUNLOCK(request);
1911         request = new_req;
1912         HTTPMSGLOCK(request);
1913
1914         // update the new message to flag whether URL re-writing was done on it
1915         if (strcmp(urlCanonical(request),uri) != 0)
1916             request->flags.redirected = 1;
1917
1918         /*
1919          * Store the new URI for logging
1920          */
1921         xfree(uri);
1922         uri = xstrdup(urlCanonical(request));
1923         setLogUri(this, urlCanonicalClean(request));
1924         assert(request->method.id());
1925     } else if (HttpReply *new_rep = dynamic_cast<HttpReply*>(msg)) {
1926         debugs(85,3,HERE << "REQMOD reply is HTTP reply");
1927
1928         // subscribe to receive reply body
1929         if (new_rep->body_pipe != NULL) {
1930             adaptedBodySource = new_rep->body_pipe;
1931             int consumer_ok = adaptedBodySource->setConsumerIfNotLate(this);
1932             assert(consumer_ok);
1933         }
1934
1935         clientStreamNode *node = (clientStreamNode *)client_stream.tail->prev->data;
1936         clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
1937         assert(repContext);
1938         repContext->createStoreEntry(request->method, request->flags);
1939
1940         EBIT_CLR(storeEntry()->flags, ENTRY_FWD_HDR_WAIT);
1941         request_satisfaction_mode = true;
1942         request_satisfaction_offset = 0;
1943         storeEntry()->replaceHttpReply(new_rep);
1944         storeEntry()->timestampsSet();
1945
1946         if (!adaptedBodySource) // no body
1947             storeEntry()->complete();
1948         clientGetMoreData(node, this);
1949     }
1950
1951     // we are done with getting headers (but may be receiving body)
1952     clearAdaptation(virginHeadSource);
1953
1954     if (!request_satisfaction_mode)
1955         doCallouts();
1956 }
1957
1958 void
1959 ClientHttpRequest::handleAdaptationBlock(const Adaptation::Answer &answer)
1960 {
1961     request->detailError(ERR_ACCESS_DENIED, ERR_DETAIL_REQMOD_BLOCK);
1962     AclMatchedName = answer.ruleId.termedBuf();
1963     assert(calloutContext);
1964     calloutContext->clientAccessCheckDone(ACCESS_DENIED);
1965     AclMatchedName = NULL;
1966 }
1967
1968 void
1969 ClientHttpRequest::resumeBodyStorage()
1970 {
1971     if (!adaptedBodySource)
1972         return;
1973
1974     noteMoreBodyDataAvailable(adaptedBodySource);
1975 }
1976
1977 void
1978 ClientHttpRequest::noteMoreBodyDataAvailable(BodyPipe::Pointer)
1979 {
1980     assert(request_satisfaction_mode);
1981     assert(adaptedBodySource != NULL);
1982
1983     if (size_t contentSize = adaptedBodySource->buf().contentSize()) {
1984         const size_t spaceAvailable = storeEntry()->bytesWanted(Range<size_t>(0,contentSize));
1985
1986         if (spaceAvailable < contentSize ) {
1987             // No or partial body data consuming
1988             typedef NullaryMemFunT<ClientHttpRequest> Dialer;
1989             AsyncCall::Pointer call = asyncCall(93, 5, "ClientHttpRequest::resumeBodyStorage",
1990                                                 Dialer(this, &ClientHttpRequest::resumeBodyStorage));
1991             storeEntry()->deferProducer(call);
1992         }
1993
1994         if (!spaceAvailable)
1995             return;
1996
1997         if (spaceAvailable < contentSize )
1998             contentSize = spaceAvailable;
1999
2000         BodyPipeCheckout bpc(*adaptedBodySource);
2001         const StoreIOBuffer ioBuf(&bpc.buf, request_satisfaction_offset, contentSize);
2002         storeEntry()->write(ioBuf);
2003         // assume StoreEntry::write() writes the entire ioBuf
2004         request_satisfaction_offset += ioBuf.length;
2005         bpc.buf.consume(contentSize);
2006         bpc.checkIn();
2007     }
2008
2009     if (adaptedBodySource->exhausted())
2010         endRequestSatisfaction();
2011     // else wait for more body data
2012 }
2013
2014 void
2015 ClientHttpRequest::noteBodyProductionEnded(BodyPipe::Pointer)
2016 {
2017     assert(!virginHeadSource);
2018     // should we end request satisfaction now?
2019     if (adaptedBodySource != NULL && adaptedBodySource->exhausted())
2020         endRequestSatisfaction();
2021 }
2022
2023 void
2024 ClientHttpRequest::endRequestSatisfaction()
2025 {
2026     debugs(85,4, HERE << this << " ends request satisfaction");
2027     assert(request_satisfaction_mode);
2028     stopConsumingFrom(adaptedBodySource);
2029
2030     // TODO: anything else needed to end store entry formation correctly?
2031     storeEntry()->complete();
2032 }
2033
2034 void
2035 ClientHttpRequest::noteBodyProducerAborted(BodyPipe::Pointer)
2036 {
2037     assert(!virginHeadSource);
2038     stopConsumingFrom(adaptedBodySource);
2039
2040     debugs(85,3, HERE << "REQMOD body production failed");
2041     if (request_satisfaction_mode) { // too late to recover or serve an error
2042         request->detailError(ERR_ICAP_FAILURE, ERR_DETAIL_CLT_REQMOD_RESP_BODY);
2043         const Comm::ConnectionPointer c = getConn()->clientConnection;
2044         Must(Comm::IsConnOpen(c));
2045         c->close(); // drastic, but we may be writing a response already
2046     } else {
2047         handleAdaptationFailure(ERR_DETAIL_CLT_REQMOD_REQ_BODY);
2048     }
2049 }
2050
2051 void
2052 ClientHttpRequest::handleAdaptationFailure(int errDetail, bool bypassable)
2053 {
2054     debugs(85,3, HERE << "handleAdaptationFailure(" << bypassable << ")");
2055
2056     const bool usedStore = storeEntry() && !storeEntry()->isEmpty();
2057     const bool usedPipe = request->body_pipe != NULL &&
2058                           request->body_pipe->consumedSize() > 0;
2059
2060     if (bypassable && !usedStore && !usedPipe) {
2061         debugs(85,3, HERE << "ICAP REQMOD callout failed, bypassing: " << calloutContext);
2062         if (calloutContext)
2063             doCallouts();
2064         return;
2065     }
2066
2067     debugs(85,3, HERE << "ICAP REQMOD callout failed, responding with error");
2068
2069     clientStreamNode *node = (clientStreamNode *)client_stream.tail->prev->data;
2070     clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
2071     assert(repContext);
2072
2073     calloutsError(ERR_ICAP_FAILURE, errDetail);
2074
2075     if (calloutContext)
2076         doCallouts();
2077 }
2078
2079 #endif
2080
2081 // XXX: modify and use with ClientRequestContext::clientAccessCheckDone too.
2082 void
2083 ClientHttpRequest::calloutsError(const err_type error, const int errDetail)
2084 {
2085     // The original author of the code also wanted to pass an errno to
2086     // setReplyToError, but it seems unlikely that the errno reflects the
2087     // true cause of the error at this point, so I did not pass it.
2088     if (calloutContext) {
2089         Ip::Address noAddr;
2090         noAddr.setNoAddr();
2091         ConnStateData * c = getConn();
2092         calloutContext->error = clientBuildError(error, Http::scInternalServerError,
2093                                 NULL,
2094                                 c != NULL ? c->clientConnection->remote : noAddr,
2095                                 request
2096                                                 );
2097 #if USE_AUTH
2098         calloutContext->error->auth_user_request =
2099             c != NULL && c->getAuth() != NULL ? c->getAuth() : request->auth_user_request;
2100 #endif
2101         calloutContext->error->detailError(errDetail);
2102         calloutContext->readNextRequest = true;
2103         if (c != NULL)
2104             c->expectNoForwarding();
2105     }
2106     //else if(calloutContext == NULL) is it possible?
2107 }
2108