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